---
name: "rte_regex_ops"
section: "3"
platform: "linux"
package: "dpdk-doc"
version: "24.11.4-0+deb13u1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/rte_regex_ops"
---

# rte\_regex\_ops(3)

## NAME

rte\_regex\_ops

## 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

The generic **rte\_regex\_ops structure to hold the RegEx attributes for enqueue and dequeue operation.**

**Definition at line 1344 of file rte\_regexdev.h.**

## Field Documentation

### uint16\_t req\_flags

**Request flags for the RegEx ops.**

**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.**

**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.**

**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.**

**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.**

**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.**

**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.**

**Definition at line 1404 of file rte\_regexdev.h.**

### void\* cross\_buf\_ptr

**Pointer representation of** *corss\_buf\_id*

**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.**