Adding support for causal message logging.
[charm.git] / src / ck-core / envelope.h
1 /**
2  @defgroup CkEnvelope
3  \brief  Charm++ message header.
4 */
5 #ifndef _ENVELOPE_H
6 #define _ENVELOPE_H
7
8 #ifndef CkIntbits
9 #define CkIntbits (sizeof(int)*8)
10 #endif
11
12 #if CMK_ERROR_CHECKING
13 #define _SET_USED(env, x) (env)->setUsed((x))
14 #define _CHECK_USED(env) do { if(env->isUsed()) \
15                            CmiAbort("Message being re-sent. Aborting...\n"); \
16                          } while(0)
17 #else
18 #define _SET_USED(env, x) do{}while(0)
19 #define _CHECK_USED(env) do{}while(0)
20 #endif
21
22 #define CkMsgAlignmentMask     (sizeof(double)-1)
23 #define CkMsgAlignLength(x) (((x)+CkMsgAlignmentMask)&(~(CkMsgAlignmentMask)))
24 #define CkMsgAlignOffset(x)     (CkMsgAlignLength(x)-(x))
25 #define CkPriobitsToInts(nBits)    ((nBits+CkIntbits-1)/CkIntbits)
26 // silly ancient name: for backward compatability only.
27 #define PW(x) CkPriobitsToInts(x) 
28
29
30
31 //#define USE_CRITICAL_PATH_HEADER_ARRAY
32
33 /**
34     \addtogroup CriticalPathFramework 
35     @{
36 */
37
38 /** A class that is used to track the entry points and other information 
39     about a critical path as a charm++ program executes.
40
41     This class won't do useful things unless USE_CRITICAL_PATH_HEADER_ARRAY is defined
42 */
43 class PathHistoryEnvelope {
44  protected:
45   // When passing paths forward, store information on PEs, in backward pass, lookup necessary information
46   int sender_history_table_idx;
47   double totalTime;
48  public:
49   double getTotalTime() const{ return totalTime; }
50   int get_sender_history_table_idx() const{ return sender_history_table_idx; }
51   void set_sender_history_table_idx(int i) { sender_history_table_idx = i; }
52   PathHistoryEnvelope(){ 
53 #ifdef USE_CRITICAL_PATH_HEADER_ARRAY
54     reset(); 
55 #endif
56   }
57   double getTime() const{ return totalTime; }
58   void setTime(double t){ totalTime = t; }
59   void pup(PUP::er &p) {
60     p | sender_history_table_idx;
61     p | totalTime;
62   } 
63   void reset();
64   void print() const;
65   /// Write a description of the path into the beginning of the provided buffer. The buffer ought to be large enough.
66   void printHTMLToString(char* buf) const{
67     buf[0] = '\0';
68     sprintf(buf+strlen(buf), "Path Time=%lf<br> Sender idx=%d", (double)totalTime, (int)sender_history_table_idx);
69   }
70   /// The number of available EP counts 
71   int getNumUsed() const;
72   /// Return the count value for the idx'th available EP  
73   int getUsedCount(int idx) const;
74   /// Return the idx'th available EP 
75   int getUsedEp(int idx) const;
76   int getEpCount(int ep) const;
77   void incrementTotalTime(double time);
78   //  void createPath(envelope *originatingMsg);
79   void setDebug100();
80 };
81 /** @} */
82
83
84
85 typedef unsigned int   UInt;
86 typedef unsigned short UShort;
87 typedef unsigned char  UChar;
88
89 #include "charm.h" // for CkGroupID, and CkEnvelopeType
90 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
91 #include "ckobjid.h" //for the ckobjId
92 #endif
93
94 /**
95 @addtogroup CkEnvelope
96 */
97
98 CkpvExtern(int, envelopeEventID);
99
100 /**
101 @{
102 The class envelope defines a Charm++ message's header. The first
103 'CmiReservedHeaderSize' bytes of memory is exclusively reserved for Converse
104 header, which is defined in convere.h and platform specific config files.
105
106 After Charm++ envelope comes the payload, i.e. a variable-length amount of user
107 data. Following the user data, optionally, a variable number of bits of
108 priority data can be stored at the end. Function
109 envelope::alloc(msgtype,size,prio) is always used to allocate the whole
110 message. Note that this memory layout must be observed.
111
112 The following are a few terms that are used often:
113
114 <pre>
115  Envelope pointer        \
116  Converse message pointer -> [ [ Converse envelope ]       ]
117                              [       Charm envelope        ] 
118  User message pointer     -> [ User data/payload ... ]
119  Priority pointer         -> [ Priority ints ... ]
120 </pre>
121
122 The "message pointers" passed to and from users bypass the envelope and point
123 *directly* to the user data--the routine "EnvToUsr" below adjusts an envelope
124 (or converse message) pointer into this user message pointer.  There is a
125 corresponding routine "UsrToEnv" which takes the user data pointer and returns
126 a pointer to the envelope/converse message.
127
128 Unfortunately, in the guts of Charm++ it's not always clear whether you've been
129 given a converse or user message pointer, as both tend to be passed as void *.
130 Confusing the two will invariably result in data corruption and bizarre
131 crashes.
132
133 FIXME: Make CkMessage inherit from envelope,
134 which would unify converse, envelope, and 
135 user message pointers.
136 */
137 class envelope {
138   private:
139     /// Converse message envelope, Must be first field in this class
140     char   core[CmiReservedHeaderSize];
141 public:
142  /**
143    This union stores the type-specific message information.
144    Keeping this in a union allows the different kinds of messages 
145    to have different fields/types, in an alignment-safe way, 
146    without wasting any storage.
147  */
148     union u_type {
149       struct s_chare {  // NewChareMsg, NewVChareMsg, ForChareMsg, ForVidMsg, FillVidMsg
150         void *ptr;      ///< object pointer
151         UInt forAnyPe;  ///< Used only by newChare
152         int  bype;      ///< created by this pe
153       } chare;
154       struct s_group {         // NodeBocInitMsg, BocInitMsg, ForNodeBocMsg, ForBocMsg
155         CkGroupID g;           ///< GroupID
156         CkNodeGroupID rednMgr; ///< Reduction manager for this group (constructor only!)
157         CkGroupID dep;         ///< create after dep is created (constructor only!)
158         int epoch;             ///< "epoch" this group was created during (0--mainchare, 1--later)
159         UShort arrayEp;        ///< Used only for array broadcasts
160       } group;
161       struct s_array{             ///< For arrays only (ArrayEltInitMsg, ForArrayEltMsg)
162         CkArrayIndexBase index; ///< Array element index
163         int listenerData[CK_ARRAYLISTENER_MAXLEN]; ///< For creation
164         CkGroupID arr;            ///< Array manager GID
165         UChar hopCount;           ///< number of times message has been routed
166         UChar ifNotThere;         ///< what to do if array element is missing
167       } array;
168       struct s_roData {    ///< RODataMsg for readonly data type
169         UInt count;
170       } roData;
171       struct s_roMsg {     ///< ROMsgMsg for readonlys defined in ci files
172         UInt roIdx;
173       } roMsg;
174     };
175     struct s_attribs {  // Packed bitwise struct
176       UChar msgIdx;     ///< Usertype of message (determines pack routine)
177       UChar mtype;      ///< e.g., ForBocMsg
178       UChar queueing:4; ///< Queueing strategy (FIFO, LIFO, PFIFO, ...)
179       UChar isPacked:1; ///< If true, message must be unpacked before use
180       UChar isUsed:1;   ///< Marker bit to prevent message re-send.
181     };
182 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
183     CkObjID sender;
184     CkObjID recver;
185     MCount SN;
186     MCount TN;
187         int incarnation;
188     MlogEntry *localMlogEntry;
189     bool freeMsg;
190 #endif
191 private:
192     u_type type;           ///< Depends on message type (attribs.mtype)
193     CMK_REFNUM_TYPE ref;            ///< Used by futures
194     s_attribs attribs;
195     UChar align[CkMsgAlignOffset(CmiReservedHeaderSize+sizeof(u_type)+sizeof(CMK_REFNUM_TYPE)+sizeof(s_attribs))];    ///< padding to make sure sizeof(double) alignment
196     
197     //This struct should now be sizeof(void*) aligned.
198     UShort priobits;   ///< Number of bits of priority data after user data
199     UShort epIdx;      ///< Entry point to call
200     UInt   pe;         ///< source processor
201     UInt   event;      ///< used by projections
202     UInt   totalsize;  ///< Byte count from envelope start to end of priobits
203     
204   public:
205 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
206     UInt piggyBcastIdx;
207 #endif
208     void pup(PUP::er &p);
209     UInt   getEvent(void) const { return event; }
210     void   setEvent(const UInt e) { event = e; }
211     CMK_REFNUM_TYPE   getRef(void) const { return ref; }
212     void   setRef(const CMK_REFNUM_TYPE r) { ref = r; }
213     UChar  getQueueing(void) const { return attribs.queueing; }
214     void   setQueueing(const UChar q) { attribs.queueing=q; }
215     UChar  getMsgtype(void) const { return attribs.mtype; }
216     void   setMsgtype(const UChar m) { attribs.mtype = m; }
217 #if CMK_ERROR_CHECKING
218     UChar  isUsed(void) { return attribs.isUsed; }
219     void   setUsed(const UChar u) { attribs.isUsed=u; }
220 #else /* CMK_ERROR_CHECKING */
221     inline void setUsed(const UChar u) {}
222 #endif
223     UChar  getMsgIdx(void) const { return attribs.msgIdx; }
224     void   setMsgIdx(const UChar idx) { attribs.msgIdx = idx; }
225     UInt   getTotalsize(void) const { return totalsize; }
226     void   setTotalsize(const UInt s) { totalsize = s; }
227     UInt   getUsersize(void) const { return totalsize - priobits - sizeof(envelope); }
228     UChar  isPacked(void) const { return attribs.isPacked; }
229     void   setPacked(const UChar p) { attribs.isPacked = p; }
230     UShort getPriobits(void) const { return priobits; }
231     void   setPriobits(const UShort p) { priobits = p; }
232     UShort getPrioWords(void) const { return CkPriobitsToInts(priobits); }
233     UShort getPrioBytes(void) const { return getPrioWords()*sizeof(int); }
234     void*  getPrioPtr(void) const { 
235       return (void *)((char *)this + totalsize - getPrioBytes());
236     }
237     static envelope *alloc(const UChar type, const UInt size=0, const UShort prio=0)
238     {
239       CkAssert(type>=NewChareMsg && type<=ForArrayEltMsg);
240       register UInt tsize = sizeof(envelope)+ 
241             CkMsgAlignLength(size)+
242             sizeof(int)*CkPriobitsToInts(prio);
243       register envelope *env = (envelope *)CmiAlloc(tsize);
244 #if CMK_REPLAYSYSTEM
245       //for record-replay
246       memset(env, 0, sizeof(envelope));
247       env->setEvent(++CkpvAccess(envelopeEventID));
248 #endif
249       env->setMsgtype(type);
250       env->totalsize = tsize;
251       env->priobits = prio;
252       env->setPacked(0);
253       env->type.group.dep.setZero();
254       _SET_USED(env, 0);
255       env->setRef(0);
256       env->setEpIdx(0);
257
258 #ifdef USE_CRITICAL_PATH_HEADER_ARRAY
259       env->pathHistory.reset();
260 #endif
261
262 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
263       env->sender.type = TypeInvalid;
264       env->recver.type = TypeInvalid;
265       env->SN = 0;
266       env->TN = 0;
267           env->incarnation = -1;
268       env->localMlogEntry = NULL;
269 #endif
270
271       return env;
272     }
273     void reset() {
274 #if CMK_REPLAYSYSTEM
275       setEvent(++CkpvAccess(envelopeEventID));
276 #endif
277       type.group.dep.setZero();
278     }
279     UShort getEpIdx(void) const { return epIdx; }
280     void   setEpIdx(const UShort idx) { epIdx = idx; }
281     UInt   getSrcPe(void) const { return pe; }
282     void   setSrcPe(const UInt s) { pe = s; }
283     static void setSrcPe(char *env, const UInt s) { ((envelope*)env)->setSrcPe(s); }
284
285 // Readonly-specific fields
286     UInt   getCount(void) const { 
287       CkAssert(getMsgtype()==RODataMsg); return type.roData.count; 
288     }
289     void   setCount(const UInt c) { 
290       CkAssert(getMsgtype()==RODataMsg); type.roData.count = c; 
291     }
292     UInt   getRoIdx(void) const { 
293       CkAssert(getMsgtype()==ROMsgMsg); return type.roMsg.roIdx; 
294     }
295     void   setRoIdx(const UInt r) { 
296       CkAssert(getMsgtype()==ROMsgMsg); type.roMsg.roIdx = r; 
297     }
298     
299  // Chare-specific fields
300     UInt isForAnyPE(void) { 
301       CkAssert(getMsgtype()==NewChareMsg || getMsgtype()==NewVChareMsg); 
302       return type.chare.forAnyPe; 
303     }
304     void setForAnyPE(UInt f) { 
305       CkAssert(getMsgtype()==NewChareMsg || getMsgtype()==NewVChareMsg); 
306       type.chare.forAnyPe = f; 
307     }
308     void*  getVidPtr(void) const {
309       CkAssert(getMsgtype()==NewVChareMsg || getMsgtype()==ForVidMsg
310           || getMsgtype()==FillVidMsg ||  getMsgtype()==DeleteVidMsg);
311       return type.chare.ptr;
312     }
313     void   setVidPtr(void *p) {
314       CkAssert(getMsgtype()==NewVChareMsg || getMsgtype()==ForVidMsg
315           || getMsgtype()==FillVidMsg ||  getMsgtype()==DeleteVidMsg);
316       type.chare.ptr = p;
317     }
318     void*  getObjPtr(void) const { 
319       CkAssert(getMsgtype()==ForChareMsg); return type.chare.ptr; 
320     }
321     void   setObjPtr(void *p) { 
322       CkAssert(getMsgtype()==ForChareMsg); type.chare.ptr = p; 
323     }
324     UInt getByPe(void) { 
325       CkAssert(getMsgtype()==NewChareMsg || getMsgtype()==NewVChareMsg); 
326       return type.chare.bype; 
327     }
328     void setByPe(UInt pe) { 
329       CkAssert(getMsgtype()==NewChareMsg || getMsgtype()==NewVChareMsg); 
330       type.chare.bype = pe; 
331     }
332
333 // Group-specific fields
334     CkGroupID   getGroupNum(void) const {
335       CkAssert(getMsgtype()==BocInitMsg || getMsgtype()==ForBocMsg
336           || getMsgtype()==NodeBocInitMsg || getMsgtype()==ForNodeBocMsg);
337       return type.group.g;
338     }
339     void   setGroupNum(const CkGroupID g) {
340       CkAssert(getMsgtype()==BocInitMsg || getMsgtype()==ForBocMsg
341           || getMsgtype()==NodeBocInitMsg || getMsgtype()==ForNodeBocMsg);
342       type.group.g = g;
343     }
344     void setGroupEpoch(int epoch) { type.group.epoch=epoch; }
345     int getGroupEpoch(void) { return type.group.epoch; }
346     void setRednMgr(CkNodeGroupID r){ type.group.rednMgr = r; }
347     CkNodeGroupID getRednMgr(){ return type.group.rednMgr; }
348     CkGroupID getGroupDep(){ return type.group.dep; }
349     void setGroupDep(const CkGroupID &r){ type.group.dep = r; }
350
351 // Array-specific fields
352     CkGroupID &getsetArrayMgr(void) {return type.array.arr;}
353     int getArrayMgrIdx(void) const {return type.array.arr.idx;}
354     UShort &getsetArrayEp(void) {return epIdx;}
355     UShort &getsetArrayBcastEp(void) {return type.group.arrayEp;}
356     UInt &getsetArraySrcPe(void) {return pe;}
357     UChar &getsetArrayHops(void) {return type.array.hopCount;}
358     int getArrayIfNotThere(void) {return type.array.ifNotThere;}
359     void setArrayIfNotThere(int nt) {type.array.ifNotThere=nt;}
360     int *getsetArrayListenerData(void) {return type.array.listenerData;}
361     CkArrayIndex &getsetArrayIndex(void) 
362         {return *(CkArrayIndex *)&type.array.index;}
363
364 #ifdef USE_CRITICAL_PATH_HEADER_ARRAY
365  public:
366     /** The information regarding the entry methods that executed along the path to this one.
367         \addtogroup CriticalPathFramework
368     */
369     PathHistoryEnvelope pathHistory;
370 #endif
371
372 };
373
374
375 inline envelope *UsrToEnv(const void *const msg) {
376   return (((envelope *) msg)-1);
377 }
378
379 inline void *EnvToUsr(const envelope *const env) {
380   return ((void *)(env+1));
381 }
382
383 inline envelope *_allocEnv(const int msgtype, const int size=0, const int prio=0) {
384   return envelope::alloc(msgtype,size,prio);
385 }
386
387 inline void *_allocMsg(const int msgtype, const int size, const int prio=0) {
388   return EnvToUsr(envelope::alloc(msgtype,size,prio));
389 }
390
391 inline void _resetEnv(envelope *env) {
392   env->reset();
393 }
394
395 inline void setEventID(envelope *env){
396   env->setEvent(++CkpvAccess(envelopeEventID));
397 }
398
399 /** @} */
400
401 extern UChar   _defaultQueueing;
402
403 extern void CkPackMessage(envelope **pEnv);
404 extern void CkUnpackMessage(envelope **pEnv);
405
406 class MsgPool: public SafePool<void *> {
407 private:
408     static void *_alloc(void) {
409       /* CkAllocSysMsg() called in .def.h is not thread of sigio safe */
410       register envelope *env = _allocEnv(ForChareMsg,0,0);
411       env->setQueueing(_defaultQueueing);
412       env->setMsgIdx(0);
413       return EnvToUsr(env);
414     }
415     static void _reset(void* m) {
416       register envelope *env = UsrToEnv(m);
417       _resetEnv(env);
418     }
419 public:
420     MsgPool():SafePool<void*>(_alloc, CkFreeMsg, _reset) {}
421 #if (defined(_FAULT_MLOG_) || defined(_FAULT_CAUSAL_))
422         void *get(void){
423             return allocfn();
424         }
425         void put(void *m){
426         }
427 #endif
428 };
429
430 CkpvExtern(MsgPool*, _msgPool);
431
432 #endif