doca_devemu_vfs_io.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_DEVEMU_VFS_IO_H_
#define DOCA_DEVEMU_VFS_IO_H_
 
#include <stdint.h>
 
#include <doca_buf.h>
#include <doca_error.h>
#include <doca_dev.h>
#include <doca_devemu_pci.h>
#include <doca_devemu_virtio.h>
#include <doca_devemu_virtio_io.h>
#include <doca_devemu_vfs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************************************************************************************************************
 * DOCA devemu Virtio FS IO context API
 *********************************************************************************************************************/
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_io_create(struct doca_devemu_vfs_dev *vfs_dev,
        struct doca_pe *progress_engine, struct doca_devemu_vfs_io **io);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_io_destroy(struct doca_devemu_vfs_io *io);
 
DOCA_EXPERIMENTAL
struct doca_ctx *doca_devemu_vfs_io_as_ctx(struct doca_devemu_vfs_io *io);
 
DOCA_EXPERIMENTAL
struct doca_devemu_virtio_io *doca_devemu_vfs_io_as_virtio_io(struct doca_devemu_vfs_io *io);
 
/*********************************************************************************************************************
 * DOCA devemu Virtio FS IO context events API
 *********************************************************************************************************************/
 
typedef void (*doca_devemu_vfs_io_event_vfs_req_notice_handler_cb_t)(struct doca_devemu_vfs_req *req,
        void *req_user_data, union doca_data event_user_data);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_io_event_vfs_req_notice_register(struct doca_devemu_vfs_io *io,
        doca_devemu_vfs_io_event_vfs_req_notice_handler_cb_t handler,
        union doca_data user_data);
 
typedef void (*doca_devemu_vfs_io_event_vfs_notification_req_notice_handler_cb_t)(
        struct doca_devemu_vfs_notification_req *req,
        void *req_user_data, union doca_data event_user_data);
 
DOCA_EXPERIMENTAL
doca_error_t doca_devemu_vfs_io_event_vfs_notification_req_notice_register(struct doca_devemu_vfs_io *io,
        doca_devemu_vfs_io_event_vfs_notification_req_notice_handler_cb_t handler,
        union doca_data user_data);
 
/*********************************************************************************************************************
 * DOCA devemu Virtio FS request API
 *********************************************************************************************************************/
 
DOCA_EXPERIMENTAL
void doca_devemu_vfs_req_complete(struct doca_devemu_vfs_req *req, uint32_t len);
 
DOCA_EXPERIMENTAL
struct doca_buf *doca_devemu_vfs_req_get_datain(struct doca_devemu_vfs_req *req);
 
DOCA_EXPERIMENTAL
struct doca_buf *doca_devemu_vfs_req_get_dataout(struct doca_devemu_vfs_req *req);
 
DOCA_EXPERIMENTAL
uint32_t doca_devemu_vfs_req_get_datain_list_len(struct doca_devemu_vfs_req *req);
 
DOCA_EXPERIMENTAL
uint32_t doca_devemu_vfs_req_get_datain_data_len(struct doca_devemu_vfs_req *req);
 
DOCA_EXPERIMENTAL
uint32_t doca_devemu_vfs_req_get_dataout_list_len(struct doca_devemu_vfs_req *req);
 
DOCA_EXPERIMENTAL
uint32_t doca_devemu_vfs_req_get_dataout_data_len(struct doca_devemu_vfs_req *req);
 
DOCA_EXPERIMENTAL
uint64_t doca_devemu_vfs_req_get_id(struct doca_devemu_vfs_req *req);
 
DOCA_EXPERIMENTAL
uint16_t doca_devemu_vfs_req_get_src_domain_id(struct doca_devemu_vfs_req *req);
 
/*********************************************************************************************************************
 * DOCA devemu Virtio FS notification_request API
 *********************************************************************************************************************/
 
DOCA_EXPERIMENTAL
void doca_devemu_vfs_notification_req_complete(struct doca_devemu_vfs_notification_req *req, uint32_t len);
 
DOCA_EXPERIMENTAL
struct doca_buf *doca_devemu_vfs_notification_req_get_dataout(struct doca_devemu_vfs_notification_req *req);
 
DOCA_EXPERIMENTAL
uint32_t doca_devemu_vfs_notification_req_get_dataout_list_len(struct doca_devemu_vfs_notification_req *req);
 
DOCA_EXPERIMENTAL
uint32_t doca_devemu_vfs_notification_req_get_dataout_data_len(struct doca_devemu_vfs_notification_req *req);
 
DOCA_EXPERIMENTAL
uint64_t doca_devemu_vfs_notification_req_get_id(struct doca_devemu_vfs_notification_req *req);
 
DOCA_EXPERIMENTAL
uint16_t doca_devemu_vfs_notification_req_get_src_domain_id(struct doca_devemu_vfs_notification_req *req);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_DEVEMU_VFS_IO_H_ */