Typos. A bunch of typos I've been collecting.
[vpp.git] / src / vnet / adj / adj.c
1 /*
2  * Copyright (c) 2016 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #include <vnet/adj/adj.h>
17 #include <vnet/adj/adj_internal.h>
18 #include <vnet/adj/adj_glean.h>
19 #include <vnet/adj/adj_midchain.h>
20 #include <vnet/adj/adj_mcast.h>
21 #include <vnet/adj/adj_delegate.h>
22 #include <vnet/fib/fib_node_list.h>
23
24 /* Adjacency packet/byte counters indexed by adjacency index. */
25 vlib_combined_counter_main_t adjacency_counters = {
26     .name = "adjacency",
27     .stat_segment_name = "/net/adjacency",
28 };
29
30 /*
31  * the single adj pool
32  */
33 ip_adjacency_t *adj_pool;
34
35 /**
36  * @brief Global Config for enabling per-adjacency counters.
37  * By default these are disabled.
38  */
39 int adj_per_adj_counters;
40
41 const ip46_address_t ADJ_BCAST_ADDR = {
42     .ip6 = {
43         .as_u64[0] = 0xffffffffffffffff,
44         .as_u64[1] = 0xffffffffffffffff,
45     },
46 };
47
48 /**
49  * Adj flag names
50  */
51 static const char *adj_attr_names[] = ADJ_ATTR_NAMES;
52
53 always_inline void
54 adj_poison (ip_adjacency_t * adj)
55 {
56     if (CLIB_DEBUG > 0)
57     {
58         clib_memset (adj, 0xfe, sizeof (adj[0]));
59     }
60 }
61
62 ip_adjacency_t *
63 adj_alloc (fib_protocol_t proto)
64 {
65     ip_adjacency_t *adj;
66
67     pool_get_aligned(adj_pool, adj, CLIB_CACHE_LINE_BYTES);
68
69     adj_poison(adj);
70
71     /* Make sure certain fields are always initialized. */
72     /* Validate adjacency counters. */
73     vlib_validate_combined_counter(&adjacency_counters,
74                                    adj_get_index(adj));
75     vlib_zero_combined_counter(&adjacency_counters,
76                                adj_get_index(adj));
77     fib_node_init(&adj->ia_node,
78                   FIB_NODE_TYPE_ADJ);
79
80     adj->ia_nh_proto = proto;
81     adj->ia_flags = 0;
82     adj->rewrite_header.sw_if_index = ~0;
83     adj->rewrite_header.flags = 0;
84     adj->lookup_next_index = 0;
85     adj->ia_delegates = NULL;
86
87     /* lest it become a midchain in the future */
88     clib_memset(&adj->sub_type.midchain.next_dpo, 0,
89            sizeof(adj->sub_type.midchain.next_dpo));
90
91     return (adj);
92 }
93
94 static int
95 adj_index_is_special (adj_index_t adj_index)
96 {
97     if (ADJ_INDEX_INVALID == adj_index)
98         return (!0);
99
100     return (0);
101 }
102
103 u8*
104 format_adj_flags (u8 * s, va_list * args)
105 {
106     adj_flags_t af;
107     adj_attr_t at;
108
109     af = va_arg (*args, int);
110
111     if (ADJ_FLAG_NONE == af)
112     {
113         return (format(s, "None"));
114     }
115     FOR_EACH_ADJ_ATTR(at)
116     {
117         if (af & (1 << at))
118         {
119             s = format(s, "%s ", adj_attr_names[at]);
120         }
121     }
122     return (s);
123 }
124
125 /**
126  * @brief Pretty print helper function for formatting specific adjacencies.
127  * @param s - input string to format
128  * @param args - other args passed to format function such as:
129  *                 - vnet_main_t
130  *                 - ip_lookup_main_t
131  *                 - adj_index
132  */
133 u8 *
134 format_ip_adjacency (u8 * s, va_list * args)
135 {
136     format_ip_adjacency_flags_t fiaf;
137     ip_adjacency_t * adj;
138     u32 adj_index;
139
140     adj_index = va_arg (*args, u32);
141     fiaf = va_arg (*args, format_ip_adjacency_flags_t);
142     adj = adj_get(adj_index);
143
144     switch (adj->lookup_next_index)
145     {
146     case IP_LOOKUP_NEXT_REWRITE:
147     case IP_LOOKUP_NEXT_BCAST:
148         s = format (s, "%U", format_adj_nbr, adj_index, 0);
149         break;
150     case IP_LOOKUP_NEXT_ARP:
151         s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
152         break;
153     case IP_LOOKUP_NEXT_GLEAN:
154         s = format (s, "%U", format_adj_glean, adj_index, 0);
155         break;
156     case IP_LOOKUP_NEXT_MIDCHAIN:
157         s = format (s, "%U", format_adj_midchain, adj_index, 2);
158         break;
159     case IP_LOOKUP_NEXT_MCAST:
160         s = format (s, "%U", format_adj_mcast, adj_index, 0);
161         break;
162     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
163         s = format (s, "%U", format_adj_mcast_midchain, adj_index, 0);
164         break;
165     case IP_LOOKUP_NEXT_DROP:
166     case IP_LOOKUP_NEXT_PUNT:
167     case IP_LOOKUP_NEXT_LOCAL:
168     case IP_LOOKUP_NEXT_ICMP_ERROR:
169     case IP_LOOKUP_N_NEXT:
170         break;
171     }
172
173     if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
174     {
175         vlib_counter_t counts;
176
177         vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
178         s = format (s, "\n   flags:%U", format_adj_flags, adj->ia_flags);
179         s = format (s, "\n   counts:[%Ld:%Ld]", counts.packets, counts.bytes);
180         s = format (s, "\n   locks:%d", adj->ia_node.fn_locks);
181         s = format(s, "\n delegates:\n  ");
182         adj_delegate_format(s, adj);
183
184         s = format(s, "\n children:");
185         if (fib_node_list_get_size(adj->ia_node.fn_children))
186         {
187             s = format(s, "\n  ");
188             s = fib_node_children_format(adj->ia_node.fn_children, s);
189         }
190     }
191
192     return s;
193 }
194
195 int
196 adj_recursive_loop_detect (adj_index_t ai,
197                            fib_node_index_t **entry_indicies)
198 {
199     ip_adjacency_t * adj;
200
201     adj = adj_get(ai);
202
203     switch (adj->lookup_next_index)
204     {
205     case IP_LOOKUP_NEXT_REWRITE:
206     case IP_LOOKUP_NEXT_ARP:
207     case IP_LOOKUP_NEXT_GLEAN:
208     case IP_LOOKUP_NEXT_MCAST:
209     case IP_LOOKUP_NEXT_BCAST:
210     case IP_LOOKUP_NEXT_DROP:
211     case IP_LOOKUP_NEXT_PUNT:
212     case IP_LOOKUP_NEXT_LOCAL:
213     case IP_LOOKUP_NEXT_ICMP_ERROR:
214     case IP_LOOKUP_N_NEXT:
215         /*
216          * these adjacency types are terminal graph nodes, so there's no
217          * possibility of a loop down here.
218          */
219         break;
220     case IP_LOOKUP_NEXT_MIDCHAIN:
221     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
222         return (adj_ndr_midchain_recursive_loop_detect(ai, entry_indicies));
223     }
224
225     return (0);
226 }
227
228 /*
229  * adj_last_lock_gone
230  *
231  * last lock/reference to the adj has gone, we no longer need it.
232  */
233 static void
234 adj_last_lock_gone (ip_adjacency_t *adj)
235 {
236     vlib_main_t * vm = vlib_get_main();
237
238     ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
239     ADJ_DBG(adj, "last-lock-gone");
240
241     adj_delegate_adj_deleted(adj);
242
243     vlib_worker_thread_barrier_sync (vm);
244
245     switch (adj->lookup_next_index)
246     {
247     case IP_LOOKUP_NEXT_MIDCHAIN:
248         dpo_reset(&adj->sub_type.midchain.next_dpo);
249         /* FALL THROUGH */
250     case IP_LOOKUP_NEXT_ARP:
251     case IP_LOOKUP_NEXT_REWRITE:
252     case IP_LOOKUP_NEXT_BCAST:
253         /*
254          * complete and incomplete nbr adjs
255          */
256         adj_nbr_remove(adj_get_index(adj),
257                        adj->ia_nh_proto,
258                        adj->ia_link,
259                        &adj->sub_type.nbr.next_hop,
260                        adj->rewrite_header.sw_if_index);
261         break;
262     case IP_LOOKUP_NEXT_GLEAN:
263         adj_glean_remove(adj->ia_nh_proto,
264                          adj->rewrite_header.sw_if_index);
265         break;
266     case IP_LOOKUP_NEXT_MCAST:
267     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
268         adj_mcast_remove(adj->ia_nh_proto,
269                          adj->rewrite_header.sw_if_index);
270         break;
271     case IP_LOOKUP_NEXT_DROP:
272     case IP_LOOKUP_NEXT_PUNT:
273     case IP_LOOKUP_NEXT_LOCAL:
274     case IP_LOOKUP_NEXT_ICMP_ERROR:
275     case IP_LOOKUP_N_NEXT:
276         /*
277          * type not stored in any DB from which we need to remove it
278          */
279         break;
280     }
281
282     vlib_worker_thread_barrier_release(vm);
283
284     fib_node_deinit(&adj->ia_node);
285     ASSERT(0 == vec_len(adj->ia_delegates));
286     vec_free(adj->ia_delegates);
287     pool_put(adj_pool, adj);
288 }
289
290 u32
291 adj_dpo_get_urpf (const dpo_id_t *dpo)
292 {
293     ip_adjacency_t *adj;
294
295     adj = adj_get(dpo->dpoi_index);
296
297     return (adj->rewrite_header.sw_if_index);
298 }
299
300 void
301 adj_lock (adj_index_t adj_index)
302 {
303     ip_adjacency_t *adj;
304
305     if (adj_index_is_special(adj_index))
306     {
307         return;
308     }
309
310     adj = adj_get(adj_index);
311     ASSERT(adj);
312
313     ADJ_DBG(adj, "lock");
314     fib_node_lock(&adj->ia_node);
315 }
316
317 void
318 adj_unlock (adj_index_t adj_index)
319 {
320     ip_adjacency_t *adj;
321
322     if (adj_index_is_special(adj_index))
323     {
324         return;
325     }
326
327     adj = adj_get(adj_index);
328     ASSERT(adj);
329
330     ADJ_DBG(adj, "unlock");
331     ASSERT(adj);
332
333     fib_node_unlock(&adj->ia_node);
334 }
335
336 u32
337 adj_child_add (adj_index_t adj_index,
338                fib_node_type_t child_type,
339                fib_node_index_t child_index)
340 {
341     ASSERT(ADJ_INDEX_INVALID != adj_index);
342     if (adj_index_is_special(adj_index))
343     {
344         return (~0);
345     }
346
347     return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
348                                adj_index,
349                                child_type,
350                                child_index));
351 }
352
353 void
354 adj_child_remove (adj_index_t adj_index,
355                   u32 sibling_index)
356 {
357     if (adj_index_is_special(adj_index))
358     {
359         return;
360     }
361
362     fib_node_child_remove(FIB_NODE_TYPE_ADJ,
363                           adj_index,
364                           sibling_index);
365 }
366
367 /*
368  * Context for the walk to update the cached feature flags.
369  */
370 typedef struct adj_feature_update_t_
371 {
372     u8 arc;
373     u8 enable;
374 } adj_feature_update_ctx_t;
375
376 static adj_walk_rc_t
377 adj_feature_update_walk_cb (adj_index_t ai,
378                             void *arg)
379 {
380     adj_feature_update_ctx_t *ctx = arg;
381     ip_adjacency_t *adj;
382
383     adj = adj_get(ai);
384
385     /*
386      * this ugly mess matches the feature arc that is changing with affected
387      * adjacencies
388      */
389     if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
390          (VNET_LINK_IP6 == adj->ia_link)) ||
391         ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
392          (VNET_LINK_IP4 == adj->ia_link)) ||
393         ((ctx->arc == mpls_main.output_feature_arc_index) &&
394          (VNET_LINK_MPLS == adj->ia_link)))
395     {
396         if (ctx->enable)
397             adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
398         else
399             adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
400     }
401     return (ADJ_WALK_RC_CONTINUE);
402 }
403
404 void
405 adj_feature_update (u32 sw_if_index,
406                     u8 arc_index,
407                     u8 is_enable)
408 {
409     /*
410      * Walk all the adjacencies on the interface to update the cached
411      * 'has-features' flag
412      */
413     adj_feature_update_ctx_t ctx = {
414         .arc = arc_index,
415         .enable = is_enable,
416     };
417     adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
418 }
419
420 static adj_walk_rc_t
421 adj_mtu_update_walk_cb (adj_index_t ai,
422                         void *arg)
423 {
424     ip_adjacency_t *adj;
425
426     adj = adj_get(ai);
427
428     vnet_rewrite_update_mtu (vnet_get_main(), adj->ia_link,
429                              &adj->rewrite_header);
430
431     return (ADJ_WALK_RC_CONTINUE);
432 }
433
434 static clib_error_t *
435 adj_mtu_update (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
436 {
437   adj_walk (sw_if_index, adj_mtu_update_walk_cb, NULL);
438
439   return (NULL);
440 }
441
442 VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(adj_mtu_update);
443
444 /**
445  * @brief Walk the Adjacencies on a given interface
446  */
447 void
448 adj_walk (u32 sw_if_index,
449           adj_walk_cb_t cb,
450           void *ctx)
451 {
452     /*
453      * walk all the neighbor adjacencies
454      */
455     fib_protocol_t proto;
456
457     FOR_EACH_FIB_IP_PROTOCOL(proto)
458     {
459         adj_nbr_walk(sw_if_index, proto, cb, ctx);
460         adj_mcast_walk(sw_if_index, proto, cb, ctx);
461     }
462 }
463
464 /**
465  * @brief Return the link type of the adjacency
466  */
467 vnet_link_t
468 adj_get_link_type (adj_index_t ai)
469 {
470     const ip_adjacency_t *adj;
471
472     adj = adj_get(ai);
473
474     return (adj->ia_link);
475 }
476
477 /**
478  * @brief Return the sw interface index of the adjacency.
479  */
480 u32
481 adj_get_sw_if_index (adj_index_t ai)
482 {
483     const ip_adjacency_t *adj;
484
485     adj = adj_get(ai);
486
487     return (adj->rewrite_header.sw_if_index);
488 }
489
490 /**
491  * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
492  * 0 is down, !0 is up.
493  */
494 int
495 adj_is_up (adj_index_t ai)
496 {
497     return (adj_bfd_is_up(ai));
498 }
499
500 /**
501  * @brief Return the rewrite string of the adjacency
502  */
503 const u8*
504 adj_get_rewrite (adj_index_t ai)
505 {
506     vnet_rewrite_header_t *rw;
507     ip_adjacency_t *adj;
508
509     adj = adj_get(ai);
510     rw = &adj->rewrite_header;
511
512     ASSERT (rw->data_bytes != 0xfefe);
513
514     return (rw->data - rw->data_bytes);
515 }
516
517 static fib_node_t *
518 adj_get_node (fib_node_index_t index)
519 {
520     ip_adjacency_t *adj;
521
522     adj = adj_get(index);
523
524     return (&adj->ia_node);
525 }
526
527 #define ADJ_FROM_NODE(_node)                                            \
528     ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
529
530 static void
531 adj_node_last_lock_gone (fib_node_t *node)
532 {
533     adj_last_lock_gone(ADJ_FROM_NODE(node));
534 }
535
536 static fib_node_back_walk_rc_t
537 adj_back_walk_notify (fib_node_t *node,
538                       fib_node_back_walk_ctx_t *ctx)
539 {
540     ip_adjacency_t *adj;
541
542     adj = ADJ_FROM_NODE(node);
543
544     switch (adj->lookup_next_index)
545     {
546     case IP_LOOKUP_NEXT_MIDCHAIN:
547         adj_midchain_delegate_restack(adj_get_index(adj));
548         break;
549     case IP_LOOKUP_NEXT_ARP:
550     case IP_LOOKUP_NEXT_REWRITE:
551     case IP_LOOKUP_NEXT_BCAST:
552     case IP_LOOKUP_NEXT_GLEAN:
553     case IP_LOOKUP_NEXT_MCAST:
554     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
555     case IP_LOOKUP_NEXT_DROP:
556     case IP_LOOKUP_NEXT_PUNT:
557     case IP_LOOKUP_NEXT_LOCAL:
558     case IP_LOOKUP_NEXT_ICMP_ERROR:
559     case IP_LOOKUP_N_NEXT:
560         /*
561          * Que pasa. yo soj en el final!
562          */
563         ASSERT(0);
564         break;
565     }
566
567     return (FIB_NODE_BACK_WALK_CONTINUE);
568 }
569
570 /*
571  * Adjacency's graph node virtual function table
572  */
573 static const fib_node_vft_t adj_vft = {
574     .fnv_get = adj_get_node,
575     .fnv_last_lock = adj_node_last_lock_gone,
576     .fnv_back_walk = adj_back_walk_notify,
577 };
578
579 static clib_error_t *
580 adj_module_init (vlib_main_t * vm)
581 {
582     fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
583
584     adj_nbr_module_init();
585     adj_glean_module_init();
586     adj_midchain_module_init();
587     adj_mcast_module_init();
588
589     return (NULL);
590 }
591
592 VLIB_INIT_FUNCTION (adj_module_init);
593
594 static clib_error_t *
595 adj_show (vlib_main_t * vm,
596           unformat_input_t * input,
597           vlib_cli_command_t * cmd)
598 {
599     adj_index_t ai = ADJ_INDEX_INVALID;
600     u32 sw_if_index = ~0;
601     int summary = 0;
602
603     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
604     {
605         if (unformat (input, "%d", &ai))
606             ;
607         else if (unformat (input, "sum"))
608             summary = 1;
609         else if (unformat (input, "summary"))
610             summary = 1;
611         else if (unformat (input, "%U",
612                            unformat_vnet_sw_interface, vnet_get_main(),
613                            &sw_if_index))
614             ;
615         else
616             break;
617     }
618
619     if (summary)
620     {
621         vlib_cli_output (vm, "Number of adjacencies: %d", pool_elts(adj_pool));
622         vlib_cli_output (vm, "Per-adjacency counters: %s",
623                          (adj_are_counters_enabled() ?
624                           "enabled":
625                           "disabled"));
626     }
627     else
628     {
629         if (ADJ_INDEX_INVALID != ai)
630         {
631             if (pool_is_free_index(adj_pool, ai))
632             {
633                 vlib_cli_output (vm, "adjacency %d invalid", ai);
634                 return 0;
635             }
636
637             vlib_cli_output (vm, "[@%d] %U",
638                              ai,
639                              format_ip_adjacency,  ai,
640                              FORMAT_IP_ADJACENCY_DETAIL);
641         }
642         else
643         {
644             /* *INDENT-OFF* */
645             pool_foreach_index(ai, adj_pool,
646             ({
647                 if (~0 != sw_if_index &&
648                     sw_if_index != adj_get_sw_if_index(ai))
649                 {
650                 }
651                 else
652                 {
653                     vlib_cli_output (vm, "[@%d] %U",
654                                      ai,
655                                      format_ip_adjacency, ai,
656                                      FORMAT_IP_ADJACENCY_NONE);
657                 }
658             }));
659             /* *INDENT-ON* */
660         }
661     }
662     return 0;
663 }
664
665 /*?
666  * Show all adjacencies.
667  * @cliexpar
668  * @cliexstart{sh adj}
669  * [@0]
670  * [@1]  glean: loop0
671  * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
672  * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
673  * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
674  * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
675  * @cliexend
676  ?*/
677 VLIB_CLI_COMMAND (adj_show_command, static) = {
678     .path = "show adj",
679     .short_help = "show adj [<adj_index>] [interface] [summary]",
680     .function = adj_show,
681 };
682
683 /**
684  * @brief CLI invoked function to enable/disable per-adj counters
685  */
686 static clib_error_t *
687 adj_cli_counters_set (vlib_main_t * vm,
688                       unformat_input_t * input,
689                       vlib_cli_command_t * cmd)
690 {
691     clib_error_t *error = NULL;
692     int enable = ~0;
693
694     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
695     {
696         if (unformat (input, "enable"))
697             enable = 1;
698         else if (unformat (input, "disable"))
699             enable = 0;
700         else
701             break;
702     }
703
704     if (enable != ~0)
705     {
706         /* user requested something sensible */
707         adj_per_adj_counters = enable;
708     }
709     else
710     {
711         error = clib_error_return (0, "specify 'enable' or 'disable'");
712     }
713
714     return (error);
715 }
716
717 /*?
718  * Enable/disable per-adjacency counters. This is optional because it comes
719  * with a non-negligible performance cost.
720  ?*/
721 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
722     .path = "adjacency counters",
723     .short_help = "adjacency counters [enable|disable]",
724     .function = adj_cli_counters_set,
725 };