3. Data Structures - NVIDIA Docs

doca_error_t ( *aging_init_cb )( doca_flow_ct_aging_ctx* ctx )
void ( *aging_shutdown_cb )( doca_flow_ct_aging_ctx* ctx )
void ( *aging_timer_cb )( doca_flow_ct_aging_ctx* ctx, uint64_t current_time_s )
void ( *conn_sync_cb )( doca_flow_ct_aging_ctx* ctx, doca_flow_ct_aging_conn_event* conn, uint32_t n )

Variables

doca_error_t ( *doca_flow_ct_aging_ops::aging_init_cb )( doca_flow_ct_aging_ctx* ctx )

Plugin init callback

void ( *doca_flow_ct_aging_ops::aging_shutdown_cb )( doca_flow_ct_aging_ctx* ctx )

Plugin shutdown callback

void ( *doca_flow_ct_aging_ops::aging_timer_cb )( doca_flow_ct_aging_ctx* ctx, uint64_t current_time_s )

Callback to check timeout connections based on counter statistics

void ( *doca_flow_ct_aging_ops::conn_sync_cb )( doca_flow_ct_aging_ctx* ctx, doca_flow_ct_aging_conn_event* conn, uint32_t n )

Before timer, Connection sync callback for changed connections

3.18. doca_flow_ct_cfg Struct Reference

[Doca Flow CT]

Public Variables

uint16_t aging_core
doca_flow_ct_aging_ops * aging_ops
uint16_t aging_query_delay_s
uint32_t base_core_id
struct doca_flow_ct_direction_cfg direction[2]
uint32_t dup_filter_sz
uint32_t entry_user_ctx_size
uint32_t flags
doca_flow_ct_flow_log_cb flow_log_cb
enumdoca_flow_ct_hash_type hash_type
uint32_t meta_action_bits
uint32_t meta_user_bits
doca_flow_meta * meta_zone_mask
uint32_t n_conn_counter_asymmetric
uint32_t nb_arm_queues
uint32_t nb_arm_sessions[DOCA_FLOW_CT_SESSION_MAX]
uint32_t nb_ctrl_queues
uint32_t nb_user_actions
uint16_t queue_depth
uint16_t tcp_session_del_s
uint16_t tcp_timeout_s
enumdoca_flow_tun_type tunnel_type
uint16_t udp_timeout_s
uint16_t vxlan_dst_port
struct doca_flow_ct_worker_callbacks worker_cb

Variables

uint16_t doca_flow_ct_cfg::aging_core [inherited]

CT aging thread bind to CPU core.

doca_flow_ct_aging_ops * doca_flow_ct_cfg::aging_ops [inherited]

Aging plugin callbacks

uint16_t doca_flow_ct_cfg::aging_query_delay_s [inherited]

CT aging query delay

uint32_t doca_flow_ct_cfg::base_core_id [inherited]

Base core id for the workers

struct doca_flow_ct_direction_cfg doca_flow_ct_cfg::direction[2] [inherited]

Configuration of each direction

uint32_t doca_flow_ct_cfg::dup_filter_sz [inherited]

Number of connections to cache in duplication filter

uint32_t doca_flow_ct_cfg::entry_user_ctx_size [inherited]

user entry context size

uint32_t doca_flow_ct_cfg::flags [inherited]

CT behavior flags

doca_flow_ct_flow_log_cb doca_flow_ct_cfg::flow_log_cb [inherited]

Flow log callback function

enumdoca_flow_ct_hash_type doca_flow_ct_cfg::hash_type [inherited]

Connection hash table type.

uint32_t doca_flow_ct_cfg::meta_action_bits [inherited]

User action data bits carried by identified connection packet Mask to indicate which field/bits user used to set zone information

uint32_t doca_flow_ct_cfg::meta_user_bits [inherited]

User data bits ignored by worker

doca_flow_meta * doca_flow_ct_cfg::meta_zone_mask [inherited]

Mask to indicate which field/bits to modify so user can read after CT pipe

uint32_t doca_flow_ct_cfg::n_conn_counter_asymmetric [inherited]

Number of connections with asymmetric counter

uint32_t doca_flow_ct_cfg::nb_arm_queues [inherited]

number of ARM CT queues(thread).

uint32_t doca_flow_ct_cfg::nb_arm_sessions[DOCA_FLOW_CT_SESSION_MAX] [inherited]

number of ARM CT sessions.

uint32_t doca_flow_ct_cfg::nb_ctrl_queues [inherited]

number of control queues.

uint32_t doca_flow_ct_cfg::nb_user_actions [inherited]

number of user actions (shared & non-shared)

uint16_t doca_flow_ct_cfg::queue_depth [inherited]

hardware Queue depth, default 512

uint16_t doca_flow_ct_cfg::tcp_session_del_s [inherited]

time to delay or kill TCP session after RST/FIN.

uint16_t doca_flow_ct_cfg::tcp_timeout_s [inherited]

TCP timeout in second.

enumdoca_flow_tun_type doca_flow_ct_cfg::tunnel_type [inherited]

Tunnel type

uint16_t doca_flow_ct_cfg::udp_timeout_s [inherited]

UDP timeout in second.

uint16_t doca_flow_ct_cfg::vxlan_dst_port [inherited]

outer UDP destination port for VxLAN traffic. BE

struct doca_flow_ct_worker_callbacks doca_flow_ct_cfg::worker_cb [inherited]

callbacks for autonomous mode with shared actions

3.19. doca_flow_ct_direction_cfg Struct Reference

[Doca Flow CT]

Direction config

Public Variables

bool match_inner
doca_flow_meta * meta_modify_mask
doca_flow_meta * zone_match_mask

Variables

bool doca_flow_ct_direction_cfg::match_inner [inherited]

match packet inner layer

doca_flow_meta * doca_flow_ct_direction_cfg::meta_modify_mask [inherited]

meta mask to modify

doca_flow_meta * doca_flow_ct_direction_cfg::zone_match_mask [inherited]

Zone mask to match

3.20. doca_flow_ct_ip4 Struct Reference

[Doca Flow Net]

doca flow CT ipV4

Public Variables

doca_be32_t dst_ip
doca_be32_t src_ip

Variables

doca_be32_t doca_flow_ct_ip4::dst_ip [inherited]

ip dst address

doca_be32_t doca_flow_ct_ip4::src_ip [inherited]

ip src address

3.21. doca_flow_ct_ip6 Struct Reference

[Doca Flow Net]

doca flow CT ipV6

Public Variables

doca_be32_t dst_ip[4]
doca_be32_t src_ip[4]

Variables

doca_be32_t doca_flow_ct_ip6::dst_ip[4] [inherited]

ip dst address

doca_be32_t doca_flow_ct_ip6::src_ip[4] [inherited]

