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 unsigned char function_name[] = "SRv6-AD-plugin";
28 unsigned char keyword_str[] = "End.AD";
29 unsigned char def_str[] =
30 "Endpoint with dynamic proxy to SR-unaware appliance";
31 unsigned char params_str[] = "nh <next-hop> oif <iface-out> iif <iface-in>";
34 /*****************************************/
35 /* SRv6 LocalSID instantiation and removal functions */
37 srv6_ad_localsid_creation_fn (ip6_sr_localsid_t * localsid)
39 ip6_sr_main_t *srm = &sr_main;
40 srv6_ad_main_t *sm = &srv6_ad_main;
41 srv6_ad_localsid_t *ls_mem = localsid->plugin_mem;
42 u32 localsid_index = localsid - srm->localsids;
44 /* Step 1: Prepare xconnect adjacency for sending packets to the VNF */
46 /* Retrieve the adjacency corresponding to the (OIF, next_hop) */
47 adj_index_t nh_adj_index = ADJ_INDEX_INVALID;
48 if (ls_mem->ip_version == DA_IP4)
49 nh_adj_index = adj_nbr_add_or_lock (FIB_PROTOCOL_IP4,
50 VNET_LINK_IP4, &ls_mem->nh_addr,
51 ls_mem->sw_if_index_out);
52 else if (ls_mem->ip_version == DA_IP6)
53 nh_adj_index = adj_nbr_add_or_lock (FIB_PROTOCOL_IP6,
54 VNET_LINK_IP6, &ls_mem->nh_addr,
55 ls_mem->sw_if_index_out);
56 if (nh_adj_index == ADJ_INDEX_INVALID)
59 ls_mem->nh_adj = nh_adj_index;
62 /* Step 2: Prepare inbound policy for packets returning from the VNF */
64 /* Sanitise the SW_IF_INDEX */
65 if (pool_is_free_index (sm->vnet_main->interface_main.sw_interfaces,
66 ls_mem->sw_if_index_in))
69 vnet_sw_interface_t *sw = vnet_get_sw_interface (sm->vnet_main,
70 ls_mem->sw_if_index_in);
71 if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
75 if (ls_mem->ip_version == DA_IP4)
77 ret = vnet_feature_enable_disable ("ip4-unicast", "srv6-ad4-rewrite",
78 ls_mem->sw_if_index_in, 1, 0, 0);
82 /* FIB API calls - Recursive route through the BindingSID */
83 if (ls_mem->sw_if_index_in < vec_len (sm->sw_iface_localsid4))
85 sm->sw_iface_localsid4[ls_mem->sw_if_index_in] = localsid_index;
89 vec_resize (sm->sw_iface_localsid4,
90 (pool_len (sm->vnet_main->interface_main.sw_interfaces)
91 - vec_len (sm->sw_iface_localsid4)));
92 sm->sw_iface_localsid4[ls_mem->sw_if_index_in] = localsid_index;
95 else if (ls_mem->ip_version == DA_IP6)
97 ret = vnet_feature_enable_disable ("ip6-unicast", "srv6-ad6-rewrite",
98 ls_mem->sw_if_index_in, 1, 0, 0);
102 if (ls_mem->sw_if_index_in < vec_len (sm->sw_iface_localsid6))
104 sm->sw_iface_localsid6[ls_mem->sw_if_index_in] = localsid_index;
108 vec_resize (sm->sw_iface_localsid6,
109 (pool_len (sm->vnet_main->interface_main.sw_interfaces)
110 - vec_len (sm->sw_iface_localsid6)));
111 sm->sw_iface_localsid6[ls_mem->sw_if_index_in] = localsid_index;
119 srv6_ad_localsid_removal_fn (ip6_sr_localsid_t * localsid)
121 srv6_ad_main_t *sm = &srv6_ad_main;
122 srv6_ad_localsid_t *ls_mem = localsid->plugin_mem;
125 if (ls_mem->ip_version == DA_IP4)
127 /* Remove hardware indirection (from sr_steering.c:137) */
128 ret = vnet_feature_enable_disable ("ip4-unicast", "srv6-ad4-rewrite",
129 ls_mem->sw_if_index_in, 0, 0, 0);
133 /* Remove local SID pointer from interface table (from sr_steering.c:139) */
134 sm->sw_iface_localsid4[ls_mem->sw_if_index_in] = ~(u32) 0;
136 else if (ls_mem->ip_version == DA_IP6)
138 /* Remove hardware indirection (from sr_steering.c:137) */
139 ret = vnet_feature_enable_disable ("ip6-unicast", "srv6-ad6-rewrite",
140 ls_mem->sw_if_index_in, 0, 0, 0);
144 /* Remove local SID pointer from interface table (from sr_steering.c:139) */
145 sm->sw_iface_localsid6[ls_mem->sw_if_index_in] = ~(u32) 0;
149 /* Unlock (OIF, NHOP) adjacency (from sr_localsid.c:103) */
150 adj_unlock (ls_mem->nh_adj);
152 /* Clean up local SID memory */
153 clib_mem_free (localsid->plugin_mem);
158 /**********************************/
159 /* SRv6 LocalSID format functions */
161 * Prints nicely the parameters of a localsid
162 * Example: print "Table 5"
165 format_srv6_ad_localsid (u8 * s, va_list * args)
167 srv6_ad_localsid_t *ls_mem = va_arg (*args, void *);
169 vnet_main_t *vnm = vnet_get_main ();
171 if (ls_mem->ip_version == DA_IP4)
175 "\tOutgoing iface: %U\n"
176 "\tIncoming iface: %U",
177 format_ip4_address, &ls_mem->nh_addr.ip4,
178 format_vnet_sw_if_index_name, vnm,
179 ls_mem->sw_if_index_out, format_vnet_sw_if_index_name,
180 vnm, ls_mem->sw_if_index_in));
186 "\tOutgoing iface: %U\n"
187 "\tIncoming iface: %U",
188 format_ip6_address, &ls_mem->nh_addr.ip6,
189 format_vnet_sw_if_index_name, vnm,
190 ls_mem->sw_if_index_out, format_vnet_sw_if_index_name,
191 vnm, ls_mem->sw_if_index_in));
196 * Process the parameters of a localsid
197 * Example: process from:
198 * sr localsid address cafe::1 behavior new_srv6_localsid 5
199 * everything from behavior on... so in this case 'new_srv6_localsid 5'
200 * Notice that it MUST match the keyword_str and params_str defined above.
203 unformat_srv6_ad_localsid (unformat_input_t * input, va_list * args)
205 void **plugin_mem_p = va_arg (*args, void **);
206 srv6_ad_localsid_t *ls_mem;
208 vnet_main_t *vnm = vnet_get_main ();
210 ip46_address_t nh_addr;
214 if (unformat (input, "end.ad nh %U oif %U iif %U",
215 unformat_ip4_address, &nh_addr.ip4,
216 unformat_vnet_sw_interface, vnm, &sw_if_index_out,
217 unformat_vnet_sw_interface, vnm, &sw_if_index_in))
219 /* Allocate a portion of memory */
220 ls_mem = clib_mem_alloc_aligned_at_offset (sizeof *ls_mem, 0, 0, 1);
222 /* Set to zero the memory */
223 memset (ls_mem, 0, sizeof *ls_mem);
225 /* Our brand-new car is ready */
226 ls_mem->ip_version = DA_IP4;
227 clib_memcpy (&ls_mem->nh_addr.ip4, &nh_addr.ip4,
228 sizeof (ip4_address_t));
229 ls_mem->sw_if_index_out = sw_if_index_out;
230 ls_mem->sw_if_index_in = sw_if_index_in;
232 /* Dont forget to add it to the localsid */
233 *plugin_mem_p = ls_mem;
236 else if (unformat (input, "end.ad nh %U oif %U iif %U",
237 unformat_ip6_address, &nh_addr.ip6,
238 unformat_vnet_sw_interface, vnm, &sw_if_index_out,
239 unformat_vnet_sw_interface, vnm, &sw_if_index_in))
241 /* Allocate a portion of memory */
242 ls_mem = clib_mem_alloc_aligned_at_offset (sizeof *ls_mem, 0, 0, 1);
244 /* Set to zero the memory */
245 memset (ls_mem, 0, sizeof *ls_mem);
247 /* Our brand-new car is ready */
248 ls_mem->ip_version = DA_IP6;
249 clib_memcpy (&ls_mem->nh_addr.ip6, &nh_addr.ip6,
250 sizeof (ip6_address_t));
251 ls_mem->sw_if_index_out = sw_if_index_out;
252 ls_mem->sw_if_index_in = sw_if_index_in;
254 /* Dont forget to add it to the localsid */
255 *plugin_mem_p = ls_mem;
261 /*************************/
262 /* SRv6 LocalSID FIB DPO */
264 format_srv6_ad_dpo (u8 * s, va_list * args)
266 index_t index = va_arg (*args, index_t);
267 CLIB_UNUSED (u32 indent) = va_arg (*args, u32);
269 return (format (s, "SR: dynamic_proxy_index:[%u]", index));
273 srv6_ad_dpo_lock (dpo_id_t * dpo)
278 srv6_ad_dpo_unlock (dpo_id_t * dpo)
282 const static dpo_vft_t srv6_ad_vft = {
283 .dv_lock = srv6_ad_dpo_lock,
284 .dv_unlock = srv6_ad_dpo_unlock,
285 .dv_format = format_srv6_ad_dpo,
288 const static char *const srv6_ad_ip6_nodes[] = {
293 const static char *const *const srv6_ad_nodes[DPO_PROTO_NUM] = {
294 [DPO_PROTO_IP6] = srv6_ad_ip6_nodes,
297 /**********************/
298 static clib_error_t *
299 srv6_ad_init (vlib_main_t * vm)
301 srv6_ad_main_t *sm = &srv6_ad_main;
305 sm->vnet_main = vnet_get_main ();
308 sm->srv6_ad_dpo_type = dpo_register_new_type (&srv6_ad_vft, srv6_ad_nodes);
310 /* Register SRv6 LocalSID */
311 rv = sr_localsid_register_function (vm,
316 &sm->srv6_ad_dpo_type,
317 format_srv6_ad_localsid,
318 unformat_srv6_ad_localsid,
319 srv6_ad_localsid_creation_fn,
320 srv6_ad_localsid_removal_fn);
322 clib_error_return (0, "SRv6 LocalSID function could not be registered.");
324 sm->srv6_localsid_behavior_id = rv;
330 VNET_FEATURE_INIT (srv6_ad4_rewrite, static) =
332 .arc_name = "ip4-unicast",
333 .node_name = "srv6-ad4-rewrite",
337 VNET_FEATURE_INIT (srv6_ad6_rewrite, static) =
339 .arc_name = "ip6-unicast",
340 .node_name = "srv6-ad6-rewrite",
344 VLIB_INIT_FUNCTION (srv6_ad_init);
346 VLIB_PLUGIN_REGISTER () = {
347 .version = VPP_BUILD_VER,
348 .description = "Dynamic SRv6 proxy",
353 * fd.io coding-style-patch-verification: ON
356 * eval: (c-set-style "gnu")