[urcu.git] / urcu.h

#ifndef _URCU_H
#define _URCU_H

/*
 * urcu.h
 *
 * Userspace RCU header
 *
 * Copyright February 2009 - Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
 *
 * Credits for Paul e. McKenney <paulmck@linux.vnet.ibm.com>
 * for inspiration coming from the Linux kernel RCU and rcu-preempt.
 *
 * The barrier, mb, rmb, wmb, atomic_inc, smp_read_barrier_depends, ACCESS_ONCE
 * and rcu_dereference primitives come from the Linux kernel.
 *
 * Distributed under GPLv2
 */

/* The "volatile" is due to gcc bugs */
#define barrier() __asm__ __volatile__("": : :"memory")

/* x86 32/64 specific */
#define mb()    asm volatile("mfence":::"memory")
#define rmb()   asm volatile("lfence":::"memory")
#define wmb()   asm volatile("sfence" ::: "memory")

static inline void atomic_inc(int *v)
{
	asm volatile("lock; incl %0"
		     : "+m" (*v));
}

/* Nop everywhere except on alpha. */
#define smp_read_barrier_depends()

/*
 * Prevent the compiler from merging or refetching accesses.  The compiler
 * is also forbidden from reordering successive instances of ACCESS_ONCE(),
 * but only when the compiler is aware of some particular ordering.  One way
 * to make the compiler aware of ordering is to put the two invocations of
 * ACCESS_ONCE() in different C statements.
 *
 * This macro does absolutely -nothing- to prevent the CPU from reordering,
 * merging, or refetching absolutely anything at any time.  Its main intended
 * use is to mediate communication between process-level code and irq/NMI
 * handlers, all running on the same CPU.
 */
#define ACCESS_ONCE(x) (*(volatile typeof(x) *)&(x))

/**
 * rcu_dereference - fetch an RCU-protected pointer in an
 * RCU read-side critical section.  This pointer may later
 * be safely dereferenced.
 *
 * Inserts memory barriers on architectures that require them
 * (currently only the Alpha), and, more importantly, documents
 * exactly which pointers are protected by RCU.
 */

#define rcu_dereference(p)     ({ \
				typeof(p) _________p1 = ACCESS_ONCE(p); \
				smp_read_barrier_depends(); \
				(_________p1); \
				})

#define SIGURCU SIGUSR1

#ifdef DEBUG_YIELD
#include <sched.h>

#define YIELD_READ 	(1 << 0)
#define YIELD_WRITE	(1 << 1)

extern int yield_active;

static inline void debug_yield_read(void)
{
	if (yield_active & YIELD_READ)
		sched_yield();
}

static inline void debug_yield_write(void)
{
	if (yield_active & YIELD_WRITE)
		sched_yield();
}
#else
static inline void debug_yield_read(void)
{
}

static inline void debug_yield_write(void)
{
}
#endif

/* Global quiescent period parity */
extern int urcu_qparity;

extern int __thread urcu_active_readers[2];

static inline int get_urcu_qparity(void)
{
	return urcu_qparity;
}

/*
 * urcu_parity should be declared on the caller's stack.
 */
static inline void rcu_read_lock(int *urcu_parity)
{
	debug_yield_read();
	*urcu_parity = get_urcu_qparity();
	debug_yield_read();
	urcu_active_readers[*urcu_parity]++;
	debug_yield_read();
	/*
	 * Increment active readers count before accessing the pointer.
	 * See force_mb_all_threads().
	 */
	barrier();
	debug_yield_read();
}

static inline void rcu_read_unlock(int *urcu_parity)
{
	debug_yield_read();
	barrier();
	debug_yield_read();
	/*
	 * Finish using rcu before decrementing the pointer.
	 * See force_mb_all_threads().
	 */
	urcu_active_readers[*urcu_parity]--;
	debug_yield_read();
}

extern void *urcu_publish_content(void **ptr, void *new);

/*
 * Reader thread registration.
 */
extern void urcu_register_thread(void);
extern void urcu_unregister_thread(void);

