FD.io VPP  v18.01.2-1-g9b554f3
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,
53  u32 sw_if_index)
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,
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  * rewirte is reset (i.e. when ARP/ND etnry 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  u32 mask)
106 {
107  ip_adjacency_t *adj;
108 
109  ASSERT(ADJ_INDEX_INVALID != adj_index);
110 
111  adj = adj_get(adj_index);
112 
113  /*
114  * update the adj's rewrite string and build the arc
115  * from the rewrite node to the interface's TX node
116  */
120  vnet_get_main(),
121  adj->rewrite_header.sw_if_index),
122  rewrite);
123  /*
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.
127  */
128  adj->rewrite_header.dst_mcast_offset = offset;
129  adj->rewrite_header.dst_mcast_mask = clib_host_to_net_u32(mask);
130 }
131 
132 /**
133  * adj_mcast_midchain_update_rewrite
134  *
135  * Update the adjacency's rewrite string. A NULL string implies the
136  * rewirte is reset (i.e. when ARP/ND etnry is gone).
137  * NB: the adj being updated may be handling traffic in the DP.
138  */
139 void
141  adj_midchain_fixup_t fixup,
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 chainging 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, 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  /*
177  * set the fields corresponding to the mcast IP address rewrite
178  * The mask must be stored in network byte order, since the packet's
179  * IP address will also be in network order.
180  */
181  adj->rewrite_header.dst_mcast_offset = offset;
182  adj->rewrite_header.dst_mcast_mask = clib_host_to_net_u32(mask);
183 }
184 
185 void
187  u32 sw_if_index)
188 {
189  ASSERT(sw_if_index < vec_len(adj_mcasts[proto]));
190 
191  adj_mcasts[proto][sw_if_index] = ADJ_INDEX_INVALID;
192 }
193 
194 static clib_error_t *
196  u32 sw_if_index,
197  u32 flags)
198 {
199  /*
200  * for each mcast on the interface trigger a walk back to the children
201  */
202  fib_protocol_t proto;
203  ip_adjacency_t *adj;
204 
205 
206  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
207  {
208  if (sw_if_index >= vec_len(adj_mcasts[proto]) ||
209  ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
210  continue;
211 
212  adj = adj_get(adj_mcasts[proto][sw_if_index]);
213 
214  fib_node_back_walk_ctx_t bw_ctx = {
218  };
219 
221  }
222 
223  return (NULL);
224 }
225 
227 
228 /**
229  * @brief Invoked on each SW interface of a HW interface when the
230  * HW interface state changes
231  */
232 static void
234  u32 sw_if_index,
235  void *arg)
236 {
237  adj_mcast_interface_state_change(vnm, sw_if_index, (uword) arg);
238 }
239 
240 /**
241  * @brief Registered callback for HW interface state changes
242  */
243 static clib_error_t *
245  u32 hw_if_index,
246  u32 flags)
247 {
248  /*
249  * walk SW interfaces on the HW
250  */
251  uword sw_flags;
252 
253  sw_flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
255  0);
256 
257  vnet_hw_interface_walk_sw(vnm, hw_if_index,
259  (void*) sw_flags);
260 
261  return (NULL);
262 }
263 
266 
267 static clib_error_t *
269  u32 sw_if_index,
270  u32 is_add)
271 {
272  /*
273  * for each mcast on the interface trigger a walk back to the children
274  */
275  fib_protocol_t proto;
276  ip_adjacency_t *adj;
277 
278  if (is_add)
279  {
280  /*
281  * not interested in interface additions. we will not back walk
282  * to resolve paths through newly added interfaces. Why? The control
283  * plane should have the brains to add interfaces first, then routes.
284  * So the case where there are paths with a interface that matches
285  * one just created is the case where the path resolved through an
286  * interface that was deleted, and still has not been removed. The
287  * new interface added, is NO GUARANTEE that the interface being
288  * added now, even though it may have the same sw_if_index, is the
289  * same interface that the path needs. So tough!
290  * If the control plane wants these routes to resolve it needs to
291  * remove and add them again.
292  */
293  return (NULL);
294  }
295 
296  for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
297  {
298  if (sw_if_index >= vec_len(adj_mcasts[proto]) ||
299  ADJ_INDEX_INVALID == adj_mcasts[proto][sw_if_index])
300  continue;
301 
302  adj = adj_get(adj_mcasts[proto][sw_if_index]);
303 
304  fib_node_back_walk_ctx_t bw_ctx = {
306  };
307 
309  }
310 
311  return (NULL);
312 }
313 
315 
316 /**
317  * @brief Walk the multicast Adjacencies on a given interface
318  */
319 void
320 adj_mcast_walk (u32 sw_if_index,
321  fib_protocol_t proto,
322  adj_walk_cb_t cb,
323  void *ctx)
324 {
325  if (vec_len(adj_mcasts[proto]) > sw_if_index)
326  {
327  if (ADJ_INDEX_INVALID != adj_mcasts[proto][sw_if_index])
328  {
329  cb(adj_mcasts[proto][sw_if_index], ctx);
330  }
331  }
332 }
333 
334 u8*
335 format_adj_mcast (u8* s, va_list *ap)
336 {
337  index_t index = va_arg(*ap, index_t);
338  CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
339  ip_adjacency_t * adj = adj_get(index);
340 
341  s = format(s, "%U-mcast: ",
343  if (adj->rewrite_header.flags & VNET_REWRITE_HAS_FEATURES)
344  s = format(s, "[features] ");
345  s = format (s, "%U",
347  &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
348 
349  return (s);
350 }
351 
352 u8*
353 format_adj_mcast_midchain (u8* s, va_list *ap)
354 {
355  index_t index = va_arg(*ap, index_t);
356  CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
357  vnet_main_t * vnm = vnet_get_main();
358  ip_adjacency_t * adj = adj_get(index);
359 
360  s = format(s, "%U-mcast-midchain: ",
362  s = format (s, "%U",
364  vnm->vlib_main, &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;
457  fib_protocol_t proto;
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:382
void vnet_rewrite_init(vnet_main_t *vnm, u32 sw_if_index, u32 this_node, u32 next_node, vnet_rewrite_header_t *rw)
Definition: rewrite.c:103
#define CLIB_UNUSED(x)
Definition: clib.h:79
A virtual function table regisitered for a DPO type.
Definition: dpo.h:377
u8 * format_adj_mcast_midchain(u8 *s, va_list *ap)
Definition: adj_mcast.c:353
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:222
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:967
#define NULL
Definition: clib.h:55
IP unicast adjacency.
Definition: adj.h:174
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:419
#define VNET_HW_INTERFACE_FLAG_LINK_UP
Definition: interface.h:394
void adj_mcast_remove(fib_protocol_t proto, u32 sw_if_index)
Definition: adj_mcast.c:186
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:333
u32 adj_dpo_get_urpf(const dpo_id_t *dpo)
Definition: adj.c:212
struct ip_adjacency_t_::@38::@40 midchain
IP_LOOKUP_NEXT_MIDCHAIN.
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:30
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
vnet_link_t ia_link
link/ether-type 1 bytes
Definition: adj.h:195
vlib_node_registration_t ip4_rewrite_mcast_node
(constructor) VLIB_REGISTER_NODE (ip4_rewrite_mcast_node)
Definition: ip4_forward.c:2790
vlib_node_registration_t ip6_rewrite_mcast_node
(constructor) VLIB_REGISTER_NODE (ip6_rewrite_mcast_node)
Definition: ip6_forward.c:2444
static ip_adjacency_t * adj_get(adj_index_t adj_index)
Get a pointer to an adjacency object from its index.
Definition: adj.h:365
enum ip_adjacency_flags_t_ adj_flags_t
Flags on an IP adjacency.
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:306
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:727
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:320
static clib_error_t * adj_mcast_interface_delete(vnet_main_t *vnm, u32 sw_if_index, u32 is_add)
Definition: adj_mcast.c:268
void adj_unlock(adj_index_t adj_index)
Release a reference counting lock on the adjacency.
Definition: adj.c:239
void vnet_update_adjacency_for_sw_interface(vnet_main_t *vnm, u32 sw_if_index, u32 ai)
Definition: rewrite.c:217
format_function_t format_vnet_rewrite
Definition: rewrite.h:338
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:166
fib_node_bw_reason_flag_t fnbw_reason
The reason/trigger for the backwalk.
Definition: fib_node.h:203
#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
vlib_main_t * vlib_main
Definition: vnet.h:78
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:86
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
union ip_adjacency_t_::@38 sub_type
VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(adj_mcast_hw_interface_state_change)
static clib_error_t * adj_mcast_interface_state_change(vnet_main_t *vnm, u32 sw_if_index, u32 flags)
Definition: adj_mcast.c:195
Multicast Midchain Adjacency.
Definition: adj.h:86
u32 vnet_tx_node_index_for_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
Definition: rewrite.c:96
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:244
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:335
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:199
u32 adj_mcast_db_size(void)
Return the size of the adj DB.
Definition: adj_mcast.c:454
#define VNET_SW_INTERFACE_FLAG_ADMIN_UP
Definition: interface.h:576
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
long ctx[MAX_CONNS]
Definition: main.c:122
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.
void adj_mcast_update_rewrite(adj_index_t adj_index, u8 *rewrite, u8 offset, u32 mask)
adj_mcast_update_rewrite
Definition: adj_mcast.c:102
static void 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:233
u8 * format_dpo_id(u8 *s, va_list *args)
Format a DPO_id_t oject
Definition: dpo.c:146
u64 uword
Definition: types.h:112
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:202
#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:182
void(* adj_midchain_fixup_t)(vlib_main_t *vm, struct ip_adjacency_t_ *adj, vlib_buffer_t *b0)
A function type for post-rewrite fixups on midchain adjacency.
Definition: adj.h:142
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
unsigned char u8
Definition: types.h:56
ip_lookup_next_t lookup_next_index
Next hop after ip4-lookup.
Definition: adj.h:189
ip_adjacency_t * adj_alloc(fib_protocol_t proto)
Definition: adj.c:48
static adj_index_t * adj_mcasts[FIB_PROTOCOL_MAX]
Definition: adj_mcast.c:26
#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:51
struct clib_bihash_value offset
template key/value backing page structure
void adj_midchain_setup(adj_index_t adj_index, adj_midchain_fixup_t fixup, adj_flags_t flags)
adj_midchain_setup
Definition: adj_midchain.c:461
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
void adj_mcast_midchain_update_rewrite(adj_index_t adj_index, adj_midchain_fixup_t fixup, adj_flags_t flags, u8 *rewrite, u8 offset, u32 mask)
adj_mcast_midchain_update_rewrite
Definition: adj_mcast.c:140
u32 flags
Definition: vhost-user.h:77
#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:481
This adjacency/interface has output features configured.
Definition: rewrite.h:57
VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(adj_mcast_interface_state_change)