NVIDIA Docs Hub NVIDIA Networking BlueField DPUs / SuperNICs & DOCA DOCA Documentation v2.2.1 2. Modules

2. Modules

Here is a list of all modules:

2.1. App Shield

DOCA App Shield library let you to monitor operation system that resides on the host. This is done with the DPU DMA capabilities and the regex engine. Please follow the programmer guide for system configurations.

Defines

#define doca_apsh_attst_info_get ( attestation, attr ): Get attribute value for a attestation.
#define doca_apsh_envar_info_get ( envar, attr ): Get attribute value for an environment variable.
#define doca_apsh_handle_info_get ( handle, attr ): Get attribute value for a handle.
#define doca_apsh_ldrmodule_info_get ( ldrmodule, attr ): Get attribute value for a ldrmodule.
#define doca_apsh_lib_info_get ( lib, attr ): Get attribute value for a lib.
#define doca_apsh_module_info_get ( module, attr ): Get attribute value for a module.
#define doca_apsh_netscan_info_get ( connection, attr ): Get attribute value for a connection.
#define doca_apsh_privilege_info_get ( privilege, attr ): Get attribute value for a privilege.
#define doca_apsh_process_info_get ( process, attr ): Get attribute value for a process.
#define doca_apsh_process_parameters_info_get ( process_parameters, attr ): get attribute value for a process-parameter
#define doca_apsh_sid_info_get ( sid, attr ): Get attribute value for a SID.
#define doca_apsh_sys_config ( system, attr, value ): configure attribute value for a system, such as: hashtest limit, symbols map ...
#define doca_apsh_thread_info_get ( thread, attr ): Get attribute value for a thread.
#define doca_apsh_vad_info_get ( vad, attr ): Get attribute value for a vad.
#define doca_apsh_yara_info_get ( yara, attr ): Get attribute value for a yara.

Functions

const __DOCA_EXPERIMENTAL void* __doca_apsh_attst_info_get ( doca_apsh_attestation* attestation, doca_apsh_attestation_attr attr ): Shadow function - get attribute value for a attestation.
const __DOCA_EXPERIMENTAL void* __doca_apsh_envar_info_get ( doca_apsh_envar* envar, doca_apsh_envar_attr attr ): Shadow function - get attribute value for an environment variable.
const __DOCA_EXPERIMENTAL void* __doca_apsh_handle_info_get ( doca_apsh_handle* handle, doca_apsh_handle_attr attr ): Shadow function - get attribute value for a handle.
const __DOCA_EXPERIMENTAL void* __doca_apsh_ldrmodule_info_get ( doca_apsh_ldrmodule* ldrmodule, doca_apsh_ldrmodule_attr attr ): Shadow function - get attribute value for a modules.
const __DOCA_EXPERIMENTAL void* __doca_apsh_lib_info_get ( doca_apsh_lib* lib, doca_apsh_lib_attr attr ): Shadow function - get attribute value for a lib.
const __DOCA_EXPERIMENTAL void* __doca_apsh_module_info_get ( doca_apsh_module* module, doca_apsh_module_attr attr ): Shadow function - get attribute value for a module.
const __DOCA_EXPERIMENTAL void* __doca_apsh_netscan_info_get ( doca_apsh_netscan* connection, doca_apsh_netscan_attr attr ): Shadow function - get attribute value for a connection.
const __DOCA_EXPERIMENTAL void* __doca_apsh_privilege_info_get ( doca_apsh_privilege* privilege, doca_apsh_privilege_attr attr ): Shadow function - get attribute value for a privilege.
const __DOCA_EXPERIMENTAL void* __doca_apsh_process_info_get ( doca_apsh_process* process, doca_apsh_process_attr attr ): Shadow function - get attribute value for a process.
const __DOCA_EXPERIMENTAL void* __doca_apsh_process_parameters_info_get ( doca_apsh_process_parameters* process_parameters, doca_apsh_process_parameters_attr attr ): Shadow function - get attribute value for a process-parameter.
const __DOCA_EXPERIMENTAL void* __doca_apsh_sid_info_get ( doca_apsh_sid* sid, doca_apsh_sid_attr attr ): Shadow function - get attribute value for a SID.
doca_error_t __doca_apsh_sys_config ( doca_apsh_system* system, doca_apsh_system_config_attr attr, void* value ): Shadow function - configure attribute value for a system.
const __DOCA_EXPERIMENTAL void* __doca_apsh_thread_info_get ( doca_apsh_thread* thread, doca_apsh_thread_attr attr ): Shadow function - get attribute value for a thread.
const __DOCA_EXPERIMENTAL void* __doca_apsh_vad_info_get ( doca_apsh_vad* vad, doca_apsh_vad_attr attr ): Shadow function - get attribute value for a vad.
const __DOCA_EXPERIMENTAL void* __doca_apsh_yara_info_get ( doca_apsh_yara* yara, doca_apsh_yara_attr attr ): Shadow function - get attribute value for a yara.
__DOCA_EXPERIMENTAL void doca_apsh_attestation_free ( doca_apsh_attestation** attestation ): Destroys a attestation context.
doca_error_t doca_apsh_attestation_get ( doca_apsh_process* process, const char* exec_hash_map_path, doca_apsh_attestation*** attestation, int* attestation_size ): Get current process attestation.
doca_error_t doca_apsh_attst_refresh ( doca_apsh_attestation*** attestation, int* attestation_size ): refresh single attestation handler of a process with new snapshot
__DOCA_EXPERIMENTAL doca_apsh_ctx* doca_apsh_create ( void ): Create a new apsh handler.
__DOCA_EXPERIMENTAL void doca_apsh_destroy ( doca_apsh_ctx* ctx ): Free the APSH memory and close connections.
doca_error_t doca_apsh_dma_dev_set ( doca_apsh_ctx* ctx, doca_dev* dma_dev ): Set apsh dma device.
__DOCA_EXPERIMENTAL void doca_apsh_envars_free ( doca_apsh_envar** envars ): Destroys a envars context.
doca_error_t doca_apsh_envars_get ( doca_apsh_process* process, doca_apsh_envar*** envars, int* envars_size ): Get array of current process environment variables.
__DOCA_EXPERIMENTAL void doca_apsh_handles_free ( doca_apsh_handle** handles ): Destroys a handles context.
doca_error_t doca_apsh_handles_get ( doca_apsh_process* process, doca_apsh_handle*** handles, int* handles_size ): Get array of current process handles.
__DOCA_EXPERIMENTAL void doca_apsh_ldrmodules_free ( doca_apsh_ldrmodule** ldrmodules ): Destroys a ldrmodules context.
doca_error_t doca_apsh_ldrmodules_get ( doca_apsh_process* process, doca_apsh_ldrmodule*** ldrmodules, int* ldrmodules_size ): Get array of current process modules.
__DOCA_EXPERIMENTAL void doca_apsh_libs_free ( doca_apsh_lib** libs ): Destroys a libs context.
doca_error_t doca_apsh_libs_get ( doca_apsh_process* process, doca_apsh_lib*** libs, int* libs_size ): Get array of current process loadable libraries.
__DOCA_EXPERIMENTAL void doca_apsh_module_free ( doca_apsh_module** modules ): Destroys a modules array.
doca_error_t doca_apsh_modules_get ( doca_apsh_system* system, doca_apsh_module*** modules, int* modules_size ): Get array of current modules installed on the system.
__DOCA_EXPERIMENTAL void doca_apsh_netscan_free ( doca_apsh_netscan** connections ): Destroys a netscan context.
doca_error_t doca_apsh_netscan_get ( doca_apsh_system* system, doca_apsh_netscan*** connections, int* connections_size ): Get array of current connections.
__DOCA_EXPERIMENTAL void doca_apsh_privileges_free ( doca_apsh_privilege** privileges ): Destroys a privileges context.
doca_error_t doca_apsh_privileges_get ( doca_apsh_process* process, doca_apsh_privilege*** privileges, int* privileges_size ): Get array of current process privileges.
__DOCA_EXPERIMENTAL void doca_apsh_process_parameters_free ( doca_apsh_process_parameters* process_parameters ): Destroys a process-parameters context.
doca_error_t doca_apsh_process_parameters_get ( doca_apsh_process* process, doca_apsh_process_parameters** process_parameters ): Get current process parameters.
__DOCA_EXPERIMENTAL void doca_apsh_processes_free ( doca_apsh_process** processes ): Destroys a process context.
doca_error_t doca_apsh_processes_get ( doca_apsh_system* system, doca_apsh_process*** processes, int* processes_size ): Get array of current processes running on the system.
doca_error_t doca_apsh_regex_dev_set ( doca_apsh_ctx* ctx, doca_dev* regex_dev ): Set apsh regex device.
__DOCA_EXPERIMENTAL void doca_apsh_sids_free ( doca_apsh_sid** sids ): Destroys a SIDs context.
doca_error_t doca_apsh_sids_get ( doca_apsh_process* process, doca_apsh_sid*** sids, int* sids_size ): Get array of current process SIDs.
doca_error_t doca_apsh_start ( doca_apsh_ctx* ctx ): Start apsh handler.
doca_error_t doca_apsh_sys_dev_set ( doca_apsh_system* system, doca_dev_rep* dev ): Set system device.
doca_error_t doca_apsh_sys_kpgd_file_set ( doca_apsh_system* system, const char* system_kpgd_file_path ): Set system kpgd file.
doca_error_t doca_apsh_sys_mem_region_set ( doca_apsh_system* system, const char* system_mem_region_path ): Set system allowed memory regions.
doca_error_t doca_apsh_sys_os_symbol_map_set ( doca_apsh_system* system, const char* system_os_symbol_map_path ): Set system os symbol map.
doca_error_t doca_apsh_sys_os_type_set ( doca_apsh_system* system, doca_apsh_system_os os_type ): Set system os type.
doca_error_t doca_apsh_sys_set_scan_window_size ( doca_apsh_system* system, uint32_t scan_window_size ): Set system yara scan window size.
doca_error_t doca_apsh_sys_set_scan_window_step ( doca_apsh_system* system, uint32_t scan_window_step ): Set system yara scan window step.
__DOCA_EXPERIMENTAL doca_apsh_system* doca_apsh_system_create ( doca_apsh_ctx* ctx ): Create a new system handler.
__DOCA_EXPERIMENTAL void doca_apsh_system_destroy ( doca_apsh_system* system ): Destroy system handler.
doca_error_t doca_apsh_system_start ( doca_apsh_system* system ): Start system handler.
__DOCA_EXPERIMENTAL void doca_apsh_threads_free ( doca_apsh_thread** threads ): Destroys a threads context.
doca_error_t doca_apsh_threads_get ( doca_apsh_process* process, doca_apsh_thread*** threads, int* threads_size ): Get array of current process threads.
__DOCA_EXPERIMENTAL void doca_apsh_vads_free ( doca_apsh_vad** vads ): Destroys a vads context.
doca_error_t doca_apsh_vads_get ( doca_apsh_process* process, doca_apsh_vad*** vads, int* vads_size ): Get array of current process vads - virtual address descriptor.
__DOCA_EXPERIMENTAL void doca_apsh_yara_free ( doca_apsh_yara** yara_matches ): Destroys a yara context.
doca_error_t doca_apsh_yara_get ( doca_apsh_process* process, doca_apsh_yara_rule ** yara_rules_arr, uint32_t yara_rules_arr_size, uint64_t scan_type, doca_apsh_yara*** yara_matches, int* yara_matches_size ): Scan current process with yara rules. The scanning is done with a window size and step that are set by doca_apsh_sys_set_scan_window_size and doca_apsh_sys_set_scan_window_step.

Defines

#define doca_apsh_attst_info_get ( attestation, attr )

Get the requested info from attestation handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_attst_info_get(attestation, attr))

Parameters

attestation: single attestation handler
attr: Attribute to get the info on the module

#define doca_apsh_envar_info_get ( envar, attr )

Get the requested info from envar handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_envar_info_get(envar, attr))

Parameters

envar: single envar handler
attr: Attribute to get the info on the module

#define doca_apsh_handle_info_get ( handle, attr )

Get the requested info from handle handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_handle_info_get(handle, attr))

Parameters

handle: single handle handler
attr: Attribute to get the info on the module

#define doca_apsh_ldrmodule_info_get ( ldrmodule, attr )

Get the requested info from ldrmodule handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_ldrmodule_info_get(ldrmodule, attr))

Parameters

ldrmodule: single ldrmodule handler
attr: Attribute to get the info on the module

#define doca_apsh_lib_info_get ( lib, attr )

Get the requested info from lib handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_lib_info_get(lib, attr))

Parameters

lib: single lib handler
attr: Attribute to get the info on the module

#define doca_apsh_module_info_get ( module, attr )

Get the requested info from module handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_module_info_get(module, attr))

Parameters

module: single module handler
attr: Attribute to get the info on the module

#define doca_apsh_netscan_info_get ( connection, attr )

Get the requested info from connection handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_netscan_info_get(connection, attr))

Parameters

connection: single connection handler
attr: Attribute to get the info on the connection

#define doca_apsh_privilege_info_get ( privilege, attr )

Get the requested info from privilege handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_privilege_info_get(privilege, attr))

Parameters

privilege: single privilege handler
attr: Attribute to get the info on the module

#define doca_apsh_process_info_get ( process, attr )

Get the requested info from process handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_process_info_get(process, attr))

Parameters

process: single process handler
attr: Attribute to get the info on the module

#define doca_apsh_process_parameters_info_get ( process_parameters, attr )

Get the requested info from process_parameters handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_process_parameters_info_get(process_parameters, attr))

Parameters

process_parameters: single process_parameters handler
attr: Attribute to get the info on the process_parameters

#define doca_apsh_sid_info_get ( sid, attr )

Get the requested info from SID handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_sid_info_get(sid, attr))

Parameters

sid: single SID handler
attr: Attribute to get the info on the module

#define doca_apsh_sys_config ( system, attr, value )

Value

(__doca_apsh_sys_config(system, attr, (void *)((uintptr_t)value)))

Parameters

system: system handler
attr: Attribute to set in the system
value: the value to set

#define doca_apsh_thread_info_get ( thread, attr )

Get the requested info from thread handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_thread_info_get(thread, attr))

Parameters

thread: single thread handler
attr: Attribute to get the info on the module

#define doca_apsh_vad_info_get ( vad, attr )

Get the requested info from vad handler. The info is right to the snapshot (at the get function moment) full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_vad_info_get(vad, attr))

Parameters

vad: single vad handler
attr: Attribute to get the info on the module

#define doca_apsh_yara_info_get ( yara, attr )

Get the requested info from yara handler. The info is right to the snapshot (at the get function moment) Full list (type and descriptions) can be found in doca_apsh_attr.h

Value

((attr##_TYPE)(uintptr_t)__doca_apsh_yara_info_get(yara, attr))

Parameters

yara: single yara handler
attr: Attribute to get the info on the yara

Functions

const __DOCA_EXPERIMENTAL void* __doca_apsh_attst_info_get ( doca_apsh_attestation* attestation, doca_apsh_attestation_attr attr )

Shadow function - get attribute value for a attestation.

Parameters

attestation: single attestation handler
attr: Attribute to get the info on the attestation

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_attestation_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_envar_info_get ( doca_apsh_envar* envar, doca_apsh_envar_attr attr )

Shadow function - get attribute value for an environment variable.

Parameters

envar: single envar handler
attr: Attribute to get the info on the envar

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_envar_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_handle_info_get ( doca_apsh_handle* handle, doca_apsh_handle_attr attr )

Shadow function - get attribute value for a handle.

Parameters

handle: single handle handler
attr: Attribute to get the info on the handle

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_handle_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_ldrmodule_info_get ( doca_apsh_ldrmodule* ldrmodule, doca_apsh_ldrmodule_attr attr )

Shadow function - get attribute value for a modules.

Parameters

ldrmodule: single ldrmodule handler
attr: Attribute to get the info on the module

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_ldrmodule_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_lib_info_get ( doca_apsh_lib* lib, doca_apsh_lib_attr attr )

Shadow function - get attribute value for a lib.

Parameters

lib: single lib handler
attr: Attribute to get the info on the lib

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_lib_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_module_info_get ( doca_apsh_module* module, doca_apsh_module_attr attr )

Shadow function - get attribute value for a module.

Parameters

module: single module handler
attr: Attribute to get the info on the module

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_mod_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_netscan_info_get ( doca_apsh_netscan* connection, doca_apsh_netscan_attr attr )

Shadow function - get attribute value for a connection.

Parameters

connection: single connection handler
attr: Attribute to get the info on the connection

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_netscan_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_privilege_info_get ( doca_apsh_privilege* privilege, doca_apsh_privilege_attr attr )

Shadow function - get attribute value for a privilege.

Parameters

privilege: single privilege handler
attr: Attribute to get the info on the privilege

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_privilege_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_process_info_get ( doca_apsh_process* process, doca_apsh_process_attr attr )

Shadow function - get attribute value for a process.

Parameters

process: single process handler
attr: Attribute to get the info on the process

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_process_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_process_parameters_info_get ( doca_apsh_process_parameters* process_parameters, doca_apsh_process_parameters_attr attr )

Shadow function - get attribute value for a process-parameter.

Parameters

process_parameters: single process_parameters handler
attr: Attribute to get the info on the process_parameters

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_process_parameters_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_sid_info_get ( doca_apsh_sid* sid, doca_apsh_sid_attr attr )

Shadow function - get attribute value for a SID.

Parameters

sid: single SID handler
attr: Attribute to get the info on the SID

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_sid_info_get

doca_error_t __doca_apsh_sys_config ( doca_apsh_system* system, doca_apsh_system_config_attr attr, void* value )

Shadow function - configure attribute value for a system.

Parameters

system: system handler
attr: Attribute to set in the system
value: the value to set

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_SUPPORTED - if attr was OS type and an unsupported OS type had been received.
DOCA_ERROR_NO_MEMORY - if memory allocation failed.
DOCA_ERROR_BAD_STATE - if system is already started.

Description

Do not use this function, recommended to use doca_apsh_sys_config

const __DOCA_EXPERIMENTAL void* __doca_apsh_thread_info_get ( doca_apsh_thread* thread, doca_apsh_thread_attr attr )

Shadow function - get attribute value for a thread.

Parameters

thread: single thread handler
attr: Attribute to get the info on the thread

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_thread_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_vad_info_get ( doca_apsh_vad* vad, doca_apsh_vad_attr attr )

Shadow function - get attribute value for a vad.

Parameters

vad: single vad handler
attr: Attribute to get the info on the vad

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_vad_info_get

const __DOCA_EXPERIMENTAL void* __doca_apsh_yara_info_get ( doca_apsh_yara* yara, doca_apsh_yara_attr attr )

Shadow function - get attribute value for a yara.

Parameters

yara: single yara handler
attr: Attribute to get the info on the yara

Returns

return the info requested, need to cast

Description

Do not use this function, recommended to use doca_apsh_yara_info_get

__DOCA_EXPERIMENTAL void doca_apsh_attestation_free ( doca_apsh_attestation** attestation )

Destroys a attestation context.

Parameters

attestation: Attestation opaque pointer of the process to destroy

Description

doca_error_t doca_apsh_attestation_get ( doca_apsh_process* process, const char* exec_hash_map_path, doca_apsh_attestation*** attestation, int* attestation_size )

Get current process attestation.

Parameters

process: Process handler
exec_hash_map_path: path to file containing the hash calculations of the executable and dlls/libs of the process note that changing the process code or any libs can effect this. The file can be created by running the doca_exec_hash_build_map tool on the system.
attestation: Attestation opaque pointers of the process
attestation_size: Output param, will contain size of attestation array on success.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if modules list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to modules array.
DOCA_ERROR_NOT_FOUND - if process hasn't been found.

Description

This function is multithreaded compatible with different system context, meaning do not call this function simultaneously with the same system context. The return is snapshot, this is not dynamic, need to free it.

doca_error_t doca_apsh_attst_refresh ( doca_apsh_attestation*** attestation, int* attestation_size )

refresh single attestation handler of a process with new snapshot

Parameters

attestation: single attestation handler to refresh
attestation_size: Output param, will contain size of attestation array on success.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if modules list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to modules array.
DOCA_ERROR_NOT_FOUND - if process hasn't been found.

Description

This function is multithreaded compatible with different system context, Refresh the snapshot of the handler. Recommended to query all wanted information before refreshing.

__DOCA_EXPERIMENTAL doca_apsh_ctx* doca_apsh_create ( void )

Create a new apsh handler.

Returns

apsh context required for creating system handler, NULL on failure

Description

Allocate memory and init the opaque struct for apsh handler. Before using the system handler use doca_apsh_start

__DOCA_EXPERIMENTAL void doca_apsh_destroy ( doca_apsh_ctx* ctx )

Free the APSH memory and close connections.

Parameters

ctx: apsh context to destroy

Description

doca_error_t doca_apsh_dma_dev_set ( doca_apsh_ctx* ctx, doca_dev* dma_dev )

Set apsh dma device.

Parameters

ctx: apsh handler
dma_dev: doca device with dma capabilities, please refer to doca_dev.h

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - if cannot alloc new buffer for dma_dev_name.

Description

This is a Mandatory setter

__DOCA_EXPERIMENTAL void doca_apsh_envars_free ( doca_apsh_envar** envars )

Destroys a envars context.

Parameters

envars: Array of envars opaque pointers of the process to destroy

Description

doca_error_t doca_apsh_envars_get ( doca_apsh_process* process, doca_apsh_envar*** envars, int* envars_size )

Get array of current process environment variables.

Parameters

process: Process handler
envars: Array of environment variables opaque pointers of the process. in case process doesn't have any envars, will return NULL.
envars_size: Output param, will contain size of envars array on success.

Returns

DOCA_SUCCESS - in case of success (including the case envars_size is zero). doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if envars list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to envars array.
DOCA_ERROR_NOT_SUPPORTED - in case of unsupported system os.

Description

This function is multi-threaded compatible with different system context, meaning do not call this function simultaneously with the same system context. The return array is snapshot, the function allocates this array, use doca_apsh_envars_free to free it.

Note:

currently supported only for windows systems.

__DOCA_EXPERIMENTAL void doca_apsh_handles_free ( doca_apsh_handle** handles )

Destroys a handles context.

Parameters

handles: Array of handles opaque pointers of the process to destroy

Description

doca_error_t doca_apsh_handles_get ( doca_apsh_process* process, doca_apsh_handle*** handles, int* handles_size )

Get array of current process handles.

Parameters

process: Process handler
handles: Array of handles opaque pointers of the process. in case process doesn't have any handles, will return NULL.
handles_size: Output param, will contain size of handles array on success.

Returns

DOCA_SUCCESS - in case of success (including the case handles_size is zero). doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if handles list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to handles array.
DOCA_ERROR_NOT_SUPPORTED - in case of unsupported system os.

Description

Note:

currently supported only for windows systems.

__DOCA_EXPERIMENTAL void doca_apsh_ldrmodules_free ( doca_apsh_ldrmodule** ldrmodules )

Destroys a ldrmodules context.

Parameters

ldrmodules: Array of ldrmodules opaque pointers of the process to destroy

Description

doca_error_t doca_apsh_ldrmodules_get ( doca_apsh_process* process, doca_apsh_ldrmodule*** ldrmodules, int* ldrmodules_size )

Get array of current process modules.

Parameters

process: Process handler
ldrmodules: Array of ldrmodules opaque pointers of the process. in case process doesn't have any modules, will return NULL.
ldrmodules_size: Output param, will contain size of ldrmodules array on success.

Returns

DOCA_SUCCESS - in case of success (including the case ldrmodules_size is zero). doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if ldrmodules list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to ldrmodules array.
DOCA_ERROR_NOT_SUPPORTED - in case of unsupported system os.

Description

Note:

currently supported only for windows systems.

__DOCA_EXPERIMENTAL void doca_apsh_libs_free ( doca_apsh_lib** libs )

Destroys a libs context.

Parameters

libs: Array of libs opaque pointers of the process to destroy

Description

doca_error_t doca_apsh_libs_get ( doca_apsh_process* process, doca_apsh_lib*** libs, int* libs_size )

Get array of current process loadable libraries.

Parameters

process: Process handler
libs: Array of libs opaque pointers of the process. in case process doesn't point to any libs, will return NULL.
libs_size: Output param, will contain size of libs array on success.

Returns

DOCA_SUCCESS - in case of success (including the case libs_size is zero). doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if libs list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to libs array.

Description

This function is multithreaded compatible with different system context, meaning do not call this function simultaneously with the same system context. The return array is snapshot, this is not dynamic array, need to free it.

__DOCA_EXPERIMENTAL void doca_apsh_module_free ( doca_apsh_module** modules )

Destroys a modules array.

Parameters

modules: Array of module opaque pointers of the systems to destroy

Description

doca_error_t doca_apsh_modules_get ( doca_apsh_system* system, doca_apsh_module*** modules, int* modules_size )

Get array of current modules installed on the system.

Parameters

system: System handler
modules: Array of module opaque pointers of the systems
modules_size: Output param, will contain size of modules array on success.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if modules list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to modules array.

Description

__DOCA_EXPERIMENTAL void doca_apsh_netscan_free ( doca_apsh_netscan** connections )

Destroys a netscan context.

Parameters

connections: Array of connections opaque pointers of the system to destroy

Description

doca_error_t doca_apsh_netscan_get ( doca_apsh_system* system, doca_apsh_netscan*** connections, int* connections_size )

Get array of current connections.

Parameters

system: System handler
connections: Pointer to array of connections opaque pointers of the system
connections_size: Output param, will contain size of connections array on success

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if connections list initialization failed or no regex device was set.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to connections array.
DOCA_ERROR_NOT_SUPPORTED - if unsupported OS type has been received (or unsupported OS build). list of supported builds: Windows 10 10240 x86 Windows 10 10586 x86 Windows 10 14393 x86 Windows 10 15063 x64 Windows 10 15063 x86 Windows 10 16299 x64 Windows 10 17134 x64 Windows 10 17134 x86 Windows 10 17763 x64 Windows 10 18362 x64 Windows 10 18363 x64 Windows 10 19041 x64 Windows 10 19041 x86
DOCA_ERROR_BAD_STATE - if system isn't started yet.

Description

Note:

currently supported only for systems with windows 10 build (such as: windows 10 and windows server 2019).
this function requires the usage of regex device. (set it using doca_apsh_regex_dev_set)

__DOCA_EXPERIMENTAL void doca_apsh_privileges_free ( doca_apsh_privilege** privileges )

Destroys a privileges context.

Parameters

privileges: Array of privileges opaque pointers of the process to destroy

Description

doca_error_t doca_apsh_privileges_get ( doca_apsh_process* process, doca_apsh_privilege*** privileges, int* privileges_size )

Get array of current process privileges.

Parameters

process: Process handler
privileges: Array of privileges opaque pointers of the process. in case process doesn't have any privileges, will return NULL.
privileges_size: Output param, will contain size of privileges array on success.

Returns

DOCA_SUCCESS - in case of success (including the case privileges_size is zero). doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if privileges list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to privileges array.
DOCA_ERROR_NOT_SUPPORTED - in case of unsupported system os.

Description

Note:

currently supported only for windows systems.

__DOCA_EXPERIMENTAL void doca_apsh_process_parameters_free ( doca_apsh_process_parameters* process_parameters )

Destroys a process-parameters context.

Parameters

process_parameters: process-parameters opaque pointer of the process

Description

doca_error_t doca_apsh_process_parameters_get ( doca_apsh_process* process, doca_apsh_process_parameters** process_parameters )

Get current process parameters.

Parameters

process: Process handler
process_parameters: Pointer of process-parameters opaque pointer of the process. In case process-parameters data are paged out, will return NULL.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if process-parameters object initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot allocate memory to process-parameters object.
DOCA_ERROR_NOT_SUPPORTED - in case of unsupported system os.
DOCA_ERROR_BAD_STATE - in case the relevant memory is not present in the system memory.

Description

This function is multi-threaded compatible with different system context, meaning do not call this function simultaneously with the same system context. The return object is a snapshot, not a dynamic object, need to free it.

Note:

currently supported only for windows systems.

__DOCA_EXPERIMENTAL void doca_apsh_processes_free ( doca_apsh_process** processes )

Destroys a process context.

Parameters

processes: Array of process opaque pointers of the systems to destroy

Description

doca_error_t doca_apsh_processes_get ( doca_apsh_system* system, doca_apsh_process*** processes, int* processes_size )

Get array of current processes running on the system.

Parameters

system: System handler
processes: Array of process opaque pointers of the systems
processes_size: Output param, will contain size of processes array on success.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if processes list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to processes array.

Description

doca_error_t doca_apsh_regex_dev_set ( doca_apsh_ctx* ctx, doca_dev* regex_dev )

Set apsh regex device.

Parameters

ctx: apsh handler
regex_dev: doca device with the capabilities of regex

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

This is not a Mandatory setter

Note:

currently this device is used only for windows systems.

__DOCA_EXPERIMENTAL void doca_apsh_sids_free ( doca_apsh_sid** sids )

Destroys a SIDs context.

Parameters

sids: Array of SIDs opaque pointers of the process to destroy

Description

doca_error_t doca_apsh_sids_get ( doca_apsh_process* process, doca_apsh_sid*** sids, int* sids_size )

Get array of current process SIDs.

Parameters

process: Process handler
sids: Array of SIDs opaque pointers of the process. in case process doesn't have any SIDs, will return NULL.
sids_size: Output param, will contain size of SIDs array on success.

Returns

DOCA_SUCCESS - in case of success (including the case handles_size is zero). doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if SIDs list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to SIDs array.
DOCA_ERROR_NOT_SUPPORTED - in case of unsupported system os.

Description

Note:

currently supported only for windows systems.

doca_error_t doca_apsh_start ( doca_apsh_ctx* ctx )

Start apsh handler.

Parameters

ctx: App Shield handler

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Start apsh handler and init connection to devices. Need to set apsh params with setter functions before starting the system. Mandatory setters: doca_apsh_dma_dev_set. Other setters can be query automatically but will take time.

doca_error_t doca_apsh_sys_dev_set ( doca_apsh_system* system, doca_dev_rep* dev )

Set system device.

Parameters

system: system handler
dev: the device that is connected to the system to be queried. for example a vf that is connected to a vm or pf that is connected to the bare-metal. doca representor device from dma device configured in doca_apsh_dma_dev_set. to query the right device please refer to doca_dev.h for full options.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if system was already started.

Description

This is a Mandatory setter

doca_error_t doca_apsh_sys_kpgd_file_set ( doca_apsh_system* system, const char* system_kpgd_file_path )

Set system kpgd file.

Parameters

system: system handler
system_kpgd_file_path: the path to kpgd file

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_SUPPORTED - if unsupported OS type had been received.
DOCA_ERROR_BAD_STATE - if system was already started.

Description

This is not a must setter

doca_error_t doca_apsh_sys_mem_region_set ( doca_apsh_system* system, const char* system_mem_region_path )

Set system allowed memory regions.

Parameters

system: system handler
system_mem_region_path: path to json file containing the memory regions of the devices The memory regions are unique per system, would not change on reboot or between different devices of the same system. note that adding/removing device from the host can change the regions. The json can be created by running the doca_system_mem_region tool on the system.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - if cannot alloc new buffer for system_os_symbol_map_path.
DOCA_ERROR_BAD_STATE - if system was already started.

Description

This is a Mandatory setter

doca_error_t doca_apsh_sys_os_symbol_map_set ( doca_apsh_system* system, const char* system_os_symbol_map_path )

Set system os symbol map.

Parameters

system: system handler
system_os_symbol_map_path: the os memory map data, unique per os build please note that changing linux kernel (adding/removing modules) will change the map should be created by running the doca_system_os_symbol_map tool on the system os

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - if cannot alloc new buffer for system_os_symbol_map_path.
DOCA_ERROR_BAD_STATE - if system was already started.

Description

This is a Mandatory setter

doca_error_t doca_apsh_sys_os_type_set ( doca_apsh_system* system, doca_apsh_system_os os_type )

Set system os type.

Parameters

system: system handler
os_type: system os type - windows/linux

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_SUPPORTED - if unsupported OS type had been received.
DOCA_ERROR_BAD_STATE - if system was already started.

Description

This is a must setter

doca_error_t doca_apsh_sys_set_scan_window_size ( doca_apsh_system* system, uint32_t scan_window_size )

Set system yara scan window size.

Parameters

system: system handler
scan_window_size: yara scan window size (in bytes) a condition on scan window size is: (window_scan_size % PAGE_SIZE == 0) or (PAGE_SIZE % window_scan_size == 0)

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

This is not a must setter. Default size is 4KB.

doca_error_t doca_apsh_sys_set_scan_window_step ( doca_apsh_system* system, uint32_t scan_window_step )

Set system yara scan window step.

Parameters

system: system handler
scan_window_step: yara scan window step (in bytes) a condition on scan window step is: window_scan_size % scan_window_step == 0

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

This is not a must setter. Default size is 4KB. Since this setter is dependant on scan_window_size, make sure to call it afrer "doca_apsh_sys_set_scan_window_size".

__DOCA_EXPERIMENTAL doca_apsh_system* doca_apsh_system_create ( doca_apsh_ctx* ctx )

Create a new system handler.

Parameters

ctx: apsh handler

Returns

returns system pointer, NULL on failure

Description

Allocate memory and init the opaque struct for system handler. Before using the system handler use doca_apsh_system_start

__DOCA_EXPERIMENTAL void doca_apsh_system_destroy ( doca_apsh_system* system )

Destroy system handler.

Parameters

system: system context to destroy

Description

This will not destroy process/module/libs ...

doca_error_t doca_apsh_system_start ( doca_apsh_system* system )

Start system handler.

Parameters

system: system handler

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if app-shield system initialization has failed.

Description

Start system handler and init connection to the system. Need to set system params with setter functions before starting the system. Mandatory setters: os_symbol_map, mem_region, dev. Other setters can be query automatically but will take time.

__DOCA_EXPERIMENTAL void doca_apsh_threads_free ( doca_apsh_thread** threads )

Destroys a threads context.

Parameters

threads: Array of threads opaque pointers of the process to destroy

Description

doca_error_t doca_apsh_threads_get ( doca_apsh_process* process, doca_apsh_thread*** threads, int* threads_size )

Get array of current process threads.

Parameters

process: Process handler
threads: Array of threads opaque pointers of the process. in case process doesn't have any threads, will return NULL.
threads_size: Output param, will contain size of threads array on success.

Returns

DOCA_SUCCESS - in case of success (including the case threads_size is zero). doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if threads list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to threads array.

Description

__DOCA_EXPERIMENTAL void doca_apsh_vads_free ( doca_apsh_vad** vads )

Destroys a vads context.

Parameters

vads: Array of vads opaque pointers of the process to destroy

Description

doca_error_t doca_apsh_vads_get ( doca_apsh_process* process, doca_apsh_vad*** vads, int* vads_size )

Get array of current process vads - virtual address descriptor.

Parameters

process: Process handler
vads: Array of vads opaque pointers of the process. in case process doesn't point to any vads, will return NULL.
vads_size: Output param, will contain size of vads array on success.

Returns

DOCA_SUCCESS - in case of success (including the case vads_size is zero). doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if modules list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to modules array.
DOCA_ERROR_NOT_FOUND - if process hasn't been found.

Description

__DOCA_EXPERIMENTAL void doca_apsh_yara_free ( doca_apsh_yara** yara_matches )

Destroys a yara context.

Parameters

yara_matches: Array of yara matches opaque pointers to destroy

Description

doca_error_t doca_apsh_yara_get ( doca_apsh_process* process, doca_apsh_yara_rule ** yara_rules_arr, uint32_t yara_rules_arr_size, uint64_t scan_type, doca_apsh_yara*** yara_matches, int* yara_matches_size )

Scan current process with yara rules. The scanning is done with a window size and step that are set by doca_apsh_sys_set_scan_window_size and doca_apsh_sys_set_scan_window_step.

Parameters

process: Process handler
yara_rules_arr: Array of type doca_apsh_yara_rule containing the rules to check against the process's memory
yara_rules_arr_size: Length of yara_rules_arr
scan_type: YARA scan type bitmask - to scan the whole vad tree or just heaps This will affect performance, please see enum doca_apsh_yara_scan_type
yara_matches: Point to array of yara matches opaque pointers. In case no yara matches were found, will return NULL.
yara_matches_size: Output param, will contain size of YARA array on success.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_INITIALIZATION - if yara matches list initialization failed.
DOCA_ERROR_NO_MEMORY - if cannot alloc memory to yara matches array.
DOCA_ERROR_NOT_FOUND - if process hasn't been found.
DOCA_ERROR_NOT_SUPPORTED - in case of unsupported system os or DPU.

Description

Note:

1. Currently supported only for windows systems 2. Currently supported only on DPU with Ubuntu 22.04.

2.2. App Shield Attributes

DOCA App Shield attributes to query with get functions, see doca_apsh.h

Typedefs

typedef char * DOCA_APSH_ATTESTATION_COMM_TYPE: attestation comm type
typedef uint64_t DOCA_APSH_ATTESTATION_END_ADDRESS_TYPE: attestation end address type
typedef bool DOCA_APSH_ATTESTATION_HASH_DATA_IS_PRESENT_TYPE: attestation hash data is present type
typedef int DOCA_APSH_ATTESTATION_MATCHING_HASHES_TYPE: attestation matching hashes type
typedef int DOCA_APSH_ATTESTATION_PAGES_NUMBER_TYPE: attestation pages number type
typedef int DOCA_APSH_ATTESTATION_PAGES_PRESENT_TYPE: attestation pages present type
typedef char * DOCA_APSH_ATTESTATION_PATH_OF_MEMORY_AREA_TYPE: attestation path of memory area type
typedef unsigned int DOCA_APSH_ATTESTATION_PID_TYPE: attestation pid type
typedef char * DOCA_APSH_ATTESTATION_PROTECTION_TYPE: attestation protection type
typedef uint64_t DOCA_APSH_ATTESTATION_START_ADDRESS_TYPE: attestation start address type
typedef doca_dev * DOCA_APSH_DMA_DEV_TYPE: dma dev name
typedef char * DOCA_APSH_ENVARS_COMM_TYPE: envars comm type
typedef unsigned int DOCA_APSH_ENVARS_PID_TYPE: envars pid type
typedef char * DOCA_APSH_ENVARS_VALUE_TYPE: envars value type
typedef char * DOCA_APSH_ENVARS_VARIABLE_TYPE: envars variable type
typedef uint64_t DOCA_APSH_ENVARS_WINDOWS_BLOCK_TYPE: envars windows block address type
typedef uint64_t DOCA_APSH_HANDLE_ACCESS_TYPE: handle access type
typedef char * DOCA_APSH_HANDLE_COMM_TYPE: handle comm type
typedef char * DOCA_APSH_HANDLE_NAME_TYPE: handle name type
typedef unsigned int DOCA_APSH_HANDLE_PID_TYPE: handle pid type
typedef uint64_t DOCA_APSH_HANDLE_TABLE_ENTRY_TYPE: handle table entry type
typedef char * DOCA_APSH_HANDLE_TYPE_TYPE: handle type type
typedef uint64_t DOCA_APSH_HANDLE_VALUE_TYPE: handle value type
typedef int DOCA_APSH_HASHTEST_LIMIT_TYPE: limit of vm areas to attest
typedef char * DOCA_APSH_KPGD_FILE_TYPE: kpgd file path
typedef uint64_t DOCA_APSH_LDRMODULE_BASE_ADDRESS_TYPE: ldrmodule base adress type
typedef char * DOCA_APSH_LDRMODULE_COMM_TYPE: ldrmodule comm type
typedef char * DOCA_APSH_LDRMODULE_LIBRARY_PATH_TYPE: ldrmodule library path type
typedef unsigned int DOCA_APSH_LDRMODULE_PID_TYPE: ldrmodule pid type
typedef char * DOCA_APSH_LDRMODULE_WINDOWS_BASE_DLL_NAME_TYPE: ldrmodule windows BASE dll name type
typedef bool DOCA_APSH_LDRMODULE_WINDOWS_ININIT_TYPE: ldrmodule ininit type
typedef bool DOCA_APSH_LDRMODULE_WINDOWS_INLOAD_TYPE: ldrmodule inload type
typedef bool DOCA_APSH_LDRMODULE_WINDOWS_INMEM_TYPE: ldrmodule inmem type
typedef unsignedlong DOCA_APSH_LDRMODULE_WINDOWS_SIZE_OF_IMAGE_TYPE: ldrmodule size of image type
typedef int DOCA_APSH_LIBS_LIMIT_TYPE: limit of libs number
typedef char * DOCA_APSH_LIB_COMM_TYPE: lib comm type
typedef char * DOCA_APSH_LIB_LIBRARY_PATH_TYPE: lib loaded library path type
typedef uint64_t DOCA_APSH_LIB_LINUX_LOAD_ADRESS_TYPE: lib load address for Linux
typedef uint64_t DOCA_APSH_LIB_LOAD_ADRESS_TYPE: lib load address for both Windows and Linux
typedef unsigned int DOCA_APSH_LIB_PID_TYPE: lib pid type
typedef char * DOCA_APSH_LIB_WINDOWS_FULL_DLL_NAME_TYPE: lib full dll name type
typedef unsignedlong DOCA_APSH_LIB_WINDOWS_SIZE_OFIMAGE_TYPE: lib size ofimage type
typedef char * DOCA_APSH_MEM_REGION_TYPE: memory region path
typedef int DOCA_APSH_MODULES_LIMIT_TYPE: llimit of modules number
typedef char * DOCA_APSH_MODULES_NAME_TYPE: module name type
typedef uint64_t DOCA_APSH_MODULES_OFFSET_TYPE: module offset type
typedef uint32_t DOCA_APSH_MODULES_SIZE_TYPE: module size type
typedef char * DOCA_APSH_NETSCAN_COMM_TYPE: netscan process name
typedef char * DOCA_APSH_NETSCAN_LOCAL_ADDR_TYPE: netscan connection local address
typedef uint16_t DOCA_APSH_NETSCAN_LOCAL_PORT_TYPE: netscan connection local port
typedef uint32_t DOCA_APSH_NETSCAN_PID_TYPE: netscan process id
typedef char * DOCA_APSH_NETSCAN_PROTOCOL_TYPE: netscan connection protcol
typedef char * DOCA_APSH_NETSCAN_REMOTE_ADDR_TYPE: netscan connection remote address
typedef uint16_t DOCA_APSH_NETSCAN_REMOTE_PORT_TYPE: netscan connection remote port
typedef char * DOCA_APSH_NETSCAN_STATE_TYPE: netscan connection state
typedef char * DOCA_APSH_NETSCAN_TIME_TYPE: netscan connection creation time
typedef char * DOCA_APSH_OS_SYMBOL_MAP_TYPE: os symbol map path
typedef enumdoca_apsh_system_os DOCA_APSH_OS_TYPE_TYPE: os type
typedef char * DOCA_APSH_PRIVILEGES_COMM_TYPE: privilege process name
typedef bool DOCA_APSH_PRIVILEGES_IS_ON_TYPE: privilege is on type
typedef char * DOCA_APSH_PRIVILEGES_NAME_TYPE: privilege name type
typedef unsigned int DOCA_APSH_PRIVILEGES_PID_TYPE: privilege process pid
typedef bool DOCA_APSH_PRIVILEGES_WINDOWS_DEFAULT_TYPE: privilege windows enabled by default type
typedef bool DOCA_APSH_PRIVILEGES_WINDOWS_ENABLED_TYPE: privilege windows enabled type
typedef bool DOCA_APSH_PRIVILEGES_WINDOWS_PRESENT_TYPE: privilege windows present type
typedef char * DOCA_APSH_PROCESS_COMM_TYPE: process comm type
typedef uint64_t DOCA_APSH_PROCESS_CPU_TIME_TYPE: process cpu time type
typedef int DOCA_APSH_PROCESS_LIMIT_TYPE: limit of processes number
typedef unsigned int DOCA_APSH_PROCESS_LINUX_GID_TYPE: process gid type
typedef uint64_t DOCA_APSH_PROCESS_LINUX_STATE_TYPE: process state type
typedef unsigned int DOCA_APSH_PROCESS_LINUX_UID_TYPE: process uid type
typedef char * DOCA_APSH_PROCESS_PARAMETERS_CMD_LINE_TYPE: process-parameters command line
typedef uint64_t DOCA_APSH_PROCESS_PARAMETERS_IMAGE_BASE_ADDR_TYPE: process-parameters image base address
typedef char * DOCA_APSH_PROCESS_PARAMETERS_IMAGE_FULL_PATH_TYPE: process-parameters image full path
typedef unsigned int DOCA_APSH_PROCESS_PARAMETERS_PID_TYPE: process-parameters pid
typedef unsigned int DOCA_APSH_PROCESS_PID_TYPE: process pid type
typedef unsigned int DOCA_APSH_PROCESS_PPID_TYPE: process pid type
typedef uint32_t DOCA_APSH_PROCESS_SID_ATTRIBUTES_TYPE: SID attributes flag.
typedef unsigned int DOCA_APSH_PROCESS_SID_PID_TYPE: SID process id.
typedef char * DOCA_APSH_PROCESS_SID_STRING_TYPE: SID strings.
typedef uint64_t DOCA_APSH_PROCESS_WINDOWS_OFFSET_TYPE: process offset type
typedef int DOCA_APSH_PROCESS_WINDOWS_THREADS_TYPE: process threads type
typedef char * DOCA_APSH_REGEX_DEV_TYPE: regex dev name
typedef uint32_t DOCA_APSH_SCAN_WIN_SIZE_TYPE: yara scan window size
typedef uint32_t DOCA_APSH_SCAN_WIN_STEP_TYPE: yara scan window step
typedef int DOCA_APSH_STRING_LIMIT_TYPE: length limit of apsh_read_str
typedef int DOCA_APSH_THREADS_LIMIT_TYPE: limit of threads number
typedef char * DOCA_APSH_THREAD_LINUX_PROC_NAME_TYPE: thread proc name type
typedef char * DOCA_APSH_THREAD_LINUX_THREAD_NAME_TYPE: thread thread name type
typedef unsigned int DOCA_APSH_THREAD_PID_TYPE: thread pid type
typedef long DOCA_APSH_THREAD_STATE_TYPE: thread state type
typedef unsigned int DOCA_APSH_THREAD_TID_TYPE: thread tid type
typedef uint64_t DOCA_APSH_THREAD_WINDOWS_OFFSET_TYPE: thread offset type
typedef unsigned char DOCA_APSH_THREAD_WINDOWS_WAIT_REASON_TYPE: thread wait reason type
typedef int DOCA_APSH_VADS_LIMIT_TYPE: limit of vads number
typedef doca_dev_rep * DOCA_APSH_VHCA_ID_TYPE: vhca id
typedef char * DOCA_APSH_VMA_FILE_PATH_TYPE: vma file path type
typedef uint64_t DOCA_APSH_VMA_OFFSET_TYPE: vma offset type
typedef unsigned int DOCA_APSH_VMA_PID_TYPE: vma pid type
typedef char * DOCA_APSH_VMA_PROCESS_NAME_TYPE: vma file path type
typedef char * DOCA_APSH_VMA_PROTECTION_TYPE: vma protection type
typedef uint64_t DOCA_APSH_VMA_VM_END_TYPE: vma vm end type
typedef uint64_t DOCA_APSH_VMA_VM_START_TYPE: vma vm start type
typedef int DOCA_APSH_VMA_WINDOWS_COMMIT_CHARGE_TYPE: vma commit charge type
typedef int DOCA_APSH_VMA_WINDOWS_PRIVATE_MEMORY_TYPE: vma private memory type
typedef char * DOCA_APSH_VMA_WINDOWS_TAG_TYPE: vma tag type
typedef int DOCA_APSH_WINDOWS_ENVARS_LIMIT_TYPE: length limit of envars for windows
typedef char * DOCA_APSH_YARA_COMM_TYPE: name of the process
typedef uint64_t DOCA_APSH_YARA_MATCH_WINDOW_ADDR_TYPE: virtual address of the scan window of the match
typedef uint64_t DOCA_APSH_YARA_MATCH_WINDOW_LEN_TYPE: length of the scan window of the match
typedef uint32_t DOCA_APSH_YARA_PID_TYPE: pid of the process
typedef char * DOCA_APSH_YARA_RULE_TYPE: rule name

Enumerations

enum doca_apsh_attestation_attr: doca app shield attestation attributes
enum doca_apsh_envar_attr: doca app shield envars attributes
enum doca_apsh_handle_attr: doca app shield handle attributes
enum doca_apsh_ldrmodule_attr: doca app shield LDR-Modules attributes
enum doca_apsh_lib_attr: doca app shield lib attributes
enum doca_apsh_module_attr: doca app shield module attributes
enum doca_apsh_netscan_attr: doca app shield netsacn attributes
enum doca_apsh_privilege_attr: doca app shield privileges attributes windows privilege list can be found on: https://docs.microsoft.com/en-us/windows/win32/secauthz/privilege-constants
enum doca_apsh_process_attr: doca app shield process attributes
enum doca_apsh_process_parameters_attr: doca app shield process-parameters attributes
enum doca_apsh_sid_attr: doca app shield SID (secruity identifiers) attributes
enum doca_apsh_system_config_attr: doca app shield configuration attributes
enum doca_apsh_system_os: system os types
enum doca_apsh_thread_attr: doca app shield thread attributes
enum doca_apsh_vad_attr: doca app shield virtual address descriptor attributes
enum doca_apsh_yara_attr: doca app shield yara attributes
enum doca_apsh_yara_rule: avaiable doca app shield yara rules
enum doca_apsh_yara_scan_type: doca app shield yara scan type bitmask

Typedefs

typedef char * DOCA_APSH_ATTESTATION_COMM_TYPE

attestation comm type

typedef uint64_t DOCA_APSH_ATTESTATION_END_ADDRESS_TYPE

attestation end address type

typedef bool DOCA_APSH_ATTESTATION_HASH_DATA_IS_PRESENT_TYPE

attestation hash data is present type

typedef int DOCA_APSH_ATTESTATION_MATCHING_HASHES_TYPE

attestation matching hashes type

typedef int DOCA_APSH_ATTESTATION_PAGES_NUMBER_TYPE

attestation pages number type

typedef int DOCA_APSH_ATTESTATION_PAGES_PRESENT_TYPE

attestation pages present type

typedef char * DOCA_APSH_ATTESTATION_PATH_OF_MEMORY_AREA_TYPE

attestation path of memory area type

typedef unsigned int DOCA_APSH_ATTESTATION_PID_TYPE

attestation pid type

typedef char * DOCA_APSH_ATTESTATION_PROTECTION_TYPE

attestation protection type

typedef uint64_t DOCA_APSH_ATTESTATION_START_ADDRESS_TYPE

attestation start address type

typedef doca_dev * DOCA_APSH_DMA_DEV_TYPE

dma dev name

typedef char * DOCA_APSH_ENVARS_COMM_TYPE

envars comm type

typedef unsigned int DOCA_APSH_ENVARS_PID_TYPE

envars pid type

typedef char * DOCA_APSH_ENVARS_VALUE_TYPE

envars value type

typedef char * DOCA_APSH_ENVARS_VARIABLE_TYPE

envars variable type

typedef uint64_t DOCA_APSH_ENVARS_WINDOWS_BLOCK_TYPE

envars windows block address type

typedef uint64_t DOCA_APSH_HANDLE_ACCESS_TYPE

handle access type

typedef char * DOCA_APSH_HANDLE_COMM_TYPE

handle comm type

typedef char * DOCA_APSH_HANDLE_NAME_TYPE

handle name type

typedef unsigned int DOCA_APSH_HANDLE_PID_TYPE

handle pid type

typedef uint64_t DOCA_APSH_HANDLE_TABLE_ENTRY_TYPE

handle table entry type

typedef char * DOCA_APSH_HANDLE_TYPE_TYPE

handle type type

typedef uint64_t DOCA_APSH_HANDLE_VALUE_TYPE

handle value type

typedef int DOCA_APSH_HASHTEST_LIMIT_TYPE

limit of vm areas to attest

typedef char * DOCA_APSH_KPGD_FILE_TYPE

kpgd file path

typedef uint64_t DOCA_APSH_LDRMODULE_BASE_ADDRESS_TYPE

ldrmodule base adress type

typedef char * DOCA_APSH_LDRMODULE_COMM_TYPE

ldrmodule comm type

typedef char * DOCA_APSH_LDRMODULE_LIBRARY_PATH_TYPE

ldrmodule library path type

typedef unsigned int DOCA_APSH_LDRMODULE_PID_TYPE

ldrmodule pid type

typedef char * DOCA_APSH_LDRMODULE_WINDOWS_BASE_DLL_NAME_TYPE

ldrmodule windows BASE dll name type

typedef bool DOCA_APSH_LDRMODULE_WINDOWS_ININIT_TYPE

ldrmodule ininit type

typedef bool DOCA_APSH_LDRMODULE_WINDOWS_INLOAD_TYPE

ldrmodule inload type

typedef bool DOCA_APSH_LDRMODULE_WINDOWS_INMEM_TYPE

ldrmodule inmem type

typedef unsignedlong DOCA_APSH_LDRMODULE_WINDOWS_SIZE_OF_IMAGE_TYPE

ldrmodule size of image type

typedef int DOCA_APSH_LIBS_LIMIT_TYPE

limit of libs number

typedef char * DOCA_APSH_LIB_COMM_TYPE

lib comm type

typedef char * DOCA_APSH_LIB_LIBRARY_PATH_TYPE

lib loaded library path type

typedef uint64_t DOCA_APSH_LIB_LINUX_LOAD_ADRESS_TYPE

lib load address for Linux

typedef uint64_t DOCA_APSH_LIB_LOAD_ADRESS_TYPE

lib load address for both Windows and Linux

typedef unsigned int DOCA_APSH_LIB_PID_TYPE

lib pid type

typedef char * DOCA_APSH_LIB_WINDOWS_FULL_DLL_NAME_TYPE

lib full dll name type

typedef unsignedlong DOCA_APSH_LIB_WINDOWS_SIZE_OFIMAGE_TYPE

lib size ofimage type

typedef char * DOCA_APSH_MEM_REGION_TYPE

memory region path

typedef int DOCA_APSH_MODULES_LIMIT_TYPE

llimit of modules number

typedef char * DOCA_APSH_MODULES_NAME_TYPE

module name type

typedef uint64_t DOCA_APSH_MODULES_OFFSET_TYPE

module offset type

typedef uint32_t DOCA_APSH_MODULES_SIZE_TYPE

module size type

typedef char * DOCA_APSH_NETSCAN_COMM_TYPE

netscan process name

typedef char * DOCA_APSH_NETSCAN_LOCAL_ADDR_TYPE

netscan connection local address

typedef uint16_t DOCA_APSH_NETSCAN_LOCAL_PORT_TYPE

netscan connection local port

typedef uint32_t DOCA_APSH_NETSCAN_PID_TYPE

netscan process id

typedef char * DOCA_APSH_NETSCAN_PROTOCOL_TYPE

netscan connection protcol

typedef char * DOCA_APSH_NETSCAN_REMOTE_ADDR_TYPE

netscan connection remote address

typedef uint16_t DOCA_APSH_NETSCAN_REMOTE_PORT_TYPE

netscan connection remote port

typedef char * DOCA_APSH_NETSCAN_STATE_TYPE

netscan connection state

typedef char * DOCA_APSH_NETSCAN_TIME_TYPE

netscan connection creation time

typedef char * DOCA_APSH_OS_SYMBOL_MAP_TYPE

os symbol map path

typedef enumdoca_apsh_system_os DOCA_APSH_OS_TYPE_TYPE

os type

typedef char * DOCA_APSH_PRIVILEGES_COMM_TYPE

privilege process name

typedef bool DOCA_APSH_PRIVILEGES_IS_ON_TYPE

privilege is on type

typedef char * DOCA_APSH_PRIVILEGES_NAME_TYPE

privilege name type

typedef unsigned int DOCA_APSH_PRIVILEGES_PID_TYPE

privilege process pid

typedef bool DOCA_APSH_PRIVILEGES_WINDOWS_DEFAULT_TYPE

privilege windows enabled by default type

typedef bool DOCA_APSH_PRIVILEGES_WINDOWS_ENABLED_TYPE

privilege windows enabled type

typedef bool DOCA_APSH_PRIVILEGES_WINDOWS_PRESENT_TYPE

privilege windows present type

typedef char * DOCA_APSH_PROCESS_COMM_TYPE

process comm type

typedef uint64_t DOCA_APSH_PROCESS_CPU_TIME_TYPE

process cpu time type

typedef int DOCA_APSH_PROCESS_LIMIT_TYPE

limit of processes number

typedef unsigned int DOCA_APSH_PROCESS_LINUX_GID_TYPE

process gid type

typedef uint64_t DOCA_APSH_PROCESS_LINUX_STATE_TYPE

process state type

typedef unsigned int DOCA_APSH_PROCESS_LINUX_UID_TYPE

process uid type

typedef char * DOCA_APSH_PROCESS_PARAMETERS_CMD_LINE_TYPE

process-parameters command line

typedef uint64_t DOCA_APSH_PROCESS_PARAMETERS_IMAGE_BASE_ADDR_TYPE

process-parameters image base address

typedef char * DOCA_APSH_PROCESS_PARAMETERS_IMAGE_FULL_PATH_TYPE

process-parameters image full path

typedef unsigned int DOCA_APSH_PROCESS_PARAMETERS_PID_TYPE

process-parameters pid

typedef unsigned int DOCA_APSH_PROCESS_PID_TYPE

process pid type

typedef unsigned int DOCA_APSH_PROCESS_PPID_TYPE

process pid type

typedef uint32_t DOCA_APSH_PROCESS_SID_ATTRIBUTES_TYPE

SID attributes flag.

typedef unsigned int DOCA_APSH_PROCESS_SID_PID_TYPE

SID process id.

typedef char * DOCA_APSH_PROCESS_SID_STRING_TYPE

SID strings.

typedef uint64_t DOCA_APSH_PROCESS_WINDOWS_OFFSET_TYPE

process offset type

typedef int DOCA_APSH_PROCESS_WINDOWS_THREADS_TYPE

process threads type

typedef char * DOCA_APSH_REGEX_DEV_TYPE

regex dev name

typedef uint32_t DOCA_APSH_SCAN_WIN_SIZE_TYPE

yara scan window size

typedef uint32_t DOCA_APSH_SCAN_WIN_STEP_TYPE

yara scan window step

typedef int DOCA_APSH_STRING_LIMIT_TYPE

length limit of apsh_read_str

typedef int DOCA_APSH_THREADS_LIMIT_TYPE

limit of threads number

typedef char * DOCA_APSH_THREAD_LINUX_PROC_NAME_TYPE

thread proc name type

typedef char * DOCA_APSH_THREAD_LINUX_THREAD_NAME_TYPE

thread thread name type

typedef unsigned int DOCA_APSH_THREAD_PID_TYPE

thread pid type

typedef long DOCA_APSH_THREAD_STATE_TYPE

thread state type

typedef unsigned int DOCA_APSH_THREAD_TID_TYPE

thread tid type

typedef uint64_t DOCA_APSH_THREAD_WINDOWS_OFFSET_TYPE

thread offset type

typedef unsigned char DOCA_APSH_THREAD_WINDOWS_WAIT_REASON_TYPE

thread wait reason type

typedef int DOCA_APSH_VADS_LIMIT_TYPE

limit of vads number

typedef doca_dev_rep * DOCA_APSH_VHCA_ID_TYPE

vhca id

typedef char * DOCA_APSH_VMA_FILE_PATH_TYPE

vma file path type

typedef uint64_t DOCA_APSH_VMA_OFFSET_TYPE

vma offset type

typedef unsigned int DOCA_APSH_VMA_PID_TYPE

vma pid type

typedef char * DOCA_APSH_VMA_PROCESS_NAME_TYPE

vma file path type

typedef char * DOCA_APSH_VMA_PROTECTION_TYPE

vma protection type

typedef uint64_t DOCA_APSH_VMA_VM_END_TYPE

vma vm end type

typedef uint64_t DOCA_APSH_VMA_VM_START_TYPE

vma vm start type

typedef int DOCA_APSH_VMA_WINDOWS_COMMIT_CHARGE_TYPE

vma commit charge type

typedef int DOCA_APSH_VMA_WINDOWS_PRIVATE_MEMORY_TYPE

vma private memory type

typedef char * DOCA_APSH_VMA_WINDOWS_TAG_TYPE

vma tag type

typedef int DOCA_APSH_WINDOWS_ENVARS_LIMIT_TYPE

length limit of envars for windows

typedef char * DOCA_APSH_YARA_COMM_TYPE

name of the process

typedef uint64_t DOCA_APSH_YARA_MATCH_WINDOW_ADDR_TYPE

virtual address of the scan window of the match

typedef uint64_t DOCA_APSH_YARA_MATCH_WINDOW_LEN_TYPE

length of the scan window of the match

typedef uint32_t DOCA_APSH_YARA_PID_TYPE

pid of the process

typedef char * DOCA_APSH_YARA_RULE_TYPE

rule name

Enumerations

enum doca_apsh_attestation_attr

Values

DOCA_APSH_ATTESTATION_PID: attestation process id
DOCA_APSH_ATTESTATION_COMM: attestation process name
DOCA_APSH_ATTESTATION_PATH_OF_MEMORY_AREA: attestation path of memory area
DOCA_APSH_ATTESTATION_PROTECTION: attestation protection
DOCA_APSH_ATTESTATION_START_ADDRESS: attestation start address
DOCA_APSH_ATTESTATION_END_ADDRESS: attestation end address
DOCA_APSH_ATTESTATION_PAGES_NUMBER: attestation process pages count in binary file
DOCA_APSH_ATTESTATION_PAGES_PRESENT: attestation pages present in memory
DOCA_APSH_ATTESTATION_MATCHING_HASHES: attestation pages hash match count from pages in memory
DOCA_APSH_ATTESTATION_HASH_DATA_IS_PRESENT: attestation hash data is present

enum doca_apsh_envar_attr

Values

DOCA_APSH_ENVARS_PID: envars pid
DOCA_APSH_ENVARS_COMM: envars process name
DOCA_APSH_ENVARS_VARIABLE: envars variable
DOCA_APSH_ENVARS_VALUE: envars value
DOCA_APSH_ENVARS_WINDOWS_BLOCK = 1000: envars windows environment block address

enum doca_apsh_handle_attr

Values

DOCA_APSH_HANDLE_PID: handle process id
DOCA_APSH_HANDLE_COMM: handle process name
DOCA_APSH_HANDLE_VALUE: handle value
DOCA_APSH_HANDLE_TABLE_ENTRY: handle table entry
DOCA_APSH_HANDLE_TYPE: handle type
DOCA_APSH_HANDLE_ACCESS: handle access
DOCA_APSH_HANDLE_NAME: handle name

enum doca_apsh_ldrmodule_attr

Values

DOCA_APSH_LDRMODULE_PID: ldrmodule process pid
DOCA_APSH_LDRMODULE_COMM: ldrmodule process name
DOCA_APSH_LDRMODULE_BASE_ADDRESS: ldrmodule base address
DOCA_APSH_LDRMODULE_LIBRARY_PATH: ldrmodule loaded library path
DOCA_APSH_LDRMODULE_WINDOWS_BASE_DLL_NAME = 1000: ldrmodule full dll name
DOCA_APSH_LDRMODULE_WINDOWS_SIZE_OF_IMAGE: ldrmodule size of image
DOCA_APSH_LDRMODULE_WINDOWS_INLOAD: ldrmodule appear in inload list
DOCA_APSH_LDRMODULE_WINDOWS_INMEM: ldrmodule appear in inmem list
DOCA_APSH_LDRMODULE_WINDOWS_ININIT: ldrmodule appear in ininit list

enum doca_apsh_lib_attr

Values

DOCA_APSH_LIB_PID: lib pid
DOCA_APSH_LIB_COMM: lib name
DOCA_APSH_LIB_LIBRARY_PATH: lib loaded library path
DOCA_APSH_LIB_LOAD_ADRESS: lib load address for both Windows and Linux
DOCA_APSH_LIB_WINDOWS_FULL_DLL_NAME = 1000: lib full dll name
DOCA_APSH_LIB_WINDOWS_SIZE_OFIMAGE: lib size of image
DOCA_APSH_LIB_LINUX_LOAD_ADRESS = 2000: lib load address for Linux. It's kept for backwards compatibility, use DOCA_APSH_LIB_LOAD_ADRESS instead-

enum doca_apsh_module_attr

Values

DOCA_APSH_MODULES_OFFSET: module offset
DOCA_APSH_MODULES_NAME: module name
DOCA_APSH_MODULES_SIZE: module size

enum doca_apsh_netscan_attr

Values

DOCA_APSH_NETSCAN_PID: netscan process id
DOCA_APSH_NETSCAN_COMM: netscan process name
DOCA_APSH_NETSCAN_PROTOCOL: netscan connection protcol
DOCA_APSH_NETSCAN_LOCAL_ADDR: netscan connection local address
DOCA_APSH_NETSCAN_REMOTE_ADDR: netscan connection remote address
DOCA_APSH_NETSCAN_LOCAL_PORT: netscan connection local port
DOCA_APSH_NETSCAN_REMOTE_PORT: netscan connection remote port
DOCA_APSH_NETSCAN_STATE: netscan connection state
DOCA_APSH_NETSCAN_TIME: netscan connection creation time

enum doca_apsh_privilege_attr

Values

DOCA_APSH_PRIVILEGES_PID: privilege process pid
DOCA_APSH_PRIVILEGES_COMM: privilege process name
DOCA_APSH_PRIVILEGES_NAME: privilege name, for example: SeTcbPrivilege
DOCA_APSH_PRIVILEGES_IS_ON: is the privilege turned on or off. For Windows this is the outcome of get(PRESENT) && (get(ENABLED) || get(DEFAULT))
DOCA_APSH_PRIVILEGES_WINDOWS_PRESENT = 1000: privilege present flag
DOCA_APSH_PRIVILEGES_WINDOWS_ENABLED: privilege enabled flag
DOCA_APSH_PRIVILEGES_WINDOWS_DEFAULT: privilege enabledbydefault flag

enum doca_apsh_process_attr

Values

DOCA_APSH_PROCESS_PID: process id
DOCA_APSH_PROCESS_PPID: process parent id
DOCA_APSH_PROCESS_COMM: process executable name
DOCA_APSH_PROCESS_CPU_TIME: process cpu time [ps]
DOCA_APSH_PROCESS_WINDOWS_OFFSET = 1000: process offset
DOCA_APSH_PROCESS_WINDOWS_THREADS: process thread count
DOCA_APSH_PROCESS_LINUX_GID = 2000: process group id
DOCA_APSH_PROCESS_LINUX_UID: process user id
DOCA_APSH_PROCESS_LINUX_STATE: process state

enum doca_apsh_process_parameters_attr

Values

DOCA_APSH_PROCESS_PARAMETERS_PID: process-parameters pid
DOCA_APSH_PROCESS_PARAMETERS_CMD_LINE: process-parameters command line
DOCA_APSH_PROCESS_PARAMETERS_IMAGE_BASE_ADDR: process-parameters image base address
DOCA_APSH_PROCESS_PARAMETERS_IMAGE_FULL_PATH: process-parameters image full path

enum doca_apsh_sid_attr

Values

DOCA_APSH_PROCESS_SID_PID: SID process id
DOCA_APSH_PROCESS_SID_STRING: SID string
DOCA_APSH_PROCESS_SID_ATTRIBUTES: SID attributes flag

enum doca_apsh_system_config_attr

Values

DOCA_APSH_OS_SYMBOL_MAP: os symbol map path
DOCA_APSH_MEM_REGION: memory region path
DOCA_APSH_KPGD_FILE: kpgd file path
DOCA_APSH_VHCA_ID: vhca id
DOCA_APSH_OS_TYPE: os type
DOCA_APSH_SCAN_WIN_SIZE: yara scan window size
DOCA_APSH_SCAN_WIN_STEP: yara scan window step
DOCA_APSH_HASHTEST_LIMIT: limit of vm areas to attest
DOCA_APSH_MODULES_LIMIT: limit of modules number
DOCA_APSH_PROCESS_LIMIT: limit of processes number
DOCA_APSH_THREADS_LIMIT: limit of threads number
DOCA_APSH_LDRMODULES_LIMIT: limit of ldrmodules number on windows
DOCA_APSH_LIBS_LIMIT: limit of libs number
DOCA_APSH_VADS_LIMIT: limit of vads number
DOCA_APSH_WINDOWS_ENVARS_LIMIT: length limit of envars for windows
DOCA_APSH_HANDLES_LIMIT: limit of handles number on windows
DOCA_APSH_STRING_LIMIT: length limit of apsh_read_str

enum doca_apsh_system_os

Values

DOCA_APSH_SYSTEM_LINUX: linux
DOCA_APSH_SYSTEM_WINDOWS: windows

enum doca_apsh_thread_attr

Values

DOCA_APSH_THREAD_PID: thread process id
DOCA_APSH_THREAD_TID: thread id
DOCA_APSH_THREAD_STATE: thread state
DOCA_APSH_THREAD_WINDOWS_WAIT_REASON = 1000: thread wait reason
DOCA_APSH_THREAD_WINDOWS_OFFSET: thread offset
DOCA_APSH_THREAD_LINUX_PROC_NAME = 2000: thread process name
DOCA_APSH_THREAD_LINUX_THREAD_NAME: thread name

enum doca_apsh_vad_attr

Values

DOCA_APSH_VMA_PID: vma process id
DOCA_APSH_VMA_OFFSET: vma offset
DOCA_APSH_VMA_PROTECTION: vma protection
DOCA_APSH_VMA_VM_START: vma vm start
DOCA_APSH_VMA_VM_END: vma vm end
DOCA_APSH_VMA_PROCESS_NAME: vma process name
DOCA_APSH_VMA_FILE_PATH: vma file path
DOCA_APSH_VMA_WINDOWS_COMMIT_CHARGE = 1000: vma commit charge
DOCA_APSH_VMA_WINDOWS_PRIVATE_MEMORY: vma private memory
DOCA_APSH_VMA_WINDOWS_TAG: vma pool tag

enum doca_apsh_yara_attr

Values

DOCA_APSH_YARA_PID: pid of the process
DOCA_APSH_YARA_COMM: name of the process
DOCA_APSH_YARA_RULE: rule name
DOCA_APSH_YARA_MATCH_WINDOW_ADDR: virtual address of the scan window of the match
DOCA_APSH_YARA_MATCH_WINDOW_LEN: length of the scan window of the match

enum doca_apsh_yara_rule

Values

DOCA_APSH_YARA_RULE_HELLO_WORLD: yara rule that scans for "Hello World". Rule name is "Hello_World".
DOCA_APSH_YARA_RULE_REFLECTIVE_DLL_INJECTION: yara rule that scans for Reflective Dll Injection attack. Rule name is "Reflective_Dll_Injection".
DOCA_APSH_YARA_RULE_MIMIKATZ: yara rule that scans for Mimiaktz process running on the system. Rule name is "Mimikatz".

enum doca_apsh_yara_scan_type

Values

DOCA_APSH_YARA_SCAN_VMA = 1: scan all vma tree, override all others
DOCA_APSH_YARA_SCAN_HEAP = 1<<1: scan heap vads

2.4. Core

Modules

DOCA Buffer

DOCA Buffer Array

DOCA Buffer Inventory

DOCA Bufpool

DOCA Context

DOCA DPDK

DOCA Device

DOCA Error

DOCA Memory Map

DOCA RDMA BRIDGE

DOCA Sync Event

DOCA Types

DOCA Buffer

DOCA Buffer Array

DOCA Buffer Inventory

DOCA Bufpool

DOCA Context

DOCA Device

DOCA DPDK

DOCA Error

DOCA Memory Map

DOCA RDMA BRIDGE

DOCA Sync Event

DOCA Types

2.4.1. DOCA Buffer

[Core]

The DOCA Buffer is used for reference data. It holds the information on a memory region that belongs to a DOCA memory map, and its descriptor is allocated from DOCA Buffer Inventory.

Functions

doca_error_t doca_buf_get_data ( const doca_buf* buf, void** data ): Get the buffer's data.
doca_error_t doca_buf_get_data_len ( const doca_buf* buf, size_t* data_len ): Get buffer's data length.
doca_error_t doca_buf_get_head ( const doca_buf* buf, void** head ): Get the buffer's head.
doca_error_t doca_buf_get_len ( const doca_buf* buf, size_t* len ): Get the buffer's length.
doca_error_t doca_buf_get_refcount ( doca_buf* buf, uint16_t* refcount ): Get the reference count of the object.
doca_error_t doca_buf_is_in_list ( const doca_buf* buf, uint8_t* is_in_list ): Check if provided DOCA Buf is a linked list.
doca_error_t doca_buf_list_chain ( doca_buf* list1, doca_buf* list2 ): Append list2 to list1.
doca_error_t doca_buf_list_is_first ( const doca_buf* buf, bool* is_first ): Check if provided DOCA Buf is the first element in a linked list.
doca_error_t doca_buf_list_is_last ( const doca_buf* buf, bool* is_last ): Check if provided DOCA Buf is the last element in a linked list.
doca_error_t doca_buf_list_last ( doca_buf* buf, doca_buf** last_buf ): Get last DOCA Buf in linked list.
doca_error_t doca_buf_list_next ( doca_buf* buf, doca_buf** next_buf ): Get next DOCA Buf in linked list.
doca_error_t doca_buf_list_num_elements ( const doca_buf* buf, uint32_t* num_elements ): Get the number of the elements in list.
doca_error_t doca_buf_list_unchain ( doca_buf* list1, doca_buf* list2 ): Separate list2 from list1.
doca_error_t doca_buf_refcount_add ( doca_buf* buf, uint16_t* refcount ): Increase the object reference count by 1.
doca_error_t doca_buf_refcount_rm ( doca_buf* buf, uint16_t* refcount ): Decrease the object reference count by 1, if 0 reached, return the element back to the inventory.
doca_error_t doca_buf_reset_data_len ( doca_buf* buf )
doca_error_t doca_buf_set_data ( doca_buf* buf, void* data, size_t data_len )

Functions

doca_error_t doca_buf_get_data ( const doca_buf* buf, void** data )

Get the buffer's data.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
data: The data of the buffer. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_get_data_len ( const doca_buf* buf, size_t* data_len )

Get buffer's data length.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
data_len: The data length of the buffer. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_get_head ( const doca_buf* buf, void** head )

Get the buffer's head.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
head: The head of the buffer. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_get_len ( const doca_buf* buf, size_t* len )

Get the buffer's length.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
len: The length of the buffer. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_get_refcount ( doca_buf* buf, uint16_t* refcount )

Get the reference count of the object.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
refcount: The number of references to the object. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_is_in_list ( const doca_buf* buf, uint8_t* is_in_list )

Check if provided DOCA Buf is a linked list.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
is_in_list: 1 if buf is part of a linked list, 0 if it is not. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_list_chain ( doca_buf* list1, doca_buf* list2 )

Append list2 to list1.

Parameters

list1: DOCA Buf representing list1. MUST NOT BE NULL AND MUST BE HEAD OF LIST.
list2: DOCA Buf representing list2. MUST NOT BE NULL AND MUST BE HEAD OF LIST.

Returns

DOCA_SUCCESS - always.

Description

Before: +----+ +----+ +----+ list1 -> |1 |->|2 |->|3 | +----+ +----+ +----+

+----+ +----+ list2 -> |4 |->|5 | +----+ +----+

After:

+----+ +----+ +----+ +----+ +----+ list1 -> |1 |->|2 |->|3 |->|4 |->|5 | +----+ +----+ +----+ +----+ +----+ / list2

doca_error_t doca_buf_list_is_first ( const doca_buf* buf, bool* is_first )

Check if provided DOCA Buf is the first element in a linked list.

Parameters

buf: DOCA Buf element.
is_first: True if buf is the first element, false if it is not.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_list_is_last ( const doca_buf* buf, bool* is_last )

Check if provided DOCA Buf is the last element in a linked list.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
is_last: True if buf is the last element, false if it is not. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_list_last ( doca_buf* buf, doca_buf** last_buf )

Get last DOCA Buf in linked list.

Parameters

buf: DOCA Buf element.
last_buf: The last DOCA Buf in the linked list, which may be buf.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_buf_list_next ( doca_buf* buf, doca_buf** next_buf )

Get next DOCA Buf in linked list.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
next_buf: The next DOCA Buf in the linked list, *next_buf will be NULL if the no other element in the list. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_list_num_elements ( const doca_buf* buf, uint32_t* num_elements )

Get the number of the elements in list.

Parameters

buf: DOCA Buf element. Buf must be a head of a list.
num_elements: Number of elements in list.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if the buffer is not a head of a list.

Description

doca_error_t doca_buf_list_unchain ( doca_buf* list1, doca_buf* list2 )

Separate list2 from list1.

Parameters

list1: DOCA Buf representing list1. MUST NOT BE NULL.
list2: DOCA Buf representing list2, list2 should be contained in list1. list2 must be different from list1. MUST NOT BE NULL

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if list2 is not part of list1.

Description

Before: +----+ +----+ +----+ +----+ +----+ list1 -> |1 |->|2 |->|3 |->|4 |->|5 | +----+ +----+ +----+ +----+ +----+ / list2

After: +----+ +----+ +----+ list1 -> |1 |->|2 |->|3 | +----+ +----+ +----+

+----+ +----+ list2 -> |4 |->|5 | +----+ +----+

doca_error_t doca_buf_refcount_add ( doca_buf* buf, uint16_t* refcount )

Increase the object reference count by 1.

Parameters

buf: DOCA Buf element.
refcount: The number of references to the object before this operation took place.

Returns

DOCA_ERROR_NOT_SUPPORTED

Description

Note:

This function is not supported yet.

doca_error_t doca_buf_refcount_rm ( doca_buf* buf, uint16_t* refcount )

Decrease the object reference count by 1, if 0 reached, return the element back to the inventory.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
refcount: The number of references to the object before this operation took place. Can be NULL.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_NOT_PERMITTED - buf is the next element in some list.

Description

When refcont 0 reached, all related resources should be released. For example if the element points into some mmap its state will be adjusted accordingly.

doca_error_t doca_buf_reset_data_len ( doca_buf* buf )

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always

Description

Reset the data length to 0 (data will still point to the same location)

__data_len__ / \ +-----+--------------+--------------+ Before | |data | | +-----+--------------+--------------+ / data

data_len = 0 / +-----+-----------------------------+ After | | | +-----+-----------------------------+ / data

doca_error_t doca_buf_set_data ( doca_buf* buf, void* data, size_t data_len )

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
data: Data address. MUST NOT BE NULL.
data_len: Data length.

Returns

DOCA_SUCCESS - always

Description

Set data pointer and data length

+-----------+-----+-----------------+ Before | |data | | +-----------+-----+-----------------+

__data_len__ / \ +-----+--------------+--------------+ After | |data | | +-----+--------------+--------------+ / data

Note:

The range [data, data + data_len] must be in [head, head + len]. Otherwise undefined behaviour.

2.4.2. DOCA Buffer Array

[Core]

The DOCA buffer array represents an array of fixed size doca_bufs (for multiple doca_dev). Can act as a free list or direct access mode.

Functions

doca_error_t doca_buf_arr_create ( doca_mmap* mmap, doca_buf_arr** buf_arr ): Allocates a doca_buf_arr.
doca_error_t doca_buf_arr_destroy ( doca_buf_arr* buf_arr ): Destroys a doca buf array instance.
doca_error_t doca_buf_arr_get_gpu_handle ( const doca_buf_arr* buf_arr, doca_gpu_buf_arr** gpu_buf_arr ): Retrieves the handle in the gpu memory space of a doca_buf_arr.
doca_error_t doca_buf_arr_set_params ( doca_buf_arr* buf_arr, size_t size, uint32_t num_elem, uint32_t start_offset ): Sets the buf array params.
doca_error_t doca_buf_arr_set_target_gpu ( doca_buf_arr* buf_arr, doca_gpu* gpu_handler ): Configures the buf array to be created on the gpu device.
doca_error_t doca_buf_arr_start ( doca_buf_arr* buf_arr ): This method enables the allocation of doca_bufs.
doca_error_t doca_buf_arr_stop ( doca_buf_arr* buf_arr ): Stops a started doca buf array.

Functions

doca_error_t doca_buf_arr_create ( doca_mmap* mmap, doca_buf_arr** buf_arr )

Allocates a doca_buf_arr.

Parameters

mmap: The mmap managing the memory chunk. Must be populated with memory chunk.
buf_arr: The newly created doca_buf_arr.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - failed to allocate a doca_buf_arr.

Description

doca_error_t doca_buf_arr_destroy ( doca_buf_arr* buf_arr )

Destroys a doca buf array instance.

Parameters

buf_arr: The doca_buf_arr to destroy

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_buf_arr_get_gpu_handle ( const doca_buf_arr* buf_arr, doca_gpu_buf_arr** gpu_buf_arr )

Retrieves the handle in the gpu memory space of a doca_buf_arr.

Parameters

buf_arr: The doca_buf_arr
gpu_buf_arr: A pointer to the handle in the gpu memory space

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if doca_buf_arr is not started.

Description

doca_error_t doca_buf_arr_set_params ( doca_buf_arr* buf_arr, size_t size, uint32_t num_elem, uint32_t start_offset )

Sets the buf array params.

Parameters

buf_arr: The doca_buf_arr
size: Size in bytes of a single element (must be > 0).
num_elem: Number of elements in the doca_buf_arr (must be > 0).
start_offset: Offset from mmap start to set doca_buf_arr.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if doca_buf_arr is already started

Description

doca_error_t doca_buf_arr_set_target_gpu ( doca_buf_arr* buf_arr, doca_gpu* gpu_handler )

Configures the buf array to be created on the gpu device.

Parameters

buf_arr: The doca_buf_arr
gpu_handler: The gpu device handler.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if doca_buf_arr is already started

Description

doca_error_t doca_buf_arr_start ( doca_buf_arr* buf_arr )

This method enables the allocation of doca_bufs.

Parameters

buf_arr: The doca_buf_arr to start

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE -
DOCA_ERROR_NOT_PERMITTED - if mmap is not started.
DOCA_ERROR_NO_MEMORY - failed to allocate enough space for configuration structure

Description

Note:

Before calling this function, the mmap with which the buf array was created must be started.

doca_error_t doca_buf_arr_stop ( doca_buf_arr* buf_arr )

Stops a started doca buf array.

Parameters

buf_arr: The doca_buf_arr to stop

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

2.4.3. DOCA Buffer Inventory

[Core]

The DOCA buffer inventory manages a pool of doca_buf objects. Each buffer obtained from an inventory is a descriptor that points to a memory region from a doca_mmap memory range of the user's choice.

Functions

doca_error_t doca_buf_inventory_buf_by_addr ( doca_buf_inventory* inventory, doca_mmap* mmap, void* addr, size_t len, doca_buf** buf ): Allocate single element from buffer inventory and point it to the buffer defined by `addr` & `len` arguments.
doca_error_t doca_buf_inventory_buf_by_args ( doca_buf_inventory* inventory, doca_mmap* mmap, void* addr, size_t len, void* data, size_t data_len, doca_buf** buf ): Allocate single element from buffer inventory and point it to the buffer defined by `addr`, `len`, `data` and `data_len` arguments.
doca_error_t doca_buf_inventory_buf_by_data ( doca_buf_inventory* inventory, doca_mmap* mmap, void* data, size_t data_len, doca_buf** buf ): Allocate single element from buffer inventory and point it to the buffer defined by `data` & `data_len` arguments.
doca_error_t doca_buf_inventory_buf_dup ( doca_buf_inventory* inventory, const doca_buf* src_buf, doca_buf** dst_buf ): Duplicates content of the `buf` argument into element allocated from buffer inventory. (I.e., deep copy).
doca_error_t doca_buf_inventory_create ( const doca_data* user_data, size_t num_elements, uint32_t extensions, doca_buf_inventory** buf_inventory ): Allocates buffer inventory with default/unset attributes.
doca_error_t doca_buf_inventory_destroy ( doca_buf_inventory* inventory ): Destroy buffer inventory structure.
doca_error_t doca_buf_inventory_get_num_elements ( doca_buf_inventory* inventory, uint32_t* num_of_elements ): Read the total number of elements in a DOCA Inventory.
doca_error_t doca_buf_inventory_get_num_free_elements ( doca_buf_inventory* inventory, uint32_t* num_of_free_elements ): Get the total number of free elements in a DOCA Inventory.
doca_error_t doca_buf_inventory_get_user_data ( doca_buf_inventory* inventory, doca_data* user_data ): Get the user_data of a DOCA Inventory.
doca_error_t doca_buf_inventory_start ( doca_buf_inventory* inventory ): Start element retrieval from inventory.
doca_error_t doca_buf_inventory_stop ( doca_buf_inventory* inventory ): Stop element retrieval from inventory.

Functions

doca_error_t doca_buf_inventory_buf_by_addr ( doca_buf_inventory* inventory, doca_mmap* mmap, void* addr, size_t len, doca_buf** buf ) [inline]

Allocate single element from buffer inventory and point it to the buffer defined by `addr` & `len` arguments.

Parameters

inventory: The DOCA Buf inventory. MUST NOT BE NULL AND MUST BE STARTED.
mmap: DOCA memory map structure. MUST NOT BE NULL AND MUST BE STARTED.
addr: The start address of the payload. MUST NOT BE NULL.
len: The length in bytes of the payload.
buf: Doca buf allocated and initialized with args. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if there is no suitable memory range for the given address and length.
DOCA_ERROR_NO_MEMORY - if doca_buf_inventory is empty.

Description

doca_error_t doca_buf_inventory_buf_by_args ( doca_buf_inventory* inventory, doca_mmap* mmap, void* addr, size_t len, void* data, size_t data_len, doca_buf** buf )

Allocate single element from buffer inventory and point it to the buffer defined by `addr`, `len`, `data` and `data_len` arguments.

Parameters

inventory: The DOCA Buf inventory. MUST NOT BE NULL AND MUST BE STARTED.
mmap: DOCA memory map structure. MUST NOT BE NULL AND MUST BE STARTED.
addr: The start address of the buffer. MUST NOT BE NULL.
len: The length in bytes of the buffer.
data: The start address of the data inside the buffer. MUST NOT BE NULL.
data_len: The length in bytes of the data.
buf: Doca buf allocated and initialized with args. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - or if there is no suitable memory range for the given address and length.
DOCA_ERROR_NO_MEMORY - if doca_buf_inventory is empty.

Description

Note:

The range [data, data + data_len] must fit within [addr, addr +len]. Otherwise undefined behaviour.

doca_error_t doca_buf_inventory_buf_by_data ( doca_buf_inventory* inventory, doca_mmap* mmap, void* data, size_t data_len, doca_buf** buf ) [inline]

Allocate single element from buffer inventory and point it to the buffer defined by `data` & `data_len` arguments.

Parameters

inventory: The DOCA Buf inventory. MUST NOT BE NULL AND MUST BE STARTED.
mmap: DOCA memory map structure. MUST NOT BE NULL AND MUST BE STARTED.
data: The start address of the data inside the buffer. MUST NOT BE NULL.
data_len: The length in bytes of the data.
buf: Doca buf allocated and initialized with args. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - or if there is no suitable memory range for the given address and length.
DOCA_ERROR_NO_MEMORY - if doca_buf_inventory is empty.

Description

doca_error_t doca_buf_inventory_buf_dup ( doca_buf_inventory* inventory, const doca_buf* src_buf, doca_buf** dst_buf )

Duplicates content of the `buf` argument into element allocated from buffer inventory. (I.e., deep copy).

Parameters

inventory: Buffer inventory structure that will hold the new doca_buf.
src_buf: The DOCA buf to be duplicated.
dst_buf: A duplicate DOCA Buf.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if src_buf mmap or input inventory unstarted/stopped or src_buf inventory extensions and the input inventory extensions are incompatible.
DOCA_ERROR_NO_MEMORY - if cannot alloc new doca_buf from the given inventory.

Description

doca_error_t doca_buf_inventory_create ( const doca_data* user_data, size_t num_elements, uint32_t extensions, doca_buf_inventory** buf_inventory )

Allocates buffer inventory with default/unset attributes.

Parameters

user_data
num_elements: Initial number of elements in the inventory.
extensions: Bitmap of extensions enabled for the inventory described in doca_buf.h.
buf_inventory: Buffer inventory with default/unset attributes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_buf_inventory.

Description

The returned object can be manipulated with doca_buf_inventory_property_set() API. Once all required attributes are set, it should be reconfigured and adjusted to meet the setting with doca_buf_inventory_start(). See doca_buf_inventory_start for the rest of the details.

doca_error_t doca_buf_inventory_destroy ( doca_buf_inventory* inventory )

Destroy buffer inventory structure.

Parameters

inventory: Buffer inventory structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if not all allocated elements had been returned to the inventory.

Description

Before calling this function all allocated elements should be returned back to the inventory.

doca_error_t doca_buf_inventory_get_num_elements ( doca_buf_inventory* inventory, uint32_t* num_of_elements )

Read the total number of elements in a DOCA Inventory.

Parameters

inventory: The DOCA Buf inventory.
num_of_elements: The total number of elements in inventory.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

The total number of elements type: uint32_t.

doca_error_t doca_buf_inventory_get_num_free_elements ( doca_buf_inventory* inventory, uint32_t* num_of_free_elements )

Get the total number of free elements in a DOCA Inventory.

Parameters

inventory: The DOCA Buf inventory.
num_of_free_elements: The total number of free elements in inventory.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

The total number of free elements type: uint32_t.

doca_error_t doca_buf_inventory_get_user_data ( doca_buf_inventory* inventory, doca_data* user_data )

Get the user_data of a DOCA Inventory.

Parameters

inventory: The DOCA Buf inventory.
user_data: The user_data of inventory.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

The user_data that was provided to the inventory upon its creation.

doca_error_t doca_buf_inventory_start ( doca_buf_inventory* inventory )

Start element retrieval from inventory.

Parameters

inventory: Buffer inventory structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Un-started/stopped buffer inventory rejects all attempts to retrieve element. On first start verifies & finalizes the buffer inventory object configuration.

The following become possible only after start:

Retrieval of free elements from the inventory using doca_buf_inventory_buf_by_addr().
Duplicating a buffer's content into a buffer allocated from the inventory using doca_buf_inventory_buf_dup().

The following are NOT possible after the first time start is called:

Setting the properties of the inventory using doca_buf_inventory_property_set().

doca_error_t doca_buf_inventory_stop ( doca_buf_inventory* inventory )

Stop element retrieval from inventory.

Parameters

inventory: Buffer inventory structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

No retrieval of elements with for stopped inventory. For details see doca_buf_inventory_start().

2.4.4. DOCA Bufpool

[Core]

The DOCA Bufpool is an inventory of doca_buf objects, such that each doca_buf is set with a permanent, fixed size memory buffer, right from creation and till destruction, which allows immediate allocation of doca_buf objects.

Basic structure example of Bufpool (after creation):

+------------------------------------------+ | memory range | +-----------+ | +--------+ +--------+ +--------+ | | doca_mmap |-----------| | buffer | | buffer | | buffer | | +-----------+ | +--------+ +--------+ ..... +--------+ | | \ \ \ | +------------------------------------------+ \ \ \ \ \ \ +--------------------------------------------+ | | | | | +--------------+ | +----------+ +----------+ +----------+ | | doca_bfupool |--------| | doca_buf | | doca_buf | | doca_buf | | +--------------+ | +----------+ +----------+ ....+----------+ | +--------------------------------------------+

Functions

doca_error_t doca_bufpool_buf_alloc ( doca_bufpool* bufpool, doca_buf** buf ): This method acquires a doca_buf from the doca_bufpool, pointing to an allocated empty buffer.
doca_error_t doca_bufpool_create ( const doca_data* user_data, size_t num_elements, uint32_t extensions, size_t element_size, size_t element_alignment, const doca_mmap* mmap, doca_bufpool** bufpool ): Allocates a bufpool and sets it with doca_buf objects that are set in advance with constant memory buffers.
doca_error_t doca_bufpool_destroy ( doca_bufpool* bufpool ): Destroy bufpool structure.
doca_error_t doca_bufpool_get_num_elements ( const doca_bufpool* bufpool, uint32_t* num_of_elements ): Get the number of elements that was set in the creation of a doca_bufpool.
doca_error_t doca_bufpool_get_num_free_elements ( const doca_bufpool* bufpool, uint32_t* num_of_free_elements ): Get the total number of free elements available for allocation in a doca_bufpool.
doca_error_t doca_bufpool_get_user_data ( const doca_bufpool* bufpool, doca_data* user_data ): Get the user_data of a DOCA Bufpool.
doca_error_t doca_bufpool_start ( doca_bufpool* bufpool ): Start DOCA bufpool.
doca_error_t doca_bufpool_stop ( doca_bufpool* bufpool ): Stop a started DOCA bufpool.

Functions

doca_error_t doca_bufpool_buf_alloc ( doca_bufpool* bufpool, doca_buf** buf )

This method acquires a doca_buf from the doca_bufpool, pointing to an allocated empty buffer.

Parameters

bufpool: The DOCA Bufpool from which to acquire a doca_buf, that was set to point to a memory buffer at doca_bufpool_create().
buf: Pointer to the allocated doca_buf.

Description

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if bufpool is un-started/stopped.
DOCA_ERROR_NO_MEMORY - if the bufpool is empty (all doca_bufs are already allocated).

doca_error_t doca_bufpool_create ( const doca_data* user_data, size_t num_elements, uint32_t extensions, size_t element_size, size_t element_alignment, const doca_mmap* mmap, doca_bufpool** bufpool )

Allocates a bufpool and sets it with doca_buf objects that are set in advance with constant memory buffers.

Parameters

user_data
num_elements: Number of elements in the bufpool (must be > 0).
extensions: Bitmap of extensions enabled for the bufpool described in doca_buf.h.
element_size: Size of a single element (must be > 0).
element_alignment: Element alignment requirement (must be a power of 2, can be 0).
mmap: The mmap managing the memory chunk. Must be populated with memory chunk.
bufpool: The newly created DOCA Bufpool.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - failed to allocate a doca_bufpool.
DOCA_ERROR_BAD_STATE - if no memory range was set to mmap.

Description

doca_error_t doca_bufpool_destroy ( doca_bufpool* bufpool )

Destroy bufpool structure.

Parameters

bufpool: The DOCA Bufpool to destroy.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_IN_USE - if not all allocated doca_bufs had been returned to the bufpool.

Description

Before calling this function, all allocated doca_bufs should be returned back to the bufpool.

doca_error_t doca_bufpool_get_num_elements ( const doca_bufpool* bufpool, uint32_t* num_of_elements )

Get the number of elements that was set in the creation of a doca_bufpool.

Parameters

bufpool: The DOCA Bufpool.
num_of_elements: The number of elements that was set in the creation of bufpool.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_bufpool_get_num_free_elements ( const doca_bufpool* bufpool, uint32_t* num_of_free_elements )

Get the total number of free elements available for allocation in a doca_bufpool.

Parameters

bufpool: The DOCA Bufpool.
num_of_free_elements: The total number of free elements in bufpool.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_bufpool_get_user_data ( const doca_bufpool* bufpool, doca_data* user_data )

Get the user_data of a DOCA Bufpool.

Parameters

bufpool: The DOCA Bufpool.
user_data: The user_data of bufpool.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

The user_data that was provided to the bufpool upon its creation.

doca_error_t doca_bufpool_start ( doca_bufpool* bufpool )

Start DOCA bufpool.

Parameters

bufpool: The DOCA Bufpool to start.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if the mmap with which the bufpool was created is not started.

Description

This method enables the allocation of doca_bufs using doca_bufpool_buf_alloc(). Before calling this function, the mmap with which the bufpool was created must be started.

doca_error_t doca_bufpool_stop ( doca_bufpool* bufpool )

Stop a started DOCA bufpool.

Parameters

bufpool: The DOCA Bufpool to stop.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

This method disables the allocation of doca_bufs. Calling this method is also possible if there are allocated doca_bufs.

2.4.5. DOCA Context

[Core]

DOCA CTX is the base class of every data-path library in DOCA. It is a specific library/SDK instance object providing abstract data processing functionality. The library exposes events and/or jobs that manipulate data.

Classes

struct doca_event: Activity completion event.
struct doca_job: Job structure describes request arguments for service provided by context.

Defines

#define DOCA_ACTION_SDK_RANGE 16: Power 2 single SDK/context action type range.

Functions

doca_error_t doca_ctx_dev_add ( doca_ctx* ctx, doca_dev* dev ): Add a device to a DOCA CTX.
doca_error_t doca_ctx_dev_rm ( doca_ctx* ctx, doca_dev* dev ): Remove a device from a context.
doca_error_t doca_ctx_get_event_driven_supported ( doca_ctx* ctx, uint8_t* event_supported ): Check if CTX supports event driven mode.
doca_error_t doca_ctx_get_max_num_ctx ( uint32_t* max_num_ctx ): Get the ctx maximum number of contexts allowed within an application.
doca_error_t doca_ctx_set_datapath_on_gpu ( doca_ctx* ctx, doca_gpu* gpu_dev ): This function binds the DOCA context to a gpu device.
doca_error_t doca_ctx_start ( doca_ctx* ctx ): Finalizes all configurations, and starts the DOCA CTX.
doca_error_t doca_ctx_stop ( doca_ctx* ctx ): Stops the context allowing reconfiguration.
doca_error_t doca_ctx_workq_add ( doca_ctx* ctx, doca_workq* workq ): Add a workQ to a context.
doca_error_t doca_ctx_workq_rm ( doca_ctx* ctx, doca_workq* workq ): Remove a DOCA WorkQ from a DOCA CTX.
doca_error_t doca_workq_create ( uint32_t depth, doca_workq** workq ): Creates empty DOCA WorkQ object with default attributes.
doca_error_t doca_workq_destroy ( doca_workq* workq ): Destroy a DOCA WorkQ.
doca_error_t doca_workq_event_handle_arm ( doca_workq* workq ): Arm the WorkQ to receive next completion event.
doca_error_t doca_workq_event_handle_clear ( doca_workq* workq, doca_event_handle_t handle ): Clear triggered events.
doca_error_t doca_workq_get_depth ( const doca_workq* workq, uint32_t* depth ): Get the maximum number of inflight jobs allowed for a DOCA workq.
doca_error_t doca_workq_get_event_driven_enable ( doca_workq* workq, uint8_t* enabled ): Check if WorkQ event-driven mode is enabled.
doca_error_t doca_workq_get_event_handle ( doca_workq* workq, doca_event_handle_t* handle ): Get the event handle for waiting on events.
doca_error_t doca_workq_progress_retrieve ( doca_workq* workq, doca_event* ev, int flags ): Progress & retrieve single pending event.
doca_error_t doca_workq_set_event_driven_enable ( doca_workq* workq, uint8_t enable ): Enable WorkQ event-driven mode.
doca_error_t doca_workq_set_event_handle ( doca_workq* workq, doca_event_handle_t event_handle, uintptr_t completion_key ): Set event handle This method is supported only for Windows. Windows uses io completion port that is created by the application and passed to the work queue. The work queue Uses the io completion port to register events.
doca_error_t doca_workq_submit ( doca_workq* workq, doca_job* job ): Submit a job to a DOCA WorkQ.

Defines

#define DOCA_ACTION_SDK_RANGE 16

Functions

doca_error_t doca_ctx_dev_add ( doca_ctx* ctx, doca_dev* dev )

Add a device to a DOCA CTX.

Parameters

ctx: The CTX to add the device to.
dev: The device to add.

Returns

DOCA_SUCCESS - In case of success. Error code - On failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - CTX is started.
DOCA_ERROR_IN_USE - the device was already added.
DOCA_ERROR_NOT_SUPPORTED - the provided device is not supported by CTX, I.e., the device is not useful for any job, missing the capabilities, or was opened using doca_dev_open_from_pd().
DOCA_ERROR_DRIVER - failed to interact with device.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

doca_error_t doca_ctx_dev_rm ( doca_ctx* ctx, doca_dev* dev )

Remove a device from a context.

Parameters

ctx: The CTX to remove the device from. Must already hold the device.
dev: The device to remove.

Returns

DOCA_SUCCESS - In case of success. Error code - On failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - CTX is started.
DOCA_ERROR_NOT_FOUND - the provided device was never added to the ctx or was already removed.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

doca_error_t doca_ctx_get_event_driven_supported ( doca_ctx* ctx, uint8_t* event_supported )

Check if CTX supports event driven mode.

Parameters

ctx: The library instance containing the WorkQ.
event_supported: Boolean indicating whether event driven mode is supported.

Returns

DOCA_SUCCESS - In case of success. Error code - on failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

In case the support exists, then this CTX can be added to WorkQ operating in event driven mode.

doca_error_t doca_ctx_get_max_num_ctx ( uint32_t* max_num_ctx )

Get the ctx maximum number of contexts allowed within an application.

Parameters

max_num_ctx: The ctx max number of contexts allowed within an application.

Returns

DOCA_SUCCESS - in case max_num_ctx received the required value properly. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - max_num_ctx is NULL.

Description

doca_error_t doca_ctx_set_datapath_on_gpu ( doca_ctx* ctx, doca_gpu* gpu_dev )

This function binds the DOCA context to a gpu device.

Parameters

ctx: The library instance.
gpu_dev: A pointer to a doca_gpu device.

Returns

DOCA_SUCCESS - In case of success. Error code - on failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - CTX is started.

Description

The data path will be executed on the device and not on the CPU.

doca_error_t doca_ctx_start ( doca_ctx* ctx )

Finalizes all configurations, and starts the DOCA CTX.

Parameters

ctx: The DOCA context to start.

Returns

DOCA_SUCCESS - In case of success. Error code - In case of failure:

DOCA_ERROR_INVALID_VALUE - either an invalid input was received or no devices were added to the CTX.
DOCA_ERROR_NOT_SUPPORTED - one of the provided devices is not supported by CTX.
DOCA_ERROR_INITIALIZATION - resource initialization failed (could be due to allocation failure), or the device is in a bad state or another reason caused initialization to fail.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

After starting the CTX, it can't be configured any further. Use doca_ctx_stop in order to reconfigure the CTX.

The following become possible only after start:

Adding WorkQ to CTX using doca_ctx_workq_add()
Removing WorkQ from CTX using doca_ctx_workq_rm()
Submitting a job using doca_workq_submit()

The following are NOT possible after start and become possible again after calling doca_ctx_stop:

Adding device to CTX using doca_ctx_dev_add()
Removing device from CTX using doca_ctx_dev_rm()
Binding gpu device to CTX using doca_ctx_set_datapath_on_gpu()

doca_error_t doca_ctx_stop ( doca_ctx* ctx )

Stops the context allowing reconfiguration.

Parameters

ctx: The DOCA context to stop.

Returns

DOCA_SUCCESS - In case of success. Error code - In case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_PERMITTED - either some jobs are still pending or not all WorkQs have been removed.
DOCA_ERROR_IN_USE - some workqs are still associated with the ctx.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

Once a context has started, it can't be configured any further. This method should be called in case the context needs to be configured after starting. For more details see doca_ctx_start().

doca_error_t doca_ctx_workq_add ( doca_ctx* ctx, doca_workq* workq )

Add a workQ to a context.

Parameters

ctx: The library instance that will handle the jobs.
workq: The WorkQ where you want to receive job completions.

Returns

DOCA_SUCCESS - In case of success. Error code - on failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - CTX is not started.
DOCA_ERROR_IN_USE - same WorkQ already added.
DOCA_ERROR_NO_MEMORY - memory allocation failed.
DOCA_ERROR_INITIALIZATION - initialization of WorkQ failed.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

This method adds a WorkQ to a context. Once a WorkQ has been added it will start accepting jobs defined by the CTX & retrieve events from the CTX. The jobs can be progressed using doca_workq_progress_retrieve().

doca_error_t doca_ctx_workq_rm ( doca_ctx* ctx, doca_workq* workq )

Remove a DOCA WorkQ from a DOCA CTX.

Parameters

ctx: The library instance containing the WorkQ.
workq: The WorkQ to remove.

Returns

DOCA_SUCCESS - In case of success. Error code - on failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - CTX is not started.
DOCA_ERROR_NOT_PERMITTED - some jobs are still pending completion.
DOCA_ERROR_NOT_FOUND - WorkQ does not exist within CTX.
DOCA_ERROR_IN_USE - WorkQ contains inflight jobs.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

This function can only be used after CTX is started (doca_ctx_start()).

doca_error_t doca_workq_create ( uint32_t depth, doca_workq** workq )

Creates empty DOCA WorkQ object with default attributes.

Parameters

depth: The maximum number of inflight jobs.
workq: The newly created WorkQ.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - invalid input received.
DOCA_ERROR_NO_MEMORY - failed to allocate WorkQ.

Description

The returned WorkQ needs to be added to at least one DOCA CTX. Then the WorkQ can be used to progress jobs and to poll events exposed by the associated CTX.

doca_error_t doca_workq_destroy ( doca_workq* workq )

Destroy a DOCA WorkQ.

Parameters

workq: The WorkQ to destroy.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - invalid input received.
DOCA_ERROR_IN_USE - WorkQ not removed from one of the doca_ctx.

Description

In order to destroy a WorkQ, at first needs to be removed from all DOCA CTXs using it.

doca_error_t doca_workq_event_handle_arm ( doca_workq* workq )

Arm the WorkQ to receive next completion event.

Parameters

workq: The WorkQ object to arm. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - workq has been successfully armed, event handle can be used to wait on events.

Description

This method should be used before waiting on the event handle. The expected flow is as follows: 1. Enable event driven mode using doca_workq_set_event_driven_enable(). 2. Get event handle using doca_workq_get_event_handle(). 3. Arm the workq. 4. Wait for an event using the event handle. E.g., using epoll_wait(). 5. Once the thread wakes up, call doca_workq_event_handle_clear(). 6. Call doca_workq_progress_retrieve() until an event is retrieved. 7. Repeat 3.

Note:

event driven mode must be active by using doca_workq_set_event_driven_enable(). Otherwise undefined behaviour.

doca_error_t doca_workq_event_handle_clear ( doca_workq* workq, doca_event_handle_t handle )

Clear triggered events.

Parameters

workq: The WorkQ object that received the events. MUST NOT BE NULL.
handle: workq event handle.

Returns

DOCA_SUCCESS - on successfuly clearing triggered events.
DOCA_ERROR_OPERATING_SYSTEM - a system call has failed.

Description

Method used for clearing of events, this method should be called after an event has been received using the event handle. After this is called, the events will no longer be triggered, and the handle can be armed again. See doca_workq_event_handle_arm() for entire flow.

Note:

event driven mode must be active by using doca_workq_set_event_driven_enable(). Otherwise undefined behaviour.

doca_error_t doca_workq_get_depth ( const doca_workq* workq, uint32_t* depth )

Get the maximum number of inflight jobs allowed for a DOCA workq.

Parameters

workq: The DOCA WorkQ.
depth: The maximum number of inflight jobs allowed for workq.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_workq_get_event_driven_enable ( doca_workq* workq, uint8_t* enabled )

Check if WorkQ event-driven mode is enabled.

Parameters

workq: The WorkQ to query.
enabled: 0 or 1 indicating if event-driven mode is enabled.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Event-driven mode is not enabled by default. It is possible to enable it by setting this porperty to 1. Using doca_workq_set_event_driven_enable()

doca_error_t doca_workq_get_event_handle ( doca_workq* workq, doca_event_handle_t* handle )

Get the event handle for waiting on events.

Parameters

workq: The WorkQ to query.
handle: The event handle of the WorkQ.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - event driven mode is not enabled. Try doca_workq_set_event_driven_enable().

Description

Calling this for the first time will enable event-driven mode for the WorkQ. Retrieves the event handle of the WorkQ, the handle does not change throughout the lifecycle of the WorkQ.

doca_error_t doca_workq_progress_retrieve ( doca_workq* workq, doca_event* ev, int flags )

Progress & retrieve single pending event.

Parameters

workq: The WorkQ object to poll for events. MUST NOT BE NULL.
ev: Event structure to be filled in case an event was received. MUST NOT BE NULL
flags: Flags for progress/retrival operations. A combination of enum doca_workq_retrieve_flags.

Returns

DOCA_SUCCESS - on successful event retrieval. ev output argument is set.
DOCA_ERROR_AGAIN - no event available (ev output argument not set), try again to make more progress.
DOCA_ERROR_IO_FAILED - the retrieved event is a failure event. The specific error is reported per action type.

Description

Polling method for progress of submitted jobs and retrieval of events.

NOTE: for V1 retrieve supported for single event only.

doca_error_t doca_workq_set_event_driven_enable ( doca_workq* workq, uint8_t enable )

Enable WorkQ event-driven mode.

Parameters

workq: The WorkQ to query.
enable: 0 or 1 indicating whether to enable event-driven mode or not.

Returns

DOCA_SUCCESS - in case event driven mode has been set, or is already set to same value. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - workq is still added to at least 1 CTX.
DOCA_ERROR_OPERATING_SYSTEM - a system call has failed.

Description

Event-driven mode is not enabled by default. Once enabled, the doca_workq_handle_* APIs can be used in order to wait on events. This mode can only be enabled before adding the WorkQ to any CTX.

doca_error_t doca_workq_set_event_handle ( doca_workq* workq, doca_event_handle_t event_handle, uintptr_t completion_key )

Set event handle This method is supported only for Windows. Windows uses io completion port that is created by the application and passed to the work queue. The work queue Uses the io completion port to register events.

Parameters

workq: The work queue to set
event_handle: The IO completion port to register to
completion_key: Completion key facilitates finding the source of the event.

Returns

DOCA_SUCCESS - in case event driven mode has been set, or is already set to same value. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - used in non Windows OS.
DOCA_ERROR_OPERATING_SYSTEM - a system call has failed.

Description

doca_error_t doca_workq_submit ( doca_workq* workq, doca_job* job )

Submit a job to a DOCA WorkQ.

Parameters

workq: The DOCA WorkQ used for progress and retrieval of jobs. MUST NOT BE NULL.
job: The job to submit, the job must be compatible with the WorkQ. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case the job was submitted successfully, doca_workq_progress_retrieve() can be called next. Error code - in case of failure:

DOCA_ERROR_BAD_STATE - in case job->ctx is stopped.
DOCA_ERROR_NOT_FOUND - in case the ctx is not associated to the workQ.
DOCA_ERROR_NO_MEMORY - in case the workQ is full. Maximum number of inflight jobs.

Description

This method is used to submit a job to the WorkQ. The WorkQ should be added to the job->ctx via doca_ctx_workq_add() before job submission. Once a job has been submitted, it can be progressed using doca_workq_progress_retrieve() until the result is ready and retrieved.

Note:

job->ctx must not be NULL, must be started and associated with the workq. Otherwise undefined behaviour.

2.4.6. DOCA Device

[Core]

The DOCA device represents an available processing unit backed by the HW or SW implementation.

Defines

#define DOCA_DEVINFO_PCI_ADDR_SIZE 13: Format: "XXXX:XX:XX.X". Including a null terminator.
#define DOCA_DEVINFO_PCI_BDF_SIZE 8: Format: "XX:XX.X". Including a null terminator.
#define DOCA_DEVINFO_REP_PCI_ADDR_SIZE 13: Format: "XXXX:XX:XX.X". Including a null terminator.
#define DOCA_DEVINFO_REP_PCI_BDF_SIZE 8: Format: "XX:XX.X". Including a null terminator.

Enumerations

enum doca_dev_rep_filter

Functions

__DOCA_EXPERIMENTAL doca_devinfo* doca_dev_as_devinfo ( const doca_dev* dev ): Get local device info from device. This should be useful when wanting to query information about device after opening it, and destroying the devinfo list.
doca_error_t doca_dev_close ( doca_dev* dev ): Destroy allocated local device instance.
doca_error_t doca_dev_open ( doca_devinfo* devinfo, doca_dev** dev ): Initialize local device for use.
__DOCA_EXPERIMENTAL doca_devinfo_rep* doca_dev_rep_as_devinfo ( doca_dev_rep* dev_rep ): Get representor device info from device. This should be useful when wanting to query information about device after opening it, and destroying the devinfo list.
doca_error_t doca_dev_rep_close ( doca_dev_rep* dev ): Destroy allocated representor device instance.
doca_error_t doca_dev_rep_open ( doca_devinfo_rep* devinfo, doca_dev_rep** dev_rep ): Initialize representor device for use.
doca_error_t doca_devinfo_get_ibdev_name ( const doca_devinfo* devinfo, char* ibdev_name, uint32_t size ): Get the name of the IB device represented by a DOCA devinfo.
doca_error_t doca_devinfo_get_iface_name ( const doca_devinfo* devinfo, char* iface_name, uint32_t size ): Get the name of the ethernet interface of a DOCA devinfo.
doca_error_t doca_devinfo_get_ipv4_addr ( const doca_devinfo* devinfo, uint8_t* ipv4_addr, uint32_t size ): Get the IPv4 address of a DOCA devinfo.
doca_error_t doca_devinfo_get_ipv6_addr ( const doca_devinfo* devinfo, uint8_t* ipv6_addr, uint32_t size ): Get the IPv6 address of a DOCA devinfo.
doca_error_t doca_devinfo_get_is_hotplug_manager_supported ( const doca_devinfo* devinfo, uint8_t* is_hotplug_manager ): Get the hotplug manager capability of a DOCA devinfo.
doca_error_t doca_devinfo_get_is_mmap_export_dpu_supported ( const doca_devinfo* devinfo, uint8_t* mmap_export ): Get the mmap export to DPU capability of the device.
doca_error_t doca_devinfo_get_is_mmap_from_export_dpu_supported ( const doca_devinfo* devinfo, uint8_t* from_export ): Get the mmap create from export DPU capability of the device.
doca_error_t doca_devinfo_get_is_pci_addr_equal ( const doca_devinfo* devinfo, const char* pci_addr_str, uint8_t* is_equal ): Check if a PCI address belongs to a DOCA devinfo.
doca_error_t doca_devinfo_get_lid ( const doca_devinfo* devinfo, uint16_t* lid ): Get the port LID of a DOCA devinfo.
doca_error_t doca_devinfo_get_mac_addr ( const doca_devinfo* devinfo, uint8_t* mac_addr, uint32_t size ): Get the MAC address of a DOCA devinfo.
doca_error_t doca_devinfo_get_pci_addr_str ( const doca_devinfo* devinfo, char* pci_addr_str ): Get the PCI address of a DOCA devinfo.
doca_error_t doca_devinfo_list_create ( doca_devinfo*** dev_list, uint32_t* nb_devs ): Creates list of all available local devices.
doca_error_t doca_devinfo_list_destroy ( doca_devinfo** dev_list ): Destroy list of local device info structures.
doca_error_t doca_devinfo_rep_get_is_list_all_supported ( const doca_devinfo* devinfo, uint8_t* all_supported ): Get the representor devices discovery capability of the device.
doca_error_t doca_devinfo_rep_get_is_list_emulated_supported ( const doca_devinfo* devinfo, uint8_t* emulated_supported ): Get the remote emulated device discovery capability of the device.
doca_error_t doca_devinfo_rep_get_is_list_net_supported ( const doca_devinfo* devinfo, uint8_t* net_supported ): Get the remote net discovery capability of the device.
doca_error_t doca_devinfo_rep_get_is_pci_addr_equal ( const doca_devinfo_rep* devinfo_rep, const char* pci_addr_str, uint8_t* is_equal ): Check if a PCI address belongs to a DOCA devinfo_rep.
doca_error_t doca_devinfo_rep_get_pci_addr_str ( const doca_devinfo_rep* devinfo_rep, char* pci_addr_str ): Get the PCI address of a DOCA devinfo_rep.
doca_error_t doca_devinfo_rep_get_pci_func_type ( const doca_devinfo_rep* devinfo_rep, doca_pci_func_type ** pci_func_type ): Get the PCI function type of a DOCA devinfo_rep.
doca_error_t doca_devinfo_rep_get_vuid ( const doca_devinfo_rep* devinfo_rep, char* rep_vuid, uint32_t size ): Get the Vendor Unique ID of a representor DOCA devinfo.
doca_error_t doca_devinfo_rep_list_create ( doca_dev* dev, int filter, doca_devinfo_rep*** dev_list_rep, uint32_t* nb_devs_rep ): Create list of available representor devices accessible by dev.
doca_error_t doca_devinfo_rep_list_destroy ( doca_devinfo_rep** dev_list_rep ): Destroy list of representor device info structures.

Defines

#define DOCA_DEVINFO_PCI_ADDR_SIZE 13
#define DOCA_DEVINFO_PCI_BDF_SIZE 8
#define DOCA_DEVINFO_REP_PCI_ADDR_SIZE 13
#define DOCA_DEVINFO_REP_PCI_BDF_SIZE 8

Enumerations

enum doca_dev_rep_filter

Representor device filter by flavor

Multiple options possible but some are mutually exclusive.

Values

DOCA_DEV_REP_FILTER_ALL = 0
DOCA_DEV_REP_FILTER_NET = 1<<1
DOCA_DEV_REP_FILTER_EMULATED = 1<<2

Functions

__DOCA_EXPERIMENTAL doca_devinfo* doca_dev_as_devinfo ( const doca_dev* dev )

Get local device info from device. This should be useful when wanting to query information about device after opening it, and destroying the devinfo list.

Parameters

dev: The doca device instance.

Returns

The matching doca_devinfo instance in case of success, NULL in case dev is invalid or was created by doca_dev_open_from_pd().

Description

doca_error_t doca_dev_close ( doca_dev* dev )

Destroy allocated local device instance.

Parameters

dev: The local doca device instance.

Returns

DOCA_SUCCESS - in case of success.

DOCA_ERROR_IN_USE - failed to deallocate device resources.

Description

doca_error_t doca_dev_open ( doca_devinfo* devinfo, doca_dev** dev )

Initialize local device for use.

Parameters

devinfo: The devinfo structure of the requested device.
dev: Initialized local doca device instance on success. Valid on success only.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - failed to allocate protection domain for device.
DOCA_ERROR_NOT_CONNECTED - failed to open device.
DOCA_ERROR_INITIALIZATION - maximum number of open devices was exceeded.

Description

Note:

In case the same device was previously opened, then the same doca_dev instance is returned.

__DOCA_EXPERIMENTAL doca_devinfo_rep* doca_dev_rep_as_devinfo ( doca_dev_rep* dev_rep )

Get representor device info from device. This should be useful when wanting to query information about device after opening it, and destroying the devinfo list.

Parameters

dev_rep: The representor doca device instance.

Returns

The matching doca_devinfo_rep instance in case of success, NULL in case dev_rep is invalid.

Description

doca_error_t doca_dev_rep_close ( doca_dev_rep* dev )

Destroy allocated representor device instance.

Parameters

dev: The representor doca device instance.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - failed to deallocate device resources.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

doca_error_t doca_dev_rep_open ( doca_devinfo_rep* devinfo, doca_dev_rep** dev_rep )

Initialize representor device for use.

Parameters

devinfo: The devinfo structure of the requested device.
dev_rep: Initialized representor doca device instance on success. Valid on success only.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - failed to allocate memory for device.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

doca_error_t doca_devinfo_get_ibdev_name ( const doca_devinfo* devinfo, char* ibdev_name, uint32_t size )

Get the name of the IB device represented by a DOCA devinfo.

Parameters

devinfo: The device to query.
ibdev_name: The name of the IB device represented by devinfo.
size: The size of the input ibdev_name buffer, must be at least DOCA_DEVINFO_IBDEV_NAME_SIZE which includes the null terminating byte.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

The name of the IB device type: char[DOCA_DEVINFO_IBDEV_NAME_SIZE].

doca_error_t doca_devinfo_get_iface_name ( const doca_devinfo* devinfo, char* iface_name, uint32_t size )

Get the name of the ethernet interface of a DOCA devinfo.

Parameters

devinfo: The device to query.
iface_name: The name of the ethernet interface of devinfo.
size: The size of the input iface_name buffer, must be at least DOCA_DEVINFO_IFACE_NAME_SIZE which includes the null terminating byte.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the interface name from the OS

Description

The name of the ethernet interface is the same as it's name in ifconfig. The name of the ethernet interface type: char[DOCA_DEVINFO_IFACE_NAME_SIZE].

doca_error_t doca_devinfo_get_ipv4_addr ( const doca_devinfo* devinfo, uint8_t* ipv4_addr, uint32_t size )

Get the IPv4 address of a DOCA devinfo.

Parameters

devinfo: The device to query.
ipv4_addr: The IPv4 address of devinfo.
size: The size of the input ipv4_addr buffer, must be at least DOCA_DEVINFO_IPV4_ADDR_SIZE

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the IPv4 address from the OS

Description

The IPv4 address type: uint8_t[DOCA_DEVINFO_IPV4_ADDR_SIZE].

doca_error_t doca_devinfo_get_ipv6_addr ( const doca_devinfo* devinfo, uint8_t* ipv6_addr, uint32_t size )

Get the IPv6 address of a DOCA devinfo.

Parameters

devinfo: The device to query.
ipv6_addr: The IPv6 address of devinfo.
size: The size of the input ipv6_addr buffer, must be at least DOCA_DEVINFO_IPV6_ADDR_SIZE

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the IPv6 address from the OS

Description

The IPv6 address type: uint8_t[DOCA_DEVINFO_IPV6_ADDR_SIZE].

doca_error_t doca_devinfo_get_is_hotplug_manager_supported ( const doca_devinfo* devinfo, uint8_t* is_hotplug_manager )

Get the hotplug manager capability of a DOCA devinfo.

Parameters

devinfo: The device to query.
is_hotplug_manager: 1 if the hotplug manager capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

The hotplug manager property type: uint8_t*.

doca_error_t doca_devinfo_get_is_mmap_export_dpu_supported ( const doca_devinfo* devinfo, uint8_t* mmap_export )

Get the mmap export to DPU capability of the device.

Parameters

devinfo: The device to query.
mmap_export: 1 if the mmap export capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

Get uint8_t value defining if the device can be used to export an mmap. See doca_mmap_export_dpu() in doca_mmap.h true - device can be used with the mmap export API. false - export API is guaranteed to faile with DOCA_ERROR_NOT_SUPPORTED.

doca_error_t doca_devinfo_get_is_mmap_from_export_dpu_supported ( const doca_devinfo* devinfo, uint8_t* from_export )

Get the mmap create from export DPU capability of the device.

Parameters

devinfo: The device to query.
from_export: 1 if the mmap from export DPU capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

Get uint8_t value defining if the device can be used to create an mmap from an exported mmap where the exported mmap was created using doca_mmap_export_dpu(). See doca_mmap_create_from_export() in doca_mmap.h true - device can be used with the mmap create from export API. false - create from export API is guaranteed to fail with DOCA_ERROR_NOT_SUPPORTED.

doca_error_t doca_devinfo_get_is_pci_addr_equal ( const doca_devinfo* devinfo, const char* pci_addr_str, uint8_t* is_equal )

Check if a PCI address belongs to a DOCA devinfo.

Parameters

devinfo

The device to query.

pci_addr_str

The PCI address to check, should be as one of the following formats:

"Domain:Bus:Device.Function", e.g., "0000:83:00.0" (size DOCA_DEVINFO_PCI_ADDR_SIZE including a null terminator).
"Bus:Device.Function", e.g., "83:00.0" (size DOCA_DEVINFO_PCI_BDF_SIZE including a null terminator).

is_equal

1 if pci_addr_str belongs to devinfo, 0 otherwise. In case of an error, no certain value is guaranteed.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the actual PCI address from the OS for comparison.

Description

doca_error_t doca_devinfo_get_lid ( const doca_devinfo* devinfo, uint16_t* lid )

Get the port LID of a DOCA devinfo.

Parameters

devinfo: The device to query.
lid: The port LID of devinfo.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query port LID.
DOCA_ERROR_NOT_SUPPORTED - the device port's link layer is not IB.

Description

The port LID type: uint16_t *.

doca_error_t doca_devinfo_get_mac_addr ( const doca_devinfo* devinfo, uint8_t* mac_addr, uint32_t size )

Get the MAC address of a DOCA devinfo.

Parameters

devinfo: The device to query.
mac_addr: The MAC address of devinfo.
size: The size of the input mac_addr buffer, must be at least DOCA_DEVINFO_MAC_ADDR_SIZE

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - the device port's link layer is not RoCE.

Description

The MAC address type: uint8_t[DOCA_DEVINFO_MAC_ADDR_SIZE].

doca_error_t doca_devinfo_get_pci_addr_str ( const doca_devinfo* devinfo, char* pci_addr_str )

Get the PCI address of a DOCA devinfo.

Parameters

devinfo: The device to query.
pci_addr_str: The PCI address of devinfo, should be of size DOCA_DEVINFO_PCI_ADDR_SIZE at least.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the PCI address from the OS

Description

The PCI address string format is "Domain:Bus:Device.Function", e.g., "0000:83:00.0".

doca_error_t doca_devinfo_list_create ( doca_devinfo*** dev_list, uint32_t* nb_devs )

Creates list of all available local devices.

Parameters

dev_list: Pointer to array of pointers. Output can then be accessed as follows (*dev_list)[idx].
nb_devs: Number of available local devices.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - failed to allocate enough space.
DOCA_ERROR_NOT_FOUND - failed to get RDMA devices list

Description

Lists information about available devices, to start using the device you first have to call doca_dev_open(), while passing an element of this list. List elements become invalid once it has been destroyed.

Note:

Returned list must be destroyed using doca_devinfo_list_destroy()

doca_error_t doca_devinfo_list_destroy ( doca_devinfo** dev_list )

Destroy list of local device info structures.

Parameters

dev_list: List to be destroyed.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - at least one device in the list is in a corrupted state.

Description

Destroys the list of device information, once the list has been destroyed, all elements become invalid.

doca_error_t doca_devinfo_rep_get_is_list_all_supported ( const doca_devinfo* devinfo, uint8_t* all_supported )

Get the representor devices discovery capability of the device.

Parameters

devinfo: The device to query.
all_supported: 1 if the rep list all capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

Get uint8_t value defining if the device can be used to create list of representor devices. In case true is returned, then this device supports at least one representor type. See doca_devinfo_rep_list_create(). true - device can be used with the remote list create API with filter DOCA_DEV_REP_FILTER_ALL. false - providing DOCA_DEV_REP_FILTER_ALL is guaranteed to fail with DOCA_ERROR_NOT_SUPPORTED.

doca_error_t doca_devinfo_rep_get_is_list_emulated_supported ( const doca_devinfo* devinfo, uint8_t* emulated_supported )

Get the remote emulated device discovery capability of the device.

Parameters

devinfo: The device to query.
emulated_supported: 1 if the list emulated capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

Get uint8_t value defining if the device can be used to create list of emulated representor devices. See doca_devinfo_rep_list_create(). true - device can be used with the remote list create API with filter DOCA_DEV_REP_FILTER_EMULATED. false - providing DOCA_DEV_REP_FILTER_EMULATED is guaranteed to fail with DOCA_ERROR_NOT_SUPPORTED.

doca_error_t doca_devinfo_rep_get_is_list_net_supported ( const doca_devinfo* devinfo, uint8_t* net_supported )

Get the remote net discovery capability of the device.

Parameters

devinfo: The device to query.
net_supported: 1 if the rep list net capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

Get uint8_t value defining if the device can be used to create list of net remote devices. See doca_devinfo_remote_list_create(). true - device can be used with the remote list create API with filter DOCA_DEV_REMOTE_FILTER_NET. false - providing DOCA_DEV_REMOTE_FILTER_NET is guaranteed to fail with DOCA_ERROR_NOT_SUPPORTED.

doca_error_t doca_devinfo_rep_get_is_pci_addr_equal ( const doca_devinfo_rep* devinfo_rep, const char* pci_addr_str, uint8_t* is_equal )

Check if a PCI address belongs to a DOCA devinfo_rep.

Parameters

devinfo_rep

The representor of device to query.

pci_addr_str

The PCI address to check, should be as one of the following formats:

"Domain:Bus:Device.Function", e.g., "0000:83:00.0" (size DOCA_DEVINFO_PCI_ADDR_SIZE including a null terminator).
"Bus:Device.Function", e.g., "83:00.0" (size DOCA_DEVINFO_PCI_BDF_SIZE including a null terminator).

is_equal

1 if pci_addr_str belongs to devinfo_rep, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()
DOCA_ERROR_NO_MEMORY - not enough memory to generate devinfo_rep PCI address for comparison.
DOCA_ERROR_UNEXPECTED - an unexpected error occurred.

Description

doca_error_t doca_devinfo_rep_get_pci_addr_str ( const doca_devinfo_rep* devinfo_rep, char* pci_addr_str )

Get the PCI address of a DOCA devinfo_rep.

Parameters

devinfo_rep: The device to query.
pci_addr_str: The PCI address of devinfo_rep, should be of size DOCA_DEVINFO_REP_PCI_ADDR_SIZE at least.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()
DOCA_ERROR_NO_MEMORY - not enough memory to generate the stringed PCI address.
DOCA_ERROR_UNEXPECTED - an unexpected error occurred.

Description

The PCI address string format is "Domain:Bus:Device.Function", e.g., "0000:83:00.0".

doca_error_t doca_devinfo_rep_get_pci_func_type ( const doca_devinfo_rep* devinfo_rep, doca_pci_func_type ** pci_func_type )

Get the PCI function type of a DOCA devinfo_rep.

Parameters

devinfo_rep: The representor of device to query.
pci_func_type: The PCI function type of the devinfo_rep.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

The pci function type: enum doca_pci_func_type.

doca_error_t doca_devinfo_rep_get_vuid ( const doca_devinfo_rep* devinfo_rep, char* rep_vuid, uint32_t size )

Get the Vendor Unique ID of a representor DOCA devinfo.

Parameters

devinfo_rep: The representor device to query.
rep_vuid: The Vendor Unique ID of devinfo_rep.
size: The size of the vuid buffer, including the terminating null byte ('').

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

The Vendor Unique ID is used as stable ID of a VF/PF. The Vendor Unique ID type: char[DOCA_DEVINFO_VUID_SIZE].

doca_error_t doca_devinfo_rep_list_create ( doca_dev* dev, int filter, doca_devinfo_rep*** dev_list_rep, uint32_t* nb_devs_rep )

Create list of available representor devices accessible by dev.

Parameters

dev: Local device with access to representors.
filter: Bitmap filter of representor types. See enum doca_dev_rep_filter for more details.
dev_list_rep: Pointer to array of pointers. Output can then be accessed as follows (*dev_list_rep)[idx].
nb_devs_rep: Number of available representor devices.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - failed to allocate memory for list.
DOCA_ERROR_DRIVER - Failed to query driver.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

Returns all representors managed by the provided device. The provided device must be a local device. The representor may represent a network function attached to the host, or it can represent an emulated function attached to the host.

Note:

Returned list must be destroyed using doca_devinfo_rep_list_destroy()

doca_error_t doca_devinfo_rep_list_destroy ( doca_devinfo_rep** dev_list_rep )

Destroy list of representor device info structures.

Parameters

dev_list_rep: List to be destroyed.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - the doca_dev that created the list is in a corrupted state.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

Destroy list of representor device information, once the list has been destroyed, all elements of the list are considered invalid.

2.4.7. DOCA DPDK

[Core]

DOCA API for integration with DPDK.

Functions

doca_error_t doca_dpdk_mempool_create ( const rte_mempool* mbuf_pool, doca_dpdk_mempool** mempool_out ): Create a DOCA DPDK memory pool, with ability to convert rte_mbuf to doca_buf Expected flow is as follows: Control path: // Create the memory pool based on a DPDK memory pool doca_dpdk_mempool_create() // Add 1 or more DOCA devices doca_dpdk_mempool_dev_add() // Set permission level across all devices (default=LOCAL_READ/WRITE) doca_dpdk_mempool_set_permissions() // Start the pool doca_dpdk_mempool_start().
doca_error_t doca_dpdk_mempool_destroy ( doca_dpdk_mempool* mempool ): Destroy a DOCA DPDK memory pool Before destroying need to make sure that all buffers that were acquired using doca_dpdk_mempool_mbuf_to_buf() have been released This must be called before destroying the originating DPDK mempool.
doca_error_t doca_dpdk_mempool_dev_add ( doca_dpdk_mempool* mempool, doca_dev* dev ): Add a DOCA device to the mempool This allows the DOCA bufs that are retrieved from the pool to be compatible with other DOCA libraries, that use the DOCA device.
doca_error_t doca_dpdk_mempool_mbuf_to_buf ( doca_dpdk_mempool* mempool, doca_buf_inventory* inventory, rte_mbuf* mbuf, doca_buf** buf ): Acquire a doca_buf based on an rte_mbuf The acquired doca_buf attempts to be as similar as possible to the rte_mbuf Level of support:After acquiring the buffer the refcount of the mbuf is increasedIn case mbuf is indirect refcount of the direct buffer is increased instead and metadata of the indirectmbuf is used where metdata refers to the mbuf's data offset, data length, and next pointerIn case the acquired doca_buf is duplicated, then the duplication process will increase the refcount of the direct mbufs as well Limitations:The mbuf must represent memory from the originating rte_mempool associated with this mempool and mbuf cannot be created from external memoryAny changes made to the rte_mbuf after the acquisition will not affect the doca_bufAny changes made to the doca_buf after acquisition will not affect the rte_mbuf.
doca_error_t doca_dpdk_mempool_set_permissions ( doca_dpdk_mempool* mempool, uint32_t access_mask ): Set the read/write permissions of the memory for devices Default: DOCA_ACCESS_LOCAL_READ_WRITE Setting the permission will set the access that the added devices have over the memory of the DOCA buffers.
doca_error_t doca_dpdk_mempool_start ( doca_dpdk_mempool* mempool ): Start the DOCA DPDK memory pool Operations that must be done before start: Adding at least 1 device - doca_dpdk_mempool_dev_add() Optionally, setting the permission level - doca_dpdk_mempool_set_permissions() Operations that are allowed after start: Acquiring a matching doca_buf from an rte_mbuf - doca_dpdk_mempool_mbuf_to_buf() Destroying the DOCA DPDK memory pool - doca_dpdk_mempool_destroy().
doca_error_t doca_dpdk_port_as_dev ( uint16_t port_id, doca_dev** dev ): Return the DOCA device associated with a DPDK port.
doca_error_t doca_dpdk_port_probe ( doca_dev* dev, const char* devargs ): Attach a DPDK port specified by DOCA device.

Functions

doca_error_t doca_dpdk_mempool_create ( const rte_mempool* mbuf_pool, doca_dpdk_mempool** mempool_out )

Create a DOCA DPDK memory pool, with ability to convert rte_mbuf to doca_buf Expected flow is as follows: Control path: // Create the memory pool based on a DPDK memory pool doca_dpdk_mempool_create() // Add 1 or more DOCA devices doca_dpdk_mempool_dev_add() // Set permission level across all devices (default=LOCAL_READ/WRITE) doca_dpdk_mempool_set_permissions() // Start the pool doca_dpdk_mempool_start().

Parameters

mbuf_pool: A DPDK pool of mbufs, created with rte_pktmbuf_pool_create*()
mempool_out: The newly created DOCA DPDK memory pool in case of success

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.

Description

Data path: // Convert DPDK mbuf to DOCA buf doca_dpdk_mempool_mbuf_to_buf() // Optionally release DPDK mbuf back to the DPDK pool in case it is no longer needed rte_pktmbuf_free() // Release the doca_buf once finished with it doca_buf_refcnt_rm()

doca_error_t doca_dpdk_mempool_destroy ( doca_dpdk_mempool* mempool )

Destroy a DOCA DPDK memory pool Before destroying need to make sure that all buffers that were acquired using doca_dpdk_mempool_mbuf_to_buf() have been released This must be called before destroying the originating DPDK mempool.

Parameters

mempool: The DOCA DPDK memory pool to destroy

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_IN_USE - at least 1 DOCA buf has been acquired and still not released

Description

Note:

: Once destroyed the originating DPDK memory pool, and any allocated RTE mbuf are not affected

doca_error_t doca_dpdk_mempool_dev_add ( doca_dpdk_mempool* mempool, doca_dev* dev )

Add a DOCA device to the mempool This allows the DOCA bufs that are retrieved from the pool to be compatible with other DOCA libraries, that use the DOCA device.

Parameters

mempool: The DOCA DPDK memory pool to add the device to
dev: A DOCA device instance

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_NO_MEMORY - out of memory.

Description

Note:

Once device has been added it can't be removed. Only option is to destroy the doca_dpdk_mempool

doca_error_t doca_dpdk_mempool_mbuf_to_buf ( doca_dpdk_mempool* mempool, doca_buf_inventory* inventory, rte_mbuf* mbuf, doca_buf** buf )

Acquire a doca_buf based on an rte_mbuf The acquired doca_buf attempts to be as similar as possible to the rte_mbuf Level of support:After acquiring the buffer the refcount of the mbuf is increasedIn case mbuf is indirect refcount of the direct buffer is increased instead and metadata of the indirectmbuf is used where metdata refers to the mbuf's data offset, data length, and next pointerIn case the acquired doca_buf is duplicated, then the duplication process will increase the refcount of the direct mbufs as well Limitations:The mbuf must represent memory from the originating rte_mempool associated with this mempool and mbuf cannot be created from external memoryAny changes made to the rte_mbuf after the acquisition will not affect the doca_bufAny changes made to the doca_buf after acquisition will not affect the rte_mbuf.

Parameters

mempool: The DOCA DPDK memory pool created using the rte_mempool that created the rte_mbuf
inventory: A DOCA Buffer Inventory to be used for allocating the doca_buf. Must be started and have enough space
mbuf: A DPDK buffer that references memory that is within the RTE mempool associated with the DOCA DPDK mempool
buf: A DOCA buffer that references the same memory as the provided mbuf

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_NO_MEMORY - The inventory does not have enough free elements.

Description

doca_buf created after calling this method:

head __data_len__ \ / \ +----------+--------------+----------+ +----------+--------------+----------+ doca_buf list: | | data | | --next--> | | data | | +----------+--------------+----------+ +----------+--------------+----------+

Note:

: Destroying the doca_buf using 'doca_buf_refcount_rm()' will call 'rte_pktmbuf_free_seg()' on each direct mbuf

doca_error_t doca_dpdk_mempool_set_permissions ( doca_dpdk_mempool* mempool, uint32_t access_mask )

Set the read/write permissions of the memory for devices Default: DOCA_ACCESS_LOCAL_READ_WRITE Setting the permission will set the access that the added devices have over the memory of the DOCA buffers.

Parameters

mempool: The DOCA DPDK memory pool
access_mask: The access permissions - see 'enum doca_access_flags'

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input or bad access flag combination.

Description

Note:

: setting DOCA_ACCESS_DPU_* flags is invalid

doca_error_t doca_dpdk_mempool_start ( doca_dpdk_mempool* mempool )

Start the DOCA DPDK memory pool Operations that must be done before start: Adding at least 1 device - doca_dpdk_mempool_dev_add() Optionally, setting the permission level - doca_dpdk_mempool_set_permissions() Operations that are allowed after start: Acquiring a matching doca_buf from an rte_mbuf - doca_dpdk_mempool_mbuf_to_buf() Destroying the DOCA DPDK memory pool - doca_dpdk_mempool_destroy().

Parameters

mempool: The DOCA DPDK memory pool to add the device to

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_NO_MEMORY - out of memory.

Description

doca_error_t doca_dpdk_port_as_dev ( uint16_t port_id, doca_dev** dev )

Return the DOCA device associated with a DPDK port.

Parameters

port_id: The DPDK port identifier to get the associated DOCA device for.
dev: The DPDK DOCA device associated with the given DPDK port identifier.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_NOT_FOUND - in case there is no such DPDK port associated with a DOCA device.

Description

doca_error_t doca_dpdk_port_probe ( doca_dev* dev, const char* devargs )

Attach a DPDK port specified by DOCA device.

Parameters

dev: DOCA device to attach PDK port for.
devargs: DPDK devargs style - must NOT contains the device's PCI address ([domain:]bus:devid.func).

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_DRIVER - in case of DPDK error during DPDK port attach.
DOCA_ERROR_NO_MEMORY - in case of memory allocation failure.

Description

Thread unsafe API.

It's the user responsibility to set the DPDK EAL initialization to skip probing the PCI device associated with the given DOCA device to prevent EAL from using it.

No initialization is done for the probed PDPK port and the port is not started.

2.4.8. DOCA Error

[Core]

DOCA Error provides information regarding different errors caused while using the DOCA libraries.

Defines

#define DOCA_ERROR_PROPAGATE ( r, t ): Save the first encountered doca_error_t.
#define DOCA_IS_ERROR ( r ): Compiler optimized macro to check if we have an error.

Functions

const __DOCA_EXPERIMENTAL char* doca_get_error_name ( doca_error_t error ): Returns the string representation of an error code name.
const __DOCA_EXPERIMENTAL char* doca_get_error_string ( doca_error_t error ): Returns the description string of an error code.

Defines

#define DOCA_ERROR_PROPAGATE ( r, t )

Updates the return value variable r to hold the first error that we encountered.

Value

do { \ if (r == DOCA_SUCCESS) \ r = t; \ } while(0)

#define DOCA_IS_ERROR ( r )

Used in cases where error is unlikely to happen.

Value

doca_unlikely((r) != DOCA_SUCCESS)

Functions

const __DOCA_EXPERIMENTAL char* doca_get_error_name ( doca_error_t error )

Returns the string representation of an error code name.

Parameters

error: - Error code to convert to string.

Returns

char* pointer to a NULL-terminated string.

Description

Returns a string containing the name of an error code in the enum. If the error code is not recognized, "unrecognized error code" is returned.

const __DOCA_EXPERIMENTAL char* doca_get_error_string ( doca_error_t error )

Returns the description string of an error code.

Parameters

error: - Error code to convert to description string.

Returns

char* pointer to a NULL-terminated string.

Description

This function returns the description string of an error code. If the error code is not recognized, "unrecognized error code" is returned.

2.4.9. DOCA Memory Map

[Core]

The DOCA memory map provides a centralized repository and orchestration of several memory ranges registration for each device attached to the memory map.

Typedefs

typedef void( doca_mmap_memrange_free_cb_t: Function to be called for each populated memory range on memory map destroy.

Functions

doca_error_t doca_mmap_create ( const doca_data* user_data, doca_mmap** mmap ): Allocates zero size memory map object with default/unset attributes.
doca_error_t doca_mmap_create_from_export ( const doca_data* user_data, const void* export_desc, size_t export_desc_len, doca_dev* dev, doca_mmap** mmap ): Creates a memory map object representing memory ranges in remote system memory space.
doca_error_t doca_mmap_destroy ( doca_mmap* mmap ): Destroy DOCA Memory Map structure.
doca_error_t doca_mmap_dev_add ( doca_mmap* mmap, doca_dev* dev ): Register DOCA memory map on a given device.
doca_error_t doca_mmap_dev_rm ( doca_mmap* mmap, doca_dev* dev ): Deregister given device from DOCA memory map.
doca_error_t doca_mmap_export_dpu ( doca_mmap* mmap, const doca_dev* dev, const void** export_desc, size_t* export_desc_len ): Compose memory map representation for later import with doca_mmap_create_from_export() for one of the devices previously added to the memory map.
doca_error_t doca_mmap_export_rdma ( doca_mmap* mmap, const doca_dev* dev, const void** export_desc, size_t* export_desc_len ): Compose memory map representation for later import with doca_mmap_create_from_export() for one of the devices previously added to the memory map. The imported mmap can then be used for RDMA operations.
doca_error_t doca_mmap_get_exported ( doca_mmap* mmap, uint8_t* exported ): Get the flag indicating if a DOCA Memory Map had been exported.
doca_error_t doca_mmap_get_from_export ( doca_mmap* mmap, uint8_t* from_export ): Get the flag indicating if a DOCA Memory Map had been created from an export.
doca_error_t doca_mmap_get_max_num_devices ( doca_mmap* mmap, uint32_t* max_num_devices ): Get the max number of devices to add to a DOCA Memory Map.
doca_error_t doca_mmap_get_memrange ( const doca_mmap* mmap, void** addr, size_t* len ): Get the memory range of DOCA memory map.
doca_error_t doca_mmap_get_num_bufs ( doca_mmap* mmap, uint32_t* num_bufs ): Get the Total number of `struct doca_buf` objects pointing to the memory in a DOCA Memory Map.
doca_error_t doca_mmap_get_user_data ( doca_mmap* mmap, doca_data* user_data ): Get the user_data of a DOCA Memory Map.
doca_error_t doca_mmap_set_dmabuf_memrange ( doca_mmap* mmap, int dmabuf_fd, size_t offset, size_t len ): Set the memory range of DOCA memory map using dmabuf.
doca_error_t doca_mmap_set_free_cb ( doca_mmap* mmap, doca_mmap_memrange_free_cb_t* free_cb, void* opaque ): Set callback that will free the memory range when destroying DOCA memory map.
doca_error_t doca_mmap_set_max_num_devices ( doca_mmap* mmap, uint32_t max_num_devices ): Set a new max number of devices to add to a DOCA Memory Map.
doca_error_t doca_mmap_set_memrange ( doca_mmap* mmap, void* addr, size_t len ): Set the memory range of DOCA memory map.
doca_error_t doca_mmap_set_permissions ( doca_mmap* mmap, uint32_t access_mask ): Set access flags of the registered memory.
doca_error_t doca_mmap_start ( doca_mmap* mmap ): Start DOCA Memory Map.
doca_error_t doca_mmap_stop ( doca_mmap* mmap ): Stop DOCA Memory Map.

Typedefs

typedef void( doca_mmap_memrange_free_cb_t

Function to be called for each populated memory range on memory map destroy.

Functions

doca_error_t doca_mmap_create ( const doca_data* user_data, doca_mmap** mmap )

Allocates zero size memory map object with default/unset attributes.

Parameters

user_data
mmap: DOCA memory map structure with default/unset attributes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_mmap.

Description

The returned memory map object can be manipulated with doca_mmap_property_set() API.

Once all required mmap attributes set it should be reconfigured and adjusted to meet object size setting with doca_mmap_start() See doca_mmap_start for the rest of the details.

doca_error_t doca_mmap_create_from_export ( const doca_data* user_data, const void* export_desc, size_t export_desc_len, doca_dev* dev, doca_mmap** mmap )

Creates a memory map object representing memory ranges in remote system memory space.

Parameters

user_data
export_desc: An export descriptor generated by doca_mmap_export_*.
export_desc_len: Length in bytes of the export_desc.
dev: A local device connected to the device that resides in the exported mmap. In case the 'export_desc' was created using doca_mmap_export_dpu(), then device must have from export DPU capability. See doca_devinfo_get_is_mmap_from_export_dpu_supported() in doca_dev.h
mmap: DOCA memory map granting access to remote memory.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received or internal error. The following errors are internal and will occur if failed to produce new mmap from export descriptor:
DOCA_ERROR_NO_MEMORY - if internal memory allocation failed.
DOCA_ERROR_NOT_SUPPORTED - device missing create from export capability, or was opened using doca_dev_open_from_pd().
DOCA_ERROR_NOT_PERMITTED
DOCA_ERROR_DRIVER

Description

Once this function called on the object it considered as from_export.

The following are NOT possible for the mmap created from export:

Setting the properties of the mmap using doca_mmap_set_*().
Adding a device to the mmap using doca_mmap_dev_add().
Removing a device to the mmap using doca_mmap_dev_rm().
Exporting the mmap using doca_mmap_export_*.

Note:

: The created object not backed by local memory.

doca_error_t doca_mmap_destroy ( doca_mmap* mmap )

Destroy DOCA Memory Map structure.

Parameters

mmap: The DOCA memory map structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if there is a memory region pointed by one or more `struct doca_buf`, or if memory deregistration failed.

Description

Before calling this function all allocated buffers should be returned back to the mmap.

doca_error_t doca_mmap_dev_add ( doca_mmap* mmap, doca_dev* dev )

Parameters

mmap: DOCA memory map structure.
dev: DOCA Dev instance with appropriate capability.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if memory deregistration failed or the operation is not premitted for the given mmap (see details in this function description).
DOCA_ERROR_NO_MEMORY - if reached to DOCA_MMAP_MAX_NUM_DEVICES.
DOCA_ERROR_IN_USE - if doca_dev already exists in doca_mmap.
DOCA_ERROR_NOT_SUPPORTED - if dev was opened using doca_dev_open_from_pd().

Description

This operation is not permitted for:

started memory map object.
memory map object that have been exported or created from export.

doca_error_t doca_mmap_dev_rm ( doca_mmap* mmap, doca_dev* dev )

Deregister given device from DOCA memory map.

Parameters

mmap: DOCA memory map structure.
dev: DOCA Dev instance that was previously added.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received or doca_dev doesn't exists in doca_mmap.
DOCA_ERROR_NOT_PERMITTED - if memory deregistration failed or the operation is not premitted for the given mmap (see details in this function description).

Description

This operation is not permitted for:

started memory map object.
memory map object that have been exported or created from export.

doca_error_t doca_mmap_export_dpu ( doca_mmap* mmap, const doca_dev* dev, const void** export_desc, size_t* export_desc_len )

Compose memory map representation for later import with doca_mmap_create_from_export() for one of the devices previously added to the memory map.

Parameters

mmap: DOCA memory map structure.
dev: Device previously added to the memory map via doca_mmap_dev_add(). Device must have export capability. See doca_devinfo_get_is_mmap_export_dpu_supported() in doca_dev.h
export_desc: On successful return should have a pointer to the allocated blob containing serialized representation of the memory map object for the device provided as `dev`.
export_desc_len: Length in bytes of the export_desc.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received or device does not exists in mmap.
DOCA_ERROR_NOT_PERMITTED - the operation is not premitted for the given mmap, see details in this function description. The following errors will occur if failed to produce export descriptor:
DOCA_ERROR_NO_MEMORY - if failed to alloc memory for export_desc.
DOCA_ERROR_NOT_SUPPORTED - device missing export capability.
DOCA_ERROR_DRIVER

Description

Once this function called on the object it considered as exported. The same mmap can be exported using different devices. Once mmap is stopped then any mmap created from export will be invalidated, and the 'export_desc' is destroyed.

This operation is not permitted for:

un-started/stopped memory map object.
memory map object that have been created from export.
memory map with no DPU access permission set - see doca_mmap_set_permissions()

doca_error_t doca_mmap_export_rdma ( doca_mmap* mmap, const doca_dev* dev, const void** export_desc, size_t* export_desc_len )

Compose memory map representation for later import with doca_mmap_create_from_export() for one of the devices previously added to the memory map. The imported mmap can then be used for RDMA operations.

Parameters

mmap: DOCA memory map structure.
dev: Device previously added to the memory map via doca_mmap_dev_add().
export_desc: On successful return should have a pointer to the allocated blob containing serialized representation of the memory map object for the device provided as `dev`.
export_desc_len: Length in bytes of the export_desc.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received or device does not exists in mmap.
DOCA_ERROR_NOT_PERMITTED - the operation is not premitted for the given mmap, see details in this function description. The following errors will occur if failed to produce export descriptor:
DOCA_ERROR_NO_MEMORY - if failed to alloc memory for export_desc.
DOCA_ERROR_NOT_SUPPORTED - device missing export capability, or was opened using doca_dev_open_from_pd().
DOCA_ERROR_DRIVER

Description

Once this function called on the object it considered as exported.

This operation is not permitted for:

un-started/stopped memory map object.
memory map objects that have been created from export.
memory map with no RDMA access permission set - see doca_mmap_set_permissions()

doca_error_t doca_mmap_get_exported ( doca_mmap* mmap, uint8_t* exported )

Get the flag indicating if a DOCA Memory Map had been exported.

Parameters

mmap: The DOCA memory map structure.
exported: 1 if mmap had been exported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_mmap_get_from_export ( doca_mmap* mmap, uint8_t* from_export )

Get the flag indicating if a DOCA Memory Map had been created from an export.

Parameters

mmap: The DOCA memory map structure.
from_export: 1 if mmap had been created from export, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_mmap_get_max_num_devices ( doca_mmap* mmap, uint32_t* max_num_devices )

Get the max number of devices to add to a DOCA Memory Map.

Parameters

mmap: The DOCA memory map structure.
max_num_devices: The max number of devices that can be added add to mmap.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_mmap_get_memrange ( const doca_mmap* mmap, void** addr, size_t* len )

Get the memory range of DOCA memory map.

Parameters

mmap: DOCA memory map structure.
addr: Start address of the memory range previously set.
len: The size of the memory range in bytes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - memrange was never set.

Description

doca_error_t doca_mmap_get_num_bufs ( doca_mmap* mmap, uint32_t* num_bufs )

Get the Total number of `struct doca_buf` objects pointing to the memory in a DOCA Memory Map.

Parameters

mmap: The DOCA memory map structure.
num_bufs: The total number of `struct doca_buf` objects pointing to the memory in mmap.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_mmap_get_user_data ( doca_mmap* mmap, doca_data* user_data )

Get the user_data of a DOCA Memory Map.

Parameters

mmap: The DOCA memory map structure.
user_data: The user_data of mmap.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Note:

The user_data that was provided to the mmap upon its creation.

doca_error_t doca_mmap_set_dmabuf_memrange ( doca_mmap* mmap, int dmabuf_fd, size_t offset, size_t len )

Set the memory range of DOCA memory map using dmabuf.

Parameters

mmap: DOCA memory map structure.
dmabuf_fd: File descriptor of the dmabuf.
offset: Start offset of the dmabuf.
len: The size of the memory range in bytes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_NOT_SUPPORTED - if not called from linux operating system
DOCA_ERROR_INVALID_VALUE - if an invalid input had been received, or addr + len overflows.
DOCA_ERROR_BAD_STATE - if mmap is started.
DOCA_ERROR_NOT_PERMITTED - if mmap memory range was set before

Description

This operation is not permitted for:

started memory map object.
memory map object that have been exported or created from export.

Note:

: this property is mandatory and can be done only once. it is only supported when used on linux operating system

doca_error_t doca_mmap_set_free_cb ( doca_mmap* mmap, doca_mmap_memrange_free_cb_t* free_cb, void* opaque )

Set callback that will free the memory range when destroying DOCA memory map.

Parameters

mmap: DOCA memory map structure.
free_cb: Callback function to free the set memory range on memory map destroy.
opaque: User opaque value passed to free_cb.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if mmap is started.

Description

Note:

Callback is called on mmap destroy, only in case the mmap was started and destroyed without changing the callback.

doca_error_t doca_mmap_set_max_num_devices ( doca_mmap* mmap, uint32_t max_num_devices )

Set a new max number of devices to add to a DOCA Memory Map.

Parameters

mmap: The DOCA memory map structure.
max_num_devices: The new max number of devices that can be added add to mmap.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if trying to set the max number of devices after first start of the mmap.

Description

doca_error_t doca_mmap_set_memrange ( doca_mmap* mmap, void* addr, size_t len )

Set the memory range of DOCA memory map.

Parameters

mmap: DOCA memory map structure.
addr: Start address of the memory range to be set.
len: The size of the memory range in bytes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received, or addr + len overflows.
DOCA_ERROR_BAD_STATE - if mmap is started.
DOCA_ERROR_NOT_PERMITTED - if mmap memory range was set before

Description

This operation is not permitted for:

started memory map object.
memory map object that have been exported or created from export.

Note:

: this property is mandatory and can be done only once

doca_error_t doca_mmap_set_permissions ( doca_mmap* mmap, uint32_t access_mask )

Set access flags of the registered memory.

Parameters

mmap: The DOCA memory map structure.
access_mask: bitwise combination of access flags - see enum doca_access_flags

Returns

DOCA_SUCCESS - in case of success doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received or trying to set an undefined access flag, or invalid combination
DOCA_ERROR_BAD_STATE - If mmap is started

Description

this defines what kind of access the added devices have to the memory defined in mmap

doca_error_t doca_mmap_start ( doca_mmap* mmap )

Start DOCA Memory Map.

Parameters

mmap: DOCA memory map structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - if memory allocation failed.
DOCA_ERROR_NOT_PERMITTED - if mmap is exported or created from export.

Description

Allows execution of different operations on the mmap, detailed below. On start verifies & finalizes the mmap object configuration.

The following become possible only after start:

Exporting the mmap using doca_mmap_export_*.
Mapping doca_buf structures to the memory ranges in the using doca_buf_inventory_buf_by_addr() or doca_buf_inventory_buf_dup().

The following are NOT possible while mmap is started:

Setting the properties of the mmap through doca_mmap_set_*.
Adding a device to the mmap using doca_mmap_dev_add().
Removing a device to the mmap using doca_mmap_dev_rm().

doca_error_t doca_mmap_stop ( doca_mmap* mmap )

Stop DOCA Memory Map.

Parameters

mmap: DOCA memory map structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if mmap was exported or created from export, or buffers that were created for this mmap, are still not destroyed.

Description

Prevents execution of different operations and allows operations that were available before start. For details see doca_mmap_start(). Frees any export descriptor received from doca_mmap_export_*, and invalidates any mmap created from this mmap export.

2.4.10. DOCA RDMA BRIDGE

[Core]

DOCA RDMA bridge.

Functions

doca_error_t doca_buf_get_mkey ( const doca_buf* buf, doca_dev* dev, uint32_t* mkey ): Get lkey with doca_access_flags access for a DOCA buffer of a DOCA device.
doca_error_t doca_dev_get_pd ( const doca_dev* dev, ibv_pd** pd ): Get the protection domain associated with a DOCA device.
doca_error_t doca_dev_open_from_pd ( ibv_pd* pd, doca_dev** dev ): Open a DOCA device using an ibv_pd.

Functions

doca_error_t doca_buf_get_mkey ( const doca_buf* buf, doca_dev* dev, uint32_t* mkey )

Get lkey with doca_access_flags access for a DOCA buffer of a DOCA device.

Parameters

buf: The DOCA buffer to get lkey for. MUST NOT BE NULL.
dev: The DOCA device to get lkey for. MUST NOT BE NULL.
mkey: The returned MKey. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if cannot find mkey by the given device.
DOCA_ERROR_NOT_SUPPORTED - if the given access flags is not supported

Description

Note:

Access of mkey is defined by the mmap where buf was created.

doca_error_t doca_dev_get_pd ( const doca_dev* dev, ibv_pd** pd )

Get the protection domain associated with a DOCA device.

Parameters

dev: DOCA device to get the pd from.
pd: The protection-domain associated with the given DOCA device.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_BAD_STATE - in case the device's pd is not valid (bad state)

Description

doca_error_t doca_dev_open_from_pd ( ibv_pd* pd, doca_dev** dev )

Open a DOCA device using an ibv_pd.

Parameters

pd: A protection domain that is not associated with any DOCA device
dev: A newly created DOCA device with same protection domain as 'pd'

Returns

DOCA_SUCCESS - in case of success

Description

Always prefer using a DOCA device obtained from doca_devinfo_list_create() This call will fail if PD was acquired by DOCA through doca_devinfo_list_create() and then doca_dev_get_pd()

This API should be used only to bridge between rdma-core and DOCA, to allow them to share memory registrations E.g., application already has logic that utilizes an ibv_pd, to read and write memory using RDMA, and wants to extend the logic by using libraries in DOCA, but such libraries will require a doca_dev and doca_buf instead of an ibv_pd and mkey in order to read write same memory. Then this method can be used to get a doca_dev that can be added to a doca_mmap, such that any doca_buf created from the doca_mmap can yield mkeys that are associated with the same ibv_pd using doca_buf_get_mkey()

For reference: doca_dev - is parallel to an ibv_pd doca_buf - is parallel to an ibv_mr registered on multiple devices doca_mmap - is parallel to creating an ibv_mr for multiple devices

The only APIs that are supported for the newly created device:

2.4.11. DOCA Sync Event

[Core]

DOCA Sync Event DOCA Sync Event is a software synchronization mechanism of parallel execution across the CPU, DPU, DPA, and GPU. It is an abstraction around 64-bit value which can be updated, read, and waited upon from any of these units to achieve synchronization between executions on them.

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_sync_event_as_ctx ( doca_sync_event* event ): Convert a Sync Event to a DOCA context.
doca_error_t doca_sync_event_create ( doca_sync_event** event ): Create a Sync Event handle.
doca_error_t doca_sync_event_create_from_export ( doca_dev* dev, const uint8_t* data, size_t sz, doca_sync_event** event ): Create a Sync Event handle from an export.
doca_error_t doca_sync_event_destroy ( doca_sync_event* event ): Destroy a Sync Event instance.
doca_error_t doca_sync_event_export_remote ( doca_sync_event* event, doca_sync_event_remote_t* handle ): Obtain an handle for interacting with the associated DOCA Syn Event from a remote node.
doca_error_t doca_sync_event_export_to_dpa ( doca_sync_event* event, doca_dpa* dpa, doca_dpa_dev_sync_event_t* dpa_dev_se_handle ): Export Sync Event to be shared with the DPA.
doca_error_t doca_sync_event_export_to_dpu ( doca_sync_event* event, doca_dev* dev, const uint8_t** data, size_t* sz ): Export Sync Event to be shared with the DPU.
doca_error_t doca_sync_event_export_to_gpu ( doca_sync_event* event, doca_gpu* gpu, doca_gpu_dev_sync_event_t** gpu_dev_se ): Export Sync Event to be shared with the GPU.
doca_error_t doca_sync_event_get ( doca_sync_event* event, uint64_t* value ): Get the value of a Sync Event synchronously.
doca_error_t doca_sync_event_get_create_from_export_supported ( const doca_devinfo* devinfo )
doca_error_t doca_sync_event_get_export_to_dpa_supported ( const doca_devinfo* devinfo )
doca_error_t doca_sync_event_get_export_to_dpu_supported ( const doca_devinfo* devinfo )
doca_error_t doca_sync_event_get_export_to_gpu_supported ( const doca_devinfo* devinfo )
doca_error_t doca_sync_event_job_get_supported ( doca_devinfo* devinfo, doca_sync_event_job_types type ): Check if a given device is capable of executing a specific Sync Event job.
doca_error_t doca_sync_event_publisher_add_location_cpu ( doca_sync_event* event, doca_dev* dev ): Associate a CPU device context as the Sync Event Publisher.
doca_error_t doca_sync_event_publisher_add_location_dpa ( doca_sync_event* event, doca_dpa* dpa ): Associate a DOCA DPA context as the Sync Event Publisher.
doca_error_t doca_sync_event_publisher_add_location_dpu ( doca_sync_event* event ): Declare Sync Event Publisher as the DPU.
doca_error_t doca_sync_event_publisher_add_location_gpu ( doca_sync_event* event, doca_gpu* gpu ): Associate a DOCA GPU context as the Sync Event Publisher.
doca_error_t doca_sync_event_set_addr ( doca_sync_event* event, uint64_t* addr ): Set the 64-bit value's address for a Sync Event.
doca_error_t doca_sync_event_start ( doca_sync_event* event ): Start a Sync Event to be operate as stand-alone DOCA Core object only.
doca_error_t doca_sync_event_stop ( doca_sync_event* event ): Stop a Sync Event which has been previously started with 'doca_sync_event_start'.
doca_error_t doca_sync_event_subscriber_add_location_cpu ( doca_sync_event* event, doca_dev* dev )
doca_error_t doca_sync_event_subscriber_add_location_dpa ( doca_sync_event* event, doca_dpa* dpa ): Associate a DOCA DPA context as the Sync Event Sublisher.
doca_error_t doca_sync_event_subscriber_add_location_dpu ( doca_sync_event* event ): Declare Sync Event Publisher as the DPU.
doca_error_t doca_sync_event_subscriber_add_location_gpu ( doca_sync_event* event, doca_gpu* gpu ): Associate a DOCA GPU context as the Sync Event Subscriber.
doca_error_t doca_sync_event_update_add ( doca_sync_event* event, uint64_t value, uint64_t* fetched ): Atomically increase the value of a Sync Event by some value synchronously.
doca_error_t doca_sync_event_update_set ( doca_sync_event* event, uint64_t value ): Set the value of a Sync Event to some value synchronously.
doca_error_t doca_sync_event_wait_gt ( doca_sync_event* event, uint64_t value, uint64_t mask ): Wait for the value of a Sync Event to reach some value synchronously in a polling busy wait manner.
doca_error_t doca_sync_event_wait_gt_yield ( doca_sync_event* event, uint64_t value, uint64_t mask ): Wait for the value of a Sync Event to reach some value synchronously in a periodically busy wait manner.

Typedefs

typedef uint64_t doca_dpa_dev_sync_event_t

DPA sync event handle type definition

typedef uint64_t doca_gpu_dev_sync_event_t

GPU sync event handle type definition

Enumerations

enum doca_sync_event_job_types

Sync Event job types for performing operation on a Sync Event thorugh DOCA job submission on a DOCA WorkQ

Values

DOCA_SYNC_EVENT_JOB_WAIT_GT = DOCA_ACTION_SYNC_EVENT_FIRST+1: Wait for the Sync Event to be grater than some value
DOCA_SYNC_EVENT_JOB_GET: Get the value of the Sync Event
DOCA_SYNC_EVENT_JOB_UPDATE_SET: Set the Sync Event value with some value
DOCA_SYNC_EVENT_JOB_UPDATE_ADD: Increment atomically the Sync Event value by some value

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_sync_event_as_ctx ( doca_sync_event* event )

Convert a Sync Event to a DOCA context.

Parameters

event: The doca_sync_event to be converted

Returns

The matching doca_ctx instance in case of success, NULL otherwise.

Description

Set the Sync Event to operate as a DOCA Context only, hence it can be interacted with through the supported DOCA Context API.

Sync Event CTX supports the following operations: start/stop/workq_add/workq_rm/get_event_driven_supported. A device can't be attached to a sync event ctx.

A user can use an attached (to Sync Event CTX) DOCA WorkQ to perform operations on the underlying Sync Event asynchronously by submitting jobs to the attached DOCA WorkQ(see enum doca_sync_event_job_types).

It is suggested to use Sync Event in this mode to wait on a Sync Event in a blocking manner.

doca_error_t doca_sync_event_create ( doca_sync_event** event )

Create a Sync Event handle.

Parameters

event: The created doca_sync_event instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_sync_event.

Description

Creates CPU handle - Host CPU or DPU's CPU.

doca_error_t doca_sync_event_create_from_export ( doca_dev* dev, const uint8_t* data, size_t sz, doca_sync_event** event )

Create a Sync Event handle from an export.

Parameters

dev: doca_dev instance to be attached to the create doca_sync_event.
data: Exported doca_sync_event data stream, created by doca_sync_event_export_to_* call.
sz: Size of exported doca_sync_event data stream, created by doca_sync_event_export_to_* call.
event: The created doca_sync_event instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided doca_dev does not support creating Sync Event from export.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_sync_event.

Description

Creates a DPU handle. The DOCA Device should be capable of importing an exported Sync Event (see doca_sync_event_get_create_from_export_supported capability).

Note:

The Sync Event can only be configured and exported by the exporting process.

doca_error_t doca_sync_event_destroy ( doca_sync_event* event )

Destroy a Sync Event instance.

Parameters

event: doca_sync_event to be destroyed.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.

Description

doca_error_t doca_sync_event_export_remote ( doca_sync_event* event, doca_sync_event_remote_t* handle )

Obtain an handle for interacting with the associated DOCA Syn Event from a remote node.

Parameters

event: Target doca_sync_event instance to export for remote.
handle: The remote handle associated with the given doca_sync_event instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_export_to_dpa ( doca_sync_event* event, doca_dpa* dpa, doca_dpa_dev_sync_event_t* dpa_dev_se_handle )

Export Sync Event to be shared with the DPA.

Parameters

event: Target doca_sync_event instance to export.
dpa: The associated DOCA DPA Context.
dpa_dev_se_handle: DOCA DPA device sync event handle that can be passed to a kernel.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support this Sync Event action.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_dpa_sync_event.

Description

Create Sync Event DPA handle used for synchronize between the x86 CPU HOST and the DPA. Sync Event should be properly configured, either subscriber or publisher should be declared as DPA location. The underlying DOCA Device should be capable of exporting to DPA (see doca_sync_event_get_export_to_dpa_supported capability). A Sync Event can be exported from the Host CPU only.

The DOCA DPA Sync Event is an handle to be used from the DPA to perform operations on the associated Sync Event.

doca_error_t doca_sync_event_export_to_dpu ( doca_sync_event* event, doca_dev* dev, const uint8_t** data, size_t* sz )

Export Sync Event to be shared with the DPU.

Parameters

event: Target doca_sync_event instance to export.
dev: Target dev to export.
data: The created export data stream.
sz: Size of created export data stream.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support this Sync Event action.
DOCA_ERROR_NO_MEMORY - failed to alloc data stream.

Description

Create export data stream used for synchronize between the x86 CPU HOST to DPU ARM. Sync Event should be properly configured, both subscriber and publisher must be declared as either CPU or DPU location. The underlying DOCA Device should be capable of exporting to DPU (see doca_sync_event_get_export_to_dpu_supported capability). A Sync Event can be exported from the Host CPU only.

The exported data stream an be used from the DPU to created an exported Sync Event (see doca_sync_event_create_from_export).

doca_error_t doca_sync_event_export_to_gpu ( doca_sync_event* event, doca_gpu* gpu, doca_gpu_dev_sync_event_t** gpu_dev_se )

Export Sync Event to be shared with the GPU.

Parameters

event: Target doca_sync_event instance to export.
gpu: The associated DOCA GPU Context.
gpu_dev_se: DOCA GPU device sync event handle that can be passed to a kernel.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support this Sync Event action.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_gpu_sync_event.

Description

Create Sync Event GPU handle used for synchronize between the x86 CPU HOST and the DPA. Sync Event should be properly configured, either subscriber or publisher should be declared as GPU location. The underlying DOCA Device should be capable of exporting to GPU (see doca_sync_event_get_export_to_gpu_supported capability). A Sync Event can be exported from the Host CPU only.

The DOCA GPU Sync Event is an handle to be used from the GPU to perform operations on the associated Sync Event.

doca_error_t doca_sync_event_get ( doca_sync_event* event, uint64_t* value )

Get the value of a Sync Event synchronously.

Parameters

event: Target doca_sync_event instance to read its value.
value: The returned doca_sync_event value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_get_create_from_export_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: The DOCA device information.

Returns

DOCA_SUCCESS - in case device supports creating Sync Event from an export. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support importing an exported Sync Event.

Description

Check if given device is capable of creating Sync Event from an export.

doca_error_t doca_sync_event_get_export_to_dpa_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: The DOCA device information.

Returns

DOCA_SUCCESS - in case device supports exporting an associated Sync Event to DPA. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support exporting an associated Sync Event to DPA.

Description

Check if a DOCA device is capable of exporting an associated Sync Event to the DPA using doca_sync_event_export_to_dpa.

doca_error_t doca_sync_event_get_export_to_dpu_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: The DOCA device information.

Returns

DOCA_SUCCESS - in case device supports exporting an associated Sync Event to DPU. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support exporting an associated Sync Event to DPU.

Description

Check if a DOCA device is capable of exporting an associated Sync Event to the DPU using doca_sync_event_export_to_dpu.

doca_error_t doca_sync_event_get_export_to_gpu_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: The DOCA device information.

Returns

DOCA_SUCCESS - in case device supports exporting an associated Sync Event to GPU. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support exporting an associated Sync Event to GPU.

Description

Check if a DOCA device is capable of exporting an associated Sync Event to the GPU using doca_sync_event_export_to_gpu.

doca_error_t doca_sync_event_job_get_supported ( doca_devinfo* devinfo, doca_sync_event_job_types type )

Check if a given device is capable of executing a specific Sync Event job.

Parameters

devinfo: The DOCA device information.
type: doca_sync_event_job_types available for this device. see enum doca_sync_event_job_types.

Returns

DOCA_SUCCESS - in case device supports the Sync Event job type. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support this Sync Event job.

Description

doca_error_t doca_sync_event_publisher_add_location_cpu ( doca_sync_event* event, doca_dev* dev )

Associate a CPU device context as the Sync Event Publisher.

Parameters

event: Target doca_sync_event instance to set.
dev: doca_dev instance associated with CPU.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_publisher_add_location_dpa ( doca_sync_event* event, doca_dpa* dpa )

Associate a DOCA DPA context as the Sync Event Publisher.

Parameters

event: Target doca_sync_event instance to set.
dpa: doca_dpa instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_publisher_add_location_dpu ( doca_sync_event* event )

Declare Sync Event Publisher as the DPU.

Parameters

event: Target doca_sync_event instance to set.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.

Description

doca_error_t doca_sync_event_publisher_add_location_gpu ( doca_sync_event* event, doca_gpu* gpu )

Associate a DOCA GPU context as the Sync Event Publisher.

Parameters

event: Target doca_sync_event instance to set.
gpu: doca_gpu instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_set_addr ( doca_sync_event* event, uint64_t* addr )

Set the 64-bit value's address for a Sync Event.

Parameters

event: Pointer to se event instance to be configured.
addr: Allocated address pointer.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - setting address for event which has already been started is not allowed.
DOCA_ERROR_NOT_SUPPORTED - addr is in unsupported address space.

Description

Setting external address is allowed only for CPU/DPU configured Sync Event.

doca_error_t doca_sync_event_start ( doca_sync_event* event )

Start a Sync Event to be operate as stand-alone DOCA Core object only.

Parameters

event: Pointer to se event instance to be started.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.

Description

Starting a Sync Event with doca_sync_event_start means it can't be operate as (and converted to) DOCA Context.

doca_error_t doca_sync_event_stop ( doca_sync_event* event )

Stop a Sync Event which has been previously started with 'doca_sync_event_start'.

Parameters

event: Pointer to se event instance to be stoped.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.

Description

doca_error_t doca_sync_event_subscriber_add_location_cpu ( doca_sync_event* event, doca_dev* dev )

Parameters

event: Target doca_sync_event instance to set.
dev: doca_dev instance associated with CPU.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

Associate a CPU device context as the doca_sync_event Subscriber,

doca_error_t doca_sync_event_subscriber_add_location_dpa ( doca_sync_event* event, doca_dpa* dpa )

Associate a DOCA DPA context as the Sync Event Sublisher.

Parameters

event: Target doca_sync_event instance to set.
dpa: doca_dpa instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_subscriber_add_location_dpu ( doca_sync_event* event )

Declare Sync Event Publisher as the DPU.

Parameters

event: Target doca_sync_event instance to set.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.

Description

doca_error_t doca_sync_event_subscriber_add_location_gpu ( doca_sync_event* event, doca_gpu* gpu )

Associate a DOCA GPU context as the Sync Event Subscriber.

Parameters

event: Target doca_sync_event instance to set.
gpu: doca_gpu instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_update_add ( doca_sync_event* event, uint64_t value, uint64_t* fetched )

Atomically increase the value of a Sync Event by some value synchronously.

Parameters

event: Target doca_sync_event instance to increment.
value: The value to increment the doca_sync_event value by.
fetched: The value of the doca_sync_event before the operation.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_update_set ( doca_sync_event* event, uint64_t value )

Set the value of a Sync Event to some value synchronously.

Parameters

event: Target doca_sync_event instance to set its value.
value: The value to set the doca_sync_event to.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_wait_gt ( doca_sync_event* event, uint64_t value, uint64_t mask )

Wait for the value of a Sync Event to reach some value synchronously in a polling busy wait manner.

Parameters

event: Target doca_sync_event instance to wait on.
value: The value to wait for the doca_sync_event to be greater than.
mask: Mask to apply (bitwise AND) on the doca_sync_event value for comparison with wait threshold.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_wait_gt_yield ( doca_sync_event* event, uint64_t value, uint64_t mask )

Wait for the value of a Sync Event to reach some value synchronously in a periodically busy wait manner.

Parameters

event: Target doca_sync_event instance to wait on.
value: The value to wait for the doca_sync_event to be greater than.
mask: Mask to apply (bitwise AND) on the doca_sync_event value for comparison with wait threshold.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

After each polling iteration, call sched_yield sched_yield() causes the calling thread to relinquish the CPU. The thread is moved to the end of the queue for its static priority and a new thread gets to run.

2.4.12. DOCA Types

[Core]

DOCA Types introduces types that are common for many libraries.

Defines

#define DOCA_GID_BYTE_LENGTH 16: Specifies the length of a GID (Global ID) in bytes.

Typedefs

typedef uint16_t doca_be16_t: Declare DOCA endianity types.
typedef void * doca_event_handle_t

Enumerations

enum doca_access_flags: Specifies the permission level for DOCA buffer.
enum doca_eth_wait_on_time: Type of wait on time the network card can support.
enum doca_gpu_mem_type: Type of memory the GPUNetIO library can allocate.
enum doca_mtu_size: MTU size in bytes.
enum doca_pci_func_type: Specifies the PCI function type for DOCA representor device.

Defines

#define DOCA_GID_BYTE_LENGTH 16

Typedefs

typedef uint16_t doca_be16_t

Declare DOCA endianity types.

typedef void * doca_event_handle_t

Used for windows HANDLE or IOCompletionPort

Enumerations

enum doca_access_flags

Can be used with doca_mmap_set_permissions() to set permission level. A few notes: DOCA_ACCESS_DPU_READ_ONLY and DOCA_ACCESS_DPU_READ_WRITE are mutually exclusive Buffer can always be read locally by local device, regardless of set permissions local device - doca_dev running in the same process of the mmap remote device - doca_dev running on a different process on a remote machine DPU device - doca_dev running on a process on the DPU OS. This is only relevant when local process is running on HOST. In case local process is running on DPU the doca_dev is considered a local device.

Values

DOCA_ACCESS_LOCAL_READ_ONLY = 0
DOCA_ACCESS_LOCAL_READ_WRITE = (1<<0)
DOCA_ACCESS_RDMA_READ = (1<<1)
DOCA_ACCESS_RDMA_WRITE = (1<<2)
DOCA_ACCESS_RDMA_ATOMIC = (1<<3)
DOCA_ACCESS_DPU_READ_ONLY = (1<<4)
DOCA_ACCESS_DPU_READ_WRITE = (1<<5): Allows reading buffer by a DPU device but no write Only relevant for HOST - see doca_mmap_export_dpu()

enum doca_eth_wait_on_time

Values

DOCA_ETH_WAIT_ON_TIME_NONE = 0
DOCA_ETH_WAIT_ON_TIME_NATIVE = 1
DOCA_ETH_WAIT_ON_TIME_DPDK = 2

enum doca_gpu_mem_type

Values

DOCA_GPU_MEM_GPU = 0
DOCA_GPU_MEM_GPU_CPU = 1
DOCA_GPU_MEM_CPU = 2
DOCA_GPU_MEM_CPU_GPU = 3

enum doca_mtu_size

Values

DOCA_MTU_SIZE_256_BYTES = 0x0
DOCA_MTU_SIZE_512_BYTES = 0x1
DOCA_MTU_SIZE_1K_BYTES = 0x2
DOCA_MTU_SIZE_2K_BYTES = 0x3
DOCA_MTU_SIZE_4K_BYTES = 0x4
DOCA_MTU_SIZE_RAW_ETHERNET = 0x5

enum doca_pci_func_type

Values

DOCA_PCI_FUNC_PF = 0
DOCA_PCI_FUNC_VF
DOCA_PCI_FUNC_SF

DOCA Buffer

DOCA Buffer Array

DOCA Buffer Inventory

DOCA Bufpool

DOCA Context

DOCA Device

DOCA DPDK

DOCA Error

DOCA Memory Map

DOCA RDMA BRIDGE

DOCA Sync Event

DOCA Types

2.4.1. DOCA Buffer

[Core]

The DOCA Buffer is used for reference data. It holds the information on a memory region that belongs to a DOCA memory map, and its descriptor is allocated from DOCA Buffer Inventory.

Functions

doca_error_t doca_buf_get_data ( const doca_buf* buf, void** data ): Get the buffer's data.
doca_error_t doca_buf_get_data_len ( const doca_buf* buf, size_t* data_len ): Get buffer's data length.
doca_error_t doca_buf_get_head ( const doca_buf* buf, void** head ): Get the buffer's head.
doca_error_t doca_buf_get_len ( const doca_buf* buf, size_t* len ): Get the buffer's length.
doca_error_t doca_buf_get_refcount ( doca_buf* buf, uint16_t* refcount ): Get the reference count of the object.
doca_error_t doca_buf_is_in_list ( const doca_buf* buf, uint8_t* is_in_list ): Check if provided DOCA Buf is a linked list.
doca_error_t doca_buf_list_chain ( doca_buf* list1, doca_buf* list2 ): Append list2 to list1.
doca_error_t doca_buf_list_is_first ( const doca_buf* buf, bool* is_first ): Check if provided DOCA Buf is the first element in a linked list.
doca_error_t doca_buf_list_is_last ( const doca_buf* buf, bool* is_last ): Check if provided DOCA Buf is the last element in a linked list.
doca_error_t doca_buf_list_last ( doca_buf* buf, doca_buf** last_buf ): Get last DOCA Buf in linked list.
doca_error_t doca_buf_list_next ( doca_buf* buf, doca_buf** next_buf ): Get next DOCA Buf in linked list.
doca_error_t doca_buf_list_num_elements ( const doca_buf* buf, uint32_t* num_elements ): Get the number of the elements in list.
doca_error_t doca_buf_list_unchain ( doca_buf* list1, doca_buf* list2 ): Separate list2 from list1.
doca_error_t doca_buf_refcount_add ( doca_buf* buf, uint16_t* refcount ): Increase the object reference count by 1.
doca_error_t doca_buf_refcount_rm ( doca_buf* buf, uint16_t* refcount ): Decrease the object reference count by 1, if 0 reached, return the element back to the inventory.
doca_error_t doca_buf_reset_data_len ( doca_buf* buf )
doca_error_t doca_buf_set_data ( doca_buf* buf, void* data, size_t data_len )

Functions

doca_error_t doca_buf_get_data ( const doca_buf* buf, void** data )

Get the buffer's data.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
data: The data of the buffer. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_get_data_len ( const doca_buf* buf, size_t* data_len )

Get buffer's data length.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
data_len: The data length of the buffer. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_get_head ( const doca_buf* buf, void** head )

Get the buffer's head.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
head: The head of the buffer. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_get_len ( const doca_buf* buf, size_t* len )

Get the buffer's length.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
len: The length of the buffer. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_get_refcount ( doca_buf* buf, uint16_t* refcount )

Get the reference count of the object.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
refcount: The number of references to the object. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_is_in_list ( const doca_buf* buf, uint8_t* is_in_list )

Check if provided DOCA Buf is a linked list.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
is_in_list: 1 if buf is part of a linked list, 0 if it is not. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_list_chain ( doca_buf* list1, doca_buf* list2 )

Append list2 to list1.

Parameters

list1: DOCA Buf representing list1. MUST NOT BE NULL AND MUST BE HEAD OF LIST.
list2: DOCA Buf representing list2. MUST NOT BE NULL AND MUST BE HEAD OF LIST.

Returns

DOCA_SUCCESS - always.

Description

Before: +----+ +----+ +----+ list1 -> |1 |->|2 |->|3 | +----+ +----+ +----+

+----+ +----+ list2 -> |4 |->|5 | +----+ +----+

After:

+----+ +----+ +----+ +----+ +----+ list1 -> |1 |->|2 |->|3 |->|4 |->|5 | +----+ +----+ +----+ +----+ +----+ / list2

doca_error_t doca_buf_list_is_first ( const doca_buf* buf, bool* is_first )

Check if provided DOCA Buf is the first element in a linked list.

Parameters

buf: DOCA Buf element.
is_first: True if buf is the first element, false if it is not.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_list_is_last ( const doca_buf* buf, bool* is_last )

Check if provided DOCA Buf is the last element in a linked list.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
is_last: True if buf is the last element, false if it is not. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_list_last ( doca_buf* buf, doca_buf** last_buf )

Get last DOCA Buf in linked list.

Parameters

buf: DOCA Buf element.
last_buf: The last DOCA Buf in the linked list, which may be buf.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_buf_list_next ( doca_buf* buf, doca_buf** next_buf )

Get next DOCA Buf in linked list.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
next_buf: The next DOCA Buf in the linked list, *next_buf will be NULL if the no other element in the list. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_buf_list_num_elements ( const doca_buf* buf, uint32_t* num_elements )

Get the number of the elements in list.

Parameters

buf: DOCA Buf element. Buf must be a head of a list.
num_elements: Number of elements in list.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if the buffer is not a head of a list.

Description

doca_error_t doca_buf_list_unchain ( doca_buf* list1, doca_buf* list2 )

Separate list2 from list1.

Parameters

list1: DOCA Buf representing list1. MUST NOT BE NULL.
list2: DOCA Buf representing list2, list2 should be contained in list1. list2 must be different from list1. MUST NOT BE NULL

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if list2 is not part of list1.

Description

Before: +----+ +----+ +----+ +----+ +----+ list1 -> |1 |->|2 |->|3 |->|4 |->|5 | +----+ +----+ +----+ +----+ +----+ / list2

After: +----+ +----+ +----+ list1 -> |1 |->|2 |->|3 | +----+ +----+ +----+

+----+ +----+ list2 -> |4 |->|5 | +----+ +----+

doca_error_t doca_buf_refcount_add ( doca_buf* buf, uint16_t* refcount )

Increase the object reference count by 1.

Parameters

buf: DOCA Buf element.
refcount: The number of references to the object before this operation took place.

Returns

DOCA_ERROR_NOT_SUPPORTED

Description

Note:

This function is not supported yet.

doca_error_t doca_buf_refcount_rm ( doca_buf* buf, uint16_t* refcount )

Decrease the object reference count by 1, if 0 reached, return the element back to the inventory.

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
refcount: The number of references to the object before this operation took place. Can be NULL.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_NOT_PERMITTED - buf is the next element in some list.

Description

When refcont 0 reached, all related resources should be released. For example if the element points into some mmap its state will be adjusted accordingly.

doca_error_t doca_buf_reset_data_len ( doca_buf* buf )

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - always

Description

Reset the data length to 0 (data will still point to the same location)

__data_len__ / \ +-----+--------------+--------------+ Before | |data | | +-----+--------------+--------------+ / data

data_len = 0 / +-----+-----------------------------+ After | | | +-----+-----------------------------+ / data

doca_error_t doca_buf_set_data ( doca_buf* buf, void* data, size_t data_len )

Parameters

buf: DOCA Buf element. MUST NOT BE NULL.
data: Data address. MUST NOT BE NULL.
data_len: Data length.

Returns

DOCA_SUCCESS - always

Description

Set data pointer and data length

+-----------+-----+-----------------+ Before | |data | | +-----------+-----+-----------------+

__data_len__ / \ +-----+--------------+--------------+ After | |data | | +-----+--------------+--------------+ / data

Note:

The range [data, data + data_len] must be in [head, head + len]. Otherwise undefined behaviour.

2.4.2. DOCA Buffer Array

[Core]

The DOCA buffer array represents an array of fixed size doca_bufs (for multiple doca_dev). Can act as a free list or direct access mode.

Functions

doca_error_t doca_buf_arr_create ( doca_mmap* mmap, doca_buf_arr** buf_arr ): Allocates a doca_buf_arr.
doca_error_t doca_buf_arr_destroy ( doca_buf_arr* buf_arr ): Destroys a doca buf array instance.
doca_error_t doca_buf_arr_get_gpu_handle ( const doca_buf_arr* buf_arr, doca_gpu_buf_arr** gpu_buf_arr ): Retrieves the handle in the gpu memory space of a doca_buf_arr.
doca_error_t doca_buf_arr_set_params ( doca_buf_arr* buf_arr, size_t size, uint32_t num_elem, uint32_t start_offset ): Sets the buf array params.
doca_error_t doca_buf_arr_set_target_gpu ( doca_buf_arr* buf_arr, doca_gpu* gpu_handler ): Configures the buf array to be created on the gpu device.
doca_error_t doca_buf_arr_start ( doca_buf_arr* buf_arr ): This method enables the allocation of doca_bufs.
doca_error_t doca_buf_arr_stop ( doca_buf_arr* buf_arr ): Stops a started doca buf array.

Functions

doca_error_t doca_buf_arr_create ( doca_mmap* mmap, doca_buf_arr** buf_arr )

Allocates a doca_buf_arr.

Parameters

mmap: The mmap managing the memory chunk. Must be populated with memory chunk.
buf_arr: The newly created doca_buf_arr.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - failed to allocate a doca_buf_arr.

Description

doca_error_t doca_buf_arr_destroy ( doca_buf_arr* buf_arr )

Destroys a doca buf array instance.

Parameters

buf_arr: The doca_buf_arr to destroy

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_buf_arr_get_gpu_handle ( const doca_buf_arr* buf_arr, doca_gpu_buf_arr** gpu_buf_arr )

Retrieves the handle in the gpu memory space of a doca_buf_arr.

Parameters

buf_arr: The doca_buf_arr
gpu_buf_arr: A pointer to the handle in the gpu memory space

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if doca_buf_arr is not started.

Description

doca_error_t doca_buf_arr_set_params ( doca_buf_arr* buf_arr, size_t size, uint32_t num_elem, uint32_t start_offset )

Sets the buf array params.

Parameters

buf_arr: The doca_buf_arr
size: Size in bytes of a single element (must be > 0).
num_elem: Number of elements in the doca_buf_arr (must be > 0).
start_offset: Offset from mmap start to set doca_buf_arr.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if doca_buf_arr is already started

Description

doca_error_t doca_buf_arr_set_target_gpu ( doca_buf_arr* buf_arr, doca_gpu* gpu_handler )

Configures the buf array to be created on the gpu device.

Parameters

buf_arr: The doca_buf_arr
gpu_handler: The gpu device handler.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if doca_buf_arr is already started

Description

doca_error_t doca_buf_arr_start ( doca_buf_arr* buf_arr )

This method enables the allocation of doca_bufs.

Parameters

buf_arr: The doca_buf_arr to start

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE -
DOCA_ERROR_NOT_PERMITTED - if mmap is not started.
DOCA_ERROR_NO_MEMORY - failed to allocate enough space for configuration structure

Description

Note:

Before calling this function, the mmap with which the buf array was created must be started.

doca_error_t doca_buf_arr_stop ( doca_buf_arr* buf_arr )

Stops a started doca buf array.

Parameters

buf_arr: The doca_buf_arr to stop

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

2.4.3. DOCA Buffer Inventory

[Core]

The DOCA buffer inventory manages a pool of doca_buf objects. Each buffer obtained from an inventory is a descriptor that points to a memory region from a doca_mmap memory range of the user's choice.

Functions

doca_error_t doca_buf_inventory_buf_by_addr ( doca_buf_inventory* inventory, doca_mmap* mmap, void* addr, size_t len, doca_buf** buf ): Allocate single element from buffer inventory and point it to the buffer defined by `addr` & `len` arguments.
doca_error_t doca_buf_inventory_buf_by_args ( doca_buf_inventory* inventory, doca_mmap* mmap, void* addr, size_t len, void* data, size_t data_len, doca_buf** buf ): Allocate single element from buffer inventory and point it to the buffer defined by `addr`, `len`, `data` and `data_len` arguments.
doca_error_t doca_buf_inventory_buf_by_data ( doca_buf_inventory* inventory, doca_mmap* mmap, void* data, size_t data_len, doca_buf** buf ): Allocate single element from buffer inventory and point it to the buffer defined by `data` & `data_len` arguments.
doca_error_t doca_buf_inventory_buf_dup ( doca_buf_inventory* inventory, const doca_buf* src_buf, doca_buf** dst_buf ): Duplicates content of the `buf` argument into element allocated from buffer inventory. (I.e., deep copy).
doca_error_t doca_buf_inventory_create ( const doca_data* user_data, size_t num_elements, uint32_t extensions, doca_buf_inventory** buf_inventory ): Allocates buffer inventory with default/unset attributes.
doca_error_t doca_buf_inventory_destroy ( doca_buf_inventory* inventory ): Destroy buffer inventory structure.
doca_error_t doca_buf_inventory_get_num_elements ( doca_buf_inventory* inventory, uint32_t* num_of_elements ): Read the total number of elements in a DOCA Inventory.
doca_error_t doca_buf_inventory_get_num_free_elements ( doca_buf_inventory* inventory, uint32_t* num_of_free_elements ): Get the total number of free elements in a DOCA Inventory.
doca_error_t doca_buf_inventory_get_user_data ( doca_buf_inventory* inventory, doca_data* user_data ): Get the user_data of a DOCA Inventory.
doca_error_t doca_buf_inventory_start ( doca_buf_inventory* inventory ): Start element retrieval from inventory.
doca_error_t doca_buf_inventory_stop ( doca_buf_inventory* inventory ): Stop element retrieval from inventory.

Functions

doca_error_t doca_buf_inventory_buf_by_addr ( doca_buf_inventory* inventory, doca_mmap* mmap, void* addr, size_t len, doca_buf** buf ) [inline]

Allocate single element from buffer inventory and point it to the buffer defined by `addr` & `len` arguments.

Parameters

inventory: The DOCA Buf inventory. MUST NOT BE NULL AND MUST BE STARTED.
mmap: DOCA memory map structure. MUST NOT BE NULL AND MUST BE STARTED.
addr: The start address of the payload. MUST NOT BE NULL.
len: The length in bytes of the payload.
buf: Doca buf allocated and initialized with args. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if there is no suitable memory range for the given address and length.
DOCA_ERROR_NO_MEMORY - if doca_buf_inventory is empty.

Description

doca_error_t doca_buf_inventory_buf_by_args ( doca_buf_inventory* inventory, doca_mmap* mmap, void* addr, size_t len, void* data, size_t data_len, doca_buf** buf )

Allocate single element from buffer inventory and point it to the buffer defined by `addr`, `len`, `data` and `data_len` arguments.

Parameters

inventory: The DOCA Buf inventory. MUST NOT BE NULL AND MUST BE STARTED.
mmap: DOCA memory map structure. MUST NOT BE NULL AND MUST BE STARTED.
addr: The start address of the buffer. MUST NOT BE NULL.
len: The length in bytes of the buffer.
data: The start address of the data inside the buffer. MUST NOT BE NULL.
data_len: The length in bytes of the data.
buf: Doca buf allocated and initialized with args. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - or if there is no suitable memory range for the given address and length.
DOCA_ERROR_NO_MEMORY - if doca_buf_inventory is empty.

Description

Note:

The range [data, data + data_len] must fit within [addr, addr +len]. Otherwise undefined behaviour.

doca_error_t doca_buf_inventory_buf_by_data ( doca_buf_inventory* inventory, doca_mmap* mmap, void* data, size_t data_len, doca_buf** buf ) [inline]

Allocate single element from buffer inventory and point it to the buffer defined by `data` & `data_len` arguments.

Parameters

inventory: The DOCA Buf inventory. MUST NOT BE NULL AND MUST BE STARTED.
mmap: DOCA memory map structure. MUST NOT BE NULL AND MUST BE STARTED.
data: The start address of the data inside the buffer. MUST NOT BE NULL.
data_len: The length in bytes of the data.
buf: Doca buf allocated and initialized with args. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - or if there is no suitable memory range for the given address and length.
DOCA_ERROR_NO_MEMORY - if doca_buf_inventory is empty.

Description

doca_error_t doca_buf_inventory_buf_dup ( doca_buf_inventory* inventory, const doca_buf* src_buf, doca_buf** dst_buf )

Duplicates content of the `buf` argument into element allocated from buffer inventory. (I.e., deep copy).

Parameters

inventory: Buffer inventory structure that will hold the new doca_buf.
src_buf: The DOCA buf to be duplicated.
dst_buf: A duplicate DOCA Buf.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if src_buf mmap or input inventory unstarted/stopped or src_buf inventory extensions and the input inventory extensions are incompatible.
DOCA_ERROR_NO_MEMORY - if cannot alloc new doca_buf from the given inventory.

Description

doca_error_t doca_buf_inventory_create ( const doca_data* user_data, size_t num_elements, uint32_t extensions, doca_buf_inventory** buf_inventory )

Allocates buffer inventory with default/unset attributes.

Parameters

user_data
num_elements: Initial number of elements in the inventory.
extensions: Bitmap of extensions enabled for the inventory described in doca_buf.h.
buf_inventory: Buffer inventory with default/unset attributes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_buf_inventory.

Description

doca_error_t doca_buf_inventory_destroy ( doca_buf_inventory* inventory )

Destroy buffer inventory structure.

Parameters

inventory: Buffer inventory structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if not all allocated elements had been returned to the inventory.

Description

Before calling this function all allocated elements should be returned back to the inventory.

doca_error_t doca_buf_inventory_get_num_elements ( doca_buf_inventory* inventory, uint32_t* num_of_elements )

Read the total number of elements in a DOCA Inventory.

Parameters

inventory: The DOCA Buf inventory.
num_of_elements: The total number of elements in inventory.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

The total number of elements type: uint32_t.

doca_error_t doca_buf_inventory_get_num_free_elements ( doca_buf_inventory* inventory, uint32_t* num_of_free_elements )

Get the total number of free elements in a DOCA Inventory.

Parameters

inventory: The DOCA Buf inventory.
num_of_free_elements: The total number of free elements in inventory.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

The total number of free elements type: uint32_t.

doca_error_t doca_buf_inventory_get_user_data ( doca_buf_inventory* inventory, doca_data* user_data )

Get the user_data of a DOCA Inventory.

Parameters

inventory: The DOCA Buf inventory.
user_data: The user_data of inventory.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

The user_data that was provided to the inventory upon its creation.

doca_error_t doca_buf_inventory_start ( doca_buf_inventory* inventory )

Start element retrieval from inventory.

Parameters

inventory: Buffer inventory structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Un-started/stopped buffer inventory rejects all attempts to retrieve element. On first start verifies & finalizes the buffer inventory object configuration.

The following become possible only after start:

Retrieval of free elements from the inventory using doca_buf_inventory_buf_by_addr().
Duplicating a buffer's content into a buffer allocated from the inventory using doca_buf_inventory_buf_dup().

The following are NOT possible after the first time start is called:

Setting the properties of the inventory using doca_buf_inventory_property_set().

doca_error_t doca_buf_inventory_stop ( doca_buf_inventory* inventory )

Stop element retrieval from inventory.

Parameters

inventory: Buffer inventory structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

No retrieval of elements with for stopped inventory. For details see doca_buf_inventory_start().

2.4.4. DOCA Bufpool

[Core]

Basic structure example of Bufpool (after creation):

Functions

doca_error_t doca_bufpool_buf_alloc ( doca_bufpool* bufpool, doca_buf** buf ): This method acquires a doca_buf from the doca_bufpool, pointing to an allocated empty buffer.
doca_error_t doca_bufpool_create ( const doca_data* user_data, size_t num_elements, uint32_t extensions, size_t element_size, size_t element_alignment, const doca_mmap* mmap, doca_bufpool** bufpool ): Allocates a bufpool and sets it with doca_buf objects that are set in advance with constant memory buffers.
doca_error_t doca_bufpool_destroy ( doca_bufpool* bufpool ): Destroy bufpool structure.
doca_error_t doca_bufpool_get_num_elements ( const doca_bufpool* bufpool, uint32_t* num_of_elements ): Get the number of elements that was set in the creation of a doca_bufpool.
doca_error_t doca_bufpool_get_num_free_elements ( const doca_bufpool* bufpool, uint32_t* num_of_free_elements ): Get the total number of free elements available for allocation in a doca_bufpool.
doca_error_t doca_bufpool_get_user_data ( const doca_bufpool* bufpool, doca_data* user_data ): Get the user_data of a DOCA Bufpool.
doca_error_t doca_bufpool_start ( doca_bufpool* bufpool ): Start DOCA bufpool.
doca_error_t doca_bufpool_stop ( doca_bufpool* bufpool ): Stop a started DOCA bufpool.

Functions

doca_error_t doca_bufpool_buf_alloc ( doca_bufpool* bufpool, doca_buf** buf )

This method acquires a doca_buf from the doca_bufpool, pointing to an allocated empty buffer.

Parameters

bufpool: The DOCA Bufpool from which to acquire a doca_buf, that was set to point to a memory buffer at doca_bufpool_create().
buf: Pointer to the allocated doca_buf.

Description

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if bufpool is un-started/stopped.
DOCA_ERROR_NO_MEMORY - if the bufpool is empty (all doca_bufs are already allocated).

doca_error_t doca_bufpool_create ( const doca_data* user_data, size_t num_elements, uint32_t extensions, size_t element_size, size_t element_alignment, const doca_mmap* mmap, doca_bufpool** bufpool )

Allocates a bufpool and sets it with doca_buf objects that are set in advance with constant memory buffers.

Parameters

user_data
num_elements: Number of elements in the bufpool (must be > 0).
extensions: Bitmap of extensions enabled for the bufpool described in doca_buf.h.
element_size: Size of a single element (must be > 0).
element_alignment: Element alignment requirement (must be a power of 2, can be 0).
mmap: The mmap managing the memory chunk. Must be populated with memory chunk.
bufpool: The newly created DOCA Bufpool.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - failed to allocate a doca_bufpool.
DOCA_ERROR_BAD_STATE - if no memory range was set to mmap.

Description

doca_error_t doca_bufpool_destroy ( doca_bufpool* bufpool )

Destroy bufpool structure.

Parameters

bufpool: The DOCA Bufpool to destroy.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_IN_USE - if not all allocated doca_bufs had been returned to the bufpool.

Description

Before calling this function, all allocated doca_bufs should be returned back to the bufpool.

doca_error_t doca_bufpool_get_num_elements ( const doca_bufpool* bufpool, uint32_t* num_of_elements )

Get the number of elements that was set in the creation of a doca_bufpool.

Parameters

bufpool: The DOCA Bufpool.
num_of_elements: The number of elements that was set in the creation of bufpool.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_bufpool_get_num_free_elements ( const doca_bufpool* bufpool, uint32_t* num_of_free_elements )

Get the total number of free elements available for allocation in a doca_bufpool.

Parameters

bufpool: The DOCA Bufpool.
num_of_free_elements: The total number of free elements in bufpool.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_bufpool_get_user_data ( const doca_bufpool* bufpool, doca_data* user_data )

Get the user_data of a DOCA Bufpool.

Parameters

bufpool: The DOCA Bufpool.
user_data: The user_data of bufpool.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

The user_data that was provided to the bufpool upon its creation.

doca_error_t doca_bufpool_start ( doca_bufpool* bufpool )

Start DOCA bufpool.

Parameters

bufpool: The DOCA Bufpool to start.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if the mmap with which the bufpool was created is not started.

Description

This method enables the allocation of doca_bufs using doca_bufpool_buf_alloc(). Before calling this function, the mmap with which the bufpool was created must be started.

doca_error_t doca_bufpool_stop ( doca_bufpool* bufpool )

Stop a started DOCA bufpool.

Parameters

bufpool: The DOCA Bufpool to stop.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

This method disables the allocation of doca_bufs. Calling this method is also possible if there are allocated doca_bufs.

2.4.5. DOCA Context

[Core]

Classes

struct doca_event: Activity completion event.
struct doca_job: Job structure describes request arguments for service provided by context.

Defines

#define DOCA_ACTION_SDK_RANGE 16: Power 2 single SDK/context action type range.

Functions

doca_error_t doca_ctx_dev_add ( doca_ctx* ctx, doca_dev* dev ): Add a device to a DOCA CTX.
doca_error_t doca_ctx_dev_rm ( doca_ctx* ctx, doca_dev* dev ): Remove a device from a context.
doca_error_t doca_ctx_get_event_driven_supported ( doca_ctx* ctx, uint8_t* event_supported ): Check if CTX supports event driven mode.
doca_error_t doca_ctx_get_max_num_ctx ( uint32_t* max_num_ctx ): Get the ctx maximum number of contexts allowed within an application.
doca_error_t doca_ctx_set_datapath_on_gpu ( doca_ctx* ctx, doca_gpu* gpu_dev ): This function binds the DOCA context to a gpu device.
doca_error_t doca_ctx_start ( doca_ctx* ctx ): Finalizes all configurations, and starts the DOCA CTX.
doca_error_t doca_ctx_stop ( doca_ctx* ctx ): Stops the context allowing reconfiguration.
doca_error_t doca_ctx_workq_add ( doca_ctx* ctx, doca_workq* workq ): Add a workQ to a context.
doca_error_t doca_ctx_workq_rm ( doca_ctx* ctx, doca_workq* workq ): Remove a DOCA WorkQ from a DOCA CTX.
doca_error_t doca_workq_create ( uint32_t depth, doca_workq** workq ): Creates empty DOCA WorkQ object with default attributes.
doca_error_t doca_workq_destroy ( doca_workq* workq ): Destroy a DOCA WorkQ.
doca_error_t doca_workq_event_handle_arm ( doca_workq* workq ): Arm the WorkQ to receive next completion event.
doca_error_t doca_workq_event_handle_clear ( doca_workq* workq, doca_event_handle_t handle ): Clear triggered events.
doca_error_t doca_workq_get_depth ( const doca_workq* workq, uint32_t* depth ): Get the maximum number of inflight jobs allowed for a DOCA workq.
doca_error_t doca_workq_get_event_driven_enable ( doca_workq* workq, uint8_t* enabled ): Check if WorkQ event-driven mode is enabled.
doca_error_t doca_workq_get_event_handle ( doca_workq* workq, doca_event_handle_t* handle ): Get the event handle for waiting on events.
doca_error_t doca_workq_progress_retrieve ( doca_workq* workq, doca_event* ev, int flags ): Progress & retrieve single pending event.
doca_error_t doca_workq_set_event_driven_enable ( doca_workq* workq, uint8_t enable ): Enable WorkQ event-driven mode.
doca_error_t doca_workq_set_event_handle ( doca_workq* workq, doca_event_handle_t event_handle, uintptr_t completion_key ): Set event handle This method is supported only for Windows. Windows uses io completion port that is created by the application and passed to the work queue. The work queue Uses the io completion port to register events.
doca_error_t doca_workq_submit ( doca_workq* workq, doca_job* job ): Submit a job to a DOCA WorkQ.

Defines

#define DOCA_ACTION_SDK_RANGE 16

Functions

doca_error_t doca_ctx_dev_add ( doca_ctx* ctx, doca_dev* dev )

Add a device to a DOCA CTX.

Parameters

ctx: The CTX to add the device to.
dev: The device to add.

Returns

DOCA_SUCCESS - In case of success. Error code - On failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - CTX is started.
DOCA_ERROR_IN_USE - the device was already added.
DOCA_ERROR_NOT_SUPPORTED - the provided device is not supported by CTX, I.e., the device is not useful for any job, missing the capabilities, or was opened using doca_dev_open_from_pd().
DOCA_ERROR_DRIVER - failed to interact with device.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

doca_error_t doca_ctx_dev_rm ( doca_ctx* ctx, doca_dev* dev )

Remove a device from a context.

Parameters

ctx: The CTX to remove the device from. Must already hold the device.
dev: The device to remove.

Returns

DOCA_SUCCESS - In case of success. Error code - On failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - CTX is started.
DOCA_ERROR_NOT_FOUND - the provided device was never added to the ctx or was already removed.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

doca_error_t doca_ctx_get_event_driven_supported ( doca_ctx* ctx, uint8_t* event_supported )

Check if CTX supports event driven mode.

Parameters

ctx: The library instance containing the WorkQ.
event_supported: Boolean indicating whether event driven mode is supported.

Returns

DOCA_SUCCESS - In case of success. Error code - on failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

In case the support exists, then this CTX can be added to WorkQ operating in event driven mode.

doca_error_t doca_ctx_get_max_num_ctx ( uint32_t* max_num_ctx )

Get the ctx maximum number of contexts allowed within an application.

Parameters

max_num_ctx: The ctx max number of contexts allowed within an application.

Returns

DOCA_SUCCESS - in case max_num_ctx received the required value properly. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - max_num_ctx is NULL.

Description

doca_error_t doca_ctx_set_datapath_on_gpu ( doca_ctx* ctx, doca_gpu* gpu_dev )

This function binds the DOCA context to a gpu device.

Parameters

ctx: The library instance.
gpu_dev: A pointer to a doca_gpu device.

Returns

DOCA_SUCCESS - In case of success. Error code - on failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - CTX is started.

Description

The data path will be executed on the device and not on the CPU.

doca_error_t doca_ctx_start ( doca_ctx* ctx )

Finalizes all configurations, and starts the DOCA CTX.

Parameters

ctx: The DOCA context to start.

Returns

DOCA_SUCCESS - In case of success. Error code - In case of failure:

DOCA_ERROR_INVALID_VALUE - either an invalid input was received or no devices were added to the CTX.
DOCA_ERROR_NOT_SUPPORTED - one of the provided devices is not supported by CTX.
DOCA_ERROR_INITIALIZATION - resource initialization failed (could be due to allocation failure), or the device is in a bad state or another reason caused initialization to fail.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

After starting the CTX, it can't be configured any further. Use doca_ctx_stop in order to reconfigure the CTX.

The following become possible only after start:

Adding WorkQ to CTX using doca_ctx_workq_add()
Removing WorkQ from CTX using doca_ctx_workq_rm()
Submitting a job using doca_workq_submit()

The following are NOT possible after start and become possible again after calling doca_ctx_stop:

Adding device to CTX using doca_ctx_dev_add()
Removing device from CTX using doca_ctx_dev_rm()
Binding gpu device to CTX using doca_ctx_set_datapath_on_gpu()

doca_error_t doca_ctx_stop ( doca_ctx* ctx )

Stops the context allowing reconfiguration.

Parameters

ctx: The DOCA context to stop.

Returns

DOCA_SUCCESS - In case of success. Error code - In case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_PERMITTED - either some jobs are still pending or not all WorkQs have been removed.
DOCA_ERROR_IN_USE - some workqs are still associated with the ctx.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

Once a context has started, it can't be configured any further. This method should be called in case the context needs to be configured after starting. For more details see doca_ctx_start().

doca_error_t doca_ctx_workq_add ( doca_ctx* ctx, doca_workq* workq )

Add a workQ to a context.

Parameters

ctx: The library instance that will handle the jobs.
workq: The WorkQ where you want to receive job completions.

Returns

DOCA_SUCCESS - In case of success. Error code - on failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - CTX is not started.
DOCA_ERROR_IN_USE - same WorkQ already added.
DOCA_ERROR_NO_MEMORY - memory allocation failed.
DOCA_ERROR_INITIALIZATION - initialization of WorkQ failed.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

doca_error_t doca_ctx_workq_rm ( doca_ctx* ctx, doca_workq* workq )

Remove a DOCA WorkQ from a DOCA CTX.

Parameters

ctx: The library instance containing the WorkQ.
workq: The WorkQ to remove.

Returns

DOCA_SUCCESS - In case of success. Error code - on failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - CTX is not started.
DOCA_ERROR_NOT_PERMITTED - some jobs are still pending completion.
DOCA_ERROR_NOT_FOUND - WorkQ does not exist within CTX.
DOCA_ERROR_IN_USE - WorkQ contains inflight jobs.
DOCA_ERROR_UNEXPECTED - ctx is corrupted.

Description

This function can only be used after CTX is started (doca_ctx_start()).

doca_error_t doca_workq_create ( uint32_t depth, doca_workq** workq )

Creates empty DOCA WorkQ object with default attributes.

Parameters

depth: The maximum number of inflight jobs.
workq: The newly created WorkQ.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - invalid input received.
DOCA_ERROR_NO_MEMORY - failed to allocate WorkQ.

Description

The returned WorkQ needs to be added to at least one DOCA CTX. Then the WorkQ can be used to progress jobs and to poll events exposed by the associated CTX.

doca_error_t doca_workq_destroy ( doca_workq* workq )

Destroy a DOCA WorkQ.

Parameters

workq: The WorkQ to destroy.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - invalid input received.
DOCA_ERROR_IN_USE - WorkQ not removed from one of the doca_ctx.

Description

In order to destroy a WorkQ, at first needs to be removed from all DOCA CTXs using it.

doca_error_t doca_workq_event_handle_arm ( doca_workq* workq )

Arm the WorkQ to receive next completion event.

Parameters

workq: The WorkQ object to arm. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - workq has been successfully armed, event handle can be used to wait on events.

Description

Note:

event driven mode must be active by using doca_workq_set_event_driven_enable(). Otherwise undefined behaviour.

doca_error_t doca_workq_event_handle_clear ( doca_workq* workq, doca_event_handle_t handle )

Clear triggered events.

Parameters

workq: The WorkQ object that received the events. MUST NOT BE NULL.
handle: workq event handle.

Returns

DOCA_SUCCESS - on successfuly clearing triggered events.
DOCA_ERROR_OPERATING_SYSTEM - a system call has failed.

Description

Note:

event driven mode must be active by using doca_workq_set_event_driven_enable(). Otherwise undefined behaviour.

doca_error_t doca_workq_get_depth ( const doca_workq* workq, uint32_t* depth )

Get the maximum number of inflight jobs allowed for a DOCA workq.

Parameters

workq: The DOCA WorkQ.
depth: The maximum number of inflight jobs allowed for workq.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_workq_get_event_driven_enable ( doca_workq* workq, uint8_t* enabled )

Check if WorkQ event-driven mode is enabled.

Parameters

workq: The WorkQ to query.
enabled: 0 or 1 indicating if event-driven mode is enabled.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Event-driven mode is not enabled by default. It is possible to enable it by setting this porperty to 1. Using doca_workq_set_event_driven_enable()

doca_error_t doca_workq_get_event_handle ( doca_workq* workq, doca_event_handle_t* handle )

Get the event handle for waiting on events.

Parameters

workq: The WorkQ to query.
handle: The event handle of the WorkQ.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - event driven mode is not enabled. Try doca_workq_set_event_driven_enable().

Description

Calling this for the first time will enable event-driven mode for the WorkQ. Retrieves the event handle of the WorkQ, the handle does not change throughout the lifecycle of the WorkQ.

doca_error_t doca_workq_progress_retrieve ( doca_workq* workq, doca_event* ev, int flags )

Progress & retrieve single pending event.

Parameters

workq: The WorkQ object to poll for events. MUST NOT BE NULL.
ev: Event structure to be filled in case an event was received. MUST NOT BE NULL
flags: Flags for progress/retrival operations. A combination of enum doca_workq_retrieve_flags.

Returns

DOCA_SUCCESS - on successful event retrieval. ev output argument is set.
DOCA_ERROR_AGAIN - no event available (ev output argument not set), try again to make more progress.
DOCA_ERROR_IO_FAILED - the retrieved event is a failure event. The specific error is reported per action type.

Description

Polling method for progress of submitted jobs and retrieval of events.

NOTE: for V1 retrieve supported for single event only.

doca_error_t doca_workq_set_event_driven_enable ( doca_workq* workq, uint8_t enable )

Enable WorkQ event-driven mode.

Parameters

workq: The WorkQ to query.
enable: 0 or 1 indicating whether to enable event-driven mode or not.

Returns

DOCA_SUCCESS - in case event driven mode has been set, or is already set to same value. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - workq is still added to at least 1 CTX.
DOCA_ERROR_OPERATING_SYSTEM - a system call has failed.

Description

Event-driven mode is not enabled by default. Once enabled, the doca_workq_handle_* APIs can be used in order to wait on events. This mode can only be enabled before adding the WorkQ to any CTX.

doca_error_t doca_workq_set_event_handle ( doca_workq* workq, doca_event_handle_t event_handle, uintptr_t completion_key )

Parameters

workq: The work queue to set
event_handle: The IO completion port to register to
completion_key: Completion key facilitates finding the source of the event.

Returns

DOCA_SUCCESS - in case event driven mode has been set, or is already set to same value. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - used in non Windows OS.
DOCA_ERROR_OPERATING_SYSTEM - a system call has failed.

Description

doca_error_t doca_workq_submit ( doca_workq* workq, doca_job* job )

Submit a job to a DOCA WorkQ.

Parameters

workq: The DOCA WorkQ used for progress and retrieval of jobs. MUST NOT BE NULL.
job: The job to submit, the job must be compatible with the WorkQ. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case the job was submitted successfully, doca_workq_progress_retrieve() can be called next. Error code - in case of failure:

DOCA_ERROR_BAD_STATE - in case job->ctx is stopped.
DOCA_ERROR_NOT_FOUND - in case the ctx is not associated to the workQ.
DOCA_ERROR_NO_MEMORY - in case the workQ is full. Maximum number of inflight jobs.

Description

Note:

job->ctx must not be NULL, must be started and associated with the workq. Otherwise undefined behaviour.

2.4.6. DOCA Device

[Core]

The DOCA device represents an available processing unit backed by the HW or SW implementation.

Defines

#define DOCA_DEVINFO_PCI_ADDR_SIZE 13: Format: "XXXX:XX:XX.X". Including a null terminator.
#define DOCA_DEVINFO_PCI_BDF_SIZE 8: Format: "XX:XX.X". Including a null terminator.
#define DOCA_DEVINFO_REP_PCI_ADDR_SIZE 13: Format: "XXXX:XX:XX.X". Including a null terminator.
#define DOCA_DEVINFO_REP_PCI_BDF_SIZE 8: Format: "XX:XX.X". Including a null terminator.

Enumerations

enum doca_dev_rep_filter

Functions

__DOCA_EXPERIMENTAL doca_devinfo* doca_dev_as_devinfo ( const doca_dev* dev ): Get local device info from device. This should be useful when wanting to query information about device after opening it, and destroying the devinfo list.
doca_error_t doca_dev_close ( doca_dev* dev ): Destroy allocated local device instance.
doca_error_t doca_dev_open ( doca_devinfo* devinfo, doca_dev** dev ): Initialize local device for use.
__DOCA_EXPERIMENTAL doca_devinfo_rep* doca_dev_rep_as_devinfo ( doca_dev_rep* dev_rep ): Get representor device info from device. This should be useful when wanting to query information about device after opening it, and destroying the devinfo list.
doca_error_t doca_dev_rep_close ( doca_dev_rep* dev ): Destroy allocated representor device instance.
doca_error_t doca_dev_rep_open ( doca_devinfo_rep* devinfo, doca_dev_rep** dev_rep ): Initialize representor device for use.
doca_error_t doca_devinfo_get_ibdev_name ( const doca_devinfo* devinfo, char* ibdev_name, uint32_t size ): Get the name of the IB device represented by a DOCA devinfo.
doca_error_t doca_devinfo_get_iface_name ( const doca_devinfo* devinfo, char* iface_name, uint32_t size ): Get the name of the ethernet interface of a DOCA devinfo.
doca_error_t doca_devinfo_get_ipv4_addr ( const doca_devinfo* devinfo, uint8_t* ipv4_addr, uint32_t size ): Get the IPv4 address of a DOCA devinfo.
doca_error_t doca_devinfo_get_ipv6_addr ( const doca_devinfo* devinfo, uint8_t* ipv6_addr, uint32_t size ): Get the IPv6 address of a DOCA devinfo.
doca_error_t doca_devinfo_get_is_hotplug_manager_supported ( const doca_devinfo* devinfo, uint8_t* is_hotplug_manager ): Get the hotplug manager capability of a DOCA devinfo.
doca_error_t doca_devinfo_get_is_mmap_export_dpu_supported ( const doca_devinfo* devinfo, uint8_t* mmap_export ): Get the mmap export to DPU capability of the device.
doca_error_t doca_devinfo_get_is_mmap_from_export_dpu_supported ( const doca_devinfo* devinfo, uint8_t* from_export ): Get the mmap create from export DPU capability of the device.
doca_error_t doca_devinfo_get_is_pci_addr_equal ( const doca_devinfo* devinfo, const char* pci_addr_str, uint8_t* is_equal ): Check if a PCI address belongs to a DOCA devinfo.
doca_error_t doca_devinfo_get_lid ( const doca_devinfo* devinfo, uint16_t* lid ): Get the port LID of a DOCA devinfo.
doca_error_t doca_devinfo_get_mac_addr ( const doca_devinfo* devinfo, uint8_t* mac_addr, uint32_t size ): Get the MAC address of a DOCA devinfo.
doca_error_t doca_devinfo_get_pci_addr_str ( const doca_devinfo* devinfo, char* pci_addr_str ): Get the PCI address of a DOCA devinfo.
doca_error_t doca_devinfo_list_create ( doca_devinfo*** dev_list, uint32_t* nb_devs ): Creates list of all available local devices.
doca_error_t doca_devinfo_list_destroy ( doca_devinfo** dev_list ): Destroy list of local device info structures.
doca_error_t doca_devinfo_rep_get_is_list_all_supported ( const doca_devinfo* devinfo, uint8_t* all_supported ): Get the representor devices discovery capability of the device.
doca_error_t doca_devinfo_rep_get_is_list_emulated_supported ( const doca_devinfo* devinfo, uint8_t* emulated_supported ): Get the remote emulated device discovery capability of the device.
doca_error_t doca_devinfo_rep_get_is_list_net_supported ( const doca_devinfo* devinfo, uint8_t* net_supported ): Get the remote net discovery capability of the device.
doca_error_t doca_devinfo_rep_get_is_pci_addr_equal ( const doca_devinfo_rep* devinfo_rep, const char* pci_addr_str, uint8_t* is_equal ): Check if a PCI address belongs to a DOCA devinfo_rep.
doca_error_t doca_devinfo_rep_get_pci_addr_str ( const doca_devinfo_rep* devinfo_rep, char* pci_addr_str ): Get the PCI address of a DOCA devinfo_rep.
doca_error_t doca_devinfo_rep_get_pci_func_type ( const doca_devinfo_rep* devinfo_rep, doca_pci_func_type ** pci_func_type ): Get the PCI function type of a DOCA devinfo_rep.
doca_error_t doca_devinfo_rep_get_vuid ( const doca_devinfo_rep* devinfo_rep, char* rep_vuid, uint32_t size ): Get the Vendor Unique ID of a representor DOCA devinfo.
doca_error_t doca_devinfo_rep_list_create ( doca_dev* dev, int filter, doca_devinfo_rep*** dev_list_rep, uint32_t* nb_devs_rep ): Create list of available representor devices accessible by dev.
doca_error_t doca_devinfo_rep_list_destroy ( doca_devinfo_rep** dev_list_rep ): Destroy list of representor device info structures.

Defines

#define DOCA_DEVINFO_PCI_ADDR_SIZE 13
#define DOCA_DEVINFO_PCI_BDF_SIZE 8
#define DOCA_DEVINFO_REP_PCI_ADDR_SIZE 13
#define DOCA_DEVINFO_REP_PCI_BDF_SIZE 8

Enumerations

enum doca_dev_rep_filter

Representor device filter by flavor

Multiple options possible but some are mutually exclusive.

Values

DOCA_DEV_REP_FILTER_ALL = 0
DOCA_DEV_REP_FILTER_NET = 1<<1
DOCA_DEV_REP_FILTER_EMULATED = 1<<2

Functions

__DOCA_EXPERIMENTAL doca_devinfo* doca_dev_as_devinfo ( const doca_dev* dev )

Get local device info from device. This should be useful when wanting to query information about device after opening it, and destroying the devinfo list.

Parameters

dev: The doca device instance.

Returns

The matching doca_devinfo instance in case of success, NULL in case dev is invalid or was created by doca_dev_open_from_pd().

Description

doca_error_t doca_dev_close ( doca_dev* dev )

Destroy allocated local device instance.

Parameters

dev: The local doca device instance.

Returns

DOCA_SUCCESS - in case of success.

DOCA_ERROR_IN_USE - failed to deallocate device resources.

Description

doca_error_t doca_dev_open ( doca_devinfo* devinfo, doca_dev** dev )

Initialize local device for use.

Parameters

devinfo: The devinfo structure of the requested device.
dev: Initialized local doca device instance on success. Valid on success only.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - failed to allocate protection domain for device.
DOCA_ERROR_NOT_CONNECTED - failed to open device.
DOCA_ERROR_INITIALIZATION - maximum number of open devices was exceeded.

Description

Note:

In case the same device was previously opened, then the same doca_dev instance is returned.

__DOCA_EXPERIMENTAL doca_devinfo_rep* doca_dev_rep_as_devinfo ( doca_dev_rep* dev_rep )

Get representor device info from device. This should be useful when wanting to query information about device after opening it, and destroying the devinfo list.

Parameters

dev_rep: The representor doca device instance.

Returns

The matching doca_devinfo_rep instance in case of success, NULL in case dev_rep is invalid.

Description

doca_error_t doca_dev_rep_close ( doca_dev_rep* dev )

Destroy allocated representor device instance.

Parameters

dev: The representor doca device instance.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - failed to deallocate device resources.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

doca_error_t doca_dev_rep_open ( doca_devinfo_rep* devinfo, doca_dev_rep** dev_rep )

Initialize representor device for use.

Parameters

devinfo: The devinfo structure of the requested device.
dev_rep: Initialized representor doca device instance on success. Valid on success only.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - failed to allocate memory for device.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

doca_error_t doca_devinfo_get_ibdev_name ( const doca_devinfo* devinfo, char* ibdev_name, uint32_t size )

Get the name of the IB device represented by a DOCA devinfo.

Parameters

devinfo: The device to query.
ibdev_name: The name of the IB device represented by devinfo.
size: The size of the input ibdev_name buffer, must be at least DOCA_DEVINFO_IBDEV_NAME_SIZE which includes the null terminating byte.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

The name of the IB device type: char[DOCA_DEVINFO_IBDEV_NAME_SIZE].

doca_error_t doca_devinfo_get_iface_name ( const doca_devinfo* devinfo, char* iface_name, uint32_t size )

Get the name of the ethernet interface of a DOCA devinfo.

Parameters

devinfo: The device to query.
iface_name: The name of the ethernet interface of devinfo.
size: The size of the input iface_name buffer, must be at least DOCA_DEVINFO_IFACE_NAME_SIZE which includes the null terminating byte.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the interface name from the OS

Description

The name of the ethernet interface is the same as it's name in ifconfig. The name of the ethernet interface type: char[DOCA_DEVINFO_IFACE_NAME_SIZE].

doca_error_t doca_devinfo_get_ipv4_addr ( const doca_devinfo* devinfo, uint8_t* ipv4_addr, uint32_t size )

Get the IPv4 address of a DOCA devinfo.

Parameters

devinfo: The device to query.
ipv4_addr: The IPv4 address of devinfo.
size: The size of the input ipv4_addr buffer, must be at least DOCA_DEVINFO_IPV4_ADDR_SIZE

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the IPv4 address from the OS

Description

The IPv4 address type: uint8_t[DOCA_DEVINFO_IPV4_ADDR_SIZE].

doca_error_t doca_devinfo_get_ipv6_addr ( const doca_devinfo* devinfo, uint8_t* ipv6_addr, uint32_t size )

Get the IPv6 address of a DOCA devinfo.

Parameters

devinfo: The device to query.
ipv6_addr: The IPv6 address of devinfo.
size: The size of the input ipv6_addr buffer, must be at least DOCA_DEVINFO_IPV6_ADDR_SIZE

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the IPv6 address from the OS

Description

The IPv6 address type: uint8_t[DOCA_DEVINFO_IPV6_ADDR_SIZE].

doca_error_t doca_devinfo_get_is_hotplug_manager_supported ( const doca_devinfo* devinfo, uint8_t* is_hotplug_manager )

Get the hotplug manager capability of a DOCA devinfo.

Parameters

devinfo: The device to query.
is_hotplug_manager: 1 if the hotplug manager capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

The hotplug manager property type: uint8_t*.

doca_error_t doca_devinfo_get_is_mmap_export_dpu_supported ( const doca_devinfo* devinfo, uint8_t* mmap_export )

Get the mmap export to DPU capability of the device.

Parameters

devinfo: The device to query.
mmap_export: 1 if the mmap export capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

doca_error_t doca_devinfo_get_is_mmap_from_export_dpu_supported ( const doca_devinfo* devinfo, uint8_t* from_export )

Get the mmap create from export DPU capability of the device.

Parameters

devinfo: The device to query.
from_export: 1 if the mmap from export DPU capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

doca_error_t doca_devinfo_get_is_pci_addr_equal ( const doca_devinfo* devinfo, const char* pci_addr_str, uint8_t* is_equal )

Check if a PCI address belongs to a DOCA devinfo.

Parameters

devinfo

The device to query.

pci_addr_str

The PCI address to check, should be as one of the following formats:

"Domain:Bus:Device.Function", e.g., "0000:83:00.0" (size DOCA_DEVINFO_PCI_ADDR_SIZE including a null terminator).
"Bus:Device.Function", e.g., "83:00.0" (size DOCA_DEVINFO_PCI_BDF_SIZE including a null terminator).

is_equal

1 if pci_addr_str belongs to devinfo, 0 otherwise. In case of an error, no certain value is guaranteed.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the actual PCI address from the OS for comparison.

Description

doca_error_t doca_devinfo_get_lid ( const doca_devinfo* devinfo, uint16_t* lid )

Get the port LID of a DOCA devinfo.

Parameters

devinfo: The device to query.
lid: The port LID of devinfo.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query port LID.
DOCA_ERROR_NOT_SUPPORTED - the device port's link layer is not IB.

Description

The port LID type: uint16_t *.

doca_error_t doca_devinfo_get_mac_addr ( const doca_devinfo* devinfo, uint8_t* mac_addr, uint32_t size )

Get the MAC address of a DOCA devinfo.

Parameters

devinfo: The device to query.
mac_addr: The MAC address of devinfo.
size: The size of the input mac_addr buffer, must be at least DOCA_DEVINFO_MAC_ADDR_SIZE

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - the device port's link layer is not RoCE.

Description

The MAC address type: uint8_t[DOCA_DEVINFO_MAC_ADDR_SIZE].

doca_error_t doca_devinfo_get_pci_addr_str ( const doca_devinfo* devinfo, char* pci_addr_str )

Get the PCI address of a DOCA devinfo.

Parameters

devinfo: The device to query.
pci_addr_str: The PCI address of devinfo, should be of size DOCA_DEVINFO_PCI_ADDR_SIZE at least.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the PCI address from the OS

Description

The PCI address string format is "Domain:Bus:Device.Function", e.g., "0000:83:00.0".

doca_error_t doca_devinfo_list_create ( doca_devinfo*** dev_list, uint32_t* nb_devs )

Creates list of all available local devices.

Parameters

dev_list: Pointer to array of pointers. Output can then be accessed as follows (*dev_list)[idx].
nb_devs: Number of available local devices.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - failed to allocate enough space.
DOCA_ERROR_NOT_FOUND - failed to get RDMA devices list

Description

Note:

Returned list must be destroyed using doca_devinfo_list_destroy()

doca_error_t doca_devinfo_list_destroy ( doca_devinfo** dev_list )

Destroy list of local device info structures.

Parameters

dev_list: List to be destroyed.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - at least one device in the list is in a corrupted state.

Description

Destroys the list of device information, once the list has been destroyed, all elements become invalid.

doca_error_t doca_devinfo_rep_get_is_list_all_supported ( const doca_devinfo* devinfo, uint8_t* all_supported )

Get the representor devices discovery capability of the device.

Parameters

devinfo: The device to query.
all_supported: 1 if the rep list all capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

doca_error_t doca_devinfo_rep_get_is_list_emulated_supported ( const doca_devinfo* devinfo, uint8_t* emulated_supported )

Get the remote emulated device discovery capability of the device.

Parameters

devinfo: The device to query.
emulated_supported: 1 if the list emulated capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

doca_error_t doca_devinfo_rep_get_is_list_net_supported ( const doca_devinfo* devinfo, uint8_t* net_supported )

Get the remote net discovery capability of the device.

Parameters

devinfo: The device to query.
net_supported: 1 if the rep list net capability is supported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query capability support.

Description

doca_error_t doca_devinfo_rep_get_is_pci_addr_equal ( const doca_devinfo_rep* devinfo_rep, const char* pci_addr_str, uint8_t* is_equal )

Check if a PCI address belongs to a DOCA devinfo_rep.

Parameters

devinfo_rep

The representor of device to query.

pci_addr_str

The PCI address to check, should be as one of the following formats:

"Domain:Bus:Device.Function", e.g., "0000:83:00.0" (size DOCA_DEVINFO_PCI_ADDR_SIZE including a null terminator).
"Bus:Device.Function", e.g., "83:00.0" (size DOCA_DEVINFO_PCI_BDF_SIZE including a null terminator).

is_equal

1 if pci_addr_str belongs to devinfo_rep, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()
DOCA_ERROR_NO_MEMORY - not enough memory to generate devinfo_rep PCI address for comparison.
DOCA_ERROR_UNEXPECTED - an unexpected error occurred.

Description

doca_error_t doca_devinfo_rep_get_pci_addr_str ( const doca_devinfo_rep* devinfo_rep, char* pci_addr_str )

Get the PCI address of a DOCA devinfo_rep.

Parameters

devinfo_rep: The device to query.
pci_addr_str: The PCI address of devinfo_rep, should be of size DOCA_DEVINFO_REP_PCI_ADDR_SIZE at least.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()
DOCA_ERROR_NO_MEMORY - not enough memory to generate the stringed PCI address.
DOCA_ERROR_UNEXPECTED - an unexpected error occurred.

Description

The PCI address string format is "Domain:Bus:Device.Function", e.g., "0000:83:00.0".

doca_error_t doca_devinfo_rep_get_pci_func_type ( const doca_devinfo_rep* devinfo_rep, doca_pci_func_type ** pci_func_type )

Get the PCI function type of a DOCA devinfo_rep.

Parameters

devinfo_rep: The representor of device to query.
pci_func_type: The PCI function type of the devinfo_rep.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

The pci function type: enum doca_pci_func_type.

doca_error_t doca_devinfo_rep_get_vuid ( const doca_devinfo_rep* devinfo_rep, char* rep_vuid, uint32_t size )

Get the Vendor Unique ID of a representor DOCA devinfo.

Parameters

devinfo_rep: The representor device to query.
rep_vuid: The Vendor Unique ID of devinfo_rep.
size: The size of the vuid buffer, including the terminating null byte ('').

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

The Vendor Unique ID is used as stable ID of a VF/PF. The Vendor Unique ID type: char[DOCA_DEVINFO_VUID_SIZE].

doca_error_t doca_devinfo_rep_list_create ( doca_dev* dev, int filter, doca_devinfo_rep*** dev_list_rep, uint32_t* nb_devs_rep )

Create list of available representor devices accessible by dev.

Parameters

dev: Local device with access to representors.
filter: Bitmap filter of representor types. See enum doca_dev_rep_filter for more details.
dev_list_rep: Pointer to array of pointers. Output can then be accessed as follows (*dev_list_rep)[idx].
nb_devs_rep: Number of available representor devices.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - failed to allocate memory for list.
DOCA_ERROR_DRIVER - Failed to query driver.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

Note:

Returned list must be destroyed using doca_devinfo_rep_list_destroy()

doca_error_t doca_devinfo_rep_list_destroy ( doca_devinfo_rep** dev_list_rep )

Destroy list of representor device info structures.

Parameters

dev_list_rep: List to be destroyed.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - the doca_dev that created the list is in a corrupted state.
DOCA_ERROR_NOT_SUPPORTED - local device does not expose representor devices, or dev was created by doca_dev_open_from_pd()

Description

Destroy list of representor device information, once the list has been destroyed, all elements of the list are considered invalid.

2.4.7. DOCA DPDK

[Core]

DOCA API for integration with DPDK.

Functions

doca_error_t doca_dpdk_mempool_create ( const rte_mempool* mbuf_pool, doca_dpdk_mempool** mempool_out ): Create a DOCA DPDK memory pool, with ability to convert rte_mbuf to doca_buf Expected flow is as follows: Control path: // Create the memory pool based on a DPDK memory pool doca_dpdk_mempool_create() // Add 1 or more DOCA devices doca_dpdk_mempool_dev_add() // Set permission level across all devices (default=LOCAL_READ/WRITE) doca_dpdk_mempool_set_permissions() // Start the pool doca_dpdk_mempool_start().
doca_error_t doca_dpdk_mempool_destroy ( doca_dpdk_mempool* mempool ): Destroy a DOCA DPDK memory pool Before destroying need to make sure that all buffers that were acquired using doca_dpdk_mempool_mbuf_to_buf() have been released This must be called before destroying the originating DPDK mempool.
doca_error_t doca_dpdk_mempool_dev_add ( doca_dpdk_mempool* mempool, doca_dev* dev ): Add a DOCA device to the mempool This allows the DOCA bufs that are retrieved from the pool to be compatible with other DOCA libraries, that use the DOCA device.
doca_error_t doca_dpdk_mempool_mbuf_to_buf ( doca_dpdk_mempool* mempool, doca_buf_inventory* inventory, rte_mbuf* mbuf, doca_buf** buf ): Acquire a doca_buf based on an rte_mbuf The acquired doca_buf attempts to be as similar as possible to the rte_mbuf Level of support:After acquiring the buffer the refcount of the mbuf is increasedIn case mbuf is indirect refcount of the direct buffer is increased instead and metadata of the indirectmbuf is used where metdata refers to the mbuf's data offset, data length, and next pointerIn case the acquired doca_buf is duplicated, then the duplication process will increase the refcount of the direct mbufs as well Limitations:The mbuf must represent memory from the originating rte_mempool associated with this mempool and mbuf cannot be created from external memoryAny changes made to the rte_mbuf after the acquisition will not affect the doca_bufAny changes made to the doca_buf after acquisition will not affect the rte_mbuf.
doca_error_t doca_dpdk_mempool_set_permissions ( doca_dpdk_mempool* mempool, uint32_t access_mask ): Set the read/write permissions of the memory for devices Default: DOCA_ACCESS_LOCAL_READ_WRITE Setting the permission will set the access that the added devices have over the memory of the DOCA buffers.
doca_error_t doca_dpdk_mempool_start ( doca_dpdk_mempool* mempool ): Start the DOCA DPDK memory pool Operations that must be done before start: Adding at least 1 device - doca_dpdk_mempool_dev_add() Optionally, setting the permission level - doca_dpdk_mempool_set_permissions() Operations that are allowed after start: Acquiring a matching doca_buf from an rte_mbuf - doca_dpdk_mempool_mbuf_to_buf() Destroying the DOCA DPDK memory pool - doca_dpdk_mempool_destroy().
doca_error_t doca_dpdk_port_as_dev ( uint16_t port_id, doca_dev** dev ): Return the DOCA device associated with a DPDK port.
doca_error_t doca_dpdk_port_probe ( doca_dev* dev, const char* devargs ): Attach a DPDK port specified by DOCA device.

Functions

doca_error_t doca_dpdk_mempool_create ( const rte_mempool* mbuf_pool, doca_dpdk_mempool** mempool_out )

Parameters

mbuf_pool: A DPDK pool of mbufs, created with rte_pktmbuf_pool_create*()
mempool_out: The newly created DOCA DPDK memory pool in case of success

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.

Description

doca_error_t doca_dpdk_mempool_destroy ( doca_dpdk_mempool* mempool )

Parameters

mempool: The DOCA DPDK memory pool to destroy

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_IN_USE - at least 1 DOCA buf has been acquired and still not released

Description

Note:

: Once destroyed the originating DPDK memory pool, and any allocated RTE mbuf are not affected

doca_error_t doca_dpdk_mempool_dev_add ( doca_dpdk_mempool* mempool, doca_dev* dev )

Add a DOCA device to the mempool This allows the DOCA bufs that are retrieved from the pool to be compatible with other DOCA libraries, that use the DOCA device.

Parameters

mempool: The DOCA DPDK memory pool to add the device to
dev: A DOCA device instance

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_NO_MEMORY - out of memory.

Description

Note:

Once device has been added it can't be removed. Only option is to destroy the doca_dpdk_mempool

doca_error_t doca_dpdk_mempool_mbuf_to_buf ( doca_dpdk_mempool* mempool, doca_buf_inventory* inventory, rte_mbuf* mbuf, doca_buf** buf )

Parameters

mempool: The DOCA DPDK memory pool created using the rte_mempool that created the rte_mbuf
inventory: A DOCA Buffer Inventory to be used for allocating the doca_buf. Must be started and have enough space
mbuf: A DPDK buffer that references memory that is within the RTE mempool associated with the DOCA DPDK mempool
buf: A DOCA buffer that references the same memory as the provided mbuf

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_NO_MEMORY - The inventory does not have enough free elements.

Description

doca_buf created after calling this method:

Note:

: Destroying the doca_buf using 'doca_buf_refcount_rm()' will call 'rte_pktmbuf_free_seg()' on each direct mbuf

doca_error_t doca_dpdk_mempool_set_permissions ( doca_dpdk_mempool* mempool, uint32_t access_mask )

Parameters

mempool: The DOCA DPDK memory pool
access_mask: The access permissions - see 'enum doca_access_flags'

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input or bad access flag combination.

Description

Note:

: setting DOCA_ACCESS_DPU_* flags is invalid

doca_error_t doca_dpdk_mempool_start ( doca_dpdk_mempool* mempool )

Parameters

mempool: The DOCA DPDK memory pool to add the device to

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_NO_MEMORY - out of memory.

Description

doca_error_t doca_dpdk_port_as_dev ( uint16_t port_id, doca_dev** dev )

Return the DOCA device associated with a DPDK port.

Parameters

port_id: The DPDK port identifier to get the associated DOCA device for.
dev: The DPDK DOCA device associated with the given DPDK port identifier.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_NOT_FOUND - in case there is no such DPDK port associated with a DOCA device.

Description

doca_error_t doca_dpdk_port_probe ( doca_dev* dev, const char* devargs )

Attach a DPDK port specified by DOCA device.

Parameters

dev: DOCA device to attach PDK port for.
devargs: DPDK devargs style - must NOT contains the device's PCI address ([domain:]bus:devid.func).

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_DRIVER - in case of DPDK error during DPDK port attach.
DOCA_ERROR_NO_MEMORY - in case of memory allocation failure.

Description

Thread unsafe API.

It's the user responsibility to set the DPDK EAL initialization to skip probing the PCI device associated with the given DOCA device to prevent EAL from using it.

No initialization is done for the probed PDPK port and the port is not started.

2.4.8. DOCA Error

[Core]

DOCA Error provides information regarding different errors caused while using the DOCA libraries.

Defines

#define DOCA_ERROR_PROPAGATE ( r, t ): Save the first encountered doca_error_t.
#define DOCA_IS_ERROR ( r ): Compiler optimized macro to check if we have an error.

Functions

const __DOCA_EXPERIMENTAL char* doca_get_error_name ( doca_error_t error ): Returns the string representation of an error code name.
const __DOCA_EXPERIMENTAL char* doca_get_error_string ( doca_error_t error ): Returns the description string of an error code.

Defines

#define DOCA_ERROR_PROPAGATE ( r, t )

Updates the return value variable r to hold the first error that we encountered.

Value

do { \ if (r == DOCA_SUCCESS) \ r = t; \ } while(0)

#define DOCA_IS_ERROR ( r )

Used in cases where error is unlikely to happen.

Value

doca_unlikely((r) != DOCA_SUCCESS)

Functions

const __DOCA_EXPERIMENTAL char* doca_get_error_name ( doca_error_t error )

Returns the string representation of an error code name.

Parameters

error: - Error code to convert to string.

Returns

char* pointer to a NULL-terminated string.

Description

Returns a string containing the name of an error code in the enum. If the error code is not recognized, "unrecognized error code" is returned.

const __DOCA_EXPERIMENTAL char* doca_get_error_string ( doca_error_t error )

Returns the description string of an error code.

Parameters

error: - Error code to convert to description string.

Returns

char* pointer to a NULL-terminated string.

Description

This function returns the description string of an error code. If the error code is not recognized, "unrecognized error code" is returned.

2.4.9. DOCA Memory Map

[Core]

The DOCA memory map provides a centralized repository and orchestration of several memory ranges registration for each device attached to the memory map.

Typedefs

typedef void( doca_mmap_memrange_free_cb_t: Function to be called for each populated memory range on memory map destroy.

Functions

doca_error_t doca_mmap_create ( const doca_data* user_data, doca_mmap** mmap ): Allocates zero size memory map object with default/unset attributes.
doca_error_t doca_mmap_create_from_export ( const doca_data* user_data, const void* export_desc, size_t export_desc_len, doca_dev* dev, doca_mmap** mmap ): Creates a memory map object representing memory ranges in remote system memory space.
doca_error_t doca_mmap_destroy ( doca_mmap* mmap ): Destroy DOCA Memory Map structure.
doca_error_t doca_mmap_dev_add ( doca_mmap* mmap, doca_dev* dev ): Register DOCA memory map on a given device.
doca_error_t doca_mmap_dev_rm ( doca_mmap* mmap, doca_dev* dev ): Deregister given device from DOCA memory map.
doca_error_t doca_mmap_export_dpu ( doca_mmap* mmap, const doca_dev* dev, const void** export_desc, size_t* export_desc_len ): Compose memory map representation for later import with doca_mmap_create_from_export() for one of the devices previously added to the memory map.
doca_error_t doca_mmap_export_rdma ( doca_mmap* mmap, const doca_dev* dev, const void** export_desc, size_t* export_desc_len ): Compose memory map representation for later import with doca_mmap_create_from_export() for one of the devices previously added to the memory map. The imported mmap can then be used for RDMA operations.
doca_error_t doca_mmap_get_exported ( doca_mmap* mmap, uint8_t* exported ): Get the flag indicating if a DOCA Memory Map had been exported.
doca_error_t doca_mmap_get_from_export ( doca_mmap* mmap, uint8_t* from_export ): Get the flag indicating if a DOCA Memory Map had been created from an export.
doca_error_t doca_mmap_get_max_num_devices ( doca_mmap* mmap, uint32_t* max_num_devices ): Get the max number of devices to add to a DOCA Memory Map.
doca_error_t doca_mmap_get_memrange ( const doca_mmap* mmap, void** addr, size_t* len ): Get the memory range of DOCA memory map.
doca_error_t doca_mmap_get_num_bufs ( doca_mmap* mmap, uint32_t* num_bufs ): Get the Total number of `struct doca_buf` objects pointing to the memory in a DOCA Memory Map.
doca_error_t doca_mmap_get_user_data ( doca_mmap* mmap, doca_data* user_data ): Get the user_data of a DOCA Memory Map.
doca_error_t doca_mmap_set_dmabuf_memrange ( doca_mmap* mmap, int dmabuf_fd, size_t offset, size_t len ): Set the memory range of DOCA memory map using dmabuf.
doca_error_t doca_mmap_set_free_cb ( doca_mmap* mmap, doca_mmap_memrange_free_cb_t* free_cb, void* opaque ): Set callback that will free the memory range when destroying DOCA memory map.
doca_error_t doca_mmap_set_max_num_devices ( doca_mmap* mmap, uint32_t max_num_devices ): Set a new max number of devices to add to a DOCA Memory Map.
doca_error_t doca_mmap_set_memrange ( doca_mmap* mmap, void* addr, size_t len ): Set the memory range of DOCA memory map.
doca_error_t doca_mmap_set_permissions ( doca_mmap* mmap, uint32_t access_mask ): Set access flags of the registered memory.
doca_error_t doca_mmap_start ( doca_mmap* mmap ): Start DOCA Memory Map.
doca_error_t doca_mmap_stop ( doca_mmap* mmap ): Stop DOCA Memory Map.

Typedefs

typedef void( doca_mmap_memrange_free_cb_t

Function to be called for each populated memory range on memory map destroy.

Functions

doca_error_t doca_mmap_create ( const doca_data* user_data, doca_mmap** mmap )

Allocates zero size memory map object with default/unset attributes.

Parameters

user_data
mmap: DOCA memory map structure with default/unset attributes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_mmap.

Description

The returned memory map object can be manipulated with doca_mmap_property_set() API.

Once all required mmap attributes set it should be reconfigured and adjusted to meet object size setting with doca_mmap_start() See doca_mmap_start for the rest of the details.

doca_error_t doca_mmap_create_from_export ( const doca_data* user_data, const void* export_desc, size_t export_desc_len, doca_dev* dev, doca_mmap** mmap )

Creates a memory map object representing memory ranges in remote system memory space.

Parameters

user_data
export_desc: An export descriptor generated by doca_mmap_export_*.
export_desc_len: Length in bytes of the export_desc.
dev: A local device connected to the device that resides in the exported mmap. In case the 'export_desc' was created using doca_mmap_export_dpu(), then device must have from export DPU capability. See doca_devinfo_get_is_mmap_from_export_dpu_supported() in doca_dev.h
mmap: DOCA memory map granting access to remote memory.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received or internal error. The following errors are internal and will occur if failed to produce new mmap from export descriptor:
DOCA_ERROR_NO_MEMORY - if internal memory allocation failed.
DOCA_ERROR_NOT_SUPPORTED - device missing create from export capability, or was opened using doca_dev_open_from_pd().
DOCA_ERROR_NOT_PERMITTED
DOCA_ERROR_DRIVER

Description

Once this function called on the object it considered as from_export.

The following are NOT possible for the mmap created from export:

Setting the properties of the mmap using doca_mmap_set_*().
Adding a device to the mmap using doca_mmap_dev_add().
Removing a device to the mmap using doca_mmap_dev_rm().
Exporting the mmap using doca_mmap_export_*.

Note:

: The created object not backed by local memory.

doca_error_t doca_mmap_destroy ( doca_mmap* mmap )

Destroy DOCA Memory Map structure.

Parameters

mmap: The DOCA memory map structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if there is a memory region pointed by one or more `struct doca_buf`, or if memory deregistration failed.

Description

Before calling this function all allocated buffers should be returned back to the mmap.

doca_error_t doca_mmap_dev_add ( doca_mmap* mmap, doca_dev* dev )

Parameters

mmap: DOCA memory map structure.
dev: DOCA Dev instance with appropriate capability.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if memory deregistration failed or the operation is not premitted for the given mmap (see details in this function description).
DOCA_ERROR_NO_MEMORY - if reached to DOCA_MMAP_MAX_NUM_DEVICES.
DOCA_ERROR_IN_USE - if doca_dev already exists in doca_mmap.
DOCA_ERROR_NOT_SUPPORTED - if dev was opened using doca_dev_open_from_pd().

Description

This operation is not permitted for:

started memory map object.
memory map object that have been exported or created from export.

doca_error_t doca_mmap_dev_rm ( doca_mmap* mmap, doca_dev* dev )

Deregister given device from DOCA memory map.

Parameters

mmap: DOCA memory map structure.
dev: DOCA Dev instance that was previously added.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received or doca_dev doesn't exists in doca_mmap.
DOCA_ERROR_NOT_PERMITTED - if memory deregistration failed or the operation is not premitted for the given mmap (see details in this function description).

Description

This operation is not permitted for:

started memory map object.
memory map object that have been exported or created from export.

doca_error_t doca_mmap_export_dpu ( doca_mmap* mmap, const doca_dev* dev, const void** export_desc, size_t* export_desc_len )

Compose memory map representation for later import with doca_mmap_create_from_export() for one of the devices previously added to the memory map.

Parameters

mmap: DOCA memory map structure.
dev: Device previously added to the memory map via doca_mmap_dev_add(). Device must have export capability. See doca_devinfo_get_is_mmap_export_dpu_supported() in doca_dev.h
export_desc: On successful return should have a pointer to the allocated blob containing serialized representation of the memory map object for the device provided as `dev`.
export_desc_len: Length in bytes of the export_desc.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received or device does not exists in mmap.
DOCA_ERROR_NOT_PERMITTED - the operation is not premitted for the given mmap, see details in this function description. The following errors will occur if failed to produce export descriptor:
DOCA_ERROR_NO_MEMORY - if failed to alloc memory for export_desc.
DOCA_ERROR_NOT_SUPPORTED - device missing export capability.
DOCA_ERROR_DRIVER

Description

This operation is not permitted for:

un-started/stopped memory map object.
memory map object that have been created from export.
memory map with no DPU access permission set - see doca_mmap_set_permissions()

doca_error_t doca_mmap_export_rdma ( doca_mmap* mmap, const doca_dev* dev, const void** export_desc, size_t* export_desc_len )

Parameters

mmap: DOCA memory map structure.
dev: Device previously added to the memory map via doca_mmap_dev_add().
export_desc: On successful return should have a pointer to the allocated blob containing serialized representation of the memory map object for the device provided as `dev`.
export_desc_len: Length in bytes of the export_desc.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received or device does not exists in mmap.
DOCA_ERROR_NOT_PERMITTED - the operation is not premitted for the given mmap, see details in this function description. The following errors will occur if failed to produce export descriptor:
DOCA_ERROR_NO_MEMORY - if failed to alloc memory for export_desc.
DOCA_ERROR_NOT_SUPPORTED - device missing export capability, or was opened using doca_dev_open_from_pd().
DOCA_ERROR_DRIVER

Description

Once this function called on the object it considered as exported.

This operation is not permitted for:

un-started/stopped memory map object.
memory map objects that have been created from export.
memory map with no RDMA access permission set - see doca_mmap_set_permissions()

doca_error_t doca_mmap_get_exported ( doca_mmap* mmap, uint8_t* exported )

Get the flag indicating if a DOCA Memory Map had been exported.

Parameters

mmap: The DOCA memory map structure.
exported: 1 if mmap had been exported, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_mmap_get_from_export ( doca_mmap* mmap, uint8_t* from_export )

Get the flag indicating if a DOCA Memory Map had been created from an export.

Parameters

mmap: The DOCA memory map structure.
from_export: 1 if mmap had been created from export, 0 otherwise.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_mmap_get_max_num_devices ( doca_mmap* mmap, uint32_t* max_num_devices )

Get the max number of devices to add to a DOCA Memory Map.

Parameters

mmap: The DOCA memory map structure.
max_num_devices: The max number of devices that can be added add to mmap.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_mmap_get_memrange ( const doca_mmap* mmap, void** addr, size_t* len )

Get the memory range of DOCA memory map.

Parameters

mmap: DOCA memory map structure.
addr: Start address of the memory range previously set.
len: The size of the memory range in bytes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - memrange was never set.

Description

doca_error_t doca_mmap_get_num_bufs ( doca_mmap* mmap, uint32_t* num_bufs )

Get the Total number of `struct doca_buf` objects pointing to the memory in a DOCA Memory Map.

Parameters

mmap: The DOCA memory map structure.
num_bufs: The total number of `struct doca_buf` objects pointing to the memory in mmap.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

doca_error_t doca_mmap_get_user_data ( doca_mmap* mmap, doca_data* user_data )

Get the user_data of a DOCA Memory Map.

Parameters

mmap: The DOCA memory map structure.
user_data: The user_data of mmap.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Note:

The user_data that was provided to the mmap upon its creation.

doca_error_t doca_mmap_set_dmabuf_memrange ( doca_mmap* mmap, int dmabuf_fd, size_t offset, size_t len )

Set the memory range of DOCA memory map using dmabuf.

Parameters

mmap: DOCA memory map structure.
dmabuf_fd: File descriptor of the dmabuf.
offset: Start offset of the dmabuf.
len: The size of the memory range in bytes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_NOT_SUPPORTED - if not called from linux operating system
DOCA_ERROR_INVALID_VALUE - if an invalid input had been received, or addr + len overflows.
DOCA_ERROR_BAD_STATE - if mmap is started.
DOCA_ERROR_NOT_PERMITTED - if mmap memory range was set before

Description

This operation is not permitted for:

started memory map object.
memory map object that have been exported or created from export.

Note:

: this property is mandatory and can be done only once. it is only supported when used on linux operating system

doca_error_t doca_mmap_set_free_cb ( doca_mmap* mmap, doca_mmap_memrange_free_cb_t* free_cb, void* opaque )

Set callback that will free the memory range when destroying DOCA memory map.

Parameters

mmap: DOCA memory map structure.
free_cb: Callback function to free the set memory range on memory map destroy.
opaque: User opaque value passed to free_cb.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_BAD_STATE - if mmap is started.

Description

Note:

Callback is called on mmap destroy, only in case the mmap was started and destroyed without changing the callback.

doca_error_t doca_mmap_set_max_num_devices ( doca_mmap* mmap, uint32_t max_num_devices )

Set a new max number of devices to add to a DOCA Memory Map.

Parameters

mmap: The DOCA memory map structure.
max_num_devices: The new max number of devices that can be added add to mmap.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if trying to set the max number of devices after first start of the mmap.

Description

doca_error_t doca_mmap_set_memrange ( doca_mmap* mmap, void* addr, size_t len )

Set the memory range of DOCA memory map.

Parameters

mmap: DOCA memory map structure.
addr: Start address of the memory range to be set.
len: The size of the memory range in bytes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received, or addr + len overflows.
DOCA_ERROR_BAD_STATE - if mmap is started.
DOCA_ERROR_NOT_PERMITTED - if mmap memory range was set before

Description

This operation is not permitted for:

started memory map object.
memory map object that have been exported or created from export.

Note:

: this property is mandatory and can be done only once

doca_error_t doca_mmap_set_permissions ( doca_mmap* mmap, uint32_t access_mask )

Set access flags of the registered memory.

Parameters

mmap: The DOCA memory map structure.
access_mask: bitwise combination of access flags - see enum doca_access_flags

Returns

DOCA_SUCCESS - in case of success doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received or trying to set an undefined access flag, or invalid combination
DOCA_ERROR_BAD_STATE - If mmap is started

Description

this defines what kind of access the added devices have to the memory defined in mmap

doca_error_t doca_mmap_start ( doca_mmap* mmap )

Start DOCA Memory Map.

Parameters

mmap: DOCA memory map structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - if memory allocation failed.
DOCA_ERROR_NOT_PERMITTED - if mmap is exported or created from export.

Description

Allows execution of different operations on the mmap, detailed below. On start verifies & finalizes the mmap object configuration.

The following become possible only after start:

Exporting the mmap using doca_mmap_export_*.
Mapping doca_buf structures to the memory ranges in the using doca_buf_inventory_buf_by_addr() or doca_buf_inventory_buf_dup().

The following are NOT possible while mmap is started:

Setting the properties of the mmap through doca_mmap_set_*.
Adding a device to the mmap using doca_mmap_dev_add().
Removing a device to the mmap using doca_mmap_dev_rm().

doca_error_t doca_mmap_stop ( doca_mmap* mmap )

Stop DOCA Memory Map.

Parameters

mmap: DOCA memory map structure.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_PERMITTED - if mmap was exported or created from export, or buffers that were created for this mmap, are still not destroyed.

Description

2.4.10. DOCA RDMA BRIDGE

[Core]

DOCA RDMA bridge.

Functions

doca_error_t doca_buf_get_mkey ( const doca_buf* buf, doca_dev* dev, uint32_t* mkey ): Get lkey with doca_access_flags access for a DOCA buffer of a DOCA device.
doca_error_t doca_dev_get_pd ( const doca_dev* dev, ibv_pd** pd ): Get the protection domain associated with a DOCA device.
doca_error_t doca_dev_open_from_pd ( ibv_pd* pd, doca_dev** dev ): Open a DOCA device using an ibv_pd.

Functions

doca_error_t doca_buf_get_mkey ( const doca_buf* buf, doca_dev* dev, uint32_t* mkey )

Get lkey with doca_access_flags access for a DOCA buffer of a DOCA device.

Parameters

buf: The DOCA buffer to get lkey for. MUST NOT BE NULL.
dev: The DOCA device to get lkey for. MUST NOT BE NULL.
mkey: The returned MKey. MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if cannot find mkey by the given device.
DOCA_ERROR_NOT_SUPPORTED - if the given access flags is not supported

Description

Note:

Access of mkey is defined by the mmap where buf was created.

doca_error_t doca_dev_get_pd ( const doca_dev* dev, ibv_pd** pd )

Get the protection domain associated with a DOCA device.

Parameters

dev: DOCA device to get the pd from.
pd: The protection-domain associated with the given DOCA device.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_BAD_STATE - in case the device's pd is not valid (bad state)

Description

doca_error_t doca_dev_open_from_pd ( ibv_pd* pd, doca_dev** dev )

Open a DOCA device using an ibv_pd.

Parameters

pd: A protection domain that is not associated with any DOCA device
dev: A newly created DOCA device with same protection domain as 'pd'

Returns

DOCA_SUCCESS - in case of success

Description

Always prefer using a DOCA device obtained from doca_devinfo_list_create() This call will fail if PD was acquired by DOCA through doca_devinfo_list_create() and then doca_dev_get_pd()

For reference: doca_dev - is parallel to an ibv_pd doca_buf - is parallel to an ibv_mr registered on multiple devices doca_mmap - is parallel to creating an ibv_mr for multiple devices

The only APIs that are supported for the newly created device:

2.4.11. DOCA Sync Event

[Core]

Classes

struct doca_sync_event_job_get
struct doca_sync_event_job_update_add
struct doca_sync_event_job_update_set
struct doca_sync_event_job_wait
struct doca_sync_event_result

Typedefs

typedef uint64_t doca_dpa_dev_sync_event_t
typedef uint64_t doca_gpu_dev_sync_event_t

Enumerations

enum doca_sync_event_job_types

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_sync_event_as_ctx ( doca_sync_event* event ): Convert a Sync Event to a DOCA context.
doca_error_t doca_sync_event_create ( doca_sync_event** event ): Create a Sync Event handle.
doca_error_t doca_sync_event_create_from_export ( doca_dev* dev, const uint8_t* data, size_t sz, doca_sync_event** event ): Create a Sync Event handle from an export.
doca_error_t doca_sync_event_destroy ( doca_sync_event* event ): Destroy a Sync Event instance.
doca_error_t doca_sync_event_export_remote ( doca_sync_event* event, doca_sync_event_remote_t* handle ): Obtain an handle for interacting with the associated DOCA Syn Event from a remote node.
doca_error_t doca_sync_event_export_to_dpa ( doca_sync_event* event, doca_dpa* dpa, doca_dpa_dev_sync_event_t* dpa_dev_se_handle ): Export Sync Event to be shared with the DPA.
doca_error_t doca_sync_event_export_to_dpu ( doca_sync_event* event, doca_dev* dev, const uint8_t** data, size_t* sz ): Export Sync Event to be shared with the DPU.
doca_error_t doca_sync_event_export_to_gpu ( doca_sync_event* event, doca_gpu* gpu, doca_gpu_dev_sync_event_t** gpu_dev_se ): Export Sync Event to be shared with the GPU.
doca_error_t doca_sync_event_get ( doca_sync_event* event, uint64_t* value ): Get the value of a Sync Event synchronously.
doca_error_t doca_sync_event_get_create_from_export_supported ( const doca_devinfo* devinfo )
doca_error_t doca_sync_event_get_export_to_dpa_supported ( const doca_devinfo* devinfo )
doca_error_t doca_sync_event_get_export_to_dpu_supported ( const doca_devinfo* devinfo )
doca_error_t doca_sync_event_get_export_to_gpu_supported ( const doca_devinfo* devinfo )
doca_error_t doca_sync_event_job_get_supported ( doca_devinfo* devinfo, doca_sync_event_job_types type ): Check if a given device is capable of executing a specific Sync Event job.
doca_error_t doca_sync_event_publisher_add_location_cpu ( doca_sync_event* event, doca_dev* dev ): Associate a CPU device context as the Sync Event Publisher.
doca_error_t doca_sync_event_publisher_add_location_dpa ( doca_sync_event* event, doca_dpa* dpa ): Associate a DOCA DPA context as the Sync Event Publisher.
doca_error_t doca_sync_event_publisher_add_location_dpu ( doca_sync_event* event ): Declare Sync Event Publisher as the DPU.
doca_error_t doca_sync_event_publisher_add_location_gpu ( doca_sync_event* event, doca_gpu* gpu ): Associate a DOCA GPU context as the Sync Event Publisher.
doca_error_t doca_sync_event_set_addr ( doca_sync_event* event, uint64_t* addr ): Set the 64-bit value's address for a Sync Event.
doca_error_t doca_sync_event_start ( doca_sync_event* event ): Start a Sync Event to be operate as stand-alone DOCA Core object only.
doca_error_t doca_sync_event_stop ( doca_sync_event* event ): Stop a Sync Event which has been previously started with 'doca_sync_event_start'.
doca_error_t doca_sync_event_subscriber_add_location_cpu ( doca_sync_event* event, doca_dev* dev )
doca_error_t doca_sync_event_subscriber_add_location_dpa ( doca_sync_event* event, doca_dpa* dpa ): Associate a DOCA DPA context as the Sync Event Sublisher.
doca_error_t doca_sync_event_subscriber_add_location_dpu ( doca_sync_event* event ): Declare Sync Event Publisher as the DPU.
doca_error_t doca_sync_event_subscriber_add_location_gpu ( doca_sync_event* event, doca_gpu* gpu ): Associate a DOCA GPU context as the Sync Event Subscriber.
doca_error_t doca_sync_event_update_add ( doca_sync_event* event, uint64_t value, uint64_t* fetched ): Atomically increase the value of a Sync Event by some value synchronously.
doca_error_t doca_sync_event_update_set ( doca_sync_event* event, uint64_t value ): Set the value of a Sync Event to some value synchronously.
doca_error_t doca_sync_event_wait_gt ( doca_sync_event* event, uint64_t value, uint64_t mask ): Wait for the value of a Sync Event to reach some value synchronously in a polling busy wait manner.
doca_error_t doca_sync_event_wait_gt_yield ( doca_sync_event* event, uint64_t value, uint64_t mask ): Wait for the value of a Sync Event to reach some value synchronously in a periodically busy wait manner.

Typedefs

typedef uint64_t doca_dpa_dev_sync_event_t

DPA sync event handle type definition

typedef uint64_t doca_gpu_dev_sync_event_t

GPU sync event handle type definition

Enumerations

enum doca_sync_event_job_types

Sync Event job types for performing operation on a Sync Event thorugh DOCA job submission on a DOCA WorkQ

Values

DOCA_SYNC_EVENT_JOB_WAIT_GT = DOCA_ACTION_SYNC_EVENT_FIRST+1: Wait for the Sync Event to be grater than some value
DOCA_SYNC_EVENT_JOB_GET: Get the value of the Sync Event
DOCA_SYNC_EVENT_JOB_UPDATE_SET: Set the Sync Event value with some value
DOCA_SYNC_EVENT_JOB_UPDATE_ADD: Increment atomically the Sync Event value by some value

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_sync_event_as_ctx ( doca_sync_event* event )

Convert a Sync Event to a DOCA context.

Parameters

event: The doca_sync_event to be converted

Returns

The matching doca_ctx instance in case of success, NULL otherwise.

Description

Set the Sync Event to operate as a DOCA Context only, hence it can be interacted with through the supported DOCA Context API.

Sync Event CTX supports the following operations: start/stop/workq_add/workq_rm/get_event_driven_supported. A device can't be attached to a sync event ctx.

It is suggested to use Sync Event in this mode to wait on a Sync Event in a blocking manner.

doca_error_t doca_sync_event_create ( doca_sync_event** event )

Create a Sync Event handle.

Parameters

event: The created doca_sync_event instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_sync_event.

Description

Creates CPU handle - Host CPU or DPU's CPU.

doca_error_t doca_sync_event_create_from_export ( doca_dev* dev, const uint8_t* data, size_t sz, doca_sync_event** event )

Create a Sync Event handle from an export.

Parameters

dev: doca_dev instance to be attached to the create doca_sync_event.
data: Exported doca_sync_event data stream, created by doca_sync_event_export_to_* call.
sz: Size of exported doca_sync_event data stream, created by doca_sync_event_export_to_* call.
event: The created doca_sync_event instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided doca_dev does not support creating Sync Event from export.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_sync_event.

Description

Creates a DPU handle. The DOCA Device should be capable of importing an exported Sync Event (see doca_sync_event_get_create_from_export_supported capability).

Note:

The Sync Event can only be configured and exported by the exporting process.

doca_error_t doca_sync_event_destroy ( doca_sync_event* event )

Destroy a Sync Event instance.

Parameters

event: doca_sync_event to be destroyed.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.

Description

doca_error_t doca_sync_event_export_remote ( doca_sync_event* event, doca_sync_event_remote_t* handle )

Obtain an handle for interacting with the associated DOCA Syn Event from a remote node.

Parameters

event: Target doca_sync_event instance to export for remote.
handle: The remote handle associated with the given doca_sync_event instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_export_to_dpa ( doca_sync_event* event, doca_dpa* dpa, doca_dpa_dev_sync_event_t* dpa_dev_se_handle )

Export Sync Event to be shared with the DPA.

Parameters

event: Target doca_sync_event instance to export.
dpa: The associated DOCA DPA Context.
dpa_dev_se_handle: DOCA DPA device sync event handle that can be passed to a kernel.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support this Sync Event action.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_dpa_sync_event.

Description

The DOCA DPA Sync Event is an handle to be used from the DPA to perform operations on the associated Sync Event.

doca_error_t doca_sync_event_export_to_dpu ( doca_sync_event* event, doca_dev* dev, const uint8_t** data, size_t* sz )

Export Sync Event to be shared with the DPU.

Parameters

event: Target doca_sync_event instance to export.
dev: Target dev to export.
data: The created export data stream.
sz: Size of created export data stream.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support this Sync Event action.
DOCA_ERROR_NO_MEMORY - failed to alloc data stream.

Description

The exported data stream an be used from the DPU to created an exported Sync Event (see doca_sync_event_create_from_export).

doca_error_t doca_sync_event_export_to_gpu ( doca_sync_event* event, doca_gpu* gpu, doca_gpu_dev_sync_event_t** gpu_dev_se )

Export Sync Event to be shared with the GPU.

Parameters

event: Target doca_sync_event instance to export.
gpu: The associated DOCA GPU Context.
gpu_dev_se: DOCA GPU device sync event handle that can be passed to a kernel.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support this Sync Event action.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_gpu_sync_event.

Description

The DOCA GPU Sync Event is an handle to be used from the GPU to perform operations on the associated Sync Event.

doca_error_t doca_sync_event_get ( doca_sync_event* event, uint64_t* value )

Get the value of a Sync Event synchronously.

Parameters

event: Target doca_sync_event instance to read its value.
value: The returned doca_sync_event value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_get_create_from_export_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: The DOCA device information.

Returns

DOCA_SUCCESS - in case device supports creating Sync Event from an export. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support importing an exported Sync Event.

Description

Check if given device is capable of creating Sync Event from an export.

doca_error_t doca_sync_event_get_export_to_dpa_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: The DOCA device information.

Returns

DOCA_SUCCESS - in case device supports exporting an associated Sync Event to DPA. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support exporting an associated Sync Event to DPA.

Description

Check if a DOCA device is capable of exporting an associated Sync Event to the DPA using doca_sync_event_export_to_dpa.

doca_error_t doca_sync_event_get_export_to_dpu_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: The DOCA device information.

Returns

DOCA_SUCCESS - in case device supports exporting an associated Sync Event to DPU. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support exporting an associated Sync Event to DPU.

Description

Check if a DOCA device is capable of exporting an associated Sync Event to the DPU using doca_sync_event_export_to_dpu.

doca_error_t doca_sync_event_get_export_to_gpu_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: The DOCA device information.

Returns

DOCA_SUCCESS - in case device supports exporting an associated Sync Event to GPU. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support exporting an associated Sync Event to GPU.

Description

Check if a DOCA device is capable of exporting an associated Sync Event to the GPU using doca_sync_event_export_to_gpu.

doca_error_t doca_sync_event_job_get_supported ( doca_devinfo* devinfo, doca_sync_event_job_types type )

Check if a given device is capable of executing a specific Sync Event job.

Parameters

devinfo: The DOCA device information.
type: doca_sync_event_job_types available for this device. see enum doca_sync_event_job_types.

Returns

DOCA_SUCCESS - in case device supports the Sync Event job type. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support this Sync Event job.

Description

doca_error_t doca_sync_event_publisher_add_location_cpu ( doca_sync_event* event, doca_dev* dev )

Associate a CPU device context as the Sync Event Publisher.

Parameters

event: Target doca_sync_event instance to set.
dev: doca_dev instance associated with CPU.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_publisher_add_location_dpa ( doca_sync_event* event, doca_dpa* dpa )

Associate a DOCA DPA context as the Sync Event Publisher.

Parameters

event: Target doca_sync_event instance to set.
dpa: doca_dpa instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_publisher_add_location_dpu ( doca_sync_event* event )

Declare Sync Event Publisher as the DPU.

Parameters

event: Target doca_sync_event instance to set.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.

Description

doca_error_t doca_sync_event_publisher_add_location_gpu ( doca_sync_event* event, doca_gpu* gpu )

Associate a DOCA GPU context as the Sync Event Publisher.

Parameters

event: Target doca_sync_event instance to set.
gpu: doca_gpu instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_set_addr ( doca_sync_event* event, uint64_t* addr )

Set the 64-bit value's address for a Sync Event.

Parameters

event: Pointer to se event instance to be configured.
addr: Allocated address pointer.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_BAD_STATE - setting address for event which has already been started is not allowed.
DOCA_ERROR_NOT_SUPPORTED - addr is in unsupported address space.

Description

Setting external address is allowed only for CPU/DPU configured Sync Event.

doca_error_t doca_sync_event_start ( doca_sync_event* event )

Start a Sync Event to be operate as stand-alone DOCA Core object only.

Parameters

event: Pointer to se event instance to be started.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.

Description

Starting a Sync Event with doca_sync_event_start means it can't be operate as (and converted to) DOCA Context.

doca_error_t doca_sync_event_stop ( doca_sync_event* event )

Stop a Sync Event which has been previously started with 'doca_sync_event_start'.

Parameters

event: Pointer to se event instance to be stoped.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.

Description

doca_error_t doca_sync_event_subscriber_add_location_cpu ( doca_sync_event* event, doca_dev* dev )

Parameters

event: Target doca_sync_event instance to set.
dev: doca_dev instance associated with CPU.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

Associate a CPU device context as the doca_sync_event Subscriber,

doca_error_t doca_sync_event_subscriber_add_location_dpa ( doca_sync_event* event, doca_dpa* dpa )

Associate a DOCA DPA context as the Sync Event Sublisher.

Parameters

event: Target doca_sync_event instance to set.
dpa: doca_dpa instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_subscriber_add_location_dpu ( doca_sync_event* event )

Declare Sync Event Publisher as the DPU.

Parameters

event: Target doca_sync_event instance to set.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - event argument is a NULL pointer.

Description

doca_error_t doca_sync_event_subscriber_add_location_gpu ( doca_sync_event* event, doca_gpu* gpu )

Associate a DOCA GPU context as the Sync Event Subscriber.

Parameters

event: Target doca_sync_event instance to set.
gpu: doca_gpu instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_update_add ( doca_sync_event* event, uint64_t value, uint64_t* fetched )

Atomically increase the value of a Sync Event by some value synchronously.

Parameters

event: Target doca_sync_event instance to increment.
value: The value to increment the doca_sync_event value by.
fetched: The value of the doca_sync_event before the operation.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_update_set ( doca_sync_event* event, uint64_t value )

Set the value of a Sync Event to some value synchronously.

Parameters

event: Target doca_sync_event instance to set its value.
value: The value to set the doca_sync_event to.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_wait_gt ( doca_sync_event* event, uint64_t value, uint64_t mask )

Wait for the value of a Sync Event to reach some value synchronously in a polling busy wait manner.

Parameters

event: Target doca_sync_event instance to wait on.
value: The value to wait for the doca_sync_event to be greater than.
mask: Mask to apply (bitwise AND) on the doca_sync_event value for comparison with wait threshold.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

doca_error_t doca_sync_event_wait_gt_yield ( doca_sync_event* event, uint64_t value, uint64_t mask )

Wait for the value of a Sync Event to reach some value synchronously in a periodically busy wait manner.

Parameters

event: Target doca_sync_event instance to wait on.
value: The value to wait for the doca_sync_event to be greater than.
mask: Mask to apply (bitwise AND) on the doca_sync_event value for comparison with wait threshold.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - any of the arguments is a NULL pointer.

Description

2.4.12. DOCA Types

[Core]

DOCA Types introduces types that are common for many libraries.

Defines

#define DOCA_GID_BYTE_LENGTH 16: Specifies the length of a GID (Global ID) in bytes.

Typedefs

typedef uint16_t doca_be16_t: Declare DOCA endianity types.
typedef void * doca_event_handle_t

Enumerations

enum doca_access_flags: Specifies the permission level for DOCA buffer.
enum doca_eth_wait_on_time: Type of wait on time the network card can support.
enum doca_gpu_mem_type: Type of memory the GPUNetIO library can allocate.
enum doca_mtu_size: MTU size in bytes.
enum doca_pci_func_type: Specifies the PCI function type for DOCA representor device.

Defines

#define DOCA_GID_BYTE_LENGTH 16

Typedefs

typedef uint16_t doca_be16_t

Declare DOCA endianity types.

typedef void * doca_event_handle_t

Used for windows HANDLE or IOCompletionPort

Enumerations

enum doca_access_flags

Values

DOCA_ACCESS_LOCAL_READ_ONLY = 0
DOCA_ACCESS_LOCAL_READ_WRITE = (1<<0)
DOCA_ACCESS_RDMA_READ = (1<<1)
DOCA_ACCESS_RDMA_WRITE = (1<<2)
DOCA_ACCESS_RDMA_ATOMIC = (1<<3)
DOCA_ACCESS_DPU_READ_ONLY = (1<<4)
DOCA_ACCESS_DPU_READ_WRITE = (1<<5): Allows reading buffer by a DPU device but no write Only relevant for HOST - see doca_mmap_export_dpu()

enum doca_eth_wait_on_time

Values

DOCA_ETH_WAIT_ON_TIME_NONE = 0
DOCA_ETH_WAIT_ON_TIME_NATIVE = 1
DOCA_ETH_WAIT_ON_TIME_DPDK = 2

enum doca_gpu_mem_type

Values

DOCA_GPU_MEM_GPU = 0
DOCA_GPU_MEM_GPU_CPU = 1
DOCA_GPU_MEM_CPU = 2
DOCA_GPU_MEM_CPU_GPU = 3

enum doca_mtu_size

Values

DOCA_MTU_SIZE_256_BYTES = 0x0
DOCA_MTU_SIZE_512_BYTES = 0x1
DOCA_MTU_SIZE_1K_BYTES = 0x2
DOCA_MTU_SIZE_2K_BYTES = 0x3
DOCA_MTU_SIZE_4K_BYTES = 0x4
DOCA_MTU_SIZE_RAW_ETHERNET = 0x5

enum doca_pci_func_type

Values

DOCA_PCI_FUNC_PF = 0
DOCA_PCI_FUNC_VF
DOCA_PCI_FUNC_SF

2.5. Comm Channel

DOCA Communication Channel library let you set a direct communication channel between the host and the DPU. The channel is run over RoCE/IB protocol and is not part of the TCP/IP stack. Please follow the programmer guide for usage instructions.

Typedefs

typedef doca_event_handle_t doca_event_channel_t: endpoint notification file descriptor for blocking with epoll() for recv ready event

Enumerations

enum doca_comm_channel_msg_flags: Flags for send/receive functions.

Functions

doca_error_t doca_comm_channel_ep_connect ( doca_comm_channel_ep_t* local_ep, const char* name, doca_comm_channel_addr_t** peer_addr ): Client side Connect.
doca_error_t doca_comm_channel_ep_create ( doca_comm_channel_ep_t** ep ): Create local endpoint The endpoint handle represents all the configuration needed for the channel to run. The user needs to hold one endpoint for all actions with the comm channel on his side.
doca_error_t doca_comm_channel_ep_destroy ( doca_comm_channel_ep_t* local_ep ): Release endpoint handle.
doca_error_t doca_comm_channel_ep_disconnect ( doca_comm_channel_ep_t* local_ep, doca_comm_channel_addr_t* peer_addr ): Disconnect the endpoint from the remote peer. block until all resources related to peer address are freed new connection could be created on the endpoint.
doca_error_t doca_comm_channel_ep_event_handle_arm_recv ( doca_comm_channel_ep_t* local_ep ): Arm the event_channel handle for received messages. This function arms the receive completion queue, facilitating blocking on the receive event channel. Blocking should be implemented by the user (poll in Linux, GetQueuedCompletionStatus in Windows).
doca_error_t doca_comm_channel_ep_event_handle_arm_send ( doca_comm_channel_ep_t* local_ep ): Arm the event_channel handle for transmitted messages. This function arms the transmit completion queue, facilitating blocking on the transmit event channel. Blocking should be implemented by the user (poll in Linux, GetQueuedCompletionStatus in Windows).
doca_error_t doca_comm_channel_ep_get_device ( doca_comm_channel_ep_t* ep, doca_dev** device ): get device property of endpoint.
doca_error_t doca_comm_channel_ep_get_device_rep ( doca_comm_channel_ep_t* ep, doca_dev_rep** device_rep ): get device representor property of endpoint.
doca_error_t doca_comm_channel_ep_get_event_channel ( doca_comm_channel_ep_t* local_ep, doca_event_channel_t* send_event_channel, doca_event_channel_t* recv_event_channel ): Extract the event_channel handles for user's use When the user send/receive packets with non-blocking mode, this handle can be used to get interrupt when a new event happened, using epoll() or similar function. The event channels are owned by the endpoint and release when calling doca_comm_channel_ep_destroy(). This function can be called only after calling doca_comm_channel_ep_listen() or doca_comm_channel_ep_connect().
doca_error_t doca_comm_channel_ep_get_max_msg_size ( doca_comm_channel_ep_t* ep, uint16_t* max_msg_size ): get maximal msg size property of endpoint. The size returned is the actual size being used and might differ from the size set with doca_comm_channel_ep_set_max_msg_size(), as there is a minimal size requirement. If maximal msg size was not set, using doca_comm_channel_ep_set_max_msg_size(), a default value is used and can be inquired by calling doca_comm_channel_ep_get_max_msg_size().
doca_error_t doca_comm_channel_ep_get_peer_addr_list ( const doca_comm_channel_ep_t* local_ep, doca_comm_channel_addr_t*** peer_addr_array, uint32_t* peer_addr_array_len ): get an array of the peer_addr connected to a given service object
doca_error_t doca_comm_channel_ep_get_pending_connections ( const doca_comm_channel_ep_t* local_ep, uint32_t* pending_connections ): get the number of pending connections for a given service endpoint
doca_error_t doca_comm_channel_ep_get_recv_queue_size ( doca_comm_channel_ep_t* ep, uint16_t* recv_queue_size ): get receive queue size property of endpoint. The size returned is the actual size being used and might differ from the size set with doca_comm_channel_ep_set_recv_queue_size(), as there is a minimal size requirement and the size is rounded up to the closest power of 2. If receive queue size was not set, using doca_comm_channel_ep_set_recv_queue_size(), a default value is used and can be inquired by calling doca_comm_channel_ep_get_recv_queue_size().
doca_error_t doca_comm_channel_ep_get_send_queue_size ( doca_comm_channel_ep_t* ep, uint16_t* send_queue_size ): get send queue size property of endpoint. The size returned is the actual size being used and might differ from the size set with doca_comm_channel_ep_set_send_queue_size(), as there is a minimal size requirement and the size is rounded up to the closest power of 2. If send queue size was not set, using doca_comm_channel_ep_set_send_queue_size(), a default value is used and can be inquired by calling doca_comm_channel_ep_get_send_queue_size().
doca_error_t doca_comm_channel_ep_get_service_event_channel ( doca_comm_channel_ep_t* local_ep, doca_event_channel_t* service_event_channel ): Extract the service_event_channel handle for user's use This handle can be used to get interrupt when one of the following events occure: new client connected, client disconnected or service moved to error state using epoll() or similar function. If an event was received, the application can call doca_comm_channel_ep_update_service_state_info() and it's query functions to get the current service state. The service event channel is armed automatically upon calling doca_comm_channel_ep_update_service_state_info().
doca_error_t doca_comm_channel_ep_listen ( doca_comm_channel_ep_t* local_ep, const char* name ): Service side listen on all interfaces.
doca_error_t doca_comm_channel_ep_recvfrom ( doca_comm_channel_ep_t* local_ep, void* msg, size_t* len, int flags, doca_comm_channel_addr_t** peer_addr ): Receive message from connected client/service.
doca_error_t doca_comm_channel_ep_sendto ( doca_comm_channel_ep_t* local_ep, const void* msg, size_t len, int flags, doca_comm_channel_addr_t* peer_addr ): Send message to peer address. The connection to the wanted peer_address need to be established before sending the message.
doca_error_t doca_comm_channel_ep_set_device ( doca_comm_channel_ep_t* ep, doca_dev* device ): set device property for endpoint.
doca_error_t doca_comm_channel_ep_set_device_rep ( doca_comm_channel_ep_t* ep, doca_dev_rep* device_rep ): set device representor property for endpoint.
doca_error_t doca_comm_channel_ep_set_max_msg_size ( doca_comm_channel_ep_t* ep, uint16_t max_msg_size ): set maximal msg size property for endpoint. The value max_msg_size may be increased internally, the actual value can be queried using doca_comm_channel_ep_get_max_msg_size().
doca_error_t doca_comm_channel_ep_set_recv_queue_size ( doca_comm_channel_ep_t* ep, uint16_t recv_queue_size ): set receive queue size property for endpoint. The value recv_queue_size may be increased internally, the actual value can be queried using doca_comm_channel_ep_get_recv_queue_size().
doca_error_t doca_comm_channel_ep_set_send_queue_size ( doca_comm_channel_ep_t* ep, uint16_t send_queue_size ): set send queue size property for endpoint. The value send_queue_size may be increased internally, the actual value can be queried using doca_comm_channel_ep_get_send_queue_size().
doca_error_t doca_comm_channel_ep_update_service_state_info ( doca_comm_channel_ep_t* local_ep ): update the connections status for a given service endpoint
doca_error_t doca_comm_channel_get_max_message_size ( doca_devinfo* devinfo, uint32_t* max_message_size ): Get the maximum message size supported by comm_channel.
doca_error_t doca_comm_channel_get_max_recv_queue_size ( doca_devinfo* devinfo, uint32_t* max_recv_queue_size ): Get the maximum receive queue size supported by comm_channel.
doca_error_t doca_comm_channel_get_max_send_queue_size ( doca_devinfo* devinfo, uint32_t* max_send_queue_size ): Get the maximum send queue size supported by comm_channel.
doca_error_t doca_comm_channel_get_max_service_name_len ( uint32_t* max_service_name_len ): Get the comm_channel maximum Service name length.
doca_error_t doca_comm_channel_get_service_max_num_connections ( doca_devinfo* devinfo, uint32_t* max_num_connections ): Get the maximum number of connections the service can hold.
doca_error_t doca_comm_channel_peer_addr_get_recv_bytes ( const doca_comm_channel_addr_t* peer_addr, uint64_t* recv_bytes ): get total bytes received from specific peer address
doca_error_t doca_comm_channel_peer_addr_get_recv_messages ( const doca_comm_channel_addr_t* peer_addr, uint64_t* recv_messages ): get total messages received from specific peer address
doca_error_t doca_comm_channel_peer_addr_get_send_bytes ( const doca_comm_channel_addr_t* peer_addr, uint64_t* send_bytes ): get total bytes sent to specific peer address
doca_error_t doca_comm_channel_peer_addr_get_send_in_flight_messages ( const doca_comm_channel_addr_t* peer_addr, uint64_t* send_in_flight_messages ): get number of messages in transmission to a specific peer address
doca_error_t doca_comm_channel_peer_addr_get_send_messages ( const doca_comm_channel_addr_t* peer_addr, uint64_t* send_messages ): get total messages sent to specific peer address
doca_error_t doca_comm_channel_peer_addr_get_user_data ( doca_comm_channel_addr_t* peer_addr, uint64_t* user_data ): Extract 'user_context' from peer_addr handle. By default, the 'user_context' is set to 0 and can be change using doca_comm_channel_peer_addr_set_user_data().
doca_error_t doca_comm_channel_peer_addr_set_user_data ( doca_comm_channel_addr_t* peer_addr, uint64_t user_context ): Save 'user_context' in peer_addr handle.
doca_error_t doca_comm_channel_peer_addr_update_info ( doca_comm_channel_addr_t* peer_addr ): update statistics for given peer_addr

Typedefs

typedef doca_event_handle_t doca_event_channel_t

endpoint notification file descriptor for blocking with epoll() for recv ready event

Enumerations

enum doca_comm_channel_msg_flags

Values

DOCA_CC_MSG_FLAG_NONE = 0

Functions

doca_error_t doca_comm_channel_ep_connect ( doca_comm_channel_ep_t* local_ep, const char* name, doca_comm_channel_addr_t** peer_addr )

Client side Connect.

Parameters

local_ep: handle for the endpoint created beforehand with doca_comm_channel_ep_create().
name: identifies the service. Use doca_comm_channel_get_max_service_name_len() to get the maximal service name length.
peer_addr: handle to use for sending packets and recognize source of messages.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if no ep object, name or peer_address pointer given. DOCA_ERROR_DRIVER if failed to query the capabilities of the device that was set for the ep or acquire device attributes. DOCA_ERROR_NOT_SUPPORTED if tried to call connect on a device that doesn't have the capability to connect to Comm Channel. DOCA_ERROR_NOT_PERMITTED if the endpoint is already connected. DOCA_ERROR_BAD_STATE if no doca_dev was set. DOCA_ERROR_NO_MEMORY if memory allocation failed. DOCA_ERROR_INITIALIZATION if initialization of ep connection failed. DOCA_ERROR_CONNECTION_ABORTED if connection failed for any reason (connections rejected or failed).

Description

This function available only for client-side use. As part of the connection process, the client initiates an internal handshake protocol with the service.

If the connect function is being called before the service perform listen with the same name the connection will fail.

doca_error_t doca_comm_channel_ep_create ( doca_comm_channel_ep_t** ep )

Create local endpoint The endpoint handle represents all the configuration needed for the channel to run. The user needs to hold one endpoint for all actions with the comm channel on his side.

Parameters

ep: handle to the newly created endpoint.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if no ep pointer or no attribute object was given. DOCA_ERROR_NO_MEMORY if memory allocation failed during ep creation. DOCA_ERROR_INITIALIZATION if initialization of ep failed. DOCA_ERROR_DRIVER if acquiring device attributes failed.

Description

doca_error_t doca_comm_channel_ep_destroy ( doca_comm_channel_ep_t* local_ep )

Release endpoint handle.

Parameters

local_ep: handle for the endpoint created beforehand with doca_comm_channel_ep_create().

Returns

DOCA_SUCCESS on success. DOCA_ERROR_NOT_CONNECTED if ep does not exist.

Description

The function close the event_channel and release all internal resources. The doca_comm_channel_ep_disconnect() is included as part of the destroy process.

doca_error_t doca_comm_channel_ep_disconnect ( doca_comm_channel_ep_t* local_ep, doca_comm_channel_addr_t* peer_addr )

Disconnect the endpoint from the remote peer. block until all resources related to peer address are freed new connection could be created on the endpoint.

Parameters

local_ep: handle for the endpoint created beforehand with doca_comm_channel_ep_create().
peer_addr: peer address to be disconnect from.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if no ep was provided. DOCA_ERROR_NO_MEMORY if a memory related error has occured. DOCA_ERROR_NOT_CONNECTED if there is no connection. DOCA_ERROR_UNKNOWN if an unknown error occured.

Description

doca_error_t doca_comm_channel_ep_event_handle_arm_recv ( doca_comm_channel_ep_t* local_ep )

Arm the event_channel handle for received messages. This function arms the receive completion queue, facilitating blocking on the receive event channel. Blocking should be implemented by the user (poll in Linux, GetQueuedCompletionStatus in Windows).

Parameters

local_ep: handle for the endpoint created beforehand with doca_comm_channel_ep_create().

Returns

DOCA_SUCCESS on success DOCA_ERROR_INVALID_VALUE if no ep object was given.

Description

doca_error_t doca_comm_channel_ep_event_handle_arm_send ( doca_comm_channel_ep_t* local_ep )

Arm the event_channel handle for transmitted messages. This function arms the transmit completion queue, facilitating blocking on the transmit event channel. Blocking should be implemented by the user (poll in Linux, GetQueuedCompletionStatus in Windows).

Parameters

local_ep: handle for the endpoint created beforehand with doca_comm_channel_ep_create().

Returns

DOCA_SUCCESS on success DOCA_ERROR_INVALID_VALUE if no ep object was given.

Description

doca_error_t doca_comm_channel_ep_get_device ( doca_comm_channel_ep_t* ep, doca_dev** device )

get device property of endpoint.

Parameters

ep: endpoint from which the property should be retrieved.
device: current device used in endpoint.

Returns

DOCA_SUCCESS if property was returned successfully. DOCA_ERROR_INVALID_VALUE if an invalid parameter was given.

Description

doca_error_t doca_comm_channel_ep_get_device_rep ( doca_comm_channel_ep_t* ep, doca_dev_rep** device_rep )

get device representor property of endpoint.

Parameters

ep: endpoint from which the property should be retrieved.
device_rep: current device representor used in endpoint.

Returns

DOCA_SUCCESS if property returned successfully. DOCA_ERROR_INVALID_VALUE if an invalid parameter was given.

Description

doca_error_t doca_comm_channel_ep_get_event_channel ( doca_comm_channel_ep_t* local_ep, doca_event_channel_t* send_event_channel, doca_event_channel_t* recv_event_channel )

Extract the event_channel handles for user's use When the user send/receive packets with non-blocking mode, this handle can be used to get interrupt when a new event happened, using epoll() or similar function. The event channels are owned by the endpoint and release when calling doca_comm_channel_ep_destroy(). This function can be called only after calling doca_comm_channel_ep_listen() or doca_comm_channel_ep_connect().

Parameters

local_ep: handle for the endpoint created beforehand with doca_comm_channel_ep_create().
send_event_channel: handle for send event channel.
recv_event_channel: handle for receive event channel.

Returns

DOCA_SUCCESS on success DOCA_ERROR_INVALID_VALUE if no ep was provided or if both event channel output params are null. DOCA_ERROR_BAD_STATE if called before calling doca_comm_channel_ep_listen() or doca_comm_channel_ep_connect(). DOCA_ERROR_NOT_FOUND if another error occurred.

Description

doca_error_t doca_comm_channel_ep_get_max_msg_size ( doca_comm_channel_ep_t* ep, uint16_t* max_msg_size )

get maximal msg size property of endpoint. The size returned is the actual size being used and might differ from the size set with doca_comm_channel_ep_set_max_msg_size(), as there is a minimal size requirement. If maximal msg size was not set, using doca_comm_channel_ep_set_max_msg_size(), a default value is used and can be inquired by calling doca_comm_channel_ep_get_max_msg_size().

Parameters

ep: endpoint from which the property should be retrieved.
max_msg_size: maximal msg size used by the endpoint.

Returns

DOCA_SUCCESS if property was returned successfully. DOCA_ERROR_INVALID_VALUE if an invalid parameter was given.

Description

doca_error_t doca_comm_channel_ep_get_peer_addr_list ( const doca_comm_channel_ep_t* local_ep, doca_comm_channel_addr_t*** peer_addr_array, uint32_t* peer_addr_array_len )

get an array of the peer_addr connected to a given service object

Parameters

local_ep: Pointer to service endpoint to get peer_addr array for.
peer_addr_array: An array of connected peer_addr objects.
peer_addr_array_len: The number of entries in the output peer_addr_array.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if any of the arguments are NULL. DOCA_ERROR_NOT_SUPPORTED if called on a client endpoint.

Description

This function can only be called on the service side. This function will return an array of all peer_addr conected to the given service endpoint, based on the information that was updated at the last time doca_comm_channel_ep_update_service_state_info() was called.

Note:

When calling doca_comm_channel_ep_update_service_state_info() any previously received peer_addr_array is invalidated.

doca_error_t doca_comm_channel_ep_get_pending_connections ( const doca_comm_channel_ep_t* local_ep, uint32_t* pending_connections )

get the number of pending connections for a given service endpoint

Parameters

local_ep: Pointer to peer_addr to get pending connections for.
pending_connections: The number of pending connections for the given service endpoint.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if any of the arguments are NULL. DOCA_ERROR_NOT_SUPPORTED if called on a client endpoint.

Description

This function can only be called on the service side. This function will return the number of pending connections for the given service endpoint, based on the information that was updated at the last time doca_comm_channel_ep_update_service_state_info() was called. Pending connections are connections that are waiting for handshake to be completed. doca_comm_channel_ep_recvfrom() should be called to handle pending connections.

doca_error_t doca_comm_channel_ep_get_recv_queue_size ( doca_comm_channel_ep_t* ep, uint16_t* recv_queue_size )

get receive queue size property of endpoint. The size returned is the actual size being used and might differ from the size set with doca_comm_channel_ep_set_recv_queue_size(), as there is a minimal size requirement and the size is rounded up to the closest power of 2. If receive queue size was not set, using doca_comm_channel_ep_set_recv_queue_size(), a default value is used and can be inquired by calling doca_comm_channel_ep_get_recv_queue_size().

Parameters

ep: endpoint from which the property should be retrieved.
recv_queue_size: receive queue size used by the endpoint.

Returns

DOCA_SUCCESS if property was returned successfully. DOCA_ERROR_INVALID_VALUE if an invalid parameter was given.

Description

doca_error_t doca_comm_channel_ep_get_send_queue_size ( doca_comm_channel_ep_t* ep, uint16_t* send_queue_size )

get send queue size property of endpoint. The size returned is the actual size being used and might differ from the size set with doca_comm_channel_ep_set_send_queue_size(), as there is a minimal size requirement and the size is rounded up to the closest power of 2. If send queue size was not set, using doca_comm_channel_ep_set_send_queue_size(), a default value is used and can be inquired by calling doca_comm_channel_ep_get_send_queue_size().

Parameters

ep: endpoint from which the property should be retrieved.
send_queue_size: send queue size used by the endpoint.

Returns

DOCA_SUCCESS if property was returned successfully. DOCA_ERROR_INVALID_VALUE if an invalid parameter was given.

Description

doca_error_t doca_comm_channel_ep_get_service_event_channel ( doca_comm_channel_ep_t* local_ep, doca_event_channel_t* service_event_channel )

Extract the service_event_channel handle for user's use This handle can be used to get interrupt when one of the following events occure: new client connected, client disconnected or service moved to error state using epoll() or similar function. If an event was received, the application can call doca_comm_channel_ep_update_service_state_info() and it's query functions to get the current service state. The service event channel is armed automatically upon calling doca_comm_channel_ep_update_service_state_info().

Parameters

local_ep: handle for the endpoint created beforehand with doca_comm_channel_ep_create().
service_event_channel: handle for service event channel.

Returns

DOCA_SUCCESS on success DOCA_ERROR_INVALID_VALUE if no ep was provided or if service_event_channel is NULL. DOCA_ERROR_BAD_STATE if called before calling doca_comm_channel_ep_listen(). DOCA_ERROR_NOT_SUPPORTED if called on a non-service instant.

Description

The event channels are owned by the endpoint and release when calling doca_comm_channel_ep_destroy(). This function can be called only after calling doca_comm_channel_ep_listen().

This function available only for service side use.

doca_error_t doca_comm_channel_ep_listen ( doca_comm_channel_ep_t* local_ep, const char* name )

Service side listen on all interfaces.

Parameters

local_ep: handle for the endpoint created beforehand with doca_comm_channel_ep_create().
name: identifies the service. Use doca_comm_channel_get_max_service_name_len() to get the maximal service name length.

Returns

DOCA_SUCCESS on success DOCA_ERROR_INVALID_VALUE if no ep object or no name was given. DOCA_ERROR_DRIVER if failed to query the capabilities of the device that was set for the ep. DOCA_ERROR_NOT_SUPPORTED if tried to call listen on a device that doesn't have the capability to be defiend as the service side for Comm Channel. DOCA_ERROR_BAD_STATE if no doca_dev or no doca_dev_rep was set. DOCA_ERROR_NOT_PERMITTED if the endpoint is already listening. DOCA_ERROR_NO_MEMORY if memory allocation failed. DOCA_ERROR_INITIALIZATION if initialization of service failed. DOCA_ERROR_CONNECTION_ABORTED if registration of service failed. DOCA_ERROR_DRIVER if acquiring device attributes failed.

Description

Endpoint will start listening on given devices. After calling this function the user should call doca_comm_channel_ep_recvfrom() in order to get new peers to communicate with.

This function available only for service side use.

doca_error_t doca_comm_channel_ep_recvfrom ( doca_comm_channel_ep_t* local_ep, void* msg, size_t* len, int flags, doca_comm_channel_addr_t** peer_addr )

Receive message from connected client/service.

Parameters

local_ep: handle for the endpoint created beforehand with doca_comm_channel_ep_create().
msg: pointer to the buffer where the message should be stored.
len: input - maximum len of bytes in the msg buffer, output - len of actual received message.
flags: flag for receive command. currently no flags are supported.
peer_addr: received message source address handle

Returns

DOCA_SUCCESS on successful receive. If a message was received, the value pointed by len will be updated with the number of bytes received. DOCA_ERROR_INVALID_VALUE if any of the parameters is NULL. DOCA_ERROR_NOT_CONNECTED if endpoint is service and listen was not called. DOCA_ERROR_AGAIN if no message was received. when returned, the user can use the endpoint's doca_event_channel_t to get indication for a new arrival message. DOCA_ERROR_CONNECTION_RESET if the message received is from a peer_addr that has error. DOCA_ERROR_INITIALIZATION if initialization of the DCI after a send error failed DOCA_ERROR_UNKNOWN if an unknown error occurred.

Description

On service side, doca_comm_channel_ep_recvfrom() also used for accepting new connection from clients.

doca_error_t doca_comm_channel_ep_sendto ( doca_comm_channel_ep_t* local_ep, const void* msg, size_t len, int flags, doca_comm_channel_addr_t* peer_addr )

Send message to peer address. The connection to the wanted peer_address need to be established before sending the message.

Parameters

local_ep: handle for the endpoint created beforehand with doca_comm_channel_ep_create().
msg: pointer to the message to be sent.
len: length in bytes of msg.
flags: flag for send command. currently no flags are supported.
peer_addr: destination address handle of the send operation.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_NOT_CONNECTED if no peer_address was supplied or no connection was found. DOCA_ERROR_INVALID_VALUE if the supplied len was larger than the msgsize given at ep creation or any of the input variables are null. DOCA_ERROR_AGAIN if the send queue is full. when returned, the user can use the endpoint's doca_event_channel_t to get indication for a new empty slot. DOCA_ERROR_CONNECTION_RESET if the provided peer_addr experienced an error and it needs to be disconnected. DOCA_ERROR_INITIALIZATION if initialization of the DCI after a send error failed DOCA_ERROR_UNKNOWN if an unknown error occurred.

Description

doca_error_t doca_comm_channel_ep_set_device ( doca_comm_channel_ep_t* ep, doca_dev* device )

set device property for endpoint.

Parameters

ep: endpoint to set the property for.
device: device to use in endpoint.

Returns

DOCA_SUCCESS if property set successfully. DOCA_ERROR_INVALID_VALUE if an invalid parameter was given. DOCA_ERROR_BAD_STATE if endpoint is already active.

Description

doca_error_t doca_comm_channel_ep_set_device_rep ( doca_comm_channel_ep_t* ep, doca_dev_rep* device_rep )

set device representor property for endpoint.

Parameters

ep: endpoint to set the property for.
device_rep: device representor to use in endpoint.

Returns

DOCA_SUCCESS if property set successfully. DOCA_ERROR_INVALID_VALUE if an invalid parameter was given. DOCA_ERROR_BAD_STATE if endpoint is already active.

Description

doca_error_t doca_comm_channel_ep_set_max_msg_size ( doca_comm_channel_ep_t* ep, uint16_t max_msg_size )

set maximal msg size property for endpoint. The value max_msg_size may be increased internally, the actual value can be queried using doca_comm_channel_ep_get_max_msg_size().

Parameters

ep: endpoint to set the property for.
max_msg_size: maximal msg size to use in endpoint.

Returns

DOCA_SUCCESS if property set successfully. DOCA_ERROR_INVALID_VALUE if an invalid parameter was given. DOCA_ERROR_BAD_STATE if endpoint is already active.

Description

doca_error_t doca_comm_channel_ep_set_recv_queue_size ( doca_comm_channel_ep_t* ep, uint16_t recv_queue_size )

set receive queue size property for endpoint. The value recv_queue_size may be increased internally, the actual value can be queried using doca_comm_channel_ep_get_recv_queue_size().

Parameters

ep: endpoint to set the property for.
recv_queue_size: receive queue size to use in endpoint.

Returns

DOCA_SUCCESS if property set successfully. DOCA_ERROR_INVALID_VALUE if an invalid parameter was given. DOCA_ERROR_BAD_STATE if endpoint is already active.

Description

doca_error_t doca_comm_channel_ep_set_send_queue_size ( doca_comm_channel_ep_t* ep, uint16_t send_queue_size )

set send queue size property for endpoint. The value send_queue_size may be increased internally, the actual value can be queried using doca_comm_channel_ep_get_send_queue_size().

Parameters

ep: endpoint to set the property for.
send_queue_size: send queue size to use in endpoint.

Returns

DOCA_SUCCESS if property set successfully. DOCA_ERROR_INVALID_VALUE if an invalid parameter was given. DOCA_ERROR_BAD_STATE if endpoint is already active.

Description

doca_error_t doca_comm_channel_ep_update_service_state_info ( doca_comm_channel_ep_t* local_ep )

update the connections status for a given service endpoint

Parameters

local_ep: Pointer to endpoint to update the connections status on.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if local_ep is NULL. DOCA_ERROR_NOT_SUPPORTED if called on a client endpoint. DOCA_ERROR_DRIVER if failed to query the service status. DOCA_ERROR_AGAIN if an unexpected number of new clients joined and service status needs to be queried again. DOCA_ERROR_CONNECTION_RESET if the the service is in error state.

Description

Can only be called on the service side. This function saves a snapshot of the current service state, which can be queried using the functions doca_comm_channel_ep_get_peer_addr_list() or doca_comm_channel_ep_get_pending_connections(). This function can also be used to check if service is in error state, in that case it cannot be recovered and needs to be destroyed.

Note:

Calling this function will also invalidate any peer_addr_array received from previous calls to doca_comm_channel_ep_get_peer_addr_list().

doca_error_t doca_comm_channel_get_max_message_size ( doca_devinfo* devinfo, uint32_t* max_message_size )

Get the maximum message size supported by comm_channel.

Parameters

devinfo: devinfo that should be inquired for its maximum message size under comm channel limitations.
max_message_size: the maximum message size supported by comm_channel.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if either devinfo or max_message_size is NULL. DOCA_ERROR_UNEXPECTED if an unexpected error occurred.

Description

doca_error_t doca_comm_channel_get_max_recv_queue_size ( doca_devinfo* devinfo, uint32_t* max_recv_queue_size )

Get the maximum receive queue size supported by comm_channel.

Parameters

devinfo: devinfo that should be inquired for its maximum receive queue size under comm channel limitations.
max_recv_queue_size: the maximum receive queue size supported by comm_channel.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if either devinfo or max_recv_queue_size is NULL. DOCA_ERROR_UNEXPECTED if an unexpected error occurred.

Description

doca_error_t doca_comm_channel_get_max_send_queue_size ( doca_devinfo* devinfo, uint32_t* max_send_queue_size )

Get the maximum send queue size supported by comm_channel.

Parameters

devinfo: devinfo that should be inquired for its maximum send queue size under comm channel limitations.
max_send_queue_size: the maximum send queue size supported by comm_channel.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if either devinfo or max_send_queue_size is NULL. DOCA_ERROR_UNEXPECTED if an unexpected error occurred.

Description

doca_error_t doca_comm_channel_get_max_service_name_len ( uint32_t* max_service_name_len )

Get the comm_channel maximum Service name length.

Parameters

max_service_name_len: The comm_channel max service name length, including the terminating null byte ('').

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if max_service_name_len is NULL.

Description

doca_error_t doca_comm_channel_get_service_max_num_connections ( doca_devinfo* devinfo, uint32_t* max_num_connections )

Get the maximum number of connections the service can hold.

Parameters

devinfo: devinfo that should be inquired for its maximum number of connections.
max_num_connections: the maximum number of connections the service can hold.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if either devinfo or max_num_connections is NULL. DOCA_ERROR_NOT_SUPPORTED if querying this capability is not supported by the device. DOCA_ERROR_UNEXPECTED if an unexpected error occurred.

Description

Note:

This capability should be queried only on the service side.

doca_error_t doca_comm_channel_peer_addr_get_recv_bytes ( const doca_comm_channel_addr_t* peer_addr, uint64_t* recv_bytes )

get total bytes received from specific peer address

Parameters

peer_addr: Pointer to peer_addr to query statistics for.
recv_bytes: Will contain the number of received bytes from the given peer_addr.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if any of the arguments are NULL.

Description

This function will return the total number of bytes received from a given peer_addr, updated to the last time doca_comm_channel_peer_addr_update_info() was called.

doca_error_t doca_comm_channel_peer_addr_get_recv_messages ( const doca_comm_channel_addr_t* peer_addr, uint64_t* recv_messages )

get total messages received from specific peer address

Parameters

peer_addr: Pointer to peer_addr to query statistics for.
recv_messages: Will contain the number of received messages from the given peer_addr.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if any of the arguments are NULL.

Description

This function will return the total number of messages received from a given peer_addr, updated to the last time doca_comm_channel_peer_addr_update_info() was called.

doca_error_t doca_comm_channel_peer_addr_get_send_bytes ( const doca_comm_channel_addr_t* peer_addr, uint64_t* send_bytes )

get total bytes sent to specific peer address

Parameters

peer_addr: Pointer to peer_addr to query statistics for.
send_bytes: Will contain the number of sent messages to the given peer_addr.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if any of the arguments are NULL.

Description

This function will return the total number of bytes sent to a given peer_addr, updated to the last time doca_comm_channel_peer_addr_update_info() was called.

doca_error_t doca_comm_channel_peer_addr_get_send_in_flight_messages ( const doca_comm_channel_addr_t* peer_addr, uint64_t* send_in_flight_messages )

get number of messages in transmission to a specific peer address

Parameters

peer_addr: Pointer to peer_addr to query statistics for.
send_in_flight_messages: Will contain the number of sent messages in transmission to the given peer_addr.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if any of the arguments are NULL.

Description

This function will return the number of messages still in transmission to a specific peer_addr, updated to the last time doca_comm_channel_peer_addr_update_info() was called. This function can be used to make sure all transmissions are finished before disconnection.

doca_error_t doca_comm_channel_peer_addr_get_send_messages ( const doca_comm_channel_addr_t* peer_addr, uint64_t* send_messages )

get total messages sent to specific peer address

Parameters

peer_addr: Pointer to peer_addr to query statistics for.
send_messages: Will contain the number of sent messages to the given peer_addr.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if any of the arguments are NULL.

Description

This function will return the total number of messages sent to a given peer_addr, updated to the last time doca_comm_channel_peer_addr_update_info() was called.

doca_error_t doca_comm_channel_peer_addr_get_user_data ( doca_comm_channel_addr_t* peer_addr, uint64_t* user_data )

Extract 'user_context' from peer_addr handle. By default, the 'user_context' is set to 0 and can be change using doca_comm_channel_peer_addr_set_user_data().

Parameters

peer_addr: Pointer to peer_addr to extract user_context from.
user_data: will contain the extracted data.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if peer_address or user_data is NULL.

Description

doca_error_t doca_comm_channel_peer_addr_set_user_data ( doca_comm_channel_addr_t* peer_addr, uint64_t user_context )

Save 'user_context' in peer_addr handle.

Parameters

peer_addr: Pointer to peer_addr to set user_context to.
user_context: Data to set for peer_addr.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if peer_address is NULL.

Description

Can be use by the user to identify the peer address received from doca_comm_channel_ep_recvfrom(). The user_context for new peers is initialized to 0.

doca_error_t doca_comm_channel_peer_addr_update_info ( doca_comm_channel_addr_t* peer_addr )

update statistics for given peer_addr

Parameters

peer_addr: Pointer to peer_addr to update statistics in.

Returns

DOCA_SUCCESS on success. DOCA_ERROR_INVALID_VALUE if peer_addr is NULL. DOCA_ERROR_CONNECTION_INPROGRESS if connection is not yet established. DOCA_ERROR_CONNECTION_ABORTED if the connection failed.

Description

Should be used before calling to any peer_addr information function to update the saved statistics. This function can also be used to check if connection to a given peer_addr is currently connected. If a connection has failed, it is the user's responsibility to call doca_comm_channel_ep_disconnect() to free the peer_addr resources.

2.6. Common Defines

2.7. Compatibility Management

Lib to define compatibility with current version, define experimental Symbols.

To set a Symbol (or specifically a function) as experimental:

__DOCA_EXPERIMENTAL int func_declare(int param1, int param2);

To remove warnings of experimental compile with "-D DOCA_ALLOW_EXPERIMENTAL_API"

Defines

#define DOCA_STRUCT_START
#define __DOCA_EXPERIMENTAL: To set a Symbol (or specifically a function) as experimental.

Defines

#define DOCA_STRUCT_START

Compatibility Helpers

Value

uint32_t __doca_api_version

#define __DOCA_EXPERIMENTAL

Value

__declspec(deprecated("Symbol is defined as experimental"), DLL_EXPORT_ATTR)

2.8. DOCA COMPRESS Engine

DOCA COMPRESS library. For more details please refer to the user guide on DOCA devzone.

Classes

struct doca_compress_deflate_job
struct doca_compress_lz4_job

Enumerations

enum doca_compress_job_types

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_compress_as_ctx ( doca_compress* compress )
doca_error_t doca_compress_create ( doca_compress** compress )
doca_error_t doca_compress_destroy ( doca_compress* compress )
doca_error_t doca_compress_get_max_buf_size ( const doca_devinfo* devinfo, doca_compress_job_types job_type, uint64_t* max_buffer_size )
doca_error_t doca_compress_get_max_list_buf_num_elem ( const doca_devinfo* devinfo, uint32_t* max_list_num_elem )
doca_error_t doca_compress_job_get_supported ( doca_devinfo* devinfo, doca_compress_job_types job_type )

Enumerations

enum doca_compress_job_types

Available jobs for DOCA COMPRESS.

Values

DOCA_COMPRESS_DEFLATE_JOB = DOCA_ACTION_COMPRESS_FIRST+1
DOCA_DECOMPRESS_DEFLATE_JOB
DOCA_DECOMPRESS_LZ4_JOB

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_compress_as_ctx ( doca_compress* compress )

Parameters

compress: COMPRESS instance. This must remain valid until after the context is no longer required.

Returns

Non NULL upon success, NULL otherwise.

Description

Convert doca_compress instance into a generalised context for use with doca core objects.

doca_error_t doca_compress_create ( doca_compress** compress )

Parameters

compress: Pointer to pointer to be set to point to the created doca_compress instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - compress argument is a NULL pointer.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_compress.
DOCA_ERROR_INITIALIZATION - failed to initialize a mutex.

Description

Create a DOCA COMPRESS instance.

doca_error_t doca_compress_destroy ( doca_compress* compress )

Parameters

compress: Pointer to instance to be destroyed.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_IN_USE - if unable to gain exclusive access to the compress instance or if one or more work queues are still attached. These must be detached first.

Description

Destroy a DOCA COMPRESS instance.

doca_error_t doca_compress_get_max_buf_size ( const doca_devinfo* devinfo, doca_compress_job_types job_type, uint64_t* max_buffer_size )

Parameters

devinfo: The DOCA device information
job_type: doca_compress job type. See enum doca_compress_job_types.
max_buffer_size: The max buffer size for DOCA COMPRESS operation in bytes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - failed to query device capabilities. or provided devinfo does not support the given doca_compress job.

Description

Get maximum buffer size for DOCA COMPRESS job.

doca_error_t doca_compress_get_max_list_buf_num_elem ( const doca_devinfo* devinfo, uint32_t* max_list_num_elem )

Parameters

devinfo: The DOCA device information.
max_list_num_elem: The maximum supported number of elements in DOCA linked-list buffer. The value 1 indicates that only a single element is supported.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.

Description

Get the maximum supported number of elements in DOCA linked-list buffer for compress job.

doca_error_t doca_compress_job_get_supported ( doca_devinfo* devinfo, doca_compress_job_types job_type )

Parameters

devinfo: The DOCA device information
job_type: doca_compress job type. See enum doca_compress_job_types.

Returns

DOCA_SUCCESS - in case the job is supported. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - failed to query device capabilities or provided devinfo does not support the given doca_compress job.

Description

Check if given device is capable for given doca_compress job.

2.9. Environment Configurations

Defines

#define DOCA_COMPAT_HELPERS: declares the support/need for compatibility helper utils

Defines

#define DOCA_COMPAT_HELPERS

2.10. DOCA DMA Engine

DOCA DMA library. For more details please refer to the user guide on DOCA devzone.

Classes

struct doca_dma_job_memcpy
struct doca_dma_memcpy_result

Enumerations

enum doca_dma_job_types

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_dma_as_ctx ( doca_dma* dma )
doca_error_t doca_dma_create ( doca_dma** dma )
doca_error_t doca_dma_destroy ( doca_dma* dma )
doca_error_t doca_dma_get_max_buf_size ( const doca_devinfo* devinfo, uint64_t* buf_size )
doca_error_t doca_dma_get_max_list_buf_num_elem ( const doca_devinfo* devinfo, uint32_t* max_list_num_elem )
doca_error_t doca_dma_job_get_supported ( doca_devinfo* devinfo, doca_dma_job_types job_type )

Enumerations

enum doca_dma_job_types

Available jobs for DMA.

Values

DOCA_DMA_JOB_MEMCPY = DOCA_ACTION_DMA_FIRST+1

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_dma_as_ctx ( doca_dma* dma )

Parameters

dma: DMA instance. This must remain valid until after the context is no longer required.

Returns

Non NULL upon success, NULL otherwise.

Description

Convert doca_dma instance into a generalised context for use with doca core objects.

doca_error_t doca_dma_create ( doca_dma** dma )

Parameters

dma: Pointer to pointer to be set to point to the created doca_dma instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - dma argument is a NULL pointer.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_dma.
DOCA_ERROR_INITIALIZATION - failed to initialise a mutex.

Description

Create a DOCA DMA instance.

doca_error_t doca_dma_destroy ( doca_dma* dma )

Parameters

dma: Pointer to instance to be destroyed.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_IN_USE - Unable to gain exclusive access to the dma instance.
DOCA_ERROR_IN_USE - One or more work queues are still attached. These must be detached first.

Description

doca_error_t doca_dma_get_max_buf_size ( const doca_devinfo* devinfo, uint64_t* buf_size )

Parameters

devinfo: The DOCA device information.
buf_size: The maximum supported buffer size in bytes.

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.

Description

Get the maximum supported buffer size for DMA job.

doca_error_t doca_dma_get_max_list_buf_num_elem ( const doca_devinfo* devinfo, uint32_t* max_list_num_elem )

Parameters

devinfo: The DOCA device information.
max_list_num_elem: The maximum supported number of elements in a given DOCA linked-list buffer, such that 1 indicates no linked-list buffer support.

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.

Description

Get the maximum supported number of elements in a given DOCA linked-list buffer for DMA job.

doca_error_t doca_dma_job_get_supported ( doca_devinfo* devinfo, doca_dma_job_types job_type )

Parameters

devinfo: The DOCA device information
job_type: DMA job_type available through this device. see enum doca_dma_job_types.

Returns

DOCA_SUCCESS - in case device supports job_type. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support this DMA job.

Description

Check if given device is capable of excuting a specific DMA job.

2.13. Deep Packet Inspection

DOCA Deep packet inspection library. For more details please refer to the user guide on DOCA devzone.

Classes

struct doca_dpi_job: DOCA_DPI job definition.
struct doca_dpi_parsing_info: L2-L4 flow information, used to uniquely define a flow.
struct doca_dpi_result: DOCA_DPI result definition.
struct doca_dpi_sig_data: Extra signature data.
struct doca_dpi_sig_info: Signature info.
struct doca_dpi_stat_info: DPI statistics.

Enumerations

enum doca_dpi_flow_status_t: Status of enqueued flow.
enum doca_dpi_job_types: DOCA_DPI job types.
enum doca_dpi_sig_action_t: Signature action. Some signatures may come with an action.

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_dpi_as_ctx ( doca_dpi* dpi ): Convert DOCA_DPI instance into context for use with workQ.
doca_error_t doca_dpi_create ( doca_dpi** dpi ): Create a DOCA_DPI instance.
doca_error_t doca_dpi_destroy ( doca_dpi* dpi ): Destroy DOCA_DPI instance.
doca_error_t doca_dpi_flow_create ( doca_dpi* dpi, doca_workq* workq, const doca_dpi_parsing_info* parsing_info, doca_dpi_flow_ctx** flow_ctx ): Creates a new flow for a workq.
doca_error_t doca_dpi_flow_destroy ( doca_dpi_flow_ctx* flow_ctx ): Destroys a flow on a workq.
doca_error_t doca_dpi_get_flow_match ( const doca_dpi_flow_ctx* flow_ctx, doca_dpi_result* result ): Get the latest match of a flow.
doca_error_t doca_dpi_get_max_sig_match_len ( const doca_dpi* dpi, uint16_t* max_sig_match_len ): Get the maximum signature match length of a DPI instance.
doca_error_t doca_dpi_get_per_workq_max_flows ( const doca_dpi* dpi, uint32_t* per_workq_max_flows ): Return the configures maximum active flows per workq.
doca_error_t doca_dpi_get_per_workq_packet_pool_size ( const doca_dpi* dpi, uint32_t* per_workq_packet_pool_size ): Return the value in the corresponding set command.
doca_error_t doca_dpi_get_signature ( const doca_dpi* dpi, uint32_t sig_id, doca_dpi_sig_data* sig_data ): Get a specific signature data of a DPI instance.
doca_error_t doca_dpi_get_signatures ( const doca_dpi* dpi, doca_dpi_sig_data** sig_data, uint32_t* total_sigs ): Get all signatures of a DPI instance.
doca_error_t doca_dpi_get_stats ( const doca_dpi* dpi, bool clear, doca_dpi_stat_info* stats ): Get DPI statistics.
doca_error_t doca_dpi_is_supported ( const doca_devinfo* devinfo )
doca_error_t doca_dpi_job_get_supported ( const doca_devinfo* devinfo, doca_dpi_job_types job_type ): Check if given device is capable of excuting a specific DOCA_DPI job.
doca_error_t doca_dpi_set_in_order_mode ( const doca_dpi* dpi, bool enabled ): Enable or disable 'in order' mode.
doca_error_t doca_dpi_set_max_sig_match_len ( doca_dpi* dpi, uint16_t max_sig_match_len ): Set the maximum length that DPI guarantees to provide a match on.
doca_error_t doca_dpi_set_per_workq_max_flows ( doca_dpi* dpi, uint32_t per_workq_max_flows ): Set the maximum number of active flows that can be supported by a DOCA_DPI workq.
doca_error_t doca_dpi_set_per_workq_packet_pool_size ( doca_dpi* dpi, uint32_t per_workq_packet_pool_size ): Set the maximum number of packets packets that can be stored for a DOCA_DPI workq.
doca_error_t doca_dpi_set_signatures ( doca_dpi* dpi, const char* cdo_file ): Set the cdo file.

Enumerations

enum doca_dpi_flow_status_t

Values

DOCA_DPI_STATUS_LAST_PACKET = 1<<1: Indicates there are no more packets in queue from this flow.
DOCA_DPI_STATUS_DESTROYED = 1<<2: Indicates flow was destroyed while being processed
DOCA_DPI_STATUS_NEW_MATCH = 1<<3: Indicates flow was matched on current dequeue

enum doca_dpi_job_types

Values

DOCA_DPI_JOB = DOCA_ACTION_DPI_FIRST+1

enum doca_dpi_sig_action_t

Values

DOCA_DPI_SIG_ACTION_NA: Action not available for signature
DOCA_DPI_SIG_ACTION_ALERT: Alert
DOCA_DPI_SIG_ACTION_PASS: Signature indicates that the flow is allowed
DOCA_DPI_SIG_ACTION_DROP: Signature indicates that the flow should be dropped
DOCA_DPI_SIG_ACTION_REJECT: Send RST/ICMP unreach error to the sender of the matching packet
DOCA_DPI_SIG_ACTION_REJECTSRC: Send RST/ICMP unreach error to the sender of the matching packet
DOCA_DPI_SIG_ACTION_REJECTDST: Send RST/ICMP error packet to receiver of the matching packet
DOCA_DPI_SIG_ACTION_REJECTBOTH: Send RST/ICMP error packets to both sides of the conversation

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_dpi_as_ctx ( doca_dpi* dpi )

Convert DOCA_DPI instance into context for use with workQ.

Parameters

dpi: DOCA_DPI instance. This must remain valid until after the context is no longer required.

Returns

Non NULL - doca_ctx object on success. Error:

NULL.

Description

doca_error_t doca_dpi_create ( doca_dpi** dpi )

Create a DOCA_DPI instance.

Parameters

dpi: Instance pointer to be created, MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - not enough memory for allocation.
DOCA_ERROR_NOT_SUPPORTED - the required engine is not supported.

Description

This function must be invoked first before any function in the API. It should be invoked once per process.

This call will probe the first regex device it finds (0), when we still use the dpdk-regex as backend.

doca_error_t doca_dpi_destroy ( doca_dpi* dpi )

Destroy DOCA_DPI instance.

Parameters

dpi: Instance to be destroyed, MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - the attached workq is not detached yet. Please call doca_ctx_stop().

Description

doca_error_t doca_dpi_flow_create ( doca_dpi* dpi, doca_workq* workq, const doca_dpi_parsing_info* parsing_info, doca_dpi_flow_ctx** flow_ctx )

Creates a new flow for a workq.

Parameters

dpi: The DOCA_DPI instance.
workq: The DPI workq on which to create the flow
parsing_info: L3/L4 information.
flow_ctx: The created flow.

Description

Must be called before enqueuing any new packet using job_submit(). A flow must not be created on 2 different queues.

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - memory allocation failure.

doca_error_t doca_dpi_flow_destroy ( doca_dpi_flow_ctx* flow_ctx )

Destroys a flow on a workq.

Parameters

flow_ctx: The flow context to destroy.

Description

Should be called when a flow is terminated or times out

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

doca_error_t doca_dpi_get_flow_match ( const doca_dpi_flow_ctx* flow_ctx, doca_dpi_result* result )

Get the latest match of a flow.

Parameters

flow_ctx: The flow context of the flow to be queried.
result: Output, latest match on this flow. Only "matched" and "info" fields in the result parameter are valid.

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.

Description

doca_error_t doca_dpi_get_max_sig_match_len ( const doca_dpi* dpi, uint16_t* max_sig_match_len )

Get the maximum signature match length of a DPI instance.

Parameters

dpi: The DOCA_DPI instance.
max_sig_match_len: Output of the maximum signature match length

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.

Description

doca_error_t doca_dpi_get_per_workq_max_flows ( const doca_dpi* dpi, uint32_t* per_workq_max_flows )

Return the configures maximum active flows per workq.

Parameters

dpi: The DOCA_DPI instance.
per_workq_max_flows: The maximum parallel flows supported per workq.

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.

Description

doca_error_t doca_dpi_get_per_workq_packet_pool_size ( const doca_dpi* dpi, uint32_t* per_workq_packet_pool_size )

Return the value in the corresponding set command.

Parameters

dpi: The DOCA_DPI instance.
per_workq_packet_pool_size: Output of the maximum inflight job number.

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.

Description

doca_error_t doca_dpi_get_signature ( const doca_dpi* dpi, uint32_t sig_id, doca_dpi_sig_data* sig_data )

Get a specific signature data of a DPI instance.

Parameters

dpi: The DOCA_DPI instance.
sig_id: The signature ID.
sig_data: Output of the sig data.

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.

Description

doca_error_t doca_dpi_get_signatures ( const doca_dpi* dpi, doca_dpi_sig_data** sig_data, uint32_t* total_sigs )

Get all signatures of a DPI instance.

Parameters

dpi: The DOCA_DPI instance.
sig_data: Output of the sig data.
total_sigs: Output of the number of signatures.

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_NO_MEMORY - memory allocation failure.

Description

It is the responsibility of the user to free the array. Because this function copies all the sig info, it is highly recommended to call this function only once after loading the database, and not during packet processing.

doca_error_t doca_dpi_get_stats ( const doca_dpi* dpi, bool clear, doca_dpi_stat_info* stats )

Get DPI statistics.

Parameters

dpi: The DOCA_DPI instance.
clear: Clear the statistics after fetching them.
stats: Output struct containing the statistics.

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.

Description

doca_error_t doca_dpi_is_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: Device to check.

Returns

DOCA_SUCCESS - Device can be used with doca_dpi. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - Device cannot be used with doca_dpi.

Description

Determine if a given device is suitable for use with doca_dpi.

doca_error_t doca_dpi_job_get_supported ( const doca_devinfo* devinfo, doca_dpi_job_types job_type )

Check if given device is capable of excuting a specific DOCA_DPI job.

Parameters

devinfo: The DOCA device information
job_type: DOCA_DPI job_type to check for support.

Returns

DOCA_SUCCESS - in case device supports job_type. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support this DOCA_DPI job.

Description

doca_error_t doca_dpi_set_in_order_mode ( const doca_dpi* dpi, bool enabled )

Enable or disable 'in order' mode.

Parameters

dpi: The DOCA_DPI instance.
enabled: Set to true to turn 'in order' mode on, false to disable it.

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_IN_USE - the required engine resource is not released yet. Please call doca_ctx_stop().

Description

Due to the parallel nature of pattern matching accelerators that may be used by DPI, there is no guarantee that results from jobs sent will be returned in the same order. Enabling 'in order' mode guarantees that results returned per workq will be in the order they were sent.

Note:

This mode is disabled by default. Choosing to enable it may have a negative impact on performance.

doca_error_t doca_dpi_set_max_sig_match_len ( doca_dpi* dpi, uint16_t max_sig_match_len )

Set the maximum length that DPI guarantees to provide a match on.

Parameters

dpi: DOCA_DPI Instance, MUST NOT BE NULL.
max_sig_match_len: The value to be set.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - the required engine resource is not released yet. Please call doca_ctx_stop().

Description

It includes across consecutive packets. Must be <= 5000 For example: Signature = A.*B max_sig_match_len = 5 DPI guarantee that ACCCB will be found (len <= 5) DPI does not guarantee that ACCCCCCCB will be found (len > 5)

doca_error_t doca_dpi_set_per_workq_max_flows ( doca_dpi* dpi, uint32_t per_workq_max_flows )

Set the maximum number of active flows that can be supported by a DOCA_DPI workq.

Parameters

dpi: DOCA_DPI Instance, MUST NOT BE NULL.
per_workq_max_flows: The value to be set.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - the required engine resource is not released yet. Please call doca_ctx_stop().

Description

doca_error_t doca_dpi_set_per_workq_packet_pool_size ( doca_dpi* dpi, uint32_t per_workq_packet_pool_size )

Set the maximum number of packets packets that can be stored for a DOCA_DPI workq.

Parameters

dpi: DOCA_DPI Instance, MUST NOT BE NULL.
per_workq_packet_pool_size: The value to be set.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - the required engine resource is not released yet. Please call doca_ctx_stop().

Description

DOCA_DPI may require that packets are stored to ensure signatures are detected that occur accross multiple packets of the same flow. This value sets the maximum number of packets that can be simultaenously stored for all flows beings processed on a workq. After this function is called, all the "memory" of the previous packets enqueued are deleted.

doca_error_t doca_dpi_set_signatures ( doca_dpi* dpi, const char* cdo_file )

Set the cdo file.

Parameters

dpi: DOCA_DPI Instance, MUST NOT BE NULL.
cdo_file: CDO file created by the DPI compiler.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - the required engine resource is not released yet. Please call doca_ctx_stop().

Description

The cdo file contains signature information. The cdo file must be loaded before doca_dpi instance is started. So the typical usage sequence is: create doca_dpi instance --> set signatures --> start doca_dpi instance.

Database update: When a new signatures database is available, the doca_dpi instance must be stopped first, then, the user may call this function again. So the typical usage sequence is: stop doca_dpi instance --> set new signatures. The newly loaded CDO must contain the signatures of the previously loaded CDO or result will be undefined.

2.15. DOCA ETH RXQ

DOCA ETH RXQ library.

Enumerations

enum doca_eth_rxq_type

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_eth_rxq_as_doca_ctx ( doca_eth_rxq* eth_rxq ): Convert doca_eth_rxq instance into a generalised context for use with doca core objects.
doca_error_t doca_eth_rxq_create ( doca_eth_rxq** eth_rxq ): Create a DOCA ETH RXQ instance.
doca_error_t doca_eth_rxq_destroy ( doca_eth_rxq* eth_rxq ): Destroy a DOCA ETH RXQ instance.
doca_error_t doca_eth_rxq_get_flow_queue_id ( doca_eth_rxq* eth_rxq, uint16_t* flow_queue_id ): Get the DPDK queue ID of the doca_eth receive queue. can only be called after calling doca_ctx_start().
doca_error_t doca_eth_rxq_get_gpu_handle ( const doca_eth_rxq* eth_rxq, doca_gpu_eth_rxq** eth_rxq_ext ): Get a gpu handle of a doca_eth_rxq.
doca_error_t doca_eth_rxq_get_max_packet_size_supported ( const doca_devinfo* devinfo, uint16_t* max_packet_size ): Get the maximum packet size supported by the device.
doca_error_t doca_eth_rxq_get_pkt_buffer_size ( const doca_eth_rxq* eth_rxq, uint32_t* size ): Get the required size for the Eth packet buffer of a doca_eth_rxq.
doca_error_t doca_eth_rxq_get_type_supported ( const doca_devinfo* devinfo, doca_eth_rxq_type type, uint8_t* type_supported ): Check if RX queue type is supported.
doca_error_t doca_eth_rxq_set_max_packet_size ( doca_eth_rxq* eth_rxq, uint16_t max_pkt_sz ): Set max packet size property for doca_eth_rxq. can only be called before calling doca_ctx_start().
doca_error_t doca_eth_rxq_set_num_packets ( doca_eth_rxq* eth_rxq, uint32_t num_packets ): Set queue size property for doca_eth_rxq. can only be called before calling doca_ctx_start().
doca_error_t doca_eth_rxq_set_pkt_buffer ( doca_eth_rxq* eth_rxq, doca_mmap* mmap, uint32_t offset, uint32_t size ): Set Eth packet buffer for a doca_eth_rxq. can only be called before calling doca_ctx_start().
doca_error_t doca_eth_rxq_set_type ( doca_eth_rxq* eth_rxq, doca_eth_rxq_type type ): Set RX queue type property for doca_eth_rxq. can only be called before calling doca_ctx_start().

Enumerations

enum doca_eth_rxq_type

RX queue type.

Values

DOCA_ETH_RXQ_TYPE_CYCLIC = 0

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_eth_rxq_as_doca_ctx ( doca_eth_rxq* eth_rxq )

Convert doca_eth_rxq instance into a generalised context for use with doca core objects.

Parameters

eth_rxq: Pointer to doca_eth_rxq instance.

Returns

Non NULL upon success, NULL otherwise.

Description

doca_error_t doca_eth_rxq_create ( doca_eth_rxq** eth_rxq )

Create a DOCA ETH RXQ instance.

Parameters

eth_rxq: Pointer to pointer to be set to point to the created doca_eth_rxq instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - eth_rxq argument is a NULL pointer.
DOCA_ERROR_NO_MEMORY - failed to allocate resources.
DOCA_ERROR_INITIALIZATION - failed to initialize eth_rxq.

Description

doca_error_t doca_eth_rxq_destroy ( doca_eth_rxq* eth_rxq )

Destroy a DOCA ETH RXQ instance.

Parameters

eth_rxq: Pointer to instance to be destroyed.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - eth_rxq argument is a NULL pointer.
DOCA_ERROR_BAD_STATE - the associated ctx was not stopped before calling doca_eth_rxq_destroy().

Description

doca_error_t doca_eth_rxq_get_flow_queue_id ( doca_eth_rxq* eth_rxq, uint16_t* flow_queue_id )

Get the DPDK queue ID of the doca_eth receive queue. can only be called after calling doca_ctx_start().

Parameters

eth_rxq: Pointer to doca_eth_rxq instance.
flow_queue_id: The queue ID to be used in rte_flow or doca_flow

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context was not started.

Description

doca_error_t doca_eth_rxq_get_gpu_handle ( const doca_eth_rxq* eth_rxq, doca_gpu_eth_rxq** eth_rxq_ext )

Get a gpu handle of a doca_eth_rxq.

Parameters

eth_rxq: Pointer to doca_eth_rxq instance.
eth_rxq_ext: A doca gpu eth_rxq handle.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is not started.

Description

This method should be used after ctx is started. The expected flow is as follows: 1. bind the ctx to a gpu device using doca_ctx_set_data_path_on_gpu() 2. start the ctx using doca_ctx_start() 3. call doca_eth_rxq_get_gpu_handle() to get the gpu_handle

doca_error_t doca_eth_rxq_get_max_packet_size_supported ( const doca_devinfo* devinfo, uint16_t* max_packet_size )

Get the maximum packet size supported by the device.

Parameters

devinfo: Pointer to doca_devinfo instance.
max_packet_size: The max packet size.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.

Description

doca_error_t doca_eth_rxq_get_pkt_buffer_size ( const doca_eth_rxq* eth_rxq, uint32_t* size )

Get the required size for the Eth packet buffer of a doca_eth_rxq.

Parameters

eth_rxq: Pointer to doca_eth_rxq instance.
size: The required size for the eth packet buffer.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - in case of uninitialized queue size (packet_size, num_packets).

Description

This function should be used for calculating the minimum size of the doca_mmap given to doca_eth_rxq_set_pkt_buffer().

Note:

Must be called after doca_eth_rxq_set_num_packets() and doca_eth_rxq_set_max_packet_size().

doca_error_t doca_eth_rxq_get_type_supported ( const doca_devinfo* devinfo, doca_eth_rxq_type type, uint8_t* type_supported )

Check if RX queue type is supported.

Parameters

devinfo: Pointer to doca_devinfo instance.
type: RX queue type - see enum doca_eth_rxq_type
type_supported: Flag to indicate if type is supported.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.

Description

doca_error_t doca_eth_rxq_set_max_packet_size ( doca_eth_rxq* eth_rxq, uint16_t max_pkt_sz )

Set max packet size property for doca_eth_rxq. can only be called before calling doca_ctx_start().

Parameters

eth_rxq: Pointer to doca_eth_rxq instance.
max_pkt_sz: Max packet size to use in context.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

doca_error_t doca_eth_rxq_set_num_packets ( doca_eth_rxq* eth_rxq, uint32_t num_packets )

Set queue size property for doca_eth_rxq. can only be called before calling doca_ctx_start().

Parameters

eth_rxq: Pointer to doca_eth_rxq instance.
num_packets: Queue max number of packets to use in context.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

doca_error_t doca_eth_rxq_set_pkt_buffer ( doca_eth_rxq* eth_rxq, doca_mmap* mmap, uint32_t offset, uint32_t size )

Set Eth packet buffer for a doca_eth_rxq. can only be called before calling doca_ctx_start().

Parameters

eth_rxq: Pointer to doca_eth_rxq instance.
mmap: The mmap consist of the memrange for the Eth packet buffer.
offset: The offset from mmap start to set the packet buffer.
size: The size of the Eth packet buffer.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

doca_error_t doca_eth_rxq_set_type ( doca_eth_rxq* eth_rxq, doca_eth_rxq_type type )

Set RX queue type property for doca_eth_rxq. can only be called before calling doca_ctx_start().

Parameters

eth_rxq: Pointer to doca_eth_rxq instance.
type: RX queue type - see enum doca_eth_rxq_type

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

Note:

in doca_eth_rxq_create() the default type is DOCA_ETH_RXQ_TYPE_CYCLIC

2.16. DOCA ETH TXQ

DOCA ETH TXQ library.

Enumerations

enum doca_eth_txq_type

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_eth_txq_as_doca_ctx ( doca_eth_txq* eth_txq ): Convert doca_eth_txq instance into a generalised context for use with doca core objects.
doca_error_t doca_eth_txq_calculate_timestamp ( doca_eth_txq* eth_txq, uint64_t timestamp_ns, uint64_t* wait_on_time_value ): Calculate timestamp to use when setting the wait on time on the Tx queue.
doca_error_t doca_eth_txq_create ( doca_eth_txq** eth_txq ): Create a DOCA ETH TXQ instance.
doca_error_t doca_eth_txq_destroy ( doca_eth_txq* eth_txq ): Destroy a DOCA ETH TXQ instance.
doca_error_t doca_eth_txq_get_chksum_offload_supported ( const doca_devinfo* devinfo, uint8_t* offload_supported ): Check if checksum offload is supported by the device.
doca_error_t doca_eth_txq_get_gpu_handle ( const doca_eth_txq* eth_txq, doca_gpu_eth_txq** eth_txq_ext ): Get a gpu handle of a doca_eth_txq.
doca_error_t doca_eth_txq_get_max_queue_size_supported ( const doca_devinfo* devinfo, uint32_t* max_queue_size ): Get the maximum queue size supported by the device.
doca_error_t doca_eth_txq_get_type_supported ( const doca_devinfo* devinfo, doca_eth_txq_type type, uint8_t* type_supported ): Check if TX queue type is supported.
doca_error_t doca_eth_txq_get_wait_on_time_offload_supported ( const doca_dev* dev, doca_eth_wait_on_time ** wait_on_time_mode ): Check if wait on time offload is supported by the network device.
doca_error_t doca_eth_txq_set_l3_chksum_offload ( doca_eth_txq* eth_txq ): Set offload for the calculation of IPv4 checksum (L3) on transmitted packets. can only be called before calling doca_ctx_start().
doca_error_t doca_eth_txq_set_l4_chksum_offload ( doca_eth_txq* eth_txq ): Set offload for the calculation of TCP/UDP checksum (L4) on transmitted packets. can only be called before calling doca_ctx_start().
doca_error_t doca_eth_txq_set_queue_size ( doca_eth_txq* eth_txq, uint32_t size ): Set queue size property for doca_eth_txq. can only be called before calling doca_ctx_start().
doca_error_t doca_eth_txq_set_type ( doca_eth_txq* eth_txq, doca_eth_txq_type type ): Set TX queue type property for doca_eth_txq. can only be called before calling doca_ctx_start().
doca_error_t doca_eth_txq_set_wait_on_time_offload ( doca_eth_txq* eth_txq ): Set offload to enable wait on time feature on the queue.

Enumerations

enum doca_eth_txq_type

TX queue type.

Values

DOCA_ETH_TXQ_TYPE_CYCLIC = 0

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_eth_txq_as_doca_ctx ( doca_eth_txq* eth_txq )

Convert doca_eth_txq instance into a generalised context for use with doca core objects.

Parameters

eth_txq: Pointer to doca_eth_txq instance.

Returns

Non NULL upon success, NULL otherwise.

Description

doca_error_t doca_eth_txq_calculate_timestamp ( doca_eth_txq* eth_txq, uint64_t timestamp_ns, uint64_t* wait_on_time_value )

Calculate timestamp to use when setting the wait on time on the Tx queue.

Parameters

eth_txq: Pointer to doca_eth_txq instance.
timestamp_ns: Timestamp to indicate when send packets
wait_on_time_value: Value to use to enqueue wait on time in send queue

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_DRIVER - error query underlying network card driver
DOCA_ERROR_NOT_PERMITTED - wait on time clock is not enabled on the network card.

Description

doca_error_t doca_eth_txq_create ( doca_eth_txq** eth_txq )

Create a DOCA ETH TXQ instance.

Parameters

eth_txq: Pointer to pointer to be set to point to the created doca_eth_txq instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - eth_txq argument is a NULL pointer.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_eth_txq.
DOCA_ERROR_INITIALIZATION - failed to initialize eth_txq.

Description

doca_error_t doca_eth_txq_destroy ( doca_eth_txq* eth_txq )

Destroy a DOCA ETH TXQ instance.

Parameters

eth_txq: Pointer to instance to be destroyed.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - eth_txq argument is a NULL pointer.
DOCA_ERROR_BAD_STATE - the associated ctx was not stopped before calling doca_eth_txq_destroy().

Description

doca_error_t doca_eth_txq_get_chksum_offload_supported ( const doca_devinfo* devinfo, uint8_t* offload_supported )

Check if checksum offload is supported by the device.

Parameters

devinfo: Pointer to doca_devinfo instance.
offload_supported: Flag to indicate if checksum offload is supported.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.

Description

doca_error_t doca_eth_txq_get_gpu_handle ( const doca_eth_txq* eth_txq, doca_gpu_eth_txq** eth_txq_ext )

Get a gpu handle of a doca_eth_txq.

Parameters

eth_txq: Pointer to doca_eth_txq instance.
eth_txq_ext: A doca gpu eth_txq handle.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

Description

doca_error_t doca_eth_txq_get_max_queue_size_supported ( const doca_devinfo* devinfo, uint32_t* max_queue_size )

Get the maximum queue size supported by the device.

Parameters

devinfo: Pointer to doca_devinfo instance.
max_queue_size: The max queue size.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.

Description

doca_error_t doca_eth_txq_get_type_supported ( const doca_devinfo* devinfo, doca_eth_txq_type type, uint8_t* type_supported )

Check if TX queue type is supported.

Parameters

devinfo: Pointer to doca_devinfo instance.
type: TX queue type - see enum doca_eth_txq_type
type_supported: Flag to indicate if type is supported.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.

Description

doca_error_t doca_eth_txq_get_wait_on_time_offload_supported ( const doca_dev* dev, doca_eth_wait_on_time ** wait_on_time_mode )

Check if wait on time offload is supported by the network device.

Parameters

dev: Pointer to doca_dev instance.
wait_on_time_mode: Offload wait on time mode (native or DPDK)

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_DRIVER - error query underlying network card driver
DOCA_ERROR_NOT_SUPPORTED - real-time clock is not enable on the network card.

Description

doca_error_t doca_eth_txq_set_l3_chksum_offload ( doca_eth_txq* eth_txq )

Set offload for the calculation of IPv4 checksum (L3) on transmitted packets. can only be called before calling doca_ctx_start().

Parameters

eth_txq: Pointer to doca_eth_txq instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

doca_error_t doca_eth_txq_set_l4_chksum_offload ( doca_eth_txq* eth_txq )

Set offload for the calculation of TCP/UDP checksum (L4) on transmitted packets. can only be called before calling doca_ctx_start().

Parameters

eth_txq: Pointer to doca_eth_txq instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

doca_error_t doca_eth_txq_set_queue_size ( doca_eth_txq* eth_txq, uint32_t size )

Set queue size property for doca_eth_txq. can only be called before calling doca_ctx_start().

Parameters

eth_txq: Pointer to doca_eth_txq instance.
size: Queue size to use in context.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

doca_error_t doca_eth_txq_set_type ( doca_eth_txq* eth_txq, doca_eth_txq_type type )

Set TX queue type property for doca_eth_txq. can only be called before calling doca_ctx_start().

Parameters

eth_txq: Pointer to doca_eth_txq instance.
type: TX queue type - see enum doca_eth_txq_type

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

Note:

in doca_eth_txq_create() the default type is DOCA_ETH_TXQ_TYPE_CYCLIC

doca_error_t doca_eth_txq_set_wait_on_time_offload ( doca_eth_txq* eth_txq )

Set offload to enable wait on time feature on the queue.

Parameters

eth_txq: Pointer to doca_eth_txq instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started.
DOCA_ERROR_NOT_PERMITTED - Wait on time HW support but network device clock is not in REAL TIME mode.

Description

2.17. Flow Defines

DOCA HW offload flow library. For more details please refer to the user guide on DOCA devzone.

Classes

struct doca_flow_action_desc: action description
struct doca_flow_action_desc_field: Action descriptor field.
struct doca_flow_action_descs: action descriptor array
struct doca_flow_actions: doca flow actions information
struct doca_flow_cfg: doca flow global configuration
struct doca_flow_ct_match: doca flow CT match pattern
struct doca_flow_ct_match4: doca flow CT IPv4 match pattern
struct doca_flow_ct_match6: doca flow CT IPv6 match pattern
struct doca_flow_encap_action: doca flow encap data information
struct doca_flow_fwd: forwarding configuration
struct doca_flow_header_format: doca flow packet format
struct doca_flow_match: doca flow matcher information
struct doca_flow_meta: doca flow meta data
struct doca_flow_mirror_target: doca flow mirror target
struct doca_flow_monitor: doca monitor action configuration
struct doca_flow_ordered_list
struct doca_flow_parser_geneve_opt_cfg: User configuration structure using to create parser for single GENEVE TLV option.
struct doca_flow_pipe_attr: pipe attributes
struct doca_flow_pipe_cfg: pipeline configuration
struct doca_flow_port_cfg: doca flow port configuration
struct doca_flow_push_action: doca flow push data information
struct doca_flow_query: flow query result
struct doca_flow_resource_crypto_cfg: doca flow crypto resource configuration
struct doca_flow_resource_meter_cfg: doca flow meter resource configuration
struct doca_flow_resource_mirror_cfg: doca flow mirror resource configuration
struct doca_flow_resource_rss_cfg: doca flow rss resource configuration
struct doca_flow_resources: doca flow resource quota
struct doca_flow_shared_resource_cfg: doca flow shared resource configuration
struct doca_flow_shared_resource_result: flow shared resources query result

Defines

#define DOCA_FLOW_META_EXT 12: meter mark color
#define DOCA_FLOW_META_MAX 20
#define DOCA_FLOW_VLAN_MAX 2

Typedefs

typedef void ( *doca_flow_entry_process_cb )( doca_flow_pipe_entry* entry, uint16_t pipe_queue, enum doca_flow_entry_status status, enum doca_flow_entry_op op, void* user_ctx ): doca flow entry process callback
typedef void ( *doca_flow_shared_resource_unbind_cb )( enum doca_flow_shared_resource_type, uint32_t shared_resource_id, void* bindable_obj ): doca flow shared resource unbind callback

Enumerations

enum doca_flow_action_type: action type enumeration
enum doca_flow_cfg_flags: doca flow configuration flags
enum doca_flow_ct_entry_flags: doca flow CT entry operation flags
enum doca_flow_direction_info: doca flow direction info
enum doca_flow_entry_op: doca flow entry operation
enum doca_flow_entry_status: doca flow entry status
enum doca_flow_flags_type: doca flow flags type
enum doca_flow_fwd_type: forwarding action type
enum doca_flow_l2_valid_header: doca flow l2 valid headers
enum doca_flow_match_tcp_flags: doca flow match flags
enum doca_flow_meter_algorithm_type: Traffic meter algorithms.
enum doca_flow_meter_color_mode: Traffic meter init color mode when creating a pipe or entry: blind (fixed as green) or aware (configurable value).
enum doca_flow_meter_limit_type: Traffic meter limit type: per bytes or per packets for all meter parameters: cir, cbs, eir, ebs.
enum doca_flow_ordered_list_element_type
enum doca_flow_parser_geneve_opt_mode: Geneve TLV option class mode.
enum doca_flow_pipe_domain: doca flow pipe domain
enum doca_flow_pipe_type: doca flow pipe type
enum doca_flow_port_type: doca flow port type
enum doca_flow_push_action_type: doca flow push action type
enum doca_flow_rss_hash_function: rss hash function type
enum doca_flow_shared_resource_type: Shared resource supported types.
enum doca_flow_target_type: doca flow target type
enum doca_rss_type: rss offload types

Functions

__DOCA_EXPERIMENTAL int doca_flow_aging_handle ( doca_flow_port* port, uint16_t queue, uint64_t quota, uint64_t max_entries ): Handle aging of entries.
doca_error_t doca_flow_ct_add_entry ( doca_flow_port* port, uint16_t queue, uint32_t flags, doca_flow_ct_match* match_origin, doca_flow_ct_match* match_reply, uint32_t meta_origin, uint32_t meta_reply, void* usr_ctx, doca_flow_pipe_entry** entry ): Add new entry to doca flow CT table.
doca_error_t doca_flow_ct_get_entry ( doca_flow_port* port, uint16_t queue, uint32_t flags, doca_flow_pipe_entry* entry, doca_flow_ct_match** match_origin, doca_flow_ct_match** match_reply ): Get CT entry match pattern.
doca_error_t doca_flow_ct_query_entry ( doca_flow_port* port, uint16_t queue, uint32_t flags, doca_flow_pipe_entry* entry, doca_flow_query* stats_origin, doca_flow_query* stats_reply ): Extract information about specific entry.
doca_error_t doca_flow_ct_rm_entry ( doca_flow_port* port, uint16_t queue, uint32_t flags, doca_flow_pipe_entry* entry ): remove CT entry.
doca_error_t doca_flow_ct_update_entry ( doca_flow_port* port, uint16_t queue, uint32_t flags, doca_flow_pipe_entry* entry, uint32_t meta_origin, uint32_t meta_reply ): Update CT entry meta or couter.
__DOCA_EXPERIMENTAL void doca_flow_destroy ( void ): Destroy the doca flow.
doca_error_t doca_flow_entries_process ( doca_flow_port* port, uint16_t pipe_queue, uint64_t timeout, uint32_t max_processed_entries ): Process entries in queue.
doca_error_t doca_flow_get_target ( doca_flow_target_type type, doca_flow_target** target ): Get doca flow forward target.
doca_error_t doca_flow_init ( const doca_flow_cfg* cfg ): Initialize the doca flow.
doca_error_t doca_flow_mpls_label_decode ( const doca_flow_header_mpls* mpls, uint32_t* label, uint8_t* traffic_class, uint8_t* ttl, bool* bottom_of_stack ): Decode an MPLS label header.
doca_error_t doca_flow_mpls_label_encode ( uint32_t label, uint8_t traffic_class, uint8_t ttl, bool bottom_of_stack, doca_flow_header_mpls* mpls ): Prepare an MPLS label header in big-endian.
doca_error_t doca_flow_parser_geneve_opt_create ( const doca_flow_port* port, const doca_flow_parser_geneve_opt_cfg tlv_list[], uint8_t nb_options, doca_flow_parser** parser ): Creates GENEVE TLV parser for the selected port.
doca_error_t doca_flow_parser_geneve_opt_destroy ( doca_flow_parser* parser ): Destroy GENEVE TLV parser.
doca_error_t doca_flow_pipe_acl_add_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, const doca_flow_match* match, const doca_flow_match* match_mask, const uint32_t priority, const doca_flow_fwd* fwd, const doca_flow_flags_type flag, void* usr_ctx, doca_flow_pipe_entry** entry ): Add one new entry to a acl pipe.
doca_error_t doca_flow_pipe_add_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, const doca_flow_match* match, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, uint32_t flags, void* usr_ctx, doca_flow_pipe_entry** entry ): Add one new entry to a pipe.
doca_error_t doca_flow_pipe_control_add_entry ( uint16_t pipe_queue, uint32_t priority, doca_flow_pipe* pipe, const doca_flow_match* match, const doca_flow_match* match_mask, const doca_flow_actions* actions, const doca_flow_actions* actions_mask, const doca_flow_action_descs* action_descs, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, void* usr_ctx, doca_flow_pipe_entry** entry ): Add one new entry to a control pipe.
doca_error_t doca_flow_pipe_create ( const doca_flow_pipe_cfg* cfg, const doca_flow_fwd* fwd, const doca_flow_fwd* fwd_miss, doca_flow_pipe** pipe ): Create one new pipe.
__DOCA_EXPERIMENTAL void doca_flow_pipe_destroy ( doca_flow_pipe* pipe ): Destroy one pipe.
__DOCA_EXPERIMENTAL void doca_flow_pipe_dump ( doca_flow_pipe* pipe, FILE* f ): Dump pipe information.
doca_flow_entry_status doca_flow_pipe_entry_get_status ( doca_flow_pipe_entry* entry ): Get entry's status.
doca_error_t doca_flow_pipe_hash_add_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, uint32_t entry_index, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, const doca_flow_flags_type flags, void* usr_ctx, doca_flow_pipe_entry** entry ): Add one new entry to an hash pipe.
doca_error_t doca_flow_pipe_lpm_add_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, const doca_flow_match* match, const doca_flow_match* match_mask, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, const doca_flow_flags_type flag, void* usr_ctx, doca_flow_pipe_entry** entry ): Add one new entry to a lpm pipe.
doca_error_t doca_flow_pipe_lpm_update_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, const doca_flow_flags_type flags, doca_flow_pipe_entry* entry ): Update the lpm pipe entry with new actions.
doca_error_t doca_flow_pipe_ordered_list_add_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, uint32_t idx, const doca_flow_ordered_list* ordered_list, const doca_flow_fwd* fwd, doca_flow_flags_type flags, void* user_ctx, doca_flow_pipe_entry** entry )
doca_error_t doca_flow_pipe_rm_entry ( uint16_t pipe_queue, uint32_t flags, doca_flow_pipe_entry* entry ): Free one pipe entry.
doca_error_t doca_flow_pipe_update_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, const doca_flow_flags_type flags, doca_flow_pipe_entry* entry ): Update the pipe entry with new actions.
doca_error_t doca_flow_port_pair ( doca_flow_port* port, doca_flow_port* pair_port ): pair two doca flow ports.
__DOCA_EXPERIMENTAL void doca_flow_port_pipes_dump ( doca_flow_port* port, FILE* f ): Dump pipes of one port.
__DOCA_EXPERIMENTAL void doca_flow_port_pipes_flush ( doca_flow_port* port ): Flush pipes of one port.
__DOCA_EXPERIMENTAL uint8_t* doca_flow_port_priv_data ( doca_flow_port* port ): Get pointer of user private data.
doca_error_t doca_flow_port_start ( const doca_flow_port_cfg* cfg, doca_flow_port** port ): Start a doca port.
doca_error_t doca_flow_port_stop ( doca_flow_port* port ): Stop a doca port.
__DOCA_EXPERIMENTAL doca_flow_port* doca_flow_port_switch_get ( const doca_flow_port* port ): Get doca flow switch port.
doca_error_t doca_flow_query_entry ( doca_flow_pipe_entry* entry, doca_flow_query* query_stats ): Extract information about specific entry.
doca_error_t doca_flow_query_pipe_miss ( doca_flow_pipe* pipe, doca_flow_query* query_stats ): Extract information about pipe miss entry.
doca_error_t doca_flow_shared_resource_cfg ( doca_flow_shared_resource_type type, uint32_t id, doca_flow_shared_resource_cfg* cfg ): Configure a single shared resource.
doca_error_t doca_flow_shared_resources_bind ( doca_flow_shared_resource_type type, uint32_t* res_array, uint32_t res_array_len, void* bindable_obj ): Binds a bulk of shared resources to a bindable object.
doca_error_t doca_flow_shared_resources_query ( doca_flow_shared_resource_type type, uint32_t* res_array, doca_flow_shared_resource_result* query_results_array, uint32_t array_len ): Extract information about shared counter.

Defines

#define DOCA_FLOW_META_EXT 12

External meta data size in bytes.

#define DOCA_FLOW_META_MAX 20

Max meta data size in bytes.

#define DOCA_FLOW_VLAN_MAX 2

Max number of vlan headers.

Typedefs

void ( *doca_flow_entry_process_cb )( doca_flow_pipe_entry* entry, uint16_t pipe_queue, enum doca_flow_entry_status status, enum doca_flow_entry_op op, void* user_ctx )

doca flow entry process callback

void ( *doca_flow_shared_resource_unbind_cb )( enum doca_flow_shared_resource_type, uint32_t shared_resource_id, void* bindable_obj )

doca flow shared resource unbind callback

Enumerations

enum doca_flow_action_type

Values

DOCA_FLOW_ACTION_AUTO = 0
DOCA_FLOW_ACTION_ADD
DOCA_FLOW_ACTION_COPY
DOCA_FLOW_ACTION_MAX

enum doca_flow_cfg_flags

Values

DOCA_FLOW_CFG_PIPE_MISS_MON = (1<<0): Counter pipe miss flow and query with doca_flow_query_pipe_miss()

enum doca_flow_ct_entry_flags

Values

DOCA_FLOW_CT_ENTRY_FLAGS_NO_WAIT = (1<<0): entry will not be buffered, send to hardware immediately
DOCA_FLOW_CT_ENTRY_FLAGS_DIR_ORIGIN = (1<<1): apply to origin direction
DOCA_FLOW_CT_ENTRY_FLAGS_DIR_REPLY = (1<<2): apply to reply direction
DOCA_FLOW_CT_ENTRY_FLAGS_IPV6 = (1<<3): entry is IPv6, union in struct doca_flow_ct_match is ipv6
DOCA_FLOW_CT_ENTRY_FLAGS_AGING = (1<<4): enable aging check
DOCA_FLOW_CT_ENTRY_FLAGS_COUNTER_ORIGIN = (1<<5): Apply counter to origin direction
DOCA_FLOW_CT_ENTRY_FLAGS_COUNTER_REPLY = (1<<6): Apply counter to reply direction
DOCA_FLOW_CT_ENTRY_FLAGS_COUNTER_SHARED = (1<<7): Counter is shared for both direction

enum doca_flow_direction_info

Values

DOCA_FLOW_DIRECTION_BIDIRECTIONAL = 0
DOCA_FLOW_DIRECTION_NETWORK_TO_HOST
DOCA_FLOW_DIRECTION_HOST_TO_NETWORK

enum doca_flow_entry_op

Values

DOCA_FLOW_ENTRY_OP_ADD: Add entry
DOCA_FLOW_ENTRY_OP_DEL: Delete entry
DOCA_FLOW_ENTRY_OP_UPD: Update entry
DOCA_FLOW_ENTRY_OP_AGED: Aged entry

enum doca_flow_entry_status

Values

DOCA_FLOW_ENTRY_STATUS_IN_PROCESS
DOCA_FLOW_ENTRY_STATUS_SUCCESS
DOCA_FLOW_ENTRY_STATUS_ERROR

enum doca_flow_flags_type

Values

DOCA_FLOW_NO_WAIT = 0: entry will not be buffered
DOCA_FLOW_WAIT_FOR_BATCH = (1<<0): entry will be buffered

enum doca_flow_fwd_type

Values

DOCA_FLOW_FWD_NONE = 0: No forward action be set
DOCA_FLOW_FWD_RSS: Forwards packets to rss
DOCA_FLOW_FWD_PORT: Forwards packets to one port
DOCA_FLOW_FWD_PIPE: Forwards packets to another pipe
DOCA_FLOW_FWD_DROP: Drops packets
DOCA_FLOW_FWD_TARGET: Forwards packets to target
DOCA_FLOW_FWD_ORDERED_LIST_PIPE: Forwards packet to a specific entry in an ordered list pipe.

enum doca_flow_l2_valid_header

Values

DOCA_FLOW_L2_VALID_HEADER_VLAN_0 = (1<<0): first vlan
DOCA_FLOW_L2_VALID_HEADER_VLAN_1 = (1<<1): second vlan

enum doca_flow_match_tcp_flags

Values

DOCA_FLOW_MATCH_TCP_FLAG_FIN = (1<<0): match tcp packet with Fin flag
DOCA_FLOW_MATCH_TCP_FLAG_SYN = (1<<1): match tcp packet with Syn flag
DOCA_FLOW_MATCH_TCP_FLAG_RST = (1<<2): match tcp packet with Rst flag
DOCA_FLOW_MATCH_TCP_FLAG_PSH = (1<<3): match tcp packet with Psh flag
DOCA_FLOW_MATCH_TCP_FLAG_ACK = (1<<4): match tcp packet with Ack flag
DOCA_FLOW_MATCH_TCP_FLAG_URG = (1<<5): match tcp packet with Urg flag
DOCA_FLOW_MATCH_TCP_FLAG_ECE = (1<<6): match tcp packet with Urg flag
DOCA_FLOW_MATCH_TCP_FLAG_CWR = (1<<7): match tcp packet with Urg flag

enum doca_flow_meter_algorithm_type

Values

DOCA_FLOW_METER_ALGORITHM_TYPE_RFC2697: Single Rate Three Color Marker - IETF RFC 2697.
DOCA_FLOW_METER_ALGORITHM_TYPE_RFC2698: Two Rate Three Color Marker - IETF RFC 2698.
DOCA_FLOW_METER_ALGORITHM_TYPE_RFC4115: Two Rate Three Color Marker - IETF RFC 4115.

enum doca_flow_meter_color_mode

Values

DOCA_FLOW_METER_COLOR_MODE_BLIND = 0: Meter action init color is green.
DOCA_FLOW_METER_COLOR_MODE_AWARE: Meter action init color is configured.

enum doca_flow_meter_limit_type

Values

DOCA_FLOW_METER_LIMIT_TYPE_BYTES = 0: Meter parameters per bytes
DOCA_FLOW_METER_LIMIT_TYPE_PACKETS: Meter parameters packets

enum doca_flow_ordered_list_element_type

Type of an ordered list element.

Values

DOCA_FLOW_ORDERED_LIST_ELEMENT_ACTIONS: Ordered list element is struct doca_flow_actions, the next element is struct doca_flow_action_descs or actions mask associated with the current element.
DOCA_FLOW_ORDERED_LIST_ELEMENT_ACTIONS_MASK: Ordered list element is struct doca_flow_actions, the next element is struct doca_flow_action_descs associated with the current element.
DOCA_FLOW_ORDERED_LIST_ELEMENT_ACTION_DESCS: Ordered list element is struct doca_flow_action_descs. If the previous element type is ACTIONS, the current element is associated with it. Otherwise the current element is ordered w.r.t. the previous one.
DOCA_FLOW_ORDERED_LIST_ELEMENT_MONITOR: Ordered list element is struct doca_flow_monitor.

enum doca_flow_parser_geneve_opt_mode

Values

DOCA_FLOW_PARSER_GENEVE_OPT_MODE_IGNORE: class is ignored.
DOCA_FLOW_PARSER_GENEVE_OPT_MODE_FIXED: class is fixed (the class defines the option along with the type).
DOCA_FLOW_PARSER_GENEVE_OPT_MODE_MATCHABLE: class is matching per flow.

enum doca_flow_pipe_domain

Values

DOCA_FLOW_PIPE_DOMAIN_DEFAULT = 0: Default pipe domain for actions on ingress traffic
DOCA_FLOW_PIPE_DOMAIN_SECURE_INGRESS: Pipe domain for secure actions on ingress traffic
DOCA_FLOW_PIPE_DOMAIN_EGRESS: Pipe domain for actions on egress traffic
DOCA_FLOW_PIPE_DOMAIN_SECURE_EGRESS: Pipe domain for actions on egress traffic

enum doca_flow_pipe_type

Values

DOCA_FLOW_PIPE_BASIC: Flow pipe
DOCA_FLOW_PIPE_CONTROL: Control pipe
DOCA_FLOW_PIPE_LPM: longest prefix match (LPM) pipe
DOCA_FLOW_PIPE_CT: Connection Tracking pipe
DOCA_FLOW_PIPE_ACL: ACL pipe
DOCA_FLOW_PIPE_ORDERED_LIST: Ordered list pipe
DOCA_FLOW_PIPE_HASH: Hash pipe

enum doca_flow_port_type

Values

DOCA_FLOW_PORT_DPDK_BY_ID: dpdk port by mapping id

enum doca_flow_push_action_type

Values

DOCA_FLOW_PUSH_ACTION_VLAN

enum doca_flow_rss_hash_function

Values

DOCA_FLOW_RSS_HASH_FUNCTION_TOEPLITZ: Toeplitz
DOCA_FLOW_RSS_HASH_FUNCTION_SYMMETRIC_TOEPLITZ: Toeplitz with sorted source and destination

enum doca_flow_shared_resource_type

Values

DOCA_FLOW_SHARED_RESOURCE_METER: Shared meter type
DOCA_FLOW_SHARED_RESOURCE_COUNT: Shared counter type
DOCA_FLOW_SHARED_RESOURCE_RSS: Shared rss type
DOCA_FLOW_SHARED_RESOURCE_CRYPTO: Shared crypto action type
DOCA_FLOW_SHARED_RESOURCE_MIRROR: Shared mirror type
DOCA_FLOW_SHARED_RESOURCE_MAX: Shared max supported types

enum doca_flow_target_type

Values

DOCA_FLOW_TARGET_KERNEL

enum doca_rss_type

Values

DOCA_FLOW_RSS_IPV4 = (1<<0): rss by ipv4 head
DOCA_FLOW_RSS_IPV6 = (1<<1): rss by ipv6 head
DOCA_FLOW_RSS_UDP = (1<<2): rss by udp head
DOCA_FLOW_RSS_TCP = (1<<3): rss by tcp head

Functions

__DOCA_EXPERIMENTAL int doca_flow_aging_handle ( doca_flow_port* port, uint16_t queue, uint64_t quota, uint64_t max_entries )

Handle aging of entries.

Parameters

port: Port to handle aging
queue: Queue identifier.
quota: Max time quota in micro seconds handle aging, 0: no limit.
max_entries: Max entries for this function to handle aging, 0: no limit.

Returns

> 0 the number of aged entries. 0 no aged entries in current call. -1 full cycle done.

Description

Process aged entries, the user will get a notification in the callback.

Handling of aged entries can take too much time, so we split each cycle to small chunks that are limited by some time quota.

As long as the function doesn't return -1, more entries are pending processing for this cycle.

doca_error_t doca_flow_ct_add_entry ( doca_flow_port* port, uint16_t queue, uint32_t flags, doca_flow_ct_match* match_origin, doca_flow_ct_match* match_reply, uint32_t meta_origin, uint32_t meta_reply, void* usr_ctx, doca_flow_pipe_entry** entry )

Add new entry to doca flow CT table.

Parameters

port: port of CT pipe.
queue: queue ID, offset from doca_flow.nb_queues.
flags: operation flags, see DOCA_FLOW_CT_FLAGS_xxx.
match_origin: match pattern in origin direction.
match_reply: match pattern in reply direction, default to reverse of origin pattern.
meta_origin: meta to set on origin direction
meta_reply: meta to set on reply direction
usr_ctx: user context data to associate to entry
entry: pointer to save the new entry

Returns

DOCA_SUCCESS - in case of success.

Description

doca_error_t doca_flow_ct_get_entry ( doca_flow_port* port, uint16_t queue, uint32_t flags, doca_flow_pipe_entry* entry, doca_flow_ct_match** match_origin, doca_flow_ct_match** match_reply )

Get CT entry match pattern.

Parameters

port: port of CT pipe.
queue: queue ID, offset from doca_flow.nb_queues.
flags: operation flags, see DOCA_FLOW_CT_FLAGS_xxx.
entry: CT entry.
match_origin: Pointer to match pattern of origin direction
match_reply: Pointer to match pattern of reply direction

Returns

DOCA_SUCCESS - in case of success.

Description

doca_error_t doca_flow_ct_query_entry ( doca_flow_port* port, uint16_t queue, uint32_t flags, doca_flow_pipe_entry* entry, doca_flow_query* stats_origin, doca_flow_query* stats_reply )

Extract information about specific entry.

Parameters

port: port of CT pipe.
queue: queue ID, offset from doca_flow.nb_queues.
flags: operation flags, see DOCA_FLOW_CT_FLAGS_xxx.
entry: The CT pipe entry to query.
stats_origin: Data of origin direction retrieved by the query.
stats_reply: Data of reply direction retrieved by the query.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_UNKNOWN - otherwise.

Description

Query the packet statistics about specific CT pipe entry

doca_error_t doca_flow_ct_rm_entry ( doca_flow_port* port, uint16_t queue, uint32_t flags, doca_flow_pipe_entry* entry )

remove CT entry.

Parameters

port: port of CT pipe.
queue: queue ID, offset from doca_flow.nb_queues.
flags: operation flags, see DOCA_FLOW_CT_FLAGS_xxx.
entry: The CT pipe entry to query.

Returns

DOCA_SUCCESS - in case of success.

Description

doca_error_t doca_flow_ct_update_entry ( doca_flow_port* port, uint16_t queue, uint32_t flags, doca_flow_pipe_entry* entry, uint32_t meta_origin, uint32_t meta_reply )

Update CT entry meta or couter.

Parameters

port: port of CT pipe.
queue: queue ID, offset from doca_flow.nb_queues.
flags: operation flags, see DOCA_FLOW_CT_FLAGS_xxx.
entry: The CT pipe entry to query.
meta_origin: meta to set on origin direction
meta_reply: meta to set on reply direction

Returns

DOCA_SUCCESS - in case of success.

Description

__DOCA_EXPERIMENTAL void doca_flow_destroy ( void )

Destroy the doca flow.

Description

Release all the resources used by doca flow.

Must be invoked at the end of the application, before it exits.

doca_error_t doca_flow_entries_process ( doca_flow_port* port, uint16_t pipe_queue, uint64_t timeout, uint32_t max_processed_entries )

Process entries in queue.

Parameters

port: Port
pipe_queue: Queue identifier.
timeout: Max time in micro seconds for this function to process entries. Process once if timeout is 0
max_processed_entries: Flow entries number to process If it is 0, it will proceed until timeout.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_DRIVER - driver error.

Description

The application must invoke this function in order to complete the flow rule offloading and to receive the flow rule operation status.

doca_error_t doca_flow_get_target ( doca_flow_target_type type, doca_flow_target** target )

Get doca flow forward target.

Parameters

type: Target type.
target: Target handler on success

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - unsupported type.

Description

doca_error_t doca_flow_init ( const doca_flow_cfg* cfg )

Initialize the doca flow.

Parameters

cfg: Port configuration, see doca_flow_cfg for details.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - memory allocation failed.
DOCA_ERROR_NOT_SUPPORTED - unsupported configuration.
DOCA_ERROR_UNKNOWN - otherwise.

Description

This is the global initialization function for doca flow. It initializes all resources used by doca flow.

Must be invoked first before any other function in this API. this is a one time call, used for doca flow initialization and global configurations.

doca_error_t doca_flow_mpls_label_decode ( const doca_flow_header_mpls* mpls, uint32_t* label, uint8_t* traffic_class, uint8_t* ttl, bool* bottom_of_stack )

Decode an MPLS label header.

Parameters

mpls: Pointer to MPLS structure to decode.
label: Pointer to fill MPLS label value.
traffic_class: Pointer to fill MPLS traffic class value.
ttl: Pointer to fill MPLS TTL value.
bottom_of_stack: Pointer to fill whether this MPLS is bottom of stack.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Note:

: All output variables are in cpu-endian.

doca_error_t doca_flow_mpls_label_encode ( uint32_t label, uint8_t traffic_class, uint8_t ttl, bool bottom_of_stack, doca_flow_header_mpls* mpls )

Prepare an MPLS label header in big-endian.

Parameters

label: The label value - 20 bits.
traffic_class: Traffic class - 3 bits.
ttl: Time to live - 8 bits
bottom_of_stack: Whether this MPLS is bottom of stack.
mpls: Pointer to MPLS structure to fill.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Note:

: All input variables are in cpu-endian.

doca_error_t doca_flow_parser_geneve_opt_create ( const doca_flow_port* port, const doca_flow_parser_geneve_opt_cfg tlv_list[], uint8_t nb_options, doca_flow_parser** parser )

Creates GENEVE TLV parser for the selected port.

Parameters

port: Pointer to doca flow port.
tlv_list: A list of GENEVE TLV options to create parser for them.
nb_options: The number of options in TLV list.
parser: Parser handler on success.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - memory allocation failed.
DOCA_ERROR_NOT_SUPPORTED - unsupported configuration.
DOCA_ERROR_ALREADY_EXIST - physical device already has parser, by either same or another port.
DOCA_ERROR_UNKNOWN - otherwise.

Description

This function must be called before creation of any pipe using GENEVE option.

This API is port oriented, but the configuration is done once for all ports under the same physical device. Each port should call this API before using GENEVE options, but it must use the same options in the same order inside the list.

Each physical device has 8 DWs for GENEVE TLV options. Each nonzero element in 'data_mask' array consumes one DW, and choosing matchable mode for class consumes additional one. Calling this API for second port under same physical device doesn't consume more DW, it uses same configuration.

doca_error_t doca_flow_parser_geneve_opt_destroy ( doca_flow_parser* parser )

Destroy GENEVE TLV parser.

Parameters

parser: Pointer to parser to be destroyed.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - one of options is in used by a pipe.
DOCA_ERROR_DRIVER - there is no valid GENEVE TLV parser in this handle.
DOCA_ERROR_UNKNOWN - otherwise.

Description

This function must be called after last use of GENEVE option and before port closing.

doca_error_t doca_flow_pipe_acl_add_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, const doca_flow_match* match, const doca_flow_match* match_mask, const uint32_t priority, const doca_flow_fwd* fwd, const doca_flow_flags_type flag, void* usr_ctx, doca_flow_pipe_entry** entry )

Add one new entry to a acl pipe.

Parameters

pipe_queue: Queue identifier.
pipe: Pointer to pipe.
match: Pointer to match, indicate specific packet match information.
match_mask: Pointer to match mask information.
priority: Priority value
fwd: Pointer to fwd actions.
flag: Flow entry will be pushed to hw immediately or not. enum doca_flow_flags_type.
usr_ctx: Pointer to user context.
entry: The entry inserted.

Returns

Pipe entry handler on success, NULL otherwise and error is set.

Description

This API will populate the acl entries

doca_error_t doca_flow_pipe_add_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, const doca_flow_match* match, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, uint32_t flags, void* usr_ctx, doca_flow_pipe_entry** entry )

Add one new entry to a pipe.

Parameters

pipe_queue: Queue identifier.
pipe: Pointer to pipe.
match: Pointer to match, indicate specific packet match information.
actions: Pointer to modify actions, indicate specific modify information.
monitor: Pointer to monitor actions.
fwd: Pointer to fwd actions.
flags: Flow entry will be pushed to hw immediately or not. enum doca_flow_flags_type.
usr_ctx: Pointer to user context.
entry: Pipe entry handler on success.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - driver error.

Description

When a packet matches a single pipe, will start HW offload. The pipe only defines which fields to match. When offloading, we need detailed information from packets, or we need to set some specific actions that the pipe did not define. The parameters include:

match: The packet detail fields according to the pipe definition. actions: The real actions according to the pipe definition. monitor: Defines the monitor actions if the pipe did not define it. fwd: Define the forward action if the pipe did not define it.

This API will do the actual HW offload, with the information from the fields of the input packets.

doca_error_t doca_flow_pipe_control_add_entry ( uint16_t pipe_queue, uint32_t priority, doca_flow_pipe* pipe, const doca_flow_match* match, const doca_flow_match* match_mask, const doca_flow_actions* actions, const doca_flow_actions* actions_mask, const doca_flow_action_descs* action_descs, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, void* usr_ctx, doca_flow_pipe_entry** entry )

Add one new entry to a control pipe.

Parameters

pipe_queue: Queue identifier.
priority: Priority value.
pipe: Pointer to pipe.
match: Pointer to match, indicate specific packet match information.
match_mask: Pointer to match mask information.
actions: Pointer to modify actions, indicate specific modify information.
actions_mask: Pointer to modify actions' mask, indicate specific modify information.
action_descs: action descriptions
monitor: Pointer to monitor actions.
fwd: Pointer to fwd actions.
usr_ctx: Pointer to user context.
entry: Pipe entry handler on success.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - driver error.

Description

Refer to doca_flow_pipe_add_entry.

doca_error_t doca_flow_pipe_create ( const doca_flow_pipe_cfg* cfg, const doca_flow_fwd* fwd, const doca_flow_fwd* fwd_miss, doca_flow_pipe** pipe )

Create one new pipe.

Parameters

cfg: Pipe configuration.
fwd: Fwd configuration for the pipe.
fwd_miss: Fwd_miss configuration for the pipe. NULL for no fwd_miss. When creating a pipe if there is a miss and fwd_miss configured, packet steering should jump to it.
pipe: Pipe handler on success.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - unsupported pipe type.
DOCA_ERROR_DRIVER - driver error.

Description

Create new pipeline to match and offload specific packets, the pipe configuration includes the following components:

match: Match one packet by inner or outer fields. match_mask: The mask for the matched items. actions: Includes the modify specific packets fields, Encap and Decap actions. monitor: Includes Count, Age, and Meter actions. fwd: The destination of the matched action, include RSS, Hairpin, Port, and Drop actions.

This API will create the pipe, but would not start the HW offload.

__DOCA_EXPERIMENTAL void doca_flow_pipe_destroy ( doca_flow_pipe* pipe )

Destroy one pipe.

Parameters

pipe: Pointer to pipe.

Description

Destroy the pipe, and the pipe entries that match this pipe.

__DOCA_EXPERIMENTAL void doca_flow_pipe_dump ( doca_flow_pipe* pipe, FILE* f )

Dump pipe information.

Parameters

pipe: Pointer to doca flow pipe.
f: The output file of the pipe information.

Description

doca_flow_entry_status doca_flow_pipe_entry_get_status ( doca_flow_pipe_entry* entry )

Get entry's status.

Parameters

entry: pipe entry

Returns

entry's status

Description

doca_error_t doca_flow_pipe_hash_add_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, uint32_t entry_index, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, const doca_flow_flags_type flags, void* usr_ctx, doca_flow_pipe_entry** entry )

Add one new entry to an hash pipe.

Parameters

pipe_queue: Queue identifier.
pipe: Pointer to pipe.
entry_index: Static index in pipe for this entry.
actions: Pointer to modify actions, indicate specific modify information.
monitor: Pointer to monitor actions.
fwd: Pointer to forward actions.
flags: Flow entry will be pushed to HW immediately or not. enum doca_flow_flags_type.
usr_ctx: Pointer to user context.
entry: Pipe entry handler on success.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - driver error.

Description

Refer to doca_flow_pipe_add_entry.

doca_error_t doca_flow_pipe_lpm_add_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, const doca_flow_match* match, const doca_flow_match* match_mask, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, const doca_flow_flags_type flag, void* usr_ctx, doca_flow_pipe_entry** entry )

Add one new entry to a lpm pipe.

Parameters

pipe_queue: Queue identifier.
pipe: Pointer to pipe.
match: Pointer to match, indicate specific packet match information.
match_mask: Pointer to match mask information.
actions: Pointer to modify actions, indicate specific modify information.
monitor: Pointer to monitor actions.
fwd: Pointer to fwd actions.
flag: Flow entry will be pushed to hw immediately or not. enum doca_flow_flags_type.
usr_ctx: Pointer to user context.
entry: Pipe entry handler on success.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - driver error.

Description

This API will populate the lpm entries

doca_error_t doca_flow_pipe_lpm_update_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, const doca_flow_flags_type flags, doca_flow_pipe_entry* entry )

Update the lpm pipe entry with new actions.

Parameters

pipe_queue: Queue identifier.
pipe: Pointer to pipe.
actions: Pointer to modify actions, indicate specific modify information.
monitor: Pointer to monitor actions.
fwd: Pointer to fwd actions.
flags: Flow entry will be pushed to hw immediately or not. enum doca_flow_flags_type.
entry: The pipe entry to be updated.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - driver error.

Description

doca_error_t doca_flow_pipe_ordered_list_add_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, uint32_t idx, const doca_flow_ordered_list* ordered_list, const doca_flow_fwd* fwd, doca_flow_flags_type flags, void* user_ctx, doca_flow_pipe_entry** entry )

Parameters

pipe_queue: Queue identifier.
pipe: Pipe handle.
idx: Unique entry index. It is the user's responsibility to ensure uniqueness.
ordered_list: Ordered list with pointers to struct doca_flow_actions and struct doca_flow_monitor at the same indices as they were at the pipe creation time. If the configuration contained an element of struct doca_flow_action_descs, the corresponding array element is ignored and can be NULL.
fwd: Entry forward configuration.
flags: Entry insertion flags.
user_ctx: Opaque context for the completion callback.
entry: The entry inserted.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - memory allocation failed.
DOCA_ERROR_DRIVER - driver error.

Description

Add an entry to the ordered list pipe.

doca_error_t doca_flow_pipe_rm_entry ( uint16_t pipe_queue, uint32_t flags, doca_flow_pipe_entry* entry )

Free one pipe entry.

Parameters

pipe_queue: Queue identifier.
flags: Flow entry will be removed from hw immediately or not. enum doca_flow_flags_type.
entry: The pipe entry to be removed.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - unsupported pipe type.
DOCA_ERROR_UNKNOWN - otherwise.

Description

This API will free the pipe entry and cancel HW offload. The Application receives the entry pointer upon creation and if can call this function when there is no more need for this offload. For example, if the entry aged, use this API to free it.

doca_error_t doca_flow_pipe_update_entry ( uint16_t pipe_queue, doca_flow_pipe* pipe, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_fwd* fwd, const doca_flow_flags_type flags, doca_flow_pipe_entry* entry )

Update the pipe entry with new actions.

Parameters

pipe_queue: Queue identifier.
pipe: Pointer to pipe.
actions: Pointer to modify actions, indicate specific modify information.
monitor: Pointer to monitor actions.
fwd: Pointer to fwd actions.
flags: Flow entry will be pushed to hw immediately or not. enum doca_flow_flags_type.
entry: The pipe entry to be updated.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - driver error.

Description

doca_error_t doca_flow_port_pair ( doca_flow_port* port, doca_flow_port* pair_port )

pair two doca flow ports.

Parameters

port: Pointer to doca flow port.
pair_port: Pointer to the pair port.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - memory allocation failed.
DOCA_ERROR_NOT_SUPPORTED - not supported in the current run mode.
DOCA_ERROR_UNKNOWN - otherwise.

Description

This API should be used to pair two doca ports. This pair should be the same as the actual physical layer paired information. Those two pair ports have no order, a port cannot be paired with itself.

In this API, default behavior will be handled according to each modes. In VNF mode, pair information will be translated to queue action to redirect packets to it's pair port. In REMOTE_VNF mode, default rules will be created to redirect packets between 2 pair ports.

__DOCA_EXPERIMENTAL void doca_flow_port_pipes_dump ( doca_flow_port* port, FILE* f )

Dump pipes of one port.

Parameters

port: Pointer to doca flow port.
f: The output file of the pipe information.

Description

Dump all pipes information belong to this port.

__DOCA_EXPERIMENTAL void doca_flow_port_pipes_flush ( doca_flow_port* port )

Flush pipes of one port.

Parameters

port: Pointer to doca flow port.

Description

Destroy all pipes and all pipe entries belonging to the port.

__DOCA_EXPERIMENTAL uint8_t* doca_flow_port_priv_data ( doca_flow_port* port )

Get pointer of user private data.

Parameters

port: Port struct.

Returns

Private data head pointer.

Description

User can manage specific data structure in port structure. The size of the data structure is given on port configuration. See doca_flow_cfg for more details.

doca_error_t doca_flow_port_start ( const doca_flow_port_cfg* cfg, doca_flow_port** port )

Start a doca port.

Parameters

cfg: Port configuration, see doca_flow_cfg for details.
port: Port handler on success.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - memory allocation failed.
DOCA_ERROR_NOT_SUPPORTED - unsupported port type.
DOCA_ERROR_UNKNOWN - otherwise.

Description

Start a port with the given configuration. Will create one port in the doca flow layer, allocate all resources used by this port, and create the default offload logic for traffic.

doca_error_t doca_flow_port_stop ( doca_flow_port* port )

Stop a doca port.

Parameters

port: Port struct.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_UNKNOWN - otherwise.

Description

Stop the port, disable the traffic, destroy the doca port, free all resources of the port.

__DOCA_EXPERIMENTAL doca_flow_port* doca_flow_port_switch_get ( const doca_flow_port* port )

Get doca flow switch port.

Parameters

port: The port for which to get the switch port. If NULL, get the first switch port created. The application could use this function to get the doca switch port, then create pipes and pipe entries on this port.

Returns

The parent switch port number or NULL if none found

Description

doca_error_t doca_flow_query_entry ( doca_flow_pipe_entry* entry, doca_flow_query* query_stats )

Extract information about specific entry.

Parameters

entry: The pipe entry to query.
query_stats: Data retrieved by the query.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_UNKNOWN - otherwise.

Description

Query the packet statistics about specific pipe entry

doca_error_t doca_flow_query_pipe_miss ( doca_flow_pipe* pipe, doca_flow_query* query_stats )

Extract information about pipe miss entry.

Parameters

pipe: The pipe to query.
query_stats: Data retrieved by the query.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_UNKNOWN - otherwise.

Description

Query the packet statistics about specific pipe miss entry

doca_error_t doca_flow_shared_resource_cfg ( doca_flow_shared_resource_type type, uint32_t id, doca_flow_shared_resource_cfg* cfg )

Configure a single shared resource.

Parameters

type: Shared resource type.
id: Shared resource id.
cfg: Pointer to a shared resource configuration.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - memory allocation failed.
DOCA_ERROR_NOT_SUPPORTED - unsupported shared resource type.
DOCA_ERROR_UNKNOWN - otherwise.

Description

This API can be used by bounded and unbounded resources.

doca_error_t doca_flow_shared_resources_bind ( doca_flow_shared_resource_type type, uint32_t* res_array, uint32_t res_array_len, void* bindable_obj )

Binds a bulk of shared resources to a bindable object.

Parameters

type: Shared resource type.
res_array: Array of shared resource IDs.
res_array_len: Shared resource IDs array length.
bindable_obj: Pointer to an allowed bindable object, use NULL to bind globally.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - memory allocation failed.
DOCA_ERROR_NOT_SUPPORTED - unsupported shared resource type.
DOCA_ERROR_UNKNOWN - otherwise.

Description

Binds a bulk of shared resources from the same type to a bindable object. Currently the bindable objects are ports and pipes.

doca_error_t doca_flow_shared_resources_query ( doca_flow_shared_resource_type type, uint32_t* res_array, doca_flow_shared_resource_result* query_results_array, uint32_t array_len )

Extract information about shared counter.

Parameters

type: Shared object type.
res_array: Array of shared objects IDs to query.
query_results_array: Data array retrieved by the query.
array_len: Number of objects and their query results in their arrays (same number).

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - memory allocation failed.
DOCA_ERROR_NOT_SUPPORTED - unsupported shared resource type.
DOCA_ERROR_UNKNOWN - otherwise.

Description

Query an array of shared objects of a specific type.

2.18. Crypto Flow Net Define

DOCA HW offload flow cryptonet structure define. For more details please refer to the user guide on DOCA devzone.

Enumerations

enum doca_flow_crypto_action_type: doca flow crypto operation action type
enum doca_flow_crypto_header_type: doca flow crypto operation encapsulation header type
enum doca_flow_crypto_icv_size: doca flow crypto protocol Integrity Check Value size
enum doca_flow_crypto_net_type: doca flow crypto operation network mode type
enum doca_flow_crypto_protocol_type: doca flow crypto operation protocol type
enum doca_flow_crypto_reformat_type: doca flow crypto operation reformat type

Enumerations

enum doca_flow_crypto_action_type

Values

DOCA_FLOW_CRYPTO_ACTION_NONE = 0: No crypto action performed
DOCA_FLOW_CRYPTO_ACTION_ENCRYPT: Perform encryption
DOCA_FLOW_CRYPTO_ACTION_DECRYPT: Perform decryption/authentication

enum doca_flow_crypto_header_type

Values

DOCA_FLOW_CRYPTO_HEADER_NONE = 0: No network header involved
DOCA_FLOW_CRYPTO_HEADER_IPV4: IPv4 network header type
DOCA_FLOW_CRYPTO_HEADER_IPV6: IPv6 network header type
DOCA_FLOW_CRYPTO_HEADER_IPV4_UDP: IPv4 + UDP network header type
DOCA_FLOW_CRYPTO_HEADER_IPV6_UDP: IPv6 + UDP network header type

enum doca_flow_crypto_icv_size

Values

DOCA_FLOW_CRYPTO_ICV_DEFAULT = 0: Use default ICV size for specified protocol.
DOCA_FLOW_CRYPTO_ICV_8B = 8: ICV size is 8B
DOCA_FLOW_CRYPTO_ICV_12B = 12: ICV size is 12B
DOCA_FLOW_CRYPTO_ICV_16B = 16: ICV size is 16B

enum doca_flow_crypto_net_type

Values

DOCA_FLOW_CRYPTO_NET_NONE = 0: No network header involved
DOCA_FLOW_CRYPTO_NET_TUNNEL: Tunnel network header
DOCA_FLOW_CRYPTO_NET_TRANSPORT: Tramsport network header

enum doca_flow_crypto_protocol_type

Values

DOCA_FLOW_CRYPTO_PROTOCOL_NONE = 0: No security protocol engaged
DOCA_FLOW_CRYPTO_PROTOCOL_ESP: IPsec ESP protocol action

enum doca_flow_crypto_reformat_type

Values

DOCA_FLOW_CRYPTO_REFORMAT_NONE = 0: No reformat action performed
DOCA_FLOW_CRYPTO_REFORMAT_ENCAP: Perform encapsulation action
DOCA_FLOW_CRYPTO_REFORMAT_DECAP: Perform decapsulation action

2.19. Connection Tracking Flow

DOCA HW connection tracking library.

Classes

struct doca_flow_ct_cfg: doca flow ct global configuration
union doca_flow_ct_meta: CT packet meta data.

Defines

#define DOCA_FLOW_CT_META_TYPE_MASK 0x3

Enumerations

enum doca_flow_ct_flags: CT flags.
enum doca_flow_ct_hash_type: CT hash table type.
enum doca_flow_ct_meta_type
enum doca_flow_ct_session_type: CT l3 session types.

Functions

__DOCA_EXPERIMENTAL void doca_flow_ct_destroy ( void ): Destroy the doca flow ct.
doca_error_t doca_flow_ct_init ( const doca_flow_ct_cfg* cfg ): Initialize the doca flow ct.
__DOCA_EXPERIMENTAL uint32_t doca_flow_ct_meta_get_action_offset ( bool is_reply ): Get action data bit offset in meta data field.
__DOCA_EXPERIMENTAL uint32_t doca_flow_ct_meta_get_user_offset ( bool is_reply ): Get User data bit offset in meta data field.
__DOCA_EXPERIMENTAL uint32_t doca_flow_ct_meta_get_zone ( uint32_t meta, bool is_reply ): Get modify meta zone data.
__DOCA_EXPERIMENTAL uint32_t doca_flow_ct_meta_get_zone_offset ( bool is_reply ): Get zone data bit offset in meta data field.
__DOCA_EXPERIMENTAL void doca_flow_ct_meta_mask_prepare ( doca_flow_meta* meta, bool is_reply ): Prepare meta as mask with zone and CT type.
__DOCA_EXPERIMENTAL void doca_flow_ct_meta_prepare ( doca_flow_meta* meta, uint32_t zone, bool is_reply ): Prepare meta with zone and default CT type.
__DOCA_EXPERIMENTAL void doca_flow_ct_meta_set_action ( uint32_t* meta, uint32_t action_data, bool is_reply ): Set meta action data applies to identified connection packets.
__DOCA_EXPERIMENTAL void doca_flow_ct_meta_set_match_zone ( doca_flow_meta* meta, uint32_t zone, bool is_reply ): Set meta match zone data to doca_flow meta.
__DOCA_EXPERIMENTAL void doca_flow_ct_meta_set_user ( uint32_t* meta, uint32_t user_data, bool is_reply ): Set user data in meta data field.
__DOCA_EXPERIMENTAL void doca_flow_ct_meta_set_zone ( uint32_t* meta, uint32_t zone, bool is_reply ): Set meta zone data applies to identified connection packets.
__DOCA_EXPERIMENTAL void doca_flow_ct_set_vxlan_dst_port ( uint16_t dst_port ): Sets UDP outer destination port for VxLAN traffic.

Defines

#define DOCA_FLOW_CT_META_TYPE_MASK 0x3

Meta type mask

Enumerations

enum doca_flow_ct_flags

Values

DOCA_FLOW_CT_FLAG_STATS = 1u<<0: Enable counter for internal pipes
DOCA_FLOW_CT_FLAG_WORKER_STATS = 1u<<1: Enable worker counter dump
DOCA_FLOW_CT_FLAG_NO_AGING = 1u<<2: Bypass aging scan
DOCA_FLOW_CT_FLAG_SW_PKT_PARSING = 1u<<3: Force software packet parsing
DOCA_FLOW_CT_FLAG_MANAGED = 1u<<4: User managed worker thread, API only
DOCA_FLOW_CT_FLAG_ASYMMETRIC = 1u<<5: Asymmetric 6-tuple table definition
DOCA_FLOW_CT_FLAG_ASYMMETRIC_COUNTER = 1u<<6: Different counter in both direction

enum doca_flow_ct_hash_type

Values

DOCA_FLOW_CT_HASH_NONE: No hash table, besides zone, meta data bits reserved as connection ID.
DOCA_FLOW_CT_HASH_SYMMETRIC: Hardware symmetric hash function

enum doca_flow_ct_meta_type

Meta connection type

Values

DOCA_FLOW_CT_META_NONE: Regular payload traffic
DOCA_FLOW_CT_META_NEW: SYN or first UDP packet
DOCA_FLOW_CT_META_END: FIN or RST packet
DOCA_FLOW_CT_META_UPDATE: Payload to update user action data

enum doca_flow_ct_session_type

Values

DOCA_FLOW_CT_SESSION_IPV4: IPv4 session.
DOCA_FLOW_CT_SESSION_IPV6: IPv6 session.
DOCA_FLOW_CT_SESSION_BOTH: Total session.
DOCA_FLOW_CT_SESSION_MAX: Max session types.

Functions

__DOCA_EXPERIMENTAL void doca_flow_ct_destroy ( void )

Destroy the doca flow ct.

Description

Release all the resources used by doca flow ct.

Must be invoked before doca flow detroy.

doca_error_t doca_flow_ct_init ( const doca_flow_ct_cfg* cfg )

Initialize the doca flow ct.

Parameters

cfg: CT configuration.

Returns

0 on success, a negative errno value otherwise.

Description

This is the global initialization function for doca flow ct. It initializes all resources used by doca flow.

Must be invoked first before any other function in this API. this is a one time call, used for doca flow ct initialization and global configurations.

Must be invoked after Doca Flow initilization, before port start.

__DOCA_EXPERIMENTAL uint32_t doca_flow_ct_meta_get_action_offset ( bool is_reply )

Get action data bit offset in meta data field.

Parameters

is_reply: Reply direction in asymmetric mode.

Returns

Action data bit offset.

Description

__DOCA_EXPERIMENTAL uint32_t doca_flow_ct_meta_get_user_offset ( bool is_reply )

Get User data bit offset in meta data field.

Parameters

is_reply: Reply direction in asymmetric mode.

Returns

User data bit offset.

Description

__DOCA_EXPERIMENTAL uint32_t doca_flow_ct_meta_get_zone ( uint32_t meta, bool is_reply )

Get modify meta zone data.

Parameters

meta: CT meta.
is_reply: Get reply direction zone in asymmetric mode.

Returns

Zone value.

Description

__DOCA_EXPERIMENTAL uint32_t doca_flow_ct_meta_get_zone_offset ( bool is_reply )

Get zone data bit offset in meta data field.

Parameters

is_reply: Reply direction in asymmetric mode.

Returns

Zone data bit offset.

Description

__DOCA_EXPERIMENTAL void doca_flow_ct_meta_mask_prepare ( doca_flow_meta* meta, bool is_reply )

Prepare meta as mask with zone and CT type.

Parameters

meta: Doca flow meta.
is_reply: Prepare reply direction zone in asymmetric mode.

Description

__DOCA_EXPERIMENTAL void doca_flow_ct_meta_prepare ( doca_flow_meta* meta, uint32_t zone, bool is_reply )

Prepare meta with zone and default CT type.

Parameters

meta: Doca flow meta.
zone: Zone value.
is_reply: Prepare reply direction zone in asymmetric mode.

Description

__DOCA_EXPERIMENTAL void doca_flow_ct_meta_set_action ( uint32_t* meta, uint32_t action_data, bool is_reply )

Set meta action data applies to identified connection packets.

Parameters

meta: CT meta.
action_data: Action data.
is_reply: Reply direction in asymmetric mode.

Description

__DOCA_EXPERIMENTAL void doca_flow_ct_meta_set_match_zone ( doca_flow_meta* meta, uint32_t zone, bool is_reply )

Set meta match zone data to doca_flow meta.

Parameters

meta: doca_flow meta.
zone: Zone value.
is_reply: Set reply direction zone in asymmetric mode.

Description

__DOCA_EXPERIMENTAL void doca_flow_ct_meta_set_user ( uint32_t* meta, uint32_t user_data, bool is_reply )

Set user data in meta data field.

Parameters

meta: CT meta.
user_data: User data value.
is_reply: Reply direction in asymmetric mode.

Description

User data is ignored by worker, can't be carried with identified conneciton packets.

__DOCA_EXPERIMENTAL void doca_flow_ct_meta_set_zone ( uint32_t* meta, uint32_t zone, bool is_reply )

Set meta zone data applies to identified connection packets.

Parameters

meta: CT meta.
zone: Zone value.
is_reply: Set reply direction zone in asymmetric mode.

Description

__DOCA_EXPERIMENTAL void doca_flow_ct_set_vxlan_dst_port ( uint16_t dst_port )

Sets UDP outer destination port for VxLAN traffic.

Parameters

dst_port: outer UDP destination value.

Description

This is to initialization the UDP outer destination port for VxLAN traffic. Sets the VxLAN dest port global variable value.

Optional, default to 4789. Must be invoked after Doca Flow and CT initialization.

2.20. GRPC Flow

DOCA flow grpc API to run remote HW offload with flow library. For more details please refer to the user guide on DOCA devzone.

Classes

struct doca_flow_grpc_bindable_obj: bindable object configuration
struct doca_flow_grpc_fwd: forwarding configuration wrapper
struct doca_flow_grpc_pipe_cfg: pipeline configuration wrapper

Enumerations

enum doca_flow_grpc_bindable_obj_type: doca flow grpc bindable object types

Functions

doca_error_t doca_flow_grpc_aging_handle ( uint16_t port_id, uint16_t queue, uint64_t quota, uint64_t max_entries, uint64_t* entries_id, int len, int* nb_aged_flow ): RPC call for doca_flow_aging_handle().
__DOCA_EXPERIMENTAL void doca_flow_grpc_client_create ( const char* grpc_address ): Initialize a channel to DOCA flow grpc server.
doca_error_t doca_flow_grpc_destroy ( void ): RPC call for doca_flow_destroy().
doca_error_t doca_flow_grpc_entries_process ( uint16_t port_id, uint16_t pipe_queue, uint64_t timeout, uint32_t max_processed_entries, int* num_processed_entries ): RPC call for doca_flow_grpc_entries_process().
doca_error_t doca_flow_grpc_init ( const doca_flow_cfg* cfg ): RPC call for doca_flow_init().
doca_error_t doca_flow_grpc_pipe_add_entry ( uint16_t pipe_queue, uint64_t pipe_id, const doca_flow_match* match, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_grpc_fwd* client_fwd, uint32_t flags, uint64_t* entry_id ): RPC call for doca_flow_pipe_add_entry().
doca_error_t doca_flow_grpc_pipe_control_add_entry ( uint16_t pipe_queue, uint8_t priority, uint64_t pipe_id, const doca_flow_match* match, const doca_flow_match* match_mask, const doca_flow_actions* actions, const doca_flow_actions* actions_mask, const doca_flow_grpc_fwd* client_fwd, uint64_t* entry_id ): RPC call for doca_flow_pipe_control_add_entry().
doca_error_t doca_flow_grpc_pipe_create ( const doca_flow_grpc_pipe_cfg* cfg, const doca_flow_grpc_fwd* fwd, const doca_flow_grpc_fwd* fwd_miss, uint64_t* pipe_id ): RPC call for doca_flow_pipe_create().
doca_error_t doca_flow_grpc_pipe_destroy ( uint64_t pipe_id ): RPC call for doca_flow_pipe_destroy().
doca_error_t doca_flow_grpc_pipe_dump ( uint64_t pipe_id, FILE* f ): RPC call for doca_flow_pipe_dump().
doca_error_t doca_flow_grpc_pipe_entry_get_status ( uint64_t entry_id, doca_flow_entry_status ** entry_status ): RPC call for doca_flow_pipe_entry_get_status().
doca_error_t doca_flow_grpc_pipe_lpm_add_entry ( uint16_t pipe_queue, uint64_t pipe_id, const doca_flow_match* match, const doca_flow_match* match_mask, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_grpc_fwd* client_fwd, const doca_flow_flags_type flag, uint64_t* entry_id ): RPC call for doca_flow_pipe_lpm_add_entry().
doca_error_t doca_flow_grpc_pipe_rm_entry ( uint16_t pipe_queue, uint64_t entry_id, uint32_t flags ): RPC call for doca_flow_grpc_pipe_rm_entry().
doca_error_t doca_flow_grpc_port_pair ( uint16_t port_id, uint16_t pair_port_id ): RPC call for doca_flow_port_pair().
doca_error_t doca_flow_grpc_port_pipes_dump ( uint16_t port_id, FILE* f ): RPC call for doca_flow_port_pipes_dump().
doca_error_t doca_flow_grpc_port_pipes_flush ( uint16_t port_id ): RPC call for doca_flow_port_pipes_flush().
doca_error_t doca_flow_grpc_port_start ( const doca_flow_port_cfg* cfg, uint16_t* port_id ): RPC call for doca_flow_port_start().
doca_error_t doca_flow_grpc_port_stop ( uint16_t port_id ): RPC call for doca_flow_port_stop().
doca_error_t doca_flow_grpc_port_switch_get ( uint16_t* port_id ): RPC call for doca_flow_port_switch_get().
doca_error_t doca_flow_grpc_query_entry ( uint64_t entry_id, doca_flow_query* query_stats ): RPC call for doca_flow_query_entry().
doca_error_t doca_flow_grpc_query_pipe_miss ( uint64_t pipe_id, doca_flow_query* query_stats ): RPC call for doca_flow_query_pipe_miss().
doca_error_t doca_flow_grpc_shared_resource_cfg ( doca_flow_shared_resource_type type, uint32_t id, doca_flow_shared_resource_cfg* cfg ): RPC call for doca_flow_shared_resource_cfg().
doca_error_t doca_flow_grpc_shared_resources_bind ( doca_flow_shared_resource_type type, uint32_t* res_array, uint32_t res_array_len, doca_flow_grpc_bindable_obj* bindable_obj_id ): RPC call for doca_flow_shared_resources_bind().
doca_error_t doca_flow_grpc_shared_resources_query ( doca_flow_shared_resource_type type, uint32_t* res_array, doca_flow_shared_resource_result* query_results_array, uint32_t array_len ): RPC call for doca_flow_shared_resources_query().

Enumerations

enum doca_flow_grpc_bindable_obj_type

Values

DOCA_FLOW_GRPC_BIND_TYPE_PIPE: bind resource to a pipe
DOCA_FLOW_GRPC_BIND_TYPE_PORT: bind resource to a port
DOCA_FLOW_GRPC_BIND_TYPE_NULL: bind resource globally

Functions

doca_error_t doca_flow_grpc_aging_handle ( uint16_t port_id, uint16_t queue, uint64_t quota, uint64_t max_entries, uint64_t* entries_id, int len, int* nb_aged_flow )

RPC call for doca_flow_aging_handle().

Parameters

port_id: Port id to handle aging
queue: Queue identifier.
quota: Max time quota in micro seconds for this function to handle aging.
max_entries: Max entries for this function to handle aging, 0: no limit.
entries_id: User input entries array for the aged flows.
len: User input length of entries array.
nb_aged_flow: Number of aged flow.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

__DOCA_EXPERIMENTAL void doca_flow_grpc_client_create ( const char* grpc_address )

Initialize a channel to DOCA flow grpc server.

Parameters

grpc_address: String representing the service ip, i.e. "127.0.0.1" or "192.168.100.3:5050". If no port is provided, it will use the service default port.

Description

Must be invoked first before any other function in this API. this is a one time call, used for grpc channel initialization.

doca_error_t doca_flow_grpc_destroy ( void )

RPC call for doca_flow_destroy().

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise

Description

doca_error_t doca_flow_grpc_entries_process ( uint16_t port_id, uint16_t pipe_queue, uint64_t timeout, uint32_t max_processed_entries, int* num_processed_entries )

RPC call for doca_flow_grpc_entries_process().

Parameters

port_id: Port ID
pipe_queue: Queue identifier.
timeout: Max time in micro seconds for this function to process entries. Process once if timeout is 0
max_processed_entries: Flow entries number to process If it is 0, it will proceed until timeout.
num_processed_entries: Number of entries processed

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_init ( const doca_flow_cfg* cfg )

RPC call for doca_flow_init().

Parameters

cfg: Program configuration, see doca_flow_cfg for details.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_pipe_add_entry ( uint16_t pipe_queue, uint64_t pipe_id, const doca_flow_match* match, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_grpc_fwd* client_fwd, uint32_t flags, uint64_t* entry_id )

RPC call for doca_flow_pipe_add_entry().

Parameters

pipe_queue: Queue identifier.
pipe_id: Pipe ID.
match: Pointer to match, indicate specific packet match information.
actions: Pointer to modify actions, indicate specific modify information.
monitor: Pointer to monitor actions.
client_fwd: Pointer to fwd actions.
flags: Flow entry will be pushed to hw immediately or not. enum doca_flow_flags_type.
entry_id: Created entry ID on success.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_pipe_control_add_entry ( uint16_t pipe_queue, uint8_t priority, uint64_t pipe_id, const doca_flow_match* match, const doca_flow_match* match_mask, const doca_flow_actions* actions, const doca_flow_actions* actions_mask, const doca_flow_grpc_fwd* client_fwd, uint64_t* entry_id )

RPC call for doca_flow_pipe_control_add_entry().

Parameters

pipe_queue: Queue identifier.
priority: Priority value..
pipe_id: Pipe ID.
match: Pointer to match, indicate specific packet match information.
match_mask
actions: Pointer to actions
actions_mask: Pointer to actions' mask Pointer to match mask information.
client_fwd: Pointer to fwd actions.
entry_id: Created entry ID on success.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_pipe_create ( const doca_flow_grpc_pipe_cfg* cfg, const doca_flow_grpc_fwd* fwd, const doca_flow_grpc_fwd* fwd_miss, uint64_t* pipe_id )

RPC call for doca_flow_pipe_create().

Parameters

cfg: Pipe configuration, see doca_flow_grpc_pipe_cfg for details.
fwd: Fwd configuration for the pipe.
fwd_miss: Fwd_miss configuration for the pipe. NULL for no fwd_miss. When creating a pipe if there is a miss and fwd_miss configured, packet steering should jump to it.
pipe_id: Created pipe ID on success.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_pipe_destroy ( uint64_t pipe_id )

RPC call for doca_flow_pipe_destroy().

Parameters

pipe_id: Pipe ID.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise

Description

doca_error_t doca_flow_grpc_pipe_dump ( uint64_t pipe_id, FILE* f )

RPC call for doca_flow_pipe_dump().

Parameters

pipe_id: pipe ID.
f: The output file of the pipe information.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise

Description

doca_error_t doca_flow_grpc_pipe_entry_get_status ( uint64_t entry_id, doca_flow_entry_status ** entry_status )

RPC call for doca_flow_pipe_entry_get_status().

Parameters

entry_id: pipe entry ID
entry_status: entry's status

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_pipe_lpm_add_entry ( uint16_t pipe_queue, uint64_t pipe_id, const doca_flow_match* match, const doca_flow_match* match_mask, const doca_flow_actions* actions, const doca_flow_monitor* monitor, const doca_flow_grpc_fwd* client_fwd, const doca_flow_flags_type flag, uint64_t* entry_id )

RPC call for doca_flow_pipe_lpm_add_entry().

Parameters

pipe_queue: Queue identifier.
pipe_id: Pipe ID.
match: Pointer to match, indicate specific packet match information.
match_mask: Pointer to match mask information.
actions: Pointer to modify actions, indicate specific modify information.
monitor: Pointer to monitor actions.
client_fwd: Pointer to fwd actions.
flag: Flow entry will be pushed to hw immediately or not. enum doca_flow_flags_type.
entry_id: Created entry ID on success.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_pipe_rm_entry ( uint16_t pipe_queue, uint64_t entry_id, uint32_t flags )

RPC call for doca_flow_grpc_pipe_rm_entry().

Parameters

pipe_queue: Queue identifier.
entry_id: The entry ID to be removed.
flags: Flow entry will removed from hw immediately or not. enum doca_flow_flags_type.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_port_pair ( uint16_t port_id, uint16_t pair_port_id )

RPC call for doca_flow_port_pair().

Parameters

port_id: port ID.
pair_port_id: pair port ID.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_port_pipes_dump ( uint16_t port_id, FILE* f )

RPC call for doca_flow_port_pipes_dump().

Parameters

port_id: Port ID.
f: The output file of the pipe information.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise

Description

doca_error_t doca_flow_grpc_port_pipes_flush ( uint16_t port_id )

RPC call for doca_flow_port_pipes_flush().

Parameters

port_id: Port ID.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise

Description

doca_error_t doca_flow_grpc_port_start ( const doca_flow_port_cfg* cfg, uint16_t* port_id )

RPC call for doca_flow_port_start().

Parameters

cfg: Port configuration, see doca_flow_port_cfg for details.
port_id: Created port ID on success.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_port_stop ( uint16_t port_id )

RPC call for doca_flow_port_stop().

Parameters

port_id: Port ID.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_port_switch_get ( uint16_t* port_id )

RPC call for doca_flow_port_switch_get().

Parameters

port_id: Switch port ID

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_query_entry ( uint64_t entry_id, doca_flow_query* query_stats )

RPC call for doca_flow_query_entry().

Parameters

entry_id: The pipe entry ID to query.
query_stats: Data retrieved by the query.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_query_pipe_miss ( uint64_t pipe_id, doca_flow_query* query_stats )

RPC call for doca_flow_query_pipe_miss().

Parameters

pipe_id: The pipe ID to query.
query_stats: Data retrieved by the query.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_shared_resource_cfg ( doca_flow_shared_resource_type type, uint32_t id, doca_flow_shared_resource_cfg* cfg )

RPC call for doca_flow_shared_resource_cfg().

Parameters

type: Shared resource type.
id: Shared resource id.
cfg: Pointer to a shared resource configuration.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_shared_resources_bind ( doca_flow_shared_resource_type type, uint32_t* res_array, uint32_t res_array_len, doca_flow_grpc_bindable_obj* bindable_obj_id )

RPC call for doca_flow_shared_resources_bind().

Parameters

type: Shared resource type.
res_array: Array of shared resource IDs.
res_array_len: Shared resource IDs array length.
bindable_obj_id: Pointer to a bindable object ID.

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

doca_error_t doca_flow_grpc_shared_resources_query ( doca_flow_shared_resource_type type, uint32_t* res_array, doca_flow_shared_resource_result* query_results_array, uint32_t array_len )

RPC call for doca_flow_shared_resources_query().

Parameters

type: Shared object type.
res_array: Array of shared objects IDs to query.
query_results_array: Data array retrieved by the query.
array_len: Number of objects and their query results in their arrays (same number).

Returns

DOCA_SUCCESS on success and DOCA_ERROR otherwise.

Description

2.21. Flow Net Define

DOCA HW offload flow net structure define. For more details please refer to the user guide on DOCA devzone.

Classes

union doca_flow_geneve_option: doca flow GENEVE option single DW.
struct doca_flow_header_eth: doca flow eth header
struct doca_flow_header_eth_vlan: doca flow vlan header
struct doca_flow_header_geneve: doca flow GENEVE header.
struct doca_flow_header_icmp: doca flow icmp header in match data
struct doca_flow_header_ip4: doca flow ipv4 header in match data
struct doca_flow_header_ip6: doca flow ipv6 header in match data
struct doca_flow_header_l4_port: doca flow tcp or udp port header in match data
struct doca_flow_header_mpls: doca flow MPLS header.
struct doca_flow_header_tcp: doca flow tcp header in match data
struct doca_flow_header_udp: doca flow udp header in match data
struct doca_flow_ip_addr: doca flow ip address
struct doca_flow_tun: doca flow tunnel information

Defines

#define DOCA_ETHER_ADDR_LEN (6)
#define DOCA_ETHER_TYPE_IPV4 (0x0800)
#define DOCA_ETHER_TYPE_IPV6 (0x86DD)
#define DOCA_ETHER_TYPE_TEB (0x6558)
#define DOCA_FLOW_CRYPTO_KEY_LEN_MAX 32
#define DOCA_FLOW_CRYPTO_REFORMAT_LEN_MAX
#define DOCA_FLOW_ESP_HEADER_LEN
#define DOCA_FLOW_GENEVE_DATA_OPTION_LEN_MAX 31
#define DOCA_FLOW_GENEVE_DEFAULT_PORT (6081)
#define DOCA_FLOW_GENEVE_NUM_OF_OPTIONS_MAX 8
#define DOCA_FLOW_GENEVE_OPT_LEN_MAX 63
#define DOCA_FLOW_MPLS_DEFAULT_PORT (6635)
#define DOCA_FLOW_MPLS_LABELS_MAX 5
#define DOCA_GTPU_PORT (2152)
#define DOCA_PROTO_GRE (47)
#define DOCA_PROTO_ICMP (1)
#define DOCA_PROTO_ICMP6 (58)
#define DOCA_PROTO_TCP (6)
#define DOCA_PROTO_UDP (17)
#define DOCA_VXLAN_DEFAULT_PORT (4789)

Enumerations

enum doca_flow_l3_type: doca flow layer 3 packet type
enum doca_flow_l4_type_ext: doca flow layer 4 packet extend type
enum doca_flow_tun_type: doca flow tunnel type

Defines

#define DOCA_ETHER_ADDR_LEN (6)

length of ether add length.

#define DOCA_ETHER_TYPE_IPV4 (0x0800)

Ethernet frame types IPv4 Protocol.

#define DOCA_ETHER_TYPE_IPV6 (0x86DD)

IPv6 Protocol.

#define DOCA_ETHER_TYPE_TEB (0x6558)

Transparent Ethernet Bridging.

#define DOCA_FLOW_CRYPTO_KEY_LEN_MAX 32

Crypto key maximal length in bytes

#define DOCA_FLOW_CRYPTO_REFORMAT_LEN_MAX

Crypto tunnel header may consist of:

Ethernet addresses
Ethernet type
optional VLAN and 802.1Q headers
IPv4 (with full options) or IPv6 (w/o options)
optional UDP header
ESP (or otyer crypto protocol) header

Value

(DOCA_ETHER_ADDR_LEN * 2 + \ sizeof(doca_be16_t) + \ sizeof(doca_be16_t) * 2 * 2 + \ sizeof(doca_be32_t) * 15 + \ sizeof(doca_be32_t) * 2 + \ DOCA_FLOW_ESP_HEADER_LEN)

#define DOCA_FLOW_ESP_HEADER_LEN

IPsec ESP header maximal length in bytes

Value

(4 * sizeof(doca_be32_t))

#define DOCA_FLOW_GENEVE_DATA_OPTION_LEN_MAX 31

Max data length in single GENEVE option (in 4 bytes granularity).

#define DOCA_FLOW_GENEVE_DEFAULT_PORT (6081)

default GENEVE port id.

#define DOCA_FLOW_GENEVE_NUM_OF_OPTIONS_MAX 8

Upper bound for GENEVE TLV options number.

#define DOCA_FLOW_GENEVE_OPT_LEN_MAX 63

Max GENEVE options length in single packet (in 4 bytes granularity).

#define DOCA_FLOW_MPLS_DEFAULT_PORT (6635)

default MPLS port id.

#define DOCA_FLOW_MPLS_LABELS_MAX 5

Max MPLS labels in single match.

#define DOCA_GTPU_PORT (2152)

gtpu upd port id.

#define DOCA_PROTO_GRE (47)

Cisco GRE tunnels (rfc 1701,1702).

#define DOCA_PROTO_ICMP (1)

Internet Control Message Protocol v4.

#define DOCA_PROTO_ICMP6 (58)

Internet Control Message Protocol v6.

#define DOCA_PROTO_TCP (6)

Transmission Control Protocol.

#define DOCA_PROTO_UDP (17)

User Datagram Protocol.

#define DOCA_VXLAN_DEFAULT_PORT (4789)

default vxlan port id.

Enumerations

enum doca_flow_l3_type

Values

DOCA_FLOW_L3_TYPE_NONE = 0: l3 type is not set
DOCA_FLOW_L3_TYPE_IP4: l3 type is ipv4
DOCA_FLOW_L3_TYPE_IP6: l3 type is ipv6

enum doca_flow_l4_type_ext

Values

DOCA_FLOW_L4_TYPE_EXT_NONE = 0: l4 ext type is not set
DOCA_FLOW_L4_TYPE_EXT_TCP: l4 ext type is tcp
DOCA_FLOW_L4_TYPE_EXT_UDP: l4 ext type is udp
DOCA_FLOW_L4_TYPE_EXT_ICMP: l4 ext type is icmp
DOCA_FLOW_L4_TYPE_EXT_ICMP6: l4 ext type is icmp6

enum doca_flow_tun_type

Values

DOCA_FLOW_TUN_NONE = 0: tunnel is not set
DOCA_FLOW_TUN_VXLAN: tunnel is vxlan type
DOCA_FLOW_TUN_GTPU: tunnel is gtpu type
DOCA_FLOW_TUN_GRE: tunnel is gre type
DOCA_FLOW_TUN_ESP: tunnel is ipsec esp type
DOCA_FLOW_TUN_MPLS_O_UDP: tunnel is mpls over udp type
DOCA_FLOW_TUN_GENEVE: tunnel is geneve type
DOCA_FLOW_TUN_MAX: tunnel is geneve type

2.22. DOCA GPUNETIO

DOCA GPUNETIO library.

Defines

#define DOCA_GPUNETIO_VOLATILE ( x )

Enumerations

enum doca_gpu_semaphore_status

Functions

doca_error_t doca_gpu_create ( const char* gpu_bus_id, doca_gpu** gpu_dev ): Create a DOCA GPUNETIO handler.
doca_error_t doca_gpu_destroy ( doca_gpu* gpu_dev ): Destroy a DOCA GPUNETIO handler.
doca_error_t doca_gpu_dmabuf_fd ( doca_gpu* gpu_dev, void* memptr_gpu, size_t size, int* dmabuf_fd )
doca_error_t doca_gpu_mem_alloc ( doca_gpu* gpu_dev, size_t size, size_t alignment, doca_gpu_mem_type mtype, void** memptr_gpu, void** memptr_cpu )
doca_error_t doca_gpu_mem_free ( doca_gpu* gpu, void* memptr_gpu )
doca_error_t doca_gpu_semaphore_create ( doca_gpu* gpu_dev, doca_gpu_semaphore** semaphore )
doca_error_t doca_gpu_semaphore_destroy ( doca_gpu_semaphore* semaphore )
doca_error_t doca_gpu_semaphore_get_custom_info_addr ( doca_gpu_semaphore* semaphore_cpu, uint32_t idx, void** custom_info )
doca_error_t doca_gpu_semaphore_get_gpu_handle ( doca_gpu_semaphore* semaphore_cpu, doca_gpu_semaphore_gpu** semaphore_gpu )
doca_error_t doca_gpu_semaphore_get_status ( doca_gpu_semaphore* semaphore_cpu, uint32_t idx, doca_gpu_semaphore_status ** status )
doca_error_t doca_gpu_semaphore_set_custom_info ( doca_gpu_semaphore* semaphore, uint32_t nbytes, doca_gpu_mem_type mtype )
doca_error_t doca_gpu_semaphore_set_items_num ( doca_gpu_semaphore* semaphore, uint32_t num_items )
doca_error_t doca_gpu_semaphore_set_memory_type ( doca_gpu_semaphore* semaphore, doca_gpu_mem_type mtype )
doca_error_t doca_gpu_semaphore_set_status ( doca_gpu_semaphore* semaphore_cpu, uint32_t idx, doca_gpu_semaphore_status status )
doca_error_t doca_gpu_semaphore_start ( doca_gpu_semaphore* semaphore )
doca_error_t doca_gpu_semaphore_stop ( doca_gpu_semaphore* semaphore )

Defines

#define DOCA_GPUNETIO_VOLATILE ( x )

Macro to temporarily cast a variable to volatile.

Value

(*(volatile typeof(x) *)&(x))

Enumerations

enum doca_gpu_semaphore_status

Semaphore list of possible statuses.

Values

DOCA_GPU_SEMAPHORE_STATUS_FREE = 0
DOCA_GPU_SEMAPHORE_STATUS_READY = 1
DOCA_GPU_SEMAPHORE_STATUS_DONE = 2
DOCA_GPU_SEMAPHORE_STATUS_HOLD = 3
DOCA_GPU_SEMAPHORE_STATUS_ERROR = 4
DOCA_GPU_SEMAPHORE_STATUS_EXIT = 5

Functions

doca_error_t doca_gpu_create ( const char* gpu_bus_id, doca_gpu** gpu_dev )

Create a DOCA GPUNETIO handler.

Parameters

gpu_bus_id: GPU PCIe address.
gpu_dev: Pointer to the newly created gpu device handler.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - gpu_dev argument is a NULL pointer.
DOCA_ERROR_NOT_FOUND - GPU not found at the input PCIe address
DOCA_ERROR_NO_MEMORY - failed to alloc doca_gpu.

Description

doca_error_t doca_gpu_destroy ( doca_gpu* gpu_dev )

Destroy a DOCA GPUNETIO handler.

Parameters

gpu_dev: Pointer to handler to be destroyed.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

Description

doca_error_t doca_gpu_dmabuf_fd ( doca_gpu* gpu_dev, void* memptr_gpu, size_t size, int* dmabuf_fd )

Parameters

gpu_dev: DOCA GPUNetIO handler.
memptr_gpu: GPU memory pointer to be freed.
size: Size in bytes to map.
dmabuf_fd: DMABuf file descriptor

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NOT_SUPPORTED - DMABuf not supported

Description

Return a DMABuf file descriptor from a GPU memory address if the GPU device and CUDA installation supports DMABuf.

doca_error_t doca_gpu_mem_alloc ( doca_gpu* gpu_dev, size_t size, size_t alignment, doca_gpu_mem_type mtype, void** memptr_gpu, void** memptr_cpu )

Parameters

gpu_dev: DOCA GPUNetIO handler.
size: Buffer size in bytes.
alignment: Buffer memory alignment. If 0, the return is a pointer that is suitably aligned for any kind of variable (in the same manner as malloc()). Otherwise, the return is a pointer that is a multiple of *align*. Alignment value must be a power of two.
mtype: Type of memory buffer. See enum doca_gpu_memtype for reference.
memptr_gpu: GPU memory pointer. Must be used with CUDA API and within CUDA kernels.
memptr_cpu: CPU memory pointer. Must be used for CPU direct access to the memory.

Returns

Non NULL memptr_gpu pointer on success, NULL otherwise. Non NULL memptr_cpu pointer on success in case of DOCA_GPU_MEM_CPU_GPU and DOCA_GPU_MEM_GPU_CPU, NULL otherwise. DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.
DOCA_ERROR_NO_MEMORY - if an error occurred dealing with GPU memory.

Description

Allocate a GPU accessible memory buffer. Assumes DPDK has been already attached with doca_gpu_to_dpdk(). According to the memory type specified, the buffer can be allocated in:

DOCA_GPU_MEM_GPU memptr_gpu is not NULL while memptr_cpu is NULL.
DOCA_GPU_MEM_GPU_CPU both memptr_gpu and memptr_cpu are not NULL.
DOCA_GPU_MEM_CPU_GPU both memptr_gpu and memptr_cpu are not NULL.
DOCA_GPU_MEM_CPU is not supported. Use regular malloc instead.

doca_error_t doca_gpu_mem_free ( doca_gpu* gpu, void* memptr_gpu )

Parameters

gpu: DOCA GPUNetIO handler.
memptr_gpu: GPU memory pointer to be freed.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Free a GPU memory buffer. Only memory allocated with doca_gpu_mem_alloc() can be freed with this function.

doca_error_t doca_gpu_semaphore_create ( doca_gpu* gpu_dev, doca_gpu_semaphore** semaphore )

Parameters

gpu_dev: DOCA GPUNetIO handler.
semaphore: Pointer to the newly created semaphore handler.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Create a DOCA GPUNetIO semaphore.

doca_error_t doca_gpu_semaphore_destroy ( doca_gpu_semaphore* semaphore )

Parameters

semaphore: DOCA GPUNetIO semaphore handler.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Stop a DOCA GPUNetIO semaphore.

doca_error_t doca_gpu_semaphore_get_custom_info_addr ( doca_gpu_semaphore* semaphore_cpu, uint32_t idx, void** custom_info )

Parameters

semaphore_cpu: DOCA GPUNetIO semaphore CPU handler.
idx: DOCA GPUNetIO semaphore item index.
custom_info: DOCA GPUNetIO semaphore custom info pointer.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Get pointer to DOCA GPUNetIO semaphore item associated custom info. This can be done only if custom info memory was set to DOCA_GPU_MEM_GPU_CPU or DOCA_GPU_MEM_CPU_GPU.

doca_error_t doca_gpu_semaphore_get_gpu_handle ( doca_gpu_semaphore* semaphore_cpu, doca_gpu_semaphore_gpu** semaphore_gpu )

Parameters

semaphore_cpu: DOCA GPUNetIO semaphore CPU handler.
semaphore_gpu: DOCA GPUNetIO semaphore GPU handler.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Get a DOCA GPUNetIO semaphore handle for GPU. This can be used within a CUDA kernel.

doca_error_t doca_gpu_semaphore_get_status ( doca_gpu_semaphore* semaphore_cpu, uint32_t idx, doca_gpu_semaphore_status ** status )

Parameters

semaphore_cpu: DOCA GPUNetIO semaphore CPU handler.
idx: DOCA GPUNetIO semaphore item index.
status: DOCA GPUNetIO semaphore status.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Get DOCA GPUNetIO semaphore status from CPU. This can be done only if item memory was set to DOCA_GPU_MEM_GPU_CPU or DOCA_GPU_MEM_CPU_GPU.

doca_error_t doca_gpu_semaphore_set_custom_info ( doca_gpu_semaphore* semaphore, uint32_t nbytes, doca_gpu_mem_type mtype )

Parameters

semaphore: DOCA GPUNetIO semaphore handler.
nbytes: DOCA GPUNetIO semaphore number of items.
mtype: DOCA GPUNetIO semaphore memory type.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Attach to each item in the DOCA GPUNetIO semaphore a custom user-defined structure defined through a number of bytes reserved for each item. Specify also which memory to use for the custom info items.

doca_error_t doca_gpu_semaphore_set_items_num ( doca_gpu_semaphore* semaphore, uint32_t num_items )

Parameters

semaphore: DOCA GPUNetIO semaphore handler.
num_items: DOCA GPUNetIO semaphore number of items.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Allocate DOCA GPUNetIO semaphore number of items.

doca_error_t doca_gpu_semaphore_set_memory_type ( doca_gpu_semaphore* semaphore, doca_gpu_mem_type mtype )

Parameters

semaphore: DOCA GPUNetIO semaphore handler.
mtype: DOCA GPUNetIO semaphore items type of memory.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Type of memory to be used to allocate DOCA GPUNetIO semaphore items. It determines semaphore visibility: GPU only or GPU and CPU.

doca_error_t doca_gpu_semaphore_set_status ( doca_gpu_semaphore* semaphore_cpu, uint32_t idx, doca_gpu_semaphore_status status )

Parameters

semaphore_cpu: DOCA GPUNetIO semaphore CPU handler.
idx: DOCA GPUNetIO semaphore item index.
status: DOCA GPUNetIO semaphore status.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Set DOCA GPUNetIO semaphore status from CPU. This can be done only if item memory was set to DOCA_GPU_MEM_GPU_CPU or DOCA_GPU_MEM_CPU_GPU.

doca_error_t doca_gpu_semaphore_start ( doca_gpu_semaphore* semaphore )

Parameters

semaphore: DOCA GPUNetIO semaphore handler.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Start a DOCA GPUNetIO semaphore. Attributes can't be set after this point.

doca_error_t doca_gpu_semaphore_stop ( doca_gpu_semaphore* semaphore )

Parameters

semaphore: DOCA GPUNetIO semaphore handler.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid input had been received.

Description

Stop a DOCA GPUNetIO semaphore.

2.23. IPsec

DOCA IPSEC library. For more details please refer to the user guide on DOCA devzone.

Classes

struct doca_encryption_key: IPSec encryption key.
struct doca_ipsec_sa_attr_egress: IPSec sa egress attributes - attributes for outgoing data.
struct doca_ipsec_sa_attr_ingress: IPSec sa egress attributes - attributes for incoming data.
struct doca_ipsec_sa_attr_sn: IPSec sa sn attributes - attributes for sequence number - only if SN or AR enabled.
struct doca_ipsec_sa_attrs: IPSec attributes for create jobs.
struct doca_ipsec_sa_create_job: DOCA IPSec SA creation job.
struct doca_ipsec_sa_destroy_job: DOCA IPSec SA destroy job.
struct doca_ipsec_sa_event_attrs: IPSec sa events attributes - when turned on will trigger an event.

Enumerations

enum doca_encryption_key_type: IPSec encryption key type.
enum doca_ipsec_direction: IPSec direction of the key, incoming packets or outgoing.
enum doca_ipsec_icv_length: IPSec icv length.
enum doca_ipsec_job_types: Doca ipsec action type enums, used to specify ipsec job types.
enum doca_ipsec_replay_win_size: IPSec replay window size.

Functions

doca_error_t doca_ipsec_antireplay_get_supported ( const doca_devinfo* devinfo ): Get is device support antireplay_enable capabilities.
__DOCA_EXPERIMENTAL doca_ctx* doca_ipsec_as_ctx ( doca_ipsec* ctx ): Convert IPSec instance into context for use with workQ.
doca_error_t doca_ipsec_create ( doca_ipsec** ctx ): Create a DOCA IPSEC instance.
doca_error_t doca_ipsec_destroy ( doca_ipsec* ctx ): Destroy DOCA IPSEC instance.
doca_error_t doca_ipsec_job_get_supported ( doca_devinfo* devinfo, doca_ipsec_job_types job_type ): Check if given device is capable for given doca_ipsec job.
__DOCA_EXPERIMENTAL doca_ipsec_sa* doca_ipsec_sa_from_result ( doca_event* ev ): Convert IPSec event job into sa object.
doca_error_t doca_ipsec_sequence_number_get_supported ( const doca_devinfo* devinfo ): Get is device support sn_enabled capabilities.
doca_error_t doca_ipsec_set_sa_pool_size ( doca_ipsec* ctx, uint32_t pool_size ): set the sa pool size for sa objects that are return by doca_ipsec_sa_create_job

Enumerations

enum doca_encryption_key_type

Values

DOCA_ENCRYPTION_KEY_AESGCM_128: size of 128 bit
DOCA_ENCRYPTION_KEY_AESGCM_256: size of 256 bit

enum doca_ipsec_direction

Values

DOCA_IPSEC_DIRECTION_INGRESS_DECRYPT = 0: incoming packets, decription
DOCA_IPSEC_DIRECTION_EGRESS_ENCRYPT = 1: outgoing packets, encription

enum doca_ipsec_icv_length

Values

DOCA_IPSEC_ICV_LENGTH_8 = 8: size of 8 bit
DOCA_IPSEC_ICV_LENGTH_12 = 12: size of 12 bit
DOCA_IPSEC_ICV_LENGTH_16 = 16: size of 16 bit

enum doca_ipsec_job_types

Values

DOCA_IPSEC_JOB_SA_CREATE = DOCA_ACTION_IPSEC_FIRST+1: create sa object
DOCA_IPSEC_JOB_SA_DESTROY: destroy sa object

enum doca_ipsec_replay_win_size

Values

DOCA_IPSEC_REPLAY_WIN_SIZE_32 = 32: size of 32 bit
DOCA_IPSEC_REPLAY_WIN_SIZE_64 = 64: size of 64 bit
DOCA_IPSEC_REPLAY_WIN_SIZE_128 = 128: size of 128 bit
DOCA_IPSEC_REPLAY_WIN_SIZE_256 = 256: size of 256 bit

Functions

doca_error_t doca_ipsec_antireplay_get_supported ( const doca_devinfo* devinfo )

Get is device support antireplay_enable capabilities.

Parameters

devinfo: The DOCA device information

Returns

DOCA_SUCCESS - in case of success - capability supported. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - failed to query device capabilities or provided devinfo does not support the given capabilitie.

Description

__DOCA_EXPERIMENTAL doca_ctx* doca_ipsec_as_ctx ( doca_ipsec* ctx )

Convert IPSec instance into context for use with workQ.

Parameters

ctx: IPSEC instance. This must remain valid until after the context is no longer required.

Returns

Non NULL - doca_ctx object on success. Error:

NULL.

Description

doca_error_t doca_ipsec_create ( doca_ipsec** ctx )

Create a DOCA IPSEC instance.

Description

doca_error_t doca_ipsec_destroy ( doca_ipsec* ctx )

Destroy DOCA IPSEC instance.

Parameters

ctx: Instance to be destroyed, MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - the ctx still in use by one or more workQs.

Description

doca_error_t doca_ipsec_job_get_supported ( doca_devinfo* devinfo, doca_ipsec_job_types job_type )

Check if given device is capable for given doca_ipsec job.

Parameters

devinfo: The DOCA device information
job_type: doca_ipsec job type. See enum doca_ipsec_job_types.

Returns

DOCA_SUCCESS - in case the job is supported. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - failed to query device capabilities or provided devinfo does not support the given doca_ipsec job.

Description

__DOCA_EXPERIMENTAL doca_ipsec_sa* doca_ipsec_sa_from_result ( doca_event* ev )

Convert IPSec event job into sa object.

Parameters

ev: event of ipsec job

Returns

Non NULL - sa object of ipsec. Error:

NULL.

Description

doca_error_t doca_ipsec_sequence_number_get_supported ( const doca_devinfo* devinfo )

Get is device support sn_enabled capabilities.

Parameters

devinfo: The DOCA device information

Returns

DOCA_SUCCESS - in case of success - capability supported. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - failed to query device capabilities or provided devinfo does not support the given capabilitie.

Description

doca_error_t doca_ipsec_set_sa_pool_size ( doca_ipsec* ctx, uint32_t pool_size )

set the sa pool size for sa objects that are return by doca_ipsec_sa_create_job

Parameters

ctx: IPSEC instance.
pool_size: Number of items to have available. default is 20,000

Returns

DOCA_SUCCESS - Property was successfully set Error code - in case of failure: DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_LOCK - Unable to gain exclusive control of ipsec instance. DOCA_ERROR_IN_USE - ipsec instance is currently started.

Description

Note:

The range of valid values for this property depend upon the device in use. This means that acceptance of a value through this API does not ensure the value is acceptable, this will be validated as part of starting the context

2.24. Logging Management

Define functions for internal and external logging management

To add DOCA internal logging compile with "-D DOCA_LOGGING_ALLOW_DLOG"

Classes

class doca_log_registrator: Registers log source on program start.

Defines

#define DOCA_DLOG ( level, format, ... ) do { \ } while (0): Generates a development log message.
#define DOCA_DLOG_CRIT ( format, ... ): Generates a CRITICAL development log message.
#define DOCA_DLOG_DBG ( format, ... ): Generates a DEBUG development log message.
#define DOCA_DLOG_ERR ( format, ... ): Generates an ERROR development log message.
#define DOCA_DLOG_INFO ( format, ... ): Generates an INFO development log message.
#define DOCA_DLOG_WARN ( format, ... ): Generates a WARNING development log message.
#define DOCA_LOG ( level, format, ... ): Generates a log message.
#define DOCA_LOG_CRIT ( format, ... ): Generates a CRITICAL log message.
#define DOCA_LOG_DBG ( format, ... ): Generates a DEBUG log message.
#define DOCA_LOG_ERR ( format, ... ): Generates an ERROR log message.
#define DOCA_LOG_INFO ( format, ... ): Generates an INFO log message.
#define DOCA_LOG_RATE_LIMIT ( level, format, ... ): Generates a log message with rate limit.
#define DOCA_LOG_RATE_LIMIT_CRIT ( format, ... ): Generates a CRITICAL rate limited log message.
#define DOCA_LOG_RATE_LIMIT_DBG ( format, ... ): Generates a DEBUG rate limited log message.
#define DOCA_LOG_RATE_LIMIT_ERR ( format, ... ): Generates an ERROR rate limited log message.
#define DOCA_LOG_RATE_LIMIT_INFO ( format, ... ): Generates an INFO rate limited log message.
#define DOCA_LOG_RATE_LIMIT_WARN ( format, ... ): Generates a WARNING rate limited log message.
#define DOCA_LOG_WARN ( format, ... ): Generates a WARNING log message.

Typedefs

typedef void ( *log_flush_callback )( char* buffer ): logging backend flush() handler

Enumerations

enum doca_log_level: log levels

Functions

doca_error_t doca_log ( uint32_t level, int source, int line, const char* format, ... ): Generates a log message.
doca_error_t doca_log_backend_level_set ( doca_logger_backend* logger, uint32_t level ): Set the log level of a specific logger backend.
doca_error_t doca_log_backend_set_lower_level_immutable ( doca_logger_backend* logger ): Mark the lower log level limit of a specific logger backend as immutable.
doca_error_t doca_log_backend_set_upper_level_immutable ( doca_logger_backend* logger ): Mark the upper log level limit of a specific logger backend as immutable.
doca_error_t doca_log_backend_set_upper_level_limit ( doca_logger_backend* logger, uint32_t upper_level_limit ): Set the upper log level limit of a specific logger backend.
doca_error_t doca_log_create_buffer_backend ( char* buffer, size_t capacity, log_flush_callback handler, doca_logger_backend** backend ): Create a logging backend with a char buffer stream.
doca_error_t doca_log_create_fd_backend ( int fd, doca_logger_backend** backend ): Create a logging backend with an fd stream.
doca_error_t doca_log_create_file_backend ( FILE* fptr, doca_logger_backend** backend ): Create a logging backend with a FILE* stream.
doca_error_t doca_log_create_standard_backend ( void ): Create default, non configurable backend.
doca_error_t doca_log_create_syslog_backend ( const char* name, doca_logger_backend** backend ): Create a logging backend with a syslog output.
doca_error_tdoca_error_t __DOCA_EXPERIMENTAL doca_log_developer ( uint32_t level, int source, int line, const char* format, ... ): Generates a log message for DLOG operations.
__DOCA_EXPERIMENTAL uint16_t doca_log_get_bucket_time ( void ): Get the timespan of the rate-limit bucket.
__DOCA_EXPERIMENTAL uint16_t doca_log_get_quantity ( void ): Get the quantity of the rate-limit bucket.
__DOCA_EXPERIMENTAL uint32_t doca_log_global_level_get ( void ): Get the global log level.
doca_error_t doca_log_global_level_set ( uint32_t level ): Set the log level of ALL logger backends.
doca_error_t doca_log_global_set_upper_level_limit ( uint32_t upper_level_limit ): Set the log upper level limit of ALL logger backends.
doca_error_t doca_log_rate_bucket_register ( int source, int* bucket ): Register a new rate bucket.
doca_error_tdoca_error_tdoca_error_t __DOCA_EXPERIMENTAL doca_log_rate_limit ( uint32_t level, int source, int line, int bucket, const char* format, ... ): Generates a log message with rate limit.
__DOCA_EXPERIMENTAL void doca_log_set_bucket_time ( uint16_t bucket_time ): Set the timespan of the rate-limit bucket.
__DOCA_EXPERIMENTAL void doca_log_set_quantity ( uint16_t quantity ): Set the quantity of the rate-limit bucket.
doca_error_t doca_log_source_destroy ( int source ): Destroy a log source.
doca_error_t doca_log_source_register ( const char* source_name, int* source ): Register a log source.

Defines

#define DOCA_DLOG ( level, format, ... ) do { \ } while (0)

The DOCA_DLOG() is the main log function for development purposes logging. To show the logs, define DOCA_LOGGING_ALLOW_DLOG in the compilation variables. This will not effect performance if compiled without DOCA_LOGGING_ALLOW_DLOG, as it will be removed by the compiler. Consider using the specific level DOCA_LOG for better code readability (i.e. DOCA_DLOG_ERR).

Parameters

level: Log level enum DOCA_LOG_LEVEL.
format: printf(3) arguments, format and variables.
...

#define DOCA_DLOG_CRIT ( format, ... )

Will generate critical log for development purposes. To show the logs define DOCA_LOGGING_ALLOW_DLOG in the compilation variables. This will not effect performance if compiled without DOCA_LOGGING_ALLOW_DLOG, as it will be removed by the compiler.

Value

DOCA_DLOG(CRIT, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_DLOG_DBG ( format, ... )

Will generate debug log for development purposes. To show the logs define DOCA_LOGGING_ALLOW_DLOG in the compilation variables. This will not effect performance if compiled without DOCA_LOGGING_ALLOW_DLOG, as it will be removed by the compiler.

Value

DOCA_DLOG(DEBUG, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_DLOG_ERR ( format, ... )

Will generate error log for development purposes. To show the logs define DOCA_LOGGING_ALLOW_DLOG in the compilation variables. This will not effect performance if compiled without DOCA_LOGGING_ALLOW_DLOG, as it will be removed by the compiler.

Value

DOCA_DLOG(ERROR, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_DLOG_INFO ( format, ... )

Will generate info log for development purposes. To show the logs define DOCA_LOGGING_ALLOW_DLOG in the compilation variables. This will not effect performance if compiled without DOCA_LOGGING_ALLOW_DLOG, as it will be removed by the compiler.

Value

DOCA_DLOG(INFO, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_DLOG_WARN ( format, ... )

Will generate warning log for development purposes. To show the logs define DOCA_LOGGING_ALLOW_DLOG in the compilation variables. This will not effect performance if compiled without DOCA_LOGGING_ALLOW_DLOG, as it will be removed by the compiler.

Value

DOCA_DLOG(WARNING, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_LOG ( level, format, ... )

The DOCA_LOG() is the main log function for logging. This call affects the performance. Consider using DOCA_DLOG for the option to remove it on the final compilation. Consider using the specific level DOCA_LOG for better code readability (i.e. DOCA_LOG_ERR).

Value

doca_log(DOCA_LOG_LEVEL_##level, log_source, __LINE__, format, ##__VA_ARGS__)

Parameters

level: Log level enum DOCA_LOG_LEVEL (just ERROR, WARNING...).
format: printf(3) arguments, format and variables.
...

#define DOCA_LOG_CRIT ( format, ... )

Will generate critical log. This call affects the performance. Consider using DOCA_DLOG for the option to remove it on the final compilation.

Value

DOCA_LOG(CRIT, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_LOG_DBG ( format, ... )

Will generate debug log. This call affects the performace. Consider using DOCA_DLOG for the option to remove it on the final compilation.

Value

DOCA_LOG(DEBUG, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_LOG_ERR ( format, ... )

Will generate error log. This call affects the performance. Consider using DOCA_DLOG for the option to remove it on the final compilation.

Value

DOCA_LOG(ERROR, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_LOG_INFO ( format, ... )

Will generate info log. This call affects the performance. Consider using DOCA_DLOG for the option to remove it on the final compilation.

Value

DOCA_LOG(INFO, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_LOG_RATE_LIMIT ( level, format, ... )

The DOCA_LOG_RATE_LIMIT calls DOCA_LOG with some rate limit. Implied to be used on hot paths.

Value

do { \ static int log_bucket = -1; \ if (log_bucket == -1) { \ doca_log_rate_bucket_register(log_source, &log_bucket); \ } \ doca_log_rate_limit(DOCA_LOG_LEVEL_##level, log_source, __LINE__, log_bucket, format, ##__VA_ARGS__); \ } while (0)

Parameters

level: Log level enum DOCA_LOG_LEVEL (just ERROR, WARNING...).
format: printf(3) arguments, format and variables.
...

#define DOCA_LOG_RATE_LIMIT_CRIT ( format, ... )

Value

DOCA_LOG_RATE_LIMIT(CRIT, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_LOG_RATE_LIMIT_DBG ( format, ... )

Value

DOCA_LOG_RATE_LIMIT(DEBUG, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_LOG_RATE_LIMIT_ERR ( format, ... )

Value

DOCA_LOG_RATE_LIMIT(ERROR, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_LOG_RATE_LIMIT_INFO ( format, ... )

Value

DOCA_LOG_RATE_LIMIT(INFO, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_LOG_RATE_LIMIT_WARN ( format, ... )

Value

DOCA_LOG_RATE_LIMIT(WARNING, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

#define DOCA_LOG_WARN ( format, ... )

Will generate warning log. This call affects the performace. Consider using DOCA_DLOG for the option to remove it on the final compilation.

Value

DOCA_LOG(WARNING, format, ##__VA_ARGS__)

Parameters

format: printf(3) arguments, format and variables.
...

Typedefs

void ( *log_flush_callback )( char* buffer )

logging backend flush() handler

Enumerations

enum doca_log_level

Values

DOCA_LOG_LEVEL_CRIT = 20: Critical log level
DOCA_LOG_LEVEL_ERROR = 30: Error log level
DOCA_LOG_LEVEL_WARNING = 40: Warning log level
DOCA_LOG_LEVEL_INFO = 50: Info log level
DOCA_LOG_LEVEL_DEBUG = 60: Debug log level

Functions

doca_error_t doca_log ( uint32_t level, int source, int line, const char* format, ... )

Generates a log message.

Parameters

level: Log level enum DOCA_LOG_LEVEL.
source: The log source identifier defined by doca_log_source_register.
line: The line number this log originated from.
format: printf(3) arguments, format and variables.

Returns

DOCA error code.

Description

This should not be used, please prefer using DOCA_LOG...

doca_error_t doca_log_backend_level_set ( doca_logger_backend* logger, uint32_t level )

Set the log level of a specific logger backend.

Parameters

logger: Logger backend to update.
level: Log level enum DOCA_LOG_LEVEL.

Returns

DOCA error code.

Description

Dynamically change the log level of the given logger backend, any log under this level will be shown.

doca_error_t doca_log_backend_set_lower_level_immutable ( doca_logger_backend* logger )

Mark the lower log level limit of a specific logger backend as immutable.

Parameters

logger: Logger backend to update.

Returns

DOCA error code.

Description

Mark the lower log level limit of a specific logger backend as immutable, preventing it from being changed by any future log level changes, both global and direct.

doca_error_t doca_log_backend_set_upper_level_immutable ( doca_logger_backend* logger )

Mark the upper log level limit of a specific logger backend as immutable.

Parameters

logger: Logger backend to update.

Returns

DOCA error code.

Description

Mark the upper log level limit of a specific logger backend as immutable, preventing it from being changed by any future log level changes, both global and direct.

doca_error_t doca_log_backend_set_upper_level_limit ( doca_logger_backend* logger, uint32_t upper_level_limit )

Set the upper log level limit of a specific logger backend.

Parameters

logger: Logger backend to update.
upper_level_limit: Log level enum DOCA_LOG_LEVEL.

Returns

DOCA error code.

Description

Dynamically change the upper log level limit of the given logger backend, any log above this level will not be shown.

doca_error_t doca_log_create_buffer_backend ( char* buffer, size_t capacity, log_flush_callback handler, doca_logger_backend** backend )

Create a logging backend with a char buffer stream.

Parameters

buffer: The char buffer (char *) for the logger's stream.
capacity: Maximal amount of chars that could be written to the stream.
handler: Handler to be called when the log record should be flushed from the stream.
backend: Logging backend that wraps the given buffer (only valid if no error occurred).

Returns

DOCA error code.

Description

Creates a new logging backend. The logger will write each log record at the beginning of this buffer.

doca_error_t doca_log_create_fd_backend ( int fd, doca_logger_backend** backend )

Create a logging backend with an fd stream.

Parameters

fd: The file descriptor (int) for the logger's backend.
backend: Logging backend that wraps the given fd (only valid if no error occurred).

Returns

DOCA error code.

Description

Creates a new logging backend.

doca_error_t doca_log_create_file_backend ( FILE* fptr, doca_logger_backend** backend )

Create a logging backend with a FILE* stream.

Parameters

fptr: The FILE * for the logger's stream.
backend: Logging backend that wraps the given fptr (only valid if no error occurred).

Returns

DOCA error code.

Description

Creates a new logging backend.

doca_error_t doca_log_create_standard_backend ( void )

Create default, non configurable backend.

Returns

DOCA error code.

Description

Creates a set of 2 backends: stdout shall print the range from global min level up to DOCA_LOG_LEVEL_INFO stderr shall print DOCA_LOG_LEVEL_WARNING - DOCA_LOG_LEVEL_CRIT

doca_error_t doca_log_create_syslog_backend ( const char* name, doca_logger_backend** backend )

Create a logging backend with a syslog output.

Parameters

name: The syslog name for the logger's backend.
backend: Logging backend that exposes the desired syslog functionality (only valid if no error occurred).

Returns

DOCA error code.

Description

Creates a new logging backend.

doca_error_tdoca_error_t __DOCA_EXPERIMENTAL doca_log_developer ( uint32_t level, int source, int line, const char* format, ... )

Generates a log message for DLOG operations.

Parameters

level: Log level enum DOCA_LOG_LEVEL.
source: The log source identifier defined by doca_log_source_register.
line: The line number this log originated from.
format: printf(3) arguments, format and variables.

Returns

DOCA error code.

Description

Note:

This function is thread safe.

__DOCA_EXPERIMENTAL uint16_t doca_log_get_bucket_time ( void )

Get the timespan of the rate-limit bucket.

Returns

Time (in seconds) of the rate-limit bucket.

Description

__DOCA_EXPERIMENTAL uint16_t doca_log_get_quantity ( void )

Get the quantity of the rate-limit bucket.

Returns

Maximal number of log events for a rate-limit bucket.

Description

__DOCA_EXPERIMENTAL uint32_t doca_log_global_level_get ( void )

Get the global log level.

Returns

Log level enum DOCA_LOG_LEVEL.

Description

Dynamically query for the global log level, any log under this level will be shown. The global level is used as the initial value when a new logger backend is created.

doca_error_t doca_log_global_level_set ( uint32_t level )

Set the log level of ALL logger backends.

Parameters

level: Log level enum DOCA_LOG_LEVEL.

Returns

DOCA error code.

Description

Dynamically change the log level of ALL the logger backends, any log under this level will be shown. Newly created logger backends will use this as their default log level.

doca_error_t doca_log_global_set_upper_level_limit ( uint32_t upper_level_limit )

Set the log upper level limit of ALL logger backends.

Parameters

upper_level_limit: Log level enum DOCA_LOG_LEVEL.

Returns

DOCA error code.

Description

Dynamically change the log upper level limit of ALL the logger backends, any log above this level will not be shown. Newly created logger backends will use this as their default upper log level limit.

doca_error_t doca_log_rate_bucket_register ( int source, int* bucket )

Parameters

source: The log source identifier defined by doca_log_source_register.
bucket: Bucket identifier that was allocated to this log source (only valid if no error occurred).

Returns

DOCA error code.

Description

Will return the identifier associated with the new bucket.

doca_error_tdoca_error_tdoca_error_t __DOCA_EXPERIMENTAL doca_log_rate_limit ( uint32_t level, int source, int line, int bucket, const char* format, ... )

Generates a log message with rate limit.

Parameters

level: Log level enum DOCA_LOG_LEVEL.
source: The log source identifier defined by doca_log_source_register.
line: The line number this log originated from.
bucket: The bucket identifier defined by doca_log_rate_bucket_register.
format: printf(3) arguments, format and variables.

Description

This should not be used, please prefer using DOCA_LOG_RATE_LIMIT...

__DOCA_EXPERIMENTAL void doca_log_set_bucket_time ( uint16_t bucket_time )

Set the timespan of the rate-limit bucket.

Parameters

bucket_time: Time (in seconds) for the rate-limit bucket.

Description

__DOCA_EXPERIMENTAL void doca_log_set_quantity ( uint16_t quantity )

Set the quantity of the rate-limit bucket.

Parameters

quantity: Maximal number of log events for a rate-limit bucket.

Description

doca_error_t doca_log_source_destroy ( int source )

Destroy a log source.

Parameters

source: The source identifier of source to be destroyed, as allocated by doca_log_source_register.

Returns

DOCA error code.

Description

Destroys a given log source as part of the teardown process of the running program.

Note:

Used automatically via DOCA_LOG_REGISTER, not recommended to call it directly.

doca_error_t doca_log_source_register ( const char* source_name, int* source )

Parameters

source_name: The string identifying the log source. Should be in an heirarchic form (i.e. DPI::Parser).
source: Source identifier that was allocated to this log source name (only valid if no error occurred).

Returns

DOCA error code.

Description

Will return the identifier associated with the log source. Log source name will be shown in the logs.

Note:

Recommended to only be used via DOCA_LOG_REGISTER.

2.25. PCC Host

DOCA PCC Host library. For more details please refer to the user guide on DOCA devzone.

Enumerations

enum doca_pcc_process_state_t: Process states.

Functions

doca_error_t doca_devinfo_get_is_pcc_supported ( const doca_devinfo* devinfo ): Get whether the DOCA device supports PCC.
doca_error_t doca_pcc_create ( doca_dev* doca_dev, doca_pcc** pcc ): Create PCC context.
doca_error_t doca_pcc_destroy ( doca_pcc* pcc ): Destroy a DOCA PCC context.
doca_error_t doca_pcc_get_max_num_threads ( doca_pcc* pcc, uint32_t* max_num_threads ): Get a maximal allowed number of threads handling CC events.
doca_error_t doca_pcc_get_min_num_threads ( doca_pcc* pcc, uint32_t* min_num_threads ): Get a minimal required number of threads handling CC events.
doca_error_t doca_pcc_get_process_state ( const doca_pcc* pcc, doca_pcc_process_state_t* process_state ): Return the state of the process.
doca_error_t doca_pcc_set_app ( doca_pcc* pcc, doca_pcc_app* app ): Set program app for PCC context.
doca_error_t doca_pcc_set_thread_affinity ( doca_pcc* pcc, uint32_t num_threads, uint32_t* affinity_configs ): Configure affinity of threads handling CC events.
doca_error_t doca_pcc_start ( doca_pcc* pcc ): Start a PCC context Register the pcc process in the NIC hw.
doca_error_t doca_pcc_stop ( doca_pcc* pcc ): Stop a PCC context.
doca_error_t doca_pcc_wait ( doca_pcc* pcc, int wait_time ): Wait on events or timeout from device for given time in seconds.

Enumerations

enum doca_pcc_process_state_t

Values

DOCA_PCC_PS_ACTIVE = 0: The process handles CC events (only one process is active at a given time)
DOCA_PCC_PS_STANDBY = 1: The process is in standby mode (another process is already ACTIVE)
DOCA_PCC_PS_DEACTIVATED = 2: The process was deactivated by NIC FW and should be destroyed
DOCA_PCC_PS_ERROR = 3: The process is in error state and should be destroyed

Functions

doca_error_t doca_devinfo_get_is_pcc_supported ( const doca_devinfo* devinfo )

Get whether the DOCA device supports PCC.

Parameters

devinfo: - The device to query

Returns

DOCA_SUCCESS - in case of the DOCA device quered has PCC support Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input
DOCA_ERROR_NOT_SUPPORTED - the device quered does not support PCC

Description

doca_error_t doca_pcc_create ( doca_dev* doca_dev, doca_pcc** pcc )

Create PCC context.

Parameters

doca_dev: - DOCA device
pcc: - Created PCC context

Returns

DOCA_SUCCESS - in case of success doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input
DOCA_ERROR_DRIVER - in case of error in a DOCA driver call
DOCA_ERROR_NOT_SUPPORTED - the device does not support PCC
DOCA_ERROR_NO_MEMORY - in case of failure in internal memory allocation

Description

This function creates a DOCA PCC context given a DOCA device to capture and route PCC events to the DPA.

doca_error_t doca_pcc_destroy ( doca_pcc* pcc )

Destroy a DOCA PCC context.

Parameters

pcc: - Previously created PCC context

Returns

DOCA_SUCCESS - in case of success doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input
DOCA_ERROR_DRIVER - in case of error in a DOCA driver call

Description

This function destroys PCC context created by doca_pcc_create() When the termination is started the process will stop handling PCC events. Issueing a ^c during doca_pcc_wait(...) will also result in the application's termination.

doca_error_t doca_pcc_get_max_num_threads ( doca_pcc* pcc, uint32_t* max_num_threads )

Get a maximal allowed number of threads handling CC events.

Parameters

pcc: - PCC context
max_num_threads: - maximal number of threads used by pcc

Returns

DOCA_SUCCESS - in case of success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid NULL input

Description

doca_error_t doca_pcc_get_min_num_threads ( doca_pcc* pcc, uint32_t* min_num_threads )

Get a minimal required number of threads handling CC events.

Parameters

pcc: - PCC context
min_num_threads: - minimal number of threads used by pcc

Returns

DOCA_SUCCESS - in case of success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid NULL input

Description

doca_error_t doca_pcc_get_process_state ( const doca_pcc* pcc, doca_pcc_process_state_t* process_state )

Return the state of the process.

Parameters

pcc: - PCC context
process_state: - state of the PCC process. In case positive wait_time is specified and expired, DEACTIVATED state will be returned.

Returns

DOCA_SUCCESS - in case of success doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input

Description

doca_error_t doca_pcc_set_app ( doca_pcc* pcc, doca_pcc_app* app )

Set program app for PCC context.

Parameters

pcc: - PCC context
app: - PCC application generated by DPACC

Returns

DOCA_SUCCESS - in case of success doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input
DOCA_ERROR_BAD_STATE - if PCC context is already started

Description

The context represents a program on the DPA that is referenced by the host process that called the context creation API. Must be set before calling doca_pcc_start()

doca_error_t doca_pcc_set_thread_affinity ( doca_pcc* pcc, uint32_t num_threads, uint32_t* affinity_configs )

Configure affinity of threads handling CC events.

Parameters

pcc: - PCC context
num_threads: - number of threads used by pcc. Should be constarined by minimum and maximum allowed number (see doca_pcc_get_min_num_threads and doca_pcc_get_max_num_threads)
affinity_configs: - array of indexes to assign to threads

Returns

DOCA_SUCCESS - in case of success doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid null input or invalid number of threads
DOCA_ERROR_BAD_STATE - if PCC context is already started

Description

Must be set before calling doca_pcc_start()

doca_error_t doca_pcc_start ( doca_pcc* pcc )

Start a PCC context Register the pcc process in the NIC hw.

Parameters

pcc: - PCC context

Returns

DOCA_SUCCESS - in case of success doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input
DOCA_ERROR_DRIVER - in case of error in a DOCA driver call
DOCA_ERROR_NO_MEMORY - in case of failure in internal memory allocation

Description

doca_error_t doca_pcc_stop ( doca_pcc* pcc )

Stop a PCC context.

Parameters

pcc: - PCC context

Returns

DOCA_SUCCESS - in case of success doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input
DOCA_ERROR_DRIVER - in case of error in a DOCA driver call
DOCA_ERROR_BAD_STATE - in case pcc is not started

Description

doca_error_t doca_pcc_wait ( doca_pcc* pcc, int wait_time )

Wait on events or timeout from device for given time in seconds.

Parameters

pcc: - PCC context
wait_time: - time in seconds to wait

Returns

DOCA_SUCCESS - in case of success doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input
DOCA_ERROR_BAD_STATE - in case pcc is not started

Description

Providing a negative value for wait time will cause the context to wait on events until the user terminates it.

2.26. PCC Device

DOCA PCC Device library. For more details please refer to the user guide on DOCA devzone.

Defines

#define DOCA_DPA_DEVICE: declares that we are compiling for the DPA Device

Functions

void doca_pcc_dev_default_internal_algo ( doca_pcc_dev_algo_ctxt_t* algo_ctxt, doca_pcc_dev_event_t* event, const doca_pcc_dev_attr_t* attr, doca_pcc_dev_results_t* results ): Implements the internal CC algorithm provided by the lib.
void doca_pcc_dev_printf ( const char* format, ... ): Print to Host.
void doca_pcc_dev_user_algo ( doca_pcc_dev_algo_ctxt_t* algo_ctxt, doca_pcc_dev_event_t* event, const doca_pcc_dev_attr_t* attr, doca_pcc_dev_results_t* results ): Entry point to the user algorithm handling code.
void doca_pcc_dev_user_init ( uint32_t* disable_event_bitmask ): Entry point to the user one time initialization code.
doca_pcc_dev_error_t doca_pcc_dev_user_set_algo_params ( uint32_t port_num, uint32_t algo_slot, uint32_t param_id_base, uint32_t param_num, const uint32_t* new_param_values, uint32_t* params ): User callback executed then parameters are set.

Defines

#define DOCA_DPA_DEVICE: Note:

Must be defined before the first API use/include of DOCA

Functions

void doca_pcc_dev_default_internal_algo ( doca_pcc_dev_algo_ctxt_t* algo_ctxt, doca_pcc_dev_event_t* event, const doca_pcc_dev_attr_t* attr, doca_pcc_dev_results_t* results )

Implements the internal CC algorithm provided by the lib.

Parameters

algo_ctxt: -
event: -
attr: -
results: -

Description

The lib provides an internal built-in CC algorithm implementation. The user may call this function for flows with algo_slot that is not set by the user (An unknown algo_slot can be the result of running without algo negotiation)

See also:

doca_pcc_dev_user_algo

See also:

doca_pcc_dev_user_algo

See also:

doca_pcc_dev_user_algo

See also:

doca_pcc_dev_user_algo

void doca_pcc_dev_printf ( const char* format, ... )

Print to Host.

Parameters

format: - Format string that contains the text to be written to stdout (same as from regular printf)

Description

This function prints from device to host's standard output stream. Multiple threads may call this routine simultaneously. Printing is a convenience service, and due to limited buffering on the host, not all print statements may appear on the host

void doca_pcc_dev_user_algo ( doca_pcc_dev_algo_ctxt_t* algo_ctxt, doca_pcc_dev_event_t* event, const doca_pcc_dev_attr_t* attr, doca_pcc_dev_results_t* results )

Entry point to the user algorithm handling code.

Parameters

algo_ctxt: - pointer to user context for this flow (restored from previous iteration)
event: - pointer to event data struct to be used with getter functions
attr: - information about event like algo type
results: - new rate information to be writen to HW. The rate is expressed as a 20b fixed point number in range (0 , 1]

Description

This code handles a single event. it recieves the alorithm context, the event information (opaque struct), and some attributes (algo id), and returns the PCC rate The event info should not be used directly through the struct. It is recomended to use the supplied "getter" functions (doca_pcc_dev_event.h) to help generate more future compatible code if event information placement changes

void doca_pcc_dev_user_init ( uint32_t* disable_event_bitmask )

Entry point to the user one time initialization code.

Parameters

disable_event_bitmask: - a bitmaks of events that should be discarded and not passed to the event processing code

Description

This is called on PCC process load and should initialize the data of all user algorithms.

doca_pcc_dev_error_t doca_pcc_dev_user_set_algo_params ( uint32_t port_num, uint32_t algo_slot, uint32_t param_id_base, uint32_t param_num, const uint32_t* new_param_values, uint32_t* params )

User callback executed then parameters are set.

Parameters

port_num: - index of the port
algo_slot: - Algo slot identifier as reffered to in the PPCC command field "algo_slot" if possible it should be equal to the algo_idx
param_id_base: - id of the first parameter that was changed.
param_num: - number of all parameters that were changed
new_param_values: - pointer to an array which holds param_num number of new values for parameters
params: - pointer to an array which holds beginning of the current parameters to be changed

Returns

- DOCA_PCC_DEV_STATUS_OK: Parameters were set DOCA_PCC_DEV_STATUS_FAIL: the values (one or more) are not legal. No parameters were changed

Description

Called when the parameter change was set externally. The implementation should: Check the given new_parameters values. If those are correct from the algorithm perspective, assign them to the given parameter array.

2.27. PCC Device Algo Access

Classes

struct doca_pcc_dev_algo_meta_data: This struct provides meta data for a pcc user algo.

Functions

doca_pcc_dev_error_t doca_pcc_dev_algo_init_counter ( uint32_t algo_idx, uint32_t counter_id, uint32_t max_value, uint32_t permissions, uint32_t counter_desc_size, uint64_t counter_desc_addr ): Initialize a single counter for an algo.
doca_pcc_dev_error_t doca_pcc_dev_algo_init_metadata ( uint32_t algo_idx, const doca_pcc_dev_algo_meta_data* user_def, uint32_t param_num, uint32_t counter_num ): Initialize the algo database.
doca_pcc_dev_error_t doca_pcc_dev_algo_init_param ( uint32_t algo_idx, uint32_t param_id, uint32_t default_value, uint32_t max_value, uint32_t min_value, uint32_t permissions, uint32_t param_desc_size, uint64_t param_desc_addr ): Initialize a single parameter for an algo.
uint32_t doca_pcc_dev_get_algo_index ( uint32_t port_num, uint32_t algo_slot ): Get identifier of a specific algo and specific port.
uint32_t* doca_pcc_dev_get_algo_params ( uint32_t port_num, uint32_t algo_slot ): Get pointer to param array of a specific algo and specific port.
uint32_t doca_pcc_dev_get_algo_params_num ( uint32_t port_num, uint32_t algo_slot ): Get number of params supported per algo on the port.
uint32_t* doca_pcc_dev_get_counters ( uint32_t port_num, uint32_t algo_slot ): Get pointer to counter array of a specific algo and specific port.
uint32_t doca_pcc_dev_get_counters_num ( uint32_t port_num, uint32_t algo_slot ): Get number of counters supported per algo on the port.
doca_pcc_dev_error_t doca_pcc_dev_init_algo_slot ( uint32_t portid, uint32_t algo_slot, uint32_t algo_idx, uint32_t algo_en ): Initialize the algo per port database.

Variables

uint64_t doca_pcc_dev_algo_meta_data::algo_desc_addr
uint32_t doca_pcc_dev_algo_meta_data::algo_desc_size
uint32_t doca_pcc_dev_algo_meta_data::algo_major_version
uint32_t doca_pcc_dev_algo_meta_data::algo_minor_version

Functions

doca_pcc_dev_error_t doca_pcc_dev_algo_init_counter ( uint32_t algo_idx, uint32_t counter_id, uint32_t max_value, uint32_t permissions, uint32_t counter_desc_size, uint64_t counter_desc_addr )

Initialize a single counter for an algo.

Parameters

algo_idx: - Algo identifier.
counter_id: - counter id (from 0 to doca_pcc_dev_algo_init_metadata(...).counter_num)
max_value: - max value that allowed for the counter.
permissions: - If 1 allows value update, if 0 update is disabled.
counter_desc_size
counter_desc_addr

Returns

DOCA_PCC_DEV_STATUS_FAIL if input parameters are out of range.

Description

This function initializes a single counter (counterid) for a specific algo (algo_idx) The counter_id should be in the bounds declared by doca_pcc_dev_algo_init_metadata(...) The counter info (e.g. decription) is "global" to the algo on all ports.

doca_pcc_dev_error_t doca_pcc_dev_algo_init_metadata ( uint32_t algo_idx, const doca_pcc_dev_algo_meta_data* user_def, uint32_t param_num, uint32_t counter_num )

Initialize the algo database.

Parameters

algo_idx: - algo index.
user_def: - basic version info + pointer and size of algo descrption string
param_num: - max number of params (will be used to reserve param space)
counter_num: - max number of counters (will be used to reserve counter space)

Returns

DOCA_PCC_DEV_STATUS_FAIL if input parameters are out of range.

Description

This function initializes an algo datastructure. Each algorithm has in index (not to be confused with the doca_pcc_dev_algo_meta_data::algo_id) Algo database includes a metadata area containing basic algo information, and a params and counters metadata area. The number of parameters and counters is configurable at init time. The space allocated for the algo datastructure using this function is visible to the PCC infrastructure. This is required to allow the infrastructure to read/update param / counter information directly when handling PPCC MADs or commands. The user can use additional memory by allocating global variables

This function should be called once per algo during init.

doca_pcc_dev_error_t doca_pcc_dev_algo_init_param ( uint32_t algo_idx, uint32_t param_id, uint32_t default_value, uint32_t max_value, uint32_t min_value, uint32_t permissions, uint32_t param_desc_size, uint64_t param_desc_addr )

Initialize a single parameter for an algo.

Parameters

algo_idx: - Algo index.
param_id: - parameter id (from 0 to doca_pcc_dev_algo_init_metadata(...).param_num)
default_value: - base value.
max_value: - max value that is inforced by set function.
min_value: - min value that is inforced by set function..
permissions: - If 1 allows value update, if 0 update is disabled.
param_desc_size: - The size in bytes for the parameter descriptor string field
param_desc_addr: - A pointer to the parameter descriptor string field.

Returns

DOCA_PCC_DEV_STATUS_FAIL if input parameters are out of range.

Description

This function initializes a single parameter (param_id) for a specific algo (algo_idx) The param_id should be in the bounds declared by doca_pcc_dev_algo_init_metadata(...) The paran info is "global" to the algo on all ports. The current value of the param that is initialized to the "default" value can be modified at the port level.

uint32_t doca_pcc_dev_get_algo_index ( uint32_t port_num, uint32_t algo_slot )

Get identifier of a specific algo and specific port.

Parameters

port_num
algo_slot: - Algo slot identifier as reffered to in the PPCC command field "algo_slot"

Returns

Algo identifier.

Description

uint32_t* doca_pcc_dev_get_algo_params ( uint32_t port_num, uint32_t algo_slot )

Get pointer to param array of a specific algo and specific port.

Parameters

port_num
algo_slot: - Algo slot identifier as reffered to in the PPCC command field "algo_slot"

Returns

array of 32b parameters

Description

This retieves the pointer to an array of param (current value) of up to doca_pcc_dev_get_algo_params_num() params used by algo_slot on the port

uint32_t doca_pcc_dev_get_algo_params_num ( uint32_t port_num, uint32_t algo_slot )

Get number of params supported per algo on the port.

Parameters

port_num
algo_slot: - Algo slot identifier as reffered to in the PPCC command field "algo_slot"

Returns

number of supported params

Description

uint32_t* doca_pcc_dev_get_counters ( uint32_t port_num, uint32_t algo_slot )

Get pointer to counter array of a specific algo and specific port.

Parameters

port_num
algo_slot: - Algo slot identifier as reffered to in the PPCC command field "algo_slot"

Returns

array of 32b counters

Description

This retieves the pointer to an array of counters (up to doca_pcc_dev_get_counters_num(...) counters) used by algo_slot on the port

uint32_t doca_pcc_dev_get_counters_num ( uint32_t port_num, uint32_t algo_slot )

Get number of counters supported per algo on the port.

Parameters

port_num
algo_slot: - Algo slot identifier as reffered to in the PPCC command field "algo_slot"

Returns

number of supported counters

Description

doca_pcc_dev_error_t doca_pcc_dev_init_algo_slot ( uint32_t portid, uint32_t algo_slot, uint32_t algo_idx, uint32_t algo_en )

Initialize the algo per port database.

Parameters

portid: - port to be initialized
algo_slot: - Algo slot identifier as reffered to in the PPCC command field "algo_slot" if possible it should be equal to the algo_idx
algo_idx: - Algo identifier.
algo_en: - 1 mark algo as enabled, if 0 algo will not be reported if queried

Returns

DOCA_PCC_DEV_STATUS_FAIL if input parameters are out of range.

Description

This function initializes the algo per port parameter database, and maps an algo_idx (global algo index) to a specific slot per port. This function allocates parameters and counters per port. The default parameters values are taked from the algo metadata set by doca_pcc_dev_algo_init_param() . The counters and parameters can be get/set by the infrastructure based on MAD and access register PPCC command Function MUST be called after calls to doca_pcc_dev_algo_init_param for this algo type

Variables

uint64_t doca_pcc_dev_algo_meta_data::algo_desc_addr

pointer to description string

uint32_t doca_pcc_dev_algo_meta_data::algo_desc_size

size of description string (null terminated)

uint32_t doca_pcc_dev_algo_meta_data::algo_major_version

algo major version

uint32_t doca_pcc_dev_algo_meta_data::algo_minor_version

algo minor version

2.28. PCC Device

DOCA PCC Device library. For more details please refer to the user guide on DOCA devzone.

Defines

#define DOCA_PCC_DEV_ALGO_INDEX_INTERNAL (0xF): Reserved algo index for internal algo provided by the lib.
#define DOCA_PCC_DEV_ALGO_SLOT_INTERNAL (0xF): Reserved algo slot for internal algo provided by the lib.
#define DOCA_PCC_DEV_DEFAULT_RATE: Default rate. The user overrides teh default in the user algo function.
#define DOCA_PCC_DEV_LOG_MAX_RATE (20): defines the fixed point fraction size of the rate limiter
#define DOCA_PCC_DEV_MAX_NUM_ALGOS (8): Max number of algos supported by the lib.
#define DOCA_PCC_DEV_MAX_NUM_COUNTERS_PER_ALGO (0xF): Max number of counters per algo supported by the lib.
#define DOCA_PCC_DEV_MAX_NUM_PARAMS_PER_ALGO (0x1E): Max number of paramaters per algo supported by the lib.
#define DOCA_PCC_DEV_MAX_NUM_PORTS (4): Max number of NIC ports supported by the lib.
#define DOCA_PCC_DEV_MAX_NUM_USER_SLOTS (8): Max number of algo slots supported by the lib.
#define DOCA_PCC_DEV_MAX_RATE: Max rate in rate limiter fixed point.
#define DOCA_PCC_DEV_TX_FLAG_ACK_EXPECTED (1 << 0): TX Flag: Ack expected.
#define DOCA_PCC_DEV_TX_FLAG_OVERLOADED (1 << 1): TX Flag: Overloaded:.
#define DOCA_PCC_DEV_TX_FLAG_RTT_REQ_SENT (1 << 2): TX Flag: RTT packer sent.
#define FORCE_INLINE: static inline wrapper
#define doca_pcc_dev_fence_all ( ): fence all
#define doca_pcc_dev_fence_io ( ): fence io operations
#define doca_pcc_dev_fence_memory ( ): fence memory operations
#define doca_pcc_dev_fence_w_r ( ): fence w/r
#define doca_pcc_dev_fls ( a ) (32 - __builtin_clz(a)): 32b find last set
#define doca_pcc_dev_fxp_log2 ( a_fp ) __dpa_fxp_log2(a_fp): fixed point 16b log 2
#define doca_pcc_dev_fxp_mult ( a, b ): fixed point 16b mult
#define doca_pcc_dev_fxp_power2 ( a_fp ) __dpa_fxp_pow2(a_fp): fixed point 16b power of 2
#define doca_pcc_dev_fxp_recip ( a_fp ) __dpa_fxp_rcp(a_fp): fixed point 16b reciprocal
#define doca_pcc_dev_get_thread_time ( ) __dpa_thread_time(): return 1usec tick count
#define doca_pcc_dev_mult ( a, b ): mult wrapper

Enumerations

enum doca_pcc_dev_error_t: API functions return status.
enum doca_pcc_dev_event_type_enum: CC event type.
enum doca_pcc_dev_nack_event_sub_type_enum: CC Nack event subtypes.

Defines

#define DOCA_PCC_DEV_ALGO_INDEX_INTERNAL (0xF)

#define DOCA_PCC_DEV_ALGO_SLOT_INTERNAL (0xF)

#define DOCA_PCC_DEV_DEFAULT_RATE

Value

((DOCA_PCC_DEV_MAX_RATE >> 8) > (1) ? \ (DOCA_PCC_DEV_MAX_RATE >> 8) : (1))

#define DOCA_PCC_DEV_LOG_MAX_RATE (20)

#define DOCA_PCC_DEV_MAX_NUM_ALGOS (8)

#define DOCA_PCC_DEV_MAX_NUM_COUNTERS_PER_ALGO (0xF)

#define DOCA_PCC_DEV_MAX_NUM_PARAMS_PER_ALGO (0x1E)

#define DOCA_PCC_DEV_MAX_NUM_PORTS (4)

#define DOCA_PCC_DEV_MAX_NUM_USER_SLOTS (8)

#define DOCA_PCC_DEV_MAX_RATE

Value

(1U << DOCA_PCC_DEV_LOG_MAX_RATE)

#define DOCA_PCC_DEV_TX_FLAG_ACK_EXPECTED (1 << 0)

#define DOCA_PCC_DEV_TX_FLAG_OVERLOADED (1 << 1)

#define DOCA_PCC_DEV_TX_FLAG_RTT_REQ_SENT (1 << 2)

#define FORCE_INLINE

Value

static inline __attribute__((always_inline))

#define doca_pcc_dev_fence_all ( )

Value

__dpa_thread_fence(__DPA_SYSTEM, __DPA_RW, __DPA_RW)

#define doca_pcc_dev_fence_io ( )

Value

__dpa_thread_fence(__DPA_MMIO, __DPA_RW, __DPA_RW)

#define doca_pcc_dev_fence_memory ( )

Value

__dpa_thread_fence(__DPA_MEMORY, __DPA_RW, __DPA_RW)

#define doca_pcc_dev_fence_w_r ( )

Value

__dpa_thread_fence(__DPA_MEMORY, __DPA_W, __DPA_R)

#define doca_pcc_dev_fls ( a ) (32 - __builtin_clz(a))

#define doca_pcc_dev_fxp_log2 ( a_fp ) __dpa_fxp_log2(a_fp)

#define doca_pcc_dev_fxp_mult ( a, b )

Value

((uint32_t)((doca_pcc_dev_mult((a), (b)) >> 16) & 0xffffffff))

#define doca_pcc_dev_fxp_power2 ( a_fp ) __dpa_fxp_pow2(a_fp)

#define doca_pcc_dev_fxp_recip ( a_fp ) __dpa_fxp_rcp(a_fp)

#define doca_pcc_dev_get_thread_time ( ) __dpa_thread_time()

#define doca_pcc_dev_mult ( a, b )

Value

((uint64_t)(a) * (uint64_t)(b))

Enumerations

enum doca_pcc_dev_error_t

Values

DOCA_PCC_DEV_STATUS_OK = 0
DOCA_PCC_DEV_STATUS_FAIL = 1

enum doca_pcc_dev_event_type_enum

Values

DOCA_PCC_DEV_EVNT_NULL = 0
DOCA_PCC_DEV_EVNT_FW = 1
DOCA_PCC_DEV_EVNT_ROCE_CNP = 2
DOCA_PCC_DEV_EVNT_ROCE_TX = 3
DOCA_PCC_DEV_EVNT_ROCE_ACK = 4
DOCA_PCC_DEV_EVNT_ROCE_NACK = 5
DOCA_PCC_DEV_EVNT_RTT = 6

enum doca_pcc_dev_nack_event_sub_type_enum

Values

DOCA_PCC_DEV_NACK_EVNT_NULL = 0
DOCA_PCC_DEV_NACK_EVNT_RNR = 1
DOCA_PCC_DEV_NACK_EVNT_OOS = 2
DOCA_PCC_DEV_NACK_EVNT_DUP_READ = 3

2.29. PCC Device Data Structure Little Endian

2.30. PCC Device Data Structures

2.31. PCC Device Event

Functions

FORCE_INLINE doca_pcc_dev_ack_nack_cnp_extra_t doca_pcc_dev_get_ack_nack_cnp_extra ( doca_pcc_dev_event_t* event ): For ACK/NACK/CNP events, extra information including number of coalesced events.
FORCE_INLINE doca_pcc_dev_event_general_attr_t doca_pcc_dev_get_ev_attr ( doca_pcc_dev_event_t* event ): For all events, return structure with general information such as event type, subtype, port and flags.
FORCE_INLINE uint32_t doca_pcc_dev_get_flowtag ( doca_pcc_dev_event_t* event ): For all events, flow tag to indicate different flows.
FORCE_INLINE uint32_t doca_pcc_dev_get_fw_settings ( doca_pcc_dev_event_t* event, int n ): For FW events only, three DWORDs of FW data.
FORCE_INLINE uint32_t doca_pcc_dev_get_roce_ack_first_sn ( doca_pcc_dev_event_t* event ): For ACK/NACK/CNP events, first coalesced event serial number.
FORCE_INLINE uint32_t doca_pcc_dev_get_roce_first_timestamp ( doca_pcc_dev_event_t* event ): For TX/ACK/NACK/CNP events, first coalesced event timestamp.
FORCE_INLINE doca_pcc_dev_roce_tx_cntrs_t doca_pcc_dev_get_roce_tx_cntrs ( doca_pcc_dev_event_t* event ): For TX events only, counters including byte count and packet count.
FORCE_INLINE uint32_t doca_pcc_dev_get_rtt_req_recv_timestamp ( doca_pcc_dev_event_t* event ): For RTT events only, the time when RTT request is received.
FORCE_INLINE uint32_t doca_pcc_dev_get_rtt_req_send_timestamp ( doca_pcc_dev_event_t* event ): For RTT events only, the time when RTT request is sent.
FORCE_INLINE uint32_t doca_pcc_dev_get_rtt_resp_send_timestamp ( doca_pcc_dev_event_t* event ): For RTT events only, the time when RTT response is sent.
FORCE_INLINE uint32_t doca_pcc_dev_get_sn ( doca_pcc_dev_event_t* event ): For all events, serial number of this event.
FORCE_INLINE uint64_t doca_pcc_dev_get_timer ( void ): Core timer access (elapsed time in uSec) function 64 bits.
FORCE_INLINE uint32_t doca_pcc_dev_get_timer_lo ( void ): Core timer access (elapsed time in uSec) function 32 bits.
FORCE_INLINE uint32_t doca_pcc_dev_get_timestamp ( doca_pcc_dev_event_t* event ): For all events, timestamp of this event.

Functions

FORCE_INLINE doca_pcc_dev_ack_nack_cnp_extra_t doca_pcc_dev_get_ack_nack_cnp_extra ( doca_pcc_dev_event_t* event )

For ACK/NACK/CNP events, extra information including number of coalesced events.

Parameters

event: - pointer to opaque event struct

Returns

pcc_ack_nack_cnp_extra_t

Description

FORCE_INLINE doca_pcc_dev_event_general_attr_t doca_pcc_dev_get_ev_attr ( doca_pcc_dev_event_t* event )

For all events, return structure with general information such as event type, subtype, port and flags.

Parameters

event: - pointer to opaque event struct

Returns

doca_pcc_dev_event_general_attr_t

Description

FORCE_INLINE uint32_t doca_pcc_dev_get_flowtag ( doca_pcc_dev_event_t* event )

For all events, flow tag to indicate different flows.

Parameters

event: - pointer to opaque event structs

Returns

32 bit flow_tag

Description

FORCE_INLINE uint32_t doca_pcc_dev_get_fw_settings ( doca_pcc_dev_event_t* event, int n )

For FW events only, three DWORDs of FW data.

Parameters

event: - pointer to opaque event struct
n: - dword index 0..2

Returns

32 bit DWORD information from FW

Description

FORCE_INLINE uint32_t doca_pcc_dev_get_roce_ack_first_sn ( doca_pcc_dev_event_t* event )

For ACK/NACK/CNP events, first coalesced event serial number.

Parameters

event: - pointer to opaque event struct

Returns

32 bit first serial number

Description

FORCE_INLINE uint32_t doca_pcc_dev_get_roce_first_timestamp ( doca_pcc_dev_event_t* event )

For TX/ACK/NACK/CNP events, first coalesced event timestamp.

Parameters

event: - pointer to opaque event struct

Returns

32 bit first time stamp (1 nSec granularity)

Description

FORCE_INLINE doca_pcc_dev_roce_tx_cntrs_t doca_pcc_dev_get_roce_tx_cntrs ( doca_pcc_dev_event_t* event )

For TX events only, counters including byte count and packet count.

Parameters

event: - pointer to opaque event struct

Returns

pcc_roce_tx_cntrs_t

Description

FORCE_INLINE uint32_t doca_pcc_dev_get_rtt_req_recv_timestamp ( doca_pcc_dev_event_t* event )

For RTT events only, the time when RTT request is received.

Parameters

event: - pointer to opaque event struct

Returns

time stamp in 1 nSec

Description

FORCE_INLINE uint32_t doca_pcc_dev_get_rtt_req_send_timestamp ( doca_pcc_dev_event_t* event )

For RTT events only, the time when RTT request is sent.

Parameters

event: - pointer to opaque event struct

Returns

time stamp in 1 nSec

Description

FORCE_INLINE uint32_t doca_pcc_dev_get_rtt_resp_send_timestamp ( doca_pcc_dev_event_t* event )

For RTT events only, the time when RTT response is sent.

Parameters

event: - pointer to opaque event struct

Returns

time stamp in 1 nSec

Description

FORCE_INLINE uint32_t doca_pcc_dev_get_sn ( doca_pcc_dev_event_t* event )

For all events, serial number of this event.

Parameters

event: - pointer to opaque event struct

Returns

32 bit sn

Description

FORCE_INLINE uint64_t doca_pcc_dev_get_timer ( void )

Core timer access (elapsed time in uSec) function 64 bits.

Returns

time in uSec.

Description

FORCE_INLINE uint32_t doca_pcc_dev_get_timer_lo ( void )

Core timer access (elapsed time in uSec) function 32 bits.

Returns

time in uSec.

Description

FORCE_INLINE uint32_t doca_pcc_dev_get_timestamp ( doca_pcc_dev_event_t* event )

For all events, timestamp of this event.

Parameters

event: - pointer to opaque event struct

Returns

32 bit time stamp (1 nSec granularity)

Description

2.32. DOCA Remote Direct Memory Access

DOCA RDMA library. For more details please refer to the user guide on DOCA devzone.

Classes

struct doca_rdma_gid
struct doca_rdma_job_atomic
struct doca_rdma_job_read_write
struct doca_rdma_job_recv
struct doca_rdma_job_send
struct doca_rdma_result

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_rdma_as_ctx ( doca_rdma* rdma ): Convert doca_rdma instance into a generalised context for use with doca core objects.
doca_error_t doca_rdma_connect ( doca_rdma* rdma, const void* remote_rdma_conn_details, size_t remote_rdma_conn_details_size ): Connect to remote doca_rdma peer. Can only be called after calling doca_ctx_start().
doca_error_t doca_rdma_create ( doca_rdma** rdma ): Create a DOCA RDMA instance.
doca_error_t doca_rdma_destroy ( doca_rdma* rdma ): Destroy a DOCA RDMA instance.
doca_error_t doca_rdma_export ( const doca_rdma* rdma, const void** local_rdma_conn_details, size_t* local_rdma_conn_details_size ): Export doca_rdma connection details object The doca_rdma_conn_details are used in doca_rdma_connect(). Can only be called after calling doca_ctx_start().
doca_error_t doca_rdma_get_gid ( doca_devinfo* devinfo, uint32_t start_index, uint32_t num_entries, doca_rdma_gid* gid_array )
doca_error_t doca_rdma_get_gid_index ( const doca_rdma* rdma, uint32_t* gid_index ): Get GID index from doca_rdma. Get the current GID index set for doca_rdma.
doca_error_t doca_rdma_get_gid_table_size ( doca_devinfo* devinfo, uint32_t* gid_table_size )
doca_error_t doca_rdma_get_grh_enabled ( const doca_rdma* rdma, bool* grh_enabled ): Get GRH setting from doca_rdma. Get the current GRH setting for doca_rdma.
doca_error_t doca_rdma_get_max_buf_chain_len ( const doca_devinfo* devinfo, doca_rdma_job_types job_type, doca_rdma_transport_type transport_type, uint32_t* max_buf_chain_len )
doca_error_t doca_rdma_get_max_message_size ( const doca_devinfo* devinfo, uint32_t* max_message_size ): Get the maximal message size for a specific device.
doca_error_t doca_rdma_get_max_recv_queue_size ( const doca_devinfo* devinfo, uint32_t* max_recv_queue_size ): Get the maximal recv queue size for a specific device.
doca_error_t doca_rdma_get_max_send_queue_size ( const doca_devinfo* devinfo, uint32_t* max_send_queue_size )
doca_error_t doca_rdma_get_mtu ( const doca_rdma* rdma, doca_mtu_size ** mtu ): Get the MTU property from doca_rdma. Returns the current MTU set for the doca_rdma context.
doca_error_t doca_rdma_get_permissions ( doca_rdma* rdma, uint32_t* permissions ): Get permissions property from doca_rdma. Returns the current permissions set for the doca_rdma_context. Can only be called after calling doca_ctx_dev_add().
doca_error_t doca_rdma_get_recv_buf_chain_len ( const doca_rdma* rdma, uint32_t* recv_buf_chain_len ): Get the maximal receive buffer chain length from doca_rdma. Get the current receive buffer chain length set for doca_rdma. The returned value is the actual value being used and might differ from the size set by the user, as it may be increased.
doca_error_t doca_rdma_get_recv_queue_size ( const doca_rdma* rdma, uint32_t* recv_queue_size ): Get recv queue size property from doca_rdma. Returns the current recv_queue_size set for the doca_rdma_context. The size returned is the actual size being used and might differ from the size set by the user, as the size may be increased.
doca_error_t doca_rdma_get_send_queue_size ( const doca_rdma* rdma, uint32_t* send_queue_size ): Get send queue size property from doca_rdma. Returns the current send_queue_size set for the doca_rdma_context. The size returned is the actual size being used and might differ from the size set by the user, as the size may be increased.
doca_error_t doca_rdma_get_sl ( const doca_rdma* rdma, uint32_t* sl ): Get SL (service level) from doca_rdma. Get the current SL set for doca_rdma.
doca_error_t doca_rdma_get_state ( const doca_rdma* rdma, doca_rdma_state ** state ): Get current state of doca_rdma. Returns the current state of the doca_rdma_context.
doca_error_t doca_rdma_get_transport_type ( const doca_rdma* rdma, doca_rdma_transport_type ** transport_type ): Get transport_type property from doca_rdma. Returns the current transport_type set for the doca_rdma_context.
doca_error_t doca_rdma_get_transport_type_supported ( const doca_devinfo* devinfo, doca_rdma_transport_type transport_type ): Check if DOCA RDMA supports given transport type for a specific device.
doca_error_t doca_rdma_job_get_supported ( const doca_devinfo* devinfo, doca_rdma_job_types job_type ): Check if given device supports given doca_rdma job.
doca_error_t doca_rdma_set_gid_index ( doca_rdma* rdma, uint32_t gid_index ): Set GID index for doca_rdma. The value can be queried using doca_rdma_get_gid_index(). Can only be called before calling doca_ctx_start().
doca_error_t doca_rdma_set_grh_enabled ( doca_rdma* rdma, bool grh_enabled ): Set whether to use GRH in connection. The value can be queried using doca_rdma_get_grh_enabled(). Can only be called before calling doca_ctx_start().
doca_error_t doca_rdma_set_mtu ( doca_rdma* rdma, doca_mtu_size mtu ): Set MTU for doca_rdma. The value can be queried using doca_rdma_get_mtu(). Can only be called before calling doca_ctx_start().
doca_error_t doca_rdma_set_permissions ( doca_rdma* rdma, uint32_t permissions ): Set rdma permissions for doca_rdma. The value can be queried using doca_rdma_get_permissions(). Can only be called after calling doca_ctx_dev_add() and before calling doca_ctx_start(). The supported permissions are the RDMA access flags.
doca_error_t doca_rdma_set_recv_buf_chain_len ( doca_rdma* rdma, uint32_t recv_buf_chain_len ): Set the maximal receive buffer chain length for doca_rdma. The length may be increased and the value in use can be queried using doca_rdma_get_recv_buf_chain_len(). Can only be called before calling doca_ctx_start().
doca_error_t doca_rdma_set_recv_queue_size ( doca_rdma* rdma, uint32_t recv_queue_size ): Set recv queue size property for doca_rdma. The value can be queried using doca_rdma_get_recv_queue_size(). Queue size will be rounded to the next power of 2. Can only be called before calling doca_ctx_start().
doca_error_t doca_rdma_set_send_queue_size ( doca_rdma* rdma, uint32_t send_queue_size ): Set send queue size property for doca_rdma. The value can be queried using doca_rdma_get_send_queue_size(). Queue size will be rounded to the next power of 2. can only be called before calling doca_ctx_start().
doca_error_t doca_rdma_set_sl ( doca_rdma* rdma, uint32_t sl ): Set SL (service level) for doca_rdma. The value can be queried using doca_rdma_get_sl(). Can only be called before calling doca_ctx_start().
doca_error_t doca_rdma_set_transport_type ( doca_rdma* rdma, doca_rdma_transport_type transport_type ): Set transport type for doca_rdma. The value can be queried using doca_rdma_get_transport_type(). Can only be called before calling doca_ctx_start().

Enumerations

enum doca_rdma_job_types

Available jobs for RDMA.

Values

DOCA_RDMA_JOB_RECV = DOCA_ACTION_RDMA_FIRST+1
DOCA_RDMA_JOB_SEND
DOCA_RDMA_JOB_SEND_IMM
DOCA_RDMA_JOB_READ
DOCA_RDMA_JOB_WRITE
DOCA_RDMA_JOB_WRITE_IMM
DOCA_RDMA_JOB_ATOMIC_CMP_SWP
DOCA_RDMA_JOB_ATOMIC_FETCH_ADD

enum doca_rdma_opcode_t

Job result opcodes

Values

DOCA_RDMA_OPCODE_RECV_SEND = 0
DOCA_RDMA_OPCODE_RECV_SEND_WITH_IMM
DOCA_RDMA_OPCODE_RECV_WRITE_WITH_IMM

enum doca_rdma_state

Possible states for doca_rdma

Values

DOCA_RDMA_STATE_RESET = 0
DOCA_RDMA_STATE_INIT
DOCA_RDMA_STATE_CONNECTED
DOCA_RDMA_STATE_ERROR

enum doca_rdma_transport_type

Available transport types for RDMA

Values

DOCA_RDMA_TRANSPORT_RC: RC transport
DOCA_RDMA_TRANSPORT_DC: DC transport, currently not supported

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_rdma_as_ctx ( doca_rdma* rdma )

Convert doca_rdma instance into a generalised context for use with doca core objects.

Parameters

rdma: RDMA instance. This must remain valid until after the context is no longer required.

Returns

Non NULL upon success, NULL otherwise.

Description

doca_error_t doca_rdma_connect ( doca_rdma* rdma, const void* remote_rdma_conn_details, size_t remote_rdma_conn_details_size )

Connect to remote doca_rdma peer. Can only be called after calling doca_ctx_start().

Parameters

rdma: Pointer to doca_rdma to connect.
remote_rdma_conn_details: Exported doca_rdma_conn_details object from remote peer.
remote_rdma_conn_details_size: Size of remote doca_rdma_conn_details object.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if any of the parameters is null.
DOCA_ERROR_BAD_STATE - if context was not started or rdma instance is already connected.
DOCA_ERROR_CONNECTION_ABORTED - if connection failed or connection details object was corrupted.

Description

Note:

stopping and restarting an RDMA context require calling doca_rdma_export() & doca_rdma_connect() again.

doca_error_t doca_rdma_create ( doca_rdma** rdma )

Create a DOCA RDMA instance.

Parameters

rdma: Pointer to pointer to be set to point to the created doca_rdma instance.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - rdma argument is a NULL pointer.
DOCA_ERROR_NO_MEMORY - failed to allocate resources.
DOCA_ERROR_INITIALIZATION - failed to initialize rdma.

Description

doca_error_t doca_rdma_destroy ( doca_rdma* rdma )

Destroy a DOCA RDMA instance.

Parameters

rdma: Pointer to instance to be destroyed.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - rdma argument is a NULL pointer.
DOCA_ERROR_BAD_STATE - the associated ctx was not stopped before calling doca_rdma_destroy().

Description

doca_error_t doca_rdma_export ( const doca_rdma* rdma, const void** local_rdma_conn_details, size_t* local_rdma_conn_details_size )

Export doca_rdma connection details object The doca_rdma_conn_details are used in doca_rdma_connect(). Can only be called after calling doca_ctx_start().

Parameters

rdma: Pointer doca_rdma to export connection details for.
local_rdma_conn_details: Exported doca_rdma_conn_details object.
local_rdma_conn_details_size: Size of exported doca_rdma_conn_details object.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if any of the parameters is null.
DOCA_ERROR_BAD_STATE - if called before calling ctx_start().

Description

Note:

stopping and restarting an RDMA context require calling doca_rdma_export() & doca_rdma_connect() again.

doca_error_t doca_rdma_get_gid ( doca_devinfo* devinfo, uint32_t start_index, uint32_t num_entries, doca_rdma_gid* gid_array )

Parameters

devinfo: The DOCA device information
start_index: The first gid index of interest
num_entries: The number of desired gid indicies
gid_array: A 'struct doca_rdma_gid' array of size 'num_entries', that on success will hold the desired gids. Note that it is the user's responsibility to provide an array with enough entries to prevent data corruption

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query device capabilities.

Description

Get gids for a specific device by index and number of entries.

doca_error_t doca_rdma_get_gid_index ( const doca_rdma* rdma, uint32_t* gid_index )

Get GID index from doca_rdma. Get the current GID index set for doca_rdma.

Parameters

rdma: doca_rdma context to get the property from.
gid_index: GID index used in doca_rdma.

Returns

DOCA_SUCCESS - if property retrieved successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if function was called before adding a device.

Description

doca_error_t doca_rdma_get_gid_table_size ( doca_devinfo* devinfo, uint32_t* gid_table_size )

Parameters

devinfo: The DOCA device information
gid_table_size: The gid table size for the given devinfo.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query device capabilities.

Description

Get the gid table size for a specific device.

doca_error_t doca_rdma_get_grh_enabled ( const doca_rdma* rdma, bool* grh_enabled )

Get GRH setting from doca_rdma. Get the current GRH setting for doca_rdma.

Parameters

rdma: doca_rdma context to get the property from.
grh_enabled: GRH setting used in doca_rdma.

Returns

DOCA_SUCCESS - if property retrieved successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if function was called before adding a device.

Description

doca_error_t doca_rdma_get_max_buf_chain_len ( const doca_devinfo* devinfo, doca_rdma_job_types job_type, doca_rdma_transport_type transport_type, uint32_t* max_buf_chain_len )

Parameters

devinfo: The DOCA device information
job_type: The relevant job type
transport_type: The relevant transport type
max_buf_chain_len: The maximal number of chained local buffers (containing data) that can be submitted in the given DOCA RDMA job for the given transport type and devinfo.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query device capabilities.

Description

Get the maximal buffer chain length for a specific device, job type and transport type.

doca_error_t doca_rdma_get_max_message_size ( const doca_devinfo* devinfo, uint32_t* max_message_size )

Get the maximal message size for a specific device.

Parameters

devinfo: The DOCA device information
max_message_size: The maximal message size for the given devinfo.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query device capabilities.

Description

doca_error_t doca_rdma_get_max_recv_queue_size ( const doca_devinfo* devinfo, uint32_t* max_recv_queue_size )

Get the maximal recv queue size for a specific device.

Parameters

devinfo: The DOCA device information
max_recv_queue_size: The maximal recv queue size for the given devinfo.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query device capabilities.

Description

doca_error_t doca_rdma_get_max_send_queue_size ( const doca_devinfo* devinfo, uint32_t* max_send_queue_size )

Parameters

devinfo: The DOCA device information
max_send_queue_size: The of the maximal send queue size for the given devinfo.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query device capabilities.

Description

Get the maximal send queue size for a specific device.

doca_error_t doca_rdma_get_mtu ( const doca_rdma* rdma, doca_mtu_size ** mtu )

Get the MTU property from doca_rdma. Returns the current MTU set for the doca_rdma context.

Parameters

rdma: doca_rdma context to get the property from.
mtu: MTU set in context.

Returns

DOCA_SUCCESS - if property retrieved successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if function was called before adding a device.

Description

Note:

If MTU wasn't set by the user explicitly (and a default value was used), it may changed upon connection.

doca_error_t doca_rdma_get_permissions ( doca_rdma* rdma, uint32_t* permissions )

Get permissions property from doca_rdma. Returns the current permissions set for the doca_rdma_context. Can only be called after calling doca_ctx_dev_add().

Parameters

rdma: doca_rdma context to get the property from.
permissions: Bitwise combination of RDMA access flags set in context - see enum doca_access_flags

Returns

DOCA_SUCCESS - if property retrieved successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if function was called before adding a device.

Description

doca_error_t doca_rdma_get_recv_buf_chain_len ( const doca_rdma* rdma, uint32_t* recv_buf_chain_len )

Get the maximal receive buffer chain length from doca_rdma. Get the current receive buffer chain length set for doca_rdma. The returned value is the actual value being used and might differ from the size set by the user, as it may be increased.

Parameters

rdma: doca_rdma context to get the property from.
recv_buf_chain_len: recv_buf_chain_len used in doca_rdma.

Returns

DOCA_SUCCESS - if property retrieved successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if function was called before adding a device.

Description

doca_error_t doca_rdma_get_recv_queue_size ( const doca_rdma* rdma, uint32_t* recv_queue_size )

Get recv queue size property from doca_rdma. Returns the current recv_queue_size set for the doca_rdma_context. The size returned is the actual size being used and might differ from the size set by the user, as the size may be increased.

Parameters

rdma: doca_rdma context to get the property from.
recv_queue_size: Recv queue size set in context.

Returns

DOCA_SUCCESS - if property retrieved successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if function was called before adding a device.

Description

doca_error_t doca_rdma_get_send_queue_size ( const doca_rdma* rdma, uint32_t* send_queue_size )

Get send queue size property from doca_rdma. Returns the current send_queue_size set for the doca_rdma_context. The size returned is the actual size being used and might differ from the size set by the user, as the size may be increased.

Parameters

rdma: doca_rdma context to get the property from.
send_queue_size: Send queue size set in context.

Returns

DOCA_SUCCESS - if property retrieved successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if function was called before adding a device.

Description

doca_error_t doca_rdma_get_sl ( const doca_rdma* rdma, uint32_t* sl )

Get SL (service level) from doca_rdma. Get the current SL set for doca_rdma.

Parameters

rdma: doca_rdma context to get the property from.
sl: SL used in doca_rdma.

Returns

DOCA_SUCCESS - if property retrieved successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if function was called before adding a device.

Description

doca_error_t doca_rdma_get_state ( const doca_rdma* rdma, doca_rdma_state ** state )

Get current state of doca_rdma. Returns the current state of the doca_rdma_context.

Parameters

rdma: doca_rdma context to get the state from.
state: State of doca_rdma context.

Returns

DOCA_SUCCESS - if state retrieved successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if function was called before adding a device.

Description

doca_error_t doca_rdma_get_transport_type ( const doca_rdma* rdma, doca_rdma_transport_type ** transport_type )

Get transport_type property from doca_rdma. Returns the current transport_type set for the doca_rdma_context.

Parameters

rdma: doca_rdma context to get the property from.
transport_type: Transport_type set in context.

Returns

DOCA_SUCCESS - if property retrieved successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if function was called before adding a device.

Description

doca_error_t doca_rdma_get_transport_type_supported ( const doca_devinfo* devinfo, doca_rdma_transport_type transport_type )

Check if DOCA RDMA supports given transport type for a specific device.

Parameters

devinfo: The DOCA device information
transport_type: Transport type to query support for.

Returns

DOCA_SUCCESS - in case the transport type is supported. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query device capabilities
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support the given transport type.

Description

doca_error_t doca_rdma_job_get_supported ( const doca_devinfo* devinfo, doca_rdma_job_types job_type )

Check if given device supports given doca_rdma job.

Parameters

devinfo: The DOCA device information
job_type: doca_rdma job type. See enum doca_rdma_job_types.

Returns

DOCA_SUCCESS - in case the job is supported. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_DRIVER - failed to query device capabilities
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support the given doca_rdma job.

Description

doca_error_t doca_rdma_set_gid_index ( doca_rdma* rdma, uint32_t gid_index )

Set GID index for doca_rdma. The value can be queried using doca_rdma_get_gid_index(). Can only be called before calling doca_ctx_start().

Parameters

rdma: doca_rdma context to set the property for.
gid_index: GID index to use in doca_rdma.

Returns

DOCA_SUCCESS - if property set successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started or function was called before adding a device.

Description

doca_error_t doca_rdma_set_grh_enabled ( doca_rdma* rdma, bool grh_enabled )

Set whether to use GRH in connection. The value can be queried using doca_rdma_get_grh_enabled(). Can only be called before calling doca_ctx_start().

Parameters

rdma: doca_rdma context to set the property for.
grh_enabled: GRH setting to use in doca_rdma.

Returns

DOCA_SUCCESS - if property set successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started or function was called before adding a device.
DOCA_ERROR_NOT_SUPPORTED - if GRH setting is not supported for the device.

Description

If using IB device: If GRH is disabled, the address will rely on LID only. If GRH is enabled, the other side must also use GRH.

If using ETH device, GRH must be enabled.

doca_error_t doca_rdma_set_mtu ( doca_rdma* rdma, doca_mtu_size mtu )

Set MTU for doca_rdma. The value can be queried using doca_rdma_get_mtu(). Can only be called before calling doca_ctx_start().

Parameters

rdma: doca_rdma context to set the property for.
mtu: MTU to use in context.

Returns

DOCA_SUCCESS - if property set successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_NOT_SUPPORTED - if the given MTU is not supported.
DOCA_ERROR_BAD_STATE - if context is already started.
DOCA_ERROR_UNEXPECTED - if an unexpected error has occurred.

Description

doca_error_t doca_rdma_set_permissions ( doca_rdma* rdma, uint32_t permissions )

Set rdma permissions for doca_rdma. The value can be queried using doca_rdma_get_permissions(). Can only be called after calling doca_ctx_dev_add() and before calling doca_ctx_start(). The supported permissions are the RDMA access flags.

Parameters

rdma: doca_rdma context to set the property for.
permissions: Bitwise combination of RDMA access flags - see enum doca_access_flags

Returns

DOCA_SUCCESS - if property set successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given or non-RDMA access flags were given.
DOCA_ERROR_BAD_STATE - if context is already started or function was called before adding a device.

Description

doca_error_t doca_rdma_set_recv_buf_chain_len ( doca_rdma* rdma, uint32_t recv_buf_chain_len )

Set the maximal receive buffer chain length for doca_rdma. The length may be increased and the value in use can be queried using doca_rdma_get_recv_buf_chain_len(). Can only be called before calling doca_ctx_start().

Parameters

rdma: doca_rdma context to set the property for.
recv_buf_chain_len: recv_buf_chain_len to use in doca_rdma.

Returns

DOCA_SUCCESS - if property set successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

doca_error_t doca_rdma_set_recv_queue_size ( doca_rdma* rdma, uint32_t recv_queue_size )

Set recv queue size property for doca_rdma. The value can be queried using doca_rdma_get_recv_queue_size(). Queue size will be rounded to the next power of 2. Can only be called before calling doca_ctx_start().

Parameters

rdma: doca_rdma context to set the property for.
recv_queue_size: Recv queue size to use in context.

Returns

DOCA_SUCCESS - if property set successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_NOT_SUPPORTED - if the given size is not supported.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

doca_error_t doca_rdma_set_send_queue_size ( doca_rdma* rdma, uint32_t send_queue_size )

Set send queue size property for doca_rdma. The value can be queried using doca_rdma_get_send_queue_size(). Queue size will be rounded to the next power of 2. can only be called before calling doca_ctx_start().

Parameters

rdma: doca_rdma context to set the property for.
send_queue_size: Send queue size to use in context.

Returns

DOCA_SUCCESS - if property set successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_NOT_SUPPORTED - if the given size is not supported.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

doca_error_t doca_rdma_set_sl ( doca_rdma* rdma, uint32_t sl )

Set SL (service level) for doca_rdma. The value can be queried using doca_rdma_get_sl(). Can only be called before calling doca_ctx_start().

Parameters

rdma: doca_rdma context to set the property for.
sl: SL to use in doca_rdma.

Returns

DOCA_SUCCESS - if property set successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

doca_error_t doca_rdma_set_transport_type ( doca_rdma* rdma, doca_rdma_transport_type transport_type )

Set transport type for doca_rdma. The value can be queried using doca_rdma_get_transport_type(). Can only be called before calling doca_ctx_start().

Parameters

rdma: doca_rdma context to set the property for.
transport_type: Transport type to use in context.

Returns

DOCA_SUCCESS - if property set successfully. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if an invalid parameter was given.
DOCA_ERROR_NOT_SUPPORTED - if the given transport type is not supported.
DOCA_ERROR_BAD_STATE - if context is already started.

Description

2.33. RegEx Engine

DOCA RegEx library. For more details please refer to the user guide on DOCA devzone.

Classes

struct doca_regex_job_search
struct doca_regex_match
struct doca_regex_search_result

Defines

#define DOCA_REGEX_STATUS_FALLBACK_FLAGS
#define DOCA_REGEX_STATUS_SEARCH_FAILED

Enumerations

enum doca_regex_job_types
enum doca_regex_search_job_flags
enum doca_regex_status_flag

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_regex_as_ctx ( doca_regex* regex )
doca_error_t doca_regex_create ( doca_regex** regex )
doca_error_t doca_regex_destroy ( doca_regex* regex )
doca_error_t doca_regex_get_failed_job_fallback_enabled ( const doca_regex* regex, bool* enabled )
doca_error_t doca_regex_get_hardware_compiled_rules ( const doca_regex* regex, void** rules_data, size_t* rules_data_size )
doca_error_t doca_regex_get_hardware_supported ( const doca_devinfo* devinfo )
doca_error_t doca_regex_get_hardware_uncompiled_rules ( const doca_regex* regex, void** rules_data, size_t* rules_data_size )
doca_error_t doca_regex_get_huge_job_emulation_overlap_size ( const doca_regex* regex, uint16_t* nb_overlap_bytes )
doca_error_t doca_regex_get_maximum_job_size ( const doca_devinfo* devinfo, uint64_t* max_job_len )
doca_error_t doca_regex_get_maximum_non_huge_job_size ( const doca_devinfo* devinfo, uint64_t* max_job_len )
doca_error_t doca_regex_get_small_job_offload_threshold ( const doca_regex* regex, uint16_t* threshold )
doca_error_t doca_regex_get_software_compiled_rules ( const doca_regex* regex, void** rules_data, size_t* rules_data_size )
doca_error_t doca_regex_get_software_supported ( const doca_devinfo* devinfo )
doca_error_t doca_regex_get_software_uncompiled_rules ( const doca_regex* regex, void** rules_data, size_t* rules_data_size )
doca_error_t doca_regex_get_workq_matches_memory_pool_size ( const doca_regex* regex, uint32_t* pool_size )
doca_error_t doca_regex_is_supported ( const doca_devinfo* devinfo )
doca_error_t doca_regex_job_get_supported ( const doca_devinfo* devinfo, doca_regex_job_types job_type )
doca_error_t doca_regex_search_job_flag_get_highest_priority_match_supported ( const doca_devinfo* devinfo )
doca_error_t doca_regex_search_job_flag_get_stop_on_any_match_supported ( const doca_devinfo* devinfo )
doca_error_t doca_regex_set_failed_job_fallback_enabled ( doca_regex* regex, bool enabled )
doca_error_t doca_regex_set_hardware_compiled_rules ( doca_regex* regex, const void* rules_data, size_t rules_data_size )
doca_error_t doca_regex_set_hardware_uncompiled_rules ( doca_regex* regex, const void* rules_data, size_t rules_data_size )
doca_error_t doca_regex_set_huge_job_emulation_overlap_size ( doca_regex* regex, uint16_t nb_overlap_bytes )
doca_error_t doca_regex_set_in_order_responses_enabled ( doca_regex* regex, bool enabled )
doca_error_t doca_regex_set_small_job_offload_threshold ( doca_regex* regex, uint16_t threshold )
doca_error_t doca_regex_set_software_compiled_rules ( doca_regex* regex, const void* rules_data, size_t rules_data_size )
doca_error_t doca_regex_set_software_uncompiled_rules ( doca_regex* regex, const void* rules_data, size_t rules_data_size )
doca_error_t doca_regex_set_workq_matches_memory_pool_size ( doca_regex* regex, uint32_t pool_size )

Defines

#define DOCA_REGEX_STATUS_FALLBACK_FLAGS

Bitmask for Regex search failure flags that indicate a fallback search method can be used.

Value

(DOCA_REGEX_STATUS_MAX_PRI_THREADS | DOCA_REGEX_STATUS_MAX_SEC_THREADS | \ DOCA_REGEX_STATUS_MAX_LATENCY | DOCA_REGEX_STATUS_MAX_MATCH | \ DOCA_REGEX_STATUS_MAX_PREFIX)

#define DOCA_REGEX_STATUS_SEARCH_FAILED

Bitmask for Regex search failure

Value

Enumerations

enum doca_regex_job_types

Available job types for RegEx.

Values

DOCA_REGEX_JOB_SEARCH = DOCA_ACTION_REGEX_FIRST+1: Default RegEx search mode

enum doca_regex_search_job_flags

Available job flags for RegEx.

Values

DOCA_REGEX_SEARCH_JOB_FLAG_HIGHEST_PRIORITY_MATCH = 1<<1
DOCA_REGEX_SEARCH_JOB_FLAG_STOP_ON_ANY_MATCH = 1<<2

enum doca_regex_status_flag

Response status flags

Values

DOCA_REGEX_STATUS_MAX_PRI_THREADS = 1ULL<<0
DOCA_REGEX_STATUS_MAX_SEC_THREADS = 1ULL<<1
DOCA_REGEX_STATUS_MAX_LATENCY = 1ULL<<2
DOCA_REGEX_STATUS_MAX_MATCH = 1ULL<<3
DOCA_REGEX_STATUS_MAX_PREFIX = 1ULL<<4
DOCA_REGEX_STATUS_CQE_FAILURE_INVALID_JOB = 1ULL<<5

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_regex_as_ctx ( doca_regex* regex )

Parameters

regex: The RegEx instance to convert. This must remain valid until after the context is no longer required.

Returns

Non NULL upon success, NULL otherwise.

Description

Convert RegEx instance into context for use with workQ

doca_error_t doca_regex_create ( doca_regex** regex )

Parameters

regex: Pointer to be populated with the address of the newly created RegEx context.

Returns

DOCA_SUCCESS - RegEx instance was created DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_MEMORY - Unable to create required resources.

Description

Create a DOCA RegEx instance.

doca_error_t doca_regex_destroy ( doca_regex* regex )

Parameters

regex: Instance to be destroyed, MUST NOT BE NULL.

Returns

DOCA_SUCCESS - RegEx instance was created DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Destroy DOCA RegEx instance.

Note:

The context must be stopped via a successful call to doca_ctx_stop before it can be safely destroyed.

doca_error_t doca_regex_get_failed_job_fallback_enabled ( const doca_regex* regex, bool* enabled )

Parameters

regex: The RegEx engine.
enabled: Set to true when the feature is enabled, or false if it is disabled.

Returns

DOCA_SUCCESS - enabled is populated DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Is the failed job fallback feature enabled.

doca_error_t doca_regex_get_hardware_compiled_rules ( const doca_regex* regex, void** rules_data, size_t* rules_data_size )

Parameters

regex: The RegEx engine.
rules_data: Value to populate with a pointer to an array of bytes which are a copy of the value currently stored. Caller is assumes ownership of this memory and can choose to release it at any time.
rules_data_size: Size of the array pointed to by rules_data. Only valid when *rules_data != NULL.

Returns

DOCA_SUCCESS - rules_data and rules_data_size are populated. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_MEMORY - Unable to allocate memory to store a copy of the rules.

Description

Get the compiled rules data to be used by the hardware RegEx device.

doca_error_t doca_regex_get_hardware_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: Device to check.

Returns

DOCA_SUCCESS - Hardware acceleration is supported. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NOT_SUPPORTED - Hardware acceleration is NOT supported.

Description

Determine if a given device supports hardware accelerated RegEx searches.

doca_error_t doca_regex_get_hardware_uncompiled_rules ( const doca_regex* regex, void** rules_data, size_t* rules_data_size )

Parameters

regex: The RegEx engine.
rules_data: Value to populate to hold a pointer to an array of bytes which are a copy of the value currently stored. Caller is assumes ownership of this memory and can choose to release it at any time.
rules_data_size: Size of the array pointed to by rules_data. Only valid when *rules_data != NULL.

Returns

DOCA_SUCCESS - rules_data and rules_data_size are populated. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_MEMORY - Unable to allocate memory to store a copy of the rules.

Description

Get the un-compiled rules data to be used by the hardware RegEx device.

doca_error_t doca_regex_get_huge_job_emulation_overlap_size ( const doca_regex* regex, uint16_t* nb_overlap_bytes )

Parameters

regex: The RegEx engine.
nb_overlap_bytes: Number of bytes of overlap in use.

Returns

DOCA_SUCCESS - nb_overlap_bytes is populated. DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Get the size of overlap to use when a job exceeds a devices maximum search size.

doca_error_t doca_regex_get_maximum_job_size ( const doca_devinfo* devinfo, uint64_t* max_job_len )

Parameters

devinfo: Device to check.
max_job_len: Maximum supported job length.

Returns

DOCA_SUCCESS - max_job_len is populated. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NOT_SUPPORTED - Device does not support RegEx.

Description

Determine the maximum job size supported by this device.

doca_error_t doca_regex_get_maximum_non_huge_job_size ( const doca_devinfo* devinfo, uint64_t* max_job_len )

Parameters

devinfo: Device to check.
max_job_len: Maximum supported job length.

Returns

DOCA_SUCCESS - max_job_len is populated. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NOT_SUPPORTED - Device does not support RegEx.

Description

Determine the maximum job size supported by this device without requiring the huge job emulation feature.

doca_error_t doca_regex_get_small_job_offload_threshold ( const doca_regex* regex, uint16_t* threshold )

Parameters

regex: The RegEx engine.
threshold: Threshold job size in bytes.

Returns

DOCA_SUCCESS - threshold is populated. DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Get the "small jobs" threshold.

doca_error_t doca_regex_get_software_compiled_rules ( const doca_regex* regex, void** rules_data, size_t* rules_data_size )

Parameters

regex: The RegEx engine.
rules_data: Value to populate with a pointer to an array of bytes which are a copy of the value currently stored. Caller is assumes ownership of this memory and can choose to release it at any time.
rules_data_size: Size of the array pointed to by rules_data. Only valid when *rules_data != NULL.

Returns

DOCA_SUCCESS - rules_data and rules_data_size are populated. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_MEMORY - Unable to allocate memory to store a copy of the rules.

Description

Get the compiled rules data to be used by the software RegEx device.

doca_error_t doca_regex_get_software_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: Device to check.

Returns

DOCA_SUCCESS - Software support is available. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NOT_SUPPORTED - Software support is NOT available.

Description

Determine if a given device supports software based RegEx searches.

doca_error_t doca_regex_get_software_uncompiled_rules ( const doca_regex* regex, void** rules_data, size_t* rules_data_size )

Parameters

regex: The RegEx engine.
rules_data: Value to populate with a pointer to an array of bytes which are a copy of the value currently stored. Caller is assumes ownership of this memory and can choose to release it at any time.
rules_data_size: Size of the array pointed to by rules_data. Only valid when *rules_data != NULL.

Returns

DOCA_SUCCESS - rules_data and rules_data_size are populated. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_MEMORY - Unable to allocate memory to store a copy of the rules.

Description

Get the un-compiled rules data to be used by the software RegEx device.

doca_error_t doca_regex_get_workq_matches_memory_pool_size ( const doca_regex* regex, uint32_t* pool_size )

Parameters

regex: The RegEx engine.
pool_size: Number of items that will be available to each workq.

Returns

DOCA_SUCCESS - pool_size is populated. DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Get the size of work queue pool attached to workq for use with the RegEx engine.

doca_error_t doca_regex_is_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: Device to check.

Returns

DOCA_SUCCESS - Device can be used with doca_regex. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NOT_SUPPORTED - Device cannot be used with doca_regex.

Description

Determine if a given device is suitable for use with doca_regex.

doca_error_t doca_regex_job_get_supported ( const doca_devinfo* devinfo, doca_regex_job_types job_type )

Parameters

devinfo: Device to check.
job_type: Job type to check.

Returns

DOCA_SUCCESS - Job type is supported with the given device. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NOT_SUPPORTED - Job type is NOT supported with the given device.

Description

Determine if the given job type is supported for the given device.

doca_error_t doca_regex_search_job_flag_get_highest_priority_match_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: Device to check.

Returns

DOCA_SUCCESS - Search jobs support highest priority match when using the given device. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NOT_SUPPORTED - highest priority match is NOT supported when using the given device.

Description

Determine if 'highest priority' match is supported for the given device when submitting doca_regex_job_search jobs.

doca_error_t doca_regex_search_job_flag_get_stop_on_any_match_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: Device to check.

Returns

DOCA_SUCCESS - Search jobs support stop on any match when using the given device. DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NOT_SUPPORTED - stop on any match is NOT supported when using the given device.

Description

Determine if 'stop on any' match is supported for the given device when submitting doca_regex_job_search jobs.

doca_error_t doca_regex_set_failed_job_fallback_enabled ( doca_regex* regex, bool enabled )

Parameters

regex: The RegEx engine.
enabled: Specify true to enable the feature, false to disable it.

Returns

DOCA_SUCCESS - Property was successfully set DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_LOCK - Unable to gain exclusive control of RegEx instance. DOCA_ERROR_IN_USE - RegEx instance is currently started.

Description

Enable the ability to automatically migrate a job which was executed on the hardware device and subsequently failed to be re-executed on the software device. This is useful if a hardware limitation prevents a job from executing to completion.

Note:

This feature requires both a hardware and a software device to be available. Validated during context start.

doca_error_t doca_regex_set_hardware_compiled_rules ( doca_regex* regex, const void* rules_data, size_t rules_data_size )

Parameters

regex: The RegEx engine.
rules_data: An opaque blob of rules data which is provided to the hardware device.
rules_data_size: Size of the blob.

Returns

DOCA_SUCCESS - Property was successfully set Error code - in case of failure: DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_LOCK - Unable to gain exclusive control of RegEx instance. DOCA_ERROR_IN_USE - RegEx instance is currently started. DOCA_ERROR_NO_MEMORY - Unable to allocate memory to store a copy of the rules.

Description

Specify the compiled rules data to be used by the hardware RegEx device.

Note:

This property is mutually exclusive with hardware un-compiled rules. This property mandates that a hardware device will be attached before the context is started. If no hardware device will be provided you should not specify hardware rules, or explicitly clear them by setting them to NULL. This will be validated as part of starting the context
The caller retains ownership of data pointed to by rules_data and is responsible for freeing it when they no longer require it. The engine will make a copy of this data for its own purposes.

doca_error_t doca_regex_set_hardware_uncompiled_rules ( doca_regex* regex, const void* rules_data, size_t rules_data_size )

Parameters

regex: The RegEx engine.
rules_data: An opaque blob of rules data which will be compiled by the engine into compiled rules data which is then provided to the hardware device.
rules_data_size: Size of the blob.

Returns

DOCA_SUCCESS - Property was successfully set Error code - in case of failure: DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_LOCK - Unable to gain exclusive control of RegEx instance. DOCA_ERROR_IN_USE - RegEx instance is currently started. DOCA_ERROR_NO_MEMORY - Unable to allocate memory to store a copy of the rules.

Description

Specify the un-compiled rules data to be used by the hardware RegEx device.

Note:

This property is mutually exclusive with hardware compiled rules. This property mandates that a hardware device will be attached before the context is started. If no hardware device will be provided you should not specify hardware rules, or explicitly clear them by setting them to NULL. This will be validated as part of starting the context
The caller retains ownership of data pointed to by rules_data and is responsible for freeing it when they no longer require it. The engine will make a copy of this data for its own purposes.
Rules compilation takes place during context start.

doca_error_t doca_regex_set_huge_job_emulation_overlap_size ( doca_regex* regex, uint16_t nb_overlap_bytes )

Parameters

regex: The RegEx engine.
nb_overlap_bytes: Number of bytes of overlap to use.

Returns

DOCA_SUCCESS - Property was successfully set Error code - in case of failure: DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_LOCK - Unable to gain exclusive control of RegEx instance. DOCA_ERROR_IN_USE - RegEx instance is currently started.

Description

Set the size of overlap to use when a job exceeds a devices maximum search size. Defaults to 0 (no overlap)

When a submitted job is larger than the receiving device can support it must be fragmented. This can cause issues if a match exists but is split across two fragments. To remedy this an overlap size can be set so that these matches may be detected. The overlap defined by this function specifies how many bytes of the previous search fragment will be resent as part of the next search fragment. So for example if a 100 byte job is submitted and a device supported a 32 byte maximum job length then the jobs sent would look as follows:

Overlap size First job Second Job Third Job Fourth job Fifth Job Sixth Job 0 [0-31] [32-63] [64-95] [96-99] --- --- 8 [0-31] [24-55] [42-79] [72-99] --- --- 16 [0-31] [16-47] [32-63] [48-79] [64-95] [80-99]

This allows the user to select an overlap value which provides enough overlap to detect any match they must find for the lowest cost.

Note:

doca_error_t doca_regex_set_in_order_responses_enabled ( doca_regex* regex, bool enabled )

Parameters

regex: The RegEx engine.
enabled: Set to true to ensure in order responses, false to turn off feature.

Returns

Description

Configure the driver so that each QP will return job responses in the same order that the jobs were sent.

Note:

Enabling in order reponses may negatively impact performance as the hardware device may process some jobs quicker than others but software will not have access to these responses until previous jobs in the queue are completed. This feature is disabled by default and is recommended to only be enabled if it is a hard requirement for a given use-case.

doca_error_t doca_regex_set_small_job_offload_threshold ( doca_regex* regex, uint16_t threshold )

Parameters

regex: The RegEx engine.
threshold: Threshold job size in bytes.

Returns

DOCA_SUCCESS - Property was successfully set Error code - in case of failure: DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_LOCK - Unable to gain exclusive control of RegEx instance. DOCA_ERROR_IN_USE - RegEx instance is currently started.

Description

Define a threshold for "small jobs". For scenarios where small jobs cause poor performance using the hardware RegEx device these can instead be redirected to the software device. Set this to a value > 0 to enable the feature. Set this value to 0 to disable the feature. Defaults to 0 (disabled)

Note:

This feature requires both a hardware and a software device to be available. The range of valid values for this property depend upon the device in use. This means that acceptance of a value through this API does not ensure the value is acceptable, this will be validated as part of starting the context

doca_error_t doca_regex_set_software_compiled_rules ( doca_regex* regex, const void* rules_data, size_t rules_data_size )

Parameters

regex: The RegEx engine.
rules_data: An opaque blob of rules data which is provided to the software device.
rules_data_size: Size of the blob.

Returns

DOCA_SUCCESS - Property was successfully set Error code - in case of failure: DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_LOCK - Unable to gain exclusive control of RegEx instance. DOCA_ERROR_IN_USE - RegEx instance is currently started. DOCA_ERROR_NO_MEMORY - Unable to allocate memory to store a copy of the rules.

Description

Specify the compiled rules data to be used by the software RegEx device.

Note:

This property is mutually exclusive with software un-compiled rules. This property mandates that a software device will be attached before the context is started. If no software device will be provided you should not specify software rules, or explicitly clear them by setting them to NULL. This will be validated as part of starting the context
The caller retains ownership of data pointed to by rules_data and is responsible for freeing it when they no longer require it. The engine will make a copy of this data for its own purposes.

doca_error_t doca_regex_set_software_uncompiled_rules ( doca_regex* regex, const void* rules_data, size_t rules_data_size )

Parameters

regex: The RegEx engine.
rules_data: An opaque blob of rules data which will be compiled by the engine into compiled rules data which is then provided to the software device.
rules_data_size: Size of the blob

Returns

DOCA_SUCCESS - Property was successfully set Error code - in case of failure: DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_LOCK - Unable to gain exclusive control of RegEx instance. DOCA_ERROR_IN_USE - RegEx instance is currently started. DOCA_ERROR_NO_MEMORY - Unable to allocate memory to store a copy of the rules.

Description

Specify the un-compiled rules data to be used by the software RegEx device.

Note:

This property is mutually exclusive with software compiled rules. This property mandates that a software device will be attached before the context is started. If no software device will be provided you should not specify software rules, or explicitly clear them by setting them to NULL. This will be validated as part of starting the context
The caller retains ownership of data pointed to by rules_data and is responsible for freeing it when they no longer require it. The engine will make a copy of this data for its own purposes.
Rules compilation takes place during context start.

doca_error_t doca_regex_set_workq_matches_memory_pool_size ( doca_regex* regex, uint32_t pool_size )

Parameters

regex: The RegEx engine.
pool_size: Number of items to have available to each workq.

Returns

DOCA_SUCCESS - Property was successfully set Error code - in case of failure: DOCA_ERROR_INVALID_VALUE - received invalid input. DOCA_ERROR_NO_LOCK - Unable to gain exclusive control of RegEx instance. DOCA_ERROR_IN_USE - RegEx instance is currently started.

Description

Each work queue attached to the RegEx engine gets a pool allocator for matches. Set this value to set the maximum number of matches that can be stored for a given workq.

Note:

2.34. RegEx Engine Memory Mool

Define functions to allow easy creation and use of memory pools.

Functions

__DOCA_EXPERIMENTAL doca_regex_mempool* doca_regex_mempool_create ( size_t elem_size, size_t nb_elems )
__DOCA_EXPERIMENTAL void doca_regex_mempool_destroy ( doca_regex_mempool* pool )
__DOCA_EXPERIMENTAL size_t doca_regex_mempool_get_capacity ( const doca_regex_mempool* pool )
__DOCA_EXPERIMENTAL size_t doca_regex_mempool_get_element_size ( const doca_regex_mempool* pool )
__DOCA_EXPERIMENTAL size_t doca_regex_mempool_get_free_count ( const doca_regex_mempool* pool )
__DOCA_EXPERIMENTAL void* doca_regex_mempool_get_obj ( doca_regex_mempool* pool )
__DOCA_EXPERIMENTAL void doca_regex_mempool_put_obj ( doca_regex_mempool* pool, void* obj )

Functions

__DOCA_EXPERIMENTAL doca_regex_mempool* doca_regex_mempool_create ( size_t elem_size, size_t nb_elems )

Parameters

elem_size: Size of an element to be stored in the memory pool.
nb_elems: Number of element stored in the memory pool.

Returns

Pointer to the memory pool on success or NULL on failure.

Description

Create a memory pool.

Note:

Supports single producer and single consumer only.

__DOCA_EXPERIMENTAL void doca_regex_mempool_destroy ( doca_regex_mempool* pool )

Parameters

pool: Memory pool to be destroyed. Must not be NULL.

Description

Destroy a memory pool and all objects it owned.

Note:

all pointers to elements in this pool must be cleared before this call. Failure to do socmay result in undefined behaviour.

__DOCA_EXPERIMENTAL size_t doca_regex_mempool_get_capacity ( const doca_regex_mempool* pool )

Parameters

pool: The pool to query

Returns

The capacity / size of the pool

Description

Get the capacity of a mempool

__DOCA_EXPERIMENTAL size_t doca_regex_mempool_get_element_size ( const doca_regex_mempool* pool )

Parameters

pool: The pool to query

Returns

The size available for storage of an element within the pool

Description

Get the size of element which can be stored in this pool

__DOCA_EXPERIMENTAL size_t doca_regex_mempool_get_free_count ( const doca_regex_mempool* pool )

Parameters

pool: The pool to query

Returns

The number of free elements

Description

Get the number of elements available for use within the pool

__DOCA_EXPERIMENTAL void* doca_regex_mempool_get_obj ( doca_regex_mempool* pool )

Parameters

pool: Pool from which to get a free object.

Returns

Pointer to an object or NULL if the pool is exhausted.

Description

Get an object from the memory pool.

Note:

Supports single producer and single consumer only.

__DOCA_EXPERIMENTAL void doca_regex_mempool_put_obj ( doca_regex_mempool* pool, void* obj )

Parameters

pool: Pool which created obj.
obj: Object created by pool which is being returned to the free state.

Description

Put an object back into the memory pool.

Note:

Supports single producer and single consumer only.

2.35. DOCA RMAX Engine

DOCA RMAX library. For more details please refer to the user guide on DOCA devzone.

Classes

struct doca_rmax_cpu_affinity_mask: Data structure to describe CPU mask for doca_rmax internal thread.
struct doca_rmax_in_stream_completion: Completion returned by input stream describing the incoming packets.
struct doca_rmax_job_rx_data: Receive data job.
struct doca_rmax_stream_error: Detailed completion error information.

Defines

#define DOCA_RMAX_CPU_SETSIZE 1024
#define DOCA_RMAX_NCPUBITS

Typedefs

typedef uint64_t doca_rmax_cpu_mask_t

Enumerations

enum doca_rmax_action_type: Action types for doca jobs.
enum doca_rmax_in_stream_scatter_type: Incoming packet scatter mode, used by input stream.
enum doca_rmax_in_stream_ts_fmt_type: Input packet timestamp format (timestamp, when packet was received).
enum doca_rmax_in_stream_type: Type of input stream.

Functions

doca_error_t doca_rmax_flow_attach ( const doca_rmax_flow* flow, const doca_rmax_in_stream* stream ): Attach a flow to a stream.
doca_error_t doca_rmax_flow_create ( doca_rmax_flow** flow ): Create a steering flow for input stream to filter incoming data flow by match criteria.
doca_error_t doca_rmax_flow_destroy ( doca_rmax_flow* flow ): Destroy a steering flow.
doca_error_t doca_rmax_flow_detach ( const doca_rmax_flow* flow, const doca_rmax_in_stream* stream ): Detach a flow from a stream.
doca_error_t doca_rmax_flow_set_dst_ip ( doca_rmax_flow* flow, const in_addr* ip ): Set the destination IP filter for the flow.
doca_error_t doca_rmax_flow_set_dst_port ( doca_rmax_flow* flow, uint16_t port ): Set the destination port filter for the flow.
doca_error_t doca_rmax_flow_set_src_ip ( doca_rmax_flow* flow, const in_addr* ip ): Set the source IP filter for the flow.
doca_error_t doca_rmax_flow_set_src_port ( doca_rmax_flow* flow, uint16_t port ): Set the source port filter for the flow.
doca_error_t doca_rmax_flow_set_tag ( doca_rmax_flow* flow, uint32_t tag ): Set the tag for the flow.
doca_error_t doca_rmax_get_cpu_affinity_mask ( doca_rmax_cpu_affinity_mask* mask ): Get affinity mask for the internal Rivermax thread.
doca_error_t doca_rmax_get_ptp_clock_supported ( const doca_devinfo* devinfo ): Query PTP clock capability for device.
__DOCA_EXPERIMENTAL doca_ctx* doca_rmax_in_stream_as_ctx ( doca_rmax_in_stream* stream ): Convert a DOCA RMAX input stream to DOCA context.
doca_error_t doca_rmax_in_stream_create ( doca_rmax_in_stream** stream ): Create a DOCA RMAX input stream context.
doca_error_t doca_rmax_in_stream_destroy ( doca_rmax_in_stream* stream ): Destroy a DOCA input stream context.
doca_error_t doca_rmax_in_stream_get_elements_count ( const doca_rmax_in_stream* stream, uint32_t* value ): Get number of elements in the stream buffer.
doca_error_t doca_rmax_in_stream_get_max_packets ( const doca_rmax_in_stream* stream, uint32_t* value ): Get maximal number of packets that input stream must return in read event.
doca_error_t doca_rmax_in_stream_get_memblk_size ( const doca_rmax_in_stream* stream, size_t* value ): Get size of memory block(s).
doca_error_t doca_rmax_in_stream_get_memblk_stride_size ( const doca_rmax_in_stream* stream, uint16_t* value ): Get stride size(s).
doca_error_t doca_rmax_in_stream_get_memblks_count ( const doca_rmax_in_stream* stream, uint32_t* value ): Get number of configured memory blocks.
doca_error_t doca_rmax_in_stream_get_min_packets ( const doca_rmax_in_stream* stream, uint32_t* value ): Get minimal number of packets that input stream must return in read event.
doca_error_t doca_rmax_in_stream_get_scatter_type ( const doca_rmax_in_stream* stream, doca_rmax_in_stream_scatter_type ** value ): Get the type of packet's data scatter.
doca_error_t doca_rmax_in_stream_get_timeout_us ( const doca_rmax_in_stream* stream, int* value ): Get receive timeout.
doca_error_t doca_rmax_in_stream_get_timestamp_format ( const doca_rmax_in_stream* stream, doca_rmax_in_stream_ts_fmt_type ** value ): Get stream timestamp format.
doca_error_t doca_rmax_in_stream_get_type ( const doca_rmax_in_stream* stream, doca_rmax_in_stream_type ** value ): Get input stream type.
doca_error_t doca_rmax_in_stream_memblk_desc_get_max_size ( const doca_rmax_in_stream* stream, uint16_t* value ): Get maximal packet segment sizes.
doca_error_t doca_rmax_in_stream_memblk_desc_get_min_size ( const doca_rmax_in_stream* stream, uint16_t* value ): Get minimal packet segment sizes.
doca_error_t doca_rmax_in_stream_memblk_desc_set_max_size ( doca_rmax_in_stream* stream, const uint16_t* value ): Set maximal packet segment sizes.
doca_error_t doca_rmax_in_stream_memblk_desc_set_min_size ( doca_rmax_in_stream* stream, const uint16_t* value ): Set minimal packet segment sizes.
doca_error_t doca_rmax_in_stream_set_elements_count ( doca_rmax_in_stream* stream, uint32_t value ): Set number of elements in the stream buffer.
doca_error_t doca_rmax_in_stream_set_max_packets ( doca_rmax_in_stream* stream, uint32_t value ): Set maximal number of packets that input stream must return in read event.
doca_error_t doca_rmax_in_stream_set_memblk ( doca_rmax_in_stream* stream, doca_buf* buf ): Set memory buffer(s).
doca_error_t doca_rmax_in_stream_set_memblks_count ( doca_rmax_in_stream* stream, uint32_t value ): Set number of configured memory blocks.
doca_error_t doca_rmax_in_stream_set_min_packets ( doca_rmax_in_stream* stream, uint32_t value ): Set minimal number of packets that input stream must return in read event.
doca_error_t doca_rmax_in_stream_set_scatter_type ( doca_rmax_in_stream* stream, doca_rmax_in_stream_scatter_type value ): Set the type of packet's data scatter.
doca_error_t doca_rmax_in_stream_set_timeout_us ( doca_rmax_in_stream* stream, int value ): Set receive timeout.
doca_error_t doca_rmax_in_stream_set_timestamp_format ( doca_rmax_in_stream* stream, doca_rmax_in_stream_ts_fmt_type value ): Set stream timestamp format.
doca_error_t doca_rmax_in_stream_set_type ( doca_rmax_in_stream* stream, doca_rmax_in_stream_type value ): Set input stream type.
doca_error_t doca_rmax_init ( void ): DOCA RMAX library initalization.
__DOCA_EXPERIMENTAL void doca_rmax_interrupt ( void ): Interrupt the currently executing DOCA RMAX function, if any.
doca_error_t doca_rmax_release ( void ): Uninitialize DOCA RMAX library.
doca_error_t doca_rmax_set_clock ( doca_dev* dev ): Set the device to use for obtaining PTP time.
doca_error_t doca_rmax_set_cpu_affinity_mask ( const doca_rmax_cpu_affinity_mask* mask ): Set affinity mask for the internal Rivermax thread.

Defines

#define DOCA_RMAX_CPU_SETSIZE 1024

maximum CPU set size

#define DOCA_RMAX_NCPUBITS

number of CPU bits per one cpu mask element

Value

(8 * sizeof(doca_rmax_cpu_mask_t))

Typedefs

typedef uint64_t doca_rmax_cpu_mask_t

CPU bitmask container

Enumerations

enum doca_rmax_action_type

Values

DOCA_RMAX_ACTION_TYPE_RX_DATA = DOCA_ACTION_RMAX_FIRST+1: Input packets data. This action does not originate from a submitted job.

enum doca_rmax_in_stream_scatter_type

Values

DOCA_RMAX_IN_STREAM_SCATTER_TYPE_RAW = 0: Store raw packet data including network headers
DOCA_RMAX_IN_STREAM_SCATTER_TYPE_ULP: Store User-Level Protocol only data (discard network header up to L4)
DOCA_RMAX_IN_STREAM_SCATTER_TYPE_PAYLOAD: Store payload data only (all headers will be discarded)

enum doca_rmax_in_stream_ts_fmt_type

Values

DOCA_RMAX_IN_STREAM_TS_FMT_TYPE_RAW_COUNTER = 0: Raw number written by HW, representing the HW clock
DOCA_RMAX_IN_STREAM_TS_FMT_TYPE_RAW_NANO: Time in nanoseconds
DOCA_RMAX_IN_STREAM_TS_FMT_TYPE_SYNCED: Time in nanoseconds, synced with PTP grandmaster

enum doca_rmax_in_stream_type

Values

DOCA_RMAX_IN_STREAM_TYPE_GENERIC = 0: Generic stream
DOCA_RMAX_IN_STREAM_TYPE_RTP_2110: SMPTE ST 2110 stream

Functions

doca_error_t doca_rmax_flow_attach ( const doca_rmax_flow* flow, const doca_rmax_in_stream* stream )

Attach a flow to a stream.

Parameters

flow: Flow to operate on
stream: The context for attaching a flow

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_INITIALIZATION - Rivermax is not initialized.
DOCA_ERROR_SHUTDOWN - library shutdown in a process.
DOCA_ERROR_UNEXPECTED - unexpected issue.

Description

doca_error_t doca_rmax_flow_create ( doca_rmax_flow** flow )

Create a steering flow for input stream to filter incoming data flow by match criteria.

Parameters

flow: The flow created for input stream. Non NULL upon success, NULL otherwise.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - unable to allocate memory.

Description

doca_error_t doca_rmax_flow_destroy ( doca_rmax_flow* flow )

Destroy a steering flow.

Parameters

flow: Flow to destroy.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_rmax_flow_detach ( const doca_rmax_flow* flow, const doca_rmax_in_stream* stream )

Detach a flow from a stream.

Parameters

flow: Flow to operate on
stream: The context for detaching a flow

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_INITIALIZATION - Rivermax is not initialized.
DOCA_ERROR_SHUTDOWN - library shutdown in a process.
DOCA_ERROR_UNEXPECTED - unexpected issue.

Description

doca_error_t doca_rmax_flow_set_dst_ip ( doca_rmax_flow* flow, const in_addr* ip )

Set the destination IP filter for the flow.

Parameters

flow: Flow to operate on
ip: Destination IPv4 address

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_rmax_flow_set_dst_port ( doca_rmax_flow* flow, uint16_t port )

Set the destination port filter for the flow.

Parameters

flow: Flow to operate on
port: Destination port number, non-zero

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_rmax_flow_set_src_ip ( doca_rmax_flow* flow, const in_addr* ip )

Set the source IP filter for the flow.

Parameters

flow: Flow to operate on
ip: Source IPv4 address

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_rmax_flow_set_src_port ( doca_rmax_flow* flow, uint16_t port )

Set the source port filter for the flow.

Parameters

flow: Flow to operate on
port: Source port number. If zero then any source port is accepted.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_rmax_flow_set_tag ( doca_rmax_flow* flow, uint32_t tag )

Set the tag for the flow.

Parameters

flow: Flow to operate on
tag: Non-zero tag

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_rmax_get_cpu_affinity_mask ( doca_rmax_cpu_affinity_mask* mask )

Get affinity mask for the internal Rivermax thread.

Parameters

mask: Affinity mask. CPU is included in affinity mask if the corresponding bit is set. If CPU affinity mask is unset return value is zeroed.

Returns

DOCA_SUCCESS - always.

Description

doca_error_t doca_rmax_get_ptp_clock_supported ( const doca_devinfo* devinfo )

Query PTP clock capability for device.

Parameters

devinfo: The device to query

Returns

DOCA_SUCCESS - PTP clock is supported. DOCA_ERROR_NOT_SUPPORTED - PTP clock is not supported. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_INITIALIZATION - Rivermax is not initialized.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the IPv4 address from the OS

Description

__DOCA_EXPERIMENTAL doca_ctx* doca_rmax_in_stream_as_ctx ( doca_rmax_in_stream* stream )

Convert a DOCA RMAX input stream to DOCA context.

Parameters

stream: The context to be converted

Returns

The matching doca_ctx instance in case of success, NULL otherwise.

Description

DOCA RMAX stream supports all stream operations: create/start/stop/destroy. Only one device and one workq must be attached to a stream.

doca_error_t doca_rmax_in_stream_create ( doca_rmax_in_stream** stream )

Create a DOCA RMAX input stream context.

Parameters

stream: The input stream context created for the DOCA RMAX. Non NULL upon success, NULL otherwise.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - stream argument is a NULL pointer.
DOCA_ERROR_NO_MEMORY - failed to alloc doca_rmax_in_stream.
DOCA_ERROR_INITIALIZATION - failed to initialise DOCA context.

Description

Create input stream.

doca_error_t doca_rmax_in_stream_destroy ( doca_rmax_in_stream* stream )

Destroy a DOCA input stream context.

Parameters

stream: The context to be destroyed

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - stream argument is a NULL pointer.

Description

Free all allocated resources associated with a DOCA RMAX input stream.

doca_error_t doca_rmax_in_stream_get_elements_count ( const doca_rmax_in_stream* stream, uint32_t* value )

Get number of elements in the stream buffer.

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

This value can differ from value set by doca_rmax_in_stream_set_elements_count if the argument is not a power of two.

doca_error_t doca_rmax_in_stream_get_max_packets ( const doca_rmax_in_stream* stream, uint32_t* value )

Get maximal number of packets that input stream must return in read event.

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_rmax_in_stream_get_memblk_size ( const doca_rmax_in_stream* stream, size_t* value )

Get size of memory block(s).

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_INITIALIZATION - Rivermax is not initialized.
DOCA_ERROR_UNEXPECTED - unexpected program flow.

Description

Size of memory block (array of sizes for multiple memblks, the number of memory blocks in stream is more than one).

doca_error_t doca_rmax_in_stream_get_memblk_stride_size ( const doca_rmax_in_stream* stream, uint16_t* value )

Get stride size(s).

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_INITIALIZATION - Rivermax is not initialized.
DOCA_ERROR_UNEXPECTED - unexpected program flow.

Description

Stride size of memory block (array of stride sizes for multiple memory blocks).

doca_error_t doca_rmax_in_stream_get_memblks_count ( const doca_rmax_in_stream* stream, uint32_t* value )

Get number of configured memory blocks.

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Amount of memblks is equal to the number of segments into which the incoming packet will be divided.

doca_error_t doca_rmax_in_stream_get_min_packets ( const doca_rmax_in_stream* stream, uint32_t* value )

Get minimal number of packets that input stream must return in read event.

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_rmax_in_stream_get_scatter_type ( const doca_rmax_in_stream* stream, doca_rmax_in_stream_scatter_type ** value )

Get the type of packet's data scatter.

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

See enum doca_rmax_in_stream_scatter_type.

doca_error_t doca_rmax_in_stream_get_timeout_us ( const doca_rmax_in_stream* stream, int* value )

Get receive timeout.

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure.

Description

The number of usecs that library would do busy wait (polling) for reception of at least `min_packets` number of packets.

doca_error_t doca_rmax_in_stream_get_timestamp_format ( const doca_rmax_in_stream* stream, doca_rmax_in_stream_ts_fmt_type ** value )

Get stream timestamp format.

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

See enum doca_rmax_in_stream_ts_fmt_type

doca_error_t doca_rmax_in_stream_get_type ( const doca_rmax_in_stream* stream, doca_rmax_in_stream_type ** value )

Get input stream type.

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

doca_error_t doca_rmax_in_stream_memblk_desc_get_max_size ( const doca_rmax_in_stream* stream, uint16_t* value )

Get maximal packet segment sizes.

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_UNEXPECTED - unexpected program flow.

Description

Array of maximal packet segment sizes that will be received by input stream. Array length equals to the number of memory blocks in the stream buffer.

doca_error_t doca_rmax_in_stream_memblk_desc_get_min_size ( const doca_rmax_in_stream* stream, uint16_t* value )

Get minimal packet segment sizes.

Parameters

stream: The input stream to query.
value: Where to write the current property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_UNEXPECTED - unexpected program flow.

Description

Array of minimal packet segment sizes that will be received by input stream. Array length equals to the number of memory blocks in the stream buffer.

doca_error_t doca_rmax_in_stream_memblk_desc_set_max_size ( doca_rmax_in_stream* stream, const uint16_t* value )

Set maximal packet segment sizes.

Parameters

stream: The input stream to write property.
value: Property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_UNEXPECTED - unexpected program flow.

Description

Array of maximal packet segment sizes that will be received by input stream. Array length equals to the number of memory blocks in the stream buffer. Must be set before starting the stream context.

doca_error_t doca_rmax_in_stream_memblk_desc_set_min_size ( doca_rmax_in_stream* stream, const uint16_t* value )

Set minimal packet segment sizes.

Parameters

stream: The input stream to write property.
value: Property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_UNEXPECTED - unexpected program flow.

Description

Array of minimal packet segment sizes that will be received by input stream. Array length equals to the number of memory blocks in the stream buffer. Default: 0.

doca_error_t doca_rmax_in_stream_set_elements_count ( doca_rmax_in_stream* stream, uint32_t value )

Set number of elements in the stream buffer.

Parameters

stream: The input stream to write property.
value: Property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Must be set before starting the stream context. See also doca_rmax_in_stream_get_elements_count.

doca_error_t doca_rmax_in_stream_set_max_packets ( doca_rmax_in_stream* stream, uint32_t value )

Set maximal number of packets that input stream must return in read event.

Parameters

stream: The input stream to write property.
value: Property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Default: 1024.

doca_error_t doca_rmax_in_stream_set_memblk ( doca_rmax_in_stream* stream, doca_buf* buf )

Set memory buffer(s).

Parameters

stream: The input stream to write property.
buf: Property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_UNEXPECTED - unexpected program flow.

Description

Memory buffer (or head of linked list of memory buffers) for storing received data. The length of linked list must be the same as number of memory blocks configured. Must be set before starting the stream context.

doca_error_t doca_rmax_in_stream_set_memblks_count ( doca_rmax_in_stream* stream, uint32_t value )

Set number of configured memory blocks.

Parameters

stream: The input stream to write property.
value: Property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Amount of memblks is equal to the number of segments into which the incoming packet will be divided. Default: 1. Valid values: 1 and 2.

doca_error_t doca_rmax_in_stream_set_min_packets ( doca_rmax_in_stream* stream, uint32_t value )

Set minimal number of packets that input stream must return in read event.

Parameters

stream: The input stream to write property.
value: Property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Default: 0.

doca_error_t doca_rmax_in_stream_set_scatter_type ( doca_rmax_in_stream* stream, doca_rmax_in_stream_scatter_type value )

Set the type of packet's data scatter.

Parameters

stream: The input stream to write property.
value: Property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

See enum doca_rmax_in_stream_scatter_type. Default: DOCA_RMAX_IN_STREAM_SCATTER_TYPE_RAW.

doca_error_t doca_rmax_in_stream_set_timeout_us ( doca_rmax_in_stream* stream, int value )

Set receive timeout.

Parameters

stream: The input stream to write property.
value: Property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

The number of usecs that library would do busy wait (polling) for reception of at least `min_packets` number of packets.

Default: 0.

doca_error_t doca_rmax_in_stream_set_timestamp_format ( doca_rmax_in_stream* stream, doca_rmax_in_stream_ts_fmt_type value )

Set stream timestamp format.

Parameters

stream: The input stream to write property.
value: Property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

See enum doca_rmax_in_stream_ts_fmt_type Default: DOCA_RMAX_IN_STREAM_TS_FMT_TYPE_RAW_COUNTER.

doca_error_t doca_rmax_in_stream_set_type ( doca_rmax_in_stream* stream, doca_rmax_in_stream_type value )

Set input stream type.

Parameters

stream: The input stream to write property.
value: Property value.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Default: DOCA_RMAX_IN_STREAM_TYPE_GENERIC.

doca_error_t doca_rmax_init ( void )

DOCA RMAX library initalization.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_UNSUPPORTED_VERSION - unsupported Rivermax library version.
DOCA_ERROR_INITIALIZATION - Rivermax initialization failed.
DOCA_ERROR_NO_MEMORY - unable to allocate memory.
DOCA_ERROR_NOT_FOUND - there are no supported devices.
DOCA_ERROR_NOT_SUPPORTED - invalid or missing Rivermax license.
DOCA_ERROR_UNEXPECTED - unexpected issue.

Description

This function initializes the DOCA RMAX global resources. This function must be called after doca_rmax_set_cpu_affinity_mask and before any other DOCA RMAX library call.

__DOCA_EXPERIMENTAL void doca_rmax_interrupt ( void )

Interrupt the currently executing DOCA RMAX function, if any.

Description

doca_error_t doca_rmax_release ( void )

Uninitialize DOCA RMAX library.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INITIALIZATION - Rivermax is not initialized.
DOCA_ERROR_IN_USE - library is in use.

Description

This function cleans up the DOCA RMAX resources. No DOCA RMAX function may be called after calling this function.

doca_error_t doca_rmax_set_clock ( doca_dev* dev )

Set the device to use for obtaining PTP time.

Parameters

dev: Device to use for obtaining the PTP time.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_FOUND - there is no IPv4 address associated with this device.
DOCA_ERROR_NOT_SUPPORTED - PTP clock is not supported by device.
DOCA_ERROR_OPERATING_SYSTEM - failed to acquire the IPv4 address from the OS
DOCA_ERROR_UNEXPECTED - unexpected issue.

Description

The device must have PTP clock capability, see doca_rmax_get_ptp_clock_supported.

doca_error_t doca_rmax_set_cpu_affinity_mask ( const doca_rmax_cpu_affinity_mask* mask )

Set affinity mask for the internal Rivermax thread.

Parameters

mask: Affinity mask. CPU is included in affinity mask if the corresponding bit is set. By default affinity mask is not set, so internal thread can run on any CPU core.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - invalid affinity mask provided.

Description

Must be called before doca_rmax_init().

2.36. SHA Engine

DOCA SHA library. For more details please refer to the user guide on DOCA devzone.

Classes

struct doca_sha_job
struct doca_sha_partial_job

Defines

#define DOCA_SHA1_BYTE_COUNT 20
#define DOCA_SHA256_BYTE_COUNT 32
#define DOCA_SHA512_BYTE_COUNT 64

Enumerations

enum doca_sha_job_flags
enum doca_sha_job_type

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_sha_as_ctx ( doca_sha* ctx )
doca_error_t doca_sha_create ( doca_sha** ctx )
doca_error_t doca_sha_destroy ( doca_sha* ctx )
doca_error_t doca_sha_get_hardware_supported ( const doca_devinfo* devinfo )
doca_error_t doca_sha_get_max_list_buf_num_elem ( const doca_devinfo* devinfo, uint32_t* max_list_num_elem )
doca_error_t doca_sha_get_max_src_buffer_size ( const doca_devinfo* devinfo, uint64_t* max_buffer_size )
doca_error_t doca_sha_get_min_dst_buffer_size ( const doca_devinfo* devinfo, doca_sha_job_type job_type, uint32_t* min_buffer_size )
doca_error_t doca_sha_job_get_supported ( const doca_devinfo* devinfo, doca_sha_job_type job_type )
doca_error_t doca_sha_partial_session_copy ( doca_sha* ctx, doca_workq* workq, const doca_sha_partial_session* from_session, doca_sha_partial_session* to_session )
doca_error_t doca_sha_partial_session_create ( doca_sha* ctx, doca_workq* workq, doca_sha_partial_session** session )
doca_error_t doca_sha_partial_session_destroy ( doca_sha* ctx, doca_workq* workq, doca_sha_partial_session* session )

Defines

#define DOCA_SHA1_BYTE_COUNT 20

User response buffer length should be >= the following specified length, depending on the SHA function. Both SHA1_PARTIAL and SHA1 need 20bytes. Both SHA256_PARTIAL and SHA256 need 32bytes. Both SHA512_PARTIAL and SHA512 need 64bytes. SHA1 calculation hex-format result length.

#define DOCA_SHA256_BYTE_COUNT 32

SHA256 calculation hex-format result length.

#define DOCA_SHA512_BYTE_COUNT 64

SHA512 calculation hex-format result length.

Enumerations

enum doca_sha_job_flags

Flag enum for SHA job.

Values

DOCA_SHA_JOB_FLAGS_NONE = 0: Default flag for all SHA job.
DOCA_SHA_JOB_FLAGS_SHA_PARTIAL_FINAL: Only useful for doca_sha_partial_job.

enum doca_sha_job_type

Doca sha action type enums, used to specify sha job types.

Values

DOCA_SHA_JOB_SHA1 = DOCA_ACTION_SHA_FIRST+1
DOCA_SHA_JOB_SHA256
DOCA_SHA_JOB_SHA512
DOCA_SHA_JOB_SHA1_PARTIAL
DOCA_SHA_JOB_SHA256_PARTIAL
DOCA_SHA_JOB_SHA512_PARTIAL

Functions

__DOCA_EXPERIMENTAL doca_ctx* doca_sha_as_ctx ( doca_sha* ctx )

Parameters

ctx: SHA instance. This must remain valid until after the context is no longer required.

Returns

Non NULL - doca_ctx object on success. Error:

NULL.

Description

Convert sha instance into context for use with workQ

doca_error_t doca_sha_create ( doca_sha** ctx )

Parameters

ctx: Instance pointer to be created, MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - not enough memory for allocation.
DOCA_ERROR_NOT_SUPPORTED - the required engine is not supported.

Description

Create a DOCA SHA instance.

doca_error_t doca_sha_destroy ( doca_sha* ctx )

Parameters

ctx: Instance to be destroyed, MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_IN_USE - the required engine resource is not released yet. Please call doca_ctx_stop().

Description

Destroy DOCA SHA instance.

doca_error_t doca_sha_get_hardware_supported ( const doca_devinfo* devinfo )

Parameters

devinfo: The DOCA device information

Returns

DOCA_SUCCESS - in case of success, it is a hardware_based engine. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - failed to query device capabilities. or provided devinfo does not support the given doca_sha job.

Description

Get DOCA SHA operating mode: hardware or openssl_fallback. First to use doca_sha_job_get_supported() to decide whether the devinfo support doca_sha engine. Second to use doca_sha_get_hardware_supported() to decide whether this doca_sha engine is hardware_based or openssl_fallback_based.

doca_error_t doca_sha_get_max_list_buf_num_elem ( const doca_devinfo* devinfo, uint32_t* max_list_num_elem )

Parameters

devinfo: The DOCA device information.
max_list_num_elem: The maximum supported number of elements in a given DOCA linked-list buffer, such that 1 indicates no linked-list buffer support.

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_NOT_SUPPORTED - failed to query device capabilities. or provided devinfo does not support the given doca_sha job.

Description

Get the maximum supported number of elements in a given DOCA linked-list buffer for SHA job.

doca_error_t doca_sha_get_max_src_buffer_size ( const doca_devinfo* devinfo, uint64_t* max_buffer_size )

Parameters

devinfo: The DOCA device information
max_buffer_size: The max buffer size for DOCA SHA operation in bytes.

Returns

DOCA_SUCCESS - upon success Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - in case of invalid input.
DOCA_ERROR_NOT_SUPPORTED - failed to query device capabilities. or provided devinfo does not support the given doca_sha job.

Description

Get maximum source buffer size for DOCA SHA job.

doca_error_t doca_sha_get_min_dst_buffer_size ( const doca_devinfo* devinfo, doca_sha_job_type job_type, uint32_t* min_buffer_size )

Parameters

devinfo: The DOCA device information
job_type: doca_sha job type. See enum doca_sha_job_type.
min_buffer_size: The min buffer size for DOCA SHA operation in bytes.

Returns

DOCA_SUCCESS - in case of success. doca_error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - failed to query device capabilities. or provided devinfo does not support the given doca_sha job.

Description

Get minimum result buffer size for DOCA SHA job.

doca_error_t doca_sha_job_get_supported ( const doca_devinfo* devinfo, doca_sha_job_type job_type )

Parameters

devinfo: The DOCA device information
job_type: SHA job_type available through this device. see enum doca_sha_job_type.

Returns

DOCA_SUCCESS - in case device supports job_type. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NOT_SUPPORTED - provided devinfo does not support this SHA job.

Description

Check if given device is capable of excuting a specific SHA job.

doca_error_t doca_sha_partial_session_copy ( doca_sha* ctx, doca_workq* workq, const doca_sha_partial_session* from_session, doca_sha_partial_session* to_session )

Parameters

ctx: SHA instance.
workq: Workq instance.
from_session: The source sha_partial_session object to be copied.
to_session: The dest sha_partial_session object.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_UNEXPECTED - received corrupted input.

Description

Copy the sha_partial session state from "from_session" to "to_session". This is useful if large amounts of data to be sha-calculated which share the same header segments, and only differ in the tail last few bytes. For example, we have two msgs: msg_0 = {header, tail_0}, msg_1 = {header, tail_1}, both of them need to be processed in sha_partial job.

when without session_copy functionality: we will do sha_calculation for msg_0 as: doca_sha_partial_session_create(ctx, workq, &session_0); doca_workq_submit(workq, &job_0_for_header); doca_workq_progress_retrieve(workq, &event, DOCA_WORKQ_RETRIEVE_FLAGS_NONE); doca_workq_submit(workq, &job_0_for_tail_0); doca_workq_progress_retrieve(workq, &event, DOCA_WORKQ_RETRIEVE_FLAGS_NONE); doca_sha_partial_session_destroy(ctx, workq, session_0); then, we will do sha_calculation for msg_1 as: doca_sha_partial_session_create(ctx, workq, &session_1); doca_workq_submit(workq, &job_1_for_header); doca_workq_progress_retrieve(workq, &event, DOCA_WORKQ_RETRIEVE_FLAGS_NONE); doca_workq_submit(workq, &job_1_for_tail_1); doca_workq_progress_retrieve(workq, &event, DOCA_WORKQ_RETRIEVE_FLAGS_NONE); doca_sha_partial_session_destroy(ctx, workq, session_1);

Obviously, the same data "header" is calculated twice!

when utilising the session_copy functionality, we will do sha_calculation for msg_0 as: doca_sha_partial_session_create(ctx, workq, &session_0); doca_workq_submit(workq, &job_0_for_header); doca_workq_progress_retrieve(workq, &event, DOCA_WORKQ_RETRIEVE_FLAGS_NONE); do a session_copy: doca_sha_partial_session_create(ctx, workq, &session_1); doca_sha_partial_session_copy(ctx, workq, session_0, session_1); continue to finish msg_0: doca_workq_submit(workq, &job_0_for_tail_0); doca_workq_progress_retrieve(workq, &event, DOCA_WORKQ_RETRIEVE_FLAGS_NONE); doca_sha_partial_session_destroy(ctx, workq, session_0); continue to finish msg_1: doca_workq_submit(workq, &job_1_for_tail_1); doca_workq_progress_retrieve(workq, &event, DOCA_WORKQ_RETRIEVE_FLAGS_NONE); doca_sha_partial_session_destroy(ctx, workq, session_1);

doca_error_t doca_sha_partial_session_create ( doca_sha* ctx, doca_workq* workq, doca_sha_partial_session** session )

Parameters

ctx: SHA instance.
workq: Workq instance.
session: Instance pointer to be created, MUST NOT BE NULL.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.
DOCA_ERROR_NO_MEMORY - the resource is exhausted for now, please wait the existing jobs to finish or call doca_sha_partial_session_destroy() to release the allocated session objects.

Description

Get a session object used for sha_partial calculation. For the same sha_partial job, user need to keep using the same sha_partial_session. A session object can only be used for the same sha_ctx and workq. It cannot be shared between different sha_ctx or different workq.

doca_error_t doca_sha_partial_session_destroy ( doca_sha* ctx, doca_workq* workq, doca_sha_partial_session* session )

Parameters

ctx: SHA instance.
workq: Workq instance.
session: A sha_partial_session object to be released.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - received invalid input.

Description

Release the session object used for sha_partial calculation. Please make sure the session to be released belonging to the specific sha_ctx and workq.

2.37. Telemetry Service Library

DOCA lib for exporting events to the telemetry service.

Defines

#define DOCA_GUID_SIZE 16: DOCA GUID size.
#define DOCA_TELEMETRY_FIELD_TYPE_BOOL "bool": DOCA_TELEMETRY_FIELD_TYPE_{} are data types that are used to create doca_telemetry_field;.
#define DOCA_TELEMETRY_FIELD_TYPE_CHAR "char": DOCA telemetry char type.
#define DOCA_TELEMETRY_FIELD_TYPE_DOUBLE "double": DOCA telemetry double type.
#define DOCA_TELEMETRY_FIELD_TYPE_FLOAT "float": DOCA telemetry float type.
#define DOCA_TELEMETRY_FIELD_TYPE_INT "int": DOCA telemetry in type.
#define DOCA_TELEMETRY_FIELD_TYPE_INT16 "int16_t": DOCA telemetry int16 type.
#define DOCA_TELEMETRY_FIELD_TYPE_INT32 "int32_t": DOCA telemetry int32 type.
#define DOCA_TELEMETRY_FIELD_TYPE_INT64 "int64_t": DOCA telemetry int64 type.
#define DOCA_TELEMETRY_FIELD_TYPE_INT8 "int8_t": DOCA telemetry int8 type.
#define DOCA_TELEMETRY_FIELD_TYPE_LONG "long": DOCA telemetry long type.
#define DOCA_TELEMETRY_FIELD_TYPE_LONGLONG "long long": DOCA telemetry longlong type.
#define DOCA_TELEMETRY_FIELD_TYPE_SHORT "short": DOCA telemetry short type.
#define DOCA_TELEMETRY_FIELD_TYPE_TIMESTAMP: DOCA telemetry timestamp type.
#define DOCA_TELEMETRY_FIELD_TYPE_UCHAR "unsigned char": DOCA telemetry uchar type.
#define DOCA_TELEMETRY_FIELD_TYPE_UINT "unsigned int": DOCA telemetry uint type.
#define DOCA_TELEMETRY_FIELD_TYPE_UINT16 "uint16_t": DOCA telemetry uint16 type.
#define DOCA_TELEMETRY_FIELD_TYPE_UINT32 "uint32_t": DOCA telemetry uint32 type.
#define DOCA_TELEMETRY_FIELD_TYPE_UINT64 "uint64_t": DOCA telemetry uint64 type.
#define DOCA_TELEMETRY_FIELD_TYPE_UINT8 "uint8_t": DOCA telemetry uint8 type.
#define DOCA_TELEMETRY_FIELD_TYPE_ULONG "unsigned long": DOCA telemetry ulong type.
#define DOCA_TELEMETRY_FIELD_TYPE_ULONGLONG "unsigned long long": DOCA telemetry ulonglong type.
#define DOCA_TELEMETRY_FIELD_TYPE_USHORT "unsigned short": DOCA telemetry ushort type.

Typedefs

typedef uint8_t doca_guid_t: DOCA GUID type.
typedef uint64_t doca_telemetry_timestamp_t: DOCA schema type index type.
typedef uint8_t doca_telemetry_type_index_t: DOCA schema field type index.

Enumerations

enum doca_telemetry_ipc_status_t: DOCA telemetry IPC status.

Functions

doca_error_t doca_telemetry_check_ipc_status ( doca_telemetry_source* doca_source, doca_telemetry_ipc_status_t* status ): Return status of IPC transport.
doca_error_t doca_telemetry_field_create ( doca_telemetry_field** field ): Create new telemetry field.
doca_error_t doca_telemetry_field_destroy ( doca_telemetry_field* field ): Destroy field previously created by doca_telemetry_field_create().
__DOCA_EXPERIMENTAL void doca_telemetry_field_set_array_length ( doca_telemetry_field* field_info, uint16_t len ): Set doca telemetry field length.
__DOCA_EXPERIMENTAL void doca_telemetry_field_set_description ( doca_telemetry_field* field_info, const char* desc ): Set doca telemetry field description.
__DOCA_EXPERIMENTAL void doca_telemetry_field_set_name ( doca_telemetry_field* field_info, const char* name ): Set doca telemetry field name.
__DOCA_EXPERIMENTAL void doca_telemetry_field_set_type_name ( doca_telemetry_field* field_info, const char* type ): Set doca telemetry field type.
doca_error_t doca_telemetry_get_timestamp ( doca_telemetry_timestamp_t* timestamp ): Get timestamp in the proper format.
doca_error_t doca_telemetry_schema_add_type ( doca_telemetry_schema* doca_schema, const char* new_type_name, doca_telemetry_type* type, doca_telemetry_type_index_t* type_index ): Add user-defined fields to create new type in DOCA schema. The users loses the ownership of the type after a successful invocation of the function.
doca_error_t doca_telemetry_schema_destroy ( doca_telemetry_schema* doca_schema ): Destructor for DOCA schema.
doca_error_t doca_telemetry_schema_get_buffer_data_root ( doca_telemetry_schema* doca_schema, const char** path ): Get data root path.
doca_error_t doca_telemetry_schema_get_buffer_size ( doca_telemetry_schema* doca_schema, uint64_t* size ): Get buffer size.
doca_error_t doca_telemetry_schema_get_file_write_max_age ( doca_telemetry_schema* doca_schema, doca_telemetry_timestamp_t* max_age ): Get file maximum age.
doca_error_t doca_telemetry_schema_get_file_write_max_size ( doca_telemetry_schema* doca_schema, size_t* size ): Get file maximum size.
doca_error_t doca_telemetry_schema_get_ipc_reconnect_time ( doca_telemetry_schema* doca_schema, uint32_t* max_time ): Get IPC reconnect time in milliseconds.
doca_error_t doca_telemetry_schema_get_ipc_reconnect_tries ( doca_telemetry_schema* doca_schema, uint8_t* tries ): Get maximum IPC reconnect tries.
doca_error_t doca_telemetry_schema_get_ipc_socket_timeout ( doca_telemetry_schema* doca_schema, uint32_t* timeout ): Get IPC socket timeout in milliseconds.
doca_error_t doca_telemetry_schema_get_ipc_sockets_dir ( doca_telemetry_schema* doca_schema, const char** sockets_dir ): Get IPC socket directory.
doca_error_t doca_telemetry_schema_init ( const char* schema_name, doca_telemetry_schema** doca_schema ): Initialize DOCA schema to prepare it for setting attributes and adding types. DOCA schema is used to initialize DOCA sources that will collect the data according to the same schema.
__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_buffer_data_root ( doca_telemetry_schema* doca_schema, const char* path ): Set buffer data root Default path is "/opt/mellanox/doca/services/telemetry/data/".
__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_buffer_size ( doca_telemetry_schema* doca_schema, uint64_t size ): Set buffer size Default value is 60000 bytes.
__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_file_write_enabled ( doca_telemetry_schema* doca_schema ): Enable file write file write is disabled by default.
__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_file_write_max_age ( doca_telemetry_schema* doca_schema, doca_telemetry_timestamp_t max_age ): Set file maximum age Default value is 1 hour.
__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_file_write_max_size ( doca_telemetry_schema* doca_schema, size_t size ): Set file maximum size Default value is 1MB.
__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_ipc_enabled ( doca_telemetry_schema* doca_schema ): Enable IPC IPC is disabled by default.
__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_ipc_reconnect_time ( doca_telemetry_schema* doca_schema, uint32_t max_time ): Set IPC reconnect time in milliseconds Time limit for reconnect attempts. If the limit is reached, the client is considered disconnected. Default value is 100 milliseconds.
__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_ipc_reconnect_tries ( doca_telemetry_schema* doca_schema, uint8_t tries ): Set maximum IPC reconnect tries. Number of reconnect attempts during reconnection period. Default value is 3 tries.
__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_ipc_socket_timeout ( doca_telemetry_schema* doca_schema, uint32_t timeout ): Set IPC socket timeout in milliseconds Timeout for IPC messaging socket. If timeout is reached during send_receive, the client is considered disconnected. Default value is 3000 milliseconds.
__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_ipc_sockets_dir ( doca_telemetry_schema* doca_schema, const char* sockets_dir ): Set IPC socket directory. Default path is "/opt/mellanox/doca/services/telemetry/ipc_sockets".
__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_opaque_events_enabled ( doca_telemetry_schema* doca_schema ): Enable opaque events Opaque events are disabled by default.
doca_error_t doca_telemetry_schema_start ( doca_telemetry_schema* doca_schema ): Finalizes schema setup to start creating Doca Sources from the schema.
doca_error_t doca_telemetry_source_create ( doca_telemetry_schema* doca_schema, doca_telemetry_source** doca_source ): Creates a single DOCA source from schema.
doca_error_t doca_telemetry_source_destroy ( doca_telemetry_source* doca_source ): Destructor for DOCA source.
doca_error_t doca_telemetry_source_flush ( doca_telemetry_source* doca_source ): Immediately flush the data of the DOCA source. This function is not thread-safe and should not be called from different threads without proper access control.
doca_error_t doca_telemetry_source_get_opaque_report_max_data_size ( doca_telemetry_source* doca_source, uint32_t* max_data_size ): Get max data size for opaque report.
doca_error_t doca_telemetry_source_opaque_report ( doca_telemetry_source* doca_source, const doca_guid_t app_id, uint64_t user_defined1, uint64_t user_defined2, const void* data, uint32_t data_size ): Report opaque event data via DOCA source.
doca_error_t doca_telemetry_source_report ( doca_telemetry_source* doca_source, doca_telemetry_type_index_t index, void* data, int count ): Report events data of the same type via DOCA source.
__DOCA_EXPERIMENTAL void doca_telemetry_source_set_id ( doca_telemetry_source* doca_source, const char* source_id ): Set source id.
__DOCA_EXPERIMENTAL void doca_telemetry_source_set_tag ( doca_telemetry_source* doca_source, const char* source_tag ): Set source tag.
doca_error_t doca_telemetry_source_start ( doca_telemetry_source* doca_source ): Applies source attribute and starts DOCA source.
doca_error_t doca_telemetry_type_add_field ( doca_telemetry_type* type, doca_telemetry_field* field ): Add DOCA telemetry field to type. The users loses the ownership of the field after a successful invocation of the function.
doca_error_t doca_telemetry_type_create ( doca_telemetry_type** type ): Create new telemetry type.
doca_error_t doca_telemetry_type_destroy ( doca_telemetry_type* type ): Destroy doca telemetry type previously created by doca_telemetry_type_create().

Defines

#define DOCA_GUID_SIZE 16

#define DOCA_TELEMETRY_FIELD_TYPE_BOOL "bool"

DOCA telemetry bool type

#define DOCA_TELEMETRY_FIELD_TYPE_CHAR "char"

#define DOCA_TELEMETRY_FIELD_TYPE_DOUBLE "double"

#define DOCA_TELEMETRY_FIELD_TYPE_FLOAT "float"

#define DOCA_TELEMETRY_FIELD_TYPE_INT "int"

#define DOCA_TELEMETRY_FIELD_TYPE_INT16 "int16_t"

#define DOCA_TELEMETRY_FIELD_TYPE_INT32 "int32_t"

#define DOCA_TELEMETRY_FIELD_TYPE_INT64 "int64_t"

#define DOCA_TELEMETRY_FIELD_TYPE_INT8 "int8_t"

#define DOCA_TELEMETRY_FIELD_TYPE_LONG "long"

#define DOCA_TELEMETRY_FIELD_TYPE_LONGLONG "long long"

#define DOCA_TELEMETRY_FIELD_TYPE_SHORT "short"

#define DOCA_TELEMETRY_FIELD_TYPE_TIMESTAMP

Value

DOCA_TELEMETRY_FIELD_TYPE_UINT64

#define DOCA_TELEMETRY_FIELD_TYPE_UCHAR "unsigned char"

#define DOCA_TELEMETRY_FIELD_TYPE_UINT "unsigned int"

#define DOCA_TELEMETRY_FIELD_TYPE_UINT16 "uint16_t"

#define DOCA_TELEMETRY_FIELD_TYPE_UINT32 "uint32_t"

#define DOCA_TELEMETRY_FIELD_TYPE_UINT64 "uint64_t"

#define DOCA_TELEMETRY_FIELD_TYPE_UINT8 "uint8_t"

#define DOCA_TELEMETRY_FIELD_TYPE_ULONG "unsigned long"

#define DOCA_TELEMETRY_FIELD_TYPE_ULONGLONG "unsigned long long"

#define DOCA_TELEMETRY_FIELD_TYPE_USHORT "unsigned short"

Typedefs

typedef uint8_t doca_guid_t

DOCA GUID type.

typedef uint64_t doca_telemetry_timestamp_t

DOCA schema type index type.

typedef uint8_t doca_telemetry_type_index_t

DOCA schema field type index.

Enumerations

enum doca_telemetry_ipc_status_t

Values

DOCA_TELEMETRY_IPC_STATUS_FAILED = -1
DOCA_TELEMETRY_IPC_STATUS_CONNECTED
DOCA_TELEMETRY_IPC_STATUS_DISABLED

Functions

doca_error_t doca_telemetry_check_ipc_status ( doca_telemetry_source* doca_source, doca_telemetry_ipc_status_t* status )

Return status of IPC transport.

Parameters

doca_source

Input doca source.

status

if return is DOCA_SUCCESS then status can be one of the following

DOCA_TELEMETRY_IPC_STATUS_FAILED - if IPC is not connected.
DOCA_TELEMETRY_IPC_STATUS_CONNECTED - if IPC is connected.
DOCA_TELEMETRY_IPC_STATUS_DISABLED - if IPC is disabled from config.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if doca_source is NULL.

Description

doca_error_t doca_telemetry_field_create ( doca_telemetry_field** field )

Create new telemetry field.

Parameters

field: Pointer to the newly allocated field.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.
DOCA_ERROR_NO_MEMORY - failed to allocate doca telemetry field.

Description

doca_error_t doca_telemetry_field_destroy ( doca_telemetry_field* field )

Destroy field previously created by doca_telemetry_field_create().

Parameters

field: Pointer to the field.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.

Description

__DOCA_EXPERIMENTAL void doca_telemetry_field_set_array_length ( doca_telemetry_field* field_info, uint16_t len )

Set doca telemetry field length.

Parameters

field_info: Pointer to doca telemetry field.
len: Field length.

Description

Note:

If using single-value type (i.e char) this should be 1.

__DOCA_EXPERIMENTAL void doca_telemetry_field_set_description ( doca_telemetry_field* field_info, const char* desc )

Set doca telemetry field description.

Parameters

field_info: Pointer to doca telemetry field.
desc: Field description.

Description

Note:

Passing a field_info value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_field_set_name ( doca_telemetry_field* field_info, const char* name )

Set doca telemetry field name.

Parameters

field_info: Pointer to doca telemetry field.
name: Field name.

Description

Note:

Passing a field_info value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_field_set_type_name ( doca_telemetry_field* field_info, const char* type )

Set doca telemetry field type.

Parameters

field_info: Pointer to doca telemetry field.
type: Field type.

Description

Note:

Please see DOCA_TELEMETRY_FIELD_TYPE_* for possible field types

Note:

Passing a field_info value of NULL will result in an undefined behavior.

doca_error_t doca_telemetry_get_timestamp ( doca_telemetry_timestamp_t* timestamp )

Get timestamp in the proper format.

Parameters

timestamp: Timestamp value

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if doca_source is NULL.

Description

doca_error_t doca_telemetry_schema_add_type ( doca_telemetry_schema* doca_schema, const char* new_type_name, doca_telemetry_type* type, doca_telemetry_type_index_t* type_index )

Add user-defined fields to create new type in DOCA schema. The users loses the ownership of the type after a successful invocation of the function.

Parameters

doca_schema: Schema to create type in.
new_type_name: Name for new type.
type: User-defined fields.
type_index: Type index for the created type is written to this variable.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_NO_MEMORY - in case of memory allocation failure.
DOCA_ERROR_INVALID_VALUE - If type name exists or any of the fields have invalid field type

Description

doca_error_t doca_telemetry_schema_destroy ( doca_telemetry_schema* doca_schema )

Destructor for DOCA schema.

Parameters

doca_schema: Schema to destroy.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if doca_schema is NULL.

Description

doca_error_t doca_telemetry_schema_get_buffer_data_root ( doca_telemetry_schema* doca_schema, const char** path )

Get data root path.

Parameters

doca_schema: Pointer to DOCA schema.
path: Path to a folder where the data and schema will be stored.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.
DOCA_ERROR_NO_MEMORY - failed to allocate memory.

Description

Note:

Ownership of the returned string is transferred to the caller.

doca_error_t doca_telemetry_schema_get_buffer_size ( doca_telemetry_schema* doca_schema, uint64_t* size )

Get buffer size.

Parameters

doca_schema: Pointer to DOCA schema.
size: The buffer size

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.

Description

doca_error_t doca_telemetry_schema_get_file_write_max_age ( doca_telemetry_schema* doca_schema, doca_telemetry_timestamp_t* max_age )

Get file maximum age.

Parameters

doca_schema: Pointer to DOCA schema.
max_age: Maximum file age. Once current file is older than this threshold a new file will be created.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.

Description

doca_error_t doca_telemetry_schema_get_file_write_max_size ( doca_telemetry_schema* doca_schema, size_t* size )

Get file maximum size.

Parameters

doca_schema: Pointer to DOCA schema.
size: Maximum size of binary data file.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.

Description

doca_error_t doca_telemetry_schema_get_ipc_reconnect_time ( doca_telemetry_schema* doca_schema, uint32_t* max_time )

Get IPC reconnect time in milliseconds.

Parameters

doca_schema: Pointer to DOCA schema.
max_time: Maximum reconnect time in milliseconds

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.

Description

doca_error_t doca_telemetry_schema_get_ipc_reconnect_tries ( doca_telemetry_schema* doca_schema, uint8_t* tries )

Get maximum IPC reconnect tries.

Parameters

doca_schema: Pointer to DOCA schema.
tries: Maximum reconnect tries

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.

Description

doca_error_t doca_telemetry_schema_get_ipc_socket_timeout ( doca_telemetry_schema* doca_schema, uint32_t* timeout )

Get IPC socket timeout in milliseconds.

Parameters

doca_schema: Pointer to ipc timeout attribute.
timeout: Maximum socket timeout in milliseconds

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.

Description

doca_error_t doca_telemetry_schema_get_ipc_sockets_dir ( doca_telemetry_schema* doca_schema, const char** sockets_dir )

Get IPC socket directory.

Parameters

doca_schema: Pointer to DOCA schema.
sockets_dir: Path to a folder containing DOCA Telemetry Service (DTS) sockets.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.
DOCA_ERROR_NO_MEMORY - failed to allocate memory.

Description

Note:

Ownership of the returned string is transferred to the caller.

doca_error_t doca_telemetry_schema_init ( const char* schema_name, doca_telemetry_schema** doca_schema )

Initialize DOCA schema to prepare it for setting attributes and adding types. DOCA schema is used to initialize DOCA sources that will collect the data according to the same schema.

Parameters

schema_name: Name of the schema.
doca_schema: Pointer to DOCA schema, NULL on error.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_NO_MEMORY - failed to allocate doca_schema.
DOCA_ERROR_INITIALIZATION - failed to initialise doca_schema.
DOCA_ERROR_INVALID_VALUE - invalid input/output parameters.

Description

__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_buffer_data_root ( doca_telemetry_schema* doca_schema, const char* path )

Set buffer data root Default path is "/opt/mellanox/doca/services/telemetry/data/".

Parameters

doca_schema: Pointer to DOCA schema.
path: Path to a folder where the data and schema will be stored.

Description

Note:

Passing a doca_schema value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_buffer_size ( doca_telemetry_schema* doca_schema, uint64_t size )

Set buffer size Default value is 60000 bytes.

Parameters

doca_schema: Pointer to DOCA schema.
size: Buffer size

Description

Note:

Passing a doca_schema value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_file_write_enabled ( doca_telemetry_schema* doca_schema )

Enable file write file write is disabled by default.

Parameters

doca_schema: Pointer to DOCA schema.

Description

Note:

Passing a doca_schema value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_file_write_max_age ( doca_telemetry_schema* doca_schema, doca_telemetry_timestamp_t max_age )

Set file maximum age Default value is 1 hour.

Parameters

doca_schema: Pointer to DOCA schema.
max_age: Maximum file age. Once current file is older than this threshold a new file will be created.

Description

Note:

Passing a doca_schema value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_file_write_max_size ( doca_telemetry_schema* doca_schema, size_t size )

Set file maximum size Default value is 1MB.

Parameters

doca_schema: Pointer to DOCA schema.
size: Maximum size of binary data file. Once this size is reached, a new binary file will be created.

Description

Note:

Passing a doca_schema value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_ipc_enabled ( doca_telemetry_schema* doca_schema )

Enable IPC IPC is disabled by default.

Parameters

doca_schema: Pointer to DOCA schema.

Description

Note:

Passing a doca_schema value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_ipc_reconnect_time ( doca_telemetry_schema* doca_schema, uint32_t max_time )

Set IPC reconnect time in milliseconds Time limit for reconnect attempts. If the limit is reached, the client is considered disconnected. Default value is 100 milliseconds.

Parameters

doca_schema: Pointer to DOCA schema.
max_time: Maximum reconnect time in milliseconds

Description

Note:

Passing a doca_schema value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_ipc_reconnect_tries ( doca_telemetry_schema* doca_schema, uint8_t tries )

Set maximum IPC reconnect tries. Number of reconnect attempts during reconnection period. Default value is 3 tries.

Parameters

doca_schema: Pointer to DOCA schema.
tries: Maximum reconnect tries

Description

Note:

Passing a doca_schema value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_ipc_socket_timeout ( doca_telemetry_schema* doca_schema, uint32_t timeout )

Set IPC socket timeout in milliseconds Timeout for IPC messaging socket. If timeout is reached during send_receive, the client is considered disconnected. Default value is 3000 milliseconds.

Parameters

doca_schema: Pointer to ipc timeout attribute.
timeout: Maximum socket timeout in milliseconds

Description

Note:

Passing a doca_schema value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_ipc_sockets_dir ( doca_telemetry_schema* doca_schema, const char* sockets_dir )

Set IPC socket directory. Default path is "/opt/mellanox/doca/services/telemetry/ipc_sockets".

Parameters

doca_schema: Pointer to DOCA schema.
sockets_dir: Path to a folder containing DOCA Telemetry Service (DTS) sockets.

Description

Note:

Passing a doca_schema value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_schema_set_opaque_events_enabled ( doca_telemetry_schema* doca_schema )

Enable opaque events Opaque events are disabled by default.

Parameters

doca_schema: Pointer to DOCA schema.

Description

Note:

Passing a doca_schema value of NULL will result in an undefined behavior.

doca_error_t doca_telemetry_schema_start ( doca_telemetry_schema* doca_schema )

Finalizes schema setup to start creating Doca Sources from the schema.

Parameters

doca_schema: Input schema to start.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INITIALIZATION - in case of failure.

Description

Do NOT add new types after this function was called.

doca_error_t doca_telemetry_source_create ( doca_telemetry_schema* doca_schema, doca_telemetry_source** doca_source )

Creates a single DOCA source from schema.

Parameters

doca_schema: Schema from which source will be created.
doca_source: pointer to DOCA source, or NULL on error.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_NO_MEMORY - in case of memory allocation failure.

Description

To create a DOCA source, first call doca_telemetry_schema_start() to prepare the DOCA schema.

doca_error_t doca_telemetry_source_destroy ( doca_telemetry_source* doca_source )

Destructor for DOCA source.

Parameters

doca_source: Source to destroy.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if doca_source is NULL.

Description

doca_error_t doca_telemetry_source_flush ( doca_telemetry_source* doca_source )

Immediately flush the data of the DOCA source. This function is not thread-safe and should not be called from different threads without proper access control.

Parameters

doca_source: DOCA source to flush.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if doca_source is NULL.

Description

doca_error_t doca_telemetry_source_get_opaque_report_max_data_size ( doca_telemetry_source* doca_source, uint32_t* max_data_size )

Get max data size for opaque report.

Parameters

doca_source: Source to report.
max_data_size: Maximal data size

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter(s).

Description

doca_error_t doca_telemetry_source_opaque_report ( doca_telemetry_source* doca_source, const doca_guid_t app_id, uint64_t user_defined1, uint64_t user_defined2, const void* data, uint32_t data_size )

Report opaque event data via DOCA source.

Parameters

doca_source: Source to report.
app_id: User defined application ID.
user_defined1: User defined parameter 1.
user_defined2: User defined parameter 2.
data: Data buffer.
data_size: Size of the data in the data buffer.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_NO_MEMORY - in case of memory allocation failure.

Description

Data is flushed from internal buffer when the buffer is full. Flushing the data immediately can be done by invoking doca_telemetry_source_flush().

doca_error_t doca_telemetry_source_report ( doca_telemetry_source* doca_source, doca_telemetry_type_index_t index, void* data, int count )

Report events data of the same type via DOCA source.

Parameters

doca_source: Source to report.
index: Type index in the DOCA schema.
data: Data buffer.
count: Number of events written to the data buffer.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_NO_MEMORY - in case of memory allocation failure.

Description

Data is flushed from internal buffer when the buffer is full. Flushing the data immediately can be done by invoking doca_telemetry_source_flush(). This function is not thread-safe and should not be called from different threads without proper access control.

__DOCA_EXPERIMENTAL void doca_telemetry_source_set_id ( doca_telemetry_source* doca_source, const char* source_id )

Set source id.

Parameters

doca_source: Pointer to DOCA source.
source_id: Hostname or guid.

Description

Note:

Passing a doca_source value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_source_set_tag ( doca_telemetry_source* doca_source, const char* source_tag )

Set source tag.

Parameters

doca_source: Pointer to DOCA source.
source_tag: User defined data-file name prefix.

Description

Note:

Passing a doca_source value of NULL will result in an undefined behavior.

doca_error_t doca_telemetry_source_start ( doca_telemetry_source* doca_source )

Applies source attribute and starts DOCA source.

Parameters

doca_source: DOCA source to start.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if source attributes are not set.
DOCA_ERROR_NO_MEMORY - in case of memory allocation failure.

Description

Call this function to start reporting.

doca_error_t doca_telemetry_type_add_field ( doca_telemetry_type* type, doca_telemetry_field* field )

Add DOCA telemetry field to type. The users loses the ownership of the field after a successful invocation of the function.

Parameters

type: Pointer to doca telemetry type.
field: DOCA Telemetry field to add.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.
DOCA_ERROR_NO_MEMORY - failed to allocate doca telemetry field.

Description

Note:

field should NOT be passed to another type after calling this function.

doca_error_t doca_telemetry_type_create ( doca_telemetry_type** type )

Create new telemetry type.

Parameters

type: Pointer to the newly allocated type.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.
DOCA_ERROR_NO_MEMORY - failed to allocate doca telemetry field.

Description

doca_error_t doca_telemetry_type_destroy ( doca_telemetry_type* type )

Destroy doca telemetry type previously created by doca_telemetry_type_create().

Parameters

type: Pointer to type.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.

Description

Note:

fields added to this type should NOT be used after calling this function.

2.38. TELEMETRY NetFlow

DOCA lib for exporting a netflow packet to a netflow collector through the telemetry service.

This lib simplifies and centralizes the formatting and exporting of netflow packets. Netflow is a protocol for exporting information about the device network flows to a netflow collector that will aggregate and analyze the data. After creating conf file and invoke init function, the lib send function can be called with netflow struct to send a netflow packet with the format to the collector of choice specified in the conf file. The lib uses the netflow protocol specified by cisco.

Limitations:

The lib supports the netflow V9 format. The lib is not thread safe.

Defines

#define DOCA_NETFLOW_APP_ID: NetFlow Application ID.
#define DOCA_NETFLOW_DEFAULT_PORT 2055: NetFlow collector default port.

Functions

doca_error_t doca_telemetry_netflow_destroy ( void ): Free the exporter memory and close the connection.
doca_error_t doca_telemetry_netflow_field_create ( doca_telemetry_netflow_flowset_field** field ): Create new telemetry netflow field.
doca_error_t doca_telemetry_netflow_field_destroy ( doca_telemetry_netflow_flowset_field* field ): Destructor for DOCA netflow field.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_field_set_length ( doca_telemetry_netflow_flowset_field* field, uint16_t length ): Set doca telemetry netflow field length.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_field_set_type ( doca_telemetry_netflow_flowset_field* field, uint16_t type ): Set doca telemetry netflow field type.
doca_error_t doca_telemetry_netflow_flush ( void ): Immediately flush the data of the DOCA internal Netflow source.
doca_error_t doca_telemetry_netflow_get_buffer_data_root ( const char** path ): Get data root path.
doca_error_t doca_telemetry_netflow_get_buffer_size ( uint64_t* size ): Get buffer size.
doca_error_t doca_telemetry_netflow_get_file_write_max_age ( doca_telemetry_timestamp_t* max_age ): Get file maximum age.
doca_error_t doca_telemetry_netflow_get_file_write_max_size ( size_t* size ): Get file maximum size.
doca_error_t doca_telemetry_netflow_get_ipc_sockets_dir ( const char** path ): Get IPC socket directory.
doca_error_t doca_telemetry_netflow_init ( uint16_t source_id ): Init exporter memory, set configs and open connection.
doca_error_t doca_telemetry_netflow_send ( const doca_telemetry_netflow_template* netflow_template, const void** records, size_t nof_records, size_t* nof_records_sent ): Sending netflow records. Need to init first.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_buffer_data_root ( const char* path ): Set buffer data root Default path is "/opt/mellanox/doca/services/telemetry/data/".
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_buffer_size ( uint64_t size ): Set buffer size Default value is 60000 bytes.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_collector_addr ( const char* collector_addr ): Set collector address.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_collector_port ( uint16_t collector_port ): Set collector port. See DOCA_NETFLOW_DEFAULT_PORT for default value.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_file_write_enabled ( void ): Enable file write file write is disabled by default.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_file_write_max_age ( doca_telemetry_timestamp_t max_age ): Set file maximum age Default value is 1 hour.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_file_write_max_size ( size_t size ): Set file maximum size Default value is 1MB.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_ipc_enabled ( void ): Enable IPC IPC is disabled by default.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_ipc_sockets_dir ( const char* path ): Set IPC socket directory. Default path is "/opt/mellanox/doca/services/telemetry/ipc_sockets".
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_max_packet_size ( uint16_t max_packet_size ): Set max packet size.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_source_set_id ( const char* source_id ): Set source id.
__DOCA_EXPERIMENTAL void doca_telemetry_netflow_source_set_tag ( const char* source_tag ): Set source tag.
doca_error_t doca_telemetry_netflow_start ( void ): Finalizes netflow setup.
doca_error_t doca_telemetry_netflow_template_add_field ( doca_telemetry_netflow_template* netflow_template, doca_telemetry_netflow_flowset_field* field ): Add DOCA telemetry netflow field to netflow_template. The user loses the ownership of the field after a successful invocation of the function.
doca_error_t doca_telemetry_netflow_template_create ( doca_telemetry_netflow_template** netflow_template ): Create new telemetry netflow template.
doca_error_t doca_telemetry_netflow_template_destroy ( doca_telemetry_netflow_template* netflow_template ): Destructor for DOCA netflow template.

Defines

#define DOCA_NETFLOW_APP_ID

Note:

This GUID cannot change

Value

{ \ 0x99, 0x10, 0xc1, 0x28, 0x39, 0x61, 0x47, 0xe6,\ 0xbe, 0x6c, 0x71, 0x5a, 0x0f, 0x03, 0xad, 0xd6 \ }

#define DOCA_NETFLOW_DEFAULT_PORT 2055

Functions

doca_error_t doca_telemetry_netflow_destroy ( void )

Free the exporter memory and close the connection.

Returns

DOCA_SUCCESS - in case of success.

Description

doca_error_t doca_telemetry_netflow_field_create ( doca_telemetry_netflow_flowset_field** field )

Create new telemetry netflow field.

Parameters

field: Pointer to the newly allocated telemetry field.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.
DOCA_ERROR_NO_MEMORY - failed to allocate doca telemetry netflow field.

Description

doca_error_t doca_telemetry_netflow_field_destroy ( doca_telemetry_netflow_flowset_field* field )

Destructor for DOCA netflow field.

Parameters

field: field to destroy.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if netflow_template is NULL.

Description

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_field_set_length ( doca_telemetry_netflow_flowset_field* field, uint16_t length )

Set doca telemetry netflow field length.

Parameters

field: Pointer to doca telemetry netflow field.
length: Field type.

Description

Note:

Passing a field value of NULL will result in an undefined behavior.

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_field_set_type ( doca_telemetry_netflow_flowset_field* field, uint16_t type )

Set doca telemetry netflow field type.

Parameters

field: Pointer to doca telemetry netflow field.
type: Field type.

Description

Note:

Passing a field value of NULL will result in an undefined behavior.

doca_error_t doca_telemetry_netflow_flush ( void )

Immediately flush the data of the DOCA internal Netflow source.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_BAD_STATE - if the netflow has not been started.

Description

doca_error_t doca_telemetry_netflow_get_buffer_data_root ( const char** path )

Get data root path.

Parameters

path: The buffer data root

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.
DOCA_ERROR_NO_MEMORY - failed to allocate memory.

Description

doca_error_t doca_telemetry_netflow_get_buffer_size ( uint64_t* size )

Get buffer size.

Parameters

size: The buffer size

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.

Description

doca_error_t doca_telemetry_netflow_get_file_write_max_age ( doca_telemetry_timestamp_t* max_age )

Get file maximum age.

Parameters

max_age: Maximum file age. Once current file is older than this threshold a new file will be created.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.

Description

doca_error_t doca_telemetry_netflow_get_file_write_max_size ( size_t* size )

Get file maximum size.

Parameters

size: Maximum size of binary data file.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.

Description

doca_error_t doca_telemetry_netflow_get_ipc_sockets_dir ( const char** path )

Get IPC socket directory.

Parameters

path: Path to a folder containing DOCA Telemetry Service (DTS) sockets.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.
DOCA_ERROR_NO_MEMORY - failed to allocate memory.

Description

Note:

Ownership of the returned string is transferred to the caller.

doca_error_t doca_telemetry_netflow_init ( uint16_t source_id )

Init exporter memory, set configs and open connection.

Parameters

source_id: Unique source ID.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_BAD_STATE - if the netflow has been initialized before this call.
DOCA_ERROR_NO_MEMORY - failed to allocate memory.
DOCA_ERROR_INITIALIZATION - failed to initialise netflow.

Description

The Source ID field is a 32-bit value that is used to guarantee uniqueness for all flows exported from a particular device (see link).

This function can be called again only after doca_telemetry_netflow_destroy was called.

doca_error_t doca_telemetry_netflow_send ( const doca_telemetry_netflow_template* netflow_template, const void** records, size_t nof_records, size_t* nof_records_sent )

Sending netflow records. Need to init first.

Parameters

netflow_template: Template pointer of how the records are structured. For more info refer to doca_telemetry_netflow_template.
records: Array of pointers to the flows structs to send, must be packed. Strings must be an array in the struct, not a pointer.
nof_records: Records array size.
nof_records_sent: If not NULL, it will be filled with amount of records sent.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_BAD_STATE - if the netflow has not been initialized or the netflow has started.
DOCA_ERROR_NO_MEMORY - failed to allocate memory.

Description

Note:

When sending more then 30 records the lib splits the records to multiple packets because each packet can only send up to 30 records (Netflow protocol limit)

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_buffer_data_root ( const char* path )

Set buffer data root Default path is "/opt/mellanox/doca/services/telemetry/data/".

Parameters

path: Path to a folder where the data and schema will be stored.

Description

Note:

This function should be called after doca_telemetry_netflow_init().

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_buffer_size ( uint64_t size )

Set buffer size Default value is 60000 bytes.

Parameters

size: Buffer size

Description

Note:

This function should be called after doca_telemetry_netflow_init().

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_collector_addr ( const char* collector_addr )

Set collector address.

Parameters

collector_addr: User defined netflow collector's IP address.

Description

Note:

This function should be called after doca_telemetry_netflow_init().

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_collector_port ( uint16_t collector_port )

Set collector port. See DOCA_NETFLOW_DEFAULT_PORT for default value.

Parameters

collector_port: User defined netflow collector's port.

Description

Note:

This function should be called after doca_telemetry_netflow_init().

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_file_write_enabled ( void )

Enable file write file write is disabled by default.

Description

Note:

This function should be called after doca_telemetry_netflow_init().

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_file_write_max_age ( doca_telemetry_timestamp_t max_age )

Set file maximum age Default value is 1 hour.

Parameters

max_age: Maximum file age. Once current file is older than this threshold a new file will be created.

Description

Note:

This function should be called after doca_telemetry_netflow_init().

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_file_write_max_size ( size_t size )

Set file maximum size Default value is 1MB.

Parameters

size: Maximum size of binary data file. Once this size is reached, a new binary file will be created.

Description

Note:

This function should be called after doca_telemetry_netflow_init().

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_ipc_enabled ( void )

Enable IPC IPC is disabled by default.

Description

Note:

This function should be called after doca_telemetry_netflow_init().

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_ipc_sockets_dir ( const char* path )

Set IPC socket directory. Default path is "/opt/mellanox/doca/services/telemetry/ipc_sockets".

Parameters

path: Path to a folder containing DOCA Telemetry Service (DTS) sockets.

Description

Note:

This function should be called after doca_telemetry_netflow_init().

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_set_max_packet_size ( uint16_t max_packet_size )

Set max packet size.

Parameters

max_packet_size: User defined netflow packet's max size.

Description

Note:

This function should be called after doca_telemetry_netflow_init().

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_source_set_id ( const char* source_id )

Set source id.

Parameters

source_id: Hostname or guid.

Description

Note:

This function should be called after doca_telemetry_netflow_init().

__DOCA_EXPERIMENTAL void doca_telemetry_netflow_source_set_tag ( const char* source_tag )

Set source tag.

Parameters

source_tag: User defined data-file name prefix.

Description

Note:

This function should be called after doca_telemetry_netflow_init().

doca_error_t doca_telemetry_netflow_start ( void )

Finalizes netflow setup.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_BAD_STATE - if the netflow has not been initialized or the netflow has started.
DOCA_ERROR_NO_MEMORY - failed to allocate memory.

Description

doca_error_t doca_telemetry_netflow_template_add_field ( doca_telemetry_netflow_template* netflow_template, doca_telemetry_netflow_flowset_field* field )

Add DOCA telemetry netflow field to netflow_template. The user loses the ownership of the field after a successful invocation of the function.

Parameters

netflow_template: Pointer to netflow_template.
field: DOCA Telemetry netflow field to add.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.
DOCA_ERROR_NO_MEMORY - failed to allocate doca telemetry netflow field.

Description

Note:

field should NOT be passed to another group after calling this function.

doca_error_t doca_telemetry_netflow_template_create ( doca_telemetry_netflow_template** netflow_template )

Create new telemetry netflow template.

Parameters

netflow_template: Pointer to the newly allocated telemetry netflow template.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - NULL parameter.
DOCA_ERROR_NO_MEMORY - failed to allocate doca telemetry netflow template.

Description

doca_error_t doca_telemetry_netflow_template_destroy ( doca_telemetry_netflow_template* netflow_template )

Destructor for DOCA netflow template.

Parameters

netflow_template: netflow template to destroy.

Returns

DOCA_SUCCESS - in case of success. Error code - in case of failure:

DOCA_ERROR_INVALID_VALUE - if netflow_template is NULL.

Description

2.39. Doca Telemetry Netflow

Defines

#define DOCA_TELEMETRY_NETFLOW_ABSOLUTE_ERROR 320
#define DOCA_TELEMETRY_NETFLOW_ADDRESS_POOL_HIGH_THRESHOLD 476
#define DOCA_TELEMETRY_NETFLOW_ADDRESS_POOL_LOW_THRESHOLD 477
#define DOCA_TELEMETRY_NETFLOW_ADDRESS_PORT_MAPPING_HIGH_THRESHOLD 478
#define DOCA_TELEMETRY_NETFLOW_ADDRESS_PORT_MAPPING_LOW_THRESHOLD 479
#define DOCA_TELEMETRY_NETFLOW_ADDRESS_PORT_MAPPING_PER_USER_HIGH_THRESHOLD 480
#define DOCA_TELEMETRY_NETFLOW_ANONYMIZATION_FLAGS 285
#define DOCA_TELEMETRY_NETFLOW_ANONYMIZATION_TECHNIQUE 286
#define DOCA_TELEMETRY_NETFLOW_APPLICATION_CATEGORY_NAME 372
#define DOCA_TELEMETRY_NETFLOW_APPLICATION_DESCRIPTION 94
#define DOCA_TELEMETRY_NETFLOW_APPLICATION_GROUP_NAME 374
#define DOCA_TELEMETRY_NETFLOW_APPLICATION_NAME 96
#define DOCA_TELEMETRY_NETFLOW_APPLICATION_SUB_CATEGORY_NAME 373
#define DOCA_TELEMETRY_NETFLOW_APPLICATION_TAG 95
#define DOCA_TELEMETRY_NETFLOW_BASIC_LIST 291
#define DOCA_TELEMETRY_NETFLOW_BGP_COMMUNITY 483
#define DOCA_TELEMETRY_NETFLOW_BGP_DESTINATION_COMMUNITY_LIST 485
#define DOCA_TELEMETRY_NETFLOW_BGP_DESTINATION_EXTENDED_COMMUNITY_LIST 488
#define DOCA_TELEMETRY_NETFLOW_BGP_EXTENDED_COMMUNITY 486
#define DOCA_TELEMETRY_NETFLOW_BGP_IPV4_NEXT_HOP 18
#define DOCA_TELEMETRY_NETFLOW_BGP_LARGE_COMMUNITY 489
#define DOCA_TELEMETRY_NETFLOW_BGP_NEXT_ADJACENT_AS_NUMBER 128
#define DOCA_TELEMETRY_NETFLOW_BGP_PREV_ADJACENT_AS_NUMBER 129
#define DOCA_TELEMETRY_NETFLOW_BGP_SOURCE_COMMUNITY_LIST 484
#define DOCA_TELEMETRY_NETFLOW_BGP_SOURCE_EXTENDED_COMMUNITY_LIST 487
#define DOCA_TELEMETRY_NETFLOW_BGP_VALIDITY_STATE 294
#define DOCA_TELEMETRY_NETFLOW_BIFLOW_DIRECTION 239
#define DOCA_TELEMETRY_NETFLOW_BPG_IPV6_NEXT_HOP 63
#define DOCA_TELEMETRY_NETFLOW_COLLECTION_TIME_MILLISECONDS 258
#define DOCA_TELEMETRY_NETFLOW_COLLECTOR_CERTIFICATE 274
#define DOCA_TELEMETRY_NETFLOW_COLLECTOR_IPV4_ADDRESS 211
#define DOCA_TELEMETRY_NETFLOW_COLLECTOR_IPV6_ADDRESS 212
#define DOCA_TELEMETRY_NETFLOW_COLLECTOR_TRANSPORT_PORT 216
#define DOCA_TELEMETRY_NETFLOW_COMMON_PROPERTIES_ID 137
#define DOCA_TELEMETRY_NETFLOW_CONFIDENCE_LEVEL 338
#define DOCA_TELEMETRY_NETFLOW_CONNECTION_SUM_DURATION_SECONDS 279
#define DOCA_TELEMETRY_NETFLOW_CONNECTION_TRANSACTION_ID 280
#define DOCA_TELEMETRY_NETFLOW_DATA_LINK_FRAME_SECTION 315
#define DOCA_TELEMETRY_NETFLOW_DATA_LINK_FRAME_SIZE 312
#define DOCA_TELEMETRY_NETFLOW_DATA_LINK_FRAME_TYPE 408
#define DOCA_TELEMETRY_NETFLOW_DATA_RECORDS_RELIABILITY 276
#define DOCA_TELEMETRY_NETFLOW_DESTINATION_IPV6_PREFIX 169
#define DOCA_TELEMETRY_NETFLOW_DIGEST_HASH_VALUE 326
#define DOCA_TELEMETRY_NETFLOW_DIRECTION 61
#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_DESTINATION_IPV4_ADDRESS 381
#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_DESTINATION_IPV6_ADDRESS 383
#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_DESTINATION_IP_ADDRESS 379
#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_SOURCE_IPV4_ADDRESS 380
#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_SOURCE_IPV6_ADDRESS 382
#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_SOURCE_IP_ADDRESS 378
#define DOCA_TELEMETRY_NETFLOW_DOT1Q_CUSTOMER_DEI 389
#define DOCA_TELEMETRY_NETFLOW_DOT1Q_CUSTOMER_DESTINATION_MAC_ADDRESS 415
#define DOCA_TELEMETRY_NETFLOW_DOT1Q_CUSTOMER_PRIORITY 246
#define DOCA_TELEMETRY_NETFLOW_DOT1Q_CUSTOMER_SOURCE_MAC_ADDRESS 414
#define DOCA_TELEMETRY_NETFLOW_DOT1Q_CUSTOMER_VLAN_ID 245
#define DOCA_TELEMETRY_NETFLOW_DOT1Q_DEI 388
#define DOCA_TELEMETRY_NETFLOW_DOT1Q_PRIORITY 244
#define DOCA_TELEMETRY_NETFLOW_DOT1Q_SERVICE_INSTANCE_ID 412
#define DOCA_TELEMETRY_NETFLOW_DOT1Q_SERVICE_INSTANCE_PRIORITY 413
#define DOCA_TELEMETRY_NETFLOW_DOT1Q_SERVICE_INSTANCE_TAG 411
#define DOCA_TELEMETRY_NETFLOW_DOT1Q_VLAN_ID 243
#define DOCA_TELEMETRY_NETFLOW_DROPPED_LAYER2_OCTET_DELTA_COUNT 424
#define DOCA_TELEMETRY_NETFLOW_DROPPED_LAYER2_OCTET_TOTAL_COUNT 425
#define DOCA_TELEMETRY_NETFLOW_DROPPED_OCTET_DELTA_COUNT 132
#define DOCA_TELEMETRY_NETFLOW_DROPPED_OCTET_TOTAL_COUNT 134
#define DOCA_TELEMETRY_NETFLOW_DROPPED_PACKET_DELTA_COUNT 133
#define DOCA_TELEMETRY_NETFLOW_DROPPED_PACKET_TOTAL_COUNT 135
#define DOCA_TELEMETRY_NETFLOW_DST_AS 17
#define DOCA_TELEMETRY_NETFLOW_DST_MASK 13
#define DOCA_TELEMETRY_NETFLOW_DST_TOS 55
#define DOCA_TELEMETRY_NETFLOW_DST_TRAFFIC_INDEX 93
#define DOCA_TELEMETRY_NETFLOW_DST_VLAN 59
#define DOCA_TELEMETRY_NETFLOW_EGRESS_BROADCAST_PACKET_TOTAL_COUNT 358
#define DOCA_TELEMETRY_NETFLOW_EGRESS_INTERFACE_TYPE 369
#define DOCA_TELEMETRY_NETFLOW_EGRESS_PHYSICAL_INTERFACE 253
#define DOCA_TELEMETRY_NETFLOW_EGRESS_UNICAST_PACKET_TOTAL_COUNT 357
#define DOCA_TELEMETRY_NETFLOW_EGRESS_VRFID 235
#define DOCA_TELEMETRY_NETFLOW_ENCRYPTED_TECHNOLOGY 290
#define DOCA_TELEMETRY_NETFLOW_ENGINE_ID 39
#define DOCA_TELEMETRY_NETFLOW_ENGINE_TYPE 38
#define DOCA_TELEMETRY_NETFLOW_ETHERNET_HEADER_LENGTH 240
#define DOCA_TELEMETRY_NETFLOW_ETHERNET_PAYLOAD_LENGTH 241
#define DOCA_TELEMETRY_NETFLOW_ETHERNET_TOTAL_LENGTH 242
#define DOCA_TELEMETRY_NETFLOW_ETHERNET_TYPE 256
#define DOCA_TELEMETRY_NETFLOW_EXPORTER_CERTIFICATE 275
#define DOCA_TELEMETRY_NETFLOW_EXPORTER_IPV4_ADDRESS 130
#define DOCA_TELEMETRY_NETFLOW_EXPORTER_IPV6_ADDRESS 131
#define DOCA_TELEMETRY_NETFLOW_EXPORTER_TRANSPORT_PORT 217
#define DOCA_TELEMETRY_NETFLOW_EXPORTING_PROCESS_ID 144
#define DOCA_TELEMETRY_NETFLOW_EXPORT_INTERFACE 213
#define DOCA_TELEMETRY_NETFLOW_EXPORT_PROTOCOL_VERSION 214
#define DOCA_TELEMETRY_NETFLOW_EXPORT_SCTP_STREAM_ID 259
#define DOCA_TELEMETRY_NETFLOW_EXPORT_TRANSPORT_PROTOCOL 215
#define DOCA_TELEMETRY_NETFLOW_EXTERNAL_ADDRESS_REALM 465
#define DOCA_TELEMETRY_NETFLOW_FIREWALL_EVENT 233
#define DOCA_TELEMETRY_NETFLOW_FIRST_SWITCHED 22
#define DOCA_TELEMETRY_NETFLOW_FLOWS 3
#define DOCA_TELEMETRY_NETFLOW_FLOW_ACTIVE_TIMEOUT 36
#define DOCA_TELEMETRY_NETFLOW_FLOW_DURATION_MICROSECONDS 162
#define DOCA_TELEMETRY_NETFLOW_FLOW_DURATION_MILLISECONDS 161
#define DOCA_TELEMETRY_NETFLOW_FLOW_END_DELTA_MICROSECONDS 159
#define DOCA_TELEMETRY_NETFLOW_FLOW_END_MICROSECONDS 155
#define DOCA_TELEMETRY_NETFLOW_FLOW_END_MILLISECONDS 153
#define DOCA_TELEMETRY_NETFLOW_FLOW_END_NANOSECONDS 157
#define DOCA_TELEMETRY_NETFLOW_FLOW_END_REASON 136
#define DOCA_TELEMETRY_NETFLOW_FLOW_END_SECONDS 151
#define DOCA_TELEMETRY_NETFLOW_FLOW_ID 148
#define DOCA_TELEMETRY_NETFLOW_FLOW_INACTIVE_TIMEOUT 37
#define DOCA_TELEMETRY_NETFLOW_FLOW_KEY_INDICATOR 173
#define DOCA_TELEMETRY_NETFLOW_FLOW_SAMPLER_ID 48
#define DOCA_TELEMETRY_NETFLOW_FLOW_SAMPLER_MODE 49
#define DOCA_TELEMETRY_NETFLOW_FLOW_SAMPLER_RANDOM_INTERVAL 50
#define DOCA_TELEMETRY_NETFLOW_FLOW_SAMPLING_TIME_INTERVAL 398
#define DOCA_TELEMETRY_NETFLOW_FLOW_SAMPLING_TIME_SPACING 399
#define DOCA_TELEMETRY_NETFLOW_FLOW_SELECTED_FLOW_DELTA_COUNT 393
#define DOCA_TELEMETRY_NETFLOW_FLOW_SELECTED_OCTET_DELTA_COUNT 391
#define DOCA_TELEMETRY_NETFLOW_FLOW_SELECTED_PACKET_DELTA_COUNT 392
#define DOCA_TELEMETRY_NETFLOW_FLOW_SELECTOR_ALGORITHM 390
#define DOCA_TELEMETRY_NETFLOW_FLOW_START_DELTA_MICROSECONDS 158
#define DOCA_TELEMETRY_NETFLOW_FLOW_START_MICROSECONDS 154
#define DOCA_TELEMETRY_NETFLOW_FLOW_START_MILLISECONDS 152
#define DOCA_TELEMETRY_NETFLOW_FLOW_START_NANOSECONDS 156
#define DOCA_TELEMETRY_NETFLOW_FLOW_START_SECONDS 150
#define DOCA_TELEMETRY_NETFLOW_FORWARDING_STATUS 89
#define DOCA_TELEMETRY_NETFLOW_FRAGMENT_FLAGS 197
#define DOCA_TELEMETRY_NETFLOW_FRAGMENT_OFFSET 88
#define DOCA_TELEMETRY_NETFLOW_GLOBAL_ADDRESS_MAPPING_HIGH_THRESHOLD 481
#define DOCA_TELEMETRY_NETFLOW_GRE_KEY 296
#define DOCA_TELEMETRY_NETFLOW_HASH_DIGEST_OUTPUT 333
#define DOCA_TELEMETRY_NETFLOW_HASH_FLOW_DOMAIN 400
#define DOCA_TELEMETRY_NETFLOW_HASH_INITIALIZER_VALUE 334
#define DOCA_TELEMETRY_NETFLOW_HASH_IPPAYLOAD_OFFSET 327
#define DOCA_TELEMETRY_NETFLOW_HASH_IPPAYLOAD_SIZE 328
#define DOCA_TELEMETRY_NETFLOW_HASH_OUTPUT_RANGE_MAX 330
#define DOCA_TELEMETRY_NETFLOW_HASH_OUTPUT_RANGE_MIN 329
#define DOCA_TELEMETRY_NETFLOW_HASH_SELECTED_RANGE_MAX 332
#define DOCA_TELEMETRY_NETFLOW_HASH_SELECTED_RANGE_MIN 331
#define DOCA_TELEMETRY_NETFLOW_HTTP_CONTENT_TYPE 469
#define DOCA_TELEMETRY_NETFLOW_HTTP_MESSAGE_VERSION 462
#define DOCA_TELEMETRY_NETFLOW_HTTP_REASON_PHRASE 470
#define DOCA_TELEMETRY_NETFLOW_HTTP_REQUEST_HOST 460
#define DOCA_TELEMETRY_NETFLOW_HTTP_REQUEST_METHOD 459
#define DOCA_TELEMETRY_NETFLOW_HTTP_REQUEST_TARGET 461
#define DOCA_TELEMETRY_NETFLOW_HTTP_STATUS_CODE 457
#define DOCA_TELEMETRY_NETFLOW_HTTP_USER_AGENT 468
#define DOCA_TELEMETRY_NETFLOW_ICMP_CODE_IPV4 177
#define DOCA_TELEMETRY_NETFLOW_ICMP_CODE_IPV6 179
#define DOCA_TELEMETRY_NETFLOW_ICMP_TYPE 32
#define DOCA_TELEMETRY_NETFLOW_ICMP_TYPE_CODE_IPV6 139
#define DOCA_TELEMETRY_NETFLOW_ICMP_TYPE_IPV4 176
#define DOCA_TELEMETRY_NETFLOW_ICMP_TYPE_IPV6 178
#define DOCA_TELEMETRY_NETFLOW_IF_DESC 83
#define DOCA_TELEMETRY_NETFLOW_IF_NAME 82
#define DOCA_TELEMETRY_NETFLOW_IGNORED_DATA_RECORD_TOTAL_COUNT 407
#define DOCA_TELEMETRY_NETFLOW_IGNORED_LAYER2_FRAME_TOTAL_COUNT 433
#define DOCA_TELEMETRY_NETFLOW_IGNORED_LAYER2_OCTET_TOTAL_COUNT 426
#define DOCA_TELEMETRY_NETFLOW_IGNORED_OCTET_TOTAL_COUNT 165
#define DOCA_TELEMETRY_NETFLOW_IGNORED_PACKET_TOTAL_COUNT 164
#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_DATA_TYPE 339
#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_DESCRIPTION 340
#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_ID 303
#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_INDEX 287
#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_NAME 341
#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_RANGE_BEGIN 342
#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_RANGE_END 343
#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_SEMANTICS 344
#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_UNITS 345
#define DOCA_TELEMETRY_NETFLOW_INGRESS_BROADCAST_PACKET_TOTAL_COUNT 356
#define DOCA_TELEMETRY_NETFLOW_INGRESS_INTERFACE_TYPE 368
#define DOCA_TELEMETRY_NETFLOW_INGRESS_MULTICAST_PACKET_TOTAL_COUNT 355
#define DOCA_TELEMETRY_NETFLOW_INGRESS_PHYSICAL_INTERFACE 252
#define DOCA_TELEMETRY_NETFLOW_INGRESS_UNICAST_PACKET_TOTAL_COUNT 354
#define DOCA_TELEMETRY_NETFLOW_INGRESS_VRFID 234
#define DOCA_TELEMETRY_NETFLOW_INITIATOR_OCTETS 231
#define DOCA_TELEMETRY_NETFLOW_INITIATOR_PACKETS 298
#define DOCA_TELEMETRY_NETFLOW_INPUT_SNMP 10
#define DOCA_TELEMETRY_NETFLOW_INTERMEDIATE_PROCESS_ID 406
#define DOCA_TELEMETRY_NETFLOW_INTERNAL_ADDRESS_REALM 464
#define DOCA_TELEMETRY_NETFLOW_IN_BYTES 1
#define DOCA_TELEMETRY_NETFLOW_IN_DST_MAC 80
#define DOCA_TELEMETRY_NETFLOW_IN_PERMANENT_BYTES 85
#define DOCA_TELEMETRY_NETFLOW_IN_PERMANENT_PKTS 86
#define DOCA_TELEMETRY_NETFLOW_IN_PKTS 2
#define DOCA_TELEMETRY_NETFLOW_IN_SRC_MAC 56
#define DOCA_TELEMETRY_NETFLOW_IPSEC_SPI 295
#define DOCA_TELEMETRY_NETFLOW_IPV4_DST_ADDR 12
#define DOCA_TELEMETRY_NETFLOW_IPV4_DST_PREFIX 45
#define DOCA_TELEMETRY_NETFLOW_IPV4_IDENT 54
#define DOCA_TELEMETRY_NETFLOW_IPV4_IHL 207
#define DOCA_TELEMETRY_NETFLOW_IPV4_NEXT_HOP 15
#define DOCA_TELEMETRY_NETFLOW_IPV4_OPTIONS 208
#define DOCA_TELEMETRY_NETFLOW_IPV4_SRC_ADDR 8
#define DOCA_TELEMETRY_NETFLOW_IPV4_SRC_PREFIX 44
#define DOCA_TELEMETRY_NETFLOW_IPV6_DST_ADDR 28
#define DOCA_TELEMETRY_NETFLOW_IPV6_DST_MASK 30
#define DOCA_TELEMETRY_NETFLOW_IPV6_FLOW_LABEL 31
#define DOCA_TELEMETRY_NETFLOW_IPV6_NEXT_HOP 62
#define DOCA_TELEMETRY_NETFLOW_IPV6_OPTION_HEADERS 64
#define DOCA_TELEMETRY_NETFLOW_IPV6_SRC_ADDR 27
#define DOCA_TELEMETRY_NETFLOW_IPV6_SRC_MASK 29
#define DOCA_TELEMETRY_NETFLOW_IP_DIFF_SERV_CODE_POINT 195
#define DOCA_TELEMETRY_NETFLOW_IP_HEADER_LENGTH 189
#define DOCA_TELEMETRY_NETFLOW_IP_HEADER_PACKET_SECTION 313
#define DOCA_TELEMETRY_NETFLOW_IP_PAYLOAD_LENGTH 204
#define DOCA_TELEMETRY_NETFLOW_IP_PAYLOAD_PACKET_SECTION 314
#define DOCA_TELEMETRY_NETFLOW_IP_PRECEDENCE 196
#define DOCA_TELEMETRY_NETFLOW_IP_PROTOCOL_VERSION 60
#define DOCA_TELEMETRY_NETFLOW_IP_TOTAL_LENGTH 224
#define DOCA_TELEMETRY_NETFLOW_IP_TTL 192
#define DOCA_TELEMETRY_NETFLOW_IS_MULTICAST 206
#define DOCA_TELEMETRY_NETFLOW_L4_DST_PORT 11
#define DOCA_TELEMETRY_NETFLOW_L4_SRC_PORT 7
#define DOCA_TELEMETRY_NETFLOW_LAST_SWITCHED 21
#define DOCA_TELEMETRY_NETFLOW_LAYER2_FRAME_DELTA_COUNT 430
#define DOCA_TELEMETRY_NETFLOW_LAYER2_FRAME_TOTAL_COUNT 431
#define DOCA_TELEMETRY_NETFLOW_LAYER2_OCTET_DELTA_COUNT 352
#define DOCA_TELEMETRY_NETFLOW_LAYER2_OCTET_DELTA_SUM_OF_SQUARES 428
#define DOCA_TELEMETRY_NETFLOW_LAYER2_OCTET_TOTAL_COUNT 353
#define DOCA_TELEMETRY_NETFLOW_LAYER2_OCTET_TOTAL_SUM_OF_SQUARES 429
#define DOCA_TELEMETRY_NETFLOW_LAYER2_SEGMENT_ID 351
#define DOCA_TELEMETRY_NETFLOW_LAYER_2_PACKET_SECTION_DATA 104
#define DOCA_TELEMETRY_NETFLOW_LAYER_2_PACKET_SECTION_OFFSET 102
#define DOCA_TELEMETRY_NETFLOW_LAYER_2_PACKET_SECTION_SIZE 103
#define DOCA_TELEMETRY_NETFLOW_LINE_CARD_ID 141
#define DOCA_TELEMETRY_NETFLOW_LOWER_CILIMIT 337
#define DOCA_TELEMETRY_NETFLOW_MAX_BIBENTRIES 472
#define DOCA_TELEMETRY_NETFLOW_MAX_ENTRIES_PER_USER 473
#define DOCA_TELEMETRY_NETFLOW_MAX_EXPORT_SECONDS 260
#define DOCA_TELEMETRY_NETFLOW_MAX_FLOW_END_MICROSECONDS 268
#define DOCA_TELEMETRY_NETFLOW_MAX_FLOW_END_MILLISECONDS 269
#define DOCA_TELEMETRY_NETFLOW_MAX_FLOW_END_NANOSECONDS 270
#define DOCA_TELEMETRY_NETFLOW_MAX_FLOW_END_SECONDS 261
#define DOCA_TELEMETRY_NETFLOW_MAX_FRAGMENTS_PENDING_REASSEMBLY 475
#define DOCA_TELEMETRY_NETFLOW_MAX_LAYER2_TOTAL_LENGTH 423
#define DOCA_TELEMETRY_NETFLOW_MAX_PKT_LENGTH 26
#define DOCA_TELEMETRY_NETFLOW_MAX_SESSION_ENTRIES 471
#define DOCA_TELEMETRY_NETFLOW_MAX_SUBSCRIBERS 474
#define DOCA_TELEMETRY_NETFLOW_MAX_TTL 53
#define DOCA_TELEMETRY_NETFLOW_MESSAGE_MD5_CHECKSUM 262
#define DOCA_TELEMETRY_NETFLOW_MESSAGE_SCOPE 263
#define DOCA_TELEMETRY_NETFLOW_METERING_PROCESS_ID 143
#define DOCA_TELEMETRY_NETFLOW_METRO_EVC_ID 247
#define DOCA_TELEMETRY_NETFLOW_METRO_EVC_TYPE 248
#define DOCA_TELEMETRY_NETFLOW_MIB_CAPTURE_TIME_SEMANTICS 448
#define DOCA_TELEMETRY_NETFLOW_MIB_CONTEXT_ENGINE_ID 449
#define DOCA_TELEMETRY_NETFLOW_MIB_CONTEXT_NAME 450
#define DOCA_TELEMETRY_NETFLOW_MIB_INDEX_INDICATOR 447
#define DOCA_TELEMETRY_NETFLOW_MIB_MODULE_NAME 454
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_DESCRIPTION 452
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_IDENTIFIER 445
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_NAME 451
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_SYNTAX 453
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_BITS 437
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_COUNTER 439
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_GAUGE 440
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_INTEGER 434
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_IPADDRESS 438
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_OCTET_STRING 435
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_OID 436
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_ROW 444
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_TABLE 443
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_TIME_TICKS 441
#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_UNSIGNED 442
#define DOCA_TELEMETRY_NETFLOW_MIB_SUB_IDENTIFIER 446
#define DOCA_TELEMETRY_NETFLOW_MIN_EXPORT_SECONDS 264
#define DOCA_TELEMETRY_NETFLOW_MIN_FLOW_START_MICROSECONDS 271
#define DOCA_TELEMETRY_NETFLOW_MIN_FLOW_START_MILLISECONDS 272
#define DOCA_TELEMETRY_NETFLOW_MIN_FLOW_START_NANOSECONDS 273
#define DOCA_TELEMETRY_NETFLOW_MIN_FLOW_START_SECONDS 265
#define DOCA_TELEMETRY_NETFLOW_MIN_LAYER2_TOTAL_LENGTH 422
#define DOCA_TELEMETRY_NETFLOW_MIN_PKT_LENGTH 25
#define DOCA_TELEMETRY_NETFLOW_MIN_TTL 52
#define DOCA_TELEMETRY_NETFLOW_MOBILE_IMSI 455
#define DOCA_TELEMETRY_NETFLOW_MOBILE_MSISDN 456
#define DOCA_TELEMETRY_NETFLOW_MONITORING_INTERVAL_END_MILLI_SECONDS 360
#define DOCA_TELEMETRY_NETFLOW_MONITORING_INTERVAL_START_MILLI_SECONDS 359
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_1 70
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_10 79
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_2 71
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_3 72
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_4 73
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_5 74
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_6 75
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_7 76
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_8 77
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_9 78
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_STACK_DEPTH 202
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_STACK_LENGTH 201
#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_STACK_SECTION 316
#define DOCA_TELEMETRY_NETFLOW_MPLS_PAL_RD 90
#define DOCA_TELEMETRY_NETFLOW_MPLS_PAYLOAD_LENGTH 194
#define DOCA_TELEMETRY_NETFLOW_MPLS_PAYLOAD_PACKET_SECTION 317
#define DOCA_TELEMETRY_NETFLOW_MPLS_PREFIX_LEN 91
#define DOCA_TELEMETRY_NETFLOW_MPLS_TOP_LABEL_EXP 203
#define DOCA_TELEMETRY_NETFLOW_MPLS_TOP_LABEL_IPV6_ADDRESS 140
#define DOCA_TELEMETRY_NETFLOW_MPLS_TOP_LABEL_IP_ADDR 47
#define DOCA_TELEMETRY_NETFLOW_MPLS_TOP_LABEL_TTL 200
#define DOCA_TELEMETRY_NETFLOW_MPLS_TOP_LABEL_TYPE 46
#define DOCA_TELEMETRY_NETFLOW_MUL_DST_BYTES 20
#define DOCA_TELEMETRY_NETFLOW_MUL_DST_PKTS 19
#define DOCA_TELEMETRY_NETFLOW_MUL_IGMP_TYPE 33
#define DOCA_TELEMETRY_NETFLOW_NAT_EVENT 230
#define DOCA_TELEMETRY_NETFLOW_NAT_INSTANCE_ID 463
#define DOCA_TELEMETRY_NETFLOW_NAT_ORIGINATING_ADDRESS_REALM 229
#define DOCA_TELEMETRY_NETFLOW_NAT_POOL_ID 283
#define DOCA_TELEMETRY_NETFLOW_NAT_POOL_NAME 284
#define DOCA_TELEMETRY_NETFLOW_NAT_QUOTA_EXCEEDED_EVENT 466
#define DOCA_TELEMETRY_NETFLOW_NAT_THRESHOLD_EVENT 467
#define DOCA_TELEMETRY_NETFLOW_NAT_TYPE 297
#define DOCA_TELEMETRY_NETFLOW_NEW_CONNECTION_DELTA_COUNT 278
#define DOCA_TELEMETRY_NETFLOW_NEXT_HEADER_IPV6 193
#define DOCA_TELEMETRY_NETFLOW_NOT_SENT_FLOW_TOTAL_COUNT 166
#define DOCA_TELEMETRY_NETFLOW_NOT_SENT_LAYER2_OCTET_TOTAL_COUNT 427
#define DOCA_TELEMETRY_NETFLOW_NOT_SENT_OCTET_TOTAL_COUNT 168
#define DOCA_TELEMETRY_NETFLOW_NOT_SENT_PACKET_TOTAL_COUNT 167
#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_DOMAIN_ID 149
#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_DOMAIN_NAME 300
#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_POINT_ID 138
#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_POINT_TYPE 277
#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_TIME_MICROSECONDS 324
#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_TIME_MILLISECONDS 323
#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_TIME_NANOSECONDS 325
#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_TIME_SECONDS 322
#define DOCA_TELEMETRY_NETFLOW_OBSERVED_FLOW_TOTAL_COUNT 163
#define DOCA_TELEMETRY_NETFLOW_OCTET_DELTA_SUM_OF_SQUARES 198
#define DOCA_TELEMETRY_NETFLOW_OCTET_TOTAL_SUM_OF_SQUARES 199
#define DOCA_TELEMETRY_NETFLOW_OPAQUE_OCTETS 266
#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_EXPORTER_IPV4_ADDRESS 403
#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_EXPORTER_IPV6_ADDRESS 404
#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_FLOWS_COMPLETED 377
#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_FLOWS_INITIATED 376
#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_FLOWS_PRESENT 375
#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_OBSERVATION_DOMAIN_ID 405
#define DOCA_TELEMETRY_NETFLOW_OUTPUT_SNMP 14
#define DOCA_TELEMETRY_NETFLOW_OUT_BYTES 23
#define DOCA_TELEMETRY_NETFLOW_OUT_DST_MAC 57
#define DOCA_TELEMETRY_NETFLOW_OUT_PKTS 24
#define DOCA_TELEMETRY_NETFLOW_OUT_SRC_MAC 81
#define DOCA_TELEMETRY_NETFLOW_P2P_TECHNOLOGY 288
#define DOCA_TELEMETRY_NETFLOW_PADDING_OCTETS 210
#define DOCA_TELEMETRY_NETFLOW_PAYLOAD_LENGTH_IPV6 191
#define DOCA_TELEMETRY_NETFLOW_PORT_ID 142
#define DOCA_TELEMETRY_NETFLOW_PORT_RANGE_END 362
#define DOCA_TELEMETRY_NETFLOW_PORT_RANGE_NUM_PORTS 364
#define DOCA_TELEMETRY_NETFLOW_PORT_RANGE_START 361
#define DOCA_TELEMETRY_NETFLOW_PORT_RANGE_STEP_SIZE 363
#define DOCA_TELEMETRY_NETFLOW_POSTIP_DIFF_SERV_CODE_POINT 98
#define DOCA_TELEMETRY_NETFLOW_POST_DOT1Q_CUSTOMER_VLAN_ID 255
#define DOCA_TELEMETRY_NETFLOW_POST_DOT1Q_VLAN_ID 254
#define DOCA_TELEMETRY_NETFLOW_POST_IP_PRECEDENCE 257
#define DOCA_TELEMETRY_NETFLOW_POST_LAYER2_OCTET_DELTA_COUNT 417
#define DOCA_TELEMETRY_NETFLOW_POST_LAYER2_OCTET_TOTAL_COUNT 420
#define DOCA_TELEMETRY_NETFLOW_POST_MCAST_LAYER2_OCTET_DELTA_COUNT 418
#define DOCA_TELEMETRY_NETFLOW_POST_MCAST_LAYER2_OCTET_TOTAL_COUNT 421
#define DOCA_TELEMETRY_NETFLOW_POST_MCAST_OCTET_TOTAL_COUNT 175
#define DOCA_TELEMETRY_NETFLOW_POST_MCAST_PACKET_TOTAL_COUNT 174
#define DOCA_TELEMETRY_NETFLOW_POST_MPLS_TOP_LABEL_EXP 237
#define DOCA_TELEMETRY_NETFLOW_POST_NAPT_DESTINATION_TRANSPORT_PORT 228
#define DOCA_TELEMETRY_NETFLOW_POST_NAPT_SOURCE_TRANSPORT_PORT 227
#define DOCA_TELEMETRY_NETFLOW_POST_NATDESTINATION_IPV6_ADDRESS 282
#define DOCA_TELEMETRY_NETFLOW_POST_NATSOURCE_IPV6_ADDRESS 281
#define DOCA_TELEMETRY_NETFLOW_POST_NAT_DESTINATION_IPV4_ADDRESS 226
#define DOCA_TELEMETRY_NETFLOW_POST_NAT_SOURCE_IPV4_ADDRESS 225
#define DOCA_TELEMETRY_NETFLOW_POST_OCTET_TOTAL_COUNT 171
#define DOCA_TELEMETRY_NETFLOW_POST_PACKET_TOTAL_COUNT 172
#define DOCA_TELEMETRY_NETFLOW_PRIVATE_ENTERPRISE_NUMBER 346
#define DOCA_TELEMETRY_NETFLOW_PROTOCOL 4
#define DOCA_TELEMETRY_NETFLOW_PSEUDO_WIRE_CONTROL_WORD 251
#define DOCA_TELEMETRY_NETFLOW_PSEUDO_WIRE_DESTINATION_IPV4_ADDRESS 432
#define DOCA_TELEMETRY_NETFLOW_PSEUDO_WIRE_ID 249
#define DOCA_TELEMETRY_NETFLOW_PSEUDO_WIRE_TYPE 250
#define DOCA_TELEMETRY_NETFLOW_RELATIVE_ERROR 321
#define DOCA_TELEMETRY_NETFLOW_REPLICATION_FACTOR 99
#define DOCA_TELEMETRY_NETFLOW_RESPONDER_OCTETS 232
#define DOCA_TELEMETRY_NETFLOW_RESPONDER_PACKETS 299
#define DOCA_TELEMETRY_NETFLOW_RFC3550_JITTER_MICROSECONDS 386
#define DOCA_TELEMETRY_NETFLOW_RFC3550_JITTER_MILLISECONDS 385
#define DOCA_TELEMETRY_NETFLOW_RFC3550_JITTER_NANOSECONDS 387
#define DOCA_TELEMETRY_NETFLOW_RTP_SEQUENCE_NUMBER 370
#define DOCA_TELEMETRY_NETFLOW_SAMPLER_NAME 84
#define DOCA_TELEMETRY_NETFLOW_SAMPLING_ALGORITHM 35
#define DOCA_TELEMETRY_NETFLOW_SAMPLING_FLOW_INTERVAL 396
#define DOCA_TELEMETRY_NETFLOW_SAMPLING_FLOW_SPACING 397
#define DOCA_TELEMETRY_NETFLOW_SAMPLING_INTERVAL 34
#define DOCA_TELEMETRY_NETFLOW_SAMPLING_PACKET_INTERVAL 305
#define DOCA_TELEMETRY_NETFLOW_SAMPLING_PACKET_SPACE 306
#define DOCA_TELEMETRY_NETFLOW_SAMPLING_POPULATION 310
#define DOCA_TELEMETRY_NETFLOW_SAMPLING_PROBABILITY 311
#define DOCA_TELEMETRY_NETFLOW_SAMPLING_SIZE 309
#define DOCA_TELEMETRY_NETFLOW_SAMPLING_TIME_INTERVAL 307
#define DOCA_TELEMETRY_NETFLOW_SAMPLING_TIME_SPACE 308
#define DOCA_TELEMETRY_NETFLOW_SECTION_EXPORTED_OCTETS 410
#define DOCA_TELEMETRY_NETFLOW_SECTION_OFFSET 409
#define DOCA_TELEMETRY_NETFLOW_SELECTION_SEQUENCE_ID 301
#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ALGORITHM 304
#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ID 302
#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ID_TOTAL_FLOWS_OBSERVED 394
#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ID_TOTAL_FLOWS_SELECTED 395
#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ID_TOTAL_PKTS_OBSERVED 318
#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ID_TOTAL_PKTS_SELECTED 319
#define DOCA_TELEMETRY_NETFLOW_SELECTOR_NAME 335
#define DOCA_TELEMETRY_NETFLOW_SESSION_SCOPE 267
#define DOCA_TELEMETRY_NETFLOW_SOURCE_IPV6_PREFIX 170
#define DOCA_TELEMETRY_NETFLOW_SOURCE_TRANSPORT_PORTS_LIMIT 458
#define DOCA_TELEMETRY_NETFLOW_SRC_AS 16
#define DOCA_TELEMETRY_NETFLOW_SRC_MASK 9
#define DOCA_TELEMETRY_NETFLOW_SRC_TOS 5
#define DOCA_TELEMETRY_NETFLOW_SRC_TRAFFIC_INDEX 92
#define DOCA_TELEMETRY_NETFLOW_SRC_VLAN 58
#define DOCA_TELEMETRY_NETFLOW_STA_IPV4_ADDRESS 366
#define DOCA_TELEMETRY_NETFLOW_STA_MAC_ADDRESS 365
#define DOCA_TELEMETRY_NETFLOW_SUB_TEMPLATE_LIST 292
#define DOCA_TELEMETRY_NETFLOW_SUB_TEMPLATE_MULTI_LIST 293
#define DOCA_TELEMETRY_NETFLOW_SYSTEM_INIT_TIME_MILLISECONDS 160
#define DOCA_TELEMETRY_NETFLOW_TCP_ACKNOWLEDGMENT_NUMBER 185
#define DOCA_TELEMETRY_NETFLOW_TCP_ACK_TOTAL_COUNT 222
#define DOCA_TELEMETRY_NETFLOW_TCP_DESTINATION_PORT 183
#define DOCA_TELEMETRY_NETFLOW_TCP_FIN_TOTAL_COUNT 219
#define DOCA_TELEMETRY_NETFLOW_TCP_FLAGS 6
#define DOCA_TELEMETRY_NETFLOW_TCP_HEADER_LENGTH 188
#define DOCA_TELEMETRY_NETFLOW_TCP_OPTIONS 209
#define DOCA_TELEMETRY_NETFLOW_TCP_PSH_TOTAL_COUNT 221
#define DOCA_TELEMETRY_NETFLOW_TCP_RST_TOTAL_COUNT 220
#define DOCA_TELEMETRY_NETFLOW_TCP_SEQUENCE_NUMBER 184
#define DOCA_TELEMETRY_NETFLOW_TCP_SOURCE_PORT 182
#define DOCA_TELEMETRY_NETFLOW_TCP_SYN_TOTAL_COUNT 218
#define DOCA_TELEMETRY_NETFLOW_TCP_URGENT_POINTER 187
#define DOCA_TELEMETRY_NETFLOW_TCP_URG_TOTAL_COUNT 223
#define DOCA_TELEMETRY_NETFLOW_TCP_WINDOW_SCALE 238
#define DOCA_TELEMETRY_NETFLOW_TCP_WINDOW_SIZE 186
#define DOCA_TELEMETRY_NETFLOW_TEMPLATE_ID 145
#define DOCA_TELEMETRY_NETFLOW_TOTAL_BYTES_EXP 40
#define DOCA_TELEMETRY_NETFLOW_TOTAL_FLOWS_EXP 42
#define DOCA_TELEMETRY_NETFLOW_TOTAL_LENGTH_IPV4 190
#define DOCA_TELEMETRY_NETFLOW_TOTAL_PKTS_EXP 41
#define DOCA_TELEMETRY_NETFLOW_TRANSPORT_OCTET_DELTA_COUNT 401
#define DOCA_TELEMETRY_NETFLOW_TRANSPORT_PACKET_DELTA_COUNT 402
#define DOCA_TELEMETRY_NETFLOW_TUNNEL_TECHNOLOGY 289
#define DOCA_TELEMETRY_NETFLOW_UDP_DESTINATION_PORT 181
#define DOCA_TELEMETRY_NETFLOW_UDP_MESSAGE_LENGTH 205
#define DOCA_TELEMETRY_NETFLOW_UDP_SOURCE_PORT 180
#define DOCA_TELEMETRY_NETFLOW_UPPER_CILIMIT 336
#define DOCA_TELEMETRY_NETFLOW_USER_NAME 371
#define DOCA_TELEMETRY_NETFLOW_VALUE_DISTRIBUTION_METHOD 384
#define DOCA_TELEMETRY_NETFLOW_VIRTUAL_STATION_INTERFACE_ID 347
#define DOCA_TELEMETRY_NETFLOW_VIRTUAL_STATION_INTERFACE_NAME 348
#define DOCA_TELEMETRY_NETFLOW_VIRTUAL_STATION_NAME 350
#define DOCA_TELEMETRY_NETFLOW_VIRTUAL_STATION_UUID 349
#define DOCA_TELEMETRY_NETFLOW_VPN_IDENTIFIER 482
#define DOCA_TELEMETRY_NETFLOW_VRF_NAME 236
#define DOCA_TELEMETRY_NETFLOW_WLAN_CHANNEL_ID 146
#define DOCA_TELEMETRY_NETFLOW_WLAN_SSID 147
#define DOCA_TELEMETRY_NETFLOW_WTP_MAC_ADDRESS 367

Defines

#define DOCA_TELEMETRY_NETFLOW_ABSOLUTE_ERROR 320

This Information Element specifies the maximum possible measurement error of the reported value for a given Information Element. The absoluteError has the same unit as the Information Element with which it is associated. The real value of the metric can differ by absoluteError (positive or negative) from the measured value.

#define DOCA_TELEMETRY_NETFLOW_ADDRESS_POOL_HIGH_THRESHOLD 476

This element represents the high threshold value of the number of public IP addresses in the address pool.

#define DOCA_TELEMETRY_NETFLOW_ADDRESS_POOL_LOW_THRESHOLD 477

This element represents the low threshold value of the number of public IP addresses in the address pool.

#define DOCA_TELEMETRY_NETFLOW_ADDRESS_PORT_MAPPING_HIGH_THRESHOLD 478

This element represents the high threshold value of the number of address and port mappings.

#define DOCA_TELEMETRY_NETFLOW_ADDRESS_PORT_MAPPING_LOW_THRESHOLD 479

This element represents the low threshold value of the number of address and port mappings.

#define DOCA_TELEMETRY_NETFLOW_ADDRESS_PORT_MAPPING_PER_USER_HIGH_THRESHOLD 480

This element represents the high threshold value of the number of address and port mappings that a single user is allowed to create on a NAT device.

#define DOCA_TELEMETRY_NETFLOW_ANONYMIZATION_FLAGS 285

A flag word describing specialized modifications to the anonymization policy in effect for the anonymization technique applied to a referenced Information Element within a referenced Template. When flags are clear (0), the normal policy (as described by anonymizationTechnique) applies without modification.

#define DOCA_TELEMETRY_NETFLOW_ANONYMIZATION_TECHNIQUE 286

A description of the anonymization technique applied to a referenced Information Element within a referenced Template. Each technique may be applicable only to certain Information Elements and recommended only for certain Information Elements. Values are listed in the anonymizationTechnique registry. See [http://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-anonymization-technique].

#define DOCA_TELEMETRY_NETFLOW_APPLICATION_CATEGORY_NAME 372

An attribute that provides a first level categorization for each Application ID.

#define DOCA_TELEMETRY_NETFLOW_APPLICATION_DESCRIPTION 94

Application description.

#define DOCA_TELEMETRY_NETFLOW_APPLICATION_GROUP_NAME 374

An attribute that groups multiple Application IDs that belong to the same networking application.

#define DOCA_TELEMETRY_NETFLOW_APPLICATION_NAME 96

Name associated with a classification.

#define DOCA_TELEMETRY_NETFLOW_APPLICATION_SUB_CATEGORY_NAME 373

An attribute that provides a second level categorization for each Application ID.

#define DOCA_TELEMETRY_NETFLOW_APPLICATION_TAG 95

8 bits of engine ID, followed by n bits of classification.

#define DOCA_TELEMETRY_NETFLOW_BASIC_LIST 291

Specifies a generic Information Element with a basicList abstract data type. For example, a list of port numbers, a list of interface indexes, etc.

#define DOCA_TELEMETRY_NETFLOW_BGP_COMMUNITY 483

BGP community as defined in [RFC1997]

#define DOCA_TELEMETRY_NETFLOW_BGP_DESTINATION_COMMUNITY_LIST 485

basicList of zero or more bgpCommunity IEs, containing the BGP communities corresponding with destination IP address of a specific flow

#define DOCA_TELEMETRY_NETFLOW_BGP_DESTINATION_EXTENDED_COMMUNITY_LIST 488

basicList of zero or more bgpExtendedCommunity IEs, containing the BGP Extended Communities corresponding with destination IP address of a specific flow

#define DOCA_TELEMETRY_NETFLOW_BGP_EXTENDED_COMMUNITY 486

BGP Extended Community as defined in [RFC4360]; the size of this IE MUST be 8 octets

#define DOCA_TELEMETRY_NETFLOW_BGP_IPV4_NEXT_HOP 18

Next-hop router's IP in the BGP domain

#define DOCA_TELEMETRY_NETFLOW_BGP_LARGE_COMMUNITY 489

BGP Large Community as defined in [RFC8092]; the size of this IE MUST be 12 octets.

#define DOCA_TELEMETRY_NETFLOW_BGP_NEXT_ADJACENT_AS_NUMBER 128

The autonomous system (AS) number of the first AS in the AS path to the destination IP address. The path is deduced by looking up the destination IP address of the Flow in the BGP routing information base. If AS path information for this Flow is only available as an unordered AS set (and not as an ordered AS sequence), then the value of this Information Element is 0.

#define DOCA_TELEMETRY_NETFLOW_BGP_PREV_ADJACENT_AS_NUMBER 129

The autonomous system (AS) number of the last AS in the AS path from the source IP address. The path is deduced by looking up the source IP address of the Flow in the BGP routing information base. If AS path information for this Flow is only available as an unordered AS set (and not as an ordered AS sequence), then the value of this Information Element is 0. In case of BGP asymmetry, the bgpPrevAdjacentAsNumber might not be able to report the correct value.

#define DOCA_TELEMETRY_NETFLOW_BGP_SOURCE_COMMUNITY_LIST 484

basicList of zero or more bgpCommunity IEs, containing the BGP communities corresponding with source IP address of a specific flow

#define DOCA_TELEMETRY_NETFLOW_BGP_SOURCE_EXTENDED_COMMUNITY_LIST 487

basicList of zero or more bgpExtendedCommunity IEs, containing the BGP Extended Communities corresponding with source IP address of a specific flow

#define DOCA_TELEMETRY_NETFLOW_BGP_VALIDITY_STATE 294

This element describes the "validity state" of the BGP route correspondent source or destination IP address. If the "validity state" for this Flow is only available, then the value of this Information Element is 255.

#define DOCA_TELEMETRY_NETFLOW_BIFLOW_DIRECTION 239

A description of the direction assignment method used to assign the Biflow Source and Destination. This Information Element MAY be present in a Flow Data Record, or applied to all flows exported from an Exporting Process or Observation Domain using IPFIX Options. If this Information Element is not present in a Flow Record or associated with a Biflow via scope, it is assumed that the configuration of the direction assignment method is done out-of-band. Note that when using IPFIX Options to apply this Information Element to all flows within an Observation Domain or from an Exporting Process, the Option SHOULD be sent reliably. If reliable transport is not available (i.e., when using UDP), this Information Element SHOULD appear in each Flow Record. Values are listed in the biflowDirection registry. See [http://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-biflow-direction].

#define DOCA_TELEMETRY_NETFLOW_BPG_IPV6_NEXT_HOP 63

Next-hop router in the BGP domain

#define DOCA_TELEMETRY_NETFLOW_COLLECTION_TIME_MILLISECONDS 258

The absolute timestamp at which the data within the scope containing this Information Element was received by a Collecting Process. This Information Element SHOULD be bound to its containing IPFIX Message via IPFIX Options and the messageScope Information Element, as defined below.

#define DOCA_TELEMETRY_NETFLOW_COLLECTOR_CERTIFICATE 274

The full X.509 certificate, encoded in ASN.1 DER format, used by the Collector when IPFIX Messages were transmitted using TLS or DTLS. This Information Element SHOULD be bound to its containing IPFIX Transport Session via an options record and the sessionScope Information Element, or to its containing IPFIX Message via an options record and the messageScope Information Element.

#define DOCA_TELEMETRY_NETFLOW_COLLECTOR_IPV4_ADDRESS 211

An IPv4 address to which the Exporting Process sends Flow information.

#define DOCA_TELEMETRY_NETFLOW_COLLECTOR_IPV6_ADDRESS 212

An IPv6 address to which the Exporting Process sends Flow information.

#define DOCA_TELEMETRY_NETFLOW_COLLECTOR_TRANSPORT_PORT 216

The destination port identifier to which the Exporting Process sends Flow information. For the transport protocols UDP, TCP, and SCTP, this is the destination port number. This field MAY also be used for future transport protocols that have 16-bit source port identifiers.

#define DOCA_TELEMETRY_NETFLOW_COMMON_PROPERTIES_ID 137

An identifier of a set of common properties that is unique per Observation Domain and Transport Session. Typically, this Information Element is used to link to information reported in separate Data Records.

#define DOCA_TELEMETRY_NETFLOW_CONFIDENCE_LEVEL 338

This Information Element specifies the confidence level. It is used to provide an accuracy statement for estimated values. The confidence level provides the probability p with which the real value lies within a given range. A confidence level always needs to be associated with confidence limits that define the range in which the real value is assumed to be.

#define DOCA_TELEMETRY_NETFLOW_CONNECTION_SUM_DURATION_SECONDS 279

This information element aggregates the total time in seconds for all of the TCP or UDP connections which were in use during the observation period. For example if there are 5 concurrent connections each for 10 seconds, the value would be 50 s.

#define DOCA_TELEMETRY_NETFLOW_CONNECTION_TRANSACTION_ID 280

This information element identifies a transaction within a connection. A transaction is a meaningful exchange of application data between two network devices or a client and server. A transactionId is assigned the first time a flow is reported, so that later reports for the same flow will have the same transactionId. A different transactionId is used for each transaction within a TCP or UDP connection. The identifiers need not be sequential.

#define DOCA_TELEMETRY_NETFLOW_DATA_LINK_FRAME_SECTION 315

This Information Element carries n octets from the data link frame of a selected frame, starting sectionOffset octets into the frame.

#define DOCA_TELEMETRY_NETFLOW_DATA_LINK_FRAME_SIZE 312

This Information Element specifies the length of the selected data link frame.

#define DOCA_TELEMETRY_NETFLOW_DATA_LINK_FRAME_TYPE 408

This Information Element specifies the type of the selected data link frame.

#define DOCA_TELEMETRY_NETFLOW_DATA_RECORDS_RELIABILITY 276

The export reliability of Data Records, within this SCTP stream, for the element(s) in the Options Template scope. A typical example of an element for which the export reliability will be reported is the templateID, as specified in the Data Records Reliability Options Template. A value of 'True' means that the Exporting Process MUST send any Data Records associated with the element(s) reliably within this SCTP stream. A value of 'False' means that the Exporting Process MAY send any Data Records associated with the element(s) unreliably within this SCTP stream.

#define DOCA_TELEMETRY_NETFLOW_DESTINATION_IPV6_PREFIX 169

IPv6 destination address prefix.

#define DOCA_TELEMETRY_NETFLOW_DIGEST_HASH_VALUE 326

This Information Element specifies the value from the digest hash function. See also Sections 6.2, 3.8 and 7.1 of [RFC5475].

#define DOCA_TELEMETRY_NETFLOW_DIRECTION 61

Flow direction: 0 - ingress flow, 1 - egress flow

#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_DESTINATION_IPV4_ADDRESS 381

The count of distinct destination IPv4 address values for Original Flows contributing to this Aggregated Flow.

#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_DESTINATION_IPV6_ADDRESS 383

The count of distinct destination IPv6 address values for Original Flows contributing to this Aggregated Flow.

#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_DESTINATION_IP_ADDRESS 379

The count of distinct destination IP address values for Original Flows contributing to this Aggregated Flow, without regard to IP version. This Information Element is preferred to the version-specific counters below, unless it is important to separate the counts by version.

#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_SOURCE_IPV4_ADDRESS 380

The count of distinct source IPv4 address values for Original Flows contributing to this Aggregated Flow.

#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_SOURCE_IPV6_ADDRESS 382

The count of distinct source IPv6 address values for Original Flows contributing to this Aggregated Flow.

#define DOCA_TELEMETRY_NETFLOW_DISTINCT_COUNT_OF_SOURCE_IP_ADDRESS 378

The count of distinct source IP address values for Original Flows contributing to this Aggregated Flow, without regard to IP version. This Information Element is preferred to the IP-version-specific counters, unless it is important to separate the counts by version.

#define DOCA_TELEMETRY_NETFLOW_DOT1Q_CUSTOMER_DEI 389

In case of a QinQ frame, it represents the inner tag's Drop Eligible Indicator (DEI) field and in case of an IEEE 802.1ad frame it represents the DEI field of the C-TAG.

#define DOCA_TELEMETRY_NETFLOW_DOT1Q_CUSTOMER_DESTINATION_MAC_ADDRESS 415

The value of the Encapsulated Customer Destination Address (C-DA) portion of the Backbone Service Instance Tag (I-TAG) Tag Control Information (TCI) field of an Ethernet frame as described in [IEEE802.1Q].

#define DOCA_TELEMETRY_NETFLOW_DOT1Q_CUSTOMER_PRIORITY 246

The value represents the 3-bit Priority Code Point (PCP) portion of the Customer VLAN Tag (C-TAG) Tag Control Information (TCI) field as described in [IEEE802.1Q].

#define DOCA_TELEMETRY_NETFLOW_DOT1Q_CUSTOMER_SOURCE_MAC_ADDRESS 414

The value of the Encapsulated Customer Source Address (C-SA) portion of the Backbone Service Instance Tag (I-TAG) Tag Control Information (TCI) field of an Ethernet frame as described in [IEEE802.1Q].

#define DOCA_TELEMETRY_NETFLOW_DOT1Q_CUSTOMER_VLAN_ID 245

The value represents the Customer VLAN identifier in the Customer VLAN Tag (C-TAG) Tag Control Information (TCI) field as described in [IEEE802.1Q].

#define DOCA_TELEMETRY_NETFLOW_DOT1Q_DEI 388

The value of the 1-bit Drop Eligible Indicator (DEI) field of the VLAN tag as described in 802.1Q-2011 subclause 9.6. In case of a QinQ frame, it represents the outer tag's DEI field and in case of an IEEE 802.1ad frame it represents the DEI field of the S-TAG. Note: in earlier versions of 802.1Q the same bit field in the incoming packet is occupied by the Canonical Format Indicator (CFI) field, except for S-TAGs.

#define DOCA_TELEMETRY_NETFLOW_DOT1Q_PRIORITY 244

The value of the 3-bit User Priority portion of the Tag Control Information field of an Ethernet frame. The structure and semantics within the Tag Control Information field are defined in [IEEE802.1Q]. In the case of multi-tagged frame, it represents the 3-bit Priority Code Point (PCP) portion of the outer tag's Tag Control Information (TCI) field as described in [IEEE802.1Q], except for I-TAG.

#define DOCA_TELEMETRY_NETFLOW_DOT1Q_SERVICE_INSTANCE_ID 412

The value of the 24-bit Backbone Service Instance Identifier (I-SID) portion of the Backbone Service Instance Tag (I-TAG) Tag Control Information (TCI) field of an Ethernet frame as described in [IEEE802.1Q].

#define DOCA_TELEMETRY_NETFLOW_DOT1Q_SERVICE_INSTANCE_PRIORITY 413

The value of the 3-bit Backbone Service Instance Priority Code Point (I-PCP) portion of the Backbone Service Instance Tag (I-TAG) Tag Control Information (TCI) field of an Ethernet frame as described in [IEEE802.1Q].

#define DOCA_TELEMETRY_NETFLOW_DOT1Q_SERVICE_INSTANCE_TAG 411

This Information Element, which is 16 octets long, represents the Backbone Service Instance Tag (I-TAG) Tag Control Information (TCI) field of an Ethernet frame as described in [IEEE802.1Q]. It encodes the Backbone Service Instance Priority Code Point (I-PCP), Backbone Service Instance Drop Eligible Indicator (I-DEI), Use Customer Addresses (UCAs), Backbone Service Instance Identifier (I-SID), Encapsulated Customer Destination Address (C-DA), Encapsulated Customer Source Address (C-SA), and reserved fields. The structure and semantics within the Tag Control Information field are defined in [IEEE802.1Q].

#define DOCA_TELEMETRY_NETFLOW_DOT1Q_VLAN_ID 243

The value of the 12-bit VLAN Identifier portion of the Tag Control Information field of an Ethernet frame. The structure and semantics within the Tag Control Information field are defined in [IEEE802.1Q]. In Provider Bridged Networks, it represents the Service VLAN identifier in the Service VLAN Tag (S-TAG) Tag Control Information (TCI) field or the Customer VLAN identifier in the Customer VLAN Tag (C-TAG) Tag Control Information (TCI) field as described in [IEEE802.1Q]. In Provider Backbone Bridged Networks, it represents the Backbone VLAN identifier in the Backbone VLAN Tag (B-TAG) Tag Control Information (TCI) field as described in [IEEE802.1Q]. In a virtual link between a host system and EVB bridge, it represents the Service VLAN identifier indicating S-channel as described in [IEEE802.1Qbg].

#define DOCA_TELEMETRY_NETFLOW_DROPPED_LAYER2_OCTET_DELTA_COUNT 424

The number of layer 2 octets since the previous report (if any) in packets of this Flow dropped by packet treatment. The number of octets includes layer 2 header(s) and layer 2 payload.

#define DOCA_TELEMETRY_NETFLOW_DROPPED_LAYER2_OCTET_TOTAL_COUNT 425

The total number of octets in observed layer 2 packets (including the layer 2 header) that were dropped by packet treatment since the (re-)initialization of the Metering Process.

#define DOCA_TELEMETRY_NETFLOW_DROPPED_OCTET_DELTA_COUNT 132

The number of octets since the previous report (if any) in packets of this Flow dropped by packet treatment. The number of octets includes IP header(s) and IP payload.

#define DOCA_TELEMETRY_NETFLOW_DROPPED_OCTET_TOTAL_COUNT 134

The total number of octets in packets of this Flow dropped by packet treatment since the Metering Process (re-)initialization for this Observation Point. The number of octets includes IP header(s) and IP payload.

#define DOCA_TELEMETRY_NETFLOW_DROPPED_PACKET_DELTA_COUNT 133

The number of packets since the previous report (if any) of this Flow dropped by packet treatment.

#define DOCA_TELEMETRY_NETFLOW_DROPPED_PACKET_TOTAL_COUNT 135

The number of packets of this Flow dropped by packet treatment since the Metering Process (re-)initialization for this Observation Point.

#define DOCA_TELEMETRY_NETFLOW_DST_AS 17

Destination BGP autonomous system number where N could be 2 or 4

#define DOCA_TELEMETRY_NETFLOW_DST_MASK 13

The number of contiguous bits in the destination address subnet mask i.e.: the submask in slash notation

#define DOCA_TELEMETRY_NETFLOW_DST_TOS 55

Type of Service byte setting when exiting outgoing interface

#define DOCA_TELEMETRY_NETFLOW_DST_TRAFFIC_INDEX 93

BGP Policy Accounting Destination Traffic Index

#define DOCA_TELEMETRY_NETFLOW_DST_VLAN 59

Virtual LAN identifier associated with egress interface

#define DOCA_TELEMETRY_NETFLOW_EGRESS_BROADCAST_PACKET_TOTAL_COUNT 358

The total number of incoming broadcast packets metered at the Observation Point since the Metering Process (re-)initialization for this Observation Point.

#define DOCA_TELEMETRY_NETFLOW_EGRESS_INTERFACE_TYPE 369

The type of interface where packets of this Flow are being sent. The value matches the value of managed object 'ifType' as defined in [https://www.iana.org/assignments/ianaiftype-mib].

#define DOCA_TELEMETRY_NETFLOW_EGRESS_PHYSICAL_INTERFACE 253

The index of a networking device's physical interface (example, a switch port) where packets of this flow are being sent.

#define DOCA_TELEMETRY_NETFLOW_EGRESS_UNICAST_PACKET_TOTAL_COUNT 357

The total number of incoming unicast packets metered at the Observation Point since the Metering Process (re-)initialization for this Observation Point.

#define DOCA_TELEMETRY_NETFLOW_EGRESS_VRFID 235

An unique identifier of the VRFname where the packets of this flow are being sent. This identifier is unique per Metering Process

#define DOCA_TELEMETRY_NETFLOW_ENCRYPTED_TECHNOLOGY 290

Specifies if the Application ID is an encrypted networking protocol.

#define DOCA_TELEMETRY_NETFLOW_ENGINE_ID 39

ID number of the flow switching engine

#define DOCA_TELEMETRY_NETFLOW_ENGINE_TYPE 38

Type of flow switching engine: RP = 0, VIP/Linecard = 1

#define DOCA_TELEMETRY_NETFLOW_ETHERNET_HEADER_LENGTH 240

The difference between the length of an Ethernet frame (minus the FCS) and the length of its MAC Client Data section (including any padding) as defined in section 3.1 of [IEEE.802-3.2005]. It does not include the Preamble, SFD and Extension field lengths.

#define DOCA_TELEMETRY_NETFLOW_ETHERNET_PAYLOAD_LENGTH 241

The length of the MAC Client Data section (including any padding) of a frame as defined in section 3.1 of [IEEE.802-3.2005].

#define DOCA_TELEMETRY_NETFLOW_ETHERNET_TOTAL_LENGTH 242

The total length of the Ethernet frame (excluding the Preamble, SFD, Extension and FCS fields) as described in section 3.1 of [IEEE.802-3.2005].

#define DOCA_TELEMETRY_NETFLOW_ETHERNET_TYPE 256

The Ethernet type field of an Ethernet frame that identifies the MAC client protocol carried in the payload as defined in paragraph 1.4.349 of [IEEE.802-3.2005].

#define DOCA_TELEMETRY_NETFLOW_EXPORTER_CERTIFICATE 275

#define DOCA_TELEMETRY_NETFLOW_EXPORTER_IPV4_ADDRESS 130

The IPv4 address used by the Exporting Process. This is used by the Collector to identify the Exporter in cases where the identity of the Exporter may have been obscured by the use of a proxy.

#define DOCA_TELEMETRY_NETFLOW_EXPORTER_IPV6_ADDRESS 131

The IPv6 address used by the Exporting Process. This is used by the Collector to identify the Exporter in cases where the identity of the Exporter may have been obscured by the use of a proxy.

#define DOCA_TELEMETRY_NETFLOW_EXPORTER_TRANSPORT_PORT 217

The source port identifier from which the Exporting Process sends Flow information. For the transport protocols UDP, TCP, and SCTP, this is the source port number. This field MAY also be used for future transport protocols that have 16-bit source port identifiers. This field may be useful for distinguishing multiple Exporting Processes that use the same IP address.

#define DOCA_TELEMETRY_NETFLOW_EXPORTING_PROCESS_ID 144

An identifier of an Exporting Process that is unique per IPFIX Device. Typically, this Information Element is used for limiting the scope of other Information Elements. Note that process identifiers are typically assigned dynamically. The Exporting Process may be re-started with a different ID.

#define DOCA_TELEMETRY_NETFLOW_EXPORT_INTERFACE 213

The index of the interface from which IPFIX Messages sent by the Exporting Process to a Collector leave the IPFIX Device. The value matches the value of managed object 'ifIndex' as defined in [RFC2863]. Note that ifIndex values are not assigned statically to an interface and that the interfaces may be renumbered every time the device's management system is re-initialized, as specified in [RFC2863].

#define DOCA_TELEMETRY_NETFLOW_EXPORT_PROTOCOL_VERSION 214

The protocol version used by the Exporting Process for sending Flow information. The protocol version is given by the value of the Version Number field in the Message Header.

#define DOCA_TELEMETRY_NETFLOW_EXPORT_SCTP_STREAM_ID 259

The value of the SCTP Stream Identifier used by the Exporting Process for exporting IPFIX Message data. This is carried in the Stream Identifier field of the header of the SCTP DATA chunk containing the IPFIX Message(s).

#define DOCA_TELEMETRY_NETFLOW_EXPORT_TRANSPORT_PROTOCOL 215

The value of the protocol number used by the Exporting Process for sending Flow information. The protocol number identifies the IP packet payload type. Protocol numbers are defined in the IANA Protocol Numbers registry.

#define DOCA_TELEMETRY_NETFLOW_EXTERNAL_ADDRESS_REALM 465

This Information Element represents the external address realm where the packet is originated from or destined to. The detailed definition is in the internal address realm as specified above.

#define DOCA_TELEMETRY_NETFLOW_FIREWALL_EVENT 233

Indicates a firewall event. Allowed values are listed in the firewallEvent registry. See [http://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-firewall-event].

#define DOCA_TELEMETRY_NETFLOW_FIRST_SWITCHED 22

System uptime at which the first packet of this flow was switched

#define DOCA_TELEMETRY_NETFLOW_FLOWS 3

Number of flows that were aggregated; default for N is 4

#define DOCA_TELEMETRY_NETFLOW_FLOW_ACTIVE_TIMEOUT 36

Timeout value (in seconds) for active flow entries in the NetFlow cache

#define DOCA_TELEMETRY_NETFLOW_FLOW_DURATION_MICROSECONDS 162

The difference in time between the first observed packet of this Flow and the last observed packet of this Flow.

#define DOCA_TELEMETRY_NETFLOW_FLOW_DURATION_MILLISECONDS 161

The difference in time between the first observed packet of this Flow and the last observed packet of this Flow.

#define DOCA_TELEMETRY_NETFLOW_FLOW_END_DELTA_MICROSECONDS 159

This is a relative timestamp only valid within the scope of a single IPFIX Message. It contains the negative time offset of the last observed packet of this Flow relative to the export time specified in the IPFIX Message Header.

#define DOCA_TELEMETRY_NETFLOW_FLOW_END_MICROSECONDS 155

The absolute timestamp of the last packet of this Flow.

#define DOCA_TELEMETRY_NETFLOW_FLOW_END_MILLISECONDS 153

The absolute timestamp of the last packet of this Flow.

#define DOCA_TELEMETRY_NETFLOW_FLOW_END_NANOSECONDS 157

The absolute timestamp of the last packet of this Flow.

#define DOCA_TELEMETRY_NETFLOW_FLOW_END_REASON 136

The reason for Flow termination. Values are listed in the flowEndReason registry. See [http://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-flow-end-reason].

#define DOCA_TELEMETRY_NETFLOW_FLOW_END_SECONDS 151

The absolute timestamp of the last packet of this Flow.

#define DOCA_TELEMETRY_NETFLOW_FLOW_ID 148

An identifier of a Flow that is unique within an Observation Domain. This Information Element can be used to distinguish between different Flows if Flow Keys such as IP addresses and port numbers are not reported or are reported in separate records.

#define DOCA_TELEMETRY_NETFLOW_FLOW_INACTIVE_TIMEOUT 37

Timeout value (in seconds) for inactive flow entries in the NetFlow cache

#define DOCA_TELEMETRY_NETFLOW_FLOW_KEY_INDICATOR 173

This set of bit fields is used for marking the Information Elements of a Data Record that serve as Flow Key. Each bit represents an Information Element in the Data Record, with the n-th least significant bit representing the n-th Information Element. A bit set to value 1 indicates that the corresponding Information Element is a Flow Key of the reported Flow. A bit set to value 0 indicates that this is not the case.

#define DOCA_TELEMETRY_NETFLOW_FLOW_SAMPLER_ID 48

Identifier shown in "show flow-sampler"

#define DOCA_TELEMETRY_NETFLOW_FLOW_SAMPLER_MODE 49

The type of algorithm used for sampling data: 0x02 random sampling. Use in connection with FLOW_SAMPLER_MODE

#define DOCA_TELEMETRY_NETFLOW_FLOW_SAMPLER_RANDOM_INTERVAL 50

Packet interval at which to sample. Use in connection with FLOW_SAMPLER_MODE

#define DOCA_TELEMETRY_NETFLOW_FLOW_SAMPLING_TIME_INTERVAL 398

This Information Element specifies the time interval in microseconds during which all arriving Flows are sampled. For example, this Information Element may be used to describe the configuration of a systematic time-based Sampling Selector.

#define DOCA_TELEMETRY_NETFLOW_FLOW_SAMPLING_TIME_SPACING 399

This Information Element specifies the time interval in microseconds between two "flowSamplingTimeInterval"s. A value of 100 means that the next interval starts 100 microseconds (during which no Flows are sampled) after the current "flowsamplingTimeInterval" is over. For example, this Information Element may used to describe the configuration of a systematic time-based Sampling Selector.

#define DOCA_TELEMETRY_NETFLOW_FLOW_SELECTED_FLOW_DELTA_COUNT 393

This Information Element specifies the number of Flows that were selected in the Intermediate Flow Selection Process since the last report.

#define DOCA_TELEMETRY_NETFLOW_FLOW_SELECTED_OCTET_DELTA_COUNT 391

This Information Element specifies the volume in octets of all Flows that are selected in the Intermediate Flow Selection Process since the previous report.

#define DOCA_TELEMETRY_NETFLOW_FLOW_SELECTED_PACKET_DELTA_COUNT 392

This Information Element specifies the volume in packets of all Flows that were selected in the Intermediate Flow Selection Process since the previous report.

#define DOCA_TELEMETRY_NETFLOW_FLOW_SELECTOR_ALGORITHM 390

This Information Element identifies the Intermediate Flow Selection Process technique (e.g., Filtering, Sampling) that is applied by the Intermediate Flow Selection Process. Most of these techniques have parameters. Its configuration parameter(s) MUST be clearly specified. Further Information Elements are needed to fully specify packet selection with these methods and all their parameters. Further method identifiers may be added to the flowSelectorAlgorithm registry. It might be necessary to define new Information Elements to specify their parameters. Please note that the purpose of the flow selection techniques described in this document is the improvement of measurement functions as defined in the Scope (Section 1). The Intermediate Flow Selection Process Techniques identifiers are defined at [http://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-flowselectoralgorithm].

#define DOCA_TELEMETRY_NETFLOW_FLOW_START_DELTA_MICROSECONDS 158

This is a relative timestamp only valid within the scope of a single IPFIX Message. It contains the negative time offset of the first observed packet of this Flow relative to the export time specified in the IPFIX Message Header.

#define DOCA_TELEMETRY_NETFLOW_FLOW_START_MICROSECONDS 154

The absolute timestamp of the first packet of this Flow.

#define DOCA_TELEMETRY_NETFLOW_FLOW_START_MILLISECONDS 152

The absolute timestamp of the first packet of this Flow.

#define DOCA_TELEMETRY_NETFLOW_FLOW_START_NANOSECONDS 156

The absolute timestamp of the first packet of this Flow.

#define DOCA_TELEMETRY_NETFLOW_FLOW_START_SECONDS 150

The absolute timestamp of the first packet of this Flow.

#define DOCA_TELEMETRY_NETFLOW_FORWARDING_STATUS 89

Forwarding status is encoded on 1 byte with the 2 left bits giving the status and the 6 remaining bits giving the reason code.

#define DOCA_TELEMETRY_NETFLOW_FRAGMENT_FLAGS 197

Fragmentation properties indicated by flags in the IPv4 packet header or the IPv6 Fragment header, respectively.

#define DOCA_TELEMETRY_NETFLOW_FRAGMENT_OFFSET 88

The fragment-offset value from fragmented IP packets

#define DOCA_TELEMETRY_NETFLOW_GLOBAL_ADDRESS_MAPPING_HIGH_THRESHOLD 481

This element represents the high threshold value of the number of address and port mappings that a single user is allowed to create on a NAT device in a paired address pooling behavior.

#define DOCA_TELEMETRY_NETFLOW_GRE_KEY 296

GRE key, which is used for identifying an individual traffic flow within a tunnel.

#define DOCA_TELEMETRY_NETFLOW_HASH_DIGEST_OUTPUT 333

This Information Element contains a boolean value that is TRUE if the output from this hash Selector has been configured to be included in the packet report as a packet digest, else FALSE.

#define DOCA_TELEMETRY_NETFLOW_HASH_FLOW_DOMAIN 400

This Information Element specifies the Information Elements that are used by the Hash-based Flow Selector as the Hash Domain.

#define DOCA_TELEMETRY_NETFLOW_HASH_INITIALIZER_VALUE 334

This Information Element specifies the initializer value to the hash function.

#define DOCA_TELEMETRY_NETFLOW_HASH_IPPAYLOAD_OFFSET 327

This Information Element specifies the IP payload offset used by a Hash-based Selection Selector. See also Sections 6.2, 3.8 and 7.1 of [RFC5475].

#define DOCA_TELEMETRY_NETFLOW_HASH_IPPAYLOAD_SIZE 328

This Information Element specifies the IP payload size used by a Hash-based Selection Selector. See also Sections 6.2, 3.8 and 7.1 of [RFC5475].

#define DOCA_TELEMETRY_NETFLOW_HASH_OUTPUT_RANGE_MAX 330

This Information Element specifies the value for the end of a hash function's potential output range.

#define DOCA_TELEMETRY_NETFLOW_HASH_OUTPUT_RANGE_MIN 329

This Information Element specifies the value for the beginning of a hash function's potential output range.

#define DOCA_TELEMETRY_NETFLOW_HASH_SELECTED_RANGE_MAX 332

This Information Element specifies the value for the end of a hash function's selected range.

#define DOCA_TELEMETRY_NETFLOW_HASH_SELECTED_RANGE_MIN 331

This Information Element specifies the value for the beginning of a hash function's selected range.

#define DOCA_TELEMETRY_NETFLOW_HTTP_CONTENT_TYPE 469

The HTTP Content-Type header field as defined in section 3.1.1.5 of [RFC7231]. Encoded in UTF-8.

#define DOCA_TELEMETRY_NETFLOW_HTTP_MESSAGE_VERSION 462

The version of an HTTP/1.1 message as indicated by the HTTP-version field, defined in section 2.6 of [RFC7230], or the version identification of an HTTP/2 frame as defined in [RFC7240] section 3.1. The length of this field is limited to 10 characters, UTF-8 encoded.

#define DOCA_TELEMETRY_NETFLOW_HTTP_REASON_PHRASE 470

The HTTP reason phrase as defined in section 6.1 of [RFC7231].

#define DOCA_TELEMETRY_NETFLOW_HTTP_REQUEST_HOST 460

The HTTP request host, as defined in section 5.4 of [RFC7230] or, in the case of HTTP/2, the content of the :authority pseudo-header field as defined in section 8.1.2.3 of [RFC7240]. Encoded in UTF-8.

#define DOCA_TELEMETRY_NETFLOW_HTTP_REQUEST_METHOD 459

The HTTP request method, as defined in section 4 of [RFC7231], associated with a flow. String with up to 8 UTF-8 characters.

#define DOCA_TELEMETRY_NETFLOW_HTTP_REQUEST_TARGET 461

The HTTP request target, as defined in section 2 of [RFC7231] and in section 5.3 of [RFC7230], associated with a flow. Or the HTTP/2 ":path" pseudo-header field as defined in section 8.1.2.3 of [RFC7240]. Encoded in UTF-8.

#define DOCA_TELEMETRY_NETFLOW_HTTP_STATUS_CODE 457

The HTTP Response Status Code, as defined in section 6 of [RFC7231], associated with a flow. Implies that the flow record represents a flow containing an HTTP Response.

#define DOCA_TELEMETRY_NETFLOW_HTTP_USER_AGENT 468

The HTTP User-Agent header field as defined in section 5.5.3 of [RFC7231]. Encoded in UTF-8.

#define DOCA_TELEMETRY_NETFLOW_ICMP_CODE_IPV4 177

Code of the IPv4 ICMP message.

#define DOCA_TELEMETRY_NETFLOW_ICMP_CODE_IPV6 179

Code of the IPv6 ICMP message.

#define DOCA_TELEMETRY_NETFLOW_ICMP_TYPE 32

Internet Control Message Protocol (ICMP) packet type; reported as ((ICMP Type*256) + ICMP code)

#define DOCA_TELEMETRY_NETFLOW_ICMP_TYPE_CODE_IPV6 139

Type and Code of the IPv6 ICMP message. The combination of both values is reported as (ICMP type * 256) + ICMP code.

#define DOCA_TELEMETRY_NETFLOW_ICMP_TYPE_IPV4 176

Type of the IPv4 ICMP message.

#define DOCA_TELEMETRY_NETFLOW_ICMP_TYPE_IPV6 178

Type of the IPv6 ICMP message.

#define DOCA_TELEMETRY_NETFLOW_IF_DESC 83

Full interface name i.e.: "'FastEthernet 1/0"

#define DOCA_TELEMETRY_NETFLOW_IF_NAME 82

Shortened interface name i.e.: "FE1/0"

#define DOCA_TELEMETRY_NETFLOW_IGNORED_DATA_RECORD_TOTAL_COUNT 407

Description: The total number of received Data Records that the Intermediate Process did not process since the (re-)initialization of the Intermediate Process; includes only Data Records not examined or otherwise handled by the Intermediate Process due to resource constraints, not Data Records that were examined or otherwise handled by the Intermediate Process but those that merely do not contribute to any exported Data Record due to the operations performed by the Intermediate Process.

#define DOCA_TELEMETRY_NETFLOW_IGNORED_LAYER2_FRAME_TOTAL_COUNT 433

The total number of observed layer 2 frames that the Metering Process did not process since the (re-)initialization of the Metering Process. This Information Element is the layer 2 version of ignoredPacketTotalCount (ElementId #164).

#define DOCA_TELEMETRY_NETFLOW_IGNORED_LAYER2_OCTET_TOTAL_COUNT 426

The total number of octets in observed layer 2 packets (including the layer 2 header) that the Metering Process did not process since the (re-)initialization of the Metering Process.

#define DOCA_TELEMETRY_NETFLOW_IGNORED_OCTET_TOTAL_COUNT 165

The total number of octets in observed IP packets (including the IP header) that the Metering Process did not process since the (re-)initialization of the Metering Process.

#define DOCA_TELEMETRY_NETFLOW_IGNORED_PACKET_TOTAL_COUNT 164

The total number of observed IP packets that the Metering Process did not process since the (re-)initialization of the Metering Process.

#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_DATA_TYPE 339

A description of the abstract data type of an IPFIX information element.These are taken from the abstract data types defined in section 3.1 of the IPFIX Information Model [RFC5102]; see that section for more information on the types described in the [informationElementDataType] subregistry.

#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_DESCRIPTION 340

A UTF-8 [RFC3629] encoded Unicode string containing a human-readable description of an Information Element. The content of the informationElementDescription MAY be annotated with one or more language tags [RFC4646], encoded in-line [RFC2482] within the UTF-8 string, in order to specify the language in which the description is written. Description text in multiple languages MAY tag each section with its own language tag; in this case, the description information in each language SHOULD have equivalent meaning. In the absence of any language tag, the "i-default" [RFC2277] language SHOULD be assumed. See the Security Considerations section for notes on string handling for Information Element type records.

#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_ID 303

This Information Element contains the ID of another Information Element.

#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_INDEX 287

A zero-based index of an Information Element referenced by informationElementId within a Template referenced by templateId; used to disambiguate scope for templates containing multiple identical Information Elements.

#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_NAME 341

A UTF-8 [RFC3629] encoded Unicode string containing the name of an Information Element, intended as a simple identifier. See the Security Considerations section for notes on string handling for Information Element type records

#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_RANGE_BEGIN 342

Contains the inclusive low end of the range of acceptable values for an Information Element.

#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_RANGE_END 343

Contains the inclusive high end of the range of acceptable values for an Information Element.

#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_SEMANTICS 344

A description of the semantics of an IPFIX Information Element. These are taken from the data type semantics defined in section 3.2 of the IPFIX Information Model [RFC5102]; see that section for more information on the types defined in the [IPFIX Information Element Semantics] subregistry. This field may take the values in the semantics registry; the special value 0x00 (default) is used to note that no semantics apply to the field; it cannot be manipulated by a Collecting Process or File Reader that does not understand it a priori.

#define DOCA_TELEMETRY_NETFLOW_INFORMATION_ELEMENT_UNITS 345

A description of the units of an IPFIX Information Element. These correspond to the units implicitly defined in the Information Element definitions in section 5 of the IPFIX Information Model [RFC5102]; see that section for more information on the types described in the informationElementsUnits subregistry. This field may take the values in Table 3 below; the special value 0x00 (none) is used to note that the field is unitless.

#define DOCA_TELEMETRY_NETFLOW_INGRESS_BROADCAST_PACKET_TOTAL_COUNT 356

The total number of incoming broadcast packets metered at the Observation Point since the Metering Process (re-)initialization for this Observation Point.

#define DOCA_TELEMETRY_NETFLOW_INGRESS_INTERFACE_TYPE 368

The type of interface where packets of this Flow are being received. The value matches the value of managed object 'ifType' as defined in [https://www.iana.org/assignments/ianaiftype-mib].

#define DOCA_TELEMETRY_NETFLOW_INGRESS_MULTICAST_PACKET_TOTAL_COUNT 355

The total number of incoming multicast packets metered at the Observation Point since the Metering Process (re-)initialization for this Observation Point.

#define DOCA_TELEMETRY_NETFLOW_INGRESS_PHYSICAL_INTERFACE 252

The index of a networking device's physical interface (example, a switch port) where packets of this flow are being received.

#define DOCA_TELEMETRY_NETFLOW_INGRESS_UNICAST_PACKET_TOTAL_COUNT 354

The total number of incoming unicast packets metered at the Observation Point since the Metering Process (re-)initialization for this Observation Point.

#define DOCA_TELEMETRY_NETFLOW_INGRESS_VRFID 234

An unique identifier of the VRFname where the packets of this flow are being received. This identifier is unique per Metering Process

#define DOCA_TELEMETRY_NETFLOW_INITIATOR_OCTETS 231

The total number of layer 4 payload bytes in a flow from the initiator since the previous report. The initiator is the device which triggered the session creation, and remains the same for the life of the session.

#define DOCA_TELEMETRY_NETFLOW_INITIATOR_PACKETS 298

The total number of layer 4 packets in a flow from the initiator since the previous report. The initiator is the device which triggered the session creation, and remains the same for the life of the session.

#define DOCA_TELEMETRY_NETFLOW_INPUT_SNMP 10

Input interface index; default for N is 2 but higher values could be used

#define DOCA_TELEMETRY_NETFLOW_INTERMEDIATE_PROCESS_ID 406

Description: An identifier of an Intermediate Process that is unique per IPFIX Device. Typically, this Information Element is used for limiting the scope of other Information Elements. Note that process identifiers may be assigned dynamically; that is, an Intermediate Process may be restarted with a different ID.

#define DOCA_TELEMETRY_NETFLOW_INTERNAL_ADDRESS_REALM 464

This Information Element represents the internal address realm where the packet is originated from or destined to. By definition, a NAT mapping can be created from two address realms, one from internal and one from external. Realms are implementation dependent and can represent a Virtual Routing and Forwarding (VRF) ID, a VLAN ID, or some unique identifier. Realms are optional and, when left unspecified, would mean that the external and internal realms are the same.

#define DOCA_TELEMETRY_NETFLOW_IN_BYTES 1

Incoming counter with length N x 8 bits for number of bytes associated with an IP Flow.

#define DOCA_TELEMETRY_NETFLOW_IN_DST_MAC 80

Incoming destination MAC address

#define DOCA_TELEMETRY_NETFLOW_IN_PERMANENT_BYTES 85

Running byte counter for a permanent flow

#define DOCA_TELEMETRY_NETFLOW_IN_PERMANENT_PKTS 86

Running packet counter for a permanent flow

#define DOCA_TELEMETRY_NETFLOW_IN_PKTS 2

Incoming counter with length N x 8 bits for the number of packets associated with an IP Flow

#define DOCA_TELEMETRY_NETFLOW_IN_SRC_MAC 56

Incoming source MAC address

#define DOCA_TELEMETRY_NETFLOW_IPSEC_SPI 295

IPSec Security Parameters Index (SPI).

#define DOCA_TELEMETRY_NETFLOW_IPV4_DST_ADDR 12

IPv4 destination address

#define DOCA_TELEMETRY_NETFLOW_IPV4_DST_PREFIX 45

IPv4 destination address prefix (specific for Catalyst architecture)

#define DOCA_TELEMETRY_NETFLOW_IPV4_IDENT 54

The IP v4 identification field

#define DOCA_TELEMETRY_NETFLOW_IPV4_IHL 207

The value of the Internet Header Length (IHL) field in the IPv4 header. It specifies the length of the header in units of 4 octets. Please note that its unit is different from most of the other Information Elements reporting length values.

#define DOCA_TELEMETRY_NETFLOW_IPV4_NEXT_HOP 15

IPv4 address of next-hop router

#define DOCA_TELEMETRY_NETFLOW_IPV4_OPTIONS 208

IPv4 options in packets of this Flow. The information is encoded in a set of bit fields. For each valid IPv4 option type, there is a bit in this set. The bit is set to 1 if any observed packet of this Flow contains the corresponding IPv4 option type. Otherwise, if no observed packet of this Flow contained the respective IPv4 option type, the value of the corresponding bit is 0.

#define DOCA_TELEMETRY_NETFLOW_IPV4_SRC_ADDR 8

IPv4 source address

#define DOCA_TELEMETRY_NETFLOW_IPV4_SRC_PREFIX 44

IPv4 source address prefix (specific for Catalyst architecture)

#define DOCA_TELEMETRY_NETFLOW_IPV6_DST_ADDR 28

IPv6 Destination Address

#define DOCA_TELEMETRY_NETFLOW_IPV6_DST_MASK 30

Length of the IPv6 destination mask in contiguous bits

#define DOCA_TELEMETRY_NETFLOW_IPV6_FLOW_LABEL 31

IPv6 flow label as per RFC 2460 definition

#define DOCA_TELEMETRY_NETFLOW_IPV6_NEXT_HOP 62

IPv6 address of the next-hop router

#define DOCA_TELEMETRY_NETFLOW_IPV6_OPTION_HEADERS 64

Bit-encoded field identifying IPv6 option headers found in the flow

#define DOCA_TELEMETRY_NETFLOW_IPV6_SRC_ADDR 27

IPv6 Source Address

#define DOCA_TELEMETRY_NETFLOW_IPV6_SRC_MASK 29

Length of the IPv6 source mask in contiguous bits

#define DOCA_TELEMETRY_NETFLOW_IP_DIFF_SERV_CODE_POINT 195

The value of a Differentiated Services Code Point (DSCP) encoded in the Differentiated Services field. The Differentiated Services field spans the most significant 6 bits of the IPv4 TOS field or the IPv6 Traffic Class field, respectively.

#define DOCA_TELEMETRY_NETFLOW_IP_HEADER_LENGTH 189

The length of the IP header. For IPv6, the value of this Information Element is 40.

#define DOCA_TELEMETRY_NETFLOW_IP_HEADER_PACKET_SECTION 313

This Information Element carries a series of n octets from the IP header of a sampled packet, starting sectionOffset octets into the IP header.

#define DOCA_TELEMETRY_NETFLOW_IP_PAYLOAD_LENGTH 204

The effective length of the IP payload.

#define DOCA_TELEMETRY_NETFLOW_IP_PAYLOAD_PACKET_SECTION 314

This Information Element carries a series of n octets from the IP payload of a sampled packet, starting sectionOffset octets into the IP payload.

#define DOCA_TELEMETRY_NETFLOW_IP_PRECEDENCE 196

The value of the IP Precedence. The IP Precedence value is encoded in the first 3 bits of the IPv4 TOS field or the IPv6 Traffic Class field, respectively.

#define DOCA_TELEMETRY_NETFLOW_IP_PROTOCOL_VERSION 60

Internet Protocol Version Set to 4 for IPv4, set to 6 for IPv6. If not present in the template, then version 4 is assumed.

#define DOCA_TELEMETRY_NETFLOW_IP_TOTAL_LENGTH 224

The total length of the IP packet.

#define DOCA_TELEMETRY_NETFLOW_IP_TTL 192

For IPv4, the value of the Information Element matches the value of the Time to Live (TTL) field in the IPv4 packet header. For IPv6, the value of the Information Element matches the value of the Hop Limit field in the IPv6 packet header.

#define DOCA_TELEMETRY_NETFLOW_IS_MULTICAST 206

If the IP destination address is not a reserved multicast address, then the value of all bits of the octet (including the reserved ones) is zero.

#define DOCA_TELEMETRY_NETFLOW_L4_DST_PORT 11

TCP/UDP destination port number i.e.: FTP, Telnet, or equivalent

#define DOCA_TELEMETRY_NETFLOW_L4_SRC_PORT 7

TCP/UDP source port number i.e.: FTP, Telnet, or equivalent

#define DOCA_TELEMETRY_NETFLOW_LAST_SWITCHED 21

System uptime at which the last packet of this flow was switched

#define DOCA_TELEMETRY_NETFLOW_LAYER2_FRAME_DELTA_COUNT 430

The number of incoming layer 2 frames since the previous report (if any) for this Flow at the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_LAYER2_FRAME_TOTAL_COUNT 431

The total number of incoming layer 2 frames for this Flow at the Observation Point since the Metering Process (re-)initialization for this Observation Point.

#define DOCA_TELEMETRY_NETFLOW_LAYER2_OCTET_DELTA_COUNT 352

The number of layer 2 octets since the previous report (if any) in incoming packets for this Flow at the Observation Point. The number of octets includes layer 2 header(s) and layer 2 payload. # memo: layer 2 version of octetDeltaCount (field #1)

#define DOCA_TELEMETRY_NETFLOW_LAYER2_OCTET_DELTA_SUM_OF_SQUARES 428

The sum of the squared numbers of layer 2 octets per incoming packet since the previous report (if any) for this Flow at the Observation Point. The number of octets includes layer 2 header(s) and layer 2 payload.

#define DOCA_TELEMETRY_NETFLOW_LAYER2_OCTET_TOTAL_COUNT 353

The total number of layer 2 octets in incoming packets for this Flow at the Observation Point since the Metering Process (re-)initialization for this Observation Point. The number of octets includes layer 2 header(s) and layer 2 payload. # memo: layer 2 version of octetTotalCount (field #85)

#define DOCA_TELEMETRY_NETFLOW_LAYER2_OCTET_TOTAL_SUM_OF_SQUARES 429

The total sum of the squared numbers of layer 2 octets in incoming packets for this Flow at the Observation Point since the Metering Process (re-)initialization for this Observation Point. The number of octets includes layer 2 header(s) and layer 2 payload.

#define DOCA_TELEMETRY_NETFLOW_LAYER2_SEGMENT_ID 351

Identifier of a layer 2 network segment in an overlay network. The most significant byte identifies the layer 2 network overlay network encapsulation type:

#define DOCA_TELEMETRY_NETFLOW_LAYER_2_PACKET_SECTION_DATA 104

Layer 2 packet section data.

#define DOCA_TELEMETRY_NETFLOW_LAYER_2_PACKET_SECTION_OFFSET 102

Layer 2 packet section offset. Potentially a generic offset.

#define DOCA_TELEMETRY_NETFLOW_LAYER_2_PACKET_SECTION_SIZE 103

Layer 2 packet section size. Potentially a generic size.

#define DOCA_TELEMETRY_NETFLOW_LINE_CARD_ID 141

An identifier of a line card that is unique per IPFIX Device hosting an Observation Point. Typically, this Information Element is used for limiting the scope of other Information Elements.

#define DOCA_TELEMETRY_NETFLOW_LOWER_CILIMIT 337

This Information Element specifies the lower limit of a confidence interval. For further information, see the description of upperCILimit.

#define DOCA_TELEMETRY_NETFLOW_MAX_BIBENTRIES 472

This element represents the maximum BIB entries that can be created by the NAT device.

#define DOCA_TELEMETRY_NETFLOW_MAX_ENTRIES_PER_USER 473

This element represents the maximum NAT entries that can be created per user by the NAT device.

#define DOCA_TELEMETRY_NETFLOW_MAX_EXPORT_SECONDS 260

The absolute Export Time of the latest IPFIX Message within the scope containing this Information Element. This Information Element SHOULD be bound to its containing IPFIX Transport Session via IPFIX Options and the sessionScope Information Element.

#define DOCA_TELEMETRY_NETFLOW_MAX_FLOW_END_MICROSECONDS 268

The latest absolute timestamp of the last packet within any Flow within the scope containing this Information Element, rounded up to the microsecond if necessary. This Information Element SHOULD be bound to its containing IPFIX Transport Session via IPFIX Options and the sessionScope Information Element. This Information Element SHOULD be used only in Transport Sessions containing Flow Records with microsecond- precision (or better) timestamp Information Elements.

#define DOCA_TELEMETRY_NETFLOW_MAX_FLOW_END_MILLISECONDS 269

The latest absolute timestamp of the last packet within any Flow within the scope containing this Information Element, rounded up to the millisecond if necessary. This Information Element SHOULD be bound to its containing IPFIX Transport Session via IPFIX Options and the sessionScope Information Element. This Information Element SHOULD be used only in Transport Sessions containing Flow Records with millisecond- precision (or better) timestamp Information Elements.

#define DOCA_TELEMETRY_NETFLOW_MAX_FLOW_END_NANOSECONDS 270

The latest absolute timestamp of the last packet within any Flow within the scope containing this Information Element. This Information Element SHOULD be bound to its containing IPFIX Transport Session via IPFIX Options and the sessionScope Information Element. This Information Element SHOULD be used only in Transport Sessions containing Flow Records with nanosecond-precision timestamp Information Elements.

#define DOCA_TELEMETRY_NETFLOW_MAX_FLOW_END_SECONDS 261

The latest absolute timestamp of the last packet within any Flow within the scope containing this Information Element, rounded up to the second if necessary. This Information Element SHOULD be bound to its containing IPFIX Transport Session via IPFIX Options and the sessionScope Information Element.

#define DOCA_TELEMETRY_NETFLOW_MAX_FRAGMENTS_PENDING_REASSEMBLY 475

This element represents the maximum fragments that the NAT device can store for reassembling the packet.

#define DOCA_TELEMETRY_NETFLOW_MAX_LAYER2_TOTAL_LENGTH 423

Layer 2 length of the largest packet observed for this Flow. The packet length includes the length of the layer 2 header(s) and the length of the layer 2 payload.

#define DOCA_TELEMETRY_NETFLOW_MAX_PKT_LENGTH 26

Maximum IP packet length on incoming packets of the flow

#define DOCA_TELEMETRY_NETFLOW_MAX_SESSION_ENTRIES 471

This element represents the maximum session entries that can be created by the NAT device.

#define DOCA_TELEMETRY_NETFLOW_MAX_SUBSCRIBERS 474

This element represents the maximum subscribers or maximum hosts that are allowed by the NAT device.

#define DOCA_TELEMETRY_NETFLOW_MAX_TTL 53

Maximum TTL on incoming packets of the flow

#define DOCA_TELEMETRY_NETFLOW_MESSAGE_MD5_CHECKSUM 262

The MD5 checksum of the IPFIX Message containing this record. This Information Element SHOULD be bound to its containing IPFIX Message via an options record and the messageScope Information Element, as defined below, and SHOULD appear only once in a given IPFIX Message. To calculate the value of this Information Element, first buffer the containing IPFIX Message, setting the value of this Information Element to all zeroes. Then calculate the MD5 checksum of the resulting buffer as defined in [RFC1321], place the resulting value in this Information Element, and export the buffered message. This Information Element is intended as a simple checksum only; therefore collision resistance and algorithm agility are not required, and MD5 is an appropriate message digest. This Information Element has a fixed length of 16 octets.

#define DOCA_TELEMETRY_NETFLOW_MESSAGE_SCOPE 263

The presence of this Information Element as scope in an Options Template signifies that the options described by the Template apply to the IPFIX Message that contains them. It is defined for general purpose message scoping of options, and proposed specifically to allow the attachment a checksum to a message via IPFIX Options. The value of this Information Element MUST be written as 0 by the File Writer or Exporting Process. The value of this Information Element MUST be ignored by the File Reader or the Collecting Process.

#define DOCA_TELEMETRY_NETFLOW_METERING_PROCESS_ID 143

An identifier of a Metering Process that is unique per IPFIX Device. Typically, this Information Element is used for limiting the scope of other Information Elements. Note that process identifiers are typically assigned dynamically. The Metering Process may be re-started with a different ID.

#define DOCA_TELEMETRY_NETFLOW_METRO_EVC_ID 247

The EVC Service Attribute which uniquely identifies the Ethernet Virtual Connection (EVC) within a Metro Ethernet Network, as defined in section 6.2 of MEF 10.1. The MetroEVCID is encoded in a string of up to 100 characters.

#define DOCA_TELEMETRY_NETFLOW_METRO_EVC_TYPE 248

The 3-bit EVC Service Attribute which identifies the type of service provided by an EVC.

#define DOCA_TELEMETRY_NETFLOW_MIB_CAPTURE_TIME_SEMANTICS 448

Indicates when in the lifetime of the Flow the MIB value was retrieved from the MIB for a mibObjectIdentifier. This is used to indicate if the value exported was collected from the MIB closer to Flow creation or Flow export time and refers to the Timestamp fields included in the same Data Record. This field SHOULD be used when exporting a mibObjectValue that specifies counters or statistics.

#define DOCA_TELEMETRY_NETFLOW_MIB_CONTEXT_ENGINE_ID 449

A mibContextEngineID that specifies the SNMP engine ID for a MIB field being exported over IPFIX. Definition as per [RFC3411], Section 3.3.

#define DOCA_TELEMETRY_NETFLOW_MIB_CONTEXT_NAME 450

An Information Element that denotes that a MIB context name is specified for a MIB field being exported over IPFIX. Reference [RFC3411], Section 3.3.

#define DOCA_TELEMETRY_NETFLOW_MIB_INDEX_INDICATOR 447

A set of bit fields that is used for marking the Information Elements of a Data Record that serve as INDEX MIB objects for an indexed columnar MIB object. Each bit represents an Information Element in the Data Record, with the n-th least significant bit representing the n-th Information Element. A bit set to 1 indicates that the corresponding Information Element is an index of the columnar object represented by the mibObjectValue. A bit set to 0 indicates that this is not the case.

#define DOCA_TELEMETRY_NETFLOW_MIB_MODULE_NAME 454

The textual name of the MIB module that defines a MIB object.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_DESCRIPTION 452

The value of the DESCRIPTION clause of a MIB object type definition.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_IDENTIFIER 445

An IPFIX Information Element that denotes that a MIB Object Identifier (MIB OID) is exported in the (Options) Template Record. The mibObjectIdentifier Information Element contains the OID assigned to the MIB object type definition encoded as ASN.1/BER [X.690].

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_NAME 451

The name (called a descriptor in [RFC2578] of an object type definition.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_SYNTAX 453

The value of the SYNTAX clause of a MIB object type definition, which may include a textual convention or sub-typing. See [RFC2578].

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_BITS 437

An IPFIX Information Element that denotes that a set of Enumerated flags or bits from a MIB object will be exported. The MIB Object Identifier ("mibObjectIdentifier") for this field MUST be exported in a MIB Field Option or via another means. This Information Element is used for MIB objects with the Base syntax of BITS. The flags or bits are encoded as per the standard IPFIX Abstract Data Type of octetArray, with sufficient length to accommodate the required number of bits. If the number of bits is not an integer multiple of octets, then the most significant bits at the end of the octetArray MUST be set to 0.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_COUNTER 439

An IPFIX Information Element that denotes that the counter value of a MIB object will be exported. The MIB Object Identifier ("mibObjectIdentifier") for this field MUST be exported in a MIB Field Option or via another means. This Information Element is used for MIB objects with the Base syntax of Counter32 or Counter64 with IPFIX reduced-size encoding used as required. The value is encoded as per the standard IPFIX Abstract Data Type of unsigned64.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_GAUGE 440

An IPFIX Information Element that denotes that the Gauge value of a MIB object will be exported. The MIB Object Identifier ("mibObjectIdentifier") for this field MUST be exported in a MIB Field Option or via another means. This Information Element is used for MIB objects with the Base syntax of Gauge32. The value is encoded as per the standard IPFIX Abstract Data Type of unsigned32. This value represents a non-negative integer that may increase or decrease but that shall never exceed a maximum value or fall below a minimum value.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_INTEGER 434

An IPFIX Information Element that denotes that the integer value of a MIB object will be exported. The MIB Object Identifier ("mibObjectIdentifier") for this field MUST be exported in a MIB Field Option or via another means. This Information Element is used for MIB objects with the Base syntax of Integer32 and INTEGER with IPFIX reduced-size encoding used as required. The value is encoded as per the standard IPFIX Abstract Data Type of signed32.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_IPADDRESS 438

An IPFIX Information Element that denotes that the IPv4 address value of a MIB object will be exported. The MIB Object Identifier ("mibObjectIdentifier") for this field MUST be exported in a MIB Field Option or via another means. This Information Element is used for MIB objects with the Base syntax of IpAddress. The value is encoded as per the standard IPFIX Abstract Data Type of ipv4Address.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_OCTET_STRING 435

An IPFIX Information Element that denotes that an Octet String or Opaque value of a MIB object will be exported. The MIB Object Identifier ("mibObjectIdentifier") for this field MUST be exported in a MIB Field Option or via another means. This Information Element is used for MIB objects with the Base syntax of OCTET STRING and Opaque. The value is encoded as per the standard IPFIX Abstract Data Type of octetArray.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_OID 436

An IPFIX Information Element that denotes that an Object Identifier or OID value of a MIB object will be exported. The MIB Object Identifier ("mibObjectIdentifier") for this field MUST be exported in a MIB Field Option or via another means. This Information Element is used for MIB objects with the Base syntax of OBJECT IDENTIFIER. Note: In this case, the "mibObjectIdentifier" defines which MIB object is being exported, and the "mibObjectValueOID" field will contain the OID value of that MIB object. The mibObjectValueOID Information Element is encoded as ASN.1/BER [X.690] in an octetArray.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_ROW 444

An IPFIX Information Element that denotes that a single row of a conceptual table will be exported. The MIB Object Identifier ("mibObjectIdentifier") for this field MUST be exported in a MIB Field Option or via another means. This Information Element is used for MIB objects with a syntax of SEQUENCE. This is encoded as a subTemplateList of mibObjectValue Information Elements. The subTemplateList exported MUST contain exactly one row (i.e., one instance of the subTemplate). The Template specified in the subTemplateList MUST be an Options Template and MUST include all the objects listed in the INDEX clause as Scope Fields.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_TABLE 443

An IPFIX Information Element that denotes that a complete or partial conceptual table will be exported. The MIB Object Identifier ("mibObjectIdentifier") for this field MUST be exported in a MIB Field Option or via another means. This Information Element is used for MIB objects with a syntax of SEQUENCE OF. This is encoded as a subTemplateList of mibObjectValue Information Elements. The Template specified in the subTemplateList MUST be an Options Template and MUST include all the objects listed in the INDEX clause as Scope Fields.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_TIME_TICKS 441

An IPFIX Information Element that denotes that the TimeTicks value of a MIB object will be exported. The MIB Object Identifier ("mibObjectIdentifier") for this field MUST be exported in a MIB Field Option or via another means. This Information Element is used for MIB objects with the Base syntax of TimeTicks. The value is encoded as per the standard IPFIX Abstract Data Type of unsigned32.

#define DOCA_TELEMETRY_NETFLOW_MIB_OBJECT_VALUE_UNSIGNED 442

An IPFIX Information Element that denotes that an unsigned integer value of a MIB object will be exported. The MIB Object Identifier ("mibObjectIdentifier") for this field MUST be exported in a MIB Field Option or via another means. This Information Element is used for MIB objects with the Base syntax of unsigned32 with IPFIX reduced-size encoding used as required. The value is encoded as per the standard IPFIX Abstract Data Type of unsigned32.

#define DOCA_TELEMETRY_NETFLOW_MIB_SUB_IDENTIFIER 446

A non-negative sub-identifier of an Object Identifier (OID).

#define DOCA_TELEMETRY_NETFLOW_MIN_EXPORT_SECONDS 264

The absolute Export Time of the earliest IPFIX Message within the scope containing this Information Element. This Information Element SHOULD be bound to its containing IPFIX Transport Session via an options record and the sessionScope Information Element.

#define DOCA_TELEMETRY_NETFLOW_MIN_FLOW_START_MICROSECONDS 271

The earliest absolute timestamp of the first packet within any Flow within the scope containing this Information Element, rounded down to the microsecond if necessary. This Information Element SHOULD be bound to its containing IPFIX Transport Session via an options record and the sessionScope Information Element. This Information Element SHOULD be used only in Transport Sessions containing Flow Records with microsecond- precision (or better) timestamp Information Elements.

#define DOCA_TELEMETRY_NETFLOW_MIN_FLOW_START_MILLISECONDS 272

The earliest absolute timestamp of the first packet within any Flow within the scope containing this Information Element, rounded down to the millisecond if necessary. This Information Element SHOULD be bound to its containing IPFIX Transport Session via an options record and the sessionScope Information Element. This Information Element SHOULD be used only in Transport Sessions containing Flow Records with millisecond- precision (or better) timestamp Information Elements.

#define DOCA_TELEMETRY_NETFLOW_MIN_FLOW_START_NANOSECONDS 273

The earliest absolute timestamp of the first packet within any Flow within the scope containing this Information Element. This Information Element SHOULD be bound to its containing IPFIX Transport Session via an options record and the sessionScope Information Element. This Information Element SHOULD be used only in Transport Sessions containing Flow Records with nanosecond-precision timestamp Information Elements.

#define DOCA_TELEMETRY_NETFLOW_MIN_FLOW_START_SECONDS 265

The earliest absolute timestamp of the first packet within any Flow within the scope containing this Information Element, rounded down to the second if necessary. This Information Element SHOULD be bound to its containing IPFIX Transport Session via an options record and the sessionScope Information Element.

#define DOCA_TELEMETRY_NETFLOW_MIN_LAYER2_TOTAL_LENGTH 422

Layer 2 length of the smallest packet observed for this Flow. The packet length includes the length of the layer 2 header(s) and the length of the layer 2 payload.

#define DOCA_TELEMETRY_NETFLOW_MIN_PKT_LENGTH 25

Minimum IP packet length on incoming packets of the flow

#define DOCA_TELEMETRY_NETFLOW_MIN_TTL 52

Minimum TTL on incoming packets of the flow

#define DOCA_TELEMETRY_NETFLOW_MOBILE_IMSI 455

The International Mobile Subscription Identity (IMSI). The IMSI is a decimal digit string with up to a maximum of 15 ASCII/UTF-8 encoded digits (0x30 - 0x39).

#define DOCA_TELEMETRY_NETFLOW_MOBILE_MSISDN 456

The Mobile Station International Subscriber Directory Number (MSISDN). The MSISDN is a decimal digit string with up to a maximum of 15 ASCII/UTF-8 encoded digits (0x30 - 0x39).

#define DOCA_TELEMETRY_NETFLOW_MONITORING_INTERVAL_END_MILLI_SECONDS 360

The absolute timestamp at which the monitoring interval ended. A Monitoring interval is the period of time during which the Metering Process is running.

#define DOCA_TELEMETRY_NETFLOW_MONITORING_INTERVAL_START_MILLI_SECONDS 359

The absolute timestamp at which the monitoring interval started. A Monitoring interval is the period of time during which the Metering Process is running.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_1 70

MPLS label at position 1 in the stack. This comprises 20 bits of MPLS label, 3 EXP (experimental) bits and 1 S (end-of-stack) bit.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_10 79

MPLS label at position 10 in the stack. This comprises 20 bits of MPLS label, 3 EXP (experimental) bits and 1 S (end-of-stack) bit.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_2 71

MPLS label at position 2 in the stack. This comprises 20 bits of MPLS label, 3 EXP (experimental) bits and 1 S (end-of-stack) bit.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_3 72

MPLS label at position 3 in the stack. This comprises 20 bits of MPLS label, 3 EXP (experimental) bits and 1 S (end-of-stack) bit.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_4 73

MPLS label at position 4 in the stack. This comprises 20 bits of MPLS label, 3 EXP (experimental) bits and 1 S (end-of-stack) bit.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_5 74

MPLS label at position 5 in the stack. This comprises 20 bits of MPLS label, 3 EXP (experimental) bits and 1 S (end-of-stack) bit.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_6 75

MPLS label at position 6 in the stack. This comprises 20 bits of MPLS label, 3 EXP (experimental) bits and 1 S (end-of-stack) bit.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_7 76

MPLS label at position 7 in the stack. This comprises 20 bits of MPLS label, 3 EXP (experimental) bits and 1 S (end-of-stack) bit.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_8 77

MPLS label at position 8 in the stack. This comprises 20 bits of MPLS label, 3 EXP (experimental) bits and 1 S (end-of-stack) bit.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_9 78

MPLS label at position 9 in the stack. This comprises 20 bits of MPLS label, 3 EXP (experimental) bits and 1 S (end-of-stack) bit.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_STACK_DEPTH 202

The number of labels in the MPLS label stack.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_STACK_LENGTH 201

The length of the MPLS label stack in units of octets.

#define DOCA_TELEMETRY_NETFLOW_MPLS_LABEL_STACK_SECTION 316

This Information Element carries a series of n octets from the MPLS label stack of a sampled packet, starting sectionOffset octets into the MPLS label stack.

#define DOCA_TELEMETRY_NETFLOW_MPLS_PAL_RD 90

MPLS PAL Route Distinguisher.

#define DOCA_TELEMETRY_NETFLOW_MPLS_PAYLOAD_LENGTH 194

The size of the MPLS packet without the label stack.

#define DOCA_TELEMETRY_NETFLOW_MPLS_PAYLOAD_PACKET_SECTION 317

The mplsPayloadPacketSection carries a series of n octets from the MPLS payload of a sampled packet, starting sectionOffset octets into the MPLS payload, as it is data that follows immediately after the MPLS label stack.

#define DOCA_TELEMETRY_NETFLOW_MPLS_PREFIX_LEN 91

Number of consecutive bits in the MPLS prefix length.

#define DOCA_TELEMETRY_NETFLOW_MPLS_TOP_LABEL_EXP 203

The Exp field from the top MPLS label stack entry, i.e., the last label that was pushed.

#define DOCA_TELEMETRY_NETFLOW_MPLS_TOP_LABEL_IPV6_ADDRESS 140

The IPv6 address of the system that the MPLS top label will cause this Flow to be forwarded to.

#define DOCA_TELEMETRY_NETFLOW_MPLS_TOP_LABEL_IP_ADDR 47

Forwarding Equivalent Class corresponding to the MPLS Top Label

#define DOCA_TELEMETRY_NETFLOW_MPLS_TOP_LABEL_TTL 200

The TTL field from the top MPLS label stack entry, i.e., the last label that was pushed.

#define DOCA_TELEMETRY_NETFLOW_MPLS_TOP_LABEL_TYPE 46

MPLS Top Label Type: 0x00 UNKNOWN 0x01 TE-MIDPT 0x02 ATOM 0x03 VPN 0x04 BGP 0x05 LDP

#define DOCA_TELEMETRY_NETFLOW_MUL_DST_BYTES 20

IP multicast outgoing byte counter with length N x 8 bits for bytes associated with the IP Flow

#define DOCA_TELEMETRY_NETFLOW_MUL_DST_PKTS 19

IP multicast outgoing packet counter with length N x 8 bits for packets associated with the IP Flow

#define DOCA_TELEMETRY_NETFLOW_MUL_IGMP_TYPE 33

Internet Group Management Protocol (IGMP) packet type

#define DOCA_TELEMETRY_NETFLOW_NAT_EVENT 230

This Information Element identifies a NAT event. This IE identifies the type of a NAT event. Examples of NAT events include, but are not limited to, NAT translation create, NAT translation delete, Threshold Reached, or Threshold Exceeded, etc. Values for this Information Element are listed in the "NAT Event Type" registry, see [http://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-event-type].

#define DOCA_TELEMETRY_NETFLOW_NAT_INSTANCE_ID 463

This Information Element uniquely identifies an Instance of the NAT that runs on a NAT middlebox function after the packet passes the Observation Point. natInstanceID is defined in [RFC7659].

#define DOCA_TELEMETRY_NETFLOW_NAT_ORIGINATING_ADDRESS_REALM 229

Indicates whether the session was created because traffic originated in the private or public address realm. postNATSourceIPv4Address, postNATDestinationIPv4Address, postNAPTSourceTransportPort, and postNAPTDestinationTransportPort are qualified with the address realm in perspective.

#define DOCA_TELEMETRY_NETFLOW_NAT_POOL_ID 283

Locally unique identifier of a NAT pool.

#define DOCA_TELEMETRY_NETFLOW_NAT_POOL_NAME 284

The name of a NAT pool identified by a natPoolID.

#define DOCA_TELEMETRY_NETFLOW_NAT_QUOTA_EXCEEDED_EVENT 466

This Information Element identifies the type of a NAT Quota Exceeded event. Values for this Information Element are listed in the "NAT Quota Exceeded Event Type" registry, see [http://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-quota-exceeded-event].

#define DOCA_TELEMETRY_NETFLOW_NAT_THRESHOLD_EVENT 467

This Information Element identifies a type of a NAT Threshold event. Values for this Information Element are listed in the "NAT Threshold Event Type" registry, see [http://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-threshold-event].

#define DOCA_TELEMETRY_NETFLOW_NAT_TYPE 297

Values are listed in the natType registry. See [http://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-type].

#define DOCA_TELEMETRY_NETFLOW_NEW_CONNECTION_DELTA_COUNT 278

This information element counts the number of TCP or UDP connections which were opened during the observation period. The observation period may be specified by the flow start and end timestamps.

#define DOCA_TELEMETRY_NETFLOW_NEXT_HEADER_IPV6 193

The value of the Next Header field of the IPv6 header. The value identifies the type of the following IPv6 extension header or of the following IP payload. Valid values are defined in the IANA Protocol Numbers registry.

#define DOCA_TELEMETRY_NETFLOW_NOT_SENT_FLOW_TOTAL_COUNT 166

The total number of Flow Records that were generated by the Metering Process and dropped by the Metering Process or by the Exporting Process instead of being sent to the Collecting Process. There are several potential reasons for this including resource shortage and special Flow export policies.

#define DOCA_TELEMETRY_NETFLOW_NOT_SENT_LAYER2_OCTET_TOTAL_COUNT 427

The total number of octets in observed layer 2 packets (including the layer 2 header) that the Metering Process did not process since the (re-)initialization of the Metering Process.

#define DOCA_TELEMETRY_NETFLOW_NOT_SENT_OCTET_TOTAL_COUNT 168

The total number of octets in packets in Flow Records that were generated by the Metering Process and dropped by the Metering Process or by the Exporting Process instead of being sent to the Collecting Process. There are several potential reasons for this including resource shortage and special Flow export policies.

#define DOCA_TELEMETRY_NETFLOW_NOT_SENT_PACKET_TOTAL_COUNT 167

The total number of packets in Flow Records that were generated by the Metering Process and dropped by the Metering Process or by the Exporting Process instead of being sent to the Collecting Process. There are several potential reasons for this including resource shortage and special Flow export policies.

#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_DOMAIN_ID 149

An identifier of an Observation Domain that is locally unique to an Exporting Process. The Exporting Process uses the Observation Domain ID to uniquely identify to the Collecting Process the Observation Domain where Flows were metered. It is RECOMMENDED that this identifier is also unique per IPFIX Device.

#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_DOMAIN_NAME 300

The name of an observation domain identified by an observationDomainId.

#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_POINT_ID 138

An identifier of an Observation Point that is unique per Observation Domain. It is RECOMMENDED that this identifier is also unique per IPFIX Device. Typically, this Information Element is used for limiting the scope of other Information Elements.

#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_POINT_TYPE 277

Type of observation point. Values are listed in the observationPointType registry. See [http://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-observation-point-type].

#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_TIME_MICROSECONDS 324

This Information Element specifies the absolute time in microseconds of an observation.

#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_TIME_MILLISECONDS 323

This Information Element specifies the absolute time in milliseconds of an observation.

#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_TIME_NANOSECONDS 325

This Information Element specifies the absolute time in nanoseconds of an observation.

#define DOCA_TELEMETRY_NETFLOW_OBSERVATION_TIME_SECONDS 322

This Information Element specifies the absolute time in seconds of an observation.

#define DOCA_TELEMETRY_NETFLOW_OBSERVED_FLOW_TOTAL_COUNT 163

The total number of Flows observed in the Observation Domain since the Metering Process (re-)initialization for this Observation Point.

#define DOCA_TELEMETRY_NETFLOW_OCTET_DELTA_SUM_OF_SQUARES 198

The sum of the squared numbers of octets per incoming packet since the previous report (if any) for this Flow at the Observation Point. The number of octets includes IP header(s) and IP payload.

#define DOCA_TELEMETRY_NETFLOW_OCTET_TOTAL_SUM_OF_SQUARES 199

The total sum of the squared numbers of octets in incoming packets for this Flow at the Observation Point since the Metering Process (re-)initialization for this Observation Point. The number of octets includes IP header(s) and IP payload.

#define DOCA_TELEMETRY_NETFLOW_OPAQUE_OCTETS 266

This Information Element is used to encapsulate non- IPFIX data into an IPFIX Message stream, for the purpose of allowing a non-IPFIX data processor to store a data stream inline within an IPFIX File. A Collecting Process or File Writer MUST NOT try to interpret this binary data. This Information Element differs from paddingOctets as its contents are meaningful in some non-IPFIX context, while the contents of paddingOctets MUST be 0x00 and are intended only for Information Element alignment.

#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_EXPORTER_IPV4_ADDRESS 403

The IPv4 address used by the Exporting Process on an Original Exporter, as seen by the Collecting Process on an IPFIX Mediator. Used to provide information about the Original Observation Points to a downstream Collector.

#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_EXPORTER_IPV6_ADDRESS 404

The IPv6 address used by the Exporting Process on an Original Exporter, as seen by the Collecting Process on an IPFIX Mediator. Used to provide information about the Original Observation Points to a downstream Collector.

#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_FLOWS_COMPLETED 377

The conservative count of Original Flows whose last packet is represented within this Aggregated Flow. Conservative counts must sum to the original count on re-aggregation.

#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_FLOWS_INITIATED 376

The conservative count of Original Flows whose first packet is represented within this Aggregated Flow. Conservative counts must sum to the original count on re-aggregation.

#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_FLOWS_PRESENT 375

The non-conservative count of Original Flows contributing to this Aggregated Flow. Non-conservative counts need not sum to the original count on re-aggregation.

#define DOCA_TELEMETRY_NETFLOW_ORIGINAL_OBSERVATION_DOMAIN_ID 405

The Observation Domain ID reported by the Exporting Process on an Original Exporter, as seen by the Collecting Process on an IPFIX Mediator. Used to provide information about the Original Observation Domain to a downstream Collector. When cascading through multiple Mediators, this identifies the initial Observation Domain in the cascade.

#define DOCA_TELEMETRY_NETFLOW_OUTPUT_SNMP 14

Output interface index; default for N is 2 but higher values could be used

#define DOCA_TELEMETRY_NETFLOW_OUT_BYTES 23

Outgoing counter with length N x 8 bits for the number of bytes associated with an IP Flow

#define DOCA_TELEMETRY_NETFLOW_OUT_DST_MAC 57

Outgoing destination MAC address

#define DOCA_TELEMETRY_NETFLOW_OUT_PKTS 24

Outgoing counter with length N x 8 bits for the number of packets associated with an IP Flow.

#define DOCA_TELEMETRY_NETFLOW_OUT_SRC_MAC 81

Outgoing source MAC address

#define DOCA_TELEMETRY_NETFLOW_P2P_TECHNOLOGY 288

Specifies if the Application ID is based on peer-to-peer technology.

#define DOCA_TELEMETRY_NETFLOW_PADDING_OCTETS 210

The value of this Information Element is always a sequence of 0x00 values.

#define DOCA_TELEMETRY_NETFLOW_PAYLOAD_LENGTH_IPV6 191

This Information Element reports the value of the Payload Length field in the IPv6 header. Note that IPv6 extension headers belong to the payload. Also note that in case of a jumbo payload option the value of the Payload Length field in the IPv6 header is zero and so will be the value reported by this Information Element.

#define DOCA_TELEMETRY_NETFLOW_PORT_ID 142

An identifier of a line port that is unique per IPFIX Device hosting an Observation Point. Typically, this Information Element is used for limiting the scope of other Information Elements.

#define DOCA_TELEMETRY_NETFLOW_PORT_RANGE_END 362

The port number identifying the end of a range of ports. A value of zero indicates that the range end is not specified, ie the range is defined in some other way.

#define DOCA_TELEMETRY_NETFLOW_PORT_RANGE_NUM_PORTS 364

The number of ports in a port range. A value of zero indicates that the number of ports is not specified, ie the range is defined in some other way.

#define DOCA_TELEMETRY_NETFLOW_PORT_RANGE_START 361

The port number identifying the start of a range of ports. A value of zero indicates that the range start is not specified, ie the range is defined in some other way.

#define DOCA_TELEMETRY_NETFLOW_PORT_RANGE_STEP_SIZE 363

The step size in a port range. The default step size is 1, which indicates contiguous ports. A value of zero indicates that the step size is not specified, ie the range is defined in some other way.

#define DOCA_TELEMETRY_NETFLOW_POSTIP_DIFF_SERV_CODE_POINT 98

The value of a Differentiated Services Code Point (DSCP) encoded in the Differentiated Services Field, after modification.

#define DOCA_TELEMETRY_NETFLOW_POST_DOT1Q_CUSTOMER_VLAN_ID 255

The definition of this Information Element is identical to the definition of Information Element 'dot1qCustomerVlanId', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_POST_DOT1Q_VLAN_ID 254

The definition of this Information Element is identical to the definition of Information Element 'dot1qVlanId', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_POST_IP_PRECEDENCE 257

The definition of this Information Element is identical to the definition of Information Element 'ipPrecedence', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_POST_LAYER2_OCTET_DELTA_COUNT 417

The definition of this Information Element is identical to the definition of the layer2OctetDeltaCount Information Element, except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_POST_LAYER2_OCTET_TOTAL_COUNT 420

The definition of this Information Element is identical to the definition of the layer2OctetTotalCount Information Element, except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_POST_MCAST_LAYER2_OCTET_DELTA_COUNT 418

The number of layer 2 octets since the previous report (if any) in outgoing multicast packets sent for packets of this Flow by a multicast daemon within the Observation Domain. This property cannot necessarily be observed at the Observation Point but may be retrieved by other means. The number of octets includes layer 2 header(s) and layer 2 payload.

#define DOCA_TELEMETRY_NETFLOW_POST_MCAST_LAYER2_OCTET_TOTAL_COUNT 421

The total number of layer 2 octets in outgoing multicast packets sent for packets of this Flow by a multicast daemon in the Observation Domain since the Metering Process (re-)initialization. This property cannot necessarily be observed at the Observation Point but may be retrieved by other means. The number of octets includes layer 2 header(s) and layer 2 payload.

#define DOCA_TELEMETRY_NETFLOW_POST_MCAST_OCTET_TOTAL_COUNT 175

The total number of octets in outgoing multicast packets sent for packets of this Flow by a multicast daemon in the Observation Domain since the Metering Process (re-)initialization. This property cannot necessarily be observed at the Observation Point, but may be retrieved by other means. The number of octets includes IP header(s) and IP payload.

#define DOCA_TELEMETRY_NETFLOW_POST_MCAST_PACKET_TOTAL_COUNT 174

The total number of outgoing multicast packets sent for packets of this Flow by a multicast daemon within the Observation Domain since the Metering Process (re-)initialization. This property cannot necessarily be observed at the Observation Point, but may be retrieved by other means.

#define DOCA_TELEMETRY_NETFLOW_POST_MPLS_TOP_LABEL_EXP 237

The definition of this Information Element is identical to the definition of Information Element 'mplsTopLabelExp', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_POST_NAPT_DESTINATION_TRANSPORT_PORT 228

The definition of this Information Element is identical to the definition of Information Element 'destinationTransportPort', except that it reports a modified value caused by a Network Address Port Translation (NAPT) middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_POST_NAPT_SOURCE_TRANSPORT_PORT 227

The definition of this Information Element is identical to the definition of Information Element 'sourceTransportPort', except that it reports a modified value caused by a Network Address Port Translation (NAPT) middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_POST_NATDESTINATION_IPV6_ADDRESS 282

The definition of this Information Element is identical to the definition of Information Element 'destinationIPv6Address', except that it reports a modified value caused by a NAT64 middlebox function after the packet passed the Observation Point. See [RFC8200] for the definition of the Destination Address field in the IPv6 header. See [RFC3234] for the definition of middleboxes. See [RFC6146] for nat64 specification.

#define DOCA_TELEMETRY_NETFLOW_POST_NATSOURCE_IPV6_ADDRESS 281

The definition of this Information Element is identical to the definition of Information Element 'sourceIPv6Address', except that it reports a modified value caused by a NAT64 middlebox function after the packet passed the Observation Point. See [RFC8200] for the definition of the Source Address field in the IPv6 header. See [RFC3234] for the definition of middleboxes. See [RFC6146] for nat64 specification.

#define DOCA_TELEMETRY_NETFLOW_POST_NAT_DESTINATION_IPV4_ADDRESS 226

The definition of this Information Element is identical to the definition of Information Element 'destinationIPv4Address', except that it reports a modified value caused by a NAT middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_POST_NAT_SOURCE_IPV4_ADDRESS 225

The definition of this Information Element is identical to the definition of Information Element 'sourceIPv4Address', except that it reports a modified value caused by a NAT middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_POST_OCTET_TOTAL_COUNT 171

The definition of this Information Element is identical to the definition of Information Element 'octetTotalCount', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_POST_PACKET_TOTAL_COUNT 172

The definition of this Information Element is identical to the definition of Information Element 'packetTotalCount', except that it reports a potentially modified value caused by a middlebox function after the packet passed the Observation Point.

#define DOCA_TELEMETRY_NETFLOW_PRIVATE_ENTERPRISE_NUMBER 346

A private enterprise number, as assigned by IANA. Within the context of an Information Element Type record, this element can be used along with the informationElementId element to scope properties to a specific Information Element. To export type information about an IANA-assigned Information Element, set the privateEnterpriseNumber to 0, or do not export the privateEnterpriseNumber in the type record. To export type information about an enterprise-specific Information Element, export the enterprise number in privateEnterpriseNumber, and export the Information Element number with the Enterprise bit cleared in informationElementId. The Enterprise bit in the associated informationElementId Information Element MUST be ignored by the Collecting Process.

#define DOCA_TELEMETRY_NETFLOW_PROTOCOL 4

IP protocol byte

#define DOCA_TELEMETRY_NETFLOW_PSEUDO_WIRE_CONTROL_WORD 251

The 32-bit Preferred Pseudo Wire (PW) MPLS Control Word as defined in Section 3 of [RFC4385].

#define DOCA_TELEMETRY_NETFLOW_PSEUDO_WIRE_DESTINATION_IPV4_ADDRESS 432

The destination IPv4 address of the PSN tunnel carrying the pseudowire.

#define DOCA_TELEMETRY_NETFLOW_PSEUDO_WIRE_ID 249

A 32-bit non-zero connection identifier, which together with the pseudoWireType, identifies the Pseudo Wire (PW) as defined in [RFC8077].

#define DOCA_TELEMETRY_NETFLOW_PSEUDO_WIRE_TYPE 250

The value of this information element identifies the type of MPLS Pseudo Wire (PW) as defined in [RFC4446].

#define DOCA_TELEMETRY_NETFLOW_RELATIVE_ERROR 321

This Information Element specifies the maximum possible positive or negative error ratio for the reported value for a given Information Element as percentage of the measured value. The real value of the metric can differ by relativeError percent (positive or negative) from the measured value.

#define DOCA_TELEMETRY_NETFLOW_REPLICATION_FACTOR 99

Multicast replication factor.

#define DOCA_TELEMETRY_NETFLOW_RESPONDER_OCTETS 232

The total number of layer 4 payload bytes in a flow from the responder since the previous report. The responder is the device which replies to the initiator, and remains the same for the life of the session.

#define DOCA_TELEMETRY_NETFLOW_RESPONDER_PACKETS 299

The total number of layer 4 packets in a flow from the responder since the previous report. The responder is the device which replies to the initiator, and remains the same for the life of the session.

#define DOCA_TELEMETRY_NETFLOW_RFC3550_JITTER_MICROSECONDS 386

Interarrival jitter as defined in section 6.4.1 of [RFC3550], measured in microseconds.

#define DOCA_TELEMETRY_NETFLOW_RFC3550_JITTER_MILLISECONDS 385

Interarrival jitter as defined in section 6.4.1 of [RFC3550], measured in milliseconds.

#define DOCA_TELEMETRY_NETFLOW_RFC3550_JITTER_NANOSECONDS 387

Interarrival jitter as defined in section 6.4.1 of [RFC3550], measured in nanoseconds.

#define DOCA_TELEMETRY_NETFLOW_RTP_SEQUENCE_NUMBER 370

The RTP sequence number per [RFC3550].

#define DOCA_TELEMETRY_NETFLOW_SAMPLER_NAME 84

Name of the flow sampler

#define DOCA_TELEMETRY_NETFLOW_SAMPLING_ALGORITHM 35

The type of algorithm used for sampled NetFlow: 0x01 Deterministic Sampling ,0x02 Random Sampling

#define DOCA_TELEMETRY_NETFLOW_SAMPLING_FLOW_INTERVAL 396

This Information Element specifies the number of Flows that are consecutively sampled. A value of 100 means that 100 consecutive Flows are sampled. For example, this Information Element may be used to describe the configuration of a systematic count-based Sampling Selector.

#define DOCA_TELEMETRY_NETFLOW_SAMPLING_FLOW_SPACING 397

This Information Element specifies the number of Flows between two "samplingFlowInterval"s. A value of 100 means that the next interval starts 100 Flows (which are not sampled) after the current "samplingFlowInterval" is over. For example, this Information Element may be used to describe the configuration of a systematic count-based Sampling Selector.

#define DOCA_TELEMETRY_NETFLOW_SAMPLING_INTERVAL 34

When using sampled NetFlow, the rate at which packets are sampled i.e.: a value of 100 indicates that one of every 100 packets is sampled

#define DOCA_TELEMETRY_NETFLOW_SAMPLING_PACKET_INTERVAL 305

This Information Element specifies the number of packets that are consecutively sampled. A value of 100 means that 100 consecutive packets are sampled.

#define DOCA_TELEMETRY_NETFLOW_SAMPLING_PACKET_SPACE 306

This Information Element specifies the number of packets between two "samplingPacketInterval"s. A value of 100 means that the next interval starts 100 packets (which are not sampled) after the current "samplingPacketInterval" is over.

#define DOCA_TELEMETRY_NETFLOW_SAMPLING_POPULATION 310

This Information Element specifies the number of elements in the parent Population for random Sampling methods.

#define DOCA_TELEMETRY_NETFLOW_SAMPLING_PROBABILITY 311

This Information Element specifies the probability that a packet is sampled, expressed as a value between 0 and 1. The probability is equal for every packet. A value of 0 means no packet was sampled since the probability is 0.

#define DOCA_TELEMETRY_NETFLOW_SAMPLING_SIZE 309

This Information Element specifies the number of elements taken from the parent Population for random Sampling methods.

#define DOCA_TELEMETRY_NETFLOW_SAMPLING_TIME_INTERVAL 307

This Information Element specifies the time interval in microseconds during which all arriving packets are sampled.

#define DOCA_TELEMETRY_NETFLOW_SAMPLING_TIME_SPACE 308

This Information Element specifies the time interval in microseconds between two "samplingTimeInterval"s. A value of 100 means that the next interval starts 100 microseconds (during which no packets are sampled) after the current "samplingTimeInterval" is over.

#define DOCA_TELEMETRY_NETFLOW_SECTION_EXPORTED_OCTETS 410

This Information Element specifies the observed length of the packet section (e.g., dataLinkFrameSection, ipHeaderPacketSection, ipPayloadPacketSection, mplsLabelStackSection, and mplsPayloadPacketSection) when padding is used.

#define DOCA_TELEMETRY_NETFLOW_SECTION_OFFSET 409

This Information Element specifies the offset of the packet section (e.g., dataLinkFrameSection, ipHeaderPacketSection, ipPayloadPacketSection, mplsLabelStackSection, and mplsPayloadPacketSection). If this Information Element is omitted, it defaults to zero (i.e., no offset).

#define DOCA_TELEMETRY_NETFLOW_SELECTION_SEQUENCE_ID 301

From all the packets observed at an Observation Point, a subset of the packets is selected by a sequence of one or more Selectors. The selectionSequenceId is a unique value per Observation Domain, specifying the Observation Point and the sequence of Selectors through which the packets are selected.

#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ALGORITHM 304

This Information Element identifies the packet selection methods (e.g., Filtering, Sampling) that are applied by the Selection Process.

#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ID 302

The Selector ID is the unique ID identifying a Primitive Selector. Each Primitive Selector must have a unique ID in the Observation Domain.

#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ID_TOTAL_FLOWS_OBSERVED 394

This Information Element specifies the total number of Flows observed by a Selector, for a specific value of SelectorId. This Information Element should be used in an Options Template scoped to the observation to which it refers. See Section 3.4.2.1 of the IPFIX protocol document [RFC7011].

#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ID_TOTAL_FLOWS_SELECTED 395

This Information Element specifies the total number of Flows selected by a Selector, for a specific value of SelectorId. This Information Element should be used in an Options Template scoped to the observation to which it refers. See Section 3.4.2.1 of the IPFIX protocol document [RFC7011].

#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ID_TOTAL_PKTS_OBSERVED 318

This Information Element specifies the total number of packets observed by a Selector, for a specific value of SelectorId.

#define DOCA_TELEMETRY_NETFLOW_SELECTOR_ID_TOTAL_PKTS_SELECTED 319

This Information Element specifies the total number of packets selected by a Selector, for a specific value of SelectorId.

#define DOCA_TELEMETRY_NETFLOW_SELECTOR_NAME 335

The name of a selector identified by a selectorID. Globally unique per Metering Process.

#define DOCA_TELEMETRY_NETFLOW_SESSION_SCOPE 267

The presence of this Information Element as scope in an Options Template signifies that the options described by the Template apply to the IPFIX Transport Session that contains them. Note that as all options are implicitly scoped to Transport Session and Observation Domain, this Information Element is equivalent to a "null" scope. It is defined for general purpose session scoping of options, and proposed specifically to allow the attachment of time window to an IPFIX File via IPFIX Options. The value of this Information Element MUST be written as 0 by the File Writer or Exporting Process. The value of this Information Element MUST be ignored by the File Reader or the Collecting Process.

#define DOCA_TELEMETRY_NETFLOW_SOURCE_IPV6_PREFIX 170

IPv6 source address prefix.

#define DOCA_TELEMETRY_NETFLOW_SOURCE_TRANSPORT_PORTS_LIMIT 458

This Information Element contains the maximum number of IP source transport ports that can be used by an end user when sending IP packets; each user is associated with one or more (source) IPv4 or IPv6 addresses. This Information Element is particularly useful in address-sharing deployments that adhere to REQ-4 of [RFC6888]. Limiting the number of ports assigned to each user ensures fairness among users and mitigates the denial-of-service attack that a user could launch against other users through the address-sharing device in order to grab more ports.

#define DOCA_TELEMETRY_NETFLOW_SRC_AS 16

Source BGP autonomous system number where N could be 2 or 4

#define DOCA_TELEMETRY_NETFLOW_SRC_MASK 9

The number of contiguous bits in the source address subnet mask i.e.: the submask in slash notation

#define DOCA_TELEMETRY_NETFLOW_SRC_TOS 5

Type of Service byte setting when entering incoming interface

#define DOCA_TELEMETRY_NETFLOW_SRC_TRAFFIC_INDEX 92

BGP Policy Accounting Source Traffic Index

#define DOCA_TELEMETRY_NETFLOW_SRC_VLAN 58

Virtual LAN identifier associated with ingress interface

#define DOCA_TELEMETRY_NETFLOW_STA_IPV4_ADDRESS 366

The IPv4 address of a wireless station (STA).

#define DOCA_TELEMETRY_NETFLOW_STA_MAC_ADDRESS 365

The IEEE 802 MAC address of a wireless station (STA).

#define DOCA_TELEMETRY_NETFLOW_SUB_TEMPLATE_LIST 292

Specifies a generic Information Element with a subTemplateList abstract data type.

#define DOCA_TELEMETRY_NETFLOW_SUB_TEMPLATE_MULTI_LIST 293

Specifies a generic Information Element with a subTemplateMultiList abstract data type.

#define DOCA_TELEMETRY_NETFLOW_SYSTEM_INIT_TIME_MILLISECONDS 160

The absolute timestamp of the last (re-)initialization of the IPFIX Device.

#define DOCA_TELEMETRY_NETFLOW_TCP_ACKNOWLEDGMENT_NUMBER 185

The acknowledgment number in the TCP header.

#define DOCA_TELEMETRY_NETFLOW_TCP_ACK_TOTAL_COUNT 222

The total number of packets of this Flow with TCP "Acknowledgment field significant" (ACK) flag set.

#define DOCA_TELEMETRY_NETFLOW_TCP_DESTINATION_PORT 183

The destination port identifier in the TCP header.

#define DOCA_TELEMETRY_NETFLOW_TCP_FIN_TOTAL_COUNT 219

The total number of packets of this Flow with TCP "No more data from sender" (FIN) flag set.

#define DOCA_TELEMETRY_NETFLOW_TCP_FLAGS 6

Cumulative of all the TCP flags seen for this flow

#define DOCA_TELEMETRY_NETFLOW_TCP_HEADER_LENGTH 188

The length of the TCP header. Note that the value of this Information Element is different from the value of the Data Offset field in the TCP header. The Data Offset field indicates the length of the TCP header in units of 4 octets. This Information Elements specifies the length of the TCP header in units of octets.

#define DOCA_TELEMETRY_NETFLOW_TCP_OPTIONS 209

TCP options in packets of this Flow. The information is encoded in a set of bit fields. For each TCP option, there is a bit in this set. The bit is set to 1 if any observed packet of this Flow contains the corresponding TCP option. Otherwise, if no observed packet of this Flow contained the respective TCP option, the value of the corresponding bit is 0.

#define DOCA_TELEMETRY_NETFLOW_TCP_PSH_TOTAL_COUNT 221

The total number of packets of this Flow with TCP "Push Function" (PSH) flag set.

#define DOCA_TELEMETRY_NETFLOW_TCP_RST_TOTAL_COUNT 220

The total number of packets of this Flow with TCP "Reset the connection" (RST) flag set.

#define DOCA_TELEMETRY_NETFLOW_TCP_SEQUENCE_NUMBER 184

The sequence number in the TCP header.

#define DOCA_TELEMETRY_NETFLOW_TCP_SOURCE_PORT 182

The source port identifier in the TCP header.

#define DOCA_TELEMETRY_NETFLOW_TCP_SYN_TOTAL_COUNT 218

The total number of packets of this Flow with TCP "Synchronize sequence numbers" (SYN) flag set.

#define DOCA_TELEMETRY_NETFLOW_TCP_URGENT_POINTER 187

The urgent pointer in the TCP header.

#define DOCA_TELEMETRY_NETFLOW_TCP_URG_TOTAL_COUNT 223

The total number of packets of this Flow with TCP "Urgent Pointer field significant" (URG) flag set.

#define DOCA_TELEMETRY_NETFLOW_TCP_WINDOW_SCALE 238

The scale of the window field in the TCP header.

#define DOCA_TELEMETRY_NETFLOW_TCP_WINDOW_SIZE 186

The window field in the TCP header. If the TCP window scale is supported, then TCP window scale must be known to fully interpret the value of this information.

#define DOCA_TELEMETRY_NETFLOW_TEMPLATE_ID 145

An identifier of a Template that is locally unique within a combination of a Transport session and an Observation Domain.

#define DOCA_TELEMETRY_NETFLOW_TOTAL_BYTES_EXP 40

Counter with length N x 8 bits for bytes for the number of bytes exported by the Observation Domain

#define DOCA_TELEMETRY_NETFLOW_TOTAL_FLOWS_EXP 42

Counter with length N x 8 bits for bytes for the number of flows exported by the Observation Domain

#define DOCA_TELEMETRY_NETFLOW_TOTAL_LENGTH_IPV4 190

The total length of the IPv4 packet.

#define DOCA_TELEMETRY_NETFLOW_TOTAL_PKTS_EXP 41

Counter with length N x 8 bits for bytes for the number of packets exported by the Observation Domain

#define DOCA_TELEMETRY_NETFLOW_TRANSPORT_OCTET_DELTA_COUNT 401

The number of octets, excluding IP header(s) and Layer 4 transport protocol header(s), observed for this Flow at the Observation Point since the previous report (if any).

#define DOCA_TELEMETRY_NETFLOW_TRANSPORT_PACKET_DELTA_COUNT 402

The number of packets containing at least one octet beyond the IP header(s) and Layer 4 transport protocol header(s), observed for this Flow at the Observation Point since the previous report (if any).

#define DOCA_TELEMETRY_NETFLOW_TUNNEL_TECHNOLOGY 289

Specifies if the Application ID is used as a tunnel technology.

#define DOCA_TELEMETRY_NETFLOW_UDP_DESTINATION_PORT 181

The destination port identifier in the UDP header.

#define DOCA_TELEMETRY_NETFLOW_UDP_MESSAGE_LENGTH 205

The value of the Length field in the UDP header.

#define DOCA_TELEMETRY_NETFLOW_UDP_SOURCE_PORT 180

The source port identifier in the UDP header.

#define DOCA_TELEMETRY_NETFLOW_UPPER_CILIMIT 336

This Information Element specifies the upper limit of a confidence interval. It is used to provide an accuracy statement for an estimated value. The confidence limits define the range in which the real value is assumed to be with a certain probability p. Confidence limits always need to be associated with a confidence level that defines this probability p. Please note that a confidence interval only provides a probability that the real value lies within the limits. That means the real value can lie outside the confidence limits.

#define DOCA_TELEMETRY_NETFLOW_USER_NAME 371

User name associated with the flow.

#define DOCA_TELEMETRY_NETFLOW_VALUE_DISTRIBUTION_METHOD 384

A description of the method used to distribute the counters from Contributing Flows into the Aggregated Flow records described by an associated scope, generally a Template. The method is deemed to apply to all the non-key Information Elements in the referenced scope for which value distribution is a valid operation; if the originalFlowsInitiated and/or originalFlowsCompleted Information Elements appear in the Template, they are not subject to this distribution method, as they each infer their own distribution method. The valueDistributionMethod registry is intended to list a complete set of possible value distribution methods. See [https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-value-distribution-method].

#define DOCA_TELEMETRY_NETFLOW_VIRTUAL_STATION_INTERFACE_ID 347

Instance Identifier of the interface to a Virtual Station. A Virtual Station is an end station instance: it can be a virtual machine or a physical host.

#define DOCA_TELEMETRY_NETFLOW_VIRTUAL_STATION_INTERFACE_NAME 348

Name of the interface to a Virtual Station. A Virtual Station is an end station instance: it can be a virtual machine or a physical host.

#define DOCA_TELEMETRY_NETFLOW_VIRTUAL_STATION_NAME 350

Name of a Virtual Station. A Virtual Station is an end station instance: it can be a virtual machine or a physical host.

#define DOCA_TELEMETRY_NETFLOW_VIRTUAL_STATION_UUID 349

Unique Identifier of a Virtual Station. A Virtual Station is an end station instance: it can be a virtual machine or a physical host.

#define DOCA_TELEMETRY_NETFLOW_VPN_IDENTIFIER 482

VPN ID in the format specified by [RFC2685]. The size of this Information Element is 7 octets.

#define DOCA_TELEMETRY_NETFLOW_VRF_NAME 236

The name of a VPN Routing and Forwarding table (VRF).

#define DOCA_TELEMETRY_NETFLOW_WLAN_CHANNEL_ID 146

The identifier of the 802.11 (Wi-Fi) channel used.

#define DOCA_TELEMETRY_NETFLOW_WLAN_SSID 147

The Service Set IDentifier (SSID) identifying an 802.11 (Wi-Fi) network used. According to IEEE.802-11.1999, the SSID is encoded into a string of up to 32 characters.

#define DOCA_TELEMETRY_NETFLOW_WTP_MAC_ADDRESS 367

The IEEE 802 MAC address of a wireless access point (WTP).

2.40. Version Management

Define functions to get the DOCA version, and compare against it.

Defines

#define DOCA_CURRENT_VERSION_NUM: Macro of current version number for comparisons.
#define DOCA_VERSION_EQ_CURRENT ( major, minor, patch ): Check if the version specified is equal to current.
#define DOCA_VERSION_LTE_CURRENT ( major, minor, patch ): Check if the version specified is less then or equal to current.
#define DOCA_VERSION_NUM ( major, minor, patch ): Macro of version number for comparisons.
#define DOCA_VER_MAJOR 2: Major version number 0-255.
#define DOCA_VER_MINOR 2: Minor version number 0-255.
#define DOCA_VER_PATCH 78: Patch version number 0-9999.
#define DOCA_VER_STRING "2.2.0078": DOCA Version String.

Functions

const char* doca_version ( void ): Function returning DOCA's (SDK) version string.
const __DOCA_EXPERIMENTAL char* doca_version_runtime ( void ): Function returning DOCA's (runtime) version string.

Defines

#define DOCA_CURRENT_VERSION_NUM

Value

DOCA_VERSION_NUM(DOCA_VER_MAJOR, DOCA_VER_MINOR, DOCA_VER_PATCH)

#define DOCA_VERSION_EQ_CURRENT ( major, minor, patch )

Value

(DOCA_VERSION_NUM(major, minor, patch) == DOCA_CURRENT_VERSION_NUM)

#define DOCA_VERSION_LTE_CURRENT ( major, minor, patch )

Value

(DOCA_VERSION_NUM(major, minor, patch) <= DOCA_CURRENT_VERSION_NUM)

#define DOCA_VERSION_NUM ( major, minor, patch )

Value

((size_t)((major) << 24 | (minor) << 16 | (patch)))

#define DOCA_VER_MAJOR 2

#define DOCA_VER_MINOR 2

#define DOCA_VER_PATCH 78

#define DOCA_VER_STRING "2.2.0078"

Functions

const char* doca_version ( void ) [inline]

Function returning DOCA's (SDK) version string.

Returns

version string, using the format major.minor.patch.

Description

Note:

Represents the SDK version a project was compiled with.

const __DOCA_EXPERIMENTAL char* doca_version_runtime ( void )

Function returning DOCA's (runtime) version string.

Returns

version string, using the format major.minor.patch.

Description

Note:

Represents the runtime version a project is linked against.