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   u32 feature_bitmap;
 120
 121   /* Set up the default next node (typically L2FWD) */
 122
 123   /* Remove ourself from the feature bitmap */
 124   feature_bitmap = vnet_buffer (b0)->l2.feature_bitmap & ~L2INPUT_FEAT_LEARN;
 125
 126   /* Save for next feature graph nodes */
 127   vnet_buffer (b0)->l2.feature_bitmap = feature_bitmap;
 128
 129   /* Determine the next node */
 130   *next0 = feat_bitmap_get_next_node_index (msm->feat_next_node_index,
 131                                             feature_bitmap);
 132
 133   /* Check mac table lookup result */
 134
 135   if (PREDICT_TRUE (result0->fields.sw_if_index == sw_if_index0))
 136     {
 137       /*
 138        * The entry was in the table, and the sw_if_index matched, the normal case
 139        */
 140       counter_base[L2LEARN_ERROR_HIT] += 1;
 141       if (PREDICT_FALSE (result0->fields.timestamp != timestamp))
 142         result0->fields.timestamp = timestamp;
 143       if (PREDICT_FALSE
 144           (result0->fields.sn.as_u16 != vnet_buffer (b0)->l2.l2fib_sn))
 145         result0->fields.sn.as_u16 = vnet_buffer (b0)->l2.l2fib_sn;
 146     }
 147   else if (result0->raw == ~0)
 148     {
 149
 150       /* The entry was not in table, so add it  */
 151
 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           goto done;
 162
 163         }
 164       else
 165         {
 166           BVT (clib_bihash_kv) kv;
 167           /* It is ok to learn */
 168
 169           result0->raw = 0;     /* clear all fields */
 170           result0->fields.sw_if_index = sw_if_index0;
 171           result0->fields.timestamp = timestamp;
 172           result0->fields.sn.as_u16 = vnet_buffer (b0)->l2.l2fib_sn;
 173           kv.key = key0->raw;
 174           kv.value = result0->raw;
 175
 176           BV (clib_bihash_add_del) (msm->mac_table, &kv, 1 /* is_add */ );
 177
 178           cached_key->raw = ~0; /* invalidate the cache */
 179           msm->global_learn_count++;
 180         }
 181
 182     }
 183   else
 184     {
 185
 186       /* The entry was in the table, but with the wrong sw_if_index mapping (mac move) */
 187       counter_base[L2LEARN_ERROR_MAC_MOVE] += 1;
 188
 189       if (result0->fields.static_mac)
 190         {
 191           /*
 192            * Don't overwrite a static mac
 193            * TODO: Check violation policy. For now drop the packet
 194            */
 195           b0->error = node->errors[L2LEARN_ERROR_MAC_MOVE_VIOLATE];
 196           *next0 = L2LEARN_NEXT_DROP;
 197         }
 198       else
 199         {
 200           /*
 201            * Update the entry
 202            * TODO: may want to rate limit mac moves
 203            * TODO: check global/bridge domain/interface learn limits
 204            */
 205           BVT (clib_bihash_kv) kv;
 206
 207           result0->raw = 0;     /* clear all fields */
 208           result0->fields.sw_if_index = sw_if_index0;
 209           result0->fields.timestamp = timestamp;
 210           result0->fields.sn.as_u16 = vnet_buffer (b0)->l2.l2fib_sn;
 211
 212           kv.key = key0->raw;
 213           kv.value = result0->raw;
 214
 215           cached_key->raw = ~0; /* invalidate the cache */
 216
 217           BV (clib_bihash_add_del) (msm->mac_table, &kv, 1 /* is_add */ );
 218         }
 219     }
 220
 221   if (result0->fields.filter)
 222     {
 223       /* drop packet because lookup matched a filter mac entry */
 224
 225       if (*next0 != L2LEARN_NEXT_DROP)
 226         {
 227           /* if we're not already dropping the packet, do it now */
 228           b0->error = node->errors[L2LEARN_ERROR_FILTER_DROP];
 229           *next0 = L2LEARN_NEXT_DROP;
 230         }
 231     }
 232
 233 done:
 234   return;
 235 }
 236
 237
 238 static_always_inline uword
 239 l2learn_node_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
 240                      vlib_frame_t * frame, int do_trace)
 241 {
 242   u32 n_left_from, *from, *to_next;
 243   l2learn_next_t next_index;
 244   l2learn_main_t *msm = &l2learn_main;
 245   vlib_node_t *n = vlib_get_node (vm, l2learn_node.index);
 246   u32 node_counter_base_index = n->error_heap_index;
 247   vlib_error_main_t *em = &vm->error_main;
 248   l2fib_entry_key_t cached_key;
 249   l2fib_entry_result_t cached_result;
 250   u8 timestamp = (u8) (vlib_time_now (vm) / 60);
 251
 252   from = vlib_frame_vector_args (frame);
 253   n_left_from = frame->n_vectors;       /* number of packets to process */
 254   next_index = node->cached_next_index;
 255
 256   /* Clear the one-entry cache in case mac table was updated */
 257   cached_key.raw = ~0;
 258   cached_result.raw = ~0;       /* warning be gone */
 259
 260   while (n_left_from > 0)
 261     {
 262       u32 n_left_to_next;
 263
 264       /* get space to enqueue frame to graph node "next_index" */
 265       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 266
 267       while (n_left_from >= 8 && n_left_to_next >= 4)
 268         {
 269           u32 bi0, bi1, bi2, bi3;
 270           vlib_buffer_t *b0, *b1, *b2, *b3;
 271           u32 next0, next1, next2, next3;
 272           u32 sw_if_index0, sw_if_index1, sw_if_index2, sw_if_index3;
 273           ethernet_header_t *h0, *h1, *h2, *h3;
 274           l2fib_entry_key_t key0, key1, key2, key3;
 275           l2fib_entry_result_t result0, result1, result2, result3;
 276           u32 bucket0, bucket1, bucket2, bucket3;
 277
 278           /* Prefetch next iteration. */
 279           {
 280             vlib_buffer_t *p4, *p5, *p6, *p7;;
 281
 282             p4 = vlib_get_buffer (vm, from[4]);
 283             p5 = vlib_get_buffer (vm, from[5]);
 284             p6 = vlib_get_buffer (vm, from[6]);
 285             p7 = vlib_get_buffer (vm, from[7]);
 286
 287             vlib_prefetch_buffer_header (p4, LOAD);
 288             vlib_prefetch_buffer_header (p5, LOAD);
 289             vlib_prefetch_buffer_header (p6, LOAD);
 290             vlib_prefetch_buffer_header (p7, LOAD);
 291
 292             CLIB_PREFETCH (p4->data, CLIB_CACHE_LINE_BYTES, STORE);
 293             CLIB_PREFETCH (p5->data, CLIB_CACHE_LINE_BYTES, STORE);
 294             CLIB_PREFETCH (p6->data, CLIB_CACHE_LINE_BYTES, STORE);
 295             CLIB_PREFETCH (p7->data, CLIB_CACHE_LINE_BYTES, STORE);
 296           }
 297
 298           /* speculatively enqueue b0 and b1 to the current next frame */
 299           /* bi is "buffer index", b is pointer to the buffer */
 300           to_next[0] = bi0 = from[0];
 301           to_next[1] = bi1 = from[1];
 302           to_next[2] = bi2 = from[2];
 303           to_next[3] = bi3 = from[3];
 304           from += 4;
 305           to_next += 4;
 306           n_left_from -= 4;
 307           n_left_to_next -= 4;
 308
 309           b0 = vlib_get_buffer (vm, bi0);
 310           b1 = vlib_get_buffer (vm, bi1);
 311           b2 = vlib_get_buffer (vm, bi2);
 312           b3 = vlib_get_buffer (vm, bi3);
 313
 314           /* RX interface handles */
 315           sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 316           sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
 317           sw_if_index2 = vnet_buffer (b2)->sw_if_index[VLIB_RX];
 318           sw_if_index3 = vnet_buffer (b3)->sw_if_index[VLIB_RX];
 319
 320           /* Process 4 x pkts */
 321
 322           h0 = vlib_buffer_get_current (b0);
 323           h1 = vlib_buffer_get_current (b1);
 324           h2 = vlib_buffer_get_current (b2);
 325           h3 = vlib_buffer_get_current (b3);
 326
 327           if (do_trace)
 328             {
 329               if (b0->flags & VLIB_BUFFER_IS_TRACED)
 330                 {
 331                   l2learn_trace_t *t =
 332                     vlib_add_trace (vm, node, b0, sizeof (*t));
 333                   t->sw_if_index = sw_if_index0;
 334                   t->bd_index = vnet_buffer (b0)->l2.bd_index;
 335                   clib_memcpy (t->src, h0->src_address, 6);
 336                   clib_memcpy (t->dst, h0->dst_address, 6);
 337                 }
 338               if (b1->flags & VLIB_BUFFER_IS_TRACED)
 339                 {
 340                   l2learn_trace_t *t =
 341                     vlib_add_trace (vm, node, b1, sizeof (*t));
 342                   t->sw_if_index = sw_if_index1;
 343                   t->bd_index = vnet_buffer (b1)->l2.bd_index;
 344                   clib_memcpy (t->src, h1->src_address, 6);
 345                   clib_memcpy (t->dst, h1->dst_address, 6);
 346                 }
 347               if (b2->flags & VLIB_BUFFER_IS_TRACED)
 348                 {
 349                   l2learn_trace_t *t =
 350                     vlib_add_trace (vm, node, b2, sizeof (*t));
 351                   t->sw_if_index = sw_if_index2;
 352                   t->bd_index = vnet_buffer (b2)->l2.bd_index;
 353                   clib_memcpy (t->src, h2->src_address, 6);
 354                   clib_memcpy (t->dst, h2->dst_address, 6);
 355                 }
 356               if (b3->flags & VLIB_BUFFER_IS_TRACED)
 357                 {
 358                   l2learn_trace_t *t =
 359                     vlib_add_trace (vm, node, b3, sizeof (*t));
 360                   t->sw_if_index = sw_if_index3;
 361                   t->bd_index = vnet_buffer (b3)->l2.bd_index;
 362                   clib_memcpy (t->src, h3->src_address, 6);
 363                   clib_memcpy (t->dst, h3->dst_address, 6);
 364                 }
 365             }
 366
 367           /* process 4 pkts */
 368           vlib_node_increment_counter (vm, l2learn_node.index,
 369                                        L2LEARN_ERROR_L2LEARN, 4);
 370
 371           l2fib_lookup_4 (msm->mac_table, &cached_key, &cached_result,
 372                           h0->src_address,
 373                           h1->src_address,
 374                           h2->src_address,
 375                           h3->src_address,
 376                           vnet_buffer (b0)->l2.bd_index,
 377                           vnet_buffer (b1)->l2.bd_index,
 378                           vnet_buffer (b2)->l2.bd_index,
 379                           vnet_buffer (b3)->l2.bd_index,
 380                           &key0, &key1, &key2, &key3,
 381                           &bucket0, &bucket1, &bucket2, &bucket3,
 382                           &result0, &result1, &result2, &result3);
 383
 384           l2learn_process (node, msm, &em->counters[node_counter_base_index],
 385                            b0, sw_if_index0, &key0, &cached_key,
 386                            &bucket0, &result0, &next0, timestamp);
 387
 388           l2learn_process (node, msm, &em->counters[node_counter_base_index],
 389                            b1, sw_if_index1, &key1, &cached_key,
 390                            &bucket1, &result1, &next1, timestamp);
 391
 392           l2learn_process (node, msm, &em->counters[node_counter_base_index],
 393                            b2, sw_if_index2, &key2, &cached_key,
 394                            &bucket2, &result2, &next2, timestamp);
 395
 396           l2learn_process (node, msm, &em->counters[node_counter_base_index],
 397                            b3, sw_if_index3, &key3, &cached_key,
 398                            &bucket3, &result3, &next3, timestamp);
 399
 400           /* verify speculative enqueues, maybe switch current next frame */
 401           /* if next0==next1==next_index then nothing special needs to be done */
 402           vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
 403                                            to_next, n_left_to_next,
 404                                            bi0, bi1, bi2, bi3,
 405                                            next0, next1, next2, next3);
 406         }
 407
 408       while (n_left_from > 0 && n_left_to_next > 0)
 409         {
 410           u32 bi0;
 411           vlib_buffer_t *b0;
 412           u32 next0;
 413           u32 sw_if_index0;
 414           ethernet_header_t *h0;
 415           l2fib_entry_key_t key0;
 416           l2fib_entry_result_t result0;
 417           u32 bucket0;
 418
 419           /* speculatively enqueue b0 to the current next frame */
 420           bi0 = from[0];
 421           to_next[0] = bi0;
 422           from += 1;
 423           to_next += 1;
 424           n_left_from -= 1;
 425           n_left_to_next -= 1;
 426
 427           b0 = vlib_get_buffer (vm, bi0);
 428
 429           sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
 430
 431           h0 = vlib_buffer_get_current (b0);
 432
 433           if (do_trace && PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
 434             {
 435               l2learn_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
 436               t->sw_if_index = sw_if_index0;
 437               t->bd_index = vnet_buffer (b0)->l2.bd_index;
 438               clib_memcpy (t->src, h0->src_address, 6);
 439               clib_memcpy (t->dst, h0->dst_address, 6);
 440             }
 441
 442           /* process 1 pkt */
 443           vlib_node_increment_counter (vm, l2learn_node.index,
 444                                        L2LEARN_ERROR_L2LEARN, 1);
 445
 446
 447           l2fib_lookup_1 (msm->mac_table, &cached_key, &cached_result,
 448                           h0->src_address, vnet_buffer (b0)->l2.bd_index,
 449                           &key0, &bucket0, &result0);
 450
 451           l2learn_process (node, msm, &em->counters[node_counter_base_index],
 452                            b0, sw_if_index0, &key0, &cached_key,
 453                            &bucket0, &result0, &next0, timestamp);
 454
 455           /* verify speculative enqueue, maybe switch current next frame */
 456           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 457                                            to_next, n_left_to_next,
 458                                            bi0, next0);
 459         }
 460
 461       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 462     }
 463
 464   return frame->n_vectors;
 465 }
 466
 467 static uword
 468 l2learn_node_fn (vlib_main_t * vm,
 469                  vlib_node_runtime_t * node, vlib_frame_t * frame)
 470 {
 471   if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
 472     return l2learn_node_inline (vm, node, frame, 1 /* do_trace */ );
 473   return l2learn_node_inline (vm, node, frame, 0 /* do_trace */ );
 474 }
 475
 476 /* *INDENT-OFF* */
 477 VLIB_REGISTER_NODE (l2learn_node,static) = {
 478   .function = l2learn_node_fn,
 479   .name = "l2-learn",
 480   .vector_size = sizeof (u32),
 481   .format_trace = format_l2learn_trace,
 482   .type = VLIB_NODE_TYPE_INTERNAL,
 483
 484   .n_errors = ARRAY_LEN(l2learn_error_strings),
 485   .error_strings = l2learn_error_strings,
 486
 487   .n_next_nodes = L2LEARN_N_NEXT,
 488
 489   /* edit / add dispositions here */
 490   .next_nodes = {
 491         [L2LEARN_NEXT_DROP] = "error-drop",
 492         [L2LEARN_NEXT_L2FWD] = "l2-fwd",
 493   },
 494 };
 495 /* *INDENT-ON* */
 496
 497 VLIB_NODE_FUNCTION_MULTIARCH (l2learn_node, l2learn_node_fn)
 498      clib_error_t *l2learn_init (vlib_main_t * vm)
 499 {
 500   l2learn_main_t *mp = &l2learn_main;
 501
 502   mp->vlib_main = vm;
 503   mp->vnet_main = vnet_get_main ();
 504
 505   /* Initialize the feature next-node indexes */
 506   feat_bitmap_init_next_nodes (vm,
 507                                l2learn_node.index,
 508                                L2INPUT_N_FEAT,
 509                                l2input_get_feat_names (),
 510                                mp->feat_next_node_index);
 511
 512   /* init the hash table ptr */
 513   mp->mac_table = get_mac_table ();
 514
 515   /*
 516    * Set the default number of dynamically learned macs to the number
 517    * of buckets.
 518    */
 519   mp->global_learn_limit = L2FIB_NUM_BUCKETS * 16;
 520
 521   return 0;
 522 }
 523
 524 VLIB_INIT_FUNCTION (l2learn_init);
 525
 526
 527 /**
 528  * Set subinterface learn enable/disable.
 529  * The CLI format is:
 530  *    set interface l2 learn <interface> [disable]
 531  */
 532 static clib_error_t *
 533 int_learn (vlib_main_t * vm,
 534            unformat_input_t * input, vlib_cli_command_t * cmd)
 535 {
 536   vnet_main_t *vnm = vnet_get_main ();
 537   clib_error_t *error = 0;
 538   u32 sw_if_index;
 539   u32 enable;
 540
 541   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 542     {
 543       error = clib_error_return (0, "unknown interface `%U'",
 544                                  format_unformat_error, input);
 545       goto done;
 546     }
 547
 548   enable = 1;
 549   if (unformat (input, "disable"))
 550     {
 551       enable = 0;
 552     }
 553
 554   /* set the interface flag */
 555   l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_LEARN, enable);
 556
 557 done:
 558   return error;
 559 }
 560
 561 /*?
 562  * Layer 2 learning can be enabled and disabled on each
 563  * interface and on each bridge-domain. Use this command to
 564  * manage interfaces. It is enabled by default.
 565  *
 566  * @cliexpar
 567  * Example of how to enable learning:
 568  * @cliexcmd{set interface l2 learn GigabitEthernet0/8/0}
 569  * Example of how to disable learning:
 570  * @cliexcmd{set interface l2 learn GigabitEthernet0/8/0 disable}
 571 ?*/
 572 /* *INDENT-OFF* */
 573 VLIB_CLI_COMMAND (int_learn_cli, static) = {
 574   .path = "set interface l2 learn",
 575   .short_help = "set interface l2 learn <interface> [disable]",
 576   .function = int_learn,
 577 };
 578 /* *INDENT-ON* */
 579
 580
 581 static clib_error_t *
 582 l2learn_config (vlib_main_t * vm, unformat_input_t * input)
 583 {
 584   l2learn_main_t *mp = &l2learn_main;
 585
 586   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 587     {
 588       if (unformat (input, "limit %d", &mp->global_learn_limit))
 589         ;
 590
 591       else
 592         return clib_error_return (0, "unknown input `%U'",
 593                                   format_unformat_error, input);
 594     }
 595
 596   return 0;
 597 }
 598
 599 VLIB_CONFIG_FUNCTION (l2learn_config, "l2learn");
 600
 601
 602 /*
 603  * fd.io coding-style-patch-verification: ON
 604  *
 605  * Local Variables:
 606  * eval: (c-set-style "gnu")
 607  * End:
 608  */