rte_comp_compress_xform(3)

📦 version 26.03, in nixos 26.05, nixpkgs unstable

💅 rte_comp_compress_xform — NAME

okay so bestie, this is rte_comp_compress_xform 💖 — it's a struct from the DPDK Library Functions Manual, and it's literally the setup data for compression. That's the whole vibe. It holds all the config knobs you hand over so a compress operation knows what to do. No cap.

✨ SYNOPSIS ✨

#include <rte_comp.h>

🎀 Data Fields 🎀

enum rte_comp_algorithm algo
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 job — it's the little bundle of settings that tells the compression machinery how you want the thing compressed.

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, bestie — this is the one that decides which algorithm does the actual compressing.

Definition at line 307 of file rte_comp.h. 📍

💜 struct rte_comp_deflate_params deflate

Parameters specific to the deflate algorithm. So these knobs only matter when deflate is the algorithm in the hot seat.

Definition at line 310 of file rte_comp.h. 📍

💜 struct rte_comp_lz4_params lz4

Parameters specific to the LZ4 algorithm. Same deal, but for LZ4 — its own little parameter corner.

Definition at line 312 of file rte_comp.h. 📍

💜 union { ... }

Algorithm specific parameters — the union that holds either the deflate params or the lz4 params, depending on which algorithm you picked. It's giving "one slot, two possible moods". 🫶

💜 int level

Compression level. You know how it goes — crank it one way for more squeezing, the other way for more speed.

Definition at line 315 of file rte_comp.h. 📍

💜 uint8_t window_size

Base two log value of sliding window to be used. Yes — it's the base two log value, not the raw size, so don't come in here thinking it's bytes, okay?

And here's the caveat you gotta know: if the window size can't be supported by the PMD, then it may fall back to a smaller size. That's the tradeoff — and it's likely to result in a worse compression ratio. 😭 So like, it still works, it's just not gonna squeeze as hard as you wanted.
Definition at line 317 of file rte_comp.h. 📍

💜 enum rte_comp_checksum_type chksum

Type of checksum to generate on the uncompressed data. Lowkey important — the checksum is computed over the uncompressed data, not the squeezed version.

Definition at line 322 of file rte_comp.h. 📍

💜 enum rte_comp_hash_algorithm hash_algo

Hash algorithm to be used with compress operation. And listen — the hash is always done on plaintext. Always. Periodt. ✨

Definition at line 324 of file rte_comp.h. 📍

👑 Author 👑

Generated automatically by Doxygen for DPDK from the source code. So nobody hand-wrote this bad boy — it's the docs equivalent of a bot that ate, honestly. 🤖💅

🌸 and that's the page, bestie! 🌸 This one's brought to you by DPDK, Version 26.03.0, living its best life under the title rte_comp_compress_xform(3). Go compress something iconic 💖🎀🦋

📦 where this page comes from