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.
34 #ifndef __INCLUDE_RTE_TABLE_H__
35 #define __INCLUDE_RTE_TABLE_H__
45 * This tool is part of the Intel DPDK Packet Framework tool suite and provides
46 * a standard interface to implement different types of lookup tables for data
49 * Virtually any search algorithm that can uniquely associate data to a lookup
50 * key can be fitted under this lookup table abstraction. For the flow table
51 * use-case, the lookup key is an n-tuple of packet fields that uniquely
52 * identifies a traffic flow, while data represents actions and action
53 * meta-data associated with the same traffic flow.
62 /** Lookup table statistics */
63 struct rte_table_stats {
65 uint64_t n_pkts_lookup_miss;
72 * Parameters for lookup table creation. The underlying data structure is
73 * different for each lookup table type.
75 * CPU socket ID (e.g. for memory allocation purpose)
77 * Data size of each lookup table entry (measured in bytes)
79 * Handle to lookup table instance
81 typedef void* (*rte_table_op_create)(void *params, int socket_id,
88 * Handle to lookup table instance
90 * 0 on success, error code otherwise
92 typedef int (*rte_table_op_free)(void *table);
95 * Lookup table entry add
98 * Handle to lookup table instance
102 * Data to be associated with the current key. This parameter has to point to
103 * a valid memory buffer where the first entry_size bytes (table create
104 * parameter) are populated with the data.
106 * After successful invocation, *key_found is set to a value different than 0
107 * if the current key is already present in the table and to 0 if not. This
108 * pointer has to be set to a valid memory location before the table entry add
109 * function is called.
111 * After successful invocation, *entry_ptr stores the handle to the table
112 * entry containing the data associated with the current key. This handle can
113 * be used to perform further read-write accesses to this entry. This handle
114 * is valid until the key is deleted from the table or the same key is
115 * re-added to the table, typically to associate it with different data. This
116 * pointer has to be set to a valid memory location before the function is
119 * 0 on success, error code otherwise
121 typedef int (*rte_table_op_entry_add)(
129 * Lookup table entry delete
132 * Handle to lookup table instance
136 * After successful invocation, *key_found is set to a value different than 0
137 * if the current key was present in the table before the delete operation
138 * was performed and to 0 if not. This pointer has to be set to a valid
139 * memory location before the table entry delete function is called.
141 * After successful invocation, if the key is found in the table (*key found
142 * is different than 0 after function call is completed) and entry points to
143 * a valid buffer (entry is set to a value different than NULL before the
144 * function is called), then the first entry_size bytes (table create
145 * parameter) in *entry store a copy of table entry that contained the data
146 * associated with the current key before the key was deleted.
148 * 0 on success, error code otherwise
150 typedef int (*rte_table_op_entry_delete)(
157 * Lookup table lookup
160 * Handle to lookup table instance
162 * Burst of input packets specified as array of up to 64 pointers to struct
165 * 64-bit bitmask specifying which packets in the input burst are valid. When
166 * pkts_mask bit n is set, then element n of pkts array is pointing to a
167 * valid packet. Otherwise, element n of pkts array does not point to a valid
168 * packet, therefore it will not be accessed.
169 * @param lookup_hit_mask
170 * Once the table lookup operation is completed, this 64-bit bitmask
171 * specifies which of the valid packets in the input burst resulted in lookup
172 * hit. For each valid input packet (pkts_mask bit n is set), the following
173 * are true on lookup hit: lookup_hit_mask bit n is set, element n of entries
174 * array is valid and it points to the lookup table entry that was hit. For
175 * each valid input packet (pkts_mask bit n is set), the following are true
176 * on lookup miss: lookup_hit_mask bit n is not set and element n of entries
177 * array is not valid.
179 * Once the table lookup operation is completed, this array provides the
180 * lookup table entries that were hit, as described above. It is required
181 * that this array is always pre-allocated by the caller of this function
182 * with exactly 64 elements. The implementation is allowed to speculatively
183 * modify the elements of this array, so elements marked as invalid in
184 * lookup_hit_mask once the table lookup operation is completed might have
185 * been modified by this function.
187 * 0 on success, error code otherwise
189 typedef int (*rte_table_op_lookup)(
191 struct rte_mbuf **pkts,
193 uint64_t *lookup_hit_mask,
197 * Lookup table stats read
200 * Handle to lookup table instance
202 * Handle to table stats struct to copy data
204 * Flag indicating that stats should be cleared after read
207 * Error code or 0 on success.
209 typedef int (*rte_table_op_stats_read)(
211 struct rte_table_stats *stats,
214 /** Lookup table interface defining the lookup table operation */
215 struct rte_table_ops {
216 rte_table_op_create f_create; /**< Create */
217 rte_table_op_free f_free; /**< Free */
218 rte_table_op_entry_add f_add; /**< Entry add */
219 rte_table_op_entry_delete f_delete; /**< Entry delete */
220 rte_table_op_lookup f_lookup; /**< Lookup */
221 rte_table_op_stats_read f_stats; /**< Stats */