doc: add inline crypto feature
[dpdk.git] / lib / librte_kni / rte_kni.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef RTE_EXEC_ENV_LINUXAPP
35 #error "KNI is not supported"
36 #endif
37
38 #include <string.h>
39 #include <fcntl.h>
40 #include <unistd.h>
41 #include <sys/ioctl.h>
42
43 #include <rte_spinlock.h>
44 #include <rte_string_fns.h>
45 #include <rte_ethdev.h>
46 #include <rte_malloc.h>
47 #include <rte_log.h>
48 #include <rte_kni.h>
49 #include <rte_memzone.h>
50 #include <exec-env/rte_kni_common.h>
51 #include "rte_kni_fifo.h"
52
53 #define MAX_MBUF_BURST_NUM            32
54
55 /* Maximum number of ring entries */
56 #define KNI_FIFO_COUNT_MAX     1024
57 #define KNI_FIFO_SIZE          (KNI_FIFO_COUNT_MAX * sizeof(void *) + \
58                                         sizeof(struct rte_kni_fifo))
59
60 #define KNI_REQUEST_MBUF_NUM_MAX      32
61
62 #define KNI_MEM_CHECK(cond) do { if (cond) goto kni_fail; } while (0)
63
64 /**
65  * KNI context
66  */
67 struct rte_kni {
68         char name[RTE_KNI_NAMESIZE];        /**< KNI interface name */
69         uint16_t group_id;                  /**< Group ID of KNI devices */
70         uint32_t slot_id;                   /**< KNI pool slot ID */
71         struct rte_mempool *pktmbuf_pool;   /**< pkt mbuf mempool */
72         unsigned mbuf_size;                 /**< mbuf size */
73
74         struct rte_kni_fifo *tx_q;          /**< TX queue */
75         struct rte_kni_fifo *rx_q;          /**< RX queue */
76         struct rte_kni_fifo *alloc_q;       /**< Allocated mbufs queue */
77         struct rte_kni_fifo *free_q;        /**< To be freed mbufs queue */
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         uint8_t in_use : 1;                 /**< kni in use */
86 };
87
88 enum kni_ops_status {
89         KNI_REQ_NO_REGISTER = 0,
90         KNI_REQ_REGISTERED,
91 };
92
93 /**
94  * KNI memzone pool slot
95  */
96 struct rte_kni_memzone_slot {
97         uint32_t id;
98         uint8_t in_use : 1;                    /**< slot in use */
99
100         /* Memzones */
101         const struct rte_memzone *m_ctx;       /**< KNI ctx */
102         const struct rte_memzone *m_tx_q;      /**< TX queue */
103         const struct rte_memzone *m_rx_q;      /**< RX queue */
104         const struct rte_memzone *m_alloc_q;   /**< Allocated mbufs queue */
105         const struct rte_memzone *m_free_q;    /**< To be freed mbufs queue */
106         const struct rte_memzone *m_req_q;     /**< Request queue */
107         const struct rte_memzone *m_resp_q;    /**< Response queue */
108         const struct rte_memzone *m_sync_addr;
109
110         /* Free linked list */
111         struct rte_kni_memzone_slot *next;     /**< Next slot link.list */
112 };
113
114 /**
115  * KNI memzone pool
116  */
117 struct rte_kni_memzone_pool {
118         uint8_t initialized : 1;            /**< Global KNI pool init flag */
119
120         uint32_t max_ifaces;                /**< Max. num of KNI ifaces */
121         struct rte_kni_memzone_slot *slots;        /**< Pool slots */
122         rte_spinlock_t mutex;               /**< alloc/release mutex */
123
124         /* Free memzone slots linked-list */
125         struct rte_kni_memzone_slot *free;         /**< First empty slot */
126         struct rte_kni_memzone_slot *free_tail;    /**< Last empty slot */
127 };
128
129
130 static void kni_free_mbufs(struct rte_kni *kni);
131 static void kni_allocate_mbufs(struct rte_kni *kni);
132
133 static volatile int kni_fd = -1;
134 static struct rte_kni_memzone_pool kni_memzone_pool = {
135         .initialized = 0,
136 };
137
138 static const struct rte_memzone *
139 kni_memzone_reserve(const char *name, size_t len, int socket_id,
140                                                 unsigned flags)
141 {
142         const struct rte_memzone *mz = rte_memzone_lookup(name);
143
144         if (mz == NULL)
145                 mz = rte_memzone_reserve(name, len, socket_id, flags);
146
147         return mz;
148 }
149
150 /* Pool mgmt */
151 static struct rte_kni_memzone_slot*
152 kni_memzone_pool_alloc(void)
153 {
154         struct rte_kni_memzone_slot *slot;
155
156         rte_spinlock_lock(&kni_memzone_pool.mutex);
157
158         if (!kni_memzone_pool.free) {
159                 rte_spinlock_unlock(&kni_memzone_pool.mutex);
160                 return NULL;
161         }
162
163         slot = kni_memzone_pool.free;
164         kni_memzone_pool.free = slot->next;
165         slot->in_use = 1;
166
167         if (!kni_memzone_pool.free)
168                 kni_memzone_pool.free_tail = NULL;
169
170         rte_spinlock_unlock(&kni_memzone_pool.mutex);
171
172         return slot;
173 }
174
175 static void
176 kni_memzone_pool_release(struct rte_kni_memzone_slot *slot)
177 {
178         rte_spinlock_lock(&kni_memzone_pool.mutex);
179
180         if (kni_memzone_pool.free)
181                 kni_memzone_pool.free_tail->next = slot;
182         else
183                 kni_memzone_pool.free = slot;
184
185         kni_memzone_pool.free_tail = slot;
186         slot->next = NULL;
187         slot->in_use = 0;
188
189         rte_spinlock_unlock(&kni_memzone_pool.mutex);
190 }
191
192
193 /* Shall be called before any allocation happens */
194 void
195 rte_kni_init(unsigned int max_kni_ifaces)
196 {
197         uint32_t i;
198         struct rte_kni_memzone_slot *it;
199         const struct rte_memzone *mz;
200 #define OBJNAMSIZ 32
201         char obj_name[OBJNAMSIZ];
202         char mz_name[RTE_MEMZONE_NAMESIZE];
203
204         /* Immediately return if KNI is already initialized */
205         if (kni_memzone_pool.initialized) {
206                 RTE_LOG(WARNING, KNI, "Double call to rte_kni_init()");
207                 return;
208         }
209
210         if (max_kni_ifaces == 0) {
211                 RTE_LOG(ERR, KNI, "Invalid number of max_kni_ifaces %d\n",
212                                                         max_kni_ifaces);
213                 RTE_LOG(ERR, KNI, "Unable to initialize KNI\n");
214                 return;
215         }
216
217         /* Check FD and open */
218         if (kni_fd < 0) {
219                 kni_fd = open("/dev/" KNI_DEVICE, O_RDWR);
220                 if (kni_fd < 0) {
221                         RTE_LOG(ERR, KNI,
222                                 "Can not open /dev/%s\n", KNI_DEVICE);
223                         return;
224                 }
225         }
226
227         /* Allocate slot objects */
228         kni_memzone_pool.slots = (struct rte_kni_memzone_slot *)
229                                         rte_malloc(NULL,
230                                         sizeof(struct rte_kni_memzone_slot) *
231                                         max_kni_ifaces,
232                                         0);
233         KNI_MEM_CHECK(kni_memzone_pool.slots == NULL);
234
235         /* Initialize general pool variables */
236         kni_memzone_pool.initialized = 1;
237         kni_memzone_pool.max_ifaces = max_kni_ifaces;
238         kni_memzone_pool.free = &kni_memzone_pool.slots[0];
239         rte_spinlock_init(&kni_memzone_pool.mutex);
240
241         /* Pre-allocate all memzones of all the slots; panic on error */
242         for (i = 0; i < max_kni_ifaces; i++) {
243
244                 /* Recover current slot */
245                 it = &kni_memzone_pool.slots[i];
246                 it->id = i;
247
248                 /* Allocate KNI context */
249                 snprintf(mz_name, RTE_MEMZONE_NAMESIZE, "KNI_INFO_%d", i);
250                 mz = kni_memzone_reserve(mz_name, sizeof(struct rte_kni),
251                                         SOCKET_ID_ANY, 0);
252                 KNI_MEM_CHECK(mz == NULL);
253                 it->m_ctx = mz;
254
255                 /* TX RING */
256                 snprintf(obj_name, OBJNAMSIZ, "kni_tx_%d", i);
257                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
258                                                         SOCKET_ID_ANY, 0);
259                 KNI_MEM_CHECK(mz == NULL);
260                 it->m_tx_q = mz;
261
262                 /* RX RING */
263                 snprintf(obj_name, OBJNAMSIZ, "kni_rx_%d", i);
264                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
265                                                         SOCKET_ID_ANY, 0);
266                 KNI_MEM_CHECK(mz == NULL);
267                 it->m_rx_q = mz;
268
269                 /* ALLOC RING */
270                 snprintf(obj_name, OBJNAMSIZ, "kni_alloc_%d", i);
271                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
272                                                         SOCKET_ID_ANY, 0);
273                 KNI_MEM_CHECK(mz == NULL);
274                 it->m_alloc_q = mz;
275
276                 /* FREE RING */
277                 snprintf(obj_name, OBJNAMSIZ, "kni_free_%d", i);
278                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
279                                                         SOCKET_ID_ANY, 0);
280                 KNI_MEM_CHECK(mz == NULL);
281                 it->m_free_q = mz;
282
283                 /* Request RING */
284                 snprintf(obj_name, OBJNAMSIZ, "kni_req_%d", i);
285                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
286                                                         SOCKET_ID_ANY, 0);
287                 KNI_MEM_CHECK(mz == NULL);
288                 it->m_req_q = mz;
289
290                 /* Response RING */
291                 snprintf(obj_name, OBJNAMSIZ, "kni_resp_%d", i);
292                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
293                                                         SOCKET_ID_ANY, 0);
294                 KNI_MEM_CHECK(mz == NULL);
295                 it->m_resp_q = mz;
296
297                 /* Req/Resp sync mem area */
298                 snprintf(obj_name, OBJNAMSIZ, "kni_sync_%d", i);
299                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
300                                                         SOCKET_ID_ANY, 0);
301                 KNI_MEM_CHECK(mz == NULL);
302                 it->m_sync_addr = mz;
303
304                 if ((i+1) == max_kni_ifaces) {
305                         it->next = NULL;
306                         kni_memzone_pool.free_tail = it;
307                 } else
308                         it->next = &kni_memzone_pool.slots[i+1];
309         }
310
311         return;
312
313 kni_fail:
314         RTE_LOG(ERR, KNI, "Unable to allocate memory for max_kni_ifaces:%d."
315                 "Increase the amount of hugepages memory\n", max_kni_ifaces);
316 }
317
318
319 struct rte_kni *
320 rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
321               const struct rte_kni_conf *conf,
322               struct rte_kni_ops *ops)
323 {
324         int ret;
325         struct rte_kni_device_info dev_info;
326         struct rte_kni *ctx;
327         char intf_name[RTE_KNI_NAMESIZE];
328         const struct rte_memzone *mz;
329         struct rte_kni_memzone_slot *slot = NULL;
330
331         if (!pktmbuf_pool || !conf || !conf->name[0])
332                 return NULL;
333
334         /* Check if KNI subsystem has been initialized */
335         if (kni_memzone_pool.initialized != 1) {
336                 RTE_LOG(ERR, KNI, "KNI subsystem has not been initialized. Invoke rte_kni_init() first\n");
337                 return NULL;
338         }
339
340         /* Get an available slot from the pool */
341         slot = kni_memzone_pool_alloc();
342         if (!slot) {
343                 RTE_LOG(ERR, KNI, "Cannot allocate more KNI interfaces; increase the number of max_kni_ifaces(current %d) or release unusued ones.\n",
344                         kni_memzone_pool.max_ifaces);
345                 return NULL;
346         }
347
348         /* Recover ctx */
349         ctx = slot->m_ctx->addr;
350         snprintf(intf_name, RTE_KNI_NAMESIZE, "%s", conf->name);
351
352         if (ctx->in_use) {
353                 RTE_LOG(ERR, KNI, "KNI %s is in use\n", ctx->name);
354                 return NULL;
355         }
356         memset(ctx, 0, sizeof(struct rte_kni));
357         if (ops)
358                 memcpy(&ctx->ops, ops, sizeof(struct rte_kni_ops));
359
360         memset(&dev_info, 0, sizeof(dev_info));
361         dev_info.bus = conf->addr.bus;
362         dev_info.devid = conf->addr.devid;
363         dev_info.function = conf->addr.function;
364         dev_info.vendor_id = conf->id.vendor_id;
365         dev_info.device_id = conf->id.device_id;
366         dev_info.core_id = conf->core_id;
367         dev_info.force_bind = conf->force_bind;
368         dev_info.group_id = conf->group_id;
369         dev_info.mbuf_size = conf->mbuf_size;
370
371         snprintf(ctx->name, RTE_KNI_NAMESIZE, "%s", intf_name);
372         snprintf(dev_info.name, RTE_KNI_NAMESIZE, "%s", intf_name);
373
374         RTE_LOG(INFO, KNI, "pci: %02x:%02x:%02x \t %02x:%02x\n",
375                 dev_info.bus, dev_info.devid, dev_info.function,
376                         dev_info.vendor_id, dev_info.device_id);
377         /* TX RING */
378         mz = slot->m_tx_q;
379         ctx->tx_q = mz->addr;
380         kni_fifo_init(ctx->tx_q, KNI_FIFO_COUNT_MAX);
381         dev_info.tx_phys = mz->phys_addr;
382
383         /* RX RING */
384         mz = slot->m_rx_q;
385         ctx->rx_q = mz->addr;
386         kni_fifo_init(ctx->rx_q, KNI_FIFO_COUNT_MAX);
387         dev_info.rx_phys = mz->phys_addr;
388
389         /* ALLOC RING */
390         mz = slot->m_alloc_q;
391         ctx->alloc_q = mz->addr;
392         kni_fifo_init(ctx->alloc_q, KNI_FIFO_COUNT_MAX);
393         dev_info.alloc_phys = mz->phys_addr;
394
395         /* FREE RING */
396         mz = slot->m_free_q;
397         ctx->free_q = mz->addr;
398         kni_fifo_init(ctx->free_q, KNI_FIFO_COUNT_MAX);
399         dev_info.free_phys = mz->phys_addr;
400
401         /* Request RING */
402         mz = slot->m_req_q;
403         ctx->req_q = mz->addr;
404         kni_fifo_init(ctx->req_q, KNI_FIFO_COUNT_MAX);
405         dev_info.req_phys = mz->phys_addr;
406
407         /* Response RING */
408         mz = slot->m_resp_q;
409         ctx->resp_q = mz->addr;
410         kni_fifo_init(ctx->resp_q, KNI_FIFO_COUNT_MAX);
411         dev_info.resp_phys = mz->phys_addr;
412
413         /* Req/Resp sync mem area */
414         mz = slot->m_sync_addr;
415         ctx->sync_addr = mz->addr;
416         dev_info.sync_va = mz->addr;
417         dev_info.sync_phys = mz->phys_addr;
418
419         ctx->pktmbuf_pool = pktmbuf_pool;
420         ctx->group_id = conf->group_id;
421         ctx->slot_id = slot->id;
422         ctx->mbuf_size = conf->mbuf_size;
423
424         ret = ioctl(kni_fd, RTE_KNI_IOCTL_CREATE, &dev_info);
425         KNI_MEM_CHECK(ret < 0);
426
427         ctx->in_use = 1;
428
429         /* Allocate mbufs and then put them into alloc_q */
430         kni_allocate_mbufs(ctx);
431
432         return ctx;
433
434 kni_fail:
435         if (slot)
436                 kni_memzone_pool_release(&kni_memzone_pool.slots[slot->id]);
437
438         return NULL;
439 }
440
441 static void
442 kni_free_fifo(struct rte_kni_fifo *fifo)
443 {
444         int ret;
445         struct rte_mbuf *pkt;
446
447         do {
448                 ret = kni_fifo_get(fifo, (void **)&pkt, 1);
449                 if (ret)
450                         rte_pktmbuf_free(pkt);
451         } while (ret);
452 }
453
454 static void *
455 va2pa(struct rte_mbuf *m)
456 {
457         return (void *)((unsigned long)m -
458                         ((unsigned long)m->buf_addr -
459                          (unsigned long)m->buf_iova));
460 }
461
462 static void
463 obj_free(struct rte_mempool *mp __rte_unused, void *opaque, void *obj,
464                 unsigned obj_idx __rte_unused)
465 {
466         struct rte_mbuf *m = obj;
467         void *mbuf_phys = opaque;
468
469         if (va2pa(m) == mbuf_phys)
470                 rte_pktmbuf_free(m);
471 }
472
473 static void
474 kni_free_fifo_phy(struct rte_mempool *mp, struct rte_kni_fifo *fifo)
475 {
476         void *mbuf_phys;
477         int ret;
478
479         do {
480                 ret = kni_fifo_get(fifo, &mbuf_phys, 1);
481                 if (ret)
482                         rte_mempool_obj_iter(mp, obj_free, mbuf_phys);
483         } while (ret);
484 }
485
486 int
487 rte_kni_release(struct rte_kni *kni)
488 {
489         struct rte_kni_device_info dev_info;
490         uint32_t slot_id;
491         uint32_t retry = 5;
492
493         if (!kni || !kni->in_use)
494                 return -1;
495
496         snprintf(dev_info.name, sizeof(dev_info.name), "%s", kni->name);
497         if (ioctl(kni_fd, RTE_KNI_IOCTL_RELEASE, &dev_info) < 0) {
498                 RTE_LOG(ERR, KNI, "Fail to release kni device\n");
499                 return -1;
500         }
501
502         /* mbufs in all fifo should be released, except request/response */
503
504         /* wait until all rxq packets processed by kernel */
505         while (kni_fifo_count(kni->rx_q) && retry--)
506                 usleep(1000);
507
508         if (kni_fifo_count(kni->rx_q))
509                 RTE_LOG(ERR, KNI, "Fail to free all Rx-q items\n");
510
511         kni_free_fifo_phy(kni->pktmbuf_pool, kni->alloc_q);
512         kni_free_fifo(kni->tx_q);
513         kni_free_fifo(kni->free_q);
514
515         slot_id = kni->slot_id;
516
517         /* Memset the KNI struct */
518         memset(kni, 0, sizeof(struct rte_kni));
519
520         /* Release memzone */
521         if (slot_id > kni_memzone_pool.max_ifaces) {
522                 RTE_LOG(ERR, KNI, "KNI pool: corrupted slot ID: %d, max: %d\n",
523                         slot_id, kni_memzone_pool.max_ifaces);
524                 return -1;
525         }
526         kni_memzone_pool_release(&kni_memzone_pool.slots[slot_id]);
527
528         return 0;
529 }
530
531 int
532 rte_kni_handle_request(struct rte_kni *kni)
533 {
534         unsigned ret;
535         struct rte_kni_request *req;
536
537         if (kni == NULL)
538                 return -1;
539
540         /* Get request mbuf */
541         ret = kni_fifo_get(kni->req_q, (void **)&req, 1);
542         if (ret != 1)
543                 return 0; /* It is OK of can not getting the request mbuf */
544
545         if (req != kni->sync_addr) {
546                 RTE_LOG(ERR, KNI, "Wrong req pointer %p\n", req);
547                 return -1;
548         }
549
550         /* Analyze the request and call the relevant actions for it */
551         switch (req->req_id) {
552         case RTE_KNI_REQ_CHANGE_MTU: /* Change MTU */
553                 if (kni->ops.change_mtu)
554                         req->result = kni->ops.change_mtu(kni->ops.port_id,
555                                                         req->new_mtu);
556                 break;
557         case RTE_KNI_REQ_CFG_NETWORK_IF: /* Set network interface up/down */
558                 if (kni->ops.config_network_if)
559                         req->result = kni->ops.config_network_if(\
560                                         kni->ops.port_id, req->if_up);
561                 break;
562         default:
563                 RTE_LOG(ERR, KNI, "Unknown request id %u\n", req->req_id);
564                 req->result = -EINVAL;
565                 break;
566         }
567
568         /* Construct response mbuf and put it back to resp_q */
569         ret = kni_fifo_put(kni->resp_q, (void **)&req, 1);
570         if (ret != 1) {
571                 RTE_LOG(ERR, KNI, "Fail to put the muf back to resp_q\n");
572                 return -1; /* It is an error of can't putting the mbuf back */
573         }
574
575         return 0;
576 }
577
578 unsigned
579 rte_kni_tx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, unsigned num)
580 {
581         void *phy_mbufs[num];
582         unsigned int ret;
583         unsigned int i;
584
585         for (i = 0; i < num; i++)
586                 phy_mbufs[i] = va2pa(mbufs[i]);
587
588         ret = kni_fifo_put(kni->rx_q, phy_mbufs, num);
589
590         /* Get mbufs from free_q and then free them */
591         kni_free_mbufs(kni);
592
593         return ret;
594 }
595
596 unsigned
597 rte_kni_rx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, unsigned num)
598 {
599         unsigned ret = kni_fifo_get(kni->tx_q, (void **)mbufs, num);
600
601         /* If buffers removed, allocate mbufs and then put them into alloc_q */
602         if (ret)
603                 kni_allocate_mbufs(kni);
604
605         return ret;
606 }
607
608 static void
609 kni_free_mbufs(struct rte_kni *kni)
610 {
611         int i, ret;
612         struct rte_mbuf *pkts[MAX_MBUF_BURST_NUM];
613
614         ret = kni_fifo_get(kni->free_q, (void **)pkts, MAX_MBUF_BURST_NUM);
615         if (likely(ret > 0)) {
616                 for (i = 0; i < ret; i++)
617                         rte_pktmbuf_free(pkts[i]);
618         }
619 }
620
621 static void
622 kni_allocate_mbufs(struct rte_kni *kni)
623 {
624         int i, ret;
625         struct rte_mbuf *pkts[MAX_MBUF_BURST_NUM];
626         void *phys[MAX_MBUF_BURST_NUM];
627         int allocq_free;
628
629         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, pool) !=
630                          offsetof(struct rte_kni_mbuf, pool));
631         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, buf_addr) !=
632                          offsetof(struct rte_kni_mbuf, buf_addr));
633         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, next) !=
634                          offsetof(struct rte_kni_mbuf, next));
635         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, data_off) !=
636                          offsetof(struct rte_kni_mbuf, data_off));
637         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, data_len) !=
638                          offsetof(struct rte_kni_mbuf, data_len));
639         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, pkt_len) !=
640                          offsetof(struct rte_kni_mbuf, pkt_len));
641         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, ol_flags) !=
642                          offsetof(struct rte_kni_mbuf, ol_flags));
643
644         /* Check if pktmbuf pool has been configured */
645         if (kni->pktmbuf_pool == NULL) {
646                 RTE_LOG(ERR, KNI, "No valid mempool for allocating mbufs\n");
647                 return;
648         }
649
650         allocq_free = (kni->alloc_q->read - kni->alloc_q->write - 1) \
651                         & (MAX_MBUF_BURST_NUM - 1);
652         for (i = 0; i < allocq_free; i++) {
653                 pkts[i] = rte_pktmbuf_alloc(kni->pktmbuf_pool);
654                 if (unlikely(pkts[i] == NULL)) {
655                         /* Out of memory */
656                         RTE_LOG(ERR, KNI, "Out of memory\n");
657                         break;
658                 }
659                 phys[i] = va2pa(pkts[i]);
660         }
661
662         /* No pkt mbuf alocated */
663         if (i <= 0)
664                 return;
665
666         ret = kni_fifo_put(kni->alloc_q, phys, i);
667
668         /* Check if any mbufs not put into alloc_q, and then free them */
669         if (ret >= 0 && ret < i && ret < MAX_MBUF_BURST_NUM) {
670                 int j;
671
672                 for (j = ret; j < i; j++)
673                         rte_pktmbuf_free(pkts[j]);
674         }
675 }
676
677 struct rte_kni *
678 rte_kni_get(const char *name)
679 {
680         uint32_t i;
681         struct rte_kni_memzone_slot *it;
682         struct rte_kni *kni;
683
684         /* Note: could be improved perf-wise if necessary */
685         for (i = 0; i < kni_memzone_pool.max_ifaces; i++) {
686                 it = &kni_memzone_pool.slots[i];
687                 if (it->in_use == 0)
688                         continue;
689                 kni = it->m_ctx->addr;
690                 if (strncmp(kni->name, name, RTE_KNI_NAMESIZE) == 0)
691                         return kni;
692         }
693
694         return NULL;
695 }
696
697 const char *
698 rte_kni_get_name(const struct rte_kni *kni)
699 {
700         return kni->name;
701 }
702
703 static enum kni_ops_status
704 kni_check_request_register(struct rte_kni_ops *ops)
705 {
706         /* check if KNI request ops has been registered*/
707         if( NULL == ops )
708                 return KNI_REQ_NO_REGISTER;
709
710         if((NULL == ops->change_mtu) && (NULL == ops->config_network_if))
711                 return KNI_REQ_NO_REGISTER;
712
713         return KNI_REQ_REGISTERED;
714 }
715
716 int
717 rte_kni_register_handlers(struct rte_kni *kni,struct rte_kni_ops *ops)
718 {
719         enum kni_ops_status req_status;
720
721         if (NULL == ops) {
722                 RTE_LOG(ERR, KNI, "Invalid KNI request operation.\n");
723                 return -1;
724         }
725
726         if (NULL == kni) {
727                 RTE_LOG(ERR, KNI, "Invalid kni info.\n");
728                 return -1;
729         }
730
731         req_status = kni_check_request_register(&kni->ops);
732         if ( KNI_REQ_REGISTERED == req_status) {
733                 RTE_LOG(ERR, KNI, "The KNI request operation has already registered.\n");
734                 return -1;
735         }
736
737         memcpy(&kni->ops, ops, sizeof(struct rte_kni_ops));
738         return 0;
739 }
740
741 int
742 rte_kni_unregister_handlers(struct rte_kni *kni)
743 {
744         if (NULL == kni) {
745                 RTE_LOG(ERR, KNI, "Invalid kni info.\n");
746                 return -1;
747         }
748
749         kni->ops.change_mtu = NULL;
750         kni->ops.config_network_if = NULL;
751         return 0;
752 }
753 void
754 rte_kni_close(void)
755 {
756         if (kni_fd < 0)
757                 return;
758
759         close(kni_fd);
760         kni_fd = -1;
761 }