ip src address

3.22. doca_flow_ct_match Struct Reference

[Doca Flow CT]

Public Variables

struct doca_flow_ct_match4 ipv4
struct doca_flow_ct_match6 ipv6

Variables

struct doca_flow_ct_match4 doca_flow_ct_match::ipv4 [inherited]

IPv4 match pattern

struct doca_flow_ct_match6 doca_flow_ct_match::ipv6 [inherited]

IPv6 match pattern

3.23. doca_flow_ct_match4 Struct Reference

[Doca Flow CT]

Public Variables

doca_be32_t dst_ip
struct doca_flow_header_l4_port l4_port
uint32_t metadata
uint8_t next_proto
doca_be32_t src_ip

Variables

doca_be32_t doca_flow_ct_match4::dst_ip [inherited]

ip dst address

struct doca_flow_header_l4_port doca_flow_ct_match4::l4_port [inherited]

UDP or TCP source and destination port

uint32_t doca_flow_ct_match4::metadata [inherited]

metadata

uint8_t doca_flow_ct_match4::next_proto [inherited]

ip next protocol

doca_be32_t doca_flow_ct_match4::src_ip [inherited]

ip src address

3.24. doca_flow_ct_match6 Struct Reference

[Doca Flow CT]

Public Variables

doca_be32_t dst_ip[4]
struct doca_flow_header_l4_port l4_port
uint32_t metadata
uint8_t next_proto
doca_be32_t src_ip[4]

Variables

doca_be32_t doca_flow_ct_match6::dst_ip[4] [inherited]

ip dst address

struct doca_flow_header_l4_port doca_flow_ct_match6::l4_port [inherited]

UDP or TCP source and destination port

uint32_t doca_flow_ct_match6::metadata [inherited]

metadata

uint8_t doca_flow_ct_match6::next_proto [inherited]

ip next protocol

doca_be32_t doca_flow_ct_match6::src_ip[4] [inherited]

ip src address

3.25. doca_flow_ct_meta Union Reference

[Doca Flow CT]

Public Variables

uint32_t data
uint32_t hairpin
uint32_t src
uint32_t type
uint32_t u32

Variables

uint32_t doca_flow_ct_meta::data [inherited]

Combination of reserved, zone, user action data and user data.

uint32_t doca_flow_ct_meta::hairpin [inherited]

Subject to forward using hairpin.

uint32_t doca_flow_ct_meta::src [inherited]

Source port in multi-port E-Switch mode

uint32_t doca_flow_ct_meta::type [inherited]

Refer to doca_flow_ct_meta_type.

uint32_t doca_flow_ct_meta::u32 [inherited]

CPU endian.

3.26. doca_flow_ct_pkt Struct Reference

[Doca Flow CT]

ct packet sent to user via pkt_callback

Public Variables

void * buf
uint32_t conn_id
uint32_t data_sz_be
uint32_t is_ipv6
uint32_t is_last
uint32_t is_tcp
union doca_flow_ct_meta meta
uint32_t offset

Variables

void * doca_flow_ct_pkt::buf [inherited]

packet buffer, should not be changed by the user

uint32_t doca_flow_ct_pkt::conn_id [inherited]

connection id

uint32_t doca_flow_ct_pkt::data_sz_be [inherited]

packet size, may be changed by the user (if packet change)

uint32_t doca_flow_ct_pkt::is_ipv6 [inherited]

indication for ipv6

uint32_t doca_flow_ct_pkt::is_last [inherited]

indication for last packet in burst

uint32_t doca_flow_ct_pkt::is_tcp [inherited]

indication for tcp packet

union doca_flow_ct_meta doca_flow_ct_pkt::meta [inherited]

metadata in CPU endian

uint32_t doca_flow_ct_pkt::offset [inherited]

packet buffer start sending offset (changed by the user)

3.27. doca_flow_ct_worker_callbacks Struct Reference

[Doca Flow CT]

set of callbacks used for using shared-actions in autonomous mode

Public Variables

doca_flow_ct_rule_pkt_cb rule_pkt
doca_flow_ct_sync_acquire_cb worker_init
doca_flow_ct_sync_release_cb worker_release

Variables

doca_flow_ct_rule_pkt_cb doca_flow_ct_worker_callbacks::rule_pkt [inherited]

called on first packet of a flow

doca_flow_ct_sync_acquire_cb doca_flow_ct_worker_callbacks::worker_init [inherited]

called at start of worker thread to sync with user context

doca_flow_ct_sync_release_cb doca_flow_ct_worker_callbacks::worker_release [inherited]

called at the end of a worker thread

3.28. doca_flow_desc_field Struct Reference

[DOCA Flow]

Field based on a string that is composed out of struct members separated by a dot.

The 1st segment determines the field location in packet "outer", "inner", "tunnel". The 2nd segment determines the protocol. The 3rd segment determines the field.

E.g. "outer.eth.src_mac" "tunnel.gre.protocol" "inner.ipv4.next_proto"

Public Variables

uint32_t bit_offset
const char * field_string

Variables

uint32_t doca_flow_desc_field::bit_offset [inherited]

Field bit offset.

const char * doca_flow_desc_field::field_string [inherited]

Field selection by string.

3.29. doca_flow_encap_action Struct Reference

[DOCA Flow]

Public Variables

struct doca_flow_header_format outer
struct doca_flow_tun tun

Variables

struct doca_flow_header_format doca_flow_encap_action::outer [inherited]

outer header format

struct doca_flow_tun doca_flow_encap_action::tun [inherited]

tunnel info

3.30. doca_flow_entropy_format Struct Reference

[DOCA Flow]

Public Variables

struct doca_flow_header_ip4 ip4
struct doca_flow_header_ip6 ip6
enumdoca_flow_l3_type l3_type
enumdoca_flow_l4_type_ext l4_type_ext
struct doca_flow_header_l4_port transport

Variables

struct doca_flow_header_ip4 doca_flow_entropy_format::ip4 [inherited]

ipv4 head

struct doca_flow_header_ip6 doca_flow_entropy_format::ip6 [inherited]

ipv6 head

enumdoca_flow_l3_type doca_flow_entropy_format::l3_type [inherited]

layer 3 protocol type

enumdoca_flow_l4_type_ext doca_flow_entropy_format::l4_type_ext [inherited]

l4 layer extend type

struct doca_flow_header_l4_port doca_flow_entropy_format::transport [inherited]

transport layer source and destination port

3.31. doca_flow_fwd Struct Reference

[DOCA Flow]

Public Variables

