CkCallback Class Reference

#include <ckcallback.h>

Inheritance diagram for CkCallback:

Collaboration diagram for CkCallback:


Public Types
enum	callbackType { invalid = 0, ignore, ckExit, resumeThread, callCFn, call1Fn, sendChare, sendGroup, sendNodeGroup, sendArray, isendChare, isendGroup, isendNodeGroup, isendArray, bcastGroup, bcastNodeGroup, bcastArray, bcastSection, replyCCS }
Public Member Functions
bool	operator== (CkCallback &other)
void	impl_thread_init (void)
void *	impl_thread_delay (void) const
	CkCallback (void)
	CkCallback (callbackType t)
	CkCallback (Ck1CallbackFn fn)
	CkCallback (CkCallbackFn fn, void *param)
	CkCallback (int ep, const CkChareID &id, bool forceInline=false)
	CkCallback (int ep, const CProxy_NodeGroup &ngp)
	CkCallback (int ep, const CkGroupID &id, bool isNodeGroup=false)
	CkCallback (int ep, int onPE, const CProxy_NodeGroup &ngp, bool forceInline=false)
	CkCallback (int ep, int onPE, const CkGroupID &id, bool forceInline=false, bool isNodeGroup=false)
	CkCallback (int ep, const CProxyElement_Group &grpElt, bool forceInline=false)
	CkCallback (int ep, const CProxyElement_NodeGroup &grpElt, bool forceInline=false)
	CkCallback (int ep, const CkArrayID &id)
	CkCallback (int ep, const CkArrayIndex &idx, const CkArrayID &id, bool forceInline=false)
	CkCallback (int ep, const CProxyElement_ArrayBase &arrElt, bool forceInline=false)
	CkCallback (int ep, CProxySection_ArrayBase &sectElt, bool forceInline=false)
	CkCallback (int ep, CkSectionID &sid)
	CkCallback (Chare *p, int ep, bool forceInline=false)
	CkCallback (Group *p, int ep, bool forceInline=false)
	CkCallback (NodeGroup *p, int ep, bool forceInline=false)
	CkCallback (ArrayElement *p, int ep, bool forceInline=false)
	CkCallback (const CcsDelayedReply &reply)
	~CkCallback ()
bool	isInvalid (void) const
bool	requiresMsgConstruction () const
bool	containsPointer () const
	Does this callback point at something that may not be at the same address after a checkpoint/restart cycle?
void *	thread_delay (void) const
	Interface used by threaded callbacks: Libraries should call these from their "start" entry points.
void	thread_destroy () const
void	send (void *msg=NULL) const
	Send this message back to the caller.
void	send (int length, const void *data) const
	Send this data, formatted as a CkDataMsg, back to the caller.
void	pup (PUP::er &p)
void	setRefNum (CMK_REFNUM_TYPE refnum)
void	setRefnum (CMK_REFNUM_TYPE refnum)
Static Public Member Functions
static const char *	typeName (callbackType type)
Data Fields
callbackType	type
callbackData	d
bool	isCkExtReductionCb = false
Data Structures
union	callbackData

Detailed Description

Definition at line 35 of file ckcallback.h.

Member Enumeration Documentation

enum CkCallback::callbackType

Enumerator:

invalid
ignore
ckExit
resumeThread
callCFn
call1Fn
sendChare
sendGroup
sendNodeGroup
sendArray
isendChare
isendGroup
isendNodeGroup
isendArray
bcastGroup
bcastNodeGroup
bcastArray
bcastSection
replyCCS

Definition at line 37 of file ckcallback.h.

Constructor & Destructor Documentation

CkCallback::CkCallback ( void ) [inline]

Definition at line 220 of file ckcallback.h.

References invalid, and type.

CkCallback::CkCallback ( callbackType t ) [inline]

Definition at line 227 of file ckcallback.h.

References impl_thread_init(), resumeThread, and type.

Here is the call graph for this function:

CkCallback::CkCallback ( Ck1CallbackFn fn ) [inline]

Definition at line 236 of file ckcallback.h.

References CkCallback::callbackData::c1fn, call1Fn, d, CkCallback::callbackData::s_c1fn::fn, and type.

CkCallback::CkCallback	(	CkCallbackFn	fn,
		void *	param
	)			`[inline]`

Definition at line 245 of file ckcallback.h.

References callCFn, CkCallback::callbackData::cfn, Converse::CkMyPe(), d, CkCallback::callbackData::s_cfn::fn, CkCallback::callbackData::s_cfn::onPE, CkCallback::callbackData::s_cfn::param, and type.

