[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

#ifndef CDS_LFS_RCU_DEPRECATED
#define CDS_LFS_RCU_DEPRECATED	\
	__attribute__((deprecated("urcu/rculfstack.h is deprecated. Please use urcu/lfstack.h instead.")))
#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>

static inline CDS_LFS_RCU_DEPRECATED
void cds_lfs_node_init_rcu(struct cds_lfs_node_rcu *node)
{
	_cds_lfs_node_init_rcu(node);
}

static inline
void cds_lfs_init_rcu(struct cds_lfs_stack_rcu *s)
{
	_cds_lfs_init_rcu(s);
}

static inline CDS_LFS_RCU_DEPRECATED
int cds_lfs_push_rcu(struct cds_lfs_stack_rcu *s,
			struct cds_lfs_node_rcu *node)
{
	return _cds_lfs_push_rcu(s, node);
}

static inline CDS_LFS_RCU_DEPRECATED
struct cds_lfs_node_rcu *cds_lfs_pop_rcu(struct cds_lfs_stack_rcu *s)
{
	return _cds_lfs_pop_rcu(s);
}

#else /* !_LGPL_SOURCE */

extern CDS_LFS_RCU_DEPRECATED
void cds_lfs_node_init_rcu(struct cds_lfs_node_rcu *node);
extern CDS_LFS_RCU_DEPRECATED
void cds_lfs_init_rcu(struct cds_lfs_stack_rcu *s);
extern CDS_LFS_RCU_DEPRECATED
int 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 CDS_LFS_RCU_DEPRECATED
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	#ifndef CDS_LFS_RCU_DEPRECATED
	31	#define CDS_LFS_RCU_DEPRECATED \
	32	__attribute__((deprecated("urcu/rculfstack.h is deprecated. Please use urcu/lfstack.h instead.")))
	33	#endif
	34
	35	struct cds_lfs_node_rcu {
	36	struct cds_lfs_node_rcu *next;
	37	};
	38
	39	struct cds_lfs_stack_rcu {
	40	struct cds_lfs_node_rcu *head;
	41	};
	42
	43	#ifdef _LGPL_SOURCE
	44
	45	#include <urcu/static/rculfstack.h>
	46
	47	static inline CDS_LFS_RCU_DEPRECATED
	48	void cds_lfs_node_init_rcu(struct cds_lfs_node_rcu *node)
	49	{
	50	_cds_lfs_node_init_rcu(node);
	51	}
	52
	53	static inline
	54	void cds_lfs_init_rcu(struct cds_lfs_stack_rcu *s)
	55	{
	56	_cds_lfs_init_rcu(s);
	57	}
	58
	59	static inline CDS_LFS_RCU_DEPRECATED
	60	int cds_lfs_push_rcu(struct cds_lfs_stack_rcu *s,
	61	struct cds_lfs_node_rcu *node)
	62	{
	63	return _cds_lfs_push_rcu(s, node);
	64	}
	65
	66	static inline CDS_LFS_RCU_DEPRECATED
	67	struct cds_lfs_node_rcu cds_lfs_pop_rcu(struct cds_lfs_stack_rcu s)
	68	{
	69	return _cds_lfs_pop_rcu(s);
	70	}
	71
	72	#else /* !_LGPL_SOURCE */
	73
	74	extern CDS_LFS_RCU_DEPRECATED
	75	void cds_lfs_node_init_rcu(struct cds_lfs_node_rcu *node);
	76	extern CDS_LFS_RCU_DEPRECATED
	77	void cds_lfs_init_rcu(struct cds_lfs_stack_rcu *s);
	78	extern CDS_LFS_RCU_DEPRECATED
	79	int cds_lfs_push_rcu(struct cds_lfs_stack_rcu *s,
	80	struct cds_lfs_node_rcu *node);
	81
	82	/*
	83	* Should be called under rcu read lock critical section.
	84	*
	85	* The caller must wait for a grace period to pass before freeing the returned
	86	* node or modifying the cds_lfs_node_rcu structure.
	87	* Returns NULL if stack is empty.
	88	*/
	89	extern CDS_LFS_RCU_DEPRECATED
	90	struct cds_lfs_node_rcu cds_lfs_pop_rcu(struct cds_lfs_stack_rcu s);
	91
	92	#endif /* !_LGPL_SOURCE */
	93
	94	#ifdef __cplusplus
	95	}
	96	#endif
	97
	98	#endif /* _URCU_RCULFSTACK_H */