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