drivers/net/virtio/virtio_user/vhost.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2016 Intel Corporation
   3  */
   4
   5 #ifndef _VIRTIO_USER_VHOST_H
   6 #define _VIRTIO_USER_VHOST_H
   7
   8 #include <stdint.h>
   9 #include <linux/types.h>
  10 #include <linux/ioctl.h>
  11
  12 #include <rte_errno.h>
  13
  14 #include "../virtio.h"
  15 #include "../virtio_logs.h"
  16 #include "../virtqueue.h"
  17
  18 struct vhost_vring_state {
  19         unsigned int index;
  20         unsigned int num;
  21 };
  22
  23 struct vhost_vring_file {
  24         unsigned int index;
  25         int fd;
  26 };
  27
  28 struct vhost_vring_addr {
  29         unsigned int index;
  30         /* Option flags. */
  31         unsigned int flags;
  32         /* Flag values: */
  33         /* Whether log address is valid. If set enables logging. */
  34 #define VHOST_VRING_F_LOG 0
  35
  36         /* Start of array of descriptors (virtually contiguous) */
  37         uint64_t desc_user_addr;
  38         /* Used structure address. Must be 32 bit aligned */
  39         uint64_t used_user_addr;
  40         /* Available structure address. Must be 16 bit aligned */
  41         uint64_t avail_user_addr;
  42         /* Logging support. */
  43         /* Log writes to used structure, at offset calculated from specified
  44          * address. Address must be 32 bit aligned.
  45          */
  46         uint64_t log_guest_addr;
  47 };
  48
  49 #ifndef VHOST_USER_F_PROTOCOL_FEATURES
  50 #define VHOST_USER_F_PROTOCOL_FEATURES 30
  51 #endif
  52
  53 /** Protocol features. */
  54 #ifndef VHOST_USER_PROTOCOL_F_MQ
  55 #define VHOST_USER_PROTOCOL_F_MQ 0
  56 #endif
  57
  58 #ifndef VHOST_USER_PROTOCOL_F_REPLY_ACK
  59 #define VHOST_USER_PROTOCOL_F_REPLY_ACK 3
  60 #endif
  61
  62 #ifndef VHOST_USER_PROTOCOL_F_STATUS
  63 #define VHOST_USER_PROTOCOL_F_STATUS 16
  64 #endif
  65
  66 #ifndef VHOST_BACKEND_F_IOTLB_MSG_V2
  67 #define VHOST_BACKEND_F_IOTLB_MSG_V2 1
  68 #endif
  69
  70 #ifndef VHOST_BACKEND_F_IOTLB_BATCH
  71 #define VHOST_BACKEND_F_IOTLB_BATCH 2
  72 #endif
  73
  74 struct vhost_memory_region {
  75         uint64_t guest_phys_addr;
  76         uint64_t memory_size; /* bytes */
  77         uint64_t userspace_addr;
  78         uint64_t mmap_offset;
  79 };
  80
  81 struct virtio_user_dev;
  82
  83 struct virtio_user_backend_ops {
  84         int (*setup)(struct virtio_user_dev *dev);
  85         int (*set_owner)(struct virtio_user_dev *dev);
  86         int (*get_features)(struct virtio_user_dev *dev, uint64_t *features);
  87         int (*set_features)(struct virtio_user_dev *dev, uint64_t features);
  88         int (*get_protocol_features)(struct virtio_user_dev *dev, uint64_t *features);
  89         int (*set_protocol_features)(struct virtio_user_dev *dev, uint64_t features);
  90         int (*set_memory_table)(struct virtio_user_dev *dev);
  91         int (*set_vring_num)(struct virtio_user_dev *dev, struct vhost_vring_state *state);
  92         int (*set_vring_base)(struct virtio_user_dev *dev, struct vhost_vring_state *state);
  93         int (*get_vring_base)(struct virtio_user_dev *dev, struct vhost_vring_state *state);
  94         int (*set_vring_call)(struct virtio_user_dev *dev, struct vhost_vring_file *file);
  95         int (*set_vring_kick)(struct virtio_user_dev *dev, struct vhost_vring_file *file);
  96         int (*set_vring_addr)(struct virtio_user_dev *dev, struct vhost_vring_addr *addr);
  97         int (*get_status)(struct virtio_user_dev *dev, uint8_t *status);
  98         int (*set_status)(struct virtio_user_dev *dev, uint8_t status);
  99         int (*enable_qp)(struct virtio_user_dev *dev, uint16_t pair_idx, int enable);
 100         int (*dma_map)(struct virtio_user_dev *dev, void *addr, uint64_t iova, size_t len);
 101         int (*dma_unmap)(struct virtio_user_dev *dev, void *addr, uint64_t iova, size_t len);
 102 };
 103
 104 extern struct virtio_user_backend_ops virtio_ops_user;
 105 extern struct virtio_user_backend_ops virtio_ops_kernel;
 106 extern struct virtio_user_backend_ops virtio_ops_vdpa;
 107
 108 #endif