src/vnet/l2/l2_bd.h

   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 #include <vnet/ip/ip6_packet.h>
  24 #include <vnet/ethernet/mac_address.h>
  25
  26 typedef enum l2_bd_port_type_t_
  27 {
  28   L2_BD_PORT_TYPE_NORMAL = 0,
  29   L2_BD_PORT_TYPE_BVI = 1,
  30   L2_BD_PORT_TYPE_UU_FWD = 2,
  31 } l2_bd_port_type_t;
  32
  33 typedef struct
  34 {
  35   /* hash bd_id -> bd_index */
  36   uword *bd_index_by_bd_id;
  37
  38   /* Busy bd_index bitmap */
  39   uword *bd_index_bitmap;
  40
  41   /* convenience */
  42   vlib_main_t *vlib_main;
  43   vnet_main_t *vnet_main;
  44 } bd_main_t;
  45
  46 extern bd_main_t bd_main;
  47
  48 /* Bridge domain member  */
  49
  50 #define L2_FLOOD_MEMBER_NORMAL 0
  51 #define L2_FLOOD_MEMBER_BVI    1
  52
  53 typedef struct
  54 {
  55   u32 sw_if_index;              /* the output L2 interface */
  56   u8 flags;                     /* 0=normal, 1=bvi */
  57   u8 shg;                       /* split horizon group number  */
  58   u16 spare;
  59 } l2_flood_member_t;
  60
  61 /* Per-bridge domain configuration */
  62
  63 typedef struct
  64 {
  65   /*
  66    * Contains bit enables for flooding, learning, and forwarding.
  67    * All other feature bits should always be set.
  68    */
  69   u32 feature_bitmap;
  70   /*
  71    * identity of the bridge-domain's BVI interface
  72    * set to ~0 if there is no BVI
  73    */
  74   u32 bvi_sw_if_index;
  75
  76   /*
  77    * identity of the bridge-domain's UU flood interface
  78    * set to ~0 if there is no such configuration
  79    */
  80   u32 uu_fwd_sw_if_index;
  81
  82   /* bridge domain id, not to be confused with bd_index */
  83   u32 bd_id;
  84
  85   /* Vector of member ports */
  86   l2_flood_member_t *members;
  87
  88   /* First flood_count member ports are flooded */
  89   u32 flood_count;
  90
  91   /* Tunnel Master (Multicast vxlan) are always flooded */
  92   u32 tun_master_count;
  93
  94   /* Tunnels (Unicast vxlan) are flooded if there are no masters */
  95   u32 tun_normal_count;
  96
  97   /* Interface on which packets are not flooded */
  98   u32 no_flood_count;
  99
 100   /* hash ip4/ip6 -> mac for arp/nd termination */
 101   uword *mac_by_ip4;
 102   uword *mac_by_ip6;
 103
 104   /* mac aging */
 105   u8 mac_age;
 106
 107   /* sequence number for bridge domain based flush of MACs */
 108   u8 seq_num;
 109
 110   /* Bridge domain tag (C string NULL terminated) */
 111   u8 *bd_tag;
 112
 113 } l2_bridge_domain_t;
 114
 115 /* Limit Bridge Domain ID to 24 bits to match 24-bit VNI range */
 116 #define L2_BD_ID_MAX ((1<<24)-1)
 117
 118 typedef struct
 119 {
 120   u32 bd_id;
 121   u8 flood;
 122   u8 uu_flood;
 123   u8 forward;
 124   u8 learn;
 125   u8 arp_term;
 126   u8 mac_age;
 127   u8 *bd_tag;
 128   u8 is_add;
 129 } l2_bridge_domain_add_del_args_t;
 130
 131 /* Return 1 if bridge domain has been initialized */
 132 always_inline u32
 133 bd_is_valid (l2_bridge_domain_t * bd_config)
 134 {
 135   return (bd_config->feature_bitmap != 0);
 136 }
 137
 138 /* Init bridge domain if not done already */
 139 void bd_validate (l2_bridge_domain_t * bd_config);
 140
 141
 142 void
 143 bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member);
 144
 145 u32 bd_remove_member (l2_bridge_domain_t * bd_config, u32 sw_if_index);
 146
 147 typedef enum bd_flags_t_
 148 {
 149   L2_NONE = 0,
 150   L2_LEARN = (1 << 0),
 151   L2_FWD = (1 << 1),
 152   L2_FLOOD = (1 << 2),
 153   L2_UU_FLOOD = (1 << 3),
 154   L2_ARP_TERM = (1 << 4),
 155 } bd_flags_t;
 156
 157 u32 bd_set_flags (vlib_main_t * vm, u32 bd_index, bd_flags_t flags,
 158                   u32 enable);
 159 void bd_set_mac_age (vlib_main_t * vm, u32 bd_index, u8 age);
 160 int bd_add_del (l2_bridge_domain_add_del_args_t * args);
 161
 162 /**
 163  * \brief Get a bridge domain.
 164  *
 165  * Get a bridge domain with the given bridge domain ID.
 166  *
 167  * \param bdm bd_main pointer.
 168  * \param bd_id The bridge domain ID
 169  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
 170  */
 171 u32 bd_find_index (bd_main_t * bdm, u32 bd_id);
 172
 173 /**
 174  * \brief Create a bridge domain.
 175  *
 176  * Create a bridge domain with the given bridge domain ID
 177  *
 178  * \param bdm bd_main pointer.
 179  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
 180  */
 181 u32 bd_add_bd_index (bd_main_t * bdm, u32 bd_id);
 182
 183 /**
 184  * \brief Get or create a bridge domain.
 185  *
 186  * Get a bridge domain with the given bridge domain ID, if one exists, otherwise
 187  * create one with the given ID, or the first unused ID if the given ID is ~0..
 188  *
 189  * \param bdm bd_main pointer.
 190  * \param bd_id The bridge domain ID
 191  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
 192  */
 193 static inline u32
 194 bd_find_or_add_bd_index (bd_main_t * bdm, u32 bd_id)
 195 {
 196   u32 bd_index = bd_find_index (bdm, bd_id);
 197   if (bd_index == ~0)
 198     return bd_add_bd_index (bdm, bd_id);
 199   return bd_index;
 200 }
 201
 202 u32 bd_add_del_ip_mac (u32 bd_index,
 203                        ip46_type_t type,
 204                        const ip46_address_t * ip_addr,
 205                        const mac_address_t * mac, u8 is_add);
 206
 207 void bd_flush_ip_mac (u32 bd_index);
 208
 209 #endif
 210
 211 /*
 212  * fd.io coding-style-patch-verification: ON
 213  *
 214  * Local Variables:
 215  * eval: (c-set-style "gnu")
 216  * End:
 217  */