rte_hash.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2010-2015 Intel Corporation
 */

#ifndef _RTE_HASH_H_
#define _RTE_HASH_H_

#include <stdint.h>
#include <stddef.h>

#include <rte_compat.h>
#include <rte_rcu_qsbr.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_HASH_ENTRIES_MAX            (1 << 30)

#define RTE_HASH_NAMESIZE           32

#define RTE_HASH_LOOKUP_BULK_MAX        64
#define RTE_HASH_LOOKUP_MULTI_MAX       RTE_HASH_LOOKUP_BULK_MAX

#define RTE_HASH_EXTRA_FLAGS_TRANS_MEM_SUPPORT  0x01

#define RTE_HASH_EXTRA_FLAGS_MULTI_WRITER_ADD 0x02

#define RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY 0x04

#define RTE_HASH_EXTRA_FLAGS_EXT_TABLE 0x08

#define RTE_HASH_EXTRA_FLAGS_NO_FREE_ON_DEL 0x10

#define RTE_HASH_EXTRA_FLAGS_RW_CONCURRENCY_LF 0x20

typedef uint32_t hash_sig_t;

typedef uint32_t (*rte_hash_function)(const void *key, uint32_t key_len,
                      uint32_t init_val);

typedef int (*rte_hash_cmp_eq_t)(const void *key1, const void *key2, size_t key_len);

typedef void (*rte_hash_free_key_data)(void *p, void *key_data);

struct rte_hash_parameters {
    const char *name;       
    uint32_t entries;       
    uint32_t reserved;      
    uint32_t key_len;       
    rte_hash_function hash_func;    
    uint32_t hash_func_init_val;    
    int socket_id;          
    uint8_t extra_flag;     
};

enum rte_hash_qsbr_mode {
    RTE_HASH_QSBR_MODE_DQ = 0,
    RTE_HASH_QSBR_MODE_SYNC
};

struct rte_hash_rcu_config {
    struct rte_rcu_qsbr *v;     
    enum rte_hash_qsbr_mode mode;
    uint32_t dq_size;
    uint32_t trigger_reclaim_limit; 
    uint32_t max_reclaim_size;
    void *key_data_ptr;
    rte_hash_free_key_data free_key_data_func;
};

struct rte_hash;

struct rte_hash *
rte_hash_create(const struct rte_hash_parameters *params);

void rte_hash_set_cmp_func(struct rte_hash *h, rte_hash_cmp_eq_t func);

struct rte_hash *
rte_hash_find_existing(const char *name);

void
rte_hash_free(struct rte_hash *h);

void
rte_hash_reset(struct rte_hash *h);

int32_t
rte_hash_count(const struct rte_hash *h);

__rte_experimental
int32_t
rte_hash_max_key_id(const struct rte_hash *h);

int
rte_hash_add_key_data(const struct rte_hash *h, const void *key, void *data);

int32_t
rte_hash_add_key_with_hash_data(const struct rte_hash *h, const void *key,
                        hash_sig_t sig, void *data);

int32_t
rte_hash_add_key(const struct rte_hash *h, const void *key);

int32_t
rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key, hash_sig_t sig);

int32_t
rte_hash_del_key(const struct rte_hash *h, const void *key);

int32_t
rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key, hash_sig_t sig);

int
rte_hash_get_key_with_position(const struct rte_hash *h, const int32_t position,
                   void **key);

__rte_experimental
int
rte_hash_free_key_with_position(const struct rte_hash *h,
                const int32_t position);

int
rte_hash_lookup_data(const struct rte_hash *h, const void *key, void **data);

int
rte_hash_lookup_with_hash_data(const struct rte_hash *h, const void *key,
                    hash_sig_t sig, void **data);

int32_t
rte_hash_lookup(const struct rte_hash *h, const void *key);

int32_t
rte_hash_lookup_with_hash(const struct rte_hash *h,
                const void *key, hash_sig_t sig);

hash_sig_t
rte_hash_hash(const struct rte_hash *h, const void *key);

int
rte_hash_lookup_bulk_data(const struct rte_hash *h, const void **keys,
              uint32_t num_keys, uint64_t *hit_mask, void *data[]);

__rte_experimental
int
rte_hash_lookup_with_hash_bulk(const struct rte_hash *h, const void **keys,
        hash_sig_t *sig, uint32_t num_keys, int32_t *positions);

__rte_experimental
int
rte_hash_lookup_with_hash_bulk_data(const struct rte_hash *h,
        const void **keys, hash_sig_t *sig,
        uint32_t num_keys, uint64_t *hit_mask, void *data[]);

int
rte_hash_lookup_bulk(const struct rte_hash *h, const void **keys,
              uint32_t num_keys, int32_t *positions);

int32_t
rte_hash_iterate(const struct rte_hash *h, const void **key, void **data, uint32_t *next);

__rte_experimental
int rte_hash_rcu_qsbr_add(struct rte_hash *h, struct rte_hash_rcu_config *cfg);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_HASH_H_ */