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 dst_and_src[12];
  65   u32 sw_if_index;
  66   u16 bd_index;
  67   l2fib_entry_result_t result;
  68 } l2fwd_trace_t;
  69
  70 /* packet trace format function */
  71 static u8 *
  72 format_l2fwd_trace (u8 * s, va_list * args)
  73 {
  74   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  75   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  76   l2fwd_trace_t *t = va_arg (*args, l2fwd_trace_t *);
  77
  78   s =
  79     format (s,
  80             "l2-fwd:   sw_if_index %d dst %U src %U bd_index %d result [0x%llx, %d] %U",
  81             t->sw_if_index, format_ethernet_address, t->dst_and_src,
  82             format_ethernet_address, t->dst_and_src + 6,
  83             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 extern 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 = vnet_buffer (b0)->l2.l2fib_sn;
 160           l2fib_seq_num_t expected_sn = l2_fib_update_seq_num (in_sn,
 161                                                                l2_input_seq_num
 162                                                                (result0->fields.sw_if_index));
 163
 164           l2fib_seq_num_valid = expected_sn == result0->fields.sn;
 165         }
 166
 167       if (PREDICT_FALSE (!l2fib_seq_num_valid))
 168         {
 169           flood_error = L2FWD_ERROR_STALE_DROP;
 170           try_flood = 1;
 171         }
 172       /* perform reflection check */
 173       else if (PREDICT_FALSE (sw_if_index0 == result0->fields.sw_if_index))
 174         {
 175           b0->error = node->errors[L2FWD_ERROR_REFLECT_DROP];
 176           *next0 = L2FWD_NEXT_DROP;
 177         }
 178       /* perform filter check */
 179       else if (PREDICT_FALSE (l2fib_entry_result_is_set_FILTER (result0)))
 180         {
 181           b0->error = node->errors[L2FWD_ERROR_FILTER_DROP];
 182           *next0 = L2FWD_NEXT_DROP;
 183         }
 184       /* perform BVI check */
 185       else if (PREDICT_FALSE (l2fib_entry_result_is_set_BVI (result0)))
 186         {
 187           u32 rc;
 188           rc = l2_to_bvi (vm,
 189                           msm->vnet_main,
 190                           b0,
 191                           vnet_buffer (b0)->sw_if_index[VLIB_TX],
 192                           &msm->l3_next, next0);
 193
 194           if (PREDICT_FALSE (rc))
 195             {
 196               if (rc == TO_BVI_ERR_BAD_MAC)
 197                 {
 198                   b0->error = node->errors[L2FWD_ERROR_BVI_BAD_MAC];
 199                   *next0 = L2FWD_NEXT_DROP;
 200                 }
 201               else if (rc == TO_BVI_ERR_ETHERTYPE)
 202                 {
 203                   b0->error = node->errors[L2FWD_ERROR_BVI_ETHERTYPE];
 204                   *next0 = L2FWD_NEXT_DROP;
 205                 }
 206             }
 207         }
 208     }
 209
 210   /* flood */
 211   if (PREDICT_FALSE (try_flood))
 212     {
 213       /*
 214        * lookup miss, so flood which is typically the next feature
 215        * unless some other feature is inserted before uu_flood
 216        */
 217       if (vnet_buffer (b0)->l2.feature_bitmap &
 218           (L2INPUT_FEAT_UU_FLOOD |
 219            L2INPUT_FEAT_UU_FWD | L2INPUT_FEAT_GBP_FWD))
 220         {
 221           *next0 = vnet_l2_feature_next (b0, msm->feat_next_node_index,
 222                                          L2INPUT_FEAT_FWD);
 223         }
 224       else
 225         {
 226           /* Flooding is disabled */
 227           b0->error = node->errors[flood_error];
 228           *next0 = L2FWD_NEXT_DROP;
 229         }
 230     }
 231 }
 232
 233
 234 static_always_inline uword
 235 l2fwd_node_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
 236                    vlib_frame_t * frame, int do_trace)
 237 {
 238   u32 n_left, *from;
 239   l2fwd_main_t *msm = &l2fwd_main;
 240   vlib_node_t *n = vlib_get_node (vm, l2fwd_node.index);
 241   CLIB_UNUSED (u32 node_counter_base_index) = n->error_heap_index;
 242   vlib_error_main_t *em = &vm->error_main;
 243   l2fib_entry_key_t cached_key;
 244   l2fib_entry_result_t cached_result;
 245   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
 246   u16 nexts[VLIB_FRAME_SIZE], *next;
 247
 248   /* Clear the one-entry cache in case mac table was updated */
 249   cached_key.raw = ~0;
 250   cached_result.raw = ~0;
 251
 252   from = vlib_frame_vector_args (frame);
 253   n_left = frame->n_vectors;    /* number of packets to process */
 254   vlib_get_buffers (vm, from, bufs, n_left);
 255   next = nexts;
 256   b = bufs;
 257
 258   while (n_left >= 8)
 259     {
 260       u32 sw_if_index0, sw_if_index1, sw_if_index2, sw_if_index3;
 261       const ethernet_header_t *h0, *h1, *h2, *h3;
 262       l2fib_entry_key_t key0, key1, key2, key3;
 263       l2fib_entry_result_t result0, result1, result2, result3;
 264
 265       /* Prefetch next iteration. */
 266       {
 267         vlib_prefetch_buffer_header (b[4], LOAD);
 268         vlib_prefetch_buffer_header (b[5], LOAD);
 269         vlib_prefetch_buffer_header (b[6], LOAD);
 270         vlib_prefetch_buffer_header (b[7], LOAD);
 271
 272         clib_prefetch_load (b[4]->data);
 273         clib_prefetch_load (b[5]->data);
 274         clib_prefetch_load (b[6]->data);
 275         clib_prefetch_load (b[7]->data);
 276       }
 277
 278       /* RX interface handles */
 279       sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
 280       sw_if_index1 = vnet_buffer (b[1])->sw_if_index[VLIB_RX];
 281       sw_if_index2 = vnet_buffer (b[2])->sw_if_index[VLIB_RX];
 282       sw_if_index3 = vnet_buffer (b[3])->sw_if_index[VLIB_RX];
 283
 284       h0 = vlib_buffer_get_current (b[0]);
 285       h1 = vlib_buffer_get_current (b[1]);
 286       h2 = vlib_buffer_get_current (b[2]);
 287       h3 = vlib_buffer_get_current (b[3]);
 288
 289 #ifdef COUNTERS
 290       em->counters[node_counter_base_index + L2FWD_ERROR_L2FWD] += 4;
 291 #endif
 292       /* *INDENT-OFF* */
 293       l2fib_lookup_4 (msm->mac_table, &cached_key, &cached_result,
 294                       h0->dst_address, h1->dst_address,
 295                       h2->dst_address, h3->dst_address,
 296                       vnet_buffer (b[0])->l2.bd_index,
 297                       vnet_buffer (b[1])->l2.bd_index,
 298                       vnet_buffer (b[2])->l2.bd_index,
 299                       vnet_buffer (b[3])->l2.bd_index,
 300                       &key0,    /* not used */
 301                       &key1,    /* not used */
 302                       &key2,    /* not used */
 303                       &key3,    /* not used */
 304                       &result0,
 305                       &result1,
 306                       &result2,
 307                       &result3);
 308       /* *INDENT-ON* */
 309       l2fwd_process (vm, node, msm, em, b[0], sw_if_index0, &result0, next);
 310       l2fwd_process (vm, node, msm, em, b[1], sw_if_index1, &result1,
 311                      next + 1);
 312       l2fwd_process (vm, node, msm, em, b[2], sw_if_index2, &result2,
 313                      next + 2);
 314       l2fwd_process (vm, node, msm, em, b[3], sw_if_index3, &result3,
 315                      next + 3);
 316
 317       /* verify speculative enqueues, maybe switch current next frame */
 318       /* if next0==next1==next_index then nothing special needs to be done */
 319       if (do_trace)
 320         {
 321           if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
 322             {
 323               l2fwd_trace_t *t = vlib_add_trace (vm, node, b[0], sizeof (*t));
 324               t->sw_if_index = sw_if_index0;
 325               t->bd_index = vnet_buffer (b[0])->l2.bd_index;
 326               clib_memcpy_fast (t->dst_and_src, h0->dst_address,
 327                                 sizeof (h0->dst_address) +
 328                                 sizeof (h0->src_address));
 329               t->result = result0;
 330             }
 331           if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
 332             {
 333               l2fwd_trace_t *t = vlib_add_trace (vm, node, b[1], sizeof (*t));
 334               t->sw_if_index = sw_if_index1;
 335               t->bd_index = vnet_buffer (b[1])->l2.bd_index;
 336               clib_memcpy_fast (t->dst_and_src, h1->dst_address,
 337                                 sizeof (h1->dst_address) +
 338                                 sizeof (h1->src_address));
 339               t->result = result1;
 340             }
 341           if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
 342             {
 343               l2fwd_trace_t *t = vlib_add_trace (vm, node, b[2], sizeof (*t));
 344               t->sw_if_index = sw_if_index2;
 345               t->bd_index = vnet_buffer (b[2])->l2.bd_index;
 346               clib_memcpy_fast (t->dst_and_src, h2->dst_address,
 347                                 sizeof (h2->dst_address) +
 348                                 sizeof (h2->src_address));
 349               t->result = result2;
 350             }
 351           if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
 352             {
 353               l2fwd_trace_t *t = vlib_add_trace (vm, node, b[3], sizeof (*t));
 354               t->sw_if_index = sw_if_index3;
 355               t->bd_index = vnet_buffer (b[3])->l2.bd_index;
 356               clib_memcpy_fast (t->dst_and_src, h3->dst_address,
 357                                 sizeof (h3->dst_address) +
 358                                 sizeof (h3->src_address));
 359               t->result = result3;
 360             }
 361         }
 362
 363       next += 4;
 364       b += 4;
 365       n_left -= 4;
 366     }
 367
 368   while (n_left > 0)
 369     {
 370       u32 sw_if_index0;
 371       ethernet_header_t *h0;
 372       l2fib_entry_key_t key0;
 373       l2fib_entry_result_t result0;
 374
 375       sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
 376
 377       h0 = vlib_buffer_get_current (b[0]);
 378
 379       /* process 1 pkt */
 380 #ifdef COUNTERS
 381       em->counters[node_counter_base_index + L2FWD_ERROR_L2FWD] += 1;
 382 #endif
 383       l2fib_lookup_1 (msm->mac_table, &cached_key, &cached_result,
 384                       h0->dst_address, vnet_buffer (b[0])->l2.bd_index, &key0,
 385                       /* not used */ &result0);
 386       l2fwd_process (vm, node, msm, em, b[0], sw_if_index0, &result0, next);
 387
 388       if (do_trace && PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
 389         {
 390           l2fwd_trace_t *t = vlib_add_trace (vm, node, b[0], sizeof (*t));
 391           t->sw_if_index = sw_if_index0;
 392           t->bd_index = vnet_buffer (b[0])->l2.bd_index;
 393           clib_memcpy_fast (t->dst_and_src, h0->dst_address,
 394                             sizeof (h0->dst_address) +
 395                             sizeof (h0->src_address));
 396           t->result = result0;
 397         }
 398
 399       /* verify speculative enqueue, maybe switch current next frame */
 400       next += 1;
 401       b += 1;
 402       n_left -= 1;
 403     }
 404
 405   vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
 406
 407   return frame->n_vectors;
 408 }
 409
 410 VLIB_NODE_FN (l2fwd_node) (vlib_main_t * vm,
 411                            vlib_node_runtime_t * node, vlib_frame_t * frame)
 412 {
 413   if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
 414     return l2fwd_node_inline (vm, node, frame, 1 /* do_trace */ );
 415   return l2fwd_node_inline (vm, node, frame, 0 /* do_trace */ );
 416 }
 417
 418 /* *INDENT-OFF* */
 419 VLIB_REGISTER_NODE (l2fwd_node) = {
 420   .name = "l2-fwd",
 421   .vector_size = sizeof (u32),
 422   .format_trace = format_l2fwd_trace,
 423   .type = VLIB_NODE_TYPE_INTERNAL,
 424
 425   .n_errors = ARRAY_LEN(l2fwd_error_strings),
 426   .error_strings = l2fwd_error_strings,
 427
 428   .n_next_nodes = L2FWD_N_NEXT,
 429
 430   /* edit / add dispositions here */
 431   .next_nodes = {
 432     [L2FWD_NEXT_L2_OUTPUT] = "l2-output",
 433     [L2FWD_NEXT_DROP] = "error-drop",
 434   },
 435 };
 436 /* *INDENT-ON* */
 437
 438 #ifndef CLIB_MARCH_VARIANT
 439 clib_error_t *
 440 l2fwd_init (vlib_main_t * vm)
 441 {
 442   l2fwd_main_t *mp = &l2fwd_main;
 443
 444   mp->vlib_main = vm;
 445   mp->vnet_main = vnet_get_main ();
 446
 447   /* Initialize the feature next-node indexes */
 448   feat_bitmap_init_next_nodes (vm,
 449                                l2fwd_node.index,
 450                                L2INPUT_N_FEAT,
 451                                l2input_get_feat_names (),
 452                                mp->feat_next_node_index);
 453
 454   /* init the hash table ptr */
 455   mp->mac_table = get_mac_table ();
 456
 457   /* Initialize the next nodes for each ethertype */
 458   next_by_ethertype_init (&mp->l3_next);
 459
 460   return 0;
 461 }
 462
 463 VLIB_INIT_FUNCTION (l2fwd_init);
 464
 465
 466 /** Add the L3 input node for this ethertype to the next nodes structure. */
 467 void
 468 l2fwd_register_input_type (vlib_main_t * vm,
 469                            ethernet_type_t type, u32 node_index)
 470 {
 471   l2fwd_main_t *mp = &l2fwd_main;
 472   u32 next_index;
 473
 474   next_index = vlib_node_add_next (vm, l2fwd_node.index, node_index);
 475
 476   next_by_ethertype_register (&mp->l3_next, type, next_index);
 477 }
 478
 479
 480 /**
 481  * Set subinterface forward enable/disable.
 482  * The CLI format is:
 483  *   set interface l2 forward <interface> [disable]
 484  */
 485 static clib_error_t *
 486 int_fwd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
 487 {
 488   vnet_main_t *vnm = vnet_get_main ();
 489   clib_error_t *error = 0;
 490   u32 sw_if_index;
 491   u32 enable;
 492
 493   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 494     {
 495       error = clib_error_return (0, "unknown interface `%U'",
 496                                  format_unformat_error, input);
 497       goto done;
 498     }
 499
 500   enable = 1;
 501   if (unformat (input, "disable"))
 502     {
 503       enable = 0;
 504     }
 505
 506   /* set the interface flag */
 507   if (l2input_intf_config (sw_if_index))
 508     {
 509       l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_XCONNECT, enable);
 510     }
 511   else
 512     {
 513       l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_FWD, enable);
 514     }
 515
 516 done:
 517   return error;
 518 }
 519
 520 /*?
 521  * Layer 2 unicast forwarding can be enabled and disabled on each
 522  * interface and on each bridge-domain. Use this command to
 523  * manage interfaces. It is enabled by default.
 524  *
 525  * @cliexpar
 526  * Example of how to enable forwarding:
 527  * @cliexcmd{set interface l2 forward GigabitEthernet0/8/0}
 528  * Example of how to disable forwarding:
 529  * @cliexcmd{set interface l2 forward GigabitEthernet0/8/0 disable}
 530 ?*/
 531 /* *INDENT-OFF* */
 532 VLIB_CLI_COMMAND (int_fwd_cli, static) = {
 533   .path = "set interface l2 forward",
 534   .short_help = "set interface l2 forward <interface> [disable]",
 535   .function = int_fwd,
 536 };
 537 /* *INDENT-ON* */
 538
 539 #endif
 540
 541 /*
 542  * fd.io coding-style-patch-verification: ON
 543  *
 544  * Local Variables:
 545  * eval: (c-set-style "gnu")
 546  * End:
 547  */