module xdc.runtime.knl.GateProcess

Provides protection of critical sections across processes

C synopsis
Individual elements
XDCscript usage
Individual elements

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 ... ]

C synopsis target-domain sourced in xdc/runtime/knl/GateProcess.xdc

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

Functions
Void	GateProcess_construct// Initialize a new instance object inside the provided structure(GateProcess_Struct structP, const GateProcess_Params params, Error_Block *eb);
GateProcess_Handle	GateProcess_create// Allocate and initialize a new instance object and return its handle(const GateProcess_Params params, Error_Block eb);
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);
Int	GateProcess_getReferenceCount// Get the number of processes with references to this Gate(GateProcess_Handle handle, Error_Block *eb);
Void	GateProcess_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(GateProcess_Params *params);
Functions common to all IGateProvider modules
IArg	GateProcess_enter// Enter this gate(GateProcess_Handle handle);
Void	GateProcess_leave// Leave this gate(GateProcess_Handle handle, IArg key);
Bool	GateProcess_query// Runtime test for a particular gate quality(Int qual);
Functions common to all target instances
	GateProcess_handle// Convert this instance structure pointer into an instance handle, GateProcess_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, GateProcess_Handle_label// The label associated with this instance object, GateProcess_Handle_name// The name of this instance object, GateProcess_Handle_upCast// unconditionally move one level up the inheritance hierarchy, GateProcess_Object_count// The number of statically-created instance objects, GateProcess_Object_first// The handle of the first dynamically-created instance object, or NULL, GateProcess_Object_get// The handle of the i-th statically-created instance object (array == NULL), GateProcess_Object_heap// The heap used to allocate dynamically-created instance objects, GateProcess_Object_next// The handle of the next dynamically-created instance object, or NULL, GateProcess_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	GateProcess_Module_getMask// Returns the diagnostics mask for this module, GateProcess_Module_hasMask// Test whether this module has a diagnostics mask, GateProcess_Module_heap// The heap from which this module allocates memory, GateProcess_Module_id// Get this module's unique id, GateProcess_Module_setMask// Set the diagnostics mask for this module, GateProcess_Module_startupDone// Test if this module has completed startup
Defines
#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
Typedefs
typedef GateProcess_Object *	GateProcess_Handle// Client reference to an instance object;
typedef struct	GateProcess_Object// Opaque internal representation of an instance object GateProcess_Object;
typedef struct	GateProcess_Params// Instance config-params structure ...
typedef struct	GateProcess_Struct// Opaque client structure large enough to hold an instance object GateProcess_Struct;
Constants
extern const Assert_Id	GateProcess_A_invalidKey// Assert when an invalid key is passed to create;

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

const GateProcess_GETREFCOUNT_FAILED