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);
97 mpls_table_delete (ntohl (mp->mt_table_id), 1);
99 rv = (rv == 0) ? vnm->api_errno : rv;
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]);
222 return (add_del_route_t_handler (mp->mr_is_multipath, mp->mr_is_add, 0, // mp->is_drop,
223 0, // mp->is_unreach,
224 0, // mp->is_prohibit,
228 mp->mr_classify_table_index,
229 mp->mr_is_resolve_host,
230 mp->mr_is_resolve_attached,
231 mp->mr_is_interface_rx,
234 mp->mr_next_hop_proto,
235 &nh, ntohl (mp->mr_next_hop_sw_if_index),
237 mp->mr_next_hop_weight,
238 mp->mr_next_hop_preference,
239 ntohl (mp->mr_next_hop_via_label),
244 vl_api_mpls_route_add_del_t_handler (vl_api_mpls_route_add_del_t * mp)
246 vl_api_mpls_route_add_del_reply_t *rmp;
250 vnm = vnet_get_main ();
253 rv = mpls_route_add_del_t_handler (vnm, mp);
255 rv = (rv == 0) ? vnm->api_errno : rv;
257 REPLY_MACRO (VL_API_MPLS_ROUTE_ADD_DEL_REPLY);
261 mpls_table_create (u32 table_id, u8 is_api)
266 * The MPLS defult table must also be explicitly created via the API.
267 * So in contrast to IP, it gets no special treatment here.
271 * The API holds only one lock on the table.
272 * i.e. it can be added many times via the API but needs to be
275 fib_index = fib_table_find (FIB_PROTOCOL_MPLS, table_id);
279 fib_table_find_or_create_and_lock (FIB_PROTOCOL_MPLS,
282 FIB_SOURCE_API : FIB_SOURCE_CLI));
287 vl_api_mpls_tunnel_add_del_t_handler (vl_api_mpls_tunnel_add_del_t * mp)
289 vl_api_mpls_tunnel_add_del_reply_t *rmp;
291 u32 tunnel_sw_if_index;
293 fib_route_path_t rpath, *rpaths = NULL;
295 memset (&rpath, 0, sizeof (rpath));
297 stats_dslock_with_hint (1 /* release hint */ , 5 /* tag */ );
299 if (mp->mt_next_hop_proto_is_ip4)
301 rpath.frp_proto = DPO_PROTO_IP4;
302 clib_memcpy (&rpath.frp_addr.ip4,
303 mp->mt_next_hop, sizeof (rpath.frp_addr.ip4));
307 rpath.frp_proto = DPO_PROTO_IP6;
308 clib_memcpy (&rpath.frp_addr.ip6,
309 mp->mt_next_hop, sizeof (rpath.frp_addr.ip6));
311 rpath.frp_sw_if_index = ntohl (mp->mt_next_hop_sw_if_index);
312 rpath.frp_weight = 1;
316 for (ii = 0; ii < mp->mt_next_hop_n_out_labels; ii++)
317 vec_add1 (rpath.frp_label_stack,
318 ntohl (mp->mt_next_hop_out_label_stack[ii]));
321 vec_add1 (rpaths, rpath);
323 tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
327 if (~0 == tunnel_sw_if_index)
328 tunnel_sw_if_index = vnet_mpls_tunnel_create (mp->mt_l2_only,
329 mp->mt_is_multicast);
330 vnet_mpls_tunnel_path_add (tunnel_sw_if_index, rpaths);
334 tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
335 if (!vnet_mpls_tunnel_path_remove (tunnel_sw_if_index, rpaths))
336 vnet_mpls_tunnel_del (tunnel_sw_if_index);
344 REPLY_MACRO2(VL_API_MPLS_TUNNEL_ADD_DEL_REPLY,
346 rmp->sw_if_index = ntohl(tunnel_sw_if_index);
351 typedef struct mpls_tunnel_send_walk_ctx_t_
353 unix_shared_memory_queue_t *q;
356 } mpls_tunnel_send_walk_ctx_t;
359 send_mpls_tunnel_entry (u32 mti, void *arg)
361 fib_route_path_encode_t *api_rpaths, *api_rpath;
362 mpls_tunnel_send_walk_ctx_t *ctx;
363 vl_api_mpls_tunnel_details_t *mp;
364 const mpls_tunnel_t *mt;
365 vl_api_fib_path2_t *fp;
370 if (~0 != ctx->index && mti != ctx->index)
373 mt = mpls_tunnel_get (mti);
374 n = fib_path_list_get_n_paths (mt->mt_path_list);
376 mp = vl_msg_api_alloc (sizeof (*mp) + n * sizeof (vl_api_fib_path2_t));
377 memset (mp, 0, sizeof (*mp) + n * sizeof (vl_api_fib_path2_t));
379 mp->_vl_msg_id = ntohs (VL_API_MPLS_TUNNEL_DETAILS);
380 mp->context = ctx->context;
382 mp->mt_tunnel_index = ntohl (mti);
383 mp->mt_count = ntohl (n);
385 fib_path_list_walk (mt->mt_path_list, fib_path_encode, &api_rpaths);
388 vec_foreach (api_rpath, api_rpaths)
390 memset (fp, 0, sizeof (*fp));
392 fp->weight = api_rpath->rpath.frp_weight;
393 fp->preference = api_rpath->rpath.frp_preference;
394 fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
395 copy_fib_next_hop (api_rpath, fp);
400 // memcpy (mp->mt_next_hop_out_labels,
401 // mt->mt_label_stack, nlabels * sizeof (u32));
404 vl_msg_api_send_shmem (ctx->q, (u8 *) & mp);
408 vl_api_mpls_tunnel_dump_t_handler (vl_api_mpls_tunnel_dump_t * mp)
410 unix_shared_memory_queue_t *q;
412 q = vl_api_client_index_to_input_queue (mp->client_index);
416 mpls_tunnel_send_walk_ctx_t ctx = {
418 .index = ntohl (mp->tunnel_index),
419 .context = mp->context,
421 mpls_tunnel_walk (send_mpls_tunnel_entry, &ctx);
425 send_mpls_fib_details (vpe_api_main_t * am,
426 unix_shared_memory_queue_t * q,
427 u32 table_id, u32 label, u32 eos,
428 fib_route_path_encode_t * api_rpaths, u32 context)
430 vl_api_mpls_fib_details_t *mp;
431 fib_route_path_encode_t *api_rpath;
432 vl_api_fib_path2_t *fp;
435 path_count = vec_len (api_rpaths);
436 mp = vl_msg_api_alloc (sizeof (*mp) + path_count * sizeof (*fp));
439 memset (mp, 0, sizeof (*mp));
440 mp->_vl_msg_id = ntohs (VL_API_MPLS_FIB_DETAILS);
441 mp->context = context;
443 mp->table_id = htonl (table_id);
445 mp->label = htonl (label);
447 mp->count = htonl (path_count);
449 vec_foreach (api_rpath, api_rpaths)
451 memset (fp, 0, sizeof (*fp));
452 fp->weight = api_rpath->rpath.frp_weight;
453 fp->preference = api_rpath->rpath.frp_preference;
454 fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
455 copy_fib_next_hop (api_rpath, fp);
459 vl_msg_api_send_shmem (q, (u8 *) & mp);
462 typedef struct vl_api_mpls_fib_dump_table_walk_ctx_t_
464 fib_node_index_t *lfeis;
465 } vl_api_mpls_fib_dump_table_walk_ctx_t;
468 vl_api_mpls_fib_dump_table_walk (fib_node_index_t fei, void *arg)
470 vl_api_mpls_fib_dump_table_walk_ctx_t *ctx = arg;
472 vec_add1 (ctx->lfeis, fei);
478 vl_api_mpls_fib_dump_t_handler (vl_api_mpls_fib_dump_t * mp)
480 vpe_api_main_t *am = &vpe_api_main;
481 unix_shared_memory_queue_t *q;
482 mpls_main_t *mm = &mpls_main;
483 fib_table_t *fib_table;
484 mpls_fib_t *mpls_fib;
485 fib_node_index_t *lfeip = NULL;
488 fib_route_path_encode_t *api_rpaths;
489 vl_api_mpls_fib_dump_table_walk_ctx_t ctx = {
493 q = vl_api_client_index_to_input_queue (mp->client_index);
498 pool_foreach (mpls_fib, mm->mpls_fibs,
500 mpls_fib_table_walk (mpls_fib,
501 vl_api_mpls_fib_dump_table_walk,
505 vec_sort_with_function (ctx.lfeis, fib_entry_cmp_for_sort);
507 vec_foreach (lfeip, ctx.lfeis)
509 fib_entry_get_prefix (*lfeip, &pfx);
510 fib_index = fib_entry_get_fib_index (*lfeip);
511 fib_table = fib_table_get (fib_index, pfx.fp_proto);
513 fib_entry_encode (*lfeip, &api_rpaths);
514 send_mpls_fib_details (am, q,
515 fib_table->ft_table_id,
516 pfx.fp_label, pfx.fp_eos, api_rpaths, mp->context);
517 vec_free (api_rpaths);
520 vec_free (ctx.lfeis);
525 * Add vpe's API message handlers to the table.
526 * vlib has alread mapped shared memory and
527 * added the client registration handlers.
528 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
530 #define vl_msg_name_crc_list
531 #include <vnet/vnet_all_api_h.h>
532 #undef vl_msg_name_crc_list
535 setup_message_id_table (api_main_t * am)
537 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
538 foreach_vl_msg_name_crc_mpls;
542 static clib_error_t *
543 mpls_api_hookup (vlib_main_t * vm)
545 api_main_t *am = &api_main;
548 vl_msg_api_set_handlers(VL_API_##N, #n, \
549 vl_api_##n##_t_handler, \
551 vl_api_##n##_t_endian, \
552 vl_api_##n##_t_print, \
553 sizeof(vl_api_##n##_t), 1);
558 * Trace space for 8 MPLS encap labels
560 am->api_trace_cfg[VL_API_MPLS_TUNNEL_ADD_DEL].size += 8 * sizeof (u32);
563 * Set up the (msg_name, crc, message-id) table
565 setup_message_id_table (am);
570 VLIB_API_INIT_FUNCTION (mpls_api_hookup);
573 * fd.io coding-style-patch-verification: ON
576 * eval: (c-set-style "gnu")