DPDK  19.08.0-rc0
Data Fields
rte_regex_ops Struct Reference

#include <rte_regexdev.h>

Data Fields

uint16_t req_flags
 
uint16_t scan_size
 
uint16_t rsp_flags
 
uint8_t nb_actual_matches
 
uint8_t nb_matches
 
rte_iova_t buf_iova
 
uint16_t group_id0
 
uint16_t group_id1
 
uint16_t group_id2
 
uint16_t group_id3
 
struct rte_regex_match matches []
 
uint64_t u64
 
void * buf_addr
 
uint64_t user_id
 
void * user_ptr
 

Detailed Description

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

Definition at line 1077 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 1079 of file rte_regexdev.h.

◆ scan_size

uint16_t scan_size

Scan size of the buffer to be scanned in bytes.

Definition at line 1083 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 1085 of file rte_regexdev.h.

◆ nb_actual_matches

uint8_t nb_actual_matches

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

Definition at line 1089 of file rte_regexdev.h.

◆ nb_matches

uint8_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_regex_match

Definition at line 1091 of file rte_regexdev.h.

◆ u64

uint64_t u64

Allow 8-byte reserved on 32-bit system

Definition at line 1102 of file rte_regexdev.h.

◆ buf_addr

void* buf_addr

Virtual address of the pattern to be matched.

Definition at line 1104 of file rte_regexdev.h.

◆ buf_iova

rte_iova_t buf_iova

IOVA address of the pattern to be matched.

Definition at line 1109 of file rte_regexdev.h.

◆ group_id0

uint16_t group_id0

First group_id to match the rule against. Minimum one group id must be provided by application. When RTE_REGEX_OPS_REQ_GROUP_ID1_VALID_F set then group_id1 is valid, respectively similar flags for group_id2 and group_id3. Upon the match, struct rte_regex_match::group_id shall be updated with matching group ID by the device. Group ID scheme provides rule isolation and effective pattern matching.

Definition at line 1113 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 1122 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 1127 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 1132 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 1141 of file rte_regexdev.h.

◆ user_ptr

void* user_ptr

Pointer representation of user_id

Definition at line 1147 of file rte_regexdev.h.

◆ matches

struct rte_regex_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 1152 of file rte_regexdev.h.


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