src/plugins/gbp/gbp_contract.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_CONTRACT_H__
  17 #define __GBP_CONTRACT_H__
  18
  19 #include <plugins/gbp/gbp_types.h>
  20
  21 /**
  22  * The key for an Contract
  23  */
  24 typedef struct gbp_contract_key_t_
  25 {
  26   union
  27   {
  28     struct
  29     {
  30       /**
  31        * source and destination EPGs for which the ACL applies
  32        */
  33       epg_id_t gck_src;
  34       epg_id_t gck_dst;
  35     };
  36     u32 as_u32;
  37   };
  38 } gbp_contract_key_t;
  39
  40 typedef struct gbp_next_hop_t_
  41 {
  42   fib_node_t gnh_node;
  43   ip46_address_t gnh_ip;
  44   mac_address_t gnh_mac;
  45   index_t gnh_gu;
  46   index_t gnh_bd;
  47   index_t gnh_rd;
  48   u32 gnh_ge;
  49   u32 gnh_sibling;
  50   index_t gnh_ai[FIB_PROTOCOL_IP_MAX];
  51 } gbp_next_hop_t;
  52
  53 #define foreach_gbp_hash_mode   \
  54   _(SRC_IP, "src-ip")           \
  55   _(DST_IP, "dst-ip")
  56
  57 typedef enum gbp_hash_mode_t_
  58 {
  59 #define _(v,s) GBP_HASH_MODE_##v,
  60   foreach_gbp_hash_mode
  61 #undef _
  62 } gbp_hash_mode_t;
  63
  64 #define foreach_gbp_rule_action   \
  65   _(PERMIT,   "permit")           \
  66   _(DENY,     "deny")             \
  67   _(REDIRECT, "redirect")
  68
  69 typedef enum gbp_rule_action_t_
  70 {
  71 #define _(v,s) GBP_RULE_##v,
  72   foreach_gbp_rule_action
  73 #undef _
  74 } gbp_rule_action_t;
  75
  76 #define foreach_gbp_policy_node   \
  77   _(L2, "L2")                     \
  78   _(IP4, "ip4")                   \
  79   _(IP6, "ip6")
  80
  81 typedef enum gbp_policy_node_t_
  82 {
  83 #define _(v,s) GBP_POLICY_NODE_##v,
  84   foreach_gbp_policy_node
  85 #undef _
  86 } gbp_policy_node_t;
  87 #define GBP_POLICY_N_NODES (GBP_POLICY_NODE_IP6+1)
  88
  89 #define FOR_EACH_GBP_POLICY_NODE(pnode)         \
  90   for (pnode = GBP_POLICY_NODE_L2; pnode < GBP_POLICY_N_NODES; pnode++)
  91
  92 typedef struct gbp_rule_t_
  93 {
  94   gbp_rule_action_t gu_action;
  95   gbp_hash_mode_t gu_hash_mode;
  96   index_t *gu_nhs;
  97
  98   /**
  99    * DPO of the load-balance object used to redirect
 100    */
 101   dpo_id_t gu_dpo[GBP_POLICY_N_NODES][FIB_PROTOCOL_IP_MAX];
 102 } gbp_rule_t;
 103
 104 /**
 105  * A Group Based Policy Contract.
 106  *  Determines the ACL that applies to traffic pass between two endpoint groups
 107  */
 108 typedef struct gbp_contract_t_
 109 {
 110   /**
 111    * source and destination EPGs
 112    */
 113   gbp_contract_key_t gc_key;
 114
 115   u32 gc_acl_index;
 116   u32 gc_lc_index;
 117
 118   /**
 119    * The ACL to apply for packets from the source to the destination EPG
 120    */
 121   index_t *gc_rules;
 122 } gbp_contract_t;
 123
 124 /**
 125  * EPG src,dst pair to ACL mapping table, aka contract DB
 126  */
 127 typedef struct gbp_contract_db_t_
 128 {
 129   /**
 130    * We can form a u64 key from the pair, so use a simple hash table
 131    */
 132   uword *gc_hash;
 133 } gbp_contract_db_t;
 134
 135 extern int gbp_contract_update (epg_id_t src_epg,
 136                                 epg_id_t dst_epg,
 137                                 u32 acl_index, index_t * rules);
 138 extern int gbp_contract_delete (epg_id_t src_epg, epg_id_t dst_epg);
 139
 140 extern index_t gbp_rule_alloc (gbp_rule_action_t action,
 141                                gbp_hash_mode_t hash_mode, index_t * nhs);
 142 extern index_t gbp_next_hop_alloc (const ip46_address_t * ip,
 143                                    index_t grd,
 144                                    const mac_address_t * mac, index_t gbd);
 145
 146 typedef int (*gbp_contract_cb_t) (gbp_contract_t * gbpe, void *ctx);
 147 extern void gbp_contract_walk (gbp_contract_cb_t bgpe, void *ctx);
 148
 149 extern u8 *format_gbp_contract (u8 * s, va_list * args);
 150
 151 /**
 152  * DP functions and databases
 153  */
 154 extern gbp_contract_db_t gbp_contract_db;
 155
 156 always_inline index_t
 157 gbp_contract_find (gbp_contract_key_t * key)
 158 {
 159   uword *p;
 160
 161   p = hash_get (gbp_contract_db.gc_hash, key->as_u32);
 162
 163   if (NULL != p)
 164     return (p[0]);
 165
 166   return (INDEX_INVALID);
 167 }
 168
 169 extern gbp_contract_t *gbp_contract_pool;
 170
 171 always_inline gbp_contract_t *
 172 gbp_contract_get (index_t gci)
 173 {
 174   return (pool_elt_at_index (gbp_contract_pool, gci));
 175 }
 176
 177 extern gbp_rule_t *gbp_rule_pool;
 178
 179 always_inline gbp_rule_t *
 180 gbp_rule_get (index_t gui)
 181 {
 182   return (pool_elt_at_index (gbp_rule_pool, gui));
 183 }
 184
 185 #endif
 186
 187 /*
 188  * fd.io coding-style-patch-verification: ON
 189  *
 190  * Local Variables:
 191  * eval: (c-set-style "gnu")
 192  * End:
 193  */