FD.io VPP  v20.05.1-5-g09f167997
Vector Packet Processing
adj_mcast.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_mcast.h>
17 #include <vnet/adj/adj_internal.h>
18 #include <vnet/fib/fib_walk.h>
19 #include <vnet/ip/ip.h>
20 
21 /*
22  * The 'DB' of all mcast adjs.
23  * There is only one mcast per-interface per-protocol, so this is a per-interface
24  * vector
25  */
27 
28 static u32
30 {
31  switch (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:
37  break;
38  }
39  ASSERT(0);
40  return (0);
41 }
42 
43 /*
44  * adj_mcast_add_or_lock
45  *
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.
49  */
52  vnet_link_t link_type,
54 {
55  ip_adjacency_t * adj;
56 
58 
59  if (ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
60  {
61  vnet_main_t *vnm;
62 
63  vnm = vnet_get_main();
64  adj = adj_alloc(proto);
65 
67  adj->ia_nh_proto = proto;
68  adj->ia_link = link_type;
69  adj->ia_node_index = adj_get_mcast_node(proto);
71  adj_lock(adj_get_index(adj));
72 
73  vnet_rewrite_init(vnm, sw_if_index, link_type,
74  adj->ia_node_index,
75  vnet_tx_node_index_for_sw_interface(vnm, sw_if_index),
76  &adj->rewrite_header);
77 
78  /*
79  * we need a rewrite where the destination IP address is converted
80  * to the appropriate link-layer address. This is interface specific.
81  * So ask the interface to do it.
82  */
84  adj_get_index(adj));
85  }
86  else
87  {
88  adj = adj_get(adj_mcasts[proto][sw_if_index]);
89  adj_lock(adj_get_index(adj));
90  }
91 
93 
94  return (adj_get_index(adj));
95 }
96 
97 /**
98  * adj_mcast_update_rewrite
99  *
100  * Update the adjacency's rewrite string. A NULL string implies the
101  * rewrite is reset (i.e. when ARP/ND entry is gone).
102  * NB: the adj being updated may be handling traffic in the DP.
103  */
104 void
106  u8 *rewrite,
107  u8 offset)
108 {
109  ip_adjacency_t *adj;
110 
111  ASSERT(ADJ_INDEX_INVALID != adj_index);
112 
113  adj = adj_get(adj_index);
114 
115  /*
116  * update the adj's rewrite string and build the arc
117  * from the rewrite node to the interface's TX node
118  */
122  vnet_get_main(),
123  adj->rewrite_header.sw_if_index),
124  rewrite);
125  /*
126  * set the offset corresponding to the mcast IP address rewrite
127  */
128  adj->rewrite_header.dst_mcast_offset = offset;
129 }
130 
131 /**
132  * adj_mcast_midchain_update_rewrite
133  *
134  * Update the adjacency's rewrite string. A NULL string implies the
135  * rewrite is reset (i.e. when ARP/ND entry is gone).
136  * NB: the adj being updated may be handling traffic in the DP.
137  */
138 void
140  adj_midchain_fixup_t fixup,
141  const void *fixup_data,
143  u8 *rewrite,
144  u8 offset,
145  u32 mask)
146 {
147  ip_adjacency_t *adj;
148 
149  ASSERT(ADJ_INDEX_INVALID != adj_index);
150 
151  adj = adj_get(adj_index);
152 
153  /*
154  * one time only update. since we don't support changing the tunnel
155  * src,dst, this is all we need.
156  */
158  /*
159  * tunnels can always provide a rewrite.
160  */
161  ASSERT(NULL != rewrite);
162 
163  adj_midchain_setup(adj_index, fixup, fixup_data, flags);
164 
165  /*
166  * update the adj's rewrite string and build the arc
167  * from the rewrite node to the interface's TX node
168  */
172  vnet_get_main(),
173  adj->rewrite_header.sw_if_index),
174  rewrite);
175 
176  adj->rewrite_header.dst_mcast_offset = offset;
177 }
178 
179 void
182 {
183  ASSERT(sw_if_index < vec_len(adj_mcasts[proto]));
184 
186 }
187 
188 static clib_error_t *
191  u32 flags)
192 {
193  /*
194  * for each mcast on the interface trigger a walk back to the children
195  */
197  ip_adjacency_t *adj;
198 
199 
200  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
201  {
202  if (sw_if_index >= vec_len(adj_mcasts[proto]) ||
203  ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
204  continue;
205 
206  adj = adj_get(adj_mcasts[proto][sw_if_index]);
207 
208  fib_node_back_walk_ctx_t bw_ctx = {
212  };
213 
215  }
216 
217  return (NULL);
218 }
219 
221 
222 /**
223  * @brief Invoked on each SW interface of a HW interface when the
224  * HW interface state changes
225  */
226 static walk_rc_t
229  void *arg)
230 {
231  adj_mcast_interface_state_change(vnm, sw_if_index, (uword) arg);
232 
233  return (WALK_CONTINUE);
234 }
235 
236 /**
237  * @brief Registered callback for HW interface state changes
238  */
239 static clib_error_t *
241  u32 hw_if_index,
242  u32 flags)
243 {
244  /*
245  * walk SW interfaces on the HW
246  */
247  uword sw_flags;
248 
249  sw_flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
251  0);
252 
253  vnet_hw_interface_walk_sw(vnm, hw_if_index,
255  (void*) sw_flags);
256 
257  return (NULL);
258 }
259 
262 
263 static clib_error_t *
266  u32 is_add)
267 {
268  /*
269  * for each mcast on the interface trigger a walk back to the children
270  */
272  ip_adjacency_t *adj;
273 
274  if (is_add)
275  {
276  /*
277  * not interested in interface additions. we will not back walk
278  * to resolve paths through newly added interfaces. Why? The control
279  * plane should have the brains to add interfaces first, then routes.
280  * So the case where there are paths with a interface that matches
281  * one just created is the case where the path resolved through an
282  * interface that was deleted, and still has not been removed. The
283  * new interface added, is NO GUARANTEE that the interface being
284  * added now, even though it may have the same sw_if_index, is the
285  * same interface that the path needs. So tough!
286  * If the control plane wants these routes to resolve it needs to
287  * remove and add them again.
288  */
289  return (NULL);
290  }
291 
292  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
293  {
294  if (sw_if_index >= vec_len(adj_mcasts[proto]) ||
295  ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
296  continue;
297 
298  adj = adj_get(adj_mcasts[proto][sw_if_index]);
299 
300  fib_node_back_walk_ctx_t bw_ctx = {
302  };
303 
305  }
306 
307  return (NULL);
308 }
309 
311 
312 /**
313  * @brief Walk the multicast Adjacencies on a given interface
314  */
315 void
318  adj_walk_cb_t cb,
319  void *ctx)
320 {
321  if (vec_len(adj_mcasts[proto]) > sw_if_index)
322  {
323  if (ADJ_INDEX_INVALID != adj_mcasts[proto][sw_if_index])
324  {
325  cb(adj_mcasts[proto][sw_if_index], ctx);
326  }
327  }
328 }
329 
330 u8*
331 format_adj_mcast (u8* s, va_list *ap)
332 {
333  index_t index = va_arg(*ap, index_t);
334  CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
335  ip_adjacency_t * adj;
336 
337  if (!adj_is_valid(index))
338  return format(s, "<invalid adjacency>");
339 
340  adj = adj_get(index);
341 
342  s = format(s, "%U-mcast: ",
344  if (adj->rewrite_header.flags & VNET_REWRITE_HAS_FEATURES)
345  s = format(s, "[features] ");
346  s = format (s, "%U",
348  &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
349 
350  return (s);
351 }
352 
353 u8*
354 format_adj_mcast_midchain (u8* s, va_list *ap)
355 {
356  index_t index = va_arg(*ap, index_t);
357  CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
358  ip_adjacency_t * adj = adj_get(index);
359 
360  s = format(s, "%U-mcast-midchain: ",
362  s = format (s, "%U",
364  &adj->rewrite_header,
365  sizeof (adj->rewrite_data), 0);
366  s = format (s, "\n%Ustacked-on:\n%U%U",
367  format_white_space, indent,
368  format_white_space, indent+2,
369  format_dpo_id, &adj->sub_type.midchain.next_dpo, indent+2);
370 
371  return (s);
372 }
373 
374 
375 static void
377 {
378  adj_lock(dpo->dpoi_index);
379 }
380 static void
382 {
383  adj_unlock(dpo->dpoi_index);
384 }
385 
386 const static dpo_vft_t adj_mcast_dpo_vft = {
388  .dv_unlock = adj_dpo_unlock,
389  .dv_format = format_adj_mcast,
390  .dv_get_urpf = adj_dpo_get_urpf,
391 };
392 const static dpo_vft_t adj_mcast_midchain_dpo_vft = {
394  .dv_unlock = adj_dpo_unlock,
395  .dv_format = format_adj_mcast_midchain,
396  .dv_get_urpf = adj_dpo_get_urpf,
397 };
398 
399 /**
400  * @brief The per-protocol VLIB graph nodes that are assigned to a mcast
401  * object.
402  *
403  * this means that these graph nodes are ones from which a mcast is the
404  * parent object in the DPO-graph.
405  */
406 const static char* const adj_mcast_ip4_nodes[] =
407 {
408  "ip4-rewrite-mcast",
409  NULL,
410 };
411 const static char* const adj_mcast_ip6_nodes[] =
412 {
413  "ip6-rewrite-mcast",
414  NULL,
415 };
416 
417 const static char* const * const adj_mcast_nodes[DPO_PROTO_NUM] =
418 {
421  [DPO_PROTO_MPLS] = NULL,
422 };
423 
424 /**
425  * @brief The per-protocol VLIB graph nodes that are assigned to a mcast
426  * object.
427  *
428  * this means that these graph nodes are ones from which a mcast is the
429  * parent object in the DPO-graph.
430  */
431 const static char* const adj_mcast_midchain_ip4_nodes[] =
432 {
433  "ip4-mcast-midchain",
434  NULL,
435 };
436 const static char* const adj_mcast_midchain_ip6_nodes[] =
437 {
438  "ip6-mcast-midchain",
439  NULL,
440 };
441 
442 const static char* const * const adj_mcast_midchain_nodes[DPO_PROTO_NUM] =
443 {
446  [DPO_PROTO_MPLS] = NULL,
447 };
448 
449 /**
450  * @brief Return the size of the adj DB.
451  * This is only for testing purposes so an efficient implementation is not needed
452  */
453 u32
455 {
456  u32 n_adjs, sw_if_index;
458 
459  n_adjs = 0;
460  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
461  {
462  for (sw_if_index = 0;
463  sw_if_index < vec_len(adj_mcasts[proto]);
464  sw_if_index++)
465  {
466  if (ADJ_INDEX_INVALID != adj_mcasts[proto][sw_if_index])
467  {
468  n_adjs++;
469  }
470  }
471  }
472 
473  return (n_adjs);
474 }
475 
476 void
478 {
480  &adj_mcast_dpo_vft,
483  &adj_mcast_midchain_dpo_vft,
485 }
dpo_lock_fn_t dv_lock
A reference counting lock function.
Definition: dpo.h:406
#define CLIB_UNUSED(x)
Definition: clib.h:86
A virtual function table regisitered for a DPO type.
Definition: dpo.h:401
u8 * format_adj_mcast_midchain(u8 *s, va_list *ap)
Definition: adj_mcast.c:354
static const char *const adj_mcast_ip6_nodes[]
Definition: adj_mcast.c:411
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
Multicast Adjacency.
Definition: adj.h:82
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
union ip_adjacency_t_::@137 sub_type
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
void(* adj_midchain_fixup_t)(vlib_main_t *vm, const struct ip_adjacency_t_ *adj, vlib_buffer_t *b0, const void *data)
A function type for post-rewrite fixups on midchain adjacency.
Definition: adj.h:152
void adj_mcast_remove(fib_protocol_t proto, u32 sw_if_index)
Definition: adj_mcast.c:180
void adj_nbr_update_rewrite_internal(ip_adjacency_t *adj, ip_lookup_next_t adj_next_index, u32 complete_next_index, u32 next_index, u8 *rewrite)
adj_nbr_update_rewrite_internal
Definition: adj_nbr.c:342
u32 adj_dpo_get_urpf(const dpo_id_t *dpo)
Definition: adj.c:298
unsigned char u8
Definition: types.h:56
static void adj_dpo_lock(dpo_id_t *dpo)
Definition: adj_mcast.c:376
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
vlib_node_registration_t ip4_rewrite_mcast_node
(constructor) VLIB_REGISTER_NODE (ip4_rewrite_mcast_node)
Definition: ip4_forward.c:2694
vlib_node_registration_t ip6_rewrite_mcast_node
(constructor) VLIB_REGISTER_NODE (ip6_rewrite_mcast_node)
Definition: ip6_forward.c:2223
enum walk_rc_t_ walk_rc_t
Walk return code.
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
static u32 adj_get_mcast_node(fib_protocol_t proto)
Definition: adj_mcast.c:29
static const char *const adj_mcast_midchain_ip4_nodes[]
The per-protocol VLIB graph nodes that are assigned to a mcast object.
Definition: adj_mcast.c:431
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
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
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:129
void adj_mcast_walk(u32 sw_if_index, fib_protocol_t proto, adj_walk_cb_t cb, void *ctx)
Walk the multicast Adjacencies on a given interface.
Definition: adj_mcast.c:316
static clib_error_t * adj_mcast_interface_delete(vnet_main_t *vnm, u32 sw_if_index, u32 is_add)
Definition: adj_mcast.c:264
struct ip_adjacency_t_::@137::@139 midchain
IP_LOOKUP_NEXT_MIDCHAIN.
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
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
void adj_mcast_update_rewrite(adj_index_t adj_index, u8 *rewrite, u8 offset)
adj_mcast_update_rewrite
Definition: adj_mcast.c:105
#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
long ctx[MAX_CONNS]
Definition: main.c:144
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
u32 ia_node_index
The VLIB node in which this adj is used to forward packets.
Definition: adj.h:322
static const char *const *const adj_mcast_nodes[DPO_PROTO_NUM]
Definition: adj_mcast.c:417
static const char *const adj_mcast_midchain_ip6_nodes[]
Definition: adj_mcast.c:436
VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(adj_mcast_hw_interface_state_change)
static walk_rc_t adj_mcast_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_mcast.c:227
u32 flags
Definition: vhost_user.h:248
static clib_error_t * adj_mcast_interface_state_change(vnet_main_t *vnm, u32 sw_if_index, u32 flags)
Definition: adj_mcast.c:189
void vnet_rewrite_init(vnet_main_t *vnm, u32 sw_if_index, vnet_link_t linkt, u32 this_node, u32 next_node, vnet_rewrite_header_t *rw)
Definition: rewrite.c:80
Multicast Midchain Adjacency.
Definition: adj.h:89
u32 vnet_tx_node_index_for_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
Definition: rewrite.c:73
static const char *const adj_mcast_ip4_nodes[]
The per-protocol VLIB graph nodes that are assigned to a mcast object.
Definition: adj_mcast.c:406
void adj_mcast_module_init(void)
Module initialisation.
Definition: adj_mcast.c:477
adj_walk_rc_t(* adj_walk_cb_t)(adj_index_t ai, void *ctx)
Call back function when walking adjacencies.
Definition: adj_types.h:50
static clib_error_t * adj_mcast_hw_interface_state_change(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Registered callback for HW interface state changes.
Definition: adj_mcast.c:240
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
u8 * format_adj_mcast(u8 *s, va_list *ap)
Format/display a mcast adjacency.
Definition: adj_mcast.c:331
void adj_mcast_midchain_update_rewrite(adj_index_t adj_index, adj_midchain_fixup_t fixup, const void *fixup_data, adj_flags_t flags, u8 *rewrite, u8 offset, u32 mask)
adj_mcast_midchain_update_rewrite
Definition: adj_mcast.c:139
static const char *const *const adj_mcast_midchain_nodes[DPO_PROTO_NUM]
Definition: adj_mcast.c:442
Context passed between object during a back walk.
Definition: fib_node.h:208
u32 adj_mcast_db_size(void)
Return the size of the adj DB.
Definition: adj_mcast.c:454
#define ASSERT(truth)
VNET_SW_INTERFACE_ADD_DEL_FUNCTION(adj_mcast_interface_delete)
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
u8 * format_dpo_id(u8 *s, va_list *args)
Format a DPO_id_t oject.
Definition: dpo.c:148
enum adj_flags_t_ adj_flags_t
Flags on an IP adjacency.
template key/value backing page structure
Definition: bihash_doc.h:44
fib_protocol_t ia_nh_proto
The protocol of the neighbor/peer.
Definition: adj.h:342
#define DPO_PROTO_NUM
Definition: dpo.h:70
static void adj_dpo_unlock(dpo_id_t *dpo)
Definition: adj_mcast.c:381
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
u64 uword
Definition: types.h:112
ip_adjacency_t * adj_alloc(fib_protocol_t proto)
Definition: adj.c:63
static int adj_is_valid(adj_index_t adj_index)
Definition: adj.h:465
static adj_index_t * adj_mcasts[FIB_PROTOCOL_MAX]
Definition: adj_mcast.c:26
void adj_midchain_setup(adj_index_t adj_index, adj_midchain_fixup_t fixup, const void *data, adj_flags_t flags)
adj_midchain_setup
Definition: adj_midchain.c:378
#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
struct clib_bihash_value offset
template key/value backing page structure
adj_index_t adj_mcast_add_or_lock(fib_protocol_t proto, vnet_link_t link_type, u32 sw_if_index)
Mcast Adjacency.
Definition: adj_mcast.c:51
#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
This adjacency/interface has output features configured.
Definition: rewrite.h:57
VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(adj_mcast_interface_state_change)