uint32_t idx
doca_flow_pipe * next_pipe
int num_of_queues
doca_flow_fwd::@33::@41 ordered_list_pipe
doca_flow_pipe * pipe
uint16_t port_id
enumdoca_flow_rss_hash_function rss_hash_func
uint32_t rss_inner_flags
uint32_t rss_outer_flags
uint16_t * rss_queues
uint32_t shared_rss_id
doca_flow_target * target
enumdoca_flow_fwd_type type

Variables

uint32_t doca_flow_fwd::idx [inherited]

Index of the ordered list pipe entry.

doca_flow_pipe * doca_flow_fwd::next_pipe [inherited]

next pipe pointer

int doca_flow_fwd::num_of_queues [inherited]

number of queues

doca_flow_fwd::@33::@41 doca_flow_fwd::ordered_list_pipe [inherited]

next ordered list pipe configuration

doca_flow_pipe * doca_flow_fwd::pipe [inherited]

Ordered list pipe to select an entry from.

uint16_t doca_flow_fwd::port_id [inherited]

destination port id

enumdoca_flow_rss_hash_function doca_flow_fwd::rss_hash_func [inherited]

hash function

uint32_t doca_flow_fwd::rss_inner_flags [inherited]

rss offload inner types

uint32_t doca_flow_fwd::rss_outer_flags [inherited]

rss offload outer types

uint16_t * doca_flow_fwd::rss_queues [inherited]

rss queues array

uint32_t doca_flow_fwd::shared_rss_id [inherited]

shared rss id, only for pipe's fwd is NULL

doca_flow_target * doca_flow_fwd::target [inherited]

pointer to target handler

enumdoca_flow_fwd_type doca_flow_fwd::type [inherited]

indicate the forwarding type

3.32. doca_flow_geneve_option Union Reference

[Doca Flow Net]

This object describes single DW (4-bytes) from GENEVE option header. It describes either the first DW in the option including class, type and length or any other data DW.

Public Variables

doca_be16_t class_id
doca_be32_t data
uint8_t type

Variables

doca_be16_t doca_flow_geneve_option::class_id [inherited]

option class

doca_be32_t doca_flow_geneve_option::data [inherited]

4 bytes of option data.

uint8_t doca_flow_geneve_option::type [inherited]

option type

3.33. doca_flow_header_eth Struct Reference

[Doca Flow Net]

Public Variables

uint8_t dst_mac[DOCA_FLOW_ETHER_ADDR_LEN]
uint8_t src_mac[DOCA_FLOW_ETHER_ADDR_LEN]
doca_be16_t type

Variables

uint8_t doca_flow_header_eth::dst_mac[DOCA_FLOW_ETHER_ADDR_LEN] [inherited]

destination mac address

uint8_t doca_flow_header_eth::src_mac[DOCA_FLOW_ETHER_ADDR_LEN] [inherited]

source mac address

doca_be16_t doca_flow_header_eth::type [inherited]

eth type

3.34. doca_flow_header_eth_vlan Struct Reference

[Doca Flow Net]

Public Variables

doca_be16_t tci

Variables

doca_be16_t doca_flow_header_eth_vlan::tci [inherited]

vlan tci

3.35. doca_flow_header_format Struct Reference

[DOCA Flow]

Public Variables

struct doca_flow_header_eth eth
struct doca_flow_header_eth_vlan eth_vlan[DOCA_FLOW_VLAN_MAX]
struct doca_flow_header_icmp icmp
struct doca_flow_header_ip4 ip4
struct doca_flow_header_ip6 ip6
uint16_t l2_valid_headers
enumdoca_flow_l3_type l3_type
enumdoca_flow_l4_type_ext l4_type_ext
struct doca_flow_header_tcp tcp
struct doca_flow_header_l4_port transport
struct doca_flow_header_udp udp

Variables

struct doca_flow_header_eth doca_flow_header_format::eth [inherited]

ether head

struct doca_flow_header_eth_vlan doca_flow_header_format::eth_vlan[DOCA_FLOW_VLAN_MAX] [inherited]

vlan header array

struct doca_flow_header_icmp doca_flow_header_format::icmp [inherited]

icmp header

struct doca_flow_header_ip4 doca_flow_header_format::ip4 [inherited]

ipv4 head

struct doca_flow_header_ip6 doca_flow_header_format::ip6 [inherited]

ipv6 head

uint16_t doca_flow_header_format::l2_valid_headers [inherited]

indicate which headers are valid

enumdoca_flow_l3_type doca_flow_header_format::l3_type [inherited]

layer 3 protocol type

enumdoca_flow_l4_type_ext doca_flow_header_format::l4_type_ext [inherited]

l4 layer extend type

struct doca_flow_header_tcp doca_flow_header_format::tcp [inherited]

tcp header

struct doca_flow_header_l4_port doca_flow_header_format::transport [inherited]

transport layer source and destination port

struct doca_flow_header_udp doca_flow_header_format::udp [inherited]

udp header

3.36. doca_flow_header_geneve Struct Reference

[Doca Flow Net]

Public Variables

doca_be16_t next_proto
uint8_t o_c
uint8_t ver_opt_len
doca_be32_t vni

Variables

doca_be16_t doca_flow_header_geneve::next_proto [inherited]

next protocol

uint8_t doca_flow_header_geneve::o_c [inherited]

OAM packet (1) + critical options present (1) + reserved (6).

uint8_t doca_flow_header_geneve::ver_opt_len [inherited]

version (2) + options length (6).

doca_be32_t doca_flow_header_geneve::vni [inherited]

geneve vni (24) + reserved (8).

3.37. doca_flow_header_icmp Struct Reference

[Doca Flow Net]

Public Variables

uint8_t code
doca_be16_t ident
uint8_t type

Variables

uint8_t doca_flow_header_icmp::code [inherited]

icmp code.

doca_be16_t doca_flow_header_icmp::ident [inherited]

icmp identifier.

uint8_t doca_flow_header_icmp::type [inherited]

icmp type

3.38. doca_flow_header_ip4 Struct Reference

[Doca Flow Net]

Public Variables

uint8_t dscp_ecn
doca_be32_t dst_ip
doca_be16_t flags_fragment_offset
doca_be16_t identification
uint8_t next_proto
doca_be32_t src_ip
doca_be16_t total_len
uint8_t ttl
uint8_t version_ihl

Variables

uint8_t doca_flow_header_ip4::dscp_ecn [inherited]

dscp and ecn

doca_be32_t doca_flow_header_ip4::dst_ip [inherited]

ip dst address

doca_be16_t doca_flow_header_ip4::flags_fragment_offset [inherited]

ip fragment flags (3) + ip fragment offset (13)

doca_be16_t doca_flow_header_ip4::identification [inherited]

ip fragment identification

uint8_t doca_flow_header_ip4::next_proto [inherited]

ip next protocol

doca_be32_t doca_flow_header_ip4::src_ip [inherited]

