src/vnet/ethernet/node.c

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16  * ethernet_node.c: ethernet packet processing
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #include <vlib/vlib.h>
  41 #include <vnet/pg/pg.h>
  42 #include <vnet/ethernet/ethernet.h>
  43 #include <vppinfra/sparse_vec.h>
  44 #include <vnet/l2/l2_bvi.h>
  45
  46
  47 #define foreach_ethernet_input_next             \
  48   _ (PUNT, "error-punt")                        \
  49   _ (DROP, "error-drop")                        \
  50   _ (LLC, "llc-input")
  51
  52 typedef enum
  53 {
  54 #define _(s,n) ETHERNET_INPUT_NEXT_##s,
  55   foreach_ethernet_input_next
  56 #undef _
  57     ETHERNET_INPUT_N_NEXT,
  58 } ethernet_input_next_t;
  59
  60 typedef struct
  61 {
  62   u8 packet_data[32];
  63 } ethernet_input_trace_t;
  64
  65 static u8 *
  66 format_ethernet_input_trace (u8 * s, va_list * va)
  67 {
  68   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
  69   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
  70   ethernet_input_trace_t *t = va_arg (*va, ethernet_input_trace_t *);
  71
  72   s = format (s, "%U", format_ethernet_header, t->packet_data);
  73
  74   return s;
  75 }
  76
  77 vlib_node_registration_t ethernet_input_node;
  78
  79 typedef enum
  80 {
  81   ETHERNET_INPUT_VARIANT_ETHERNET,
  82   ETHERNET_INPUT_VARIANT_ETHERNET_TYPE,
  83   ETHERNET_INPUT_VARIANT_NOT_L2,
  84 } ethernet_input_variant_t;
  85
  86
  87 // Parse the ethernet header to extract vlan tags and innermost ethertype
  88 static_always_inline void
  89 parse_header (ethernet_input_variant_t variant,
  90               vlib_buffer_t * b0,
  91               u16 * type,
  92               u16 * orig_type,
  93               u16 * outer_id, u16 * inner_id, u32 * match_flags)
  94 {
  95   u8 vlan_count;
  96
  97   if (variant == ETHERNET_INPUT_VARIANT_ETHERNET
  98       || variant == ETHERNET_INPUT_VARIANT_NOT_L2)
  99     {
 100       ethernet_header_t *e0;
 101
 102       e0 = (void *) (b0->data + b0->current_data);
 103
 104       vnet_buffer (b0)->ethernet.start_of_ethernet_header = b0->current_data;
 105
 106       vlib_buffer_advance (b0, sizeof (e0[0]));
 107
 108       *type = clib_net_to_host_u16 (e0->type);
 109     }
 110   else if (variant == ETHERNET_INPUT_VARIANT_ETHERNET_TYPE)
 111     {
 112       // here when prior node was LLC/SNAP processing
 113       u16 *e0;
 114
 115       e0 = (void *) (b0->data + b0->current_data);
 116
 117       vlib_buffer_advance (b0, sizeof (e0[0]));
 118
 119       *type = clib_net_to_host_u16 (e0[0]);
 120     }
 121
 122   // save for distinguishing between dot1q and dot1ad later
 123   *orig_type = *type;
 124
 125   // default the tags to 0 (used if there is no corresponding tag)
 126   *outer_id = 0;
 127   *inner_id = 0;
 128
 129   *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_0_TAG;
 130   vlan_count = 0;
 131
 132   // check for vlan encaps
 133   if (ethernet_frame_is_tagged (*type))
 134     {
 135       ethernet_vlan_header_t *h0;
 136       u16 tag;
 137
 138       *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_1_TAG;
 139
 140       h0 = (void *) (b0->data + b0->current_data);
 141
 142       tag = clib_net_to_host_u16 (h0->priority_cfi_and_id);
 143
 144       *outer_id = tag & 0xfff;
 145       if (0 == *outer_id)
 146         *match_flags &= ~SUBINT_CONFIG_MATCH_1_TAG;
 147
 148       *type = clib_net_to_host_u16 (h0->type);
 149
 150       vlib_buffer_advance (b0, sizeof (h0[0]));
 151       vlan_count = 1;
 152
 153       if (*type == ETHERNET_TYPE_VLAN)
 154         {
 155           // Double tagged packet
 156           *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_2_TAG;
 157
 158           h0 = (void *) (b0->data + b0->current_data);
 159
 160           tag = clib_net_to_host_u16 (h0->priority_cfi_and_id);
 161
 162           *inner_id = tag & 0xfff;
 163
 164           *type = clib_net_to_host_u16 (h0->type);
 165
 166           vlib_buffer_advance (b0, sizeof (h0[0]));
 167           vlan_count = 2;
 168           if (*type == ETHERNET_TYPE_VLAN)
 169             {
 170               // More than double tagged packet
 171               *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_3_TAG;
 172
 173               vlib_buffer_advance (b0, sizeof (h0[0]));
 174               vlan_count = 3;   // "unknown" number, aka, 3-or-more
 175             }
 176         }
 177     }
 178   ethernet_buffer_set_vlan_count (b0, vlan_count);
 179 }
 180
 181 // Determine the subinterface for this packet, given the result of the
 182 // vlan table lookups and vlan header parsing. Check the most specific
 183 // matches first.
 184 static_always_inline void
 185 identify_subint (vnet_hw_interface_t * hi,
 186                  vlib_buffer_t * b0,
 187                  u32 match_flags,
 188                  main_intf_t * main_intf,
 189                  vlan_intf_t * vlan_intf,
 190                  qinq_intf_t * qinq_intf,
 191                  u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
 192 {
 193   u32 matched;
 194
 195   matched = eth_identify_subint (hi, b0, match_flags,
 196                                  main_intf, vlan_intf, qinq_intf,
 197                                  new_sw_if_index, error0, is_l2);
 198
 199   if (matched)
 200     {
 201
 202       // Perform L3 my-mac filter
 203       // A unicast packet arriving on an L3 interface must have a dmac matching the interface mac.
 204       // This is required for promiscuous mode, else we will forward packets we aren't supposed to.
 205       if (!(*is_l2))
 206         {
 207           ethernet_header_t *e0;
 208           e0 =
 209             (void *) (b0->data +
 210                       vnet_buffer (b0)->ethernet.start_of_ethernet_header);
 211
 212           if (!(ethernet_address_cast (e0->dst_address)))
 213             {
 214               if (!eth_mac_equal ((u8 *) e0, hi->hw_address))
 215                 {
 216                   *error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
 217                 }
 218             }
 219         }
 220
 221       // Check for down subinterface
 222       *error0 = (*new_sw_if_index) != ~0 ? (*error0) : ETHERNET_ERROR_DOWN;
 223     }
 224 }
 225
 226 static_always_inline void
 227 determine_next_node (ethernet_main_t * em,
 228                      ethernet_input_variant_t variant,
 229                      u32 is_l20,
 230                      u32 type0, vlib_buffer_t * b0, u8 * error0, u8 * next0)
 231 {
 232   if (PREDICT_FALSE (*error0 != ETHERNET_ERROR_NONE))
 233     {
 234       // some error occurred
 235       *next0 = ETHERNET_INPUT_NEXT_DROP;
 236     }
 237   else if (is_l20)
 238     {
 239       *next0 = em->l2_next;
 240       // record the L2 len and reset the buffer so the L2 header is preserved
 241       u32 eth_start = vnet_buffer (b0)->ethernet.start_of_ethernet_header;
 242       vnet_buffer (b0)->l2.l2_len = b0->current_data - eth_start;
 243       ASSERT (vnet_buffer (b0)->l2.l2_len ==
 244               ethernet_buffer_header_size (b0));
 245       vlib_buffer_advance (b0, -ethernet_buffer_header_size (b0));
 246
 247       // check for common IP/MPLS ethertypes
 248     }
 249   else if (type0 == ETHERNET_TYPE_IP4)
 250     {
 251       *next0 = em->l3_next.input_next_ip4;
 252     }
 253   else if (type0 == ETHERNET_TYPE_IP6)
 254     {
 255       *next0 = em->l3_next.input_next_ip6;
 256     }
 257   else if (type0 == ETHERNET_TYPE_MPLS)
 258     {
 259       *next0 = em->l3_next.input_next_mpls;
 260
 261     }
 262   else if (em->redirect_l3)
 263     {
 264       // L3 Redirect is on, the cached common next nodes will be
 265       // pointing to the redirect node, catch the uncommon types here
 266       *next0 = em->redirect_l3_next;
 267     }
 268   else
 269     {
 270       // uncommon ethertype, check table
 271       u32 i0;
 272       i0 = sparse_vec_index (em->l3_next.input_next_by_type, type0);
 273       *next0 = vec_elt (em->l3_next.input_next_by_type, i0);
 274       *error0 =
 275         i0 ==
 276         SPARSE_VEC_INVALID_INDEX ? ETHERNET_ERROR_UNKNOWN_TYPE : *error0;
 277
 278       // The table is not populated with LLC values, so check that now.
 279       // If variant is variant_ethernet then we came from LLC processing. Don't
 280       // go back there; drop instead using by keeping the drop/bad table result.
 281       if ((type0 < 0x600) && (variant == ETHERNET_INPUT_VARIANT_ETHERNET))
 282         {
 283           *next0 = ETHERNET_INPUT_NEXT_LLC;
 284         }
 285     }
 286 }
 287
 288 static_always_inline int
 289 ethernet_frame_is_any_tagged (u16 type0, u16 type1)
 290 {
 291 #if __SSE4_2__
 292   const __m128i ethertype_mask = _mm_set_epi16 (ETHERNET_TYPE_VLAN,
 293                                                 ETHERNET_TYPE_DOT1AD,
 294                                                 ETHERNET_TYPE_VLAN_9100,
 295                                                 ETHERNET_TYPE_VLAN_9200,
 296                                                 /* duplicate for type1 */
 297                                                 ETHERNET_TYPE_VLAN,
 298                                                 ETHERNET_TYPE_DOT1AD,
 299                                                 ETHERNET_TYPE_VLAN_9100,
 300                                                 ETHERNET_TYPE_VLAN_9200);
 301
 302   __m128i r =
 303     _mm_set_epi16 (type0, type0, type0, type0, type1, type1, type1, type1);
 304   r = _mm_cmpeq_epi16 (ethertype_mask, r);
 305   return !_mm_test_all_zeros (r, r);
 306 #else
 307   return ethernet_frame_is_tagged (type0) || ethernet_frame_is_tagged (type1);
 308 #endif
 309 }
 310
 311 static_always_inline uword
 312 ethernet_input_inline (vlib_main_t * vm,
 313                        vlib_node_runtime_t * node,
 314                        vlib_frame_t * from_frame,
 315                        ethernet_input_variant_t variant)
 316 {
 317   vnet_main_t *vnm = vnet_get_main ();
 318   ethernet_main_t *em = &ethernet_main;
 319   vlib_node_runtime_t *error_node;
 320   u32 n_left_from, next_index, *from, *to_next;
 321   u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
 322   u32 thread_index = vlib_get_thread_index ();
 323   u32 cached_sw_if_index = ~0;
 324   u32 cached_is_l2 = 0;         /* shut up gcc */
 325   vnet_hw_interface_t *hi = NULL;       /* used for main interface only */
 326
 327   if (variant != ETHERNET_INPUT_VARIANT_ETHERNET)
 328     error_node = vlib_node_get_runtime (vm, ethernet_input_node.index);
 329   else
 330     error_node = node;
 331
 332   from = vlib_frame_vector_args (from_frame);
 333   n_left_from = from_frame->n_vectors;
 334
 335   if (node->flags & VLIB_NODE_FLAG_TRACE)
 336     vlib_trace_frame_buffers_only (vm, node,
 337                                    from,
 338                                    n_left_from,
 339                                    sizeof (from[0]),
 340                                    sizeof (ethernet_input_trace_t));
 341
 342   next_index = node->cached_next_index;
 343   stats_sw_if_index = node->runtime_data[0];
 344   stats_n_packets = stats_n_bytes = 0;
 345
 346   while (n_left_from > 0)
 347     {
 348       u32 n_left_to_next;
 349
 350       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 351
 352       while (n_left_from >= 4 && n_left_to_next >= 2)
 353         {
 354           u32 bi0, bi1;
 355           vlib_buffer_t *b0, *b1;
 356           u8 next0, next1, error0, error1;
 357           u16 type0, orig_type0, type1, orig_type1;
 358           u16 outer_id0, inner_id0, outer_id1, inner_id1;
 359           u32 match_flags0, match_flags1;
 360           u32 old_sw_if_index0, new_sw_if_index0, len0, old_sw_if_index1,
 361             new_sw_if_index1, len1;
 362           vnet_hw_interface_t *hi0, *hi1;
 363           main_intf_t *main_intf0, *main_intf1;
 364           vlan_intf_t *vlan_intf0, *vlan_intf1;
 365           qinq_intf_t *qinq_intf0, *qinq_intf1;
 366           u32 is_l20, is_l21;
 367           ethernet_header_t *e0, *e1;
 368
 369           /* Prefetch next iteration. */
 370           {
 371             vlib_buffer_t *b2, *b3;
 372
 373             b2 = vlib_get_buffer (vm, from[2]);
 374             b3 = vlib_get_buffer (vm, from[3]);
 375
 376             vlib_prefetch_buffer_header (b2, STORE);
 377             vlib_prefetch_buffer_header (b3, STORE);
 378
 379             CLIB_PREFETCH (b2->data, sizeof (ethernet_header_t), LOAD);
 380             CLIB_PREFETCH (b3->data, sizeof (ethernet_header_t), LOAD);
 381           }
 382
 383           bi0 = from[0];
 384           bi1 = from[1];
 385           to_next[0] = bi0;
 386           to_next[1] = bi1;
 387           from += 2;
 388           to_next += 2;
 389           n_left_to_next -= 2;
 390           n_left_from -= 2;
 391
 392           b0 = vlib_get_buffer (vm, bi0);
 393           b1 = vlib_get_buffer (vm, bi1);
 394
 395           error0 = error1 = ETHERNET_ERROR_NONE;
 396           e0 = vlib_buffer_get_current (b0);
 397           type0 = clib_net_to_host_u16 (e0->type);
 398           e1 = vlib_buffer_get_current (b1);
 399           type1 = clib_net_to_host_u16 (e1->type);
 400
 401           /* Speed-path for the untagged case */
 402           if (PREDICT_TRUE (variant == ETHERNET_INPUT_VARIANT_ETHERNET
 403                             && !ethernet_frame_is_any_tagged (type0, type1)))
 404             {
 405               main_intf_t *intf0;
 406               subint_config_t *subint0;
 407               u32 sw_if_index0, sw_if_index1;
 408
 409               sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 410               sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
 411               is_l20 = cached_is_l2;
 412
 413               /* This is probably wholly unnecessary */
 414               if (PREDICT_FALSE (sw_if_index0 != sw_if_index1))
 415                 goto slowpath;
 416
 417               /* Now sw_if_index0 == sw_if_index1  */
 418               if (PREDICT_FALSE (cached_sw_if_index != sw_if_index0))
 419                 {
 420                   cached_sw_if_index = sw_if_index0;
 421                   hi = vnet_get_sup_hw_interface (vnm, sw_if_index0);
 422                   intf0 = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
 423                   subint0 = &intf0->untagged_subint;
 424                   cached_is_l2 = is_l20 = subint0->flags & SUBINT_CONFIG_L2;
 425                 }
 426
 427               vnet_buffer (b0)->ethernet.start_of_ethernet_header =
 428                 b0->current_data;
 429               vnet_buffer (b1)->ethernet.start_of_ethernet_header =
 430                 b1->current_data;
 431
 432               if (PREDICT_TRUE (is_l20 != 0))
 433                 {
 434                   next0 = em->l2_next;
 435                   vnet_buffer (b0)->l2.l2_len = sizeof (ethernet_header_t);
 436                   next1 = em->l2_next;
 437                   vnet_buffer (b1)->l2.l2_len = sizeof (ethernet_header_t);
 438                 }
 439               else
 440                 {
 441                   if (!ethernet_address_cast (e0->dst_address) &&
 442                       (hi->hw_address != 0) &&
 443                       !eth_mac_equal ((u8 *) e0, hi->hw_address))
 444                     error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
 445                   if (!ethernet_address_cast (e1->dst_address) &&
 446                       (hi->hw_address != 0) &&
 447                       !eth_mac_equal ((u8 *) e1, hi->hw_address))
 448                     error1 = ETHERNET_ERROR_L3_MAC_MISMATCH;
 449                   determine_next_node (em, variant, 0, type0, b0,
 450                                        &error0, &next0);
 451                   vlib_buffer_advance (b0, sizeof (ethernet_header_t));
 452                   determine_next_node (em, variant, 0, type1, b1,
 453                                        &error1, &next1);
 454                   vlib_buffer_advance (b1, sizeof (ethernet_header_t));
 455                 }
 456               goto ship_it01;
 457             }
 458
 459           /* Slow-path for the tagged case */
 460         slowpath:
 461           parse_header (variant,
 462                         b0,
 463                         &type0,
 464                         &orig_type0, &outer_id0, &inner_id0, &match_flags0);
 465
 466           parse_header (variant,
 467                         b1,
 468                         &type1,
 469                         &orig_type1, &outer_id1, &inner_id1, &match_flags1);
 470
 471           old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 472           old_sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
 473
 474           eth_vlan_table_lookups (em,
 475                                   vnm,
 476                                   old_sw_if_index0,
 477                                   orig_type0,
 478                                   outer_id0,
 479                                   inner_id0,
 480                                   &hi0,
 481                                   &main_intf0, &vlan_intf0, &qinq_intf0);
 482
 483           eth_vlan_table_lookups (em,
 484                                   vnm,
 485                                   old_sw_if_index1,
 486                                   orig_type1,
 487                                   outer_id1,
 488                                   inner_id1,
 489                                   &hi1,
 490                                   &main_intf1, &vlan_intf1, &qinq_intf1);
 491
 492           identify_subint (hi0,
 493                            b0,
 494                            match_flags0,
 495                            main_intf0,
 496                            vlan_intf0,
 497                            qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
 498
 499           identify_subint (hi1,
 500                            b1,
 501                            match_flags1,
 502                            main_intf1,
 503                            vlan_intf1,
 504                            qinq_intf1, &new_sw_if_index1, &error1, &is_l21);
 505
 506           // Save RX sw_if_index for later nodes
 507           vnet_buffer (b0)->sw_if_index[VLIB_RX] =
 508             error0 !=
 509             ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
 510           vnet_buffer (b1)->sw_if_index[VLIB_RX] =
 511             error1 !=
 512             ETHERNET_ERROR_NONE ? old_sw_if_index1 : new_sw_if_index1;
 513
 514           // Check if there is a stat to take (valid and non-main sw_if_index for pkt 0 or pkt 1)
 515           if (((new_sw_if_index0 != ~0)
 516                && (new_sw_if_index0 != old_sw_if_index0))
 517               || ((new_sw_if_index1 != ~0)
 518                   && (new_sw_if_index1 != old_sw_if_index1)))
 519             {
 520
 521               len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
 522                 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
 523               len1 = vlib_buffer_length_in_chain (vm, b1) + b1->current_data
 524                 - vnet_buffer (b1)->ethernet.start_of_ethernet_header;
 525
 526               stats_n_packets += 2;
 527               stats_n_bytes += len0 + len1;
 528
 529               if (PREDICT_FALSE
 530                   (!(new_sw_if_index0 == stats_sw_if_index
 531                      && new_sw_if_index1 == stats_sw_if_index)))
 532                 {
 533                   stats_n_packets -= 2;
 534                   stats_n_bytes -= len0 + len1;
 535
 536                   if (new_sw_if_index0 != old_sw_if_index0
 537                       && new_sw_if_index0 != ~0)
 538                     vlib_increment_combined_counter (vnm->
 539                                                      interface_main.combined_sw_if_counters
 540                                                      +
 541                                                      VNET_INTERFACE_COUNTER_RX,
 542                                                      thread_index,
 543                                                      new_sw_if_index0, 1,
 544                                                      len0);
 545                   if (new_sw_if_index1 != old_sw_if_index1
 546                       && new_sw_if_index1 != ~0)
 547                     vlib_increment_combined_counter (vnm->
 548                                                      interface_main.combined_sw_if_counters
 549                                                      +
 550                                                      VNET_INTERFACE_COUNTER_RX,
 551                                                      thread_index,
 552                                                      new_sw_if_index1, 1,
 553                                                      len1);
 554
 555                   if (new_sw_if_index0 == new_sw_if_index1)
 556                     {
 557                       if (stats_n_packets > 0)
 558                         {
 559                           vlib_increment_combined_counter
 560                             (vnm->interface_main.combined_sw_if_counters
 561                              + VNET_INTERFACE_COUNTER_RX,
 562                              thread_index,
 563                              stats_sw_if_index,
 564                              stats_n_packets, stats_n_bytes);
 565                           stats_n_packets = stats_n_bytes = 0;
 566                         }
 567                       stats_sw_if_index = new_sw_if_index0;
 568                     }
 569                 }
 570             }
 571
 572           if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
 573             is_l20 = is_l21 = 0;
 574
 575           determine_next_node (em, variant, is_l20, type0, b0, &error0,
 576                                &next0);
 577           determine_next_node (em, variant, is_l21, type1, b1, &error1,
 578                                &next1);
 579
 580         ship_it01:
 581           b0->error = error_node->errors[error0];
 582           b1->error = error_node->errors[error1];
 583
 584           // verify speculative enqueue
 585           vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
 586                                            n_left_to_next, bi0, bi1, next0,
 587                                            next1);
 588         }
 589
 590       while (n_left_from > 0 && n_left_to_next > 0)
 591         {
 592           u32 bi0;
 593           vlib_buffer_t *b0;
 594           u8 error0, next0;
 595           u16 type0, orig_type0;
 596           u16 outer_id0, inner_id0;
 597           u32 match_flags0;
 598           u32 old_sw_if_index0, new_sw_if_index0, len0;
 599           vnet_hw_interface_t *hi0;
 600           main_intf_t *main_intf0;
 601           vlan_intf_t *vlan_intf0;
 602           qinq_intf_t *qinq_intf0;
 603           ethernet_header_t *e0;
 604           u32 is_l20;
 605
 606           // Prefetch next iteration
 607           if (n_left_from > 1)
 608             {
 609               vlib_buffer_t *p2;
 610
 611               p2 = vlib_get_buffer (vm, from[1]);
 612               vlib_prefetch_buffer_header (p2, STORE);
 613               CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, LOAD);
 614             }
 615
 616           bi0 = from[0];
 617           to_next[0] = bi0;
 618           from += 1;
 619           to_next += 1;
 620           n_left_from -= 1;
 621           n_left_to_next -= 1;
 622
 623           b0 = vlib_get_buffer (vm, bi0);
 624
 625           error0 = ETHERNET_ERROR_NONE;
 626           e0 = vlib_buffer_get_current (b0);
 627           type0 = clib_net_to_host_u16 (e0->type);
 628
 629           /* Speed-path for the untagged case */
 630           if (PREDICT_TRUE (variant == ETHERNET_INPUT_VARIANT_ETHERNET
 631                             && !ethernet_frame_is_tagged (type0)))
 632             {
 633               main_intf_t *intf0;
 634               subint_config_t *subint0;
 635               u32 sw_if_index0;
 636
 637               sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 638               is_l20 = cached_is_l2;
 639
 640               if (PREDICT_FALSE (cached_sw_if_index != sw_if_index0))
 641                 {
 642                   cached_sw_if_index = sw_if_index0;
 643                   hi = vnet_get_sup_hw_interface (vnm, sw_if_index0);
 644                   intf0 = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
 645                   subint0 = &intf0->untagged_subint;
 646                   cached_is_l2 = is_l20 = subint0->flags & SUBINT_CONFIG_L2;
 647                 }
 648
 649               vnet_buffer (b0)->ethernet.start_of_ethernet_header =
 650                 b0->current_data;
 651
 652               if (PREDICT_TRUE (is_l20 != 0))
 653                 {
 654                   next0 = em->l2_next;
 655                   vnet_buffer (b0)->l2.l2_len = sizeof (ethernet_header_t);
 656                 }
 657               else
 658                 {
 659                   if (!ethernet_address_cast (e0->dst_address) &&
 660                       (hi->hw_address != 0) &&
 661                       !eth_mac_equal ((u8 *) e0, hi->hw_address))
 662                     error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
 663                   determine_next_node (em, variant, 0, type0, b0,
 664                                        &error0, &next0);
 665                   vlib_buffer_advance (b0, sizeof (ethernet_header_t));
 666                 }
 667               goto ship_it0;
 668             }
 669
 670           /* Slow-path for the tagged case */
 671           parse_header (variant,
 672                         b0,
 673                         &type0,
 674                         &orig_type0, &outer_id0, &inner_id0, &match_flags0);
 675
 676           old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 677
 678           eth_vlan_table_lookups (em,
 679                                   vnm,
 680                                   old_sw_if_index0,
 681                                   orig_type0,
 682                                   outer_id0,
 683                                   inner_id0,
 684                                   &hi0,
 685                                   &main_intf0, &vlan_intf0, &qinq_intf0);
 686
 687           identify_subint (hi0,
 688                            b0,
 689                            match_flags0,
 690                            main_intf0,
 691                            vlan_intf0,
 692                            qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
 693
 694           // Save RX sw_if_index for later nodes
 695           vnet_buffer (b0)->sw_if_index[VLIB_RX] =
 696             error0 !=
 697             ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
 698
 699           // Increment subinterface stats
 700           // Note that interface-level counters have already been incremented
 701           // prior to calling this function. Thus only subinterface counters
 702           // are incremented here.
 703           //
 704           // Interface level counters include packets received on the main
 705           // interface and all subinterfaces. Subinterface level counters
 706           // include only those packets received on that subinterface
 707           // Increment stats if the subint is valid and it is not the main intf
 708           if ((new_sw_if_index0 != ~0)
 709               && (new_sw_if_index0 != old_sw_if_index0))
 710             {
 711
 712               len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
 713                 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
 714
 715               stats_n_packets += 1;
 716               stats_n_bytes += len0;
 717
 718               // Batch stat increments from the same subinterface so counters
 719               // don't need to be incremented for every packet.
 720               if (PREDICT_FALSE (new_sw_if_index0 != stats_sw_if_index))
 721                 {
 722                   stats_n_packets -= 1;
 723                   stats_n_bytes -= len0;
 724
 725                   if (new_sw_if_index0 != ~0)
 726                     vlib_increment_combined_counter
 727                       (vnm->interface_main.combined_sw_if_counters
 728                        + VNET_INTERFACE_COUNTER_RX,
 729                        thread_index, new_sw_if_index0, 1, len0);
 730                   if (stats_n_packets > 0)
 731                     {
 732                       vlib_increment_combined_counter
 733                         (vnm->interface_main.combined_sw_if_counters
 734                          + VNET_INTERFACE_COUNTER_RX,
 735                          thread_index,
 736                          stats_sw_if_index, stats_n_packets, stats_n_bytes);
 737                       stats_n_packets = stats_n_bytes = 0;
 738                     }
 739                   stats_sw_if_index = new_sw_if_index0;
 740                 }
 741             }
 742
 743           if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
 744             is_l20 = 0;
 745
 746           determine_next_node (em, variant, is_l20, type0, b0, &error0,
 747                                &next0);
 748
 749         ship_it0:
 750           b0->error = error_node->errors[error0];
 751
 752           // verify speculative enqueue
 753           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 754                                            to_next, n_left_to_next,
 755                                            bi0, next0);
 756         }
 757
 758       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 759     }
 760
 761   // Increment any remaining batched stats
 762   if (stats_n_packets > 0)
 763     {
 764       vlib_increment_combined_counter
 765         (vnm->interface_main.combined_sw_if_counters
 766          + VNET_INTERFACE_COUNTER_RX,
 767          thread_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
 768       node->runtime_data[0] = stats_sw_if_index;
 769     }
 770
 771   return from_frame->n_vectors;
 772 }
 773
 774 static uword
 775 ethernet_input (vlib_main_t * vm,
 776                 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
 777 {
 778   return ethernet_input_inline (vm, node, from_frame,
 779                                 ETHERNET_INPUT_VARIANT_ETHERNET);
 780 }
 781
 782 static uword
 783 ethernet_input_type (vlib_main_t * vm,
 784                      vlib_node_runtime_t * node, vlib_frame_t * from_frame)
 785 {
 786   return ethernet_input_inline (vm, node, from_frame,
 787                                 ETHERNET_INPUT_VARIANT_ETHERNET_TYPE);
 788 }
 789
 790 static uword
 791 ethernet_input_not_l2 (vlib_main_t * vm,
 792                        vlib_node_runtime_t * node, vlib_frame_t * from_frame)
 793 {
 794   return ethernet_input_inline (vm, node, from_frame,
 795                                 ETHERNET_INPUT_VARIANT_NOT_L2);
 796 }
 797
 798
 799 // Return the subinterface config struct for the given sw_if_index
 800 // Also return via parameter the appropriate match flags for the
 801 // configured number of tags.
 802 // On error (unsupported or not ethernet) return 0.
 803 static subint_config_t *
 804 ethernet_sw_interface_get_config (vnet_main_t * vnm,
 805                                   u32 sw_if_index,
 806                                   u32 * flags, u32 * unsupported)
 807 {
 808   ethernet_main_t *em = &ethernet_main;
 809   vnet_hw_interface_t *hi;
 810   vnet_sw_interface_t *si;
 811   main_intf_t *main_intf;
 812   vlan_table_t *vlan_table;
 813   qinq_table_t *qinq_table;
 814   subint_config_t *subint = 0;
 815
 816   hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
 817
 818   if (!hi || (hi->hw_class_index != ethernet_hw_interface_class.index))
 819     {
 820       *unsupported = 0;
 821       goto done;                // non-ethernet interface
 822     }
 823
 824   // ensure there's an entry for the main intf (shouldn't really be necessary)
 825   vec_validate (em->main_intfs, hi->hw_if_index);
 826   main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
 827
 828   // Locate the subint for the given ethernet config
 829   si = vnet_get_sw_interface (vnm, sw_if_index);
 830
 831   if (si->sub.eth.flags.default_sub)
 832     {
 833       subint = &main_intf->default_subint;
 834       *flags = SUBINT_CONFIG_MATCH_0_TAG |
 835         SUBINT_CONFIG_MATCH_1_TAG |
 836         SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
 837     }
 838   else if ((si->sub.eth.flags.no_tags) || (si->sub.eth.raw_flags == 0))
 839     {
 840       // if no flags are set then this is a main interface
 841       // so treat as untagged
 842       subint = &main_intf->untagged_subint;
 843       *flags = SUBINT_CONFIG_MATCH_0_TAG;
 844     }
 845   else
 846     {
 847       // one or two tags
 848       // first get the vlan table
 849       if (si->sub.eth.flags.dot1ad)
 850         {
 851           if (main_intf->dot1ad_vlans == 0)
 852             {
 853               // Allocate a vlan table from the pool
 854               pool_get (em->vlan_pool, vlan_table);
 855               main_intf->dot1ad_vlans = vlan_table - em->vlan_pool;
 856             }
 857           else
 858             {
 859               // Get ptr to existing vlan table
 860               vlan_table =
 861                 vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
 862             }
 863         }
 864       else
 865         {                       // dot1q
 866           if (main_intf->dot1q_vlans == 0)
 867             {
 868               // Allocate a vlan table from the pool
 869               pool_get (em->vlan_pool, vlan_table);
 870               main_intf->dot1q_vlans = vlan_table - em->vlan_pool;
 871             }
 872           else
 873             {
 874               // Get ptr to existing vlan table
 875               vlan_table =
 876                 vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
 877             }
 878         }
 879
 880       if (si->sub.eth.flags.one_tag)
 881         {
 882           *flags = si->sub.eth.flags.exact_match ?
 883             SUBINT_CONFIG_MATCH_1_TAG :
 884             (SUBINT_CONFIG_MATCH_1_TAG |
 885              SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
 886
 887           if (si->sub.eth.flags.outer_vlan_id_any)
 888             {
 889               // not implemented yet
 890               *unsupported = 1;
 891               goto done;
 892             }
 893           else
 894             {
 895               // a single vlan, a common case
 896               subint =
 897                 &vlan_table->vlans[si->sub.eth.
 898                                    outer_vlan_id].single_tag_subint;
 899             }
 900
 901         }
 902       else
 903         {
 904           // Two tags
 905           *flags = si->sub.eth.flags.exact_match ?
 906             SUBINT_CONFIG_MATCH_2_TAG :
 907             (SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
 908
 909           if (si->sub.eth.flags.outer_vlan_id_any
 910               && si->sub.eth.flags.inner_vlan_id_any)
 911             {
 912               // not implemented yet
 913               *unsupported = 1;
 914               goto done;
 915             }
 916
 917           if (si->sub.eth.flags.inner_vlan_id_any)
 918             {
 919               // a specific outer and "any" inner
 920               // don't need a qinq table for this
 921               subint =
 922                 &vlan_table->vlans[si->sub.eth.
 923                                    outer_vlan_id].inner_any_subint;
 924               if (si->sub.eth.flags.exact_match)
 925                 {
 926                   *flags = SUBINT_CONFIG_MATCH_2_TAG;
 927                 }
 928               else
 929                 {
 930                   *flags = SUBINT_CONFIG_MATCH_2_TAG |
 931                     SUBINT_CONFIG_MATCH_3_TAG;
 932                 }
 933             }
 934           else
 935             {
 936               // a specific outer + specifc innner vlan id, a common case
 937
 938               // get the qinq table
 939               if (vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs == 0)
 940                 {
 941                   // Allocate a qinq table from the pool
 942                   pool_get (em->qinq_pool, qinq_table);
 943                   vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs =
 944                     qinq_table - em->qinq_pool;
 945                 }
 946               else
 947                 {
 948                   // Get ptr to existing qinq table
 949                   qinq_table =
 950                     vec_elt_at_index (em->qinq_pool,
 951                                       vlan_table->vlans[si->sub.
 952                                                         eth.outer_vlan_id].
 953                                       qinqs);
 954                 }
 955               subint = &qinq_table->vlans[si->sub.eth.inner_vlan_id].subint;
 956             }
 957         }
 958     }
 959
 960 done:
 961   return subint;
 962 }
 963
 964 clib_error_t *
 965 ethernet_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
 966 {
 967   subint_config_t *subint;
 968   u32 dummy_flags;
 969   u32 dummy_unsup;
 970   clib_error_t *error = 0;
 971
 972   // Find the config for this subinterface
 973   subint =
 974     ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
 975                                       &dummy_unsup);
 976
 977   if (subint == 0)
 978     {
 979       // not implemented yet or not ethernet
 980       goto done;
 981     }
 982
 983   subint->sw_if_index =
 984     ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? sw_if_index : ~0);
 985
 986 done:
 987   return error;
 988 }
 989
 990 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_sw_interface_up_down);
 991
 992
 993 // Set the L2/L3 mode for the subinterface
 994 void
 995 ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index, u32 l2)
 996 {
 997   subint_config_t *subint;
 998   u32 dummy_flags;
 999   u32 dummy_unsup;
1000   int is_port;
1001   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
1002
1003   is_port = !(sw->type == VNET_SW_INTERFACE_TYPE_SUB);
1004
1005   // Find the config for this subinterface
1006   subint =
1007     ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
1008                                       &dummy_unsup);
1009
1010   if (subint == 0)
1011     {
1012       // unimplemented or not ethernet
1013       goto done;
1014     }
1015
1016   // Double check that the config we found is for our interface (or the interface is down)
1017   ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
1018
1019   if (l2)
1020     {
1021       subint->flags |= SUBINT_CONFIG_L2;
1022       if (is_port)
1023         subint->flags |=
1024           SUBINT_CONFIG_MATCH_0_TAG | SUBINT_CONFIG_MATCH_1_TAG
1025           | SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
1026     }
1027   else
1028     {
1029       subint->flags &= ~SUBINT_CONFIG_L2;
1030       if (is_port)
1031         subint->flags &=
1032           ~(SUBINT_CONFIG_MATCH_1_TAG | SUBINT_CONFIG_MATCH_2_TAG
1033             | SUBINT_CONFIG_MATCH_3_TAG);
1034     }
1035
1036 done:
1037   return;
1038 }
1039
1040 /*
1041  * Set the L2/L3 mode for the subinterface regardless of port
1042  */
1043 void
1044 ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
1045                                           u32 sw_if_index, u32 l2)
1046 {
1047   subint_config_t *subint;
1048   u32 dummy_flags;
1049   u32 dummy_unsup;
1050
1051   /* Find the config for this subinterface */
1052   subint =
1053     ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
1054                                       &dummy_unsup);
1055
1056   if (subint == 0)
1057     {
1058       /* unimplemented or not ethernet */
1059       goto done;
1060     }
1061
1062   /*
1063    * Double check that the config we found is for our interface (or the
1064    * interface is down)
1065    */
1066   ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
1067
1068   if (l2)
1069     {
1070       subint->flags |= SUBINT_CONFIG_L2;
1071     }
1072   else
1073     {
1074       subint->flags &= ~SUBINT_CONFIG_L2;
1075     }
1076
1077 done:
1078   return;
1079 }
1080
1081 static clib_error_t *
1082 ethernet_sw_interface_add_del (vnet_main_t * vnm,
1083                                u32 sw_if_index, u32 is_create)
1084 {
1085   clib_error_t *error = 0;
1086   subint_config_t *subint;
1087   u32 match_flags;
1088   u32 unsupported = 0;
1089
1090   // Find the config for this subinterface
1091   subint =
1092     ethernet_sw_interface_get_config (vnm, sw_if_index, &match_flags,
1093                                       &unsupported);
1094
1095   if (subint == 0)
1096     {
1097       // not implemented yet or not ethernet
1098       if (unsupported)
1099         {
1100           // this is the NYI case
1101           error = clib_error_return (0, "not implemented yet");
1102         }
1103       goto done;
1104     }
1105
1106   if (!is_create)
1107     {
1108       subint->flags = 0;
1109       return error;
1110     }
1111
1112   // Initialize the subint
1113   if (subint->flags & SUBINT_CONFIG_VALID)
1114     {
1115       // Error vlan already in use
1116       error = clib_error_return (0, "vlan is already in use");
1117     }
1118   else
1119     {
1120       // Note that config is L3 by defaulty
1121       subint->flags = SUBINT_CONFIG_VALID | match_flags;
1122       subint->sw_if_index = ~0; // because interfaces are initially down
1123     }
1124
1125 done:
1126   return error;
1127 }
1128
1129 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ethernet_sw_interface_add_del);
1130
1131 static char *ethernet_error_strings[] = {
1132 #define ethernet_error(n,c,s) s,
1133 #include "error.def"
1134 #undef ethernet_error
1135 };
1136
1137 /* *INDENT-OFF* */
1138 VLIB_REGISTER_NODE (ethernet_input_node) = {
1139   .function = ethernet_input,
1140   .name = "ethernet-input",
1141   /* Takes a vector of packets. */
1142   .vector_size = sizeof (u32),
1143   .n_errors = ETHERNET_N_ERROR,
1144   .error_strings = ethernet_error_strings,
1145   .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1146   .next_nodes = {
1147 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1148     foreach_ethernet_input_next
1149 #undef _
1150   },
1151   .format_buffer = format_ethernet_header_with_length,
1152   .format_trace = format_ethernet_input_trace,
1153   .unformat_buffer = unformat_ethernet_header,
1154 };
1155 /* *INDENT-ON* */
1156
1157 /* *INDENT-OFF* */
1158 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_node, ethernet_input)
1159 /* *INDENT-ON* */
1160
1161 /* *INDENT-OFF* */
1162 VLIB_REGISTER_NODE (ethernet_input_type_node, static) = {
1163   .function = ethernet_input_type,
1164   .name = "ethernet-input-type",
1165   /* Takes a vector of packets. */
1166   .vector_size = sizeof (u32),
1167   .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1168   .next_nodes = {
1169 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1170     foreach_ethernet_input_next
1171 #undef _
1172   },
1173 };
1174 /* *INDENT-ON* */
1175
1176 /* *INDENT-OFF* */
1177 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_type_node, ethernet_input_type)
1178 /* *INDENT-ON* */
1179
1180 /* *INDENT-OFF* */
1181 VLIB_REGISTER_NODE (ethernet_input_not_l2_node, static) = {
1182   .function = ethernet_input_not_l2,
1183   .name = "ethernet-input-not-l2",
1184   /* Takes a vector of packets. */
1185   .vector_size = sizeof (u32),
1186   .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1187   .next_nodes = {
1188 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1189     foreach_ethernet_input_next
1190 #undef _
1191   },
1192 };
1193 /* *INDENT-ON* */
1194
1195
1196 /* *INDENT-OFF* */
1197 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_not_l2_node,
1198                               ethernet_input_not_l2)
1199 /* *INDENT-ON* */
1200
1201
1202 void
1203 ethernet_set_rx_redirect (vnet_main_t * vnm,
1204                           vnet_hw_interface_t * hi, u32 enable)
1205 {
1206   // Insure all packets go to ethernet-input (i.e. untagged ipv4 packets
1207   // don't go directly to ip4-input)
1208   vnet_hw_interface_rx_redirect_to_node
1209     (vnm, hi->hw_if_index, enable ? ethernet_input_node.index : ~0);
1210 }
1211
1212
1213 /*
1214  * Initialization and registration for the next_by_ethernet structure
1215  */
1216
1217 clib_error_t *
1218 next_by_ethertype_init (next_by_ethertype_t * l3_next)
1219 {
1220   l3_next->input_next_by_type = sparse_vec_new
1221     ( /* elt bytes */ sizeof (l3_next->input_next_by_type[0]),
1222      /* bits in index */ BITS (((ethernet_header_t *) 0)->type));
1223
1224   vec_validate (l3_next->sparse_index_by_input_next_index,
1225                 ETHERNET_INPUT_NEXT_DROP);
1226   vec_validate (l3_next->sparse_index_by_input_next_index,
1227                 ETHERNET_INPUT_NEXT_PUNT);
1228   l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_DROP] =
1229     SPARSE_VEC_INVALID_INDEX;
1230   l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_PUNT] =
1231     SPARSE_VEC_INVALID_INDEX;
1232
1233   /*
1234    * Make sure we don't wipe out an ethernet registration by mistake
1235    * Can happen if init function ordering constraints are missing.
1236    */
1237   if (CLIB_DEBUG > 0)
1238     {
1239       ethernet_main_t *em = &ethernet_main;
1240       ASSERT (em->next_by_ethertype_register_called == 0);
1241     }
1242
1243   return 0;
1244 }
1245
1246 // Add an ethertype -> next index mapping to the structure
1247 clib_error_t *
1248 next_by_ethertype_register (next_by_ethertype_t * l3_next,
1249                             u32 ethertype, u32 next_index)
1250 {
1251   u32 i;
1252   u16 *n;
1253   ethernet_main_t *em = &ethernet_main;
1254
1255   if (CLIB_DEBUG > 0)
1256     {
1257       ethernet_main_t *em = &ethernet_main;
1258       em->next_by_ethertype_register_called = 1;
1259     }
1260
1261   /* Setup ethernet type -> next index sparse vector mapping. */
1262   n = sparse_vec_validate (l3_next->input_next_by_type, ethertype);
1263   n[0] = next_index;
1264
1265   /* Rebuild next index -> sparse index inverse mapping when sparse vector
1266      is updated. */
1267   vec_validate (l3_next->sparse_index_by_input_next_index, next_index);
1268   for (i = 1; i < vec_len (l3_next->input_next_by_type); i++)
1269     l3_next->
1270       sparse_index_by_input_next_index[l3_next->input_next_by_type[i]] = i;
1271
1272   // do not allow the cached next index's to be updated if L3
1273   // redirect is enabled, as it will have overwritten them
1274   if (!em->redirect_l3)
1275     {
1276       // Cache common ethertypes directly
1277       if (ethertype == ETHERNET_TYPE_IP4)
1278         {
1279           l3_next->input_next_ip4 = next_index;
1280         }
1281       else if (ethertype == ETHERNET_TYPE_IP6)
1282         {
1283           l3_next->input_next_ip6 = next_index;
1284         }
1285       else if (ethertype == ETHERNET_TYPE_MPLS)
1286         {
1287           l3_next->input_next_mpls = next_index;
1288         }
1289     }
1290   return 0;
1291 }
1292
1293
1294 static clib_error_t *
1295 ethernet_input_init (vlib_main_t * vm)
1296 {
1297   ethernet_main_t *em = &ethernet_main;
1298   __attribute__ ((unused)) vlan_table_t *invalid_vlan_table;
1299   __attribute__ ((unused)) qinq_table_t *invalid_qinq_table;
1300
1301   ethernet_setup_node (vm, ethernet_input_node.index);
1302   ethernet_setup_node (vm, ethernet_input_type_node.index);
1303   ethernet_setup_node (vm, ethernet_input_not_l2_node.index);
1304
1305   next_by_ethertype_init (&em->l3_next);
1306
1307   // Initialize pools and vector for vlan parsing
1308   vec_validate (em->main_intfs, 10);    // 10 main interfaces
1309   pool_alloc (em->vlan_pool, 10);
1310   pool_alloc (em->qinq_pool, 1);
1311
1312   // The first vlan pool will always be reserved for an invalid table
1313   pool_get (em->vlan_pool, invalid_vlan_table); // first id = 0
1314   // The first qinq pool will always be reserved for an invalid table
1315   pool_get (em->qinq_pool, invalid_qinq_table); // first id = 0
1316
1317   return 0;
1318 }
1319
1320 VLIB_INIT_FUNCTION (ethernet_input_init);
1321
1322 void
1323 ethernet_register_input_type (vlib_main_t * vm,
1324                               ethernet_type_t type, u32 node_index)
1325 {
1326   ethernet_main_t *em = &ethernet_main;
1327   ethernet_type_info_t *ti;
1328   u32 i;
1329
1330   {
1331     clib_error_t *error = vlib_call_init_function (vm, ethernet_init);
1332     if (error)
1333       clib_error_report (error);
1334   }
1335
1336   ti = ethernet_get_type_info (em, type);
1337   ti->node_index = node_index;
1338   ti->next_index = vlib_node_add_next (vm,
1339                                        ethernet_input_node.index, node_index);
1340   i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1341   ASSERT (i == ti->next_index);
1342
1343   i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1344   ASSERT (i == ti->next_index);
1345
1346   // Add the L3 node for this ethertype to the next nodes structure
1347   next_by_ethertype_register (&em->l3_next, type, ti->next_index);
1348
1349   // Call the registration functions for other nodes that want a mapping
1350   l2bvi_register_input_type (vm, type, node_index);
1351 }
1352
1353 void
1354 ethernet_register_l2_input (vlib_main_t * vm, u32 node_index)
1355 {
1356   ethernet_main_t *em = &ethernet_main;
1357   u32 i;
1358
1359   em->l2_next =
1360     vlib_node_add_next (vm, ethernet_input_node.index, node_index);
1361
1362   /*
1363    * Even if we never use these arcs, we have to align the next indices...
1364    */
1365   i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1366
1367   ASSERT (i == em->l2_next);
1368
1369   i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1370   ASSERT (i == em->l2_next);
1371 }
1372
1373 // Register a next node for L3 redirect, and enable L3 redirect
1374 void
1375 ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index)
1376 {
1377   ethernet_main_t *em = &ethernet_main;
1378   u32 i;
1379
1380   em->redirect_l3 = 1;
1381   em->redirect_l3_next = vlib_node_add_next (vm,
1382                                              ethernet_input_node.index,
1383                                              node_index);
1384   /*
1385    * Change the cached next nodes to the redirect node
1386    */
1387   em->l3_next.input_next_ip4 = em->redirect_l3_next;
1388   em->l3_next.input_next_ip6 = em->redirect_l3_next;
1389   em->l3_next.input_next_mpls = em->redirect_l3_next;
1390
1391   /*
1392    * Even if we never use these arcs, we have to align the next indices...
1393    */
1394   i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1395
1396   ASSERT (i == em->redirect_l3_next);
1397
1398   i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1399
1400   ASSERT (i == em->redirect_l3_next);
1401 }
1402
1403 /*
1404  * fd.io coding-style-patch-verification: ON
1405  *
1406  * Local Variables:
1407  * eval: (c-set-style "gnu")
1408  * End:
1409  */