This module provides services through its proxy
IGateThreadSupport interface. It has a module wide config parameter
Proxy which needs to be bound to an OS specific delegate before
this module can be used.
Here is an example showing how the proxy is bound to an BIOS 6.x specific
delegate.
var GateThread = xdc.useModule('xdc.runtime.knl.GateThread');
GateThread.Proxy =
xdc.useModule('ti.sysbios.xdcruntime.GateThreadSupport');
Typically the package containing the delegates have a Settings module that
will bind all
xdc.runtime.knl proxies. The following
example sets up all the xdc.runtime.knl proxies.
xdc.useModule("ti.sysbios.xdcruntime.Settings");
const GateThread_Q_BLOCKING |
|
Blocking quality
#define GateThread_Q_BLOCKING (Int)1
DETAILS
Gates with this "quality" may cause the calling thread to block;
i.e., suspend execution until another thread leaves the gate.
const GateThread_Q_PREEMPTING |
|
Preempting quality
#define GateThread_Q_PREEMPTING (Int)2
DETAILS
Gates with this "quality" allow other threads to preempt the thread
that has already entered the gate.
GateThread_query() // module-wide |
|
Runtime test for a particular gate quality
Bool GateThread_query(Int qual);
ARGUMENTS
qual
constant describing a quality
RETURNS
Returns TRUE if the gate has the given quality,
and FALSE otherwise, which includes the case when the gate does not
recognize the constant describing the quality.
Module-Wide Built-Ins |
|
// Get this module's unique id
Bool GateThread_Module_startupDone();
// Test if this module has completed startup
// The heap from which this module allocates memory
Bool GateThread_Module_hasMask();
// Test whether this module has a diagnostics mask
Bits16 GateThread_Module_getMask();
// Returns the diagnostics mask for this module
Void GateThread_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types |
|
typedef struct GateThread_Object GateThread_Object;
// Opaque internal representation of an instance object
// Client reference to an instance object
typedef struct GateThread_Struct GateThread_Struct;
// Opaque client structure large enough to hold an instance object
// Convert this instance structure pointer into an instance handle
// Convert this instance handle into an instance structure pointer
Instance Config Parameters |
|
typedef struct GateThread_Params {
// Instance config-params structure
// Common per-instance configs
} GateThread_Params;
// Initialize this config-params structure with supplier-specified defaults before instance creation
Instance Creation |
|
// Allocate and initialize a new instance object and return its handle
// Initialize a new instance object inside the provided structure
ARGUMENTS
params
per-instance config params, or NULL to select default values (target-domain only)
eb
active error-handling block, or NULL to select default policy (target-domain only)
Instance Deletion |
|
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
// Finalize the instance object inside the provided structure
GateThread_enter() // instance |
|
Enter this gate
ARGUMENTS
handle
handle of a previously-created GateThread instance object
DETAILS
Each gate provider can implement mutual exclusion using different
algorithms; e.g., disabling all scheduling, disabling the scheduling
of all threads below a specified "priority level", suspending the
caller when the gate has been entered by another thread and
re-enabling it when the the other thread leaves the gate. However,
in all cases, after this method returns that caller has exclusive
access to the data protected by this gate.
A thread may reenter a gate without blocking or failing.
RETURNS
Returns a "key" that is used to
leave this gate; this
value is used to restore thread preemption to the state that
existed just prior to entering this gate.
GateThread_leave() // instance |
|
Leave this gate
ARGUMENTS
handle
handle of a previously-created GateThread instance object
key
the value returned by a matching call to
enter
DETAILS
This method is only called by threads that have previously entered
this gate via
enter. After this method returns, the
caller must not access the data structure protected by this gate
(unless the caller has entered the gate more than once and other
calls to
leave remain to balance the number of previous
calls to
enter).
Instance Convertors |
|
// unconditionally move one level up the inheritance hierarchy
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins |
|
Int GateThread_Object_count();
// The number of statically-created instance objects
// The handle of the i-th statically-created instance object (array == NULL)
// The handle of the first dynamically-created instance object, or NULL
// The handle of the next dynamically-created instance object, or NULL
// The heap used to allocate dynamically-created instance objects
// The label associated with this instance object
// The name of this instance object
proxy GateThread.Proxy |
|
Proxy that needs to be bound to an OS specific delegate
XDCscript usage |
meta-domain |
// explicit access to the currently bound delegate module
GateThread.Proxy.abstractInstances$ = false
// use indirect runtime function calls if true
const GateThread.Q_BLOCKING |
|
Blocking quality
XDCscript usage |
meta-domain |
const GateThread.Q_BLOCKING = 1;
DETAILS
Gates with this "quality" may cause the calling thread to block;
i.e., suspend execution until another thread leaves the gate.
C SYNOPSIS
const GateThread.Q_PREEMPTING |
|
Preempting quality
XDCscript usage |
meta-domain |
const GateThread.Q_PREEMPTING = 2;
DETAILS
Gates with this "quality" allow other threads to preempt the thread
that has already entered the gate.
C SYNOPSIS
metaonly config GateThread.common$ // module-wide |
|
Common module configuration parameters
XDCscript usage |
meta-domain |
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.
metaonly GateThread.queryMeta() // module-wide |
|
Configuration time test for a particular gate quality
XDCscript usage |
meta-domain |
GateThread.queryMeta(Int qual) returns Bool
ARGUMENTS
qual
constant describing a quality
RETURNS
Returns TRUE if the gate has the given quality,
and FALSE otherwise, which includes the case when the gate does not
recognize the constant describing the quality.
Instance Config Parameters |
|
XDCscript usage |
meta-domain |
var params = new GateThread.Params;
// Instance config-params object
Instance Creation |
|
XDCscript usage |
meta-domain |
var params =
new GateThread.
Params;
// Allocate instance config-params
params.config = ...
// Assign individual configs
var inst = GateThread.create(params);
// Create an instance-object
ARGUMENTS
params
per-instance config params, or NULL to select default values (target-domain only)
eb
active error-handling block, or NULL to select default policy (target-domain only)