rte_mbuf_pool_ops.h(3)

πŸ’– rte_mbuf_pool_ops.h β€” the DPDK mbuf pool ops glow-up πŸ’–

okay bestie, so this is rte_mbuf_pool_ops.h, a Library Functions Manual situation, and it's literally all about choosing which mempool ops your pktmbufs get to live in. it's giving matchmaker but for memory pools. πŸŽ€


✨ NAME ✨

rte_mbuf_pool_ops.h β€” the header for RTE Mbuf Pool Ops πŸ¦‹


✨ SYNOPSIS ✨

🌸 Functions 🌸

int rte_mbuf_set_platform_mempool_ops (const char *ops_name)
const char * rte_mbuf_platform_mempool_ops (void)
int rte_mbuf_set_user_mempool_ops (const char *ops_name)
const char * rte_mbuf_user_mempool_ops (void)
const char * rte_mbuf_best_mempool_ops (void)

✨ Detailed Description ✨

RTE Mbuf Pool Ops πŸ‘‘

so like. these APIs are for configuring the mbuf pool ops names that are gonna be largely used by rte_pktmbuf_pool_create(). that's the main character move. πŸ’…

but also?? you can use them to set and inquire the best mempool ops available. so it's both a setter vibe and a "hey which one's the bestie" vibe. 🫢

this is all defined in the file rte_mbuf_pool_ops.h.


✨ Function Documentation ✨

🌈 int rte_mbuf_set_platform_mempool_ops (const char * ops_name)

set the platform supported pktmbuf HW mempool ops name β€” no cap, that's the whole job.

this function lets the HW register the actively supported HW mempool ops_name. and listen β€” only one HW mempool ops can be registered at any point of time. one. singular. monogamy only. πŸ™ˆ

Parameters

  • ops_name

Returns

  • on success, zero. πŸŽ€
  • on failure, a negative value. 😭

πŸ¦‹ const char * rte_mbuf_platform_mempool_ops (void )

get configured platform supported pktmbuf HW mempool ops name β€” the little getter that could.

this function returns the platform supported mempool ops name. simple. iconic. ⭐

Returns

  • on success, platform pool ops name. ✨
  • on failure, NULL. πŸ’€

πŸ’œ int rte_mbuf_set_user_mempool_ops (const char * ops_name)

set the user preferred pktmbuf mempool ops name

this function can be used by you (yes you, bestie) to configure the user preferred mempool ops name. manifesting your fave. 🌸

Parameters

  • ops_name

Returns

  • on success, zero. πŸŽ€
  • on failure, a negative value. 😭

πŸ“ const char * rte_mbuf_user_mempool_ops (void )

get user preferred pool ops name for mbuf

this function returns the user configured mempool ops name. your pick, your rules. πŸ‘‘

Returns

  • on success, user pool ops name. πŸ’–
  • on failure, NULL. πŸ’€

🧚 const char * rte_mbuf_best_mempool_ops (void )

get the best mempool ops name for pktmbuf.

this function is used to determine the best options for mempool ops for pktmbuf allocations. it's the vibe check. 🌈

and here's the priority order, in order, do not shuffle:

  1. User defined
  2. Platform HW supported
  3. Compile time configured

also, this function is used by rte_pktmbuf_pool_create to get the best mempool ops name. so yeah, it's kind of a big deal. πŸ”₯

Returns

returns preferred mbuf pool ops name.


✨ Author ✨

Generated automatically by Doxygen for DPDK from the source code. πŸ€– (not me writing this by hand, the robots did it, and honestly they ate)


not me getting emotional over a mempool ops getter. anyway. go forth and allocate. 🫢✨

okay that's the whole page bestie, and for the cute sign-off: this was DPDK, Version 25.11.3, dated with rte_mbuf_pool_ops.h(3). slay, periodt, go pick your pool ops wisely πŸ’…πŸŽ€

πŸ“¦ where this page comes from