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