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