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_STEERING_POL_DUMP, sr_steering_pol_dump)
61 static void vl_api_sr_localsid_add_del_t_handler
62 (vl_api_sr_localsid_add_del_t * mp)
64 vl_api_sr_localsid_add_del_reply_t *rmp;
66 ip46_address_t prefix;
67 ip6_address_t localsid;
69 * int sr_cli_localsid (char is_del, ip6_address_t *localsid_addr,
70 * char end_psp, u8 behavior, u32 sw_if_index, u32 vlan_index, u32 fib_table,
71 * ip46_address_t *nh_addr, void *ls_plugin_mem)
73 if (mp->behavior == SR_BEHAVIOR_X ||
74 mp->behavior == SR_BEHAVIOR_DX6 ||
75 mp->behavior == SR_BEHAVIOR_DX4 || mp->behavior == SR_BEHAVIOR_DX2)
76 VALIDATE_SW_IF_INDEX (mp);
78 ip6_address_decode (mp->localsid, &localsid);
79 ip_address_decode (&mp->nh_addr, &prefix);
81 rv = sr_cli_localsid (mp->is_del,
85 ntohl (mp->sw_if_index),
86 ntohl (mp->vlan_index),
87 ntohl (mp->fib_table), &prefix, NULL);
89 BAD_SW_IF_INDEX_LABEL;
90 REPLY_MACRO (VL_API_SR_LOCALSID_ADD_DEL_REPLY);
94 vl_api_sr_policy_add_t_handler (vl_api_sr_policy_add_t * mp)
96 vl_api_sr_policy_add_reply_t *rmp;
97 ip6_address_t *segments = 0, *seg;
98 ip6_address_t bsid_addr;
101 for (i = 0; i < mp->sids.num_sids; i++)
103 vec_add2 (segments, seg, 1);
104 ip6_address_decode (mp->sids.sids[i], seg);
107 ip6_address_decode (mp->bsid_addr, &bsid_addr);
110 * sr_policy_add (ip6_address_t *bsid, ip6_address_t *segments,
111 * u32 weight, u8 behavior, u32 fib_table, u8 is_encap,
112 * u16 behavior, void *plugin_mem)
115 rv = sr_policy_add (&bsid_addr,
117 ntohl (mp->sids.weight),
118 mp->is_spray, ntohl (mp->fib_table), mp->is_encap, 0,
122 REPLY_MACRO (VL_API_SR_POLICY_ADD_REPLY);
126 vl_api_sr_policy_mod_t_handler (vl_api_sr_policy_mod_t * mp)
128 vl_api_sr_policy_mod_reply_t *rmp;
129 ip6_address_t *segments = 0, *seg;
130 ip6_address_t bsid_addr;
133 for (i = 0; i < mp->sids.num_sids; i++)
135 vec_add2 (segments, seg, 1);
136 ip6_address_decode (mp->sids.sids[i], seg);
139 ip6_address_decode (mp->bsid_addr, &bsid_addr);
144 * sr_policy_mod(ip6_address_t *bsid, u32 index, u32 fib_table,
145 * u8 operation, ip6_address_t *segments, u32 sl_index,
146 * u32 weight, u8 is_encap)
148 rv = sr_policy_mod (&bsid_addr,
149 ntohl (mp->sr_policy_index),
150 ntohl (mp->fib_table),
152 segments, ntohl (mp->sl_index),
153 ntohl (mp->sids.weight));
156 REPLY_MACRO (VL_API_SR_POLICY_MOD_REPLY);
160 vl_api_sr_policy_del_t_handler (vl_api_sr_policy_del_t * mp)
162 vl_api_sr_policy_del_reply_t *rmp;
164 ip6_address_t bsid_addr;
167 * sr_policy_del (ip6_address_t *bsid, u32 index)
169 ip6_address_decode (mp->bsid_addr, &bsid_addr);
170 rv = sr_policy_del (&bsid_addr, ntohl (mp->sr_policy_index));
172 REPLY_MACRO (VL_API_SR_POLICY_DEL_REPLY);
176 vl_api_sr_set_encap_source_t_handler (vl_api_sr_set_encap_source_t * mp)
178 vl_api_sr_set_encap_source_reply_t *rmp;
180 ip6_address_t encaps_source;
182 ip6_address_decode (mp->encaps_source, &encaps_source);
183 sr_set_source (&encaps_source);
185 REPLY_MACRO (VL_API_SR_SET_ENCAP_SOURCE_REPLY);
189 vl_api_sr_set_encap_hop_limit_t_handler (vl_api_sr_set_encap_hop_limit_t * mp)
191 vl_api_sr_set_encap_hop_limit_reply_t *rmp;
194 if (mp->hop_limit == 0)
195 rv = VNET_API_ERROR_INVALID_VALUE;
197 sr_set_hop_limit (mp->hop_limit);
199 REPLY_MACRO (VL_API_SR_SET_ENCAP_HOP_LIMIT_REPLY);
202 static void vl_api_sr_steering_add_del_t_handler
203 (vl_api_sr_steering_add_del_t * mp)
205 vl_api_sr_steering_add_del_reply_t *rmp;
207 ip6_address_t bsid_addr;
208 ip46_address_t prefix_addr;
211 * sr_steering_policy(int is_del, ip6_address_t *bsid, u32 sr_policy_index,
212 * u32 table_id, ip46_address_t *prefix, u32 mask_width, u32 sw_if_index,
216 ip6_address_decode (mp->bsid_addr, &bsid_addr);
217 ip_address_decode (&mp->prefix.address, &prefix_addr);
219 if (mp->traffic_type == SR_STEER_L2)
220 VALIDATE_SW_IF_INDEX (mp);
222 rv = sr_steering_policy (mp->is_del,
224 ntohl (mp->sr_policy_index),
225 ntohl (mp->table_id),
227 ntohl (mp->prefix.len),
228 ntohl (mp->sw_if_index), mp->traffic_type);
230 BAD_SW_IF_INDEX_LABEL;
231 REPLY_MACRO (VL_API_SR_STEERING_ADD_DEL_REPLY);
234 static void send_sr_localsid_details
235 (ip6_sr_localsid_t * t, vl_api_registration_t * reg, u32 context)
237 vl_api_sr_localsids_details_t *rmp;
239 rmp = vl_msg_api_alloc (sizeof (*rmp));
240 clib_memset (rmp, 0, sizeof (*rmp));
241 rmp->_vl_msg_id = ntohs (VL_API_SR_LOCALSIDS_DETAILS);
242 ip6_address_encode (&t->localsid, rmp->addr);
243 rmp->end_psp = t->end_psp;
244 rmp->behavior = htons (t->behavior);
245 rmp->fib_table = htonl (t->fib_table);
246 rmp->vlan_index = htonl (t->vlan_index);
247 ip_address_encode (&t->next_hop, IP46_TYPE_ANY, &rmp->xconnect_nh_addr);
249 if (t->behavior == SR_BEHAVIOR_T || t->behavior == SR_BEHAVIOR_DT6)
250 rmp->xconnect_iface_or_vrf_table =
251 htonl (fib_table_get_table_id (t->sw_if_index, FIB_PROTOCOL_IP6));
252 else if (t->behavior == SR_BEHAVIOR_DT4)
253 rmp->xconnect_iface_or_vrf_table =
254 htonl (fib_table_get_table_id (t->sw_if_index, FIB_PROTOCOL_IP4));
256 rmp->xconnect_iface_or_vrf_table = htonl (t->sw_if_index);
258 rmp->context = context;
260 vl_api_send_msg (reg, (u8 *) rmp);
263 static void vl_api_sr_localsids_dump_t_handler
264 (vl_api_sr_localsids_dump_t * mp)
266 vl_api_registration_t *reg;
267 ip6_sr_main_t *sm = &sr_main;
268 ip6_sr_localsid_t *t;
270 reg = vl_api_client_index_to_registration (mp->client_index);
275 pool_foreach (t, sm->localsids,
277 send_sr_localsid_details(t, reg, mp->context);
282 static void send_sr_policies_details
283 (ip6_sr_policy_t * t, vl_api_registration_t * reg, u32 context)
285 vl_api_sr_policies_details_t *rmp;
286 ip6_sr_main_t *sm = &sr_main;
288 u32 *sl_index, slidx = 0;
289 ip6_sr_sl_t *segment_list = 0;
290 ip6_address_t *segment;
291 vl_api_srv6_sid_list_t *api_sid_list;
293 rmp = vl_msg_api_alloc (sizeof (*rmp) +
294 vec_len (t->segments_lists) *
295 sizeof (vl_api_srv6_sid_list_t));
298 vec_len (t->segments_lists) *
299 sizeof (vl_api_srv6_sid_list_t)));
301 rmp->_vl_msg_id = ntohs (VL_API_SR_POLICIES_DETAILS);
302 ip6_address_encode (&t->bsid, rmp->bsid);
303 rmp->is_encap = t->is_encap;
304 rmp->is_spray = t->type;
305 rmp->fib_table = htonl (t->fib_table);
306 rmp->num_sid_lists = vec_len (t->segments_lists);
308 /* Fill in all the segments lists */
309 vec_foreach (sl_index, t->segments_lists)
311 segment_list = pool_elt_at_index (sm->sid_lists, *sl_index);
313 api_sid_list = &rmp->sid_lists[sl_index - t->segments_lists];
315 api_sid_list->num_sids = vec_len (segment_list->segments);
316 api_sid_list->weight = htonl (segment_list->weight);
318 vec_foreach (segment, segment_list->segments)
320 ip6_address_encode (segment, api_sid_list->sids[slidx++]);
324 rmp->context = context;
325 vl_api_send_msg (reg, (u8 *) rmp);
329 vl_api_sr_policies_dump_t_handler (vl_api_sr_policies_dump_t * mp)
331 vl_api_registration_t *reg;
332 ip6_sr_main_t *sm = &sr_main;
335 reg = vl_api_client_index_to_registration (mp->client_index);
340 pool_foreach (t, sm->sr_policies,
342 send_sr_policies_details(t, reg, mp->context);
347 static void send_sr_steering_pol_details
348 (ip6_sr_steering_policy_t * t, vl_api_registration_t * reg, u32 context)
350 vl_api_sr_steering_pol_details_t *rmp;
351 ip6_sr_main_t *sm = &sr_main;
353 rmp = vl_msg_api_alloc (sizeof (*rmp));
354 clib_memset (rmp, 0, sizeof (*rmp));
355 rmp->_vl_msg_id = ntohs (VL_API_SR_STEERING_POL_DETAILS);
357 //Get the SR policy BSID
359 p = pool_elt_at_index (sm->sr_policies, t->sr_policy);
360 ip6_address_encode (&p->bsid, rmp->bsid);
363 rmp->traffic_type = t->classify.traffic_type;
364 rmp->fib_table = htonl (t->classify.l3.fib_table);
365 ip_address_encode (&t->classify.l3.prefix, IP46_TYPE_ANY,
366 &rmp->prefix.address);
367 rmp->prefix.len = htonl (t->classify.l3.mask_width);
369 rmp->sw_if_index = htonl (t->classify.l2.sw_if_index);
371 rmp->context = context;
372 vl_api_send_msg (reg, (u8 *) rmp);
375 static void vl_api_sr_steering_pol_dump_t_handler
376 (vl_api_sr_policies_dump_t * mp)
378 vl_api_registration_t *reg;
379 ip6_sr_main_t *sm = &sr_main;
380 ip6_sr_steering_policy_t *t;
382 reg = vl_api_client_index_to_registration (mp->client_index);
387 pool_foreach (t, sm->steer_policies,
389 send_sr_steering_pol_details(t, reg, mp->context);
396 * Add vpe's API message handlers to the table.
397 * vlib has already mapped shared memory and
398 * added the client registration handlers.
399 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
401 #define vl_msg_name_crc_list
402 #include <vnet/vnet_all_api_h.h>
403 #undef vl_msg_name_crc_list
406 setup_message_id_table (api_main_t * am)
408 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
409 foreach_vl_msg_name_crc_sr;
413 static clib_error_t *
414 sr_api_hookup (vlib_main_t * vm)
416 api_main_t *am = vlibapi_get_main ();
419 vl_msg_api_set_handlers(VL_API_##N, #n, \
420 vl_api_##n##_t_handler, \
422 vl_api_##n##_t_endian, \
423 vl_api_##n##_t_print, \
424 sizeof(vl_api_##n##_t), 1);
429 * Set up the (msg_name, crc, message-id) table
431 setup_message_id_table (am);
436 VLIB_API_INIT_FUNCTION (sr_api_hookup);
439 * fd.io coding-style-patch-verification: ON
442 * eval: (c-set-style "gnu")