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