dart::OSThread Class Reference

#include <os_thread.h>

Inheritance diagram for dart::OSThread:

Public Types
typedef void(*	ThreadStartFunction) (uword parameter)
typedef void(*	ThreadDestructor) (void *parameter)

Public Member Functions
	~OSThread ()
ThreadId	id () const
const char *	name () const
void	SetName (const char *name)
Mutex *	timeline_block_lock () const
TimelineEventBlock *	TimelineBlockLocked () const
void	SetTimelineBlockLocked (TimelineEventBlock *block)
Log *	log () const
uword	stack_base () const
uword	stack_limit () const
uword	overflow_stack_limit () const
bool	HasStackHeadroom ()
bool	HasStackHeadroom (intptr_t headroom)
void	DisableThreadInterrupts ()
void	EnableThreadInterrupts ()
bool	ThreadInterruptsEnabled ()
Public Member Functions inherited from dart::BaseThread
bool	is_os_thread () const

Static Public Member Functions
static OSThread *	CreateOSThread ()
static bool	GetCurrentStackBounds (uword *lower, uword *upper)
static uword	GetCurrentStackPointer ()
static OSThread *	TryCurrent ()
static OSThread *	Current ()
static void	SetCurrent (OSThread *current)
static ThreadState *	CurrentVMThread ()
static uword	GetSpecifiedStackSize ()
static BaseThread *	GetCurrentTLS ()
static void	SetCurrentTLS (BaseThread *value)
static int	Start (const char *name, ThreadStartFunction function, uword parameter)
static ThreadLocalKey	CreateThreadLocal (ThreadDestructor destructor=nullptr)
static void	DeleteThreadLocal (ThreadLocalKey key)
static uword	GetThreadLocal (ThreadLocalKey key)
static ThreadId	GetCurrentThreadId ()
static void	SetThreadLocal (ThreadLocalKey key, uword value)
static intptr_t	GetMaxStackSize ()
static void	Join (ThreadJoinId id)
static intptr_t	ThreadIdToIntPtr (ThreadId id)
static ThreadId	ThreadIdFromIntPtr (intptr_t id)
static bool	Compare (ThreadId a, ThreadId b)
static ThreadJoinId	GetCurrentThreadJoinId (OSThread *thread)
static void	Init ()
static bool	IsThreadInList (ThreadId id)
static void	DisableOSThreadCreation ()
static void	EnableOSThreadCreation ()

Static Public Attributes
static const uword	kInvalidStackLimit = ~static_cast<uword>(0)
static constexpr intptr_t	kStackSizeBufferMax = (16 * KB * kWordSize)
static constexpr float	kStackSizeBufferFraction = 0.5
static const ThreadId	kInvalidThreadId
static const ThreadJoinId	kInvalidThreadJoinId

Friends
class	Thread
class	OSThreadIterator
class	ThreadInterrupterFuchsia
class	ThreadInterrupterMacOS
class	ThreadInterrupterWin
class	ThreadPool

Detailed Description

Definition at line 86 of file os_thread.h.

Member Typedef Documentation

ThreadDestructor

typedef void(* dart::OSThread::ThreadDestructor) (void *parameter)

Definition at line 206 of file os_thread.h.

ThreadStartFunction

typedef void(* dart::OSThread::ThreadStartFunction) (uword parameter)

Definition at line 205 of file os_thread.h.

Constructor & Destructor Documentation

~OSThread()

dart::OSThread::~OSThread

(

)

Definition at line 77 of file os_thread.cc.

                    {
  if (!is_os_thread()) {
    // If the embedder enters an isolate on this thread and does not exit the
    // isolate, the thread local at thread_key_, which we are destructing here,
    // will contain a dart::Thread instead of a dart::OSThread.
    FATAL("Thread exited without calling Dart_ExitIsolate");
  }
  RemoveThreadFromList(this);
  delete log_;
  log_ = nullptr;
#if defined(SUPPORT_TIMELINE)
  RecorderSynchronizationLockScope ls;
  TimelineEventRecorder* recorder = Timeline::recorder();
  if (recorder != nullptr && !ls.IsShuttingDown()) {
    // Acquire the recorder's lock so that |timeline_block_| cannot be given to
    // another thread until the call to |TimelineEventRecorder::FinishBlock| is
    // complete. This is guarded by a check ensuring that the recorder has not
    // yet been deleted, and thus ensuring that the recorder's lock can be
    // acquired. It is fine to skip the call to
    // |TimelineEventRecorder::FinishBlock| if the recorder has already been
    // deleted, because only the recorder cares about whether blocks have been
    // marked as finished.
    MutexLocker recorder_lock_locker(&Timeline::recorder()->lock_);
    MutexLocker timeline_block_lock_locker(timeline_block_lock());
    Timeline::recorder()->FinishBlock(timeline_block_);
  }
#endif
  timeline_block_ = nullptr;
  free(name_);
#if !defined(PRODUCT)
  if (prepared_for_interrupts_) {
    ThreadInterrupter::CleanupCurrentThreadState(thread_interrupter_state_);
    thread_interrupter_state_ = nullptr;
    prepared_for_interrupts_ = false;
  }
#endif  // !defined(PRODUCT)
}