ip src address

doca_be16_t doca_flow_header_ip4::total_len [inherited]

packet total length

uint8_t doca_flow_header_ip4::ttl [inherited]

time to live

uint8_t doca_flow_header_ip4::version_ihl [inherited]

version and internet header length

3.39. doca_flow_header_ip6 Struct Reference

[Doca Flow Net]

Public Variables

doca_be32_t dst_ip[4]
doca_be32_t flow_label
uint8_t hop_limit
uint8_t next_proto
doca_be16_t payload_len
doca_be32_t src_ip[4]
uint8_t traffic_class

Variables

doca_be32_t doca_flow_header_ip6::dst_ip[4] [inherited]

ip dst address

doca_be32_t doca_flow_header_ip6::flow_label [inherited]

reserved (12) + flow label (20)

uint8_t doca_flow_header_ip6::hop_limit [inherited]

hop limit

uint8_t doca_flow_header_ip6::next_proto [inherited]

ip next protocol

doca_be16_t doca_flow_header_ip6::payload_len [inherited]

payload length

doca_be32_t doca_flow_header_ip6::src_ip[4] [inherited]

ip src address

uint8_t doca_flow_header_ip6::traffic_class [inherited]

traffic class

3.40. doca_flow_header_l4_port Struct Reference

[Doca Flow Net]

Public Variables

doca_be16_t dst_port
doca_be16_t src_port

Variables

doca_be16_t doca_flow_header_l4_port::dst_port [inherited]

destination port

doca_be16_t doca_flow_header_l4_port::src_port [inherited]

source port

3.41. doca_flow_header_mpls Struct Reference

[Doca Flow Net]

Copy
Copied!

            
            ‎ 0                   1                   2                   3
       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       |                Label                  | TC  |S|      TTL      |
       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Public Variables

doca_be32_t label

Variables

doca_be32_t doca_flow_header_mpls::label [inherited]

MPLS label.

3.42. doca_flow_header_psp Struct Reference

[Doca Flow Net]

Public Variables

uint8_t hdrextlen
doca_be64_t iv
uint8_t nexthdr
uint8_t res_cryptofst
uint8_t s_d_ver_v
doca_be32_t spi
doca_be64_t vc

Variables

uint8_t doca_flow_header_psp::hdrextlen [inherited]

header extension length

doca_be64_t doca_flow_header_psp::iv [inherited]

psp initialization vector

uint8_t doca_flow_header_psp::nexthdr [inherited]

next header IP protocol number

uint8_t doca_flow_header_psp::res_cryptofst [inherited]

reserved:2, crypto offset:6

uint8_t doca_flow_header_psp::s_d_ver_v [inherited]

Sample bit, drop bit, version:4, V bit

doca_be32_t doca_flow_header_psp::spi [inherited]

psp session parameter index

doca_be64_t doca_flow_header_psp::vc [inherited]

psp virtualization cookie

3.43. doca_flow_header_tcp Struct Reference

[Doca Flow Net]

Public Variables

uint8_t data_offset
uint8_t flags
struct doca_flow_header_l4_port l4_port

Variables

uint8_t doca_flow_header_tcp::data_offset [inherited]

tcp data offset

uint8_t doca_flow_header_tcp::flags [inherited]

tcp flags

struct doca_flow_header_l4_port doca_flow_header_tcp::l4_port [inherited]

tcp source and destination port

3.44. doca_flow_header_udp Struct Reference

[Doca Flow Net]

Public Variables

struct doca_flow_header_l4_port l4_port

Variables

struct doca_flow_header_l4_port doca_flow_header_udp::l4_port [inherited]

udp source and destination port

3.45. doca_flow_ip_addr Struct Reference

[Doca Flow Net]

Public Variables

doca_be32_t ipv4_addr
doca_be32_t ipv6_addr[4]
enumdoca_flow_l3_type type

Variables

doca_be32_t doca_flow_ip_addr::ipv4_addr [inherited]

ipv4 address if type is ipv4

doca_be32_t doca_flow_ip_addr::ipv6_addr[4] [inherited]

ipv6 address if type is ipv6

enumdoca_flow_l3_type doca_flow_ip_addr::type [inherited]

ip address type

3.46. doca_flow_match Struct Reference

[DOCA Flow]

Public Variables

uint32_t flags
struct doca_flow_header_format inner
struct doca_flow_meta meta
struct doca_flow_header_format outer
struct doca_flow_parser_meta parser_meta
struct doca_flow_tun tun

Variables

uint32_t doca_flow_match::flags [inherited]

match items which are no value

struct doca_flow_header_format doca_flow_match::inner [inherited]

inner layer header format

struct doca_flow_meta doca_flow_match::meta [inherited]

Programmable meta data.

struct doca_flow_header_format doca_flow_match::outer [inherited]

outer layer header format

struct doca_flow_parser_meta doca_flow_match::parser_meta [inherited]

Read-only meta data.

struct doca_flow_tun doca_flow_match::tun [inherited]

tunnel info

3.47. doca_flow_match_condition Struct Reference

[DOCA Flow]

Public Variables

struct doca_flow_desc_field a
struct doca_flow_desc_field b
enumdoca_flow_compare_op operation
uint32_t width

Variables

struct doca_flow_desc_field doca_flow_match_condition::a [inherited]

Field descriptor A.

struct doca_flow_desc_field doca_flow_match_condition::b [inherited]

Field descriptor B.

enumdoca_flow_compare_op doca_flow_match_condition::operation [inherited]

Condition compare operation.

uint32_t doca_flow_match_condition::width [inherited]

Field width.

3.48. doca_flow_meta Struct Reference

Meta data known as scratch data can be used to match or modify within pipes. Meta data can be set with value in previous pipes and match in later pipes. User can customize meta data structure as long as overall size doesn't exceed limit. To match meta data, mask must be specified when creating pipe. Struct must be aligned to 32 bits. No initial value for Meta data, must match after setting value.

Public Variables

uint32_t mark
uint32_t pkt_meta
uint32_t u32[DOCA_FLOW_META_SCRATCH_PAD_MAX]

Variables

uint32_t doca_flow_meta::mark [inherited]

Mark id.

uint32_t doca_flow_meta::pkt_meta [inherited]

Shared with application via packet.

uint32_t doca_flow_meta::u32[DOCA_FLOW_META_SCRATCH_PAD_MAX] [inherited]

Programmable user data.

3.49. doca_flow_mirror_target Struct Reference

[DOCA Flow]

Public Variables

struct doca_flow_encap_action encap
struct doca_flow_fwd fwd
bool has_encap

Variables

struct doca_flow_encap_action doca_flow_mirror_target::encap [inherited]

Encap data.

struct doca_flow_fwd doca_flow_mirror_target::fwd [inherited]

