lib/librte_member/rte_member_ht.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 #ifndef _RTE_MEMBER_HT_H_
  35 #define _RTE_MEMBER_HT_H_
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /* Maximum number of pushes for cuckoo path in HT mode. */
  42 #define RTE_MEMBER_MAX_PUSHES 50
  43
  44 typedef uint16_t member_sig_t;                  /* signature size is 16 bit */
  45
  46 /* The bucket struct for ht setsum */
  47 struct member_ht_bucket {
  48         member_sig_t sigs[RTE_MEMBER_BUCKET_ENTRIES];   /* 2-byte signature */
  49         member_set_t sets[RTE_MEMBER_BUCKET_ENTRIES];   /* 2-byte set */
  50 } __rte_cache_aligned;
  51
  52 int
  53 rte_member_create_ht(struct rte_member_setsum *ss,
  54                 const struct rte_member_parameters *params);
  55
  56 int
  57 rte_member_lookup_ht(const struct rte_member_setsum *setsum,
  58                 const void *key, member_set_t *set_id);
  59
  60 uint32_t
  61 rte_member_lookup_bulk_ht(const struct rte_member_setsum *setsum,
  62                 const void **keys, uint32_t num_keys,
  63                 member_set_t *set_ids);
  64
  65 uint32_t
  66 rte_member_lookup_multi_ht(const struct rte_member_setsum *setsum,
  67                 const void *key, uint32_t match_per_key,
  68                 member_set_t *set_id);
  69
  70 uint32_t
  71 rte_member_lookup_multi_bulk_ht(const struct rte_member_setsum *setsum,
  72                 const void **keys, uint32_t num_keys, uint32_t match_per_key,
  73                 uint32_t *match_count,
  74                 member_set_t *set_ids);
  75
  76 int
  77 rte_member_add_ht(const struct rte_member_setsum *setsum,
  78                 const void *key, member_set_t set_id);
  79
  80 void
  81 rte_member_free_ht(struct rte_member_setsum *setsum);
  82
  83 int
  84 rte_member_delete_ht(const struct rte_member_setsum *ss, const void *key,
  85                 member_set_t set_id);
  86
  87 void
  88 rte_member_reset_ht(const struct rte_member_setsum *setsum);
  89
  90 #ifdef __cplusplus
  91 }
  92 #endif
  93
  94 #endif /* _RTE_MEMBER_HT_H_ */