summaryrefslogtreecommitdiffstats
path: root/lib/librte_table/rte_table_hash.h
blob: 9d17516a53150c576350dd624ae77c43aeb2eda8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
/*-
 *   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 __INCLUDE_RTE_TABLE_HASH_H__
#define __INCLUDE_RTE_TABLE_HASH_H__

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @file
 * RTE Table Hash
 *
 * These tables use the exact match criterion to uniquely associate data to
 * lookup keys.
 *
 * Use-cases: Flow classification table, Address Resolution Protocol (ARP) table
 *
 * Hash table types:
 * 1. Entry add strategy on bucket full:
 *     a. Least Recently Used (LRU): One of the existing keys in the bucket is
 *        deleted and the new key is added in its place. The number of keys in
 *        each bucket never grows bigger than 4. The logic to pick the key to
 *        be dropped from the bucket is LRU. The hash table lookup operation
 *        maintains the order in which the keys in the same bucket are hit, so
 *        every time a key is hit, it becomes the new Most Recently Used (MRU)
 *        key, i.e. the most unlikely candidate for drop. When a key is added
 *        to the bucket, it also becomes the new MRU key. When a key needs to
 *        be picked and dropped, the most likely candidate for drop, i.e. the
 *        current LRU key, is always picked. The LRU logic requires maintaining
 *        specific data structures per each bucket.
 *     b. Extendible bucket (ext): The bucket is extended with space for 4 more
 *        keys. This is done by allocating additional memory at table init time,
 *        which is used to create a pool of free keys (the size of this pool is
 *        configurable and always a multiple of 4). On key add operation, the
 *        allocation of a group of 4 keys only happens successfully within the
 *        limit of free keys, otherwise the key add operation fails. On key
 *        delete operation, a group of 4 keys is freed back to the pool of free
 *        keys when the key to be deleted is the only key that was used within
 *        its group of 4 keys at that time. On key lookup operation, if the
 *        current bucket is in extended state and a match is not found in the
 *        first group of 4 keys, the search continues beyond the first group of
 *        4 keys, potentially until all keys in this bucket are examined. The
 *        extendible bucket logic requires maintaining specific data structures
 *        per table and per each bucket.
 * 2. Key signature computation:
 *     a. Pre-computed key signature: The key lookup operation is split between
 *        two CPU cores. The first CPU core (typically the CPU core performing
 *        packet RX) extracts the key from the input packet, computes the key
 *        signature and saves both the key and the key signature in the packet
 *        buffer as packet meta-data. The second CPU core reads both the key and
 *        the key signature from the packet meta-data and performs the bucket
 *        search step of the key lookup operation.
 *     b. Key signature computed on lookup (do-sig): The same CPU core reads
 *        the key from the packet meta-data, uses it to compute the key
 *        signature and also performs the bucket search step of the key lookup
 *        operation.
 * 3. Key size:
 *     a. Configurable key size
 *     b. Single key size (8-byte, 16-byte or 32-byte key size)
 *
 ***/
#include <stdint.h>

#include "rte_table.h"

/** Hash function */
typedef uint64_t (*rte_table_hash_op_hash)(
	void *key,
	uint32_t key_size,
	uint64_t seed);

/**
 * Hash tables with configurable key size
 *
 */
/** Extendible bucket hash table parameters */
struct rte_table_hash_ext_params {
	/** Key size (number of bytes) */
	uint32_t key_size;

	/** Maximum number of keys */
	uint32_t n_keys;

	/** Number of hash table buckets. Each bucket stores up to 4 keys. */
	uint32_t n_buckets;

	/** Number of hash table bucket extensions. Each bucket extension has
	space for 4 keys and each bucket can have 0, 1 or more extensions. */
	uint32_t n_buckets_ext;

	/** Hash function */
	rte_table_hash_op_hash f_hash;

	/** Seed value for the hash function */
	uint64_t seed;

	/** Byte offset within packet meta-data where the 4-byte key signature
	is located. Valid for pre-computed key signature tables, ignored for
	do-sig tables. */
	uint32_t signature_offset;

	/** Byte offset within packet meta-data where the key is located */
	uint32_t key_offset;
};

/** Extendible bucket hash table operations for pre-computed key signature */
extern struct rte_table_ops rte_table_hash_ext_ops;

/** Extendible bucket hash table operations for key signature computed on
	lookup ("do-sig") */
extern struct rte_table_ops rte_table_hash_ext_dosig_ops;

/** LRU hash table parameters */
struct rte_table_hash_lru_params {
	/** Key size (number of bytes) */
	uint32_t key_size;

	/** Maximum number of keys */
	uint32_t n_keys;

	/** Number of hash table buckets. Each bucket stores up to 4 keys. */
	uint32_t n_buckets;

	/** Hash function */
	rte_table_hash_op_hash f_hash;

	/** Seed value for the hash function */
	uint64_t seed;

	/** Byte offset within packet meta-data where the 4-byte key signature
	is located. Valid for pre-computed key signature tables, ignored for
	do-sig tables. */
	uint32_t signature_offset;

	/** Byte offset within packet meta-data where the key is located */
	uint32_t key_offset;
};

/** LRU hash table operations for pre-computed key signature */
extern struct rte_table_ops rte_table_hash_lru_ops;

/** LRU hash table operations for key signature computed on lookup ("do-sig") */
extern struct rte_table_ops rte_table_hash_lru_dosig_ops;

/**
 * 8-byte key hash tables
 *
 */
/** LRU hash table parameters */
struct rte_table_hash_key8_lru_params {
	/** Maximum number of entries (and keys) in the table */
	uint32_t n_entries;

