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 33*0bc24d83SChangpeng Liu typedef enum VhostSetConfigType { 34*0bc24d83SChangpeng Liu VHOST_SET_CONFIG_TYPE_MASTER = 0, 35*0bc24d83SChangpeng Liu VHOST_SET_CONFIG_TYPE_MIGRATION = 1, 36*0bc24d83SChangpeng Liu } VhostSetConfigType; 37*0bc24d83SChangpeng Liu 38*0bc24d83SChangpeng Liu /* 39*0bc24d83SChangpeng Liu * Maximum size of virtio device config space 40*0bc24d83SChangpeng Liu */ 41*0bc24d83SChangpeng Liu #define VHOST_USER_MAX_CONFIG_SIZE 256 42*0bc24d83SChangpeng 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, 517b2e5c65SMarc-André Lureau 527b2e5c65SMarc-André Lureau VHOST_USER_PROTOCOL_F_MAX 537b2e5c65SMarc-André Lureau }; 547b2e5c65SMarc-André Lureau 557b2e5c65SMarc-André Lureau #define VHOST_USER_PROTOCOL_FEATURE_MASK ((1 << VHOST_USER_PROTOCOL_F_MAX) - 1) 567b2e5c65SMarc-André Lureau 577b2e5c65SMarc-André Lureau typedef enum VhostUserRequest { 587b2e5c65SMarc-André Lureau VHOST_USER_NONE = 0, 597b2e5c65SMarc-André Lureau VHOST_USER_GET_FEATURES = 1, 607b2e5c65SMarc-André Lureau VHOST_USER_SET_FEATURES = 2, 617b2e5c65SMarc-André Lureau VHOST_USER_SET_OWNER = 3, 627b2e5c65SMarc-André Lureau VHOST_USER_RESET_OWNER = 4, 637b2e5c65SMarc-André Lureau VHOST_USER_SET_MEM_TABLE = 5, 647b2e5c65SMarc-André Lureau VHOST_USER_SET_LOG_BASE = 6, 657b2e5c65SMarc-André Lureau VHOST_USER_SET_LOG_FD = 7, 667b2e5c65SMarc-André Lureau VHOST_USER_SET_VRING_NUM = 8, 677b2e5c65SMarc-André Lureau VHOST_USER_SET_VRING_ADDR = 9, 687b2e5c65SMarc-André Lureau VHOST_USER_SET_VRING_BASE = 10, 697b2e5c65SMarc-André Lureau VHOST_USER_GET_VRING_BASE = 11, 707b2e5c65SMarc-André Lureau VHOST_USER_SET_VRING_KICK = 12, 717b2e5c65SMarc-André Lureau VHOST_USER_SET_VRING_CALL = 13, 727b2e5c65SMarc-André Lureau VHOST_USER_SET_VRING_ERR = 14, 737b2e5c65SMarc-André Lureau VHOST_USER_GET_PROTOCOL_FEATURES = 15, 747b2e5c65SMarc-André Lureau VHOST_USER_SET_PROTOCOL_FEATURES = 16, 757b2e5c65SMarc-André Lureau VHOST_USER_GET_QUEUE_NUM = 17, 767b2e5c65SMarc-André Lureau VHOST_USER_SET_VRING_ENABLE = 18, 777b2e5c65SMarc-André Lureau VHOST_USER_SEND_RARP = 19, 78ea642e22SDr. David Alan Gilbert VHOST_USER_NET_SET_MTU = 20, 79ea642e22SDr. David Alan Gilbert VHOST_USER_SET_SLAVE_REQ_FD = 21, 80ea642e22SDr. David Alan Gilbert VHOST_USER_IOTLB_MSG = 22, 81ea642e22SDr. David Alan Gilbert VHOST_USER_SET_VRING_ENDIAN = 23, 82*0bc24d83SChangpeng Liu VHOST_USER_GET_CONFIG = 24, 83*0bc24d83SChangpeng Liu VHOST_USER_SET_CONFIG = 25, 847b2e5c65SMarc-André Lureau VHOST_USER_MAX 857b2e5c65SMarc-André Lureau } VhostUserRequest; 867b2e5c65SMarc-André Lureau 877b2e5c65SMarc-André Lureau typedef struct VhostUserMemoryRegion { 887b2e5c65SMarc-André Lureau uint64_t guest_phys_addr; 897b2e5c65SMarc-André Lureau uint64_t memory_size; 907b2e5c65SMarc-André Lureau uint64_t userspace_addr; 917b2e5c65SMarc-André Lureau uint64_t mmap_offset; 927b2e5c65SMarc-André Lureau } VhostUserMemoryRegion; 937b2e5c65SMarc-André Lureau 947b2e5c65SMarc-André Lureau typedef struct VhostUserMemory { 957b2e5c65SMarc-André Lureau uint32_t nregions; 967b2e5c65SMarc-André Lureau uint32_t padding; 977b2e5c65SMarc-André Lureau VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS]; 987b2e5c65SMarc-André Lureau } VhostUserMemory; 997b2e5c65SMarc-André Lureau 1007b2e5c65SMarc-André Lureau typedef struct VhostUserLog { 1017b2e5c65SMarc-André Lureau uint64_t mmap_size; 1027b2e5c65SMarc-André Lureau uint64_t mmap_offset; 1037b2e5c65SMarc-André Lureau } VhostUserLog; 1047b2e5c65SMarc-André Lureau 105*0bc24d83SChangpeng Liu typedef struct VhostUserConfig { 106*0bc24d83SChangpeng Liu uint32_t offset; 107*0bc24d83SChangpeng Liu uint32_t size; 108*0bc24d83SChangpeng Liu uint32_t flags; 109*0bc24d83SChangpeng Liu uint8_t region[VHOST_USER_MAX_CONFIG_SIZE]; 110*0bc24d83SChangpeng Liu } VhostUserConfig; 111*0bc24d83SChangpeng Liu 112*0bc24d83SChangpeng Liu static VhostUserConfig c __attribute__ ((unused)); 113*0bc24d83SChangpeng Liu #define VHOST_USER_CONFIG_HDR_SIZE (sizeof(c.offset) \ 114*0bc24d83SChangpeng Liu + sizeof(c.size) \ 115*0bc24d83SChangpeng Liu + sizeof(c.flags)) 116*0bc24d83SChangpeng Liu 1177b2e5c65SMarc-André Lureau #if defined(_WIN32) 1187b2e5c65SMarc-André Lureau # define VU_PACKED __attribute__((gcc_struct, packed)) 1197b2e5c65SMarc-André Lureau #else 1207b2e5c65SMarc-André Lureau # define VU_PACKED __attribute__((packed)) 1217b2e5c65SMarc-André Lureau #endif 1227b2e5c65SMarc-André Lureau 1237b2e5c65SMarc-André Lureau typedef struct VhostUserMsg { 1247b2e5c65SMarc-André Lureau VhostUserRequest request; 1257b2e5c65SMarc-André Lureau 1267b2e5c65SMarc-André Lureau #define VHOST_USER_VERSION_MASK (0x3) 1277b2e5c65SMarc-André Lureau #define VHOST_USER_REPLY_MASK (0x1 << 2) 1287b2e5c65SMarc-André Lureau uint32_t flags; 1297b2e5c65SMarc-André Lureau uint32_t size; /* the following payload size */ 1307b2e5c65SMarc-André Lureau 1317b2e5c65SMarc-André Lureau union { 1327b2e5c65SMarc-André Lureau #define VHOST_USER_VRING_IDX_MASK (0xff) 1337b2e5c65SMarc-André Lureau #define VHOST_USER_VRING_NOFD_MASK (0x1 << 8) 1347b2e5c65SMarc-André Lureau uint64_t u64; 1357b2e5c65SMarc-André Lureau struct vhost_vring_state state; 1367b2e5c65SMarc-André Lureau struct vhost_vring_addr addr; 1377b2e5c65SMarc-André Lureau VhostUserMemory memory; 1387b2e5c65SMarc-André Lureau VhostUserLog log; 139*0bc24d83SChangpeng Liu VhostUserConfig config; 1407b2e5c65SMarc-André Lureau } payload; 1417b2e5c65SMarc-André Lureau 1427b2e5c65SMarc-André Lureau int fds[VHOST_MEMORY_MAX_NREGIONS]; 1437b2e5c65SMarc-André Lureau int fd_num; 1447b2e5c65SMarc-André Lureau uint8_t *data; 1457b2e5c65SMarc-André Lureau } VU_PACKED VhostUserMsg; 1467b2e5c65SMarc-André Lureau 1477b2e5c65SMarc-André Lureau typedef struct VuDevRegion { 1487b2e5c65SMarc-André Lureau /* Guest Physical address. */ 1497b2e5c65SMarc-André Lureau uint64_t gpa; 1507b2e5c65SMarc-André Lureau /* Memory region size. */ 1517b2e5c65SMarc-André Lureau uint64_t size; 1527b2e5c65SMarc-André Lureau /* QEMU virtual address (userspace). */ 1537b2e5c65SMarc-André Lureau uint64_t qva; 1547b2e5c65SMarc-André Lureau /* Starting offset in our mmaped space. */ 1557b2e5c65SMarc-André Lureau uint64_t mmap_offset; 1567b2e5c65SMarc-André Lureau /* Start address of mmaped space. */ 1577b2e5c65SMarc-André Lureau uint64_t mmap_addr; 1587b2e5c65SMarc-André Lureau } VuDevRegion; 1597b2e5c65SMarc-André Lureau 1607b2e5c65SMarc-André Lureau typedef struct VuDev VuDev; 1617b2e5c65SMarc-André Lureau 1627b2e5c65SMarc-André Lureau typedef uint64_t (*vu_get_features_cb) (VuDev *dev); 1637b2e5c65SMarc-André Lureau typedef void (*vu_set_features_cb) (VuDev *dev, uint64_t features); 1647b2e5c65SMarc-André Lureau typedef int (*vu_process_msg_cb) (VuDev *dev, VhostUserMsg *vmsg, 1657b2e5c65SMarc-André Lureau int *do_reply); 1667b2e5c65SMarc-André Lureau typedef void (*vu_queue_set_started_cb) (VuDev *dev, int qidx, bool started); 16735480cbfSMarc-André Lureau typedef bool (*vu_queue_is_processed_in_order_cb) (VuDev *dev, int qidx); 168*0bc24d83SChangpeng Liu typedef int (*vu_get_config_cb) (VuDev *dev, uint8_t *config, uint32_t len); 169*0bc24d83SChangpeng Liu typedef int (*vu_set_config_cb) (VuDev *dev, const uint8_t *data, 170*0bc24d83SChangpeng Liu uint32_t offset, uint32_t size, 171*0bc24d83SChangpeng Liu uint32_t flags); 1727b2e5c65SMarc-André Lureau 1737b2e5c65SMarc-André Lureau typedef struct VuDevIface { 1747b2e5c65SMarc-André Lureau /* called by VHOST_USER_GET_FEATURES to get the features bitmask */ 1757b2e5c65SMarc-André Lureau vu_get_features_cb get_features; 1767b2e5c65SMarc-André Lureau /* enable vhost implementation features */ 1777b2e5c65SMarc-André Lureau vu_set_features_cb set_features; 1787b2e5c65SMarc-André Lureau /* get the protocol feature bitmask from the underlying vhost 1797b2e5c65SMarc-André Lureau * implementation */ 1807b2e5c65SMarc-André Lureau vu_get_features_cb get_protocol_features; 1817b2e5c65SMarc-André Lureau /* enable protocol features in the underlying vhost implementation. */ 1827b2e5c65SMarc-André Lureau vu_set_features_cb set_protocol_features; 1837b2e5c65SMarc-André Lureau /* process_msg is called for each vhost-user message received */ 1847b2e5c65SMarc-André Lureau /* skip libvhost-user processing if return value != 0 */ 1857b2e5c65SMarc-André Lureau vu_process_msg_cb process_msg; 1867b2e5c65SMarc-André Lureau /* tells when queues can be processed */ 1877b2e5c65SMarc-André Lureau vu_queue_set_started_cb queue_set_started; 18835480cbfSMarc-André Lureau /* 18935480cbfSMarc-André Lureau * If the queue is processed in order, in which case it will be 19035480cbfSMarc-André Lureau * resumed to vring.used->idx. This can help to support resuming 19135480cbfSMarc-André Lureau * on unmanaged exit/crash. 19235480cbfSMarc-André Lureau */ 19335480cbfSMarc-André Lureau vu_queue_is_processed_in_order_cb queue_is_processed_in_order; 194*0bc24d83SChangpeng Liu /* get the config space of the device */ 195*0bc24d83SChangpeng Liu vu_get_config_cb get_config; 196*0bc24d83SChangpeng Liu /* set the config space of the device */ 197*0bc24d83SChangpeng Liu vu_set_config_cb set_config; 1987b2e5c65SMarc-André Lureau } VuDevIface; 1997b2e5c65SMarc-André Lureau 2007b2e5c65SMarc-André Lureau typedef void (*vu_queue_handler_cb) (VuDev *dev, int qidx); 2017b2e5c65SMarc-André Lureau 2027b2e5c65SMarc-André Lureau typedef struct VuRing { 2037b2e5c65SMarc-André Lureau unsigned int num; 2047b2e5c65SMarc-André Lureau struct vring_desc *desc; 2057b2e5c65SMarc-André Lureau struct vring_avail *avail; 2067b2e5c65SMarc-André Lureau struct vring_used *used; 2077b2e5c65SMarc-André Lureau uint64_t log_guest_addr; 2087b2e5c65SMarc-André Lureau uint32_t flags; 2097b2e5c65SMarc-André Lureau } VuRing; 2107b2e5c65SMarc-André Lureau 2117b2e5c65SMarc-André Lureau typedef struct VuVirtq { 2127b2e5c65SMarc-André Lureau VuRing vring; 2137b2e5c65SMarc-André Lureau 2147b2e5c65SMarc-André Lureau /* Next head to pop */ 2157b2e5c65SMarc-André Lureau uint16_t last_avail_idx; 2167b2e5c65SMarc-André Lureau 2177b2e5c65SMarc-André Lureau /* Last avail_idx read from VQ. */ 2187b2e5c65SMarc-André Lureau uint16_t shadow_avail_idx; 2197b2e5c65SMarc-André Lureau 2207b2e5c65SMarc-André Lureau uint16_t used_idx; 2217b2e5c65SMarc-André Lureau 2227b2e5c65SMarc-André Lureau /* Last used index value we have signalled on */ 2237b2e5c65SMarc-André Lureau uint16_t signalled_used; 2247b2e5c65SMarc-André Lureau 2257b2e5c65SMarc-André Lureau /* Last used index value we have signalled on */ 2267b2e5c65SMarc-André Lureau bool signalled_used_valid; 2277b2e5c65SMarc-André Lureau 2287b2e5c65SMarc-André Lureau /* Notification enabled? */ 2297b2e5c65SMarc-André Lureau bool notification; 2307b2e5c65SMarc-André Lureau 2317b2e5c65SMarc-André Lureau int inuse; 2327b2e5c65SMarc-André Lureau 2337b2e5c65SMarc-André Lureau vu_queue_handler_cb handler; 2347b2e5c65SMarc-André Lureau 2357b2e5c65SMarc-André Lureau int call_fd; 2367b2e5c65SMarc-André Lureau int kick_fd; 2377b2e5c65SMarc-André Lureau int err_fd; 2387b2e5c65SMarc-André Lureau unsigned int enable; 2397b2e5c65SMarc-André Lureau bool started; 2407b2e5c65SMarc-André Lureau } VuVirtq; 2417b2e5c65SMarc-André Lureau 2427b2e5c65SMarc-André Lureau enum VuWatchCondtion { 24349cc0340SFelipe Franciosi VU_WATCH_IN = POLLIN, 24449cc0340SFelipe Franciosi VU_WATCH_OUT = POLLOUT, 24549cc0340SFelipe Franciosi VU_WATCH_PRI = POLLPRI, 24649cc0340SFelipe Franciosi VU_WATCH_ERR = POLLERR, 24749cc0340SFelipe Franciosi VU_WATCH_HUP = POLLHUP, 2487b2e5c65SMarc-André Lureau }; 2497b2e5c65SMarc-André Lureau 2507b2e5c65SMarc-André Lureau typedef void (*vu_panic_cb) (VuDev *dev, const char *err); 2517b2e5c65SMarc-André Lureau typedef void (*vu_watch_cb) (VuDev *dev, int condition, void *data); 2527b2e5c65SMarc-André Lureau typedef void (*vu_set_watch_cb) (VuDev *dev, int fd, int condition, 2537b2e5c65SMarc-André Lureau vu_watch_cb cb, void *data); 2547b2e5c65SMarc-André Lureau typedef void (*vu_remove_watch_cb) (VuDev *dev, int fd); 2557b2e5c65SMarc-André Lureau 2567b2e5c65SMarc-André Lureau struct VuDev { 2577b2e5c65SMarc-André Lureau int sock; 2587b2e5c65SMarc-André Lureau uint32_t nregions; 2597b2e5c65SMarc-André Lureau VuDevRegion regions[VHOST_MEMORY_MAX_NREGIONS]; 2607b2e5c65SMarc-André Lureau VuVirtq vq[VHOST_MAX_NR_VIRTQUEUE]; 2617b2e5c65SMarc-André Lureau int log_call_fd; 26213384f15SDr. David Alan Gilbert int slave_fd; 2637b2e5c65SMarc-André Lureau uint64_t log_size; 2647b2e5c65SMarc-André Lureau uint8_t *log_table; 2657b2e5c65SMarc-André Lureau uint64_t features; 2667b2e5c65SMarc-André Lureau uint64_t protocol_features; 2677b2e5c65SMarc-André Lureau bool broken; 2687b2e5c65SMarc-André Lureau 2697b2e5c65SMarc-André Lureau /* @set_watch: add or update the given fd to the watch set, 2707b2e5c65SMarc-André Lureau * call cb when condition is met */ 2717b2e5c65SMarc-André Lureau vu_set_watch_cb set_watch; 2727b2e5c65SMarc-André Lureau 2737b2e5c65SMarc-André Lureau /* @remove_watch: remove the given fd from the watch set */ 2747b2e5c65SMarc-André Lureau vu_remove_watch_cb remove_watch; 2757b2e5c65SMarc-André Lureau 2767b2e5c65SMarc-André Lureau /* @panic: encountered an unrecoverable error, you may try to 2777b2e5c65SMarc-André Lureau * re-initialize */ 2787b2e5c65SMarc-André Lureau vu_panic_cb panic; 2797b2e5c65SMarc-André Lureau const VuDevIface *iface; 2807b2e5c65SMarc-André Lureau }; 2817b2e5c65SMarc-André Lureau 2827b2e5c65SMarc-André Lureau typedef struct VuVirtqElement { 2837b2e5c65SMarc-André Lureau unsigned int index; 2847b2e5c65SMarc-André Lureau unsigned int out_num; 2857b2e5c65SMarc-André Lureau unsigned int in_num; 2867b2e5c65SMarc-André Lureau struct iovec *in_sg; 2877b2e5c65SMarc-André Lureau struct iovec *out_sg; 2887b2e5c65SMarc-André Lureau } VuVirtqElement; 2897b2e5c65SMarc-André Lureau 2907b2e5c65SMarc-André Lureau /** 2917b2e5c65SMarc-André Lureau * vu_init: 2927b2e5c65SMarc-André Lureau * @dev: a VuDev context 2937b2e5c65SMarc-André Lureau * @socket: the socket connected to vhost-user master 2947b2e5c65SMarc-André Lureau * @panic: a panic callback 2957b2e5c65SMarc-André Lureau * @set_watch: a set_watch callback 2967b2e5c65SMarc-André Lureau * @remove_watch: a remove_watch callback 2977b2e5c65SMarc-André Lureau * @iface: a VuDevIface structure with vhost-user device callbacks 2987b2e5c65SMarc-André Lureau * 2997b2e5c65SMarc-André Lureau * Intializes a VuDev vhost-user context. 3007b2e5c65SMarc-André Lureau **/ 3017b2e5c65SMarc-André Lureau void vu_init(VuDev *dev, 3027b2e5c65SMarc-André Lureau int socket, 3037b2e5c65SMarc-André Lureau vu_panic_cb panic, 3047b2e5c65SMarc-André Lureau vu_set_watch_cb set_watch, 3057b2e5c65SMarc-André Lureau vu_remove_watch_cb remove_watch, 3067b2e5c65SMarc-André Lureau const VuDevIface *iface); 3077b2e5c65SMarc-André Lureau 3087b2e5c65SMarc-André Lureau 3097b2e5c65SMarc-André Lureau /** 3107b2e5c65SMarc-André Lureau * vu_deinit: 3117b2e5c65SMarc-André Lureau * @dev: a VuDev context 3127b2e5c65SMarc-André Lureau * 3137b2e5c65SMarc-André Lureau * Cleans up the VuDev context 3147b2e5c65SMarc-André Lureau */ 3157b2e5c65SMarc-André Lureau void vu_deinit(VuDev *dev); 3167b2e5c65SMarc-André Lureau 3177b2e5c65SMarc-André Lureau /** 3187b2e5c65SMarc-André Lureau * vu_dispatch: 3197b2e5c65SMarc-André Lureau * @dev: a VuDev context 3207b2e5c65SMarc-André Lureau * 3217b2e5c65SMarc-André Lureau * Process one vhost-user message. 3227b2e5c65SMarc-André Lureau * 3237b2e5c65SMarc-André Lureau * Returns: TRUE on success, FALSE on failure. 3247b2e5c65SMarc-André Lureau */ 3257b2e5c65SMarc-André Lureau bool vu_dispatch(VuDev *dev); 3267b2e5c65SMarc-André Lureau 3277b2e5c65SMarc-André Lureau /** 3287b2e5c65SMarc-André Lureau * vu_gpa_to_va: 3297b2e5c65SMarc-André Lureau * @dev: a VuDev context 3307b2e5c65SMarc-André Lureau * @guest_addr: guest address 3317b2e5c65SMarc-André Lureau * 3327b2e5c65SMarc-André Lureau * Translate a guest address to a pointer. Returns NULL on failure. 3337b2e5c65SMarc-André Lureau */ 3347b2e5c65SMarc-André Lureau void *vu_gpa_to_va(VuDev *dev, uint64_t guest_addr); 3357b2e5c65SMarc-André Lureau 3367b2e5c65SMarc-André Lureau /** 3377b2e5c65SMarc-André Lureau * vu_get_queue: 3387b2e5c65SMarc-André Lureau * @dev: a VuDev context 3397b2e5c65SMarc-André Lureau * @qidx: queue index 3407b2e5c65SMarc-André Lureau * 3417b2e5c65SMarc-André Lureau * Returns the queue number @qidx. 3427b2e5c65SMarc-André Lureau */ 3437b2e5c65SMarc-André Lureau VuVirtq *vu_get_queue(VuDev *dev, int qidx); 3447b2e5c65SMarc-André Lureau 3457b2e5c65SMarc-André Lureau /** 3467b2e5c65SMarc-André Lureau * vu_set_queue_handler: 3477b2e5c65SMarc-André Lureau * @dev: a VuDev context 3487b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 3497b2e5c65SMarc-André Lureau * @handler: the queue handler callback 3507b2e5c65SMarc-André Lureau * 3517b2e5c65SMarc-André Lureau * Set the queue handler. This function may be called several times 3527b2e5c65SMarc-André Lureau * for the same queue. If called with NULL @handler, the handler is 3537b2e5c65SMarc-André Lureau * removed. 3547b2e5c65SMarc-André Lureau */ 3557b2e5c65SMarc-André Lureau void vu_set_queue_handler(VuDev *dev, VuVirtq *vq, 3567b2e5c65SMarc-André Lureau vu_queue_handler_cb handler); 3577b2e5c65SMarc-André Lureau 3587b2e5c65SMarc-André Lureau 3597b2e5c65SMarc-André Lureau /** 3607b2e5c65SMarc-André Lureau * vu_queue_set_notification: 3617b2e5c65SMarc-André Lureau * @dev: a VuDev context 3627b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 3637b2e5c65SMarc-André Lureau * @enable: state 3647b2e5c65SMarc-André Lureau * 3657b2e5c65SMarc-André Lureau * Set whether the queue notifies (via event index or interrupt) 3667b2e5c65SMarc-André Lureau */ 3677b2e5c65SMarc-André Lureau void vu_queue_set_notification(VuDev *dev, VuVirtq *vq, int enable); 3687b2e5c65SMarc-André Lureau 3697b2e5c65SMarc-André Lureau /** 3707b2e5c65SMarc-André Lureau * vu_queue_enabled: 3717b2e5c65SMarc-André Lureau * @dev: a VuDev context 3727b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 3737b2e5c65SMarc-André Lureau * 3747b2e5c65SMarc-André Lureau * Returns: whether the queue is enabled. 3757b2e5c65SMarc-André Lureau */ 3767b2e5c65SMarc-André Lureau bool vu_queue_enabled(VuDev *dev, VuVirtq *vq); 3777b2e5c65SMarc-André Lureau 3787b2e5c65SMarc-André Lureau /** 379bcf0836dSDr. David Alan Gilbert * vu_queue_started: 380bcf0836dSDr. David Alan Gilbert * @dev: a VuDev context 381bcf0836dSDr. David Alan Gilbert * @vq: a VuVirtq queue 382bcf0836dSDr. David Alan Gilbert * 383bcf0836dSDr. David Alan Gilbert * Returns: whether the queue is started. 384bcf0836dSDr. David Alan Gilbert */ 385bcf0836dSDr. David Alan Gilbert bool vu_queue_started(const VuDev *dev, const VuVirtq *vq); 386bcf0836dSDr. David Alan Gilbert 387bcf0836dSDr. David Alan Gilbert /** 388640601c7SMarc-André Lureau * vu_queue_empty: 3897b2e5c65SMarc-André Lureau * @dev: a VuDev context 3907b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 3917b2e5c65SMarc-André Lureau * 392640601c7SMarc-André Lureau * Returns: true if the queue is empty or not ready. 3937b2e5c65SMarc-André Lureau */ 394640601c7SMarc-André Lureau bool vu_queue_empty(VuDev *dev, VuVirtq *vq); 3957b2e5c65SMarc-André Lureau 3967b2e5c65SMarc-André Lureau /** 3977b2e5c65SMarc-André Lureau * vu_queue_notify: 3987b2e5c65SMarc-André Lureau * @dev: a VuDev context 3997b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 4007b2e5c65SMarc-André Lureau * 4017b2e5c65SMarc-André Lureau * Request to notify the queue via callfd (skipped if unnecessary) 4027b2e5c65SMarc-André Lureau */ 4037b2e5c65SMarc-André Lureau void vu_queue_notify(VuDev *dev, VuVirtq *vq); 4047b2e5c65SMarc-André Lureau 4057b2e5c65SMarc-André Lureau /** 4067b2e5c65SMarc-André Lureau * vu_queue_pop: 4077b2e5c65SMarc-André Lureau * @dev: a VuDev context 4087b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 4097b2e5c65SMarc-André Lureau * @sz: the size of struct to return (must be >= VuVirtqElement) 4107b2e5c65SMarc-André Lureau * 41119409df8SMarc-André Lureau * Returns: a VuVirtqElement filled from the queue or NULL. The 41219409df8SMarc-André Lureau * returned element must be free()-d by the caller. 4137b2e5c65SMarc-André Lureau */ 4147b2e5c65SMarc-André Lureau void *vu_queue_pop(VuDev *dev, VuVirtq *vq, size_t sz); 4157b2e5c65SMarc-André Lureau 4167b2e5c65SMarc-André Lureau /** 4177b2e5c65SMarc-André Lureau * vu_queue_rewind: 4187b2e5c65SMarc-André Lureau * @dev: a VuDev context 4197b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 4207b2e5c65SMarc-André Lureau * @num: number of elements to push back 4217b2e5c65SMarc-André Lureau * 4227b2e5c65SMarc-André Lureau * Pretend that elements weren't popped from the virtqueue. The next 4237b2e5c65SMarc-André Lureau * virtqueue_pop() will refetch the oldest element. 4247b2e5c65SMarc-André Lureau * 4257b2e5c65SMarc-André Lureau * Returns: true on success, false if @num is greater than the number of in use 4267b2e5c65SMarc-André Lureau * elements. 4277b2e5c65SMarc-André Lureau */ 4287b2e5c65SMarc-André Lureau bool vu_queue_rewind(VuDev *dev, VuVirtq *vq, unsigned int num); 4297b2e5c65SMarc-André Lureau 4307b2e5c65SMarc-André Lureau /** 4317b2e5c65SMarc-André Lureau * vu_queue_fill: 4327b2e5c65SMarc-André Lureau * @dev: a VuDev context 4337b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 4347b2e5c65SMarc-André Lureau * @elem: a VuVirtqElement 4357b2e5c65SMarc-André Lureau * @len: length in bytes to write 4367b2e5c65SMarc-André Lureau * @idx: optional offset for the used ring index (0 in general) 4377b2e5c65SMarc-André Lureau * 4387b2e5c65SMarc-André Lureau * Fill the used ring with @elem element. 4397b2e5c65SMarc-André Lureau */ 4407b2e5c65SMarc-André Lureau void vu_queue_fill(VuDev *dev, VuVirtq *vq, 4417b2e5c65SMarc-André Lureau const VuVirtqElement *elem, 4427b2e5c65SMarc-André Lureau unsigned int len, unsigned int idx); 4437b2e5c65SMarc-André Lureau 4447b2e5c65SMarc-André Lureau /** 4457b2e5c65SMarc-André Lureau * vu_queue_push: 4467b2e5c65SMarc-André Lureau * @dev: a VuDev context 4477b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 4487b2e5c65SMarc-André Lureau * @elem: a VuVirtqElement 4497b2e5c65SMarc-André Lureau * @len: length in bytes to write 4507b2e5c65SMarc-André Lureau * 4517b2e5c65SMarc-André Lureau * Helper that combines vu_queue_fill() with a vu_queue_flush(). 4527b2e5c65SMarc-André Lureau */ 4537b2e5c65SMarc-André Lureau void vu_queue_push(VuDev *dev, VuVirtq *vq, 4547b2e5c65SMarc-André Lureau const VuVirtqElement *elem, unsigned int len); 4557b2e5c65SMarc-André Lureau 4567b2e5c65SMarc-André Lureau /** 4577b2e5c65SMarc-André Lureau * vu_queue_flush: 4587b2e5c65SMarc-André Lureau * @dev: a VuDev context 4597b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 4607b2e5c65SMarc-André Lureau * @num: number of elements to flush 4617b2e5c65SMarc-André Lureau * 4627b2e5c65SMarc-André Lureau * Mark the last number of elements as done (used.idx is updated by 4637b2e5c65SMarc-André Lureau * num elements). 4647b2e5c65SMarc-André Lureau */ 4657b2e5c65SMarc-André Lureau void vu_queue_flush(VuDev *dev, VuVirtq *vq, unsigned int num); 4667b2e5c65SMarc-André Lureau 4677b2e5c65SMarc-André Lureau /** 4687b2e5c65SMarc-André Lureau * vu_queue_get_avail_bytes: 4697b2e5c65SMarc-André Lureau * @dev: a VuDev context 4707b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 4717b2e5c65SMarc-André Lureau * @in_bytes: in bytes 4727b2e5c65SMarc-André Lureau * @out_bytes: out bytes 4737b2e5c65SMarc-André Lureau * @max_in_bytes: stop counting after max_in_bytes 4747b2e5c65SMarc-André Lureau * @max_out_bytes: stop counting after max_out_bytes 4757b2e5c65SMarc-André Lureau * 4767b2e5c65SMarc-André Lureau * Count the number of available bytes, up to max_in_bytes/max_out_bytes. 4777b2e5c65SMarc-André Lureau */ 4787b2e5c65SMarc-André Lureau void vu_queue_get_avail_bytes(VuDev *vdev, VuVirtq *vq, unsigned int *in_bytes, 4797b2e5c65SMarc-André Lureau unsigned int *out_bytes, 4807b2e5c65SMarc-André Lureau unsigned max_in_bytes, unsigned max_out_bytes); 4817b2e5c65SMarc-André Lureau 4827b2e5c65SMarc-André Lureau /** 4837b2e5c65SMarc-André Lureau * vu_queue_avail_bytes: 4847b2e5c65SMarc-André Lureau * @dev: a VuDev context 4857b2e5c65SMarc-André Lureau * @vq: a VuVirtq queue 4867b2e5c65SMarc-André Lureau * @in_bytes: expected in bytes 4877b2e5c65SMarc-André Lureau * @out_bytes: expected out bytes 4887b2e5c65SMarc-André Lureau * 4897b2e5c65SMarc-André Lureau * Returns: true if in_bytes <= in_total && out_bytes <= out_total 4907b2e5c65SMarc-André Lureau */ 4917b2e5c65SMarc-André Lureau bool vu_queue_avail_bytes(VuDev *dev, VuVirtq *vq, unsigned int in_bytes, 4927b2e5c65SMarc-André Lureau unsigned int out_bytes); 4937b2e5c65SMarc-André Lureau 4947b2e5c65SMarc-André Lureau #endif /* LIBVHOST_USER_H */ 495