2 This file is a part of libcds - Concurrent Data Structures library
4 (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
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_WINTLS_MANAGER_H
32 #define CDSLIB_THREADING_DETAILS_WINTLS_MANAGER_H
34 #include <system_error>
36 #include <cds/threading/details/_common.h>
37 #include <cds/details/throw_exception.h>
40 namespace cds { namespace threading {
42 /// cds::threading::Manager implementation based on Windows TLS API
43 CDS_CXX11_INLINE_NAMESPACE namespace wintls {
45 /// Thread-specific data manager based on Windows TLS API
47 Manager throws an exception of Manager::api_exception class if an error occurs
51 /// Windows TLS API error code type
52 typedef DWORD api_error_code;
55 class api_exception : public std::system_error
58 /// Exception constructor
59 api_exception( api_error_code nCode, const char * pszFunction )
60 : std::system_error( static_cast<int>(nCode), std::system_category(), pszFunction )
76 static CDS_EXPORT_API DWORD m_key;
80 if ( m_key == TLS_OUT_OF_INDEXES ) {
81 if ( ( m_key = ::TlsAlloc() ) == TLS_OUT_OF_INDEXES )
82 CDS_THROW_EXCEPTION( api_exception( ::GetLastError(), "TlsAlloc" ));
88 if ( m_key != TLS_OUT_OF_INDEXES ) {
89 if ( ::TlsFree( m_key ) == 0 )
90 CDS_THROW_EXCEPTION( api_exception( ::GetLastError(), "TlsFree" ));
91 m_key = TLS_OUT_OF_INDEXES;
95 static ThreadData * get()
98 void * pData = ::TlsGetValue( m_key );
99 if ( pData == nullptr && ( nErr = ::GetLastError() ) != ERROR_SUCCESS )
100 CDS_THROW_EXCEPTION( api_exception( nErr, "TlsGetValue" ));
101 return reinterpret_cast<ThreadData *>( pData );
106 ThreadData * pData = new ThreadData;
107 if ( !::TlsSetValue( m_key, pData ))
108 CDS_THROW_EXCEPTION( api_exception( ::GetLastError(), "TlsSetValue" ));
112 ThreadData * p = get();
113 ::TlsSetValue( m_key, nullptr );
121 static ThreadData * _threadData( EThreadAction nAction )
127 ThreadData * p = Holder::get();
132 return Holder::get();
135 return Holder::get();
136 case do_attachThread:
137 if ( Holder::get() == nullptr )
139 return Holder::get();
140 case do_detachThread:
144 assert( false ) ; // anything forgotten?..
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, api_exception is thrown
179 If an error occurs in call of Win TLS API function, api_exception is thrown
180 with Windows error code.
182 static void attachThread()
184 ThreadData * pData = _threadData( do_attachThread );
190 CDS_THROW_EXCEPTION( api_exception( api_error_code(-1), "cds::threading::wintls::Manager::attachThread" ));
193 /// This method must be called in end of thread execution
195 If TLS pointer to manager's data is \p nullptr, api_exception is thrown
197 If an error occurs in call of Win TLS API function, api_exception is thrown
198 with Windows error code.
200 static void detachThread()
202 ThreadData * pData = _threadData( do_getData );
207 _threadData( do_detachThread );
210 CDS_THROW_EXCEPTION( api_exception( api_error_code(-1), "cds::threading::winapi::Manager::detachThread" ));
213 /// Returns ThreadData pointer for the current thread
214 static ThreadData * thread_data()
216 return _threadData( do_getData );
220 static size_t fake_current_processor()
222 return _threadData( do_getData )->fake_current_processor();
227 } // namespace wintls
228 }} // namespace cds::threading
231 #endif // #ifndef CDSLIB_THREADING_DETAILS_WINTLS_MANAGER_H