fib: do not dump no-longer valid adjacencies
[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
143     if (!adj_is_valid(adj_index))
144       return format(s, "<invalid adjacency>");
145
146     adj = adj_get(adj_index);
147
148     switch (adj->lookup_next_index)
149     {
150     case IP_LOOKUP_NEXT_REWRITE:
151     case IP_LOOKUP_NEXT_BCAST:
152         s = format (s, "%U", format_adj_nbr, adj_index, 0);
153         break;
154     case IP_LOOKUP_NEXT_ARP:
155         s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
156         break;
157     case IP_LOOKUP_NEXT_GLEAN:
158         s = format (s, "%U", format_adj_glean, adj_index, 0);
159         break;
160     case IP_LOOKUP_NEXT_MIDCHAIN:
161         s = format (s, "%U", format_adj_midchain, adj_index, 2);
162         break;
163     case IP_LOOKUP_NEXT_MCAST:
164         s = format (s, "%U", format_adj_mcast, adj_index, 0);
165         break;
166     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
167         s = format (s, "%U", format_adj_mcast_midchain, adj_index, 0);
168         break;
169     case IP_LOOKUP_NEXT_DROP:
170     case IP_LOOKUP_NEXT_PUNT:
171     case IP_LOOKUP_NEXT_LOCAL:
172     case IP_LOOKUP_NEXT_ICMP_ERROR:
173     case IP_LOOKUP_N_NEXT:
174         break;
175     }
176
177     if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
178     {
179         vlib_counter_t counts;
180
181         vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
182         s = format (s, "\n   flags:%U", format_adj_flags, adj->ia_flags);
183         s = format (s, "\n   counts:[%Ld:%Ld]", counts.packets, counts.bytes);
184         s = format (s, "\n   locks:%d", adj->ia_node.fn_locks);
185         s = format(s, "\n delegates:\n  ");
186         s = adj_delegate_format(s, adj);
187
188         s = format(s, "\n children:");
189         if (fib_node_list_get_size(adj->ia_node.fn_children))
190         {
191             s = format(s, "\n  ");
192             s = fib_node_children_format(adj->ia_node.fn_children, s);
193         }
194     }
195
196     return s;
197 }
198
199 int
200 adj_recursive_loop_detect (adj_index_t ai,
201                            fib_node_index_t **entry_indicies)
202 {
203     ip_adjacency_t * adj;
204
205     adj = adj_get(ai);
206
207     switch (adj->lookup_next_index)
208     {
209     case IP_LOOKUP_NEXT_REWRITE:
210     case IP_LOOKUP_NEXT_ARP:
211     case IP_LOOKUP_NEXT_GLEAN:
212     case IP_LOOKUP_NEXT_MCAST:
213     case IP_LOOKUP_NEXT_BCAST:
214     case IP_LOOKUP_NEXT_DROP:
215     case IP_LOOKUP_NEXT_PUNT:
216     case IP_LOOKUP_NEXT_LOCAL:
217     case IP_LOOKUP_NEXT_ICMP_ERROR:
218     case IP_LOOKUP_N_NEXT:
219         /*
220          * these adjacency types are terminal graph nodes, so there's no
221          * possibility of a loop down here.
222          */
223         break;
224     case IP_LOOKUP_NEXT_MIDCHAIN:
225     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
226         return (adj_ndr_midchain_recursive_loop_detect(ai, entry_indicies));
227     }
228
229     return (0);
230 }
231
232 /*
233  * adj_last_lock_gone
234  *
235  * last lock/reference to the adj has gone, we no longer need it.
236  */
237 static void
238 adj_last_lock_gone (ip_adjacency_t *adj)
239 {
240     vlib_main_t * vm = vlib_get_main();
241
242     ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
243     ADJ_DBG(adj, "last-lock-gone");
244
245     adj_delegate_adj_deleted(adj);
246
247     vlib_worker_thread_barrier_sync (vm);
248
249     switch (adj->lookup_next_index)
250     {
251     case IP_LOOKUP_NEXT_MIDCHAIN:
252         dpo_reset(&adj->sub_type.midchain.next_dpo);
253         /* FALL THROUGH */
254     case IP_LOOKUP_NEXT_ARP:
255     case IP_LOOKUP_NEXT_REWRITE:
256     case IP_LOOKUP_NEXT_BCAST:
257         /*
258          * complete and incomplete nbr adjs
259          */
260         adj_nbr_remove(adj_get_index(adj),
261                        adj->ia_nh_proto,
262                        adj->ia_link,
263                        &adj->sub_type.nbr.next_hop,
264                        adj->rewrite_header.sw_if_index);
265         break;
266     case IP_LOOKUP_NEXT_GLEAN:
267         adj_glean_remove(adj->ia_nh_proto,
268                          adj->rewrite_header.sw_if_index);
269         break;
270     case IP_LOOKUP_NEXT_MCAST:
271     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
272         adj_mcast_remove(adj->ia_nh_proto,
273                          adj->rewrite_header.sw_if_index);
274         break;
275     case IP_LOOKUP_NEXT_DROP:
276     case IP_LOOKUP_NEXT_PUNT:
277     case IP_LOOKUP_NEXT_LOCAL:
278     case IP_LOOKUP_NEXT_ICMP_ERROR:
279     case IP_LOOKUP_N_NEXT:
280         /*
281          * type not stored in any DB from which we need to remove it
282          */
283         break;
284     }
285
286     vlib_worker_thread_barrier_release(vm);
287
288     fib_node_deinit(&adj->ia_node);
289     ASSERT(0 == vec_len(adj->ia_delegates));
290     vec_free(adj->ia_delegates);
291     pool_put(adj_pool, adj);
292 }
293
294 u32
295 adj_dpo_get_urpf (const dpo_id_t *dpo)
296 {
297     ip_adjacency_t *adj;
298
299     adj = adj_get(dpo->dpoi_index);
300
301     return (adj->rewrite_header.sw_if_index);
302 }
303
304 void
305 adj_lock (adj_index_t adj_index)
306 {
307     ip_adjacency_t *adj;
308
309     if (adj_index_is_special(adj_index))
310     {
311         return;
312     }
313
314     adj = adj_get(adj_index);
315     ASSERT(adj);
316
317     ADJ_DBG(adj, "lock");
318     fib_node_lock(&adj->ia_node);
319 }
320
321 void
322 adj_unlock (adj_index_t adj_index)
323 {
324     ip_adjacency_t *adj;
325
326     if (adj_index_is_special(adj_index))
327     {
328         return;
329     }
330
331     adj = adj_get(adj_index);
332     ASSERT(adj);
333
334     ADJ_DBG(adj, "unlock");
335     ASSERT(adj);
336
337     fib_node_unlock(&adj->ia_node);
338 }
339
340 u32
341 adj_child_add (adj_index_t adj_index,
342                fib_node_type_t child_type,
343                fib_node_index_t child_index)
344 {
345     ASSERT(ADJ_INDEX_INVALID != adj_index);
346     if (adj_index_is_special(adj_index))
347     {
348         return (~0);
349     }
350
351     return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
352                                adj_index,
353                                child_type,
354                                child_index));
355 }
356
357 void
358 adj_child_remove (adj_index_t adj_index,
359                   u32 sibling_index)
360 {
361     if (adj_index_is_special(adj_index))
362     {
363         return;
364     }
365
366     fib_node_child_remove(FIB_NODE_TYPE_ADJ,
367                           adj_index,
368                           sibling_index);
369 }
370
371 /*
372  * Context for the walk to update the cached feature flags.
373  */
374 typedef struct adj_feature_update_t_
375 {
376     u8 arc;
377     u8 enable;
378 } adj_feature_update_ctx_t;
379
380 static adj_walk_rc_t
381 adj_feature_update_walk_cb (adj_index_t ai,
382                             void *arg)
383 {
384     adj_feature_update_ctx_t *ctx = arg;
385     ip_adjacency_t *adj;
386
387     adj = adj_get(ai);
388
389     /*
390      * this ugly mess matches the feature arc that is changing with affected
391      * adjacencies
392      */
393     if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
394          (VNET_LINK_IP6 == adj->ia_link)) ||
395         ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
396          (VNET_LINK_IP4 == adj->ia_link)) ||
397         ((ctx->arc == mpls_main.output_feature_arc_index) &&
398          (VNET_LINK_MPLS == adj->ia_link)))
399     {
400         if (ctx->enable)
401             adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
402         else
403             adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
404     }
405     return (ADJ_WALK_RC_CONTINUE);
406 }
407
408 void
409 adj_feature_update (u32 sw_if_index,
410                     u8 arc_index,
411                     u8 is_enable)
412 {
413     /*
414      * Walk all the adjacencies on the interface to update the cached
415      * 'has-features' flag
416      */
417     adj_feature_update_ctx_t ctx = {
418         .arc = arc_index,
419         .enable = is_enable,
420     };
421     adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
422 }
423
424 static adj_walk_rc_t
425 adj_mtu_update_walk_cb (adj_index_t ai,
426                         void *arg)
427 {
428     ip_adjacency_t *adj;
429
430     adj = adj_get(ai);
431
432     vnet_rewrite_update_mtu (vnet_get_main(), adj->ia_link,
433                              &adj->rewrite_header);
434
435     return (ADJ_WALK_RC_CONTINUE);
436 }
437
438 static clib_error_t *
439 adj_mtu_update (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
440 {
441   adj_walk (sw_if_index, adj_mtu_update_walk_cb, NULL);
442
443   return (NULL);
444 }
445
446 VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(adj_mtu_update);
447
448 /**
449  * @brief Walk the Adjacencies on a given interface
450  */
451 void
452 adj_walk (u32 sw_if_index,
453           adj_walk_cb_t cb,
454           void *ctx)
455 {
456     /*
457      * walk all the neighbor adjacencies
458      */
459     fib_protocol_t proto;
460
461     FOR_EACH_FIB_IP_PROTOCOL(proto)
462     {
463         adj_nbr_walk(sw_if_index, proto, cb, ctx);
464         adj_mcast_walk(sw_if_index, proto, cb, ctx);
465     }
466 }
467
468 /**
469  * @brief Return the link type of the adjacency
470  */
471 vnet_link_t
472 adj_get_link_type (adj_index_t ai)
473 {
474     const ip_adjacency_t *adj;
475
476     adj = adj_get(ai);
477
478     return (adj->ia_link);
479 }
480
481 /**
482  * @brief Return the sw interface index of the adjacency.
483  */
484 u32
485 adj_get_sw_if_index (adj_index_t ai)
486 {
487     const ip_adjacency_t *adj;
488
489     adj = adj_get(ai);
490
491     return (adj->rewrite_header.sw_if_index);
492 }
493
494 /**
495  * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
496  * 0 is down, !0 is up.
497  */
498 int
499 adj_is_up (adj_index_t ai)
500 {
501     return (adj_bfd_is_up(ai));
502 }
503
504 /**
505  * @brief Return the rewrite string of the adjacency
506  */
507 const u8*
508 adj_get_rewrite (adj_index_t ai)
509 {
510     vnet_rewrite_header_t *rw;
511     ip_adjacency_t *adj;
512
513     adj = adj_get(ai);
514     rw = &adj->rewrite_header;
515
516     ASSERT (rw->data_bytes != 0xfefe);
517
518     return (rw->data - rw->data_bytes);
519 }
520
521 static fib_node_t *
522 adj_get_node (fib_node_index_t index)
523 {
524     ip_adjacency_t *adj;
525
526     adj = adj_get(index);
527
528     return (&adj->ia_node);
529 }
530
531 #define ADJ_FROM_NODE(_node)                                            \
532     ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
533
534 static void
535 adj_node_last_lock_gone (fib_node_t *node)
536 {
537     adj_last_lock_gone(ADJ_FROM_NODE(node));
538 }
539
540 static fib_node_back_walk_rc_t
541 adj_back_walk_notify (fib_node_t *node,
542                       fib_node_back_walk_ctx_t *ctx)
543 {
544     ip_adjacency_t *adj;
545
546     adj = ADJ_FROM_NODE(node);
547
548     switch (adj->lookup_next_index)
549     {
550     case IP_LOOKUP_NEXT_MIDCHAIN:
551         adj_midchain_delegate_restack(adj_get_index(adj));
552         break;
553     case IP_LOOKUP_NEXT_ARP:
554     case IP_LOOKUP_NEXT_REWRITE:
555     case IP_LOOKUP_NEXT_BCAST:
556     case IP_LOOKUP_NEXT_GLEAN:
557     case IP_LOOKUP_NEXT_MCAST:
558     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
559     case IP_LOOKUP_NEXT_DROP:
560     case IP_LOOKUP_NEXT_PUNT:
561     case IP_LOOKUP_NEXT_LOCAL:
562     case IP_LOOKUP_NEXT_ICMP_ERROR:
563     case IP_LOOKUP_N_NEXT:
564         /*
565          * Que pasa. yo soj en el final!
566          */
567         ASSERT(0);
568         break;
569     }
570
571     return (FIB_NODE_BACK_WALK_CONTINUE);
572 }
573
574 /*
575  * Adjacency's graph node virtual function table
576  */
577 static const fib_node_vft_t adj_vft = {
578     .fnv_get = adj_get_node,
579     .fnv_last_lock = adj_node_last_lock_gone,
580     .fnv_back_walk = adj_back_walk_notify,
581 };
582
583 static clib_error_t *
584 adj_module_init (vlib_main_t * vm)
585 {
586     fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
587
588     adj_nbr_module_init();
589     adj_glean_module_init();
590     adj_midchain_module_init();
591     adj_mcast_module_init();
592
593     return (NULL);
594 }
595
596 VLIB_INIT_FUNCTION (adj_module_init);
597
598 static clib_error_t *
599 adj_show (vlib_main_t * vm,
600           unformat_input_t * input,
601           vlib_cli_command_t * cmd)
602 {
603     adj_index_t ai = ADJ_INDEX_INVALID;
604     u32 sw_if_index = ~0;
605     int summary = 0;
606
607     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
608     {
609         if (unformat (input, "%d", &ai))
610             ;
611         else if (unformat (input, "sum"))
612             summary = 1;
613         else if (unformat (input, "summary"))
614             summary = 1;
615         else if (unformat (input, "%U",
616                            unformat_vnet_sw_interface, vnet_get_main(),
617                            &sw_if_index))
618             ;
619         else
620             break;
621     }
622
623     if (summary)
624     {
625         vlib_cli_output (vm, "Number of adjacencies: %d", pool_elts(adj_pool));
626         vlib_cli_output (vm, "Per-adjacency counters: %s",
627                          (adj_are_counters_enabled() ?
628                           "enabled":
629                           "disabled"));
630     }
631     else
632     {
633         if (ADJ_INDEX_INVALID != ai)
634         {
635             if (pool_is_free_index(adj_pool, ai))
636             {
637                 vlib_cli_output (vm, "adjacency %d invalid", ai);
638                 return 0;
639             }
640
641             vlib_cli_output (vm, "[@%d] %U",
642                              ai,
643                              format_ip_adjacency,  ai,
644                              FORMAT_IP_ADJACENCY_DETAIL);
645         }
646         else
647         {
648             /* *INDENT-OFF* */
649             pool_foreach_index(ai, adj_pool,
650             ({
651                 if (~0 != sw_if_index &&
652                     sw_if_index != adj_get_sw_if_index(ai))
653                 {
654                 }
655                 else
656                 {
657                     vlib_cli_output (vm, "[@%d] %U",
658                                      ai,
659                                      format_ip_adjacency, ai,
660                                      FORMAT_IP_ADJACENCY_NONE);
661                 }
662             }));
663             /* *INDENT-ON* */
664         }
665     }
666     return 0;
667 }
668
669 /*?
670  * Show all adjacencies.
671  * @cliexpar
672  * @cliexstart{sh adj}
673  * [@0]
674  * [@1]  glean: loop0
675  * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
676  * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
677  * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
678  * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
679  * @cliexend
680  ?*/
681 VLIB_CLI_COMMAND (adj_show_command, static) = {
682     .path = "show adj",
683     .short_help = "show adj [<adj_index>] [interface] [summary]",
684     .function = adj_show,
685 };
686
687 /**
688  * @brief CLI invoked function to enable/disable per-adj counters
689  */
690 static clib_error_t *
691 adj_cli_counters_set (vlib_main_t * vm,
692                       unformat_input_t * input,
693                       vlib_cli_command_t * cmd)
694 {
695     clib_error_t *error = NULL;
696     int enable = ~0;
697
698     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
699     {
700         if (unformat (input, "enable"))
701             enable = 1;
702         else if (unformat (input, "disable"))
703             enable = 0;
704         else
705             break;
706     }
707
708     if (enable != ~0)
709     {
710         /* user requested something sensible */
711         adj_per_adj_counters = enable;
712     }
713     else
714     {
715         error = clib_error_return (0, "specify 'enable' or 'disable'");
716     }
717
718     return (error);
719 }
720
721 /*?
722  * Enable/disable per-adjacency counters. This is optional because it comes
723  * with a non-negligible performance cost.
724  ?*/
725 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
726     .path = "adjacency counters",
727     .short_help = "adjacency counters [enable|disable]",
728     .function = adj_cli_counters_set,
729 };