FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
acl.h
Go to the documentation of this file.
1 /*
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:
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 #ifndef included_acl_h
16 #define included_acl_h
17 
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/l2/l2_output.h>
21 
22 
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>
30 #include <vlib/counter.h>
31 
32 #include "types.h"
33 #include "fa_node.h"
34 #include "hash_lookup_types.h"
35 #include "lookup_context.h"
36 
37 #define ACL_PLUGIN_VERSION_MAJOR 1
38 #define ACL_PLUGIN_VERSION_MINOR 4
39 
40 #define UDP_SESSION_IDLE_TIMEOUT_SEC 600
41 #define TCP_SESSION_IDLE_TIMEOUT_SEC (3600*24)
42 #define TCP_SESSION_TRANSIENT_TIMEOUT_SEC 120
43 
44 #define SESSION_PURGATORY_TIMEOUT_USEC 10
45 
46 #define ACL_PLUGIN_HASH_LOOKUP_HEAP_SIZE (2 << 25)
47 #define ACL_PLUGIN_HASH_LOOKUP_HASH_BUCKETS 65536
48 #define ACL_PLUGIN_HASH_LOOKUP_HASH_MEMORY (2 << 25)
49 
52 
53 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);
54 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);
55 
62  ACL_TIMEOUT_PURGATORY = ACL_N_USER_TIMEOUTS, /* a special-case queue for deletion-in-progress sessions */
64 };
65 
66 typedef struct
67 {
70  u8 src_mac[6];
72  ip46_address_t src_ip_addr;
75 
76 /*
77  * ACL
78  */
79 typedef struct
80 {
81  /** Required for pool_get_aligned */
82  CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
83  u8 tag[64];
85 } acl_list_t;
86 
87 typedef struct
88 {
89  /** Required for pool_get_aligned */
90  CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
91  u8 tag[64];
94  /* References to the classifier tables that will enforce the rules */
98  /* outacl classifier tables */
103 
104 /*
105  * An element describing a particular configuration fo the mask,
106  * and how many times it has been used.
107  */
108 typedef struct
109 {
110  /** Required for pool_get_aligned */
111  CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
116 
117 typedef struct {
118  /* mheap to hold all the ACL module related allocations, other than hash */
119  void *acl_mheap;
121 
122  /* API message ID base */
124 
125  /* The pool of users of ACL lookup contexts */
127  /* The pool of ACL lookup contexts */
129 
130  acl_list_t *acls; /* Pool of ACLs */
131  hash_acl_info_t *hash_acl_infos; /* corresponding hash matching housekeeping info */
132  clib_bihash_48_8_t acl_lookup_hash; /* ACL lookup hash table. */
135 
136  /* mheap to hold all the miscellaneous allocations related to hash-based lookups */
140 /*
141  applied_hash_ace_entry_t **input_hash_entry_vec_by_sw_if_index;
142  applied_hash_ace_entry_t **output_hash_entry_vec_by_sw_if_index;
143  applied_hash_acl_info_t *input_applied_hash_acl_info_by_sw_if_index;
144  applied_hash_acl_info_t *output_applied_hash_acl_info_by_sw_if_index;
145 */
148 
149  /* Corresponding lookup context indices for in/out lookups per sw_if_index */
152  /* context user id for interface ACLs */
154 
155  macip_acl_list_t *macip_acls; /* Pool of MAC-IP ACLs */
156 
157  /* ACLs associated with interfaces */
160 
161  /* interfaces on which given ACLs are applied */
164 
165  /* bitmaps 1=sw_if_index has in/out ACL processing enabled */
168 
169  /* lookup contexts where a given ACL is used */
171 
172  /* input and output policy epochs by interface */
175 
176  /* whether we need to take the epoch of the session into account */
178 
179 
180 
181  /* Total count of interface+direction pairs enabled */
183 
184  /* Do we use hash-based ACL matching or linear */
186 
187  /* Do we use the TupleMerge for hash ACLs or not */
189 
190  /* Max collision vector length before splitting the tuple */
191 #define TM_SPLIT_THRESHOLD 39
193 
194  /* a pool of all mask types present in all ACEs */
196 
197  /* vec of vectors of all info of all mask types present in ACEs contained in each lc_index */
199 
200  /*
201  * Classify tables used to grab the packets for the ACL check,
202  * and serving as the 5-tuple session tables at the same time
203  */
208 
213 
216 
219 
220  /* MACIP (input) ACLs associated with the interfaces */
222 
223  /* Vector of interfaces on which given MACIP ACLs are applied */
225 
226  /* bitmaps when set the processing is enabled on the interface */
229  /* bihash holding all of the sessions */
231  clib_bihash_40_8_t fa_ip6_sessions_hash;
232  clib_bihash_16_8_t fa_ip4_sessions_hash;
233  /* The process node which orchestrates the cleanup */
235  /* FA session timeouts, in seconds */
236  u32 session_timeout_sec[ACL_N_TIMEOUTS];
237  /* total session adds/dels */
240  /* how many sessions went into purgatory */
242 
243  /* EH values that we can skip over */
245 
246  /* whether to match L4 ACEs with ports on the non-initial fragment */
248 
249  /* conn table per-interface conn table parameters */
253 
256 
257  /*
258  * If the cleaner has to delete more than this number
259  * of connections, it halves the sleep time.
260  */
261 
262 #define ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL 100
264 
265  /*
266  * If the cleaner deletes less than these connections,
267  * it increases the wait time by the "increment"
268  */
269 
270 #define ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL 1
272 
273 #define ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT 0.1
275 
277 
279 
280  /* per-worker data related t conn management */
282 
283  /* Configured session timeout */
284  u64 session_timeout[ACL_N_TIMEOUTS];
285 
286 
287  /* Counters for the cleaner thread */
288 
289 #define foreach_fa_cleaner_counter \
290  _(fa_cleaner_cnt_delete_by_sw_index, "delete_by_sw_index events") \
291  _(fa_cleaner_cnt_delete_by_sw_index_ok, "delete_by_sw_index handled ok") \
292  _(fa_cleaner_cnt_unknown_event, "unknown events received") \
293  _(fa_cleaner_cnt_timer_restarted, "session idle timers restarted") \
294  _(fa_cleaner_cnt_wait_with_timeout, "event wait with timeout called") \
295  _(fa_cleaner_cnt_wait_without_timeout, "event wait w/o timeout called") \
296  _(fa_cleaner_cnt_event_cycles, "total event cycles") \
297 /* end of counters */
298 #define _(id, desc) u32 id;
300 #undef _
301 
302  /* convenience */
305  /* logging */
307  /* acl counters exposed via stats segment */
310  /* enable/disable ACL counters for interface processing */
312 } acl_main_t;
313 
314 #define acl_log_err(...) \
315  vlib_log(VLIB_LOG_LEVEL_ERR, acl_main.log_default, __VA_ARGS__)
316 #define acl_log_warn(...) \
317  vlib_log(VLIB_LOG_LEVEL_WARNING, acl_main.log_default, __VA_ARGS__)
318 #define acl_log_notice(...) \
319  vlib_log(VLIB_LOG_LEVEL_NOTICE, acl_main.log_default, __VA_ARGS__)
320 #define acl_log_info(...) \
321  vlib_log(VLIB_LOG_LEVEL_INFO, acl_main.log_default, __VA_ARGS__)
322 
323 
324 static inline void
326 {
327  if (am->acl_counter_lock)
329  /* zzzz */ ;
330 }
331 
332 static inline void
334 {
335  if (am->acl_counter_lock)
337 }
338 
339 
340 #define foreach_acl_eh \
341  _(HOPBYHOP , 0 , "IPv6ExtHdrHopByHop") \
342  _(ROUTING , 43 , "IPv6ExtHdrRouting") \
343  _(DESTOPT , 60 , "IPv6ExtHdrDestOpt") \
344  _(FRAGMENT , 44 , "IPv6ExtHdrFragment") \
345  _(MOBILITY , 135, "Mobility Header") \
346  _(HIP , 139, "Experimental use Host Identity Protocol") \
347  _(SHIM6 , 140, "Shim6 Protocol") \
348  _(EXP1 , 253, "Use for experimentation and testing") \
349  _(EXP2 , 254, "Use for experimentation and testing")
350 
351 /*
352 
353  "No Next Header" is not a header.
354  Also, Fragment header needs special processing.
355 
356  _(NONEXT , 59 , "NoNextHdr") \
357 
358 
359 ESP is hiding its internal format, so no point in trying to go past it.
360 
361  _(ESP , 50 , "EncapsulatingSecurityPayload") \
362 
363 
364 AH has a special treatment of its length, it is in 32-bit words, not 64-bit words like the rest.
365 
366  _(AUTH , 51 , "Authentication Header") \
367 
368 
369 */
370 
371 
372  typedef enum {
373  #define _(N, v, s) ACL_EH_##N = v,
375  #undef _
376  } acl_eh_t;
377 
378 
379 
380 extern acl_main_t acl_main;
381 
382 void *acl_plugin_set_heap();
383 
384 typedef enum {
388 
389 void aclp_post_session_change_request(acl_main_t *am, u32 target_thread, u32 target_session, acl_fa_sess_req_t request_type);
391 
392 #endif
acl_rule_t * rules
Definition: acl.h:84
u32 * input_policy_epoch_by_sw_if_index
Definition: acl.h:173
macip_acl_rule_t * rules
Definition: acl.h:93
u32 * acl_ip4_output_classify_table_by_sw_if_index
Definition: acl.h:206
u32 fa_cleaner_node_index
Definition: acl.h:234
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
u32 * acl_dot1ad_input_classify_table_by_sw_if_index
Definition: acl.h:210
uword * fa_out_acl_on_sw_if_index
Definition: acl.h:228
fa_5tuple_t mask
Definition: acl.h:112
static void acl_plugin_counter_lock(acl_main_t *am)
Definition: acl.h:325
vlib_combined_counter_main_t * combined_acl_counters
Definition: acl.h:309
Definition: acl.h:108
u64 fa_current_cleaner_timer_wait_interval
Definition: acl.h:276
clib_bihash_40_8_t fa_ip6_sessions_hash
Definition: acl.h:231
u32 ** input_acl_vec_by_sw_if_index
Definition: acl.h:158
u16 msg_id_base
Definition: acl.h:123
u32 out_l2_table_index
Definition: acl.h:101
uword * fa_in_acl_on_sw_if_index
Definition: acl.h:227
void aclp_post_session_change_request(acl_main_t *am, u32 target_thread, u32 target_session, acl_fa_sess_req_t request_type)
unsigned long u64
Definition: types.h:89
int l4_match_nonfirst_fragment
Definition: acl.h:247
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)
u32 * acl_ip6_input_classify_table_by_sw_if_index
Definition: acl.h:205
u32 l2_table_index
Definition: acl.h:97
u32 * acl_etype_output_classify_table_by_sw_if_index
Definition: acl.h:215
u32 * output_policy_epoch_by_sw_if_index
Definition: acl.h:174
acl_fa_sess_req_t
Definition: acl.h:384
unsigned char u8
Definition: types.h:56
vlib_node_registration_t acl_out_node
vlib_log_class_t log_default
Definition: acl.h:306
double f64
Definition: types.h:142
f64 fa_cleaner_wait_time_increment
Definition: acl.h:274
u32 interface_acl_user_id
Definition: acl.h:153
u32 ** lc_index_vec_by_acl
Definition: acl.h:170
uword fa_conn_table_hash_memory_size
Definition: acl.h:251
u32 vlib_log_class_t
Definition: vlib.h:51
ip46_address_t src_ip_addr
Definition: acl.h:72
acl_eh_t
Definition: acl.h:372
volatile u32 * acl_counter_lock
Definition: acl.h:308
u64 fa_conn_table_max_entries
Definition: acl.h:252
vnet_main_t * vnet_main
Definition: acl.h:304
u8 src_prefixlen
Definition: acl.h:73
uword * in_acl_on_sw_if_index
Definition: acl.h:166
unsigned int u32
Definition: types.h:88
u32 ip4_table_index
Definition: acl.h:95
#define clib_atomic_test_and_set(a)
Definition: atomics.h:42
u32 * acl_ip4_input_classify_table_by_sw_if_index
Definition: acl.h:204
u8 from_tm
Definition: acl.h:114
#define clib_atomic_release(a)
Definition: atomics.h:43
hash_applied_mask_info_t ** hash_applied_mask_info_vec_by_lc_index
Definition: acl.h:198
unsigned short u16
Definition: types.h:57
uword * fa_ipv6_known_eh_bitmap
Definition: acl.h:244
hash_acl_info_t * hash_acl_infos
Definition: acl.h:131
u32 * output_lc_index_by_sw_if_index
Definition: acl.h:151
clib_bihash_48_8_t acl_lookup_hash
Definition: acl.h:132
#define foreach_acl_eh
Definition: acl.h:340
vlib_node_registration_t acl_in_node
u32 interface_acl_counters_enabled
Definition: acl.h:311
u32 fa_total_enabled_count
Definition: acl.h:182
u64 fa_min_deleted_sessions_per_interval
Definition: acl.h:271
The fine-grained event logger allows lightweight, thread-safe event logging at minimum cost...
u32 refcount
Definition: acl.h:113
Optimized thread-safe counters.
u64 fa_session_total_adds
Definition: acl.h:238
applied_hash_acl_info_t * applied_hash_acl_info_by_lc_index
Definition: acl.h:147
int acl_lookup_hash_initialized
Definition: acl.h:139
static void acl_plugin_counter_unlock(acl_main_t *am)
Definition: acl.h:333
void * acl_plugin_set_heap()
Definition: acl.c:122
int use_hash_acl_matching
Definition: acl.h:185
applied_hash_ace_entry_t ** hash_entry_vec_by_lc_index
Definition: acl.h:146
uword hash_lookup_hash_memory
Definition: acl.h:134
#define foreach_fa_cleaner_counter
Definition: acl.h:289
int tuple_merge_split_threshold
Definition: acl.h:192
vl_api_mac_address_t src_mac
Definition: acl_types.api:93
u8 is_ipv6
Definition: acl.h:69
int trace_acl
Definition: acl.h:255
u32 hash_lookup_hash_buckets
Definition: acl.h:133
int trace_sessions
Definition: acl.h:254
u32 out_ip6_table_index
Definition: acl.h:100
uword * out_acl_on_sw_if_index
Definition: acl.h:167
Bitmaps built as vectors of machine words.
u32 ** sw_if_index_vec_by_macip_acl
Definition: acl.h:224
u32 * acl_etype_input_classify_table_by_sw_if_index
Definition: acl.h:214
u32 count
Definition: acl.h:92
uword acl_mheap_size
Definition: acl.h:120
ace_mask_type_entry_t * ace_mask_type_pool
Definition: acl.h:195
struct _vlib_node_registration vlib_node_registration_t
u32 * macip_acl_by_sw_if_index
Definition: acl.h:221
u32 * acl_ip6_output_classify_table_by_sw_if_index
Definition: acl.h:207
acl_lookup_context_t * acl_lookup_contexts
Definition: acl.h:128
macip_acl_list_t * macip_acls
Definition: acl.h:155
void aclp_swap_wip_and_pending_session_change_requests(acl_main_t *am, u32 target_thread)
uword hash_lookup_mheap_size
Definition: acl.h:138
u32 ip6_table_index
Definition: acl.h:96
VLIB buffer representation.
Definition: buffer.h:102
vl_api_mac_address_t src_mac_mask
Definition: acl_types.api:94
acl_fa_per_worker_data_t * per_worker_data
Definition: acl.h:281
u64 uword
Definition: types.h:112
int fa_interrupt_generation
Definition: acl.h:278
u32 ** input_sw_if_index_vec_by_acl
Definition: acl.h:162
int use_tuple_merge
Definition: acl.h:188
u16 ** output_etype_whitelist_by_sw_if_index
Definition: acl.h:218
u64 fa_max_deleted_sessions_per_interval
Definition: acl.h:263
void * acl_mheap
Definition: acl.h:119
A collection of combined counters.
Definition: counter.h:188
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)
u16 ** input_etype_whitelist_by_sw_if_index
Definition: acl.h:217
void * hash_lookup_mheap
Definition: acl.h:137
u64 fa_session_total_deactivations
Definition: acl.h:241
int reclassify_sessions
Definition: acl.h:177
u32 * input_lc_index_by_sw_if_index
Definition: acl.h:150
Definition: acl.h:79
u32 out_ip4_table_index
Definition: acl.h:99
u32 ** output_sw_if_index_vec_by_acl
Definition: acl.h:163
u32 * acl_dot1q_output_classify_table_by_sw_if_index
Definition: acl.h:211
acl_timeout_e
Definition: acl.h:56
clib_bihash_16_8_t fa_ip4_sessions_hash
Definition: acl.h:232
int fa_sessions_hash_is_initialized
Definition: acl.h:230
acl_list_t * acls
Definition: acl.h:130
acl_main_t acl_main
Definition: acl.c:42
acl_lookup_context_user_t * acl_users
Definition: acl.h:126
u32 ** output_acl_vec_by_sw_if_index
Definition: acl.h:159
u8 is_permit
Definition: acl.h:68
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:33
u32 fa_conn_table_hash_num_buckets
Definition: acl.h:250
u32 * acl_dot1q_input_classify_table_by_sw_if_index
Definition: acl.h:209
u64 fa_session_total_dels
Definition: acl.h:239
foreach_fa_cleaner_counter vlib_main_t * vlib_main
Definition: acl.h:303
u32 * acl_dot1ad_output_classify_table_by_sw_if_index
Definition: acl.h:212