f27f5722fd7320fc41ee2e203cb299ab8e306c57
[charm.git] / src / ck-core / debug-charm.C
1 /*****************************************************************************
2  * A few useful built-in CPD and CCS handlers.
3  *****************************************************************************/
4
5 #include "converse.h"
6
7 #include <errno.h>
8 #include <string.h>
9 #include <sys/stat.h>           // for chmod
10
11 #include "ckhashtable.h"
12 #include "conv-ccs.h"
13 #include "debug-charm.h"
14 #include "sockRoutines.h"
15 #include "charm.h"
16 #include "middle.h"
17 #include "cklists.h"
18 #include "register.h"
19 //#include "queueing.h"
20 #include <unistd.h>
21
22
23 #if CMK_CHARMDEBUG && CMK_CCS_AVAILABLE && !defined(_WIN32)
24
25 #include "ck.h"
26
27 CkpvDeclare(int, skipBreakpoint); /* This is a counter of how many breakpoints we should skip */
28 CkpvDeclare(DebugEntryTable, _debugEntryTable);
29 CpdPersistentChecker persistentCheckerUselessClass;
30
31 void CpdFinishInitialization() {
32   CkpvInitialize(int, skipBreakpoint);
33   CkpvAccess(skipBreakpoint) = 0;
34   CkpvInitialize(DebugEntryTable, _debugEntryTable);
35   CkpvAccess(_debugEntryTable).resize(_entryTable.size());
36 }
37
38 extern "C" void resetAllCRC();
39 extern "C" void checkAllCRC(int report);
40
41 typedef struct DebugRecursiveEntry {
42   int previousChareID;
43   int alreadyUserCode;
44   char *memoryBackup;
45   void *obj;
46   void *msg;
47 } DebugRecursiveEntry;
48
49 CkQ<DebugRecursiveEntry> _debugData;
50
51 void *CpdGetCurrentObject() { return _debugData.peek().obj; }
52 void *CpdGetCurrentMsg() { return _debugData.peek().msg; }
53
54 extern int cpdInSystem;
55 extern "C" int CpdInUserCode() {return cpdInSystem==0 && _debugData.length()>0 && _debugData.peek().alreadyUserCode==1;}
56
57 // Function called right before an entry method
58 void CpdBeforeEp(int ep, void *obj, void *msg) {
59 #ifndef CMK_OPTIMIZE
60   if (CpvAccess(cmiArgDebugFlag)) {
61     DebugRecursiveEntry entry;
62     entry.previousChareID = setMemoryChareIDFromPtr(obj);
63     entry.alreadyUserCode = _entryTable[ep]->inCharm ? 0 : 1;
64     entry.memoryBackup = NULL;
65     entry.obj = obj;
66     if (msg != NULL) {
67       entry.msg = msg;
68       CmiReference(UsrToEnv(msg));
69     }
70     else entry.msg = NULL;
71     _debugData.push(entry);
72     setMemoryStatus(entry.alreadyUserCode);
73     //if (CkpvAccess(_debugEntryTable)[ep].isBreakpoint) printf("CpdBeforeEp breakpointed %d\n",ep);
74     memoryBackup = &_debugData.peek().memoryBackup;
75     if (!_entryTable[ep]->inCharm) {
76       CpdResetMemory();
77     }
78     CkVec<DebugPersistentCheck> &preExecutes = CkpvAccess(_debugEntryTable)[ep].preProcess;
79     for (int i=0; i<preExecutes.size(); ++i) {
80       preExecutes[i].object->cpdCheck(preExecutes[i].msg);
81     }
82   }
83 #endif
84 }
85
86 // Function called right after an entry method
87 void CpdAfterEp(int ep) {
88 #ifndef CMK_OPTIMIZE
89   if (CpvAccess(cmiArgDebugFlag)) {
90     DebugRecursiveEntry entry = _debugData.peek();
91     CkVec<DebugPersistentCheck> &postExecutes = CkpvAccess(_debugEntryTable)[ep].postProcess;
92     for (int i=0; i<postExecutes.size(); ++i) {
93       postExecutes[i].object->cpdCheck(postExecutes[i].msg);
94     }
95     memoryBackup = &entry.memoryBackup;
96     if (!_entryTable[ep]->inCharm) {
97       CpdCheckMemory();
98     }
99     if (entry.msg != NULL) CmiFree(UsrToEnv(entry.msg));
100     setMemoryChareID(entry.previousChareID);
101     setMemoryStatus(entry.alreadyUserCode);
102     _debugData.deq();
103   }
104 #endif
105 }
106
107 /************ Array Element CPD Lists ****************/
108
109 /**
110   Count array elements going by until they reach this
111   range (lo to hi), then start passing them to dest.
112 */
113 template <class T>
114 class CkArrayElementRangeIterator : public CkLocIterator {
115 private:
116    T *dest;
117    CkArray *mgr;
118    int cur,lo,hi;
119 public:
120    CkArrayElementRangeIterator(T *dest_,int l,int h)
121         :dest(dest_),mgr(0),cur(0),lo(l),hi(h) {}
122
123   /** Called to iterate only on a specific array manager.
124       Returs the number of objects it iterate on.
125   */
126   int iterate(int start, CkArray *m) {
127     cur = start;
128     mgr = m;
129     mgr->getLocMgr()->iterate(*this);
130     cur -= start;
131     return cur;
132   }
133
134    /** Call add for every in-range array element on this processor */
135    void iterate(void)
136    { /* Walk the groupTable for arrays (FIXME: get rid of _groupIDTable) */
137      int numGroups=CkpvAccess(_groupIDTable)->size();
138      for(int i=0;i<numGroups;i++) {
139         IrrGroup *obj = CkpvAccess(_groupTable)->find((*CkpvAccess(_groupIDTable))[i]).getObj();
140         if (obj->isArrMgr())
141         { /* This is an array manager: examine its array elements */
142           mgr=(CkArray *)obj;
143           mgr->getLocMgr()->iterate(*this);
144         }
145      }
146    }
147
148    // Called by location manager's iterate function
149    virtual void addLocation (CkLocation &loc)
150    {
151      if (cur>=lo && cur<hi)
152      { /* This element is in our range-- look it up */
153        dest->add(cur,mgr->lookup(loc.getIndex()),mgr->getGroupID().idx);
154      }
155      cur++;
156    }
157
158    // Return the number of total array elements seen so far.
159    int getCount(void) {return cur;}
160 };
161
162 /**
163   Count charm++ objects going by until they reach this
164   range (lo to hi), then start passing them to dest.
165 */
166 template <class T>
167 class CkObjectRangeIterator {
168 private:
169    T *dest;
170    int cur,lo,hi;
171 public:
172    CkObjectRangeIterator(T *dest_,int l,int h)
173         :dest(dest_),cur(0),lo(l),hi(h) {}
174
175    /** Call add for every in-range array element on this processor */
176    void iterate(void)
177    { /* Walk the groupTable for arrays (FIXME: get rid of _groupIDTable) */
178      int numGroups=CkpvAccess(_groupIDTable)->size();
179      for(int i=0;i<numGroups;i++) {
180        CkGroupID groupID = (*CkpvAccess(_groupIDTable))[i];
181         IrrGroup *obj = CkpvAccess(_groupTable)->find(groupID).getObj();
182         /*if (obj->isArrMgr())
183         { / * This is an array manager: examine its array elements * /
184           CkArray *mgr=(CkArray *)obj;
185           CkArrayElementRangeIterator<T> ait(dest,lo,hi);
186           ait.iterate(cur, mgr);
187           cur+=ait.getCount();
188         } else {*/
189           dest->add(cur,obj,groupID.idx);
190           cur++;
191         //}
192      }
193    }
194
195    // Return the number of total array elements seen so far.
196    int getCount(void) {return cur;}
197 };
198
199 class ignoreAdd {
200 public: void add(int cur,Chare *elt,int group) {}
201 };
202
203 /** Examine all the objects on the server returning the name */
204 class CpdList_objectNames : public CpdListAccessor {
205   PUP::er *pp; // Only used while inside pup routine.
206   int curGroup;
207 public:
208   virtual const char * getPath(void) const {return "charm/objectNames";}
209   virtual size_t getLength(void) const {
210     CkObjectRangeIterator<ignoreAdd> it(0,0,0);
211     it.iterate();
212     return it.getCount();
213   }
214   virtual void pup(PUP::er &p, CpdListItemsRequest &req) {
215     pp=&p;
216     CkObjectRangeIterator<CpdList_objectNames> it(this,req.lo,req.hi);
217     it.iterate(); // calls "add" for in-range elements
218   }
219   void add(int cur, Chare *obj, int group) {
220     PUP::er &p=*pp;
221     beginItem(p,cur);
222     p.comment("id");
223     char *n = (char*)malloc(30);
224     int s=obj->ckDebugChareID(n, 30);
225     CkAssert(s > 0);
226     p(n,s);
227     free(n);
228     PUPn(group);
229     p.comment("name");
230     n=obj->ckDebugChareName();
231     p(n,strlen(n));
232     free(n);
233   }
234 };
235
236 /** Examine a single object identified by the id passed in the request and
237     return its type and memory data */
238 class CpdList_object : public CpdListAccessor {
239   PUP::er *pp; //Only used while inside pup routine.
240   CpdListItemsRequest *reqq; // Only used while inside pup routine.
241 public:
242   virtual const char * getPath(void) const {return "charm/object";}
243   virtual size_t getLength(void) const {
244     CkObjectRangeIterator<ignoreAdd> it(0,0,0);
245     it.iterate();
246     return it.getCount();
247   }
248   virtual void pup(PUP::er &p, CpdListItemsRequest &req) {
249     pp=&p;
250     reqq=&req;
251     CkObjectRangeIterator<CpdList_object> it(this,req.lo,req.hi);
252     it.iterate(); // calls "add" for in-range elements;
253   }
254   void add(int cur, Chare *obj, int group) {
255     PUP::er &p=*pp;
256     CpdListItemsRequest &req=*reqq;
257     char *n = (char *)malloc(30);
258     int s=obj->ckDebugChareID(n, 30);
259     CkAssert(s > 0);
260     if (req.extraLen == s && memcmp(req.extra, n, s) == 0) {
261       // the object match, found!
262       beginItem(p,cur);
263       int type = obj->ckGetChareType();
264       p.comment("type");
265       const char *t = _chareTable[type]->name;
266       p((char*)t,strlen(t));
267       p.comment("value");
268       int size = _chareTable[type]->size;
269       p((char*)obj,size);
270     }
271   }
272 };
273
274 /** Coarse: examine array element names */
275 class CpdList_arrayElementNames : public CpdListAccessor {
276   PUP::er *pp; // Only used while inside pup routine.
277 public:
278   virtual const char * getPath(void) const {return "charm/arrayElementNames";}
279   virtual size_t getLength(void) const {
280     CkArrayElementRangeIterator<ignoreAdd> it(0,0,0);
281     it.iterate();
282     return it.getCount();
283   }
284   virtual void pup(PUP::er &p, CpdListItemsRequest &req) {
285     pp=&p;
286     CkArrayElementRangeIterator<CpdList_arrayElementNames> it(this,req.lo,req.hi);
287     it.iterate(); // calls "add" for in-range elements
288   }
289   void add(int cur,Chare *e,int group)
290   { // Just grab the name and nothing else:
291     ArrayElement *elt = (ArrayElement*)e;
292          PUP::er &p=*pp;
293          beginItem(p,cur);
294          p.comment("name");
295          char *n=elt->ckDebugChareName();
296          p(n,strlen(n));
297          free(n);
298   }
299 };
300
301 /** Detailed: examine array element data */
302 class CpdList_arrayElements : public CpdListAccessor {
303   PUP::er *pp; // Only used while inside pup routine.
304 public:
305   virtual const char * getPath(void) const {return "charm/arrayElements";}
306   virtual size_t getLength(void) const {
307     CkArrayElementRangeIterator<ignoreAdd> it(0,0,0);
308     it.iterate();
309     return it.getCount();
310   }
311   virtual void pup(PUP::er &p, CpdListItemsRequest &req) {
312     pp=&p;
313     CkArrayElementRangeIterator<CpdList_arrayElements> it(this,req.lo,req.hi);
314     it.iterate(); // calls "add" for in-range elements
315   }
316   void add(int cur, Chare *e, int group)
317   { // Pup the element data
318     ArrayElement *elt = (ArrayElement*)e;
319     PUP::er &p=*pp;
320     beginItem(p,cur);
321     //elt->ckDebugPup(p);
322     // Now ignore any pupper, just copy all the memory as raw data
323     p.comment("name");
324     char *n=elt->ckDebugChareName();
325     p(n,strlen(n));
326     free(n);
327     int type = elt->ckGetChareType();
328     p.comment("type");
329     const char *t = _chareTable[type]->name;
330     p((char*)t,strlen(t));
331     p.comment("value");
332     int size = _chareTable[type]->size;
333     p((char*)elt,size);
334   }
335 };
336
337 #ifndef __CYGWIN__
338 #include <rpc/rpc.h>
339 #endif
340
341 size_t hostInfoLength(void *) {return 1;}
342
343 void hostInfo(void *itemIter, pup_er pp, CpdListItemsRequest *req) {
344   PUP::er &p = *(PUP::er *)pp;
345   struct sockaddr_in addr;
346   CpdListBeginItem(pp, 0);
347 #if CMK_HAS_GET_MYADDRESS
348   get_myaddress(&addr);
349 #else
350   CmiAbort("hostInfo: get_myaddress does not work on this machine");
351 #endif
352   char *address = (char*)&addr.sin_addr.s_addr;
353   PUPv(address, 4);
354   int pid = getpid();
355   PUPn(pid);
356 }
357
358 /************ Message CPD Lists ****************/
359 CkpvExtern(void *,debugQueue);
360
361 // Interpret data in a message in a user-friendly way.
362 //  Ignores most of the envelope fields used by CkPupMessage,
363 //  and instead concentrates on user data
364 void CpdPupMessage(PUP::er &p, void *msg)
365 {
366   envelope *env=UsrToEnv(msg);
367   //int wasPacked=env->isPacked();
368   int size=env->getTotalsize();
369   int prioBits=env->getPriobits();
370   int from=env->getSrcPe();
371   PUPn(from);
372   //PUPn(wasPacked);
373   PUPn(prioBits);
374   int userSize=size-sizeof(envelope)-sizeof(int)*CkPriobitsToInts(prioBits);
375   PUPn(userSize);
376   int msgType = env->getMsgIdx();
377   PUPn(msgType);
378   int envType = env->getMsgtype();
379   PUPn(envType);
380
381   //p.synchronize(PUP::sync_last_system);
382
383   int ep=CkMessageToEpIdx(msg);
384   PUPn(ep);
385
386   // Pup the information specific to this envelope type
387   if (envType == ForArrayEltMsg || envType == ArrayEltInitMsg) {
388     int arrID = env->getsetArrayMgr().idx;
389     PUPn(arrID);
390     CkArrayIndexStruct &idx = *(CkArrayIndexStruct *)&env->getsetArrayIndex();
391     int nInts = idx.nInts;
392     int dimension = idx.dimension;
393     PUPn(nInts);
394     PUPn(dimension);
395     p.comment("index");
396     if (dimension >=4 && dimension <=6) {
397       p((short int *)idx.index, dimension);
398     } else {
399       p(idx.index, nInts);
400     }
401   } else if (envType == BocInitMsg || envType == NodeBocInitMsg ||
402              envType == ForNodeBocMsg || envType == ForBocMsg) {
403     int groupID = env->getGroupNum().idx;
404     PUPn(groupID);
405   } else if (envType == NewVChareMsg || envType == ForVidMsg || envType == FillVidMsg) {
406     p.comment("ptr");
407     void *ptr = env->getVidPtr();
408     pup_pointer(&p, &ptr);
409   } else if (envType == ForChareMsg) {
410     p.comment("ptr");
411     void *ptr = env->getObjPtr();
412     pup_pointer(&p, &ptr);
413   }
414   
415   /* user data */
416   p.comment("data");
417   p.synchronize(PUP::sync_begin_object);
418   if (_entryTable[ep]->messagePup!=NULL)
419     _entryTable[ep]->messagePup(p,msg);
420   else
421     CkMessage::ckDebugPup(p,msg);
422   p.synchronize(PUP::sync_end_object);
423 }
424
425 CkpvStaticDeclare(void *, lastBreakPointMsg);
426 int conditionalPipe[2] = {0, 0};
427 CkpvDeclare(void*, conditionalQueue);
428
429
430 //Cpd Lists for local and scheduler queues
431 class CpdList_localQ : public CpdListAccessor {
432
433 public:
434   CpdList_localQ() {}
435   virtual const char * getPath(void) const {return "converse/localqueue";}
436   virtual size_t getLength(void) const {
437     int x = CdsFifo_Length((CdsFifo)(CkpvAccess(debugQueue)));
438     //CmiPrintf("*******Returning fifo length %d*********\n", x);
439     //return CdsFifo_Length((CdsFifo)(CpvAccess(CmiLocalQueue)));
440     if (CkpvAccess(lastBreakPointMsg) != NULL) x++;
441     return x;
442   }
443   virtual void pup(PUP::er &p, CpdListItemsRequest &req) {
444     int length;
445     void ** messages;
446     int curObj=0;
447     void *msg;
448
449     length = CdsFifo_Length((CdsFifo)(CkpvAccess(conditionalQueue)));
450     messages = CdsFifo_Enumerate(CkpvAccess(conditionalQueue));
451     for (curObj=-length; curObj<0; curObj++) {
452       void *msg = messages[length+curObj];
453       pupSingleMessage(p, curObj-1, msg);
454     }
455     delete[] messages;
456     
457     curObj = 0;
458     length = CdsFifo_Length((CdsFifo)(CkpvAccess(debugQueue)));
459     messages = CdsFifo_Enumerate(CkpvAccess(debugQueue));
460     
461     if (CkpvAccess(lastBreakPointMsg) != NULL) {
462       beginItem(p, -1);
463       envelope *env=(envelope *)UsrToEnv(CkpvAccess(lastBreakPointMsg));
464       p.comment("name");
465       char *type=(char*)"Breakpoint";
466       p(type,strlen(type));
467       p.comment("charmMsg");
468       p.synchronize(PUP::sync_begin_object);
469       CkUnpackMessage(&env);
470       CpdPupMessage(p, EnvToUsr(env));
471       p.synchronize(PUP::sync_end_object);
472     }
473
474     for(curObj=req.lo; curObj<req.hi; curObj++)
475       if ((curObj>=0) && (curObj<length))
476       {
477         void *msg=messages[curObj]; /* converse message */
478         pupSingleMessage(p, curObj, msg);
479       }
480     delete[] messages;
481
482   }
483
484   void pupSingleMessage(PUP::er &p, int curObj, void *msg) {
485     beginItem(p,curObj);
486     int isCharm=0;
487     const char *type="Converse";
488     p.comment("name");
489     char name[128];
490 #if ! CMK_BLUEGENE_CHARM
491     if (CmiGetHandler(msg)==_charmHandlerIdx) {isCharm=1; type="Local Charm";}
492     if (CmiGetXHandler(msg)==_charmHandlerIdx) {isCharm=1; type="Network Charm";}
493 #else
494     isCharm=1; type="BG";
495 #endif
496     if (curObj < 0) type="Conditional";
497     sprintf(name,"%s %d: %s (%d)","Message",curObj,type,CmiGetHandler(msg));
498     p(name, strlen(name));
499
500     if (isCharm)
501     { /* charm message */
502       p.comment("charmMsg");
503       p.synchronize(PUP::sync_begin_object);
504       envelope *env=(envelope *)msg;
505       CkUnpackMessage(&env);
506       //messages[curObj]=env;
507       CpdPupMessage(p, EnvToUsr(env));
508       //CkPupMessage(p, &messages[curObj], 0);
509       p.synchronize(PUP::sync_end_object);
510     }
511   }
512 };
513
514 class CpdList_message : public CpdListAccessor {
515   virtual const char * getPath(void) const {return "converse/message";}
516   virtual size_t getLength(void) const {return 1;}
517   virtual void pup(PUP::er &p, CpdListItemsRequest &req) {
518     envelope *env = (envelope*)(((unsigned int)req.lo) + (((unsigned long)req.hi)<<32)+sizeof(CmiChunkHeader));
519     beginItem(p, 0);
520     const char *type="Converse";
521     p.comment("name");
522     char name[128];
523     if (CmiGetHandler(env)==_charmHandlerIdx) {type="Local Charm";}
524     if (CmiGetXHandler(env)==_charmHandlerIdx) {type="Network Charm";}
525     sprintf(name,"%s 0: %s (%d)","Message",type,CmiGetHandler(env));
526     p(name, strlen(name));
527     p.comment("charmMsg");
528     p.synchronize(PUP::sync_begin_object);
529     CpdPupMessage(p, EnvToUsr(env));
530     p.synchronize(PUP::sync_end_object);
531   }
532 };
533
534 void CpdDeliverMessage(char * msg) {
535   int msgNum;
536   void *m;
537   sscanf(msg+CmiMsgHeaderSizeBytes, "%d", &msgNum);
538   //CmiPrintf("received deliver request %d\n",msgNum);
539
540   void *debugQ=CkpvAccess(debugQueue);
541   CdsFifo_Enqueue(debugQ, (void*)(-1)); // Enqueue a guard
542   for (int i=0; i<msgNum; ++i) CdsFifo_Enqueue(debugQ, CdsFifo_Dequeue(debugQ));
543   CkpvAccess(skipBreakpoint) = 1;
544   char *queuedMsg = (char *)CdsFifo_Dequeue(debugQ);
545   if (_conditionalDelivery) {
546     CmiReference(queuedMsg);
547     CdsFifo_Enqueue(CkpvAccess(conditionalQueue), queuedMsg);
548   }  
549 #if CMK_BLUEGENE_CHARM
550   stopVTimer();
551   BgProcessMessageDefault(cta(threadinfo), queuedMsg);
552   startVTimer();
553 #else
554   CmiHandleMessage(queuedMsg);
555 #endif
556   CkpvAccess(skipBreakpoint) = 0;
557   while ((m=CdsFifo_Dequeue(debugQ)) != (void*)(-1)) CdsFifo_Enqueue(debugQ, m);  
558 }
559
560 void *CpdGetNextMessageConditional(CsdSchedulerState_t*) {
561   int len;
562   read(conditionalPipe[0], &len, 4);
563   void *msg = CmiAlloc(len);
564   read(conditionalPipe[0], msg, len);
565   return msg;
566 }
567
568 void CpdEndConditionalDelivery(char *msg) {
569   _exit(0);
570 }
571
572 extern "C" void CpdDeliverSingleMessage ();
573
574 #include <sys/wait.h>
575 void CpdDeliverMessageConditionally(char * msg) {
576   int msgNum;
577   void *m;
578   sscanf(msg+CmiMsgHeaderSizeBytes, "%d", &msgNum);
579   //CmiPrintf("received deliver request %d\n",msgNum);
580
581   int pipefd[2][2];
582   pipe(pipefd[0]); // parent to child
583   pipe(pipefd[1]); // child to parent
584   
585   pid_t pid = fork();
586   if (pid > 0) {
587     int bytes;
588     CmiPrintf("parent %d\n",pid);
589     close(pipefd[0][0]);
590     close(pipefd[1][1]);
591     conditionalPipe[0] = pipefd[1][0];
592     conditionalPipe[1] = pipefd[0][1];
593     //CpdConditionalDeliveryScheduler(pipefd[1][0], pipefd[0][1]);
594     read(conditionalPipe[0], &bytes, 4);
595     char *buf = (char*)malloc(bytes);
596     read(conditionalPipe[0], buf, bytes);
597     CcsSendReply(bytes,buf);
598     free(buf);
599     return;
600   }
601   
602   //while (true);
603   printf("child\n");
604   int volatile tmp=1;
605   //while (tmp);
606   //_exit(0);
607   _conditionalDelivery = 1;
608   close(pipefd[0][1]);
609   close(pipefd[1][0]);
610   conditionalPipe[0] = pipefd[0][0];
611   conditionalPipe[1] = pipefd[1][1];
612   CpdGetNextMessage = CpdGetNextMessageConditional;
613
614   if (msgNum == -1) CpdDeliverSingleMessage();
615   else {
616     void *debugQ=CkpvAccess(debugQueue);
617     CdsFifo_Enqueue(debugQ, (void*)(-1)); // Enqueue a guard
618     for (int i=0; i<msgNum; ++i) CdsFifo_Enqueue(debugQ, CdsFifo_Dequeue(debugQ));
619     CkpvAccess(skipBreakpoint) = 1;
620     char *queuedMsg = (char *)CdsFifo_Dequeue(debugQ);
621     CmiReference(queuedMsg);
622     CdsFifo_Enqueue(CkpvAccess(conditionalQueue), queuedMsg);
623 #if CMK_BLUEGENE_CHARM
624     stopVTimer();
625     BgProcessMessageDefault(cta(threadinfo), queuedMsg);
626     startVTimer();
627 #else
628     CmiHandleMessage(queuedMsg);
629 #endif
630     CkpvAccess(skipBreakpoint) = 0;
631     //_exit(0);
632     while ((m=CdsFifo_Dequeue(debugQ)) != (void*)(-1)) CdsFifo_Enqueue(debugQ, m);
633   }
634 }
635
636 class CpdList_msgStack : public CpdListAccessor {
637   virtual const char * getPath(void) const {return "charm/messageStack";}
638   virtual size_t getLength(void) const {
639     return _debugData.length();
640   }
641   virtual void pup(PUP::er &p, CpdListItemsRequest &req) {
642     for (int i=0; i<_debugData.length(); ++i) {
643       beginItem(p, i);
644       void *obj = _debugData[i].obj;
645       p.comment("obj");
646       pup_pointer(&p, &obj);
647       void *msg = _debugData[i].msg;
648       p.comment("msg");
649       pup_pointer(&p, &msg);
650     }
651   }
652 };
653
654 /****************** Breakpoints and other debug support **************/
655
656 typedef CkHashtableTslow<int,EntryInfo *> CpdBpFuncTable_t;
657
658 extern void CpdFreeze(void);
659 extern void CpdUnFreeze(void);
660 extern int  CpdIsFrozen(void);
661
662 CpvStaticDeclare(int, _debugMsg);
663 CpvStaticDeclare(int, _debugChare);
664
665 CpvStaticDeclare(CpdBpFuncTable_t *, breakPointEntryTable);
666
667 //CpvStaticDeclare(void *, lastBreakPointMsg);
668 CkpvStaticDeclare(void *, lastBreakPointObject);
669 CkpvStaticDeclare(int, lastBreakPointIndex);
670
671 void CpdBreakPointInit()
672 {
673   CkpvInitialize(void *, lastBreakPointMsg);
674   CkpvInitialize(void *, lastBreakPointObject);
675   CkpvInitialize(int, lastBreakPointIndex);
676   CpvInitialize(int, _debugMsg);
677   CpvInitialize(int, _debugChare);
678   CpvInitialize(CpdBpFuncTable_t *, breakPointEntryTable);
679   CkpvAccess(lastBreakPointMsg) = NULL;
680   CkpvAccess(lastBreakPointObject) = NULL;
681   CkpvAccess(lastBreakPointIndex) = 0;
682   CpvAccess(_debugMsg) = CkRegisterMsg("debug_msg",0,0,0,0);
683   CpvAccess(_debugChare) = CkRegisterChare("debug_Chare",0,TypeChare);
684   CkRegisterChareInCharm(CpvAccess(_debugChare));
685   CpvAccess(breakPointEntryTable) = new CpdBpFuncTable_t(10,0.5,CkHashFunction_int,CkHashCompare_int );
686 }
687
688 #if CMK_BLUEGENE_CHARM
689 #include "blue_impl.h"
690 #endif
691
692 static void _call_freeze_on_break_point(void * msg, void * object)
693 {
694       //Save breakpoint entry point index. This is retrieved from msg.
695       //So that the appropriate EntryInfo can be later retrieved from the hash table
696       //of break point function entries, on continue.
697
698   // If the counter "skipBreakpoint" is not zero we actually do not freeze and deliver the regular message
699   EntryInfo * breakPointEntryInfo = CpvAccess(breakPointEntryTable)->get(CkMessageToEpIdx(msg));
700   if (CkpvAccess(skipBreakpoint) > 0 || CkpvAccess(_debugEntryTable)[CkMessageToEpIdx(msg)].isBreakpoint==CmiFalse) {
701     CkAssert(breakPointEntryInfo != NULL);
702     breakPointEntryInfo->call(msg, object);
703     if (CkpvAccess(skipBreakpoint) > 0) CkpvAccess(skipBreakpoint) --;
704   } else {
705       CkpvAccess(lastBreakPointMsg) = msg;
706       CkpvAccess(lastBreakPointObject) = object;
707       CkpvAccess(lastBreakPointIndex) = CkMessageToEpIdx(msg);
708       CpdNotify(CPD_BREAKPOINT,breakPointEntryInfo->name);
709       CpdFreeze();
710 #if CMK_BLUEGENE_CHARM
711       stopVTimer();
712       ((workThreadInfo*)cta(threadinfo))->scheduler(-1);
713 #endif
714   }
715 }
716
717 //ccs handler when pressed the "next" command: deliver only a single message without unfreezing
718 extern "C"
719 void CpdDeliverSingleMessage () {
720   if (!CpdIsFrozen()) return; /* Do something only if we are in freeze mode */
721   if ( (CkpvAccess(lastBreakPointMsg) != NULL) && (CkpvAccess(lastBreakPointObject) != NULL) ) {
722     EntryInfo * breakPointEntryInfo = CpvAccess(breakPointEntryTable)->get(CkpvAccess(lastBreakPointIndex));
723     if (breakPointEntryInfo != NULL) {
724       if (_conditionalDelivery) {
725         void *env = UsrToEnv(CkpvAccess(lastBreakPointMsg));
726         CmiReference(env);
727         CdsFifo_Enqueue(CkpvAccess(conditionalQueue),env);
728       }
729       breakPointEntryInfo->call(CkpvAccess(lastBreakPointMsg), CkpvAccess(lastBreakPointObject));
730     }
731     CkpvAccess(lastBreakPointMsg) = NULL;
732     CkpvAccess(lastBreakPointObject) = NULL;
733 #if CMK_BLUEGENE_CHARM
734     ((workThreadInfo*)cta(threadinfo))->stopScheduler();
735 #endif
736   }
737   else {
738     // we were not stopped at a breakpoint, then deliver the first message in the debug queue
739     if (!CdsFifo_Empty(CkpvAccess(debugQueue))) {
740       CkpvAccess(skipBreakpoint) = 1;
741       char *queuedMsg = (char *)CdsFifo_Dequeue(CkpvAccess(debugQueue));
742       if (_conditionalDelivery) {
743         CmiReference(queuedMsg);
744         CdsFifo_Enqueue(CkpvAccess(conditionalQueue),queuedMsg);
745       }
746 #if CMK_BLUEGENE_CHARM
747       stopVTimer();
748       BgProcessMessageDefault(cta(threadinfo), queuedMsg);
749       startVTimer();
750 #else
751       CmiHandleMessage(queuedMsg);
752 #endif
753       CkpvAccess(skipBreakpoint) = 0;
754     }
755   }
756 }
757
758 //ccs handler when continue from a break point
759 extern "C"
760 void CpdContinueFromBreakPoint ()
761 {
762     CpdUnFreeze();
763     if ( (CkpvAccess(lastBreakPointMsg) != NULL) && (CkpvAccess(lastBreakPointObject) != NULL) )
764     {
765         EntryInfo * breakPointEntryInfo = CpvAccess(breakPointEntryTable)->get(CkpvAccess(lastBreakPointIndex));
766         if (breakPointEntryInfo != NULL) {
767            breakPointEntryInfo->call(CkpvAccess(lastBreakPointMsg), CkpvAccess(lastBreakPointObject));
768 #if CMK_BLUEGENE_CHARM
769            ((workThreadInfo*)cta(threadinfo))->stopScheduler();
770 #endif
771         } else {
772           // This means that the breakpoint got deleted in the meanwhile
773           
774         }
775     }
776     CkpvAccess(lastBreakPointMsg) = NULL;
777     CkpvAccess(lastBreakPointObject) = NULL;
778 }
779
780 //ccs handler to set a breakpoint with entry function name msg
781 void CpdSetBreakPoint (char *msg)
782 {
783   char functionName[128];
784   int tableSize, tableIdx = 0;
785   int reply = 0;
786   sscanf(msg+CmiReservedHeaderSize, "%s", functionName);
787   if (strlen(functionName) > 0)
788   {
789     tableSize = _entryTable.size();
790     // Replace entry in entry table with _call_freeze_on_break_point
791     tableIdx = atoi(functionName);
792     if (tableIdx >= 0 && tableIdx < tableSize) {
793            EntryInfo * breakPointEntryInfo = (EntryInfo *)CpvAccess(breakPointEntryTable)->get(tableIdx);
794            if (breakPointEntryInfo == 0) {
795              breakPointEntryInfo = new EntryInfo(_entryTable[tableIdx]->name, _entryTable[tableIdx]->call, 1, 0 );
796              //CmiPrintf("Breakpoint is set for function %s with an epIdx = %ld\n", _entryTable[tableIdx]->name, tableIdx);
797              CpvAccess(breakPointEntryTable)->put(tableIdx) = breakPointEntryInfo;
798              _entryTable[tableIdx]->name = "debug_breakpoint_ep";
799              _entryTable[tableIdx]->call = (CkCallFnPtr)_call_freeze_on_break_point;
800            } else {
801              breakPointEntryInfo->msgIdx ++;
802              //CkAssert(breakPointEntryInfo->name == _entryTable[tableIdx]->name);
803              //CkAssert(breakPointEntryInfo->call == _entryTable[tableIdx]->call);
804              //CkAssert(breakPointEntryInfo->msgIdx == _entryTable[tableIdx]->msgIdx);
805              //CkAssert(breakPointEntryInfo->chareIdx == _entryTable[tableIdx]->chareIdx);
806            }
807            CkpvAccess(_debugEntryTable)[tableIdx].isBreakpoint = CmiTrue;
808            reply = ~0;
809     }
810
811   }
812   CcsSendReply(sizeof(int), (void*)&reply);
813
814 }
815
816 void CpdQuitDebug()
817 {
818   CpdContinueFromBreakPoint();
819   CkExit();
820 }
821
822 void CpdRemoveBreakPoint (char *msg)
823 {
824   char functionName[128];
825   int reply = 0;
826   sscanf(msg+CmiReservedHeaderSize, "%s", functionName);
827   if (strlen(functionName) > 0) {
828     int idx = atoi(functionName);
829     if (idx >= 0 && idx < _entryTable.size()) {
830       EntryInfo * breakPointEntryInfo = CpvAccess(breakPointEntryTable)->get(idx);
831       if (breakPointEntryInfo != NULL) {
832         if (--breakPointEntryInfo->msgIdx == 0) {
833           // If we are the last to delete the breakpoint, then restore the original name and call function pointer
834           _entryTable[idx]->name =  breakPointEntryInfo->name;
835           _entryTable[idx]->call = (CkCallFnPtr)breakPointEntryInfo->call;
836         }
837         reply = ~0 ;
838         CkpvAccess(_debugEntryTable)[idx].isBreakpoint = CmiFalse;
839         //CmiPrintf("Breakpoint is removed for function %s with epIdx %ld\n", _entryTable[idx]->name, idx);
840         //CkpvAccess(breakPointEntryTable)->remove(idx);
841       }
842     }
843   }
844   CcsSendReply(sizeof(int), (void*)&reply);
845 }
846
847 void CpdRemoveAllBreakPoints ()
848 {
849   //all breakpoints removed
850   void *objPointer;
851   void *keyPointer;
852   int reply = 1;
853   CkHashtableIterator *it = CpvAccess(breakPointEntryTable)->iterator();
854   while(NULL!=(objPointer = it->next(&keyPointer)))
855   {
856     EntryInfo * breakPointEntryInfo = *(EntryInfo **)objPointer;
857     int idx = *(int *)keyPointer;
858     if (--breakPointEntryInfo->msgIdx == 0) {
859       // If we are the last to delete the breakpoint, then restore the original name and call function pointer
860       _entryTable[idx]->name =  breakPointEntryInfo->name;
861       _entryTable[idx]->call = (CkCallFnPtr)breakPointEntryInfo->call;
862     }
863     CkpvAccess(_debugEntryTable)[idx].isBreakpoint = CmiFalse;
864   }
865   CcsSendReply(sizeof(int), (void*)&reply);
866 }
867
868 extern "C" int CpdIsCharmDebugMessage(void *msg) {
869   envelope *env = (envelope*)msg;
870   // Later should use "isDebug" value, but for now just bypass all intrinsic EPs
871   return CmiGetHandler(msg) != _charmHandlerIdx || env->getMsgtype() == ForVidMsg ||
872          env->getMsgtype() == FillVidMsg || _entryTable[env->getEpIdx()]->inCharm;
873 }
874
875 #if CMK_BLUEGENE_CHARM
876 CpvExtern(int, _bgCcsHandlerIdx);
877 extern "C" int CpdIsBgCharmDebugMessage(void *msg) {
878   envelope *env = (envelope*)msg;
879   if (CmiBgMsgFlag(msg) == BG_CLONE) {
880     env=*(envelope**)(((char*)msg)+CmiBlueGeneMsgHeaderSizeBytes);
881   }
882   if  ((((CmiBlueGeneMsgHeader*)env)->hID) == CpvAccess(_bgCcsHandlerIdx)) return 1;
883     // make sure it indeed is a charm message
884   if (CmiBgMsgHandle(env) == _charmHandlerIdx) {
885     return env->getMsgtype() == ForVidMsg || env->getMsgtype() == FillVidMsg ||
886          _entryTable[env->getEpIdx()]->inCharm;
887   }
888   return 1;
889 }
890 #endif
891
892 CpvExtern(char *, displayArgument);
893
894 void CpdStartGdb(void)
895 {
896 #if !defined(_WIN32) || defined(__CYGWIN__)
897   FILE *f;
898   char gdbScript[200];
899   int pid;
900   if (CpvAccess(displayArgument) != NULL)
901   {
902      /*CmiPrintf("MY NODE IS %d  and process id is %d\n", CmiMyPe(), getpid());*/
903      sprintf(gdbScript, "/tmp/cpdstartgdb.%d.%d", getpid(), CmiMyPe());
904      f = fopen(gdbScript, "w");
905      fprintf(f,"#!/bin/sh\n");
906      fprintf(f,"cat > /tmp/start_gdb.$$ << END_OF_SCRIPT\n");
907      fprintf(f,"shell /bin/rm -f /tmp/start_gdb.$$\n");
908      //fprintf(f,"handle SIGPIPE nostop noprint\n");
909      fprintf(f,"handle SIGWINCH nostop noprint\n");
910      fprintf(f,"handle SIGWAITING nostop noprint\n");
911      fprintf(f, "attach %d\n", getpid());
912      fprintf(f,"END_OF_SCRIPT\n");
913      fprintf(f, "DISPLAY='%s';export DISPLAY\n",CpvAccess(displayArgument));
914      fprintf(f,"/usr/X11R6/bin/xterm ");
915      fprintf(f," -title 'Node %d ' ",CmiMyPe());
916      fprintf(f," -e /usr/bin/gdb -x /tmp/start_gdb.$$ \n");
917      fprintf(f, "exit 0\n");
918      fclose(f);
919      if( -1 == chmod(gdbScript, 0755))
920      {
921         CmiPrintf("ERROR> chmod on script failed!\n");
922         return;
923      }
924      pid = fork();
925      if (pid < 0)
926         { perror("ERROR> forking to run debugger script\n"); exit(1); }
927      if (pid == 0)
928      {
929          //CmiPrintf("In child process to start script %s\n", gdbScript);
930  if (-1 == execvp(gdbScript, NULL))
931             CmiPrintf ("Error> Could not Execute Debugger Script: %s\n",strerror
932 (errno));
933
934       }
935     }
936 #endif
937 }
938
939 extern "C" {
940   size_t cpd_memory_length(void*);
941   void cpd_memory_pup(void*,void*,CpdListItemsRequest*);
942   void cpd_memory_leak(void*,void*,CpdListItemsRequest*);
943   size_t cpd_memory_getLength(void*);
944   void cpd_memory_get(void*,void*,CpdListItemsRequest*);
945 }
946
947
948 void CpdCharmInit()
949 {
950   CpdListRegister(new CpdListAccessor_c("converse/memory",cpd_memory_length,0,cpd_memory_pup,0));
951   //CpdListRegister(new CpdListAccessor_c("converse/memory/leak",cpd_memory_length,0,cpd_memory_leak,0));
952   CpdListRegister(new CpdListAccessor_c("converse/memory/data",cpd_memory_getLength,0,cpd_memory_get,0,false));
953
954   //CpdBreakPointInit();
955   CcsRegisterHandler("ccs_set_break_point",(CmiHandler)CpdSetBreakPoint);
956   CcsSetMergeFn("ccs_set_break_point",CcsMerge_logical_and);
957   CcsRegisterHandler("ccs_remove_break_point",(CmiHandler)CpdRemoveBreakPoint);
958   CcsSetMergeFn("ccs_remove_break_point",CcsMerge_logical_and);
959   CcsRegisterHandler("ccs_remove_all_break_points",(CmiHandler)CpdRemoveAllBreakPoints);
960   CcsSetMergeFn("ccs_remove_all_break_points",CmiReduceMergeFn_random);
961   CcsRegisterHandler("ccs_continue_break_point",(CmiHandler)CpdContinueFromBreakPoint);
962   CcsRegisterHandler("ccs_single_step",(CmiHandler)CpdDeliverSingleMessage);
963   CcsRegisterHandler("ccs_debug_quit",(CmiHandler)CpdQuitDebug);
964   CcsRegisterHandler("ccs_debug_startgdb",(CmiHandler)CpdStartGdb);
965   CpdListRegister(new CpdListAccessor_c("hostinfo",hostInfoLength,0,hostInfo,0));
966   CpdListRegister(new CpdList_localQ());
967   CcsRegisterHandler("deliverMessage",(CmiHandler)CpdDeliverMessage);
968   CcsRegisterHandler("deliverConditional",(CmiHandler)CpdDeliverMessageConditionally);
969   CcsRegisterHandler("endConditional",(CmiHandler)CpdEndConditionalDelivery);
970   CpdListRegister(new CpdList_arrayElementNames());
971   CpdListRegister(new CpdList_arrayElements());
972   CpdListRegister(new CpdList_objectNames());
973   CpdListRegister(new CpdList_object());
974   CpdListRegister(new CpdList_message());
975   CpdListRegister(new CpdList_msgStack());
976   CpdGetNextMessage = CsdNextMessage;
977   CpdIsDebugMessage = CpdIsCharmDebugMessage;
978 #if CMK_BLUEGENE_CHARM
979   CpdIsDebugMessage = CpdIsBgCharmDebugMessage;
980 #endif
981 }
982
983 #if CMK_BLUEGENE_CHARM
984 CpvExtern(int, _bgCcsHandlerIdx);
985 CpvExtern(int, _bgCcsAck);
986 extern "C" void req_fw_handler(char*);
987 CkpvExtern(void *, debugQueue);
988 CkpvExtern(int, freezeModeFlag);
989 #include "blue_impl.h"
990 extern void BgProcessMessageFreezeMode(threadInfo *, char *);
991
992 void CpdBgInit()
993 {
994         // Register the BG handler for CCS. Notice that this is put into a variable shared by
995         // the whole real processor. This because converse needs to find it. We check that all
996         // virtual processors register the same index for this handler.
997         int bgCcsHandlerIdx = CkRegisterHandler((CmiHandler)req_fw_handler);
998         if (CpvAccess(_bgCcsHandlerIdx) == 0) CpvAccess(_bgCcsHandlerIdx) = bgCcsHandlerIdx;
999         CkAssert(CpvAccess(_bgCcsHandlerIdx)==bgCcsHandlerIdx);
1000         CpvAccess(_bgCcsAck) ++;
1001         CcsReleaseMessages();
1002         
1003         CkpvInitialize(int, freezeModeFlag);
1004         CkpvAccess(freezeModeFlag) = 0;
1005
1006         CkpvInitialize(void *, debugQueue);
1007         CkpvAccess(debugQueue) = CdsFifo_Create();
1008         
1009         BgProcessMessage = BgProcessMessageFreezeMode;
1010 }
1011 #endif
1012
1013 #else
1014
1015 void CpdBreakPointInit() {}
1016 void CpdCharmInit() {}
1017 #if CMK_BLUEGENE_CHARM
1018 void CpdBgInit() {}
1019 #endif
1020
1021 void CpdFinishInitialization() {}
1022
1023 void *CpdGetCurrentObject() {return NULL;}
1024 void *CpdGetCurrentMsg() {return NULL;}
1025
1026 void CpdBeforeEp(int ep, void *obj, void *msg) {}
1027 void CpdAfterEp(int ep) {}
1028
1029 #endif /*CMK_CCS_AVAILABLE*/
1030