2 * Copyright (c) 2016-2018 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.
16 #include <netinet/in.h>
18 #include <vlib/vlib.h>
19 #include <vnet/vnet.h>
20 #include <vnet/pg/pg.h>
21 #include <vppinfra/error.h>
25 #include <vnet/ip/icmp46_packet.h>
27 #include <plugins/acl/fa_node.h>
28 #include <plugins/acl/acl.h>
29 #include <plugins/acl/lookup_context.h>
30 #include <plugins/acl/public_inlines.h>
31 #include <plugins/acl/session_inlines.h>
33 #include <vppinfra/bihash_40_8.h>
34 #include <vppinfra/bihash_template.h>
41 u32 match_acl_in_index;
49 #define foreach_acl_fa_error \
50 _(ACL_DROP, "ACL deny packets") \
51 _(ACL_PERMIT, "ACL permit packets") \
52 _(ACL_NEW_SESSION, "new sessions added") \
53 _(ACL_EXIST_SESSION, "existing session packets") \
54 _(ACL_CHECK, "checked packets") \
55 _(ACL_RESTART_SESSION_TIMER, "restart session timer") \
56 _(ACL_TOO_MANY_SESSIONS, "too many sessions to add new") \
61 #define _(sym,str) ACL_FA_ERROR_##sym,
71 acl_fa_node_fn (vlib_main_t * vm,
72 vlib_node_runtime_t * node, vlib_frame_t * frame, int is_ip6,
73 int is_input, int is_l2_path, u32 * l2_feat_next_node_index,
74 vlib_node_registration_t * acl_fa_node)
77 u32 pkts_acl_checked = 0;
78 u32 pkts_new_session = 0;
79 u32 pkts_exist_session = 0;
80 u32 pkts_acl_permit = 0;
81 u32 pkts_restart_session_timer = 0;
83 acl_main_t *am = &acl_main;
84 fa_5tuple_t fa_5tuple;
85 vlib_node_runtime_t *error_node;
86 u64 now = clib_cpu_time_now ();
87 uword thread_index = os_get_thread_index ();
88 acl_fa_per_worker_data_t *pw = &am->per_worker_data[thread_index];
90 u16 nexts[VLIB_FRAME_SIZE], *next;
91 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
93 from = vlib_frame_vector_args (frame);
95 error_node = vlib_node_get_runtime (vm, acl_fa_node->index);
97 vlib_get_buffers (vm, from, bufs, frame->n_vectors);
98 /* set the initial values for the current buffer the next pointers */
102 n_left = frame->n_vectors;
109 int acl_check_needed = 1;
110 u32 match_acl_in_index = ~0;
111 u32 match_acl_pos = ~0;
112 u32 match_rule_index = ~0;
118 sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
120 sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
123 lc_index0 = am->input_lc_index_by_sw_if_index[sw_if_index0];
125 lc_index0 = am->output_lc_index_by_sw_if_index[sw_if_index0];
129 is_input ? &am->input_policy_epoch_by_sw_if_index :
130 &am->output_policy_epoch_by_sw_if_index;
131 u16 current_policy_epoch =
132 sw_if_index0 < vec_len (*p_epoch_vec) ? vec_elt (*p_epoch_vec,
134 : (is_input * FA_POLICY_EPOCH_IS_INPUT);
136 * Extract the L3/L4 matching info into a 5-tuple structure.
139 acl_plugin_fill_5tuple_inline (&acl_main, lc_index0, b[0], is_ip6,
140 is_input, is_l2_path,
141 (fa_5tuple_opaque_t *) & fa_5tuple);
142 fa_5tuple.l4.lsb_of_sw_if_index = sw_if_index0 & 0xffff;
143 fa_5tuple.pkt.mask_type_index_lsb = ~0;
144 #ifdef FA_NODE_VERBOSE_DEBUG
146 ("ACL_FA_NODE_DBG: packet 5-tuple %016llx %016llx %016llx %016llx %016llx %016llx",
147 fa_5tuple.kv.key[0], fa_5tuple.kv.key[1], fa_5tuple.kv.key[2],
148 fa_5tuple.kv.key[3], fa_5tuple.kv.key[4], fa_5tuple.kv.value);
151 /* Try to match an existing session first */
153 if (acl_fa_ifc_has_sessions (am, sw_if_index0))
155 u64 value_sess = ~0ULL;
156 if (acl_fa_find_session
157 (am, is_ip6, sw_if_index0, &fa_5tuple, &value_sess)
158 && (value_sess != ~0ULL))
160 trace_bitmap |= 0x80000000;
161 error0 = ACL_FA_ERROR_ACL_EXIST_SESSION;
162 fa_full_session_id_t f_sess_id;
164 f_sess_id.as_u64 = value_sess;
165 ASSERT (f_sess_id.thread_index < vec_len (vlib_mains));
168 get_session_ptr (am, f_sess_id.thread_index,
169 f_sess_id.session_index);
170 int old_timeout_type = fa_session_get_timeout_type (am, sess);
172 acl_fa_track_session (am, is_input, sw_if_index0, now,
174 /* expose the session id to the tracer */
175 match_rule_index = f_sess_id.session_index;
176 int new_timeout_type = fa_session_get_timeout_type (am, sess);
177 acl_check_needed = 0;
178 pkts_exist_session += 1;
179 /* Tracking might have changed the session timeout type, e.g. from transient to established */
180 if (PREDICT_FALSE (old_timeout_type != new_timeout_type))
182 acl_fa_restart_timer_for_session (am, now, f_sess_id);
183 pkts_restart_session_timer++;
185 0x00010000 + ((0xff & old_timeout_type) << 8) +
186 (0xff & new_timeout_type);
189 * I estimate the likelihood to be very low - the VPP needs
190 * to have >64K interfaces to start with and then on
191 * exactly 64K indices apart needs to be exactly the same
192 * 5-tuple... Anyway, since this probability is nonzero -
193 * print an error and drop the unlucky packet.
194 * If this shows up in real world, we would need to bump
195 * the hash key length.
197 if (PREDICT_FALSE (sess->sw_if_index != sw_if_index0))
200 ("BUG: session LSB16(sw_if_index) and 5-tuple collision!");
201 acl_check_needed = 0;
204 if (PREDICT_FALSE (am->reclassify_sessions))
206 /* if the MSB of policy epoch matches but not the LSB means it is a stale session */
208 ((current_policy_epoch ^
209 f_sess_id.intf_policy_epoch) &
210 FA_POLICY_EPOCH_IS_INPUT))
211 && (current_policy_epoch !=
212 f_sess_id.intf_policy_epoch))
214 /* delete session and increment the counter */
216 (pw->fa_session_epoch_change_by_sw_if_index,
218 vec_elt (pw->fa_session_epoch_change_by_sw_if_index,
220 if (acl_fa_conn_list_delete_session
221 (am, f_sess_id, now))
223 /* delete the session only if we were able to unlink it */
224 acl_fa_two_stage_delete_session (am, sw_if_index0,
227 acl_check_needed = 1;
228 trace_bitmap |= 0x40000000;
234 if (acl_check_needed)
236 action = 0; /* deny by default */
237 acl_plugin_match_5tuple_inline (&acl_main, lc_index0,
238 (fa_5tuple_opaque_t *) &
239 fa_5tuple, is_ip6, &action,
242 &match_rule_index, &trace_bitmap);
245 pkts_acl_permit += 1;
248 if (!acl_fa_can_add_session (am, is_input, sw_if_index0))
249 acl_fa_try_recycle_session (am, is_input, thread_index,
252 if (acl_fa_can_add_session (am, is_input, sw_if_index0))
255 acl_fa_add_session (am, is_input, is_ip6,
258 current_policy_epoch);
259 acl_fa_track_session (am, is_input, sw_if_index0,
260 now, sess, &fa_5tuple);
261 pkts_new_session += 1;
266 error0 = ACL_FA_ERROR_ACL_TOO_MANY_SESSIONS;
276 next0 = vnet_l2_feature_next (b[0], l2_feat_next_node_index, 0);
278 vnet_feature_next (sw_if_index0, &next0, b[0]);
280 #ifdef FA_NODE_VERBOSE_DEBUG
282 ("ACL_FA_NODE_DBG: sw_if_index %d lc_index %d action %d acl_index %d rule_index %d",
283 sw_if_index0, lc_index0, action, match_acl_in_index,
287 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
288 && (b[0]->flags & VLIB_BUFFER_IS_TRACED)))
290 acl_fa_trace_t *t = vlib_add_trace (vm, node, b[0], sizeof (*t));
291 t->sw_if_index = sw_if_index0;
292 t->lc_index = lc_index0;
293 t->next_index = next0;
294 t->match_acl_in_index = match_acl_in_index;
295 t->match_rule_index = match_rule_index;
296 t->packet_info[0] = fa_5tuple.kv_40_8.key[0];
297 t->packet_info[1] = fa_5tuple.kv_40_8.key[1];
298 t->packet_info[2] = fa_5tuple.kv_40_8.key[2];
299 t->packet_info[3] = fa_5tuple.kv_40_8.key[3];
300 t->packet_info[4] = fa_5tuple.kv_40_8.key[4];
301 t->packet_info[5] = fa_5tuple.kv_40_8.value;
303 t->trace_bitmap = trace_bitmap;
306 next0 = next0 < node->n_next_nodes ? next0 : 0;
308 b[0]->error = error_node->errors[error0];
313 pkts_acl_checked += 1;
316 vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
318 vlib_node_increment_counter (vm, acl_fa_node->index,
319 ACL_FA_ERROR_ACL_CHECK, pkts_acl_checked);
320 vlib_node_increment_counter (vm, acl_fa_node->index,
321 ACL_FA_ERROR_ACL_PERMIT, pkts_acl_permit);
322 vlib_node_increment_counter (vm, acl_fa_node->index,
323 ACL_FA_ERROR_ACL_NEW_SESSION,
325 vlib_node_increment_counter (vm, acl_fa_node->index,
326 ACL_FA_ERROR_ACL_EXIST_SESSION,
328 vlib_node_increment_counter (vm, acl_fa_node->index,
329 ACL_FA_ERROR_ACL_RESTART_SESSION_TIMER,
330 pkts_restart_session_timer);
331 return frame->n_vectors;
334 vlib_node_registration_t acl_in_l2_ip6_node;
335 VLIB_NODE_FN (acl_in_l2_ip6_node) (vlib_main_t * vm,
336 vlib_node_runtime_t * node,
337 vlib_frame_t * frame)
339 acl_main_t *am = &acl_main;
340 return acl_fa_node_fn (vm, node, frame, 1, 1, 1,
341 am->fa_acl_in_ip6_l2_node_feat_next_node_index,
342 &acl_in_l2_ip6_node);
345 vlib_node_registration_t acl_in_l2_ip4_node;
346 VLIB_NODE_FN (acl_in_l2_ip4_node) (vlib_main_t * vm,
347 vlib_node_runtime_t * node,
348 vlib_frame_t * frame)
350 acl_main_t *am = &acl_main;
351 return acl_fa_node_fn (vm, node, frame, 0, 1, 1,
352 am->fa_acl_in_ip4_l2_node_feat_next_node_index,
353 &acl_in_l2_ip4_node);
356 vlib_node_registration_t acl_out_l2_ip6_node;
357 VLIB_NODE_FN (acl_out_l2_ip6_node) (vlib_main_t * vm,
358 vlib_node_runtime_t * node,
359 vlib_frame_t * frame)
361 acl_main_t *am = &acl_main;
362 return acl_fa_node_fn (vm, node, frame, 1, 0, 1,
363 am->fa_acl_out_ip6_l2_node_feat_next_node_index,
364 &acl_out_l2_ip6_node);
367 vlib_node_registration_t acl_out_l2_ip4_node;
368 VLIB_NODE_FN (acl_out_l2_ip4_node) (vlib_main_t * vm,
369 vlib_node_runtime_t * node,
370 vlib_frame_t * frame)
372 acl_main_t *am = &acl_main;
373 return acl_fa_node_fn (vm, node, frame, 0, 0, 1,
374 am->fa_acl_out_ip4_l2_node_feat_next_node_index,
375 &acl_out_l2_ip4_node);
378 /**** L3 processing path nodes ****/
380 vlib_node_registration_t acl_in_fa_ip6_node;
381 VLIB_NODE_FN (acl_in_fa_ip6_node) (vlib_main_t * vm,
382 vlib_node_runtime_t * node,
383 vlib_frame_t * frame)
385 return acl_fa_node_fn (vm, node, frame, 1, 1, 0, 0, &acl_in_fa_ip6_node);
388 vlib_node_registration_t acl_in_fa_ip4_node;
389 VLIB_NODE_FN (acl_in_fa_ip4_node) (vlib_main_t * vm,
390 vlib_node_runtime_t * node,
391 vlib_frame_t * frame)
393 return acl_fa_node_fn (vm, node, frame, 0, 1, 0, 0, &acl_in_fa_ip4_node);
396 vlib_node_registration_t acl_out_fa_ip6_node;
397 VLIB_NODE_FN (acl_out_fa_ip6_node) (vlib_main_t * vm,
398 vlib_node_runtime_t * node,
399 vlib_frame_t * frame)
401 return acl_fa_node_fn (vm, node, frame, 1, 0, 0, 0, &acl_out_fa_ip6_node);
404 vlib_node_registration_t acl_out_fa_ip4_node;
405 VLIB_NODE_FN (acl_out_fa_ip4_node) (vlib_main_t * vm,
406 vlib_node_runtime_t * node,
407 vlib_frame_t * frame)
409 return acl_fa_node_fn (vm, node, frame, 0, 0, 0, 0, &acl_out_fa_ip4_node);
412 #ifndef CLIB_MARCH_VARIANT
414 format_fa_5tuple (u8 * s, va_list * args)
416 fa_5tuple_t *p5t = va_arg (*args, fa_5tuple_t *);
419 return format (s, "lc_index %d (lsb16 of sw_if_index %d) l3 %s%s %U -> %U"
420 " l4 proto %d l4_valid %d port %d -> %d tcp flags (%s) %02x rsvd %x",
421 p5t->pkt.lc_index, p5t->l4.lsb_of_sw_if_index,
424 pkt.is_nonfirst_fragment ? " non-initial fragment" : "",
425 format_ip6_address, &p5t->ip6_addr[0], format_ip6_address,
426 &p5t->ip6_addr[1], p5t->l4.proto, p5t->pkt.l4_valid,
427 p5t->l4.port[0], p5t->l4.port[1],
428 p5t->pkt.tcp_flags_valid ? "valid" : "invalid",
429 p5t->pkt.tcp_flags, p5t->pkt.flags_reserved);
431 return format (s, "lc_index %d (lsb16 of sw_if_index %d) l3 %s%s %U -> %U"
432 " l4 proto %d l4_valid %d port %d -> %d tcp flags (%s) %02x rsvd %x",
433 p5t->pkt.lc_index, p5t->l4.lsb_of_sw_if_index,
436 pkt.is_nonfirst_fragment ? " non-initial fragment" : "",
437 format_ip4_address, &p5t->ip4_addr[0], format_ip4_address,
438 &p5t->ip4_addr[1], p5t->l4.proto, p5t->pkt.l4_valid,
439 p5t->l4.port[0], p5t->l4.port[1],
440 p5t->pkt.tcp_flags_valid ? "valid" : "invalid",
441 p5t->pkt.tcp_flags, p5t->pkt.flags_reserved);
445 format_acl_plugin_5tuple (u8 * s, va_list * args)
447 return format_fa_5tuple (s, args);
450 /* packet trace format function */
452 format_acl_plugin_trace (u8 * s, va_list * args)
454 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
455 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
456 acl_fa_trace_t *t = va_arg (*args, acl_fa_trace_t *);
460 "acl-plugin: lc_index: %d, sw_if_index %d, next index %d, action: %d, match: acl %d rule %d trace_bits %08x\n"
461 " pkt info %016llx %016llx %016llx %016llx %016llx %016llx",
462 t->lc_index, t->sw_if_index, t->next_index, t->action,
463 t->match_acl_in_index, t->match_rule_index, t->trace_bitmap,
464 t->packet_info[0], t->packet_info[1], t->packet_info[2],
465 t->packet_info[3], t->packet_info[4], t->packet_info[5]);
467 /* Now also print out the packet_info in a form usable by humans */
468 s = format (s, "\n %U", format_fa_5tuple, t->packet_info);
475 static char *acl_fa_error_strings[] = {
476 #define _(sym,string) string,
481 VLIB_REGISTER_NODE (acl_in_l2_ip6_node) =
483 .name = "acl-plugin-in-ip6-l2",
484 .vector_size = sizeof (u32),
485 .format_trace = format_acl_plugin_trace,
486 .type = VLIB_NODE_TYPE_INTERNAL,
487 .n_errors = ARRAY_LEN (acl_fa_error_strings),
488 .error_strings = acl_fa_error_strings,
489 .n_next_nodes = ACL_FA_N_NEXT,
492 [ACL_FA_ERROR_DROP] = "error-drop",
496 VLIB_REGISTER_NODE (acl_in_l2_ip4_node) =
498 .name = "acl-plugin-in-ip4-l2",
499 .vector_size = sizeof (u32),
500 .format_trace = format_acl_plugin_trace,
501 .type = VLIB_NODE_TYPE_INTERNAL,
502 .n_errors = ARRAY_LEN (acl_fa_error_strings),
503 .error_strings = acl_fa_error_strings,
504 .n_next_nodes = ACL_FA_N_NEXT,
507 [ACL_FA_ERROR_DROP] = "error-drop",
511 VLIB_REGISTER_NODE (acl_out_l2_ip6_node) =
513 .name = "acl-plugin-out-ip6-l2",
514 .vector_size = sizeof (u32),
515 .format_trace = format_acl_plugin_trace,
516 .type = VLIB_NODE_TYPE_INTERNAL,
517 .n_errors = ARRAY_LEN (acl_fa_error_strings),
518 .error_strings = acl_fa_error_strings,
519 .n_next_nodes = ACL_FA_N_NEXT,
522 [ACL_FA_ERROR_DROP] = "error-drop",
526 VLIB_REGISTER_NODE (acl_out_l2_ip4_node) =
528 .name = "acl-plugin-out-ip4-l2",
529 .vector_size = sizeof (u32),
530 .format_trace = format_acl_plugin_trace,
531 .type = VLIB_NODE_TYPE_INTERNAL,
532 .n_errors = ARRAY_LEN (acl_fa_error_strings),
533 .error_strings = acl_fa_error_strings,
534 .n_next_nodes = ACL_FA_N_NEXT,
537 [ACL_FA_ERROR_DROP] = "error-drop",
542 VLIB_REGISTER_NODE (acl_in_fa_ip6_node) =
544 .name = "acl-plugin-in-ip6-fa",
545 .vector_size = sizeof (u32),
546 .format_trace = format_acl_plugin_trace,
547 .type = VLIB_NODE_TYPE_INTERNAL,
548 .n_errors = ARRAY_LEN (acl_fa_error_strings),
549 .error_strings = acl_fa_error_strings,
550 .n_next_nodes = ACL_FA_N_NEXT,
553 [ACL_FA_ERROR_DROP] = "error-drop",
557 VNET_FEATURE_INIT (acl_in_ip6_fa_feature, static) =
559 .arc_name = "ip6-unicast",
560 .node_name = "acl-plugin-in-ip6-fa",
561 .runs_before = VNET_FEATURES ("ip6-flow-classify"),
564 VLIB_REGISTER_NODE (acl_in_fa_ip4_node) =
566 .name = "acl-plugin-in-ip4-fa",
567 .vector_size = sizeof (u32),
568 .format_trace = format_acl_plugin_trace,
569 .type = VLIB_NODE_TYPE_INTERNAL,
570 .n_errors = ARRAY_LEN (acl_fa_error_strings),
571 .error_strings = acl_fa_error_strings,
572 .n_next_nodes = ACL_FA_N_NEXT,
575 [ACL_FA_ERROR_DROP] = "error-drop",
579 VNET_FEATURE_INIT (acl_in_ip4_fa_feature, static) =
581 .arc_name = "ip4-unicast",
582 .node_name = "acl-plugin-in-ip4-fa",
583 .runs_before = VNET_FEATURES ("ip4-flow-classify"),
587 VLIB_REGISTER_NODE (acl_out_fa_ip6_node) =
589 .name = "acl-plugin-out-ip6-fa",
590 .vector_size = sizeof (u32),
591 .format_trace = format_acl_plugin_trace,
592 .type = VLIB_NODE_TYPE_INTERNAL,
593 .n_errors = ARRAY_LEN (acl_fa_error_strings),
594 .error_strings = acl_fa_error_strings,
595 .n_next_nodes = ACL_FA_N_NEXT,
598 [ACL_FA_ERROR_DROP] = "error-drop",
602 VNET_FEATURE_INIT (acl_out_ip6_fa_feature, static) =
604 .arc_name = "ip6-output",
605 .node_name = "acl-plugin-out-ip6-fa",
606 .runs_before = VNET_FEATURES ("interface-output"),
609 VLIB_REGISTER_NODE (acl_out_fa_ip4_node) =
611 .name = "acl-plugin-out-ip4-fa",
612 .vector_size = sizeof (u32),
613 .format_trace = format_acl_plugin_trace,
614 .type = VLIB_NODE_TYPE_INTERNAL,
615 .n_errors = ARRAY_LEN (acl_fa_error_strings),
616 .error_strings = acl_fa_error_strings,
617 .n_next_nodes = ACL_FA_N_NEXT,
618 /* edit / add dispositions here */
621 [ACL_FA_ERROR_DROP] = "error-drop",
625 VNET_FEATURE_INIT (acl_out_ip4_fa_feature, static) =
627 .arc_name = "ip4-output",
628 .node_name = "acl-plugin-out-ip4-fa",
629 .runs_before = VNET_FEATURES ("interface-output"),
636 * fd.io coding-style-patch-verification: ON
639 * eval: (c-set-style "gnu")