[urcu.git] / urcu / rculfhash.h

#ifndef _URCU_RCULFHASH_H
#define _URCU_RCULFHASH_H

#include <stdint.h>
#include <urcu-call-rcu.h>

#ifdef __cplusplus
extern "C" {
#endif

struct rcu_ht_node {
	/* cache-hot for iteration */
	struct rcu_ht_node *next;
	unsigned long reverse_hash;
	void *key;
	unsigned int key_len;
	unsigned int dummy;
	/* cache-cold for iteration */
	struct rcu_head head;
};

struct rcu_ht;

/*
 * Caution !
 * Ensure reader and writer threads are registered as urcu readers.
 */

typedef unsigned long (*ht_hash_fct)(void *key, size_t length,
				     unsigned long seed);
typedef unsigned long (*ht_compare_fct)(void *key1, size_t key1_len,
				        void *key2, size_t key2_len);

static inline
void ht_node_init(struct rcu_ht_node *node, void *key,
		  size_t key_len)
{
	node->key = key;
	node->key_len = key_len;
	node->dummy = 0;
}

/*
 * init_size must be power of two.
 */
struct rcu_ht *ht_new(ht_hash_fct hash_fct,
		      ht_compare_fct compare_fct,
		      unsigned long hash_seed,
		      unsigned long init_size,
		      void (*ht_call_rcu)(struct rcu_head *head,
				void (*func)(struct rcu_head *head)));

int ht_destroy(struct rcu_ht *ht);
/* Count the number of nodes in the hash table. Call with rcu_read_lock held. */
void ht_count_nodes(struct rcu_ht *ht,
		unsigned long *count,
		unsigned long *removed);

/* Call with rcu_read_lock held. */
struct rcu_ht_node *ht_lookup(struct rcu_ht *ht, void *key, size_t key_len);

/* Call with rcu_read_lock held. */
void ht_add(struct rcu_ht *ht, struct rcu_ht_node *node);

/*
 * Call with rcu_read_lock held.
 * Returns the node added upon success.
 * Returns the unique node already present upon failure. If ht_add_unique fails,
 * the node passed as parameter should be freed by the caller.
 */
struct rcu_ht_node *ht_add_unique(struct rcu_ht *ht, struct rcu_ht_node *node);

/* Call with rcu_read_lock held. */
int ht_remove(struct rcu_ht *ht, struct rcu_ht_node *node);

void ht_resize(struct rcu_ht *ht, int growth);

#ifdef __cplusplus
}
#endif

#endif /* _URCU_RCULFHASH_H */
Commit	Line	Data
a42cc659 MD	1	#ifndef _URCU_RCULFHASH_H
a42cc659 MD	2	#define _URCU_RCULFHASH_H
ab7d5fc6	3
674f7a69	4	#include <stdint.h>
abc490a1 MD	5	#include <urcu-call-rcu.h>
abc490a1 MD	6
01389791 MD	7	#ifdef __cplusplus
	8	extern "C" {
	9	#endif
	10
abc490a1	11	struct rcu_ht_node {
9b35f1e4	12	/* cache-hot for iteration */
abc490a1	13	struct rcu_ht_node *next;
abc490a1	14	unsigned long reverse_hash;
9b35f1e4 MD	15	void *key;
9b35f1e4 MD	16	unsigned int key_len;
abc490a1	17	unsigned int dummy;
9b35f1e4	18	/* cache-cold for iteration */
abc490a1 MD	19	struct rcu_head head;
	20	};
	21
	22	struct rcu_ht;
ab7d5fc6	23
5e28c532 MD	24	/*
5e28c532 MD	25	* Caution !
abc490a1	26	* Ensure reader and writer threads are registered as urcu readers.
5e28c532 MD	27	*/
5e28c532 MD	28
732ad076 MD	29	typedef unsigned long (ht_hash_fct)(void key, size_t length,
	30	unsigned long seed);
	31	typedef unsigned long (ht_compare_fct)(void key1, size_t key1_len,
	32	void *key2, size_t key2_len);
abc490a1 MD	33
abc490a1 MD	34	static inline
732ad076	35	void ht_node_init(struct rcu_ht_node node, void key,
cb233752	36	size_t key_len)
abc490a1 MD	37	{
abc490a1 MD	38	node->key = key;
732ad076	39	node->key_len = key_len;
abc490a1 MD	40	node->dummy = 0;
abc490a1 MD	41	}
674f7a69 MD	42
	43	/*
	44	* init_size must be power of two.
	45	*/
abc490a1	46	struct rcu_ht *ht_new(ht_hash_fct hash_fct,
732ad076 MD	47	ht_compare_fct compare_fct,
732ad076 MD	48	unsigned long hash_seed,
abc490a1 MD	49	unsigned long init_size,
	50	void (ht_call_rcu)(struct rcu_head head,
	51	void (func)(struct rcu_head head)));
ab7d5fc6	52
5e28c532	53	int ht_destroy(struct rcu_ht *ht);
273399de MD	54	/* Count the number of nodes in the hash table. Call with rcu_read_lock held. */
	55	void ht_count_nodes(struct rcu_ht *ht,
	56	unsigned long *count,
	57	unsigned long *removed);
ab7d5fc6	58
abc490a1	59	/* Call with rcu_read_lock held. */
732ad076	60	struct rcu_ht_node ht_lookup(struct rcu_ht ht, void *key, size_t key_len);
ab7d5fc6	61
abc490a1	62	/* Call with rcu_read_lock held. */
f000907d	63	void ht_add(struct rcu_ht ht, struct rcu_ht_node node);
ab7d5fc6	64
18117871 MD	65	/*
	66	* Call with rcu_read_lock held.
	67	* Returns the node added upon success.
	68	* Returns the unique node already present upon failure. If ht_add_unique fails,
	69	* the node passed as parameter should be freed by the caller.
	70	*/
	71	struct rcu_ht_node ht_add_unique(struct rcu_ht ht, struct rcu_ht_node *node);
3eca1b8c	72
abc490a1 MD	73	/* Call with rcu_read_lock held. */
abc490a1 MD	74	int ht_remove(struct rcu_ht ht, struct rcu_ht_node node);
ab7d5fc6	75
464a1ec9 MD	76	void ht_resize(struct rcu_ht *ht, int growth);
464a1ec9 MD	77
01389791 MD	78	#ifdef __cplusplus
	79	}
	80	#endif
	81
a42cc659	82	#endif /* _URCU_RCULFHASH_H */