include/urcu/urcu-memb.h

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