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;
313 prefix->address.af == ADDRESS_IP4 || prefix->address.af == ADDRESS_IP6;
314 return (!valid_af) || ip_prefix_decode2 (prefix, &ip_prefix);
318 acl_add_list (u32 count, vl_api_acl_rule_t rules[],
319 u32 * acl_list_index, u8 * tag)
321 acl_main_t *am = &acl_main;
324 acl_rule_t *acl_new_rules = 0;
328 tag_len = clib_strnlen ((const char *) tag, sizeof (a->tag));
329 if (tag_len == sizeof (a->tag))
330 return VNET_API_ERROR_INVALID_VALUE;
332 if (am->trace_acl > 255)
333 clib_warning ("API dbg: acl_add_list index %d tag %s", *acl_list_index,
336 /* check if what they request is consistent */
337 for (i = 0; i < count; i++)
339 if (acl_api_invalid_prefix (&rules[i].src_prefix))
340 return VNET_API_ERROR_INVALID_SRC_ADDRESS;
341 if (acl_api_invalid_prefix (&rules[i].dst_prefix))
342 return VNET_API_ERROR_INVALID_DST_ADDRESS;
343 if (rules[i].src_prefix.address.af != rules[i].dst_prefix.address.af)
344 return VNET_API_ERROR_INVALID_SRC_ADDRESS;
345 if (ntohs (rules[i].srcport_or_icmptype_first) >
346 ntohs (rules[i].srcport_or_icmptype_last))
347 return VNET_API_ERROR_INVALID_VALUE_2;
348 if (ntohs (rules[i].dstport_or_icmpcode_first) >
349 ntohs (rules[i].dstport_or_icmpcode_last))
350 return VNET_API_ERROR_INVALID_VALUE_2;
353 if (*acl_list_index != ~0)
355 /* They supplied some number, let's see if this ACL exists */
356 if (pool_is_free_index (am->acls, *acl_list_index))
358 /* tried to replace a non-existent ACL, no point doing anything */
360 ("acl-plugin-error: Trying to replace nonexistent ACL %d (tag %s)",
361 *acl_list_index, tag);
362 return VNET_API_ERROR_NO_SUCH_ENTRY;
368 ("acl-plugin-warning: supplied no rules for ACL %d (tag %s)",
369 *acl_list_index, tag);
372 /* Create and populate the rules */
374 vec_validate (acl_new_rules, count - 1);
376 for (i = 0; i < count; i++)
378 r = vec_elt_at_index (acl_new_rules, i);
379 clib_memset (r, 0, sizeof (*r));
380 r->is_permit = rules[i].is_permit;
381 r->is_ipv6 = rules[i].src_prefix.address.af;
382 ip_address_decode (&rules[i].src_prefix.address, &r->src);
383 ip_address_decode (&rules[i].dst_prefix.address, &r->dst);
384 r->src_prefixlen = rules[i].src_prefix.len;
385 r->dst_prefixlen = rules[i].dst_prefix.len;
386 r->proto = rules[i].proto;
387 r->src_port_or_type_first = ntohs (rules[i].srcport_or_icmptype_first);
388 r->src_port_or_type_last = ntohs (rules[i].srcport_or_icmptype_last);
389 r->dst_port_or_code_first = ntohs (rules[i].dstport_or_icmpcode_first);
390 r->dst_port_or_code_last = ntohs (rules[i].dstport_or_icmpcode_last);
391 r->tcp_flags_value = rules[i].tcp_flags_value;
392 r->tcp_flags_mask = rules[i].tcp_flags_mask;
395 if (~0 == *acl_list_index)
398 pool_get_aligned (am->acls, a, CLIB_CACHE_LINE_BYTES);
399 clib_memset (a, 0, sizeof (*a));
400 /* Will return the newly allocated ACL index */
401 *acl_list_index = a - am->acls;
405 a = am->acls + *acl_list_index;
406 /* Get rid of the old rules */
410 a->rules = acl_new_rules;
411 memcpy (a->tag, tag, tag_len + 1);
412 if (am->trace_acl > 255)
413 warning_acl_print_acl (am->vlib_main, am, *acl_list_index);
414 if (am->reclassify_sessions)
416 /* a change in an ACLs if they are applied may mean a new policy epoch */
417 policy_notify_acl_change (am, *acl_list_index);
419 validate_and_reset_acl_counters (am, *acl_list_index);
420 acl_plugin_lookup_context_notify_acl_change (*acl_list_index);
425 acl_is_used_by (u32 acl_index, u32 ** foo_index_vec_by_acl)
427 if (acl_index < vec_len (foo_index_vec_by_acl))
429 if (vec_len (vec_elt (foo_index_vec_by_acl, acl_index)) > 0)
431 /* ACL is applied somewhere. */
439 acl_del_list (u32 acl_list_index)
441 acl_main_t *am = &acl_main;
443 if (pool_is_free_index (am->acls, acl_list_index))
445 return VNET_API_ERROR_NO_SUCH_ENTRY;
447 if (acl_is_used_by (acl_list_index, am->input_sw_if_index_vec_by_acl))
448 return VNET_API_ERROR_ACL_IN_USE_INBOUND;
449 if (acl_is_used_by (acl_list_index, am->output_sw_if_index_vec_by_acl))
450 return VNET_API_ERROR_ACL_IN_USE_OUTBOUND;
451 /* lookup contexts cover other cases, not just inbound/outbound, so check that */
452 if (acl_is_used_by (acl_list_index, am->lc_index_vec_by_acl))
453 return VNET_API_ERROR_ACL_IN_USE_BY_LOOKUP_CONTEXT;
455 /* now we can delete the ACL itself */
456 a = pool_elt_at_index (am->acls, acl_list_index);
459 pool_put (am->acls, a);
460 /* acl_list_index is now free, notify the lookup contexts */
461 acl_plugin_lookup_context_notify_acl_change (acl_list_index);
466 count_skip (u8 * p, u32 size)
468 u64 *p64 = (u64 *) p;
469 /* Be tolerant to null pointer */
473 while ((0ULL == *p64) && ((u8 *) p64 - p) < size)
477 return (p64 - (u64 *) p) / 2;
481 acl_classify_add_del_table_small (vnet_classify_main_t * cm, u8 * mask,
482 u32 mask_len, u32 next_table_index,
483 u32 miss_next_index, u32 * table_index,
487 u32 memory_size = 2 << 22;
488 u32 skip = count_skip (mask, mask_len);
489 u32 match = (mask_len / 16) - skip;
490 u8 *skip_mask_ptr = mask + 16 * skip;
491 u32 current_data_flag = 0;
492 int current_data_offset = 0;
497 int ret = vnet_classify_add_del_table (cm, skip_mask_ptr, nbuckets,
498 memory_size, skip, match,
499 next_table_index, miss_next_index,
500 table_index, current_data_flag,
501 current_data_offset, is_add,
502 1 /* delete_chain */ );
507 intf_has_etype_whitelist (acl_main_t * am, u32 sw_if_index, int is_input)
510 ? am->input_etype_whitelist_by_sw_if_index
511 : am->output_etype_whitelist_by_sw_if_index;
512 u16 *whitelist = (vec_len (v) > sw_if_index) ? vec_elt (v, sw_if_index) : 0;
513 return vec_len (whitelist) > 0;
517 acl_clear_sessions (acl_main_t * am, u32 sw_if_index)
519 vlib_process_signal_event (am->vlib_main, am->fa_cleaner_node_index,
520 ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX,
526 acl_interface_in_enable_disable (acl_main_t * am, u32 sw_if_index,
532 if (pool_is_free_index (am->vnet_main->interface_main.sw_interfaces,
534 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
536 if (clib_bitmap_get (am->in_acl_on_sw_if_index, sw_if_index) ==
540 acl_fa_enable_disable (sw_if_index, 1, enable_disable);
542 rv = vnet_l2_feature_enable_disable ("l2-input-ip4", "acl-plugin-in-ip4-l2",
543 sw_if_index, enable_disable, 0, 0);
545 clib_error ("Could not enable on input");
546 rv = vnet_l2_feature_enable_disable ("l2-input-ip6", "acl-plugin-in-ip6-l2",
547 sw_if_index, enable_disable, 0, 0);
549 clib_error ("Could not enable on input");
551 if (intf_has_etype_whitelist (am, sw_if_index, 1))
552 vnet_l2_feature_enable_disable ("l2-input-nonip",
553 "acl-plugin-in-nonip-l2", sw_if_index,
554 enable_disable, 0, 0);
555 am->in_acl_on_sw_if_index =
556 clib_bitmap_set (am->in_acl_on_sw_if_index, sw_if_index, enable_disable);
562 acl_interface_out_enable_disable (acl_main_t * am, u32 sw_if_index,
568 if (pool_is_free_index (am->vnet_main->interface_main.sw_interfaces,
570 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
572 if (clib_bitmap_get (am->out_acl_on_sw_if_index, sw_if_index) ==
576 acl_fa_enable_disable (sw_if_index, 0, enable_disable);
579 vnet_l2_feature_enable_disable ("l2-output-ip4", "acl-plugin-out-ip4-l2",
580 sw_if_index, enable_disable, 0, 0);
582 clib_error ("Could not enable on output");
584 vnet_l2_feature_enable_disable ("l2-output-ip6", "acl-plugin-out-ip6-l2",
585 sw_if_index, enable_disable, 0, 0);
587 clib_error ("Could not enable on output");
588 if (intf_has_etype_whitelist (am, sw_if_index, 0))
589 vnet_l2_feature_enable_disable ("l2-output-nonip",
590 "acl-plugin-out-nonip-l2", sw_if_index,
591 enable_disable, 0, 0);
592 am->out_acl_on_sw_if_index =
593 clib_bitmap_set (am->out_acl_on_sw_if_index, sw_if_index, enable_disable);
599 acl_stats_intf_counters_enable_disable (acl_main_t * am, int enable_disable)
603 am->interface_acl_counters_enabled = enable_disable;
609 acl_interface_inout_enable_disable (acl_main_t * am, u32 sw_if_index,
610 int is_input, int enable_disable)
613 return acl_interface_in_enable_disable (am, sw_if_index, enable_disable);
615 return acl_interface_out_enable_disable (am, sw_if_index, enable_disable);
619 acl_is_not_defined (acl_main_t * am, u32 acl_list_index)
621 return (pool_is_free_index (am->acls, acl_list_index));
625 acl_interface_set_inout_acl_list (acl_main_t * am, u32 sw_if_index,
626 u8 is_input, u32 * vec_acl_list_index,
627 int *may_clear_sessions)
630 uword *seen_acl_bitmap = 0;
631 uword *old_seen_acl_bitmap = 0;
632 uword *change_acl_bitmap = 0;
637 if (am->trace_acl > 255)
639 ("API dbg: acl_interface_set_inout_acl_list: sw_if_index %d is_input %d acl_vec: [%U]",
640 sw_if_index, is_input, format_vec32, vec_acl_list_index, "%d");
642 vec_foreach (pacln, vec_acl_list_index)
644 if (acl_is_not_defined (am, *pacln))
646 /* ACL is not defined. Can not apply */
647 clib_warning ("ERROR: ACL %d not defined", *pacln);
648 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
651 if (clib_bitmap_get (seen_acl_bitmap, *pacln))
653 /* ACL being applied twice within the list. error. */
654 clib_warning ("ERROR: ACL %d being applied twice", *pacln);
655 rv = VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
658 seen_acl_bitmap = clib_bitmap_set (seen_acl_bitmap, *pacln, 1);
662 u32 **pinout_lc_index_by_sw_if_index =
663 is_input ? &am->input_lc_index_by_sw_if_index : &am->
664 output_lc_index_by_sw_if_index;
666 u32 ***pinout_acl_vec_by_sw_if_index =
667 is_input ? &am->input_acl_vec_by_sw_if_index : &am->
668 output_acl_vec_by_sw_if_index;
670 u32 ***pinout_sw_if_index_vec_by_acl =
671 is_input ? &am->input_sw_if_index_vec_by_acl : &am->
672 output_sw_if_index_vec_by_acl;
674 vec_validate ((*pinout_acl_vec_by_sw_if_index), sw_if_index);
676 clib_bitmap_validate (old_seen_acl_bitmap, 1);
678 vec_foreach (pacln, (*pinout_acl_vec_by_sw_if_index)[sw_if_index])
680 old_seen_acl_bitmap = clib_bitmap_set (old_seen_acl_bitmap, *pacln, 1);
683 clib_bitmap_dup_xor (old_seen_acl_bitmap, seen_acl_bitmap);
685 if (am->trace_acl > 255)
686 clib_warning ("bitmaps: old seen %U new seen %U changed %U",
687 format_bitmap_hex, old_seen_acl_bitmap, format_bitmap_hex,
688 seen_acl_bitmap, format_bitmap_hex, change_acl_bitmap);
691 clib_bitmap_foreach (acln, change_acl_bitmap) {
692 if (clib_bitmap_get(old_seen_acl_bitmap, acln)) {
693 /* ACL is being removed. */
694 if (acln < vec_len((*pinout_sw_if_index_vec_by_acl))) {
695 int index = vec_search((*pinout_sw_if_index_vec_by_acl)[acln], sw_if_index);
696 vec_del1((*pinout_sw_if_index_vec_by_acl)[acln], index);
699 /* ACL is being added. */
700 vec_validate((*pinout_sw_if_index_vec_by_acl), acln);
701 vec_add1((*pinout_sw_if_index_vec_by_acl)[acln], sw_if_index);
706 vec_free ((*pinout_acl_vec_by_sw_if_index)[sw_if_index]);
707 (*pinout_acl_vec_by_sw_if_index)[sw_if_index] =
708 vec_dup (vec_acl_list_index);
710 if (am->reclassify_sessions)
712 /* re-applying ACLs means a new policy epoch */
713 increment_policy_epoch (am, sw_if_index, is_input);
717 /* if no commonalities between the ACL# - then we should definitely clear the sessions */
718 if (may_clear_sessions && *may_clear_sessions
719 && !clib_bitmap_is_zero (change_acl_bitmap))
721 acl_clear_sessions (am, sw_if_index);
722 *may_clear_sessions = 0;
727 * prepare or delete the lookup context if necessary, and if context exists, set ACL list
729 vec_validate_init_empty ((*pinout_lc_index_by_sw_if_index), sw_if_index,
731 if (vec_len (vec_acl_list_index) > 0)
733 u32 lc_index = (*pinout_lc_index_by_sw_if_index)[sw_if_index];
737 acl_plugin.get_lookup_context_index (am->interface_acl_user_id,
738 sw_if_index, is_input);
739 (*pinout_lc_index_by_sw_if_index)[sw_if_index] = lc_index;
741 acl_plugin.set_acl_vec_for_context (lc_index, vec_acl_list_index);
745 if (~0 != (*pinout_lc_index_by_sw_if_index)[sw_if_index])
748 put_lookup_context_index ((*pinout_lc_index_by_sw_if_index)
750 (*pinout_lc_index_by_sw_if_index)[sw_if_index] = ~0;
753 /* ensure ACL processing is enabled/disabled as needed */
754 acl_interface_inout_enable_disable (am, sw_if_index, is_input,
755 vec_len (vec_acl_list_index) > 0);
758 clib_bitmap_free (change_acl_bitmap);
759 clib_bitmap_free (seen_acl_bitmap);
760 clib_bitmap_free (old_seen_acl_bitmap);
765 acl_interface_reset_inout_acls (u32 sw_if_index, u8 is_input,
766 int *may_clear_sessions)
768 acl_main_t *am = &acl_main;
769 acl_interface_set_inout_acl_list (am, sw_if_index, is_input, 0,
774 acl_interface_add_del_inout_acl (u32 sw_if_index, u8 is_add, u8 is_input,
778 acl_main_t *am = &acl_main;
780 int may_clear_sessions = 1;
782 int error_already_applied = is_input ? VNET_API_ERROR_ACL_IN_USE_INBOUND
783 : VNET_API_ERROR_ACL_IN_USE_OUTBOUND;
785 u32 ***pinout_acl_vec_by_sw_if_index =
786 is_input ? &am->input_acl_vec_by_sw_if_index : &am->
787 output_acl_vec_by_sw_if_index;
791 vec_validate ((*pinout_acl_vec_by_sw_if_index), sw_if_index);
792 u32 index = vec_search ((*pinout_acl_vec_by_sw_if_index)[sw_if_index],
797 rv = error_already_applied;
801 acl_vec = vec_dup ((*pinout_acl_vec_by_sw_if_index)[sw_if_index]);
802 vec_add1 (acl_vec, acl_list_index);
806 if (sw_if_index >= vec_len (*pinout_acl_vec_by_sw_if_index))
808 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
812 u32 index = vec_search ((*pinout_acl_vec_by_sw_if_index)[sw_if_index],
817 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
821 acl_vec = vec_dup ((*pinout_acl_vec_by_sw_if_index)[sw_if_index]);
822 vec_del1 (acl_vec, index);
825 rv = acl_interface_set_inout_acl_list (am, sw_if_index, is_input, acl_vec,
826 &may_clear_sessions);
833 acl_set_etype_whitelists (acl_main_t * am, u32 sw_if_index, u16 * vec_in,
836 vec_validate (am->input_etype_whitelist_by_sw_if_index, sw_if_index);
837 vec_validate (am->output_etype_whitelist_by_sw_if_index, sw_if_index);
839 vec_free (am->input_etype_whitelist_by_sw_if_index[sw_if_index]);
840 vec_free (am->output_etype_whitelist_by_sw_if_index[sw_if_index]);
842 am->input_etype_whitelist_by_sw_if_index[sw_if_index] = vec_in;
843 am->output_etype_whitelist_by_sw_if_index[sw_if_index] = vec_out;
846 * if there are already inbound/outbound ACLs applied, toggle the
847 * enable/disable - this will recreate the necessary tables.
850 if (vec_len (am->input_acl_vec_by_sw_if_index) > sw_if_index)
852 if (vec_len (am->input_acl_vec_by_sw_if_index[sw_if_index]) > 0)
854 acl_interface_in_enable_disable (am, sw_if_index, 0);
855 acl_interface_in_enable_disable (am, sw_if_index, 1);
858 if (vec_len (am->output_acl_vec_by_sw_if_index) > sw_if_index)
860 if (vec_len (am->output_acl_vec_by_sw_if_index[sw_if_index]) > 0)
862 acl_interface_out_enable_disable (am, sw_if_index, 0);
863 acl_interface_out_enable_disable (am, sw_if_index, 1);
879 u32 dot1q_table_index;
880 u32 dot1ad_table_index;
881 u32 arp_dot1q_table_index;
882 u32 arp_dot1ad_table_index;
885 u32 out_arp_table_index;
886 u32 out_dot1q_table_index;
887 u32 out_dot1ad_table_index;
888 u32 out_arp_dot1q_table_index;
889 u32 out_arp_dot1ad_table_index;
890 } macip_match_type_t;
893 macip_find_match_type (macip_match_type_t * mv, u8 * mac_mask, u8 prefix_len,
899 for (i = 0; i < vec_len (mv); i++)
901 if ((mv[i].prefix_len == prefix_len) && (mv[i].is_ipv6 == is_ipv6)
902 && (0 == memcmp (mv[i].mac_mask, mac_mask, 6)))
912 /* Get metric used to sort match types.
913 The more specific and the more often seen - the bigger the metric */
915 match_type_metric (macip_match_type_t * m)
917 unsigned int mac_bits_set = 0;
918 unsigned int mac_byte;
920 for (i = 0; i < 6; i++)
922 mac_byte = m->mac_mask[i];
923 for (; mac_byte; mac_byte >>= 1)
924 mac_bits_set += mac_byte & 1;
927 * Attempt to place the more specific and the more used rules on top.
928 * There are obvious caveat corner cases to this, but they do not
929 * seem to be sensible in real world (e.g. specific IPv4 with wildcard MAC
930 * going with a wildcard IPv4 with a specific MAC).
932 return m->prefix_len + mac_bits_set + m->is_ipv6 + 10 * m->count;
936 match_type_compare (macip_match_type_t * m1, macip_match_type_t * m2)
938 /* Ascending sort based on the metric values */
939 return match_type_metric (m1) - match_type_metric (m2);
942 /* Get the offset of L3 source within ethernet packet */
944 get_l3_src_offset (int is6)
947 return (sizeof (ethernet_header_t) +
948 offsetof (ip6_header_t, src_address));
950 return (sizeof (ethernet_header_t) +
951 offsetof (ip4_header_t, src_address));
955 get_l3_dst_offset (int is6)
958 return (sizeof (ethernet_header_t) +
959 offsetof (ip6_header_t, dst_address));
961 return (sizeof (ethernet_header_t) +
962 offsetof (ip4_header_t, dst_address));
966 * return if the is_permit value also requires to create the egress tables
967 * For backwards compatibility, we keep the is_permit = 1 to only
968 * create the ingress tables, and the new value of 3 will also
969 * create the egress tables based on destination.
972 macip_permit_also_egress (u8 is_permit)
974 return (is_permit == 3);
978 macip_create_classify_tables (acl_main_t * am, u32 macip_acl_index)
980 macip_match_type_t *mvec = NULL;
981 macip_match_type_t *mt;
982 macip_acl_list_t *a = pool_elt_at_index (am->macip_acls, macip_acl_index);
984 u32 match_type_index;
988 vnet_classify_main_t *cm = &vnet_classify_main;
990 /* Count the number of different types of rules */
991 for (i = 0; i < a->count; i++)
995 macip_find_match_type (mvec, a->rules[i].src_mac_mask,
996 a->rules[i].src_prefixlen,
997 a->rules[i].is_ipv6)))
999 match_type_index = vec_len (mvec);
1000 vec_validate (mvec, match_type_index);
1001 memcpy (mvec[match_type_index].mac_mask,
1002 a->rules[i].src_mac_mask, 6);
1003 mvec[match_type_index].prefix_len = a->rules[i].src_prefixlen;
1004 mvec[match_type_index].is_ipv6 = a->rules[i].is_ipv6;
1005 mvec[match_type_index].has_egress = 0;
1006 mvec[match_type_index].table_index = ~0;
1007 mvec[match_type_index].arp_table_index = ~0;
1008 mvec[match_type_index].dot1q_table_index = ~0;
1009 mvec[match_type_index].dot1ad_table_index = ~0;
1010 mvec[match_type_index].arp_dot1q_table_index = ~0;
1011 mvec[match_type_index].arp_dot1ad_table_index = ~0;
1012 mvec[match_type_index].out_table_index = ~0;
1013 mvec[match_type_index].out_arp_table_index = ~0;
1014 mvec[match_type_index].out_dot1q_table_index = ~0;
1015 mvec[match_type_index].out_dot1ad_table_index = ~0;
1016 mvec[match_type_index].out_arp_dot1q_table_index = ~0;
1017 mvec[match_type_index].out_arp_dot1ad_table_index = ~0;
1019 mvec[match_type_index].count++;
1020 mvec[match_type_index].has_egress |=
1021 macip_permit_also_egress (a->rules[i].is_permit);
1023 /* Put the most frequently used tables last in the list so we can create classifier tables in reverse order */
1024 vec_sort_with_function (mvec, match_type_compare);
1025 /* Create the classifier tables */
1027 out_last_table = ~0;
1028 /* First add ARP tables */
1029 vec_foreach (mt, mvec)
1032 int is6 = mt->is_ipv6;
1034 u32 *last_tag_table;
1035 u32 *out_last_tag_table;
1042 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
1043 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1044 | Destination Address |
1045 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1047 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +
1049 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1050 | EtherType | Hardware Type |
1051 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1052 | Protocol Type | Hw addr len | Proto addr len|
1053 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1055 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +
1056 | Sender Hardware Address |
1057 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1058 | Sender Protocol Address |
1059 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1060 | Target Hardware Address |
1061 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1062 | | TargetProtocolAddress |
1063 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1065 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1067 for (tags = 2; tags >= 0; tags--)
1069 clib_memset (mask, 0, sizeof (mask));
1070 /* source MAC address */
1071 memcpy (&mask[6], mt->mac_mask, 6);
1077 clib_memset (&mask[12], 0xff, 2); /* ethernet protocol */
1079 last_tag_table = &mt->arp_table_index;
1082 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1083 clib_memset (&mask[16], 0xff, 2); /* ethernet protocol */
1085 last_tag_table = &mt->arp_dot1q_table_index;
1088 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1089 clib_memset (&mask[16], 0xff, 2); /* VLAN tag2 */
1090 clib_memset (&mask[20], 0xff, 2); /* ethernet protocol */
1092 last_tag_table = &mt->arp_dot1ad_table_index;
1096 /* sender hardware address within ARP */
1097 memcpy (&mask[l3_offset + 8], mt->mac_mask, 6);
1098 /* sender protocol address within ARP */
1099 for (i = 0; i < (mt->prefix_len / 8); i++)
1100 mask[l3_offset + 14 + i] = 0xff;
1101 if (mt->prefix_len % 8)
1102 mask[l3_offset + 14 + (mt->prefix_len / 8)] =
1103 0xff - ((1 << (8 - mt->prefix_len % 8)) - 1);
1105 mask_len = ((l3_offset + 14 + ((mt->prefix_len + 7) / 8) +
1107 1)) / sizeof (u32x4)) * sizeof (u32x4);
1108 acl_classify_add_del_table_small (cm, mask, mask_len, last_table,
1109 (~0 == last_table) ? 0 : ~0,
1111 last_table = *last_tag_table;
1114 /* egress ARP table */
1115 clib_memset (mask, 0, sizeof (mask));
1121 clib_memset (&mask[12], 0xff, 2); /* ethernet protocol */
1123 out_last_tag_table = &mt->out_arp_table_index;
1126 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1127 clib_memset (&mask[16], 0xff, 2); /* ethernet protocol */
1129 out_last_tag_table = &mt->out_arp_dot1q_table_index;
1132 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1133 clib_memset (&mask[16], 0xff, 2); /* VLAN tag2 */
1134 clib_memset (&mask[20], 0xff, 2); /* ethernet protocol */
1136 out_last_tag_table = &mt->out_arp_dot1ad_table_index;
1140 /* AYXX: FIXME here - can we tighten the ARP-related table more ? */
1141 /* mask captures just the destination and the ethertype */
1142 mask_len = ((l3_offset +
1144 1)) / sizeof (u32x4)) * sizeof (u32x4);
1145 acl_classify_add_del_table_small (cm, mask, mask_len,
1148 out_last_table) ? 0 : ~0,
1149 out_last_tag_table, 1);
1150 out_last_table = *out_last_tag_table;
1155 /* Now add IP[46] tables */
1156 vec_foreach (mt, mvec)
1159 int is6 = mt->is_ipv6;
1163 u32 *last_tag_table;
1164 u32 *out_last_tag_table;
1167 * create chained tables for VLAN (no-tags, dot1q and dot1ad) packets
1169 for (tags = 2; tags >= 0; tags--)
1171 clib_memset (mask, 0, sizeof (mask));
1172 memcpy (&mask[6], mt->mac_mask, 6);
1173 l3_src_offs = tags * 4 + get_l3_src_offset (is6);
1178 clib_memset (&mask[12], 0xff, 2); /* ethernet protocol */
1179 last_tag_table = &mt->table_index;
1182 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1183 clib_memset (&mask[16], 0xff, 2); /* ethernet protocol */
1184 last_tag_table = &mt->dot1q_table_index;
1187 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1188 clib_memset (&mask[16], 0xff, 2); /* VLAN tag2 */
1189 clib_memset (&mask[20], 0xff, 2); /* ethernet protocol */
1190 last_tag_table = &mt->dot1ad_table_index;
1193 for (i = 0; i < (mt->prefix_len / 8); i++)
1195 mask[l3_src_offs + i] = 0xff;
1197 if (mt->prefix_len % 8)
1199 mask[l3_src_offs + (mt->prefix_len / 8)] =
1200 0xff - ((1 << (8 - mt->prefix_len % 8)) - 1);
1203 * Round-up the number of bytes needed to store the prefix,
1204 * and round up the number of vectors too
1206 mask_len = ((l3_src_offs + ((mt->prefix_len + 7) / 8) +
1207 (sizeof (u32x4) - 1)) / sizeof (u32x4)) * sizeof (u32x4);
1208 acl_classify_add_del_table_small (cm, mask, mask_len, last_table,
1209 (~0 == last_table) ? 0 : ~0,
1211 last_table = *last_tag_table;
1215 for (tags = 2; tags >= 0; tags--)
1217 clib_memset (mask, 0, sizeof (mask));
1218 /* MAC destination */
1219 memcpy (&mask[0], mt->mac_mask, 6);
1220 l3_dst_offs = tags * 4 + get_l3_dst_offset (is6);
1225 clib_memset (&mask[12], 0xff, 2); /* ethernet protocol */
1226 out_last_tag_table = &mt->out_table_index;
1229 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1230 clib_memset (&mask[16], 0xff, 2); /* ethernet protocol */
1231 out_last_tag_table = &mt->out_dot1q_table_index;
1234 clib_memset (&mask[12], 0xff, 2); /* VLAN tag1 */
1235 clib_memset (&mask[16], 0xff, 2); /* VLAN tag2 */
1236 clib_memset (&mask[20], 0xff, 2); /* ethernet protocol */
1237 out_last_tag_table = &mt->out_dot1ad_table_index;
1240 for (i = 0; i < (mt->prefix_len / 8); i++)
1242 mask[l3_dst_offs + i] = 0xff;
1244 if (mt->prefix_len % 8)
1246 mask[l3_dst_offs + (mt->prefix_len / 8)] =
1247 0xff - ((1 << (8 - mt->prefix_len % 8)) - 1);
1250 * Round-up the number of bytes needed to store the prefix,
1251 * and round up the number of vectors too
1253 mask_len = ((l3_dst_offs + ((mt->prefix_len + 7) / 8) +
1255 1)) / sizeof (u32x4)) * sizeof (u32x4);
1256 acl_classify_add_del_table_small (cm, mask, mask_len,
1258 (~0 == out_last_table) ? 0 : ~0,
1259 out_last_tag_table, 1);
1260 out_last_table = *out_last_tag_table;
1264 a->ip4_table_index = last_table;
1265 a->ip6_table_index = last_table;
1266 a->l2_table_index = last_table;
1268 a->out_ip4_table_index = out_last_table;
1269 a->out_ip6_table_index = out_last_table;
1270 a->out_l2_table_index = out_last_table;
1272 /* Populate the classifier tables with rules from the MACIP ACL */
1273 for (i = 0; i < a->count; i++)
1277 int is6 = a->rules[i].is_ipv6;
1284 macip_find_match_type (mvec, a->rules[i].src_mac_mask,
1285 a->rules[i].src_prefixlen,
1286 a->rules[i].is_ipv6);
1287 ASSERT (match_type_index != ~0);
1289 for (tags = 2; tags >= 0; tags--)
1291 clib_memset (mask, 0, sizeof (mask));
1292 l3_src_offs = tags * 4 + get_l3_src_offset (is6);
1293 memcpy (&mask[6], a->rules[i].src_mac, 6);
1298 tag_table = mvec[match_type_index].table_index;
1302 tag_table = mvec[match_type_index].dot1q_table_index;
1308 tag_table = mvec[match_type_index].dot1ad_table_index;
1318 memcpy (&mask[l3_src_offs], &a->rules[i].src_ip_addr.ip6, 16);
1320 mask[eth + 1] = 0xdd;
1324 memcpy (&mask[l3_src_offs], &a->rules[i].src_ip_addr.ip4, 4);
1326 mask[eth + 1] = 0x00;
1329 /* add session to table mvec[match_type_index].table_index; */
1330 vnet_classify_add_del_session (cm, tag_table,
1331 mask, a->rules[i].is_permit ? ~0 : 0,
1332 i, 0, action, metadata, 1);
1333 clib_memset (&mask[12], 0, sizeof (mask) - 12);
1336 /* add ARP table entry too */
1337 if (!is6 && (mvec[match_type_index].arp_table_index != ~0))
1339 clib_memset (mask, 0, sizeof (mask));
1340 memcpy (&mask[6], a->rules[i].src_mac, 6);
1342 for (tags = 2; tags >= 0; tags--)
1348 tag_table = mvec[match_type_index].arp_table_index;
1354 tag_table = mvec[match_type_index].arp_dot1q_table_index;
1362 tag_table = mvec[match_type_index].arp_dot1ad_table_index;
1373 memcpy (&mask[l3_src_offs + 8], a->rules[i].src_mac, 6);
1374 memcpy (&mask[l3_src_offs + 14], &a->rules[i].src_ip_addr.ip4,
1376 vnet_classify_add_del_session (cm, tag_table, mask,
1377 a->rules[i].is_permit ? ~0 : 0,
1378 i, 0, action, metadata, 1);
1381 if (macip_permit_also_egress (a->rules[i].is_permit))
1383 /* Add the egress entry with destination set */
1384 for (tags = 2; tags >= 0; tags--)
1386 clib_memset (mask, 0, sizeof (mask));
1387 l3_dst_offs = tags * 4 + get_l3_dst_offset (is6);
1388 /* src mac in the other direction becomes dst */
1389 memcpy (&mask[0], a->rules[i].src_mac, 6);
1394 tag_table = mvec[match_type_index].out_table_index;
1398 tag_table = mvec[match_type_index].out_dot1q_table_index;
1404 tag_table = mvec[match_type_index].out_dot1ad_table_index;
1414 memcpy (&mask[l3_dst_offs], &a->rules[i].src_ip_addr.ip6,
1417 mask[eth + 1] = 0xdd;
1421 memcpy (&mask[l3_dst_offs], &a->rules[i].src_ip_addr.ip4,
1424 mask[eth + 1] = 0x00;
1427 /* add session to table mvec[match_type_index].table_index; */
1428 vnet_classify_add_del_session (cm, tag_table,
1430 a->rules[i].is_permit ? ~0 : 0,
1431 i, 0, action, metadata, 1);
1432 // clib_memset (&mask[12], 0, sizeof (mask) - 12);
1435 /* add ARP table entry too */
1436 if (!is6 && (mvec[match_type_index].out_arp_table_index != ~0))
1438 for (tags = 2; tags >= 0; tags--)
1440 clib_memset (mask, 0, sizeof (mask));
1445 tag_table = mvec[match_type_index].out_arp_table_index;
1451 mvec[match_type_index].out_arp_dot1q_table_index;
1459 mvec[match_type_index].out_arp_dot1ad_table_index;
1469 vnet_classify_add_del_session (cm, tag_table,
1472 is_permit ? ~0 : 0, i, 0,
1473 action, metadata, 1);
1482 macip_destroy_classify_tables (acl_main_t * am, u32 macip_acl_index)
1484 vnet_classify_main_t *cm = &vnet_classify_main;
1485 macip_acl_list_t *a = pool_elt_at_index (am->macip_acls, macip_acl_index);
1487 if (a->ip4_table_index != ~0)
1489 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0,
1490 &a->ip4_table_index, 0);
1491 a->ip4_table_index = ~0;
1493 if (a->ip6_table_index != ~0)
1495 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0,
1496 &a->ip6_table_index, 0);
1497 a->ip6_table_index = ~0;
1499 if (a->l2_table_index != ~0)
1501 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0, &a->l2_table_index,
1503 a->l2_table_index = ~0;
1505 if (a->out_ip4_table_index != ~0)
1507 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0,
1508 &a->out_ip4_table_index, 0);
1509 a->out_ip4_table_index = ~0;
1511 if (a->out_ip6_table_index != ~0)
1513 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0,
1514 &a->out_ip6_table_index, 0);
1515 a->out_ip6_table_index = ~0;
1517 if (a->out_l2_table_index != ~0)
1519 acl_classify_add_del_table_small (cm, 0, ~0, ~0, ~0,
1520 &a->out_l2_table_index, 0);
1521 a->out_l2_table_index = ~0;
1526 macip_maybe_apply_unapply_classifier_tables (acl_main_t * am, u32 acl_index,
1532 macip_acl_list_t *a = pool_elt_at_index (am->macip_acls, acl_index);
1534 for (i = 0; i < vec_len (am->macip_acl_by_sw_if_index); i++)
1535 if (vec_elt (am->macip_acl_by_sw_if_index, i) == acl_index)
1537 rv0 = vnet_set_input_acl_intfc (am->vlib_main, i, a->ip4_table_index,
1538 a->ip6_table_index, a->l2_table_index,
1540 /* return the first unhappy outcome but make try to plough through. */
1543 vnet_set_output_acl_intfc (am->vlib_main, i, a->out_ip4_table_index,
1544 a->out_ip6_table_index,
1545 a->out_l2_table_index, is_apply);
1546 /* return the first unhappy outcome but make try to plough through. */
1553 macip_acl_add_list (u32 count, vl_api_macip_acl_rule_t rules[],
1554 u32 * acl_list_index, u8 * tag)
1556 acl_main_t *am = &acl_main;
1557 macip_acl_list_t *a;
1558 macip_acl_rule_t *r;
1559 macip_acl_rule_t *acl_new_rules = 0;
1564 tag_len = clib_strnlen ((const char *) tag, sizeof (a->tag));
1565 if (tag_len == sizeof (a->tag))
1566 return VNET_API_ERROR_INVALID_VALUE;
1568 if (*acl_list_index != ~0)
1570 /* They supplied some number, let's see if this MACIP ACL exists */
1571 if (pool_is_free_index (am->macip_acls, *acl_list_index))
1573 /* tried to replace a non-existent ACL, no point doing anything */
1575 ("acl-plugin-error: Trying to replace nonexistent MACIP ACL %d (tag %s)",
1576 *acl_list_index, tag);
1577 return VNET_API_ERROR_NO_SUCH_ENTRY;
1584 ("acl-plugin-warning: Trying to create empty MACIP ACL (tag %s)",
1587 /* if replacing the ACL, unapply the classifier tables first - they will be gone.. */
1588 if (~0 != *acl_list_index)
1589 rv = macip_maybe_apply_unapply_classifier_tables (am, *acl_list_index, 0);
1590 /* Create and populate the rules */
1592 vec_validate (acl_new_rules, count - 1);
1594 for (i = 0; i < count; i++)
1596 r = &acl_new_rules[i];
1597 r->is_permit = rules[i].is_permit;
1598 r->is_ipv6 = rules[i].src_prefix.address.af;
1599 mac_address_decode (rules[i].src_mac, (mac_address_t *) & r->src_mac);
1600 mac_address_decode (rules[i].src_mac_mask,
1601 (mac_address_t *) & r->src_mac_mask);
1602 ip_address_decode (&rules[i].src_prefix.address, &r->src_ip_addr);
1603 r->src_prefixlen = rules[i].src_prefix.len;
1606 if (~0 == *acl_list_index)
1609 pool_get_aligned (am->macip_acls, a, CLIB_CACHE_LINE_BYTES);
1610 clib_memset (a, 0, sizeof (*a));
1611 /* Will return the newly allocated ACL index */
1612 *acl_list_index = a - am->macip_acls;
1616 a = pool_elt_at_index (am->macip_acls, *acl_list_index);
1619 vec_free (a->rules);
1621 macip_destroy_classify_tables (am, *acl_list_index);
1624 a->rules = acl_new_rules;
1626 memcpy (a->tag, tag, tag_len + 1);
1628 /* Create and populate the classifier tables */
1629 macip_create_classify_tables (am, *acl_list_index);
1630 /* If the ACL was already applied somewhere, reapply the newly created tables */
1632 || macip_maybe_apply_unapply_classifier_tables (am, *acl_list_index, 1);
1636 /* No check that sw_if_index denotes a valid interface - the callers
1637 * were supposed to validate.
1639 * That said, if sw_if_index corresponds to an interface that exists at all,
1640 * this function must return errors accordingly if the ACL is not applied.
1644 macip_acl_interface_del_acl (acl_main_t * am, u32 sw_if_index)
1647 u32 macip_acl_index;
1648 macip_acl_list_t *a;
1650 /* The vector is too short - MACIP ACL is not applied */
1651 if (sw_if_index >= vec_len (am->macip_acl_by_sw_if_index))
1652 return VNET_API_ERROR_NO_SUCH_ENTRY;
1654 macip_acl_index = am->macip_acl_by_sw_if_index[sw_if_index];
1655 /* No point in deleting MACIP ACL which is not applied */
1656 if (~0 == macip_acl_index)
1657 return VNET_API_ERROR_NO_SUCH_ENTRY;
1659 a = pool_elt_at_index (am->macip_acls, macip_acl_index);
1660 /* remove the classifier tables off the interface L2 ACL */
1662 vnet_set_input_acl_intfc (am->vlib_main, sw_if_index, a->ip4_table_index,
1663 a->ip6_table_index, a->l2_table_index, 0);
1665 vnet_set_output_acl_intfc (am->vlib_main, sw_if_index,
1666 a->out_ip4_table_index, a->out_ip6_table_index,
1667 a->out_l2_table_index, 0);
1668 /* Unset the MACIP ACL index */
1669 am->macip_acl_by_sw_if_index[sw_if_index] = ~0;
1670 /* macip_acl_interface_add_acl did a vec_add1() to this previously, so [sw_if_index] should be valid */
1671 u32 index = vec_search (am->sw_if_index_vec_by_macip_acl[macip_acl_index],
1674 vec_del1 (am->sw_if_index_vec_by_macip_acl[macip_acl_index], index);
1678 /* No check for validity of sw_if_index - the callers were supposed to validate */
1681 macip_acl_interface_add_acl (acl_main_t * am, u32 sw_if_index,
1682 u32 macip_acl_index)
1684 macip_acl_list_t *a;
1686 if (pool_is_free_index (am->macip_acls, macip_acl_index))
1688 return VNET_API_ERROR_NO_SUCH_ENTRY;
1690 a = pool_elt_at_index (am->macip_acls, macip_acl_index);
1691 vec_validate_init_empty (am->macip_acl_by_sw_if_index, sw_if_index, ~0);
1692 vec_validate (am->sw_if_index_vec_by_macip_acl, macip_acl_index);
1693 vec_add1 (am->sw_if_index_vec_by_macip_acl[macip_acl_index], sw_if_index);
1694 /* If there already a MACIP ACL applied, unapply it */
1695 if (~0 != am->macip_acl_by_sw_if_index[sw_if_index])
1696 macip_acl_interface_del_acl (am, sw_if_index);
1697 am->macip_acl_by_sw_if_index[sw_if_index] = macip_acl_index;
1699 /* Apply the classifier tables for L2 ACLs */
1701 vnet_set_input_acl_intfc (am->vlib_main, sw_if_index, a->ip4_table_index,
1702 a->ip6_table_index, a->l2_table_index, 1);
1704 vnet_set_output_acl_intfc (am->vlib_main, sw_if_index,
1705 a->out_ip4_table_index, a->out_ip6_table_index,
1706 a->out_l2_table_index, 1);
1711 macip_acl_del_list (u32 acl_list_index)
1713 acl_main_t *am = &acl_main;
1714 macip_acl_list_t *a;
1716 if (pool_is_free_index (am->macip_acls, acl_list_index))
1718 return VNET_API_ERROR_NO_SUCH_ENTRY;
1721 /* delete any references to the ACL */
1722 for (i = 0; i < vec_len (am->macip_acl_by_sw_if_index); i++)
1724 if (am->macip_acl_by_sw_if_index[i] == acl_list_index)
1726 macip_acl_interface_del_acl (am, i);
1730 /* Now that classifier tables are detached, clean them up */
1731 macip_destroy_classify_tables (am, acl_list_index);
1733 /* now we can delete the ACL itself */
1734 a = pool_elt_at_index (am->macip_acls, acl_list_index);
1737 vec_free (a->rules);
1739 pool_put (am->macip_acls, a);
1745 macip_acl_interface_add_del_acl (u32 sw_if_index, u8 is_add,
1748 acl_main_t *am = &acl_main;
1752 rv = macip_acl_interface_add_acl (am, sw_if_index, acl_list_index);
1756 rv = macip_acl_interface_del_acl (am, sw_if_index);
1762 * If the client does not allocate enough memory for a variable-length
1763 * message, and then proceed to use it as if the full memory allocated,
1764 * absent the check we happily consume that on the VPP side, and go
1765 * along as if nothing happened. However, the resulting
1766 * effects range from just garbage in the API decode
1767 * (because the decoder snoops too far), to potential memory
1770 * This verifies that the actual length of the message is
1771 * at least expected_len, and complains loudly if it is not.
1773 * A failing check here is 100% a software bug on the API user side,
1774 * so we might as well yell.
1778 verify_message_len (void *mp, u64 expected_len, char *where)
1780 u32 supplied_len = vl_msg_api_get_msg_length (mp);
1781 if (supplied_len < expected_len)
1783 clib_warning ("%s: Supplied message length %d is less than expected %d",
1784 where, supplied_len, expected_len);
1793 /* API message handler */
1795 vl_api_acl_add_replace_t_handler (vl_api_acl_add_replace_t * mp)
1797 vl_api_acl_add_replace_reply_t *rmp;
1798 acl_main_t *am = &acl_main;
1800 u32 acl_list_index = ntohl (mp->acl_index);
1801 u32 acl_count = ntohl (mp->count);
1802 u64 expected_len = sizeof (*mp) + acl_count * sizeof (mp->r[0]);
1804 if (verify_message_len (mp, expected_len, "acl_add_replace"))
1806 rv = acl_add_list (acl_count, mp->r, &acl_list_index, mp->tag);
1810 rv = VNET_API_ERROR_INVALID_VALUE;
1814 REPLY_MACRO2(VL_API_ACL_ADD_REPLACE_REPLY,
1816 rmp->acl_index = htonl(acl_list_index);
1822 vl_api_acl_del_t_handler (vl_api_acl_del_t * mp)
1824 acl_main_t *am = &acl_main;
1825 vl_api_acl_del_reply_t *rmp;
1828 rv = acl_del_list (ntohl (mp->acl_index));
1830 REPLY_MACRO (VL_API_ACL_DEL_REPLY);
1835 vl_api_acl_stats_intf_counters_enable_t_handler
1836 (vl_api_acl_stats_intf_counters_enable_t * mp)
1838 acl_main_t *am = &acl_main;
1839 vl_api_acl_stats_intf_counters_enable_reply_t *rmp;
1842 rv = acl_stats_intf_counters_enable_disable (am, mp->enable);
1844 REPLY_MACRO (VL_API_ACL_DEL_REPLY);
1849 vl_api_acl_interface_add_del_t_handler (vl_api_acl_interface_add_del_t * mp)
1851 acl_main_t *am = &acl_main;
1852 vnet_interface_main_t *im = &am->vnet_main->interface_main;
1853 u32 sw_if_index = ntohl (mp->sw_if_index);
1854 vl_api_acl_interface_add_del_reply_t *rmp;
1857 if (pool_is_free_index (im->sw_interfaces, sw_if_index))
1858 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
1861 acl_interface_add_del_inout_acl (sw_if_index, mp->is_add,
1862 mp->is_input, ntohl (mp->acl_index));
1864 REPLY_MACRO (VL_API_ACL_INTERFACE_ADD_DEL_REPLY);
1868 vl_api_acl_interface_set_acl_list_t_handler
1869 (vl_api_acl_interface_set_acl_list_t * mp)
1871 acl_main_t *am = &acl_main;
1872 vl_api_acl_interface_set_acl_list_reply_t *rmp;
1875 vnet_interface_main_t *im = &am->vnet_main->interface_main;
1876 u32 sw_if_index = ntohl (mp->sw_if_index);
1878 if (pool_is_free_index (im->sw_interfaces, sw_if_index))
1879 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
1882 int may_clear_sessions = 1;
1883 for (i = 0; i < mp->count; i++)
1885 if (acl_is_not_defined (am, ntohl (mp->acls[i])))
1887 /* ACL does not exist, so we can not apply it */
1888 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
1893 u32 *in_acl_vec = 0;
1894 u32 *out_acl_vec = 0;
1895 for (i = 0; i < mp->count; i++)
1896 if (i < mp->n_input)
1897 vec_add1 (in_acl_vec, clib_net_to_host_u32 (mp->acls[i]));
1899 vec_add1 (out_acl_vec, clib_net_to_host_u32 (mp->acls[i]));
1902 acl_interface_set_inout_acl_list (am, sw_if_index, 0, out_acl_vec,
1903 &may_clear_sessions);
1905 || acl_interface_set_inout_acl_list (am, sw_if_index, 1,
1907 &may_clear_sessions);
1908 vec_free (in_acl_vec);
1909 vec_free (out_acl_vec);
1913 REPLY_MACRO (VL_API_ACL_INTERFACE_SET_ACL_LIST_REPLY);
1917 copy_acl_rule_to_api_rule (vl_api_acl_rule_t * api_rule, acl_rule_t * r)
1919 api_rule->is_permit = r->is_permit;
1920 ip_address_encode (&r->src, r->is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4,
1921 &api_rule->src_prefix.address);
1922 ip_address_encode (&r->dst, r->is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4,
1923 &api_rule->dst_prefix.address);
1924 api_rule->src_prefix.len = r->src_prefixlen;
1925 api_rule->dst_prefix.len = r->dst_prefixlen;
1926 api_rule->proto = r->proto;
1927 api_rule->srcport_or_icmptype_first = htons (r->src_port_or_type_first);
1928 api_rule->srcport_or_icmptype_last = htons (r->src_port_or_type_last);
1929 api_rule->dstport_or_icmpcode_first = htons (r->dst_port_or_code_first);
1930 api_rule->dstport_or_icmpcode_last = htons (r->dst_port_or_code_last);
1931 api_rule->tcp_flags_mask = r->tcp_flags_mask;
1932 api_rule->tcp_flags_value = r->tcp_flags_value;
1936 send_acl_details (acl_main_t * am, vl_api_registration_t * reg,
1937 acl_list_t * acl, u32 context)
1939 vl_api_acl_details_t *mp;
1940 vl_api_acl_rule_t *rules;
1942 acl_rule_t *acl_rules = acl->rules;
1943 int msg_size = sizeof (*mp) + sizeof (mp->r[0]) * vec_len (acl_rules);
1945 mp = vl_msg_api_alloc (msg_size);
1946 clib_memset (mp, 0, msg_size);
1947 mp->_vl_msg_id = ntohs (VL_API_ACL_DETAILS + am->msg_id_base);
1949 /* fill in the message */
1950 mp->context = context;
1951 mp->count = htonl (vec_len (acl_rules));
1952 mp->acl_index = htonl (acl - am->acls);
1953 snprintf ((char *) mp->tag, sizeof (mp->tag), "%s", acl->tag);
1954 // clib_memcpy (mp->r, acl->rules, acl->count * sizeof(acl->rules[0]));
1956 for (i = 0; i < vec_len (acl_rules); i++)
1958 copy_acl_rule_to_api_rule (&rules[i], &acl_rules[i]);
1961 vl_api_send_msg (reg, (u8 *) mp);
1966 vl_api_acl_dump_t_handler (vl_api_acl_dump_t * mp)
1968 acl_main_t *am = &acl_main;
1972 vl_api_registration_t *reg;
1974 reg = vl_api_client_index_to_registration (mp->client_index);
1978 if (mp->acl_index == ~0)
1981 /* Just dump all ACLs */
1982 pool_foreach (acl, am->acls)
1984 send_acl_details(am, reg, acl, mp->context);
1990 acl_index = ntohl (mp->acl_index);
1991 if (!pool_is_free_index (am->acls, acl_index))
1993 acl = pool_elt_at_index (am->acls, acl_index);
1994 send_acl_details (am, reg, acl, mp->context);
2000 /* FIXME API: should we signal an error here at all ? */
2006 send_acl_interface_list_details (acl_main_t * am,
2007 vl_api_registration_t * reg,
2008 u32 sw_if_index, u32 context)
2010 vl_api_acl_interface_list_details_t *mp;
2017 vec_validate (am->input_acl_vec_by_sw_if_index, sw_if_index);
2018 vec_validate (am->output_acl_vec_by_sw_if_index, sw_if_index);
2020 n_input = vec_len (am->input_acl_vec_by_sw_if_index[sw_if_index]);
2021 n_output = vec_len (am->output_acl_vec_by_sw_if_index[sw_if_index]);
2022 count = n_input + n_output;
2024 msg_size = sizeof (*mp);
2025 msg_size += sizeof (mp->acls[0]) * count;
2027 mp = vl_msg_api_alloc (msg_size);
2028 clib_memset (mp, 0, msg_size);
2030 ntohs (VL_API_ACL_INTERFACE_LIST_DETAILS + am->msg_id_base);
2032 /* fill in the message */
2033 mp->context = context;
2034 mp->sw_if_index = htonl (sw_if_index);
2036 mp->n_input = n_input;
2037 for (i = 0; i < n_input; i++)
2039 mp->acls[i] = htonl (am->input_acl_vec_by_sw_if_index[sw_if_index][i]);
2041 for (i = 0; i < n_output; i++)
2043 mp->acls[n_input + i] =
2044 htonl (am->output_acl_vec_by_sw_if_index[sw_if_index][i]);
2046 vl_api_send_msg (reg, (u8 *) mp);
2050 vl_api_acl_interface_list_dump_t_handler (vl_api_acl_interface_list_dump_t *
2053 acl_main_t *am = &acl_main;
2054 vnet_sw_interface_t *swif;
2055 vnet_interface_main_t *im = &am->vnet_main->interface_main;
2058 vl_api_registration_t *reg;
2060 reg = vl_api_client_index_to_registration (mp->client_index);
2064 if (mp->sw_if_index == ~0)
2067 pool_foreach (swif, im->sw_interfaces)
2069 send_acl_interface_list_details(am, reg, swif->sw_if_index, mp->context);
2075 sw_if_index = ntohl (mp->sw_if_index);
2076 if (!pool_is_free_index (im->sw_interfaces, sw_if_index))
2077 send_acl_interface_list_details (am, reg, sw_if_index, mp->context);
2081 /* MACIP ACL API handlers */
2084 vl_api_macip_acl_add_t_handler (vl_api_macip_acl_add_t * mp)
2086 vl_api_macip_acl_add_reply_t *rmp;
2087 acl_main_t *am = &acl_main;
2089 u32 acl_list_index = ~0;
2090 u32 acl_count = ntohl (mp->count);
2091 u64 expected_len = sizeof (*mp) + acl_count * sizeof (mp->r[0]);
2093 if (verify_message_len (mp, expected_len, "macip_acl_add"))
2095 rv = macip_acl_add_list (acl_count, mp->r, &acl_list_index, mp->tag);
2099 rv = VNET_API_ERROR_INVALID_VALUE;
2103 REPLY_MACRO2(VL_API_MACIP_ACL_ADD_REPLY,
2105 rmp->acl_index = htonl(acl_list_index);
2111 vl_api_macip_acl_add_replace_t_handler (vl_api_macip_acl_add_replace_t * mp)
2113 vl_api_macip_acl_add_replace_reply_t *rmp;
2114 acl_main_t *am = &acl_main;
2116 u32 acl_list_index = ntohl (mp->acl_index);
2117 u32 acl_count = ntohl (mp->count);
2118 u64 expected_len = sizeof (*mp) + acl_count * sizeof (mp->r[0]);
2120 if (verify_message_len (mp, expected_len, "macip_acl_add_replace"))
2122 rv = macip_acl_add_list (acl_count, mp->r, &acl_list_index, mp->tag);
2126 rv = VNET_API_ERROR_INVALID_VALUE;
2130 REPLY_MACRO2(VL_API_MACIP_ACL_ADD_REPLACE_REPLY,
2132 rmp->acl_index = htonl(acl_list_index);
2138 vl_api_macip_acl_del_t_handler (vl_api_macip_acl_del_t * mp)
2140 acl_main_t *am = &acl_main;
2141 vl_api_macip_acl_del_reply_t *rmp;
2144 rv = macip_acl_del_list (ntohl (mp->acl_index));
2146 REPLY_MACRO (VL_API_MACIP_ACL_DEL_REPLY);
2150 vl_api_macip_acl_interface_add_del_t_handler
2151 (vl_api_macip_acl_interface_add_del_t * mp)
2153 acl_main_t *am = &acl_main;
2154 vl_api_macip_acl_interface_add_del_reply_t *rmp;
2156 vnet_interface_main_t *im = &am->vnet_main->interface_main;
2157 u32 sw_if_index = ntohl (mp->sw_if_index);
2159 if (pool_is_free_index (im->sw_interfaces, sw_if_index))
2160 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
2163 macip_acl_interface_add_del_acl (ntohl (mp->sw_if_index), mp->is_add,
2164 ntohl (mp->acl_index));
2166 REPLY_MACRO (VL_API_MACIP_ACL_INTERFACE_ADD_DEL_REPLY);
2170 send_macip_acl_details (acl_main_t * am, vl_api_registration_t * reg,
2171 macip_acl_list_t * acl, u32 context)
2173 vl_api_macip_acl_details_t *mp;
2174 vl_api_macip_acl_rule_t *rules;
2175 macip_acl_rule_t *r;
2177 int msg_size = sizeof (*mp) + (acl ? sizeof (mp->r[0]) * acl->count : 0);
2179 mp = vl_msg_api_alloc (msg_size);
2180 clib_memset (mp, 0, msg_size);
2181 mp->_vl_msg_id = ntohs (VL_API_MACIP_ACL_DETAILS + am->msg_id_base);
2183 /* fill in the message */
2184 mp->context = context;
2187 snprintf ((char *) mp->tag, sizeof (mp->tag), "%s", acl->tag);
2188 mp->count = htonl (acl->count);
2189 mp->acl_index = htonl (acl - am->macip_acls);
2191 for (i = 0; i < acl->count; i++)
2194 rules[i].is_permit = r->is_permit;
2195 mac_address_encode ((mac_address_t *) & r->src_mac,
2197 mac_address_encode ((mac_address_t *) & r->src_mac_mask,
2198 rules[i].src_mac_mask);
2199 ip_address_encode (&r->src_ip_addr,
2200 r->is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4,
2201 &rules[i].src_prefix.address);
2202 rules[i].src_prefix.len = r->src_prefixlen;
2207 /* No martini, no party - no ACL applied to this interface. */
2212 vl_api_send_msg (reg, (u8 *) mp);
2217 vl_api_macip_acl_dump_t_handler (vl_api_macip_acl_dump_t * mp)
2219 acl_main_t *am = &acl_main;
2220 macip_acl_list_t *acl;
2222 vl_api_registration_t *reg;
2224 reg = vl_api_client_index_to_registration (mp->client_index);
2228 if (mp->acl_index == ~0)
2230 /* Just dump all ACLs for now, with sw_if_index = ~0 */
2232 pool_foreach (acl, am->macip_acls)
2234 send_macip_acl_details (am, reg, acl, mp->context);
2240 u32 acl_index = ntohl (mp->acl_index);
2241 if (!pool_is_free_index (am->macip_acls, acl_index))
2243 acl = pool_elt_at_index (am->macip_acls, acl_index);
2244 send_macip_acl_details (am, reg, acl, mp->context);
2250 vl_api_macip_acl_interface_get_t_handler (vl_api_macip_acl_interface_get_t *
2253 acl_main_t *am = &acl_main;
2254 vl_api_macip_acl_interface_get_reply_t *rmp;
2255 u32 count = vec_len (am->macip_acl_by_sw_if_index);
2256 int msg_size = sizeof (*rmp) + sizeof (rmp->acls[0]) * count;
2257 vl_api_registration_t *reg;
2260 reg = vl_api_client_index_to_registration (mp->client_index);
2264 rmp = vl_msg_api_alloc (msg_size);
2265 clib_memset (rmp, 0, msg_size);
2267 ntohs (VL_API_MACIP_ACL_INTERFACE_GET_REPLY + am->msg_id_base);
2268 rmp->context = mp->context;
2269 rmp->count = htonl (count);
2270 for (i = 0; i < count; i++)
2272 rmp->acls[i] = htonl (am->macip_acl_by_sw_if_index[i]);
2275 vl_api_send_msg (reg, (u8 *) rmp);
2279 send_macip_acl_interface_list_details (acl_main_t * am,
2280 vl_api_registration_t * reg,
2282 u32 acl_index, u32 context)
2284 vl_api_macip_acl_interface_list_details_t *rmp;
2285 /* at this time there is only ever 1 mac ip acl per interface */
2286 int msg_size = sizeof (*rmp) + sizeof (rmp->acls[0]);
2288 rmp = vl_msg_api_alloc (msg_size);
2289 clib_memset (rmp, 0, msg_size);
2291 ntohs (VL_API_MACIP_ACL_INTERFACE_LIST_DETAILS + am->msg_id_base);
2293 /* fill in the message */
2294 rmp->context = context;
2296 rmp->sw_if_index = htonl (sw_if_index);
2297 rmp->acls[0] = htonl (acl_index);
2299 vl_api_send_msg (reg, (u8 *) rmp);
2303 vl_api_macip_acl_interface_list_dump_t_handler
2304 (vl_api_macip_acl_interface_list_dump_t * mp)
2306 vl_api_registration_t *reg;
2307 acl_main_t *am = &acl_main;
2308 u32 sw_if_index = ntohl (mp->sw_if_index);
2310 reg = vl_api_client_index_to_registration (mp->client_index);
2314 if (sw_if_index == ~0)
2316 vec_foreach_index (sw_if_index, am->macip_acl_by_sw_if_index)
2318 if (~0 != am->macip_acl_by_sw_if_index[sw_if_index])
2320 send_macip_acl_interface_list_details (am, reg, sw_if_index,
2322 macip_acl_by_sw_if_index
2330 if (vec_len (am->macip_acl_by_sw_if_index) > sw_if_index)
2332 send_macip_acl_interface_list_details (am, reg, sw_if_index,
2333 am->macip_acl_by_sw_if_index
2334 [sw_if_index], mp->context);
2340 vl_api_acl_interface_set_etype_whitelist_t_handler
2341 (vl_api_acl_interface_set_etype_whitelist_t * mp)
2343 acl_main_t *am = &acl_main;
2344 vl_api_acl_interface_set_etype_whitelist_reply_t *rmp;
2347 vnet_interface_main_t *im = &am->vnet_main->interface_main;
2348 u32 sw_if_index = ntohl (mp->sw_if_index);
2349 u16 *vec_in = 0, *vec_out = 0;
2351 if (pool_is_free_index (im->sw_interfaces, sw_if_index))
2352 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
2355 for (i = 0; i < mp->count; i++)
2357 if (i < mp->n_input)
2358 vec_add1 (vec_in, ntohs (mp->whitelist[i]));
2360 vec_add1 (vec_out, ntohs (mp->whitelist[i]));
2362 rv = acl_set_etype_whitelists (am, sw_if_index, vec_in, vec_out);
2365 REPLY_MACRO (VL_API_ACL_INTERFACE_SET_ETYPE_WHITELIST_REPLY);
2369 send_acl_interface_etype_whitelist_details (acl_main_t * am,
2370 vl_api_registration_t * reg,
2371 u32 sw_if_index, u32 context)
2373 vl_api_acl_interface_etype_whitelist_details_t *mp;
2380 u16 *whitelist_in = 0;
2381 u16 *whitelist_out = 0;
2383 if (intf_has_etype_whitelist (am, sw_if_index, 0))
2385 vec_elt (am->output_etype_whitelist_by_sw_if_index, sw_if_index);
2387 if (intf_has_etype_whitelist (am, sw_if_index, 1))
2389 vec_elt (am->input_etype_whitelist_by_sw_if_index, sw_if_index);
2391 if ((0 == whitelist_in) && (0 == whitelist_out))
2392 return; /* nothing to do */
2394 n_input = vec_len (whitelist_in);
2395 n_output = vec_len (whitelist_out);
2396 count = n_input + n_output;
2398 msg_size = sizeof (*mp);
2399 msg_size += sizeof (mp->whitelist[0]) * count;
2401 mp = vl_msg_api_alloc (msg_size);
2402 clib_memset (mp, 0, msg_size);
2404 ntohs (VL_API_ACL_INTERFACE_ETYPE_WHITELIST_DETAILS + am->msg_id_base);
2406 /* fill in the message */
2407 mp->context = context;
2408 mp->sw_if_index = htonl (sw_if_index);
2410 mp->n_input = n_input;
2411 for (i = 0; i < n_input; i++)
2413 mp->whitelist[i] = htons (whitelist_in[i]);
2415 for (i = 0; i < n_output; i++)
2417 mp->whitelist[n_input + i] = htons (whitelist_out[i]);
2419 vl_api_send_msg (reg, (u8 *) mp);
2424 vl_api_acl_interface_etype_whitelist_dump_t_handler
2425 (vl_api_acl_interface_list_dump_t * mp)
2427 acl_main_t *am = &acl_main;
2428 vnet_sw_interface_t *swif;
2429 vnet_interface_main_t *im = &am->vnet_main->interface_main;
2432 vl_api_registration_t *reg;
2434 reg = vl_api_client_index_to_registration (mp->client_index);
2438 if (mp->sw_if_index == ~0)
2441 pool_foreach (swif, im->sw_interfaces)
2443 send_acl_interface_etype_whitelist_details(am, reg, swif->sw_if_index, mp->context);
2449 sw_if_index = ntohl (mp->sw_if_index);
2450 if (!pool_is_free_index (im->sw_interfaces, sw_if_index))
2451 send_acl_interface_etype_whitelist_details (am, reg, sw_if_index,
2457 vl_api_acl_plugin_use_hash_lookup_set_t_handler (
2458 vl_api_acl_plugin_use_hash_lookup_set_t *mp)
2460 acl_main_t *am = &acl_main;
2461 vl_api_acl_plugin_use_hash_lookup_set_reply_t *rmp;
2462 vl_api_registration_t *reg;
2465 reg = vl_api_client_index_to_registration (mp->client_index);
2469 am->use_hash_acl_matching = mp->enable;
2470 REPLY_MACRO (VL_API_ACL_PLUGIN_USE_HASH_LOOKUP_SET_REPLY);
2474 vl_api_acl_plugin_use_hash_lookup_get_t_handler (
2475 vl_api_acl_plugin_use_hash_lookup_get_t *mp)
2477 acl_main_t *am = &acl_main;
2478 vl_api_acl_plugin_use_hash_lookup_get_reply_t *rmp;
2479 int msg_size = sizeof (*rmp);
2480 vl_api_registration_t *reg;
2482 reg = vl_api_client_index_to_registration (mp->client_index);
2486 rmp = vl_msg_api_alloc (msg_size);
2487 clib_memset (rmp, 0, msg_size);
2489 ntohs (VL_API_ACL_PLUGIN_USE_HASH_LOOKUP_GET_REPLY + am->msg_id_base);
2490 rmp->context = mp->context;
2491 rmp->enable = am->use_hash_acl_matching;
2492 vl_api_send_msg (reg, (u8 *) rmp);
2496 acl_set_timeout_sec (int timeout_type, u32 value)
2498 acl_main_t *am = &acl_main;
2499 clib_time_t *ct = &am->vlib_main->clib_time;
2501 if (timeout_type < ACL_N_TIMEOUTS)
2503 am->session_timeout_sec[timeout_type] = value;
2507 clib_warning ("Unknown timeout type %d", timeout_type);
2510 am->session_timeout[timeout_type] =
2511 (u64) (((f64) value) / ct->seconds_per_clock);
2515 acl_set_session_max_entries (u32 value)
2517 acl_main_t *am = &acl_main;
2518 am->fa_conn_table_max_entries = value;
2522 acl_set_skip_ipv6_eh (u32 eh, u32 value)
2524 acl_main_t *am = &acl_main;
2526 if ((eh < 256) && (value < 2))
2528 am->fa_ipv6_known_eh_bitmap =
2529 clib_bitmap_set (am->fa_ipv6_known_eh_bitmap, eh, value);
2537 static clib_error_t *
2538 acl_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
2540 acl_main_t *am = &acl_main;
2543 int may_clear_sessions = 1;
2544 vlib_process_signal_event (am->vlib_main, am->fa_cleaner_node_index,
2545 ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX,
2547 /* also unapply any ACLs in case the users did not do so. */
2548 macip_acl_interface_del_acl (am, sw_if_index);
2549 acl_interface_reset_inout_acls (sw_if_index, 0, &may_clear_sessions);
2550 acl_interface_reset_inout_acls (sw_if_index, 1, &may_clear_sessions);
2555 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (acl_sw_interface_add_del);
2559 static clib_error_t *
2560 acl_set_aclplugin_fn (vlib_main_t * vm,
2561 unformat_input_t * input, vlib_cli_command_t * cmd)
2563 clib_error_t *error = 0;
2567 uword memory_size = 0;
2568 acl_main_t *am = &acl_main;
2570 if (unformat (input, "skip-ipv6-extension-header %u %u", &eh_val, &val))
2572 if (!acl_set_skip_ipv6_eh (eh_val, val))
2574 error = clib_error_return (0, "expecting eh=0..255, value=0..1");
2578 if (unformat (input, "use-hash-acl-matching %u", &val))
2580 am->use_hash_acl_matching = (val != 0);
2583 if (unformat (input, "l4-match-nonfirst-fragment %u", &val))
2585 am->l4_match_nonfirst_fragment = (val != 0);
2588 if (unformat (input, "reclassify-sessions %u", &val))
2590 am->reclassify_sessions = (val != 0);
2593 if (unformat (input, "event-trace"))
2595 if (!unformat (input, "%u", &val))
2597 error = clib_error_return (0,
2598 "expecting trace level, got `%U`",
2599 format_unformat_error, input);
2604 am->trace_acl = val;
2608 if (unformat (input, "heap"))
2610 if (unformat (input, "main"))
2612 if (unformat (input, "validate %u", &val))
2613 clib_warning ("ACL local heap is deprecated");
2614 else if (unformat (input, "trace %u", &val))
2615 clib_warning ("ACL local heap is deprecated");
2618 else if (unformat (input, "hash"))
2620 if (unformat (input, "validate %u", &val))
2621 clib_warning ("ACL local heap is deprecated");
2622 else if (unformat (input, "trace %u", &val))
2623 clib_warning ("ACL local heap is deprecated");
2628 if (unformat (input, "session"))
2630 if (unformat (input, "table"))
2632 /* The commands here are for tuning/testing. No user-serviceable parts inside */
2633 if (unformat (input, "max-entries"))
2635 if (!unformat (input, "%u", &val))
2637 error = clib_error_return (0,
2638 "expecting maximum number of entries, got `%U`",
2639 format_unformat_error, input);
2644 acl_set_session_max_entries (val);
2648 if (unformat (input, "hash-table-buckets"))
2650 if (!unformat (input, "%u", &val))
2652 error = clib_error_return (0,
2653 "expecting maximum number of hash table buckets, got `%U`",
2654 format_unformat_error, input);
2659 am->fa_conn_table_hash_num_buckets = val;
2663 if (unformat (input, "hash-table-memory"))
2665 if (!unformat (input, "%U", unformat_memory_size, &memory_size))
2667 error = clib_error_return (0,
2668 "expecting maximum amount of hash table memory, got `%U`",
2669 format_unformat_error, input);
2674 am->fa_conn_table_hash_memory_size = memory_size;
2678 if (unformat (input, "event-trace"))
2680 if (!unformat (input, "%u", &val))
2682 error = clib_error_return (0,
2683 "expecting trace level, got `%U`",
2684 format_unformat_error, input);
2689 am->trace_sessions = val;
2695 if (unformat (input, "timeout"))
2697 if (unformat (input, "udp"))
2699 if (unformat (input, "idle"))
2701 if (!unformat (input, "%u", &timeout))
2703 error = clib_error_return (0,
2704 "expecting timeout value in seconds, got `%U`",
2705 format_unformat_error,
2711 acl_set_timeout_sec (ACL_TIMEOUT_UDP_IDLE, timeout);
2716 if (unformat (input, "tcp"))
2718 if (unformat (input, "idle"))
2720 if (!unformat (input, "%u", &timeout))
2722 error = clib_error_return (0,
2723 "expecting timeout value in seconds, got `%U`",
2724 format_unformat_error,
2730 acl_set_timeout_sec (ACL_TIMEOUT_TCP_IDLE, timeout);
2734 if (unformat (input, "transient"))
2736 if (!unformat (input, "%u", &timeout))
2738 error = clib_error_return (0,
2739 "expecting timeout value in seconds, got `%U`",
2740 format_unformat_error,
2746 acl_set_timeout_sec (ACL_TIMEOUT_TCP_TRANSIENT,
2760 my_format_mac_address (u8 * s, va_list * args)
2762 u8 *a = va_arg (*args, u8 *);
2763 return format (s, "%02x:%02x:%02x:%02x:%02x:%02x",
2764 a[0], a[1], a[2], a[3], a[4], a[5]);
2768 my_macip_acl_rule_t_pretty_format (u8 * out, va_list * args)
2770 macip_acl_rule_t *a = va_arg (*args, macip_acl_rule_t *);
2772 out = format (out, "%s action %d ip %U/%d mac %U mask %U",
2773 a->is_ipv6 ? "ipv6" : "ipv4", a->is_permit,
2774 format_ip46_address, &a->src_ip_addr,
2775 a->is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4,
2777 my_format_mac_address, a->src_mac,
2778 my_format_mac_address, a->src_mac_mask);
2783 macip_acl_print (acl_main_t * am, u32 macip_acl_index)
2785 vlib_main_t *vm = am->vlib_main;
2788 /* Don't try to print someone else's memory */
2789 if (macip_acl_index >= vec_len (am->macip_acls))
2792 macip_acl_list_t *a = vec_elt_at_index (am->macip_acls, macip_acl_index);
2793 int free_pool_slot = pool_is_free_index (am->macip_acls, macip_acl_index);
2795 vlib_cli_output (vm,
2796 "MACIP acl_index: %d, count: %d (true len %d) tag {%s} is free pool slot: %d\n",
2797 macip_acl_index, a->count, vec_len (a->rules), a->tag,
2799 vlib_cli_output (vm,
2800 " ip4_table_index %d, ip6_table_index %d, l2_table_index %d\n",
2801 a->ip4_table_index, a->ip6_table_index, a->l2_table_index);
2802 vlib_cli_output (vm,
2803 " out_ip4_table_index %d, out_ip6_table_index %d, out_l2_table_index %d\n",
2804 a->out_ip4_table_index, a->out_ip6_table_index,
2805 a->out_l2_table_index);
2806 for (i = 0; i < vec_len (a->rules); i++)
2807 vlib_cli_output (vm, " rule %d: %U\n", i,
2808 my_macip_acl_rule_t_pretty_format,
2809 vec_elt_at_index (a->rules, i));
2813 static clib_error_t *
2814 acl_set_aclplugin_interface_fn (vlib_main_t * vm,
2815 unformat_input_t * input,
2816 vlib_cli_command_t * cmd)
2818 unformat_input_t _line_input, *line_input = &_line_input;
2819 u32 sw_if_index, is_add, is_input, acl_index;
2821 is_add = is_input = 1;
2822 acl_index = sw_if_index = ~0;
2824 if (!unformat_user (input, unformat_line_input, line_input))
2827 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2829 if (unformat (line_input, "%U",
2830 unformat_vnet_sw_interface, vnet_get_main (),
2833 else if (unformat (line_input, "add"))
2835 else if (unformat (line_input, "del"))
2837 else if (unformat (line_input, "acl %d", &acl_index))
2839 else if (unformat (line_input, "input"))
2841 else if (unformat (line_input, "output"))
2847 unformat_free (line_input);
2848 if (~0 == sw_if_index)
2849 return (clib_error_return (0, "invalid interface"));
2850 if (~0 == acl_index)
2851 return (clib_error_return (0, "invalid acl"));
2853 acl_interface_add_del_inout_acl (sw_if_index, is_add, is_input, acl_index);
2858 #define vec_validate_acl_rules(v, idx) \
2860 if (vec_len(v) < idx+1) { \
2861 vec_validate(v, idx); \
2862 v[idx].is_permit = 0x1; \
2863 v[idx].srcport_or_icmptype_last = 0xffff; \
2864 v[idx].dstport_or_icmpcode_last = 0xffff; \
2868 static clib_error_t *
2869 acl_set_aclplugin_acl_fn (vlib_main_t * vm,
2870 unformat_input_t * input, vlib_cli_command_t * cmd)
2872 unformat_input_t _line_input, *line_input = &_line_input;
2873 vl_api_acl_rule_t *rules = 0;
2876 int n_rules_override = -1;
2881 u32 tcpflags, tcpmask;
2882 ip_prefix_t src, dst;
2885 if (!unformat_user (input, unformat_line_input, line_input))
2888 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
2890 if (unformat (line_input, "permit+reflect"))
2892 vec_validate_acl_rules (rules, rule_idx);
2893 rules[rule_idx].is_permit = 2;
2895 else if (unformat (line_input, "permit"))
2897 vec_validate_acl_rules (rules, rule_idx);
2898 rules[rule_idx].is_permit = 1;
2900 else if (unformat (line_input, "deny"))
2902 vec_validate_acl_rules (rules, rule_idx);
2903 rules[rule_idx].is_permit = 0;
2905 else if (unformat (line_input, "count %d", &n_rules_override))
2907 /* we will use this later */
2909 else if (unformat (line_input, "action %d", &action))
2911 vec_validate_acl_rules (rules, rule_idx);
2912 rules[rule_idx].is_permit = action;
2914 else if (unformat (line_input, "src %U", unformat_ip_prefix, &src))
2916 vec_validate_acl_rules (rules, rule_idx);
2917 ip_prefix_encode2 (&src, &rules[rule_idx].src_prefix);
2919 else if (unformat (line_input, "dst %U", unformat_ip_prefix, &dst))
2921 vec_validate_acl_rules (rules, rule_idx);
2922 ip_prefix_encode2 (&dst, &rules[rule_idx].dst_prefix);
2924 else if (unformat (line_input, "sport %d-%d", &port1, &port2))
2926 vec_validate_acl_rules (rules, rule_idx);
2927 rules[rule_idx].srcport_or_icmptype_first = htons (port1);
2928 rules[rule_idx].srcport_or_icmptype_last = htons (port2);
2930 else if (unformat (line_input, "sport %d", &port1))
2932 vec_validate_acl_rules (rules, rule_idx);
2933 rules[rule_idx].srcport_or_icmptype_first = htons (port1);
2934 rules[rule_idx].srcport_or_icmptype_last = htons (port1);
2936 else if (unformat (line_input, "dport %d-%d", &port1, &port2))
2938 vec_validate_acl_rules (rules, rule_idx);
2939 rules[rule_idx].dstport_or_icmpcode_first = htons (port1);
2940 rules[rule_idx].dstport_or_icmpcode_last = htons (port2);
2942 else if (unformat (line_input, "dport %d", &port1))
2944 vec_validate_acl_rules (rules, rule_idx);
2945 rules[rule_idx].dstport_or_icmpcode_first = htons (port1);
2946 rules[rule_idx].dstport_or_icmpcode_last = htons (port1);
2948 else if (unformat (line_input, "tcpflags %d %d", &tcpflags, &tcpmask))
2950 vec_validate_acl_rules (rules, rule_idx);
2951 rules[rule_idx].tcp_flags_value = tcpflags;
2952 rules[rule_idx].tcp_flags_mask = tcpmask;
2955 if (unformat (line_input, "tcpflags %d mask %d", &tcpflags, &tcpmask))
2957 vec_validate_acl_rules (rules, rule_idx);
2958 rules[rule_idx].tcp_flags_value = tcpflags;
2959 rules[rule_idx].tcp_flags_mask = tcpmask;
2961 else if (unformat (line_input, "proto %d", &proto))
2963 vec_validate_acl_rules (rules, rule_idx);
2964 rules[rule_idx].proto = proto;
2966 else if (unformat (line_input, "tag %s", &tag))
2969 else if (unformat (line_input, ","))
2972 vec_validate_acl_rules (rules, rule_idx);
2980 vec_add (tag, "cli", 4);
2982 rv = acl_add_list (vec_len (rules), rules, &acl_index, tag);
2987 unformat_free (line_input);
2989 return (clib_error_return (0, "failed"));
2991 vlib_cli_output (vm, "ACL index:%d", acl_index);
2996 static clib_error_t *
2997 acl_show_aclplugin_macip_acl_fn (vlib_main_t * vm,
2999 input, vlib_cli_command_t * cmd)
3001 clib_error_t *error = 0;
3002 acl_main_t *am = &acl_main;
3006 (void) unformat (input, "index %u", &acl_index);
3008 for (i = 0; i < vec_len (am->macip_acls); i++)
3010 /* Don't attempt to show the ACLs that do not exist */
3011 if (pool_is_free_index (am->macip_acls, i))
3014 if ((acl_index != ~0) && (acl_index != i))
3019 macip_acl_print (am, i);
3020 if (i < vec_len (am->sw_if_index_vec_by_macip_acl))
3022 vlib_cli_output (vm, " applied on sw_if_index(s): %U\n",
3024 vec_elt (am->sw_if_index_vec_by_macip_acl, i),
3032 static clib_error_t *
3033 acl_show_aclplugin_macip_interface_fn (vlib_main_t * vm,
3035 input, vlib_cli_command_t * cmd)
3037 clib_error_t *error = 0;
3038 acl_main_t *am = &acl_main;
3040 for (i = 0; i < vec_len (am->macip_acl_by_sw_if_index); i++)
3042 vlib_cli_output (vm, " sw_if_index %d: %d\n", i,
3043 vec_elt (am->macip_acl_by_sw_if_index, i));
3049 acl_plugin_show_acl (acl_main_t * am, u32 acl_index)
3052 vlib_main_t *vm = am->vlib_main;
3054 for (i = 0; i < vec_len (am->acls); i++)
3056 if (acl_is_not_defined (am, i))
3058 /* don't attempt to show the ACLs that do not exist */
3061 if ((acl_index != ~0) && (acl_index != i))
3065 acl_print_acl (vm, am, i);
3067 if (i < vec_len (am->input_sw_if_index_vec_by_acl))
3069 vlib_cli_output (vm, " applied inbound on sw_if_index: %U\n",
3070 format_vec32, am->input_sw_if_index_vec_by_acl[i],
3073 if (i < vec_len (am->output_sw_if_index_vec_by_acl))
3075 vlib_cli_output (vm, " applied outbound on sw_if_index: %U\n",
3076 format_vec32, am->output_sw_if_index_vec_by_acl[i],
3079 if (i < vec_len (am->lc_index_vec_by_acl))
3081 vlib_cli_output (vm, " used in lookup context index: %U\n",
3082 format_vec32, am->lc_index_vec_by_acl[i], "%d");
3087 static clib_error_t *
3088 acl_show_aclplugin_acl_fn (vlib_main_t * vm,
3089 unformat_input_t * input, vlib_cli_command_t * cmd)
3091 clib_error_t *error = 0;
3092 acl_main_t *am = &acl_main;
3095 (void) unformat (input, "index %u", &acl_index);
3097 acl_plugin_show_acl (am, acl_index);
3101 static clib_error_t *
3102 acl_show_aclplugin_lookup_context_fn (vlib_main_t * vm,
3103 unformat_input_t * input,
3104 vlib_cli_command_t * cmd)
3106 clib_error_t *error = 0;
3109 (void) unformat (input, "index %u", &lc_index);
3111 acl_plugin_show_lookup_context (lc_index);
3115 static clib_error_t *
3116 acl_show_aclplugin_lookup_user_fn (vlib_main_t * vm,
3117 unformat_input_t * input,
3118 vlib_cli_command_t * cmd)
3120 clib_error_t *error = 0;
3123 (void) unformat (input, "index %u", &lc_index);
3125 acl_plugin_show_lookup_user (lc_index);
3131 acl_plugin_show_interface (acl_main_t * am, u32 sw_if_index, int show_acl,
3134 vlib_main_t *vm = am->vlib_main;
3137 for (swi = 0; (swi < vec_len (am->input_acl_vec_by_sw_if_index)) ||
3138 (swi < vec_len (am->output_acl_vec_by_sw_if_index)); swi++)
3140 /* if we need a particular interface, skip all the others */
3141 if ((sw_if_index != ~0) && (sw_if_index != swi))
3144 vlib_cli_output (vm, "sw_if_index %d:\n", swi);
3145 if (swi < vec_len (am->input_policy_epoch_by_sw_if_index))
3146 vlib_cli_output (vm, " input policy epoch: %x\n",
3147 vec_elt (am->input_policy_epoch_by_sw_if_index,
3149 if (swi < vec_len (am->output_policy_epoch_by_sw_if_index))
3150 vlib_cli_output (vm, " output policy epoch: %x\n",
3151 vec_elt (am->output_policy_epoch_by_sw_if_index,
3155 if (intf_has_etype_whitelist (am, swi, 1))
3157 vlib_cli_output (vm, " input etype whitelist: %U", format_vec16,
3158 am->input_etype_whitelist_by_sw_if_index[swi],
3161 if (intf_has_etype_whitelist (am, swi, 0))
3163 vlib_cli_output (vm, " output etype whitelist: %U", format_vec16,
3164 am->output_etype_whitelist_by_sw_if_index[swi],
3168 if ((swi < vec_len (am->input_acl_vec_by_sw_if_index)) &&
3169 (vec_len (am->input_acl_vec_by_sw_if_index[swi]) > 0))
3171 vlib_cli_output (vm, " input acl(s): %U", format_vec32,
3172 am->input_acl_vec_by_sw_if_index[swi], "%d");
3175 vlib_cli_output (vm, "\n");
3176 vec_foreach (pj, am->input_acl_vec_by_sw_if_index[swi])
3178 acl_print_acl (vm, am, *pj);
3180 vlib_cli_output (vm, "\n");
3184 if ((swi < vec_len (am->output_acl_vec_by_sw_if_index)) &&
3185 (vec_len (am->output_acl_vec_by_sw_if_index[swi]) > 0))
3187 vlib_cli_output (vm, " output acl(s): %U", format_vec32,
3188 am->output_acl_vec_by_sw_if_index[swi], "%d");
3191 vlib_cli_output (vm, "\n");
3192 vec_foreach (pj, am->output_acl_vec_by_sw_if_index[swi])
3194 acl_print_acl (vm, am, *pj);
3196 vlib_cli_output (vm, "\n");
3199 if (detail && (swi < vec_len (am->input_lc_index_by_sw_if_index)))
3201 vlib_cli_output (vm, " input lookup context index: %d",
3202 am->input_lc_index_by_sw_if_index[swi]);
3204 if (detail && (swi < vec_len (am->output_lc_index_by_sw_if_index)))
3206 vlib_cli_output (vm, " output lookup context index: %d",
3207 am->output_lc_index_by_sw_if_index[swi]);
3214 static clib_error_t *
3215 acl_show_aclplugin_decode_5tuple_fn (vlib_main_t * vm,
3216 unformat_input_t * input,
3217 vlib_cli_command_t * cmd)
3219 clib_error_t *error = 0;
3220 u64 five_tuple[6] = { 0, 0, 0, 0, 0, 0 };
3223 (input, "%llx %llx %llx %llx %llx %llx", &five_tuple[0], &five_tuple[1],
3224 &five_tuple[2], &five_tuple[3], &five_tuple[4], &five_tuple[5]))
3225 vlib_cli_output (vm, "5-tuple structure decode: %U\n\n",
3226 format_acl_plugin_5tuple, five_tuple);
3228 error = clib_error_return (0, "expecting 6 hex integers");
3233 static clib_error_t *
3234 acl_show_aclplugin_interface_fn (vlib_main_t * vm,
3236 input, vlib_cli_command_t * cmd)
3238 clib_error_t *error = 0;
3239 acl_main_t *am = &acl_main;
3241 u32 sw_if_index = ~0;
3242 (void) unformat (input, "sw_if_index %u", &sw_if_index);
3243 int show_acl = unformat (input, "acl");
3244 int detail = unformat (input, "detail");
3246 acl_plugin_show_interface (am, sw_if_index, show_acl, detail);
3250 static clib_error_t *
3251 acl_show_aclplugin_memory_fn (vlib_main_t * vm,
3252 unformat_input_t * input,
3253 vlib_cli_command_t * cmd)
3255 clib_error_t *error = 0;
3256 vlib_cli_output (vm, "ACL memory is now part of the main heap");
3261 acl_plugin_show_sessions (acl_main_t * am,
3262 u32 show_session_thread_id,
3263 u32 show_session_session_index)
3265 vlib_main_t *vm = am->vlib_main;
3267 vnet_interface_main_t *im = &am->vnet_main->interface_main;
3268 vnet_sw_interface_t *swif;
3269 u64 now = clib_cpu_time_now ();
3270 u64 clocks_per_second = am->vlib_main->clib_time.clocks_per_second;
3273 u64 n_adds = am->fa_session_total_adds;
3274 u64 n_dels = am->fa_session_total_dels;
3275 u64 n_deact = am->fa_session_total_deactivations;
3276 vlib_cli_output (vm, "Sessions total: add %lu - del %lu = %lu", n_adds,
3277 n_dels, n_adds - n_dels);
3278 vlib_cli_output (vm, "Sessions active: add %lu - deact %lu = %lu", n_adds,
3279 n_deact, n_adds - n_deact);
3280 vlib_cli_output (vm, "Sessions being purged: deact %lu - del %lu = %lu",
3281 n_deact, n_dels, n_deact - n_dels);
3283 vlib_cli_output (vm, "now: %lu clocks per second: %lu", now,
3285 vlib_cli_output (vm, "\n\nPer-thread data:");
3286 for (wk = 0; wk < vec_len (am->per_worker_data); wk++)
3288 acl_fa_per_worker_data_t *pw = &am->per_worker_data[wk];
3289 vlib_cli_output (vm, "Thread #%d:", wk);
3290 if (show_session_thread_id == wk
3291 && show_session_session_index < pool_len (pw->fa_sessions_pool))
3293 vlib_cli_output (vm, " session index %u:",
3294 show_session_session_index);
3295 fa_session_t *sess =
3296 pw->fa_sessions_pool + show_session_session_index;
3297 u64 *m = (u64 *) & sess->info;
3298 vlib_cli_output (vm,
3299 " info: %016llx %016llx %016llx %016llx %016llx %016llx",
3300 m[0], m[1], m[2], m[3], m[4], m[5]);
3301 vlib_cli_output (vm, " sw_if_index: %u", sess->sw_if_index);
3302 vlib_cli_output (vm, " tcp_flags_seen: %x",
3303 sess->tcp_flags_seen.as_u16);
3304 vlib_cli_output (vm, " last active time: %lu",
3305 sess->last_active_time);
3306 vlib_cli_output (vm, " thread index: %u", sess->thread_index);
3307 vlib_cli_output (vm, " link enqueue time: %lu",
3308 sess->link_enqueue_time);
3309 vlib_cli_output (vm, " link next index: %u",
3310 sess->link_next_idx);
3311 vlib_cli_output (vm, " link prev index: %u",
3312 sess->link_prev_idx);
3313 vlib_cli_output (vm, " link list id: %u", sess->link_list_id);
3315 vlib_cli_output (vm, " connection add/del stats:", wk);
3317 pool_foreach (swif, im->sw_interfaces)
3319 u32 sw_if_index = swif->sw_if_index;
3321 (sw_if_index < vec_len (pw->fa_session_adds_by_sw_if_index) ?
3322 pw->fa_session_adds_by_sw_if_index[sw_if_index] :
3325 (sw_if_index < vec_len (pw->fa_session_dels_by_sw_if_index) ?
3326 pw->fa_session_dels_by_sw_if_index[sw_if_index] :
3328 u64 n_epoch_changes =
3329 (sw_if_index < vec_len (pw->fa_session_epoch_change_by_sw_if_index) ?
3330 pw->fa_session_epoch_change_by_sw_if_index[sw_if_index] :
3332 vlib_cli_output (vm,
3333 " sw_if_index %d: add %lu - del %lu = %lu; epoch chg: %lu",
3343 vlib_cli_output (vm, " connection timeout type lists:", wk);
3345 for (tt = 0; tt < ACL_N_TIMEOUTS; tt++)
3347 u32 head_session_index = pw->fa_conn_list_head[tt];
3348 vlib_cli_output (vm, " fa_conn_list_head[%d]: %d", tt,
3349 head_session_index);
3350 if (~0 != head_session_index)
3352 fa_session_t *sess = pw->fa_sessions_pool + head_session_index;
3353 vlib_cli_output (vm, " last active time: %lu",
3354 sess->last_active_time);
3355 vlib_cli_output (vm, " link enqueue time: %lu",
3356 sess->link_enqueue_time);
3360 vlib_cli_output (vm, " Next expiry time: %lu", pw->next_expiry_time);
3361 vlib_cli_output (vm, " Requeue until time: %lu",
3362 pw->requeue_until_time);
3363 vlib_cli_output (vm, " Current time wait interval: %lu",
3364 pw->current_time_wait_interval);
3365 vlib_cli_output (vm, " Count of deleted sessions: %lu",
3366 pw->cnt_deleted_sessions);
3367 vlib_cli_output (vm, " Delete already deleted: %lu",
3368 pw->cnt_already_deleted_sessions);
3369 vlib_cli_output (vm, " Session timers restarted: %lu",
3370 pw->cnt_session_timer_restarted);
3371 vlib_cli_output (vm, " Swipe until this time: %lu",
3372 pw->swipe_end_time);
3373 vlib_cli_output (vm, " sw_if_index serviced bitmap: %U",
3374 format_bitmap_hex, pw->serviced_sw_if_index_bitmap);
3375 vlib_cli_output (vm, " pending clear intfc bitmap : %U",
3377 pw->pending_clear_sw_if_index_bitmap);
3378 vlib_cli_output (vm, " clear in progress: %u", pw->clear_in_process);
3379 vlib_cli_output (vm, " interrupt is pending: %d",
3380 pw->interrupt_is_pending);
3381 vlib_cli_output (vm, " interrupt is needed: %d",
3382 pw->interrupt_is_needed);
3383 vlib_cli_output (vm, " interrupt is unwanted: %d",
3384 pw->interrupt_is_unwanted);
3385 vlib_cli_output (vm, " interrupt generation: %d",
3386 pw->interrupt_generation);
3387 vlib_cli_output (vm, " received session change requests: %d",
3388 pw->rcvd_session_change_requests);
3389 vlib_cli_output (vm, " sent session change requests: %d",
3390 pw->sent_session_change_requests);
3392 vlib_cli_output (vm, "\n\nConn cleaner thread counters:");
3393 #define _(cnt, desc) vlib_cli_output(vm, " %20lu: %s", am->cnt, desc);
3394 foreach_fa_cleaner_counter;
3396 vlib_cli_output (vm, "Interrupt generation: %d",
3397 am->fa_interrupt_generation);
3398 vlib_cli_output (vm,
3399 "Sessions per interval: min %lu max %lu increment: %f ms current: %f ms",
3400 am->fa_min_deleted_sessions_per_interval,
3401 am->fa_max_deleted_sessions_per_interval,
3402 am->fa_cleaner_wait_time_increment * 1000.0,
3403 ((f64) am->fa_current_cleaner_timer_wait_interval) *
3404 1000.0 / (f64) vm->clib_time.clocks_per_second);
3405 vlib_cli_output (vm, "Reclassify sessions: %d", am->reclassify_sessions);
3408 static clib_error_t *
3409 acl_show_aclplugin_sessions_fn (vlib_main_t * vm,
3410 unformat_input_t * input,
3411 vlib_cli_command_t * cmd)
3413 clib_error_t *error = 0;
3414 acl_main_t *am = &acl_main;
3416 u32 show_bihash_verbose = 0;
3417 u32 show_session_thread_id = ~0;
3418 u32 show_session_session_index = ~0;
3419 (void) unformat (input, "thread %u index %u", &show_session_thread_id,
3420 &show_session_session_index);
3421 (void) unformat (input, "verbose %u", &show_bihash_verbose);
3423 acl_plugin_show_sessions (am, show_session_thread_id,
3424 show_session_session_index);
3425 show_fa_sessions_hash (vm, show_bihash_verbose);
3429 static clib_error_t *
3430 acl_show_aclplugin_tables_fn (vlib_main_t * vm,
3431 unformat_input_t * input,
3432 vlib_cli_command_t * cmd)
3434 clib_error_t *error = 0;
3438 int show_acl_hash_info = 0;
3439 int show_applied_info = 0;
3440 int show_mask_type = 0;
3441 int show_bihash = 0;
3442 u32 show_bihash_verbose = 0;
3444 if (unformat (input, "acl"))
3446 show_acl_hash_info = 1;
3447 /* mask-type is handy to see as well right there */
3449 unformat (input, "index %u", &acl_index);
3451 else if (unformat (input, "applied"))
3453 show_applied_info = 1;
3454 unformat (input, "lc_index %u", &lc_index);
3456 else if (unformat (input, "mask"))
3460 else if (unformat (input, "hash"))
3463 unformat (input, "verbose %u", &show_bihash_verbose);
3467 (show_mask_type || show_acl_hash_info || show_applied_info
3470 /* if no qualifiers specified, show all */
3472 show_acl_hash_info = 1;
3473 show_applied_info = 1;
3476 vlib_cli_output (vm, "Stats counters enabled for interface ACLs: %d",
3477 acl_main.interface_acl_counters_enabled);
3478 vlib_cli_output (vm, "Use hash-based lookup for ACLs: %d",
3479 acl_main.use_hash_acl_matching);
3481 acl_plugin_show_tables_mask_type ();
3482 if (show_acl_hash_info)
3483 acl_plugin_show_tables_acl_hash_info (acl_index);
3484 if (show_applied_info)
3485 acl_plugin_show_tables_applied_info (lc_index);
3487 acl_plugin_show_tables_bihash (show_bihash_verbose);
3492 static clib_error_t *
3493 acl_clear_aclplugin_fn (vlib_main_t * vm,
3494 unformat_input_t * input, vlib_cli_command_t * cmd)
3496 clib_error_t *error = 0;
3497 acl_main_t *am = &acl_main;
3498 vlib_process_signal_event (am->vlib_main, am->fa_cleaner_node_index,
3499 ACL_FA_CLEANER_DELETE_BY_SW_IF_INDEX, ~0);
3504 VLIB_CLI_COMMAND (aclplugin_set_command, static) = {
3505 .path = "set acl-plugin",
3506 .short_help = "set acl-plugin session timeout {{udp idle}|tcp {idle|transient}} <seconds>",
3507 .function = acl_set_aclplugin_fn,
3510 VLIB_CLI_COMMAND (aclplugin_show_acl_command, static) = {
3511 .path = "show acl-plugin acl",
3512 .short_help = "show acl-plugin acl [index N]",
3513 .function = acl_show_aclplugin_acl_fn,
3516 VLIB_CLI_COMMAND (aclplugin_show_lookup_context_command, static) = {
3517 .path = "show acl-plugin lookup context",
3518 .short_help = "show acl-plugin lookup context [index N]",
3519 .function = acl_show_aclplugin_lookup_context_fn,
3522 VLIB_CLI_COMMAND (aclplugin_show_lookup_user_command, static) = {
3523 .path = "show acl-plugin lookup user",
3524 .short_help = "show acl-plugin lookup user [index N]",
3525 .function = acl_show_aclplugin_lookup_user_fn,
3528 VLIB_CLI_COMMAND (aclplugin_show_decode_5tuple_command, static) = {
3529 .path = "show acl-plugin decode 5tuple",
3530 .short_help = "show acl-plugin decode 5tuple XXXX XXXX XXXX XXXX XXXX XXXX",
3531 .function = acl_show_aclplugin_decode_5tuple_fn,
3534 VLIB_CLI_COMMAND (aclplugin_show_interface_command, static) = {
3535 .path = "show acl-plugin interface",
3536 .short_help = "show acl-plugin interface [sw_if_index N] [acl]",
3537 .function = acl_show_aclplugin_interface_fn,
3540 VLIB_CLI_COMMAND (aclplugin_show_memory_command, static) = {
3541 .path = "show acl-plugin memory",
3542 .short_help = "show acl-plugin memory",
3543 .function = acl_show_aclplugin_memory_fn,
3546 VLIB_CLI_COMMAND (aclplugin_show_sessions_command, static) = {
3547 .path = "show acl-plugin sessions",
3548 .short_help = "show acl-plugin sessions",
3549 .function = acl_show_aclplugin_sessions_fn,
3552 VLIB_CLI_COMMAND (aclplugin_show_tables_command, static) = {
3553 .path = "show acl-plugin tables",
3554 .short_help = "show acl-plugin tables [ acl [index N] | applied [ lc_index N ] | mask | hash [verbose N] ]",
3555 .function = acl_show_aclplugin_tables_fn,
3558 VLIB_CLI_COMMAND (aclplugin_show_macip_acl_command, static) = {
3559 .path = "show acl-plugin macip acl",
3560 .short_help = "show acl-plugin macip acl [index N]",
3561 .function = acl_show_aclplugin_macip_acl_fn,
3564 VLIB_CLI_COMMAND (aclplugin_show_macip_interface_command, static) = {
3565 .path = "show acl-plugin macip interface",
3566 .short_help = "show acl-plugin macip interface",
3567 .function = acl_show_aclplugin_macip_interface_fn,
3570 VLIB_CLI_COMMAND (aclplugin_clear_command, static) = {
3571 .path = "clear acl-plugin sessions",
3572 .short_help = "clear acl-plugin sessions",
3573 .function = acl_clear_aclplugin_fn,
3577 * [un]Apply an ACL to an interface.
3578 * The ACL is applied in a given direction, either input or output.
3579 * The ACL being applied must already exist.
3582 * <b><em> set acl-plugin interface <input|output> acl <index> [del] </b></em>
3585 VLIB_CLI_COMMAND (aclplugin_set_interface_command, static) = {
3586 .path = "set acl-plugin interface",
3587 .short_help = "set acl-plugin interface <interface> <input|output> <acl INDEX> [del] ",
3588 .function = acl_set_aclplugin_interface_fn,
3592 * Create an Access Control List (ACL)
3593 * an ACL is composed of more than one Access control element (ACE). Multiple
3594 * ACEs can be specified with this command using a comma separated list.
3596 * Each ACE describes a tuple of src+dst IP prefix, ip protocol, src+dst port
3597 * ranges. (the ACL plugin also support ICMP types/codes instead of UDP/TCP
3598 * ports, but this CLI does not).
3600 * An ACL can optionally be assigned a 'tag' - which is an identifier
3601 * understood by the client. VPP does not examine it in any way.
3603 * @cliexcmd{set acl-plugin acl <permit|deny> src <PREFIX> dst <PREFIX> proto
3604 * <TCP|UDP> sport <X-Y> dport <X-Y> [tag FOO]}
3606 VLIB_CLI_COMMAND (aclplugin_set_acl_command, static) = {
3607 .path = "set acl-plugin acl",
3608 .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}",
3609 .function = acl_set_aclplugin_acl_fn,
3613 static clib_error_t *
3614 acl_plugin_config (vlib_main_t * vm, unformat_input_t * input)
3616 acl_main_t *am = &acl_main;
3617 u32 conn_table_hash_buckets;
3618 uword conn_table_hash_memory_size;
3619 u32 conn_table_max_entries;
3620 uword main_heap_size;
3621 uword hash_heap_size;
3622 u32 hash_lookup_hash_buckets;
3623 uword hash_lookup_hash_memory;
3624 u32 reclassify_sessions;
3625 u32 use_tuple_merge;
3626 u32 tuple_merge_split_threshold;
3628 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
3631 (input, "connection hash buckets %d", &conn_table_hash_buckets))
3632 am->fa_conn_table_hash_num_buckets = conn_table_hash_buckets;
3635 (input, "connection hash memory %U", unformat_memory_size,
3636 &conn_table_hash_memory_size))
3637 am->fa_conn_table_hash_memory_size = conn_table_hash_memory_size;
3638 else if (unformat (input, "connection count max %d",
3639 &conn_table_max_entries))
3640 am->fa_conn_table_max_entries = conn_table_max_entries;
3643 (input, "main heap size %U", unformat_memory_size,
3646 ("WARNING: ACL heap is now part of the main heap. 'main heap size' is ineffective.");
3649 (input, "hash lookup heap size %U", unformat_memory_size,
3652 ("WARNING: ACL heap is now part of the main heap. 'hash lookup heap size' is ineffective.");
3655 (input, "hash lookup hash buckets %d", &hash_lookup_hash_buckets))
3656 am->hash_lookup_hash_buckets = hash_lookup_hash_buckets;
3659 (input, "hash lookup hash memory %U", unformat_memory_size,
3660 &hash_lookup_hash_memory))
3661 am->hash_lookup_hash_memory = hash_lookup_hash_memory;
3662 else if (unformat (input, "use tuple merge %d", &use_tuple_merge))
3663 am->use_tuple_merge = use_tuple_merge;
3666 (input, "tuple merge split threshold %d",
3667 &tuple_merge_split_threshold))
3668 am->tuple_merge_split_threshold = tuple_merge_split_threshold;
3670 else if (unformat (input, "reclassify sessions %d",
3671 &reclassify_sessions))
3672 am->reclassify_sessions = reclassify_sessions;
3675 return clib_error_return (0, "unknown input '%U'",
3676 format_unformat_error, input);
3681 VLIB_CONFIG_FUNCTION (acl_plugin_config, "acl-plugin");
3683 /* Set up the API message handling tables */
3684 #include <vnet/format_fns.h>
3685 #include <acl/acl.api.c>
3687 static clib_error_t *
3688 acl_init (vlib_main_t * vm)
3690 acl_main_t *am = &acl_main;
3691 clib_error_t *error = 0;
3692 clib_memset (am, 0, sizeof (*am));
3694 am->vnet_main = vnet_get_main ();
3695 am->log_default = vlib_log_register_class ("acl_plugin", 0);
3697 /* Ask for a correctly-sized block of API message decode slots */
3698 am->msg_id_base = setup_message_id_table ();
3700 error = acl_plugin_exports_init (&acl_plugin);
3705 am->hash_lookup_hash_buckets = ACL_PLUGIN_HASH_LOOKUP_HASH_BUCKETS;
3706 am->hash_lookup_hash_memory = ACL_PLUGIN_HASH_LOOKUP_HASH_MEMORY;
3708 am->session_timeout_sec[ACL_TIMEOUT_TCP_TRANSIENT] =
3709 TCP_SESSION_TRANSIENT_TIMEOUT_SEC;
3710 am->session_timeout_sec[ACL_TIMEOUT_TCP_IDLE] =
3711 TCP_SESSION_IDLE_TIMEOUT_SEC;
3712 am->session_timeout_sec[ACL_TIMEOUT_UDP_IDLE] =
3713 UDP_SESSION_IDLE_TIMEOUT_SEC;
3715 am->fa_conn_table_hash_num_buckets =
3716 ACL_FA_CONN_TABLE_DEFAULT_HASH_NUM_BUCKETS;
3717 am->fa_conn_table_hash_memory_size =
3718 ACL_FA_CONN_TABLE_DEFAULT_HASH_MEMORY_SIZE;
3719 am->fa_conn_table_max_entries = ACL_FA_CONN_TABLE_DEFAULT_MAX_ENTRIES;
3720 am->reclassify_sessions = 0;
3721 vlib_thread_main_t *tm = vlib_get_thread_main ();
3723 am->fa_min_deleted_sessions_per_interval =
3724 ACL_FA_DEFAULT_MIN_DELETED_SESSIONS_PER_INTERVAL;
3725 am->fa_max_deleted_sessions_per_interval =
3726 ACL_FA_DEFAULT_MAX_DELETED_SESSIONS_PER_INTERVAL;
3727 am->fa_cleaner_wait_time_increment =
3728 ACL_FA_DEFAULT_CLEANER_WAIT_TIME_INCREMENT;
3730 vec_validate (am->per_worker_data, tm->n_vlib_mains - 1);
3733 for (wk = 0; wk < vec_len (am->per_worker_data); wk++)
3735 acl_fa_per_worker_data_t *pw = &am->per_worker_data[wk];
3736 if (tm->n_vlib_mains > 1)
3738 clib_spinlock_init (&pw->pending_session_change_request_lock);
3740 vec_validate (pw->expired,
3742 am->fa_max_deleted_sessions_per_interval);
3743 vec_set_len (pw->expired, 0);
3744 vec_validate_init_empty (pw->fa_conn_list_head, ACL_N_TIMEOUTS - 1,
3745 FA_SESSION_BOGUS_INDEX);
3746 vec_validate_init_empty (pw->fa_conn_list_tail, ACL_N_TIMEOUTS - 1,
3747 FA_SESSION_BOGUS_INDEX);
3748 vec_validate_init_empty (pw->fa_conn_list_head_expiry_time,
3749 ACL_N_TIMEOUTS - 1, ~0ULL);
3753 am->fa_cleaner_cnt_delete_by_sw_index = 0;
3754 am->fa_cleaner_cnt_delete_by_sw_index_ok = 0;
3755 am->fa_cleaner_cnt_unknown_event = 0;
3756 am->fa_cleaner_cnt_timer_restarted = 0;
3757 am->fa_cleaner_cnt_wait_with_timeout = 0;
3760 #define _(N, v, s) am->fa_ipv6_known_eh_bitmap = clib_bitmap_set(am->fa_ipv6_known_eh_bitmap, v, 1);
3763 am->l4_match_nonfirst_fragment = 1;
3765 /* use the new fancy hash-based matching */
3766 am->use_hash_acl_matching = 1;
3767 /* use tuplemerge by default */
3768 am->use_tuple_merge = 1;
3769 /* Set the default threshold */
3770 am->tuple_merge_split_threshold = TM_SPLIT_THRESHOLD;
3772 am->interface_acl_user_id =
3773 acl_plugin.register_user_module ("interface ACL", "sw_if_index",
3776 am->acl_counter_lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
3777 CLIB_CACHE_LINE_BYTES);
3778 am->acl_counter_lock[0] = 0; /* should be no need */
3783 VLIB_INIT_FUNCTION (acl_init);
3787 * fd.io coding-style-patch-verification: ON
3790 * eval: (c-set-style "gnu")