xref: /qemu/subprojects/libvhost-user/libvhost-user.h (revision bd2e44fee474c43f54aadd35b5b8fd5ba8f4d11f)
17b2e5c65SMarc-André Lureau /*
27b2e5c65SMarc-André Lureau  * Vhost User library
37b2e5c65SMarc-André Lureau  *
47b2e5c65SMarc-André Lureau  * Copyright (c) 2016 Red Hat, Inc.
57b2e5c65SMarc-André Lureau  *
67b2e5c65SMarc-André Lureau  * Authors:
77b2e5c65SMarc-André Lureau  *  Victor Kaplansky <victork@redhat.com>
87b2e5c65SMarc-André Lureau  *  Marc-André Lureau <mlureau@redhat.com>
97b2e5c65SMarc-André Lureau  *
107b2e5c65SMarc-André Lureau  * This work is licensed under the terms of the GNU GPL, version 2 or
117b2e5c65SMarc-André Lureau  * later.  See the COPYING file in the top-level directory.
127b2e5c65SMarc-André Lureau  */
137b2e5c65SMarc-André Lureau 
147b2e5c65SMarc-André Lureau #ifndef LIBVHOST_USER_H
157b2e5c65SMarc-André Lureau #define LIBVHOST_USER_H
167b2e5c65SMarc-André Lureau 
177b2e5c65SMarc-André Lureau #include <stdint.h>
187b2e5c65SMarc-André Lureau #include <stdbool.h>
197b2e5c65SMarc-André Lureau #include <stddef.h>
2049cc0340SFelipe Franciosi #include <sys/poll.h>
217b2e5c65SMarc-André Lureau #include <linux/vhost.h>
227b2e5c65SMarc-André Lureau #include "standard-headers/linux/virtio_ring.h"
237b2e5c65SMarc-André Lureau 
247b2e5c65SMarc-André Lureau /* Based on qemu/hw/virtio/vhost-user.c */
257b2e5c65SMarc-André Lureau #define VHOST_USER_F_PROTOCOL_FEATURES 30
267b2e5c65SMarc-André Lureau #define VHOST_LOG_PAGE 4096
277b2e5c65SMarc-André Lureau 
287b2e5c65SMarc-André Lureau #define VHOST_MAX_NR_VIRTQUEUE 8
297b2e5c65SMarc-André Lureau #define VIRTQUEUE_MAX_SIZE 1024
307b2e5c65SMarc-André Lureau 
317b2e5c65SMarc-André Lureau #define VHOST_MEMORY_MAX_NREGIONS 8
327b2e5c65SMarc-André Lureau 
330bc24d83SChangpeng Liu typedef enum VhostSetConfigType {
340bc24d83SChangpeng Liu     VHOST_SET_CONFIG_TYPE_MASTER = 0,
350bc24d83SChangpeng Liu     VHOST_SET_CONFIG_TYPE_MIGRATION = 1,
360bc24d83SChangpeng Liu } VhostSetConfigType;
370bc24d83SChangpeng Liu 
380bc24d83SChangpeng Liu /*
390bc24d83SChangpeng Liu  * Maximum size of virtio device config space
400bc24d83SChangpeng Liu  */
410bc24d83SChangpeng Liu #define VHOST_USER_MAX_CONFIG_SIZE 256
420bc24d83SChangpeng Liu 
437b2e5c65SMarc-André Lureau enum VhostUserProtocolFeature {
447b2e5c65SMarc-André Lureau     VHOST_USER_PROTOCOL_F_MQ = 0,
457b2e5c65SMarc-André Lureau     VHOST_USER_PROTOCOL_F_LOG_SHMFD = 1,
467b2e5c65SMarc-André Lureau     VHOST_USER_PROTOCOL_F_RARP = 2,
47ea642e22SDr. David Alan Gilbert     VHOST_USER_PROTOCOL_F_REPLY_ACK = 3,
48ea642e22SDr. David Alan Gilbert     VHOST_USER_PROTOCOL_F_NET_MTU = 4,
49ea642e22SDr. David Alan Gilbert     VHOST_USER_PROTOCOL_F_SLAVE_REQ = 5,
50ea642e22SDr. David Alan Gilbert     VHOST_USER_PROTOCOL_F_CROSS_ENDIAN = 6,
519ccbfe14SDr. David Alan Gilbert     VHOST_USER_PROTOCOL_F_CRYPTO_SESSION = 7,
529ccbfe14SDr. David Alan Gilbert     VHOST_USER_PROTOCOL_F_PAGEFAULT = 8,
53ea3e6f5aSChangpeng Liu     VHOST_USER_PROTOCOL_F_CONFIG = 9,
54d84599f5STiwei Bie     VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD = 10,
55d84599f5STiwei Bie     VHOST_USER_PROTOCOL_F_HOST_NOTIFIER = 11,
565f9ff1efSXie Yongji     VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD = 12,
577b2e5c65SMarc-André Lureau 
587b2e5c65SMarc-André Lureau     VHOST_USER_PROTOCOL_F_MAX
597b2e5c65SMarc-André Lureau };
607b2e5c65SMarc-André Lureau 
617b2e5c65SMarc-André Lureau #define VHOST_USER_PROTOCOL_FEATURE_MASK ((1 << VHOST_USER_PROTOCOL_F_MAX) - 1)
627b2e5c65SMarc-André Lureau 
637b2e5c65SMarc-André Lureau typedef enum VhostUserRequest {
647b2e5c65SMarc-André Lureau     VHOST_USER_NONE = 0,
657b2e5c65SMarc-André Lureau     VHOST_USER_GET_FEATURES = 1,
667b2e5c65SMarc-André Lureau     VHOST_USER_SET_FEATURES = 2,
677b2e5c65SMarc-André Lureau     VHOST_USER_SET_OWNER = 3,
687b2e5c65SMarc-André Lureau     VHOST_USER_RESET_OWNER = 4,
697b2e5c65SMarc-André Lureau     VHOST_USER_SET_MEM_TABLE = 5,
707b2e5c65SMarc-André Lureau     VHOST_USER_SET_LOG_BASE = 6,
717b2e5c65SMarc-André Lureau     VHOST_USER_SET_LOG_FD = 7,
727b2e5c65SMarc-André Lureau     VHOST_USER_SET_VRING_NUM = 8,
737b2e5c65SMarc-André Lureau     VHOST_USER_SET_VRING_ADDR = 9,
747b2e5c65SMarc-André Lureau     VHOST_USER_SET_VRING_BASE = 10,
757b2e5c65SMarc-André Lureau     VHOST_USER_GET_VRING_BASE = 11,
767b2e5c65SMarc-André Lureau     VHOST_USER_SET_VRING_KICK = 12,
777b2e5c65SMarc-André Lureau     VHOST_USER_SET_VRING_CALL = 13,
787b2e5c65SMarc-André Lureau     VHOST_USER_SET_VRING_ERR = 14,
797b2e5c65SMarc-André Lureau     VHOST_USER_GET_PROTOCOL_FEATURES = 15,
807b2e5c65SMarc-André Lureau     VHOST_USER_SET_PROTOCOL_FEATURES = 16,
817b2e5c65SMarc-André Lureau     VHOST_USER_GET_QUEUE_NUM = 17,
827b2e5c65SMarc-André Lureau     VHOST_USER_SET_VRING_ENABLE = 18,
837b2e5c65SMarc-André Lureau     VHOST_USER_SEND_RARP = 19,
84ea642e22SDr. David Alan Gilbert     VHOST_USER_NET_SET_MTU = 20,
85ea642e22SDr. David Alan Gilbert     VHOST_USER_SET_SLAVE_REQ_FD = 21,
86ea642e22SDr. David Alan Gilbert     VHOST_USER_IOTLB_MSG = 22,
87ea642e22SDr. David Alan Gilbert     VHOST_USER_SET_VRING_ENDIAN = 23,
880bc24d83SChangpeng Liu     VHOST_USER_GET_CONFIG = 24,
890bc24d83SChangpeng Liu     VHOST_USER_SET_CONFIG = 25,
90d3dff7a5SDr. David Alan Gilbert     VHOST_USER_CREATE_CRYPTO_SESSION = 26,
91d3dff7a5SDr. David Alan Gilbert     VHOST_USER_CLOSE_CRYPTO_SESSION = 27,
92d3dff7a5SDr. David Alan Gilbert     VHOST_USER_POSTCOPY_ADVISE  = 28,
936864a7b5SDr. David Alan Gilbert     VHOST_USER_POSTCOPY_LISTEN  = 29,
94c639187eSDr. David Alan Gilbert     VHOST_USER_POSTCOPY_END     = 30,
955f9ff1efSXie Yongji     VHOST_USER_GET_INFLIGHT_FD = 31,
965f9ff1efSXie Yongji     VHOST_USER_SET_INFLIGHT_FD = 32,
97*bd2e44feSMarc-André Lureau     VHOST_USER_GPU_SET_SOCKET = 33,
987b2e5c65SMarc-André Lureau     VHOST_USER_MAX
997b2e5c65SMarc-André Lureau } VhostUserRequest;
1007b2e5c65SMarc-André Lureau 
101d84599f5STiwei Bie typedef enum VhostUserSlaveRequest {
102d84599f5STiwei Bie     VHOST_USER_SLAVE_NONE = 0,
103d84599f5STiwei Bie     VHOST_USER_SLAVE_IOTLB_MSG = 1,
104d84599f5STiwei Bie     VHOST_USER_SLAVE_CONFIG_CHANGE_MSG = 2,
105d84599f5STiwei Bie     VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG = 3,
106d84599f5STiwei Bie     VHOST_USER_SLAVE_MAX
107d84599f5STiwei Bie }  VhostUserSlaveRequest;
108d84599f5STiwei Bie 
1097b2e5c65SMarc-André Lureau typedef struct VhostUserMemoryRegion {
1107b2e5c65SMarc-André Lureau     uint64_t guest_phys_addr;
1117b2e5c65SMarc-André Lureau     uint64_t memory_size;
1127b2e5c65SMarc-André Lureau     uint64_t userspace_addr;
1137b2e5c65SMarc-André Lureau     uint64_t mmap_offset;
1147b2e5c65SMarc-André Lureau } VhostUserMemoryRegion;
1157b2e5c65SMarc-André Lureau 
1167b2e5c65SMarc-André Lureau typedef struct VhostUserMemory {
1177b2e5c65SMarc-André Lureau     uint32_t nregions;
1187b2e5c65SMarc-André Lureau     uint32_t padding;
1197b2e5c65SMarc-André Lureau     VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
1207b2e5c65SMarc-André Lureau } VhostUserMemory;
1217b2e5c65SMarc-André Lureau 
1227b2e5c65SMarc-André Lureau typedef struct VhostUserLog {
1237b2e5c65SMarc-André Lureau     uint64_t mmap_size;
1247b2e5c65SMarc-André Lureau     uint64_t mmap_offset;
1257b2e5c65SMarc-André Lureau } VhostUserLog;
1267b2e5c65SMarc-André Lureau 
1270bc24d83SChangpeng Liu typedef struct VhostUserConfig {
1280bc24d83SChangpeng Liu     uint32_t offset;
1290bc24d83SChangpeng Liu     uint32_t size;
1300bc24d83SChangpeng Liu     uint32_t flags;
1310bc24d83SChangpeng Liu     uint8_t region[VHOST_USER_MAX_CONFIG_SIZE];
1320bc24d83SChangpeng Liu } VhostUserConfig;
1330bc24d83SChangpeng Liu 
1340bc24d83SChangpeng Liu static VhostUserConfig c __attribute__ ((unused));
1350bc24d83SChangpeng Liu #define VHOST_USER_CONFIG_HDR_SIZE (sizeof(c.offset) \
1360bc24d83SChangpeng Liu                                    + sizeof(c.size) \
1370bc24d83SChangpeng Liu                                    + sizeof(c.flags))
1380bc24d83SChangpeng Liu 
139d84599f5STiwei Bie typedef struct VhostUserVringArea {
140d84599f5STiwei Bie     uint64_t u64;
141d84599f5STiwei Bie     uint64_t size;
142d84599f5STiwei Bie     uint64_t offset;
143d84599f5STiwei Bie } VhostUserVringArea;
144d84599f5STiwei Bie 
1455f9ff1efSXie Yongji typedef struct VhostUserInflight {
1465f9ff1efSXie Yongji     uint64_t mmap_size;
1475f9ff1efSXie Yongji     uint64_t mmap_offset;
1485f9ff1efSXie Yongji     uint16_t num_queues;
1495f9ff1efSXie Yongji     uint16_t queue_size;
1505f9ff1efSXie Yongji } VhostUserInflight;
1515f9ff1efSXie Yongji 
15248bb55bfSCao Jiaxi #if defined(_WIN32) && (defined(__x86_64__) || defined(__i386__))
1537b2e5c65SMarc-André Lureau # define VU_PACKED __attribute__((gcc_struct, packed))
1547b2e5c65SMarc-André Lureau #else
1557b2e5c65SMarc-André Lureau # define VU_PACKED __attribute__((packed))
1567b2e5c65SMarc-André Lureau #endif
1577b2e5c65SMarc-André Lureau 
1587b2e5c65SMarc-André Lureau typedef struct VhostUserMsg {
159ba275e9dSMarc-André Lureau     int request;
1607b2e5c65SMarc-André Lureau 
1617b2e5c65SMarc-André Lureau #define VHOST_USER_VERSION_MASK     (0x3)
1627b2e5c65SMarc-André Lureau #define VHOST_USER_REPLY_MASK       (0x1 << 2)
163d84599f5STiwei Bie #define VHOST_USER_NEED_REPLY_MASK  (0x1 << 3)
1647b2e5c65SMarc-André Lureau     uint32_t flags;
1657b2e5c65SMarc-André Lureau     uint32_t size; /* the following payload size */
1667b2e5c65SMarc-André Lureau 
1677b2e5c65SMarc-André Lureau     union {
1687b2e5c65SMarc-André Lureau #define VHOST_USER_VRING_IDX_MASK   (0xff)
1697b2e5c65SMarc-André Lureau #define VHOST_USER_VRING_NOFD_MASK  (0x1 << 8)
1707b2e5c65SMarc-André Lureau         uint64_t u64;
1717b2e5c65SMarc-André Lureau         struct vhost_vring_state state;
1727b2e5c65SMarc-André Lureau         struct vhost_vring_addr addr;
1737b2e5c65SMarc-André Lureau         VhostUserMemory memory;
1747b2e5c65SMarc-André Lureau         VhostUserLog log;
1750bc24d83SChangpeng Liu         VhostUserConfig config;
176d84599f5STiwei Bie         VhostUserVringArea area;
1775f9ff1efSXie Yongji         VhostUserInflight inflight;
1787b2e5c65SMarc-André Lureau     } payload;
1797b2e5c65SMarc-André Lureau 
1807b2e5c65SMarc-André Lureau     int fds[VHOST_MEMORY_MAX_NREGIONS];
1817b2e5c65SMarc-André Lureau     int fd_num;
1827b2e5c65SMarc-André Lureau     uint8_t *data;
1837b2e5c65SMarc-André Lureau } VU_PACKED VhostUserMsg;
1847b2e5c65SMarc-André Lureau 
1857b2e5c65SMarc-André Lureau typedef struct VuDevRegion {
1867b2e5c65SMarc-André Lureau     /* Guest Physical address. */
1877b2e5c65SMarc-André Lureau     uint64_t gpa;
1887b2e5c65SMarc-André Lureau     /* Memory region size. */
1897b2e5c65SMarc-André Lureau     uint64_t size;
1907b2e5c65SMarc-André Lureau     /* QEMU virtual address (userspace). */
1917b2e5c65SMarc-André Lureau     uint64_t qva;
1927b2e5c65SMarc-André Lureau     /* Starting offset in our mmaped space. */
1937b2e5c65SMarc-André Lureau     uint64_t mmap_offset;
1947b2e5c65SMarc-André Lureau     /* Start address of mmaped space. */
1957b2e5c65SMarc-André Lureau     uint64_t mmap_addr;
1967b2e5c65SMarc-André Lureau } VuDevRegion;
1977b2e5c65SMarc-André Lureau 
1987b2e5c65SMarc-André Lureau typedef struct VuDev VuDev;
1997b2e5c65SMarc-André Lureau 
2007b2e5c65SMarc-André Lureau typedef uint64_t (*vu_get_features_cb) (VuDev *dev);
2017b2e5c65SMarc-André Lureau typedef void (*vu_set_features_cb) (VuDev *dev, uint64_t features);
2027b2e5c65SMarc-André Lureau typedef int (*vu_process_msg_cb) (VuDev *dev, VhostUserMsg *vmsg,
2037b2e5c65SMarc-André Lureau                                   int *do_reply);
2047b2e5c65SMarc-André Lureau typedef void (*vu_queue_set_started_cb) (VuDev *dev, int qidx, bool started);
20535480cbfSMarc-André Lureau typedef bool (*vu_queue_is_processed_in_order_cb) (VuDev *dev, int qidx);
2060bc24d83SChangpeng Liu typedef int (*vu_get_config_cb) (VuDev *dev, uint8_t *config, uint32_t len);
2070bc24d83SChangpeng Liu typedef int (*vu_set_config_cb) (VuDev *dev, const uint8_t *data,
2080bc24d83SChangpeng Liu                                  uint32_t offset, uint32_t size,
2090bc24d83SChangpeng Liu                                  uint32_t flags);
2107b2e5c65SMarc-André Lureau 
2117b2e5c65SMarc-André Lureau typedef struct VuDevIface {
2127b2e5c65SMarc-André Lureau     /* called by VHOST_USER_GET_FEATURES to get the features bitmask */
2137b2e5c65SMarc-André Lureau     vu_get_features_cb get_features;
2147b2e5c65SMarc-André Lureau     /* enable vhost implementation features */
2157b2e5c65SMarc-André Lureau     vu_set_features_cb set_features;
2167b2e5c65SMarc-André Lureau     /* get the protocol feature bitmask from the underlying vhost
2177b2e5c65SMarc-André Lureau      * implementation */
2187b2e5c65SMarc-André Lureau     vu_get_features_cb get_protocol_features;
2197b2e5c65SMarc-André Lureau     /* enable protocol features in the underlying vhost implementation. */
2207b2e5c65SMarc-André Lureau     vu_set_features_cb set_protocol_features;
2217b2e5c65SMarc-André Lureau     /* process_msg is called for each vhost-user message received */
2227b2e5c65SMarc-André Lureau     /* skip libvhost-user processing if return value != 0 */
2237b2e5c65SMarc-André Lureau     vu_process_msg_cb process_msg;
2247b2e5c65SMarc-André Lureau     /* tells when queues can be processed */
2257b2e5c65SMarc-André Lureau     vu_queue_set_started_cb queue_set_started;
22635480cbfSMarc-André Lureau     /*
22735480cbfSMarc-André Lureau      * If the queue is processed in order, in which case it will be
22835480cbfSMarc-André Lureau      * resumed to vring.used->idx. This can help to support resuming
22935480cbfSMarc-André Lureau      * on unmanaged exit/crash.
23035480cbfSMarc-André Lureau      */
23135480cbfSMarc-André Lureau     vu_queue_is_processed_in_order_cb queue_is_processed_in_order;
2320bc24d83SChangpeng Liu     /* get the config space of the device */
2330bc24d83SChangpeng Liu     vu_get_config_cb get_config;
2340bc24d83SChangpeng Liu     /* set the config space of the device */
2350bc24d83SChangpeng Liu     vu_set_config_cb set_config;
2367b2e5c65SMarc-André Lureau } VuDevIface;
2377b2e5c65SMarc-André Lureau 
2387b2e5c65SMarc-André Lureau typedef void (*vu_queue_handler_cb) (VuDev *dev, int qidx);
2397b2e5c65SMarc-André Lureau 
2407b2e5c65SMarc-André Lureau typedef struct VuRing {
2417b2e5c65SMarc-André Lureau     unsigned int num;
2427b2e5c65SMarc-André Lureau     struct vring_desc *desc;
2437b2e5c65SMarc-André Lureau     struct vring_avail *avail;
2447b2e5c65SMarc-André Lureau     struct vring_used *used;
2457b2e5c65SMarc-André Lureau     uint64_t log_guest_addr;
2467b2e5c65SMarc-André Lureau     uint32_t flags;
2477b2e5c65SMarc-André Lureau } VuRing;
2487b2e5c65SMarc-André Lureau 
2495f9ff1efSXie Yongji typedef struct VuDescStateSplit {
2505f9ff1efSXie Yongji     /* Indicate whether this descriptor is inflight or not.
2515f9ff1efSXie Yongji      * Only available for head-descriptor. */
2525f9ff1efSXie Yongji     uint8_t inflight;
2535f9ff1efSXie Yongji 
2545f9ff1efSXie Yongji     /* Padding */
2555f9ff1efSXie Yongji     uint8_t padding[5];
2565f9ff1efSXie Yongji 
2575f9ff1efSXie Yongji     /* Maintain a list for the last batch of used descriptors.
2585f9ff1efSXie Yongji      * Only available when batching is used for submitting */
2595f9ff1efSXie Yongji     uint16_t next;
2605f9ff1efSXie Yongji 
2615f9ff1efSXie Yongji     /* Used to preserve the order of fetching available descriptors.
2625f9ff1efSXie Yongji      * Only available for head-descriptor. */
2635f9ff1efSXie Yongji     uint64_t counter;
2645f9ff1efSXie Yongji } VuDescStateSplit;
2655f9ff1efSXie Yongji 
2665f9ff1efSXie Yongji typedef struct VuVirtqInflight {
2675f9ff1efSXie Yongji     /* The feature flags of this region. Now it's initialized to 0. */
2685f9ff1efSXie Yongji     uint64_t features;
2695f9ff1efSXie Yongji 
2705f9ff1efSXie Yongji     /* The version of this region. It's 1 currently.
2715f9ff1efSXie Yongji      * Zero value indicates a vm reset happened. */
2725f9ff1efSXie Yongji     uint16_t version;
2735f9ff1efSXie Yongji 
2745f9ff1efSXie Yongji     /* The size of VuDescStateSplit array. It's equal to the virtqueue
2755f9ff1efSXie Yongji      * size. Slave could get it from queue size field of VhostUserInflight. */
2765f9ff1efSXie Yongji     uint16_t desc_num;
2775f9ff1efSXie Yongji 
2785f9ff1efSXie Yongji     /* The head of list that track the last batch of used descriptors. */
2795f9ff1efSXie Yongji     uint16_t last_batch_head;
2805f9ff1efSXie Yongji 
2815f9ff1efSXie Yongji     /* Storing the idx value of used ring */
2825f9ff1efSXie Yongji     uint16_t used_idx;
2835f9ff1efSXie Yongji 
2845f9ff1efSXie Yongji     /* Used to track the state of each descriptor in descriptor table */
2855f9ff1efSXie Yongji     VuDescStateSplit desc[0];
2865f9ff1efSXie Yongji } VuVirtqInflight;
2875f9ff1efSXie Yongji 
2885f9ff1efSXie Yongji typedef struct VuVirtqInflightDesc {
2895f9ff1efSXie Yongji     uint16_t index;
2905f9ff1efSXie Yongji     uint64_t counter;
2915f9ff1efSXie Yongji } VuVirtqInflightDesc;
2925f9ff1efSXie Yongji 
2937b2e5c65SMarc-André Lureau typedef struct VuVirtq {
2947b2e5c65SMarc-André Lureau     VuRing vring;
2957b2e5c65SMarc-André Lureau 
2965f9ff1efSXie Yongji     VuVirtqInflight *inflight;
2975f9ff1efSXie Yongji 
2985f9ff1efSXie Yongji     VuVirtqInflightDesc *resubmit_list;
2995f9ff1efSXie Yongji 
3005f9ff1efSXie Yongji     uint16_t resubmit_num;
3015f9ff1efSXie Yongji 
3025f9ff1efSXie Yongji     uint64_t counter;
3035f9ff1efSXie Yongji 
3047b2e5c65SMarc-André Lureau     /* Next head to pop */
3057b2e5c65SMarc-André Lureau     uint16_t last_avail_idx;
3067b2e5c65SMarc-André Lureau 
3077b2e5c65SMarc-André Lureau     /* Last avail_idx read from VQ. */
3087b2e5c65SMarc-André Lureau     uint16_t shadow_avail_idx;
3097b2e5c65SMarc-André Lureau 
3107b2e5c65SMarc-André Lureau     uint16_t used_idx;
3117b2e5c65SMarc-André Lureau 
3127b2e5c65SMarc-André Lureau     /* Last used index value we have signalled on */
3137b2e5c65SMarc-André Lureau     uint16_t signalled_used;
3147b2e5c65SMarc-André Lureau 
3157b2e5c65SMarc-André Lureau     /* Last used index value we have signalled on */
3167b2e5c65SMarc-André Lureau     bool signalled_used_valid;
3177b2e5c65SMarc-André Lureau 
3187b2e5c65SMarc-André Lureau     /* Notification enabled? */
3197b2e5c65SMarc-André Lureau     bool notification;
3207b2e5c65SMarc-André Lureau 
3217b2e5c65SMarc-André Lureau     int inuse;
3227b2e5c65SMarc-André Lureau 
3237b2e5c65SMarc-André Lureau     vu_queue_handler_cb handler;
3247b2e5c65SMarc-André Lureau 
3257b2e5c65SMarc-André Lureau     int call_fd;
3267b2e5c65SMarc-André Lureau     int kick_fd;
3277b2e5c65SMarc-André Lureau     int err_fd;
3287b2e5c65SMarc-André Lureau     unsigned int enable;
3297b2e5c65SMarc-André Lureau     bool started;
3307b2e5c65SMarc-André Lureau } VuVirtq;
3317b2e5c65SMarc-André Lureau 
3327b2e5c65SMarc-André Lureau enum VuWatchCondtion {
33349cc0340SFelipe Franciosi     VU_WATCH_IN = POLLIN,
33449cc0340SFelipe Franciosi     VU_WATCH_OUT = POLLOUT,
33549cc0340SFelipe Franciosi     VU_WATCH_PRI = POLLPRI,
33649cc0340SFelipe Franciosi     VU_WATCH_ERR = POLLERR,
33749cc0340SFelipe Franciosi     VU_WATCH_HUP = POLLHUP,
3387b2e5c65SMarc-André Lureau };
3397b2e5c65SMarc-André Lureau 
3407b2e5c65SMarc-André Lureau typedef void (*vu_panic_cb) (VuDev *dev, const char *err);
3417b2e5c65SMarc-André Lureau typedef void (*vu_watch_cb) (VuDev *dev, int condition, void *data);
3427b2e5c65SMarc-André Lureau typedef void (*vu_set_watch_cb) (VuDev *dev, int fd, int condition,
3437b2e5c65SMarc-André Lureau                                  vu_watch_cb cb, void *data);
3447b2e5c65SMarc-André Lureau typedef void (*vu_remove_watch_cb) (VuDev *dev, int fd);
3457b2e5c65SMarc-André Lureau 
3465f9ff1efSXie Yongji typedef struct VuDevInflightInfo {
3475f9ff1efSXie Yongji     int fd;
3485f9ff1efSXie Yongji     void *addr;
3495f9ff1efSXie Yongji     uint64_t size;
3505f9ff1efSXie Yongji } VuDevInflightInfo;
3515f9ff1efSXie Yongji 
3527b2e5c65SMarc-André Lureau struct VuDev {
3537b2e5c65SMarc-André Lureau     int sock;
3547b2e5c65SMarc-André Lureau     uint32_t nregions;
3557b2e5c65SMarc-André Lureau     VuDevRegion regions[VHOST_MEMORY_MAX_NREGIONS];
3567b2e5c65SMarc-André Lureau     VuVirtq vq[VHOST_MAX_NR_VIRTQUEUE];
3575f9ff1efSXie Yongji     VuDevInflightInfo inflight_info;
3587b2e5c65SMarc-André Lureau     int log_call_fd;
35913384f15SDr. David Alan Gilbert     int slave_fd;
3607b2e5c65SMarc-André Lureau     uint64_t log_size;
3617b2e5c65SMarc-André Lureau     uint8_t *log_table;
3627b2e5c65SMarc-André Lureau     uint64_t features;
3637b2e5c65SMarc-André Lureau     uint64_t protocol_features;
3647b2e5c65SMarc-André Lureau     bool broken;
3657b2e5c65SMarc-André Lureau 
3667b2e5c65SMarc-André Lureau     /* @set_watch: add or update the given fd to the watch set,
3677b2e5c65SMarc-André Lureau      * call cb when condition is met */
3687b2e5c65SMarc-André Lureau     vu_set_watch_cb set_watch;
3697b2e5c65SMarc-André Lureau 
3707b2e5c65SMarc-André Lureau     /* @remove_watch: remove the given fd from the watch set */
3717b2e5c65SMarc-André Lureau     vu_remove_watch_cb remove_watch;
3727b2e5c65SMarc-André Lureau 
3737b2e5c65SMarc-André Lureau     /* @panic: encountered an unrecoverable error, you may try to
3747b2e5c65SMarc-André Lureau      * re-initialize */
3757b2e5c65SMarc-André Lureau     vu_panic_cb panic;
3767b2e5c65SMarc-André Lureau     const VuDevIface *iface;
3772a84ffc0SDr. David Alan Gilbert 
3782a84ffc0SDr. David Alan Gilbert     /* Postcopy data */
3792a84ffc0SDr. David Alan Gilbert     int postcopy_ufd;
3806864a7b5SDr. David Alan Gilbert     bool postcopy_listening;
3817b2e5c65SMarc-André Lureau };
3827b2e5c65SMarc-André Lureau 
3837b2e5c65SMarc-André Lureau typedef struct VuVirtqElement {
3847b2e5c65SMarc-André Lureau     unsigned int index;
3857b2e5c65SMarc-André Lureau     unsigned int out_num;
3867b2e5c65SMarc-André Lureau     unsigned int in_num;
3877b2e5c65SMarc-André Lureau     struct iovec *in_sg;
3887b2e5c65SMarc-André Lureau     struct iovec *out_sg;
3897b2e5c65SMarc-André Lureau } VuVirtqElement;
3907b2e5c65SMarc-André Lureau 
3917b2e5c65SMarc-André Lureau /**
3927b2e5c65SMarc-André Lureau  * vu_init:
3937b2e5c65SMarc-André Lureau  * @dev: a VuDev context
3947b2e5c65SMarc-André Lureau  * @socket: the socket connected to vhost-user master
3957b2e5c65SMarc-André Lureau  * @panic: a panic callback
3967b2e5c65SMarc-André Lureau  * @set_watch: a set_watch callback
3977b2e5c65SMarc-André Lureau  * @remove_watch: a remove_watch callback
3987b2e5c65SMarc-André Lureau  * @iface: a VuDevIface structure with vhost-user device callbacks
3997b2e5c65SMarc-André Lureau  *
4007b2e5c65SMarc-André Lureau  * Intializes a VuDev vhost-user context.
4017b2e5c65SMarc-André Lureau  **/
4027b2e5c65SMarc-André Lureau void vu_init(VuDev *dev,
4037b2e5c65SMarc-André Lureau              int socket,
4047b2e5c65SMarc-André Lureau              vu_panic_cb panic,
4057b2e5c65SMarc-André Lureau              vu_set_watch_cb set_watch,
4067b2e5c65SMarc-André Lureau              vu_remove_watch_cb remove_watch,
4077b2e5c65SMarc-André Lureau              const VuDevIface *iface);
4087b2e5c65SMarc-André Lureau 
4097b2e5c65SMarc-André Lureau 
4107b2e5c65SMarc-André Lureau /**
4117b2e5c65SMarc-André Lureau  * vu_deinit:
4127b2e5c65SMarc-André Lureau  * @dev: a VuDev context
4137b2e5c65SMarc-André Lureau  *
4147b2e5c65SMarc-André Lureau  * Cleans up the VuDev context
4157b2e5c65SMarc-André Lureau  */
4167b2e5c65SMarc-André Lureau void vu_deinit(VuDev *dev);
4177b2e5c65SMarc-André Lureau 
4187b2e5c65SMarc-André Lureau /**
4197b2e5c65SMarc-André Lureau  * vu_dispatch:
4207b2e5c65SMarc-André Lureau  * @dev: a VuDev context
4217b2e5c65SMarc-André Lureau  *
4227b2e5c65SMarc-André Lureau  * Process one vhost-user message.
4237b2e5c65SMarc-André Lureau  *
4247b2e5c65SMarc-André Lureau  * Returns: TRUE on success, FALSE on failure.
4257b2e5c65SMarc-André Lureau  */
4267b2e5c65SMarc-André Lureau bool vu_dispatch(VuDev *dev);
4277b2e5c65SMarc-André Lureau 
4287b2e5c65SMarc-André Lureau /**
4297b2e5c65SMarc-André Lureau  * vu_gpa_to_va:
4307b2e5c65SMarc-André Lureau  * @dev: a VuDev context
431293084a7SYongji Xie  * @plen: guest memory size
4327b2e5c65SMarc-André Lureau  * @guest_addr: guest address
4337b2e5c65SMarc-André Lureau  *
4347b2e5c65SMarc-André Lureau  * Translate a guest address to a pointer. Returns NULL on failure.
4357b2e5c65SMarc-André Lureau  */
436293084a7SYongji Xie void *vu_gpa_to_va(VuDev *dev, uint64_t *plen, uint64_t guest_addr);
4377b2e5c65SMarc-André Lureau 
4387b2e5c65SMarc-André Lureau /**
4397b2e5c65SMarc-André Lureau  * vu_get_queue:
4407b2e5c65SMarc-André Lureau  * @dev: a VuDev context
4417b2e5c65SMarc-André Lureau  * @qidx: queue index
4427b2e5c65SMarc-André Lureau  *
4437b2e5c65SMarc-André Lureau  * Returns the queue number @qidx.
4447b2e5c65SMarc-André Lureau  */
4457b2e5c65SMarc-André Lureau VuVirtq *vu_get_queue(VuDev *dev, int qidx);
4467b2e5c65SMarc-André Lureau 
4477b2e5c65SMarc-André Lureau /**
4487b2e5c65SMarc-André Lureau  * vu_set_queue_handler:
4497b2e5c65SMarc-André Lureau  * @dev: a VuDev context
4507b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
4517b2e5c65SMarc-André Lureau  * @handler: the queue handler callback
4527b2e5c65SMarc-André Lureau  *
4537b2e5c65SMarc-André Lureau  * Set the queue handler. This function may be called several times
4547b2e5c65SMarc-André Lureau  * for the same queue. If called with NULL @handler, the handler is
4557b2e5c65SMarc-André Lureau  * removed.
4567b2e5c65SMarc-André Lureau  */
4577b2e5c65SMarc-André Lureau void vu_set_queue_handler(VuDev *dev, VuVirtq *vq,
4587b2e5c65SMarc-André Lureau                           vu_queue_handler_cb handler);
4597b2e5c65SMarc-André Lureau 
460d84599f5STiwei Bie /**
461d84599f5STiwei Bie  * vu_set_queue_host_notifier:
462d84599f5STiwei Bie  * @dev: a VuDev context
463d84599f5STiwei Bie  * @vq: a VuVirtq queue
464d84599f5STiwei Bie  * @fd: a file descriptor
465d84599f5STiwei Bie  * @size: host page size
466d84599f5STiwei Bie  * @offset: notifier offset in @fd file
467d84599f5STiwei Bie  *
468d84599f5STiwei Bie  * Set queue's host notifier. This function may be called several
469d84599f5STiwei Bie  * times for the same queue. If called with -1 @fd, the notifier
470d84599f5STiwei Bie  * is removed.
471d84599f5STiwei Bie  */
472d84599f5STiwei Bie bool vu_set_queue_host_notifier(VuDev *dev, VuVirtq *vq, int fd,
473d84599f5STiwei Bie                                 int size, int offset);
4747b2e5c65SMarc-André Lureau 
4757b2e5c65SMarc-André Lureau /**
4767b2e5c65SMarc-André Lureau  * vu_queue_set_notification:
4777b2e5c65SMarc-André Lureau  * @dev: a VuDev context
4787b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
4797b2e5c65SMarc-André Lureau  * @enable: state
4807b2e5c65SMarc-André Lureau  *
4817b2e5c65SMarc-André Lureau  * Set whether the queue notifies (via event index or interrupt)
4827b2e5c65SMarc-André Lureau  */
4837b2e5c65SMarc-André Lureau void vu_queue_set_notification(VuDev *dev, VuVirtq *vq, int enable);
4847b2e5c65SMarc-André Lureau 
4857b2e5c65SMarc-André Lureau /**
4867b2e5c65SMarc-André Lureau  * vu_queue_enabled:
4877b2e5c65SMarc-André Lureau  * @dev: a VuDev context
4887b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
4897b2e5c65SMarc-André Lureau  *
4907b2e5c65SMarc-André Lureau  * Returns: whether the queue is enabled.
4917b2e5c65SMarc-André Lureau  */
4927b2e5c65SMarc-André Lureau bool vu_queue_enabled(VuDev *dev, VuVirtq *vq);
4937b2e5c65SMarc-André Lureau 
4947b2e5c65SMarc-André Lureau /**
495bcf0836dSDr. David Alan Gilbert  * vu_queue_started:
496bcf0836dSDr. David Alan Gilbert  * @dev: a VuDev context
497bcf0836dSDr. David Alan Gilbert  * @vq: a VuVirtq queue
498bcf0836dSDr. David Alan Gilbert  *
499bcf0836dSDr. David Alan Gilbert  * Returns: whether the queue is started.
500bcf0836dSDr. David Alan Gilbert  */
501bcf0836dSDr. David Alan Gilbert bool vu_queue_started(const VuDev *dev, const VuVirtq *vq);
502bcf0836dSDr. David Alan Gilbert 
503bcf0836dSDr. David Alan Gilbert /**
504640601c7SMarc-André Lureau  * vu_queue_empty:
5057b2e5c65SMarc-André Lureau  * @dev: a VuDev context
5067b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
5077b2e5c65SMarc-André Lureau  *
508640601c7SMarc-André Lureau  * Returns: true if the queue is empty or not ready.
5097b2e5c65SMarc-André Lureau  */
510640601c7SMarc-André Lureau bool vu_queue_empty(VuDev *dev, VuVirtq *vq);
5117b2e5c65SMarc-André Lureau 
5127b2e5c65SMarc-André Lureau /**
5137b2e5c65SMarc-André Lureau  * vu_queue_notify:
5147b2e5c65SMarc-André Lureau  * @dev: a VuDev context
5157b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
5167b2e5c65SMarc-André Lureau  *
5177b2e5c65SMarc-André Lureau  * Request to notify the queue via callfd (skipped if unnecessary)
5187b2e5c65SMarc-André Lureau  */
5197b2e5c65SMarc-André Lureau void vu_queue_notify(VuDev *dev, VuVirtq *vq);
5207b2e5c65SMarc-André Lureau 
5217b2e5c65SMarc-André Lureau /**
5227b2e5c65SMarc-André Lureau  * vu_queue_pop:
5237b2e5c65SMarc-André Lureau  * @dev: a VuDev context
5247b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
5257b2e5c65SMarc-André Lureau  * @sz: the size of struct to return (must be >= VuVirtqElement)
5267b2e5c65SMarc-André Lureau  *
52719409df8SMarc-André Lureau  * Returns: a VuVirtqElement filled from the queue or NULL. The
52819409df8SMarc-André Lureau  * returned element must be free()-d by the caller.
5297b2e5c65SMarc-André Lureau  */
5307b2e5c65SMarc-André Lureau void *vu_queue_pop(VuDev *dev, VuVirtq *vq, size_t sz);
5317b2e5c65SMarc-André Lureau 
532b13919abSMarc-André Lureau 
533b13919abSMarc-André Lureau /**
534b13919abSMarc-André Lureau  * vu_queue_unpop:
535b13919abSMarc-André Lureau  * @dev: a VuDev context
536b13919abSMarc-André Lureau  * @vq: a VuVirtq queue
537b13919abSMarc-André Lureau  * @elem: The #VuVirtqElement
538b13919abSMarc-André Lureau  * @len: number of bytes written
539b13919abSMarc-André Lureau  *
540b13919abSMarc-André Lureau  * Pretend the most recent element wasn't popped from the virtqueue.  The next
541b13919abSMarc-André Lureau  * call to vu_queue_pop() will refetch the element.
542b13919abSMarc-André Lureau  */
543b13919abSMarc-André Lureau void vu_queue_unpop(VuDev *dev, VuVirtq *vq, VuVirtqElement *elem,
544b13919abSMarc-André Lureau                     size_t len);
545b13919abSMarc-André Lureau 
5467b2e5c65SMarc-André Lureau /**
5477b2e5c65SMarc-André Lureau  * vu_queue_rewind:
5487b2e5c65SMarc-André Lureau  * @dev: a VuDev context
5497b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
5507b2e5c65SMarc-André Lureau  * @num: number of elements to push back
5517b2e5c65SMarc-André Lureau  *
5527b2e5c65SMarc-André Lureau  * Pretend that elements weren't popped from the virtqueue.  The next
5537b2e5c65SMarc-André Lureau  * virtqueue_pop() will refetch the oldest element.
5547b2e5c65SMarc-André Lureau  *
5557b2e5c65SMarc-André Lureau  * Returns: true on success, false if @num is greater than the number of in use
5567b2e5c65SMarc-André Lureau  * elements.
5577b2e5c65SMarc-André Lureau  */
5587b2e5c65SMarc-André Lureau bool vu_queue_rewind(VuDev *dev, VuVirtq *vq, unsigned int num);
5597b2e5c65SMarc-André Lureau 
5607b2e5c65SMarc-André Lureau /**
5617b2e5c65SMarc-André Lureau  * vu_queue_fill:
5627b2e5c65SMarc-André Lureau  * @dev: a VuDev context
5637b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
5647b2e5c65SMarc-André Lureau  * @elem: a VuVirtqElement
5657b2e5c65SMarc-André Lureau  * @len: length in bytes to write
5667b2e5c65SMarc-André Lureau  * @idx: optional offset for the used ring index (0 in general)
5677b2e5c65SMarc-André Lureau  *
5687b2e5c65SMarc-André Lureau  * Fill the used ring with @elem element.
5697b2e5c65SMarc-André Lureau  */
5707b2e5c65SMarc-André Lureau void vu_queue_fill(VuDev *dev, VuVirtq *vq,
5717b2e5c65SMarc-André Lureau                    const VuVirtqElement *elem,
5727b2e5c65SMarc-André Lureau                    unsigned int len, unsigned int idx);
5737b2e5c65SMarc-André Lureau 
5747b2e5c65SMarc-André Lureau /**
5757b2e5c65SMarc-André Lureau  * vu_queue_push:
5767b2e5c65SMarc-André Lureau  * @dev: a VuDev context
5777b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
5787b2e5c65SMarc-André Lureau  * @elem: a VuVirtqElement
5797b2e5c65SMarc-André Lureau  * @len: length in bytes to write
5807b2e5c65SMarc-André Lureau  *
5817b2e5c65SMarc-André Lureau  * Helper that combines vu_queue_fill() with a vu_queue_flush().
5827b2e5c65SMarc-André Lureau  */
5837b2e5c65SMarc-André Lureau void vu_queue_push(VuDev *dev, VuVirtq *vq,
5847b2e5c65SMarc-André Lureau                    const VuVirtqElement *elem, unsigned int len);
5857b2e5c65SMarc-André Lureau 
5867b2e5c65SMarc-André Lureau /**
5877b2e5c65SMarc-André Lureau  * vu_queue_flush:
5887b2e5c65SMarc-André Lureau  * @dev: a VuDev context
5897b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
5907b2e5c65SMarc-André Lureau  * @num: number of elements to flush
5917b2e5c65SMarc-André Lureau  *
5927b2e5c65SMarc-André Lureau  * Mark the last number of elements as done (used.idx is updated by
5937b2e5c65SMarc-André Lureau  * num elements).
5947b2e5c65SMarc-André Lureau */
5957b2e5c65SMarc-André Lureau void vu_queue_flush(VuDev *dev, VuVirtq *vq, unsigned int num);
5967b2e5c65SMarc-André Lureau 
5977b2e5c65SMarc-André Lureau /**
5987b2e5c65SMarc-André Lureau  * vu_queue_get_avail_bytes:
5997b2e5c65SMarc-André Lureau  * @dev: a VuDev context
6007b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
6017b2e5c65SMarc-André Lureau  * @in_bytes: in bytes
6027b2e5c65SMarc-André Lureau  * @out_bytes: out bytes
6037b2e5c65SMarc-André Lureau  * @max_in_bytes: stop counting after max_in_bytes
6047b2e5c65SMarc-André Lureau  * @max_out_bytes: stop counting after max_out_bytes
6057b2e5c65SMarc-André Lureau  *
6067b2e5c65SMarc-André Lureau  * Count the number of available bytes, up to max_in_bytes/max_out_bytes.
6077b2e5c65SMarc-André Lureau  */
6087b2e5c65SMarc-André Lureau void vu_queue_get_avail_bytes(VuDev *vdev, VuVirtq *vq, unsigned int *in_bytes,
6097b2e5c65SMarc-André Lureau                               unsigned int *out_bytes,
6107b2e5c65SMarc-André Lureau                               unsigned max_in_bytes, unsigned max_out_bytes);
6117b2e5c65SMarc-André Lureau 
6127b2e5c65SMarc-André Lureau /**
6137b2e5c65SMarc-André Lureau  * vu_queue_avail_bytes:
6147b2e5c65SMarc-André Lureau  * @dev: a VuDev context
6157b2e5c65SMarc-André Lureau  * @vq: a VuVirtq queue
6167b2e5c65SMarc-André Lureau  * @in_bytes: expected in bytes
6177b2e5c65SMarc-André Lureau  * @out_bytes: expected out bytes
6187b2e5c65SMarc-André Lureau  *
6197b2e5c65SMarc-André Lureau  * Returns: true if in_bytes <= in_total && out_bytes <= out_total
6207b2e5c65SMarc-André Lureau  */
6217b2e5c65SMarc-André Lureau bool vu_queue_avail_bytes(VuDev *dev, VuVirtq *vq, unsigned int in_bytes,
6227b2e5c65SMarc-André Lureau                           unsigned int out_bytes);
6237b2e5c65SMarc-André Lureau 
6247b2e5c65SMarc-André Lureau #endif /* LIBVHOST_USER_H */
625