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
  23 /**
  24  * Bridge Domain Flags
  25  */
  26 typedef enum gbp_bridge_domain_flags_t_
  27 {
  28   GBP_BD_FLAG_NONE = 0,
  29   GBP_BD_FLAG_DO_NOT_LEARN = (1 << 0),
  30 } gbp_bridge_domain_flags_t;
  31
  32 /**
  33  * A bridge Domain Representation.
  34  * This is a standard bridge-domain plus all the attributes it must
  35  * have to supprt the GBP model.
  36  */
  37 typedef struct gbp_bridge_domain_t_
  38 {
  39   /**
  40    * Bridge-domain ID
  41    */
  42   u32 gb_bd_id;
  43   u32 gb_bd_index;
  44
  45   /**
  46    * Flags conttrolling behaviour
  47    */
  48   gbp_bridge_domain_flags_t gb_flags;
  49
  50   /**
  51    * The BD's BVI interface (obligatory)
  52    */
  53   u32 gb_bvi_sw_if_index;
  54
  55   /**
  56    * The BD's MAC spine-proxy interface (optional)
  57    */
  58   u32 gb_uu_fwd_sw_if_index;
  59
  60   /**
  61    * The BD's VNI interface on which packets from unkown endpoints
  62    * arrive
  63    */
  64   u32 gb_vni_sw_if_index;
  65
  66   /**
  67    * locks/references to the BD so it does not get deleted (from the API)
  68    * whilst it is still being used
  69    */
  70   u32 gb_locks;
  71 } gbp_bridge_domain_t;
  72
  73 extern int gbp_bridge_domain_add_and_lock (u32 bd_id,
  74                                            gbp_bridge_domain_flags_t flags,
  75                                            u32 bvi_sw_if_index,
  76                                            u32 uu_fwd_sw_if_index);
  77 extern void gbp_bridge_domain_unlock (index_t gbi);
  78 extern index_t gbp_bridge_domain_find_and_lock (u32 bd_id);
  79 extern int gbp_bridge_domain_delete (u32 bd_id);
  80 extern index_t gbp_bridge_domain_index (const gbp_bridge_domain_t *);
  81 extern u32 gbp_bridge_domain_get_bd_id (index_t gbdi);
  82
  83 typedef int (*gbp_bridge_domain_cb_t) (gbp_bridge_domain_t * gb, void *ctx);
  84 extern void gbp_bridge_domain_walk (gbp_bridge_domain_cb_t bgpe, void *ctx);
  85
  86 extern u8 *format_gbp_bridge_domain (u8 * s, va_list * args);
  87
  88 /**
  89  * DB of bridge_domains
  90  */
  91 typedef struct gbp_bridge_domain_db_t
  92 {
  93   uword *gbd_by_bd_id;
  94   index_t *gbd_by_bd_index;
  95 } gbp_bridge_domain_db_t;
  96
  97 extern gbp_bridge_domain_db_t gbp_bridge_domain_db;
  98 extern gbp_bridge_domain_t *gbp_bridge_domain_pool;
  99
 100 always_inline gbp_bridge_domain_t *
 101 gbp_bridge_domain_get (index_t i)
 102 {
 103   return (pool_elt_at_index (gbp_bridge_domain_pool, i));
 104 }
 105
 106 always_inline gbp_bridge_domain_t *
 107 gbp_bridge_domain_get_by_bd_index (u32 bd_index)
 108 {
 109   return (gbp_bridge_domain_get
 110           (gbp_bridge_domain_db.gbd_by_bd_index[bd_index]));
 111 }
 112
 113 #endif
 114
 115 /*
 116  * fd.io coding-style-patch-verification: ON
 117  *
 118  * Local Variables:
 119  * eval: (c-set-style "gnu")
 120  * End:
 121  */