src/vnet/unix/tapcli.c

   1 /*
   2  *------------------------------------------------------------------
   3  * tapcli.c - dynamic tap interface hookup
   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  dynamic tap interface hookup
  22  */
  23
  24 #include <fcntl.h>              /* for open */
  25 #include <sys/ioctl.h>
  26 #include <sys/socket.h>
  27 #include <sys/stat.h>
  28 #include <sys/types.h>
  29 #include <sys/uio.h>            /* for iovec */
  30 #include <netinet/in.h>
  31
  32 #include <linux/if_arp.h>
  33 #include <linux/if_tun.h>
  34
  35 #include <vlib/vlib.h>
  36 #include <vlib/unix/unix.h>
  37
  38 #include <vnet/ip/ip.h>
  39
  40 #include <vnet/ethernet/ethernet.h>
  41
  42 #include <vnet/feature/feature.h>
  43 #include <vnet/devices/devices.h>
  44 #include <vnet/unix/tuntap.h>
  45 #include <vnet/unix/tapcli.h>
  46
  47 static vnet_device_class_t tapcli_dev_class;
  48 static vnet_hw_interface_class_t tapcli_interface_class;
  49 static vlib_node_registration_t tapcli_rx_node;
  50
  51 static void tapcli_nopunt_frame (vlib_main_t * vm,
  52                                  vlib_node_runtime_t * node,
  53                                  vlib_frame_t * frame);
  54 /**
  55  * @brief Struct for the tapcli interface
  56  */
  57 typedef struct
  58 {
  59   u32 unix_fd;
  60   u32 clib_file_index;
  61   u32 provision_fd;
  62   /** For counters */
  63   u32 sw_if_index;
  64   u32 hw_if_index;
  65   u32 is_promisc;
  66   struct ifreq ifr;
  67   u32 per_interface_next_index;
  68   /** for delete */
  69   u8 active;
  70 } tapcli_interface_t;
  71
  72 /**
  73  * @brief Struct for RX trace
  74  */
  75 typedef struct
  76 {
  77   u16 sw_if_index;
  78 } tapcli_rx_trace_t;
  79
  80 /**
  81  * @brief Function to format TAP CLI trace
  82  *
  83  * @param *s - u8 - formatting string
  84  * @param *va - va_list
  85  *
  86  * @return *s - u8 - formatted string
  87  *
  88  */
  89 u8 *
  90 format_tapcli_rx_trace (u8 * s, va_list * va)
  91 {
  92   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
  93   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
  94   vnet_main_t *vnm = vnet_get_main ();
  95   tapcli_rx_trace_t *t = va_arg (*va, tapcli_rx_trace_t *);
  96   s = format (s, "%U", format_vnet_sw_if_index_name, vnm, t->sw_if_index);
  97   return s;
  98 }
  99
 100 /**
 101  * @brief TAPCLI per thread struct
 102  */
 103 typedef struct
 104 {
 105   /** Vector of VLIB rx buffers to use.  We allocate them in blocks
 106      of VLIB_FRAME_SIZE (256). */
 107   u32 *rx_buffers;
 108
 109   /** Vector of iovecs for readv/writev calls. */
 110   struct iovec *iovecs;
 111 } tapcli_per_thread_t;
 112
 113 /**
 114  * @brief TAPCLI main state struct
 115  */
 116 typedef struct
 117 {
 118   /** per thread variables */
 119   tapcli_per_thread_t *threads;
 120
 121   /** tap device destination MAC address. Required, or Linux drops pkts */
 122   u8 ether_dst_mac[6];
 123
 124   /** Interface MTU in bytes and # of default sized buffers. */
 125   u32 mtu_bytes, mtu_buffers;
 126
 127   /** Vector of tap interfaces */
 128   tapcli_interface_t *tapcli_interfaces;
 129
 130   /** Vector of deleted tap interfaces */
 131   u32 *tapcli_inactive_interfaces;
 132
 133   /** Bitmap of tap interfaces with pending reads */
 134   uword *pending_read_bitmap;
 135
 136   /** Hash table to find tapcli interface given hw_if_index */
 137   uword *tapcli_interface_index_by_sw_if_index;
 138
 139   /** Hash table to find tapcli interface given unix fd */
 140   uword *tapcli_interface_index_by_unix_fd;
 141
 142   /** renumbering table */
 143   u32 *show_dev_instance_by_real_dev_instance;
 144
 145   /** 1 => disable CLI */
 146   int is_disabled;
 147
 148   /** convenience - vlib_main_t */
 149   vlib_main_t *vlib_main;
 150   /** convenience - vnet_main_t */
 151   vnet_main_t *vnet_main;
 152 } tapcli_main_t;
 153
 154 static tapcli_main_t tapcli_main;
 155
 156 /**
 157  * @brief tapcli TX node function
 158  * @node tap-cli-tx
 159  *
 160  * Output node, writes the buffers comprising the incoming frame
 161  * to the tun/tap device, aka hands them to the Linux kernel stack.
 162  *
 163  * @param *vm - vlib_main_t
 164  * @param *node - vlib_node_runtime_t
 165  * @param *frame - vlib_frame_t
 166  *
 167  * @return n_packets - uword
 168  *
 169  */
 170 static uword
 171 tapcli_tx (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
 172 {
 173   u32 *buffers = vlib_frame_args (frame);
 174   uword n_packets = frame->n_vectors;
 175   tapcli_main_t *tm = &tapcli_main;
 176   tapcli_interface_t *ti;
 177   int i;
 178   u16 thread_index = vm->thread_index;
 179
 180   for (i = 0; i < n_packets; i++)
 181     {
 182       struct iovec *iov;
 183       vlib_buffer_t *b;
 184       uword l;
 185       vnet_hw_interface_t *hw;
 186       uword *p;
 187       u32 tx_sw_if_index;
 188
 189       b = vlib_get_buffer (vm, buffers[i]);
 190
 191       tx_sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
 192       if (tx_sw_if_index == (u32) ~ 0)
 193         tx_sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
 194
 195       ASSERT (tx_sw_if_index != (u32) ~ 0);
 196
 197       /* Use the sup intfc to finesse vlan subifs */
 198       hw = vnet_get_sup_hw_interface (tm->vnet_main, tx_sw_if_index);
 199       tx_sw_if_index = hw->sw_if_index;
 200
 201       p = hash_get (tm->tapcli_interface_index_by_sw_if_index,
 202                     tx_sw_if_index);
 203       if (p == 0)
 204         {
 205           clib_warning ("sw_if_index %d unknown", tx_sw_if_index);
 206           /* $$$ leak, but this should never happen... */
 207           continue;
 208         }
 209       else
 210         ti = vec_elt_at_index (tm->tapcli_interfaces, p[0]);
 211
 212       /* Re-set iovecs if present. */
 213       if (tm->threads[thread_index].iovecs)
 214         _vec_len (tm->threads[thread_index].iovecs) = 0;
 215
 216       /* VLIB buffer chain -> Unix iovec(s). */
 217       vec_add2 (tm->threads[thread_index].iovecs, iov, 1);
 218       iov->iov_base = b->data + b->current_data;
 219       iov->iov_len = l = b->current_length;
 220
 221       if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
 222         {
 223           do
 224             {
 225               b = vlib_get_buffer (vm, b->next_buffer);
 226
 227               vec_add2 (tm->threads[thread_index].iovecs, iov, 1);
 228
 229               iov->iov_base = b->data + b->current_data;
 230               iov->iov_len = b->current_length;
 231               l += b->current_length;
 232             }
 233           while (b->flags & VLIB_BUFFER_NEXT_PRESENT);
 234         }
 235
 236       if (writev (ti->unix_fd, tm->threads[thread_index].iovecs,
 237                   vec_len (tm->threads[thread_index].iovecs)) < l)
 238         clib_unix_warning ("writev");
 239     }
 240
 241   vlib_buffer_free (vm, vlib_frame_vector_args (frame), frame->n_vectors);
 242
 243   return n_packets;
 244 }
 245
 246 /* *INDENT-OFF* */
 247 VLIB_REGISTER_NODE (tapcli_tx_node,static) = {
 248   .function = tapcli_tx,
 249   .name = "tapcli-tx",
 250   .type = VLIB_NODE_TYPE_INTERNAL,
 251   .vector_size = 4,
 252 };
 253 /* *INDENT-ON* */
 254
 255 /**
 256  * @brief Dispatch tapcli RX node function for node tap_cli_rx
 257  *
 258  *
 259  * @param *vm - vlib_main_t
 260  * @param *node - vlib_node_runtime_t
 261  * @param *ti - tapcli_interface_t
 262  *
 263  * @return n_packets - uword
 264  *
 265  */
 266 static uword
 267 tapcli_rx_iface (vlib_main_t * vm,
 268                  vlib_node_runtime_t * node, tapcli_interface_t * ti)
 269 {
 270   tapcli_main_t *tm = &tapcli_main;
 271   const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
 272   u32 n_trace = vlib_get_trace_count (vm, node);
 273   u8 set_trace = 0;
 274   u16 thread_index = vm->thread_index;
 275   vnet_main_t *vnm;
 276   vnet_sw_interface_t *si;
 277   u8 admin_down;
 278   u32 next = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
 279   u32 n_left_to_next, next_index;
 280   u32 *to_next;
 281
 282   vnm = vnet_get_main ();
 283   si = vnet_get_sw_interface (vnm, ti->sw_if_index);
 284   admin_down = !(si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP);
 285
 286   vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
 287
 288   while (n_left_to_next)
 289     {                           // Fill at most one vector
 290       vlib_buffer_t *b_first, *b, *prev;
 291       u32 bi_first, bi;
 292       word n_bytes_in_packet;
 293       int j, n_bytes_left;
 294
 295       if (PREDICT_FALSE (vec_len (tm->threads[thread_index].rx_buffers) <
 296                          tm->mtu_buffers))
 297         {
 298           uword len = vec_len (tm->threads[thread_index].rx_buffers);
 299           _vec_len (tm->threads[thread_index].rx_buffers) +=
 300             vlib_buffer_alloc_from_free_list (vm,
 301                                               &tm->threads[thread_index].
 302                                               rx_buffers[len],
 303                                               VLIB_FRAME_SIZE - len,
 304                                               VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
 305           if (PREDICT_FALSE
 306               (vec_len (tm->threads[thread_index].rx_buffers) <
 307                tm->mtu_buffers))
 308             {
 309               vlib_node_increment_counter (vm, tapcli_rx_node.index,
 310                                            TAPCLI_ERROR_BUFFER_ALLOC,
 311                                            tm->mtu_buffers -
 312                                            vec_len (tm->threads
 313                                                     [thread_index].
 314                                                     rx_buffers));
 315               break;
 316             }
 317         }
 318
 319       uword i_rx = vec_len (tm->threads[thread_index].rx_buffers) - 1;
 320
 321       /* Allocate RX buffers from end of rx_buffers.
 322          Turn them into iovecs to pass to readv. */
 323       vec_validate (tm->threads[thread_index].iovecs, tm->mtu_buffers - 1);
 324       for (j = 0; j < tm->mtu_buffers; j++)
 325         {
 326           b =
 327             vlib_get_buffer (vm,
 328                              tm->threads[thread_index].rx_buffers[i_rx - j]);
 329           tm->threads[thread_index].iovecs[j].iov_base = b->data;
 330           tm->threads[thread_index].iovecs[j].iov_len = buffer_size;
 331         }
 332
 333       n_bytes_left = readv (ti->unix_fd, tm->threads[thread_index].iovecs,
 334                             tm->mtu_buffers);
 335       n_bytes_in_packet = n_bytes_left;
 336       if (n_bytes_left <= 0)
 337         {
 338           if (errno != EAGAIN)
 339             {
 340               vlib_node_increment_counter (vm, tapcli_rx_node.index,
 341                                            TAPCLI_ERROR_READ, 1);
 342             }
 343           break;
 344         }
 345
 346       bi_first = tm->threads[thread_index].rx_buffers[i_rx];
 347       b = b_first = vlib_get_buffer (vm,
 348                                      tm->threads[thread_index].
 349                                      rx_buffers[i_rx]);
 350       prev = NULL;
 351
 352       while (1)
 353         {
 354           b->current_length =
 355             n_bytes_left < buffer_size ? n_bytes_left : buffer_size;
 356           n_bytes_left -= buffer_size;
 357
 358           if (prev)
 359             {
 360               prev->next_buffer = bi;
 361               prev->flags |= VLIB_BUFFER_NEXT_PRESENT;
 362             }
 363           prev = b;
 364
 365           /* last segment */
 366           if (n_bytes_left <= 0)
 367             break;
 368
 369           i_rx--;
 370           bi = tm->threads[thread_index].rx_buffers[i_rx];
 371           b = vlib_get_buffer (vm, bi);
 372         }
 373
 374       _vec_len (tm->threads[thread_index].rx_buffers) = i_rx;
 375
 376       b_first->total_length_not_including_first_buffer =
 377         (n_bytes_in_packet >
 378          buffer_size) ? n_bytes_in_packet - buffer_size : 0;
 379       b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
 380
 381       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b_first);
 382
 383       vnet_buffer (b_first)->sw_if_index[VLIB_RX] = ti->sw_if_index;
 384       vnet_buffer (b_first)->sw_if_index[VLIB_TX] = (u32) ~ 0;
 385
 386       b_first->error = node->errors[TAPCLI_ERROR_NONE];
 387       next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
 388       next_index = (ti->per_interface_next_index != ~0) ?
 389         ti->per_interface_next_index : next_index;
 390       next_index = admin_down ? VNET_DEVICE_INPUT_NEXT_DROP : next_index;
 391
 392       to_next[0] = bi_first;
 393       to_next++;
 394       n_left_to_next--;
 395
 396       vnet_feature_start_device_input_x1 (ti->sw_if_index, &next_index,
 397                                           b_first);
 398
 399       vlib_validate_buffer_enqueue_x1 (vm, node, next,
 400                                        to_next, n_left_to_next,
 401                                        bi_first, next_index);
 402
 403       /* Interface counters for tapcli interface. */
 404       if (PREDICT_TRUE (!admin_down))
 405         {
 406           vlib_increment_combined_counter (vnet_main.interface_main.
 407                                            combined_sw_if_counters +
 408                                            VNET_INTERFACE_COUNTER_RX,
 409                                            thread_index, ti->sw_if_index, 1,
 410                                            n_bytes_in_packet);
 411
 412           if (PREDICT_FALSE (n_trace > 0))
 413             {
 414               vlib_trace_buffer (vm, node, next_index,
 415                                  b_first, /* follow_chain */ 1);
 416               n_trace--;
 417               set_trace = 1;
 418               tapcli_rx_trace_t *t0 =
 419                 vlib_add_trace (vm, node, b_first, sizeof (*t0));
 420               t0->sw_if_index = si->sw_if_index;
 421             }
 422         }
 423     }
 424   vlib_put_next_frame (vm, node, next, n_left_to_next);
 425   if (set_trace)
 426     vlib_set_trace_count (vm, node, n_trace);
 427   return VLIB_FRAME_SIZE - n_left_to_next;
 428 }
 429
 430 /**
 431  * @brief tapcli RX node function
 432  * @node tap-cli-rx
 433  *
 434  * Input node from the Kernel tun/tap device
 435  *
 436  * @param *vm - vlib_main_t
 437  * @param *node - vlib_node_runtime_t
 438  * @param *frame - vlib_frame_t
 439  *
 440  * @return n_packets - uword
 441  *
 442  */
 443 static uword
 444 tapcli_rx (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
 445 {
 446   tapcli_main_t *tm = &tapcli_main;
 447   static u32 *ready_interface_indices;
 448   tapcli_interface_t *ti;
 449   int i;
 450   u32 total_count = 0;
 451
 452   vec_reset_length (ready_interface_indices);
 453   /* *INDENT-OFF* */
 454   clib_bitmap_foreach (i, tm->pending_read_bitmap,
 455   ({
 456     vec_add1 (ready_interface_indices, i);
 457   }));
 458   /* *INDENT-ON* */
 459
 460   if (vec_len (ready_interface_indices) == 0)
 461     return 0;
 462
 463   for (i = 0; i < vec_len (ready_interface_indices); i++)
 464     {
 465       tm->pending_read_bitmap =
 466         clib_bitmap_set (tm->pending_read_bitmap,
 467                          ready_interface_indices[i], 0);
 468
 469       ti =
 470         vec_elt_at_index (tm->tapcli_interfaces, ready_interface_indices[i]);
 471       total_count += tapcli_rx_iface (vm, node, ti);
 472     }
 473   return total_count;           //This might return more than 256.
 474 }
 475
 476 /** TAPCLI error strings */
 477 static char *tapcli_rx_error_strings[] = {
 478 #define _(sym,string) string,
 479   foreach_tapcli_error
 480 #undef _
 481 };
 482
 483 /* *INDENT-OFF* */
 484 VLIB_REGISTER_NODE (tapcli_rx_node, static) = {
 485   .function = tapcli_rx,
 486   .name = "tapcli-rx",
 487   .sibling_of = "device-input",
 488   .type = VLIB_NODE_TYPE_INPUT,
 489   .state = VLIB_NODE_STATE_INTERRUPT,
 490   .vector_size = 4,
 491   .n_errors = TAPCLI_N_ERROR,
 492   .error_strings = tapcli_rx_error_strings,
 493   .format_trace = format_tapcli_rx_trace,
 494 };
 495 /* *INDENT-ON* */
 496
 497
 498 /**
 499  * @brief Gets called when file descriptor is ready from epoll.
 500  *
 501  * @param *uf - clib_file_t
 502  *
 503  * @return error - clib_error_t
 504  *
 505  */
 506 static clib_error_t *
 507 tapcli_read_ready (clib_file_t * uf)
 508 {
 509   vlib_main_t *vm = vlib_get_main ();
 510   tapcli_main_t *tm = &tapcli_main;
 511   uword *p;
 512
 513   /** Schedule the rx node */
 514   vlib_node_set_interrupt_pending (vm, tapcli_rx_node.index);
 515
 516   p = hash_get (tm->tapcli_interface_index_by_unix_fd, uf->file_descriptor);
 517
 518   /** Mark the specific tap interface ready-to-read */
 519   if (p)
 520     tm->pending_read_bitmap = clib_bitmap_set (tm->pending_read_bitmap,
 521                                                p[0], 1);
 522   else
 523     clib_warning ("fd %d not in hash table", uf->file_descriptor);
 524
 525   return 0;
 526 }
 527
 528 /**
 529  * @brief CLI function for TAPCLI configuration
 530  *
 531  * @param *vm - vlib_main_t
 532  * @param *input - unformat_input_t
 533  *
 534  * @return error - clib_error_t
 535  *
 536  */
 537 static clib_error_t *
 538 tapcli_config (vlib_main_t * vm, unformat_input_t * input)
 539 {
 540   tapcli_main_t *tm = &tapcli_main;
 541   const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
 542
 543   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 544     {
 545       if (unformat (input, "mtu %d", &tm->mtu_bytes))
 546         ;
 547       else if (unformat (input, "disable"))
 548         tm->is_disabled = 1;
 549       else
 550         return clib_error_return (0, "unknown input `%U'",
 551                                   format_unformat_error, input);
 552     }
 553
 554   if (tm->is_disabled)
 555     return 0;
 556
 557   if (geteuid ())
 558     {
 559       clib_warning ("tapcli disabled: must be superuser");
 560       tm->is_disabled = 1;
 561       return 0;
 562     }
 563
 564   tm->mtu_buffers = (tm->mtu_bytes + (buffer_size - 1)) / buffer_size;
 565
 566   return 0;
 567 }
 568
 569 /**
 570  * @brief Renumber TAPCLI interface
 571  *
 572  * @param *hi - vnet_hw_interface_t
 573  * @param new_dev_instance - u32
 574  *
 575  * @return rc - int
 576  *
 577  */
 578 static int
 579 tap_name_renumber (vnet_hw_interface_t * hi, u32 new_dev_instance)
 580 {
 581   tapcli_main_t *tm = &tapcli_main;
 582
 583   vec_validate_init_empty (tm->show_dev_instance_by_real_dev_instance,
 584                            hi->dev_instance, ~0);
 585
 586   tm->show_dev_instance_by_real_dev_instance[hi->dev_instance] =
 587     new_dev_instance;
 588
 589   return 0;
 590 }
 591
 592 VLIB_CONFIG_FUNCTION (tapcli_config, "tapcli");
 593
 594 /**
 595  * @brief Free "no punt" frame
 596  *
 597  * @param *vm - vlib_main_t
 598  * @param *node - vlib_node_runtime_t
 599  * @param *frame - vlib_frame_t
 600  *
 601  */
 602 static void
 603 tapcli_nopunt_frame (vlib_main_t * vm,
 604                      vlib_node_runtime_t * node, vlib_frame_t * frame)
 605 {
 606   u32 *buffers = vlib_frame_args (frame);
 607   uword n_packets = frame->n_vectors;
 608   vlib_buffer_free (vm, buffers, n_packets);
 609   vlib_frame_free (vm, node, frame);
 610 }
 611
 612 /* *INDENT-OFF* */
 613 VNET_HW_INTERFACE_CLASS (tapcli_interface_class,static) = {
 614   .name = "tapcli",
 615   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
 616 };
 617 /* *INDENT-ON* */
 618
 619 /**
 620  * @brief Formatter for TAPCLI interface name
 621  *
 622  * @param *s - formatter string
 623  * @param *args - va_list
 624  *
 625  * @return *s - formatted string
 626  *
 627  */
 628 static u8 *
 629 format_tapcli_interface_name (u8 * s, va_list * args)
 630 {
 631   u32 i = va_arg (*args, u32);
 632   u32 show_dev_instance = ~0;
 633   tapcli_main_t *tm = &tapcli_main;
 634
 635   if (i < vec_len (tm->show_dev_instance_by_real_dev_instance))
 636     show_dev_instance = tm->show_dev_instance_by_real_dev_instance[i];
 637
 638   if (show_dev_instance != ~0)
 639     i = show_dev_instance;
 640
 641   s = format (s, "tapcli-%d", i);
 642   return s;
 643 }
 644
 645 /**
 646  * @brief Modify interface flags for TAPCLI interface
 647  *
 648  * @param *vnm - vnet_main_t
 649  * @param *hw - vnet_hw_interface_t
 650  * @param flags - u32
 651  *
 652  * @return rc - u32
 653  *
 654  */
 655 static u32
 656 tapcli_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hw, u32 flags)
 657 {
 658   tapcli_main_t *tm = &tapcli_main;
 659   tapcli_interface_t *ti;
 660
 661   ti = vec_elt_at_index (tm->tapcli_interfaces, hw->dev_instance);
 662
 663   if (flags & ETHERNET_INTERFACE_FLAG_MTU)
 664     {
 665       const uword buffer_size = VLIB_BUFFER_DATA_SIZE;
 666       tm->mtu_bytes = hw->max_packet_bytes;
 667       tm->mtu_buffers = (tm->mtu_bytes + (buffer_size - 1)) / buffer_size;
 668     }
 669   else
 670     {
 671       struct ifreq ifr;
 672       u32 want_promisc;
 673
 674       memcpy (&ifr, &ti->ifr, sizeof (ifr));
 675
 676       /* get flags, modify to bring up interface... */
 677       if (ioctl (ti->provision_fd, SIOCGIFFLAGS, &ifr) < 0)
 678         {
 679           clib_unix_warning ("Couldn't get interface flags for %s", hw->name);
 680           return 0;
 681         }
 682
 683       want_promisc = (flags & ETHERNET_INTERFACE_FLAG_ACCEPT_ALL) != 0;
 684
 685       if (want_promisc == ti->is_promisc)
 686         return 0;
 687
 688       if (flags & ETHERNET_INTERFACE_FLAG_ACCEPT_ALL)
 689         ifr.ifr_flags |= IFF_PROMISC;
 690       else
 691         ifr.ifr_flags &= ~(IFF_PROMISC);
 692
 693       /* get flags, modify to bring up interface... */
 694       if (ioctl (ti->provision_fd, SIOCSIFFLAGS, &ifr) < 0)
 695         {
 696           clib_unix_warning ("Couldn't set interface flags for %s", hw->name);
 697           return 0;
 698         }
 699
 700       ti->is_promisc = want_promisc;
 701     }
 702
 703   return 0;
 704 }
 705
 706 /**
 707  * @brief Setting the TAP interface's next processing node
 708  *
 709  * @param *vnm - vnet_main_t
 710  * @param hw_if_index - u32
 711  * @param node_index - u32
 712  *
 713  */
 714 static void
 715 tapcli_set_interface_next_node (vnet_main_t * vnm,
 716                                 u32 hw_if_index, u32 node_index)
 717 {
 718   tapcli_main_t *tm = &tapcli_main;
 719   tapcli_interface_t *ti;
 720   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 721
 722   ti = vec_elt_at_index (tm->tapcli_interfaces, hw->dev_instance);
 723
 724   /** Shut off redirection */
 725   if (node_index == ~0)
 726     {
 727       ti->per_interface_next_index = node_index;
 728       return;
 729     }
 730
 731   ti->per_interface_next_index =
 732     vlib_node_add_next (tm->vlib_main, tapcli_rx_node.index, node_index);
 733 }
 734
 735 /**
 736  * @brief Set link_state == admin_state otherwise things like ip6 neighbor discovery breaks
 737  *
 738  * @param *vnm - vnet_main_t
 739  * @param hw_if_index - u32
 740  * @param flags - u32
 741  *
 742  * @return error - clib_error_t
 743  */
 744 static clib_error_t *
 745 tapcli_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 746 {
 747   uword is_admin_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
 748   u32 hw_flags;
 749   u32 speed_duplex = VNET_HW_INTERFACE_FLAG_FULL_DUPLEX
 750     | VNET_HW_INTERFACE_FLAG_SPEED_1G;
 751
 752   if (is_admin_up)
 753     hw_flags = VNET_HW_INTERFACE_FLAG_LINK_UP | speed_duplex;
 754   else
 755     hw_flags = speed_duplex;
 756
 757   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
 758   return 0;
 759 }
 760
 761 /* *INDENT-OFF* */
 762 VNET_DEVICE_CLASS (tapcli_dev_class,static) = {
 763   .name = "tapcli",
 764   .tx_function = tapcli_tx,
 765   .format_device_name = format_tapcli_interface_name,
 766   .rx_redirect_to_node = tapcli_set_interface_next_node,
 767   .name_renumber = tap_name_renumber,
 768   .admin_up_down_function = tapcli_interface_admin_up_down,
 769 };
 770 /* *INDENT-ON* */
 771
 772 /**
 773  * @brief Dump TAP interfaces
 774  *
 775  * @param **out_tapids - tapcli_interface_details_t
 776  *
 777  * @return rc - int
 778  *
 779  */
 780 int
 781 vnet_tap_dump_ifs (tapcli_interface_details_t ** out_tapids)
 782 {
 783   tapcli_main_t *tm = &tapcli_main;
 784   tapcli_interface_t *ti;
 785
 786   tapcli_interface_details_t *r_tapids = NULL;
 787   tapcli_interface_details_t *tapid = NULL;
 788
 789   vec_foreach (ti, tm->tapcli_interfaces)
 790   {
 791     if (!ti->active)
 792       continue;
 793     vec_add2 (r_tapids, tapid, 1);
 794     tapid->sw_if_index = ti->sw_if_index;
 795     strncpy ((char *) tapid->dev_name, ti->ifr.ifr_name,
 796              sizeof (ti->ifr.ifr_name) - 1);
 797   }
 798
 799   *out_tapids = r_tapids;
 800
 801   return 0;
 802 }
 803
 804 /**
 805  * @brief Get tap interface from inactive interfaces or create new
 806  *
 807  * @return interface - tapcli_interface_t
 808  *
 809  */
 810 static tapcli_interface_t *
 811 tapcli_get_new_tapif ()
 812 {
 813   tapcli_main_t *tm = &tapcli_main;
 814   tapcli_interface_t *ti = NULL;
 815
 816   int inactive_cnt = vec_len (tm->tapcli_inactive_interfaces);
 817   // if there are any inactive ifaces
 818   if (inactive_cnt > 0)
 819     {
 820       // take last
 821       u32 ti_idx = tm->tapcli_inactive_interfaces[inactive_cnt - 1];
 822       if (vec_len (tm->tapcli_interfaces) > ti_idx)
 823         {
 824           ti = vec_elt_at_index (tm->tapcli_interfaces, ti_idx);
 825           clib_warning ("reusing tap interface");
 826         }
 827       // "remove" from inactive list
 828       _vec_len (tm->tapcli_inactive_interfaces) -= 1;
 829     }
 830
 831   // ti was not retrieved from inactive ifaces - create new
 832   if (!ti)
 833     vec_add2 (tm->tapcli_interfaces, ti, 1);
 834
 835   return ti;
 836 }
 837
 838 typedef struct
 839 {
 840   ip6_address_t addr;
 841   u32 mask_width;
 842   unsigned int ifindex;
 843 } ip6_ifreq_t;
 844
 845 /**
 846  * @brief Connect a TAP interface
 847  *
 848  * @param vm - vlib_main_t
 849  * @param ap - vnet_tap_connect_args_t
 850  *
 851  * @return rc - int
 852  *
 853  */
 854 int
 855 vnet_tap_connect (vlib_main_t * vm, vnet_tap_connect_args_t * ap)
 856 {
 857   tapcli_main_t *tm = &tapcli_main;
 858   tapcli_interface_t *ti = NULL;
 859   struct ifreq ifr;
 860   int flags;
 861   int dev_net_tun_fd;
 862   int dev_tap_fd = -1;
 863   clib_error_t *error;
 864   u8 hwaddr[6];
 865   int rv = 0;
 866
 867   if (tm->is_disabled)
 868     {
 869       return VNET_API_ERROR_FEATURE_DISABLED;
 870     }
 871
 872   flags = IFF_TAP | IFF_NO_PI;
 873
 874   if ((dev_net_tun_fd = open ("/dev/net/tun", O_RDWR)) < 0)
 875     return VNET_API_ERROR_SYSCALL_ERROR_1;
 876
 877   clib_memset (&ifr, 0, sizeof (ifr));
 878   strncpy (ifr.ifr_name, (char *) ap->intfc_name, sizeof (ifr.ifr_name) - 1);
 879   ifr.ifr_flags = flags;
 880   if (ioctl (dev_net_tun_fd, TUNSETIFF, (void *) &ifr) < 0)
 881     {
 882       rv = VNET_API_ERROR_SYSCALL_ERROR_2;
 883       goto error;
 884     }
 885
 886   /* Open a provisioning socket */
 887   if ((dev_tap_fd = socket (PF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
 888     {
 889       rv = VNET_API_ERROR_SYSCALL_ERROR_3;
 890       goto error;
 891     }
 892
 893   /* Find the interface index. */
 894   {
 895     struct ifreq ifr;
 896     struct sockaddr_ll sll;
 897
 898     clib_memset (&ifr, 0, sizeof (ifr));
 899     strncpy (ifr.ifr_name, (char *) ap->intfc_name,
 900              sizeof (ifr.ifr_name) - 1);
 901     if (ioctl (dev_tap_fd, SIOCGIFINDEX, &ifr) < 0)
 902       {
 903         rv = VNET_API_ERROR_SYSCALL_ERROR_4;
 904         goto error;
 905       }
 906
 907     /* Bind the provisioning socket to the interface. */
 908     clib_memset (&sll, 0, sizeof (sll));
 909     sll.sll_family = AF_PACKET;
 910     sll.sll_ifindex = ifr.ifr_ifindex;
 911     sll.sll_protocol = htons (ETH_P_ALL);
 912
 913     if (bind (dev_tap_fd, (struct sockaddr *) &sll, sizeof (sll)) < 0)
 914       {
 915         rv = VNET_API_ERROR_SYSCALL_ERROR_5;
 916         goto error;
 917       }
 918   }
 919
 920   /* non-blocking I/O on /dev/tapX */
 921   {
 922     int one = 1;
 923     if (ioctl (dev_net_tun_fd, FIONBIO, &one) < 0)
 924       {
 925         rv = VNET_API_ERROR_SYSCALL_ERROR_6;
 926         goto error;
 927       }
 928   }
 929   ifr.ifr_mtu = tm->mtu_bytes;
 930   if (ioctl (dev_tap_fd, SIOCSIFMTU, &ifr) < 0)
 931     {
 932       rv = VNET_API_ERROR_SYSCALL_ERROR_7;
 933       goto error;
 934     }
 935
 936   /* get flags, modify to bring up interface... */
 937   if (ioctl (dev_tap_fd, SIOCGIFFLAGS, &ifr) < 0)
 938     {
 939       rv = VNET_API_ERROR_SYSCALL_ERROR_8;
 940       goto error;
 941     }
 942
 943   ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);
 944
 945   if (ioctl (dev_tap_fd, SIOCSIFFLAGS, &ifr) < 0)
 946     {
 947       rv = VNET_API_ERROR_SYSCALL_ERROR_9;
 948       goto error;
 949     }
 950
 951   if (ap->ip4_address_set)
 952     {
 953       struct sockaddr_in sin;
 954       /* ip4: mask defaults to /24 */
 955       u32 mask = clib_host_to_net_u32 (0xFFFFFF00);
 956
 957       clib_memset (&sin, 0, sizeof (sin));
 958       sin.sin_family = AF_INET;
 959       /* sin.sin_port = 0; */
 960       sin.sin_addr.s_addr = ap->ip4_address->as_u32;
 961       memcpy (&ifr.ifr_ifru.ifru_addr, &sin, sizeof (sin));
 962
 963       if (ioctl (dev_tap_fd, SIOCSIFADDR, &ifr) < 0)
 964         {
 965           rv = VNET_API_ERROR_SYSCALL_ERROR_10;
 966           goto error;
 967         }
 968
 969       if (ap->ip4_mask_width > 0 && ap->ip4_mask_width < 33)
 970         {
 971           mask = ~0;
 972           mask <<= (32 - ap->ip4_mask_width);
 973         }
 974
 975       mask = clib_host_to_net_u32 (mask);
 976       sin.sin_family = AF_INET;
 977       sin.sin_port = 0;
 978       sin.sin_addr.s_addr = mask;
 979       memcpy (&ifr.ifr_ifru.ifru_addr, &sin, sizeof (sin));
 980
 981       if (ioctl (dev_tap_fd, SIOCSIFNETMASK, &ifr) < 0)
 982         {
 983           rv = VNET_API_ERROR_SYSCALL_ERROR_10;
 984           goto error;
 985         }
 986     }
 987
 988   if (ap->ip6_address_set)
 989     {
 990       struct ifreq ifr2;
 991       ip6_ifreq_t ifr6;
 992       int sockfd6;
 993
 994       sockfd6 = socket (AF_INET6, SOCK_DGRAM, IPPROTO_IP);
 995       if (sockfd6 < 0)
 996         {
 997           rv = VNET_API_ERROR_SYSCALL_ERROR_10;
 998           goto error;
 999         }
1000
1001       clib_memset (&ifr2, 0, sizeof (ifr));
1002       strncpy (ifr2.ifr_name, (char *) ap->intfc_name,
1003                sizeof (ifr2.ifr_name) - 1);
1004       if (ioctl (sockfd6, SIOCGIFINDEX, &ifr2) < 0)
1005         {
1006           close (sockfd6);
1007           rv = VNET_API_ERROR_SYSCALL_ERROR_4;
1008           goto error;
1009         }
1010
1011       memcpy (&ifr6.addr, ap->ip6_address, sizeof (ip6_address_t));
1012       ifr6.mask_width = ap->ip6_mask_width;
1013       ifr6.ifindex = ifr2.ifr_ifindex;
1014
1015       if (ioctl (sockfd6, SIOCSIFADDR, &ifr6) < 0)
1016         {
1017           close (sockfd6);
1018           clib_unix_warning ("ifr6");
1019           rv = VNET_API_ERROR_SYSCALL_ERROR_10;
1020           goto error;
1021         }
1022       close (sockfd6);
1023     }
1024
1025   ti = tapcli_get_new_tapif ();
1026   ti->per_interface_next_index = ~0;
1027
1028   if (ap->hwaddr_arg != 0)
1029     clib_memcpy (hwaddr, ap->hwaddr_arg, 6);
1030   else
1031     {
1032       f64 now = vlib_time_now (vm);
1033       u32 rnd;
1034       rnd = (u32) (now * 1e6);
1035       rnd = random_u32 (&rnd);
1036
1037       memcpy (hwaddr + 2, &rnd, sizeof (rnd));
1038       hwaddr[0] = 2;
1039       hwaddr[1] = 0xfe;
1040     }
1041
1042   error = ethernet_register_interface
1043     (tm->vnet_main,
1044      tapcli_dev_class.index,
1045      ti - tm->tapcli_interfaces /* device instance */ ,
1046      hwaddr /* ethernet address */ ,
1047      &ti->hw_if_index, tapcli_flag_change);
1048
1049   if (error)
1050     {
1051       clib_error_report (error);
1052       rv = VNET_API_ERROR_INVALID_REGISTRATION;
1053       goto error;
1054     }
1055
1056   {
1057     clib_file_t template = { 0 };
1058     template.read_function = tapcli_read_ready;
1059     template.file_descriptor = dev_net_tun_fd;
1060     ti->clib_file_index = clib_file_add (&file_main, &template);
1061     ti->unix_fd = dev_net_tun_fd;
1062     ti->provision_fd = dev_tap_fd;
1063     clib_memcpy (&ti->ifr, &ifr, sizeof (ifr));
1064   }
1065
1066   {
1067     vnet_hw_interface_t *hw;
1068     hw = vnet_get_hw_interface (tm->vnet_main, ti->hw_if_index);
1069     hw->min_supported_packet_bytes = TAP_MTU_MIN;
1070     hw->max_supported_packet_bytes = TAP_MTU_MAX;
1071     vnet_sw_interface_set_mtu (tm->vnet_main, hw->sw_if_index, 9000);
1072     ti->sw_if_index = hw->sw_if_index;
1073     if (ap->sw_if_indexp)
1074       *(ap->sw_if_indexp) = hw->sw_if_index;
1075   }
1076
1077   ti->active = 1;
1078
1079   hash_set (tm->tapcli_interface_index_by_sw_if_index, ti->sw_if_index,
1080             ti - tm->tapcli_interfaces);
1081
1082   hash_set (tm->tapcli_interface_index_by_unix_fd, ti->unix_fd,
1083             ti - tm->tapcli_interfaces);
1084
1085   return rv;
1086
1087 error:
1088   close (dev_net_tun_fd);
1089   if (dev_tap_fd >= 0)
1090     close (dev_tap_fd);
1091
1092   return rv;
1093 }
1094
1095 /**
1096  * @brief Renumber a TAP interface
1097  *
1098  * @param *vm - vlib_main_t
1099  * @param *intfc_name - u8
1100  * @param *hwaddr_arg - u8
1101  * @param *sw_if_indexp - u32
1102  * @param renumber - u8
1103  * @param custom_dev_instance - u32
1104  *
1105  * @return rc - int
1106  *
1107  */
1108 int
1109 vnet_tap_connect_renumber (vlib_main_t * vm, vnet_tap_connect_args_t * ap)
1110 {
1111   int rv = vnet_tap_connect (vm, ap);
1112
1113   if (!rv && ap->renumber)
1114     vnet_interface_name_renumber (*(ap->sw_if_indexp),
1115                                   ap->custom_dev_instance);
1116
1117   return rv;
1118 }
1119
1120 /**
1121  * @brief Disconnect TAP CLI interface
1122  *
1123  * @param *ti - tapcli_interface_t
1124  *
1125  * @return rc - int
1126  *
1127  */
1128 static int
1129 tapcli_tap_disconnect (tapcli_interface_t * ti)
1130 {
1131   int rv = 0;
1132   vnet_main_t *vnm = vnet_get_main ();
1133   tapcli_main_t *tm = &tapcli_main;
1134   u32 sw_if_index = ti->sw_if_index;
1135
1136   // bring interface down
1137   vnet_sw_interface_set_flags (vnm, sw_if_index, 0);
1138
1139   if (ti->clib_file_index != ~0)
1140     {
1141       clib_file_del (&file_main, file_main.file_pool + ti->clib_file_index);
1142       ti->clib_file_index = ~0;
1143     }
1144   else
1145     close (ti->unix_fd);
1146
1147   hash_unset (tm->tapcli_interface_index_by_unix_fd, ti->unix_fd);
1148   hash_unset (tm->tapcli_interface_index_by_sw_if_index, ti->sw_if_index);
1149   close (ti->provision_fd);
1150   ti->unix_fd = -1;
1151   ti->provision_fd = -1;
1152
1153   return rv;
1154 }
1155
1156 /**
1157  * @brief Delete TAP interface
1158  *
1159  * @param *vm - vlib_main_t
1160  * @param sw_if_index - u32
1161  *
1162  * @return rc - int
1163  *
1164  */
1165 int
1166 vnet_tap_delete (vlib_main_t * vm, u32 sw_if_index)
1167 {
1168   int rv = 0;
1169   tapcli_main_t *tm = &tapcli_main;
1170   tapcli_interface_t *ti;
1171   uword *p = NULL;
1172
1173   p = hash_get (tm->tapcli_interface_index_by_sw_if_index, sw_if_index);
1174   if (p == 0)
1175     {
1176       clib_warning ("sw_if_index %d unknown", sw_if_index);
1177       return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1178     }
1179   ti = vec_elt_at_index (tm->tapcli_interfaces, p[0]);
1180
1181   // inactive
1182   ti->active = 0;
1183   tapcli_tap_disconnect (ti);
1184   // add to inactive list
1185   vec_add1 (tm->tapcli_inactive_interfaces, ti - tm->tapcli_interfaces);
1186
1187   // reset renumbered iface
1188   if (p[0] < vec_len (tm->show_dev_instance_by_real_dev_instance))
1189     tm->show_dev_instance_by_real_dev_instance[p[0]] = ~0;
1190
1191   ethernet_delete_interface (tm->vnet_main, ti->hw_if_index);
1192   return rv;
1193 }
1194
1195 /**
1196  * @brief CLI function to delete TAP interface
1197  *
1198  * @param *vm - vlib_main_t
1199  * @param *input - unformat_input_t
1200  * @param *cmd - vlib_cli_command_t
1201  *
1202  * @return error - clib_error_t
1203  *
1204  */
1205 static clib_error_t *
1206 tap_delete_command_fn (vlib_main_t * vm,
1207                        unformat_input_t * input, vlib_cli_command_t * cmd)
1208 {
1209   tapcli_main_t *tm = &tapcli_main;
1210   u32 sw_if_index = ~0;
1211
1212   if (tm->is_disabled)
1213     {
1214       return clib_error_return (0, "device disabled...");
1215     }
1216
1217   if (unformat (input, "%U", unformat_vnet_sw_interface, tm->vnet_main,
1218                 &sw_if_index))
1219     ;
1220   else
1221     return clib_error_return (0, "unknown input `%U'",
1222                               format_unformat_error, input);
1223
1224
1225   int rc = vnet_tap_delete (vm, sw_if_index);
1226
1227   if (!rc)
1228     {
1229       vlib_cli_output (vm, "Deleted.");
1230     }
1231   else
1232     {
1233       vlib_cli_output (vm, "Error during deletion of tap interface. (rc: %d)",
1234                        rc);
1235     }
1236
1237   return 0;
1238 }
1239
1240 /* *INDENT-OFF* */
1241 VLIB_CLI_COMMAND (tap_delete_command, static) = {
1242     .path = "tap delete",
1243     .short_help = "tap delete <vpp-tap-intfc-name>",
1244     .function = tap_delete_command_fn,
1245 };
1246 /* *INDENT-ON* */
1247
1248 /**
1249  * @brief Modifies tap interface - can result in new interface being created
1250  *
1251  * @param *vm - vlib_main_t
1252  * @param orig_sw_if_index - u32
1253  * @param *intfc_name - u8
1254  * @param *hwaddr_arg - u8
1255  * @param *sw_if_indexp - u32
1256  * @param renumber - u8
1257  * @param custom_dev_instance - u32
1258  *
1259  * @return rc - int
1260  *
1261  */
1262 int
1263 vnet_tap_modify (vlib_main_t * vm, vnet_tap_connect_args_t * ap)
1264 {
1265   int rv = vnet_tap_delete (vm, ap->orig_sw_if_index);
1266
1267   if (rv)
1268     return rv;
1269
1270   rv = vnet_tap_connect_renumber (vm, ap);
1271
1272   return rv;
1273 }
1274
1275 /**
1276  * @brief CLI function to modify TAP interface
1277  *
1278  * @param *vm - vlib_main_t
1279  * @param *input - unformat_input_t
1280  * @param *cmd - vlib_cli_command_t
1281  *
1282  * @return error - clib_error_t
1283  *
1284  */
1285 static clib_error_t *
1286 tap_modify_command_fn (vlib_main_t * vm,
1287                        unformat_input_t * input, vlib_cli_command_t * cmd)
1288 {
1289   u8 *intfc_name;
1290   tapcli_main_t *tm = &tapcli_main;
1291   u32 sw_if_index = ~0;
1292   u32 new_sw_if_index = ~0;
1293   int user_hwaddr = 0;
1294   u8 hwaddr[6];
1295   vnet_tap_connect_args_t _a, *ap = &_a;
1296
1297   if (tm->is_disabled)
1298     {
1299       return clib_error_return (0, "device disabled...");
1300     }
1301
1302   if (unformat (input, "%U", unformat_vnet_sw_interface, tm->vnet_main,
1303                 &sw_if_index))
1304     ;
1305   else
1306     return clib_error_return (0, "unknown input `%U'",
1307                               format_unformat_error, input);
1308
1309   if (unformat (input, "%s", &intfc_name))
1310     ;
1311   else
1312     return clib_error_return (0, "unknown input `%U'",
1313                               format_unformat_error, input);
1314
1315   if (unformat (input, "hwaddr %U", unformat_ethernet_address, &hwaddr))
1316     user_hwaddr = 1;
1317
1318
1319   clib_memset (ap, 0, sizeof (*ap));
1320   ap->orig_sw_if_index = sw_if_index;
1321   ap->intfc_name = intfc_name;
1322   ap->sw_if_indexp = &new_sw_if_index;
1323   if (user_hwaddr)
1324     ap->hwaddr_arg = hwaddr;
1325
1326   int rc = vnet_tap_modify (vm, ap);
1327
1328   if (!rc)
1329     {
1330       vlib_cli_output (vm, "Modified %U for Linux tap '%s'",
1331                        format_vnet_sw_if_index_name, tm->vnet_main,
1332                        *(ap->sw_if_indexp), ap->intfc_name);
1333     }
1334   else
1335     {
1336       vlib_cli_output (vm,
1337                        "Error during modification of tap interface. (rc: %d)",
1338                        rc);
1339     }
1340
1341   return 0;
1342 }
1343
1344 /* *INDENT-OFF* */
1345 VLIB_CLI_COMMAND (tap_modify_command, static) = {
1346     .path = "tap modify",
1347     .short_help = "tap modify <vpp-tap-intfc-name> <linux-intfc-name> [hwaddr <addr>]",
1348     .function = tap_modify_command_fn,
1349 };
1350 /* *INDENT-ON* */
1351
1352 /**
1353  * @brief CLI function to connect TAP interface
1354  *
1355  * @param *vm - vlib_main_t
1356  * @param *input - unformat_input_t
1357  * @param *cmd - vlib_cli_command_t
1358  *
1359  * @return error - clib_error_t
1360  *
1361  */
1362 static clib_error_t *
1363 tap_connect_command_fn (vlib_main_t * vm,
1364                         unformat_input_t * input, vlib_cli_command_t * cmd)
1365 {
1366   u8 *intfc_name = 0;
1367   unformat_input_t _line_input, *line_input = &_line_input;
1368   vnet_tap_connect_args_t _a, *ap = &_a;
1369   tapcli_main_t *tm = &tapcli_main;
1370   u8 hwaddr[6];
1371   u8 *hwaddr_arg = 0;
1372   u32 sw_if_index;
1373   ip4_address_t ip4_address;
1374   int ip4_address_set = 0;
1375   ip6_address_t ip6_address;
1376   int ip6_address_set = 0;
1377   u32 ip4_mask_width = 0;
1378   u32 ip6_mask_width = 0;
1379   clib_error_t *error = NULL;
1380
1381   if (tm->is_disabled)
1382     return clib_error_return (0, "device disabled...");
1383
1384   if (!unformat_user (input, unformat_line_input, line_input))
1385     return 0;
1386
1387   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1388     {
1389       if (unformat (line_input, "hwaddr %U", unformat_ethernet_address,
1390                     &hwaddr))
1391         hwaddr_arg = hwaddr;
1392
1393       /* It is here for backward compatibility */
1394       else if (unformat (line_input, "hwaddr random"))
1395         ;
1396
1397       else if (unformat (line_input, "address %U/%d",
1398                          unformat_ip4_address, &ip4_address, &ip4_mask_width))
1399         ip4_address_set = 1;
1400
1401       else if (unformat (line_input, "address %U/%d",
1402                          unformat_ip6_address, &ip6_address, &ip6_mask_width))
1403         ip6_address_set = 1;
1404
1405       else if (unformat (line_input, "%s", &intfc_name))
1406         ;
1407       else
1408         {
1409           error = clib_error_return (0, "unknown input `%U'",
1410                                      format_unformat_error, line_input);
1411           goto done;
1412         }
1413     }
1414
1415   if (intfc_name == 0)
1416     {
1417       error = clib_error_return (0, "interface name must be specified");
1418       goto done;
1419     }
1420
1421   clib_memset (ap, 0, sizeof (*ap));
1422
1423   ap->intfc_name = intfc_name;
1424   ap->hwaddr_arg = hwaddr_arg;
1425   if (ip4_address_set)
1426     {
1427       ap->ip4_address = &ip4_address;
1428       ap->ip4_mask_width = ip4_mask_width;
1429       ap->ip4_address_set = 1;
1430     }
1431   if (ip6_address_set)
1432     {
1433       ap->ip6_address = &ip6_address;
1434       ap->ip6_mask_width = ip6_mask_width;
1435       ap->ip6_address_set = 1;
1436     }
1437
1438   ap->sw_if_indexp = &sw_if_index;
1439
1440   int rv = vnet_tap_connect (vm, ap);
1441
1442   switch (rv)
1443     {
1444     case VNET_API_ERROR_SYSCALL_ERROR_1:
1445       error = clib_error_return (0, "Couldn't open /dev/net/tun");
1446       goto done;
1447
1448     case VNET_API_ERROR_SYSCALL_ERROR_2:
1449       error =
1450         clib_error_return (0, "Error setting flags on '%s'", intfc_name);
1451       goto done;
1452
1453     case VNET_API_ERROR_SYSCALL_ERROR_3:
1454       error = clib_error_return (0, "Couldn't open provisioning socket");
1455       goto done;
1456
1457     case VNET_API_ERROR_SYSCALL_ERROR_4:
1458       error = clib_error_return (0, "Couldn't get if_index");
1459       goto done;
1460
1461     case VNET_API_ERROR_SYSCALL_ERROR_5:
1462       error = clib_error_return (0, "Couldn't bind provisioning socket");
1463       goto done;
1464
1465     case VNET_API_ERROR_SYSCALL_ERROR_6:
1466       error = clib_error_return (0, "Couldn't set device non-blocking flag");
1467       goto done;
1468
1469     case VNET_API_ERROR_SYSCALL_ERROR_7:
1470       error = clib_error_return (0, "Couldn't set device MTU");
1471       goto done;
1472
1473     case VNET_API_ERROR_SYSCALL_ERROR_8:
1474       error = clib_error_return (0, "Couldn't get interface flags");
1475       goto done;
1476
1477     case VNET_API_ERROR_SYSCALL_ERROR_9:
1478       error = clib_error_return (0, "Couldn't set intfc admin state up");
1479       goto done;
1480
1481     case VNET_API_ERROR_SYSCALL_ERROR_10:
1482       error = clib_error_return (0, "Couldn't set intfc address/mask");
1483       goto done;
1484
1485     case VNET_API_ERROR_INVALID_REGISTRATION:
1486       error = clib_error_return (0, "Invalid registration");
1487       goto done;
1488
1489     case 0:
1490       break;
1491
1492     default:
1493       error = clib_error_return (0, "Unknown error: %d", rv);
1494       goto done;
1495     }
1496
1497   vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
1498                    vnet_get_main (), sw_if_index);
1499
1500 done:
1501   unformat_free (line_input);
1502
1503   return error;
1504 }
1505
1506 /* *INDENT-OFF* */
1507 VLIB_CLI_COMMAND (tap_connect_command, static) = {
1508     .path = "tap connect",
1509     .short_help =
1510         "tap connect <intfc-name> [address <ip-addr>/mw] [hwaddr <addr>]",
1511     .function = tap_connect_command_fn,
1512 };
1513 /* *INDENT-ON* */
1514
1515 /**
1516  * @brief TAPCLI main init
1517  *
1518  * @param *vm - vlib_main_t
1519  *
1520  * @return error - clib_error_t
1521  *
1522  */
1523 clib_error_t *
1524 tapcli_init (vlib_main_t * vm)
1525 {
1526   tapcli_main_t *tm = &tapcli_main;
1527   vlib_thread_main_t *m = vlib_get_thread_main ();
1528   tapcli_per_thread_t *thread;
1529
1530   tm->vlib_main = vm;
1531   tm->vnet_main = vnet_get_main ();
1532   tm->mtu_bytes = TAP_MTU_DEFAULT;
1533   tm->tapcli_interface_index_by_sw_if_index = hash_create (0, sizeof (uword));
1534   tm->tapcli_interface_index_by_unix_fd = hash_create (0, sizeof (uword));
1535   vm->os_punt_frame = tapcli_nopunt_frame;
1536   vec_validate_aligned (tm->threads, m->n_vlib_mains - 1,
1537                         CLIB_CACHE_LINE_BYTES);
1538   vec_foreach (thread, tm->threads)
1539   {
1540     thread->iovecs = 0;
1541     thread->rx_buffers = 0;
1542     vec_alloc (thread->rx_buffers, VLIB_FRAME_SIZE);
1543     vec_reset_length (thread->rx_buffers);
1544   }
1545
1546   return 0;
1547 }
1548
1549 VLIB_INIT_FUNCTION (tapcli_init);
1550
1551 /*
1552  * fd.io coding-style-patch-verification: ON
1553  *
1554  * Local Variables:
1555  * eval: (c-set-style "gnu")
1556  * End:
1557  */