4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _VHOST_NET_USER_H
35 #define _VHOST_NET_USER_H
38 #include <linux/vhost.h>
40 #include "rte_virtio_net.h"
42 /* refer to hw/virtio/vhost-user.c */
44 #define VHOST_MEMORY_MAX_NREGIONS 8
46 typedef enum VhostUserRequest {
48 VHOST_USER_GET_FEATURES = 1,
49 VHOST_USER_SET_FEATURES = 2,
50 VHOST_USER_SET_OWNER = 3,
51 VHOST_USER_RESET_OWNER = 4,
52 VHOST_USER_SET_MEM_TABLE = 5,
53 VHOST_USER_SET_LOG_BASE = 6,
54 VHOST_USER_SET_LOG_FD = 7,
55 VHOST_USER_SET_VRING_NUM = 8,
56 VHOST_USER_SET_VRING_ADDR = 9,
57 VHOST_USER_SET_VRING_BASE = 10,
58 VHOST_USER_GET_VRING_BASE = 11,
59 VHOST_USER_SET_VRING_KICK = 12,
60 VHOST_USER_SET_VRING_CALL = 13,
61 VHOST_USER_SET_VRING_ERR = 14,
62 VHOST_USER_GET_PROTOCOL_FEATURES = 15,
63 VHOST_USER_SET_PROTOCOL_FEATURES = 16,
64 VHOST_USER_GET_QUEUE_NUM = 17,
65 VHOST_USER_SET_VRING_ENABLE = 18,
66 VHOST_USER_SEND_RARP = 19,
70 typedef struct VhostUserMemoryRegion {
71 uint64_t guest_phys_addr;
73 uint64_t userspace_addr;
75 } VhostUserMemoryRegion;
77 typedef struct VhostUserMemory {
80 VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
83 typedef struct VhostUserLog {
88 typedef struct VhostUserMsg {
89 VhostUserRequest request;
91 #define VHOST_USER_VERSION_MASK 0x3
92 #define VHOST_USER_REPLY_MASK (0x1 << 2)
94 uint32_t size; /* the following payload size */
96 #define VHOST_USER_VRING_IDX_MASK 0xff
97 #define VHOST_USER_VRING_NOFD_MASK (0x1<<8)
99 struct vhost_vring_state state;
100 struct vhost_vring_addr addr;
101 VhostUserMemory memory;
104 int fds[VHOST_MEMORY_MAX_NREGIONS];
105 } __attribute((packed)) VhostUserMsg;
107 #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
109 /* The version of the protocol we support */
110 #define VHOST_USER_VERSION 0x1
112 /*****************************************************************************/