summaryrefslogtreecommitdiffstats
path: root/src/vnet/classify/classify.api
diff options
context:
space:
mode:
authorJon Loeliger <jdl@netgate.com>2020-10-15 14:41:36 -0400
committerDamjan Marion <dmarion@me.com>2020-12-15 15:14:05 +0000
commit5c1e48c01b50ddbd7623228e3dbc94d835d23813 (patch)
treec38d75e9f471b5dbee8968230c5f0bf538f2d53e /src/vnet/classify/classify.api
parent510aaa8911843206f7b9ff48b41e3c7b8c4a99fe (diff)
classify: add pcap/trace classfier mgmt API calls
Add lookup/get/set API calls to manage both PCAP and Trace filtering Classifier tables. The "lookup" call may be used to identify a Classifier table within a chain of tables taht matches a particular mask vector. For efficiency, this call should be used to determine to which table a match vector should be added. The "get" calls return the first table within a chain (either a PCAP or the Trace) set of tables. The "set" call may be used to add a new table to one such chain. If the "sort_masks" flag is set, the tables within the chain are ordered such that the most-specific mask is first, and the least-specific mask is last. A call that "sets" a chain to ~0 will delete and free all the tables with a chain. The PCAP filters are per-interface, with "local0", (that is, sw_if_index == 0) holding the system-wide PCAP filter. The Classifier used a reference-counted "set" for each PCAP or trace filter that it stored. The ref counts were not used, and the vector of tables was only used temporarily to establish a sorted order for tables based on masks. None of that complexity was actually warranted, and where it was used, the same could be achieved more simply. Type: refactor Signed-off-by: Jon Loeliger <jdl@netgate.com> Change-Id: Icc56116cca91b91c631ca0628e814fb53f3677d2
Diffstat (limited to 'src/vnet/classify/classify.api')
-rw-r--r--src/vnet/classify/classify.api171
1 files changed, 170 insertions, 1 deletions
diff --git a/src/vnet/classify/classify.api b/src/vnet/classify/classify.api
index 38c7343af72..c569fe6a599 100644
--- a/src/vnet/classify/classify.api
+++ b/src/vnet/classify/classify.api
@@ -13,7 +13,7 @@
* limitations under the License.
*/
-option version = "3.0.0";
+option version = "3.1.0";
import "vnet/interface_types.api";
@@ -442,6 +442,175 @@ autoreply define output_acl_set_interface
bool is_add;
};
+
+
+/** \brief Find a compatible Classify table in a PCAP chain
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - interface whose chain will be searched, 0==system-wide
+ @param skip_n_vectors - number of u32x4 skip vectors
+ @param match_n_vectors - number of u32x4 vectors, 1..5
+ @param mask_len - length of mask, match_n_vectors * sizeof(u32x4)
+ @param mask - match mask
+*/
+define classify_pcap_lookup_table
+{
+ u32 client_index;
+ u32 context;
+ vl_api_interface_index_t sw_if_index [default=0xffffffff];
+ u32 skip_n_vectors [default=0];
+ u32 match_n_vectors [default=1];
+ u32 mask_len;
+ u8 mask[mask_len];
+};
+
+/** \brief Classify pcap table lookup response
+ @param context - sender context, to match reply w/ request
+ @param retval - return code for the table lookup request
+ @param table_index - returned index of the found table, or ~0
+ */
+define classify_pcap_lookup_table_reply
+{
+ u32 context;
+ i32 retval;
+ u32 table_index;
+};
+
+/** \brief Add a Classify table into a PCAP chain on an interface
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - interface whose chain will be searched, 0==system-wide
+ @param table_index - Classify table to be added
+ @param sort_masks - 1=sort masks into most-to-least specific order
+ */
+define classify_pcap_set_table
+{
+ u32 client_index;
+ u32 context;
+ vl_api_interface_index_t sw_if_index;
+ u32 table_index [default=0xffffffff];
+ bool sort_masks [default=0];
+};
+
+/** \brief Classify pcap table lookup response
+ @param context - sender context which was passed in the request
+ @param retval - return code for the table lookup request
+ @param table_index - returned index of the sorted table chain
+ */
+define classify_pcap_set_table_reply
+{
+ u32 context;
+ i32 retval;
+ u32 table_index;
+};
+
+/** \brief Classify get the PCAP table indices for an interface
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ */
+define classify_pcap_get_tables
+{
+ u32 client_index;
+ u32 context;
+ vl_api_interface_index_t sw_if_index;
+};
+
+/** \brief Classify get a PCAP tables response
+ @param context - sender context which was passed in the request
+ @param retval - return code for the request
+ @param count - number of ids returned in response
+ @param indices - array of classify table indices
+ */
+define classify_pcap_get_tables_reply
+{
+ u32 context;
+ i32 retval;
+ u32 count;
+ u32 indices[count];
+};
+
+
+
+/** \brief Find a mask-compatible Classify table in the Trace chain
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param skip_n_vectors - number of u32x4 skip vectors
+ @param match_n_vectors - number of u32x4 vectors, 1..5
+ @param mask_len - length of mask, match_n_vectors * sizeof(u32x4)
+ @param mask - match mask
+*/
+define classify_trace_lookup_table
+{
+ u32 client_index;
+ u32 context;
+ u32 skip_n_vectors [default=0];
+ u32 match_n_vectors [default=1];
+ u32 mask_len;
+ u8 mask[mask_len];
+};
+
+/** \brief Classify trace table lookup response
+ @param context - sender context which was passed in the request
+ @param retval - return code for the table lookup request
+ @param table_index - returned index of the found table, or ~0
+ */
+define classify_trace_lookup_table_reply
+{
+ u32 context;
+ i32 retval;
+ u32 table_index;
+};
+
+/** \brief Add a Classify table into the Trace chain
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param table_index - Classify table to be added
+ @param sort_masks - 1=sort masks into most-to-least specific order
+ */
+define classify_trace_set_table
+{
+ u32 client_index;
+ u32 context;
+ u32 table_index [default=0xffffffff];
+ bool sort_masks [default=0];
+};
+
+/** \brief Classify Trace table lookup response
+ @param context - sender context which was passed in the request
+ @param retval - return code for the table lookup request
+ @param table_index - returned index of the sorted table chain
+ */
+define classify_trace_set_table_reply
+{
+ u32 context;
+ i32 retval;
+ u32 table_index;
+};
+
+/** \brief Classify get the Trace table indices
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ */
+define classify_trace_get_tables
+{
+ u32 client_index;
+ u32 context;
+};
+
+/** \brief Classify get the Trace tables response
+ @param context - sender context which was passed in the request
+ @param retval - return code for the request
+ @param count - number of ids returned in response
+ @param indices - array of classify table indices
+ */
+define classify_trace_get_tables_reply
+{
+ u32 context;
+ i32 retval;
+ u32 count;
+ u32 indices[count];
+};
+
/*
* Local Variables:
* eval: (c-set-style "gnu")