ck-core/envelope.h File Reference

Go to the source code of this file.

Namespaces
namespace	ck
namespace	ck::impl
Data Structures
class	PathHistoryEnvelope
	A class that is used to track the entry points and other information about a critical path as a charm++ program executes. More...
union	ck::impl::u_type
	These structures store the type-specific message information. More...
struct	ck::impl::u_type::s_chare
struct	ck::impl::u_type::s_group
struct	ck::impl::u_type::s_array
struct	ck::impl::u_type::s_roData
struct	ck::impl::u_type::s_roMsg
struct	ck::impl::s_attribs
class	envelope
class	envelope::envelopeSizeHelper
class	MsgPool
Typedefs
typedef unsigned int	UInt
typedef unsigned short	UShort
typedef unsigned char	UChar
Functions
	CkpvExtern (int, envelopeEventID)
void	CkPackMessage (envelope **pEnv)
void	CkUnpackMessage (envelope **pEnv)
	CkpvExtern (MsgPool *, _msgPool)
envelope *	UsrToEnv (const void *const msg)
void *	EnvToUsr (const envelope *const env)
envelope *	_allocEnv (const int msgtype, const int size=0, const int prio=0, const GroupDepNum groupDepNum=GroupDepNum{})
void *	_allocMsg (const int msgtype, const int size, const int prio=0, const GroupDepNum groupDepNum=GroupDepNum{})
void	_resetEnv (envelope *env)
void	setEventID (envelope *env)
Variables
UChar	_defaultQueueing

---

Typedef Documentation

typedef unsigned int UInt

Definition at line 89 of file envelope.h.

typedef unsigned short UShort

Definition at line 90 of file envelope.h.

typedef unsigned char UChar

Definition at line 91 of file envelope.h.

---

Function Documentation

CkpvExtern	(	int	,
		envelopeEventID
	)

envelope* UsrToEnv

(

const void *const

msg

)

[inline]

Definition at line 504 of file envelope.h.

