rte_regex_ops(3)

📦 version 26.03, in nixos 26.05, nixpkgs unstable

💅 rte_regex_ops

okay bestie, welcome to the Library Functions Manual ✨ — yes this is a manpage, yes it's about a struct, and yes we're gonna make it cute. This is rte_regex_ops, and she is the main character when it comes to RegEx things. 🎀

🌸 SYNOPSIS 🌸

#include <rte_regexdev.h>

🦋 Data Fields

  • uint16_t req_flags
  • uint16_t rsp_flags
  • uint16_t nb_actual_matches
  • uint16_t nb_matches
  • struct rte_mbuf * mbuf
  • uint16_t group_id0
  • uint16_t group_id1
  • uint16_t group_id2
  • uint16_t group_id3
  • struct rte_regexdev_match matches []

✨ Detailed Description ✨

So the generic rte_regex_ops structure is the whole point of this page — it holds all the RegEx attributes for both the enqueue and dequeue operation. like, both. at once. multitasking icon behavior fr fr 💅

📍 Definition at line 1344 of file rte_regexdev.h.

💖 Field Documentation 💖

⭐ uint16_t req_flags

The request flags for the RegEx ops. yeah, the "what do I want" flags 🫶

See also: RTE_REGEX_OPS_REQ_*

📍 Definition at line 1346 of file rte_regexdev.h.

⭐ uint16_t rsp_flags

The response flags for the RegEx ops — the "what did I actually get back" flags 😌

See also: RTE_REGEX_OPS_RSP_*

📍 Definition at line 1350 of file rte_regexdev.h.

🌈 uint16_t nb_actual_matches

The total number of actual matches detected by the Regex device. not the returned ones, the actual ones — she's keeping receipts 👑

📍 Definition at line 1354 of file rte_regexdev.h.

🌈 uint16_t nb_matches

The total number of matches returned by the RegEx device for this scan. and listen — the size of the rte_regex_ops::matches zero length array will be this value. it literally sets the vibe check for how many matches you got 💀

See also: struct rte_regex_ops::matches, struct rte_regexdev_match

📍 Definition at line 1356 of file rte_regexdev.h.

🍓 struct rte_mbuf* mbuf

The source mbuf, to search in. that's the thing you're scanning bestie, no cap 🔍

📍 Definition at line 1365 of file rte_regexdev.h.

🧚 uint16_t group_id0

First group_id to match the rule against.

⚠️ okay this is the important one: at minimum one group should be valid. and behaviour is undefined if none of the groups are valid. undefined behavior is NOT the vibe, protect yourself 🚨

See also: RTE_REGEX_OPS_REQ_GROUP_ID0_VALID_F

📍 Definition at line 1368 of file rte_regexdev.h.

🧚 uint16_t group_id1

Second group_id to match the rule against. the sequel, and honestly she ate 💅

See also: RTE_REGEX_OPS_REQ_GROUP_ID1_VALID_F

📍 Definition at line 1374 of file rte_regexdev.h.

🧚 uint16_t group_id2

Third group_id to match the rule against. threequel energy, we love to see it 🌸

See also: RTE_REGEX_OPS_REQ_GROUP_ID2_VALID_F

📍 Definition at line 1379 of file rte_regexdev.h.

🧚 uint16_t group_id3

Forth group_id to match the rule against. yes it says "Forth", we don't gatekeep the original spelling here 😭 (it's group number four, bestie)

See also: RTE_REGEX_OPS_REQ_GROUP_ID3_VALID_F

📍 Definition at line 1384 of file rte_regexdev.h.

🎀 uint64_t user_id

Application specific opaque value. An application may use this field to hold an application specific value to share between the dequeue and enqueue operation.

🚫 and listen to this part: Implementation should not modify this field. hands off, that's the app's business, periodt 💅
📍 Definition at line 1392 of file rte_regexdev.h.

🎀 void* user_ptr

Pointer representation of user_id. same energy, pointer edition 🌟

📍 Definition at line 1398 of file rte_regexdev.h.

🔥 uint64_t cross_buf_id

ID used by the RegEx device in order to support cross packet detection. This ID is returned from the RegEx device on the dequeue function, and — heads up — the application must send it back when calling enqueue with the following packet. like a little handoff between packets, iykyk 🫱🫲

📍 Definition at line 1404 of file rte_regexdev.h.

🔥 void* cross_buf_ptr

Pointer representation of corss_buf_id. (yes it's spelled "corss" in the source, I am simply reporting the facts, do not come for me 🙈)

📍 Definition at line 1411 of file rte_regexdev.h.

👑 struct rte_regexdev_match matches[]

Zero length array to hold the match tuples. and the struct rte_regex_ops::nb_matches value holds the number of elements in this array. zero-length array but make it fashion ✨

See also: struct rte_regex_ops::nb_matches

📍 Definition at line 1416 of file rte_regexdev.h.

🌟 Author 🌟

Generated automatically by Doxygen for DPDK from the source code. not a human, just a very diligent robot doing robot things 🤖💜

okay that's the whole page bestie, you ate that 🫶 and for the lil sign-off moment: this beauty is from DPDK, Version 26.03.0, and lives at rte_regex_ops(3) — go forth and regex responsibly 💖✨🎀

📦 where this page comes from