NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_dpa.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 
22 #ifndef DOCA_DPA_H_
23 #define DOCA_DPA_H_
24 
25 #include <stdint.h>
26 #include <stddef.h>
27 #include <stdarg.h>
28 #include <stdbool.h>
29 #include <doca_compat.h>
30 #include <doca_error.h>
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
39 struct doca_devinfo;
40 struct doca_dev;
41 struct doca_sync_event;
42 struct doca_dpa;
43 struct doca_buf;
44 struct doca_dpa_hash_table;
45 struct doca_dpa_eu_affinity;
46 struct doca_dpa_thread;
47 struct doca_dpa_tg;
48 struct doca_dpa_completion;
49 struct doca_dpa_async_ops;
50 struct doca_dpa_notification_completion;
51 
57 #define DOCA_DPA_COMPLETION_LOG_MAX_USER_DATA (24)
58 
62 typedef enum doca_dpa_dev_log_level {
63  DOCA_DPA_DEV_LOG_LEVEL_DISABLE = 10,
64  DOCA_DPA_DEV_LOG_LEVEL_ERROR = 30,
65  DOCA_DPA_DEV_LOG_LEVEL_WARNING = 40,
66  DOCA_DPA_DEV_LOG_LEVEL_INFO = 50,
67  DOCA_DPA_DEV_LOG_LEVEL_DEBUG = 60,
68 } doca_dpa_dev_log_level_t;
69 
73 typedef uint64_t doca_dpa_dev_t;
74 
78 typedef uint64_t doca_dpa_dev_uintptr_t;
79 
83 typedef uint64_t doca_dpa_dev_hash_table_t;
84 
88 typedef uint64_t doca_dpa_dev_completion_t;
89 
93 typedef uint64_t doca_dpa_dev_async_ops_t;
94 
98 typedef uint64_t doca_dpa_dev_notification_completion_t;
99 
107 struct doca_dpa_app;
108 
118 typedef void(doca_dpa_func_t)(void);
119 
130 DOCA_EXPERIMENTAL
131 doca_error_t doca_dpa_cap_is_supported(const struct doca_devinfo *devinfo);
132 
150 DOCA_EXPERIMENTAL
151 doca_error_t doca_dpa_create(struct doca_dev *dev, struct doca_dpa **dpa);
152 
166 DOCA_EXPERIMENTAL
167 doca_error_t doca_dpa_destroy(struct doca_dpa *dpa);
168 
180 DOCA_EXPERIMENTAL
181 doca_error_t doca_dpa_start(struct doca_dpa *dpa);
182 
194 DOCA_EXPERIMENTAL
195 doca_error_t doca_dpa_stop(struct doca_dpa *dpa);
196 
212 DOCA_EXPERIMENTAL
213 doca_error_t doca_dpa_set_app(struct doca_dpa *dpa, struct doca_dpa_app *app);
214 
225 DOCA_EXPERIMENTAL
226 doca_error_t doca_dpa_get_app(struct doca_dpa *dpa, struct doca_dpa_app **app);
227 
247 DOCA_EXPERIMENTAL
248 doca_error_t doca_dpa_app_get_name(struct doca_dpa_app *app, char *app_name, uint32_t *app_name_len);
249 
266 DOCA_EXPERIMENTAL
267 doca_error_t doca_dpa_set_log_level(struct doca_dpa *dpa, doca_dpa_dev_log_level_t log_level);
268 
279 DOCA_EXPERIMENTAL
280 doca_error_t doca_dpa_get_log_level(struct doca_dpa *dpa, doca_dpa_dev_log_level_t *log_level);
281 
298 DOCA_EXPERIMENTAL
299 doca_error_t doca_dpa_log_file_set_path(struct doca_dpa *dpa, const char *file_path);
300 
316 DOCA_EXPERIMENTAL
317 doca_error_t doca_dpa_log_file_get_path(struct doca_dpa *dpa, char *file_path, uint32_t *file_path_len);
318 
335 DOCA_EXPERIMENTAL
336 doca_error_t doca_dpa_trace_file_set_path(struct doca_dpa *dpa, const char *file_path);
337 
353 DOCA_EXPERIMENTAL
354 doca_error_t doca_dpa_trace_file_get_path(struct doca_dpa *dpa, char *file_path, uint32_t *file_path_len);
355 
366 DOCA_EXPERIMENTAL
367 doca_error_t doca_dpa_get_max_threads_per_kernel(const struct doca_dpa *dpa, unsigned int *value);
368 
380 DOCA_EXPERIMENTAL
381 doca_error_t doca_dpa_get_kernel_max_run_time(const struct doca_dpa *dpa, unsigned long long *value);
382 
408 DOCA_EXPERIMENTAL
409 doca_error_t doca_dpa_device_extend(struct doca_dpa *dpa, struct doca_dev *other_dev, struct doca_dpa **extended_dpa);
410 
422 DOCA_EXPERIMENTAL
423 doca_error_t doca_dpa_get_dpa_handle(struct doca_dpa *dpa, doca_dpa_dev_t *handle);
424 
436 DOCA_EXPERIMENTAL
437 doca_error_t doca_dpa_get_uar_id(const struct doca_dpa *dpa, uint32_t *uar_id);
438 
472 DOCA_EXPERIMENTAL
473 doca_error_t doca_dpa_kernel_launch_update_set(struct doca_dpa *dpa,
474  struct doca_sync_event *wait_event,
475  uint64_t wait_threshold,
476  struct doca_sync_event *comp_event,
477  uint64_t comp_count,
478  unsigned int num_threads,
479  doca_dpa_func_t *func,
480  ... /* args */);
481 
505 DOCA_EXPERIMENTAL
506 doca_error_t doca_dpa_kernel_launch_update_add(struct doca_dpa *dpa,
507  struct doca_sync_event *wait_event,
508  uint64_t wait_threshold,
509  struct doca_sync_event *comp_event,
510  uint64_t comp_count,
511  unsigned int num_threads,
512  doca_dpa_func_t *func,
513  ... /* args */);
514 
537 DOCA_EXPERIMENTAL
538 doca_error_t doca_dpa_rpc(struct doca_dpa *dpa, doca_dpa_func_t *func, uint64_t *retval, ... /* args */);
539 
555 DOCA_EXPERIMENTAL
556 doca_error_t doca_dpa_peek_at_last_error(const struct doca_dpa *dpa);
557 
576 DOCA_EXPERIMENTAL
577 doca_error_t doca_dpa_mem_alloc(struct doca_dpa *dpa, size_t size, doca_dpa_dev_uintptr_t *dev_ptr);
578 
594 DOCA_EXPERIMENTAL
595 doca_error_t doca_dpa_mem_free(struct doca_dpa *dpa, doca_dpa_dev_uintptr_t dev_ptr);
596 
614 DOCA_EXPERIMENTAL
615 doca_error_t doca_dpa_h2d_memcpy(struct doca_dpa *dpa, doca_dpa_dev_uintptr_t dst_ptr, void *src_ptr, size_t size);
616 
634 DOCA_EXPERIMENTAL
635 doca_error_t doca_dpa_h2d_buf_memcpy(struct doca_dpa *dpa,
636  doca_dpa_dev_uintptr_t dst_ptr,
637  struct doca_buf *buf,
638  size_t size);
639 
657 DOCA_EXPERIMENTAL
658 doca_error_t doca_dpa_d2h_memcpy(struct doca_dpa *dpa, void *dst_ptr, doca_dpa_dev_uintptr_t src_ptr, size_t size);
659 
677 DOCA_EXPERIMENTAL
678 doca_error_t doca_dpa_d2h_buf_memcpy(struct doca_dpa *dpa,
679  struct doca_buf *buf,
680  doca_dpa_dev_uintptr_t src_ptr,
681  size_t size);
682 
700 DOCA_EXPERIMENTAL
701 doca_error_t doca_dpa_memset(struct doca_dpa *dpa, doca_dpa_dev_uintptr_t dev_ptr, int value, size_t size);
702 
721 DOCA_EXPERIMENTAL
722 doca_error_t doca_dpa_hash_table_create(struct doca_dpa *dpa,
723  unsigned int num_entries,
724  struct doca_dpa_hash_table **ht);
725 
741 DOCA_EXPERIMENTAL
742 doca_error_t doca_dpa_hash_table_destroy(struct doca_dpa_hash_table *ht);
743 
754 DOCA_EXPERIMENTAL
755 doca_error_t doca_dpa_hash_table_get_dpa_handle(struct doca_dpa_hash_table *ht, doca_dpa_dev_hash_table_t *ht_handle);
756 
769 DOCA_EXPERIMENTAL
770 doca_error_t doca_dpa_get_core_num(struct doca_dpa *dpa, unsigned int *num_cores);
771 
784 DOCA_EXPERIMENTAL
785 doca_error_t doca_dpa_get_num_eus_per_core(struct doca_dpa *dpa, unsigned int *eus_per_core);
786 
799 DOCA_EXPERIMENTAL
800 doca_error_t doca_dpa_get_total_num_eus_available(struct doca_dpa *dpa, unsigned int *total_num_eus);
801 
817 DOCA_EXPERIMENTAL
818 doca_error_t doca_dpa_eu_affinity_create(struct doca_dpa *dpa, struct doca_dpa_eu_affinity **affinity);
819 
832 DOCA_EXPERIMENTAL
833 doca_error_t doca_dpa_eu_affinity_destroy(struct doca_dpa_eu_affinity *affinity);
834 
847 DOCA_EXPERIMENTAL
848 doca_error_t doca_dpa_eu_affinity_set(struct doca_dpa_eu_affinity *affinity, unsigned int eu_id);
849 
861 DOCA_EXPERIMENTAL
862 doca_error_t doca_dpa_eu_affinity_clear(struct doca_dpa_eu_affinity *affinity);
863 
876 DOCA_EXPERIMENTAL
877 doca_error_t doca_dpa_eu_affinity_get(struct doca_dpa_eu_affinity *affinity, unsigned int *eu_id);
878 
901 DOCA_EXPERIMENTAL
902 doca_error_t doca_dpa_thread_create(struct doca_dpa *dpa, struct doca_dpa_thread **dpa_thread);
903 
917 DOCA_EXPERIMENTAL
918 doca_error_t doca_dpa_thread_destroy(struct doca_dpa_thread *dpa_thread);
919 
939 DOCA_EXPERIMENTAL
940 doca_error_t doca_dpa_thread_set_func_arg(struct doca_dpa_thread *dpa_thread, doca_dpa_func_t *func, uint64_t arg);
941 
953 DOCA_EXPERIMENTAL
954 doca_error_t doca_dpa_thread_get_func_arg(struct doca_dpa_thread *dpa_thread, doca_dpa_func_t **func, uint64_t *arg);
955 
972 DOCA_EXPERIMENTAL
973 doca_error_t doca_dpa_thread_set_local_storage(struct doca_dpa_thread *dpa_thread, doca_dpa_dev_uintptr_t dev_ptr);
974 
985 DOCA_EXPERIMENTAL
986 doca_error_t doca_dpa_thread_get_local_storage(struct doca_dpa_thread *dpa_thread, doca_dpa_dev_uintptr_t *dev_ptr);
987 
1004 DOCA_EXPERIMENTAL
1005 doca_error_t doca_dpa_thread_set_affinity(struct doca_dpa_thread *dpa_thread,
1006  const struct doca_dpa_eu_affinity *affinity);
1007 
1018 DOCA_EXPERIMENTAL
1019 doca_error_t doca_dpa_thread_get_affinity(struct doca_dpa_thread *dpa_thread,
1020  const struct doca_dpa_eu_affinity **affinity);
1021 
1036 DOCA_EXPERIMENTAL
1037 doca_error_t doca_dpa_thread_start(struct doca_dpa_thread *dpa_thread);
1038 
1050 DOCA_EXPERIMENTAL
1051 doca_error_t doca_dpa_thread_stop(struct doca_dpa_thread *dpa_thread);
1052 
1073 DOCA_EXPERIMENTAL
1074 doca_error_t doca_dpa_thread_run(struct doca_dpa_thread *dpa_thread);
1075 
1088 DOCA_EXPERIMENTAL
1089 doca_error_t doca_dpa_thread_get_id(struct doca_dpa_thread *dpa_thread, uint32_t *dpa_thread_id);
1090 
1107 DOCA_EXPERIMENTAL
1108 doca_error_t doca_dpa_thread_group_create(struct doca_dpa *dpa, unsigned int num_threads, struct doca_dpa_tg **tg);
1109 
1123 DOCA_EXPERIMENTAL
1124 doca_error_t doca_dpa_thread_group_destroy(struct doca_dpa_tg *tg);
1125 
1136 DOCA_EXPERIMENTAL
1137 doca_error_t doca_dpa_thread_group_get_num_threads(struct doca_dpa_tg *tg, unsigned int *num_threads);
1138 
1159 DOCA_EXPERIMENTAL
1160 doca_error_t doca_dpa_thread_group_set_thread(struct doca_dpa_tg *tg,
1161  struct doca_dpa_thread *thread,
1162  unsigned int rank);
1163 
1178 DOCA_EXPERIMENTAL
1179 doca_error_t doca_dpa_thread_group_start(struct doca_dpa_tg *tg);
1180 
1192 DOCA_EXPERIMENTAL
1193 doca_error_t doca_dpa_thread_group_stop(struct doca_dpa_tg *tg);
1194 
1214 DOCA_EXPERIMENTAL
1215 doca_error_t doca_dpa_completion_create(struct doca_dpa *dpa,
1216  unsigned int queue_size,
1217  struct doca_dpa_completion **dpa_comp);
1218 
1232 DOCA_EXPERIMENTAL
1233 doca_error_t doca_dpa_completion_destroy(struct doca_dpa_completion *dpa_comp);
1234 
1245 DOCA_EXPERIMENTAL
1246 doca_error_t doca_dpa_completion_get_queue_size(struct doca_dpa_completion *dpa_comp, unsigned int *queue_size);
1247 
1264 DOCA_EXPERIMENTAL
1265 doca_error_t doca_dpa_completion_set_thread(struct doca_dpa_completion *dpa_comp, struct doca_dpa_thread *dpa_thread);
1266 
1277 DOCA_EXPERIMENTAL
1278 doca_error_t doca_dpa_completion_get_thread(struct doca_dpa_completion *dpa_comp, struct doca_dpa_thread **dpa_thread);
1279 
1294 DOCA_EXPERIMENTAL
1295 doca_error_t doca_dpa_completion_start(struct doca_dpa_completion *dpa_comp);
1296 
1308 DOCA_EXPERIMENTAL
1309 doca_error_t doca_dpa_completion_stop(struct doca_dpa_completion *dpa_comp);
1310 
1322 DOCA_EXPERIMENTAL
1323 doca_error_t doca_dpa_completion_get_dpa_handle(struct doca_dpa_completion *dpa_comp,
1324  doca_dpa_dev_completion_t *handle);
1325 
1346 DOCA_EXPERIMENTAL
1347 doca_error_t doca_dpa_async_ops_create(struct doca_dpa *dpa,
1348  unsigned int queue_size,
1349  uint64_t user_data,
1350  struct doca_dpa_async_ops **async_ops);
1351 
1365 DOCA_EXPERIMENTAL
1366 doca_error_t doca_dpa_async_ops_destroy(struct doca_dpa_async_ops *async_ops);
1367 
1378 DOCA_EXPERIMENTAL
1379 doca_error_t doca_dpa_async_ops_get_queue_size(struct doca_dpa_async_ops *async_ops, unsigned int *queue_size);
1380 
1391 DOCA_EXPERIMENTAL
1392 doca_error_t doca_dpa_async_ops_get_user_data(struct doca_dpa_async_ops *async_ops, uint64_t *user_data);
1393 
1410 DOCA_EXPERIMENTAL
1411 doca_error_t doca_dpa_async_ops_attach(struct doca_dpa_async_ops *async_ops, struct doca_dpa_completion *dpa_comp);
1412 
1427 DOCA_EXPERIMENTAL
1428 doca_error_t doca_dpa_async_ops_start(struct doca_dpa_async_ops *async_ops);
1429 
1441 DOCA_EXPERIMENTAL
1442 doca_error_t doca_dpa_async_ops_stop(struct doca_dpa_async_ops *async_ops);
1443 
1455 DOCA_EXPERIMENTAL
1456 doca_error_t doca_dpa_async_ops_get_dpa_handle(struct doca_dpa_async_ops *async_ops, doca_dpa_dev_async_ops_t *handle);
1457 
1476 DOCA_EXPERIMENTAL
1477 doca_error_t doca_dpa_notification_completion_create(struct doca_dpa *dpa,
1478  struct doca_dpa_thread *dpa_thread,
1479  struct doca_dpa_notification_completion **notify_comp);
1480 
1494 DOCA_EXPERIMENTAL
1495 doca_error_t doca_dpa_notification_completion_destroy(struct doca_dpa_notification_completion *notify_comp);
1496 
1507 DOCA_EXPERIMENTAL
1508 doca_error_t doca_dpa_notification_completion_get_thread(struct doca_dpa_notification_completion *notify_comp,
1509  struct doca_dpa_thread **dpa_thread);
1510 
1525 DOCA_EXPERIMENTAL
1526 doca_error_t doca_dpa_notification_completion_start(struct doca_dpa_notification_completion *notify_comp);
1527 
1539 DOCA_EXPERIMENTAL
1540 doca_error_t doca_dpa_notification_completion_stop(struct doca_dpa_notification_completion *notify_comp);
1541 
1553 DOCA_EXPERIMENTAL
1554 doca_error_t doca_dpa_notification_completion_get_dpa_handle(struct doca_dpa_notification_completion *notify_comp,
1555  doca_dpa_dev_notification_completion_t *handle);
1556 
1557 #ifdef __cplusplus
1558 }
1559 #endif
1560 
1561 #endif /* DOCA_DPA_H_ */
1562 
doca_compat.h
doca_error.h
DOCA_EXPERIMENTAL
#define DOCA_EXPERIMENTAL
To set a Symbol (or specifically a function) as experimental.
Definition: doca_compat.h:103
DOCA_DPA_DEV_LOG_LEVEL_ERROR
@ DOCA_DPA_DEV_LOG_LEVEL_ERROR
Definition: doca_dpa.h:64
DOCA_DPA_DEV_LOG_LEVEL_DISABLE
@ DOCA_DPA_DEV_LOG_LEVEL_DISABLE
Definition: doca_dpa.h:63
DOCA_DPA_DEV_LOG_LEVEL_DEBUG
@ DOCA_DPA_DEV_LOG_LEVEL_DEBUG
Definition: doca_dpa.h:67
DOCA_DPA_DEV_LOG_LEVEL_WARNING
@ DOCA_DPA_DEV_LOG_LEVEL_WARNING
Definition: doca_dpa.h:65
DOCA_DPA_DEV_LOG_LEVEL_INFO
@ DOCA_DPA_DEV_LOG_LEVEL_INFO
Definition: doca_dpa.h:66
doca_dpa_d2h_buf_memcpy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_d2h_buf_memcpy(struct doca_dpa *dpa, struct doca_buf *buf, doca_dpa_dev_uintptr_t src_ptr, size_t size)
Copy from DPA Heap to DOCA Buf.
doca_dpa_notification_completion_start
DOCA_EXPERIMENTAL doca_error_t doca_dpa_notification_completion_start(struct doca_dpa_notification_completion *notify_comp)
Start DPA notification completion context.
doca_dpa_async_ops_get_queue_size
DOCA_EXPERIMENTAL doca_error_t doca_dpa_async_ops_get_queue_size(struct doca_dpa_async_ops *async_ops, unsigned int *queue_size)
Get DPA asynchronous ops queue size.
doca_dpa_stop
DOCA_EXPERIMENTAL doca_error_t doca_dpa_stop(struct doca_dpa *dpa)
Stop a DPA context.
doca_dpa_hash_table_create
DOCA_EXPERIMENTAL doca_error_t doca_dpa_hash_table_create(struct doca_dpa *dpa, unsigned int num_entries, struct doca_dpa_hash_table **ht)
Create a hash table on DPA.
doca_dpa_log_file_get_path
DOCA_EXPERIMENTAL doca_error_t doca_dpa_log_file_get_path(struct doca_dpa *dpa, char *file_path, uint32_t *file_path_len)
Get log file path to write device logs into.
doca_dpa_thread_run
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_run(struct doca_dpa_thread *dpa_thread)
Run DPA thread.
doca_dpa_thread_create
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_create(struct doca_dpa *dpa, struct doca_dpa_thread **dpa_thread)
Create DPA thread.
doca_dpa_thread_group_set_thread
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_group_set_thread(struct doca_dpa_tg *tg, struct doca_dpa_thread *thread, unsigned int rank)
Set DPA thread at 'rank' in DPA thread group.
doca_dpa_trace_file_get_path
DOCA_EXPERIMENTAL doca_error_t doca_dpa_trace_file_get_path(struct doca_dpa *dpa, char *file_path, uint32_t *file_path_len)
Get trace file path to write device traces into.
doca_dpa_completion_destroy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_completion_destroy(struct doca_dpa_completion *dpa_comp)
Destroy DPA completion context.
doca_dpa_kernel_launch_update_set
DOCA_EXPERIMENTAL doca_error_t doca_dpa_kernel_launch_update_set(struct doca_dpa *dpa, struct doca_sync_event *wait_event, uint64_t wait_threshold, struct doca_sync_event *comp_event, uint64_t comp_count, unsigned int num_threads, doca_dpa_func_t *func,...)
Submit a kernel to DPA that sets completion event.
doca_dpa_create
DOCA_EXPERIMENTAL doca_error_t doca_dpa_create(struct doca_dev *dev, struct doca_dpa **dpa)
Create a DOCA DPA Context.
doca_dpa_dev_hash_table_t
uint64_t doca_dpa_dev_hash_table_t
DPA hash table handle type definition.
Definition: doca_dpa.h:83
doca_dpa_set_log_level
DOCA_EXPERIMENTAL doca_error_t doca_dpa_set_log_level(struct doca_dpa *dpa, doca_dpa_dev_log_level_t log_level)
Set device logs verbosity level.
doca_dpa_dev_log_level
doca_dpa_dev_log_level
DOCA DPA device log levels, sorted by verbosity from high to low.
Definition: doca_dpa.h:62
doca_dpa_notification_completion_destroy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_notification_completion_destroy(struct doca_dpa_notification_completion *notify_comp)
Destroy DPA notification completion context.
doca_dpa_dev_t
uint64_t doca_dpa_dev_t
DPA context handle type definition.
Definition: doca_dpa.h:73
doca_dpa_async_ops_stop
DOCA_EXPERIMENTAL doca_error_t doca_dpa_async_ops_stop(struct doca_dpa_async_ops *async_ops)
Stop DPA asynchronous ops context.
doca_dpa_get_dpa_handle
DOCA_EXPERIMENTAL doca_error_t doca_dpa_get_dpa_handle(struct doca_dpa *dpa, doca_dpa_dev_t *handle)
Get DPA context handle.
doca_dpa_completion_set_thread
DOCA_EXPERIMENTAL doca_error_t doca_dpa_completion_set_thread(struct doca_dpa_completion *dpa_comp, struct doca_dpa_thread *dpa_thread)
Set DPA completion context thread.
doca_dpa_device_extend
DOCA_EXPERIMENTAL doca_error_t doca_dpa_device_extend(struct doca_dpa *dpa, struct doca_dev *other_dev, struct doca_dpa **extended_dpa)
Create an extended DPA context.
doca_dpa_get_core_num
DOCA_EXPERIMENTAL doca_error_t doca_dpa_get_core_num(struct doca_dpa *dpa, unsigned int *num_cores)
Retrieve the number of available DPA cores.
doca_dpa_thread_group_destroy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_group_destroy(struct doca_dpa_tg *tg)
Destroy DPA thread group.
doca_dpa_notification_completion_create
DOCA_EXPERIMENTAL doca_error_t doca_dpa_notification_completion_create(struct doca_dpa *dpa, struct doca_dpa_thread *dpa_thread, struct doca_dpa_notification_completion **notify_comp)
Create DPA notification completion context.
doca_dpa_mem_alloc
DOCA_EXPERIMENTAL doca_error_t doca_dpa_mem_alloc(struct doca_dpa *dpa, size_t size, doca_dpa_dev_uintptr_t *dev_ptr)
Allocate DPA heap memory.
doca_dpa_get_num_eus_per_core
DOCA_EXPERIMENTAL doca_error_t doca_dpa_get_num_eus_per_core(struct doca_dpa *dpa, unsigned int *eus_per_core)
Retrieve the number of EUs available per DPA core.
doca_dpa_dev_log_level_t
enum doca_dpa_dev_log_level doca_dpa_dev_log_level_t
DOCA DPA device log levels, sorted by verbosity from high to low.
doca_dpa_completion_start
DOCA_EXPERIMENTAL doca_error_t doca_dpa_completion_start(struct doca_dpa_completion *dpa_comp)
Start DPA completion context.
doca_dpa_notification_completion_get_thread
DOCA_EXPERIMENTAL doca_error_t doca_dpa_notification_completion_get_thread(struct doca_dpa_notification_completion *notify_comp, struct doca_dpa_thread **dpa_thread)
Get DPA notification completion context attached thread.
doca_dpa_mem_free
DOCA_EXPERIMENTAL doca_error_t doca_dpa_mem_free(struct doca_dpa *dpa, doca_dpa_dev_uintptr_t dev_ptr)
Free the previously allocated DPA memory.
doca_dpa_destroy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_destroy(struct doca_dpa *dpa)
Destroy a DOCA DPA context.
doca_dpa_completion_get_thread
DOCA_EXPERIMENTAL doca_error_t doca_dpa_completion_get_thread(struct doca_dpa_completion *dpa_comp, struct doca_dpa_thread **dpa_thread)
Get DPA completion context attached thread.
doca_dpa_get_log_level
DOCA_EXPERIMENTAL doca_error_t doca_dpa_get_log_level(struct doca_dpa *dpa, doca_dpa_dev_log_level_t *log_level)
Get device logs verbosity level that was set for DPA context.
doca_dpa_eu_affinity_get
DOCA_EXPERIMENTAL doca_error_t doca_dpa_eu_affinity_get(struct doca_dpa_eu_affinity *affinity, unsigned int *eu_id)
Get EU ID from DPA EU affinity.
doca_dpa_rpc
DOCA_EXPERIMENTAL doca_error_t doca_dpa_rpc(struct doca_dpa *dpa, doca_dpa_func_t *func, uint64_t *retval,...)
RPC to run DPA kernel.
doca_dpa_completion_get_queue_size
DOCA_EXPERIMENTAL doca_error_t doca_dpa_completion_get_queue_size(struct doca_dpa_completion *dpa_comp, unsigned int *queue_size)
Get DPA completion context queue size.
doca_dpa_hash_table_get_dpa_handle
DOCA_EXPERIMENTAL doca_error_t doca_dpa_hash_table_get_dpa_handle(struct doca_dpa_hash_table *ht, doca_dpa_dev_hash_table_t *ht_handle)
Get DPA hash table handle.
doca_dpa_thread_set_local_storage
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_set_local_storage(struct doca_dpa_thread *dpa_thread, doca_dpa_dev_uintptr_t dev_ptr)
Set DPA thread local storage.
doca_dpa_completion_get_dpa_handle
DOCA_EXPERIMENTAL doca_error_t doca_dpa_completion_get_dpa_handle(struct doca_dpa_completion *dpa_comp, doca_dpa_dev_completion_t *handle)
Get DPA completion context handle.
doca_dpa_get_app
DOCA_EXPERIMENTAL doca_error_t doca_dpa_get_app(struct doca_dpa *dpa, struct doca_dpa_app **app)
Get program app that was set for DPA context.
doca_dpa_async_ops_attach
DOCA_EXPERIMENTAL doca_error_t doca_dpa_async_ops_attach(struct doca_dpa_async_ops *async_ops, struct doca_dpa_completion *dpa_comp)
Attach DPA asynchronous ops context to DPA completion context.
doca_dpa_notification_completion_get_dpa_handle
DOCA_EXPERIMENTAL doca_error_t doca_dpa_notification_completion_get_dpa_handle(struct doca_dpa_notification_completion *notify_comp, doca_dpa_dev_notification_completion_t *handle)
Get DPA notification completion context handle.
doca_dpa_completion_create
DOCA_EXPERIMENTAL doca_error_t doca_dpa_completion_create(struct doca_dpa *dpa, unsigned int queue_size, struct doca_dpa_completion **dpa_comp)
Create DPA completion context.
doca_dpa_eu_affinity_create
DOCA_EXPERIMENTAL doca_error_t doca_dpa_eu_affinity_create(struct doca_dpa *dpa, struct doca_dpa_eu_affinity **affinity)
Create DPA EU affinity.
doca_dpa_hash_table_destroy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_hash_table_destroy(struct doca_dpa_hash_table *ht)
Destroy DPA hash table.
doca_dpa_get_max_threads_per_kernel
DOCA_EXPERIMENTAL doca_error_t doca_dpa_get_max_threads_per_kernel(const struct doca_dpa *dpa, unsigned int *value)
Get maximum number of DPA threads to run a single kernel launch operation.
doca_dpa_func_t
void() doca_dpa_func_t(void)
Generic function pointer type.
Definition: doca_dpa.h:118
doca_dpa_thread_get_affinity
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_get_affinity(struct doca_dpa_thread *dpa_thread, const struct doca_dpa_eu_affinity **affinity)
Get DPA thread affinity.
doca_dpa_notification_completion_stop
DOCA_EXPERIMENTAL doca_error_t doca_dpa_notification_completion_stop(struct doca_dpa_notification_completion *notify_comp)
Stop DPA notification completion context.
doca_dpa_async_ops_create
DOCA_EXPERIMENTAL doca_error_t doca_dpa_async_ops_create(struct doca_dpa *dpa, unsigned int queue_size, uint64_t user_data, struct doca_dpa_async_ops **async_ops)
Create DPA asynchronous ops context.
doca_dpa_log_file_set_path
DOCA_EXPERIMENTAL doca_error_t doca_dpa_log_file_set_path(struct doca_dpa *dpa, const char *file_path)
Set log file path to write device logs into.
doca_dpa_eu_affinity_clear
DOCA_EXPERIMENTAL doca_error_t doca_dpa_eu_affinity_clear(struct doca_dpa_eu_affinity *affinity)
Clear DPA EU affinity.
doca_dpa_get_kernel_max_run_time
DOCA_EXPERIMENTAL doca_error_t doca_dpa_get_kernel_max_run_time(const struct doca_dpa *dpa, unsigned long long *value)
Get maximum allowable time in seconds that a kernel may remain scheduled on the DPA....
doca_dpa_dev_completion_t
uint64_t doca_dpa_dev_completion_t
DPA completion handle type definition.
Definition: doca_dpa.h:88
doca_dpa_start
DOCA_EXPERIMENTAL doca_error_t doca_dpa_start(struct doca_dpa *dpa)
Start a DPA context.
doca_dpa_async_ops_start
DOCA_EXPERIMENTAL doca_error_t doca_dpa_async_ops_start(struct doca_dpa_async_ops *async_ops)
Start DPA asynchronous ops context.
doca_dpa_thread_set_func_arg
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_set_func_arg(struct doca_dpa_thread *dpa_thread, doca_dpa_func_t *func, uint64_t arg)
Set DPA thread entry point and its argument.
doca_dpa_async_ops_get_dpa_handle
DOCA_EXPERIMENTAL doca_error_t doca_dpa_async_ops_get_dpa_handle(struct doca_dpa_async_ops *async_ops, doca_dpa_dev_async_ops_t *handle)
Get DPA asynchronous ops context handle.
doca_dpa_d2h_memcpy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_d2h_memcpy(struct doca_dpa *dpa, void *dst_ptr, doca_dpa_dev_uintptr_t src_ptr, size_t size)
Copy from DPA Heap to host memory.
doca_dpa_h2d_memcpy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_h2d_memcpy(struct doca_dpa *dpa, doca_dpa_dev_uintptr_t dst_ptr, void *src_ptr, size_t size)
Copy from host memory to DPA Heap.
doca_dpa_cap_is_supported
DOCA_EXPERIMENTAL doca_error_t doca_dpa_cap_is_supported(const struct doca_devinfo *devinfo)
Get whether the DOCA device supports DPA.
doca_dpa_thread_get_local_storage
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_get_local_storage(struct doca_dpa_thread *dpa_thread, doca_dpa_dev_uintptr_t *dev_ptr)
Get DPA thread local storage.
doca_dpa_completion_stop
DOCA_EXPERIMENTAL doca_error_t doca_dpa_completion_stop(struct doca_dpa_completion *dpa_comp)
Stop DPA completion context.
doca_dpa_dev_uintptr_t
uint64_t doca_dpa_dev_uintptr_t
DPA pointer type definition.
Definition: doca_dpa.h:78
doca_dpa_get_uar_id
DOCA_EXPERIMENTAL doca_error_t doca_dpa_get_uar_id(const struct doca_dpa *dpa, uint32_t *uar_id)
Get DPA UAR ID.
doca_dpa_thread_set_affinity
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_set_affinity(struct doca_dpa_thread *dpa_thread, const struct doca_dpa_eu_affinity *affinity)
Set DPA thread affinity.
doca_dpa_kernel_launch_update_add
DOCA_EXPERIMENTAL doca_error_t doca_dpa_kernel_launch_update_add(struct doca_dpa *dpa, struct doca_sync_event *wait_event, uint64_t wait_threshold, struct doca_sync_event *comp_event, uint64_t comp_count, unsigned int num_threads, doca_dpa_func_t *func,...)
Submit a kernel to DPA.
doca_dpa_peek_at_last_error
DOCA_EXPERIMENTAL doca_error_t doca_dpa_peek_at_last_error(const struct doca_dpa *dpa)
Return the last error generated on the DPA. Check if an error occurred on the device side runtime....
doca_dpa_thread_group_start
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_group_start(struct doca_dpa_tg *tg)
Start DPA thread group.
doca_dpa_thread_group_create
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_group_create(struct doca_dpa *dpa, unsigned int num_threads, struct doca_dpa_tg **tg)
Create DPA thread group.
doca_dpa_async_ops_destroy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_async_ops_destroy(struct doca_dpa_async_ops *async_ops)
Destroy DPA asynchronous ops context.
doca_dpa_dev_async_ops_t
uint64_t doca_dpa_dev_async_ops_t
DPA asynchronous ops handle type definition.
Definition: doca_dpa.h:93
doca_dpa_eu_affinity_destroy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_eu_affinity_destroy(struct doca_dpa_eu_affinity *affinity)
Destroy DPA EU affinity.
doca_dpa_thread_group_get_num_threads
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_group_get_num_threads(struct doca_dpa_tg *tg, unsigned int *num_threads)
Get DPA thread group number of threads.
doca_dpa_get_total_num_eus_available
DOCA_EXPERIMENTAL doca_error_t doca_dpa_get_total_num_eus_available(struct doca_dpa *dpa, unsigned int *total_num_eus)
Retrieve the total number of EUs available to the application.
doca_dpa_dev_notification_completion_t
uint64_t doca_dpa_dev_notification_completion_t
DPA notification completion handle type definition.
Definition: doca_dpa.h:98
doca_dpa_thread_start
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_start(struct doca_dpa_thread *dpa_thread)
Start DPA thread.
doca_dpa_memset
DOCA_EXPERIMENTAL doca_error_t doca_dpa_memset(struct doca_dpa *dpa, doca_dpa_dev_uintptr_t dev_ptr, int value, size_t size)
Set DPA Heap memory to a value.
doca_dpa_thread_get_func_arg
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_get_func_arg(struct doca_dpa_thread *dpa_thread, doca_dpa_func_t **func, uint64_t *arg)
Get DPA thread entry point and its argument.
doca_dpa_thread_stop
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_stop(struct doca_dpa_thread *dpa_thread)
Stop DPA thread.
doca_dpa_thread_get_id
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_get_id(struct doca_dpa_thread *dpa_thread, uint32_t *dpa_thread_id)
Get DPA thread ID.
doca_dpa_trace_file_set_path
DOCA_EXPERIMENTAL doca_error_t doca_dpa_trace_file_set_path(struct doca_dpa *dpa, const char *file_path)
Set trace file path to write device traces into.
doca_dpa_eu_affinity_set
DOCA_EXPERIMENTAL doca_error_t doca_dpa_eu_affinity_set(struct doca_dpa_eu_affinity *affinity, unsigned int eu_id)
Set EU ID in DPA EU affinity.
doca_dpa_async_ops_get_user_data
DOCA_EXPERIMENTAL doca_error_t doca_dpa_async_ops_get_user_data(struct doca_dpa_async_ops *async_ops, uint64_t *user_data)
Get DPA asynchronous ops context user data.
doca_dpa_thread_destroy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_destroy(struct doca_dpa_thread *dpa_thread)
Destroy DPA thread.
doca_dpa_app_get_name
DOCA_EXPERIMENTAL doca_error_t doca_dpa_app_get_name(struct doca_dpa_app *app, char *app_name, uint32_t *app_name_len)
Get DPA application name.
doca_dpa_h2d_buf_memcpy
DOCA_EXPERIMENTAL doca_error_t doca_dpa_h2d_buf_memcpy(struct doca_dpa *dpa, doca_dpa_dev_uintptr_t dst_ptr, struct doca_buf *buf, size_t size)
Copy from DOCA Buf to DPA Heap.
doca_dpa_set_app
DOCA_EXPERIMENTAL doca_error_t doca_dpa_set_app(struct doca_dpa *dpa, struct doca_dpa_app *app)
Set program app for DPA context.
doca_dpa_thread_group_stop
DOCA_EXPERIMENTAL doca_error_t doca_dpa_thread_group_stop(struct doca_dpa_tg *tg)
Stop DPA thread group.
doca_error_t
enum doca_error doca_error_t
DOCA API return codes.
value
type value
Definition: meson_options.txt:28
log_level
int log_level
Definition: pcc.c:40