doca_buf_array.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_BUF_ARRAY_H_
#define DOCA_BUF_ARRAY_H_
 
#include <stddef.h>
#include <stdint.h>
 
#include <doca_compat.h>
#include <doca_error.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*******************************************************************************
 * DOCA Buf Array
 ******************************************************************************/
 
struct doca_gpu;
struct doca_dpa;
struct doca_mmap;
 
struct doca_buf_arr;
struct doca_gpu_buf_arr;
 
typedef uint64_t doca_dpa_dev_buf_arr_t;
 
DOCA_EXPERIMENTAL
doca_error_t doca_buf_arr_create(size_t num_elem, struct doca_buf_arr **buf_arr);
 
DOCA_EXPERIMENTAL
doca_error_t doca_buf_arr_set_target_gpu(struct doca_buf_arr *buf_arr, struct doca_gpu *gpu_handler);
 
DOCA_EXPERIMENTAL
doca_error_t doca_buf_arr_set_target_dpa(struct doca_buf_arr *buf_arr, struct doca_dpa *dpa_handler);
 
DOCA_EXPERIMENTAL
doca_error_t doca_buf_arr_set_params(struct doca_buf_arr *buf_arr,
                     struct doca_mmap *mmap,
                     size_t elem_size,
                     uint64_t start_offset);
 
DOCA_EXPERIMENTAL
doca_error_t doca_buf_arr_start(struct doca_buf_arr *buf_arr);
 
DOCA_EXPERIMENTAL
doca_error_t doca_buf_arr_stop(struct doca_buf_arr *buf_arr);
 
DOCA_EXPERIMENTAL
doca_error_t doca_buf_arr_destroy(struct doca_buf_arr *buf_arr);
 
DOCA_EXPERIMENTAL
doca_error_t doca_buf_arr_get_gpu_handle(const struct doca_buf_arr *buf_arr, struct doca_gpu_buf_arr **gpu_buf_arr);
 
DOCA_EXPERIMENTAL
doca_error_t doca_buf_arr_get_dpa_handle(const struct doca_buf_arr *buf_arr, doca_dpa_dev_buf_arr_t *dpa_buf_arr);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_BUF_ARRAY_H_ */