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_CDEV_H_
35 #define _VHOST_NET_CDEV_H_
38 #include <sys/types.h>
40 #include <linux/vhost.h>
44 #include "rte_virtio_net.h"
46 extern struct vhost_net_device_ops const *ops;
48 /* Macros for printing using RTE_LOG */
49 #define RTE_LOGTYPE_VHOST_CONFIG RTE_LOGTYPE_USER1
50 #define RTE_LOGTYPE_VHOST_DATA RTE_LOGTYPE_USER1
52 #ifdef RTE_LIBRTE_VHOST_DEBUG
53 #define VHOST_MAX_PRINT_BUFF 6072
54 #define LOG_LEVEL RTE_LOG_DEBUG
55 #define LOG_DEBUG(log_type, fmt, args...) RTE_LOG(DEBUG, log_type, fmt, ##args)
56 #define PRINT_PACKET(device, addr, size, header) do { \
57 char *pkt_addr = (char *)(addr); \
59 char packet[VHOST_MAX_PRINT_BUFF]; \
62 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%" PRIu64 ") Header size %d: ", (device->device_fh), (size)); \
64 snprintf(packet, VHOST_MAX_PRINT_BUFF, "(%" PRIu64 ") Packet size %d: ", (device->device_fh), (size)); \
65 for (index = 0; index < (size); index++) { \
66 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), \
67 "%02hhx ", pkt_addr[index]); \
69 snprintf(packet + strnlen(packet, VHOST_MAX_PRINT_BUFF), VHOST_MAX_PRINT_BUFF - strnlen(packet, VHOST_MAX_PRINT_BUFF), "\n"); \
71 LOG_DEBUG(VHOST_DATA, "%s", packet); \
74 #define LOG_LEVEL RTE_LOG_INFO
75 #define LOG_DEBUG(log_type, fmt, args...) do {} while (0)
76 #define PRINT_PACKET(device, addr, size, header) do {} while (0)
81 * Structure used to identify device context.
83 struct vhost_device_ctx {
84 pid_t pid; /* PID of process calling the IOCTL. */
85 uint64_t fh; /* Populated with fi->fh to track the device index. */
89 * Structure contains function pointers to be defined in virtio-net.c. These
90 * functions are called in CUSE context and are used to configure devices.
92 struct vhost_net_device_ops {
93 int (*new_device)(struct vhost_device_ctx);
94 void (*destroy_device)(struct vhost_device_ctx);
96 void (*set_ifname)(struct vhost_device_ctx,
97 const char *if_name, unsigned int if_len);
99 int (*get_features)(struct vhost_device_ctx, uint64_t *);
100 int (*set_features)(struct vhost_device_ctx, uint64_t *);
102 int (*set_vring_num)(struct vhost_device_ctx, struct vhost_vring_state *);
103 int (*set_vring_addr)(struct vhost_device_ctx, struct vhost_vring_addr *);
104 int (*set_vring_base)(struct vhost_device_ctx, struct vhost_vring_state *);
105 int (*get_vring_base)(struct vhost_device_ctx, uint32_t, struct vhost_vring_state *);
107 int (*set_vring_kick)(struct vhost_device_ctx, struct vhost_vring_file *);
108 int (*set_vring_call)(struct vhost_device_ctx, struct vhost_vring_file *);
110 int (*set_backend)(struct vhost_device_ctx, struct vhost_vring_file *);
112 int (*set_owner)(struct vhost_device_ctx);
113 int (*reset_owner)(struct vhost_device_ctx);
117 struct vhost_net_device_ops const *get_virtio_net_callbacks(void);
118 #endif /* _VHOST_NET_CDEV_H_ */