vhost: add a flag to enable dequeue zero copy
[dpdk.git] / lib / librte_vhost / rte_virtio_net.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 _VIRTIO_NET_H_
35 #define _VIRTIO_NET_H_
36
37 /**
38  * @file
39  * Interface to vhost net
40  */
41
42 #include <stdint.h>
43 #include <linux/vhost.h>
44 #include <linux/virtio_ring.h>
45 #include <linux/virtio_net.h>
46 #include <sys/eventfd.h>
47 #include <sys/socket.h>
48 #include <linux/if.h>
49
50 #include <rte_memory.h>
51 #include <rte_mempool.h>
52 #include <rte_ether.h>
53
54 #define RTE_VHOST_USER_CLIENT           (1ULL << 0)
55 #define RTE_VHOST_USER_NO_RECONNECT     (1ULL << 1)
56 #define RTE_VHOST_USER_DEQUEUE_ZERO_COPY        (1ULL << 2)
57
58 /* Enum for virtqueue management. */
59 enum {VIRTIO_RXQ, VIRTIO_TXQ, VIRTIO_QNUM};
60
61 /**
62  * Device and vring operations.
63  */
64 struct virtio_net_device_ops {
65         int (*new_device)(int vid);             /**< Add device. */
66         void (*destroy_device)(int vid);        /**< Remove device. */
67
68         int (*vring_state_changed)(int vid, uint16_t queue_id, int enable);     /**< triggered when a vring is enabled or disabled */
69
70         void *reserved[5]; /**< Reserved for future extension */
71 };
72
73 /**
74  *  Disable features in feature_mask. Returns 0 on success.
75  */
76 int rte_vhost_feature_disable(uint64_t feature_mask);
77
78 /**
79  *  Enable features in feature_mask. Returns 0 on success.
80  */
81 int rte_vhost_feature_enable(uint64_t feature_mask);
82
83 /* Returns currently supported vhost features */
84 uint64_t rte_vhost_feature_get(void);
85
86 int rte_vhost_enable_guest_notification(int vid, uint16_t queue_id, int enable);
87
88 /**
89  * Register vhost driver. path could be different for multiple
90  * instance support.
91  */
92 int rte_vhost_driver_register(const char *path, uint64_t flags);
93
94 /* Unregister vhost driver. This is only meaningful to vhost user. */
95 int rte_vhost_driver_unregister(const char *path);
96
97 /* Register callbacks. */
98 int rte_vhost_driver_callback_register(struct virtio_net_device_ops const * const);
99 /* Start vhost driver session blocking loop. */
100 int rte_vhost_driver_session_start(void);
101
102 /**
103  * Get the numa node from which the virtio net device's memory
104  * is allocated.
105  *
106  * @param vid
107  *  virtio-net device ID
108  *
109  * @return
110  *  The numa node, -1 on failure
111  */
112 int rte_vhost_get_numa_node(int vid);
113
114 /**
115  * Get the number of queues the device supports.
116  *
117  * @param vid
118  *  virtio-net device ID
119  *
120  * @return
121  *  The number of queues, 0 on failure
122  */
123 uint32_t rte_vhost_get_queue_num(int vid);
124
125 /**
126  * Get the virtio net device's ifname. For vhost-cuse, ifname is the
127  * path of the char device. For vhost-user, ifname is the vhost-user
128  * socket file path.
129  *
130  * @param vid
131  *  virtio-net device ID
132  * @param buf
133  *  The buffer to stored the queried ifname
134  * @param len
135  *  The length of buf
136  *
137  * @return
138  *  0 on success, -1 on failure
139  */
140 int rte_vhost_get_ifname(int vid, char *buf, size_t len);
141
142 /**
143  * Get how many avail entries are left in the queue
144  *
145  * @param vid
146  *  virtio-net device ID
147  * @param queue_id
148  *  virtio queue index
149  *
150  * @return
151  *  num of avail entires left
152  */
153 uint16_t rte_vhost_avail_entries(int vid, uint16_t queue_id);
154
155 /**
156  * This function adds buffers to the virtio devices RX virtqueue. Buffers can
157  * be received from the physical port or from another virtual device. A packet
158  * count is returned to indicate the number of packets that were succesfully
159  * added to the RX queue.
160  * @param vid
161  *  virtio-net device ID
162  * @param queue_id
163  *  virtio queue index in mq case
164  * @param pkts
165  *  array to contain packets to be enqueued
166  * @param count
167  *  packets num to be enqueued
168  * @return
169  *  num of packets enqueued
170  */
171 uint16_t rte_vhost_enqueue_burst(int vid, uint16_t queue_id,
172         struct rte_mbuf **pkts, uint16_t count);
173
174 /**
175  * This function gets guest buffers from the virtio device TX virtqueue,
176  * construct host mbufs, copies guest buffer content to host mbufs and
177  * store them in pkts to be processed.
178  * @param vid
179  *  virtio-net device
180  * @param queue_id
181  *  virtio queue index in mq case
182  * @param mbuf_pool
183  *  mbuf_pool where host mbuf is allocated.
184  * @param pkts
185  *  array to contain packets to be dequeued
186  * @param count
187  *  packets num to be dequeued
188  * @return
189  *  num of packets dequeued
190  */
191 uint16_t rte_vhost_dequeue_burst(int vid, uint16_t queue_id,
192         struct rte_mempool *mbuf_pool, struct rte_mbuf **pkts, uint16_t count);
193
194 #endif /* _VIRTIO_NET_H_ */