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