remove old comments and commented-out code
[ghc-hetmet.git] / rts / Hpc.c
index 0eeb8dd..b183253 100644 (file)
--- a/rts/Hpc.c
+++ b/rts/Hpc.c
@@ -7,29 +7,31 @@
 #include <stdlib.h>
 #include <string.h>
 #include <assert.h>
-#include "HsFFI.h"
 
 #include "Rts.h"
 #include "Hpc.h"
+#include "Trace.h"
+
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+
 
 /* This is the runtime support for the Haskell Program Coverage (hpc) toolkit,
  * inside GHC.
  *
  */
 
-#define DEBUG_HPC 0
 #define WOP_SIZE 1024  
 
 static int hpc_inited = 0;             // Have you started this component?
-static int totalTickCount = 0;         // How many ticks have we got to work with
 static FILE *tixFile;                  // file being read/written
 static int tix_ch;                     // current char
-static StgWord64 magicTixNumber;       // Magic/Hash number to mark .tix files
 
 static FILE *rixFile = NULL;           // The tracer file/pipe (to debugger)
 static FILE *rixCmdFile = NULL;                // The tracer file/pipe (from debugger)
 static StgWord64 rixCounter = 0;       // The global event counter
-
+static int debuggee_pid;
 
 typedef enum {
   RixThreadFinishedOp   = -1,
@@ -42,6 +44,7 @@ typedef struct _Info {
   char *modName;               // name of module
   int tickCount;               // number of ticks
   int tickOffset;              // offset into a single large .tix Array
+  int hashNo;                  // Hash number for this module's mix info
   StgWord64 *tixArr;           // tix Array from the program execution (local for this module)
   struct _Info *next;
 } Info;
@@ -55,19 +58,21 @@ typedef struct _Info {
 
 Info *modules = 0;
 Info *nextModule = 0;
-StgWord64 *tixBoxes = 0;       // local copy of tixBoxes array, from file.
 int totalTixes = 0;            // total number of tix boxes.
 
 static char *tixFilename;
 
-
 static void failure(char *msg) {
+  debugTrace(DEBUG_hpc,"hpc failure: %s\n",msg);
   fprintf(stderr,"Hpc failure: %s\n",msg);
-  fprintf(stderr,"(perhaps remove .tix file?)\n");
+  if (tixFilename) {
+    fprintf(stderr,"(perhaps remove %s file?)\n",tixFilename);
+  } else {
+    fprintf(stderr,"(perhaps remove .tix file?)\n");
+  }
   exit(-1);
 }
 
-
 static int init_open(char *filename) 
 {
   tixFile = fopen(filename,"r");
@@ -80,8 +85,8 @@ static int init_open(char *filename)
 
 static void expect(char c) {
   if (tix_ch != c) {
-    fprintf(stderr,"Hpc: parse failed (%c,%c)\n",tix_ch,c);
-    exit(-1);
+    fprintf(stderr,"('%c' '%c')\n",tix_ch,c);
+    failure("parse error when reading .tix file");
   }
   tix_ch = getc(tixFile);
 }
@@ -124,7 +129,6 @@ static void hpc_init(void) {
     return;
   }
   hpc_inited = 1;
-  
 
   tixFilename = (char *) malloc(strlen(prog_name) + 6);
   sprintf(tixFilename, "%s.tix", prog_name);
@@ -137,28 +141,42 @@ static void hpc_init(void) {
     expect('i');
     expect('x');
     ws();
-    magicTixNumber = expectWord64();
-    ws();
     expect('[');
     ws();
     while(tix_ch != ']') {
       tmpModule = (Info *)calloc(1,sizeof(Info));
-      expect('(');
+      expect('T');
+      expect('i');
+      expect('x');
+      expect('M');
+      expect('o');
+      expect('d');
+      expect('u');
+      expect('l');
+      expect('e');
       ws();
       tmpModule -> modName = expectString();
       ws();
-      expect(',');
+      tmpModule -> hashNo = (unsigned int)expectWord64();
       ws();
       tmpModule -> tickCount = (int)expectWord64();
-      ws();
-      expect(')');
-      ws();
-      
+      tmpModule -> tixArr = (StgWord64 *)calloc(tmpModule->tickCount,sizeof(StgWord64));
       tmpModule -> tickOffset = totalTixes;
       totalTixes += tmpModule -> tickCount;
-      
-      tmpModule -> tixArr = 0;
-      
+      ws();
+      expect('[');
+      ws();
+      for(i = 0;i < tmpModule->tickCount;i++) {
+       tmpModule->tixArr[i] = expectWord64();
+       ws();
+       if (tix_ch == ',') {
+         expect(',');
+         ws();
+       }
+      }
+      expect(']');
+      ws();
+
       if (!modules) {
        modules = tmpModule;
       } else {
@@ -172,24 +190,7 @@ static void hpc_init(void) {
       }
     }
     expect(']');
-    ws();
-    tixBoxes = (StgWord64 *)calloc(totalTixes,sizeof(StgWord64));
-
-    expect('[');
-    for(i = 0;i < totalTixes;i++) {
-      if (i != 0) {
-       expect(',');
-       ws();
-      }
-    tixBoxes[i] = expectWord64();
-    ws();
-    }
-    expect(']');
-
     fclose(tixFile);
-  } else {
-    // later, we will find a binary specific 
-    magicTixNumber = (StgWord64)0;
   }
 }
 
@@ -199,14 +200,15 @@ static void hpc_init(void) {
  */
 
 int
-hs_hpc_module(char *modName,int modCount,StgWord64 *tixArr) {
+hs_hpc_module(char *modName,
+             int modCount,
+             int modHashNo,
+             StgWord64 *tixArr) {
   Info *tmpModule, *lastModule;
   int i;
   int offset = 0;
   
-#if DEBUG_HPC
-  fprintf(stderr,"hs_hpc_module(%s,%d)\n",modName,modCount);
-#endif
+  debugTrace(DEBUG_hpc,"hs_hpc_module(%s,%d)",modName,modCount);
 
   hpc_init();
 
@@ -218,12 +220,18 @@ hs_hpc_module(char *modName,int modCount,StgWord64 *tixArr) {
       if (tmpModule->tickCount != modCount) {
        failure("inconsistent number of tick boxes");
       }
-      assert(tmpModule->tixArr == 0);  
-      assert(tixBoxes != 0);
-      tmpModule->tixArr = tixArr;
+      assert(tmpModule->tixArr != 0);  
+      if (tmpModule->hashNo != modHashNo) {
+       fprintf(stderr,"in module '%s'\n",tmpModule->modName);
+       failure("module mismatch with .tix/.mix file hash number");
+       fprintf(stderr,"(perhaps remove %s ?)\n",tixFilename);
+       exit(-1);
+
+      }
       for(i=0;i < modCount;i++) {
-       tixArr[i] = tixBoxes[i + tmpModule->tickOffset];
+       tixArr[i] = tmpModule->tixArr[i];
       }
+      tmpModule->tixArr = tixArr;
       return tmpModule->tickOffset;
     }
     lastModule = tmpModule;
@@ -232,6 +240,7 @@ hs_hpc_module(char *modName,int modCount,StgWord64 *tixArr) {
   tmpModule = (Info *)calloc(1,sizeof(Info));
   tmpModule->modName = modName;
   tmpModule->tickCount = modCount;
+  tmpModule->hashNo = modHashNo;
   if (lastModule) {
     tmpModule->tickOffset = lastModule->tickOffset + lastModule->tickCount;
   } else {
@@ -249,9 +258,8 @@ hs_hpc_module(char *modName,int modCount,StgWord64 *tixArr) {
     lastModule->next=tmpModule;
   }
 
-#if DEBUG_HPC
-  fprintf(stderr,"end: hs_hpc_module\n");
-#endif
+  debugTrace(DEBUG_hpc,"end: hs_hpc_module");
+
   return offset;
 }
 
@@ -261,7 +269,6 @@ static void breakPointCommand(HpcRixOp rixOp, StgThreadID rixTid);
 static StgThreadID previousTid = 0;
 static StgWord64 rixBPCounter = 0;     // The global event breakpoint counter
 static int *tixBoxBP;
-static int specialOpBP = 0;
 static HpcRixOp rixOpBack[WOP_SIZE];   // The actual op
 static HpcRixOp rixTidBack[WOP_SIZE];  // Tid's before the op
 
@@ -281,9 +288,9 @@ hs_hpc_thread_finished_event(StgTSO *current_tso) {
 
 void
 hs_hpc_tick(int rixOp, StgTSO *current_tso) {
-#if DEBUG_HPC
-  fprintf(stderr,"hs_hpc_tick(%x)\n",rixOp);
-#endif
+
+  debugTrace(DEBUG_hpc,"hs_hpc_tick(%x)",rixOp);
+
   if (rixFile == NULL) {
     return;
   }
@@ -291,7 +298,8 @@ hs_hpc_tick(int rixOp, StgTSO *current_tso) {
   StgThreadID tid = (current_tso == 0) ? 0 : current_tso->id;
 
   // now check to see if we have met a breakpoint condition
-  if (rixCounter == rixBPCounter || (specialOpBP && tid != previousTid)) {
+  if (rixCounter == rixBPCounter 
+      || tid != previousTid) {
     breakPointCommand(rixOp,tid);
   } else {
     if (rixOp >= 0) {
@@ -300,10 +308,8 @@ hs_hpc_tick(int rixOp, StgTSO *current_tso) {
          breakPointCommand(rixOp,tid);
       }
     } else {
-      // Special op
-      if (specialOpBP) {
-       breakPointCommand(rixOp,tid);
-      }
+      // record the special operation
+      breakPointCommand(rixOp,tid);
     }
   }
   // update the history information.
@@ -312,48 +318,62 @@ hs_hpc_tick(int rixOp, StgTSO *current_tso) {
   rixTidBack[rixCounter % WOP_SIZE] = tid;
   rixCounter++;
 
-#if DEBUG_HPC
-  fprintf(stderr,"end: hs_hpc_tick\n");
-#endif
+  debugTrace(DEBUG_hpc, "end: hs_hpc_tick");
 }
 
 static void 
 printEvent(FILE *out,StgWord64 rixCounter,StgThreadID rixTid,HpcRixOp rixOp) {
-#if DEBUG_HPC
-  if (out != stderr) {
-    printEvent(stderr,rixCounter,rixTid,rixOp);
-  }
-#endif
-  fprintf(out,"%" PRIuWORD64 " %u ",rixCounter,(unsigned int)rixTid);
+  char prefixMsg[128];
+  char suffixMsg[128];
+
+  sprintf(prefixMsg,
+         "Event %" PRIuWORD64 " %u ",
+         rixCounter,
+         (unsigned int)rixTid);
+
   switch(rixOp) {
   case RixThreadFinishedOp:
-    fprintf(out,"ThreadFinished\n");
+    sprintf(suffixMsg,"ThreadFinished");
+    break;
   case RixRaiseOp:
-    fprintf(out,"Raise\n");
+    sprintf(suffixMsg,"Raise");
+    break;
   case RixFinishedOp:
-    fprintf(out,"Finished\n");
+    sprintf(suffixMsg,"Finished");
+    break;
   default:
-    fprintf(out,"%u\n",rixOp);
+    sprintf(suffixMsg,"%u",rixOp);
   }
+
+  fprintf(out,"%s%s\n",prefixMsg,suffixMsg);
+  debugTrace(DEBUG_hpc,"sending %s%s",prefixMsg,suffixMsg);
 }
 
 static void
 breakPointCommand(HpcRixOp rixOp, StgThreadID rixTid) {
   StgWord64 tmp64 = 0;
   unsigned int tmp = 0;
+
+  if (getpid() != debuggee_pid) {
+    // We are not the original process, to do not issue 
+    // any events, and do not try to talk to the debugger.
+    return;
+  }
+
+  debugTrace(DEBUG_hpc,"breakPointCommand %d %x",rixOp,(unsigned int)rixTid);
+
   printEvent(rixFile,rixCounter,rixTid,rixOp);
   fflush(rixFile);
+
   /* From here, you can ask some basic questions.
    * 
    *  c<nat>           set the (one) counter breakpoint
    *  s<nat>           set the (many) tickbox breakpoint
    *  u<nat>           unset the (many) tickbox breakpoint
-   *  x                        set special bp 
-   *  o                        unset special bp
    *  h                        history
 
    * Note that you aways end up here on the first tick
-   * because the specialOpBP is equal 0.
+   * because the rixBPCounter starts equal to 0.
    */
   int c = getc(rixCmdFile);
   while(c != 10 && c != -1) {
@@ -365,9 +385,8 @@ breakPointCommand(HpcRixOp rixOp, StgThreadID rixTid) {
        tmp64 = tmp64 * 10 + (c - '0');
        c = getc(rixCmdFile);
       }
-#if DEBUG_HPC
-      fprintf(stderr,"setting countBP = %" PRIuWORD64 "\n",tmp64);
-#endif
+      debugTrace(DEBUG_hpc,"setting countBP = %" PRIuWORD64,tmp64);
+
       rixBPCounter = tmp64;
       break;
     case 's': // s2323  -- set tick box breakpoint at 2323
@@ -377,9 +396,9 @@ breakPointCommand(HpcRixOp rixOp, StgThreadID rixTid) {
        tmp = tmp * 10 + (c - '0');
        c = getc(rixCmdFile);
       }
-#if DEBUG_HPC
-      fprintf(stderr,"seting bp for tix %d\n",tmp);
-#endif
+
+      debugTrace(DEBUG_hpc,"seting bp for tix %d",tmp);
+
       tixBoxBP[tmp] = 1;
       break;
     case 'u': // u2323  -- unset tick box breakpoint at 2323
@@ -389,25 +408,11 @@ breakPointCommand(HpcRixOp rixOp, StgThreadID rixTid) {
        tmp = tmp * 10 + (c - '0');
        c = getc(rixCmdFile);
       }
-#if DEBUG_HPC
-      fprintf(stderr,"unseting bp for tix %d\n",tmp);
-#endif
+
+      debugTrace(DEBUG_hpc,"unseting bp for tix %d",tmp);
+
       tixBoxBP[tmp] = 0;
       break;
-    case 'x': // x -- set special bp flag
-#if DEBUG_HPC
-      fprintf(stderr,"seting specialOpBP = 1\n");
-#endif
-      specialOpBP = 1;
-      c = getc(rixCmdFile);
-      break;
-    case 'o': // o -- clear special bp flag
-#if DEBUG_HPC
-      fprintf(stderr,"seting specialOpBP = 0\n");
-#endif
-      specialOpBP = 0;
-      c = getc(rixCmdFile);
-      break;
     case 'h': // h -- history of the last few (WOP_SIZE) steps 
       if (rixCounter > WOP_SIZE) {
        tmp64 = rixCounter - WOP_SIZE;
@@ -415,15 +420,18 @@ breakPointCommand(HpcRixOp rixOp, StgThreadID rixTid) {
        tmp64 = 0;
       }
       for(;tmp64 < rixCounter;tmp64++) {
-       printEvent(rixFile,tmp64,rixTidBack[tmp64 % WOP_SIZE],rixOpBack[tmp64 % WOP_SIZE]);
+       printEvent(rixFile,
+                  tmp64,
+                  rixTidBack[tmp64 % WOP_SIZE],
+                  rixOpBack[tmp64 % WOP_SIZE]);
       }
       fflush(rixFile);
       c = getc(rixCmdFile);
       break;
     default:
-#if DEBUG_HPC
-      fprintf(stderr,"strange command from HPCRIX (%d)\n",c);
-#endif
+
+      debugTrace(DEBUG_hpc,"strange command from HPCRIX (%d)",c);
+
       c = getc(rixCmdFile);
     }
     while (c != 10) {          // the end of the line
@@ -431,9 +439,9 @@ breakPointCommand(HpcRixOp rixOp, StgThreadID rixTid) {
     }
     c = getc(rixCmdFile); // the first char on the next command
   }
-#if DEBUG_HPC
-  fprintf(stderr,"re entering program\n");
-#endif
+
+  debugTrace(DEBUG_hpc,"leaving breakPointCommand");
+
 }
 
 /* This is called after all the modules have registered their local tixboxes,
@@ -442,41 +450,46 @@ breakPointCommand(HpcRixOp rixOp, StgThreadID rixTid) {
 
 void
 startupHpc(void) {
-  Info *tmpModule;
   char *hpcRix;
-  char *hpcRixCmd;
-#if DEBUG_HPC
-  fprintf(stderr,"startupHpc\n");
-#endif
+
+  debugTrace(DEBUG_hpc,"startupHpc");
  
  if (hpc_inited == 0) {
     return;
   }
-
-  tmpModule = modules;
-
-  if (tixBoxes) {
-    for(;tmpModule != 0;tmpModule = tmpModule->next) {
-      totalTickCount += tmpModule->tickCount;
-      if (!tmpModule->tixArr) {
-       fprintf(stderr,"error: module %s did not register any hpc tick data\n",
-               tmpModule->modName);
-       fprintf(stderr,"(perhaps remove %s ?)\n",tixFilename);
-       exit(-1);
-      }
-    }
-  }
-
   // HPCRIX contains the name of the file to send our dynamic runtime output to (a named pipe).
 
   hpcRix = getenv("HPCRIX");
   if (hpcRix) {
     int comma;
     Info *tmpModule;  
+    int rixFD, rixCmdFD;
+    int tixCount = 0;
 
     assert(hpc_inited);
 
-    rixFile = fopen(hpcRix,"w");
+    if (sscanf(hpcRix,"%d:%d",&rixFD,&rixCmdFD) != 2) {
+      /* Bad format for HPCRIX.
+       */
+      debugTrace(DEBUG_hpc,"Bad HPCRIX (%s)",hpcRix);
+      exit(0);
+    }
+
+    debugTrace(DEBUG_hpc,"found HPCRIX pipes: %d:%d",rixFD,rixCmdFD);
+
+    rixFile = fdopen(rixFD,"w");
+    assert(rixFile != NULL);
+
+    rixCmdFile = fdopen(rixCmdFD,"r");
+    assert(rixCmdFile != NULL);
+
+    // If we fork a process, then we do not want ticks inside
+    // the sub-process to talk to the debugger. So we remember
+    // our pid at startup time, so we can check if we are still
+    // the original process.
+
+    debuggee_pid = getpid();
+
     comma = 0;
     
     fprintf(rixFile,"Starting %s\n",prog_name);
@@ -491,26 +504,23 @@ startupHpc(void) {
       fprintf(rixFile,"(\"%s\",%u)",
              tmpModule->modName,
              tmpModule->tickCount);
-#if DEBUG_HPC
-      fprintf(stderr,"(tracer)%s: %u (offset=%u)\n",
-             tmpModule->modName,
-             tmpModule->tickCount,
-             tmpModule->tickOffset);
-#endif
+
+      tixCount += tmpModule->tickCount;
+
+      debugTrace(DEBUG_hpc,"(tracer)%s: %u (offset=%u) (hash=%u)\n",
+                tmpModule->modName,
+                tmpModule->tickCount,
+                tmpModule->hashNo,
+                tmpModule->tickOffset);
+
     }
     fprintf(rixFile,"]\n");
     fflush(rixFile);
 
-    // Now we open the command channel.
-    hpcRixCmd = getenv("HPCRIXCMD");
-    assert(hpcRixCmd != NULL);
-    rixCmdFile = fopen(hpcRixCmd,"r");
-    assert(rixCmdFile != NULL);
-
     // Allocate the tixBox breakpoint array
     // These are set to 1 if you want to 
     // stop at a specific breakpoint
-    tixBoxBP = (int *)calloc(1,sizeof(int));
+    tixBoxBP = (int *)calloc(tixCount,sizeof(int));
   }
 
 }
@@ -522,11 +532,9 @@ startupHpc(void) {
 void
 exitHpc(void) {
   Info *tmpModule;  
-  int i, comma;
+  int i, inner_comma, outer_comma;
 
-#if DEBUG_HPC
-  fprintf(stderr,"exitHpc\n");
-#endif
+  debugTrace(DEBUG_hpc,"exitHpc");
 
   if (hpc_inited == 0) {
     return;
@@ -534,34 +542,51 @@ exitHpc(void) {
 
   FILE *f = fopen(tixFilename,"w");
   
-  comma = 0;
+  outer_comma = 0;
 
-  fprintf(f,"Tix %" PRIuWORD64 " [", magicTixNumber);
+  fprintf(f,"Tix [");
   tmpModule = modules;
   for(;tmpModule != 0;tmpModule = tmpModule->next) {
-    if (comma) {
+    if (outer_comma) {
       fprintf(f,",");
     } else {
-      comma = 1;
+      outer_comma = 1;
     }
-    fprintf(f,"(\"%s\",%u)",
+    fprintf(f," TixModule \"%s\" %u %u [",
           tmpModule->modName,
+           tmpModule->hashNo,
            tmpModule->tickCount);
-#if DEBUG_HPC
-    fprintf(stderr,"%s: %u (offset=%u)\n",
-          tmpModule->modName,
-          tmpModule->tickCount,
-          tmpModule->tickOffset);
-#endif
+    debugTrace(DEBUG_hpc,"%s: %u (offset=%u) (hash=%u)\n",
+              tmpModule->modName,
+              tmpModule->tickCount,
+              tmpModule->hashNo,
+              tmpModule->tickOffset);
+
+    inner_comma = 0;
+    for(i = 0;i < tmpModule->tickCount;i++) {
+      if (inner_comma) {
+       fprintf(f,",");
+      } else {
+       inner_comma = 1;
+      }
+
+      if (tmpModule->tixArr) {
+       fprintf(f,"%" PRIuWORD64,tmpModule->tixArr[i]);
+      } else {
+       fprintf(f,"0");
+      }
+    }
+    fprintf(f,"]");
   }
-  fprintf(f,"] [");
+  fprintf(f,"]\n");
   
-  comma = 0;
+  /*
   tmpModule = modules;
   for(;tmpModule != 0;tmpModule = tmpModule->next) {
       if (!tmpModule->tixArr) {
-       fprintf(stderr,"warning: module %s did not register any hpc tick data\n",
-               tmpModule->modName);
+       debugTrace(DEBUG_hpc,
+                  "warning: module %s did not register any hpc tick data\n",
+                  tmpModule->modName);
       }
 
     for(i = 0;i < tmpModule->tickCount;i++) {
@@ -581,6 +606,7 @@ exitHpc(void) {
   }
       
   fprintf(f,"]\n");
+  */
   fclose(f);
 
   if (rixFile != NULL) {