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

#ifndef _URCU_BATCH_H
#define _URCU_BATCH_H

/*
 * urcu-defer.h
 *
 * Userspace RCU header - deferred execution
 *
 * Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 * Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
 *
 * LGPL-compatible code should include this header with :
 *
 * #define _LGPL_SOURCE
 * #include <urcu-defer.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
 */

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

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Note: the defer_rcu() API is currently EXPERIMENTAL. It may change in the
 * future.
 *
 * Important !
 *
 * Each thread queuing memory reclamation must be registered with
 * rcu_defer_register_thread(). rcu_defer_unregister_thread() should be
 * called before the thread exits.
 *
 * *NEVER* use defer_rcu() within a RCU read-side critical section, because this
 * primitive need to call synchronize_rcu() if the thread queue is full.
 */

extern void defer_rcu(void (*fct)(void *p), void *p);

/*
 * Thread registration for reclamation.
 */
extern int rcu_defer_register_thread(void);
extern void rcu_defer_unregister_thread(void);
extern void rcu_defer_barrier(void);
extern void rcu_defer_barrier_thread(void);

#ifdef __cplusplus
}
#endif

#endif /* _URCU_BATCH_H */
Commit	Line	Data
	1	#ifndef _URCU_BATCH_H
	2	#define _URCU_BATCH_H
	3
	4	/*
	5	* urcu-defer.h
	6	*
	7	* Userspace RCU header - deferred execution
	8	*
	9	* Copyright (c) 2009 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	10	* Copyright (c) 2009 Paul E. McKenney, IBM Corporation.
	11	*
	12	* LGPL-compatible code should include this header with :
	13	*
	14	* #define _LGPL_SOURCE
	15	* #include <urcu-defer.h>
	16	*
	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
	30	*/
	31
	32	#include <stdlib.h>
	33	#include <pthread.h>
	34
	35	#ifdef __cplusplus
	36	extern "C" {
	37	#endif
	38
	39	/*
	40	* Note: the defer_rcu() API is currently EXPERIMENTAL. It may change in the
	41	* future.
	42	*
	43	* Important !
	44	*
	45	* Each thread queuing memory reclamation must be registered with
	46	* rcu_defer_register_thread(). rcu_defer_unregister_thread() should be
	47	* called before the thread exits.
	48	*
	49	* NEVER use defer_rcu() within a RCU read-side critical section, because this
	50	* primitive need to call synchronize_rcu() if the thread queue is full.
	51	*/
	52
	53	extern void defer_rcu(void (fct)(void p), void *p);
	54
	55	/*
	56	* Thread registration for reclamation.
	57	*/
	58	extern int rcu_defer_register_thread(void);
	59	extern void rcu_defer_unregister_thread(void);
	60	extern void rcu_defer_barrier(void);
	61	extern void rcu_defer_barrier_thread(void);
	62
	63	#ifdef __cplusplus
	64	}
	65	#endif
	66
	67	#endif /* _URCU_BATCH_H */