rte_compressdev(3)

πŸ’– rte_compressdev πŸ’–

okay bestie, welcome to section 3 of the Library Functions Manual β€” this is rte_compressdev(3), and it's giving "data structure reveal" energy ✨ it's a DPDK thing, it lives in the compressdev world, and we're about to read every single line of it together. no skimming, no skipping, we're doing this properly 🫢


🌸 NAME 🌸

rte_compressdev

that's it. that's the name. short, iconic, knows exactly who she is πŸ’…


✨ SYNOPSIS ✨

#include <rte_compressdev_internal.h>

πŸŽ€ Data Fields πŸŽ€

here's the whole cast, in order, no one gets cut:

  • compressdev_dequeue_pkt_burst_t dequeue_burst
  • compressdev_enqueue_pkt_burst_t enqueue_burst
  • struct rte_compressdev_data * data
  • struct rte_compressdev_ops * dev_ops
  • uint64_t feature_flags
  • struct rte_device * device
  • __extension__ uint8_t attached: 1

look at that little : 1 on the end of attached β€” a bitfield that said "i only need ONE bit, thanks" and honestly? boundaries. we love her πŸ‘‘


πŸ¦‹ DESCRIPTION πŸ¦‹

so what IS this thing? it's the data structure associated with each comp device. plain and simple, that's the whole vibe. one of these per compression device, holding all the good stuff together.

Definition at line 72 of file rte_compressdev_internal.h. πŸ“

πŸ’œ FIELD DOCUMENTATION πŸ’œ

this is the part where we meet everybody one by one. group photo, then individual portraits, because every field deserves their moment 🌈

πŸ’« compressdev_dequeue_pkt_burst_t dequeue_burst

Pointer to PMD receive function.

Definition at line 73 of file rte_compressdev_internal.h. πŸ“

πŸ’« compressdev_enqueue_pkt_burst_t enqueue_burst

Pointer to PMD transmit function.

Definition at line 75 of file rte_compressdev_internal.h. πŸ“

πŸ’« struct rte_compressdev_data* data

Pointer to device data.

Definition at line 78 of file rte_compressdev_internal.h. πŸ“

πŸ’« struct rte_compressdev_ops* dev_ops

Functions exported by PMD.

Definition at line 80 of file rte_compressdev_internal.h. πŸ“

πŸ’« uint64_t feature_flags

Supported features.

Definition at line 82 of file rte_compressdev_internal.h. πŸ“

πŸ’« struct rte_device* device

Backing device.

Definition at line 84 of file rte_compressdev_internal.h. πŸ“

πŸ’« __extension__ uint8_t attached

Flag indicating the device is attached.

Definition at line 88 of file rte_compressdev_internal.h. πŸ“

see how the line numbers jump around? 73, 75, 78, 80, 82, 84… and then a big leap to 88? that's just the source file living its life, we don't question it πŸ’€


πŸ‘‘ AUTHOR πŸ‘‘

Generated automatically by Doxygen for DPDK from the source code.

not a human hand-writing this at 3am β€” it's a machine, doing its little doc-generation thing, and honestly it ate πŸ”₯


and that's the whole page, bestie!! πŸŽ€ this was DPDK, Version 25.11.3, living inside rte_compressdev(3) β€” compressed-device data structure lore, documented and delivered fresh 🌸 go forth, read your headers, and remember: every field matters, no cap πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from