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_ether.h>
23 #include <rte_kni_common.h>
33 * Structure which has the function pointers for KNI interface.
36 uint16_t port_id; /* Port ID */
38 /* Pointer to function of changing MTU */
39 int (*change_mtu)(uint16_t port_id, unsigned int new_mtu);
41 /* Pointer to function of configuring network interface */
42 int (*config_network_if)(uint16_t port_id, uint8_t if_up);
44 /* Pointer to function of configuring mac address */
45 int (*config_mac_address)(uint16_t port_id, uint8_t mac_addr[]);
47 /* Pointer to function of configuring promiscuous mode */
48 int (*config_promiscusity)(uint16_t port_id, uint8_t to_on);
50 /* Pointer to function of configuring allmulticast mode */
51 int (*config_allmulticast)(uint16_t port_id, uint8_t to_on);
55 * Structure for configuring KNI device.
59 * KNI name which will be used in relevant network device.
60 * Let the name as short as possible, as it will be part of
63 char name[RTE_KNI_NAMESIZE];
64 uint32_t core_id; /* Core ID to bind kernel thread on */
65 uint16_t group_id; /* Group ID */
66 unsigned mbuf_size; /* mbuf size */
67 struct rte_pci_addr addr; /* depreciated */
68 struct rte_pci_id id; /* depreciated */
71 uint8_t force_bind : 1; /* Flag to bind kernel thread */
72 uint8_t mac_addr[RTE_ETHER_ADDR_LEN]; /* MAC address assigned to KNI */
79 * Initialize and preallocate KNI subsystem
81 * This function is to be executed on the main lcore only, after EAL
82 * initialization and before any KNI interface is attempted to be
85 * @param max_kni_ifaces
86 * The maximum number of KNI interfaces that can coexist concurrently
89 * - 0 indicates success.
90 * - negative value indicates failure.
92 int rte_kni_init(unsigned int max_kni_ifaces);
96 * Allocate KNI interface according to the port id, mbuf size, mbuf pool,
97 * configurations and callbacks for kernel requests.The KNI interface created
98 * in the kernel space is the net interface the traditional Linux application
101 * The rte_kni_alloc shall not be called before rte_kni_init() has been
102 * called. rte_kni_alloc is thread safe.
104 * The mempool should have capacity of more than "2 x KNI_FIFO_COUNT_MAX"
105 * elements for each KNI interface allocated.
107 * @param pktmbuf_pool
108 * The mempool for allocating mbufs for packets.
110 * The pointer to the configurations of the KNI device.
112 * The pointer to the callbacks for the KNI kernel requests.
115 * - The pointer to the context of a KNI interface.
116 * - NULL indicate error.
118 struct rte_kni *rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
119 const struct rte_kni_conf *conf, struct rte_kni_ops *ops);
122 * Release KNI interface according to the context. It will also release the
123 * paired KNI interface in kernel space. All processing on the specific KNI
124 * context need to be stopped before calling this interface.
126 * rte_kni_release is thread safe.
129 * The pointer to the context of an existent KNI interface.
132 * - 0 indicates success.
133 * - negative value indicates failure.
135 int rte_kni_release(struct rte_kni *kni);
138 * It is used to handle the request mbufs sent from kernel space.
139 * Then analyzes it and calls the specific actions for the specific requests.
140 * Finally constructs the response mbuf and puts it back to the resp_q.
143 * The pointer to the context of an existent KNI interface.
147 * - negative value indicates failure.
149 int rte_kni_handle_request(struct rte_kni *kni);
152 * Retrieve a burst of packets from a KNI interface. The retrieved packets are
153 * stored in rte_mbuf structures whose pointers are supplied in the array of
154 * mbufs, and the maximum number is indicated by num. It handles allocating
155 * the mbufs for KNI interface alloc queue.
158 * The KNI interface context.
160 * The array to store the pointers of mbufs.
162 * The maximum number per burst.
165 * The actual number of packets retrieved.
167 unsigned rte_kni_rx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs,
171 * Send a burst of packets to a KNI interface. The packets to be sent out are
172 * stored in rte_mbuf structures whose pointers are supplied in the array of
173 * mbufs, and the maximum number is indicated by num. It handles the freeing of
174 * the mbufs in the free queue of KNI interface.
177 * The KNI interface context.
179 * The array to store the pointers of mbufs.
181 * The maximum number per burst.
184 * The actual number of packets sent.
186 unsigned rte_kni_tx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs,
190 * Get the KNI context of its name.
193 * pointer to the KNI device name.
196 * On success: Pointer to KNI interface.
199 struct rte_kni *rte_kni_get(const char *name);
202 * Get the name given to a KNI device
205 * The KNI instance to query
207 * The pointer to the KNI name
209 const char *rte_kni_get_name(const struct rte_kni *kni);
212 * Register KNI request handling for a specified port,and it can
213 * be called by primary process or secondary process.
216 * pointer to struct rte_kni.
218 * pointer to struct rte_kni_ops.
224 int rte_kni_register_handlers(struct rte_kni *kni, struct rte_kni_ops *ops);
227 * Unregister KNI request handling for a specified port.
230 * pointer to struct rte_kni.
236 int rte_kni_unregister_handlers(struct rte_kni *kni);
239 * Update link carrier state for KNI port.
241 * Update the linkup/linkdown state of a KNI interface in the kernel.
244 * pointer to struct rte_kni.
252 * Previous link state == linkdown: 0
253 * Previous link state == linkup: 1
257 rte_kni_update_link(struct rte_kni *kni, unsigned int linkup);
262 void rte_kni_close(void);
268 #endif /* _RTE_KNI_H_ */