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