rte_regex_ops(3)

🦋 rte_regex_ops(3) — NAME

okay bestie, gather round 💖 this is rte_regex_ops — the generic struct that holds all your RegEx attributes so you can do the enqueue and dequeue thing. it lives in section 3 of the library functions manual, and it is the glow-up your packet regex pipeline needed. no cap.

---

✨ 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 []

---

💜 DESCRIPTION (Detailed Description) 💜

the generic rte_regex_ops structure — she holds the RegEx attributes for enqueue and dequeue operation. that's her whole job and she ate 💅

Definition at line 1344 of file rte_regexdev.h.

---

🌸 FIELD DOCUMENTATION 🌸

💫 uint16_t req_flags

Request flags for the RegEx ops. the vibe-check flags, basically ✨

See also: RTE_REGEX_OPS_REQ_*

Definition at line 1346 of file rte_regexdev.h.

💫 uint16_t rsp_flags

Response flags for the RegEx ops.

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. the real ones. the ones that were always there 🫶

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. The size of rte_regex_ops::matches zero length array will be this value. so like… she says how big she is. iconic.

See also: struct rte_regex_ops::matches, struct rte_regexdev_match

Definition at line 1356 of file rte_regexdev.h.

💫 struct rte_mbuf* mbuf

source mbuf, to search in. the main character of the operation ngl 🌈

Definition at line 1365 of file rte_regexdev.h.

💫 uint16_t group_id0

First group_id to match the rule against. At minimum one group should be valid. Behaviour is undefined non of the groups are valid. 😭 so like. please. at least one valid group. i am begging.

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.

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.

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.

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 application specific value to share between dequeue and enqueue operation. Implementation should not modify this field. 🔒 hands off, that's your little secret, not the implementation's.

Definition at line 1392 of file rte_regexdev.h.

💫 void* user_ptr

Pointer representation of user_id

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. The application must send it back when calling enqueue with the following packet. 👑 like a little baton pass between packets. don't drop it fr fr.

Definition at line 1404 of file rte_regexdev.h.

💫 void* cross_buf_ptr

Pointer representation of corss_buf_id (yes we're spelling it like that, it's in the source 😌)

Definition at line 1411 of file rte_regexdev.h.

💫 struct rte_regexdev_match matches[]

Zero length array to hold the match tuples. The struct rte_regex_ops::nb_matches value holds the number of elements in this array.

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 hardworking documentation generator. slay, honestly.

---

and that's the whole page bestie, tysm for reading 🫶 this was DPDK, Version 25.11.3, and the page is rte_regex_ops(3) — go forth and match some patterns ✨💅🎀