lib/librte_table/rte_table_acl.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef __INCLUDE_RTE_TABLE_ACL_H__
  35 #define __INCLUDE_RTE_TABLE_ACL_H__
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /**
  42  * @file
  43  * RTE Table ACL
  44  *
  45  * This table uses the Access Control List (ACL) algorithm to uniquely
  46  * associate data to lookup keys.
  47  *
  48  * Use-cases: Firewall rule database, etc.
  49  *
  50  ***/
  51
  52 #include <stdint.h>
  53
  54 #include "rte_acl.h"
  55
  56 #include "rte_table.h"
  57
  58 /** ACL table parameters */
  59 struct rte_table_acl_params {
  60         /** Name */
  61         const char *name;
  62
  63         /** Maximum number of ACL rules in the table */
  64         uint32_t n_rules;
  65
  66         /** Number of fields in the ACL rule specification */
  67         uint32_t n_rule_fields;
  68
  69         /** Format specification of the fields of the ACL rule */
  70         struct rte_acl_field_def field_format[RTE_ACL_MAX_FIELDS];
  71 };
  72
  73 /** ACL rule specification for entry add operation */
  74 struct rte_table_acl_rule_add_params {
  75         /** ACL rule priority, with 0 as the highest priority */
  76         int32_t  priority;
  77
  78         /** Values for the fields of the ACL rule to be added to the table */
  79         struct rte_acl_field field_value[RTE_ACL_MAX_FIELDS];
  80 };
  81
  82 /** ACL rule specification for entry delete operation */
  83 struct rte_table_acl_rule_delete_params {
  84         /** Values for the fields of the ACL rule to be deleted from table */
  85         struct rte_acl_field field_value[RTE_ACL_MAX_FIELDS];
  86 };
  87
  88 /** ACL table operations */
  89 extern struct rte_table_ops rte_table_acl_ops;
  90
  91 #ifdef __cplusplus
  92 }
  93 #endif
  94
  95 #endif