vnet/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
 146       *type = clib_net_to_host_u16 (h0->type);
 147
 148       vlib_buffer_advance (b0, sizeof (h0[0]));
 149       vlan_count = 1;
 150
 151       if (*type == ETHERNET_TYPE_VLAN)
 152         {
 153           // Double tagged packet
 154           *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_2_TAG;
 155
 156           h0 = (void *) (b0->data + b0->current_data);
 157
 158           tag = clib_net_to_host_u16 (h0->priority_cfi_and_id);
 159
 160           *inner_id = tag & 0xfff;
 161
 162           *type = clib_net_to_host_u16 (h0->type);
 163
 164           vlib_buffer_advance (b0, sizeof (h0[0]));
 165           vlan_count = 2;
 166
 167           if (*type == ETHERNET_TYPE_VLAN)
 168             {
 169               // More than double tagged packet
 170               *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_3_TAG;
 171               vlan_count = 3;   // "unknown" number, aka, 3-or-more
 172             }
 173         }
 174     }
 175   ethernet_buffer_set_vlan_count (b0, vlan_count);
 176 }
 177
 178 // Determine the subinterface for this packet, given the result of the
 179 // vlan table lookups and vlan header parsing. Check the most specific
 180 // matches first.
 181 static_always_inline void
 182 identify_subint (vnet_hw_interface_t * hi,
 183                  vlib_buffer_t * b0,
 184                  u32 match_flags,
 185                  main_intf_t * main_intf,
 186                  vlan_intf_t * vlan_intf,
 187                  qinq_intf_t * qinq_intf,
 188                  u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
 189 {
 190   u32 matched;
 191
 192   matched = eth_identify_subint (hi, b0, match_flags,
 193                                  main_intf, vlan_intf, qinq_intf,
 194                                  new_sw_if_index, error0, is_l2);
 195
 196   if (matched)
 197     {
 198
 199       // Perform L3 my-mac filter
 200       // A unicast packet arriving on an L3 interface must have a dmac matching the interface mac.
 201       // This is required for promiscuous mode, else we will forward packets we aren't supposed to.
 202       if (!(*is_l2))
 203         {
 204           ethernet_header_t *e0;
 205           e0 =
 206             (void *) (b0->data +
 207                       vnet_buffer (b0)->ethernet.start_of_ethernet_header);
 208
 209           if (!(ethernet_address_cast (e0->dst_address)))
 210             {
 211               if (!eth_mac_equal ((u8 *) e0, hi->hw_address))
 212                 {
 213                   *error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
 214                 }
 215             }
 216         }
 217
 218       // Check for down subinterface
 219       *error0 = (*new_sw_if_index) != ~0 ? (*error0) : ETHERNET_ERROR_DOWN;
 220     }
 221 }
 222
 223 static_always_inline void
 224 determine_next_node (ethernet_main_t * em,
 225                      ethernet_input_variant_t variant,
 226                      u32 is_l20,
 227                      u32 type0, vlib_buffer_t * b0, u8 * error0, u8 * next0)
 228 {
 229   if (PREDICT_FALSE (*error0 != ETHERNET_ERROR_NONE))
 230     {
 231       // some error occurred
 232       *next0 = ETHERNET_INPUT_NEXT_DROP;
 233     }
 234   else if (is_l20)
 235     {
 236       *next0 = em->l2_next;
 237       // record the L2 len and reset the buffer so the L2 header is preserved
 238       u32 eth_start = vnet_buffer (b0)->ethernet.start_of_ethernet_header;
 239       vnet_buffer (b0)->l2.l2_len = b0->current_data - eth_start;
 240       vlib_buffer_advance (b0, -ethernet_buffer_header_size (b0));
 241
 242       // check for common IP/MPLS ethertypes
 243     }
 244   else if (type0 == ETHERNET_TYPE_IP4)
 245     {
 246       *next0 = em->l3_next.input_next_ip4;
 247     }
 248   else if (type0 == ETHERNET_TYPE_IP6)
 249     {
 250       *next0 = em->l3_next.input_next_ip6;
 251     }
 252   else if (type0 == ETHERNET_TYPE_MPLS_UNICAST)
 253     {
 254       *next0 = em->l3_next.input_next_mpls;
 255
 256     }
 257   else if (em->redirect_l3)
 258     {
 259       // L3 Redirect is on, the cached common next nodes will be
 260       // pointing to the redirect node, catch the uncommon types here
 261       *next0 = em->redirect_l3_next;
 262     }
 263   else
 264     {
 265       // uncommon ethertype, check table
 266       u32 i0;
 267       i0 = sparse_vec_index (em->l3_next.input_next_by_type, type0);
 268       *next0 = vec_elt (em->l3_next.input_next_by_type, i0);
 269       *error0 =
 270         i0 ==
 271         SPARSE_VEC_INVALID_INDEX ? ETHERNET_ERROR_UNKNOWN_TYPE : *error0;
 272
 273       // The table is not populated with LLC values, so check that now.
 274       // If variant is variant_ethernet then we came from LLC processing. Don't
 275       // go back there; drop instead using by keeping the drop/bad table result.
 276       if ((type0 < 0x600) && (variant == ETHERNET_INPUT_VARIANT_ETHERNET))
 277         {
 278           *next0 = ETHERNET_INPUT_NEXT_LLC;
 279         }
 280     }
 281 }
 282
 283 static_always_inline uword
 284 ethernet_input_inline (vlib_main_t * vm,
 285                        vlib_node_runtime_t * node,
 286                        vlib_frame_t * from_frame,
 287                        ethernet_input_variant_t variant)
 288 {
 289   vnet_main_t *vnm = vnet_get_main ();
 290   ethernet_main_t *em = &ethernet_main;
 291   vlib_node_runtime_t *error_node;
 292   u32 n_left_from, next_index, *from, *to_next;
 293   u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
 294   u32 cpu_index = os_get_cpu_number ();
 295
 296   if (variant != ETHERNET_INPUT_VARIANT_ETHERNET)
 297     error_node = vlib_node_get_runtime (vm, ethernet_input_node.index);
 298   else
 299     error_node = node;
 300
 301   from = vlib_frame_vector_args (from_frame);
 302   n_left_from = from_frame->n_vectors;
 303
 304   if (node->flags & VLIB_NODE_FLAG_TRACE)
 305     vlib_trace_frame_buffers_only (vm, node,
 306                                    from,
 307                                    n_left_from,
 308                                    sizeof (from[0]),
 309                                    sizeof (ethernet_input_trace_t));
 310
 311   next_index = node->cached_next_index;
 312   stats_sw_if_index = node->runtime_data[0];
 313   stats_n_packets = stats_n_bytes = 0;
 314
 315   while (n_left_from > 0)
 316     {
 317       u32 n_left_to_next;
 318
 319       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 320
 321       while (n_left_from >= 4 && n_left_to_next >= 2)
 322         {
 323           u32 bi0, bi1;
 324           vlib_buffer_t *b0, *b1;
 325           u8 next0, next1, error0, error1;
 326           u16 type0, orig_type0, type1, orig_type1;
 327           u16 outer_id0, inner_id0, outer_id1, inner_id1;
 328           u32 match_flags0, match_flags1;
 329           u32 old_sw_if_index0, new_sw_if_index0, len0, old_sw_if_index1,
 330             new_sw_if_index1, len1;
 331           vnet_hw_interface_t *hi0, *hi1;
 332           main_intf_t *main_intf0, *main_intf1;
 333           vlan_intf_t *vlan_intf0, *vlan_intf1;
 334           qinq_intf_t *qinq_intf0, *qinq_intf1;
 335           u32 is_l20, is_l21;
 336
 337           /* Prefetch next iteration. */
 338           {
 339             vlib_buffer_t *b2, *b3;
 340
 341             b2 = vlib_get_buffer (vm, from[2]);
 342             b3 = vlib_get_buffer (vm, from[3]);
 343
 344             vlib_prefetch_buffer_header (b2, STORE);
 345             vlib_prefetch_buffer_header (b3, STORE);
 346
 347             CLIB_PREFETCH (b2->data, sizeof (ethernet_header_t), LOAD);
 348             CLIB_PREFETCH (b3->data, sizeof (ethernet_header_t), LOAD);
 349           }
 350
 351           bi0 = from[0];
 352           bi1 = from[1];
 353           to_next[0] = bi0;
 354           to_next[1] = bi1;
 355           from += 2;
 356           to_next += 2;
 357           n_left_to_next -= 2;
 358           n_left_from -= 2;
 359
 360           b0 = vlib_get_buffer (vm, bi0);
 361           b1 = vlib_get_buffer (vm, bi1);
 362
 363           error0 = error1 = ETHERNET_ERROR_NONE;
 364
 365           parse_header (variant,
 366                         b0,
 367                         &type0,
 368                         &orig_type0, &outer_id0, &inner_id0, &match_flags0);
 369
 370           parse_header (variant,
 371                         b1,
 372                         &type1,
 373                         &orig_type1, &outer_id1, &inner_id1, &match_flags1);
 374
 375           old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 376           old_sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
 377
 378           eth_vlan_table_lookups (em,
 379                                   vnm,
 380                                   old_sw_if_index0,
 381                                   orig_type0,
 382                                   outer_id0,
 383                                   inner_id0,
 384                                   &hi0,
 385                                   &main_intf0, &vlan_intf0, &qinq_intf0);
 386
 387           eth_vlan_table_lookups (em,
 388                                   vnm,
 389                                   old_sw_if_index1,
 390                                   orig_type1,
 391                                   outer_id1,
 392                                   inner_id1,
 393                                   &hi1,
 394                                   &main_intf1, &vlan_intf1, &qinq_intf1);
 395
 396           identify_subint (hi0,
 397                            b0,
 398                            match_flags0,
 399                            main_intf0,
 400                            vlan_intf0,
 401                            qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
 402
 403           identify_subint (hi1,
 404                            b1,
 405                            match_flags1,
 406                            main_intf1,
 407                            vlan_intf1,
 408                            qinq_intf1, &new_sw_if_index1, &error1, &is_l21);
 409
 410           // Save RX sw_if_index for later nodes
 411           vnet_buffer (b0)->sw_if_index[VLIB_RX] =
 412             error0 !=
 413             ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
 414           vnet_buffer (b1)->sw_if_index[VLIB_RX] =
 415             error1 !=
 416             ETHERNET_ERROR_NONE ? old_sw_if_index1 : new_sw_if_index1;
 417
 418           // Check if there is a stat to take (valid and non-main sw_if_index for pkt 0 or pkt 1)
 419           if (((new_sw_if_index0 != ~0)
 420                && (new_sw_if_index0 != old_sw_if_index0))
 421               || ((new_sw_if_index1 != ~0)
 422                   && (new_sw_if_index1 != old_sw_if_index1)))
 423             {
 424
 425               len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
 426                 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
 427               len1 = vlib_buffer_length_in_chain (vm, b1) + b1->current_data
 428                 - vnet_buffer (b1)->ethernet.start_of_ethernet_header;
 429
 430               stats_n_packets += 2;
 431               stats_n_bytes += len0 + len1;
 432
 433               if (PREDICT_FALSE
 434                   (!(new_sw_if_index0 == stats_sw_if_index
 435                      && new_sw_if_index1 == stats_sw_if_index)))
 436                 {
 437                   stats_n_packets -= 2;
 438                   stats_n_bytes -= len0 + len1;
 439
 440                   if (new_sw_if_index0 != old_sw_if_index0
 441                       && new_sw_if_index0 != ~0)
 442                     vlib_increment_combined_counter (vnm->
 443                                                      interface_main.combined_sw_if_counters
 444                                                      +
 445                                                      VNET_INTERFACE_COUNTER_RX,
 446                                                      cpu_index,
 447                                                      new_sw_if_index0, 1,
 448                                                      len0);
 449                   if (new_sw_if_index1 != old_sw_if_index1
 450                       && new_sw_if_index1 != ~0)
 451                     vlib_increment_combined_counter (vnm->
 452                                                      interface_main.combined_sw_if_counters
 453                                                      +
 454                                                      VNET_INTERFACE_COUNTER_RX,
 455                                                      cpu_index,
 456                                                      new_sw_if_index1, 1,
 457                                                      len1);
 458
 459                   if (new_sw_if_index0 == new_sw_if_index1)
 460                     {
 461                       if (stats_n_packets > 0)
 462                         {
 463                           vlib_increment_combined_counter
 464                             (vnm->interface_main.combined_sw_if_counters
 465                              + VNET_INTERFACE_COUNTER_RX,
 466                              cpu_index,
 467                              stats_sw_if_index,
 468                              stats_n_packets, stats_n_bytes);
 469                           stats_n_packets = stats_n_bytes = 0;
 470                         }
 471                       stats_sw_if_index = new_sw_if_index0;
 472                     }
 473                 }
 474             }
 475
 476           if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
 477             is_l20 = is_l21 = 0;
 478
 479           determine_next_node (em, variant, is_l20, type0, b0, &error0,
 480                                &next0);
 481           determine_next_node (em, variant, is_l21, type1, b1, &error1,
 482                                &next1);
 483
 484           b0->error = error_node->errors[error0];
 485           b1->error = error_node->errors[error1];
 486
 487           // verify speculative enqueue
 488           vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
 489                                            n_left_to_next, bi0, bi1, next0,
 490                                            next1);
 491         }
 492
 493       while (n_left_from > 0 && n_left_to_next > 0)
 494         {
 495           u32 bi0;
 496           vlib_buffer_t *b0;
 497           u8 error0, next0;
 498           u16 type0, orig_type0;
 499           u16 outer_id0, inner_id0;
 500           u32 match_flags0;
 501           u32 old_sw_if_index0, new_sw_if_index0, len0;
 502           vnet_hw_interface_t *hi0;
 503           main_intf_t *main_intf0;
 504           vlan_intf_t *vlan_intf0;
 505           qinq_intf_t *qinq_intf0;
 506           u32 is_l20;
 507
 508           // Prefetch next iteration
 509           if (n_left_from > 1)
 510             {
 511               vlib_buffer_t *p2;
 512
 513               p2 = vlib_get_buffer (vm, from[1]);
 514               vlib_prefetch_buffer_header (p2, STORE);
 515               CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, LOAD);
 516             }
 517
 518           bi0 = from[0];
 519           to_next[0] = bi0;
 520           from += 1;
 521           to_next += 1;
 522           n_left_from -= 1;
 523           n_left_to_next -= 1;
 524
 525           b0 = vlib_get_buffer (vm, bi0);
 526
 527           error0 = ETHERNET_ERROR_NONE;
 528
 529           parse_header (variant,
 530                         b0,
 531                         &type0,
 532                         &orig_type0, &outer_id0, &inner_id0, &match_flags0);
 533
 534           old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 535
 536           eth_vlan_table_lookups (em,
 537                                   vnm,
 538                                   old_sw_if_index0,
 539                                   orig_type0,
 540                                   outer_id0,
 541                                   inner_id0,
 542                                   &hi0,
 543                                   &main_intf0, &vlan_intf0, &qinq_intf0);
 544
 545           identify_subint (hi0,
 546                            b0,
 547                            match_flags0,
 548                            main_intf0,
 549                            vlan_intf0,
 550                            qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
 551
 552           // Save RX sw_if_index for later nodes
 553           vnet_buffer (b0)->sw_if_index[VLIB_RX] =
 554             error0 !=
 555             ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
 556
 557           // Increment subinterface stats
 558           // Note that interface-level counters have already been incremented
 559           // prior to calling this function. Thus only subinterface counters
 560           // are incremented here.
 561           //
 562           // Interface level counters include packets received on the main
 563           // interface and all subinterfaces. Subinterface level counters
 564           // include only those packets received on that subinterface
 565           // Increment stats if the subint is valid and it is not the main intf
 566           if ((new_sw_if_index0 != ~0)
 567               && (new_sw_if_index0 != old_sw_if_index0))
 568             {
 569
 570               len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
 571                 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
 572
 573               stats_n_packets += 1;
 574               stats_n_bytes += len0;
 575
 576               // Batch stat increments from the same subinterface so counters
 577               // don't need to be incremented for every packet.
 578               if (PREDICT_FALSE (new_sw_if_index0 != stats_sw_if_index))
 579                 {
 580                   stats_n_packets -= 1;
 581                   stats_n_bytes -= len0;
 582
 583                   if (new_sw_if_index0 != ~0)
 584                     vlib_increment_combined_counter
 585                       (vnm->interface_main.combined_sw_if_counters
 586                        + VNET_INTERFACE_COUNTER_RX,
 587                        cpu_index, new_sw_if_index0, 1, len0);
 588                   if (stats_n_packets > 0)
 589                     {
 590                       vlib_increment_combined_counter
 591                         (vnm->interface_main.combined_sw_if_counters
 592                          + VNET_INTERFACE_COUNTER_RX,
 593                          cpu_index,
 594                          stats_sw_if_index, stats_n_packets, stats_n_bytes);
 595                       stats_n_packets = stats_n_bytes = 0;
 596                     }
 597                   stats_sw_if_index = new_sw_if_index0;
 598                 }
 599             }
 600
 601           if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
 602             is_l20 = 0;
 603
 604           determine_next_node (em, variant, is_l20, type0, b0, &error0,
 605                                &next0);
 606
 607           b0->error = error_node->errors[error0];
 608
 609           // verify speculative enqueue
 610           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 611                                            to_next, n_left_to_next,
 612                                            bi0, next0);
 613         }
 614
 615       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 616     }
 617
 618   // Increment any remaining batched stats
 619   if (stats_n_packets > 0)
 620     {
 621       vlib_increment_combined_counter
 622         (vnm->interface_main.combined_sw_if_counters
 623          + VNET_INTERFACE_COUNTER_RX,
 624          cpu_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
 625       node->runtime_data[0] = stats_sw_if_index;
 626     }
 627
 628   return from_frame->n_vectors;
 629 }
 630
 631 static uword
 632 ethernet_input (vlib_main_t * vm,
 633                 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
 634 {
 635   return ethernet_input_inline (vm, node, from_frame,
 636                                 ETHERNET_INPUT_VARIANT_ETHERNET);
 637 }
 638
 639 static uword
 640 ethernet_input_type (vlib_main_t * vm,
 641                      vlib_node_runtime_t * node, vlib_frame_t * from_frame)
 642 {
 643   return ethernet_input_inline (vm, node, from_frame,
 644                                 ETHERNET_INPUT_VARIANT_ETHERNET_TYPE);
 645 }
 646
 647 static uword
 648 ethernet_input_not_l2 (vlib_main_t * vm,
 649                        vlib_node_runtime_t * node, vlib_frame_t * from_frame)
 650 {
 651   return ethernet_input_inline (vm, node, from_frame,
 652                                 ETHERNET_INPUT_VARIANT_NOT_L2);
 653 }
 654
 655
 656 // Return the subinterface config struct for the given sw_if_index
 657 // Also return via parameter the appropriate match flags for the
 658 // configured number of tags.
 659 // On error (unsupported or not ethernet) return 0.
 660 static subint_config_t *
 661 ethernet_sw_interface_get_config (vnet_main_t * vnm,
 662                                   u32 sw_if_index,
 663                                   u32 * flags, u32 * unsupported)
 664 {
 665   ethernet_main_t *em = &ethernet_main;
 666   vnet_hw_interface_t *hi;
 667   vnet_sw_interface_t *si;
 668   main_intf_t *main_intf;
 669   vlan_table_t *vlan_table;
 670   qinq_table_t *qinq_table;
 671   subint_config_t *subint = 0;
 672
 673   hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
 674
 675   if (!hi || (hi->hw_class_index != ethernet_hw_interface_class.index))
 676     {
 677       *unsupported = 0;
 678       goto done;                // non-ethernet interface
 679     }
 680
 681   // ensure there's an entry for the main intf (shouldn't really be necessary)
 682   vec_validate (em->main_intfs, hi->hw_if_index);
 683   main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
 684
 685   // Locate the subint for the given ethernet config
 686   si = vnet_get_sw_interface (vnm, sw_if_index);
 687
 688   if (si->sub.eth.flags.default_sub)
 689     {
 690       subint = &main_intf->default_subint;
 691       *flags = SUBINT_CONFIG_MATCH_0_TAG |
 692         SUBINT_CONFIG_MATCH_1_TAG |
 693         SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
 694     }
 695   else if ((si->sub.eth.flags.no_tags) || (si->sub.eth.raw_flags == 0))
 696     {
 697       // if no flags are set then this is a main interface
 698       // so treat as untagged
 699       subint = &main_intf->untagged_subint;
 700       *flags = SUBINT_CONFIG_MATCH_0_TAG;
 701     }
 702   else
 703     {
 704       // one or two tags
 705       // first get the vlan table
 706       if (si->sub.eth.flags.dot1ad)
 707         {
 708           if (main_intf->dot1ad_vlans == 0)
 709             {
 710               // Allocate a vlan table from the pool
 711               pool_get (em->vlan_pool, vlan_table);
 712               main_intf->dot1ad_vlans = vlan_table - em->vlan_pool;
 713             }
 714           else
 715             {
 716               // Get ptr to existing vlan table
 717               vlan_table =
 718                 vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
 719             }
 720         }
 721       else
 722         {                       // dot1q
 723           if (main_intf->dot1q_vlans == 0)
 724             {
 725               // Allocate a vlan table from the pool
 726               pool_get (em->vlan_pool, vlan_table);
 727               main_intf->dot1q_vlans = vlan_table - em->vlan_pool;
 728             }
 729           else
 730             {
 731               // Get ptr to existing vlan table
 732               vlan_table =
 733                 vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
 734             }
 735         }
 736
 737       if (si->sub.eth.flags.one_tag)
 738         {
 739           *flags = si->sub.eth.flags.exact_match ?
 740             SUBINT_CONFIG_MATCH_1_TAG :
 741             (SUBINT_CONFIG_MATCH_1_TAG |
 742              SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
 743
 744           if (si->sub.eth.flags.outer_vlan_id_any)
 745             {
 746               // not implemented yet
 747               *unsupported = 1;
 748               goto done;
 749             }
 750           else
 751             {
 752               // a single vlan, a common case
 753               subint =
 754                 &vlan_table->vlans[si->sub.eth.
 755                                    outer_vlan_id].single_tag_subint;
 756             }
 757
 758         }
 759       else
 760         {
 761           // Two tags
 762           *flags = si->sub.eth.flags.exact_match ?
 763             SUBINT_CONFIG_MATCH_2_TAG :
 764             (SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
 765
 766           if (si->sub.eth.flags.outer_vlan_id_any
 767               && si->sub.eth.flags.inner_vlan_id_any)
 768             {
 769               // not implemented yet
 770               *unsupported = 1;
 771               goto done;
 772             }
 773
 774           if (si->sub.eth.flags.inner_vlan_id_any)
 775             {
 776               // a specific outer and "any" inner
 777               // don't need a qinq table for this
 778               subint =
 779                 &vlan_table->vlans[si->sub.eth.
 780                                    outer_vlan_id].inner_any_subint;
 781               if (si->sub.eth.flags.exact_match)
 782                 {
 783                   *flags = SUBINT_CONFIG_MATCH_2_TAG;
 784                 }
 785               else
 786                 {
 787                   *flags = SUBINT_CONFIG_MATCH_2_TAG |
 788                     SUBINT_CONFIG_MATCH_3_TAG;
 789                 }
 790             }
 791           else
 792             {
 793               // a specific outer + specifc innner vlan id, a common case
 794
 795               // get the qinq table
 796               if (vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs == 0)
 797                 {
 798                   // Allocate a qinq table from the pool
 799                   pool_get (em->qinq_pool, qinq_table);
 800                   vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs =
 801                     qinq_table - em->qinq_pool;
 802                 }
 803               else
 804                 {
 805                   // Get ptr to existing qinq table
 806                   qinq_table =
 807                     vec_elt_at_index (em->qinq_pool,
 808                                       vlan_table->vlans[si->sub.
 809                                                         eth.outer_vlan_id].
 810                                       qinqs);
 811                 }
 812               subint = &qinq_table->vlans[si->sub.eth.inner_vlan_id].subint;
 813             }
 814         }
 815     }
 816
 817 done:
 818   return subint;
 819 }
 820
 821 clib_error_t *
 822 ethernet_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
 823 {
 824   subint_config_t *subint;
 825   u32 dummy_flags;
 826   u32 dummy_unsup;
 827   clib_error_t *error = 0;
 828
 829   // Find the config for this subinterface
 830   subint =
 831     ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
 832                                       &dummy_unsup);
 833
 834   if (subint == 0)
 835     {
 836       // not implemented yet or not ethernet
 837       goto done;
 838     }
 839
 840   subint->sw_if_index =
 841     ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? sw_if_index : ~0);
 842
 843 done:
 844   return error;
 845 }
 846
 847 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_sw_interface_up_down);
 848
 849
 850 // Set the L2/L3 mode for the subinterface
 851 void
 852 ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index, u32 l2)
 853 {
 854   subint_config_t *subint;
 855   u32 dummy_flags;
 856   u32 dummy_unsup;
 857   int is_port;
 858   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
 859
 860   is_port = !(sw->type == VNET_SW_INTERFACE_TYPE_SUB);
 861
 862   // Find the config for this subinterface
 863   subint =
 864     ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
 865                                       &dummy_unsup);
 866
 867   if (subint == 0)
 868     {
 869       // unimplemented or not ethernet
 870       goto done;
 871     }
 872
 873   // Double check that the config we found is for our interface (or the interface is down)
 874   ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
 875
 876   if (l2)
 877     {
 878       subint->flags |= SUBINT_CONFIG_L2;
 879       if (is_port)
 880         subint->flags |=
 881           SUBINT_CONFIG_MATCH_0_TAG | SUBINT_CONFIG_MATCH_1_TAG
 882           | SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
 883     }
 884   else
 885     {
 886       subint->flags &= ~SUBINT_CONFIG_L2;
 887       if (is_port)
 888         subint->flags &=
 889           ~(SUBINT_CONFIG_MATCH_1_TAG | SUBINT_CONFIG_MATCH_2_TAG
 890             | SUBINT_CONFIG_MATCH_3_TAG);
 891     }
 892
 893 done:
 894   return;
 895 }
 896
 897 /*
 898  * Set the L2/L3 mode for the subinterface regardless of port
 899  */
 900 void
 901 ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
 902                                           u32 sw_if_index, u32 l2)
 903 {
 904   subint_config_t *subint;
 905   u32 dummy_flags;
 906   u32 dummy_unsup;
 907
 908   /* Find the config for this subinterface */
 909   subint =
 910     ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
 911                                       &dummy_unsup);
 912
 913   if (subint == 0)
 914     {
 915       /* unimplemented or not ethernet */
 916       goto done;
 917     }
 918
 919   /*
 920    * Double check that the config we found is for our interface (or the
 921    * interface is down)
 922    */
 923   ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
 924
 925   if (l2)
 926     {
 927       subint->flags |= SUBINT_CONFIG_L2;
 928     }
 929   else
 930     {
 931       subint->flags &= ~SUBINT_CONFIG_L2;
 932     }
 933
 934 done:
 935   return;
 936 }
 937
 938 static clib_error_t *
 939 ethernet_sw_interface_add_del (vnet_main_t * vnm,
 940                                u32 sw_if_index, u32 is_create)
 941 {
 942   clib_error_t *error = 0;
 943   subint_config_t *subint;
 944   u32 match_flags;
 945   u32 unsupported = 0;
 946
 947   // Find the config for this subinterface
 948   subint =
 949     ethernet_sw_interface_get_config (vnm, sw_if_index, &match_flags,
 950                                       &unsupported);
 951
 952   if (subint == 0)
 953     {
 954       // not implemented yet or not ethernet
 955       if (unsupported)
 956         {
 957           // this is the NYI case
 958           error = clib_error_return (0, "not implemented yet");
 959         }
 960       goto done;
 961     }
 962
 963   if (!is_create)
 964     {
 965       subint->flags = 0;
 966       return error;
 967     }
 968
 969   // Initialize the subint
 970   if (subint->flags & SUBINT_CONFIG_VALID)
 971     {
 972       // Error vlan already in use
 973       error = clib_error_return (0, "vlan is already in use");
 974     }
 975   else
 976     {
 977       // Note that config is L3 by defaulty
 978       subint->flags = SUBINT_CONFIG_VALID | match_flags;
 979       subint->sw_if_index = ~0; // because interfaces are initially down
 980     }
 981
 982 done:
 983   return error;
 984 }
 985
 986 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ethernet_sw_interface_add_del);
 987
 988 static char *ethernet_error_strings[] = {
 989 #define ethernet_error(n,c,s) s,
 990 #include "error.def"
 991 #undef ethernet_error
 992 };
 993
 994 /* *INDENT-OFF* */
 995 VLIB_REGISTER_NODE (ethernet_input_node) = {
 996   .function = ethernet_input,
 997   .name = "ethernet-input",
 998   /* Takes a vector of packets. */
 999   .vector_size = sizeof (u32),
1000   .n_errors = ETHERNET_N_ERROR,
1001   .error_strings = ethernet_error_strings,
1002   .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1003   .next_nodes = {
1004 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1005     foreach_ethernet_input_next
1006 #undef _
1007   },
1008   .format_buffer = format_ethernet_header_with_length,
1009   .format_trace = format_ethernet_input_trace,
1010   .unformat_buffer = unformat_ethernet_header,
1011 };
1012 /* *INDENT-ON* */
1013
1014 /* *INDENT-OFF* */
1015 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_node, ethernet_input)
1016 /* *INDENT-ON* */
1017
1018 /* *INDENT-OFF* */
1019 VLIB_REGISTER_NODE (ethernet_input_type_node, static) = {
1020   .function = ethernet_input_type,
1021   .name = "ethernet-input-type",
1022   /* Takes a vector of packets. */
1023   .vector_size = sizeof (u32),
1024   .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1025   .next_nodes = {
1026 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1027     foreach_ethernet_input_next
1028 #undef _
1029   },
1030 };
1031 /* *INDENT-ON* */
1032
1033 /* *INDENT-OFF* */
1034 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_type_node, ethernet_input_type)
1035 /* *INDENT-ON* */
1036
1037 /* *INDENT-OFF* */
1038 VLIB_REGISTER_NODE (ethernet_input_not_l2_node, static) = {
1039   .function = ethernet_input_not_l2,
1040   .name = "ethernet-input-not-l2",
1041   /* Takes a vector of packets. */
1042   .vector_size = sizeof (u32),
1043   .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1044   .next_nodes = {
1045 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1046     foreach_ethernet_input_next
1047 #undef _
1048   },
1049 };
1050 /* *INDENT-ON* */
1051
1052
1053 /* *INDENT-OFF* */
1054 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_not_l2_node,
1055                               ethernet_input_not_l2)
1056 /* *INDENT-ON* */
1057
1058
1059 void
1060 ethernet_set_rx_redirect (vnet_main_t * vnm,
1061                           vnet_hw_interface_t * hi, u32 enable)
1062 {
1063   // Insure all packets go to ethernet-input (i.e. untagged ipv4 packets
1064   // don't go directly to ip4-input)
1065   vnet_hw_interface_rx_redirect_to_node
1066     (vnm, hi->hw_if_index, enable ? ethernet_input_node.index : ~0);
1067 }
1068
1069
1070 /*
1071  * Initialization and registration for the next_by_ethernet structure
1072  */
1073
1074 clib_error_t *
1075 next_by_ethertype_init (next_by_ethertype_t * l3_next)
1076 {
1077   l3_next->input_next_by_type = sparse_vec_new
1078     ( /* elt bytes */ sizeof (l3_next->input_next_by_type[0]),
1079      /* bits in index */ BITS (((ethernet_header_t *) 0)->type));
1080
1081   vec_validate (l3_next->sparse_index_by_input_next_index,
1082                 ETHERNET_INPUT_NEXT_DROP);
1083   vec_validate (l3_next->sparse_index_by_input_next_index,
1084                 ETHERNET_INPUT_NEXT_PUNT);
1085   l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_DROP] =
1086     SPARSE_VEC_INVALID_INDEX;
1087   l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_PUNT] =
1088     SPARSE_VEC_INVALID_INDEX;
1089
1090   /*
1091    * Make sure we don't wipe out an ethernet registration by mistake
1092    * Can happen if init function ordering constraints are missing.
1093    */
1094   if (CLIB_DEBUG > 0)
1095     {
1096       ethernet_main_t *em = &ethernet_main;
1097       ASSERT (em->next_by_ethertype_register_called == 0);
1098     }
1099
1100   return 0;
1101 }
1102
1103 // Add an ethertype -> next index mapping to the structure
1104 clib_error_t *
1105 next_by_ethertype_register (next_by_ethertype_t * l3_next,
1106                             u32 ethertype, u32 next_index)
1107 {
1108   u32 i;
1109   u16 *n;
1110   ethernet_main_t *em = &ethernet_main;
1111
1112   if (CLIB_DEBUG > 0)
1113     {
1114       ethernet_main_t *em = &ethernet_main;
1115       em->next_by_ethertype_register_called = 1;
1116     }
1117
1118   /* Setup ethernet type -> next index sparse vector mapping. */
1119   n = sparse_vec_validate (l3_next->input_next_by_type, ethertype);
1120   n[0] = next_index;
1121
1122   /* Rebuild next index -> sparse index inverse mapping when sparse vector
1123      is updated. */
1124   vec_validate (l3_next->sparse_index_by_input_next_index, next_index);
1125   for (i = 1; i < vec_len (l3_next->input_next_by_type); i++)
1126     l3_next->
1127       sparse_index_by_input_next_index[l3_next->input_next_by_type[i]] = i;
1128
1129   // do not allow the cached next index's to be updated if L3
1130   // redirect is enabled, as it will have overwritten them
1131   if (!em->redirect_l3)
1132     {
1133       // Cache common ethertypes directly
1134       if (ethertype == ETHERNET_TYPE_IP4)
1135         {
1136           l3_next->input_next_ip4 = next_index;
1137         }
1138       else if (ethertype == ETHERNET_TYPE_IP6)
1139         {
1140           l3_next->input_next_ip6 = next_index;
1141         }
1142       else if (ethertype == ETHERNET_TYPE_MPLS_UNICAST)
1143         {
1144           l3_next->input_next_mpls = next_index;
1145         }
1146     }
1147   return 0;
1148 }
1149
1150
1151 static clib_error_t *
1152 ethernet_input_init (vlib_main_t * vm)
1153 {
1154   ethernet_main_t *em = &ethernet_main;
1155   __attribute__ ((unused)) vlan_table_t *invalid_vlan_table;
1156   __attribute__ ((unused)) qinq_table_t *invalid_qinq_table;
1157
1158   ethernet_setup_node (vm, ethernet_input_node.index);
1159   ethernet_setup_node (vm, ethernet_input_type_node.index);
1160   ethernet_setup_node (vm, ethernet_input_not_l2_node.index);
1161
1162   next_by_ethertype_init (&em->l3_next);
1163
1164   // Initialize pools and vector for vlan parsing
1165   vec_validate (em->main_intfs, 10);    // 10 main interfaces
1166   pool_alloc (em->vlan_pool, 10);
1167   pool_alloc (em->qinq_pool, 1);
1168
1169   // The first vlan pool will always be reserved for an invalid table
1170   pool_get (em->vlan_pool, invalid_vlan_table); // first id = 0
1171   // The first qinq pool will always be reserved for an invalid table
1172   pool_get (em->qinq_pool, invalid_qinq_table); // first id = 0
1173
1174   return 0;
1175 }
1176
1177 VLIB_INIT_FUNCTION (ethernet_input_init);
1178
1179 void
1180 ethernet_register_input_type (vlib_main_t * vm,
1181                               ethernet_type_t type, u32 node_index)
1182 {
1183   ethernet_main_t *em = &ethernet_main;
1184   ethernet_type_info_t *ti;
1185   u32 i;
1186
1187   {
1188     clib_error_t *error = vlib_call_init_function (vm, ethernet_init);
1189     if (error)
1190       clib_error_report (error);
1191   }
1192
1193   ti = ethernet_get_type_info (em, type);
1194   ti->node_index = node_index;
1195   ti->next_index = vlib_node_add_next (vm,
1196                                        ethernet_input_node.index, node_index);
1197   i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1198   ASSERT (i == ti->next_index);
1199
1200   i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1201   ASSERT (i == ti->next_index);
1202
1203   // Add the L3 node for this ethertype to the next nodes structure
1204   next_by_ethertype_register (&em->l3_next, type, ti->next_index);
1205
1206   // Call the registration functions for other nodes that want a mapping
1207   l2bvi_register_input_type (vm, type, node_index);
1208 }
1209
1210 void
1211 ethernet_register_l2_input (vlib_main_t * vm, u32 node_index)
1212 {
1213   ethernet_main_t *em = &ethernet_main;
1214   u32 i;
1215
1216   em->l2_next =
1217     vlib_node_add_next (vm, ethernet_input_node.index, node_index);
1218
1219   /*
1220    * Even if we never use these arcs, we have to align the next indices...
1221    */
1222   i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1223
1224   ASSERT (i == em->l2_next);
1225
1226   i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1227   ASSERT (i == em->l2_next);
1228 }
1229
1230 // Register a next node for L3 redirect, and enable L3 redirect
1231 void
1232 ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index)
1233 {
1234   ethernet_main_t *em = &ethernet_main;
1235   u32 i;
1236
1237   em->redirect_l3 = 1;
1238   em->redirect_l3_next = vlib_node_add_next (vm,
1239                                              ethernet_input_node.index,
1240                                              node_index);
1241   /*
1242    * Change the cached next nodes to the redirect node
1243    */
1244   em->l3_next.input_next_ip4 = em->redirect_l3_next;
1245   em->l3_next.input_next_ip6 = em->redirect_l3_next;
1246   em->l3_next.input_next_mpls = em->redirect_l3_next;
1247
1248   /*
1249    * Even if we never use these arcs, we have to align the next indices...
1250    */
1251   i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1252
1253   ASSERT (i == em->redirect_l3_next);
1254 }
1255
1256 /*
1257  * fd.io coding-style-patch-verification: ON
1258  *
1259  * Local Variables:
1260  * eval: (c-set-style "gnu")
1261  * End:
1262  */