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