Member Function Documentation

Compare()

static bool dart::OSThread::Compare ( ThreadId  a, ThreadId  b  )

static

CreateOSThread()

OSThread * dart::OSThread::CreateOSThread ( )

static

Definition at line 66 of file os_thread.cc.

                                   {
  ASSERT(thread_list_lock_ != nullptr);
  MutexLocker ml(thread_list_lock_);
  if (!creation_enabled_) {
    return nullptr;
  }
  OSThread* os_thread = new OSThread();
  AddThreadToListLocked(os_thread);
  return os_thread;
}

CreateThreadLocal()

static ThreadLocalKey dart::OSThread::CreateThreadLocal ( ThreadDestructor  destructor = nullptr )

static

Current()

static OSThread * dart::OSThread::Current ( )

inlinestatic

Definition at line 175 of file os_thread.h.

                             {
    OSThread* os_thread = TryCurrent();
    if (os_thread == nullptr) {
      os_thread = CreateAndSetUnknownThread();
    }
    return os_thread;
  }

CurrentVMThread()

static ThreadState * dart::OSThread::CurrentVMThread ( )

inlinestatic

Definition at line 184 of file os_thread.h.

{ return current_vm_thread_; }

DeleteThreadLocal()

static void dart::OSThread::DeleteThreadLocal ( ThreadLocalKey  key )

static

DisableOSThreadCreation()

void dart::OSThread::DisableOSThreadCreation ( )

static

Definition at line 247 of file os_thread.cc.

                                       {
  MutexLocker ml(thread_list_lock_);
  creation_enabled_ = false;
}

DisableThreadInterrupts()

void dart::OSThread::DisableThreadInterrupts

(

)

Definition at line 143 of file os_thread.cc.

                                       {
  ASSERT(OSThread::Current() == this);
  thread_interrupt_disabled_.fetch_add(1u);
}

EnableOSThreadCreation()

void dart::OSThread::EnableOSThreadCreation ( )

static

Definition at line 252 of file os_thread.cc.

                                      {
  MutexLocker ml(thread_list_lock_);
  creation_enabled_ = true;
}

EnableThreadInterrupts()

void dart::OSThread::EnableThreadInterrupts

(

)

Definition at line 148 of file os_thread.cc.

                                      {
  ASSERT(OSThread::Current() == this);
  uintptr_t old = thread_interrupt_disabled_.fetch_sub(1u);
  if (FLAG_profiler && (old == 1)) {
    // We just decremented from 1 to 0.
    // Make sure the thread interrupter is awake.
    if (!prepared_for_interrupts_) {
      thread_interrupter_state_ = ThreadInterrupter::PrepareCurrentThread();
      prepared_for_interrupts_ = true;
    }
    ThreadInterrupter::WakeUp();
  }
  if (old == 0) {
    // We just decremented from 0, this means we've got a mismatched pair
    // of calls to EnableThreadInterrupts and DisableThreadInterrupts.
    FATAL("Invalid call to OSThread::EnableThreadInterrupts()");
  }
}

GetCurrentStackBounds()

static bool dart::OSThread::GetCurrentStackBounds ( uword *  lower, uword *  upper  )

static

GetCurrentStackPointer()

DART_NOINLINE uword dart::OSThread::GetCurrentStackPointer ( )

static

Definition at line 132 of file os_thread.cc.

                                       {
#ifdef _MSC_VER
  return reinterpret_cast<uword>(_AddressOfReturnAddress());
#elif __GNUC__
  return reinterpret_cast<uword>(__builtin_frame_address(0));
#else
#error Unimplemented
#endif
}

GetCurrentThreadId()

static ThreadId dart::OSThread::GetCurrentThreadId ( )

static

GetCurrentThreadJoinId()

static ThreadJoinId dart::OSThread::GetCurrentThreadJoinId ( OSThread *  thread )

static

GetCurrentTLS()

static BaseThread * dart::OSThread::GetCurrentTLS ( )

inlinestatic

