Comments about the let/app invariant
[ghc.git] / rts / Hpc.c
index 0f3f3b3..20ef91f 100644 (file)
--- a/rts/Hpc.c
+++ b/rts/Hpc.c
@@ -1,65 +1,63 @@
 /*
  * (c)2006 Galois Connections, Inc.
- */ 
+ */
+
+#include "PosixSource.h"
+#include "Rts.h"
+
+#include "Trace.h"
+#include "Hash.h"
+#include "RtsUtils.h"
 
 #include <stdio.h>
 #include <ctype.h>
-#include <stdlib.h>
 #include <string.h>
 #include <assert.h>
-#include "HsFFI.h"
 
-#include "Rts.h"
-#include "Hpc.h"
+#ifdef HAVE_SYS_TYPES_H
+#include <sys/types.h>
+#endif
+
+#ifdef HAVE_SYS_STAT_H
+#include <sys/stat.h>
+#endif
+
+#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
-
-static int hpc_inited = 0;             // Have you started this component?
-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
-
-typedef struct _Info {
-  char *modName;               // name of module
-  int tickCount;               // number of ticks
-  int tickOffset;              // offset into a single large .tix Array
-  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"
-#else
-#define PRIuWORD64 "llu"
-#endif
-
-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 int hpc_inited = 0;              // Have you started this component?
+static pid_t hpc_pid = 0;               // pid of this process at hpc-boot time.
+                                        // Only this pid will read or write .tix file(s).
+static FILE *tixFile;                   // file being read/written
+static int tix_ch;                      // current char
 
+static HashTable * moduleHash = NULL;   // module name -> HpcModuleInfo
 
+HpcModuleInfo *modules = 0;
 
-static char *tixFilename;
+static char *tixFilename = NULL;
 
-static void failure(char *msg) {
-  printf("Hpc failure: %s\n",msg);
-  printf("(perhaps remove .tix file?)\n");
-  exit(-1);
+static void GNU_ATTRIBUTE(__noreturn__)
+failure(char *msg) {
+  debugTrace(DEBUG_hpc,"hpc failure: %s\n",msg);
+  fprintf(stderr,"Hpc failure: %s\n",msg);
+  if (tixFilename) {
+    fprintf(stderr,"(perhaps remove %s file?)\n",tixFilename);
+  } else {
+    fprintf(stderr,"(perhaps remove .tix file?)\n");
+  }
+  stg_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;
   }
@@ -69,8 +67,8 @@ static int init_open(char *filename)
 
 static void expect(char c) {
   if (tix_ch != c) {
-    printf("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);
 }
@@ -82,7 +80,7 @@ static void ws(void) {
 }
 
 static char *expectString(void) {
-  char tmp[256], *res;
+  char tmp[256], *res; // XXX
   int tmp_ix = 0;
   expect('"');
   while (tix_ch != '"') {
@@ -91,7 +89,7 @@ static char *expectString(void) {
   }
   tmp[tmp_ix++] = 0;
   expect('"');
-  res = malloc(tmp_ix);
+  res = stgMallocBytes(tmp_ix,"Hpc.expectString");
   strcpy(res,tmp);
   return res;
 }
@@ -105,336 +103,304 @@ static StgWord64 expectWord64(void) {
   return tmp;
 }
 
-static void hpc_init(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;
-
-    ws();
+static void
+readTix(void) {
+  unsigned int i;
+  HpcModuleInfo *tmpModule, *lookup;
+
+  ws();
+  expect('T');
+  expect('i');
+  expect('x');
+  ws();
+  expect('[');
+  ws();
+
+  while(tix_ch != ']') {
+    tmpModule = (HpcModuleInfo *)stgMallocBytes(sizeof(HpcModuleInfo),
+                                                "Hpc.readTix");
+    tmpModule->from_file = rtsTrue;
     expect('T');
     expect('i');
     expect('x');
+    expect('M');
+    expect('o');
+    expect('d');
+    expect('u');
+    expect('l');
+    expect('e');
     ws();
-    magicTixNumber = expectWord64();
+    tmpModule -> modName = expectString();
+    ws();
+    tmpModule -> hashNo = (unsigned int)expectWord64();
+    ws();
+    tmpModule -> tickCount = (int)expectWord64();
+    tmpModule -> tixArr = (StgWord64 *)calloc(tmpModule->tickCount,sizeof(StgWord64));
     ws();
     expect('[');
     ws();
-    while(tix_ch != ']') {
-      tmpModule = (Info *)calloc(1,sizeof(Info));
-      expect('(');
-      ws();
-      tmpModule -> modName = expectString();
-      ws();
-      expect(',');
-      ws();
-      tmpModule -> tickCount = (int)expectWord64();
-      ws();
-      expect(')');
+    for(i = 0;i < tmpModule->tickCount;i++) {
+      tmpModule->tixArr[i] = expectWord64();
       ws();
-      
-      tmpModule -> tickOffset = totalTixes;
-      totalTixes += tmpModule -> tickCount;
-      
-      tmpModule -> tixArr = 0;
-      
-      if (!modules) {
-       modules = tmpModule;
-      } else {
-       nextModule->next=tmpModule;
-      }
-      nextModule=tmpModule;
-      
       if (tix_ch == ',') {
-       expect(',');
-       ws();
+        expect(',');
+        ws();
       }
     }
     expect(']');
     ws();
-    tixBoxes = (StgWord64 *)calloc(totalTixes,sizeof(StgWord64));
 
-    expect('[');
-    for(i = 0;i < totalTixes;i++) {
-      if (i != 0) {
-       expect(',');
-       ws();
-      }
-    tixBoxes[i] = expectWord64();
-    ws();
+    lookup = lookupHashTable(moduleHash, (StgWord)tmpModule->modName);
+    if (lookup == NULL) {
+        debugTrace(DEBUG_hpc,"readTix: new HpcModuleInfo for %s",
+                   tmpModule->modName);
+        insertHashTable(moduleHash, (StgWord)tmpModule->modName, tmpModule);
+    } else {
+        ASSERT(lookup->tixArr != 0);
+        ASSERT(!strcmp(tmpModule->modName, lookup->modName));
+        debugTrace(DEBUG_hpc,"readTix: existing HpcModuleInfo for %s",
+                   tmpModule->modName);
+        if (tmpModule->hashNo != lookup->hashNo) {
+            fprintf(stderr,"in module '%s'\n",tmpModule->modName);
+            failure("module mismatch with .tix/.mix file hash number");
+            if (tixFilename != NULL) {
+                fprintf(stderr,"(perhaps remove %s ?)\n",tixFilename);
+            }
+            stg_exit(EXIT_FAILURE);
+        }
+        for (i=0; i < tmpModule->tickCount; i++) {
+            lookup->tixArr[i] = tmpModule->tixArr[i];
+        }
+        stgFree(tmpModule->tixArr);
+        stgFree(tmpModule->modName);
+        stgFree(tmpModule);
     }
-    expect(']');
 
-    fclose(tixFile);
-  } else {
-    // later, we will find a binary specific 
-    magicTixNumber = (StgWord64)0;
+    if (tix_ch == ',') {
+      expect(',');
+      ws();
+    }
   }
+  expect(']');
+  fclose(tixFile);
 }
 
-/* Called on a per-module basis, at startup time, declaring where the tix boxes are stored in memory.
- * This memory can be uninitized, because we will initialize it with either the contents
- * of the tix file, or all zeros.
- */
-
-int
-hs_hpc_module(char *modName,int modCount,StgWord64 *tixArr) {
-  Info *tmpModule, *lastModule;
-  int i;
-  int offset = 0;
-  
-#if DEBUG_HPC
-  printf("hs_hpc_module(%s,%d)\n",modName,modCount);
-#endif
-
-  hpc_init();
+void
+startupHpc(void)
+{
+  char *hpc_tixdir;
+  char *hpc_tixfile;
 
-  tmpModule = modules;
-  lastModule = 0;
-  
-  for(;tmpModule != 0;tmpModule = tmpModule->next) {
-    if (!strcmp(tmpModule->modName,modName)) {
-      if (tmpModule->tickCount != modCount) {
-       failure("inconsistent number of tick boxes");
-      }
-      assert(tmpModule->tixArr == 0);  
-      assert(tixBoxes != 0);
-      tmpModule->tixArr = tixArr;
-      for(i=0;i < modCount;i++) {
-       tixArr[i] = tixBoxes[i + tmpModule->tickOffset];
-      }
-      return tmpModule->tickOffset;
-    }
-    lastModule = tmpModule;
-  }
-  // Did not find entry so add one on.
-  tmpModule = (Info *)calloc(1,sizeof(Info));
-  tmpModule->modName = modName;
-  tmpModule->tickCount = modCount;
-  if (lastModule) {
-    tmpModule->tickOffset = lastModule->tickOffset + lastModule->tickCount;
-  } else {
-    tmpModule->tickOffset = 0;
+  if (moduleHash == NULL) {
+      // no modules were registered with hs_hpc_module, so don't bother
+      // creating the .tix file.
+      return;
   }
-  tmpModule->tixArr = tixArr;
-  for(i=0;i < modCount;i++) {
-    tixArr[i] = 0;
-  }
-  tmpModule->next = 0;
 
-  if (!modules) {
-    modules = tmpModule;
-  } else {
-    lastModule->next=tmpModule;
+  if (hpc_inited != 0) {
+    return;
   }
-
-#if DEBUG_HPC
-  printf("end: hs_hpc_module\n");
+  hpc_inited = 1;
+  hpc_pid    = getpid();
+  hpc_tixdir = getenv("HPCTIXDIR");
+  hpc_tixfile = getenv("HPCTIXFILE");
+
+  debugTrace(DEBUG_hpc,"startupHpc");
+
+  /* XXX Check results of mallocs/strdups, and check we are requesting
+         enough bytes */
+  if (hpc_tixfile != NULL) {
+    tixFilename = strdup(hpc_tixfile);
+  } else if (hpc_tixdir != NULL) {
+    /* Make sure the directory is present;
+     * conditional code for mkdir lifted from lndir.c
+     */
+#ifdef WIN32
+    mkdir(hpc_tixdir);
+#else
+    mkdir(hpc_tixdir,0777);
 #endif
-  return offset;
-}
-
-static StgThreadID previous_tid = 0;
+    /* Then, try open the file
+     */
+    tixFilename = (char *) stgMallocBytes(strlen(hpc_tixdir) +
+                                          strlen(prog_name) + 12,
+                                          "Hpc.startupHpc");
+    sprintf(tixFilename,"%s/%s-%d.tix",hpc_tixdir,prog_name,(int)hpc_pid);
+  } else {
+    tixFilename = (char *) stgMallocBytes(strlen(prog_name) + 6,
+                                          "Hpc.startupHpc");
+    sprintf(tixFilename, "%s.tix", prog_name);
+  }
 
-static void 
-send_ThreadId(StgTSO *current_tso) {
-  // This assumes that there is no real thread 0.
-  StgThreadID tid = (current_tso == 0) ? 0 : current_tso->id;
-  if (tid != previous_tid) {
-    previous_tid = tid;
-    // How do we print StgWord32's without a cast?
-    fprintf(rixFile,"Thread Switch %d\n",(unsigned int)tid);
+  if (init_open(fopen(tixFilename,"r"))) {
+    readTix();
   }
 }
 
 /*
- * Called on *every* exception thrown
+ * Called on a per-module basis, by a constructor function compiled
+ * with each module (see Coverage.hpcInitCode), declaring where the
+ * tix boxes are stored in memory.  This memory can be uninitized,
+ * because we will initialize it with either the contents of the tix
+ * file, or all zeros.
+ *
+ * Note that we might call this before reading the .tix file, or after
+ * in the case where we loaded some Haskell code from a .so with
+ * dlopen().  So we must handle the case where we already have an
+ * HpcModuleInfo for the module which was read from the .tix file.
  */
+
 void
-hs_hpc_event(char *msg,StgTSO *current_tso) {
-  // Assumes that we have had at least *one* tick first.
-  // All exceptions before the first tick are not reported.
-  // The only time this might be an issue is in bootstrapping code,
-  // so this is a feature.
-
-  // This is called on *every* exception, even when Hpc is not enabled.
-
-  if (rixFile != NULL) {
-    assert(hpc_inited != 0);
-    send_ThreadId(current_tso);
-    fprintf(rixFile,"%s\n",msg);
+hs_hpc_module(char *modName,
+              StgWord32 modCount,
+              StgWord32 modHashNo,
+              StgWord64 *tixArr)
+{
+  HpcModuleInfo *tmpModule;
+  nat i;
+
+  if (moduleHash == NULL) {
+      moduleHash = allocStrHashTable();
   }
-}
 
-/* Called on every tick, dynamically to our file record of program execution
- */
+  tmpModule = lookupHashTable(moduleHash, (StgWord)modName);
+  if (tmpModule == NULL)
+  {
+      // Did not find entry so add one on.
+      tmpModule = (HpcModuleInfo *)stgMallocBytes(sizeof(HpcModuleInfo),
+                                                  "Hpc.hs_hpc_module");
+      tmpModule->modName = modName;
+      tmpModule->tickCount = modCount;
+      tmpModule->hashNo = modHashNo;
 
-void
-hs_hpc_tick(int globIx, StgTSO *current_tso) {
-#if DEBUG_HPC && DEBUG
-  printf("hs_hpc_tick(%d)\n",globIx);
-#endif
-  assert(hpc_inited != 0);
-  if (rixFile != NULL) {
-    send_ThreadId(current_tso);
-    fprintf(rixFile,"%d\n",globIx);
+      tmpModule->tixArr = tixArr;
+      for(i=0;i < modCount;i++) {
+          tixArr[i] = 0;
+      }
+      tmpModule->next = modules;
+      tmpModule->from_file = rtsFalse;
+      modules = tmpModule;
+      insertHashTable(moduleHash, (StgWord)modName, tmpModule);
   }
+  else
+  {
+      if (tmpModule->tickCount != modCount) {
+          failure("inconsistent number of tick boxes");
+      }
+      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");
+          if (tixFilename != NULL) {
+              fprintf(stderr,"(perhaps remove %s ?)\n",tixFilename);
+          }
+          stg_exit(EXIT_FAILURE);
+      }
+      // The existing tixArr was made up when we read the .tix file,
+      // whereas this is the real tixArr, so copy the data from the
+      // .tix into the real tixArr.
+      for(i=0;i < modCount;i++) {
+          tixArr[i] = tmpModule->tixArr[i];
+      }
 
-#if DEBUG_HPC
-  printf("end: hs_hpc_tick\n");
-#endif
-  
+      if (tmpModule->from_file) {
+          stgFree(tmpModule->modName);
+          stgFree(tmpModule->tixArr);
+      }
+      tmpModule->from_file = rtsFalse;
+  }
 }
 
-/* This is called after all the modules have registered their local tixboxes,
- * and does a sanity check: are we good to go?
- */
+static void
+writeTix(FILE *f) {
+  HpcModuleInfo *tmpModule;
+  unsigned int i, inner_comma, outer_comma;
 
-void
-startupHpc(void) {
-  Info *tmpModule;
-  char *hpcRix;
-#if DEBUG_HPC
-  printf("startupHpc\n");
-#endif
- if (hpc_inited == 0) {
+  outer_comma = 0;
+
+  if (f == 0) {
     return;
   }
 
+  fprintf(f,"Tix [");
   tmpModule = modules;
-
-  if (tixBoxes) {
-    for(;tmpModule != 0;tmpModule = tmpModule->next) {
-      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);
-      }
+  for(;tmpModule != 0;tmpModule = tmpModule->next) {
+    if (outer_comma) {
+      fprintf(f,",");
+    } else {
+      outer_comma = 1;
     }
-  }
+    fprintf(f," TixModule \"%s\" %u %u [",
+           tmpModule->modName,
+            (nat)tmpModule->hashNo,
+            (nat)tmpModule->tickCount);
+    debugTrace(DEBUG_hpc,"%s: %u (hash=%u)\n",
+               tmpModule->modName,
+               (nat)tmpModule->tickCount,
+               (nat)tmpModule->hashNo);
+
+    inner_comma = 0;
+    for(i = 0;i < tmpModule->tickCount;i++) {
+      if (inner_comma) {
+        fprintf(f,",");
+      } else {
+        inner_comma = 1;
+      }
 
-  // HPCRIX contains the name of the file to send our dynamic runtime output to.
-  // This might be a real file, or perhaps a named pipe.
-  hpcRix = getenv("HPCRIX");
-  if (hpcRix) {
-    int comma;
-    Info *tmpModule;  
-
-    assert(hpc_inited);
-
-    rixFile = fopen(hpcRix,"w");
-
-    comma = 0;
-    
-    fprintf(rixFile,"Starting %s\n",prog_name);
-    fprintf(rixFile,"[");
-    tmpModule = modules;
-    for(;tmpModule != 0;tmpModule = tmpModule->next) {
-      if (comma) {
-       fprintf(rixFile,",");
+      if (tmpModule->tixArr) {
+        fprintf(f,"%" FMT_Word64,tmpModule->tixArr[i]);
       } else {
-       comma = 1;
+        fprintf(f,"0");
       }
-      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
     }
-    fprintf(rixFile,"]\n");
-    fflush(rixFile);
+    fprintf(f,"]");
   }
+  fprintf(f,"]\n");
 
+  fclose(f);
 }
 
+static void
+freeHpcModuleInfo (HpcModuleInfo *mod)
+{
+    if (mod->from_file) {
+        stgFree(mod->modName);
+        stgFree(mod->tixArr);
+    }
+    stgFree(mod);
+}
 
-/* Called at the end of execution, to write out the Hpc *.tix file  
+/* 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;  
-  int i, comma;
-
-#if DEBUG_HPC
-  printf("exitHpc\n");
-#endif
+  debugTrace(DEBUG_hpc,"exitHpc");
 
   if (hpc_inited == 0) {
     return;
   }
 
-  FILE *f = fopen(tixFilename,"w");
-  
-  comma = 0;
+  // Only write the tix file if you are the original process.
+  // Any sub-process from use of fork from inside Haskell will
+  // not clober the .tix file.
 
-  fprintf(f,"Tix %" PRIuWORD64 " [", magicTixNumber);
-  tmpModule = modules;
-  for(;tmpModule != 0;tmpModule = tmpModule->next) {
-    if (comma) {
-      fprintf(f,",");
-    } else {
-      comma = 1;
-    }
-    fprintf(f,"(\"%s\",%u)",
-          tmpModule->modName,
-           tmpModule->tickCount);
-#if DEBUG_HPC
-    fprintf(stderr,"%s: %u (offset=%u)\n",
-          tmpModule->modName,
-          tmpModule->tickCount,
-          tmpModule->tickOffset);
-#endif
+  if (hpc_pid == getpid()) {
+    FILE *f = fopen(tixFilename,"w");
+    writeTix(f);
   }
-  fprintf(f,"] [");
-  
-  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);
-      }
 
-    for(i = 0;i < tmpModule->tickCount;i++) {
-      if (comma) {
-       fprintf(f,",");
-      } else {
-       comma = 1;
-      }
+  freeHashTable(moduleHash, (void (*)(void *))freeHpcModuleInfo);
+  moduleHash = NULL;
 
-      if (tmpModule->tixArr) {
-       fprintf(f,"%" PRIuWORD64,tmpModule->tixArr[i]);
-      } else {
-       fprintf(f,"0");
-      }
+  stgFree(tixFilename);
+  tixFilename = NULL;
+}
 
-    }
-  }
-      
-  fprintf(f,"]\n");
-  fclose(f);
+//////////////////////////////////////////////////////////////////////////////
+// This is the API into Hpc RTS from Haskell, allowing the tixs boxes
+// to be first class.
 
-  if (rixFile != NULL) {
-    fprintf(rixFile,"Finished\n");
-    fclose(rixFile);
-  }
-  
+HpcModuleInfo *hs_hpc_rootModule(void) {
+  return modules;
 }
-