libstdc++-v3/include/bits/stl_threads.h

   1 // Threading support -*- C++ -*-
   2
   3 // Copyright (C) 2001, 2002 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 2, or (at your option)
   9 // any later version.
  10
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19 // USA.
  20
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 /*
  31  * Copyright (c) 1997-1999
  32  * Silicon Graphics Computer Systems, Inc.
  33  *
  34  * Permission to use, copy, modify, distribute and sell this software
  35  * and its documentation for any purpose is hereby granted without fee,
  36  * provided that the above copyright notice appear in all copies and
  37  * that both that copyright notice and this permission notice appear
  38  * in supporting documentation.  Silicon Graphics makes no
  39  * representations about the suitability of this software for any
  40  * purpose.  It is provided "as is" without express or implied warranty.
  41  */
  42
  43 /** @file stl_threads.h
  44  *  This is an internal header file, included by other library headers.
  45  *  You should not attempt to use it directly.
  46  */
  47
  48 #ifndef __SGI_STL_INTERNAL_THREADS_H
  49 #define __SGI_STL_INTERNAL_THREADS_H
  50
  51 // The only supported threading model is GCC's own gthr.h abstraction layer.
  52 #include "bits/gthr.h"
  53
  54 namespace std
  55 {
  56   // Class _Refcount_Base provides a type, _RC_t, a data member,
  57   // _M_ref_count, and member functions _M_incr and _M_decr, which perform
  58   // atomic preincrement/predecrement.  The constructor initializes
  59   // _M_ref_count.
  60   struct _Refcount_Base
  61   {
  62     // The type _RC_t
  63     typedef size_t _RC_t;
  64
  65     // The data member _M_ref_count
  66     volatile _RC_t _M_ref_count;
  67
  68     // Constructor
  69     __gthread_mutex_t _M_ref_count_lock;
  70
  71     _Refcount_Base(_RC_t __n) : _M_ref_count(__n)
  72     {
  73 #ifdef __GTHREAD_MUTEX_INIT
  74       __gthread_mutex_t __tmp = __GTHREAD_MUTEX_INIT;
  75       _M_ref_count_lock = __tmp;
  76 #elif defined(__GTHREAD_MUTEX_INIT_FUNCTION)
  77       __GTHREAD_MUTEX_INIT_FUNCTION (&_M_ref_count_lock);
  78 #else
  79 #error __GTHREAD_MUTEX_INIT or __GTHREAD_MUTEX_INIT_FUNCTION should be defined by gthr.h abstraction layer, report problem to libstdc++@gcc.gnu.org.
  80 #endif
  81     }
  82
  83     void
  84     _M_incr()
  85     {
  86       __gthread_mutex_lock(&_M_ref_count_lock);
  87       ++_M_ref_count;
  88       __gthread_mutex_unlock(&_M_ref_count_lock);
  89     }
  90
  91     _RC_t
  92     _M_decr()
  93     {
  94       __gthread_mutex_lock(&_M_ref_count_lock);
  95       volatile _RC_t __tmp = --_M_ref_count;
  96       __gthread_mutex_unlock(&_M_ref_count_lock);
  97       return __tmp;
  98     }
  99   };
 100 } //namespace std
 101
 102   // Locking class.  Note that this class *does not have a
 103   // constructor*.  It must be initialized either statically, with
 104   // __STL_MUTEX_INITIALIZER, or dynamically, by explicitly calling
 105   // the _M_initialize member function.  (This is similar to the ways
 106   // that a pthreads mutex can be initialized.)  There are explicit
 107   // member functions for acquiring and releasing the lock.
 108
 109   // There is no constructor because static initialization is
 110   // essential for some uses, and only a class aggregate (see section
 111   // 8.5.1 of the C++ standard) can be initialized that way.  That
 112   // means we must have no constructors, no base classes, no virtual
 113   // functions, and no private or protected members.
 114
 115 #if !defined(__GTHREAD_MUTEX_INIT) && defined(__GTHREAD_MUTEX_INIT_FUNCTION)
 116 namespace __gnu_cxx
 117 {
 118   extern __gthread_mutex_t _GLIBCPP_mutex;
 119   extern __gthread_mutex_t *_GLIBCPP_mutex_address;
 120   extern __gthread_once_t _GLIBCPP_once;
 121   extern void _GLIBCPP_mutex_init (void);
 122   extern void _GLIBCPP_mutex_address_init (void);
 123 }
 124 #endif
 125
 126 namespace std
 127 {
 128   struct _STL_mutex_lock
 129   {
 130     // The class must be statically initialized with __STL_MUTEX_INITIALIZER.
 131 #if !defined(__GTHREAD_MUTEX_INIT) && defined(__GTHREAD_MUTEX_INIT_FUNCTION)
 132     volatile int _M_init_flag;
 133     __gthread_once_t _M_once;
 134 #endif
 135     __gthread_mutex_t _M_lock;
 136
 137     void
 138     _M_initialize()
 139     {
 140 #ifdef __GTHREAD_MUTEX_INIT
 141       // There should be no code in this path given the usage rules above.
 142 #elif defined(__GTHREAD_MUTEX_INIT_FUNCTION)
 143       if (_M_init_flag) return;
 144       if (__gthread_once (&__gnu_cxx::_GLIBCPP_once,
 145                           __gnu_cxx::_GLIBCPP_mutex_init) != 0
 146           && __gthread_active_p ())
 147         abort ();
 148       __gthread_mutex_lock (&__gnu_cxx::_GLIBCPP_mutex);
 149       if (!_M_init_flag)
 150         {
 151           // Even though we have a global lock, we use __gthread_once to be
 152           // absolutely certain the _M_lock mutex is only initialized once on
 153           // multiprocessor systems.
 154           __gnu_cxx::_GLIBCPP_mutex_address = &_M_lock;
 155           if (__gthread_once (&_M_once,
 156                               __gnu_cxx::_GLIBCPP_mutex_address_init) != 0
 157             && __gthread_active_p ())
 158             abort ();
 159           _M_init_flag = 1;
 160         }
 161       __gthread_mutex_unlock (&__gnu_cxx::_GLIBCPP_mutex);
 162 #endif
 163     }
 164
 165     void
 166     _M_acquire_lock()
 167     {
 168 #if !defined(__GTHREAD_MUTEX_INIT) && defined(__GTHREAD_MUTEX_INIT_FUNCTION)
 169       if (!_M_init_flag) _M_initialize();
 170 #endif
 171       __gthread_mutex_lock(&_M_lock);
 172     }
 173
 174     void
 175     _M_release_lock()
 176     {
 177 #if !defined(__GTHREAD_MUTEX_INIT) && defined(__GTHREAD_MUTEX_INIT_FUNCTION)
 178       if (!_M_init_flag) _M_initialize();
 179 #endif
 180       __gthread_mutex_unlock(&_M_lock);
 181     }
 182   };
 183
 184 #ifdef __GTHREAD_MUTEX_INIT
 185 #define __STL_MUTEX_INITIALIZER = { __GTHREAD_MUTEX_INIT }
 186 #elif defined(__GTHREAD_MUTEX_INIT_FUNCTION)
 187 #ifdef __GTHREAD_MUTEX_INIT_DEFAULT
 188 #define __STL_MUTEX_INITIALIZER \
 189   = { 0, __GTHREAD_ONCE_INIT, __GTHREAD_MUTEX_INIT_DEFAULT }
 190 #else
 191 #define __STL_MUTEX_INITIALIZER = { 0, __GTHREAD_ONCE_INIT }
 192 #endif
 193 #endif
 194
 195   // A locking class that uses _STL_mutex_lock.  The constructor takes a
 196   // reference to an _STL_mutex_lock, and acquires a lock.  The
 197   // destructor releases the lock.  It's not clear that this is exactly
 198   // the right functionality.  It will probably change in the future.
 199   struct _STL_auto_lock
 200   {
 201     _STL_mutex_lock& _M_lock;
 202
 203     _STL_auto_lock(_STL_mutex_lock& __lock) : _M_lock(__lock)
 204     { _M_lock._M_acquire_lock(); }
 205
 206     ~_STL_auto_lock() { _M_lock._M_release_lock(); }
 207
 208   private:
 209     void operator=(const _STL_auto_lock&);
 210     _STL_auto_lock(const _STL_auto_lock&);
 211   } __attribute__ ((__unused__));
 212
 213 } // namespace std
 214
 215 #endif