Here is the call graph for this function:

CkCallback::CkCallback	(	int	ep,
		const CkChareID &	id,
		bool	forceInline = `false`
	)			`[inline]`

Definition at line 254 of file ckcallback.h.

References _entryTable, CkCallback::callbackData::chare, d, CkCallback::callbackData::s_chare::ep, CkCallback::callbackData::s_chare::hasRefnum, CkCallback::callbackData::s_chare::id, isendChare, CkCallback::callbackData::s_chare::refnum, sendChare, and type.

CkCallback::CkCallback	(	int	ep,
		const CProxy_NodeGroup &	ngp
	)

Definition at line 125 of file ckcallback.C.

References bcastNodeGroup, CProxy_NodeGroup::ckGetGroupID(), d, CkCallback::callbackData::s_group::ep, CkCallback::callbackData::group, CkCallback::callbackData::s_group::hasRefnum, CkCallback::callbackData::s_group::id, CkCallback::callbackData::s_group::refnum, and type.

Here is the call graph for this function:

CkCallback::CkCallback	(	int	ep,
		const CkGroupID &	id,
		bool	isNodeGroup = `false`
	)			`[inline]`

Definition at line 268 of file ckcallback.h.

References bcastGroup, bcastNodeGroup, d, CkCallback::callbackData::s_group::ep, CkCallback::callbackData::group, CkCallback::callbackData::s_group::hasRefnum, CkCallback::callbackData::s_group::id, CkCallback::callbackData::s_group::refnum, and type.

CkCallback::CkCallback	(	int	ep,
		int	onPE,
		const CProxy_NodeGroup &	ngp,
		bool	forceInline = `false`
	)

Definition at line 135 of file ckcallback.C.

References _entryTable, CProxy_NodeGroup::ckGetGroupID(), d, CkCallback::callbackData::s_group::ep, CkCallback::callbackData::group, CkCallback::callbackData::s_group::hasRefnum, CkCallback::callbackData::s_group::id, isendNodeGroup, CkCallback::callbackData::s_group::onPE, CkCallback::callbackData::s_group::refnum, sendNodeGroup, and type.

Here is the call graph for this function:

CkCallback::CkCallback	(	int	ep,
		int	onPE,
		const CkGroupID &	id,
		bool	forceInline = `false`,
		bool	isNodeGroup = `false`
	)			`[inline]`

Definition at line 282 of file ckcallback.h.

References _entryTable, d, CkCallback::callbackData::s_group::ep, CkCallback::callbackData::group, CkCallback::callbackData::s_group::hasRefnum, CkCallback::callbackData::s_group::id, isendGroup, isendNodeGroup, CkCallback::callbackData::s_group::onPE, CkCallback::callbackData::s_group::refnum, sendGroup, sendNodeGroup, and type.

CkCallback::CkCallback	(	int	ep,
		const CProxyElement_Group &	grpElt,
		bool	forceInline = `false`
	)

Definition at line 145 of file ckcallback.C.

References _entryTable, d, CkCallback::callbackData::s_group::ep, CkCallback::callbackData::group, CkCallback::callbackData::s_group::hasRefnum, CkCallback::callbackData::s_group::id, isendGroup, CkCallback::callbackData::s_group::onPE, CkCallback::callbackData::s_group::refnum, sendGroup, and type.

CkCallback::CkCallback	(	int	ep,
		const CProxyElement_NodeGroup &	grpElt,
		bool	forceInline = `false`
	)

Definition at line 157 of file ckcallback.C.

References _entryTable, CProxy_NodeGroup::ckGetGroupID(), CProxyElement_NodeGroup::ckGetGroupPe(), d, CkCallback::callbackData::s_group::ep, CkCallback::callbackData::group, CkCallback::callbackData::s_group::hasRefnum, CkCallback::callbackData::s_group::id, isendNodeGroup, CkCallback::callbackData::s_group::onPE, CkCallback::callbackData::s_group::refnum, sendNodeGroup, and type.

Here is the call graph for this function:

CkCallback::CkCallback	(	int	ep,
		const CkArrayID &	id
	)			`[inline]`

Definition at line 299 of file ckcallback.h.

References CkCallback::callbackData::array, bcastArray, d, CkCallback::callbackData::s_array::ep, CkCallback::callbackData::s_array::hasRefnum, CkCallback::callbackData::s_array::id, CkCallback::callbackData::s_array::refnum, and type.

CkCallback::CkCallback	(	int	ep,
		const CkArrayIndex &	idx,
		const CkArrayID &	id,
		bool	forceInline = `false`
	)			`[inline]`

Definition at line 310 of file ckcallback.h.

References _entryTable, CkCallback::callbackData::array, d, CkCallback::callbackData::s_array::ep, CkCallback::callbackData::s_array::hasRefnum, CkCallback::callbackData::s_array::id, CkCallback::callbackData::s_array::idx, isendArray, CkCallback::callbackData::s_array::refnum, sendArray, and type.

CkCallback::CkCallback	(	int	ep,
		const CProxyElement_ArrayBase &	arrElt,
		bool	forceInline = `false`
	)

Definition at line 169 of file ckcallback.C.

References _entryTable, CkCallback::callbackData::array, d, CkCallback::callbackData::s_array::ep, CkCallback::callbackData::s_array::hasRefnum, CkCallback::callbackData::s_array::id, CkCallback::callbackData::s_array::idx, isendArray, CkCallback::callbackData::s_array::refnum, sendArray, and type.

CkCallback::CkCallback	(	int	ep,
		CProxySection_ArrayBase &	sectElt,
		bool	forceInline = `false`
	)

Definition at line 181 of file ckcallback.C.

CkCallback::CkCallback	(	int	ep,
		CkSectionID &	sid
	)

Definition at line 197 of file ckcallback.C.

References CkCallback::callbackData::s_section::_elems, CkCallback::callbackData::s_section::_nElems, bcastSection, d, CkCallback::callbackData::s_section::ep, CkCallback::callbackData::s_section::hasRefnum, CkCallback::callbackData::s_section::npes, CkCallback::callbackData::s_section::pelist, CkCallback::callbackData::s_section::refnum, CkCallback::callbackData::section, CkCallback::callbackData::s_section::sinfo, and type.

CkCallback::CkCallback	(	Chare *	p,
		int	ep,
		bool	forceInline = `false`
	)

Definition at line 96 of file ckcallback.C.

References _entryTable, CkCallback::callbackData::chare, Chare::ckGetChareID(), d, CkCallback::callbackData::s_chare::ep, CkCallback::callbackData::s_chare::hasRefnum, CkCallback::callbackData::s_chare::id, isendChare, CkCallback::callbackData::s_chare::refnum, sendChare, and type.

Here is the call graph for this function:

CkCallback::CkCallback	(	Group *	p,
		int	ep,
		bool	forceInline = `false`
	)

Definition at line 106 of file ckcallback.C.

References _entryTable, IrrGroup::ckGetGroupID(), Converse::CkMyPe(), d, CkCallback::callbackData::s_group::ep, CkCallback::callbackData::group, CkCallback::callbackData::s_group::hasRefnum, CkCallback::callbackData::s_group::id, isendGroup, CkCallback::callbackData::s_group::onPE, CkCallback::callbackData::s_group::refnum, sendGroup, and type.

Here is the call graph for this function:

CkCallback::CkCallback	(	NodeGroup *	p,
		int	ep,
		bool	forceInline = `false`
	)

Definition at line 115 of file ckcallback.C.

References _entryTable, NodeGroup::ckGetGroupID(), BGConverse::CkMyNode(), d, CkCallback::callbackData::s_group::ep, CkCallback::callbackData::group, CkCallback::callbackData::s_group::hasRefnum, CkCallback::callbackData::s_group::id, isendNodeGroup, CkCallback::callbackData::s_group::onPE, CkCallback::callbackData::s_group::refnum, sendNodeGroup, and type.

Here is the call graph for this function:

CkCallback::CkCallback	(	ArrayElement *	p,
		int	ep,
		bool	forceInline = `false`
	)

Definition at line 212 of file ckcallback.C.

References _entryTable, CkCallback::callbackData::array, ArrayElement::ckGetArrayID(), CkMigratable::ckGetArrayIndex(), d, CkCallback::callbackData::s_array::ep, CkCallback::callbackData::s_array::hasRefnum, CkCallback::callbackData::s_array::id, CkCallback::callbackData::s_array::idx, isendArray, CkCallback::callbackData::s_array::refnum, sendArray, and type.

Here is the call graph for this function:

CkCallback::CkCallback ( const CcsDelayedReply & reply ) [inline]

Definition at line 339 of file ckcallback.h.

References CkCallback::callbackData::ccsReply, d, CkCallback::callbackData::s_ccsReply::reply, replyCCS, and type.

CkCallback::~CkCallback ( ) [inline]

Definition at line 347 of file ckcallback.h.

