FD.io VPP  v20.05.1-6-gf53edbc3b
Vector Packet Processing
fib_api.h
Go to the documentation of this file.
1 /*
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 
19 #include <vnet/fib/fib_types.h>
20 #include <vnet/fib/fib_entry.h>
21 #include <vnet/ip/ip.api_types.h>
22 
23 /**
24  * Forward declare the API type, no need to include the generated api headers
25  */
26 struct _vl_api_fib_path;
27 struct _vl_api_fib_prefix;
28 
29 /**
30  * Encode and decode functions from the API types to internal types
31  */
32 extern void fib_api_path_encode(const fib_route_path_t * api_rpath,
33  struct _vl_api_fib_path *out);
34 extern int fib_api_path_decode(struct _vl_api_fib_path *in,
35  fib_route_path_t *out);
36 
37 extern int fib_api_table_id_decode(fib_protocol_t fproto,
38  u32 table_id,
39  u32 *fib_index);
40 
41 /**
42  * Adding routes from the API
43  */
44 extern int fib_api_route_add_del (u8 is_add,
45  u8 is_multipath,
46  u32 fib_index,
47  const fib_prefix_t * prefix,
49  fib_route_path_t *rpaths);
50 
51 extern u8* format_vl_api_fib_path(u8 * s, va_list * args);
52 
53 
54 extern int fib_proto_from_api_address_family (vl_api_address_family_t af, fib_protocol_t *out);
55 extern vl_api_address_family_t fib_proto_to_api_address_family (fib_protocol_t fproto);
56 
57 #endif /* __FIB_API_H__ */
u8 * format_vl_api_fib_path(u8 *s, va_list *args)
Definition: fib_api.c:510
A representation of a path as described by a route producer.
Definition: fib_types.h:490
vl_api_prefix_t prefix
Definition: ip.api:144
int fib_api_route_add_del(u8 is_add, u8 is_multipath, u32 fib_index, const fib_prefix_t *prefix, fib_entry_flag_t entry_flags, fib_route_path_t *rpaths)
Adding routes from the API.
Definition: fib_api.c:460
unsigned char u8
Definition: types.h:56
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
vl_api_address_family_t fib_proto_to_api_address_family(fib_protocol_t fproto)
Definition: fib_api.c:557
Aggregate type for a prefix.
Definition: fib_types.h:203
int fib_proto_from_api_address_family(vl_api_address_family_t af, fib_protocol_t *out)
Definition: fib_api.c:541
unsigned int u32
Definition: types.h:88
enum fib_entry_flag_t_ fib_entry_flag_t
void fib_api_path_encode(const fib_route_path_t *api_rpath, struct _vl_api_fib_path *out)
Encode and decode functions from the API types to internal types.
int fib_api_table_id_decode(fib_protocol_t fproto, u32 table_id, u32 *fib_index)
Definition: fib_api.c:45
int fib_api_path_decode(struct _vl_api_fib_path *in, fib_route_path_t *out)
u32 entry_flags
Definition: ip.api:307
u32 table_id
Definition: fib_types.api:118