/*

 * Copyright (C) 2007, 2008, 2010 Apple Inc. All rights reserved.

 * Copyright (C) 2007 Justin Haygood (jhaygood@reaktix.com)

 *

 * 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.

 *

 *

 * Note: The implementations of InterlockedIncrement and InterlockedDecrement are based

 * on atomic_increment and atomic_exchange_and_add from the Boost C++ Library. The license

 * is virtually identical to the Apple license above but is included here for completeness.

 *

 * Boost Software License - Version 1.0 - August 17th, 2003

 * 

 * Permission is hereby granted, free of charge, to any person or organization

 * obtaining a copy of the software and accompanying documentation covered by

 * this license (the "Software") to use, reproduce, display, distribute,

 * execute, and transmit the Software, and to prepare derivative works of the

 * Software, and to permit third-parties to whom the Software is furnished to

 * do so, all subject to the following:

 * 

 * The copyright notices in the Software and this entire statement, including

 * the above license grant, this restriction and the following disclaimer,

 * must be included in all copies of the Software, in whole or in part, and

 * all derivative works of the Software, unless such copies or derivative

 * works are solely in the form of machine-executable object code generated by

 * a source language processor.

 * 

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT

 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE

 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,

 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

 * DEALINGS IN THE SOFTWARE.

 */

#ifndef Threading_h

#define Threading_h

#include "Platform.h"

#include <stdint.h>

#include <wtf/Assertions.h>

#include <wtf/Atomics.h>

#include <wtf/Locker.h>

#include <wtf/MainThread.h>

#include <wtf/Noncopyable.h>

#include <wtf/ThreadSafeShared.h>

#include <wtf/ThreadingPrimitives.h>

// For portability, we do not use thread-safe statics natively supported by some compilers (e.g. gcc).

#define AtomicallyInitializedStatic(T, name) \

    WTF::lockAtomicallyInitializedStaticMutex(); \

    static T name; \

    WTF::unlockAtomicallyInitializedStaticMutex();

namespace WTF {

typedef uint32_t ThreadIdentifier;

typedef void* (*ThreadFunction)(void* argument);

// This function must be called from the main thread. It is safe to call it repeatedly.

// Darwin is an exception to this rule: it is OK to call it from any thread, the only 

// requirement is that the calls are not reentrant.

void initializeThreading();

// Returns 0 if thread creation failed.

// The thread name must be a literal since on some platforms it's passed in to the thread.

ThreadIdentifier createThread(ThreadFunction, void*, const char* threadName);

// Internal platform-specific createThread implementation.

ThreadIdentifier createThreadInternal(ThreadFunction, void*, const char* threadName);

// Called in the thread during initialization.

// Helpful for platforms where the thread name must be set from within the thread.

void initializeCurrentThreadInternal(const char* threadName);

ThreadIdentifier currentThread();

int waitForThreadCompletion(ThreadIdentifier, void**);

void detachThread(ThreadIdentifier);

void lockAtomicallyInitializedStaticMutex();

void unlockAtomicallyInitializedStaticMutex();

} // namespace WTF

using WTF::ThreadIdentifier;

using WTF::createThread;

using WTF::currentThread;

using WTF::detachThread;

using WTF::waitForThreadCompletion;

#endif // Threading_h