rte_comp_compress_xform(3)

💅 NAME 💅

rte_comp_compress_xform — she's from the Library Functions Manual, and she's the struct that holds all your compression setup data. That's the name, that's the whole name, no subtitle, she doesn't need one. 👑

---

✨ SYNOPSIS ✨

Okay bestie, first things first, you gotta pull her in:

#include <rte_comp.h>

Data Fields (the whole squad, in order):

• enum rte_comp_algorithm algo
• an anonymous union holding the algorithm-specific stuff:

union {
   struct rte_comp_deflate_params deflate
   struct rte_comp_lz4_params lz4
};

• int level
• uint8_t window_size
• enum rte_comp_checksum_type chksum
• enum rte_comp_hash_algorithm hash_algo

---

🦋 Detailed Description 🦋

Setup Data for compression. That's it, that's the whole vibe — this is the struct you fill in so the compression side knows what it's doing. 💖

Definition at line 306 of file rte_comp.h.

---

📖 Field Documentation 📖

🎀 enum rte_comp_algorithm algo

Algorithm to use for compress operation. Pick your fighter. ✨

Definition at line 307 of file rte_comp.h.

🎀 struct rte_comp_deflate_params deflate

Parameters specific to the deflate algorithm. All the deflate-only details live here, no sharing. 💅

Definition at line 310 of file rte_comp.h.

🎀 struct rte_comp_lz4_params lz4

Parameters specific to the LZ4 algorithm. Same deal, but make it LZ4. 🌸

Definition at line 312 of file rte_comp.h.

🎀 union { ... }

Algorithm specific parameters. This is the lil union that switches lanes depending on which algo you picked, so it's giving choose your own adventure. 🦋

Heads up: this one's the only field in the doc with no "Definition at line" note attached. Not me gatekeeping, that's just how it is. 🙈

🎀 int level

Compression level. Turn it up or keep it chill. 🔥

Definition at line 315 of file rte_comp.h.

🎀 uint8_t window_size

Base two log value of sliding window to be used. If window size can't be supported by the PMD then it may fall back to a smaller size. This is likely to result in a worse compression ratio.

So like, if your PMD can't hang with the window you asked for, it lowkey downgrades you, and bestie, the compression ratio will suffer. Not a warning exactly, just the truth. 😭

Definition at line 317 of file rte_comp.h.

🎀 enum rte_comp_checksum_type chksum

Type of checksum to generate on the uncompressed data. Yes, on the uncompressed data. Read it again, it says what it says. ⭐

Definition at line 322 of file rte_comp.h.

🎀 enum rte_comp_hash_algorithm hash_algo

Hash algorithm to be used with compress operation. Hash is always done on plaintext.

Periodt. Plaintext, always. No sneaky hashing-the-compressed-bytes situation happening here. 👑

Definition at line 324 of file rte_comp.h.

---

🫶 Author 🫶

Generated automatically by Doxygen for DPDK from the source code. So like, a robot wrote it, but the robot ate. 🤖✨

---

and that's the whole page, bestie — courtesy of DPDK, Version 25.11.3, which is the vibe check this whole thing passed. mwah 💋