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