[urcu.git] / include / 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
 */

#include <urcu/compiler.h>

#ifdef __cplusplus
extern "C" {
#endif

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