urcu.h

   1 #ifndef _URCU_H
   2 #define _URCU_H
   3
   4 /*
   5  * urcu.h
   6  *
   7  * Userspace RCU header
   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.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  * IBM's contributions to this file may be relicensed under LGPLv2 or later.
  32  */
  33
  34 #include <stdlib.h>
  35 #include <pthread.h>
  36 #include <urcu/tls-compat.h>
  37 #include <stdio.h>
  38 #include <assert.h>
  39
  40 /*
  41  * See urcu-pointer.h and urcu/static/urcu-pointer.h for pointer
  42  * publication headers.
  43  */
  44 #include <urcu-pointer.h>
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 #include <urcu/map/urcu.h>
  51
  52 /*
  53  * Important !
  54  *
  55  * Each thread containing read-side critical sections must be registered
  56  * with rcu_register_thread_mb() before calling rcu_read_lock_mb().
  57  * rcu_unregister_thread_mb() should be called before the thread exits.
  58  */
  59
  60 #ifdef _LGPL_SOURCE
  61
  62 #include <urcu/static/urcu.h>
  63
  64 /*
  65  * Mappings for static use of the userspace RCU library.
  66  * Should only be used in LGPL-compatible code.
  67  */
  68
  69 /*
  70  * rcu_read_lock()
  71  * rcu_read_unlock()
  72  *
  73  * Mark the beginning and end of a read-side critical section.
  74  * DON'T FORGET TO USE RCU_REGISTER/UNREGISTER_THREAD() FOR EACH THREAD WITH
  75  * READ-SIDE CRITICAL SECTION.
  76  */
  77 #ifdef RCU_MEMBARRIER
  78 #define rcu_read_lock_memb              _rcu_read_lock
  79 #define rcu_read_unlock_memb            _rcu_read_unlock
  80 #define rcu_read_ongoing_memb           _rcu_read_ongoing
  81 #elif defined(RCU_SIGNAL)
  82 #define rcu_read_lock_sig               _rcu_read_lock
  83 #define rcu_read_unlock_sig             _rcu_read_unlock
  84 #define rcu_read_ongoing_sig            _rcu_read_ongoing
  85 #elif defined(RCU_MB)
  86 #define rcu_read_lock_mb                _rcu_read_lock
  87 #define rcu_read_unlock_mb              _rcu_read_unlock
  88 #define rcu_read_ongoing_mb             _rcu_read_ongoing
  89 #endif
  90
  91 #else /* !_LGPL_SOURCE */
  92
  93 /*
  94  * library wrappers to be used by non-LGPL compatible source code.
  95  * See LGPL-only urcu/static/urcu-pointer.h for documentation.
  96  */
  97
  98 extern void rcu_read_lock(void);
  99 extern void rcu_read_unlock(void);
 100 extern int rcu_read_ongoing(void);
 101
 102 #endif /* !_LGPL_SOURCE */
 103
 104 extern void synchronize_rcu(void);
 105
 106 /*
 107  * Reader thread registration.
 108  */
 109 extern void rcu_register_thread(void);
 110 extern void rcu_unregister_thread(void);
 111
 112 /*
 113  * Explicit rcu initialization, for "early" use within library constructors.
 114  */
 115 extern void rcu_init(void);
 116
 117 /*
 118  * Q.S. reporting are no-ops for these URCU flavors.
 119  */
 120 static inline void rcu_quiescent_state(void)
 121 {
 122 }
 123
 124 static inline void rcu_thread_offline(void)
 125 {
 126 }
 127
 128 static inline void rcu_thread_online(void)
 129 {
 130 }
 131
 132 #ifdef __cplusplus
 133 }
 134 #endif
 135
 136 #include <urcu-call-rcu.h>
 137 #include <urcu-defer.h>
 138 #include <urcu-flavor.h>
 139
 140 #endif /* _URCU_H */