doca_devemu_vfs.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_DEVEMU_VFS_H_
#define DOCA_DEVEMU_VFS_H_
 
#include <stdint.h>
 
#include <linux/fuse.h>
 
#include <doca_buf.h>
#include <doca_error.h>
#include <doca_dev.h>
#include <doca_devemu_pci.h>
#include <doca_devemu_virtio.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct doca_devemu_vfs_cfg;
 
struct doca_devemu_vfs_dev;
 
struct doca_devemu_vfs_type;
 
struct doca_devemu_vfs_io;
 
struct doca_devemu_vfs_req;
 
struct doca_devemu_vfs_notification_req;
 
#define DOCA_VFS_TAG_SIZE 21
 
/*********************************************************************************************************************
 * DOCA devemu Virtio FS configuration API
 *********************************************************************************************************************/
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_init(struct doca_devemu_vfs_cfg *cfg);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_teardown(void);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_cfg_create(struct doca_devemu_vfs_cfg **cfg);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_cfg_destroy(struct doca_devemu_vfs_cfg *cfg);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_cfg_get_vfs_req_user_data_size(const struct doca_devemu_vfs_cfg *cfg,
        uint32_t *req_user_data_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_cfg_set_vfs_req_user_data_size(struct doca_devemu_vfs_cfg *cfg,
        uint32_t req_user_data_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_cfg_get_notification_req_user_data_size(const struct doca_devemu_vfs_cfg *cfg,
        uint32_t *req_user_data_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_cfg_set_notification_req_user_data_size(struct doca_devemu_vfs_cfg *cfg,
        uint32_t req_user_data_size);
 
/*********************************************************************************************************************
 * DOCA devemu Virtio FS device API
 *********************************************************************************************************************/
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_dev_create(struct doca_devemu_vfs_type *vfs_type, struct doca_dev_rep *dev_rep,
        struct doca_pe *progress_engine, struct doca_devemu_vfs_dev **vfs_dev);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_dev_destroy(struct doca_devemu_vfs_dev *vfs_dev);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_dev_get_tag(const struct doca_devemu_vfs_dev *vfs_dev, char tag[DOCA_VFS_TAG_SIZE]);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_dev_set_tag(struct doca_devemu_vfs_dev *vfs_dev, const char tag[DOCA_VFS_TAG_SIZE]);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_dev_get_num_request_queues(const struct doca_devemu_vfs_dev *vfs_dev, uint32_t *num_request_queues);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_dev_set_num_request_queues(struct doca_devemu_vfs_dev *vfs_dev, uint32_t num_request_queues);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_dev_get_notify_buf_size(const struct doca_devemu_vfs_dev *vfs_dev, uint32_t *notify_buf_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_dev_set_notify_buf_size(struct doca_devemu_vfs_dev *vfs_dev, uint32_t notify_buf_size);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_dev_get_req_src_domain_id_range(const struct doca_devemu_vfs_dev *vfs_dev,
        uint16_t *min_src_domain_id, uint16_t *max_src_domain_id);
 
DOCA_EXPERIMENTAL
struct doca_ctx *doca_devemu_vfs_dev_as_ctx(struct doca_devemu_vfs_dev *vfs_dev);
 
DOCA_EXPERIMENTAL
struct doca_devemu_virtio_dev *doca_devemu_vfs_dev_as_virtio_dev(struct doca_devemu_vfs_dev *vfs_dev);
 
DOCA_EXPERIMENTAL
struct doca_devemu_pci_dev *doca_devemu_vfs_dev_as_pci_dev(struct doca_devemu_vfs_dev *vfs_dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_DEVEMU_VFS_H_ */