src/vnet/l2/l2_input.c

   1 /*
   2  * l2_input.c : layer 2 input packet processing
   3  *
   4  * Copyright (c) 2013 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <vlib/vlib.h>
  19 #include <vnet/vnet.h>
  20 #include <vnet/pg/pg.h>
  21 #include <vnet/ethernet/ethernet.h>
  22 #include <vnet/ethernet/packet.h>
  23 #include <vnet/ip/ip_packet.h>
  24 #include <vnet/ip/ip4_packet.h>
  25 #include <vnet/ip/ip6_packet.h>
  26 #include <vlib/cli.h>
  27 #include <vnet/l2/l2_input.h>
  28 #include <vnet/l2/l2_output.h>
  29 #include <vnet/l2/feat_bitmap.h>
  30 #include <vnet/l2/l2_bvi.h>
  31 #include <vnet/l2/l2_fib.h>
  32
  33 #include <vppinfra/error.h>
  34 #include <vppinfra/hash.h>
  35 #include <vppinfra/cache.h>
  36
  37 /**
  38  * @file
  39  * @brief Interface Input Mode (Layer 2 Cross-Connect or Bridge / Layer 3).
  40  *
  41  * This file contains the CLI Commands that modify the input mode of an
  42  * interface. For interfaces in a Layer 2 cross-connect, all packets
  43  * received on one interface will be transmitted to the other. For
  44  * interfaces in a bridge-domain, packets will be forwarded to other
  45  * interfaces in the same bridge-domain based on destination mac address.
  46  * For interfaces in Layer 3 mode, the packets will be routed.
  47  */
  48
  49 /* Feature graph node names */
  50 static char *l2input_feat_names[] = {
  51 #define _(sym,name) name,
  52   foreach_l2input_feat
  53 #undef _
  54 };
  55
  56 char **
  57 l2input_get_feat_names (void)
  58 {
  59   return l2input_feat_names;
  60 }
  61
  62
  63 typedef struct
  64 {
  65   /* per-pkt trace data */
  66   u8 src[6];
  67   u8 dst[6];
  68   u32 next_index;
  69   u32 sw_if_index;
  70 } l2input_trace_t;
  71
  72 /* packet trace format function */
  73 static u8 *
  74 format_l2input_trace (u8 * s, va_list * args)
  75 {
  76   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  77   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  78   l2input_trace_t *t = va_arg (*args, l2input_trace_t *);
  79
  80   s = format (s, "l2-input: sw_if_index %d dst %U src %U",
  81               t->sw_if_index,
  82               format_ethernet_address, t->dst,
  83               format_ethernet_address, t->src);
  84   return s;
  85 }
  86
  87 l2input_main_t l2input_main;
  88
  89 #define foreach_l2input_error                   \
  90 _(L2INPUT,     "L2 input packets")              \
  91 _(DROP,        "L2 input drops")
  92
  93 typedef enum
  94 {
  95 #define _(sym,str) L2INPUT_ERROR_##sym,
  96   foreach_l2input_error
  97 #undef _
  98     L2INPUT_N_ERROR,
  99 } l2input_error_t;
 100
 101 static char *l2input_error_strings[] = {
 102 #define _(sym,string) string,
 103   foreach_l2input_error
 104 #undef _
 105 };
 106
 107 typedef enum
 108 {                               /*  */
 109   L2INPUT_NEXT_LEARN,
 110   L2INPUT_NEXT_FWD,
 111   L2INPUT_NEXT_DROP,
 112   L2INPUT_N_NEXT,
 113 } l2input_next_t;
 114
 115
 116 static_always_inline void
 117 classify_and_dispatch (vlib_main_t * vm,
 118                        vlib_node_runtime_t * node,
 119                        u32 cpu_index,
 120                        l2input_main_t * msm, vlib_buffer_t * b0, u32 * next0)
 121 {
 122   /*
 123    * Load L2 input feature struct
 124    * Load bridge domain struct
 125    * Parse ethernet header to determine unicast/mcast/broadcast
 126    * take L2 input stat
 127    * classify packet as IP/UDP/TCP, control, other
 128    * mask feature bitmap
 129    * go to first node in bitmap
 130    * Later: optimize VTM
 131    *
 132    * For L2XC,
 133    *   set tx sw-if-handle
 134    */
 135
 136   u16 ethertype;
 137   u8 protocol;
 138   l2_input_config_t *config;
 139   l2_bridge_domain_t *bd_config;
 140   u16 bd_index0;
 141   u32 feature_bitmap;
 142   u32 feat_mask;
 143   ethernet_header_t *h0;
 144   u8 *l3h0;
 145   u32 sw_if_index0;
 146
 147 #define get_u16(addr) ( *((u16 *)(addr)) )
 148
 149   sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 150
 151   h0 = vlib_buffer_get_current (b0);
 152   l3h0 = (u8 *) h0 + vnet_buffer (b0)->l2.l2_len;
 153
 154   ethertype = clib_net_to_host_u16 (get_u16 (l3h0 - 2));
 155   feat_mask = ~0;
 156
 157   /* Get config for the input interface */
 158   config = vec_elt_at_index (msm->configs, sw_if_index0);
 159
 160   /* Save split horizon group */
 161   vnet_buffer (b0)->l2.shg = config->shg;
 162
 163   /* determine layer2 kind for stat and mask */
 164   if (PREDICT_FALSE (ethernet_address_cast (h0->dst_address)))
 165     {
 166       protocol = ((ip6_header_t *) l3h0)->protocol;
 167
 168       /* Disable bridge forwarding (flooding will execute instead if not xconnect) */
 169       feat_mask &= ~(L2INPUT_FEAT_FWD | L2INPUT_FEAT_UU_FLOOD);
 170
 171       /* Disable ARP-term for non-ARP and non-ICMP6 packet */
 172       if (ethertype != ETHERNET_TYPE_ARP &&
 173           (ethertype != ETHERNET_TYPE_IP6 || protocol != IP_PROTOCOL_ICMP6))
 174         feat_mask &= ~(L2INPUT_FEAT_ARP_TERM);
 175     }
 176   else
 177     {
 178       /*
 179        * Check for from-BVI processing - set SHG of unicast packets from BVI
 180        * to 0 so it is not dropped for VXLAN tunnels or other ports with the
 181        * same SHG as that of the BVI.
 182        */
 183       if (PREDICT_FALSE (vnet_buffer (b0)->sw_if_index[VLIB_TX] ==
 184                          L2INPUT_BVI))
 185         vnet_buffer (b0)->l2.shg = 0;
 186     }
 187
 188
 189   if (config->xconnect)
 190     {
 191       /* Set the output interface */
 192       vnet_buffer (b0)->sw_if_index[VLIB_TX] = config->output_sw_if_index;
 193     }
 194   else
 195     {
 196       /* Do bridge-domain processing */
 197       bd_index0 = config->bd_index;
 198       /* save BD ID for next feature graph nodes */
 199       vnet_buffer (b0)->l2.bd_index = bd_index0;
 200
 201       /* Get config for the bridge domain interface */
 202       bd_config = vec_elt_at_index (msm->bd_configs, bd_index0);
 203
 204       /*
 205        * Process bridge domain feature enables.
 206        * To perform learning/flooding/forwarding, the corresponding bit
 207        * must be enabled in both the input interface config and in the
 208        * bridge domain config. In the bd_bitmap, bits for features other
 209        * than learning/flooding/forwarding should always be set.
 210        */
 211       feat_mask = feat_mask & bd_config->feature_bitmap;
 212     }
 213
 214   /* mask out features from bitmap using packet type and bd config */
 215   feature_bitmap = config->feature_bitmap & feat_mask;
 216
 217   /* save for next feature graph nodes */
 218   vnet_buffer (b0)->l2.feature_bitmap = feature_bitmap;
 219
 220   /* Determine the next node */
 221   *next0 = feat_bitmap_get_next_node_index (msm->feat_next_node_index,
 222                                             feature_bitmap);
 223 }
 224
 225 static_always_inline uword
 226 l2input_node_inline (vlib_main_t * vm,
 227                      vlib_node_runtime_t * node, vlib_frame_t * frame,
 228                      int do_trace)
 229 {
 230   u32 n_left_from, *from, *to_next;
 231   l2input_next_t next_index;
 232   l2input_main_t *msm = &l2input_main;
 233   u32 cpu_index = os_get_cpu_number ();
 234
 235   from = vlib_frame_vector_args (frame);
 236   n_left_from = frame->n_vectors;       /* number of packets to process */
 237   next_index = node->cached_next_index;
 238
 239   while (n_left_from > 0)
 240     {
 241       u32 n_left_to_next;
 242
 243       /* get space to enqueue frame to graph node "next_index" */
 244       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 245
 246       while (n_left_from >= 8 && n_left_to_next >= 4)
 247         {
 248           u32 bi0, bi1, bi2, bi3;
 249           vlib_buffer_t *b0, *b1, *b2, *b3;
 250           u32 next0, next1, next2, next3;
 251           u32 sw_if_index0, sw_if_index1, sw_if_index2, sw_if_index3;
 252
 253           /* Prefetch next iteration. */
 254           {
 255             vlib_buffer_t *p4, *p5, *p6, *p7;
 256
 257             p4 = vlib_get_buffer (vm, from[4]);
 258             p5 = vlib_get_buffer (vm, from[5]);
 259             p6 = vlib_get_buffer (vm, from[6]);
 260             p7 = vlib_get_buffer (vm, from[7]);
 261
 262             /* Prefetch the buffer header and packet for the N+2 loop iteration */
 263             vlib_prefetch_buffer_header (p4, LOAD);
 264             vlib_prefetch_buffer_header (p5, LOAD);
 265             vlib_prefetch_buffer_header (p6, LOAD);
 266             vlib_prefetch_buffer_header (p7, LOAD);
 267
 268             CLIB_PREFETCH (p4->data, CLIB_CACHE_LINE_BYTES, STORE);
 269             CLIB_PREFETCH (p5->data, CLIB_CACHE_LINE_BYTES, STORE);
 270             CLIB_PREFETCH (p6->data, CLIB_CACHE_LINE_BYTES, STORE);
 271             CLIB_PREFETCH (p7->data, CLIB_CACHE_LINE_BYTES, STORE);
 272
 273             /*
 274              * Don't bother prefetching the bridge-domain config (which
 275              * depends on the input config above). Only a small number of
 276              * bridge domains are expected. Plus the structure is small
 277              * and several fit in a cache line.
 278              */
 279           }
 280
 281           /* speculatively enqueue b0 and b1 to the current next frame */
 282           /* bi is "buffer index", b is pointer to the buffer */
 283           to_next[0] = bi0 = from[0];
 284           to_next[1] = bi1 = from[1];
 285           to_next[2] = bi2 = from[2];
 286           to_next[3] = bi3 = from[3];
 287           from += 4;
 288           to_next += 4;
 289           n_left_from -= 4;
 290           n_left_to_next -= 4;
 291
 292           b0 = vlib_get_buffer (vm, bi0);
 293           b1 = vlib_get_buffer (vm, bi1);
 294           b2 = vlib_get_buffer (vm, bi2);
 295           b3 = vlib_get_buffer (vm, bi3);
 296
 297           if (do_trace)
 298             {
 299               /* RX interface handles */
 300               sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 301               sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
 302               sw_if_index2 = vnet_buffer (b2)->sw_if_index[VLIB_RX];
 303               sw_if_index3 = vnet_buffer (b3)->sw_if_index[VLIB_RX];
 304
 305               if (b0->flags & VLIB_BUFFER_IS_TRACED)
 306                 {
 307                   ethernet_header_t *h0 = vlib_buffer_get_current (b0);
 308                   l2input_trace_t *t =
 309                     vlib_add_trace (vm, node, b0, sizeof (*t));
 310                   t->sw_if_index = sw_if_index0;
 311                   clib_memcpy (t->src, h0->src_address, 6);
 312                   clib_memcpy (t->dst, h0->dst_address, 6);
 313                 }
 314               if (b1->flags & VLIB_BUFFER_IS_TRACED)
 315                 {
 316                   ethernet_header_t *h1 = vlib_buffer_get_current (b1);
 317                   l2input_trace_t *t =
 318                     vlib_add_trace (vm, node, b1, sizeof (*t));
 319                   t->sw_if_index = sw_if_index1;
 320                   clib_memcpy (t->src, h1->src_address, 6);
 321                   clib_memcpy (t->dst, h1->dst_address, 6);
 322                 }
 323               if (b2->flags & VLIB_BUFFER_IS_TRACED)
 324                 {
 325                   ethernet_header_t *h2 = vlib_buffer_get_current (b2);
 326                   l2input_trace_t *t =
 327                     vlib_add_trace (vm, node, b2, sizeof (*t));
 328                   t->sw_if_index = sw_if_index2;
 329                   clib_memcpy (t->src, h2->src_address, 6);
 330                   clib_memcpy (t->dst, h2->dst_address, 6);
 331                 }
 332               if (b3->flags & VLIB_BUFFER_IS_TRACED)
 333                 {
 334                   ethernet_header_t *h3 = vlib_buffer_get_current (b3);
 335                   l2input_trace_t *t =
 336                     vlib_add_trace (vm, node, b3, sizeof (*t));
 337                   t->sw_if_index = sw_if_index3;
 338                   clib_memcpy (t->src, h3->src_address, 6);
 339                   clib_memcpy (t->dst, h3->dst_address, 6);
 340                 }
 341             }
 342
 343           vlib_node_increment_counter (vm, l2input_node.index,
 344                                        L2INPUT_ERROR_L2INPUT, 4);
 345
 346           classify_and_dispatch (vm, node, cpu_index, msm, b0, &next0);
 347           classify_and_dispatch (vm, node, cpu_index, msm, b1, &next1);
 348           classify_and_dispatch (vm, node, cpu_index, msm, b2, &next2);
 349           classify_and_dispatch (vm, node, cpu_index, msm, b3, &next3);
 350
 351           /* verify speculative enqueues, maybe switch current next frame */
 352           /* if next0==next1==next_index then nothing special needs to be done */
 353           vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
 354                                            to_next, n_left_to_next,
 355                                            bi0, bi1, bi2, bi3,
 356                                            next0, next1, next2, next3);
 357         }
 358
 359       while (n_left_from > 0 && n_left_to_next > 0)
 360         {
 361           u32 bi0;
 362           vlib_buffer_t *b0;
 363           u32 next0;
 364           u32 sw_if_index0;
 365
 366           /* speculatively enqueue b0 to the current next frame */
 367           bi0 = from[0];
 368           to_next[0] = bi0;
 369           from += 1;
 370           to_next += 1;
 371           n_left_from -= 1;
 372           n_left_to_next -= 1;
 373
 374           b0 = vlib_get_buffer (vm, bi0);
 375
 376           if (do_trace && PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 377             {
 378               ethernet_header_t *h0 = vlib_buffer_get_current (b0);
 379               l2input_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
 380               sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 381               t->sw_if_index = sw_if_index0;
 382               clib_memcpy (t->src, h0->src_address, 6);
 383               clib_memcpy (t->dst, h0->dst_address, 6);
 384             }
 385
 386           vlib_node_increment_counter (vm, l2input_node.index,
 387                                        L2INPUT_ERROR_L2INPUT, 1);
 388
 389           classify_and_dispatch (vm, node, cpu_index, msm, b0, &next0);
 390
 391           /* verify speculative enqueue, maybe switch current next frame */
 392           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 393                                            to_next, n_left_to_next,
 394                                            bi0, next0);
 395         }
 396
 397       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 398     }
 399
 400   return frame->n_vectors;
 401 }
 402
 403 static uword
 404 l2input_node_fn (vlib_main_t * vm,
 405                  vlib_node_runtime_t * node, vlib_frame_t * frame)
 406 {
 407   if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
 408     return l2input_node_inline (vm, node, frame, 1 /* do_trace */ );
 409   return l2input_node_inline (vm, node, frame, 0 /* do_trace */ );
 410 }
 411
 412 /* *INDENT-OFF* */
 413 VLIB_REGISTER_NODE (l2input_node) = {
 414   .function = l2input_node_fn,
 415   .name = "l2-input",
 416   .vector_size = sizeof (u32),
 417   .format_trace = format_l2input_trace,
 418   .format_buffer = format_ethernet_header_with_length,
 419   .type = VLIB_NODE_TYPE_INTERNAL,
 420
 421   .n_errors = ARRAY_LEN(l2input_error_strings),
 422   .error_strings = l2input_error_strings,
 423
 424   .n_next_nodes = L2INPUT_N_NEXT,
 425
 426   /* edit / add dispositions here */
 427   .next_nodes = {
 428        [L2INPUT_NEXT_LEARN] = "l2-learn",
 429        [L2INPUT_NEXT_FWD]   = "l2-fwd",
 430        [L2INPUT_NEXT_DROP]  = "error-drop",
 431   },
 432 };
 433 /* *INDENT-ON* */
 434
 435 VLIB_NODE_FUNCTION_MULTIARCH (l2input_node, l2input_node_fn)
 436      clib_error_t *l2input_init (vlib_main_t * vm)
 437 {
 438   l2input_main_t *mp = &l2input_main;
 439
 440   mp->vlib_main = vm;
 441   mp->vnet_main = vnet_get_main ();
 442
 443   /* Get packets RX'd from L2 interfaces */
 444   ethernet_register_l2_input (vm, l2input_node.index);
 445
 446   /* Create the config vector */
 447   vec_validate (mp->configs, 100);
 448   /* create 100 sw interface entries and zero them */
 449
 450   /* Initialize the feature next-node indexes */
 451   feat_bitmap_init_next_nodes (vm,
 452                                l2input_node.index,
 453                                L2INPUT_N_FEAT,
 454                                l2input_get_feat_names (),
 455                                mp->feat_next_node_index);
 456
 457   return 0;
 458 }
 459
 460 VLIB_INIT_FUNCTION (l2input_init);
 461
 462
 463 /** Get a pointer to the config for the given interface. */
 464 l2_input_config_t *
 465 l2input_intf_config (u32 sw_if_index)
 466 {
 467   l2input_main_t *mp = &l2input_main;
 468
 469   vec_validate (mp->configs, sw_if_index);
 470   return vec_elt_at_index (mp->configs, sw_if_index);
 471 }
 472
 473 /** Enable (or disable) the feature in the bitmap for the given interface. */
 474 u32
 475 l2input_intf_bitmap_enable (u32 sw_if_index, u32 feature_bitmap, u32 enable)
 476 {
 477   l2input_main_t *mp = &l2input_main;
 478   l2_input_config_t *config;
 479
 480   vec_validate (mp->configs, sw_if_index);
 481   config = vec_elt_at_index (mp->configs, sw_if_index);
 482
 483   if (enable)
 484     {
 485       config->feature_bitmap |= feature_bitmap;
 486     }
 487   else
 488     {
 489       config->feature_bitmap &= ~feature_bitmap;
 490     }
 491
 492   return config->feature_bitmap;
 493 }
 494
 495 u32
 496 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value)
 497 {
 498   l2_bridge_domain_t *bd_config;
 499   vec_validate (l2input_main.bd_configs, bd_index);
 500   bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
 501   bd_validate (bd_config);
 502   bd_config->feature_bitmap =
 503     (bd_config->feature_bitmap & ~feat_mask) | feat_value;
 504   return bd_config->feature_bitmap;
 505 }
 506
 507 /**
 508  * Set the subinterface to run in l2 or l3 mode.
 509  * For L3 mode, just the sw_if_index is specified.
 510  * For bridged mode, the bd id and bvi flag are also specified.
 511  * For xconnect mode, the peer sw_if_index is also specified.
 512  * Return 0 if ok, or non-0 if there was an error.
 513  */
 514
 515 u32
 516 set_int_l2_mode (vlib_main_t * vm, vnet_main_t * vnet_main,     /*           */
 517                  u32 mode,      /* One of L2 modes or back to L3 mode        */
 518                  u32 sw_if_index,       /* sw interface index                */
 519                  u32 bd_index,  /* for bridged interface                     */
 520                  u32 bvi,       /* the bridged interface is the BVI          */
 521                  u32 shg,       /* the bridged interface split horizon group */
 522                  u32 xc_sw_if_index)    /* peer interface for xconnect       */
 523 {
 524   l2input_main_t *mp = &l2input_main;
 525   l2output_main_t *l2om = &l2output_main;
 526   vnet_main_t *vnm = vnet_get_main ();
 527   vnet_hw_interface_t *hi;
 528   l2_output_config_t *out_config;
 529   l2_input_config_t *config;
 530   l2_bridge_domain_t *bd_config;
 531   l2_flood_member_t member;
 532   u64 mac;
 533   i32 l2_if_adjust = 0;
 534   u32 slot;
 535
 536   hi = vnet_get_sup_hw_interface (vnet_main, sw_if_index);
 537   config = l2input_intf_config (sw_if_index);
 538
 539   if (config->bridge)
 540     {
 541       /* Interface is already in bridge mode. Undo the existing config. */
 542       bd_config = vec_elt_at_index (mp->bd_configs, config->bd_index);
 543
 544       /* remove interface from flood vector */
 545       bd_remove_member (bd_config, sw_if_index);
 546
 547       /* undo any BVI-related config */
 548       if (bd_config->bvi_sw_if_index == sw_if_index)
 549         {
 550           bd_config->bvi_sw_if_index = ~0;
 551           config->bvi = 0;
 552
 553           /* delete the l2fib entry for the bvi interface */
 554           mac = *((u64 *) hi->hw_address);
 555           l2fib_del_entry (mac, config->bd_index);
 556
 557           /* Make loop output node send packet back to ethernet-input node */
 558           slot =
 559             vlib_node_add_named_next_with_slot (vm, hi->tx_node_index,
 560                                                 "ethernet-input",
 561                                                 VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
 562           ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
 563         }
 564       l2_if_adjust--;
 565     }
 566   else if (config->xconnect)
 567     {
 568       l2_if_adjust--;
 569     }
 570
 571   /*
 572    * Directs the l2 output path to work out the interface
 573    * output next-arc itself. Needed when recycling a sw_if_index.
 574    */
 575   vec_validate_init_empty (l2om->next_nodes.output_node_index_vec,
 576                            sw_if_index, ~0);
 577   l2om->next_nodes.output_node_index_vec[sw_if_index] = ~0;
 578
 579   /* Initialize the l2-input configuration for the interface */
 580   if (mode == MODE_L3)
 581     {
 582       /* Set L2 config to BD index 0 so that if any packet accidentally
 583        * came in on L2 path, it will be dropped in BD 0 */
 584       config->xconnect = 0;
 585       config->bridge = 0;
 586       config->shg = 0;
 587       config->bd_index = 0;
 588       config->feature_bitmap = L2INPUT_FEAT_DROP;
 589
 590       /* Clear L2 output config */
 591       out_config = l2output_intf_config (sw_if_index);
 592       memset (out_config, 0, sizeof (l2_output_config_t));
 593
 594       /* Make sure any L2-output packet to this interface now in L3 mode is
 595        * dropped. This may happen if L2 FIB MAC entry is stale */
 596       l2om->next_nodes.output_node_index_vec[sw_if_index] =
 597         L2OUTPUT_NEXT_BAD_INTF;
 598     }
 599   else if (mode == MODE_L2_CLASSIFY)
 600     {
 601       config->xconnect = 1;
 602       config->bridge = 0;
 603       config->output_sw_if_index = xc_sw_if_index;
 604
 605       /* Make sure last-chance drop is configured */
 606       config->feature_bitmap |=
 607         L2INPUT_FEAT_DROP | L2INPUT_FEAT_INPUT_CLASSIFY;
 608
 609       /* Make sure bridging features are disabled */
 610       config->feature_bitmap &=
 611         ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
 612       shg = 0;                  /* not used in xconnect */
 613
 614       /* Insure all packets go to ethernet-input */
 615       ethernet_set_rx_redirect (vnet_main, hi, 1);
 616     }
 617   else
 618     {
 619
 620       if (mode == MODE_L2_BRIDGE)
 621         {
 622           /*
 623            * Remove a check that the interface must be an Ethernet.
 624            * Specifically so we can bridge to L3 tunnel interfaces.
 625            * Here's the check:
 626            * if (hi->hw_class_index != ethernet_hw_interface_class.index)
 627            *
 628            */
 629           if (!hi)
 630             return MODE_ERROR_ETH;      /* non-ethernet */
 631
 632           config->xconnect = 0;
 633           config->bridge = 1;
 634           config->bd_index = bd_index;
 635
 636           /*
 637            * Enable forwarding, flooding, learning and ARP termination by default
 638            * (note that ARP term is disabled on BD feature bitmap by default)
 639            */
 640           config->feature_bitmap |= L2INPUT_FEAT_FWD | L2INPUT_FEAT_UU_FLOOD |
 641             L2INPUT_FEAT_FLOOD | L2INPUT_FEAT_LEARN | L2INPUT_FEAT_ARP_TERM;
 642
 643           /* Make sure last-chance drop is configured */
 644           config->feature_bitmap |= L2INPUT_FEAT_DROP;
 645
 646           /* Make sure xconnect is disabled */
 647           config->feature_bitmap &= ~L2INPUT_FEAT_XCONNECT;
 648
 649           /* Set up bridge domain */
 650           vec_validate (mp->bd_configs, bd_index);
 651           bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
 652           bd_validate (bd_config);
 653
 654           /* TODO: think: add l2fib entry even for non-bvi interface? */
 655
 656           /* Do BVI interface initializations */
 657           if (bvi)
 658             {
 659               /* ensure BD has no bvi interface (or replace that one with this??) */
 660               if (bd_config->bvi_sw_if_index != ~0)
 661                 {
 662                   return MODE_ERROR_BVI_DEF;    /* bd already has a bvi interface */
 663                 }
 664               bd_config->bvi_sw_if_index = sw_if_index;
 665               config->bvi = 1;
 666
 667               /* create the l2fib entry for the bvi interface */
 668               mac = *((u64 *) hi->hw_address);
 669               l2fib_add_entry (mac, bd_index, sw_if_index, 1, 0, 1);    /* static + bvi */
 670
 671               /* Disable learning by default. no use since l2fib entry is static. */
 672               config->feature_bitmap &= ~L2INPUT_FEAT_LEARN;
 673
 674               /* Make loop output node send packet to l2-input node */
 675               slot =
 676                 vlib_node_add_named_next_with_slot (vm, hi->tx_node_index,
 677                                                     "l2-input",
 678                                                     VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
 679               ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
 680             }
 681
 682           /* Add interface to bridge-domain flood vector */
 683           member.sw_if_index = sw_if_index;
 684           member.flags = bvi ? L2_FLOOD_MEMBER_BVI : L2_FLOOD_MEMBER_NORMAL;
 685           member.shg = shg;
 686           bd_add_member (bd_config, &member);
 687
 688         }
 689       else
 690         {
 691           config->xconnect = 1;
 692           config->bridge = 0;
 693           config->output_sw_if_index = xc_sw_if_index;
 694
 695           /* Make sure last-chance drop is configured */
 696           config->feature_bitmap |= L2INPUT_FEAT_DROP;
 697
 698           /* Make sure bridging features are disabled */
 699           config->feature_bitmap &=
 700             ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
 701
 702           config->feature_bitmap |= L2INPUT_FEAT_XCONNECT;
 703           shg = 0;              /* not used in xconnect */
 704         }
 705
 706       /* set up split-horizon group and set output feature bit */
 707       config->shg = shg;
 708       out_config = l2output_intf_config (sw_if_index);
 709       out_config->shg = shg;
 710       out_config->feature_bitmap |= L2OUTPUT_FEAT_OUTPUT;
 711
 712       /*
 713        * Test: remove this when non-IP features can be configured.
 714        * Enable a non-IP feature to test IP feature masking
 715        * config->feature_bitmap |= L2INPUT_FEAT_CTRL_PKT;
 716        */
 717
 718       l2_if_adjust++;
 719     }
 720
 721   /* Adjust count of L2 interfaces */
 722   hi->l2_if_count += l2_if_adjust;
 723
 724   if (hi->hw_class_index == ethernet_hw_interface_class.index)
 725     {
 726       if ((hi->l2_if_count == 1) && (l2_if_adjust == 1))
 727         {
 728           /* Just added first L2 interface on this port */
 729
 730           /* Set promiscuous mode on the l2 interface */
 731           ethernet_set_flags (vnet_main, hi->hw_if_index,
 732                               ETHERNET_INTERFACE_FLAG_ACCEPT_ALL);
 733
 734           /* ensure all packets go to ethernet-input */
 735           ethernet_set_rx_redirect (vnet_main, hi, 1);
 736
 737         }
 738       else if ((hi->l2_if_count == 0) && (l2_if_adjust == -1))
 739         {
 740           /* Just removed only L2 subinterface on this port */
 741
 742           /* Disable promiscuous mode on the l2 interface */
 743           ethernet_set_flags (vnet_main, hi->hw_if_index, 0);
 744
 745           /* Allow ip packets to go directly to ip4-input etc */
 746           ethernet_set_rx_redirect (vnet_main, hi, 0);
 747         }
 748     }
 749
 750   /* Set up the L2/L3 flag in the interface parsing tables */
 751   ethernet_sw_interface_set_l2_mode (vnm, sw_if_index, (mode != MODE_L3));
 752
 753   return 0;
 754 }
 755
 756 /**
 757  * Set subinterface in bridging mode with a bridge-domain ID.
 758  * The CLI format is:
 759  *   set interface l2 bridge <interface> <bd> [bvi] [split-horizon-group]
 760  */
 761 static clib_error_t *
 762 int_l2_bridge (vlib_main_t * vm,
 763                unformat_input_t * input, vlib_cli_command_t * cmd)
 764 {
 765   vnet_main_t *vnm = vnet_get_main ();
 766   clib_error_t *error = 0;
 767   u32 bd_index, bd_id;
 768   u32 sw_if_index;
 769   u32 bvi;
 770   u32 rc;
 771   u32 shg;
 772
 773   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 774     {
 775       error = clib_error_return (0, "unknown interface `%U'",
 776                                  format_unformat_error, input);
 777       goto done;
 778     }
 779
 780   if (!unformat (input, "%d", &bd_id))
 781     {
 782       error = clib_error_return (0, "expected bridge domain ID `%U'",
 783                                  format_unformat_error, input);
 784       goto done;
 785     }
 786
 787   bd_index = bd_find_or_add_bd_index (&bd_main, bd_id);
 788
 789   /* optional bvi  */
 790   bvi = unformat (input, "bvi");
 791
 792   /* optional split horizon group */
 793   shg = 0;
 794   (void) unformat (input, "%d", &shg);
 795
 796   /* set the interface mode */
 797   if ((rc =
 798        set_int_l2_mode (vm, vnm, MODE_L2_BRIDGE, sw_if_index, bd_index, bvi,
 799                         shg, 0)))
 800     {
 801       if (rc == MODE_ERROR_ETH)
 802         {
 803           error = clib_error_return (0, "bridged interface must be ethernet",
 804                                      format_unformat_error, input);
 805         }
 806       else if (rc == MODE_ERROR_BVI_DEF)
 807         {
 808           error =
 809             clib_error_return (0, "bridge-domain already has a bvi interface",
 810                                format_unformat_error, input);
 811         }
 812       else
 813         {
 814           error = clib_error_return (0, "invalid configuration for interface",
 815                                      format_unformat_error, input);
 816         }
 817       goto done;
 818     }
 819
 820 done:
 821   return error;
 822 }
 823
 824 /*?
 825  * Use this command put an interface into Layer 2 bridge domain. If a
 826  * bridge-domain with the provided bridge-domain-id does not exist, it
 827  * will be created. Interfaces in a bridge-domain forward packets to
 828  * other interfaces in the same bridge-domain based on destination mac
 829  * address. To remove an interface from a the Layer 2 bridge domain,
 830  * put the interface in a different mode, for example Layer 3 mode.
 831  *
 832  * Optionally, an interface can be added to a Layer 2 bridge-domain as
 833  * a Bridged Virtual Interface (bvi). Only one interface in a Layer 2
 834  * bridge-domain can be a bvi.
 835  *
 836  * Optionally, a split-horizon group can also be specified. This defaults
 837  * to 0 if not specified.
 838  *
 839  * @cliexpar
 840  * Example of how to configure a Layer 2 bridge-domain with three
 841  * interfaces (where 200 is the bridge-domain-id):
 842  * @cliexcmd{set interface l2 bridge GigabitEthernet0/8/0.200 200}
 843  * This interface is added a BVI interface:
 844  * @cliexcmd{set interface l2 bridge GigabitEthernet0/9/0.200 200 bvi}
 845  * This interface also has a split-horizon group of 1 specified:
 846  * @cliexcmd{set interface l2 bridge GigabitEthernet0/a/0.200 200 1}
 847  * Example of how to remove an interface from a Layer2 bridge-domain:
 848  * @cliexcmd{set interface l3 GigabitEthernet0/a/0.200}
 849 ?*/
 850 /* *INDENT-OFF* */
 851 VLIB_CLI_COMMAND (int_l2_bridge_cli, static) = {
 852   .path = "set interface l2 bridge",
 853   .short_help = "set interface l2 bridge <interface> <bridge-domain-id> [bvi] [shg]",
 854   .function = int_l2_bridge,
 855 };
 856 /* *INDENT-ON* */
 857
 858 /**
 859  * Set subinterface in xconnect mode with another interface.
 860  * The CLI format is:
 861  *   set interface l2 xconnect <interface> <peer interface>
 862  */
 863 static clib_error_t *
 864 int_l2_xc (vlib_main_t * vm,
 865            unformat_input_t * input, vlib_cli_command_t * cmd)
 866 {
 867   vnet_main_t *vnm = vnet_get_main ();
 868   clib_error_t *error = 0;
 869   u32 sw_if_index;
 870   u32 xc_sw_if_index;
 871
 872   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 873     {
 874       error = clib_error_return (0, "unknown interface `%U'",
 875                                  format_unformat_error, input);
 876       goto done;
 877     }
 878
 879   if (!unformat_user
 880       (input, unformat_vnet_sw_interface, vnm, &xc_sw_if_index))
 881     {
 882       error = clib_error_return (0, "unknown peer interface `%U'",
 883                                  format_unformat_error, input);
 884       goto done;
 885     }
 886
 887   /* set the interface mode */
 888   if (set_int_l2_mode
 889       (vm, vnm, MODE_L2_XC, sw_if_index, 0, 0, 0, xc_sw_if_index))
 890     {
 891       error = clib_error_return (0, "invalid configuration for interface",
 892                                  format_unformat_error, input);
 893       goto done;
 894     }
 895
 896 done:
 897   return error;
 898 }
 899
 900 /*?
 901  * Use this command put an interface into Layer 2 cross-connect mode.
 902  * Both interfaces must be in this mode for bi-directioal traffic. All
 903  * packets received on one interface will be transmitted to the other.
 904  * To remove the Layer 2 cross-connect, put the interface in a different
 905  * mode, for example Layer 3 mode.
 906  *
 907  * @cliexpar
 908  * Example of how to configure a Layer2 cross-connect between two interfaces:
 909  * @cliexcmd{set interface l2 xconnect GigabitEthernet0/8/0.300 GigabitEthernet0/9/0.300}
 910  * @cliexcmd{set interface l2 xconnect GigabitEthernet0/9/0.300 GigabitEthernet0/8/0.300}
 911  * Example of how to remove a Layer2 cross-connect:
 912  * @cliexcmd{set interface l3 GigabitEthernet0/8/0.300}
 913  * @cliexcmd{set interface l3 GigabitEthernet0/9/0.300}
 914 ?*/
 915 /* *INDENT-OFF* */
 916 VLIB_CLI_COMMAND (int_l2_xc_cli, static) = {
 917   .path = "set interface l2 xconnect",
 918   .short_help = "set interface l2 xconnect <interface> <peer interface>",
 919   .function = int_l2_xc,
 920 };
 921 /* *INDENT-ON* */
 922
 923 /**
 924  * Set subinterface in L3 mode.
 925  * The CLI format is:
 926  *   set interface l3 <interface>
 927  */
 928 static clib_error_t *
 929 int_l3 (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
 930 {
 931   vnet_main_t *vnm = vnet_get_main ();
 932   clib_error_t *error = 0;
 933   u32 sw_if_index;
 934
 935   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 936     {
 937       error = clib_error_return (0, "unknown interface `%U'",
 938                                  format_unformat_error, input);
 939       goto done;
 940     }
 941
 942   /* set the interface mode */
 943   if (set_int_l2_mode (vm, vnm, MODE_L3, sw_if_index, 0, 0, 0, 0))
 944     {
 945       error = clib_error_return (0, "invalid configuration for interface",
 946                                  format_unformat_error, input);
 947       goto done;
 948     }
 949
 950 done:
 951   return error;
 952 }
 953
 954 /*?
 955  * Modify the packet processing mode of the interface to Layer 3, which
 956  * implies packets will be routed. This is the default mode of an interface.
 957  * Use this command to remove an interface from a Layer 2 cross-connect or a
 958  * Layer 2 bridge.
 959  *
 960  * @cliexpar
 961  * Example of how to set the mode of an interface to Layer 3:
 962  * @cliexcmd{set interface l3 GigabitEthernet0/8/0.200}
 963 ?*/
 964 /* *INDENT-OFF* */
 965      VLIB_CLI_COMMAND (int_l3_cli, static) = {
 966   .path = "set interface l3",
 967   .short_help = "set interface l3 <interface>",
 968   .function = int_l3,
 969 };
 970 /* *INDENT-ON* */
 971
 972 /**
 973  * Show interface mode.
 974  * The CLI format is:
 975  *    show mode [<if-name1> <if-name2> ...]
 976  */
 977 static clib_error_t *
 978 show_int_mode (vlib_main_t * vm,
 979                unformat_input_t * input, vlib_cli_command_t * cmd)
 980 {
 981   vnet_main_t *vnm = vnet_get_main ();
 982   clib_error_t *error = 0;
 983   char *mode;
 984   u8 *args;
 985   vnet_interface_main_t *im = &vnm->interface_main;
 986   vnet_sw_interface_t *si, *sis = 0;
 987   l2input_main_t *mp = &l2input_main;
 988   l2_input_config_t *config;
 989
 990   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 991     {
 992       u32 sw_if_index;
 993
 994       /* See if user wants to show specific interface */
 995       if (unformat
 996           (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
 997         {
 998           si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
 999           vec_add1 (sis, si[0]);
1000         }
1001       else
1002         {
1003           error = clib_error_return (0, "unknown input `%U'",
1004                                      format_unformat_error, input);
1005           goto done;
1006         }
1007
1008     }
1009
1010   if (vec_len (sis) == 0)       /* Get all interfaces */
1011     {
1012       /* Gather interfaces. */
1013       sis = vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
1014       _vec_len (sis) = 0;
1015       /* *INDENT-OFF* */
1016       pool_foreach (si, im->sw_interfaces, ({ vec_add1 (sis, si[0]); }));
1017       /* *INDENT-ON* */
1018     }
1019
1020   vec_foreach (si, sis)
1021   {
1022     vec_validate (mp->configs, si->sw_if_index);
1023     config = vec_elt_at_index (mp->configs, si->sw_if_index);
1024     if (config->bridge)
1025       {
1026         u32 bd_id;
1027         mode = "l2 bridge";
1028         bd_id = l2input_main.bd_configs[config->bd_index].bd_id;
1029
1030         args = format (0, "bd_id %d%s%d", bd_id,
1031                        config->bvi ? " bvi shg " : " shg ", config->shg);
1032       }
1033     else if (config->xconnect)
1034       {
1035         mode = "l2 xconnect";
1036         args = format (0, "%U",
1037                        format_vnet_sw_if_index_name,
1038                        vnm, config->output_sw_if_index);
1039       }
1040     else
1041       {
1042         mode = "l3";
1043         args = format (0, " ");
1044       }
1045     vlib_cli_output (vm, "%s %U %v\n",
1046                      mode,
1047                      format_vnet_sw_if_index_name,
1048                      vnm, si->sw_if_index, args);
1049     vec_free (args);
1050   }
1051
1052 done:
1053   vec_free (sis);
1054
1055   return error;
1056 }
1057
1058 /*?
1059  * Show the packet processing mode (Layer2 xcross-onnect, Layer 2 bridge,
1060  * Layer 3 routed) of all interfaces and sub-interfaces, or limit the
1061  * output to just the provided list of interfaces and sub-interfaces.
1062  * The output shows the mode, the interface, and if the interface is
1063  * a member of a bridge, the bridge-domain-id and the split horizen group (shg).
1064  *
1065  * @cliexpar
1066  * Example of displaying the mode of all interfaces:
1067  * @cliexstart{show mode}
1068  * l3 local0
1069  * l3 GigabitEthernet0/8/0
1070  * l3 GigabitEthernet0/9/0
1071  * l3 GigabitEthernet0/a/0
1072  * l2 bridge GigabitEthernet0/8/0.200 bd_id 200 shg 0
1073  * l2 bridge GigabitEthernet0/9/0.200 bd_id 200 shg 0
1074  * l2 bridge GigabitEthernet0/a/0.200 bd_id 200 shg 0
1075  * l2 xconnect GigabitEthernet0/8/0.300 GigabitEthernet0/9/0.300
1076  * l2 xconnect GigabitEthernet0/9/0.300 GigabitEthernet0/8/0.300
1077  * @cliexend
1078  * Example of displaying the mode of a seleted list of interfaces:
1079  * @cliexstart{show mode GigabitEthernet0/8/0 GigabitEthernet0/8/0.200}
1080  * l3 GigabitEthernet0/8/0
1081  * l2 bridge GigabitEthernet0/8/0.200 bd_id 200 shg 0
1082  * @cliexend
1083 ?*/
1084 /* *INDENT-OFF* */
1085 VLIB_CLI_COMMAND (show_l2_mode, static) = {
1086   .path = "show mode",
1087   .short_help = "show mode [<if-name1> <if-name2> ...]",
1088   .function = show_int_mode,
1089 };
1090 /* *INDENT-ON* */
1091
1092 #define foreach_l2_init_function                \
1093 _(feat_bitmap_drop_init)                        \
1094 _(l2fib_init)                                   \
1095 _(l2_input_classify_init)                             \
1096 _(l2bd_init)                                    \
1097 _(l2fwd_init)                                   \
1098 _(l2_inacl_init)                                \
1099 _(l2input_init)                                 \
1100 _(l2_vtr_init)                                  \
1101 _(l2_invtr_init)                                \
1102 _(l2_efp_filter_init)                           \
1103 _(l2learn_init)                                 \
1104 _(l2flood_init)                                 \
1105 _(l2_outacl_init)                               \
1106 _(l2output_init)                                \
1107 _(l2_patch_init)                                \
1108 _(l2_xcrw_init)
1109
1110 clib_error_t *
1111 l2_init (vlib_main_t * vm)
1112 {
1113   clib_error_t *error;
1114
1115 #define _(a) do {                                                       \
1116   if ((error = vlib_call_init_function (vm, a))) return error; }        \
1117 while (0);
1118   foreach_l2_init_function;
1119 #undef _
1120   return 0;
1121 }
1122
1123 VLIB_INIT_FUNCTION (l2_init);
1124
1125 /*
1126  * fd.io coding-style-patch-verification: ON
1127  *
1128  * Local Variables:
1129  * eval: (c-set-style "gnu")
1130  * End:
1131  */