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