src/vnet/interface_cli.c

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16  * interface_cli.c: interface CLI
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 /**
  41  * @file
  42  * @brief Interface CLI.
  43  *
  44  * Source code for several CLI interface commands.
  45  *
  46  */
  47
  48 #include <vnet/vnet.h>
  49 #include <vnet/ip/ip.h>
  50 #include <vppinfra/bitmap.h>
  51 #include <vnet/fib/ip4_fib.h>
  52 #include <vnet/fib/ip6_fib.h>
  53 #include <vnet/l2/l2_output.h>
  54 #include <vnet/l2/l2_input.h>
  55
  56 static int
  57 compare_interface_names (void *a1, void *a2)
  58 {
  59   u32 *hi1 = a1;
  60   u32 *hi2 = a2;
  61
  62   return vnet_hw_interface_compare (vnet_get_main (), *hi1, *hi2);
  63 }
  64
  65 static clib_error_t *
  66 show_or_clear_hw_interfaces (vlib_main_t * vm,
  67                              unformat_input_t * input,
  68                              vlib_cli_command_t * cmd)
  69 {
  70   clib_error_t *error = 0;
  71   vnet_main_t *vnm = vnet_get_main ();
  72   vnet_interface_main_t *im = &vnm->interface_main;
  73   vnet_hw_interface_t *hi;
  74   u32 hw_if_index, *hw_if_indices = 0;
  75   int i, verbose = -1, is_show, show_bond = 0;
  76
  77   is_show = strstr (cmd->path, "show") != 0;
  78   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
  79     {
  80       /* See if user wants to show a specific interface. */
  81       if (unformat
  82           (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
  83         vec_add1 (hw_if_indices, hw_if_index);
  84
  85       /* See if user wants to show an interface with a specific hw_if_index. */
  86       else if (unformat (input, "%u", &hw_if_index))
  87         vec_add1 (hw_if_indices, hw_if_index);
  88
  89       else if (unformat (input, "verbose"))
  90         verbose = 1;            /* this is also the default */
  91
  92       else if (unformat (input, "detail"))
  93         verbose = 2;
  94
  95       else if (unformat (input, "brief"))
  96         verbose = 0;
  97
  98       else if (unformat (input, "bond"))
  99         {
 100           show_bond = 1;
 101           if (verbose < 0)
 102             verbose = 0;        /* default to brief for link bonding */
 103         }
 104
 105       else
 106         {
 107           error = clib_error_return (0, "unknown input `%U'",
 108                                      format_unformat_error, input);
 109           goto done;
 110         }
 111     }
 112
 113   /* Gather interfaces. */
 114   if (vec_len (hw_if_indices) == 0)
 115     pool_foreach (hi, im->hw_interfaces,
 116                   vec_add1 (hw_if_indices, hi - im->hw_interfaces));
 117
 118   if (verbose < 0)
 119     verbose = 1;                /* default to verbose (except bond) */
 120
 121   if (is_show)
 122     {
 123       /* Sort by name. */
 124       vec_sort_with_function (hw_if_indices, compare_interface_names);
 125
 126       vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm, 0, verbose);
 127       for (i = 0; i < vec_len (hw_if_indices); i++)
 128         {
 129           hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
 130           if (show_bond == 0)   /* show all interfaces */
 131             vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm,
 132                              hi, verbose);
 133           else if ((hi->bond_info) &&
 134                    (hi->bond_info != VNET_HW_INTERFACE_BOND_INFO_SLAVE))
 135             {                   /* show only bonded interface and all its slave interfaces */
 136               int hw_idx;
 137               vnet_hw_interface_t *shi;
 138               vlib_cli_output (vm, "%U\n", format_vnet_hw_interface, vnm,
 139                                hi, verbose);
 140
 141               /* *INDENT-OFF* */
 142               clib_bitmap_foreach (hw_idx, hi->bond_info,
 143               ({
 144                 shi = vnet_get_hw_interface(vnm, hw_idx);
 145                 vlib_cli_output (vm, "%U\n",
 146                                  format_vnet_hw_interface, vnm, shi, verbose);
 147               }));
 148               /* *INDENT-ON* */
 149             }
 150         }
 151     }
 152   else
 153     {
 154       for (i = 0; i < vec_len (hw_if_indices); i++)
 155         {
 156           vnet_device_class_t *dc;
 157
 158           hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
 159           dc = vec_elt_at_index (im->device_classes, hi->dev_class_index);
 160
 161           if (dc->clear_counters)
 162             dc->clear_counters (hi->dev_instance);
 163         }
 164     }
 165
 166 done:
 167   vec_free (hw_if_indices);
 168   return error;
 169 }
 170
 171 /*?
 172  * Display more detailed information about all or a list of given interfaces.
 173  * The verboseness of the output can be controlled by the following optional
 174  * parameters:
 175  * - brief: Only show name, index and state (default for bonded interfaces).
 176  * - verbose: Also display additional attributes (default for all other interfaces).
 177  * - detail: Also display all remaining attributes and extended statistics.
 178  *
 179  * To limit the output of the command to bonded interfaces and their slave
 180  * interfaces, use the '<em>bond</em>' optional parameter.
 181  *
 182  * @cliexpar
 183  * Example of how to display default data for all interfaces:
 184  * @cliexstart{show hardware-interfaces}
 185  *               Name                Idx   Link  Hardware
 186  * GigabitEthernet7/0/0               1     up   GigabitEthernet7/0/0
 187  *   Ethernet address ec:f4:bb:c0:bc:fc
 188  *   Intel e1000
 189  *     carrier up full duplex speed 1000 mtu 9216
 190  *     rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
 191  *     cpu socket 0
 192  * GigabitEthernet7/0/1               2     up   GigabitEthernet7/0/1
 193  *   Ethernet address ec:f4:bb:c0:bc:fd
 194  *   Intel e1000
 195  *     carrier up full duplex speed 1000 mtu 9216
 196  *     rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
 197  *     cpu socket 0
 198  * VirtualEthernet0/0/0               3     up   VirtualEthernet0/0/0
 199  *   Ethernet address 02:fe:a5:a9:8b:8e
 200  * VirtualEthernet0/0/1               4     up   VirtualEthernet0/0/1
 201  *   Ethernet address 02:fe:c0:4e:3b:b0
 202  * VirtualEthernet0/0/2               5     up   VirtualEthernet0/0/2
 203  *   Ethernet address 02:fe:1f:73:92:81
 204  * VirtualEthernet0/0/3               6     up   VirtualEthernet0/0/3
 205  *   Ethernet address 02:fe:f2:25:c4:68
 206  * local0                             0    down  local0
 207  *   local
 208  * @cliexend
 209  * Example of how to display '<em>verbose</em>' data for an interface by name and
 210  * software index (where 2 is the software index):
 211  * @cliexstart{show hardware-interfaces GigabitEthernet7/0/0 2 verbose}
 212  *               Name                Idx   Link  Hardware
 213  * GigabitEthernet7/0/0               1     up   GigabitEthernet7/0/0
 214  *   Ethernet address ec:f4:bb:c0:bc:fc
 215  *   Intel e1000
 216  *     carrier up full duplex speed 1000 mtu 9216
 217  *     rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
 218  *     cpu socket 0
 219  * GigabitEthernet7/0/1               2    down  GigabitEthernet7/0/1
 220  *   Ethernet address ec:f4:bb:c0:bc:fd
 221  *   Intel e1000
 222  *     carrier up full duplex speed 1000 mtu 9216
 223  *     rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
 224  *     cpu socket 0
 225  * @cliexend
 226  ?*/
 227 /* *INDENT-OFF* */
 228 VLIB_CLI_COMMAND (show_hw_interfaces_command, static) = {
 229   .path = "show hardware-interfaces",
 230   .short_help = "show hardware-interfaces [brief|verbose|detail] [bond] "
 231     "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
 232   .function = show_or_clear_hw_interfaces,
 233 };
 234 /* *INDENT-ON* */
 235
 236
 237 /*?
 238  * Clear the extended statistics for all or a list of given interfaces
 239  * (statistics associated with the '<em>show hardware-interfaces</em>' command).
 240  *
 241  * @cliexpar
 242  * Example of how to clear the extended statistics for all interfaces:
 243  * @cliexcmd{clear hardware-interfaces}
 244  * Example of how to clear the extended statistics for an interface by
 245  * name and software index (where 2 is the software index):
 246  * @cliexcmd{clear hardware-interfaces GigabitEthernet7/0/0 2}
 247  ?*/
 248 /* *INDENT-OFF* */
 249 VLIB_CLI_COMMAND (clear_hw_interface_counters_command, static) = {
 250   .path = "clear hardware-interfaces",
 251   .short_help = "clear hardware-interfaces "
 252     "[<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]",
 253   .function = show_or_clear_hw_interfaces,
 254 };
 255 /* *INDENT-ON* */
 256
 257 static int
 258 sw_interface_name_compare (void *a1, void *a2)
 259 {
 260   vnet_sw_interface_t *si1 = a1;
 261   vnet_sw_interface_t *si2 = a2;
 262
 263   return vnet_sw_interface_compare (vnet_get_main (),
 264                                     si1->sw_if_index, si2->sw_if_index);
 265 }
 266
 267 static clib_error_t *
 268 show_sw_interfaces (vlib_main_t * vm,
 269                     unformat_input_t * input, vlib_cli_command_t * cmd)
 270 {
 271   clib_error_t *error = 0;
 272   vnet_main_t *vnm = vnet_get_main ();
 273   vnet_interface_main_t *im = &vnm->interface_main;
 274   vnet_sw_interface_t *si, *sorted_sis = 0;
 275   u32 sw_if_index = ~(u32) 0;
 276   u8 show_addresses = 0;
 277   u8 show_features = 0;
 278   u8 show_tag = 0;
 279
 280   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 281     {
 282       /* See if user wants to show specific interface */
 283       if (unformat
 284           (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
 285         {
 286           si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
 287           vec_add1 (sorted_sis, si[0]);
 288         }
 289       else if (unformat (input, "address") || unformat (input, "addr"))
 290         show_addresses = 1;
 291       else if (unformat (input, "features") || unformat (input, "feat"))
 292         show_features = 1;
 293       else if (unformat (input, "tag"))
 294         show_tag = 1;
 295       else
 296         {
 297           error = clib_error_return (0, "unknown input `%U'",
 298                                      format_unformat_error, input);
 299           goto done;
 300         }
 301     }
 302
 303   if (show_features || show_tag)
 304     {
 305       if (sw_if_index == ~(u32) 0)
 306         return clib_error_return (0, "Interface not specified...");
 307     }
 308
 309   if (show_features)
 310     {
 311       vnet_interface_features_show (vm, sw_if_index);
 312
 313       l2_input_config_t *l2_input = l2input_intf_config (sw_if_index);
 314       u32 fb = l2_input->feature_bitmap;
 315       /* intf input features are masked by bridge domain */
 316       if (l2_input->bridge)
 317         fb &= l2input_bd_config (l2_input->bd_index)->feature_bitmap;
 318       vlib_cli_output (vm, "\nl2-input:\n%U", format_l2_input_features, fb);
 319
 320       l2_output_config_t *l2_output = l2output_intf_config (sw_if_index);
 321       vlib_cli_output (vm, "\nl2-output:");
 322       if (l2_output->out_vtr_flag)
 323         vlib_cli_output (vm, "%10s (%s)", "VTR", "--internal--");
 324       vlib_cli_output (vm, "%U", format_l2_output_features,
 325                        l2_output->feature_bitmap);
 326       return 0;
 327     }
 328   if (show_tag)
 329     {
 330       u8 *tag;
 331       tag = vnet_get_sw_interface_tag (vnm, sw_if_index);
 332       vlib_cli_output (vm, "%U: %s",
 333                        format_vnet_sw_if_index_name, vnm, sw_if_index,
 334                        tag ? (char *) tag : "(none)");
 335       return 0;
 336     }
 337
 338   if (!show_addresses)
 339     vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, 0);
 340
 341   if (vec_len (sorted_sis) == 0)        /* Get all interfaces */
 342     {
 343       /* Gather interfaces. */
 344       sorted_sis =
 345         vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
 346       _vec_len (sorted_sis) = 0;
 347       pool_foreach (si, im->sw_interfaces, (
 348                                              {
 349                                              int visible =
 350                                              vnet_swif_is_api_visible (si);
 351                                              if (visible)
 352                                              vec_add1 (sorted_sis, si[0]);}
 353                     ));
 354
 355       /* Sort by name. */
 356       vec_sort_with_function (sorted_sis, sw_interface_name_compare);
 357     }
 358
 359   if (show_addresses)
 360     {
 361       vec_foreach (si, sorted_sis)
 362       {
 363         ip4_main_t *im4 = &ip4_main;
 364         ip6_main_t *im6 = &ip6_main;
 365         ip_lookup_main_t *lm4 = &im4->lookup_main;
 366         ip_lookup_main_t *lm6 = &im6->lookup_main;
 367         ip_interface_address_t *ia = 0;
 368         ip4_address_t *r4;
 369         ip6_address_t *r6;
 370         u32 fib_index4 = 0, fib_index6 = 0;
 371         ip4_fib_t *fib4;
 372         ip6_fib_t *fib6;
 373
 374         if (vec_len (im4->fib_index_by_sw_if_index) > si->sw_if_index)
 375           fib_index4 = vec_elt (im4->fib_index_by_sw_if_index,
 376                                 si->sw_if_index);
 377
 378         if (vec_len (im6->fib_index_by_sw_if_index) > si->sw_if_index)
 379           fib_index6 = vec_elt (im6->fib_index_by_sw_if_index,
 380                                 si->sw_if_index);
 381
 382         fib4 = ip4_fib_get (fib_index4);
 383         fib6 = ip6_fib_get (fib_index6);
 384
 385         if (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)
 386           vlib_cli_output
 387             (vm, "%U (%s): \n  unnumbered, use %U",
 388              format_vnet_sw_if_index_name,
 389              vnm, si->sw_if_index,
 390              (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "dn",
 391              format_vnet_sw_if_index_name, vnm, si->unnumbered_sw_if_index);
 392
 393         else
 394           {
 395             vlib_cli_output (vm, "%U (%s):",
 396                              format_vnet_sw_if_index_name,
 397                              vnm, si->sw_if_index,
 398                              (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 399                              ? "up" : "dn");
 400           }
 401
 402         /* Display any L2 info */
 403         l2_input_config_t *l2_input = l2input_intf_config (si->sw_if_index);
 404         if (l2_input->bridge)
 405           {
 406             u32 bd_id = l2input_main.bd_configs[l2_input->bd_index].bd_id;
 407             vlib_cli_output (vm, "  l2 bridge bd_id %d%s%d", bd_id,
 408                              l2_input->bvi ? " bvi shg " : " shg ",
 409                              l2_input->shg);
 410           }
 411         else if (l2_input->xconnect)
 412           {
 413             vlib_cli_output (vm, "  l2 xconnect %U",
 414                              format_vnet_sw_if_index_name,
 415                              vnm, l2_input->output_sw_if_index);
 416           }
 417
 418         /* Display any IP4 addressing info */
 419           /* *INDENT-OFF* */
 420           foreach_ip_interface_address (lm4, ia, si->sw_if_index,
 421                                         1 /* honor unnumbered */,
 422           ({
 423             r4 = ip_interface_address_get_address (lm4, ia);
 424             if (fib4->table_id)
 425               {
 426                 vlib_cli_output (vm, "  %U/%d table %d",
 427                                  format_ip4_address, r4,
 428                                  ia->address_length,
 429                                  fib4->table_id);
 430               }
 431             else
 432               {
 433                 vlib_cli_output (vm, "  %U/%d",
 434                                  format_ip4_address, r4,
 435                                  ia->address_length);
 436               }
 437           }));
 438           /* *INDENT-ON* */
 439
 440         /* Display any IP6 addressing info */
 441           /* *INDENT-OFF* */
 442           foreach_ip_interface_address (lm6, ia, si->sw_if_index,
 443                                         1 /* honor unnumbered */,
 444           ({
 445             r6 = ip_interface_address_get_address (lm6, ia);
 446             if (fib6->table_id)
 447               {
 448                 vlib_cli_output (vm, "  %U/%d table %d",
 449                                  format_ip6_address, r6,
 450                                  ia->address_length,
 451                                  fib6->table_id);
 452               }
 453             else
 454               {
 455                 vlib_cli_output (vm, "  %U/%d",
 456                                  format_ip6_address, r6,
 457                                  ia->address_length);
 458               }
 459           }));
 460           /* *INDENT-ON* */
 461       }
 462     }
 463   else
 464     {
 465       vec_foreach (si, sorted_sis)
 466       {
 467         vlib_cli_output (vm, "%U\n", format_vnet_sw_interface, vnm, si);
 468       }
 469     }
 470
 471 done:
 472   vec_free (sorted_sis);
 473   return error;
 474 }
 475
 476 /* *INDENT-OFF* */
 477 VLIB_CLI_COMMAND (show_sw_interfaces_command, static) = {
 478   .path = "show interface",
 479   .short_help = "show interface [address|addr|features|feat] [<interface> [<interface> [..]]]",
 480   .function = show_sw_interfaces,
 481 };
 482 /* *INDENT-ON* */
 483
 484 /* Root of all interface commands. */
 485 /* *INDENT-OFF* */
 486 VLIB_CLI_COMMAND (vnet_cli_interface_command, static) = {
 487   .path = "interface",
 488   .short_help = "Interface commands",
 489 };
 490 /* *INDENT-ON* */
 491
 492 /* *INDENT-OFF* */
 493 VLIB_CLI_COMMAND (vnet_cli_set_interface_command, static) = {
 494   .path = "set interface",
 495   .short_help = "Interface commands",
 496 };
 497 /* *INDENT-ON* */
 498
 499 static clib_error_t *
 500 clear_interface_counters (vlib_main_t * vm,
 501                           unformat_input_t * input, vlib_cli_command_t * cmd)
 502 {
 503   vnet_main_t *vnm = vnet_get_main ();
 504   vnet_interface_main_t *im = &vnm->interface_main;
 505   vlib_simple_counter_main_t *sm;
 506   vlib_combined_counter_main_t *cm;
 507   static vnet_main_t **my_vnet_mains;
 508   int i, j, n_counters;
 509
 510   vec_reset_length (my_vnet_mains);
 511
 512   for (i = 0; i < vec_len (vnet_mains); i++)
 513     {
 514       if (vnet_mains[i])
 515         vec_add1 (my_vnet_mains, vnet_mains[i]);
 516     }
 517
 518   if (vec_len (vnet_mains) == 0)
 519     vec_add1 (my_vnet_mains, vnm);
 520
 521   n_counters = vec_len (im->combined_sw_if_counters);
 522
 523   for (j = 0; j < n_counters; j++)
 524     {
 525       for (i = 0; i < vec_len (my_vnet_mains); i++)
 526         {
 527           im = &my_vnet_mains[i]->interface_main;
 528           cm = im->combined_sw_if_counters + j;
 529           vlib_clear_combined_counters (cm);
 530         }
 531     }
 532
 533   n_counters = vec_len (im->sw_if_counters);
 534
 535   for (j = 0; j < n_counters; j++)
 536     {
 537       for (i = 0; i < vec_len (my_vnet_mains); i++)
 538         {
 539           im = &my_vnet_mains[i]->interface_main;
 540           sm = im->sw_if_counters + j;
 541           vlib_clear_simple_counters (sm);
 542         }
 543     }
 544
 545   return 0;
 546 }
 547
 548 /*?
 549  * Clear the statistics for all interfaces (statistics associated with the
 550  * '<em>show interface</em>' command).
 551  *
 552  * @cliexpar
 553  * Example of how to clear the statistics for all interfaces:
 554  * @cliexcmd{clear interfaces}
 555  ?*/
 556 /* *INDENT-OFF* */
 557 VLIB_CLI_COMMAND (clear_interface_counters_command, static) = {
 558   .path = "clear interfaces",
 559   .short_help = "clear interfaces",
 560   .function = clear_interface_counters,
 561 };
 562 /* *INDENT-ON* */
 563
 564 /**
 565  * Parse subinterface names.
 566  *
 567  * The following subinterface syntax is supported. The first two are for
 568  * backwards compatability:
 569  *
 570  * <intf-name> <id>
 571  *     - a subinterface with the name <intf-name>.<id>. The subinterface
 572  *       is a single dot1q vlan with vlan id <id> and exact-match semantics.
 573  *
 574  * <intf-name> <min_id>-<max_id>
 575  *     - a set of the above subinterfaces, repeating for each id
 576  *       in the range <min_id> to <max_id>
 577  *
 578  * In the following, exact-match semantics (i.e. the number of vlan tags on the
 579  * packet must match the number of tags in the configuration) are used only if
 580  * the keyword exact-match is present. Non-exact match is the default.
 581  *
 582  * <intf-name> <id> dot1q <outer_id> [exact-match]
 583  *     - a subinterface with the name <intf-name>.<id>. The subinterface
 584  *       is a single dot1q vlan with vlan id <outer_id>.
 585  *
 586  * <intf-name> <id> dot1q any [exact-match]
 587  *     - a subinterface with the name <intf-name>.<id>. The subinterface
 588  *       is a single dot1q vlan with any vlan id.
 589  *
 590  * <intf-name> <id> dot1q <outer_id> inner-dot1q <inner_id> [exact-match]
 591  *     - a subinterface with the name <intf-name>.<id>. The subinterface
 592  *       is a double dot1q vlan with outer vlan id <outer_id> and inner vlan id
 593  *       <inner_id>.
 594  *
 595  * <intf-name> <id> dot1q <outer_id> inner-dot1q any [exact-match]
 596  *     - a subinterface with the name <intf-name>.<id>. The subinterface
 597  *       is a double dot1q vlan with outer vlan id <id> and any inner vlan id.
 598  *
 599  * <intf-name> <id> dot1q any inner-dot1q any [exact-match]
 600  *
 601  *     - a subinterface with the name <intf-name>.<id>. The subinterface
 602  *       is a double dot1q vlan with any outer vlan id and any inner vlan id.
 603  *
 604  * For each of the above CLI, there is a duplicate that uses the keyword
 605  * "dot1ad" in place of the first "dot1q". These interfaces use ethertype
 606  * 0x88ad in place of 0x8100 for the outer ethertype. Note that for double-
 607  * tagged packets the inner ethertype is always 0x8100. Also note that
 608  * the dot1q and dot1ad naming spaces are independent, so it is legal to
 609  * have both "Gig3/0/0.1 dot1q 100" and "Gig3/0/0.2 dot1ad 100". For example:
 610  *
 611  * <intf-name> <id> dot1ad <outer_id> inner-dot1q <inner_id> [exact-match]
 612  *     - a subinterface with the name <intf-name>.<id>. The subinterface
 613  *       is a double dot1ad vlan with outer vlan id <outer_id> and inner vlan
 614  *       id <inner_id>.
 615  *
 616  * <intf-name> <id> untagged
 617  *     - a subinterface with the name <intf-name>.<id>. The subinterface
 618  *       has no vlan tags. Only one can be specified per interface.
 619  *
 620  * <intf-name> <id> default
 621  *     - a subinterface with the name <intf-name>.<id>. This is associated
 622  *       with a packet that did not match any other configured subinterface
 623  *       on this interface. Only one can be specified per interface.
 624  */
 625
 626 static clib_error_t *
 627 parse_vlan_sub_interfaces (unformat_input_t * input,
 628                            vnet_sw_interface_t * template)
 629 {
 630   clib_error_t *error = 0;
 631   u32 inner_vlan, outer_vlan;
 632
 633   if (unformat (input, "any inner-dot1q any"))
 634     {
 635       template->sub.eth.flags.two_tags = 1;
 636       template->sub.eth.flags.outer_vlan_id_any = 1;
 637       template->sub.eth.flags.inner_vlan_id_any = 1;
 638     }
 639   else if (unformat (input, "any"))
 640     {
 641       template->sub.eth.flags.one_tag = 1;
 642       template->sub.eth.flags.outer_vlan_id_any = 1;
 643     }
 644   else if (unformat (input, "%d inner-dot1q any", &outer_vlan))
 645     {
 646       template->sub.eth.flags.two_tags = 1;
 647       template->sub.eth.flags.inner_vlan_id_any = 1;
 648       template->sub.eth.outer_vlan_id = outer_vlan;
 649     }
 650   else if (unformat (input, "%d inner-dot1q %d", &outer_vlan, &inner_vlan))
 651     {
 652       template->sub.eth.flags.two_tags = 1;
 653       template->sub.eth.outer_vlan_id = outer_vlan;
 654       template->sub.eth.inner_vlan_id = inner_vlan;
 655     }
 656   else if (unformat (input, "%d", &outer_vlan))
 657     {
 658       template->sub.eth.flags.one_tag = 1;
 659       template->sub.eth.outer_vlan_id = outer_vlan;
 660     }
 661   else
 662     {
 663       error = clib_error_return (0, "expected dot1q config, got `%U'",
 664                                  format_unformat_error, input);
 665       goto done;
 666     }
 667
 668   if (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 669     {
 670       if (unformat (input, "exact-match"))
 671         {
 672           template->sub.eth.flags.exact_match = 1;
 673         }
 674     }
 675
 676 done:
 677   return error;
 678 }
 679
 680 static clib_error_t *
 681 create_sub_interfaces (vlib_main_t * vm,
 682                        unformat_input_t * input, vlib_cli_command_t * cmd)
 683 {
 684   vnet_main_t *vnm = vnet_get_main ();
 685   clib_error_t *error = 0;
 686   u32 hw_if_index, sw_if_index;
 687   vnet_hw_interface_t *hi;
 688   u32 id, id_min, id_max;
 689   vnet_sw_interface_t template;
 690
 691   hw_if_index = ~0;
 692   if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
 693     {
 694       error = clib_error_return (0, "unknown interface `%U'",
 695                                  format_unformat_error, input);
 696       goto done;
 697     }
 698
 699   memset (&template, 0, sizeof (template));
 700   template.sub.eth.raw_flags = 0;
 701
 702   if (unformat (input, "%d default", &id_min))
 703     {
 704       id_max = id_min;
 705       template.sub.eth.flags.default_sub = 1;
 706     }
 707   else if (unformat (input, "%d untagged", &id_min))
 708     {
 709       id_max = id_min;
 710       template.sub.eth.flags.no_tags = 1;
 711       template.sub.eth.flags.exact_match = 1;
 712     }
 713   else if (unformat (input, "%d dot1q", &id_min))
 714     {
 715       /* parse dot1q config */
 716       id_max = id_min;
 717       error = parse_vlan_sub_interfaces (input, &template);
 718       if (error)
 719         goto done;
 720     }
 721   else if (unformat (input, "%d dot1ad", &id_min))
 722     {
 723       /* parse dot1ad config */
 724       id_max = id_min;
 725       template.sub.eth.flags.dot1ad = 1;
 726       error = parse_vlan_sub_interfaces (input, &template);
 727       if (error)
 728         goto done;
 729     }
 730   else if (unformat (input, "%d-%d", &id_min, &id_max))
 731     {
 732       template.sub.eth.flags.one_tag = 1;
 733       template.sub.eth.flags.exact_match = 1;
 734       if (id_min > id_max)
 735         goto id_error;
 736     }
 737   else if (unformat (input, "%d", &id_min))
 738     {
 739       id_max = id_min;
 740       template.sub.eth.flags.one_tag = 1;
 741       template.sub.eth.outer_vlan_id = id_min;
 742       template.sub.eth.flags.exact_match = 1;
 743     }
 744   else
 745     {
 746     id_error:
 747       error = clib_error_return (0, "expected ID or ID MIN-MAX, got `%U'",
 748                                  format_unformat_error, input);
 749       goto done;
 750     }
 751
 752   hi = vnet_get_hw_interface (vnm, hw_if_index);
 753
 754   if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
 755     {
 756       error =
 757         clib_error_return (0,
 758                            "not allowed as %v belong to a BondEthernet interface",
 759                            hi->name);
 760       goto done;
 761     }
 762
 763   for (id = id_min; id <= id_max; id++)
 764     {
 765       uword *p;
 766       vnet_interface_main_t *im = &vnm->interface_main;
 767       u64 sup_and_sub_key = ((u64) (hi->sw_if_index) << 32) | (u64) id;
 768       u64 *kp;
 769
 770       p = hash_get_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
 771       if (p)
 772         {
 773           if (CLIB_DEBUG > 0)
 774             clib_warning ("sup sw_if_index %d, sub id %d already exists\n",
 775                           hi->sw_if_index, id);
 776           continue;
 777         }
 778
 779       kp = clib_mem_alloc (sizeof (*kp));
 780       *kp = sup_and_sub_key;
 781
 782       template.type = VNET_SW_INTERFACE_TYPE_SUB;
 783       template.flood_class = VNET_FLOOD_CLASS_NORMAL;
 784       template.sup_sw_if_index = hi->sw_if_index;
 785       template.sub.id = id;
 786       if (id_min < id_max)
 787         template.sub.eth.outer_vlan_id = id;
 788
 789       error = vnet_create_sw_interface (vnm, &template, &sw_if_index);
 790       if (error)
 791         goto done;
 792
 793       hash_set (hi->sub_interface_sw_if_index_by_id, id, sw_if_index);
 794       hash_set_mem (im->sw_if_index_by_sup_and_sub, kp, sw_if_index);
 795       vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
 796                        vnet_get_main (), sw_if_index);
 797     }
 798
 799 done:
 800   return error;
 801 }
 802
 803 /*?
 804  * This command is used to add VLAN IDs to interfaces, also known as subinterfaces.
 805  * The primary input to this command is the '<em>interface</em>' and '<em>subId</em>'
 806  * (subinterface Id) parameters. If no additional VLAN ID is provide, the VLAN ID is
 807  * assumed to be the '<em>subId</em>'. The VLAN ID and '<em>subId</em>' can be different,
 808  * but this is not recommended.
 809  *
 810  * This command has several variations:
 811  * - <b>create sub-interfaces <interface> <subId></b> - Create a subinterface to
 812  * process packets with a given 802.1q VLAN ID (same value as the '<em>subId</em>').
 813  *
 814  * - <b>create sub-interfaces <interface> <subId> default</b> - Adding the
 815  * '<em>default</em>' parameter indicates that packets with VLAN IDs that do not
 816  * match any other subinterfaces should be sent to this subinterface.
 817  *
 818  * - <b>create sub-interfaces <interface> <subId> untagged</b> - Adding the
 819  * '<em>untagged</em>' parameter indicates that packets no VLAN IDs should be sent
 820  * to this subinterface.
 821  *
 822  * - <b>create sub-interfaces <interface> <subId>-<subId></b> - Create a range of
 823  * subinterfaces to handle a range of VLAN IDs.
 824  *
 825  * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any [exact-match]</b> -
 826  * Use this command to specify the outer VLAN ID, to either be explicited or to make the
 827  * VLAN ID different from the '<em>subId</em>'.
 828  *
 829  * - <b>create sub-interfaces <interface> <subId> dot1q|dot1ad <vlanId>|any inner-dot1q
 830  * <vlanId>|any [exact-match]</b> - Use this command to specify the outer VLAN ID and
 831  * the innner VLAN ID.
 832  *
 833  * When '<em>dot1q</em>' or '<em>dot1ad</em>' is explictly entered, subinterfaces
 834  * can be configured as either exact-match or non-exact match. Non-exact match is the CLI
 835  * default. If '<em>exact-match</em>' is specified, packets must have the same number of
 836  * VLAN tags as the configuration. For non-exact-match, packets must at least that number
 837  * of tags. L3 (routed) interfaces must be configured as exact-match. L2 interfaces are
 838  * typically configured as non-exact-match. If '<em>dot1q</em>' or '<em>dot1ad</em>' is NOT
 839  * entered, then the default behavior is exact-match.
 840  *
 841  * Use the '<em>show interface</em>' command to display all subinterfaces.
 842  *
 843  * @cliexpar
 844  * @parblock
 845  * Example of how to create a VLAN subinterface 11 to process packets on 802.1q VLAN ID 11:
 846  * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11}
 847  *
 848  * The previous example is shorthand and is equivalent to:
 849  * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 11 exact-match}
 850  *
 851  *
 852  * Example of how to create a subinterface number that is different from the VLAN ID:
 853  * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100}
 854  *
 855  *
 856  * Examples of how to create q-in-q and q-in-any subinterfaces:
 857  * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1q 100 inner-dot1q 200}
 858  * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1q 100 inner-dot1q any}
 859  *
 860  * Examples of how to create dot1ad interfaces:
 861  * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 11 dot1ad 11}
 862  * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 12 dot1ad 100 inner-dot1q 200}
 863  *
 864  *
 865  * Examples of '<em>exact-match</em>' versus non-exact match. A packet with
 866  * outer VLAN 100 and inner VLAN 200 would match this interface, because the default
 867  * is non-exact match:
 868  * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100}
 869  *
 870  * However, the same packet would NOT match this interface because '<em>exact-match</em>'
 871  * is specified and only one VLAN is configured, but packet contains two VLANs:
 872  * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 dot1q 100 exact-match}
 873  *
 874  *
 875  * Example of how to created a subinterface to process untagged packets:
 876  * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 5 untagged}
 877  *
 878  * Example of how to created a subinterface to process any packet with a VLAN ID that
 879  * does not match any other subinterface:
 880  * @cliexcmd{create sub-interfaces GigabitEthernet2/0/0 7 default}
 881  *
 882  * When subinterfaces are created, they are in the down state. Example of how to
 883  * enable a newly created subinterface:
 884  * @cliexcmd{set interface GigabitEthernet2/0/0.7 up}
 885  * @endparblock
 886  ?*/
 887 /* *INDENT-OFF* */
 888 VLIB_CLI_COMMAND (create_sub_interfaces_command, static) = {
 889   .path = "create sub-interfaces",
 890   .short_help = "create sub-interfaces <interface> "
 891     "{<subId> [default|untagged]} | "
 892     "{<subId>-<subId>} | "
 893     "{<subId> dot1q|dot1ad <vlanId>|any [inner-dot1q <vlanId>|any] [exact-match]}",
 894   .function = create_sub_interfaces,
 895 };
 896 /* *INDENT-ON* */
 897
 898 static clib_error_t *
 899 set_state (vlib_main_t * vm,
 900            unformat_input_t * input, vlib_cli_command_t * cmd)
 901 {
 902   vnet_main_t *vnm = vnet_get_main ();
 903   clib_error_t *error;
 904   u32 sw_if_index, flags;
 905
 906   sw_if_index = ~0;
 907   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 908     {
 909       error = clib_error_return (0, "unknown interface `%U'",
 910                                  format_unformat_error, input);
 911       goto done;
 912     }
 913
 914   if (!unformat (input, "%U", unformat_vnet_sw_interface_flags, &flags))
 915     {
 916       error = clib_error_return (0, "unknown flags `%U'",
 917                                  format_unformat_error, input);
 918       goto done;
 919     }
 920
 921   error = vnet_sw_interface_set_flags (vnm, sw_if_index, flags);
 922   if (error)
 923     goto done;
 924
 925 done:
 926   return error;
 927 }
 928
 929
 930 /*?
 931  * This command is used to change the admin state (up/down) of an interface.
 932  *
 933  * If an interface is down, the optional '<em>punt</em>' flag can also be set.
 934  * The '<em>punt</em>' flag implies the interface is disabled for forwarding
 935  * but punt all traffic to slow-path. Use the '<em>enable</em>' flag to clear
 936  * '<em>punt</em>' flag (interface is still down).
 937  *
 938  * @cliexpar
 939  * Example of how to configure the admin state of an interface to '<em>up</em?':
 940  * @cliexcmd{set interface state GigabitEthernet2/0/0 up}
 941  * Example of how to configure the admin state of an interface to '<em>down</em?':
 942  * @cliexcmd{set interface state GigabitEthernet2/0/0 down}
 943  ?*/
 944 /* *INDENT-OFF* */
 945 VLIB_CLI_COMMAND (set_state_command, static) = {
 946   .path = "set interface state",
 947   .short_help = "set interface state <interface> [up|down|punt|enable]",
 948   .function = set_state,
 949 };
 950 /* *INDENT-ON* */
 951
 952 static clib_error_t *
 953 set_unnumbered (vlib_main_t * vm,
 954                 unformat_input_t * input, vlib_cli_command_t * cmd)
 955 {
 956   vnet_main_t *vnm = vnet_get_main ();
 957   u32 unnumbered_sw_if_index;
 958   u32 inherit_from_sw_if_index;
 959   vnet_sw_interface_t *si;
 960   int is_set = 0;
 961   int is_del = 0;
 962   u32 was_unnum;
 963
 964   if (unformat (input, "%U use %U",
 965                 unformat_vnet_sw_interface, vnm, &unnumbered_sw_if_index,
 966                 unformat_vnet_sw_interface, vnm, &inherit_from_sw_if_index))
 967     is_set = 1;
 968   else if (unformat (input, "del %U",
 969                      unformat_vnet_sw_interface, vnm,
 970                      &unnumbered_sw_if_index))
 971     is_del = 1;
 972   else
 973     return clib_error_return (0, "parse error '%U'",
 974                               format_unformat_error, input);
 975
 976   si = vnet_get_sw_interface (vnm, unnumbered_sw_if_index);
 977   was_unnum = (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED);
 978
 979   if (is_del)
 980     {
 981       si->flags &= ~(VNET_SW_INTERFACE_FLAG_UNNUMBERED);
 982       si->unnumbered_sw_if_index = (u32) ~ 0;
 983
 984       ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
 985         [unnumbered_sw_if_index] = ~0;
 986       ip6_main.lookup_main.if_address_pool_index_by_sw_if_index
 987         [unnumbered_sw_if_index] = ~0;
 988     }
 989   else if (is_set)
 990     {
 991       si->flags |= VNET_SW_INTERFACE_FLAG_UNNUMBERED;
 992       si->unnumbered_sw_if_index = inherit_from_sw_if_index;
 993
 994       ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
 995         [unnumbered_sw_if_index] =
 996         ip4_main.lookup_main.if_address_pool_index_by_sw_if_index
 997         [inherit_from_sw_if_index];
 998       ip6_main.lookup_main.if_address_pool_index_by_sw_if_index
 999         [unnumbered_sw_if_index] =
1000         ip6_main.lookup_main.if_address_pool_index_by_sw_if_index
1001         [inherit_from_sw_if_index];
1002     }
1003
1004   if (was_unnum != (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED))
1005     {
1006       ip4_sw_interface_enable_disable (unnumbered_sw_if_index, !is_del);
1007       ip6_sw_interface_enable_disable (unnumbered_sw_if_index, !is_del);
1008     }
1009
1010   return 0;
1011 }
1012
1013 /* *INDENT-OFF* */
1014 VLIB_CLI_COMMAND (set_unnumbered_command, static) = {
1015   .path = "set interface unnumbered",
1016   .short_help = "set interface unnumbered [<interface> use <interface> | del <interface>]",
1017   .function = set_unnumbered,
1018 };
1019 /* *INDENT-ON* */
1020
1021
1022
1023 static clib_error_t *
1024 set_hw_class (vlib_main_t * vm,
1025               unformat_input_t * input, vlib_cli_command_t * cmd)
1026 {
1027   vnet_main_t *vnm = vnet_get_main ();
1028   vnet_interface_main_t *im = &vnm->interface_main;
1029   clib_error_t *error;
1030   u32 hw_if_index, hw_class_index;
1031
1032   hw_if_index = ~0;
1033   if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
1034     {
1035       error = clib_error_return (0, "unknown hardware interface `%U'",
1036                                  format_unformat_error, input);
1037       goto done;
1038     }
1039
1040   if (!unformat_user (input, unformat_hash_string,
1041                       im->hw_interface_class_by_name, &hw_class_index))
1042     {
1043       error = clib_error_return (0, "unknown hardware class `%U'",
1044                                  format_unformat_error, input);
1045       goto done;
1046     }
1047
1048   error = vnet_hw_interface_set_class (vnm, hw_if_index, hw_class_index);
1049   if (error)
1050     goto done;
1051
1052 done:
1053   return error;
1054 }
1055
1056 /* *INDENT-OFF* */
1057 VLIB_CLI_COMMAND (set_hw_class_command, static) = {
1058   .path = "set interface hw-class",
1059   .short_help = "Set interface hardware class",
1060   .function = set_hw_class,
1061 };
1062 /* *INDENT-ON* */
1063
1064 static clib_error_t *
1065 vnet_interface_cli_init (vlib_main_t * vm)
1066 {
1067   return 0;
1068 }
1069
1070 VLIB_INIT_FUNCTION (vnet_interface_cli_init);
1071
1072 static clib_error_t *
1073 renumber_interface_command_fn (vlib_main_t * vm,
1074                                unformat_input_t * input,
1075                                vlib_cli_command_t * cmd)
1076 {
1077   u32 hw_if_index;
1078   u32 new_dev_instance;
1079   vnet_main_t *vnm = vnet_get_main ();
1080   int rv;
1081
1082   if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
1083     return clib_error_return (0, "unknown hardware interface `%U'",
1084                               format_unformat_error, input);
1085
1086   if (!unformat (input, "%d", &new_dev_instance))
1087     return clib_error_return (0, "new dev instance missing");
1088
1089   rv = vnet_interface_name_renumber (hw_if_index, new_dev_instance);
1090
1091   switch (rv)
1092     {
1093     case 0:
1094       break;
1095
1096     default:
1097       return clib_error_return (0, "vnet_interface_name_renumber returned %d",
1098                                 rv);
1099
1100     }
1101
1102   return 0;
1103 }
1104
1105
1106 /* *INDENT-OFF* */
1107 VLIB_CLI_COMMAND (renumber_interface_command, static) = {
1108   .path = "renumber interface",
1109   .short_help = "renumber interface <interface> <new-dev-instance>",
1110   .function = renumber_interface_command_fn,
1111 };
1112 /* *INDENT-ON* */
1113
1114 static clib_error_t *
1115 promiscuous_cmd (vlib_main_t * vm,
1116                  unformat_input_t * input, vlib_cli_command_t * cmd)
1117 {
1118   vnet_main_t *vnm = vnet_get_main ();
1119   u32 hw_if_index;
1120   u32 flags = ETHERNET_INTERFACE_FLAG_ACCEPT_ALL;
1121   ethernet_main_t *em = &ethernet_main;
1122   ethernet_interface_t *eif;
1123
1124   if (unformat (input, "on %U",
1125                 unformat_vnet_hw_interface, vnm, &hw_if_index))
1126     ;
1127   else if (unformat (input, "off %U",
1128                      unformat_ethernet_interface, vnm, &hw_if_index))
1129     flags = 0;
1130   else
1131     return clib_error_return (0, "unknown input `%U'",
1132                               format_unformat_error, input);
1133
1134   eif = ethernet_get_interface (em, hw_if_index);
1135   if (!eif)
1136     return clib_error_return (0, "not supported");
1137
1138   ethernet_set_flags (vnm, hw_if_index, flags);
1139   return 0;
1140 }
1141
1142 /* *INDENT-OFF* */
1143 VLIB_CLI_COMMAND (set_interface_promiscuous_cmd, static) = {
1144   .path = "set interface promiscuous",
1145   .short_help = "set interface promiscuous [on|off] <interface>",
1146   .function = promiscuous_cmd,
1147 };
1148 /* *INDENT-ON* */
1149
1150 static clib_error_t *
1151 mtu_cmd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1152 {
1153   vnet_main_t *vnm = vnet_get_main ();
1154   u32 hw_if_index, mtu;
1155   u32 flags = ETHERNET_INTERFACE_FLAG_MTU;
1156   ethernet_main_t *em = &ethernet_main;
1157
1158   if (unformat (input, "%d %U", &mtu,
1159                 unformat_vnet_hw_interface, vnm, &hw_if_index))
1160     {
1161       vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
1162       ethernet_interface_t *eif = ethernet_get_interface (em, hw_if_index);
1163
1164       if (!eif)
1165         return clib_error_return (0, "not supported");
1166
1167       if (mtu < hi->min_supported_packet_bytes)
1168         return clib_error_return (0, "Invalid mtu (%d): "
1169                                   "must be >= min pkt bytes (%d)", mtu,
1170                                   hi->min_supported_packet_bytes);
1171
1172       if (mtu > hi->max_supported_packet_bytes)
1173         return clib_error_return (0, "Invalid mtu (%d): must be <= (%d)", mtu,
1174                                   hi->max_supported_packet_bytes);
1175
1176       if (hi->max_packet_bytes != mtu)
1177         {
1178           hi->max_packet_bytes = mtu;
1179           ethernet_set_flags (vnm, hw_if_index, flags);
1180         }
1181     }
1182   else
1183     return clib_error_return (0, "unknown input `%U'",
1184                               format_unformat_error, input);
1185   return 0;
1186 }
1187
1188 /* *INDENT-OFF* */
1189 VLIB_CLI_COMMAND (set_interface_mtu_cmd, static) = {
1190   .path = "set interface mtu",
1191   .short_help = "set interface mtu <value> <interface>",
1192   .function = mtu_cmd,
1193 };
1194 /* *INDENT-ON* */
1195
1196 static clib_error_t *
1197 set_interface_mac_address (vlib_main_t * vm, unformat_input_t * input,
1198                            vlib_cli_command_t * cmd)
1199 {
1200   vnet_main_t *vnm = vnet_get_main ();
1201   vnet_sw_interface_t *si = NULL;
1202   clib_error_t *error = 0;
1203   u32 sw_if_index = ~0;
1204   u64 mac = 0;
1205
1206   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1207     {
1208       error = clib_error_return (0, "unknown interface `%U'",
1209                                  format_unformat_error, input);
1210       goto done;
1211     }
1212   if (!unformat_user (input, unformat_ethernet_address, &mac))
1213     {
1214       error = clib_error_return (0, "expected mac address `%U'",
1215                                  format_unformat_error, input);
1216       goto done;
1217     }
1218   si = vnet_get_sw_interface (vnm, sw_if_index);
1219   error = vnet_hw_interface_change_mac_address (vnm, si->hw_if_index, mac);
1220 done:
1221   return error;
1222 }
1223
1224 /*?
1225  * The '<em>set interface mac address </em>' command allows to set MAC address of given interface.
1226  * In case of NIC interfaces the one has to support MAC address change. A side effect of MAC address
1227  * change are changes of MAC addresses in FIB tables (ipv4 and ipv6).
1228  *
1229  * @cliexpar
1230  * @parblock
1231  * Example of how to change MAC Address of interface:
1232  * @cliexcmd{set interface mac address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01}
1233  * @cliexcmd{set interface mac address host-vpp0 aa:bb:cc:dd:ee:02}
1234  * @cliexcmd{set interface mac address tap-0 aa:bb:cc:dd:ee:03}
1235  * @cliexcmd{set interface mac address pg0 aa:bb:cc:dd:ee:04}
1236  * @endparblock
1237 ?*/
1238 /* *INDENT-OFF* */
1239 VLIB_CLI_COMMAND (set_interface_mac_address_cmd, static) = {
1240   .path = "set interface mac address",
1241   .short_help = "set interface mac address <interface> <mac-address>",
1242   .function = set_interface_mac_address,
1243 };
1244 /* *INDENT-ON* */
1245
1246 static clib_error_t *
1247 set_tag (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1248 {
1249   vnet_main_t *vnm = vnet_get_main ();
1250   u32 sw_if_index = ~0;
1251   u8 *tag = 0;
1252
1253   if (!unformat (input, "%U %s", unformat_vnet_sw_interface,
1254                  vnm, &sw_if_index, &tag))
1255     return clib_error_return (0, "unknown input `%U'",
1256                               format_unformat_error, input);
1257
1258   vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
1259
1260   return 0;
1261 }
1262
1263 /* *INDENT-OFF* */
1264 VLIB_CLI_COMMAND (set_tag_command, static) = {
1265   .path = "set interface tag",
1266   .short_help = "set interface tag <interface> <tag>",
1267   .function = set_tag,
1268 };
1269 /* *INDENT-ON* */
1270
1271 static clib_error_t *
1272 clear_tag (vlib_main_t * vm, unformat_input_t * input,
1273            vlib_cli_command_t * cmd)
1274 {
1275   vnet_main_t *vnm = vnet_get_main ();
1276   u32 sw_if_index = ~0;
1277
1278   if (!unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1279     return clib_error_return (0, "unknown input `%U'",
1280                               format_unformat_error, input);
1281
1282   vnet_clear_sw_interface_tag (vnm, sw_if_index);
1283
1284   return 0;
1285 }
1286
1287 /* *INDENT-OFF* */
1288 VLIB_CLI_COMMAND (clear_tag_command, static) = {
1289   .path = "clear interface tag",
1290   .short_help = "clear interface tag <interface>",
1291   .function = clear_tag,
1292 };
1293 /* *INDENT-ON* */
1294
1295 static clib_error_t *
1296 set_hw_interface_rx_mode (vnet_main_t * vnm, u32 hw_if_index,
1297                           u32 queue_id, vnet_hw_interface_rx_mode mode)
1298 {
1299   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1300   vnet_device_class_t *dev_class =
1301     vnet_get_device_class (vnm, hw->dev_class_index);
1302   clib_error_t *error;
1303   vnet_hw_interface_rx_mode old_mode;
1304   int rv;
1305
1306   if (mode == VNET_HW_INTERFACE_RX_MODE_DEFAULT)
1307     mode = hw->default_rx_mode;
1308
1309   rv = vnet_hw_interface_get_rx_mode (vnm, hw_if_index, queue_id, &old_mode);
1310   switch (rv)
1311     {
1312     case 0:
1313       if (old_mode == mode)
1314         return 0;               /* same rx-mode, no change */
1315       break;
1316     case VNET_API_ERROR_INVALID_INTERFACE:
1317       return clib_error_return (0, "invalid interface");
1318     case VNET_API_ERROR_INVALID_QUEUE:
1319       return clib_error_return (0, "invalid queue");
1320     default:
1321       return clib_error_return (0, "unknown error");
1322     }
1323
1324   if (dev_class->rx_mode_change_function)
1325     {
1326       error = dev_class->rx_mode_change_function (vnm, hw_if_index, queue_id,
1327                                                   mode);
1328       if (error)
1329         return (error);
1330     }
1331
1332   rv = vnet_hw_interface_set_rx_mode (vnm, hw_if_index, queue_id, mode);
1333   switch (rv)
1334     {
1335     case 0:
1336       break;
1337     case VNET_API_ERROR_UNSUPPORTED:
1338       return clib_error_return (0, "unsupported");
1339     case VNET_API_ERROR_INVALID_INTERFACE:
1340       return clib_error_return (0, "invalid interface");
1341     case VNET_API_ERROR_INVALID_QUEUE:
1342       return clib_error_return (0, "invalid queue");
1343     default:
1344       return clib_error_return (0, "unknown error");
1345     }
1346
1347   return 0;
1348 }
1349
1350 static clib_error_t *
1351 set_interface_rx_mode (vlib_main_t * vm, unformat_input_t * input,
1352                        vlib_cli_command_t * cmd)
1353 {
1354   clib_error_t *error = 0;
1355   unformat_input_t _line_input, *line_input = &_line_input;
1356   vnet_main_t *vnm = vnet_get_main ();
1357   vnet_hw_interface_t *hw;
1358   u32 hw_if_index = (u32) ~ 0;
1359   u32 queue_id = (u32) ~ 0;
1360   vnet_hw_interface_rx_mode mode = VNET_HW_INTERFACE_RX_MODE_UNKNOWN;
1361   int i;
1362   u8 input_queue_id = 0;
1363
1364   if (!unformat_user (input, unformat_line_input, line_input))
1365     return 0;
1366
1367   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1368     {
1369       if (unformat
1370           (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1371         ;
1372       else if (unformat (line_input, "queue %d", &queue_id))
1373         input_queue_id = 1;
1374       else if (unformat (line_input, "polling"))
1375         mode = VNET_HW_INTERFACE_RX_MODE_POLLING;
1376       else if (unformat (line_input, "interrupt"))
1377         mode = VNET_HW_INTERFACE_RX_MODE_INTERRUPT;
1378       else if (unformat (line_input, "adaptive"))
1379         mode = VNET_HW_INTERFACE_RX_MODE_ADAPTIVE;
1380       else
1381         {
1382           error = clib_error_return (0, "parse error: '%U'",
1383                                      format_unformat_error, line_input);
1384           unformat_free (line_input);
1385           return error;
1386         }
1387     }
1388
1389   unformat_free (line_input);
1390
1391   if (hw_if_index == (u32) ~ 0)
1392     return clib_error_return (0, "please specify valid interface name");
1393
1394   if (mode == VNET_HW_INTERFACE_RX_MODE_UNKNOWN)
1395     return clib_error_return (0, "please specify valid rx-mode");
1396
1397   hw = vnet_get_hw_interface (vnm, hw_if_index);
1398
1399   if (input_queue_id == 0)
1400     {
1401       for (i = 0; i < vec_len (hw->dq_runtime_index_by_queue); i++)
1402         {
1403           error = set_hw_interface_rx_mode (vnm, hw_if_index, i, mode);
1404           if (error)
1405             break;
1406         }
1407       hw->default_rx_mode = mode;
1408     }
1409   else
1410     error = set_hw_interface_rx_mode (vnm, hw_if_index, queue_id, mode);
1411
1412   return (error);
1413 }
1414
1415 /*?
1416  * This command is used to assign the RX packet processing mode (polling,
1417  * interrupt, adaptive) of the a given interface, and optionally a
1418  * given queue. If the '<em>queue</em>' is not provided, the '<em>mode</em>'
1419  * is applied to all queues of the interface. Not all interfaces support
1420  * all modes. To display the current rx-mode use the command
1421  * '<em>show interface rx-placement</em>'.
1422  *
1423  * @cliexpar
1424  * Example of how to assign rx-mode to all queues on an interface:
1425  * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 polling}
1426  * Example of how to assign rx-mode to one queue of an interface:
1427  * @cliexcmd{set interface rx-mode VirtualEthernet0/0/12 queue 0 interrupt}
1428  * Example of how to display the rx-mode of all interfaces:
1429  * @cliexstart{show interface rx-placement}
1430  * Thread 1 (vpp_wk_0):
1431  *   node dpdk-input:
1432  *     GigabitEthernet7/0/0 queue 0 (polling)
1433  *   node vhost-user-input:
1434  *     VirtualEthernet0/0/12 queue 0 (interrupt)
1435  *     VirtualEthernet0/0/12 queue 2 (polling)
1436  *     VirtualEthernet0/0/13 queue 0 (polling)
1437  *     VirtualEthernet0/0/13 queue 2 (polling)
1438  * Thread 2 (vpp_wk_1):
1439  *   node dpdk-input:
1440  *     GigabitEthernet7/0/1 queue 0 (polling)
1441  *   node vhost-user-input:
1442  *     VirtualEthernet0/0/12 queue 1 (polling)
1443  *     VirtualEthernet0/0/12 queue 3 (polling)
1444  *     VirtualEthernet0/0/13 queue 1 (polling)
1445  *     VirtualEthernet0/0/13 queue 3 (polling)
1446  * @cliexend
1447 ?*/
1448 /* *INDENT-OFF* */
1449 VLIB_CLI_COMMAND (cmd_set_if_rx_mode,static) = {
1450     .path = "set interface rx-mode",
1451     .short_help = "set interface rx-mode <interface> [queue <n>] [polling | interrupt | adaptive]",
1452     .function = set_interface_rx_mode,
1453 };
1454 /* *INDENT-ON* */
1455
1456 static clib_error_t *
1457 show_interface_rx_placement_fn (vlib_main_t * vm, unformat_input_t * input,
1458                                 vlib_cli_command_t * cmd)
1459 {
1460   u8 *s = 0;
1461   vnet_main_t *vnm = vnet_get_main ();
1462   vnet_device_input_runtime_t *rt;
1463   vnet_device_and_queue_t *dq;
1464   vlib_node_t *pn = vlib_get_node_by_name (vm, (u8 *) "device-input");
1465   uword si;
1466   int index = 0;
1467
1468   /* *INDENT-OFF* */
1469   foreach_vlib_main (({
1470     clib_bitmap_foreach (si, pn->sibling_bitmap,
1471       ({
1472         rt = vlib_node_get_runtime_data (this_vlib_main, si);
1473
1474         if (vec_len (rt->devices_and_queues))
1475           s = format (s, "  node %U:\n", format_vlib_node_name, vm, si);
1476
1477         vec_foreach (dq, rt->devices_and_queues)
1478           {
1479             vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm,
1480                                                              dq->hw_if_index);
1481             s = format (s, "    %U queue %u (%U)\n",
1482                         format_vnet_sw_if_index_name, vnm, hi->sw_if_index,
1483                         dq->queue_id,
1484                         format_vnet_hw_interface_rx_mode, dq->mode);
1485           }
1486       }));
1487     if (vec_len (s) > 0)
1488       {
1489         vlib_cli_output(vm, "Thread %u (%v):\n%v", index,
1490                         vlib_worker_threads[index].name, s);
1491         vec_reset_length (s);
1492       }
1493     index++;
1494   }));
1495   /* *INDENT-ON* */
1496
1497   vec_free (s);
1498   return 0;
1499 }
1500
1501 /*?
1502  * This command is used to display the interface and queue worker
1503  * thread placement.
1504  *
1505  * @cliexpar
1506  * Example of how to display the interface placement:
1507  * @cliexstart{show interface rx-placement}
1508  * Thread 1 (vpp_wk_0):
1509  *   node dpdk-input:
1510  *     GigabitEthernet7/0/0 queue 0 (polling)
1511  *   node vhost-user-input:
1512  *     VirtualEthernet0/0/12 queue 0 (polling)
1513  *     VirtualEthernet0/0/12 queue 2 (polling)
1514  *     VirtualEthernet0/0/13 queue 0 (polling)
1515  *     VirtualEthernet0/0/13 queue 2 (polling)
1516  * Thread 2 (vpp_wk_1):
1517  *   node dpdk-input:
1518  *     GigabitEthernet7/0/1 queue 0 (polling)
1519  *   node vhost-user-input:
1520  *     VirtualEthernet0/0/12 queue 1 (polling)
1521  *     VirtualEthernet0/0/12 queue 3 (polling)
1522  *     VirtualEthernet0/0/13 queue 1 (polling)
1523  *     VirtualEthernet0/0/13 queue 3 (polling)
1524  * @cliexend
1525 ?*/
1526 /* *INDENT-OFF* */
1527 VLIB_CLI_COMMAND (show_interface_rx_placement, static) = {
1528   .path = "show interface rx-placement",
1529   .short_help = "show interface rx-placement",
1530   .function = show_interface_rx_placement_fn,
1531 };
1532 /* *INDENT-ON* */
1533
1534 static clib_error_t *
1535 set_interface_rx_placement (vlib_main_t * vm, unformat_input_t * input,
1536                             vlib_cli_command_t * cmd)
1537 {
1538   clib_error_t *error = 0;
1539   unformat_input_t _line_input, *line_input = &_line_input;
1540   vnet_main_t *vnm = vnet_get_main ();
1541   vnet_device_main_t *vdm = &vnet_device_main;
1542   vnet_hw_interface_rx_mode mode;
1543   u32 hw_if_index = (u32) ~ 0;
1544   u32 queue_id = (u32) 0;
1545   u32 thread_index = (u32) ~ 0;
1546   int rv;
1547
1548   if (!unformat_user (input, unformat_line_input, line_input))
1549     return 0;
1550
1551   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1552     {
1553       if (unformat
1554           (line_input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
1555         ;
1556       else if (unformat (line_input, "queue %d", &queue_id))
1557         ;
1558       else if (unformat (line_input, "main", &thread_index))
1559         thread_index = 0;
1560       else if (unformat (line_input, "worker %d", &thread_index))
1561         thread_index += vdm->first_worker_thread_index;
1562       else
1563         {
1564           error = clib_error_return (0, "parse error: '%U'",
1565                                      format_unformat_error, line_input);
1566           unformat_free (line_input);
1567           return error;
1568         }
1569     }
1570
1571   unformat_free (line_input);
1572
1573   if (hw_if_index == (u32) ~ 0)
1574     return clib_error_return (0, "please specify valid interface name");
1575
1576   if (thread_index > vdm->last_worker_thread_index)
1577     return clib_error_return (0,
1578                               "please specify valid worker thread or main");
1579
1580   rv = vnet_hw_interface_get_rx_mode (vnm, hw_if_index, queue_id, &mode);
1581
1582   if (rv)
1583     return clib_error_return (0, "not found");
1584
1585   rv = vnet_hw_interface_unassign_rx_thread (vnm, hw_if_index, queue_id);
1586
1587   if (rv)
1588     return clib_error_return (0, "not found");
1589
1590   vnet_hw_interface_assign_rx_thread (vnm, hw_if_index, queue_id,
1591                                       thread_index);
1592   vnet_hw_interface_set_rx_mode (vnm, hw_if_index, queue_id, mode);
1593
1594   return 0;
1595 }
1596
1597 /*?
1598  * This command is used to assign a given interface, and optionally a
1599  * given queue, to a different thread. If the '<em>queue</em>' is not provided,
1600  * it defaults to 0. The '<em>worker</em>' parameter is zero based and the index
1601  * in the thread name, for example, 0 in the thread name '<em>vpp_wk_0</em>'.
1602  *
1603  * @cliexpar
1604  * Example of how to display the interface placement:
1605  * @cliexstart{show interface rx-placement}
1606  * Thread 1 (vpp_wk_0):
1607  *   node dpdk-input:
1608  *     GigabitEthernet7/0/0 queue 0 (polling)
1609  *   node vhost-user-input:
1610  *     VirtualEthernet0/0/12 queue 0 (polling)
1611  *     VirtualEthernet0/0/12 queue 2 (polling)
1612  *     VirtualEthernet0/0/13 queue 0 (polling)
1613  *     VirtualEthernet0/0/13 queue 2 (polling)
1614  * Thread 2 (vpp_wk_1):
1615  *   node dpdk-input:
1616  *     GigabitEthernet7/0/1 queue 0 (polling)
1617  *   node vhost-user-input:
1618  *     VirtualEthernet0/0/12 queue 1 (polling)
1619  *     VirtualEthernet0/0/12 queue 3 (polling)
1620  *     VirtualEthernet0/0/13 queue 1 (polling)
1621  *     VirtualEthernet0/0/13 queue 3 (polling)
1622  * @cliexend
1623  * Example of how to assign a interface and queue to a worker thread:
1624  * @cliexcmd{set interface rx-placement VirtualEthernet0/0/12 queue 1 worker 0}
1625  * Example of how to display the interface placement:
1626  * @cliexstart{show interface rx-placement}
1627  * Thread 1 (vpp_wk_0):
1628  *   node dpdk-input:
1629  *     GigabitEthernet7/0/0 queue 0 (polling)
1630  *   node vhost-user-input:
1631  *     VirtualEthernet0/0/12 queue 0 (polling)
1632  *     VirtualEthernet0/0/12 queue 1 (polling)
1633  *     VirtualEthernet0/0/12 queue 2 (polling)
1634  *     VirtualEthernet0/0/13 queue 0 (polling)
1635  *     VirtualEthernet0/0/13 queue 2 (polling)
1636  * Thread 2 (vpp_wk_1):
1637  *   node dpdk-input:
1638  *     GigabitEthernet7/0/1 queue 0 (polling)
1639  *   node vhost-user-input:
1640  *     VirtualEthernet0/0/12 queue 3 (polling)
1641  *     VirtualEthernet0/0/13 queue 1 (polling)
1642  *     VirtualEthernet0/0/13 queue 3 (polling)
1643  * @cliexend
1644 ?*/
1645 /* *INDENT-OFF* */
1646 VLIB_CLI_COMMAND (cmd_set_if_rx_placement,static) = {
1647     .path = "set interface rx-placement",
1648     .short_help = "set interface rx-placement <interface> [queue <n>] "
1649       "[worker <n> | main]",
1650     .function = set_interface_rx_placement,
1651     .is_mp_safe = 1,
1652 };
1653 /* *INDENT-ON* */
1654 /*
1655  * fd.io coding-style-patch-verification: ON
1656  *
1657  * Local Variables:
1658  * eval: (c-set-style "gnu")
1659  * End:
1660  */