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->rewrite_header.sw_if_index = ~0;
103 adj->rewrite_header.flags = 0;
104 adj->lookup_next_index = 0;
105 adj->ia_delegates = NULL;
107 /* lest it become a midchain in the future */
108 clib_memset(&adj->sub_type.midchain.next_dpo, 0,
109 sizeof(adj->sub_type.midchain.next_dpo));
111 if (need_barrier_sync)
112 vlib_worker_thread_barrier_release (vm);
118 adj_index_is_special (adj_index_t adj_index)
120 if (ADJ_INDEX_INVALID == adj_index)
127 format_adj_flags (u8 * s, va_list * args)
132 af = va_arg (*args, int);
134 if (ADJ_FLAG_NONE == af)
136 return (format(s, "None"));
138 FOR_EACH_ADJ_ATTR(at)
142 s = format(s, "%s ", adj_attr_names[at]);
149 * @brief Pretty print helper function for formatting specific adjacencies.
150 * @param s - input string to format
151 * @param args - other args passed to format function such as:
157 format_ip_adjacency (u8 * s, va_list * args)
159 format_ip_adjacency_flags_t fiaf;
160 ip_adjacency_t * adj;
163 adj_index = va_arg (*args, u32);
164 fiaf = va_arg (*args, format_ip_adjacency_flags_t);
166 if (!adj_is_valid(adj_index))
167 return format(s, "<invalid adjacency>");
169 adj = adj_get(adj_index);
171 switch (adj->lookup_next_index)
173 case IP_LOOKUP_NEXT_REWRITE:
174 case IP_LOOKUP_NEXT_BCAST:
175 s = format (s, "%U", format_adj_nbr, adj_index, 0);
177 case IP_LOOKUP_NEXT_ARP:
178 s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
180 case IP_LOOKUP_NEXT_GLEAN:
181 s = format (s, "%U", format_adj_glean, adj_index, 0);
183 case IP_LOOKUP_NEXT_MIDCHAIN:
184 s = format (s, "%U", format_adj_midchain, adj_index, 2);
186 case IP_LOOKUP_NEXT_MCAST:
187 s = format (s, "%U", format_adj_mcast, adj_index, 0);
189 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
190 s = format (s, "%U", format_adj_mcast_midchain, adj_index, 0);
192 case IP_LOOKUP_NEXT_DROP:
193 case IP_LOOKUP_NEXT_PUNT:
194 case IP_LOOKUP_NEXT_LOCAL:
195 case IP_LOOKUP_NEXT_ICMP_ERROR:
196 case IP_LOOKUP_N_NEXT:
200 if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
202 vlib_counter_t counts;
204 vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
205 s = format (s, "\n flags:%U", format_adj_flags, adj->ia_flags);
206 s = format (s, "\n counts:[%Ld:%Ld]", counts.packets, counts.bytes);
207 s = format (s, "\n locks:%d", adj->ia_node.fn_locks);
208 s = format(s, "\n delegates:\n ");
209 s = adj_delegate_format(s, adj);
211 s = format(s, "\n children:");
212 if (fib_node_list_get_size(adj->ia_node.fn_children))
214 s = format(s, "\n ");
215 s = fib_node_children_format(adj->ia_node.fn_children, s);
223 adj_recursive_loop_detect (adj_index_t ai,
224 fib_node_index_t **entry_indicies)
226 ip_adjacency_t * adj;
230 switch (adj->lookup_next_index)
232 case IP_LOOKUP_NEXT_REWRITE:
233 case IP_LOOKUP_NEXT_ARP:
234 case IP_LOOKUP_NEXT_GLEAN:
235 case IP_LOOKUP_NEXT_MCAST:
236 case IP_LOOKUP_NEXT_BCAST:
237 case IP_LOOKUP_NEXT_DROP:
238 case IP_LOOKUP_NEXT_PUNT:
239 case IP_LOOKUP_NEXT_LOCAL:
240 case IP_LOOKUP_NEXT_ICMP_ERROR:
241 case IP_LOOKUP_N_NEXT:
243 * these adjacency types are terminal graph nodes, so there's no
244 * possibility of a loop down here.
247 case IP_LOOKUP_NEXT_MIDCHAIN:
248 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
249 return (adj_ndr_midchain_recursive_loop_detect(ai, entry_indicies));
258 * last lock/reference to the adj has gone, we no longer need it.
261 adj_last_lock_gone (ip_adjacency_t *adj)
263 vlib_main_t * vm = vlib_get_main();
265 ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
266 ADJ_DBG(adj, "last-lock-gone");
268 adj_delegate_adj_deleted(adj);
270 vlib_worker_thread_barrier_sync (vm);
272 switch (adj->lookup_next_index)
274 case IP_LOOKUP_NEXT_MIDCHAIN:
275 adj_midchain_teardown(adj);
277 case IP_LOOKUP_NEXT_ARP:
278 case IP_LOOKUP_NEXT_REWRITE:
279 case IP_LOOKUP_NEXT_BCAST:
281 * complete and incomplete nbr adjs
283 adj_nbr_remove(adj_get_index(adj),
286 &adj->sub_type.nbr.next_hop,
287 adj->rewrite_header.sw_if_index);
289 case IP_LOOKUP_NEXT_GLEAN:
290 adj_glean_remove(adj->ia_nh_proto,
291 adj->rewrite_header.sw_if_index);
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)))
426 adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
428 adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
430 return (ADJ_WALK_RC_CONTINUE);
434 adj_feature_update (u32 sw_if_index,
439 * Walk all the adjacencies on the interface to update the cached
440 * 'has-features' flag
442 adj_feature_update_ctx_t ctx = {
446 adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
450 adj_mtu_update_walk_cb (adj_index_t ai,
457 vnet_rewrite_update_mtu (vnet_get_main(), adj->ia_link,
458 &adj->rewrite_header);
460 return (ADJ_WALK_RC_CONTINUE);
463 static clib_error_t *
464 adj_mtu_update (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
466 adj_walk (sw_if_index, adj_mtu_update_walk_cb, NULL);
471 VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(adj_mtu_update);
474 * @brief Walk the Adjacencies on a given interface
477 adj_walk (u32 sw_if_index,
482 * walk all the neighbor adjacencies
484 fib_protocol_t proto;
486 FOR_EACH_FIB_IP_PROTOCOL(proto)
488 adj_nbr_walk(sw_if_index, proto, cb, ctx);
489 adj_mcast_walk(sw_if_index, proto, cb, ctx);
494 * @brief Return the link type of the adjacency
497 adj_get_link_type (adj_index_t ai)
499 const ip_adjacency_t *adj;
503 return (adj->ia_link);
507 * @brief Return the sw interface index of the adjacency.
510 adj_get_sw_if_index (adj_index_t ai)
512 const ip_adjacency_t *adj;
516 return (adj->rewrite_header.sw_if_index);
520 * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
521 * 0 is down, !0 is up.
524 adj_is_up (adj_index_t ai)
526 return (adj_bfd_is_up(ai));
530 * @brief Return the rewrite string of the adjacency
533 adj_get_rewrite (adj_index_t ai)
535 vnet_rewrite_header_t *rw;
539 rw = &adj->rewrite_header;
541 ASSERT (rw->data_bytes != 0xfefe);
543 return (rw->data - rw->data_bytes);
547 adj_get_node (fib_node_index_t index)
551 adj = adj_get(index);
553 return (&adj->ia_node);
556 #define ADJ_FROM_NODE(_node) \
557 ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
560 adj_node_last_lock_gone (fib_node_t *node)
562 adj_last_lock_gone(ADJ_FROM_NODE(node));
565 static fib_node_back_walk_rc_t
566 adj_back_walk_notify (fib_node_t *node,
567 fib_node_back_walk_ctx_t *ctx)
571 adj = ADJ_FROM_NODE(node);
573 switch (adj->lookup_next_index)
575 case IP_LOOKUP_NEXT_MIDCHAIN:
576 adj_midchain_delegate_restack(adj_get_index(adj));
578 case IP_LOOKUP_NEXT_ARP:
579 case IP_LOOKUP_NEXT_REWRITE:
580 case IP_LOOKUP_NEXT_BCAST:
581 case IP_LOOKUP_NEXT_GLEAN:
582 case IP_LOOKUP_NEXT_MCAST:
583 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
584 case IP_LOOKUP_NEXT_DROP:
585 case IP_LOOKUP_NEXT_PUNT:
586 case IP_LOOKUP_NEXT_LOCAL:
587 case IP_LOOKUP_NEXT_ICMP_ERROR:
588 case IP_LOOKUP_N_NEXT:
590 * Que pasa. yo soj en el final!
596 return (FIB_NODE_BACK_WALK_CONTINUE);
600 * Adjacency's graph node virtual function table
602 static const fib_node_vft_t adj_vft = {
603 .fnv_get = adj_get_node,
604 .fnv_last_lock = adj_node_last_lock_gone,
605 .fnv_back_walk = adj_back_walk_notify,
608 static clib_error_t *
609 adj_module_init (vlib_main_t * vm)
611 fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
613 adj_nbr_module_init();
614 adj_glean_module_init();
615 adj_midchain_module_init();
616 adj_mcast_module_init();
621 VLIB_INIT_FUNCTION (adj_module_init);
623 static clib_error_t *
624 adj_show (vlib_main_t * vm,
625 unformat_input_t * input,
626 vlib_cli_command_t * cmd)
628 adj_index_t ai = ADJ_INDEX_INVALID;
629 u32 sw_if_index = ~0;
632 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
634 if (unformat (input, "%d", &ai))
636 else if (unformat (input, "summary") || unformat (input, "sum"))
638 else if (unformat (input, "%U",
639 unformat_vnet_sw_interface, vnet_get_main(),
648 vlib_cli_output (vm, "Number of adjacencies: %d", pool_elts(adj_pool));
649 vlib_cli_output (vm, "Per-adjacency counters: %s",
650 (adj_are_counters_enabled() ?
656 if (ADJ_INDEX_INVALID != ai)
658 if (pool_is_free_index(adj_pool, ai))
660 vlib_cli_output (vm, "adjacency %d invalid", ai);
664 vlib_cli_output (vm, "[@%d] %U",
666 format_ip_adjacency, ai,
667 FORMAT_IP_ADJACENCY_DETAIL);
672 pool_foreach_index(ai, adj_pool,
674 if (~0 != sw_if_index &&
675 sw_if_index != adj_get_sw_if_index(ai))
680 vlib_cli_output (vm, "[@%d] %U",
682 format_ip_adjacency, ai,
683 FORMAT_IP_ADJACENCY_NONE);
693 * Show all adjacencies.
695 * @cliexstart{sh adj}
698 * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
699 * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
700 * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
701 * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
704 VLIB_CLI_COMMAND (adj_show_command, static) = {
706 .short_help = "show adj [<adj_index>] [interface] [summary]",
707 .function = adj_show,
711 * @brief CLI invoked function to enable/disable per-adj counters
713 static clib_error_t *
714 adj_cli_counters_set (vlib_main_t * vm,
715 unformat_input_t * input,
716 vlib_cli_command_t * cmd)
718 clib_error_t *error = NULL;
721 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
723 if (unformat (input, "enable"))
725 else if (unformat (input, "disable"))
733 /* user requested something sensible */
734 adj_per_adj_counters = enable;
738 error = clib_error_return (0, "specify 'enable' or 'disable'");
745 * Enable/disable per-adjacency counters. This is optional because it comes
746 * with a non-negligible performance cost.
748 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
749 .path = "adjacency counters",
750 .short_help = "adjacency counters [enable|disable]",
751 .function = adj_cli_counters_set,