[urcu.git] / urcu.h

#ifndef _URCU_H
#define _URCU_H

/*
 * urcu.h
 *
 * Userspace RCU header
 *
 * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
 * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
 *
 * LGPL-compatible code should include this header with :
 *
 * #define _LGPL_SOURCE
 * #include <urcu.h>
 *
 * 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
 *
 * IBM's contributions to this file may be relicensed under LGPLv2 or later.
 */

#include <stdlib.h>
#include <pthread.h>

/*
 * See urcu-pointer.h and urcu-pointer-static.h for pointer publication headers.
 */
#include <urcu-pointer.h>

/*
 * Important !
 *
 * Each thread containing read-side critical sections must be registered
 * with rcu_register_thread() before calling rcu_read_lock().
 * rcu_unregister_thread() should be called before the thread exits.
 */

#ifdef _LGPL_SOURCE

#include <urcu-static.h>

/*
 * Mappings for static use of the userspace RCU library.
 * Should only be used in LGPL-compatible code.
 */

/*
 * rcu_read_lock()
 * rcu_read_unlock()
 *
 * Mark the beginning and end of a read-side critical section.
 * DON'T FORGET TO USE RCU_REGISTER/UNREGISTER_THREAD() FOR EACH THREAD WITH
 * READ-SIDE CRITICAL SECTION.
 */
#define rcu_read_lock()		_rcu_read_lock()
#define rcu_read_unlock()	_rcu_read_unlock()

#else /* !_LGPL_SOURCE */

/*
 * library wrappers to be used by non-LGPL compatible source code.
 * See LGPL-only urcu-pointer-static.h for documentation.
 */

extern void rcu_read_lock(void);
extern void rcu_read_unlock(void);

#endif /* !_LGPL_SOURCE */

extern void synchronize_rcu(void);

/*
 * Reader thread registration.
 */
extern void rcu_register_thread(void);
extern void rcu_unregister_thread(void);

/*
 * Explicit urcu initialization, for "early" use within library constructors.
 */
extern void urcu_init(void);

#endif /* _URCU_H */
Commit	Line	Data
27b012e2 MD	1	#ifndef _URCU_H
	2	#define _URCU_H
	3
b257a10b MD	4	/*
	5	* urcu.h
	6	*
	7	* Userspace RCU header
	8	*
af02d47e MD	9	* Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
af02d47e MD	10	* Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
5e7e64b9	11	*
121a5d44	12	* LGPL-compatible code should include this header with :
5e7e64b9	13	*
121a5d44 MD	14	* #define _LGPL_SOURCE
	15	* #include <urcu.h>
	16	*
af02d47e MD	17	* This library is free software; you can redistribute it and/or
	18	* modify it under the terms of the GNU Lesser General Public
	19	* License as published by the Free Software Foundation; either
	20	* version 2.1 of the License, or (at your option) any later version.
	21	*
	22	* This library is distributed in the hope that it will be useful,
	23	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	24	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	25	* Lesser General Public License for more details.
	26	*
	27	* You should have received a copy of the GNU Lesser General Public
	28	* License along with this library; if not, write to the Free Software
	29	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
54843abc PM	30	*
54843abc PM	31	* IBM's contributions to this file may be relicensed under LGPLv2 or later.
b257a10b MD	32	*/
b257a10b MD	33
1430ee0b	34	#include <stdlib.h>
69a757c9	35	#include <pthread.h>
1430ee0b	36
7e30abe3 MD	37	/*
	38	* See urcu-pointer.h and urcu-pointer-static.h for pointer publication headers.
	39	*/
	40	#include <urcu-pointer.h>
	41
92b752ee MD	42	/*
	43	* Important !
	44	*
	45	* Each thread containing read-side critical sections must be registered
	46	* with rcu_register_thread() before calling rcu_read_lock().
	47	* rcu_unregister_thread() should be called before the thread exits.
	48	*/
	49
121a5d44	50	#ifdef _LGPL_SOURCE
b0d5e790	51
121a5d44	52	#include <urcu-static.h>
3a86deba MD	53
3a86deba MD	54	/*
121a5d44 MD	55	* Mappings for static use of the userspace RCU library.
121a5d44 MD	56	* Should only be used in LGPL-compatible code.
3a86deba	57	*/
3a86deba	58
7e30abe3 MD	59	/*
	60	* rcu_read_lock()
	61	* rcu_read_unlock()
	62	*
	63	* Mark the beginning and end of a read-side critical section.
	64	* DON'T FORGET TO USE RCU_REGISTER/UNREGISTER_THREAD() FOR EACH THREAD WITH
	65	* READ-SIDE CRITICAL SECTION.
	66	*/
	67	#define rcu_read_lock() _rcu_read_lock()
	68	#define rcu_read_unlock() _rcu_read_unlock()
41718ff9	69
121a5d44	70	#else /* !_LGPL_SOURCE */
27b012e2	71
40e140c9	72	/*
121a5d44	73	* library wrappers to be used by non-LGPL compatible source code.
7e30abe3	74	* See LGPL-only urcu-pointer-static.h for documentation.
40e140c9	75	*/
cf380c2f	76
121a5d44 MD	77	extern void rcu_read_lock(void);
121a5d44 MD	78	extern void rcu_read_unlock(void);
cf380c2f	79
121a5d44	80	#endif /* !_LGPL_SOURCE */
f4a486ac	81
e462817e	82	extern void synchronize_rcu(void);
27b012e2 MD	83
	84	/*
	85	* Reader thread registration.
	86	*/
121a5d44 MD	87	extern void rcu_register_thread(void);
121a5d44 MD	88	extern void rcu_unregister_thread(void);
27b012e2	89
e95f4e7f MD	90	/*
	91	* Explicit urcu initialization, for "early" use within library constructors.
	92	*/
	93	extern void urcu_init(void);
	94
27b012e2	95	#endif /* _URCU_H */