2 This file is a part of libcds - Concurrent Data Structures library
4 (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
6 Source code repo: http://github.com/khizmax/libcds/
7 Download: http://sourceforge.net/projects/libcds/files/
9 Redistribution and use in source and binary forms, with or without
10 modification, are permitted provided that the following conditions are met:
12 * Redistributions of source code must retain the above copyright notice, this
13 list of conditions and the following disclaimer.
15 * Redistributions in binary form must reproduce the above copyright notice,
16 this list of conditions and the following disclaimer in the documentation
17 and/or other materials provided with the distribution.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef CDSLIB_THREADING_DETAILS_PTHREAD_MANAGER_H
32 #define CDSLIB_THREADING_DETAILS_PTHREAD_MANAGER_H
34 #include <system_error>
37 #include <cds/threading/details/_common.h>
40 namespace cds { namespace threading {
42 /// cds::threading::Manager implementation based on pthread thread-specific data functions
43 CDS_CXX11_INLINE_NAMESPACE namespace pthread {
45 /// Thread-specific data manager based on pthread thread-specific data functions
47 Manager throws an exception of Manager::pthread_exception class if an error occurs
51 /// pthread error code type
52 typedef int pthread_error_code;
55 class pthread_exception: public std::system_error
58 /// Exception constructor
59 pthread_exception( int nCode, const char * pszFunction )
60 : std::system_error( nCode, std::system_category(), pszFunction )
64 /// pthread TLS key holder
67 static pthread_key_t m_key;
69 static void key_destructor(void * p)
72 reinterpret_cast<ThreadData *>(p)->fini();
73 delete reinterpret_cast<ThreadData *>(p);
79 pthread_error_code nErr;
80 if ( (nErr = pthread_key_create( &m_key, key_destructor )) != 0 )
81 throw pthread_exception( nErr, "pthread_key_create" );
86 pthread_error_code nErr;
87 if ( (nErr = pthread_key_delete( m_key )) != 0 )
88 throw pthread_exception( nErr, "pthread_key_delete" );
91 static ThreadData * get()
93 return reinterpret_cast<ThreadData *>( pthread_getspecific( m_key ) );
98 pthread_error_code nErr;
99 ThreadData * pData = new ThreadData;
100 if ( ( nErr = pthread_setspecific( m_key, pData )) != 0 )
101 throw pthread_exception( nErr, "pthread_setspecific" );
105 ThreadData * p = get();
106 pthread_setspecific( m_key, nullptr );
125 static ThreadData * _threadData( EThreadAction nAction )
129 return Holder::get();
131 return Holder::get();
132 case do_attachThread:
133 if ( Holder::get() == nullptr )
135 return Holder::get();
136 case do_detachThread:
143 assert( false ) ; // anything forgotten?..
145 assert(false) ; // how did we get here?
151 /// Initialize manager
153 This function is automatically called by cds::Initialize
160 /// Terminate manager
162 This function is automatically called by cds::Terminate
169 /// Checks whether current thread is attached to \p libcds feature or not.
170 static bool isThreadAttached()
172 return _threadData( do_checkData ) != nullptr;
175 /// This method must be called in beginning of thread execution
177 If TLS pointer to manager's data is \p nullptr, pthread_exception is thrown
179 If an error occurs in call of pthread API function, pthread_exception is thrown
180 with pthread error code.
182 static void attachThread()
184 ThreadData * pData = _threadData( do_attachThread );
191 throw pthread_exception( -1, "cds::threading::pthread::Manager::attachThread" );
194 /// This method must be called in end of thread execution
196 If TLS pointer to manager's data is \p nullptr, pthread_exception is thrown
198 If an error occurs in call of pthread API function, pthread_exception is thrown
199 with pthread error code.
201 static void detachThread()
203 ThreadData * pData = _threadData( do_getData );
208 _threadData( do_detachThread );
211 throw pthread_exception( -1, "cds::threading::pthread::Manager::detachThread" );
214 /// Returns ThreadData pointer for the current thread
215 static ThreadData * thread_data()
217 return _threadData( do_getData );
220 /// Get gc::HP thread GC implementation for current thread
222 The object returned may be uninitialized if you did not call attachThread in the beginning of thread execution
223 or if you did not use gc::HP.
224 To initialize gc::HP GC you must constuct cds::gc::HP object in the beginning of your application
226 static gc::HP::thread_gc_impl& getHZPGC()
228 return *(_threadData( do_getData )->m_hpManager);
231 /// Get gc::DHP thread GC implementation for current thread
233 The object returned may be uninitialized if you did not call attachThread in the beginning of thread execution
234 or if you did not use gc::DHP.
235 To initialize gc::DHP GC you must constuct cds::gc::DHP object in the beginning of your application
237 static gc::DHP::thread_gc_impl& getDHPGC()
239 return *(_threadData( do_getData )->m_dhpManager);
243 static size_t fake_current_processor()
245 return _threadData( do_getData )->fake_current_processor();
251 } // namespace pthread
252 }} // namespace cds::threading
255 #endif // #ifndef CDSLIB_THREADING_DETAILS_PTHREAD_MANAGER_H