src/vnet/l2/l2_flood.c

   1 /*
   2  * l2_flood.c : layer 2 flooding
   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 #include <vnet/l2/l2_input.h>
  24 #include <vnet/l2/feat_bitmap.h>
  25 #include <vnet/l2/l2_bvi.h>
  26 #include <vnet/replication.h>
  27 #include <vnet/l2/l2_fib.h>
  28
  29 #include <vppinfra/error.h>
  30 #include <vppinfra/hash.h>
  31
  32
  33 /**
  34  * @file
  35  * @brief Ethernet Flooding.
  36  *
  37  * Flooding uses the packet replication infrastructure to send a copy of the
  38  * packet to each member interface. Logically the replication infrastructure
  39  * expects two graph nodes: a prep node that initiates replication and sends the
  40  * packet to the first destination, and a recycle node that is passed the packet
  41  * after it has been transmitted.
  42  *
  43  * To decrease the amount of code, l2 flooding implements both functions in
  44  * the same graph node. This node can tell if is it being called as the "prep"
  45  * or "recycle" using replication_is_recycled().
  46  */
  47
  48
  49 typedef struct
  50 {
  51
  52   /* Next nodes for each feature */
  53   u32 feat_next_node_index[32];
  54
  55   /* next node index for the L3 input node of each ethertype */
  56   next_by_ethertype_t l3_next;
  57
  58   /* convenience variables */
  59   vlib_main_t *vlib_main;
  60   vnet_main_t *vnet_main;
  61
  62   /* per-cpu vector of cloned packets */
  63   u32 **clones;
  64   l2_flood_member_t ***members;
  65 } l2flood_main_t;
  66
  67 typedef struct
  68 {
  69   u8 src[6];
  70   u8 dst[6];
  71   u32 sw_if_index;
  72   u16 bd_index;
  73 } l2flood_trace_t;
  74
  75
  76 /* packet trace format function */
  77 static u8 *
  78 format_l2flood_trace (u8 * s, va_list * args)
  79 {
  80   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  81   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  82   l2flood_trace_t *t = va_arg (*args, l2flood_trace_t *);
  83
  84   s = format (s, "l2-flood: sw_if_index %d dst %U src %U bd_index %d",
  85               t->sw_if_index,
  86               format_ethernet_address, t->dst,
  87               format_ethernet_address, t->src, t->bd_index);
  88   return s;
  89 }
  90
  91 l2flood_main_t l2flood_main;
  92
  93 static vlib_node_registration_t l2flood_node;
  94
  95 #define foreach_l2flood_error                                   \
  96 _(L2FLOOD,           "L2 flood packets")                        \
  97 _(REPL_FAIL,         "L2 replication failures")                 \
  98 _(NO_MEMBERS,        "L2 replication complete")                 \
  99 _(BVI_BAD_MAC,       "BVI L3 mac mismatch")                     \
 100 _(BVI_ETHERTYPE,     "BVI packet with unhandled ethertype")
 101
 102 typedef enum
 103 {
 104 #define _(sym,str) L2FLOOD_ERROR_##sym,
 105   foreach_l2flood_error
 106 #undef _
 107     L2FLOOD_N_ERROR,
 108 } l2flood_error_t;
 109
 110 static char *l2flood_error_strings[] = {
 111 #define _(sym,string) string,
 112   foreach_l2flood_error
 113 #undef _
 114 };
 115
 116 typedef enum
 117 {
 118   L2FLOOD_NEXT_L2_OUTPUT,
 119   L2FLOOD_NEXT_DROP,
 120   L2FLOOD_N_NEXT,
 121 } l2flood_next_t;
 122
 123 /*
 124  * Perform flooding on one packet
 125  *
 126  * Due to the way BVI processing can modify the packet, the BVI interface
 127  * (if present) must be processed last in the replication. The member vector
 128  * is arranged so that the BVI interface is always the first element.
 129  * Flooding walks the vector in reverse.
 130  *
 131  * BVI processing causes the packet to go to L3 processing. This strips the
 132  * L2 header, which is fine because the replication infrastructure restores
 133  * it. However L3 processing can trigger larger changes to the packet. For
 134  * example, an ARP request could be turned into an ARP reply, an ICMP request
 135  * could be turned into an ICMP reply. If BVI processing is not performed
 136  * last, the modified packet would be replicated to the remaining members.
 137  */
 138 static uword
 139 l2flood_node_fn (vlib_main_t * vm,
 140                  vlib_node_runtime_t * node, vlib_frame_t * frame)
 141 {
 142   u32 n_left_from, *from, *to_next;
 143   l2flood_next_t next_index;
 144   l2flood_main_t *msm = &l2flood_main;
 145   u32 thread_index = vm->thread_index;
 146
 147   from = vlib_frame_vector_args (frame);
 148   n_left_from = frame->n_vectors;
 149   next_index = node->cached_next_index;
 150
 151   while (n_left_from > 0)
 152     {
 153       u32 n_left_to_next;
 154
 155       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 156
 157       while (n_left_from > 0 && n_left_to_next > 0)
 158         {
 159           u32 next0, sw_if_index0, bi0, ci0;
 160           u16 n_clones, n_cloned, clone0;
 161           l2_bridge_domain_t *bd_config;
 162           l2_flood_member_t *member;
 163           vlib_buffer_t *b0, *c0;
 164           u8 in_shg;
 165           i32 mi;
 166
 167           /* speculatively enqueue b0 to the current next frame */
 168           bi0 = from[0];
 169           from += 1;
 170           n_left_from -= 1;
 171           next0 = L2FLOOD_NEXT_DROP;
 172
 173           b0 = vlib_get_buffer (vm, bi0);
 174
 175           /* Get config for the bridge domain interface */
 176           bd_config = vec_elt_at_index (l2input_main.bd_configs,
 177                                         vnet_buffer (b0)->l2.bd_index);
 178           in_shg = vnet_buffer (b0)->l2.shg;
 179           sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 180
 181           vec_validate (msm->members[thread_index],
 182                         vec_len (bd_config->members));
 183
 184           vec_reset_length (msm->members[thread_index]);
 185
 186           /* Find first members that passes the reflection and SHG checks */
 187           for (mi = bd_config->flood_count - 1; mi >= 0; mi--)
 188             {
 189               member = &bd_config->members[mi];
 190               if ((member->sw_if_index != sw_if_index0) &&
 191                   (!in_shg || (member->shg != in_shg)))
 192                 {
 193                   vec_add1 (msm->members[thread_index], member);
 194                 }
 195             }
 196
 197           n_clones = vec_len (msm->members[thread_index]);
 198
 199           if (0 == n_clones)
 200             {
 201               /* No members to flood to */
 202               to_next[0] = bi0;
 203               to_next += 1;
 204               n_left_to_next -= 1;
 205
 206               b0->error = node->errors[L2FLOOD_ERROR_NO_MEMBERS];
 207               vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 208                                                to_next, n_left_to_next,
 209                                                bi0, L2FLOOD_NEXT_DROP);
 210               continue;
 211             }
 212
 213           vec_validate (msm->clones[thread_index], n_clones);
 214           vec_reset_length (msm->clones[thread_index]);
 215
 216           /*
 217            * the header offset needs to be large enoguh to incorporate
 218            * all the L3 headers that could be touched when doing BVI
 219            * processing. So take the current l2 length plus 2 * IPv6
 220            * headers (for tunnel encap)
 221            */
 222           n_cloned = vlib_buffer_clone (vm, bi0,
 223                                         msm->clones[thread_index],
 224                                         n_clones,
 225                                         (vnet_buffer (b0)->l2.l2_len +
 226                                          sizeof (udp_header_t) +
 227                                          2 * sizeof (ip6_header_t)));
 228
 229           if (PREDICT_FALSE (n_cloned != n_clones))
 230             {
 231               b0->error = node->errors[L2FLOOD_ERROR_REPL_FAIL];
 232             }
 233
 234           /*
 235            * for all but the last clone, these are not BVI bound
 236            */
 237           for (clone0 = 0; clone0 < n_cloned - 1; clone0++)
 238             {
 239               member = msm->members[thread_index][clone0];
 240               ci0 = msm->clones[thread_index][clone0];
 241               c0 = vlib_get_buffer (vm, ci0);
 242
 243               to_next[0] = ci0;
 244               to_next += 1;
 245               n_left_to_next -= 1;
 246
 247               if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
 248                                  (b0->flags & VLIB_BUFFER_IS_TRACED)))
 249                 {
 250                   ethernet_header_t *h0;
 251                   l2flood_trace_t *t;
 252
 253                   if (c0 != b0)
 254                     vlib_buffer_copy_trace_flag (vm, b0, ci0);
 255
 256                   t = vlib_add_trace (vm, node, c0, sizeof (*t));
 257                   h0 = vlib_buffer_get_current (c0);
 258                   t->sw_if_index = sw_if_index0;
 259                   t->bd_index = vnet_buffer (c0)->l2.bd_index;
 260                   clib_memcpy (t->src, h0->src_address, 6);
 261                   clib_memcpy (t->dst, h0->dst_address, 6);
 262                 }
 263
 264               /* Do normal L2 forwarding */
 265               vnet_buffer (c0)->sw_if_index[VLIB_TX] = member->sw_if_index;
 266               next0 = L2FLOOD_NEXT_L2_OUTPUT;
 267
 268               vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 269                                                to_next, n_left_to_next,
 270                                                ci0, next0);
 271               if (PREDICT_FALSE (0 == n_left_to_next))
 272                 {
 273                   vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 274                   vlib_get_next_frame (vm, node, next_index,
 275                                        to_next, n_left_to_next);
 276                 }
 277             }
 278
 279           /*
 280            * the last clone that might go to a BVI
 281            */
 282           member = msm->members[thread_index][clone0];
 283           ci0 = msm->clones[thread_index][clone0];
 284           c0 = vlib_get_buffer (vm, ci0);
 285
 286           to_next[0] = ci0;
 287           to_next += 1;
 288           n_left_to_next -= 1;
 289
 290           if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
 291                              (b0->flags & VLIB_BUFFER_IS_TRACED)))
 292             {
 293               ethernet_header_t *h0;
 294               l2flood_trace_t *t;
 295
 296               if (c0 != b0)
 297                 vlib_buffer_copy_trace_flag (vm, b0, ci0);
 298
 299               t = vlib_add_trace (vm, node, c0, sizeof (*t));
 300               h0 = vlib_buffer_get_current (c0);
 301               t->sw_if_index = sw_if_index0;
 302               t->bd_index = vnet_buffer (c0)->l2.bd_index;
 303               clib_memcpy (t->src, h0->src_address, 6);
 304               clib_memcpy (t->dst, h0->dst_address, 6);
 305             }
 306
 307
 308           /* Forward packet to the current member */
 309           if (PREDICT_FALSE (member->flags & L2_FLOOD_MEMBER_BVI))
 310             {
 311               /* Do BVI processing */
 312               u32 rc;
 313               rc = l2_to_bvi (vm,
 314                               msm->vnet_main,
 315                               c0, member->sw_if_index, &msm->l3_next, &next0);
 316
 317               if (PREDICT_FALSE (rc))
 318                 {
 319                   if (rc == TO_BVI_ERR_BAD_MAC)
 320                     {
 321                       c0->error = node->errors[L2FLOOD_ERROR_BVI_BAD_MAC];
 322                     }
 323                   else if (rc == TO_BVI_ERR_ETHERTYPE)
 324                     {
 325                       c0->error = node->errors[L2FLOOD_ERROR_BVI_ETHERTYPE];
 326                     }
 327                 }
 328             }
 329           else
 330             {
 331               /* Do normal L2 forwarding */
 332               vnet_buffer (c0)->sw_if_index[VLIB_TX] = member->sw_if_index;
 333               next0 = L2FLOOD_NEXT_L2_OUTPUT;
 334             }
 335
 336           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 337                                            to_next, n_left_to_next,
 338                                            ci0, next0);
 339           if (PREDICT_FALSE (0 == n_left_to_next))
 340             {
 341               vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 342               vlib_get_next_frame (vm, node, next_index,
 343                                    to_next, n_left_to_next);
 344             }
 345         }
 346
 347       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 348     }
 349
 350   vlib_node_increment_counter (vm, node->node_index,
 351                                L2FLOOD_ERROR_L2FLOOD, frame->n_vectors);
 352
 353   return frame->n_vectors;
 354 }
 355
 356
 357 /* *INDENT-OFF* */
 358 VLIB_REGISTER_NODE (l2flood_node,static) = {
 359   .function = l2flood_node_fn,
 360   .name = "l2-flood",
 361   .vector_size = sizeof (u32),
 362   .format_trace = format_l2flood_trace,
 363   .type = VLIB_NODE_TYPE_INTERNAL,
 364
 365   .n_errors = ARRAY_LEN(l2flood_error_strings),
 366   .error_strings = l2flood_error_strings,
 367
 368   .n_next_nodes = L2FLOOD_N_NEXT,
 369
 370   /* edit / add dispositions here */
 371   .next_nodes = {
 372         [L2FLOOD_NEXT_L2_OUTPUT] = "l2-output",
 373         [L2FLOOD_NEXT_DROP] = "error-drop",
 374   },
 375 };
 376 /* *INDENT-ON* */
 377
 378 VLIB_NODE_FUNCTION_MULTIARCH (l2flood_node, l2flood_node_fn)
 379      clib_error_t *l2flood_init (vlib_main_t * vm)
 380 {
 381   l2flood_main_t *mp = &l2flood_main;
 382
 383   mp->vlib_main = vm;
 384   mp->vnet_main = vnet_get_main ();
 385
 386   vec_validate (mp->clones, vlib_num_workers ());
 387   vec_validate (mp->members, vlib_num_workers ());
 388
 389   /* Initialize the feature next-node indexes */
 390   feat_bitmap_init_next_nodes (vm,
 391                                l2flood_node.index,
 392                                L2INPUT_N_FEAT,
 393                                l2input_get_feat_names (),
 394                                mp->feat_next_node_index);
 395
 396   return NULL;
 397 }
 398
 399 VLIB_INIT_FUNCTION (l2flood_init);
 400
 401
 402
 403 /** Add the L3 input node for this ethertype to the next nodes structure. */
 404 void
 405 l2flood_register_input_type (vlib_main_t * vm,
 406                              ethernet_type_t type, u32 node_index)
 407 {
 408   l2flood_main_t *mp = &l2flood_main;
 409   u32 next_index;
 410
 411   next_index = vlib_node_add_next (vm, l2flood_node.index, node_index);
 412
 413   next_by_ethertype_register (&mp->l3_next, type, next_index);
 414 }
 415
 416
 417 /**
 418  * Set subinterface flood enable/disable.
 419  * The CLI format is:
 420  * set interface l2 flood <interface> [disable]
 421  */
 422 static clib_error_t *
 423 int_flood (vlib_main_t * vm,
 424            unformat_input_t * input, vlib_cli_command_t * cmd)
 425 {
 426   vnet_main_t *vnm = vnet_get_main ();
 427   clib_error_t *error = 0;
 428   u32 sw_if_index;
 429   u32 enable;
 430
 431   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 432     {
 433       error = clib_error_return (0, "unknown interface `%U'",
 434                                  format_unformat_error, input);
 435       goto done;
 436     }
 437
 438   enable = 1;
 439   if (unformat (input, "disable"))
 440     {
 441       enable = 0;
 442     }
 443
 444   /* set the interface flag */
 445   l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_FLOOD, enable);
 446
 447 done:
 448   return error;
 449 }
 450
 451 /*?
 452  * Layer 2 flooding can be enabled and disabled on each
 453  * interface and on each bridge-domain. Use this command to
 454  * manage interfaces. It is enabled by default.
 455  *
 456  * @cliexpar
 457  * Example of how to enable flooding:
 458  * @cliexcmd{set interface l2 flood GigabitEthernet0/8/0}
 459  * Example of how to disable flooding:
 460  * @cliexcmd{set interface l2 flood GigabitEthernet0/8/0 disable}
 461 ?*/
 462 /* *INDENT-OFF* */
 463 VLIB_CLI_COMMAND (int_flood_cli, static) = {
 464   .path = "set interface l2 flood",
 465   .short_help = "set interface l2 flood <interface> [disable]",
 466   .function = int_flood,
 467 };
 468 /* *INDENT-ON* */
 469
 470 /*
 471  * fd.io coding-style-patch-verification: ON
 472  *
 473  * Local Variables:
 474  * eval: (c-set-style "gnu")
 475  * End:
 476  */