src/vnet/unix/tuntap.c

   1 /*
   2  *------------------------------------------------------------------
   3  * tuntap.c - kernel stack (reverse) punt/inject path
   4  *
   5  * Copyright (c) 2009 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19 /**
  20  * @file
  21  * @brief  TunTap Kernel stack (reverse) punt/inject path.
  22  *
  23  * This driver runs in one of two distinct modes:
  24  * - "punt/inject" mode, where we send pkts not otherwise processed
  25  * by the forwarding to the Linux kernel stack, and
  26  *
  27  * - "normal interface" mode, where we treat the Linux kernel stack
  28  * as a peer.
  29  *
  30  * By default, we select punt/inject mode.
  31  */
  32
  33 #include <fcntl.h>              /* for open */
  34 #include <sys/ioctl.h>
  35 #include <sys/socket.h>
  36 #include <sys/stat.h>
  37 #include <sys/types.h>
  38 #include <sys/uio.h>            /* for iovec */
  39 #include <netinet/in.h>
  40
  41 #include <linux/if_arp.h>
  42 #include <linux/if_tun.h>
  43
  44 #include <vlib/vlib.h>
  45 #include <vlib/unix/unix.h>
  46
  47 #include <vnet/ip/ip.h>
  48 #include <vnet/fib/fib_table.h>
  49
  50 #include <vnet/ethernet/ethernet.h>
  51 #include <vnet/devices/devices.h>
  52 #include <vnet/feature/feature.h>
  53
  54 static vnet_device_class_t tuntap_dev_class;
  55 static vnet_hw_interface_class_t tuntap_interface_class;
  56
  57 static void tuntap_punt_frame (vlib_main_t * vm,
  58                                vlib_node_runtime_t * node,
  59                                vlib_frame_t * frame);
  60 static void tuntap_nopunt_frame (vlib_main_t * vm,
  61                                  vlib_node_runtime_t * node,
  62                                  vlib_frame_t * frame);
  63
  64 typedef struct
  65 {
  66   u32 sw_if_index;
  67   u8 is_v6;
  68   u8 addr[16];
  69 } subif_address_t;
  70
  71 /**
  72  * @brief TUNTAP per thread struct
  73  */
  74 typedef struct
  75 {
  76   /** Vector of VLIB rx buffers to use.  We allocate them in blocks
  77      of VLIB_FRAME_SIZE (256). */
  78   u32 *rx_buffers;
  79
  80   /** Vector of iovecs for readv/writev calls. */
  81   struct iovec *iovecs;
  82 } tuntap_per_thread_t;
  83
  84 /**
  85  * @brief TUNTAP node main state
  86  */
  87 typedef struct
  88 {
  89   /** per thread variables */
  90   tuntap_per_thread_t *threads;
  91
  92   /** File descriptors for /dev/net/tun and provisioning socket. */
  93   int dev_net_tun_fd, dev_tap_fd;
  94
  95   /** Create a "tap" [ethernet] encaps device */
  96   int is_ether;
  97
  98   /** 1 if a "normal" routed intfc, 0 if a punt/inject interface */
  99
 100   int have_normal_interface;
 101
 102   /** tap device destination MAC address. Required, or Linux drops pkts */
 103   u8 ether_dst_mac[6];
 104
 105   /** Interface MTU in bytes and # of default sized buffers. */
 106   u32 mtu_bytes, mtu_buffers;
 107
 108   /** Linux interface name for tun device. */
 109   char *tun_name;
 110
 111   /** Pool of subinterface addresses */
 112   subif_address_t *subifs;
 113
 114   /** Hash for subif addresses */
 115   mhash_t subif_mhash;
 116
 117   /** Unix file index */
 118   u32 clib_file_index;
 119
 120   /** For the "normal" interface, if configured */
 121   u32 hw_if_index, sw_if_index;
 122
 123 } tuntap_main_t;
 124
 125 static tuntap_main_t tuntap_main = {
 126   .tun_name = "vnet",
 127
 128   /** Suitable defaults for an Ethernet-like tun/tap device */
 129   .mtu_bytes = 4096 + 256,
 130 };
 131
 132 /**
 133  * @brief tuntap_tx
 134  * @node tuntap-tx
 135  *
 136  * Output node, writes the buffers comprising the incoming frame
 137  * to the tun/tap device, aka hands them to the Linux kernel stack.
 138  *
 139  * @param *vm - vlib_main_t
 140  * @param *node - vlib_node_runtime_t
 141  * @param *frame - vlib_frame_t
 142  *
 143  * @return rc - uword
 144  *
 145  */
 146 static uword
 147 tuntap_tx (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
 148 {
 149   u32 *buffers = vlib_frame_vector_args (frame);
 150   uword n_packets = frame->n_vectors;
 151   tuntap_main_t *tm = &tuntap_main;
 152   vnet_main_t *vnm = vnet_get_main ();
 153   vnet_interface_main_t *im = &vnm->interface_main;
 154   u32 n_bytes = 0;
 155   int i;
 156   u16 thread_index = vm->thread_index;
 157
 158   for (i = 0; i < n_packets; i++)
 159     {
 160       struct iovec *iov;
 161       vlib_buffer_t *b;
 162       uword l;
 163
 164       b = vlib_get_buffer (vm, buffers[i]);
 165
 166       if (tm->is_ether && (!tm->have_normal_interface))
 167         {
 168           vlib_buffer_reset (b);
 169           clib_memcpy_fast (vlib_buffer_get_current (b), tm->ether_dst_mac,
 170                             6);
 171         }
 172
 173       /* Re-set iovecs if present. */
 174       if (tm->threads[thread_index].iovecs)
 175         vec_set_len (tm->threads[thread_index].iovecs, 0);
 176
 177       /** VLIB buffer chain -> Unix iovec(s). */
 178       vec_add2 (tm->threads[thread_index].iovecs, iov, 1);
 179       iov->iov_base = b->data + b->current_data;
 180       iov->iov_len = l = b->current_length;
 181
 182       if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
 183         {
 184           do
 185             {
 186               b = vlib_get_buffer (vm, b->next_buffer);
 187
 188               vec_add2 (tm->threads[thread_index].iovecs, iov, 1);
 189
 190               iov->iov_base = b->data + b->current_data;
 191               iov->iov_len = b->current_length;
 192               l += b->current_length;
 193             }
 194           while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
 195         }
 196
 197       if (writev (tm->dev_net_tun_fd, tm->threads[thread_index].iovecs,
 198                   vec_len (tm->threads[thread_index].iovecs)) < l)
 199         clib_unix_warning ("writev");
 200
 201       n_bytes += l;
 202     }
 203
 204   /* Update tuntap interface output stats. */
 205   vlib_increment_combined_counter (im->combined_sw_if_counters
 206                                    + VNET_INTERFACE_COUNTER_TX,
 207                                    vm->thread_index,
 208                                    tm->sw_if_index, n_packets, n_bytes);
 209
 210
 211   /** The normal interface path flattens the buffer chain */
 212   if (tm->have_normal_interface)
 213     vlib_buffer_free_no_next (vm, buffers, n_packets);
 214   else
 215     vlib_buffer_free (vm, buffers, n_packets);
 216
 217   return n_packets;
 218 }
 219
 220 VLIB_REGISTER_NODE (tuntap_tx_node,static) = {
 221   .function = tuntap_tx,
 222   .name = "tuntap-tx",
 223   .type = VLIB_NODE_TYPE_INTERNAL,
 224   .vector_size = 4,
 225 };
 226
 227 /**
 228  * @brief TUNTAP receive node
 229  * @node tuntap-rx
 230  *
 231  * @param *vm - vlib_main_t
 232  * @param *node - vlib_node_runtime_t
 233  * @param *frame - vlib_frame_t
 234  *
 235  * @return rc - uword
 236  *
 237  */
 238 static uword
 239 tuntap_rx (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
 240 {
 241   tuntap_main_t *tm = &tuntap_main;
 242   vlib_buffer_t *b;
 243   u32 bi;
 244   const uword buffer_size = vlib_buffer_get_default_data_size (vm);
 245   u16 thread_index = vm->thread_index;
 246
 247   /** Make sure we have some RX buffers. */
 248   {
 249     uword n_left = vec_len (tm->threads[thread_index].rx_buffers);
 250     uword n_alloc;
 251
 252     if (n_left < VLIB_FRAME_SIZE / 2)
 253       {
 254         if (!tm->threads[thread_index].rx_buffers)
 255           vec_alloc (tm->threads[thread_index].rx_buffers, VLIB_FRAME_SIZE);
 256
 257         n_alloc =
 258           vlib_buffer_alloc (vm,
 259                              tm->threads[thread_index].rx_buffers + n_left,
 260                              VLIB_FRAME_SIZE - n_left);
 261         vec_set_len (tm->threads[thread_index].rx_buffers, n_left + n_alloc);
 262       }
 263   }
 264
 265   /** Allocate RX buffers from end of rx_buffers.
 266      Turn them into iovecs to pass to readv. */
 267   {
 268     uword i_rx = vec_len (tm->threads[thread_index].rx_buffers) - 1;
 269     vlib_buffer_t *b;
 270     word i, n_bytes_left, n_bytes_in_packet;
 271
 272     /** We should have enough buffers left for an MTU sized packet. */
 273     ASSERT (vec_len (tm->threads[thread_index].rx_buffers) >=
 274             tm->mtu_buffers);
 275
 276     vec_validate (tm->threads[thread_index].iovecs, tm->mtu_buffers - 1);
 277     for (i = 0; i < tm->mtu_buffers; i++)
 278       {
 279         b =
 280           vlib_get_buffer (vm,
 281                            tm->threads[thread_index].rx_buffers[i_rx - i]);
 282         tm->threads[thread_index].iovecs[i].iov_base = b->data;
 283         tm->threads[thread_index].iovecs[i].iov_len = buffer_size;
 284       }
 285
 286     n_bytes_left =
 287       readv (tm->dev_net_tun_fd, tm->threads[thread_index].iovecs,
 288              tm->mtu_buffers);
 289     n_bytes_in_packet = n_bytes_left;
 290     if (n_bytes_left <= 0)
 291       {
 292         if (errno != EAGAIN)
 293           clib_unix_warning ("readv %d", n_bytes_left);
 294         return 0;
 295       }
 296
 297     bi = tm->threads[thread_index].rx_buffers[i_rx];
 298
 299     while (1)
 300       {
 301         b = vlib_get_buffer (vm, tm->threads[thread_index].rx_buffers[i_rx]);
 302         b->flags = 0;
 303         b->current_data = 0;
 304         b->current_length =
 305           n_bytes_left < buffer_size ? n_bytes_left : buffer_size;
 306
 307         n_bytes_left -= buffer_size;
 308
 309         if (n_bytes_left <= 0)
 310           {
 311             break;
 312           }
 313
 314         i_rx--;
 315         b->flags |= VLIB_BUFFER_NEXT_PRESENT;
 316         b->next_buffer = tm->threads[thread_index].rx_buffers[i_rx];
 317       }
 318
 319     /** Interface counters for tuntap interface. */
 320     vlib_increment_combined_counter
 321       (vnet_main.interface_main.combined_sw_if_counters
 322        + VNET_INTERFACE_COUNTER_RX,
 323        thread_index, tm->sw_if_index, 1, n_bytes_in_packet);
 324
 325     vec_set_len (tm->threads[thread_index].rx_buffers, i_rx);
 326   }
 327
 328   b = vlib_get_buffer (vm, bi);
 329
 330   {
 331     u32 next_index;
 332     uword n_trace = vlib_get_trace_count (vm, node);
 333
 334     vnet_buffer (b)->sw_if_index[VLIB_RX] = tm->sw_if_index;
 335     vnet_buffer (b)->sw_if_index[VLIB_TX] = (u32) ~ 0;
 336
 337     b->error = node->errors[0];
 338
 339     if (tm->is_ether)
 340       {
 341         next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
 342       }
 343     else
 344       switch (b->data[0] & 0xf0)
 345         {
 346         case 0x40:
 347           next_index = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
 348           break;
 349         case 0x60:
 350           next_index = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
 351           break;
 352         default:
 353           next_index = VNET_DEVICE_INPUT_NEXT_DROP;
 354           break;
 355         }
 356
 357     /* The linux kernel couldn't care less if our interface is up */
 358     if (tm->have_normal_interface)
 359       {
 360         vnet_main_t *vnm = vnet_get_main ();
 361         vnet_sw_interface_t *si;
 362         si = vnet_get_sw_interface (vnm, tm->sw_if_index);
 363         if (!(si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
 364           next_index = VNET_DEVICE_INPUT_NEXT_DROP;
 365       }
 366
 367     vnet_feature_start_device_input (tm->sw_if_index, &next_index, b);
 368
 369     vlib_set_next_frame_buffer (vm, node, next_index, bi);
 370
 371     if (PREDICT_FALSE (n_trace > 0 && vlib_trace_buffer (vm, node, next_index, b,       /* follow_chain */
 372                                                          1)))
 373       vlib_set_trace_count (vm, node, n_trace - 1);
 374   }
 375
 376   return 1;
 377 }
 378
 379 /**
 380  * @brief TUNTAP_RX error strings
 381  */
 382 static char *tuntap_rx_error_strings[] = {
 383   "unknown packet type",
 384 };
 385
 386 VLIB_REGISTER_NODE (tuntap_rx_node,static) = {
 387   .function = tuntap_rx,
 388   .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
 389   .name = "tuntap-rx",
 390   .sibling_of = "device-input",
 391   .type = VLIB_NODE_TYPE_INPUT,
 392   .state = VLIB_NODE_STATE_INTERRUPT,
 393   .vector_size = 4,
 394   .n_errors = 1,
 395   .error_strings = tuntap_rx_error_strings,
 396 };
 397
 398 /**
 399  * @brief Gets called when file descriptor is ready from epoll.
 400  *
 401  * @param *uf - clib_file_t
 402  *
 403  * @return error - clib_error_t
 404  */
 405 static clib_error_t *
 406 tuntap_read_ready (clib_file_t * uf)
 407 {
 408   vlib_main_t *vm = vlib_get_main ();
 409   vlib_node_set_interrupt_pending (vm, tuntap_rx_node.index);
 410   return 0;
 411 }
 412
 413 /**
 414  * @brief Clean up the tun/tap device
 415  *
 416  * @param *vm - vlib_main_t
 417  *
 418  * @return error - clib_error_t
 419  *
 420  */
 421 static clib_error_t *
 422 tuntap_exit (vlib_main_t * vm)
 423 {
 424   tuntap_main_t *tm = &tuntap_main;
 425   struct ifreq ifr;
 426   int sfd;
 427
 428   /* Not present. */
 429   if (!tm->dev_net_tun_fd || tm->dev_net_tun_fd < 0)
 430     return 0;
 431
 432   sfd = socket (AF_INET, SOCK_STREAM, 0);
 433   if (sfd < 0)
 434     clib_unix_warning ("provisioning socket");
 435
 436   clib_memset (&ifr, 0, sizeof (ifr));
 437   strncpy (ifr.ifr_name, tm->tun_name, sizeof (ifr.ifr_name) - 1);
 438
 439   /* get flags, modify to bring down interface... */
 440   if (ioctl (sfd, SIOCGIFFLAGS, &ifr) < 0)
 441     clib_unix_warning ("SIOCGIFFLAGS");
 442
 443   ifr.ifr_flags &= ~(IFF_UP | IFF_RUNNING);
 444
 445   if (ioctl (sfd, SIOCSIFFLAGS, &ifr) < 0)
 446     clib_unix_warning ("SIOCSIFFLAGS");
 447
 448   /* Turn off persistence */
 449   if (ioctl (tm->dev_net_tun_fd, TUNSETPERSIST, 0) < 0)
 450     clib_unix_warning ("TUNSETPERSIST");
 451   close (tm->dev_tap_fd);
 452   if (tm->dev_net_tun_fd >= 0)
 453     close (tm->dev_net_tun_fd);
 454   if (sfd >= 0)
 455     close (sfd);
 456
 457   return 0;
 458 }
 459
 460 VLIB_MAIN_LOOP_EXIT_FUNCTION (tuntap_exit);
 461
 462 /**
 463  * @brief CLI function for tun/tap config
 464  *
 465  * @param *vm - vlib_main_t
 466  * @param *input - unformat_input_t
 467  *
 468  * @return error - clib_error_t
 469  *
 470  */
 471 static clib_error_t *
 472 tuntap_config (vlib_main_t * vm, unformat_input_t * input)
 473 {
 474   tuntap_main_t *tm = &tuntap_main;
 475   clib_error_t *error = 0;
 476   struct ifreq ifr;
 477   u8 *name;
 478   int flags = IFF_TUN | IFF_NO_PI;
 479   int is_enabled = 0, is_ether = 0, have_normal_interface = 0;
 480   const uword buffer_size = vlib_buffer_get_default_data_size (vm);
 481
 482   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 483     {
 484       if (unformat (input, "mtu %d", &tm->mtu_bytes))
 485         ;
 486       else if (unformat (input, "enable"))
 487         is_enabled = 1;
 488       else if (unformat (input, "disable"))
 489         is_enabled = 0;
 490       else if (unformat (input, "ethernet") || unformat (input, "ether"))
 491         is_ether = 1;
 492       else if (unformat (input, "have-normal-interface") ||
 493                unformat (input, "have-normal"))
 494         have_normal_interface = 1;
 495       else if (unformat (input, "name %s", &name))
 496         tm->tun_name = (char *) name;
 497       else
 498         return clib_error_return (0, "unknown input `%U'",
 499                                   format_unformat_error, input);
 500     }
 501
 502   tm->dev_net_tun_fd = -1;
 503   tm->dev_tap_fd = -1;
 504
 505   if (is_enabled == 0)
 506     return 0;
 507
 508   if (geteuid ())
 509     {
 510       clib_warning ("tuntap disabled: must be superuser");
 511       return 0;
 512     }
 513
 514   tm->is_ether = is_ether;
 515   tm->have_normal_interface = have_normal_interface;
 516
 517   if (is_ether)
 518     flags = IFF_TAP | IFF_NO_PI;
 519
 520   if ((tm->dev_net_tun_fd = open ("/dev/net/tun", O_RDWR)) < 0)
 521     {
 522       error = clib_error_return_unix (0, "open /dev/net/tun");
 523       goto done;
 524     }
 525
 526   clib_memset (&ifr, 0, sizeof (ifr));
 527   strncpy (ifr.ifr_name, tm->tun_name, sizeof (ifr.ifr_name) - 1);
 528   ifr.ifr_flags = flags;
 529   if (ioctl (tm->dev_net_tun_fd, TUNSETIFF, (void *) &ifr) < 0)
 530     {
 531       error = clib_error_return_unix (0, "ioctl TUNSETIFF");
 532       goto done;
 533     }
 534
 535   /* Make it persistent, at least until we split. */
 536   if (ioctl (tm->dev_net_tun_fd, TUNSETPERSIST, 1) < 0)
 537     {
 538       error = clib_error_return_unix (0, "TUNSETPERSIST");
 539       goto done;
 540     }
 541
 542   /* Open a provisioning socket */
 543   if ((tm->dev_tap_fd = socket (PF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
 544     {
 545       error = clib_error_return_unix (0, "socket");
 546       goto done;
 547     }
 548
 549   /* Find the interface index. */
 550   {
 551     struct ifreq ifr;
 552     struct sockaddr_ll sll;
 553
 554     clib_memset (&ifr, 0, sizeof (ifr));
 555     strncpy (ifr.ifr_name, tm->tun_name, sizeof (ifr.ifr_name) - 1);
 556     if (ioctl (tm->dev_tap_fd, SIOCGIFINDEX, &ifr) < 0)
 557       {
 558         error = clib_error_return_unix (0, "ioctl SIOCGIFINDEX");
 559         goto done;
 560       }
 561
 562     /* Bind the provisioning socket to the interface. */
 563     clib_memset (&sll, 0, sizeof (sll));
 564     sll.sll_family = AF_PACKET;
 565     sll.sll_ifindex = ifr.ifr_ifindex;
 566     sll.sll_protocol = htons (ETH_P_ALL);
 567
 568     if (bind (tm->dev_tap_fd, (struct sockaddr *) &sll, sizeof (sll)) < 0)
 569       {
 570         error = clib_error_return_unix (0, "bind");
 571         goto done;
 572       }
 573   }
 574
 575   /* non-blocking I/O on /dev/tapX */
 576   {
 577     int one = 1;
 578     if (ioctl (tm->dev_net_tun_fd, FIONBIO, &one) < 0)
 579       {
 580         error = clib_error_return_unix (0, "ioctl FIONBIO");
 581         goto done;
 582       }
 583   }
 584
 585   tm->mtu_buffers = (tm->mtu_bytes + (buffer_size - 1)) / buffer_size;
 586
 587   ifr.ifr_mtu = tm->mtu_bytes;
 588   if (ioctl (tm->dev_tap_fd, SIOCSIFMTU, &ifr) < 0)
 589     {
 590       error = clib_error_return_unix (0, "ioctl SIOCSIFMTU");
 591       goto done;
 592     }
 593
 594   /* get flags, modify to bring up interface... */
 595   if (ioctl (tm->dev_tap_fd, SIOCGIFFLAGS, &ifr) < 0)
 596     {
 597       error = clib_error_return_unix (0, "ioctl SIOCGIFFLAGS");
 598       goto done;
 599     }
 600
 601   ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);
 602
 603   if (ioctl (tm->dev_tap_fd, SIOCSIFFLAGS, &ifr) < 0)
 604     {
 605       error = clib_error_return_unix (0, "ioctl SIOCSIFFLAGS");
 606       goto done;
 607     }
 608
 609   if (is_ether)
 610     {
 611       if (ioctl (tm->dev_tap_fd, SIOCGIFHWADDR, &ifr) < 0)
 612         {
 613           error = clib_error_return_unix (0, "ioctl SIOCGIFHWADDR");
 614           goto done;
 615         }
 616       else
 617         clib_memcpy_fast (tm->ether_dst_mac, ifr.ifr_hwaddr.sa_data, 6);
 618     }
 619
 620   if (have_normal_interface)
 621     {
 622       vnet_main_t *vnm = vnet_get_main ();
 623       vnet_eth_interface_registration_t eir = {};
 624
 625       eir.dev_class_index = tuntap_dev_class.index;
 626       eir.address = tm->ether_dst_mac;
 627       tm->hw_if_index = vnet_eth_register_interface (vnm, &eir);
 628
 629       tm->sw_if_index = tm->hw_if_index;
 630       vm->os_punt_frame = tuntap_nopunt_frame;
 631     }
 632   else
 633     {
 634       vnet_main_t *vnm = vnet_get_main ();
 635       vnet_hw_interface_t *hi;
 636
 637       vm->os_punt_frame = tuntap_punt_frame;
 638
 639       tm->hw_if_index = vnet_register_interface
 640         (vnm, tuntap_dev_class.index, 0 /* device instance */ ,
 641          tuntap_interface_class.index, 0);
 642       hi = vnet_get_hw_interface (vnm, tm->hw_if_index);
 643       tm->sw_if_index = hi->sw_if_index;
 644
 645       /* Interface is always up. */
 646       vnet_hw_interface_set_flags (vnm, tm->hw_if_index,
 647                                    VNET_HW_INTERFACE_FLAG_LINK_UP);
 648       vnet_sw_interface_set_flags (vnm, tm->sw_if_index,
 649                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
 650     }
 651
 652   {
 653     clib_file_t template = { 0 };
 654     template.read_function = tuntap_read_ready;
 655     template.file_descriptor = tm->dev_net_tun_fd;
 656     template.description = format (0, "vnet tuntap");
 657     tm->clib_file_index = clib_file_add (&file_main, &template);
 658   }
 659
 660 done:
 661   if (error)
 662     {
 663       if (tm->dev_net_tun_fd >= 0)
 664         close (tm->dev_net_tun_fd);
 665       if (tm->dev_tap_fd >= 0)
 666         close (tm->dev_tap_fd);
 667     }
 668
 669   return error;
 670 }
 671
 672 VLIB_CONFIG_FUNCTION (tuntap_config, "tuntap");
 673
 674 /**
 675  * @brief Add or Del IP4 address to tun/tap interface
 676  *
 677  * @param *im - ip4_main_t
 678  * @param opaque - uword
 679  * @param sw_if_index - u32
 680  * @param *address - ip4_address_t
 681  * @param is_delete - u32
 682  *
 683  */
 684 void
 685 tuntap_ip4_add_del_interface_address (ip4_main_t * im,
 686                                       uword opaque,
 687                                       u32 sw_if_index,
 688                                       ip4_address_t * address,
 689                                       u32 address_length,
 690                                       u32 if_address_index, u32 is_delete)
 691 {
 692   tuntap_main_t *tm = &tuntap_main;
 693   struct ifreq ifr;
 694   subif_address_t subif_addr, *ap;
 695   uword *p;
 696
 697   /** Tuntap disabled, or using a "normal" interface. */
 698   if (tm->have_normal_interface || tm->dev_tap_fd < 0)
 699     return;
 700
 701   /* if the address is being applied to an interface that is not in
 702    * the same table/VRF as this tap, then ignore it.
 703    * If we don't do this overlapping address spaces in the different tables
 704    * breaks the linux host's routing tables */
 705   if (fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4,
 706                                            sw_if_index) !=
 707       fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP4, tm->sw_if_index))
 708     return;
 709
 710   /** See if we already know about this subif */
 711   clib_memset (&subif_addr, 0, sizeof (subif_addr));
 712   subif_addr.sw_if_index = sw_if_index;
 713   clib_memcpy_fast (&subif_addr.addr, address, sizeof (*address));
 714
 715   p = mhash_get (&tm->subif_mhash, &subif_addr);
 716
 717   if (p)
 718     ap = pool_elt_at_index (tm->subifs, p[0]);
 719   else
 720     {
 721       pool_get (tm->subifs, ap);
 722       *ap = subif_addr;
 723       mhash_set (&tm->subif_mhash, ap, ap - tm->subifs, 0);
 724     }
 725
 726   /* Use subif pool index to select alias device. */
 727   clib_memset (&ifr, 0, sizeof (ifr));
 728   snprintf (ifr.ifr_name, sizeof (ifr.ifr_name),
 729             "%s:%d", tm->tun_name, (int) (ap - tm->subifs));
 730
 731   /* the tuntap punt/inject is enabled for IPv4 RX so long as
 732    * any vpp interface has an IPv4 address.
 733    * this is also ref counted.
 734    */
 735   ip4_sw_interface_enable_disable (tm->sw_if_index, !is_delete);
 736
 737   if (!is_delete)
 738     {
 739       struct sockaddr_in *sin;
 740
 741       sin = (struct sockaddr_in *) &ifr.ifr_addr;
 742
 743       /* Set ipv4 address, netmask. */
 744       sin->sin_family = AF_INET;
 745       clib_memcpy_fast (&sin->sin_addr.s_addr, address, 4);
 746       if (ioctl (tm->dev_tap_fd, SIOCSIFADDR, &ifr) < 0)
 747         clib_unix_warning ("ioctl SIOCSIFADDR");
 748
 749       sin->sin_addr.s_addr = im->fib_masks[address_length];
 750       if (ioctl (tm->dev_tap_fd, SIOCSIFNETMASK, &ifr) < 0)
 751         clib_unix_warning ("ioctl SIOCSIFNETMASK");
 752     }
 753   else
 754     {
 755       mhash_unset (&tm->subif_mhash, &subif_addr, 0 /* old value ptr */ );
 756       pool_put (tm->subifs, ap);
 757     }
 758
 759   /* get flags, modify to bring up interface... */
 760   if (ioctl (tm->dev_tap_fd, SIOCGIFFLAGS, &ifr) < 0)
 761     clib_unix_warning ("ioctl SIOCGIFFLAGS");
 762
 763   if (is_delete)
 764     ifr.ifr_flags &= ~(IFF_UP | IFF_RUNNING);
 765   else
 766     ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);
 767
 768   if (ioctl (tm->dev_tap_fd, SIOCSIFFLAGS, &ifr) < 0)
 769     clib_unix_warning ("ioctl SIOCSIFFLAGS");
 770 }
 771
 772 /**
 773  * @brief workaround for a known include file bug.
 774  * including @c <linux/ipv6.h> causes multiple definitions if
 775  * @c <netinet/in.h is also included.
 776  */
 777 struct in6_ifreq
 778 {
 779   struct in6_addr ifr6_addr;
 780   u32 ifr6_prefixlen;
 781   int ifr6_ifindex;
 782 };
 783
 784 /**
 785  * @brief Add or Del tun/tap interface address.
 786  *
 787  * Both the v6 interface address API and the way ifconfig
 788  * displays subinterfaces differ from their v4 counterparts.
 789  * The code given here seems to work but YMMV.
 790  *
 791  * @param *im - ip6_main_t
 792  * @param opaque - uword
 793  * @param sw_if_index - u32
 794  * @param *address - ip6_address_t
 795  * @param address_length - u32
 796  * @param if_address_index - u32
 797  * @param is_delete - u32
 798  */
 799 void
 800 tuntap_ip6_add_del_interface_address (ip6_main_t * im,
 801                                       uword opaque,
 802                                       u32 sw_if_index,
 803                                       ip6_address_t * address,
 804                                       u32 address_length,
 805                                       u32 if_address_index, u32 is_delete)
 806 {
 807   tuntap_main_t *tm = &tuntap_main;
 808   struct ifreq ifr;
 809   struct in6_ifreq ifr6;
 810   subif_address_t subif_addr, *ap;
 811   uword *p;
 812
 813   /* Tuntap disabled, or using a "normal" interface. */
 814   if (tm->have_normal_interface || tm->dev_tap_fd < 0)
 815     return;
 816
 817   /* if the address is being applied to an interface that is not in
 818    * the same table/VRF as this tap, then ignore it.
 819    * If we don't do this overlapping address spaces in the different tables
 820    * breaks the linux host's routing tables */
 821   if (fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP6,
 822                                            sw_if_index) !=
 823       fib_table_get_index_for_sw_if_index (FIB_PROTOCOL_IP6, tm->sw_if_index))
 824     return;
 825
 826   /* See if we already know about this subif */
 827   clib_memset (&subif_addr, 0, sizeof (subif_addr));
 828   subif_addr.sw_if_index = sw_if_index;
 829   subif_addr.is_v6 = 1;
 830   clib_memcpy_fast (&subif_addr.addr, address, sizeof (*address));
 831
 832   p = mhash_get (&tm->subif_mhash, &subif_addr);
 833
 834   if (p)
 835     ap = pool_elt_at_index (tm->subifs, p[0]);
 836   else
 837     {
 838       pool_get (tm->subifs, ap);
 839       *ap = subif_addr;
 840       mhash_set (&tm->subif_mhash, ap, ap - tm->subifs, 0);
 841     }
 842
 843   /* Use subif pool index to select alias device. */
 844   clib_memset (&ifr, 0, sizeof (ifr));
 845   clib_memset (&ifr6, 0, sizeof (ifr6));
 846   snprintf (ifr.ifr_name, sizeof (ifr.ifr_name),
 847             "%s:%d", tm->tun_name, (int) (ap - tm->subifs));
 848
 849   /* the tuntap punt/inject is enabled for IPv6 RX so long as
 850    * any vpp interface has an IPv6 address.
 851    * this is also ref counted.
 852    */
 853   ip6_sw_interface_enable_disable (tm->sw_if_index, !is_delete);
 854
 855   if (!is_delete)
 856     {
 857       int sockfd = socket (AF_INET6, SOCK_STREAM, 0);
 858       if (sockfd < 0)
 859         clib_unix_warning ("get ifindex socket");
 860
 861       if (ioctl (sockfd, SIOGIFINDEX, &ifr) < 0)
 862         clib_unix_warning ("get ifindex");
 863
 864       ifr6.ifr6_ifindex = ifr.ifr_ifindex;
 865       ifr6.ifr6_prefixlen = address_length;
 866       clib_memcpy_fast (&ifr6.ifr6_addr, address, 16);
 867
 868       if (ioctl (sockfd, SIOCSIFADDR, &ifr6) < 0)
 869         clib_unix_warning ("set address");
 870
 871       if (sockfd >= 0)
 872         close (sockfd);
 873     }
 874   else
 875     {
 876       int sockfd = socket (AF_INET6, SOCK_STREAM, 0);
 877       if (sockfd < 0)
 878         clib_unix_warning ("get ifindex socket");
 879
 880       if (ioctl (sockfd, SIOGIFINDEX, &ifr) < 0)
 881         clib_unix_warning ("get ifindex");
 882
 883       ifr6.ifr6_ifindex = ifr.ifr_ifindex;
 884       ifr6.ifr6_prefixlen = address_length;
 885       clib_memcpy_fast (&ifr6.ifr6_addr, address, 16);
 886
 887       if (ioctl (sockfd, SIOCDIFADDR, &ifr6) < 0)
 888         clib_unix_warning ("del address");
 889
 890       if (sockfd >= 0)
 891         close (sockfd);
 892
 893       mhash_unset (&tm->subif_mhash, &subif_addr, 0 /* old value ptr */ );
 894       pool_put (tm->subifs, ap);
 895     }
 896 }
 897
 898 /**
 899  * @brief TX the tun/tap frame
 900  *
 901  * @param *vm - vlib_main_t
 902  * @param *node - vlib_node_runtime_t
 903  * @param *frame - vlib_frame_t
 904  *
 905  */
 906 static void
 907 tuntap_punt_frame (vlib_main_t * vm,
 908                    vlib_node_runtime_t * node, vlib_frame_t * frame)
 909 {
 910   tuntap_tx (vm, node, frame);
 911   vlib_frame_free (vm, frame);
 912 }
 913
 914 /**
 915  * @brief Free the tun/tap frame
 916  *
 917  * @param *vm - vlib_main_t
 918  * @param *node - vlib_node_runtime_t
 919  * @param *frame - vlib_frame_t
 920  *
 921  */
 922 static void
 923 tuntap_nopunt_frame (vlib_main_t * vm,
 924                      vlib_node_runtime_t * node, vlib_frame_t * frame)
 925 {
 926   u32 *buffers = vlib_frame_vector_args (frame);
 927   uword n_packets = frame->n_vectors;
 928   vlib_buffer_free (vm, buffers, n_packets);
 929   vlib_frame_free (vm, frame);
 930 }
 931
 932 VNET_HW_INTERFACE_CLASS (tuntap_interface_class,static) = {
 933   .name = "tuntap",
 934   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
 935 };
 936
 937 /**
 938  * @brief Format tun/tap interface name
 939  *
 940  * @param *s - u8 - formatter string
 941  * @param *args - va_list
 942  *
 943  * @return *s - u8 - formatted string
 944  *
 945  */
 946 static u8 *
 947 format_tuntap_interface_name (u8 * s, va_list * args)
 948 {
 949   u32 i = va_arg (*args, u32);
 950
 951   s = format (s, "tuntap-%d", i);
 952   return s;
 953 }
 954
 955 /**
 956  * @brief TX packet out tun/tap
 957  *
 958  * @param *vm - vlib_main_t
 959  * @param *node - vlib_node_runtime_t
 960  * @param *frame - vlib_frame_t
 961  *
 962  * @return n_buffers - uword - Packets transmitted
 963  *
 964  */
 965 static uword
 966 tuntap_intfc_tx (vlib_main_t * vm,
 967                  vlib_node_runtime_t * node, vlib_frame_t * frame)
 968 {
 969   tuntap_main_t *tm = &tuntap_main;
 970   u32 *buffers = vlib_frame_vector_args (frame);
 971   uword n_buffers = frame->n_vectors;
 972
 973   /* Normal interface transmit happens only on the normal interface... */
 974   if (tm->have_normal_interface)
 975     return tuntap_tx (vm, node, frame);
 976
 977   vlib_buffer_free (vm, buffers, n_buffers);
 978   return n_buffers;
 979 }
 980
 981 VNET_DEVICE_CLASS (tuntap_dev_class,static) = {
 982   .name = "tuntap",
 983   .tx_function = tuntap_intfc_tx,
 984   .format_device_name = format_tuntap_interface_name,
 985 };
 986
 987 /**
 988  * @brief tun/tap node init
 989  *
 990  * @param *vm - vlib_main_t
 991  *
 992  * @return error - clib_error_t
 993  *
 994  */
 995 static clib_error_t *
 996 tuntap_init (vlib_main_t * vm)
 997 {
 998   ip4_main_t *im4 = &ip4_main;
 999   ip6_main_t *im6 = &ip6_main;
1000   ip4_add_del_interface_address_callback_t cb4;
1001   ip6_add_del_interface_address_callback_t cb6;
1002   tuntap_main_t *tm = &tuntap_main;
1003   vlib_thread_main_t *m = vlib_get_thread_main ();
1004
1005   mhash_init (&tm->subif_mhash, sizeof (u32), sizeof (subif_address_t));
1006
1007   cb4.function = tuntap_ip4_add_del_interface_address;
1008   cb4.function_opaque = 0;
1009   vec_add1 (im4->add_del_interface_address_callbacks, cb4);
1010
1011   cb6.function = tuntap_ip6_add_del_interface_address;
1012   cb6.function_opaque = 0;
1013   vec_add1 (im6->add_del_interface_address_callbacks, cb6);
1014   vec_validate_aligned (tm->threads, m->n_vlib_mains - 1,
1015                         CLIB_CACHE_LINE_BYTES);
1016
1017   return 0;
1018 }
1019
1020 VLIB_INIT_FUNCTION (tuntap_init) =
1021 {
1022   .runs_after = VLIB_INITS("ip4_init"),
1023 };
1024
1025 /*
1026  * fd.io coding-style-patch-verification: ON
1027  *
1028  * Local Variables:
1029  * eval: (c-set-style "gnu")
1030  * End:
1031  */