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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 *------------------------------------------------------------------
17 * ad.c - SRv6 Dynamic Proxy (AD) function
18 *------------------------------------------------------------------
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>
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
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>";
38 srv6_ad_main_t srv6_ad_main;
40 /*****************************************/
41 /* SRv6 LocalSID instantiation and removal functions */
43 srv6_ad_localsid_creation_fn (ip6_sr_localsid_t * localsid)
45 ip6_sr_main_t *srm = &sr_main;
46 srv6_ad_main_t *sm = &srv6_ad_main;
47 srv6_ad_localsid_t *ls_mem = localsid->plugin_mem;
48 u32 localsid_index = localsid - srm->localsids;
50 /* Step 1: Prepare xconnect adjacency for sending packets to the VNF */
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)
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)
66 clib_mem_free (ls_mem);
67 return SID_CREATE_INVALID_ADJ_INDEX;
71 ls_mem->nh_adj = nh_adj_index;
74 /* Step 2: Prepare inbound policy for packets returning from the VNF */
76 /* Sanitise the SW_IF_INDEX */
77 if (pool_is_free_index (sm->vnet_main->interface_main.sw_interfaces,
78 ls_mem->sw_if_index_in))
80 adj_unlock (ls_mem->nh_adj);
81 clib_mem_free (ls_mem);
82 return SID_CREATE_INVALID_IFACE_INDEX;
85 vnet_sw_interface_t *sw = vnet_get_sw_interface (sm->vnet_main,
86 ls_mem->sw_if_index_in);
87 if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
89 adj_unlock (ls_mem->nh_adj);
90 clib_mem_free (ls_mem);
91 return SID_CREATE_INVALID_IFACE_TYPE;
94 if (ls_mem->inner_type == AD_TYPE_L2)
96 /* Enable End.AD2 rewrite node for this interface */
98 vnet_feature_enable_disable ("device-input", "srv6-ad2-rewrite",
99 ls_mem->sw_if_index_in, 1, 0, 0);
102 clib_mem_free (ls_mem);
103 return SID_CREATE_IFACE_FEATURE_ERROR;
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,
109 ETHERNET_INTERFACE_FLAG_ACCEPT_ALL);
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))
114 vec_resize (sm->sw_iface_localsid2,
115 (pool_len (sm->vnet_main->interface_main.sw_interfaces)
116 - vec_len (sm->sw_iface_localsid2)));
118 sm->sw_iface_localsid2[ls_mem->sw_if_index_in] = localsid_index;
120 else if (ls_mem->inner_type == AD_TYPE_IP4)
122 /* Enable End.AD4 rewrite node for this interface */
124 vnet_feature_enable_disable ("ip4-unicast", "srv6-ad4-rewrite",
125 ls_mem->sw_if_index_in, 1, 0, 0);
128 adj_unlock (ls_mem->nh_adj);
129 clib_mem_free (ls_mem);
130 return SID_CREATE_IFACE_FEATURE_ERROR;
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))
136 vec_resize (sm->sw_iface_localsid4,
137 (pool_len (sm->vnet_main->interface_main.sw_interfaces)
138 - vec_len (sm->sw_iface_localsid4)));
140 sm->sw_iface_localsid4[ls_mem->sw_if_index_in] = localsid_index;
142 else if (ls_mem->inner_type == AD_TYPE_IP6)
144 /* Enable End.AD6 rewrite node for this interface */
146 vnet_feature_enable_disable ("ip6-unicast", "srv6-ad6-rewrite",
147 ls_mem->sw_if_index_in, 1, 0, 0);
150 adj_unlock (ls_mem->nh_adj);
151 clib_mem_free (ls_mem);
152 return SID_CREATE_IFACE_FEATURE_ERROR;
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))
158 vec_resize (sm->sw_iface_localsid6,
159 (pool_len (sm->vnet_main->interface_main.sw_interfaces)
160 - vec_len (sm->sw_iface_localsid6)));
162 sm->sw_iface_localsid6[ls_mem->sw_if_index_in] = localsid_index;
167 /* Step 3: Initialize rewrite counters */
168 srv6_ad_localsid_t **ls_p;
169 pool_get (sm->sids, ls_p);
171 ls_mem->index = ls_p - sm->sids;
173 vlib_validate_combined_counter (&(sm->valid_counters), ls_mem->index);
174 vlib_validate_combined_counter (&(sm->invalid_counters), ls_mem->index);
176 vlib_zero_combined_counter (&(sm->valid_counters), ls_mem->index);
177 vlib_zero_combined_counter (&(sm->invalid_counters), ls_mem->index);
183 srv6_ad_localsid_removal_fn (ip6_sr_localsid_t * localsid)
185 srv6_ad_main_t *sm = &srv6_ad_main;
186 srv6_ad_localsid_t *ls_mem = localsid->plugin_mem;
188 if (ls_mem->inner_type == AD_TYPE_L2)
190 /* Disable End.AD2 rewrite node for this interface */
192 vnet_feature_enable_disable ("device-input", "srv6-ad2-rewrite",
193 ls_mem->sw_if_index_in, 0, 0, 0);
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);
201 /* Remove local SID index from interface table */
202 sm->sw_iface_localsid2[ls_mem->sw_if_index_in] = ~(u32) 0;
204 else if (ls_mem->inner_type == AD_TYPE_IP4)
206 /* Disable End.AD4 rewrite node for this interface */
208 vnet_feature_enable_disable ("ip4-unicast", "srv6-ad4-rewrite",
209 ls_mem->sw_if_index_in, 0, 0, 0);
213 /* Remove local SID pointer from interface table */
214 sm->sw_iface_localsid4[ls_mem->sw_if_index_in] = ~(u32) 0;
216 else if (ls_mem->inner_type == AD_TYPE_IP6)
218 /* Disable End.AD6 rewrite node for this interface */
220 vnet_feature_enable_disable ("ip6-unicast", "srv6-ad6-rewrite",
221 ls_mem->sw_if_index_in, 0, 0, 0);
225 /* Remove local SID pointer from interface table */
226 sm->sw_iface_localsid6[ls_mem->sw_if_index_in] = ~(u32) 0;
230 /* Unlock (OIF, NHOP) adjacency */
231 adj_unlock (ls_mem->nh_adj);
233 /* Delete SID entry */
234 pool_put (sm->sids, pool_elt_at_index (sm->sids, ls_mem->index));
236 /* Clean up local SID memory */
237 vec_free (ls_mem->rewrite);
238 clib_mem_free (localsid->plugin_mem);
243 /**********************************/
244 /* SRv6 LocalSID format functions */
246 * Prints nicely the parameters of a localsid
247 * Example: print "Table 5"
250 format_srv6_ad_localsid (u8 * s, va_list * args)
252 srv6_ad_localsid_t *ls_mem = va_arg (*args, void *);
254 vnet_main_t *vnm = vnet_get_main ();
255 srv6_ad_main_t *sm = &srv6_ad_main;
257 if (ls_mem->inner_type == AD_TYPE_IP4)
260 format (s, "Next-hop:\t%U\n\t", format_ip4_address,
261 &ls_mem->nh_addr.ip4);
263 else if (ls_mem->inner_type == AD_TYPE_IP6)
266 format (s, "Next-hop:\t%U\n\t", format_ip6_address,
267 &ls_mem->nh_addr.ip6);
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);
275 vlib_counter_t valid, invalid;
276 vlib_get_combined_counter (&(sm->valid_counters), ls_mem->index, &valid);
277 vlib_get_combined_counter (&(sm->invalid_counters), ls_mem->index,
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);
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.
295 unformat_srv6_ad_localsid (unformat_input_t * input, va_list * args)
297 void **plugin_mem_p = va_arg (*args, void **);
298 srv6_ad_localsid_t *ls_mem;
300 vnet_main_t *vnm = vnet_get_main ();
302 u8 inner_type = AD_TYPE_L2;
303 ip46_address_t nh_addr;
308 #define PARAM_AD_NH (1 << 0)
309 #define PARAM_AD_OIF (1 << 1)
310 #define PARAM_AD_IIF (1 << 2)
312 if (!unformat (input, "end.ad"))
315 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
317 if (!(params & PARAM_AD_NH) && unformat (input, "nh %U",
318 unformat_ip4_address,
321 inner_type = AD_TYPE_IP4;
322 params |= PARAM_AD_NH;
324 if (!(params & PARAM_AD_NH) && unformat (input, "nh %U",
325 unformat_ip6_address,
328 inner_type = AD_TYPE_IP6;
329 params |= PARAM_AD_NH;
331 else if (!(params & PARAM_AD_OIF) && unformat (input, "oif %U",
332 unformat_vnet_sw_interface,
333 vnm, &sw_if_index_out))
335 params |= PARAM_AD_OIF;
337 else if (!(params & PARAM_AD_IIF) && unformat (input, "iif %U",
338 unformat_vnet_sw_interface,
339 vnm, &sw_if_index_in))
341 params |= PARAM_AD_IIF;
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)
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;
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;
373 /*************************/
374 /* SRv6 LocalSID FIB DPO */
376 format_srv6_ad_dpo (u8 * s, va_list * args)
378 index_t index = va_arg (*args, index_t);
379 CLIB_UNUSED (u32 indent) = va_arg (*args, u32);
381 return (format (s, "SR: dynamic_proxy_index:[%u]", index));
385 srv6_ad_dpo_lock (dpo_id_t * dpo)
390 srv6_ad_dpo_unlock (dpo_id_t * dpo)
394 const static dpo_vft_t srv6_ad_vft = {
395 .dv_lock = srv6_ad_dpo_lock,
396 .dv_unlock = srv6_ad_dpo_unlock,
397 .dv_format = format_srv6_ad_dpo,
400 const static char *const srv6_ad_ip6_nodes[] = {
405 const static char *const *const srv6_ad_nodes[DPO_PROTO_NUM] = {
406 [DPO_PROTO_IP6] = srv6_ad_ip6_nodes,
409 /**********************/
410 static clib_error_t *
411 srv6_ad_init (vlib_main_t * vm)
413 srv6_ad_main_t *sm = &srv6_ad_main;
417 sm->vnet_main = vnet_get_main ();
420 sm->srv6_ad_dpo_type = dpo_register_new_type (&srv6_ad_vft, srv6_ad_nodes);
422 /* Register SRv6 LocalSID */
423 rv = sr_localsid_register_function (vm,
429 &sm->srv6_ad_dpo_type,
430 format_srv6_ad_localsid,
431 unformat_srv6_ad_localsid,
432 srv6_ad_localsid_creation_fn,
433 srv6_ad_localsid_removal_fn);
435 clib_error_return (0, "SRv6 LocalSID function could not be registered.");
437 sm->srv6_localsid_behavior_id = rv;
443 VNET_FEATURE_INIT (srv6_ad2_rewrite, static) =
445 .arc_name = "device-input",
446 .node_name = "srv6-ad2-rewrite",
447 .runs_before = VNET_FEATURES ("ethernet-input"),
450 VNET_FEATURE_INIT (srv6_ad4_rewrite, static) =
452 .arc_name = "ip4-unicast",
453 .node_name = "srv6-ad4-rewrite",
457 VNET_FEATURE_INIT (srv6_ad6_rewrite, static) =
459 .arc_name = "ip6-unicast",
460 .node_name = "srv6-ad6-rewrite",
464 VLIB_INIT_FUNCTION (srv6_ad_init);
466 VLIB_PLUGIN_REGISTER () = {
467 .version = VPP_BUILD_VER,
468 .description = "Dynamic Segment Routing for IPv6 (SRv6) Proxy",
473 * fd.io coding-style-patch-verification: ON
476 * eval: (c-set-style "gnu")