Mirror target, must be filled.

bool doca_flow_mirror_target::has_encap [inherited]

Encap mirrored packets.

3.50. doca_flow_monitor Struct Reference

[DOCA Flow]

Public Variables

uint32_t aging_sec
uint64_t cbs
uint64_t cir
enumdoca_flow_resource_type counter_type
enumdoca_flow_meter_limit_type limit_type
enum doca_flow_meter_color meter_init_color
enumdoca_flow_resource_type meter_type
uint32_t shared_counter_id
uint32_t shared_meter_id
uint32_t shared_mirror_id

Variables

uint32_t doca_flow_monitor::aging_sec [inherited]

aging time in seconds.

uint64_t doca_flow_monitor::cbs [inherited]

Committed Burst Size (bytes).

uint64_t doca_flow_monitor::cir [inherited]

Committed Information Rate (bytes/second).

enumdoca_flow_resource_type doca_flow_monitor::counter_type [inherited]

Type of counter configuration.

enumdoca_flow_meter_limit_type doca_flow_monitor::limit_type [inherited]

Meter rate limit type: bytes / packets per second

enum doca_flow_meter_color doca_flow_monitor::meter_init_color [inherited]

meter initial color

enumdoca_flow_resource_type doca_flow_monitor::meter_type [inherited]

Type of meter configuration.

uint32_t doca_flow_monitor::shared_counter_id [inherited]

shared counter id

uint32_t doca_flow_monitor::shared_meter_id [inherited]

shared meter id

uint32_t doca_flow_monitor::shared_mirror_id [inherited]

shared mirror id.

3.51. doca_flow_nat64_action Struct Reference

[DOCA Flow]

Public Variables

enumdoca_flow_l3_type original_l3_type

Variables

enumdoca_flow_l3_type doca_flow_nat64_action::original_l3_type [inherited]

original header's layer 3 type

3.52. doca_flow_ordered_list Struct Reference

[DOCA Flow]

Ordered list configuration.

Public Variables

const * elements
uint32_t idx
uint32_t size

Variables

const * doca_flow_ordered_list::elements [inherited]

An array of DOCA flow structure pointers, depending on types.

uint32_t doca_flow_ordered_list::idx [inherited]

List index among the lists of the pipe. At pipe creation, it must match the list position in the array of lists. At entry insertion, it determines which list to use.

uint32_t doca_flow_ordered_list::size [inherited]

Number of elements in the list.

3.53. doca_flow_parser_geneve_opt_cfg Struct Reference

[DOCA Flow]

Public Variables

doca_be32_t data_mask[DOCA_FLOW_GENEVE_DATA_OPTION_LEN_MAX]
enumdoca_flow_parser_geneve_opt_mode match_on_class_mode
doca_be16_t option_class
uint8_t option_len
uint8_t option_type

Variables

doca_be32_t doca_flow_parser_geneve_opt_cfg::data_mask[DOCA_FLOW_GENEVE_DATA_OPTION_LEN_MAX] [inherited]

Data mask describing which DWs should be sampled.

enumdoca_flow_parser_geneve_opt_mode doca_flow_parser_geneve_opt_cfg::match_on_class_mode [inherited]

Indicator about class field role in this option.

doca_be16_t doca_flow_parser_geneve_opt_cfg::option_class [inherited]

The class of the GENEVE TLV option.

uint8_t doca_flow_parser_geneve_opt_cfg::option_len [inherited]

The length of the GENEVE TLV option data in DW granularity.

uint8_t doca_flow_parser_geneve_opt_cfg::option_type [inherited]

The type of the GENEVE TLV option.

3.54. doca_flow_parser_meta Struct Reference

[DOCA Flow]

Parser meta data known as read-only hardware data that can be used to match.

Public Variables

uint8_t inner_ip4_checksum_ok
uint8_t inner_ip_fragmented
enumdoca_flow_l2_meta inner_l2_type
uint8_t inner_l3_ok
enumdoca_flow_l3_meta inner_l3_type
uint8_t inner_l4_checksum_ok
uint8_t inner_l4_ok
enumdoca_flow_l4_meta inner_l4_type
uint8_t ipsec_syndrome
enum doca_flow_meter_color meter_color
uint8_t outer_ip4_checksum_ok
uint8_t outer_ip_fragmented
enumdoca_flow_l2_meta outer_l2_type
uint8_t outer_l3_ok
enumdoca_flow_l3_meta outer_l3_type
uint8_t outer_l4_checksum_ok
uint8_t outer_l4_ok
enumdoca_flow_l4_meta outer_l4_type
uint32_t port_meta
uint8_t psp_syndrome
uint16_t random

Variables

uint8_t doca_flow_parser_meta::inner_ip4_checksum_ok [inherited]

Whether inner IPv4 checksum is valid.

uint8_t doca_flow_parser_meta::inner_ip_fragmented [inherited]

Whether inner IP packet is fragmented.

enumdoca_flow_l2_meta doca_flow_parser_meta::inner_l2_type [inherited]

Innermost L2 packet type.

uint8_t doca_flow_parser_meta::inner_l3_ok [inherited]

Whether inner L3 layer is valid without checksum.

enumdoca_flow_l3_meta doca_flow_parser_meta::inner_l3_type [inherited]

Innermost L3 packet type.

uint8_t doca_flow_parser_meta::inner_l4_checksum_ok [inherited]

Whether inner L4 checksum is valid.

uint8_t doca_flow_parser_meta::inner_l4_ok [inherited]

Whether inner L4 layer is valid including checksum.

enumdoca_flow_l4_meta doca_flow_parser_meta::inner_l4_type [inherited]

Innermost L4 packet type.

uint8_t doca_flow_parser_meta::ipsec_syndrome [inherited]

IPsec decrypt/authentication syndrome.

enum doca_flow_meter_color doca_flow_parser_meta::meter_color [inherited]

Meter colors: Green, Yellow, Red.

uint8_t doca_flow_parser_meta::outer_ip4_checksum_ok [inherited]

Whether outer IPv4 checksum is valid.

uint8_t doca_flow_parser_meta::outer_ip_fragmented [inherited]

Whether outer IP packet is fragmented.

enumdoca_flow_l2_meta doca_flow_parser_meta::outer_l2_type [inherited]

Outermost L2 packet type.

uint8_t doca_flow_parser_meta::outer_l3_ok [inherited]

Whether outer L3 layer is valid without checksum.

enumdoca_flow_l3_meta doca_flow_parser_meta::outer_l3_type [inherited]

Outermost L3 packet type.

uint8_t doca_flow_parser_meta::outer_l4_checksum_ok [inherited]

Whether outer L4 checksum is valid.

