FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
l2_bd.h
Go to the documentation of this file.
1 /*
2  * l2_bd.h : layer 2 bridge domain
3  *
4  * Copyright (c) 2013 Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef included_l2bd_h
19 #define included_l2bd_h
20 
21 #include <vlib/vlib.h>
22 #include <vnet/vnet.h>
23 
24 typedef enum l2_bd_port_type_t_
25 {
30 
31 typedef struct
32 {
33  /* hash bd_id -> bd_index */
35 
36  /* Busy bd_index bitmap */
38 
39  /* convenience */
42 } bd_main_t;
43 
44 extern bd_main_t bd_main;
45 
46 /* Bridge domain member */
47 
48 #define L2_FLOOD_MEMBER_NORMAL 0
49 #define L2_FLOOD_MEMBER_BVI 1
50 
51 typedef struct
52 {
53  u32 sw_if_index; /* the output L2 interface */
54  u8 flags; /* 0=normal, 1=bvi */
55  u8 shg; /* split horizon group number */
58 
59 /* Per-bridge domain configuration */
60 
61 typedef struct
62 {
63  /*
64  * Contains bit enables for flooding, learning, and forwarding.
65  * All other feature bits should always be set.
66  */
68  /*
69  * identity of the bridge-domain's BVI interface
70  * set to ~0 if there is no BVI
71  */
73 
74  /*
75  * identity of the bridge-domain's UU flood interface
76  * set to ~0 if there is no such configuration
77  */
79 
80  /* bridge domain id, not to be confused with bd_index */
82 
83  /* Vector of member ports */
85 
86  /* First flood_count member ports are flooded */
88 
89  /* Tunnel Master (Multicast vxlan) are always flooded */
91 
92  /* Tunnels (Unicast vxlan) are flooded if there are no masters */
94 
95  /* Interface on which packets are not flooded */
97 
98  /* hash ip4/ip6 -> mac for arp/nd termination */
101 
102  /* mac aging */
104 
105  /* sequence number for bridge domain based flush of MACs */
107 
108  /* Bridge domain tag (C string NULL terminated) */
110 
112 
113 /* Limit Bridge Domain ID to 24 bits to match 24-bit VNI range */
114 #define L2_BD_ID_MAX ((1<<24)-1)
115 
116 typedef struct
117 {
128 
129 /* Return 1 if bridge domain has been initialized */
132 {
133  return (bd_config->feature_bitmap != 0);
134 }
135 
136 /* Init bridge domain if not done already */
137 void bd_validate (l2_bridge_domain_t * bd_config);
138 
139 
140 void
141 bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member);
142 
144 
145 typedef enum bd_flags_t_
146 {
147  L2_NONE = 0,
148  L2_LEARN = (1 << 0),
149  L2_FWD = (1 << 1),
150  L2_FLOOD = (1 << 2),
151  L2_UU_FLOOD = (1 << 3),
152  L2_ARP_TERM = (1 << 4),
153 } bd_flags_t;
154 
156  u32 enable);
157 void bd_set_mac_age (vlib_main_t * vm, u32 bd_index, u8 age);
159 
160 /**
161  * \brief Get a bridge domain.
162  *
163  * Get a bridge domain with the given bridge domain ID.
164  *
165  * \param bdm bd_main pointer.
166  * \param bd_id The bridge domain ID
167  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
168  */
169 u32 bd_find_index (bd_main_t * bdm, u32 bd_id);
170 
171 /**
172  * \brief Create a bridge domain.
173  *
174  * Create a bridge domain with the given bridge domain ID
175  *
176  * \param bdm bd_main pointer.
177  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
178  */
179 u32 bd_add_bd_index (bd_main_t * bdm, u32 bd_id);
180 
181 /**
182  * \brief Get or create a bridge domain.
183  *
184  * Get a bridge domain with the given bridge domain ID, if one exists, otherwise
185  * create one with the given ID, or the first unused ID if the given ID is ~0..
186  *
187  * \param bdm bd_main pointer.
188  * \param bd_id The bridge domain ID
189  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
190  */
191 static inline u32
193 {
194  u32 bd_index = bd_find_index (bdm, bd_id);
195  if (bd_index == ~0)
196  return bd_add_bd_index (bdm, bd_id);
197  return bd_index;
198 }
199 
200 u32 bd_add_del_ip_mac (u32 bd_index,
201  u8 * ip_addr, u8 * mac_addr, u8 is_ip6, u8 is_add);
202 
203 #endif
204 
205 /*
206  * fd.io coding-style-patch-verification: ON
207  *
208  * Local Variables:
209  * eval: (c-set-style "gnu")
210  * End:
211  */
u32 uu_fwd_sw_if_index
Definition: l2_bd.h:78
u32 bvi_sw_if_index
Definition: l2_bd.h:72
Definition: l2_bd.h:149
l2_flood_member_t * members
Definition: l2_bd.h:84
void bd_add_member(l2_bridge_domain_t *bd_config, l2_flood_member_t *member)
Definition: l2_bd.c:140
unsigned char u8
Definition: types.h:56
int bd_add_del(l2_bridge_domain_add_del_args_t *args)
Definition: l2_bd.c:1159
u32 sw_if_index
Definition: vxlan_gbp.api:39
#define always_inline
Definition: clib.h:94
bd_main_t bd_main
Definition: l2_bd.c:44
u32 bd_set_flags(vlib_main_t *vm, u32 bd_index, bd_flags_t flags, u32 enable)
Set the learn/forward/flood flags for the bridge domain.
Definition: l2_bd.c:244
u32 bd_add_bd_index(bd_main_t *bdm, u32 bd_id)
Create a bridge domain.
Definition: l2_bd.c:78
unsigned int u32
Definition: types.h:88
uword * bd_index_by_bd_id
Definition: l2_bd.h:34
vnet_main_t * vnet_main
Definition: l2_bd.h:41
unsigned short u16
Definition: types.h:57
enum l2_bd_port_type_t_ l2_bd_port_type_t
uword * bd_index_bitmap
Definition: l2_bd.h:37
static u32 bd_is_valid(l2_bridge_domain_t *bd_config)
Definition: l2_bd.h:131
Definition: l2_bd.h:147
u32 flags
Definition: vhost_user.h:115
u32 no_flood_count
Definition: l2_bd.h:96
vlib_main_t * vm
Definition: buffer.c:294
u32 tun_master_count
Definition: l2_bd.h:90
u32 bd_remove_member(l2_bridge_domain_t *bd_config, u32 sw_if_index)
Definition: l2_bd.c:185
uword * mac_by_ip6
Definition: l2_bd.h:100
u32 bd_add_del_ip_mac(u32 bd_index, u8 *ip_addr, u8 *mac_addr, u8 is_ip6, u8 is_add)
Add/delete IP address to MAC address mapping.
Definition: l2_bd.c:735
static u32 bd_find_or_add_bd_index(bd_main_t *bdm, u32 bd_id)
Get or create a bridge domain.
Definition: l2_bd.h:192
bd_flags_t_
Definition: l2_bd.h:145
u32 tun_normal_count
Definition: l2_bd.h:93
void bd_set_mac_age(vlib_main_t *vm, u32 bd_index, u8 age)
Set the mac age for the bridge domain.
Definition: l2_bd.c:288
vlib_main_t * vlib_main
Definition: l2_bd.h:40
l2_bd_port_type_t_
Definition: l2_bd.h:24
u32 feature_bitmap
Definition: l2_bd.h:67
u64 uword
Definition: types.h:112
u32 bd_find_index(bd_main_t *bdm, u32 bd_id)
Get a bridge domain.
Definition: l2_bd.c:69
uword * mac_by_ip4
Definition: l2_bd.h:99
u32 sw_if_index
Definition: l2_bd.h:53
void bd_validate(l2_bridge_domain_t *bd_config)
Init bridge domain if not done already.
Definition: l2_bd.c:51
enum bd_flags_t_ bd_flags_t