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>
30 #include <vnet/vnet_msg_enum.h>
32 #define vl_typedefs /* define message structures */
33 #include <vnet/vnet_all_api_h.h>
36 #define vl_endianfun /* define message structures */
37 #include <vnet/vnet_all_api_h.h>
40 /* instantiate all the print functions we know about */
41 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
43 #include <vnet/vnet_all_api_h.h>
46 #include <vlibapi/api_helper_macros.h>
48 #define foreach_vpe_api_msg \
49 _(MPLS_IP_BIND_UNBIND, mpls_ip_bind_unbind) \
50 _(MPLS_ROUTE_ADD_DEL, mpls_route_add_del) \
51 _(MPLS_TUNNEL_ADD_DEL, mpls_tunnel_add_del) \
52 _(MPLS_TUNNEL_DUMP, mpls_tunnel_dump) \
53 _(MPLS_TUNNEL_DETAILS, mpls_tunnel_details) \
54 _(MPLS_FIB_DUMP, mpls_fib_dump) \
55 _(MPLS_FIB_DETAILS, mpls_fib_details)
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 if (mp->mr_next_hop_proto_is_ip4)
149 pfx.fp_payload_proto = DPO_PROTO_IP4;
153 pfx.fp_payload_proto = DPO_PROTO_IP6;
158 pfx.fp_payload_proto = DPO_PROTO_MPLS;
161 rv = add_del_route_check (FIB_PROTOCOL_MPLS,
163 mp->mr_next_hop_sw_if_index,
164 dpo_proto_to_fib (pfx.fp_payload_proto),
165 mp->mr_next_hop_table_id,
166 mp->mr_create_table_if_needed,
167 &fib_index, &next_hop_fib_index);
173 memset (&nh, 0, sizeof (nh));
175 if (mp->mr_next_hop_proto_is_ip4)
176 memcpy (&nh.ip4, mp->mr_next_hop, sizeof (nh.ip4));
178 memcpy (&nh.ip6, mp->mr_next_hop, sizeof (nh.ip6));
180 n_labels = mp->mr_next_hop_n_out_labels;
183 else if (1 == n_labels)
184 vec_add1 (label_stack, ntohl (mp->mr_next_hop_out_label_stack[0]));
187 vec_validate (label_stack, n_labels - 1);
188 for (ii = 0; ii < n_labels; ii++)
189 label_stack[ii] = ntohl (mp->mr_next_hop_out_label_stack[ii]);
192 return (add_del_route_t_handler (mp->mr_is_multipath, mp->mr_is_add, 0, // mp->is_drop,
193 0, // mp->is_unreach,
194 0, // mp->is_prohibit,
197 mp->mr_classify_table_index,
198 mp->mr_is_resolve_host,
199 mp->mr_is_resolve_attached,
201 mp->mr_next_hop_proto_is_ip4,
202 &nh, ntohl (mp->mr_next_hop_sw_if_index),
204 mp->mr_next_hop_weight,
205 ntohl (mp->mr_next_hop_via_label),
210 vl_api_mpls_route_add_del_t_handler (vl_api_mpls_route_add_del_t * mp)
212 vl_api_mpls_route_add_del_reply_t *rmp;
216 vnm = vnet_get_main ();
219 rv = mpls_route_add_del_t_handler (vnm, mp);
221 rv = (rv == 0) ? vnm->api_errno : rv;
223 REPLY_MACRO (VL_API_MPLS_ROUTE_ADD_DEL_REPLY);
227 vl_api_mpls_tunnel_add_del_t_handler (vl_api_mpls_tunnel_add_del_t * mp)
229 vl_api_mpls_tunnel_add_del_reply_t *rmp;
231 u32 tunnel_sw_if_index;
234 stats_dslock_with_hint (1 /* release hint */ , 5 /* tag */ );
238 fib_route_path_t rpath, *rpaths = NULL;
239 mpls_label_t *label_stack = NULL;
241 memset (&rpath, 0, sizeof (rpath));
243 if (mp->mt_next_hop_proto_is_ip4)
245 rpath.frp_proto = FIB_PROTOCOL_IP4;
246 clib_memcpy (&rpath.frp_addr.ip4,
247 mp->mt_next_hop, sizeof (rpath.frp_addr.ip4));
251 rpath.frp_proto = FIB_PROTOCOL_IP6;
252 clib_memcpy (&rpath.frp_addr.ip6,
253 mp->mt_next_hop, sizeof (rpath.frp_addr.ip6));
255 rpath.frp_sw_if_index = ntohl (mp->mt_next_hop_sw_if_index);
257 for (ii = 0; ii < mp->mt_next_hop_n_out_labels; ii++)
258 vec_add1 (label_stack, ntohl (mp->mt_next_hop_out_label_stack[ii]));
260 vec_add1 (rpaths, rpath);
262 vnet_mpls_tunnel_add (rpaths, label_stack,
263 mp->mt_l2_only, &tunnel_sw_if_index);
265 vec_free (label_stack);
269 tunnel_sw_if_index = ntohl (mp->mt_sw_if_index);
270 vnet_mpls_tunnel_del (tunnel_sw_if_index);
276 REPLY_MACRO2(VL_API_MPLS_TUNNEL_ADD_DEL_REPLY,
278 rmp->sw_if_index = ntohl(tunnel_sw_if_index);
284 vl_api_mpls_tunnel_details_t_handler (vl_api_mpls_tunnel_details_t * mp)
286 clib_warning ("BUG");
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 mpls_tunnel_send_walk_ctx_t *ctx;
300 vl_api_mpls_tunnel_details_t *mp;
301 const mpls_tunnel_t *mt;
306 if (~0 != ctx->index && mti != ctx->index)
309 mt = mpls_tunnel_get (mti);
310 nlabels = vec_len (mt->mt_label_stack);
312 mp = vl_msg_api_alloc (sizeof (*mp) + nlabels * sizeof (u32));
313 memset (mp, 0, sizeof (*mp));
314 mp->_vl_msg_id = ntohs (VL_API_MPLS_TUNNEL_DETAILS);
315 mp->context = ctx->context;
317 mp->tunnel_index = ntohl (mti);
318 memcpy (mp->mt_next_hop_out_labels,
319 mt->mt_label_stack, nlabels * sizeof (u32));
323 vl_msg_api_send_shmem (ctx->q, (u8 *) & mp);
327 vl_api_mpls_tunnel_dump_t_handler (vl_api_mpls_tunnel_dump_t * mp)
329 unix_shared_memory_queue_t *q;
331 q = vl_api_client_index_to_input_queue (mp->client_index);
335 mpls_tunnel_send_walk_ctx_t ctx = {
337 .index = ntohl (mp->tunnel_index),
338 .context = mp->context,
340 mpls_tunnel_walk (send_mpls_tunnel_entry, &ctx);
344 vl_api_mpls_fib_details_t_handler (vl_api_mpls_fib_details_t * mp)
346 clib_warning ("BUG");
350 vl_api_mpls_fib_details_t_endian (vl_api_mpls_fib_details_t * mp)
352 clib_warning ("BUG");
356 vl_api_mpls_fib_details_t_print (vl_api_mpls_fib_details_t * mp)
358 clib_warning ("BUG");
362 send_mpls_fib_details (vpe_api_main_t * am,
363 unix_shared_memory_queue_t * q,
364 u32 table_id, u32 label, u32 eos,
365 fib_route_path_encode_t * api_rpaths, u32 context)
367 vl_api_mpls_fib_details_t *mp;
368 fib_route_path_encode_t *api_rpath;
369 vl_api_fib_path2_t *fp;
372 path_count = vec_len (api_rpaths);
373 mp = vl_msg_api_alloc (sizeof (*mp) + path_count * sizeof (*fp));
376 memset (mp, 0, sizeof (*mp));
377 mp->_vl_msg_id = ntohs (VL_API_MPLS_FIB_DETAILS);
378 mp->context = context;
380 mp->table_id = htonl (table_id);
382 mp->label = htonl (label);
384 mp->count = htonl (path_count);
386 vec_foreach (api_rpath, api_rpaths)
388 memset (fp, 0, sizeof (*fp));
389 fp->weight = htonl (api_rpath->rpath.frp_weight);
390 fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
391 copy_fib_next_hop (api_rpath, fp);
395 vl_msg_api_send_shmem (q, (u8 *) & mp);
399 vl_api_mpls_fib_dump_t_handler (vl_api_mpls_fib_dump_t * mp)
401 vpe_api_main_t *am = &vpe_api_main;
402 unix_shared_memory_queue_t *q;
403 mpls_main_t *mm = &mpls_main;
404 fib_table_t *fib_table;
405 fib_node_index_t lfei, *lfeip, *lfeis = NULL;
409 fib_route_path_encode_t *api_rpaths;
411 q = vl_api_client_index_to_input_queue (mp->client_index);
416 pool_foreach (fib_table, mm->fibs,
418 hash_foreach(key, lfei, fib_table->mpls.mf_entries,
420 vec_add1(lfeis, lfei);
424 vec_sort_with_function (lfeis, fib_entry_cmp_for_sort);
426 vec_foreach (lfeip, lfeis)
428 fib_entry_get_prefix (*lfeip, &pfx);
429 fib_index = fib_entry_get_fib_index (*lfeip);
430 fib_table = fib_table_get (fib_index, pfx.fp_proto);
432 fib_entry_encode (*lfeip, &api_rpaths);
433 send_mpls_fib_details (am, q,
434 fib_table->ft_table_id,
435 pfx.fp_label, pfx.fp_eos, api_rpaths, mp->context);
436 vec_free (api_rpaths);
444 * Add vpe's API message handlers to the table.
445 * vlib has alread mapped shared memory and
446 * added the client registration handlers.
447 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
449 #define vl_msg_name_crc_list
450 #include <vnet/vnet_all_api_h.h>
451 #undef vl_msg_name_crc_list
454 setup_message_id_table (api_main_t * am)
456 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
457 foreach_vl_msg_name_crc_mpls;
461 static clib_error_t *
462 mpls_api_hookup (vlib_main_t * vm)
464 api_main_t *am = &api_main;
467 vl_msg_api_set_handlers(VL_API_##N, #n, \
468 vl_api_##n##_t_handler, \
470 vl_api_##n##_t_endian, \
471 vl_api_##n##_t_print, \
472 sizeof(vl_api_##n##_t), 1);
477 * Trace space for 8 MPLS encap labels
479 am->api_trace_cfg[VL_API_MPLS_TUNNEL_ADD_DEL].size += 8 * sizeof (u32);
482 * Set up the (msg_name, crc, message-id) table
484 setup_message_id_table (am);
489 VLIB_API_INIT_FUNCTION (mpls_api_hookup);
492 * fd.io coding-style-patch-verification: ON
495 * eval: (c-set-style "gnu")