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