lib/librte_vhost/vhost_user.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2018 Intel Corporation
   3  */
   4
   5 #ifndef _VHOST_NET_USER_H
   6 #define _VHOST_NET_USER_H
   7
   8 #include <stdint.h>
   9 #include <linux/vhost.h>
  10
  11 #include "rte_vhost.h"
  12
  13 /* refer to hw/virtio/vhost-user.c */
  14
  15 #define VHOST_MEMORY_MAX_NREGIONS 8
  16
  17 #define VHOST_USER_PROTOCOL_FEATURES    ((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \
  18                                          (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |\
  19                                          (1ULL << VHOST_USER_PROTOCOL_F_RARP) | \
  20                                          (1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK) | \
  21                                          (1ULL << VHOST_USER_PROTOCOL_F_NET_MTU) | \
  22                                          (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_REQ) | \
  23                                          (1ULL << VHOST_USER_PROTOCOL_F_CRYPTO_SESSION) | \
  24                                          (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD) | \
  25                                          (1ULL << VHOST_USER_PROTOCOL_F_HOST_NOTIFIER))
  26
  27 typedef enum VhostUserRequest {
  28         VHOST_USER_NONE = 0,
  29         VHOST_USER_GET_FEATURES = 1,
  30         VHOST_USER_SET_FEATURES = 2,
  31         VHOST_USER_SET_OWNER = 3,
  32         VHOST_USER_RESET_OWNER = 4,
  33         VHOST_USER_SET_MEM_TABLE = 5,
  34         VHOST_USER_SET_LOG_BASE = 6,
  35         VHOST_USER_SET_LOG_FD = 7,
  36         VHOST_USER_SET_VRING_NUM = 8,
  37         VHOST_USER_SET_VRING_ADDR = 9,
  38         VHOST_USER_SET_VRING_BASE = 10,
  39         VHOST_USER_GET_VRING_BASE = 11,
  40         VHOST_USER_SET_VRING_KICK = 12,
  41         VHOST_USER_SET_VRING_CALL = 13,
  42         VHOST_USER_SET_VRING_ERR = 14,
  43         VHOST_USER_GET_PROTOCOL_FEATURES = 15,
  44         VHOST_USER_SET_PROTOCOL_FEATURES = 16,
  45         VHOST_USER_GET_QUEUE_NUM = 17,
  46         VHOST_USER_SET_VRING_ENABLE = 18,
  47         VHOST_USER_SEND_RARP = 19,
  48         VHOST_USER_NET_SET_MTU = 20,
  49         VHOST_USER_SET_SLAVE_REQ_FD = 21,
  50         VHOST_USER_IOTLB_MSG = 22,
  51         VHOST_USER_CRYPTO_CREATE_SESS = 26,
  52         VHOST_USER_CRYPTO_CLOSE_SESS = 27,
  53         VHOST_USER_POSTCOPY_ADVISE = 28,
  54         VHOST_USER_POSTCOPY_LISTEN = 29,
  55         VHOST_USER_MAX = 30
  56 } VhostUserRequest;
  57
  58 typedef enum VhostUserSlaveRequest {
  59         VHOST_USER_SLAVE_NONE = 0,
  60         VHOST_USER_SLAVE_IOTLB_MSG = 1,
  61         VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG = 3,
  62         VHOST_USER_SLAVE_MAX
  63 } VhostUserSlaveRequest;
  64
  65 typedef struct VhostUserMemoryRegion {
  66         uint64_t guest_phys_addr;
  67         uint64_t memory_size;
  68         uint64_t userspace_addr;
  69         uint64_t mmap_offset;
  70 } VhostUserMemoryRegion;
  71
  72 typedef struct VhostUserMemory {
  73         uint32_t nregions;
  74         uint32_t padding;
  75         VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
  76 } VhostUserMemory;
  77
  78 typedef struct VhostUserLog {
  79         uint64_t mmap_size;
  80         uint64_t mmap_offset;
  81 } VhostUserLog;
  82
  83 /* Comply with Cryptodev-Linux */
  84 #define VHOST_USER_CRYPTO_MAX_HMAC_KEY_LENGTH   512
  85 #define VHOST_USER_CRYPTO_MAX_CIPHER_KEY_LENGTH 64
  86
  87 /* Same structure as vhost-user backend session info */
  88 typedef struct VhostUserCryptoSessionParam {
  89         int64_t session_id;
  90         uint32_t op_code;
  91         uint32_t cipher_algo;
  92         uint32_t cipher_key_len;
  93         uint32_t hash_algo;
  94         uint32_t digest_len;
  95         uint32_t auth_key_len;
  96         uint32_t aad_len;
  97         uint8_t op_type;
  98         uint8_t dir;
  99         uint8_t hash_mode;
 100         uint8_t chaining_dir;
 101         uint8_t *ciphe_key;
 102         uint8_t *auth_key;
 103         uint8_t cipher_key_buf[VHOST_USER_CRYPTO_MAX_CIPHER_KEY_LENGTH];
 104         uint8_t auth_key_buf[VHOST_USER_CRYPTO_MAX_HMAC_KEY_LENGTH];
 105 } VhostUserCryptoSessionParam;
 106
 107 typedef struct VhostUserVringArea {
 108         uint64_t u64;
 109         uint64_t size;
 110         uint64_t offset;
 111 } VhostUserVringArea;
 112
 113 typedef struct VhostUserMsg {
 114         union {
 115                 uint32_t master; /* a VhostUserRequest value */
 116                 uint32_t slave;  /* a VhostUserSlaveRequest value*/
 117         } request;
 118
 119 #define VHOST_USER_VERSION_MASK     0x3
 120 #define VHOST_USER_REPLY_MASK       (0x1 << 2)
 121 #define VHOST_USER_NEED_REPLY           (0x1 << 3)
 122         uint32_t flags;
 123         uint32_t size; /* the following payload size */
 124         union {
 125 #define VHOST_USER_VRING_IDX_MASK   0xff
 126 #define VHOST_USER_VRING_NOFD_MASK  (0x1<<8)
 127                 uint64_t u64;
 128                 struct vhost_vring_state state;
 129                 struct vhost_vring_addr addr;
 130                 VhostUserMemory memory;
 131                 VhostUserLog    log;
 132                 struct vhost_iotlb_msg iotlb;
 133                 VhostUserCryptoSessionParam crypto_session;
 134                 VhostUserVringArea area;
 135         } payload;
 136         int fds[VHOST_MEMORY_MAX_NREGIONS];
 137         int fd_num;
 138 } __attribute((packed)) VhostUserMsg;
 139
 140 #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
 141
 142 /* The version of the protocol we support */
 143 #define VHOST_USER_VERSION    0x1
 144
 145
 146 /* vhost_user.c */
 147 int vhost_user_msg_handler(int vid, int fd);
 148 int vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm);
 149 int vhost_user_host_notifier_ctrl(int vid, bool enable);
 150
 151 /* socket.c */
 152 int read_fd_message(int sockfd, char *buf, int buflen, int *fds, int max_fds,
 153                 int *fd_num);
 154 int send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);
 155
 156 #endif