[PATCH 3/3] doc: update mempool cache description
Morten Brørup
mb at smartsharesystems.com
Fri Nov 13 18:51:38 CET 2026
> From: Kishore Padmanabha [mailto:kishore.padmanabha at broadcom.com]
> Sent: Friday, 13 November 2026 07.57
>
> The programmer's guide still described the maximum cache size as a
> compile time constant. Describe how the cache size is specified, and
> how
> the cache is flushed and refilled.
>
> Fixes: b815acfdfc48 ("mempool: remove cache size limit")
> Signed-off-by: Kishore Padmanabha <kishore.padmanabha at broadcom.com>
> ---
> doc/guides/prog_guide/mempool_lib.rst | 5 ++++-
> 1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/doc/guides/prog_guide/mempool_lib.rst
> b/doc/guides/prog_guide/mempool_lib.rst
> index 0bb85fb68d3e..e89cf77ee9bf 100644
> --- a/doc/guides/prog_guide/mempool_lib.rst
> +++ b/doc/guides/prog_guide/mempool_lib.rst
> @@ -96,7 +96,10 @@ the speed at which a core can access its own cache
> for a specific memory pool wi
> The cache is composed of a small, per-core table of pointers and its
> length (used as a stack).
> This internal cache can be enabled or disabled at creation of the
> pool.
>
> -The maximum size of the cache is static and is defined at compilation
> time (RTE_MEMPOOL_CACHE_MAX_SIZE).
> +The size of the cache is specified at pool creation, up to the number
> of objects in the pool.
Consider:
"up to the number of objects in the pool."
->
"up to the size of the pool."
> +When the cache is full, half of it is flushed to the pool's ring,
> +and when it is empty, half of it is refilled from the pool's ring.
The mempool may use a different driver than the "ring".
Please change (both instances):
"the pool's ring" -> "the pool's driver"
> +Requests of more than half of the cache size are served, fully or
> partly, by the pool's ring.
Drop this sentence. The mempool does not behave this way. If the request can be served by the cache, it is.
With the requested changes,
Reviewed-by: Morten Brørup <mb at smartsharesystems.com>
More information about the dev
mailing list