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;
30 ip_adjacency_t *adj_pool;
33 * @brief Global Config for enabling per-adjacency counters.
34 * By default these are disabled.
36 int adj_per_adj_counters;
39 adj_poison (ip_adjacency_t * adj)
43 memset (adj, 0xfe, sizeof (adj[0]));
48 adj_alloc (fib_protocol_t proto)
52 pool_get_aligned(adj_pool, adj, CLIB_CACHE_LINE_BYTES);
56 /* Make sure certain fields are always initialized. */
57 /* Validate adjacency counters. */
58 vlib_validate_combined_counter(&adjacency_counters,
61 fib_node_init(&adj->ia_node,
64 adj->ia_nh_proto = proto;
66 adj->rewrite_header.sw_if_index = ~0;
67 adj->lookup_next_index = 0;
68 adj->ia_delegates = NULL;
70 ip4_main.lookup_main.adjacency_heap = adj_pool;
71 ip6_main.lookup_main.adjacency_heap = adj_pool;
77 adj_index_is_special (adj_index_t adj_index)
79 if (ADJ_INDEX_INVALID == adj_index)
86 * @brief Pretty print helper function for formatting specific adjacencies.
87 * @param s - input string to format
88 * @param args - other args passed to format function such as:
94 format_ip_adjacency (u8 * s, va_list * args)
96 format_ip_adjacency_flags_t fiaf;
100 adj_index = va_arg (*args, u32);
101 fiaf = va_arg (*args, format_ip_adjacency_flags_t);
102 adj = adj_get(adj_index);
104 switch (adj->lookup_next_index)
106 case IP_LOOKUP_NEXT_REWRITE:
107 s = format (s, "%U", format_adj_nbr, adj_index, 0);
109 case IP_LOOKUP_NEXT_ARP:
110 s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
112 case IP_LOOKUP_NEXT_GLEAN:
113 s = format (s, "%U", format_adj_glean, adj_index, 0);
115 case IP_LOOKUP_NEXT_MIDCHAIN:
116 s = format (s, "%U", format_adj_midchain, adj_index, 2);
118 case IP_LOOKUP_NEXT_MCAST:
119 s = format (s, "%U", format_adj_mcast, adj_index, 0);
125 if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
127 adj_delegate_type_t adt;
129 vlib_counter_t counts;
131 vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
132 s = format (s, "\n counts:[%Ld:%Ld]", counts.packets, counts.bytes);
133 s = format (s, "\n locks:%d", adj->ia_node.fn_locks);
134 s = format(s, "\n delegates:\n ");
135 FOR_EACH_ADJ_DELEGATE(adj, adt, aed,
137 s = format(s, " %U\n", format_adj_deletegate, aed);
140 s = format(s, "\n children:\n ");
141 s = fib_node_children_format(adj->ia_node.fn_children, s);
150 * last lock/reference to the adj has gone, we no longer need it.
153 adj_last_lock_gone (ip_adjacency_t *adj)
155 vlib_main_t * vm = vlib_get_main();
157 ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
158 ADJ_DBG(adj, "last-lock-gone");
160 vlib_worker_thread_barrier_sync (vm);
162 switch (adj->lookup_next_index)
164 case IP_LOOKUP_NEXT_MIDCHAIN:
165 dpo_reset(&adj->sub_type.midchain.next_dpo);
167 case IP_LOOKUP_NEXT_ARP:
168 case IP_LOOKUP_NEXT_REWRITE:
170 * complete and incomplete nbr adjs
172 adj_nbr_remove(adj_get_index(adj),
175 &adj->sub_type.nbr.next_hop,
176 adj->rewrite_header.sw_if_index);
178 case IP_LOOKUP_NEXT_GLEAN:
179 adj_glean_remove(adj->ia_nh_proto,
180 adj->rewrite_header.sw_if_index);
182 case IP_LOOKUP_NEXT_MCAST:
183 adj_mcast_remove(adj->ia_nh_proto,
184 adj->rewrite_header.sw_if_index);
186 case IP_LOOKUP_NEXT_DROP:
187 case IP_LOOKUP_NEXT_PUNT:
188 case IP_LOOKUP_NEXT_LOCAL:
189 case IP_LOOKUP_NEXT_ICMP_ERROR:
190 case IP_LOOKUP_N_NEXT:
192 * type not stored in any DB from which we need to remove it
197 vlib_worker_thread_barrier_release(vm);
199 fib_node_deinit(&adj->ia_node);
200 ASSERT(0 == vec_len(adj->ia_delegates));
201 vec_free(adj->ia_delegates);
202 pool_put(adj_pool, adj);
206 adj_lock (adj_index_t adj_index)
210 if (adj_index_is_special(adj_index))
215 adj = adj_get(adj_index);
218 ADJ_DBG(adj, "lock");
219 fib_node_lock(&adj->ia_node);
223 adj_unlock (adj_index_t adj_index)
227 if (adj_index_is_special(adj_index))
232 adj = adj_get(adj_index);
235 ADJ_DBG(adj, "unlock");
238 fib_node_unlock(&adj->ia_node);
242 adj_child_add (adj_index_t adj_index,
243 fib_node_type_t child_type,
244 fib_node_index_t child_index)
246 ASSERT(ADJ_INDEX_INVALID != adj_index);
247 if (adj_index_is_special(adj_index))
252 return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
259 adj_child_remove (adj_index_t adj_index,
262 if (adj_index_is_special(adj_index))
267 fib_node_child_remove(FIB_NODE_TYPE_ADJ,
273 * Context for the walk to update the cached feture flags.
275 typedef struct adj_feature_update_t_
279 } adj_feature_update_ctx_t;
282 adj_feature_update_walk_cb (adj_index_t ai,
285 adj_feature_update_ctx_t *ctx = arg;
291 * this ugly mess matches the feature arc that is changing with affected
294 if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
295 (VNET_LINK_IP6 == adj->ia_link)) ||
296 ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
297 (VNET_LINK_IP4 == adj->ia_link)) ||
298 ((ctx->arc == mpls_main.output_feature_arc_index) &&
299 (VNET_LINK_MPLS == adj->ia_link)))
302 adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
304 adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
306 return (ADJ_WALK_RC_CONTINUE);
310 adj_feature_update (u32 sw_if_index,
315 * Walk all the adjacencies on the interface to update the cached
316 * 'has-features' flag
318 adj_feature_update_ctx_t ctx = {
322 adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
326 * @brief Walk the Adjacencies on a given interface
329 adj_walk (u32 sw_if_index,
334 * walk all the neighbor adjacencies
336 fib_protocol_t proto;
338 FOR_EACH_FIB_IP_PROTOCOL(proto)
340 adj_nbr_walk(sw_if_index, proto, cb, ctx);
345 * @brief Return the link type of the adjacency
348 adj_get_link_type (adj_index_t ai)
350 const ip_adjacency_t *adj;
354 return (adj->ia_link);
358 * @brief Return the sw interface index of the adjacency.
361 adj_get_sw_if_index (adj_index_t ai)
363 const ip_adjacency_t *adj;
367 return (adj->rewrite_header.sw_if_index);
371 * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
372 * 0 is down, !0 is up.
375 adj_is_up (adj_index_t ai)
377 const adj_delegate_t *aed;
379 aed = adj_delegate_get(adj_get(ai), ADJ_DELEGATE_BFD);
384 * no BFD tracking - resolved
391 * defer to the state of the BFD tracking
393 return (ADJ_BFD_STATE_UP == aed->ad_bfd_state);
398 * @brief Return the rewrite string of the adjacency
401 adj_get_rewrite (adj_index_t ai)
403 vnet_rewrite_header_t *rw;
407 rw = &adj->rewrite_header;
409 ASSERT (rw->data_bytes != 0xfefe);
411 return (rw->data - rw->data_bytes);
415 adj_get_node (fib_node_index_t index)
419 adj = adj_get(index);
421 return (&adj->ia_node);
424 #define ADJ_FROM_NODE(_node) \
425 ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
428 adj_node_last_lock_gone (fib_node_t *node)
430 adj_last_lock_gone(ADJ_FROM_NODE(node));
433 static fib_node_back_walk_rc_t
434 adj_back_walk_notify (fib_node_t *node,
435 fib_node_back_walk_ctx_t *ctx)
438 * Que pasa. yo soj en el final!
442 return (FIB_NODE_BACK_WALK_CONTINUE);
446 * Adjacency's graph node virtual function table
448 static const fib_node_vft_t adj_vft = {
449 .fnv_get = adj_get_node,
450 .fnv_last_lock = adj_node_last_lock_gone,
451 .fnv_back_walk = adj_back_walk_notify,
454 static clib_error_t *
455 adj_module_init (vlib_main_t * vm)
457 fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
459 adj_nbr_module_init();
460 adj_glean_module_init();
461 adj_midchain_module_init();
462 adj_mcast_module_init();
467 VLIB_INIT_FUNCTION (adj_module_init);
469 static clib_error_t *
470 adj_show (vlib_main_t * vm,
471 unformat_input_t * input,
472 vlib_cli_command_t * cmd)
474 adj_index_t ai = ADJ_INDEX_INVALID;
475 u32 sw_if_index = ~0;
478 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
480 if (unformat (input, "%d", &ai))
482 else if (unformat (input, "sum"))
484 else if (unformat (input, "summary"))
486 else if (unformat (input, "%U",
487 unformat_vnet_sw_interface, vnet_get_main(),
496 vlib_cli_output (vm, "Number of adjacenies: %d", pool_elts(adj_pool));
497 vlib_cli_output (vm, "Per-adjacency counters: %s",
498 (adj_are_counters_enabled() ?
504 if (ADJ_INDEX_INVALID != ai)
506 if (pool_is_free_index(adj_pool, ai))
508 vlib_cli_output (vm, "adjacency %d invalid", ai);
512 vlib_cli_output (vm, "[@%d] %U",
514 format_ip_adjacency, ai,
515 FORMAT_IP_ADJACENCY_DETAIL);
520 pool_foreach_index(ai, adj_pool,
522 if (~0 != sw_if_index &&
523 sw_if_index != adj_get_sw_if_index(ai))
528 vlib_cli_output (vm, "[@%d] %U",
530 format_ip_adjacency, ai,
531 FORMAT_IP_ADJACENCY_NONE);
541 * Show all adjacencies.
543 * @cliexstart{sh adj}
546 * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
547 * [@3] mpls via 1.0.0.2 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
548 * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
549 * [@5] mpls via 1.0.0.3 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
552 VLIB_CLI_COMMAND (adj_show_command, static) = {
554 .short_help = "show adj [<adj_index>] [interface] [summary]",
555 .function = adj_show,
559 * @brief CLI invoked function to enable/disable per-adj counters
561 static clib_error_t *
562 adj_cli_counters_set (vlib_main_t * vm,
563 unformat_input_t * input,
564 vlib_cli_command_t * cmd)
566 clib_error_t *error = NULL;
569 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
571 if (unformat (input, "enable"))
573 else if (unformat (input, "disable"))
581 /* user requested something sensible */
582 adj_per_adj_counters = enable;
586 error = clib_error_return (0, "specify 'enable' or 'disable'");
593 * Enabe/disble per-adjacency counters. This is optional because it comes with
594 * a non-negligible performance cost.
596 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
597 .path = "adjacency counters",
598 .short_help = "adjacency counters [enable|disable]",
599 .function = adj_cli_counters_set,