Definition at line 200 of file os_thread.h.

                                     {
    return reinterpret_cast<BaseThread*>(OSThread::GetThreadLocal(thread_key_));
  }

GetMaxStackSize()

static intptr_t dart::OSThread::GetMaxStackSize ( )

static

GetSpecifiedStackSize()

static uword dart::OSThread::GetSpecifiedStackSize ( )

inlinestatic

Definition at line 193 of file os_thread.h.

                                       {
    intptr_t headroom =
        OSThread::CalculateHeadroom(OSThread::GetMaxStackSize());
    ASSERT(headroom < OSThread::GetMaxStackSize());
    uword stack_size = OSThread::GetMaxStackSize() - headroom;
    return stack_size;
  }

GetThreadLocal()

static uword dart::OSThread::GetThreadLocal ( ThreadLocalKey  key )

inlinestatic

Definition at line 218 of file os_thread.h.

                                                  {
    return ThreadInlineImpl::GetThreadLocal(key);
  }

HasStackHeadroom() [1/2]

bool dart::OSThread::HasStackHeadroom ( )

inline

Definition at line 132 of file os_thread.h.

{ return HasStackHeadroom(stack_headroom_); }

HasStackHeadroom() [2/2]

bool dart::OSThread::HasStackHeadroom ( intptr_t  headroom )

inline

Definition at line 133 of file os_thread.h.

                                           {
    return GetCurrentStackPointer() > (stack_limit_ + headroom);
  }

id()

ThreadId dart::OSThread::id ( ) const

inline

Definition at line 96 of file os_thread.h.

                      {
    ASSERT(id_ != OSThread::kInvalidThreadId);
    return id_;
  }

Init()

void dart::OSThread::Init ( )

static

Definition at line 177 of file os_thread.cc.

                    {
  // Allocate the global OSThread lock.
  if (thread_list_lock_ == nullptr) {
    thread_list_lock_ = new Mutex();
  }
  ASSERT(thread_list_lock_ != nullptr);
 
  // Create the thread local key.
  if (thread_key_ == kUnsetThreadLocalKey) {
    thread_key_ = CreateThreadLocal(DeleteThread);
  }
  ASSERT(thread_key_ != kUnsetThreadLocalKey);
 
  // Enable creation of OSThread structures in the VM.
  EnableOSThreadCreation();
 
  // Create a new OSThread structure and set it as the TLS.
  OSThread* os_thread = CreateOSThread();
  ASSERT(os_thread != nullptr);
  OSThread::SetCurrent(os_thread);
  os_thread->SetName("Dart_Initialize");
}

IsThreadInList()

bool dart::OSThread::IsThreadInList ( ThreadId  id )

static

Definition at line 230 of file os_thread.cc.

                                         {
  if (id == OSThread::kInvalidThreadId) {
    return false;
  }
  OSThreadIterator it;
  while (it.HasNext()) {
    ASSERT(OSThread::thread_list_lock_->IsOwnedByCurrentThread());
    OSThread* t = it.Next();
    // An address test is not sufficient because the allocator may recycle
    // the address for another Thread. Test against the thread's id.
    if (t->id() == id) {
      return true;
    }
  }
  return false;
}

Join()

static void dart::OSThread::Join ( ThreadJoinId  id )

static

log()

Log * dart::OSThread::log ( ) const

inline

Definition at line 126 of file os_thread.h.

{ return log_; }

name()

const char * dart::OSThread::name ( ) const

inline

Definition at line 108 of file os_thread.h.

{ return name_; }

overflow_stack_limit()

uword dart::OSThread::overflow_stack_limit ( ) const

inline

Definition at line 130 of file os_thread.h.

{ return stack_limit_ + stack_headroom_; }

SetCurrent()

static void dart::OSThread::SetCurrent ( OSThread *  current )

inlinestatic

Definition at line 182 of file os_thread.h.

{ SetCurrentTLS(current); }

SetCurrentTLS()

void dart::OSThread::SetCurrentTLS ( BaseThread *  value )

static

Definition at line 318 of file os_thread.cc.

                                              {
  // Provides thread-local destructors.
  SetThreadLocal(thread_key_, reinterpret_cast<uword>(value));
 
  // Allows the C compiler more freedom to optimize.
  if ((value != nullptr) && !value->is_os_thread()) {
    current_vm_thread_ = static_cast<Thread*>(value);
  } else {
    current_vm_thread_ = nullptr;
  }
}

SetName()

void dart::OSThread::SetName

(

const char *

name

)

