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) | \
26 (1ULL << VHOST_USER_PROTOCOL_F_PAGEFAULT))
28 typedef enum VhostUserRequest {
30 VHOST_USER_GET_FEATURES = 1,
31 VHOST_USER_SET_FEATURES = 2,
32 VHOST_USER_SET_OWNER = 3,
33 VHOST_USER_RESET_OWNER = 4,
34 VHOST_USER_SET_MEM_TABLE = 5,
35 VHOST_USER_SET_LOG_BASE = 6,
36 VHOST_USER_SET_LOG_FD = 7,
37 VHOST_USER_SET_VRING_NUM = 8,
38 VHOST_USER_SET_VRING_ADDR = 9,
39 VHOST_USER_SET_VRING_BASE = 10,
40 VHOST_USER_GET_VRING_BASE = 11,
41 VHOST_USER_SET_VRING_KICK = 12,
42 VHOST_USER_SET_VRING_CALL = 13,
43 VHOST_USER_SET_VRING_ERR = 14,
44 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
45 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
46 VHOST_USER_GET_QUEUE_NUM = 17,
47 VHOST_USER_SET_VRING_ENABLE = 18,
48 VHOST_USER_SEND_RARP = 19,
49 VHOST_USER_NET_SET_MTU = 20,
50 VHOST_USER_SET_SLAVE_REQ_FD = 21,
51 VHOST_USER_IOTLB_MSG = 22,
52 VHOST_USER_CRYPTO_CREATE_SESS = 26,
53 VHOST_USER_CRYPTO_CLOSE_SESS = 27,
54 VHOST_USER_POSTCOPY_ADVISE = 28,
55 VHOST_USER_POSTCOPY_LISTEN = 29,
56 VHOST_USER_POSTCOPY_END = 30,
57 VHOST_USER_GET_INFLIGHT_FD = 31,
58 VHOST_USER_SET_INFLIGHT_FD = 32,
62 typedef enum VhostUserSlaveRequest {
63 VHOST_USER_SLAVE_NONE = 0,
64 VHOST_USER_SLAVE_IOTLB_MSG = 1,
65 VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG = 3,
67 } VhostUserSlaveRequest;
69 typedef struct VhostUserMemoryRegion {
70 uint64_t guest_phys_addr;
72 uint64_t userspace_addr;
74 } VhostUserMemoryRegion;
76 typedef struct VhostUserMemory {
79 VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
82 typedef struct VhostUserLog {
87 /* Comply with Cryptodev-Linux */
88 #define VHOST_USER_CRYPTO_MAX_HMAC_KEY_LENGTH 512
89 #define VHOST_USER_CRYPTO_MAX_CIPHER_KEY_LENGTH 64
91 /* Same structure as vhost-user backend session info */
92 typedef struct VhostUserCryptoSessionParam {
96 uint32_t cipher_key_len;
99 uint32_t auth_key_len;
104 uint8_t chaining_dir;
107 uint8_t cipher_key_buf[VHOST_USER_CRYPTO_MAX_CIPHER_KEY_LENGTH];
108 uint8_t auth_key_buf[VHOST_USER_CRYPTO_MAX_HMAC_KEY_LENGTH];
109 } VhostUserCryptoSessionParam;
111 typedef struct VhostUserVringArea {
115 } VhostUserVringArea;
117 typedef struct VhostUserInflight {
119 uint64_t mmap_offset;
124 typedef struct VhostUserMsg {
126 uint32_t master; /* a VhostUserRequest value */
127 uint32_t slave; /* a VhostUserSlaveRequest value*/
130 #define VHOST_USER_VERSION_MASK 0x3
131 #define VHOST_USER_REPLY_MASK (0x1 << 2)
132 #define VHOST_USER_NEED_REPLY (0x1 << 3)
134 uint32_t size; /* the following payload size */
136 #define VHOST_USER_VRING_IDX_MASK 0xff
137 #define VHOST_USER_VRING_NOFD_MASK (0x1<<8)
139 struct vhost_vring_state state;
140 struct vhost_vring_addr addr;
141 VhostUserMemory memory;
143 struct vhost_iotlb_msg iotlb;
144 VhostUserCryptoSessionParam crypto_session;
145 VhostUserVringArea area;
146 VhostUserInflight inflight;
148 int fds[VHOST_MEMORY_MAX_NREGIONS];
150 } __attribute((packed)) VhostUserMsg;
152 #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
154 /* The version of the protocol we support */
155 #define VHOST_USER_VERSION 0x1
159 int vhost_user_msg_handler(int vid, int fd);
160 int vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm);
163 int read_fd_message(int sockfd, char *buf, int buflen, int *fds, int max_fds,
165 int send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);