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
 568   hi = vnet_get_sup_hw_interface (vnet_main, sw_if_index);
 569   config = l2input_intf_config (sw_if_index);
 570
 571   if (config->bridge)
 572     {
 573       /* Interface is already in bridge mode. Undo the existing config. */
 574       bd_config = vec_elt_at_index (mp->bd_configs, config->bd_index);
 575
 576       /* remove interface from flood vector */
 577       bd_remove_member (bd_config, sw_if_index);
 578
 579       /* undo any BVI-related config */
 580       if (bd_config->bvi_sw_if_index == sw_if_index)
 581         {
 582           vnet_sw_interface_t *si;
 583
 584           bd_config->bvi_sw_if_index = ~0;
 585           config->bvi = 0;
 586
 587           /* delete the l2fib entry for the bvi interface */
 588           l2fib_del_entry (hi->hw_address, config->bd_index);
 589
 590           /* Make loop output node send packet back to ethernet-input node */
 591           slot =
 592             vlib_node_add_named_next_with_slot (vm, hi->tx_node_index,
 593                                                 "ethernet-input",
 594                                                 VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
 595           ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
 596
 597           /* since this is a no longer BVI interface do not to flood to it */
 598           si = vnet_get_sw_interface (vnm, sw_if_index);
 599           si->flood_class = VNET_FLOOD_CLASS_NO_FLOOD;
 600         }
 601
 602       /* Clear MACs learned on the interface */
 603       if ((config->feature_bitmap & L2INPUT_FEAT_LEARN) ||
 604           (bd_config->feature_bitmap & L2INPUT_FEAT_LEARN))
 605         l2fib_flush_int_mac (vm, sw_if_index);
 606
 607       l2_if_adjust--;
 608     }
 609   else if (config->xconnect)
 610     {
 611       l2_if_adjust--;
 612     }
 613
 614   /* Make sure vector is big enough */
 615   vec_validate_init_empty (l2om->output_node_index_vec, sw_if_index,
 616                            L2OUTPUT_NEXT_DROP);
 617
 618   /* Initialize the l2-input configuration for the interface */
 619   if (mode == MODE_L3)
 620     {
 621       /* Set L2 config to BD index 0 so that if any packet accidentally
 622        * came in on L2 path, it will be dropped in BD 0 */
 623       config->xconnect = 0;
 624       config->bridge = 0;
 625       config->shg = 0;
 626       config->bd_index = 0;
 627       config->feature_bitmap = L2INPUT_FEAT_DROP;
 628
 629       /* Clear L2 output config */
 630       out_config = l2output_intf_config (sw_if_index);
 631       memset (out_config, 0, sizeof (l2_output_config_t));
 632
 633       /* Make sure any L2-output packet to this interface now in L3 mode is
 634        * dropped. This may happen if L2 FIB MAC entry is stale */
 635       l2om->output_node_index_vec[sw_if_index] = L2OUTPUT_NEXT_BAD_INTF;
 636     }
 637   else
 638     {
 639       /* Add or update l2-output node next-arc and output_node_index_vec table
 640        * for the interface */
 641       l2output_create_output_node_mapping (vm, vnet_main, sw_if_index);
 642
 643       if (mode == MODE_L2_BRIDGE)
 644         {
 645           /*
 646            * Remove a check that the interface must be an Ethernet.
 647            * Specifically so we can bridge to L3 tunnel interfaces.
 648            * Here's the check:
 649            * if (hi->hw_class_index != ethernet_hw_interface_class.index)
 650            *
 651            */
 652           if (!hi)
 653             return MODE_ERROR_ETH;      /* non-ethernet */
 654
 655           config->xconnect = 0;
 656           config->bridge = 1;
 657           config->bd_index = bd_index;
 658           *l2fib_valid_swif_seq_num (sw_if_index) += 1;
 659
 660           /*
 661            * Enable forwarding, flooding, learning and ARP termination by default
 662            * (note that ARP term is disabled on BD feature bitmap by default)
 663            */
 664           config->feature_bitmap |= L2INPUT_FEAT_FWD | L2INPUT_FEAT_UU_FLOOD |
 665             L2INPUT_FEAT_FLOOD | L2INPUT_FEAT_LEARN | L2INPUT_FEAT_ARP_TERM;
 666
 667           /* Make sure last-chance drop is configured */
 668           config->feature_bitmap |= L2INPUT_FEAT_DROP;
 669
 670           /* Make sure xconnect is disabled */
 671           config->feature_bitmap &= ~L2INPUT_FEAT_XCONNECT;
 672
 673           /* Set up bridge domain */
 674           bd_config = l2input_bd_config (bd_index);
 675           bd_validate (bd_config);
 676
 677           /* TODO: think: add l2fib entry even for non-bvi interface? */
 678
 679           /* Do BVI interface initializations */
 680           if (bvi)
 681             {
 682               vnet_sw_interface_t *si;
 683
 684               /* ensure BD has no bvi interface (or replace that one with this??) */
 685               if (bd_config->bvi_sw_if_index != ~0)
 686                 {
 687                   return MODE_ERROR_BVI_DEF;    /* bd already has a bvi interface */
 688                 }
 689               bd_config->bvi_sw_if_index = sw_if_index;
 690               config->bvi = 1;
 691
 692               /* create the l2fib entry for the bvi interface */
 693               l2fib_add_fwd_entry (hi->hw_address, bd_index, sw_if_index, 1, 1);        /* static + bvi */
 694
 695               /* Disable learning by default. no use since l2fib entry is static. */
 696               config->feature_bitmap &= ~L2INPUT_FEAT_LEARN;
 697
 698               /* Make loop output node send packet to l2-input node */
 699               slot =
 700                 vlib_node_add_named_next_with_slot (vm, hi->tx_node_index,
 701                                                     "l2-input",
 702                                                     VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
 703               ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
 704
 705               /* since this is a BVI interface we want to flood to it */
 706               si = vnet_get_sw_interface (vnm, sw_if_index);
 707               si->flood_class = VNET_FLOOD_CLASS_BVI;
 708             }
 709
 710           /* Add interface to bridge-domain flood vector */
 711           l2_flood_member_t member = {
 712             .sw_if_index = sw_if_index,
 713             .flags = bvi ? L2_FLOOD_MEMBER_BVI : L2_FLOOD_MEMBER_NORMAL,
 714             .shg = shg,
 715           };
 716           bd_add_member (bd_config, &member);
 717
 718         }
 719       else if (mode == MODE_L2_XC)
 720         {
 721           config->xconnect = 1;
 722           config->bridge = 0;
 723           config->output_sw_if_index = xc_sw_if_index;
 724
 725           /* Make sure last-chance drop is configured */
 726           config->feature_bitmap |= L2INPUT_FEAT_DROP;
 727
 728           /* Make sure bridging features are disabled */
 729           config->feature_bitmap &=
 730             ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
 731
 732           config->feature_bitmap |= L2INPUT_FEAT_XCONNECT;
 733           shg = 0;              /* not used in xconnect */
 734         }
 735       else if (mode == MODE_L2_CLASSIFY)
 736         {
 737           config->xconnect = 1;
 738           config->bridge = 0;
 739           config->output_sw_if_index = xc_sw_if_index;
 740
 741           /* Make sure last-chance drop is configured */
 742           config->feature_bitmap |=
 743             L2INPUT_FEAT_DROP | L2INPUT_FEAT_INPUT_CLASSIFY;
 744
 745           /* Make sure bridging features are disabled */
 746           config->feature_bitmap &=
 747             ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
 748           shg = 0;              /* not used in xconnect */
 749
 750           /* Insure all packets go to ethernet-input */
 751           ethernet_set_rx_redirect (vnet_main, hi, 1);
 752         }
 753
 754       /* set up split-horizon group and set output feature bit */
 755       config->shg = shg;
 756       out_config = l2output_intf_config (sw_if_index);
 757       out_config->shg = shg;
 758       out_config->feature_bitmap |= L2OUTPUT_FEAT_OUTPUT;
 759
 760       /*
 761        * Test: remove this when non-IP features can be configured.
 762        * Enable a non-IP feature to test IP feature masking
 763        * config->feature_bitmap |= L2INPUT_FEAT_CTRL_PKT;
 764        */
 765
 766       l2_if_adjust++;
 767     }
 768
 769   /* Adjust count of L2 interfaces */
 770   hi->l2_if_count += l2_if_adjust;
 771
 772   if (hi->hw_class_index == ethernet_hw_interface_class.index)
 773     {
 774       if ((hi->l2_if_count == 1) && (l2_if_adjust == 1))
 775         {
 776           /* Just added first L2 interface on this port */
 777
 778           /* Set promiscuous mode on the l2 interface */
 779           ethernet_set_flags (vnet_main, hi->hw_if_index,
 780                               ETHERNET_INTERFACE_FLAG_ACCEPT_ALL);
 781
 782           /* ensure all packets go to ethernet-input */
 783           ethernet_set_rx_redirect (vnet_main, hi, 1);
 784
 785         }
 786       else if ((hi->l2_if_count == 0) && (l2_if_adjust == -1))
 787         {
 788           /* Just removed only L2 subinterface on this port */
 789
 790           /* Disable promiscuous mode on the l2 interface */
 791           ethernet_set_flags (vnet_main, hi->hw_if_index, 0);
 792
 793           /* Allow ip packets to go directly to ip4-input etc */
 794           ethernet_set_rx_redirect (vnet_main, hi, 0);
 795         }
 796     }
 797
 798   /* Set up the L2/L3 flag in the interface parsing tables */
 799   ethernet_sw_interface_set_l2_mode (vnm, sw_if_index, (mode != MODE_L3));
 800
 801   return 0;
 802 }
 803
 804 /**
 805  * Set subinterface in bridging mode with a bridge-domain ID.
 806  * The CLI format is:
 807  *   set interface l2 bridge <interface> <bd> [bvi] [split-horizon-group]
 808  */
 809 static clib_error_t *
 810 int_l2_bridge (vlib_main_t * vm,
 811                unformat_input_t * input, vlib_cli_command_t * cmd)
 812 {
 813   vnet_main_t *vnm = vnet_get_main ();
 814   clib_error_t *error = 0;
 815   u32 bd_index, bd_id;
 816   u32 sw_if_index;
 817   u32 bvi;
 818   u32 rc;
 819   u32 shg;
 820
 821   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 822     {
 823       error = clib_error_return (0, "unknown interface `%U'",
 824                                  format_unformat_error, input);
 825       goto done;
 826     }
 827
 828   if (!unformat (input, "%d", &bd_id))
 829     {
 830       error = clib_error_return (0, "expected bridge domain ID `%U'",
 831                                  format_unformat_error, input);
 832       goto done;
 833     }
 834
 835   if (bd_id > L2_BD_ID_MAX)
 836     {
 837       error = clib_error_return (0, "bridge domain ID exceed 16M limit",
 838                                  format_unformat_error, input);
 839       goto done;
 840     }
 841   bd_index = bd_find_or_add_bd_index (&bd_main, bd_id);
 842
 843   /* optional bvi  */
 844   bvi = unformat (input, "bvi");
 845
 846   /* optional split horizon group */
 847   shg = 0;
 848   (void) unformat (input, "%d", &shg);
 849
 850   /* set the interface mode */
 851   if ((rc =
 852        set_int_l2_mode (vm, vnm, MODE_L2_BRIDGE, sw_if_index, bd_index, bvi,
 853                         shg, 0)))
 854     {
 855       if (rc == MODE_ERROR_ETH)
 856         {
 857           error = clib_error_return (0, "bridged interface must be ethernet",
 858                                      format_unformat_error, input);
 859         }
 860       else if (rc == MODE_ERROR_BVI_DEF)
 861         {
 862           error =
 863             clib_error_return (0, "bridge-domain already has a bvi interface",
 864                                format_unformat_error, input);
 865         }
 866       else
 867         {
 868           error = clib_error_return (0, "invalid configuration for interface",
 869                                      format_unformat_error, input);
 870         }
 871       goto done;
 872     }
 873
 874 done:
 875   return error;
 876 }
 877
 878 /*?
 879  * Use this command put an interface into Layer 2 bridge domain. If a
 880  * bridge-domain with the provided bridge-domain-id does not exist, it
 881  * will be created. Interfaces in a bridge-domain forward packets to
 882  * other interfaces in the same bridge-domain based on destination mac
 883  * address. To remove an interface from a the Layer 2 bridge domain,
 884  * put the interface in a different mode, for example Layer 3 mode.
 885  *
 886  * Optionally, an interface can be added to a Layer 2 bridge-domain as
 887  * a Bridged Virtual Interface (bvi). Only one interface in a Layer 2
 888  * bridge-domain can be a bvi.
 889  *
 890  * Optionally, a split-horizon group can also be specified. This defaults
 891  * to 0 if not specified.
 892  *
 893  * @cliexpar
 894  * Example of how to configure a Layer 2 bridge-domain with three
 895  * interfaces (where 200 is the bridge-domain-id):
 896  * @cliexcmd{set interface l2 bridge GigabitEthernet0/8/0.200 200}
 897  * This interface is added a BVI interface:
 898  * @cliexcmd{set interface l2 bridge GigabitEthernet0/9/0.200 200 bvi}
 899  * This interface also has a split-horizon group of 1 specified:
 900  * @cliexcmd{set interface l2 bridge GigabitEthernet0/a/0.200 200 1}
 901  * Example of how to remove an interface from a Layer2 bridge-domain:
 902  * @cliexcmd{set interface l3 GigabitEthernet0/a/0.200}
 903 ?*/
 904 /* *INDENT-OFF* */
 905 VLIB_CLI_COMMAND (int_l2_bridge_cli, static) = {
 906   .path = "set interface l2 bridge",
 907   .short_help = "set interface l2 bridge <interface> <bridge-domain-id> [bvi] [shg]",
 908   .function = int_l2_bridge,
 909 };
 910 /* *INDENT-ON* */
 911
 912 /**
 913  * Set subinterface in xconnect mode with another interface.
 914  * The CLI format is:
 915  *   set interface l2 xconnect <interface> <peer interface>
 916  */
 917 static clib_error_t *
 918 int_l2_xc (vlib_main_t * vm,
 919            unformat_input_t * input, vlib_cli_command_t * cmd)
 920 {
 921   vnet_main_t *vnm = vnet_get_main ();
 922   clib_error_t *error = 0;
 923   u32 sw_if_index;
 924   u32 xc_sw_if_index;
 925
 926   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 927     {
 928       error = clib_error_return (0, "unknown interface `%U'",
 929                                  format_unformat_error, input);
 930       goto done;
 931     }
 932
 933   if (!unformat_user
 934       (input, unformat_vnet_sw_interface, vnm, &xc_sw_if_index))
 935     {
 936       error = clib_error_return (0, "unknown peer interface `%U'",
 937                                  format_unformat_error, input);
 938       goto done;
 939     }
 940
 941   /* set the interface mode */
 942   if (set_int_l2_mode
 943       (vm, vnm, MODE_L2_XC, sw_if_index, 0, 0, 0, xc_sw_if_index))
 944     {
 945       error = clib_error_return (0, "invalid configuration for interface",
 946                                  format_unformat_error, input);
 947       goto done;
 948     }
 949
 950 done:
 951   return error;
 952 }
 953
 954 /*?
 955  * Use this command put an interface into Layer 2 cross-connect mode.
 956  * Both interfaces must be in this mode for bi-directioal traffic. All
 957  * packets received on one interface will be transmitted to the other.
 958  * To remove the Layer 2 cross-connect, put the interface in a different
 959  * mode, for example Layer 3 mode.
 960  *
 961  * @cliexpar
 962  * Example of how to configure a Layer2 cross-connect between two interfaces:
 963  * @cliexcmd{set interface l2 xconnect GigabitEthernet0/8/0.300 GigabitEthernet0/9/0.300}
 964  * @cliexcmd{set interface l2 xconnect GigabitEthernet0/9/0.300 GigabitEthernet0/8/0.300}
 965  * Example of how to remove a Layer2 cross-connect:
 966  * @cliexcmd{set interface l3 GigabitEthernet0/8/0.300}
 967  * @cliexcmd{set interface l3 GigabitEthernet0/9/0.300}
 968 ?*/
 969 /* *INDENT-OFF* */
 970 VLIB_CLI_COMMAND (int_l2_xc_cli, static) = {
 971   .path = "set interface l2 xconnect",
 972   .short_help = "set interface l2 xconnect <interface> <peer interface>",
 973   .function = int_l2_xc,
 974 };
 975 /* *INDENT-ON* */
 976
 977 /**
 978  * Set subinterface in L3 mode.
 979  * The CLI format is:
 980  *   set interface l3 <interface>
 981  */
 982 static clib_error_t *
 983 int_l3 (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
 984 {
 985   vnet_main_t *vnm = vnet_get_main ();
 986   clib_error_t *error = 0;
 987   u32 sw_if_index;
 988
 989   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 990     {
 991       error = clib_error_return (0, "unknown interface `%U'",
 992                                  format_unformat_error, input);
 993       goto done;
 994     }
 995
 996   /* set the interface mode */
 997   if (set_int_l2_mode (vm, vnm, MODE_L3, sw_if_index, 0, 0, 0, 0))
 998     {
 999       error = clib_error_return (0, "invalid configuration for interface",
1000                                  format_unformat_error, input);
1001       goto done;
1002     }
1003
1004 done:
1005   return error;
1006 }
1007
1008 /*?
1009  * Modify the packet processing mode of the interface to Layer 3, which
1010  * implies packets will be routed. This is the default mode of an interface.
1011  * Use this command to remove an interface from a Layer 2 cross-connect or a
1012  * Layer 2 bridge.
1013  *
1014  * @cliexpar
1015  * Example of how to set the mode of an interface to Layer 3:
1016  * @cliexcmd{set interface l3 GigabitEthernet0/8/0.200}
1017 ?*/
1018 /* *INDENT-OFF* */
1019      VLIB_CLI_COMMAND (int_l3_cli, static) = {
1020   .path = "set interface l3",
1021   .short_help = "set interface l3 <interface>",
1022   .function = int_l3,
1023 };
1024 /* *INDENT-ON* */
1025
1026 /**
1027  * Show interface mode.
1028  * The CLI format is:
1029  *    show mode [<if-name1> <if-name2> ...]
1030  */
1031 static clib_error_t *
1032 show_int_mode (vlib_main_t * vm,
1033                unformat_input_t * input, vlib_cli_command_t * cmd)
1034 {
1035   vnet_main_t *vnm = vnet_get_main ();
1036   clib_error_t *error = 0;
1037   char *mode;
1038   u8 *args;
1039   vnet_interface_main_t *im = &vnm->interface_main;
1040
1041   vnet_sw_interface_t *si, *sis = 0;
1042   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1043     {
1044       u32 sw_if_index;
1045
1046       /* See if user wants to show specific interface */
1047       if (unformat
1048           (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1049         {
1050           si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
1051           vec_add1 (sis, si[0]);
1052         }
1053       else
1054         {
1055           error = clib_error_return (0, "unknown input `%U'",
1056                                      format_unformat_error, input);
1057           goto done;
1058         }
1059     }
1060
1061   if (vec_len (sis) == 0)       /* Get all interfaces */
1062     {
1063       /* Gather interfaces. */
1064       sis = vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
1065       _vec_len (sis) = 0;
1066       /* *INDENT-OFF* */
1067       pool_foreach (si, im->sw_interfaces, ({ vec_add1 (sis, si[0]); }));
1068       /* *INDENT-ON* */
1069     }
1070
1071   vec_foreach (si, sis)
1072   {
1073     l2_input_config_t *config = l2input_intf_config (si->sw_if_index);
1074     if (config->bridge)
1075       {
1076         u32 bd_id;
1077         mode = "l2 bridge";
1078         bd_id = l2input_main.bd_configs[config->bd_index].bd_id;
1079
1080         args = format (0, "bd_id %d%s%d", bd_id,
1081                        config->bvi ? " bvi shg " : " shg ", config->shg);
1082       }
1083     else if (config->xconnect)
1084       {
1085         mode = "l2 xconnect";
1086         args = format (0, "%U",
1087                        format_vnet_sw_if_index_name,
1088                        vnm, config->output_sw_if_index);
1089       }
1090     else
1091       {
1092         mode = "l3";
1093         args = format (0, " ");
1094       }
1095     vlib_cli_output (vm, "%s %U %v\n",
1096                      mode,
1097                      format_vnet_sw_if_index_name,
1098                      vnm, si->sw_if_index, args);
1099     vec_free (args);
1100   }
1101
1102 done:
1103   vec_free (sis);
1104
1105   return error;
1106 }
1107
1108 /*?
1109  * Show the packet processing mode (Layer2 xcross-onnect, Layer 2 bridge,
1110  * Layer 3 routed) of all interfaces and sub-interfaces, or limit the
1111  * output to just the provided list of interfaces and sub-interfaces.
1112  * The output shows the mode, the interface, and if the interface is
1113  * a member of a bridge, the bridge-domain-id and the split horizen group (shg).
1114  *
1115  * @cliexpar
1116  * Example of displaying the mode of all interfaces:
1117  * @cliexstart{show mode}
1118  * l3 local0
1119  * l3 GigabitEthernet0/8/0
1120  * l3 GigabitEthernet0/9/0
1121  * l3 GigabitEthernet0/a/0
1122  * l2 bridge GigabitEthernet0/8/0.200 bd_id 200 shg 0
1123  * l2 bridge GigabitEthernet0/9/0.200 bd_id 200 shg 0
1124  * l2 bridge GigabitEthernet0/a/0.200 bd_id 200 shg 0
1125  * l2 xconnect GigabitEthernet0/8/0.300 GigabitEthernet0/9/0.300
1126  * l2 xconnect GigabitEthernet0/9/0.300 GigabitEthernet0/8/0.300
1127  * @cliexend
1128  * Example of displaying the mode of a seleted list of interfaces:
1129  * @cliexstart{show mode GigabitEthernet0/8/0 GigabitEthernet0/8/0.200}
1130  * l3 GigabitEthernet0/8/0
1131  * l2 bridge GigabitEthernet0/8/0.200 bd_id 200 shg 0
1132  * @cliexend
1133 ?*/
1134 /* *INDENT-OFF* */
1135 VLIB_CLI_COMMAND (show_l2_mode, static) = {
1136   .path = "show mode",
1137   .short_help = "show mode [<if-name1> <if-name2> ...]",
1138   .function = show_int_mode,
1139 };
1140 /* *INDENT-ON* */
1141
1142 #define foreach_l2_init_function                \
1143 _(feat_bitmap_drop_init)                        \
1144 _(l2fib_init)                                   \
1145 _(l2_input_classify_init)                             \
1146 _(l2bd_init)                                    \
1147 _(l2fwd_init)                                   \
1148 _(l2_in_out_acl_init)                           \
1149 _(l2input_init)                                 \
1150 _(l2_vtr_init)                                  \
1151 _(l2_invtr_init)                                \
1152 _(l2_efp_filter_init)                           \
1153 _(l2learn_init)                                 \
1154 _(l2flood_init)                                 \
1155 _(l2output_init)                                \
1156 _(l2_patch_init)                                \
1157 _(l2_xcrw_init)
1158
1159 clib_error_t *
1160 l2_init (vlib_main_t * vm)
1161 {
1162   clib_error_t *error;
1163
1164 #define _(a) do {                                                       \
1165   if ((error = vlib_call_init_function (vm, a))) return error; }        \
1166 while (0);
1167   foreach_l2_init_function;
1168 #undef _
1169   return 0;
1170 }
1171
1172 VLIB_INIT_FUNCTION (l2_init);
1173
1174 /*
1175  * fd.io coding-style-patch-verification: ON
1176  *
1177  * Local Variables:
1178  * eval: (c-set-style "gnu")
1179  * End:
1180  */