src/vnet/l2/l2_learn.c

   1 /*
   2  * l2_learn.c : layer 2 learning 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/feat_bitmap.h>
  26 #include <vnet/l2/l2_fib.h>
  27 #include <vnet/l2/l2_learn.h>
  28
  29 #include <vppinfra/error.h>
  30 #include <vppinfra/hash.h>
  31
  32 /**
  33  * @file
  34  * @brief Ethernet Bridge Learning.
  35  *
  36  * Populate the mac table with entries mapping the packet's source mac + bridge
  37  * domain ID to the input sw_if_index.
  38  *
  39  * Note that learning and forwarding are separate graph nodes. This means that
  40  * for a set of packets, all learning is performed first, then all nodes are
  41  * forwarded. The forwarding is done based on the end-state of the mac table,
  42  * instead of the state after each packet. Thus the forwarding results could
  43  * differ in certain cases (mac move tests), but this not expected to cause
  44  * problems in real-world networks. It is much simpler to separate learning
  45  * and forwarding into separate nodes.
  46  */
  47
  48
  49 typedef struct
  50 {
  51   u8 src[6];
  52   u8 dst[6];
  53   u32 sw_if_index;
  54   u16 bd_index;
  55 } l2learn_trace_t;
  56
  57
  58 /* packet trace format function */
  59 static u8 *
  60 format_l2learn_trace (u8 * s, va_list * args)
  61 {
  62   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  63   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  64   l2learn_trace_t *t = va_arg (*args, l2learn_trace_t *);
  65
  66   s = format (s, "l2-learn: sw_if_index %d dst %U src %U bd_index %d",
  67               t->sw_if_index,
  68               format_ethernet_address, t->dst,
  69               format_ethernet_address, t->src, t->bd_index);
  70   return s;
  71 }
  72
  73 static vlib_node_registration_t l2learn_node;
  74
  75 #define foreach_l2learn_error                           \
  76 _(L2LEARN,           "L2 learn packets")                \
  77 _(MISS,              "L2 learn misses")                 \
  78 _(MAC_MOVE,          "L2 mac moves")                    \
  79 _(MAC_MOVE_VIOLATE,  "L2 mac move violations")          \
  80 _(LIMIT,             "L2 not learned due to limit")     \
  81 _(HIT,               "L2 learn hits")                   \
  82 _(FILTER_DROP,       "L2 filter mac drops")
  83
  84 typedef enum
  85 {
  86 #define _(sym,str) L2LEARN_ERROR_##sym,
  87   foreach_l2learn_error
  88 #undef _
  89     L2LEARN_N_ERROR,
  90 } l2learn_error_t;
  91
  92 static char *l2learn_error_strings[] = {
  93 #define _(sym,string) string,
  94   foreach_l2learn_error
  95 #undef _
  96 };
  97
  98 typedef enum
  99 {
 100   L2LEARN_NEXT_L2FWD,
 101   L2LEARN_NEXT_DROP,
 102   L2LEARN_N_NEXT,
 103 } l2learn_next_t;
 104
 105
 106 /** Perform learning on one packet based on the mac table lookup result. */
 107
 108 static_always_inline void
 109 l2learn_process (vlib_node_runtime_t * node,
 110                  l2learn_main_t * msm,
 111                  u64 * counter_base,
 112                  vlib_buffer_t * b0,
 113                  u32 sw_if_index0,
 114                  l2fib_entry_key_t * key0,
 115                  l2fib_entry_key_t * cached_key,
 116                  u32 * bucket0,
 117                  l2fib_entry_result_t * result0, u32 * next0, u8 timestamp)
 118 {
 119   /* Set up the default next node (typically L2FWD) */
 120   *next0 = vnet_l2_feature_next (b0, msm->feat_next_node_index,
 121                                  L2INPUT_FEAT_LEARN);
 122
 123   /* Check mac table lookup result */
 124   if (PREDICT_TRUE (result0->fields.sw_if_index == sw_if_index0))
 125     {
 126       /* Entry in L2FIB with matching sw_if_index matched - normal fast path */
 127       counter_base[L2LEARN_ERROR_HIT] += 1;
 128       int update = !result0->fields.age_not &&  /* static_mac always age_not */
 129         (result0->fields.timestamp != timestamp ||
 130          result0->fields.sn.as_u16 != vnet_buffer (b0)->l2.l2fib_sn);
 131
 132       if (PREDICT_TRUE (!update))
 133         return;
 134       else if (msm->global_learn_count > msm->global_learn_limit)
 135         return;                 /* Above learn limit - do not update */
 136     }
 137   else if (result0->raw == ~0)
 138     {
 139       /* Entry not in L2FIB - add it  */
 140       counter_base[L2LEARN_ERROR_MISS] += 1;
 141
 142       if (msm->global_learn_count >= msm->global_learn_limit)
 143         {
 144           /*
 145            * Global limit reached. Do not learn the mac but forward the packet.
 146            * In the future, limits could also be per-interface or bridge-domain.
 147            */
 148           counter_base[L2LEARN_ERROR_LIMIT] += 1;
 149           return;
 150         }
 151
 152       /* Do not learn if mac is 0 */
 153       l2fib_entry_key_t key = *key0;
 154       key.fields.bd_index = 0;
 155       if (key.raw == 0)
 156         return;
 157
 158       /* It is ok to learn */
 159       msm->global_learn_count++;
 160       result0->raw = 0;         /* clear all fields */
 161       result0->fields.sw_if_index = sw_if_index0;
 162       result0->fields.lrn_evt = (msm->client_pid != 0);
 163       cached_key->raw = ~0;     /* invalidate the cache */
 164     }
 165   else
 166     {
 167       /* Entry in L2FIB with different sw_if_index - mac move or filter */
 168       if (result0->fields.filter)
 169         {
 170           ASSERT (result0->fields.sw_if_index == ~0);
 171           /* drop packet because lookup matched a filter mac entry */
 172           b0->error = node->errors[L2LEARN_ERROR_FILTER_DROP];
 173           *next0 = L2LEARN_NEXT_DROP;
 174           return;
 175         }
 176
 177       if (result0->fields.static_mac)
 178         {
 179           /*
 180            * Don't overwrite a static mac
 181            * TODO: Check violation policy. For now drop the packet
 182            */
 183           b0->error = node->errors[L2LEARN_ERROR_MAC_MOVE_VIOLATE];
 184           *next0 = L2LEARN_NEXT_DROP;
 185           return;
 186         }
 187
 188       /*
 189        * TODO: may want to rate limit mac moves
 190        * TODO: check global/bridge domain/interface learn limits
 191        */
 192       result0->fields.sw_if_index = sw_if_index0;
 193       if (result0->fields.age_not)      /* The mac was provisioned */
 194         {
 195           msm->global_learn_count++;
 196           result0->fields.age_not = 0;
 197         }
 198       result0->fields.lrn_evt = (msm->client_pid != 0);
 199       counter_base[L2LEARN_ERROR_MAC_MOVE] += 1;
 200     }
 201
 202   /* Update the entry */
 203   result0->fields.timestamp = timestamp;
 204   result0->fields.sn.as_u16 = vnet_buffer (b0)->l2.l2fib_sn;
 205
 206   BVT (clib_bihash_kv) kv;
 207   kv.key = key0->raw;
 208   kv.value = result0->raw;
 209   BV (clib_bihash_add_del) (msm->mac_table, &kv, 1 /* is_add */ );
 210 }
 211
 212
 213 static_always_inline uword
 214 l2learn_node_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
 215                      vlib_frame_t * frame, int do_trace)
 216 {
 217   u32 n_left_from, *from, *to_next;
 218   l2learn_next_t next_index;
 219   l2learn_main_t *msm = &l2learn_main;
 220   vlib_node_t *n = vlib_get_node (vm, l2learn_node.index);
 221   u32 node_counter_base_index = n->error_heap_index;
 222   vlib_error_main_t *em = &vm->error_main;
 223   l2fib_entry_key_t cached_key;
 224   l2fib_entry_result_t cached_result;
 225   u8 timestamp = (u8) (vlib_time_now (vm) / 60);
 226
 227   from = vlib_frame_vector_args (frame);
 228   n_left_from = frame->n_vectors;       /* number of packets to process */
 229   next_index = node->cached_next_index;
 230
 231   /* Clear the one-entry cache in case mac table was updated */
 232   cached_key.raw = ~0;
 233   cached_result.raw = ~0;       /* warning be gone */
 234
 235   while (n_left_from > 0)
 236     {
 237       u32 n_left_to_next;
 238
 239       /* get space to enqueue frame to graph node "next_index" */
 240       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 241
 242       while (n_left_from >= 8 && n_left_to_next >= 4)
 243         {
 244           u32 bi0, bi1, bi2, bi3;
 245           vlib_buffer_t *b0, *b1, *b2, *b3;
 246           u32 next0, next1, next2, next3;
 247           u32 sw_if_index0, sw_if_index1, sw_if_index2, sw_if_index3;
 248           ethernet_header_t *h0, *h1, *h2, *h3;
 249           l2fib_entry_key_t key0, key1, key2, key3;
 250           l2fib_entry_result_t result0, result1, result2, result3;
 251           u32 bucket0, bucket1, bucket2, bucket3;
 252
 253           /* Prefetch next iteration. */
 254           {
 255             vlib_buffer_t *p4, *p5, *p6, *p7;;
 256
 257             p4 = vlib_get_buffer (vm, from[4]);
 258             p5 = vlib_get_buffer (vm, from[5]);
 259             p6 = vlib_get_buffer (vm, from[6]);
 260             p7 = vlib_get_buffer (vm, from[7]);
 261
 262             vlib_prefetch_buffer_header (p4, LOAD);
 263             vlib_prefetch_buffer_header (p5, LOAD);
 264             vlib_prefetch_buffer_header (p6, LOAD);
 265             vlib_prefetch_buffer_header (p7, LOAD);
 266
 267             CLIB_PREFETCH (p4->data, CLIB_CACHE_LINE_BYTES, STORE);
 268             CLIB_PREFETCH (p5->data, CLIB_CACHE_LINE_BYTES, STORE);
 269             CLIB_PREFETCH (p6->data, CLIB_CACHE_LINE_BYTES, STORE);
 270             CLIB_PREFETCH (p7->data, CLIB_CACHE_LINE_BYTES, STORE);
 271           }
 272
 273           /* speculatively enqueue b0 and b1 to the current next frame */
 274           /* bi is "buffer index", b is pointer to the buffer */
 275           to_next[0] = bi0 = from[0];
 276           to_next[1] = bi1 = from[1];
 277           to_next[2] = bi2 = from[2];
 278           to_next[3] = bi3 = from[3];
 279           from += 4;
 280           to_next += 4;
 281           n_left_from -= 4;
 282           n_left_to_next -= 4;
 283
 284           b0 = vlib_get_buffer (vm, bi0);
 285           b1 = vlib_get_buffer (vm, bi1);
 286           b2 = vlib_get_buffer (vm, bi2);
 287           b3 = vlib_get_buffer (vm, bi3);
 288
 289           /* RX interface handles */
 290           sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 291           sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
 292           sw_if_index2 = vnet_buffer (b2)->sw_if_index[VLIB_RX];
 293           sw_if_index3 = vnet_buffer (b3)->sw_if_index[VLIB_RX];
 294
 295           /* Process 4 x pkts */
 296
 297           h0 = vlib_buffer_get_current (b0);
 298           h1 = vlib_buffer_get_current (b1);
 299           h2 = vlib_buffer_get_current (b2);
 300           h3 = vlib_buffer_get_current (b3);
 301
 302           if (do_trace)
 303             {
 304               if (b0->flags & VLIB_BUFFER_IS_TRACED)
 305                 {
 306                   l2learn_trace_t *t =
 307                     vlib_add_trace (vm, node, b0, sizeof (*t));
 308                   t->sw_if_index = sw_if_index0;
 309                   t->bd_index = vnet_buffer (b0)->l2.bd_index;
 310                   clib_memcpy (t->src, h0->src_address, 6);
 311                   clib_memcpy (t->dst, h0->dst_address, 6);
 312                 }
 313               if (b1->flags & VLIB_BUFFER_IS_TRACED)
 314                 {
 315                   l2learn_trace_t *t =
 316                     vlib_add_trace (vm, node, b1, sizeof (*t));
 317                   t->sw_if_index = sw_if_index1;
 318                   t->bd_index = vnet_buffer (b1)->l2.bd_index;
 319                   clib_memcpy (t->src, h1->src_address, 6);
 320                   clib_memcpy (t->dst, h1->dst_address, 6);
 321                 }
 322               if (b2->flags & VLIB_BUFFER_IS_TRACED)
 323                 {
 324                   l2learn_trace_t *t =
 325                     vlib_add_trace (vm, node, b2, sizeof (*t));
 326                   t->sw_if_index = sw_if_index2;
 327                   t->bd_index = vnet_buffer (b2)->l2.bd_index;
 328                   clib_memcpy (t->src, h2->src_address, 6);
 329                   clib_memcpy (t->dst, h2->dst_address, 6);
 330                 }
 331               if (b3->flags & VLIB_BUFFER_IS_TRACED)
 332                 {
 333                   l2learn_trace_t *t =
 334                     vlib_add_trace (vm, node, b3, sizeof (*t));
 335                   t->sw_if_index = sw_if_index3;
 336                   t->bd_index = vnet_buffer (b3)->l2.bd_index;
 337                   clib_memcpy (t->src, h3->src_address, 6);
 338                   clib_memcpy (t->dst, h3->dst_address, 6);
 339                 }
 340             }
 341
 342           /* process 4 pkts */
 343           vlib_node_increment_counter (vm, l2learn_node.index,
 344                                        L2LEARN_ERROR_L2LEARN, 4);
 345
 346           l2fib_lookup_4 (msm->mac_table, &cached_key, &cached_result,
 347                           h0->src_address,
 348                           h1->src_address,
 349                           h2->src_address,
 350                           h3->src_address,
 351                           vnet_buffer (b0)->l2.bd_index,
 352                           vnet_buffer (b1)->l2.bd_index,
 353                           vnet_buffer (b2)->l2.bd_index,
 354                           vnet_buffer (b3)->l2.bd_index,
 355                           &key0, &key1, &key2, &key3,
 356                           &bucket0, &bucket1, &bucket2, &bucket3,
 357                           &result0, &result1, &result2, &result3);
 358
 359           l2learn_process (node, msm, &em->counters[node_counter_base_index],
 360                            b0, sw_if_index0, &key0, &cached_key,
 361                            &bucket0, &result0, &next0, timestamp);
 362
 363           l2learn_process (node, msm, &em->counters[node_counter_base_index],
 364                            b1, sw_if_index1, &key1, &cached_key,
 365                            &bucket1, &result1, &next1, timestamp);
 366
 367           l2learn_process (node, msm, &em->counters[node_counter_base_index],
 368                            b2, sw_if_index2, &key2, &cached_key,
 369                            &bucket2, &result2, &next2, timestamp);
 370
 371           l2learn_process (node, msm, &em->counters[node_counter_base_index],
 372                            b3, sw_if_index3, &key3, &cached_key,
 373                            &bucket3, &result3, &next3, timestamp);
 374
 375           /* verify speculative enqueues, maybe switch current next frame */
 376           /* if next0==next1==next_index then nothing special needs to be done */
 377           vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
 378                                            to_next, n_left_to_next,
 379                                            bi0, bi1, bi2, bi3,
 380                                            next0, next1, next2, next3);
 381         }
 382
 383       while (n_left_from > 0 && n_left_to_next > 0)
 384         {
 385           u32 bi0;
 386           vlib_buffer_t *b0;
 387           u32 next0;
 388           u32 sw_if_index0;
 389           ethernet_header_t *h0;
 390           l2fib_entry_key_t key0;
 391           l2fib_entry_result_t result0;
 392           u32 bucket0;
 393
 394           /* speculatively enqueue b0 to the current next frame */
 395           bi0 = from[0];
 396           to_next[0] = bi0;
 397           from += 1;
 398           to_next += 1;
 399           n_left_from -= 1;
 400           n_left_to_next -= 1;
 401
 402           b0 = vlib_get_buffer (vm, bi0);
 403
 404           sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 405
 406           h0 = vlib_buffer_get_current (b0);
 407
 408           if (do_trace && PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 409             {
 410               l2learn_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
 411               t->sw_if_index = sw_if_index0;
 412               t->bd_index = vnet_buffer (b0)->l2.bd_index;
 413               clib_memcpy (t->src, h0->src_address, 6);
 414               clib_memcpy (t->dst, h0->dst_address, 6);
 415             }
 416
 417           /* process 1 pkt */
 418           vlib_node_increment_counter (vm, l2learn_node.index,
 419                                        L2LEARN_ERROR_L2LEARN, 1);
 420
 421
 422           l2fib_lookup_1 (msm->mac_table, &cached_key, &cached_result,
 423                           h0->src_address, vnet_buffer (b0)->l2.bd_index,
 424                           &key0, &bucket0, &result0);
 425
 426           l2learn_process (node, msm, &em->counters[node_counter_base_index],
 427                            b0, sw_if_index0, &key0, &cached_key,
 428                            &bucket0, &result0, &next0, timestamp);
 429
 430           /* verify speculative enqueue, maybe switch current next frame */
 431           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 432                                            to_next, n_left_to_next,
 433                                            bi0, next0);
 434         }
 435
 436       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 437     }
 438
 439   return frame->n_vectors;
 440 }
 441
 442 static uword
 443 l2learn_node_fn (vlib_main_t * vm,
 444                  vlib_node_runtime_t * node, vlib_frame_t * frame)
 445 {
 446   if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
 447     return l2learn_node_inline (vm, node, frame, 1 /* do_trace */ );
 448   return l2learn_node_inline (vm, node, frame, 0 /* do_trace */ );
 449 }
 450
 451 /* *INDENT-OFF* */
 452 VLIB_REGISTER_NODE (l2learn_node,static) = {
 453   .function = l2learn_node_fn,
 454   .name = "l2-learn",
 455   .vector_size = sizeof (u32),
 456   .format_trace = format_l2learn_trace,
 457   .type = VLIB_NODE_TYPE_INTERNAL,
 458
 459   .n_errors = ARRAY_LEN(l2learn_error_strings),
 460   .error_strings = l2learn_error_strings,
 461
 462   .n_next_nodes = L2LEARN_N_NEXT,
 463
 464   /* edit / add dispositions here */
 465   .next_nodes = {
 466         [L2LEARN_NEXT_DROP] = "error-drop",
 467         [L2LEARN_NEXT_L2FWD] = "l2-fwd",
 468   },
 469 };
 470 /* *INDENT-ON* */
 471
 472 VLIB_NODE_FUNCTION_MULTIARCH (l2learn_node, l2learn_node_fn)
 473      clib_error_t *l2learn_init (vlib_main_t * vm)
 474 {
 475   l2learn_main_t *mp = &l2learn_main;
 476
 477   mp->vlib_main = vm;
 478   mp->vnet_main = vnet_get_main ();
 479
 480   /* Initialize the feature next-node indexes */
 481   feat_bitmap_init_next_nodes (vm,
 482                                l2learn_node.index,
 483                                L2INPUT_N_FEAT,
 484                                l2input_get_feat_names (),
 485                                mp->feat_next_node_index);
 486
 487   /* init the hash table ptr */
 488   mp->mac_table = get_mac_table ();
 489
 490   /*
 491    * Set the default number of dynamically learned macs to the number
 492    * of buckets.
 493    */
 494   mp->global_learn_limit = L2LEARN_DEFAULT_LIMIT;
 495
 496   return 0;
 497 }
 498
 499 VLIB_INIT_FUNCTION (l2learn_init);
 500
 501
 502 /**
 503  * Set subinterface learn enable/disable.
 504  * The CLI format is:
 505  *    set interface l2 learn <interface> [disable]
 506  */
 507 static clib_error_t *
 508 int_learn (vlib_main_t * vm,
 509            unformat_input_t * input, vlib_cli_command_t * cmd)
 510 {
 511   vnet_main_t *vnm = vnet_get_main ();
 512   clib_error_t *error = 0;
 513   u32 sw_if_index;
 514   u32 enable;
 515
 516   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 517     {
 518       error = clib_error_return (0, "unknown interface `%U'",
 519                                  format_unformat_error, input);
 520       goto done;
 521     }
 522
 523   enable = 1;
 524   if (unformat (input, "disable"))
 525     {
 526       enable = 0;
 527     }
 528
 529   /* set the interface flag */
 530   l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_LEARN, enable);
 531
 532 done:
 533   return error;
 534 }
 535
 536 /*?
 537  * Layer 2 learning can be enabled and disabled on each
 538  * interface and on each bridge-domain. Use this command to
 539  * manage interfaces. It is enabled by default.
 540  *
 541  * @cliexpar
 542  * Example of how to enable learning:
 543  * @cliexcmd{set interface l2 learn GigabitEthernet0/8/0}
 544  * Example of how to disable learning:
 545  * @cliexcmd{set interface l2 learn GigabitEthernet0/8/0 disable}
 546 ?*/
 547 /* *INDENT-OFF* */
 548 VLIB_CLI_COMMAND (int_learn_cli, static) = {
 549   .path = "set interface l2 learn",
 550   .short_help = "set interface l2 learn <interface> [disable]",
 551   .function = int_learn,
 552 };
 553 /* *INDENT-ON* */
 554
 555
 556 static clib_error_t *
 557 l2learn_config (vlib_main_t * vm, unformat_input_t * input)
 558 {
 559   l2learn_main_t *mp = &l2learn_main;
 560
 561   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 562     {
 563       if (unformat (input, "limit %d", &mp->global_learn_limit))
 564         ;
 565
 566       else
 567         return clib_error_return (0, "unknown input `%U'",
 568                                   format_unformat_error, input);
 569     }
 570
 571   return 0;
 572 }
 573
 574 VLIB_CONFIG_FUNCTION (l2learn_config, "l2learn");
 575
 576
 577 /*
 578  * fd.io coding-style-patch-verification: ON
 579  *
 580  * Local Variables:
 581  * eval: (c-set-style "gnu")
 582  * End:
 583  */