cne_hash.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2010-2022 Intel Corporation
 */
 
#ifndef _CNE_HASH_H_
#define _CNE_HASH_H_
 
#include <stdint.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CNE_HASH_ENTRIES_MAX (1 << 30)
 
#define CNE_HASH_NAMESIZE 32
 
#define CNE_HASH_LOOKUP_BULK_MAX  64
#define CNE_HASH_LOOKUP_MULTI_MAX CNE_HASH_LOOKUP_BULK_MAX
 
#define CNE_HASH_EXTRA_FLAGS_TRANS_MEM_SUPPORT 0x01
 
#define CNE_HASH_EXTRA_FLAGS_MULTI_WRITER_ADD 0x02
 
#define CNE_HASH_EXTRA_FLAGS_RW_CONCURRENCY 0x04
 
#define CNE_HASH_EXTRA_FLAGS_EXT_TABLE 0x08
 
#define CNE_HASH_EXTRA_FLAGS_NO_FREE_ON_DEL 0x10
 
#define CNE_HASH_EXTRA_FLAGS_RW_CONCURRENCY_LF 0x20
 
typedef uint32_t hash_sig_t;
 
typedef uint32_t (*cne_hash_function)(const void *key, uint32_t key_len, uint32_t init_val);
 
typedef int (*cne_hash_cmp_eq_t)(const void *key1, const void *key2, size_t key_len);
 
struct cne_hash_parameters {
    const char *name;            
    uint32_t entries;            
    uint32_t reserved;           
    uint32_t key_len;            
    cne_hash_function hash_func; 
    uint32_t hash_func_init_val; 
    int socket_id;               
    uint8_t extra_flag;          
};
 
struct cne_hash;
 
struct cne_hash *cne_hash_create(const struct cne_hash_parameters *params);
 
void cne_hash_set_cmp_func(struct cne_hash *h, cne_hash_cmp_eq_t func);
 
struct cne_hash *cne_hash_find_existing(const char *name);
 
void cne_hash_free(struct cne_hash *h);
 
void cne_hash_reset(struct cne_hash *h);
 
int32_t cne_hash_count(const struct cne_hash *h);
 
int32_t cne_hash_max_key_id(const struct cne_hash *h);
 
int cne_hash_add_key_data(const struct cne_hash *h, const void *key, void *data);
 
int32_t cne_hash_add_key_with_hash_data(const struct cne_hash *h, const void *key, hash_sig_t sig,
                                        void *data);
 
int32_t cne_hash_add_key(const struct cne_hash *h, const void *key);
 
int32_t cne_hash_add_key_with_hash(const struct cne_hash *h, const void *key, hash_sig_t sig);
 
int32_t cne_hash_del_key(const struct cne_hash *h, const void *key);
 
int32_t cne_hash_del_key_with_hash(const struct cne_hash *h, const void *key, hash_sig_t sig);
 
int cne_hash_get_key_with_position(const struct cne_hash *h, const int32_t position, void **key);
 
int cne_hash_free_key_with_position(const struct cne_hash *h, const int32_t position);
 
int cne_hash_lookup_data(const struct cne_hash *h, const void *key, void **data);
 
int cne_hash_lookup_with_hash_data(const struct cne_hash *h, const void *key, hash_sig_t sig,
                                   void **data);
 
int32_t cne_hash_lookup(const struct cne_hash *h, const void *key);
 
int32_t cne_hash_lookup_with_hash(const struct cne_hash *h, const void *key, hash_sig_t sig);
 
hash_sig_t cne_hash_hash(const struct cne_hash *h, const void *key);
 
int cne_hash_lookup_bulk_data(const struct cne_hash *h, const void **keys, uint32_t num_keys,
                              uint64_t *hit_mask, void *data[]);
 
int cne_hash_lookup_with_hash_bulk(const struct cne_hash *h, const void **keys, hash_sig_t *sig,
                                   uint32_t num_keys, int32_t *positions);
 
int cne_hash_lookup_with_hash_bulk_data(const struct cne_hash *h, const void **keys,
                                        hash_sig_t *sig, uint32_t num_keys, uint64_t *hit_mask,
                                        void *data[]);
 
int cne_hash_lookup_bulk(const struct cne_hash *h, const void **keys, uint32_t num_keys,
                         int32_t *positions);
 
int32_t cne_hash_iterate(const struct cne_hash *h, const void **key, void **data, uint32_t *next);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CNE_HASH_H_ */