gbp: VRF scoped contracts
[vpp.git] / src / plugins / gbp / gbp_route_domain.h
1 /*
2  * Copyright (c) 2018 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 __GBP_ROUTE_DOMAIN_H__
17 #define __GBP_ROUTE_DOMAIN_H__
18
19 #include <plugins/gbp/gbp_types.h>
20
21 #include <vnet/fib/fib_types.h>
22 #include <vnet/ethernet/mac_address.h>
23
24 /**
25  * A route Domain Representation.
26  * This is a standard route-domain plus all the attributes it must
27  * have to supprt the GBP model.
28  */
29 typedef struct gpb_route_domain_t_
30 {
31   /**
32    * Route-domain ID
33    */
34   u32 grd_id;
35   gbp_scope_t grd_scope;
36   u32 grd_fib_index[FIB_PROTOCOL_IP_MAX];
37   u32 grd_table_id[FIB_PROTOCOL_IP_MAX];
38
39   /**
40    * The RD's VNI interface on which packets from unkown endpoints
41    * arrive
42    */
43   u32 grd_vni_sw_if_index;
44
45   /**
46    * The interfaces on which to send packets to unnknown EPs
47    */
48   u32 grd_uu_sw_if_index[FIB_PROTOCOL_IP_MAX];
49
50   /**
51    * adjacencies on the UU interfaces.
52    */
53   u32 grd_adj[FIB_PROTOCOL_IP_MAX];
54
55   u32 grd_locks;
56 } gbp_route_domain_t;
57
58 extern int gbp_route_domain_add_and_lock (u32 rd_id,
59                                           gbp_scope_t scope,
60                                           u32 ip4_table_id,
61                                           u32 ip6_table_id,
62                                           u32 ip4_uu_sw_if_index,
63                                           u32 ip6_uu_sw_if_index);
64 extern void gbp_route_domain_unlock (index_t grdi);
65 extern index_t gbp_route_domain_find_and_lock (u32 rd_id);
66 extern index_t gbp_route_domain_find (u32 rd_id);
67 extern index_t gbp_route_domain_index (const gbp_route_domain_t *);
68
69 extern int gbp_route_domain_delete (u32 rd_id);
70 extern gbp_route_domain_t *gbp_route_domain_get (index_t i);
71 extern u32 gbp_route_domain_get_rd_id (index_t i);
72 extern gbp_scope_t gbp_route_domain_get_scope (index_t i);
73
74 typedef int (*gbp_route_domain_cb_t) (gbp_route_domain_t * gb, void *ctx);
75 extern void gbp_route_domain_walk (gbp_route_domain_cb_t bgpe, void *ctx);
76
77 extern const mac_address_t *gbp_route_domain_get_local_mac (void);
78 extern const mac_address_t *gbp_route_domain_get_remote_mac (void);
79
80 extern u8 *format_gbp_route_domain (u8 * s, va_list * args);
81
82 #endif
83
84 /*
85  * fd.io coding-style-patch-verification: ON
86  *
87  * Local Variables:
88  * eval: (c-set-style "gnu")
89  * End:
90  */