Referenced by ArrayElemExt::__AtSyncEntryMethod(), _bcastQD1(), _bcastQD2(), _handlePhase1(), _handlePhase2(), _invokeEntryNoTrace(), _prepareImmediateMsg(), _prepareMsg(), _prepareMsgBranch(), _processNewVChareMsg(), MsgPool::_reset(), _sendReadonlies(), CentralLB::ApplyDecision(), CkArrayMessage::array_element_id(), CkArrayMessage::array_ep(), CkArrayMessage::array_ep_bcast(), CkArrayMessage::array_getSrcPe(), CkArrayMessage::array_hops(), CkArrayMessage::array_ifNotThere(), CkArrayMessage::array_setIfNotThere(), CkMulticastMgr::ArraySectionSend(), NullLB::AtSync(), CkArray::broadcastHomeElements(), CkMulticastMgr::buildContributeMsg(), CkMulticastMgr::childrenReady(), CK_REDUCTION_CLIENT_DEF(), Chare::CkAddThreadListeners(), CkAllocateMarshallMsg(), CkAllocateMarshallMsgNoninline(), CkAllocateMarshallMsgT(), CkAllocBuffer(), CkArrayExtSend(), CkArrayExtSend_multi(), CkArrayManagerDeliver(), CProxy_ArrayBase::ckBroadcast(), CkCopyMsg(), CkCreateArrayExt(), CkCreateAttachedFuture(), CkCreateAttachedFutureSend(), CkCreateChare(), CkCreateGroup(), CkCreateGroupExt(), CkCreateNodeGroup(), CkMessage::ckDebugPup(), CkFreeMsg(), CkGetRefNum(), CkGetSrcPe(), CkInsertArrayExt(), CkMessageToEpIdx(), CkPackMessage(), CkPriorityPtr(), CkPupChareData(), CkPupMessage(), CkPupPerPlaceData(), CkSemaSignal(), CkSendAsyncCreateArray(), CkSendMsg(), CkSendMsgBranch(), CkSendMsgBranchImmediate(), CkSendMsgBranchInline(), CkSendMsgInline(), CkSendMsgNodeBranchImmediate(), CkSendMsgNodeBranchInline(), CkSendToFutureID(), CkSetMsgArrayIfNotThere(), CkSetQueueing(), CkSetRefNum(), CkStartQD(), CkUnpackMessage(), CkMulticastMgr::combineFrags(), CkReductionMgr::contribute(), CkMulticastMgr::contribute(), CkReductionMgr::contributeViaMessage(), CpdAfterEp(), CpdBeforeEp(), CpdPythonGroup::cpdCheck(), CpdDeliverSingleMessage(), CpdPupMessage(), CkArrayBroadcaster::deliver(), CkLocMgr::deliverAnyBufferedMsgs(), CkLocMgr::deliverMsg(), CkLocMgr::deliverUnknown(), CkLocMgr::demandCreateElement(), CkArray::demandCreateElement(), FuncCkLoop::destroyHelpers(), MeshStreamer< dtype >::flushDimension(), MeshStreamer< dtype >::flushLargestBucket(), final::getSeq(), CkMulticastMgr::GroupSectionSend(), CkArrayBroadcaster::incoming(), CkLocMgr::inform(), CentralLB::InitiateScatter(), CkLocRec::invokeEntry(), CkMemCheckPT::isMaster(), msg_prepareSend(), msg_prepareSend_noinline(), SDAG::MsgClosure::MsgClosure(), FuncCkLoop::parallelizeFunc(), printPriority(), CentralLB::printStrategyStats(), CentralLB::ProcessReceiveMigration(), QdState::propagate(), Event::pup(), SDAG::MsgClosure::pup(), CkMessage::pup(), CpdList_localQ::pup(), MeshStreamer< dtype >::receiveAlongRoute(), GroupChunkMeshStreamer< dtype, ClientType, RouterType, EntryMethod >::receiveAtDestination(), GroupMeshStreamer< dtype, ClientType, RouterType, EntryMethod >::receiveAtDestination(), CkArray::recvBroadcast(), ArrayElement::recvBroadcast(), CkMulticastMgr::recvMsg(), CkMulticastMgr::recvRedMsg(), CkMulticastMgr::reduceFragment(), CkReductionMgr::reduceMessages(), CkReductionMgr::ReductionStarting(), RegisterCkLoopHdlrs(), CentralLB::ScatterMigrationResults(), QdState::sendCount(), sendGroupMsg(), MeshStreamer< dtype >::sendLargestBuffer(), CkLocMgr::sendMsg(), sendNodeGroupMsg(), CkMulticastMgr::sendToSection(), FutureBOC::SetFuture(), SequentialSolver::setParentInfo(), ParallelSolver::setParentInfo(), FutureBOC::SetSema(), final::setSeq(), CkMulticastMgr::SimpleSend(), CkCheckPTEntry::updateBuffer(), CkDiskCheckPTInfo::updateBuffer(), Chare::~Chare(), and SDAG::MsgClosure::~MsgClosure().

void* EnvToUsr

(

const envelope *const

env

)

[inline]

Definition at line 508 of file envelope.h.

Referenced by MsgPool::_alloc(), _exitHandler(), _invokeEntryNoTrace(), _processArrayEltMsg(), _processFillVidMsg(), _processHandler(), _processRODataMsg(), _processROMsgMsg(), _qdCommHandler(), _qdHandler(), _receiveMlogLocationHandler(), _sendReadonlies(), _sendStats(), _sendWarnings(), bdcastRO(), CkAllocBuffer(), CkAllocMsg(), CkAllocSysMsg(), CkCopyMsg(), CkCreateArrayAsync(), CkPackMessage(), CkPupMessage(), CkRdmaIssueRgets(), CkRdmaPrepareBcastMsg(), CkReplaceSourcePtrsInBcastMsg(), CkUnpackMessage(), deregisterMemFromMsg(), CkArray::forwardZCMsgToOtherElems(), getParentBcastAckInfo(), getRdmaNumopsAndBufsize(), CkMemCheckPT::isMaster(), mergeStats(), mergeWarningMsg(), migrationDone(), Event::pup(), CpdList_message::pup(), CpdList_localQ::pup(), CpdList_localQ::pupSingleMessage(), CkMulticastMgr::recvPacket(), sendGroupMsg(), sendMlogLocation(), sendNodeGroupMsg(), sendRecvDoneMsgToPeers(), CkMulticastMgr::sendToSection(), CkCheckPTEntry::updateBuffer(), CkDiskCheckPTInfo::updateBuffer(), and updatePeerCounterAndPush().

