FIB Interpose Source
[vpp.git] / src / vnet / adj / adj_glean.c
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
16 #include <vnet/adj/adj.h>
17 #include <vnet/adj/adj_internal.h>
18 #include <vnet/fib/fib_walk.h>
19
20 /*
21  * The 'DB' of all glean adjs.
22  * There is only one glean per-interface per-protocol, so this is a per-interface
23  * vector
24  */
25 static adj_index_t *adj_gleans[FIB_PROTOCOL_MAX];
26
27 static inline vlib_node_registration_t*
28 adj_get_glean_node (fib_protocol_t proto)
29 {
30     switch (proto) {
31     case FIB_PROTOCOL_IP4:
32         return (&ip4_glean_node);
33     case FIB_PROTOCOL_IP6:
34         return (&ip6_glean_node);
35     case FIB_PROTOCOL_MPLS:
36         break;
37     }
38     ASSERT(0);
39     return (NULL);
40 }
41
42 /*
43  * adj_glean_add_or_lock
44  *
45  * The next_hop address here is used for source address selection in the DP.
46  * The glean adj is added to an interface's connected prefix, the next-hop
47  * passed here is the local prefix on the same interface.
48  */
49 adj_index_t
50 adj_glean_add_or_lock (fib_protocol_t proto,
51                        vnet_link_t linkt,
52                        u32 sw_if_index,
53                        const ip46_address_t *nh_addr)
54 {
55     ip_adjacency_t * adj;
56
57     vec_validate_init_empty(adj_gleans[proto], sw_if_index, ADJ_INDEX_INVALID);
58
59     if (ADJ_INDEX_INVALID == adj_gleans[proto][sw_if_index])
60     {
61         adj = adj_alloc(proto);
62
63         adj->lookup_next_index = IP_LOOKUP_NEXT_GLEAN;
64         adj->ia_nh_proto = proto;
65         adj->ia_link = linkt;
66         adj_gleans[proto][sw_if_index] = adj_get_index(adj);
67
68         if (NULL != nh_addr)
69         {
70             adj->sub_type.glean.receive_addr = *nh_addr;
71         }
72         else
73         {
74             adj->sub_type.glean.receive_addr = zero_addr;
75         }
76
77         adj->rewrite_header.sw_if_index = sw_if_index;
78         adj->rewrite_header.data_bytes = 0;
79         adj->rewrite_header.max_l3_packet_bytes =
80             vnet_sw_interface_get_mtu(vnet_get_main(), sw_if_index, VLIB_TX);
81
82         adj_lock(adj_get_index(adj));
83
84         vnet_update_adjacency_for_sw_interface(vnet_get_main(),
85                                                sw_if_index,
86                                                adj_get_index(adj));
87     }
88     else
89     {
90         adj = adj_get(adj_gleans[proto][sw_if_index]);
91         adj_lock(adj_get_index(adj));
92     }
93
94     return (adj_get_index(adj));
95 }
96
97 /**
98  * adj_glean_update_rewrite
99  */
100 void
101 adj_glean_update_rewrite (adj_index_t adj_index)
102 {
103     ip_adjacency_t *adj;
104
105     ASSERT(ADJ_INDEX_INVALID != adj_index);
106
107     adj = adj_get(adj_index);
108
109     vnet_rewrite_for_sw_interface(vnet_get_main(),
110                                   adj_fib_proto_2_nd(adj->ia_nh_proto),
111                                   adj->rewrite_header.sw_if_index,
112                                   adj_get_glean_node(adj->ia_nh_proto)->index,
113                                   VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST,
114                                   &adj->rewrite_header,
115                                   sizeof (adj->rewrite_data));
116 }
117
118 adj_index_t
119 adj_glean_get (fib_protocol_t proto,
120                u32 sw_if_index)
121 {
122     if (sw_if_index < vec_len(adj_gleans[proto]))
123     {
124         return (adj_gleans[proto][sw_if_index]);
125     }
126     return (ADJ_INDEX_INVALID);
127 }
128
129 void
130 adj_glean_remove (fib_protocol_t proto,
131                   u32 sw_if_index)
132 {
133     ASSERT(sw_if_index < vec_len(adj_gleans[proto]));
134
135     adj_gleans[proto][sw_if_index] = ADJ_INDEX_INVALID;
136 }
137
138 static clib_error_t *
139 adj_glean_interface_state_change (vnet_main_t * vnm,
140                                   u32 sw_if_index,
141                                   u32 flags)
142 {
143     /*
144      * for each glean on the interface trigger a walk back to the children
145      */
146     fib_protocol_t proto;
147     ip_adjacency_t *adj;
148
149
150     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
151     {
152         if (sw_if_index >= vec_len(adj_gleans[proto]) ||
153             ADJ_INDEX_INVALID == adj_gleans[proto][sw_if_index])
154             continue;
155
156         adj = adj_get(adj_gleans[proto][sw_if_index]);
157
158         fib_node_back_walk_ctx_t bw_ctx = {
159             .fnbw_reason = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP ?
160                             FIB_NODE_BW_REASON_FLAG_INTERFACE_UP :
161                             FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN),
162         };
163
164         fib_walk_sync(FIB_NODE_TYPE_ADJ, adj_get_index(adj), &bw_ctx);
165     }
166
167     return (NULL);
168 }
169
170 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(adj_glean_interface_state_change);
171
172 /**
173  * @brief Invoked on each SW interface of a HW interface when the
174  * HW interface state changes
175  */
176 static void
177 adj_nbr_hw_sw_interface_state_change (vnet_main_t * vnm,
178                                       u32 sw_if_index,
179                                       void *arg)
180 {
181     adj_glean_interface_state_change(vnm, sw_if_index, (uword) arg);
182 }
183
184 /**
185  * @brief Registered callback for HW interface state changes
186  */
187 static clib_error_t *
188 adj_glean_hw_interface_state_change (vnet_main_t * vnm,
189                                      u32 hw_if_index,
190                                      u32 flags)
191 {
192     /*
193      * walk SW interfaces on the HW
194      */
195     uword sw_flags;
196
197     sw_flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
198                 VNET_SW_INTERFACE_FLAG_ADMIN_UP :
199                 0);
200
201     vnet_hw_interface_walk_sw(vnm, hw_if_index,
202                               adj_nbr_hw_sw_interface_state_change,
203                               (void*) sw_flags);
204
205     return (NULL);
206 }
207
208 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(
209     adj_glean_hw_interface_state_change);
210
211 static clib_error_t *
212 adj_glean_interface_delete (vnet_main_t * vnm,
213                             u32 sw_if_index,
214                             u32 is_add)
215 {
216     /*
217      * for each glean on the interface trigger a walk back to the children
218      */
219     fib_protocol_t proto;
220     ip_adjacency_t *adj;
221
222     if (is_add)
223     {
224         /*
225          * not interested in interface additions. we will not back walk
226          * to resolve paths through newly added interfaces. Why? The control
227          * plane should have the brains to add interfaces first, then routes.
228          * So the case where there are paths with a interface that matches
229          * one just created is the case where the path resolved through an
230          * interface that was deleted, and still has not been removed. The
231          * new interface added, is NO GUARANTEE that the interface being
232          * added now, even though it may have the same sw_if_index, is the
233          * same interface that the path needs. So tough!
234          * If the control plane wants these routes to resolve it needs to
235          * remove and add them again.
236          */
237         return (NULL);
238     }
239
240     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
241     {
242         if (sw_if_index >= vec_len(adj_gleans[proto]) ||
243             ADJ_INDEX_INVALID == adj_gleans[proto][sw_if_index])
244             continue;
245
246         adj = adj_get(adj_gleans[proto][sw_if_index]);
247
248         fib_node_back_walk_ctx_t bw_ctx = {
249             .fnbw_reason =  FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE,
250         };
251
252         fib_walk_sync(FIB_NODE_TYPE_ADJ, adj_get_index(adj), &bw_ctx);
253     }
254
255     return (NULL);
256 }
257
258 VNET_SW_INTERFACE_ADD_DEL_FUNCTION(adj_glean_interface_delete);
259
260 u8*
261 format_adj_glean (u8* s, va_list *ap)
262 {
263     index_t index = va_arg(*ap, index_t);
264     CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
265     ip_adjacency_t * adj = adj_get(index);
266
267     s = format(s, "%U-glean: %U",
268                format_fib_protocol, adj->ia_nh_proto,
269                 format_vnet_rewrite,
270                 &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
271
272     return (s);
273 }
274
275
276 static void
277 adj_dpo_lock (dpo_id_t *dpo)
278 {
279     adj_lock(dpo->dpoi_index);
280 }
281 static void
282 adj_dpo_unlock (dpo_id_t *dpo)
283 {
284     adj_unlock(dpo->dpoi_index);
285 }
286
287 const static dpo_vft_t adj_glean_dpo_vft = {
288     .dv_lock = adj_dpo_lock,
289     .dv_unlock = adj_dpo_unlock,
290     .dv_format = format_adj_glean,
291     .dv_get_urpf = adj_dpo_get_urpf,
292 };
293
294 /**
295  * @brief The per-protocol VLIB graph nodes that are assigned to a glean
296  *        object.
297  *
298  * this means that these graph nodes are ones from which a glean is the
299  * parent object in the DPO-graph.
300  */
301 const static char* const glean_ip4_nodes[] =
302 {
303     "ip4-glean",
304     NULL,
305 };
306 const static char* const glean_ip6_nodes[] =
307 {
308     "ip6-glean",
309     NULL,
310 };
311
312 const static char* const * const glean_nodes[DPO_PROTO_NUM] =
313 {
314     [DPO_PROTO_IP4]  = glean_ip4_nodes,
315     [DPO_PROTO_IP6]  = glean_ip6_nodes,
316     [DPO_PROTO_MPLS] = NULL,
317 };
318
319 void
320 adj_glean_module_init (void)
321 {
322     dpo_register(DPO_ADJACENCY_GLEAN, &adj_glean_dpo_vft, glean_nodes);
323 }