> From: Bruce Richardson [mailto:[email protected]] > Sent: Thursday, 9 October 2025 18.50 > > On Sat, Aug 23, 2025 at 06:30:00AM +0000, Morten Brørup wrote: > > Sanity checking a reinitialized mbuf (a.k.a. raw mbuf) has been > refactored > > to follow the same design pattern as sanity checking a normal mbuf, > and > > now depends on RTE_LIBRTE_MBUF_DEBUG instead of RTE_ENABLE_ASSERT. > > > > The details of the changes are as follows: > > > > Non-inlined functions rte_mbuf_raw_sanity_check() and > rte_mbuf_raw_check() > > have been added. > > They do for a reinitialized mbuf what rte_mbuf_sanity_check() and > > rte_mbuf_check() do for a normal mbuf. > > They basically check the same conditions as > __rte_mbuf_raw_sanity_check() > > previously did, but use "if (!condition) rte_panic(message)" instead > of > > RTE_ASSERT(), so they don't depend on RTE_ENABLE_ASSERT. > > > > The inline function __rte_mbuf_raw_sanity_check() has been replaced > > by the new macro __rte_mbuf_raw_sanity_check_mp(), which either calls > > rte_mbuf_raw_sanity_check() or does nothing, depending on > > RTE_LIBRTE_MBUF_DEBUG, just like the __rte_mbuf_sanity_check() macro > does > > for a normal mbuf. > > > > Note that the new macro __rte_mbuf_raw_sanity_check_mp() takes an > optional > > mempool parameter to verify that the mbuf belongs to the expected > mbuf > > pool. > > This addition is mainly relevant for sanity checking reinitialized > mbufs > > freed directly into a given mempool by a PMD when using > > RTE_ETH_TX_OFFLOAD_MBUF_FAST_FREE. > > > > The macro __rte_mbuf_raw_sanity_check() has been kept for backwards > API > > compatibility. > > It simply calls __rte_mbuf_raw_sanity_check_mp() without specifying a > > mempool. > > > > Signed-off-by: Morten Brørup <[email protected]> > > Acked-by: Andrew Rybchenko <[email protected]> > > Acked-by: Konstantin Ananyev <[email protected]> > > --- > > Looks ok to me, one comment inline below.
Thank you for reviewing, Bruce. Comment replied to inline below. :-) > > Acked-by: Bruce Richardson <[email protected]> > > > v3: > > * Removed experimental status for the new functions. > > Experimental is optional for new symbols, to allow for future API > > changes. But this has been around for a long time. (Stephen > Hemminger) > > * Consequentially, the added build check for ALLOW_EXPERIMENTAL_API > with > > RTE_LIBRTE_MBUF_DEBUG is no longer needed, and was removed. > > v2: > > * Added explicit build check for ALLOW_EXPERIMENTAL_API being enabled > when > > RTE_LIBRTE_MBUF_DEBUG is enabled, with descriptive error message if > not > > so. (Ivan Malov) > > * Fixed typo in patch description. > > --- > > lib/mbuf/rte_mbuf.c | 61 ++++++++++++++++++++++++++++ > > lib/mbuf/rte_mbuf.h | 96 +++++++++++++++++++++++++++---------------- > -- > > 2 files changed, 119 insertions(+), 38 deletions(-) > > > > diff --git a/lib/mbuf/rte_mbuf.c b/lib/mbuf/rte_mbuf.c > > index 9e7731a8a2..af39c13cf7 100644 > > --- a/lib/mbuf/rte_mbuf.c > > +++ b/lib/mbuf/rte_mbuf.c > > @@ -373,6 +373,67 @@ rte_pktmbuf_pool_create_extbuf(const char *name, > unsigned int n, > > return mp; > > } > > > > +/* do some sanity checks on a reinitialized mbuf: panic if it fails > */ > > +RTE_EXPORT_SYMBOL(rte_mbuf_raw_sanity_check) > > +void > > +rte_mbuf_raw_sanity_check(const struct rte_mbuf *m, const struct > rte_mempool *mp) > > +{ > > + const char *reason; > > + > > + if (rte_mbuf_raw_check(m, mp, &reason)) > > + rte_panic("%s\n", reason); > > +} > > + > > +RTE_EXPORT_SYMBOL(rte_mbuf_raw_check) > > +int rte_mbuf_raw_check(const struct rte_mbuf *m, const struct > rte_mempool *mp, > > + const char **reason) > > +{ > > + /* check sanity */ > > + if (rte_mbuf_check(m, 0, reason) == -1) > > + return -1; > > + > > + /* check initialized */ > > + if (rte_mbuf_refcnt_read(m) != 1) { > > + *reason = "uninitialized ref cnt"; > > + return -1; > > + } > > + if (m->next != NULL) { > > + *reason = "uninitialized next ptr"; > > + return -1; > > + } > > + if (m->nb_segs != 1) { > > + *reason = "uninitialized nb_segs"; > > + return -1; > > + } > > + if (RTE_MBUF_CLONED(m)) { > > + *reason = "cloned"; > > + return -1; > > + } > > + if (RTE_MBUF_HAS_EXTBUF(m)) { > > + if (!RTE_MBUF_HAS_PINNED_EXTBUF(m)) { > > + *reason = "external buffer not pinned"; > > + return -1; > > + } > > + > > + uint16_t cnt = rte_mbuf_ext_refcnt_read(m->shinfo); > > + if ((cnt == 0) || (cnt == UINT16_MAX)) { > > + *reason = "pinned external buffer bad ref cnt"; > > + return -1; > > + } > > + if (cnt != 1) { > > + *reason = "pinned external buffer uninitialized ref > cnt"; > > + return -1; > > + } > > + } > > + > > + if (mp != NULL && m->pool != mp) { > > + *reason = "wrong mbuf pool"; > > + return -1; > > + } > > + > > + return 0; > > +} > > + > > /* do some sanity checks on a mbuf: panic if it fails */ > > RTE_EXPORT_SYMBOL(rte_mbuf_sanity_check) > > void > > diff --git a/lib/mbuf/rte_mbuf.h b/lib/mbuf/rte_mbuf.h > > index 06ab7502a5..552cda1ae5 100644 > > --- a/lib/mbuf/rte_mbuf.h > > +++ b/lib/mbuf/rte_mbuf.h > > @@ -339,11 +339,17 @@ rte_pktmbuf_priv_flags(struct rte_mempool *mp) > > > > #ifdef RTE_LIBRTE_MBUF_DEBUG > > > > +/** check reinitialized mbuf type in debug mode */ > > +#define __rte_mbuf_raw_sanity_check_mp(m, mp) > rte_mbuf_raw_sanity_check(m, mp) > > + > > /** check mbuf type in debug mode */ > > #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, > is_h) > > > > #else /* RTE_LIBRTE_MBUF_DEBUG */ > > > > +/** check reinitialized mbuf type in debug mode */ > > This is in release mode, not debug mode. Comment below seems wrong too. Yes, I noticed the comment was present in both debug and release mode, which I couldn't understand. So I guessed it was for Doxygen or some other parser. I have seen weird stuff for Doxygen, e.g. "#ifdef __DOXYGEN__" for documenting a function [1], so I didn't attempt to understand the reason for it, but just followed the same pattern. Also, the comment says that the macro does something in debug mode, so I guess that the comment is not incorrect (but misleading) when describing a release mode macro. Again, I didn't understand it, so I left it as is. [1]: https://elixir.bootlin.com/dpdk/v25.07/source/lib/eal/include/generic/rte_memcpy.h#L94 > > > +#define __rte_mbuf_raw_sanity_check_mp(m, mp) do { } while (0) > > + > > /** check mbuf type in debug mode */ > > #define __rte_mbuf_sanity_check(m, is_h) do { } while (0) > > > > @@ -513,6 +519,46 @@ rte_mbuf_ext_refcnt_update(struct > rte_mbuf_ext_shared_info *shinfo, > > } while (0) > > <snip>
