#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
*
*/
-#define WOP_SIZE 1024
-
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 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"
#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;
static void
readTix(void) {
- int i;
- Info *tmpModule;
+ unsigned int i;
+ HpcModuleInfo *tmpModule;
totalTixes = 0;
ws();
while(tix_ch != ']') {
- tmpModule = (Info *)calloc(1,sizeof(Info));
+ tmpModule = (HpcModuleInfo *)calloc(1,sizeof(HpcModuleInfo));
expect('T');
expect('i');
expect('x');
}
static void hpc_init(void) {
+ char *hpc_tixdir;
if (hpc_inited != 0) {
return;
}
hpc_inited = 1;
-
- tixFilename = (char *) malloc(strlen(prog_name) + 6);
- sprintf(tixFilename, "%s.tix", prog_name);
+ 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 {
+ 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,
- int modHashNo,
+ StgWord32 modCount,
+ StgWord32 modHashNo,
StgWord64 *tixArr) {
- Info *tmpModule, *lastModule;
- int i;
+ HpcModuleInfo *tmpModule, *lastModule;
+ unsigned int i;
int offset = 0;
- debugTrace(DEBUG_hpc,"hs_hpc_module(%s,%d)",modName,modCount);
+ debugTrace(DEBUG_hpc,"hs_hpc_module(%s,%d)",modName,(nat)modCount);
hpc_init();
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;
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?
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));
- }
-
}
static void
writeTix(FILE *f) {
- Info *tmpModule;
- int i, inner_comma, outer_comma;
+ HpcModuleInfo *tmpModule;
+ unsigned int i, inner_comma, outer_comma;
outer_comma = 0;
}
fprintf(f," TixModule \"%s\" %u %u [",
tmpModule->modName,
- tmpModule->hashNo,
- tmpModule->tickCount);
+ (nat)tmpModule->hashNo,
+ (nat)tmpModule->tickCount);
debugTrace(DEBUG_hpc,"%s: %u (offset=%u) (hash=%u)\n",
tmpModule->modName,
- tmpModule->tickCount,
- tmpModule->hashNo,
- tmpModule->tickOffset);
+ (nat)tmpModule->tickCount,
+ (nat)tmpModule->hashNo,
+ (nat)tmpModule->tickOffset);
inner_comma = 0;
for(i = 0;i < tmpModule->tickCount;i++) {
return;
}
- FILE *f = fopen(tixFilename,"w");
- writeTix(f);
+ // 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 (rixFile != NULL) {
- hs_hpc_tick(RixFinishedOp,(StgThreadID)0);
- fclose(rixFile);
+ if (hpc_pid == getpid()) {
+ FILE *f = fopen(tixFilename,"w");
+ writeTix(f);
}
- if (rixCmdFile != NULL) {
- fclose(rixCmdFile);
- }
-
}
-void hs_hpc_read(char *filename) {
- Info *orig_modules = 0, *tmpModule, *tmpOrigModule;
- int i;
+//////////////////////////////////////////////////////////////////////////////
+// This is the API into Hpc RTS from Haskell, allowing the tixs boxes
+// to be first class.
- 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;
- }
- }
- }
- }
+HpcModuleInfo *hs_hpc_rootModule(void) {
+ return modules;
}
-
-void hs_hpc_write(char *filename) {
- writeTix(fopen(filename,"w"));
-}
-
-
-