	/** Hash function */
	rte_table_hash_op_hash f_hash;

	/** Seed for the hash function */
	uint64_t seed;

	/** Byte offset within packet meta-data where the 4-byte key signature
	is located. Valid for pre-computed key signature tables, ignored for
	do-sig tables. */
	uint32_t signature_offset;

	/** Byte offset within packet meta-data where the key is located */
	uint32_t key_offset;

	/** Bit-mask to be AND-ed to the key on lookup */
	uint8_t *key_mask;
};

/** LRU hash table operations for pre-computed key signature */
extern struct rte_table_ops rte_table_hash_key8_lru_ops;

/** LRU hash table operations for key signature computed on lookup ("do-sig") */
extern struct rte_table_ops rte_table_hash_key8_lru_dosig_ops;

/** Extendible bucket hash table parameters */
struct rte_table_hash_key8_ext_params {
	/** Maximum number of entries (and keys) in the table */
	uint32_t n_entries;

	/** Number of entries (and keys) for hash table bucket extensions. Each
		bucket is extended in increments of 4 keys. */
	uint32_t n_entries_ext;

	/** Hash function */
	rte_table_hash_op_hash f_hash;

	/** Seed for the hash function */
	uint64_t seed;

	/** Byte offset within packet meta-data where the 4-byte key signature
	is located. Valid for pre-computed key signature tables, ignored for
	do-sig tables. */
	uint32_t signature_offset;

	/** Byte offset within packet meta-data where the key is located */
	uint32_t key_offset;

	/** Bit-mask to be AND-ed to the key on lookup */
	uint8_t *key_mask;
};

/** Extendible bucket hash table operations for pre-computed key signature */
extern struct rte_table_ops rte_table_hash_key8_ext_ops;

/** Extendible bucket hash table operations for key signature computed on
    lookup ("do-sig") */
extern struct rte_table_ops rte_table_hash_key8_ext_dosig_ops;

/**
 * 16-byte key hash tables
 *
 */
/** LRU hash table parameters */
struct rte_table_hash_key16_lru_params {
	/** Maximum number of entries (and keys) in the table */
	uint32_t n_entries;

	/** Hash function */
	rte_table_hash_op_hash f_hash;

	/** Seed for the hash function */
	uint64_t seed;

	/** Byte offset within packet meta-data where the 4-byte key signature
	is located. Valid for pre-computed key signature tables, ignored for
	do-sig tables. */
	uint32_t signature_offset;

	/** Byte offset within packet meta-data where the key is located */
	uint32_t key_offset;

	/** Bit-mask to be AND-ed to the key on lookup */
	uint8_t *key_mask;
};

/** LRU hash table operations for pre-computed key signature */
extern struct rte_table_ops rte_table_hash_key16_lru_ops;

/** LRU hash table operations for key signature computed on lookup
    ("do-sig") */
extern struct rte_table_ops rte_table_hash_key16_lru_dosig_ops;

/** Extendible bucket hash table parameters */
struct rte_table_hash_key16_ext_params {
	/** Maximum number of entries (and keys) in the table */
	uint32_t n_entries;

	/** Number of entries (and keys) for hash table bucket extensions. Each
	bucket is extended in increments of 4 keys. */
	uint32_t n_entries_ext;

	/** Hash function */
	rte_table_hash_op_hash f_hash;

	/** Seed for the hash function */
	uint64_t seed;

	/** Byte offset within packet meta-data where the 4-byte key signature
	is located. Valid for pre-computed key signature tables, ignored for
	do-sig tables. */
	uint32_t signature_offset;

	/** Byte offset within packet meta-data where the key is located */
	uint32_t key_offset;

	/** Bit-mask to be AND-ed to the key on lookup */
	uint8_t *key_mask;
};

/** Extendible bucket operations for pre-computed key signature */
extern struct rte_table_ops rte_table_hash_key16_ext_ops;

/** Extendible bucket hash table operations for key signature computed on
    lookup ("do-sig") */
extern struct rte_table_ops rte_table_hash_key16_ext_dosig_ops;

/**
 * 32-byte key hash tables
 *
 */
/** LRU hash table parameters */
struct rte_table_hash_key32_lru_params {
	/** Maximum number of entries (and keys) in the table */
	uint32_t n_entries;

	/** Hash function */
	rte_table_hash_op_hash f_hash;

	/** Seed for the hash function */
	uint64_t seed;

	/** Byte offset within packet meta-data where the 4-byte key signature
	is located. Valid for pre-computed key signature tables, ignored for
	do-sig tables. */
	uint32_t signature_offset;

	/** Byte offset within packet meta-data where the key is located */
	uint32_t key_offset;
};

/** LRU hash table operations for pre-computed key signature */
extern struct rte_table_ops rte_table_hash_key32_lru_ops;

/** Extendible bucket hash table parameters */
struct rte_table_hash_key32_ext_params {
	/** Maximum number of entries (and keys) in the table */
	uint32_t n_entries;

	/** Number of entries (and keys) for hash table bucket extensions. Each
		bucket is extended in increments of 4 keys. */
	uint32_t n_entries_ext;

	/** Hash function */
	rte_table_hash_op_hash f_hash;

	/** Seed for the hash function */
	uint64_t seed;

	/** Byte offset within packet meta-data where the 4-byte key signature
	is located. Valid for pre-computed key signature tables, ignored for
	do-sig tables. */
	uint32_t signature_offset;

	/** Byte offset within packet meta-data where the key is located */
	uint32_t key_offset;
};

/** Extendible bucket hash table operations */
extern struct rte_table_ops rte_table_hash_key32_ext_ops;

#ifdef __cplusplus
}
#endif

#endif