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_TUNNEL_ADD_DEL, mpls_tunnel_add_del) \
54 _(MPLS_TUNNEL_DUMP, mpls_tunnel_dump) \
55 _(MPLS_FIB_DUMP, mpls_fib_dump)
57 extern void stats_dslock_with_hint (int hint, int tag);
58 extern void stats_dsunlock (void);
61 mpls_ip_bind_unbind_handler (vnet_main_t * vnm,
62 vl_api_mpls_ip_bind_unbind_t * mp)
64 u32 mpls_fib_index, ip_fib_index;
67 fib_table_find (FIB_PROTOCOL_MPLS, ntohl (mp->mb_mpls_table_id));
69 if (~0 == mpls_fib_index)
71 if (mp->mb_create_table_if_needed)
74 fib_table_find_or_create_and_lock (FIB_PROTOCOL_MPLS,
75 ntohl (mp->mb_mpls_table_id));
78 return VNET_API_ERROR_NO_SUCH_FIB;
81 ip_fib_index = fib_table_find ((mp->mb_is_ip4 ?
84 ntohl (mp->mb_ip_table_id));
85 if (~0 == ip_fib_index)
86 return VNET_API_ERROR_NO_SUCH_FIB;
89 .fp_len = mp->mb_address_length,
94 pfx.fp_proto = FIB_PROTOCOL_IP4;
95 clib_memcpy (&pfx.fp_addr.ip4, mp->mb_address,
96 sizeof (pfx.fp_addr.ip4));
100 pfx.fp_proto = FIB_PROTOCOL_IP6;
101 clib_memcpy (&pfx.fp_addr.ip6, mp->mb_address,
102 sizeof (pfx.fp_addr.ip6));
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)
135 u32 fib_index, next_hop_fib_index;
136 mpls_label_t *label_stack = NULL;
137 int rv, ii, n_labels;;
141 .fp_proto = FIB_PROTOCOL_MPLS,
142 .fp_eos = mp->mr_eos,
143 .fp_label = ntohl (mp->mr_label),
147 pfx.fp_payload_proto = mp->mr_next_hop_proto;
151 pfx.fp_payload_proto = DPO_PROTO_MPLS;
154 rv = add_del_route_check (FIB_PROTOCOL_MPLS,
156 mp->mr_next_hop_sw_if_index,
157 pfx.fp_payload_proto,
158 mp->mr_next_hop_table_id,
159 mp->mr_create_table_if_needed,
161 &fib_index, &next_hop_fib_index);
167 memset (&nh, 0, sizeof (nh));
169 if (DPO_PROTO_IP4 == mp->mr_next_hop_proto)
170 memcpy (&nh.ip4, mp->mr_next_hop, sizeof (nh.ip4));
171 else if (DPO_PROTO_IP6 == mp->mr_next_hop_proto)
172 memcpy (&nh.ip6, mp->mr_next_hop, sizeof (nh.ip6));
174 n_labels = mp->mr_next_hop_n_out_labels;
177 else if (1 == n_labels)
178 vec_add1 (label_stack, ntohl (mp->mr_next_hop_out_label_stack[0]));
181 vec_validate (label_stack, n_labels - 1);
182 for (ii = 0; ii < n_labels; ii++)
183 label_stack[ii] = ntohl (mp->mr_next_hop_out_label_stack[ii]);
186 return (add_del_route_t_handler (mp->mr_is_multipath, mp->mr_is_add, 0, // mp->is_drop,
187 0, // mp->is_unreach,
188 0, // mp->is_prohibit,
192 mp->mr_classify_table_index,
193 mp->mr_is_resolve_host,
194 mp->mr_is_resolve_attached,
195 mp->mr_is_interface_rx,
198 mp->mr_next_hop_proto,
199 &nh, ntohl (mp->mr_next_hop_sw_if_index),
201 mp->mr_next_hop_weight,
202 mp->mr_next_hop_preference,
203 ntohl (mp->mr_next_hop_via_label),
208 vl_api_mpls_route_add_del_t_handler (vl_api_mpls_route_add_del_t * mp)
210 vl_api_mpls_route_add_del_reply_t *rmp;
214 vnm = vnet_get_main ();
217 rv = mpls_route_add_del_t_handler (vnm, mp);
219 rv = (rv == 0) ? vnm->api_errno : rv;
221 REPLY_MACRO (VL_API_MPLS_ROUTE_ADD_DEL_REPLY);
225 vl_api_mpls_tunnel_add_del_t_handler (vl_api_mpls_tunnel_add_del_t * mp)
227 vl_api_mpls_tunnel_add_del_reply_t *rmp;
229 u32 tunnel_sw_if_index;
231 fib_route_path_t rpath, *rpaths = NULL;
233 memset (&rpath, 0, sizeof (rpath));
235 stats_dslock_with_hint (1 /* release hint */ , 5 /* tag */ );
237 if (mp->mt_next_hop_proto_is_ip4)
239 rpath.frp_proto = DPO_PROTO_IP4;
240 clib_memcpy (&rpath.frp_addr.ip4,
241 mp->mt_next_hop, sizeof (rpath.frp_addr.ip4));
245 rpath.frp_proto = DPO_PROTO_IP6;
246 clib_memcpy (&rpath.frp_addr.ip6,
247 mp->mt_next_hop, sizeof (rpath.frp_addr.ip6));
249 rpath.frp_sw_if_index = ntohl (mp->mt_next_hop_sw_if_index);
250 rpath.frp_weight = 1;
254 for (ii = 0; ii < mp->mt_next_hop_n_out_labels; ii++)
255 vec_add1 (rpath.frp_label_stack,
256 ntohl (mp->mt_next_hop_out_label_stack[ii]));
259 vec_add1 (rpaths, rpath);
261 tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
265 if (~0 == tunnel_sw_if_index)
266 tunnel_sw_if_index = vnet_mpls_tunnel_create (mp->mt_l2_only,
267 mp->mt_is_multicast);
268 vnet_mpls_tunnel_path_add (tunnel_sw_if_index, rpaths);
272 tunnel_sw_if_index = ntohl (mp->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);
282 REPLY_MACRO2(VL_API_MPLS_TUNNEL_ADD_DEL_REPLY,
284 rmp->sw_if_index = ntohl(tunnel_sw_if_index);
289 typedef struct mpls_tunnel_send_walk_ctx_t_
291 unix_shared_memory_queue_t *q;
294 } mpls_tunnel_send_walk_ctx_t;
297 send_mpls_tunnel_entry (u32 mti, void *arg)
299 fib_route_path_encode_t *api_rpaths, *api_rpath;
300 mpls_tunnel_send_walk_ctx_t *ctx;
301 vl_api_mpls_tunnel_details_t *mp;
302 const mpls_tunnel_t *mt;
303 vl_api_fib_path2_t *fp;
308 if (~0 != ctx->index && mti != ctx->index)
311 mt = mpls_tunnel_get (mti);
312 n = fib_path_list_get_n_paths (mt->mt_path_list);
314 mp = vl_msg_api_alloc (sizeof (*mp) + n * sizeof (vl_api_fib_path2_t));
315 memset (mp, 0, sizeof (*mp) + n * sizeof (vl_api_fib_path2_t));
317 mp->_vl_msg_id = ntohs (VL_API_MPLS_TUNNEL_DETAILS);
318 mp->context = ctx->context;
320 mp->mt_tunnel_index = ntohl (mti);
321 mp->mt_count = ntohl (n);
323 fib_path_list_walk (mt->mt_path_list, fib_path_encode, &api_rpaths);
326 vec_foreach (api_rpath, api_rpaths)
328 memset (fp, 0, sizeof (*fp));
330 fp->weight = api_rpath->rpath.frp_weight;
331 fp->preference = api_rpath->rpath.frp_preference;
332 fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
333 copy_fib_next_hop (api_rpath, fp);
338 // memcpy (mp->mt_next_hop_out_labels,
339 // mt->mt_label_stack, nlabels * sizeof (u32));
342 vl_msg_api_send_shmem (ctx->q, (u8 *) & mp);
346 vl_api_mpls_tunnel_dump_t_handler (vl_api_mpls_tunnel_dump_t * mp)
348 unix_shared_memory_queue_t *q;
350 q = vl_api_client_index_to_input_queue (mp->client_index);
354 mpls_tunnel_send_walk_ctx_t ctx = {
356 .index = ntohl (mp->tunnel_index),
357 .context = mp->context,
359 mpls_tunnel_walk (send_mpls_tunnel_entry, &ctx);
363 send_mpls_fib_details (vpe_api_main_t * am,
364 unix_shared_memory_queue_t * q,
365 u32 table_id, u32 label, u32 eos,
366 fib_route_path_encode_t * api_rpaths, u32 context)
368 vl_api_mpls_fib_details_t *mp;
369 fib_route_path_encode_t *api_rpath;
370 vl_api_fib_path2_t *fp;
373 path_count = vec_len (api_rpaths);
374 mp = vl_msg_api_alloc (sizeof (*mp) + path_count * sizeof (*fp));
377 memset (mp, 0, sizeof (*mp));
378 mp->_vl_msg_id = ntohs (VL_API_MPLS_FIB_DETAILS);
379 mp->context = context;
381 mp->table_id = htonl (table_id);
383 mp->label = htonl (label);
385 mp->count = htonl (path_count);
387 vec_foreach (api_rpath, api_rpaths)
389 memset (fp, 0, sizeof (*fp));
390 fp->weight = api_rpath->rpath.frp_weight;
391 fp->preference = api_rpath->rpath.frp_preference;
392 fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
393 copy_fib_next_hop (api_rpath, fp);
397 vl_msg_api_send_shmem (q, (u8 *) & mp);
400 typedef struct vl_api_mpls_fib_dump_table_walk_ctx_t_
402 fib_node_index_t *lfeis;
403 } vl_api_mpls_fib_dump_table_walk_ctx_t;
406 vl_api_mpls_fib_dump_table_walk (fib_node_index_t fei, void *arg)
408 vl_api_mpls_fib_dump_table_walk_ctx_t *ctx = arg;
410 vec_add1 (ctx->lfeis, fei);
416 vl_api_mpls_fib_dump_t_handler (vl_api_mpls_fib_dump_t * mp)
418 vpe_api_main_t *am = &vpe_api_main;
419 unix_shared_memory_queue_t *q;
420 mpls_main_t *mm = &mpls_main;
421 fib_table_t *fib_table;
422 mpls_fib_t *mpls_fib;
423 fib_node_index_t *lfeip = NULL;
426 fib_route_path_encode_t *api_rpaths;
427 vl_api_mpls_fib_dump_table_walk_ctx_t ctx = {
431 q = vl_api_client_index_to_input_queue (mp->client_index);
436 pool_foreach (mpls_fib, mm->mpls_fibs,
438 mpls_fib_table_walk (mpls_fib,
439 vl_api_mpls_fib_dump_table_walk,
443 vec_sort_with_function (ctx.lfeis, fib_entry_cmp_for_sort);
445 vec_foreach (lfeip, ctx.lfeis)
447 fib_entry_get_prefix (*lfeip, &pfx);
448 fib_index = fib_entry_get_fib_index (*lfeip);
449 fib_table = fib_table_get (fib_index, pfx.fp_proto);
451 fib_entry_encode (*lfeip, &api_rpaths);
452 send_mpls_fib_details (am, q,
453 fib_table->ft_table_id,
454 pfx.fp_label, pfx.fp_eos, api_rpaths, mp->context);
455 vec_free (api_rpaths);
458 vec_free (ctx.lfeis);
463 * Add vpe's API message handlers to the table.
464 * vlib has alread mapped shared memory and
465 * added the client registration handlers.
466 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
468 #define vl_msg_name_crc_list
469 #include <vnet/vnet_all_api_h.h>
470 #undef vl_msg_name_crc_list
473 setup_message_id_table (api_main_t * am)
475 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
476 foreach_vl_msg_name_crc_mpls;
480 static clib_error_t *
481 mpls_api_hookup (vlib_main_t * vm)
483 api_main_t *am = &api_main;
486 vl_msg_api_set_handlers(VL_API_##N, #n, \
487 vl_api_##n##_t_handler, \
489 vl_api_##n##_t_endian, \
490 vl_api_##n##_t_print, \
491 sizeof(vl_api_##n##_t), 1);
496 * Trace space for 8 MPLS encap labels
498 am->api_trace_cfg[VL_API_MPLS_TUNNEL_ADD_DEL].size += 8 * sizeof (u32);
501 * Set up the (msg_name, crc, message-id) table
503 setup_message_id_table (am);
508 VLIB_API_INIT_FUNCTION (mpls_api_hookup);
511 * fd.io coding-style-patch-verification: ON
514 * eval: (c-set-style "gnu")