blob: 9eac62fe1c6b3ee59cdaf79701111c5c609fe504 [file] [log] [blame]
Dave Barachb5e8a772016-12-06 12:04:42 -05001/*
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:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15
16#ifndef __FIB_API_H__
17#define __FIB_API_H__
18
Neale Ranns81458422018-03-12 06:59:36 -070019#include <vnet/fib/fib_types.h>
Neale Ranns097fa662018-05-01 05:17:55 -070020#include <vnet/fib/fib_entry.h>
Jakub Grajciar7dd63e52020-03-19 08:03:55 +010021#include <vnet/ip/ip.api_types.h>
Dave Barachb5e8a772016-12-06 12:04:42 -050022
Neale Ranns097fa662018-05-01 05:17:55 -070023/**
24 * Forward declare the API type, no need to include the generated api headers
25 */
Neale Ranns81458422018-03-12 06:59:36 -070026struct _vl_api_fib_path;
Neale Ranns097fa662018-05-01 05:17:55 -070027struct _vl_api_fib_prefix;
Neale Ranns81458422018-03-12 06:59:36 -070028
Neale Ranns097fa662018-05-01 05:17:55 -070029/**
30 * Encode and decode functions from the API types to internal types
31 */
Benoît Ganne83e73702021-08-10 16:23:36 +020032extern vl_api_fib_path_nh_proto_t fib_api_path_dpo_proto_to_nh (dpo_proto_t dproto);
33extern int fib_api_path_nh_proto_to_dpo (vl_api_fib_path_nh_proto_t pp, dpo_proto_t *dproto);
Neale Ranns097fa662018-05-01 05:17:55 -070034extern void fib_api_path_encode(const fib_route_path_t * api_rpath,
Neale Ranns990f6942020-10-20 07:20:17 +000035 vl_api_fib_path_t *out);
36extern int fib_api_path_decode(vl_api_fib_path_t *in,
Neale Ranns097fa662018-05-01 05:17:55 -070037 fib_route_path_t *out);
Dave Barachb5e8a772016-12-06 12:04:42 -050038
Neale Ranns097fa662018-05-01 05:17:55 -070039extern int fib_api_table_id_decode(fib_protocol_t fproto,
40 u32 table_id,
41 u32 *fib_index);
Neale Ranns2303cb12018-02-21 04:57:17 -080042
Neale Ranns097fa662018-05-01 05:17:55 -070043/**
44 * Adding routes from the API
45 */
Neale Rannsc2ac2352019-07-02 14:33:29 +000046extern int fib_api_route_add_del (u8 is_add,
47 u8 is_multipath,
48 u32 fib_index,
49 const fib_prefix_t * prefix,
Neale Ranns976b2592019-12-04 06:11:00 +000050 fib_source_t src,
Neale Rannsc2ac2352019-07-02 14:33:29 +000051 fib_entry_flag_t entry_flags,
52 fib_route_path_t *rpaths);
Neale Ranns2303cb12018-02-21 04:57:17 -080053
Benoît Ganne32dc9132024-06-17 15:33:59 +020054extern u8 *format_vl_api_address_union (u8 * s, va_list * args);
Neale Ranns097fa662018-05-01 05:17:55 -070055extern u8* format_vl_api_fib_path(u8 * s, va_list * args);
Neale Ranns2303cb12018-02-21 04:57:17 -080056
Neale Ranns2303cb12018-02-21 04:57:17 -080057
Jakub Grajciar7dd63e52020-03-19 08:03:55 +010058extern int fib_proto_from_api_address_family (vl_api_address_family_t af, fib_protocol_t *out);
59extern vl_api_address_family_t fib_proto_to_api_address_family (fib_protocol_t fproto);
Neale Rannsd1e68ab2018-10-01 01:42:13 -070060
Dave Barachb5e8a772016-12-06 12:04:42 -050061#endif /* __FIB_API_H__ */