[userspace-rcu.git] / urcu / rcuja.h

#ifndef _URCU_RCUJA_H
#define _URCU_RCUJA_H

/*
 * urcu/rcuja.h
 *
 * Userspace RCU library - RCU Judy Array
 *
 * Copyright 2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * Include this file _after_ including your URCU flavor.
 */

#include <stdint.h>
#include <urcu/compiler.h>
#include <urcu-call-rcu.h>
#include <urcu-flavor.h>
#include <stdint.h>
#include <urcu/rcuhlist.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Duplicate nodes with the same key are chained into a singly-linked
 * list. The last item of this list has a NULL next pointer.
 */
struct cds_ja_node {
	struct cds_ja_node *next;
};

struct cds_ja;

/*
 * cds_ja_node_init - initialize a judy array node
 * @node: the node to initialize.
 *
 * This function is kept to be eventually used for debugging purposes
 * (detection of memory corruption).
 */
static inline
void cds_ja_node_init(struct cds_ja_node *node)
{
}

struct cds_ja_node *cds_ja_lookup(struct cds_ja *ja, uint64_t key);
struct cds_ja_node *cds_ja_lookup_lower_equal(struct cds_ja *ja,
		uint64_t key);

int cds_ja_add(struct cds_ja *ja, uint64_t key,
		struct cds_ja_node *new_node);

struct cds_ja_node *cds_ja_add_unique(struct cds_ja *ja, uint64_t key,
		struct cds_ja_node *new_node);

int cds_ja_del(struct cds_ja *ja, uint64_t key,
		struct cds_ja_node *node);

struct cds_ja *_cds_ja_new(unsigned int key_bits,
		const struct rcu_flavor_struct *flavor);

static inline
struct cds_ja *cds_ja_new(unsigned int key_bits)
{
	return _cds_ja_new(key_bits, &rcu_flavor);
}

int cds_ja_destroy(struct cds_ja *ja,
		void (*rcu_free_node_cb)(struct cds_ja_node *node));

/*
 * Iterate through duplicates returned by cds_ja_lookup*()
 * This must be done while rcu_read_lock() is held.
 * Receives a struct cds_ja_node * as parameter, which is used as start
 * of duplicate list and loop cursor.
 */
#define cds_ja_for_each_duplicate_rcu(pos)				\
	for (; (pos) != NULL; (pos) = rcu_dereference((pos)->next))

#ifdef __cplusplus
}
#endif

#endif /* _URCU_RCUJA_H */
Commit	Line	Data
d553beef MD	1	#ifndef _URCU_RCUJA_H
	2	#define _URCU_RCUJA_H
	3
	4	/*
	5	* urcu/rcuja.h
	6	*
	7	* Userspace RCU library - RCU Judy Array
	8	*
	9	* Copyright 2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	10	*
	11	* This library is free software; you can redistribute it and/or
	12	* modify it under the terms of the GNU Lesser General Public
	13	* License as published by the Free Software Foundation; either
	14	* version 2.1 of the License, or (at your option) any later version.
	15	*
	16	* This library is distributed in the hope that it will be useful,
	17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	19	* Lesser General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU Lesser General Public
	22	* License along with this library; if not, write to the Free Software
	23	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	24	*
	25	* Include this file _after_ including your URCU flavor.
	26	*/
	27
	28	#include <stdint.h>
	29	#include <urcu/compiler.h>
	30	#include <urcu-call-rcu.h>
	31	#include <urcu-flavor.h>
	32	#include <stdint.h>
	33	#include <urcu/rcuhlist.h>
	34
	35	#ifdef __cplusplus
	36	extern "C" {
	37	#endif
	38
03ec1aeb MD	39	/*
	40	* Duplicate nodes with the same key are chained into a singly-linked
	41	* list. The last item of this list has a NULL next pointer.
	42	*/
d553beef	43	struct cds_ja_node {
03ec1aeb	44	struct cds_ja_node *next;
d553beef MD	45	};
	46
	47	struct cds_ja;
	48
	49	/*
	50	* cds_ja_node_init - initialize a judy array node
	51	* @node: the node to initialize.
	52	*
	53	* This function is kept to be eventually used for debugging purposes
	54	* (detection of memory corruption).
	55	*/
	56	static inline
	57	void cds_ja_node_init(struct cds_ja_node *node)
	58	{
	59	}
	60
03ec1aeb MD	61	struct cds_ja_node cds_ja_lookup(struct cds_ja ja, uint64_t key);
03ec1aeb MD	62	struct cds_ja_node cds_ja_lookup_lower_equal(struct cds_ja ja,
291b2543	63	uint64_t key);
d553beef MD	64
	65	int cds_ja_add(struct cds_ja *ja, uint64_t key,
	66	struct cds_ja_node *new_node);
	67
75d573aa MD	68	struct cds_ja_node cds_ja_add_unique(struct cds_ja ja, uint64_t key,
	69	struct cds_ja_node *new_node);
	70
d553beef MD	71	int cds_ja_del(struct cds_ja *ja, uint64_t key,
	72	struct cds_ja_node *node);
	73
	74	struct cds_ja *_cds_ja_new(unsigned int key_bits,
	75	const struct rcu_flavor_struct *flavor);
	76
	77	static inline
	78	struct cds_ja *cds_ja_new(unsigned int key_bits)
	79	{
	80	return _cds_ja_new(key_bits, &rcu_flavor);
	81	}
	82
	83	int cds_ja_destroy(struct cds_ja *ja,
21ac4c56	84	void (rcu_free_node_cb)(struct cds_ja_node node));
d553beef	85
03ec1aeb MD	86	/*
	87	* Iterate through duplicates returned by cds_ja_lookup*()
	88	* This must be done while rcu_read_lock() is held.
	89	* Receives a struct cds_ja_node * as parameter, which is used as start
	90	* of duplicate list and loop cursor.
	91	*/
	92	#define cds_ja_for_each_duplicate_rcu(pos) \
	93	for (; (pos) != NULL; (pos) = rcu_dereference((pos)->next))
	94
d553beef MD	95	#ifdef __cplusplus
	96	}
	97	#endif
	98
	99	#endif /* _URCU_RCUJA_H */