lib/librte_member/rte_member.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2017 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 /**
  35  * @file
  36  *
  37  * RTE Membership Library
  38  *
  39  * The Membership Library is an extension and generalization of a traditional
  40  * filter (for example Bloom Filter and cuckoo filter) structure that has
  41  * multiple usages in a variety of workloads and applications. The library is
  42  * used to test if a key belongs to certain sets. Two types of such
  43  * "set-summary" structures are implemented: hash-table based (HT) and vector
  44  * bloom filter (vBF). For HT setsummary, two subtypes or modes are available,
  45  * cache and non-cache modes. The table below summarize some properties of
  46  * the different implementations.
  47  *
  48  * @warning
  49  * @b EXPERIMENTAL: this API may change without prior notice
  50  */
  51
  52 /**
  53  * <!--
  54  * +==========+=====================+================+=========================+
  55  * |   type   |      vbf            |     HT-cache   |     HT-non-cache        |
  56  * +==========+=====================+==========================================+
  57  * |structure |  bloom-filter array |  hash-table like without storing key     |
  58  * +----------+---------------------+------------------------------------------+
  59  * |set id    | limited by bf count |           [1, 0x7fff]                    |
  60  * |          | up to 32.           |                                          |
  61  * +----------+---------------------+------------------------------------------+
  62  * |usages &  | small set range,    | can delete,    | cache most recent keys, |
  63  * |properties| user-specified      | big set range, | have both false-positive|
  64  * |          | false-positive rate,| small false    | and false-negative      |
  65  * |          | no deletion support.| positive depend| depend on table size,   |
  66  * |          |                     | on table size, | automatic overwritten.  |
  67  * |          |                     | new key does   |                         |
  68  * |          |                     | not overwrite  |                         |
  69  * |          |                     | existing key.  |                         |
  70  * +----------+---------------------+----------------+-------------------------+
  71  * -->
  72  */
  73
  74 #ifndef _RTE_MEMBER_H_
  75 #define _RTE_MEMBER_H_
  76
  77 #ifdef __cplusplus
  78 extern "C" {
  79 #endif
  80
  81 #include <stdint.h>
  82
  83 /** The set ID type that stored internally in hash table based set summary. */
  84 typedef uint16_t member_set_t;
  85 /** Invalid set ID used to mean no match found. */
  86 #define RTE_MEMBER_NO_MATCH 0
  87 /** Maximum size of hash table that can be created. */
  88 #define RTE_MEMBER_ENTRIES_MAX (1 << 30)
  89 /** Maximum number of keys that can be searched as a bulk */
  90 #define RTE_MEMBER_LOOKUP_BULK_MAX 64
  91 /** Entry count per bucket in hash table based mode. */
  92 #define RTE_MEMBER_BUCKET_ENTRIES 16
  93 /** Maximum number of characters in setsum name. */
  94 #define RTE_MEMBER_NAMESIZE 32
  95
  96 /** @internal Hash function used by membership library. */
  97 #if defined(RTE_ARCH_X86) || defined(RTE_MACHINE_CPUFLAG_CRC32)
  98 #include <rte_hash_crc.h>
  99 #define MEMBER_HASH_FUNC       rte_hash_crc
 100 #else
 101 #include <rte_jhash.h>
 102 #define MEMBER_HASH_FUNC       rte_jhash
 103 #endif
 104
 105 extern int librte_member_logtype;
 106
 107 #define RTE_MEMBER_LOG(level, fmt, args...) \
 108 rte_log(RTE_LOG_ ## level, librte_member_logtype, "%s(): " fmt, \
 109         __func__, ## args)
 110
 111 /** @internal setsummary structure. */
 112 struct rte_member_setsum;
 113
 114 /**
 115  * @warning
 116  * @b EXPERIMENTAL: this API may change without prior notice
 117  *
 118  * Parameter struct used to create set summary
 119  */
 120 struct rte_member_parameters;
 121
 122 /**
 123  * @warning
 124  * @b EXPERIMENTAL: this API may change without prior notice
 125  *
 126  * Define different set summary types
 127  */
 128 enum rte_member_setsum_type {
 129         RTE_MEMBER_TYPE_HT = 0,  /**< Hash table based set summary. */
 130         RTE_MEMBER_NUM_TYPE
 131 };
 132
 133 /** @internal compare function for different arch. */
 134 enum rte_member_sig_compare_function {
 135         RTE_MEMBER_COMPARE_SCALAR = 0,
 136         RTE_MEMBER_COMPARE_NUM
 137 };
 138
 139 /** @internal setsummary structure. */
 140 struct rte_member_setsum {
 141         enum rte_member_setsum_type type; /* Type of the set summary. */
 142         uint32_t key_len;               /* Length of key. */
 143         uint32_t prim_hash_seed;        /* Primary hash function seed. */
 144         uint32_t sec_hash_seed;         /* Secondary hash function seed. */
 145
 146         /* Hash table based. */
 147         uint32_t bucket_cnt;            /* Number of buckets. */
 148         uint32_t bucket_mask;           /* Bit mask to get bucket index. */
 149         /* For runtime selecting AVX, scalar, etc for signature comparison. */
 150         enum rte_member_sig_compare_function sig_cmp_fn;
 151         uint8_t cache;                  /* If it is cache mode for ht based. */
 152
 153         /* Vector bloom filter. */
 154         uint32_t num_set;               /* Number of set (bf) in vbf. */
 155         uint32_t bits;                  /* Number of bits in each bf. */
 156         uint32_t bit_mask;      /* Bit mask to get bit location in bf. */
 157         uint32_t num_hashes;    /* Number of hash values to index bf. */
 158
 159         uint32_t mul_shift;  /* vbf internal variable used during bit test. */
 160         uint32_t div_shift;  /* vbf internal variable used during bit test. */
 161
 162         void *table;    /* This is the handler of hash table or vBF array. */
 163
 164
 165         /* Second cache line should start here. */
 166         uint32_t socket_id;          /* NUMA Socket ID for memory. */
 167         char name[RTE_MEMBER_NAMESIZE]; /* Name of this set summary. */
 168 } __rte_cache_aligned;
 169
 170 /**
 171  * @warning
 172  * @b EXPERIMENTAL: this API may change without prior notice
 173  *
 174  * Parameters used when create the set summary table. Currently user can
 175  * specify two types of setsummary: HT based and vBF. For HT based, user can
 176  * specify cache or non-cache mode. Here is a table to describe some differences
 177  *
 178  */
 179 struct rte_member_parameters {
 180         const char *name;                       /**< Name of the hash. */
 181
 182         /**
 183          * User to specify the type of the setsummary from one of
 184          * rte_member_setsum_type.
 185          *
 186          * HT based setsummary is implemented like a hash table. User should use
 187          * this type when there are many sets.
 188          *
 189          * vBF setsummary is a vector of bloom filters. It is used when number
 190          * of sets is not big (less than 32 for current implementation).
 191          */
 192         enum rte_member_setsum_type type;
 193
 194         /**
 195          * is_cache is only used for HT based setsummary.
 196          *
 197          * If it is HT based setsummary, user to specify the subtype or mode
 198          * of the setsummary. It could be cache, or non-cache mode.
 199          * Set is_cache to be 1 if to use as cache mode.
 200          *
 201          * For cache mode, keys can be evicted out of the HT setsummary. Keys
 202          * with the same signature and map to the same bucket
 203          * will overwrite each other in the setsummary table.
 204          * This mode is useful for the case that the set-summary only
 205          * needs to keep record of the recently inserted keys. Both
 206          * false-negative and false-positive could happen.
 207          *
 208          * For non-cache mode, keys cannot be evicted out of the cache. So for
 209          * this mode the setsummary will become full eventually. Keys with the
 210          * same signature but map to the same bucket will still occupy multiple
 211          * entries. This mode does not give false-negative result.
 212          */
 213         uint8_t is_cache;
 214
 215         /**
 216          * For HT setsummary, num_keys equals to the number of entries of the
 217          * table. When the number of keys inserted in the HT setsummary
 218          * approaches this number, eviction could happen. For cache mode,
 219          * keys could be evicted out of the table. For non-cache mode, keys will
 220          * be evicted to other buckets like cuckoo hash. The table will also
 221          * likely to become full before the number of inserted keys equal to the
 222          * total number of entries.
 223          *
 224          * For vBF, num_keys equal to the expected number of keys that will
 225          * be inserted into the vBF. The implementation assumes the keys are
 226          * evenly distributed to each BF in vBF. This is used to calculate the
 227          * number of bits we need for each BF. User does not specify the size of
 228          * each BF directly because the optimal size depends on the num_keys
 229          * and false positive rate.
 230          */
 231         uint32_t num_keys;
 232
 233         /**
 234          * The length of key is used for hash calculation. Since key is not
 235          * stored in set-summary, large key does not require more memory space.
 236          */
 237         uint32_t key_len;
 238
 239         /**
 240          * num_set is only used for vBF, but not used for HT setsummary.
 241          *
 242          * num_set is equal to the number of BFs in vBF. For current
 243          * implementation, it only supports 1,2,4,8,16,32 BFs in one vBF set
 244          * summary. If other number of sets are needed, for example 5, the user
 245          * should allocate the minimum available value that larger than 5,
 246          * which is 8.
 247          */
 248         uint32_t num_set;
 249
 250         /**
 251          * false_positive_rate is only used for vBF, but not used for HT
 252          * setsummary.
 253          *
 254          * For vBF, false_positive_rate is the user-defined false positive rate
 255          * given expected number of inserted keys (num_keys). It is used to
 256          * calculate the total number of bits for each BF, and the number of
 257          * hash values used during lookup and insertion. For details please
 258          * refer to vBF implementation and membership library documentation.
 259          *
 260          * For HT, This parameter is not directly set by users.
 261          * HT setsummary's false positive rate is in the order of:
 262          * false_pos = (1/bucket_count)*(1/2^16), since we use 16-bit signature.
 263          * This is because two keys needs to map to same bucket and same
 264          * signature to have a collision (false positive). bucket_count is equal
 265          * to number of entries (num_keys) divided by entry count per bucket
 266          * (RTE_MEMBER_BUCKET_ENTRIES). Thus, the false_positive_rate is not
 267          * directly set by users for HT mode.
 268          */
 269         float false_positive_rate;
 270
 271         /**
 272          * We use two seeds to calculate two independent hashes for each key.
 273          *
 274          * For HT type, one hash is used as signature, and the other is used
 275          * for bucket location.
 276          * For vBF type, these two hashes and their combinations are used as
 277          * hash locations to index the bit array.
 278          */
 279         uint32_t prim_hash_seed;
 280
 281         /**
 282          * The secondary seed should be a different value from the primary seed.
 283          */
 284         uint32_t sec_hash_seed;
 285
 286         int socket_id;                  /**< NUMA Socket ID for memory. */
 287 };
 288
 289 /**
 290  * @warning
 291  * @b EXPERIMENTAL: this API may change without prior notice
 292  *
 293  * Find an existing set-summary and return a pointer to it.
 294  *
 295  * @param name
 296  *   Name of the set-summary.
 297  * @return
 298  *   Pointer to the set-summary or NULL if object not found
 299  *   with rte_errno set appropriately. Possible rte_errno values include:
 300  *    - ENOENT - value not available for return
 301  */
 302 struct rte_member_setsum *
 303 rte_member_find_existing(const char *name);
 304
 305 /**
 306  * @warning
 307  * @b EXPERIMENTAL: this API may change without prior notice
 308  *
 309  * Create set-summary (SS).
 310  *
 311  * @param params
 312  *   Parameters to initialize the setsummary.
 313  * @return
 314  *   Return the pointer to the setsummary.
 315  *   Return value is NULL if the creation failed.
 316  */
 317 struct rte_member_setsum *
 318 rte_member_create(const struct rte_member_parameters *params);
 319
 320 /**
 321  * @warning
 322  * @b EXPERIMENTAL: this API may change without prior notice
 323  *
 324  * Lookup key in set-summary (SS).
 325  * Single key lookup and return as soon as the first match found
 326  *
 327  * @param setsum
 328  *   Pointer of a setsummary.
 329  * @param key
 330  *   Pointer of the key to be looked up.
 331  * @param set_id
 332  *   Output the set id matches the key.
 333  * @return
 334  *   Return 1 for found a match and 0 for not found a match.
 335  */
 336 int
 337 rte_member_lookup(const struct rte_member_setsum *setsum, const void *key,
 338                         member_set_t *set_id);
 339
 340 /**
 341  * @warning
 342  * @b EXPERIMENTAL: this API may change without prior notice
 343  *
 344  * Lookup bulk of keys in set-summary (SS).
 345  * Each key lookup returns as soon as the first match found
 346  *
 347  * @param setsum
 348  *   Pointer of a setsummary.
 349  * @param keys
 350  *   Pointer of the bulk of keys to be looked up.
 351  * @param num_keys
 352  *   Number of keys that will be lookup.
 353  * @param set_ids
 354  *   Output set ids for all the keys to this array.
 355  *   User should preallocate array that can contain all results, which size is
 356  *   the num_keys.
 357  * @return
 358  *   The number of keys that found a match.
 359  */
 360 int
 361 rte_member_lookup_bulk(const struct rte_member_setsum *setsum,
 362                         const void **keys, uint32_t num_keys,
 363                         member_set_t *set_ids);
 364
 365 /**
 366  * @warning
 367  * @b EXPERIMENTAL: this API may change without prior notice
 368  *
 369  * Lookup a key in set-summary (SS) for multiple matches.
 370  * The key lookup will find all matched entries (multiple match).
 371  * Note that for cache mode of HT, each key can have at most one match. This is
 372  * because keys with same signature that maps to same bucket will overwrite
 373  * each other. So multi-match lookup should be used for vBF and non-cache HT.
 374  *
 375  * @param setsum
 376  *   Pointer of a set-summary.
 377  * @param key
 378  *   Pointer of the key that to be looked up.
 379  * @param max_match_per_key
 380  *   User specified maximum number of matches for each key. The function returns
 381  *   as soon as this number of matches found for the key.
 382  * @param set_id
 383  *   Output set ids for all the matches of the key. User needs to preallocate
 384  *   the array that can contain max_match_per_key number of results.
 385  * @return
 386  *   The number of matches that found for the key.
 387  *   For cache mode HT set-summary, the number should be at most 1.
 388  */
 389 int
 390 rte_member_lookup_multi(const struct rte_member_setsum *setsum,
 391                 const void *key, uint32_t max_match_per_key,
 392                 member_set_t *set_id);
 393
 394 /**
 395  * @warning
 396  * @b EXPERIMENTAL: this API may change without prior notice
 397  *
 398  * Lookup a bulk of keys in set-summary (SS) for multiple matches each key.
 399  * Each key lookup will find all matched entries (multiple match).
 400  * Note that for cache mode HT, each key can have at most one match. So
 401  * multi-match function is mainly used for vBF and non-cache mode HT.
 402  *
 403  * @param setsum
 404  *   Pointer of a setsummary.
 405  * @param keys
 406  *   Pointer of the keys to be looked up.
 407  * @param num_keys
 408  *   The number of keys that will be lookup.
 409  * @param max_match_per_key
 410  *   The possible maximum number of matches for each key.
 411  * @param match_count
 412  *   Output the number of matches for each key in an array.
 413  * @param set_ids
 414  *   Return set ids for all the matches of all keys. Users pass in a
 415  *   preallocated 2D array with first dimension as key index and second
 416  *   dimension as match index. For example set_ids[bulk_size][max_match_per_key]
 417  * @return
 418  *   The number of keys that found one or more matches in the set-summary.
 419  */
 420 int
 421 rte_member_lookup_multi_bulk(const struct rte_member_setsum *setsum,
 422                 const void **keys, uint32_t num_keys,
 423                 uint32_t max_match_per_key,
 424                 uint32_t *match_count,
 425                 member_set_t *set_ids);
 426
 427 /**
 428  * @warning
 429  * @b EXPERIMENTAL: this API may change without prior notice
 430  *
 431  * Insert key into set-summary (SS).
 432  *
 433  * @param setsum
 434  *   Pointer of a set-summary.
 435  * @param key
 436  *   Pointer of the key to be added.
 437  * @param set_id
 438  *   The set id associated with the key that needs to be added. Different mode
 439  *   supports different set_id ranges. 0 cannot be used as set_id since
 440  *   RTE_MEMBER_NO_MATCH by default is set as 0.
 441  *   For HT mode, the set_id has range as [1, 0x7FFF], MSB is reserved.
 442  *   For vBF mode the set id is limited by the num_set parameter when create
 443  *   the set-summary.
 444  * @return
 445  *   HT (cache mode) and vBF should never fail unless the set_id is not in the
 446  *   valid range. In such case -EINVAL is returned.
 447  *   For HT (non-cache mode) it could fail with -ENOSPC error code when table is
 448  *   full.
 449  *   For success it returns different values for different modes to provide
 450  *   extra information for users.
 451  *   Return 0 for HT (cache mode) if the add does not cause
 452  *   eviction, return 1 otherwise. Return 0 for non-cache mode if success,
 453  *   -ENOSPC for full, and 1 if cuckoo eviction happens.
 454  *   Always returns 0 for vBF mode.
 455  */
 456 int
 457 rte_member_add(const struct rte_member_setsum *setsum, const void *key,
 458                         member_set_t set_id);
 459
 460 /**
 461  * @warning
 462  * @b EXPERIMENTAL: this API may change without prior notice
 463  *
 464  * De-allocate memory used by set-summary.
 465  *
 466  * @param setsum
 467  *   Pointer to the set summary.
 468  */
 469 void
 470 rte_member_free(struct rte_member_setsum *setsum);
 471
 472 /**
 473  * @warning
 474  * @b EXPERIMENTAL: this API may change without prior notice
 475  *
 476  * Reset the set-summary tables. E.g. reset bits to be 0 in BF,
 477  * reset set_id in each entry to be RTE_MEMBER_NO_MATCH in HT based SS.
 478  *
 479  * @param setsum
 480  *   Pointer to the set-summary.
 481  */
 482 void
 483 rte_member_reset(const struct rte_member_setsum *setsum);
 484
 485 /**
 486  * @warning
 487  * @b EXPERIMENTAL: this API may change without prior notice
 488  *
 489  * Delete items from the set-summary. Note that vBF does not support deletion
 490  * in current implementation. For vBF, error code of -EINVAL will be returned.
 491  *
 492  * @param setsum
 493  *   Pointer to the set-summary.
 494  * @param key
 495  *   Pointer of the key to be deleted.
 496  * @param set_id
 497  *   For HT mode, we need both key and its corresponding set_id to
 498  *   properly delete the key. Without set_id, we may delete other keys with the
 499  *   same signature.
 500  * @return
 501  *   If no entry found to delete, an error code of -ENOENT could be returned.
 502  */
 503 int
 504 rte_member_delete(const struct rte_member_setsum *setsum, const void *key,
 505                         member_set_t set_id);
 506
 507 #ifdef __cplusplus
 508 }
 509 #endif
 510
 511 #endif /* _RTE_MEMBER_H_ */