1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
12 * The KNI library provides the ability to create and destroy kernel NIC
13 * interfaces that may be used by the RTE application to receive/transmit
14 * packets from/to Linux kernel net interfaces.
16 * This library provides two APIs to burst receive packets from KNI interfaces,
17 * and burst transmit packets to KNI interfaces.
21 #include <rte_memory.h>
22 #include <rte_mempool.h>
23 #include <rte_ether.h>
25 #include <rte_kni_common.h>
35 * Structure which has the function pointers for KNI interface.
38 uint16_t port_id; /* Port ID */
40 /* Pointer to function of changing MTU */
41 int (*change_mtu)(uint16_t port_id, unsigned int new_mtu);
43 /* Pointer to function of configuring network interface */
44 int (*config_network_if)(uint16_t port_id, uint8_t if_up);
46 /* Pointer to function of configuring mac address */
47 int (*config_mac_address)(uint16_t port_id, uint8_t mac_addr[]);
49 /* Pointer to function of configuring promiscuous mode */
50 int (*config_promiscusity)(uint16_t port_id, uint8_t to_on);
52 /* Pointer to function of configuring allmulticast mode */
53 int (*config_allmulticast)(uint16_t port_id, uint8_t to_on);
57 * Structure for configuring KNI device.
61 * KNI name which will be used in relevant network device.
62 * Let the name as short as possible, as it will be part of
65 char name[RTE_KNI_NAMESIZE];
66 uint32_t core_id; /* Core ID to bind kernel thread on */
67 uint16_t group_id; /* Group ID */
68 unsigned mbuf_size; /* mbuf size */
69 struct rte_pci_addr addr; /* depreciated */
70 struct rte_pci_id id; /* depreciated */
73 uint8_t force_bind : 1; /* Flag to bind kernel thread */
74 uint8_t mac_addr[RTE_ETHER_ADDR_LEN]; /* MAC address assigned to KNI */
81 * Initialize and preallocate KNI subsystem
83 * This function is to be executed on the MASTER lcore only, after EAL
84 * initialization and before any KNI interface is attempted to be
87 * @param max_kni_ifaces
88 * The maximum number of KNI interfaces that can coexist concurrently
91 * - 0 indicates success.
92 * - negative value indicates failure.
94 int rte_kni_init(unsigned int max_kni_ifaces);
98 * Allocate KNI interface according to the port id, mbuf size, mbuf pool,
99 * configurations and callbacks for kernel requests.The KNI interface created
100 * in the kernel space is the net interface the traditional Linux application
103 * The rte_kni_alloc shall not be called before rte_kni_init() has been
104 * called. rte_kni_alloc is thread safe.
106 * The mempool should have capacity of more than "2 x KNI_FIFO_COUNT_MAX"
107 * elements for each KNI interface allocated.
109 * @param pktmbuf_pool
110 * The mempool for allocating mbufs for packets.
112 * The pointer to the configurations of the KNI device.
114 * The pointer to the callbacks for the KNI kernel requests.
117 * - The pointer to the context of a KNI interface.
118 * - NULL indicate error.
120 struct rte_kni *rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
121 const struct rte_kni_conf *conf, struct rte_kni_ops *ops);
124 * Release KNI interface according to the context. It will also release the
125 * paired KNI interface in kernel space. All processing on the specific KNI
126 * context need to be stopped before calling this interface.
128 * rte_kni_release is thread safe.
131 * The pointer to the context of an existent KNI interface.
134 * - 0 indicates success.
135 * - negative value indicates failure.
137 int rte_kni_release(struct rte_kni *kni);
140 * It is used to handle the request mbufs sent from kernel space.
141 * Then analyzes it and calls the specific actions for the specific requests.
142 * Finally constructs the response mbuf and puts it back to the resp_q.
145 * The pointer to the context of an existent KNI interface.
149 * - negative value indicates failure.
151 int rte_kni_handle_request(struct rte_kni *kni);
154 * Retrieve a burst of packets from a KNI interface. The retrieved packets are
155 * stored in rte_mbuf structures whose pointers are supplied in the array of
156 * mbufs, and the maximum number is indicated by num. It handles allocating
157 * the mbufs for KNI interface alloc queue.
160 * The KNI interface context.
162 * The array to store the pointers of mbufs.
164 * The maximum number per burst.
167 * The actual number of packets retrieved.
169 unsigned rte_kni_rx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs,
173 * Send a burst of packets to a KNI interface. The packets to be sent out are
174 * stored in rte_mbuf structures whose pointers are supplied in the array of
175 * mbufs, and the maximum number is indicated by num. It handles the freeing of
176 * the mbufs in the free queue of KNI interface.
179 * The KNI interface context.
181 * The array to store the pointers of mbufs.
183 * The maximum number per burst.
186 * The actual number of packets sent.
188 unsigned rte_kni_tx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs,
192 * Get the KNI context of its name.
195 * pointer to the KNI device name.
198 * On success: Pointer to KNI interface.
201 struct rte_kni *rte_kni_get(const char *name);
204 * Get the name given to a KNI device
207 * The KNI instance to query
209 * The pointer to the KNI name
211 const char *rte_kni_get_name(const struct rte_kni *kni);
214 * Register KNI request handling for a specified port,and it can
215 * be called by master process or slave process.
218 * pointer to struct rte_kni.
220 * pointer to struct rte_kni_ops.
226 int rte_kni_register_handlers(struct rte_kni *kni, struct rte_kni_ops *ops);
229 * Unregister KNI request handling for a specified port.
232 * pointer to struct rte_kni.
238 int rte_kni_unregister_handlers(struct rte_kni *kni);
241 * Update link carrier state for KNI port.
243 * Update the linkup/linkdown state of a KNI interface in the kernel.
246 * pointer to struct rte_kni.
254 * Previous link state == linkdown: 0
255 * Previous link state == linkup: 1
259 rte_kni_update_link(struct rte_kni *kni, unsigned int linkup);
264 void rte_kni_close(void);
270 #endif /* _RTE_KNI_H_ */