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:
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.
18 #include <vnet/vnet.h>
19 #include <vnet/plugin/plugin.h>
22 #include <vnet/l2/l2_classify.h>
23 #include <vnet/l2/l2_in_out_feat_arc.h>
24 #include <vnet/classify/in_out_acl.h>
25 #include <vpp/app/version.h>
27 #include <vnet/ethernet/ethernet_types_api.h>
28 #include <vnet/ip/format.h>
29 #include <vnet/ethernet/ethernet.h>
30 #include <vnet/ip/ip_types_api.h>
32 #include <vlibapi/api.h>
33 #include <vlibmemory/api.h>
35 /* define message IDs */
36 #include <acl/acl.api_enum.h>
37 #include <acl/acl.api_types.h>
41 #include "public_inlines.h"
45 #define REPLY_MSG_ID_BASE am->msg_id_base
46 #include <vlibapi/api_helper_macros.h>
49 * The code for the bihash, used by the session management.
51 #include <vppinfra/bihash_40_8.h>
52 #include <vppinfra/bihash_template.h>
53 #include <vppinfra/bihash_template.c>
56 VLIB_PLUGIN_REGISTER () = {
57 .version = VPP_BUILD_VER,
58 .description = "Access Control Lists (ACL)",
62 /* methods exported from ACL-as-a-service */
63 static acl_plugin_methods_t acl_plugin;
67 format_vec16 (u8 * s, va_list * va)
69 u16 *v = va_arg (*va, u16 *);
70 char *fmt = va_arg (*va, char *);
72 for (i = 0; i < vec_len (v); i++)
76 s = format (s, fmt, v[i]);
82 vl_api_acl_plugin_get_version_t_handler (vl_api_acl_plugin_get_version_t * mp)
84 acl_main_t *am = &acl_main;
85 vl_api_acl_plugin_get_version_reply_t *rmp;
86 int msg_size = sizeof (*rmp);
87 vl_api_registration_t *reg;
89 reg = vl_api_client_index_to_registration (mp->client_index);
93 rmp = vl_msg_api_alloc (msg_size);
94 clib_memset (rmp, 0, msg_size);
96 ntohs (VL_API_ACL_PLUGIN_GET_VERSION_REPLY + am->msg_id_base);
97 rmp->context = mp->context;
98 rmp->major = htonl (ACL_PLUGIN_VERSION_MAJOR);
99 rmp->minor = htonl (ACL_PLUGIN_VERSION_MINOR);
101 vl_api_send_msg (reg, (u8 *) rmp);
105 vl_api_acl_plugin_control_ping_t_handler (vl_api_acl_plugin_control_ping_t *
108 vl_api_acl_plugin_control_ping_reply_t *rmp;
109 acl_main_t *am = &acl_main;
113 REPLY_MACRO2 (VL_API_ACL_PLUGIN_CONTROL_PING_REPLY,
115 rmp->vpe_pid = ntohl (getpid ());
121 print_clib_warning_and_reset (vlib_main_t * vm, u8 * out0)
123 clib_warning ("%v", out0);
124 vec_reset_length (out0);
128 print_cli_and_reset (vlib_main_t * vm, u8 * out0)
130 vlib_cli_output (vm, "%v", out0);
131 vec_reset_length (out0);
134 typedef void (*acl_vector_print_func_t) (vlib_main_t * vm, u8 * out0);
137 format_acl_action (u8 * s, u8 action)
142 s = format (s, "deny");
145 s = format (s, "permit");
148 s = format (s, "permit+reflect");
151 s = format (s, "action %d", action);
157 acl_print_acl_x (acl_vector_print_func_t vpr, vlib_main_t * vm,
158 acl_main_t * am, int acl_index)
161 acl_rule_t *acl_rules = am->acls[acl_index].rules;
162 u8 *out0 = format (0, "acl-index %u count %u tag {%s}\n", acl_index,
163 vec_len (acl_rules), am->acls[acl_index].tag);
166 for (j = 0; j < vec_len (acl_rules); j++)
169 out0 = format (out0, " %9d: %s ", j, r->is_ipv6 ? "ipv6" : "ipv4");
170 out0 = format_acl_action (out0, r->is_permit);
171 out0 = format (out0, " src %U/%d", format_ip46_address, &r->src,
172 r->is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4,
175 format (out0, " dst %U/%d", format_ip46_address, &r->dst,
176 r->is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4, r->dst_prefixlen);
177 out0 = format (out0, " proto %d", r->proto);
178 out0 = format (out0, " sport %d", r->src_port_or_type_first);
179 if (r->src_port_or_type_first != r->src_port_or_type_last)
181 out0 = format (out0, "-%d", r->src_port_or_type_last);
183 out0 = format (out0, " dport %d", r->dst_port_or_code_first);
184 if (r->dst_port_or_code_first != r->dst_port_or_code_last)
186 out0 = format (out0, "-%d", r->dst_port_or_code_last);
188 if (r->tcp_flags_mask || r->tcp_flags_value)
191 format (out0, " tcpflags %d mask %d", r->tcp_flags_value,
194 out0 = format (out0, "\n");
200 vl_api_acl_plugin_get_conn_table_max_entries_t_handler
201 (vl_api_acl_plugin_get_conn_table_max_entries_t * mp)
203 acl_main_t *am = &acl_main;
204 vl_api_acl_plugin_get_conn_table_max_entries_reply_t *rmp;
205 int msg_size = sizeof (*rmp);
206 vl_api_registration_t *rp;
208 rp = vl_api_client_index_to_registration (mp->client_index);
212 rmp = vl_msg_api_alloc (msg_size);
213 memset (rmp, 0, msg_size);
215 ntohs (VL_API_ACL_PLUGIN_GET_CONN_TABLE_MAX_ENTRIES_REPLY +
217 rmp->context = mp->context;
218 rmp->conn_table_max_entries =
219 clib_net_to_host_u64 (am->fa_conn_table_max_entries);
221 vl_api_send_msg (rp, (u8 *) rmp);
225 acl_print_acl (vlib_main_t * vm, acl_main_t * am, int acl_index)
227 acl_print_acl_x (print_cli_and_reset, vm, am, acl_index);
231 warning_acl_print_acl (vlib_main_t * vm, acl_main_t * am, int acl_index)
233 acl_print_acl_x (print_clib_warning_and_reset, vm, am, acl_index);
237 increment_policy_epoch (acl_main_t * am, u32 sw_if_index, int is_input)
240 u32 **ppolicy_epoch_by_swi =
241 is_input ? &am->input_policy_epoch_by_sw_if_index :
242 &am->output_policy_epoch_by_sw_if_index;
243 vec_validate (*ppolicy_epoch_by_swi, sw_if_index);
245 u32 *p_epoch = vec_elt_at_index ((*ppolicy_epoch_by_swi), sw_if_index);
247 ((1 + *p_epoch) & FA_POLICY_EPOCH_MASK) +
248 (is_input * FA_POLICY_EPOCH_IS_INPUT);
252 try_increment_acl_policy_epoch (acl_main_t * am, u32 acl_num, int is_input)
254 u32 ***p_swi_vec_by_acl = is_input ? &am->input_sw_if_index_vec_by_acl
255 : &am->output_sw_if_index_vec_by_acl;
256 if (acl_num < vec_len (*p_swi_vec_by_acl))
259 vec_foreach (p_swi, (*p_swi_vec_by_acl)[acl_num])
261 increment_policy_epoch (am, *p_swi, is_input);
268 policy_notify_acl_change (acl_main_t * am, u32 acl_num)
270 try_increment_acl_policy_epoch (am, acl_num, 0);
271 try_increment_acl_policy_epoch (am, acl_num, 1);
276 validate_and_reset_acl_counters (acl_main_t * am, u32 acl_index)
279 /* counters are set as vectors [acl#] pointing to vectors of [acl rule] */
280 acl_plugin_counter_lock (am);
282 int old_len = vec_len (am->combined_acl_counters);
284 vec_validate (am->combined_acl_counters, acl_index);
286 for (i = old_len; i < vec_len (am->combined_acl_counters); i++)
288 am->combined_acl_counters[i].name = 0;
289 /* filled in once only */
290 am->combined_acl_counters[i].stat_segment_name = (void *)
291 format (0, "/acl/%d/matches%c", i, 0);
292 i32 rule_count = vec_len (am->acls[i].rules);
293 /* Validate one extra so we always have at least one counter for an ACL */
294 vlib_validate_combined_counter (&am->combined_acl_counters[i],
296 vlib_clear_combined_counters (&am->combined_acl_counters[i]);
299 /* (re)validate for the actual ACL that is getting added/updated */
300 i32 rule_count = vec_len (am->acls[acl_index].rules);
301 /* Validate one extra so we always have at least one counter for an ACL */
302 vlib_validate_combined_counter (&am->combined_acl_counters[acl_index],
304 vlib_clear_combined_counters (&am->combined_acl_counters[acl_index]);
305 acl_plugin_counter_unlock (am);
309 acl_api_invalid_prefix (const vl_api_prefix_t * prefix)
311 ip_prefix_t ip_prefix;
312 return ip_prefix_decode2 (prefix, &ip_prefix);
316 acl_add_list (u32 count, vl_api_acl_rule_t rules[],
317 u32 * acl_list_index, u8 * tag)
319 acl_main_t *am = &acl_main;
322 acl_rule_t *acl_new_rules = 0;
326 tag_len = clib_strnlen ((const char *) tag, sizeof (a->tag));
327 if (tag_len == sizeof (a->tag))
328 return VNET_API_ERROR_INVALID_VALUE;
330 if (am->trace_acl > 255)
331 clib_warning ("API dbg: acl_add_list index %d tag %s", *acl_list_index,
334 /* check if what they request is consistent */
335 for (i = 0; i < count; i++)
337 if (acl_api_invalid_prefix (&rules[i].src_prefix))
338 return VNET_API_ERROR_INVALID_SRC_ADDRESS;
339 if (acl_api_invalid_prefix (&rules[i].dst_prefix))
340 return VNET_API_ERROR_INVALID_DST_ADDRESS;
341 if (ntohs (rules[i].srcport_or_icmptype_first) >
342 ntohs (rules[i].srcport_or_icmptype_last))
343 return VNET_API_ERROR_INVALID_VALUE_2;
344 if (ntohs (rules[i].dstport_or_icmpcode_first) >
345 ntohs (rules[i].dstport_or_icmpcode_last))
346 return VNET_API_ERROR_INVALID_VALUE_2;
349 if (*acl_list_index != ~0)
351 /* They supplied some number, let's see if this ACL exists */
352 if (pool_is_free_index (am->acls, *acl_list_index))
354 /* tried to replace a non-existent ACL, no point doing anything */
356 ("acl-plugin-error: Trying to replace nonexistent ACL %d (tag %s)",
357 *acl_list_index, tag);
358 return VNET_API_ERROR_NO_SUCH_ENTRY;
364 ("acl-plugin-warning: supplied no rules for ACL %d (tag %s)",
365 *acl_list_index, tag);
368 /* Create and populate the rules */
370 vec_validate (acl_new_rules, count - 1);
372 for (i = 0; i < count; i++)
374 r = vec_elt_at_index (acl_new_rules, i);
375 clib_memset (r, 0, sizeof (*r));
376 r->is_permit = rules[i].is_permit;
377 r->is_ipv6 = rules[i].src_prefix.address.af;
378 ip_address_decode (&rules[i].src_prefix.address, &r->src);
379 ip_address_decode (&rules[i].dst_prefix.address, &r->dst);
380 r->src_prefixlen = rules[i].src_prefix.len;
381 r->dst_prefixlen = rules[i].dst_prefix.len;
382 r->proto = rules[i].proto;
383 r->src_port_or_type_first = ntohs (rules[i].srcport_or_icmptype_first);
384 r->src_port_or_type_last = ntohs (rules[i].srcport_or_icmptype_last);
385 r->dst_port_or_code_first = ntohs (rules[i].dstport_or_icmpcode_first);
386 r->dst_port_or_code_last = ntohs (rules[i].dstport_or_icmpcode_last);
387 r->tcp_flags_value = rules[i].tcp_flags_value;
388 r->tcp_flags_mask = rules[i].tcp_flags_mask;
391 if (~0 == *acl_list_index)
394 pool_get_aligned (am->acls, a, CLIB_CACHE_LINE_BYTES);
395 clib_memset (a, 0, sizeof (*a));
396 /* Will return the newly allocated ACL index */
397 *acl_list_index = a - am->acls;
401 a = am->acls + *acl_list_index;
402 /* Get rid of the old rules */
406 a->rules = acl_new_rules;
407 memcpy (a->tag, tag, tag_len + 1);
408 if (am->trace_acl > 255)
409 warning_acl_print_acl (am->vlib_main, am, *acl_list_index);
410 if (am->reclassify_sessions)
412 /* a change in an ACLs if they are applied may mean a new policy epoch */
413 policy_notify_acl_change (am, *acl_list_index);
415 validate_and_reset_acl_counters (am, *acl_list_index);
416 acl_plugin_lookup_context_notify_acl_change (*acl_list_index);
421 acl_is_used_by (u32 acl_index, u32 ** foo_index_vec_by_acl)
423 if (acl_index < vec_len (foo_index_vec_by_acl))
425 if (vec_len (vec_elt (foo_index_vec_by_acl, acl_index)) > 0)
427 /* ACL is applied somewhere. */
435 acl_del_list (u32 acl_list_index)
437 acl_main_t *am = &acl_main;
439 if (pool_is_free_index (am->acls, acl_list_index))
441 return VNET_API_ERROR_NO_SUCH_ENTRY;
443 if (acl_is_used_by (acl_list_index, am->input_sw_if_index_vec_by_acl))
444 return VNET_API_ERROR_ACL_IN_USE_INBOUND;
445 if (acl_is_used_by (acl_list_index, am->output_sw_if_index_vec_by_acl))
446 return VNET_API_ERROR_ACL_IN_USE_OUTBOUND;
447 /* lookup contexts cover other cases, not just inbound/outbound, so check that */
448 if (acl_is_used_by (acl_list_index, am->lc_index_vec_by_acl))
449 return VNET_API_ERROR_ACL_IN_USE_BY_LOOKUP_CONTEXT;
451 /* now we can delete the ACL itself */
452 a = pool_elt_at_index (am->acls, acl_list_index);
455 pool_put (am->acls, a);
456 /* acl_list_index is now free, notify the lookup contexts */
457 acl_plugin_lookup_context_notify_acl_change (acl_list_index);
462 count_skip (u8 * p, u32 size)
464 u64 *p64 = (u64 *) p;
465 /* Be tolerant to null pointer */
469 while ((0ULL == *p64) && ((u8 *) p64 - p) < size)
473 return (p64 - (u64 *) p) / 2;
477 acl_classify_add_del_table_small (vnet_classify_main_t * cm, u8 * mask,
478 u32 mask_len, u32 next_table_index,
479 u32 miss_next_index, u32 * table_index,
483 u32 memory_size = 2 << 22;
484 u32 skip = count_skip (mask, mask_len);
485 u32 match = (mask_len / 16) - skip;
486 u8 *skip_mask_ptr = mask + 16 * skip;
487 u32 current_data_flag = 0;
488 int current_data_offset = 0;
493 int ret = vnet_classify_add_del_table (cm, skip_mask_ptr, nbuckets,
494 memory_size, skip, match,
495 next_table_index, miss_next_index,
496 table_index, current_data_flag,
497 current_data_offset, is_add,
498 1 /* delete_chain */ );
503 intf_has_etype_whitelist (acl_main_t * am, u32 sw_if_index, int is_input)
506 ? am->input_etype_whitelist_by_sw_if_index
507 : am->output_etype_whitelist_by_sw_if_index;
508 u16 *whitelist = (vec_len (v) > sw_if_index) ? vec_elt (v, sw_if_index) : 0;
509 return vec_len (whitelist) > 0;
513 acl_clear_sessions (acl_main_t * am, u32 sw_if_index)
515 vlib_process_signal_event (am->vlib_main, am->fa_cleaner_node_index,
516 ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX,
522 acl_interface_in_enable_disable (acl_main_t * am, u32 sw_if_index,
528 if (pool_is_free_index (am->vnet_main->interface_main.sw_interfaces,
530 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
532 if (clib_bitmap_get (am->in_acl_on_sw_if_index, sw_if_index) ==
536 acl_fa_enable_disable (sw_if_index, 1, enable_disable);
538 rv = vnet_l2_feature_enable_disable ("l2-input-ip4", "acl-plugin-in-ip4-l2",
539 sw_if_index, enable_disable, 0, 0);
541 clib_error ("Could not enable on input");
542 rv = vnet_l2_feature_enable_disable ("l2-input-ip6", "acl-plugin-in-ip6-l2",
543 sw_if_index, enable_disable, 0, 0);
545 clib_error ("Could not enable on input");
547 if (intf_has_etype_whitelist (am, sw_if_index, 1))
548 vnet_l2_feature_enable_disable ("l2-input-nonip",
549 "acl-plugin-in-nonip-l2", sw_if_index,
550 enable_disable, 0, 0);
551 am->in_acl_on_sw_if_index =
552 clib_bitmap_set (am->in_acl_on_sw_if_index, sw_if_index, enable_disable);
558 acl_interface_out_enable_disable (acl_main_t * am, u32 sw_if_index,
564 if (pool_is_free_index (am->vnet_main->interface_main.sw_interfaces,
566 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
568 if (clib_bitmap_get (am->out_acl_on_sw_if_index, sw_if_index) ==
572 acl_fa_enable_disable (sw_if_index, 0, enable_disable);
575 vnet_l2_feature_enable_disable ("l2-output-ip4", "acl-plugin-out-ip4-l2",
576 sw_if_index, enable_disable, 0, 0);
578 clib_error ("Could not enable on output");
580 vnet_l2_feature_enable_disable ("l2-output-ip6", "acl-plugin-out-ip6-l2",
581 sw_if_index, enable_disable, 0, 0);
583 clib_error ("Could not enable on output");
584 if (intf_has_etype_whitelist (am, sw_if_index, 0))
585 vnet_l2_feature_enable_disable ("l2-output-nonip",
586 "acl-plugin-out-nonip-l2", sw_if_index,
587 enable_disable, 0, 0);
588 am->out_acl_on_sw_if_index =
589 clib_bitmap_set (am->out_acl_on_sw_if_index, sw_if_index, enable_disable);
595 acl_stats_intf_counters_enable_disable (acl_main_t * am, int enable_disable)
599 am->interface_acl_counters_enabled = enable_disable;
605 acl_interface_inout_enable_disable (acl_main_t * am, u32 sw_if_index,
606 int is_input, int enable_disable)
609 return acl_interface_in_enable_disable (am, sw_if_index, enable_disable);
611 return acl_interface_out_enable_disable (am, sw_if_index, enable_disable);
615 acl_is_not_defined (acl_main_t * am, u32 acl_list_index)
617 return (pool_is_free_index (am->acls, acl_list_index));
621 acl_interface_set_inout_acl_list (acl_main_t * am, u32 sw_if_index,
622 u8 is_input, u32 * vec_acl_list_index,
623 int *may_clear_sessions)
626 uword *seen_acl_bitmap = 0;
627 uword *old_seen_acl_bitmap = 0;
628 uword *change_acl_bitmap = 0;
633 if (am->trace_acl > 255)
635 ("API dbg: acl_interface_set_inout_acl_list: sw_if_index %d is_input %d acl_vec: [%U]",
636 sw_if_index, is_input, format_vec32, vec_acl_list_index, "%d");
638 vec_foreach (pacln, vec_acl_list_index)
640 if (acl_is_not_defined (am, *pacln))
642 /* ACL is not defined. Can not apply */
643 clib_warning ("ERROR: ACL %d not defined", *pacln);
644 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
647 if (clib_bitmap_get (seen_acl_bitmap, *pacln))
649 /* ACL being applied twice within the list. error. */
650 clib_warning ("ERROR: ACL %d being applied twice", *pacln);
651 rv = VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
654 seen_acl_bitmap = clib_bitmap_set (seen_acl_bitmap, *pacln, 1);
658 u32 **pinout_lc_index_by_sw_if_index =
659 is_input ? &am->input_lc_index_by_sw_if_index : &am->
660 output_lc_index_by_sw_if_index;
662 u32 ***pinout_acl_vec_by_sw_if_index =
663 is_input ? &am->input_acl_vec_by_sw_if_index : &am->
664 output_acl_vec_by_sw_if_index;
666 u32 ***pinout_sw_if_index_vec_by_acl =
667 is_input ? &am->input_sw_if_index_vec_by_acl : &am->
668 output_sw_if_index_vec_by_acl;
670 vec_validate ((*pinout_acl_vec_by_sw_if_index), sw_if_index);
672 clib_bitmap_validate (old_seen_acl_bitmap, 1);
674 vec_foreach (pacln, (*pinout_acl_vec_by_sw_if_index)[sw_if_index])
676 old_seen_acl_bitmap = clib_bitmap_set (old_seen_acl_bitmap, *pacln, 1);
679 clib_bitmap_dup_xor (old_seen_acl_bitmap, seen_acl_bitmap);
681 if (am->trace_acl > 255)
682 clib_warning ("bitmaps: old seen %U new seen %U changed %U",
683 format_bitmap_hex, old_seen_acl_bitmap, format_bitmap_hex,
684 seen_acl_bitmap, format_bitmap_hex, change_acl_bitmap);
687 clib_bitmap_foreach (acln, change_acl_bitmap) {
688 if (clib_bitmap_get(old_seen_acl_bitmap, acln)) {
689 /* ACL is being removed. */
690 if (acln < vec_len((*pinout_sw_if_index_vec_by_acl))) {
691 int index = vec_search((*pinout_sw_if_index_vec_by_acl)[acln], sw_if_index);
692 vec_del1((*pinout_sw_if_index_vec_by_acl)[acln], index);
695 /* ACL is being added. */
696 vec_validate((*pinout_sw_if_index_vec_by_acl), acln);
697 vec_add1((*pinout_sw_if_index_vec_by_acl)[acln], sw_if_index);
702 vec_free ((*pinout_acl_vec_by_sw_if_index)[sw_if_index]);
703 (*pinout_acl_vec_by_sw_if_index)[sw_if_index] =
704 vec_dup (vec_acl_list_index);
706 if (am->reclassify_sessions)
708 /* re-applying ACLs means a new policy epoch */
709 increment_policy_epoch (am, sw_if_index, is_input);
713 /* if no commonalities between the ACL# - then we should definitely clear the sessions */
714 if (may_clear_sessions && *may_clear_sessions
715 && !clib_bitmap_is_zero (change_acl_bitmap))
717 acl_clear_sessions (am, sw_if_index);
718 *may_clear_sessions = 0;
723 * prepare or delete the lookup context if necessary, and if context exists, set ACL list
725 vec_validate_init_empty ((*pinout_lc_index_by_sw_if_index), sw_if_index,
727 if (vec_len (vec_acl_list_index) > 0)
729 u32 lc_index = (*pinout_lc_index_by_sw_if_index)[sw_if_index];
733 acl_plugin.get_lookup_context_index (am->interface_acl_user_id,
734 sw_if_index, is_input);
735 (*pinout_lc_index_by_sw_if_index)[sw_if_index] = lc_index;
737 acl_plugin.set_acl_vec_for_context (lc_index, vec_acl_list_index);
741 if (~0 != (*pinout_lc_index_by_sw_if_index)[sw_if_index])
744 put_lookup_context_index ((*pinout_lc_index_by_sw_if_index)
746 (*pinout_lc_index_by_sw_if_index)[sw_if_index] = ~0;
749 /* ensure ACL processing is enabled/disabled as needed */
750 acl_interface_inout_enable_disable (am, sw_if_index, is_input,
751 vec_len (vec_acl_list_index) > 0);
754 clib_bitmap_free (change_acl_bitmap);
755 clib_bitmap_free (seen_acl_bitmap);
756 clib_bitmap_free (old_seen_acl_bitmap);
761 acl_interface_reset_inout_acls (u32 sw_if_index, u8 is_input,
762 int *may_clear_sessions)
764 acl_main_t *am = &acl_main;
765 acl_interface_set_inout_acl_list (am, sw_if_index, is_input, 0,
770 acl_interface_add_del_inout_acl (u32 sw_if_index, u8 is_add, u8 is_input,
774 acl_main_t *am = &acl_main;
776 int may_clear_sessions = 1;
778 int error_already_applied = is_input ? VNET_API_ERROR_ACL_IN_USE_INBOUND
779 : VNET_API_ERROR_ACL_IN_USE_OUTBOUND;
781 u32 ***pinout_acl_vec_by_sw_if_index =
782 is_input ? &am->input_acl_vec_by_sw_if_index : &am->
783 output_acl_vec_by_sw_if_index;
787 vec_validate ((*pinout_acl_vec_by_sw_if_index), sw_if_index);
788 u32 index = vec_search ((*pinout_acl_vec_by_sw_if_index)[sw_if_index],
793 rv = error_already_applied;
797 acl_vec = vec_dup ((*pinout_acl_vec_by_sw_if_index)[sw_if_index]);
798 vec_add1 (acl_vec, acl_list_index);
802 if (sw_if_index >= vec_len (*pinout_acl_vec_by_sw_if_index))
804 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
808 u32 index = vec_search ((*pinout_acl_vec_by_sw_if_index)[sw_if_index],
813 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
817 acl_vec = vec_dup ((*pinout_acl_vec_by_sw_if_index)[sw_if_index]);
818 vec_del1 (acl_vec, index);
821 rv = acl_interface_set_inout_acl_list (am, sw_if_index, is_input, acl_vec,
822 &may_clear_sessions);
829 acl_set_etype_whitelists (acl_main_t * am, u32 sw_if_index, u16 * vec_in,
832 vec_validate (am->input_etype_whitelist_by_sw_if_index, sw_if_index);
833 vec_validate (am->output_etype_whitelist_by_sw_if_index, sw_if_index);
835 vec_free (am->input_etype_whitelist_by_sw_if_index[sw_if_index]);
836 vec_free (am->output_etype_whitelist_by_sw_if_index[sw_if_index]);
838 am->input_etype_whitelist_by_sw_if_index[sw_if_index] = vec_in;
839 am->output_etype_whitelist_by_sw_if_index[sw_if_index] = vec_out;
842 * if there are already inbound/outbound ACLs applied, toggle the
843 * enable/disable - this will recreate the necessary tables.
846 if (vec_len (am->input_acl_vec_by_sw_if_index) > sw_if_index)
848 if (vec_len (am->input_acl_vec_by_sw_if_index[sw_if_index]) > 0)
850 acl_interface_in_enable_disable (am, sw_if_index, 0);
851 acl_interface_in_enable_disable (am, sw_if_index, 1);
854 if (vec_len (am->output_acl_vec_by_sw_if_index) > sw_if_index)
856 if (vec_len (am->output_acl_vec_by_sw_if_index[sw_if_index]) > 0)
858 acl_interface_out_enable_disable (am, sw_if_index, 0);
859 acl_interface_out_enable_disable (am, sw_if_index, 1);
875 u32 dot1q_table_index;
876 u32 dot1ad_table_index;
877 u32 arp_dot1q_table_index;
878 u32 arp_dot1ad_table_index;
881 u32 out_arp_table_index;
882 u32 out_dot1q_table_index;
883 u32 out_dot1ad_table_index;
884 u32 out_arp_dot1q_table_index;
885 u32 out_arp_dot1ad_table_index;
886 } macip_match_type_t;
889 macip_find_match_type (macip_match_type_t * mv, u8 * mac_mask, u8 prefix_len,
895 for (i = 0; i < vec_len (mv); i++)
897 if ((mv[i].prefix_len == prefix_len) && (mv[i].is_ipv6 == is_ipv6)
898 && (0 == memcmp (mv[i].mac_mask, mac_mask, 6)))
908 /* Get metric used to sort match types.
909 The more specific and the more often seen - the bigger the metric */
911 match_type_metric (macip_match_type_t * m)
913 unsigned int mac_bits_set = 0;
914 unsigned int mac_byte;
916 for (i = 0; i < 6; i++)
918 mac_byte = m->mac_mask[i];
919 for (; mac_byte; mac_byte >>= 1)
920 mac_bits_set += mac_byte & 1;
923 * Attempt to place the more specific and the more used rules on top.
924 * There are obvious caveat corner cases to this, but they do not
925 * seem to be sensible in real world (e.g. specific IPv4 with wildcard MAC
926 * going with a wildcard IPv4 with a specific MAC).
928 return m->prefix_len + mac_bits_set + m->is_ipv6 + 10 * m->count;
932 match_type_compare (macip_match_type_t * m1, macip_match_type_t * m2)
934 /* Ascending sort based on the metric values */
935 return match_type_metric (m1) - match_type_metric (m2);
938 /* Get the offset of L3 source within ethernet packet */
940 get_l3_src_offset (int is6)
943 return (sizeof (ethernet_header_t) +
944 offsetof (ip6_header_t, src_address));
946 return (sizeof (ethernet_header_t) +
947 offsetof (ip4_header_t, src_address));
951 get_l3_dst_offset (int is6)
954 return (sizeof (ethernet_header_t) +
955 offsetof (ip6_header_t, dst_address));
957 return (sizeof (ethernet_header_t) +
958 offsetof (ip4_header_t, dst_address));
962 * return if the is_permit value also requires to create the egress tables
963 * For backwards compatibility, we keep the is_permit = 1 to only
964 * create the ingress tables, and the new value of 3 will also
965 * create the egress tables based on destination.
968 macip_permit_also_egress (u8 is_permit)
970 return (is_permit == 3);
974 macip_create_classify_tables (acl_main_t * am, u32 macip_acl_index)
976 macip_match_type_t *mvec = NULL;
977 macip_match_type_t *mt;
978 macip_acl_list_t *a = pool_elt_at_index (am->macip_acls, macip_acl_index);
980 u32 match_type_index;
984 vnet_classify_main_t *cm = &vnet_classify_main;
986 /* Count the number of different types of rules */
987 for (i = 0; i < a->count; i++)
991 macip_find_match_type (mvec, a->rules[i].src_mac_mask,
992 a->rules[i].src_prefixlen,
993 a->rules[i].is_ipv6)))
995 match_type_index = vec_len (mvec);
996 vec_validate (mvec, match_type_index);
997 memcpy (mvec[match_type_index].mac_mask,
998 a->rules[i].src_mac_mask, 6);
999 mvec[match_type_index].prefix_len = a->rules[i].src_prefixlen;
1000 mvec[match_type_index].is_ipv6 = a->rules[i].is_ipv6;
1001 mvec[match_type_index].has_egress = 0;
1002 mvec[match_type_index].table_index = ~0;
1003 mvec[match_type_index].arp_table_index = ~0;
1004 mvec[match_type_index].dot1q_table_index = ~0;
1005 mvec[match_type_index].dot1ad_table_index = ~0;
1006 mvec[match_type_index].arp_dot1q_table_index = ~0;
1007 mvec[match_type_index].arp_dot1ad_table_index = ~0;
1008 mvec[match_type_index].out_table_index = ~0;
1009 mvec[match_type_index].out_arp_table_index = ~0;
1010 mvec[match_type_index].out_dot1q_table_index = ~0;
1011 mvec[match_type_index].out_dot1ad_table_index = ~0;
1012 mvec[match_type_index].out_arp_dot1q_table_index = ~0;
1013 mvec[match_type_index].out_arp_dot1ad_table_index = ~0;
1015 mvec[match_type_index].count++;
1016 mvec[match_type_index].has_egress |=
1017 macip_permit_also_egress (a->rules[i].is_permit);
1019 /* Put the most frequently used tables last in the list so we can create classifier tables in reverse order */
1020 vec_sort_with_function (mvec, match_type_compare);
1021 /* Create the classifier tables */
1023 out_last_table = ~0;
1024 /* First add ARP tables */
1025 vec_foreach (mt, mvec)
1028 int is6 = mt->is_ipv6;
1030 u32 *last_tag_table;
1031 u32 *out_last_tag_table;
1038 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1039 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1040 | Destination Address |
1041 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1043 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +
1045 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1046 | EtherType | Hardware Type |
1047 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1048 | Protocol Type | Hw addr len | Proto addr len|
1049 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1051 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +
1052 | Sender Hardware Address |
1053 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1054 | Sender Protocol Address |
1055 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1056 | Target Hardware Address |
1057 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1058 | | TargetProtocolAddress |
1059 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1061 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1063 for (tags = 2; tags >= 0; tags--)
1065 clib_memset (mask, 0, sizeof (mask));
1066 /* source MAC address */
1067 memcpy (&mask[6], mt->mac_mask, 6);
1073 clib_memset (&mask[12], 0xff, 2); /* ethernet protocol */
1075 last_tag_table = &mt->arp_table_index;
1078 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1079 clib_memset (&mask[16], 0xff, 2); /* ethernet protocol */
1081 last_tag_table = &mt->arp_dot1q_table_index;
1084 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1085 clib_memset (&mask[16], 0xff, 2); /* VLAN tag2 */
1086 clib_memset (&mask[20], 0xff, 2); /* ethernet protocol */
1088 last_tag_table = &mt->arp_dot1ad_table_index;
1092 /* sender hardware address within ARP */
1093 memcpy (&mask[l3_offset + 8], mt->mac_mask, 6);
1094 /* sender protocol address within ARP */
1095 for (i = 0; i < (mt->prefix_len / 8); i++)
1096 mask[l3_offset + 14 + i] = 0xff;
1097 if (mt->prefix_len % 8)
1098 mask[l3_offset + 14 + (mt->prefix_len / 8)] =
1099 0xff - ((1 << (8 - mt->prefix_len % 8)) - 1);
1101 mask_len = ((l3_offset + 14 + ((mt->prefix_len + 7) / 8) +
1103 1)) / sizeof (u32x4)) * sizeof (u32x4);
1104 acl_classify_add_del_table_small (cm, mask, mask_len, last_table,
1105 (~0 == last_table) ? 0 : ~0,
1107 last_table = *last_tag_table;
1110 /* egress ARP table */
1111 clib_memset (mask, 0, sizeof (mask));
1117 clib_memset (&mask[12], 0xff, 2); /* ethernet protocol */
1119 out_last_tag_table = &mt->out_arp_table_index;
1122 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1123 clib_memset (&mask[16], 0xff, 2); /* ethernet protocol */
1125 out_last_tag_table = &mt->out_arp_dot1q_table_index;
1128 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1129 clib_memset (&mask[16], 0xff, 2); /* VLAN tag2 */
1130 clib_memset (&mask[20], 0xff, 2); /* ethernet protocol */
1132 out_last_tag_table = &mt->out_arp_dot1ad_table_index;
1136 /* AYXX: FIXME here - can we tighten the ARP-related table more ? */
1137 /* mask captures just the destination and the ethertype */
1138 mask_len = ((l3_offset +
1140 1)) / sizeof (u32x4)) * sizeof (u32x4);
1141 acl_classify_add_del_table_small (cm, mask, mask_len,
1144 out_last_table) ? 0 : ~0,
1145 out_last_tag_table, 1);
1146 out_last_table = *out_last_tag_table;
1151 /* Now add IP[46] tables */
1152 vec_foreach (mt, mvec)
1155 int is6 = mt->is_ipv6;
1159 u32 *last_tag_table;
1160 u32 *out_last_tag_table;
1163 * create chained tables for VLAN (no-tags, dot1q and dot1ad) packets
1165 for (tags = 2; tags >= 0; tags--)
1167 clib_memset (mask, 0, sizeof (mask));
1168 memcpy (&mask[6], mt->mac_mask, 6);
1169 l3_src_offs = tags * 4 + get_l3_src_offset (is6);
1174 clib_memset (&mask[12], 0xff, 2); /* ethernet protocol */
1175 last_tag_table = &mt->table_index;
1178 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1179 clib_memset (&mask[16], 0xff, 2); /* ethernet protocol */
1180 last_tag_table = &mt->dot1q_table_index;
1183 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1184 clib_memset (&mask[16], 0xff, 2); /* VLAN tag2 */
1185 clib_memset (&mask[20], 0xff, 2); /* ethernet protocol */
1186 last_tag_table = &mt->dot1ad_table_index;
1189 for (i = 0; i < (mt->prefix_len / 8); i++)
1191 mask[l3_src_offs + i] = 0xff;
1193 if (mt->prefix_len % 8)
1195 mask[l3_src_offs + (mt->prefix_len / 8)] =
1196 0xff - ((1 << (8 - mt->prefix_len % 8)) - 1);
1199 * Round-up the number of bytes needed to store the prefix,
1200 * and round up the number of vectors too
1202 mask_len = ((l3_src_offs + ((mt->prefix_len + 7) / 8) +
1203 (sizeof (u32x4) - 1)) / sizeof (u32x4)) * sizeof (u32x4);
1204 acl_classify_add_del_table_small (cm, mask, mask_len, last_table,
1205 (~0 == last_table) ? 0 : ~0,
1207 last_table = *last_tag_table;
1211 for (tags = 2; tags >= 0; tags--)
1213 clib_memset (mask, 0, sizeof (mask));
1214 /* MAC destination */
1215 memcpy (&mask[0], mt->mac_mask, 6);
1216 l3_dst_offs = tags * 4 + get_l3_dst_offset (is6);
1221 clib_memset (&mask[12], 0xff, 2); /* ethernet protocol */
1222 out_last_tag_table = &mt->out_table_index;
1225 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1226 clib_memset (&mask[16], 0xff, 2); /* ethernet protocol */
1227 out_last_tag_table = &mt->out_dot1q_table_index;
1230 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1231 clib_memset (&mask[16], 0xff, 2); /* VLAN tag2 */
1232 clib_memset (&mask[20], 0xff, 2); /* ethernet protocol */
1233 out_last_tag_table = &mt->out_dot1ad_table_index;
1236 for (i = 0; i < (mt->prefix_len / 8); i++)
1238 mask[l3_dst_offs + i] = 0xff;
1240 if (mt->prefix_len % 8)
1242 mask[l3_dst_offs + (mt->prefix_len / 8)] =
1243 0xff - ((1 << (8 - mt->prefix_len % 8)) - 1);
1246 * Round-up the number of bytes needed to store the prefix,
1247 * and round up the number of vectors too
1249 mask_len = ((l3_dst_offs + ((mt->prefix_len + 7) / 8) +
1251 1)) / sizeof (u32x4)) * sizeof (u32x4);
1252 acl_classify_add_del_table_small (cm, mask, mask_len,
1254 (~0 == out_last_table) ? 0 : ~0,
1255 out_last_tag_table, 1);
1256 out_last_table = *out_last_tag_table;
1260 a->ip4_table_index = last_table;
1261 a->ip6_table_index = last_table;
1262 a->l2_table_index = last_table;
1264 a->out_ip4_table_index = out_last_table;
1265 a->out_ip6_table_index = out_last_table;
1266 a->out_l2_table_index = out_last_table;
1268 /* Populate the classifier tables with rules from the MACIP ACL */
1269 for (i = 0; i < a->count; i++)
1273 int is6 = a->rules[i].is_ipv6;
1280 macip_find_match_type (mvec, a->rules[i].src_mac_mask,
1281 a->rules[i].src_prefixlen,
1282 a->rules[i].is_ipv6);
1283 ASSERT (match_type_index != ~0);
1285 for (tags = 2; tags >= 0; tags--)
1287 clib_memset (mask, 0, sizeof (mask));
1288 l3_src_offs = tags * 4 + get_l3_src_offset (is6);
1289 memcpy (&mask[6], a->rules[i].src_mac, 6);
1294 tag_table = mvec[match_type_index].table_index;
1298 tag_table = mvec[match_type_index].dot1q_table_index;
1304 tag_table = mvec[match_type_index].dot1ad_table_index;
1314 memcpy (&mask[l3_src_offs], &a->rules[i].src_ip_addr.ip6, 16);
1316 mask[eth + 1] = 0xdd;
1320 memcpy (&mask[l3_src_offs], &a->rules[i].src_ip_addr.ip4, 4);
1322 mask[eth + 1] = 0x00;
1325 /* add session to table mvec[match_type_index].table_index; */
1326 vnet_classify_add_del_session (cm, tag_table,
1327 mask, a->rules[i].is_permit ? ~0 : 0,
1328 i, 0, action, metadata, 1);
1329 clib_memset (&mask[12], 0, sizeof (mask) - 12);
1332 /* add ARP table entry too */
1333 if (!is6 && (mvec[match_type_index].arp_table_index != ~0))
1335 clib_memset (mask, 0, sizeof (mask));
1336 memcpy (&mask[6], a->rules[i].src_mac, 6);
1338 for (tags = 2; tags >= 0; tags--)
1344 tag_table = mvec[match_type_index].arp_table_index;
1350 tag_table = mvec[match_type_index].arp_dot1q_table_index;
1358 tag_table = mvec[match_type_index].arp_dot1ad_table_index;
1369 memcpy (&mask[l3_src_offs + 8], a->rules[i].src_mac, 6);
1370 memcpy (&mask[l3_src_offs + 14], &a->rules[i].src_ip_addr.ip4,
1372 vnet_classify_add_del_session (cm, tag_table, mask,
1373 a->rules[i].is_permit ? ~0 : 0,
1374 i, 0, action, metadata, 1);
1377 if (macip_permit_also_egress (a->rules[i].is_permit))
1379 /* Add the egress entry with destination set */
1380 for (tags = 2; tags >= 0; tags--)
1382 clib_memset (mask, 0, sizeof (mask));
1383 l3_dst_offs = tags * 4 + get_l3_dst_offset (is6);
1384 /* src mac in the other direction becomes dst */
1385 memcpy (&mask[0], a->rules[i].src_mac, 6);
1390 tag_table = mvec[match_type_index].out_table_index;
1394 tag_table = mvec[match_type_index].out_dot1q_table_index;
1400 tag_table = mvec[match_type_index].out_dot1ad_table_index;
1410 memcpy (&mask[l3_dst_offs], &a->rules[i].src_ip_addr.ip6,
1413 mask[eth + 1] = 0xdd;
1417 memcpy (&mask[l3_dst_offs], &a->rules[i].src_ip_addr.ip4,
1420 mask[eth + 1] = 0x00;
1423 /* add session to table mvec[match_type_index].table_index; */
1424 vnet_classify_add_del_session (cm, tag_table,
1426 a->rules[i].is_permit ? ~0 : 0,
1427 i, 0, action, metadata, 1);
1428 // clib_memset (&mask[12], 0, sizeof (mask) - 12);
1431 /* add ARP table entry too */
1432 if (!is6 && (mvec[match_type_index].out_arp_table_index != ~0))
1434 for (tags = 2; tags >= 0; tags--)
1436 clib_memset (mask, 0, sizeof (mask));
1441 tag_table = mvec[match_type_index].out_arp_table_index;
1447 mvec[match_type_index].out_arp_dot1q_table_index;
1455 mvec[match_type_index].out_arp_dot1ad_table_index;
1465 vnet_classify_add_del_session (cm, tag_table,
1468 is_permit ? ~0 : 0, i, 0,
1469 action, metadata, 1);
1478 macip_destroy_classify_tables (acl_main_t * am, u32 macip_acl_index)
1480 vnet_classify_main_t *cm = &vnet_classify_main;
1481 macip_acl_list_t *a = pool_elt_at_index (am->macip_acls, macip_acl_index);
1483 if (a->ip4_table_index != ~0)
1485 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0,
1486 &a->ip4_table_index, 0);
1487 a->ip4_table_index = ~0;
1489 if (a->ip6_table_index != ~0)
1491 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0,
1492 &a->ip6_table_index, 0);
1493 a->ip6_table_index = ~0;
1495 if (a->l2_table_index != ~0)
1497 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0, &a->l2_table_index,
1499 a->l2_table_index = ~0;
1501 if (a->out_ip4_table_index != ~0)
1503 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0,
1504 &a->out_ip4_table_index, 0);
1505 a->out_ip4_table_index = ~0;
1507 if (a->out_ip6_table_index != ~0)
1509 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0,
1510 &a->out_ip6_table_index, 0);
1511 a->out_ip6_table_index = ~0;
1513 if (a->out_l2_table_index != ~0)
1515 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0,
1516 &a->out_l2_table_index, 0);
1517 a->out_l2_table_index = ~0;
1522 macip_maybe_apply_unapply_classifier_tables (acl_main_t * am, u32 acl_index,
1528 macip_acl_list_t *a = pool_elt_at_index (am->macip_acls, acl_index);
1530 for (i = 0; i < vec_len (am->macip_acl_by_sw_if_index); i++)
1531 if (vec_elt (am->macip_acl_by_sw_if_index, i) == acl_index)
1533 rv0 = vnet_set_input_acl_intfc (am->vlib_main, i, a->ip4_table_index,
1534 a->ip6_table_index, a->l2_table_index,
1536 /* return the first unhappy outcome but make try to plough through. */
1539 vnet_set_output_acl_intfc (am->vlib_main, i, a->out_ip4_table_index,
1540 a->out_ip6_table_index,
1541 a->out_l2_table_index, is_apply);
1542 /* return the first unhappy outcome but make try to plough through. */
1549 macip_acl_add_list (u32 count, vl_api_macip_acl_rule_t rules[],
1550 u32 * acl_list_index, u8 * tag)
1552 acl_main_t *am = &acl_main;
1553 macip_acl_list_t *a;
1554 macip_acl_rule_t *r;
1555 macip_acl_rule_t *acl_new_rules = 0;
1560 tag_len = clib_strnlen ((const char *) tag, sizeof (a->tag));
1561 if (tag_len == sizeof (a->tag))
1562 return VNET_API_ERROR_INVALID_VALUE;
1564 if (*acl_list_index != ~0)
1566 /* They supplied some number, let's see if this MACIP ACL exists */
1567 if (pool_is_free_index (am->macip_acls, *acl_list_index))
1569 /* tried to replace a non-existent ACL, no point doing anything */
1571 ("acl-plugin-error: Trying to replace nonexistent MACIP ACL %d (tag %s)",
1572 *acl_list_index, tag);
1573 return VNET_API_ERROR_NO_SUCH_ENTRY;
1580 ("acl-plugin-warning: Trying to create empty MACIP ACL (tag %s)",
1583 /* if replacing the ACL, unapply the classifier tables first - they will be gone.. */
1584 if (~0 != *acl_list_index)
1585 rv = macip_maybe_apply_unapply_classifier_tables (am, *acl_list_index, 0);
1586 /* Create and populate the rules */
1588 vec_validate (acl_new_rules, count - 1);
1590 for (i = 0; i < count; i++)
1592 r = &acl_new_rules[i];
1593 r->is_permit = rules[i].is_permit;
1594 r->is_ipv6 = rules[i].src_prefix.address.af;
1595 mac_address_decode (rules[i].src_mac, (mac_address_t *) & r->src_mac);
1596 mac_address_decode (rules[i].src_mac_mask,
1597 (mac_address_t *) & r->src_mac_mask);
1598 ip_address_decode (&rules[i].src_prefix.address, &r->src_ip_addr);
1599 r->src_prefixlen = rules[i].src_prefix.len;
1602 if (~0 == *acl_list_index)
1605 pool_get_aligned (am->macip_acls, a, CLIB_CACHE_LINE_BYTES);
1606 clib_memset (a, 0, sizeof (*a));
1607 /* Will return the newly allocated ACL index */
1608 *acl_list_index = a - am->macip_acls;
1612 a = pool_elt_at_index (am->macip_acls, *acl_list_index);
1615 vec_free (a->rules);
1617 macip_destroy_classify_tables (am, *acl_list_index);
1620 a->rules = acl_new_rules;
1622 memcpy (a->tag, tag, tag_len + 1);
1624 /* Create and populate the classifier tables */
1625 macip_create_classify_tables (am, *acl_list_index);
1626 /* If the ACL was already applied somewhere, reapply the newly created tables */
1628 || macip_maybe_apply_unapply_classifier_tables (am, *acl_list_index, 1);
1632 /* No check that sw_if_index denotes a valid interface - the callers
1633 * were supposed to validate.
1635 * That said, if sw_if_index corresponds to an interface that exists at all,
1636 * this function must return errors accordingly if the ACL is not applied.
1640 macip_acl_interface_del_acl (acl_main_t * am, u32 sw_if_index)
1643 u32 macip_acl_index;
1644 macip_acl_list_t *a;
1646 /* The vector is too short - MACIP ACL is not applied */
1647 if (sw_if_index >= vec_len (am->macip_acl_by_sw_if_index))
1648 return VNET_API_ERROR_NO_SUCH_ENTRY;
1650 macip_acl_index = am->macip_acl_by_sw_if_index[sw_if_index];
1651 /* No point in deleting MACIP ACL which is not applied */
1652 if (~0 == macip_acl_index)
1653 return VNET_API_ERROR_NO_SUCH_ENTRY;
1655 a = pool_elt_at_index (am->macip_acls, macip_acl_index);
1656 /* remove the classifier tables off the interface L2 ACL */
1658 vnet_set_input_acl_intfc (am->vlib_main, sw_if_index, a->ip4_table_index,
1659 a->ip6_table_index, a->l2_table_index, 0);
1661 vnet_set_output_acl_intfc (am->vlib_main, sw_if_index,
1662 a->out_ip4_table_index, a->out_ip6_table_index,
1663 a->out_l2_table_index, 0);
1664 /* Unset the MACIP ACL index */
1665 am->macip_acl_by_sw_if_index[sw_if_index] = ~0;
1666 /* macip_acl_interface_add_acl did a vec_add1() to this previously, so [sw_if_index] should be valid */
1667 u32 index = vec_search (am->sw_if_index_vec_by_macip_acl[macip_acl_index],
1670 vec_del1 (am->sw_if_index_vec_by_macip_acl[macip_acl_index], index);
1674 /* No check for validity of sw_if_index - the callers were supposed to validate */
1677 macip_acl_interface_add_acl (acl_main_t * am, u32 sw_if_index,
1678 u32 macip_acl_index)
1680 macip_acl_list_t *a;
1682 if (pool_is_free_index (am->macip_acls, macip_acl_index))
1684 return VNET_API_ERROR_NO_SUCH_ENTRY;
1686 a = pool_elt_at_index (am->macip_acls, macip_acl_index);
1687 vec_validate_init_empty (am->macip_acl_by_sw_if_index, sw_if_index, ~0);
1688 vec_validate (am->sw_if_index_vec_by_macip_acl, macip_acl_index);
1689 vec_add1 (am->sw_if_index_vec_by_macip_acl[macip_acl_index], sw_if_index);
1690 /* If there already a MACIP ACL applied, unapply it */
1691 if (~0 != am->macip_acl_by_sw_if_index[sw_if_index])
1692 macip_acl_interface_del_acl (am, sw_if_index);
1693 am->macip_acl_by_sw_if_index[sw_if_index] = macip_acl_index;
1695 /* Apply the classifier tables for L2 ACLs */
1697 vnet_set_input_acl_intfc (am->vlib_main, sw_if_index, a->ip4_table_index,
1698 a->ip6_table_index, a->l2_table_index, 1);
1700 vnet_set_output_acl_intfc (am->vlib_main, sw_if_index,
1701 a->out_ip4_table_index, a->out_ip6_table_index,
1702 a->out_l2_table_index, 1);
1707 macip_acl_del_list (u32 acl_list_index)
1709 acl_main_t *am = &acl_main;
1710 macip_acl_list_t *a;
1712 if (pool_is_free_index (am->macip_acls, acl_list_index))
1714 return VNET_API_ERROR_NO_SUCH_ENTRY;
1717 /* delete any references to the ACL */
1718 for (i = 0; i < vec_len (am->macip_acl_by_sw_if_index); i++)
1720 if (am->macip_acl_by_sw_if_index[i] == acl_list_index)
1722 macip_acl_interface_del_acl (am, i);
1726 /* Now that classifier tables are detached, clean them up */
1727 macip_destroy_classify_tables (am, acl_list_index);
1729 /* now we can delete the ACL itself */
1730 a = pool_elt_at_index (am->macip_acls, acl_list_index);
1733 vec_free (a->rules);
1735 pool_put (am->macip_acls, a);
1741 macip_acl_interface_add_del_acl (u32 sw_if_index, u8 is_add,
1744 acl_main_t *am = &acl_main;
1748 rv = macip_acl_interface_add_acl (am, sw_if_index, acl_list_index);
1752 rv = macip_acl_interface_del_acl (am, sw_if_index);
1758 * If the client does not allocate enough memory for a variable-length
1759 * message, and then proceed to use it as if the full memory allocated,
1760 * absent the check we happily consume that on the VPP side, and go
1761 * along as if nothing happened. However, the resulting
1762 * effects range from just garbage in the API decode
1763 * (because the decoder snoops too far), to potential memory
1766 * This verifies that the actual length of the message is
1767 * at least expected_len, and complains loudly if it is not.
1769 * A failing check here is 100% a software bug on the API user side,
1770 * so we might as well yell.
1774 verify_message_len (void *mp, u64 expected_len, char *where)
1776 u32 supplied_len = vl_msg_api_get_msg_length (mp);
1777 if (supplied_len < expected_len)
1779 clib_warning ("%s: Supplied message length %d is less than expected %d",
1780 where, supplied_len, expected_len);
1789 /* API message handler */
1791 vl_api_acl_add_replace_t_handler (vl_api_acl_add_replace_t * mp)
1793 vl_api_acl_add_replace_reply_t *rmp;
1794 acl_main_t *am = &acl_main;
1796 u32 acl_list_index = ntohl (mp->acl_index);
1797 u32 acl_count = ntohl (mp->count);
1798 u64 expected_len = sizeof (*mp) + acl_count * sizeof (mp->r[0]);
1800 if (verify_message_len (mp, expected_len, "acl_add_replace"))
1802 rv = acl_add_list (acl_count, mp->r, &acl_list_index, mp->tag);
1806 rv = VNET_API_ERROR_INVALID_VALUE;
1810 REPLY_MACRO2(VL_API_ACL_ADD_REPLACE_REPLY,
1812 rmp->acl_index = htonl(acl_list_index);
1818 vl_api_acl_del_t_handler (vl_api_acl_del_t * mp)
1820 acl_main_t *am = &acl_main;
1821 vl_api_acl_del_reply_t *rmp;
1824 rv = acl_del_list (ntohl (mp->acl_index));
1826 REPLY_MACRO (VL_API_ACL_DEL_REPLY);
1831 vl_api_acl_stats_intf_counters_enable_t_handler
1832 (vl_api_acl_stats_intf_counters_enable_t * mp)
1834 acl_main_t *am = &acl_main;
1835 vl_api_acl_stats_intf_counters_enable_reply_t *rmp;
1838 rv = acl_stats_intf_counters_enable_disable (am, mp->enable);
1840 REPLY_MACRO (VL_API_ACL_DEL_REPLY);
1845 vl_api_acl_interface_add_del_t_handler (vl_api_acl_interface_add_del_t * mp)
1847 acl_main_t *am = &acl_main;
1848 vnet_interface_main_t *im = &am->vnet_main->interface_main;
1849 u32 sw_if_index = ntohl (mp->sw_if_index);
1850 vl_api_acl_interface_add_del_reply_t *rmp;
1853 if (pool_is_free_index (im->sw_interfaces, sw_if_index))
1854 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
1857 acl_interface_add_del_inout_acl (sw_if_index, mp->is_add,
1858 mp->is_input, ntohl (mp->acl_index));
1860 REPLY_MACRO (VL_API_ACL_INTERFACE_ADD_DEL_REPLY);
1864 vl_api_acl_interface_set_acl_list_t_handler
1865 (vl_api_acl_interface_set_acl_list_t * mp)
1867 acl_main_t *am = &acl_main;
1868 vl_api_acl_interface_set_acl_list_reply_t *rmp;
1871 vnet_interface_main_t *im = &am->vnet_main->interface_main;
1872 u32 sw_if_index = ntohl (mp->sw_if_index);
1874 if (pool_is_free_index (im->sw_interfaces, sw_if_index))
1875 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
1878 int may_clear_sessions = 1;
1879 for (i = 0; i < mp->count; i++)
1881 if (acl_is_not_defined (am, ntohl (mp->acls[i])))
1883 /* ACL does not exist, so we can not apply it */
1884 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1889 u32 *in_acl_vec = 0;
1890 u32 *out_acl_vec = 0;
1891 for (i = 0; i < mp->count; i++)
1892 if (i < mp->n_input)
1893 vec_add1 (in_acl_vec, clib_net_to_host_u32 (mp->acls[i]));
1895 vec_add1 (out_acl_vec, clib_net_to_host_u32 (mp->acls[i]));
1898 acl_interface_set_inout_acl_list (am, sw_if_index, 0, out_acl_vec,
1899 &may_clear_sessions);
1901 || acl_interface_set_inout_acl_list (am, sw_if_index, 1,
1903 &may_clear_sessions);
1904 vec_free (in_acl_vec);
1905 vec_free (out_acl_vec);
1909 REPLY_MACRO (VL_API_ACL_INTERFACE_SET_ACL_LIST_REPLY);
1913 copy_acl_rule_to_api_rule (vl_api_acl_rule_t * api_rule, acl_rule_t * r)
1915 api_rule->is_permit = r->is_permit;
1916 ip_address_encode (&r->src, r->is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4,
1917 &api_rule->src_prefix.address);
1918 ip_address_encode (&r->dst, r->is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4,
1919 &api_rule->dst_prefix.address);
1920 api_rule->src_prefix.len = r->src_prefixlen;
1921 api_rule->dst_prefix.len = r->dst_prefixlen;
1922 api_rule->proto = r->proto;
1923 api_rule->srcport_or_icmptype_first = htons (r->src_port_or_type_first);
1924 api_rule->srcport_or_icmptype_last = htons (r->src_port_or_type_last);
1925 api_rule->dstport_or_icmpcode_first = htons (r->dst_port_or_code_first);
1926 api_rule->dstport_or_icmpcode_last = htons (r->dst_port_or_code_last);
1927 api_rule->tcp_flags_mask = r->tcp_flags_mask;
1928 api_rule->tcp_flags_value = r->tcp_flags_value;
1932 send_acl_details (acl_main_t * am, vl_api_registration_t * reg,
1933 acl_list_t * acl, u32 context)
1935 vl_api_acl_details_t *mp;
1936 vl_api_acl_rule_t *rules;
1938 acl_rule_t *acl_rules = acl->rules;
1939 int msg_size = sizeof (*mp) + sizeof (mp->r[0]) * vec_len (acl_rules);
1941 mp = vl_msg_api_alloc (msg_size);
1942 clib_memset (mp, 0, msg_size);
1943 mp->_vl_msg_id = ntohs (VL_API_ACL_DETAILS + am->msg_id_base);
1945 /* fill in the message */
1946 mp->context = context;
1947 mp->count = htonl (vec_len (acl_rules));
1948 mp->acl_index = htonl (acl - am->acls);
1949 snprintf ((char *) mp->tag, sizeof (mp->tag), "%s", acl->tag);
1950 // clib_memcpy (mp->r, acl->rules, acl->count * sizeof(acl->rules[0]));
1952 for (i = 0; i < vec_len (acl_rules); i++)
1954 copy_acl_rule_to_api_rule (&rules[i], &acl_rules[i]);
1957 vl_api_send_msg (reg, (u8 *) mp);
1962 vl_api_acl_dump_t_handler (vl_api_acl_dump_t * mp)
1964 acl_main_t *am = &acl_main;
1968 vl_api_registration_t *reg;
1970 reg = vl_api_client_index_to_registration (mp->client_index);
1974 if (mp->acl_index == ~0)
1977 /* Just dump all ACLs */
1978 pool_foreach (acl, am->acls)
1980 send_acl_details(am, reg, acl, mp->context);
1986 acl_index = ntohl (mp->acl_index);
1987 if (!pool_is_free_index (am->acls, acl_index))
1989 acl = pool_elt_at_index (am->acls, acl_index);
1990 send_acl_details (am, reg, acl, mp->context);
1996 /* FIXME API: should we signal an error here at all ? */
2002 send_acl_interface_list_details (acl_main_t * am,
2003 vl_api_registration_t * reg,
2004 u32 sw_if_index, u32 context)
2006 vl_api_acl_interface_list_details_t *mp;
2013 vec_validate (am->input_acl_vec_by_sw_if_index, sw_if_index);
2014 vec_validate (am->output_acl_vec_by_sw_if_index, sw_if_index);
2016 n_input = vec_len (am->input_acl_vec_by_sw_if_index[sw_if_index]);
2017 n_output = vec_len (am->output_acl_vec_by_sw_if_index[sw_if_index]);
2018 count = n_input + n_output;
2020 msg_size = sizeof (*mp);
2021 msg_size += sizeof (mp->acls[0]) * count;
2023 mp = vl_msg_api_alloc (msg_size);
2024 clib_memset (mp, 0, msg_size);
2026 ntohs (VL_API_ACL_INTERFACE_LIST_DETAILS + am->msg_id_base);
2028 /* fill in the message */
2029 mp->context = context;
2030 mp->sw_if_index = htonl (sw_if_index);
2032 mp->n_input = n_input;
2033 for (i = 0; i < n_input; i++)
2035 mp->acls[i] = htonl (am->input_acl_vec_by_sw_if_index[sw_if_index][i]);
2037 for (i = 0; i < n_output; i++)
2039 mp->acls[n_input + i] =
2040 htonl (am->output_acl_vec_by_sw_if_index[sw_if_index][i]);
2042 vl_api_send_msg (reg, (u8 *) mp);
2046 vl_api_acl_interface_list_dump_t_handler (vl_api_acl_interface_list_dump_t *
2049 acl_main_t *am = &acl_main;
2050 vnet_sw_interface_t *swif;
2051 vnet_interface_main_t *im = &am->vnet_main->interface_main;
2054 vl_api_registration_t *reg;
2056 reg = vl_api_client_index_to_registration (mp->client_index);
2060 if (mp->sw_if_index == ~0)
2063 pool_foreach (swif, im->sw_interfaces)
2065 send_acl_interface_list_details(am, reg, swif->sw_if_index, mp->context);
2071 sw_if_index = ntohl (mp->sw_if_index);
2072 if (!pool_is_free_index (im->sw_interfaces, sw_if_index))
2073 send_acl_interface_list_details (am, reg, sw_if_index, mp->context);
2077 /* MACIP ACL API handlers */
2080 vl_api_macip_acl_add_t_handler (vl_api_macip_acl_add_t * mp)
2082 vl_api_macip_acl_add_reply_t *rmp;
2083 acl_main_t *am = &acl_main;
2085 u32 acl_list_index = ~0;
2086 u32 acl_count = ntohl (mp->count);
2087 u64 expected_len = sizeof (*mp) + acl_count * sizeof (mp->r[0]);
2089 if (verify_message_len (mp, expected_len, "macip_acl_add"))
2091 rv = macip_acl_add_list (acl_count, mp->r, &acl_list_index, mp->tag);
2095 rv = VNET_API_ERROR_INVALID_VALUE;
2099 REPLY_MACRO2(VL_API_MACIP_ACL_ADD_REPLY,
2101 rmp->acl_index = htonl(acl_list_index);
2107 vl_api_macip_acl_add_replace_t_handler (vl_api_macip_acl_add_replace_t * mp)
2109 vl_api_macip_acl_add_replace_reply_t *rmp;
2110 acl_main_t *am = &acl_main;
2112 u32 acl_list_index = ntohl (mp->acl_index);
2113 u32 acl_count = ntohl (mp->count);
2114 u64 expected_len = sizeof (*mp) + acl_count * sizeof (mp->r[0]);
2116 if (verify_message_len (mp, expected_len, "macip_acl_add_replace"))
2118 rv = macip_acl_add_list (acl_count, mp->r, &acl_list_index, mp->tag);
2122 rv = VNET_API_ERROR_INVALID_VALUE;
2126 REPLY_MACRO2(VL_API_MACIP_ACL_ADD_REPLACE_REPLY,
2128 rmp->acl_index = htonl(acl_list_index);
2134 vl_api_macip_acl_del_t_handler (vl_api_macip_acl_del_t * mp)
2136 acl_main_t *am = &acl_main;
2137 vl_api_macip_acl_del_reply_t *rmp;
2140 rv = macip_acl_del_list (ntohl (mp->acl_index));
2142 REPLY_MACRO (VL_API_MACIP_ACL_DEL_REPLY);
2146 vl_api_macip_acl_interface_add_del_t_handler
2147 (vl_api_macip_acl_interface_add_del_t * mp)
2149 acl_main_t *am = &acl_main;
2150 vl_api_macip_acl_interface_add_del_reply_t *rmp;
2152 vnet_interface_main_t *im = &am->vnet_main->interface_main;
2153 u32 sw_if_index = ntohl (mp->sw_if_index);
2155 if (pool_is_free_index (im->sw_interfaces, sw_if_index))
2156 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
2159 macip_acl_interface_add_del_acl (ntohl (mp->sw_if_index), mp->is_add,
2160 ntohl (mp->acl_index));
2162 REPLY_MACRO (VL_API_MACIP_ACL_INTERFACE_ADD_DEL_REPLY);
2166 send_macip_acl_details (acl_main_t * am, vl_api_registration_t * reg,
2167 macip_acl_list_t * acl, u32 context)
2169 vl_api_macip_acl_details_t *mp;
2170 vl_api_macip_acl_rule_t *rules;
2171 macip_acl_rule_t *r;
2173 int msg_size = sizeof (*mp) + (acl ? sizeof (mp->r[0]) * acl->count : 0);
2175 mp = vl_msg_api_alloc (msg_size);
2176 clib_memset (mp, 0, msg_size);
2177 mp->_vl_msg_id = ntohs (VL_API_MACIP_ACL_DETAILS + am->msg_id_base);
2179 /* fill in the message */
2180 mp->context = context;
2183 snprintf ((char *) mp->tag, sizeof (mp->tag), "%s", acl->tag);
2184 mp->count = htonl (acl->count);
2185 mp->acl_index = htonl (acl - am->macip_acls);
2187 for (i = 0; i < acl->count; i++)
2190 rules[i].is_permit = r->is_permit;
2191 mac_address_encode ((mac_address_t *) & r->src_mac,
2193 mac_address_encode ((mac_address_t *) & r->src_mac_mask,
2194 rules[i].src_mac_mask);
2195 ip_address_encode (&r->src_ip_addr,
2196 r->is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4,
2197 &rules[i].src_prefix.address);
2198 rules[i].src_prefix.len = r->src_prefixlen;
2203 /* No martini, no party - no ACL applied to this interface. */
2208 vl_api_send_msg (reg, (u8 *) mp);
2213 vl_api_macip_acl_dump_t_handler (vl_api_macip_acl_dump_t * mp)
2215 acl_main_t *am = &acl_main;
2216 macip_acl_list_t *acl;
2218 vl_api_registration_t *reg;
2220 reg = vl_api_client_index_to_registration (mp->client_index);
2224 if (mp->acl_index == ~0)
2226 /* Just dump all ACLs for now, with sw_if_index = ~0 */
2228 pool_foreach (acl, am->macip_acls)
2230 send_macip_acl_details (am, reg, acl, mp->context);
2236 u32 acl_index = ntohl (mp->acl_index);
2237 if (!pool_is_free_index (am->macip_acls, acl_index))
2239 acl = pool_elt_at_index (am->macip_acls, acl_index);
2240 send_macip_acl_details (am, reg, acl, mp->context);
2246 vl_api_macip_acl_interface_get_t_handler (vl_api_macip_acl_interface_get_t *
2249 acl_main_t *am = &acl_main;
2250 vl_api_macip_acl_interface_get_reply_t *rmp;
2251 u32 count = vec_len (am->macip_acl_by_sw_if_index);
2252 int msg_size = sizeof (*rmp) + sizeof (rmp->acls[0]) * count;
2253 vl_api_registration_t *reg;
2256 reg = vl_api_client_index_to_registration (mp->client_index);
2260 rmp = vl_msg_api_alloc (msg_size);
2261 clib_memset (rmp, 0, msg_size);
2263 ntohs (VL_API_MACIP_ACL_INTERFACE_GET_REPLY + am->msg_id_base);
2264 rmp->context = mp->context;
2265 rmp->count = htonl (count);
2266 for (i = 0; i < count; i++)
2268 rmp->acls[i] = htonl (am->macip_acl_by_sw_if_index[i]);
2271 vl_api_send_msg (reg, (u8 *) rmp);
2275 send_macip_acl_interface_list_details (acl_main_t * am,
2276 vl_api_registration_t * reg,
2278 u32 acl_index, u32 context)
2280 vl_api_macip_acl_interface_list_details_t *rmp;
2281 /* at this time there is only ever 1 mac ip acl per interface */
2282 int msg_size = sizeof (*rmp) + sizeof (rmp->acls[0]);
2284 rmp = vl_msg_api_alloc (msg_size);
2285 clib_memset (rmp, 0, msg_size);
2287 ntohs (VL_API_MACIP_ACL_INTERFACE_LIST_DETAILS + am->msg_id_base);
2289 /* fill in the message */
2290 rmp->context = context;
2292 rmp->sw_if_index = htonl (sw_if_index);
2293 rmp->acls[0] = htonl (acl_index);
2295 vl_api_send_msg (reg, (u8 *) rmp);
2299 vl_api_macip_acl_interface_list_dump_t_handler
2300 (vl_api_macip_acl_interface_list_dump_t * mp)
2302 vl_api_registration_t *reg;
2303 acl_main_t *am = &acl_main;
2304 u32 sw_if_index = ntohl (mp->sw_if_index);
2306 reg = vl_api_client_index_to_registration (mp->client_index);
2310 if (sw_if_index == ~0)
2312 vec_foreach_index (sw_if_index, am->macip_acl_by_sw_if_index)
2314 if (~0 != am->macip_acl_by_sw_if_index[sw_if_index])
2316 send_macip_acl_interface_list_details (am, reg, sw_if_index,
2318 macip_acl_by_sw_if_index
2326 if (vec_len (am->macip_acl_by_sw_if_index) > sw_if_index)
2328 send_macip_acl_interface_list_details (am, reg, sw_if_index,
2329 am->macip_acl_by_sw_if_index
2330 [sw_if_index], mp->context);
2336 vl_api_acl_interface_set_etype_whitelist_t_handler
2337 (vl_api_acl_interface_set_etype_whitelist_t * mp)
2339 acl_main_t *am = &acl_main;
2340 vl_api_acl_interface_set_etype_whitelist_reply_t *rmp;
2343 vnet_interface_main_t *im = &am->vnet_main->interface_main;
2344 u32 sw_if_index = ntohl (mp->sw_if_index);
2345 u16 *vec_in = 0, *vec_out = 0;
2347 if (pool_is_free_index (im->sw_interfaces, sw_if_index))
2348 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
2351 for (i = 0; i < mp->count; i++)
2353 if (i < mp->n_input)
2354 vec_add1 (vec_in, ntohs (mp->whitelist[i]));
2356 vec_add1 (vec_out, ntohs (mp->whitelist[i]));
2358 rv = acl_set_etype_whitelists (am, sw_if_index, vec_in, vec_out);
2361 REPLY_MACRO (VL_API_ACL_INTERFACE_SET_ETYPE_WHITELIST_REPLY);
2365 send_acl_interface_etype_whitelist_details (acl_main_t * am,
2366 vl_api_registration_t * reg,
2367 u32 sw_if_index, u32 context)
2369 vl_api_acl_interface_etype_whitelist_details_t *mp;
2376 u16 *whitelist_in = 0;
2377 u16 *whitelist_out = 0;
2379 if (intf_has_etype_whitelist (am, sw_if_index, 0))
2381 vec_elt (am->output_etype_whitelist_by_sw_if_index, sw_if_index);
2383 if (intf_has_etype_whitelist (am, sw_if_index, 1))
2385 vec_elt (am->input_etype_whitelist_by_sw_if_index, sw_if_index);
2387 if ((0 == whitelist_in) && (0 == whitelist_out))
2388 return; /* nothing to do */
2390 n_input = vec_len (whitelist_in);
2391 n_output = vec_len (whitelist_out);
2392 count = n_input + n_output;
2394 msg_size = sizeof (*mp);
2395 msg_size += sizeof (mp->whitelist[0]) * count;
2397 mp = vl_msg_api_alloc (msg_size);
2398 clib_memset (mp, 0, msg_size);
2400 ntohs (VL_API_ACL_INTERFACE_ETYPE_WHITELIST_DETAILS + am->msg_id_base);
2402 /* fill in the message */
2403 mp->context = context;
2404 mp->sw_if_index = htonl (sw_if_index);
2406 mp->n_input = n_input;
2407 for (i = 0; i < n_input; i++)
2409 mp->whitelist[i] = htons (whitelist_in[i]);
2411 for (i = 0; i < n_output; i++)
2413 mp->whitelist[n_input + i] = htons (whitelist_out[i]);
2415 vl_api_send_msg (reg, (u8 *) mp);
2420 vl_api_acl_interface_etype_whitelist_dump_t_handler
2421 (vl_api_acl_interface_list_dump_t * mp)
2423 acl_main_t *am = &acl_main;
2424 vnet_sw_interface_t *swif;
2425 vnet_interface_main_t *im = &am->vnet_main->interface_main;
2428 vl_api_registration_t *reg;
2430 reg = vl_api_client_index_to_registration (mp->client_index);
2434 if (mp->sw_if_index == ~0)
2437 pool_foreach (swif, im->sw_interfaces)
2439 send_acl_interface_etype_whitelist_details(am, reg, swif->sw_if_index, mp->context);
2445 sw_if_index = ntohl (mp->sw_if_index);
2446 if (!pool_is_free_index (im->sw_interfaces, sw_if_index))
2447 send_acl_interface_etype_whitelist_details (am, reg, sw_if_index,
2453 vl_api_acl_plugin_use_hash_lookup_set_t_handler (
2454 vl_api_acl_plugin_use_hash_lookup_set_t *mp)
2456 acl_main_t *am = &acl_main;
2457 vl_api_acl_plugin_use_hash_lookup_set_reply_t *rmp;
2458 vl_api_registration_t *reg;
2461 reg = vl_api_client_index_to_registration (mp->client_index);
2465 am->use_hash_acl_matching = mp->enable;
2466 REPLY_MACRO (VL_API_ACL_PLUGIN_USE_HASH_LOOKUP_SET_REPLY);
2470 vl_api_acl_plugin_use_hash_lookup_get_t_handler (
2471 vl_api_acl_plugin_use_hash_lookup_get_t *mp)
2473 acl_main_t *am = &acl_main;
2474 vl_api_acl_plugin_use_hash_lookup_get_reply_t *rmp;
2475 int msg_size = sizeof (*rmp);
2476 vl_api_registration_t *reg;
2478 reg = vl_api_client_index_to_registration (mp->client_index);
2482 rmp = vl_msg_api_alloc (msg_size);
2483 clib_memset (rmp, 0, msg_size);
2485 ntohs (VL_API_ACL_PLUGIN_USE_HASH_LOOKUP_GET_REPLY + am->msg_id_base);
2486 rmp->context = mp->context;
2487 rmp->enable = am->use_hash_acl_matching;
2488 vl_api_send_msg (reg, (u8 *) rmp);
2492 acl_set_timeout_sec (int timeout_type, u32 value)
2494 acl_main_t *am = &acl_main;
2495 clib_time_t *ct = &am->vlib_main->clib_time;
2497 if (timeout_type < ACL_N_TIMEOUTS)
2499 am->session_timeout_sec[timeout_type] = value;
2503 clib_warning ("Unknown timeout type %d", timeout_type);
2506 am->session_timeout[timeout_type] =
2507 (u64) (((f64) value) / ct->seconds_per_clock);
2511 acl_set_session_max_entries (u32 value)
2513 acl_main_t *am = &acl_main;
2514 am->fa_conn_table_max_entries = value;
2518 acl_set_skip_ipv6_eh (u32 eh, u32 value)
2520 acl_main_t *am = &acl_main;
2522 if ((eh < 256) && (value < 2))
2524 am->fa_ipv6_known_eh_bitmap =
2525 clib_bitmap_set (am->fa_ipv6_known_eh_bitmap, eh, value);
2533 static clib_error_t *
2534 acl_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
2536 acl_main_t *am = &acl_main;
2539 int may_clear_sessions = 1;
2540 vlib_process_signal_event (am->vlib_main, am->fa_cleaner_node_index,
2541 ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX,
2543 /* also unapply any ACLs in case the users did not do so. */
2544 macip_acl_interface_del_acl (am, sw_if_index);
2545 acl_interface_reset_inout_acls (sw_if_index, 0, &may_clear_sessions);
2546 acl_interface_reset_inout_acls (sw_if_index, 1, &may_clear_sessions);
2551 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (acl_sw_interface_add_del);
2555 static clib_error_t *
2556 acl_set_aclplugin_fn (vlib_main_t * vm,
2557 unformat_input_t * input, vlib_cli_command_t * cmd)
2559 clib_error_t *error = 0;
2563 uword memory_size = 0;
2564 acl_main_t *am = &acl_main;
2566 if (unformat (input, "skip-ipv6-extension-header %u %u", &eh_val, &val))
2568 if (!acl_set_skip_ipv6_eh (eh_val, val))
2570 error = clib_error_return (0, "expecting eh=0..255, value=0..1");
2574 if (unformat (input, "use-hash-acl-matching %u", &val))
2576 am->use_hash_acl_matching = (val != 0);
2579 if (unformat (input, "l4-match-nonfirst-fragment %u", &val))
2581 am->l4_match_nonfirst_fragment = (val != 0);
2584 if (unformat (input, "reclassify-sessions %u", &val))
2586 am->reclassify_sessions = (val != 0);
2589 if (unformat (input, "event-trace"))
2591 if (!unformat (input, "%u", &val))
2593 error = clib_error_return (0,
2594 "expecting trace level, got `%U`",
2595 format_unformat_error, input);
2600 am->trace_acl = val;
2604 if (unformat (input, "heap"))
2606 if (unformat (input, "main"))
2608 if (unformat (input, "validate %u", &val))
2609 clib_warning ("ACL local heap is deprecated");
2610 else if (unformat (input, "trace %u", &val))
2611 clib_warning ("ACL local heap is deprecated");
2614 else if (unformat (input, "hash"))
2616 if (unformat (input, "validate %u", &val))
2617 clib_warning ("ACL local heap is deprecated");
2618 else if (unformat (input, "trace %u", &val))
2619 clib_warning ("ACL local heap is deprecated");
2624 if (unformat (input, "session"))
2626 if (unformat (input, "table"))
2628 /* The commands here are for tuning/testing. No user-serviceable parts inside */
2629 if (unformat (input, "max-entries"))
2631 if (!unformat (input, "%u", &val))
2633 error = clib_error_return (0,
2634 "expecting maximum number of entries, got `%U`",
2635 format_unformat_error, input);
2640 acl_set_session_max_entries (val);
2644 if (unformat (input, "hash-table-buckets"))
2646 if (!unformat (input, "%u", &val))
2648 error = clib_error_return (0,
2649 "expecting maximum number of hash table buckets, got `%U`",
2650 format_unformat_error, input);
2655 am->fa_conn_table_hash_num_buckets = val;
2659 if (unformat (input, "hash-table-memory"))
2661 if (!unformat (input, "%U", unformat_memory_size, &memory_size))
2663 error = clib_error_return (0,
2664 "expecting maximum amount of hash table memory, got `%U`",
2665 format_unformat_error, input);
2670 am->fa_conn_table_hash_memory_size = memory_size;
2674 if (unformat (input, "event-trace"))
2676 if (!unformat (input, "%u", &val))
2678 error = clib_error_return (0,
2679 "expecting trace level, got `%U`",
2680 format_unformat_error, input);
2685 am->trace_sessions = val;
2691 if (unformat (input, "timeout"))
2693 if (unformat (input, "udp"))
2695 if (unformat (input, "idle"))
2697 if (!unformat (input, "%u", &timeout))
2699 error = clib_error_return (0,
2700 "expecting timeout value in seconds, got `%U`",
2701 format_unformat_error,
2707 acl_set_timeout_sec (ACL_TIMEOUT_UDP_IDLE, timeout);
2712 if (unformat (input, "tcp"))
2714 if (unformat (input, "idle"))
2716 if (!unformat (input, "%u", &timeout))
2718 error = clib_error_return (0,
2719 "expecting timeout value in seconds, got `%U`",
2720 format_unformat_error,
2726 acl_set_timeout_sec (ACL_TIMEOUT_TCP_IDLE, timeout);
2730 if (unformat (input, "transient"))
2732 if (!unformat (input, "%u", &timeout))
2734 error = clib_error_return (0,
2735 "expecting timeout value in seconds, got `%U`",
2736 format_unformat_error,
2742 acl_set_timeout_sec (ACL_TIMEOUT_TCP_TRANSIENT,
2756 my_format_mac_address (u8 * s, va_list * args)
2758 u8 *a = va_arg (*args, u8 *);
2759 return format (s, "%02x:%02x:%02x:%02x:%02x:%02x",
2760 a[0], a[1], a[2], a[3], a[4], a[5]);
2764 my_macip_acl_rule_t_pretty_format (u8 * out, va_list * args)
2766 macip_acl_rule_t *a = va_arg (*args, macip_acl_rule_t *);
2768 out = format (out, "%s action %d ip %U/%d mac %U mask %U",
2769 a->is_ipv6 ? "ipv6" : "ipv4", a->is_permit,
2770 format_ip46_address, &a->src_ip_addr,
2771 a->is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4,
2773 my_format_mac_address, a->src_mac,
2774 my_format_mac_address, a->src_mac_mask);
2779 macip_acl_print (acl_main_t * am, u32 macip_acl_index)
2781 vlib_main_t *vm = am->vlib_main;
2784 /* Don't try to print someone else's memory */
2785 if (macip_acl_index >= vec_len (am->macip_acls))
2788 macip_acl_list_t *a = vec_elt_at_index (am->macip_acls, macip_acl_index);
2789 int free_pool_slot = pool_is_free_index (am->macip_acls, macip_acl_index);
2791 vlib_cli_output (vm,
2792 "MACIP acl_index: %d, count: %d (true len %d) tag {%s} is free pool slot: %d\n",
2793 macip_acl_index, a->count, vec_len (a->rules), a->tag,
2795 vlib_cli_output (vm,
2796 " ip4_table_index %d, ip6_table_index %d, l2_table_index %d\n",
2797 a->ip4_table_index, a->ip6_table_index, a->l2_table_index);
2798 vlib_cli_output (vm,
2799 " out_ip4_table_index %d, out_ip6_table_index %d, out_l2_table_index %d\n",
2800 a->out_ip4_table_index, a->out_ip6_table_index,
2801 a->out_l2_table_index);
2802 for (i = 0; i < vec_len (a->rules); i++)
2803 vlib_cli_output (vm, " rule %d: %U\n", i,
2804 my_macip_acl_rule_t_pretty_format,
2805 vec_elt_at_index (a->rules, i));
2809 static clib_error_t *
2810 acl_set_aclplugin_interface_fn (vlib_main_t * vm,
2811 unformat_input_t * input,
2812 vlib_cli_command_t * cmd)
2814 unformat_input_t _line_input, *line_input = &_line_input;
2815 u32 sw_if_index, is_add, is_input, acl_index;
2817 is_add = is_input = 1;
2818 acl_index = sw_if_index = ~0;
2820 if (!unformat_user (input, unformat_line_input, line_input))
2823 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2825 if (unformat (line_input, "%U",
2826 unformat_vnet_sw_interface, vnet_get_main (),
2829 else if (unformat (line_input, "add"))
2831 else if (unformat (line_input, "del"))
2833 else if (unformat (line_input, "acl %d", &acl_index))
2835 else if (unformat (line_input, "input"))
2837 else if (unformat (line_input, "output"))
2843 if (~0 == sw_if_index)
2844 return (clib_error_return (0, "invalid interface"));
2845 if (~0 == acl_index)
2846 return (clib_error_return (0, "invalid acl"));
2848 acl_interface_add_del_inout_acl (sw_if_index, is_add, is_input, acl_index);
2850 unformat_free (line_input);
2854 #define vec_validate_acl_rules(v, idx) \
2856 if (vec_len(v) < idx+1) { \
2857 vec_validate(v, idx); \
2858 v[idx].is_permit = 0x1; \
2859 v[idx].srcport_or_icmptype_last = 0xffff; \
2860 v[idx].dstport_or_icmpcode_last = 0xffff; \
2864 static clib_error_t *
2865 acl_set_aclplugin_acl_fn (vlib_main_t * vm,
2866 unformat_input_t * input, vlib_cli_command_t * cmd)
2868 unformat_input_t _line_input, *line_input = &_line_input;
2869 vl_api_acl_rule_t *rules = 0;
2872 int n_rules_override = -1;
2877 u32 tcpflags, tcpmask;
2878 ip_prefix_t src, dst;
2881 if (!unformat_user (input, unformat_line_input, line_input))
2884 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2886 if (unformat (line_input, "permit+reflect"))
2888 vec_validate_acl_rules (rules, rule_idx);
2889 rules[rule_idx].is_permit = 2;
2891 else if (unformat (line_input, "permit"))
2893 vec_validate_acl_rules (rules, rule_idx);
2894 rules[rule_idx].is_permit = 1;
2896 else if (unformat (line_input, "deny"))
2898 vec_validate_acl_rules (rules, rule_idx);
2899 rules[rule_idx].is_permit = 0;
2901 else if (unformat (line_input, "count %d", &n_rules_override))
2903 /* we will use this later */
2905 else if (unformat (line_input, "action %d", &action))
2907 vec_validate_acl_rules (rules, rule_idx);
2908 rules[rule_idx].is_permit = action;
2910 else if (unformat (line_input, "src %U", unformat_ip_prefix, &src))
2912 vec_validate_acl_rules (rules, rule_idx);
2913 ip_prefix_encode2 (&src, &rules[rule_idx].src_prefix);
2915 else if (unformat (line_input, "dst %U", unformat_ip_prefix, &dst))
2917 vec_validate_acl_rules (rules, rule_idx);
2918 ip_prefix_encode2 (&dst, &rules[rule_idx].dst_prefix);
2920 else if (unformat (line_input, "sport %d-%d", &port1, &port2))
2922 vec_validate_acl_rules (rules, rule_idx);
2923 rules[rule_idx].srcport_or_icmptype_first = htons (port1);
2924 rules[rule_idx].srcport_or_icmptype_last = htons (port2);
2926 else if (unformat (line_input, "sport %d", &port1))
2928 vec_validate_acl_rules (rules, rule_idx);
2929 rules[rule_idx].srcport_or_icmptype_first = htons (port1);
2930 rules[rule_idx].srcport_or_icmptype_last = htons (port1);
2932 else if (unformat (line_input, "dport %d-%d", &port1, &port2))
2934 vec_validate_acl_rules (rules, rule_idx);
2935 rules[rule_idx].dstport_or_icmpcode_first = htons (port1);
2936 rules[rule_idx].dstport_or_icmpcode_last = htons (port2);
2938 else if (unformat (line_input, "dport %d", &port1))
2940 vec_validate_acl_rules (rules, rule_idx);
2941 rules[rule_idx].dstport_or_icmpcode_first = htons (port1);
2942 rules[rule_idx].dstport_or_icmpcode_last = htons (port1);
2944 else if (unformat (line_input, "tcpflags %d %d", &tcpflags, &tcpmask))
2946 vec_validate_acl_rules (rules, rule_idx);
2947 rules[rule_idx].tcp_flags_value = tcpflags;
2948 rules[rule_idx].tcp_flags_mask = tcpmask;
2951 if (unformat (line_input, "tcpflags %d mask %d", &tcpflags, &tcpmask))
2953 vec_validate_acl_rules (rules, rule_idx);
2954 rules[rule_idx].tcp_flags_value = tcpflags;
2955 rules[rule_idx].tcp_flags_mask = tcpmask;
2957 else if (unformat (line_input, "proto %d", &proto))
2959 vec_validate_acl_rules (rules, rule_idx);
2960 rules[rule_idx].proto = proto;
2962 else if (unformat (line_input, "tag %s", &tag))
2965 else if (unformat (line_input, ","))
2968 vec_validate_acl_rules (rules, rule_idx);
2976 vec_add (tag, "cli", 4);
2978 rv = acl_add_list (vec_len (rules), rules, &acl_index, tag);
2984 return (clib_error_return (0, "failed"));
2986 vlib_cli_output (vm, "ACL index:%d", acl_index);
2991 static clib_error_t *
2992 acl_show_aclplugin_macip_acl_fn (vlib_main_t * vm,
2994 input, vlib_cli_command_t * cmd)
2996 clib_error_t *error = 0;
2997 acl_main_t *am = &acl_main;
3001 (void) unformat (input, "index %u", &acl_index);
3003 for (i = 0; i < vec_len (am->macip_acls); i++)
3005 /* Don't attempt to show the ACLs that do not exist */
3006 if (pool_is_free_index (am->macip_acls, i))
3009 if ((acl_index != ~0) && (acl_index != i))
3014 macip_acl_print (am, i);
3015 if (i < vec_len (am->sw_if_index_vec_by_macip_acl))
3017 vlib_cli_output (vm, " applied on sw_if_index(s): %U\n",
3019 vec_elt (am->sw_if_index_vec_by_macip_acl, i),
3027 static clib_error_t *
3028 acl_show_aclplugin_macip_interface_fn (vlib_main_t * vm,
3030 input, vlib_cli_command_t * cmd)
3032 clib_error_t *error = 0;
3033 acl_main_t *am = &acl_main;
3035 for (i = 0; i < vec_len (am->macip_acl_by_sw_if_index); i++)
3037 vlib_cli_output (vm, " sw_if_index %d: %d\n", i,
3038 vec_elt (am->macip_acl_by_sw_if_index, i));
3044 acl_plugin_show_acl (acl_main_t * am, u32 acl_index)
3047 vlib_main_t *vm = am->vlib_main;
3049 for (i = 0; i < vec_len (am->acls); i++)
3051 if (acl_is_not_defined (am, i))
3053 /* don't attempt to show the ACLs that do not exist */
3056 if ((acl_index != ~0) && (acl_index != i))
3060 acl_print_acl (vm, am, i);
3062 if (i < vec_len (am->input_sw_if_index_vec_by_acl))
3064 vlib_cli_output (vm, " applied inbound on sw_if_index: %U\n",
3065 format_vec32, am->input_sw_if_index_vec_by_acl[i],
3068 if (i < vec_len (am->output_sw_if_index_vec_by_acl))
3070 vlib_cli_output (vm, " applied outbound on sw_if_index: %U\n",
3071 format_vec32, am->output_sw_if_index_vec_by_acl[i],
3074 if (i < vec_len (am->lc_index_vec_by_acl))
3076 vlib_cli_output (vm, " used in lookup context index: %U\n",
3077 format_vec32, am->lc_index_vec_by_acl[i], "%d");
3082 static clib_error_t *
3083 acl_show_aclplugin_acl_fn (vlib_main_t * vm,
3084 unformat_input_t * input, vlib_cli_command_t * cmd)
3086 clib_error_t *error = 0;
3087 acl_main_t *am = &acl_main;
3090 (void) unformat (input, "index %u", &acl_index);
3092 acl_plugin_show_acl (am, acl_index);
3096 static clib_error_t *
3097 acl_show_aclplugin_lookup_context_fn (vlib_main_t * vm,
3098 unformat_input_t * input,
3099 vlib_cli_command_t * cmd)
3101 clib_error_t *error = 0;
3104 (void) unformat (input, "index %u", &lc_index);
3106 acl_plugin_show_lookup_context (lc_index);
3110 static clib_error_t *
3111 acl_show_aclplugin_lookup_user_fn (vlib_main_t * vm,
3112 unformat_input_t * input,
3113 vlib_cli_command_t * cmd)
3115 clib_error_t *error = 0;
3118 (void) unformat (input, "index %u", &lc_index);
3120 acl_plugin_show_lookup_user (lc_index);
3126 acl_plugin_show_interface (acl_main_t * am, u32 sw_if_index, int show_acl,
3129 vlib_main_t *vm = am->vlib_main;
3132 for (swi = 0; (swi < vec_len (am->input_acl_vec_by_sw_if_index)) ||
3133 (swi < vec_len (am->output_acl_vec_by_sw_if_index)); swi++)
3135 /* if we need a particular interface, skip all the others */
3136 if ((sw_if_index != ~0) && (sw_if_index != swi))
3139 vlib_cli_output (vm, "sw_if_index %d:\n", swi);
3140 if (swi < vec_len (am->input_policy_epoch_by_sw_if_index))
3141 vlib_cli_output (vm, " input policy epoch: %x\n",
3142 vec_elt (am->input_policy_epoch_by_sw_if_index,
3144 if (swi < vec_len (am->output_policy_epoch_by_sw_if_index))
3145 vlib_cli_output (vm, " output policy epoch: %x\n",
3146 vec_elt (am->output_policy_epoch_by_sw_if_index,
3150 if (intf_has_etype_whitelist (am, swi, 1))
3152 vlib_cli_output (vm, " input etype whitelist: %U", format_vec16,
3153 am->input_etype_whitelist_by_sw_if_index[swi],
3156 if (intf_has_etype_whitelist (am, swi, 0))
3158 vlib_cli_output (vm, " output etype whitelist: %U", format_vec16,
3159 am->output_etype_whitelist_by_sw_if_index[swi],
3163 if ((swi < vec_len (am->input_acl_vec_by_sw_if_index)) &&
3164 (vec_len (am->input_acl_vec_by_sw_if_index[swi]) > 0))
3166 vlib_cli_output (vm, " input acl(s): %U", format_vec32,
3167 am->input_acl_vec_by_sw_if_index[swi], "%d");
3170 vlib_cli_output (vm, "\n");
3171 vec_foreach (pj, am->input_acl_vec_by_sw_if_index[swi])
3173 acl_print_acl (vm, am, *pj);
3175 vlib_cli_output (vm, "\n");
3179 if ((swi < vec_len (am->output_acl_vec_by_sw_if_index)) &&
3180 (vec_len (am->output_acl_vec_by_sw_if_index[swi]) > 0))
3182 vlib_cli_output (vm, " output acl(s): %U", format_vec32,
3183 am->output_acl_vec_by_sw_if_index[swi], "%d");
3186 vlib_cli_output (vm, "\n");
3187 vec_foreach (pj, am->output_acl_vec_by_sw_if_index[swi])
3189 acl_print_acl (vm, am, *pj);
3191 vlib_cli_output (vm, "\n");
3194 if (detail && (swi < vec_len (am->input_lc_index_by_sw_if_index)))
3196 vlib_cli_output (vm, " input lookup context index: %d",
3197 am->input_lc_index_by_sw_if_index[swi]);
3199 if (detail && (swi < vec_len (am->output_lc_index_by_sw_if_index)))
3201 vlib_cli_output (vm, " output lookup context index: %d",
3202 am->output_lc_index_by_sw_if_index[swi]);
3209 static clib_error_t *
3210 acl_show_aclplugin_decode_5tuple_fn (vlib_main_t * vm,
3211 unformat_input_t * input,
3212 vlib_cli_command_t * cmd)
3214 clib_error_t *error = 0;
3215 u64 five_tuple[6] = { 0, 0, 0, 0, 0, 0 };
3218 (input, "%llx %llx %llx %llx %llx %llx", &five_tuple[0], &five_tuple[1],
3219 &five_tuple[2], &five_tuple[3], &five_tuple[4], &five_tuple[5]))
3220 vlib_cli_output (vm, "5-tuple structure decode: %U\n\n",
3221 format_acl_plugin_5tuple, five_tuple);
3223 error = clib_error_return (0, "expecting 6 hex integers");
3228 static clib_error_t *
3229 acl_show_aclplugin_interface_fn (vlib_main_t * vm,
3231 input, vlib_cli_command_t * cmd)
3233 clib_error_t *error = 0;
3234 acl_main_t *am = &acl_main;
3236 u32 sw_if_index = ~0;
3237 (void) unformat (input, "sw_if_index %u", &sw_if_index);
3238 int show_acl = unformat (input, "acl");
3239 int detail = unformat (input, "detail");
3241 acl_plugin_show_interface (am, sw_if_index, show_acl, detail);
3245 static clib_error_t *
3246 acl_show_aclplugin_memory_fn (vlib_main_t * vm,
3247 unformat_input_t * input,
3248 vlib_cli_command_t * cmd)
3250 clib_error_t *error = 0;
3251 vlib_cli_output (vm, "ACL memory is now part of the main heap");
3256 acl_plugin_show_sessions (acl_main_t * am,
3257 u32 show_session_thread_id,
3258 u32 show_session_session_index)
3260 vlib_main_t *vm = am->vlib_main;
3262 vnet_interface_main_t *im = &am->vnet_main->interface_main;
3263 vnet_sw_interface_t *swif;
3264 u64 now = clib_cpu_time_now ();
3265 u64 clocks_per_second = am->vlib_main->clib_time.clocks_per_second;
3268 u64 n_adds = am->fa_session_total_adds;
3269 u64 n_dels = am->fa_session_total_dels;
3270 u64 n_deact = am->fa_session_total_deactivations;
3271 vlib_cli_output (vm, "Sessions total: add %lu - del %lu = %lu", n_adds,
3272 n_dels, n_adds - n_dels);
3273 vlib_cli_output (vm, "Sessions active: add %lu - deact %lu = %lu", n_adds,
3274 n_deact, n_adds - n_deact);
3275 vlib_cli_output (vm, "Sessions being purged: deact %lu - del %lu = %lu",
3276 n_deact, n_dels, n_deact - n_dels);
3278 vlib_cli_output (vm, "now: %lu clocks per second: %lu", now,
3280 vlib_cli_output (vm, "\n\nPer-thread data:");
3281 for (wk = 0; wk < vec_len (am->per_worker_data); wk++)
3283 acl_fa_per_worker_data_t *pw = &am->per_worker_data[wk];
3284 vlib_cli_output (vm, "Thread #%d:", wk);
3285 if (show_session_thread_id == wk
3286 && show_session_session_index < pool_len (pw->fa_sessions_pool))
3288 vlib_cli_output (vm, " session index %u:",
3289 show_session_session_index);
3290 fa_session_t *sess =
3291 pw->fa_sessions_pool + show_session_session_index;
3292 u64 *m = (u64 *) & sess->info;
3293 vlib_cli_output (vm,
3294 " info: %016llx %016llx %016llx %016llx %016llx %016llx",
3295 m[0], m[1], m[2], m[3], m[4], m[5]);
3296 vlib_cli_output (vm, " sw_if_index: %u", sess->sw_if_index);
3297 vlib_cli_output (vm, " tcp_flags_seen: %x",
3298 sess->tcp_flags_seen.as_u16);
3299 vlib_cli_output (vm, " last active time: %lu",
3300 sess->last_active_time);
3301 vlib_cli_output (vm, " thread index: %u", sess->thread_index);
3302 vlib_cli_output (vm, " link enqueue time: %lu",
3303 sess->link_enqueue_time);
3304 vlib_cli_output (vm, " link next index: %u",
3305 sess->link_next_idx);
3306 vlib_cli_output (vm, " link prev index: %u",
3307 sess->link_prev_idx);
3308 vlib_cli_output (vm, " link list id: %u", sess->link_list_id);
3310 vlib_cli_output (vm, " connection add/del stats:", wk);
3312 pool_foreach (swif, im->sw_interfaces)
3314 u32 sw_if_index = swif->sw_if_index;
3316 (sw_if_index < vec_len (pw->fa_session_adds_by_sw_if_index) ?
3317 pw->fa_session_adds_by_sw_if_index[sw_if_index] :
3320 (sw_if_index < vec_len (pw->fa_session_dels_by_sw_if_index) ?
3321 pw->fa_session_dels_by_sw_if_index[sw_if_index] :
3323 u64 n_epoch_changes =
3324 (sw_if_index < vec_len (pw->fa_session_epoch_change_by_sw_if_index) ?
3325 pw->fa_session_epoch_change_by_sw_if_index[sw_if_index] :
3327 vlib_cli_output (vm,
3328 " sw_if_index %d: add %lu - del %lu = %lu; epoch chg: %lu",
3338 vlib_cli_output (vm, " connection timeout type lists:", wk);
3340 for (tt = 0; tt < ACL_N_TIMEOUTS; tt++)
3342 u32 head_session_index = pw->fa_conn_list_head[tt];
3343 vlib_cli_output (vm, " fa_conn_list_head[%d]: %d", tt,
3344 head_session_index);
3345 if (~0 != head_session_index)
3347 fa_session_t *sess = pw->fa_sessions_pool + head_session_index;
3348 vlib_cli_output (vm, " last active time: %lu",
3349 sess->last_active_time);
3350 vlib_cli_output (vm, " link enqueue time: %lu",
3351 sess->link_enqueue_time);
3355 vlib_cli_output (vm, " Next expiry time: %lu", pw->next_expiry_time);
3356 vlib_cli_output (vm, " Requeue until time: %lu",
3357 pw->requeue_until_time);
3358 vlib_cli_output (vm, " Current time wait interval: %lu",
3359 pw->current_time_wait_interval);
3360 vlib_cli_output (vm, " Count of deleted sessions: %lu",
3361 pw->cnt_deleted_sessions);
3362 vlib_cli_output (vm, " Delete already deleted: %lu",
3363 pw->cnt_already_deleted_sessions);
3364 vlib_cli_output (vm, " Session timers restarted: %lu",
3365 pw->cnt_session_timer_restarted);
3366 vlib_cli_output (vm, " Swipe until this time: %lu",
3367 pw->swipe_end_time);
3368 vlib_cli_output (vm, " sw_if_index serviced bitmap: %U",
3369 format_bitmap_hex, pw->serviced_sw_if_index_bitmap);
3370 vlib_cli_output (vm, " pending clear intfc bitmap : %U",
3372 pw->pending_clear_sw_if_index_bitmap);
3373 vlib_cli_output (vm, " clear in progress: %u", pw->clear_in_process);
3374 vlib_cli_output (vm, " interrupt is pending: %d",
3375 pw->interrupt_is_pending);
3376 vlib_cli_output (vm, " interrupt is needed: %d",
3377 pw->interrupt_is_needed);
3378 vlib_cli_output (vm, " interrupt is unwanted: %d",
3379 pw->interrupt_is_unwanted);
3380 vlib_cli_output (vm, " interrupt generation: %d",
3381 pw->interrupt_generation);
3382 vlib_cli_output (vm, " received session change requests: %d",
3383 pw->rcvd_session_change_requests);
3384 vlib_cli_output (vm, " sent session change requests: %d",
3385 pw->sent_session_change_requests);
3387 vlib_cli_output (vm, "\n\nConn cleaner thread counters:");
3388 #define _(cnt, desc) vlib_cli_output(vm, " %20lu: %s", am->cnt, desc);
3389 foreach_fa_cleaner_counter;
3391 vlib_cli_output (vm, "Interrupt generation: %d",
3392 am->fa_interrupt_generation);
3393 vlib_cli_output (vm,
3394 "Sessions per interval: min %lu max %lu increment: %f ms current: %f ms",
3395 am->fa_min_deleted_sessions_per_interval,
3396 am->fa_max_deleted_sessions_per_interval,
3397 am->fa_cleaner_wait_time_increment * 1000.0,
3398 ((f64) am->fa_current_cleaner_timer_wait_interval) *
3399 1000.0 / (f64) vm->clib_time.clocks_per_second);
3400 vlib_cli_output (vm, "Reclassify sessions: %d", am->reclassify_sessions);
3403 static clib_error_t *
3404 acl_show_aclplugin_sessions_fn (vlib_main_t * vm,
3405 unformat_input_t * input,
3406 vlib_cli_command_t * cmd)
3408 clib_error_t *error = 0;
3409 acl_main_t *am = &acl_main;
3411 u32 show_bihash_verbose = 0;
3412 u32 show_session_thread_id = ~0;
3413 u32 show_session_session_index = ~0;
3414 (void) unformat (input, "thread %u index %u", &show_session_thread_id,
3415 &show_session_session_index);
3416 (void) unformat (input, "verbose %u", &show_bihash_verbose);
3418 acl_plugin_show_sessions (am, show_session_thread_id,
3419 show_session_session_index);
3420 show_fa_sessions_hash (vm, show_bihash_verbose);
3424 static clib_error_t *
3425 acl_show_aclplugin_tables_fn (vlib_main_t * vm,
3426 unformat_input_t * input,
3427 vlib_cli_command_t * cmd)
3429 clib_error_t *error = 0;
3433 int show_acl_hash_info = 0;
3434 int show_applied_info = 0;
3435 int show_mask_type = 0;
3436 int show_bihash = 0;
3437 u32 show_bihash_verbose = 0;
3439 if (unformat (input, "acl"))
3441 show_acl_hash_info = 1;
3442 /* mask-type is handy to see as well right there */
3444 unformat (input, "index %u", &acl_index);
3446 else if (unformat (input, "applied"))
3448 show_applied_info = 1;
3449 unformat (input, "lc_index %u", &lc_index);
3451 else if (unformat (input, "mask"))
3455 else if (unformat (input, "hash"))
3458 unformat (input, "verbose %u", &show_bihash_verbose);
3462 (show_mask_type || show_acl_hash_info || show_applied_info
3465 /* if no qualifiers specified, show all */
3467 show_acl_hash_info = 1;
3468 show_applied_info = 1;
3471 vlib_cli_output (vm, "Stats counters enabled for interface ACLs: %d",
3472 acl_main.interface_acl_counters_enabled);
3473 vlib_cli_output (vm, "Use hash-based lookup for ACLs: %d",
3474 acl_main.use_hash_acl_matching);
3476 acl_plugin_show_tables_mask_type ();
3477 if (show_acl_hash_info)
3478 acl_plugin_show_tables_acl_hash_info (acl_index);
3479 if (show_applied_info)
3480 acl_plugin_show_tables_applied_info (lc_index);
3482 acl_plugin_show_tables_bihash (show_bihash_verbose);
3487 static clib_error_t *
3488 acl_clear_aclplugin_fn (vlib_main_t * vm,
3489 unformat_input_t * input, vlib_cli_command_t * cmd)
3491 clib_error_t *error = 0;
3492 acl_main_t *am = &acl_main;
3493 vlib_process_signal_event (am->vlib_main, am->fa_cleaner_node_index,
3494 ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX, ~0);
3499 VLIB_CLI_COMMAND (aclplugin_set_command, static) = {
3500 .path = "set acl-plugin",
3501 .short_help = "set acl-plugin session timeout {{udp idle}|tcp {idle|transient}} <seconds>",
3502 .function = acl_set_aclplugin_fn,
3505 VLIB_CLI_COMMAND (aclplugin_show_acl_command, static) = {
3506 .path = "show acl-plugin acl",
3507 .short_help = "show acl-plugin acl [index N]",
3508 .function = acl_show_aclplugin_acl_fn,
3511 VLIB_CLI_COMMAND (aclplugin_show_lookup_context_command, static) = {
3512 .path = "show acl-plugin lookup context",
3513 .short_help = "show acl-plugin lookup context [index N]",
3514 .function = acl_show_aclplugin_lookup_context_fn,
3517 VLIB_CLI_COMMAND (aclplugin_show_lookup_user_command, static) = {
3518 .path = "show acl-plugin lookup user",
3519 .short_help = "show acl-plugin lookup user [index N]",
3520 .function = acl_show_aclplugin_lookup_user_fn,
3523 VLIB_CLI_COMMAND (aclplugin_show_decode_5tuple_command, static) = {
3524 .path = "show acl-plugin decode 5tuple",
3525 .short_help = "show acl-plugin decode 5tuple XXXX XXXX XXXX XXXX XXXX XXXX",
3526 .function = acl_show_aclplugin_decode_5tuple_fn,
3529 VLIB_CLI_COMMAND (aclplugin_show_interface_command, static) = {
3530 .path = "show acl-plugin interface",
3531 .short_help = "show acl-plugin interface [sw_if_index N] [acl]",
3532 .function = acl_show_aclplugin_interface_fn,
3535 VLIB_CLI_COMMAND (aclplugin_show_memory_command, static) = {
3536 .path = "show acl-plugin memory",
3537 .short_help = "show acl-plugin memory",
3538 .function = acl_show_aclplugin_memory_fn,
3541 VLIB_CLI_COMMAND (aclplugin_show_sessions_command, static) = {
3542 .path = "show acl-plugin sessions",
3543 .short_help = "show acl-plugin sessions",
3544 .function = acl_show_aclplugin_sessions_fn,
3547 VLIB_CLI_COMMAND (aclplugin_show_tables_command, static) = {
3548 .path = "show acl-plugin tables",
3549 .short_help = "show acl-plugin tables [ acl [index N] | applied [ lc_index N ] | mask | hash [verbose N] ]",
3550 .function = acl_show_aclplugin_tables_fn,
3553 VLIB_CLI_COMMAND (aclplugin_show_macip_acl_command, static) = {
3554 .path = "show acl-plugin macip acl",
3555 .short_help = "show acl-plugin macip acl [index N]",
3556 .function = acl_show_aclplugin_macip_acl_fn,
3559 VLIB_CLI_COMMAND (aclplugin_show_macip_interface_command, static) = {
3560 .path = "show acl-plugin macip interface",
3561 .short_help = "show acl-plugin macip interface",
3562 .function = acl_show_aclplugin_macip_interface_fn,
3565 VLIB_CLI_COMMAND (aclplugin_clear_command, static) = {
3566 .path = "clear acl-plugin sessions",
3567 .short_help = "clear acl-plugin sessions",
3568 .function = acl_clear_aclplugin_fn,
3572 * [un]Apply an ACL to an interface.
3573 * The ACL is applied in a given direction, either input or output.
3574 * The ACL being applied must already exist.
3577 * <b><em> set acl-plugin interface <input|output> acl <index> [del] </b></em>
3580 VLIB_CLI_COMMAND (aclplugin_set_interface_command, static) = {
3581 .path = "set acl-plugin interface",
3582 .short_help = "set acl-plugin interface <interface> <input|output> <acl INDEX> [del] ",
3583 .function = acl_set_aclplugin_interface_fn,
3587 * Create an Access Control List (ACL)
3588 * an ACL is composed of more than one Access control element (ACE). Multiple
3589 * ACEs can be specified with this command using a comma separated list.
3591 * Each ACE describes a tuple of src+dst IP prefix, ip protocol, src+dst port
3592 * ranges. (the ACL plugin also support ICMP types/codes instead of UDP/TCP
3593 * ports, but this CLI does not).
3595 * An ACL can optionally be assigned a 'tag' - which is an identifier
3596 * understood by the client. VPP does not examine it in any way.
3598 * @cliexcmd{set acl-plugin acl <permit|deny> src <PREFIX> dst <PREFIX> proto
3599 * <TCP|UDP> sport <X-Y> dport <X-Y> [tag FOO]}
3601 VLIB_CLI_COMMAND (aclplugin_set_acl_command, static) = {
3602 .path = "set acl-plugin acl",
3603 .short_help = "set acl-plugin acl <permit|deny> src <PREFIX> dst <PREFIX> proto X sport X-Y dport X-Y [tag FOO] {use comma separated list for multiple rules}",
3604 .function = acl_set_aclplugin_acl_fn,
3608 static clib_error_t *
3609 acl_plugin_config (vlib_main_t * vm, unformat_input_t * input)
3611 acl_main_t *am = &acl_main;
3612 u32 conn_table_hash_buckets;
3613 uword conn_table_hash_memory_size;
3614 u32 conn_table_max_entries;
3615 uword main_heap_size;
3616 uword hash_heap_size;
3617 u32 hash_lookup_hash_buckets;
3618 uword hash_lookup_hash_memory;
3619 u32 reclassify_sessions;
3620 u32 use_tuple_merge;
3621 u32 tuple_merge_split_threshold;
3623 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3626 (input, "connection hash buckets %d", &conn_table_hash_buckets))
3627 am->fa_conn_table_hash_num_buckets = conn_table_hash_buckets;
3630 (input, "connection hash memory %U", unformat_memory_size,
3631 &conn_table_hash_memory_size))
3632 am->fa_conn_table_hash_memory_size = conn_table_hash_memory_size;
3633 else if (unformat (input, "connection count max %d",
3634 &conn_table_max_entries))
3635 am->fa_conn_table_max_entries = conn_table_max_entries;
3638 (input, "main heap size %U", unformat_memory_size,
3641 ("WARNING: ACL heap is now part of the main heap. 'main heap size' is ineffective.");
3644 (input, "hash lookup heap size %U", unformat_memory_size,
3647 ("WARNING: ACL heap is now part of the main heap. 'hash lookup heap size' is ineffective.");
3650 (input, "hash lookup hash buckets %d", &hash_lookup_hash_buckets))
3651 am->hash_lookup_hash_buckets = hash_lookup_hash_buckets;
3654 (input, "hash lookup hash memory %U", unformat_memory_size,
3655 &hash_lookup_hash_memory))
3656 am->hash_lookup_hash_memory = hash_lookup_hash_memory;
3657 else if (unformat (input, "use tuple merge %d", &use_tuple_merge))
3658 am->use_tuple_merge = use_tuple_merge;
3661 (input, "tuple merge split threshold %d",
3662 &tuple_merge_split_threshold))
3663 am->tuple_merge_split_threshold = tuple_merge_split_threshold;
3665 else if (unformat (input, "reclassify sessions %d",
3666 &reclassify_sessions))
3667 am->reclassify_sessions = reclassify_sessions;
3670 return clib_error_return (0, "unknown input '%U'",
3671 format_unformat_error, input);
3676 VLIB_CONFIG_FUNCTION (acl_plugin_config, "acl-plugin");
3678 /* Set up the API message handling tables */
3679 #include <vnet/format_fns.h>
3680 #include <acl/acl.api.c>
3682 static clib_error_t *
3683 acl_init (vlib_main_t * vm)
3685 acl_main_t *am = &acl_main;
3686 clib_error_t *error = 0;
3687 clib_memset (am, 0, sizeof (*am));
3689 am->vnet_main = vnet_get_main ();
3690 am->log_default = vlib_log_register_class ("acl_plugin", 0);
3692 /* Ask for a correctly-sized block of API message decode slots */
3693 am->msg_id_base = setup_message_id_table ();
3695 error = acl_plugin_exports_init (&acl_plugin);
3700 am->hash_lookup_hash_buckets = ACL_PLUGIN_HASH_LOOKUP_HASH_BUCKETS;
3701 am->hash_lookup_hash_memory = ACL_PLUGIN_HASH_LOOKUP_HASH_MEMORY;
3703 am->session_timeout_sec[ACL_TIMEOUT_TCP_TRANSIENT] =
3704 TCP_SESSION_TRANSIENT_TIMEOUT_SEC;
3705 am->session_timeout_sec[ACL_TIMEOUT_TCP_IDLE] =
3706 TCP_SESSION_IDLE_TIMEOUT_SEC;
3707 am->session_timeout_sec[ACL_TIMEOUT_UDP_IDLE] =
3708 UDP_SESSION_IDLE_TIMEOUT_SEC;
3710 am->fa_conn_table_hash_num_buckets =
3711 ACL_FA_CONN_TABLE_DEFAULT_HASH_NUM_BUCKETS;
3712 am->fa_conn_table_hash_memory_size =
3713 ACL_FA_CONN_TABLE_DEFAULT_HASH_MEMORY_SIZE;
3714 am->fa_conn_table_max_entries = ACL_FA_CONN_TABLE_DEFAULT_MAX_ENTRIES;
3715 am->reclassify_sessions = 0;
3716 vlib_thread_main_t *tm = vlib_get_thread_main ();
3718 am->fa_min_deleted_sessions_per_interval =
3719 ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL;
3720 am->fa_max_deleted_sessions_per_interval =
3721 ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL;
3722 am->fa_cleaner_wait_time_increment =
3723 ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT;
3725 vec_validate (am->per_worker_data, tm->n_vlib_mains - 1);
3728 for (wk = 0; wk < vec_len (am->per_worker_data); wk++)
3730 acl_fa_per_worker_data_t *pw = &am->per_worker_data[wk];
3731 if (tm->n_vlib_mains > 1)
3733 clib_spinlock_init (&pw->pending_session_change_request_lock);
3735 vec_validate (pw->expired,
3737 am->fa_max_deleted_sessions_per_interval);
3738 vec_set_len (pw->expired, 0);
3739 vec_validate_init_empty (pw->fa_conn_list_head, ACL_N_TIMEOUTS - 1,
3740 FA_SESSION_BOGUS_INDEX);
3741 vec_validate_init_empty (pw->fa_conn_list_tail, ACL_N_TIMEOUTS - 1,
3742 FA_SESSION_BOGUS_INDEX);
3743 vec_validate_init_empty (pw->fa_conn_list_head_expiry_time,
3744 ACL_N_TIMEOUTS - 1, ~0ULL);
3748 am->fa_cleaner_cnt_delete_by_sw_index = 0;
3749 am->fa_cleaner_cnt_delete_by_sw_index_ok = 0;
3750 am->fa_cleaner_cnt_unknown_event = 0;
3751 am->fa_cleaner_cnt_timer_restarted = 0;
3752 am->fa_cleaner_cnt_wait_with_timeout = 0;
3755 #define _(N, v, s) am->fa_ipv6_known_eh_bitmap = clib_bitmap_set(am->fa_ipv6_known_eh_bitmap, v, 1);
3758 am->l4_match_nonfirst_fragment = 1;
3760 /* use the new fancy hash-based matching */
3761 am->use_hash_acl_matching = 1;
3762 /* use tuplemerge by default */
3763 am->use_tuple_merge = 1;
3764 /* Set the default threshold */
3765 am->tuple_merge_split_threshold = TM_SPLIT_THRESHOLD;
3767 am->interface_acl_user_id =
3768 acl_plugin.register_user_module ("interface ACL", "sw_if_index",
3771 am->acl_counter_lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
3772 CLIB_CACHE_LINE_BYTES);
3773 am->acl_counter_lock[0] = 0; /* should be no need */
3778 VLIB_INIT_FUNCTION (acl_init);
3782 * fd.io coding-style-patch-verification: ON
3785 * eval: (c-set-style "gnu")