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 _(MPLS_FIB_DUMP, mpls_fib_dump)
58 extern void stats_dslock_with_hint (int hint, int tag);
59 extern void stats_dsunlock (void);
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_id), 1, mp->mt_name);
97 mpls_table_delete (ntohl (mp->mt_table_id), 1);
99 // NB: Nothing sets rv; none of the above returns an error
101 REPLY_MACRO (VL_API_MPLS_TABLE_ADD_DEL_REPLY);
105 mpls_ip_bind_unbind_handler (vnet_main_t * vnm,
106 vl_api_mpls_ip_bind_unbind_t * mp)
108 u32 mpls_fib_index, ip_fib_index;
111 fib_table_find (FIB_PROTOCOL_MPLS, ntohl (mp->mb_mpls_table_id));
113 if (~0 == mpls_fib_index)
115 return VNET_API_ERROR_NO_SUCH_FIB;
118 ip_fib_index = fib_table_find ((mp->mb_is_ip4 ?
121 ntohl (mp->mb_ip_table_id));
122 if (~0 == ip_fib_index)
123 return VNET_API_ERROR_NO_SUCH_FIB;
126 .fp_len = mp->mb_address_length,
131 pfx.fp_proto = FIB_PROTOCOL_IP4;
132 clib_memcpy (&pfx.fp_addr.ip4, mp->mb_address,
133 sizeof (pfx.fp_addr.ip4));
137 pfx.fp_proto = FIB_PROTOCOL_IP6;
138 clib_memcpy (&pfx.fp_addr.ip6, mp->mb_address,
139 sizeof (pfx.fp_addr.ip6));
143 fib_table_entry_local_label_add (ip_fib_index, &pfx,
144 ntohl (mp->mb_label));
146 fib_table_entry_local_label_remove (ip_fib_index, &pfx,
147 ntohl (mp->mb_label));
153 vl_api_mpls_ip_bind_unbind_t_handler (vl_api_mpls_ip_bind_unbind_t * mp)
155 vl_api_mpls_ip_bind_unbind_reply_t *rmp;
159 vnm = vnet_get_main ();
162 rv = mpls_ip_bind_unbind_handler (vnm, mp);
163 rv = (rv == 0) ? vnm->api_errno : rv;
165 REPLY_MACRO (VL_API_MPLS_IP_BIND_UNBIND_REPLY);
169 mpls_route_add_del_t_handler (vnet_main_t * vnm,
170 vl_api_mpls_route_add_del_t * mp)
172 u32 fib_index, next_hop_fib_index;
173 mpls_label_t *label_stack = NULL;
174 int rv, ii, n_labels;;
178 .fp_proto = FIB_PROTOCOL_MPLS,
179 .fp_eos = mp->mr_eos,
180 .fp_label = ntohl (mp->mr_label),
184 pfx.fp_payload_proto = mp->mr_next_hop_proto;
188 pfx.fp_payload_proto = DPO_PROTO_MPLS;
191 rv = add_del_route_check (FIB_PROTOCOL_MPLS,
193 mp->mr_next_hop_sw_if_index,
194 pfx.fp_payload_proto,
195 mp->mr_next_hop_table_id,
197 &fib_index, &next_hop_fib_index);
203 memset (&nh, 0, sizeof (nh));
205 if (DPO_PROTO_IP4 == mp->mr_next_hop_proto)
206 memcpy (&nh.ip4, mp->mr_next_hop, sizeof (nh.ip4));
207 else if (DPO_PROTO_IP6 == mp->mr_next_hop_proto)
208 memcpy (&nh.ip6, mp->mr_next_hop, sizeof (nh.ip6));
210 n_labels = mp->mr_next_hop_n_out_labels;
213 else if (1 == n_labels)
214 vec_add1 (label_stack, ntohl (mp->mr_next_hop_out_label_stack[0]));
217 vec_validate (label_stack, n_labels - 1);
218 for (ii = 0; ii < n_labels; ii++)
219 label_stack[ii] = ntohl (mp->mr_next_hop_out_label_stack[ii]);
223 return (add_del_route_t_handler (mp->mr_is_multipath, mp->mr_is_add,
225 0, // mp->is_unreach,
226 0, // mp->is_prohibit,
230 mp->mr_classify_table_index,
231 mp->mr_is_resolve_host,
232 mp->mr_is_resolve_attached,
233 mp->mr_is_interface_rx,
236 0, // is source_lookup
238 mp->mr_next_hop_proto,
239 &nh, ntohl (mp->mr_next_hop_sw_if_index),
241 mp->mr_next_hop_weight,
242 mp->mr_next_hop_preference,
243 ntohl (mp->mr_next_hop_via_label),
249 vl_api_mpls_route_add_del_t_handler (vl_api_mpls_route_add_del_t * mp)
251 vl_api_mpls_route_add_del_reply_t *rmp;
255 vnm = vnet_get_main ();
258 rv = mpls_route_add_del_t_handler (vnm, mp);
260 rv = (rv == 0) ? vnm->api_errno : rv;
262 REPLY_MACRO (VL_API_MPLS_ROUTE_ADD_DEL_REPLY);
266 mpls_table_create (u32 table_id, u8 is_api, const u8 * name)
271 * The MPLS defult table must also be explicitly created via the API.
272 * So in contrast to IP, it gets no special treatment here.
276 * The API holds only one lock on the table.
277 * i.e. it can be added many times via the API but needs to be
280 fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
284 fib_table_find_or_create_and_lock_w_name (FIB_PROTOCOL_MPLS,
288 FIB_SOURCE_CLI), name);
293 vl_api_mpls_tunnel_add_del_t_handler (vl_api_mpls_tunnel_add_del_t * mp)
295 vl_api_mpls_tunnel_add_del_reply_t *rmp;
297 u32 tunnel_sw_if_index;
299 fib_route_path_t rpath, *rpaths = NULL;
301 memset (&rpath, 0, sizeof (rpath));
303 stats_dslock_with_hint (1 /* release hint */ , 5 /* tag */ );
305 if (mp->mt_next_hop_proto_is_ip4)
307 rpath.frp_proto = DPO_PROTO_IP4;
308 clib_memcpy (&rpath.frp_addr.ip4,
309 mp->mt_next_hop, sizeof (rpath.frp_addr.ip4));
313 rpath.frp_proto = DPO_PROTO_IP6;
314 clib_memcpy (&rpath.frp_addr.ip6,
315 mp->mt_next_hop, sizeof (rpath.frp_addr.ip6));
317 rpath.frp_sw_if_index = ntohl (mp->mt_next_hop_sw_if_index);
318 rpath.frp_weight = 1;
322 for (ii = 0; ii < mp->mt_next_hop_n_out_labels; ii++)
323 vec_add1 (rpath.frp_label_stack,
324 ntohl (mp->mt_next_hop_out_label_stack[ii]));
327 vec_add1 (rpaths, rpath);
329 tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
333 if (~0 == tunnel_sw_if_index)
334 tunnel_sw_if_index = vnet_mpls_tunnel_create (mp->mt_l2_only,
335 mp->mt_is_multicast);
336 vnet_mpls_tunnel_path_add (tunnel_sw_if_index, rpaths);
340 tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
341 if (!vnet_mpls_tunnel_path_remove (tunnel_sw_if_index, rpaths))
342 vnet_mpls_tunnel_del (tunnel_sw_if_index);
350 REPLY_MACRO2(VL_API_MPLS_TUNNEL_ADD_DEL_REPLY,
352 rmp->sw_if_index = ntohl(tunnel_sw_if_index);
357 typedef struct mpls_tunnel_send_walk_ctx_t_
359 unix_shared_memory_queue_t *q;
362 } mpls_tunnel_send_walk_ctx_t;
365 send_mpls_tunnel_entry (u32 mti, void *arg)
367 fib_route_path_encode_t *api_rpaths, *api_rpath;
368 mpls_tunnel_send_walk_ctx_t *ctx;
369 vl_api_mpls_tunnel_details_t *mp;
370 const mpls_tunnel_t *mt;
371 vl_api_fib_path2_t *fp;
376 if (~0 != ctx->index && mti != ctx->index)
379 mt = mpls_tunnel_get (mti);
380 n = fib_path_list_get_n_paths (mt->mt_path_list);
382 mp = vl_msg_api_alloc (sizeof (*mp) + n * sizeof (vl_api_fib_path2_t));
383 memset (mp, 0, sizeof (*mp) + n * sizeof (vl_api_fib_path2_t));
385 mp->_vl_msg_id = ntohs (VL_API_MPLS_TUNNEL_DETAILS);
386 mp->context = ctx->context;
388 mp->mt_tunnel_index = ntohl (mti);
389 mp->mt_count = ntohl (n);
391 fib_path_list_walk (mt->mt_path_list, fib_path_encode, &api_rpaths);
394 vec_foreach (api_rpath, api_rpaths)
396 memset (fp, 0, sizeof (*fp));
398 fp->weight = api_rpath->rpath.frp_weight;
399 fp->preference = api_rpath->rpath.frp_preference;
400 fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
401 copy_fib_next_hop (api_rpath, fp);
406 // memcpy (mp->mt_next_hop_out_labels,
407 // mt->mt_label_stack, nlabels * sizeof (u32));
410 vl_msg_api_send_shmem (ctx->q, (u8 *) & mp);
414 vl_api_mpls_tunnel_dump_t_handler (vl_api_mpls_tunnel_dump_t * mp)
416 unix_shared_memory_queue_t *q;
418 q = vl_api_client_index_to_input_queue (mp->client_index);
422 mpls_tunnel_send_walk_ctx_t ctx = {
424 .index = ntohl (mp->tunnel_index),
425 .context = mp->context,
427 mpls_tunnel_walk (send_mpls_tunnel_entry, &ctx);
431 send_mpls_fib_details (vpe_api_main_t * am,
432 unix_shared_memory_queue_t * q,
433 const fib_table_t * table,
435 fib_route_path_encode_t * api_rpaths, u32 context)
437 vl_api_mpls_fib_details_t *mp;
438 fib_route_path_encode_t *api_rpath;
439 vl_api_fib_path2_t *fp;
442 path_count = vec_len (api_rpaths);
443 mp = vl_msg_api_alloc (sizeof (*mp) + path_count * sizeof (*fp));
446 memset (mp, 0, sizeof (*mp));
447 mp->_vl_msg_id = ntohs (VL_API_MPLS_FIB_DETAILS);
448 mp->context = context;
450 mp->table_id = htonl (table->ft_table_id);
451 memcpy (mp->table_name, table->ft_desc,
452 clib_min (vec_len (table->ft_desc), sizeof (mp->table_name)));
454 mp->label = htonl (label);
456 mp->count = htonl (path_count);
458 vec_foreach (api_rpath, api_rpaths)
460 memset (fp, 0, sizeof (*fp));
461 fp->weight = api_rpath->rpath.frp_weight;
462 fp->preference = api_rpath->rpath.frp_preference;
463 fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
464 copy_fib_next_hop (api_rpath, fp);
468 vl_msg_api_send_shmem (q, (u8 *) & mp);
471 typedef struct vl_api_mpls_fib_dump_table_walk_ctx_t_
473 fib_node_index_t *lfeis;
474 } vl_api_mpls_fib_dump_table_walk_ctx_t;
477 vl_api_mpls_fib_dump_table_walk (fib_node_index_t fei, void *arg)
479 vl_api_mpls_fib_dump_table_walk_ctx_t *ctx = arg;
481 vec_add1 (ctx->lfeis, fei);
487 vl_api_mpls_fib_dump_t_handler (vl_api_mpls_fib_dump_t * mp)
489 vpe_api_main_t *am = &vpe_api_main;
490 unix_shared_memory_queue_t *q;
491 mpls_main_t *mm = &mpls_main;
492 fib_table_t *fib_table;
493 mpls_fib_t *mpls_fib;
494 fib_node_index_t *lfeip = NULL;
497 fib_route_path_encode_t *api_rpaths;
498 vl_api_mpls_fib_dump_table_walk_ctx_t ctx = {
502 q = vl_api_client_index_to_input_queue (mp->client_index);
507 pool_foreach (mpls_fib, mm->mpls_fibs,
509 mpls_fib_table_walk (mpls_fib,
510 vl_api_mpls_fib_dump_table_walk,
514 vec_sort_with_function (ctx.lfeis, fib_entry_cmp_for_sort);
516 vec_foreach (lfeip, ctx.lfeis)
518 fib_entry_get_prefix (*lfeip, &pfx);
519 fib_index = fib_entry_get_fib_index (*lfeip);
520 fib_table = fib_table_get (fib_index, pfx.fp_proto);
522 fib_entry_encode (*lfeip, &api_rpaths);
523 send_mpls_fib_details (am, q,
524 fib_table, pfx.fp_label,
525 pfx.fp_eos, api_rpaths, mp->context);
526 vec_free (api_rpaths);
529 vec_free (ctx.lfeis);
534 * Add vpe's API message handlers to the table.
535 * vlib has alread mapped shared memory and
536 * added the client registration handlers.
537 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
539 #define vl_msg_name_crc_list
540 #include <vnet/vnet_all_api_h.h>
541 #undef vl_msg_name_crc_list
544 setup_message_id_table (api_main_t * am)
546 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
547 foreach_vl_msg_name_crc_mpls;
551 static clib_error_t *
552 mpls_api_hookup (vlib_main_t * vm)
554 api_main_t *am = &api_main;
557 vl_msg_api_set_handlers(VL_API_##N, #n, \
558 vl_api_##n##_t_handler, \
560 vl_api_##n##_t_endian, \
561 vl_api_##n##_t_print, \
562 sizeof(vl_api_##n##_t), 1);
567 * Trace space for 8 MPLS encap labels
569 am->api_trace_cfg[VL_API_MPLS_TUNNEL_ADD_DEL].size += 8 * sizeof (u32);
572 * Set up the (msg_name, crc, message-id) table
574 setup_message_id_table (am);
579 VLIB_API_INIT_FUNCTION (mpls_api_hookup);
582 * fd.io coding-style-patch-verification: ON
585 * eval: (c-set-style "gnu")