rte_table_hash.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef __INCLUDE_RTE_TABLE_HASH_H__
#define __INCLUDE_RTE_TABLE_HASH_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#include "rte_table.h"

typedef uint64_t (*rte_table_hash_op_hash)(
        void *key,
        uint32_t key_size,
        uint64_t seed);

struct rte_table_hash_ext_params {
        uint32_t key_size;

        uint32_t n_keys;

        uint32_t n_buckets;

        uint32_t n_buckets_ext;

        rte_table_hash_op_hash f_hash;

        uint64_t seed;

        uint32_t signature_offset;

        uint32_t key_offset;
};

extern struct rte_table_ops rte_table_hash_ext_ops;

extern struct rte_table_ops rte_table_hash_ext_dosig_ops;

struct rte_table_hash_lru_params {
        uint32_t key_size;

        uint32_t n_keys;

        uint32_t n_buckets;

        rte_table_hash_op_hash f_hash;

        uint64_t seed;

        uint32_t signature_offset;

        uint32_t key_offset;
};

extern struct rte_table_ops rte_table_hash_lru_ops;

extern struct rte_table_ops rte_table_hash_lru_dosig_ops;

struct rte_table_hash_key8_lru_params {
        uint32_t n_entries;

        rte_table_hash_op_hash f_hash;

        uint64_t seed;

        uint32_t signature_offset;

        uint32_t key_offset;

        uint8_t *key_mask;
};

extern struct rte_table_ops rte_table_hash_key8_lru_ops;

extern struct rte_table_ops rte_table_hash_key8_lru_dosig_ops;

struct rte_table_hash_key8_ext_params {
        uint32_t n_entries;

        uint32_t n_entries_ext;

        rte_table_hash_op_hash f_hash;

        uint64_t seed;

        uint32_t signature_offset;

        uint32_t key_offset;

        uint8_t *key_mask;
};

extern struct rte_table_ops rte_table_hash_key8_ext_ops;

extern struct rte_table_ops rte_table_hash_key8_ext_dosig_ops;

struct rte_table_hash_key16_lru_params {
        uint32_t n_entries;

        rte_table_hash_op_hash f_hash;

        uint64_t seed;

        uint32_t signature_offset;

        uint32_t key_offset;

        uint8_t *key_mask;
};

extern struct rte_table_ops rte_table_hash_key16_lru_ops;

extern struct rte_table_ops rte_table_hash_key16_lru_dosig_ops;

struct rte_table_hash_key16_ext_params {
        uint32_t n_entries;

        uint32_t n_entries_ext;

        rte_table_hash_op_hash f_hash;

        uint64_t seed;

        uint32_t signature_offset;

        uint32_t key_offset;

        uint8_t *key_mask;
};

extern struct rte_table_ops rte_table_hash_key16_ext_ops;

extern struct rte_table_ops rte_table_hash_key16_ext_dosig_ops;

struct rte_table_hash_key32_lru_params {
        uint32_t n_entries;

        rte_table_hash_op_hash f_hash;

        uint64_t seed;

        uint32_t signature_offset;

        uint32_t key_offset;
};

extern struct rte_table_ops rte_table_hash_key32_lru_ops;

struct rte_table_hash_key32_ext_params {
        uint32_t n_entries;

        uint32_t n_entries_ext;

        rte_table_hash_op_hash f_hash;

        uint64_t seed;

        uint32_t signature_offset;

        uint32_t key_offset;
};

extern struct rte_table_ops rte_table_hash_key32_ext_ops;

struct rte_table_hash_cuckoo_params {
                uint32_t key_size;

        uint32_t n_keys;

        rte_table_hash_op_hash f_hash;

        uint32_t seed;

        uint32_t signature_offset;

        uint32_t key_offset;

        const char *name;
};

extern struct rte_table_ops rte_table_hash_cuckoo_dosig_ops;

#ifdef __cplusplus
}
#endif

#endif