NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
common_common.c File Reference
#include <unistd.h>
#include <time.h>
#include <doca_log.h>
#include <doca_argp.h>
#include <doca_dev.h>
#include <doca_pe.h>
#include "common_common.h"
Include dependency graph for common_common.c:

Go to the source code of this file.

Macros

#define SLEEP_IN_NANOS   (10 * 1000) /* Sample the task every 10 microseconds */
 
#define TIMEOUT_IN_NANOS   (1 * 1000000000) /* Poll the task for maximum of 1 second */
 

Functions

 DOCA_LOG_REGISTER (SYNC_EVENT::COMMON)
 
static void task_completion_cb (struct doca_task *se_task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static void task_error_cb (struct doca_task *se_task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static void task_get_completion_cb (struct doca_sync_event_task_get *task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static void task_get_error_cb (struct doca_sync_event_task_get *task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static void task_notify_set_completion_cb (struct doca_sync_event_task_notify_set *task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static void task_notify_set_error_cb (struct doca_sync_event_task_notify_set *task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static void task_notify_add_completion_cb (struct doca_sync_event_task_notify_add *task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static void task_notify_add_error_cb (struct doca_sync_event_task_notify_add *task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static void task_wait_eq_completion_cb (struct doca_sync_event_task_wait_eq *task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static void task_wait_eq_error_cb (struct doca_sync_event_task_wait_eq *task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static doca_error_t pci_addr_cb (const char *pci_addr_src, char pci_addr_dest[DOCA_DEVINFO_PCI_ADDR_SIZE])
 
static doca_error_t dev_pci_addr_cb (void *param, void *config)
 
static doca_error_t rep_pci_addr_cb (void *param, void *config)
 
static doca_error_t is_async_mode_cb (void *param, void *config)
 
static doca_error_t async_num_tasks_cb (void *param, void *config)
 
static doca_error_t is_update_atomic_cb (void *param, void *config)
 
doca_error_t sync_event_params_register (void)
 
doca_error_t sync_event_config_validate (const struct sync_event_config *se_cfg, const struct sync_event_runtime_objects *se_rt_objs)
 
doca_error_t sync_event_start_async (const struct sync_event_config *se_cfg, struct sync_event_runtime_objects *se_rt_objs)
 
static void comch_send_completion_cb (struct doca_comch_task_send *task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static void comch_send_completion_err_cb (struct doca_comch_task_send *task, union doca_data task_user_data, union doca_data ctx_user_data)
 
static doca_error_t sync_event_cc_init (struct sync_event_runtime_objects *se_rt_objs)
 
doca_error_t sync_event_cc_handshake (struct sync_event_runtime_objects *se_rt_objs)
 
doca_error_t sync_event_async_task_submit (struct sync_event_runtime_objects *se_rt_objs, struct doca_task *se_task)
 
void sync_event_tear_down (struct sync_event_runtime_objects *se_rt_objs)
 

Macro Definition Documentation

◆ SLEEP_IN_NANOS

#define SLEEP_IN_NANOS   (10 * 1000) /* Sample the task every 10 microseconds */

Definition at line 38 of file common_common.c.

◆ TIMEOUT_IN_NANOS

#define TIMEOUT_IN_NANOS   (1 * 1000000000) /* Poll the task for maximum of 1 second */

Definition at line 39 of file common_common.c.

Function Documentation

◆ async_num_tasks_cb()

static doca_error_t async_num_tasks_cb ( void *  param,
void *  config 
)
inlinestatic

Definition at line 271 of file common_common.c.

◆ comch_send_completion_cb()

static void comch_send_completion_cb ( struct doca_comch_task_send *  task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

Definition at line 525 of file common_common.c.

◆ comch_send_completion_err_cb()

static void comch_send_completion_err_cb ( struct doca_comch_task_send *  task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

Definition at line 545 of file common_common.c.

◆ dev_pci_addr_cb()

static doca_error_t dev_pci_addr_cb ( void *  param,
void *  config 
)
inlinestatic

Definition at line 231 of file common_common.c.

◆ DOCA_LOG_REGISTER()

DOCA_LOG_REGISTER ( SYNC_EVENT::COMMON  )

◆ is_async_mode_cb()

static doca_error_t is_async_mode_cb ( void *  param,
void *  config 
)
inlinestatic

Definition at line 255 of file common_common.c.

◆ is_update_atomic_cb()

static doca_error_t is_update_atomic_cb ( void *  param,
void *  config 
)
inlinestatic

Definition at line 285 of file common_common.c.

◆ pci_addr_cb()

static doca_error_t pci_addr_cb ( const char *  pci_addr_src,
char  pci_addr_dest[DOCA_DEVINFO_PCI_ADDR_SIZE] 
)
inlinestatic

Definition at line 210 of file common_common.c.

◆ rep_pci_addr_cb()

static doca_error_t rep_pci_addr_cb ( void *  param,
void *  config 
)
inlinestatic

Definition at line 243 of file common_common.c.

◆ sync_event_async_task_submit()

doca_error_t sync_event_async_task_submit ( struct sync_event_runtime_objects se_rt_objs,
struct doca_task *  se_task 
)

Definition at line 854 of file common_common.c.

◆ sync_event_cc_handshake()

doca_error_t sync_event_cc_handshake ( struct sync_event_runtime_objects se_rt_objs)

Definition at line 805 of file common_common.c.

◆ sync_event_cc_init()

static doca_error_t sync_event_cc_init ( struct sync_event_runtime_objects se_rt_objs)
static

Definition at line 741 of file common_common.c.

◆ sync_event_config_validate()

doca_error_t sync_event_config_validate ( const struct sync_event_config se_cfg,
const struct sync_event_runtime_objects se_rt_objs 
)

Definition at line 410 of file common_common.c.

◆ sync_event_params_register()

doca_error_t sync_event_params_register ( void  )

Definition at line 299 of file common_common.c.

◆ sync_event_start_async()

doca_error_t sync_event_start_async ( const struct sync_event_config se_cfg,
struct sync_event_runtime_objects se_rt_objs 
)

Definition at line 440 of file common_common.c.

◆ sync_event_tear_down()

void sync_event_tear_down ( struct sync_event_runtime_objects se_rt_objs)

Definition at line 895 of file common_common.c.

◆ task_completion_cb()

static void task_completion_cb ( struct doca_task *  se_task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

Common DOCA Sync Event task callback for successful completion.

@se_task [in]: the successfully completed sync event task. Implementation can assume it is not NULL. @task_user_data [in]: task's user data which was previously set. @ctx_user_data [in]: context's user data which was previously set.

Definition at line 48 of file common_common.c.

◆ task_error_cb()

static void task_error_cb ( struct doca_task *  se_task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

Common DOCA Sync Event task callback for completion with error.

@se_task [in]: the successfully completed sync event task. Implementation can assume it is not NULL. @task_user_data [in]: task's user data which was previously set. @ctx_user_data [in]: context's user data which was previously set.

Definition at line 65 of file common_common.c.

◆ task_get_completion_cb()

static void task_get_completion_cb ( struct doca_sync_event_task_get *  task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

DOCA Sync Event get task callback for successful completion.

See doca_sync_event_task_get_completion_cb_t doc.

@task [in]: the successfully completed sync event get task. Implementation can assume it is not NULL. @task_user_data [in]: task's user data which was previously set. @ctx_user_data [in]: context's user data which was previously set.

Definition at line 84 of file common_common.c.

◆ task_get_error_cb()

static void task_get_error_cb ( struct doca_sync_event_task_get *  task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

DOCA Sync Event get task callback for completion with error.

See doca_sync_event_task_get_completion_cb_t doc.

@task [in]: the completed-with-error sync event get task. Implementation can assume it is not NULL. @task_user_data [in]: task's user data which was previously set. @ctx_user_data [in]: context's user data which was previously set.

Definition at line 100 of file common_common.c.

◆ task_notify_add_completion_cb()

static void task_notify_add_completion_cb ( struct doca_sync_event_task_notify_add *  task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

DOCA Sync Event notify-add task callback for successful completion.

See doca_sync_event_task_notify_add_completion_cb_t doc.

@task [in]: the successfully completed sync event notify-add task. Implementation can assume it is not NULL. @task_user_data [in]: task's user data which was previously set. @ctx_user_data [in]: context's user data which was previously set.

Definition at line 148 of file common_common.c.

◆ task_notify_add_error_cb()

static void task_notify_add_error_cb ( struct doca_sync_event_task_notify_add *  task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

DOCA Sync Event notify-add task callback for completion with error.

See doca_sync_event_task_notify_add_completion_cb_t doc.

@task [in]: the completed-with-error sync event notify-add task. Implementation can assume it is not NULL. @task_user_data [in]: task's user data which was previously set. @ctx_user_data [in]: context's user data which was previously set.

Definition at line 164 of file common_common.c.

◆ task_notify_set_completion_cb()

static void task_notify_set_completion_cb ( struct doca_sync_event_task_notify_set *  task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

DOCA Sync Event notify-set task callback for successful completion.

See doca_sync_event_task_notify_set_completion_cb_t doc.

@task [in]: the successfully completed sync event notify-set task. Implementation can assume it is not NULL. @task_user_data [in]: task's user data which was previously set. @ctx_user_data [in]: context's user data which was previously set.

Definition at line 116 of file common_common.c.

◆ task_notify_set_error_cb()

static void task_notify_set_error_cb ( struct doca_sync_event_task_notify_set *  task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

DOCA Sync Event notify-set task callback for completion with error.

See doca_sync_event_task_notify_set_completion_cb_t doc.

@task [in]: the completed-with-error sync event notify-set task. Implementation can assume it is not NULL. @task_user_data [in]: task's user data which was previously set. @ctx_user_data [in]: context's user data which was previously set.

Definition at line 132 of file common_common.c.

◆ task_wait_eq_completion_cb()

static void task_wait_eq_completion_cb ( struct doca_sync_event_task_wait_eq *  task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

DOCA Sync Event wait-eq task callback for successful completion.

See doca_sync_event_task_wait_eq_completion_cb_t doc.

@task [in]: The successfully completed sync event wait_eq task. Implementation can assume it is not NULL. @task_user_data [in]: task's user data which was previously set. @ctx_user_data [in]: context's user data which was previously set.

Definition at line 180 of file common_common.c.

◆ task_wait_eq_error_cb()

static void task_wait_eq_error_cb ( struct doca_sync_event_task_wait_eq *  task,
union doca_data  task_user_data,
union doca_data  ctx_user_data 
)
static

DOCA Sync Event wait-eq task callback for completion with error.

See doca_sync_event_task_wait_eq_completion_cb_t doc.

@task [in]: The completed-with-error sync event wait-eq task. Implementation can assume it is not NULL. @task_user_data [in]: task's user data which was previously set. @ctx_user_data [in]: context's user data which was previously set.

Definition at line 196 of file common_common.c.