apps: add mask-based hash functions
[dpdk.git] / lib / librte_table / rte_table_hash.h
index 5f655ee..3c53d6a 100644 (file)
@@ -98,54 +98,28 @@ extern "C" {
 /** Hash function */
 typedef uint64_t (*rte_table_hash_op_hash)(
        void *key,
+       void *key_mask,
        uint32_t key_size,
        uint64_t seed);
 
-/**
- * Hash tables with configurable key size
- *
- */
-/** Extendible bucket hash table parameters */
-struct rte_table_hash_ext_params {
+/** Hash table parameters */
+struct rte_table_hash_params {
+       /** Name */
+       const char *name;
+
        /** Key size (number of bytes) */
        uint32_t key_size;
 
-       /** Maximum number of keys */
-       uint32_t n_keys;
-
-       /** Number of hash table buckets. Each bucket stores up to 4 keys. */
-       uint32_t n_buckets;
-
-       /** Number of hash table bucket extensions. Each bucket extension has
-       space for 4 keys and each bucket can have 0, 1 or more extensions. */
-       uint32_t n_buckets_ext;
-
-       /** Hash function */
-       rte_table_hash_op_hash f_hash;
-
-       /** Seed value for the hash function */
-       uint64_t seed;
-
-       /** Byte offset within packet meta-data where the 4-byte key signature
-       is located. Valid for pre-computed key signature tables, ignored for
-       do-sig tables. */
-       uint32_t signature_offset;
-
        /** Byte offset within packet meta-data where the key is located */
        uint32_t key_offset;
-};
-
-extern struct rte_table_ops rte_table_hash_ext_ops;
 
-/** LRU hash table parameters */
-struct rte_table_hash_lru_params {
-       /** Key size (number of bytes) */
-       uint32_t key_size;
+       /** Key mask */
+       uint8_t *key_mask;
 
-       /** Maximum number of keys */
+       /** Number of keys */
        uint32_t n_keys;
 
-       /** Number of hash table buckets. Each bucket stores up to 4 keys. */
+       /** Number of buckets */
        uint32_t n_buckets;
 
        /** Hash function */
@@ -153,214 +127,24 @@ struct rte_table_hash_lru_params {
 
        /** Seed value for the hash function */
        uint64_t seed;
-
-       /** Byte offset within packet meta-data where the 4-byte key signature
-       is located. Valid for pre-computed key signature tables, ignored for
-       do-sig tables. */
-       uint32_t signature_offset;
-
-       /** Byte offset within packet meta-data where the key is located */
-       uint32_t key_offset;
 };
 
-extern struct rte_table_ops rte_table_hash_lru_ops;
-
-/**
- * 8-byte key hash tables
- *
- */
-/** LRU hash table parameters */
-struct rte_table_hash_key8_lru_params {
-       /** Maximum number of entries (and keys) in the table */
-       uint32_t n_entries;
-
-       /** Hash function */
-       rte_table_hash_op_hash f_hash;
-
-       /** Seed for the hash function */
-       uint64_t seed;
-
-       /** Byte offset within packet meta-data where the 4-byte key signature
-       is located. Valid for pre-computed key signature tables, ignored for
-       do-sig tables. */
-       uint32_t signature_offset;
-
-       /** Byte offset within packet meta-data where the key is located */
-       uint32_t key_offset;
+extern struct rte_table_ops rte_table_hash_ext_ops;
 
-       /** Bit-mask to be AND-ed to the key on lookup */
-       uint8_t *key_mask;
-};
+extern struct rte_table_ops rte_table_hash_lru_ops;
 
 extern struct rte_table_ops rte_table_hash_key8_lru_ops;
 
-/** Extendible bucket hash table parameters */
-struct rte_table_hash_key8_ext_params {
-       /** Maximum number of entries (and keys) in the table */
-       uint32_t n_entries;
-
-       /** Number of entries (and keys) for hash table bucket extensions. Each
-               bucket is extended in increments of 4 keys. */
-       uint32_t n_entries_ext;
-
-       /** Hash function */
-       rte_table_hash_op_hash f_hash;
-
-       /** Seed for the hash function */
-       uint64_t seed;
-
-       /** Byte offset within packet meta-data where the 4-byte key signature
-       is located. Valid for pre-computed key signature tables, ignored for
-       do-sig tables. */
-       uint32_t signature_offset;
-
-       /** Byte offset within packet meta-data where the key is located */
-       uint32_t key_offset;
-
-       /** Bit-mask to be AND-ed to the key on lookup */
-       uint8_t *key_mask;
-};
-
 extern struct rte_table_ops rte_table_hash_key8_ext_ops;
 
-/**
- * 16-byte key hash tables
- *
- */
-/** LRU hash table parameters */
-struct rte_table_hash_key16_lru_params {
-       /** Maximum number of entries (and keys) in the table */
-       uint32_t n_entries;
-
-       /** Hash function */
-       rte_table_hash_op_hash f_hash;
-
-       /** Seed for the hash function */
-       uint64_t seed;
-
-       /** Byte offset within packet meta-data where the 4-byte key signature
-       is located. Valid for pre-computed key signature tables, ignored for
-       do-sig tables. */
-       uint32_t signature_offset;
-
-       /** Byte offset within packet meta-data where the key is located */
-       uint32_t key_offset;
-
-       /** Bit-mask to be AND-ed to the key on lookup */
-       uint8_t *key_mask;
-};
-
 extern struct rte_table_ops rte_table_hash_key16_lru_ops;
 
-/** Extendible bucket hash table parameters */
-struct rte_table_hash_key16_ext_params {
-       /** Maximum number of entries (and keys) in the table */
-       uint32_t n_entries;
-
-       /** Number of entries (and keys) for hash table bucket extensions. Each
-       bucket is extended in increments of 4 keys. */
-       uint32_t n_entries_ext;
-
-       /** Hash function */
-       rte_table_hash_op_hash f_hash;
-
-       /** Seed for the hash function */
-       uint64_t seed;
-
-       /** Byte offset within packet meta-data where the 4-byte key signature
-       is located. Valid for pre-computed key signature tables, ignored for
-       do-sig tables. */
-       uint32_t signature_offset;
-
-       /** Byte offset within packet meta-data where the key is located */
-       uint32_t key_offset;
-
-       /** Bit-mask to be AND-ed to the key on lookup */
-       uint8_t *key_mask;
-};
-
 extern struct rte_table_ops rte_table_hash_key16_ext_ops;
 
-/**
- * 32-byte key hash tables
- *
- */
-/** LRU hash table parameters */
-struct rte_table_hash_key32_lru_params {
-       /** Maximum number of entries (and keys) in the table */
-       uint32_t n_entries;
-
-       /** Hash function */
-       rte_table_hash_op_hash f_hash;
-
-       /** Seed for the hash function */
-       uint64_t seed;
-
-       /** Byte offset within packet meta-data where the 4-byte key signature
-       is located. Valid for pre-computed key signature tables, ignored for
-       do-sig tables. */
-       uint32_t signature_offset;
-
-       /** Byte offset within packet meta-data where the key is located */
-       uint32_t key_offset;
-};
-
-/** LRU hash table operations for pre-computed key signature */
 extern struct rte_table_ops rte_table_hash_key32_lru_ops;
 
-/** Extendible bucket hash table parameters */
-struct rte_table_hash_key32_ext_params {
-       /** Maximum number of entries (and keys) in the table */
-       uint32_t n_entries;
-
-       /** Number of entries (and keys) for hash table bucket extensions. Each
-               bucket is extended in increments of 4 keys. */
-       uint32_t n_entries_ext;
-
-       /** Hash function */
-       rte_table_hash_op_hash f_hash;
-
-       /** Seed for the hash function */
-       uint64_t seed;
-
-       /** Byte offset within packet meta-data where the 4-byte key signature
-       is located. Valid for pre-computed key signature tables, ignored for
-       do-sig tables. */
-       uint32_t signature_offset;
-
-       /** Byte offset within packet meta-data where the key is located */
-       uint32_t key_offset;
-};
-
-/** Extendible bucket hash table operations */
 extern struct rte_table_ops rte_table_hash_key32_ext_ops;
 
-/** Cuckoo hash table parameters */
-struct rte_table_hash_cuckoo_params {
-    /** Key size (number of bytes */
-               uint32_t key_size;
-
-       /** Maximum number of hash table entries */
-       uint32_t n_keys;
-
-       /** Hash function used to calculate hash */
-       rte_table_hash_op_hash f_hash;
-
-       /** Seed value or Init value used by f_hash */
-       uint32_t seed;
-
-       /** Byte offset within packet meta-data where the 4-byte key signature
-       is located. Valid for pre-computed key signature tables, ignored for
-       do-sig tables. */
-       uint32_t signature_offset;
-
-       /** Byte offset within packet meta-data where the key is located */
-       uint32_t key_offset;
-
-       /** Hash table name */
-       const char *name;
-};
-
 extern struct rte_table_ops rte_table_hash_cuckoo_ops;
 
 #ifdef __cplusplus