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->rewrite_header.flags = 0;
68 adj->lookup_next_index = 0;
69 adj->ia_delegates = NULL;
71 /* lest it become a midchain in the future */
72 memset(&adj->sub_type.midchain.next_dpo, 0,
73 sizeof(adj->sub_type.midchain.next_dpo));
79 adj_index_is_special (adj_index_t adj_index)
81 if (ADJ_INDEX_INVALID == adj_index)
88 * @brief Pretty print helper function for formatting specific adjacencies.
89 * @param s - input string to format
90 * @param args - other args passed to format function such as:
96 format_ip_adjacency (u8 * s, va_list * args)
98 format_ip_adjacency_flags_t fiaf;
102 adj_index = va_arg (*args, u32);
103 fiaf = va_arg (*args, format_ip_adjacency_flags_t);
104 adj = adj_get(adj_index);
106 switch (adj->lookup_next_index)
108 case IP_LOOKUP_NEXT_REWRITE:
109 s = format (s, "%U", format_adj_nbr, adj_index, 0);
111 case IP_LOOKUP_NEXT_ARP:
112 s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
114 case IP_LOOKUP_NEXT_GLEAN:
115 s = format (s, "%U", format_adj_glean, adj_index, 0);
117 case IP_LOOKUP_NEXT_MIDCHAIN:
118 s = format (s, "%U", format_adj_midchain, adj_index, 2);
120 case IP_LOOKUP_NEXT_MCAST:
121 s = format (s, "%U", format_adj_mcast, adj_index, 0);
123 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
124 s = format (s, "%U", format_adj_mcast_midchain, adj_index, 0);
130 if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
132 adj_delegate_type_t adt;
134 vlib_counter_t counts;
136 vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
137 s = format (s, "\n counts:[%Ld:%Ld]", counts.packets, counts.bytes);
138 s = format (s, "\n locks:%d", adj->ia_node.fn_locks);
139 s = format(s, "\n delegates:\n ");
140 FOR_EACH_ADJ_DELEGATE(adj, adt, aed,
142 s = format(s, " %U\n", format_adj_deletegate, aed);
145 s = format(s, "\n children:\n ");
146 s = fib_node_children_format(adj->ia_node.fn_children, s);
155 * last lock/reference to the adj has gone, we no longer need it.
158 adj_last_lock_gone (ip_adjacency_t *adj)
160 vlib_main_t * vm = vlib_get_main();
162 ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
163 ADJ_DBG(adj, "last-lock-gone");
165 vlib_worker_thread_barrier_sync (vm);
167 switch (adj->lookup_next_index)
169 case IP_LOOKUP_NEXT_MIDCHAIN:
170 dpo_reset(&adj->sub_type.midchain.next_dpo);
172 case IP_LOOKUP_NEXT_ARP:
173 case IP_LOOKUP_NEXT_REWRITE:
175 * complete and incomplete nbr adjs
177 adj_nbr_remove(adj_get_index(adj),
180 &adj->sub_type.nbr.next_hop,
181 adj->rewrite_header.sw_if_index);
183 case IP_LOOKUP_NEXT_GLEAN:
184 adj_glean_remove(adj->ia_nh_proto,
185 adj->rewrite_header.sw_if_index);
187 case IP_LOOKUP_NEXT_MCAST:
188 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
189 adj_mcast_remove(adj->ia_nh_proto,
190 adj->rewrite_header.sw_if_index);
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:
198 * type not stored in any DB from which we need to remove it
203 vlib_worker_thread_barrier_release(vm);
205 fib_node_deinit(&adj->ia_node);
206 ASSERT(0 == vec_len(adj->ia_delegates));
207 vec_free(adj->ia_delegates);
208 pool_put(adj_pool, adj);
212 adj_lock (adj_index_t adj_index)
216 if (adj_index_is_special(adj_index))
221 adj = adj_get(adj_index);
224 ADJ_DBG(adj, "lock");
225 fib_node_lock(&adj->ia_node);
229 adj_unlock (adj_index_t adj_index)
233 if (adj_index_is_special(adj_index))
238 adj = adj_get(adj_index);
241 ADJ_DBG(adj, "unlock");
244 fib_node_unlock(&adj->ia_node);
248 adj_child_add (adj_index_t adj_index,
249 fib_node_type_t child_type,
250 fib_node_index_t child_index)
252 ASSERT(ADJ_INDEX_INVALID != adj_index);
253 if (adj_index_is_special(adj_index))
258 return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
265 adj_child_remove (adj_index_t adj_index,
268 if (adj_index_is_special(adj_index))
273 fib_node_child_remove(FIB_NODE_TYPE_ADJ,
279 * Context for the walk to update the cached feture flags.
281 typedef struct adj_feature_update_t_
285 } adj_feature_update_ctx_t;
288 adj_feature_update_walk_cb (adj_index_t ai,
291 adj_feature_update_ctx_t *ctx = arg;
297 * this ugly mess matches the feature arc that is changing with affected
300 if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
301 (VNET_LINK_IP6 == adj->ia_link)) ||
302 ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
303 (VNET_LINK_IP4 == adj->ia_link)) ||
304 ((ctx->arc == mpls_main.output_feature_arc_index) &&
305 (VNET_LINK_MPLS == adj->ia_link)))
308 adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
310 adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
312 return (ADJ_WALK_RC_CONTINUE);
316 adj_feature_update (u32 sw_if_index,
321 * Walk all the adjacencies on the interface to update the cached
322 * 'has-features' flag
324 adj_feature_update_ctx_t ctx = {
328 adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
332 * @brief Walk the Adjacencies on a given interface
335 adj_walk (u32 sw_if_index,
340 * walk all the neighbor adjacencies
342 fib_protocol_t proto;
344 FOR_EACH_FIB_IP_PROTOCOL(proto)
346 adj_nbr_walk(sw_if_index, proto, cb, ctx);
347 adj_mcast_walk(sw_if_index, proto, cb, ctx);
352 * @brief Return the link type of the adjacency
355 adj_get_link_type (adj_index_t ai)
357 const ip_adjacency_t *adj;
361 return (adj->ia_link);
365 * @brief Return the sw interface index of the adjacency.
368 adj_get_sw_if_index (adj_index_t ai)
370 const ip_adjacency_t *adj;
374 return (adj->rewrite_header.sw_if_index);
378 * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
379 * 0 is down, !0 is up.
382 adj_is_up (adj_index_t ai)
384 const adj_delegate_t *aed;
386 aed = adj_delegate_get(adj_get(ai), ADJ_DELEGATE_BFD);
391 * no BFD tracking - resolved
398 * defer to the state of the BFD tracking
400 return (ADJ_BFD_STATE_UP == aed->ad_bfd_state);
405 * @brief Return the rewrite string of the adjacency
408 adj_get_rewrite (adj_index_t ai)
410 vnet_rewrite_header_t *rw;
414 rw = &adj->rewrite_header;
416 ASSERT (rw->data_bytes != 0xfefe);
418 return (rw->data - rw->data_bytes);
422 adj_get_node (fib_node_index_t index)
426 adj = adj_get(index);
428 return (&adj->ia_node);
431 #define ADJ_FROM_NODE(_node) \
432 ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
435 adj_node_last_lock_gone (fib_node_t *node)
437 adj_last_lock_gone(ADJ_FROM_NODE(node));
440 static fib_node_back_walk_rc_t
441 adj_back_walk_notify (fib_node_t *node,
442 fib_node_back_walk_ctx_t *ctx)
445 * Que pasa. yo soj en el final!
449 return (FIB_NODE_BACK_WALK_CONTINUE);
453 * Adjacency's graph node virtual function table
455 static const fib_node_vft_t adj_vft = {
456 .fnv_get = adj_get_node,
457 .fnv_last_lock = adj_node_last_lock_gone,
458 .fnv_back_walk = adj_back_walk_notify,
461 static clib_error_t *
462 adj_module_init (vlib_main_t * vm)
464 fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
466 adj_nbr_module_init();
467 adj_glean_module_init();
468 adj_midchain_module_init();
469 adj_mcast_module_init();
474 VLIB_INIT_FUNCTION (adj_module_init);
476 static clib_error_t *
477 adj_show (vlib_main_t * vm,
478 unformat_input_t * input,
479 vlib_cli_command_t * cmd)
481 adj_index_t ai = ADJ_INDEX_INVALID;
482 u32 sw_if_index = ~0;
485 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
487 if (unformat (input, "%d", &ai))
489 else if (unformat (input, "sum"))
491 else if (unformat (input, "summary"))
493 else if (unformat (input, "%U",
494 unformat_vnet_sw_interface, vnet_get_main(),
503 vlib_cli_output (vm, "Number of adjacenies: %d", pool_elts(adj_pool));
504 vlib_cli_output (vm, "Per-adjacency counters: %s",
505 (adj_are_counters_enabled() ?
511 if (ADJ_INDEX_INVALID != ai)
513 if (pool_is_free_index(adj_pool, ai))
515 vlib_cli_output (vm, "adjacency %d invalid", ai);
519 vlib_cli_output (vm, "[@%d] %U",
521 format_ip_adjacency, ai,
522 FORMAT_IP_ADJACENCY_DETAIL);
527 pool_foreach_index(ai, adj_pool,
529 if (~0 != sw_if_index &&
530 sw_if_index != adj_get_sw_if_index(ai))
535 vlib_cli_output (vm, "[@%d] %U",
537 format_ip_adjacency, ai,
538 FORMAT_IP_ADJACENCY_NONE);
548 * Show all adjacencies.
550 * @cliexstart{sh adj}
553 * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
554 * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
555 * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
556 * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
559 VLIB_CLI_COMMAND (adj_show_command, static) = {
561 .short_help = "show adj [<adj_index>] [interface] [summary]",
562 .function = adj_show,
566 * @brief CLI invoked function to enable/disable per-adj counters
568 static clib_error_t *
569 adj_cli_counters_set (vlib_main_t * vm,
570 unformat_input_t * input,
571 vlib_cli_command_t * cmd)
573 clib_error_t *error = NULL;
576 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
578 if (unformat (input, "enable"))
580 else if (unformat (input, "disable"))
588 /* user requested something sensible */
589 adj_per_adj_counters = enable;
593 error = clib_error_return (0, "specify 'enable' or 'disable'");
600 * Enabe/disble per-adjacency counters. This is optional because it comes with
601 * a non-negligible performance cost.
603 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
604 .path = "adjacency counters",
605 .short_help = "adjacency counters [enable|disable]",
606 .function = adj_cli_counters_set,