Hpc.c 9.05 KB
Newer Older
andy@galois.com's avatar
andy@galois.com committed
1
2
3
4
5
6
7
8
9
10
/*
 * (c)2006 Galois Connections, Inc.
 */ 

#include <stdio.h>
#include <ctype.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include "HsFFI.h"
andy@galois.com's avatar
andy@galois.com committed
11

12
#include "Rts.h"
andy@galois.com's avatar
andy@galois.com committed
13
14
15
16
17
18
19
20
21
#include "Hpc.h"

/* This is the runtime support for the Haskell Program Coverage (hpc) toolkit,
 * inside GHC.
 *
 */

#define DEBUG_HPC 0

22
23
24
25
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
andy@galois.com's avatar
andy@galois.com committed
26

27
static FILE *rixFile = NULL;		// The tracer file/pipe
andy@galois.com's avatar
andy@galois.com committed
28

andy@galois.com's avatar
andy@galois.com committed
29
30
31
32
33
34
35
36
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;

37
38
39
40
41
42
43
// 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

andy@galois.com's avatar
andy@galois.com committed
44
45
46
47
48
49
50
Info *modules = 0;
Info *nextModule = 0;
StgWord64 *tixBoxes = 0;	// local copy of tixBoxes array, from file.
int totalTixes = 0;		// total number of tix boxes.



51
static char *tixFilename;
andy@galois.com's avatar
andy@galois.com committed
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

static void failure(char *msg) {
  printf("Hpc failure: %s\n",msg);
  printf("(perhaps remove .tix file?)\n");
  exit(-1);
}


static int init_open(char *filename) 
{
  tixFile = fopen(filename,"r");
 if (tixFile == 0) {
    return 0;
  }
  tix_ch = getc(tixFile);
  return 1;
}

static void expect(char c) {
  if (tix_ch != c) {
    printf("Hpc: parse failed (%c,%c)\n",tix_ch,c);
    exit(-1);
  }
  tix_ch = getc(tixFile);
}

static void ws(void) {
  while (tix_ch == ' ') {
    tix_ch = getc(tixFile);
  }
}

static char *expectString(void) {
  char tmp[256], *res;
  int tmp_ix = 0;
  expect('"');
  while (tix_ch != '"') {
    tmp[tmp_ix++] = tix_ch;
    tix_ch = getc(tixFile);
  }
  tmp[tmp_ix++] = 0;
  expect('"');
  res = malloc(tmp_ix);
  strcpy(res,tmp);
  return res;
}

static StgWord64 expectWord64(void) {
  StgWord64 tmp = 0;
  while (isdigit(tix_ch)) {
    tmp = tmp * 10 + (tix_ch -'0');
    tix_ch = getc(tixFile);
  }
  return tmp;
}

static void hpc_init(void) {
  int i;
  Info *tmpModule;  

  if (hpc_inited != 0) {
    return;
  }
  hpc_inited = 1;
  
117
118
119
120

  tixFilename = (char *) malloc(strlen(prog_name) + 6);
  sprintf(tixFilename, "%s.tix", prog_name);

andy@galois.com's avatar
andy@galois.com committed
121
122
123
124
125
126
127
128
  if (init_open(tixFilename)) { 
    totalTixes = 0;

    ws();
    expect('T');
    expect('i');
    expect('x');
    ws();
129
    magicTixNumber = expectWord64();
andy@galois.com's avatar
andy@galois.com committed
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
    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(')');
      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();
161
162
      }
    }
andy@galois.com's avatar
andy@galois.com committed
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
    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);
179
180
181
  } else {
    // later, we will find a binary specific 
    magicTixNumber = (StgWord64)0;
andy@galois.com's avatar
andy@galois.com committed
182
183
184
185
186
187
188
189
  }
}

/* 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.
 */

andy@galois.com's avatar
andy@galois.com committed
190
int
andy@galois.com's avatar
andy@galois.com committed
191
192
193
hs_hpc_module(char *modName,int modCount,StgWord64 *tixArr) {
  Info *tmpModule, *lastModule;
  int i;
andy@galois.com's avatar
andy@galois.com committed
194
  int offset = 0;
andy@galois.com's avatar
andy@galois.com committed
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
  
#if DEBUG_HPC
  printf("hs_hpc_module(%s,%d)\n",modName,modCount);
#endif

  hpc_init();

  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];
      }
andy@galois.com's avatar
andy@galois.com committed
216
      return tmpModule->tickOffset;
