FD.io VPP  v17.07.01-10-g3be13f0
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 "bihash_40_8.h"
29 #include "fa_node.h"
30 #include "hash_lookup_types.h"
31 
32 #define ACL_PLUGIN_VERSION_MAJOR 1
33 #define ACL_PLUGIN_VERSION_MINOR 3
34 
35 #define UDP_SESSION_IDLE_TIMEOUT_SEC 600
36 #define TCP_SESSION_IDLE_TIMEOUT_SEC (3600*24)
37 #define TCP_SESSION_TRANSIENT_TIMEOUT_SEC 120
38 
41 
42 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);
43 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);
44 
50 };
51 
52 
53 enum address_e { IP4, IP6 };
54 typedef struct
55 {
56  enum address_e type;
57  union {
60  } addr;
61 } address_t;
62 
63 /*
64  * ACL rules
65  */
66 typedef struct
67 {
70  ip46_address_t src;
72  ip46_address_t dst;
81 } acl_rule_t;
82 
83 typedef struct
84 {
87  u8 src_mac[6];
88  u8 src_mac_mask[6];
89  ip46_address_t src_ip_addr;
92 
93 /*
94  * ACL
95  */
96 typedef struct
97 {
98  u8 tag[64];
101 } acl_list_t;
102 
103 typedef struct
104 {
105  u8 tag[64];
108  /* References to the classifier tables that will enforce the rules */
113 
114 /*
115  * An element describing a particular configuration fo the mask,
116  * and how many times it has been used.
117  */
118 typedef struct
119 {
123 
124 typedef struct {
125  /* mheap to hold all the ACL module related allocations, other than hash */
126  void *acl_mheap;
127 
128  /* API message ID base */
130 
131  acl_list_t *acls; /* Pool of ACLs */
132  hash_acl_info_t *hash_acl_infos; /* corresponding hash matching housekeeping info */
133  clib_bihash_48_8_t acl_lookup_hash; /* ACL lookup hash table. */
134 
135  /* mheap to hold all the miscellaneous allocations related to hash-based lookups */
142 
143  macip_acl_list_t *macip_acls; /* Pool of MAC-IP ACLs */
144 
145  /* ACLs associated with interfaces */
148 
149  /* interfaces on which given ACLs are applied */
152 
153  /* Total count of interface+direction pairs enabled */
155 
156  /* Do we use hash-based ACL matching or linear */
158 
159  /* a pool of all mask types present in all ACEs */
161 
162  /*
163  * Classify tables used to grab the packets for the ACL check,
164  * and serving as the 5-tuple session tables at the same time
165  */
170 
171  /* MACIP (input) ACLs associated with the interfaces */
173 
174  /* bitmaps when set the processing is enabled on the interface */
177  /* bihash holding all of the sessions */
179  clib_bihash_40_8_t fa_sessions_hash;
180  /* The process node which orcherstrates the cleanup */
182  /* FA session timeouts, in seconds */
183  u32 session_timeout_sec[ACL_N_TIMEOUTS];
184  /* total session adds/dels */
187 
188  /* L2 datapath glue */
189 
190  /* next indices within L2 classifiers for ip4/ip6 fa L2 nodes */
195  /* next node indices for L2 dispatch */
196  u32 fa_acl_in_ip4_l2_node_feat_next_node_index[32];
197  u32 fa_acl_in_ip6_l2_node_feat_next_node_index[32];
198  u32 fa_acl_out_ip4_l2_node_feat_next_node_index[32];
199  u32 fa_acl_out_ip6_l2_node_feat_next_node_index[32];
200 
201  /* EH values that we can skip over */
203 
204  /* whether to match L4 ACEs with ports on the non-initial fragment */
206 
207  /* conn table per-interface conn table parameters */
211 
212  /*
213  * If the cleaner has to delete more than this number
214  * of connections, it halves the sleep time.
215  */
216 
217 #define ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL 100
219 
220  /*
221  * If the cleaner deletes less than these connections,
222  * it increases the wait time by the "increment"
223  */
224 
225 #define ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL 1
227 
228 #define ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT 0.1
230 
232 
234 
235  /* per-worker data related t conn management */
237 
238  /* Configured session timeout */
239  u64 session_timeout[ACL_N_TIMEOUTS];
240 
241 
242  /* Counters for the cleaner thread */
243 
244 #define foreach_fa_cleaner_counter \
245  _(fa_cleaner_cnt_delete_by_sw_index, "delete_by_sw_index events") \
246  _(fa_cleaner_cnt_delete_by_sw_index_ok, "delete_by_sw_index handled ok") \
247  _(fa_cleaner_cnt_unknown_event, "unknown events received") \
248  _(fa_cleaner_cnt_timer_restarted, "session idle timers restarted") \
249  _(fa_cleaner_cnt_wait_with_timeout, "event wait with timeout called") \
250  _(fa_cleaner_cnt_wait_without_timeout, "event wait w/o timeout called") \
251  _(fa_cleaner_cnt_event_cycles, "total event cycles") \
252 /* end of counters */
253 #define _(id, desc) u32 id;
255 #undef _
256 
257  /* convenience */
260 } acl_main_t;
261 
262 #define foreach_acl_eh \
263  _(HOPBYHOP , 0 , "IPv6ExtHdrHopByHop") \
264  _(ROUTING , 43 , "IPv6ExtHdrRouting") \
265  _(DESTOPT , 60 , "IPv6ExtHdrDestOpt") \
266  _(FRAGMENT , 44 , "IPv6ExtHdrFragment") \
267  _(MOBILITY , 135, "Mobility Header") \
268  _(HIP , 139, "Experimental use Host Identity Protocol") \
269  _(SHIM6 , 140, "Shim6 Protocol") \
270  _(EXP1 , 253, "Use for experimentation and testing") \
271  _(EXP2 , 254, "Use for experimentation and testing")
272 
273 /*
274 
275  "No Next Header" is not a header.
276  Also, Fragment header needs special processing.
277 
278  _(NONEXT , 59 , "NoNextHdr") \
279 
280 
281 ESP is hiding its internal format, so no point in trying to go past it.
282 
283  _(ESP , 50 , "EncapsulatingSecurityPayload") \
284 
285 
286 AH has a special treatment of its length, it is in 32-bit words, not 64-bit words like the rest.
287 
288  _(AUTH , 51 , "Authentication Header") \
289 
290 
291 */
292 
293 
294  typedef enum {
295  #define _(N, v, s) ACL_EH_##N = v,
297  #undef _
298  } acl_eh_t;
299 
300 
301 
302 extern acl_main_t acl_main;
303 
304 
305 #endif
acl_rule_t * rules
Definition: acl.h:100
macip_acl_rule_t * rules
Definition: acl.h:107
u32 * acl_ip4_output_classify_table_by_sw_if_index
Definition: acl.h:168
u32 fa_cleaner_node_index
Definition: acl.h:181
uword * fa_out_acl_on_sw_if_index
Definition: acl.h:176
u8 is_ipv6
Definition: acl.h:69
fa_5tuple_t mask
Definition: acl.h:120
Definition: acl.h:118
u64 fa_current_cleaner_timer_wait_interval
Definition: acl.h:231
Definition: acl.h:54
u32 ** input_acl_vec_by_sw_if_index
Definition: acl.h:146
u16 msg_id_base
Definition: acl.h:129
uword * fa_in_acl_on_sw_if_index
Definition: acl.h:175
int l4_match_nonfirst_fragment
Definition: acl.h:205
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:73
u32 * acl_ip6_input_classify_table_by_sw_if_index
Definition: acl.h:167
u32 count
Definition: acl.h:99
u32 l2_table_index
Definition: acl.h:111
ip6_address_t ip6
Definition: acl.h:58
struct _vlib_node_registration vlib_node_registration_t
Definition: acl.h:53
u32 l2_input_classify_next_acl_ip4
Definition: acl.h:191
applied_hash_acl_info_t * output_applied_hash_acl_info_by_sw_if_index
Definition: acl.h:141
vlib_node_registration_t acl_out_node
f64 fa_cleaner_wait_time_increment
Definition: acl.h:229
uword fa_conn_table_hash_memory_size
Definition: acl.h:209
u16 dst_port_or_code_last
Definition: acl.h:78
u32 l2_output_classify_next_acl_ip4
Definition: acl.h:193
u8 src_prefixlen
Definition: acl.h:71
ip46_address_t src_ip_addr
Definition: acl.h:89
Definition: acl.h:53
address_e
Definition: acl.h:53
acl_eh_t
Definition: acl.h:294
u64 fa_conn_table_max_entries
Definition: acl.h:210
vnet_main_t * vnet_main
Definition: acl.h:259
ip46_address_t src
Definition: acl.h:70
u8 src_prefixlen
Definition: acl.h:90
u8 is_permit
Definition: acl.h:68
unsigned long u64
Definition: types.h:89
u32 ip4_table_index
Definition: acl.h:109
clib_bihash_40_8_t fa_sessions_hash
Definition: acl.h:179
ip4_address_t ip4
Definition: acl.h:59
u32 * acl_ip4_input_classify_table_by_sw_if_index
Definition: acl.h:166
ip46_address_t dst
Definition: acl.h:72
applied_hash_acl_info_t * input_applied_hash_acl_info_by_sw_if_index
Definition: acl.h:140
u16 dst_port_or_code_first
Definition: acl.h:77
uword * fa_ipv6_known_eh_bitmap
Definition: acl.h:202
hash_acl_info_t * hash_acl_infos
Definition: acl.h:132
clib_bihash_48_8_t acl_lookup_hash
Definition: acl.h:133
#define foreach_acl_eh
Definition: acl.h:262
u32 l2_input_classify_next_acl_ip6
Definition: acl.h:192
vlib_node_registration_t acl_in_node
u32 fa_total_enabled_count
Definition: acl.h:154
u8 proto
Definition: acl.h:74
u16 src_port_or_type_first
Definition: acl.h:75
u64 fa_min_deleted_sessions_per_interval
Definition: acl.h:226
The fine-grained event logger allows lightweight, thread-safe event logging at minimum cost...
u32 refcount
Definition: acl.h:121
applied_hash_ace_entry_t ** output_hash_entry_vec_by_sw_if_index
Definition: acl.h:139
u64 fa_session_total_adds
Definition: acl.h:185
int acl_lookup_hash_initialized
Definition: acl.h:137
Definition: acl.h:66
int use_hash_acl_matching
Definition: acl.h:157
#define foreach_fa_cleaner_counter
Definition: acl.h:244
u8 is_ipv6
Definition: acl.h:86
unsigned int u32
Definition: types.h:88
u16 src_port_or_type_last
Definition: acl.h:76
Bitmaps built as vectors of machine words.
u64 uword
Definition: types.h:112
ace_mask_type_entry_t * ace_mask_type_pool
Definition: acl.h:160
u32 * macip_acl_by_sw_if_index
Definition: acl.h:172
u32 * acl_ip6_output_classify_table_by_sw_if_index
Definition: acl.h:169
unsigned short u16
Definition: types.h:57
macip_acl_list_t * macip_acls
Definition: acl.h:143
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
u32 ip6_table_index
Definition: acl.h:110
u8 tcp_flags_mask
Definition: acl.h:80
acl_fa_per_worker_data_t * per_worker_data
Definition: acl.h:236
int fa_interrupt_generation
Definition: acl.h:233
u32 ** input_sw_if_index_vec_by_acl
Definition: acl.h:150
u64 fa_max_deleted_sessions_per_interval
Definition: acl.h:218
void * acl_mheap
Definition: acl.h:126
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:79
void * hash_lookup_mheap
Definition: acl.h:136
vhost_vring_addr_t addr
Definition: vhost-user.h:82
Definition: acl.h:96
u32 ** output_sw_if_index_vec_by_acl
Definition: acl.h:151
acl_timeout_e
Definition: acl.h:45
u32 l2_output_classify_next_acl_ip6
Definition: acl.h:194
int fa_sessions_hash_is_initialized
Definition: acl.h:178
acl_list_t * acls
Definition: acl.h:131
acl_main_t acl_main
Definition: jvpp_acl.h:39
u32 ** output_acl_vec_by_sw_if_index
Definition: acl.h:147
u8 is_permit
Definition: acl.h:85
u32 fa_conn_table_hash_num_buckets
Definition: acl.h:208
u64 fa_session_total_dels
Definition: acl.h:186
applied_hash_ace_entry_t ** input_hash_entry_vec_by_sw_if_index
Definition: acl.h:138
foreach_fa_cleaner_counter vlib_main_t * vlib_main
Definition: acl.h:258