module xdc.runtime.knl.GateProcess

Provides protection of critical sections across processes. [EXPERIMENTAL]

C synopsis
XDCscript usage
XDCspec declarations
Individual elements
Additional documentation

This module provides services through its proxy IGateProcessSupport 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. [ more ... ]

XDCspec summary sourced in xdc/runtime/knl/GateProcess.xdc

module GateProcess { ...

// inherits xdc.runtime.IGateProvider

// inherits xdc.runtime.IModule

instance: ...

C synopsis target-domain

#include <xdc/runtime/knl/GateProcess.h>

module-wide constants & types

#define GateProcess_GETREFCOUNT_FAILED// Status returned by getReferenceCount when there is an error (Int)-1

#define GateProcess_Q_BLOCKING// Blocking quality (Int)1

#define GateProcess_Q_PREEMPTING// Preempting quality (Int)2

module-wide config parameters

extern const Assert_Id GateProcess_A_invalidKey// Assert when an invalid key is passed to create;

module-wide functions

Bool GateProcess_query// Runtime test for a particular gate quality( Int qual );

module-wide built-ins

Types_ModuleId GateProcess_Module_id// Get this module's unique id( );

Bool GateProcess_Module_startupDone// Test if this module has completed startup( );

IHeap_Handle GateProcess_Module_heap// The heap from which this module allocates memory( );

per-instance object types

typedef struct GateProcess_Object// Opaque internal representation of an instance object GateProcess_Object;

typedef GateProcess_Object *GateProcess_Handle// Client reference to an instance object;

typedef struct GateProcess_Struct// Opaque client structure large enough to hold an instance object GateProcess_Struct;

GateProcess_Handle GateProcess_handle// Convert this instance structure pointer into an instance handle( GateProcess_Struct *structP );

GateProcess_Struct *GateProcess_struct// Convert this instance handle into an instance structure pointer( GateProcess_Handle handle );

per-instance config parameters

typedef struct GateProcess_Params// Instance config-params structure {

IInstance_Params *instance;

Int key// globally unique key for SysV-style semaphore;

} GateProcess_Params;

Void GateProcess_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation( GateProcess_Params *params );

per-instance creation

GateProcess_Handle GateProcess_create// Allocate and initialize a new instance object and return its handle( const GateProcess_Params *params, Error_Block *eb );

Void GateProcess_construct// Initialize a new instance object inside the provided structure( GateProcess_Struct *structP, const GateProcess_Params *params, Error_Block *eb );

per-instance deletion

Void GateProcess_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL( GateProcess_Handle *handleP );

Void GateProcess_destruct// Finalize the instance object inside the provided structure( GateProcess_Struct *structP );

per-instance functions

IArg GateProcess_enter// Enter this gate( GateProcess_Handle handle );

Int GateProcess_getReferenceCount// Get the number of processes with references to this Gate( GateProcess_Handle handle, Error_Block *eb );

Void GateProcess_leave// Leave this gate( GateProcess_Handle handle, IArg key );

per-instance convertors

IGateProvider_Handle GateProcess_Handle_upCast// unconditionally move one level up the inheritance hierarchy( GateProcess_Handle handle );

GateProcess_Handle GateProcess_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure( IGateProvider_Handle handle );

per-instance built-ins

Int GateProcess_Object_count// The number of statically-created instance objects( );

GateProcess_Handle GateProcess_Object_get// The handle of the i-th statically-created instance object (array == NULL)( GateProcess_Object *array, Int i );

GateProcess_Handle GateProcess_Object_first// The handle of the first dynamically-created instance object, or NULL( );

GateProcess_Handle GateProcess_Object_next// The handle of the next dynamically-created instance object, or NULL( GateProcess_Handle handle );

IHeap_Handle GateProcess_Object_heap// The heap used to allocate dynamically-created instance objects( );

Types_Label *GateProcess_Handle_label// The label associated with this instance object( GateProcess_Handle handle, Types_Label *buf );

String GateProcess_Handle_name// The name of this instance object( GateProcess_Handle handle );

XDCscript usage meta-domain

var GateProcess = xdc.useModule('xdc.runtime.knl.GateProcess');

local proxy modules

GateProcess.Proxy// Proxy that needs to be bound to an OS specific delegate = IGateProcessSupport.Module null

GateProcess.Proxy.delegate$ = IGateProcessSupport.Module null

GateProcess.Proxy.abstractInstances$ = false

module-wide constants & types

const GateProcess.GETREFCOUNT_FAILED// Status returned by getReferenceCount when there is an error = -1;

const GateProcess.Q_BLOCKING// Blocking quality = 1;

const GateProcess.Q_PREEMPTING// Preempting quality = 2;

module-wide config parameters

GateProcess.A_invalidKey// Assert when an invalid key is passed to create = Assert.Desc {

msg: "A_invalidKey: the key must be set to a non-default value"

};

GateProcess.common$// Common module configuration parameters = Types.Common$ undefined;

module-wide functions

GateProcess.queryMeta// Configuration time test for a particular gate quality( Int qual ) returns Bool

per-instance config parameters

var params = new GateProcess.Params// Instance config-params object;

params.key// globally unique key for SysV-style semaphore = Int -1;

per-instance creation

var inst = GateProcess.create// Create an instance-object( params );

XDCspec declarations sourced in xdc/runtime/knl/GateProcess.xdc

package xdc.runtime.knl;

module GateProcess inherits IGateProvider {

local proxy modules

proxy Proxy inherits IGateProcessSupport;

module-wide constants & types

const Int GETREFCOUNT_FAILED// Status returned by getReferenceCount when there is an error = -1;

const Int Q_BLOCKING// Blocking quality = 1;

const Int Q_PREEMPTING// Preempting quality = 2;

module-wide config parameters

config Assert.Id A_invalidKey// Assert when an invalid key is passed to create = {

msg: "A_invalidKey: the key must be set to a non-default value"

};

metaonly config Types.Common$ common$// Common module configuration parameters;

module-wide functions

Bool query// Runtime test for a particular gate quality( Int qual );

metaonly Bool queryMeta// Configuration time test for a particular gate quality( Int qual );

instance:

per-instance config parameters

config Int key// globally unique key for SysV-style semaphore = -1;

per-instance creation

create// Create an instance-object( );

per-instance functions

IArg enter// Enter this gate( );

Int getReferenceCount// Get the number of processes with references to this Gate( Error.Block *eb );

Void leave// Leave this gate( IArg key );

}

DETAILS

Here is an example showing how the proxy is bound to an BIOS 6.x specific delegate.

var GateProcess = xdc.useModule('xdc.runtime.knl.GateProcess'); GateProcess.Proxy = xdc.useModule('ti.sysbios.xdcruntime.GateProcessSupport');

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");

proxy GateProcess.Proxy