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/fib/fib_node_list.h>
24 * Special Adj with index zero. we need to define this since the v4 mtrie
25 * assumes an index of 0 implies the ply is empty. therefore all 'real'
26 * adjs need a non-zero index.
28 static ip_adjacency_t *special_v4_miss_adj_with_index_zero;
30 /* Adjacency packet/byte counters indexed by adjacency index. */
31 vlib_combined_counter_main_t adjacency_counters;
36 ip_adjacency_t *adj_pool;
39 * @brief Global Config for enabling per-adjacency counters.
40 * By default these are disabled.
42 int adj_per_adj_counters;
45 adj_poison (ip_adjacency_t * adj)
49 memset (adj, 0xfe, sizeof (adj[0]));
54 adj_alloc (fib_protocol_t proto)
58 pool_get(adj_pool, adj);
62 /* Make sure certain fields are always initialized. */
63 /* Validate adjacency counters. */
64 vlib_validate_combined_counter(&adjacency_counters,
67 adj->rewrite_header.sw_if_index = ~0;
69 adj->lookup_next_index = 0;
71 fib_node_init(&adj->ia_node,
73 adj->ia_nh_proto = proto;
76 ip4_main.lookup_main.adjacency_heap = adj_pool;
77 ip6_main.lookup_main.adjacency_heap = adj_pool;
83 adj_index_is_special (adj_index_t adj_index)
85 if (ADJ_INDEX_INVALID == adj_index)
92 * @brief Pretty print helper function for formatting specific adjacencies.
93 * @param s - input string to format
94 * @param args - other args passed to format function such as:
100 format_ip_adjacency (u8 * s, va_list * args)
102 format_ip_adjacency_flags_t fiaf;
103 ip_adjacency_t * adj;
106 adj_index = va_arg (*args, u32);
107 fiaf = va_arg (*args, format_ip_adjacency_flags_t);
108 adj = adj_get(adj_index);
110 switch (adj->lookup_next_index)
112 case IP_LOOKUP_NEXT_REWRITE:
113 s = format (s, "%U", format_adj_nbr, adj_index, 0);
115 case IP_LOOKUP_NEXT_ARP:
116 s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
118 case IP_LOOKUP_NEXT_GLEAN:
119 s = format (s, "%U", format_adj_glean, adj_index, 0);
121 case IP_LOOKUP_NEXT_MIDCHAIN:
122 s = format (s, "%U", format_adj_midchain, adj_index, 2);
124 case IP_LOOKUP_NEXT_MCAST:
125 s = format (s, "%U", format_adj_mcast, adj_index, 0);
131 if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
133 vlib_counter_t counts;
135 vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
136 s = format (s, "\n counts:[%Ld:%Ld]", counts.packets, counts.bytes);
137 s = format (s, "\n locks:%d", adj->ia_node.fn_locks);
138 s = format(s, "\n children:\n ");
139 s = fib_node_children_format(adj->ia_node.fn_children, s);
148 * last lock/reference to the adj has gone, we no longer need it.
151 adj_last_lock_gone (ip_adjacency_t *adj)
153 vlib_main_t * vm = vlib_get_main();
155 ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
156 ADJ_DBG(adj, "last-lock-gone");
158 vlib_worker_thread_barrier_sync (vm);
160 switch (adj->lookup_next_index)
162 case IP_LOOKUP_NEXT_MIDCHAIN:
163 dpo_reset(&adj->sub_type.midchain.next_dpo);
165 case IP_LOOKUP_NEXT_ARP:
166 case IP_LOOKUP_NEXT_REWRITE:
168 * complete and incomplete nbr adjs
170 adj_nbr_remove(adj_get_index(adj),
173 &adj->sub_type.nbr.next_hop,
174 adj->rewrite_header.sw_if_index);
176 case IP_LOOKUP_NEXT_GLEAN:
177 adj_glean_remove(adj->ia_nh_proto,
178 adj->rewrite_header.sw_if_index);
180 case IP_LOOKUP_NEXT_MCAST:
181 adj_mcast_remove(adj->ia_nh_proto,
182 adj->rewrite_header.sw_if_index);
186 * type not stored in any DB from which we need to remove it
191 vlib_worker_thread_barrier_release(vm);
193 fib_node_deinit(&adj->ia_node);
194 pool_put(adj_pool, adj);
198 adj_lock (adj_index_t adj_index)
202 if (adj_index_is_special(adj_index))
207 adj = adj_get(adj_index);
210 ADJ_DBG(adj, "lock");
211 fib_node_lock(&adj->ia_node);
215 adj_unlock (adj_index_t adj_index)
219 if (adj_index_is_special(adj_index))
224 adj = adj_get(adj_index);
227 ADJ_DBG(adj, "unlock");
230 fib_node_unlock(&adj->ia_node);
234 adj_child_add (adj_index_t adj_index,
235 fib_node_type_t child_type,
236 fib_node_index_t child_index)
238 ASSERT(ADJ_INDEX_INVALID != adj_index);
239 if (adj_index_is_special(adj_index))
244 return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
251 adj_child_remove (adj_index_t adj_index,
254 if (adj_index_is_special(adj_index))
259 fib_node_child_remove(FIB_NODE_TYPE_ADJ,
265 * Context for the walk to update the cached feture flags.
267 typedef struct adj_feature_update_t_
271 } adj_feature_update_ctx_t;
274 adj_feature_update_walk_cb (adj_index_t ai,
277 adj_feature_update_ctx_t *ctx = arg;
283 * this ugly mess matches the feature arc that is changing with affected
286 if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
287 (VNET_LINK_IP6 == adj->ia_link)) ||
288 ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
289 (VNET_LINK_IP4 == adj->ia_link)) ||
290 ((ctx->arc == mpls_main.output_feature_arc_index) &&
291 (VNET_LINK_MPLS == adj->ia_link)))
294 adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
296 adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
298 return (ADJ_WALK_RC_CONTINUE);
302 adj_feature_update (u32 sw_if_index,
307 * Walk all the adjacencies on the interface to update the cached
308 * 'has-features' flag
310 adj_feature_update_ctx_t ctx = {
314 adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
318 * @brief Walk the Adjacencies on a given interface
321 adj_walk (u32 sw_if_index,
326 * walk all the neighbor adjacencies
328 fib_protocol_t proto;
330 FOR_EACH_FIB_IP_PROTOCOL(proto)
332 adj_nbr_walk(sw_if_index, proto, cb, ctx);
337 * @brief Return the link type of the adjacency
340 adj_get_link_type (adj_index_t ai)
342 const ip_adjacency_t *adj;
346 return (adj->ia_link);
350 * @brief Return the sw interface index of the adjacency.
353 adj_get_sw_if_index (adj_index_t ai)
355 const ip_adjacency_t *adj;
359 return (adj->rewrite_header.sw_if_index);
363 * @brief Return the link type of the adjacency
366 adj_get_rewrite (adj_index_t ai)
368 vnet_rewrite_header_t *rw;
372 rw = &adj->rewrite_header;
374 ASSERT (rw->data_bytes != 0xfefe);
376 return (rw->data - rw->data_bytes);
380 adj_get_node (fib_node_index_t index)
384 adj = adj_get(index);
386 return (&adj->ia_node);
389 #define ADJ_FROM_NODE(_node) \
390 ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
393 adj_node_last_lock_gone (fib_node_t *node)
395 adj_last_lock_gone(ADJ_FROM_NODE(node));
398 static fib_node_back_walk_rc_t
399 adj_back_walk_notify (fib_node_t *node,
400 fib_node_back_walk_ctx_t *ctx)
403 * Que pasa. yo soj en el final!
407 return (FIB_NODE_BACK_WALK_CONTINUE);
411 * Adjacency's graph node virtual function table
413 static const fib_node_vft_t adj_vft = {
414 .fnv_get = adj_get_node,
415 .fnv_last_lock = adj_node_last_lock_gone,
416 .fnv_back_walk = adj_back_walk_notify,
419 static clib_error_t *
420 adj_module_init (vlib_main_t * vm)
422 fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
424 adj_nbr_module_init();
425 adj_glean_module_init();
426 adj_midchain_module_init();
427 adj_mcast_module_init();
430 * one special adj to reserve index 0
432 special_v4_miss_adj_with_index_zero = adj_alloc(FIB_PROTOCOL_IP4);
437 VLIB_INIT_FUNCTION (adj_module_init);
439 static clib_error_t *
440 adj_show (vlib_main_t * vm,
441 unformat_input_t * input,
442 vlib_cli_command_t * cmd)
444 adj_index_t ai = ADJ_INDEX_INVALID;
445 u32 sw_if_index = ~0;
448 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
450 if (unformat (input, "%d", &ai))
452 else if (unformat (input, "sum"))
454 else if (unformat (input, "summary"))
456 else if (unformat (input, "%U",
457 unformat_vnet_sw_interface, vnet_get_main(),
466 vlib_cli_output (vm, "Number of adjacenies: %d", pool_elts(adj_pool));
467 vlib_cli_output (vm, "Per-adjacency counters: %s",
468 (adj_are_counters_enabled() ?
474 if (ADJ_INDEX_INVALID != ai)
476 if (pool_is_free_index(adj_pool, ai))
478 vlib_cli_output (vm, "adjacency %d invalid", ai);
482 vlib_cli_output (vm, "[@%d] %U",
484 format_ip_adjacency, ai,
485 FORMAT_IP_ADJACENCY_DETAIL);
490 pool_foreach_index(ai, adj_pool,
492 if (~0 != sw_if_index &&
493 sw_if_index != adj_get_sw_if_index(ai))
498 vlib_cli_output (vm, "[@%d] %U",
500 format_ip_adjacency, ai,
501 FORMAT_IP_ADJACENCY_NONE);
511 * Show all adjacencies.
513 * @cliexstart{sh adj}
516 * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
517 * [@3] mpls via 1.0.0.2 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
518 * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
519 * [@5] mpls via 1.0.0.3 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
522 VLIB_CLI_COMMAND (adj_show_command, static) = {
524 .short_help = "show adj [<adj_index>] [interface] [summary]",
525 .function = adj_show,
529 * @brief CLI invoked function to enable/disable per-adj counters
531 static clib_error_t *
532 adj_cli_counters_set (vlib_main_t * vm,
533 unformat_input_t * input,
534 vlib_cli_command_t * cmd)
536 clib_error_t *error = NULL;
539 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
541 if (unformat (input, "enable"))
543 else if (unformat (input, "disable"))
551 /* user requested something sensible */
552 adj_per_adj_counters = enable;
556 error = clib_error_return (0, "specify 'enable' or 'disable'");
563 * Enabe/disble per-adjacency counters. This is optional because it comes with
564 * a non-negligible performance cost.
566 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
567 .path = "adjacency counters",
568 .short_help = "adjacency counters [enable|disable]",
569 .function = adj_cli_counters_set,