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         void *key_mask,
 102         uint32_t key_size,
 103         uint64_t seed);
 104
 105 /** Hash table parameters */
 106 struct rte_table_hash_params {
 107         /** Name */
 108         const char *name;
 109
 110         /** Key size (number of bytes) */
 111         uint32_t key_size;
 112
 113         /** Byte offset within packet meta-data where the key is located */
 114         uint32_t key_offset;
 115
 116         /** Key mask */
 117         uint8_t *key_mask;
 118
 119         /** Number of keys */
 120         uint32_t n_keys;
 121
 122         /** Number of buckets */
 123         uint32_t n_buckets;
 124
 125         /** Hash function */
 126         rte_table_hash_op_hash f_hash;
 127
 128         /** Seed value for the hash function */
 129         uint64_t seed;
 130 };
 131
 132 /** Hash function */
 133 typedef uint64_t (*rte_table_hash_op_hash_nomask)(
 134         void *key,
 135         uint32_t key_size,
 136         uint64_t seed);
 137
 138 extern struct rte_table_ops rte_table_hash_ext_ops;
 139
 140 extern struct rte_table_ops rte_table_hash_lru_ops;
 141
 142 extern struct rte_table_ops rte_table_hash_key8_lru_ops;
 143
 144 extern struct rte_table_ops rte_table_hash_key8_ext_ops;
 145
 146 /**
 147  * 16-byte key hash tables
 148  *
 149  */
 150 /** LRU hash table parameters */
 151 struct rte_table_hash_key16_lru_params {
 152         /** Maximum number of entries (and keys) in the table */
 153         uint32_t n_entries;
 154
 155         /** Hash function */
 156         rte_table_hash_op_hash_nomask f_hash;
 157
 158         /** Seed for the hash function */
 159         uint64_t seed;
 160
 161         /** Byte offset within packet meta-data where the 4-byte key signature
 162         is located. Valid for pre-computed key signature tables, ignored for
 163         do-sig tables. */
 164         uint32_t signature_offset;
 165
 166         /** Byte offset within packet meta-data where the key is located */
 167         uint32_t key_offset;
 168
 169         /** Bit-mask to be AND-ed to the key on lookup */
 170         uint8_t *key_mask;
 171 };
 172
 173 extern struct rte_table_ops rte_table_hash_key16_lru_ops;
 174
 175 /** Extendible bucket hash table parameters */
 176 struct rte_table_hash_key16_ext_params {
 177         /** Maximum number of entries (and keys) in the table */
 178         uint32_t n_entries;
 179
 180         /** Number of entries (and keys) for hash table bucket extensions. Each
 181         bucket is extended in increments of 4 keys. */
 182         uint32_t n_entries_ext;
 183
 184         /** Hash function */
 185         rte_table_hash_op_hash_nomask f_hash;
 186
 187         /** Seed for the hash function */
 188         uint64_t seed;
 189
 190         /** Byte offset within packet meta-data where the 4-byte key signature
 191         is located. Valid for pre-computed key signature tables, ignored for
 192         do-sig tables. */
 193         uint32_t signature_offset;
 194
 195         /** Byte offset within packet meta-data where the key is located */
 196         uint32_t key_offset;
 197
 198         /** Bit-mask to be AND-ed to the key on lookup */
 199         uint8_t *key_mask;
 200 };
 201
 202 extern struct rte_table_ops rte_table_hash_key16_ext_ops;
 203
 204 /**
 205  * 32-byte key hash tables
 206  *
 207  */
 208 /** LRU hash table parameters */
 209 struct rte_table_hash_key32_lru_params {
 210         /** Maximum number of entries (and keys) in the table */
 211         uint32_t n_entries;
 212
 213         /** Hash function */
 214         rte_table_hash_op_hash_nomask f_hash;
 215
 216         /** Seed for the hash function */
 217         uint64_t seed;
 218
 219         /** Byte offset within packet meta-data where the 4-byte key signature
 220         is located. Valid for pre-computed key signature tables, ignored for
 221         do-sig tables. */
 222         uint32_t signature_offset;
 223
 224         /** Byte offset within packet meta-data where the key is located */
 225         uint32_t key_offset;
 226 };
 227
 228 /** LRU hash table operations for pre-computed key signature */
 229 extern struct rte_table_ops rte_table_hash_key32_lru_ops;
 230
 231 /** Extendible bucket hash table parameters */
 232 struct rte_table_hash_key32_ext_params {
 233         /** Maximum number of entries (and keys) in the table */
 234         uint32_t n_entries;
 235
 236         /** Number of entries (and keys) for hash table bucket extensions. Each
 237                 bucket is extended in increments of 4 keys. */
 238         uint32_t n_entries_ext;
 239
 240         /** Hash function */
 241         rte_table_hash_op_hash_nomask f_hash;
 242
 243         /** Seed for the hash function */
 244         uint64_t seed;
 245
 246         /** Byte offset within packet meta-data where the 4-byte key signature
 247         is located. Valid for pre-computed key signature tables, ignored for
 248         do-sig tables. */
 249         uint32_t signature_offset;
 250
 251         /** Byte offset within packet meta-data where the key is located */
 252         uint32_t key_offset;
 253 };
 254
 255 /** Extendible bucket hash table operations */
 256 extern struct rte_table_ops rte_table_hash_key32_ext_ops;
 257
 258 /** Cuckoo hash table parameters */
 259 struct rte_table_hash_cuckoo_params {
 260     /** Key size (number of bytes */
 261                 uint32_t key_size;
 262
 263         /** Maximum number of hash table entries */
 264         uint32_t n_keys;
 265
 266         /** Hash function used to calculate hash */
 267         rte_table_hash_op_hash_nomask f_hash;
 268
 269         /** Seed value or Init value used by f_hash */
 270         uint32_t seed;
 271
 272         /** Byte offset within packet meta-data where the 4-byte key signature
 273         is located. Valid for pre-computed key signature tables, ignored for
 274         do-sig tables. */
 275         uint32_t signature_offset;
 276
 277         /** Byte offset within packet meta-data where the key is located */
 278         uint32_t key_offset;
 279
 280         /** Hash table name */
 281         const char *name;
 282 };
 283
 284 extern struct rte_table_ops rte_table_hash_cuckoo_ops;
 285
 286 #ifdef __cplusplus
 287 }
 288 #endif
 289
 290 #endif