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