Home | History | Annotate | Download | only in wtf
      1 /*
      2  * Copyright (C) 2007, 2008, 2010 Apple Inc. All rights reserved.
      3  * Copyright (C) 2007 Justin Haygood (jhaygood (at) reaktix.com)
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions
      7  * are met:
      8  *
      9  * 1.  Redistributions of source code must retain the above copyright
     10  *     notice, this list of conditions and the following disclaimer.
     11  * 2.  Redistributions in binary form must reproduce the above copyright
     12  *     notice, this list of conditions and the following disclaimer in the
     13  *     documentation and/or other materials provided with the distribution.
     14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
     15  *     its contributors may be used to endorse or promote products derived
     16  *     from this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
     19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
     22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
     25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     28  */
     29 
     30 #ifndef Threading_h
     31 #define Threading_h
     32 
     33 #include "wtf/WTFExport.h"
     34 #include <stdint.h>
     35 
     36 // For portability, we do not use thread-safe statics natively supported by some compilers (e.g. gcc).
     37 #define AtomicallyInitializedStatic(T, name) \
     38     WTF::lockAtomicallyInitializedStaticMutex(); \
     39     static T name; \
     40     WTF::unlockAtomicallyInitializedStaticMutex();
     41 
     42 namespace WTF {
     43 
     44 typedef uint32_t ThreadIdentifier;
     45 typedef void (*ThreadFunction)(void* argument);
     46 
     47 // Returns 0 if thread creation failed.
     48 // The thread name must be a literal since on some platforms it's passed in to the thread.
     49 WTF_EXPORT ThreadIdentifier createThread(ThreadFunction, void*, const char* threadName);
     50 
     51 // Internal platform-specific createThread implementation.
     52 WTF_EXPORT ThreadIdentifier createThreadInternal(ThreadFunction, void*, const char* threadName);
     53 
     54 // Called in the thread during initialization.
     55 // Helpful for platforms where the thread name must be set from within the thread.
     56 WTF_EXPORT void initializeCurrentThreadInternal(const char* threadName);
     57 
     58 WTF_EXPORT ThreadIdentifier currentThread();
     59 WTF_EXPORT int waitForThreadCompletion(ThreadIdentifier);
     60 WTF_EXPORT void detachThread(ThreadIdentifier);
     61 
     62 WTF_EXPORT void yield();
     63 
     64 WTF_EXPORT void lockAtomicallyInitializedStaticMutex();
     65 WTF_EXPORT void unlockAtomicallyInitializedStaticMutex();
     66 
     67 } // namespace WTF
     68 
     69 using WTF::ThreadIdentifier;
     70 using WTF::createThread;
     71 using WTF::currentThread;
     72 using WTF::detachThread;
     73 using WTF::waitForThreadCompletion;
     74 using WTF::yield;
     75 
     76 #endif // Threading_h
     77