module ti.sdo.xdcruntime.linux.GateProcessSupport
C synopsis target-domain sourced in ti/sdo/xdcruntime/linux/GateProcessSupport.xdc
#include <ti/sdo/xdcruntime/linux/GateProcessSupport.h>
Functions
Void
Void
Void
Void
Functions common to all IGateProcessSupport modules
Int 
Functions common to all IGateProvider modules
IArg 
Void 
Bool 
Functions common to all target instances
Functions common to all target modules
Defines
#define
#define
#define
Typedefs
typedef struct
typedef struct
typedef struct
Constants
extern const Assert_Id 
extern const Assert_Id 
extern const Error_Id 
extern const Log_Event 
extern const Log_Event 
extern const Int 
 
const GateProcessSupport_GETREFCOUNT_FAILED

Status returned by getReferenceCount when there is an error

C synopsis target-domain
#define GateProcessSupport_GETREFCOUNT_FAILED (Int)-1
const GateProcessSupport_Q_BLOCKING

Blocking quality

C synopsis target-domain
#define GateProcessSupport_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 GateProcessSupport_Q_PREEMPTING

Preempting quality

C synopsis target-domain
#define GateProcessSupport_Q_PREEMPTING (Int)2
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
config GateProcessSupport_A_POSIX_Error  // module-wide
C synopsis target-domain
extern const Assert_Id GateProcessSupport_A_POSIX_Error;
config GateProcessSupport_A_invalidKey  // module-wide

Asserted in GateProcess_create

C synopsis target-domain
extern const Assert_Id GateProcessSupport_A_invalidKey;
config GateProcessSupport_E_POSIX_Error  // module-wide
C synopsis target-domain
extern const Error_Id GateProcessSupport_E_POSIX_Error;
config GateProcessSupport_L_create  // module-wide
C synopsis target-domain
extern const Log_Event GateProcessSupport_L_create;
config GateProcessSupport_L_extant  // module-wide
C synopsis target-domain
extern const Log_Event GateProcessSupport_L_extant;
config GateProcessSupport_perms  // module-wide

unix-style RW perms for the underlying sem

C synopsis target-domain
extern const Int GateProcessSupport_perms;
GateProcessSupport_query()  // module-wide

Runtime test for a particular gate quality

C synopsis target-domain
Bool GateProcessSupport_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 GateProcessSupport_Module_id();
// Get this module's unique id
 
Bool GateProcessSupport_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle GateProcessSupport_Module_heap();
// The heap from which this module allocates memory
 
Bool GateProcessSupport_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 GateProcessSupport_Module_getMask();
// Returns the diagnostics mask for this module
 
Void GateProcessSupport_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct GateProcessSupport_Object GateProcessSupport_Object;
// Opaque internal representation of an instance object
 
typedef GateProcessSupport_Object *GateProcessSupport_Handle;
// Client reference to an instance object
 
typedef struct GateProcessSupport_Struct GateProcessSupport_Struct;
// Opaque client structure large enough to hold an instance object
 
