[userspace-rcu.git] / include / urcu / flavor.h

#ifndef _URCU_FLAVOR_H
#define _URCU_FLAVOR_H

/*
 * urcu-flavor.h
 *
 * Userspace RCU header - rcu flavor declarations
 *
 * Copyright (c) 2011 Lai Jiangshan <laijs@cn.fujitsu.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 rcu_head;

struct urcu_atfork {
	void (*before_fork)(void *priv);
	void (*after_fork_parent)(void *priv);
	void (*after_fork_child)(void *priv);
	void *priv;
};

void urcu_register_rculfhash_atfork(struct urcu_atfork *atfork);
void urcu_unregister_rculfhash_atfork(struct urcu_atfork *atfork);

struct rcu_flavor_struct {
	void (*read_lock)(void);
	void (*read_unlock)(void);
	int (*read_ongoing)(void);
	void (*read_quiescent_state)(void);
	void (*update_call_rcu)(struct rcu_head *head,
				void (*func)(struct rcu_head *head));
	void (*update_synchronize_rcu)(void);
	void (*update_defer_rcu)(void (*fct)(void *p), void *p);

	void (*thread_offline)(void);
	void (*thread_online)(void);
	void (*register_thread)(void);
	void (*unregister_thread)(void);

	void (*barrier)(void);

	void (*register_rculfhash_atfork)(struct urcu_atfork *atfork);
	void (*unregister_rculfhash_atfork)(struct urcu_atfork *atfork);
};

#define DEFINE_RCU_FLAVOR(x)				\
const struct rcu_flavor_struct x = {			\
	.read_lock		= rcu_read_lock,	\
	.read_unlock		= rcu_read_unlock,	\
	.read_ongoing		= rcu_read_ongoing,	\
	.read_quiescent_state	= rcu_quiescent_state,	\
	.update_call_rcu	= call_rcu,		\
	.update_synchronize_rcu	= synchronize_rcu,	\
	.update_defer_rcu	= defer_rcu,		\
	.thread_offline		= rcu_thread_offline,	\
	.thread_online		= rcu_thread_online,	\
	.register_thread	= rcu_register_thread,	\
	.unregister_thread	= rcu_unregister_thread,\
	.barrier		= rcu_barrier,		\
	.register_rculfhash_atfork = urcu_register_rculfhash_atfork,	\
	.unregister_rculfhash_atfork = urcu_unregister_rculfhash_atfork,\
}

#define DEFINE_RCU_FLAVOR_ALIAS(x, y) _DEFINE_RCU_FLAVOR_ALIAS(x, y)
#ifdef __APPLE__
#define _DEFINE_RCU_FLAVOR_ALIAS(x, y)
#else
#define _DEFINE_RCU_FLAVOR_ALIAS(x, y)			\
__attribute__((alias(#x)))				\
extern const struct rcu_flavor_struct y;
#endif

extern const struct rcu_flavor_struct rcu_flavor;

#ifdef __cplusplus
}
#endif

#endif /* _URCU_FLAVOR_H */
Commit	Line	Data
541d828d LJ	1	#ifndef _URCU_FLAVOR_H
	2	#define _URCU_FLAVOR_H
	3
	4	/*
	5	* urcu-flavor.h
	6	*
	7	* Userspace RCU header - rcu flavor declarations
	8	*
	9	* Copyright (c) 2011 Lai Jiangshan <laijs@cn.fujitsu.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
6bcce235 MD	30	struct rcu_head;
6bcce235 MD	31
d0ec0ed2 MD	32	struct urcu_atfork {
	33	void (before_fork)(void priv);
	34	void (after_fork_parent)(void priv);
	35	void (after_fork_child)(void priv);
	36	void *priv;
	37	};
	38
	39	void urcu_register_rculfhash_atfork(struct urcu_atfork *atfork);
	40	void urcu_unregister_rculfhash_atfork(struct urcu_atfork *atfork);
	41
541d828d LJ	42	struct rcu_flavor_struct {
	43	void (*read_lock)(void);
	44	void (*read_unlock)(void);
882f3357	45	int (*read_ongoing)(void);
541d828d LJ	46	void (*read_quiescent_state)(void);
	47	void (update_call_rcu)(struct rcu_head head,
	48	void (func)(struct rcu_head head));
	49	void (*update_synchronize_rcu)(void);
	50	void (update_defer_rcu)(void (fct)(void p), void p);
	51
	52	void (*thread_offline)(void);
	53	void (*thread_online)(void);
	54	void (*register_thread)(void);
	55	void (*unregister_thread)(void);
b7f721d9 MD	56
b7f721d9 MD	57	void (*barrier)(void);
d0ec0ed2 MD	58
	59	void (register_rculfhash_atfork)(struct urcu_atfork atfork);
	60	void (unregister_rculfhash_atfork)(struct urcu_atfork atfork);
541d828d LJ	61	};
541d828d LJ	62
5e6b23a6 MD	63	#define DEFINE_RCU_FLAVOR(x) \
5e6b23a6 MD	64	const struct rcu_flavor_struct x = { \
541d828d LJ	65	.read_lock = rcu_read_lock, \
541d828d LJ	66	.read_unlock = rcu_read_unlock, \
882f3357	67	.read_ongoing = rcu_read_ongoing, \
541d828d LJ	68	.read_quiescent_state = rcu_quiescent_state, \
	69	.update_call_rcu = call_rcu, \
	70	.update_synchronize_rcu = synchronize_rcu, \
	71	.update_defer_rcu = defer_rcu, \
	72	.thread_offline = rcu_thread_offline, \
	73	.thread_online = rcu_thread_online, \
	74	.register_thread = rcu_register_thread, \
	75	.unregister_thread = rcu_unregister_thread,\
b7f721d9	76	.barrier = rcu_barrier, \
d0ec0ed2 MD	77	.register_rculfhash_atfork = urcu_register_rculfhash_atfork, \
d0ec0ed2 MD	78	.unregister_rculfhash_atfork = urcu_unregister_rculfhash_atfork,\
5e6b23a6	79	}
541d828d	80
4477a870	81	#define DEFINE_RCU_FLAVOR_ALIAS(x, y) _DEFINE_RCU_FLAVOR_ALIAS(x, y)
ce28e67a MJ	82	#ifdef __APPLE__
	83	#define _DEFINE_RCU_FLAVOR_ALIAS(x, y)
	84	#else
4477a870 MD	85	#define _DEFINE_RCU_FLAVOR_ALIAS(x, y) \
	86	__attribute__((alias(#x))) \
	87	extern const struct rcu_flavor_struct y;
ce28e67a	88	#endif
4477a870	89
541d828d LJ	90	extern const struct rcu_flavor_struct rcu_flavor;
	91
	92	#ifdef __cplusplus
	93	}
	94	#endif
	95
	96	#endif /* _URCU_FLAVOR_H */