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