2 * l2_bd.h : layer 2 bridge domain
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #ifndef included_l2bd_h
19 #define included_l2bd_h
21 #include <vlib/vlib.h>
22 #include <vnet/vnet.h>
26 /* hash bd_id -> bd_index */
27 uword *bd_index_by_bd_id;
29 /* Busy bd_index bitmap */
30 uword *bd_index_bitmap;
33 vlib_main_t *vlib_main;
34 vnet_main_t *vnet_main;
39 /* Bridge domain member */
41 #define L2_FLOOD_MEMBER_NORMAL 0
42 #define L2_FLOOD_MEMBER_BVI 1
46 u32 sw_if_index; /* the output L2 interface */
47 u8 flags; /* 0=normal, 1=bvi */
48 u8 shg; /* split horizon group number */
52 /* Per-bridge domain configuration */
58 * Contains bit enables for flooding, learning, and forwarding.
59 * All other feature bits should always be set.
61 * identity of the bridge-domain's BVI interface
62 * set to ~0 if there is no BVI
66 /* bridge domain id, not to be confused with bd_index */
69 /* Vector of member ports */
70 l2_flood_member_t *members;
72 /* First flood_count member ports are flooded */
75 /* Tunnel Master (Multicast vxlan) are always flooded */
78 /* Tunnels (Unicast vxlan) are flooded if there are no masters */
81 /* hash ip4/ip6 -> mac for arp/nd termination */
88 /* sequence number for bridge domain based flush of MACs */
93 /* Limit Bridge Domain ID to 24 bits to match 24-bit VNI range */
94 #define L2_BD_ID_MAX ((1<<24)-1)
106 } l2_bridge_domain_add_del_args_t;
108 /* Return 1 if bridge domain has been initialized */
110 bd_is_valid (l2_bridge_domain_t * bd_config)
112 return (bd_config->feature_bitmap != 0);
115 /* Init bridge domain if not done already */
116 void bd_validate (l2_bridge_domain_t * bd_config);
120 bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member);
122 u32 bd_remove_member (l2_bridge_domain_t * bd_config, u32 sw_if_index);
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)
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);
133 int bd_add_del (l2_bridge_domain_add_del_args_t * args);
136 * \brief Get a bridge domain.
138 * Get a bridge domain with the given bridge domain ID.
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.
144 u32 bd_find_index (bd_main_t * bdm, u32 bd_id);
147 * \brief Create a bridge domain.
149 * Create a bridge domain with the given bridge domain ID
151 * \param bdm bd_main pointer.
152 * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
154 u32 bd_add_bd_index (bd_main_t * bdm, u32 bd_id);
157 * \brief Get or create a bridge domain.
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..
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.
167 bd_find_or_add_bd_index (bd_main_t * bdm, u32 bd_id)
169 u32 bd_index = bd_find_index (bdm, bd_id);
171 return bd_add_bd_index (bdm, bd_id);
175 u32 bd_add_del_ip_mac (u32 bd_index,
176 u8 * ip_addr, u8 * mac_addr, u8 is_ip6, u8 is_add);
181 * fd.io coding-style-patch-verification: ON
184 * eval: (c-set-style "gnu")