rte_memzone(3)

πŸ’– rte_memzone πŸ’–

okay bestie, gather round, because today we're meeting rte_memzone β€” the main character of the DPDK memory world. this page lives in section 3 of the manual (Library Functions Manual, iykyk), so think of it as the little laminated card taped to the inside of your locker that explains exactly what a memzone is. no cap, every field, every line number, every "Definition at line" β€” it's all here. let's go πŸ¦‹


✨ NAME ✨

rte_memzone β€” the struct that describes a memzone, periodt.


🌸 SYNOPSIS 🌸

#include <rte_memzone.h>

πŸŽ€ Data Fields

so here's the lineup of fields, in the order the page lists them:

  • char name [RTE_MEMZONE_NAMESIZE]
  • rte_iova_t iova
  • size_t len
  • uint64_t hugepage_sz
  • int32_t socket_id
  • uint32_t flags

πŸ’… Detailed Description πŸ’…

A structure describing a memzone, which is a contiguous portion of physical memory identified by a name.

fr fr, that's the whole vibe: a memzone is a chunk of physical memory, it's contiguous, and you find it again by its name. that's it. that's the girl. πŸ‘‘

Definition at line 48 of file rte_memzone.h.


🧚 Field Documentation 🧚

this is the part where we meet every single member one by one, like a reality show intro sequence. no skips, no cuts. 🌈

  • char name[RTE_MEMZONE_NAMESIZE] β€” Name of the memory zone.

Definition at line 51 of file rte_memzone.h.

  • rte_iova_t iova β€” Start IO address.

Definition at line 53 of file rte_memzone.h.

  • void* addr β€” Start virtual address.

Definition at line 55 of file rte_memzone.h.

  • uint64_t addr_64 β€” Makes sure addr is always 64-bits. (yes, it really does say that, and yes, it's iconic of it to just announce its whole purpose like that 😭)

Definition at line 56 of file rte_memzone.h.

  • size_t len β€” Length of the memzone.

Definition at line 58 of file rte_memzone.h.

  • uint64_t hugepage_sz β€” The page size of underlying memory.

Definition at line 60 of file rte_memzone.h.

  • int32_t socket_id β€” NUMA socket ID.

Definition at line 62 of file rte_memzone.h.

  • uint32_t flags β€” Characteristics of this memzone.

Definition at line 64 of file rte_memzone.h.

psst β€” tiny lil heads-up so you're not confused later: the Data Fields list up in the synopsis doesn't name addr or addr_64, but the Field Documentation absolutely does, at lines 55 and 56. i'm not fixing it, i'm just telling you, because that's how the page reads. πŸ’œ

🫢 Author 🫢

Generated automatically by Doxygen for DPDK from the source code.


okay and that's the whole page, bestie!! you now know rte_memzone better than it knows itself. this little doc came to you courtesy of DPDK, Version 25.11.3 β€” so if you're out here slaying with memzones, that's the version whose manual you just read. mwah, go build something gorgeous. πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ’…

πŸ“¦ where this page comes from