diff options
Diffstat (limited to 'src/dpdk22/lib/librte_acl/rte_acl.h')
| -rw-r--r-- | src/dpdk22/lib/librte_acl/rte_acl.h | 388 |
1 files changed, 0 insertions, 388 deletions
diff --git a/src/dpdk22/lib/librte_acl/rte_acl.h b/src/dpdk22/lib/librte_acl/rte_acl.h deleted file mode 100644 index 0979a098..00000000 --- a/src/dpdk22/lib/librte_acl/rte_acl.h +++ /dev/null @@ -1,388 +0,0 @@ -/*- - * BSD LICENSE - * - * Copyright(c) 2010-2014 Intel Corporation. All rights reserved. - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the - * distribution. - * * Neither the name of Intel Corporation nor the names of its - * contributors may be used to endorse or promote products derived - * from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -#ifndef _RTE_ACL_H_ -#define _RTE_ACL_H_ - -/** - * @file - * - * RTE Classifier. - */ - -#include <rte_acl_osdep.h> - -#ifdef __cplusplus -extern "C" { -#endif - -#define RTE_ACL_MAX_CATEGORIES 16 - -#define RTE_ACL_RESULTS_MULTIPLIER (XMM_SIZE / sizeof(uint32_t)) - -#define RTE_ACL_MAX_LEVELS 64 -#define RTE_ACL_MAX_FIELDS 64 - -union rte_acl_field_types { - uint8_t u8; - uint16_t u16; - uint32_t u32; - uint64_t u64; -}; - -enum { - RTE_ACL_FIELD_TYPE_MASK = 0, - RTE_ACL_FIELD_TYPE_RANGE, - RTE_ACL_FIELD_TYPE_BITMASK -}; - -/** - * ACL Field definition. - * Each field in the ACL rule has an associate definition. - * It defines the type of field, its size, its offset in the input buffer, - * the field index, and the input index. - * For performance reasons, the inner loop of the search function is unrolled - * to process four input bytes at a time. This requires the input to be grouped - * into sets of 4 consecutive bytes. The loop processes the first input byte as - * part of the setup and then subsequent bytes must be in groups of 4 - * consecutive bytes. - */ -struct rte_acl_field_def { - uint8_t type; /**< type - RTE_ACL_FIELD_TYPE_*. */ - uint8_t size; /**< size of field 1,2,4, or 8. */ - uint8_t field_index; /**< index of field inside the rule. */ - uint8_t input_index; /**< 0-N input index. */ - uint32_t offset; /**< offset to start of field. */ -}; - -/** - * ACL build configuration. - * Defines the fields of an ACL trie and number of categories to build with. - */ -struct rte_acl_config { - uint32_t num_categories; /**< Number of categories to build with. */ - uint32_t num_fields; /**< Number of field definitions. */ - struct rte_acl_field_def defs[RTE_ACL_MAX_FIELDS]; - /**< array of field definitions. */ - size_t max_size; - /**< max memory limit for internal run-time structures. */ -}; - -/** - * Defines the value of a field for a rule. - */ -struct rte_acl_field { - union rte_acl_field_types value; - /**< a 1,2,4, or 8 byte value of the field. */ - union rte_acl_field_types mask_range; - /**< - * depending on field type: - * mask -> 1.2.3.4/32 value=0x1020304, mask_range=32, - * range -> 0 : 65535 value=0, mask_range=65535, - * bitmask -> 0x06/0xff value=6, mask_range=0xff. - */ -}; - -enum { - RTE_ACL_TYPE_SHIFT = 29, - RTE_ACL_MAX_INDEX = RTE_LEN2MASK(RTE_ACL_TYPE_SHIFT, uint32_t), - RTE_ACL_MAX_PRIORITY = RTE_ACL_MAX_INDEX, - RTE_ACL_MIN_PRIORITY = 0, -}; - -#define RTE_ACL_INVALID_USERDATA 0 - -#define RTE_ACL_MASKLEN_TO_BITMASK(v, s) \ -((v) == 0 ? (v) : (typeof(v))((uint64_t)-1 << ((s) * CHAR_BIT - (v)))) - -/** - * Miscellaneous data for ACL rule. - */ -struct rte_acl_rule_data { - uint32_t category_mask; /**< Mask of categories for that rule. */ - int32_t priority; /**< Priority for that rule. */ - uint32_t userdata; /**< Associated with the rule user data. */ -}; - -/** - * Defines single ACL rule. - * data - miscellaneous data for the rule. - * field[] - value and mask or range for each field. - */ -#define RTE_ACL_RULE_DEF(name, fld_num) struct name {\ - struct rte_acl_rule_data data; \ - struct rte_acl_field field[fld_num]; \ -} - -RTE_ACL_RULE_DEF(rte_acl_rule, 0); - -#define RTE_ACL_RULE_SZ(fld_num) \ - (sizeof(struct rte_acl_rule) + sizeof(struct rte_acl_field) * (fld_num)) - - -/** Max number of characters in name.*/ -#define RTE_ACL_NAMESIZE 32 - -/** - * Parameters used when creating the ACL context. - */ -struct rte_acl_param { - const char *name; /**< Name of the ACL context. */ - int socket_id; /**< Socket ID to allocate memory for. */ - uint32_t rule_size; /**< Size of each rule. */ - uint32_t max_rule_num; /**< Maximum number of rules. */ -}; - - -/** - * Create a new ACL context. - * - * @param param - * Parameters used to create and initialise the ACL context. - * @return - * Pointer to ACL context structure that is used in future ACL - * operations, or NULL on error, with error code set in rte_errno. - * Possible rte_errno errors include: - * - EINVAL - invalid parameter passed to function - */ -struct rte_acl_ctx * -rte_acl_create(const struct rte_acl_param *param); - -/** - * Find an existing ACL context object and return a pointer to it. - * - * @param name - * Name of the ACL context as passed to rte_acl_create() - * @return - * Pointer to ACL context or NULL if object not found - * with rte_errno set appropriately. Possible rte_errno values include: - * - ENOENT - value not available for return - */ -struct rte_acl_ctx * -rte_acl_find_existing(const char *name); - -/** - * De-allocate all memory used by ACL context. - * - * @param ctx - * ACL context to free - */ -void -rte_acl_free(struct rte_acl_ctx *ctx); - -/** - * Add rules to an existing ACL context. - * This function is not multi-thread safe. - * - * @param ctx - * ACL context to add patterns to. - * @param rules - * Array of rules to add to the ACL context. - * Note that all fields in rte_acl_rule structures are expected - * to be in host byte order. - * Each rule expected to be in the same format and not exceed size - * specified at ACL context creation time. - * @param num - * Number of elements in the input array of rules. - * @return - * - -ENOMEM if there is no space in the ACL context for these rules. - * - -EINVAL if the parameters are invalid. - * - Zero if operation completed successfully. - */ -int -rte_acl_add_rules(struct rte_acl_ctx *ctx, const struct rte_acl_rule *rules, - uint32_t num); - -/** - * Delete all rules from the ACL context. - * This function is not multi-thread safe. - * Note that internal run-time structures are not affected. - * - * @param ctx - * ACL context to delete rules from. - */ -void -rte_acl_reset_rules(struct rte_acl_ctx *ctx); - -/** - * Analyze set of rules and build required internal run-time structures. - * This function is not multi-thread safe. - * - * @param ctx - * ACL context to build. - * @param cfg - * Pointer to struct rte_acl_config - defines build parameters. - * @return - * - -ENOMEM if couldn't allocate enough memory. - * - -EINVAL if the parameters are invalid. - * - Negative error code if operation failed. - * - Zero if operation completed successfully. - */ -int -rte_acl_build(struct rte_acl_ctx *ctx, const struct rte_acl_config *cfg); - -/** - * Delete all rules from the ACL context and - * destroy all internal run-time structures. - * This function is not multi-thread safe. - * - * @param ctx - * ACL context to reset. - */ -void -rte_acl_reset(struct rte_acl_ctx *ctx); - -/** - * Available implementations of ACL classify. - */ -enum rte_acl_classify_alg { - RTE_ACL_CLASSIFY_DEFAULT = 0, - RTE_ACL_CLASSIFY_SCALAR = 1, /**< generic implementation. */ - RTE_ACL_CLASSIFY_SSE = 2, /**< requires SSE4.1 support. */ - RTE_ACL_CLASSIFY_AVX2 = 3, /**< requires AVX2 support. */ - RTE_ACL_CLASSIFY_NEON = 4, /**< requires NEON support. */ - RTE_ACL_CLASSIFY_NUM /* should always be the last one. */ -}; - -/** - * Perform search for a matching ACL rule for each input data buffer. - * Each input data buffer can have up to *categories* matches. - * That implies that results array should be big enough to hold - * (categories * num) elements. - * Also categories parameter should be either one or multiple of - * RTE_ACL_RESULTS_MULTIPLIER and can't be bigger than RTE_ACL_MAX_CATEGORIES. - * If more than one rule is applicable for given input buffer and - * given category, then rule with highest priority will be returned as a match. - * Note, that it is a caller's responsibility to ensure that input parameters - * are valid and point to correct memory locations. - * - * @param ctx - * ACL context to search with. - * @param data - * Array of pointers to input data buffers to perform search. - * Note that all fields in input data buffers supposed to be in network - * byte order (MSB). - * @param results - * Array of search results, *categories* results per each input data buffer. - * @param num - * Number of elements in the input data buffers array. - * @param categories - * Number of maximum possible matches for each input buffer, one possible - * match per category. - * @return - * zero on successful completion. - * -EINVAL for incorrect arguments. - */ -extern int -rte_acl_classify(const struct rte_acl_ctx *ctx, - const uint8_t **data, - uint32_t *results, uint32_t num, - uint32_t categories); - -/** - * Perform search using specified algorithm for a matching ACL rule for - * each input data buffer. - * Each input data buffer can have up to *categories* matches. - * That implies that results array should be big enough to hold - * (categories * num) elements. - * Also categories parameter should be either one or multiple of - * RTE_ACL_RESULTS_MULTIPLIER and can't be bigger than RTE_ACL_MAX_CATEGORIES. - * If more than one rule is applicable for given input buffer and - * given category, then rule with highest priority will be returned as a match. - * Note, that it is a caller's responsibility to ensure that input parameters - * are valid and point to correct memory locations. - * - * @param ctx - * ACL context to search with. - * @param data - * Array of pointers to input data buffers to perform search. - * Note that all fields in input data buffers supposed to be in network - * byte order (MSB). - * @param results - * Array of search results, *categories* results per each input data buffer. - * @param num - * Number of elements in the input data buffers array. - * @param categories - * Number of maximum possible matches for each input buffer, one possible - * match per category. - * @param alg - * Algorithm to be used for the search. - * It is the caller responsibility to ensure that the value refers to the - * existing algorithm, and that it could be run on the given CPU. - * @return - * zero on successful completion. - * -EINVAL for incorrect arguments. - */ -extern int -rte_acl_classify_alg(const struct rte_acl_ctx *ctx, - const uint8_t **data, - uint32_t *results, uint32_t num, - uint32_t categories, - enum rte_acl_classify_alg alg); - -/* - * Override the default classifier function for a given ACL context. - * @param ctx - * ACL context to change classify function for. - * @param alg - * New default classify algorithm for given ACL context. - * It is the caller responsibility to ensure that the value refers to the - * existing algorithm, and that it could be run on the given CPU. - * @return - * - -EINVAL if the parameters are invalid. - * - Zero if operation completed successfully. - */ -extern int -rte_acl_set_ctx_classify(struct rte_acl_ctx *ctx, - enum rte_acl_classify_alg alg); - -/** - * Dump an ACL context structure to the console. - * - * @param ctx - * ACL context to dump. - */ -void -rte_acl_dump(const struct rte_acl_ctx *ctx); - -/** - * Dump all ACL context structures to the console. - */ -void -rte_acl_list_dump(void); - -#ifdef __cplusplus -} -#endif - -#endif /* _RTE_ACL_H_ */ |