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