1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 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_F_MQ 0
18 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
19 #define VHOST_USER_PROTOCOL_F_RARP 2
20 #define VHOST_USER_PROTOCOL_F_REPLY_ACK 3
21 #define VHOST_USER_PROTOCOL_F_NET_MTU 4
22 #define VHOST_USER_PROTOCOL_F_SLAVE_REQ 5
24 #define VHOST_USER_PROTOCOL_FEATURES ((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \
25 (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |\
26 (1ULL << VHOST_USER_PROTOCOL_F_RARP) | \
27 (1ULL << VHOST_USER_PROTOCOL_F_REPLY_ACK) | \
28 (1ULL << VHOST_USER_PROTOCOL_F_NET_MTU) | \
29 (1ULL << VHOST_USER_PROTOCOL_F_SLAVE_REQ))
31 typedef enum VhostUserRequest {
33 VHOST_USER_GET_FEATURES = 1,
34 VHOST_USER_SET_FEATURES = 2,
35 VHOST_USER_SET_OWNER = 3,
36 VHOST_USER_RESET_OWNER = 4,
37 VHOST_USER_SET_MEM_TABLE = 5,
38 VHOST_USER_SET_LOG_BASE = 6,
39 VHOST_USER_SET_LOG_FD = 7,
40 VHOST_USER_SET_VRING_NUM = 8,
41 VHOST_USER_SET_VRING_ADDR = 9,
42 VHOST_USER_SET_VRING_BASE = 10,
43 VHOST_USER_GET_VRING_BASE = 11,
44 VHOST_USER_SET_VRING_KICK = 12,
45 VHOST_USER_SET_VRING_CALL = 13,
46 VHOST_USER_SET_VRING_ERR = 14,
47 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
48 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
49 VHOST_USER_GET_QUEUE_NUM = 17,
50 VHOST_USER_SET_VRING_ENABLE = 18,
51 VHOST_USER_SEND_RARP = 19,
52 VHOST_USER_NET_SET_MTU = 20,
53 VHOST_USER_SET_SLAVE_REQ_FD = 21,
54 VHOST_USER_IOTLB_MSG = 22,
58 typedef enum VhostUserSlaveRequest {
59 VHOST_USER_SLAVE_NONE = 0,
60 VHOST_USER_SLAVE_IOTLB_MSG = 1,
62 } VhostUserSlaveRequest;
64 typedef struct VhostUserMemoryRegion {
65 uint64_t guest_phys_addr;
67 uint64_t userspace_addr;
69 } VhostUserMemoryRegion;
71 typedef struct VhostUserMemory {
74 VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
77 typedef struct VhostUserLog {
82 typedef struct VhostUserMsg {
84 VhostUserRequest master;
85 VhostUserSlaveRequest slave;
88 #define VHOST_USER_VERSION_MASK 0x3
89 #define VHOST_USER_REPLY_MASK (0x1 << 2)
90 #define VHOST_USER_NEED_REPLY (0x1 << 3)
92 uint32_t size; /* the following payload size */
94 #define VHOST_USER_VRING_IDX_MASK 0xff
95 #define VHOST_USER_VRING_NOFD_MASK (0x1<<8)
97 struct vhost_vring_state state;
98 struct vhost_vring_addr addr;
99 VhostUserMemory memory;
101 struct vhost_iotlb_msg iotlb;
103 int fds[VHOST_MEMORY_MAX_NREGIONS];
104 } __attribute((packed)) VhostUserMsg;
106 #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
108 /* The version of the protocol we support */
109 #define VHOST_USER_VERSION 0x1
113 int vhost_user_msg_handler(int vid, int fd);
114 int vhost_user_iotlb_miss(struct virtio_net *dev, uint64_t iova, uint8_t perm);
117 int read_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);
118 int send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);