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 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
  53 /* Per-bridge domain configuration */
  54
  55 typedef struct
  56 {
  57   u32 feature_bitmap;
  58   /*
  59    * Contains bit enables for flooding, learning, and forwarding.
  60    * All other feature bits should always be set.
  61    *
  62    * identity of the bridge-domain's BVI interface
  63    * set to ~0 if there is no BVI
  64    */
  65   u32 bvi_sw_if_index;
  66
  67   /* bridge domain id, not to be confused with bd_index */
  68   u32 bd_id;
  69
  70   /* Vector of member ports */
  71   l2_flood_member_t *members;
  72
  73   /* First flood_count member ports are flooded */
  74   u32 flood_count;
  75
  76   /* Tunnel Master (Multicast vxlan) are always flooded */
  77   u32 tun_master_count;
  78
  79   /* Tunnels (Unicast vxlan) are flooded if there are no masters */
  80   u32 tun_normal_count;
  81
  82   /* hash ip4/ip6 -> mac for arp/nd termination */
  83   uword *mac_by_ip4;
  84   uword *mac_by_ip6;
  85
  86   /* mac aging */
  87   u8 mac_age;
  88
  89   /* sequence number for bridge domain based flush of MACs */
  90   u8 seq_num;
  91
  92 } l2_bridge_domain_t;
  93
  94 typedef struct
  95 {
  96   u32 bd_id;
  97   u8 flood;
  98   u8 uu_flood;
  99   u8 forward;
 100   u8 learn;
 101   u8 arp_term;
 102   u8 mac_age;
 103   u8 is_add;
 104 } l2_bridge_domain_add_del_args_t;
 105
 106 /* Return 1 if bridge domain has been initialized */
 107 always_inline u32
 108 bd_is_valid (l2_bridge_domain_t * bd_config)
 109 {
 110   return (bd_config->feature_bitmap != 0);
 111 }
 112
 113 /* Init bridge domain if not done already */
 114 void bd_validate (l2_bridge_domain_t * bd_config);
 115
 116
 117 void
 118 bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member);
 119
 120 u32 bd_remove_member (l2_bridge_domain_t * bd_config, u32 sw_if_index);
 121
 122
 123 #define L2_LEARN   (1<<0)
 124 #define L2_FWD     (1<<1)
 125 #define L2_FLOOD   (1<<2)
 126 #define L2_UU_FLOOD (1<<3)
 127 #define L2_ARP_TERM (1<<4)
 128
 129 u32 bd_set_flags (vlib_main_t * vm, u32 bd_index, u32 flags, u32 enable);
 130 void bd_set_mac_age (vlib_main_t * vm, u32 bd_index, u8 age);
 131
 132 /**
 133  * \brief Get or create a bridge domain.
 134  *
 135  * Get or create a bridge domain with the given bridge domain ID.
 136  *
 137  * \param bdm bd_main pointer.
 138  * \param bd_id The bridge domain ID or ~0 if an arbitrary unused bridge domain should be used.
 139  * \return The bridge domain index in \c l2input_main->l2_bridge_domain_t vector.
 140  */
 141 u32 bd_find_or_add_bd_index (bd_main_t * bdm, u32 bd_id);
 142
 143 /**
 144  * \brief Delete a bridge domain.
 145  *
 146  * Delete an existing bridge domain with the given bridge domain ID.
 147  *
 148  * \param bdm bd_main pointer.
 149  * \param bd_id The bridge domain ID.
 150  * \return 0 on success and -1 if the bridge domain does not exist.
 151  */
 152 int bd_delete_bd_index (bd_main_t * bdm, u32 bd_id);
 153
 154 u32 bd_add_del_ip_mac (u32 bd_index,
 155                        u8 * ip_addr, u8 * mac_addr, u8 is_ip6, u8 is_add);
 156
 157 #endif
 158
 159 /*
 160  * fd.io coding-style-patch-verification: ON
 161  *
 162  * Local Variables:
 163  * eval: (c-set-style "gnu")
 164  * End:
 165  */