1d342b9c8f
In some cases (ACL of a few lines long with a lot of different subnet masks), linear lookup may be more efficient than the hash-based lookup. Expose the API to allow the control plane to choose what lookup algorithm to use. Type: improvement Change-Id: I540dd1b4ce63c5106a556d550f911f3a578b33e0 Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
540 lines
17 KiB
C
540 lines
17 KiB
C
/* Hey Emacs use -*- mode: C -*- */
|
|
/*
|
|
* Copyright (c) 2016 Cisco and/or its affiliates.
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at:
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/** \file
|
|
This file defines the vpp control-plane API messages
|
|
used to control the ACL plugin
|
|
*/
|
|
|
|
option version = "2.0.1";
|
|
|
|
import "plugins/acl/acl_types.api";
|
|
import "vnet/interface_types.api";
|
|
|
|
/** \brief Get the plugin version
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
*/
|
|
|
|
define acl_plugin_get_version
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
};
|
|
|
|
/** \brief Reply to get the plugin version
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param major - Incremented every time a known breaking behavior change is introduced
|
|
@param minor - Incremented with small changes, may be used to avoid buggy versions
|
|
*/
|
|
|
|
define acl_plugin_get_version_reply
|
|
{
|
|
u32 context;
|
|
u32 major;
|
|
u32 minor;
|
|
};
|
|
|
|
/** \brief Control ping from client to api server request
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
*/
|
|
define acl_plugin_control_ping
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
};
|
|
|
|
/** \brief Control ping from the client to the server response
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param retval - return code for the request
|
|
@param vpe_pid - the pid of the vpe, returned by the server
|
|
*/
|
|
define acl_plugin_control_ping_reply
|
|
{
|
|
u32 context;
|
|
i32 retval;
|
|
u32 client_index;
|
|
u32 vpe_pid;
|
|
};
|
|
|
|
/** \brief Get Connection table max entries
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
*/
|
|
|
|
define acl_plugin_get_conn_table_max_entries
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
};
|
|
|
|
/** \brief Reply to get connection table max entries
|
|
@param context - sender context, to match reply w/ request
|
|
@param conn_table_max_entries - the value of maximum entries of connection table
|
|
*/
|
|
define acl_plugin_get_conn_table_max_entries_reply
|
|
{
|
|
u32 context;
|
|
u64 conn_table_max_entries;
|
|
};
|
|
|
|
/** \brief Replace an existing ACL in-place or create a new ACL
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param acl_index - an existing ACL entry (0..0xfffffffe) to replace, or 0xffffffff to make new ACL
|
|
@param tag - a string value stored along with the ACL, for descriptive purposes
|
|
@param count - number of ACL rules
|
|
@r - Rules for this access-list
|
|
*/
|
|
|
|
define acl_add_replace
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
u32 acl_index; /* ~0 to add, existing ACL# to replace */
|
|
string tag[64]; /* What gets in here gets out in the corresponding tag field when dumping the ACLs. */
|
|
u32 count;
|
|
vl_api_acl_rule_t r[count];
|
|
option vat_help = "<acl-idx> <permit|permit+reflect|deny|action N> [src IP/plen] [dst IP/plen] [sport X-Y] [dport X-Y] [proto P] [tcpflags FL MASK], ... , ...";
|
|
};
|
|
|
|
/** \brief Reply to add/replace ACL
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param acl_index - index of the updated or newly created ACL
|
|
@param retval 0 - no error
|
|
*/
|
|
|
|
define acl_add_replace_reply
|
|
{
|
|
u32 context;
|
|
u32 acl_index;
|
|
i32 retval;
|
|
};
|
|
|
|
/** \brief Delete an ACL
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param acl_index - ACL index to delete
|
|
*/
|
|
|
|
autoreply define acl_del
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
u32 acl_index;
|
|
option vat_help = "<acl-idx>";
|
|
};
|
|
|
|
/* acl_interface_add_del(_reply) to be deprecated in lieu of acl_interface_set_acl_list */
|
|
/** \brief Use acl_interface_set_acl_list instead
|
|
Append/remove an ACL index to/from the list of ACLs checked for an interface
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param is_add - add or delete the ACL index from the list
|
|
@param is_input - check the ACL on input (1) or output (0)
|
|
@param sw_if_index - the interface to alter the list of ACLs on
|
|
@param acl_index - index of ACL for the operation
|
|
*/
|
|
|
|
autoreply define acl_interface_add_del
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
bool is_add [default=true];
|
|
/*
|
|
* is_input = 0 => ACL applied on interface egress
|
|
* is_input = 1 => ACL applied on interface ingress
|
|
*/
|
|
bool is_input;
|
|
vl_api_interface_index_t sw_if_index;
|
|
u32 acl_index;
|
|
option vat_help = "<intfc> | sw_if_index <if-idx> [add|del] [input|output] acl <acl-idx>";
|
|
};
|
|
|
|
/** \brief Set the vector of input/output ACLs checked for an interface
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param sw_if_index - the interface to alter the list of ACLs on
|
|
@param count - total number of ACL indices in the vector
|
|
@param n_input - this many first elements correspond to input ACLs, the rest - output
|
|
@param acls - vector of ACL indices
|
|
*/
|
|
|
|
autoreply define acl_interface_set_acl_list
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
vl_api_interface_index_t sw_if_index;
|
|
u8 count;
|
|
u8 n_input; /* First n_input ACLs are set as a list of input ACLs, the rest are applied as output */
|
|
u32 acls[count];
|
|
option vat_help = "<intfc> | sw_if_index <if-idx> input [acl-idx list] output [acl-idx list]";
|
|
};
|
|
|
|
/** \brief Reply to set the ACL list on an interface
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param retval 0 - no error
|
|
*/
|
|
|
|
/** \brief Dump the specific ACL contents or all of the ACLs' contents
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param acl_index - ACL index to dump, ~0 to dump all ACLs
|
|
*/
|
|
|
|
define acl_dump
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
u32 acl_index; /* ~0 for all ACLs */
|
|
option vat_help = "[<acl-idx>]";
|
|
};
|
|
|
|
/** \brief Details about a single ACL contents
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param acl_index - ACL index whose contents are being sent in this message
|
|
@param tag - Descriptive tag value which was supplied at ACL creation
|
|
@param count - Number of rules in this ACL
|
|
@param r - Array of rules within this ACL
|
|
*/
|
|
|
|
define acl_details
|
|
{
|
|
u32 context;
|
|
u32 acl_index;
|
|
string tag[64]; /* Same blob that was supplied to us when creating the ACL, one hopes. */
|
|
u32 count;
|
|
vl_api_acl_rule_t r[count];
|
|
};
|
|
|
|
/** \brief Dump the list(s) of ACL applied to specific or all interfaces
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param sw_if_index - interface for which to dump the ACL list. Default: 0xffffffff (All interfaces)
|
|
*/
|
|
|
|
define acl_interface_list_dump
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
vl_api_interface_index_t sw_if_index [default=0xffffffff];
|
|
option vat_help = "[<intfc> | sw_if_index <if-idx>]";
|
|
};
|
|
|
|
/** \brief Details about a single ACL contents
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param sw_if_index - interface for which the list of ACLs is applied
|
|
@param count - total length of acl indices vector
|
|
@param n_input - this many of indices in the beginning are input ACLs, the rest - output
|
|
@param acls - the vector of ACL indices
|
|
*/
|
|
|
|
define acl_interface_list_details
|
|
{
|
|
u32 context;
|
|
vl_api_interface_index_t sw_if_index;
|
|
u8 count;
|
|
u8 n_input;
|
|
u32 acls[count];
|
|
};
|
|
|
|
/** \brief Add a MACIP ACL
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param tag - descriptive value for this MACIP ACL
|
|
@param count - number of rules in this MACIP ACL
|
|
@param r - vector of MACIP ACL rules
|
|
*/
|
|
|
|
define macip_acl_add
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
string tag[64];
|
|
u32 count;
|
|
vl_api_macip_acl_rule_t r[count];
|
|
option vat_help = "...";
|
|
};
|
|
|
|
/** \brief Reply to add MACIP ACL
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param acl_index - index of the newly created MACIP ACL
|
|
@param retval 0 - no error
|
|
*/
|
|
|
|
define macip_acl_add_reply
|
|
{
|
|
u32 context;
|
|
u32 acl_index;
|
|
i32 retval;
|
|
};
|
|
|
|
/** \brief Add/Replace a MACIP ACL
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param acl_index - an existing MACIP ACL entry (0..0xfffffffe) to replace, or 0xffffffff to make new MACIP ACL Default: 0xffffffff
|
|
@param tag - descriptive value for this MACIP ACL
|
|
@param count - number of rules in this MACIP ACL
|
|
@param r - vector of MACIP ACL rules
|
|
*/
|
|
|
|
define macip_acl_add_replace
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
u32 acl_index [default=0xffffffff]; /* ~0 to add, existing MACIP ACL# to replace */
|
|
string tag[64];
|
|
u32 count;
|
|
vl_api_macip_acl_rule_t r[count];
|
|
option vat_help = "<acl-idx> <permit|deny|action N> [count <count>] [src] ip <ipaddress/[plen]> mac <mac> mask <mac_mask>, ... , ...";
|
|
};
|
|
|
|
/** \brief Reply to add/replace MACIP ACL
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param acl_index - index of the newly created MACIP ACL
|
|
@param retval 0 - no error
|
|
*/
|
|
|
|
define macip_acl_add_replace_reply
|
|
{
|
|
u32 context;
|
|
u32 acl_index;
|
|
i32 retval;
|
|
};
|
|
|
|
/** \brief Delete a MACIP ACL
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param acl_index - MACIP ACL index to delete
|
|
*/
|
|
|
|
autoreply define macip_acl_del
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
u32 acl_index;
|
|
option vat_help = "<acl-idx>";
|
|
};
|
|
|
|
/** \brief Add or delete a MACIP ACL to/from interface
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param is_add - add (1) or delete (0) MACIP ACL from being used on an interface
|
|
@param sw_if_index - interface to apply the action to
|
|
@param acl_index - MACIP ACL index
|
|
*/
|
|
|
|
autoreply define macip_acl_interface_add_del
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
bool is_add [default=true];
|
|
/* MACIP ACLs are always input */
|
|
vl_api_interface_index_t sw_if_index;
|
|
u32 acl_index;
|
|
option vat_help = "<intfc> | sw_if_index <if-idx> [add|del] acl <acl-idx>";
|
|
};
|
|
|
|
/** \brief Dump one or all defined MACIP ACLs
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param acl_index - MACIP ACL index or ~0 to dump all MACIP ACLs Default: 0xffffffff
|
|
*/
|
|
|
|
define macip_acl_dump
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
u32 acl_index [default=0xffffffff]; /* ~0 for all ACLs */
|
|
option vat_help = "[<acl-idx>]";
|
|
};
|
|
|
|
/** \brief Details about one MACIP ACL
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param acl_index - index of this MACIP ACL
|
|
@param tag - descriptive tag which was supplied during the creation
|
|
@param count - length of the vector of MACIP ACL rules
|
|
@param r - rules comprising this MACIP ACL
|
|
*/
|
|
|
|
define macip_acl_details
|
|
{
|
|
u32 context;
|
|
u32 acl_index;
|
|
string tag[64];
|
|
u32 count;
|
|
vl_api_macip_acl_rule_t r[count];
|
|
};
|
|
|
|
/** \brief Get the vector of MACIP ACL IDs applied to the interfaces
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
*/
|
|
|
|
define macip_acl_interface_get
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
};
|
|
|
|
/** \brief Reply with the vector of MACIP ACLs by sw_if_index
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param count - total number of elements in the vector
|
|
@param acls - the vector of active MACIP ACL indices per sw_if_index
|
|
*/
|
|
|
|
define macip_acl_interface_get_reply
|
|
{
|
|
u32 context;
|
|
u32 count;
|
|
u32 acls[count];
|
|
};
|
|
|
|
/** \brief Dump the list(s) of MACIP ACLs applied to specific or all interfaces
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param sw_if_index - interface to dump the MACIP ACL list for
|
|
*/
|
|
|
|
define macip_acl_interface_list_dump
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
vl_api_interface_index_t sw_if_index; /* ~0 for all interfaces */
|
|
};
|
|
|
|
/** \brief Details about a single MACIP ACL contents
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param sw_if_index - interface for which the list of MACIP ACLs is applied
|
|
@param count - total length of acl indices vector
|
|
@param acls - the vector of MACIP ACL indices
|
|
*/
|
|
|
|
define macip_acl_interface_list_details
|
|
{
|
|
u32 context;
|
|
vl_api_interface_index_t sw_if_index;
|
|
u8 count;
|
|
u32 acls[count];
|
|
};
|
|
|
|
/** \brief Set the ethertype whitelists on an interface. Takes effect when applying ACLs on the interface, so must be given prior.
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param sw_if_index - the interface to alter the list of ACLs on
|
|
@param count - total number of whitelisted ethertypes in the vector
|
|
@param n_input - this many first elements correspond to input whitelisted ethertypes, the rest - output
|
|
@param whitelist - vector of whitelisted ethertypes
|
|
*/
|
|
|
|
autoreply define acl_interface_set_etype_whitelist
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
vl_api_interface_index_t sw_if_index;
|
|
u8 count; /* Total number of ethertypes in the whitelist */
|
|
u8 n_input; /* first n_input ethertypes are input, the rest - output */
|
|
u16 whitelist[count];
|
|
option vat_help = "<intfc> | sw_if_index <if-idx> input [ethertype list] output [ethertype list]";
|
|
};
|
|
|
|
/** \brief Dump the list(s) of Ethertype whitelists applied to specific or all interfaces
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param sw_if_index - interface to dump the ethertype whitelist for
|
|
*/
|
|
|
|
define acl_interface_etype_whitelist_dump
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
vl_api_interface_index_t sw_if_index; /* ~0 for all interfaces */
|
|
option vat_help = "[<intfc> | sw_if_index <if-idx>]";
|
|
};
|
|
|
|
/** \brief Details about ethertype whitelist on a single interface
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param sw_if_index - interface for which the list of MACIP ACLs is applied
|
|
@param count - total number of whitelisted ethertypes in the vector
|
|
@param n_input - this many first elements correspond to input whitelisted ethertypes, the rest - output
|
|
@param whitelist - vector of whitelisted ethertypes
|
|
*/
|
|
|
|
define acl_interface_etype_whitelist_details
|
|
{
|
|
u32 context;
|
|
vl_api_interface_index_t sw_if_index;
|
|
u8 count;
|
|
u8 n_input; /* first n_input ethertypes are input, the rest - output */
|
|
u16 whitelist[count];
|
|
};
|
|
|
|
/** \brief Enable or disable incrementing ACL counters in stats segment by interface processing
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param enable - whether to enable or disable incrementing the counters
|
|
*/
|
|
|
|
autoreply define acl_stats_intf_counters_enable
|
|
{
|
|
u32 client_index;
|
|
u32 context;
|
|
bool enable;
|
|
option vat_help = "[disable]";
|
|
};
|
|
|
|
/** \brief Enable hash-based ACL lookups (default) or disable them (use linear search)
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
@param enable - whether to enable or disable the usage of hash lookup algorithm
|
|
*/
|
|
|
|
autoreply define acl_plugin_use_hash_lookup_set
|
|
{
|
|
option status="in_progress";
|
|
u32 client_index;
|
|
u32 context;
|
|
bool enable;
|
|
};
|
|
|
|
/** \brief Get if the hash-based ACL lookups are enabled (default) or not (use linear search)
|
|
@param client_index - opaque cookie to identify the sender
|
|
@param context - sender context, to match reply w/ request
|
|
*/
|
|
|
|
|
|
define acl_plugin_use_hash_lookup_get
|
|
{
|
|
option status="in_progress";
|
|
u32 client_index;
|
|
u32 context;
|
|
};
|
|
|
|
|
|
/** \brief Reply with the previous state of the hash lookup
|
|
@param context - returned sender context, to match reply w/ request
|
|
@param prev_enable - previous state of the hash lookup use
|
|
*/
|
|
|
|
define acl_plugin_use_hash_lookup_get_reply
|
|
{
|
|
option status="in_progress";
|
|
u32 context;
|
|
bool enable;
|
|
};
|