doca_mmap.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_MMAP_H_
#define DOCA_MMAP_H_
 
#include <stddef.h>
#include <stdint.h>
 
#include <doca_compat.h>
#include <doca_error.h>
#include <doca_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct doca_dev;
struct doca_devinfo;
 
/*******************************************************************************
 * DOCA Memory Map
 ******************************************************************************/
 
struct doca_mmap;
struct doca_dpa;
 
typedef uint32_t doca_dpa_dev_mmap_t;
 
DOCA_STABLE
doca_error_t doca_mmap_create(struct doca_mmap **mmap);
 
DOCA_STABLE
doca_error_t doca_mmap_destroy(struct doca_mmap *mmap);
 
DOCA_STABLE
doca_error_t doca_mmap_start(struct doca_mmap *mmap);
 
DOCA_STABLE
doca_error_t doca_mmap_stop(struct doca_mmap *mmap);
 
DOCA_STABLE
doca_error_t doca_mmap_add_dev(struct doca_mmap *mmap, struct doca_dev *dev);
 
DOCA_STABLE
doca_error_t doca_mmap_rm_dev(struct doca_mmap *mmap, struct doca_dev *dev);
 
typedef void(doca_mmap_memrange_free_cb_t)(void *addr, size_t len, void *cookie);
 
DOCA_STABLE
doca_error_t doca_mmap_export_pci(struct doca_mmap *mmap,
                  const struct doca_dev *dev,
                  const void **export_desc,
                  size_t *export_desc_len);
 
DOCA_STABLE
doca_error_t doca_mmap_export_rdma(struct doca_mmap *mmap,
                   const struct doca_dev *dev,
                   const void **export_desc,
                   size_t *export_desc_len);
 
DOCA_EXPERIMENTAL
doca_error_t doca_mmap_dev_get_dpa_handle(struct doca_mmap *mmap,
                      const struct doca_dev *dev,
                      doca_dpa_dev_mmap_t *dpa_mmap_handle);
 
DOCA_STABLE
doca_error_t doca_mmap_create_from_export(const union doca_data *user_data,
                      const void *export_desc,
                      size_t export_desc_len,
                      struct doca_dev *dev,
                      struct doca_mmap **mmap);
 
/*******************************************************************************
 * DOCA Memory Map properties
 ******************************************************************************/
 
DOCA_STABLE
doca_error_t doca_mmap_set_memrange(struct doca_mmap *mmap, void *addr, size_t len);
 
DOCA_STABLE
doca_error_t doca_mmap_set_dmabuf_memrange(struct doca_mmap *mmap,
                       int dmabuf_fd,
                       void *addr,
                       size_t dmabuf_offset,
                       size_t len);
 
DOCA_EXPERIMENTAL
doca_error_t doca_mmap_set_dpa_memrange(struct doca_mmap *mmap, struct doca_dpa *dpa, uint64_t dpa_addr, size_t len);
 
DOCA_STABLE
doca_error_t doca_mmap_get_memrange(const struct doca_mmap *mmap, void **addr, size_t *len);
 
DOCA_STABLE
doca_error_t doca_mmap_set_free_cb(struct doca_mmap *mmap, doca_mmap_memrange_free_cb_t *free_cb, void *opaque);
 
DOCA_STABLE
doca_error_t doca_mmap_get_user_data(const struct doca_mmap *mmap, union doca_data *user_data);
 
DOCA_STABLE
doca_error_t doca_mmap_get_max_num_devices(const struct doca_mmap *mmap, uint32_t *max_num_devices);
 
DOCA_STABLE
doca_error_t doca_mmap_get_num_bufs(const struct doca_mmap *mmap, uint32_t *num_bufs);
 
DOCA_STABLE
doca_error_t doca_mmap_get_exported(const struct doca_mmap *mmap, uint8_t *exported);
 
DOCA_STABLE
doca_error_t doca_mmap_get_from_export(const struct doca_mmap *mmap, uint8_t *from_export);
 
DOCA_STABLE
doca_error_t doca_mmap_set_max_num_devices(struct doca_mmap *mmap, uint32_t max_num_devices);
 
DOCA_STABLE
doca_error_t doca_mmap_set_permissions(struct doca_mmap *mmap, uint32_t access_mask);
 
DOCA_STABLE
doca_error_t doca_mmap_set_user_data(struct doca_mmap *mmap, union doca_data user_data);
 
DOCA_STABLE
doca_error_t doca_mmap_cap_is_export_pci_supported(const struct doca_devinfo *devinfo, uint8_t *mmap_export);
 
DOCA_STABLE
doca_error_t doca_mmap_cap_is_create_from_export_pci_supported(const struct doca_devinfo *devinfo,
                                   uint8_t *from_export);
 
DOCA_EXPERIMENTAL
doca_error_t doca_mmap_enable_thread_safety(struct doca_mmap *mmap);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_MMAP_H_ */