rte_regexdev_config(3)

📦 version 26.03, in nixos 26.05, nixpkgs unstable

💅 rte_regexdev_config(3) — the Library Functions Manual bestie ✨

okay so this is a whole manual page from DPDK for rte_regexdev_config, and it's literally the struct you fill out when you wanna tell a RegEx device how to behave. it's giving "config struct energy" and honestly? iconic. let's get into it 🫶

✨ NAME ✨

rte_regexdev_config — the RegEx device configuration structure, no cap 💖

🌸 SYNOPSIS 🌸

#include <rte_regexdev.h>

Data Fields 👑 (these are the members, keep them exactly as-is, don't be weird about it):

  • uint16_t nb_max_matches
  • uint16_t nb_queue_pairs
  • uint32_t nb_rules_per_group
  • uint16_t nb_groups
  • const char * rule_db
  • uint32_t rule_db_len
  • uint32_t dev_cfg_flags

🦋 DESCRIPTION (Detailed Description) 🦋

so basically it's the RegEx device configuration structure 📝 — the vibe you hand over when you're setting a device up.

fr fr it says "Definition at line 679 of file rte_regexdev.h." so if you ever need to go look at the source, that's where it lives, iykyk 🔍

🎀 FIELD DOCUMENTATION 🎀

🌈 uint16_t nb_max_matches

the maximum matches per scan that you're configuring on this device. 🎯

the way that this value cannot exceed the max_matches which previously provided in rte_regexdev_info_get() — like, that's the ceiling bestie, do not test it 💀

the value 0 is allowed though, in which case, value 1 used. yes really. zero means one. we don't make the rules ✨

See also: struct rte_regexdev_info::max_matches

Definition at line 680 of file rte_regexdev.h.

🌸 uint16_t nb_queue_pairs

number of RegEx queue pairs to configure on this device 🧵✨

this value cannot exceed the max_queue_pairs which previously provided in rte_regexdev_info_get(). again — previous call said the limit, you respect the limit, periodt 💅

See also: struct rte_regexdev_info::max_queue_pairs

Definition at line 687 of file rte_regexdev.h.

⭐ uint32_t nb_rules_per_group

number of rules per group to configure on this device 🗂️

this value cannot exceed the max_rules_per_group which previously provided in rte_regexdev_info_get(). the audacity of limits, honestly 🙈

the value 0 is allowed, in which case struct rte_regexdev_info::max_rules_per_group used. yup, auto-fill from the info struct, slay 🫶

See also: struct rte_regexdev_info::max_rules_per_group

Definition at line 693 of file rte_regexdev.h.

🦋 uint16_t nb_groups

number of groups to configure on this device 🎀

this value cannot exceed the max_groups which previously provided in rte_regexdev_info_get(). pattern recognition bestie: every "cannot exceed" is the same energy — check the info struct first ✅

See also: struct rte_regexdev_info::max_groups

Definition at line 701 of file rte_regexdev.h.

🔥 const char* rule_db

imports the initial set of prebuilt rule database on this device 📦✨

the value NULL is allowed, in which case, the device will not be configured with a prebuilt rule database. totally valid, no judgement 🫶

if you do skip it at config time, your application may use rte_regexdev_rule_db_update() or rte_regexdev_rule_db_import() API to update or import rule database after the rte_regexdev_configure(). so you're not locked out, you're just doing it later 💅

See also: rte_regexdev_rule_db_update(), rte_regexdev_rule_db_import()

Definition at line 707 of file rte_regexdev.h.

🍓 uint32_t rule_db_len

length of rule_db buffer 📏 — that's it, that's the whole field, short and sweet, main character with minimal dialogue ✨

Definition at line 716 of file rte_regexdev.h.

💜 uint32_t dev_cfg_flags

RegEx device configuration flags 🚩 — see RTE_REGEXDEV_CFG_* for the actual flag names, go look at those, ikyk 👀

Definition at line 718 of file rte_regexdev.h.

👑 AUTHOR 👑

Generated automatically by Doxygen for DPDK from the source code. 🤖💖 yes a robot wrote it, and it ate, lowkey.

💫 cute sign-off 💫

and that's the whole page bestie!! 🌈 this was DPDK, Version 26.03.0, manual page rte_regexdev_config(3) — go configure your regex device responsibly, check your info struct first, and remember: zero sometimes means one. mwah 💋🎀🦋

📦 where this page comes from