andy@galois.com's avatar
andy@galois.com committed
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
    }
    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;
  }
  tmpModule->tixArr = tixArr;
  for(i=0;i < modCount;i++) {
    tixArr[i] = 0;
  }
  tmpModule->next = 0;

  if (!modules) {
    modules = tmpModule;
  } else {
    lastModule->next=tmpModule;
  }

#if DEBUG_HPC
  printf("end: hs_hpc_module\n");
#endif
andy@galois.com's avatar
andy@galois.com committed
244
245
246
  return offset;
}

247
248
249
250
251
252
253
254
255
256
257
258
static StgThreadID previous_tid = 0;

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 = current_tso->id;
    // How do we print StgWord32's without a cast?
    fprintf(rixFile,"Thread %d\n",(unsigned int)tid);
  }
}
andy@galois.com's avatar
andy@galois.com committed
259
260
261
262
263

/*
 * Called on *every* exception thrown
 */
void
264
hs_hpc_throw(StgTSO *current_tso) {
andy@galois.com's avatar
andy@galois.com committed
265
266
267
268
  // 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.
269
270
271
272
273
274

  // This is called on *every* exception, even when Hpc is not enabled.

  if (rixFile != NULL) {
    assert(hpc_inited != 0);
    send_ThreadId(current_tso);
andy@galois.com's avatar
andy@galois.com committed
275
276
277
278
    fprintf(rixFile,"Throw\n");
  }
}

279
/* Called on every tick, dynamically to our file record of program execution
andy@galois.com's avatar
andy@galois.com committed
280
281
282
 */

void
283
hs_hpc_tick(int globIx, StgTSO *current_tso) {
andy@galois.com's avatar
andy@galois.com committed
284
285
286
#if DEBUG_HPC && DEBUG
  printf("hs_hpc_tick(%d)\n",globIx);
#endif
287
288
289
290
  assert(hpc_inited != 0);
  if (rixFile != NULL) {
    send_ThreadId(current_tso);
    fprintf(rixFile,"%d\n",globIx);
andy@galois.com's avatar
andy@galois.com committed
291
292
293
294
295
296
  }

#if DEBUG_HPC
  printf("end: hs_hpc_tick\n");
#endif
  
andy@galois.com's avatar
andy@galois.com committed
297
298
299
300
301
302
303
304
305
}

/* 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;
306
  char *hpcRix;
andy@galois.com's avatar
andy@galois.com committed
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
#if DEBUG_HPC
  printf("startupHpc\n");
#endif
 
 if (hpc_inited == 0) {
    return;
  }

  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);
      }
    }
  }
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363

  // 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,",");
      } 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);
  }

andy@galois.com's avatar
andy@galois.com committed
364
365
}

andy@galois.com's avatar
andy@galois.com committed
366

andy@galois.com's avatar
andy@galois.com committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
/* 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

  if (hpc_inited == 0) {
    return;
  }

  FILE *f = fopen(tixFilename,"w");
  
  comma = 0;

387
  fprintf(f,"Tix %" PRIuWORD64 " [", magicTixNumber);
andy@galois.com's avatar
andy@galois.com committed
388
389
390
391
392
393
394
  tmpModule = modules;
  for(;tmpModule != 0;tmpModule = tmpModule->next) {
    if (comma) {
      fprintf(f,",");
    } else {
      comma = 1;
    }
395
    fprintf(f,"(\"%s\",%u)",
andy@galois.com's avatar
andy@galois.com committed
396
397
398
	   tmpModule->modName,
	    tmpModule->tickCount);
#if DEBUG_HPC
399
    fprintf(stderr,"%s: %u (offset=%u)\n",
andy@galois.com's avatar
andy@galois.com committed
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
	   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);
      }

    for(i = 0;i < tmpModule->tickCount;i++) {
      if (comma) {
	fprintf(f,",");
      } else {
	comma = 1;
      }

      if (tmpModule->tixArr) {
423
	fprintf(f,"%" PRIuWORD64,tmpModule->tixArr[i]);
andy@galois.com's avatar
andy@galois.com committed
424
425
426
427
428
429
430
431
432
      } else {
	fprintf(f,"0");
      }

    }
  }
      
  fprintf(f,"]\n");
  fclose(f);
andy@galois.com's avatar
andy@galois.com committed
433

434
  if (rixFile != NULL) {
435
    fprintf(rixFile,"Finished\n");
andy@galois.com's avatar
andy@galois.com committed
436
437
    fclose(rixFile);
  }
andy@galois.com's avatar
andy@galois.com committed
438
439
440
  
}