1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski #ifndef _THREAD_HXX_
25*b1cdbd2cSJim Jagielski #define _THREAD_HXX_
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski #ifdef __cplusplus
28*b1cdbd2cSJim Jagielski
29*b1cdbd2cSJim Jagielski #include <osl/time.h>
30*b1cdbd2cSJim Jagielski
31*b1cdbd2cSJim Jagielski
32*b1cdbd2cSJim Jagielski #include <osl/diagnose.h>
33*b1cdbd2cSJim Jagielski #include <osl/thread.h>
34*b1cdbd2cSJim Jagielski #include <rtl/alloc.h>
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski namespace osl
37*b1cdbd2cSJim Jagielski {
38*b1cdbd2cSJim Jagielski /** threadFunc is the function which is executed by the threads
39*b1cdbd2cSJim Jagielski created by the osl::Thread class. The function's signature
40*b1cdbd2cSJim Jagielski matches the one of oslWorkerFunction which is declared in
41*b1cdbd2cSJim Jagielski osl/thread.h .
42*b1cdbd2cSJim Jagielski */
43*b1cdbd2cSJim Jagielski extern "C" inline void SAL_CALL threadFunc( void* param);
44*b1cdbd2cSJim Jagielski
45*b1cdbd2cSJim Jagielski class Thread
46*b1cdbd2cSJim Jagielski {
47*b1cdbd2cSJim Jagielski Thread( const Thread& );
48*b1cdbd2cSJim Jagielski Thread& operator= ( const Thread& );
49*b1cdbd2cSJim Jagielski public:
50*b1cdbd2cSJim Jagielski // these are here to force memory de/allocation to sal lib.
operator new(size_t nSize)51*b1cdbd2cSJim Jagielski inline static void * SAL_CALL operator new( size_t nSize ) SAL_THROW (())
52*b1cdbd2cSJim Jagielski { return ::rtl_allocateMemory( nSize ); }
operator delete(void * pMem)53*b1cdbd2cSJim Jagielski inline static void SAL_CALL operator delete( void * pMem ) SAL_THROW (())
54*b1cdbd2cSJim Jagielski { ::rtl_freeMemory( pMem ); }
operator new(size_t,void * pMem)55*b1cdbd2cSJim Jagielski inline static void * SAL_CALL operator new( size_t, void * pMem ) SAL_THROW (())
56*b1cdbd2cSJim Jagielski { return pMem; }
operator delete(void *,void *)57*b1cdbd2cSJim Jagielski inline static void SAL_CALL operator delete( void *, void * ) SAL_THROW (())
58*b1cdbd2cSJim Jagielski {}
59*b1cdbd2cSJim Jagielski
Thread()60*b1cdbd2cSJim Jagielski Thread(): m_hThread(0){}
61*b1cdbd2cSJim Jagielski
~Thread()62*b1cdbd2cSJim Jagielski virtual ~Thread()
63*b1cdbd2cSJim Jagielski {
64*b1cdbd2cSJim Jagielski osl_destroyThread( m_hThread);
65*b1cdbd2cSJim Jagielski }
66*b1cdbd2cSJim Jagielski
create()67*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL create()
68*b1cdbd2cSJim Jagielski {
69*b1cdbd2cSJim Jagielski OSL_ASSERT(m_hThread == 0); // only one running thread per instance
70*b1cdbd2cSJim Jagielski if (m_hThread)
71*b1cdbd2cSJim Jagielski return sal_False;
72*b1cdbd2cSJim Jagielski
73*b1cdbd2cSJim Jagielski m_hThread = osl_createSuspendedThread( threadFunc, (void*)this);
74*b1cdbd2cSJim Jagielski if ( m_hThread )
75*b1cdbd2cSJim Jagielski osl_resumeThread(m_hThread);
76*b1cdbd2cSJim Jagielski
77*b1cdbd2cSJim Jagielski return m_hThread != 0;
78*b1cdbd2cSJim Jagielski }
79*b1cdbd2cSJim Jagielski
createSuspended()80*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL createSuspended()
81*b1cdbd2cSJim Jagielski {
82*b1cdbd2cSJim Jagielski OSL_ASSERT(m_hThread == 0); // only one running thread per instance
83*b1cdbd2cSJim Jagielski if( m_hThread)
84*b1cdbd2cSJim Jagielski return sal_False;
85*b1cdbd2cSJim Jagielski m_hThread= osl_createSuspendedThread( threadFunc,
86*b1cdbd2cSJim Jagielski (void*)this);
87*b1cdbd2cSJim Jagielski return m_hThread != 0;
88*b1cdbd2cSJim Jagielski }
89*b1cdbd2cSJim Jagielski
suspend()90*b1cdbd2cSJim Jagielski virtual void SAL_CALL suspend()
91*b1cdbd2cSJim Jagielski {
92*b1cdbd2cSJim Jagielski if( m_hThread )
93*b1cdbd2cSJim Jagielski osl_suspendThread(m_hThread);
94*b1cdbd2cSJim Jagielski }
95*b1cdbd2cSJim Jagielski
resume()96*b1cdbd2cSJim Jagielski virtual void SAL_CALL resume()
97*b1cdbd2cSJim Jagielski {
98*b1cdbd2cSJim Jagielski if( m_hThread )
99*b1cdbd2cSJim Jagielski osl_resumeThread(m_hThread);
100*b1cdbd2cSJim Jagielski }
101*b1cdbd2cSJim Jagielski
terminate()102*b1cdbd2cSJim Jagielski virtual void SAL_CALL terminate()
103*b1cdbd2cSJim Jagielski {
104*b1cdbd2cSJim Jagielski if( m_hThread )
105*b1cdbd2cSJim Jagielski osl_terminateThread(m_hThread);
106*b1cdbd2cSJim Jagielski }
107*b1cdbd2cSJim Jagielski
join()108*b1cdbd2cSJim Jagielski virtual void SAL_CALL join()
109*b1cdbd2cSJim Jagielski {
110*b1cdbd2cSJim Jagielski osl_joinWithThread(m_hThread);
111*b1cdbd2cSJim Jagielski }
112*b1cdbd2cSJim Jagielski
isRunning() const113*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL isRunning() const
114*b1cdbd2cSJim Jagielski {
115*b1cdbd2cSJim Jagielski return osl_isThreadRunning(m_hThread);
116*b1cdbd2cSJim Jagielski }
117*b1cdbd2cSJim Jagielski
setPriority(oslThreadPriority Priority)118*b1cdbd2cSJim Jagielski void SAL_CALL setPriority( oslThreadPriority Priority)
119*b1cdbd2cSJim Jagielski {
120*b1cdbd2cSJim Jagielski if( m_hThread )
121*b1cdbd2cSJim Jagielski osl_setThreadPriority(m_hThread, Priority);
122*b1cdbd2cSJim Jagielski }
123*b1cdbd2cSJim Jagielski
getPriority() const124*b1cdbd2cSJim Jagielski oslThreadPriority SAL_CALL getPriority() const
125*b1cdbd2cSJim Jagielski {
126*b1cdbd2cSJim Jagielski return m_hThread ? osl_getThreadPriority(m_hThread) : osl_Thread_PriorityUnknown;
127*b1cdbd2cSJim Jagielski }
128*b1cdbd2cSJim Jagielski
getIdentifier() const129*b1cdbd2cSJim Jagielski oslThreadIdentifier SAL_CALL getIdentifier() const
130*b1cdbd2cSJim Jagielski {
131*b1cdbd2cSJim Jagielski return osl_getThreadIdentifier(m_hThread);
132*b1cdbd2cSJim Jagielski }
133*b1cdbd2cSJim Jagielski
getCurrentIdentifier()134*b1cdbd2cSJim Jagielski static oslThreadIdentifier SAL_CALL getCurrentIdentifier()
135*b1cdbd2cSJim Jagielski {
136*b1cdbd2cSJim Jagielski return osl_getThreadIdentifier(0);
137*b1cdbd2cSJim Jagielski }
138*b1cdbd2cSJim Jagielski
wait(const TimeValue & Delay)139*b1cdbd2cSJim Jagielski static void SAL_CALL wait(const TimeValue& Delay)
140*b1cdbd2cSJim Jagielski {
141*b1cdbd2cSJim Jagielski osl_waitThread(&Delay);
142*b1cdbd2cSJim Jagielski }
143*b1cdbd2cSJim Jagielski
yield()144*b1cdbd2cSJim Jagielski static void SAL_CALL yield()
145*b1cdbd2cSJim Jagielski {
146*b1cdbd2cSJim Jagielski osl_yieldThread();
147*b1cdbd2cSJim Jagielski }
148*b1cdbd2cSJim Jagielski
setName(char const * name)149*b1cdbd2cSJim Jagielski static inline void setName(char const * name) throw () {
150*b1cdbd2cSJim Jagielski osl_setThreadName(name);
151*b1cdbd2cSJim Jagielski }
152*b1cdbd2cSJim Jagielski
schedule()153*b1cdbd2cSJim Jagielski virtual sal_Bool SAL_CALL schedule()
154*b1cdbd2cSJim Jagielski {
155*b1cdbd2cSJim Jagielski return m_hThread ? osl_scheduleThread(m_hThread) : sal_False;
156*b1cdbd2cSJim Jagielski }
157*b1cdbd2cSJim Jagielski
operator oslThread() const158*b1cdbd2cSJim Jagielski SAL_CALL operator oslThread() const
159*b1cdbd2cSJim Jagielski {
160*b1cdbd2cSJim Jagielski return m_hThread;
161*b1cdbd2cSJim Jagielski }
162*b1cdbd2cSJim Jagielski
163*b1cdbd2cSJim Jagielski protected:
164*b1cdbd2cSJim Jagielski
165*b1cdbd2cSJim Jagielski /** The thread functions calls the protected functions
166*b1cdbd2cSJim Jagielski run and onTerminated.
167*b1cdbd2cSJim Jagielski */
168*b1cdbd2cSJim Jagielski friend void SAL_CALL threadFunc( void* param);
169*b1cdbd2cSJim Jagielski
170*b1cdbd2cSJim Jagielski virtual void SAL_CALL run() = 0;
171*b1cdbd2cSJim Jagielski
onTerminated()172*b1cdbd2cSJim Jagielski virtual void SAL_CALL onTerminated()
173*b1cdbd2cSJim Jagielski {
174*b1cdbd2cSJim Jagielski }
175*b1cdbd2cSJim Jagielski
176*b1cdbd2cSJim Jagielski private:
177*b1cdbd2cSJim Jagielski oslThread m_hThread;
178*b1cdbd2cSJim Jagielski };
179*b1cdbd2cSJim Jagielski
threadFunc(void * param)180*b1cdbd2cSJim Jagielski extern "C" inline void SAL_CALL threadFunc( void* param)
181*b1cdbd2cSJim Jagielski {
182*b1cdbd2cSJim Jagielski Thread* pObj= (Thread*)param;
183*b1cdbd2cSJim Jagielski pObj->run();
184*b1cdbd2cSJim Jagielski pObj->onTerminated();
185*b1cdbd2cSJim Jagielski }
186*b1cdbd2cSJim Jagielski
187*b1cdbd2cSJim Jagielski class ThreadData
188*b1cdbd2cSJim Jagielski {
189*b1cdbd2cSJim Jagielski ThreadData( const ThreadData& );
190*b1cdbd2cSJim Jagielski ThreadData& operator= (const ThreadData& );
191*b1cdbd2cSJim Jagielski public:
192*b1cdbd2cSJim Jagielski /// Create a thread specific local data key
ThreadData(oslThreadKeyCallbackFunction pCallback=0)193*b1cdbd2cSJim Jagielski ThreadData( oslThreadKeyCallbackFunction pCallback= 0 )
194*b1cdbd2cSJim Jagielski {
195*b1cdbd2cSJim Jagielski m_hKey = osl_createThreadKey( pCallback );
196*b1cdbd2cSJim Jagielski }
197*b1cdbd2cSJim Jagielski
198*b1cdbd2cSJim Jagielski /// Destroy a thread specific local data key
~ThreadData()199*b1cdbd2cSJim Jagielski ~ThreadData()
200*b1cdbd2cSJim Jagielski {
201*b1cdbd2cSJim Jagielski osl_destroyThreadKey(m_hKey);
202*b1cdbd2cSJim Jagielski }
203*b1cdbd2cSJim Jagielski
204*b1cdbd2cSJim Jagielski /** Set the data associated with the data key.
205*b1cdbd2cSJim Jagielski @returns True if operation was successfull
206*b1cdbd2cSJim Jagielski */
setData(void * pData)207*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL setData(void *pData)
208*b1cdbd2cSJim Jagielski {
209*b1cdbd2cSJim Jagielski return (osl_setThreadKeyData(m_hKey, pData));
210*b1cdbd2cSJim Jagielski }
211*b1cdbd2cSJim Jagielski
212*b1cdbd2cSJim Jagielski /** Get the data associated with the data key.
213*b1cdbd2cSJim Jagielski @returns The data asscoitaed with the data key or
214*b1cdbd2cSJim Jagielski NULL if no data was set
215*b1cdbd2cSJim Jagielski */
getData()216*b1cdbd2cSJim Jagielski void* SAL_CALL getData()
217*b1cdbd2cSJim Jagielski {
218*b1cdbd2cSJim Jagielski return osl_getThreadKeyData(m_hKey);
219*b1cdbd2cSJim Jagielski }
220*b1cdbd2cSJim Jagielski
operator oslThreadKey() const221*b1cdbd2cSJim Jagielski operator oslThreadKey() const
222*b1cdbd2cSJim Jagielski {
223*b1cdbd2cSJim Jagielski return m_hKey;
224*b1cdbd2cSJim Jagielski }
225*b1cdbd2cSJim Jagielski
226*b1cdbd2cSJim Jagielski private:
227*b1cdbd2cSJim Jagielski oslThreadKey m_hKey;
228*b1cdbd2cSJim Jagielski };
229*b1cdbd2cSJim Jagielski
230*b1cdbd2cSJim Jagielski } // end namespace osl
231*b1cdbd2cSJim Jagielski #endif
232*b1cdbd2cSJim Jagielski #endif
233