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->rewrite_header.sw_if_index = ~0;
83 adj->rewrite_header.flags = 0;
84 adj->lookup_next_index = 0;
85 adj->ia_delegates = NULL;
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));
95 adj_index_is_special (adj_index_t adj_index)
97 if (ADJ_INDEX_INVALID == adj_index)
104 format_adj_flags (u8 * s, va_list * args)
109 af = va_arg (*args, int);
111 if (ADJ_FLAG_NONE == af)
113 return (format(s, "None"));
115 FOR_EACH_ADJ_ATTR(at)
119 s = format(s, "%s ", adj_attr_names[at]);
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:
134 format_ip_adjacency (u8 * s, va_list * args)
136 format_ip_adjacency_flags_t fiaf;
137 ip_adjacency_t * adj;
140 adj_index = va_arg (*args, u32);
141 fiaf = va_arg (*args, format_ip_adjacency_flags_t);
142 adj = adj_get(adj_index);
144 switch (adj->lookup_next_index)
146 case IP_LOOKUP_NEXT_REWRITE:
147 case IP_LOOKUP_NEXT_BCAST:
148 s = format (s, "%U", format_adj_nbr, adj_index, 0);
150 case IP_LOOKUP_NEXT_ARP:
151 s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
153 case IP_LOOKUP_NEXT_GLEAN:
154 s = format (s, "%U", format_adj_glean, adj_index, 0);
156 case IP_LOOKUP_NEXT_MIDCHAIN:
157 s = format (s, "%U", format_adj_midchain, adj_index, 2);
159 case IP_LOOKUP_NEXT_MCAST:
160 s = format (s, "%U", format_adj_mcast, adj_index, 0);
162 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
163 s = format (s, "%U", format_adj_mcast_midchain, adj_index, 0);
165 case IP_LOOKUP_NEXT_DROP:
166 case IP_LOOKUP_NEXT_PUNT:
167 case IP_LOOKUP_NEXT_LOCAL:
168 case IP_LOOKUP_NEXT_ICMP_ERROR:
169 case IP_LOOKUP_N_NEXT:
173 if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
175 vlib_counter_t counts;
177 vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
178 s = format (s, "\n flags:%U", format_adj_flags, adj->ia_flags);
179 s = format (s, "\n counts:[%Ld:%Ld]", counts.packets, counts.bytes);
180 s = format (s, "\n locks:%d", adj->ia_node.fn_locks);
181 s = format(s, "\n delegates:\n ");
182 adj_delegate_format(s, adj);
184 s = format(s, "\n children:");
185 if (fib_node_list_get_size(adj->ia_node.fn_children))
187 s = format(s, "\n ");
188 s = fib_node_children_format(adj->ia_node.fn_children, s);
196 adj_recursive_loop_detect (adj_index_t ai,
197 fib_node_index_t **entry_indicies)
199 ip_adjacency_t * adj;
203 switch (adj->lookup_next_index)
205 case IP_LOOKUP_NEXT_REWRITE:
206 case IP_LOOKUP_NEXT_ARP:
207 case IP_LOOKUP_NEXT_GLEAN:
208 case IP_LOOKUP_NEXT_MCAST:
209 case IP_LOOKUP_NEXT_BCAST:
210 case IP_LOOKUP_NEXT_DROP:
211 case IP_LOOKUP_NEXT_PUNT:
212 case IP_LOOKUP_NEXT_LOCAL:
213 case IP_LOOKUP_NEXT_ICMP_ERROR:
214 case IP_LOOKUP_N_NEXT:
216 * these adjcencey types are terminal graph nodes, so there's no
217 * possibility of a loop down here.
220 case IP_LOOKUP_NEXT_MIDCHAIN:
221 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
222 return (adj_ndr_midchain_recursive_loop_detect(ai, entry_indicies));
231 * last lock/reference to the adj has gone, we no longer need it.
234 adj_last_lock_gone (ip_adjacency_t *adj)
236 vlib_main_t * vm = vlib_get_main();
238 ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
239 ADJ_DBG(adj, "last-lock-gone");
241 adj_delegate_adj_deleted(adj);
243 vlib_worker_thread_barrier_sync (vm);
245 switch (adj->lookup_next_index)
247 case IP_LOOKUP_NEXT_MIDCHAIN:
248 dpo_reset(&adj->sub_type.midchain.next_dpo);
250 case IP_LOOKUP_NEXT_ARP:
251 case IP_LOOKUP_NEXT_REWRITE:
252 case IP_LOOKUP_NEXT_BCAST:
254 * complete and incomplete nbr adjs
256 adj_nbr_remove(adj_get_index(adj),
259 &adj->sub_type.nbr.next_hop,
260 adj->rewrite_header.sw_if_index);
262 case IP_LOOKUP_NEXT_GLEAN:
263 adj_glean_remove(adj->ia_nh_proto,
264 adj->rewrite_header.sw_if_index);
266 case IP_LOOKUP_NEXT_MCAST:
267 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
268 adj_mcast_remove(adj->ia_nh_proto,
269 adj->rewrite_header.sw_if_index);
271 case IP_LOOKUP_NEXT_DROP:
272 case IP_LOOKUP_NEXT_PUNT:
273 case IP_LOOKUP_NEXT_LOCAL:
274 case IP_LOOKUP_NEXT_ICMP_ERROR:
275 case IP_LOOKUP_N_NEXT:
277 * type not stored in any DB from which we need to remove it
282 vlib_worker_thread_barrier_release(vm);
284 fib_node_deinit(&adj->ia_node);
285 ASSERT(0 == vec_len(adj->ia_delegates));
286 vec_free(adj->ia_delegates);
287 pool_put(adj_pool, adj);
291 adj_dpo_get_urpf (const dpo_id_t *dpo)
295 adj = adj_get(dpo->dpoi_index);
297 return (adj->rewrite_header.sw_if_index);
301 adj_lock (adj_index_t adj_index)
305 if (adj_index_is_special(adj_index))
310 adj = adj_get(adj_index);
313 ADJ_DBG(adj, "lock");
314 fib_node_lock(&adj->ia_node);
318 adj_unlock (adj_index_t adj_index)
322 if (adj_index_is_special(adj_index))
327 adj = adj_get(adj_index);
330 ADJ_DBG(adj, "unlock");
333 fib_node_unlock(&adj->ia_node);
337 adj_child_add (adj_index_t adj_index,
338 fib_node_type_t child_type,
339 fib_node_index_t child_index)
341 ASSERT(ADJ_INDEX_INVALID != adj_index);
342 if (adj_index_is_special(adj_index))
347 return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
354 adj_child_remove (adj_index_t adj_index,
357 if (adj_index_is_special(adj_index))
362 fib_node_child_remove(FIB_NODE_TYPE_ADJ,
368 * Context for the walk to update the cached feture flags.
370 typedef struct adj_feature_update_t_
374 } adj_feature_update_ctx_t;
377 adj_feature_update_walk_cb (adj_index_t ai,
380 adj_feature_update_ctx_t *ctx = arg;
386 * this ugly mess matches the feature arc that is changing with affected
389 if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
390 (VNET_LINK_IP6 == adj->ia_link)) ||
391 ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
392 (VNET_LINK_IP4 == adj->ia_link)) ||
393 ((ctx->arc == mpls_main.output_feature_arc_index) &&
394 (VNET_LINK_MPLS == adj->ia_link)))
397 adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
399 adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
401 return (ADJ_WALK_RC_CONTINUE);
405 adj_feature_update (u32 sw_if_index,
410 * Walk all the adjacencies on the interface to update the cached
411 * 'has-features' flag
413 adj_feature_update_ctx_t ctx = {
417 adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
421 adj_mtu_update_walk_cb (adj_index_t ai,
428 vnet_rewrite_update_mtu (vnet_get_main(), adj->ia_link,
429 &adj->rewrite_header);
431 return (ADJ_WALK_RC_CONTINUE);
434 static clib_error_t *
435 adj_mtu_update (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
437 adj_walk (sw_if_index, adj_mtu_update_walk_cb, NULL);
442 VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(adj_mtu_update);
445 * @brief Walk the Adjacencies on a given interface
448 adj_walk (u32 sw_if_index,
453 * walk all the neighbor adjacencies
455 fib_protocol_t proto;
457 FOR_EACH_FIB_IP_PROTOCOL(proto)
459 adj_nbr_walk(sw_if_index, proto, cb, ctx);
460 adj_mcast_walk(sw_if_index, proto, cb, ctx);
465 * @brief Return the link type of the adjacency
468 adj_get_link_type (adj_index_t ai)
470 const ip_adjacency_t *adj;
474 return (adj->ia_link);
478 * @brief Return the sw interface index of the adjacency.
481 adj_get_sw_if_index (adj_index_t ai)
483 const ip_adjacency_t *adj;
487 return (adj->rewrite_header.sw_if_index);
491 * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
492 * 0 is down, !0 is up.
495 adj_is_up (adj_index_t ai)
497 return (adj_bfd_is_up(ai));
501 * @brief Return the rewrite string of the adjacency
504 adj_get_rewrite (adj_index_t ai)
506 vnet_rewrite_header_t *rw;
510 rw = &adj->rewrite_header;
512 ASSERT (rw->data_bytes != 0xfefe);
514 return (rw->data - rw->data_bytes);
518 adj_get_node (fib_node_index_t index)
522 adj = adj_get(index);
524 return (&adj->ia_node);
527 #define ADJ_FROM_NODE(_node) \
528 ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
531 adj_node_last_lock_gone (fib_node_t *node)
533 adj_last_lock_gone(ADJ_FROM_NODE(node));
536 static fib_node_back_walk_rc_t
537 adj_back_walk_notify (fib_node_t *node,
538 fib_node_back_walk_ctx_t *ctx)
541 * Que pasa. yo soj en el final!
545 return (FIB_NODE_BACK_WALK_CONTINUE);
549 * Adjacency's graph node virtual function table
551 static const fib_node_vft_t adj_vft = {
552 .fnv_get = adj_get_node,
553 .fnv_last_lock = adj_node_last_lock_gone,
554 .fnv_back_walk = adj_back_walk_notify,
557 static clib_error_t *
558 adj_module_init (vlib_main_t * vm)
560 fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
562 adj_nbr_module_init();
563 adj_glean_module_init();
564 adj_midchain_module_init();
565 adj_mcast_module_init();
570 VLIB_INIT_FUNCTION (adj_module_init);
572 static clib_error_t *
573 adj_show (vlib_main_t * vm,
574 unformat_input_t * input,
575 vlib_cli_command_t * cmd)
577 adj_index_t ai = ADJ_INDEX_INVALID;
578 u32 sw_if_index = ~0;
581 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
583 if (unformat (input, "%d", &ai))
585 else if (unformat (input, "sum"))
587 else if (unformat (input, "summary"))
589 else if (unformat (input, "%U",
590 unformat_vnet_sw_interface, vnet_get_main(),
599 vlib_cli_output (vm, "Number of adjacencies: %d", pool_elts(adj_pool));
600 vlib_cli_output (vm, "Per-adjacency counters: %s",
601 (adj_are_counters_enabled() ?
607 if (ADJ_INDEX_INVALID != ai)
609 if (pool_is_free_index(adj_pool, ai))
611 vlib_cli_output (vm, "adjacency %d invalid", ai);
615 vlib_cli_output (vm, "[@%d] %U",
617 format_ip_adjacency, ai,
618 FORMAT_IP_ADJACENCY_DETAIL);
623 pool_foreach_index(ai, adj_pool,
625 if (~0 != sw_if_index &&
626 sw_if_index != adj_get_sw_if_index(ai))
631 vlib_cli_output (vm, "[@%d] %U",
633 format_ip_adjacency, ai,
634 FORMAT_IP_ADJACENCY_NONE);
644 * Show all adjacencies.
646 * @cliexstart{sh adj}
649 * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
650 * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
651 * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
652 * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
655 VLIB_CLI_COMMAND (adj_show_command, static) = {
657 .short_help = "show adj [<adj_index>] [interface] [summary]",
658 .function = adj_show,
662 * @brief CLI invoked function to enable/disable per-adj counters
664 static clib_error_t *
665 adj_cli_counters_set (vlib_main_t * vm,
666 unformat_input_t * input,
667 vlib_cli_command_t * cmd)
669 clib_error_t *error = NULL;
672 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
674 if (unformat (input, "enable"))
676 else if (unformat (input, "disable"))
684 /* user requested something sensible */
685 adj_per_adj_counters = enable;
689 error = clib_error_return (0, "specify 'enable' or 'disable'");
696 * Enabe/disble per-adjacency counters. This is optional because it comes with
697 * a non-negligible performance cost.
699 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
700 .path = "adjacency counters",
701 .short_help = "adjacency counters [enable|disable]",
702 .function = adj_cli_counters_set,