include/urcu/urcu-mb.h

   1 #ifndef _URCU_MB_H
   2 #define _URCU_MB_H
   3
   4 /*
   5  * urcu-mb.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
  37 /*
  38  * See urcu/pointer.h and urcu/static/pointer.h for pointer
  39  * publication headers.
  40  */
  41 #include <urcu/pointer.h>
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #include <urcu/map/urcu-mb.h>
  48
  49 /*
  50  * Important !
  51  *
  52  * Each thread containing read-side critical sections must be registered
  53  * with rcu_register_thread_mb() before calling rcu_read_lock_mb().
  54  * rcu_unregister_thread_mb() should be called before the thread exits.
  55  */
  56
  57 #ifdef _LGPL_SOURCE
  58
  59 #include <urcu/static/urcu-mb.h>
  60
  61 /*
  62  * Mappings for static use of the userspace RCU library.
  63  * Should only be used in LGPL-compatible code.
  64  */
  65
  66 /*
  67  * rcu_read_lock()
  68  * rcu_read_unlock()
  69  *
  70  * Mark the beginning and end of a read-side critical section.
  71  * DON'T FORGET TO USE RCU_REGISTER/UNREGISTER_THREAD() FOR EACH THREAD WITH
  72  * READ-SIDE CRITICAL SECTION.
  73  */
  74 #define urcu_mb_read_lock               _urcu_mb_read_lock
  75 #define urcu_mb_read_unlock             _urcu_mb_read_unlock
  76 #define urcu_mb_read_ongoing            _urcu_mb_read_ongoing
  77
  78 #else /* !_LGPL_SOURCE */
  79
  80 /*
  81  * library wrappers to be used by non-LGPL compatible source code.
  82  * See LGPL-only urcu/static/pointer.h for documentation.
  83  */
  84
  85 extern void urcu_mb_read_lock(void);
  86 extern void urcu_mb_read_unlock(void);
  87 extern int urcu_mb_read_ongoing(void);
  88
  89 #endif /* !_LGPL_SOURCE */
  90
  91 extern void urcu_mb_synchronize_rcu(void);
  92
  93 /*
  94  * Reader thread registration.
  95  */
  96 extern void urcu_mb_register_thread(void);
  97 extern void urcu_mb_unregister_thread(void);
  98
  99 /*
 100  * Explicit rcu initialization, for "early" use within library constructors.
 101  */
 102 extern void urcu_mb_init(void);
 103
 104 /*
 105  * Q.S. reporting are no-ops for these URCU flavors.
 106  */
 107 static inline void urcu_mb_quiescent_state(void)
 108 {
 109 }
 110
 111 static inline void urcu_mb_thread_offline(void)
 112 {
 113 }
 114
 115 static inline void urcu_mb_thread_online(void)
 116 {
 117 }
 118
 119 #ifdef __cplusplus
 120 }
 121 #endif
 122
 123 #include <urcu/call-rcu.h>
 124 #include <urcu/defer.h>
 125 #include <urcu/flavor.h>
 126
 127 #ifndef URCU_API_MAP
 128 #include <urcu/map/clear.h>
 129 #endif
 130
 131 #endif /* _URCU_MB_H */