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
  24 typedef struct
  25 {
  26   /* hash bd_id -> bd_index */
  27   uword *bd_index_by_bd_id;
  28
  29   /* Busy bd_index bitmap */
  30   uword *bd_index_bitmap;
  31
  32   /* convenience */
  33   vlib_main_t *vlib_main;
  34   vnet_main_t *vnet_main;
  35 } bd_main_t;
  36
  37 extern bd_main_t bd_main;
  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  */
  49   u16 spare;
  50 } l2_flood_member_t;
  51
  52 /* Per-bridge domain configuration */
  53
  54 typedef struct
  55 {
  56   u32 feature_bitmap;
  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    */
  64   u32 bvi_sw_if_index;
  65
  66   /* bridge domain id, not to be confused with bd_index */
  67   u32 bd_id;
  68
  69   /* Vector of member ports */
  70   l2_flood_member_t *members;
  71
  72   /* First flood_count member ports are flooded */
  73   u32 flood_count;
  74
  75   /* Tunnel Master (Multicast vxlan) are always flooded */
  76   u32 tun_master_count;
  77
  78   /* Tunnels (Unicast vxlan) are flooded if there are no masters */
  79   u32 tun_normal_count;
  80
  81   /* hash ip4/ip6 -> mac for arp/nd termination */
  82   uword *mac_by_ip4;
  83   uword *mac_by_ip6;
  84
  85   /* mac aging */
  86   u8 mac_age;
  87
  88   /* sequence number for bridge domain based flush of MACs */
  89   u8 seq_num;
  90
  91   /* Bridge domain tag (C string NULL terminated) */
  92   u8 *bd_tag;
  93
  94 } l2_bridge_domain_t;
  95
  96 /* Limit Bridge Domain ID to 24 bits to match 24-bit VNI range */
  97 #define L2_BD_ID_MAX ((1<<24)-1)
  98
  99 typedef struct
 100 {
 101   u32 bd_id;
 102   u8 flood;
 103   u8 uu_flood;
 104   u8 forward;
 105   u8 learn;
 106   u8 arp_term;
 107   u8 mac_age;
 108   u8 *bd_tag;
 109   u8 is_add;
 110 } l2_bridge_domain_add_del_args_t;
 111
 112 /* Return 1 if bridge domain has been initialized */
 113 always_inline u32
 114 bd_is_valid (l2_bridge_domain_t * bd_config)
 115 {
 116   return (bd_config->feature_bitmap != 0);
 117 }
 118
 119 /* Init bridge domain if not done already */
 120 void bd_validate (l2_bridge_domain_t * bd_config);
 121
 122
 123 void
 124 bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member);
 125
 126 u32 bd_remove_member (l2_bridge_domain_t * bd_config, u32 sw_if_index);
 127
 128
 129 #define L2_LEARN   (1<<0)
 130 #define L2_FWD     (1<<1)
 131 #define L2_FLOOD   (1<<2)
 132 #define L2_UU_FLOOD (1<<3)
 133 #define L2_ARP_TERM (1<<4)
 134
 135 u32 bd_set_flags (vlib_main_t * vm, u32 bd_index, u32 flags, u32 enable);
 136 void bd_set_mac_age (vlib_main_t * vm, u32 bd_index, u8 age);
 137 int bd_add_del (l2_bridge_domain_add_del_args_t * args);
 138
 139 /**
 140  * \brief Get a bridge domain.
 141  *
 142  * Get a bridge domain with the given bridge domain ID.
 143  *
 144  * \param bdm bd_main pointer.
 145  * \param bd_id The bridge domain ID
 146  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
 147  */
 148 u32 bd_find_index (bd_main_t * bdm, u32 bd_id);
 149
 150 /**
 151  * \brief Create a bridge domain.
 152  *
 153  * Create a bridge domain with the given bridge domain ID
 154  *
 155  * \param bdm bd_main pointer.
 156  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
 157  */
 158 u32 bd_add_bd_index (bd_main_t * bdm, u32 bd_id);
 159
 160 /**
 161  * \brief Get or create a bridge domain.
 162  *
 163  * Get a bridge domain with the given bridge domain ID, if one exists, otherwise
 164  * create one with the given ID, or the first unused ID if the given ID is ~0..
 165  *
 166  * \param bdm bd_main pointer.
 167  * \param bd_id The bridge domain ID
 168  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
 169  */
 170 static inline u32
 171 bd_find_or_add_bd_index (bd_main_t * bdm, u32 bd_id)
 172 {
 173   u32 bd_index = bd_find_index (bdm, bd_id);
 174   if (bd_index == ~0)
 175     return bd_add_bd_index (bdm, bd_id);
 176   return bd_index;
 177 }
 178
 179 u32 bd_add_del_ip_mac (u32 bd_index,
 180                        u8 * ip_addr, u8 * mac_addr, u8 is_ip6, u8 is_add);
 181
 182 #endif
 183
 184 /*
 185  * fd.io coding-style-patch-verification: ON
 186  *
 187  * Local Variables:
 188  * eval: (c-set-style "gnu")
 189  * End:
 190  */