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