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