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 <exec-env/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[]);
51 * Structure for configuring KNI device.
55 * KNI name which will be used in relevant network device.
56 * Let the name as short as possible, as it will be part of
59 char name[RTE_KNI_NAMESIZE];
60 uint32_t core_id; /* Core ID to bind kernel thread on */
61 uint16_t group_id; /* Group ID */
62 unsigned mbuf_size; /* mbuf size */
63 struct rte_pci_addr addr;
67 uint8_t force_bind : 1; /* Flag to bind kernel thread */
68 char mac_addr[ETHER_ADDR_LEN]; /* MAC address assigned to KNI */
72 * Initialize and preallocate KNI subsystem
74 * This function is to be executed on the MASTER lcore only, after EAL
75 * initialization and before any KNI interface is attempted to be
78 * @param max_kni_ifaces
79 * The maximum number of KNI interfaces that can coexist concurrently
81 void rte_kni_init(unsigned int max_kni_ifaces);
85 * Allocate KNI interface according to the port id, mbuf size, mbuf pool,
86 * configurations and callbacks for kernel requests.The KNI interface created
87 * in the kernel space is the net interface the traditional Linux application
90 * The rte_kni_alloc shall not be called before rte_kni_init() has been
91 * called. rte_kni_alloc is thread safe.
93 * The mempool should have capacity of more than "2 x KNI_FIFO_COUNT_MAX"
94 * elements for each KNI interface allocated.
97 * The mempool for allocating mbufs for packets.
99 * The pointer to the configurations of the KNI device.
101 * The pointer to the callbacks for the KNI kernel requests.
104 * - The pointer to the context of a KNI interface.
105 * - NULL indicate error.
107 struct rte_kni *rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
108 const struct rte_kni_conf *conf, struct rte_kni_ops *ops);
111 * Release KNI interface according to the context. It will also release the
112 * paired KNI interface in kernel space. All processing on the specific KNI
113 * context need to be stopped before calling this interface.
115 * rte_kni_release is thread safe.
118 * The pointer to the context of an existent KNI interface.
121 * - 0 indicates success.
122 * - negative value indicates failure.
124 int rte_kni_release(struct rte_kni *kni);
127 * It is used to handle the request mbufs sent from kernel space.
128 * Then analyzes it and calls the specific actions for the specific requests.
129 * Finally constructs the response mbuf and puts it back to the resp_q.
132 * The pointer to the context of an existent KNI interface.
136 * - negative value indicates failure.
138 int rte_kni_handle_request(struct rte_kni *kni);
141 * Retrieve a burst of packets from a KNI interface. The retrieved packets are
142 * stored in rte_mbuf structures whose pointers are supplied in the array of
143 * mbufs, and the maximum number is indicated by num. It handles allocating
144 * the mbufs for KNI interface alloc queue.
147 * The KNI interface context.
149 * The array to store the pointers of mbufs.
151 * The maximum number per burst.
154 * The actual number of packets retrieved.
156 unsigned rte_kni_rx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs,
160 * Send a burst of packets to a KNI interface. The packets to be sent out are
161 * stored in rte_mbuf structures whose pointers are supplied in the array of
162 * mbufs, and the maximum number is indicated by num. It handles the freeing of
163 * the mbufs in the free queue of KNI interface.
166 * The KNI interface context.
168 * The array to store the pointers of mbufs.
170 * The maximum number per burst.
173 * The actual number of packets sent.
175 unsigned rte_kni_tx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs,
179 * Get the KNI context of its name.
182 * pointer to the KNI device name.
185 * On success: Pointer to KNI interface.
188 struct rte_kni *rte_kni_get(const char *name);
191 * Get the name given to a KNI device
194 * The KNI instance to query
196 * The pointer to the KNI name
198 const char *rte_kni_get_name(const struct rte_kni *kni);
201 * Register KNI request handling for a specified port,and it can
202 * be called by master process or slave process.
205 * pointer to struct rte_kni.
207 * pointer to struct rte_kni_ops.
213 int rte_kni_register_handlers(struct rte_kni *kni, struct rte_kni_ops *ops);
216 * Unregister KNI request handling for a specified port.
219 * pointer to struct rte_kni.
225 int rte_kni_unregister_handlers(struct rte_kni *kni);
230 void rte_kni_close(void);
236 #endif /* _RTE_KNI_H_ */