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/format_fns.h>
34 #include <vnet/mpls/mpls.api_enum.h>
35 #include <vnet/mpls/mpls.api_types.h>
37 #define REPLY_MSG_ID_BASE mpls_main.msg_id_base
38 #include <vlibapi/api_helper_macros.h>
41 mpls_table_delete (u32 table_id, u8 is_api)
46 * The MPLS defult table must also be explicitly created via the API.
47 * So in contrast to IP, it gets no special treatment here.
49 * The API holds only one lock on the table.
50 * i.e. it can be added many times via the API but needs to be
53 fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
57 fib_table_unlock (fib_index,
59 (is_api ? FIB_SOURCE_API : FIB_SOURCE_CLI));
64 vl_api_mpls_table_add_del_t_handler (vl_api_mpls_table_add_del_t * mp)
66 vl_api_mpls_table_add_del_reply_t *rmp;
70 vnm = vnet_get_main ();
74 mpls_table_create (ntohl (mp->mt_table.mt_table_id),
75 1, mp->mt_table.mt_name);
77 mpls_table_delete (ntohl (mp->mt_table.mt_table_id), 1);
79 // NB: Nothing sets rv; none of the above returns an error
81 REPLY_MACRO (VL_API_MPLS_TABLE_ADD_DEL_REPLY);
85 mpls_ip_bind_unbind_handler (vnet_main_t * vnm,
86 vl_api_mpls_ip_bind_unbind_t * mp)
88 u32 mpls_fib_index, ip_fib_index;
92 fib_table_find (FIB_PROTOCOL_MPLS, ntohl (mp->mb_mpls_table_id));
94 if (~0 == mpls_fib_index)
96 return VNET_API_ERROR_NO_SUCH_FIB;
99 ip_prefix_decode (&mp->mb_prefix, &pfx);
101 ip_fib_index = fib_table_find (pfx.fp_proto, ntohl (mp->mb_ip_table_id));
102 if (~0 == ip_fib_index)
103 return VNET_API_ERROR_NO_SUCH_FIB;
106 fib_table_entry_local_label_add (ip_fib_index, &pfx,
107 ntohl (mp->mb_label));
109 fib_table_entry_local_label_remove (ip_fib_index, &pfx,
110 ntohl (mp->mb_label));
116 vl_api_mpls_ip_bind_unbind_t_handler (vl_api_mpls_ip_bind_unbind_t * mp)
118 vl_api_mpls_ip_bind_unbind_reply_t *rmp;
122 vnm = vnet_get_main ();
125 rv = mpls_ip_bind_unbind_handler (vnm, mp);
126 rv = (rv == 0) ? vnm->api_errno : rv;
128 REPLY_MACRO (VL_API_MPLS_IP_BIND_UNBIND_REPLY);
132 mpls_route_add_del_t_handler (vnet_main_t * vnm,
133 vl_api_mpls_route_add_del_t * mp,
136 fib_route_path_t *rpaths = NULL, *rpath;
137 vl_api_fib_path_t *apath;
143 .fp_proto = FIB_PROTOCOL_MPLS,
144 .fp_eos = mp->mr_route.mr_eos,
145 .fp_label = ntohl (mp->mr_route.mr_label),
149 pfx.fp_payload_proto = mp->mr_route.mr_eos_proto;
153 pfx.fp_payload_proto = DPO_PROTO_MPLS;
156 rv = fib_api_table_id_decode (FIB_PROTOCOL_MPLS,
157 ntohl (mp->mr_route.mr_table_id), &fib_index);
161 vec_validate (rpaths, mp->mr_route.mr_n_paths - 1);
163 for (ii = 0; ii < mp->mr_route.mr_n_paths; ii++)
165 apath = &mp->mr_route.mr_paths[ii];
168 rv = fib_api_path_decode (apath, rpath);
174 rv = fib_api_route_add_del (
175 mp->mr_is_add, mp->mr_is_multipath, fib_index, &pfx, FIB_SOURCE_API,
176 (mp->mr_route.mr_is_multicast ? FIB_ENTRY_FLAG_MULTICAST :
177 FIB_ENTRY_FLAG_NONE),
180 if (mp->mr_is_add && 0 == rv)
181 *stats_index = fib_table_entry_get_stats_index (fib_index, &pfx);
190 vl_api_mpls_route_add_del_t_handler (vl_api_mpls_route_add_del_t * mp)
192 vl_api_mpls_route_add_del_reply_t *rmp;
197 vnm = vnet_get_main ();
200 rv = mpls_route_add_del_t_handler (vnm, mp, &stats_index);
203 REPLY_MACRO2 (VL_API_MPLS_ROUTE_ADD_DEL_REPLY,
205 rmp->stats_index = htonl (stats_index);
211 mpls_table_create (u32 table_id, u8 is_api, const u8 * name)
216 * The MPLS defult table must also be explicitly created via the API.
217 * So in contrast to IP, it gets no special treatment here.
221 * The API holds only one lock on the table.
222 * i.e. it can be added many times via the API but needs to be
225 fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
229 fib_table_find_or_create_and_lock_w_name (FIB_PROTOCOL_MPLS,
233 FIB_SOURCE_CLI), name);
238 vl_api_mpls_tunnel_add_del_t_handler (vl_api_mpls_tunnel_add_del_t * mp)
240 u32 tunnel_sw_if_index = ~0, tunnel_index = ~0;
241 vl_api_mpls_tunnel_add_del_reply_t *rmp;
242 fib_route_path_t *rpath, *rpaths = NULL;
245 vec_validate (rpaths, mp->mt_tunnel.mt_n_paths - 1);
247 for (ii = 0; ii < mp->mt_tunnel.mt_n_paths; ii++)
251 rv = fib_api_path_decode (&mp->mt_tunnel.mt_paths[ii], rpath);
256 tunnel_sw_if_index = ntohl (mp->mt_tunnel.mt_sw_if_index);
260 if (~0 == tunnel_sw_if_index)
262 vnet_mpls_tunnel_create (mp->mt_tunnel.mt_l2_only,
263 mp->mt_tunnel.mt_is_multicast,
264 mp->mt_tunnel.mt_tag);
265 vnet_mpls_tunnel_path_add (tunnel_sw_if_index, rpaths);
267 tunnel_index = vnet_mpls_tunnel_get_index (tunnel_sw_if_index);
271 tunnel_index = vnet_mpls_tunnel_get_index (tunnel_sw_if_index);
272 tunnel_sw_if_index = ntohl (mp->mt_tunnel.mt_sw_if_index);
273 if (!vnet_mpls_tunnel_path_remove (tunnel_sw_if_index, rpaths))
274 vnet_mpls_tunnel_del (tunnel_sw_if_index);
281 REPLY_MACRO2(VL_API_MPLS_TUNNEL_ADD_DEL_REPLY,
283 rmp->sw_if_index = ntohl(tunnel_sw_if_index);
284 rmp->tunnel_index = ntohl(tunnel_index);
290 vl_api_sw_interface_set_mpls_enable_t_handler
291 (vl_api_sw_interface_set_mpls_enable_t * mp)
293 vl_api_sw_interface_set_mpls_enable_reply_t *rmp;
296 VALIDATE_SW_IF_INDEX (mp);
298 rv = mpls_sw_interface_enable_disable (&mpls_main,
299 ntohl (mp->sw_if_index),
302 BAD_SW_IF_INDEX_LABEL;
303 REPLY_MACRO (VL_API_SW_INTERFACE_SET_MPLS_ENABLE_REPLY);
306 typedef struct mpls_tunnel_send_walk_ctx_t_
308 vl_api_registration_t *reg;
311 } mpls_tunnel_send_walk_ctx_t;
314 send_mpls_tunnel_entry (u32 mti, void *arg)
316 mpls_tunnel_send_walk_ctx_t *ctx;
317 vl_api_mpls_tunnel_details_t *mp;
318 fib_path_encode_ctx_t path_ctx = {
321 const mpls_tunnel_t *mt;
322 fib_route_path_t *rpath;
323 vl_api_fib_path_t *fp;
328 mt = mpls_tunnel_get (mti);
330 if (~0 != ctx->sw_if_index && mt->mt_sw_if_index != ctx->sw_if_index)
333 n = fib_path_list_get_n_paths (mt->mt_path_list);
335 mp = vl_msg_api_alloc (sizeof (*mp) + n * sizeof (vl_api_fib_path_t));
336 clib_memset (mp, 0, sizeof (*mp) + n * sizeof (vl_api_fib_path_t));
338 mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_MPLS_TUNNEL_DETAILS);
339 mp->context = ctx->context;
341 mp->mt_tunnel.mt_n_paths = n;
342 mp->mt_tunnel.mt_sw_if_index = ntohl (mt->mt_sw_if_index);
343 mp->mt_tunnel.mt_tunnel_index = ntohl (mti);
344 mp->mt_tunnel.mt_l2_only = ! !(MPLS_TUNNEL_FLAG_L2 & mt->mt_flags);
345 mp->mt_tunnel.mt_is_multicast = ! !(MPLS_TUNNEL_FLAG_MCAST & mt->mt_flags);
346 memcpy (mp->mt_tunnel.mt_tag, mt->mt_tag, sizeof (mp->mt_tunnel.mt_tag));
348 fib_path_list_walk_w_ext (mt->mt_path_list,
349 &mt->mt_path_exts, fib_path_encode, &path_ctx);
351 fp = mp->mt_tunnel.mt_paths;
352 vec_foreach (rpath, path_ctx.rpaths)
354 fib_api_path_encode (rpath, fp);
358 vl_api_send_msg (ctx->reg, (u8 *) mp);
360 vec_free (path_ctx.rpaths);
364 vl_api_mpls_tunnel_dump_t_handler (vl_api_mpls_tunnel_dump_t * mp)
366 vl_api_registration_t *reg;
368 reg = vl_api_client_index_to_registration (mp->client_index);
372 mpls_tunnel_send_walk_ctx_t ctx = {
374 .sw_if_index = ntohl (mp->sw_if_index),
375 .context = mp->context,
377 mpls_tunnel_walk (send_mpls_tunnel_entry, &ctx);
381 send_mpls_table_details (vpe_api_main_t * am,
382 vl_api_registration_t * reg,
383 u32 context, const fib_table_t * table)
385 vl_api_mpls_table_details_t *mp;
387 mp = vl_msg_api_alloc (sizeof (*mp));
388 memset (mp, 0, sizeof (*mp));
389 mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_MPLS_TABLE_DETAILS);
390 mp->context = context;
392 mp->mt_table.mt_table_id = htonl (table->ft_table_id);
393 memcpy (mp->mt_table.mt_name,
395 clib_min (vec_len (table->ft_desc), sizeof (mp->mt_table.mt_name)));
397 vl_api_send_msg (reg, (u8 *) mp);
401 vl_api_mpls_table_dump_t_handler (vl_api_mpls_table_dump_t * mp)
403 vpe_api_main_t *am = &vpe_api_main;
404 vl_api_registration_t *reg;
405 mpls_main_t *mm = &mpls_main;
406 fib_table_t *fib_table;
408 reg = vl_api_client_index_to_registration (mp->client_index);
413 pool_foreach (fib_table, mm->fibs)
415 send_mpls_table_details(am, reg, mp->context, fib_table);
421 send_mpls_route_details (vpe_api_main_t * am,
422 vl_api_registration_t * reg,
423 u32 context, fib_node_index_t fib_entry_index)
425 fib_route_path_t *rpaths, *rpath;
426 vl_api_mpls_route_details_t *mp;
427 const fib_prefix_t *pfx;
428 vl_api_fib_path_t *fp;
431 rpaths = fib_entry_encode (fib_entry_index);
432 pfx = fib_entry_get_prefix (fib_entry_index);
434 path_count = vec_len (rpaths);
435 mp = vl_msg_api_alloc (sizeof (*mp) + path_count * sizeof (*fp));
438 clib_memset (mp, 0, sizeof (*mp));
439 mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_MPLS_ROUTE_DETAILS);
440 mp->context = context;
442 mp->mr_route.mr_table_id =
443 htonl (fib_table_get_table_id
444 (fib_entry_get_fib_index (fib_entry_index), pfx->fp_proto));
445 mp->mr_route.mr_eos = pfx->fp_eos;
446 mp->mr_route.mr_eos_proto = pfx->fp_payload_proto;
447 mp->mr_route.mr_label = htonl (pfx->fp_label);
449 mp->mr_route.mr_n_paths = path_count;
450 fp = mp->mr_route.mr_paths;
451 vec_foreach (rpath, rpaths)
453 fib_api_path_encode (rpath, fp);
458 vl_api_send_msg (reg, (u8 *) mp);
461 typedef struct vl_api_mpls_route_dump_table_walk_ctx_t_
463 fib_node_index_t *lfeis;
464 } vl_api_mpls_route_dump_table_walk_ctx_t;
466 static fib_table_walk_rc_t
467 vl_api_mpls_route_dump_table_walk (fib_node_index_t fei, void *arg)
469 vl_api_mpls_route_dump_table_walk_ctx_t *ctx = arg;
471 vec_add1 (ctx->lfeis, fei);
473 return (FIB_TABLE_WALK_CONTINUE);
477 vl_api_mpls_route_dump_t_handler (vl_api_mpls_route_dump_t * mp)
479 vpe_api_main_t *am = &vpe_api_main;
480 vl_api_registration_t *reg;
481 fib_node_index_t *lfeip = NULL;
482 vl_api_mpls_route_dump_table_walk_ctx_t ctx = {
487 reg = vl_api_client_index_to_registration (mp->client_index);
491 fib_index = fib_table_find (FIB_PROTOCOL_MPLS,
492 ntohl (mp->table.mt_table_id));
494 if (INDEX_INVALID != fib_index)
496 fib_table_walk (fib_index,
498 vl_api_mpls_route_dump_table_walk, &ctx);
499 vec_sort_with_function (ctx.lfeis, fib_entry_cmp_for_sort);
501 vec_foreach (lfeip, ctx.lfeis)
503 send_mpls_route_details (am, reg, mp->context, *lfeip);
506 vec_free (ctx.lfeis);
510 #include <vnet/mpls/mpls.api.c>
511 static clib_error_t *
512 mpls_api_hookup (vlib_main_t * vm)
514 api_main_t *am = vlibapi_get_main ();
517 * Trace space for 8 MPLS encap labels
519 am->api_trace_cfg[VL_API_MPLS_TUNNEL_ADD_DEL].size += 8 * sizeof (u32);
522 * Set up the (msg_name, crc, message-id) table
524 REPLY_MSG_ID_BASE = setup_message_id_table ();
529 VLIB_API_INIT_FUNCTION (mpls_api_hookup);
532 * fd.io coding-style-patch-verification: ON
535 * eval: (c-set-style "gnu")