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)
67 pool_get_aligned(adj_pool, adj, CLIB_CACHE_LINE_BYTES);
71 /* Make sure certain fields are always initialized. */
72 /* Validate adjacency counters. */
73 vlib_validate_combined_counter(&adjacency_counters,
75 vlib_zero_combined_counter(&adjacency_counters,
77 fib_node_init(&adj->ia_node,
80 adj->ia_nh_proto = proto;
82 adj->ia_cfg_index = 0;
83 adj->rewrite_header.sw_if_index = ~0;
84 adj->rewrite_header.flags = 0;
85 adj->lookup_next_index = 0;
86 adj->ia_delegates = NULL;
88 /* lest it become a midchain in the future */
89 clib_memset(&adj->sub_type.midchain.next_dpo, 0,
90 sizeof(adj->sub_type.midchain.next_dpo));
96 adj_index_is_special (adj_index_t adj_index)
98 if (ADJ_INDEX_INVALID == adj_index)
105 format_adj_flags (u8 * s, va_list * args)
110 af = va_arg (*args, int);
112 if (ADJ_FLAG_NONE == af)
114 return (format(s, "None"));
116 FOR_EACH_ADJ_ATTR(at)
120 s = format(s, "%s ", adj_attr_names[at]);
127 * @brief Pretty print helper function for formatting specific adjacencies.
128 * @param s - input string to format
129 * @param args - other args passed to format function such as:
135 format_ip_adjacency (u8 * s, va_list * args)
137 format_ip_adjacency_flags_t fiaf;
138 ip_adjacency_t * adj;
141 adj_index = va_arg (*args, u32);
142 fiaf = va_arg (*args, format_ip_adjacency_flags_t);
144 if (!adj_is_valid(adj_index))
145 return format(s, "<invalid adjacency>");
147 adj = adj_get(adj_index);
149 switch (adj->lookup_next_index)
151 case IP_LOOKUP_NEXT_REWRITE:
152 case IP_LOOKUP_NEXT_BCAST:
153 s = format (s, "%U", format_adj_nbr, adj_index, 0);
155 case IP_LOOKUP_NEXT_ARP:
156 s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
158 case IP_LOOKUP_NEXT_GLEAN:
159 s = format (s, "%U", format_adj_glean, adj_index, 0);
161 case IP_LOOKUP_NEXT_MIDCHAIN:
162 s = format (s, "%U", format_adj_midchain, adj_index, 2);
164 case IP_LOOKUP_NEXT_MCAST:
165 s = format (s, "%U", format_adj_mcast, adj_index, 0);
167 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
168 s = format (s, "%U", format_adj_mcast_midchain, adj_index, 0);
170 case IP_LOOKUP_NEXT_DROP:
171 case IP_LOOKUP_NEXT_PUNT:
172 case IP_LOOKUP_NEXT_LOCAL:
173 case IP_LOOKUP_NEXT_ICMP_ERROR:
174 case IP_LOOKUP_N_NEXT:
178 if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
180 vlib_counter_t counts;
182 vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
183 s = format (s, "\n flags:%U", format_adj_flags, adj->ia_flags);
184 s = format (s, "\n counts:[%Ld:%Ld]", counts.packets, counts.bytes);
185 s = format (s, "\n locks:%d", adj->ia_node.fn_locks);
186 s = format(s, "\n delegates:");
187 s = adj_delegate_format(s, adj);
189 s = format(s, "\n children:");
190 if (fib_node_list_get_size(adj->ia_node.fn_children))
192 s = format(s, "\n ");
193 s = fib_node_children_format(adj->ia_node.fn_children, s);
201 adj_recursive_loop_detect (adj_index_t ai,
202 fib_node_index_t **entry_indicies)
204 ip_adjacency_t * adj;
208 switch (adj->lookup_next_index)
210 case IP_LOOKUP_NEXT_REWRITE:
211 case IP_LOOKUP_NEXT_ARP:
212 case IP_LOOKUP_NEXT_GLEAN:
213 case IP_LOOKUP_NEXT_MCAST:
214 case IP_LOOKUP_NEXT_BCAST:
215 case IP_LOOKUP_NEXT_DROP:
216 case IP_LOOKUP_NEXT_PUNT:
217 case IP_LOOKUP_NEXT_LOCAL:
218 case IP_LOOKUP_NEXT_ICMP_ERROR:
219 case IP_LOOKUP_N_NEXT:
221 * these adjacency types are terminal graph nodes, so there's no
222 * possibility of a loop down here.
225 case IP_LOOKUP_NEXT_MIDCHAIN:
226 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
227 return (adj_ndr_midchain_recursive_loop_detect(ai, entry_indicies));
236 * last lock/reference to the adj has gone, we no longer need it.
239 adj_last_lock_gone (ip_adjacency_t *adj)
241 vlib_main_t * vm = vlib_get_main();
243 ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
244 ADJ_DBG(adj, "last-lock-gone");
246 adj_delegate_adj_deleted(adj);
248 vlib_worker_thread_barrier_sync (vm);
250 switch (adj->lookup_next_index)
252 case IP_LOOKUP_NEXT_MIDCHAIN:
253 adj_midchain_teardown(adj);
255 case IP_LOOKUP_NEXT_ARP:
256 case IP_LOOKUP_NEXT_REWRITE:
257 case IP_LOOKUP_NEXT_BCAST:
259 * complete and incomplete nbr adjs
261 adj_nbr_remove(adj_get_index(adj),
264 &adj->sub_type.nbr.next_hop,
265 adj->rewrite_header.sw_if_index);
267 case IP_LOOKUP_NEXT_GLEAN:
268 adj_glean_remove(adj->ia_nh_proto,
269 adj->rewrite_header.sw_if_index);
271 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
272 adj_midchain_teardown(adj);
274 case IP_LOOKUP_NEXT_MCAST:
275 adj_mcast_remove(adj->ia_nh_proto,
276 adj->rewrite_header.sw_if_index);
278 case IP_LOOKUP_NEXT_DROP:
279 case IP_LOOKUP_NEXT_PUNT:
280 case IP_LOOKUP_NEXT_LOCAL:
281 case IP_LOOKUP_NEXT_ICMP_ERROR:
282 case IP_LOOKUP_N_NEXT:
284 * type not stored in any DB from which we need to remove it
289 vlib_worker_thread_barrier_release(vm);
291 fib_node_deinit(&adj->ia_node);
292 ASSERT(0 == vec_len(adj->ia_delegates));
293 vec_free(adj->ia_delegates);
294 pool_put(adj_pool, adj);
298 adj_dpo_get_urpf (const dpo_id_t *dpo)
302 adj = adj_get(dpo->dpoi_index);
304 return (adj->rewrite_header.sw_if_index);
308 adj_lock (adj_index_t adj_index)
312 if (adj_index_is_special(adj_index))
317 adj = adj_get(adj_index);
320 ADJ_DBG(adj, "lock");
321 fib_node_lock(&adj->ia_node);
325 adj_unlock (adj_index_t adj_index)
329 if (adj_index_is_special(adj_index))
334 adj = adj_get(adj_index);
337 ADJ_DBG(adj, "unlock");
340 fib_node_unlock(&adj->ia_node);
344 adj_child_add (adj_index_t adj_index,
345 fib_node_type_t child_type,
346 fib_node_index_t child_index)
348 ASSERT(ADJ_INDEX_INVALID != adj_index);
349 if (adj_index_is_special(adj_index))
354 return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
361 adj_child_remove (adj_index_t adj_index,
364 if (adj_index_is_special(adj_index))
369 fib_node_child_remove(FIB_NODE_TYPE_ADJ,
375 * Context for the walk to update the cached feature flags.
377 typedef struct adj_feature_update_t_
381 } adj_feature_update_ctx_t;
384 adj_feature_update_walk_cb (adj_index_t ai,
387 adj_feature_update_ctx_t *ctx = arg;
393 * this ugly mess matches the feature arc that is changing with affected
396 if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
397 (VNET_LINK_IP6 == adj->ia_link)) ||
398 ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
399 (VNET_LINK_IP4 == adj->ia_link)) ||
400 ((ctx->arc == mpls_main.output_feature_arc_index) &&
401 (VNET_LINK_MPLS == adj->ia_link)))
403 vnet_feature_main_t *fm = &feature_main;
404 vnet_feature_config_main_t *cm;
406 cm = &fm->feature_config_mains[ctx->arc];
409 adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
411 adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
413 adj->ia_cfg_index = vec_elt (cm->config_index_by_sw_if_index,
414 adj->rewrite_header.sw_if_index);
416 return (ADJ_WALK_RC_CONTINUE);
420 adj_feature_update (u32 sw_if_index,
426 * Walk all the adjacencies on the interface to update the cached
427 * 'has-features' flag
429 adj_feature_update_ctx_t ctx = {
433 adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
437 adj_mtu_update_walk_cb (adj_index_t ai,
444 vnet_rewrite_update_mtu (vnet_get_main(), adj->ia_link,
445 &adj->rewrite_header);
447 return (ADJ_WALK_RC_CONTINUE);
450 static clib_error_t *
451 adj_mtu_update (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
453 adj_walk (sw_if_index, adj_mtu_update_walk_cb, NULL);
458 VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(adj_mtu_update);
461 * @brief Walk the Adjacencies on a given interface
464 adj_walk (u32 sw_if_index,
469 * walk all the neighbor adjacencies
471 fib_protocol_t proto;
473 FOR_EACH_FIB_IP_PROTOCOL(proto)
475 adj_nbr_walk(sw_if_index, proto, cb, ctx);
476 adj_mcast_walk(sw_if_index, proto, cb, ctx);
481 * @brief Return the link type of the adjacency
484 adj_get_link_type (adj_index_t ai)
486 const ip_adjacency_t *adj;
490 return (adj->ia_link);
494 * @brief Return the sw interface index of the adjacency.
497 adj_get_sw_if_index (adj_index_t ai)
499 const ip_adjacency_t *adj;
503 return (adj->rewrite_header.sw_if_index);
507 * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
508 * 0 is down, !0 is up.
511 adj_is_up (adj_index_t ai)
513 return (adj_bfd_is_up(ai));
517 * @brief Return the rewrite string of the adjacency
520 adj_get_rewrite (adj_index_t ai)
522 vnet_rewrite_header_t *rw;
526 rw = &adj->rewrite_header;
528 ASSERT (rw->data_bytes != 0xfefe);
530 return (rw->data - rw->data_bytes);
534 adj_get_node (fib_node_index_t index)
538 adj = adj_get(index);
540 return (&adj->ia_node);
543 #define ADJ_FROM_NODE(_node) \
544 ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
547 adj_node_last_lock_gone (fib_node_t *node)
549 adj_last_lock_gone(ADJ_FROM_NODE(node));
552 static fib_node_back_walk_rc_t
553 adj_back_walk_notify (fib_node_t *node,
554 fib_node_back_walk_ctx_t *ctx)
558 adj = ADJ_FROM_NODE(node);
560 switch (adj->lookup_next_index)
562 case IP_LOOKUP_NEXT_MIDCHAIN:
563 adj_midchain_delegate_restack(adj_get_index(adj));
565 case IP_LOOKUP_NEXT_ARP:
566 case IP_LOOKUP_NEXT_REWRITE:
567 case IP_LOOKUP_NEXT_BCAST:
568 case IP_LOOKUP_NEXT_GLEAN:
569 case IP_LOOKUP_NEXT_MCAST:
570 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
571 case IP_LOOKUP_NEXT_DROP:
572 case IP_LOOKUP_NEXT_PUNT:
573 case IP_LOOKUP_NEXT_LOCAL:
574 case IP_LOOKUP_NEXT_ICMP_ERROR:
575 case IP_LOOKUP_N_NEXT:
577 * Que pasa. yo soj en el final!
583 return (FIB_NODE_BACK_WALK_CONTINUE);
587 * Adjacency's graph node virtual function table
589 static const fib_node_vft_t adj_vft = {
590 .fnv_get = adj_get_node,
591 .fnv_last_lock = adj_node_last_lock_gone,
592 .fnv_back_walk = adj_back_walk_notify,
595 static clib_error_t *
596 adj_module_init (vlib_main_t * vm)
598 fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
600 adj_nbr_module_init();
601 adj_glean_module_init();
602 adj_midchain_module_init();
603 adj_mcast_module_init();
605 vnet_feature_register(adj_feature_update, NULL);
610 VLIB_INIT_FUNCTION (adj_module_init);
612 static clib_error_t *
613 adj_show (vlib_main_t * vm,
614 unformat_input_t * input,
615 vlib_cli_command_t * cmd)
617 adj_index_t ai = ADJ_INDEX_INVALID;
618 u32 sw_if_index = ~0;
621 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
623 if (unformat (input, "%d", &ai))
625 else if (unformat (input, "summary") || unformat (input, "sum"))
627 else if (unformat (input, "%U",
628 unformat_vnet_sw_interface, vnet_get_main(),
637 vlib_cli_output (vm, "Number of adjacencies: %d", pool_elts(adj_pool));
638 vlib_cli_output (vm, "Per-adjacency counters: %s",
639 (adj_are_counters_enabled() ?
645 if (ADJ_INDEX_INVALID != ai)
647 if (pool_is_free_index(adj_pool, ai))
649 vlib_cli_output (vm, "adjacency %d invalid", ai);
653 vlib_cli_output (vm, "[@%d] %U",
655 format_ip_adjacency, ai,
656 FORMAT_IP_ADJACENCY_DETAIL);
661 pool_foreach_index(ai, adj_pool,
663 if (~0 != sw_if_index &&
664 sw_if_index != adj_get_sw_if_index(ai))
669 vlib_cli_output (vm, "[@%d] %U",
671 format_ip_adjacency, ai,
672 FORMAT_IP_ADJACENCY_NONE);
682 * Show all adjacencies.
684 * @cliexstart{sh adj}
687 * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
688 * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
689 * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
690 * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
693 VLIB_CLI_COMMAND (adj_show_command, static) = {
695 .short_help = "show adj [<adj_index>] [interface] [summary]",
696 .function = adj_show,
700 * @brief CLI invoked function to enable/disable per-adj counters
702 static clib_error_t *
703 adj_cli_counters_set (vlib_main_t * vm,
704 unformat_input_t * input,
705 vlib_cli_command_t * cmd)
707 clib_error_t *error = NULL;
710 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
712 if (unformat (input, "enable"))
714 else if (unformat (input, "disable"))
722 /* user requested something sensible */
723 adj_per_adj_counters = enable;
727 error = clib_error_return (0, "specify 'enable' or 'disable'");
734 * Enable/disable per-adjacency counters. This is optional because it comes
735 * with a non-negligible performance cost.
737 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
738 .path = "adjacency counters",
739 .short_help = "adjacency counters [enable|disable]",
740 .function = adj_cli_counters_set,