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