interface xdc.runtime.knl.IThreadSupport
index URL

Interface for OS specific back-end

The xdc.runtime.knl package contains modules that provide typical OS services. These xdc.runtime.knl modules require proxies to be bound to an OS specific delegate. This specifies the interface to be implemented by the OS specific delegate for xdc.runtime.knl.Thread module. [ more ... ]
XDCspec summary sourced in xdc/runtime/knl/IThreadSupport.xdc
interface IThreadSupport {  ...
// inherits xdc.runtime.IModule
instance:  ...
XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
package xdc.runtime.knl;
 
interface IThreadSupport {
module-wide constants & types
    const Int GETPRI_FAILED// The error status for getPriority when an error is captured in the Error.Block = -2;
    const Int INVALID_OS_PRIORITY// Invalid OS priority value = 0;
 
    enum CompStatus// Status returned by compareOsPriorities when an error occurs {
        CompStatus_ERROR,
        CompStatus_LOWER,
        CompStatus_EQUAL,
        CompStatus_HIGHER
    };
 
    enum Priority// Thread priorities which are mapped to OS specific value by Proxy {
        Priority_INVALID,
        Priority_LOWEST,
        Priority_BELOW_NORMAL,
        Priority_NORMAL,
        Priority_ABOVE_NORMAL,
        Priority_HIGHEST
    };
 
    typedef Void (*RunFxn// typedef for function that gets called when the Thread runs)(IArg);
 
    struct Stat// Struct to hold thread statistics from stat {
        SizeT stackSize;
        SizeT stackUsed;
    };
module-wide config parameters
    metaonly config Types.Common$ common$// Common module configuration parameters;
module-wide functions
    Int compareOsPriorities// Compare two priority values and find out which one represents a higher priority(Int p1, Int p2, Error.Block *eb);
    IThreadSupport.Handle self// Acquire the currently executing thread's handle(Error.Block *eb);
    Bool sleep// Sleep for certain number of microseconds(UInt timeout, Error.Block *eb);
    Bool start// Start threads running(Error.Block *eb);
    Bool yield// Yield the currently scheduled thread(Error.Block *eb);
 
 
instance:
per-instance config parameters
    config IArg arg// Thread function argument. Default is NULL = null;
    config Int osPriority// OS specific thread priority = IThreadSupport.INVALID_OS_PRIORITY;
    config IThreadSupport.Priority priority// Thread priority = IThreadSupport.Priority_NORMAL;
    config SizeT stackSize// Thread stack size. If left at zero, OS default is used = 0;
    config Ptr tls// User-specified thread local storage data = null;
per-instance creation
    create// Create an instance-object(IThreadSupport.RunFxn fxn);
per-instance functions
    Ptr getOsHandle// Get the OS thread handle();
    Int getOsPriority// Obtain a thread's os specific priority(Error.Block *eb);
    IThreadSupport.Priority getPriority// Obtain a thread's priority(Error.Block *eb);
    Ptr getTls// Obtain a thread's local storage pointer();
    Bool join// Join on a Thread(Error.Block *eb);
    Bool setOsPriority// Set a thread's priority(Int newPri, Error.Block *eb);
    Bool setPriority// Set a thread's priority(IThreadSupport.Priority newPri, Error.Block *eb);
    Void setTls// Set a thread's local storage pointer(Ptr tls);
    Bool stat// Obtain a thread's stats(IThreadSupport.Stat *buf, Error.Block *eb);
}
DETAILS
The xdc.runtime.knl package contains modules that provide typical OS services. These xdc.runtime.knl modules require proxies to be bound to an OS specific delegate. This specifies the interface to be implemented by the OS specific delegate for xdc.runtime.knl.Thread module.
Refer to xdc.runtime.knl.Thread for more details on the APIs.
 
const IThreadSupport.GETPRI_FAILED
index URL

The error status for getPriority when an error is captured in the Error.Block

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
const Int GETPRI_FAILED = -2;
 
 
const IThreadSupport.INVALID_OS_PRIORITY
index URL

Invalid OS priority value

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
const Int INVALID_OS_PRIORITY = 0;
 
 
enum IThreadSupport.CompStatus
index URL

Status returned by compareOsPriorities when an error occurs

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
enum CompStatus {
    CompStatus_ERROR,
    CompStatus_LOWER,
    CompStatus_EQUAL,
    CompStatus_HIGHER
};
 
 
enum IThreadSupport.Priority
index URL

Thread priorities which are mapped to OS specific value by Proxy

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
enum Priority {
    Priority_INVALID,
    Priority_LOWEST,
    Priority_BELOW_NORMAL,
    Priority_NORMAL,
    Priority_ABOVE_NORMAL,
    Priority_HIGHEST
};
 
 
typedef IThreadSupport.RunFxn
index URL

typedef for function that gets called when the Thread runs

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
typedef Void (*RunFxn)(IArg);
 
 
struct IThreadSupport.Stat
index URL

Struct to hold thread statistics from stat

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
struct Stat {
    SizeT stackSize;
    SizeT stackUsed;
};
 
 
metaonly config IThreadSupport.common$  // module-wide
index URL

Common module configuration parameters

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
metaonly config Types.Common$ common$;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
 
IThreadSupport.compareOsPriorities()  // module-wide
index URL

Compare two priority values and find out which one represents a higher priority

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Int compareOsPriorities(Int p1, Int p2, Error.Block *eb);
 
ARGUMENTS
p1 — priority one
p2 — priority two
eb — Pointer to Error.Block
DETAILS
Refer to xdc.runtime.knl.Thread.compareOsPriorities for more details.
RETURNS
Refer to description above
 
IThreadSupport.self()  // module-wide
index URL

Acquire the currently executing thread's handle

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
IThreadSupport.Handle self(Error.Block *eb);
 
ARGUMENTS
eb — Pointer to Error.Block
DETAILS
Refer to xdc.runtime.knl.Thread.self for more details.
RETURNS
Handle in case of success; null for error;
 
IThreadSupport.sleep()  // module-wide
index URL

Sleep for certain number of microseconds

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Bool sleep(UInt timeout, Error.Block *eb);
 
ARGUMENTS
timeout — timeout in microseconds
eb — Pointer to Error.Block
DETAILS
Refer to xdc.runtime.knl.Thread.sleep for more details.
RETURNS
true for success; false for failure
 
IThreadSupport.start()  // module-wide
index URL

Start threads running

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Bool start(Error.Block *eb);
 
ARGUMENTS
eb — Pointer to Error.Block
DETAILS
Refer to xdc.runtime.knl.Thread.start for more details.
RETURNS
true for success; false for failure
 
IThreadSupport.yield()  // module-wide
index URL

Yield the currently scheduled thread

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Bool yield(Error.Block *eb);
 
ARGUMENTS
eb — Pointer to Error.Block
DETAILS
Refer to xdc.runtime.knl.Thread.yield for more details.
RETURNS
true for success; false for failure
 
config IThreadSupport.arg  // instance
index URL

Thread function argument. Default is NULL

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
config IArg arg = null;
 
 
config IThreadSupport.osPriority  // instance
index URL

OS specific thread priority

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
config Int osPriority = IThreadSupport.INVALID_OS_PRIORITY;
 
DETAILS
Used to specify an OS specific value for priority. If set this value takes precedence over priority.
 
config IThreadSupport.priority  // instance
index URL

Thread priority

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
config IThreadSupport.Priority priority = IThreadSupport.Priority_NORMAL;
 
DETAILS
Thread defines several constants which allows applications to select a priority in an OS independent way. Priority_LOWEST, Priority_BELOW_NORMAL, Priority_NORMAL, Priority_ABOVE_NORMAL and Priority_HIGHEST. These values get mapped to OS specific priorities by the OS specific delegate.
 
config IThreadSupport.stackSize  // instance
index URL

Thread stack size. If left at zero, OS default is used

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
config SizeT stackSize = 0;
 
 
config IThreadSupport.tls  // instance
index URL

User-specified thread local storage data

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
config Ptr tls = null;
 
Instance Creation
index URL

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
create(IThreadSupport.RunFxn fxn);
// Create an instance-object
ARGUMENTS
fxn — function for new thread to begin execution
DETAILS
This function spawns a new thread calling the function fxn.
 
IThreadSupport.getOsHandle()  // instance
index URL

Get the OS thread handle

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Ptr getOsHandle();
 
RETURNS
null in case of error
 
IThreadSupport.getOsPriority()  // instance
index URL

Obtain a thread's os specific priority

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Int getOsPriority(Error.Block *eb);
 
ARGUMENTS
eb — Pointer to Error.Block
DETAILS
For OSes that support dynamic priority boosting, the value returned is the base priority of the thread.
Refer to xdc.runtime.knl.Thread.getOsPriority for more details.
RETURNS
thread priority in case of success; GETPRI_FAILED in case of error;
 
IThreadSupport.getPriority()  // instance
index URL

Obtain a thread's priority

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
IThreadSupport.Priority getPriority(Error.Block *eb);
 
ARGUMENTS
eb — Pointer to Error.Block
DETAILS
Refer to xdc.runtime.knl.Thread.getPriority for more details.
RETURNS
thread priority in case of success; Priority_INVALID in case of error;
 
IThreadSupport.getTls()  // instance
index URL

Obtain a thread's local storage pointer

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Ptr getTls();
 
RETURNS
null in case of error
 
IThreadSupport.join()  // instance
index URL

Join on a Thread

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Bool join(Error.Block *eb);
 
ARGUMENTS
eb — Pointer to Error.Block
DETAILS
Refer to xdc.runtime.knl.Thread.join for more details.
RETURNS
true for success; false for failure
 
IThreadSupport.setOsPriority()  // instance
index URL

Set a thread's priority

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Bool setOsPriority(Int newPri, Error.Block *eb);
 
ARGUMENTS
newPri — new thread priority
eb — Pointer to Error.Block
DETAILS
This API sets the base priority of the thread on OSes that support dynamic priority boosting
Refer to xdc.runtime.knl.Thread.setOsPriority for more details.
RETURNS
true for success; false for failure
 
IThreadSupport.setPriority()  // instance
index URL

Set a thread's priority

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Bool setPriority(IThreadSupport.Priority newPri, Error.Block *eb);
 
ARGUMENTS
newPri — new thread priority
eb — Pointer to Error.Block
DETAILS
Refer to xdc.runtime.knl.Thread.setPriority for more details.
RETURNS
true for success; false for failure
 
IThreadSupport.setTls()  // instance
index URL

Set a thread's local storage pointer

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Void setTls(Ptr tls);
 
ARGUMENTS
tls — thread tls
 
IThreadSupport.stat()  // instance
index URL

Obtain a thread's stats

XDCspec declarations sourced in xdc/runtime/knl/IThreadSupport.xdc
Bool stat(IThreadSupport.Stat *buf, Error.Block *eb);
 
ARGUMENTS
buf — Pointer to Stat
eb — Pointer to Error.Block
RETURNS
true for success; false for failure
generated on Thu, 27 Sep 2012 23:21:09 GMT