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/fib/fib_walk.h>
21 * The 'DB' of all glean adjs.
22 * There is one glean per-{interface, protocol, connected prefix}
24 static uword **adj_gleans[FIB_PROTOCOL_IP_MAX];
27 adj_get_glean_node (fib_protocol_t proto)
30 case FIB_PROTOCOL_IP4:
31 return (ip4_glean_node.index);
32 case FIB_PROTOCOL_IP6:
33 return (ip6_glean_node.index);
34 case FIB_PROTOCOL_MPLS:
42 adj_glean_db_lookup (fib_protocol_t proto,
44 const ip46_address_t *nh_addr)
48 if (vec_len(adj_gleans[proto]) <= sw_if_index)
49 return (ADJ_INDEX_INVALID);
51 p = hash_get_mem (adj_gleans[proto][sw_if_index], nh_addr);
56 return (ADJ_INDEX_INVALID);
60 adj_glean_db_insert (fib_protocol_t proto,
62 const ip46_address_t *nh_addr,
65 vlib_main_t *vm = vlib_get_main();
67 vlib_worker_thread_barrier_sync(vm);
69 vec_validate(adj_gleans[proto], sw_if_index);
71 if (NULL == adj_gleans[proto][sw_if_index])
73 adj_gleans[proto][sw_if_index] =
74 hash_create_mem (0, sizeof(ip46_address_t), sizeof(adj_index_t));
77 hash_set_mem_alloc (&adj_gleans[proto][sw_if_index],
80 vlib_worker_thread_barrier_release(vm);
84 adj_glean_db_remove (fib_protocol_t proto,
86 const ip46_address_t *nh_addr)
88 vlib_main_t *vm = vlib_get_main();
90 vlib_worker_thread_barrier_sync(vm);
92 ASSERT(ADJ_INDEX_INVALID != adj_glean_db_lookup(proto, sw_if_index, nh_addr));
93 hash_unset_mem_free (&adj_gleans[proto][sw_if_index],
96 if (0 == hash_elts(adj_gleans[proto][sw_if_index]))
98 hash_free(adj_gleans[proto][sw_if_index]);
99 adj_gleans[proto][sw_if_index] = NULL;
101 vlib_worker_thread_barrier_release(vm);
105 * adj_glean_add_or_lock
107 * The next_hop address here is used for source address selection in the DP.
108 * The glean adj is added to an interface's connected prefix, the next-hop
109 * passed here is the local prefix on the same interface.
112 adj_glean_add_or_lock (fib_protocol_t proto,
115 const fib_prefix_t *conn)
117 ip_adjacency_t * adj;
120 ai = adj_glean_db_lookup(proto, sw_if_index, &conn->fp_addr);
122 if (ADJ_INDEX_INVALID == ai)
124 adj = adj_alloc(proto);
126 adj->lookup_next_index = IP_LOOKUP_NEXT_GLEAN;
127 adj->ia_nh_proto = proto;
128 adj->ia_link = linkt;
129 adj->ia_node_index = adj_get_glean_node(proto);
130 ai = adj_get_index(adj);
134 fib_prefix_normalize(conn, &adj->sub_type.glean.rx_pfx);
135 adj->rewrite_header.sw_if_index = sw_if_index;
136 adj->rewrite_header.data_bytes = 0;
137 adj->rewrite_header.max_l3_packet_bytes =
138 vnet_sw_interface_get_mtu(vnet_get_main(), sw_if_index,
139 vnet_link_to_mtu(linkt));
141 vnet_update_adjacency_for_sw_interface(vnet_get_main(),
145 adj_glean_db_insert(proto, sw_if_index,
146 &adj->sub_type.glean.rx_pfx.fp_addr, ai);
154 adj_delegate_adj_created(adj);
160 * adj_glean_update_rewrite
163 adj_glean_update_rewrite (adj_index_t adj_index)
167 ASSERT(ADJ_INDEX_INVALID != adj_index);
169 adj = adj_get(adj_index);
171 vnet_rewrite_for_sw_interface(vnet_get_main(),
172 adj_fib_proto_2_nd(adj->ia_nh_proto),
173 adj->rewrite_header.sw_if_index,
175 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST,
176 &adj->rewrite_header,
177 sizeof (adj->rewrite_data));
181 adj_glean_update_rewrite_walk (adj_index_t ai,
184 adj_glean_update_rewrite(ai);
186 return (ADJ_WALK_RC_CONTINUE);
190 adj_glean_walk (u32 sw_if_index,
194 fib_protocol_t proto;
196 FOR_EACH_FIB_IP_PROTOCOL(proto)
198 adj_index_t ai, *aip, *ais = NULL;
199 ip46_address_t *conn;
201 if (vec_len(adj_gleans[proto]) <= sw_if_index ||
202 NULL == adj_gleans[proto][sw_if_index])
206 * Walk first to collect the indices
207 * then walk the collection. This is safe
208 * to modifications of the hash table
210 hash_foreach_mem(conn, ai, adj_gleans[proto][sw_if_index],
215 vec_foreach(aip, ais)
217 if (ADJ_WALK_RC_STOP == cb(*aip, data))
225 adj_glean_get (fib_protocol_t proto,
227 const ip46_address_t *nh)
231 return adj_glean_db_lookup(proto, sw_if_index, nh);
235 ip46_address_t *conn;
238 if (vec_len(adj_gleans[proto]) <= sw_if_index ||
239 NULL == adj_gleans[proto][sw_if_index])
240 return (ADJ_INDEX_INVALID);
242 hash_foreach_mem(conn, ai, adj_gleans[proto][sw_if_index],
247 return (ADJ_INDEX_INVALID);
250 const ip46_address_t *
251 adj_glean_get_src (fib_protocol_t proto,
253 const ip46_address_t *nh)
255 const ip46_address_t *conn, *source;
256 const ip_adjacency_t *adj;
259 if (vec_len(adj_gleans[proto]) <= sw_if_index ||
260 NULL == adj_gleans[proto][sw_if_index])
264 .fp_len = fib_prefix_get_host_length(proto),
272 * An interface can have more than one glean address. Where
273 * possible we want to return a source address from the same
274 * subnet as the destination. If this is not possible then any address
279 hash_foreach_mem(conn, ai, adj_gleans[proto][sw_if_index],
283 if (adj->sub_type.glean.rx_pfx.fp_len > 0)
285 source = &adj->sub_type.glean.rx_pfx.fp_addr;
287 /* if no destination is specified use the just glean */
291 /* check the clean covers the desintation */
292 if (fib_prefix_is_cover(&adj->sub_type.glean.rx_pfx, &pfx))
301 adj_glean_remove (ip_adjacency_t *adj)
305 fib_prefix_normalize(&adj->sub_type.glean.rx_pfx,
307 adj_glean_db_remove(adj->ia_nh_proto,
308 adj->rewrite_header.sw_if_index,
313 adj_glean_start_backwalk (adj_index_t ai,
316 fib_node_back_walk_ctx_t bw_ctx = *(fib_node_back_walk_ctx_t*) data;
318 fib_walk_sync(FIB_NODE_TYPE_ADJ, ai, &bw_ctx);
320 return (ADJ_WALK_RC_CONTINUE);
323 static clib_error_t *
324 adj_glean_interface_state_change (vnet_main_t * vnm,
329 * for each glean on the interface trigger a walk back to the children
331 fib_node_back_walk_ctx_t bw_ctx = {
332 .fnbw_reason = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP ?
333 FIB_NODE_BW_REASON_FLAG_INTERFACE_UP :
334 FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN),
337 adj_glean_walk (sw_if_index, adj_glean_start_backwalk, &bw_ctx);
342 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(adj_glean_interface_state_change);
345 * @brief Invoked on each SW interface of a HW interface when the
346 * HW interface state changes
349 adj_nbr_hw_sw_interface_state_change (vnet_main_t * vnm,
353 adj_glean_interface_state_change(vnm, sw_if_index, (uword) arg);
355 return (WALK_CONTINUE);
359 * @brief Registered callback for HW interface state changes
361 static clib_error_t *
362 adj_glean_hw_interface_state_change (vnet_main_t * vnm,
367 * walk SW interfaces on the HW
371 sw_flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
372 VNET_SW_INTERFACE_FLAG_ADMIN_UP :
375 vnet_hw_interface_walk_sw(vnm, hw_if_index,
376 adj_nbr_hw_sw_interface_state_change,
382 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(
383 adj_glean_hw_interface_state_change);
385 static clib_error_t *
386 adj_glean_interface_delete (vnet_main_t * vnm,
393 * not interested in interface additions. we will not back walk
394 * to resolve paths through newly added interfaces. Why? The control
395 * plane should have the brains to add interfaces first, then routes.
396 * So the case where there are paths with a interface that matches
397 * one just created is the case where the path resolved through an
398 * interface that was deleted, and still has not been removed. The
399 * new interface added, is NO GUARANTEE that the interface being
400 * added now, even though it may have the same sw_if_index, is the
401 * same interface that the path needs. So tough!
402 * If the control plane wants these routes to resolve it needs to
403 * remove and add them again.
409 * for each glean on the interface trigger a walk back to the children
411 fib_node_back_walk_ctx_t bw_ctx = {
412 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE,
415 adj_glean_walk (sw_if_index, adj_glean_start_backwalk, &bw_ctx);
420 VNET_SW_INTERFACE_ADD_DEL_FUNCTION(adj_glean_interface_delete);
423 * Callback function invoked when an interface's MAC Address changes
426 adj_glean_ethernet_change_mac (ethernet_main_t * em,
430 adj_glean_walk (sw_if_index, adj_glean_update_rewrite_walk, NULL);
434 adj_glean_table_bind (fib_protocol_t fproto,
439 * for each glean on the interface trigger a walk back to the children
441 fib_node_back_walk_ctx_t bw_ctx = {
442 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_INTERFACE_BIND,
444 .fnbw_to_fib_index = itf_fib_index,
448 adj_glean_walk (sw_if_index, adj_glean_start_backwalk, &bw_ctx);
453 * Callback function invoked when an interface's IPv6 Table
457 adj_glean_ip6_table_bind (ip6_main_t * im,
463 adj_glean_table_bind (FIB_PROTOCOL_IP6, sw_if_index, new_fib_index);
467 * Callback function invoked when an interface's IPv4 Table
471 adj_glean_ip4_table_bind (ip4_main_t * im,
477 adj_glean_table_bind (FIB_PROTOCOL_IP4, sw_if_index, new_fib_index);
481 format_adj_glean (u8* s, va_list *ap)
483 index_t index = va_arg(*ap, index_t);
484 CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
485 ip_adjacency_t * adj = adj_get(index);
487 s = format(s, "%U-glean: [src:%U] %U",
488 format_fib_protocol, adj->ia_nh_proto,
489 format_fib_prefix, &adj->sub_type.glean.rx_pfx,
491 &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
497 adj_glean_db_size (void)
499 fib_protocol_t proto;
503 FOR_EACH_FIB_IP_PROTOCOL(proto)
505 vec_foreach_index(sw_if_index, adj_gleans[proto])
507 if (NULL != adj_gleans[proto][sw_if_index])
509 count += hash_elts(adj_gleans[proto][sw_if_index]);
517 adj_dpo_lock (dpo_id_t *dpo)
519 adj_lock(dpo->dpoi_index);
522 adj_dpo_unlock (dpo_id_t *dpo)
524 adj_unlock(dpo->dpoi_index);
527 const static dpo_vft_t adj_glean_dpo_vft = {
528 .dv_lock = adj_dpo_lock,
529 .dv_unlock = adj_dpo_unlock,
530 .dv_format = format_adj_glean,
531 .dv_get_urpf = adj_dpo_get_urpf,
532 .dv_get_mtu = adj_dpo_get_mtu,
536 * @brief The per-protocol VLIB graph nodes that are assigned to a glean
539 * this means that these graph nodes are ones from which a glean is the
540 * parent object in the DPO-graph.
542 const static char* const glean_ip4_nodes[] =
547 const static char* const glean_ip6_nodes[] =
553 const static char* const * const glean_nodes[DPO_PROTO_NUM] =
555 [DPO_PROTO_IP4] = glean_ip4_nodes,
556 [DPO_PROTO_IP6] = glean_ip6_nodes,
557 [DPO_PROTO_MPLS] = NULL,
561 adj_glean_module_init (void)
563 dpo_register(DPO_ADJACENCY_GLEAN, &adj_glean_dpo_vft, glean_nodes);
565 ethernet_address_change_ctx_t ctx = {
566 .function = adj_glean_ethernet_change_mac,
567 .function_opaque = 0,
569 vec_add1 (ethernet_main.address_change_callbacks, ctx);
571 ip6_table_bind_callback_t cbt6 = {
572 .function = adj_glean_ip6_table_bind,
574 vec_add1 (ip6_main.table_bind_callbacks, cbt6);
576 ip4_table_bind_callback_t cbt4 = {
577 .function = adj_glean_ip4_table_bind,
579 vec_add1 (ip4_main.table_bind_callbacks, cbt4);