strand.threadbase

The threadbase module provides OS-independent code for thread storage and management.

Members

Aliases

IsMarkedDg
alias IsMarkedDg = int delegate(void* addr) nothrow
Undocumented in source.
ScanAllThreadsFn
alias ScanAllThreadsFn = void delegate(void*, void*) nothrow
Undocumented in source.
ScanAllThreadsTypeFn
alias ScanAllThreadsTypeFn = void delegate(ScanType, void*, void*) nothrow
Undocumented in source.
callWithStackShellDg
alias callWithStackShellDg = void delegate(void* sp) nothrow
Undocumented in source.

Classes

SuppressTraceInfo
class SuppressTraceInfo
Undocumented in source.
ThreadBase
class ThreadBase

//////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////

ThreadError
class ThreadError

Base class for thread errors to be used for function inside GC when allocations are unavailable.

ThreadException
class ThreadException

Base class for thread exceptions.

Enums

IsMarked
enum IsMarked

Indicates whether an address has been marked by the GC.

ScanType
enum ScanType

Indicates the kind of scan being performed by thread_scanAllType.

Functions

_d_monitordelete_nogc
void _d_monitordelete_nogc(Object h)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
findLowLevelThread
bool findLowLevelThread(ThreadID tid)

Check whether a thread was created by createLowLevelThread.

initLowlevelThreads
void initLowlevelThreads()
Undocumented in source. Be warned that the author may not have intended to support it.
ll_removeThread
void ll_removeThread(ThreadID tid)
Undocumented in source. Be warned that the author may not have intended to support it.
onThreadError
void onThreadError(string msg)

A callback for thread errors in D during collections. Since an allocation is not possible a preallocated ThreadError will be used as the Error instance

termLowlevelThreads
void termLowlevelThreads()
Undocumented in source. Be warned that the author may not have intended to support it.
thread_attachThis_tpl
ThreadT thread_attachThis_tpl()

Registers the calling thread for use with the D Runtime. If this routine is called for a thread which is already registered, no action is performed.

thread_detachByAddr
void thread_detachByAddr(ThreadID addr)
thread_detachInstance
void thread_detachInstance(ThreadBase t)

Deregisters the given thread from use with the runtime. If this routine is called for a thread which is not registered, the result is undefined.

thread_detachThis
void thread_detachThis()

Deregisters the calling thread from use with the runtime. If this routine is called for a thread which is not registered, the result is undefined.

thread_enterCriticalRegion
void thread_enterCriticalRegion()

Signals that the code following this call is a critical region. Any code in this region must finish running before the calling thread can be suspended by a call to thread_suspendAll.

thread_exitCriticalRegion
void thread_exitCriticalRegion()

Signals that the calling thread is no longer in a critical region. Following a call to this function, the thread can once again be suspended.

thread_inCriticalRegion
bool thread_inCriticalRegion()

Returns true if the current thread is in a critical region; otherwise, false.

thread_isMainThread
bool thread_isMainThread()
thread_joinAll
void thread_joinAll()

Joins all non-daemon threads that are currently running. This is done by performing successive scans through the thread list until a scan consists of only daemon threads.

thread_processGCMarks
void thread_processGCMarks(IsMarkedDg isMarked)

This routine allows the runtime to process any special per-thread handling for the GC. This is needed for taking into account any memory that is referenced by non-scanned pointers but is about to be freed. That currently means the array append cache.

thread_resumeAll
void thread_resumeAll()

Resume all threads but the calling thread for "stop the world" garbage collection runs. This function must be called once for each preceding call to thread_suspendAll before the threads are actually resumed.

thread_scanAll
void thread_scanAll(ScanAllThreadsFn scan)

The main entry point for garbage collection. The supplied delegate will be passed ranges representing both stack and register values.

thread_scanAllType
void thread_scanAllType(ScanAllThreadsTypeFn scan)

The main entry point for garbage collection. The supplied delegate will be passed ranges representing both stack and register values.

thread_setThis
void thread_setThis(ThreadBase t)

Sets the current thread to a specific reference. Only to be used when dealing with externally-created threads (in e.g. C code). The primary use of this function is when ThreadBase.getThis() must return a sensible value in, for example, TLS destructors. In other words, don't touch this unless you know what you're doing.

thread_stackBottom
void* thread_stackBottom()

Returns the stack bottom of the currently active stack within the calling thread.

thread_stackTop
void* thread_stackTop()

Returns the stack top of the currently active stack within the calling thread.

thread_term_tpl
void thread_term_tpl(MainThreadStore _mainThreadStore)

Terminates the thread module. No other thread routine may be called afterwards.

Properties

lowlevelLock
Mutex lowlevelLock [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

thread_findByAddr
ThreadBase thread_findByAddr(ThreadID addr)

Search the list of all threads for a thread with the given thread identifier.

Static variables

ll_nThreads
size_t ll_nThreads;

//////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////

ll_pThreads
ll_ThreadData* ll_pThreads;
Undocumented in source.
multiThreadedFlag
bool multiThreadedFlag;
Undocumented in source.
suspendDepth
uint suspendDepth;
Undocumented in source.

Variables

attachThread
ThreadBase function(ThreadBase) @(nogc) nothrow attachThread;

//////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////

callWithStackShell
void function(scope callWithStackShellDg) nothrow callWithStackShell;
Undocumented in source.
resume
void function(ThreadBase) nothrow @(nogc) resume;
Undocumented in source.
thread_yield
void function() @(nogc) nothrow thread_yield;
Undocumented in source.

Meta

License

Distributed under the Boost Software License 1.0. (See accompanying file LICENSE)

Authors

Sean Kelly, Walter Bright, Alex Rønne Petersen, Martin Nowak