DPDK  23.03.0
Data Fields
rte_regex_ops Struct Reference

#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_mbufmbuf
 
uint16_t group_id0
 
uint16_t group_id1
 
uint16_t group_id2
 
uint16_t group_id3
 
struct rte_regexdev_match matches []
 
uint64_t user_id
 
void * user_ptr
 
uint64_t cross_buf_id
 
void * cross_buf_ptr
 

Detailed Description

The generic rte_regex_ops structure to hold the RegEx attributes for enqueue and dequeue operation.

Definition at line 1349 of file rte_regexdev.h.

Field Documentation

◆ req_flags

uint16_t req_flags

Request flags for the RegEx ops.

See also
RTE_REGEX_OPS_REQ_*

Definition at line 1351 of file rte_regexdev.h.

◆ rsp_flags

uint16_t rsp_flags

Response flags for the RegEx ops.

See also
RTE_REGEX_OPS_RSP_*

Definition at line 1355 of file rte_regexdev.h.

◆ nb_actual_matches

uint16_t nb_actual_matches

The total number of actual matches detected by the Regex device.

Definition at line 1359 of file rte_regexdev.h.

◆ nb_matches

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 1361 of file rte_regexdev.h.

◆ mbuf

struct rte_mbuf* mbuf

source mbuf, to search in.

Definition at line 1370 of file rte_regexdev.h.

◆ group_id0

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 1373 of file rte_regexdev.h.

◆ group_id1

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 1379 of file rte_regexdev.h.

◆ group_id2

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 1384 of file rte_regexdev.h.

◆ group_id3

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 1389 of file rte_regexdev.h.

◆ user_id

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 1398 of file rte_regexdev.h.

◆ user_ptr

void* user_ptr

Pointer representation of user_id

Definition at line 1404 of file rte_regexdev.h.

◆ cross_buf_id

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 1411 of file rte_regexdev.h.

◆ cross_buf_ptr

void* cross_buf_ptr

Pointer representation of corss_buf_id

Definition at line 1418 of file rte_regexdev.h.

◆ matches

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 1423 of file rte_regexdev.h.


The documentation for this struct was generated from the following file: