CkRegister

Charm Registration--keeps track of the possible chare and method types. More...


Data Structures
class	EntryInfo
	Represents a single entry method or constructor. More...
class	MsgInfo
	Represents one type of Message. More...
class	ChareInfo
	Represents a class of Chares (or array or group elements). More...
class	MainInfo
	Describes a mainchare's constructor. These are all executed at startup. More...
class	ReadonlyInfo
	Describes a readonly global variable. More...
class	ReadonlyMsgInfo
	Describes a readonly message. More...
class	CkRegisteredInfo< T >
	This class stores registered entities, like EntryInfo's, in a linear list indexed by index ("idx"). More...
Typedefs
typedef void (	CkPackFnPtr )(void *msg)
	Message pack function: convert a message into a buffer.
typedef void (	CkUnpackFnPtr )(void *buf)
	Message unpack function: convert a buffer into a message.
typedef void(*	CkDeallocFnPtr )(void *msg)
	Message dealloc function: deletes a message.
typedef void(*	CkCallFnPtr )(void msg, void obj)
	A "call function" to invoke a method on an object.
typedef void(*	CkPupReadonlyFnPtr )(void *pup_er)
	This function pup's a global variable.
typedef int(*	CkMarshallUnpackFn )(char marshall_buf, void object)
	A "marshall unpack" function: pups out parameters and calls a method.
typedef void(*	CkMessagePupFn )(PUP::er &p, void *userMessage)
	A "message pup" function: pups message data for debugger display.
Enumerations
enum	ChareType { TypeInvalid = 0, TypeChare, TypeMainChare, TypeGroup, TypeNodeGroup, TypeArray }
	type of a chare More...
Functions
int	CkRegisterMsg (const char *name, CkPackFnPtr pack, CkUnpackFnPtr unpack, CkDeallocFnPtr dealloc, size_t size)
	Register this message name, with this basic size and pack and unpack functions.
int	CkRegisterEp (const char *name, CkCallFnPtr call, int msgIdx, int chareIdx, int ck_ep_flags)
	Register this entry point, with this call function and flags.
int	CkRegisterChare (const char *name, size_t dataSz, ChareType chareType)
	Register this type of chare (group, or array), with this size.
void	CkRegisterChareInCharm (int chareIndex)
	Register this chare as internal to Charm++.
int	CkRegisterMainChare (int chareIndex, int epIndex)
	Register this chare as a mainchare, with this entry point as its constructor.
void	CkRegisterDefaultCtor (int chareIndex, int ctorEpIndex)
	Register a default constructor for this chare.
void	CkRegisterMigCtor (int chareIndex, int ctorEpIndex)
	Register a migration constructor for this chare.
void	CkRegisterGroupIrr (int chareIndex, int isIrr)
	Indicate whether this group is an IrrGroup.
void	CkRegisterBase (int derivedIdx, int baseIdx)
	Register the chare baseIdx as a base class of the chare derivedIdx.
void	CkRegisterReadonly (const char name, const char type, int size, void *ptr, CkPupReadonlyFnPtr pup_fn)
	Register this readonly global variable.
void	CkRegisterReadonlyMsg (const char name, const char type, void **pMsg)
	Register this readonly message.
void	CkRegisterMarshallUnpackFn (int epIndex, CkMarshallUnpackFn m)
	Register this marshall unpack function with this entry point.
CkMarshallUnpackFn	CkLookupMarshallUnpackFn (int epIndex)
	Lookup the marshall unpack function, if any, for this entry point.
void	CkRegisterMessagePupFn (int epIndex, CkMessagePupFn m)
	Register this message pup function with this entry point.
void	_registerInit (void)
void	_registerDone (void)
Variables
CkRegisteredInfo< EntryInfo >	_entryTable
	These tables are shared between all processors on a node.
CkRegisteredInfo< MsgInfo >	_msgTable
CkRegisteredInfo< ChareInfo >	_chareTable
CkRegisteredInfo< MainInfo >	_mainTable
CkRegisteredInfo< ReadonlyInfo >	_readonlyTable
CkRegisteredInfo< ReadonlyMsgInfo >	_readonlyMsgs

Detailed Description

Charm Registration--keeps track of the possible chare and method types.

These routines keep track of the various chares (see ChareInfo and the _chareTable in register.h) and entry methods (see EntryInfo and the _entryTable) that exist in the program.

These are implemented in register.C.

These routines are normally called by a translator-generated _registerModule routine in the .def file. Because these routines fill out global tables, they are normally called exactly once per node at Charm startup time.