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 * as.c - SRv6 Static Proxy (AS) 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-as/as.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-AS-plugin";
33 unsigned char keyword_str[] = "End.AS";
34 unsigned char def_str[] =
35 "Endpoint with static proxy to SR-unaware appliance";
36 unsigned char params_str[] =
37 "nh <next-hop> oif <iface-out> iif <iface-in> src <src-addr> next <sid> [next <sid> ...]";
41 prepare_rewrite (ip6_address_t src_addr, ip6_address_t * sid_list,
44 u8 *rewrite_str = NULL;
45 u32 rewrite_len = IPv6_DEFAULT_HEADER_LENGTH;
47 u8 num_sids = vec_len (sid_list);
53 sizeof (ip6_sr_header_t) + num_sids * sizeof (ip6_address_t);
54 rewrite_len += sr_hdr_len;
57 vec_validate (rewrite_str, rewrite_len - 1);
60 ip6_header_t *iph = (ip6_header_t *) rewrite_str;
61 iph->ip_version_traffic_class_and_flow_label =
62 clib_host_to_net_u32 (0 | ((6 & 0xF) << 28));
63 iph->src_address = src_addr;
64 iph->dst_address = sid_list[0];
65 iph->payload_length = sr_hdr_len;
66 iph->hop_limit = IPv6_DEFAULT_HOP_LIMIT;
70 /* Set Next Header value to Routing Extension */
71 iph->protocol = IP_PROTOCOL_IPV6_ROUTE;
74 ip6_sr_header_t *srh = (ip6_sr_header_t *) (iph + 1);
75 srh->protocol = protocol;
76 srh->length = sr_hdr_len / 8 - 1;
77 srh->type = ROUTING_HEADER_TYPE_SR;
78 srh->segments_left = num_sids - 1;
79 srh->first_segment = num_sids - 1;
83 /* Fill segment list */
84 ip6_address_t *this_address;
85 ip6_address_t *addrp = srh->segments + srh->first_segment;
86 vec_foreach (this_address, sid_list)
88 *addrp = *this_address;
94 /* Set Next Header value to inner protocol */
95 iph->protocol = protocol;
102 free_ls_mem (srv6_as_localsid_t * ls_mem)
104 vec_free (ls_mem->rewrite);
105 vec_free (ls_mem->sid_list);
106 clib_mem_free (ls_mem);
110 /*****************************************/
111 /* SRv6 LocalSID instantiation and removal functions */
113 srv6_as_localsid_creation_fn (ip6_sr_localsid_t * localsid)
115 ip6_sr_main_t *srm = &sr_main;
116 srv6_as_main_t *sm = &srv6_as_main;
117 srv6_as_localsid_t *ls_mem = localsid->plugin_mem;
118 u32 localsid_index = localsid - srm->localsids;
120 /* Step 1: Prepare xconnect adjacency for sending packets to the VNF */
122 /* Retrieve the adjacency corresponding to the (OIF, next_hop) */
123 adj_index_t nh_adj_index = ADJ_INDEX_INVALID;
124 if (ls_mem->inner_type != AS_TYPE_L2)
126 if (ls_mem->inner_type == AS_TYPE_IP4)
127 nh_adj_index = adj_nbr_add_or_lock (FIB_PROTOCOL_IP4,
128 VNET_LINK_IP4, &ls_mem->nh_addr,
129 ls_mem->sw_if_index_out);
130 else if (ls_mem->inner_type == AS_TYPE_IP6)
131 nh_adj_index = adj_nbr_add_or_lock (FIB_PROTOCOL_IP6,
132 VNET_LINK_IP6, &ls_mem->nh_addr,
133 ls_mem->sw_if_index_out);
134 if (nh_adj_index == ADJ_INDEX_INVALID)
136 free_ls_mem (ls_mem);
137 return SID_CREATE_INVALID_ADJ_INDEX;
141 ls_mem->nh_adj = nh_adj_index;
144 /* Step 2: Prepare inbound policy for packets returning from the VNF */
146 /* Make sure the provided incoming interface index is valid */
147 if (pool_is_free_index (sm->vnet_main->interface_main.sw_interfaces,
148 ls_mem->sw_if_index_in))
150 adj_unlock (ls_mem->nh_adj);
151 free_ls_mem (ls_mem);
152 return SID_CREATE_INVALID_IFACE_INDEX;
155 /* Retrieve associated interface structure */
156 vnet_sw_interface_t *sw = vnet_get_sw_interface (sm->vnet_main,
157 ls_mem->sw_if_index_in);
158 if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
160 adj_unlock (ls_mem->nh_adj);
161 free_ls_mem (ls_mem);
162 return SID_CREATE_INVALID_IFACE_TYPE;
165 if (ls_mem->inner_type == AS_TYPE_L2)
167 /* Enable End.AS2 rewrite node for this interface */
169 vnet_feature_enable_disable ("device-input", "srv6-as2-rewrite",
170 ls_mem->sw_if_index_in, 1, 0, 0);
173 free_ls_mem (ls_mem);
174 return SID_CREATE_IFACE_FEATURE_ERROR;
177 /* Set interface in promiscuous mode */
178 vnet_main_t *vnm = vnet_get_main ();
179 ethernet_set_flags (vnm, ls_mem->sw_if_index_in,
180 ETHERNET_INTERFACE_FLAG_ACCEPT_ALL);
182 /* Prepare rewrite string */
183 ls_mem->rewrite = prepare_rewrite (ls_mem->src_addr, ls_mem->sid_list,
184 IP_PROTOCOL_IP6_NONXT);
186 /* Associate local SID index to this interface (resize vector if needed) */
187 if (ls_mem->sw_if_index_in >= vec_len (sm->sw_iface_localsid2))
189 vec_resize (sm->sw_iface_localsid2,
190 (pool_len (sm->vnet_main->interface_main.sw_interfaces)
191 - vec_len (sm->sw_iface_localsid2)));
193 sm->sw_iface_localsid2[ls_mem->sw_if_index_in] = localsid_index;
195 else if (ls_mem->inner_type == AS_TYPE_IP4)
197 /* Enable End.AS4 rewrite node for this interface */
199 vnet_feature_enable_disable ("ip4-unicast", "srv6-as4-rewrite",
200 ls_mem->sw_if_index_in, 1, 0, 0);
203 adj_unlock (ls_mem->nh_adj);
204 free_ls_mem (ls_mem);
205 return SID_CREATE_IFACE_FEATURE_ERROR;
208 /* Prepare rewrite string */
209 ls_mem->rewrite = prepare_rewrite (ls_mem->src_addr, ls_mem->sid_list,
210 IP_PROTOCOL_IP_IN_IP);
212 /* Associate local SID index to this interface (resize vector if needed) */
213 if (ls_mem->sw_if_index_in >= vec_len (sm->sw_iface_localsid4))
215 vec_resize (sm->sw_iface_localsid4,
216 (pool_len (sm->vnet_main->interface_main.sw_interfaces)
217 - vec_len (sm->sw_iface_localsid4)));
219 sm->sw_iface_localsid4[ls_mem->sw_if_index_in] = localsid_index;
221 else if (ls_mem->inner_type == AS_TYPE_IP6)
223 /* Enable End.AS6 rewrite node for this interface */
225 vnet_feature_enable_disable ("ip6-unicast", "srv6-as6-rewrite",
226 ls_mem->sw_if_index_in, 1, 0, 0);
229 adj_unlock (ls_mem->nh_adj);
230 free_ls_mem (ls_mem);
231 return SID_CREATE_IFACE_FEATURE_ERROR;
234 /* Prepare rewrite string */
235 ls_mem->rewrite = prepare_rewrite (ls_mem->src_addr, ls_mem->sid_list,
238 /* Associate local SID index to this interface (resize vector if needed) */
239 if (ls_mem->sw_if_index_in >= vec_len (sm->sw_iface_localsid6))
241 vec_resize (sm->sw_iface_localsid6,
242 (pool_len (sm->vnet_main->interface_main.sw_interfaces)
243 - vec_len (sm->sw_iface_localsid6)));
245 sm->sw_iface_localsid6[ls_mem->sw_if_index_in] = localsid_index;
248 /* Step 3: Initialize rewrite counters */
249 srv6_as_localsid_t **ls_p;
250 pool_get (sm->sids, ls_p);
252 ls_mem->index = ls_p - sm->sids;
254 vlib_validate_combined_counter (&(sm->valid_counters), ls_mem->index);
255 vlib_validate_combined_counter (&(sm->invalid_counters), ls_mem->index);
257 vlib_zero_combined_counter (&(sm->valid_counters), ls_mem->index);
258 vlib_zero_combined_counter (&(sm->invalid_counters), ls_mem->index);
264 srv6_as_localsid_removal_fn (ip6_sr_localsid_t * localsid)
266 srv6_as_main_t *sm = &srv6_as_main;
267 srv6_as_localsid_t *ls_mem = localsid->plugin_mem;
269 if (ls_mem->inner_type == AS_TYPE_L2)
271 /* Disable End.AS2 rewrite node for this interface */
273 ret = vnet_feature_enable_disable ("device-input", "srv6-as2-rewrite",
274 ls_mem->sw_if_index_in, 0, 0, 0);
278 /* Disable promiscuous mode on the interface */
279 vnet_main_t *vnm = vnet_get_main ();
280 ethernet_set_flags (vnm, ls_mem->sw_if_index_in, 0);
282 /* Remove local SID index from interface table */
283 sm->sw_iface_localsid2[ls_mem->sw_if_index_in] = ~(u32) 0;
285 else if (ls_mem->inner_type == AS_TYPE_IP4)
287 /* Disable End.AS4 rewrite node for this interface */
289 ret = vnet_feature_enable_disable ("ip4-unicast", "srv6-as4-rewrite",
290 ls_mem->sw_if_index_in, 0, 0, 0);
294 /* Remove local SID index from interface table */
295 sm->sw_iface_localsid4[ls_mem->sw_if_index_in] = ~(u32) 0;
297 else if (ls_mem->inner_type == AS_TYPE_IP6)
299 /* Disable End.AS6 rewrite node for this interface */
301 ret = vnet_feature_enable_disable ("ip6-unicast", "srv6-as6-rewrite",
302 ls_mem->sw_if_index_in, 0, 0, 0);
306 /* Remove local SID index from interface table */
307 sm->sw_iface_localsid6[ls_mem->sw_if_index_in] = ~(u32) 0;
311 /* Unlock (OIF, NHOP) adjacency (from sr_localsid.c:103) */
312 adj_unlock (ls_mem->nh_adj);
314 /* Delete SID entry */
315 pool_put (sm->sids, pool_elt_at_index (sm->sids, ls_mem->index));
317 /* Clean up local SID memory */
318 free_ls_mem (ls_mem);
323 /**********************************/
324 /* SRv6 LocalSID format functions */
326 * Prints nicely the parameters of a localsid
327 * Example: print "Table 5"
330 format_srv6_as_localsid (u8 * s, va_list * args)
332 srv6_as_localsid_t *ls_mem = va_arg (*args, void *);
334 vnet_main_t *vnm = vnet_get_main ();
335 srv6_as_main_t *sm = &srv6_as_main;
337 if (ls_mem->inner_type == AS_TYPE_IP4)
340 format (s, "Next-hop:\t%U\n\t", format_ip4_address,
341 &ls_mem->nh_addr.ip4);
343 else if (ls_mem->inner_type == AS_TYPE_IP6)
346 format (s, "Next-hop:\t%U\n\t", format_ip6_address,
347 &ls_mem->nh_addr.ip6);
350 s = format (s, "Outgoing iface:\t%U\n", format_vnet_sw_if_index_name, vnm,
351 ls_mem->sw_if_index_out);
352 s = format (s, "\tIncoming iface:\t%U\n", format_vnet_sw_if_index_name, vnm,
353 ls_mem->sw_if_index_in);
354 s = format (s, "\tSource address:\t%U\n", format_ip6_address,
357 s = format (s, "\tSegment list:\t< ");
359 vec_foreach (addr, ls_mem->sid_list)
361 s = format (s, "%U, ", format_ip6_address, addr);
363 s = format (s, "\b\b >\n");
365 vlib_counter_t valid, invalid;
366 vlib_get_combined_counter (&(sm->valid_counters), ls_mem->index, &valid);
367 vlib_get_combined_counter (&(sm->invalid_counters), ls_mem->index,
370 format (s, "\tGood rewrite traffic: \t[%Ld packets : %Ld bytes]\n",
371 valid.packets, valid.bytes);
373 format (s, "\tBad rewrite traffic: \t[%Ld packets : %Ld bytes]\n",
374 invalid.packets, invalid.bytes);
380 * Process the parameters of a localsid
381 * Example: process from:
382 * sr localsid address cafe::1 behavior new_srv6_localsid 5
383 * everything from behavior on... so in this case 'new_srv6_localsid 5'
384 * Notice that it MUST match the keyword_str and params_str defined above.
387 unformat_srv6_as_localsid (unformat_input_t * input, va_list * args)
389 void **plugin_mem_p = va_arg (*args, void **);
390 srv6_as_localsid_t *ls_mem;
392 vnet_main_t *vnm = vnet_get_main ();
394 u8 inner_type = AS_TYPE_L2;
395 ip46_address_t nh_addr;
398 ip6_address_t src_addr;
399 ip6_address_t next_sid;
400 ip6_address_t *sid_list = NULL;
403 #define PARAM_AS_NH (1 << 0)
404 #define PARAM_AS_OIF (1 << 1)
405 #define PARAM_AS_IIF (1 << 2)
406 #define PARAM_AS_SRC (1 << 3)
408 if (!unformat (input, "end.as"))
411 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
413 if (!(params & PARAM_AS_NH) && unformat (input, "nh %U",
414 unformat_ip4_address,
417 inner_type = AS_TYPE_IP4;
418 params |= PARAM_AS_NH;
420 if (!(params & PARAM_AS_NH) && unformat (input, "nh %U",
421 unformat_ip6_address,
424 inner_type = AS_TYPE_IP6;
425 params |= PARAM_AS_NH;
427 else if (!(params & PARAM_AS_OIF) && unformat (input, "oif %U",
428 unformat_vnet_sw_interface,
429 vnm, &sw_if_index_out))
431 params |= PARAM_AS_OIF;
433 else if (!(params & PARAM_AS_IIF) && unformat (input, "iif %U",
434 unformat_vnet_sw_interface,
435 vnm, &sw_if_index_in))
437 params |= PARAM_AS_IIF;
439 else if (!(params & PARAM_AS_SRC) && unformat (input, "src %U",
440 unformat_ip6_address,
443 params |= PARAM_AS_SRC;
445 else if (unformat (input, "next %U", unformat_ip6_address, &next_sid))
447 vec_add1 (sid_list, next_sid);
455 /* Make sure that all parameters are supplied */
456 u8 params_chk = (PARAM_AS_OIF | PARAM_AS_IIF | PARAM_AS_SRC);
457 if ((params & params_chk) != params_chk || sid_list == NULL)
463 /* Allocate and initialize memory block for local SID parameters */
464 ls_mem = clib_mem_alloc_aligned_at_offset (sizeof *ls_mem, 0, 0, 1);
465 clib_memset (ls_mem, 0, sizeof *ls_mem);
466 *plugin_mem_p = ls_mem;
468 /* Set local SID parameters */
469 ls_mem->inner_type = inner_type;
470 if (inner_type == AS_TYPE_IP4)
471 ls_mem->nh_addr.ip4 = nh_addr.ip4;
472 else if (inner_type == AS_TYPE_IP6)
473 ls_mem->nh_addr.ip6 = nh_addr.ip6;
474 ls_mem->sw_if_index_out = sw_if_index_out;
475 ls_mem->sw_if_index_in = sw_if_index_in;
476 ls_mem->src_addr = src_addr;
477 ls_mem->sid_list = sid_list;
482 /*************************/
483 /* SRv6 LocalSID FIB DPO */
485 format_srv6_as_dpo (u8 * s, va_list * args)
487 index_t index = va_arg (*args, index_t);
488 CLIB_UNUSED (u32 indent) = va_arg (*args, u32);
490 return (format (s, "SR: static_proxy_index:[%u]", index));
494 srv6_as_dpo_lock (dpo_id_t * dpo)
499 srv6_as_dpo_unlock (dpo_id_t * dpo)
503 const static dpo_vft_t srv6_as_vft = {
504 .dv_lock = srv6_as_dpo_lock,
505 .dv_unlock = srv6_as_dpo_unlock,
506 .dv_format = format_srv6_as_dpo,
509 const static char *const srv6_as_ip6_nodes[] = {
514 const static char *const *const srv6_as_nodes[DPO_PROTO_NUM] = {
515 [DPO_PROTO_IP6] = srv6_as_ip6_nodes,
518 /**********************/
519 static clib_error_t *
520 srv6_as_init (vlib_main_t * vm)
522 srv6_as_main_t *sm = &srv6_as_main;
526 sm->vnet_main = vnet_get_main ();
529 sm->srv6_as_dpo_type = dpo_register_new_type (&srv6_as_vft, srv6_as_nodes);
531 /* Register SRv6 LocalSID */
532 rv = sr_localsid_register_function (vm,
537 &sm->srv6_as_dpo_type,
538 format_srv6_as_localsid,
539 unformat_srv6_as_localsid,
540 srv6_as_localsid_creation_fn,
541 srv6_as_localsid_removal_fn);
543 clib_error_return (0, "SRv6 LocalSID function could not be registered.");
545 sm->srv6_localsid_behavior_id = rv;
551 VNET_FEATURE_INIT (srv6_as2_rewrite, static) =
553 .arc_name = "device-input",
554 .node_name = "srv6-as2-rewrite",
555 .runs_before = VNET_FEATURES ("ethernet-input"),
558 VNET_FEATURE_INIT (srv6_as4_rewrite, static) =
560 .arc_name = "ip4-unicast",
561 .node_name = "srv6-as4-rewrite",
565 VNET_FEATURE_INIT (srv6_as6_rewrite, static) =
567 .arc_name = "ip6-unicast",
568 .node_name = "srv6-as6-rewrite",
572 VLIB_INIT_FUNCTION (srv6_as_init);
574 VLIB_PLUGIN_REGISTER () = {
575 .version = VPP_BUILD_VER,
576 .description = "Static SRv6 proxy",
581 * fd.io coding-style-patch-verification: ON
584 * eval: (c-set-style "gnu")