10df750e9SMarc-André Lureau /* 20df750e9SMarc-André Lureau * Vhost User library 30df750e9SMarc-André Lureau * 40df750e9SMarc-André Lureau * Copyright (c) 2016 Red Hat, Inc. 50df750e9SMarc-André Lureau * 60df750e9SMarc-André Lureau * Authors: 70df750e9SMarc-André Lureau * Victor Kaplansky <victork@redhat.com> 80df750e9SMarc-André Lureau * Marc-André Lureau <mlureau@redhat.com> 90df750e9SMarc-André Lureau * 100df750e9SMarc-André Lureau * This work is licensed under the terms of the GNU GPL, version 2 or 110df750e9SMarc-André Lureau * later. See the COPYING file in the top-level directory. 120df750e9SMarc-André Lureau */ 130df750e9SMarc-André Lureau 140df750e9SMarc-André Lureau #ifndef LIBVHOST_USER_H 150df750e9SMarc-André Lureau #define LIBVHOST_USER_H 160df750e9SMarc-André Lureau 170df750e9SMarc-André Lureau #include <stdint.h> 180df750e9SMarc-André Lureau #include <stdbool.h> 190df750e9SMarc-André Lureau #include <stddef.h> 2029ce0d35SJiaxun Yang #include <poll.h> 210df750e9SMarc-André Lureau #include <linux/vhost.h> 220df750e9SMarc-André Lureau #include <pthread.h> 230df750e9SMarc-André Lureau #include "standard-headers/linux/virtio_ring.h" 240df750e9SMarc-André Lureau 250df750e9SMarc-André Lureau /* Based on qemu/hw/virtio/vhost-user.c */ 260df750e9SMarc-André Lureau #define VHOST_USER_F_PROTOCOL_FEATURES 30 270df750e9SMarc-André Lureau #define VHOST_LOG_PAGE 4096 280df750e9SMarc-André Lureau 290df750e9SMarc-André Lureau #define VIRTQUEUE_MAX_SIZE 1024 300df750e9SMarc-André Lureau 310df750e9SMarc-André Lureau #define VHOST_MEMORY_BASELINE_NREGIONS 8 320df750e9SMarc-André Lureau 330df750e9SMarc-André Lureau /* 340fa6344cSDavid Hildenbrand * vhost in the kernel usually supports 509 mem slots. 509 used to be the 350fa6344cSDavid Hildenbrand * KVM limit, it supported 512, but 3 were used for internal purposes. This 360fa6344cSDavid Hildenbrand * limit is sufficient to support many DIMMs and virtio-mem in 370fa6344cSDavid Hildenbrand * "dynamic-memslots" mode. 380df750e9SMarc-André Lureau */ 390fa6344cSDavid Hildenbrand #define VHOST_USER_MAX_RAM_SLOTS 509 400df750e9SMarc-André Lureau 410df750e9SMarc-André Lureau #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64) 420df750e9SMarc-André Lureau 430df750e9SMarc-André Lureau typedef enum VhostSetConfigType { 44f8ed3648SManos Pitsidianakis VHOST_SET_CONFIG_TYPE_FRONTEND = 0, 450df750e9SMarc-André Lureau VHOST_SET_CONFIG_TYPE_MIGRATION = 1, 460df750e9SMarc-André Lureau } VhostSetConfigType; 470df750e9SMarc-André Lureau 480df750e9SMarc-André Lureau /* 490df750e9SMarc-André Lureau * Maximum size of virtio device config space 500df750e9SMarc-André Lureau */ 510df750e9SMarc-André Lureau #define VHOST_USER_MAX_CONFIG_SIZE 256 520df750e9SMarc-André Lureau 530df750e9SMarc-André Lureau enum VhostUserProtocolFeature { 540df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_MQ = 0, 550df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_LOG_SHMFD = 1, 560df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_RARP = 2, 570df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_REPLY_ACK = 3, 580df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_NET_MTU = 4, 59e608feedSMaxime Coquelin VHOST_USER_PROTOCOL_F_BACKEND_REQ = 5, 600df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_CROSS_ENDIAN = 6, 610df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_CRYPTO_SESSION = 7, 620df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_PAGEFAULT = 8, 630df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_CONFIG = 9, 64e608feedSMaxime Coquelin VHOST_USER_PROTOCOL_F_BACKEND_SEND_FD = 10, 650df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_HOST_NOTIFIER = 11, 660df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD = 12, 670df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS = 14, 680df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_CONFIGURE_MEM_SLOTS = 15, 69ce0f3b03SAlbert Esteve /* Feature 16 is reserved for VHOST_USER_PROTOCOL_F_STATUS. */ 70d4eb5038SHanna Czenczek /* Feature 17 reserved for VHOST_USER_PROTOCOL_F_XEN_MMAP. */ 71d4eb5038SHanna Czenczek VHOST_USER_PROTOCOL_F_SHARED_OBJECT = 18, 720df750e9SMarc-André Lureau VHOST_USER_PROTOCOL_F_MAX 730df750e9SMarc-André Lureau }; 740df750e9SMarc-André Lureau 750df750e9SMarc-André Lureau #define VHOST_USER_PROTOCOL_FEATURE_MASK ((1 << VHOST_USER_PROTOCOL_F_MAX) - 1) 760df750e9SMarc-André Lureau 770df750e9SMarc-André Lureau typedef enum VhostUserRequest { 780df750e9SMarc-André Lureau VHOST_USER_NONE = 0, 790df750e9SMarc-André Lureau VHOST_USER_GET_FEATURES = 1, 800df750e9SMarc-André Lureau VHOST_USER_SET_FEATURES = 2, 810df750e9SMarc-André Lureau VHOST_USER_SET_OWNER = 3, 820df750e9SMarc-André Lureau VHOST_USER_RESET_OWNER = 4, 830df750e9SMarc-André Lureau VHOST_USER_SET_MEM_TABLE = 5, 840df750e9SMarc-André Lureau VHOST_USER_SET_LOG_BASE = 6, 850df750e9SMarc-André Lureau VHOST_USER_SET_LOG_FD = 7, 860df750e9SMarc-André Lureau VHOST_USER_SET_VRING_NUM = 8, 870df750e9SMarc-André Lureau VHOST_USER_SET_VRING_ADDR = 9, 880df750e9SMarc-André Lureau VHOST_USER_SET_VRING_BASE = 10, 890df750e9SMarc-André Lureau VHOST_USER_GET_VRING_BASE = 11, 900df750e9SMarc-André Lureau VHOST_USER_SET_VRING_KICK = 12, 910df750e9SMarc-André Lureau VHOST_USER_SET_VRING_CALL = 13, 920df750e9SMarc-André Lureau VHOST_USER_SET_VRING_ERR = 14, 930df750e9SMarc-André Lureau VHOST_USER_GET_PROTOCOL_FEATURES = 15, 940df750e9SMarc-André Lureau VHOST_USER_SET_PROTOCOL_FEATURES = 16, 950df750e9SMarc-André Lureau VHOST_USER_GET_QUEUE_NUM = 17, 960df750e9SMarc-André Lureau VHOST_USER_SET_VRING_ENABLE = 18, 970df750e9SMarc-André Lureau VHOST_USER_SEND_RARP = 19, 980df750e9SMarc-André Lureau VHOST_USER_NET_SET_MTU = 20, 99e608feedSMaxime Coquelin VHOST_USER_SET_BACKEND_REQ_FD = 21, 1000df750e9SMarc-André Lureau VHOST_USER_IOTLB_MSG = 22, 1010df750e9SMarc-André Lureau VHOST_USER_SET_VRING_ENDIAN = 23, 1020df750e9SMarc-André Lureau VHOST_USER_GET_CONFIG = 24, 1030df750e9SMarc-André Lureau VHOST_USER_SET_CONFIG = 25, 1040df750e9SMarc-André Lureau VHOST_USER_CREATE_CRYPTO_SESSION = 26, 1050df750e9SMarc-André Lureau VHOST_USER_CLOSE_CRYPTO_SESSION = 27, 1060df750e9SMarc-André Lureau VHOST_USER_POSTCOPY_ADVISE = 28, 1070df750e9SMarc-André Lureau VHOST_USER_POSTCOPY_LISTEN = 29, 1080df750e9SMarc-André Lureau VHOST_USER_POSTCOPY_END = 30, 1090df750e9SMarc-André Lureau VHOST_USER_GET_INFLIGHT_FD = 31, 1100df750e9SMarc-André Lureau VHOST_USER_SET_INFLIGHT_FD = 32, 1110df750e9SMarc-André Lureau VHOST_USER_GPU_SET_SOCKET = 33, 1120df750e9SMarc-André Lureau VHOST_USER_VRING_KICK = 35, 1130df750e9SMarc-André Lureau VHOST_USER_GET_MAX_MEM_SLOTS = 36, 1140df750e9SMarc-André Lureau VHOST_USER_ADD_MEM_REG = 37, 1150df750e9SMarc-André Lureau VHOST_USER_REM_MEM_REG = 38, 116ce0f3b03SAlbert Esteve VHOST_USER_GET_SHARED_OBJECT = 41, 1170df750e9SMarc-André Lureau VHOST_USER_MAX 1180df750e9SMarc-André Lureau } VhostUserRequest; 1190df750e9SMarc-André Lureau 120f8ed3648SManos Pitsidianakis typedef enum VhostUserBackendRequest { 121e608feedSMaxime Coquelin VHOST_USER_BACKEND_NONE = 0, 122e608feedSMaxime Coquelin VHOST_USER_BACKEND_IOTLB_MSG = 1, 123e608feedSMaxime Coquelin VHOST_USER_BACKEND_CONFIG_CHANGE_MSG = 2, 124e608feedSMaxime Coquelin VHOST_USER_BACKEND_VRING_HOST_NOTIFIER_MSG = 3, 125e608feedSMaxime Coquelin VHOST_USER_BACKEND_VRING_CALL = 4, 126e608feedSMaxime Coquelin VHOST_USER_BACKEND_VRING_ERR = 5, 127ce0f3b03SAlbert Esteve VHOST_USER_BACKEND_SHARED_OBJECT_ADD = 6, 128ce0f3b03SAlbert Esteve VHOST_USER_BACKEND_SHARED_OBJECT_REMOVE = 7, 129ce0f3b03SAlbert Esteve VHOST_USER_BACKEND_SHARED_OBJECT_LOOKUP = 8, 130e608feedSMaxime Coquelin VHOST_USER_BACKEND_MAX 131f8ed3648SManos Pitsidianakis } VhostUserBackendRequest; 1320df750e9SMarc-André Lureau 1330df750e9SMarc-André Lureau typedef struct VhostUserMemoryRegion { 1340df750e9SMarc-André Lureau uint64_t guest_phys_addr; 1350df750e9SMarc-André Lureau uint64_t memory_size; 1360df750e9SMarc-André Lureau uint64_t userspace_addr; 1370df750e9SMarc-André Lureau uint64_t mmap_offset; 1380df750e9SMarc-André Lureau } VhostUserMemoryRegion; 1390df750e9SMarc-André Lureau 140316ee111SRaphael Norwitz #define VHOST_USER_MEM_REG_SIZE (sizeof(VhostUserMemoryRegion)) 141316ee111SRaphael Norwitz 1420df750e9SMarc-André Lureau typedef struct VhostUserMemory { 1430df750e9SMarc-André Lureau uint32_t nregions; 1440df750e9SMarc-André Lureau uint32_t padding; 1450df750e9SMarc-André Lureau VhostUserMemoryRegion regions[VHOST_MEMORY_BASELINE_NREGIONS]; 1460df750e9SMarc-André Lureau } VhostUserMemory; 1470df750e9SMarc-André Lureau 1480df750e9SMarc-André Lureau typedef struct VhostUserMemRegMsg { 1490df750e9SMarc-André Lureau uint64_t padding; 1500df750e9SMarc-André Lureau VhostUserMemoryRegion region; 1510df750e9SMarc-André Lureau } VhostUserMemRegMsg; 1520df750e9SMarc-André Lureau 1530df750e9SMarc-André Lureau typedef struct VhostUserLog { 1540df750e9SMarc-André Lureau uint64_t mmap_size; 1550df750e9SMarc-André Lureau uint64_t mmap_offset; 1560df750e9SMarc-André Lureau } VhostUserLog; 1570df750e9SMarc-André Lureau 1580df750e9SMarc-André Lureau typedef struct VhostUserConfig { 1590df750e9SMarc-André Lureau uint32_t offset; 1600df750e9SMarc-André Lureau uint32_t size; 1610df750e9SMarc-André Lureau uint32_t flags; 1620df750e9SMarc-André Lureau uint8_t region[VHOST_USER_MAX_CONFIG_SIZE]; 1630df750e9SMarc-André Lureau } VhostUserConfig; 1640df750e9SMarc-André Lureau 1650df750e9SMarc-André Lureau static VhostUserConfig c __attribute__ ((unused)); 1660df750e9SMarc-André Lureau #define VHOST_USER_CONFIG_HDR_SIZE (sizeof(c.offset) \ 1670df750e9SMarc-André Lureau + sizeof(c.size) \ 1680df750e9SMarc-André Lureau + sizeof(c.flags)) 1690df750e9SMarc-André Lureau 1700df750e9SMarc-André Lureau typedef struct VhostUserVringArea { 1710df750e9SMarc-André Lureau uint64_t u64; 1720df750e9SMarc-André Lureau uint64_t size; 1730df750e9SMarc-André Lureau uint64_t offset; 1740df750e9SMarc-André Lureau } VhostUserVringArea; 1750df750e9SMarc-André Lureau 1760df750e9SMarc-André Lureau typedef struct VhostUserInflight { 1770df750e9SMarc-André Lureau uint64_t mmap_size; 1780df750e9SMarc-André Lureau uint64_t mmap_offset; 1790df750e9SMarc-André Lureau uint16_t num_queues; 1800df750e9SMarc-André Lureau uint16_t queue_size; 1810df750e9SMarc-André Lureau } VhostUserInflight; 1820df750e9SMarc-André Lureau 183ce0f3b03SAlbert Esteve #define UUID_LEN 16 184ce0f3b03SAlbert Esteve 185ce0f3b03SAlbert Esteve typedef struct VhostUserShared { 186ce0f3b03SAlbert Esteve unsigned char uuid[UUID_LEN]; 187ce0f3b03SAlbert Esteve } VhostUserShared; 188ce0f3b03SAlbert Esteve 1890df750e9SMarc-André Lureau #if defined(_WIN32) && (defined(__x86_64__) || defined(__i386__)) 1900df750e9SMarc-André Lureau # define VU_PACKED __attribute__((gcc_struct, packed)) 1910df750e9SMarc-André Lureau #else 1920df750e9SMarc-André Lureau # define VU_PACKED __attribute__((packed)) 1930df750e9SMarc-André Lureau #endif 1940df750e9SMarc-André Lureau 1950df750e9SMarc-André Lureau typedef struct VhostUserMsg { 1960df750e9SMarc-André Lureau int request; 1970df750e9SMarc-André Lureau 1980df750e9SMarc-André Lureau #define VHOST_USER_VERSION_MASK (0x3) 1990df750e9SMarc-André Lureau #define VHOST_USER_REPLY_MASK (0x1 << 2) 2000df750e9SMarc-André Lureau #define VHOST_USER_NEED_REPLY_MASK (0x1 << 3) 2010df750e9SMarc-André Lureau uint32_t flags; 2020df750e9SMarc-André Lureau uint32_t size; /* the following payload size */ 2030df750e9SMarc-André Lureau 2040df750e9SMarc-André Lureau union { 2050df750e9SMarc-André Lureau #define VHOST_USER_VRING_IDX_MASK (0xff) 2060df750e9SMarc-André Lureau #define VHOST_USER_VRING_NOFD_MASK (0x1 << 8) 2070df750e9SMarc-André Lureau uint64_t u64; 2080df750e9SMarc-André Lureau struct vhost_vring_state state; 2090df750e9SMarc-André Lureau struct vhost_vring_addr addr; 2100df750e9SMarc-André Lureau VhostUserMemory memory; 2110df750e9SMarc-André Lureau VhostUserMemRegMsg memreg; 2120df750e9SMarc-André Lureau VhostUserLog log; 2130df750e9SMarc-André Lureau VhostUserConfig config; 2140df750e9SMarc-André Lureau VhostUserVringArea area; 2150df750e9SMarc-André Lureau VhostUserInflight inflight; 216ce0f3b03SAlbert Esteve VhostUserShared object; 2170df750e9SMarc-André Lureau } payload; 2180df750e9SMarc-André Lureau 2190df750e9SMarc-André Lureau int fds[VHOST_MEMORY_BASELINE_NREGIONS]; 2200df750e9SMarc-André Lureau int fd_num; 2210df750e9SMarc-André Lureau uint8_t *data; 2220df750e9SMarc-André Lureau } VU_PACKED VhostUserMsg; 2230df750e9SMarc-André Lureau 2240df750e9SMarc-André Lureau typedef struct VuDevRegion { 2250df750e9SMarc-André Lureau /* Guest Physical address. */ 2260df750e9SMarc-André Lureau uint64_t gpa; 2270df750e9SMarc-André Lureau /* Memory region size. */ 2280df750e9SMarc-André Lureau uint64_t size; 2290df750e9SMarc-André Lureau /* QEMU virtual address (userspace). */ 2300df750e9SMarc-André Lureau uint64_t qva; 2310df750e9SMarc-André Lureau /* Starting offset in our mmaped space. */ 2320df750e9SMarc-André Lureau uint64_t mmap_offset; 2330df750e9SMarc-André Lureau /* Start address of mmaped space. */ 2340df750e9SMarc-André Lureau uint64_t mmap_addr; 2350df750e9SMarc-André Lureau } VuDevRegion; 2360df750e9SMarc-André Lureau 2370df750e9SMarc-André Lureau typedef struct VuDev VuDev; 2380df750e9SMarc-André Lureau 2390df750e9SMarc-André Lureau typedef uint64_t (*vu_get_features_cb) (VuDev *dev); 2400df750e9SMarc-André Lureau typedef void (*vu_set_features_cb) (VuDev *dev, uint64_t features); 2410df750e9SMarc-André Lureau typedef int (*vu_process_msg_cb) (VuDev *dev, VhostUserMsg *vmsg, 2420df750e9SMarc-André Lureau int *do_reply); 2430df750e9SMarc-André Lureau typedef bool (*vu_read_msg_cb) (VuDev *dev, int sock, VhostUserMsg *vmsg); 2440df750e9SMarc-André Lureau typedef void (*vu_queue_set_started_cb) (VuDev *dev, int qidx, bool started); 2450df750e9SMarc-André Lureau typedef bool (*vu_queue_is_processed_in_order_cb) (VuDev *dev, int qidx); 2460df750e9SMarc-André Lureau typedef int (*vu_get_config_cb) (VuDev *dev, uint8_t *config, uint32_t len); 2470df750e9SMarc-André Lureau typedef int (*vu_set_config_cb) (VuDev *dev, const uint8_t *data, 2480df750e9SMarc-André Lureau uint32_t offset, uint32_t size, 2490df750e9SMarc-André Lureau uint32_t flags); 250ce0f3b03SAlbert Esteve typedef int (*vu_get_shared_object_cb) (VuDev *dev, const unsigned char *uuid); 2510df750e9SMarc-André Lureau 2520df750e9SMarc-André Lureau typedef struct VuDevIface { 2530df750e9SMarc-André Lureau /* called by VHOST_USER_GET_FEATURES to get the features bitmask */ 2540df750e9SMarc-André Lureau vu_get_features_cb get_features; 2550df750e9SMarc-André Lureau /* enable vhost implementation features */ 2560df750e9SMarc-André Lureau vu_set_features_cb set_features; 2570df750e9SMarc-André Lureau /* get the protocol feature bitmask from the underlying vhost 2580df750e9SMarc-André Lureau * implementation */ 2590df750e9SMarc-André Lureau vu_get_features_cb get_protocol_features; 2600df750e9SMarc-André Lureau /* enable protocol features in the underlying vhost implementation. */ 2610df750e9SMarc-André Lureau vu_set_features_cb set_protocol_features; 2620df750e9SMarc-André Lureau /* process_msg is called for each vhost-user message received */ 2630df750e9SMarc-André Lureau /* skip libvhost-user processing if return value != 0 */ 2640df750e9SMarc-André Lureau vu_process_msg_cb process_msg; 2650df750e9SMarc-André Lureau /* tells when queues can be processed */ 2660df750e9SMarc-André Lureau vu_queue_set_started_cb queue_set_started; 2670df750e9SMarc-André Lureau /* 2680df750e9SMarc-André Lureau * If the queue is processed in order, in which case it will be 2690df750e9SMarc-André Lureau * resumed to vring.used->idx. This can help to support resuming 2700df750e9SMarc-André Lureau * on unmanaged exit/crash. 2710df750e9SMarc-André Lureau */ 2720df750e9SMarc-André Lureau vu_queue_is_processed_in_order_cb queue_is_processed_in_order; 2730df750e9SMarc-André Lureau /* get the config space of the device */ 2740df750e9SMarc-André Lureau vu_get_config_cb get_config; 2750df750e9SMarc-André Lureau /* set the config space of the device */ 2760df750e9SMarc-André Lureau vu_set_config_cb set_config; 277ce0f3b03SAlbert Esteve /* get virtio shared object from the underlying vhost implementation. */ 278ce0f3b03SAlbert Esteve vu_get_shared_object_cb get_shared_object; 2790df750e9SMarc-André Lureau } VuDevIface; 2800df750e9SMarc-André Lureau 2810df750e9SMarc-André Lureau typedef void (*vu_queue_handler_cb) (VuDev *dev, int qidx); 2820df750e9SMarc-André Lureau 2830df750e9SMarc-André Lureau typedef struct VuRing { 2840df750e9SMarc-André Lureau unsigned int num; 2850df750e9SMarc-André Lureau struct vring_desc *desc; 2860df750e9SMarc-André Lureau struct vring_avail *avail; 2870df750e9SMarc-André Lureau struct vring_used *used; 2880df750e9SMarc-André Lureau uint64_t log_guest_addr; 2890df750e9SMarc-André Lureau uint32_t flags; 2900df750e9SMarc-André Lureau } VuRing; 2910df750e9SMarc-André Lureau 2920df750e9SMarc-André Lureau typedef struct VuDescStateSplit { 2930df750e9SMarc-André Lureau /* Indicate whether this descriptor is inflight or not. 2940df750e9SMarc-André Lureau * Only available for head-descriptor. */ 2950df750e9SMarc-André Lureau uint8_t inflight; 2960df750e9SMarc-André Lureau 2970df750e9SMarc-André Lureau /* Padding */ 2980df750e9SMarc-André Lureau uint8_t padding[5]; 2990df750e9SMarc-André Lureau 3000df750e9SMarc-André Lureau /* Maintain a list for the last batch of used descriptors. 3010df750e9SMarc-André Lureau * Only available when batching is used for submitting */ 3020df750e9SMarc-André Lureau uint16_t next; 3030df750e9SMarc-André Lureau 3040df750e9SMarc-André Lureau /* Used to preserve the order of fetching available descriptors. 3050df750e9SMarc-André Lureau * Only available for head-descriptor. */ 3060df750e9SMarc-André Lureau uint64_t counter; 3070df750e9SMarc-André Lureau } VuDescStateSplit; 3080df750e9SMarc-André Lureau 3090df750e9SMarc-André Lureau typedef struct VuVirtqInflight { 3100df750e9SMarc-André Lureau /* The feature flags of this region. Now it's initialized to 0. */ 3110df750e9SMarc-André Lureau uint64_t features; 3120df750e9SMarc-André Lureau 3130df750e9SMarc-André Lureau /* The version of this region. It's 1 currently. 3140df750e9SMarc-André Lureau * Zero value indicates a vm reset happened. */ 3150df750e9SMarc-André Lureau uint16_t version; 3160df750e9SMarc-André Lureau 317f8ed3648SManos Pitsidianakis /* 318f8ed3648SManos Pitsidianakis * The size of VuDescStateSplit array. It's equal to the virtqueue size. 319f8ed3648SManos Pitsidianakis * Backend could get it from queue size field of VhostUserInflight. 320f8ed3648SManos Pitsidianakis */ 3210df750e9SMarc-André Lureau uint16_t desc_num; 3220df750e9SMarc-André Lureau 3230df750e9SMarc-André Lureau /* The head of list that track the last batch of used descriptors. */ 3240df750e9SMarc-André Lureau uint16_t last_batch_head; 3250df750e9SMarc-André Lureau 3260df750e9SMarc-André Lureau /* Storing the idx value of used ring */ 3270df750e9SMarc-André Lureau uint16_t used_idx; 3280df750e9SMarc-André Lureau 3290df750e9SMarc-André Lureau /* Used to track the state of each descriptor in descriptor table */ 3300df750e9SMarc-André Lureau VuDescStateSplit desc[]; 3310df750e9SMarc-André Lureau } VuVirtqInflight; 3320df750e9SMarc-André Lureau 3330df750e9SMarc-André Lureau typedef struct VuVirtqInflightDesc { 3340df750e9SMarc-André Lureau uint16_t index; 3350df750e9SMarc-André Lureau uint64_t counter; 3360df750e9SMarc-André Lureau } VuVirtqInflightDesc; 3370df750e9SMarc-André Lureau 3380df750e9SMarc-André Lureau typedef struct VuVirtq { 3390df750e9SMarc-André Lureau VuRing vring; 3400df750e9SMarc-André Lureau 3410df750e9SMarc-André Lureau VuVirtqInflight *inflight; 3420df750e9SMarc-André Lureau 3430df750e9SMarc-André Lureau VuVirtqInflightDesc *resubmit_list; 3440df750e9SMarc-André Lureau 3450df750e9SMarc-André Lureau uint16_t resubmit_num; 3460df750e9SMarc-André Lureau 3470df750e9SMarc-André Lureau uint64_t counter; 3480df750e9SMarc-André Lureau 3490df750e9SMarc-André Lureau /* Next head to pop */ 3500df750e9SMarc-André Lureau uint16_t last_avail_idx; 3510df750e9SMarc-André Lureau 3520df750e9SMarc-André Lureau /* Last avail_idx read from VQ. */ 3530df750e9SMarc-André Lureau uint16_t shadow_avail_idx; 3540df750e9SMarc-André Lureau 3550df750e9SMarc-André Lureau uint16_t used_idx; 3560df750e9SMarc-André Lureau 3570df750e9SMarc-André Lureau /* Last used index value we have signalled on */ 3580df750e9SMarc-André Lureau uint16_t signalled_used; 3590df750e9SMarc-André Lureau 3600df750e9SMarc-André Lureau /* Last used index value we have signalled on */ 3610df750e9SMarc-André Lureau bool signalled_used_valid; 3620df750e9SMarc-André Lureau 3630df750e9SMarc-André Lureau /* Notification enabled? */ 3640df750e9SMarc-André Lureau bool notification; 3650df750e9SMarc-André Lureau 366e7ee4fe2SMarcel Holtmann unsigned int inuse; 3670df750e9SMarc-André Lureau 3680df750e9SMarc-André Lureau vu_queue_handler_cb handler; 3690df750e9SMarc-André Lureau 3700df750e9SMarc-André Lureau int call_fd; 3710df750e9SMarc-André Lureau int kick_fd; 3720df750e9SMarc-André Lureau int err_fd; 3730df750e9SMarc-André Lureau unsigned int enable; 3740df750e9SMarc-André Lureau bool started; 3750df750e9SMarc-André Lureau 3760df750e9SMarc-André Lureau /* Guest addresses of our ring */ 3770df750e9SMarc-André Lureau struct vhost_vring_addr vra; 3780df750e9SMarc-André Lureau } VuVirtq; 3790df750e9SMarc-André Lureau 3800df750e9SMarc-André Lureau enum VuWatchCondtion { 3810df750e9SMarc-André Lureau VU_WATCH_IN = POLLIN, 3820df750e9SMarc-André Lureau VU_WATCH_OUT = POLLOUT, 3830df750e9SMarc-André Lureau VU_WATCH_PRI = POLLPRI, 3840df750e9SMarc-André Lureau VU_WATCH_ERR = POLLERR, 3850df750e9SMarc-André Lureau VU_WATCH_HUP = POLLHUP, 3860df750e9SMarc-André Lureau }; 3870df750e9SMarc-André Lureau 3880df750e9SMarc-André Lureau typedef void (*vu_panic_cb) (VuDev *dev, const char *err); 3890df750e9SMarc-André Lureau typedef void (*vu_watch_cb) (VuDev *dev, int condition, void *data); 3900df750e9SMarc-André Lureau typedef void (*vu_set_watch_cb) (VuDev *dev, int fd, int condition, 3910df750e9SMarc-André Lureau vu_watch_cb cb, void *data); 3920df750e9SMarc-André Lureau typedef void (*vu_remove_watch_cb) (VuDev *dev, int fd); 3930df750e9SMarc-André Lureau 3940df750e9SMarc-André Lureau typedef struct VuDevInflightInfo { 3950df750e9SMarc-André Lureau int fd; 3960df750e9SMarc-André Lureau void *addr; 3970df750e9SMarc-André Lureau uint64_t size; 3980df750e9SMarc-André Lureau } VuDevInflightInfo; 3990df750e9SMarc-André Lureau 4000df750e9SMarc-André Lureau struct VuDev { 4010df750e9SMarc-André Lureau int sock; 4020df750e9SMarc-André Lureau uint32_t nregions; 403d884e272SDavid Hildenbrand VuDevRegion *regions; 4040df750e9SMarc-André Lureau VuVirtq *vq; 4050df750e9SMarc-André Lureau VuDevInflightInfo inflight_info; 4060df750e9SMarc-André Lureau int log_call_fd; 407f8ed3648SManos Pitsidianakis /* Must be held while using backend_fd */ 408f8ed3648SManos Pitsidianakis pthread_mutex_t backend_mutex; 409f8ed3648SManos Pitsidianakis int backend_fd; 4100df750e9SMarc-André Lureau uint64_t log_size; 4110df750e9SMarc-André Lureau uint8_t *log_table; 4120df750e9SMarc-André Lureau uint64_t features; 4130df750e9SMarc-André Lureau uint64_t protocol_features; 4140df750e9SMarc-André Lureau bool broken; 4150df750e9SMarc-André Lureau uint16_t max_queues; 4160df750e9SMarc-André Lureau 4170df750e9SMarc-André Lureau /* 4180df750e9SMarc-André Lureau * @read_msg: custom method to read vhost-user message 4190df750e9SMarc-André Lureau * 4200df750e9SMarc-André Lureau * Read data from vhost_user socket fd and fill up 4210df750e9SMarc-André Lureau * the passed VhostUserMsg *vmsg struct. 4220df750e9SMarc-André Lureau * 4230df750e9SMarc-André Lureau * If reading fails, it should close the received set of file 4240df750e9SMarc-André Lureau * descriptors as socket message's auxiliary data. 4250df750e9SMarc-André Lureau * 4260df750e9SMarc-André Lureau * For the details, please refer to vu_message_read in libvhost-user.c 4270df750e9SMarc-André Lureau * which will be used by default if not custom method is provided when 4280df750e9SMarc-André Lureau * calling vu_init 4290df750e9SMarc-André Lureau * 4300df750e9SMarc-André Lureau * Returns: true if vhost-user message successfully received, 4310df750e9SMarc-André Lureau * otherwise return false. 4320df750e9SMarc-André Lureau * 4330df750e9SMarc-André Lureau */ 4340df750e9SMarc-André Lureau vu_read_msg_cb read_msg; 4350df750e9SMarc-André Lureau 4360df750e9SMarc-André Lureau /* 4370df750e9SMarc-André Lureau * @set_watch: add or update the given fd to the watch set, 4380df750e9SMarc-André Lureau * call cb when condition is met. 4390df750e9SMarc-André Lureau */ 4400df750e9SMarc-André Lureau vu_set_watch_cb set_watch; 4410df750e9SMarc-André Lureau 4420df750e9SMarc-André Lureau /* @remove_watch: remove the given fd from the watch set */ 4430df750e9SMarc-André Lureau vu_remove_watch_cb remove_watch; 4440df750e9SMarc-André Lureau 4450df750e9SMarc-André Lureau /* 4460df750e9SMarc-André Lureau * @panic: encountered an unrecoverable error, you may try to re-initialize 4470df750e9SMarc-André Lureau */ 4480df750e9SMarc-André Lureau vu_panic_cb panic; 4490df750e9SMarc-André Lureau const VuDevIface *iface; 4500df750e9SMarc-André Lureau 4510df750e9SMarc-André Lureau /* Postcopy data */ 4520df750e9SMarc-André Lureau int postcopy_ufd; 4530df750e9SMarc-André Lureau bool postcopy_listening; 4540df750e9SMarc-André Lureau }; 4550df750e9SMarc-André Lureau 4560df750e9SMarc-André Lureau typedef struct VuVirtqElement { 4570df750e9SMarc-André Lureau unsigned int index; 4580df750e9SMarc-André Lureau unsigned int out_num; 4590df750e9SMarc-André Lureau unsigned int in_num; 4600df750e9SMarc-André Lureau struct iovec *in_sg; 4610df750e9SMarc-André Lureau struct iovec *out_sg; 4620df750e9SMarc-André Lureau } VuVirtqElement; 4630df750e9SMarc-André Lureau 4640df750e9SMarc-André Lureau /** 4650df750e9SMarc-André Lureau * vu_init: 4660df750e9SMarc-André Lureau * @dev: a VuDev context 4670df750e9SMarc-André Lureau * @max_queues: maximum number of virtqueues 468f8ed3648SManos Pitsidianakis * @socket: the socket connected to vhost-user frontend 4690df750e9SMarc-André Lureau * @panic: a panic callback 4700df750e9SMarc-André Lureau * @set_watch: a set_watch callback 4710df750e9SMarc-André Lureau * @remove_watch: a remove_watch callback 4720df750e9SMarc-André Lureau * @iface: a VuDevIface structure with vhost-user device callbacks 4730df750e9SMarc-André Lureau * 4740df750e9SMarc-André Lureau * Initializes a VuDev vhost-user context. 4750df750e9SMarc-André Lureau * 4760df750e9SMarc-André Lureau * Returns: true on success, false on failure. 4770df750e9SMarc-André Lureau **/ 4780df750e9SMarc-André Lureau bool vu_init(VuDev *dev, 4790df750e9SMarc-André Lureau uint16_t max_queues, 4800df750e9SMarc-André Lureau int socket, 4810df750e9SMarc-André Lureau vu_panic_cb panic, 4820df750e9SMarc-André Lureau vu_read_msg_cb read_msg, 4830df750e9SMarc-André Lureau vu_set_watch_cb set_watch, 4840df750e9SMarc-André Lureau vu_remove_watch_cb remove_watch, 4850df750e9SMarc-André Lureau const VuDevIface *iface); 4860df750e9SMarc-André Lureau 4870df750e9SMarc-André Lureau 4880df750e9SMarc-André Lureau /** 4890df750e9SMarc-André Lureau * vu_deinit: 4900df750e9SMarc-André Lureau * @dev: a VuDev context 4910df750e9SMarc-André Lureau * 4920df750e9SMarc-André Lureau * Cleans up the VuDev context 4930df750e9SMarc-André Lureau */ 4940df750e9SMarc-André Lureau void vu_deinit(VuDev *dev); 4950df750e9SMarc-André Lureau 496467eeb0fSAlex Bennée 497467eeb0fSAlex Bennée /** 498467eeb0fSAlex Bennée * vu_request_to_string: return string for vhost message request 499467eeb0fSAlex Bennée * @req: VhostUserMsg request 500467eeb0fSAlex Bennée * 501467eeb0fSAlex Bennée * Returns a const string, do not free. 502467eeb0fSAlex Bennée */ 503467eeb0fSAlex Bennée const char *vu_request_to_string(unsigned int req); 504467eeb0fSAlex Bennée 5050df750e9SMarc-André Lureau /** 5060df750e9SMarc-André Lureau * vu_dispatch: 5070df750e9SMarc-André Lureau * @dev: a VuDev context 5080df750e9SMarc-André Lureau * 5090df750e9SMarc-André Lureau * Process one vhost-user message. 5100df750e9SMarc-André Lureau * 5110df750e9SMarc-André Lureau * Returns: TRUE on success, FALSE on failure. 5120df750e9SMarc-André Lureau */ 5130df750e9SMarc-André Lureau bool vu_dispatch(VuDev *dev); 5140df750e9SMarc-André Lureau 5150df750e9SMarc-André Lureau /** 5160df750e9SMarc-André Lureau * vu_gpa_to_va: 5170df750e9SMarc-André Lureau * @dev: a VuDev context 5180df750e9SMarc-André Lureau * @plen: guest memory size 5190df750e9SMarc-André Lureau * @guest_addr: guest address 5200df750e9SMarc-André Lureau * 5210df750e9SMarc-André Lureau * Translate a guest address to a pointer. Returns NULL on failure. 5220df750e9SMarc-André Lureau */ 5230df750e9SMarc-André Lureau void *vu_gpa_to_va(VuDev *dev, uint64_t *plen, uint64_t guest_addr); 5240df750e9SMarc-André Lureau 5250df750e9SMarc-André Lureau /** 5260df750e9SMarc-André Lureau * vu_get_queue: 5270df750e9SMarc-André Lureau * @dev: a VuDev context 5280df750e9SMarc-André Lureau * @qidx: queue index 5290df750e9SMarc-André Lureau * 5300df750e9SMarc-André Lureau * Returns the queue number @qidx. 5310df750e9SMarc-André Lureau */ 5320df750e9SMarc-André Lureau VuVirtq *vu_get_queue(VuDev *dev, int qidx); 5330df750e9SMarc-André Lureau 5340df750e9SMarc-André Lureau /** 5350df750e9SMarc-André Lureau * vu_set_queue_handler: 5360df750e9SMarc-André Lureau * @dev: a VuDev context 5370df750e9SMarc-André Lureau * @vq: a VuVirtq queue 5380df750e9SMarc-André Lureau * @handler: the queue handler callback 5390df750e9SMarc-André Lureau * 5400df750e9SMarc-André Lureau * Set the queue handler. This function may be called several times 5410df750e9SMarc-André Lureau * for the same queue. If called with NULL @handler, the handler is 5420df750e9SMarc-André Lureau * removed. 5430df750e9SMarc-André Lureau */ 5440df750e9SMarc-André Lureau void vu_set_queue_handler(VuDev *dev, VuVirtq *vq, 5450df750e9SMarc-André Lureau vu_queue_handler_cb handler); 5460df750e9SMarc-André Lureau 5470df750e9SMarc-André Lureau /** 5480df750e9SMarc-André Lureau * vu_set_queue_host_notifier: 5490df750e9SMarc-André Lureau * @dev: a VuDev context 5500df750e9SMarc-André Lureau * @vq: a VuVirtq queue 5510df750e9SMarc-André Lureau * @fd: a file descriptor 5520df750e9SMarc-André Lureau * @size: host page size 5530df750e9SMarc-André Lureau * @offset: notifier offset in @fd file 5540df750e9SMarc-André Lureau * 5550df750e9SMarc-André Lureau * Set queue's host notifier. This function may be called several 5560df750e9SMarc-André Lureau * times for the same queue. If called with -1 @fd, the notifier 5570df750e9SMarc-André Lureau * is removed. 5580df750e9SMarc-André Lureau */ 5590df750e9SMarc-André Lureau bool vu_set_queue_host_notifier(VuDev *dev, VuVirtq *vq, int fd, 5600df750e9SMarc-André Lureau int size, int offset); 5610df750e9SMarc-André Lureau 5620df750e9SMarc-André Lureau /** 563ce0f3b03SAlbert Esteve * vu_lookup_shared_object: 564ce0f3b03SAlbert Esteve * @dev: a VuDev context 565ce0f3b03SAlbert Esteve * @uuid: UUID of the shared object 566ce0f3b03SAlbert Esteve * @dmabuf_fd: output dma-buf file descriptor 567ce0f3b03SAlbert Esteve * 568ce0f3b03SAlbert Esteve * Lookup for a virtio shared object (i.e., dma-buf fd) associated with the 569ce0f3b03SAlbert Esteve * received UUID. Result, if found, is stored in the dmabuf_fd argument. 570ce0f3b03SAlbert Esteve * 571ce0f3b03SAlbert Esteve * Returns: whether the virtio object was found. 572ce0f3b03SAlbert Esteve */ 573ce0f3b03SAlbert Esteve bool vu_lookup_shared_object(VuDev *dev, unsigned char uuid[UUID_LEN], 574ce0f3b03SAlbert Esteve int *dmabuf_fd); 575ce0f3b03SAlbert Esteve 576ce0f3b03SAlbert Esteve /** 577ce0f3b03SAlbert Esteve * vu_add_shared_object: 578ce0f3b03SAlbert Esteve * @dev: a VuDev context 579ce0f3b03SAlbert Esteve * @uuid: UUID of the shared object 580ce0f3b03SAlbert Esteve * 581ce0f3b03SAlbert Esteve * Registers this back-end as the exporter for the object associated with 582ce0f3b03SAlbert Esteve * the received UUID. 583ce0f3b03SAlbert Esteve * 584ce0f3b03SAlbert Esteve * Returns: TRUE on success, FALSE on failure. 585ce0f3b03SAlbert Esteve */ 586ce0f3b03SAlbert Esteve bool vu_add_shared_object(VuDev *dev, unsigned char uuid[UUID_LEN]); 587ce0f3b03SAlbert Esteve 588ce0f3b03SAlbert Esteve /** 589ce0f3b03SAlbert Esteve * vu_rm_shared_object: 590ce0f3b03SAlbert Esteve * @dev: a VuDev context 591ce0f3b03SAlbert Esteve * @uuid: UUID of the shared object 592ce0f3b03SAlbert Esteve * 593ce0f3b03SAlbert Esteve * Removes a shared object entry (i.e., back-end entry) associated with the 594ce0f3b03SAlbert Esteve * received UUID key from the hash table. 595ce0f3b03SAlbert Esteve * 596ce0f3b03SAlbert Esteve * Returns: TRUE on success, FALSE on failure. 597ce0f3b03SAlbert Esteve */ 598ce0f3b03SAlbert Esteve bool vu_rm_shared_object(VuDev *dev, unsigned char uuid[UUID_LEN]); 599ce0f3b03SAlbert Esteve 600ce0f3b03SAlbert Esteve /** 6010df750e9SMarc-André Lureau * vu_queue_set_notification: 6020df750e9SMarc-André Lureau * @dev: a VuDev context 6030df750e9SMarc-André Lureau * @vq: a VuVirtq queue 6040df750e9SMarc-André Lureau * @enable: state 6050df750e9SMarc-André Lureau * 6060df750e9SMarc-André Lureau * Set whether the queue notifies (via event index or interrupt) 6070df750e9SMarc-André Lureau */ 6080df750e9SMarc-André Lureau void vu_queue_set_notification(VuDev *dev, VuVirtq *vq, int enable); 6090df750e9SMarc-André Lureau 6100df750e9SMarc-André Lureau /** 6110df750e9SMarc-André Lureau * vu_queue_enabled: 6120df750e9SMarc-André Lureau * @dev: a VuDev context 6130df750e9SMarc-André Lureau * @vq: a VuVirtq queue 6140df750e9SMarc-André Lureau * 6150df750e9SMarc-André Lureau * Returns: whether the queue is enabled. 6160df750e9SMarc-André Lureau */ 6170df750e9SMarc-André Lureau bool vu_queue_enabled(VuDev *dev, VuVirtq *vq); 6180df750e9SMarc-André Lureau 6190df750e9SMarc-André Lureau /** 6200df750e9SMarc-André Lureau * vu_queue_started: 6210df750e9SMarc-André Lureau * @dev: a VuDev context 6220df750e9SMarc-André Lureau * @vq: a VuVirtq queue 6230df750e9SMarc-André Lureau * 6240df750e9SMarc-André Lureau * Returns: whether the queue is started. 6250df750e9SMarc-André Lureau */ 6260df750e9SMarc-André Lureau bool vu_queue_started(const VuDev *dev, const VuVirtq *vq); 6270df750e9SMarc-André Lureau 6280df750e9SMarc-André Lureau /** 6290df750e9SMarc-André Lureau * vu_queue_empty: 6300df750e9SMarc-André Lureau * @dev: a VuDev context 6310df750e9SMarc-André Lureau * @vq: a VuVirtq queue 6320df750e9SMarc-André Lureau * 6330df750e9SMarc-André Lureau * Returns: true if the queue is empty or not ready. 6340df750e9SMarc-André Lureau */ 6350df750e9SMarc-André Lureau bool vu_queue_empty(VuDev *dev, VuVirtq *vq); 6360df750e9SMarc-André Lureau 6370df750e9SMarc-André Lureau /** 6380df750e9SMarc-André Lureau * vu_queue_notify: 6390df750e9SMarc-André Lureau * @dev: a VuDev context 6400df750e9SMarc-André Lureau * @vq: a VuVirtq queue 6410df750e9SMarc-André Lureau * 6420df750e9SMarc-André Lureau * Request to notify the queue via callfd (skipped if unnecessary) 6430df750e9SMarc-André Lureau */ 6440df750e9SMarc-André Lureau void vu_queue_notify(VuDev *dev, VuVirtq *vq); 6450df750e9SMarc-André Lureau 646ca858a5fSVladimir Sementsov-Ogievskiy void vu_config_change_msg(VuDev *dev); 647ca858a5fSVladimir Sementsov-Ogievskiy 6480df750e9SMarc-André Lureau /** 6490df750e9SMarc-André Lureau * vu_queue_notify_sync: 6500df750e9SMarc-André Lureau * @dev: a VuDev context 6510df750e9SMarc-André Lureau * @vq: a VuVirtq queue 6520df750e9SMarc-André Lureau * 6530df750e9SMarc-André Lureau * Request to notify the queue via callfd (skipped if unnecessary) 6540df750e9SMarc-André Lureau * or sync message if possible. 6550df750e9SMarc-André Lureau */ 6560df750e9SMarc-André Lureau void vu_queue_notify_sync(VuDev *dev, VuVirtq *vq); 6570df750e9SMarc-André Lureau 6580df750e9SMarc-André Lureau /** 6590df750e9SMarc-André Lureau * vu_queue_pop: 6600df750e9SMarc-André Lureau * @dev: a VuDev context 6610df750e9SMarc-André Lureau * @vq: a VuVirtq queue 6620df750e9SMarc-André Lureau * @sz: the size of struct to return (must be >= VuVirtqElement) 6630df750e9SMarc-André Lureau * 6640df750e9SMarc-André Lureau * Returns: a VuVirtqElement filled from the queue or NULL. The 6650df750e9SMarc-André Lureau * returned element must be free()-d by the caller. 6660df750e9SMarc-André Lureau */ 6670df750e9SMarc-André Lureau void *vu_queue_pop(VuDev *dev, VuVirtq *vq, size_t sz); 6680df750e9SMarc-André Lureau 6690df750e9SMarc-André Lureau 6700df750e9SMarc-André Lureau /** 6710df750e9SMarc-André Lureau * vu_queue_unpop: 6720df750e9SMarc-André Lureau * @dev: a VuDev context 6730df750e9SMarc-André Lureau * @vq: a VuVirtq queue 6740df750e9SMarc-André Lureau * @elem: The #VuVirtqElement 6750df750e9SMarc-André Lureau * @len: number of bytes written 6760df750e9SMarc-André Lureau * 6770df750e9SMarc-André Lureau * Pretend the most recent element wasn't popped from the virtqueue. The next 6780df750e9SMarc-André Lureau * call to vu_queue_pop() will refetch the element. 6790df750e9SMarc-André Lureau */ 6800df750e9SMarc-André Lureau void vu_queue_unpop(VuDev *dev, VuVirtq *vq, VuVirtqElement *elem, 6810df750e9SMarc-André Lureau size_t len); 6820df750e9SMarc-André Lureau 6830df750e9SMarc-André Lureau /** 6840df750e9SMarc-André Lureau * vu_queue_rewind: 6850df750e9SMarc-André Lureau * @dev: a VuDev context 6860df750e9SMarc-André Lureau * @vq: a VuVirtq queue 6870df750e9SMarc-André Lureau * @num: number of elements to push back 6880df750e9SMarc-André Lureau * 6890df750e9SMarc-André Lureau * Pretend that elements weren't popped from the virtqueue. The next 6900df750e9SMarc-André Lureau * virtqueue_pop() will refetch the oldest element. 6910df750e9SMarc-André Lureau * 6920df750e9SMarc-André Lureau * Returns: true on success, false if @num is greater than the number of in use 6930df750e9SMarc-André Lureau * elements. 6940df750e9SMarc-André Lureau */ 6950df750e9SMarc-André Lureau bool vu_queue_rewind(VuDev *dev, VuVirtq *vq, unsigned int num); 6960df750e9SMarc-André Lureau 6970df750e9SMarc-André Lureau /** 6980df750e9SMarc-André Lureau * vu_queue_fill: 6990df750e9SMarc-André Lureau * @dev: a VuDev context 7000df750e9SMarc-André Lureau * @vq: a VuVirtq queue 7010df750e9SMarc-André Lureau * @elem: a VuVirtqElement 7020df750e9SMarc-André Lureau * @len: length in bytes to write 7030df750e9SMarc-André Lureau * @idx: optional offset for the used ring index (0 in general) 7040df750e9SMarc-André Lureau * 7050df750e9SMarc-André Lureau * Fill the used ring with @elem element. 7060df750e9SMarc-André Lureau */ 7070df750e9SMarc-André Lureau void vu_queue_fill(VuDev *dev, VuVirtq *vq, 7080df750e9SMarc-André Lureau const VuVirtqElement *elem, 7090df750e9SMarc-André Lureau unsigned int len, unsigned int idx); 7100df750e9SMarc-André Lureau 7110df750e9SMarc-André Lureau /** 7120df750e9SMarc-André Lureau * vu_queue_push: 7130df750e9SMarc-André Lureau * @dev: a VuDev context 7140df750e9SMarc-André Lureau * @vq: a VuVirtq queue 7150df750e9SMarc-André Lureau * @elem: a VuVirtqElement 7160df750e9SMarc-André Lureau * @len: length in bytes to write 7170df750e9SMarc-André Lureau * 7180df750e9SMarc-André Lureau * Helper that combines vu_queue_fill() with a vu_queue_flush(). 7190df750e9SMarc-André Lureau */ 7200df750e9SMarc-André Lureau void vu_queue_push(VuDev *dev, VuVirtq *vq, 7210df750e9SMarc-André Lureau const VuVirtqElement *elem, unsigned int len); 7220df750e9SMarc-André Lureau 7230df750e9SMarc-André Lureau /** 7240df750e9SMarc-André Lureau * vu_queue_flush: 7250df750e9SMarc-André Lureau * @dev: a VuDev context 7260df750e9SMarc-André Lureau * @vq: a VuVirtq queue 7270df750e9SMarc-André Lureau * @num: number of elements to flush 7280df750e9SMarc-André Lureau * 7290df750e9SMarc-André Lureau * Mark the last number of elements as done (used.idx is updated by 7300df750e9SMarc-André Lureau * num elements). 7310df750e9SMarc-André Lureau */ 7320df750e9SMarc-André Lureau void vu_queue_flush(VuDev *dev, VuVirtq *vq, unsigned int num); 7330df750e9SMarc-André Lureau 7340df750e9SMarc-André Lureau /** 7350df750e9SMarc-André Lureau * vu_queue_get_avail_bytes: 7360df750e9SMarc-André Lureau * @dev: a VuDev context 7370df750e9SMarc-André Lureau * @vq: a VuVirtq queue 7380df750e9SMarc-André Lureau * @in_bytes: in bytes 7390df750e9SMarc-André Lureau * @out_bytes: out bytes 7400df750e9SMarc-André Lureau * @max_in_bytes: stop counting after max_in_bytes 7410df750e9SMarc-André Lureau * @max_out_bytes: stop counting after max_out_bytes 7420df750e9SMarc-André Lureau * 7430df750e9SMarc-André Lureau * Count the number of available bytes, up to max_in_bytes/max_out_bytes. 7440df750e9SMarc-André Lureau */ 7450df750e9SMarc-André Lureau void vu_queue_get_avail_bytes(VuDev *vdev, VuVirtq *vq, unsigned int *in_bytes, 7460df750e9SMarc-André Lureau unsigned int *out_bytes, 7470df750e9SMarc-André Lureau unsigned max_in_bytes, unsigned max_out_bytes); 7480df750e9SMarc-André Lureau 7490df750e9SMarc-André Lureau /** 7500df750e9SMarc-André Lureau * vu_queue_avail_bytes: 7510df750e9SMarc-André Lureau * @dev: a VuDev context 7520df750e9SMarc-André Lureau * @vq: a VuVirtq queue 7530df750e9SMarc-André Lureau * @in_bytes: expected in bytes 7540df750e9SMarc-André Lureau * @out_bytes: expected out bytes 7550df750e9SMarc-André Lureau * 7560df750e9SMarc-André Lureau * Returns: true if in_bytes <= in_total && out_bytes <= out_total 7570df750e9SMarc-André Lureau */ 7580df750e9SMarc-André Lureau bool vu_queue_avail_bytes(VuDev *dev, VuVirtq *vq, unsigned int in_bytes, 7590df750e9SMarc-André Lureau unsigned int out_bytes); 7600df750e9SMarc-André Lureau 7610df750e9SMarc-André Lureau #endif /* LIBVHOST_USER_H */ 762