drivers/net/tap/rte_eth_tap.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016-2017 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 #include <rte_atomic.h>
  35 #include <rte_branch_prediction.h>
  36 #include <rte_byteorder.h>
  37 #include <rte_common.h>
  38 #include <rte_mbuf.h>
  39 #include <rte_ethdev.h>
  40 #include <rte_ethdev_vdev.h>
  41 #include <rte_malloc.h>
  42 #include <rte_vdev.h>
  43 #include <rte_kvargs.h>
  44 #include <rte_net.h>
  45 #include <rte_debug.h>
  46 #include <rte_ip.h>
  47
  48 #include <sys/types.h>
  49 #include <sys/stat.h>
  50 #include <sys/socket.h>
  51 #include <sys/ioctl.h>
  52 #include <sys/utsname.h>
  53 #include <sys/mman.h>
  54 #include <errno.h>
  55 #include <signal.h>
  56 #include <stdint.h>
  57 #include <sys/uio.h>
  58 #include <unistd.h>
  59 #include <arpa/inet.h>
  60 #include <net/if.h>
  61 #include <linux/if_tun.h>
  62 #include <linux/if_ether.h>
  63 #include <linux/version.h>
  64 #include <fcntl.h>
  65
  66 #include <rte_eth_tap.h>
  67 #include <tap_flow.h>
  68 #include <tap_netlink.h>
  69 #include <tap_tcmsgs.h>
  70
  71 /* Linux based path to the TUN device */
  72 #define TUN_TAP_DEV_PATH        "/dev/net/tun"
  73 #define DEFAULT_TAP_NAME        "dtap"
  74
  75 #define ETH_TAP_IFACE_ARG       "iface"
  76 #define ETH_TAP_SPEED_ARG       "speed"
  77 #define ETH_TAP_REMOTE_ARG      "remote"
  78 #define ETH_TAP_MAC_ARG         "mac"
  79 #define ETH_TAP_MAC_FIXED       "fixed"
  80
  81 #define FLOWER_KERNEL_VERSION KERNEL_VERSION(4, 2, 0)
  82 #define FLOWER_VLAN_KERNEL_VERSION KERNEL_VERSION(4, 9, 0)
  83
  84 static struct rte_vdev_driver pmd_tap_drv;
  85
  86 static const char *valid_arguments[] = {
  87         ETH_TAP_IFACE_ARG,
  88         ETH_TAP_SPEED_ARG,
  89         ETH_TAP_REMOTE_ARG,
  90         ETH_TAP_MAC_ARG,
  91         NULL
  92 };
  93
  94 static int tap_unit;
  95
  96 static volatile uint32_t tap_trigger;   /* Rx trigger */
  97
  98 static struct rte_eth_link pmd_link = {
  99         .link_speed = ETH_SPEED_NUM_10G,
 100         .link_duplex = ETH_LINK_FULL_DUPLEX,
 101         .link_status = ETH_LINK_DOWN,
 102         .link_autoneg = ETH_LINK_SPEED_AUTONEG
 103 };
 104
 105 static void
 106 tap_trigger_cb(int sig __rte_unused)
 107 {
 108         /* Valid trigger values are nonzero */
 109         tap_trigger = (tap_trigger + 1) | 0x80000000;
 110 }
 111
 112 /* Specifies on what netdevices the ioctl should be applied */
 113 enum ioctl_mode {
 114         LOCAL_AND_REMOTE,
 115         LOCAL_ONLY,
 116         REMOTE_ONLY,
 117 };
 118
 119 static int tap_intr_handle_set(struct rte_eth_dev *dev, int set);
 120
 121 /* Tun/Tap allocation routine
 122  *
 123  * name is the number of the interface to use, unless NULL to take the host
 124  * supplied name.
 125  */
 126 static int
 127 tun_alloc(struct pmd_internals *pmd)
 128 {
 129         struct ifreq ifr;
 130 #ifdef IFF_MULTI_QUEUE
 131         unsigned int features;
 132 #endif
 133         int fd;
 134
 135         memset(&ifr, 0, sizeof(struct ifreq));
 136
 137         /*
 138          * Do not set IFF_NO_PI as packet information header will be needed
 139          * to check if a received packet has been truncated.
 140          */
 141         ifr.ifr_flags = IFF_TAP;
 142         snprintf(ifr.ifr_name, IFNAMSIZ, "%s", pmd->name);
 143
 144         RTE_LOG(DEBUG, PMD, "ifr_name '%s'\n", ifr.ifr_name);
 145
 146         fd = open(TUN_TAP_DEV_PATH, O_RDWR);
 147         if (fd < 0) {
 148                 RTE_LOG(ERR, PMD, "Unable to create TAP interface\n");
 149                 goto error;
 150         }
 151
 152 #ifdef IFF_MULTI_QUEUE
 153         /* Grab the TUN features to verify we can work multi-queue */
 154         if (ioctl(fd, TUNGETFEATURES, &features) < 0) {
 155                 RTE_LOG(ERR, PMD, "TAP unable to get TUN/TAP features\n");
 156                 goto error;
 157         }
 158         RTE_LOG(DEBUG, PMD, "  TAP Features %08x\n", features);
 159
 160         if (features & IFF_MULTI_QUEUE) {
 161                 RTE_LOG(DEBUG, PMD, "  Multi-queue support for %d queues\n",
 162                         RTE_PMD_TAP_MAX_QUEUES);
 163                 ifr.ifr_flags |= IFF_MULTI_QUEUE;
 164         } else
 165 #endif
 166         {
 167                 ifr.ifr_flags |= IFF_ONE_QUEUE;
 168                 RTE_LOG(DEBUG, PMD, "  Single queue only support\n");
 169         }
 170
 171         /* Set the TUN/TAP configuration and set the name if needed */
 172         if (ioctl(fd, TUNSETIFF, (void *)&ifr) < 0) {
 173                 RTE_LOG(WARNING, PMD,
 174                         "Unable to set TUNSETIFF for %s\n",
 175                         ifr.ifr_name);
 176                 perror("TUNSETIFF");
 177                 goto error;
 178         }
 179
 180         /* Always set the file descriptor to non-blocking */
 181         if (fcntl(fd, F_SETFL, O_NONBLOCK) < 0) {
 182                 RTE_LOG(WARNING, PMD,
 183                         "Unable to set %s to nonblocking\n",
 184                         ifr.ifr_name);
 185                 perror("F_SETFL, NONBLOCK");
 186                 goto error;
 187         }
 188
 189         /* Set up trigger to optimize empty Rx bursts */
 190         errno = 0;
 191         do {
 192                 struct sigaction sa;
 193                 int flags = fcntl(fd, F_GETFL);
 194
 195                 if (flags == -1 || sigaction(SIGIO, NULL, &sa) == -1)
 196                         break;
 197                 if (sa.sa_handler != tap_trigger_cb) {
 198                         /*
 199                          * Make sure SIGIO is not already taken. This is done
 200                          * as late as possible to leave the application a
 201                          * chance to set up its own signal handler first.
 202                          */
 203                         if (sa.sa_handler != SIG_IGN &&
 204                             sa.sa_handler != SIG_DFL) {
 205                                 errno = EBUSY;
 206                                 break;
 207                         }
 208                         sa = (struct sigaction){
 209                                 .sa_flags = SA_RESTART,
 210                                 .sa_handler = tap_trigger_cb,
 211                         };
 212                         if (sigaction(SIGIO, &sa, NULL) == -1)
 213                                 break;
 214                 }
 215                 /* Enable SIGIO on file descriptor */
 216                 fcntl(fd, F_SETFL, flags | O_ASYNC);
 217                 fcntl(fd, F_SETOWN, getpid());
 218         } while (0);
 219         if (errno) {
 220                 /* Disable trigger globally in case of error */
 221                 tap_trigger = 0;
 222                 RTE_LOG(WARNING, PMD, "Rx trigger disabled: %s\n",
 223                         strerror(errno));
 224         }
 225
 226         return fd;
 227
 228 error:
 229         if (fd > 0)
 230                 close(fd);
 231         return -1;
 232 }
 233
 234 static void
 235 tap_verify_csum(struct rte_mbuf *mbuf)
 236 {
 237         uint32_t l2 = mbuf->packet_type & RTE_PTYPE_L2_MASK;
 238         uint32_t l3 = mbuf->packet_type & RTE_PTYPE_L3_MASK;
 239         uint32_t l4 = mbuf->packet_type & RTE_PTYPE_L4_MASK;
 240         unsigned int l2_len = sizeof(struct ether_hdr);
 241         unsigned int l3_len;
 242         uint16_t cksum = 0;
 243         void *l3_hdr;
 244         void *l4_hdr;
 245
 246         if (l2 == RTE_PTYPE_L2_ETHER_VLAN)
 247                 l2_len += 4;
 248         else if (l2 == RTE_PTYPE_L2_ETHER_QINQ)
 249                 l2_len += 8;
 250         /* Don't verify checksum for packets with discontinuous L2 header */
 251         if (unlikely(l2_len + sizeof(struct ipv4_hdr) >
 252                      rte_pktmbuf_data_len(mbuf)))
 253                 return;
 254         l3_hdr = rte_pktmbuf_mtod_offset(mbuf, void *, l2_len);
 255         if (l3 == RTE_PTYPE_L3_IPV4 || l3 == RTE_PTYPE_L3_IPV4_EXT) {
 256                 struct ipv4_hdr *iph = l3_hdr;
 257
 258                 /* ihl contains the number of 4-byte words in the header */
 259                 l3_len = 4 * (iph->version_ihl & 0xf);
 260                 if (unlikely(l2_len + l3_len > rte_pktmbuf_data_len(mbuf)))
 261                         return;
 262
 263                 cksum = ~rte_raw_cksum(iph, l3_len);
 264                 mbuf->ol_flags |= cksum ?
 265                         PKT_RX_IP_CKSUM_BAD :
 266                         PKT_RX_IP_CKSUM_GOOD;
 267         } else if (l3 == RTE_PTYPE_L3_IPV6) {
 268                 l3_len = sizeof(struct ipv6_hdr);
 269         } else {
 270                 /* IPv6 extensions are not supported */
 271                 return;
 272         }
 273         if (l4 == RTE_PTYPE_L4_UDP || l4 == RTE_PTYPE_L4_TCP) {
 274                 l4_hdr = rte_pktmbuf_mtod_offset(mbuf, void *, l2_len + l3_len);
 275                 /* Don't verify checksum for multi-segment packets. */
 276                 if (mbuf->nb_segs > 1)
 277                         return;
 278                 if (l3 == RTE_PTYPE_L3_IPV4)
 279                         cksum = ~rte_ipv4_udptcp_cksum(l3_hdr, l4_hdr);
 280                 else if (l3 == RTE_PTYPE_L3_IPV6)
 281                         cksum = ~rte_ipv6_udptcp_cksum(l3_hdr, l4_hdr);
 282                 mbuf->ol_flags |= cksum ?
 283                         PKT_RX_L4_CKSUM_BAD :
 284                         PKT_RX_L4_CKSUM_GOOD;
 285         }
 286 }
 287
 288 /* Callback to handle the rx burst of packets to the correct interface and
 289  * file descriptor(s) in a multi-queue setup.
 290  */
 291 static uint16_t
 292 pmd_rx_burst(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
 293 {
 294         struct rx_queue *rxq = queue;
 295         uint16_t num_rx;
 296         unsigned long num_rx_bytes = 0;
 297         uint32_t trigger = tap_trigger;
 298
 299         if (trigger == rxq->trigger_seen)
 300                 return 0;
 301         if (trigger)
 302                 rxq->trigger_seen = trigger;
 303         rte_compiler_barrier();
 304         for (num_rx = 0; num_rx < nb_pkts; ) {
 305                 struct rte_mbuf *mbuf = rxq->pool;
 306                 struct rte_mbuf *seg = NULL;
 307                 struct rte_mbuf *new_tail = NULL;
 308                 uint16_t data_off = rte_pktmbuf_headroom(mbuf);
 309                 int len;
 310
 311                 len = readv(rxq->fd, *rxq->iovecs,
 312                             1 + (rxq->rxmode->enable_scatter ?
 313                                  rxq->nb_rx_desc : 1));
 314                 if (len < (int)sizeof(struct tun_pi))
 315                         break;
 316
 317                 /* Packet couldn't fit in the provided mbuf */
 318                 if (unlikely(rxq->pi.flags & TUN_PKT_STRIP)) {
 319                         rxq->stats.ierrors++;
 320                         continue;
 321                 }
 322
 323                 len -= sizeof(struct tun_pi);
 324
 325                 mbuf->pkt_len = len;
 326                 mbuf->port = rxq->in_port;
 327                 while (1) {
 328                         struct rte_mbuf *buf = rte_pktmbuf_alloc(rxq->mp);
 329
 330                         if (unlikely(!buf)) {
 331                                 rxq->stats.rx_nombuf++;
 332                                 /* No new buf has been allocated: do nothing */
 333                                 if (!new_tail || !seg)
 334                                         goto end;
 335
 336                                 seg->next = NULL;
 337                                 rte_pktmbuf_free(mbuf);
 338
 339                                 goto end;
 340                         }
 341                         seg = seg ? seg->next : mbuf;
 342                         if (rxq->pool == mbuf)
 343                                 rxq->pool = buf;
 344                         if (new_tail)
 345                                 new_tail->next = buf;
 346                         new_tail = buf;
 347                         new_tail->next = seg->next;
 348
 349                         /* iovecs[0] is reserved for packet info (pi) */
 350                         (*rxq->iovecs)[mbuf->nb_segs].iov_len =
 351                                 buf->buf_len - data_off;
 352                         (*rxq->iovecs)[mbuf->nb_segs].iov_base =
 353                                 (char *)buf->buf_addr + data_off;
 354
 355                         seg->data_len = RTE_MIN(seg->buf_len - data_off, len);
 356                         seg->data_off = data_off;
 357
 358                         len -= seg->data_len;
 359                         if (len <= 0)
 360                                 break;
 361                         mbuf->nb_segs++;
 362                         /* First segment has headroom, not the others */
 363                         data_off = 0;
 364                 }
 365                 seg->next = NULL;
 366                 mbuf->packet_type = rte_net_get_ptype(mbuf, NULL,
 367                                                       RTE_PTYPE_ALL_MASK);
 368                 if (rxq->rxmode->hw_ip_checksum)
 369                         tap_verify_csum(mbuf);
 370
 371                 /* account for the receive frame */
 372                 bufs[num_rx++] = mbuf;
 373                 num_rx_bytes += mbuf->pkt_len;
 374         }
 375 end:
 376         rxq->stats.ipackets += num_rx;
 377         rxq->stats.ibytes += num_rx_bytes;
 378
 379         return num_rx;
 380 }
 381
 382 static void
 383 tap_tx_offload(char *packet, uint64_t ol_flags, unsigned int l2_len,
 384                unsigned int l3_len)
 385 {
 386         void *l3_hdr = packet + l2_len;
 387
 388         if (ol_flags & (PKT_TX_IP_CKSUM | PKT_TX_IPV4)) {
 389                 struct ipv4_hdr *iph = l3_hdr;
 390                 uint16_t cksum;
 391
 392                 iph->hdr_checksum = 0;
 393                 cksum = rte_raw_cksum(iph, l3_len);
 394                 iph->hdr_checksum = (cksum == 0xffff) ? cksum : ~cksum;
 395         }
 396         if (ol_flags & PKT_TX_L4_MASK) {
 397                 uint16_t l4_len;
 398                 uint32_t cksum;
 399                 uint16_t *l4_cksum;
 400                 void *l4_hdr;
 401
 402                 l4_hdr = packet + l2_len + l3_len;
 403                 if ((ol_flags & PKT_TX_L4_MASK) == PKT_TX_UDP_CKSUM)
 404                         l4_cksum = &((struct udp_hdr *)l4_hdr)->dgram_cksum;
 405                 else if ((ol_flags & PKT_TX_L4_MASK) == PKT_TX_TCP_CKSUM)
 406                         l4_cksum = &((struct tcp_hdr *)l4_hdr)->cksum;
 407                 else
 408                         return;
 409                 *l4_cksum = 0;
 410                 if (ol_flags & PKT_TX_IPV4) {
 411                         struct ipv4_hdr *iph = l3_hdr;
 412
 413                         l4_len = rte_be_to_cpu_16(iph->total_length) - l3_len;
 414                         cksum = rte_ipv4_phdr_cksum(l3_hdr, 0);
 415                 } else {
 416                         struct ipv6_hdr *ip6h = l3_hdr;
 417
 418                         /* payload_len does not include ext headers */
 419                         l4_len = rte_be_to_cpu_16(ip6h->payload_len) -
 420                                 l3_len + sizeof(struct ipv6_hdr);
 421                         cksum = rte_ipv6_phdr_cksum(l3_hdr, 0);
 422                 }
 423                 cksum += rte_raw_cksum(l4_hdr, l4_len);
 424                 cksum = ((cksum & 0xffff0000) >> 16) + (cksum & 0xffff);
 425                 cksum = (~cksum) & 0xffff;
 426                 if (cksum == 0)
 427                         cksum = 0xffff;
 428                 *l4_cksum = cksum;
 429         }
 430 }
 431
 432 /* Callback to handle sending packets from the tap interface
 433  */
 434 static uint16_t
 435 pmd_tx_burst(void *queue, struct rte_mbuf **bufs, uint16_t nb_pkts)
 436 {
 437         struct tx_queue *txq = queue;
 438         uint16_t num_tx = 0;
 439         unsigned long num_tx_bytes = 0;
 440         uint32_t max_size;
 441         int i;
 442
 443         if (unlikely(nb_pkts == 0))
 444                 return 0;
 445
 446         max_size = *txq->mtu + (ETHER_HDR_LEN + ETHER_CRC_LEN + 4);
 447         for (i = 0; i < nb_pkts; i++) {
 448                 struct rte_mbuf *mbuf = bufs[num_tx];
 449                 struct iovec iovecs[mbuf->nb_segs + 1];
 450                 struct tun_pi pi = { .flags = 0 };
 451                 struct rte_mbuf *seg = mbuf;
 452                 char m_copy[mbuf->data_len];
 453                 int n;
 454                 int j;
 455
 456                 /* stats.errs will be incremented */
 457                 if (rte_pktmbuf_pkt_len(mbuf) > max_size)
 458                         break;
 459
 460                 iovecs[0].iov_base = &pi;
 461                 iovecs[0].iov_len = sizeof(pi);
 462                 for (j = 1; j <= mbuf->nb_segs; j++) {
 463                         iovecs[j].iov_len = rte_pktmbuf_data_len(seg);
 464                         iovecs[j].iov_base =
 465                                 rte_pktmbuf_mtod(seg, void *);
 466                         seg = seg->next;
 467                 }
 468                 if (mbuf->ol_flags & (PKT_TX_IP_CKSUM | PKT_TX_IPV4) ||
 469                     (mbuf->ol_flags & PKT_TX_L4_MASK) == PKT_TX_UDP_CKSUM ||
 470                     (mbuf->ol_flags & PKT_TX_L4_MASK) == PKT_TX_TCP_CKSUM) {
 471                         /* Support only packets with all data in the same seg */
 472                         if (mbuf->nb_segs > 1)
 473                                 break;
 474                         /* To change checksums, work on a copy of data. */
 475                         rte_memcpy(m_copy, rte_pktmbuf_mtod(mbuf, void *),
 476                                    rte_pktmbuf_data_len(mbuf));
 477                         tap_tx_offload(m_copy, mbuf->ol_flags,
 478                                        mbuf->l2_len, mbuf->l3_len);
 479                         iovecs[1].iov_base = m_copy;
 480                 }
 481                 /* copy the tx frame data */
 482                 n = writev(txq->fd, iovecs, mbuf->nb_segs + 1);
 483                 if (n <= 0)
 484                         break;
 485
 486                 num_tx++;
 487                 num_tx_bytes += mbuf->pkt_len;
 488                 rte_pktmbuf_free(mbuf);
 489         }
 490
 491         txq->stats.opackets += num_tx;
 492         txq->stats.errs += nb_pkts - num_tx;
 493         txq->stats.obytes += num_tx_bytes;
 494
 495         return num_tx;
 496 }
 497
 498 static const char *
 499 tap_ioctl_req2str(unsigned long request)
 500 {
 501         switch (request) {
 502         case SIOCSIFFLAGS:
 503                 return "SIOCSIFFLAGS";
 504         case SIOCGIFFLAGS:
 505                 return "SIOCGIFFLAGS";
 506         case SIOCGIFHWADDR:
 507                 return "SIOCGIFHWADDR";
 508         case SIOCSIFHWADDR:
 509                 return "SIOCSIFHWADDR";
 510         case SIOCSIFMTU:
 511                 return "SIOCSIFMTU";
 512         }
 513         return "UNKNOWN";
 514 }
 515
 516 static int
 517 tap_ioctl(struct pmd_internals *pmd, unsigned long request,
 518           struct ifreq *ifr, int set, enum ioctl_mode mode)
 519 {
 520         short req_flags = ifr->ifr_flags;
 521         int remote = pmd->remote_if_index &&
 522                 (mode == REMOTE_ONLY || mode == LOCAL_AND_REMOTE);
 523
 524         if (!pmd->remote_if_index && mode == REMOTE_ONLY)
 525                 return 0;
 526         /*
 527          * If there is a remote netdevice, apply ioctl on it, then apply it on
 528          * the tap netdevice.
 529          */
 530 apply:
 531         if (remote)
 532                 snprintf(ifr->ifr_name, IFNAMSIZ, "%s", pmd->remote_iface);
 533         else if (mode == LOCAL_ONLY || mode == LOCAL_AND_REMOTE)
 534                 snprintf(ifr->ifr_name, IFNAMSIZ, "%s", pmd->name);
 535         switch (request) {
 536         case SIOCSIFFLAGS:
 537                 /* fetch current flags to leave other flags untouched */
 538                 if (ioctl(pmd->ioctl_sock, SIOCGIFFLAGS, ifr) < 0)
 539                         goto error;
 540                 if (set)
 541                         ifr->ifr_flags |= req_flags;
 542                 else
 543                         ifr->ifr_flags &= ~req_flags;
 544                 break;
 545         case SIOCGIFFLAGS:
 546         case SIOCGIFHWADDR:
 547         case SIOCSIFHWADDR:
 548         case SIOCSIFMTU:
 549                 break;
 550         default:
 551                 RTE_ASSERT(!"unsupported request type: must not happen");
 552         }
 553         if (ioctl(pmd->ioctl_sock, request, ifr) < 0)
 554                 goto error;
 555         if (remote-- && mode == LOCAL_AND_REMOTE)
 556                 goto apply;
 557         return 0;
 558
 559 error:
 560         RTE_LOG(DEBUG, PMD, "%s: %s(%s) failed: %s(%d)\n", ifr->ifr_name,
 561                 __func__, tap_ioctl_req2str(request), strerror(errno), errno);
 562         return -errno;
 563 }
 564
 565 static int
 566 tap_link_set_down(struct rte_eth_dev *dev)
 567 {
 568         struct pmd_internals *pmd = dev->data->dev_private;
 569         struct ifreq ifr = { .ifr_flags = IFF_UP };
 570
 571         dev->data->dev_link.link_status = ETH_LINK_DOWN;
 572         return tap_ioctl(pmd, SIOCSIFFLAGS, &ifr, 0, LOCAL_ONLY);
 573 }
 574
 575 static int
 576 tap_link_set_up(struct rte_eth_dev *dev)
 577 {
 578         struct pmd_internals *pmd = dev->data->dev_private;
 579         struct ifreq ifr = { .ifr_flags = IFF_UP };
 580
 581         dev->data->dev_link.link_status = ETH_LINK_UP;
 582         return tap_ioctl(pmd, SIOCSIFFLAGS, &ifr, 1, LOCAL_AND_REMOTE);
 583 }
 584
 585 static int
 586 tap_dev_start(struct rte_eth_dev *dev)
 587 {
 588         int err;
 589
 590         err = tap_intr_handle_set(dev, 1);
 591         if (err)
 592                 return err;
 593         return tap_link_set_up(dev);
 594 }
 595
 596 /* This function gets called when the current port gets stopped.
 597  */
 598 static void
 599 tap_dev_stop(struct rte_eth_dev *dev)
 600 {
 601         tap_intr_handle_set(dev, 0);
 602         tap_link_set_down(dev);
 603 }
 604
 605 static int
 606 tap_dev_configure(struct rte_eth_dev *dev __rte_unused)
 607 {
 608         return 0;
 609 }
 610
 611 static uint32_t
 612 tap_dev_speed_capa(void)
 613 {
 614         uint32_t speed = pmd_link.link_speed;
 615         uint32_t capa = 0;
 616
 617         if (speed >= ETH_SPEED_NUM_10M)
 618                 capa |= ETH_LINK_SPEED_10M;
 619         if (speed >= ETH_SPEED_NUM_100M)
 620                 capa |= ETH_LINK_SPEED_100M;
 621         if (speed >= ETH_SPEED_NUM_1G)
 622                 capa |= ETH_LINK_SPEED_1G;
 623         if (speed >= ETH_SPEED_NUM_5G)
 624                 capa |= ETH_LINK_SPEED_2_5G;
 625         if (speed >= ETH_SPEED_NUM_5G)
 626                 capa |= ETH_LINK_SPEED_5G;
 627         if (speed >= ETH_SPEED_NUM_10G)
 628                 capa |= ETH_LINK_SPEED_10G;
 629         if (speed >= ETH_SPEED_NUM_20G)
 630                 capa |= ETH_LINK_SPEED_20G;
 631         if (speed >= ETH_SPEED_NUM_25G)
 632                 capa |= ETH_LINK_SPEED_25G;
 633         if (speed >= ETH_SPEED_NUM_40G)
 634                 capa |= ETH_LINK_SPEED_40G;
 635         if (speed >= ETH_SPEED_NUM_50G)
 636                 capa |= ETH_LINK_SPEED_50G;
 637         if (speed >= ETH_SPEED_NUM_56G)
 638                 capa |= ETH_LINK_SPEED_56G;
 639         if (speed >= ETH_SPEED_NUM_100G)
 640                 capa |= ETH_LINK_SPEED_100G;
 641
 642         return capa;
 643 }
 644
 645 static void
 646 tap_dev_info(struct rte_eth_dev *dev, struct rte_eth_dev_info *dev_info)
 647 {
 648         struct pmd_internals *internals = dev->data->dev_private;
 649
 650         dev_info->if_index = internals->if_index;
 651         dev_info->max_mac_addrs = 1;
 652         dev_info->max_rx_pktlen = (uint32_t)ETHER_MAX_VLAN_FRAME_LEN;
 653         dev_info->max_rx_queues = internals->nb_queues;
 654         dev_info->max_tx_queues = internals->nb_queues;
 655         dev_info->min_rx_bufsize = 0;
 656         dev_info->pci_dev = NULL;
 657         dev_info->speed_capa = tap_dev_speed_capa();
 658         dev_info->rx_offload_capa = (DEV_RX_OFFLOAD_IPV4_CKSUM |
 659                                      DEV_RX_OFFLOAD_UDP_CKSUM |
 660                                      DEV_RX_OFFLOAD_TCP_CKSUM);
 661         dev_info->tx_offload_capa =
 662                 (DEV_TX_OFFLOAD_IPV4_CKSUM |
 663                  DEV_TX_OFFLOAD_UDP_CKSUM |
 664                  DEV_TX_OFFLOAD_TCP_CKSUM);
 665 }
 666
 667 static void
 668 tap_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *tap_stats)
 669 {
 670         unsigned int i, imax;
 671         unsigned long rx_total = 0, tx_total = 0, tx_err_total = 0;
 672         unsigned long rx_bytes_total = 0, tx_bytes_total = 0;
 673         unsigned long rx_nombuf = 0, ierrors = 0;
 674         const struct pmd_internals *pmd = dev->data->dev_private;
 675
 676         imax = (pmd->nb_queues < RTE_ETHDEV_QUEUE_STAT_CNTRS) ?
 677                 pmd->nb_queues : RTE_ETHDEV_QUEUE_STAT_CNTRS;
 678
 679         for (i = 0; i < imax; i++) {
 680                 tap_stats->q_ipackets[i] = pmd->rxq[i].stats.ipackets;
 681                 tap_stats->q_ibytes[i] = pmd->rxq[i].stats.ibytes;
 682                 rx_total += tap_stats->q_ipackets[i];
 683                 rx_bytes_total += tap_stats->q_ibytes[i];
 684                 rx_nombuf += pmd->rxq[i].stats.rx_nombuf;
 685                 ierrors += pmd->rxq[i].stats.ierrors;
 686
 687                 tap_stats->q_opackets[i] = pmd->txq[i].stats.opackets;
 688                 tap_stats->q_errors[i] = pmd->txq[i].stats.errs;
 689                 tap_stats->q_obytes[i] = pmd->txq[i].stats.obytes;
 690                 tx_total += tap_stats->q_opackets[i];
 691                 tx_err_total += tap_stats->q_errors[i];
 692                 tx_bytes_total += tap_stats->q_obytes[i];
 693         }
 694
 695         tap_stats->ipackets = rx_total;
 696         tap_stats->ibytes = rx_bytes_total;
 697         tap_stats->ierrors = ierrors;
 698         tap_stats->rx_nombuf = rx_nombuf;
 699         tap_stats->opackets = tx_total;
 700         tap_stats->oerrors = tx_err_total;
 701         tap_stats->obytes = tx_bytes_total;
 702 }
 703
 704 static void
 705 tap_stats_reset(struct rte_eth_dev *dev)
 706 {
 707         int i;
 708         struct pmd_internals *pmd = dev->data->dev_private;
 709
 710         for (i = 0; i < pmd->nb_queues; i++) {
 711                 pmd->rxq[i].stats.ipackets = 0;
 712                 pmd->rxq[i].stats.ibytes = 0;
 713                 pmd->rxq[i].stats.ierrors = 0;
 714                 pmd->rxq[i].stats.rx_nombuf = 0;
 715
 716                 pmd->txq[i].stats.opackets = 0;
 717                 pmd->txq[i].stats.errs = 0;
 718                 pmd->txq[i].stats.obytes = 0;
 719         }
 720 }
 721
 722 static void
 723 tap_dev_close(struct rte_eth_dev *dev)
 724 {
 725         int i;
 726         struct pmd_internals *internals = dev->data->dev_private;
 727
 728         tap_link_set_down(dev);
 729         tap_flow_flush(dev, NULL);
 730         tap_flow_implicit_flush(internals, NULL);
 731
 732         for (i = 0; i < internals->nb_queues; i++) {
 733                 if (internals->rxq[i].fd != -1)
 734                         close(internals->rxq[i].fd);
 735                 internals->rxq[i].fd = -1;
 736                 internals->txq[i].fd = -1;
 737         }
 738
 739         if (internals->remote_if_index) {
 740                 /* Restore initial remote state */
 741                 ioctl(internals->ioctl_sock, SIOCSIFFLAGS,
 742                                 &internals->remote_initial_flags);
 743         }
 744 }
 745
 746 static void
 747 tap_rx_queue_release(void *queue)
 748 {
 749         struct rx_queue *rxq = queue;
 750
 751         if (rxq && (rxq->fd > 0)) {
 752                 close(rxq->fd);
 753                 rxq->fd = -1;
 754                 rte_pktmbuf_free(rxq->pool);
 755                 rte_free(rxq->iovecs);
 756                 rxq->pool = NULL;
 757                 rxq->iovecs = NULL;
 758         }
 759 }
 760
 761 static void
 762 tap_tx_queue_release(void *queue)
 763 {
 764         struct tx_queue *txq = queue;
 765
 766         if (txq && (txq->fd > 0)) {
 767                 close(txq->fd);
 768                 txq->fd = -1;
 769         }
 770 }
 771
 772 static int
 773 tap_link_update(struct rte_eth_dev *dev, int wait_to_complete __rte_unused)
 774 {
 775         struct rte_eth_link *dev_link = &dev->data->dev_link;
 776         struct pmd_internals *pmd = dev->data->dev_private;
 777         struct ifreq ifr = { .ifr_flags = 0 };
 778
 779         if (pmd->remote_if_index) {
 780                 tap_ioctl(pmd, SIOCGIFFLAGS, &ifr, 0, REMOTE_ONLY);
 781                 if (!(ifr.ifr_flags & IFF_UP) ||
 782                     !(ifr.ifr_flags & IFF_RUNNING)) {
 783                         dev_link->link_status = ETH_LINK_DOWN;
 784                         return 0;
 785                 }
 786         }
 787         tap_ioctl(pmd, SIOCGIFFLAGS, &ifr, 0, LOCAL_ONLY);
 788         dev_link->link_status =
 789                 ((ifr.ifr_flags & IFF_UP) && (ifr.ifr_flags & IFF_RUNNING) ?
 790                  ETH_LINK_UP :
 791                  ETH_LINK_DOWN);
 792         return 0;
 793 }
 794
 795 static void
 796 tap_promisc_enable(struct rte_eth_dev *dev)
 797 {
 798         struct pmd_internals *pmd = dev->data->dev_private;
 799         struct ifreq ifr = { .ifr_flags = IFF_PROMISC };
 800
 801         dev->data->promiscuous = 1;
 802         tap_ioctl(pmd, SIOCSIFFLAGS, &ifr, 1, LOCAL_AND_REMOTE);
 803         if (pmd->remote_if_index && !pmd->flow_isolate)
 804                 tap_flow_implicit_create(pmd, TAP_REMOTE_PROMISC);
 805 }
 806
 807 static void
 808 tap_promisc_disable(struct rte_eth_dev *dev)
 809 {
 810         struct pmd_internals *pmd = dev->data->dev_private;
 811         struct ifreq ifr = { .ifr_flags = IFF_PROMISC };
 812
 813         dev->data->promiscuous = 0;
 814         tap_ioctl(pmd, SIOCSIFFLAGS, &ifr, 0, LOCAL_AND_REMOTE);
 815         if (pmd->remote_if_index && !pmd->flow_isolate)
 816                 tap_flow_implicit_destroy(pmd, TAP_REMOTE_PROMISC);
 817 }
 818
 819 static void
 820 tap_allmulti_enable(struct rte_eth_dev *dev)
 821 {
 822         struct pmd_internals *pmd = dev->data->dev_private;
 823         struct ifreq ifr = { .ifr_flags = IFF_ALLMULTI };
 824
 825         dev->data->all_multicast = 1;
 826         tap_ioctl(pmd, SIOCSIFFLAGS, &ifr, 1, LOCAL_AND_REMOTE);
 827         if (pmd->remote_if_index && !pmd->flow_isolate)
 828                 tap_flow_implicit_create(pmd, TAP_REMOTE_ALLMULTI);
 829 }
 830
 831 static void
 832 tap_allmulti_disable(struct rte_eth_dev *dev)
 833 {
 834         struct pmd_internals *pmd = dev->data->dev_private;
 835         struct ifreq ifr = { .ifr_flags = IFF_ALLMULTI };
 836
 837         dev->data->all_multicast = 0;
 838         tap_ioctl(pmd, SIOCSIFFLAGS, &ifr, 0, LOCAL_AND_REMOTE);
 839         if (pmd->remote_if_index && !pmd->flow_isolate)
 840                 tap_flow_implicit_destroy(pmd, TAP_REMOTE_ALLMULTI);
 841 }
 842
 843 static void
 844 tap_mac_set(struct rte_eth_dev *dev, struct ether_addr *mac_addr)
 845 {
 846         struct pmd_internals *pmd = dev->data->dev_private;
 847         enum ioctl_mode mode = LOCAL_ONLY;
 848         struct ifreq ifr;
 849
 850         if (is_zero_ether_addr(mac_addr)) {
 851                 RTE_LOG(ERR, PMD, "%s: can't set an empty MAC address\n",
 852                         dev->device->name);
 853                 return;
 854         }
 855         /* Check the actual current MAC address on the tap netdevice */
 856         if (tap_ioctl(pmd, SIOCGIFHWADDR, &ifr, 0, LOCAL_ONLY) < 0)
 857                 return;
 858         if (is_same_ether_addr((struct ether_addr *)&ifr.ifr_hwaddr.sa_data,
 859                                mac_addr))
 860                 return;
 861         /* Check the current MAC address on the remote */
 862         if (tap_ioctl(pmd, SIOCGIFHWADDR, &ifr, 0, REMOTE_ONLY) < 0)
 863                 return;
 864         if (!is_same_ether_addr((struct ether_addr *)&ifr.ifr_hwaddr.sa_data,
 865                                mac_addr))
 866                 mode = LOCAL_AND_REMOTE;
 867         ifr.ifr_hwaddr.sa_family = AF_LOCAL;
 868         rte_memcpy(ifr.ifr_hwaddr.sa_data, mac_addr, ETHER_ADDR_LEN);
 869         if (tap_ioctl(pmd, SIOCSIFHWADDR, &ifr, 1, mode) < 0)
 870                 return;
 871         rte_memcpy(&pmd->eth_addr, mac_addr, ETHER_ADDR_LEN);
 872         if (pmd->remote_if_index && !pmd->flow_isolate) {
 873                 /* Replace MAC redirection rule after a MAC change */
 874                 if (tap_flow_implicit_destroy(pmd, TAP_REMOTE_LOCAL_MAC) < 0) {
 875                         RTE_LOG(ERR, PMD,
 876                                 "%s: Couldn't delete MAC redirection rule\n",
 877                                 dev->device->name);
 878                         return;
 879                 }
 880                 if (tap_flow_implicit_create(pmd, TAP_REMOTE_LOCAL_MAC) < 0)
 881                         RTE_LOG(ERR, PMD,
 882                                 "%s: Couldn't add MAC redirection rule\n",
 883                                 dev->device->name);
 884         }
 885 }
 886
 887 static int
 888 tap_setup_queue(struct rte_eth_dev *dev,
 889                 struct pmd_internals *internals,
 890                 uint16_t qid)
 891 {
 892         struct pmd_internals *pmd = dev->data->dev_private;
 893         struct rx_queue *rx = &internals->rxq[qid];
 894         struct tx_queue *tx = &internals->txq[qid];
 895         int fd = rx->fd == -1 ? tx->fd : rx->fd;
 896
 897         if (fd == -1) {
 898                 RTE_LOG(INFO, PMD, "Add queue to TAP %s for qid %d\n",
 899                         pmd->name, qid);
 900                 fd = tun_alloc(pmd);
 901                 if (fd < 0) {
 902                         RTE_LOG(ERR, PMD, "%s: tun_alloc() failed.\n",
 903                                 pmd->name);
 904                         return -1;
 905                 }
 906         }
 907
 908         rx->fd = fd;
 909         tx->fd = fd;
 910         tx->mtu = &dev->data->mtu;
 911         rx->rxmode = &dev->data->dev_conf.rxmode;
 912
 913         return fd;
 914 }
 915
 916 static int
 917 tap_rx_queue_setup(struct rte_eth_dev *dev,
 918                    uint16_t rx_queue_id,
 919                    uint16_t nb_rx_desc,
 920                    unsigned int socket_id,
 921                    const struct rte_eth_rxconf *rx_conf __rte_unused,
 922                    struct rte_mempool *mp)
 923 {
 924         struct pmd_internals *internals = dev->data->dev_private;
 925         struct rx_queue *rxq = &internals->rxq[rx_queue_id];
 926         struct rte_mbuf **tmp = &rxq->pool;
 927         long iov_max = sysconf(_SC_IOV_MAX);
 928         uint16_t nb_desc = RTE_MIN(nb_rx_desc, iov_max - 1);
 929         struct iovec (*iovecs)[nb_desc + 1];
 930         int data_off = RTE_PKTMBUF_HEADROOM;
 931         int ret = 0;
 932         int fd;
 933         int i;
 934
 935         if ((rx_queue_id >= internals->nb_queues) || !mp) {
 936                 RTE_LOG(WARNING, PMD,
 937                         "nb_queues %d too small or mempool NULL\n",
 938                         internals->nb_queues);
 939                 return -1;
 940         }
 941
 942         rxq->mp = mp;
 943         rxq->trigger_seen = 1; /* force initial burst */
 944         rxq->in_port = dev->data->port_id;
 945         rxq->nb_rx_desc = nb_desc;
 946         iovecs = rte_zmalloc_socket(dev->device->name, sizeof(*iovecs), 0,
 947                                     socket_id);
 948         if (!iovecs) {
 949                 RTE_LOG(WARNING, PMD,
 950                         "%s: Couldn't allocate %d RX descriptors\n",
 951                         dev->device->name, nb_desc);
 952                 return -ENOMEM;
 953         }
 954         rxq->iovecs = iovecs;
 955
 956         dev->data->rx_queues[rx_queue_id] = rxq;
 957         fd = tap_setup_queue(dev, internals, rx_queue_id);
 958         if (fd == -1) {
 959                 ret = fd;
 960                 goto error;
 961         }
 962
 963         (*rxq->iovecs)[0].iov_len = sizeof(struct tun_pi);
 964         (*rxq->iovecs)[0].iov_base = &rxq->pi;
 965
 966         for (i = 1; i <= nb_desc; i++) {
 967                 *tmp = rte_pktmbuf_alloc(rxq->mp);
 968                 if (!*tmp) {
 969                         RTE_LOG(WARNING, PMD,
 970                                 "%s: couldn't allocate memory for queue %d\n",
 971                                 dev->device->name, rx_queue_id);
 972                         ret = -ENOMEM;
 973                         goto error;
 974                 }
 975                 (*rxq->iovecs)[i].iov_len = (*tmp)->buf_len - data_off;
 976                 (*rxq->iovecs)[i].iov_base =
 977                         (char *)(*tmp)->buf_addr + data_off;
 978                 data_off = 0;
 979                 tmp = &(*tmp)->next;
 980         }
 981
 982         RTE_LOG(DEBUG, PMD, "  RX TAP device name %s, qid %d on fd %d\n",
 983                 internals->name, rx_queue_id, internals->rxq[rx_queue_id].fd);
 984
 985         return 0;
 986
 987 error:
 988         rte_pktmbuf_free(rxq->pool);
 989         rxq->pool = NULL;
 990         rte_free(rxq->iovecs);
 991         rxq->iovecs = NULL;
 992         return ret;
 993 }
 994
 995 static int
 996 tap_tx_queue_setup(struct rte_eth_dev *dev,
 997                    uint16_t tx_queue_id,
 998                    uint16_t nb_tx_desc __rte_unused,
 999                    unsigned int socket_id __rte_unused,
1000                    const struct rte_eth_txconf *tx_conf __rte_unused)
1001 {
1002         struct pmd_internals *internals = dev->data->dev_private;
1003         int ret;
1004
1005         if (tx_queue_id >= internals->nb_queues)
1006                 return -1;
1007
1008         dev->data->tx_queues[tx_queue_id] = &internals->txq[tx_queue_id];
1009         ret = tap_setup_queue(dev, internals, tx_queue_id);
1010         if (ret == -1)
1011                 return -1;
1012
1013         RTE_LOG(DEBUG, PMD, "  TX TAP device name %s, qid %d on fd %d\n",
1014                 internals->name, tx_queue_id, internals->txq[tx_queue_id].fd);
1015
1016         return 0;
1017 }
1018
1019 static int
1020 tap_mtu_set(struct rte_eth_dev *dev, uint16_t mtu)
1021 {
1022         struct pmd_internals *pmd = dev->data->dev_private;
1023         struct ifreq ifr = { .ifr_mtu = mtu };
1024         int err = 0;
1025
1026         err = tap_ioctl(pmd, SIOCSIFMTU, &ifr, 1, LOCAL_AND_REMOTE);
1027         if (!err)
1028                 dev->data->mtu = mtu;
1029
1030         return err;
1031 }
1032
1033 static int
1034 tap_set_mc_addr_list(struct rte_eth_dev *dev __rte_unused,
1035                      struct ether_addr *mc_addr_set __rte_unused,
1036                      uint32_t nb_mc_addr __rte_unused)
1037 {
1038         /*
1039          * Nothing to do actually: the tap has no filtering whatsoever, every
1040          * packet is received.
1041          */
1042         return 0;
1043 }
1044
1045 static int
1046 tap_nl_msg_handler(struct nlmsghdr *nh, void *arg)
1047 {
1048         struct rte_eth_dev *dev = arg;
1049         struct pmd_internals *pmd = dev->data->dev_private;
1050         struct ifinfomsg *info = NLMSG_DATA(nh);
1051
1052         if (nh->nlmsg_type != RTM_NEWLINK ||
1053             (info->ifi_index != pmd->if_index &&
1054              info->ifi_index != pmd->remote_if_index))
1055                 return 0;
1056         return tap_link_update(dev, 0);
1057 }
1058
1059 static void
1060 tap_dev_intr_handler(void *cb_arg)
1061 {
1062         struct rte_eth_dev *dev = cb_arg;
1063         struct pmd_internals *pmd = dev->data->dev_private;
1064
1065         nl_recv(pmd->intr_handle.fd, tap_nl_msg_handler, dev);
1066 }
1067
1068 static int
1069 tap_intr_handle_set(struct rte_eth_dev *dev, int set)
1070 {
1071         struct pmd_internals *pmd = dev->data->dev_private;
1072
1073         /* In any case, disable interrupt if the conf is no longer there. */
1074         if (!dev->data->dev_conf.intr_conf.lsc) {
1075                 if (pmd->intr_handle.fd != -1)
1076                         nl_final(pmd->intr_handle.fd);
1077                 rte_intr_callback_unregister(
1078                         &pmd->intr_handle, tap_dev_intr_handler, dev);
1079                 return 0;
1080         }
1081         if (set) {
1082                 pmd->intr_handle.fd = nl_init(RTMGRP_LINK);
1083                 if (unlikely(pmd->intr_handle.fd == -1))
1084                         return -EBADF;
1085                 return rte_intr_callback_register(
1086                         &pmd->intr_handle, tap_dev_intr_handler, dev);
1087         }
1088         nl_final(pmd->intr_handle.fd);
1089         return rte_intr_callback_unregister(&pmd->intr_handle,
1090                                             tap_dev_intr_handler, dev);
1091 }
1092
1093 static const uint32_t*
1094 tap_dev_supported_ptypes_get(struct rte_eth_dev *dev __rte_unused)
1095 {
1096         static const uint32_t ptypes[] = {
1097                 RTE_PTYPE_INNER_L2_ETHER,
1098                 RTE_PTYPE_INNER_L2_ETHER_VLAN,
1099                 RTE_PTYPE_INNER_L2_ETHER_QINQ,
1100                 RTE_PTYPE_INNER_L3_IPV4,
1101                 RTE_PTYPE_INNER_L3_IPV4_EXT,
1102                 RTE_PTYPE_INNER_L3_IPV6,
1103                 RTE_PTYPE_INNER_L3_IPV6_EXT,
1104                 RTE_PTYPE_INNER_L4_FRAG,
1105                 RTE_PTYPE_INNER_L4_UDP,
1106                 RTE_PTYPE_INNER_L4_TCP,
1107                 RTE_PTYPE_INNER_L4_SCTP,
1108                 RTE_PTYPE_L2_ETHER,
1109                 RTE_PTYPE_L2_ETHER_VLAN,
1110                 RTE_PTYPE_L2_ETHER_QINQ,
1111                 RTE_PTYPE_L3_IPV4,
1112                 RTE_PTYPE_L3_IPV4_EXT,
1113                 RTE_PTYPE_L3_IPV6_EXT,
1114                 RTE_PTYPE_L3_IPV6,
1115                 RTE_PTYPE_L4_FRAG,
1116                 RTE_PTYPE_L4_UDP,
1117                 RTE_PTYPE_L4_TCP,
1118                 RTE_PTYPE_L4_SCTP,
1119         };
1120
1121         return ptypes;
1122 }
1123
1124 static int
1125 tap_flow_ctrl_get(struct rte_eth_dev *dev __rte_unused,
1126                   struct rte_eth_fc_conf *fc_conf)
1127 {
1128         fc_conf->mode = RTE_FC_NONE;
1129         return 0;
1130 }
1131
1132 static int
1133 tap_flow_ctrl_set(struct rte_eth_dev *dev __rte_unused,
1134                   struct rte_eth_fc_conf *fc_conf)
1135 {
1136         if (fc_conf->mode != RTE_FC_NONE)
1137                 return -ENOTSUP;
1138         return 0;
1139 }
1140
1141 static const struct eth_dev_ops ops = {
1142         .dev_start              = tap_dev_start,
1143         .dev_stop               = tap_dev_stop,
1144         .dev_close              = tap_dev_close,
1145         .dev_configure          = tap_dev_configure,
1146         .dev_infos_get          = tap_dev_info,
1147         .rx_queue_setup         = tap_rx_queue_setup,
1148         .tx_queue_setup         = tap_tx_queue_setup,
1149         .rx_queue_release       = tap_rx_queue_release,
1150         .tx_queue_release       = tap_tx_queue_release,
1151         .flow_ctrl_get          = tap_flow_ctrl_get,
1152         .flow_ctrl_set          = tap_flow_ctrl_set,
1153         .link_update            = tap_link_update,
1154         .dev_set_link_up        = tap_link_set_up,
1155         .dev_set_link_down      = tap_link_set_down,
1156         .promiscuous_enable     = tap_promisc_enable,
1157         .promiscuous_disable    = tap_promisc_disable,
1158         .allmulticast_enable    = tap_allmulti_enable,
1159         .allmulticast_disable   = tap_allmulti_disable,
1160         .mac_addr_set           = tap_mac_set,
1161         .mtu_set                = tap_mtu_set,
1162         .set_mc_addr_list       = tap_set_mc_addr_list,
1163         .stats_get              = tap_stats_get,
1164         .stats_reset            = tap_stats_reset,
1165         .dev_supported_ptypes_get = tap_dev_supported_ptypes_get,
1166         .filter_ctrl            = tap_dev_filter_ctrl,
1167 };
1168
1169
1170 static int
1171 eth_dev_tap_create(struct rte_vdev_device *vdev, char *tap_name,
1172                    char *remote_iface, int fixed_mac_type)
1173 {
1174         int numa_node = rte_socket_id();
1175         struct rte_eth_dev *dev;
1176         struct pmd_internals *pmd;
1177         struct rte_eth_dev_data *data;
1178         struct ifreq ifr;
1179         int i;
1180
1181         RTE_LOG(DEBUG, PMD, "  TAP device on numa %u\n", rte_socket_id());
1182
1183         data = rte_zmalloc_socket(tap_name, sizeof(*data), 0, numa_node);
1184         if (!data) {
1185                 RTE_LOG(ERR, PMD, "TAP Failed to allocate data\n");
1186                 goto error_exit;
1187         }
1188
1189         dev = rte_eth_vdev_allocate(vdev, sizeof(*pmd));
1190         if (!dev) {
1191                 RTE_LOG(ERR, PMD, "TAP Unable to allocate device struct\n");
1192                 goto error_exit;
1193         }
1194
1195         pmd = dev->data->dev_private;
1196         snprintf(pmd->name, sizeof(pmd->name), "%s", tap_name);
1197         pmd->nb_queues = RTE_PMD_TAP_MAX_QUEUES;
1198
1199         pmd->ioctl_sock = socket(AF_INET, SOCK_DGRAM, 0);
1200         if (pmd->ioctl_sock == -1) {
1201                 RTE_LOG(ERR, PMD,
1202                         "TAP Unable to get a socket for management: %s\n",
1203                         strerror(errno));
1204                 goto error_exit;
1205         }
1206
1207         /* Setup some default values */
1208         rte_memcpy(data, dev->data, sizeof(*data));
1209         data->dev_private = pmd;
1210         data->dev_flags = RTE_ETH_DEV_DETACHABLE | RTE_ETH_DEV_INTR_LSC;
1211         data->numa_node = numa_node;
1212
1213         data->dev_link = pmd_link;
1214         data->mac_addrs = &pmd->eth_addr;
1215         data->nb_rx_queues = pmd->nb_queues;
1216         data->nb_tx_queues = pmd->nb_queues;
1217
1218         dev->data = data;
1219         dev->dev_ops = &ops;
1220         dev->rx_pkt_burst = pmd_rx_burst;
1221         dev->tx_pkt_burst = pmd_tx_burst;
1222
1223         pmd->intr_handle.type = RTE_INTR_HANDLE_EXT;
1224         pmd->intr_handle.fd = -1;
1225
1226         /* Presetup the fds to -1 as being not valid */
1227         for (i = 0; i < RTE_PMD_TAP_MAX_QUEUES; i++) {
1228                 pmd->rxq[i].fd = -1;
1229                 pmd->txq[i].fd = -1;
1230         }
1231
1232         if (fixed_mac_type) {
1233                 /* fixed mac = 00:64:74:61:70:<iface_idx> */
1234                 static int iface_idx;
1235                 char mac[ETHER_ADDR_LEN] = "\0dtap";
1236
1237                 mac[ETHER_ADDR_LEN - 1] = iface_idx++;
1238                 rte_memcpy(&pmd->eth_addr, mac, ETHER_ADDR_LEN);
1239         } else {
1240                 eth_random_addr((uint8_t *)&pmd->eth_addr);
1241         }
1242
1243         /* Immediately create the netdevice (this will create the 1st queue). */
1244         if (tap_setup_queue(dev, pmd, 0) == -1)
1245                 goto error_exit;
1246
1247         ifr.ifr_mtu = dev->data->mtu;
1248         if (tap_ioctl(pmd, SIOCSIFMTU, &ifr, 1, LOCAL_AND_REMOTE) < 0)
1249                 goto error_exit;
1250
1251         memset(&ifr, 0, sizeof(struct ifreq));
1252         ifr.ifr_hwaddr.sa_family = AF_LOCAL;
1253         rte_memcpy(ifr.ifr_hwaddr.sa_data, &pmd->eth_addr, ETHER_ADDR_LEN);
1254         if (tap_ioctl(pmd, SIOCSIFHWADDR, &ifr, 0, LOCAL_ONLY) < 0)
1255                 goto error_exit;
1256
1257         /*
1258          * Set up everything related to rte_flow:
1259          * - netlink socket
1260          * - tap / remote if_index
1261          * - mandatory QDISCs
1262          * - rte_flow actual/implicit lists
1263          * - implicit rules
1264          */
1265         pmd->nlsk_fd = nl_init(0);
1266         if (pmd->nlsk_fd == -1) {
1267                 RTE_LOG(WARNING, PMD, "%s: failed to create netlink socket.\n",
1268                         pmd->name);
1269                 goto disable_rte_flow;
1270         }
1271         pmd->if_index = if_nametoindex(pmd->name);
1272         if (!pmd->if_index) {
1273                 RTE_LOG(ERR, PMD, "%s: failed to get if_index.\n", pmd->name);
1274                 goto disable_rte_flow;
1275         }
1276         if (qdisc_create_multiq(pmd->nlsk_fd, pmd->if_index) < 0) {
1277                 RTE_LOG(ERR, PMD, "%s: failed to create multiq qdisc.\n",
1278                         pmd->name);
1279                 goto disable_rte_flow;
1280         }
1281         if (qdisc_create_ingress(pmd->nlsk_fd, pmd->if_index) < 0) {
1282                 RTE_LOG(ERR, PMD, "%s: failed to create ingress qdisc.\n",
1283                         pmd->name);
1284                 goto disable_rte_flow;
1285         }
1286         LIST_INIT(&pmd->flows);
1287
1288         if (strlen(remote_iface)) {
1289                 pmd->remote_if_index = if_nametoindex(remote_iface);
1290                 if (!pmd->remote_if_index) {
1291                         RTE_LOG(ERR, PMD, "%s: failed to get %s if_index.\n",
1292                                 pmd->name, remote_iface);
1293                         goto error_remote;
1294                 }
1295                 snprintf(pmd->remote_iface, RTE_ETH_NAME_MAX_LEN,
1296                          "%s", remote_iface);
1297
1298                 /* Save state of remote device */
1299                 tap_ioctl(pmd, SIOCGIFFLAGS, &pmd->remote_initial_flags, 0, REMOTE_ONLY);
1300
1301                 /* Replicate remote MAC address */
1302                 if (tap_ioctl(pmd, SIOCGIFHWADDR, &ifr, 0, REMOTE_ONLY) < 0) {
1303                         RTE_LOG(ERR, PMD, "%s: failed to get %s MAC address.\n",
1304                                 pmd->name, pmd->remote_iface);
1305                         goto error_remote;
1306                 }
1307                 rte_memcpy(&pmd->eth_addr, ifr.ifr_hwaddr.sa_data,
1308                            ETHER_ADDR_LEN);
1309                 /* The desired MAC is already in ifreq after SIOCGIFHWADDR. */
1310                 if (tap_ioctl(pmd, SIOCSIFHWADDR, &ifr, 0, LOCAL_ONLY) < 0) {
1311                         RTE_LOG(ERR, PMD, "%s: failed to get %s MAC address.\n",
1312                                 pmd->name, remote_iface);
1313                         goto error_remote;
1314                 }
1315
1316                 /*
1317                  * Flush usually returns negative value because it tries to
1318                  * delete every QDISC (and on a running device, one QDISC at
1319                  * least is needed). Ignore negative return value.
1320                  */
1321                 qdisc_flush(pmd->nlsk_fd, pmd->remote_if_index);
1322                 if (qdisc_create_ingress(pmd->nlsk_fd,
1323                                          pmd->remote_if_index) < 0) {
1324                         RTE_LOG(ERR, PMD, "%s: failed to create ingress qdisc.\n",
1325                                 pmd->remote_iface);
1326                         goto error_remote;
1327                 }
1328                 LIST_INIT(&pmd->implicit_flows);
1329                 if (tap_flow_implicit_create(pmd, TAP_REMOTE_TX) < 0 ||
1330                     tap_flow_implicit_create(pmd, TAP_REMOTE_LOCAL_MAC) < 0 ||
1331                     tap_flow_implicit_create(pmd, TAP_REMOTE_BROADCAST) < 0 ||
1332                     tap_flow_implicit_create(pmd, TAP_REMOTE_BROADCASTV6) < 0) {
1333                         RTE_LOG(ERR, PMD,
1334                                 "%s: failed to create implicit rules.\n",
1335                                 pmd->name);
1336                         goto error_remote;
1337                 }
1338         }
1339
1340         return 0;
1341
1342 disable_rte_flow:
1343         RTE_LOG(ERR, PMD, " Disabling rte flow support: %s(%d)\n",
1344                 strerror(errno), errno);
1345         if (strlen(remote_iface)) {
1346                 RTE_LOG(ERR, PMD, "Remote feature requires flow support.\n");
1347                 goto error_exit;
1348         }
1349         return 0;
1350
1351 error_remote:
1352         RTE_LOG(ERR, PMD, " Can't set up remote feature: %s(%d)\n",
1353                 strerror(errno), errno);
1354         tap_flow_implicit_flush(pmd, NULL);
1355
1356 error_exit:
1357         RTE_LOG(ERR, PMD, "TAP Unable to initialize %s\n",
1358                 rte_vdev_device_name(vdev));
1359
1360         rte_free(data);
1361         return -EINVAL;
1362 }
1363
1364 static int
1365 set_interface_name(const char *key __rte_unused,
1366                    const char *value,
1367                    void *extra_args)
1368 {
1369         char *name = (char *)extra_args;
1370
1371         if (value)
1372                 snprintf(name, RTE_ETH_NAME_MAX_LEN - 1, "%s", value);
1373         else
1374                 snprintf(name, RTE_ETH_NAME_MAX_LEN - 1, "%s%d",
1375                          DEFAULT_TAP_NAME, (tap_unit - 1));
1376
1377         return 0;
1378 }
1379
1380 static int
1381 set_interface_speed(const char *key __rte_unused,
1382                     const char *value,
1383                     void *extra_args)
1384 {
1385         *(int *)extra_args = (value) ? atoi(value) : ETH_SPEED_NUM_10G;
1386
1387         return 0;
1388 }
1389
1390 static int
1391 set_remote_iface(const char *key __rte_unused,
1392                  const char *value,
1393                  void *extra_args)
1394 {
1395         char *name = (char *)extra_args;
1396
1397         if (value)
1398                 snprintf(name, RTE_ETH_NAME_MAX_LEN, "%s", value);
1399
1400         return 0;
1401 }
1402
1403 static int
1404 set_mac_type(const char *key __rte_unused,
1405              const char *value,
1406              void *extra_args)
1407 {
1408         if (value &&
1409             !strncasecmp(ETH_TAP_MAC_FIXED, value, strlen(ETH_TAP_MAC_FIXED)))
1410                 *(int *)extra_args = 1;
1411         return 0;
1412 }
1413
1414 /* Open a TAP interface device.
1415  */
1416 static int
1417 rte_pmd_tap_probe(struct rte_vdev_device *dev)
1418 {
1419         const char *name, *params;
1420         int ret;
1421         struct rte_kvargs *kvlist = NULL;
1422         int speed;
1423         char tap_name[RTE_ETH_NAME_MAX_LEN];
1424         char remote_iface[RTE_ETH_NAME_MAX_LEN];
1425         int fixed_mac_type = 0;
1426
1427         name = rte_vdev_device_name(dev);
1428         params = rte_vdev_device_args(dev);
1429
1430         speed = ETH_SPEED_NUM_10G;
1431         snprintf(tap_name, sizeof(tap_name), "%s%d",
1432                  DEFAULT_TAP_NAME, tap_unit++);
1433         memset(remote_iface, 0, RTE_ETH_NAME_MAX_LEN);
1434
1435         if (params && (params[0] != '\0')) {
1436                 RTE_LOG(DEBUG, PMD, "parameters (%s)\n", params);
1437
1438                 kvlist = rte_kvargs_parse(params, valid_arguments);
1439                 if (kvlist) {
1440                         if (rte_kvargs_count(kvlist, ETH_TAP_SPEED_ARG) == 1) {
1441                                 ret = rte_kvargs_process(kvlist,
1442                                                          ETH_TAP_SPEED_ARG,
1443                                                          &set_interface_speed,
1444                                                          &speed);
1445                                 if (ret == -1)
1446                                         goto leave;
1447                         }
1448
1449                         if (rte_kvargs_count(kvlist, ETH_TAP_IFACE_ARG) == 1) {
1450                                 ret = rte_kvargs_process(kvlist,
1451                                                          ETH_TAP_IFACE_ARG,
1452                                                          &set_interface_name,
1453                                                          tap_name);
1454                                 if (ret == -1)
1455                                         goto leave;
1456                         }
1457
1458                         if (rte_kvargs_count(kvlist, ETH_TAP_REMOTE_ARG) == 1) {
1459                                 ret = rte_kvargs_process(kvlist,
1460                                                          ETH_TAP_REMOTE_ARG,
1461                                                          &set_remote_iface,
1462                                                          remote_iface);
1463                                 if (ret == -1)
1464                                         goto leave;
1465                         }
1466
1467                         if (rte_kvargs_count(kvlist, ETH_TAP_MAC_ARG) == 1) {
1468                                 ret = rte_kvargs_process(kvlist,
1469                                                          ETH_TAP_MAC_ARG,
1470                                                          &set_mac_type,
1471                                                          &fixed_mac_type);
1472                                 if (ret == -1)
1473                                         goto leave;
1474                         }
1475                 }
1476         }
1477         pmd_link.link_speed = speed;
1478
1479         RTE_LOG(NOTICE, PMD, "Initializing pmd_tap for %s as %s\n",
1480                 name, tap_name);
1481
1482         ret = eth_dev_tap_create(dev, tap_name, remote_iface, fixed_mac_type);
1483
1484 leave:
1485         if (ret == -1) {
1486                 RTE_LOG(ERR, PMD, "Failed to create pmd for %s as %s\n",
1487                         name, tap_name);
1488                 tap_unit--;             /* Restore the unit number */
1489         }
1490         rte_kvargs_free(kvlist);
1491
1492         return ret;
1493 }
1494
1495 /* detach a TAP device.
1496  */
1497 static int
1498 rte_pmd_tap_remove(struct rte_vdev_device *dev)
1499 {
1500         struct rte_eth_dev *eth_dev = NULL;
1501         struct pmd_internals *internals;
1502         int i;
1503
1504         RTE_LOG(DEBUG, PMD, "Closing TUN/TAP Ethernet device on numa %u\n",
1505                 rte_socket_id());
1506
1507         /* find the ethdev entry */
1508         eth_dev = rte_eth_dev_allocated(rte_vdev_device_name(dev));
1509         if (!eth_dev)
1510                 return 0;
1511
1512         internals = eth_dev->data->dev_private;
1513         if (internals->nlsk_fd) {
1514                 tap_flow_flush(eth_dev, NULL);
1515                 tap_flow_implicit_flush(internals, NULL);
1516                 nl_final(internals->nlsk_fd);
1517         }
1518         for (i = 0; i < internals->nb_queues; i++)
1519                 if (internals->rxq[i].fd != -1)
1520                         close(internals->rxq[i].fd);
1521
1522         close(internals->ioctl_sock);
1523         rte_free(eth_dev->data->dev_private);
1524         rte_free(eth_dev->data);
1525
1526         rte_eth_dev_release_port(eth_dev);
1527
1528         return 0;
1529 }
1530
1531 static struct rte_vdev_driver pmd_tap_drv = {
1532         .probe = rte_pmd_tap_probe,
1533         .remove = rte_pmd_tap_remove,
1534 };
1535 RTE_PMD_REGISTER_VDEV(net_tap, pmd_tap_drv);
1536 RTE_PMD_REGISTER_ALIAS(net_tap, eth_tap);
1537 RTE_PMD_REGISTER_PARAM_STRING(net_tap,
1538                               ETH_TAP_IFACE_ARG "=<string> "
1539                               ETH_TAP_SPEED_ARG "=<int> "
1540                               ETH_TAP_MAC_ARG "=" ETH_TAP_MAC_FIXED " "
1541                               ETH_TAP_REMOTE_ARG "=<string>");