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