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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef __GBP_CONTRACT_H__
17 #define __GBP_CONTRACT_H__
19 #include <plugins/gbp/gbp_types.h>
21 #define foreach_gbp_policy_error \
22 _(ALLOW_NO_SCLASS, "allow-no-sclass") \
23 _(ALLOW_INTRA, "allow-intra-sclass") \
24 _(ALLOW_A_BIT, "allow-a-bit-set") \
25 _(ALLOW_SCLASS_1, "allow-sclass-1") \
26 _(ALLOW_CONTRACT, "allow-contract") \
27 _(DROP_CONTRACT, "drop-contract") \
28 _(DROP_ETHER_TYPE, "drop-ether-type") \
29 _(DROP_NO_CONTRACT, "drop-no-contract") \
30 _(DROP_NO_DCLASS, "drop-no-dclass")
33 * The key for an Contract
35 typedef struct gbp_contract_key_t_
42 * source and destination EPGs for which the ACL applies
51 typedef struct gbp_next_hop_t_
54 ip46_address_t gnh_ip;
55 mac_address_t gnh_mac;
61 index_t gnh_ai[FIB_PROTOCOL_IP_MAX];
64 #define foreach_gbp_hash_mode \
67 _(SYMMETRIC, "symmetric")
69 typedef enum gbp_hash_mode_t_
71 #define _(v,s) GBP_HASH_MODE_##v,
76 #define foreach_gbp_rule_action \
79 _(REDIRECT, "redirect")
81 typedef enum gbp_rule_action_t_
83 #define _(v,s) GBP_RULE_##v,
84 foreach_gbp_rule_action
88 #define foreach_gbp_policy_node \
93 typedef enum gbp_policy_node_t_
95 #define _(v,s) GBP_POLICY_NODE_##v,
96 foreach_gbp_policy_node
99 #define GBP_POLICY_N_NODES (GBP_POLICY_NODE_IP6+1)
101 #define FOR_EACH_GBP_POLICY_NODE(pnode) \
102 for (pnode = GBP_POLICY_NODE_L2; pnode < GBP_POLICY_N_NODES; pnode++)
104 typedef struct gbp_rule_t_
106 gbp_rule_action_t gu_action;
107 gbp_hash_mode_t gu_hash_mode;
111 * DPO of the load-balance object used to redirect
113 dpo_id_t gu_dpo[GBP_POLICY_N_NODES][FIB_PROTOCOL_IP_MAX];
117 * A Group Based Policy Contract.
118 * Determines the ACL that applies to traffic pass between two endpoint groups
120 typedef struct gbp_contract_t_
123 * source and destination EPGs
125 gbp_contract_key_t gc_key;
131 * The ACL to apply for packets from the source to the destination EPG
136 * An ethertype whitelist
138 u16 *gc_allowed_ethertypes;
142 * EPG src,dst pair to ACL mapping table, aka contract DB
144 typedef struct gbp_contract_db_t_
147 * We can form a u64 key from the pair, so use a simple hash table
152 extern int gbp_contract_update (sclass_t sclass,
156 u16 * allowed_ethertypes, u32 * stats_index);
157 extern int gbp_contract_delete (sclass_t sclass, sclass_t dclass);
159 extern index_t gbp_rule_alloc (gbp_rule_action_t action,
160 gbp_hash_mode_t hash_mode, index_t * nhs);
161 extern index_t gbp_next_hop_alloc (const ip46_address_t * ip,
163 const mac_address_t * mac, index_t gbd);
165 typedef int (*gbp_contract_cb_t) (gbp_contract_t * gbpe, void *ctx);
166 extern void gbp_contract_walk (gbp_contract_cb_t bgpe, void *ctx);
168 extern u8 *format_gbp_contract (u8 * s, va_list * args);
171 * DP functions and databases
173 extern gbp_contract_db_t gbp_contract_db;
175 always_inline index_t
176 gbp_contract_find (gbp_contract_key_t * key)
180 p = hash_get (gbp_contract_db.gc_hash, key->as_u32);
185 return (INDEX_INVALID);
188 extern gbp_contract_t *gbp_contract_pool;
190 always_inline gbp_contract_t *
191 gbp_contract_get (index_t gci)
193 return (pool_elt_at_index (gbp_contract_pool, gci));
196 extern gbp_rule_t *gbp_rule_pool;
198 always_inline gbp_rule_t *
199 gbp_rule_get (index_t gui)
201 return (pool_elt_at_index (gbp_rule_pool, gui));
204 extern vlib_combined_counter_main_t gbp_contract_permit_counters;
205 extern vlib_combined_counter_main_t gbp_contract_drop_counters;
210 * fd.io coding-style-patch-verification: ON
213 * eval: (c-set-style "gnu")