GateProcessSupport_Handle GateProcessSupport_handle(GateProcessSupport_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
GateProcessSupport_Struct *GateProcessSupport_struct(GateProcessSupport_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct GateProcessSupport_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
    Int key;
    // globally unique key for SysV-style semaphore
} GateProcessSupport_Params;
 
Void GateProcessSupport_Params_init(GateProcessSupport_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
config GateProcessSupport_key  // instance

globally unique key for SysV-style semaphore

C synopsis target-domain
      ...
    Int key;
Instance Creation

C synopsis target-domain
GateProcessSupport_Handle GateProcessSupport_create(const GateProcessSupport_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void GateProcessSupport_construct(GateProcessSupport_Struct *structP, const GateProcessSupport_Params *params, Error_Block *eb);
// 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)
DETAILS
This function creates a new GateProcess object which is initialized to count. All gates created with the same key reference the same underlying synchronization object and work between processes. The underlying synchronization object should be automatically deleted when all references to it have been deleted, and the reference count should An implementation for a platform on which this is technically impossible (e.g. an operating system that does not support multiple processes) may provide a 'toy' implemenation with behavior matching that of IGateProcessSupport.
Instance Deletion

C synopsis target-domain
Void GateProcessSupport_delete(GateProcessSupport_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void GateProcessSupport_destruct(GateProcessSupport_Struct *structP);
// Finalize the instance object inside the provided structure
GateProcessSupport_enter()  // instance

Enter this gate

C synopsis target-domain
IArg GateProcessSupport_enter(GateProcessSupport_Handle handle);
ARGUMENTS
handle — handle of a previously-created GateProcessSupport 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.
GateProcessSupport_getReferenceCount()  // instance

Get the number of processes with references to this Gate

C synopsis target-domain
Int GateProcessSupport_getReferenceCount(GateProcessSupport_Handle handle, Error_Block *err);
ARGUMENTS
handle — handle of a previously-created GateProcessSupport instance object
err — Pointer to Error.Block
RETURNS
Returns the number of processes that possess a reference to this gate, or GETREFCOUNT_FAILED if an error occured. A 'toy' implementation should always return 0.
GateProcessSupport_leave()  // instance

Leave this gate

C synopsis target-domain
Void GateProcessSupport_leave(GateProcessSupport_Handle handle, IArg key);
ARGUMENTS
handle — handle of a previously-created GateProcessSupport 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
IGateProcessSupport_Handle GateProcessSupport_Handle_upCast(GateProcessSupport_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
GateProcessSupport_Handle GateProcessSupport_Handle_downCast(IGateProcessSupport_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
 
IGateThreadSupport_Handle GateProcessSupport_Handle_upCast2(GateProcessSupport_Handle handle);
// unconditionally move 2 levels up the inheritance hierarchy
 
GateProcessSupport_Handle GateProcessSupport_Handle_downCast2(IGateThreadSupport_Handle handle);
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
 
IGateProvider_Handle GateProcessSupport_Handle_upCast3(GateProcessSupport_Handle handle);
// unconditionally move 3 levels up the inheritance hierarchy
 
GateProcessSupport_Handle GateProcessSupport_Handle_downCast3(IGateProvider_Handle handle);
// conditionally move 3 levels down the inheritance hierarchy; NULL upon failure
Instance Built-Ins

C synopsis target-domain
Int GateProcessSupport_Object_count();
// The number of statically-created instance objects
 
GateProcessSupport_Handle GateProcessSupport_Object_get(GateProcessSupport_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
GateProcessSupport_Handle GateProcessSupport_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
GateProcessSupport_Handle GateProcessSupport_Object_next(GateProcessSupport_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle GateProcessSupport_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *GateProcessSupport_Handle_label(GateProcessSupport_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String GateProcessSupport_Handle_name(GateProcessSupport_Handle handle);
// The name of this instance object
 
XDCscript usage meta-domain sourced in ti/sdo/xdcruntime/linux/GateProcessSupport.xdc
var GateProcessSupport = xdc.useModule('ti.sdo.xdcruntime.linux.GateProcessSupport');
module-wide constants & types
module-wide config parameters
        msg: "A_POSIX_Error: a POSIX function returned failure"
    };
        msg: "A_invalidKey: params key has not been set"
    };
        msg: "E_POSIX_Error: a POSIX function returned failure, errno is %d"
    };
        mask: Diags.LIFECYCLE,
        msg: "--- GateProcess(%d) DNE, creating"
    };
        mask: Diags.LIFECYCLE,
        msg: "--- GateProcess(%d) already exists, incrementing reference count"
    };
module-wide functions
per-instance config parameters
    var params = new GateProcessSupport.Params// Instance config-params object;
        params.key// globally unique key for SysV-style semaphore = Int -1;
per-instance creation
    var inst = GateProcessSupport.create// Create an instance-object(params);
 
const GateProcessSupport.GETREFCOUNT_FAILED

Status returned by getReferenceCount when there is an error

XDCscript usage meta-domain
const GateProcessSupport.GETREFCOUNT_FAILED = -1;
C SYNOPSIS
const GateProcessSupport.Q_BLOCKING

Blocking quality

XDCscript usage meta-domain
const GateProcessSupport.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 GateProcessSupport.Q_PREEMPTING

Preempting quality

XDCscript usage meta-domain
const GateProcessSupport.Q_PREEMPTING = 2;
DETAILS
Gates with this "quality" allow other threads to preempt the thread that has already entered the gate.
C SYNOPSIS
config GateProcessSupport.A_POSIX_Error  // module-wide
XDCscript usage meta-domain
GateProcessSupport.A_POSIX_Error = Assert.Desc {
    msg: "A_POSIX_Error: a POSIX function returned failure"
};
C SYNOPSIS
config GateProcessSupport.A_invalidKey  // module-wide

Asserted in GateProcess_create

XDCscript usage meta-domain
GateProcessSupport.A_invalidKey = Assert.Desc {
    msg: "A_invalidKey: params key has not been set"
};
C SYNOPSIS
config GateProcessSupport.E_POSIX_Error  // module-wide
XDCscript usage meta-domain
GateProcessSupport.E_POSIX_Error = Error.Desc {
    msg: "E_POSIX_Error: a POSIX function returned failure, errno is %d"
};
C SYNOPSIS
config GateProcessSupport.L_create  // module-wide
XDCscript usage meta-domain
GateProcessSupport.L_create = Log.EventDesc {
    mask: Diags.LIFECYCLE,
    msg: "--- GateProcess(%d) DNE, creating"
};
C SYNOPSIS
config GateProcessSupport.L_extant  // module-wide
XDCscript usage meta-domain
GateProcessSupport.L_extant = Log.EventDesc {
    mask: Diags.LIFECYCLE,
    msg: "--- GateProcess(%d) already exists, incrementing reference count"
};
C SYNOPSIS
config GateProcessSupport.perms  // module-wide

unix-style RW perms for the underlying sem

XDCscript usage meta-domain
GateProcessSupport.perms = Int 0666;
C SYNOPSIS
metaonly config GateProcessSupport.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
GateProcessSupport.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 GateProcessSupport.queryMeta()  // module-wide

Configuration time test for a particular gate quality

XDCscript usage meta-domain
GateProcessSupport.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 GateProcessSupport.Params;
// Instance config-params object
    params.key = Int -1;
    // globally unique key for SysV-style semaphore
config GateProcessSupport.key  // instance

globally unique key for SysV-style semaphore

XDCscript usage meta-domain
var params = new GateProcessSupport.Params;
  ...
params.key = Int -1;
C SYNOPSIS
Instance Creation

XDCscript usage meta-domain
var params = new GateProcessSupport.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = GateProcessSupport.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)
DETAILS
This function creates a new GateProcess object which is initialized to count. All gates created with the same key reference the same underlying synchronization object and work between processes. The underlying synchronization object should be automatically deleted when all references to it have been deleted, and the reference count should An implementation for a platform on which this is technically impossible (e.g. an operating system that does not support multiple processes) may provide a 'toy' implemenation with behavior matching that of IGateProcessSupport.
generated on Fri, 29 Oct 2010 00:26:49 GMT