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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
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 #include <vnet/fib/fib_walk.h>
25 /* Adjacency packet/byte counters indexed by adjacency index. */
26 vlib_combined_counter_main_t adjacency_counters = {
28 .stat_segment_name = "/net/adjacency",
34 ip_adjacency_t *adj_pool;
37 * The adjacency logger
39 vlib_log_class_t adj_logger;
42 * @brief Global Config for enabling per-adjacency counters.
43 * By default these are disabled.
45 int adj_per_adj_counters;
47 const ip46_address_t ADJ_BCAST_ADDR = {
49 .as_u64[0] = 0xffffffffffffffff,
50 .as_u64[1] = 0xffffffffffffffff,
57 static const char *adj_attr_names[] = ADJ_ATTR_NAMES;
60 adj_poison (ip_adjacency_t * adj)
64 clib_memset (adj, 0xfe, sizeof (adj[0]));
69 adj_alloc (fib_protocol_t proto)
72 u8 need_barrier_sync = pool_get_will_expand (adj_pool);
76 ASSERT (vm->thread_index == 0);
78 /* If the adj_pool will expand, stop the parade. */
79 if (need_barrier_sync)
80 vlib_worker_thread_barrier_sync (vm);
82 pool_get_aligned(adj_pool, adj, CLIB_CACHE_LINE_BYTES);
86 /* Validate adjacency counters. */
87 if (need_barrier_sync == 0)
89 /* If the adj counter pool will expand, stop the parade */
90 need_barrier_sync = vlib_validate_combined_counter_will_expand
91 (&adjacency_counters, adj_get_index (adj));
92 if (need_barrier_sync)
93 vlib_worker_thread_barrier_sync (vm);
95 vlib_validate_combined_counter(&adjacency_counters,
98 /* Make sure certain fields are always initialized. */
99 vlib_zero_combined_counter(&adjacency_counters,
101 fib_node_init(&adj->ia_node,
104 adj->ia_nh_proto = proto;
106 adj->ia_cfg_index = 0;
107 adj->rewrite_header.sw_if_index = ~0;
108 adj->rewrite_header.flags = 0;
109 adj->lookup_next_index = 0;
110 adj->ia_delegates = NULL;
112 /* lest it become a midchain in the future */
113 clib_memset(&adj->sub_type.midchain.next_dpo, 0,
114 sizeof(adj->sub_type.midchain.next_dpo));
116 if (need_barrier_sync)
117 vlib_worker_thread_barrier_release (vm);
123 adj_index_is_special (adj_index_t adj_index)
125 if (ADJ_INDEX_INVALID == adj_index)
132 format_adj_flags (u8 * s, va_list * args)
137 af = va_arg (*args, int);
139 if (ADJ_FLAG_NONE == af)
141 return (format(s, "None"));
143 FOR_EACH_ADJ_ATTR(at)
147 s = format(s, "%s ", adj_attr_names[at]);
154 * @brief Pretty print helper function for formatting specific adjacencies.
155 * @param s - input string to format
156 * @param args - other args passed to format function such as:
162 format_ip_adjacency (u8 * s, va_list * args)
164 format_ip_adjacency_flags_t fiaf;
165 ip_adjacency_t * adj;
168 adj_index = va_arg (*args, u32);
169 fiaf = va_arg (*args, format_ip_adjacency_flags_t);
171 if (!adj_is_valid(adj_index))
172 return format(s, "<invalid adjacency>");
174 adj = adj_get(adj_index);
176 switch (adj->lookup_next_index)
178 case IP_LOOKUP_NEXT_REWRITE:
179 case IP_LOOKUP_NEXT_BCAST:
180 s = format (s, "%U", format_adj_nbr, adj_index, 0);
182 case IP_LOOKUP_NEXT_ARP:
183 s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
185 case IP_LOOKUP_NEXT_GLEAN:
186 s = format (s, "%U", format_adj_glean, adj_index, 0);
188 case IP_LOOKUP_NEXT_MIDCHAIN:
189 s = format (s, "%U", format_adj_midchain, adj_index, 2);
191 case IP_LOOKUP_NEXT_MCAST:
192 s = format (s, "%U", format_adj_mcast, adj_index, 0);
194 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
195 s = format (s, "%U", format_adj_mcast_midchain, adj_index, 0);
197 case IP_LOOKUP_NEXT_DROP:
198 case IP_LOOKUP_NEXT_PUNT:
199 case IP_LOOKUP_NEXT_LOCAL:
200 case IP_LOOKUP_NEXT_ICMP_ERROR:
201 case IP_LOOKUP_N_NEXT:
205 if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
207 vlib_counter_t counts;
209 vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
210 s = format (s, "\n flags:%U", format_adj_flags, adj->ia_flags);
211 s = format (s, "\n counts:[%Ld:%Ld]", counts.packets, counts.bytes);
212 s = format (s, "\n locks:%d", adj->ia_node.fn_locks);
213 s = format(s, "\n delegates:");
214 s = adj_delegate_format(s, adj);
216 s = format(s, "\n children:");
217 if (fib_node_list_get_size(adj->ia_node.fn_children))
219 s = format(s, "\n ");
220 s = fib_node_children_format(adj->ia_node.fn_children, s);
228 adj_recursive_loop_detect (adj_index_t ai,
229 fib_node_index_t **entry_indicies)
231 ip_adjacency_t * adj;
235 switch (adj->lookup_next_index)
237 case IP_LOOKUP_NEXT_REWRITE:
238 case IP_LOOKUP_NEXT_ARP:
239 case IP_LOOKUP_NEXT_GLEAN:
240 case IP_LOOKUP_NEXT_MCAST:
241 case IP_LOOKUP_NEXT_BCAST:
242 case IP_LOOKUP_NEXT_DROP:
243 case IP_LOOKUP_NEXT_PUNT:
244 case IP_LOOKUP_NEXT_LOCAL:
245 case IP_LOOKUP_NEXT_ICMP_ERROR:
246 case IP_LOOKUP_N_NEXT:
248 * these adjacency types are terminal graph nodes, so there's no
249 * possibility of a loop down here.
252 case IP_LOOKUP_NEXT_MIDCHAIN:
253 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
254 return (adj_ndr_midchain_recursive_loop_detect(ai, entry_indicies));
263 * last lock/reference to the adj has gone, we no longer need it.
266 adj_last_lock_gone (ip_adjacency_t *adj)
268 vlib_main_t * vm = vlib_get_main();
270 ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
271 ADJ_DBG(adj, "last-lock-gone");
273 adj_delegate_adj_deleted(adj);
275 vlib_worker_thread_barrier_sync (vm);
277 switch (adj->lookup_next_index)
279 case IP_LOOKUP_NEXT_MIDCHAIN:
280 adj_midchain_teardown(adj);
282 case IP_LOOKUP_NEXT_ARP:
283 case IP_LOOKUP_NEXT_REWRITE:
284 case IP_LOOKUP_NEXT_BCAST:
286 * complete and incomplete nbr adjs
288 adj_nbr_remove(adj_get_index(adj),
291 &adj->sub_type.nbr.next_hop,
292 adj->rewrite_header.sw_if_index);
294 case IP_LOOKUP_NEXT_GLEAN:
295 adj_glean_remove(adj);
297 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
298 adj_midchain_teardown(adj);
300 case IP_LOOKUP_NEXT_MCAST:
301 adj_mcast_remove(adj->ia_nh_proto,
302 adj->rewrite_header.sw_if_index);
304 case IP_LOOKUP_NEXT_DROP:
305 case IP_LOOKUP_NEXT_PUNT:
306 case IP_LOOKUP_NEXT_LOCAL:
307 case IP_LOOKUP_NEXT_ICMP_ERROR:
308 case IP_LOOKUP_N_NEXT:
310 * type not stored in any DB from which we need to remove it
316 fib_node_deinit(&adj->ia_node);
317 ASSERT(0 == vec_len(adj->ia_delegates));
318 vec_free(adj->ia_delegates);
319 pool_put(adj_pool, adj);
320 vlib_worker_thread_barrier_release(vm);
324 adj_dpo_get_urpf (const dpo_id_t *dpo)
328 adj = adj_get(dpo->dpoi_index);
330 return (adj->rewrite_header.sw_if_index);
334 adj_dpo_get_mtu (const dpo_id_t *dpo)
338 adj = adj_get(dpo->dpoi_index);
340 return (adj->rewrite_header.max_l3_packet_bytes);
344 adj_lock (adj_index_t adj_index)
348 if (adj_index_is_special(adj_index))
353 adj = adj_get(adj_index);
356 fib_node_lock(&adj->ia_node);
360 adj_unlock (adj_index_t adj_index)
364 if (adj_index_is_special(adj_index))
369 adj = adj_get(adj_index);
372 fib_node_unlock(&adj->ia_node);
376 adj_child_add (adj_index_t adj_index,
377 fib_node_type_t child_type,
378 fib_node_index_t child_index)
380 ASSERT(ADJ_INDEX_INVALID != adj_index);
381 if (adj_index_is_special(adj_index))
386 return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
393 adj_child_remove (adj_index_t adj_index,
396 if (adj_index_is_special(adj_index))
401 fib_node_child_remove(FIB_NODE_TYPE_ADJ,
407 * Context for the walk to update the cached feature flags.
409 typedef struct adj_feature_update_t_
413 } adj_feature_update_ctx_t;
416 adj_feature_update_walk_cb (adj_index_t ai,
419 adj_feature_update_ctx_t *ctx = arg;
425 * this ugly mess matches the feature arc that is changing with affected
428 if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
429 (VNET_LINK_IP6 == adj->ia_link)) ||
430 ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
431 (VNET_LINK_IP4 == adj->ia_link)) ||
432 ((ctx->arc == mpls_main.output_feature_arc_index) &&
433 (VNET_LINK_MPLS == adj->ia_link)))
435 vnet_feature_main_t *fm = &feature_main;
436 vnet_feature_config_main_t *cm;
438 cm = &fm->feature_config_mains[ctx->arc];
441 adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
443 adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
445 adj->ia_cfg_index = vec_elt (cm->config_index_by_sw_if_index,
446 adj->rewrite_header.sw_if_index);
448 return (ADJ_WALK_RC_CONTINUE);
452 adj_feature_update (u32 sw_if_index,
458 * Walk all the adjacencies on the interface to update the cached
459 * 'has-features' flag
461 adj_feature_update_ctx_t ctx = {
465 adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
469 adj_mtu_update_walk_cb (adj_index_t ai,
476 vnet_rewrite_update_mtu (vnet_get_main(), adj->ia_link,
477 &adj->rewrite_header);
478 adj_delegate_adj_modified(adj);
481 * Backwalk to all Path MTU trackers, casual like ..
484 fib_node_back_walk_ctx_t bw_ctx = {
485 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_ADJ_MTU,
488 fib_walk_async(FIB_NODE_TYPE_ADJ, ai,
489 FIB_WALK_PRIORITY_LOW, &bw_ctx);
492 return (ADJ_WALK_RC_CONTINUE);
495 static clib_error_t *
496 adj_mtu_update (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
498 adj_walk (sw_if_index, adj_mtu_update_walk_cb, NULL);
503 VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(adj_mtu_update);
506 * @brief Walk the Adjacencies on a given interface
509 adj_walk (u32 sw_if_index,
514 * walk all the neighbor adjacencies
516 fib_protocol_t proto;
518 FOR_EACH_FIB_IP_PROTOCOL(proto)
520 adj_nbr_walk(sw_if_index, proto, cb, ctx);
521 adj_mcast_walk(sw_if_index, proto, cb, ctx);
526 * @brief Return the link type of the adjacency
529 adj_get_link_type (adj_index_t ai)
531 const ip_adjacency_t *adj;
535 return (adj->ia_link);
539 * @brief Return the sw interface index of the adjacency.
542 adj_get_sw_if_index (adj_index_t ai)
544 const ip_adjacency_t *adj;
548 return (adj->rewrite_header.sw_if_index);
552 * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
553 * 0 is down, !0 is up.
556 adj_is_up (adj_index_t ai)
558 return (adj_bfd_is_up(ai));
562 * @brief Return the rewrite string of the adjacency
565 adj_get_rewrite (adj_index_t ai)
567 vnet_rewrite_header_t *rw;
571 rw = &adj->rewrite_header;
573 ASSERT (rw->data_bytes != 0xfefe);
575 return (rw->data - rw->data_bytes);
579 adj_get_node (fib_node_index_t index)
583 adj = adj_get(index);
585 return (&adj->ia_node);
588 #define ADJ_FROM_NODE(_node) \
589 ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
592 adj_node_last_lock_gone (fib_node_t *node)
594 adj_last_lock_gone(ADJ_FROM_NODE(node));
597 static fib_node_back_walk_rc_t
598 adj_back_walk_notify (fib_node_t *node,
599 fib_node_back_walk_ctx_t *ctx)
603 adj = ADJ_FROM_NODE(node);
605 switch (adj->lookup_next_index)
607 case IP_LOOKUP_NEXT_MIDCHAIN:
608 adj_midchain_delegate_restack(adj_get_index(adj));
610 case IP_LOOKUP_NEXT_ARP:
611 case IP_LOOKUP_NEXT_REWRITE:
612 case IP_LOOKUP_NEXT_BCAST:
613 case IP_LOOKUP_NEXT_GLEAN:
614 case IP_LOOKUP_NEXT_MCAST:
615 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
616 case IP_LOOKUP_NEXT_DROP:
617 case IP_LOOKUP_NEXT_PUNT:
618 case IP_LOOKUP_NEXT_LOCAL:
619 case IP_LOOKUP_NEXT_ICMP_ERROR:
620 case IP_LOOKUP_N_NEXT:
622 * Que pasa. yo soj en el final!
628 return (FIB_NODE_BACK_WALK_CONTINUE);
632 * Adjacency's graph node virtual function table
634 static const fib_node_vft_t adj_vft = {
635 .fnv_get = adj_get_node,
636 .fnv_last_lock = adj_node_last_lock_gone,
637 .fnv_back_walk = adj_back_walk_notify,
640 static clib_error_t *
641 adj_module_init (vlib_main_t * vm)
643 fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
645 adj_nbr_module_init();
646 adj_glean_module_init();
647 adj_midchain_module_init();
648 adj_mcast_module_init();
650 vnet_feature_register(adj_feature_update, NULL);
652 adj_logger = vlib_log_register_class("adj", "adj");
657 VLIB_INIT_FUNCTION (adj_module_init);
659 static clib_error_t *
660 adj_show (vlib_main_t * vm,
661 unformat_input_t * input,
662 vlib_cli_command_t * cmd)
664 adj_index_t ai = ADJ_INDEX_INVALID;
665 u32 sw_if_index = ~0;
668 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
670 if (unformat (input, "%d", &ai))
672 else if (unformat (input, "summary") || unformat (input, "sum"))
674 else if (unformat (input, "%U",
675 unformat_vnet_sw_interface, vnet_get_main(),
684 vlib_cli_output (vm, "Number of adjacencies: %d", pool_elts(adj_pool));
685 vlib_cli_output (vm, "Per-adjacency counters: %s",
686 (adj_are_counters_enabled() ?
692 if (ADJ_INDEX_INVALID != ai)
694 if (pool_is_free_index(adj_pool, ai))
696 vlib_cli_output (vm, "adjacency %d invalid", ai);
700 vlib_cli_output (vm, "[@%d] %U",
702 format_ip_adjacency, ai,
703 FORMAT_IP_ADJACENCY_DETAIL);
707 pool_foreach_index (ai, adj_pool)
709 if (~0 != sw_if_index &&
710 sw_if_index != adj_get_sw_if_index(ai))
715 vlib_cli_output (vm, "[@%d] %U",
717 format_ip_adjacency, ai,
718 FORMAT_IP_ADJACENCY_NONE);
727 * Show all adjacencies.
729 * @cliexstart{sh adj}
732 * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
733 * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
734 * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
735 * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
738 VLIB_CLI_COMMAND (adj_show_command, static) = {
740 .short_help = "show adj [<adj_index>] [interface] [summary]",
741 .function = adj_show,
745 * @brief CLI invoked function to enable/disable per-adj counters
747 static clib_error_t *
748 adj_cli_counters_set (vlib_main_t * vm,
749 unformat_input_t * input,
750 vlib_cli_command_t * cmd)
752 clib_error_t *error = NULL;
755 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
757 if (unformat (input, "enable"))
759 else if (unformat (input, "disable"))
767 /* user requested something sensible */
768 adj_per_adj_counters = enable;
772 error = clib_error_return (0, "specify 'enable' or 'disable'");
779 * Enable/disable per-adjacency counters. This is optional because it comes
780 * with a non-negligible performance cost.
782 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
783 .path = "adjacency counters",
784 .short_help = "adjacency counters [enable|disable]",
785 .function = adj_cli_counters_set,