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