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