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 if (in->proto == FIB_API_PATH_NH_PROTO_IP4)
69 clib_memcpy (&out->ip4, &in->nh.address.ip4, sizeof (out->ip4));
70 else if (in->proto == FIB_API_PATH_NH_PROTO_IP6)
71 clib_memcpy (&out->ip6, &in->nh.address.ip6, sizeof (out->ip6));
74 static vl_api_fib_path_nh_proto_t
75 fib_api_path_dpo_proto_to_nh (dpo_proto_t dproto)
80 return (FIB_API_PATH_NH_PROTO_IP4);
82 return (FIB_API_PATH_NH_PROTO_IP6);
84 return (FIB_API_PATH_NH_PROTO_MPLS);
86 return (FIB_API_PATH_NH_PROTO_BIER);
87 case DPO_PROTO_ETHERNET:
88 return (FIB_API_PATH_NH_PROTO_ETHERNET);
93 return (FIB_API_PATH_NH_PROTO_IP4);
98 fib_api_next_hop_encode (const fib_route_path_t *rpath,
99 vl_api_fib_path_t *fp)
101 fp->proto = fib_api_path_dpo_proto_to_nh(rpath->frp_proto);
103 if (rpath->frp_proto == DPO_PROTO_IP4)
104 clib_memcpy (&fp->nh.address.ip4,
105 &rpath->frp_addr.ip4,
106 sizeof (rpath->frp_addr.ip4));
107 else if (rpath->frp_proto == DPO_PROTO_IP6)
108 clib_memcpy (&fp->nh.address.ip6,
109 &rpath->frp_addr.ip6,
110 sizeof (rpath->frp_addr.ip6));
114 fib_api_path_nh_proto_to_dpo (vl_api_fib_path_nh_proto_t pp,
119 case FIB_API_PATH_NH_PROTO_IP4:
120 *dproto = DPO_PROTO_IP4;
122 case FIB_API_PATH_NH_PROTO_IP6:
123 *dproto = DPO_PROTO_IP6;
125 case FIB_API_PATH_NH_PROTO_MPLS:
126 *dproto = DPO_PROTO_MPLS;
128 case FIB_API_PATH_NH_PROTO_BIER:
129 *dproto = DPO_PROTO_BIER;
131 case FIB_API_PATH_NH_PROTO_ETHERNET:
132 *dproto = DPO_PROTO_ETHERNET;
141 fib_api_path_decode (vl_api_fib_path_t *in,
142 fib_route_path_t *out)
144 vnet_classify_main_t *cm = &vnet_classify_main;
145 int rv = 0, n_labels;
149 vnm = vnet_get_main ();
150 clib_memset(&out->frp_dpo, 0, sizeof(out->frp_dpo));
153 in->flags = ntohl (in->flags);
154 in->type = ntohl (in->type);
155 in->proto = ntohl (in->proto);
158 * attributes that apply to all path types
161 out->frp_weight = in->weight;
162 if (0 == out->frp_weight)
166 out->frp_preference = in->preference;
168 rv = fib_api_path_nh_proto_to_dpo(in->proto, &out->frp_proto);
174 * convert the flags and the AFI to determine the path type
176 if (in->flags & FIB_API_PATH_FLAG_RESOLVE_VIA_HOST)
177 out->frp_flags |= FIB_ROUTE_PATH_RESOLVE_VIA_HOST;
178 if (in->flags & FIB_API_PATH_FLAG_RESOLVE_VIA_ATTACHED)
179 out->frp_flags |= FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED;
180 if (in->flags & FIB_API_PATH_FLAG_POP_PW_CW)
181 out->frp_flags |= FIB_ROUTE_PATH_POP_PW_CW;
185 case FIB_API_PATH_TYPE_DVR:
186 out->frp_sw_if_index = ntohl(in->sw_if_index);
187 out->frp_flags |= FIB_ROUTE_PATH_DVR;
189 case FIB_API_PATH_TYPE_INTERFACE_RX:
190 out->frp_sw_if_index = ntohl(in->sw_if_index);
191 out->frp_flags |= FIB_ROUTE_PATH_INTF_RX;
193 case FIB_API_PATH_TYPE_DROP:
194 out->frp_flags |= FIB_ROUTE_PATH_DROP;
196 case FIB_API_PATH_TYPE_LOCAL:
197 out->frp_flags |= FIB_ROUTE_PATH_LOCAL;
198 out->frp_sw_if_index = ntohl(in->sw_if_index);
200 case FIB_API_PATH_TYPE_ICMP_UNREACH:
201 out->frp_flags |= FIB_ROUTE_PATH_ICMP_UNREACH;
203 case FIB_API_PATH_TYPE_ICMP_PROHIBIT:
204 out->frp_flags |= FIB_ROUTE_PATH_ICMP_PROHIBIT;
206 case FIB_API_PATH_TYPE_CLASSIFY:
207 out->frp_flags |= FIB_ROUTE_PATH_CLASSIFY;
209 if (pool_is_free_index (cm->tables, ntohl (in->nh.classify_table_index)))
211 return VNET_API_ERROR_NO_SUCH_TABLE;
213 out->frp_classify_table_id = ntohl (in->nh.classify_table_index);
215 case FIB_API_PATH_TYPE_UDP_ENCAP:
216 out->frp_flags |= FIB_ROUTE_PATH_UDP_ENCAP;
217 out->frp_udp_encap_id = ntohl(in->nh.obj_id);
219 case FIB_API_PATH_TYPE_BIER_IMP:
220 out->frp_flags |= FIB_ROUTE_PATH_BIER_IMP;
221 out->frp_bier_imp = ntohl (in->nh.obj_id);
224 case FIB_API_PATH_TYPE_SOURCE_LOOKUP:
225 out->frp_flags |= FIB_ROUTE_PATH_SOURCE_LOOKUP;
227 case FIB_API_PATH_TYPE_NORMAL:
228 switch (out->frp_proto)
232 fib_api_next_hop_decode(in, &out->frp_addr);
233 out->frp_sw_if_index = ntohl(in->sw_if_index);
234 out->frp_rpf_id = ntohl(in->rpf_id);
236 if (0 == out->frp_rpf_id)
238 /* allow 0 to be an unset value on the API */
239 out->frp_rpf_id = ~0;
242 if (~0 != out->frp_rpf_id)
244 out->frp_flags |= FIB_ROUTE_PATH_RPF_ID;
247 if (~0 == out->frp_sw_if_index)
249 /* recursive or deag, validate the next-hop FIB */
250 if (~0 != out->frp_rpf_id)
252 rv = fib_api_mtable_id_decode(
253 dpo_proto_to_fib(out->frp_proto),
255 &out->frp_fib_index);
259 rv = fib_api_table_id_decode(
260 dpo_proto_to_fib(out->frp_proto),
262 &out->frp_fib_index);
271 if (pool_is_free_index (vnm->interface_main.sw_interfaces,
272 out->frp_sw_if_index))
274 return VNET_API_ERROR_NO_MATCHING_INTERFACE;
278 if (ip46_address_is_zero(&out->frp_addr))
280 if (~0 == out->frp_sw_if_index &&
281 ~0 != out->frp_fib_index)
283 out->frp_flags |= FIB_ROUTE_PATH_DEAG;
289 out->frp_local_label = ntohl (in->nh.via_label);
290 out->frp_eos = MPLS_NON_EOS;
291 out->frp_sw_if_index = ~0;
294 out->frp_sw_if_index = ntohl(in->sw_if_index);
295 out->frp_rpf_id = ntohl(in->rpf_id);
297 if (!(out->frp_flags & FIB_ROUTE_PATH_BIER_IMP))
299 fib_api_next_hop_decode(in, &out->frp_addr);
301 if (ip46_address_is_zero(&out->frp_addr))
305 bdti = bier_disp_table_find(ntohl(in->table_id));
307 if (INDEX_INVALID != bdti)
309 out->frp_fib_index = bdti;
313 return (VNET_API_ERROR_NO_SUCH_FIB);
318 case DPO_PROTO_ETHERNET:
319 out->frp_sw_if_index = ntohl(in->sw_if_index);
326 n_labels = in->n_labels;
329 vec_validate (out->frp_label_stack, n_labels - 1);
330 for (ii = 0; ii < n_labels; ii++)
332 out->frp_label_stack[ii].fml_value =
333 ntohl(in->label_stack[ii].label);
334 out->frp_label_stack[ii].fml_ttl =
335 in->label_stack[ii].ttl;
336 out->frp_label_stack[ii].fml_exp =
337 in->label_stack[ii].exp;
338 out->frp_label_stack[ii].fml_mode =
339 (in->label_stack[ii].is_uniform ?
340 FIB_MPLS_LSP_MODE_UNIFORM :
341 FIB_MPLS_LSP_MODE_PIPE);
349 fib_api_path_encode (const fib_route_path_t * rpath,
350 vl_api_fib_path_t *out)
352 memset (out, 0, sizeof (*out));
354 out->weight = rpath->frp_weight;
355 out->preference = rpath->frp_preference;
356 out->sw_if_index = htonl (rpath->frp_sw_if_index);
357 out->proto = fib_api_path_dpo_proto_to_nh(rpath->frp_proto);
358 out->rpf_id = rpath->frp_rpf_id;
359 fib_api_next_hop_encode (rpath, out);
361 if (0 != rpath->frp_fib_index)
363 if ((DPO_PROTO_IP6 == rpath->frp_proto) ||
364 (DPO_PROTO_IP4 == rpath->frp_proto))
366 if (rpath->frp_flags & FIB_ROUTE_PATH_RPF_ID)
368 out->table_id = htonl (mfib_table_get_table_id(
369 rpath->frp_fib_index,
370 dpo_proto_to_fib(rpath->frp_proto)));
374 out->table_id = htonl (fib_table_get_table_id(
375 rpath->frp_fib_index,
376 dpo_proto_to_fib(rpath->frp_proto)));
381 if (rpath->frp_flags & FIB_ROUTE_PATH_DVR)
383 out->type = FIB_API_PATH_TYPE_DVR;
385 else if (rpath->frp_flags & FIB_ROUTE_PATH_ICMP_UNREACH)
387 out->type = FIB_API_PATH_TYPE_ICMP_UNREACH;
389 else if (rpath->frp_flags & FIB_ROUTE_PATH_ICMP_PROHIBIT)
391 out->type = FIB_API_PATH_TYPE_ICMP_PROHIBIT;
393 else if (rpath->frp_flags & FIB_ROUTE_PATH_LOCAL)
395 out->type = FIB_API_PATH_TYPE_LOCAL;
397 else if (rpath->frp_flags & FIB_ROUTE_PATH_DROP)
399 out->type = FIB_API_PATH_TYPE_DROP;
401 else if (rpath->frp_flags & FIB_ROUTE_PATH_UDP_ENCAP)
403 out->type = FIB_API_PATH_TYPE_UDP_ENCAP;
404 out->nh.obj_id = rpath->frp_udp_encap_id;
406 else if (rpath->frp_flags & FIB_ROUTE_PATH_BIER_IMP)
408 out->type = FIB_API_PATH_TYPE_BIER_IMP;
409 out->nh.obj_id = rpath->frp_bier_imp;
411 else if (rpath->frp_flags & FIB_ROUTE_PATH_INTF_RX)
413 out->type = FIB_API_PATH_TYPE_INTERFACE_RX;
417 out->type = FIB_API_PATH_TYPE_NORMAL;
419 if (rpath->frp_flags & FIB_ROUTE_PATH_RESOLVE_VIA_HOST)
421 out->flags |= FIB_API_PATH_FLAG_RESOLVE_VIA_HOST;
423 if (rpath->frp_flags & FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED)
425 out->flags |= FIB_API_PATH_FLAG_RESOLVE_VIA_ATTACHED;
428 out->flags = htonl (out->flags);
429 out->type = htonl (out->type);
430 out->proto = htonl (out->proto);
432 if (rpath->frp_label_stack)
436 for (ii = 0; ii < vec_len(rpath->frp_label_stack); ii++)
438 out->label_stack[ii].label =
439 htonl(rpath->frp_label_stack[ii].fml_value);
440 out->label_stack[ii].ttl =
441 rpath->frp_label_stack[ii].fml_ttl;
442 out->label_stack[ii].exp =
443 rpath->frp_label_stack[ii].fml_exp;
450 fib_api_route_add_del (u8 is_add,
453 const fib_prefix_t * prefix,
455 fib_entry_flag_t entry_flags,
456 fib_route_path_t *rpaths)
460 if (vec_len(rpaths) == 0)
461 return (VNET_API_ERROR_NO_PATHS_IN_ROUTE);
463 /* Iterative path add/remove */
465 fib_table_entry_path_add2 (fib_index,
471 fib_table_entry_path_remove2 (fib_index,
480 if (vec_len(rpaths) == 0)
481 return (VNET_API_ERROR_NO_PATHS_IN_ROUTE);
483 /* path replacement */
484 fib_table_entry_update (fib_index,
492 fib_table_entry_delete (fib_index,
501 format_vl_api_fib_path (u8 * s, va_list * args)
503 const vl_api_fib_path_t *path = va_arg (*args, vl_api_fib_path_t*);
505 s = format (s, "sw_if_index %d", ntohl (path->sw_if_index));
506 switch (clib_net_to_host_u32(path->proto))
508 case FIB_API_PATH_NH_PROTO_IP4:
509 s = format (s, " %U", format_vl_api_address_union,
510 &path->nh.address, ADDRESS_IP4);
512 case FIB_API_PATH_NH_PROTO_IP6:
513 s = format (s, " %U", format_vl_api_address_union,
514 &path->nh.address, ADDRESS_IP6);
519 s = format (s, " weight %d", path->weight);
520 s = format (s, " preference %d", path->preference);
521 s = format (s, " type %d", ntohl(path->type));
522 s = format (s, " proto %d", ntohl(path->proto));
523 s = format (s, " flags %d", ntohl(path->flags));
524 s = format (s, " n_labels %d", ntohl(path->n_labels));
525 s = format (s, " table-id %d", ntohl(path->table_id));
526 s = format (s, " rpf-id %d", ntohl(path->rpf_id));
532 fib_proto_from_api_address_family (vl_api_address_family_t af, fib_protocol_t * out)
537 *out = (FIB_PROTOCOL_IP4);
540 *out = (FIB_PROTOCOL_IP6);
544 return (VNET_API_ERROR_INVALID_ADDRESS_FAMILY);
547 vl_api_address_family_t
548 fib_proto_to_api_address_family (fib_protocol_t fproto)
552 case FIB_PROTOCOL_IP4:
553 return (ADDRESS_IP4);
554 case FIB_PROTOCOL_IP6:
555 return (ADDRESS_IP6);
561 return (ADDRESS_IP4);
565 vl_api_fib_source_add_t_handler (vl_api_fib_source_add_t * mp)
567 vl_api_fib_source_add_reply_t *rmp;
572 name = format (0, "%s", mp->src.name);
575 src = fib_source_allocate((const char *)name,
581 REPLY_MACRO2 (VL_API_FIB_SOURCE_ADD_REPLY,
587 typedef struct fib_source_dump_ctx_t_
589 vl_api_registration_t * reg;
591 } fib_source_dump_ctx_t;
594 send_fib_source (fib_source_t id,
596 fib_source_priority_t prio,
597 fib_source_behaviour_t bh,
600 vl_api_fib_source_details_t *mp;
601 fib_source_dump_ctx_t *ctx;
604 mp = vl_msg_api_alloc_zero (sizeof (*mp));
608 mp->_vl_msg_id = ntohs (VL_API_FIB_SOURCE_DETAILS + REPLY_MSG_ID_BASE);
609 mp->context = ctx->context;
611 mp->src.priority = prio;
613 clib_memcpy(mp->src.name, name,
614 clib_min(strlen(name), ARRAY_LEN(mp->src.name)));
616 vl_api_send_msg (ctx->reg, (u8 *) mp);
618 return (WALK_CONTINUE);
622 vl_api_fib_source_dump_t_handler (vl_api_fib_source_dump_t * mp)
624 vl_api_registration_t *reg;
626 reg = vl_api_client_index_to_registration (mp->client_index);
630 fib_source_dump_ctx_t ctx = {
632 .context = mp->context,
635 fib_source_walk(send_fib_source, &ctx);
639 #include <vnet/fib/fib.api.c>
641 static clib_error_t *
642 fib_api_hookup (vlib_main_t * vm)
645 * Set up the (msg_name, crc, message-id) table
647 fib_base_msg_id = setup_message_id_table ();
652 VLIB_API_INIT_FUNCTION (fib_api_hookup);