FD.io VPP  v18.04-17-g3a0d853
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 
30 #include "fa_node.h"
31 #include "hash_lookup_types.h"
32 #include "lookup_context.h"
33 
34 #define ACL_PLUGIN_VERSION_MAJOR 1
35 #define ACL_PLUGIN_VERSION_MINOR 3
36 
37 #define UDP_SESSION_IDLE_TIMEOUT_SEC 600
38 #define TCP_SESSION_IDLE_TIMEOUT_SEC (3600*24)
39 #define TCP_SESSION_TRANSIENT_TIMEOUT_SEC 120
40 
41 #define ACL_PLUGIN_HASH_LOOKUP_HEAP_SIZE (2 << 25)
42 #define ACL_PLUGIN_HASH_LOOKUP_HASH_BUCKETS 65536
43 #define ACL_PLUGIN_HASH_LOOKUP_HASH_MEMORY (2 << 25)
44 
47 
48 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);
49 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);
50 
56 };
57 
58 
59 enum address_e { IP4, IP6 };
60 typedef struct
61 {
62  enum address_e type;
63  union {
66  } addr;
67 } address_t;
68 
69 /*
70  * ACL rules
71  */
72 typedef struct
73 {
76  ip46_address_t src;
78  ip46_address_t dst;
87 } acl_rule_t;
88 
89 typedef struct
90 {
93  u8 src_mac[6];
94  u8 src_mac_mask[6];
95  ip46_address_t src_ip_addr;
98 
99 /*
100  * ACL
101  */
102 typedef struct
103 {
104  /** Required for pool_get_aligned */
105  CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
106  u8 tag[64];
109 } acl_list_t;
110 
111 typedef struct
112 {
113  /** Required for pool_get_aligned */
114  CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
115  u8 tag[64];
118  /* References to the classifier tables that will enforce the rules */
122  /* outacl classifier tables */
127 
128 /*
129  * An element describing a particular configuration fo the mask,
130  * and how many times it has been used.
131  */
132 typedef struct
133 {
134  /** Required for pool_get_aligned */
135  CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
139 
140 typedef struct {
141  /* mheap to hold all the ACL module related allocations, other than hash */
142  void *acl_mheap;
144 
145  /* API message ID base */
147 
148  /* The pool of users of ACL lookup contexts */
150  /* The pool of ACL lookup contexts */
152 
153  acl_list_t *acls; /* Pool of ACLs */
154  hash_acl_info_t *hash_acl_infos; /* corresponding hash matching housekeeping info */
155  clib_bihash_48_8_t acl_lookup_hash; /* ACL lookup hash table. */
158 
159  /* mheap to hold all the miscellaneous allocations related to hash-based lookups */
163 /*
164  applied_hash_ace_entry_t **input_hash_entry_vec_by_sw_if_index;
165  applied_hash_ace_entry_t **output_hash_entry_vec_by_sw_if_index;
166  applied_hash_acl_info_t *input_applied_hash_acl_info_by_sw_if_index;
167  applied_hash_acl_info_t *output_applied_hash_acl_info_by_sw_if_index;
168 */
171 
172  /* Corresponding lookup context indices for in/out lookups per sw_if_index */
175  /* context user id for interface ACLs */
177 
178  macip_acl_list_t *macip_acls; /* Pool of MAC-IP ACLs */
179 
180  /* ACLs associated with interfaces */
183 
184  /* interfaces on which given ACLs are applied */
187 
188  /* bitmaps 1=sw_if_index has in/out ACL processing enabled */
191 
192  /* lookup contexts where a given ACL is used */
194 
195  /* input and output policy epochs by interface */
198 
199  /* whether we need to take the epoch of the session into account */
201 
202 
203 
204  /* Total count of interface+direction pairs enabled */
206 
207  /* Do we use hash-based ACL matching or linear */
209 
210  /* a pool of all mask types present in all ACEs */
212 
213  /*
214  * Classify tables used to grab the packets for the ACL check,
215  * and serving as the 5-tuple session tables at the same time
216  */
221 
226 
229 
232 
233  /* MACIP (input) ACLs associated with the interfaces */
235 
236  /* Vector of interfaces on which given MACIP ACLs are applied */
238 
239  /* bitmaps when set the processing is enabled on the interface */
242  /* bihash holding all of the sessions */
244  clib_bihash_40_8_t fa_sessions_hash;
245  /* The process node which orcherstrates the cleanup */
247  /* FA session timeouts, in seconds */
248  u32 session_timeout_sec[ACL_N_TIMEOUTS];
249  /* total session adds/dels */
252 
253  /* L2 datapath glue */
254 
255  /* next indices within L2 classifiers for ip4/ip6 fa L2 nodes */
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];
265 
266  /* EH values that we can skip over */
268 
269  /* whether to match L4 ACEs with ports on the non-initial fragment */
271 
272  /* conn table per-interface conn table parameters */
276 
279 
280  /*
281  * If the cleaner has to delete more than this number
282  * of connections, it halves the sleep time.
283  */
284 
285 #define ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL 100
287 
288  /*
289  * If the cleaner deletes less than these connections,
290  * it increases the wait time by the "increment"
291  */
292 
293 #define ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL 1
295 
296 #define ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT 0.1
298 
300 
302 
303  /* per-worker data related t conn management */
305 
306  /* Configured session timeout */
307  u64 session_timeout[ACL_N_TIMEOUTS];
308 
309 
310  /* Counters for the cleaner thread */
311 
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;
323 #undef _
324 
325  /* convenience */
328 } acl_main_t;
329 
330 #define foreach_acl_eh \
331  _(HOPBYHOP , 0 , "IPv6ExtHdrHopByHop") \
332  _(ROUTING , 43 , "IPv6ExtHdrRouting") \
333  _(DESTOPT , 60 , "IPv6ExtHdrDestOpt") \
334  _(FRAGMENT , 44 , "IPv6ExtHdrFragment") \
335  _(MOBILITY , 135, "Mobility Header") \
336  _(HIP , 139, "Experimental use Host Identity Protocol") \
337  _(SHIM6 , 140, "Shim6 Protocol") \
338  _(EXP1 , 253, "Use for experimentation and testing") \
339  _(EXP2 , 254, "Use for experimentation and testing")
340 
341 /*
342 
343  "No Next Header" is not a header.
344  Also, Fragment header needs special processing.
345 
346  _(NONEXT , 59 , "NoNextHdr") \
347 
348 
349 ESP is hiding its internal format, so no point in trying to go past it.
350 
351  _(ESP , 50 , "EncapsulatingSecurityPayload") \
352 
353 
354 AH has a special treatment of its length, it is in 32-bit words, not 64-bit words like the rest.
355 
356  _(AUTH , 51 , "Authentication Header") \
357 
358 
359 */
360 
361 
362  typedef enum {
363  #define _(N, v, s) ACL_EH_##N = v,
365  #undef _
366  } acl_eh_t;
367 
368 
369 
370 extern acl_main_t acl_main;
371 /*
372  * pointer to the above.
373  * Needed for some gymnastics to be able to provide
374  * the inline functions from this plugin to other plugins.
375  * If the ACL_PLUGIN_EXTERNAL_EXPORTS is defined, then
376  * there is a static definition in public_exports.h - do not collide with that.
377  */
378 #ifndef ACL_PLUGIN_EXTERNAL_EXPORTS
379 extern acl_main_t *p_acl_main;
380 #endif
381 
382 void *acl_plugin_set_heap();
383 
384 
385 #endif
acl_rule_t * rules
Definition: acl.h:108
u32 * input_policy_epoch_by_sw_if_index
Definition: acl.h:196
acl_main_t * p_acl_main
Definition: acl.c:57
macip_acl_rule_t * rules
Definition: acl.h:117
u32 * acl_ip4_output_classify_table_by_sw_if_index
Definition: acl.h:219
u32 fa_cleaner_node_index
Definition: acl.h:246
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
u32 * acl_dot1ad_input_classify_table_by_sw_if_index
Definition: acl.h:223
uword * fa_out_acl_on_sw_if_index
Definition: acl.h:241
u8 is_ipv6
Definition: acl.h:75
fa_5tuple_t mask
Definition: acl.h:136
Definition: acl.h:132
u64 fa_current_cleaner_timer_wait_interval
Definition: acl.h:299
Definition: acl.h:60
u32 ** input_acl_vec_by_sw_if_index
Definition: acl.h:181
u16 msg_id_base
Definition: acl.h:146
u32 out_l2_table_index
Definition: acl.h:125
uword * fa_in_acl_on_sw_if_index
Definition: acl.h:240
int l4_match_nonfirst_fragment
Definition: acl.h:270
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)
u8 dst_prefixlen
Definition: acl.h:79
u32 * acl_ip6_input_classify_table_by_sw_if_index
Definition: acl.h:218
u32 count
Definition: acl.h:107
u32 l2_table_index
Definition: acl.h:121
ip6_address_t ip6
Definition: acl.h:64
u32 * acl_etype_output_classify_table_by_sw_if_index
Definition: acl.h:228
Definition: acl.h:59
u32 * output_policy_epoch_by_sw_if_index
Definition: acl.h:197
u32 l2_input_classify_next_acl_ip4
Definition: acl.h:256
vlib_node_registration_t acl_out_node
f64 fa_cleaner_wait_time_increment
Definition: acl.h:297
u32 interface_acl_user_id
Definition: acl.h:176
u32 ** lc_index_vec_by_acl
Definition: acl.h:193
uword fa_conn_table_hash_memory_size
Definition: acl.h:274
u16 dst_port_or_code_last
Definition: acl.h:84
u32 l2_output_classify_next_acl_ip4
Definition: acl.h:258
u8 src_prefixlen
Definition: acl.h:77
ip46_address_t src_ip_addr
Definition: acl.h:95
Definition: acl.h:59
address_e
Definition: acl.h:59
acl_eh_t
Definition: acl.h:362
u64 fa_conn_table_max_entries
Definition: acl.h:275
vnet_main_t * vnet_main
Definition: acl.h:327
ip46_address_t src
Definition: acl.h:76
u8 src_prefixlen
Definition: acl.h:96
u8 is_permit
Definition: acl.h:74
uword * in_acl_on_sw_if_index
Definition: acl.h:189
unsigned long u64
Definition: types.h:89
u32 ip4_table_index
Definition: acl.h:119
clib_bihash_40_8_t fa_sessions_hash
Definition: acl.h:244
ip4_address_t ip4
Definition: acl.h:65
u32 * acl_ip4_input_classify_table_by_sw_if_index
Definition: acl.h:217
ip46_address_t dst
Definition: acl.h:78
u16 dst_port_or_code_first
Definition: acl.h:83
uword * fa_ipv6_known_eh_bitmap
Definition: acl.h:267
hash_acl_info_t * hash_acl_infos
Definition: acl.h:154
u32 * output_lc_index_by_sw_if_index
Definition: acl.h:174
clib_bihash_48_8_t acl_lookup_hash
Definition: acl.h:155
#define foreach_acl_eh
Definition: acl.h:330
u32 l2_input_classify_next_acl_ip6
Definition: acl.h:257
vlib_node_registration_t acl_in_node
u32 fa_total_enabled_count
Definition: acl.h:205
u8 proto
Definition: acl.h:80
u16 src_port_or_type_first
Definition: acl.h:81
u64 fa_min_deleted_sessions_per_interval
Definition: acl.h:294
The fine-grained event logger allows lightweight, thread-safe event logging at minimum cost...
u32 refcount
Definition: acl.h:137
u64 fa_session_total_adds
Definition: acl.h:250
applied_hash_acl_info_t * applied_hash_acl_info_by_lc_index
Definition: acl.h:170
int acl_lookup_hash_initialized
Definition: acl.h:162
Definition: acl.h:72
void * acl_plugin_set_heap()
Definition: acl.c:161
int use_hash_acl_matching
Definition: acl.h:208
applied_hash_ace_entry_t ** hash_entry_vec_by_lc_index
Definition: acl.h:169
#define foreach_fa_cleaner_counter
Definition: acl.h:312
u8 is_ipv6
Definition: acl.h:92
int trace_acl
Definition: acl.h:278
u32 hash_lookup_hash_buckets
Definition: acl.h:156
unsigned int u32
Definition: types.h:88
int trace_sessions
Definition: acl.h:277
u32 out_ip6_table_index
Definition: acl.h:124
u16 src_port_or_type_last
Definition: acl.h:82
uword * out_acl_on_sw_if_index
Definition: acl.h:190
Bitmaps built as vectors of machine words.
u32 ** sw_if_index_vec_by_macip_acl
Definition: acl.h:237
u32 * acl_etype_input_classify_table_by_sw_if_index
Definition: acl.h:227
u64 uword
Definition: types.h:112
uword acl_mheap_size
Definition: acl.h:143
ace_mask_type_entry_t * ace_mask_type_pool
Definition: acl.h:211
struct _vlib_node_registration vlib_node_registration_t
u32 * macip_acl_by_sw_if_index
Definition: acl.h:234
u32 * acl_ip6_output_classify_table_by_sw_if_index
Definition: acl.h:220
acl_lookup_context_t * acl_lookup_contexts
Definition: acl.h:151
unsigned short u16
Definition: types.h:57
macip_acl_list_t * macip_acls
Definition: acl.h:178
uword hash_lookup_mheap_size
Definition: acl.h:161
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
u32 ip6_table_index
Definition: acl.h:120
u8 tcp_flags_mask
Definition: acl.h:86
acl_fa_per_worker_data_t * per_worker_data
Definition: acl.h:304
int fa_interrupt_generation
Definition: acl.h:301
u32 ** input_sw_if_index_vec_by_acl
Definition: acl.h:185
u16 ** output_etype_whitelist_by_sw_if_index
Definition: acl.h:231
u64 fa_max_deleted_sessions_per_interval
Definition: acl.h:286
void * acl_mheap
Definition: acl.h:142
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)
u8 tcp_flags_value
Definition: acl.h:85
u16 ** input_etype_whitelist_by_sw_if_index
Definition: acl.h:230
void * hash_lookup_mheap
Definition: acl.h:160
int reclassify_sessions
Definition: acl.h:200
u32 * input_lc_index_by_sw_if_index
Definition: acl.h:173
vhost_vring_addr_t addr
Definition: vhost-user.h:83
u32 out_ip4_table_index
Definition: acl.h:123
u32 ** output_sw_if_index_vec_by_acl
Definition: acl.h:186
u32 * acl_dot1q_output_classify_table_by_sw_if_index
Definition: acl.h:224
acl_timeout_e
Definition: acl.h:51
u32 l2_output_classify_next_acl_ip6
Definition: acl.h:259
int fa_sessions_hash_is_initialized
Definition: acl.h:243
acl_list_t * acls
Definition: acl.h:153
acl_main_t acl_main
Definition: jvpp_acl.h:39
acl_lookup_context_user_t * acl_users
Definition: acl.h:149
u32 ** output_acl_vec_by_sw_if_index
Definition: acl.h:182
u8 is_permit
Definition: acl.h:91
u32 hash_lookup_hash_memory
Definition: acl.h:157
u32 fa_conn_table_hash_num_buckets
Definition: acl.h:273
u32 * acl_dot1q_input_classify_table_by_sw_if_index
Definition: acl.h:222
u64 fa_session_total_dels
Definition: acl.h:251
foreach_fa_cleaner_counter vlib_main_t * vlib_main
Definition: acl.h:326
u32 * acl_dot1ad_output_classify_table_by_sw_if_index
Definition: acl.h:225