FD.io VPP  v17.07.01-10-g3be13f0
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 struct
25 {
26  /* hash bd_id -> bd_index */
28 
29  /* Busy bd_index bitmap */
31 
32  /* convenience */
35 } bd_main_t;
36 
38 
39 /* Bridge domain member */
40 
41 #define L2_FLOOD_MEMBER_NORMAL 0
42 #define L2_FLOOD_MEMBER_BVI 1
43 
44 typedef struct
45 {
46  u32 sw_if_index; /* the output L2 interface */
47  u8 flags; /* 0=normal, 1=bvi */
48  u8 shg; /* split horizon group number */
51 
52 /* Per-bridge domain configuration */
53 
54 typedef struct
55 {
57  /*
58  * Contains bit enables for flooding, learning, and forwarding.
59  * All other feature bits should always be set.
60  *
61  * identity of the bridge-domain's BVI interface
62  * set to ~0 if there is no BVI
63  */
65 
66  /* bridge domain id, not to be confused with bd_index */
68 
69  /* Vector of member ports */
71 
72  /* First flood_count member ports are flooded */
74 
75  /* Tunnel Master (Multicast vxlan) are always flooded */
77 
78  /* Tunnels (Unicast vxlan) are flooded if there are no masters */
80 
81  /* hash ip4/ip6 -> mac for arp/nd termination */
84 
85  /* mac aging */
87 
88  /* sequence number for bridge domain based flush of MACs */
90 
92 
93 /* Limit Bridge Domain ID to 24 bits to match 24-bit VNI range */
94 #define L2_BD_ID_MAX ((1<<24)-1)
95 
96 typedef struct
97 {
107 
108 /* Return 1 if bridge domain has been initialized */
111 {
112  return (bd_config->feature_bitmap != 0);
113 }
114 
115 /* Init bridge domain if not done already */
116 void bd_validate (l2_bridge_domain_t * bd_config);
117 
118 
119 void
120 bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member);
121 
122 u32 bd_remove_member (l2_bridge_domain_t * bd_config, u32 sw_if_index);
123 
124 
125 #define L2_LEARN (1<<0)
126 #define L2_FWD (1<<1)
127 #define L2_FLOOD (1<<2)
128 #define L2_UU_FLOOD (1<<3)
129 #define L2_ARP_TERM (1<<4)
130 
131 u32 bd_set_flags (vlib_main_t * vm, u32 bd_index, u32 flags, u32 enable);
132 void bd_set_mac_age (vlib_main_t * vm, u32 bd_index, u8 age);
134 
135 /**
136  * \brief Get a bridge domain.
137  *
138  * Get a bridge domain with the given bridge domain ID.
139  *
140  * \param bdm bd_main pointer.
141  * \param bd_id The bridge domain ID
142  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
143  */
144 u32 bd_find_index (bd_main_t * bdm, u32 bd_id);
145 
146 /**
147  * \brief Create a bridge domain.
148  *
149  * Create a bridge domain with the given bridge domain ID
150  *
151  * \param bdm bd_main pointer.
152  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
153  */
154 u32 bd_add_bd_index (bd_main_t * bdm, u32 bd_id);
155 
156 /**
157  * \brief Get or create a bridge domain.
158  *
159  * Get a bridge domain with the given bridge domain ID, if one exists, otherwise
160  * create one with the given ID, or the first unused ID if the given ID is ~0..
161  *
162  * \param bdm bd_main pointer.
163  * \param bd_id The bridge domain ID
164  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
165  */
166 static inline u32
168 {
169  u32 bd_index = bd_find_index (bdm, bd_id);
170  if (bd_index == ~0)
171  return bd_add_bd_index (bdm, bd_id);
172  return bd_index;
173 }
174 
175 u32 bd_add_del_ip_mac (u32 bd_index,
176  u8 * ip_addr, u8 * mac_addr, u8 is_ip6, u8 is_add);
177 
178 #endif
179 
180 /*
181  * fd.io coding-style-patch-verification: ON
182  *
183  * Local Variables:
184  * eval: (c-set-style "gnu")
185  * End:
186  */
u32 bvi_sw_if_index
Definition: l2_bd.h:64
l2_flood_member_t * members
Definition: l2_bd.h:70
void bd_add_member(l2_bridge_domain_t *bd_config, l2_flood_member_t *member)
Definition: l2_bd.c:133
int bd_add_del(l2_bridge_domain_add_del_args_t *args)
Definition: l2_bd.c:1114
#define always_inline
Definition: clib.h:84
bd_main_t bd_main
Definition: l2_bd.h:37
u32 bd_add_bd_index(bd_main_t *bdm, u32 bd_id)
Create a bridge domain.
Definition: l2_bd.c:76
uword * bd_index_by_bd_id
Definition: l2_bd.h:27
vnet_main_t * vnet_main
Definition: l2_bd.h:34
u32 bd_set_flags(vlib_main_t *vm, u32 bd_index, u32 flags, u32 enable)
Set the learn/forward/flood flags for the bridge domain.
Definition: l2_bd.c:229
uword * bd_index_bitmap
Definition: l2_bd.h:30
static u32 bd_is_valid(l2_bridge_domain_t *bd_config)
Definition: l2_bd.h:110
u32 tun_master_count
Definition: l2_bd.h:76
u32 bd_remove_member(l2_bridge_domain_t *bd_config, u32 sw_if_index)
Definition: l2_bd.c:172
uword * mac_by_ip6
Definition: l2_bd.h:83
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:719
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:167
unsigned int u32
Definition: types.h:88
u32 tun_normal_count
Definition: l2_bd.h:79
u64 uword
Definition: types.h:112
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:273
vlib_main_t * vlib_main
Definition: l2_bd.h:33
unsigned short u16
Definition: types.h:57
u32 feature_bitmap
Definition: l2_bd.h:56
unsigned char u8
Definition: types.h:56
u32 bd_find_index(bd_main_t *bdm, u32 bd_id)
Get a bridge domain.
Definition: l2_bd.c:67
uword * mac_by_ip4
Definition: l2_bd.h:82
u32 sw_if_index
Definition: l2_bd.h:46
u32 flags
Definition: vhost-user.h:76
void bd_validate(l2_bridge_domain_t *bd_config)
Init bridge domain if not done already.
Definition: l2_bd.c:51