Definition at line 115 of file os_thread.cc.

                                       {
  MutexLocker ml(thread_list_lock_);
  // Clear the old thread name.
  if (name_ != nullptr) {
    free(name_);
    name_ = nullptr;
  }
  ASSERT(OSThread::Current() == this);
  ASSERT(name != nullptr);
  name_ = Utils::StrDup(name);
 
#if defined(SUPPORT_TIMELINE)
  UpdateTimelineTrackMetadata(*this);
#endif  // defined(SUPPORT_TIMELINE)
}

SetThreadLocal()

static void dart::OSThread::SetThreadLocal ( ThreadLocalKey  key, uword  value  )

static

SetTimelineBlockLocked()

void dart::OSThread::SetTimelineBlockLocked ( TimelineEventBlock *  block )

inline

Definition at line 121 of file os_thread.h.

                                                         {
    ASSERT(timeline_block_lock()->IsOwnedByCurrentThread());
    timeline_block_ = block;
  }

stack_base()

uword dart::OSThread::stack_base ( ) const

inline

Definition at line 128 of file os_thread.h.

{ return stack_base_; }

stack_limit()

uword dart::OSThread::stack_limit ( ) const

inline

Definition at line 129 of file os_thread.h.

{ return stack_limit_; }

Start()

static int dart::OSThread::Start ( const char *  name, ThreadStartFunction  function, uword  parameter  )

static

ThreadIdFromIntPtr()

static ThreadId dart::OSThread::ThreadIdFromIntPtr ( intptr_t  id )

static

ThreadIdToIntPtr()

static intptr_t dart::OSThread::ThreadIdToIntPtr ( ThreadId  id )

static

ThreadInterruptsEnabled()

bool dart::OSThread::ThreadInterruptsEnabled

(

)

Definition at line 167 of file os_thread.cc.

                                       {
  return thread_interrupt_disabled_ == 0;
}

timeline_block_lock()

Mutex * dart::OSThread::timeline_block_lock ( ) const

inline

Definition at line 112 of file os_thread.h.

{ return &timeline_block_lock_; }

TimelineBlockLocked()

TimelineEventBlock * dart::OSThread::TimelineBlockLocked ( ) const

inline

Definition at line 115 of file os_thread.h.

                                                  {
    ASSERT(timeline_block_lock()->IsOwnedByCurrentThread());
    return timeline_block_;
  }

TryCurrent()

static OSThread * dart::OSThread::TryCurrent ( )

inlinestatic

Definition at line 159 of file os_thread.h.

                                {
    BaseThread* thread = GetCurrentTLS();
    OSThread* os_thread = nullptr;
    if (thread != nullptr) {
      if (thread->is_os_thread()) {
        os_thread = reinterpret_cast<OSThread*>(thread);
      } else {
        ThreadState* vm_thread = reinterpret_cast<ThreadState*>(thread);
        os_thread = GetOSThreadFromThread(vm_thread);
      }
    }
    return os_thread;
  }

Friends And Related Symbol Documentation

OSThreadIterator

friend class OSThreadIterator

friend

Definition at line 332 of file os_thread.h.

Thread

friend class Thread

friend

Definition at line 331 of file os_thread.h.

ThreadInterrupterFuchsia

friend class ThreadInterrupterFuchsia

friend

Definition at line 333 of file os_thread.h.

ThreadInterrupterMacOS

friend class ThreadInterrupterMacOS

friend

Definition at line 334 of file os_thread.h.

ThreadInterrupterWin

friend class ThreadInterrupterWin

friend

Definition at line 335 of file os_thread.h.

ThreadPool

friend class ThreadPool

friend

Definition at line 336 of file os_thread.h.

Member Data Documentation

kInvalidStackLimit

const uword dart::OSThread::kInvalidStackLimit = ~static_cast<uword>(0)

static

Definition at line 88 of file os_thread.h.

kInvalidThreadId

const ThreadId dart::OSThread::kInvalidThreadId

static

Definition at line 244 of file os_thread.h.

kInvalidThreadJoinId

const ThreadJoinId dart::OSThread::kInvalidThreadJoinId

static

Definition at line 245 of file os_thread.h.

kStackSizeBufferFraction

constexpr float dart::OSThread::kStackSizeBufferFraction = 0.5

staticconstexpr

Definition at line 242 of file os_thread.h.

kStackSizeBufferMax

constexpr intptr_t dart::OSThread::kStackSizeBufferMax = (16 * KB * kWordSize)

staticconstexpr

Definition at line 241 of file os_thread.h.

---

The documentation for this class was generated from the following files:

• third_party/dart-lang/sdk/runtime/vm/os_thread.h
• third_party/dart-lang/sdk/runtime/vm/os_thread.cc