lib/kni/rte_kni.c

   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
  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 *
 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
 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
 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 *
 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
 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 *
 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 *
 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
 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
 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
 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
 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
 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
 515 kni_config_allmulticast(uint16_t port_id, uint8_t to_on)
 516 {
 517         int ret;
 518
 519         if (!rte_eth_dev_is_valid_port(port_id)) {
 520                 RTE_LOG(ERR, KNI, "Invalid port id %d\n", port_id);
 521                 return -EINVAL;
 522         }
 523
 524         RTE_LOG(INFO, KNI, "Configure allmulticast mode of %d to %d\n",
 525                 port_id, to_on);
 526
 527         if (to_on)
 528                 ret = rte_eth_allmulticast_enable(port_id);
 529         else
 530                 ret = rte_eth_allmulticast_disable(port_id);
 531         if (ret != 0)
 532                 RTE_LOG(ERR, KNI,
 533                         "Failed to %s allmulticast mode for port %u: %s\n",
 534                         to_on ? "enable" : "disable", port_id,
 535                         rte_strerror(-ret));
 536
 537         return ret;
 538 }
 539
 540 int
 541 rte_kni_handle_request(struct rte_kni *kni)
 542 {
 543         unsigned int ret;
 544         struct rte_kni_request *req = NULL;
 545
 546         if (kni == NULL)
 547                 return -1;
 548
 549         /* Get request mbuf */
 550         ret = kni_fifo_get(kni->req_q, (void **)&req, 1);
 551         if (ret != 1)
 552                 return 0; /* It is OK of can not getting the request mbuf */
 553
 554         if (req != kni->sync_addr) {
 555                 RTE_LOG(ERR, KNI, "Wrong req pointer %p\n", req);
 556                 return -1;
 557         }
 558
 559         /* Analyze the request and call the relevant actions for it */
 560         switch (req->req_id) {
 561         case RTE_KNI_REQ_CHANGE_MTU: /* Change MTU */
 562                 if (kni->ops.change_mtu)
 563                         req->result = kni->ops.change_mtu(kni->ops.port_id,
 564                                                         req->new_mtu);
 565                 break;
 566         case RTE_KNI_REQ_CFG_NETWORK_IF: /* Set network interface up/down */
 567                 if (kni->ops.config_network_if)
 568                         req->result = kni->ops.config_network_if(kni->ops.port_id,
 569                                                                  req->if_up);
 570                 break;
 571         case RTE_KNI_REQ_CHANGE_MAC_ADDR: /* Change MAC Address */
 572                 if (kni->ops.config_mac_address)
 573                         req->result = kni->ops.config_mac_address(
 574                                         kni->ops.port_id, req->mac_addr);
 575                 else if (kni->ops.port_id != UINT16_MAX)
 576                         req->result = kni_config_mac_address(
 577                                         kni->ops.port_id, req->mac_addr);
 578                 break;
 579         case RTE_KNI_REQ_CHANGE_PROMISC: /* Change PROMISCUOUS MODE */
 580                 if (kni->ops.config_promiscusity)
 581                         req->result = kni->ops.config_promiscusity(
 582                                         kni->ops.port_id, req->promiscusity);
 583                 else if (kni->ops.port_id != UINT16_MAX)
 584                         req->result = kni_config_promiscusity(
 585                                         kni->ops.port_id, req->promiscusity);
 586                 break;
 587         case RTE_KNI_REQ_CHANGE_ALLMULTI: /* Change ALLMULTICAST MODE */
 588                 if (kni->ops.config_allmulticast)
 589                         req->result = kni->ops.config_allmulticast(
 590                                         kni->ops.port_id, req->allmulti);
 591                 else if (kni->ops.port_id != UINT16_MAX)
 592                         req->result = kni_config_allmulticast(
 593                                         kni->ops.port_id, req->allmulti);
 594                 break;
 595         default:
 596                 RTE_LOG(ERR, KNI, "Unknown request id %u\n", req->req_id);
 597                 req->result = -EINVAL;
 598                 break;
 599         }
 600
 601         /* if needed, construct response buffer and put it back to resp_q */
 602         if (!req->async)
 603                 ret = kni_fifo_put(kni->resp_q, (void **)&req, 1);
 604         else
 605                 ret = 1;
 606         if (ret != 1) {
 607                 RTE_LOG(ERR, KNI, "Fail to put the muf back to resp_q\n");
 608                 return -1; /* It is an error of can't putting the mbuf back */
 609         }
 610
 611         return 0;
 612 }
 613
 614 unsigned
 615 rte_kni_tx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, unsigned int num)
 616 {
 617         num = RTE_MIN(kni_fifo_free_count(kni->rx_q), num);
 618         void *phy_mbufs[num];
 619         unsigned int ret;
 620         unsigned int i;
 621
 622         for (i = 0; i < num; i++)
 623                 phy_mbufs[i] = va2pa_all(mbufs[i]);
 624
 625         ret = kni_fifo_put(kni->rx_q, phy_mbufs, num);
 626
 627         /* Get mbufs from free_q and then free them */
 628         kni_free_mbufs(kni);
 629
 630         return ret;
 631 }
 632
 633 unsigned
 634 rte_kni_rx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, unsigned int num)
 635 {
 636         unsigned int ret = kni_fifo_get(kni->tx_q, (void **)mbufs, num);
 637
 638         /* If buffers removed, allocate mbufs and then put them into alloc_q */
 639         if (ret)
 640                 kni_allocate_mbufs(kni);
 641
 642         return ret;
 643 }
 644
 645 static void
 646 kni_free_mbufs(struct rte_kni *kni)
 647 {
 648         int i, ret;
 649         struct rte_mbuf *pkts[MAX_MBUF_BURST_NUM];
 650
 651         ret = kni_fifo_get(kni->free_q, (void **)pkts, MAX_MBUF_BURST_NUM);
 652         if (likely(ret > 0)) {
 653                 for (i = 0; i < ret; i++)
 654                         rte_pktmbuf_free(pkts[i]);
 655         }
 656 }
 657
 658 static void
 659 kni_allocate_mbufs(struct rte_kni *kni)
 660 {
 661         int i, ret;
 662         struct rte_mbuf *pkts[MAX_MBUF_BURST_NUM];
 663         void *phys[MAX_MBUF_BURST_NUM];
 664         int allocq_free;
 665
 666         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, pool) !=
 667                          offsetof(struct rte_kni_mbuf, pool));
 668         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, buf_addr) !=
 669                          offsetof(struct rte_kni_mbuf, buf_addr));
 670         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, next) !=
 671                          offsetof(struct rte_kni_mbuf, next));
 672         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, data_off) !=
 673                          offsetof(struct rte_kni_mbuf, data_off));
 674         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, data_len) !=
 675                          offsetof(struct rte_kni_mbuf, data_len));
 676         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, pkt_len) !=
 677                          offsetof(struct rte_kni_mbuf, pkt_len));
 678         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, ol_flags) !=
 679                          offsetof(struct rte_kni_mbuf, ol_flags));
 680
 681         /* Check if pktmbuf pool has been configured */
 682         if (kni->pktmbuf_pool == NULL) {
 683                 RTE_LOG(ERR, KNI, "No valid mempool for allocating mbufs\n");
 684                 return;
 685         }
 686
 687         allocq_free = kni_fifo_free_count(kni->alloc_q);
 688         allocq_free = (allocq_free > MAX_MBUF_BURST_NUM) ?
 689                 MAX_MBUF_BURST_NUM : allocq_free;
 690         for (i = 0; i < allocq_free; i++) {
 691                 pkts[i] = rte_pktmbuf_alloc(kni->pktmbuf_pool);
 692                 if (unlikely(pkts[i] == NULL)) {
 693                         /* Out of memory */
 694                         RTE_LOG(ERR, KNI, "Out of memory\n");
 695                         break;
 696                 }
 697                 phys[i] = va2pa(pkts[i]);
 698         }
 699
 700         /* No pkt mbuf allocated */
 701         if (i <= 0)
 702                 return;
 703
 704         ret = kni_fifo_put(kni->alloc_q, phys, i);
 705
 706         /* Check if any mbufs not put into alloc_q, and then free them */
 707         if (ret >= 0 && ret < i && ret < MAX_MBUF_BURST_NUM) {
 708                 int j;
 709
 710                 for (j = ret; j < i; j++)
 711                         rte_pktmbuf_free(pkts[j]);
 712         }
 713 }
 714
 715 struct rte_kni *
 716 rte_kni_get(const char *name)
 717 {
 718         struct rte_kni *kni;
 719
 720         if (name == NULL || name[0] == '\0')
 721                 return NULL;
 722
 723         rte_mcfg_tailq_read_lock();
 724
 725         kni = __rte_kni_get(name);
 726
 727         rte_mcfg_tailq_read_unlock();
 728
 729         return kni;
 730 }
 731
 732 const char *
 733 rte_kni_get_name(const struct rte_kni *kni)
 734 {
 735         return kni->name;
 736 }
 737
 738 static enum kni_ops_status
 739 kni_check_request_register(struct rte_kni_ops *ops)
 740 {
 741         /* check if KNI request ops has been registered*/
 742         if (ops == NULL)
 743                 return KNI_REQ_NO_REGISTER;
 744
 745         if (ops->change_mtu == NULL
 746             && ops->config_network_if == NULL
 747             && ops->config_mac_address == NULL
 748             && ops->config_promiscusity == NULL
 749             && ops->config_allmulticast == NULL)
 750                 return KNI_REQ_NO_REGISTER;
 751
 752         return KNI_REQ_REGISTERED;
 753 }
 754
 755 int
 756 rte_kni_register_handlers(struct rte_kni *kni, struct rte_kni_ops *ops)
 757 {
 758         enum kni_ops_status req_status;
 759
 760         if (ops == NULL) {
 761                 RTE_LOG(ERR, KNI, "Invalid KNI request operation.\n");
 762                 return -1;
 763         }
 764
 765         if (kni == NULL) {
 766                 RTE_LOG(ERR, KNI, "Invalid kni info.\n");
 767                 return -1;
 768         }
 769
 770         req_status = kni_check_request_register(&kni->ops);
 771         if (req_status == KNI_REQ_REGISTERED) {
 772                 RTE_LOG(ERR, KNI, "The KNI request operation has already registered.\n");
 773                 return -1;
 774         }
 775
 776         memcpy(&kni->ops, ops, sizeof(struct rte_kni_ops));
 777         return 0;
 778 }
 779
 780 int
 781 rte_kni_unregister_handlers(struct rte_kni *kni)
 782 {
 783         if (kni == NULL) {
 784                 RTE_LOG(ERR, KNI, "Invalid kni info.\n");
 785                 return -1;
 786         }
 787
 788         memset(&kni->ops, 0, sizeof(struct rte_kni_ops));
 789
 790         return 0;
 791 }
 792
 793 int
 794 rte_kni_update_link(struct rte_kni *kni, unsigned int linkup)
 795 {
 796         char path[64];
 797         char old_carrier[2];
 798         const char *new_carrier;
 799         int old_linkup;
 800         int fd, ret;
 801
 802         if (kni == NULL)
 803                 return -1;
 804
 805         snprintf(path, sizeof(path), "/sys/devices/virtual/net/%s/carrier",
 806                 kni->name);
 807
 808         fd = open(path, O_RDWR);
 809         if (fd == -1) {
 810                 RTE_LOG(ERR, KNI, "Failed to open file: %s.\n", path);
 811                 return -1;
 812         }
 813
 814         ret = read(fd, old_carrier, 2);
 815         if (ret < 1) {
 816                 close(fd);
 817                 return -1;
 818         }
 819         old_linkup = (old_carrier[0] == '1');
 820
 821         if (old_linkup == (int)linkup)
 822                 goto out;
 823
 824         new_carrier = linkup ? "1" : "0";
 825         ret = write(fd, new_carrier, 1);
 826         if (ret < 1) {
 827                 RTE_LOG(ERR, KNI, "Failed to write file: %s.\n", path);
 828                 close(fd);
 829                 return -1;
 830         }
 831 out:
 832         close(fd);
 833         return old_linkup;
 834 }
 835
 836 void
 837 rte_kni_close(void)
 838 {
 839         if (kni_fd < 0)
 840                 return;
 841
 842         close(kni_fd);
 843         kni_fd = -1;
 844 }