From patchwork Thu Apr 26 01:10:09 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Yongseok Koh X-Patchwork-Id: 38979 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id B1C5E8DAB; Thu, 26 Apr 2018 03:10:45 +0200 (CEST) Received: from EUR01-VE1-obe.outbound.protection.outlook.com (mail-ve1eur01on0078.outbound.protection.outlook.com [104.47.1.78]) by dpdk.org (Postfix) with ESMTP id EFED27CDB for ; Thu, 26 Apr 2018 03:10:41 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Mellanox.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=k6BuRFMI424QIaV/lzkTf3LUOo3EUtTC6djEla1hgG4=; b=pyp1I8WndN3xOa4gtYHwq/7ONX/m4KhRBdcAmExLM0jPuTVzCBl1Lxhr2cwFNsj/uXU8meMjHIx8nytGSMBqcSWbuIWJo7zAWLxXGTjlf0vlSHgII6sv/XCyC5OIOY7Ckr5ARzPPAwbfPP1O6a5oX49K0ex1xdd6DIUOVjLNHzw= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=yskoh@mellanox.com; Received: from mellanox.com (209.116.155.178) by VI1PR0501MB2046.eurprd05.prod.outlook.com (2603:10a6:800:36::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.696.15; Thu, 26 Apr 2018 01:10:27 +0000 From: Yongseok Koh To: wenzhuo.lu@intel.com, jingjing.wu@intel.com, olivier.matz@6wind.com Cc: dev@dpdk.org, konstantin.ananyev@intel.com, arybchenko@solarflare.com, stephen@networkplumber.org, thomas@monjalon.net, adrien.mazarguil@6wind.com, nelio.laranjeiro@6wind.com, Yongseok Koh Date: Wed, 25 Apr 2018 18:10:09 -0700 Message-Id: <20180426011010.28078-1-yskoh@mellanox.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20180310012532.15809-1-yskoh@mellanox.com> References: <20180310012532.15809-1-yskoh@mellanox.com> MIME-Version: 1.0 X-Originating-IP: [209.116.155.178] X-ClientProxiedBy: CY4PR04CA0050.namprd04.prod.outlook.com (2603:10b6:910:4f::15) To VI1PR0501MB2046.eurprd05.prod.outlook.com (2603:10a6:800:36::20) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652020)(48565401081)(5600026)(4534165)(4627221)(201703031133081)(201702281549075)(2017052603328)(7153060)(7193020); SRVR:VI1PR0501MB2046; X-Microsoft-Exchange-Diagnostics: 1; VI1PR0501MB2046; 3:jAtC9PgZDpFI8IOxrBMWpEgKYUv9/Y5vKECY0ScWnYFrwRdKbfSGebUN5EbwBmba7EZDYatFWNqH5+YBpuo9aKiXiLkNs00g3VjcZzpvDYuMMsZEchu2jzMtJFHh+hgM6Ikqi/18lqSBPxNNcX45wfav/a/5fi+r6Arf3OiVARu+QWjKlyew7zlqk2lqxmPLAiS17yKKCYUpsLx/oYi8RxwnA7lUt5wJfJ26QKdNfdJ0hVq8eFVCCKOF+FYAnj8S; 25:qEmRSgF0PHwLc7j1ZfWNsX5zh7BiwskJMp7Tjlc2OCOICzi29i+DfcAjHhd3qXwCXCyjb/V8fF5F4gZo/o23Al/uc6XT9dV/LjEn/lfm74V/F/20VbR4BfLtvin63Ux9A47t+B0L34iqs7ISRneUqPrCQH8NUcQA9eQ8SCarwz2a1aLejOqRZ5wtwG7nXCxhM7fDOQgzfbebheMT1Ns56q1jMdmAbCXFqhpMHV/cF3bmqdy+eA8STftZrOMR/IiR5F1UCGypFIsHT0fNiX6YimHSbchyi8JogY+Aq+wilBeb+iNHCVY+4YeIY5maxlZp1NEHr8qJj7ubRJLaZ+yzBA==; 31:E9mfYOyABQL9wYE68NUxaTO6Zdk1dNzyebKcwnw2moBjVIAyK7V4Pr9kfsToi80LYRcNuELfA7ekBYkt3XvN5LJCdLGp9x4soE1hGKXBTE/RcUh9KiX7koubnsDfQ8FAoDMxbzJq6Y+gRll4prsDmG36lvW45fu2EbAOOyqWsO76/l4dv57D9PFKPwrzriG5Ew1gSgDESlWKElUKIxa3BgVmjFf684oMpM861ozuVkg= X-MS-TrafficTypeDiagnostic: VI1PR0501MB2046: X-LD-Processed: a652971c-7d2e-4d9b-a6a4-d149256f461b,ExtAddr X-Microsoft-Exchange-Diagnostics: 1; VI1PR0501MB2046; 20:HJ7Gn8cu3eWE/fiqztTUCqFyNamysqQUcMOs2nsDCqYC6mWHOBszVQt14OyX5RgEUn1aYKRWVeK7OJBsZXhy0zLfsisucQAsxLIj6HwMlNzBNuG6ZmhOG1AsQS85aTsd/8uVP5rgntzQMTyYfjMIXDwND9rU0WQ0OaqURyhX5iUyZM6g9V2X7bPp5TORmGV9EI9i3XPnzds9m5WyJloSEdNiUQYIcYFKFx4WJ0VlYuyfKenvnP3UmVzsHA8X8ZUHP0xaKixnxAXAKjuSwChWiAYDLs3Nh4ePpj47Ul9wt3VDSwvAp6yGofAoih2W2LKB0JxyVrklEy8eTYmgMsiZ7Go2ft3OUGnMbuAIjjBEI+BQbkcnE/S/kFr5qurHzl6LLMR5Etv5zbi/1mo/z67SMMrjaR30un0xTELKdUVrnECaCh98VdTGhKVCUnsHBy9QzxlBKFz/toKEhhwJZVAPf4SOx10yd4mlBEOG02xy6gK3HFFoP9IF+CIlnz/CjVGO; 4:DqbssFcsrFZuvngXdPmbvIJVf0umwb6MAbwUr+6tR5dyLfc4WCdoQQCeV9c36MkufMAtPEOsA5YV3XzGLU6jcel1mP63LjHrqCfoa0zm6g3AdHeS6/brfSpoMtNRCXmlAtKfIOMFiNHiF7jJl31DffiM/Qt9ijrps0YOYzEGL/BH8S4gqya/Muf+mKxG0KbZsX4gq0UDttWz3t9fx0a2lLWZ/X3Tj+SPiHepLc95IymMx6tKnK95i8cKYUFnqXDg3mbv+R0gE7K8RqgIBmM/Tg== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:; X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(8121501046)(5005006)(10201501046)(3231232)(944501410)(52105095)(3002001)(93006095)(93001095)(6055026)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123562045)(20161123560045)(20161123564045)(20161123558120)(6072148)(201708071742011); SRVR:VI1PR0501MB2046; BCL:0; PCL:0; RULEID:; SRVR:VI1PR0501MB2046; X-Forefront-PRVS: 0654257CF5 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(346002)(39380400002)(366004)(396003)(39860400002)(376002)(189003)(199004)(47776003)(5890100001)(66066001)(107886003)(2616005)(21086003)(956004)(48376002)(476003)(97736004)(2906002)(11346002)(6666003)(446003)(26005)(186003)(51416003)(52116002)(386003)(50466002)(16526019)(76176011)(478600001)(55016002)(106356001)(7696005)(6116002)(8676002)(69596002)(4326008)(50226002)(3846002)(59450400001)(8936002)(1076002)(36756003)(16586007)(305945005)(486006)(105586002)(53936002)(68736007)(316002)(5660300001)(7416002)(81156014)(25786009)(86362001)(7736002)(81166006); DIR:OUT; SFP:1101; SCL:1; SRVR:VI1PR0501MB2046; H:mellanox.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; MX:3; A:1; Received-SPF: None (protection.outlook.com: mellanox.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; VI1PR0501MB2046; 23:SnGB+p+E1AFZQgckREp3YvkLZprMJiDW+eAQMf4?= vHhPxcbYkQ5ooJriMS2SUn8baYSuzLPxeRrvE2mPlZuAP2HNRZ2splUDlbXP9VLTg4iN7aRAqSQ3eAUwgkat/IcCGJM/a/BpYzaEcmuWN1tmU14FqqCdwwmfk44e+qeV0j1y26ARdl3vnuZj5HHBap7FSY/Ech5DfhE7HI3pzU1YPJUffkbDvwKWQfHPRnEUCERrRK0N5L3aaS4u2dgQdO2pX+z4QbqNHeGpCoFl5IgNOhHfkgBTfOEM5myDYCHuVyVSvp1MsITEHeEuf0DLk6MiYrUx6acuBLhX79iu4NfX28mU4Xz0oc+qRZnEJMX2Xds748ahBvD6XvJIrYCtw3vMd0QpXyoyjon//BdvYGNh9S/P5t1QtWmRO9CPd2oZg3xQZkn/iYZa/SxDdvZqnPIa8M9ob+TmYZBbA+XWRHLGrbW4z7KnDeIObBkURV/ignwdDIjmmegnNHeKvLWYxe3FYIGCU5xPAKKO+FDocgG8KjSyR9Ug7LHrU5+igZSEhbqsmXfeCPEGeHPpYCO+G2e23FD+W1VFaI974EvKUB3hAReF4Cs4+TwXhOzHFgpdcSCOFSWYu53ELNPX9nCWwicD76n5NMmwH+Jiru1J20v7IW7Xyv4usBPe/eFWPzNYHW7Nv822dIJAQnt2yqzFUwvYtg9Fot0tMLeKu2ZbFBjLLzrlOKKb1gfc+vdzjU/xsTpsE7Ulv2df5eBxW1rD5ZllYTxo1B/62Zqk+5jmpZjhsqpQWxWhkvBkv361xUJLYyEt4l3gCdgq6Vik5/AVW9DjykgXwyaaaIgsLJA4EXucCIytziG1sYO6bp+t31kFsBczIkSncOn2M0/uHLFH2pi7C4rqX1jofI8VNxOkiK7brjRmMJb9i80Di0yuMo8NpSnPTA/bU5Qxn248ZbQsRqqTVgvcudS2gX4DJHFZmLUHK2oOsZi0eZbRi7g7w5jWWACwSlJl0CAGDAGPrifLa4Md+JFLqRybU1EyWtCJKBGWRm+q7Qos2M1qakfIknwhYdkv5GfQNKOwl99c7WQoCWccG0nubRBHcSb4V1d0o5Tn0iZAw7Uba/HF2Db3driVUOHYHXXUAY+UQaW/3XcU7RgrVoGcCUMeBV8yCNgqBQ53W0vGinLIVHNlhhSbRFUfafxj9dVVHs9HAC2Tq/9xT+Hl0dA94FO9T7QG4ivIVHADr990KHqFyc3IK96yAuUgxFIqeQWq05+niBpGmaO4QttW/6JXH+EnFfUCSCOuJJ32vbg== X-Microsoft-Antispam-Message-Info: eBEBqK+d/opyc0Ndp10pfte3Fdv8gvs4jC3dNWSoyjsVm71F7y6IyB71QuiRpjcLckOQz7yee1E+p1b+h3CbhS2VWXOI1erk2xH6F8+8R6irFsvIyytVvabCmhrrRnsBNK+O/x5SQWV2iccThtKyhjMB/QEcFyrdry8Jn8svbwylAaCKsEwRovrxN+eLHdRK X-Microsoft-Exchange-Diagnostics: 1; VI1PR0501MB2046; 6:ZjVfxXIfEK9tXNjXNPX+gPev/XRHkXgn+8GmpJlTj78kR6ZFlx1vVSYuiSScxsYX9OKH2FewkXXKiaB4upfDqnX/d0lIxJAFHLgcynzIMzuN396vtiOva6Vk4gOn6D81wjDOPCJVdntDljBdxP2q7FZwcvS+OCp06pQdBSctJ1J0rpsWtpqoF9eLkmoBlzoBZ1tLScED+xfoM3kjvjcNN4Z3QZ1cWRKN+m0JBENIhj9qIvi4zdoTpu0jhDSPiSf6ucLIppfS53b54O2K3V5HNxS7QVmc8iqoy5aSVJDaePgSWHHoZhF5ZgMhc5ettVJB/+VNp0UixdfngpC64p6Rk7Ogd8b3IMMTHVZgWa2KT7xHx7rk/M9lVhfwquTKE2BHAL/nXzYPUK51oFti2b1TkHCSZJpqckcTK5DSRxdoYeKGwmOUEcCQ4IKs0oUpBaEqll6VwLQ1buLpUK0GQ6gz+A==; 5:TpsxZts1ceicRR9OD1CQolOXfTu+1UV4QwP+4nFzfHDIoOSzAFnvCvmT8zP9SnYQYb3IOP5UwFHmtjvp09lAbdbIXpYuW4ejjmiSbKvM0ITz/MvY0uMljq/qE1KFzhrbHI+CVAPDm9itfLDNA1nbeTgWgjrf65XMh23ipPau57M=; 24:26CzHQX6/gIb2HKAJIkjFlNU3hO9+zjj4/BpqWY1DwGt6e2DLieZTvb+qLum/X6ba0k7uOWgeEGNQDnaGDS8KC9Kpz/rYTODcgMYCebcjuE= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; VI1PR0501MB2046; 7:+r1x18tg3fxPDV1fsan9cSk2AtwPfqeXU7JNJp7jheLUxV9hfgzgdewOSXdL6dWAosrxm1eK0gFsLJQyXRfg8IS7wA836TmwCbUO5rsPjyUVHlerUpCZjYjTmQhJY9nb1g29nT77I1wO5y0z5eeC3bn4hr9EYJ/FeqV0P19LUS2njelC+q1UQclhjEsMUe5II6QLRShrqkrItF8MYy2y4Zwh2U6rD7FmGAKedPm3DbW+tLx3ubgrC7IXNmQ1ANqp X-MS-Office365-Filtering-Correlation-Id: 73b4e6c8-00b8-4fd1-67f8-08d5ab1280be X-OriginatorOrg: Mellanox.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 26 Apr 2018 01:10:27.8328 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 73b4e6c8-00b8-4fd1-67f8-08d5ab1280be X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: a652971c-7d2e-4d9b-a6a4-d149256f461b X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR0501MB2046 Subject: [dpdk-dev] [PATCH v6 1/2] mbuf: support attaching external buffer to mbuf X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" This patch introduces a new way of attaching an external buffer to a mbuf. Attaching an external buffer is quite similar to mbuf indirection in replacing buffer addresses and length of a mbuf, but a few differences: - When an indirect mbuf is attached, refcnt of the direct mbuf would be 2 as long as the direct mbuf itself isn't freed after the attachment. In such cases, the buffer area of a direct mbuf must be read-only. But external buffer has its own refcnt and it starts from 1. Unless multiple mbufs are attached to a mbuf having an external buffer, the external buffer is writable. - There's no need to allocate buffer from a mempool. Any buffer can be attached with appropriate free callback. - Smaller metadata is required to maintain shared data such as refcnt. Signed-off-by: Yongseok Koh Acked-by: Konstantin Ananyev Acked-by: Olivier Matz --- ** This patch can pass the mbuf_autotest. ** Submitting only non-mlx5 patches to meet deadline for RC1. mlx5 patches will be submitted separately rebased on a differnet patchset which accommodates new memory hotplug design to mlx PMDs. v6: * rte_pktmbuf_attach_extbuf() doesn't take NULL shinfo. Instead, rte_pktmbuf_ext_shinfo_init_helper() is added. * bug fix in rte_pktmbuf_attach() - shinfo wasn't saved to mi. * minor changes from review. v5: * rte_pktmbuf_attach_extbuf() sets headroom to 0. * if shinfo is provided when attaching, user should initialize it. * minor changes from review. v4: * rte_pktmbuf_attach_extbuf() takes new arguments - buf_iova and shinfo. user can pass memory for shared data via shinfo argument. * minor changes from review. v3: * implement external buffer attachment instead of introducing buf_off for mbuf indirection. lib/librte_mbuf/rte_mbuf.h | 335 +++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 306 insertions(+), 29 deletions(-) diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h index 43aaa9c5f..0a6885281 100644 --- a/lib/librte_mbuf/rte_mbuf.h +++ b/lib/librte_mbuf/rte_mbuf.h @@ -344,7 +344,10 @@ extern "C" { PKT_TX_MACSEC | \ PKT_TX_SEC_OFFLOAD) -#define __RESERVED (1ULL << 61) /**< reserved for future mbuf use */ +/** + * Mbuf having an external buffer attached. shinfo in mbuf must be filled. + */ +#define EXT_ATTACHED_MBUF (1ULL << 61) #define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ @@ -584,8 +587,27 @@ struct rte_mbuf { /** Sequence number. See also rte_reorder_insert(). */ uint32_t seqn; + /** Shared data for external buffer attached to mbuf. See + * rte_pktmbuf_attach_extbuf(). + */ + struct rte_mbuf_ext_shared_info *shinfo; + } __rte_cache_aligned; +/** + * Function typedef of callback to free externally attached buffer. + */ +typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque); + +/** + * Shared data at the end of an external buffer. + */ +struct rte_mbuf_ext_shared_info { + rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */ + void *fcb_opaque; /**< Free callback argument */ + rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ +}; + /**< Maximum number of nb_segs allowed. */ #define RTE_MBUF_MAX_NB_SEGS UINT16_MAX @@ -706,14 +728,34 @@ rte_mbuf_to_baddr(struct rte_mbuf *md) } /** + * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE + * otherwise. + * + * If a mbuf has its data in another mbuf and references it by mbuf + * indirection, this mbuf can be defined as a cloned mbuf. + */ +#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) + +/** * Returns TRUE if given mbuf is indirect, or FALSE otherwise. */ -#define RTE_MBUF_INDIRECT(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) +#define RTE_MBUF_INDIRECT(mb) RTE_MBUF_CLONED(mb) + +/** + * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise. + * + * External buffer is a user-provided anonymous buffer. + */ +#define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF) /** * Returns TRUE if given mbuf is direct, or FALSE otherwise. + * + * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf + * can be defined as a direct mbuf. */ -#define RTE_MBUF_DIRECT(mb) (!RTE_MBUF_INDIRECT(mb)) +#define RTE_MBUF_DIRECT(mb) \ + (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF))) /** * Private data in case of pktmbuf pool. @@ -839,6 +881,58 @@ rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value) #endif /* RTE_MBUF_REFCNT_ATOMIC */ +/** + * Reads the refcnt of an external buffer. + * + * @param shinfo + * Shared data of the external buffer. + * @return + * Reference count number. + */ +static inline uint16_t +rte_mbuf_ext_refcnt_read(const struct rte_mbuf_ext_shared_info *shinfo) +{ + return (uint16_t)(rte_atomic16_read(&shinfo->refcnt_atomic)); +} + +/** + * Set refcnt of an external buffer. + * + * @param shinfo + * Shared data of the external buffer. + * @param new_value + * Value set + */ +static inline void +rte_mbuf_ext_refcnt_set(struct rte_mbuf_ext_shared_info *shinfo, + uint16_t new_value) +{ + rte_atomic16_set(&shinfo->refcnt_atomic, new_value); +} + +/** + * Add given value to refcnt of an external buffer and return its new + * value. + * + * @param shinfo + * Shared data of the external buffer. + * @param value + * Value to add/subtract + * @return + * Updated value + */ +static inline uint16_t +rte_mbuf_ext_refcnt_update(struct rte_mbuf_ext_shared_info *shinfo, + int16_t value) +{ + if (likely(rte_mbuf_ext_refcnt_read(shinfo) == 1)) { + rte_mbuf_ext_refcnt_set(shinfo, 1 + value); + return 1 + value; + } + + return (uint16_t)rte_atomic16_add_return(&shinfo->refcnt_atomic, value); +} + /** Mbuf prefetch */ #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \ if ((m) != NULL) \ @@ -1213,11 +1307,157 @@ static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool, } /** + * Initialize shared data at the end of an external buffer before attaching + * to a mbuf by ``rte_pktmbuf_attach_extbuf()``. This is not a mandatory + * initialization but a helper function to simply spare a few bytes at the + * end of the buffer for shared data. If shared data is allocated + * separately, this should not be called but application has to properly + * initialize the shared data according to its need. + * + * Free callback and its argument is saved and the refcnt is set to 1. + * + * @warning + * buf_len must be adjusted to RTE_PTR_DIFF(shinfo, buf_addr) after this + * initialization. For example, + * + * struct rte_mbuf_ext_shared_info *shinfo = + * rte_pktmbuf_ext_shinfo_init_helpfer(buf_addr, buf_len, + * free_cb, fcb_arg); + * buf_len = RTE_PTR_DIFF(shinfo, buf_addr); + * rte_pktmbuf_attach_extbuf(m, buf_addr, buf_iova, buf_len, shinfo); + * + * @param buf_addr + * The pointer to the external buffer. + * @param buf_len + * The size of the external buffer. buf_len must be larger than the size + * of ``struct rte_mbuf_ext_shared_info`` and padding for alignment. If + * not enough, this function will return NULL. + * @param free_cb + * Free callback function to call when the external buffer needs to be + * freed. + * @param fcb_opaque + * Argument for the free callback function. + * + * @return + * A pointer to the initialized shared data on success, return NULL + * otherwise. + */ +static inline struct rte_mbuf_ext_shared_info * +rte_pktmbuf_ext_shinfo_init_helper(void *buf_addr, uint16_t buf_len, + rte_mbuf_extbuf_free_callback_t free_cb, void *fcb_opaque) +{ + struct rte_mbuf_ext_shared_info *shinfo; + void *buf_end = RTE_PTR_ADD(buf_addr, buf_len); + + shinfo = RTE_PTR_ALIGN_FLOOR(RTE_PTR_SUB(buf_end, + sizeof(*shinfo)), sizeof(uintptr_t)); + if ((void *)shinfo <= buf_addr) + return NULL; + + rte_mbuf_ext_refcnt_set(shinfo, 1); + + shinfo->free_cb = free_cb; + shinfo->fcb_opaque = fcb_opaque; + + /* buf_len must be adjusted to RTE_PTR_DIFF(shinfo, buf_addr) */ + return shinfo; +} + +/** + * Attach an external buffer to a mbuf. + * + * User-managed anonymous buffer can be attached to an mbuf. When attaching + * it, corresponding free callback function and its argument should be + * provided via shinfo. This callback function will be called once all the + * mbufs are detached from the buffer (refcnt becomes zero). + * + * The headroom for the attaching mbuf will be set to zero and this can be + * properly adjusted after attachment. For example, ``rte_pktmbuf_adj()`` + * or ``rte_pktmbuf_reset_headroom()`` might be used. + * + * More mbufs can be attached to the same external buffer by + * ``rte_pktmbuf_attach()`` once the external buffer has been attached by + * this API. + * + * Detachment can be done by either ``rte_pktmbuf_detach_extbuf()`` or + * ``rte_pktmbuf_detach()``. + * + * Memory for shared data must be provided and user must initialize all of + * the content properly, escpecially free callback and refcnt. The pointer + * of shared data will be stored in m->shinfo. + * ``rte_pktmbuf_ext_shinfo_init_helper`` can help to simply spare a few + * bytes at the end of buffer for the shared data, store free callback and + * its argument and set the refcnt to 1. + * + * Attaching an external buffer is quite similar to mbuf indirection in + * replacing buffer addresses and length of a mbuf, but a few differences: + * - When an indirect mbuf is attached, refcnt of the direct mbuf would be + * 2 as long as the direct mbuf itself isn't freed after the attachment. + * In such cases, the buffer area of a direct mbuf must be read-only. But + * external buffer has its own refcnt and it starts from 1. Unless + * multiple mbufs are attached to a mbuf having an external buffer, the + * external buffer is writable. + * - There's no need to allocate buffer from a mempool. Any buffer can be + * attached with appropriate free callback and its IO address. + * - Smaller metadata is required to maintain shared data such as refcnt. + * + * @warning + * @b EXPERIMENTAL: This API may change without prior notice. + * Once external buffer is enabled by allowing experimental API, + * ``RTE_MBUF_DIRECT()`` and ``RTE_MBUF_INDIRECT()`` are no longer + * exclusive. A mbuf can be considered direct if it is neither indirect nor + * having external buffer. + * + * @param m + * The pointer to the mbuf. + * @param buf_addr + * The pointer to the external buffer. + * @param buf_iova + * IO address of the external buffer. + * @param buf_len + * The size of the external buffer. + * @param shinfo + * User-provided memory for shared data of the external buffer. + */ +static inline void __rte_experimental +rte_pktmbuf_attach_extbuf(struct rte_mbuf *m, void *buf_addr, + rte_iova_t buf_iova, uint16_t buf_len, + struct rte_mbuf_ext_shared_info *shinfo) +{ + /* mbuf should not be read-only */ + RTE_ASSERT(RTE_MBUF_DIRECT(m) && rte_mbuf_refcnt_read(m) == 1); + RTE_ASSERT(shinfo->free_cb != NULL); + + m->buf_addr = buf_addr; + m->buf_iova = buf_iova; + m->buf_len = buf_len; + + m->data_len = 0; + m->data_off = 0; + + m->ol_flags |= EXT_ATTACHED_MBUF; + m->shinfo = shinfo; +} + +/** + * Detach the external buffer attached to a mbuf, same as + * ``rte_pktmbuf_detach()`` + * + * @param m + * The mbuf having external buffer. + */ +#define rte_pktmbuf_detach_extbuf(m) rte_pktmbuf_detach(m) + +/** * Attach packet mbuf to another packet mbuf. * - * After attachment we refer the mbuf we attached as 'indirect', - * while mbuf we attached to as 'direct'. - * The direct mbuf's reference counter is incremented. + * If the mbuf we are attaching to isn't a direct buffer and is attached to + * an external buffer, the mbuf being attached will be attached to the + * external buffer instead of mbuf indirection. + * + * Otherwise, the mbuf will be indirectly attached. After attachment we + * refer the mbuf we attached as 'indirect', while mbuf we attached to as + * 'direct'. The direct mbuf's reference counter is incremented. * * Right now, not supported: * - attachment for already indirect mbuf (e.g. - mi has to be direct). @@ -1231,19 +1471,20 @@ static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool, */ static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m) { - struct rte_mbuf *md; - RTE_ASSERT(RTE_MBUF_DIRECT(mi) && rte_mbuf_refcnt_read(mi) == 1); - /* if m is not direct, get the mbuf that embeds the data */ - if (RTE_MBUF_DIRECT(m)) - md = m; - else - md = rte_mbuf_from_indirect(m); + if (RTE_MBUF_HAS_EXTBUF(m)) { + rte_mbuf_ext_refcnt_update(m->shinfo, 1); + mi->ol_flags = m->ol_flags; + mi->shinfo = m->shinfo; + } else { + /* if m is not direct, get the mbuf that embeds the data */ + rte_mbuf_refcnt_update(rte_mbuf_from_indirect(m), 1); + mi->priv_size = m->priv_size; + mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF; + } - rte_mbuf_refcnt_update(md, 1); - mi->priv_size = m->priv_size; mi->buf_iova = m->buf_iova; mi->buf_addr = m->buf_addr; mi->buf_len = m->buf_len; @@ -1259,7 +1500,6 @@ static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m) mi->next = NULL; mi->pkt_len = mi->data_len; mi->nb_segs = 1; - mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF; mi->packet_type = m->packet_type; mi->timestamp = m->timestamp; @@ -1268,12 +1508,52 @@ static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m) } /** - * Detach an indirect packet mbuf. + * @internal used by rte_pktmbuf_detach(). * + * Decrement the reference counter of the external buffer. When the + * reference counter becomes 0, the buffer is freed by pre-registered + * callback. + */ +static inline void +__rte_pktmbuf_free_extbuf(struct rte_mbuf *m) +{ + RTE_ASSERT(RTE_MBUF_HAS_EXTBUF(m)); + RTE_ASSERT(m->shinfo != NULL); + + if (rte_mbuf_ext_refcnt_update(m->shinfo, -1) == 0) + m->shinfo->free_cb(m->buf_addr, m->shinfo->fcb_opaque); +} + +/** + * @internal used by rte_pktmbuf_detach(). + * + * Decrement the direct mbuf's reference counter. When the reference + * counter becomes 0, the direct mbuf is freed. + */ +static inline void +__rte_pktmbuf_free_direct(struct rte_mbuf *m) +{ + struct rte_mbuf *md; + + RTE_ASSERT(RTE_MBUF_INDIRECT(m)); + + md = rte_mbuf_from_indirect(m); + + if (rte_mbuf_refcnt_update(md, -1) == 0) { + md->next = NULL; + md->nb_segs = 1; + rte_mbuf_refcnt_set(md, 1); + rte_mbuf_raw_free(md); + } +} + +/** + * Detach a packet mbuf from external buffer or direct buffer. + * + * - decrement refcnt and free the external/direct buffer if refcnt + * becomes zero. * - restore original mbuf address and length values. * - reset pktmbuf data and data_len to their default values. - * - decrement the direct mbuf's reference counter. When the - * reference counter becomes 0, the direct mbuf is freed. * * All other fields of the given packet mbuf will be left intact. * @@ -1282,10 +1562,14 @@ static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m) */ static inline void rte_pktmbuf_detach(struct rte_mbuf *m) { - struct rte_mbuf *md = rte_mbuf_from_indirect(m); struct rte_mempool *mp = m->pool; uint32_t mbuf_size, buf_len, priv_size; + if (RTE_MBUF_HAS_EXTBUF(m)) + __rte_pktmbuf_free_extbuf(m); + else + __rte_pktmbuf_free_direct(m); + priv_size = rte_pktmbuf_priv_size(mp); mbuf_size = sizeof(struct rte_mbuf) + priv_size; buf_len = rte_pktmbuf_data_room_size(mp); @@ -1297,13 +1581,6 @@ static inline void rte_pktmbuf_detach(struct rte_mbuf *m) rte_pktmbuf_reset_headroom(m); m->data_len = 0; m->ol_flags = 0; - - if (rte_mbuf_refcnt_update(md, -1) == 0) { - md->next = NULL; - md->nb_segs = 1; - rte_mbuf_refcnt_set(md, 1); - rte_mbuf_raw_free(md); - } } /** @@ -1327,7 +1604,7 @@ rte_pktmbuf_prefree_seg(struct rte_mbuf *m) if (likely(rte_mbuf_refcnt_read(m) == 1)) { - if (RTE_MBUF_INDIRECT(m)) + if (!RTE_MBUF_DIRECT(m)) rte_pktmbuf_detach(m); if (m->next != NULL) { @@ -1339,7 +1616,7 @@ rte_pktmbuf_prefree_seg(struct rte_mbuf *m) } else if (__rte_mbuf_refcnt_update(m, -1) == 0) { - if (RTE_MBUF_INDIRECT(m)) + if (!RTE_MBUF_DIRECT(m)) rte_pktmbuf_detach(m); if (m->next != NULL) {