4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
38 * RTE Longest Prefix Match for IPv6 (LPM6)
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
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. */
62 * Create an LPM object.
67 * NUMA socket ID for LPM table memory allocation
69 * Structure containing the configuration
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
81 rte_lpm6_create(const char *name, int socket_id,
82 const struct rte_lpm6_config *config);
85 * Find an existing LPM object and return a pointer to it.
88 * Name of the lpm object as passed to rte_lpm6_create()
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.
95 rte_lpm6_find_existing(const char *name);
106 rte_lpm6_free(struct rte_lpm6 *lpm);
109 * Add a rule to the LPM table.
114 * IP of the rule to be added to the LPM table
116 * Depth of the rule to be added to the LPM table
118 * Next hop of the rule to be added to the LPM table
120 * 0 on success, negative value otherwise
123 rte_lpm6_add(struct rte_lpm6 *lpm, uint8_t *ip, uint8_t depth,
127 * Check if a rule is present in the LPM table,
128 * and provide its next hop if it is.
133 * IP of the rule to be searched
135 * Depth of the rule to searched
137 * Next hop of the rule (valid only if it is found)
139 * 1 if the rule exists, 0 if it does not, a negative value on failure
142 rte_lpm6_is_rule_present(struct rte_lpm6 *lpm, uint8_t *ip, uint8_t depth,
146 * Delete a rule from the LPM table.
151 * IP of the rule to be deleted from the LPM table
153 * Depth of the rule to be deleted from the LPM table
155 * 0 on success, negative value otherwise
158 rte_lpm6_delete(struct rte_lpm6 *lpm, uint8_t *ip, uint8_t depth);
161 * Delete a rule from the LPM table.
166 * Array of IPs to be deleted from the LPM table
168 * Array of depths of the rules to be deleted from the LPM table
170 * Number of rules to be deleted from the LPM table
172 * 0 on success, negative value otherwise.
175 rte_lpm6_delete_bulk_func(struct rte_lpm6 *lpm,
176 uint8_t ips[][RTE_LPM6_IPV6_ADDR_SIZE], uint8_t *depths, unsigned n);
179 * Delete all rules from the LPM table.
185 rte_lpm6_delete_all(struct rte_lpm6 *lpm);
188 * Lookup an IP into the LPM table.
193 * IP to be looked up in the LPM table
195 * Next hop of the most specific rule found for IP (valid on lookup hit only)
197 * -EINVAL for incorrect arguments, -ENOENT on lookup miss, 0 on lookup hit
200 rte_lpm6_lookup(const struct rte_lpm6 *lpm, uint8_t *ip, uint8_t *next_hop);
203 * Lookup multiple IP addresses in an LPM table.
208 * Array of IPs to be looked up in the LPM table
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.
214 * Number of elements in ips (and next_hops) array to lookup.
216 * -EINVAL for incorrect arguments, otherwise 0
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);