DOCA UROM Plugins

Collaboration diagram for DOCA UROM Plugins:

Data Structures
struct	doca_urom_service_plugin_info
struct	urom_worker_cmd
	UROM Worker command structure. More...
struct	urom_worker_cmd_desc
	UROM Worker command descriptor structure. More...
struct	urom_worker_notify
	UROM Worker notification structure. More...
struct	urom_worker_notif_desc
	UROM Worker notification descriptor structure. More...
struct	urom_plugin_iface
	UROM Worker plugin interface. More...
struct	urom_domain_lookups_iface
	UROM Worker domain lookups interface. More...
struct	urom_worker_ctx
	UROM worker context. More...

Macros
#define	DOCA_UROM_PLUGIN_NAME_MAX_LEN   48

Functions
static doca_error_t	doca_urom_worker_domain_addr_lookup (struct urom_worker_ctx *ctx, uint64_t domain_id, void **addr)
	Worker domain address lookup. More...
static doca_error_t	doca_urom_worker_domain_seg_lookup (struct urom_worker_ctx *ctx, uint64_t domain_id, uint64_t va, int *seg)
	Worker domain segment id lookup according to the domain id and segment virtual address. More...
static doca_error_t	doca_urom_worker_domain_memh_lookup (struct urom_worker_ctx *ctx, uint64_t domain_id, int seg, size_t *len, void **memh)
	Worker domain segment memory handle lookup according to the domain and segment ids. More...
static doca_error_t	doca_urom_worker_domain_mkey_lookup (struct urom_worker_ctx *ctx, uint64_t domain_id, int seg, size_t *len, void **rkey)
	Worker domain segment remote memory key lookup according to the segment and seg ids. More...

Detailed Description

DOCA UROM Worker Plugin interfaces and data structures.

Macro Definition Documentation

DOCA_UROM_PLUGIN_NAME_MAX_LEN

#define DOCA_UROM_PLUGIN_NAME_MAX_LEN   48

Maximum plugin name length

Definition at line 35 of file doca_urom_plugin.h.

Function Documentation

doca_urom_worker_domain_addr_lookup()

static doca_error_t doca_urom_worker_domain_addr_lookup ( struct urom_worker_ctx *  ctx, uint64_t  domain_id, void **  addr  )

inlinestatic

Worker domain address lookup.

Parameters

[in]	ctx	UROM worker context
[in]	domain_id	UROM domain id
[out]	addr	Set domain address

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_FOUND - if domain_id is invalid.

Definition at line 201 of file doca_urom_plugin.h.

doca_urom_worker_domain_memh_lookup()

static doca_error_t doca_urom_worker_domain_memh_lookup ( struct urom_worker_ctx *  ctx, uint64_t  domain_id, int  seg, size_t *  len, void **  memh  )

inlinestatic

Worker domain segment memory handle lookup according to the domain and segment ids.

Parameters

[in]	ctx	UROM worker context
[in]	domain_id	UROM domain id
[in]	seg	Segment id
[out]	len	Set memory handle size
[out]	memh	Set memory handle

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_FOUND - in case memh doesn't exist

Definition at line 254 of file doca_urom_plugin.h.

doca_urom_worker_domain_mkey_lookup()

static doca_error_t doca_urom_worker_domain_mkey_lookup ( struct urom_worker_ctx *  ctx, uint64_t  domain_id, int  seg, size_t *  len, void **  rkey  )

inlinestatic

Worker domain segment remote memory key lookup according to the segment and seg ids.

Parameters

[in]	ctx	UROM worker context
[in]	domain_id	UROM domain id
[in]	seg	Segment id
[out]	len	Set memory handle size
[out]	rkey	Set memory remote key

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_FOUND - in case rkey doesn't exist

Definition at line 283 of file doca_urom_plugin.h.

doca_urom_worker_domain_seg_lookup()

static doca_error_t doca_urom_worker_domain_seg_lookup ( struct urom_worker_ctx *  ctx, uint64_t  domain_id, uint64_t  va, int *  seg  )

inlinestatic

Worker domain segment id lookup according to the domain id and segment virtual address.

Parameters

[in]	ctx	UROM worker context
[in]	domain_id	UROM domain id
[in]	va	Segment virtual address
[out]	seg	Set segment id

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_FOUND - in case seg doesn't exist

Definition at line 226 of file doca_urom_plugin.h.