GBP Endpoint Learning
[vpp.git] / src / plugins / gbp / gbp_bridge_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_BRIDGE_DOMAIN_H__
17 #define __GBP_BRIDGE_DOMAIN_H__
18
19 #include <plugins/gbp/gbp_types.h>
20
21 #include <vnet/fib/fib_types.h>
22
23 /**
24  * A bridge Domain Representation.
25  * This is a standard bridge-domain plus all the attributes it must
26  * have to supprt the GBP model.
27  */
28 typedef struct gpb_bridge_domain_t_
29 {
30   /**
31    * Bridge-domain ID
32    */
33   u32 gb_bd_id;
34   u32 gb_bd_index;
35
36   /**
37    * The BD's BVI interface (obligatory)
38    */
39   u32 gb_bvi_sw_if_index;
40
41   /**
42    * The BD's MAC spine-proxy interface (optional)
43    */
44   u32 gb_uu_fwd_sw_if_index;
45
46   /**
47    * The BD's VNI interface on which packets from unkown endpoints
48    * arrive
49    */
50   u32 gb_vni_sw_if_index;
51
52   /**
53    * locks/references to the BD so it does not get deleted (from the API)
54    * whilst it is still being used
55    */
56   u32 gb_locks;
57 } gbp_bridge_domain_t;
58
59 extern int gbp_bridge_domain_add_and_lock (u32 bd_id,
60                                            u32 bvi_sw_if_index,
61                                            u32 uu_fwd_sw_if_index);
62 extern void gbp_bridge_domain_unlock (index_t gbi);
63 extern index_t gbp_bridge_domain_find_and_lock (u32 bd_id);
64 extern int gbp_bridge_domain_delete (u32 bd_id);
65 extern gbp_bridge_domain_t *gbp_bridge_domain_get (index_t i);
66
67 typedef int (*gbp_bridge_domain_cb_t) (gbp_bridge_domain_t * gb, void *ctx);
68 extern void gbp_bridge_domain_walk (gbp_bridge_domain_cb_t bgpe, void *ctx);
69
70 extern u8 *format_gbp_bridge_domain (u8 * s, va_list * args);
71
72 #endif
73
74 /*
75  * fd.io coding-style-patch-verification: ON
76  *
77  * Local Variables:
78  * eval: (c-set-style "gnu")
79  * End:
80  */