doca_ctx.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 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_CTX_H_
#define DOCA_CTX_H_
 
#include <stddef.h>
#include <stdint.h>
 
#include <doca_error.h>
#include <doca_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************************************************************************************************************
 * DOCA Context
 *********************************************************************************************************************/
 
struct doca_ctx;
struct doca_devinfo;
 
enum doca_ctx_states {
    DOCA_CTX_STATE_IDLE = 0,
    DOCA_CTX_STATE_STARTING = 1,
    DOCA_CTX_STATE_RUNNING = 2,
    /*
     * doca_ctx_stop called.
     * Resources are allocated, context can not allocate tasks, submit tasks, allocate events or register events.
     * Submitted tasks are flushed or drained (during progress call).
     * ctx will usually move to idle state when number of in-flight tasks reach 0.
     * Application should call progress_one until the context moves to idle state.
     */
    DOCA_CTX_STATE_STOPPING = 3,
};
 
typedef void (*doca_ctx_state_changed_callback_t)(const union doca_data user_data,
                          struct doca_ctx *ctx,
                          enum doca_ctx_states prev_state,
                          enum doca_ctx_states next_state);
 
DOCA_STABLE
doca_error_t doca_ctx_start(struct doca_ctx *ctx);
 
DOCA_STABLE
doca_error_t doca_ctx_stop(struct doca_ctx *ctx);
 
DOCA_STABLE
doca_error_t doca_ctx_get_num_inflight_tasks(const struct doca_ctx *ctx, size_t *num_inflight_tasks);
 
struct doca_gpu;
 
DOCA_EXPERIMENTAL
doca_error_t doca_ctx_set_datapath_on_gpu(struct doca_ctx *ctx, struct doca_gpu *gpu_dev);
 
DOCA_STABLE
doca_error_t doca_ctx_set_user_data(struct doca_ctx *ctx, union doca_data user_data);
 
DOCA_STABLE
doca_error_t doca_ctx_get_user_data(const struct doca_ctx *ctx, union doca_data *user_data);
 
DOCA_STABLE
doca_error_t doca_ctx_set_state_changed_cb(struct doca_ctx *ctx, doca_ctx_state_changed_callback_t cb);
 
DOCA_STABLE
doca_error_t doca_ctx_get_state(const struct doca_ctx *ctx, enum doca_ctx_states *state);
 
DOCA_EXPERIMENTAL
void doca_ctx_flush_tasks(struct doca_ctx *ctx);
 
struct doca_dpa;
 
DOCA_EXPERIMENTAL
doca_error_t doca_ctx_set_datapath_on_dpa(struct doca_ctx *ctx, struct doca_dpa *dpa_dev);
 
DOCA_EXPERIMENTAL
doca_error_t doca_ctx_set_completion_vector(struct doca_ctx *ctx, uint32_t comp_vector);
 
DOCA_EXPERIMENTAL
doca_error_t doca_ctx_cap_get_num_completion_vectors(const struct doca_devinfo *devinfo, uint32_t *num_comp_vectors);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_CTX_H_ */