Fix the +RTS -V0 option introduced recently; it didn't work at all, now it does.
[ghc.git] / rts / Hpc.c
index b183253..ebd5af1 100644 (file)
--- a/rts/Hpc.c
+++ b/rts/Hpc.c
  *
  */
 
-#define WOP_SIZE 1024  
-
 static int hpc_inited = 0;             // Have you started this component?
 static FILE *tixFile;                  // file being read/written
 static int tix_ch;                     // current char
 
-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,
-  RixRaiseOp            = -2,
-  RixFinishedOp         = -3
-} HpcRixOp;
-
-
-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;
-
 // This is a cruel hack, we should completely redesign the format specifier handling in the RTS.
 #if SIZEOF_LONG == 8
 #define PRIuWORD64 "lu"
@@ -56,12 +33,15 @@ typedef struct _Info {
 #define PRIuWORD64 "llu"
 #endif
 
-Info *modules = 0;
-Info *nextModule = 0;
+HpcModuleInfo *modules = 0;
+HpcModuleInfo *nextModule = 0;
 int totalTixes = 0;            // total number of tix boxes.
 
 static char *tixFilename;
 
+void hs_hpc_read(char *filename);
+void hs_hpc_write(char *filename);
+
 static void failure(char *msg) {
   debugTrace(DEBUG_hpc,"hpc failure: %s\n",msg);
   fprintf(stderr,"Hpc failure: %s\n",msg);
@@ -73,9 +53,8 @@ static void failure(char *msg) {
   exit(-1);
 }
 
-static int init_open(char *filename) 
-{
-  tixFile = fopen(filename,"r");
+static int init_open(FILE *file) {
+  tixFile = file;
  if (tixFile == 0) {
     return 0;
   }
@@ -121,76 +100,82 @@ static StgWord64 expectWord64(void) {
   return tmp;
 }
 
-static void hpc_init(void) {
+static void
+readTix(void) {
   int i;
-  Info *tmpModule;  
-
-  if (hpc_inited != 0) {
-    return;
-  }
-  hpc_inited = 1;
-
-  tixFilename = (char *) malloc(strlen(prog_name) + 6);
-  sprintf(tixFilename, "%s.tix", prog_name);
-
-  if (init_open(tixFilename)) { 
-    totalTixes = 0;
+  HpcModuleInfo *tmpModule;
 
-    ws();
+  totalTixes = 0;
+    
+  ws();
+  expect('T');
+  expect('i');
+  expect('x');
+  ws();
+  expect('[');
+  ws();
+  
+  while(tix_ch != ']') {
+    tmpModule = (HpcModuleInfo *)calloc(1,sizeof(HpcModuleInfo));
     expect('T');
     expect('i');
     expect('x');
+    expect('M');
+    expect('o');
+    expect('d');
+    expect('u');
+    expect('l');
+    expect('e');
+    ws();
+    tmpModule -> modName = expectString();
+    ws();
+    tmpModule -> hashNo = (unsigned int)expectWord64();
+    ws();
+    tmpModule -> tickCount = (int)expectWord64();
+    tmpModule -> tixArr = (StgWord64 *)calloc(tmpModule->tickCount,sizeof(StgWord64));
+    tmpModule -> tickOffset = totalTixes;
+    totalTixes += tmpModule -> tickCount;
     ws();
     expect('[');
     ws();
-    while(tix_ch != ']') {
-      tmpModule = (Info *)calloc(1,sizeof(Info));
-      expect('T');
-      expect('i');
-      expect('x');
-      expect('M');
-      expect('o');
-      expect('d');
-      expect('u');
-      expect('l');
-      expect('e');
-      ws();
-      tmpModule -> modName = expectString();
-      ws();
-      tmpModule -> hashNo = (unsigned int)expectWord64();
-      ws();
-      tmpModule -> tickCount = (int)expectWord64();
-      tmpModule -> tixArr = (StgWord64 *)calloc(tmpModule->tickCount,sizeof(StgWord64));
-      tmpModule -> tickOffset = totalTixes;
-      totalTixes += tmpModule -> tickCount;
-      ws();
-      expect('[');
-      ws();
-      for(i = 0;i < tmpModule->tickCount;i++) {
-       tmpModule->tixArr[i] = expectWord64();
-       ws();
-       if (tix_ch == ',') {
-         expect(',');
-         ws();
-       }
-      }
-      expect(']');
+    for(i = 0;i < tmpModule->tickCount;i++) {
+      tmpModule->tixArr[i] = expectWord64();
       ws();
-
-      if (!modules) {
-       modules = tmpModule;
-      } else {
-       nextModule->next=tmpModule;
-      }
-      nextModule=tmpModule;
-      
       if (tix_ch == ',') {
        expect(',');
        ws();
       }
     }
     expect(']');
-    fclose(tixFile);
+    ws();
+    
+    if (!modules) {
+      modules = tmpModule;
+    } else {
+      nextModule->next=tmpModule;
+    }
+    nextModule=tmpModule;
+    
+    if (tix_ch == ',') {
+      expect(',');
+      ws();
+    }
+  }
+  expect(']');
+  fclose(tixFile);
+}
+
+static void hpc_init(void) {
+  if (hpc_inited != 0) {
+    return;
+  }
+  hpc_inited = 1;
+
+  tixFilename = (char *) malloc(strlen(prog_name) + 6);
+  sprintf(tixFilename, "%s.tix", prog_name);
+
+  if (init_open(fopen(tixFilename,"r"))) {
+    readTix();
   }
 }
 
@@ -204,7 +189,7 @@ hs_hpc_module(char *modName,
              int modCount,
              int modHashNo,
              StgWord64 *tixArr) {
-  Info *tmpModule, *lastModule;
+  HpcModuleInfo *tmpModule, *lastModule;
   int i;
   int offset = 0;
   
@@ -237,7 +222,7 @@ hs_hpc_module(char *modName,
     lastModule = tmpModule;
   }
   // Did not find entry so add one on.
-  tmpModule = (Info *)calloc(1,sizeof(Info));
+  tmpModule = (HpcModuleInfo *)calloc(1,sizeof(HpcModuleInfo));
   tmpModule->modName = modName;
   tmpModule->tickCount = modCount;
   tmpModule->hashNo = modHashNo;
@@ -263,186 +248,6 @@ hs_hpc_module(char *modName,
   return offset;
 }
 
-static void breakPointCommand(HpcRixOp rixOp, StgThreadID rixTid);
-
-// Breakpointing
-static StgThreadID previousTid = 0;
-static StgWord64 rixBPCounter = 0;     // The global event breakpoint counter
-static int *tixBoxBP;
-static HpcRixOp rixOpBack[WOP_SIZE];   // The actual op
-static HpcRixOp rixTidBack[WOP_SIZE];  // Tid's before the op
-
-void 
-hs_hpc_raise_event(StgTSO *current_tso) {
-  hs_hpc_tick(RixRaiseOp,current_tso);
-}
-
-void 
-hs_hpc_thread_finished_event(StgTSO *current_tso) {
-  hs_hpc_tick(RixThreadFinishedOp,current_tso);
-}
-
-/* Called on every tick, dynamically, sending to our 
- * external record of program execution.
- */
-
-void
-hs_hpc_tick(int rixOp, StgTSO *current_tso) {
-
-  debugTrace(DEBUG_hpc,"hs_hpc_tick(%x)",rixOp);
-
-  if (rixFile == NULL) {
-    return;
-  }
-  assert(rixCmdFile != NULL);
-  StgThreadID tid = (current_tso == 0) ? 0 : current_tso->id;
-
-  // now check to see if we have met a breakpoint condition
-  if (rixCounter == rixBPCounter 
-      || tid != previousTid) {
-    breakPointCommand(rixOp,tid);
-  } else {
-    if (rixOp >= 0) {
-      // Tix op
-      if (tixBoxBP[rixOp] == 1) {      // reached a bp tixbox
-         breakPointCommand(rixOp,tid);
-      }
-    } else {
-      // record the special operation
-      breakPointCommand(rixOp,tid);
-    }
-  }
-  // update the history information.
-  previousTid = tid;
-  rixOpBack[rixCounter % WOP_SIZE]  = rixOp;
-  rixTidBack[rixCounter % WOP_SIZE] = tid;
-  rixCounter++;
-
-  debugTrace(DEBUG_hpc, "end: hs_hpc_tick");
-}
-
-static void 
-printEvent(FILE *out,StgWord64 rixCounter,StgThreadID rixTid,HpcRixOp rixOp) {
-  char prefixMsg[128];
-  char suffixMsg[128];
-
-  sprintf(prefixMsg,
-         "Event %" PRIuWORD64 " %u ",
-         rixCounter,
-         (unsigned int)rixTid);
-
-  switch(rixOp) {
-  case RixThreadFinishedOp:
-    sprintf(suffixMsg,"ThreadFinished");
-    break;
-  case RixRaiseOp:
-    sprintf(suffixMsg,"Raise");
-    break;
-  case RixFinishedOp:
-    sprintf(suffixMsg,"Finished");
-    break;
-  default:
-    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
-   *  h                        history
-
-   * Note that you aways end up here on the first tick
-   * because the rixBPCounter starts equal to 0.
-   */
-  int c = getc(rixCmdFile);
-  while(c != 10 && c != -1) {
-    switch(c) {
-    case 'c': // c1234 -- set counter breakpoint at 1234
-      c = getc(rixCmdFile);
-      tmp64 = 0;
-      while(isdigit(c)) {
-       tmp64 = tmp64 * 10 + (c - '0');
-       c = getc(rixCmdFile);
-      }
-      debugTrace(DEBUG_hpc,"setting countBP = %" PRIuWORD64,tmp64);
-
-      rixBPCounter = tmp64;
-      break;
-    case 's': // s2323  -- set tick box breakpoint at 2323
-      c = getc(rixCmdFile);
-      tmp = 0;
-      while(isdigit(c)) {
-       tmp = tmp * 10 + (c - '0');
-       c = getc(rixCmdFile);
-      }
-
-      debugTrace(DEBUG_hpc,"seting bp for tix %d",tmp);
-
-      tixBoxBP[tmp] = 1;
-      break;
-    case 'u': // u2323  -- unset tick box breakpoint at 2323
-      c = getc(rixCmdFile);
-      tmp = 0;
-      while(isdigit(c)) {
-       tmp = tmp * 10 + (c - '0');
-       c = getc(rixCmdFile);
-      }
-
-      debugTrace(DEBUG_hpc,"unseting bp for tix %d",tmp);
-
-      tixBoxBP[tmp] = 0;
-      break;
-    case 'h': // h -- history of the last few (WOP_SIZE) steps 
-      if (rixCounter > WOP_SIZE) {
-       tmp64 = rixCounter - WOP_SIZE;
-      } else {
-       tmp64 = 0;
-      }
-      for(;tmp64 < rixCounter;tmp64++) {
-       printEvent(rixFile,
-                  tmp64,
-                  rixTidBack[tmp64 % WOP_SIZE],
-                  rixOpBack[tmp64 % WOP_SIZE]);
-      }
-      fflush(rixFile);
-      c = getc(rixCmdFile);
-      break;
-    default:
-
-      debugTrace(DEBUG_hpc,"strange command from HPCRIX (%d)",c);
-
-      c = getc(rixCmdFile);
-    }
-    while (c != 10) {          // the end of the line
-       c = getc(rixCmdFile); // to the end of the line
-    }
-    c = getc(rixCmdFile); // the first char on the next command
-  }
-
-  debugTrace(DEBUG_hpc,"leaving breakPointCommand");
-
-}
 
 /* This is called after all the modules have registered their local tixboxes,
  * and does a sanity check: are we good to go?
@@ -450,100 +255,25 @@ breakPointCommand(HpcRixOp rixOp, StgThreadID rixTid) {
 
 void
 startupHpc(void) {
-  char *hpcRix;
-
   debugTrace(DEBUG_hpc,"startupHpc");
  
  if (hpc_inited == 0) {
     return;
   }
-  // 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);
-
-    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);
-    fprintf(rixFile,"[");
-    tmpModule = modules;
-    for(;tmpModule != 0;tmpModule = tmpModule->next) {
-      if (comma) {
-       fprintf(rixFile,",");
-      } else {
-       comma = 1;
-      }
-      fprintf(rixFile,"(\"%s\",%u)",
-             tmpModule->modName,
-             tmpModule->tickCount);
-
-      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);
-
-    // Allocate the tixBox breakpoint array
-    // These are set to 1 if you want to 
-    // stop at a specific breakpoint
-    tixBoxBP = (int *)calloc(tixCount,sizeof(int));
-  }
-
 }
 
 
-/* Called at the end of execution, to write out the Hpc *.tix file  
- * for this exection. Safe to call, even if coverage is not used.
- */
-void
-exitHpc(void) {
-  Info *tmpModule;  
+static void
+writeTix(FILE *f) {
+  HpcModuleInfo *tmpModule;  
   int i, inner_comma, outer_comma;
 
-  debugTrace(DEBUG_hpc,"exitHpc");
+  outer_comma = 0;
 
-  if (hpc_inited == 0) {
+  if (f == 0) {
     return;
   }
 
-  FILE *f = fopen(tixFilename,"w");
-  
-  outer_comma = 0;
-
   fprintf(f,"Tix [");
   tmpModule = modules;
   for(;tmpModule != 0;tmpModule = tmpModule->next) {
@@ -580,42 +310,63 @@ exitHpc(void) {
   }
   fprintf(f,"]\n");
   
-  /*
-  tmpModule = modules;
-  for(;tmpModule != 0;tmpModule = tmpModule->next) {
-      if (!tmpModule->tixArr) {
-       debugTrace(DEBUG_hpc,
-                  "warning: module %s did not register any hpc tick data\n",
-                  tmpModule->modName);
-      }
+  fclose(f);
+}
 
-    for(i = 0;i < tmpModule->tickCount;i++) {
-      if (comma) {
-       fprintf(f,",");
-      } else {
-       comma = 1;
-      }
+/* Called at the end of execution, to write out the Hpc *.tix file  
+ * for this exection. Safe to call, even if coverage is not used.
+ */
+void
+exitHpc(void) {
+  debugTrace(DEBUG_hpc,"exitHpc");
 
-      if (tmpModule->tixArr) {
-       fprintf(f,"%" PRIuWORD64,tmpModule->tixArr[i]);
-      } else {
-       fprintf(f,"0");
-      }
+  if (hpc_inited == 0) {
+    return;
+  }
+
+  FILE *f = fopen(tixFilename,"w");
+  writeTix(f);
+}
+
+void hs_hpc_read(char *filename) {
+  HpcModuleInfo *orig_modules = 0, *tmpModule, *tmpOrigModule;
+  int i;
 
+  orig_modules = modules;
+  modules = 0;
+  if (init_open(fopen(filename,"r"))) {
+    readTix();
+    // Now we copy across the arrays. O(n^2), but works
+    for(tmpModule = modules;
+       tmpModule != 0;
+       tmpModule = tmpModule->next) {
+
+      for(tmpOrigModule = orig_modules;
+         tmpOrigModule != 0;
+         tmpOrigModule = tmpOrigModule->next) {
+       if (!strcmp(tmpModule->modName,tmpOrigModule->modName)) {    
+         assert(tmpModule->tixArr != 0);               
+         assert(tmpOrigModule->tixArr != 0);           
+         assert(tmpModule->tickCount == tmpOrigModule->tickCount);
+         for(i=0;i < tmpModule->tickCount;i++) {
+           tmpOrigModule->tixArr[i] = tmpModule->tixArr[i];
+         }
+         tmpModule->tixArr = tmpOrigModule->tixArr;
+         break;
+       }
+      }
     }
   }
-      
-  fprintf(f,"]\n");
-  */
-  fclose(f);
+}
 
-  if (rixFile != NULL) {
-    hs_hpc_tick(RixFinishedOp,(StgThreadID)0);
-    fclose(rixFile);
-  }
-  if (rixCmdFile != NULL) {
-    fclose(rixCmdFile);
-  }
-  
+void hs_hpc_write(char *filename) {
+  writeTix(fopen(filename,"w"));
 }
 
+//////////////////////////////////////////////////////////////////////////////
+// This is the API into Hpc RTS from Haskell, allowing the tixs boxes
+// to be first class.
+
+HpcModuleInfo *hs_hpc_rootModule(void) {
+  return modules;
+}