src/vnet/devices/tap/tap.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #define _GNU_SOURCE
  19 #include <sys/types.h>
  20 #include <sys/stat.h>
  21 #include <sys/socket.h>
  22 #include <fcntl.h>
  23 #include <net/if.h>
  24 #include <linux/if_tun.h>
  25 #include <sys/ioctl.h>
  26 #include <linux/ethtool.h>
  27 #include <linux/sockios.h>
  28 #include <sys/eventfd.h>
  29 #include <net/if_arp.h>
  30 #include <limits.h>
  31
  32 #include <linux/netlink.h>
  33 #include <linux/rtnetlink.h>
  34
  35 #include <vlib/vlib.h>
  36 #include <vlib/physmem.h>
  37 #include <vlib/unix/unix.h>
  38 #include <vppinfra/linux/netns.h>
  39 #include <vnet/ethernet/ethernet.h>
  40 #include <vnet/ip/ip4_packet.h>
  41 #include <vnet/ip/ip6_packet.h>
  42 #include <vnet/devices/netlink.h>
  43 #include <vnet/devices/virtio/virtio.h>
  44 #include <vnet/devices/tap/tap.h>
  45
  46 tap_main_t tap_main;
  47
  48 #define tap_log_err(dev, f, ...)                        \
  49   vlib_log (VLIB_LOG_LEVEL_ERR, tap_main.log_default, "tap%u: " f, dev->dev_instance, ## __VA_ARGS__)
  50 #define tap_log_dbg(dev, f, ...)                        \
  51   vlib_log (VLIB_LOG_LEVEL_DEBUG, tap_main.log_default, "tap%u: " f, dev->dev_instance, ## __VA_ARGS__)
  52
  53 #define _IOCTL(fd,a,...) \
  54   if (ioctl (fd, a, __VA_ARGS__) < 0) \
  55     { \
  56       err = clib_error_return_unix (0, "ioctl(" #a ")"); \
  57       tap_log_err (vif, "%U", format_clib_error, err); \
  58       goto error; \
  59     }
  60
  61   /* *INDENT-OFF* */
  62 VNET_HW_INTERFACE_CLASS (tun_device_hw_interface_class, static) =
  63 {
  64   .name = "tun-device",
  65   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
  66 };
  67   /* *INDENT-ON* */
  68
  69 #define TUN_MAX_PACKET_BYTES     65355
  70 #define TUN_MIN_PACKET_BYTES     64
  71 #define TUN_DEFAULT_PACKET_BYTES 1500
  72
  73 static u32
  74 virtio_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
  75                         u32 flags)
  76 {
  77   /* nothing for now */
  78   //TODO On MTU change call vnet_netlink_set_if_mtu
  79   return 0;
  80 }
  81
  82 #define TAP_MAX_INSTANCE 1024
  83
  84 static void
  85 tap_free (vlib_main_t * vm, virtio_if_t * vif)
  86 {
  87   virtio_main_t *mm = &virtio_main;
  88   tap_main_t *tm = &tap_main;
  89   clib_error_t *err = 0;
  90   int i;
  91
  92   /* *INDENT-OFF* */
  93   vec_foreach_index (i, vif->vhost_fds) if (vif->vhost_fds[i] != -1)
  94     close (vif->vhost_fds[i]);
  95   vec_foreach_index (i, vif->rxq_vrings)
  96     virtio_vring_free_rx (vm, vif, RX_QUEUE (i));
  97   vec_foreach_index (i, vif->txq_vrings)
  98     virtio_vring_free_tx (vm, vif, TX_QUEUE (i));
  99   /* *INDENT-ON* */
 100
 101   if (vif->tap_fds)
 102     {
 103       _IOCTL (vif->tap_fds[0], TUNSETPERSIST, (void *) (uintptr_t) 0);
 104       tap_log_dbg (vif, "TUNSETPERSIST: unset");
 105     }
 106 error:
 107   vec_foreach_index (i, vif->tap_fds) close (vif->tap_fds[i]);
 108
 109   vec_free (vif->vhost_fds);
 110   vec_free (vif->rxq_vrings);
 111   vec_free (vif->txq_vrings);
 112   vec_free (vif->host_if_name);
 113   vec_free (vif->net_ns);
 114   vec_free (vif->host_bridge);
 115   clib_error_free (vif->error);
 116
 117   tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 0);
 118   clib_memset (vif, 0, sizeof (*vif));
 119   pool_put (mm->interfaces, vif);
 120 }
 121
 122 void
 123 tap_create_if (vlib_main_t * vm, tap_create_if_args_t * args)
 124 {
 125   vlib_thread_main_t *thm = vlib_get_thread_main ();
 126   vlib_physmem_main_t *vpm = &vm->physmem_main;
 127   vnet_main_t *vnm = vnet_get_main ();
 128   virtio_main_t *vim = &virtio_main;
 129   tap_main_t *tm = &tap_main;
 130   vnet_sw_interface_t *sw;
 131   vnet_hw_interface_t *hw;
 132   int i, num_vhost_queues;
 133   int old_netns_fd = -1;
 134   struct ifreq ifr = {.ifr_flags = IFF_NO_PI | IFF_VNET_HDR };
 135   struct ifreq get_ifr = {.ifr_flags = 0 };
 136   size_t hdrsz;
 137   vhost_memory_t *vhost_mem = 0;
 138   virtio_if_t *vif = 0;
 139   clib_error_t *err = 0;
 140   unsigned int tap_features;
 141   int tfd = -1, qfd = -1, vfd = -1, nfd = -1;
 142   char *host_if_name = 0;
 143   unsigned int offload = 0;
 144   int sndbuf = 0;
 145
 146   if (args->id != ~0)
 147     {
 148       if (clib_bitmap_get (tm->tap_ids, args->id))
 149         {
 150           args->rv = VNET_API_ERROR_INVALID_INTERFACE;
 151           args->error = clib_error_return (0, "interface already exists");
 152           return;
 153         }
 154     }
 155   else
 156     {
 157       args->id = clib_bitmap_first_clear (tm->tap_ids);
 158     }
 159
 160   if (args->id > TAP_MAX_INSTANCE)
 161     {
 162       args->rv = VNET_API_ERROR_UNSPECIFIED;
 163       args->error = clib_error_return (0, "cannot find free interface id");
 164       return;
 165     }
 166
 167   pool_get_zero (vim->interfaces, vif);
 168
 169   if (args->tap_flags & TAP_FLAG_TUN)
 170     {
 171       vif->type = VIRTIO_IF_TYPE_TUN;
 172       ifr.ifr_flags |= IFF_TUN;
 173
 174       /*
 175        * From kernel 4.20, xdp support has been added in tun_sendmsg.
 176        * If sndbuf == INT_MAX, vhost batches the packet and processes
 177        * them using xdp data path for tun driver. It assumes packets
 178        * are ethernet frames (It needs to be fixed).
 179        * To avoid xdp data path in tun driver, sndbuf value should
 180        * be < INT_MAX.
 181        */
 182       sndbuf = INT_MAX - 1;
 183     }
 184   else
 185     {
 186       vif->type = VIRTIO_IF_TYPE_TAP;
 187       ifr.ifr_flags |= IFF_TAP;
 188       sndbuf = INT_MAX;
 189     }
 190
 191   vif->dev_instance = vif - vim->interfaces;
 192   vif->id = args->id;
 193   vif->num_txqs = thm->n_vlib_mains;
 194   vif->num_rxqs = clib_max (args->num_rx_queues, 1);
 195
 196   if (args->tap_flags & TAP_FLAG_ATTACH)
 197     {
 198       if (args->host_if_name == NULL)
 199         {
 200           args->rv = VNET_API_ERROR_NO_MATCHING_INTERFACE;
 201           err = clib_error_return (0, "host_if_name is not provided");
 202           goto error;
 203         }
 204     }
 205
 206   /* if namespace is specified, all further netlink messages should be executed
 207    * after we change our net namespace */
 208   if (args->host_namespace)
 209     {
 210       old_netns_fd = clib_netns_open (NULL /* self */);
 211       if ((nfd = clib_netns_open (args->host_namespace)) == -1)
 212         {
 213           args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
 214           args->error = clib_error_return_unix (0, "clib_netns_open '%s'",
 215                                                 args->host_namespace);
 216           goto error;
 217         }
 218       if (clib_setns (nfd) == -1)
 219         {
 220           args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
 221           args->error =
 222             clib_error_return_unix (0, "setns '%s'", args->host_namespace);
 223           goto error;
 224         }
 225     }
 226
 227   if (args->host_if_name != NULL)
 228     {
 229       host_if_name = (char *) args->host_if_name;
 230       clib_memcpy (ifr.ifr_name, host_if_name,
 231                    clib_min (IFNAMSIZ, vec_len (host_if_name)));
 232     }
 233
 234   if ((tfd = open ("/dev/net/tun", O_RDWR | O_NONBLOCK)) < 0)
 235     {
 236       args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
 237       args->error = clib_error_return_unix (0, "open '/dev/net/tun'");
 238       goto error;
 239     }
 240   vec_add1 (vif->tap_fds, tfd);
 241   tap_log_dbg (vif, "open tap fd %d", tfd);
 242
 243   _IOCTL (tfd, TUNGETFEATURES, &tap_features);
 244   tap_log_dbg (vif, "TUNGETFEATURES: features 0x%lx", tap_features);
 245   if ((tap_features & IFF_VNET_HDR) == 0)
 246     {
 247       args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
 248       args->error = clib_error_return (0, "vhost-net backend not available");
 249       goto error;
 250     }
 251
 252   if ((tap_features & IFF_MULTI_QUEUE) == 0)
 253     {
 254       if (vif->num_rxqs > 1)
 255         {
 256           args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
 257           args->error = clib_error_return (0, "multiqueue not supported");
 258           goto error;
 259         }
 260       vif->num_rxqs = vif->num_txqs = 1;
 261     }
 262   else
 263     ifr.ifr_flags |= IFF_MULTI_QUEUE;
 264
 265   hdrsz = sizeof (virtio_net_hdr_v1_t);
 266   if (args->tap_flags & TAP_FLAG_GSO)
 267     {
 268       offload = TUN_F_CSUM | TUN_F_TSO4 | TUN_F_TSO6;
 269       vif->gso_enabled = 1;
 270     }
 271   else if (args->tap_flags & TAP_FLAG_CSUM_OFFLOAD)
 272     {
 273       offload = TUN_F_CSUM;
 274       vif->csum_offload_enabled = 1;
 275     }
 276
 277   _IOCTL (tfd, TUNSETIFF, (void *) &ifr);
 278   tap_log_dbg (vif, "TUNSETIFF fd %d name %s flags 0x%x", tfd,
 279                ifr.ifr_ifrn.ifrn_name, ifr.ifr_flags);
 280
 281   vif->ifindex = if_nametoindex (ifr.ifr_ifrn.ifrn_name);
 282   tap_log_dbg (vif, "ifindex %d", vif->ifindex);
 283
 284   if (!args->host_if_name)
 285     host_if_name = ifr.ifr_ifrn.ifrn_name;
 286   else
 287     host_if_name = (char *) args->host_if_name;
 288
 289   /*
 290    * unset the persistence when attaching to existing
 291    * interface
 292    */
 293   if (args->tap_flags & TAP_FLAG_ATTACH)
 294     {
 295       _IOCTL (tfd, TUNSETPERSIST, (void *) (uintptr_t) 0);
 296       tap_log_dbg (vif, "TUNSETPERSIST: unset");
 297     }
 298
 299   /* set the persistence */
 300   if (args->tap_flags & TAP_FLAG_PERSIST)
 301     {
 302       _IOCTL (tfd, TUNSETPERSIST, (void *) (uintptr_t) 1);
 303       tap_log_dbg (vif, "TUNSETPERSIST: set");
 304
 305       /* verify persistence is set, read the flags */
 306       _IOCTL (tfd, TUNGETIFF, (void *) &get_ifr);
 307       tap_log_dbg (vif, "TUNGETIFF: flags 0x%lx", get_ifr.ifr_flags);
 308       if ((get_ifr.ifr_flags & IFF_PERSIST) == 0)
 309         {
 310           args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
 311           args->error = clib_error_return (0, "persistence not supported");
 312           goto error;
 313         }
 314     }
 315
 316   /* create additional queues on the linux side.
 317    * we create as many linux queue pairs as we have rx queues
 318    */
 319   for (i = 1; i < vif->num_rxqs; i++)
 320     {
 321       if ((qfd = open ("/dev/net/tun", O_RDWR | O_NONBLOCK)) < 0)
 322         {
 323           args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
 324           args->error = clib_error_return_unix (0, "open '/dev/net/tun'");
 325           goto error;
 326         }
 327       _IOCTL (qfd, TUNSETIFF, (void *) &ifr);
 328       tap_log_dbg (vif, "TUNSETIFF fd %d name %s flags 0x%x", qfd,
 329                    ifr.ifr_ifrn.ifrn_name, ifr.ifr_flags);
 330       vec_add1 (vif->tap_fds, qfd);
 331     }
 332
 333   for (i = 0; i < vif->num_rxqs; i++)
 334     {
 335       tap_log_dbg (vif, "TUNSETVNETHDRSZ: fd %d vnet_hdr_sz %u",
 336                    vif->tap_fds[i], hdrsz);
 337       _IOCTL (vif->tap_fds[i], TUNSETVNETHDRSZ, &hdrsz);
 338
 339       tap_log_dbg (vif, "TUNSETSNDBUF: fd %d sndbuf %d", vif->tap_fds[i],
 340                    sndbuf);
 341       _IOCTL (vif->tap_fds[i], TUNSETSNDBUF, &sndbuf);
 342
 343       tap_log_dbg (vif, "TUNSETOFFLOAD: fd %d offload 0x%lx", vif->tap_fds[i],
 344                    offload);
 345       _IOCTL (vif->tap_fds[i], TUNSETOFFLOAD, offload);
 346
 347       if (fcntl (vif->tap_fds[i], F_SETFL, O_NONBLOCK) < 0)
 348         {
 349           err = clib_error_return_unix (0, "fcntl(tfd, F_SETFL, O_NONBLOCK)");
 350           tap_log_err (vif, "set nonblocking: %U", format_clib_error, err);
 351           goto error;
 352         }
 353     }
 354
 355   /* open as many vhost-net fds as required and set ownership */
 356   num_vhost_queues = clib_max (vif->num_rxqs, vif->num_txqs);
 357   for (i = 0; i < num_vhost_queues; i++)
 358     {
 359       if ((vfd = open ("/dev/vhost-net", O_RDWR | O_NONBLOCK)) < 0)
 360         {
 361           args->rv = VNET_API_ERROR_SYSCALL_ERROR_1;
 362           args->error = clib_error_return_unix (0, "open '/dev/vhost-net'");
 363           goto error;
 364         }
 365       vec_add1 (vif->vhost_fds, vfd);
 366       virtio_log_debug (vif, "open vhost-net fd %d qpair %u", vfd, i);
 367       _IOCTL (vfd, VHOST_SET_OWNER, 0);
 368       virtio_log_debug (vif, "VHOST_SET_OWNER: fd %u", vfd);
 369     }
 370
 371   _IOCTL (vif->vhost_fds[0], VHOST_GET_FEATURES, &vif->remote_features);
 372   virtio_log_debug (vif, "VHOST_GET_FEATURES: features 0x%lx",
 373                     vif->remote_features);
 374
 375   if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF)) == 0)
 376     {
 377       args->rv = VNET_API_ERROR_UNSUPPORTED;
 378       args->error = clib_error_return (0, "vhost-net backend doesn't support "
 379                                        "VIRTIO_NET_F_MRG_RXBUF feature");
 380       goto error;
 381     }
 382
 383   if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) ==
 384       0)
 385     {
 386       args->rv = VNET_API_ERROR_UNSUPPORTED;
 387       args->error = clib_error_return (0, "vhost-net backend doesn't support "
 388                                        "VIRTIO_RING_F_INDIRECT_DESC feature");
 389       goto error;
 390     }
 391
 392   if ((vif->remote_features & VIRTIO_FEATURE (VIRTIO_F_VERSION_1)) == 0)
 393     {
 394       args->rv = VNET_API_ERROR_UNSUPPORTED;
 395       args->error = clib_error_return (0, "vhost-net backend doesn't support "
 396                                        "VIRTIO_F_VERSION_1 features");
 397       goto error;
 398     }
 399
 400   vif->features |= VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);
 401   vif->features |= VIRTIO_FEATURE (VIRTIO_F_VERSION_1);
 402   vif->features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);
 403
 404   virtio_set_net_hdr_size (vif);
 405
 406   if (vif->type == VIRTIO_IF_TYPE_TAP)
 407     {
 408       if (ethernet_mac_address_is_zero (args->host_mac_addr.bytes))
 409         ethernet_mac_address_generate (args->host_mac_addr.bytes);
 410       args->error = vnet_netlink_set_link_addr (vif->ifindex,
 411                                                 args->host_mac_addr.bytes);
 412       if (args->error)
 413         {
 414           args->rv = VNET_API_ERROR_NETLINK_ERROR;
 415           goto error;
 416         }
 417
 418       if (args->host_bridge)
 419         {
 420           args->error = vnet_netlink_set_link_master (vif->ifindex,
 421                                                       (char *)
 422                                                       args->host_bridge);
 423           if (args->error)
 424             {
 425               args->rv = VNET_API_ERROR_NETLINK_ERROR;
 426               goto error;
 427             }
 428         }
 429     }
 430
 431   if (args->host_ip4_prefix_len)
 432     {
 433       args->error = vnet_netlink_add_ip4_addr (vif->ifindex,
 434                                                &args->host_ip4_addr,
 435                                                args->host_ip4_prefix_len);
 436       if (args->error)
 437         {
 438           args->rv = VNET_API_ERROR_NETLINK_ERROR;
 439           goto error;
 440         }
 441     }
 442
 443   if (args->host_ip6_prefix_len)
 444     {
 445       args->error = vnet_netlink_add_ip6_addr (vif->ifindex,
 446                                                &args->host_ip6_addr,
 447                                                args->host_ip6_prefix_len);
 448       if (args->error)
 449         {
 450           args->rv = VNET_API_ERROR_NETLINK_ERROR;
 451           goto error;
 452         }
 453     }
 454
 455   args->error = vnet_netlink_set_link_state (vif->ifindex, 1 /* UP */ );
 456   if (args->error)
 457     {
 458       args->rv = VNET_API_ERROR_NETLINK_ERROR;
 459       goto error;
 460     }
 461
 462   if (args->host_ip4_gw_set)
 463     {
 464       args->error = vnet_netlink_add_ip4_route (0, 0, &args->host_ip4_gw);
 465       if (args->error)
 466         {
 467           args->rv = VNET_API_ERROR_NETLINK_ERROR;
 468           goto error;
 469         }
 470     }
 471
 472   if (args->host_ip6_gw_set)
 473     {
 474       args->error = vnet_netlink_add_ip6_route (0, 0, &args->host_ip6_gw);
 475       if (args->error)
 476         {
 477           args->rv = VNET_API_ERROR_NETLINK_ERROR;
 478           goto error;
 479         }
 480     }
 481
 482   if (args->host_mtu_set)
 483     {
 484       args->error =
 485         vnet_netlink_set_link_mtu (vif->ifindex, args->host_mtu_size);
 486       if (args->error)
 487         {
 488           args->rv = VNET_API_ERROR_NETLINK_ERROR;
 489           goto error;
 490         }
 491     }
 492   else if (tm->host_mtu_size != 0)
 493     {
 494       args->error =
 495         vnet_netlink_set_link_mtu (vif->ifindex, tm->host_mtu_size);
 496       if (args->error)
 497         {
 498           args->rv = VNET_API_ERROR_NETLINK_ERROR;
 499           goto error;
 500         }
 501       args->host_mtu_set = 1;
 502       args->host_mtu_size = tm->host_mtu_size;
 503     }
 504
 505   /* switch back to old net namespace */
 506   if (args->host_namespace)
 507     {
 508       if (clib_setns (old_netns_fd) == -1)
 509         {
 510           args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
 511           args->error = clib_error_return_unix (0, "setns '%s'",
 512                                                 args->host_namespace);
 513           goto error;
 514         }
 515     }
 516
 517   for (i = 0; i < num_vhost_queues; i++)
 518     {
 519       if (i < vif->num_rxqs && (args->error =
 520                                 virtio_vring_init (vm, vif, RX_QUEUE (i),
 521                                                    args->rx_ring_sz)))
 522         {
 523           args->rv = VNET_API_ERROR_INIT_FAILED;
 524           goto error;
 525         }
 526
 527       if (i < vif->num_txqs && (args->error =
 528                                 virtio_vring_init (vm, vif, TX_QUEUE (i),
 529                                                    args->tx_ring_sz)))
 530         {
 531           args->rv = VNET_API_ERROR_INIT_FAILED;
 532           goto error;
 533         }
 534     }
 535
 536   /* setup features and memtable */
 537   i = sizeof (vhost_memory_t) + sizeof (vhost_memory_region_t);
 538   vhost_mem = clib_mem_alloc (i);
 539   clib_memset (vhost_mem, 0, i);
 540   vhost_mem->nregions = 1;
 541   vhost_mem->regions[0].memory_size = vpm->max_size;
 542   vhost_mem->regions[0].guest_phys_addr = vpm->base_addr;
 543   vhost_mem->regions[0].userspace_addr =
 544     vhost_mem->regions[0].guest_phys_addr;
 545
 546   for (i = 0; i < vhost_mem->nregions; i++)
 547     virtio_log_debug (vif, "memtable region %u memory_size 0x%lx "
 548                       "guest_phys_addr 0x%lx userspace_addr 0x%lx", i,
 549                       vhost_mem->regions[0].memory_size,
 550                       vhost_mem->regions[0].guest_phys_addr,
 551                       vhost_mem->regions[0].userspace_addr);
 552
 553
 554   for (i = 0; i < num_vhost_queues; i++)
 555     {
 556       int fd = vif->vhost_fds[i];
 557       _IOCTL (fd, VHOST_SET_FEATURES, &vif->features);
 558       virtio_log_debug (vif, "VHOST_SET_FEATURES: fd %u features 0x%lx",
 559                         fd, vif->features);
 560       _IOCTL (fd, VHOST_SET_MEM_TABLE, vhost_mem);
 561       virtio_log_debug (vif, "VHOST_SET_MEM_TABLE: fd %u", fd);
 562     }
 563
 564   /* finish initializing queue pair */
 565   for (i = 0; i < num_vhost_queues * 2; i++)
 566     {
 567       vhost_vring_addr_t addr = { 0 };
 568       vhost_vring_state_t state = { 0 };
 569       vhost_vring_file_t file = { 0 };
 570       virtio_vring_t *vring;
 571       u16 qp = i >> 1;
 572       int fd = vif->vhost_fds[qp];
 573
 574       if (i & 1)
 575         {
 576           if (qp >= vif->num_txqs)
 577             continue;
 578           vring = vec_elt_at_index (vif->txq_vrings, qp);
 579         }
 580       else
 581         {
 582           if (qp >= vif->num_rxqs)
 583             continue;
 584           vring = vec_elt_at_index (vif->rxq_vrings, qp);
 585         }
 586
 587       addr.index = state.index = file.index = vring->queue_id & 1;
 588       state.num = vring->size;
 589       virtio_log_debug (vif, "VHOST_SET_VRING_NUM fd %d index %u num %u", fd,
 590                         state.index, state.num);
 591       _IOCTL (fd, VHOST_SET_VRING_NUM, &state);
 592
 593       addr.flags = 0;
 594       addr.desc_user_addr = pointer_to_uword (vring->desc);
 595       addr.avail_user_addr = pointer_to_uword (vring->avail);
 596       addr.used_user_addr = pointer_to_uword (vring->used);
 597
 598       virtio_log_debug (vif, "VHOST_SET_VRING_ADDR fd %d index %u flags 0x%x "
 599                         "desc_user_addr 0x%lx avail_user_addr 0x%lx "
 600                         "used_user_addr 0x%lx", fd, addr.index,
 601                         addr.flags, addr.desc_user_addr, addr.avail_user_addr,
 602                         addr.used_user_addr);
 603       _IOCTL (fd, VHOST_SET_VRING_ADDR, &addr);
 604
 605       file.fd = vring->call_fd;
 606       virtio_log_debug (vif, "VHOST_SET_VRING_CALL fd %d index %u call_fd %d",
 607                         fd, file.index, file.fd);
 608       _IOCTL (fd, VHOST_SET_VRING_CALL, &file);
 609
 610       file.fd = vring->kick_fd;
 611       virtio_log_debug (vif, "VHOST_SET_VRING_KICK fd %d index %u kick_fd %d",
 612                         fd, file.index, file.fd);
 613       _IOCTL (fd, VHOST_SET_VRING_KICK, &file);
 614
 615       file.fd = vif->tap_fds[qp % vif->num_rxqs];
 616       virtio_log_debug (vif, "VHOST_NET_SET_BACKEND fd %d index %u tap_fd %d",
 617                         fd, file.index, file.fd);
 618       _IOCTL (fd, VHOST_NET_SET_BACKEND, &file);
 619     }
 620
 621   if (vif->type == VIRTIO_IF_TYPE_TAP)
 622     {
 623       if (!args->mac_addr_set)
 624         ethernet_mac_address_generate (args->mac_addr.bytes);
 625
 626       clib_memcpy (vif->mac_addr, args->mac_addr.bytes, 6);
 627       vif->host_bridge = format (0, "%s%c", args->host_bridge, 0);
 628     }
 629   vif->host_if_name = format (0, "%s%c", host_if_name, 0);
 630   vif->net_ns = format (0, "%s%c", args->host_namespace, 0);
 631   vif->host_mtu_size = args->host_mtu_size;
 632   vif->tap_flags = args->tap_flags;
 633   clib_memcpy (vif->host_mac_addr, args->host_mac_addr.bytes, 6);
 634   vif->host_ip4_prefix_len = args->host_ip4_prefix_len;
 635   vif->host_ip6_prefix_len = args->host_ip6_prefix_len;
 636   if (args->host_ip4_prefix_len)
 637     clib_memcpy (&vif->host_ip4_addr, &args->host_ip4_addr, 4);
 638   if (args->host_ip6_prefix_len)
 639     clib_memcpy (&vif->host_ip6_addr, &args->host_ip6_addr, 16);
 640
 641   if (vif->type != VIRTIO_IF_TYPE_TUN)
 642     {
 643       args->error =
 644         ethernet_register_interface (vnm, virtio_device_class.index,
 645                                      vif->dev_instance, vif->mac_addr,
 646                                      &vif->hw_if_index,
 647                                      virtio_eth_flag_change);
 648       if (args->error)
 649         {
 650           args->rv = VNET_API_ERROR_INVALID_REGISTRATION;
 651           goto error;
 652         }
 653
 654     }
 655   else
 656     {
 657       vif->hw_if_index = vnet_register_interface
 658         (vnm, virtio_device_class.index,
 659          vif->dev_instance /* device instance */ ,
 660          tun_device_hw_interface_class.index, vif->dev_instance);
 661
 662     }
 663   tm->tap_ids = clib_bitmap_set (tm->tap_ids, vif->id, 1);
 664   sw = vnet_get_hw_sw_interface (vnm, vif->hw_if_index);
 665   vif->sw_if_index = sw->sw_if_index;
 666   args->sw_if_index = vif->sw_if_index;
 667   args->rv = 0;
 668   hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
 669   hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_INT_MODE;
 670   if (args->tap_flags & TAP_FLAG_GSO)
 671     {
 672       hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO |
 673                   VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM |
 674                   VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM;
 675     }
 676   else if (args->tap_flags & TAP_FLAG_CSUM_OFFLOAD)
 677     {
 678       hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM |
 679                   VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM;
 680     }
 681   if ((args->tap_flags & TAP_FLAG_GSO)
 682       && (args->tap_flags & TAP_FLAG_GRO_COALESCE))
 683     {
 684       virtio_set_packet_coalesce (vif);
 685     }
 686   if (vif->type == VIRTIO_IF_TYPE_TUN)
 687     {
 688       hw->max_supported_packet_bytes = TUN_MAX_PACKET_BYTES;
 689       hw->min_packet_bytes = hw->min_supported_packet_bytes =
 690         TUN_MIN_PACKET_BYTES;
 691       hw->max_packet_bytes =
 692         args->host_mtu_size ? args->host_mtu_size : TUN_DEFAULT_PACKET_BYTES;
 693       vnet_sw_interface_set_mtu (vnm, hw->sw_if_index, hw->max_packet_bytes);
 694     }
 695
 696   virtio_vring_set_rx_queues (vm, vif);
 697
 698   vif->per_interface_next_index = ~0;
 699   vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
 700   vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
 701                                VNET_HW_INTERFACE_FLAG_LINK_UP);
 702   /*
 703    * Host tun/tap driver link carrier state is "up" at creation. The
 704    * driver never changes this unless the backend (VPP) changes it using
 705    * TUNSETCARRIER ioctl(). See tap_set_carrier().
 706    */
 707   vif->host_carrier_up = 1;
 708
 709   goto done;
 710
 711 error:
 712   if (err)
 713     {
 714       ASSERT (args->error == 0);
 715       args->error = err;
 716       args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
 717     }
 718
 719   tap_log_err (vif, "%U", format_clib_error, args->error);
 720   tap_free (vm, vif);
 721 done:
 722   if (vhost_mem)
 723     clib_mem_free (vhost_mem);
 724   if (old_netns_fd != -1)
 725     {
 726       /* in case we errored with a switched netns */
 727       clib_setns (old_netns_fd);
 728       close (old_netns_fd);
 729     }
 730   if (nfd != -1)
 731     close (nfd);
 732 }
 733
 734 int
 735 tap_delete_if (vlib_main_t * vm, u32 sw_if_index)
 736 {
 737   vnet_main_t *vnm = vnet_get_main ();
 738   virtio_main_t *mm = &virtio_main;
 739   virtio_if_t *vif;
 740   vnet_hw_interface_t *hw;
 741
 742   hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
 743   if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
 744     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 745
 746   vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
 747
 748   if ((vif->type != VIRTIO_IF_TYPE_TAP) && (vif->type != VIRTIO_IF_TYPE_TUN))
 749     return VNET_API_ERROR_INVALID_INTERFACE;
 750
 751   /* bring down the interface */
 752   vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
 753   vnet_sw_interface_set_flags (vnm, vif->sw_if_index, 0);
 754
 755   if (vif->type == VIRTIO_IF_TYPE_TAP)
 756     ethernet_delete_interface (vnm, vif->hw_if_index);
 757   else                          /* VIRTIO_IF_TYPE_TUN */
 758     vnet_delete_hw_interface (vnm, vif->hw_if_index);
 759   vif->hw_if_index = ~0;
 760
 761   tap_free (vm, vif);
 762
 763   return 0;
 764 }
 765
 766 int
 767 tap_csum_offload_enable_disable (vlib_main_t * vm, u32 sw_if_index,
 768                                  int enable_disable)
 769 {
 770   vnet_main_t *vnm = vnet_get_main ();
 771   virtio_main_t *mm = &virtio_main;
 772   virtio_if_t *vif;
 773   vnet_hw_interface_t *hw;
 774   clib_error_t *err = 0;
 775   int i = 0;
 776
 777   hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
 778
 779   if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
 780     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 781
 782   vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
 783
 784   const unsigned int csum_offload_on = TUN_F_CSUM;
 785   const unsigned int csum_offload_off = 0;
 786   unsigned int offload = enable_disable ? csum_offload_on : csum_offload_off;
 787   vec_foreach_index (i, vif->tap_fds)
 788     _IOCTL (vif->tap_fds[i], TUNSETOFFLOAD, offload);
 789   vif->gso_enabled = 0;
 790   vif->packet_coalesce = 0;
 791   vif->csum_offload_enabled = enable_disable ? 1 : 0;
 792
 793   if ((hw->caps & VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO) != 0)
 794     {
 795       hw->caps &= ~VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO;
 796     }
 797
 798   if (enable_disable)
 799     {
 800       hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_L4_TX_CKSUM;
 801     }
 802   else
 803     {
 804       hw->caps &= ~VNET_HW_INTERFACE_CAP_SUPPORTS_L4_TX_CKSUM;
 805     }
 806
 807 error:
 808   if (err)
 809     {
 810       clib_warning ("Error %s checksum offload on sw_if_index %d",
 811                     enable_disable ? "enabling" : "disabling", sw_if_index);
 812       return VNET_API_ERROR_SYSCALL_ERROR_3;
 813     }
 814   return 0;
 815 }
 816
 817 int
 818 tap_gso_enable_disable (vlib_main_t * vm, u32 sw_if_index, int enable_disable,
 819                         int is_packet_coalesce)
 820 {
 821   vnet_main_t *vnm = vnet_get_main ();
 822   virtio_main_t *mm = &virtio_main;
 823   virtio_if_t *vif;
 824   vnet_hw_interface_t *hw;
 825   clib_error_t *err = 0;
 826   int i = 0;
 827
 828   hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
 829
 830   if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
 831     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 832
 833   vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
 834
 835   const unsigned int gso_on = TUN_F_CSUM | TUN_F_TSO4 | TUN_F_TSO6;
 836   const unsigned int gso_off = 0;
 837   unsigned int offload = enable_disable ? gso_on : gso_off;
 838   vec_foreach_index (i, vif->tap_fds)
 839     _IOCTL (vif->tap_fds[i], TUNSETOFFLOAD, offload);
 840   vif->gso_enabled = enable_disable ? 1 : 0;
 841   vif->csum_offload_enabled = 0;
 842   if (enable_disable)
 843     {
 844       if ((hw->caps & VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO) == 0)
 845         {
 846           hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO |
 847                       VNET_HW_INTERFACE_CAP_SUPPORTS_L4_TX_CKSUM;
 848         }
 849       if (is_packet_coalesce)
 850         {
 851           virtio_set_packet_coalesce (vif);
 852         }
 853     }
 854   else
 855     {
 856       if ((hw->caps & VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO) != 0)
 857         {
 858           hw->caps &= ~(VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO |
 859                         VNET_HW_INTERFACE_CAP_SUPPORTS_L4_TX_CKSUM);
 860         }
 861       vif->packet_coalesce = 0;
 862     }
 863
 864 error:
 865   if (err)
 866     {
 867       clib_warning ("Error %s gso on sw_if_index %d",
 868                     enable_disable ? "enabling" : "disabling", sw_if_index);
 869       return VNET_API_ERROR_SYSCALL_ERROR_3;
 870     }
 871   return 0;
 872 }
 873
 874 int
 875 tap_dump_ifs (tap_interface_details_t ** out_tapids)
 876 {
 877   vnet_main_t *vnm = vnet_get_main ();
 878   virtio_main_t *mm = &virtio_main;
 879   virtio_if_t *vif;
 880   virtio_vring_t *vring;
 881   vnet_hw_interface_t *hi;
 882   tap_interface_details_t *r_tapids = NULL;
 883   tap_interface_details_t *tapid = NULL;
 884
 885   /* *INDENT-OFF* */
 886   pool_foreach (vif, mm->interfaces) {
 887     if ((vif->type != VIRTIO_IF_TYPE_TAP)
 888       && (vif->type != VIRTIO_IF_TYPE_TUN))
 889       continue;
 890     vec_add2(r_tapids, tapid, 1);
 891     clib_memset (tapid, 0, sizeof (*tapid));
 892     tapid->id = vif->id;
 893     tapid->sw_if_index = vif->sw_if_index;
 894     hi = vnet_get_hw_interface (vnm, vif->hw_if_index);
 895     clib_memcpy(tapid->dev_name, hi->name,
 896                 MIN (ARRAY_LEN (tapid->dev_name) - 1, vec_len (hi->name)));
 897     vring = vec_elt_at_index (vif->rxq_vrings, RX_QUEUE_ACCESS(0));
 898     tapid->rx_ring_sz = vring->size;
 899     vring = vec_elt_at_index (vif->txq_vrings, TX_QUEUE_ACCESS(0));
 900     tapid->tx_ring_sz = vring->size;
 901     tapid->tap_flags = vif->tap_flags;
 902     clib_memcpy(&tapid->host_mac_addr, vif->host_mac_addr, 6);
 903     if (vif->host_if_name)
 904       {
 905         clib_memcpy(tapid->host_if_name, vif->host_if_name,
 906                     MIN (ARRAY_LEN (tapid->host_if_name) - 1,
 907                     vec_len (vif->host_if_name)));
 908       }
 909     if (vif->net_ns)
 910       {
 911         clib_memcpy(tapid->host_namespace, vif->net_ns,
 912                     MIN (ARRAY_LEN (tapid->host_namespace) - 1,
 913                     vec_len (vif->net_ns)));
 914       }
 915     if (vif->host_bridge)
 916       {
 917         clib_memcpy(tapid->host_bridge, vif->host_bridge,
 918                     MIN (ARRAY_LEN (tapid->host_bridge) - 1,
 919                     vec_len (vif->host_bridge)));
 920       }
 921     if (vif->host_ip4_prefix_len)
 922       clib_memcpy(tapid->host_ip4_addr.as_u8, &vif->host_ip4_addr, 4);
 923     tapid->host_ip4_prefix_len = vif->host_ip4_prefix_len;
 924     if (vif->host_ip6_prefix_len)
 925       clib_memcpy(tapid->host_ip6_addr.as_u8, &vif->host_ip6_addr, 16);
 926     tapid->host_ip6_prefix_len = vif->host_ip6_prefix_len;
 927     tapid->host_mtu_size = vif->host_mtu_size;
 928   }
 929   /* *INDENT-ON* */
 930
 931   *out_tapids = r_tapids;
 932
 933   return 0;
 934 }
 935
 936 /*
 937  * Set host tap/tun interface carrier state so it will appear to host
 938  * applications that the interface's link state changed.
 939  *
 940  * If the kernel we're building against does not have support for the
 941  * TUNSETCARRIER ioctl command, do nothing.
 942  */
 943 int
 944 tap_set_carrier (u32 hw_if_index, u32 carrier_up)
 945 {
 946   int ret = 0;
 947 #ifdef TUNSETCARRIER
 948   vnet_main_t *vnm = vnet_get_main ();
 949   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
 950   virtio_main_t *mm = &virtio_main;
 951   virtio_if_t *vif;
 952   int *fd;
 953
 954   vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
 955   vec_foreach (fd, vif->tap_fds)
 956   {
 957     ret = ioctl (*fd, TUNSETCARRIER, &carrier_up);
 958     if (ret < 0)
 959       {
 960         clib_warning ("ioctl (TUNSETCARRIER) returned %d", ret);
 961         break;
 962       }
 963   }
 964   if (!ret)
 965     vif->host_carrier_up = (carrier_up != 0);
 966 #endif
 967
 968   return ret;
 969 }
 970
 971 static clib_error_t *
 972 tap_mtu_config (vlib_main_t * vm, unformat_input_t * input)
 973 {
 974   tap_main_t *tm = &tap_main;
 975
 976   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 977     {
 978       if (unformat (input, "host-mtu %d", &tm->host_mtu_size))
 979         ;
 980       else
 981         return clib_error_return (0, "unknown input `%U'",
 982                                   format_unformat_error, input);
 983     }
 984
 985   return 0;
 986 }
 987
 988 /*
 989  * Set host tap/tun interface speed in Mbps.
 990  */
 991 int
 992 tap_set_speed (u32 hw_if_index, u32 speed)
 993 {
 994   vnet_main_t *vnm = vnet_get_main ();
 995   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
 996   virtio_main_t *mm = &virtio_main;
 997   virtio_if_t *vif;
 998   int old_netns_fd = -1;
 999   int nfd = -1;
1000   int ctl_fd = -1;
1001   struct ifreq ifr;
1002   struct ethtool_cmd ecmd;
1003   int ret = -1;
1004
1005   vif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
1006
1007   if (vif->net_ns)
1008     {
1009       old_netns_fd = clib_netns_open (NULL /* self */);
1010       if ((nfd = clib_netns_open (vif->net_ns)) == -1)
1011         {
1012           clib_warning ("Cannot open netns");
1013           goto done;
1014         }
1015       if (clib_setns (nfd) == -1)
1016         {
1017           clib_warning ("Cannot set ns");
1018           goto done;
1019         }
1020     }
1021
1022   if ((ctl_fd = socket (AF_INET, SOCK_STREAM, 0)) == -1)
1023     {
1024       clib_warning ("Cannot open control socket");
1025       goto done;
1026     }
1027
1028   ecmd.cmd = ETHTOOL_GSET;
1029   clib_memset (&ifr, 0, sizeof (ifr));
1030   clib_memcpy (ifr.ifr_name, vif->host_if_name,
1031                strlen ((const char *) vif->host_if_name));
1032   ifr.ifr_data = (void *) &ecmd;
1033   if ((ret = ioctl (ctl_fd, SIOCETHTOOL, &ifr)) < 0)
1034     {
1035       clib_warning ("Cannot get device settings");
1036       goto done;
1037     }
1038
1039   if (ethtool_cmd_speed (&ecmd) != speed)
1040     {
1041       ecmd.cmd = ETHTOOL_SSET;
1042       ethtool_cmd_speed_set (&ecmd, speed);
1043       if ((ret = ioctl (ctl_fd, SIOCETHTOOL, &ifr)) < 0)
1044         {
1045           clib_warning ("Cannot set device settings");
1046           goto done;
1047         }
1048     }
1049
1050 done:
1051   if (old_netns_fd != -1)
1052     {
1053       if (clib_setns (old_netns_fd) == -1)
1054         {
1055           clib_warning ("Cannot set old ns");
1056         }
1057       close (old_netns_fd);
1058     }
1059   if (nfd != -1)
1060     close (nfd);
1061   if (ctl_fd != -1)
1062     close (ctl_fd);
1063
1064   return ret;
1065 }
1066
1067 /* tap { host-mtu <size> } configuration. */
1068 VLIB_CONFIG_FUNCTION (tap_mtu_config, "tap");
1069
1070 static clib_error_t *
1071 tap_init (vlib_main_t * vm)
1072 {
1073   tap_main_t *tm = &tap_main;
1074   clib_error_t *error = 0;
1075
1076   tm->log_default = vlib_log_register_class ("tap", 0);
1077   vlib_log_debug (tm->log_default, "initialized");
1078
1079   tm->host_mtu_size = 0;
1080
1081   return error;
1082 }
1083
1084 VLIB_INIT_FUNCTION (tap_init);
1085
1086 /*
1087  * fd.io coding-style-patch-verification: ON
1088  *
1089  * Local Variables:
1090  * eval: (c-set-style "gnu")
1091  * End:
1092  */