#endif /* _URCU_H */
Commit	Line	Data
	1	#ifndef _URCU_H
	2	#define _URCU_H
	3
	4	/*
	5	* urcu.h
	6	*
	7	* Userspace RCU header
	8	*
	9	* Copyright February 2009 - Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
	10	*
	11	* Credits for Paul e. McKenney <paulmck@linux.vnet.ibm.com>
	12	* for inspiration coming from the Linux kernel RCU and rcu-preempt.
	13	*
	14	* The barrier, mb, rmb, wmb, atomic_inc, smp_read_barrier_depends, ACCESS_ONCE
	15	* and rcu_dereference primitives come from the Linux kernel.
	16	*
	17	* Distributed under GPLv2
	18	*/
	19
	20	/* The "volatile" is due to gcc bugs */
	21	#define barrier() __asm__ __volatile__("": : :"memory")
	22
	23	/* x86 32/64 specific */
	24	#define mb() asm volatile("mfence":::"memory")
	25	#define rmb() asm volatile("lfence":::"memory")
	26	#define wmb() asm volatile("sfence" ::: "memory")
	27
	28	static inline void atomic_inc(int *v)
	29	{
	30	asm volatile("lock; incl %0"
	31	: "+m" (*v));
	32	}
	33
	34	/* Nop everywhere except on alpha. */
	35	#define smp_read_barrier_depends()
	36
	37	/*
	38	* Prevent the compiler from merging or refetching accesses. The compiler
	39	* is also forbidden from reordering successive instances of ACCESS_ONCE(),
	40	* but only when the compiler is aware of some particular ordering. One way
	41	* to make the compiler aware of ordering is to put the two invocations of
	42	* ACCESS_ONCE() in different C statements.
	43	*
	44	* This macro does absolutely -nothing- to prevent the CPU from reordering,
	45	* merging, or refetching absolutely anything at any time. Its main intended
	46	* use is to mediate communication between process-level code and irq/NMI
	47	* handlers, all running on the same CPU.
	48	*/
	49	#define ACCESS_ONCE(x) ((volatile typeof(x) )&(x))
	50
	51	/**
	52	* rcu_dereference - fetch an RCU-protected pointer in an
	53	* RCU read-side critical section. This pointer may later
	54	* be safely dereferenced.
	55	*
	56	* Inserts memory barriers on architectures that require them
	57	* (currently only the Alpha), and, more importantly, documents
	58	* exactly which pointers are protected by RCU.
	59	*/
	60
	61	#define rcu_dereference(p) ({ \
	62	typeof(p) _________p1 = ACCESS_ONCE(p); \
	63	smp_read_barrier_depends(); \
	64	(_________p1); \
	65	})
	66
	67	#define SIGURCU SIGUSR1
	68
	69	#ifdef DEBUG_YIELD
	70	#include <sched.h>
	71
	72	#define YIELD_READ (1 << 0)
	73	#define YIELD_WRITE (1 << 1)
	74
	75	extern int yield_active;
	76
	77	static inline void debug_yield_read(void)
	78	{
	79	if (yield_active & YIELD_READ)
	80	sched_yield();
	81	}
	82
	83	static inline void debug_yield_write(void)
	84	{
	85	if (yield_active & YIELD_WRITE)
	86	sched_yield();
	87	}
	88	#else
	89	static inline void debug_yield_read(void)
	90	{
	91	}
	92
	93	static inline void debug_yield_write(void)
	94	{
	95	}
	96	#endif
	97
	98	/* Global quiescent period parity */
	99	extern int urcu_qparity;
	100
	101	extern int __thread urcu_active_readers[2];
	102
	103	static inline int get_urcu_qparity(void)
	104	{
	105	return urcu_qparity;
	106	}
	107
	108	/*
	109	* urcu_parity should be declared on the caller's stack.
	110	*/
	111	static inline void rcu_read_lock(int *urcu_parity)
	112	{
	113	debug_yield_read();
	114	*urcu_parity = get_urcu_qparity();
	115	debug_yield_read();
	116	urcu_active_readers[*urcu_parity]++;
	117	debug_yield_read();
	118	/*
	119	* Increment active readers count before accessing the pointer.
	120	* See force_mb_all_threads().
	121	*/
	122	barrier();
	123	debug_yield_read();
	124	}
	125
	126	static inline void rcu_read_unlock(int *urcu_parity)
	127	{
	128	debug_yield_read();
	129	barrier();
	130	debug_yield_read();
	131	/*
	132	* Finish using rcu before decrementing the pointer.
	133	* See force_mb_all_threads().
	134	*/
	135	urcu_active_readers[*urcu_parity]--;
	136	debug_yield_read();
	137	}
	138
	139	extern void urcu_publish_content(void ptr, void new);
	140
	141	/*
	142	* Reader thread registration.
	143	*/
	144	extern void urcu_register_thread(void);
	145	extern void urcu_unregister_thread(void);
	146
	147	#endif /* _URCU_H */