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_delegate, 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 adj_delegate_vft_lock_gone(adj);
167 vlib_worker_thread_barrier_sync (vm);
169 switch (adj->lookup_next_index)
171 case IP_LOOKUP_NEXT_MIDCHAIN:
172 dpo_reset(&adj->sub_type.midchain.next_dpo);
174 case IP_LOOKUP_NEXT_ARP:
175 case IP_LOOKUP_NEXT_REWRITE:
177 * complete and incomplete nbr adjs
179 adj_nbr_remove(adj_get_index(adj),
182 &adj->sub_type.nbr.next_hop,
183 adj->rewrite_header.sw_if_index);
185 case IP_LOOKUP_NEXT_GLEAN:
186 adj_glean_remove(adj->ia_nh_proto,
187 adj->rewrite_header.sw_if_index);
189 case IP_LOOKUP_NEXT_MCAST:
190 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
191 adj_mcast_remove(adj->ia_nh_proto,
192 adj->rewrite_header.sw_if_index);
194 case IP_LOOKUP_NEXT_DROP:
195 case IP_LOOKUP_NEXT_PUNT:
196 case IP_LOOKUP_NEXT_LOCAL:
197 case IP_LOOKUP_NEXT_ICMP_ERROR:
198 case IP_LOOKUP_N_NEXT:
200 * type not stored in any DB from which we need to remove it
205 vlib_worker_thread_barrier_release(vm);
207 fib_node_deinit(&adj->ia_node);
208 ASSERT(0 == vec_len(adj->ia_delegates));
209 vec_free(adj->ia_delegates);
210 pool_put(adj_pool, adj);
214 adj_dpo_get_urpf (const dpo_id_t *dpo)
218 adj = adj_get(dpo->dpoi_index);
220 return (adj->rewrite_header.sw_if_index);
224 adj_lock (adj_index_t adj_index)
228 if (adj_index_is_special(adj_index))
233 adj = adj_get(adj_index);
236 ADJ_DBG(adj, "lock");
237 fib_node_lock(&adj->ia_node);
241 adj_unlock (adj_index_t adj_index)
245 if (adj_index_is_special(adj_index))
250 adj = adj_get(adj_index);
253 ADJ_DBG(adj, "unlock");
256 fib_node_unlock(&adj->ia_node);
260 adj_child_add (adj_index_t adj_index,
261 fib_node_type_t child_type,
262 fib_node_index_t child_index)
264 ASSERT(ADJ_INDEX_INVALID != adj_index);
265 if (adj_index_is_special(adj_index))
270 return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
277 adj_child_remove (adj_index_t adj_index,
280 if (adj_index_is_special(adj_index))
285 fib_node_child_remove(FIB_NODE_TYPE_ADJ,
291 * Context for the walk to update the cached feture flags.
293 typedef struct adj_feature_update_t_
297 } adj_feature_update_ctx_t;
300 adj_feature_update_walk_cb (adj_index_t ai,
303 adj_feature_update_ctx_t *ctx = arg;
309 * this ugly mess matches the feature arc that is changing with affected
312 if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
313 (VNET_LINK_IP6 == adj->ia_link)) ||
314 ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
315 (VNET_LINK_IP4 == adj->ia_link)) ||
316 ((ctx->arc == mpls_main.output_feature_arc_index) &&
317 (VNET_LINK_MPLS == adj->ia_link)))
320 adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
322 adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
324 return (ADJ_WALK_RC_CONTINUE);
328 adj_feature_update (u32 sw_if_index,
333 * Walk all the adjacencies on the interface to update the cached
334 * 'has-features' flag
336 adj_feature_update_ctx_t ctx = {
340 adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
344 adj_mtu_update_walk_cb (adj_index_t ai,
351 vnet_rewrite_update_mtu (vnet_get_main(),
352 &adj->rewrite_header);
354 return (ADJ_WALK_RC_CONTINUE);
358 adj_sw_mtu_update (vnet_main_t * vnm,
363 * Walk all the adjacencies on the interface to update the cached MTU
365 adj_walk (sw_if_index, adj_mtu_update_walk_cb, NULL);
369 adj_mtu_update (u32 hw_if_index)
372 * Walk all the SW interfaces on the HW interface to update the cached MTU
374 vnet_hw_interface_walk_sw(vnet_get_main(),
381 * @brief Walk the Adjacencies on a given interface
384 adj_walk (u32 sw_if_index,
389 * walk all the neighbor adjacencies
391 fib_protocol_t proto;
393 FOR_EACH_FIB_IP_PROTOCOL(proto)
395 adj_nbr_walk(sw_if_index, proto, cb, ctx);
396 adj_mcast_walk(sw_if_index, proto, cb, ctx);
401 * @brief Return the link type of the adjacency
404 adj_get_link_type (adj_index_t ai)
406 const ip_adjacency_t *adj;
410 return (adj->ia_link);
414 * @brief Return the sw interface index of the adjacency.
417 adj_get_sw_if_index (adj_index_t ai)
419 const ip_adjacency_t *adj;
423 return (adj->rewrite_header.sw_if_index);
427 * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
428 * 0 is down, !0 is up.
431 adj_is_up (adj_index_t ai)
433 const adj_delegate_t *aed;
435 aed = adj_delegate_get(adj_get(ai), ADJ_DELEGATE_BFD);
440 * no BFD tracking - resolved
447 * defer to the state of the BFD tracking
449 return (ADJ_BFD_STATE_UP == aed->ad_bfd_state);
454 * @brief Return the rewrite string of the adjacency
457 adj_get_rewrite (adj_index_t ai)
459 vnet_rewrite_header_t *rw;
463 rw = &adj->rewrite_header;
465 ASSERT (rw->data_bytes != 0xfefe);
467 return (rw->data - rw->data_bytes);
471 adj_get_node (fib_node_index_t index)
475 adj = adj_get(index);
477 return (&adj->ia_node);
480 #define ADJ_FROM_NODE(_node) \
481 ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
484 adj_node_last_lock_gone (fib_node_t *node)
486 adj_last_lock_gone(ADJ_FROM_NODE(node));
489 static fib_node_back_walk_rc_t
490 adj_back_walk_notify (fib_node_t *node,
491 fib_node_back_walk_ctx_t *ctx)
494 * Que pasa. yo soj en el final!
498 return (FIB_NODE_BACK_WALK_CONTINUE);
502 * Adjacency's graph node virtual function table
504 static const fib_node_vft_t adj_vft = {
505 .fnv_get = adj_get_node,
506 .fnv_last_lock = adj_node_last_lock_gone,
507 .fnv_back_walk = adj_back_walk_notify,
510 static clib_error_t *
511 adj_module_init (vlib_main_t * vm)
513 fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
515 adj_nbr_module_init();
516 adj_glean_module_init();
517 adj_midchain_module_init();
518 adj_mcast_module_init();
523 VLIB_INIT_FUNCTION (adj_module_init);
525 static clib_error_t *
526 adj_show (vlib_main_t * vm,
527 unformat_input_t * input,
528 vlib_cli_command_t * cmd)
530 adj_index_t ai = ADJ_INDEX_INVALID;
531 u32 sw_if_index = ~0;
534 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
536 if (unformat (input, "%d", &ai))
538 else if (unformat (input, "sum"))
540 else if (unformat (input, "summary"))
542 else if (unformat (input, "%U",
543 unformat_vnet_sw_interface, vnet_get_main(),
552 vlib_cli_output (vm, "Number of adjacenies: %d", pool_elts(adj_pool));
553 vlib_cli_output (vm, "Per-adjacency counters: %s",
554 (adj_are_counters_enabled() ?
560 if (ADJ_INDEX_INVALID != ai)
562 if (pool_is_free_index(adj_pool, ai))
564 vlib_cli_output (vm, "adjacency %d invalid", ai);
568 vlib_cli_output (vm, "[@%d] %U",
570 format_ip_adjacency, ai,
571 FORMAT_IP_ADJACENCY_DETAIL);
576 pool_foreach_index(ai, adj_pool,
578 if (~0 != sw_if_index &&
579 sw_if_index != adj_get_sw_if_index(ai))
584 vlib_cli_output (vm, "[@%d] %U",
586 format_ip_adjacency, ai,
587 FORMAT_IP_ADJACENCY_NONE);
597 * Show all adjacencies.
599 * @cliexstart{sh adj}
602 * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
603 * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
604 * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
605 * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
608 VLIB_CLI_COMMAND (adj_show_command, static) = {
610 .short_help = "show adj [<adj_index>] [interface] [summary]",
611 .function = adj_show,
615 * @brief CLI invoked function to enable/disable per-adj counters
617 static clib_error_t *
618 adj_cli_counters_set (vlib_main_t * vm,
619 unformat_input_t * input,
620 vlib_cli_command_t * cmd)
622 clib_error_t *error = NULL;
625 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
627 if (unformat (input, "enable"))
629 else if (unformat (input, "disable"))
637 /* user requested something sensible */
638 adj_per_adj_counters = enable;
642 error = clib_error_return (0, "specify 'enable' or 'disable'");
649 * Enabe/disble per-adjacency counters. This is optional because it comes with
650 * a non-negligible performance cost.
652 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
653 .path = "adjacency counters",
654 .short_help = "adjacency counters [enable|disable]",
655 .function = adj_cli_counters_set,