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