module xdc.runtime.GateNull

Empty implementation of IGateProvider

An instance of this IGateProvider implementation is assigned to all gated modules as a default module-wide gate. Instances of this gate implementation provide no protection for critical sections and should only be used for modules in which the data structures protected by module-level gates are never accessed by concurrent threads.
C synopsis target-domain sourced in xdc/runtime/GateNull.xdc
#include <xdc/runtime/GateNull.h>
Functions
Void
Void
Void
Void
Functions common to all IGateProvider modules
IArg 
Void 
Bool 
Functions common to all target instances
Functions common to all target modules
Defines
#define
#define
Typedefs
typedef GateNull_Object *
typedef struct
typedef struct
typedef struct
 
 
const GateNull_Q_BLOCKING

Blocking quality

C synopsis target-domain
#define GateNull_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 GateNull_Q_PREEMPTING

Preempting quality

C synopsis target-domain
#define GateNull_Q_PREEMPTING (Int)2
 
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
 
GateNull_query()  // module-wide

Runtime test for a particular gate quality

C synopsis target-domain
Bool GateNull_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

C synopsis target-domain
Types_ModuleId GateNull_Module_id();
// Get this module's unique id
 
Bool GateNull_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle GateNull_Module_heap();
// The heap from which this module allocates memory
 
Bool GateNull_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 GateNull_Module_getMask();
// Returns the diagnostics mask for this module
 
Void GateNull_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct GateNull_Object GateNull_Object;
// Opaque internal representation of an instance object
 
typedef GateNull_Object *GateNull_Handle;
// Client reference to an instance object
 
typedef struct GateNull_Struct GateNull_Struct;
// Opaque client structure large enough to hold an instance object
 
GateNull_Handle GateNull_handle(GateNull_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
GateNull_Struct *GateNull_struct(GateNull_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct GateNull_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
} GateNull_Params;
 
Void GateNull_Params_init(GateNull_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
Runtime Instance Creation

C synopsis target-domain
GateNull_Handle GateNull_create(const GateNull_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void GateNull_construct(GateNull_Struct *structP, const GateNull_Params *params);
// 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

C synopsis target-domain
Void GateNull_delete(GateNull_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void GateNull_destruct(GateNull_Struct *structP);
// Finalize the instance object inside the provided structure
 
GateNull_enter()  // instance

Enter this gate

C synopsis target-domain
IArg GateNull_enter(GateNull_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created GateNull 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.
 
GateNull_leave()  // instance

Leave this gate

C synopsis target-domain
Void GateNull_leave(GateNull_Handle handle, IArg key);
 
ARGUMENTS
handle — handle of a previously-created GateNull 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

C synopsis target-domain
IGateProvider_Handle GateNull_Handle_upCast(GateNull_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
GateNull_Handle GateNull_Handle_downCast(IGateProvider_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins

C synopsis target-domain
Int GateNull_Object_count();
// The number of statically-created instance objects
 
GateNull_Handle GateNull_Object_get(GateNull_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
GateNull_Handle GateNull_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
GateNull_Handle GateNull_Object_next(GateNull_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle GateNull_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *GateNull_Handle_label(GateNull_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String GateNull_Handle_name(GateNull_Handle handle);
// The name of this instance object
 
Configuration settings sourced in xdc/runtime/GateNull.xdc
var GateNull = xdc.useModule('xdc.runtime.GateNull');
module-wide constants & types
module-wide config parameters
module-wide functions
per-instance config parameters
    var params = new GateNull.Params// Instance config-params object;
per-instance creation
    var inst = GateNull.create// Create an instance-object(params);
 
 
const GateNull.Q_BLOCKING

Blocking quality

Configuration settings
const GateNull.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 GateNull.Q_PREEMPTING

Preempting quality

Configuration settings
const GateNull.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 GateNull.common$  // module-wide

Common module configuration parameters

Configuration settings
GateNull.common$ = Types.Common$ undefined;
 
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 GateNull.queryMeta()  // module-wide

Configuration time test for a particular gate quality

Configuration settings
GateNull.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

Configuration settings
var params = new GateNull.Params;
// Instance config-params object
Static Instance Creation

Configuration settings
var params = new GateNull.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = GateNull.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)
generated on Tue, 14 Feb 2017 20:01:28 GMT