References thread_destroy().

Here is the call graph for this function:

Member Function Documentation

static const char* CkCallback::typeName ( callbackType type ) [inline, static]

Definition at line 59 of file ckcallback.h.

References bcastArray, bcastGroup, bcastNodeGroup, bcastSection, call1Fn, callCFn, ckExit, ignore, invalid, isendArray, isendChare, isendGroup, isendNodeGroup, replyCCS, resumeThread, sendArray, sendChare, sendGroup, and sendNodeGroup.

Referenced by CkReductionMgr::reduceMessages().

Here is the caller graph for this function:

bool CkCallback::operator== ( CkCallback & other ) [inline]

Definition at line 149 of file ckcallback.h.

void CkCallback::impl_thread_init ( void )

Definition at line 54 of file ckcallback.C.

References CkCallback::callbackData::s_thread::cb, cb, Converse::CkMyPe(), d, CkCallback::callbackData::s_thread::onPE, CkCallback::callbackData::s_thread::ret, CkCallback::callbackData::s_thread::th, and CkCallback::callbackData::thread.

Referenced by CkCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

void * CkCallback::impl_thread_delay ( void ) const

Definition at line 70 of file ckcallback.C.

References CkCallback::callbackData::s_thread::cb, Converse::CkMyPe(), CthSelf(), CthSuspend(), d, dest, CkCallback::callbackData::s_thread::onPE, resumeThread, CkCallback::callbackData::s_thread::ret, CkCallback::callbackData::s_thread::th, CkCallback::callbackData::thread, and type.

Referenced by CkCallbackPython::thread_delay(), and thread_delay().

Here is the call graph for this function:

Here is the caller graph for this function:

bool CkCallback::isInvalid ( void ) const [inline]

Definition at line 351 of file ckcallback.h.

References invalid, and type.

Referenced by CkReductionMgr::barrier(), CkReductionMgr::Barrier_RecvMsg(), MeshStreamer< dtype >::checkAllStagesCompleted(), CkCreateArrayAsync(), CkNodeReductionMgr::ckSetReductionClient(), CkStartCheckpoint(), MeshStreamer< dtype >::finish(), CkReductionMgr::finishBarrier(), CkNodeReductionMgr::finishReduction(), CkReductionMgr::finishReduction(), CkArray::initDone(), CkMemCheckPT::isMaster(), Ck::IO::impl::Director::prepareWriteSession_helper(), CkMulticastMgr::recvRedMsg(), CkMulticastMgr::reduceFragment(), and CkReductionMgr::reduceMessages().

Here is the caller graph for this function:

bool CkCallback::requiresMsgConstruction ( ) const [inline]

Definition at line 353 of file ckcallback.h.

References ckExit, ignore, invalid, and type.

Referenced by invokeDestinationCallback(), invokeSourceCallback(), and send().

Here is the caller graph for this function:

bool CkCallback::containsPointer ( ) const

Does this callback point at something that may not be at the same address after a checkpoint/restart cycle?

Definition at line 484 of file ckcallback.C.

References bcastArray, bcastGroup, bcastNodeGroup, bcastSection, call1Fn, callCFn, ckExit, ignore, invalid, isendArray, isendChare, isendGroup, isendNodeGroup, replyCCS, resumeThread, sendArray, sendChare, sendGroup, sendNodeGroup, and type.

Referenced by CkStartCheckpoint().

Here is the caller graph for this function:

void* CkCallback::thread_delay ( void ) const [inline]

Interface used by threaded callbacks: Libraries should call these from their "start" entry points.

Use "return cb.thread_delay()" to suspend the thread before the return. It's a no-op for everything but threads.

Reimplemented in CkCallbackPython.

Definition at line 368 of file ckcallback.h.

References impl_thread_delay(), resumeThread, and type.

Referenced by CkCallbackResumeThread::~CkCallbackResumeThread().

Here is the call graph for this function:

Here is the caller graph for this function:

void CkCallback::thread_destroy ( ) const

Definition at line 521 of file ckcallback.C.

References CkCallback::callbackData::s_thread::cb, d, resumeThread, CkCallback::callbackData::thread, and type.

Referenced by ~CkCallback(), and CkCallbackResumeThread::~CkCallbackResumeThread().

Here is the caller graph for this function:

void CkCallback::send ( void * msg = NULL ) const

Send this message back to the caller.

Libraries should call this from their "done" entry points. It takes the given message and handles it appropriately. After the send(), this callback is finished and cannot be reused.

Definition at line 292 of file ckcallback.C.