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>
19 #include <vnet/ip/ip.h>
22 * The 'DB' of all mcast adjs.
23 * There is only one mcast per-interface per-protocol, so this is a per-interface
26 static adj_index_t *adj_mcasts[FIB_PROTOCOL_MAX];
29 adj_get_mcast_node (fib_protocol_t proto)
32 case FIB_PROTOCOL_IP4:
33 return (ip4_rewrite_mcast_node.index);
34 case FIB_PROTOCOL_IP6:
35 return (ip6_rewrite_mcast_node.index);
36 case FIB_PROTOCOL_MPLS:
44 * adj_mcast_add_or_lock
46 * The next_hop address here is used for source address selection in the DP.
47 * The mcast adj is added to an interface's connected prefix, the next-hop
48 * passed here is the local prefix on the same interface.
51 adj_mcast_add_or_lock (fib_protocol_t proto,
52 vnet_link_t link_type,
57 vec_validate_init_empty(adj_mcasts[proto], sw_if_index, ADJ_INDEX_INVALID);
59 if (ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
63 vnm = vnet_get_main();
64 adj = adj_alloc(proto);
66 adj->lookup_next_index = IP_LOOKUP_NEXT_MCAST;
67 adj->ia_nh_proto = proto;
68 adj->ia_link = link_type;
69 adj_mcasts[proto][sw_if_index] = adj_get_index(adj);
70 adj_lock(adj_get_index(adj));
72 vnet_rewrite_init(vnm, sw_if_index,
73 adj_get_mcast_node(proto),
74 vnet_tx_node_index_for_sw_interface(vnm, sw_if_index),
75 &adj->rewrite_header);
78 * we need a rewrite where the destination IP address is converted
79 * to the appropriate link-layer address. This is interface specific.
80 * So ask the interface to do it.
82 vnet_update_adjacency_for_sw_interface(vnm, sw_if_index,
87 adj = adj_get(adj_mcasts[proto][sw_if_index]);
88 adj_lock(adj_get_index(adj));
91 return (adj_get_index(adj));
95 * adj_mcast_update_rewrite
97 * Update the adjacency's rewrite string. A NULL string implies the
98 * rewirte is reset (i.e. when ARP/ND etnry is gone).
99 * NB: the adj being updated may be handling traffic in the DP.
102 adj_mcast_update_rewrite (adj_index_t adj_index,
109 ASSERT(ADJ_INDEX_INVALID != adj_index);
111 adj = adj_get(adj_index);
114 * update the adj's rewrite string and build the arc
115 * from the rewrite node to the interface's TX node
117 adj_nbr_update_rewrite_internal(adj, IP_LOOKUP_NEXT_MCAST,
118 adj_get_mcast_node(adj->ia_nh_proto),
119 vnet_tx_node_index_for_sw_interface(
121 adj->rewrite_header.sw_if_index),
124 * set the fields corresponding to the mcast IP address rewrite
125 * The mask must be stored in network byte order, since the packet's
126 * IP address will also be in network order.
128 adj->rewrite_header.dst_mcast_offset = offset;
129 adj->rewrite_header.dst_mcast_mask = clib_host_to_net_u32(mask);
133 adj_mcast_remove (fib_protocol_t proto,
136 ASSERT(sw_if_index < vec_len(adj_mcasts[proto]));
138 adj_mcasts[proto][sw_if_index] = ADJ_INDEX_INVALID;
141 static clib_error_t *
142 adj_mcast_interface_state_change (vnet_main_t * vnm,
147 * for each mcast on the interface trigger a walk back to the children
149 fib_protocol_t proto;
153 for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
155 if (sw_if_index >= vec_len(adj_mcasts[proto]) ||
156 ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
159 adj = adj_get(adj_mcasts[proto][sw_if_index]);
161 fib_node_back_walk_ctx_t bw_ctx = {
162 .fnbw_reason = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP ?
163 FIB_NODE_BW_REASON_FLAG_INTERFACE_UP :
164 FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN),
167 fib_walk_sync(FIB_NODE_TYPE_ADJ, adj_get_index(adj), &bw_ctx);
173 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(adj_mcast_interface_state_change);
176 * @brief Invoked on each SW interface of a HW interface when the
177 * HW interface state changes
180 adj_nbr_hw_sw_interface_state_change (vnet_main_t * vnm,
184 adj_mcast_interface_state_change(vnm, sw_if_index, (uword) arg);
188 * @brief Registered callback for HW interface state changes
190 static clib_error_t *
191 adj_mcast_hw_interface_state_change (vnet_main_t * vnm,
196 * walk SW interfaces on the HW
200 sw_flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
201 VNET_SW_INTERFACE_FLAG_ADMIN_UP :
204 vnet_hw_interface_walk_sw(vnm, hw_if_index,
205 adj_nbr_hw_sw_interface_state_change,
211 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(
212 adj_mcast_hw_interface_state_change);
214 static clib_error_t *
215 adj_mcast_interface_delete (vnet_main_t * vnm,
220 * for each mcast on the interface trigger a walk back to the children
222 fib_protocol_t proto;
228 * not interested in interface additions. we will not back walk
229 * to resolve paths through newly added interfaces. Why? The control
230 * plane should have the brains to add interfaces first, then routes.
231 * So the case where there are paths with a interface that matches
232 * one just created is the case where the path resolved through an
233 * interface that was deleted, and still has not been removed. The
234 * new interface added, is NO GUARANTEE that the interface being
235 * added now, even though it may have the same sw_if_index, is the
236 * same interface that the path needs. So tough!
237 * If the control plane wants these routes to resolve it needs to
238 * remove and add them again.
243 for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
245 if (sw_if_index >= vec_len(adj_mcasts[proto]) ||
246 ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
249 adj = adj_get(adj_mcasts[proto][sw_if_index]);
251 fib_node_back_walk_ctx_t bw_ctx = {
252 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE,
255 fib_walk_sync(FIB_NODE_TYPE_ADJ, adj_get_index(adj), &bw_ctx);
261 VNET_SW_INTERFACE_ADD_DEL_FUNCTION(adj_mcast_interface_delete);
264 format_adj_mcast (u8* s, va_list *ap)
266 index_t index = va_arg(*ap, index_t);
267 CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
268 ip_adjacency_t * adj = adj_get(index);
270 s = format(s, "%U-mcast: ",
271 format_fib_protocol, adj->ia_nh_proto);
274 &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
281 adj_dpo_lock (dpo_id_t *dpo)
283 adj_lock(dpo->dpoi_index);
286 adj_dpo_unlock (dpo_id_t *dpo)
288 adj_unlock(dpo->dpoi_index);
291 const static dpo_vft_t adj_mcast_dpo_vft = {
292 .dv_lock = adj_dpo_lock,
293 .dv_unlock = adj_dpo_unlock,
294 .dv_format = format_adj_mcast,
298 * @brief The per-protocol VLIB graph nodes that are assigned to a mcast
301 * this means that these graph nodes are ones from which a mcast is the
302 * parent object in the DPO-graph.
304 const static char* const adj_mcast_ip4_nodes[] =
309 const static char* const adj_mcast_ip6_nodes[] =
315 const static char* const * const adj_mcast_nodes[DPO_PROTO_NUM] =
317 [DPO_PROTO_IP4] = adj_mcast_ip4_nodes,
318 [DPO_PROTO_IP6] = adj_mcast_ip6_nodes,
319 [DPO_PROTO_MPLS] = NULL,
323 * @brief Return the size of the adj DB.
324 * This is only for testing purposes so an efficient implementation is not needed
327 adj_mcast_db_size (void)
329 u32 n_adjs, sw_if_index;
330 fib_protocol_t proto;
333 for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
335 for (sw_if_index = 0;
336 sw_if_index < vec_len(adj_mcasts[proto]);
339 if (ADJ_INDEX_INVALID != adj_mcasts[proto][sw_if_index])
350 adj_mcast_module_init (void)
352 dpo_register(DPO_ADJACENCY_MCAST, &adj_mcast_dpo_vft, adj_mcast_nodes);