[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 */
	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);

#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	struct rcu_head head;
	16	};
	17
	18	struct rcu_ht;
	19
	20	/*
	21	* Caution !
	22	* Ensure reader and writer threads are registered as urcu readers.
	23	*/
	24
	25	typedef unsigned long (ht_hash_fct)(void key, size_t length,
	26	unsigned long seed);
	27	typedef unsigned long (ht_compare_fct)(void key1, size_t key1_len,
	28	void *key2, size_t key2_len);
	29
	30	static inline
	31	void ht_node_init(struct rcu_ht_node node, void key,
	32	size_t key_len)
	33	{
	34	node->key = key;
	35	node->key_len = key_len;
	36	node->dummy = 0;
	37	}
	38
	39	/*
	40	* init_size must be power of two.
	41	*/
	42	struct rcu_ht *ht_new(ht_hash_fct hash_fct,
	43	ht_compare_fct compare_fct,
	44	unsigned long hash_seed,
	45	unsigned long init_size,
	46	void (ht_call_rcu)(struct rcu_head head,
	47	void (func)(struct rcu_head head)));
	48
	49	int ht_destroy(struct rcu_ht *ht);
	50	/* Count the number of nodes in the hash table. Call with rcu_read_lock held. */
	51	void ht_count_nodes(struct rcu_ht *ht,
	52	unsigned long *count,
	53	unsigned long *removed);
	54
	55	/* Call with rcu_read_lock held. */
	56	struct rcu_ht_node ht_lookup(struct rcu_ht ht, void *key, size_t key_len);
	57
	58	/* Call with rcu_read_lock held. */
	59	void ht_add(struct rcu_ht ht, struct rcu_ht_node node);
	60
	61	/*
	62	* Call with rcu_read_lock held.
	63	* Returns the node added upon success.
	64	* Returns the unique node already present upon failure. If ht_add_unique fails,
	65	* the node passed as parameter should be freed by the caller.
	66	*/
	67	struct rcu_ht_node ht_add_unique(struct rcu_ht ht, struct rcu_ht_node *node);
	68
	69	/* Call with rcu_read_lock held. */
	70	int ht_remove(struct rcu_ht ht, struct rcu_ht_node node);
	71
	72	void ht_resize(struct rcu_ht *ht, int growth);
	73
	74	#endif /* _URCU_RCULFHASH_H */