1f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org/* 2f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org * Copyright 2004 The WebRTC Project Authors. All rights reserved. 3f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org * 4f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org * Use of this source code is governed by a BSD-style license 5f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org * that can be found in the LICENSE file in the root of the source 6f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org * tree. An additional intellectual property rights grant can be found 7f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org * in the file PATENTS. All contributing project authors may 8f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org * be found in the AUTHORS file in the root of the source tree. 9f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org */ 10f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 11f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#ifndef WEBRTC_BASE_THREAD_H_ 12f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#define WEBRTC_BASE_THREAD_H_ 13f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 14f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#include <algorithm> 15f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#include <list> 16f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#include <string> 17f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#include <vector> 18f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 19f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#if defined(WEBRTC_POSIX) 20f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#include <pthread.h> 21f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#endif 22f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#include "webrtc/base/constructormagic.h" 23e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org#include "webrtc/base/event.h" 24f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#include "webrtc/base/messagequeue.h" 25f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 26f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#if defined(WEBRTC_WIN) 27f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#include "webrtc/base/win32.h" 28f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#endif 29f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 30f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.orgnamespace rtc { 31f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 32f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.orgclass Thread; 33f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 34f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.orgclass ThreadManager { 35f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org public: 3653d9012faf32eb711681fdeb31b9d0d2f9e9481bandresp@webrtc.org static const int kForever = -1; 3753d9012faf32eb711681fdeb31b9d0d2f9e9481bandresp@webrtc.org 38f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org ThreadManager(); 39f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org ~ThreadManager(); 40f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 41f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org static ThreadManager* Instance(); 42f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 43f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org Thread* CurrentThread(); 44f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org void SetCurrentThread(Thread* thread); 45f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 46f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // Returns a thread object with its thread_ ivar set 47f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // to whatever the OS uses to represent the thread. 48f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // If there already *is* a Thread object corresponding to this thread, 49f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // this method will return that. Otherwise it creates a new Thread 50f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // object whose wrapped() method will return true, and whose 51f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // handle will, on Win32, be opened with only synchronization privileges - 52f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // if you need more privilegs, rather than changing this method, please 53f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // write additional code to adjust the privileges, or call a different 54f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // factory method of your own devising, because this one gets used in 55f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // unexpected contexts (like inside browser plugins) and it would be a 56f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // shame to break it. It is also conceivable on Win32 that we won't even 57f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // be able to get synchronization privileges, in which case the result 58f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // will have a NULL handle. 59f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org Thread *WrapCurrentThread(); 60f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org void UnwrapCurrentThread(); 61f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 62f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org private: 63f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#if defined(WEBRTC_POSIX) 64f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org pthread_key_t key_; 65f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#endif 66f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 67f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#if defined(WEBRTC_WIN) 68f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org DWORD key_; 69f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#endif 70f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 713c089d751ede283e21e186885eaf705c3257ccd2henrikg RTC_DISALLOW_COPY_AND_ASSIGN(ThreadManager); 72f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org}; 73f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 74f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.orgstruct _SendMessage { 75f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org _SendMessage() {} 76f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org Thread *thread; 77f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org Message msg; 78f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org bool *ready; 79f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org}; 80f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 81f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.orgclass Runnable { 82f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org public: 83f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org virtual ~Runnable() {} 84f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org virtual void Run(Thread* thread) = 0; 85f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 86f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org protected: 87f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org Runnable() {} 88f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 89f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org private: 903c089d751ede283e21e186885eaf705c3257ccd2henrikg RTC_DISALLOW_COPY_AND_ASSIGN(Runnable); 91f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org}; 92f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 93f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org// WARNING! SUBCLASSES MUST CALL Stop() IN THEIR DESTRUCTORS! See ~Thread(). 94f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 95f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.orgclass Thread : public MessageQueue { 96f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org public: 97f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org explicit Thread(SocketServer* ss = NULL); 98f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // NOTE: ALL SUBCLASSES OF Thread MUST CALL Stop() IN THEIR DESTRUCTORS (or 99f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // guarantee Stop() is explicitly called before the subclass is destroyed). 100f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // This is required to avoid a data race between the destructor modifying the 101f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // vtable, and the Thread::PreRun calling the virtual method Run(). 10267186fe00cc68cbe03aa66d17fb4962458ca96d2kwiberg@webrtc.org ~Thread() override; 103f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 104f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org static Thread* Current(); 105f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 10692a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org // Used to catch performance regressions. Use this to disallow blocking calls 10792a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org // (Invoke) for a given scope. If a synchronous call is made while this is in 10892a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org // effect, an assert will be triggered. 10992a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org // Note that this is a single threaded class. 11092a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org class ScopedDisallowBlockingCalls { 11192a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org public: 11292a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org ScopedDisallowBlockingCalls(); 11392a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org ~ScopedDisallowBlockingCalls(); 11492a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org private: 11592a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org Thread* const thread_; 11692a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org const bool previous_state_; 11792a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org }; 11892a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org 119f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org bool IsCurrent() const { 120f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org return Current() == this; 121f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org } 122f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 123f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // Sleeps the calling thread for the specified number of milliseconds, during 124f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // which time no processing is performed. Returns false if sleeping was 125f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // interrupted by a signal (POSIX only). 126f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org static bool SleepMs(int millis); 127f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 128f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // Sets the thread's name, for debugging. Must be called before Start(). 129f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // If |obj| is non-NULL, its value is appended to |name|. 130f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org const std::string& name() const { return name_; } 131f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org bool SetName(const std::string& name, const void* obj); 132f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 133f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // Starts the execution of the thread. 134f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org bool Start(Runnable* runnable = NULL); 135f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 136f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // Tells the thread to stop and waits until it is joined. 137f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // Never call Stop on the current thread. Instead use the inherited Quit 138f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // function which will exit the base MessageQueue without terminating the 139f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // underlying OS thread. 140f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org virtual void Stop(); 141f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 142f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // By default, Thread::Run() calls ProcessMessages(kForever). To do other 143f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // work, override Run(). To receive and dispatch messages, call 144f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // ProcessMessages occasionally. 145f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org virtual void Run(); 146f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 1470c4e06b4c6107a1b94f764e279e4fb4161e905b0Peter Boström virtual void Send(MessageHandler* phandler, 1480c4e06b4c6107a1b94f764e279e4fb4161e905b0Peter Boström uint32_t id = 0, 1490c4e06b4c6107a1b94f764e279e4fb4161e905b0Peter Boström MessageData* pdata = NULL); 150f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 151f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // Convenience method to invoke a functor on another thread. Caller must 152f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // provide the |ReturnT| template argument, which cannot (easily) be deduced. 153f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // Uses Send() internally, which blocks the current thread until execution 154f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // is complete. 155f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // Ex: bool result = thread.Invoke<bool>(&MyFunctionReturningBool); 15692a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org // NOTE: This function can only be called when synchronous calls are allowed. 15792a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org // See ScopedDisallowBlockingCalls for details. 158f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org template <class ReturnT, class FunctorT> 159f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org ReturnT Invoke(const FunctorT& functor) { 1607c64ed2e0c55d6402ef24a822b18fc9e6cc11299tommi@webrtc.org InvokeBegin(); 161f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org FunctorMessageHandler<ReturnT, FunctorT> handler(functor); 162f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org Send(&handler); 1637c64ed2e0c55d6402ef24a822b18fc9e6cc11299tommi@webrtc.org InvokeEnd(); 164f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org return handler.result(); 165f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org } 166f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 167f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // From MessageQueue 16867186fe00cc68cbe03aa66d17fb4962458ca96d2kwiberg@webrtc.org void Clear(MessageHandler* phandler, 1690c4e06b4c6107a1b94f764e279e4fb4161e905b0Peter Boström uint32_t id = MQID_ANY, 17067186fe00cc68cbe03aa66d17fb4962458ca96d2kwiberg@webrtc.org MessageList* removed = NULL) override; 17167186fe00cc68cbe03aa66d17fb4962458ca96d2kwiberg@webrtc.org void ReceiveSends() override; 172f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 173f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // ProcessMessages will process I/O and dispatch messages until: 174f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // 1) cms milliseconds have elapsed (returns true) 175f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // 2) Stop() is called (returns false) 176f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org bool ProcessMessages(int cms); 177f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 178f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // Returns true if this is a thread that we created using the standard 179f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // constructor, false if it was created by a call to 180f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // ThreadManager::WrapCurrentThread(). The main thread of an application 181f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // is generally not owned, since the OS representation of the thread 182f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // obviously exists before we can get to it. 183f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // You cannot call Start on non-owned threads. 184f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org bool IsOwned(); 185f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 186f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#if defined(WEBRTC_WIN) 187f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org HANDLE GetHandle() const { 188f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org return thread_; 189f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org } 190f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org DWORD GetId() const { 191f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org return thread_id_; 192f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org } 193f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#elif defined(WEBRTC_POSIX) 194f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org pthread_t GetPThread() { 195f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org return thread_; 196f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org } 197f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#endif 198f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 199e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org // Expose private method running() for tests. 200e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org // 201e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org // DANGER: this is a terrible public API. Most callers that might want to 202e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org // call this likely do not have enough control/knowledge of the Thread in 203e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org // question to guarantee that the returned value remains true for the duration 204e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org // of whatever code is conditionally executing because of the return value! 205e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org bool RunningForTest() { return running(); } 206e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org 2073987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org // Sets the per-thread allow-blocking-calls flag and returns the previous 2087dfb7fa189701a57ad6399ad1472d6edd28b087cjiayl@webrtc.org // value. Must be called on this thread. 2093987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org bool SetAllowBlockingCalls(bool allow); 2103987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org 211e30dab77dfaf4a156b50c899246c3734152d11b2henrike@webrtc.org // These functions are public to avoid injecting test hooks. Don't call them 212e30dab77dfaf4a156b50c899246c3734152d11b2henrike@webrtc.org // outside of tests. 213ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org // This method should be called when thread is created using non standard 214ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org // method, like derived implementation of rtc::Thread and it can not be 215ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org // started by calling Start(). This will set started flag to true and 216ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org // owned to false. This must be called from the current thread. 217ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org bool WrapCurrent(); 218ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org void UnwrapCurrent(); 219ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org 220e30dab77dfaf4a156b50c899246c3734152d11b2henrike@webrtc.org protected: 221ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org // Same as WrapCurrent except that it never fails as it does not try to 222ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org // acquire the synchronization access of the thread. The caller should never 223ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org // call Stop() or Join() on this thread. 224ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org void SafeWrapCurrent(); 225ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org 226f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // Blocks the calling thread until this thread has terminated. 227f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org void Join(); 228f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 22992a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org static void AssertBlockingIsAllowedOnCurrentThread(); 23092a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org 23192a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org friend class ScopedDisallowBlockingCalls; 23292a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org 233f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org private: 234f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org static void *PreRun(void *pv); 235f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 236f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // ThreadManager calls this instead WrapCurrent() because 237f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // ThreadManager::Instance() cannot be used while ThreadManager is 238f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org // being created. 239ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org // The method tries to get synchronization rights of the thread on Windows if 240ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org // |need_synchronize_access| is true. 241ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org bool WrapCurrentWithThreadManager(ThreadManager* thread_manager, 242ba737cba1aa6607911b1ca10460423b4c3e51fb9jiayl@webrtc.org bool need_synchronize_access); 243f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 244e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org // Return true if the thread was started and hasn't yet stopped. 245e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org bool running() { return running_.Wait(0); } 246e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org 2473987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org // Processes received "Send" requests. If |source| is not NULL, only requests 2483987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org // from |source| are processed, otherwise, all requests are processed. 2493987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org void ReceiveSendsFromThread(const Thread* source); 2503987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org 2513987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org // If |source| is not NULL, pops the first "Send" message from |source| in 2523987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org // |sendlist_|, otherwise, pops the first "Send" message of |sendlist_|. 2533987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org // The caller must lock |crit_| before calling. 2543987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org // Returns true if there is such a message. 2553987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org bool PopSendMessageFromThread(const Thread* source, _SendMessage* msg); 2563987b6de506a7e72a5bdfdf8c8ad9964705c5a28jiayl@webrtc.org 2577c64ed2e0c55d6402ef24a822b18fc9e6cc11299tommi@webrtc.org // Used for tracking performance of Invoke calls. 2587c64ed2e0c55d6402ef24a822b18fc9e6cc11299tommi@webrtc.org void InvokeBegin(); 2597c64ed2e0c55d6402ef24a822b18fc9e6cc11299tommi@webrtc.org void InvokeEnd(); 2607c64ed2e0c55d6402ef24a822b18fc9e6cc11299tommi@webrtc.org 261f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org std::list<_SendMessage> sendlist_; 262f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org std::string name_; 263e5063b173303e9ee6c2246d2aa42a1480902b867fischman@webrtc.org Event running_; // Signalled means running. 264f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 265f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#if defined(WEBRTC_POSIX) 266f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org pthread_t thread_; 267f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#endif 268f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 269f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#if defined(WEBRTC_WIN) 270f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org HANDLE thread_; 271f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org DWORD thread_id_; 272f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#endif 273f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 274f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org bool owned_; 27592a9bacf9aeadf5f845bf464fdbc49e37b4ca21chenrike@webrtc.org bool blocking_calls_allowed_; // By default set to |true|. 276f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 277f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org friend class ThreadManager; 278f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 2793c089d751ede283e21e186885eaf705c3257ccd2henrikg RTC_DISALLOW_COPY_AND_ASSIGN(Thread); 280f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org}; 281f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 282f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org// AutoThread automatically installs itself at construction 283f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org// uninstalls at destruction, if a Thread object is 284f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org// _not already_ associated with the current OS thread. 285f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 286f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.orgclass AutoThread : public Thread { 287f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org public: 288f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org explicit AutoThread(SocketServer* ss = 0); 28967186fe00cc68cbe03aa66d17fb4962458ca96d2kwiberg@webrtc.org ~AutoThread() override; 290f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 291f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org private: 2923c089d751ede283e21e186885eaf705c3257ccd2henrikg RTC_DISALLOW_COPY_AND_ASSIGN(AutoThread); 293f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org}; 294f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 295f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org// Win32 extension for threads that need to use COM 296f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#if defined(WEBRTC_WIN) 297f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.orgclass ComThread : public Thread { 298f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org public: 299f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org ComThread() {} 300f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org virtual ~ComThread() { Stop(); } 301f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 302f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org protected: 303f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org virtual void Run(); 304f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 305f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org private: 3063c089d751ede283e21e186885eaf705c3257ccd2henrikg RTC_DISALLOW_COPY_AND_ASSIGN(ComThread); 307f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org}; 308f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#endif 309f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 310f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org// Provides an easy way to install/uninstall a socketserver on a thread. 311f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.orgclass SocketServerScope { 312f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org public: 313f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org explicit SocketServerScope(SocketServer* ss) { 314f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org old_ss_ = Thread::Current()->socketserver(); 315f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org Thread::Current()->set_socketserver(ss); 316f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org } 317f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org ~SocketServerScope() { 318f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org Thread::Current()->set_socketserver(old_ss_); 319f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org } 320f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 321f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org private: 322f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org SocketServer* old_ss_; 323f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 3243c089d751ede283e21e186885eaf705c3257ccd2henrikg RTC_DISALLOW_IMPLICIT_CONSTRUCTORS(SocketServerScope); 325f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org}; 326f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 327f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org} // namespace rtc 328f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org 329f048872e915a3ee229044ec4bc541f6cbf9e4de1henrike@webrtc.org#endif // WEBRTC_BASE_THREAD_H_ 330