2 *------------------------------------------------------------------
3 * sr_api.c - ipv6 segment routing api
5 * Copyright (c) 2016 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vnet/srv6/sr.h>
22 #include <vlibmemory/api.h>
24 #include <vnet/interface.h>
25 #include <vnet/api_errno.h>
26 #include <vnet/feature/feature.h>
27 #include <vnet/fib/fib_table.h>
29 #include <vnet/ip/ip_types_api.h>
31 #include <vnet/vnet_msg_enum.h>
33 #define vl_typedefs /* define message structures */
34 #include <vnet/vnet_all_api_h.h>
37 #define vl_endianfun /* define message structures */
38 #include <vnet/vnet_all_api_h.h>
41 /* instantiate all the print functions we know about */
42 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
44 #include <vnet/vnet_all_api_h.h>
47 #include <vlibapi/api_helper_macros.h>
49 #define foreach_vpe_api_msg \
50 _(SR_LOCALSID_ADD_DEL, sr_localsid_add_del) \
51 _(SR_POLICY_ADD, sr_policy_add) \
52 _(SR_POLICY_MOD, sr_policy_mod) \
53 _(SR_POLICY_DEL, sr_policy_del) \
54 _(SR_STEERING_ADD_DEL, sr_steering_add_del) \
55 _(SR_SET_ENCAP_SOURCE, sr_set_encap_source) \
56 _(SR_SET_ENCAP_HOP_LIMIT, sr_set_encap_hop_limit) \
57 _(SR_LOCALSIDS_DUMP, sr_localsids_dump) \
58 _(SR_POLICIES_DUMP, sr_policies_dump) \
59 _(SR_POLICIES_WITH_SL_INDEX_DUMP, sr_policies_with_sl_index_dump) \
60 _(SR_STEERING_POL_DUMP, sr_steering_pol_dump)
62 static void vl_api_sr_localsid_add_del_t_handler
63 (vl_api_sr_localsid_add_del_t * mp)
65 vl_api_sr_localsid_add_del_reply_t *rmp;
67 ip46_address_t prefix;
68 ip6_address_t localsid;
70 * int sr_cli_localsid (char is_del, ip6_address_t *localsid_addr,
71 * char end_psp, u8 behavior, u32 sw_if_index, u32 vlan_index, u32 fib_table,
72 * ip46_address_t *nh_addr, void *ls_plugin_mem)
74 if (mp->behavior == SR_BEHAVIOR_X ||
75 mp->behavior == SR_BEHAVIOR_DX6 ||
76 mp->behavior == SR_BEHAVIOR_DX4 || mp->behavior == SR_BEHAVIOR_DX2)
77 VALIDATE_SW_IF_INDEX (mp);
79 ip6_address_decode (mp->localsid, &localsid);
80 ip_address_decode (&mp->nh_addr, &prefix);
82 rv = sr_cli_localsid (mp->is_del,
86 ntohl (mp->sw_if_index),
87 ntohl (mp->vlan_index),
88 ntohl (mp->fib_table), &prefix, 0, NULL);
90 BAD_SW_IF_INDEX_LABEL;
91 REPLY_MACRO (VL_API_SR_LOCALSID_ADD_DEL_REPLY);
95 vl_api_sr_policy_add_t_handler (vl_api_sr_policy_add_t * mp)
97 vl_api_sr_policy_add_reply_t *rmp;
98 ip6_address_t *segments = 0, *seg;
99 ip6_address_t bsid_addr;
102 for (i = 0; i < mp->sids.num_sids; i++)
104 vec_add2 (segments, seg, 1);
105 ip6_address_decode (mp->sids.sids[i], seg);
108 ip6_address_decode (mp->bsid_addr, &bsid_addr);
111 * sr_policy_add (ip6_address_t *bsid, ip6_address_t *segments,
112 * u32 weight, u8 behavior, u32 fib_table, u8 is_encap,
113 * u16 behavior, void *plugin_mem)
116 rv = sr_policy_add (&bsid_addr,
118 ntohl (mp->sids.weight),
119 mp->is_spray, ntohl (mp->fib_table), mp->is_encap, 0,
123 REPLY_MACRO (VL_API_SR_POLICY_ADD_REPLY);
127 vl_api_sr_policy_mod_t_handler (vl_api_sr_policy_mod_t * mp)
129 vl_api_sr_policy_mod_reply_t *rmp;
130 ip6_address_t *segments = 0, *seg;
131 ip6_address_t bsid_addr;
134 for (i = 0; i < mp->sids.num_sids; i++)
136 vec_add2 (segments, seg, 1);
137 ip6_address_decode (mp->sids.sids[i], seg);
140 ip6_address_decode (mp->bsid_addr, &bsid_addr);
145 * sr_policy_mod(ip6_address_t *bsid, u32 index, u32 fib_table,
146 * u8 operation, ip6_address_t *segments, u32 sl_index,
147 * u32 weight, u8 is_encap)
149 rv = sr_policy_mod (&bsid_addr,
150 ntohl (mp->sr_policy_index),
151 ntohl (mp->fib_table),
153 segments, ntohl (mp->sl_index),
154 ntohl (mp->sids.weight));
157 REPLY_MACRO (VL_API_SR_POLICY_MOD_REPLY);
161 vl_api_sr_policy_del_t_handler (vl_api_sr_policy_del_t * mp)
163 vl_api_sr_policy_del_reply_t *rmp;
165 ip6_address_t bsid_addr;
168 * sr_policy_del (ip6_address_t *bsid, u32 index)
170 ip6_address_decode (mp->bsid_addr, &bsid_addr);
171 rv = sr_policy_del (&bsid_addr, ntohl (mp->sr_policy_index));
173 REPLY_MACRO (VL_API_SR_POLICY_DEL_REPLY);
177 vl_api_sr_set_encap_source_t_handler (vl_api_sr_set_encap_source_t * mp)
179 vl_api_sr_set_encap_source_reply_t *rmp;
181 ip6_address_t encaps_source;
183 ip6_address_decode (mp->encaps_source, &encaps_source);
184 sr_set_source (&encaps_source);
186 REPLY_MACRO (VL_API_SR_SET_ENCAP_SOURCE_REPLY);
190 vl_api_sr_set_encap_hop_limit_t_handler (vl_api_sr_set_encap_hop_limit_t * mp)
192 vl_api_sr_set_encap_hop_limit_reply_t *rmp;
195 if (mp->hop_limit == 0)
196 rv = VNET_API_ERROR_INVALID_VALUE;
198 sr_set_hop_limit (mp->hop_limit);
200 REPLY_MACRO (VL_API_SR_SET_ENCAP_HOP_LIMIT_REPLY);
203 static void vl_api_sr_steering_add_del_t_handler
204 (vl_api_sr_steering_add_del_t * mp)
206 vl_api_sr_steering_add_del_reply_t *rmp;
208 ip6_address_t bsid_addr;
209 ip46_address_t prefix_addr;
212 * sr_steering_policy(int is_del, ip6_address_t *bsid, u32 sr_policy_index,
213 * u32 table_id, ip46_address_t *prefix, u32 mask_width, u32 sw_if_index,
217 ip6_address_decode (mp->bsid_addr, &bsid_addr);
218 ip_address_decode (&mp->prefix.address, &prefix_addr);
220 if (mp->traffic_type == SR_STEER_L2)
221 VALIDATE_SW_IF_INDEX (mp);
223 rv = sr_steering_policy (mp->is_del,
225 ntohl (mp->sr_policy_index),
226 ntohl (mp->table_id),
229 ntohl (mp->sw_if_index), mp->traffic_type);
231 BAD_SW_IF_INDEX_LABEL;
232 REPLY_MACRO (VL_API_SR_STEERING_ADD_DEL_REPLY);
235 static void send_sr_localsid_details
236 (ip6_sr_localsid_t * t, vl_api_registration_t * reg, u32 context)
238 vl_api_sr_localsids_details_t *rmp;
240 rmp = vl_msg_api_alloc (sizeof (*rmp));
241 clib_memset (rmp, 0, sizeof (*rmp));
242 rmp->_vl_msg_id = ntohs (VL_API_SR_LOCALSIDS_DETAILS);
243 ip6_address_encode (&t->localsid, rmp->addr);
244 rmp->end_psp = t->end_psp;
245 rmp->behavior = htons (t->behavior);
246 rmp->fib_table = htonl (t->fib_table);
247 rmp->vlan_index = htonl (t->vlan_index);
248 ip_address_encode (&t->next_hop, IP46_TYPE_ANY, &rmp->xconnect_nh_addr);
250 if (t->behavior == SR_BEHAVIOR_T || t->behavior == SR_BEHAVIOR_DT6)
251 rmp->xconnect_iface_or_vrf_table =
252 htonl (fib_table_get_table_id (t->sw_if_index, FIB_PROTOCOL_IP6));
253 else if (t->behavior == SR_BEHAVIOR_DT4)
254 rmp->xconnect_iface_or_vrf_table =
255 htonl (fib_table_get_table_id (t->sw_if_index, FIB_PROTOCOL_IP4));
257 rmp->xconnect_iface_or_vrf_table = htonl (t->sw_if_index);
259 rmp->context = context;
261 vl_api_send_msg (reg, (u8 *) rmp);
264 static void vl_api_sr_localsids_dump_t_handler
265 (vl_api_sr_localsids_dump_t * mp)
267 vl_api_registration_t *reg;
268 ip6_sr_main_t *sm = &sr_main;
269 ip6_sr_localsid_t *t;
271 reg = vl_api_client_index_to_registration (mp->client_index);
276 pool_foreach (t, sm->localsids,
278 send_sr_localsid_details(t, reg, mp->context);
283 static void send_sr_policies_details
284 (ip6_sr_policy_t * t, vl_api_registration_t * reg, u32 context)
286 vl_api_sr_policies_details_t *rmp;
287 ip6_sr_main_t *sm = &sr_main;
289 u32 *sl_index, slidx = 0;
290 ip6_sr_sl_t *segment_list = 0;
291 ip6_address_t *segment;
292 vl_api_srv6_sid_list_t *api_sid_list;
294 rmp = vl_msg_api_alloc (sizeof (*rmp) +
295 vec_len (t->segments_lists) *
296 sizeof (vl_api_srv6_sid_list_t));
299 vec_len (t->segments_lists) *
300 sizeof (vl_api_srv6_sid_list_t)));
302 rmp->_vl_msg_id = ntohs (VL_API_SR_POLICIES_DETAILS);
303 ip6_address_encode (&t->bsid, rmp->bsid);
304 rmp->is_encap = t->is_encap;
305 rmp->is_spray = t->type;
306 rmp->fib_table = htonl (t->fib_table);
307 rmp->num_sid_lists = vec_len (t->segments_lists);
309 /* Fill in all the segments lists */
310 vec_foreach (sl_index, t->segments_lists)
312 segment_list = pool_elt_at_index (sm->sid_lists, *sl_index);
314 api_sid_list = &rmp->sid_lists[sl_index - t->segments_lists];
316 api_sid_list->num_sids = vec_len (segment_list->segments);
317 api_sid_list->weight = htonl (segment_list->weight);
319 vec_foreach (segment, segment_list->segments)
321 ip6_address_encode (segment, api_sid_list->sids[slidx++]);
325 rmp->context = context;
326 vl_api_send_msg (reg, (u8 *) rmp);
330 vl_api_sr_policies_dump_t_handler (vl_api_sr_policies_dump_t * mp)
332 vl_api_registration_t *reg;
333 ip6_sr_main_t *sm = &sr_main;
336 reg = vl_api_client_index_to_registration (mp->client_index);
341 pool_foreach (t, sm->sr_policies,
343 send_sr_policies_details(t, reg, mp->context);
350 static void send_sr_policies_details_with_sl_index
351 (ip6_sr_policy_t * t, vl_api_registration_t * reg, u32 context)
353 vl_api_sr_policies_with_sl_index_details_t *rmp;
354 ip6_sr_main_t *sm = &sr_main;
356 u32 *sl_index, slidx = 0;
357 ip6_sr_sl_t *segment_list = 0;
358 ip6_address_t *segment;
359 vl_api_srv6_sid_list_with_sl_index_t *api_sid_list;
361 rmp = vl_msg_api_alloc (sizeof (*rmp) +
362 vec_len (t->segments_lists) *
363 sizeof (vl_api_srv6_sid_list_with_sl_index_t));
366 vec_len (t->segments_lists) *
367 sizeof (vl_api_srv6_sid_list_with_sl_index_t)));
369 rmp->_vl_msg_id = ntohs (VL_API_SR_POLICIES_WITH_SL_INDEX_DETAILS);
370 ip6_address_encode (&t->bsid, rmp->bsid);
371 rmp->is_encap = t->is_encap;
372 rmp->is_spray = t->type;
373 rmp->fib_table = htonl (t->fib_table);
374 rmp->num_sid_lists = vec_len (t->segments_lists);
376 /* Fill in all the segments lists */
377 vec_foreach (sl_index, t->segments_lists)
379 segment_list = pool_elt_at_index (sm->sid_lists, *sl_index);
381 api_sid_list = &rmp->sid_lists[sl_index - t->segments_lists];
382 api_sid_list->sl_index = htonl (*sl_index);
383 api_sid_list->num_sids = vec_len (segment_list->segments);
384 api_sid_list->weight = htonl (segment_list->weight);
386 vec_foreach (segment, segment_list->segments)
388 ip6_address_encode (segment, api_sid_list->sids[slidx++]);
392 rmp->context = context;
393 vl_api_send_msg (reg, (u8 *) rmp);
397 vl_api_sr_policies_with_sl_index_dump_t_handler
398 (vl_api_sr_policies_with_sl_index_dump_t * mp)
400 vl_api_registration_t *reg;
401 ip6_sr_main_t *sm = &sr_main;
404 reg = vl_api_client_index_to_registration (mp->client_index);
409 pool_foreach (t, sm->sr_policies,
411 send_sr_policies_details_with_sl_index(t, reg, mp->context);
416 static void send_sr_steering_pol_details
417 (ip6_sr_steering_policy_t * t, vl_api_registration_t * reg, u32 context)
419 vl_api_sr_steering_pol_details_t *rmp;
420 ip6_sr_main_t *sm = &sr_main;
422 rmp = vl_msg_api_alloc (sizeof (*rmp));
423 clib_memset (rmp, 0, sizeof (*rmp));
424 rmp->_vl_msg_id = ntohs (VL_API_SR_STEERING_POL_DETAILS);
426 //Get the SR policy BSID
428 p = pool_elt_at_index (sm->sr_policies, t->sr_policy);
429 ip6_address_encode (&p->bsid, rmp->bsid);
432 rmp->traffic_type = t->classify.traffic_type;
433 rmp->fib_table = htonl (t->classify.l3.fib_table);
434 ip_address_encode (&t->classify.l3.prefix, IP46_TYPE_ANY,
435 &rmp->prefix.address);
436 rmp->prefix.len = t->classify.l3.mask_width;
438 rmp->sw_if_index = htonl (t->classify.l2.sw_if_index);
440 rmp->context = context;
441 vl_api_send_msg (reg, (u8 *) rmp);
444 static void vl_api_sr_steering_pol_dump_t_handler
445 (vl_api_sr_policies_dump_t * mp)
447 vl_api_registration_t *reg;
448 ip6_sr_main_t *sm = &sr_main;
449 ip6_sr_steering_policy_t *t;
451 reg = vl_api_client_index_to_registration (mp->client_index);
456 pool_foreach (t, sm->steer_policies,
458 send_sr_steering_pol_details(t, reg, mp->context);
465 * Add vpe's API message handlers to the table.
466 * vlib has already mapped shared memory and
467 * added the client registration handlers.
468 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
470 #define vl_msg_name_crc_list
471 #include <vnet/vnet_all_api_h.h>
472 #undef vl_msg_name_crc_list
475 setup_message_id_table (api_main_t * am)
477 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
478 foreach_vl_msg_name_crc_sr;
482 static clib_error_t *
483 sr_api_hookup (vlib_main_t * vm)
485 api_main_t *am = vlibapi_get_main ();
488 vl_msg_api_set_handlers(VL_API_##N, #n, \
489 vl_api_##n##_t_handler, \
491 vl_api_##n##_t_endian, \
492 vl_api_##n##_t_print, \
493 sizeof(vl_api_##n##_t), 1);
498 * Set up the (msg_name, crc, message-id) table
500 setup_message_id_table (am);
505 VLIB_API_INIT_FUNCTION (sr_api_hookup);
508 * fd.io coding-style-patch-verification: ON
511 * eval: (c-set-style "gnu")