FD.io VPP  v20.05.1-6-gf53edbc3b
Vector Packet Processing
adj_glean.c
Go to the documentation of this file.
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  */
26 
27 static inline u32
29 {
30  switch (proto) {
31  case FIB_PROTOCOL_IP4:
32  return (ip4_glean_node.index);
33  case FIB_PROTOCOL_IP6:
34  return (ip6_glean_node.index);
35  case FIB_PROTOCOL_MPLS:
36  break;
37  }
38  ASSERT(0);
39  return (~0);
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  */
51  vnet_link_t linkt,
53  const ip46_address_t *nh_addr)
54 {
55  ip_adjacency_t * adj;
56 
58 
59  if (ADJ_INDEX_INVALID == adj_gleans[proto][sw_if_index])
60  {
61  adj = adj_alloc(proto);
62 
64  adj->ia_nh_proto = proto;
65  adj->ia_link = linkt;
66  adj->ia_node_index = adj_get_glean_node(proto);
68 
69  if (NULL != nh_addr)
70  {
71  adj->sub_type.glean.receive_addr = *nh_addr;
72  }
73  else
74  {
75  adj->sub_type.glean.receive_addr = zero_addr;
76  }
77 
78  adj->rewrite_header.sw_if_index = sw_if_index;
79  adj->rewrite_header.data_bytes = 0;
80  adj->rewrite_header.max_l3_packet_bytes =
82  vnet_link_to_mtu(linkt));
83  adj_lock(adj_get_index(adj));
84 
86  sw_if_index,
87  adj_get_index(adj));
88  }
89  else
90  {
91  adj = adj_get(adj_gleans[proto][sw_if_index]);
92  adj_lock(adj_get_index(adj));
93  }
94 
96 
97  return (adj_get_index(adj));
98 }
99 
100 /**
101  * adj_glean_update_rewrite
102  */
103 void
105 {
106  ip_adjacency_t *adj;
107 
108  ASSERT(ADJ_INDEX_INVALID != adj_index);
109 
110  adj = adj_get(adj_index);
111 
114  adj->rewrite_header.sw_if_index,
115  adj->ia_node_index,
117  &adj->rewrite_header,
118  sizeof (adj->rewrite_data));
119 }
120 
124 {
125  if (sw_if_index < vec_len(adj_gleans[proto]))
126  {
127  return (adj_gleans[proto][sw_if_index]);
128  }
129  return (ADJ_INDEX_INVALID);
130 }
131 
132 void
135 {
136  ASSERT(sw_if_index < vec_len(adj_gleans[proto]));
137 
139 }
140 
141 static clib_error_t *
144  u32 flags)
145 {
146  /*
147  * for each glean on the interface trigger a walk back to the children
148  */
150  ip_adjacency_t *adj;
151 
153  {
154  if (sw_if_index >= vec_len(adj_gleans[proto]) ||
155  ADJ_INDEX_INVALID == adj_gleans[proto][sw_if_index])
156  continue;
157 
158  adj = adj_get(adj_gleans[proto][sw_if_index]);
159 
160  fib_node_back_walk_ctx_t bw_ctx = {
164  };
165 
167  }
168 
169  return (NULL);
170 }
171 
173 
174 /**
175  * @brief Invoked on each SW interface of a HW interface when the
176  * HW interface state changes
177  */
178 static walk_rc_t
181  void *arg)
182 {
183  adj_glean_interface_state_change(vnm, sw_if_index, (uword) arg);
184 
185  return (WALK_CONTINUE);
186 }
187 
188 /**
189  * @brief Registered callback for HW interface state changes
190  */
191 static clib_error_t *
193  u32 hw_if_index,
194  u32 flags)
195 {
196  /*
197  * walk SW interfaces on the HW
198  */
199  uword sw_flags;
200 
201  sw_flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
203  0);
204 
205  vnet_hw_interface_walk_sw(vnm, hw_if_index,
207  (void*) sw_flags);
208 
209  return (NULL);
210 }
211 
214 
215 static clib_error_t *
218  u32 is_add)
219 {
220  /*
221  * for each glean on the interface trigger a walk back to the children
222  */
224  ip_adjacency_t *adj;
225 
226  if (is_add)
227  {
228  /*
229  * not interested in interface additions. we will not back walk
230  * to resolve paths through newly added interfaces. Why? The control
231  * plane should have the brains to add interfaces first, then routes.
232  * So the case where there are paths with a interface that matches
233  * one just created is the case where the path resolved through an
234  * interface that was deleted, and still has not been removed. The
235  * new interface added, is NO GUARANTEE that the interface being
236  * added now, even though it may have the same sw_if_index, is the
237  * same interface that the path needs. So tough!
238  * If the control plane wants these routes to resolve it needs to
239  * remove and add them again.
240  */
241  return (NULL);
242  }
243 
245  {
246  if (sw_if_index >= vec_len(adj_gleans[proto]) ||
247  ADJ_INDEX_INVALID == adj_gleans[proto][sw_if_index])
248  continue;
249 
250  adj = adj_get(adj_gleans[proto][sw_if_index]);
251 
252  fib_node_back_walk_ctx_t bw_ctx = {
254  };
255 
257  }
258 
259  return (NULL);
260 }
261 
263 
264 u8*
265 format_adj_glean (u8* s, va_list *ap)
266 {
267  index_t index = va_arg(*ap, index_t);
268  CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
269  ip_adjacency_t * adj = adj_get(index);
270 
271  s = format(s, "%U-glean: %U",
274  &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
275 
276  return (s);
277 }
278 
279 
280 static void
282 {
283  adj_lock(dpo->dpoi_index);
284 }
285 static void
287 {
288  adj_unlock(dpo->dpoi_index);
289 }
290 
291 const static dpo_vft_t adj_glean_dpo_vft = {
293  .dv_unlock = adj_dpo_unlock,
294  .dv_format = format_adj_glean,
295  .dv_get_urpf = adj_dpo_get_urpf,
296 };
297 
298 /**
299  * @brief The per-protocol VLIB graph nodes that are assigned to a glean
300  * object.
301  *
302  * this means that these graph nodes are ones from which a glean is the
303  * parent object in the DPO-graph.
304  */
305 const static char* const glean_ip4_nodes[] =
306 {
307  "ip4-glean",
308  NULL,
309 };
310 const static char* const glean_ip6_nodes[] =
311 {
312  "ip6-glean",
313  NULL,
314 };
315 
316 const static char* const * const glean_nodes[DPO_PROTO_NUM] =
317 {
320  [DPO_PROTO_MPLS] = NULL,
321 };
322 
323 void
325 {
326  dpo_register(DPO_ADJACENCY_GLEAN, &adj_glean_dpo_vft, glean_nodes);
327 }
dpo_lock_fn_t dv_lock
A reference counting lock function.
Definition: dpo.h:406
void adj_glean_remove(fib_protocol_t proto, u32 sw_if_index)
Definition: adj_glean.c:133
#define VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST
Definition: rewrite.h:234
#define CLIB_UNUSED(x)
Definition: clib.h:86
A virtual function table regisitered for a DPO type.
Definition: dpo.h:401
void adj_lock(adj_index_t adj_index)
Take a reference counting lock on the adjacency.
Definition: adj.c:308
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
void adj_delegate_adj_created(ip_adjacency_t *adj)
Definition: adj_delegate.c:158
void vnet_hw_interface_walk_sw(vnet_main_t *vnm, u32 hw_if_index, vnet_hw_sw_interface_walk_t fn, void *ctx)
Walk the SW interfaces on a HW interface - this is the super interface and any sub-interfaces.
Definition: interface.c:1049
IP unicast adjacency.
Definition: adj.h:227
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
void vnet_rewrite_for_sw_interface(vnet_main_t *vnm, vnet_link_t link_type, u32 sw_if_index, u32 node_index, void *dst_address, vnet_rewrite_header_t *rw, u32 max_rewrite_bytes)
Deprecated.
Definition: rewrite.c:101
adj_index_t adj_glean_get(fib_protocol_t proto, u32 sw_if_index)
Get an existing glean.
Definition: adj_glean.c:122
union ip_adjacency_t_::@137 sub_type
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
static u32 vnet_sw_interface_get_mtu(vnet_main_t *vnm, u32 sw_if_index, vnet_mtu_t af)
u32 adj_dpo_get_urpf(const dpo_id_t *dpo)
Definition: adj.c:298
unsigned char u8
Definition: types.h:56
u8 * format_fib_protocol(u8 *s, va_list *ap)
Definition: fib_types.c:33
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
vnet_link_t ia_link
link/ether-type 1 bytes
Definition: adj.h:335
enum walk_rc_t_ walk_rc_t
Walk return code.
void adj_glean_update_rewrite(adj_index_t adj_index)
adj_glean_update_rewrite
Definition: adj_glean.c:104
static ip_adjacency_t * adj_get(adj_index_t adj_index)
Get a pointer to an adjacency object from its index.
Definition: adj.h:459
void dpo_register(dpo_type_t type, const dpo_vft_t *vft, const char *const *const *nodes)
For a given DPO type Register:
Definition: dpo.c:322
vl_api_interface_index_t sw_if_index
Definition: gre.api:53
static walk_rc_t adj_nbr_hw_sw_interface_state_change(vnet_main_t *vnm, u32 sw_if_index, void *arg)
Invoked on each SW interface of a HW interface when the HW interface state changes.
Definition: adj_glean.c:179
void fib_walk_sync(fib_node_type_t parent_type, fib_node_index_t parent_index, fib_node_back_walk_ctx_t *ctx)
Back walk all the children of a FIB node.
Definition: fib_walk.c:745
static adj_index_t * adj_gleans[FIB_PROTOCOL_MAX]
Definition: adj_glean.c:25
void adj_unlock(adj_index_t adj_index)
Release a reference counting lock on the adjacency.
Definition: adj.c:325
void vnet_update_adjacency_for_sw_interface(vnet_main_t *vnm, u32 sw_if_index, u32 ai)
Definition: rewrite.c:179
unsigned int u32
Definition: types.h:88
format_function_t format_vnet_rewrite
Definition: rewrite.h:263
static clib_error_t * adj_glean_interface_delete(vnet_main_t *vnm, u32 sw_if_index, u32 is_add)
Definition: adj_glean.c:216
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:170
fib_node_bw_reason_flag_t fnbw_reason
The reason/trigger for the backwalk.
Definition: fib_node.h:212
#define ADJ_INDEX_INVALID
Invalid ADJ index - used when no adj is known likewise blazoned capitals INVALID speak volumes where ...
Definition: adj_types.h:36
vl_api_ip_proto_t proto
Definition: acl_types.api:50
vl_api_address_t nh_addr
Definition: lisp_gpe.api:222
static adj_index_t adj_get_index(const ip_adjacency_t *adj)
Get a pointer to an adjacency object from its index.
Definition: adj_internal.h:101
static clib_error_t * adj_glean_hw_interface_state_change(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Registered callback for HW interface state changes.
Definition: adj_glean.c:192
vlib_node_registration_t ip6_glean_node
(constructor) VLIB_REGISTER_NODE (ip6_glean_node)
Definition: ip6_neighbor.c:263
u32 ia_node_index
The VLIB node in which this adj is used to forward packets.
Definition: adj.h:322
This packet matches an "interface route" and packets need to be passed to ARP to find rewrite string ...
Definition: adj.h:68
static void adj_dpo_unlock(dpo_id_t *dpo)
Definition: adj_glean.c:286
void adj_glean_module_init(void)
Module initialisation.
Definition: adj_glean.c:324
static const char *const glean_ip4_nodes[]
The per-protocol VLIB graph nodes that are assigned to a glean object.
Definition: adj_glean.c:305
u32 flags
Definition: vhost_user.h:248
static clib_error_t * adj_glean_interface_state_change(vnet_main_t *vnm, u32 sw_if_index, u32 flags)
Definition: adj_glean.c:142
static void adj_dpo_lock(dpo_id_t *dpo)
Definition: adj_glean.c:281
u8 * format_adj_glean(u8 *s, va_list *ap)
Format/display a glean adjacency.
Definition: adj_glean.c:265
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
static const char *const *const glean_nodes[DPO_PROTO_NUM]
Definition: adj_glean.c:316
VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(adj_glean_hw_interface_state_change)
Context passed between object during a back walk.
Definition: fib_node.h:208
#define ASSERT(truth)
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
struct ip_adjacency_t_::@137::@140 glean
IP_LOOKUP_NEXT_GLEAN.
VNET_SW_INTERFACE_ADD_DEL_FUNCTION(adj_glean_interface_delete)
static const char *const glean_ip6_nodes[]
Definition: adj_glean.c:310
fib_protocol_t ia_nh_proto
The protocol of the neighbor/peer.
Definition: adj.h:342
#define DPO_PROTO_NUM
Definition: dpo.h:70
index_t dpoi_index
the index of objects of that type
Definition: dpo.h:186
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
ip_lookup_next_t lookup_next_index
Next hop after ip4-lookup.
Definition: adj.h:329
vnet_mtu_t vnet_link_to_mtu(vnet_link_t link)
Definition: interface.c:1619
u64 uword
Definition: types.h:112
ip_adjacency_t * adj_alloc(fib_protocol_t proto)
Definition: adj.c:63
adj_index_t adj_glean_add_or_lock(fib_protocol_t proto, vnet_link_t linkt, u32 sw_if_index, const ip46_address_t *nh_addr)
Glean Adjacency.
Definition: adj_glean.c:50
#define FOR_EACH_FIB_IP_PROTOCOL(_item)
Definition: fib_types.h:70
#define FIB_PROTOCOL_MAX
Definition outside of enum so it does not need to be included in non-defaulted switch statements...
Definition: fib_types.h:52
vlib_node_registration_t ip4_glean_node
(constructor) VLIB_REGISTER_NODE (ip4_glean_node)
Definition: ip4_neighbor.c:274
static vnet_link_t adj_fib_proto_2_nd(fib_protocol_t fp)
Definition: adj_internal.h:67
#define vec_validate_init_empty(V, I, INIT)
Make sure vector is long enough for given index and initialize empty space (no header, unspecified alignment)
Definition: vec.h:554
static u32 adj_get_glean_node(fib_protocol_t proto)
Definition: adj_glean.c:28
const ip46_address_t zero_addr
Definition: lookup.c:181
VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(adj_glean_interface_state_change)