uint8_t doca_flow_parser_meta::outer_l4_ok [inherited]

Whether outer L4 layer is valid including checksum.

enumdoca_flow_l4_meta doca_flow_parser_meta::outer_l4_type [inherited]

Outermost L4 packet type.

uint32_t doca_flow_parser_meta::port_meta [inherited]

Programmable source vport.

uint8_t doca_flow_parser_meta::psp_syndrome [inherited]

PSP decrypt/authentication syndrome.

uint16_t doca_flow_parser_meta::random [inherited]

Matches a random value. This value is not based on the packet data/headers. Application shouldn't assume that this value is kept during the packet lifetime.

3.55. doca_flow_push_action Struct Reference

[DOCA Flow]

Public Variables

enumdoca_flow_push_action_type type

Variables

enumdoca_flow_push_action_type doca_flow_push_action::type [inherited]

header type to push

3.56. doca_flow_resource_decap_cfg Struct Reference

[DOCA Flow]

Public Variables

struct doca_flow_header_eth eth
struct doca_flow_header_eth_vlan eth_vlan[DOCA_FLOW_VLAN_MAX]
bool is_l2
uint16_t l2_valid_headers

Variables

struct doca_flow_header_eth doca_flow_resource_decap_cfg::eth [inherited]

ether head for is_l2 is false

struct doca_flow_header_eth_vlan doca_flow_resource_decap_cfg::eth_vlan[DOCA_FLOW_VLAN_MAX] [inherited]

vlan header array for is_l2 is false

bool doca_flow_resource_decap_cfg::is_l2 [inherited]

L2 or L3 tunnel flavor

uint16_t doca_flow_resource_decap_cfg::l2_valid_headers [inherited]

indicate which headers are valid

3.57. doca_flow_resource_encap_cfg Struct Reference

[DOCA Flow]

Public Variables

struct doca_flow_encap_action encap
bool is_l2

Variables

struct doca_flow_encap_action doca_flow_resource_encap_cfg::encap [inherited]

Encap data

bool doca_flow_resource_encap_cfg::is_l2 [inherited]

L2 or L3 tunnel flavor

3.58. doca_flow_resource_ipsec_sa_cfg Struct Reference

[DOCA Flow]

Public Variables

bool esn_en
enumdoca_flow_crypto_icv_len icv_len
uint64_t implicit_iv
struct doca_flow_crypto_key_cfg key_cfg
uint32_t lifetime_threshold
uint32_t salt
uint64_t sn_initial
enumdoca_flow_crypto_sn_offload_type sn_offload_type
enumdoca_flow_crypto_replay_win_size win_size

Variables

bool doca_flow_resource_ipsec_sa_cfg::esn_en [inherited]

Enable extended sequence number

enumdoca_flow_crypto_icv_len doca_flow_resource_ipsec_sa_cfg::icv_len [inherited]

ICV value

uint64_t doca_flow_resource_ipsec_sa_cfg::implicit_iv [inherited]

implicit IV value

struct doca_flow_crypto_key_cfg doca_flow_resource_ipsec_sa_cfg::key_cfg [inherited]

IPSec key configuration

uint32_t doca_flow_resource_ipsec_sa_cfg::lifetime_threshold [inherited]

When SN reaches this threshold, all passing packets will return a relevant syndrome

uint32_t doca_flow_resource_ipsec_sa_cfg::salt [inherited]

salt value

uint64_t doca_flow_resource_ipsec_sa_cfg::sn_initial [inherited]

Initial sequence number

enumdoca_flow_crypto_sn_offload_type doca_flow_resource_ipsec_sa_cfg::sn_offload_type [inherited]

SN offload type - increment or anti-replay

enumdoca_flow_crypto_replay_win_size doca_flow_resource_ipsec_sa_cfg::win_size [inherited]

Anti-replay window size - only valid when using DOCA_FLOW_CRYPTO_SN_OFFLOAD_AR

3.59. doca_flow_resource_meter_cfg Struct Reference

[DOCA Flow]

Public Variables

enumdoca_flow_meter_algorithm_type alg
uint64_t cbs
uint64_t cir
enumdoca_flow_meter_color_mode color_mode
uint64_t ebs
uint64_t eir
enumdoca_flow_meter_limit_type limit_type
uint64_t pbs
uint64_t pir

Variables

enumdoca_flow_meter_algorithm_type doca_flow_resource_meter_cfg::alg [inherited]

Meter algorithm by RFCs

uint64_t doca_flow_resource_meter_cfg::cbs [inherited]

Committed Burst Size (bytes or packets).

uint64_t doca_flow_resource_meter_cfg::cir [inherited]

Committed Information Rate (bytes or packets per second).

enumdoca_flow_meter_color_mode doca_flow_resource_meter_cfg::color_mode [inherited]

Meter color mode: blind / aware

uint64_t doca_flow_resource_meter_cfg::ebs [inherited]

Excess Burst Size (EBS) (bytes or packets).

uint64_t doca_flow_resource_meter_cfg::eir [inherited]

Excess Information Rate (bytes or packets per seconds).

enumdoca_flow_meter_limit_type doca_flow_resource_meter_cfg::limit_type [inherited]

Meter rate limit type: bytes / packets per second

uint64_t doca_flow_resource_meter_cfg::pbs [inherited]

Peak Burst Size (bytes or packets).

uint64_t doca_flow_resource_meter_cfg::pir [inherited]

Peak Information Rate (bytes or packets per seconds).

3.60. doca_flow_resource_mirror_cfg Struct Reference

[DOCA Flow]

Public Variables

struct doca_flow_fwd fwd
int nr_targets
doca_flow_mirror_target * target

Variables

struct doca_flow_fwd doca_flow_resource_mirror_cfg::fwd [inherited]

Original packet dst, can be filled optional.

int doca_flow_resource_mirror_cfg::nr_targets [inherited]

Mirror target number.

doca_flow_mirror_target * doca_flow_resource_mirror_cfg::target [inherited]

Mirror target pointer.

3.61. doca_flow_resource_psp_cfg Struct Reference

[DOCA Flow]

Public Variables

struct doca_flow_crypto_key_cfg key_cfg

Variables

struct doca_flow_crypto_key_cfg doca_flow_resource_psp_cfg::key_cfg [inherited]

PSP key configuration

3.62. doca_flow_resource_query Struct Reference

[DOCA Flow]

Public Variables

uint64_t current_sn
uint64_t total_bytes
uint64_t total_pkts

Variables

uint64_t doca_flow_resource_query::current_sn [inherited]

Current SN for encrypt, lower bound of AR window for decrypt

uint64_t doca_flow_resource_query::total_bytes [inherited]

total bytes hit this flow

uint64_t doca_flow_resource_query::total_pkts [inherited]

total packets hit this flow

