ThreadingPthreads.cpp 9.3 KB
Newer Older
andersca's avatar
andersca committed
1
/*
2
 * Copyright (C) 2007, 2009 Apple Inc. All rights reserved.
3
 * Copyright (C) 2007 Justin Haygood (jhaygood@reaktix.com)
andersca's avatar
andersca committed
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer. 
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution. 
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission. 
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
29

andersca's avatar
andersca committed
30
31
32
#include "config.h"
#include "Threading.h"

33
34
#if USE(PTHREADS)

35
#include "CurrentTime.h"
ap@webkit.org's avatar
ap@webkit.org committed
36
37
#include "HashMap.h"
#include "MainThread.h"
38
#include "RandomNumberSeed.h"
39
40
#include "StdLibExtras.h"
#include "UnusedParam.h"
bdash's avatar
bdash committed
41
#include <errno.h>
42
#include <limits.h>
43
#include <sys/time.h>
bdash's avatar
bdash committed
44

45
46
47
48
#if PLATFORM(ANDROID)
#include "jni_utility.h"
#endif

49
namespace WTF {
andersca's avatar
andersca committed
50

dimich@chromium.org's avatar
dimich@chromium.org committed
51
typedef HashMap<ThreadIdentifier, pthread_t> ThreadMap;
52

53
static Mutex* atomicallyInitializedStaticMutex;
ap@webkit.org's avatar
ap@webkit.org committed
54

55
#if !PLATFORM(DARWIN) || PLATFORM(CHROMIUM)
ap@webkit.org's avatar
ap@webkit.org committed
56
57
static ThreadIdentifier mainThreadIdentifier; // The thread that was the first to call initializeThreading(), which must be the main thread.
#endif
aroben@apple.com's avatar
aroben@apple.com committed
58

dimich@chromium.org's avatar
dimich@chromium.org committed
59
60
61
62
63
64
static Mutex& threadMapMutex()
{
    DEFINE_STATIC_LOCAL(Mutex, mutex, ());
    return mutex;
}

ap@webkit.org's avatar
ap@webkit.org committed
65
66
67
68
void initializeThreading()
{
    if (!atomicallyInitializedStaticMutex) {
        atomicallyInitializedStaticMutex = new Mutex;
dimich@chromium.org's avatar
dimich@chromium.org committed
69
        threadMapMutex();
70
        initializeRandomNumberGenerator();
71
#if !PLATFORM(DARWIN) || PLATFORM(CHROMIUM)
aroben@apple.com's avatar
aroben@apple.com committed
72
        mainThreadIdentifier = currentThread();
ap@webkit.org's avatar
ap@webkit.org committed
73
74
#endif
        initializeMainThread();
ap@webkit.org's avatar
ap@webkit.org committed
75
76
77
    }
}

78
79
80
81
82
83
84
85
86
87
88
void lockAtomicallyInitializedStaticMutex()
{
    ASSERT(atomicallyInitializedStaticMutex);
    atomicallyInitializedStaticMutex->lock();
}

void unlockAtomicallyInitializedStaticMutex()
{
    atomicallyInitializedStaticMutex->unlock();
}

dimich@chromium.org's avatar
dimich@chromium.org committed
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
static ThreadMap& threadMap()
{
    DEFINE_STATIC_LOCAL(ThreadMap, map, ());
    return map;
}

static ThreadIdentifier identifierByPthreadHandle(const pthread_t& pthreadHandle)
{
    MutexLocker locker(threadMapMutex());

    ThreadMap::iterator i = threadMap().begin();
    for (; i != threadMap().end(); ++i) {
        if (pthread_equal(i->second, pthreadHandle))
            return i->first;
    }

    return 0;
}

static ThreadIdentifier establishIdentifierForPthreadHandle(pthread_t& pthreadHandle)
{
    ASSERT(!identifierByPthreadHandle(pthreadHandle));

    MutexLocker locker(threadMapMutex());

    static ThreadIdentifier identifierCount = 1;

    threadMap().add(identifierCount, pthreadHandle);

    return identifierCount++;
}

static pthread_t pthreadHandleForIdentifier(ThreadIdentifier id)
{
    MutexLocker locker(threadMapMutex());

    return threadMap().get(id);
}

static void clearPthreadHandleForIdentifier(ThreadIdentifier id)
{
    MutexLocker locker(threadMapMutex());

    ASSERT(threadMap().contains(id));

    threadMap().remove(id);
}

137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
#if PLATFORM(ANDROID)
// On the Android platform, threads must be registered with the VM before they run.
struct ThreadData {
    ThreadFunction entryPoint;
    void* arg;
};

static void* runThreadWithRegistration(void* arg)
{
    ThreadData* data = static_cast<ThreadData*>(arg);
    JavaVM* vm = JSC::Bindings::getJavaVM();
    JNIEnv* env;
    void* ret = 0;
    if (vm->AttachCurrentThread(&env, 0) == JNI_OK) {
        ret = data->entryPoint(data->arg);
        vm->DetachCurrentThread();
    }
    delete data;
    return ret;
}

ThreadIdentifier createThreadInternal(ThreadFunction entryPoint, void* data, const char*)
{
    pthread_t threadHandle;
    ThreadData* threadData = new ThreadData();
    threadData->entryPoint = entryPoint;
    threadData->arg = data;

    if (pthread_create(&threadHandle, 0, runThreadWithRegistration, static_cast<void*>(threadData))) {
        LOG_ERROR("Failed to create pthread at entry point %p with data %p", entryPoint, data);
dimich@chromium.org's avatar
dimich@chromium.org committed
167
        return 0;
168
    }
dimich@chromium.org's avatar
dimich@chromium.org committed
169
    return establishIdentifierForPthreadHandle(threadHandle);
170
171
}
#else
172
ThreadIdentifier createThreadInternal(ThreadFunction entryPoint, void* data, const char*)
andersca's avatar
andersca committed
173
174
{
    pthread_t threadHandle;
175
    if (pthread_create(&threadHandle, 0, entryPoint, data)) {
andersca's avatar
andersca committed
176
        LOG_ERROR("Failed to create pthread at entry point %p with data %p", entryPoint, data);
dimich@chromium.org's avatar
dimich@chromium.org committed
177
        return 0;
andersca's avatar
andersca committed
178
179
    }

dimich@chromium.org's avatar
dimich@chromium.org committed
180
    return establishIdentifierForPthreadHandle(threadHandle);
andersca's avatar
andersca committed
181
}
182
#endif
andersca's avatar
andersca committed
183

184
185
void setThreadNameInternal(const char* threadName)
{
186
#if PLATFORM(DARWIN) && !defined(BUILDING_ON_TIGER) && !defined(BUILDING_ON_LEOPARD) && !PLATFORM(IPHONE)
187
188
189
190
191
192
    pthread_setname_np(threadName);
#else
    UNUSED_PARAM(threadName);
#endif
}

andersca's avatar
andersca committed
193
194
int waitForThreadCompletion(ThreadIdentifier threadID, void** result)
{
dimich@chromium.org's avatar
dimich@chromium.org committed
195
196
197
198
    ASSERT(threadID);

    pthread_t pthreadHandle = pthreadHandleForIdentifier(threadID);

andersca's avatar
andersca committed
199
200
    int joinResult = pthread_join(pthreadHandle, result);
    if (joinResult == EDEADLK)
dimich@chromium.org's avatar
dimich@chromium.org committed
201
202
203
        LOG_ERROR("ThreadIdentifier %u was found to be deadlocked trying to quit", threadID);

    clearPthreadHandleForIdentifier(threadID);
andersca's avatar
andersca committed
204
205
206
207
208
    return joinResult;
}

void detachThread(ThreadIdentifier threadID)
{
dimich@chromium.org's avatar
dimich@chromium.org committed
209
210
211
212
    ASSERT(threadID);

    pthread_t pthreadHandle = pthreadHandleForIdentifier(threadID);

andersca's avatar
andersca committed
213
    pthread_detach(pthreadHandle);
dimich@chromium.org's avatar
dimich@chromium.org committed
214
215

    clearPthreadHandleForIdentifier(threadID);
andersca's avatar
andersca committed
216
217
}

218
219
ThreadIdentifier currentThread()
{
dimich@chromium.org's avatar
dimich@chromium.org committed
220
221
222
223
    pthread_t currentThread = pthread_self();
    if (ThreadIdentifier id = identifierByPthreadHandle(currentThread))
        return id;
    return establishIdentifierForPthreadHandle(currentThread);
224
225
}

aroben@apple.com's avatar
aroben@apple.com committed
226
227
bool isMainThread()
{
228
#if PLATFORM(DARWIN) && !PLATFORM(CHROMIUM)
ap@webkit.org's avatar
ap@webkit.org committed
229
230
    return pthread_main_np();
#else
aroben@apple.com's avatar
aroben@apple.com committed
231
    return currentThread() == mainThreadIdentifier;
ap@webkit.org's avatar
ap@webkit.org committed
232
#endif
aroben@apple.com's avatar
aroben@apple.com committed
233
234
}

andersca's avatar
andersca committed
235
236
237
238
239
240
241
242
243
244
245
246
Mutex::Mutex()
{
    pthread_mutex_init(&m_mutex, NULL);
}

Mutex::~Mutex()
{
    pthread_mutex_destroy(&m_mutex);
}

void Mutex::lock()
{
ap@webkit.org's avatar
ap@webkit.org committed
247
248
    int result = pthread_mutex_lock(&m_mutex);
    ASSERT_UNUSED(result, !result);
andersca's avatar
andersca committed
249
}
dimich@chromium.org's avatar
dimich@chromium.org committed
250

andersca's avatar
andersca committed
251
252
253
bool Mutex::tryLock()
{
    int result = pthread_mutex_trylock(&m_mutex);
dimich@chromium.org's avatar
dimich@chromium.org committed
254

andersca's avatar
andersca committed
255
256
    if (result == 0)
        return true;
ap@webkit.org's avatar
ap@webkit.org committed
257
    if (result == EBUSY)
andersca's avatar
andersca committed
258
259
        return false;

ap@webkit.org's avatar
ap@webkit.org committed
260
    ASSERT_NOT_REACHED();
andersca's avatar
andersca committed
261
262
263
264
265
    return false;
}

void Mutex::unlock()
{
ap@webkit.org's avatar
ap@webkit.org committed
266
267
    int result = pthread_mutex_unlock(&m_mutex);
    ASSERT_UNUSED(result, !result);
andersca's avatar
andersca committed
268
}
269

270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324

ReadWriteLock::ReadWriteLock()
{
    pthread_rwlock_init(&m_readWriteLock, NULL);
}

ReadWriteLock::~ReadWriteLock()
{
    pthread_rwlock_destroy(&m_readWriteLock);
}

void ReadWriteLock::readLock()
{
    int result = pthread_rwlock_rdlock(&m_readWriteLock);
    ASSERT_UNUSED(result, !result);
}

bool ReadWriteLock::tryReadLock()
{
    int result = pthread_rwlock_tryrdlock(&m_readWriteLock);

    if (result == 0)
        return true;
    if (result == EBUSY || result == EAGAIN)
        return false;

    ASSERT_NOT_REACHED();
    return false;
}

void ReadWriteLock::writeLock()
{
    int result = pthread_rwlock_wrlock(&m_readWriteLock);
    ASSERT_UNUSED(result, !result);
}

bool ReadWriteLock::tryWriteLock()
{
    int result = pthread_rwlock_trywrlock(&m_readWriteLock);

    if (result == 0)
        return true;
    if (result == EBUSY || result == EAGAIN)
        return false;

    ASSERT_NOT_REACHED();
    return false;
}

void ReadWriteLock::unlock()
{
    int result = pthread_rwlock_unlock(&m_readWriteLock);
    ASSERT_UNUSED(result, !result);
}

andersca's avatar
andersca committed
325
326
327
328
329
330
331
332
333
334
335
336
ThreadCondition::ThreadCondition()
{ 
    pthread_cond_init(&m_condition, NULL);
}

ThreadCondition::~ThreadCondition()
{
    pthread_cond_destroy(&m_condition);
}
    
void ThreadCondition::wait(Mutex& mutex)
{
ap@webkit.org's avatar
ap@webkit.org committed
337
338
    int result = pthread_cond_wait(&m_condition, &mutex.impl());
    ASSERT_UNUSED(result, !result);
andersca's avatar
andersca committed
339
}
beidson@apple.com's avatar
beidson@apple.com committed
340

341
bool ThreadCondition::timedWait(Mutex& mutex, double absoluteTime)
beidson@apple.com's avatar
beidson@apple.com committed
342
{
343
344
345
346
    if (absoluteTime < currentTime())
        return false;

    if (absoluteTime > INT_MAX) {
beidson@apple.com's avatar
beidson@apple.com committed
347
348
349
        wait(mutex);
        return true;
    }
350

351
352
    int timeSeconds = static_cast<int>(absoluteTime);
    int timeNanoseconds = static_cast<int>((absoluteTime - timeSeconds) * 1E9);
353

beidson@apple.com's avatar
beidson@apple.com committed
354
    timespec targetTime;
355
356
    targetTime.tv_sec = timeSeconds;
    targetTime.tv_nsec = timeNanoseconds;
beidson@apple.com's avatar
beidson@apple.com committed
357
358
359
360

    return pthread_cond_timedwait(&m_condition, &mutex.impl(), &targetTime) == 0;
}

andersca's avatar
andersca committed
361
362
void ThreadCondition::signal()
{
ap@webkit.org's avatar
ap@webkit.org committed
363
364
    int result = pthread_cond_signal(&m_condition);
    ASSERT_UNUSED(result, !result);
andersca's avatar
andersca committed
365
366
367
368
}

void ThreadCondition::broadcast()
{
ap@webkit.org's avatar
ap@webkit.org committed
369
370
    int result = pthread_cond_broadcast(&m_condition);
    ASSERT_UNUSED(result, !result);
andersca's avatar
andersca committed
371
}
dimich@chromium.org's avatar
dimich@chromium.org committed
372

373
} // namespace WTF
374
375

#endif // USE(PTHREADS)