2 * Copyright (c) 2016 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.
15 #ifndef included_acl_h
16 #define included_acl_h
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/l2/l2_output.h>
23 #include <vppinfra/hash.h>
24 #include <vppinfra/error.h>
25 #include <vppinfra/bitmap.h>
26 #include <vppinfra/elog.h>
27 #include <vppinfra/bihash_48_8.h>
28 #include <vppinfra/bihash_40_8.h>
29 #include <vppinfra/bihash_16_8.h>
33 #include "hash_lookup_types.h"
34 #include "lookup_context.h"
36 #define ACL_PLUGIN_VERSION_MAJOR 1
37 #define ACL_PLUGIN_VERSION_MINOR 3
39 #define UDP_SESSION_IDLE_TIMEOUT_SEC 600
40 #define TCP_SESSION_IDLE_TIMEOUT_SEC (3600*24)
41 #define TCP_SESSION_TRANSIENT_TIMEOUT_SEC 120
43 #define SESSION_PURGATORY_TIMEOUT_USEC 10
45 #define ACL_PLUGIN_HASH_LOOKUP_HEAP_SIZE (2 << 25)
46 #define ACL_PLUGIN_HASH_LOOKUP_HASH_BUCKETS 65536
47 #define ACL_PLUGIN_HASH_LOOKUP_HASH_MEMORY (2 << 25)
49 extern vlib_node_registration_t acl_in_node;
50 extern vlib_node_registration_t acl_out_node;
52 void input_acl_packet_match(u32 sw_if_index, vlib_buffer_t * b0, u32 *nextp, u32 *acl_match_p, u32 *rule_match_p, u32 *trace_bitmap);
53 void output_acl_packet_match(u32 sw_if_index, vlib_buffer_t * b0, u32 *nextp, u32 *acl_match_p, u32 *rule_match_p, u32 *trace_bitmap);
56 ACL_TIMEOUT_UNUSED = 0,
59 ACL_TIMEOUT_TCP_TRANSIENT,
61 ACL_TIMEOUT_PURGATORY = ACL_N_USER_TIMEOUTS, /* a special-case queue for deletion-in-progress sessions */
66 enum address_e { IP4, IP6 };
82 ip46_address_t src_ip_addr;
91 /** Required for pool_get_aligned */
92 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
100 /** Required for pool_get_aligned */
101 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
104 macip_acl_rule_t *rules;
105 /* References to the classifier tables that will enforce the rules */
109 /* outacl classifier tables */
110 u32 out_ip4_table_index;
111 u32 out_ip6_table_index;
112 u32 out_l2_table_index;
116 * An element describing a particular configuration fo the mask,
117 * and how many times it has been used.
121 /** Required for pool_get_aligned */
122 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
125 } ace_mask_type_entry_t;
128 /* mheap to hold all the ACL module related allocations, other than hash */
130 uword acl_mheap_size;
132 /* API message ID base */
135 /* The pool of users of ACL lookup contexts */
136 acl_lookup_context_user_t *acl_users;
137 /* The pool of ACL lookup contexts */
138 acl_lookup_context_t *acl_lookup_contexts;
140 acl_list_t *acls; /* Pool of ACLs */
141 hash_acl_info_t *hash_acl_infos; /* corresponding hash matching housekeeping info */
142 clib_bihash_48_8_t acl_lookup_hash; /* ACL lookup hash table. */
143 u32 hash_lookup_hash_buckets;
144 u32 hash_lookup_hash_memory;
146 /* mheap to hold all the miscellaneous allocations related to hash-based lookups */
147 void *hash_lookup_mheap;
148 uword hash_lookup_mheap_size;
149 int acl_lookup_hash_initialized;
151 applied_hash_ace_entry_t **input_hash_entry_vec_by_sw_if_index;
152 applied_hash_ace_entry_t **output_hash_entry_vec_by_sw_if_index;
153 applied_hash_acl_info_t *input_applied_hash_acl_info_by_sw_if_index;
154 applied_hash_acl_info_t *output_applied_hash_acl_info_by_sw_if_index;
156 applied_hash_ace_entry_t **hash_entry_vec_by_lc_index;
157 applied_hash_acl_info_t *applied_hash_acl_info_by_lc_index;
159 /* Corresponding lookup context indices for in/out lookups per sw_if_index */
160 u32 *input_lc_index_by_sw_if_index;
161 u32 *output_lc_index_by_sw_if_index;
162 /* context user id for interface ACLs */
163 u32 interface_acl_user_id;
165 macip_acl_list_t *macip_acls; /* Pool of MAC-IP ACLs */
167 /* ACLs associated with interfaces */
168 u32 **input_acl_vec_by_sw_if_index;
169 u32 **output_acl_vec_by_sw_if_index;
171 /* interfaces on which given ACLs are applied */
172 u32 **input_sw_if_index_vec_by_acl;
173 u32 **output_sw_if_index_vec_by_acl;
175 /* bitmaps 1=sw_if_index has in/out ACL processing enabled */
176 uword *in_acl_on_sw_if_index;
177 uword *out_acl_on_sw_if_index;
179 /* lookup contexts where a given ACL is used */
180 u32 **lc_index_vec_by_acl;
182 /* input and output policy epochs by interface */
183 u32 *input_policy_epoch_by_sw_if_index;
184 u32 *output_policy_epoch_by_sw_if_index;
186 /* whether we need to take the epoch of the session into account */
187 int reclassify_sessions;
191 /* Total count of interface+direction pairs enabled */
192 u32 fa_total_enabled_count;
194 /* Do we use hash-based ACL matching or linear */
195 int use_hash_acl_matching;
197 /* Do we use the TupleMerge for hash ACLs or not */
200 /* Max collision vector length before splitting the tuple */
201 #define TM_SPLIT_THRESHOLD 39
202 int tuple_merge_split_threshold;
204 /* a pool of all mask types present in all ACEs */
205 ace_mask_type_entry_t *ace_mask_type_pool;
207 /* vec of vectors of all info of all mask types present in ACEs contained in each lc_index */
208 hash_applied_mask_info_t **hash_applied_mask_info_vec_by_lc_index;
211 * Classify tables used to grab the packets for the ACL check,
212 * and serving as the 5-tuple session tables at the same time
214 u32 *acl_ip4_input_classify_table_by_sw_if_index;
215 u32 *acl_ip6_input_classify_table_by_sw_if_index;
216 u32 *acl_ip4_output_classify_table_by_sw_if_index;
217 u32 *acl_ip6_output_classify_table_by_sw_if_index;
219 u32 *acl_dot1q_input_classify_table_by_sw_if_index;
220 u32 *acl_dot1ad_input_classify_table_by_sw_if_index;
221 u32 *acl_dot1q_output_classify_table_by_sw_if_index;
222 u32 *acl_dot1ad_output_classify_table_by_sw_if_index;
224 u32 *acl_etype_input_classify_table_by_sw_if_index;
225 u32 *acl_etype_output_classify_table_by_sw_if_index;
227 u16 **input_etype_whitelist_by_sw_if_index;
228 u16 **output_etype_whitelist_by_sw_if_index;
230 /* MACIP (input) ACLs associated with the interfaces */
231 u32 *macip_acl_by_sw_if_index;
233 /* Vector of interfaces on which given MACIP ACLs are applied */
234 u32 **sw_if_index_vec_by_macip_acl;
236 /* bitmaps when set the processing is enabled on the interface */
237 uword *fa_in_acl_on_sw_if_index;
238 uword *fa_out_acl_on_sw_if_index;
239 /* bihash holding all of the sessions */
240 int fa_sessions_hash_is_initialized;
241 clib_bihash_40_8_t fa_ip6_sessions_hash;
242 clib_bihash_16_8_t fa_ip4_sessions_hash;
243 /* The process node which orcherstrates the cleanup */
244 u32 fa_cleaner_node_index;
245 /* FA session timeouts, in seconds */
246 u32 session_timeout_sec[ACL_N_TIMEOUTS];
247 /* total session adds/dels */
248 u64 fa_session_total_adds;
249 u64 fa_session_total_dels;
250 /* how many sessions went into purgatory */
251 u64 fa_session_total_deactivations;
253 /* L2 datapath glue */
255 /* next indices within L2 classifiers for ip4/ip6 fa L2 nodes */
256 u32 l2_input_classify_next_acl_ip4;
257 u32 l2_input_classify_next_acl_ip6;
258 u32 l2_output_classify_next_acl_ip4;
259 u32 l2_output_classify_next_acl_ip6;
260 /* next node indices for L2 dispatch */
261 u32 fa_acl_in_ip4_l2_node_feat_next_node_index[32];
262 u32 fa_acl_in_ip6_l2_node_feat_next_node_index[32];
263 u32 fa_acl_out_ip4_l2_node_feat_next_node_index[32];
264 u32 fa_acl_out_ip6_l2_node_feat_next_node_index[32];
266 /* EH values that we can skip over */
267 uword *fa_ipv6_known_eh_bitmap;
269 /* whether to match L4 ACEs with ports on the non-initial fragment */
270 int l4_match_nonfirst_fragment;
272 /* conn table per-interface conn table parameters */
273 u32 fa_conn_table_hash_num_buckets;
274 uword fa_conn_table_hash_memory_size;
275 u64 fa_conn_table_max_entries;
281 * If the cleaner has to delete more than this number
282 * of connections, it halves the sleep time.
285 #define ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL 100
286 u64 fa_max_deleted_sessions_per_interval;
289 * If the cleaner deletes less than these connections,
290 * it increases the wait time by the "increment"
293 #define ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL 1
294 u64 fa_min_deleted_sessions_per_interval;
296 #define ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT 0.1
297 f64 fa_cleaner_wait_time_increment;
299 u64 fa_current_cleaner_timer_wait_interval;
301 int fa_interrupt_generation;
303 /* per-worker data related t conn management */
304 acl_fa_per_worker_data_t *per_worker_data;
306 /* Configured session timeout */
307 u64 session_timeout[ACL_N_TIMEOUTS];
310 /* Counters for the cleaner thread */
312 #define foreach_fa_cleaner_counter \
313 _(fa_cleaner_cnt_delete_by_sw_index, "delete_by_sw_index events") \
314 _(fa_cleaner_cnt_delete_by_sw_index_ok, "delete_by_sw_index handled ok") \
315 _(fa_cleaner_cnt_unknown_event, "unknown events received") \
316 _(fa_cleaner_cnt_timer_restarted, "session idle timers restarted") \
317 _(fa_cleaner_cnt_wait_with_timeout, "event wait with timeout called") \
318 _(fa_cleaner_cnt_wait_without_timeout, "event wait w/o timeout called") \
319 _(fa_cleaner_cnt_event_cycles, "total event cycles") \
320 /* end of counters */
321 #define _(id, desc) u32 id;
322 foreach_fa_cleaner_counter
326 vlib_main_t * vlib_main;
327 vnet_main_t * vnet_main;
329 vlib_log_class_t log_default;
332 #define acl_log_err(...) \
333 vlib_log(VLIB_LOG_LEVEL_ERR, acl_main.log_default, __VA_ARGS__)
334 #define acl_log_warn(...) \
335 vlib_log(VLIB_LOG_LEVEL_WARNING, acl_main.log_default, __VA_ARGS__)
336 #define acl_log_notice(...) \
337 vlib_log(VLIB_LOG_LEVEL_NOTICE, acl_main.log_default, __VA_ARGS__)
338 #define acl_log_info(...) \
339 vlib_log(VLIB_LOG_LEVEL_INFO, acl_main.log_default, __VA_ARGS__)
343 #define foreach_acl_eh \
344 _(HOPBYHOP , 0 , "IPv6ExtHdrHopByHop") \
345 _(ROUTING , 43 , "IPv6ExtHdrRouting") \
346 _(DESTOPT , 60 , "IPv6ExtHdrDestOpt") \
347 _(FRAGMENT , 44 , "IPv6ExtHdrFragment") \
348 _(MOBILITY , 135, "Mobility Header") \
349 _(HIP , 139, "Experimental use Host Identity Protocol") \
350 _(SHIM6 , 140, "Shim6 Protocol") \
351 _(EXP1 , 253, "Use for experimentation and testing") \
352 _(EXP2 , 254, "Use for experimentation and testing")
356 "No Next Header" is not a header.
357 Also, Fragment header needs special processing.
359 _(NONEXT , 59 , "NoNextHdr") \
362 ESP is hiding its internal format, so no point in trying to go past it.
364 _(ESP , 50 , "EncapsulatingSecurityPayload") \
367 AH has a special treatment of its length, it is in 32-bit words, not 64-bit words like the rest.
369 _(AUTH , 51 , "Authentication Header") \
376 #define _(N, v, s) ACL_EH_##N = v,
383 extern acl_main_t acl_main;
385 void *acl_plugin_set_heap();