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>
24 /* Adjacency packet/byte counters indexed by adjacency index. */
25 vlib_combined_counter_main_t adjacency_counters = {
27 .stat_segment_name = "/net/adjacency",
33 ip_adjacency_t *adj_pool;
36 * @brief Global Config for enabling per-adjacency counters.
37 * By default these are disabled.
39 int adj_per_adj_counters;
41 const ip46_address_t ADJ_BCAST_ADDR = {
43 .as_u64[0] = 0xffffffffffffffff,
44 .as_u64[1] = 0xffffffffffffffff,
51 static const char *adj_attr_names[] = ADJ_ATTR_NAMES;
54 adj_poison (ip_adjacency_t * adj)
58 clib_memset (adj, 0xfe, sizeof (adj[0]));
63 adj_alloc (fib_protocol_t proto)
66 u8 need_barrier_sync = 0;
70 ASSERT (vm->thread_index == 0);
72 pool_get_aligned_will_expand (adj_pool, need_barrier_sync,
73 CLIB_CACHE_LINE_BYTES);
74 /* If the adj_pool will expand, stop the parade. */
75 if (need_barrier_sync)
76 vlib_worker_thread_barrier_sync (vm);
78 pool_get_aligned(adj_pool, adj, CLIB_CACHE_LINE_BYTES);
82 /* Validate adjacency counters. */
83 if (need_barrier_sync == 0)
85 /* If the adj counter pool will expand, stop the parade */
86 need_barrier_sync = vlib_validate_combined_counter_will_expand
87 (&adjacency_counters, adj_get_index (adj));
88 if (need_barrier_sync)
89 vlib_worker_thread_barrier_sync (vm);
91 vlib_validate_combined_counter(&adjacency_counters,
94 /* Make sure certain fields are always initialized. */
95 vlib_zero_combined_counter(&adjacency_counters,
97 fib_node_init(&adj->ia_node,
100 adj->ia_nh_proto = proto;
102 adj->ia_cfg_index = 0;
103 adj->rewrite_header.sw_if_index = ~0;
104 adj->rewrite_header.flags = 0;
105 adj->lookup_next_index = 0;
106 adj->ia_delegates = NULL;
108 /* lest it become a midchain in the future */
109 clib_memset(&adj->sub_type.midchain.next_dpo, 0,
110 sizeof(adj->sub_type.midchain.next_dpo));
112 if (need_barrier_sync)
113 vlib_worker_thread_barrier_release (vm);
119 adj_index_is_special (adj_index_t adj_index)
121 if (ADJ_INDEX_INVALID == adj_index)
128 format_adj_flags (u8 * s, va_list * args)
133 af = va_arg (*args, int);
135 if (ADJ_FLAG_NONE == af)
137 return (format(s, "None"));
139 FOR_EACH_ADJ_ATTR(at)
143 s = format(s, "%s ", adj_attr_names[at]);
150 * @brief Pretty print helper function for formatting specific adjacencies.
151 * @param s - input string to format
152 * @param args - other args passed to format function such as:
158 format_ip_adjacency (u8 * s, va_list * args)
160 format_ip_adjacency_flags_t fiaf;
161 ip_adjacency_t * adj;
164 adj_index = va_arg (*args, u32);
165 fiaf = va_arg (*args, format_ip_adjacency_flags_t);
167 if (!adj_is_valid(adj_index))
168 return format(s, "<invalid adjacency>");
170 adj = adj_get(adj_index);
172 switch (adj->lookup_next_index)
174 case IP_LOOKUP_NEXT_REWRITE:
175 case IP_LOOKUP_NEXT_BCAST:
176 s = format (s, "%U", format_adj_nbr, adj_index, 0);
178 case IP_LOOKUP_NEXT_ARP:
179 s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
181 case IP_LOOKUP_NEXT_GLEAN:
182 s = format (s, "%U", format_adj_glean, adj_index, 0);
184 case IP_LOOKUP_NEXT_MIDCHAIN:
185 s = format (s, "%U", format_adj_midchain, adj_index, 2);
187 case IP_LOOKUP_NEXT_MCAST:
188 s = format (s, "%U", format_adj_mcast, adj_index, 0);
190 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
191 s = format (s, "%U", format_adj_mcast_midchain, adj_index, 0);
193 case IP_LOOKUP_NEXT_DROP:
194 case IP_LOOKUP_NEXT_PUNT:
195 case IP_LOOKUP_NEXT_LOCAL:
196 case IP_LOOKUP_NEXT_ICMP_ERROR:
197 case IP_LOOKUP_N_NEXT:
201 if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
203 vlib_counter_t counts;
205 vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
206 s = format (s, "\n flags:%U", format_adj_flags, adj->ia_flags);
207 s = format (s, "\n counts:[%Ld:%Ld]", counts.packets, counts.bytes);
208 s = format (s, "\n locks:%d", adj->ia_node.fn_locks);
209 s = format(s, "\n delegates:");
210 s = adj_delegate_format(s, adj);
212 s = format(s, "\n children:");
213 if (fib_node_list_get_size(adj->ia_node.fn_children))
215 s = format(s, "\n ");
216 s = fib_node_children_format(adj->ia_node.fn_children, s);
224 adj_recursive_loop_detect (adj_index_t ai,
225 fib_node_index_t **entry_indicies)
227 ip_adjacency_t * adj;
231 switch (adj->lookup_next_index)
233 case IP_LOOKUP_NEXT_REWRITE:
234 case IP_LOOKUP_NEXT_ARP:
235 case IP_LOOKUP_NEXT_GLEAN:
236 case IP_LOOKUP_NEXT_MCAST:
237 case IP_LOOKUP_NEXT_BCAST:
238 case IP_LOOKUP_NEXT_DROP:
239 case IP_LOOKUP_NEXT_PUNT:
240 case IP_LOOKUP_NEXT_LOCAL:
241 case IP_LOOKUP_NEXT_ICMP_ERROR:
242 case IP_LOOKUP_N_NEXT:
244 * these adjacency types are terminal graph nodes, so there's no
245 * possibility of a loop down here.
248 case IP_LOOKUP_NEXT_MIDCHAIN:
249 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
250 return (adj_ndr_midchain_recursive_loop_detect(ai, entry_indicies));
259 * last lock/reference to the adj has gone, we no longer need it.
262 adj_last_lock_gone (ip_adjacency_t *adj)
264 vlib_main_t * vm = vlib_get_main();
266 ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
267 ADJ_DBG(adj, "last-lock-gone");
269 adj_delegate_adj_deleted(adj);
271 vlib_worker_thread_barrier_sync (vm);
273 switch (adj->lookup_next_index)
275 case IP_LOOKUP_NEXT_MIDCHAIN:
276 adj_midchain_teardown(adj);
278 case IP_LOOKUP_NEXT_ARP:
279 case IP_LOOKUP_NEXT_REWRITE:
280 case IP_LOOKUP_NEXT_BCAST:
282 * complete and incomplete nbr adjs
284 adj_nbr_remove(adj_get_index(adj),
287 &adj->sub_type.nbr.next_hop,
288 adj->rewrite_header.sw_if_index);
290 case IP_LOOKUP_NEXT_GLEAN:
291 adj_glean_remove(adj);
293 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
294 adj_midchain_teardown(adj);
296 case IP_LOOKUP_NEXT_MCAST:
297 adj_mcast_remove(adj->ia_nh_proto,
298 adj->rewrite_header.sw_if_index);
300 case IP_LOOKUP_NEXT_DROP:
301 case IP_LOOKUP_NEXT_PUNT:
302 case IP_LOOKUP_NEXT_LOCAL:
303 case IP_LOOKUP_NEXT_ICMP_ERROR:
304 case IP_LOOKUP_N_NEXT:
306 * type not stored in any DB from which we need to remove it
311 vlib_worker_thread_barrier_release(vm);
313 fib_node_deinit(&adj->ia_node);
314 ASSERT(0 == vec_len(adj->ia_delegates));
315 vec_free(adj->ia_delegates);
316 pool_put(adj_pool, adj);
320 adj_dpo_get_urpf (const dpo_id_t *dpo)
324 adj = adj_get(dpo->dpoi_index);
326 return (adj->rewrite_header.sw_if_index);
330 adj_lock (adj_index_t adj_index)
334 if (adj_index_is_special(adj_index))
339 adj = adj_get(adj_index);
342 ADJ_DBG(adj, "lock");
343 fib_node_lock(&adj->ia_node);
347 adj_unlock (adj_index_t adj_index)
351 if (adj_index_is_special(adj_index))
356 adj = adj_get(adj_index);
359 ADJ_DBG(adj, "unlock");
362 fib_node_unlock(&adj->ia_node);
366 adj_child_add (adj_index_t adj_index,
367 fib_node_type_t child_type,
368 fib_node_index_t child_index)
370 ASSERT(ADJ_INDEX_INVALID != adj_index);
371 if (adj_index_is_special(adj_index))
376 return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
383 adj_child_remove (adj_index_t adj_index,
386 if (adj_index_is_special(adj_index))
391 fib_node_child_remove(FIB_NODE_TYPE_ADJ,
397 * Context for the walk to update the cached feature flags.
399 typedef struct adj_feature_update_t_
403 } adj_feature_update_ctx_t;
406 adj_feature_update_walk_cb (adj_index_t ai,
409 adj_feature_update_ctx_t *ctx = arg;
415 * this ugly mess matches the feature arc that is changing with affected
418 if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
419 (VNET_LINK_IP6 == adj->ia_link)) ||
420 ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
421 (VNET_LINK_IP4 == adj->ia_link)) ||
422 ((ctx->arc == mpls_main.output_feature_arc_index) &&
423 (VNET_LINK_MPLS == adj->ia_link)))
425 vnet_feature_main_t *fm = &feature_main;
426 vnet_feature_config_main_t *cm;
428 cm = &fm->feature_config_mains[ctx->arc];
431 adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
433 adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
435 adj->ia_cfg_index = vec_elt (cm->config_index_by_sw_if_index,
436 adj->rewrite_header.sw_if_index);
438 return (ADJ_WALK_RC_CONTINUE);
442 adj_feature_update (u32 sw_if_index,
448 * Walk all the adjacencies on the interface to update the cached
449 * 'has-features' flag
451 adj_feature_update_ctx_t ctx = {
455 adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
459 adj_mtu_update_walk_cb (adj_index_t ai,
466 vnet_rewrite_update_mtu (vnet_get_main(), adj->ia_link,
467 &adj->rewrite_header);
469 return (ADJ_WALK_RC_CONTINUE);
472 static clib_error_t *
473 adj_mtu_update (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
475 adj_walk (sw_if_index, adj_mtu_update_walk_cb, NULL);
480 VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(adj_mtu_update);
483 * @brief Walk the Adjacencies on a given interface
486 adj_walk (u32 sw_if_index,
491 * walk all the neighbor adjacencies
493 fib_protocol_t proto;
495 FOR_EACH_FIB_IP_PROTOCOL(proto)
497 adj_nbr_walk(sw_if_index, proto, cb, ctx);
498 adj_mcast_walk(sw_if_index, proto, cb, ctx);
503 * @brief Return the link type of the adjacency
506 adj_get_link_type (adj_index_t ai)
508 const ip_adjacency_t *adj;
512 return (adj->ia_link);
516 * @brief Return the sw interface index of the adjacency.
519 adj_get_sw_if_index (adj_index_t ai)
521 const ip_adjacency_t *adj;
525 return (adj->rewrite_header.sw_if_index);
529 * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
530 * 0 is down, !0 is up.
533 adj_is_up (adj_index_t ai)
535 return (adj_bfd_is_up(ai));
539 * @brief Return the rewrite string of the adjacency
542 adj_get_rewrite (adj_index_t ai)
544 vnet_rewrite_header_t *rw;
548 rw = &adj->rewrite_header;
550 ASSERT (rw->data_bytes != 0xfefe);
552 return (rw->data - rw->data_bytes);
556 adj_get_node (fib_node_index_t index)
560 adj = adj_get(index);
562 return (&adj->ia_node);
565 #define ADJ_FROM_NODE(_node) \
566 ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
569 adj_node_last_lock_gone (fib_node_t *node)
571 adj_last_lock_gone(ADJ_FROM_NODE(node));
574 static fib_node_back_walk_rc_t
575 adj_back_walk_notify (fib_node_t *node,
576 fib_node_back_walk_ctx_t *ctx)
580 adj = ADJ_FROM_NODE(node);
582 switch (adj->lookup_next_index)
584 case IP_LOOKUP_NEXT_MIDCHAIN:
585 adj_midchain_delegate_restack(adj_get_index(adj));
587 case IP_LOOKUP_NEXT_ARP:
588 case IP_LOOKUP_NEXT_REWRITE:
589 case IP_LOOKUP_NEXT_BCAST:
590 case IP_LOOKUP_NEXT_GLEAN:
591 case IP_LOOKUP_NEXT_MCAST:
592 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
593 case IP_LOOKUP_NEXT_DROP:
594 case IP_LOOKUP_NEXT_PUNT:
595 case IP_LOOKUP_NEXT_LOCAL:
596 case IP_LOOKUP_NEXT_ICMP_ERROR:
597 case IP_LOOKUP_N_NEXT:
599 * Que pasa. yo soj en el final!
605 return (FIB_NODE_BACK_WALK_CONTINUE);
609 * Adjacency's graph node virtual function table
611 static const fib_node_vft_t adj_vft = {
612 .fnv_get = adj_get_node,
613 .fnv_last_lock = adj_node_last_lock_gone,
614 .fnv_back_walk = adj_back_walk_notify,
617 static clib_error_t *
618 adj_module_init (vlib_main_t * vm)
620 fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
622 adj_nbr_module_init();
623 adj_glean_module_init();
624 adj_midchain_module_init();
625 adj_mcast_module_init();
627 vnet_feature_register(adj_feature_update, NULL);
632 VLIB_INIT_FUNCTION (adj_module_init);
634 static clib_error_t *
635 adj_show (vlib_main_t * vm,
636 unformat_input_t * input,
637 vlib_cli_command_t * cmd)
639 adj_index_t ai = ADJ_INDEX_INVALID;
640 u32 sw_if_index = ~0;
643 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
645 if (unformat (input, "%d", &ai))
647 else if (unformat (input, "summary") || unformat (input, "sum"))
649 else if (unformat (input, "%U",
650 unformat_vnet_sw_interface, vnet_get_main(),
659 vlib_cli_output (vm, "Number of adjacencies: %d", pool_elts(adj_pool));
660 vlib_cli_output (vm, "Per-adjacency counters: %s",
661 (adj_are_counters_enabled() ?
667 if (ADJ_INDEX_INVALID != ai)
669 if (pool_is_free_index(adj_pool, ai))
671 vlib_cli_output (vm, "adjacency %d invalid", ai);
675 vlib_cli_output (vm, "[@%d] %U",
677 format_ip_adjacency, ai,
678 FORMAT_IP_ADJACENCY_DETAIL);
683 pool_foreach_index (ai, adj_pool)
685 if (~0 != sw_if_index &&
686 sw_if_index != adj_get_sw_if_index(ai))
691 vlib_cli_output (vm, "[@%d] %U",
693 format_ip_adjacency, ai,
694 FORMAT_IP_ADJACENCY_NONE);
704 * Show all adjacencies.
706 * @cliexstart{sh adj}
709 * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
710 * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
711 * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
712 * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
715 VLIB_CLI_COMMAND (adj_show_command, static) = {
717 .short_help = "show adj [<adj_index>] [interface] [summary]",
718 .function = adj_show,
722 * @brief CLI invoked function to enable/disable per-adj counters
724 static clib_error_t *
725 adj_cli_counters_set (vlib_main_t * vm,
726 unformat_input_t * input,
727 vlib_cli_command_t * cmd)
729 clib_error_t *error = NULL;
732 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
734 if (unformat (input, "enable"))
736 else if (unformat (input, "disable"))
744 /* user requested something sensible */
745 adj_per_adj_counters = enable;
749 error = clib_error_return (0, "specify 'enable' or 'disable'");
756 * Enable/disable per-adjacency counters. This is optional because it comes
757 * with a non-negligible performance cost.
759 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
760 .path = "adjacency counters",
761 .short_help = "adjacency counters [enable|disable]",
762 .function = adj_cli_counters_set,