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
 256         memcpy(dev_info.mac_addr, conf->mac_addr, RTE_ETHER_ADDR_LEN);
 257
 258         strlcpy(dev_info.name, conf->name, RTE_KNI_NAMESIZE);
 259
 260         ret = kni_reserve_mz(kni);
 261         if (ret < 0)
 262                 goto mz_fail;
 263
 264         /* TX RING */
 265         kni->tx_q = kni->m_tx_q->addr;
 266         kni_fifo_init(kni->tx_q, KNI_FIFO_COUNT_MAX);
 267         dev_info.tx_phys = kni->m_tx_q->phys_addr;
 268
 269         /* RX RING */
 270         kni->rx_q = kni->m_rx_q->addr;
 271         kni_fifo_init(kni->rx_q, KNI_FIFO_COUNT_MAX);
 272         dev_info.rx_phys = kni->m_rx_q->phys_addr;
 273
 274         /* ALLOC RING */
 275         kni->alloc_q = kni->m_alloc_q->addr;
 276         kni_fifo_init(kni->alloc_q, KNI_FIFO_COUNT_MAX);
 277         dev_info.alloc_phys = kni->m_alloc_q->phys_addr;
 278
 279         /* FREE RING */
 280         kni->free_q = kni->m_free_q->addr;
 281         kni_fifo_init(kni->free_q, KNI_FIFO_COUNT_MAX);
 282         dev_info.free_phys = kni->m_free_q->phys_addr;
 283
 284         /* Request RING */
 285         kni->req_q = kni->m_req_q->addr;
 286         kni_fifo_init(kni->req_q, KNI_FIFO_COUNT_MAX);
 287         dev_info.req_phys = kni->m_req_q->phys_addr;
 288
 289         /* Response RING */
 290         kni->resp_q = kni->m_resp_q->addr;
 291         kni_fifo_init(kni->resp_q, KNI_FIFO_COUNT_MAX);
 292         dev_info.resp_phys = kni->m_resp_q->phys_addr;
 293
 294         /* Req/Resp sync mem area */
 295         kni->sync_addr = kni->m_sync_addr->addr;
 296         dev_info.sync_va = kni->m_sync_addr->addr;
 297         dev_info.sync_phys = kni->m_sync_addr->phys_addr;
 298
 299         kni->pktmbuf_pool = pktmbuf_pool;
 300         kni->group_id = conf->group_id;
 301         kni->mbuf_size = conf->mbuf_size;
 302
 303         ret = ioctl(kni_fd, RTE_KNI_IOCTL_CREATE, &dev_info);
 304         if (ret < 0)
 305                 goto ioctl_fail;
 306
 307         te->data = kni;
 308
 309         kni_list = RTE_TAILQ_CAST(rte_kni_tailq.head, rte_kni_list);
 310         TAILQ_INSERT_TAIL(kni_list, te, next);
 311
 312         rte_mcfg_tailq_write_unlock();
 313
 314         /* Allocate mbufs and then put them into alloc_q */
 315         kni_allocate_mbufs(kni);
 316
 317         return kni;
 318
 319 ioctl_fail:
 320         kni_release_mz(kni);
 321 mz_fail:
 322         rte_free(kni);
 323 kni_fail:
 324         rte_free(te);
 325 unlock:
 326         rte_mcfg_tailq_write_unlock();
 327
 328         return NULL;
 329 }
 330
 331 static void
 332 kni_free_fifo(struct rte_kni_fifo *fifo)
 333 {
 334         int ret;
 335         struct rte_mbuf *pkt;
 336
 337         do {
 338                 ret = kni_fifo_get(fifo, (void **)&pkt, 1);
 339                 if (ret)
 340                         rte_pktmbuf_free(pkt);
 341         } while (ret);
 342 }
 343
 344 static void *
 345 va2pa(struct rte_mbuf *m)
 346 {
 347         return (void *)((unsigned long)m -
 348                         ((unsigned long)m->buf_addr -
 349                          (unsigned long)m->buf_iova));
 350 }
 351
 352 static void *
 353 va2pa_all(struct rte_mbuf *mbuf)
 354 {
 355         void *phy_mbuf = va2pa(mbuf);
 356         struct rte_mbuf *next = mbuf->next;
 357         while (next) {
 358                 mbuf->next = va2pa(next);
 359                 mbuf = next;
 360                 next = mbuf->next;
 361         }
 362         return phy_mbuf;
 363 }
 364
 365 static void
 366 obj_free(struct rte_mempool *mp __rte_unused, void *opaque, void *obj,
 367                 unsigned obj_idx __rte_unused)
 368 {
 369         struct rte_mbuf *m = obj;
 370         void *mbuf_phys = opaque;
 371
 372         if (va2pa(m) == mbuf_phys)
 373                 rte_pktmbuf_free(m);
 374 }
 375
 376 static void
 377 kni_free_fifo_phy(struct rte_mempool *mp, struct rte_kni_fifo *fifo)
 378 {
 379         void *mbuf_phys;
 380         int ret;
 381
 382         do {
 383                 ret = kni_fifo_get(fifo, &mbuf_phys, 1);
 384                 if (ret)
 385                         rte_mempool_obj_iter(mp, obj_free, mbuf_phys);
 386         } while (ret);
 387 }
 388
 389 int
 390 rte_kni_release(struct rte_kni *kni)
 391 {
 392         struct rte_tailq_entry *te;
 393         struct rte_kni_list *kni_list;
 394         struct rte_kni_device_info dev_info;
 395         uint32_t retry = 5;
 396
 397         if (!kni)
 398                 return -1;
 399
 400         kni_list = RTE_TAILQ_CAST(rte_kni_tailq.head, rte_kni_list);
 401
 402         rte_mcfg_tailq_write_lock();
 403
 404         TAILQ_FOREACH(te, kni_list, next) {
 405                 if (te->data == kni)
 406                         break;
 407         }
 408
 409         if (te == NULL)
 410                 goto unlock;
 411
 412         strlcpy(dev_info.name, kni->name, sizeof(dev_info.name));
 413         if (ioctl(kni_fd, RTE_KNI_IOCTL_RELEASE, &dev_info) < 0) {
 414                 RTE_LOG(ERR, KNI, "Fail to release kni device\n");
 415                 goto unlock;
 416         }
 417
 418         TAILQ_REMOVE(kni_list, te, next);
 419
 420         rte_mcfg_tailq_write_unlock();
 421
 422         /* mbufs in all fifo should be released, except request/response */
 423
 424         /* wait until all rxq packets processed by kernel */
 425         while (kni_fifo_count(kni->rx_q) && retry--)
 426                 usleep(1000);
 427
 428         if (kni_fifo_count(kni->rx_q))
 429                 RTE_LOG(ERR, KNI, "Fail to free all Rx-q items\n");
 430
 431         kni_free_fifo_phy(kni->pktmbuf_pool, kni->alloc_q);
 432         kni_free_fifo(kni->tx_q);
 433         kni_free_fifo(kni->free_q);
 434
 435         kni_release_mz(kni);
 436
 437         rte_free(kni);
 438
 439         rte_free(te);
 440
 441         return 0;
 442
 443 unlock:
 444         rte_mcfg_tailq_write_unlock();
 445
 446         return -1;
 447 }
 448
 449 /* default callback for request of configuring device mac address */
 450 static int
 451 kni_config_mac_address(uint16_t port_id, uint8_t mac_addr[])
 452 {
 453         int ret = 0;
 454
 455         if (!rte_eth_dev_is_valid_port(port_id)) {
 456                 RTE_LOG(ERR, KNI, "Invalid port id %d\n", port_id);
 457                 return -EINVAL;
 458         }
 459
 460         RTE_LOG(INFO, KNI, "Configure mac address of %d", port_id);
 461
 462         ret = rte_eth_dev_default_mac_addr_set(port_id,
 463                                         (struct rte_ether_addr *)mac_addr);
 464         if (ret < 0)
 465                 RTE_LOG(ERR, KNI, "Failed to config mac_addr for port %d\n",
 466                         port_id);
 467
 468         return ret;
 469 }
 470
 471 /* default callback for request of configuring promiscuous mode */
 472 static int
 473 kni_config_promiscusity(uint16_t port_id, uint8_t to_on)
 474 {
 475         int ret;
 476
 477         if (!rte_eth_dev_is_valid_port(port_id)) {
 478                 RTE_LOG(ERR, KNI, "Invalid port id %d\n", port_id);
 479                 return -EINVAL;
 480         }
 481
 482         RTE_LOG(INFO, KNI, "Configure promiscuous mode of %d to %d\n",
 483                 port_id, to_on);
 484
 485         if (to_on)
 486                 ret = rte_eth_promiscuous_enable(port_id);
 487         else
 488                 ret = rte_eth_promiscuous_disable(port_id);
 489
 490         if (ret != 0)
 491                 RTE_LOG(ERR, KNI,
 492                         "Failed to %s promiscuous mode for port %u: %s\n",
 493                         to_on ? "enable" : "disable", port_id,
 494                         rte_strerror(-ret));
 495
 496         return ret;
 497 }
 498
 499 /* default callback for request of configuring allmulticast mode */
 500 static int
 501 kni_config_allmulticast(uint16_t port_id, uint8_t to_on)
 502 {
 503         if (!rte_eth_dev_is_valid_port(port_id)) {
 504                 RTE_LOG(ERR, KNI, "Invalid port id %d\n", port_id);
 505                 return -EINVAL;
 506         }
 507
 508         RTE_LOG(INFO, KNI, "Configure allmulticast mode of %d to %d\n",
 509                 port_id, to_on);
 510
 511         if (to_on)
 512                 rte_eth_allmulticast_enable(port_id);
 513         else
 514                 rte_eth_allmulticast_disable(port_id);
 515
 516         return 0;
 517 }
 518
 519 int
 520 rte_kni_handle_request(struct rte_kni *kni)
 521 {
 522         unsigned int ret;
 523         struct rte_kni_request *req = NULL;
 524
 525         if (kni == NULL)
 526                 return -1;
 527
 528         /* Get request mbuf */
 529         ret = kni_fifo_get(kni->req_q, (void **)&req, 1);
 530         if (ret != 1)
 531                 return 0; /* It is OK of can not getting the request mbuf */
 532
 533         if (req != kni->sync_addr) {
 534                 RTE_LOG(ERR, KNI, "Wrong req pointer %p\n", req);
 535                 return -1;
 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(kni->ops.port_id,
 548                                                                  req->if_up);
 549                 break;
 550         case RTE_KNI_REQ_CHANGE_MAC_ADDR: /* Change MAC Address */
 551                 if (kni->ops.config_mac_address)
 552                         req->result = kni->ops.config_mac_address(
 553                                         kni->ops.port_id, req->mac_addr);
 554                 else if (kni->ops.port_id != UINT16_MAX)
 555                         req->result = kni_config_mac_address(
 556                                         kni->ops.port_id, req->mac_addr);
 557                 break;
 558         case RTE_KNI_REQ_CHANGE_PROMISC: /* Change PROMISCUOUS MODE */
 559                 if (kni->ops.config_promiscusity)
 560                         req->result = kni->ops.config_promiscusity(
 561                                         kni->ops.port_id, req->promiscusity);
 562                 else if (kni->ops.port_id != UINT16_MAX)
 563                         req->result = kni_config_promiscusity(
 564                                         kni->ops.port_id, req->promiscusity);
 565                 break;
 566         case RTE_KNI_REQ_CHANGE_ALLMULTI: /* Change ALLMULTICAST MODE */
 567                 if (kni->ops.config_allmulticast)
 568                         req->result = kni->ops.config_allmulticast(
 569                                         kni->ops.port_id, req->allmulti);
 570                 else if (kni->ops.port_id != UINT16_MAX)
 571                         req->result = kni_config_allmulticast(
 572                                         kni->ops.port_id, req->allmulti);
 573                 break;
 574         default:
 575                 RTE_LOG(ERR, KNI, "Unknown request id %u\n", req->req_id);
 576                 req->result = -EINVAL;
 577                 break;
 578         }
 579
 580         /* Construct response mbuf and put it back to resp_q */
 581         ret = kni_fifo_put(kni->resp_q, (void **)&req, 1);
 582         if (ret != 1) {
 583                 RTE_LOG(ERR, KNI, "Fail to put the muf back to resp_q\n");
 584                 return -1; /* It is an error of can't putting the mbuf back */
 585         }
 586
 587         return 0;
 588 }
 589
 590 unsigned
 591 rte_kni_tx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, unsigned int num)
 592 {
 593         num = RTE_MIN(kni_fifo_free_count(kni->rx_q), num);
 594         void *phy_mbufs[num];
 595         unsigned int ret;
 596         unsigned int i;
 597
 598         for (i = 0; i < num; i++)
 599                 phy_mbufs[i] = va2pa_all(mbufs[i]);
 600
 601         ret = kni_fifo_put(kni->rx_q, phy_mbufs, num);
 602
 603         /* Get mbufs from free_q and then free them */
 604         kni_free_mbufs(kni);
 605
 606         return ret;
 607 }
 608
 609 unsigned
 610 rte_kni_rx_burst(struct rte_kni *kni, struct rte_mbuf **mbufs, unsigned int num)
 611 {
 612         unsigned int ret = kni_fifo_get(kni->tx_q, (void **)mbufs, num);
 613
 614         /* If buffers removed, allocate mbufs and then put them into alloc_q */
 615         if (ret)
 616                 kni_allocate_mbufs(kni);
 617
 618         return ret;
 619 }
 620
 621 static void
 622 kni_free_mbufs(struct rte_kni *kni)
 623 {
 624         int i, ret;
 625         struct rte_mbuf *pkts[MAX_MBUF_BURST_NUM];
 626
 627         ret = kni_fifo_get(kni->free_q, (void **)pkts, MAX_MBUF_BURST_NUM);
 628         if (likely(ret > 0)) {
 629                 for (i = 0; i < ret; i++)
 630                         rte_pktmbuf_free(pkts[i]);
 631         }
 632 }
 633
 634 static void
 635 kni_allocate_mbufs(struct rte_kni *kni)
 636 {
 637         int i, ret;
 638         struct rte_mbuf *pkts[MAX_MBUF_BURST_NUM];
 639         void *phys[MAX_MBUF_BURST_NUM];
 640         int allocq_free;
 641
 642         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, pool) !=
 643                          offsetof(struct rte_kni_mbuf, pool));
 644         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, buf_addr) !=
 645                          offsetof(struct rte_kni_mbuf, buf_addr));
 646         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, next) !=
 647                          offsetof(struct rte_kni_mbuf, next));
 648         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, data_off) !=
 649                          offsetof(struct rte_kni_mbuf, data_off));
 650         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, data_len) !=
 651                          offsetof(struct rte_kni_mbuf, data_len));
 652         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, pkt_len) !=
 653                          offsetof(struct rte_kni_mbuf, pkt_len));
 654         RTE_BUILD_BUG_ON(offsetof(struct rte_mbuf, ol_flags) !=
 655                          offsetof(struct rte_kni_mbuf, ol_flags));
 656
 657         /* Check if pktmbuf pool has been configured */
 658         if (kni->pktmbuf_pool == NULL) {
 659                 RTE_LOG(ERR, KNI, "No valid mempool for allocating mbufs\n");
 660                 return;
 661         }
 662
 663         allocq_free = (kni->alloc_q->read - kni->alloc_q->write - 1)
 664                         & (MAX_MBUF_BURST_NUM - 1);
 665         for (i = 0; i < allocq_free; i++) {
 666                 pkts[i] = rte_pktmbuf_alloc(kni->pktmbuf_pool);
 667                 if (unlikely(pkts[i] == NULL)) {
 668                         /* Out of memory */
 669                         RTE_LOG(ERR, KNI, "Out of memory\n");
 670                         break;
 671                 }
 672                 phys[i] = va2pa(pkts[i]);
 673         }
 674
 675         /* No pkt mbuf allocated */
 676         if (i <= 0)
 677                 return;
 678
 679         ret = kni_fifo_put(kni->alloc_q, phys, i);
 680
 681         /* Check if any mbufs not put into alloc_q, and then free them */
 682         if (ret >= 0 && ret < i && ret < MAX_MBUF_BURST_NUM) {
 683                 int j;
 684
 685                 for (j = ret; j < i; j++)
 686                         rte_pktmbuf_free(pkts[j]);
 687         }
 688 }
 689
 690 struct rte_kni *
 691 rte_kni_get(const char *name)
 692 {
 693         struct rte_kni *kni;
 694
 695         if (name == NULL || name[0] == '\0')
 696                 return NULL;
 697
 698         rte_mcfg_tailq_read_lock();
 699
 700         kni = __rte_kni_get(name);
 701
 702         rte_mcfg_tailq_read_unlock();
 703
 704         return kni;
 705 }
 706
 707 const char *
 708 rte_kni_get_name(const struct rte_kni *kni)
 709 {
 710         return kni->name;
 711 }
 712
 713 static enum kni_ops_status
 714 kni_check_request_register(struct rte_kni_ops *ops)
 715 {
 716         /* check if KNI request ops has been registered*/
 717         if (ops == NULL)
 718                 return KNI_REQ_NO_REGISTER;
 719
 720         if (ops->change_mtu == NULL
 721             && ops->config_network_if == NULL
 722             && ops->config_mac_address == NULL
 723             && ops->config_promiscusity == NULL
 724             && ops->config_allmulticast == NULL)
 725                 return KNI_REQ_NO_REGISTER;
 726
 727         return KNI_REQ_REGISTERED;
 728 }
 729
 730 int
 731 rte_kni_register_handlers(struct rte_kni *kni, struct rte_kni_ops *ops)
 732 {
 733         enum kni_ops_status req_status;
 734
 735         if (ops == NULL) {
 736                 RTE_LOG(ERR, KNI, "Invalid KNI request operation.\n");
 737                 return -1;
 738         }
 739
 740         if (kni == NULL) {
 741                 RTE_LOG(ERR, KNI, "Invalid kni info.\n");
 742                 return -1;
 743         }
 744
 745         req_status = kni_check_request_register(&kni->ops);
 746         if (req_status == KNI_REQ_REGISTERED) {
 747                 RTE_LOG(ERR, KNI, "The KNI request operation has already registered.\n");
 748                 return -1;
 749         }
 750
 751         memcpy(&kni->ops, ops, sizeof(struct rte_kni_ops));
 752         return 0;
 753 }
 754
 755 int
 756 rte_kni_unregister_handlers(struct rte_kni *kni)
 757 {
 758         if (kni == NULL) {
 759                 RTE_LOG(ERR, KNI, "Invalid kni info.\n");
 760                 return -1;
 761         }
 762
 763         memset(&kni->ops, 0, sizeof(struct rte_kni_ops));
 764
 765         return 0;
 766 }
 767
 768 int
 769 rte_kni_update_link(struct rte_kni *kni, unsigned int linkup)
 770 {
 771         char path[64];
 772         char old_carrier[2];
 773         const char *new_carrier;
 774         int old_linkup;
 775         int fd, ret;
 776
 777         if (kni == NULL)
 778                 return -1;
 779
 780         snprintf(path, sizeof(path), "/sys/devices/virtual/net/%s/carrier",
 781                 kni->name);
 782
 783         fd = open(path, O_RDWR);
 784         if (fd == -1) {
 785                 RTE_LOG(ERR, KNI, "Failed to open file: %s.\n", path);
 786                 return -1;
 787         }
 788
 789         ret = read(fd, old_carrier, 2);
 790         if (ret < 1) {
 791                 close(fd);
 792                 return -1;
 793         }
 794         old_linkup = (old_carrier[0] == '1');
 795
 796         new_carrier = linkup ? "1" : "0";
 797         ret = write(fd, new_carrier, 1);
 798         if (ret < 1) {
 799                 RTE_LOG(ERR, KNI, "Failed to write file: %s.\n", path);
 800                 close(fd);
 801                 return -1;
 802         }
 803
 804         close(fd);
 805         return old_linkup;
 806 }
 807
 808 void
 809 rte_kni_close(void)
 810 {
 811         if (kni_fd < 0)
 812                 return;
 813
 814         close(kni_fd);
 815         kni_fd = -1;
 816 }