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
 750   if (is_admin_up)
 751     hw_flags = VNET_HW_INTERFACE_FLAG_LINK_UP;
 752   else
 753     hw_flags = 0;
 754
 755   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
 756   return 0;
 757 }
 758
 759 /* *INDENT-OFF* */
 760 VNET_DEVICE_CLASS (tapcli_dev_class,static) = {
 761   .name = "tapcli",
 762   .tx_function = tapcli_tx,
 763   .format_device_name = format_tapcli_interface_name,
 764   .rx_redirect_to_node = tapcli_set_interface_next_node,
 765   .name_renumber = tap_name_renumber,
 766   .admin_up_down_function = tapcli_interface_admin_up_down,
 767 };
 768 /* *INDENT-ON* */
 769
 770 /**
 771  * @brief Dump TAP interfaces
 772  *
 773  * @param **out_tapids - tapcli_interface_details_t
 774  *
 775  * @return rc - int
 776  *
 777  */
 778 int
 779 vnet_tap_dump_ifs (tapcli_interface_details_t ** out_tapids)
 780 {
 781   tapcli_main_t *tm = &tapcli_main;
 782   tapcli_interface_t *ti;
 783
 784   tapcli_interface_details_t *r_tapids = NULL;
 785   tapcli_interface_details_t *tapid = NULL;
 786
 787   vec_foreach (ti, tm->tapcli_interfaces)
 788   {
 789     if (!ti->active)
 790       continue;
 791     vec_add2 (r_tapids, tapid, 1);
 792     tapid->sw_if_index = ti->sw_if_index;
 793     strncpy ((char *) tapid->dev_name, ti->ifr.ifr_name,
 794              sizeof (ti->ifr.ifr_name) - 1);
 795   }
 796
 797   *out_tapids = r_tapids;
 798
 799   return 0;
 800 }
 801
 802 /**
 803  * @brief Get tap interface from inactive interfaces or create new
 804  *
 805  * @return interface - tapcli_interface_t
 806  *
 807  */
 808 static tapcli_interface_t *
 809 tapcli_get_new_tapif ()
 810 {
 811   tapcli_main_t *tm = &tapcli_main;
 812   tapcli_interface_t *ti = NULL;
 813
 814   int inactive_cnt = vec_len (tm->tapcli_inactive_interfaces);
 815   // if there are any inactive ifaces
 816   if (inactive_cnt > 0)
 817     {
 818       // take last
 819       u32 ti_idx = tm->tapcli_inactive_interfaces[inactive_cnt - 1];
 820       if (vec_len (tm->tapcli_interfaces) > ti_idx)
 821         {
 822           ti = vec_elt_at_index (tm->tapcli_interfaces, ti_idx);
 823           clib_warning ("reusing tap interface");
 824         }
 825       // "remove" from inactive list
 826       _vec_len (tm->tapcli_inactive_interfaces) -= 1;
 827     }
 828
 829   // ti was not retrieved from inactive ifaces - create new
 830   if (!ti)
 831     vec_add2 (tm->tapcli_interfaces, ti, 1);
 832
 833   return ti;
 834 }
 835
 836 typedef struct
 837 {
 838   ip6_address_t addr;
 839   u32 mask_width;
 840   unsigned int ifindex;
 841 } ip6_ifreq_t;
 842
 843 /**
 844  * @brief Connect a TAP interface
 845  *
 846  * @param vm - vlib_main_t
 847  * @param ap - vnet_tap_connect_args_t
 848  *
 849  * @return rc - int
 850  *
 851  */
 852 int
 853 vnet_tap_connect (vlib_main_t * vm, vnet_tap_connect_args_t * ap)
 854 {
 855   tapcli_main_t *tm = &tapcli_main;
 856   tapcli_interface_t *ti = NULL;
 857   struct ifreq ifr;
 858   int flags;
 859   int dev_net_tun_fd;
 860   int dev_tap_fd = -1;
 861   clib_error_t *error;
 862   u8 hwaddr[6];
 863   int rv = 0;
 864
 865   if (tm->is_disabled)
 866     {
 867       return VNET_API_ERROR_FEATURE_DISABLED;
 868     }
 869
 870   flags = IFF_TAP | IFF_NO_PI;
 871
 872   if ((dev_net_tun_fd = open ("/dev/net/tun", O_RDWR)) < 0)
 873     return VNET_API_ERROR_SYSCALL_ERROR_1;
 874
 875   clib_memset (&ifr, 0, sizeof (ifr));
 876   strncpy (ifr.ifr_name, (char *) ap->intfc_name, sizeof (ifr.ifr_name) - 1);
 877   ifr.ifr_flags = flags;
 878   if (ioctl (dev_net_tun_fd, TUNSETIFF, (void *) &ifr) < 0)
 879     {
 880       rv = VNET_API_ERROR_SYSCALL_ERROR_2;
 881       goto error;
 882     }
 883
 884   /* Open a provisioning socket */
 885   if ((dev_tap_fd = socket (PF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
 886     {
 887       rv = VNET_API_ERROR_SYSCALL_ERROR_3;
 888       goto error;
 889     }
 890
 891   /* Find the interface index. */
 892   {
 893     struct ifreq ifr;
 894     struct sockaddr_ll sll;
 895
 896     clib_memset (&ifr, 0, sizeof (ifr));
 897     strncpy (ifr.ifr_name, (char *) ap->intfc_name,
 898              sizeof (ifr.ifr_name) - 1);
 899     if (ioctl (dev_tap_fd, SIOCGIFINDEX, &ifr) < 0)
 900       {
 901         rv = VNET_API_ERROR_SYSCALL_ERROR_4;
 902         goto error;
 903       }
 904
 905     /* Bind the provisioning socket to the interface. */
 906     clib_memset (&sll, 0, sizeof (sll));
 907     sll.sll_family = AF_PACKET;
 908     sll.sll_ifindex = ifr.ifr_ifindex;
 909     sll.sll_protocol = htons (ETH_P_ALL);
 910
 911     if (bind (dev_tap_fd, (struct sockaddr *) &sll, sizeof (sll)) < 0)
 912       {
 913         rv = VNET_API_ERROR_SYSCALL_ERROR_5;
 914         goto error;
 915       }
 916   }
 917
 918   /* non-blocking I/O on /dev/tapX */
 919   {
 920     int one = 1;
 921     if (ioctl (dev_net_tun_fd, FIONBIO, &one) < 0)
 922       {
 923         rv = VNET_API_ERROR_SYSCALL_ERROR_6;
 924         goto error;
 925       }
 926   }
 927   ifr.ifr_mtu = tm->mtu_bytes;
 928   if (ioctl (dev_tap_fd, SIOCSIFMTU, &ifr) < 0)
 929     {
 930       rv = VNET_API_ERROR_SYSCALL_ERROR_7;
 931       goto error;
 932     }
 933
 934   /* get flags, modify to bring up interface... */
 935   if (ioctl (dev_tap_fd, SIOCGIFFLAGS, &ifr) < 0)
 936     {
 937       rv = VNET_API_ERROR_SYSCALL_ERROR_8;
 938       goto error;
 939     }
 940
 941   ifr.ifr_flags |= (IFF_UP | IFF_RUNNING);
 942
 943   if (ioctl (dev_tap_fd, SIOCSIFFLAGS, &ifr) < 0)
 944     {
 945       rv = VNET_API_ERROR_SYSCALL_ERROR_9;
 946       goto error;
 947     }
 948
 949   if (ap->ip4_address_set)
 950     {
 951       struct sockaddr_in sin;
 952       /* ip4: mask defaults to /24 */
 953       u32 mask = clib_host_to_net_u32 (0xFFFFFF00);
 954
 955       clib_memset (&sin, 0, sizeof (sin));
 956       sin.sin_family = AF_INET;
 957       /* sin.sin_port = 0; */
 958       sin.sin_addr.s_addr = ap->ip4_address->as_u32;
 959       memcpy (&ifr.ifr_ifru.ifru_addr, &sin, sizeof (sin));
 960
 961       if (ioctl (dev_tap_fd, SIOCSIFADDR, &ifr) < 0)
 962         {
 963           rv = VNET_API_ERROR_SYSCALL_ERROR_10;
 964           goto error;
 965         }
 966
 967       if (ap->ip4_mask_width > 0 && ap->ip4_mask_width < 33)
 968         {
 969           mask = ~0;
 970           mask <<= (32 - ap->ip4_mask_width);
 971         }
 972
 973       mask = clib_host_to_net_u32 (mask);
 974       sin.sin_family = AF_INET;
 975       sin.sin_port = 0;
 976       sin.sin_addr.s_addr = mask;
 977       memcpy (&ifr.ifr_ifru.ifru_addr, &sin, sizeof (sin));
 978
 979       if (ioctl (dev_tap_fd, SIOCSIFNETMASK, &ifr) < 0)
 980         {
 981           rv = VNET_API_ERROR_SYSCALL_ERROR_10;
 982           goto error;
 983         }
 984     }
 985
 986   if (ap->ip6_address_set)
 987     {
 988       struct ifreq ifr2;
 989       ip6_ifreq_t ifr6;
 990       int sockfd6;
 991
 992       sockfd6 = socket (AF_INET6, SOCK_DGRAM, IPPROTO_IP);
 993       if (sockfd6 < 0)
 994         {
 995           rv = VNET_API_ERROR_SYSCALL_ERROR_10;
 996           goto error;
 997         }
 998
 999       clib_memset (&ifr2, 0, sizeof (ifr));
1000       strncpy (ifr2.ifr_name, (char *) ap->intfc_name,
1001                sizeof (ifr2.ifr_name) - 1);
1002       if (ioctl (sockfd6, SIOCGIFINDEX, &ifr2) < 0)
1003         {
1004           close (sockfd6);
1005           rv = VNET_API_ERROR_SYSCALL_ERROR_4;
1006           goto error;
1007         }
1008
1009       memcpy (&ifr6.addr, ap->ip6_address, sizeof (ip6_address_t));
1010       ifr6.mask_width = ap->ip6_mask_width;
1011       ifr6.ifindex = ifr2.ifr_ifindex;
1012
1013       if (ioctl (sockfd6, SIOCSIFADDR, &ifr6) < 0)
1014         {
1015           close (sockfd6);
1016           clib_unix_warning ("ifr6");
1017           rv = VNET_API_ERROR_SYSCALL_ERROR_10;
1018           goto error;
1019         }
1020       close (sockfd6);
1021     }
1022
1023   ti = tapcli_get_new_tapif ();
1024   ti->per_interface_next_index = ~0;
1025
1026   if (ap->hwaddr_arg != 0)
1027     clib_memcpy (hwaddr, ap->hwaddr_arg, 6);
1028   else
1029     {
1030       f64 now = vlib_time_now (vm);
1031       u32 rnd;
1032       rnd = (u32) (now * 1e6);
1033       rnd = random_u32 (&rnd);
1034
1035       memcpy (hwaddr + 2, &rnd, sizeof (rnd));
1036       hwaddr[0] = 2;
1037       hwaddr[1] = 0xfe;
1038     }
1039
1040   error = ethernet_register_interface
1041     (tm->vnet_main,
1042      tapcli_dev_class.index,
1043      ti - tm->tapcli_interfaces /* device instance */ ,
1044      hwaddr /* ethernet address */ ,
1045      &ti->hw_if_index, tapcli_flag_change);
1046
1047   if (error)
1048     {
1049       clib_error_report (error);
1050       rv = VNET_API_ERROR_INVALID_REGISTRATION;
1051       goto error;
1052     }
1053
1054   {
1055     clib_file_t template = { 0 };
1056     template.read_function = tapcli_read_ready;
1057     template.file_descriptor = dev_net_tun_fd;
1058     ti->clib_file_index = clib_file_add (&file_main, &template);
1059     ti->unix_fd = dev_net_tun_fd;
1060     ti->provision_fd = dev_tap_fd;
1061     clib_memcpy (&ti->ifr, &ifr, sizeof (ifr));
1062   }
1063
1064   {
1065     vnet_hw_interface_t *hw;
1066     hw = vnet_get_hw_interface (tm->vnet_main, ti->hw_if_index);
1067     hw->min_supported_packet_bytes = TAP_MTU_MIN;
1068     hw->max_supported_packet_bytes = TAP_MTU_MAX;
1069     vnet_sw_interface_set_mtu (tm->vnet_main, hw->sw_if_index, 9000);
1070     ti->sw_if_index = hw->sw_if_index;
1071     if (ap->sw_if_indexp)
1072       *(ap->sw_if_indexp) = hw->sw_if_index;
1073   }
1074
1075   ti->active = 1;
1076
1077   hash_set (tm->tapcli_interface_index_by_sw_if_index, ti->sw_if_index,
1078             ti - tm->tapcli_interfaces);
1079
1080   hash_set (tm->tapcli_interface_index_by_unix_fd, ti->unix_fd,
1081             ti - tm->tapcli_interfaces);
1082
1083   return rv;
1084
1085 error:
1086   close (dev_net_tun_fd);
1087   if (dev_tap_fd >= 0)
1088     close (dev_tap_fd);
1089
1090   return rv;
1091 }
1092
1093 /**
1094  * @brief Renumber a TAP interface
1095  *
1096  * @param *vm - vlib_main_t
1097  * @param *intfc_name - u8
1098  * @param *hwaddr_arg - u8
1099  * @param *sw_if_indexp - u32
1100  * @param renumber - u8
1101  * @param custom_dev_instance - u32
1102  *
1103  * @return rc - int
1104  *
1105  */
1106 int
1107 vnet_tap_connect_renumber (vlib_main_t * vm, vnet_tap_connect_args_t * ap)
1108 {
1109   int rv = vnet_tap_connect (vm, ap);
1110
1111   if (!rv && ap->renumber)
1112     vnet_interface_name_renumber (*(ap->sw_if_indexp),
1113                                   ap->custom_dev_instance);
1114
1115   return rv;
1116 }
1117
1118 /**
1119  * @brief Disconnect TAP CLI interface
1120  *
1121  * @param *ti - tapcli_interface_t
1122  *
1123  * @return rc - int
1124  *
1125  */
1126 static int
1127 tapcli_tap_disconnect (tapcli_interface_t * ti)
1128 {
1129   int rv = 0;
1130   vnet_main_t *vnm = vnet_get_main ();
1131   tapcli_main_t *tm = &tapcli_main;
1132   u32 sw_if_index = ti->sw_if_index;
1133
1134   // bring interface down
1135   vnet_sw_interface_set_flags (vnm, sw_if_index, 0);
1136
1137   if (ti->clib_file_index != ~0)
1138     {
1139       clib_file_del (&file_main, file_main.file_pool + ti->clib_file_index);
1140       ti->clib_file_index = ~0;
1141     }
1142   else
1143     close (ti->unix_fd);
1144
1145   hash_unset (tm->tapcli_interface_index_by_unix_fd, ti->unix_fd);
1146   hash_unset (tm->tapcli_interface_index_by_sw_if_index, ti->sw_if_index);
1147   close (ti->provision_fd);
1148   ti->unix_fd = -1;
1149   ti->provision_fd = -1;
1150
1151   return rv;
1152 }
1153
1154 /**
1155  * @brief Delete TAP interface
1156  *
1157  * @param *vm - vlib_main_t
1158  * @param sw_if_index - u32
1159  *
1160  * @return rc - int
1161  *
1162  */
1163 int
1164 vnet_tap_delete (vlib_main_t * vm, u32 sw_if_index)
1165 {
1166   int rv = 0;
1167   tapcli_main_t *tm = &tapcli_main;
1168   tapcli_interface_t *ti;
1169   uword *p = NULL;
1170
1171   p = hash_get (tm->tapcli_interface_index_by_sw_if_index, sw_if_index);
1172   if (p == 0)
1173     {
1174       clib_warning ("sw_if_index %d unknown", sw_if_index);
1175       return VNET_API_ERROR_INVALID_SW_IF_INDEX;
1176     }
1177   ti = vec_elt_at_index (tm->tapcli_interfaces, p[0]);
1178
1179   // inactive
1180   ti->active = 0;
1181   tapcli_tap_disconnect (ti);
1182   // add to inactive list
1183   vec_add1 (tm->tapcli_inactive_interfaces, ti - tm->tapcli_interfaces);
1184
1185   // reset renumbered iface
1186   if (p[0] < vec_len (tm->show_dev_instance_by_real_dev_instance))
1187     tm->show_dev_instance_by_real_dev_instance[p[0]] = ~0;
1188
1189   ethernet_delete_interface (tm->vnet_main, ti->hw_if_index);
1190   return rv;
1191 }
1192
1193 /**
1194  * @brief CLI function to delete TAP interface
1195  *
1196  * @param *vm - vlib_main_t
1197  * @param *input - unformat_input_t
1198  * @param *cmd - vlib_cli_command_t
1199  *
1200  * @return error - clib_error_t
1201  *
1202  */
1203 static clib_error_t *
1204 tap_delete_command_fn (vlib_main_t * vm,
1205                        unformat_input_t * input, vlib_cli_command_t * cmd)
1206 {
1207   tapcli_main_t *tm = &tapcli_main;
1208   u32 sw_if_index = ~0;
1209
1210   if (tm->is_disabled)
1211     {
1212       return clib_error_return (0, "device disabled...");
1213     }
1214
1215   if (unformat (input, "%U", unformat_vnet_sw_interface, tm->vnet_main,
1216                 &sw_if_index))
1217     ;
1218   else
1219     return clib_error_return (0, "unknown input `%U'",
1220                               format_unformat_error, input);
1221
1222
1223   int rc = vnet_tap_delete (vm, sw_if_index);
1224
1225   if (!rc)
1226     {
1227       vlib_cli_output (vm, "Deleted.");
1228     }
1229   else
1230     {
1231       vlib_cli_output (vm, "Error during deletion of tap interface. (rc: %d)",
1232                        rc);
1233     }
1234
1235   return 0;
1236 }
1237
1238 /* *INDENT-OFF* */
1239 VLIB_CLI_COMMAND (tap_delete_command, static) = {
1240     .path = "tap delete",
1241     .short_help = "tap delete <vpp-tap-intfc-name>",
1242     .function = tap_delete_command_fn,
1243 };
1244 /* *INDENT-ON* */
1245
1246 /**
1247  * @brief Modifies tap interface - can result in new interface being created
1248  *
1249  * @param *vm - vlib_main_t
1250  * @param orig_sw_if_index - u32
1251  * @param *intfc_name - u8
1252  * @param *hwaddr_arg - u8
1253  * @param *sw_if_indexp - u32
1254  * @param renumber - u8
1255  * @param custom_dev_instance - u32
1256  *
1257  * @return rc - int
1258  *
1259  */
1260 int
1261 vnet_tap_modify (vlib_main_t * vm, vnet_tap_connect_args_t * ap)
1262 {
1263   int rv = vnet_tap_delete (vm, ap->orig_sw_if_index);
1264
1265   if (rv)
1266     return rv;
1267
1268   rv = vnet_tap_connect_renumber (vm, ap);
1269
1270   return rv;
1271 }
1272
1273 /**
1274  * @brief CLI function to modify TAP interface
1275  *
1276  * @param *vm - vlib_main_t
1277  * @param *input - unformat_input_t
1278  * @param *cmd - vlib_cli_command_t
1279  *
1280  * @return error - clib_error_t
1281  *
1282  */
1283 static clib_error_t *
1284 tap_modify_command_fn (vlib_main_t * vm,
1285                        unformat_input_t * input, vlib_cli_command_t * cmd)
1286 {
1287   u8 *intfc_name;
1288   tapcli_main_t *tm = &tapcli_main;
1289   u32 sw_if_index = ~0;
1290   u32 new_sw_if_index = ~0;
1291   int user_hwaddr = 0;
1292   u8 hwaddr[6];
1293   vnet_tap_connect_args_t _a, *ap = &_a;
1294
1295   if (tm->is_disabled)
1296     {
1297       return clib_error_return (0, "device disabled...");
1298     }
1299
1300   if (unformat (input, "%U", unformat_vnet_sw_interface, tm->vnet_main,
1301                 &sw_if_index))
1302     ;
1303   else
1304     return clib_error_return (0, "unknown input `%U'",
1305                               format_unformat_error, input);
1306
1307   if (unformat (input, "%s", &intfc_name))
1308     ;
1309   else
1310     return clib_error_return (0, "unknown input `%U'",
1311                               format_unformat_error, input);
1312
1313   if (unformat (input, "hwaddr %U", unformat_ethernet_address, &hwaddr))
1314     user_hwaddr = 1;
1315
1316
1317   clib_memset (ap, 0, sizeof (*ap));
1318   ap->orig_sw_if_index = sw_if_index;
1319   ap->intfc_name = intfc_name;
1320   ap->sw_if_indexp = &new_sw_if_index;
1321   if (user_hwaddr)
1322     ap->hwaddr_arg = hwaddr;
1323
1324   int rc = vnet_tap_modify (vm, ap);
1325
1326   if (!rc)
1327     {
1328       vlib_cli_output (vm, "Modified %U for Linux tap '%s'",
1329                        format_vnet_sw_if_index_name, tm->vnet_main,
1330                        *(ap->sw_if_indexp), ap->intfc_name);
1331     }
1332   else
1333     {
1334       vlib_cli_output (vm,
1335                        "Error during modification of tap interface. (rc: %d)",
1336                        rc);
1337     }
1338
1339   return 0;
1340 }
1341
1342 /* *INDENT-OFF* */
1343 VLIB_CLI_COMMAND (tap_modify_command, static) = {
1344     .path = "tap modify",
1345     .short_help = "tap modify <vpp-tap-intfc-name> <linux-intfc-name> [hwaddr <addr>]",
1346     .function = tap_modify_command_fn,
1347 };
1348 /* *INDENT-ON* */
1349
1350 /**
1351  * @brief CLI function to connect TAP interface
1352  *
1353  * @param *vm - vlib_main_t
1354  * @param *input - unformat_input_t
1355  * @param *cmd - vlib_cli_command_t
1356  *
1357  * @return error - clib_error_t
1358  *
1359  */
1360 static clib_error_t *
1361 tap_connect_command_fn (vlib_main_t * vm,
1362                         unformat_input_t * input, vlib_cli_command_t * cmd)
1363 {
1364   u8 *intfc_name = 0;
1365   unformat_input_t _line_input, *line_input = &_line_input;
1366   vnet_tap_connect_args_t _a, *ap = &_a;
1367   tapcli_main_t *tm = &tapcli_main;
1368   u8 hwaddr[6];
1369   u8 *hwaddr_arg = 0;
1370   u32 sw_if_index;
1371   ip4_address_t ip4_address;
1372   int ip4_address_set = 0;
1373   ip6_address_t ip6_address;
1374   int ip6_address_set = 0;
1375   u32 ip4_mask_width = 0;
1376   u32 ip6_mask_width = 0;
1377   clib_error_t *error = NULL;
1378
1379   if (tm->is_disabled)
1380     return clib_error_return (0, "device disabled...");
1381
1382   if (!unformat_user (input, unformat_line_input, line_input))
1383     return 0;
1384
1385   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1386     {
1387       if (unformat (line_input, "hwaddr %U", unformat_ethernet_address,
1388                     &hwaddr))
1389         hwaddr_arg = hwaddr;
1390
1391       /* It is here for backward compatibility */
1392       else if (unformat (line_input, "hwaddr random"))
1393         ;
1394
1395       else if (unformat (line_input, "address %U/%d",
1396                          unformat_ip4_address, &ip4_address, &ip4_mask_width))
1397         ip4_address_set = 1;
1398
1399       else if (unformat (line_input, "address %U/%d",
1400                          unformat_ip6_address, &ip6_address, &ip6_mask_width))
1401         ip6_address_set = 1;
1402
1403       else if (unformat (line_input, "%s", &intfc_name))
1404         ;
1405       else
1406         {
1407           error = clib_error_return (0, "unknown input `%U'",
1408                                      format_unformat_error, line_input);
1409           goto done;
1410         }
1411     }
1412
1413   if (intfc_name == 0)
1414     {
1415       error = clib_error_return (0, "interface name must be specified");
1416       goto done;
1417     }
1418
1419   clib_memset (ap, 0, sizeof (*ap));
1420
1421   ap->intfc_name = intfc_name;
1422   ap->hwaddr_arg = hwaddr_arg;
1423   if (ip4_address_set)
1424     {
1425       ap->ip4_address = &ip4_address;
1426       ap->ip4_mask_width = ip4_mask_width;
1427       ap->ip4_address_set = 1;
1428     }
1429   if (ip6_address_set)
1430     {
1431       ap->ip6_address = &ip6_address;
1432       ap->ip6_mask_width = ip6_mask_width;
1433       ap->ip6_address_set = 1;
1434     }
1435
1436   ap->sw_if_indexp = &sw_if_index;
1437
1438   int rv = vnet_tap_connect (vm, ap);
1439
1440   switch (rv)
1441     {
1442     case VNET_API_ERROR_SYSCALL_ERROR_1:
1443       error = clib_error_return (0, "Couldn't open /dev/net/tun");
1444       goto done;
1445
1446     case VNET_API_ERROR_SYSCALL_ERROR_2:
1447       error =
1448         clib_error_return (0, "Error setting flags on '%s'", intfc_name);
1449       goto done;
1450
1451     case VNET_API_ERROR_SYSCALL_ERROR_3:
1452       error = clib_error_return (0, "Couldn't open provisioning socket");
1453       goto done;
1454
1455     case VNET_API_ERROR_SYSCALL_ERROR_4:
1456       error = clib_error_return (0, "Couldn't get if_index");
1457       goto done;
1458
1459     case VNET_API_ERROR_SYSCALL_ERROR_5:
1460       error = clib_error_return (0, "Couldn't bind provisioning socket");
1461       goto done;
1462
1463     case VNET_API_ERROR_SYSCALL_ERROR_6:
1464       error = clib_error_return (0, "Couldn't set device non-blocking flag");
1465       goto done;
1466
1467     case VNET_API_ERROR_SYSCALL_ERROR_7:
1468       error = clib_error_return (0, "Couldn't set device MTU");
1469       goto done;
1470
1471     case VNET_API_ERROR_SYSCALL_ERROR_8:
1472       error = clib_error_return (0, "Couldn't get interface flags");
1473       goto done;
1474
1475     case VNET_API_ERROR_SYSCALL_ERROR_9:
1476       error = clib_error_return (0, "Couldn't set intfc admin state up");
1477       goto done;
1478
1479     case VNET_API_ERROR_SYSCALL_ERROR_10:
1480       error = clib_error_return (0, "Couldn't set intfc address/mask");
1481       goto done;
1482
1483     case VNET_API_ERROR_INVALID_REGISTRATION:
1484       error = clib_error_return (0, "Invalid registration");
1485       goto done;
1486
1487     case 0:
1488       break;
1489
1490     default:
1491       error = clib_error_return (0, "Unknown error: %d", rv);
1492       goto done;
1493     }
1494
1495   vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
1496                    vnet_get_main (), sw_if_index);
1497
1498 done:
1499   unformat_free (line_input);
1500
1501   return error;
1502 }
1503
1504 /* *INDENT-OFF* */
1505 VLIB_CLI_COMMAND (tap_connect_command, static) = {
1506     .path = "tap connect",
1507     .short_help =
1508         "tap connect <intfc-name> [address <ip-addr>/mw] [hwaddr <addr>]",
1509     .function = tap_connect_command_fn,
1510 };
1511 /* *INDENT-ON* */
1512
1513 /**
1514  * @brief TAPCLI main init
1515  *
1516  * @param *vm - vlib_main_t
1517  *
1518  * @return error - clib_error_t
1519  *
1520  */
1521 clib_error_t *
1522 tapcli_init (vlib_main_t * vm)
1523 {
1524   tapcli_main_t *tm = &tapcli_main;
1525   vlib_thread_main_t *m = vlib_get_thread_main ();
1526   tapcli_per_thread_t *thread;
1527
1528   tm->vlib_main = vm;
1529   tm->vnet_main = vnet_get_main ();
1530   tm->mtu_bytes = TAP_MTU_DEFAULT;
1531   tm->tapcli_interface_index_by_sw_if_index = hash_create (0, sizeof (uword));
1532   tm->tapcli_interface_index_by_unix_fd = hash_create (0, sizeof (uword));
1533   vm->os_punt_frame = tapcli_nopunt_frame;
1534   vec_validate_aligned (tm->threads, m->n_vlib_mains - 1,
1535                         CLIB_CACHE_LINE_BYTES);
1536   vec_foreach (thread, tm->threads)
1537   {
1538     thread->iovecs = 0;
1539     thread->rx_buffers = 0;
1540     vec_alloc (thread->rx_buffers, VLIB_FRAME_SIZE);
1541     vec_reset_length (thread->rx_buffers);
1542   }
1543
1544   return 0;
1545 }
1546
1547 VLIB_INIT_FUNCTION (tapcli_init);
1548
1549 /*
1550  * fd.io coding-style-patch-verification: ON
1551  *
1552  * Local Variables:
1553  * eval: (c-set-style "gnu")
1554  * End:
1555  */