doca_pe.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
 *
 * This software product is a proprietary product of NVIDIA CORPORATION &
 * AFFILIATES (the "Company") and all right, title, and interest in and to the
 * software product, including all associated intellectual property rights, are
 * and shall remain exclusively with the Company.
 *
 * This software product is governed by the End User License Agreement
 * provided with the software product.
 *
 */
 
#ifndef DOCA_PE_H_
#define DOCA_PE_H_
 
#include <stdint.h>
#include <stdlib.h>
 
#include <doca_compat.h>
#include <doca_error.h>
#include <doca_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct doca_ctx;
struct doca_pe;
struct doca_task;
struct doca_task_batch;
struct doca_devinfo;
 
enum doca_task_batch_max_tasks_number {
    DOCA_TASK_BATCH_MAX_TASKS_NUMBER_16,
    DOCA_TASK_BATCH_MAX_TASKS_NUMBER_32,
    DOCA_TASK_BATCH_MAX_TASKS_NUMBER_64,
    DOCA_TASK_BATCH_MAX_TASKS_NUMBER_128,
};
 
enum doca_event_batch_events_number {
    DOCA_EVENT_BATCH_EVENTS_NUMBER_1,
    DOCA_EVENT_BATCH_EVENTS_NUMBER_2,
    DOCA_EVENT_BATCH_EVENTS_NUMBER_4,
    DOCA_EVENT_BATCH_EVENTS_NUMBER_8,
    DOCA_EVENT_BATCH_EVENTS_NUMBER_16,
    DOCA_EVENT_BATCH_EVENTS_NUMBER_32,
    DOCA_EVENT_BATCH_EVENTS_NUMBER_64,
    DOCA_EVENT_BATCH_EVENTS_NUMBER_128,
};
 
enum doca_task_submit_flag {
    DOCA_TASK_SUBMIT_FLAG_NONE = 0U,
    DOCA_TASK_SUBMIT_FLAG_FLUSH = (1U << 0),        
    DOCA_TASK_SUBMIT_FLAG_OPTIMIZE_REPORTS = (1U << 1), 
};
 
enum doca_pe_event_mode {
    DOCA_PE_EVENT_MODE_PROGRESS_SELECTIVE, /* PE shall progress only contexts that received an event or that had
                        * tasks to progress when doca_pe_request_notification was called.
                        * doca_pe_clear_notification must be called after an event was
                        * triggered. */
    DOCA_PE_EVENT_MODE_PROGRESS_ALL /* PE shall progress all contexts when doca_pe_progress is called. No need to
                     * call doca_pe_clear_notification after an event was triggered. */
};
 
typedef void (*doca_task_completion_cb_t)(struct doca_task *task,
                      union doca_data task_user_data,
                      union doca_data ctx_user_data);
 
DOCA_STABLE
doca_error_t doca_pe_create(struct doca_pe **pe);
 
DOCA_STABLE
doca_error_t doca_pe_destroy(struct doca_pe *pe);
 
DOCA_STABLE
uint8_t doca_pe_progress(struct doca_pe *pe);
 
#ifdef __linux__
DOCA_STABLE
doca_error_t doca_pe_get_notification_handle(const struct doca_pe *pe, doca_notification_handle_t *handle);
 
#endif /* __linux__ */
 
#ifdef _WIN32
 
DOCA_STABLE
doca_error_t doca_pe_set_notification_handle(struct doca_pe *pe,
                         doca_notification_handle_t handle,
                         union doca_data completion_key);
 
#endif /* _WIN32 */
 
DOCA_STABLE
doca_error_t doca_pe_clear_notification(struct doca_pe *pe, doca_notification_handle_t handle);
 
DOCA_STABLE
doca_error_t doca_pe_request_notification(struct doca_pe *pe);
 
DOCA_STABLE
doca_error_t doca_pe_get_num_inflight_tasks(const struct doca_pe *pe, size_t *num_inflight_tasks);
 
DOCA_STABLE
doca_error_t doca_task_submit(struct doca_task *task);
 
DOCA_EXPERIMENTAL
doca_error_t doca_task_submit_ex(struct doca_task *task, uint32_t flags);
 
DOCA_EXPERIMENTAL
doca_error_t doca_task_batch_submit(struct doca_task_batch *task_batch);
 
DOCA_STABLE
doca_error_t doca_task_try_submit(struct doca_task *task);
 
DOCA_EXPERIMENTAL
doca_error_t doca_task_batch_try_submit(struct doca_task_batch *task_batch);
 
DOCA_STABLE
void doca_task_free(struct doca_task *task);
 
DOCA_EXPERIMENTAL
void doca_task_batch_free(struct doca_task_batch *task_batch);
 
DOCA_STABLE
doca_error_t doca_task_get_status(const struct doca_task *task);
 
DOCA_EXPERIMENTAL
doca_error_t doca_task_batch_get_status(const struct doca_task_batch *task_batch);
 
DOCA_STABLE
void doca_task_set_user_data(struct doca_task *task, union doca_data user_data);
 
DOCA_EXPERIMENTAL
void doca_task_batch_set_user_data(struct doca_task_batch *task_batch, union doca_data user_data);
 
DOCA_STABLE
union doca_data doca_task_get_user_data(const struct doca_task *task);
 
DOCA_EXPERIMENTAL
union doca_data doca_task_batch_get_user_data(const struct doca_task_batch *task_batch);
 
DOCA_STABLE
struct doca_ctx *doca_task_get_ctx(const struct doca_task *task);
 
DOCA_EXPERIMENTAL
struct doca_ctx *doca_task_batch_get_ctx(const struct doca_task_batch *task_batch);
 
DOCA_EXPERIMENTAL
union doca_data doca_task_batch_get_ctx_user_data(const struct doca_task_batch *task_batch);
 
DOCA_EXPERIMENTAL
uint16_t doca_task_batch_get_tasks_num(struct doca_task_batch *task_batch);
 
DOCA_STABLE
doca_error_t doca_pe_connect_ctx(struct doca_pe *pe, struct doca_ctx *ctx);
 
DOCA_EXPERIMENTAL
doca_error_t doca_pe_set_event_mode(struct doca_pe *pe, enum doca_pe_event_mode event_mode);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_PE_H_ */