#include <stdlib.h>
#include <string.h>
#include <assert.h>
-#include "HsFFI.h"
#include "Rts.h"
#include "Hpc.h"
+#include "Trace.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
-#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 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 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
-
-
-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
- 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 "llu"
#endif
-Info *modules = 0;
-Info *nextModule = 0;
-StgWord64 *tixBoxes = 0; // local copy of tixBoxes array, from file.
+HpcModuleInfo *modules = 0;
+HpcModuleInfo *nextModule = 0;
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");
+static int init_open(FILE *file) {
+ tixFile = file;
if (tixFile == 0) {
return 0;
}
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);
}
return tmp;
}
-static void hpc_init(void) {
- int i;
- Info *tmpModule;
+static void
+readTix(void) {
+ unsigned int i;
+ HpcModuleInfo *tmpModule;
- if (hpc_inited != 0) {
- return;
- }
- hpc_inited = 1;
+ totalTixes = 0;
+
+ ws();
+ expect('T');
+ expect('i');
+ expect('x');
+ ws();
+ expect('[');
+ ws();
-
- tixFilename = (char *) malloc(strlen(prog_name) + 6);
- sprintf(tixFilename, "%s.tix", prog_name);
-
- if (init_open(tixFilename)) {
- totalTixes = 0;
-
- 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();
- magicTixNumber = expectWord64();
+ 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('(');
- 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();
- tixBoxes = (StgWord64 *)calloc(totalTixes,sizeof(StgWord64));
-
- expect('[');
- for(i = 0;i < totalTixes;i++) {
- if (i != 0) {
- expect(',');
- ws();
- }
- tixBoxes[i] = expectWord64();
- ws();
+
+ if (!modules) {
+ modules = tmpModule;
+ } else {
+ nextModule->next=tmpModule;
}
- expect(']');
+ nextModule=tmpModule;
+
+ if (tix_ch == ',') {
+ expect(',');
+ ws();
+ }
+ }
+ expect(']');
+ fclose(tixFile);
+}
- fclose(tixFile);
+static void hpc_init(void) {
+ char *hpc_tixdir;
+ if (hpc_inited != 0) {
+ return;
+ }
+ hpc_inited = 1;
+ hpc_pid = getpid();
+ hpc_tixdir = getenv("HPCTIXDIR");
+
+ 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
+ /* Then, try open the file
+ */
+ tixFilename = (char *) malloc(strlen(hpc_tixdir) + strlen(prog_name) + 12);
+ sprintf(tixFilename,"%s/%s-%d.tix",hpc_tixdir,prog_name,hpc_pid);
} else {
- // later, we will find a binary specific
- magicTixNumber = (StgWord64)0;
+ tixFilename = (char *) malloc(strlen(prog_name) + 6);
+ sprintf(tixFilename, "%s.tix", prog_name);
+ }
+
+ if (init_open(fopen(tixFilename,"r"))) {
+ readTix();
}
}
*/
int
-hs_hpc_module(char *modName,int modCount,StgWord64 *tixArr) {
- Info *tmpModule, *lastModule;
- int i;
+hs_hpc_module(char *modName,
+ StgWord32 modCount,
+ StgWord32 modHashNo,
+ StgWord64 *tixArr) {
+ HpcModuleInfo *tmpModule, *lastModule;
+ unsigned 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,(nat)modCount);
hpc_init();
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;
}
// 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;
if (lastModule) {
tmpModule->tickOffset = lastModule->tickOffset + lastModule->tickCount;
} else {
lastModule->next=tmpModule;
}
-#if DEBUG_HPC
- fprintf(stderr,"end: hs_hpc_module\n");
-#endif
- 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[10000];
-static int specialOpBP = 0;
-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) {
-#if DEBUG_HPC
- fprintf(stderr,"hs_hpc_tick(%x)\n",rixOp);
-#endif
- 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 || (specialOpBP && tid != previousTid)) {
- breakPointCommand(rixOp,tid);
- } else {
- if (rixOp >= 0) {
- // Tix op
- if (tixBoxBP[rixOp] == 1) { // reached a bp tixbox
- breakPointCommand(rixOp,tid);
- }
- } else {
- // Special op
- if (specialOpBP) {
- breakPointCommand(rixOp,tid);
- }
- }
- }
- // update the history information.
- previousTid = tid;
- rixOpBack[rixCounter % WOP_SIZE] = rixOp;
- rixTidBack[rixCounter % WOP_SIZE] = tid;
- rixCounter++;
-
-#if DEBUG_HPC
- fprintf(stderr,"end: hs_hpc_tick\n");
-#endif
-}
+ debugTrace(DEBUG_hpc,"end: hs_hpc_module");
-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);
- switch(rixOp) {
- case RixThreadFinishedOp:
- fprintf(out,"ThreadFinished\n");
- case RixRaiseOp:
- fprintf(out,"Raise\n");
- case RixFinishedOp:
- fprintf(out,"Finished\n");
- default:
- fprintf(out,"%u\n",rixOp);
- }
+ return offset;
}
-static void
-breakPointCommand(HpcRixOp rixOp, StgThreadID rixTid) {
- StgWord64 tmp64 = 0;
- unsigned int tmp = 0;
- 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.
- */
- 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);
- }
-#if DEBUG_HPC
- fprintf(stderr,"setting countBP = %" PRIuWORD64 "\n",tmp64);
-#endif
- 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);
- }
-#if DEBUG_HPC
- fprintf(stderr,"seting bp for tix %d\n",tmp);
-#endif
- 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);
- }
-#if DEBUG_HPC
- fprintf(stderr,"unseting bp for tix %d\n",tmp);
-#endif
- 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;
- } 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:
-#if DEBUG_HPC
- fprintf(stderr,"strange command from HPCRIX (%d)\n",c);
-#endif
- 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
- }
-#if DEBUG_HPC
- fprintf(stderr,"re entering program\n");
-#endif
-}
/* This is called after all the modules have registered their local tixboxes,
* and does a sanity check: are we good to go?
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;
-
- 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,",");
- } else {
- comma = 1;
- }
- 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);
-
- // Now we open the command channel.
- hpcRixCmd = getenv("HPCRIXCMD");
- assert(hpcRixCmd != NULL);
- rixCmdFile = fopen(hpcRixCmd,"r");
- assert(rixCmdFile != NULL);
-
- }
-
}
-/* 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;
+static void
+writeTix(FILE *f) {
+ HpcModuleInfo *tmpModule;
+ unsigned int i, inner_comma, outer_comma;
-#if DEBUG_HPC
- fprintf(stderr,"exitHpc\n");
-#endif
+ outer_comma = 0;
- if (hpc_inited == 0) {
+ if (f == 0) {
return;
}
- FILE *f = fopen(tixFilename,"w");
-
- 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)",
- tmpModule->modName,
- tmpModule->tickCount);
-#if DEBUG_HPC
- fprintf(stderr,"%s: %u (offset=%u)\n",
+ fprintf(f," TixModule \"%s\" %u %u [",
tmpModule->modName,
- tmpModule->tickCount,
- tmpModule->tickOffset);
-#endif
- }
- 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);
- }
-
+ (nat)tmpModule->hashNo,
+ (nat)tmpModule->tickCount);
+ debugTrace(DEBUG_hpc,"%s: %u (offset=%u) (hash=%u)\n",
+ tmpModule->modName,
+ (nat)tmpModule->tickCount,
+ (nat)tmpModule->hashNo,
+ (nat)tmpModule->tickOffset);
+
+ inner_comma = 0;
for(i = 0;i < tmpModule->tickCount;i++) {
- if (comma) {
+ if (inner_comma) {
fprintf(f,",");
} else {
- comma = 1;
+ inner_comma = 1;
}
if (tmpModule->tixArr) {
} else {
fprintf(f,"0");
}
-
}
+ fprintf(f,"]");
}
-
fprintf(f,"]\n");
+
fclose(f);
+}
- if (rixFile != NULL) {
- hs_hpc_tick(RixFinishedOp,(StgThreadID)0);
- fclose(rixFile);
+/* 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 (hpc_inited == 0) {
+ return;
}
- if (rixCmdFile != NULL) {
- fclose(rixCmdFile);
+
+ // 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.
+
+ if (hpc_pid == getpid()) {
+ FILE *f = fopen(tixFilename,"w");
+ writeTix(f);
}
-
}
+//////////////////////////////////////////////////////////////////////////////
+// This is the API into Hpc RTS from Haskell, allowing the tixs boxes
+// to be first class.
+
+HpcModuleInfo *hs_hpc_rootModule(void) {
+ return modules;
+}
projects / ghc-hetmet.git / blobdiff