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.
41 * The KNI library provides the ability to create and destroy kernel NIC
42 * interfaces that may be used by the RTE application to receive/transmit
43 * packets from/to Linux kernel net interfaces.
45 * This library provide two APIs to burst receive packets from KNI interfaces,
46 * and burst transmit packets to KNI interfaces.
52 #include <exec-env/rte_kni_common.h>
61 * Structure which has the function pointers for KNI interface.
64 uint8_t port_id; /* Port ID */
66 /* Pointer to function of changing MTU */
67 int (*change_mtu)(uint8_t port_id, unsigned new_mtu);
69 /* Pointer to function of configuring network interface */
70 int (*config_network_if)(uint8_t port_id, uint8_t if_up);
74 * Structure for configuring KNI device.
78 * KNI name which will be used in relevant network device.
79 * Let the name as short as possible, as it will be part of
82 char name[RTE_KNI_NAMESIZE];
83 uint32_t core_id; /* Core ID to bind kernel thread on */
84 uint16_t group_id; /* Group ID */
85 unsigned mbuf_size; /* mbuf size */
86 struct rte_pci_addr addr;
89 uint8_t force_bind : 1; /* Flag to bind kernel thread */
93 * Initialize and preallocate KNI subsystem
95 * This function is to be executed on the MASTER lcore only, after EAL
96 * initialization and before any KNI interface is attempted to be
99 * @param max_kni_ifaces
100 * The maximum number of KNI interfaces that can coexist concurrently
102 extern void rte_kni_init(unsigned int max_kni_ifaces);
106 * Allocate KNI interface according to the port id, mbuf size, mbuf pool,
107 * configurations and callbacks for kernel requests.The KNI interface created
108 * in the kernel space is the net interface the traditional Linux application
111 * The rte_kni_alloc shall not be called before rte_kni_init() has been
112 * called. rte_kni_alloc is thread safe.
114 * @param pktmbuf_pool
115 * The mempool for allocting mbufs for packets.
117 * The pointer to the configurations of the KNI device.
119 * The pointer to the callbacks for the KNI kernel requests.
122 * - The pointer to the context of a KNI interface.
123 * - NULL indicate error.
125 extern struct rte_kni *rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
126 const struct rte_kni_conf *conf,
127 struct rte_kni_ops *ops);
130 * It create a KNI device for specific port.
132 * Note: It is deprecated and just for backward compatibility.
138 * @param pktmbuf_pool
139 * The mempool for allocting mbufs for packets.
141 * The pointer to the callbacks for the KNI kernel requests.
144 * - The pointer to the context of a KNI interface.
145 * - NULL indicate error.
147 extern struct rte_kni *rte_kni_create(uint8_t port_id,
149 struct rte_mempool *pktmbuf_pool,
150 struct rte_kni_ops *ops) \
151 __attribute__ ((deprecated));
154 * Release KNI interface according to the context. It will also release the
155 * paired KNI interface in kernel space. All processing on the specific KNI
156 * context need to be stopped before calling this interface.
158 * rte_kni_release is thread safe.
161 * The pointer to the context of an existent KNI interface.
164 * - 0 indicates success.
165 * - negative value indicates failure.
167 extern int rte_kni_release(struct rte_kni *kni);
170 * It is used to handle the request mbufs sent from kernel space.
171 * Then analyzes it and calls the specific actions for the specific requests.
172 * Finally constructs the response mbuf and puts it back to the resp_q.
175 * The pointer to the context of an existent KNI interface.
179 * - negative value indicates failure.
181 extern int rte_kni_handle_request(struct rte_kni *kni);
184 * Retrieve a burst of packets from a KNI interface. The retrieved packets are
185 * stored in rte_mbuf structures whose pointers are supplied in the array of
186 * mbufs, and the maximum number is indicated by num. It handles the freeing of
187 * the mbufs in the free queue of KNI interface.
190 * The KNI interface context.
192 * The array to store the pointers of mbufs.
194 * The maximum number per burst.
197 * The actual number of packets retrieved.
199 extern unsigned rte_kni_rx_burst(struct rte_kni *kni,
200 struct rte_mbuf **mbufs, unsigned num);
203 * Send a burst of packets to a KNI interface. The packets to be sent out are
204 * stored in rte_mbuf structures whose pointers are supplied in the array of
205 * mbufs, and the maximum number is indicated by num. It handles allocating
206 * the mbufs for KNI interface alloc queue.
209 * The KNI interface context.
211 * The array to store the pointers of mbufs.
213 * The maximum number per burst.
216 * The actual number of packets sent.
218 extern unsigned rte_kni_tx_burst(struct rte_kni *kni,
219 struct rte_mbuf **mbufs, unsigned num);
222 * Get the port id from KNI interface.
224 * Note: It is deprecated and just for backward compatibility.
227 * The KNI interface context.
230 * On success: The port id.
233 extern uint8_t rte_kni_get_port_id(struct rte_kni *kni) \
234 __attribute__ ((deprecated));
237 * Get the KNI context of its name.
240 * pointer to the KNI device name.
243 * On success: Pointer to KNI interface.
246 extern struct rte_kni *rte_kni_get(const char *name);
249 * Get the KNI context of the specific port.
251 * Note: It is deprecated and just for backward compatibility.
257 * On success: Pointer to KNI interface.
260 extern struct rte_kni *rte_kni_info_get(uint8_t port_id) \
261 __attribute__ ((deprecated));
264 * Register KNI request handling for a specified port,and it can
265 * be called by master process or slave process.
268 * pointer to struct rte_kni.
270 * ponter to struct rte_kni_ops.
276 extern int rte_kni_register_handlers(struct rte_kni *kni,
277 struct rte_kni_ops *ops);
280 * Unregister KNI request handling for a specified port.
283 * pointer to struct rte_kni.
289 extern int rte_kni_unregister_handlers(struct rte_kni *kni);
299 extern void rte_kni_close(void);
305 #endif /* _RTE_KNI_H_ */