xref: /dpdk/lib/kni/rte_kni.c (revision 30a1de10)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation
3  */
4 
5 #ifndef RTE_EXEC_ENV_LINUX
6 #error "KNI is not supported"
7 #endif
8 
9 #include <string.h>
10 #include <fcntl.h>
11 #include <unistd.h>
12 #include <sys/ioctl.h>
13 #include <linux/version.h>
14 
15 #include <rte_string_fns.h>
16 #include <rte_ethdev.h>
17 #include <rte_malloc.h>
18 #include <rte_log.h>
19 #include <rte_kni.h>
20 #include <rte_memzone.h>
21 #include <rte_tailq.h>
22 #include <rte_eal_memconfig.h>
23 #include <rte_kni_common.h>
24 #include "rte_kni_fifo.h"
25 
26 #define MAX_MBUF_BURST_NUM            32
27 
28 /* Maximum number of ring entries */
29 #define KNI_FIFO_COUNT_MAX     1024
30 #define KNI_FIFO_SIZE          (KNI_FIFO_COUNT_MAX * sizeof(void *) + \
31 					sizeof(struct rte_kni_fifo))
32 
33 #define KNI_REQUEST_MBUF_NUM_MAX      32
34 
35 #define KNI_MEM_CHECK(cond, fail) do { if (cond) goto fail; } while (0)
36 
37 #define KNI_MZ_NAME_FMT			"kni_info_%s"
38 #define KNI_TX_Q_MZ_NAME_FMT		"kni_tx_%s"
39 #define KNI_RX_Q_MZ_NAME_FMT		"kni_rx_%s"
40 #define KNI_ALLOC_Q_MZ_NAME_FMT		"kni_alloc_%s"
41 #define KNI_FREE_Q_MZ_NAME_FMT		"kni_free_%s"
42 #define KNI_REQ_Q_MZ_NAME_FMT		"kni_req_%s"
43 #define KNI_RESP_Q_MZ_NAME_FMT		"kni_resp_%s"
44 #define KNI_SYNC_ADDR_MZ_NAME_FMT	"kni_sync_%s"
45 
46 TAILQ_HEAD(rte_kni_list, rte_tailq_entry);
47 
48 static struct rte_tailq_elem rte_kni_tailq = {
49 	.name = "RTE_KNI",
50 };
51 EAL_REGISTER_TAILQ(rte_kni_tailq)
52 
53 /**
54  * KNI context
55  */
56 struct rte_kni {
57 	char name[RTE_KNI_NAMESIZE];        /**< KNI interface name */
58 	uint16_t group_id;                  /**< Group ID of KNI devices */
59 	uint32_t slot_id;                   /**< KNI pool slot ID */
60 	struct rte_mempool *pktmbuf_pool;   /**< pkt mbuf mempool */
61 	unsigned int mbuf_size;                 /**< mbuf size */
62 
63 	const struct rte_memzone *m_tx_q;   /**< TX queue memzone */
64 	const struct rte_memzone *m_rx_q;   /**< RX queue memzone */
65 	const struct rte_memzone *m_alloc_q;/**< Alloc queue memzone */
66 	const struct rte_memzone *m_free_q; /**< Free queue memzone */
67 
68 	struct rte_kni_fifo *tx_q;          /**< TX queue */
69 	struct rte_kni_fifo *rx_q;          /**< RX queue */
70 	struct rte_kni_fifo *alloc_q;       /**< Allocated mbufs queue */
71 	struct rte_kni_fifo *free_q;        /**< To be freed mbufs queue */
72 
73 	const struct rte_memzone *m_req_q;  /**< Request queue memzone */
74 	const struct rte_memzone *m_resp_q; /**< Response queue memzone */
75 	const struct rte_memzone *m_sync_addr;/**< Sync addr memzone */
76 
77 	/* For request & response */
78 	struct rte_kni_fifo *req_q;         /**< Request queue */
79 	struct rte_kni_fifo *resp_q;        /**< Response queue */
80 	void *sync_addr;                   /**< Req/Resp Mem address */
81 
82 	struct rte_kni_ops ops;             /**< operations for request */
83 };
84 
85 enum kni_ops_status {
86 	KNI_REQ_NO_REGISTER = 0,
87 	KNI_REQ_REGISTERED,
88 };
89 
90 static void kni_free_mbufs(struct rte_kni *kni);
91 static void kni_allocate_mbufs(struct rte_kni *kni);
92 
93 static volatile int kni_fd = -1;
94 
95 /* Shall be called before any allocation happens */
96 int
rte_kni_init(unsigned int max_kni_ifaces __rte_unused)97 rte_kni_init(unsigned int max_kni_ifaces __rte_unused)
98 {
99 #if LINUX_VERSION_CODE < KERNEL_VERSION(4, 10, 0)
100 	if (rte_eal_iova_mode() != RTE_IOVA_PA) {
101 		RTE_LOG(ERR, KNI, "KNI requires IOVA as PA\n");
102 		return -1;
103 	}
104 #endif
105 
106 	/* Check FD and open */
107 	if (kni_fd < 0) {
108 		kni_fd = open("/dev/" KNI_DEVICE, O_RDWR);
109 		if (kni_fd < 0) {
110 			RTE_LOG(ERR, KNI,
111 				"Can not open /dev/%s\n", KNI_DEVICE);
112 			return -1;
113 		}
114 	}
115 
116 	return 0;
117 }
118 
119 static struct rte_kni *
__rte_kni_get(const char * name)120 __rte_kni_get(const char *name)
121 {
122 	struct rte_kni *kni;
123 	struct rte_tailq_entry *te;
124 	struct rte_kni_list *kni_list;
125 
126 	kni_list = RTE_TAILQ_CAST(rte_kni_tailq.head, rte_kni_list);
127 
128 	TAILQ_FOREACH(te, kni_list, next) {
129 		kni = te->data;
130 		if (strncmp(name, kni->name, RTE_KNI_NAMESIZE) == 0)
131 			break;
132 	}
133 
134 	if (te == NULL)
135 		kni = NULL;
136 
137 	return kni;
138 }
139 
140 static int
kni_reserve_mz(struct rte_kni * kni)141 kni_reserve_mz(struct rte_kni *kni)
142 {
143 	char mz_name[RTE_MEMZONE_NAMESIZE];
144 
145 	snprintf(mz_name, RTE_MEMZONE_NAMESIZE, KNI_TX_Q_MZ_NAME_FMT, kni->name);
146 	kni->m_tx_q = rte_memzone_reserve(mz_name, KNI_FIFO_SIZE, SOCKET_ID_ANY,
147 			RTE_MEMZONE_IOVA_CONTIG);
148 	KNI_MEM_CHECK(kni->m_tx_q == NULL, tx_q_fail);
149 
150 	snprintf(mz_name, RTE_MEMZONE_NAMESIZE, KNI_RX_Q_MZ_NAME_FMT, kni->name);
151 	kni->m_rx_q = rte_memzone_reserve(mz_name, KNI_FIFO_SIZE, SOCKET_ID_ANY,
152 			RTE_MEMZONE_IOVA_CONTIG);
153 	KNI_MEM_CHECK(kni->m_rx_q == NULL, rx_q_fail);
154 
155 	snprintf(mz_name, RTE_MEMZONE_NAMESIZE, KNI_ALLOC_Q_MZ_NAME_FMT, kni->name);
156 	kni->m_alloc_q = rte_memzone_reserve(mz_name, KNI_FIFO_SIZE, SOCKET_ID_ANY,
157 			RTE_MEMZONE_IOVA_CONTIG);
158 	KNI_MEM_CHECK(kni->m_alloc_q == NULL, alloc_q_fail);
159 
160 	snprintf(mz_name, RTE_MEMZONE_NAMESIZE, KNI_FREE_Q_MZ_NAME_FMT, kni->name);
161 	kni->m_free_q = rte_memzone_reserve(mz_name, KNI_FIFO_SIZE, SOCKET_ID_ANY,
162 			RTE_MEMZONE_IOVA_CONTIG);
163 	KNI_MEM_CHECK(kni->m_free_q == NULL, free_q_fail);
164 
165 	snprintf(mz_name, RTE_MEMZONE_NAMESIZE, KNI_REQ_Q_MZ_NAME_FMT, kni->name);
166 	kni->m_req_q = rte_memzone_reserve(mz_name, KNI_FIFO_SIZE, SOCKET_ID_ANY,
167 			RTE_MEMZONE_IOVA_CONTIG);
168 	KNI_MEM_CHECK(kni->m_req_q == NULL, req_q_fail);
169 
170 	snprintf(mz_name, RTE_MEMZONE_NAMESIZE, KNI_RESP_Q_MZ_NAME_FMT, kni->name);
171 	kni->m_resp_q = rte_memzone_reserve(mz_name, KNI_FIFO_SIZE, SOCKET_ID_ANY,
172 			RTE_MEMZONE_IOVA_CONTIG);
173 	KNI_MEM_CHECK(kni->m_resp_q == NULL, resp_q_fail);
174 
175 	snprintf(mz_name, RTE_MEMZONE_NAMESIZE, KNI_SYNC_ADDR_MZ_NAME_FMT, kni->name);
176 	kni->m_sync_addr = rte_memzone_reserve(mz_name, KNI_FIFO_SIZE, SOCKET_ID_ANY,
177 			RTE_MEMZONE_IOVA_CONTIG);
178 	KNI_MEM_CHECK(kni->m_sync_addr == NULL, sync_addr_fail);
179 
180 	return 0;
181 
182 sync_addr_fail:
183 	rte_memzone_free(kni->m_resp_q);
184 resp_q_fail:
185 	rte_memzone_free(kni->m_req_q);
186 req_q_fail:
187 	rte_memzone_free(kni->m_free_q);
188 free_q_fail:
189 	rte_memzone_free(kni->m_alloc_q);
190 alloc_q_fail:
191 	rte_memzone_free(kni->m_rx_q);
192 rx_q_fail:
193 	rte_memzone_free(kni->m_tx_q);
194 tx_q_fail:
195 	return -1;
196 }
197 
198 static void
kni_release_mz(struct rte_kni * kni)199 kni_release_mz(struct rte_kni *kni)
200 {
201 	rte_memzone_free(kni->m_tx_q);
202 	rte_memzone_free(kni->m_rx_q);
203 	rte_memzone_free(kni->m_alloc_q);
204 	rte_memzone_free(kni->m_free_q);
205 	rte_memzone_free(kni->m_req_q);
206 	rte_memzone_free(kni->m_resp_q);
207 	rte_memzone_free(kni->m_sync_addr);
208 }
209 
210 struct rte_kni *
rte_kni_alloc(struct rte_mempool * pktmbuf_pool,const struct rte_kni_conf * conf,struct rte_kni_ops * ops)211 rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
212 	      const struct rte_kni_conf *conf,
213 	      struct rte_kni_ops *ops)
214 {
215 	int ret;
216 	struct rte_kni_device_info dev_info;
217 	struct rte_kni *kni;
218 	struct rte_tailq_entry *te;
219 	struct rte_kni_list *kni_list;
220 
221 	if (!pktmbuf_pool || !conf || !conf->name[0])
222 		return NULL;
223 
224 	/* Check if KNI subsystem has been initialized */
225 	if (kni_fd < 0) {
226 		RTE_LOG(ERR, KNI, "KNI subsystem has not been initialized. Invoke rte_kni_init() first\n");
227 		return NULL;
228 	}
229 
230 	rte_mcfg_tailq_write_lock();
231 
232 	kni = __rte_kni_get(conf->name);
233 	if (kni != NULL) {
234 		RTE_LOG(ERR, KNI, "KNI already exists\n");
235 		goto unlock;
236 	}
237 
238 	te = rte_zmalloc("KNI_TAILQ_ENTRY", sizeof(*te), 0);
239 	if (te == NULL) {
240 		RTE_LOG(ERR, KNI, "Failed to allocate tailq entry\n");
241 		goto unlock;
242 	}
243 
244 	kni = rte_zmalloc("KNI", sizeof(struct rte_kni), RTE_CACHE_LINE_SIZE);
245 	if (kni == NULL) {
246 		RTE_LOG(ERR, KNI, "KNI memory allocation failed\n");
247 		goto kni_fail;
248 	}
249 
250 	strlcpy(kni->name, conf->name, RTE_KNI_NAMESIZE);
251 
252 	if (ops)
253 		memcpy(&kni->ops, ops, sizeof(struct rte_kni_ops));
254 	else
255 		kni->ops.port_id = UINT16_MAX;
256 
257 	memset(&dev_info, 0, sizeof(dev_info));
258 	dev_info.core_id = conf->core_id;
259 	dev_info.force_bind = conf->force_bind;
260 	dev_info.group_id = conf->group_id;
261 	dev_info.mbuf_size = conf->mbuf_size;
262 	dev_info.mtu = conf->mtu;
263 	dev_info.min_mtu = conf->min_mtu;
264 	dev_info.max_mtu = conf->max_mtu;
265 
266 	memcpy(dev_info.mac_addr, conf->mac_addr, RTE_ETHER_ADDR_LEN);
267 
268 	strlcpy(dev_info.name, conf->name, RTE_KNI_NAMESIZE);
269 
270 	ret = kni_reserve_mz(kni);
271 	if (ret < 0)
272 		goto mz_fail;
273 
274 	/* TX RING */
275 	kni->tx_q = kni->m_tx_q->addr;
276 	kni_fifo_init(kni->tx_q, KNI_FIFO_COUNT_MAX);
277 	dev_info.tx_phys = kni->m_tx_q->iova;
278 
279 	/* RX RING */
280 	kni->rx_q = kni->m_rx_q->addr;
281 	kni_fifo_init(kni->rx_q, KNI_FIFO_COUNT_MAX);
282 	dev_info.rx_phys = kni->m_rx_q->iova;
283 
284 	/* ALLOC RING */
285 	kni->alloc_q = kni->m_alloc_q->addr;
286 	kni_fifo_init(kni->alloc_q, KNI_FIFO_COUNT_MAX);
287 	dev_info.alloc_phys = kni->m_alloc_q->iova;
288 
289 	/* FREE RING */
290 	kni->free_q = kni->m_free_q->addr;
291 	kni_fifo_init(kni->free_q, KNI_FIFO_COUNT_MAX);
292 	dev_info.free_phys = kni->m_free_q->iova;
293 
294 	/* Request RING */
295 	kni->req_q = kni->m_req_q->addr;
296 	kni_fifo_init(kni->req_q, KNI_FIFO_COUNT_MAX);
297 	dev_info.req_phys = kni->m_req_q->iova;
298 
299 	/* Response RING */
300 	kni->resp_q = kni->m_resp_q->addr;
301 	kni_fifo_init(kni->resp_q, KNI_FIFO_COUNT_MAX);
302 	dev_info.resp_phys = kni->m_resp_q->iova;
303 
304 	/* Req/Resp sync mem area */
305 	kni->sync_addr = kni->m_sync_addr->addr;
306 	dev_info.sync_va = kni->m_sync_addr->addr;
307 	dev_info.sync_phys = kni->m_sync_addr->iova;
308 
309 	kni->pktmbuf_pool = pktmbuf_pool;
310 	kni->group_id = conf->group_id;
311 	kni->mbuf_size = conf->mbuf_size;
312 
313 	dev_info.iova_mode = (rte_eal_iova_mode() == RTE_IOVA_VA) ? 1 : 0;
314 
315 	ret = ioctl(kni_fd, RTE_KNI_IOCTL_CREATE, &dev_info);
316 	if (ret < 0)
317 		goto ioctl_fail;
318 
319 	te->data = kni;
320 
321 	kni_list = RTE_TAILQ_CAST(rte_kni_tailq.head, rte_kni_list);
322 	TAILQ_INSERT_TAIL(kni_list, te, next);
323 
324 	rte_mcfg_tailq_write_unlock();
325 
326 	/* Allocate mbufs and then put them into alloc_q */
327 	kni_allocate_mbufs(kni);
328 
329 	return kni;
330 
331 ioctl_fail:
332 	kni_release_mz(kni);
333 mz_fail:
334 	rte_free(kni);
335 kni_fail:
336 	rte_free(te);
337 unlock:
338 	rte_mcfg_tailq_write_unlock();
339 
340 	return NULL;
341 }
342 
343 static void
kni_free_fifo(struct rte_kni_fifo * fifo)344 kni_free_fifo(struct rte_kni_fifo *fifo)
345 {
346 	int ret;
347 	struct rte_mbuf *pkt;
348 
349 	do {
350 		ret = kni_fifo_get(fifo, (void **)&pkt, 1);
351 		if (ret)
352 			rte_pktmbuf_free(pkt);
353 	} while (ret);
354 }
355 
356 static void *
va2pa(struct rte_mbuf * m)357 va2pa(struct rte_mbuf *m)
358 {
359 	return (void *)((unsigned long)m -
360 			((unsigned long)m->buf_addr -
361 			 (unsigned long)m->buf_iova));
362 }
363 
364 static void *
va2pa_all(struct rte_mbuf * mbuf)365 va2pa_all(struct rte_mbuf *mbuf)
366 {
367 	void *phy_mbuf = va2pa(mbuf);
368 	struct rte_mbuf *next = mbuf->next;
369 	while (next) {
370 		mbuf->next = va2pa(next);
371 		mbuf = next;
372 		next = mbuf->next;
373 	}
374 	return phy_mbuf;
375 }
376 
377 static void
obj_free(struct rte_mempool * mp __rte_unused,void * opaque,void * obj,unsigned obj_idx __rte_unused)378 obj_free(struct rte_mempool *mp __rte_unused, void *opaque, void *obj,
379 		unsigned obj_idx __rte_unused)
380 {
381 	struct rte_mbuf *m = obj;
382 	void *mbuf_phys = opaque;
383 
384 	if (va2pa(m) == mbuf_phys)
385 		rte_pktmbuf_free(m);
386 }
387 
388 static void
kni_free_fifo_phy(struct rte_mempool * mp,struct rte_kni_fifo * fifo)389 kni_free_fifo_phy(struct rte_mempool *mp, struct rte_kni_fifo *fifo)
390 {
391 	void *mbuf_phys;
392 	int ret;
393 
394 	do {
395 		ret = kni_fifo_get(fifo, &mbuf_phys, 1);
396 		if (ret)
397 			rte_mempool_obj_iter(mp, obj_free, mbuf_phys);
398 	} while (ret);
399 }
400 
401 int
rte_kni_release(struct rte_kni * kni)402 rte_kni_release(struct rte_kni *kni)
403 {
404 	struct rte_tailq_entry *te;
405 	struct rte_kni_list *kni_list;
406 	struct rte_kni_device_info dev_info;
407 	uint32_t retry = 5;
408 
409 	if (!kni)
410 		return -1;
411 
412 	kni_list = RTE_TAILQ_CAST(rte_kni_tailq.head, rte_kni_list);
413 
414 	rte_mcfg_tailq_write_lock();
415 
416 	TAILQ_FOREACH(te, kni_list, next) {
417 		if (te->data == kni)
418 			break;
419 	}
420 
421 	if (te == NULL)
422 		goto unlock;
423 
424 	strlcpy(dev_info.name, kni->name, sizeof(dev_info.name));
425 	if (ioctl(kni_fd, RTE_KNI_IOCTL_RELEASE, &dev_info) < 0) {
426 		RTE_LOG(ERR, KNI, "Fail to release kni device\n");
427 		goto unlock;
428 	}
429 
430 	TAILQ_REMOVE(kni_list, te, next);
431 
432 	rte_mcfg_tailq_write_unlock();
433 
434 	/* mbufs in all fifo should be released, except request/response */
435 
436 	/* wait until all rxq packets processed by kernel */
437 	while (kni_fifo_count(kni->rx_q) && retry--)
438 		usleep(1000);
439 
440 	if (kni_fifo_count(kni->rx_q))
441 		RTE_LOG(ERR, KNI, "Fail to free all Rx-q items\n");
442 
443 	kni_free_fifo_phy(kni->pktmbuf_pool, kni->alloc_q);
444 	kni_free_fifo(kni->tx_q);
445 	kni_free_fifo(kni->free_q);
446 
447 	kni_release_mz(kni);
448 
449 	rte_free(kni);
450 
451 	rte_free(te);
452 
453 	return 0;
454 
455 unlock:
456 	rte_mcfg_tailq_write_unlock();
457 
458 	return -1;
459 }
460 
461 /* default callback for request of configuring device mac address */
462 static int
kni_config_mac_address(uint16_t port_id,uint8_t mac_addr[])463 kni_config_mac_address(uint16_t port_id, uint8_t mac_addr[])
464 {
465 	int ret = 0;
466 
467 	if (!rte_eth_dev_is_valid_port(port_id)) {
468 		RTE_LOG(ERR, KNI, "Invalid port id %d\n", port_id);
469 		return -EINVAL;
470 	}
471 
472 	RTE_LOG(INFO, KNI, "Configure mac address of %d", port_id);
473 
474 	ret = rte_eth_dev_default_mac_addr_set(port_id,
475 					(struct rte_ether_addr *)mac_addr);
476 	if (ret < 0)
477 		RTE_LOG(ERR, KNI, "Failed to config mac_addr for port %d\n",
478 			port_id);
479 
480 	return ret;
481 }
482 
483 /* default callback for request of configuring promiscuous mode */
484 static int
kni_config_promiscusity(uint16_t port_id,uint8_t to_on)485 kni_config_promiscusity(uint16_t port_id, uint8_t to_on)
486 {
487 	int ret;
488 
489 	if (!rte_eth_dev_is_valid_port(port_id)) {
490 		RTE_LOG(ERR, KNI, "Invalid port id %d\n", port_id);
491 		return -EINVAL;
492 	}
493 
494 	RTE_LOG(INFO, KNI, "Configure promiscuous mode of %d to %d\n",
495 		port_id, to_on);
496 
497 	if (to_on)
498 		ret = rte_eth_promiscuous_enable(port_id);
499 	else
500 		ret = rte_eth_promiscuous_disable(port_id);
501 
502 	if (ret != 0)
503 		RTE_LOG(ERR, KNI,
504 			"Failed to %s promiscuous mode for port %u: %s\n",
505 			to_on ? "enable" : "disable", port_id,
506 			rte_strerror(-ret));
507 
508 	return ret;
509 }
510 
511 /* default callback for request of configuring allmulticast mode */
512 static int
kni_config_allmulticast(uint16_t port_id,uint8_t to_on)513 kni_config_allmulticast(uint16_t port_id, uint8_t to_on)
514 {
515 	int ret;
516 
517 	if (!rte_eth_dev_is_valid_port(port_id)) {
518 		RTE_LOG(ERR, KNI, "Invalid port id %d\n", port_id);
519 		return -EINVAL;
520 	}
521 
522 	RTE_LOG(INFO, KNI, "Configure allmulticast mode of %d to %d\n",
523 		port_id, to_on);
524 
525 	if (to_on)
526 		ret = rte_eth_allmulticast_enable(port_id);
527 	else
528 		ret = rte_eth_allmulticast_disable(port_id);
529 	if (ret != 0)
530 		RTE_LOG(ERR, KNI,
531 			"Failed to %s allmulticast mode for port %u: %s\n",
532 			to_on ? "enable" : "disable", port_id,
533 			rte_strerror(-ret));
534 
535 	return ret;
536 }
537 
538 int
rte_kni_handle_request(struct rte_kni * kni)539 rte_kni_handle_request(struct rte_kni *kni)
540 {
541 	unsigned int ret;
542 	struct rte_kni_request *req = NULL;
543 
544 	if (kni == NULL)
545 		return -1;
546 
547 	/* Get request mbuf */
548 	ret = kni_fifo_get(kni->req_q, (void **)&req, 1);
549 	if (ret != 1)
550 		return 0; /* It is OK of can not getting the request mbuf */
551 
552 	if (req != kni->sync_addr) {
553 		RTE_LOG(ERR, KNI, "Wrong req pointer %p\n", req);
554 		return -1;
555 	}
556 
557 	/* Analyze the request and call the relevant actions for it */
558 	switch (req->req_id) {
559 	case RTE_KNI_REQ_CHANGE_MTU: /* Change MTU */
560 		if (kni->ops.change_mtu)
561 			req->result = kni->ops.change_mtu(kni->ops.port_id,
562 							req->new_mtu);
563 		break;
564 	case RTE_KNI_REQ_CFG_NETWORK_IF: /* Set network interface up/down */
565 		if (kni->ops.config_network_if)
566 			req->result = kni->ops.config_network_if(kni->ops.port_id,
567 								 req->if_up);
568 		break;
569 	case RTE_KNI_REQ_CHANGE_MAC_ADDR: /* Change MAC Address */
570 		if (kni->ops.config_mac_address)
571 			req->result = kni->ops.config_mac_address(
572 					kni->ops.port_id, req->mac_addr);
573 		else if (kni->ops.port_id != UINT16_MAX)
574 			req->result = kni_config_mac_address(
575 					kni->ops.port_id, req->mac_addr);
576 		break;
577 	case RTE_KNI_REQ_CHANGE_PROMISC: /* Change PROMISCUOUS MODE */
578 		if (kni->ops.config_promiscusity)
579 			req->result = kni->ops.config_promiscusity(
580 					kni->ops.port_id, req->promiscusity);
581 		else if (kni->ops.port_id != UINT16_MAX)
582 			req->result = kni_config_promiscusity(
583 					kni->ops.port_id, req->promiscusity);
584 		break;
585 	case RTE_KNI_REQ_CHANGE_ALLMULTI: /* Change ALLMULTICAST MODE */
586 		if (kni->ops.config_allmulticast)
587 			req->result = kni->ops.config_allmulticast(
588 					kni->ops.port_id, req->allmulti);
589 		else if (kni->ops.port_id != UINT16_MAX)
590 			req->result = kni_config_allmulticast(
591 					kni->ops.port_id, req->allmulti);
592 		break;
593 	default:
594 		RTE_LOG(ERR, KNI, "Unknown request id %u\n", req->req_id);
595 		req->result = -EINVAL;
596 		break;
597 	}
598 
599 	/* if needed, construct response buffer and put it back to resp_q */
600 	if (!req->async)
601 		ret = kni_fifo_put(kni->resp_q, (void **)&req, 1);
602 	else
603 		ret = 1;
604 	if (ret != 1) {
605 		RTE_LOG(ERR, KNI, "Fail to put the muf back to resp_q\n");
606 		return -1; /* It is an error of can't putting the mbuf back */
607 	}
608 
609 	return 0;
610 }
611 
612 unsigned
rte_kni_tx_burst(struct rte_kni * kni,struct rte_mbuf ** mbufs,unsigned int num)613 rte_kni_tx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, unsigned int num)
614 {
615 	num = RTE_MIN(kni_fifo_free_count(kni->rx_q), num);
616 	void *phy_mbufs[num];
617 	unsigned int ret;
618 	unsigned int i;
619 
620 	for (i = 0; i < num; i++)
621 		phy_mbufs[i] = va2pa_all(mbufs[i]);
622 
623 	ret = kni_fifo_put(kni->rx_q, phy_mbufs, num);
624 
625 	/* Get mbufs from free_q and then free them */
626 	kni_free_mbufs(kni);
627 
628 	return ret;
629 }
630 
631 unsigned
rte_kni_rx_burst(struct rte_kni * kni,struct rte_mbuf ** mbufs,unsigned int num)632 rte_kni_rx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, unsigned int num)
633 {
634 	unsigned int ret = kni_fifo_get(kni->tx_q, (void **)mbufs, num);
635 
636 	/* If buffers removed, allocate mbufs and then put them into alloc_q */
637 	if (ret)
638 		kni_allocate_mbufs(kni);
639 
640 	return ret;
641 }
642 
643 static void
kni_free_mbufs(struct rte_kni * kni)644 kni_free_mbufs(struct rte_kni *kni)
645 {
646 	int i, ret;
647 	struct rte_mbuf *pkts[MAX_MBUF_BURST_NUM];
648 
649 	ret = kni_fifo_get(kni->free_q, (void **)pkts, MAX_MBUF_BURST_NUM);
650 	if (likely(ret > 0)) {
651 		for (i = 0; i < ret; i++)
652 			rte_pktmbuf_free(pkts[i]);
653 	}
654 }
655 
656 static void
kni_allocate_mbufs(struct rte_kni * kni)657 kni_allocate_mbufs(struct rte_kni *kni)
658 {
659 	int i, ret;
660 	struct rte_mbuf *pkts[MAX_MBUF_BURST_NUM];
661 	void *phys[MAX_MBUF_BURST_NUM];
662 	int allocq_free;
663 
664 	RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, pool) !=
665 			 offsetof(struct rte_kni_mbuf, pool));
666 	RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, buf_addr) !=
667 			 offsetof(struct rte_kni_mbuf, buf_addr));
668 	RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, next) !=
669 			 offsetof(struct rte_kni_mbuf, next));
670 	RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, data_off) !=
671 			 offsetof(struct rte_kni_mbuf, data_off));
672 	RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, data_len) !=
673 			 offsetof(struct rte_kni_mbuf, data_len));
674 	RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, pkt_len) !=
675 			 offsetof(struct rte_kni_mbuf, pkt_len));
676 	RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, ol_flags) !=
677 			 offsetof(struct rte_kni_mbuf, ol_flags));
678 
679 	/* Check if pktmbuf pool has been configured */
680 	if (kni->pktmbuf_pool == NULL) {
681 		RTE_LOG(ERR, KNI, "No valid mempool for allocating mbufs\n");
682 		return;
683 	}
684 
685 	allocq_free = kni_fifo_free_count(kni->alloc_q);
686 	allocq_free = (allocq_free > MAX_MBUF_BURST_NUM) ?
687 		MAX_MBUF_BURST_NUM : allocq_free;
688 	for (i = 0; i < allocq_free; i++) {
689 		pkts[i] = rte_pktmbuf_alloc(kni->pktmbuf_pool);
690 		if (unlikely(pkts[i] == NULL)) {
691 			/* Out of memory */
692 			RTE_LOG(ERR, KNI, "Out of memory\n");
693 			break;
694 		}
695 		phys[i] = va2pa(pkts[i]);
696 	}
697 
698 	/* No pkt mbuf allocated */
699 	if (i <= 0)
700 		return;
701 
702 	ret = kni_fifo_put(kni->alloc_q, phys, i);
703 
704 	/* Check if any mbufs not put into alloc_q, and then free them */
705 	if (ret >= 0 && ret < i && ret < MAX_MBUF_BURST_NUM) {
706 		int j;
707 
708 		for (j = ret; j < i; j++)
709 			rte_pktmbuf_free(pkts[j]);
710 	}
711 }
712 
713 struct rte_kni *
rte_kni_get(const char * name)714 rte_kni_get(const char *name)
715 {
716 	struct rte_kni *kni;
717 
718 	if (name == NULL || name[0] == '\0')
719 		return NULL;
720 
721 	rte_mcfg_tailq_read_lock();
722 
723 	kni = __rte_kni_get(name);
724 
725 	rte_mcfg_tailq_read_unlock();
726 
727 	return kni;
728 }
729 
730 const char *
rte_kni_get_name(const struct rte_kni * kni)731 rte_kni_get_name(const struct rte_kni *kni)
732 {
733 	return kni->name;
734 }
735 
736 static enum kni_ops_status
kni_check_request_register(struct rte_kni_ops * ops)737 kni_check_request_register(struct rte_kni_ops *ops)
738 {
739 	/* check if KNI request ops has been registered*/
740 	if (ops == NULL)
741 		return KNI_REQ_NO_REGISTER;
742 
743 	if (ops->change_mtu == NULL
744 	    && ops->config_network_if == NULL
745 	    && ops->config_mac_address == NULL
746 	    && ops->config_promiscusity == NULL
747 	    && ops->config_allmulticast == NULL)
748 		return KNI_REQ_NO_REGISTER;
749 
750 	return KNI_REQ_REGISTERED;
751 }
752 
753 int
rte_kni_register_handlers(struct rte_kni * kni,struct rte_kni_ops * ops)754 rte_kni_register_handlers(struct rte_kni *kni, struct rte_kni_ops *ops)
755 {
756 	enum kni_ops_status req_status;
757 
758 	if (ops == NULL) {
759 		RTE_LOG(ERR, KNI, "Invalid KNI request operation.\n");
760 		return -1;
761 	}
762 
763 	if (kni == NULL) {
764 		RTE_LOG(ERR, KNI, "Invalid kni info.\n");
765 		return -1;
766 	}
767 
768 	req_status = kni_check_request_register(&kni->ops);
769 	if (req_status == KNI_REQ_REGISTERED) {
770 		RTE_LOG(ERR, KNI, "The KNI request operation has already registered.\n");
771 		return -1;
772 	}
773 
774 	memcpy(&kni->ops, ops, sizeof(struct rte_kni_ops));
775 	return 0;
776 }
777 
778 int
rte_kni_unregister_handlers(struct rte_kni * kni)779 rte_kni_unregister_handlers(struct rte_kni *kni)
780 {
781 	if (kni == NULL) {
782 		RTE_LOG(ERR, KNI, "Invalid kni info.\n");
783 		return -1;
784 	}
785 
786 	memset(&kni->ops, 0, sizeof(struct rte_kni_ops));
787 
788 	return 0;
789 }
790 
791 int
rte_kni_update_link(struct rte_kni * kni,unsigned int linkup)792 rte_kni_update_link(struct rte_kni *kni, unsigned int linkup)
793 {
794 	char path[64];
795 	char old_carrier[2];
796 	const char *new_carrier;
797 	int old_linkup;
798 	int fd, ret;
799 
800 	if (kni == NULL)
801 		return -1;
802 
803 	snprintf(path, sizeof(path), "/sys/devices/virtual/net/%s/carrier",
804 		kni->name);
805 
806 	fd = open(path, O_RDWR);
807 	if (fd == -1) {
808 		RTE_LOG(ERR, KNI, "Failed to open file: %s.\n", path);
809 		return -1;
810 	}
811 
812 	ret = read(fd, old_carrier, 2);
813 	if (ret < 1) {
814 		close(fd);
815 		return -1;
816 	}
817 	old_linkup = (old_carrier[0] == '1');
818 
819 	if (old_linkup == (int)linkup)
820 		goto out;
821 
822 	new_carrier = linkup ? "1" : "0";
823 	ret = write(fd, new_carrier, 1);
824 	if (ret < 1) {
825 		RTE_LOG(ERR, KNI, "Failed to write file: %s.\n", path);
826 		close(fd);
827 		return -1;
828 	}
829 out:
830 	close(fd);
831 	return old_linkup;
832 }
833 
834 void
rte_kni_close(void)835 rte_kni_close(void)
836 {
837 	if (kni_fd < 0)
838 		return;
839 
840 	close(kni_fd);
841 	kni_fd = -1;
842 }
843