2 *------------------------------------------------------------------
3 * mpls_api.c - mpls 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 <vlibmemory/api.h>
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/mpls/mpls.h>
26 #include <vnet/mpls/mpls_tunnel.h>
27 #include <vnet/fib/fib_table.h>
28 #include <vnet/fib/fib_api.h>
29 #include <vnet/fib/mpls_fib.h>
30 #include <vnet/fib/fib_path_list.h>
31 #include <vnet/ip/ip_types_api.h>
33 #include <vnet/vnet_msg_enum.h>
35 #define vl_typedefs /* define message structures */
36 #include <vnet/vnet_all_api_h.h>
39 #define vl_endianfun /* define message structures */
40 #include <vnet/vnet_all_api_h.h>
43 /* instantiate all the print functions we know about */
44 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
46 #include <vnet/vnet_all_api_h.h>
49 #include <vlibapi/api_helper_macros.h>
51 #define foreach_vpe_api_msg \
52 _(MPLS_IP_BIND_UNBIND, mpls_ip_bind_unbind) \
53 _(MPLS_ROUTE_ADD_DEL, mpls_route_add_del) \
54 _(MPLS_TABLE_ADD_DEL, mpls_table_add_del) \
55 _(MPLS_TUNNEL_ADD_DEL, mpls_tunnel_add_del) \
56 _(MPLS_TUNNEL_DUMP, mpls_tunnel_dump) \
57 _(SW_INTERFACE_SET_MPLS_ENABLE, sw_interface_set_mpls_enable) \
58 _(MPLS_TABLE_DUMP, mpls_table_dump) \
59 _(MPLS_ROUTE_DUMP, mpls_route_dump)
62 mpls_table_delete (u32 table_id, u8 is_api)
67 * The MPLS defult table must also be explicitly created via the API.
68 * So in contrast to IP, it gets no special treatment here.
70 * The API holds only one lock on the table.
71 * i.e. it can be added many times via the API but needs to be
74 fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
78 fib_table_unlock (fib_index,
80 (is_api ? FIB_SOURCE_API : FIB_SOURCE_CLI));
85 vl_api_mpls_table_add_del_t_handler (vl_api_mpls_table_add_del_t * mp)
87 vl_api_mpls_table_add_del_reply_t *rmp;
91 vnm = vnet_get_main ();
95 mpls_table_create (ntohl (mp->mt_table.mt_table_id),
96 1, mp->mt_table.mt_name);
98 mpls_table_delete (ntohl (mp->mt_table.mt_table_id), 1);
100 // NB: Nothing sets rv; none of the above returns an error
102 REPLY_MACRO (VL_API_MPLS_TABLE_ADD_DEL_REPLY);
106 mpls_ip_bind_unbind_handler (vnet_main_t * vnm,
107 vl_api_mpls_ip_bind_unbind_t * mp)
109 u32 mpls_fib_index, ip_fib_index;
113 fib_table_find (FIB_PROTOCOL_MPLS, ntohl (mp->mb_mpls_table_id));
115 if (~0 == mpls_fib_index)
117 return VNET_API_ERROR_NO_SUCH_FIB;
120 ip_prefix_decode (&mp->mb_prefix, &pfx);
122 ip_fib_index = fib_table_find (pfx.fp_proto, ntohl (mp->mb_ip_table_id));
123 if (~0 == ip_fib_index)
124 return VNET_API_ERROR_NO_SUCH_FIB;
127 fib_table_entry_local_label_add (ip_fib_index, &pfx,
128 ntohl (mp->mb_label));
130 fib_table_entry_local_label_remove (ip_fib_index, &pfx,
131 ntohl (mp->mb_label));
137 vl_api_mpls_ip_bind_unbind_t_handler (vl_api_mpls_ip_bind_unbind_t * mp)
139 vl_api_mpls_ip_bind_unbind_reply_t *rmp;
143 vnm = vnet_get_main ();
146 rv = mpls_ip_bind_unbind_handler (vnm, mp);
147 rv = (rv == 0) ? vnm->api_errno : rv;
149 REPLY_MACRO (VL_API_MPLS_IP_BIND_UNBIND_REPLY);
153 mpls_route_add_del_t_handler (vnet_main_t * vnm,
154 vl_api_mpls_route_add_del_t * mp,
157 fib_route_path_t *rpaths = NULL, *rpath;
158 vl_api_fib_path_t *apath;
164 .fp_proto = FIB_PROTOCOL_MPLS,
165 .fp_eos = mp->mr_route.mr_eos,
166 .fp_label = ntohl (mp->mr_route.mr_label),
170 pfx.fp_payload_proto = mp->mr_route.mr_eos_proto;
174 pfx.fp_payload_proto = DPO_PROTO_MPLS;
177 rv = fib_api_table_id_decode (FIB_PROTOCOL_MPLS,
178 ntohl (mp->mr_route.mr_table_id), &fib_index);
182 vec_validate (rpaths, mp->mr_route.mr_n_paths - 1);
184 for (ii = 0; ii < mp->mr_route.mr_n_paths; ii++)
186 apath = &mp->mr_route.mr_paths[ii];
189 rv = fib_api_path_decode (apath, rpath);
195 rv = fib_api_route_add_del (mp->mr_is_add,
199 (mp->mr_route.mr_is_multicast ?
200 FIB_ENTRY_FLAG_MULTICAST :
201 FIB_ENTRY_FLAG_NONE), rpaths);
203 if (mp->mr_is_add && 0 == rv)
204 *stats_index = fib_table_entry_get_stats_index (fib_index, &pfx);
213 vl_api_mpls_route_add_del_t_handler (vl_api_mpls_route_add_del_t * mp)
215 vl_api_mpls_route_add_del_reply_t *rmp;
220 vnm = vnet_get_main ();
223 rv = mpls_route_add_del_t_handler (vnm, mp, &stats_index);
226 REPLY_MACRO2 (VL_API_MPLS_ROUTE_ADD_DEL_REPLY,
228 rmp->stats_index = htonl (stats_index);
234 mpls_table_create (u32 table_id, u8 is_api, const u8 * name)
239 * The MPLS defult table must also be explicitly created via the API.
240 * So in contrast to IP, it gets no special treatment here.
244 * The API holds only one lock on the table.
245 * i.e. it can be added many times via the API but needs to be
248 fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
252 fib_table_find_or_create_and_lock_w_name (FIB_PROTOCOL_MPLS,
256 FIB_SOURCE_CLI), name);
261 vl_api_mpls_tunnel_add_del_t_handler (vl_api_mpls_tunnel_add_del_t * mp)
263 u32 tunnel_sw_if_index = ~0, tunnel_index = ~0;
264 vl_api_mpls_tunnel_add_del_reply_t *rmp;
265 fib_route_path_t *rpath, *rpaths = NULL;
268 vec_validate (rpaths, mp->mt_tunnel.mt_n_paths - 1);
270 for (ii = 0; ii < mp->mt_tunnel.mt_n_paths; ii++)
274 rv = fib_api_path_decode (&mp->mt_tunnel.mt_paths[ii], rpath);
279 tunnel_sw_if_index = ntohl (mp->mt_tunnel.mt_sw_if_index);
283 if (~0 == tunnel_sw_if_index)
285 vnet_mpls_tunnel_create (mp->mt_tunnel.mt_l2_only,
286 mp->mt_tunnel.mt_is_multicast,
287 mp->mt_tunnel.mt_tag);
288 vnet_mpls_tunnel_path_add (tunnel_sw_if_index, rpaths);
290 tunnel_index = vnet_mpls_tunnel_get_index (tunnel_sw_if_index);
294 tunnel_index = vnet_mpls_tunnel_get_index (tunnel_sw_if_index);
295 tunnel_sw_if_index = ntohl (mp->mt_tunnel.mt_sw_if_index);
296 if (!vnet_mpls_tunnel_path_remove (tunnel_sw_if_index, rpaths))
297 vnet_mpls_tunnel_del (tunnel_sw_if_index);
304 REPLY_MACRO2(VL_API_MPLS_TUNNEL_ADD_DEL_REPLY,
306 rmp->sw_if_index = ntohl(tunnel_sw_if_index);
307 rmp->tunnel_index = ntohl(tunnel_index);
313 vl_api_sw_interface_set_mpls_enable_t_handler
314 (vl_api_sw_interface_set_mpls_enable_t * mp)
316 vl_api_sw_interface_set_mpls_enable_reply_t *rmp;
319 VALIDATE_SW_IF_INDEX (mp);
321 rv = mpls_sw_interface_enable_disable (&mpls_main,
322 ntohl (mp->sw_if_index),
325 BAD_SW_IF_INDEX_LABEL;
326 REPLY_MACRO (VL_API_SW_INTERFACE_SET_MPLS_ENABLE_REPLY);
329 typedef struct mpls_tunnel_send_walk_ctx_t_
331 vl_api_registration_t *reg;
334 } mpls_tunnel_send_walk_ctx_t;
337 send_mpls_tunnel_entry (u32 mti, void *arg)
339 mpls_tunnel_send_walk_ctx_t *ctx;
340 vl_api_mpls_tunnel_details_t *mp;
341 fib_path_encode_ctx_t path_ctx = {
344 const mpls_tunnel_t *mt;
345 fib_route_path_t *rpath;
346 vl_api_fib_path_t *fp;
351 mt = mpls_tunnel_get (mti);
353 if (~0 != ctx->sw_if_index && mt->mt_sw_if_index != ctx->sw_if_index)
356 n = fib_path_list_get_n_paths (mt->mt_path_list);
358 mp = vl_msg_api_alloc (sizeof (*mp) + n * sizeof (vl_api_fib_path_t));
359 clib_memset (mp, 0, sizeof (*mp) + n * sizeof (vl_api_fib_path_t));
361 mp->_vl_msg_id = ntohs (VL_API_MPLS_TUNNEL_DETAILS);
362 mp->context = ctx->context;
364 mp->mt_tunnel.mt_n_paths = n;
365 mp->mt_tunnel.mt_sw_if_index = ntohl (mt->mt_sw_if_index);
366 mp->mt_tunnel.mt_tunnel_index = ntohl (mti);
367 mp->mt_tunnel.mt_l2_only = ! !(MPLS_TUNNEL_FLAG_L2 & mt->mt_flags);
368 mp->mt_tunnel.mt_is_multicast = ! !(MPLS_TUNNEL_FLAG_MCAST & mt->mt_flags);
369 memcpy (mp->mt_tunnel.mt_tag, mt->mt_tag, sizeof (mp->mt_tunnel.mt_tag));
371 fib_path_list_walk_w_ext (mt->mt_path_list,
372 &mt->mt_path_exts, fib_path_encode, &path_ctx);
374 fp = mp->mt_tunnel.mt_paths;
375 vec_foreach (rpath, path_ctx.rpaths)
377 fib_api_path_encode (rpath, fp);
381 vl_api_send_msg (ctx->reg, (u8 *) mp);
383 vec_free (path_ctx.rpaths);
387 vl_api_mpls_tunnel_dump_t_handler (vl_api_mpls_tunnel_dump_t * mp)
389 vl_api_registration_t *reg;
391 reg = vl_api_client_index_to_registration (mp->client_index);
395 mpls_tunnel_send_walk_ctx_t ctx = {
397 .sw_if_index = ntohl (mp->sw_if_index),
398 .context = mp->context,
400 mpls_tunnel_walk (send_mpls_tunnel_entry, &ctx);
404 send_mpls_table_details (vpe_api_main_t * am,
405 vl_api_registration_t * reg,
406 u32 context, const fib_table_t * table)
408 vl_api_mpls_table_details_t *mp;
410 mp = vl_msg_api_alloc (sizeof (*mp));
411 memset (mp, 0, sizeof (*mp));
412 mp->_vl_msg_id = ntohs (VL_API_MPLS_TABLE_DETAILS);
413 mp->context = context;
415 mp->mt_table.mt_table_id = htonl (table->ft_table_id);
416 memcpy (mp->mt_table.mt_name,
418 clib_min (vec_len (table->ft_desc), sizeof (mp->mt_table.mt_name)));
420 vl_api_send_msg (reg, (u8 *) mp);
424 vl_api_mpls_table_dump_t_handler (vl_api_mpls_table_dump_t * mp)
426 vpe_api_main_t *am = &vpe_api_main;
427 vl_api_registration_t *reg;
428 mpls_main_t *mm = &mpls_main;
429 fib_table_t *fib_table;
431 reg = vl_api_client_index_to_registration (mp->client_index);
436 pool_foreach (fib_table, mm->fibs,
438 send_mpls_table_details(am, reg, mp->context, fib_table);
444 send_mpls_route_details (vpe_api_main_t * am,
445 vl_api_registration_t * reg,
446 u32 context, fib_node_index_t fib_entry_index)
448 fib_route_path_t *rpaths, *rpath;
449 vl_api_mpls_route_details_t *mp;
450 const fib_prefix_t *pfx;
451 vl_api_fib_path_t *fp;
454 rpaths = fib_entry_encode (fib_entry_index);
455 pfx = fib_entry_get_prefix (fib_entry_index);
457 path_count = vec_len (rpaths);
458 mp = vl_msg_api_alloc (sizeof (*mp) + path_count * sizeof (*fp));
461 clib_memset (mp, 0, sizeof (*mp));
462 mp->_vl_msg_id = ntohs (VL_API_MPLS_ROUTE_DETAILS);
463 mp->context = context;
465 mp->mr_route.mr_table_id =
466 htonl (fib_table_get_table_id
467 (fib_entry_get_fib_index (fib_entry_index), pfx->fp_proto));
468 mp->mr_route.mr_eos = pfx->fp_eos;
469 mp->mr_route.mr_eos_proto = pfx->fp_payload_proto;
470 mp->mr_route.mr_label = htonl (pfx->fp_label);
472 mp->mr_route.mr_n_paths = path_count;
473 fp = mp->mr_route.mr_paths;
474 vec_foreach (rpath, rpaths)
476 fib_api_path_encode (rpath, fp);
481 vl_api_send_msg (reg, (u8 *) mp);
484 typedef struct vl_api_mpls_route_dump_table_walk_ctx_t_
486 fib_node_index_t *lfeis;
487 } vl_api_mpls_route_dump_table_walk_ctx_t;
489 static fib_table_walk_rc_t
490 vl_api_mpls_route_dump_table_walk (fib_node_index_t fei, void *arg)
492 vl_api_mpls_route_dump_table_walk_ctx_t *ctx = arg;
494 vec_add1 (ctx->lfeis, fei);
496 return (FIB_TABLE_WALK_CONTINUE);
500 vl_api_mpls_route_dump_t_handler (vl_api_mpls_route_dump_t * mp)
502 vpe_api_main_t *am = &vpe_api_main;
503 vl_api_registration_t *reg;
504 fib_node_index_t *lfeip = NULL;
505 vl_api_mpls_route_dump_table_walk_ctx_t ctx = {
510 reg = vl_api_client_index_to_registration (mp->client_index);
514 fib_index = fib_table_find (FIB_PROTOCOL_MPLS,
515 ntohl (mp->table.mt_table_id));
517 if (INDEX_INVALID != fib_index)
519 fib_table_walk (fib_index,
521 vl_api_mpls_route_dump_table_walk, &ctx);
522 vec_sort_with_function (ctx.lfeis, fib_entry_cmp_for_sort);
524 vec_foreach (lfeip, ctx.lfeis)
526 send_mpls_route_details (am, reg, mp->context, *lfeip);
529 vec_free (ctx.lfeis);
535 * Add vpe's API message handlers to the table.
536 * vlib has already mapped shared memory and
537 * added the client registration handlers.
538 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
540 #define vl_msg_name_crc_list
541 #include <vnet/vnet_all_api_h.h>
542 #undef vl_msg_name_crc_list
545 setup_message_id_table (api_main_t * am)
547 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
548 foreach_vl_msg_name_crc_mpls;
552 static clib_error_t *
553 mpls_api_hookup (vlib_main_t * vm)
555 api_main_t *am = vlibapi_get_main ();
558 vl_msg_api_set_handlers(VL_API_##N, #n, \
559 vl_api_##n##_t_handler, \
561 vl_api_##n##_t_endian, \
562 vl_api_##n##_t_print, \
563 sizeof(vl_api_##n##_t), 1);
568 * Trace space for 8 MPLS encap labels
570 am->api_trace_cfg[VL_API_MPLS_TUNNEL_ADD_DEL].size += 8 * sizeof (u32);
573 * Set up the (msg_name, crc, message-id) table
575 setup_message_id_table (am);
580 VLIB_API_INIT_FUNCTION (mpls_api_hookup);
583 * fd.io coding-style-patch-verification: ON
586 * eval: (c-set-style "gnu")