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