NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_sync_event.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
3  *
4  * This software product is a proprietary product of NVIDIA CORPORATION &
5  * AFFILIATES (the "Company") and all right, title, and interest in and to the
6  * software product, including all associated intellectual property rights, are
7  * and shall remain exclusively with the Company.
8  *
9  * This software product is governed by the End User License Agreement
10  * provided with the software product.
11  *
12  */
13 
26 #ifndef DOCA_SYNC_EVENT_H_
27 #define DOCA_SYNC_EVENT_H_
28 
29 #include <stddef.h>
30 #include <stdint.h>
31 
32 #include <doca_compat.h>
33 #include <doca_error.h>
34 #include <doca_types.h>
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 struct doca_ctx;
41 struct doca_dev;
42 struct doca_devinfo;
43 struct doca_dpa;
44 struct doca_gpu;
45 
46 struct doca_sync_event;
47 struct doca_sync_event_remote_net;
48 
49 struct doca_dpa_sync_event;
50 
51 struct doca_buf;
52 
56 typedef uint64_t doca_dpa_dev_sync_event_t;
57 
61 typedef uint64_t doca_dpa_dev_sync_event_remote_net_t;
62 
63 struct doca_gpu_sync_event;
64 
68 typedef uint64_t doca_gpu_dev_sync_event_t;
69 
73 typedef uint64_t doca_gpu_dev_sync_event_remote_net_t;
74 
75 struct doca_sync_event_task_get;
76 struct doca_sync_event_task_notify_set;
77 struct doca_sync_event_task_notify_add;
78 struct doca_sync_event_task_wait_eq;
79 struct doca_sync_event_task_wait_neq;
80 
94 typedef void (*doca_sync_event_task_get_completion_cb_t)(struct doca_sync_event_task_get *task,
95  union doca_data task_user_data,
96  union doca_data ctx_user_data);
97 
111 typedef void (*doca_sync_event_task_notify_set_completion_cb_t)(struct doca_sync_event_task_notify_set *task,
112  union doca_data task_user_data,
113  union doca_data ctx_user_data);
114 
128 typedef void (*doca_sync_event_task_notify_add_completion_cb_t)(struct doca_sync_event_task_notify_add *task,
129  union doca_data task_user_data,
130  union doca_data ctx_user_data);
131 
145 typedef void (*doca_sync_event_task_wait_eq_completion_cb_t)(struct doca_sync_event_task_wait_eq *task,
146  union doca_data task_user_data,
147  union doca_data ctx_user_data);
148 
162 typedef void (*doca_sync_event_task_wait_neq_completion_cb_t)(struct doca_sync_event_task_wait_neq *task,
163  union doca_data task_user_data,
164  union doca_data ctx_user_data);
165 
181 DOCA_EXPERIMENTAL
182 doca_error_t doca_sync_event_create(struct doca_sync_event **event);
183 
214 DOCA_EXPERIMENTAL
215 doca_error_t doca_sync_event_create_from_export(struct doca_dev *dev,
216  const uint8_t *data,
217  size_t sz,
218  struct doca_sync_event **event);
219 
233 DOCA_EXPERIMENTAL
234 doca_error_t doca_sync_event_cap_is_create_from_export_supported(const struct doca_devinfo *devinfo);
235 
266 DOCA_EXPERIMENTAL
267 doca_error_t doca_sync_event_remote_net_create_from_export(struct doca_dev *dev,
268  const uint8_t *data,
269  size_t sz,
270  struct doca_sync_event_remote_net **event);
271 
286 DOCA_EXPERIMENTAL
287 doca_error_t doca_sync_event_cap_remote_net_is_create_from_export_supported(const struct doca_devinfo *devinfo);
288 
300 DOCA_EXPERIMENTAL
301 doca_error_t doca_sync_event_destroy(struct doca_sync_event *event);
302 
314 DOCA_EXPERIMENTAL
315 doca_error_t doca_sync_event_remote_net_destroy(struct doca_sync_event_remote_net *event);
316 
331 DOCA_EXPERIMENTAL
332 doca_error_t doca_sync_event_add_publisher_location_cpu(struct doca_sync_event *event, struct doca_dev *dev);
333 
348 DOCA_EXPERIMENTAL
349 doca_error_t doca_sync_event_add_publisher_location_dpa(struct doca_sync_event *event, struct doca_dpa *dpa);
350 
365 DOCA_EXPERIMENTAL
366 doca_error_t doca_sync_event_add_publisher_location_gpu(struct doca_sync_event *event, struct doca_gpu *gpu);
367 
379 DOCA_EXPERIMENTAL
380 doca_error_t doca_sync_event_add_publisher_location_remote_pci(struct doca_sync_event *event);
381 
393 DOCA_EXPERIMENTAL
394 doca_error_t doca_sync_event_add_publisher_location_remote_net(struct doca_sync_event *event);
395 
410 DOCA_EXPERIMENTAL
411 doca_error_t doca_sync_event_add_subscriber_location_cpu(struct doca_sync_event *event, struct doca_dev *dev);
412 
427 DOCA_EXPERIMENTAL
428 doca_error_t doca_sync_event_add_subscriber_location_dpa(struct doca_sync_event *event, struct doca_dpa *dpa);
429 
444 DOCA_EXPERIMENTAL
445 doca_error_t doca_sync_event_add_subscriber_location_gpu(struct doca_sync_event *event, struct doca_gpu *gpu);
446 
458 DOCA_EXPERIMENTAL
459 doca_error_t doca_sync_event_add_subscriber_location_remote_pci(struct doca_sync_event *event);
460 
478 DOCA_EXPERIMENTAL
479 doca_error_t doca_sync_event_set_addr(struct doca_sync_event *event, uint64_t *addr);
480 
511 DOCA_EXPERIMENTAL
512 doca_error_t doca_sync_event_set_doca_buf(struct doca_sync_event *event, struct doca_buf *buf);
513 
528 DOCA_EXPERIMENTAL
529 doca_error_t doca_sync_event_start(struct doca_sync_event *event);
530 
542 DOCA_EXPERIMENTAL
543 doca_error_t doca_sync_event_stop(struct doca_sync_event *event);
544 
567 DOCA_EXPERIMENTAL
568 struct doca_ctx *doca_sync_event_as_ctx(struct doca_sync_event *event);
569 
582 DOCA_EXPERIMENTAL
583 doca_error_t doca_sync_event_cap_task_get_is_supported(const struct doca_devinfo *devinfo);
584 
603 DOCA_EXPERIMENTAL
604 doca_error_t doca_sync_event_task_get_set_conf(struct doca_sync_event *event,
605  doca_sync_event_task_get_completion_cb_t completion_cb,
606  doca_sync_event_task_get_completion_cb_t error_cb,
607  uint32_t num_tasks);
608 
628 DOCA_EXPERIMENTAL
629 doca_error_t doca_sync_event_task_get_alloc_init(struct doca_sync_event *event,
630  uint64_t *ret_val_ptr,
631  union doca_data user_data,
632  struct doca_sync_event_task_get **task);
633 
643 DOCA_EXPERIMENTAL
644 struct doca_task *doca_sync_event_task_get_as_doca_task(struct doca_sync_event_task_get *task);
645 
654 DOCA_EXPERIMENTAL
655 void doca_sync_event_task_get_set_ret_val_ptr(struct doca_sync_event_task_get *task, uint64_t *ret_val_ptr);
656 
666 DOCA_EXPERIMENTAL
667 uint64_t *doca_sync_event_task_get_get_ret_val_ptr(const struct doca_sync_event_task_get *task);
668 
681 DOCA_EXPERIMENTAL
682 doca_error_t doca_sync_event_cap_task_notify_set_is_supported(const struct doca_devinfo *devinfo);
683 
702 DOCA_EXPERIMENTAL
703 doca_error_t doca_sync_event_task_notify_set_set_conf(struct doca_sync_event *event,
704  doca_sync_event_task_notify_set_completion_cb_t completion_cb,
705  doca_sync_event_task_notify_set_completion_cb_t error_cb,
706  uint32_t num_tasks);
707 
727 DOCA_EXPERIMENTAL
728 doca_error_t doca_sync_event_task_notify_set_alloc_init(struct doca_sync_event *event,
729  uint64_t set_val,
730  union doca_data user_data,
731  struct doca_sync_event_task_notify_set **task);
732 
742 DOCA_EXPERIMENTAL
743 struct doca_task *doca_sync_event_task_notify_set_as_doca_task(struct doca_sync_event_task_notify_set *task);
744 
753 DOCA_EXPERIMENTAL
754 void doca_sync_event_task_notify_set_set_set_val(struct doca_sync_event_task_notify_set *task, uint64_t set_val);
755 
765 DOCA_EXPERIMENTAL
766 uint64_t doca_sync_event_task_notify_set_get_set_val(const struct doca_sync_event_task_notify_set *task);
767 
780 DOCA_EXPERIMENTAL
781 doca_error_t doca_sync_event_cap_task_notify_add_is_supported(const struct doca_devinfo *devinfo);
782 
801 DOCA_EXPERIMENTAL
802 doca_error_t doca_sync_event_task_notify_add_set_conf(struct doca_sync_event *event,
803  doca_sync_event_task_notify_add_completion_cb_t completion_cb,
804  doca_sync_event_task_notify_add_completion_cb_t error_cb,
805  uint32_t num_tasks);
806 
828 DOCA_EXPERIMENTAL
829 doca_error_t doca_sync_event_task_notify_add_alloc_init(struct doca_sync_event *event,
830  uint64_t inc_val,
831  uint64_t *fetched_val_ptr,
832  union doca_data user_data,
833  struct doca_sync_event_task_notify_add **task);
834 
844 DOCA_EXPERIMENTAL
845 struct doca_task *doca_sync_event_task_notify_add_as_doca_task(struct doca_sync_event_task_notify_add *task);
846 
855 DOCA_EXPERIMENTAL
856 void doca_sync_event_task_notify_add_set_inc_val(struct doca_sync_event_task_notify_add *task, uint64_t inc_val);
857 
867 DOCA_EXPERIMENTAL
868 uint64_t doca_sync_event_task_notify_add_get_inc_val(const struct doca_sync_event_task_notify_add *task);
869 
878 DOCA_EXPERIMENTAL
879 void doca_sync_event_task_notify_add_set_fetched_val_ptr(struct doca_sync_event_task_notify_add *task,
880  uint64_t *fetched_val_ptr);
881 
891 DOCA_EXPERIMENTAL
892 uint64_t *doca_sync_event_task_notify_add_get_fetched_val_ptr(const struct doca_sync_event_task_notify_add *task);
893 
906 DOCA_EXPERIMENTAL
907 doca_error_t doca_sync_event_cap_task_wait_eq_is_supported(const struct doca_devinfo *devinfo);
908 
927 DOCA_EXPERIMENTAL
928 doca_error_t doca_sync_event_task_wait_eq_set_conf(struct doca_sync_event *event,
929  doca_sync_event_task_wait_eq_completion_cb_t completion_cb,
930  doca_sync_event_task_wait_eq_completion_cb_t error_cb,
931  uint32_t num_tasks);
932 
955 DOCA_EXPERIMENTAL
956 doca_error_t doca_sync_event_task_wait_eq_alloc_init(struct doca_sync_event *event,
957  uint64_t wait_val,
958  uint64_t mask,
959  union doca_data user_data,
960  struct doca_sync_event_task_wait_eq **task);
961 
971 DOCA_EXPERIMENTAL
972 struct doca_task *doca_sync_event_task_wait_eq_as_doca_task(struct doca_sync_event_task_wait_eq *task);
973 
982 DOCA_EXPERIMENTAL
983 void doca_sync_event_task_wait_eq_set_wait_val(struct doca_sync_event_task_wait_eq *task, uint64_t wait_val);
984 
994 DOCA_EXPERIMENTAL
995 uint64_t doca_sync_event_task_wait_eq_get_wait_val(const struct doca_sync_event_task_wait_eq *task);
996 
1005 DOCA_EXPERIMENTAL
1006 void doca_sync_event_task_wait_eq_set_mask(struct doca_sync_event_task_wait_eq *task, uint64_t mask);
1007 
1017 DOCA_EXPERIMENTAL
1018 uint64_t doca_sync_event_task_wait_eq_get_mask(const struct doca_sync_event_task_wait_eq *task);
1019 
1032 DOCA_EXPERIMENTAL
1033 doca_error_t doca_sync_event_cap_task_wait_neq_is_supported(const struct doca_devinfo *devinfo);
1034 
1053 DOCA_EXPERIMENTAL
1054 doca_error_t doca_sync_event_task_wait_neq_set_conf(struct doca_sync_event *event,
1055  doca_sync_event_task_wait_neq_completion_cb_t completion_cb,
1056  doca_sync_event_task_wait_neq_completion_cb_t error_cb,
1057  uint32_t num_tasks);
1058 
1081 DOCA_EXPERIMENTAL
1082 doca_error_t doca_sync_event_task_wait_neq_alloc_init(struct doca_sync_event *event,
1083  uint64_t wait_val,
1084  uint64_t mask,
1085  union doca_data user_data,
1086  struct doca_sync_event_task_wait_neq **task);
1087 
1097 DOCA_EXPERIMENTAL
1098 struct doca_task *doca_sync_event_task_wait_neq_as_doca_task(struct doca_sync_event_task_wait_neq *task);
1099 
1108 DOCA_EXPERIMENTAL
1109 void doca_sync_event_task_wait_neq_set_wait_val(struct doca_sync_event_task_wait_neq *task, uint64_t wait_val);
1110 
1120 DOCA_EXPERIMENTAL
1121 uint64_t doca_sync_event_task_wait_neq_get_wait_val(const struct doca_sync_event_task_wait_neq *task);
1122 
1131 DOCA_EXPERIMENTAL
1132 void doca_sync_event_task_wait_neq_set_mask(struct doca_sync_event_task_wait_neq *task, uint64_t mask);
1133 
1143 DOCA_EXPERIMENTAL
1144 uint64_t doca_sync_event_task_wait_neq_get_mask(const struct doca_sync_event_task_wait_neq *task);
1145 
1180 DOCA_EXPERIMENTAL
1181 doca_error_t doca_sync_event_export_to_remote_pci(struct doca_sync_event *event,
1182  struct doca_dev *dev,
1183  const uint8_t **data,
1184  size_t *sz);
1185 
1200 DOCA_EXPERIMENTAL
1201 doca_error_t doca_sync_event_cap_is_export_to_remote_pci_supported(const struct doca_devinfo *devinfo);
1202 
1231 DOCA_EXPERIMENTAL
1232 doca_error_t doca_sync_event_get_dpa_handle(struct doca_sync_event *event,
1233  struct doca_dpa *dpa,
1234  doca_dpa_dev_sync_event_t *dpa_dev_se_handle);
1235 
1250 DOCA_EXPERIMENTAL
1251 doca_error_t doca_sync_event_cap_is_export_to_dpa_supported(const struct doca_devinfo *devinfo);
1252 
1281 DOCA_EXPERIMENTAL
1282 doca_error_t doca_sync_event_get_gpu_handle(struct doca_sync_event *event,
1283  struct doca_gpu *gpu,
1284  doca_gpu_dev_sync_event_t **gpu_dev_se);
1285 
1300 DOCA_EXPERIMENTAL
1301 doca_error_t doca_sync_event_cap_is_export_to_gpu_supported(const struct doca_devinfo *devinfo);
1302 
1333 DOCA_EXPERIMENTAL
1334 doca_error_t doca_sync_event_export_to_remote_net(struct doca_sync_event *event, const uint8_t **data, size_t *sz);
1335 
1349 DOCA_EXPERIMENTAL
1350 doca_error_t doca_sync_event_cap_is_export_to_remote_net_supported(const struct doca_devinfo *devinfo);
1351 
1380 DOCA_EXPERIMENTAL
1381 doca_error_t doca_sync_event_remote_net_get_dpa_handle(struct doca_sync_event_remote_net *event,
1382  struct doca_dpa *dpa,
1383  doca_dpa_dev_sync_event_remote_net_t *dpa_remote_event);
1384 
1398 DOCA_EXPERIMENTAL
1399 doca_error_t doca_sync_event_cap_remote_net_is_export_to_dpa_supported(const struct doca_devinfo *devinfo);
1400 
1429 DOCA_EXPERIMENTAL
1430 doca_error_t doca_sync_event_remote_net_get_gpu_handle(struct doca_sync_event_remote_net *event,
1431  struct doca_gpu *gpu,
1432  doca_gpu_dev_sync_event_remote_net_t *gpu_remote_event);
1433 
1447 DOCA_EXPERIMENTAL
1448 doca_error_t doca_sync_event_cap_remote_net_is_export_to_gpu_supported(const struct doca_devinfo *devinfo);
1449 
1464 DOCA_EXPERIMENTAL
1465 doca_error_t doca_sync_event_get(struct doca_sync_event *event, uint64_t *value);
1466 
1484 DOCA_EXPERIMENTAL
1485 doca_error_t doca_sync_event_update_add(struct doca_sync_event *event, uint64_t value, uint64_t *fetched);
1486 
1501 DOCA_EXPERIMENTAL
1502 doca_error_t doca_sync_event_update_set(struct doca_sync_event *event, uint64_t value);
1503 
1522 DOCA_EXPERIMENTAL
1523 doca_error_t doca_sync_event_wait_gt(struct doca_sync_event *event, uint64_t value, uint64_t mask);
1524 
1548 DOCA_EXPERIMENTAL
1549 doca_error_t doca_sync_event_wait_gt_yield(struct doca_sync_event *event, uint64_t value, uint64_t mask);
1550 
1568 DOCA_EXPERIMENTAL
1569 doca_error_t doca_sync_event_wait_eq(struct doca_sync_event *event, uint64_t value, uint64_t mask);
1570 
1594 DOCA_EXPERIMENTAL
1595 doca_error_t doca_sync_event_wait_eq_yield(struct doca_sync_event *event, uint64_t value, uint64_t mask);
1596 
1614 DOCA_EXPERIMENTAL
1615 doca_error_t doca_sync_event_wait_neq(struct doca_sync_event *event, uint64_t value, uint64_t mask);
1616 
1640 DOCA_EXPERIMENTAL
1641 doca_error_t doca_sync_event_wait_neq_yield(struct doca_sync_event *event, uint64_t value, uint64_t mask);
1642 
1643 #ifdef __cplusplus
1644 }
1645 #endif
1646 
1649 #endif /* DOCA_SYNC_EVENT_H_ */
doca_compat.h
addr
uintptr_t addr
Definition: doca_dpa_dev_buf.h:0
doca_error.h
doca_types.h
DOCA_EXPERIMENTAL
#define DOCA_EXPERIMENTAL
To set a Symbol (or specifically a function) as experimental.
Definition: doca_compat.h:103
doca_error_t
enum doca_error doca_error_t
DOCA API return codes.
doca_sync_event_task_notify_set_as_doca_task
DOCA_EXPERIMENTAL struct doca_task * doca_sync_event_task_notify_set_as_doca_task(struct doca_sync_event_task_notify_set *task)
Convert a DOCA Sync Event notify-set task to a DOCA Task.
doca_sync_event_create_from_export
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_create_from_export(struct doca_dev *dev, const uint8_t *data, size_t sz, struct doca_sync_event **event)
Create a Sync Event handle from an export.
doca_sync_event_remote_net_create_from_export
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_remote_net_create_from_export(struct doca_dev *dev, const uint8_t *data, size_t sz, struct doca_sync_event_remote_net **event)
Create a remote Sync Event handle from an export.
doca_sync_event_task_get_alloc_init
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_task_get_alloc_init(struct doca_sync_event *event, uint64_t *ret_val_ptr, union doca_data user_data, struct doca_sync_event_task_get **task)
Allocate a DOCA Sync Event get task.
doca_sync_event_cap_remote_net_is_export_to_dpa_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_remote_net_is_export_to_dpa_supported(const struct doca_devinfo *devinfo)
doca_sync_event_cap_task_wait_neq_is_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_task_wait_neq_is_supported(const struct doca_devinfo *devinfo)
Check if a given device supports submitting a DOCA Sync Event wait-not-equal task.
doca_sync_event_task_notify_add_set_conf
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_task_notify_add_set_conf(struct doca_sync_event *event, doca_sync_event_task_notify_add_completion_cb_t completion_cb, doca_sync_event_task_notify_add_completion_cb_t error_cb, uint32_t num_tasks)
Set the DOCA Sync Event notify-add task configuration.
doca_sync_event_task_notify_add_get_fetched_val_ptr
DOCA_EXPERIMENTAL uint64_t * doca_sync_event_task_notify_add_get_fetched_val_ptr(const struct doca_sync_event_task_notify_add *task)
Get the fetched value pointer of a DOCA Sync Event notify-add task.
doca_sync_event_add_publisher_location_remote_pci
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_add_publisher_location_remote_pci(struct doca_sync_event *event)
Declare Sync Event publisher as remote pci.
doca_sync_event_task_get_set_ret_val_ptr
DOCA_EXPERIMENTAL void doca_sync_event_task_get_set_ret_val_ptr(struct doca_sync_event_task_get *task, uint64_t *ret_val_ptr)
Set the return value pointer of a DOCA Sync Event get task.
doca_sync_event_remote_net_destroy
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_remote_net_destroy(struct doca_sync_event_remote_net *event)
Destroy a Sync Event instance.
doca_sync_event_start
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_start(struct doca_sync_event *event)
Start a Sync Event to be operate as stand-alone DOCA Core object only.
doca_sync_event_task_wait_eq_as_doca_task
DOCA_EXPERIMENTAL struct doca_task * doca_sync_event_task_wait_eq_as_doca_task(struct doca_sync_event_task_wait_eq *task)
Convert a DOCA Sync Event wait-equal task to a DOCA Task.
doca_sync_event_cap_is_export_to_dpa_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_is_export_to_dpa_supported(const struct doca_devinfo *devinfo)
doca_dpa_dev_sync_event_t
uint64_t doca_dpa_dev_sync_event_t
DOCA Sync Event DPA handle.
Definition: doca_sync_event.h:51
doca_sync_event_task_get_set_conf
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_task_get_set_conf(struct doca_sync_event *event, doca_sync_event_task_get_completion_cb_t completion_cb, doca_sync_event_task_get_completion_cb_t error_cb, uint32_t num_tasks)
Set the DOCA Sync Event get task configuration.
doca_sync_event_task_get_as_doca_task
DOCA_EXPERIMENTAL struct doca_task * doca_sync_event_task_get_as_doca_task(struct doca_sync_event_task_get *task)
Convert a DOCA Sync Event get task to a DOCA Task.
doca_sync_event_update_add
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_update_add(struct doca_sync_event *event, uint64_t value, uint64_t *fetched)
Atomically increase the value of a Sync Event by some value synchronously.
doca_sync_event_task_wait_neq_as_doca_task
DOCA_EXPERIMENTAL struct doca_task * doca_sync_event_task_wait_neq_as_doca_task(struct doca_sync_event_task_wait_neq *task)
Convert a DOCA Sync Event wait-not-equal task to a DOCA Task.
doca_sync_event_wait_eq_yield
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_wait_eq_yield(struct doca_sync_event *event, uint64_t value, uint64_t mask)
Wait for the value of a Sync Event to be equal to some value synchronously in a periodically busy wai...
doca_sync_event_task_wait_neq_set_wait_val
DOCA_EXPERIMENTAL void doca_sync_event_task_wait_neq_set_wait_val(struct doca_sync_event_task_wait_neq *task, uint64_t wait_val)
Set the wait value of a DOCA wait-not-equal task.
doca_sync_event_get_gpu_handle
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_get_gpu_handle(struct doca_sync_event *event, struct doca_gpu *gpu, doca_gpu_dev_sync_event_t **gpu_dev_se)
Export Sync Event to be shared with the GPU.
doca_sync_event_task_wait_eq_set_conf
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_task_wait_eq_set_conf(struct doca_sync_event *event, doca_sync_event_task_wait_eq_completion_cb_t completion_cb, doca_sync_event_task_wait_eq_completion_cb_t error_cb, uint32_t num_tasks)
Set the DOCA Sync Event wait-equal task configuration.
doca_sync_event_get
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_get(struct doca_sync_event *event, uint64_t *value)
Get the value of a Sync Event synchronously.
doca_sync_event_create
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_create(struct doca_sync_event **event)
Create a Sync Event handle.
doca_sync_event_cap_task_wait_eq_is_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_task_wait_eq_is_supported(const struct doca_devinfo *devinfo)
Check if a given device supports submitting a DOCA Sync Event wait-equal task.
doca_sync_event_task_notify_set_set_set_val
DOCA_EXPERIMENTAL void doca_sync_event_task_notify_set_set_set_val(struct doca_sync_event_task_notify_set *task, uint64_t set_val)
Set the set value of a DOCA Sync Event notify-set task.
doca_sync_event_cap_is_export_to_remote_pci_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_is_export_to_remote_pci_supported(const struct doca_devinfo *devinfo)
doca_sync_event_task_notify_add_completion_cb_t
void(* doca_sync_event_task_notify_add_completion_cb_t)(struct doca_sync_event_task_notify_add *task, union doca_data task_user_data, union doca_data ctx_user_data)
Add task completion callback.
Definition: doca_sync_event.h:128
doca_sync_event_add_subscriber_location_dpa
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_add_subscriber_location_dpa(struct doca_sync_event *event, struct doca_dpa *dpa)
Associate a DOCA DPA context as the Sync Event subscriber.
doca_sync_event_task_notify_set_set_conf
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_task_notify_set_set_conf(struct doca_sync_event *event, doca_sync_event_task_notify_set_completion_cb_t completion_cb, doca_sync_event_task_notify_set_completion_cb_t error_cb, uint32_t num_tasks)
Set the DOCA Sync Event notify-set task configuration.
doca_sync_event_task_wait_neq_set_conf
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_task_wait_neq_set_conf(struct doca_sync_event *event, doca_sync_event_task_wait_neq_completion_cb_t completion_cb, doca_sync_event_task_wait_neq_completion_cb_t error_cb, uint32_t num_tasks)
Set the DOCA Sync Event wait-not-equal task configuration.
doca_sync_event_cap_task_get_is_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_task_get_is_supported(const struct doca_devinfo *devinfo)
Check if a given device supports submitting a DOCA Sync Event get task.
doca_sync_event_task_wait_eq_alloc_init
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_task_wait_eq_alloc_init(struct doca_sync_event *event, uint64_t wait_val, uint64_t mask, union doca_data user_data, struct doca_sync_event_task_wait_eq **task)
Allocate a DOCA Sync Event wait-equal task.
doca_sync_event_task_notify_add_alloc_init
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_task_notify_add_alloc_init(struct doca_sync_event *event, uint64_t inc_val, uint64_t *fetched_val_ptr, union doca_data user_data, struct doca_sync_event_task_notify_add **task)
Allocate a DOCA Sync Event notify-add task.
doca_sync_event_task_notify_add_set_inc_val
DOCA_EXPERIMENTAL void doca_sync_event_task_notify_add_set_inc_val(struct doca_sync_event_task_notify_add *task, uint64_t inc_val)
Set the increment value of a doca notify-add task.
doca_sync_event_task_wait_neq_get_wait_val
DOCA_EXPERIMENTAL uint64_t doca_sync_event_task_wait_neq_get_wait_val(const struct doca_sync_event_task_wait_neq *task)
Get the wait value of a DOCA Sync Event wait-not-equal task.
doca_sync_event_update_set
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_update_set(struct doca_sync_event *event, uint64_t value)
Set the value of a Sync Event to some value synchronously.
doca_sync_event_cap_remote_net_is_create_from_export_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_remote_net_is_create_from_export_supported(const struct doca_devinfo *devinfo)
doca_sync_event_wait_gt
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_wait_gt(struct doca_sync_event *event, uint64_t value, uint64_t mask)
Wait for the value of a Sync Event to be grater than some threshold value synchronously in a polling ...
doca_sync_event_task_notify_add_set_fetched_val_ptr
DOCA_EXPERIMENTAL void doca_sync_event_task_notify_add_set_fetched_val_ptr(struct doca_sync_event_task_notify_add *task, uint64_t *fetched_val_ptr)
Set the fetched value pointer of a DOCA Sync Event notify-add task.
doca_sync_event_stop
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_stop(struct doca_sync_event *event)
Stop a Sync Event which has been previously started with 'doca_sync_event_start'.
doca_sync_event_set_addr
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_set_addr(struct doca_sync_event *event, uint64_t *addr)
Set the 64-bit value's memory for a Sync Event.
doca_sync_event_as_ctx
DOCA_EXPERIMENTAL struct doca_ctx * doca_sync_event_as_ctx(struct doca_sync_event *event)
Convert a Sync Event to a DOCA context.
doca_sync_event_wait_neq
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_wait_neq(struct doca_sync_event *event, uint64_t value, uint64_t mask)
Wait for the value of a Sync Event to be not equal to some value synchronously in a busy wait manner.
doca_sync_event_cap_is_create_from_export_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_is_create_from_export_supported(const struct doca_devinfo *devinfo)
doca_sync_event_task_wait_neq_get_mask
DOCA_EXPERIMENTAL uint64_t doca_sync_event_task_wait_neq_get_mask(const struct doca_sync_event_task_wait_neq *task)
Get the mask of a DOCA Sync Event wait-not-equal task.
doca_sync_event_task_wait_eq_get_mask
DOCA_EXPERIMENTAL uint64_t doca_sync_event_task_wait_eq_get_mask(const struct doca_sync_event_task_wait_eq *task)
Get the mask of a DOCA Sync Event wait-equal task.
doca_sync_event_wait_gt_yield
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_wait_gt_yield(struct doca_sync_event *event, uint64_t value, uint64_t mask)
Wait for the value of a Sync Event to be grater than some threshold value synchronously in a periodic...
doca_sync_event_task_notify_set_alloc_init
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_task_notify_set_alloc_init(struct doca_sync_event *event, uint64_t set_val, union doca_data user_data, struct doca_sync_event_task_notify_set **task)
Allocate a DOCA Sync Event notify-set task.
doca_sync_event_cap_is_export_to_gpu_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_is_export_to_gpu_supported(const struct doca_devinfo *devinfo)
doca_sync_event_cap_task_notify_set_is_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_task_notify_set_is_supported(const struct doca_devinfo *devinfo)
Check if a given device supports submitting a DOCA Sync Event notify-set task.
doca_sync_event_cap_remote_net_is_export_to_gpu_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_remote_net_is_export_to_gpu_supported(const struct doca_devinfo *devinfo)
doca_sync_event_task_wait_eq_set_mask
DOCA_EXPERIMENTAL void doca_sync_event_task_wait_eq_set_mask(struct doca_sync_event_task_wait_eq *task, uint64_t mask)
Set the mask of a DOCA wait-equal task.
doca_sync_event_wait_neq_yield
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_wait_neq_yield(struct doca_sync_event *event, uint64_t value, uint64_t mask)
Wait for the value of a Sync Event to be not equal to some value synchronously in a periodically busy...
doca_sync_event_wait_eq
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_wait_eq(struct doca_sync_event *event, uint64_t value, uint64_t mask)
Wait for the value of a Sync Event to be equal to some value synchronously in a busy wait manner.
doca_sync_event_remote_net_get_dpa_handle
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_remote_net_get_dpa_handle(struct doca_sync_event_remote_net *event, struct doca_dpa *dpa, doca_dpa_dev_sync_event_remote_net_t *dpa_remote_event)
Export remote Sync Event to be shared with the DPA.
doca_sync_event_cap_is_export_to_remote_net_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_is_export_to_remote_net_supported(const struct doca_devinfo *devinfo)
doca_sync_event_task_wait_eq_set_wait_val
DOCA_EXPERIMENTAL void doca_sync_event_task_wait_eq_set_wait_val(struct doca_sync_event_task_wait_eq *task, uint64_t wait_val)
Set the wait value of a DOCA wait-equal task.
doca_sync_event_remote_net_get_gpu_handle
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_remote_net_get_gpu_handle(struct doca_sync_event_remote_net *event, struct doca_gpu *gpu, doca_gpu_dev_sync_event_remote_net_t *gpu_remote_event)
Export remote Sync Event to be shared with the GPU.
doca_sync_event_task_get_get_ret_val_ptr
DOCA_EXPERIMENTAL uint64_t * doca_sync_event_task_get_get_ret_val_ptr(const struct doca_sync_event_task_get *task)
Get the return value pointer of a DOCA Sync Event get task.
doca_sync_event_get_dpa_handle
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_get_dpa_handle(struct doca_sync_event *event, struct doca_dpa *dpa, doca_dpa_dev_sync_event_t *dpa_dev_se_handle)
Export Sync Event to be shared with the DPA.
doca_sync_event_task_notify_add_as_doca_task
DOCA_EXPERIMENTAL struct doca_task * doca_sync_event_task_notify_add_as_doca_task(struct doca_sync_event_task_notify_add *task)
Convert a DOCA Sync Event notify-add task to a DOCA Task.
doca_sync_event_add_publisher_location_remote_net
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_add_publisher_location_remote_net(struct doca_sync_event *event)
Declare Sync Event publisher as a remote peer.
doca_sync_event_add_subscriber_location_cpu
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_add_subscriber_location_cpu(struct doca_sync_event *event, struct doca_dev *dev)
doca_gpu_dev_sync_event_remote_net_t
uint64_t doca_gpu_dev_sync_event_remote_net_t
DOCA Sync Event remote GPU handle.
Definition: doca_sync_event.h:73
doca_sync_event_export_to_remote_pci
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_export_to_remote_pci(struct doca_sync_event *event, struct doca_dev *dev, const uint8_t **data, size_t *sz)
Export Sync Event to be shared with remote PCI.
doca_gpu_dev_sync_event_t
uint64_t doca_gpu_dev_sync_event_t
DOCA Sync Event GPU handle.
Definition: doca_sync_event.h:63
doca_sync_event_task_wait_eq_get_wait_val
DOCA_EXPERIMENTAL uint64_t doca_sync_event_task_wait_eq_get_wait_val(const struct doca_sync_event_task_wait_eq *task)
Get the wait value of a DOCA Sync Event wait-equal task.
doca_sync_event_destroy
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_destroy(struct doca_sync_event *event)
Destroy a Sync Event instance.
doca_sync_event_task_notify_set_completion_cb_t
void(* doca_sync_event_task_notify_set_completion_cb_t)(struct doca_sync_event_task_notify_set *task, union doca_data task_user_data, union doca_data ctx_user_data)
Set task completion callback.
Definition: doca_sync_event.h:111
doca_sync_event_add_publisher_location_dpa
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_add_publisher_location_dpa(struct doca_sync_event *event, struct doca_dpa *dpa)
Associate a DOCA DPA context as the Sync Event publisher.
doca_sync_event_add_subscriber_location_gpu
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_add_subscriber_location_gpu(struct doca_sync_event *event, struct doca_gpu *gpu)
Associate a DOCA GPU context as the Sync Event subscriber.
doca_sync_event_task_get_completion_cb_t
void(* doca_sync_event_task_get_completion_cb_t)(struct doca_sync_event_task_get *task, union doca_data task_user_data, union doca_data ctx_user_data)
Get task completion callback.
Definition: doca_sync_event.h:94
doca_sync_event_task_wait_neq_alloc_init
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_task_wait_neq_alloc_init(struct doca_sync_event *event, uint64_t wait_val, uint64_t mask, union doca_data user_data, struct doca_sync_event_task_wait_neq **task)
Allocate a DOCA Sync Event wait-not-equal task.
doca_sync_event_task_notify_add_get_inc_val
DOCA_EXPERIMENTAL uint64_t doca_sync_event_task_notify_add_get_inc_val(const struct doca_sync_event_task_notify_add *task)
Get the increment value of a DOCA Sync Event notify-add task.
doca_sync_event_task_wait_neq_completion_cb_t
void(* doca_sync_event_task_wait_neq_completion_cb_t)(struct doca_sync_event_task_wait_neq *task, union doca_data task_user_data, union doca_data ctx_user_data)
Wait neq task completion callback.
Definition: doca_sync_event.h:162
doca_sync_event_task_wait_eq_completion_cb_t
void(* doca_sync_event_task_wait_eq_completion_cb_t)(struct doca_sync_event_task_wait_eq *task, union doca_data task_user_data, union doca_data ctx_user_data)
Wait eq task completion callback.
Definition: doca_sync_event.h:145
doca_sync_event_add_publisher_location_cpu
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_add_publisher_location_cpu(struct doca_sync_event *event, struct doca_dev *dev)
Associate a CPU device context as the Sync Event publisher.
doca_sync_event_set_doca_buf
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_set_doca_buf(struct doca_sync_event *event, struct doca_buf *buf)
Set the 64-bit value's buffer for a Sync Event.
doca_sync_event_task_notify_set_get_set_val
DOCA_EXPERIMENTAL uint64_t doca_sync_event_task_notify_set_get_set_val(const struct doca_sync_event_task_notify_set *task)
Get the set value of a DOCA Sync Event notify-set task.
doca_sync_event_task_wait_neq_set_mask
DOCA_EXPERIMENTAL void doca_sync_event_task_wait_neq_set_mask(struct doca_sync_event_task_wait_neq *task, uint64_t mask)
Set the mask of a DOCA wait-not-equal task.
doca_sync_event_add_publisher_location_gpu
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_add_publisher_location_gpu(struct doca_sync_event *event, struct doca_gpu *gpu)
Associate a DOCA GPU context as the Sync Event publisher.
doca_sync_event_cap_task_notify_add_is_supported
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_cap_task_notify_add_is_supported(const struct doca_devinfo *devinfo)
Check if a given device supports submitting a DOCA Sync Event notify-add task.
doca_sync_event_export_to_remote_net
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_export_to_remote_net(struct doca_sync_event *event, const uint8_t **data, size_t *sz)
Export Sync Event to be shared with a remote peer.
doca_dpa_dev_sync_event_remote_net_t
uint64_t doca_dpa_dev_sync_event_remote_net_t
DOCA Sync Event remote DPA handle.
Definition: doca_sync_event.h:61
doca_sync_event_add_subscriber_location_remote_pci
DOCA_EXPERIMENTAL doca_error_t doca_sync_event_add_subscriber_location_remote_pci(struct doca_sync_event *event)
Declare Sync Event subscriber as remote PCI.
value
type value
Definition: meson_options.txt:28
doca_data
Convenience type for representing opaque data.
Definition: doca_types.h:56