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>
32 #include <vnet/vnet_msg_enum.h>
34 #define vl_typedefs /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
38 #define vl_endianfun /* define message structures */
39 #include <vnet/vnet_all_api_h.h>
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
45 #include <vnet/vnet_all_api_h.h>
48 #include <vlibapi/api_helper_macros.h>
50 #define foreach_vpe_api_msg \
51 _(MPLS_IP_BIND_UNBIND, mpls_ip_bind_unbind) \
52 _(MPLS_ROUTE_ADD_DEL, mpls_route_add_del) \
53 _(MPLS_TABLE_ADD_DEL, mpls_table_add_del) \
54 _(MPLS_TUNNEL_ADD_DEL, mpls_tunnel_add_del) \
55 _(MPLS_TUNNEL_DUMP, mpls_tunnel_dump) \
56 _(SW_INTERFACE_SET_MPLS_ENABLE, sw_interface_set_mpls_enable) \
57 _(MPLS_FIB_DUMP, mpls_fib_dump)
59 extern void stats_dslock_with_hint (int hint, int tag);
60 extern void stats_dsunlock (void);
63 mpls_table_delete (u32 table_id, u8 is_api)
68 * The MPLS defult table must also be explicitly created via the API.
69 * So in contrast to IP, it gets no special treatment here.
71 * The API holds only one lock on the table.
72 * i.e. it can be added many times via the API but needs to be
75 fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
79 fib_table_unlock (fib_index,
81 (is_api ? FIB_SOURCE_API : FIB_SOURCE_CLI));
86 vl_api_mpls_table_add_del_t_handler (vl_api_mpls_table_add_del_t * mp)
88 vl_api_mpls_table_add_del_reply_t *rmp;
92 vnm = vnet_get_main ();
96 mpls_table_create (ntohl (mp->mt_table_id), 1, mp->mt_name);
98 mpls_table_delete (ntohl (mp->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;
112 fib_table_find (FIB_PROTOCOL_MPLS, ntohl (mp->mb_mpls_table_id));
114 if (~0 == mpls_fib_index)
116 return VNET_API_ERROR_NO_SUCH_FIB;
119 ip_fib_index = fib_table_find ((mp->mb_is_ip4 ?
122 ntohl (mp->mb_ip_table_id));
123 if (~0 == ip_fib_index)
124 return VNET_API_ERROR_NO_SUCH_FIB;
127 .fp_len = mp->mb_address_length,
132 pfx.fp_proto = FIB_PROTOCOL_IP4;
133 clib_memcpy (&pfx.fp_addr.ip4, mp->mb_address,
134 sizeof (pfx.fp_addr.ip4));
138 pfx.fp_proto = FIB_PROTOCOL_IP6;
139 clib_memcpy (&pfx.fp_addr.ip6, mp->mb_address,
140 sizeof (pfx.fp_addr.ip6));
144 fib_table_entry_local_label_add (ip_fib_index, &pfx,
145 ntohl (mp->mb_label));
147 fib_table_entry_local_label_remove (ip_fib_index, &pfx,
148 ntohl (mp->mb_label));
154 vl_api_mpls_ip_bind_unbind_t_handler (vl_api_mpls_ip_bind_unbind_t * mp)
156 vl_api_mpls_ip_bind_unbind_reply_t *rmp;
160 vnm = vnet_get_main ();
163 rv = mpls_ip_bind_unbind_handler (vnm, mp);
164 rv = (rv == 0) ? vnm->api_errno : rv;
166 REPLY_MACRO (VL_API_MPLS_IP_BIND_UNBIND_REPLY);
170 mpls_route_add_del_t_handler (vnet_main_t * vnm,
171 vl_api_mpls_route_add_del_t * mp,
174 fib_mpls_label_t *label_stack = NULL;
175 u32 fib_index, next_hop_fib_index;
176 int rv, ii, n_labels;;
180 .fp_proto = FIB_PROTOCOL_MPLS,
181 .fp_eos = mp->mr_eos,
182 .fp_label = ntohl (mp->mr_label),
186 pfx.fp_payload_proto = mp->mr_next_hop_proto;
190 pfx.fp_payload_proto = DPO_PROTO_MPLS;
193 rv = add_del_route_check (FIB_PROTOCOL_MPLS,
195 mp->mr_next_hop_sw_if_index,
196 pfx.fp_payload_proto,
197 mp->mr_next_hop_table_id,
199 &fib_index, &next_hop_fib_index);
205 clib_memset (&nh, 0, sizeof (nh));
207 if (DPO_PROTO_IP4 == mp->mr_next_hop_proto)
208 memcpy (&nh.ip4, mp->mr_next_hop, sizeof (nh.ip4));
209 else if (DPO_PROTO_IP6 == mp->mr_next_hop_proto)
210 memcpy (&nh.ip6, mp->mr_next_hop, sizeof (nh.ip6));
212 n_labels = mp->mr_next_hop_n_out_labels;
217 vec_validate (label_stack, n_labels - 1);
218 for (ii = 0; ii < n_labels; ii++)
220 label_stack[ii].fml_value =
221 ntohl (mp->mr_next_hop_out_label_stack[ii].label);
222 label_stack[ii].fml_ttl = mp->mr_next_hop_out_label_stack[ii].ttl;
223 label_stack[ii].fml_exp = mp->mr_next_hop_out_label_stack[ii].exp;
224 label_stack[ii].fml_mode =
225 (mp->mr_next_hop_out_label_stack[ii].is_uniform ?
226 FIB_MPLS_LSP_MODE_UNIFORM : FIB_MPLS_LSP_MODE_PIPE);
231 rv = add_del_route_t_handler (mp->mr_is_multipath, mp->mr_is_add,
233 0, // mp->is_unreach,
234 0, // mp->is_prohibit,
238 mp->mr_classify_table_index,
239 mp->mr_is_resolve_host,
240 mp->mr_is_resolve_attached,
241 mp->mr_is_interface_rx,
244 0, // is source_lookup
247 mp->mr_next_hop_proto,
248 &nh, ~0, // next_hop_id
249 ntohl (mp->mr_next_hop_sw_if_index),
251 mp->mr_next_hop_weight,
252 mp->mr_next_hop_preference,
253 ntohl (mp->mr_next_hop_via_label),
257 if (mp->mr_is_add && 0 == rv)
258 *stats_index = fib_table_entry_get_stats_index (fib_index, &pfx);
264 vl_api_mpls_route_add_del_t_handler (vl_api_mpls_route_add_del_t * mp)
266 vl_api_mpls_route_add_del_reply_t *rmp;
271 vnm = vnet_get_main ();
274 rv = mpls_route_add_del_t_handler (vnm, mp, &stats_index);
277 REPLY_MACRO2 (VL_API_MPLS_ROUTE_ADD_DEL_REPLY,
279 rmp->stats_index = htonl (stats_index);
285 mpls_table_create (u32 table_id, u8 is_api, const u8 * name)
290 * The MPLS defult table must also be explicitly created via the API.
291 * So in contrast to IP, it gets no special treatment here.
295 * The API holds only one lock on the table.
296 * i.e. it can be added many times via the API but needs to be
299 fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
303 fib_table_find_or_create_and_lock_w_name (FIB_PROTOCOL_MPLS,
307 FIB_SOURCE_CLI), name);
312 vl_api_mpls_tunnel_add_del_t_handler (vl_api_mpls_tunnel_add_del_t * mp)
314 u32 tunnel_sw_if_index = ~0, tunnel_index = ~0, next_hop_via_label;
315 vl_api_mpls_tunnel_add_del_reply_t *rmp;
316 fib_route_path_t rpath, *rpaths = NULL;
319 clib_memset (&rpath, 0, sizeof (rpath));
321 stats_dslock_with_hint (1 /* release hint */ , 5 /* tag */ );
323 if (mp->mt_next_hop_proto_is_ip4)
325 rpath.frp_proto = DPO_PROTO_IP4;
326 clib_memcpy (&rpath.frp_addr.ip4,
327 mp->mt_next_hop, sizeof (rpath.frp_addr.ip4));
331 rpath.frp_proto = DPO_PROTO_IP6;
332 clib_memcpy (&rpath.frp_addr.ip6,
333 mp->mt_next_hop, sizeof (rpath.frp_addr.ip6));
335 rpath.frp_sw_if_index = ntohl (mp->mt_next_hop_sw_if_index);
336 rpath.frp_weight = mp->mt_next_hop_weight;
337 rpath.frp_preference = mp->mt_next_hop_preference;
339 next_hop_via_label = ntohl (mp->mt_next_hop_via_label);
340 if ((MPLS_LABEL_INVALID != next_hop_via_label) && (0 != next_hop_via_label))
342 rpath.frp_proto = DPO_PROTO_MPLS;
343 rpath.frp_local_label = next_hop_via_label;
344 rpath.frp_eos = MPLS_NON_EOS;
347 if (rpath.frp_sw_if_index == ~0)
348 { /* recursive path, set fib index */
349 rpath.frp_fib_index =
350 fib_table_find (dpo_proto_to_fib (rpath.frp_proto),
351 ntohl (mp->mt_next_hop_table_id));
352 if (rpath.frp_fib_index == ~0)
354 rv = VNET_API_ERROR_NO_SUCH_FIB;
361 for (ii = 0; ii < mp->mt_next_hop_n_out_labels; ii++)
363 fib_mpls_label_t fml = {
364 .fml_value = ntohl (mp->mt_next_hop_out_label_stack[ii].label),
365 .fml_ttl = mp->mt_next_hop_out_label_stack[ii].ttl,
366 .fml_exp = mp->mt_next_hop_out_label_stack[ii].exp,
367 .fml_mode = (mp->mt_next_hop_out_label_stack[ii].is_uniform ?
368 FIB_MPLS_LSP_MODE_UNIFORM : FIB_MPLS_LSP_MODE_PIPE),
370 vec_add1 (rpath.frp_label_stack, fml);
374 vec_add1 (rpaths, rpath);
376 tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
380 if (~0 == tunnel_sw_if_index)
381 tunnel_sw_if_index = vnet_mpls_tunnel_create (mp->mt_l2_only,
382 mp->mt_is_multicast);
383 vnet_mpls_tunnel_path_add (tunnel_sw_if_index, rpaths);
385 tunnel_index = vnet_mpls_tunnel_get_index (tunnel_sw_if_index);
389 tunnel_index = vnet_mpls_tunnel_get_index (tunnel_sw_if_index);
390 tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
391 if (!vnet_mpls_tunnel_path_remove (tunnel_sw_if_index, rpaths))
392 vnet_mpls_tunnel_del (tunnel_sw_if_index);
401 REPLY_MACRO2(VL_API_MPLS_TUNNEL_ADD_DEL_REPLY,
403 rmp->sw_if_index = ntohl(tunnel_sw_if_index);
404 rmp->tunnel_index = ntohl(tunnel_index);
410 vl_api_sw_interface_set_mpls_enable_t_handler
411 (vl_api_sw_interface_set_mpls_enable_t * mp)
413 vl_api_sw_interface_set_mpls_enable_reply_t *rmp;
416 VALIDATE_SW_IF_INDEX (mp);
418 rv = mpls_sw_interface_enable_disable (&mpls_main,
419 ntohl (mp->sw_if_index),
422 BAD_SW_IF_INDEX_LABEL;
423 REPLY_MACRO (VL_API_SW_INTERFACE_SET_MPLS_ENABLE_REPLY);
426 typedef struct mpls_tunnel_send_walk_ctx_t_
428 vl_api_registration_t *reg;
431 } mpls_tunnel_send_walk_ctx_t;
434 send_mpls_tunnel_entry (u32 mti, void *arg)
436 fib_route_path_encode_t *api_rpaths = NULL, *api_rpath;
437 mpls_tunnel_send_walk_ctx_t *ctx;
438 vl_api_mpls_tunnel_details_t *mp;
439 const mpls_tunnel_t *mt;
440 vl_api_fib_path_t *fp;
445 mt = mpls_tunnel_get (mti);
447 if (~0 != ctx->sw_if_index && mt->mt_sw_if_index != ctx->sw_if_index)
450 n = fib_path_list_get_n_paths (mt->mt_path_list);
452 mp = vl_msg_api_alloc (sizeof (*mp) + n * sizeof (vl_api_fib_path_t));
453 clib_memset (mp, 0, sizeof (*mp) + n * sizeof (vl_api_fib_path_t));
455 mp->_vl_msg_id = ntohs (VL_API_MPLS_TUNNEL_DETAILS);
456 mp->context = ctx->context;
458 mp->mt_tunnel_index = ntohl (mti);
459 mp->mt_sw_if_index = ntohl (mt->mt_sw_if_index);
460 mp->mt_count = ntohl (n);
462 fib_path_list_walk (mt->mt_path_list, fib_path_encode, &api_rpaths);
465 vec_foreach (api_rpath, api_rpaths)
467 fib_api_path_encode (api_rpath, fp);
471 vl_api_send_msg (ctx->reg, (u8 *) mp);
475 vl_api_mpls_tunnel_dump_t_handler (vl_api_mpls_tunnel_dump_t * mp)
477 vl_api_registration_t *reg;
479 reg = vl_api_client_index_to_registration (mp->client_index);
483 mpls_tunnel_send_walk_ctx_t ctx = {
485 .sw_if_index = ntohl (mp->sw_if_index),
486 .context = mp->context,
488 mpls_tunnel_walk (send_mpls_tunnel_entry, &ctx);
492 send_mpls_fib_details (vpe_api_main_t * am,
493 vl_api_registration_t * reg,
494 const fib_table_t * table,
495 const fib_prefix_t * pfx,
496 fib_route_path_encode_t * api_rpaths, u32 context)
498 vl_api_mpls_fib_details_t *mp;
499 fib_route_path_encode_t *api_rpath;
500 vl_api_fib_path_t *fp;
503 path_count = vec_len (api_rpaths);
504 mp = vl_msg_api_alloc (sizeof (*mp) + path_count * sizeof (*fp));
507 clib_memset (mp, 0, sizeof (*mp));
508 mp->_vl_msg_id = ntohs (VL_API_MPLS_FIB_DETAILS);
509 mp->context = context;
511 mp->table_id = htonl (table->ft_table_id);
512 memcpy (mp->table_name, table->ft_desc,
513 clib_min (vec_len (table->ft_desc), sizeof (mp->table_name)));
514 mp->eos_bit = pfx->fp_eos;
515 mp->label = htonl (pfx->fp_label);
517 mp->count = htonl (path_count);
519 vec_foreach (api_rpath, api_rpaths)
521 fib_api_path_encode (api_rpath, fp);
525 vl_api_send_msg (reg, (u8 *) mp);
528 typedef struct vl_api_mpls_fib_dump_table_walk_ctx_t_
530 fib_node_index_t *lfeis;
531 } vl_api_mpls_fib_dump_table_walk_ctx_t;
533 static fib_table_walk_rc_t
534 vl_api_mpls_fib_dump_table_walk (fib_node_index_t fei, void *arg)
536 vl_api_mpls_fib_dump_table_walk_ctx_t *ctx = arg;
538 vec_add1 (ctx->lfeis, fei);
540 return (FIB_TABLE_WALK_CONTINUE);
544 vl_api_mpls_fib_dump_t_handler (vl_api_mpls_fib_dump_t * mp)
546 vpe_api_main_t *am = &vpe_api_main;
547 vl_api_registration_t *reg;
548 mpls_main_t *mm = &mpls_main;
549 fib_table_t *fib_table;
550 mpls_fib_t *mpls_fib;
551 fib_node_index_t *lfeip = NULL;
552 const fib_prefix_t *pfx;
554 fib_route_path_encode_t *api_rpaths;
555 vl_api_mpls_fib_dump_table_walk_ctx_t ctx = {
559 reg = vl_api_client_index_to_registration (mp->client_index);
564 pool_foreach (mpls_fib, mm->mpls_fibs,
566 mpls_fib_table_walk (mpls_fib,
567 vl_api_mpls_fib_dump_table_walk,
571 vec_sort_with_function (ctx.lfeis, fib_entry_cmp_for_sort);
573 vec_foreach (lfeip, ctx.lfeis)
575 pfx = fib_entry_get_prefix (*lfeip);
576 fib_index = fib_entry_get_fib_index (*lfeip);
577 fib_table = fib_table_get (fib_index, pfx->fp_proto);
579 fib_entry_encode (*lfeip, &api_rpaths);
580 send_mpls_fib_details (am, reg, fib_table, pfx, api_rpaths, mp->context);
581 vec_free (api_rpaths);
584 vec_free (ctx.lfeis);
589 * Add vpe's API message handlers to the table.
590 * vlib has alread mapped shared memory and
591 * added the client registration handlers.
592 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
594 #define vl_msg_name_crc_list
595 #include <vnet/vnet_all_api_h.h>
596 #undef vl_msg_name_crc_list
599 setup_message_id_table (api_main_t * am)
601 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
602 foreach_vl_msg_name_crc_mpls;
606 static clib_error_t *
607 mpls_api_hookup (vlib_main_t * vm)
609 api_main_t *am = &api_main;
612 vl_msg_api_set_handlers(VL_API_##N, #n, \
613 vl_api_##n##_t_handler, \
615 vl_api_##n##_t_endian, \
616 vl_api_##n##_t_print, \
617 sizeof(vl_api_##n##_t), 1);
622 * Trace space for 8 MPLS encap labels
624 am->api_trace_cfg[VL_API_MPLS_TUNNEL_ADD_DEL].size += 8 * sizeof (u32);
627 * Set up the (msg_name, crc, message-id) table
629 setup_message_id_table (am);
634 VLIB_API_INIT_FUNCTION (mpls_api_hookup);
637 * fd.io coding-style-patch-verification: ON
640 * eval: (c-set-style "gnu")