src/plugins/gbp/gbp_bridge_domain.h

   1 /*
   2  * Copyright (c) 2018 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef __GBP_BRIDGE_DOMAIN_H__
  17 #define __GBP_BRIDGE_DOMAIN_H__
  18
  19 #include <plugins/gbp/gbp_types.h>
  20
  21 #include <vnet/fib/fib_types.h>
  22 #include <vnet/l2/l2_bd.h>
  23
  24 /**
  25  * Bridge Domain Flags
  26  */
  27 typedef enum gbp_bridge_domain_flags_t_
  28 {
  29   GBP_BD_FLAG_NONE = 0,
  30   GBP_BD_FLAG_DO_NOT_LEARN = (1 << 0),
  31   GBP_BD_FLAG_UU_FWD_DROP = (1 << 1),
  32   GBP_BD_FLAG_MCAST_DROP = (1 << 2),
  33   GBP_BD_FLAG_UCAST_ARP = (1 << 3),
  34 } gbp_bridge_domain_flags_t;
  35
  36 /**
  37  * A bridge Domain Representation.
  38  * This is a standard bridge-domain plus all the attributes it must
  39  * have to supprt the GBP model.
  40  */
  41 typedef struct gbp_bridge_domain_t_
  42 {
  43   /**
  44    * Bridge-domain ID
  45    */
  46   u32 gb_bd_id;
  47   u32 gb_bd_index;
  48
  49   /**
  50    * Index of the Route-domain this BD is associated with. This is used as the
  51    * 'scope' of the packets for contract matching.
  52    */
  53   u32 gb_rdi;
  54
  55   /**
  56    * Flags conttrolling behaviour
  57    */
  58   gbp_bridge_domain_flags_t gb_flags;
  59
  60   /**
  61    * The BD's BVI interface (obligatory)
  62    */
  63   u32 gb_bvi_sw_if_index;
  64
  65   /**
  66    * The BD's MAC spine-proxy interface (optional)
  67    */
  68   u32 gb_uu_fwd_sw_if_index;
  69
  70   /**
  71    * The BD's interface to sned Broadcast and multicast packets
  72    */
  73   u32 gb_bm_flood_sw_if_index;
  74
  75   /**
  76    * The index of the BD's VNI interface on which packets from
  77    * unkown endpoints arrive
  78    */
  79   u32 gb_vni;
  80
  81   /**
  82    * locks/references to the BD so it does not get deleted (from the API)
  83    * whilst it is still being used
  84    */
  85   u32 gb_locks;
  86 } gbp_bridge_domain_t;
  87
  88 extern void gbp_bridge_domain_itf_add (u32 sw_if_index, u32 bd_index,
  89                                        l2_bd_port_type_t type);
  90 extern void gbp_bridge_domain_itf_del (u32 sw_if_index, u32 bd_index,
  91                                        l2_bd_port_type_t type);
  92
  93 extern int gbp_bridge_domain_add_and_lock (u32 bd_id,
  94                                            u32 rd_id,
  95                                            gbp_bridge_domain_flags_t flags,
  96                                            u32 bvi_sw_if_index,
  97                                            u32 uu_fwd_sw_if_index,
  98                                            u32 bm_flood_sw_if_index);
  99
 100 extern void gbp_bridge_domain_unlock (index_t gbi);
 101 extern index_t gbp_bridge_domain_find_and_lock (u32 bd_id);
 102 extern int gbp_bridge_domain_delete (u32 bd_id);
 103 extern index_t gbp_bridge_domain_index (const gbp_bridge_domain_t *);
 104 extern u32 gbp_bridge_domain_get_bd_id (index_t gbdi);
 105
 106 typedef int (*gbp_bridge_domain_cb_t) (gbp_bridge_domain_t * gb, void *ctx);
 107 extern void gbp_bridge_domain_walk (gbp_bridge_domain_cb_t bgpe, void *ctx);
 108
 109 extern u8 *format_gbp_bridge_domain (u8 * s, va_list * args);
 110 extern u8 *format_gbp_bridge_domain_flags (u8 * s, va_list * args);
 111
 112 /**
 113  * DB of bridge_domains
 114  */
 115 typedef struct gbp_bridge_domain_db_t
 116 {
 117   uword *gbd_by_bd_id;
 118   index_t *gbd_by_bd_index;
 119 } gbp_bridge_domain_db_t;
 120
 121 extern gbp_bridge_domain_db_t gbp_bridge_domain_db;
 122 extern gbp_bridge_domain_t *gbp_bridge_domain_pool;
 123
 124 always_inline gbp_bridge_domain_t *
 125 gbp_bridge_domain_get (index_t i)
 126 {
 127   return (pool_elt_at_index (gbp_bridge_domain_pool, i));
 128 }
 129
 130 always_inline gbp_bridge_domain_t *
 131 gbp_bridge_domain_get_by_bd_index (u32 bd_index)
 132 {
 133   return (gbp_bridge_domain_get
 134           (gbp_bridge_domain_db.gbd_by_bd_index[bd_index]));
 135 }
 136
 137 extern gbp_scope_t *gbp_scope_by_bd_index;
 138
 139 always_inline gbp_scope_t
 140 gbp_bridge_domain_get_scope (u32 bd_index)
 141 {
 142   return (gbp_scope_by_bd_index[bd_index]);
 143 }
 144
 145 #endif
 146
 147 /*
 148  * fd.io coding-style-patch-verification: ON
 149  *
 150  * Local Variables:
 151  * eval: (c-set-style "gnu")
 152  * End:
 153  */