const GateAAMonitor_Q_BLOCKING |
|
Blocking quality
#define GateAAMonitor_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 GateAAMonitor_Q_PREEMPTING |
|
Preempting quality
#define GateAAMonitor_Q_PREEMPTING (Int)2
DETAILS
Gates with this "quality" allow other threads to preempt the thread
that has already entered the gate.
config GateAAMonitor_A_invSharedAddr // module-wide |
|
Assert raised when supplied sharedAddr is invalid
extern const Assert_Id GateAAMonitor_A_invSharedAddr;
DETAILS
C6472 requires that shared region 0 be placed in SL2 memory and that
all GateMP instances be allocated from region 0. The gate itself may
be used to protect the contents of any shared region.
config GateAAMonitor_numInstances // module-wide |
|
Maximum number of instances supported by the GateAAMonitor module
extern const UInt GateAAMonitor_numInstances;
GateAAMonitor_query() // module-wide |
|
Runtime test for a particular gate quality
Bool GateAAMonitor_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.
GateAAMonitor_sharedMemReq() // module-wide |
|
Amount of shared memory required for creation of each instance
ARGUMENTS
params
Pointer to the parameters that will be used in
the create.
DETAILS
The value returned by this function may depend on the cache alignment
requirements for the shared region from which memory will be used.
RETURNS
Number of MAUs needed to create the instance.
Module-Wide Built-Ins |
|
// Get this module's unique id
Bool GateAAMonitor_Module_startupDone();
// Test if this module has completed startup
// The heap from which this module allocates memory
Bool GateAAMonitor_Module_hasMask();
// Test whether this module has a diagnostics mask
Bits16 GateAAMonitor_Module_getMask();
// Returns the diagnostics mask for this module
Void GateAAMonitor_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types |
|
typedef struct GateAAMonitor_Object GateAAMonitor_Object;
// Opaque internal representation of an instance object
// Client reference to an instance object
typedef struct GateAAMonitor_Struct GateAAMonitor_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 GateAAMonitor_Params {
// Instance config-params structure
// Common per-instance configs
UInt resourceId;
// Logical resource id
Ptr sharedAddr;
// Physical address of the shared memory
} GateAAMonitor_Params;
// Initialize this config-params structure with supplier-specified defaults before instance creation
config GateAAMonitor_resourceId // instance |
|
Logical resource id
config GateAAMonitor_sharedAddr // instance |
|
Physical address of the shared memory
DETAILS
This parameter is only used by GateMP delegates that use shared memory
Instance Creation |
|
// Allocate and initialize a new instance object and return its handle
// Initialize a new instance object inside the provided structure
ARGUMENTS
localGate
Gate to use for local protection.
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)
DETAILS
A Non-NULL gate for local protection must be passed to the create
call. If no local protection is desired, a
xdc.runtime.GateNull handle must be passed in.
Instance Deletion |
|
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
// Finalize the instance object inside the provided structure
GateAAMonitor_enter() // instance |
|
Enter this gate
ARGUMENTS
handle
handle of a previously-created GateAAMonitor 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.
GateAAMonitor_leave() // instance |
|
Leave this gate
ARGUMENTS
handle
handle of a previously-created GateAAMonitor 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
// unconditionally move 2 levels up the inheritance hierarchy
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
Instance Built-Ins |
|
Int GateAAMonitor_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
const GateAAMonitor.Q_BLOCKING |
|
Blocking quality
XDCscript usage |
meta-domain |
const GateAAMonitor.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 GateAAMonitor.Q_PREEMPTING |
|
Preempting quality
XDCscript usage |
meta-domain |
const GateAAMonitor.Q_PREEMPTING = 2;
DETAILS
Gates with this "quality" allow other threads to preempt the thread
that has already entered the gate.
C SYNOPSIS
config GateAAMonitor.A_invSharedAddr // module-wide |
|
Assert raised when supplied sharedAddr is invalid
XDCscript usage |
meta-domain |
msg: "A_invSharedAddr: Address must be in shared L2 address space"
};
DETAILS
C6472 requires that shared region 0 be placed in SL2 memory and that
all GateMP instances be allocated from region 0. The gate itself may
be used to protect the contents of any shared region.
C SYNOPSIS
config GateAAMonitor.numInstances // module-wide |
|
Maximum number of instances supported by the GateAAMonitor module
XDCscript usage |
meta-domain |
GateAAMonitor.numInstances = UInt 32;
C SYNOPSIS
metaonly config GateAAMonitor.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 GateAAMonitor.getNumResources() // module-wide |
|
Returns the number of resources offered by the GateMP delegate
XDCscript usage |
meta-domain |
GateAAMonitor.getNumResources() returns UInt
metaonly GateAAMonitor.queryMeta() // module-wide |
|
Configuration time test for a particular gate quality
XDCscript usage |
meta-domain |
GateAAMonitor.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 GateAAMonitor.Params;
// Instance config-params object
params.resourceId = UInt 0;
// Logical resource id
params.sharedAddr = Ptr null;
// Physical address of the shared memory
config GateAAMonitor.resourceId // instance |
|
Logical resource id
XDCscript usage |
meta-domain |
var params = new GateAAMonitor.Params;
...
params.resourceId = UInt 0;
C SYNOPSIS
config GateAAMonitor.sharedAddr // instance |
|
Physical address of the shared memory
XDCscript usage |
meta-domain |
var params = new GateAAMonitor.Params;
...
params.sharedAddr = Ptr null;
DETAILS
This parameter is only used by GateMP delegates that use shared memory
C SYNOPSIS
Instance Creation |
|
XDCscript usage |
meta-domain |
var params =
new GateAAMonitor.
Params;
// Allocate instance config-params
params.config = ...
// Assign individual configs
// Create an instance-object
ARGUMENTS
localGate
Gate to use for local protection.
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)
DETAILS
A Non-NULL gate for local protection must be passed to the create
call. If no local protection is desired, a
xdc.runtime.GateNull handle must be passed in.