2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/vnet.h>
17 #include <vlibmemory/api.h>
18 #include <vnet/fib/fib_api.h>
19 #include <vnet/ip/ip_types_api.h>
20 #include <vnet/fib/fib_table.h>
21 #include <vnet/mfib/mfib_table.h>
22 #include <vnet/bier/bier_disp_table.h>
23 #include <vpp/api/types.h>
24 #include <vnet/classify/vnet_classify.h>
25 #include <vnet/ip/ip_format_fns.h>
27 #include <vnet/fib/fib.api_enum.h>
28 #include <vnet/fib/fib.api_types.h>
30 static u16 fib_base_msg_id;
31 #define REPLY_MSG_ID_BASE fib_base_msg_id
32 #include <vlibapi/api_helper_macros.h>
35 fib_api_table_id_decode (fib_protocol_t fproto,
39 *fib_index = fib_table_find(fproto, table_id);
41 if (INDEX_INVALID == *fib_index)
43 return VNET_API_ERROR_NO_SUCH_FIB;
50 fib_api_mtable_id_decode (fib_protocol_t fproto,
54 *fib_index = mfib_table_find(fproto, table_id);
58 return VNET_API_ERROR_NO_SUCH_FIB;
65 fib_api_next_hop_decode (const vl_api_fib_path_t *in,
68 ASSERT (FIB_API_PATH_NH_PROTO_IP4 == in->proto || FIB_API_PATH_NH_PROTO_IP6 == in->proto);
69 *out = to_ip46 (FIB_API_PATH_NH_PROTO_IP6 == in->proto, (void *)&in->nh.address);
72 vl_api_fib_path_nh_proto_t
73 fib_api_path_dpo_proto_to_nh (dpo_proto_t dproto)
78 return (FIB_API_PATH_NH_PROTO_IP4);
80 return (FIB_API_PATH_NH_PROTO_IP6);
82 return (FIB_API_PATH_NH_PROTO_MPLS);
84 return (FIB_API_PATH_NH_PROTO_BIER);
85 case DPO_PROTO_ETHERNET:
86 return (FIB_API_PATH_NH_PROTO_ETHERNET);
91 return (FIB_API_PATH_NH_PROTO_IP4);
96 fib_api_next_hop_encode (const fib_route_path_t *rpath,
97 vl_api_fib_path_t *fp)
99 fp->proto = fib_api_path_dpo_proto_to_nh(rpath->frp_proto);
101 if (rpath->frp_proto == DPO_PROTO_IP4)
102 clib_memcpy (&fp->nh.address.ip4,
103 &rpath->frp_addr.ip4,
104 sizeof (rpath->frp_addr.ip4));
105 else if (rpath->frp_proto == DPO_PROTO_IP6)
106 clib_memcpy (&fp->nh.address.ip6,
107 &rpath->frp_addr.ip6,
108 sizeof (rpath->frp_addr.ip6));
112 fib_api_path_nh_proto_to_dpo (vl_api_fib_path_nh_proto_t pp,
117 case FIB_API_PATH_NH_PROTO_IP4:
118 *dproto = DPO_PROTO_IP4;
120 case FIB_API_PATH_NH_PROTO_IP6:
121 *dproto = DPO_PROTO_IP6;
123 case FIB_API_PATH_NH_PROTO_MPLS:
124 *dproto = DPO_PROTO_MPLS;
126 case FIB_API_PATH_NH_PROTO_BIER:
127 *dproto = DPO_PROTO_BIER;
129 case FIB_API_PATH_NH_PROTO_ETHERNET:
130 *dproto = DPO_PROTO_ETHERNET;
139 fib_api_path_decode (vl_api_fib_path_t *in,
140 fib_route_path_t *out)
142 vnet_classify_main_t *cm = &vnet_classify_main;
143 int rv = 0, n_labels;
147 vnm = vnet_get_main ();
148 clib_memset(&out->frp_dpo, 0, sizeof(out->frp_dpo));
151 in->flags = ntohl (in->flags);
152 in->type = ntohl (in->type);
153 in->proto = ntohl (in->proto);
156 * attributes that apply to all path types
159 out->frp_weight = in->weight;
160 if (0 == out->frp_weight)
164 out->frp_preference = in->preference;
166 rv = fib_api_path_nh_proto_to_dpo(in->proto, &out->frp_proto);
172 * convert the flags and the AFI to determine the path type
174 if (in->flags & FIB_API_PATH_FLAG_RESOLVE_VIA_HOST)
175 out->frp_flags |= FIB_ROUTE_PATH_RESOLVE_VIA_HOST;
176 if (in->flags & FIB_API_PATH_FLAG_RESOLVE_VIA_ATTACHED)
177 out->frp_flags |= FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED;
178 if (in->flags & FIB_API_PATH_FLAG_POP_PW_CW)
179 out->frp_flags |= FIB_ROUTE_PATH_POP_PW_CW;
183 case FIB_API_PATH_TYPE_DVR:
184 out->frp_sw_if_index = ntohl(in->sw_if_index);
185 out->frp_flags |= FIB_ROUTE_PATH_DVR;
187 case FIB_API_PATH_TYPE_INTERFACE_RX:
188 out->frp_sw_if_index = ntohl(in->sw_if_index);
189 out->frp_flags |= FIB_ROUTE_PATH_INTF_RX;
191 case FIB_API_PATH_TYPE_DROP:
192 out->frp_flags |= FIB_ROUTE_PATH_DROP;
194 case FIB_API_PATH_TYPE_LOCAL:
195 out->frp_flags |= FIB_ROUTE_PATH_LOCAL;
196 out->frp_sw_if_index = ntohl(in->sw_if_index);
198 case FIB_API_PATH_TYPE_ICMP_UNREACH:
199 out->frp_flags |= FIB_ROUTE_PATH_ICMP_UNREACH;
201 case FIB_API_PATH_TYPE_ICMP_PROHIBIT:
202 out->frp_flags |= FIB_ROUTE_PATH_ICMP_PROHIBIT;
204 case FIB_API_PATH_TYPE_CLASSIFY:
205 out->frp_flags |= FIB_ROUTE_PATH_CLASSIFY;
207 if (pool_is_free_index (cm->tables, ntohl (in->nh.classify_table_index)))
209 return VNET_API_ERROR_NO_SUCH_TABLE;
211 out->frp_classify_table_id = ntohl (in->nh.classify_table_index);
213 case FIB_API_PATH_TYPE_UDP_ENCAP:
214 out->frp_flags |= FIB_ROUTE_PATH_UDP_ENCAP;
215 out->frp_udp_encap_id = ntohl(in->nh.obj_id);
217 case FIB_API_PATH_TYPE_BIER_IMP:
218 out->frp_flags |= FIB_ROUTE_PATH_BIER_IMP;
219 out->frp_bier_imp = ntohl (in->nh.obj_id);
222 case FIB_API_PATH_TYPE_SOURCE_LOOKUP:
223 out->frp_flags |= FIB_ROUTE_PATH_SOURCE_LOOKUP;
225 case FIB_API_PATH_TYPE_NORMAL:
226 switch (out->frp_proto)
230 fib_api_next_hop_decode(in, &out->frp_addr);
231 out->frp_sw_if_index = ntohl(in->sw_if_index);
232 out->frp_rpf_id = ntohl(in->rpf_id);
234 if (0 == out->frp_rpf_id)
236 /* allow 0 to be an unset value on the API */
237 out->frp_rpf_id = ~0;
240 if (~0 != out->frp_rpf_id)
242 out->frp_flags |= FIB_ROUTE_PATH_RPF_ID;
245 if (~0 == out->frp_sw_if_index)
247 /* recursive or deag, validate the next-hop FIB */
248 if (~0 != out->frp_rpf_id)
250 rv = fib_api_mtable_id_decode(
251 dpo_proto_to_fib(out->frp_proto),
253 &out->frp_fib_index);
257 rv = fib_api_table_id_decode(
258 dpo_proto_to_fib(out->frp_proto),
260 &out->frp_fib_index);
269 if (pool_is_free_index (vnm->interface_main.sw_interfaces,
270 out->frp_sw_if_index))
272 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
276 if (ip46_address_is_zero(&out->frp_addr))
278 if (~0 == out->frp_sw_if_index &&
279 ~0 != out->frp_fib_index)
281 out->frp_flags |= FIB_ROUTE_PATH_DEAG;
287 out->frp_local_label = ntohl (in->nh.via_label);
288 out->frp_eos = MPLS_NON_EOS;
289 out->frp_sw_if_index = ~0;
292 out->frp_sw_if_index = ntohl(in->sw_if_index);
293 out->frp_rpf_id = ntohl(in->rpf_id);
295 if (!(out->frp_flags & FIB_ROUTE_PATH_BIER_IMP))
299 bdti = bier_disp_table_find(ntohl(in->table_id));
301 if (INDEX_INVALID != bdti)
303 out->frp_fib_index = bdti;
307 return (VNET_API_ERROR_NO_SUCH_FIB);
311 case DPO_PROTO_ETHERNET:
312 out->frp_sw_if_index = ntohl(in->sw_if_index);
319 n_labels = in->n_labels;
322 vec_validate (out->frp_label_stack, n_labels - 1);
323 for (ii = 0; ii < n_labels; ii++)
325 out->frp_label_stack[ii].fml_value =
326 ntohl(in->label_stack[ii].label);
327 out->frp_label_stack[ii].fml_ttl =
328 in->label_stack[ii].ttl;
329 out->frp_label_stack[ii].fml_exp =
330 in->label_stack[ii].exp;
331 out->frp_label_stack[ii].fml_mode =
332 (in->label_stack[ii].is_uniform ?
333 FIB_MPLS_LSP_MODE_UNIFORM :
334 FIB_MPLS_LSP_MODE_PIPE);
342 fib_api_path_encode (const fib_route_path_t * rpath,
343 vl_api_fib_path_t *out)
345 memset (out, 0, sizeof (*out));
347 out->weight = rpath->frp_weight;
348 out->preference = rpath->frp_preference;
349 out->sw_if_index = htonl (rpath->frp_sw_if_index);
350 out->proto = fib_api_path_dpo_proto_to_nh(rpath->frp_proto);
351 out->rpf_id = rpath->frp_rpf_id;
352 fib_api_next_hop_encode (rpath, out);
354 if (0 != rpath->frp_fib_index)
356 if ((DPO_PROTO_IP6 == rpath->frp_proto) ||
357 (DPO_PROTO_IP4 == rpath->frp_proto))
359 if (rpath->frp_flags & FIB_ROUTE_PATH_RPF_ID)
361 out->table_id = htonl (mfib_table_get_table_id(
362 rpath->frp_fib_index,
363 dpo_proto_to_fib(rpath->frp_proto)));
367 out->table_id = htonl (fib_table_get_table_id(
368 rpath->frp_fib_index,
369 dpo_proto_to_fib(rpath->frp_proto)));
374 if (rpath->frp_flags & FIB_ROUTE_PATH_DVR)
376 out->type = FIB_API_PATH_TYPE_DVR;
378 else if (rpath->frp_flags & FIB_ROUTE_PATH_ICMP_UNREACH)
380 out->type = FIB_API_PATH_TYPE_ICMP_UNREACH;
382 else if (rpath->frp_flags & FIB_ROUTE_PATH_ICMP_PROHIBIT)
384 out->type = FIB_API_PATH_TYPE_ICMP_PROHIBIT;
386 else if (rpath->frp_flags & FIB_ROUTE_PATH_LOCAL)
388 out->type = FIB_API_PATH_TYPE_LOCAL;
390 else if (rpath->frp_flags & FIB_ROUTE_PATH_DROP)
392 out->type = FIB_API_PATH_TYPE_DROP;
394 else if (rpath->frp_flags & FIB_ROUTE_PATH_UDP_ENCAP)
396 out->type = FIB_API_PATH_TYPE_UDP_ENCAP;
397 out->nh.obj_id = rpath->frp_udp_encap_id;
399 else if (rpath->frp_flags & FIB_ROUTE_PATH_BIER_IMP)
401 out->type = FIB_API_PATH_TYPE_BIER_IMP;
402 out->nh.obj_id = rpath->frp_bier_imp;
404 else if (rpath->frp_flags & FIB_ROUTE_PATH_INTF_RX)
406 out->type = FIB_API_PATH_TYPE_INTERFACE_RX;
410 out->type = FIB_API_PATH_TYPE_NORMAL;
412 if (rpath->frp_flags & FIB_ROUTE_PATH_RESOLVE_VIA_HOST)
414 out->flags |= FIB_API_PATH_FLAG_RESOLVE_VIA_HOST;
416 if (rpath->frp_flags & FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED)
418 out->flags |= FIB_API_PATH_FLAG_RESOLVE_VIA_ATTACHED;
421 out->flags = htonl (out->flags);
422 out->type = htonl (out->type);
423 out->proto = htonl (out->proto);
425 if (rpath->frp_label_stack)
429 for (ii = 0; ii < vec_len(rpath->frp_label_stack); ii++)
431 out->label_stack[ii].label =
432 htonl(rpath->frp_label_stack[ii].fml_value);
433 out->label_stack[ii].ttl =
434 rpath->frp_label_stack[ii].fml_ttl;
435 out->label_stack[ii].exp =
436 rpath->frp_label_stack[ii].fml_exp;
443 fib_api_route_add_del (u8 is_add,
446 const fib_prefix_t * prefix,
448 fib_entry_flag_t entry_flags,
449 fib_route_path_t *rpaths)
451 if (!fib_prefix_validate(prefix)) {
452 return (VNET_API_ERROR_INVALID_PREFIX_LENGTH);
456 if (vec_len(rpaths) == 0)
457 return (VNET_API_ERROR_NO_PATHS_IN_ROUTE);
459 /* Iterative path add/remove */
461 fib_table_entry_path_add2 (fib_index,
467 fib_table_entry_path_remove2 (fib_index,
476 if (vec_len(rpaths) == 0)
477 return (VNET_API_ERROR_NO_PATHS_IN_ROUTE);
479 /* path replacement */
480 fib_table_entry_update (fib_index,
488 fib_table_entry_delete (fib_index,
497 format_vl_api_fib_path (u8 * s, va_list * args)
499 const vl_api_fib_path_t *path = va_arg (*args, vl_api_fib_path_t*);
501 s = format (s, "sw_if_index %d", ntohl (path->sw_if_index));
502 switch (clib_net_to_host_u32(path->proto))
504 case FIB_API_PATH_NH_PROTO_IP4:
505 s = format (s, " %U", format_vl_api_address_union,
506 &path->nh.address, ADDRESS_IP4);
508 case FIB_API_PATH_NH_PROTO_IP6:
509 s = format (s, " %U", format_vl_api_address_union,
510 &path->nh.address, ADDRESS_IP6);
515 s = format (s, " weight %d", path->weight);
516 s = format (s, " preference %d", path->preference);
517 s = format (s, " type %d", ntohl(path->type));
518 s = format (s, " proto %d", ntohl(path->proto));
519 s = format (s, " flags %d", ntohl(path->flags));
520 s = format (s, " n_labels %d", ntohl(path->n_labels));
521 s = format (s, " table-id %d", ntohl(path->table_id));
522 s = format (s, " rpf-id %d", ntohl(path->rpf_id));
528 fib_proto_from_api_address_family (vl_api_address_family_t af, fib_protocol_t * out)
533 *out = (FIB_PROTOCOL_IP4);
536 *out = (FIB_PROTOCOL_IP6);
540 return (VNET_API_ERROR_INVALID_ADDRESS_FAMILY);
543 vl_api_address_family_t
544 fib_proto_to_api_address_family (fib_protocol_t fproto)
548 case FIB_PROTOCOL_IP4:
549 return (ADDRESS_IP4);
550 case FIB_PROTOCOL_IP6:
551 return (ADDRESS_IP6);
557 return (ADDRESS_IP4);
561 vl_api_fib_source_add_t_handler (vl_api_fib_source_add_t * mp)
563 vl_api_fib_source_add_reply_t *rmp;
568 name = format (0, "%s", mp->src.name);
571 src = fib_source_allocate((const char *)name,
577 REPLY_MACRO2 (VL_API_FIB_SOURCE_ADD_REPLY,
583 typedef struct fib_source_dump_ctx_t_
585 vl_api_registration_t * reg;
587 } fib_source_dump_ctx_t;
590 send_fib_source (fib_source_t id,
592 fib_source_priority_t prio,
593 fib_source_behaviour_t bh,
596 vl_api_fib_source_details_t *mp;
597 fib_source_dump_ctx_t *ctx;
600 mp = vl_msg_api_alloc_zero (sizeof (*mp));
604 mp->_vl_msg_id = ntohs (VL_API_FIB_SOURCE_DETAILS + REPLY_MSG_ID_BASE);
605 mp->context = ctx->context;
607 mp->src.priority = prio;
609 clib_memcpy(mp->src.name, name,
610 clib_min(strlen(name), ARRAY_LEN(mp->src.name)));
612 vl_api_send_msg (ctx->reg, (u8 *) mp);
614 return (WALK_CONTINUE);
618 vl_api_fib_source_dump_t_handler (vl_api_fib_source_dump_t * mp)
620 vl_api_registration_t *reg;
622 reg = vl_api_client_index_to_registration (mp->client_index);
626 fib_source_dump_ctx_t ctx = {
628 .context = mp->context,
631 fib_source_walk(send_fib_source, &ctx);
635 #include <vnet/fib/fib.api.c>
637 static clib_error_t *
638 fib_api_hookup (vlib_main_t * vm)
641 * Set up the (msg_name, crc, message-id) table
643 fib_base_msg_id = setup_message_id_table ();
648 VLIB_API_INIT_FUNCTION (fib_api_hookup);