1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2018 Intel Corporation
5 #ifndef _VHOST_NET_USER_H
6 #define _VHOST_NET_USER_H
9 #include <linux/vhost.h>
11 #include "rte_vhost.h"
13 /* refer to hw/virtio/vhost-user.c */
15 #define VHOST_MEMORY_MAX_NREGIONS 8
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))
27 typedef enum VhostUserRequest {
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_POSTCOPY_END = 30,
59 typedef enum VhostUserSlaveRequest {
60 VHOST_USER_SLAVE_NONE = 0,
61 VHOST_USER_SLAVE_IOTLB_MSG = 1,
62 VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG = 3,
64 } VhostUserSlaveRequest;
66 typedef struct VhostUserMemoryRegion {
67 uint64_t guest_phys_addr;
69 uint64_t userspace_addr;
71 } VhostUserMemoryRegion;
73 typedef struct VhostUserMemory {
76 VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
79 typedef struct VhostUserLog {
84 /* Comply with Cryptodev-Linux */
85 #define VHOST_USER_CRYPTO_MAX_HMAC_KEY_LENGTH 512
86 #define VHOST_USER_CRYPTO_MAX_CIPHER_KEY_LENGTH 64
88 /* Same structure as vhost-user backend session info */
89 typedef struct VhostUserCryptoSessionParam {
93 uint32_t cipher_key_len;
96 uint32_t auth_key_len;
101 uint8_t chaining_dir;
104 uint8_t cipher_key_buf[VHOST_USER_CRYPTO_MAX_CIPHER_KEY_LENGTH];
105 uint8_t auth_key_buf[VHOST_USER_CRYPTO_MAX_HMAC_KEY_LENGTH];
106 } VhostUserCryptoSessionParam;
108 typedef struct VhostUserVringArea {
112 } VhostUserVringArea;
114 typedef struct VhostUserMsg {
116 uint32_t master; /* a VhostUserRequest value */
117 uint32_t slave; /* a VhostUserSlaveRequest value*/
120 #define VHOST_USER_VERSION_MASK 0x3
121 #define VHOST_USER_REPLY_MASK (0x1 << 2)
122 #define VHOST_USER_NEED_REPLY (0x1 << 3)
124 uint32_t size; /* the following payload size */
126 #define VHOST_USER_VRING_IDX_MASK 0xff
127 #define VHOST_USER_VRING_NOFD_MASK (0x1<<8)
129 struct vhost_vring_state state;
130 struct vhost_vring_addr addr;
131 VhostUserMemory memory;
133 struct vhost_iotlb_msg iotlb;
134 VhostUserCryptoSessionParam crypto_session;
135 VhostUserVringArea area;
137 int fds[VHOST_MEMORY_MAX_NREGIONS];
139 } __attribute((packed)) VhostUserMsg;
141 #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
143 /* The version of the protocol we support */
144 #define VHOST_USER_VERSION 0x1
148 int vhost_user_msg_handler(int vid, int fd);
149 int vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm);
150 int vhost_user_host_notifier_ctrl(int vid, bool enable);
153 int read_fd_message(int sockfd, char *buf, int buflen, int *fds, int max_fds,
155 int send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);