New upstream version 17.11-rc3
[deb_dpdk.git] / lib / librte_table / rte_table_hash.h
index 57505a6..15f1902 100644 (file)
@@ -1,7 +1,7 @@
 /*-
  *   BSD LICENSE
  *
- *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
+ *   Copyright(c) 2010-2017 Intel Corporation. All rights reserved.
  *   All rights reserved.
  *
  *   Redistribution and use in source and binary forms, with or without
@@ -45,8 +45,6 @@ extern "C" {
  * These tables use the exact match criterion to uniquely associate data to
  * lookup keys.
  *
- * Use-cases: Flow classification table, Address Resolution Protocol (ARP) table
- *
  * Hash table types:
  * 1. Entry add strategy on bucket full:
  *     a. Least Recently Used (LRU): One of the existing keys in the bucket is
@@ -59,7 +57,7 @@ extern "C" {
  *        to the bucket, it also becomes the new MRU key. When a key needs to
  *        be picked and dropped, the most likely candidate for drop, i.e. the
  *        current LRU key, is always picked. The LRU logic requires maintaining
- *        specific data structures per each bucket.
+ *        specific data structures per each bucket. Use-cases: flow cache, etc.
  *     b. Extendible bucket (ext): The bucket is extended with space for 4 more
  *        keys. This is done by allocating additional memory at table init time,
  *        which is used to create a pool of free keys (the size of this pool is
@@ -73,20 +71,8 @@ extern "C" {
  *        first group of 4 keys, the search continues beyond the first group of
  *        4 keys, potentially until all keys in this bucket are examined. The
  *        extendible bucket logic requires maintaining specific data structures
- *        per table and per each bucket.
- * 2. Key signature computation:
- *     a. Pre-computed key signature: The key lookup operation is split between
- *        two CPU cores. The first CPU core (typically the CPU core performing
- *        packet RX) extracts the key from the input packet, computes the key
- *        signature and saves both the key and the key signature in the packet
- *        buffer as packet meta-data. The second CPU core reads both the key and
- *        the key signature from the packet meta-data and performs the bucket
- *        search step of the key lookup operation.
- *     b. Key signature computed on lookup (do-sig): The same CPU core reads
- *        the key from the packet meta-data, uses it to compute the key
- *        signature and also performs the bucket search step of the key lookup
- *        operation.
- * 3. Key size:
+ *        per table and per each bucket. Use-cases: flow table, etc.
+ * 2. Key size:
  *     a. Configurable key size
  *     b. Single key size (8-byte, 16-byte or 32-byte key size)
  *
@@ -98,59 +84,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;
-};
 
-/** Extendible bucket hash table operations for pre-computed key signature */
-extern struct rte_table_ops rte_table_hash_ext_ops;
-
-/** Extendible bucket hash table operations for key signature computed on
-       lookup ("do-sig") */
-extern struct rte_table_ops rte_table_hash_ext_dosig_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 */
@@ -158,239 +113,23 @@ 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;
-};
-
-/** LRU hash table operations for pre-computed key signature */
-extern struct rte_table_ops rte_table_hash_lru_ops;
-
-/** LRU hash table operations for key signature computed on lookup ("do-sig") */
-extern struct rte_table_ops rte_table_hash_lru_dosig_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;
-
-       /** Bit-mask to be AND-ed to the key on lookup */
-       uint8_t *key_mask;
 };
 
-/** LRU hash table operations for pre-computed key signature */
-extern struct rte_table_ops rte_table_hash_key8_lru_ops;
-
-/** LRU hash table operations for key signature computed on lookup ("do-sig") */
-extern struct rte_table_ops rte_table_hash_key8_lru_dosig_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;
-};
-
-/** Extendible bucket hash table operations for pre-computed key signature */
+/** Extendible bucket hash table operations */
+extern struct rte_table_ops rte_table_hash_ext_ops;
 extern struct rte_table_ops rte_table_hash_key8_ext_ops;
-
-/** Extendible bucket hash table operations for key signature computed on
-    lookup ("do-sig") */
-extern struct rte_table_ops rte_table_hash_key8_ext_dosig_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;
-};
-
-/** LRU hash table operations for pre-computed key signature */
-extern struct rte_table_ops rte_table_hash_key16_lru_ops;
-
-/** LRU hash table operations for key signature computed on lookup
-    ("do-sig") */
-extern struct rte_table_ops rte_table_hash_key16_lru_dosig_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;
-};
-
-/** Extendible bucket operations for pre-computed key signature */
 extern struct rte_table_ops rte_table_hash_key16_ext_ops;
-
-/** Extendible bucket hash table operations for key signature computed on
-    lookup ("do-sig") */
-extern struct rte_table_ops rte_table_hash_key16_ext_dosig_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;
+/** LRU hash table operations */
+extern struct rte_table_ops rte_table_hash_lru_ops;
 
-       /** Hash table name */
-       const char *name;
-};
+extern struct rte_table_ops rte_table_hash_key8_lru_ops;
+extern struct rte_table_ops rte_table_hash_key16_lru_ops;
+extern struct rte_table_ops rte_table_hash_key32_lru_ops;
 
 /** Cuckoo hash table operations */
-extern struct rte_table_ops rte_table_hash_cuckoo_dosig_ops;
+extern struct rte_table_ops rte_table_hash_cuckoo_ops;
 
 #ifdef __cplusplus
 }