vhost: refactor code structure
[dpdk.git] / lib / librte_vhost / vhost_user.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
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
16  *       distribution.
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.
20  *
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.
32  */
33
34 #ifndef _VHOST_NET_USER_H
35 #define _VHOST_NET_USER_H
36
37 #include <stdint.h>
38 #include <linux/vhost.h>
39
40 #include "rte_virtio_net.h"
41
42 /* refer to hw/virtio/vhost-user.c */
43
44 #define VHOST_MEMORY_MAX_NREGIONS 8
45
46 #define VHOST_USER_PROTOCOL_F_MQ        0
47 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
48 #define VHOST_USER_PROTOCOL_F_RARP      2
49
50 #define VHOST_USER_PROTOCOL_FEATURES    ((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \
51                                          (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD) |\
52                                          (1ULL << VHOST_USER_PROTOCOL_F_RARP))
53
54 typedef enum VhostUserRequest {
55         VHOST_USER_NONE = 0,
56         VHOST_USER_GET_FEATURES = 1,
57         VHOST_USER_SET_FEATURES = 2,
58         VHOST_USER_SET_OWNER = 3,
59         VHOST_USER_RESET_OWNER = 4,
60         VHOST_USER_SET_MEM_TABLE = 5,
61         VHOST_USER_SET_LOG_BASE = 6,
62         VHOST_USER_SET_LOG_FD = 7,
63         VHOST_USER_SET_VRING_NUM = 8,
64         VHOST_USER_SET_VRING_ADDR = 9,
65         VHOST_USER_SET_VRING_BASE = 10,
66         VHOST_USER_GET_VRING_BASE = 11,
67         VHOST_USER_SET_VRING_KICK = 12,
68         VHOST_USER_SET_VRING_CALL = 13,
69         VHOST_USER_SET_VRING_ERR = 14,
70         VHOST_USER_GET_PROTOCOL_FEATURES = 15,
71         VHOST_USER_SET_PROTOCOL_FEATURES = 16,
72         VHOST_USER_GET_QUEUE_NUM = 17,
73         VHOST_USER_SET_VRING_ENABLE = 18,
74         VHOST_USER_SEND_RARP = 19,
75         VHOST_USER_MAX
76 } VhostUserRequest;
77
78 typedef struct VhostUserMemoryRegion {
79         uint64_t guest_phys_addr;
80         uint64_t memory_size;
81         uint64_t userspace_addr;
82         uint64_t mmap_offset;
83 } VhostUserMemoryRegion;
84
85 typedef struct VhostUserMemory {
86         uint32_t nregions;
87         uint32_t padding;
88         VhostUserMemoryRegion regions[VHOST_MEMORY_MAX_NREGIONS];
89 } VhostUserMemory;
90
91 typedef struct VhostUserLog {
92         uint64_t mmap_size;
93         uint64_t mmap_offset;
94 } VhostUserLog;
95
96 typedef struct VhostUserMsg {
97         VhostUserRequest request;
98
99 #define VHOST_USER_VERSION_MASK     0x3
100 #define VHOST_USER_REPLY_MASK       (0x1 << 2)
101         uint32_t flags;
102         uint32_t size; /* the following payload size */
103         union {
104 #define VHOST_USER_VRING_IDX_MASK   0xff
105 #define VHOST_USER_VRING_NOFD_MASK  (0x1<<8)
106                 uint64_t u64;
107                 struct vhost_vring_state state;
108                 struct vhost_vring_addr addr;
109                 VhostUserMemory memory;
110                 VhostUserLog    log;
111         } payload;
112         int fds[VHOST_MEMORY_MAX_NREGIONS];
113 } __attribute((packed)) VhostUserMsg;
114
115 #define VHOST_USER_HDR_SIZE offsetof(VhostUserMsg, payload.u64)
116
117 /* The version of the protocol we support */
118 #define VHOST_USER_VERSION    0x1
119
120
121 /* vhost_user.c */
122 int vhost_user_msg_handler(int vid, int fd);
123
124 /* socket.c */
125 int read_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);
126 int send_fd_message(int sockfd, char *buf, int buflen, int *fds, int fd_num);
127
128 #endif