FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
ad.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 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  *------------------------------------------------------------------
17  * ad.c - SRv6 Dynamic Proxy (AD) function
18  *------------------------------------------------------------------
19  */
20 
21 #include <vnet/vnet.h>
22 #include <vnet/adj/adj.h>
23 #include <vnet/plugin/plugin.h>
24 #include <vpp/app/version.h>
25 #include <srv6-ad/ad.h>
26 
27 #define SID_CREATE_IFACE_FEATURE_ERROR -1
28 #define SID_CREATE_INVALID_IFACE_TYPE -3
29 #define SID_CREATE_INVALID_IFACE_INDEX -4
30 #define SID_CREATE_INVALID_ADJ_INDEX -5
31 
32 unsigned char function_name[] = "SRv6-AD-plugin";
33 unsigned char keyword_str[] = "End.AD";
34 unsigned char def_str[] =
35  "Endpoint with dynamic proxy to SR-unaware appliance";
36 unsigned char params_str[] = "nh <next-hop> oif <iface-out> iif <iface-in>";
37 
39 
40 /*****************************************/
41 /* SRv6 LocalSID instantiation and removal functions */
42 static int
44 {
45  ip6_sr_main_t *srm = &sr_main;
47  srv6_ad_localsid_t *ls_mem = localsid->plugin_mem;
48  u32 localsid_index = localsid - srm->localsids;
49 
50  /* Step 1: Prepare xconnect adjacency for sending packets to the VNF */
51 
52  /* Retrieve the adjacency corresponding to the (OIF, next_hop) */
53  adj_index_t nh_adj_index = ADJ_INDEX_INVALID;
54  if (ls_mem->inner_type != AD_TYPE_L2)
55  {
56  if (ls_mem->inner_type == AD_TYPE_IP4)
57  nh_adj_index = adj_nbr_add_or_lock (FIB_PROTOCOL_IP4,
58  VNET_LINK_IP4, &ls_mem->nh_addr,
59  ls_mem->sw_if_index_out);
60  else if (ls_mem->inner_type == AD_TYPE_IP6)
61  nh_adj_index = adj_nbr_add_or_lock (FIB_PROTOCOL_IP6,
62  VNET_LINK_IP6, &ls_mem->nh_addr,
63  ls_mem->sw_if_index_out);
64  if (nh_adj_index == ADJ_INDEX_INVALID)
65  {
66  clib_mem_free (ls_mem);
68  }
69  }
70 
71  ls_mem->nh_adj = nh_adj_index;
72 
73 
74  /* Step 2: Prepare inbound policy for packets returning from the VNF */
75 
76  /* Sanitise the SW_IF_INDEX */
78  ls_mem->sw_if_index_in))
79  {
80  adj_unlock (ls_mem->nh_adj);
81  clib_mem_free (ls_mem);
83  }
84 
86  ls_mem->sw_if_index_in);
88  {
89  adj_unlock (ls_mem->nh_adj);
90  clib_mem_free (ls_mem);
92  }
93 
94  if (ls_mem->inner_type == AD_TYPE_L2)
95  {
96  /* Enable End.AD2 rewrite node for this interface */
97  int ret =
98  vnet_feature_enable_disable ("device-input", "srv6-ad2-rewrite",
99  ls_mem->sw_if_index_in, 1, 0, 0);
100  if (ret != 0)
101  {
102  clib_mem_free (ls_mem);
104  }
105 
106  /* Set interface in promiscuous mode */
107  vnet_main_t *vnm = vnet_get_main ();
108  ethernet_set_flags (vnm, ls_mem->sw_if_index_in,
110 
111  /* Associate local SID index to this interface (resize vector if needed) */
112  if (ls_mem->sw_if_index_in >= vec_len (sm->sw_iface_localsid2))
113  {
116  - vec_len (sm->sw_iface_localsid2)));
117  }
118  sm->sw_iface_localsid2[ls_mem->sw_if_index_in] = localsid_index;
119  }
120  else if (ls_mem->inner_type == AD_TYPE_IP4)
121  {
122  /* Enable End.AD4 rewrite node for this interface */
123  int ret =
124  vnet_feature_enable_disable ("ip4-unicast", "srv6-ad4-rewrite",
125  ls_mem->sw_if_index_in, 1, 0, 0);
126  if (ret != 0)
127  {
128  adj_unlock (ls_mem->nh_adj);
129  clib_mem_free (ls_mem);
131  }
132 
133  /* Associate local SID index to this interface (resize vector if needed) */
134  if (ls_mem->sw_if_index_in >= vec_len (sm->sw_iface_localsid4))
135  {
138  - vec_len (sm->sw_iface_localsid4)));
139  }
140  sm->sw_iface_localsid4[ls_mem->sw_if_index_in] = localsid_index;
141  }
142  else if (ls_mem->inner_type == AD_TYPE_IP6)
143  {
144  /* Enable End.AD6 rewrite node for this interface */
145  int ret =
146  vnet_feature_enable_disable ("ip6-unicast", "srv6-ad6-rewrite",
147  ls_mem->sw_if_index_in, 1, 0, 0);
148  if (ret != 0)
149  {
150  adj_unlock (ls_mem->nh_adj);
151  clib_mem_free (ls_mem);
153  }
154 
155  /* Associate local SID index to this interface (resize vector if needed) */
156  if (ls_mem->sw_if_index_in >= vec_len (sm->sw_iface_localsid6))
157  {
160  - vec_len (sm->sw_iface_localsid6)));
161  }
162  sm->sw_iface_localsid6[ls_mem->sw_if_index_in] = localsid_index;
163  }
164 
165  ls_mem->rw_len = 0;
166 
167  /* Step 3: Initialize rewrite counters */
168  srv6_ad_localsid_t **ls_p;
169  pool_get (sm->sids, ls_p);
170  *ls_p = ls_mem;
171  ls_mem->index = ls_p - sm->sids;
172 
175 
178 
179  return 0;
180 }
181 
182 static int
184 {
186  srv6_ad_localsid_t *ls_mem = localsid->plugin_mem;
187 
188  if (ls_mem->inner_type == AD_TYPE_L2)
189  {
190  /* Disable End.AD2 rewrite node for this interface */
191  int ret =
192  vnet_feature_enable_disable ("device-input", "srv6-ad2-rewrite",
193  ls_mem->sw_if_index_in, 0, 0, 0);
194  if (ret != 0)
195  return -1;
196 
197  /* Disable promiscuous mode on the interface */
198  vnet_main_t *vnm = vnet_get_main ();
199  ethernet_set_flags (vnm, ls_mem->sw_if_index_in, 0);
200 
201  /* Remove local SID index from interface table */
202  sm->sw_iface_localsid2[ls_mem->sw_if_index_in] = ~(u32) 0;
203  }
204  else if (ls_mem->inner_type == AD_TYPE_IP4)
205  {
206  /* Disable End.AD4 rewrite node for this interface */
207  int ret =
208  vnet_feature_enable_disable ("ip4-unicast", "srv6-ad4-rewrite",
209  ls_mem->sw_if_index_in, 0, 0, 0);
210  if (ret != 0)
211  return -1;
212 
213  /* Remove local SID pointer from interface table */
214  sm->sw_iface_localsid4[ls_mem->sw_if_index_in] = ~(u32) 0;
215  }
216  else if (ls_mem->inner_type == AD_TYPE_IP6)
217  {
218  /* Disable End.AD6 rewrite node for this interface */
219  int ret =
220  vnet_feature_enable_disable ("ip6-unicast", "srv6-ad6-rewrite",
221  ls_mem->sw_if_index_in, 0, 0, 0);
222  if (ret != 0)
223  return -1;
224 
225  /* Remove local SID pointer from interface table */
226  sm->sw_iface_localsid6[ls_mem->sw_if_index_in] = ~(u32) 0;
227  }
228 
229 
230  /* Unlock (OIF, NHOP) adjacency */
231  adj_unlock (ls_mem->nh_adj);
232 
233  /* Delete SID entry */
234  pool_put (sm->sids, pool_elt_at_index (sm->sids, ls_mem->index));
235 
236  /* Clean up local SID memory */
237  vec_free (ls_mem->rewrite);
238  clib_mem_free (localsid->plugin_mem);
239 
240  return 0;
241 }
242 
243 /**********************************/
244 /* SRv6 LocalSID format functions */
245 /*
246  * Prints nicely the parameters of a localsid
247  * Example: print "Table 5"
248  */
249 u8 *
250 format_srv6_ad_localsid (u8 * s, va_list * args)
251 {
252  srv6_ad_localsid_t *ls_mem = va_arg (*args, void *);
253 
254  vnet_main_t *vnm = vnet_get_main ();
256 
257  if (ls_mem->inner_type == AD_TYPE_IP4)
258  {
259  s =
260  format (s, "Next-hop:\t%U\n\t", format_ip4_address,
261  &ls_mem->nh_addr.ip4);
262  }
263  else if (ls_mem->inner_type == AD_TYPE_IP6)
264  {
265  s =
266  format (s, "Next-hop:\t%U\n\t", format_ip6_address,
267  &ls_mem->nh_addr.ip6);
268  }
269 
270  s = format (s, "Outgoing iface:\t%U\n", format_vnet_sw_if_index_name, vnm,
271  ls_mem->sw_if_index_out);
272  s = format (s, "\tIncoming iface:\t%U\n", format_vnet_sw_if_index_name, vnm,
273  ls_mem->sw_if_index_in);
274 
275  vlib_counter_t valid, invalid;
276  vlib_get_combined_counter (&(sm->valid_counters), ls_mem->index, &valid);
278  &invalid);
279  s = format (s, "\tGood rewrite traffic: \t[%Ld packets : %Ld bytes]\n",
280  valid.packets, valid.bytes);
281  s = format (s, "\tBad rewrite traffic: \t[%Ld packets : %Ld bytes]\n",
282  invalid.packets, invalid.bytes);
283 
284  return s;
285 }
286 
287 /*
288  * Process the parameters of a localsid
289  * Example: process from:
290  * sr localsid address cafe::1 behavior new_srv6_localsid 5
291  * everything from behavior on... so in this case 'new_srv6_localsid 5'
292  * Notice that it MUST match the keyword_str and params_str defined above.
293  */
294 uword
296 {
297  void **plugin_mem_p = va_arg (*args, void **);
298  srv6_ad_localsid_t *ls_mem;
299 
300  vnet_main_t *vnm = vnet_get_main ();
301 
302  u8 inner_type = AD_TYPE_L2;
303  ip46_address_t nh_addr;
304  u32 sw_if_index_out;
305  u32 sw_if_index_in;
306 
307  u8 params = 0;
308 #define PARAM_AD_NH (1 << 0)
309 #define PARAM_AD_OIF (1 << 1)
310 #define PARAM_AD_IIF (1 << 2)
311 
312  if (!unformat (input, "end.ad"))
313  return 0;
314 
316  {
317  if (!(params & PARAM_AD_NH) && unformat (input, "nh %U",
319  &nh_addr.ip4))
320  {
321  inner_type = AD_TYPE_IP4;
322  params |= PARAM_AD_NH;
323  }
324  if (!(params & PARAM_AD_NH) && unformat (input, "nh %U",
326  &nh_addr.ip6))
327  {
328  inner_type = AD_TYPE_IP6;
329  params |= PARAM_AD_NH;
330  }
331  else if (!(params & PARAM_AD_OIF) && unformat (input, "oif %U",
333  vnm, &sw_if_index_out))
334  {
335  params |= PARAM_AD_OIF;
336  }
337  else if (!(params & PARAM_AD_IIF) && unformat (input, "iif %U",
339  vnm, &sw_if_index_in))
340  {
341  params |= PARAM_AD_IIF;
342  }
343  else
344  {
345  break;
346  }
347  }
348 
349  /* Make sure that all parameters are supplied */
350  u8 params_chk = (PARAM_AD_OIF | PARAM_AD_IIF);
351  if ((params & params_chk) != params_chk)
352  {
353  return 0;
354  }
355 
356  /* Allocate and initialize memory block for local SID parameters */
357  ls_mem = clib_mem_alloc_aligned_at_offset (sizeof *ls_mem, 0, 0, 1);
358  clib_memset (ls_mem, 0, sizeof *ls_mem);
359  *plugin_mem_p = ls_mem;
360 
361  /* Set local SID parameters */
362  ls_mem->inner_type = inner_type;
363  if (inner_type == AD_TYPE_IP4)
364  ls_mem->nh_addr.ip4 = nh_addr.ip4;
365  else if (inner_type == AD_TYPE_IP6)
366  ls_mem->nh_addr.ip6 = nh_addr.ip6;
367  ls_mem->sw_if_index_out = sw_if_index_out;
368  ls_mem->sw_if_index_in = sw_if_index_in;
369 
370  return 1;
371 }
372 
373 /*************************/
374 /* SRv6 LocalSID FIB DPO */
375 static u8 *
376 format_srv6_ad_dpo (u8 * s, va_list * args)
377 {
378  index_t index = va_arg (*args, index_t);
379  CLIB_UNUSED (u32 indent) = va_arg (*args, u32);
380 
381  return (format (s, "SR: dynamic_proxy_index:[%u]", index));
382 }
383 
384 void
386 {
387 }
388 
389 void
391 {
392 }
393 
394 const static dpo_vft_t srv6_ad_vft = {
396  .dv_unlock = srv6_ad_dpo_unlock,
397  .dv_format = format_srv6_ad_dpo,
398 };
399 
400 const static char *const srv6_ad_ip6_nodes[] = {
401  "srv6-ad-localsid",
402  NULL,
403 };
404 
405 const static char *const *const srv6_ad_nodes[DPO_PROTO_NUM] = {
407 };
408 
409 /**********************/
410 static clib_error_t *
412 {
414  int rv = 0;
415 
416  sm->vlib_main = vm;
417  sm->vnet_main = vnet_get_main ();
418 
419  /* Create DPO */
421 
422  /* Register SRv6 LocalSID */
425  keyword_str,
426  def_str,
427  params_str,
428  128,
429  &sm->srv6_ad_dpo_type,
434  if (rv < 0)
435  clib_error_return (0, "SRv6 LocalSID function could not be registered.");
436  else
437  sm->srv6_localsid_behavior_id = rv;
438 
439  return 0;
440 }
441 
442 /* *INDENT-OFF* */
443 VNET_FEATURE_INIT (srv6_ad2_rewrite, static) =
444 {
445  .arc_name = "device-input",
446  .node_name = "srv6-ad2-rewrite",
447  .runs_before = VNET_FEATURES ("ethernet-input"),
448 };
449 
450 VNET_FEATURE_INIT (srv6_ad4_rewrite, static) =
451 {
452  .arc_name = "ip4-unicast",
453  .node_name = "srv6-ad4-rewrite",
454  .runs_before = 0,
455 };
456 
457 VNET_FEATURE_INIT (srv6_ad6_rewrite, static) =
458 {
459  .arc_name = "ip6-unicast",
460  .node_name = "srv6-ad6-rewrite",
461  .runs_before = 0,
462 };
463 
465 
467  .version = VPP_BUILD_VER,
468  .description = "Dynamic Segment Routing for IPv6 (SRv6) Proxy",
469 };
470 /* *INDENT-ON* */
471 
472 /*
473 * fd.io coding-style-patch-verification: ON
474 *
475 * Local Variables:
476 * eval: (c-set-style "gnu")
477 * End:
478 */
ip6_sr_main_t sr_main
Definition: sr.c:31
dpo_lock_fn_t dv_lock
A reference counting lock function.
Definition: dpo.h:406
vnet_main_t * vnet_main
[convenience] vnet main
Definition: ad.h:53
#define CLIB_UNUSED(x)
Definition: clib.h:82
A virtual function table regisitered for a DPO type.
Definition: dpo.h:401
void vlib_validate_combined_counter(vlib_combined_counter_main_t *cm, u32 index)
validate a combined counter
Definition: counter.c:94
static void * clib_mem_alloc_aligned_at_offset(uword size, uword align, uword align_offset, int os_out_of_memory_on_failure)
Definition: mem.h:113
SR LocalSID.
Definition: sr.h:118
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
vnet_interface_main_t interface_main
Definition: vnet.h:56
#define NULL
Definition: clib.h:58
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
u32 * sw_iface_localsid4
Retrieve local SID from iface.
Definition: ad.h:60
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
Combined counter to hold both packets and byte differences.
Definition: counter_types.h:26
static vnet_sw_interface_t * vnet_get_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
unformat_function_t unformat_vnet_sw_interface
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:237
format_function_t format_vnet_sw_if_index_name
int sr_localsid_register_function(vlib_main_t *vm, u8 *fn_name, u8 *keyword_str, u8 *def_str, u8 *params_str, u8 prefix_length, dpo_type_t *dpo, format_function_t *ls_format, unformat_function_t *ls_unformat, sr_plugin_callback_t *creation_fn, sr_plugin_callback_t *removal_fn)
SR LocalSID plugin registry.
Definition: sr_localsid.c:1564
unsigned char u8
Definition: types.h:56
#define pool_len(p)
Number of elements in pool vector.
Definition: pool.h:140
format_function_t format_ip4_address
Definition: format.h:73
u32 srv6_localsid_behavior_id
SRv6 LocalSID behavior number.
Definition: ad.h:57
unformat_function_t unformat_ip4_address
Definition: format.h:68
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
vlib_combined_counter_main_t invalid_counters
Invalid rewrite counters.
Definition: ad.h:66
#define AD_TYPE_IP4
Definition: ad.h:27
#define clib_error_return(e, args...)
Definition: error.h:99
void adj_unlock(adj_index_t adj_index)
Release a reference counting lock on the adjacency.
Definition: adj.c:324
#define vec_resize(V, N)
Resize a vector (no header, unspecified alignment) Add N elements to end of given vector V...
Definition: vec.h:243
unsigned int u32
Definition: types.h:88
u8 inner_type
Definition: ad.h:39
dpo_type_t dpo_register_new_type(const dpo_vft_t *vft, const char *const *const *nodes)
Create and register a new DPO type.
Definition: dpo.c:342
u32 nh_adj
Adjacency index for out.
Definition: ad.h:38
ip46_address_t nh_addr
Proxied device address.
Definition: ad.h:36
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
#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
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:519
static void vlib_zero_combined_counter(vlib_combined_counter_main_t *cm, u32 index)
Clear a combined counter Clears the set of per-thread counters.
Definition: counter.h:285
counter_t packets
packet counter
Definition: counter_types.h:28
u32 sw_if_index_out
Outgoing iface to proxied dev.
Definition: ad.h:37
struct _unformat_input_t unformat_input_t
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:287
u32 rw_len
Number of bits to be rewritten.
Definition: ad.h:42
vlib_main_t * vlib_main
[convenience] vlib main
Definition: ad.h:52
u8 * rewrite
Headers to be rewritten.
Definition: ad.h:43
vlib_main_t * vm
Definition: in2out_ed.c:1810
srv6_ad_localsid_t ** sids
Pool of AD SID pointers.
Definition: ad.h:63
unformat_function_t unformat_ip6_address
Definition: format.h:89
ip6_sr_localsid_t * localsids
Definition: sr.h:252
#define UNFORMAT_END_OF_INPUT
Definition: format.h:145
format_function_t format_ip6_address
Definition: format.h:91
static void vlib_get_combined_counter(const vlib_combined_counter_main_t *cm, u32 index, vlib_counter_t *result)
Get the value of a combined counter, never called in the speed path Scrapes the entire set of per-thr...
Definition: counter.h:259
#define AD_TYPE_IP6
Definition: ad.h:28
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:342
#define ETHERNET_INTERFACE_FLAG_ACCEPT_ALL
Definition: ethernet.h:141
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:284
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
void * plugin_mem
Memory to be used by the plugin callback functions.
Definition: sr.h:142
static void clib_mem_free(void *p)
Definition: mem.h:226
u8 nh_addr[16]
Definition: lisp_gpe.api:233
dpo_type_t srv6_ad_dpo_type
DPO type.
Definition: ad.h:55
#define VNET_FEATURES(...)
Definition: feature.h:442
u32 * sw_iface_localsid2
Retrieve local SID from iface.
Definition: ad.h:59
counter_t bytes
byte counter
Definition: counter_types.h:29
vlib_combined_counter_main_t valid_counters
Valid rewrite counters.
Definition: ad.h:65
#define DPO_PROTO_NUM
Definition: dpo.h:70
u32 * sw_iface_localsid6
Retrieve local SID from iface.
Definition: ad.h:61
u32 sw_if_index_in
Incoming iface from proxied dev.
Definition: ad.h:41
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u64 uword
Definition: types.h:112
vnet_sw_interface_t * sw_interfaces
Definition: interface.h:854
Segment Routing main datastructure.
Definition: sr.h:237
vnet_sw_interface_type_t type
Definition: interface.h:718
adj_index_t adj_nbr_add_or_lock(fib_protocol_t nh_proto, vnet_link_t link_type, const ip46_address_t *nh_addr, u32 sw_if_index)
Neighbour Adjacency sub-type.
Definition: adj_nbr.c:218
#define AD_TYPE_L2
Definition: ad.h:26
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
int vnet_feature_enable_disable(const char *arc_name, const char *node_name, u32 sw_if_index, int enable_disable, void *feature_config, u32 n_feature_config_bytes)
Definition: feature.c:304
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:171
u32 ethernet_set_flags(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: interface.c:426