732a1fc5d8534fa764c984b46299e1a564029eb4
[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 #ifndef CLIB_MARCH_VARIANT
33 l2learn_main_t l2learn_main;
34 #endif
35
36 /**
37  * @file
38  * @brief Ethernet Bridge Learning.
39  *
40  * Populate the mac table with entries mapping the packet's source mac + bridge
41  * domain ID to the input sw_if_index.
42  *
43  * Note that learning and forwarding are separate graph nodes. This means that
44  * for a set of packets, all learning is performed first, then all nodes are
45  * forwarded. The forwarding is done based on the end-state of the mac table,
46  * instead of the state after each packet. Thus the forwarding results could
47  * differ in certain cases (mac move tests), but this not expected to cause
48  * problems in real-world networks. It is much simpler to separate learning
49  * and forwarding into separate nodes.
50  */
51
52
53 typedef struct
54 {
55   u8 src[6];
56   u8 dst[6];
57   u32 sw_if_index;
58   u16 bd_index;
59 } l2learn_trace_t;
60
61
62 /* packet trace format function */
63 static u8 *
64 format_l2learn_trace (u8 * s, va_list * args)
65 {
66   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
67   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
68   l2learn_trace_t *t = va_arg (*args, l2learn_trace_t *);
69
70   s = format (s, "l2-learn: sw_if_index %d dst %U src %U bd_index %d",
71               t->sw_if_index,
72               format_ethernet_address, t->dst,
73               format_ethernet_address, t->src, t->bd_index);
74   return s;
75 }
76
77 static vlib_node_registration_t l2learn_node;
78
79 #define foreach_l2learn_error                           \
80 _(L2LEARN,           "L2 learn packets")                \
81 _(MISS,              "L2 learn misses")                 \
82 _(MAC_MOVE,          "L2 mac moves")                    \
83 _(MAC_MOVE_VIOLATE,  "L2 mac move violations")          \
84 _(LIMIT,             "L2 not learned due to limit")     \
85 _(HIT_UPDATE,        "L2 learn hit updates")            \
86 _(FILTER_DROP,       "L2 filter mac drops")
87
88 typedef enum
89 {
90 #define _(sym,str) L2LEARN_ERROR_##sym,
91   foreach_l2learn_error
92 #undef _
93     L2LEARN_N_ERROR,
94 } l2learn_error_t;
95
96 static char *l2learn_error_strings[] = {
97 #define _(sym,string) string,
98   foreach_l2learn_error
99 #undef _
100 };
101
102 typedef enum
103 {
104   L2LEARN_NEXT_L2FWD,
105   L2LEARN_NEXT_DROP,
106   L2LEARN_N_NEXT,
107 } l2learn_next_t;
108
109
110 /** Perform learning on one packet based on the mac table lookup result. */
111
112 static_always_inline void
113 l2learn_process (vlib_node_runtime_t * node,
114                  l2learn_main_t * msm,
115                  u64 * counter_base,
116                  vlib_buffer_t * b0,
117                  u32 sw_if_index0,
118                  l2fib_entry_key_t * key0,
119                  l2fib_entry_key_t * cached_key,
120                  u32 * count,
121                  l2fib_entry_result_t * result0, u32 * next0, u8 timestamp)
122 {
123   /* Set up the default next node (typically L2FWD) */
124   *next0 = vnet_l2_feature_next (b0, msm->feat_next_node_index,
125                                  L2INPUT_FEAT_LEARN);
126
127   /* Check mac table lookup result */
128   if (PREDICT_TRUE (result0->fields.sw_if_index == sw_if_index0))
129     {
130       /* Entry in L2FIB with matching sw_if_index matched - normal fast path */
131       u32 dtime = timestamp - result0->fields.timestamp;
132       u32 dsn = result0->fields.sn.as_u16 - vnet_buffer (b0)->l2.l2fib_sn;
133       u32 check = (dtime && vnet_buffer (b0)->l2.bd_age) || dsn;
134
135       if (PREDICT_TRUE (check == 0))
136         return;                 /* MAC entry up to date */
137       if (l2fib_entry_result_is_set_AGE_NOT (result0))
138         return;                 /* Static MAC always age_not */
139       if (msm->global_learn_count > msm->global_learn_limit)
140         return;                 /* Above learn limit - do not update */
141
142       /* Limit updates per l2-learn node call to avoid prolonged update burst
143        * as dtime advance over 1 minute mark, unless more than 1 min behind
144        * or SN obsolete */
145       if ((*count > 2) && (dtime == 1) && (dsn == 0))
146         return;
147
148       counter_base[L2LEARN_ERROR_HIT_UPDATE] += 1;
149       *count += 1;
150     }
151   else if (result0->raw == ~0)
152     {
153       /* Entry not in L2FIB - add it  */
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           return;
164         }
165
166       /* Do not learn if mac is 0 */
167       l2fib_entry_key_t key = *key0;
168       key.fields.bd_index = 0;
169       if (key.raw == 0)
170         return;
171
172       /* It is ok to learn */
173       msm->global_learn_count++;
174       result0->raw = 0;         /* clear all fields */
175       result0->fields.sw_if_index = sw_if_index0;
176       if (msm->client_pid != 0)
177         l2fib_entry_result_set_LRN_EVT (result0);
178       else
179         l2fib_entry_result_clear_LRN_EVT (result0);
180     }
181   else
182     {
183       /* Entry in L2FIB with different sw_if_index - mac move or filter */
184       if (l2fib_entry_result_is_set_FILTER (result0))
185         {
186           ASSERT (result0->fields.sw_if_index == ~0);
187           /* drop packet because lookup matched a filter mac entry */
188           b0->error = node->errors[L2LEARN_ERROR_FILTER_DROP];
189           *next0 = L2LEARN_NEXT_DROP;
190           return;
191         }
192
193       if (l2fib_entry_result_is_set_STATIC (result0))
194         {
195           /*
196            * Don't overwrite a static mac
197            * TODO: Check violation policy. For now drop the packet
198            */
199           b0->error = node->errors[L2LEARN_ERROR_MAC_MOVE_VIOLATE];
200           *next0 = L2LEARN_NEXT_DROP;
201           return;
202         }
203
204       /*
205        * TODO: may want to rate limit mac moves
206        * TODO: check global/bridge domain/interface learn limits
207        */
208       result0->fields.sw_if_index = sw_if_index0;
209       if (l2fib_entry_result_is_set_AGE_NOT (result0))
210         {
211           /* The mac was provisioned */
212           msm->global_learn_count++;
213           l2fib_entry_result_clear_AGE_NOT (result0);
214         }
215       if (msm->client_pid != 0)
216         l2fib_entry_result_set_bits (result0,
217                                      (L2FIB_ENTRY_RESULT_FLAG_LRN_EVT |
218                                       L2FIB_ENTRY_RESULT_FLAG_LRN_MOV));
219       else
220         l2fib_entry_result_clear_bits (result0,
221                                        (L2FIB_ENTRY_RESULT_FLAG_LRN_EVT |
222                                         L2FIB_ENTRY_RESULT_FLAG_LRN_MOV));
223       counter_base[L2LEARN_ERROR_MAC_MOVE] += 1;
224     }
225
226   /* Update the entry */
227   result0->fields.timestamp = timestamp;
228   result0->fields.sn.as_u16 = vnet_buffer (b0)->l2.l2fib_sn;
229
230   BVT (clib_bihash_kv) kv;
231   kv.key = key0->raw;
232   kv.value = result0->raw;
233   BV (clib_bihash_add_del) (msm->mac_table, &kv, 1 /* is_add */ );
234
235   /* Invalidate the cache */
236   cached_key->raw = ~0;
237 }
238
239
240 static_always_inline uword
241 l2learn_node_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
242                      vlib_frame_t * frame, int do_trace)
243 {
244   u32 n_left_from, *from, *to_next;
245   l2learn_next_t next_index;
246   l2learn_main_t *msm = &l2learn_main;
247   vlib_node_t *n = vlib_get_node (vm, l2learn_node.index);
248   u32 node_counter_base_index = n->error_heap_index;
249   vlib_error_main_t *em = &vm->error_main;
250   l2fib_entry_key_t cached_key;
251   l2fib_entry_result_t cached_result;
252   u8 timestamp = (u8) (vlib_time_now (vm) / 60);
253   u32 count = 0;
254
255   from = vlib_frame_vector_args (frame);
256   n_left_from = frame->n_vectors;       /* number of packets to process */
257   next_index = node->cached_next_index;
258
259   /* Clear the one-entry cache in case mac table was updated */
260   cached_key.raw = ~0;
261   cached_result.raw = ~0;       /* warning be gone */
262
263   while (n_left_from > 0)
264     {
265       u32 n_left_to_next;
266
267       /* get space to enqueue frame to graph node "next_index" */
268       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
269
270       while (n_left_from >= 8 && n_left_to_next >= 4)
271         {
272           u32 bi0, bi1, bi2, bi3;
273           vlib_buffer_t *b0, *b1, *b2, *b3;
274           u32 next0, next1, next2, next3;
275           u32 sw_if_index0, sw_if_index1, sw_if_index2, sw_if_index3;
276           const ethernet_header_t *h0, *h1, *h2, *h3;
277           l2fib_entry_key_t key0, key1, key2, key3;
278           l2fib_entry_result_t result0, result1, result2, result3;
279           u32 bucket0, bucket1, bucket2, bucket3;
280
281           /* Prefetch next iteration. */
282           {
283             vlib_buffer_t *p4, *p5, *p6, *p7;;
284
285             p4 = vlib_get_buffer (vm, from[4]);
286             p5 = vlib_get_buffer (vm, from[5]);
287             p6 = vlib_get_buffer (vm, from[6]);
288             p7 = vlib_get_buffer (vm, from[7]);
289
290             /* buffer header is read and written, so use LOAD
291              * prefetch */
292             vlib_prefetch_buffer_header (p4, LOAD);
293             vlib_prefetch_buffer_header (p5, LOAD);
294             vlib_prefetch_buffer_header (p6, LOAD);
295             vlib_prefetch_buffer_header (p7, LOAD);
296
297             CLIB_PREFETCH (p4->data, CLIB_CACHE_LINE_BYTES, LOAD);
298             CLIB_PREFETCH (p5->data, CLIB_CACHE_LINE_BYTES, LOAD);
299             CLIB_PREFETCH (p6->data, CLIB_CACHE_LINE_BYTES, LOAD);
300             CLIB_PREFETCH (p7->data, CLIB_CACHE_LINE_BYTES, LOAD);
301           }
302
303           /* speculatively enqueue b0 and b1 to the current next frame */
304           /* bi is "buffer index", b is pointer to the buffer */
305           to_next[0] = bi0 = from[0];
306           to_next[1] = bi1 = from[1];
307           to_next[2] = bi2 = from[2];
308           to_next[3] = bi3 = from[3];
309           from += 4;
310           to_next += 4;
311           n_left_from -= 4;
312           n_left_to_next -= 4;
313
314           b0 = vlib_get_buffer (vm, bi0);
315           b1 = vlib_get_buffer (vm, bi1);
316           b2 = vlib_get_buffer (vm, bi2);
317           b3 = vlib_get_buffer (vm, bi3);
318
319           /* RX interface handles */
320           sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
321           sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
322           sw_if_index2 = vnet_buffer (b2)->sw_if_index[VLIB_RX];
323           sw_if_index3 = vnet_buffer (b3)->sw_if_index[VLIB_RX];
324
325           /* Process 4 x pkts */
326
327           h0 = vlib_buffer_get_current (b0);
328           h1 = vlib_buffer_get_current (b1);
329           h2 = vlib_buffer_get_current (b2);
330           h3 = vlib_buffer_get_current (b3);
331
332           if (do_trace)
333             {
334               if (b0->flags & VLIB_BUFFER_IS_TRACED)
335                 {
336                   l2learn_trace_t *t =
337                     vlib_add_trace (vm, node, b0, sizeof (*t));
338                   t->sw_if_index = sw_if_index0;
339                   t->bd_index = vnet_buffer (b0)->l2.bd_index;
340                   clib_memcpy (t->src, h0->src_address, 6);
341                   clib_memcpy (t->dst, h0->dst_address, 6);
342                 }
343               if (b1->flags & VLIB_BUFFER_IS_TRACED)
344                 {
345                   l2learn_trace_t *t =
346                     vlib_add_trace (vm, node, b1, sizeof (*t));
347                   t->sw_if_index = sw_if_index1;
348                   t->bd_index = vnet_buffer (b1)->l2.bd_index;
349                   clib_memcpy (t->src, h1->src_address, 6);
350                   clib_memcpy (t->dst, h1->dst_address, 6);
351                 }
352               if (b2->flags & VLIB_BUFFER_IS_TRACED)
353                 {
354                   l2learn_trace_t *t =
355                     vlib_add_trace (vm, node, b2, sizeof (*t));
356                   t->sw_if_index = sw_if_index2;
357                   t->bd_index = vnet_buffer (b2)->l2.bd_index;
358                   clib_memcpy (t->src, h2->src_address, 6);
359                   clib_memcpy (t->dst, h2->dst_address, 6);
360                 }
361               if (b3->flags & VLIB_BUFFER_IS_TRACED)
362                 {
363                   l2learn_trace_t *t =
364                     vlib_add_trace (vm, node, b3, sizeof (*t));
365                   t->sw_if_index = sw_if_index3;
366                   t->bd_index = vnet_buffer (b3)->l2.bd_index;
367                   clib_memcpy (t->src, h3->src_address, 6);
368                   clib_memcpy (t->dst, h3->dst_address, 6);
369                 }
370             }
371
372           /* process 4 pkts */
373           vlib_node_increment_counter (vm, l2learn_node.index,
374                                        L2LEARN_ERROR_L2LEARN, 4);
375
376           l2fib_lookup_4 (msm->mac_table, &cached_key, &cached_result,
377                           h0->src_address,
378                           h1->src_address,
379                           h2->src_address,
380                           h3->src_address,
381                           vnet_buffer (b0)->l2.bd_index,
382                           vnet_buffer (b1)->l2.bd_index,
383                           vnet_buffer (b2)->l2.bd_index,
384                           vnet_buffer (b3)->l2.bd_index,
385                           &key0, &key1, &key2, &key3,
386                           &bucket0, &bucket1, &bucket2, &bucket3,
387                           &result0, &result1, &result2, &result3);
388
389           l2learn_process (node, msm, &em->counters[node_counter_base_index],
390                            b0, sw_if_index0, &key0, &cached_key,
391                            &count, &result0, &next0, timestamp);
392
393           l2learn_process (node, msm, &em->counters[node_counter_base_index],
394                            b1, sw_if_index1, &key1, &cached_key,
395                            &count, &result1, &next1, timestamp);
396
397           l2learn_process (node, msm, &em->counters[node_counter_base_index],
398                            b2, sw_if_index2, &key2, &cached_key,
399                            &count, &result2, &next2, timestamp);
400
401           l2learn_process (node, msm, &em->counters[node_counter_base_index],
402                            b3, sw_if_index3, &key3, &cached_key,
403                            &count, &result3, &next3, timestamp);
404
405           /* verify speculative enqueues, maybe switch current next frame */
406           /* if next0==next1==next_index then nothing special needs to be done */
407           vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
408                                            to_next, n_left_to_next,
409                                            bi0, bi1, bi2, bi3,
410                                            next0, next1, next2, next3);
411         }
412
413       while (n_left_from > 0 && n_left_to_next > 0)
414         {
415           u32 bi0;
416           vlib_buffer_t *b0;
417           u32 next0;
418           u32 sw_if_index0;
419           ethernet_header_t *h0;
420           l2fib_entry_key_t key0;
421           l2fib_entry_result_t result0;
422           u32 bucket0;
423
424           /* speculatively enqueue b0 to the current next frame */
425           bi0 = from[0];
426           to_next[0] = bi0;
427           from += 1;
428           to_next += 1;
429           n_left_from -= 1;
430           n_left_to_next -= 1;
431
432           b0 = vlib_get_buffer (vm, bi0);
433
434           sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
435
436           h0 = vlib_buffer_get_current (b0);
437
438           if (do_trace && PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
439             {
440               l2learn_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
441               t->sw_if_index = sw_if_index0;
442               t->bd_index = vnet_buffer (b0)->l2.bd_index;
443               clib_memcpy (t->src, h0->src_address, 6);
444               clib_memcpy (t->dst, h0->dst_address, 6);
445             }
446
447           /* process 1 pkt */
448           vlib_node_increment_counter (vm, l2learn_node.index,
449                                        L2LEARN_ERROR_L2LEARN, 1);
450
451
452           l2fib_lookup_1 (msm->mac_table, &cached_key, &cached_result,
453                           h0->src_address, vnet_buffer (b0)->l2.bd_index,
454                           &key0, &bucket0, &result0);
455
456           l2learn_process (node, msm, &em->counters[node_counter_base_index],
457                            b0, sw_if_index0, &key0, &cached_key,
458                            &count, &result0, &next0, timestamp);
459
460           /* verify speculative enqueue, maybe switch current next frame */
461           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
462                                            to_next, n_left_to_next,
463                                            bi0, next0);
464         }
465
466       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
467     }
468
469   return frame->n_vectors;
470 }
471
472 VLIB_NODE_FN (l2learn_node) (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   .name = "l2-learn",
483   .vector_size = sizeof (u32),
484   .format_trace = format_l2learn_trace,
485   .type = VLIB_NODE_TYPE_INTERNAL,
486
487   .n_errors = ARRAY_LEN(l2learn_error_strings),
488   .error_strings = l2learn_error_strings,
489
490   .n_next_nodes = L2LEARN_N_NEXT,
491
492   /* edit / add dispositions here */
493   .next_nodes = {
494         [L2LEARN_NEXT_DROP] = "error-drop",
495         [L2LEARN_NEXT_L2FWD] = "l2-fwd",
496   },
497 };
498 /* *INDENT-ON* */
499
500 #ifndef CLIB_MARCH_VARIANT
501 clib_error_t *
502 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 = L2LEARN_DEFAULT_LIMIT;
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 #endif
606
607
608 /*
609  * fd.io coding-style-patch-verification: ON
610  *
611  * Local Variables:
612  * eval: (c-set-style "gnu")
613  * End:
614  */