lib/librte_table/rte_table_hash.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2016 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_HASH_H__
  35 #define __INCLUDE_RTE_TABLE_HASH_H__
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /**
  42  * @file
  43  * RTE Table Hash
  44  *
  45  * These tables use the exact match criterion to uniquely associate data to
  46  * lookup keys.
  47  *
  48  * Use-cases: Flow classification table, Address Resolution Protocol (ARP) table
  49  *
  50  * Hash table types:
  51  * 1. Entry add strategy on bucket full:
  52  *     a. Least Recently Used (LRU): One of the existing keys in the bucket is
  53  *        deleted and the new key is added in its place. The number of keys in
  54  *        each bucket never grows bigger than 4. The logic to pick the key to
  55  *        be dropped from the bucket is LRU. The hash table lookup operation
  56  *        maintains the order in which the keys in the same bucket are hit, so
  57  *        every time a key is hit, it becomes the new Most Recently Used (MRU)
  58  *        key, i.e. the most unlikely candidate for drop. When a key is added
  59  *        to the bucket, it also becomes the new MRU key. When a key needs to
  60  *        be picked and dropped, the most likely candidate for drop, i.e. the
  61  *        current LRU key, is always picked. The LRU logic requires maintaining
  62  *        specific data structures per each bucket.
  63  *     b. Extendible bucket (ext): The bucket is extended with space for 4 more
  64  *        keys. This is done by allocating additional memory at table init time,
  65  *        which is used to create a pool of free keys (the size of this pool is
  66  *        configurable and always a multiple of 4). On key add operation, the
  67  *        allocation of a group of 4 keys only happens successfully within the
  68  *        limit of free keys, otherwise the key add operation fails. On key
  69  *        delete operation, a group of 4 keys is freed back to the pool of free
  70  *        keys when the key to be deleted is the only key that was used within
  71  *        its group of 4 keys at that time. On key lookup operation, if the
  72  *        current bucket is in extended state and a match is not found in the
  73  *        first group of 4 keys, the search continues beyond the first group of
  74  *        4 keys, potentially until all keys in this bucket are examined. The
  75  *        extendible bucket logic requires maintaining specific data structures
  76  *        per table and per each bucket.
  77  * 2. Key signature computation:
  78  *     a. Pre-computed key signature: The key lookup operation is split between
  79  *        two CPU cores. The first CPU core (typically the CPU core performing
  80  *        packet RX) extracts the key from the input packet, computes the key
  81  *        signature and saves both the key and the key signature in the packet
  82  *        buffer as packet meta-data. The second CPU core reads both the key and
  83  *        the key signature from the packet meta-data and performs the bucket
  84  *        search step of the key lookup operation.
  85  *     b. Key signature computed on lookup (do-sig): The same CPU core reads
  86  *        the key from the packet meta-data, uses it to compute the key
  87  *        signature and also performs the bucket search step of the key lookup
  88  *        operation.
  89  * 3. Key size:
  90  *     a. Configurable key size
  91  *     b. Single key size (8-byte, 16-byte or 32-byte key size)
  92  *
  93  ***/
  94 #include <stdint.h>
  95
  96 #include "rte_table.h"
  97
  98 /** Hash function */
  99 typedef uint64_t (*rte_table_hash_op_hash)(
 100         void *key,
 101         uint32_t key_size,
 102         uint64_t seed);
 103
 104 /**
 105  * Hash tables with configurable key size
 106  *
 107  */
 108 /** Extendible bucket hash table parameters */
 109 struct rte_table_hash_ext_params {
 110         /** Key size (number of bytes) */
 111         uint32_t key_size;
 112
 113         /** Maximum number of keys */
 114         uint32_t n_keys;
 115
 116         /** Number of hash table buckets. Each bucket stores up to 4 keys. */
 117         uint32_t n_buckets;
 118
 119         /** Number of hash table bucket extensions. Each bucket extension has
 120         space for 4 keys and each bucket can have 0, 1 or more extensions. */
 121         uint32_t n_buckets_ext;
 122
 123         /** Hash function */
 124         rte_table_hash_op_hash f_hash;
 125
 126         /** Seed value for the hash function */
 127         uint64_t seed;
 128
 129         /** Byte offset within packet meta-data where the 4-byte key signature
 130         is located. Valid for pre-computed key signature tables, ignored for
 131         do-sig tables. */
 132         uint32_t signature_offset;
 133
 134         /** Byte offset within packet meta-data where the key is located */
 135         uint32_t key_offset;
 136 };
 137
 138 extern struct rte_table_ops rte_table_hash_ext_ops;
 139
 140 /** LRU hash table parameters */
 141 struct rte_table_hash_lru_params {
 142         /** Key size (number of bytes) */
 143         uint32_t key_size;
 144
 145         /** Maximum number of keys */
 146         uint32_t n_keys;
 147
 148         /** Number of hash table buckets. Each bucket stores up to 4 keys. */
 149         uint32_t n_buckets;
 150
 151         /** Hash function */
 152         rte_table_hash_op_hash f_hash;
 153
 154         /** Seed value for the hash function */
 155         uint64_t seed;
 156
 157         /** Byte offset within packet meta-data where the 4-byte key signature
 158         is located. Valid for pre-computed key signature tables, ignored for
 159         do-sig tables. */
 160         uint32_t signature_offset;
 161
 162         /** Byte offset within packet meta-data where the key is located */
 163         uint32_t key_offset;
 164 };
 165
 166 /** LRU hash table operations for pre-computed key signature */
 167 extern struct rte_table_ops rte_table_hash_lru_ops;
 168
 169 /** LRU hash table operations for key signature computed on lookup ("do-sig") */
 170 extern struct rte_table_ops rte_table_hash_lru_dosig_ops;
 171
 172 /**
 173  * 8-byte key hash tables
 174  *
 175  */
 176 /** LRU hash table parameters */
 177 struct rte_table_hash_key8_lru_params {
 178         /** Maximum number of entries (and keys) in the table */
 179         uint32_t n_entries;
 180
 181         /** Hash function */
 182         rte_table_hash_op_hash f_hash;
 183
 184         /** Seed for the hash function */
 185         uint64_t seed;
 186
 187         /** Byte offset within packet meta-data where the 4-byte key signature
 188         is located. Valid for pre-computed key signature tables, ignored for
 189         do-sig tables. */
 190         uint32_t signature_offset;
 191
 192         /** Byte offset within packet meta-data where the key is located */
 193         uint32_t key_offset;
 194
 195         /** Bit-mask to be AND-ed to the key on lookup */
 196         uint8_t *key_mask;
 197 };
 198
 199 extern struct rte_table_ops rte_table_hash_key8_lru_ops;
 200
 201 /** Extendible bucket hash table parameters */
 202 struct rte_table_hash_key8_ext_params {
 203         /** Maximum number of entries (and keys) in the table */
 204         uint32_t n_entries;
 205
 206         /** Number of entries (and keys) for hash table bucket extensions. Each
 207                 bucket is extended in increments of 4 keys. */
 208         uint32_t n_entries_ext;
 209
 210         /** Hash function */
 211         rte_table_hash_op_hash f_hash;
 212
 213         /** Seed for the hash function */
 214         uint64_t seed;
 215
 216         /** Byte offset within packet meta-data where the 4-byte key signature
 217         is located. Valid for pre-computed key signature tables, ignored for
 218         do-sig tables. */
 219         uint32_t signature_offset;
 220
 221         /** Byte offset within packet meta-data where the key is located */
 222         uint32_t key_offset;
 223
 224         /** Bit-mask to be AND-ed to the key on lookup */
 225         uint8_t *key_mask;
 226 };
 227
 228 extern struct rte_table_ops rte_table_hash_key8_ext_ops;
 229
 230 /**
 231  * 16-byte key hash tables
 232  *
 233  */
 234 /** LRU hash table parameters */
 235 struct rte_table_hash_key16_lru_params {
 236         /** Maximum number of entries (and keys) in the table */
 237         uint32_t n_entries;
 238
 239         /** Hash function */
 240         rte_table_hash_op_hash f_hash;
 241
 242         /** Seed for the hash function */
 243         uint64_t seed;
 244
 245         /** Byte offset within packet meta-data where the 4-byte key signature
 246         is located. Valid for pre-computed key signature tables, ignored for
 247         do-sig tables. */
 248         uint32_t signature_offset;
 249
 250         /** Byte offset within packet meta-data where the key is located */
 251         uint32_t key_offset;
 252
 253         /** Bit-mask to be AND-ed to the key on lookup */
 254         uint8_t *key_mask;
 255 };
 256
 257 extern struct rte_table_ops rte_table_hash_key16_lru_ops;
 258
 259 /** Extendible bucket hash table parameters */
 260 struct rte_table_hash_key16_ext_params {
 261         /** Maximum number of entries (and keys) in the table */
 262         uint32_t n_entries;
 263
 264         /** Number of entries (and keys) for hash table bucket extensions. Each
 265         bucket is extended in increments of 4 keys. */
 266         uint32_t n_entries_ext;
 267
 268         /** Hash function */
 269         rte_table_hash_op_hash f_hash;
 270
 271         /** Seed for the hash function */
 272         uint64_t seed;
 273
 274         /** Byte offset within packet meta-data where the 4-byte key signature
 275         is located. Valid for pre-computed key signature tables, ignored for
 276         do-sig tables. */
 277         uint32_t signature_offset;
 278
 279         /** Byte offset within packet meta-data where the key is located */
 280         uint32_t key_offset;
 281
 282         /** Bit-mask to be AND-ed to the key on lookup */
 283         uint8_t *key_mask;
 284 };
 285
 286 extern struct rte_table_ops rte_table_hash_key16_ext_ops;
 287
 288 /**
 289  * 32-byte key hash tables
 290  *
 291  */
 292 /** LRU hash table parameters */
 293 struct rte_table_hash_key32_lru_params {
 294         /** Maximum number of entries (and keys) in the table */
 295         uint32_t n_entries;
 296
 297         /** Hash function */
 298         rte_table_hash_op_hash f_hash;
 299
 300         /** Seed for the hash function */
 301         uint64_t seed;
 302
 303         /** Byte offset within packet meta-data where the 4-byte key signature
 304         is located. Valid for pre-computed key signature tables, ignored for
 305         do-sig tables. */
 306         uint32_t signature_offset;
 307
 308         /** Byte offset within packet meta-data where the key is located */
 309         uint32_t key_offset;
 310 };
 311
 312 /** LRU hash table operations for pre-computed key signature */
 313 extern struct rte_table_ops rte_table_hash_key32_lru_ops;
 314
 315 /** Extendible bucket hash table parameters */
 316 struct rte_table_hash_key32_ext_params {
 317         /** Maximum number of entries (and keys) in the table */
 318         uint32_t n_entries;
 319
 320         /** Number of entries (and keys) for hash table bucket extensions. Each
 321                 bucket is extended in increments of 4 keys. */
 322         uint32_t n_entries_ext;
 323
 324         /** Hash function */
 325         rte_table_hash_op_hash f_hash;
 326
 327         /** Seed for the hash function */
 328         uint64_t seed;
 329
 330         /** Byte offset within packet meta-data where the 4-byte key signature
 331         is located. Valid for pre-computed key signature tables, ignored for
 332         do-sig tables. */
 333         uint32_t signature_offset;
 334
 335         /** Byte offset within packet meta-data where the key is located */
 336         uint32_t key_offset;
 337 };
 338
 339 /** Extendible bucket hash table operations */
 340 extern struct rte_table_ops rte_table_hash_key32_ext_ops;
 341
 342 /** Cuckoo hash table parameters */
 343 struct rte_table_hash_cuckoo_params {
 344     /** Key size (number of bytes */
 345                 uint32_t key_size;
 346
 347         /** Maximum number of hash table entries */
 348         uint32_t n_keys;
 349
 350         /** Hash function used to calculate hash */
 351         rte_table_hash_op_hash f_hash;
 352
 353         /** Seed value or Init value used by f_hash */
 354         uint32_t seed;
 355
 356         /** Byte offset within packet meta-data where the 4-byte key signature
 357         is located. Valid for pre-computed key signature tables, ignored for
 358         do-sig tables. */
 359         uint32_t signature_offset;
 360
 361         /** Byte offset within packet meta-data where the key is located */
 362         uint32_t key_offset;
 363
 364         /** Hash table name */
 365         const char *name;
 366 };
 367
 368 /** Cuckoo hash table operations */
 369 extern struct rte_table_ops rte_table_hash_cuckoo_dosig_ops;
 370
 371 #ifdef __cplusplus
 372 }
 373 #endif
 374
 375 #endif