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