[urcu.git] / urcu / rculfhash.h

#ifndef _URCU_RCULFHASH_H
#define _URCU_RCULFHASH_H

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

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 */
	unsigned long hash;
	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. */
int 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);

#endif /* _URCU_RCULFHASH_H */
Commit	Line	Data
	1	#ifndef _URCU_RCULFHASH_H
	2	#define _URCU_RCULFHASH_H
	3
	4	#include <stdint.h>
	5	#include <urcu-call-rcu.h>
	6
	7	struct rcu_ht_node {
	8	/* cache-hot for iteration */
	9	struct rcu_ht_node *next;
	10	unsigned long reverse_hash;
	11	void *key;
	12	unsigned int key_len;
	13	unsigned int dummy;
	14	/* cache-cold for iteration */
	15	unsigned long hash;
	16	struct rcu_head head;
	17	};
	18
	19	struct rcu_ht;
	20
	21	/*
	22	* Caution !
	23	* Ensure reader and writer threads are registered as urcu readers.
	24	*/
	25
	26	typedef unsigned long (ht_hash_fct)(void key, size_t length,
	27	unsigned long seed);
	28	typedef unsigned long (ht_compare_fct)(void key1, size_t key1_len,
	29	void *key2, size_t key2_len);
	30
	31	static inline
	32	void ht_node_init(struct rcu_ht_node node, void key,
	33	size_t key_len)
	34	{
	35	node->key = key;
	36	node->key_len = key_len;
	37	node->dummy = 0;
	38	}
	39
	40	/*
	41	* init_size must be power of two.
	42	*/
	43	struct rcu_ht *ht_new(ht_hash_fct hash_fct,
	44	ht_compare_fct compare_fct,
	45	unsigned long hash_seed,
	46	unsigned long init_size,
	47	void (ht_call_rcu)(struct rcu_head head,
	48	void (func)(struct rcu_head head)));
	49
	50	int ht_destroy(struct rcu_ht *ht);
	51	/* Count the number of nodes in the hash table. Call with rcu_read_lock held. */
	52	void ht_count_nodes(struct rcu_ht *ht,
	53	unsigned long *count,
	54	unsigned long *removed);
	55
	56	/* Call with rcu_read_lock held. */
	57	struct rcu_ht_node ht_lookup(struct rcu_ht ht, void *key, size_t key_len);
	58
	59	/* Call with rcu_read_lock held. */
	60	void ht_add(struct rcu_ht ht, struct rcu_ht_node node);
	61
	62	/* Call with rcu_read_lock held. */
	63	int ht_add_unique(struct rcu_ht ht, struct rcu_ht_node node);
	64
	65	/* Call with rcu_read_lock held. */
	66	int ht_remove(struct rcu_ht ht, struct rcu_ht_node node);
	67
	68	void ht_resize(struct rcu_ht *ht, int growth);
	69
	70	#endif /* _URCU_RCULFHASH_H */