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/vnet_msg_enum.h>
31 #define vl_typedefs /* define message structures */
32 #include <vnet/vnet_all_api_h.h>
35 #define vl_endianfun /* define message structures */
36 #include <vnet/vnet_all_api_h.h>
39 /* instantiate all the print functions we know about */
40 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
42 #include <vnet/vnet_all_api_h.h>
45 #include <vlibapi/api_helper_macros.h>
47 #define foreach_vpe_api_msg \
48 _(SR_LOCALSID_ADD_DEL, sr_localsid_add_del) \
49 _(SR_POLICY_ADD, sr_policy_add) \
50 _(SR_POLICY_MOD, sr_policy_mod) \
51 _(SR_POLICY_DEL, sr_policy_del) \
52 _(SR_STEERING_ADD_DEL, sr_steering_add_del) \
53 _(SR_SET_ENCAP_SOURCE, sr_set_encap_source) \
54 _(SR_SET_ENCAP_HOP_LIMIT, sr_set_encap_hop_limit) \
55 _(SR_LOCALSIDS_DUMP, sr_localsids_dump) \
56 _(SR_POLICIES_DUMP, sr_policies_dump) \
57 _(SR_STEERING_POL_DUMP, sr_steering_pol_dump)
59 static void vl_api_sr_localsid_add_del_t_handler
60 (vl_api_sr_localsid_add_del_t * mp)
62 vl_api_sr_localsid_add_del_reply_t *rmp;
65 * int sr_cli_localsid (char is_del, ip6_address_t *localsid_addr,
66 * char end_psp, u8 behavior, u32 sw_if_index, u32 vlan_index, u32 fib_table,
67 * ip46_address_t *nh_addr, void *ls_plugin_mem)
69 if (mp->behavior == SR_BEHAVIOR_X ||
70 mp->behavior == SR_BEHAVIOR_DX6 ||
71 mp->behavior == SR_BEHAVIOR_DX4 || mp->behavior == SR_BEHAVIOR_DX2)
72 VALIDATE_SW_IF_INDEX (mp);
74 ip46_address_t prefix;
76 clib_memset (&prefix, 0, sizeof (ip46_address_t));
77 if ((mp->nh_addr4[0] | mp->nh_addr4[1] | mp->
78 nh_addr4[2] | mp->nh_addr4[3]) != 0)
79 memcpy (&prefix.ip4, mp->nh_addr4, sizeof (prefix.ip4));
81 memcpy (&prefix.ip6, mp->nh_addr6, sizeof (prefix.ip6));
83 rv = sr_cli_localsid (mp->is_del,
84 (ip6_address_t *) & mp->localsid, 0,
87 ntohl (mp->sw_if_index),
88 ntohl (mp->vlan_index),
89 ntohl (mp->fib_table), &prefix, NULL);
91 BAD_SW_IF_INDEX_LABEL;
92 REPLY_MACRO (VL_API_SR_LOCALSID_ADD_DEL_REPLY);
96 vl_api_sr_policy_add_t_handler (vl_api_sr_policy_add_t * mp)
98 vl_api_sr_policy_add_reply_t *rmp;
99 ip6_address_t *segments = 0, *seg;
100 ip6_address_t *this_address = (ip6_address_t *) mp->sids.sids;
103 for (i = 0; i < mp->sids.num_sids; i++)
105 vec_add2 (segments, seg, 1);
106 clib_memcpy (seg->as_u8, this_address->as_u8, sizeof (*this_address));
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 ((ip6_address_t *) & mp->bsid_addr,
118 ntohl (mp->sids.weight),
119 mp->type, ntohl (mp->fib_table), mp->is_encap, 0, NULL);
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;
130 ip6_address_t *segments = 0, *seg;
131 ip6_address_t *this_address = (ip6_address_t *) mp->sids.sids;
134 for (i = 0; i < mp->sids.num_sids; i++)
136 vec_add2 (segments, seg, 1);
137 clib_memcpy (seg->as_u8, this_address->as_u8, sizeof (*this_address));
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 ((ip6_address_t *) & mp->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;
166 * sr_policy_del (ip6_address_t *bsid, u32 index)
168 rv = sr_policy_del ((ip6_address_t *) & mp->bsid_addr,
169 ntohl (mp->sr_policy_index));
171 REPLY_MACRO (VL_API_SR_POLICY_DEL_REPLY);
175 vl_api_sr_set_encap_source_t_handler (vl_api_sr_set_encap_source_t * mp)
177 vl_api_sr_set_encap_source_reply_t *rmp;
179 sr_set_source ((ip6_address_t *) & mp->encaps_source);
181 REPLY_MACRO (VL_API_SR_SET_ENCAP_SOURCE_REPLY);
185 vl_api_sr_set_encap_hop_limit_t_handler (vl_api_sr_set_encap_hop_limit_t * mp)
187 vl_api_sr_set_encap_hop_limit_reply_t *rmp;
190 if (mp->hop_limit == 0)
191 rv = VNET_API_ERROR_INVALID_VALUE;
193 sr_set_hop_limit (mp->hop_limit);
195 REPLY_MACRO (VL_API_SR_SET_ENCAP_HOP_LIMIT_REPLY);
198 static void vl_api_sr_steering_add_del_t_handler
199 (vl_api_sr_steering_add_del_t * mp)
201 vl_api_sr_steering_add_del_reply_t *rmp;
205 * sr_steering_policy(int is_del, ip6_address_t *bsid, u32 sr_policy_index,
206 * u32 table_id, ip46_address_t *prefix, u32 mask_width, u32 sw_if_index,
209 if (mp->traffic_type == SR_STEER_L2)
210 VALIDATE_SW_IF_INDEX (mp);
212 rv = sr_steering_policy (mp->is_del,
213 (ip6_address_t *) & mp->bsid_addr,
214 ntohl (mp->sr_policy_index),
215 ntohl (mp->table_id),
216 (ip46_address_t *) & mp->prefix_addr,
217 ntohl (mp->mask_width),
218 ntohl (mp->sw_if_index), mp->traffic_type);
220 BAD_SW_IF_INDEX_LABEL;
221 REPLY_MACRO (VL_API_SR_STEERING_ADD_DEL_REPLY);
224 static void send_sr_localsid_details
225 (ip6_sr_localsid_t * t, vl_api_registration_t * reg, u32 context)
227 vl_api_sr_localsids_details_t *rmp;
229 rmp = vl_msg_api_alloc (sizeof (*rmp));
230 clib_memset (rmp, 0, sizeof (*rmp));
231 rmp->_vl_msg_id = ntohs (VL_API_SR_LOCALSIDS_DETAILS);
232 clib_memcpy (rmp->addr.addr, &t->localsid, sizeof (ip6_address_t));
233 rmp->end_psp = t->end_psp;
234 rmp->behavior = htons (t->behavior);
235 rmp->fib_table = htonl (t->fib_table);
236 rmp->vlan_index = htonl (t->vlan_index);
237 if (ip46_address_is_ip4 (&t->next_hop))
238 clib_memcpy (rmp->xconnect_nh_addr4, &t->next_hop.ip4,
239 sizeof (ip4_address_t));
241 clib_memcpy (rmp->xconnect_nh_addr6, &t->next_hop.ip6,
242 sizeof (ip6_address_t));
244 if (t->behavior == SR_BEHAVIOR_T || t->behavior == SR_BEHAVIOR_DT6)
245 rmp->xconnect_iface_or_vrf_table =
246 htonl (fib_table_get_table_id (t->sw_if_index, FIB_PROTOCOL_IP6));
247 else if (t->behavior == SR_BEHAVIOR_DT4)
248 rmp->xconnect_iface_or_vrf_table =
249 htonl (fib_table_get_table_id (t->sw_if_index, FIB_PROTOCOL_IP4));
251 rmp->xconnect_iface_or_vrf_table = htonl (t->sw_if_index);
253 rmp->context = context;
255 vl_api_send_msg (reg, (u8 *) rmp);
258 static void vl_api_sr_localsids_dump_t_handler
259 (vl_api_sr_localsids_dump_t * mp)
261 vl_api_registration_t *reg;
262 ip6_sr_main_t *sm = &sr_main;
263 ip6_sr_localsid_t *t;
265 reg = vl_api_client_index_to_registration (mp->client_index);
270 pool_foreach (t, sm->localsids,
272 send_sr_localsid_details(t, reg, mp->context);
277 static void send_sr_policies_details
278 (ip6_sr_policy_t * t, vl_api_registration_t * reg, u32 context)
280 vl_api_sr_policies_details_t *rmp;
281 ip6_sr_main_t *sm = &sr_main;
284 ip6_sr_sl_t *segment_list = 0;
285 vl_api_srv6_sid_list_t *write_sid_list;
287 rmp = vl_msg_api_alloc (sizeof (*rmp) +
288 vec_len (t->segments_lists) *
289 sizeof (vl_api_srv6_sid_list_t));
292 vec_len (t->segments_lists) *
293 sizeof (vl_api_srv6_sid_list_t)));
295 rmp->_vl_msg_id = ntohs (VL_API_SR_POLICIES_DETAILS);
296 clib_memcpy (rmp->bsid.addr, &t->bsid, sizeof (ip6_address_t));
297 rmp->is_encap = t->is_encap;
299 rmp->fib_table = htonl (t->fib_table);
300 rmp->num_sid_lists = vec_len (t->segments_lists);
302 /* Fill in all the segments lists */
303 vec_foreach (sl_index, t->segments_lists)
305 segment_list = pool_elt_at_index (sm->sid_lists, *sl_index);
306 write_sid_list = &rmp->sid_lists[sl_index - t->segments_lists];
307 write_sid_list->num_sids = vec_len (segment_list->segments);
308 write_sid_list->weight = htonl (segment_list->weight);
309 clib_memcpy (write_sid_list->sids, segment_list->segments,
310 vec_len (segment_list->segments) * sizeof (ip6_address_t));
313 rmp->context = context;
314 vl_api_send_msg (reg, (u8 *) rmp);
318 vl_api_sr_policies_dump_t_handler (vl_api_sr_policies_dump_t * mp)
320 vl_api_registration_t *reg;
321 ip6_sr_main_t *sm = &sr_main;
324 reg = vl_api_client_index_to_registration (mp->client_index);
329 pool_foreach (t, sm->sr_policies,
331 send_sr_policies_details(t, reg, mp->context);
336 static void send_sr_steering_pol_details
337 (ip6_sr_steering_policy_t * t, vl_api_registration_t * reg, u32 context)
339 vl_api_sr_steering_pol_details_t *rmp;
340 ip6_sr_main_t *sm = &sr_main;
342 rmp = vl_msg_api_alloc (sizeof (*rmp));
343 clib_memset (rmp, 0, sizeof (*rmp));
344 rmp->_vl_msg_id = ntohs (VL_API_SR_STEERING_POL_DETAILS);
346 //Get the SR policy BSID
348 p = pool_elt_at_index (sm->sr_policies, t->sr_policy);
349 clib_memcpy (rmp->bsid.addr, &p->bsid, sizeof (ip6_address_t));
352 rmp->traffic_type = t->classify.traffic_type;
353 rmp->fib_table = htonl (t->classify.l3.fib_table);
354 rmp->mask_width = htonl (t->classify.l3.mask_width);
355 if (ip46_address_is_ip4 (&t->classify.l3.prefix))
356 clib_memcpy (rmp->prefix_addr, &t->classify.l3.prefix.ip4,
357 sizeof (ip4_address_t));
359 clib_memcpy (rmp->prefix_addr, &t->classify.l3.prefix.ip6,
360 sizeof (ip6_address_t));
362 rmp->sw_if_index = htonl (t->classify.l2.sw_if_index);
364 rmp->context = context;
365 vl_api_send_msg (reg, (u8 *) rmp);
368 static void vl_api_sr_steering_pol_dump_t_handler
369 (vl_api_sr_policies_dump_t * mp)
371 vl_api_registration_t *reg;
372 ip6_sr_main_t *sm = &sr_main;
373 ip6_sr_steering_policy_t *t;
375 reg = vl_api_client_index_to_registration (mp->client_index);
380 pool_foreach (t, sm->steer_policies,
382 send_sr_steering_pol_details(t, reg, mp->context);
389 * Add vpe's API message handlers to the table.
390 * vlib has already mapped shared memory and
391 * added the client registration handlers.
392 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
394 #define vl_msg_name_crc_list
395 #include <vnet/vnet_all_api_h.h>
396 #undef vl_msg_name_crc_list
399 setup_message_id_table (api_main_t * am)
401 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
402 foreach_vl_msg_name_crc_sr;
406 static clib_error_t *
407 sr_api_hookup (vlib_main_t * vm)
409 api_main_t *am = vlibapi_get_main ();
412 vl_msg_api_set_handlers(VL_API_##N, #n, \
413 vl_api_##n##_t_handler, \
415 vl_api_##n##_t_endian, \
416 vl_api_##n##_t_print, \
417 sizeof(vl_api_##n##_t), 1);
422 * Set up the (msg_name, crc, message-id) table
424 setup_message_id_table (am);
429 VLIB_API_INIT_FUNCTION (sr_api_hookup);
432 * fd.io coding-style-patch-verification: ON
435 * eval: (c-set-style "gnu")