Here is the caller graph for this function:

envelope* _allocEnv	(	const int	msgtype,
		const int	size = 0,
		const int	prio = 0
	)			[inline]

Definition at line 512 of file envelope.h.

Referenced by MsgPool::_alloc(), _exitHandler(), _roRdmaDoneHandler(), _sendReadonlies(), _sendStats(), _sendTriggers(), _sendWarnings(), bdcastRO(), CkAllocBuffer(), CkAllocMsg(), CkAllocSysMsg(), CkCleanup(), CkContinueExit(), CkExit(), CkPupMessage(), LibCkExit(), mergeStats(), MlogEntry::pup(), readonlyGet(), and readonlyGetCompleted().

Here is the caller graph for this function:

void* _allocMsg	(	const int	msgtype,
		const int	size,
		const int	prio = 0
	)			[inline]

Definition at line 516 of file envelope.h.

Referenced by _processNewVChareMsg(), Stats::operator new(), and Chare::~Chare().

Here is the caller graph for this function:

void _resetEnv

(

envelope *

env

)

[inline]

Definition at line 520 of file envelope.h.

References envelope::reset().

Referenced by MsgPool::_reset().

Here is the call graph for this function:

Here is the caller graph for this function:

void setEventID

(

envelope *

env

)

[inline]

Definition at line 525 of file envelope.h.

References envelope::setEvent().

Referenced by _prepareMsg(), and _prepareMsgBranch().

Here is the call graph for this function:

Here is the caller graph for this function:

void CkPackMessage

(

envelope **

pEnv

)

Definition at line 1363 of file ck.C.

References _msgTable, EnvToUsr(), envelope::getMsgIdx(), envelope::isPacked(), msg, envelope::setPacked(), and UsrToEnv().

Referenced by _createGroup(), _createNodeGroup(), _infoFn(), _noCldEnqueue(), _noCldEnqueueMulti(), _noCldNodeEnqueue(), _sendReadonlies(), _skipCldEnqueue(), CkPupMessage(), CkRdmaEMBcastAckHandler(), CkRdmaIssueRgets(), CkRdmaPrepareBcastMsg(), CkReplaceSourcePtrsInBcastMsg(), CkSendAsyncCreateArray(), deregisterMemFromMsg(), CkMemCheckPT::isMaster(), CkMessageReplay::isNext(), CkMessageReplay::process(), CkMessageDetailRecorder::process(), CkMessageRecorder::process(), processBcastSendEmApiCompletion(), sendMlogLocation(), sendRecvDoneMsgToPeers(), CkMulticastMgr::sendToSection(), and updatePeerCounterAndPush().

Here is the call graph for this function:

Here is the caller graph for this function:

void CkUnpackMessage

(

envelope **

pEnv

)

Definition at line 1377 of file ck.C.

References _msgTable, EnvToUsr(), envelope::getMsgIdx(), envelope::isPacked(), msg, envelope::setPacked(), and UsrToEnv().

Referenced by _createGroup(), _createNodeGroup(), _initHandler(), _processBufferedBocInits(), _processBufferedNodeBocInits(), _processHandler(), _receiveMlogLocationHandler(), _sendReadonlies(), CkCreateArrayAsync(), CkPupMessage(), CkRdmaEMBcastAckHandler(), CkRdmaIssueRgets(), CkRdmaPrepareBcastMsg(), CkReplaceSourcePtrsInBcastMsg(), CkSendMsgInline(), deregisterMemFromMsg(), CkMemCheckPT::isMaster(), CkMessageReplay::isNext(), CkMessageReplay::process(), CkMessageDetailRecorder::process(), CkMessageRecorder::process(), processBcastSendEmApiCompletion(), CpdList_localQ::pup(), CpdList_localQ::pupSingleMessage(), CkMulticastMgr::recvPacket(), sendRecvDoneMsgToPeers(), CkMulticastMgr::sendToSection(), CkCheckPTEntry::updateBuffer(), CkDiskCheckPTInfo::updateBuffer(), and updatePeerCounterAndPush().

Here is the call graph for this function:

Here is the caller graph for this function:

CkpvExtern	(	MsgPool *	,
		_msgPool
	)