[project @ 2000-04-14 15:18:05 by sewardj]
[ghc-hetmet.git] / ghc / rts / Printer.c
1 /* -----------------------------------------------------------------------------
2  * $Id: Printer.c,v 1.25 2000/04/14 15:18:06 sewardj Exp $
3  *
4  * (c) The GHC Team, 1994-2000.
5  *
6  * Heap printer
7  * 
8  * ---------------------------------------------------------------------------*/
9
10 #include "Rts.h"
11 #include "Printer.h"
12
13 #ifdef DEBUG
14
15 #include "RtsUtils.h"
16 #include "RtsFlags.h"
17 #include "Bytecodes.h"  /* for InstrPtr */
18 #include "Disassembler.h"
19
20 #include "Printer.h"
21
22 // HWL: explicit fixed header size to make debugging easier
23 int fixed_hs = FIXED_HS, itbl_sz = sizeofW(StgInfoTable), 
24     uf_sz=sizeofW(StgUpdateFrame), sf_sz=sizeofW(StgSeqFrame); 
25
26 /* --------------------------------------------------------------------------
27  * local function decls
28  * ------------------------------------------------------------------------*/
29
30 static void    printStdObject( StgClosure *obj, char* tag );
31 static void    reset_table   ( int size );
32 static void    prepare_table ( void );
33 static void    insert        ( unsigned value, const char *name );
34 #if 0 /* unused but might be useful sometime */
35 static rtsBool lookup_name   ( char *name, unsigned *result );
36 static void    enZcode       ( char *in, char *out );
37 #endif
38 static char    unZcode       ( char ch );
39 rtsBool lookupGHCName ( StgPtr addr, const char **result );
40 static void    printZcoded   ( const char *raw );
41
42 /* --------------------------------------------------------------------------
43  * Printer
44  * ------------------------------------------------------------------------*/
45
46 #ifdef INTERPRETER
47 char* lookupHugsItblName ( void* itbl );
48 #endif
49
50 void printPtr( StgPtr p )
51 {
52 #ifdef INTERPRETER
53     char* str;
54 #endif
55     const char *raw;
56     if (lookupGHCName( p, &raw )) {
57         printZcoded(raw);
58 #ifdef INTERPRETER
59     } else if ((raw = lookupHugsName(p)) != 0) {
60         fprintf(stderr, "%s", raw);
61     } else if ((str = lookupHugsItblName(p)) != 0) {
62         fprintf(stderr, "%p=%s", p, str);
63 #endif
64     } else {
65         fprintf(stderr, "%p", p);
66     }
67 }
68   
69 void printObj( StgClosure *obj )
70 {
71     fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
72     printClosure(obj);
73 }
74
75 static void printStdObject( StgClosure *obj, char* tag )
76 {
77     StgWord i, j;
78     const StgInfoTable* info = get_itbl(obj);
79     fprintf(stderr,"%s(",tag);
80     printPtr((StgPtr)obj->header.info);
81     for (i = 0; i < info->layout.payload.ptrs; ++i) {
82         fprintf(stderr,", ");
83         printPtr((StgPtr)obj->payload[i]);
84     }
85     for (j = 0; j < info->layout.payload.nptrs; ++j) {
86         fprintf(stderr,", %pd#",obj->payload[i+j]);
87     }
88     fprintf(stderr,")\n");
89 }
90
91 void printClosure( StgClosure *obj )
92 {
93     switch ( get_itbl(obj)->type ) {
94     case INVALID_OBJECT:
95             barf("Invalid object");
96 #ifdef INTERPRETER
97     case BCO:
98             fprintf(stderr,"BCO\n");
99             disassemble(stgCast(StgBCO*,obj),"\t");
100             break;
101 #endif
102
103     case AP_UPD:
104         {
105             StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
106             StgWord i;
107             fprintf(stderr,"AP_UPD("); printPtr((StgPtr)ap->fun);
108             for (i = 0; i < ap->n_args; ++i) {
109                 fprintf(stderr,", ");
110                 printPtr(ap->payload[i]);
111             }
112             fprintf(stderr,")\n");
113             break;
114         }
115
116     case PAP:
117         {
118             StgPAP* pap = stgCast(StgPAP*,obj);
119             StgWord i;
120             fprintf(stderr,"PAP("); printPtr((StgPtr)pap->fun);
121             for (i = 0; i < pap->n_args; ++i) {
122                 fprintf(stderr,", ");
123                 printPtr((StgPtr)pap->payload[i]);
124             }
125             fprintf(stderr,")\n");
126             break;
127         }
128
129     case IND:
130             fprintf(stderr,"IND("); 
131             printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
132             fprintf(stderr,")\n"); 
133             break;
134
135     case IND_STATIC:
136             fprintf(stderr,"IND_STATIC("); 
137             printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
138             fprintf(stderr,")\n"); 
139             break;
140
141     case IND_OLDGEN:
142             fprintf(stderr,"IND_OLDGEN("); 
143             printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
144             fprintf(stderr,")\n"); 
145             break;
146
147     case CAF_UNENTERED:
148         {
149             StgCAF* caf = stgCast(StgCAF*,obj);
150             fprintf(stderr,"CAF_UNENTERED("); 
151             printPtr((StgPtr)caf->body);
152             fprintf(stderr,", ");
153             printPtr((StgPtr)caf->value); /* should be null */
154             fprintf(stderr,", ");
155             printPtr((StgPtr)caf->link);
156             fprintf(stderr,")\n"); 
157             break;
158         }
159
160     case CAF_ENTERED:
161         {
162             StgCAF* caf = stgCast(StgCAF*,obj);
163             fprintf(stderr,"CAF_ENTERED("); 
164             printPtr((StgPtr)caf->body);
165             fprintf(stderr,", ");
166             printPtr((StgPtr)caf->value);
167             fprintf(stderr,", ");
168             printPtr((StgPtr)caf->link);
169             fprintf(stderr,")\n"); 
170             break;
171         }
172
173     case CAF_BLACKHOLE:
174             fprintf(stderr,"CAF_BH("); 
175             printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
176             fprintf(stderr,")\n"); 
177             break;
178
179     case SE_BLACKHOLE:
180             fprintf(stderr,"SE_BH\n"); 
181             break;
182
183     case SE_CAF_BLACKHOLE:
184             fprintf(stderr,"SE_CAF_BH\n"); 
185             break;
186
187     case BLACKHOLE:
188             fprintf(stderr,"BH\n"); 
189             break;
190
191     case BLACKHOLE_BQ:
192             fprintf(stderr,"BQ("); 
193             printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
194             fprintf(stderr,")\n"); 
195             break;
196
197     case TSO:
198       fprintf(stderr,"TSO("); 
199       fprintf(stderr,"%d (%x)", 
200               stgCast(StgTSO*,obj)->id, stgCast(StgTSO*,obj));
201       fprintf(stderr,")\n"); 
202       break;
203
204 #if defined(PAR)
205     case BLOCKED_FETCH:
206       fprintf(stderr,"BLOCKED_FETCH("); 
207       printGA(&(stgCast(StgBlockedFetch*,obj)->ga));
208       printPtr((StgPtr)(stgCast(StgBlockedFetch*,obj)->node));
209       fprintf(stderr,")\n"); 
210       break;
211
212     case FETCH_ME:
213       fprintf(stderr,"FETCH_ME("); 
214       printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
215       fprintf(stderr,")\n"); 
216       break;
217
218     case FETCH_ME_BQ:
219       fprintf(stderr,"FETCH_ME_BQ("); 
220       // printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
221       printPtr((StgPtr)stgCast(StgFetchMeBlockingQueue*,obj)->blocking_queue);
222       fprintf(stderr,")\n"); 
223       break;
224 #endif
225 #if defined(GRAN) || defined(PAR)
226     case RBH:
227       fprintf(stderr,"RBH("); 
228       printPtr((StgPtr)stgCast(StgRBH*,obj)->blocking_queue);
229       fprintf(stderr,")\n"); 
230       break;
231
232 #endif
233
234     case CONSTR:
235     case CONSTR_1_0: case CONSTR_0_1:
236     case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
237     case CONSTR_INTLIKE:
238     case CONSTR_CHARLIKE:
239     case CONSTR_STATIC:
240     case CONSTR_NOCAF_STATIC:
241         {
242             /* We can't use printStdObject because we want to print the
243              * tag as well.
244              */
245             StgWord i, j;
246             const StgInfoTable* info = get_itbl(obj);
247             fprintf(stderr,"PACK(");
248             printPtr((StgPtr)obj->header.info);
249             fprintf(stderr,"(tag=%d)",info->srt_len);
250             for (i = 0; i < info->layout.payload.ptrs; ++i) {
251                 fprintf(stderr,", ");
252                 printPtr((StgPtr)obj->payload[i]);
253             }
254             for (j = 0; j < info->layout.payload.nptrs; ++j) {
255                 fprintf(stderr,", %p#", obj->payload[i+j]);
256             }
257             fprintf(stderr,")\n");
258             break;
259         }
260
261     case FUN:
262     case FUN_1_0: case FUN_0_1: 
263     case FUN_1_1: case FUN_0_2: case FUN_2_0:
264     case FUN_STATIC:
265             printStdObject(obj,"FUN");
266             break;
267
268     case THUNK:
269     case THUNK_1_0: case THUNK_0_1:
270     case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
271     case THUNK_STATIC:
272             /* ToDo: will this work for THUNK_STATIC too? */
273             printStdObject(obj,"THUNK");
274             break;
275
276     case THUNK_SELECTOR:
277             printStdObject(obj,"THUNK_SELECTOR");
278             break;
279
280     case ARR_WORDS:
281         {
282             StgWord i;
283             fprintf(stderr,"ARR_WORDS(\"");
284             /* ToDo: we can't safely assume that this is a string! 
285             for (i = 0; arrWordsGetChar(obj,i); ++i) {
286                 putchar(arrWordsGetChar(obj,i));
287                 } */
288             for (i=0; i<((StgArrWords *)obj)->words; i++)
289               fprintf(stderr, "%d", ((StgArrWords *)obj)->payload[i]);
290             fprintf(stderr,"\")\n");
291             break;
292         }
293
294     case UPDATE_FRAME:
295         {
296             StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
297             fprintf(stderr,"UpdateFrame(");
298             printPtr((StgPtr)GET_INFO(u));
299             fprintf(stderr,",");
300             printPtr((StgPtr)u->updatee);
301             fprintf(stderr,",");
302             printPtr((StgPtr)u->link);
303             fprintf(stderr,")\n"); 
304             break;
305         }
306
307     case CATCH_FRAME:
308         {
309             StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
310             fprintf(stderr,"CatchFrame(");
311             printPtr((StgPtr)GET_INFO(u));
312             fprintf(stderr,",");
313             printPtr((StgPtr)u->handler);
314             fprintf(stderr,",");
315             printPtr((StgPtr)u->link);
316             fprintf(stderr,")\n"); 
317             break;
318         }
319
320     case SEQ_FRAME:
321         {
322             StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
323             fprintf(stderr,"SeqFrame(");
324             printPtr((StgPtr)GET_INFO(u));
325             fprintf(stderr,",");
326             printPtr((StgPtr)u->link);
327             fprintf(stderr,")\n"); 
328             break;
329         }
330
331     case STOP_FRAME:
332         {
333             StgStopFrame* u = stgCast(StgStopFrame*,obj);
334             fprintf(stderr,"StopFrame(");
335             printPtr((StgPtr)GET_INFO(u));
336             fprintf(stderr,")\n"); 
337             break;
338         }
339     default:
340             //barf("printClosure %d",get_itbl(obj)->type);
341             fprintf(stderr, "*** printClosure: unknown type %d ****\n",
342                     get_itbl(obj)->type );
343             return;
344     }
345 }
346
347 /*
348 void printGraph( StgClosure *obj )
349 {
350  printClosure(obj);
351 }
352 */
353
354 StgPtr printStackObj( StgPtr sp )
355 {
356     /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
357
358     if (IS_ARG_TAG(*sp)) {
359         nat i;
360         StgWord tag = *sp++;
361         fprintf(stderr,"Tagged{");
362         for (i = 0; i < tag; i++) {
363             fprintf(stderr,"0x%x#", (unsigned)(*sp++));
364             if (i < tag-1) fprintf(stderr, ", ");
365         }
366         fprintf(stderr, "}\n");
367     } else {
368         StgClosure* c = (StgClosure*)(*sp);
369         printPtr((StgPtr)*sp);
370 #ifdef INTERPRETER
371         if (c == &ret_bco_info) {
372            fprintf(stderr, "\t\t");
373            fprintf(stderr, "ret_bco_info\n" );
374         } else
375         if (IS_HUGS_CONSTR_INFO(GET_INFO(c))) {
376            fprintf(stderr, "\t\t\t");
377            fprintf(stderr, "ConstrInfoTable\n" );
378         } else
379 #endif
380         if (get_itbl(c)->type == BCO) {
381            fprintf(stderr, "\t\t\t");
382            fprintf(stderr, "BCO(...)\n"); 
383         }
384         else {
385            fprintf(stderr, "\t\t\t");
386            printClosure ( (StgClosure*)(*sp));
387         }
388         sp += 1;
389     }
390     return sp;
391     
392 }
393
394 void printStackChunk( StgPtr sp, StgPtr spBottom )
395 {
396     StgWord32 bitmap;
397     const StgInfoTable *info;
398
399     ASSERT(sp <= spBottom);
400     while (sp < spBottom) {
401       if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
402         info = get_itbl((StgClosure *)sp);
403         switch (info->type) {
404
405         case UPDATE_FRAME:
406             printObj( stgCast(StgClosure*,sp) );
407             sp += sizeofW(StgUpdateFrame);
408             continue;
409
410         case SEQ_FRAME:
411             printObj( stgCast(StgClosure*,sp) );
412             sp += sizeofW(StgSeqFrame);
413             continue;
414
415         case CATCH_FRAME:
416             printObj( stgCast(StgClosure*,sp) );
417             sp += sizeofW(StgCatchFrame);
418             continue;
419
420         case STOP_FRAME:
421             /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
422             printObj( stgCast(StgClosure*,sp) );
423             continue;
424
425         case RET_DYN:
426           fprintf(stderr, "RET_DYN (%p)\n", sp);
427           bitmap = *++sp;
428           ++sp;
429           fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
430           goto small_bitmap;
431
432         case RET_SMALL:
433         case RET_VEC_SMALL:
434           fprintf(stderr, "RET_SMALL (%p)\n", sp);
435           bitmap = info->layout.bitmap;
436           sp++;
437         small_bitmap:
438           while (bitmap != 0) {
439             fprintf(stderr,"   stk[%d] (%p) = ", spBottom-sp, sp);
440             if ((bitmap & 1) == 0) {
441               printPtr((P_)*sp);
442               fprintf(stderr,"\n");
443             } else {
444               fprintf(stderr,"Word# %d\n", *sp++);
445             }         
446             sp++;
447             bitmap = bitmap >> 1;
448             }
449           continue;
450
451         case RET_BIG:
452         case RET_VEC_BIG:
453           barf("todo");
454
455         default:
456           break;
457         }
458       }
459       fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
460       sp = printStackObj(sp);
461     }
462 }
463
464 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
465 {
466     /* check everything down to the first update frame */
467     printStackChunk( sp, stgCast(StgPtr,su) );
468     while ( stgCast(StgPtr,su) < spBottom) {
469         sp = stgCast(StgPtr,su);
470         switch (get_itbl(su)->type) {
471         case UPDATE_FRAME:
472                 printObj( stgCast(StgClosure*,su) );
473                 sp += sizeofW(StgUpdateFrame);
474                 su = su->link;
475                 break;
476         case SEQ_FRAME:
477                 printObj( stgCast(StgClosure*,su) );
478                 sp += sizeofW(StgSeqFrame);
479                 su = stgCast(StgSeqFrame*,su)->link;
480                 break;
481         case CATCH_FRAME:
482                 printObj( stgCast(StgClosure*,su) );
483                 sp += sizeofW(StgCatchFrame);
484                 su = stgCast(StgCatchFrame*,su)->link;
485                 break;
486         case STOP_FRAME:
487                 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
488                 printObj( stgCast(StgClosure*,su) );
489                 return;
490         default:
491                 barf("printStack: weird record found on update frame list.");
492         }
493         printStackChunk( sp, stgCast(StgPtr,su) );
494     }
495     ASSERT(stgCast(StgPtr,su) == spBottom);
496 }
497
498 void printTSO( StgTSO *tso )
499 {
500     printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
501     /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
502 }
503
504 /* -----------------------------------------------------------------------------
505    Closure types
506    
507    NOTE: must be kept in sync with the closure types in includes/ClosureTypes.h
508    -------------------------------------------------------------------------- */
509
510 static char *closure_type_names[] = {
511   "INVALID_OBJECT",             /* 0  */
512   "CONSTR",                     /* 1  */
513   "CONSTR_1_0",                 /* 2  */
514   "CONSTR_0_1",                 /* 3  */
515   "CONSTR_2_0",                 /* 4  */
516   "CONSTR_1_1",                 /* 5  */
517   "CONSTR_0_2",                 /* 6  */
518   "CONSTR_INTLIKE",             /* 7  */
519   "CONSTR_CHARLIKE",            /* 8  */
520   "CONSTR_STATIC",              /* 9  */
521   "CONSTR_NOCAF_STATIC",        /* 10 */
522   "FUN",                        /* 11 */
523   "FUN_1_0",                    /* 12 */
524   "FUN_0_1",                    /* 13 */
525   "FUN_2_0",                    /* 14 */
526   "FUN_1_1",                    /* 15 */
527   "FUN_0_2",                    /* 16 */
528   "FUN_STATIC",                 /* 17 */
529   "THUNK",                      /* 18 */
530   "THUNK_1_0",                  /* 19 */
531   "THUNK_0_1",                  /* 20 */
532   "THUNK_2_0",                  /* 21 */
533   "THUNK_1_1",                  /* 22 */
534   "THUNK_0_2",                  /* 23 */
535   "THUNK_STATIC",               /* 24 */
536   "THUNK_SELECTOR",             /* 25 */
537   "BCO",                        /* 26 */
538   "AP_UPD",                     /* 27 */
539   "PAP",                        /* 28 */
540   "IND",                        /* 29 */
541   "IND_OLDGEN",                 /* 30 */
542   "IND_PERM",                   /* 31 */
543   "IND_OLDGEN_PERM",            /* 32 */
544   "IND_STATIC",                 /* 33 */
545   "CAF_UNENTERED",              /* 34 */
546   "CAF_ENTERED",                /* 35 */
547   "CAF_BLACKHOLE",              /* 36 */
548   "RET_BCO",                    /* 37 */
549   "RET_SMALL",                  /* 38 */
550   "RET_VEC_SMALL",              /* 39 */
551   "RET_BIG",                    /* 40 */
552   "RET_VEC_BIG",                /* 41 */
553   "RET_DYN",                    /* 42 */
554   "UPDATE_FRAME",               /* 43 */
555   "CATCH_FRAME",                /* 44 */
556   "STOP_FRAME",                 /* 45 */
557   "SEQ_FRAME",                  /* 46 */
558   "BLACKHOLE",                  /* 47 */
559   "BLACKHOLE_BQ",               /* 48 */
560   "SE_BLACKHOLE",               /* 49 */
561   "SE_CAF_BLACKHOLE",           /* 50 */
562   "MVAR",                       /* 51 */
563   "ARR_WORDS",                  /* 52 */
564   "MUT_ARR_PTRS",               /* 53 */
565   "MUT_ARR_PTRS_FROZEN",        /* 54 */
566   "MUT_VAR",                    /* 55 */
567   "WEAK",                       /* 56 */
568   "FOREIGN",                    /* 57 */
569   "STABLE_NAME",                /* 58 */
570   "TSO",                        /* 59 */
571   "BLOCKED_FETCH",              /* 60 */
572   "FETCH_ME",                   /* 61 */
573   "FETCH_ME_BQ",                /* 62 */
574   "RBH",                        /* 63 */
575   "EVACUATED",                  /* 64 */
576   "N_CLOSURE_TYPES"             /* 65 */
577 };
578
579 char *
580 info_type(StgClosure *closure){ 
581   return closure_type_names[get_itbl(closure)->type];
582 }
583
584 char *
585 info_type_by_ip(StgInfoTable *ip){ 
586   return closure_type_names[ip->type];
587 }
588
589 void
590 info_hdr_type(StgClosure *closure, char *res){ 
591   strcpy(res,closure_type_names[get_itbl(closure)->type]);
592 }
593
594 /* --------------------------------------------------------------------------
595  * Address printing code
596  *
597  * Uses symbol table in (unstripped executable)
598  * ------------------------------------------------------------------------*/
599
600 /* --------------------------------------------------------------------------
601  * Simple lookup table
602  *
603  * Current implementation is pretty dumb!
604  * ------------------------------------------------------------------------*/
605
606 struct entry {
607     nat value;
608     const char *name;
609 };
610
611 static nat max_table_size;
612 static nat table_size;
613 static struct entry* table;
614
615 static void reset_table( int size )
616 {
617     max_table_size = size;
618     table_size = 0;
619     table = (struct entry *) malloc(size * sizeof(struct entry));
620 }
621
622 static void prepare_table( void )
623 {
624     /* Could sort it...  */
625 }
626
627 static void insert( unsigned value, const char *name )
628 {
629     if ( table_size >= max_table_size ) {
630         barf( "Symbol table overflow\n" );
631     }
632     table[table_size].value = value;
633     table[table_size].name = name;
634     table_size = table_size + 1;
635 }
636
637
638 #if 0
639 static rtsBool lookup_name( char *name, unsigned *result )
640 {
641     int i;
642     for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
643     }
644     if (i < table_size) {
645         *result = table[i].value;
646         return rtsTrue;
647     } else {
648         return rtsFalse;
649     }
650 }
651 #endif
652
653 /* Code from somewhere inside GHC (circa 1994)
654  * * Z-escapes:
655  *     "std"++xs -> "Zstd"++xs
656  *     char_to_c 'Z'  = "ZZ"
657  *     char_to_c '&'  = "Za"
658  *     char_to_c '|'  = "Zb"
659  *     char_to_c ':'  = "Zc"
660  *     char_to_c '/'  = "Zd"
661  *     char_to_c '='  = "Ze"
662  *     char_to_c '>'  = "Zg"
663  *     char_to_c '#'  = "Zh"
664  *     char_to_c '<'  = "Zl"
665  *     char_to_c '-'  = "Zm"
666  *     char_to_c '!'  = "Zn"
667  *     char_to_c '.'  = "Zo"
668  *     char_to_c '+'  = "Zp"
669  *     char_to_c '\'' = "Zq"
670  *     char_to_c '*'  = "Zt"
671  *     char_to_c '_'  = "Zu"
672  *     char_to_c c    = "Z" ++ show (ord c)
673  */
674 static char unZcode( char ch )
675 {
676     switch (ch) {
677     case 'a'  : return ('&');
678     case 'b'  : return ('|');
679     case 'c'  : return (':');
680     case 'd'  : return ('/');
681     case 'e'  : return ('=');
682     case 'g'  : return ('>');
683     case 'h'  : return ('#');
684     case 'l'  : return ('<');
685     case 'm'  : return ('-');
686     case 'n'  : return ('!');
687     case 'o'  : return ('.');
688     case 'p'  : return ('+');
689     case 'q'  : return ('\'');
690     case 't'  : return ('*');
691     case 'u'  : return ('_');
692     case 'Z'  :
693     case '\0' : return ('Z');
694     default   : return (ch);
695     }
696 }
697
698 #if 0
699 /* Precondition: out big enough to handle output (about twice length of in) */
700 static void enZcode( char *in, char *out )
701 {
702     int i, j;
703
704     j = 0;
705     out[ j++ ] = '_';
706     for( i = 0; in[i] != '\0'; ++i ) {
707         switch (in[i]) {
708         case 'Z'  : 
709                 out[j++] = 'Z';
710                 out[j++] = 'Z';
711                 break;
712         case '&'  : 
713                 out[j++] = 'Z';
714                 out[j++] = 'a';
715                 break;
716         case '|'  : 
717                 out[j++] = 'Z';
718                 out[j++] = 'b';
719                 break;
720         case ':'  : 
721                 out[j++] = 'Z';
722                 out[j++] = 'c';
723                 break;
724         case '/'  : 
725                 out[j++] = 'Z';
726                 out[j++] = 'd';
727                 break;
728         case '='  : 
729                 out[j++] = 'Z';
730                 out[j++] = 'e';
731                 break;
732         case '>'  : 
733                 out[j++] = 'Z';
734                 out[j++] = 'g';
735                 break;
736         case '#'  : 
737                 out[j++] = 'Z';
738                 out[j++] = 'h';
739                 break;
740         case '<'  : 
741                 out[j++] = 'Z';
742                 out[j++] = 'l';
743                 break;
744         case '-'  : 
745                 out[j++] = 'Z';
746                 out[j++] = 'm';
747                 break;
748         case '!'  : 
749                 out[j++] = 'Z';
750                 out[j++] = 'n';
751                 break;
752         case '.'  : 
753                 out[j++] = 'Z';
754                 out[j++] = 'o';
755                 break;
756         case '+'  : 
757                 out[j++] = 'Z';
758                 out[j++] = 'p';
759                 break;
760         case '\'' : 
761                 out[j++] = 'Z';
762                 out[j++] = 'q';
763                 break;
764         case '*'  : 
765                 out[j++] = 'Z';
766                 out[j++] = 't';
767                 break;
768         case '_'  : 
769                 out[j++] = 'Z';
770                 out[j++] = 'u';
771                 break;
772         default :
773                 out[j++] = in[i];
774                 break;
775         }
776     }
777     out[j] = '\0';
778 }
779 #endif
780
781 rtsBool lookupGHCName( StgPtr addr, const char **result )
782 {
783     nat i;
784     for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
785     }
786     if (i < table_size) {
787         *result = table[i].name;
788         return rtsTrue;
789     } else {
790         return rtsFalse;
791     }
792 }
793
794 static void printZcoded( const char *raw )
795 {
796     nat j = 0;
797     
798     while ( raw[j] != '\0' ) {
799         if (raw[j] == 'Z') {
800             fputc(unZcode(raw[j+1]),stderr);
801             j = j + 2;
802         } else {
803             fputc(raw[j],stderr);
804             j = j + 1;
805         }
806     }
807 }
808
809 /* --------------------------------------------------------------------------
810  * Symbol table loading
811  * ------------------------------------------------------------------------*/
812
813 /* Causing linking trouble on Win32 plats, so I'm
814    disabling this for now. 
815 */
816 /* For now, BFD support is unconditionally disabled -- HWL */
817 #if 0 /* HWL */ && defined(HAVE_BFD_H) && !defined(_WIN32)
818
819 #include <bfd.h>
820
821 /* Fairly ad-hoc piece of code that seems to filter out a lot of
822  * rubbish like the obj-splitting symbols
823  */
824
825 static rtsBool isReal( flagword flags, const char *name )
826 {
827 #if 0
828     /* ToDo: make this work on BFD */
829     int tp = type & N_TYPE;    
830     if (tp == N_TEXT || tp == N_DATA) {
831         return (name[0] == '_' && name[1] != '_');
832     } else {
833         return rtsFalse;
834     }
835 #else
836     (void)flags;   /* keep gcc -Wall happy */
837     if (*name == '\0'  || 
838         (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
839         (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
840         return rtsFalse;
841     }
842     return rtsTrue;
843 #endif
844 }
845
846 extern void DEBUG_LoadSymbols( char *name )
847 {
848     bfd* abfd;
849     char **matching;
850
851     bfd_init();
852     abfd = bfd_openr(name, "default");
853     if (abfd == NULL) {
854         barf("can't open executable %s to get symbol table", name);
855     }
856     if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
857         barf("mismatch");
858     }
859
860     {
861         long storage_needed;
862         asymbol **symbol_table;
863         long number_of_symbols;
864         long num_real_syms = 0;
865         long i;
866      
867         storage_needed = bfd_get_symtab_upper_bound (abfd);
868      
869         if (storage_needed < 0) {
870             barf("can't read symbol table");
871         }     
872 #if 0
873         if (storage_needed == 0) {
874             belch("no storage needed");
875         }
876 #endif
877         symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
878
879         number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
880      
881         if (number_of_symbols < 0) {
882             barf("can't canonicalise symbol table");
883         }
884
885         for( i = 0; i != number_of_symbols; ++i ) {
886             symbol_info info;
887             bfd_get_symbol_info(abfd,symbol_table[i],&info);
888             /*fprintf(stderr,"\t%c\t0x%x      \t%s\n",info.type,(nat)info.value,info.name); */
889             if (isReal(info.type, info.name)) {
890                 num_real_syms += 1;
891             }
892         }
893     
894         IF_DEBUG(evaluator,
895                  fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n", 
896                          number_of_symbols, num_real_syms)
897                  );
898
899         reset_table( num_real_syms );
900     
901         for( i = 0; i != number_of_symbols; ++i ) {
902             symbol_info info;
903             bfd_get_symbol_info(abfd,symbol_table[i],&info);
904             if (isReal(info.type, info.name)) {
905                 insert( info.value, info.name );
906             }
907         }
908         
909         free(symbol_table);
910     }
911     prepare_table();
912 }
913
914 #else /* HAVE_BFD_H */
915
916 extern void DEBUG_LoadSymbols( char *name STG_UNUSED )
917 {
918   /* nothing, yet */
919 }
920
921 #endif /* HAVE_BFD_H */
922
923 #include "StoragePriv.h"
924
925 void
926 findPtr(P_ p)
927 {
928   nat s, g;
929   P_ q;
930   bdescr *bd;
931
932   for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
933     for (s = 0; s < generations[g].n_steps; s++) {
934       for (bd = generations[g].steps[s].blocks; bd; bd = bd->link) {
935         for (q = bd->start; q < bd->free; q++) {
936           if (*q == (W_)p) {
937             printf("%p\n", q);
938           }
939         }
940       }
941     }
942   }
943 }
944
945 #else /* DEBUG */
946 void printPtr( StgPtr p )
947 {
948     fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
949 }
950   
951 void printObj( StgClosure *obj )
952 {
953     fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );
954 }
955 #endif /* DEBUG */