From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from EUR01-VE1-obe.outbound.protection.outlook.com (mail-ve1eur01on0065.outbound.protection.outlook.com [104.47.1.65]) by dpdk.org (Postfix) with ESMTP id 7F0C12BF4 for ; Wed, 25 Apr 2018 04:53:59 +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=R1WZ6ORirMaX8NafyI9/7F7ZoRVb/Hp1qPq6N0DKZvU=; b=t0dhPDnuVbVmt5ATNXqzEI1auF1slnuUFL6Wp/ZHI+0F6uihRoE+06HU2Qx7yiOpyeiYjA9yFU4zfJ9oVvJpfrjtxKVo9XKemCzTAs1DjYiNnZietT3nbbj5C1vUjW1FPOkRtIjNzSS13uyMDYfxZiMFnyH3V0Ao3okmdjNCe/U= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=yskoh@mellanox.com; Received: from mellanox.com (209.116.155.178) by DB6PR0501MB2037.eurprd05.prod.outlook.com (2603:10a6:4:6::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.696.13; Wed, 25 Apr 2018 02:53:55 +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: Tue, 24 Apr 2018 19:53:40 -0700 Message-Id: <20180425025341.10590-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 Content-Type: text/plain X-Originating-IP: [209.116.155.178] X-ClientProxiedBy: BYAPR07CA0025.namprd07.prod.outlook.com (2603:10b6:a02:bc::38) To DB6PR0501MB2037.eurprd05.prod.outlook.com (2603:10a6:4:6::19) 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:DB6PR0501MB2037; X-Microsoft-Exchange-Diagnostics: 1; DB6PR0501MB2037; 3:tGPZUQWCNVKNnji5uG7PI1V4xnKXcPL5V60HNi3cKZOcp8F/iLCLA71U+s/ZQ8mR/xkYx1gdXLPmiaAtSIAyXwaR2j7xMSaTOHkkYBb4fIspgAhv9bOLQi+FSC1BglgAE5vVvBaj/R4pJKeDvSziT8XIzeFV47p3G6h6fcg4uIX3Pco46fymqEHYX3B59OIl7Z7+s7K1/LfRRhLMGGvjuH3KgX2uMjOxiK+n6A4bTqpDWvAenVImV5d2F7UANYG2; 25:sIXhW+nGev/FDXKONCzrzuLl+Pf+rcBn6IigmAis9yxH14RapF5/jQSSpr4PZsR+0nVKNqDJpacxWh9OyttMu01LjT49EGYYkw3x9JQVmDMVFPf1icMvTJyLGgIOwR1/Ma8j/y2fU69VKnAx3jPFUhZhEubzJskTwgOZlmbPnMWpCC4Hn7QVtDVLXEqCQl54EgEhJKcCZK+h0RETolIHVx9DBfD6yaKPwSpV97JTU4qax46F+v1ZYxgJlpJemGVreVmP75jfhWLnpSwwlxDjJyTmxP6RiFV5ZCMWz4ayeww6AiX+lDRCMJjJdj9S77unSAIqhALhyO8DlHdLg/6pig==; 31:dhl39Q+asm6iwqg2ks/aJ3vYWJyNdAZistJMeMYyqKMWwU/UH1TGRiE9BOieXYzSCxh35r7LtZXdE7fPji24MiarH3TPi4ErLr4arF3Luof0teRrVwzSsoR0/qALd/P2Kwey2zlN/O0qbZPqts86kHc+bWeHXWX5uvpvo9I+OIC3cWUYBo+o5fS3qDheiB43TpQgJChMgHyTZzH2XDLQrt04ZKQFHThZ6Y8UcFYUE40= X-MS-TrafficTypeDiagnostic: DB6PR0501MB2037: X-LD-Processed: a652971c-7d2e-4d9b-a6a4-d149256f461b,ExtAddr X-Microsoft-Exchange-Diagnostics: 1; DB6PR0501MB2037; 20:0B9SMMVbfEFLrpCVkRH2JMhgiOxeuCudC4vwNRR3XtfHJTVcI7BJ8QQUh65pzaVopFq8Eoe94XNSTUpaz7eCOuQc8hXzwF7FW2oytF7v+FiOcuYUbrEBw4Q1bHmLonY9oSwcZFlv1MwvGBNS7QT4h/9IQCT+ZKiyMviGDP9sL8P1OAxEHVJSQut4joojAz58CqhSM8DgyxzqC+00jqvm2or/xtLnUXIQVOepXoYS4Fc2Qb7ytiq+T0HxWToljtCBN8JAJ1Zknk7FZY6XqNjtH5rl7cfErBSTJtZlxADeKK4hvldoyH3MjfZ/62KZ/GIIMoht/KX8N0sTBS6cuZLhBYOTFNW6zuoVhs5rLO7LIvrhpoDtSLolJp7fjuDRKiXkU+IwSwM2lcp65lS7UVRp0kwCxixuRx1G6ViRol9LhOzJ1IndiD4NESTYWUOwrvmJx0DJUx/kI5GSY9OPWKzD+p8y7FHg3lJM4BZGMx3ZudAH7ADMgnqSP3Q6Ub9KDl8u; 4:vzmugWjchRpNeyI8SQjuUto6Yo1XSVLJSMWHeJ+BfOqi2vlKhwSDbt4lITZK1JMBYL52nao8NpqKSh95ZU53qe+HoPY8GjY1GkA+9W1670Xzn17ZIGDaLXN07Po2EpOAmldgh//u5wnfmERq73cDRSvoDGz2PJdP1aqI+YvYp21S2dCiNiAKcODzxpQK7JyuPoOGF35QSl6Kwc0zZLeySvLk5ZLT37Mj9KdXHWY+ozFpDvF6peq25qYgu1eYhs98Kce6d9Ehq6rKYXd4hvrItQ== 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)(93006095)(93001095)(3231232)(944501410)(52105095)(3002001)(10201501046)(6055026)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123564045)(20161123560045)(20161123558120)(20161123562045)(6072148)(201708071742011); SRVR:DB6PR0501MB2037; BCL:0; PCL:0; RULEID:; SRVR:DB6PR0501MB2037; X-Forefront-PRVS: 06530126A4 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(396003)(376002)(346002)(366004)(39860400002)(39380400002)(189003)(199004)(36756003)(478600001)(107886003)(5660300001)(105586002)(21086003)(48376002)(486006)(4326008)(3846002)(6116002)(476003)(69596002)(2616005)(956004)(50466002)(16586007)(316002)(7736002)(305945005)(97736004)(47776003)(1076002)(53936002)(25786009)(446003)(11346002)(55016002)(59450400001)(8676002)(81156014)(386003)(81166006)(106356001)(6666003)(76176011)(52116002)(7696005)(51416003)(16526019)(26005)(7416002)(186003)(86362001)(5890100001)(50226002)(66066001)(2906002)(68736007)(8936002); DIR:OUT; SFP:1101; SCL:1; SRVR:DB6PR0501MB2037; H:mellanox.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; MX:1; A:1; Received-SPF: None (protection.outlook.com: mellanox.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; DB6PR0501MB2037; 23:YRlfAetBKAa+KNrMjWYWRryhAjWk8bJsxl47dfJ?= =?us-ascii?Q?gfB0R23Oc6EUPTR/Io6OjH6vemlK9k6WI+35Oxj8mQhaVIBcTXYDHgAStZ4L?= =?us-ascii?Q?3i9vR78VsIxDRr7H8LCWRqLJBkfNzaCqpXGvbFoNQEB2DG2awxylqOYL6BUW?= =?us-ascii?Q?YR/IDgUH8Ko+DvOISG8s85/jpWP9RjgVqdll8XCBU5sgjA25GSLudhs0suWV?= =?us-ascii?Q?+PioSzx1v4ufmCQxS5s4K3f8r/7RrbbD1Ig3JchcjTvguFOUWLkVnh536lWX?= =?us-ascii?Q?f27V+KEJCC/O2lbU+KAeOvYChjjvlIB78bqjErotfBj/Tc5+lOkoM8/HmBDq?= =?us-ascii?Q?r8vQK1bK5mGBu0NUHfRGrv6uBSw+mh7w3H5MPaaWtPVpLFJ6tK2n93BOSClJ?= =?us-ascii?Q?WAQZLOnULyMqfli3nMosqz6NY6sbQ5c/FE/LqfAqRfGrGPUOftPkLvk2X3jM?= =?us-ascii?Q?JPMJ8wt39g018fNOgYSX2r0Zd0+c5rbtci50y95g7fkFuVC/GVcCayPVKWRp?= =?us-ascii?Q?PTG3l2aBr1nHUgYRyY+eUILm12/xct8KsBt9ZzQ/xsXSGQ+qe0BqLIUkZPJS?= =?us-ascii?Q?WUCoiJX5l4OdwkdTzn5v4WO7s88aGET+D28Q+ph1HIHntiTJ8YzAtOsMMtRG?= =?us-ascii?Q?Za81yW80yZv/+evVtoh21+LPN3bq8CcF3jPhrhNElVKTrudEDciMjUxN6HeC?= =?us-ascii?Q?vbK3tl9ESVmhv8A8JT6NQa72c63erDjMi/UCaiG5agkX/6mX1osHnc6C3yRz?= =?us-ascii?Q?ilIBhJWcIQBf33QRV+4JNhfXYhsv8AkJZCvvgypeelnulW2EPUv0t7BxIwOz?= =?us-ascii?Q?3+SctMBGUuE+Gb6M38x3ITgPyMkAssuqUSzpy7e2gxyk0FgRahmAWh7WVv2l?= =?us-ascii?Q?6IHUdx5VH68mHwfv/UDlwl8SYE3yBhVRtjElUDrU21g7sAx80Mrw4ZTxedD7?= =?us-ascii?Q?jqJ7LrJ9l443/JfTMLXisgj2n6t2OWX6keUAOUiZr/3UKcHxyQYF01uDo3oW?= =?us-ascii?Q?3PtLxtIqMdthJYSV6fZMCizAGG1H7wBq+ON1N2pI5jo+1RA4HHmQJRr5wc/2?= =?us-ascii?Q?AV4bDoUYq5oQNnSj+edCECeEy8TefGz6QWfjg9Iyi7zALDiL0H8/a2avajQ/?= =?us-ascii?Q?WJPeZY5VudSNwRd9RGJ1wkSzTmSW0TNVIUobBgbtJdmKpev+v1yNv2/dLP2K?= =?us-ascii?Q?4SzeFAkcoCw4LWlxnTtf5/3TJPFAq6sZvln/n1JMjuqx0kDD4/ODw58KblBz?= =?us-ascii?Q?ZmEdG6yM8oPItLPkBax+DeJDarvo3++nln282txuut7mzOJIvoumPmnUXJPz?= =?us-ascii?Q?fCw=3D=3D?= X-Microsoft-Antispam-Message-Info: mkVnjxYGZ0cNPcKBTOgY55lETjJBzGXoAXjqWl6sb7ZR1FAyMGQkGIXUwS5IhuqxvA4F2yvFw57BsCL5E71DRjM6bufORBh+DwQw0gnoZ7rxt+N4vjOG4E30QRtxmQhFvpTlwaAZSeStT2LQOBxnat2yPPQNrdesspGYoHQ/6kP8oJ7I3jC2LuCnMUWzAe3D X-Microsoft-Exchange-Diagnostics: 1; DB6PR0501MB2037; 6:r58yDnQ2z6VJIbmjEP+w5Rr9l9gE8XZmSmNfGMEIhR23LmFZBsnvgxvG91vcAum/WyILXWxm0Mqa34/1HV24b52LEUchOFuriXve6HBwtfjgBtrUwA2tLfXlVuyk8W7em35SrIpiUe/y6kzewuWEOHr7yPukbM1Mpwbq9fQuDSdS4/MC194o0cej7ysHJ74jwvE+TBI12ZPoC8DMJ0PxHQelce8UGv+jHkJfGp2bsLm8eAXkDPnEGztW+wArl1UC05F0Sa3W+O0aQxlVRI6S7llV4D3OZ1cDXMjGfkpJQviZgvzCFWhZMbPx43dEMCnAo3PxeeqJMDKJAmTyU6hXH0dXz6ES657Py2LSRIe/E/E1FXrntdFkiMTC3arb3F6OQx30jFAFwwUBn7dUb35pV2Nvr0XKEfXxevNusSaNFOQcB6jPbjw3dV5ML9sIbtLMCI905zY6DuMrNfqubQwdFw==; 5:FwJHfFNoeXw/ecdRhYeHiQhliDu0/1X4LA0HJKobtl/3wHcjm1J6Ueop3v7J1CCekts+n+qgRIzafs6u0grd2TCbnTDqpGtlYbI4uFrvcS8tAZ2vG6H4x/mCjFXQWJ77jgaOOgZCC2AqEi1sI22TfgJ6wd7pZH0Ro4arAr5KIJ4=; 24:ik9TupIi7vX7jNN8umU4znMlqrFO1Ps+WbYCTMZoVcShp2fIzJOQzUglYEkasmiLC9Vc757SxBrmoGyH9fD/nSwdsFlR5bviyEtt6bZ55uU= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; DB6PR0501MB2037; 7:KxFmMnR6I35pCkkbbxIy7WHD4oeqh32JqDbUKcibpkPBDkxxAmORuH7RXKfQzqD4Lh9UNjSPyTwKfDaAx978LWy/4VbVPCQPShIBl8YMmkMnpdlECUUYQIw+EKgDZLi4UN5LFsBcXHOpLgLNlIrf/4XK6VjHfrhtXsxu+LjiGbAl4SEgvfsrYOvz1HN3rGY+hZ1sbtCWn2mW5oEiMVXWAlPL2eSrGzOysXL8IbQ862DWQsjOEFP+ZgJAk4EKJBBA X-MS-Office365-Filtering-Correlation-Id: 5b4bf28c-ba97-426f-1e6e-08d5aa57ca1d X-OriginatorOrg: Mellanox.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Apr 2018 02:53:55.4137 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 5b4bf28c-ba97-426f-1e6e-08d5aa57ca1d X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: a652971c-7d2e-4d9b-a6a4-d149256f461b X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB6PR0501MB2037 Subject: [dpdk-dev] [PATCH v5 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: , X-List-Received-Date: Wed, 25 Apr 2018 02:53:59 -0000 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 --- ** 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. 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 | 303 ++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 274 insertions(+), 29 deletions(-) diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h index 43aaa9c5f..e2c12874a 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,33 @@ 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) (!(RTE_MBUF_CLONED(mb) || RTE_MBUF_HAS_EXTBUF(mb))) /** * Private data in case of pktmbuf pool. @@ -839,6 +880,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 +1306,127 @@ static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool, } /** + * 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. This callback function will be called once all the mbufs are + * detached from the buffer. + * + * 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()`` can 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()``. + * + * 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 we're attaching to. + * @param buf_iova + * IO address of the external buffer we're attaching to. + * @param buf_len + * The size of the external buffer we're attaching to. If memory for + * shared data is not provided, 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 shinfo + * User-provided memory for shared data. If NULL, a few bytes in the + * trailer of the provided buffer will be dedicated for shared data and + * the shared data will be properly initialized. Otherwise, user must + * initialize the content except for free callback and its argument. The + * pointer of shared data will be stored in m->shinfo. + * @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 new start of the data on success, return NULL + * otherwise. + */ +static inline char * __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, + rte_mbuf_extbuf_free_callback_t free_cb, void *fcb_opaque) +{ + /* Additional attachment should be done by rte_pktmbuf_attach() */ + RTE_ASSERT(!RTE_MBUF_HAS_EXTBUF(m)); + + m->buf_addr = buf_addr; + m->buf_iova = buf_iova; + + if (shinfo == NULL) { + 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; + + m->buf_len = RTE_PTR_DIFF(shinfo, buf_addr); + rte_mbuf_ext_refcnt_set(shinfo, 1); + } else { + m->buf_len = buf_len; + } + + m->data_len = 0; + m->data_off = 0; + + m->ol_flags |= EXT_ATTACHED_MBUF; + m->shinfo = shinfo; + + shinfo->free_cb = free_cb; + shinfo->fcb_opaque = fcb_opaque; + + return (char *)m->buf_addr + m->data_off; +} + +/** + * 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 +1440,19 @@ 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; + } 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 +1468,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 +1476,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 +1530,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 +1549,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 +1572,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 +1584,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) { -- 2.11.0