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/relase 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_panic("Unable to initialize KNI\n");
 214         }
 215
 216         /* Check FD and open */
 217         if (kni_fd < 0) {
 218                 kni_fd = open("/dev/" KNI_DEVICE, O_RDWR);
 219                 if (kni_fd < 0)
 220                         rte_panic("Can not open /dev/%s\n", KNI_DEVICE);
 221         }
 222
 223         /* Allocate slot objects */
 224         kni_memzone_pool.slots = (struct rte_kni_memzone_slot *)
 225                                         rte_malloc(NULL,
 226                                         sizeof(struct rte_kni_memzone_slot) *
 227                                         max_kni_ifaces,
 228                                         0);
 229         KNI_MEM_CHECK(kni_memzone_pool.slots == NULL);
 230
 231         /* Initialize general pool variables */
 232         kni_memzone_pool.initialized = 1;
 233         kni_memzone_pool.max_ifaces = max_kni_ifaces;
 234         kni_memzone_pool.free = &kni_memzone_pool.slots[0];
 235         rte_spinlock_init(&kni_memzone_pool.mutex);
 236
 237         /* Pre-allocate all memzones of all the slots; panic on error */
 238         for (i = 0; i < max_kni_ifaces; i++) {
 239
 240                 /* Recover current slot */
 241                 it = &kni_memzone_pool.slots[i];
 242                 it->id = i;
 243
 244                 /* Allocate KNI context */
 245                 snprintf(mz_name, RTE_MEMZONE_NAMESIZE, "KNI_INFO_%d", i);
 246                 mz = kni_memzone_reserve(mz_name, sizeof(struct rte_kni),
 247                                         SOCKET_ID_ANY, 0);
 248                 KNI_MEM_CHECK(mz == NULL);
 249                 it->m_ctx = mz;
 250
 251                 /* TX RING */
 252                 snprintf(obj_name, OBJNAMSIZ, "kni_tx_%d", i);
 253                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
 254                                                         SOCKET_ID_ANY, 0);
 255                 KNI_MEM_CHECK(mz == NULL);
 256                 it->m_tx_q = mz;
 257
 258                 /* RX RING */
 259                 snprintf(obj_name, OBJNAMSIZ, "kni_rx_%d", i);
 260                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
 261                                                         SOCKET_ID_ANY, 0);
 262                 KNI_MEM_CHECK(mz == NULL);
 263                 it->m_rx_q = mz;
 264
 265                 /* ALLOC RING */
 266                 snprintf(obj_name, OBJNAMSIZ, "kni_alloc_%d", i);
 267                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
 268                                                         SOCKET_ID_ANY, 0);
 269                 KNI_MEM_CHECK(mz == NULL);
 270                 it->m_alloc_q = mz;
 271
 272                 /* FREE RING */
 273                 snprintf(obj_name, OBJNAMSIZ, "kni_free_%d", i);
 274                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
 275                                                         SOCKET_ID_ANY, 0);
 276                 KNI_MEM_CHECK(mz == NULL);
 277                 it->m_free_q = mz;
 278
 279                 /* Request RING */
 280                 snprintf(obj_name, OBJNAMSIZ, "kni_req_%d", i);
 281                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
 282                                                         SOCKET_ID_ANY, 0);
 283                 KNI_MEM_CHECK(mz == NULL);
 284                 it->m_req_q = mz;
 285
 286                 /* Response RING */
 287                 snprintf(obj_name, OBJNAMSIZ, "kni_resp_%d", i);
 288                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
 289                                                         SOCKET_ID_ANY, 0);
 290                 KNI_MEM_CHECK(mz == NULL);
 291                 it->m_resp_q = mz;
 292
 293                 /* Req/Resp sync mem area */
 294                 snprintf(obj_name, OBJNAMSIZ, "kni_sync_%d", i);
 295                 mz = kni_memzone_reserve(obj_name, KNI_FIFO_SIZE,
 296                                                         SOCKET_ID_ANY, 0);
 297                 KNI_MEM_CHECK(mz == NULL);
 298                 it->m_sync_addr = mz;
 299
 300                 if ((i+1) == max_kni_ifaces) {
 301                         it->next = NULL;
 302                         kni_memzone_pool.free_tail = it;
 303                 } else
 304                         it->next = &kni_memzone_pool.slots[i+1];
 305         }
 306
 307         return;
 308
 309 kni_fail:
 310         rte_panic("Unable to allocate memory for max_kni_ifaces:%d. Increase the amount of hugepages memory\n",
 311                          max_kni_ifaces);
 312 }
 313
 314 /* It is deprecated and just for backward compatibility */
 315 struct rte_kni *
 316 rte_kni_create(uint8_t port_id,
 317                unsigned mbuf_size,
 318                struct rte_mempool *pktmbuf_pool,
 319                struct rte_kni_ops *ops)
 320 {
 321         struct rte_kni_conf conf;
 322         struct rte_eth_dev_info info;
 323
 324         memset(&info, 0, sizeof(info));
 325         memset(&conf, 0, sizeof(conf));
 326         rte_eth_dev_info_get(port_id, &info);
 327
 328         snprintf(conf.name, sizeof(conf.name), "vEth%u", port_id);
 329         conf.addr = info.pci_dev->addr;
 330         conf.id = info.pci_dev->id;
 331         conf.group_id = (uint16_t)port_id;
 332         conf.mbuf_size = mbuf_size;
 333
 334         /* Save the port id for request handling */
 335         ops->port_id = port_id;
 336
 337         return rte_kni_alloc(pktmbuf_pool, &conf, ops);
 338 }
 339
 340 struct rte_kni *
 341 rte_kni_alloc(struct rte_mempool *pktmbuf_pool,
 342               const struct rte_kni_conf *conf,
 343               struct rte_kni_ops *ops)
 344 {
 345         int ret;
 346         struct rte_kni_device_info dev_info;
 347         struct rte_kni *ctx;
 348         char intf_name[RTE_KNI_NAMESIZE];
 349         char mz_name[RTE_MEMZONE_NAMESIZE];
 350         const struct rte_memzone *mz;
 351         struct rte_kni_memzone_slot *slot = NULL;
 352
 353         if (!pktmbuf_pool || !conf || !conf->name[0])
 354                 return NULL;
 355
 356         /* Check if KNI subsystem has been initialized */
 357         if (kni_memzone_pool.initialized != 1) {
 358                 RTE_LOG(ERR, KNI, "KNI subsystem has not been initialized. Invoke rte_kni_init() first\n");
 359                 return NULL;
 360         }
 361
 362         /* Get an available slot from the pool */
 363         slot = kni_memzone_pool_alloc();
 364         if (!slot) {
 365                 RTE_LOG(ERR, KNI, "Cannot allocate more KNI interfaces; increase the number of max_kni_ifaces(current %d) or release unusued ones.\n",
 366                         kni_memzone_pool.max_ifaces);
 367                 return NULL;
 368         }
 369
 370         /* Recover ctx */
 371         ctx = slot->m_ctx->addr;
 372         snprintf(intf_name, RTE_KNI_NAMESIZE, "%s", conf->name);
 373
 374         if (ctx->in_use) {
 375                 RTE_LOG(ERR, KNI, "KNI %s is in use\n", ctx->name);
 376                 return NULL;
 377         }
 378         memset(ctx, 0, sizeof(struct rte_kni));
 379         if (ops)
 380                 memcpy(&ctx->ops, ops, sizeof(struct rte_kni_ops));
 381
 382         memset(&dev_info, 0, sizeof(dev_info));
 383         dev_info.bus = conf->addr.bus;
 384         dev_info.devid = conf->addr.devid;
 385         dev_info.function = conf->addr.function;
 386         dev_info.vendor_id = conf->id.vendor_id;
 387         dev_info.device_id = conf->id.device_id;
 388         dev_info.core_id = conf->core_id;
 389         dev_info.force_bind = conf->force_bind;
 390         dev_info.group_id = conf->group_id;
 391         dev_info.mbuf_size = conf->mbuf_size;
 392
 393         snprintf(ctx->name, RTE_KNI_NAMESIZE, "%s", intf_name);
 394         snprintf(dev_info.name, RTE_KNI_NAMESIZE, "%s", intf_name);
 395
 396         RTE_LOG(INFO, KNI, "pci: %02x:%02x:%02x \t %02x:%02x\n",
 397                 dev_info.bus, dev_info.devid, dev_info.function,
 398                         dev_info.vendor_id, dev_info.device_id);
 399         /* TX RING */
 400         mz = slot->m_tx_q;
 401         ctx->tx_q = mz->addr;
 402         kni_fifo_init(ctx->tx_q, KNI_FIFO_COUNT_MAX);
 403         dev_info.tx_phys = mz->phys_addr;
 404
 405         /* RX RING */
 406         mz = slot->m_rx_q;
 407         ctx->rx_q = mz->addr;
 408         kni_fifo_init(ctx->rx_q, KNI_FIFO_COUNT_MAX);
 409         dev_info.rx_phys = mz->phys_addr;
 410
 411         /* ALLOC RING */
 412         mz = slot->m_alloc_q;
 413         ctx->alloc_q = mz->addr;
 414         kni_fifo_init(ctx->alloc_q, KNI_FIFO_COUNT_MAX);
 415         dev_info.alloc_phys = mz->phys_addr;
 416
 417         /* FREE RING */
 418         mz = slot->m_free_q;
 419         ctx->free_q = mz->addr;
 420         kni_fifo_init(ctx->free_q, KNI_FIFO_COUNT_MAX);
 421         dev_info.free_phys = mz->phys_addr;
 422
 423         /* Request RING */
 424         mz = slot->m_req_q;
 425         ctx->req_q = mz->addr;
 426         kni_fifo_init(ctx->req_q, KNI_FIFO_COUNT_MAX);
 427         dev_info.req_phys = mz->phys_addr;
 428
 429         /* Response RING */
 430         mz = slot->m_resp_q;
 431         ctx->resp_q = mz->addr;
 432         kni_fifo_init(ctx->resp_q, KNI_FIFO_COUNT_MAX);
 433         dev_info.resp_phys = mz->phys_addr;
 434
 435         /* Req/Resp sync mem area */
 436         mz = slot->m_sync_addr;
 437         ctx->sync_addr = mz->addr;
 438         dev_info.sync_va = mz->addr;
 439         dev_info.sync_phys = mz->phys_addr;
 440
 441
 442         /* MBUF mempool */
 443         snprintf(mz_name, sizeof(mz_name), RTE_MEMPOOL_OBJ_NAME,
 444                 pktmbuf_pool->name);
 445         mz = rte_memzone_lookup(mz_name);
 446         KNI_MEM_CHECK(mz == NULL);
 447         dev_info.mbuf_va = mz->addr;
 448         dev_info.mbuf_phys = mz->phys_addr;
 449         ctx->pktmbuf_pool = pktmbuf_pool;
 450         ctx->group_id = conf->group_id;
 451         ctx->slot_id = slot->id;
 452         ctx->mbuf_size = conf->mbuf_size;
 453
 454         ret = ioctl(kni_fd, RTE_KNI_IOCTL_CREATE, &dev_info);
 455         KNI_MEM_CHECK(ret < 0);
 456
 457         ctx->in_use = 1;
 458
 459         /* Allocate mbufs and then put them into alloc_q */
 460         kni_allocate_mbufs(ctx);
 461
 462         return ctx;
 463
 464 kni_fail:
 465         if (slot)
 466                 kni_memzone_pool_release(&kni_memzone_pool.slots[slot->id]);
 467
 468         return NULL;
 469 }
 470
 471 static void
 472 kni_free_fifo(struct rte_kni_fifo *fifo)
 473 {
 474         int ret;
 475         struct rte_mbuf *pkt;
 476
 477         do {
 478                 ret = kni_fifo_get(fifo, (void **)&pkt, 1);
 479                 if (ret)
 480                         rte_pktmbuf_free(pkt);
 481         } while (ret);
 482 }
 483
 484 int
 485 rte_kni_release(struct rte_kni *kni)
 486 {
 487         struct rte_kni_device_info dev_info;
 488         uint32_t slot_id;
 489
 490         if (!kni || !kni->in_use)
 491                 return -1;
 492
 493         snprintf(dev_info.name, sizeof(dev_info.name), "%s", kni->name);
 494         if (ioctl(kni_fd, RTE_KNI_IOCTL_RELEASE, &dev_info) < 0) {
 495                 RTE_LOG(ERR, KNI, "Fail to release kni device\n");
 496                 return -1;
 497         }
 498
 499         /* mbufs in all fifo should be released, except request/response */
 500         kni_free_fifo(kni->tx_q);
 501         kni_free_fifo(kni->rx_q);
 502         kni_free_fifo(kni->alloc_q);
 503         kni_free_fifo(kni->free_q);
 504
 505         slot_id = kni->slot_id;
 506
 507         /* Memset the KNI struct */
 508         memset(kni, 0, sizeof(struct rte_kni));
 509
 510         /* Release memzone */
 511         if (slot_id > kni_memzone_pool.max_ifaces) {
 512                 rte_panic("KNI pool: corrupted slot ID: %d, max: %d\n",
 513                         slot_id, kni_memzone_pool.max_ifaces);
 514         }
 515         kni_memzone_pool_release(&kni_memzone_pool.slots[slot_id]);
 516
 517         return 0;
 518 }
 519
 520 int
 521 rte_kni_handle_request(struct rte_kni *kni)
 522 {
 523         unsigned ret;
 524         struct rte_kni_request *req;
 525
 526         if (kni == NULL)
 527                 return -1;
 528
 529         /* Get request mbuf */
 530         ret = kni_fifo_get(kni->req_q, (void **)&req, 1);
 531         if (ret != 1)
 532                 return 0; /* It is OK of can not getting the request mbuf */
 533
 534         if (req != kni->sync_addr) {
 535                 rte_panic("Wrong req pointer %p\n", req);
 536         }
 537
 538         /* Analyze the request and call the relevant actions for it */
 539         switch (req->req_id) {
 540         case RTE_KNI_REQ_CHANGE_MTU: /* Change MTU */
 541                 if (kni->ops.change_mtu)
 542                         req->result = kni->ops.change_mtu(kni->ops.port_id,
 543                                                         req->new_mtu);
 544                 break;
 545         case RTE_KNI_REQ_CFG_NETWORK_IF: /* Set network interface up/down */
 546                 if (kni->ops.config_network_if)
 547                         req->result = kni->ops.config_network_if(\
 548                                         kni->ops.port_id, req->if_up);
 549                 break;
 550         default:
 551                 RTE_LOG(ERR, KNI, "Unknown request id %u\n", req->req_id);
 552                 req->result = -EINVAL;
 553                 break;
 554         }
 555
 556         /* Construct response mbuf and put it back to resp_q */
 557         ret = kni_fifo_put(kni->resp_q, (void **)&req, 1);
 558         if (ret != 1) {
 559                 RTE_LOG(ERR, KNI, "Fail to put the muf back to resp_q\n");
 560                 return -1; /* It is an error of can't putting the mbuf back */
 561         }
 562
 563         return 0;
 564 }
 565
 566 unsigned
 567 rte_kni_tx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, unsigned num)
 568 {
 569         unsigned ret = kni_fifo_put(kni->rx_q, (void **)mbufs, num);
 570
 571         /* Get mbufs from free_q and then free them */
 572         kni_free_mbufs(kni);
 573
 574         return ret;
 575 }
 576
 577 unsigned
 578 rte_kni_rx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, unsigned num)
 579 {
 580         unsigned ret = kni_fifo_get(kni->tx_q, (void **)mbufs, num);
 581
 582         /* If buffers removed, allocate mbufs and then put them into alloc_q */
 583         if (ret)
 584                 kni_allocate_mbufs(kni);
 585
 586         return ret;
 587 }
 588
 589 static void
 590 kni_free_mbufs(struct rte_kni *kni)
 591 {
 592         int i, ret;
 593         struct rte_mbuf *pkts[MAX_MBUF_BURST_NUM];
 594
 595         ret = kni_fifo_get(kni->free_q, (void **)pkts, MAX_MBUF_BURST_NUM);
 596         if (likely(ret > 0)) {
 597                 for (i = 0; i < ret; i++)
 598                         rte_pktmbuf_free(pkts[i]);
 599         }
 600 }
 601
 602 static void
 603 kni_allocate_mbufs(struct rte_kni *kni)
 604 {
 605         int i, ret;
 606         struct rte_mbuf *pkts[MAX_MBUF_BURST_NUM];
 607
 608         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, pool) !=
 609                          offsetof(struct rte_kni_mbuf, pool));
 610         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, buf_addr) !=
 611                          offsetof(struct rte_kni_mbuf, buf_addr));
 612         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, next) !=
 613                          offsetof(struct rte_kni_mbuf, next));
 614         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, data_off) !=
 615                          offsetof(struct rte_kni_mbuf, data_off));
 616         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, data_len) !=
 617                          offsetof(struct rte_kni_mbuf, data_len));
 618         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, pkt_len) !=
 619                          offsetof(struct rte_kni_mbuf, pkt_len));
 620         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, ol_flags) !=
 621                          offsetof(struct rte_kni_mbuf, ol_flags));
 622
 623         /* Check if pktmbuf pool has been configured */
 624         if (kni->pktmbuf_pool == NULL) {
 625                 RTE_LOG(ERR, KNI, "No valid mempool for allocating mbufs\n");
 626                 return;
 627         }
 628
 629         for (i = 0; i < MAX_MBUF_BURST_NUM; i++) {
 630                 pkts[i] = rte_pktmbuf_alloc(kni->pktmbuf_pool);
 631                 if (unlikely(pkts[i] == NULL)) {
 632                         /* Out of memory */
 633                         RTE_LOG(ERR, KNI, "Out of memory\n");
 634                         break;
 635                 }
 636         }
 637
 638         /* No pkt mbuf alocated */
 639         if (i <= 0)
 640                 return;
 641
 642         ret = kni_fifo_put(kni->alloc_q, (void **)pkts, i);
 643
 644         /* Check if any mbufs not put into alloc_q, and then free them */
 645         if (ret >= 0 && ret < i && ret < MAX_MBUF_BURST_NUM) {
 646                 int j;
 647
 648                 for (j = ret; j < i; j++)
 649                         rte_pktmbuf_free(pkts[j]);
 650         }
 651 }
 652
 653 /* It is deprecated and just for backward compatibility */
 654 uint8_t
 655 rte_kni_get_port_id(struct rte_kni *kni)
 656 {
 657         if (!kni)
 658                 return ~0x0;
 659
 660         return kni->ops.port_id;
 661 }
 662
 663 struct rte_kni *
 664 rte_kni_get(const char *name)
 665 {
 666         uint32_t i;
 667         struct rte_kni_memzone_slot *it;
 668         struct rte_kni *kni;
 669
 670         /* Note: could be improved perf-wise if necessary */
 671         for (i = 0; i < kni_memzone_pool.max_ifaces; i++) {
 672                 it = &kni_memzone_pool.slots[i];
 673                 if (it->in_use == 0)
 674                         continue;
 675                 kni = it->m_ctx->addr;
 676                 if (strncmp(kni->name, name, RTE_KNI_NAMESIZE) == 0)
 677                         return kni;
 678         }
 679
 680         return NULL;
 681 }
 682
 683 const char *
 684 rte_kni_get_name(const struct rte_kni *kni)
 685 {
 686         return kni->name;
 687 }
 688
 689 /*
 690  * It is deprecated and just for backward compatibility.
 691  */
 692 struct rte_kni *
 693 rte_kni_info_get(uint8_t port_id)
 694 {
 695         char name[RTE_MEMZONE_NAMESIZE];
 696
 697         if (port_id >= RTE_MAX_ETHPORTS)
 698                 return NULL;
 699
 700         snprintf(name, RTE_MEMZONE_NAMESIZE, "vEth%u", port_id);
 701
 702         return rte_kni_get(name);
 703 }
 704
 705 static enum kni_ops_status
 706 kni_check_request_register(struct rte_kni_ops *ops)
 707 {
 708         /* check if KNI request ops has been registered*/
 709         if( NULL == ops )
 710                 return KNI_REQ_NO_REGISTER;
 711
 712         if((NULL == ops->change_mtu) && (NULL == ops->config_network_if))
 713                 return KNI_REQ_NO_REGISTER;
 714
 715         return KNI_REQ_REGISTERED;
 716 }
 717
 718 int
 719 rte_kni_register_handlers(struct rte_kni *kni,struct rte_kni_ops *ops)
 720 {
 721         enum kni_ops_status req_status;
 722
 723         if (NULL == ops) {
 724                 RTE_LOG(ERR, KNI, "Invalid KNI request operation.\n");
 725                 return -1;
 726         }
 727
 728         if (NULL == kni) {
 729                 RTE_LOG(ERR, KNI, "Invalid kni info.\n");
 730                 return -1;
 731         }
 732
 733         req_status = kni_check_request_register(&kni->ops);
 734         if ( KNI_REQ_REGISTERED == req_status) {
 735                 RTE_LOG(ERR, KNI, "The KNI request operation has already registered.\n");
 736                 return -1;
 737         }
 738
 739         memcpy(&kni->ops, ops, sizeof(struct rte_kni_ops));
 740         return 0;
 741 }
 742
 743 int
 744 rte_kni_unregister_handlers(struct rte_kni *kni)
 745 {
 746         if (NULL == kni) {
 747                 RTE_LOG(ERR, KNI, "Invalid kni info.\n");
 748                 return -1;
 749         }
 750
 751         kni->ops.change_mtu = NULL;
 752         kni->ops.config_network_if = NULL;
 753         return 0;
 754 }
 755 void
 756 rte_kni_close(void)
 757 {
 758         if (kni_fd < 0)
 759                 return;
 760
 761         close(kni_fd);
 762         kni_fd = -1;
 763 }