[urcu.git] / urcu / rculfstack.h

#ifndef _URCU_RCULFSTACK_H
#define _URCU_RCULFSTACK_H

/*
 * rculfstack.h
 *
 * Userspace RCU library - Lock-Free RCU Stack
 *
 * Copyright 2010 - 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
 */

#ifdef __cplusplus
extern "C" {
#endif

struct cds_lfs_node_rcu {
	struct cds_lfs_node_rcu *next;
};

struct cds_lfs_stack_rcu {
	struct cds_lfs_node_rcu *head;
};

#ifdef _LGPL_SOURCE

#include <urcu/static/rculfstack.h>

#define cds_lfs_node_init_rcu	_cds_lfs_node_init_rcu
#define cds_lfs_init_rcu	_cds_lfs_init_rcu
#define cds_lfs_push_rcu	_cds_lfs_push_rcu
#define cds_lfs_pop_rcu		_cds_lfs_pop_rcu

#else /* !_LGPL_SOURCE */

extern void cds_lfs_node_init_rcu(struct cds_lfs_node_rcu *node);
extern void cds_lfs_init_rcu(struct cds_lfs_stack_rcu *s);
extern void cds_lfs_push_rcu(struct cds_lfs_stack_rcu *s, struct cds_lfs_node_rcu *node);

/*
 * Should be called under rcu read lock critical section.
 *
 * The caller must wait for a grace period to pass before freeing the returned
 * node or modifying the cds_lfs_node_rcu structure.
 * Returns NULL if stack is empty.
 */
extern struct cds_lfs_node_rcu *cds_lfs_pop_rcu(struct cds_lfs_stack_rcu *s);

#endif /* !_LGPL_SOURCE */

#ifdef __cplusplus
}
#endif

#endif /* _URCU_RCULFSTACK_H */
Commit	Line	Data
	1	#ifndef _URCU_RCULFSTACK_H
	2	#define _URCU_RCULFSTACK_H
	3
	4	/*
	5	* rculfstack.h
	6	*
	7	* Userspace RCU library - Lock-Free RCU Stack
	8	*
	9	* Copyright 2010 - 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
	26	#ifdef __cplusplus
	27	extern "C" {
	28	#endif
	29
	30	struct cds_lfs_node_rcu {
	31	struct cds_lfs_node_rcu *next;
	32	};
	33
	34	struct cds_lfs_stack_rcu {
	35	struct cds_lfs_node_rcu *head;
	36	};
	37
	38	#ifdef _LGPL_SOURCE
	39
	40	#include <urcu/static/rculfstack.h>
	41
	42	#define cds_lfs_node_init_rcu _cds_lfs_node_init_rcu
	43	#define cds_lfs_init_rcu _cds_lfs_init_rcu
	44	#define cds_lfs_push_rcu _cds_lfs_push_rcu
	45	#define cds_lfs_pop_rcu _cds_lfs_pop_rcu
	46
	47	#else /* !_LGPL_SOURCE */
	48
	49	extern void cds_lfs_node_init_rcu(struct cds_lfs_node_rcu *node);
	50	extern void cds_lfs_init_rcu(struct cds_lfs_stack_rcu *s);
	51	extern void cds_lfs_push_rcu(struct cds_lfs_stack_rcu s, struct cds_lfs_node_rcu node);
	52
	53	/*
	54	* Should be called under rcu read lock critical section.
	55	*
	56	* The caller must wait for a grace period to pass before freeing the returned
	57	* node or modifying the cds_lfs_node_rcu structure.
	58	* Returns NULL if stack is empty.
	59	*/
	60	extern struct cds_lfs_node_rcu cds_lfs_pop_rcu(struct cds_lfs_stack_rcu s);
	61
	62	#endif /* !_LGPL_SOURCE */
	63
	64	#ifdef __cplusplus
	65	}
	66	#endif
	67
	68	#endif /* _URCU_RCULFSTACK_H */