src/vnet/l2/l2_fwd.c

   1 /*
   2  * l2_fwd.c : layer 2 forwarding using l2fib
   3  *
   4  * Copyright (c) 2013 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <vlib/vlib.h>
  19 #include <vnet/vnet.h>
  20 #include <vnet/pg/pg.h>
  21 #include <vnet/ethernet/ethernet.h>
  22 #include <vlib/cli.h>
  23
  24 #include <vnet/l2/l2_input.h>
  25 #include <vnet/l2/l2_bvi.h>
  26 #include <vnet/l2/l2_fwd.h>
  27 #include <vnet/l2/l2_fib.h>
  28 #include <vnet/l2/feat_bitmap.h>
  29
  30 #include <vppinfra/error.h>
  31 #include <vppinfra/hash.h>
  32 #include <vppinfra/sparse_vec.h>
  33
  34
  35 /**
  36  * @file
  37  * @brief Ethernet Forwarding.
  38  *
  39  * Code in this file handles forwarding Layer 2 packets. This file calls
  40  * the FIB lookup, packet learning and the packet flooding as necessary.
  41  * Packet is then sent to the next graph node.
  42  */
  43
  44 typedef struct
  45 {
  46
  47   /* Hash table */
  48   BVT (clib_bihash) * mac_table;
  49
  50   /* next node index for the L3 input node of each ethertype */
  51   next_by_ethertype_t l3_next;
  52
  53   /* Next nodes for each feature */
  54   u32 feat_next_node_index[32];
  55
  56   /* convenience variables */
  57   vlib_main_t *vlib_main;
  58   vnet_main_t *vnet_main;
  59 } l2fwd_main_t;
  60
  61 typedef struct
  62 {
  63   /* per-pkt trace data */
  64   u8 src[6];
  65   u8 dst[6];
  66   u32 sw_if_index;
  67   u16 bd_index;
  68   l2fib_entry_result_t result;
  69 } l2fwd_trace_t;
  70
  71 /* packet trace format function */
  72 static u8 *
  73 format_l2fwd_trace (u8 * s, va_list * args)
  74 {
  75   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  76   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  77   l2fwd_trace_t *t = va_arg (*args, l2fwd_trace_t *);
  78
  79   s =
  80     format (s,
  81             "l2-fwd:   sw_if_index %d dst %U src %U bd_index %d result [0x%llx, %d] %U",
  82             t->sw_if_index, format_ethernet_address, t->dst,
  83             format_ethernet_address, t->src, t->bd_index, t->result.raw,
  84             t->result.fields.sw_if_index, format_l2fib_entry_result_flags,
  85             t->result.fields.flags);
  86   return s;
  87 }
  88
  89 #ifndef CLIB_MARCH_VARIANT
  90 l2fwd_main_t l2fwd_main;
  91 #else
  92 extern l2fwd_main_t l2fwd_main;
  93 #endif
  94
  95 static vlib_node_registration_t l2fwd_node;
  96
  97 #define foreach_l2fwd_error                             \
  98 _(L2FWD,         "L2 forward packets")                  \
  99 _(FLOOD,         "L2 forward misses")                   \
 100 _(HIT,           "L2 forward hits")                     \
 101 _(BVI_BAD_MAC,   "BVI L3 MAC mismatch")                 \
 102 _(BVI_ETHERTYPE, "BVI packet with unhandled ethertype") \
 103 _(FILTER_DROP,   "Filter Mac Drop")                     \
 104 _(REFLECT_DROP,  "Reflection Drop")                     \
 105 _(STALE_DROP,    "Stale entry Drop")
 106
 107 typedef enum
 108 {
 109 #define _(sym,str) L2FWD_ERROR_##sym,
 110   foreach_l2fwd_error
 111 #undef _
 112     L2FWD_N_ERROR,
 113 } l2fwd_error_t;
 114
 115 static char *l2fwd_error_strings[] = {
 116 #define _(sym,string) string,
 117   foreach_l2fwd_error
 118 #undef _
 119 };
 120
 121 typedef enum
 122 {
 123   L2FWD_NEXT_L2_OUTPUT,
 124   L2FWD_NEXT_DROP,
 125   L2FWD_N_NEXT,
 126 } l2fwd_next_t;
 127
 128 /** Forward one packet based on the mac table lookup result. */
 129
 130 static_always_inline void
 131 l2fwd_process (vlib_main_t * vm,
 132                vlib_node_runtime_t * node,
 133                l2fwd_main_t * msm,
 134                vlib_error_main_t * em,
 135                vlib_buffer_t * b0,
 136                u32 sw_if_index0, l2fib_entry_result_t * result0, u16 * next0)
 137 {
 138   int try_flood = result0->raw == ~0;
 139   int flood_error;
 140
 141   if (PREDICT_FALSE (try_flood))
 142     {
 143       flood_error = L2FWD_ERROR_FLOOD;
 144     }
 145   else
 146     {
 147       /* lookup hit, forward packet  */
 148 #ifdef COUNTERS
 149       em->counters[node_counter_base_index + L2FWD_ERROR_HIT] += 1;
 150 #endif
 151
 152       vnet_buffer (b0)->sw_if_index[VLIB_TX] = result0->fields.sw_if_index;
 153       *next0 = L2FWD_NEXT_L2_OUTPUT;
 154       int l2fib_seq_num_valid = 1;
 155
 156       /* check l2fib seq num for stale entries */
 157       if (!l2fib_entry_result_is_set_AGE_NOT (result0))
 158         {
 159           l2fib_seq_num_t in_sn = {.as_u16 = vnet_buffer (b0)->l2.l2fib_sn };
 160           l2fib_seq_num_t expected_sn = {
 161             .bd = in_sn.bd,
 162             .swif = *l2fib_swif_seq_num (result0->fields.sw_if_index),
 163           };
 164           l2fib_seq_num_valid =
 165             expected_sn.as_u16 == result0->fields.sn.as_u16;
 166         }
 167
 168       if (PREDICT_FALSE (!l2fib_seq_num_valid))
 169         {
 170           flood_error = L2FWD_ERROR_STALE_DROP;
 171           try_flood = 1;
 172         }
 173       /* perform reflection check */
 174       else if (PREDICT_FALSE (sw_if_index0 == result0->fields.sw_if_index))
 175         {
 176           b0->error = node->errors[L2FWD_ERROR_REFLECT_DROP];
 177           *next0 = L2FWD_NEXT_DROP;
 178         }
 179       /* perform filter check */
 180       else if (PREDICT_FALSE (l2fib_entry_result_is_set_FILTER (result0)))
 181         {
 182           b0->error = node->errors[L2FWD_ERROR_FILTER_DROP];
 183           *next0 = L2FWD_NEXT_DROP;
 184         }
 185       /* perform BVI check */
 186       else if (PREDICT_FALSE (l2fib_entry_result_is_set_BVI (result0)))
 187         {
 188           u32 rc;
 189           rc = l2_to_bvi (vm,
 190                           msm->vnet_main,
 191                           b0,
 192                           vnet_buffer (b0)->sw_if_index[VLIB_TX],
 193                           &msm->l3_next, next0);
 194
 195           if (PREDICT_FALSE (rc))
 196             {
 197               if (rc == TO_BVI_ERR_BAD_MAC)
 198                 {
 199                   b0->error = node->errors[L2FWD_ERROR_BVI_BAD_MAC];
 200                   *next0 = L2FWD_NEXT_DROP;
 201                 }
 202               else if (rc == TO_BVI_ERR_ETHERTYPE)
 203                 {
 204                   b0->error = node->errors[L2FWD_ERROR_BVI_ETHERTYPE];
 205                   *next0 = L2FWD_NEXT_DROP;
 206                 }
 207             }
 208         }
 209     }
 210
 211   /* flood */
 212   if (PREDICT_FALSE (try_flood))
 213     {
 214       /*
 215        * lookup miss, so flood which is typically the next feature
 216        * unless some other feature is inserted before uu_flood
 217        */
 218       if (vnet_buffer (b0)->l2.feature_bitmap &
 219           (L2INPUT_FEAT_UU_FLOOD |
 220            L2INPUT_FEAT_UU_FWD | L2INPUT_FEAT_GBP_FWD))
 221         {
 222           *next0 = vnet_l2_feature_next (b0, msm->feat_next_node_index,
 223                                          L2INPUT_FEAT_FWD);
 224         }
 225       else
 226         {
 227           /* Flooding is disabled */
 228           b0->error = node->errors[flood_error];
 229           *next0 = L2FWD_NEXT_DROP;
 230         }
 231     }
 232 }
 233
 234
 235 static_always_inline uword
 236 l2fwd_node_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
 237                    vlib_frame_t * frame, int do_trace)
 238 {
 239   u32 n_left, *from;
 240   l2fwd_main_t *msm = &l2fwd_main;
 241   vlib_node_t *n = vlib_get_node (vm, l2fwd_node.index);
 242   CLIB_UNUSED (u32 node_counter_base_index) = n->error_heap_index;
 243   vlib_error_main_t *em = &vm->error_main;
 244   l2fib_entry_key_t cached_key;
 245   l2fib_entry_result_t cached_result;
 246   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
 247   u16 nexts[VLIB_FRAME_SIZE], *next;
 248
 249   /* Clear the one-entry cache in case mac table was updated */
 250   cached_key.raw = ~0;
 251   cached_result.raw = ~0;
 252
 253   from = vlib_frame_vector_args (frame);
 254   n_left = frame->n_vectors;    /* number of packets to process */
 255   vlib_get_buffers (vm, from, bufs, n_left);
 256   next = nexts;
 257   b = bufs;
 258
 259   while (n_left >= 8)
 260     {
 261       u32 sw_if_index0, sw_if_index1, sw_if_index2, sw_if_index3;
 262       const ethernet_header_t *h0, *h1, *h2, *h3;
 263       l2fib_entry_key_t key0, key1, key2, key3;
 264       l2fib_entry_result_t result0, result1, result2, result3;
 265       u32 bucket0, bucket1, bucket2, bucket3;
 266
 267       /* Prefetch next iteration. */
 268       {
 269         vlib_prefetch_buffer_header (b[4], LOAD);
 270         vlib_prefetch_buffer_header (b[5], LOAD);
 271         vlib_prefetch_buffer_header (b[6], LOAD);
 272         vlib_prefetch_buffer_header (b[7], LOAD);
 273
 274         CLIB_PREFETCH (b[4]->data, CLIB_CACHE_LINE_BYTES, LOAD);
 275         CLIB_PREFETCH (b[5]->data, CLIB_CACHE_LINE_BYTES, LOAD);
 276         CLIB_PREFETCH (b[6]->data, CLIB_CACHE_LINE_BYTES, LOAD);
 277         CLIB_PREFETCH (b[7]->data, CLIB_CACHE_LINE_BYTES, LOAD);
 278       }
 279
 280       /* RX interface handles */
 281       sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
 282       sw_if_index1 = vnet_buffer (b[1])->sw_if_index[VLIB_RX];
 283       sw_if_index2 = vnet_buffer (b[2])->sw_if_index[VLIB_RX];
 284       sw_if_index3 = vnet_buffer (b[3])->sw_if_index[VLIB_RX];
 285
 286       h0 = vlib_buffer_get_current (b[0]);
 287       h1 = vlib_buffer_get_current (b[1]);
 288       h2 = vlib_buffer_get_current (b[2]);
 289       h3 = vlib_buffer_get_current (b[3]);
 290
 291 #ifdef COUNTERS
 292       em->counters[node_counter_base_index + L2FWD_ERROR_L2FWD] += 4;
 293 #endif
 294       /* *INDENT-OFF* */
 295       l2fib_lookup_4 (msm->mac_table, &cached_key, &cached_result,
 296                       h0->dst_address, h1->dst_address,
 297                       h2->dst_address, h3->dst_address,
 298                       vnet_buffer (b[0])->l2.bd_index,
 299                       vnet_buffer (b[1])->l2.bd_index,
 300                       vnet_buffer (b[2])->l2.bd_index,
 301                       vnet_buffer (b[3])->l2.bd_index,
 302                       &key0,    /* not used */
 303                       &key1,    /* not used */
 304                       &key2,    /* not used */
 305                       &key3,    /* not used */
 306                       &bucket0, /* not used */
 307                       &bucket1, /* not used */
 308                       &bucket2, /* not used */
 309                       &bucket3, /* not used */
 310                       &result0,
 311                       &result1,
 312                       &result2,
 313                       &result3);
 314       /* *INDENT-ON* */
 315       l2fwd_process (vm, node, msm, em, b[0], sw_if_index0, &result0, next);
 316       l2fwd_process (vm, node, msm, em, b[1], sw_if_index1, &result1,
 317                      next + 1);
 318       l2fwd_process (vm, node, msm, em, b[2], sw_if_index2, &result2,
 319                      next + 2);
 320       l2fwd_process (vm, node, msm, em, b[3], sw_if_index3, &result3,
 321                      next + 3);
 322
 323       /* verify speculative enqueues, maybe switch current next frame */
 324       /* if next0==next1==next_index then nothing special needs to be done */
 325       if (do_trace)
 326         {
 327           if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
 328             {
 329               l2fwd_trace_t *t = vlib_add_trace (vm, node, b[0], sizeof (*t));
 330               t->sw_if_index = sw_if_index0;
 331               t->bd_index = vnet_buffer (b[0])->l2.bd_index;
 332               clib_memcpy (t->src, h0->src_address, 6);
 333               clib_memcpy (t->dst, h0->dst_address, 6);
 334               t->result = result0;
 335             }
 336           if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
 337             {
 338               l2fwd_trace_t *t = vlib_add_trace (vm, node, b[1], sizeof (*t));
 339               t->sw_if_index = sw_if_index1;
 340               t->bd_index = vnet_buffer (b[1])->l2.bd_index;
 341               clib_memcpy (t->src, h1->src_address, 6);
 342               clib_memcpy (t->dst, h1->dst_address, 6);
 343               t->result = result1;
 344             }
 345           if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
 346             {
 347               l2fwd_trace_t *t = vlib_add_trace (vm, node, b[2], sizeof (*t));
 348               t->sw_if_index = sw_if_index2;
 349               t->bd_index = vnet_buffer (b[2])->l2.bd_index;
 350               clib_memcpy (t->src, h2->src_address, 6);
 351               clib_memcpy (t->dst, h2->dst_address, 6);
 352               t->result = result2;
 353             }
 354           if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
 355             {
 356               l2fwd_trace_t *t = vlib_add_trace (vm, node, b[3], sizeof (*t));
 357               t->sw_if_index = sw_if_index3;
 358               t->bd_index = vnet_buffer (b[3])->l2.bd_index;
 359               clib_memcpy (t->src, h3->src_address, 6);
 360               clib_memcpy (t->dst, h3->dst_address, 6);
 361               t->result = result3;
 362             }
 363         }
 364
 365       next += 4;
 366       b += 4;
 367       n_left -= 4;
 368     }
 369
 370   while (n_left > 0)
 371     {
 372       u32 sw_if_index0;
 373       ethernet_header_t *h0;
 374       l2fib_entry_key_t key0;
 375       l2fib_entry_result_t result0;
 376       u32 bucket0;
 377
 378       sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
 379
 380       h0 = vlib_buffer_get_current (b[0]);
 381
 382       /* process 1 pkt */
 383 #ifdef COUNTERS
 384       em->counters[node_counter_base_index + L2FWD_ERROR_L2FWD] += 1;
 385 #endif
 386       l2fib_lookup_1 (msm->mac_table, &cached_key, &cached_result, h0->dst_address, vnet_buffer (b[0])->l2.bd_index, &key0,     /* not used */
 387                       &bucket0, /* not used */
 388                       &result0);
 389       l2fwd_process (vm, node, msm, em, b[0], sw_if_index0, &result0, next);
 390
 391       if (do_trace && PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
 392         {
 393           l2fwd_trace_t *t = vlib_add_trace (vm, node, b[0], sizeof (*t));
 394           t->sw_if_index = sw_if_index0;
 395           t->bd_index = vnet_buffer (b[0])->l2.bd_index;
 396           clib_memcpy (t->src, h0->src_address, 6);
 397           clib_memcpy (t->dst, h0->dst_address, 6);
 398           t->result = result0;
 399         }
 400
 401       /* verify speculative enqueue, maybe switch current next frame */
 402       next += 1;
 403       b += 1;
 404       n_left -= 1;
 405     }
 406
 407   vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
 408
 409   return frame->n_vectors;
 410 }
 411
 412 VLIB_NODE_FN (l2fwd_node) (vlib_main_t * vm,
 413                            vlib_node_runtime_t * node, vlib_frame_t * frame)
 414 {
 415   if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
 416     return l2fwd_node_inline (vm, node, frame, 1 /* do_trace */ );
 417   return l2fwd_node_inline (vm, node, frame, 0 /* do_trace */ );
 418 }
 419
 420 /* *INDENT-OFF* */
 421 VLIB_REGISTER_NODE (l2fwd_node,static) = {
 422   .name = "l2-fwd",
 423   .vector_size = sizeof (u32),
 424   .format_trace = format_l2fwd_trace,
 425   .type = VLIB_NODE_TYPE_INTERNAL,
 426
 427   .n_errors = ARRAY_LEN(l2fwd_error_strings),
 428   .error_strings = l2fwd_error_strings,
 429
 430   .n_next_nodes = L2FWD_N_NEXT,
 431
 432   /* edit / add dispositions here */
 433   .next_nodes = {
 434     [L2FWD_NEXT_L2_OUTPUT] = "l2-output",
 435     [L2FWD_NEXT_DROP] = "error-drop",
 436   },
 437 };
 438 /* *INDENT-ON* */
 439
 440 #ifndef CLIB_MARCH_VARIANT
 441 clib_error_t *
 442 l2fwd_init (vlib_main_t * vm)
 443 {
 444   l2fwd_main_t *mp = &l2fwd_main;
 445
 446   mp->vlib_main = vm;
 447   mp->vnet_main = vnet_get_main ();
 448
 449   /* Initialize the feature next-node indexes */
 450   feat_bitmap_init_next_nodes (vm,
 451                                l2fwd_node.index,
 452                                L2INPUT_N_FEAT,
 453                                l2input_get_feat_names (),
 454                                mp->feat_next_node_index);
 455
 456   /* init the hash table ptr */
 457   mp->mac_table = get_mac_table ();
 458
 459   /* Initialize the next nodes for each ethertype */
 460   next_by_ethertype_init (&mp->l3_next);
 461
 462   return 0;
 463 }
 464
 465 VLIB_INIT_FUNCTION (l2fwd_init);
 466
 467
 468 /** Add the L3 input node for this ethertype to the next nodes structure. */
 469 void
 470 l2fwd_register_input_type (vlib_main_t * vm,
 471                            ethernet_type_t type, u32 node_index)
 472 {
 473   l2fwd_main_t *mp = &l2fwd_main;
 474   u32 next_index;
 475
 476   next_index = vlib_node_add_next (vm, l2fwd_node.index, node_index);
 477
 478   next_by_ethertype_register (&mp->l3_next, type, next_index);
 479 }
 480
 481
 482 /**
 483  * Set subinterface forward enable/disable.
 484  * The CLI format is:
 485  *   set interface l2 forward <interface> [disable]
 486  */
 487 static clib_error_t *
 488 int_fwd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
 489 {
 490   vnet_main_t *vnm = vnet_get_main ();
 491   clib_error_t *error = 0;
 492   u32 sw_if_index;
 493   u32 enable;
 494
 495   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 496     {
 497       error = clib_error_return (0, "unknown interface `%U'",
 498                                  format_unformat_error, input);
 499       goto done;
 500     }
 501
 502   enable = 1;
 503   if (unformat (input, "disable"))
 504     {
 505       enable = 0;
 506     }
 507
 508   /* set the interface flag */
 509   if (l2input_intf_config (sw_if_index)->xconnect)
 510     {
 511       l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_XCONNECT, enable);
 512     }
 513   else
 514     {
 515       l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_FWD, enable);
 516     }
 517
 518 done:
 519   return error;
 520 }
 521
 522 /*?
 523  * Layer 2 unicast forwarding can be enabled and disabled on each
 524  * interface and on each bridge-domain. Use this command to
 525  * manage interfaces. It is enabled by default.
 526  *
 527  * @cliexpar
 528  * Example of how to enable forwarding:
 529  * @cliexcmd{set interface l2 forward GigabitEthernet0/8/0}
 530  * Example of how to disable forwarding:
 531  * @cliexcmd{set interface l2 forward GigabitEthernet0/8/0 disable}
 532 ?*/
 533 /* *INDENT-OFF* */
 534 VLIB_CLI_COMMAND (int_fwd_cli, static) = {
 535   .path = "set interface l2 forward",
 536   .short_help = "set interface l2 forward <interface> [disable]",
 537   .function = int_fwd,
 538 };
 539 /* *INDENT-ON* */
 540
 541 #endif
 542
 543 /*
 544  * fd.io coding-style-patch-verification: ON
 545  *
 546  * Local Variables:
 547  * eval: (c-set-style "gnu")
 548  * End:
 549  */