lib/librte_lpm/rte_lpm6.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 #ifndef _RTE_LPM6_H_
  34 #define _RTE_LPM6_H_
  35
  36 /**
  37  * @file
  38  * RTE Longest Prefix Match for IPv6 (LPM6)
  39  */
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45
  46 #define RTE_LPM6_MAX_DEPTH               128
  47 #define RTE_LPM6_IPV6_ADDR_SIZE           16
  48 /** Max number of characters in LPM name. */
  49 #define RTE_LPM6_NAMESIZE                 32
  50
  51 /** LPM structure. */
  52 struct rte_lpm6;
  53
  54 /** LPM configuration structure. */
  55 struct rte_lpm6_config {
  56         uint32_t max_rules;      /**< Max number of rules. */
  57         uint32_t number_tbl8s;   /**< Number of tbl8s to allocate. */
  58         int flags;               /**< This field is currently unused. */
  59 };
  60
  61 /**
  62  * Create an LPM object.
  63  *
  64  * @param name
  65  *   LPM object name
  66  * @param socket_id
  67  *   NUMA socket ID for LPM table memory allocation
  68  * @param config
  69  *   Structure containing the configuration
  70  * @return
  71  *   Handle to LPM object on success, NULL otherwise with rte_errno set
  72  *   to an appropriate values. Possible rte_errno values include:
  73  *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
  74  *    - E_RTE_SECONDARY - function was called from a secondary process instance
  75  *    - EINVAL - invalid parameter passed to function
  76  *    - ENOSPC - the maximum number of memzones has already been allocated
  77  *    - EEXIST - a memzone with the same name already exists
  78  *    - ENOMEM - no appropriate memory area found in which to create memzone
  79  */
  80 struct rte_lpm6 *
  81 rte_lpm6_create(const char *name, int socket_id,
  82                 const struct rte_lpm6_config *config);
  83
  84 /**
  85  * Find an existing LPM object and return a pointer to it.
  86  *
  87  * @param name
  88  *   Name of the lpm object as passed to rte_lpm6_create()
  89  * @return
  90  *   Pointer to lpm object or NULL if object not found with rte_errno
  91  *   set appropriately. Possible rte_errno values include:
  92  *    - ENOENT - required entry not available to return.
  93  */
  94 struct rte_lpm6 *
  95 rte_lpm6_find_existing(const char *name);
  96
  97 /**
  98  * Free an LPM object.
  99  *
 100  * @param lpm
 101  *   LPM object handle
 102  * @return
 103  *   None
 104  */
 105 void
 106 rte_lpm6_free(struct rte_lpm6 *lpm);
 107
 108 /**
 109  * Add a rule to the LPM table.
 110  *
 111  * @param lpm
 112  *   LPM object handle
 113  * @param ip
 114  *   IP of the rule to be added to the LPM table
 115  * @param depth
 116  *   Depth of the rule to be added to the LPM table
 117  * @param next_hop
 118  *   Next hop of the rule to be added to the LPM table
 119  * @return
 120  *   0 on success, negative value otherwise
 121  */
 122 int
 123 rte_lpm6_add(struct rte_lpm6 *lpm, uint8_t *ip, uint8_t depth,
 124                 uint8_t next_hop);
 125
 126 /**
 127  * Check if a rule is present in the LPM table,
 128  * and provide its next hop if it is.
 129  *
 130  * @param lpm
 131  *   LPM object handle
 132  * @param ip
 133  *   IP of the rule to be searched
 134  * @param depth
 135  *   Depth of the rule to searched
 136  * @param next_hop
 137  *   Next hop of the rule (valid only if it is found)
 138  * @return
 139  *   1 if the rule exists, 0 if it does not, a negative value on failure
 140  */
 141 int
 142 rte_lpm6_is_rule_present(struct rte_lpm6 *lpm, uint8_t *ip, uint8_t depth,
 143 uint8_t *next_hop);
 144
 145 /**
 146  * Delete a rule from the LPM table.
 147  *
 148  * @param lpm
 149  *   LPM object handle
 150  * @param ip
 151  *   IP of the rule to be deleted from the LPM table
 152  * @param depth
 153  *   Depth of the rule to be deleted from the LPM table
 154  * @return
 155  *   0 on success, negative value otherwise
 156  */
 157 int
 158 rte_lpm6_delete(struct rte_lpm6 *lpm, uint8_t *ip, uint8_t depth);
 159
 160 /**
 161  * Delete a rule from the LPM table.
 162  *
 163  * @param lpm
 164  *   LPM object handle
 165  * @param ips
 166  *   Array of IPs to be deleted from the LPM table
 167  * @param depths
 168  *   Array of depths of the rules to be deleted from the LPM table
 169  * @param n
 170  *   Number of rules to be deleted from the LPM table
 171  * @return
 172  *   0 on success, negative value otherwise.
 173  */
 174 int
 175 rte_lpm6_delete_bulk_func(struct rte_lpm6 *lpm,
 176                 uint8_t ips[][RTE_LPM6_IPV6_ADDR_SIZE], uint8_t *depths, unsigned n);
 177
 178 /**
 179  * Delete all rules from the LPM table.
 180  *
 181  * @param lpm
 182  *   LPM object handle
 183  */
 184 void
 185 rte_lpm6_delete_all(struct rte_lpm6 *lpm);
 186
 187 /**
 188  * Lookup an IP into the LPM table.
 189  *
 190  * @param lpm
 191  *   LPM object handle
 192  * @param ip
 193  *   IP to be looked up in the LPM table
 194  * @param next_hop
 195  *   Next hop of the most specific rule found for IP (valid on lookup hit only)
 196  * @return
 197  *   -EINVAL for incorrect arguments, -ENOENT on lookup miss, 0 on lookup hit
 198  */
 199 int
 200 rte_lpm6_lookup(const struct rte_lpm6 *lpm, uint8_t *ip, uint8_t *next_hop);
 201
 202 /**
 203  * Lookup multiple IP addresses in an LPM table.
 204  *
 205  * @param lpm
 206  *   LPM object handle
 207  * @param ips
 208  *   Array of IPs to be looked up in the LPM table
 209  * @param next_hops
 210  *   Next hop of the most specific rule found for IP (valid on lookup hit only).
 211  *   This is an array of two byte values. The next hop will be stored on
 212  *   each position on success; otherwise the position will be set to -1.
 213  * @param n
 214  *   Number of elements in ips (and next_hops) array to lookup.
 215  *  @return
 216  *   -EINVAL for incorrect arguments, otherwise 0
 217  */
 218 int
 219 rte_lpm6_lookup_bulk_func(const struct rte_lpm6 *lpm,
 220                 uint8_t ips[][RTE_LPM6_IPV6_ADDR_SIZE],
 221                 int16_t * next_hops, unsigned n);
 222
 223 #ifdef __cplusplus
 224 }
 225 #endif
 226
 227 #endif