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 extern struct rte_table_ops rte_table_hash_lru_ops;
 167
 168 /**
 169  * 8-byte key hash tables
 170  *
 171  */
 172 /** LRU hash table parameters */
 173 struct rte_table_hash_key8_lru_params {
 174         /** Maximum number of entries (and keys) in the table */
 175         uint32_t n_entries;
 176
 177         /** Hash function */
 178         rte_table_hash_op_hash f_hash;
 179
 180         /** Seed for the hash function */
 181         uint64_t seed;
 182
 183         /** Byte offset within packet meta-data where the 4-byte key signature
 184         is located. Valid for pre-computed key signature tables, ignored for
 185         do-sig tables. */
 186         uint32_t signature_offset;
 187
 188         /** Byte offset within packet meta-data where the key is located */
 189         uint32_t key_offset;
 190
 191         /** Bit-mask to be AND-ed to the key on lookup */
 192         uint8_t *key_mask;
 193 };
 194
 195 extern struct rte_table_ops rte_table_hash_key8_lru_ops;
 196
 197 /** Extendible bucket hash table parameters */
 198 struct rte_table_hash_key8_ext_params {
 199         /** Maximum number of entries (and keys) in the table */
 200         uint32_t n_entries;
 201
 202         /** Number of entries (and keys) for hash table bucket extensions. Each
 203                 bucket is extended in increments of 4 keys. */
 204         uint32_t n_entries_ext;
 205
 206         /** Hash function */
 207         rte_table_hash_op_hash f_hash;
 208
 209         /** Seed for the hash function */
 210         uint64_t seed;
 211
 212         /** Byte offset within packet meta-data where the 4-byte key signature
 213         is located. Valid for pre-computed key signature tables, ignored for
 214         do-sig tables. */
 215         uint32_t signature_offset;
 216
 217         /** Byte offset within packet meta-data where the key is located */
 218         uint32_t key_offset;
 219
 220         /** Bit-mask to be AND-ed to the key on lookup */
 221         uint8_t *key_mask;
 222 };
 223
 224 extern struct rte_table_ops rte_table_hash_key8_ext_ops;
 225
 226 /**
 227  * 16-byte key hash tables
 228  *
 229  */
 230 /** LRU hash table parameters */
 231 struct rte_table_hash_key16_lru_params {
 232         /** Maximum number of entries (and keys) in the table */
 233         uint32_t n_entries;
 234
 235         /** Hash function */
 236         rte_table_hash_op_hash f_hash;
 237
 238         /** Seed for the hash function */
 239         uint64_t seed;
 240
 241         /** Byte offset within packet meta-data where the 4-byte key signature
 242         is located. Valid for pre-computed key signature tables, ignored for
 243         do-sig tables. */
 244         uint32_t signature_offset;
 245
 246         /** Byte offset within packet meta-data where the key is located */
 247         uint32_t key_offset;
 248
 249         /** Bit-mask to be AND-ed to the key on lookup */
 250         uint8_t *key_mask;
 251 };
 252
 253 extern struct rte_table_ops rte_table_hash_key16_lru_ops;
 254
 255 /** Extendible bucket hash table parameters */
 256 struct rte_table_hash_key16_ext_params {
 257         /** Maximum number of entries (and keys) in the table */
 258         uint32_t n_entries;
 259
 260         /** Number of entries (and keys) for hash table bucket extensions. Each
 261         bucket is extended in increments of 4 keys. */
 262         uint32_t n_entries_ext;
 263
 264         /** Hash function */
 265         rte_table_hash_op_hash f_hash;
 266
 267         /** Seed for the hash function */
 268         uint64_t seed;
 269
 270         /** Byte offset within packet meta-data where the 4-byte key signature
 271         is located. Valid for pre-computed key signature tables, ignored for
 272         do-sig tables. */
 273         uint32_t signature_offset;
 274
 275         /** Byte offset within packet meta-data where the key is located */
 276         uint32_t key_offset;
 277
 278         /** Bit-mask to be AND-ed to the key on lookup */
 279         uint8_t *key_mask;
 280 };
 281
 282 extern struct rte_table_ops rte_table_hash_key16_ext_ops;
 283
 284 /**
 285  * 32-byte key hash tables
 286  *
 287  */
 288 /** LRU hash table parameters */
 289 struct rte_table_hash_key32_lru_params {
 290         /** Maximum number of entries (and keys) in the table */
 291         uint32_t n_entries;
 292
 293         /** Hash function */
 294         rte_table_hash_op_hash f_hash;
 295
 296         /** Seed for the hash function */
 297         uint64_t seed;
 298
 299         /** Byte offset within packet meta-data where the 4-byte key signature
 300         is located. Valid for pre-computed key signature tables, ignored for
 301         do-sig tables. */
 302         uint32_t signature_offset;
 303
 304         /** Byte offset within packet meta-data where the key is located */
 305         uint32_t key_offset;
 306 };
 307
 308 /** LRU hash table operations for pre-computed key signature */
 309 extern struct rte_table_ops rte_table_hash_key32_lru_ops;
 310
 311 /** Extendible bucket hash table parameters */
 312 struct rte_table_hash_key32_ext_params {
 313         /** Maximum number of entries (and keys) in the table */
 314         uint32_t n_entries;
 315
 316         /** Number of entries (and keys) for hash table bucket extensions. Each
 317                 bucket is extended in increments of 4 keys. */
 318         uint32_t n_entries_ext;
 319
 320         /** Hash function */
 321         rte_table_hash_op_hash f_hash;
 322
 323         /** Seed for the hash function */
 324         uint64_t seed;
 325
 326         /** Byte offset within packet meta-data where the 4-byte key signature
 327         is located. Valid for pre-computed key signature tables, ignored for
 328         do-sig tables. */
 329         uint32_t signature_offset;
 330
 331         /** Byte offset within packet meta-data where the key is located */
 332         uint32_t key_offset;
 333 };
 334
 335 /** Extendible bucket hash table operations */
 336 extern struct rte_table_ops rte_table_hash_key32_ext_ops;
 337
 338 /** Cuckoo hash table parameters */
 339 struct rte_table_hash_cuckoo_params {
 340     /** Key size (number of bytes */
 341                 uint32_t key_size;
 342
 343         /** Maximum number of hash table entries */
 344         uint32_t n_keys;
 345
 346         /** Hash function used to calculate hash */
 347         rte_table_hash_op_hash f_hash;
 348
 349         /** Seed value or Init value used by f_hash */
 350         uint32_t seed;
 351
 352         /** Byte offset within packet meta-data where the 4-byte key signature
 353         is located. Valid for pre-computed key signature tables, ignored for
 354         do-sig tables. */
 355         uint32_t signature_offset;
 356
 357         /** Byte offset within packet meta-data where the key is located */
 358         uint32_t key_offset;
 359
 360         /** Hash table name */
 361         const char *name;
 362 };
 363
 364 extern struct rte_table_ops rte_table_hash_cuckoo_ops;
 365
 366 #ifdef __cplusplus
 367 }
 368 #endif
 369
 370 #endif