3.63. doca_flow_resource_rss_cfg Struct Reference

[DOCA Flow]

Public Variables

uint32_t inner_flags
int nr_queues
uint32_t outer_flags
uint16_t * queues_array
enumdoca_flow_rss_hash_function rss_hash_func

Variables

uint32_t doca_flow_resource_rss_cfg::inner_flags [inherited]

rss offload inner types

int doca_flow_resource_rss_cfg::nr_queues [inherited]

number of queues

uint32_t doca_flow_resource_rss_cfg::outer_flags [inherited]

rss offload outer types

uint16_t * doca_flow_resource_rss_cfg::queues_array [inherited]

rss queues array

enumdoca_flow_rss_hash_function doca_flow_resource_rss_cfg::rss_hash_func [inherited]

hash function

3.64. doca_flow_shared_resource_cfg Struct Reference

[DOCA Flow]

Public Variables

enumdoca_flow_pipe_domain domain

Variables

enumdoca_flow_pipe_domain doca_flow_shared_resource_cfg::domain [inherited]

Shared resource steering domain

3.65. doca_flow_tun Struct Reference

[Doca Flow Net]

Public Variables

doca_be32_t esp_sn
doca_be32_t esp_spi
struct doca_flow_header_geneve geneve
union doca_flow_geneve_option geneve_options[DOCA_FLOW_GENEVE_OPT_LEN_MAX]
doca_be32_t gre_key
doca_be32_t gtp_teid
bool key_present
struct doca_flow_header_mpls mpls[DOCA_FLOW_MPLS_LABELS_MAX]
uint8_t nvgre_flow_id
doca_be32_t nvgre_vs_id
doca_be16_t protocol
enumdoca_flow_tun_type type
doca_be16_t vxlan_group_policy_id
uint8_t vxlan_next_protocol
doca_be32_t vxlan_tun_id
uint8_t vxlan_tun_rsvd1
enumdoca_flow_tun_ext_vxlan_type vxlan_type

Variables

doca_be32_t doca_flow_tun::esp_sn [inherited]

ipsec sequence number

doca_be32_t doca_flow_tun::esp_spi [inherited]

ipsec session parameter index

struct doca_flow_header_geneve doca_flow_tun::geneve [inherited]

geneve header

union doca_flow_geneve_option doca_flow_tun::geneve_options[DOCA_FLOW_GENEVE_OPT_LEN_MAX] [inherited]

geneve options as array of doca_be32_t

doca_be32_t doca_flow_tun::gre_key [inherited]

gre key

doca_be32_t doca_flow_tun::gtp_teid [inherited]

gtp teid

bool doca_flow_tun::key_present [inherited]

gre key is present

struct doca_flow_header_mpls doca_flow_tun::mpls[DOCA_FLOW_MPLS_LABELS_MAX] [inherited]

mpls labels

uint8_t doca_flow_tun::nvgre_flow_id [inherited]

nvgre flow id.

doca_be32_t doca_flow_tun::nvgre_vs_id [inherited]

nvgre virtual subnet id(24) + reserved (8).

doca_be16_t doca_flow_tun::protocol [inherited]

next protocol

enumdoca_flow_tun_type doca_flow_tun::type [inherited]

tunnel type

doca_be16_t doca_flow_tun::vxlan_group_policy_id [inherited]

vxlan gbp group policy id

uint8_t doca_flow_tun::vxlan_next_protocol [inherited]

vxlan gpe next protocol

doca_be32_t doca_flow_tun::vxlan_tun_id [inherited]

vxlan vni(24) + unused (8).

uint8_t doca_flow_tun::vxlan_tun_rsvd1 [inherited]

vxlan last reserved byte.

enumdoca_flow_tun_ext_vxlan_type doca_flow_tun::vxlan_type [inherited]

vxlan ext-type, standard, gpe, gbp

3.66. doca_flow_tune_server_kpi_res Struct Reference

[DOCA Flow Tune Server]

Public Variables

struct doca_flow_tune_server_shared_resources_kpi_res shared_resources_kpi
enumdoca_flow_tune_server_kpi_type type
uint64_t val

Variables

struct doca_flow_tune_server_shared_resources_kpi_res doca_flow_tune_server_kpi_res::shared_resources_kpi [inherited]

Shared resources KPI result

enumdoca_flow_tune_server_kpi_type doca_flow_tune_server_kpi_res::type [inherited]

KPI result type

uint64_t doca_flow_tune_server_kpi_res::val [inherited]

KPI result value

3.67. doca_flow_tune_server_shared_resources_kpi_res Struct Reference

[DOCA Flow Tune Server]

Public Variables

uint64_t nr_counter
uint64_t nr_decap
uint64_t nr_encap
uint64_t nr_meter
uint64_t nr_mirror
uint64_t nr_psp
uint64_t nr_rss

Variables

uint64_t doca_flow_tune_server_shared_resources_kpi_res::nr_counter [inherited]

Total number of shared counters

uint64_t doca_flow_tune_server_shared_resources_kpi_res::nr_decap [inherited]

Total number of shared decap

uint64_t doca_flow_tune_server_shared_resources_kpi_res::nr_encap [inherited]

Total number of shared encap

uint64_t doca_flow_tune_server_shared_resources_kpi_res::nr_meter [inherited]

Total number of shared meters

uint64_t doca_flow_tune_server_shared_resources_kpi_res::nr_mirror [inherited]

Total number of shared mirrors

uint64_t doca_flow_tune_server_shared_resources_kpi_res::nr_psp [inherited]

Total number of shared psp

uint64_t doca_flow_tune_server_shared_resources_kpi_res::nr_rss [inherited]

Total number of shared rss

3.68. doca_gather_list Struct Reference

[DOCA Types]

Public Variables

void * addr
uint64_t len
doca_gather_list * next

Variables

void * doca_gather_list::addr [inherited]

Address of buffer in the list

uint64_t doca_gather_list::len [inherited]

Length of current buffer in bytes

doca_gather_list * doca_gather_list::next [inherited]

Pointer to next buffer in the list

3.69. doca_log_registrator Class Reference

[DOCA Logging Management]

Should be used to register the log source. For example:

DOCA_LOG_REGISTER(dpi)

void foo { DOCA_LOG_INFO("Message"); }

Note:

The macro also takes care of the dtor() logic on teardown.

3.70. doca_pcc_dev_algo_meta_data Struct Reference

[DOCA PCC Device Algorithm Access]

Public Variables

uint64_t algo_desc_addr
uint32_t algo_desc_size
uint32_t algo_id
uint32_t algo_major_version
uint32_t algo_minor_version

Variables

uint64_t doca_pcc_dev_algo_meta_data::algo_desc_addr [inherited]

pointer to description string

