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;
38 const ip46_address_t ADJ_BCAST_ADDR = {
40 .as_u64[0] = 0xffffffffffffffff,
41 .as_u64[1] = 0xffffffffffffffff,
46 adj_poison (ip_adjacency_t * adj)
50 memset (adj, 0xfe, sizeof (adj[0]));
55 adj_alloc (fib_protocol_t proto)
59 pool_get_aligned(adj_pool, adj, CLIB_CACHE_LINE_BYTES);
63 /* Make sure certain fields are always initialized. */
64 /* Validate adjacency counters. */
65 vlib_validate_combined_counter(&adjacency_counters,
68 fib_node_init(&adj->ia_node,
71 adj->ia_nh_proto = proto;
73 adj->rewrite_header.sw_if_index = ~0;
74 adj->rewrite_header.flags = 0;
75 adj->lookup_next_index = 0;
76 adj->ia_delegates = NULL;
78 /* lest it become a midchain in the future */
79 memset(&adj->sub_type.midchain.next_dpo, 0,
80 sizeof(adj->sub_type.midchain.next_dpo));
86 adj_index_is_special (adj_index_t adj_index)
88 if (ADJ_INDEX_INVALID == adj_index)
95 * @brief Pretty print helper function for formatting specific adjacencies.
96 * @param s - input string to format
97 * @param args - other args passed to format function such as:
103 format_ip_adjacency (u8 * s, va_list * args)
105 format_ip_adjacency_flags_t fiaf;
106 ip_adjacency_t * adj;
109 adj_index = va_arg (*args, u32);
110 fiaf = va_arg (*args, format_ip_adjacency_flags_t);
111 adj = adj_get(adj_index);
113 switch (adj->lookup_next_index)
115 case IP_LOOKUP_NEXT_REWRITE:
116 s = format (s, "%U", format_adj_nbr, adj_index, 0);
118 case IP_LOOKUP_NEXT_ARP:
119 s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
121 case IP_LOOKUP_NEXT_GLEAN:
122 s = format (s, "%U", format_adj_glean, adj_index, 0);
124 case IP_LOOKUP_NEXT_MIDCHAIN:
125 s = format (s, "%U", format_adj_midchain, adj_index, 2);
127 case IP_LOOKUP_NEXT_MCAST:
128 s = format (s, "%U", format_adj_mcast, adj_index, 0);
130 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
131 s = format (s, "%U", format_adj_mcast_midchain, adj_index, 0);
137 if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
139 vlib_counter_t counts;
141 vlib_get_combined_counter(&adjacency_counters, adj_index, &counts);
142 s = format (s, "\n counts:[%Ld:%Ld]", counts.packets, counts.bytes);
143 s = format (s, "\n locks:%d", adj->ia_node.fn_locks);
144 s = format(s, "\n delegates:\n ");
145 adj_delegate_format(s, adj);
147 s = format(s, "\n children:");
148 if (fib_node_list_get_size(adj->ia_node.fn_children))
150 s = format(s, "\n ");
151 s = fib_node_children_format(adj->ia_node.fn_children, s);
161 * last lock/reference to the adj has gone, we no longer need it.
164 adj_last_lock_gone (ip_adjacency_t *adj)
166 vlib_main_t * vm = vlib_get_main();
168 ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
169 ADJ_DBG(adj, "last-lock-gone");
171 adj_delegate_adj_deleted(adj);
173 vlib_worker_thread_barrier_sync (vm);
175 switch (adj->lookup_next_index)
177 case IP_LOOKUP_NEXT_MIDCHAIN:
178 dpo_reset(&adj->sub_type.midchain.next_dpo);
180 case IP_LOOKUP_NEXT_ARP:
181 case IP_LOOKUP_NEXT_REWRITE:
182 case IP_LOOKUP_NEXT_BCAST:
184 * complete and incomplete nbr adjs
186 adj_nbr_remove(adj_get_index(adj),
189 &adj->sub_type.nbr.next_hop,
190 adj->rewrite_header.sw_if_index);
192 case IP_LOOKUP_NEXT_GLEAN:
193 adj_glean_remove(adj->ia_nh_proto,
194 adj->rewrite_header.sw_if_index);
196 case IP_LOOKUP_NEXT_MCAST:
197 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
198 adj_mcast_remove(adj->ia_nh_proto,
199 adj->rewrite_header.sw_if_index);
201 case IP_LOOKUP_NEXT_DROP:
202 case IP_LOOKUP_NEXT_PUNT:
203 case IP_LOOKUP_NEXT_LOCAL:
204 case IP_LOOKUP_NEXT_ICMP_ERROR:
205 case IP_LOOKUP_N_NEXT:
207 * type not stored in any DB from which we need to remove it
212 vlib_worker_thread_barrier_release(vm);
214 fib_node_deinit(&adj->ia_node);
215 ASSERT(0 == vec_len(adj->ia_delegates));
216 vec_free(adj->ia_delegates);
217 pool_put(adj_pool, adj);
221 adj_dpo_get_urpf (const dpo_id_t *dpo)
225 adj = adj_get(dpo->dpoi_index);
227 return (adj->rewrite_header.sw_if_index);
231 adj_lock (adj_index_t adj_index)
235 if (adj_index_is_special(adj_index))
240 adj = adj_get(adj_index);
243 ADJ_DBG(adj, "lock");
244 fib_node_lock(&adj->ia_node);
248 adj_unlock (adj_index_t adj_index)
252 if (adj_index_is_special(adj_index))
257 adj = adj_get(adj_index);
260 ADJ_DBG(adj, "unlock");
263 fib_node_unlock(&adj->ia_node);
267 adj_child_add (adj_index_t adj_index,
268 fib_node_type_t child_type,
269 fib_node_index_t child_index)
271 ASSERT(ADJ_INDEX_INVALID != adj_index);
272 if (adj_index_is_special(adj_index))
277 return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
284 adj_child_remove (adj_index_t adj_index,
287 if (adj_index_is_special(adj_index))
292 fib_node_child_remove(FIB_NODE_TYPE_ADJ,
298 * Context for the walk to update the cached feture flags.
300 typedef struct adj_feature_update_t_
304 } adj_feature_update_ctx_t;
307 adj_feature_update_walk_cb (adj_index_t ai,
310 adj_feature_update_ctx_t *ctx = arg;
316 * this ugly mess matches the feature arc that is changing with affected
319 if (((ctx->arc == ip6_main.lookup_main.output_feature_arc_index) &&
320 (VNET_LINK_IP6 == adj->ia_link)) ||
321 ((ctx->arc == ip4_main.lookup_main.output_feature_arc_index) &&
322 (VNET_LINK_IP4 == adj->ia_link)) ||
323 ((ctx->arc == mpls_main.output_feature_arc_index) &&
324 (VNET_LINK_MPLS == adj->ia_link)))
327 adj->rewrite_header.flags |= VNET_REWRITE_HAS_FEATURES;
329 adj->rewrite_header.flags &= ~VNET_REWRITE_HAS_FEATURES;
331 return (ADJ_WALK_RC_CONTINUE);
335 adj_feature_update (u32 sw_if_index,
340 * Walk all the adjacencies on the interface to update the cached
341 * 'has-features' flag
343 adj_feature_update_ctx_t ctx = {
347 adj_walk (sw_if_index, adj_feature_update_walk_cb, &ctx);
351 adj_mtu_update_walk_cb (adj_index_t ai,
358 vnet_rewrite_update_mtu (vnet_get_main(), adj->ia_link,
359 &adj->rewrite_header);
361 return (ADJ_WALK_RC_CONTINUE);
365 adj_mtu_update (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
367 adj_walk (sw_if_index, adj_mtu_update_walk_cb, NULL);
370 VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(adj_mtu_update);
373 * @brief Walk the Adjacencies on a given interface
376 adj_walk (u32 sw_if_index,
381 * walk all the neighbor adjacencies
383 fib_protocol_t proto;
385 FOR_EACH_FIB_IP_PROTOCOL(proto)
387 adj_nbr_walk(sw_if_index, proto, cb, ctx);
388 adj_mcast_walk(sw_if_index, proto, cb, ctx);
393 * @brief Return the link type of the adjacency
396 adj_get_link_type (adj_index_t ai)
398 const ip_adjacency_t *adj;
402 return (adj->ia_link);
406 * @brief Return the sw interface index of the adjacency.
409 adj_get_sw_if_index (adj_index_t ai)
411 const ip_adjacency_t *adj;
415 return (adj->rewrite_header.sw_if_index);
419 * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding
420 * 0 is down, !0 is up.
423 adj_is_up (adj_index_t ai)
425 return (adj_bfd_is_up(ai));
429 * @brief Return the rewrite string of the adjacency
432 adj_get_rewrite (adj_index_t ai)
434 vnet_rewrite_header_t *rw;
438 rw = &adj->rewrite_header;
440 ASSERT (rw->data_bytes != 0xfefe);
442 return (rw->data - rw->data_bytes);
446 adj_get_node (fib_node_index_t index)
450 adj = adj_get(index);
452 return (&adj->ia_node);
455 #define ADJ_FROM_NODE(_node) \
456 ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
459 adj_node_last_lock_gone (fib_node_t *node)
461 adj_last_lock_gone(ADJ_FROM_NODE(node));
464 static fib_node_back_walk_rc_t
465 adj_back_walk_notify (fib_node_t *node,
466 fib_node_back_walk_ctx_t *ctx)
469 * Que pasa. yo soj en el final!
473 return (FIB_NODE_BACK_WALK_CONTINUE);
477 * Adjacency's graph node virtual function table
479 static const fib_node_vft_t adj_vft = {
480 .fnv_get = adj_get_node,
481 .fnv_last_lock = adj_node_last_lock_gone,
482 .fnv_back_walk = adj_back_walk_notify,
485 static clib_error_t *
486 adj_module_init (vlib_main_t * vm)
488 fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
490 adj_nbr_module_init();
491 adj_glean_module_init();
492 adj_midchain_module_init();
493 adj_mcast_module_init();
498 VLIB_INIT_FUNCTION (adj_module_init);
500 static clib_error_t *
501 adj_show (vlib_main_t * vm,
502 unformat_input_t * input,
503 vlib_cli_command_t * cmd)
505 adj_index_t ai = ADJ_INDEX_INVALID;
506 u32 sw_if_index = ~0;
509 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
511 if (unformat (input, "%d", &ai))
513 else if (unformat (input, "sum"))
515 else if (unformat (input, "summary"))
517 else if (unformat (input, "%U",
518 unformat_vnet_sw_interface, vnet_get_main(),
527 vlib_cli_output (vm, "Number of adjacenies: %d", pool_elts(adj_pool));
528 vlib_cli_output (vm, "Per-adjacency counters: %s",
529 (adj_are_counters_enabled() ?
535 if (ADJ_INDEX_INVALID != ai)
537 if (pool_is_free_index(adj_pool, ai))
539 vlib_cli_output (vm, "adjacency %d invalid", ai);
543 vlib_cli_output (vm, "[@%d] %U",
545 format_ip_adjacency, ai,
546 FORMAT_IP_ADJACENCY_DETAIL);
551 pool_foreach_index(ai, adj_pool,
553 if (~0 != sw_if_index &&
554 sw_if_index != adj_get_sw_if_index(ai))
559 vlib_cli_output (vm, "[@%d] %U",
561 format_ip_adjacency, ai,
562 FORMAT_IP_ADJACENCY_NONE);
572 * Show all adjacencies.
574 * @cliexstart{sh adj}
577 * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
578 * [@3] mpls via 1.0.0.2 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
579 * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
580 * [@5] mpls via 1.0.0.3 loop0: MPLS: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
583 VLIB_CLI_COMMAND (adj_show_command, static) = {
585 .short_help = "show adj [<adj_index>] [interface] [summary]",
586 .function = adj_show,
590 * @brief CLI invoked function to enable/disable per-adj counters
592 static clib_error_t *
593 adj_cli_counters_set (vlib_main_t * vm,
594 unformat_input_t * input,
595 vlib_cli_command_t * cmd)
597 clib_error_t *error = NULL;
600 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
602 if (unformat (input, "enable"))
604 else if (unformat (input, "disable"))
612 /* user requested something sensible */
613 adj_per_adj_counters = enable;
617 error = clib_error_return (0, "specify 'enable' or 'disable'");
624 * Enabe/disble per-adjacency counters. This is optional because it comes with
625 * a non-negligible performance cost.
627 VLIB_CLI_COMMAND (adj_cli_counters_set_command, static) = {
628 .path = "adjacency counters",
629 .short_help = "adjacency counters [enable|disable]",
630 .function = adj_cli_counters_set,