FD.io VPP  v19.04.4-rc0-5-ge88582fac
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_mcasts[proto][sw_if_index] = adj_get_index(adj);
70  adj_lock(adj_get_index(adj));
71 
72  vnet_rewrite_init(vnm, sw_if_index, link_type,
73  adj_get_mcast_node(proto),
74  vnet_tx_node_index_for_sw_interface(vnm, sw_if_index),
75  &adj->rewrite_header);
76 
77  /*
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.
81  */
83  adj_get_index(adj));
84  }
85  else
86  {
87  adj = adj_get(adj_mcasts[proto][sw_if_index]);
88  adj_lock(adj_get_index(adj));
89  }
90 
91  return (adj_get_index(adj));
92 }
93 
94 /**
95  * adj_mcast_update_rewrite
96  *
97  * Update the adjacency's rewrite string. A NULL string implies the
98  * rewrite is reset (i.e. when ARP/ND entry is gone).
99  * NB: the adj being updated may be handling traffic in the DP.
100  */
101 void
103  u8 *rewrite,
104  u8 offset)
105 {
106  ip_adjacency_t *adj;
107 
108  ASSERT(ADJ_INDEX_INVALID != adj_index);
109 
110  adj = adj_get(adj_index);
111 
112  /*
113  * update the adj's rewrite string and build the arc
114  * from the rewrite node to the interface's TX node
115  */
119  vnet_get_main(),
120  adj->rewrite_header.sw_if_index),
121  rewrite);
122  /*
123  * set the offset corresponding to the mcast IP address rewrite
124  */
125  adj->rewrite_header.dst_mcast_offset = offset;
126 }
127 
128 /**
129  * adj_mcast_midchain_update_rewrite
130  *
131  * Update the adjacency's rewrite string. A NULL string implies the
132  * rewrite is reset (i.e. when ARP/ND entry is gone).
133  * NB: the adj being updated may be handling traffic in the DP.
134  */
135 void
137  adj_midchain_fixup_t fixup,
138  const void *fixup_data,
140  u8 *rewrite,
141  u8 offset,
142  u32 mask)
143 {
144  ip_adjacency_t *adj;
145 
146  ASSERT(ADJ_INDEX_INVALID != adj_index);
147 
148  adj = adj_get(adj_index);
149 
150  /*
151  * one time only update. since we don't support changing the tunnel
152  * src,dst, this is all we need.
153  */
155  /*
156  * tunnels can always provide a rewrite.
157  */
158  ASSERT(NULL != rewrite);
159 
160  adj_midchain_setup(adj_index, fixup, fixup_data, flags);
161 
162  /*
163  * update the adj's rewrite string and build the arc
164  * from the rewrite node to the interface's TX node
165  */
169  vnet_get_main(),
170  adj->rewrite_header.sw_if_index),
171  rewrite);
172 
173  adj->rewrite_header.dst_mcast_offset = offset;
174 }
175 
176 void
179 {
180  ASSERT(sw_if_index < vec_len(adj_mcasts[proto]));
181 
183 }
184 
185 static clib_error_t *
188  u32 flags)
189 {
190  /*
191  * for each mcast on the interface trigger a walk back to the children
192  */
193  fib_protocol_t proto;
194  ip_adjacency_t *adj;
195 
196 
197  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
198  {
199  if (sw_if_index >= vec_len(adj_mcasts[proto]) ||
200  ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
201  continue;
202 
203  adj = adj_get(adj_mcasts[proto][sw_if_index]);
204 
205  fib_node_back_walk_ctx_t bw_ctx = {
209  };
210 
212  }
213 
214  return (NULL);
215 }
216 
218 
219 /**
220  * @brief Invoked on each SW interface of a HW interface when the
221  * HW interface state changes
222  */
223 static walk_rc_t
226  void *arg)
227 {
228  adj_mcast_interface_state_change(vnm, sw_if_index, (uword) arg);
229 
230  return (WALK_CONTINUE);
231 }
232 
233 /**
234  * @brief Registered callback for HW interface state changes
235  */
236 static clib_error_t *
238  u32 hw_if_index,
239  u32 flags)
240 {
241  /*
242  * walk SW interfaces on the HW
243  */
244  uword sw_flags;
245 
246  sw_flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
248  0);
249 
250  vnet_hw_interface_walk_sw(vnm, hw_if_index,
252  (void*) sw_flags);
253 
254  return (NULL);
255 }
256 
259 
260 static clib_error_t *
263  u32 is_add)
264 {
265  /*
266  * for each mcast on the interface trigger a walk back to the children
267  */
268  fib_protocol_t proto;
269  ip_adjacency_t *adj;
270 
271  if (is_add)
272  {
273  /*
274  * not interested in interface additions. we will not back walk
275  * to resolve paths through newly added interfaces. Why? The control
276  * plane should have the brains to add interfaces first, then routes.
277  * So the case where there are paths with a interface that matches
278  * one just created is the case where the path resolved through an
279  * interface that was deleted, and still has not been removed. The
280  * new interface added, is NO GUARANTEE that the interface being
281  * added now, even though it may have the same sw_if_index, is the
282  * same interface that the path needs. So tough!
283  * If the control plane wants these routes to resolve it needs to
284  * remove and add them again.
285  */
286  return (NULL);
287  }
288 
289  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
290  {
291  if (sw_if_index >= vec_len(adj_mcasts[proto]) ||
292  ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
293  continue;
294 
295  adj = adj_get(adj_mcasts[proto][sw_if_index]);
296 
297  fib_node_back_walk_ctx_t bw_ctx = {
299  };
300 
302  }
303 
304  return (NULL);
305 }
306 
308 
309 /**
310  * @brief Walk the multicast Adjacencies on a given interface
311  */
312 void
314  fib_protocol_t proto,
315  adj_walk_cb_t cb,
316  void *ctx)
317 {
318  if (vec_len(adj_mcasts[proto]) > sw_if_index)
319  {
320  if (ADJ_INDEX_INVALID != adj_mcasts[proto][sw_if_index])
321  {
322  cb(adj_mcasts[proto][sw_if_index], ctx);
323  }
324  }
325 }
326 
327 u8*
328 format_adj_mcast (u8* s, va_list *ap)
329 {
330  index_t index = va_arg(*ap, index_t);
331  CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
332  ip_adjacency_t * adj = adj_get(index);
333 
334  s = format(s, "%U-mcast: ",
336  if (adj->rewrite_header.flags & VNET_REWRITE_HAS_FEATURES)
337  s = format(s, "[features] ");
338  s = format (s, "%U",
340  &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
341 
342  return (s);
343 }
344 
345 u8*
346 format_adj_mcast_midchain (u8* s, va_list *ap)
347 {
348  index_t index = va_arg(*ap, index_t);
349  CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
350  ip_adjacency_t * adj = adj_get(index);
351 
352  s = format(s, "%U-mcast-midchain: ",
354  s = format (s, "%U",
356  &adj->rewrite_header,
357  sizeof (adj->rewrite_data), 0);
358  s = format (s, "\n%Ustacked-on:\n%U%U",
359  format_white_space, indent,
360  format_white_space, indent+2,
361  format_dpo_id, &adj->sub_type.midchain.next_dpo, indent+2);
362 
363  return (s);
364 }
365 
366 
367 static void
369 {
370  adj_lock(dpo->dpoi_index);
371 }
372 static void
374 {
375  adj_unlock(dpo->dpoi_index);
376 }
377 
378 const static dpo_vft_t adj_mcast_dpo_vft = {
380  .dv_unlock = adj_dpo_unlock,
381  .dv_format = format_adj_mcast,
382  .dv_get_urpf = adj_dpo_get_urpf,
383 };
384 const static dpo_vft_t adj_mcast_midchain_dpo_vft = {
386  .dv_unlock = adj_dpo_unlock,
387  .dv_format = format_adj_mcast_midchain,
388  .dv_get_urpf = adj_dpo_get_urpf,
389 };
390 
391 /**
392  * @brief The per-protocol VLIB graph nodes that are assigned to a mcast
393  * object.
394  *
395  * this means that these graph nodes are ones from which a mcast is the
396  * parent object in the DPO-graph.
397  */
398 const static char* const adj_mcast_ip4_nodes[] =
399 {
400  "ip4-rewrite-mcast",
401  NULL,
402 };
403 const static char* const adj_mcast_ip6_nodes[] =
404 {
405  "ip6-rewrite-mcast",
406  NULL,
407 };
408 
409 const static char* const * const adj_mcast_nodes[DPO_PROTO_NUM] =
410 {
413  [DPO_PROTO_MPLS] = NULL,
414 };
415 
416 /**
417  * @brief The per-protocol VLIB graph nodes that are assigned to a mcast
418  * object.
419  *
420  * this means that these graph nodes are ones from which a mcast is the
421  * parent object in the DPO-graph.
422  */
423 const static char* const adj_mcast_midchain_ip4_nodes[] =
424 {
425  "ip4-mcast-midchain",
426  NULL,
427 };
428 const static char* const adj_mcast_midchain_ip6_nodes[] =
429 {
430  "ip6-mcast-midchain",
431  NULL,
432 };
433 
434 const static char* const * const adj_mcast_midchain_nodes[DPO_PROTO_NUM] =
435 {
438  [DPO_PROTO_MPLS] = NULL,
439 };
440 
441 /**
442  * @brief Return the size of the adj DB.
443  * This is only for testing purposes so an efficient implementation is not needed
444  */
445 u32
447 {
448  u32 n_adjs, sw_if_index;
449  fib_protocol_t proto;
450 
451  n_adjs = 0;
452  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
453  {
454  for (sw_if_index = 0;
455  sw_if_index < vec_len(adj_mcasts[proto]);
456  sw_if_index++)
457  {
458  if (ADJ_INDEX_INVALID != adj_mcasts[proto][sw_if_index])
459  {
460  n_adjs++;
461  }
462  }
463  }
464 
465  return (n_adjs);
466 }
467 
468 void
470 {
472  &adj_mcast_dpo_vft,
475  &adj_mcast_midchain_dpo_vft,
477 }
u32 sw_if_index
Definition: ipsec_gre.api:37
dpo_lock_fn_t dv_lock
A reference counting lock function.
Definition: dpo.h:404
u32 flags
Definition: vhost_user.h:115
#define CLIB_UNUSED(x)
Definition: clib.h:82
A virtual function table regisitered for a DPO type.
Definition: dpo.h:399
struct ip_adjacency_t_::@46::@48 midchain
IP_LOOKUP_NEXT_MIDCHAIN.
u8 * format_adj_mcast_midchain(u8 *s, va_list *ap)
Definition: adj_mcast.c:346
static const char *const adj_mcast_ip6_nodes[]
Definition: adj_mcast.c:403
void adj_lock(adj_index_t adj_index)
Take a reference counting lock on the adjacency.
Definition: adj.c:301
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
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:1021
#define NULL
Definition: clib.h:58
IP unicast adjacency.
Definition: adj.h:221
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
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
void adj_mcast_remove(fib_protocol_t proto, u32 sw_if_index)
Definition: adj_mcast.c:177
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:340
u32 adj_dpo_get_urpf(const dpo_id_t *dpo)
Definition: adj.c:291
unsigned char u8
Definition: types.h:56
static void adj_dpo_lock(dpo_id_t *dpo)
Definition: adj_mcast.c:368
u8 * format_fib_protocol(u8 *s, va_list *ap)
Definition: fib_types.c:32
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
vnet_link_t ia_link
link/ether-type 1 bytes
Definition: adj.h:242
vlib_node_registration_t ip4_rewrite_mcast_node
(constructor) VLIB_REGISTER_NODE (ip4_rewrite_mcast_node)
Definition: ip4_forward.c:2626
vlib_node_registration_t ip6_rewrite_mcast_node
(constructor) VLIB_REGISTER_NODE (ip6_rewrite_mcast_node)
Definition: ip6_forward.c:2127
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:433
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:423
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:321
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:113
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:313
static clib_error_t * adj_mcast_interface_delete(vnet_main_t *vnm, u32 sw_if_index, u32 is_add)
Definition: adj_mcast.c:261
void adj_unlock(adj_index_t adj_index)
Release a reference counting lock on the adjacency.
Definition: adj.c:318
void vnet_update_adjacency_for_sw_interface(vnet_main_t *vnm, u32 sw_if_index, u32 ai)
Definition: rewrite.c:205
unsigned int u32
Definition: types.h:88
format_function_t format_vnet_rewrite
Definition: rewrite.h:253
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:168
fib_node_bw_reason_flag_t fnbw_reason
The reason/trigger for the backwalk.
Definition: fib_node.h:208
void adj_mcast_update_rewrite(adj_index_t adj_index, u8 *rewrite, u8 offset)
adj_mcast_update_rewrite
Definition: adj_mcast.c:102
#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
long ctx[MAX_CONNS]
Definition: main.c:144
static adj_index_t adj_get_index(ip_adjacency_t *adj)
Get a pointer to an adjacency object from its index.
Definition: adj_internal.h:101
static const char *const *const adj_mcast_nodes[DPO_PROTO_NUM]
Definition: adj_mcast.c:409
static const char *const adj_mcast_midchain_ip6_nodes[]
Definition: adj_mcast.c:428
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:224
static clib_error_t * adj_mcast_interface_state_change(vnet_main_t *vnm, u32 sw_if_index, u32 flags)
Definition: adj_mcast.c:186
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:398
void adj_mcast_module_init(void)
Module initialisation.
Definition: adj_mcast.c:469
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
void(* adj_midchain_fixup_t)(vlib_main_t *vm, 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
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:237
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:328
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:136
static const char *const *const adj_mcast_midchain_nodes[DPO_PROTO_NUM]
Definition: adj_mcast.c:434
Context passed between object during a back walk.
Definition: fib_node.h:204
u32 adj_mcast_db_size(void)
Return the size of the adj DB.
Definition: adj_mcast.c:446
#define ASSERT(truth)
u8 is_add
Definition: ipsec_gre.api:36
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:147
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:249
#define DPO_PROTO_NUM
Definition: dpo.h:70
static void adj_dpo_unlock(dpo_id_t *dpo)
Definition: adj_mcast.c:373
index_t dpoi_index
the index of objects of that type
Definition: dpo.h:184
union ip_adjacency_t_::@46 sub_type
#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:236
u64 uword
Definition: types.h:112
ip_adjacency_t * adj_alloc(fib_protocol_t proto)
Definition: adj.c:63
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:454
#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:486
This adjacency/interface has output features configured.
Definition: rewrite.h:57
VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(adj_mcast_interface_state_change)