uint32_t doca_pcc_dev_algo_meta_data::algo_desc_size [inherited]

size of description string (null terminated)

uint32_t doca_pcc_dev_algo_meta_data::algo_id [inherited]

algo unique identifier

uint32_t doca_pcc_dev_algo_meta_data::algo_major_version [inherited]

algo major version

uint32_t doca_pcc_dev_algo_meta_data::algo_minor_version [inherited]

algo minor version

3.71. doca_pcc_np_dev_response_packet Struct Reference

[DOCA PCC Device Notification Point]

Public Variables

uint8_t * data
size_t size

Variables

uint8_t * doca_pcc_np_dev_response_packet::data [inherited]

data buffer for user to fill

size_t doca_pcc_np_dev_response_packet::size [inherited]

size of data buffer

3.72. doca_rdma_gid Struct Reference

[DOCA RDMA]

gid struct

Public Variables

uint8_t raw[DOCA_GID_BYTE_LENGTH]

Variables

uint8_t doca_rdma_gid::raw[DOCA_GID_BYTE_LENGTH] [inherited]

The raw value of the GID

3.73. doca_rmax_in_stream_result Struct Reference

[DOCA RMAX Engine]

Input stream starts to receive packets right after start and attaching any flow.

Public Variables

uint32_t elements_count
* memblk_ptr_arr
uint32_t memblk_ptr_arr_len
uint32_t seqn_first
uint64_t ts_first
uint64_t ts_last

Variables

uint32_t doca_rmax_in_stream_result::elements_count [inherited]

Number of packets received

* doca_rmax_in_stream_result::memblk_ptr_arr [inherited]

Array of pointers to the beginning of the memory block as configured by input stream create step. The offset between packets inside memory block can be queried by doca_rmax_in_stream_get_memblk_stride_size

uint32_t doca_rmax_in_stream_result::memblk_ptr_arr_len [inherited]

Number of memory blocks placed in memblk_ptr_arr. See doca_rmax_in_stream_get_memblks_count.

uint32_t doca_rmax_in_stream_result::seqn_first [inherited]

Sequence number of the first packet

uint64_t doca_rmax_in_stream_result::ts_first [inherited]

Time of arrival of the first packet

uint64_t doca_rmax_in_stream_result::ts_last [inherited]

Time of arrival of the last packet

3.74. doca_rmax_stream_error Struct Reference

[DOCA RMAX Engine]

Public Variables

int code
const char * message

Variables

int doca_rmax_stream_error::code [inherited]

Raw Rivermax error code

const char * doca_rmax_stream_error::message [inherited]

Human-readable error

3.75. doca_urom_domain_oob_coll Struct Reference

[DOCA UROM (Unified Resource and Offload Manager)DOCA UROM Domains]

Public Variables

doca_urom_domain_allgather_cb_t allgather
void * coll_info
uint32_t n_oob_indexes
uint32_t oob_index
doca_urom_domain_req_free_cb_t req_free
doca_urom_domain_req_test_cb_t req_test

Variables

doca_urom_domain_allgather_cb_t doca_urom_domain_oob_coll::allgather [inherited]

Non-blocking Allgather callback

void * doca_urom_domain_oob_coll::coll_info [inherited]

Context or meta data required by the OOB collective

uint32_t doca_urom_domain_oob_coll::n_oob_indexes [inherited]

Number of endpoints participating in the oob operation (e.g., number of client processes representing a domain workers)

uint32_t doca_urom_domain_oob_coll::oob_index [inherited]

Integer value that represents the position of the calling processes in the given oob op: the data specified by "src_buf" will be placed at the offset "oob_index*size" in the "recv_buf". oob_index must be unique at every calling process and should be in the range [0:n_oob_indexes).

doca_urom_domain_req_free_cb_t doca_urom_domain_oob_coll::req_free [inherited]

Request free callback

doca_urom_domain_req_test_cb_t doca_urom_domain_oob_coll::req_test [inherited]

Request test callback

3.76. doca_urom_service_plugin_info Struct Reference

[DOCA UROM Plugins]

UROM plugin info structure

Public Variables

uint64_t id
char plugin_name[DOCA_UROM_PLUGIN_NAME_MAX_LEN]
uint64_t version

Variables

uint64_t doca_urom_service_plugin_info::id [inherited]

Unique ID to send commands to the plugin

char doca_urom_service_plugin_info::plugin_name[DOCA_UROM_PLUGIN_NAME_MAX_LEN] [inherited]

The .so plugin file name, without ".so"

uint64_t doca_urom_service_plugin_info::version [inherited]

Plugin version

3.77. urom_domain_lookups_iface Struct Reference

[DOCA UROM Plugins]

Public Variables

doca_error_t ( *addr_lookup )( urom_worker_ctx* ctx, uint64_t domain_id, void* *addr )
doca_error_t ( *memh_lookup )( urom_worker_ctx* ctx, uint64_t domain_id, int seg, size_t* len, void* *memh )
doca_error_t ( *mkey_lookup )( urom_worker_ctx* ctx, uint64_t domain_id, int seg, size_t* len, void* *rkey )
doca_error_t ( *seg_lookup )( urom_worker_ctx* ctx, uint64_t domain_id, uint64_t va, int* seg )

Variables

doca_error_t ( *urom_domain_lookups_iface::addr_lookup )( urom_worker_ctx* ctx, uint64_t domain_id, void* *addr )

Domain address lookup function.

doca_error_t ( *urom_domain_lookups_iface::memh_lookup )( urom_worker_ctx* ctx, uint64_t domain_id, int seg, size_t* len, void* *memh )

Domain memory handle lookup function.

doca_error_t ( *urom_domain_lookups_iface::mkey_lookup )( urom_worker_ctx* ctx, uint64_t domain_id, int seg, size_t* len, void* *rkey )

Domain memory key lookup function.

doca_error_t ( *urom_domain_lookups_iface::seg_lookup )( urom_worker_ctx* ctx, uint64_t domain_id, uint64_t va, int* seg )

Domain memory segment lookup function.

3.78. urom_plugin_iface Struct Reference

[DOCA UROM Plugins]

Public Variables

DOCA_STRUCT_START
doca_error_t ( *addr )( urom_worker_ctx* ctx, void* addr, size_t* addr_len )
void ( *close )( urom_worker_ctx* ctx )
doca_error_t ( *notif_pack )( urom_worker_notify* notif, size_t* packed_notif_len, void* packed_notif )
doca_error_t ( *open )( urom_worker_ctx* ctx )
doca_error_t ( *progress )( urom_worker_ctx* ctx, ucs_list_link_t* notif_list )
doca_error_t ( *worker_cmd )( urom_worker_ctx* ctx, ucs_list_link_t* cmd_list )