[project @ 2000-06-15 13:23:51 by daan]
[ghc-hetmet.git] / ghc / rts / Printer.c
1 /* -----------------------------------------------------------------------------
2  * $Id: Printer.c,v 1.27 2000/06/15 13:23:52 daan 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 #ifdef XMLAMBDA
262 /* rows are mutarrays in xmlambda, maybe we should make a new type: ROW */
263     case MUT_ARR_PTRS_FROZEN:
264           {
265             StgWord i;
266             StgMutArrPtrs* p = stgCast(StgMutArrPtrs*,obj);
267
268             fprintf(stderr,"Row<%i>(",p->ptrs);
269             for (i = 0; i < p->ptrs; ++i) {
270                 if (i > 0) fprintf(stderr,", ");
271                 printPtr((StgPtr)(p->payload[i]));
272             }
273             fprintf(stderr,")\n");
274             break;
275           }
276 #endif  
277
278     case FUN:
279     case FUN_1_0: case FUN_0_1: 
280     case FUN_1_1: case FUN_0_2: case FUN_2_0:
281     case FUN_STATIC:
282             printStdObject(obj,"FUN");
283             break;
284
285     case THUNK:
286     case THUNK_1_0: case THUNK_0_1:
287     case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
288     case THUNK_STATIC:
289             /* ToDo: will this work for THUNK_STATIC too? */
290             printStdObject(obj,"THUNK");
291             break;
292
293     case THUNK_SELECTOR:
294             printStdObject(obj,"THUNK_SELECTOR");
295             break;
296
297     case ARR_WORDS:
298         {
299             StgWord i;
300             fprintf(stderr,"ARR_WORDS(\"");
301             /* ToDo: we can't safely assume that this is a string! 
302             for (i = 0; arrWordsGetChar(obj,i); ++i) {
303                 putchar(arrWordsGetChar(obj,i));
304                 } */
305             for (i=0; i<((StgArrWords *)obj)->words; i++)
306               fprintf(stderr, "%d", ((StgArrWords *)obj)->payload[i]);
307             fprintf(stderr,"\")\n");
308             break;
309         }
310
311     case UPDATE_FRAME:
312         {
313             StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
314             fprintf(stderr,"UpdateFrame(");
315             printPtr((StgPtr)GET_INFO(u));
316             fprintf(stderr,",");
317             printPtr((StgPtr)u->updatee);
318             fprintf(stderr,",");
319             printPtr((StgPtr)u->link);
320             fprintf(stderr,")\n"); 
321             break;
322         }
323
324     case CATCH_FRAME:
325         {
326             StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
327             fprintf(stderr,"CatchFrame(");
328             printPtr((StgPtr)GET_INFO(u));
329             fprintf(stderr,",");
330             printPtr((StgPtr)u->handler);
331             fprintf(stderr,",");
332             printPtr((StgPtr)u->link);
333             fprintf(stderr,")\n"); 
334             break;
335         }
336
337     case SEQ_FRAME:
338         {
339             StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
340             fprintf(stderr,"SeqFrame(");
341             printPtr((StgPtr)GET_INFO(u));
342             fprintf(stderr,",");
343             printPtr((StgPtr)u->link);
344             fprintf(stderr,")\n"); 
345             break;
346         }
347
348     case STOP_FRAME:
349         {
350             StgStopFrame* u = stgCast(StgStopFrame*,obj);
351             fprintf(stderr,"StopFrame(");
352             printPtr((StgPtr)GET_INFO(u));
353             fprintf(stderr,")\n"); 
354             break;
355         }
356     default:
357             //barf("printClosure %d",get_itbl(obj)->type);
358             fprintf(stderr, "*** printClosure: unknown type %d ****\n",
359                     get_itbl(obj)->type );
360             return;
361     }
362 }
363
364 /*
365 void printGraph( StgClosure *obj )
366 {
367  printClosure(obj);
368 }
369 */
370
371 StgPtr printStackObj( StgPtr sp )
372 {
373     /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
374
375     if (IS_ARG_TAG(*sp)) {
376         nat i;
377         StgWord tag = *sp++;
378         fprintf(stderr,"Tagged{");
379         for (i = 0; i < tag; i++) {
380             fprintf(stderr,"0x%x#", (unsigned)(*sp++));
381             if (i < tag-1) fprintf(stderr, ", ");
382         }
383         fprintf(stderr, "}\n");
384     } else {
385         StgClosure* c = (StgClosure*)(*sp);
386         printPtr((StgPtr)*sp);
387 #ifdef INTERPRETER
388         if (c == &ret_bco_info) {
389            fprintf(stderr, "\t\t");
390            fprintf(stderr, "ret_bco_info\n" );
391         } else
392         if (IS_HUGS_CONSTR_INFO(GET_INFO(c))) {
393            fprintf(stderr, "\t\t\t");
394            fprintf(stderr, "ConstrInfoTable\n" );
395         } else
396 #endif
397         if (get_itbl(c)->type == BCO) {
398            fprintf(stderr, "\t\t\t");
399            fprintf(stderr, "BCO(...)\n"); 
400         }
401         else {
402            fprintf(stderr, "\t\t\t");
403            printClosure ( (StgClosure*)(*sp));
404         }
405         sp += 1;
406     }
407     return sp;
408     
409 }
410
411 void printStackChunk( StgPtr sp, StgPtr spBottom )
412 {
413     StgWord32 bitmap;
414     const StgInfoTable *info;
415
416     ASSERT(sp <= spBottom);
417     while (sp < spBottom) {
418       if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
419         info = get_itbl((StgClosure *)sp);
420         switch (info->type) {
421
422         case UPDATE_FRAME:
423             printObj( stgCast(StgClosure*,sp) );
424             sp += sizeofW(StgUpdateFrame);
425             continue;
426
427         case SEQ_FRAME:
428             printObj( stgCast(StgClosure*,sp) );
429             sp += sizeofW(StgSeqFrame);
430             continue;
431
432         case CATCH_FRAME:
433             printObj( stgCast(StgClosure*,sp) );
434             sp += sizeofW(StgCatchFrame);
435             continue;
436
437         case STOP_FRAME:
438             /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
439             printObj( stgCast(StgClosure*,sp) );
440             continue;
441
442         case RET_DYN:
443           fprintf(stderr, "RET_DYN (%p)\n", sp);
444           bitmap = *++sp;
445           ++sp;
446           fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
447           goto small_bitmap;
448
449         case RET_SMALL:
450         case RET_VEC_SMALL:
451           fprintf(stderr, "RET_SMALL (%p)\n", sp);
452           bitmap = info->layout.bitmap;
453           sp++;
454         small_bitmap:
455           while (bitmap != 0) {
456             fprintf(stderr,"   stk[%d] (%p) = ", spBottom-sp, sp);
457             if ((bitmap & 1) == 0) {
458               printPtr((P_)*sp);
459               fprintf(stderr,"\n");
460             } else {
461               fprintf(stderr,"Word# %d\n", *sp++);
462             }         
463             sp++;
464             bitmap = bitmap >> 1;
465             }
466           continue;
467
468         case RET_BIG:
469         case RET_VEC_BIG:
470           barf("todo");
471
472         default:
473           break;
474         }
475       }
476       fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
477       sp = printStackObj(sp);
478     }
479 }
480
481 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
482 {
483     /* check everything down to the first update frame */
484     printStackChunk( sp, stgCast(StgPtr,su) );
485     while ( stgCast(StgPtr,su) < spBottom) {
486         sp = stgCast(StgPtr,su);
487         switch (get_itbl(su)->type) {
488         case UPDATE_FRAME:
489                 printObj( stgCast(StgClosure*,su) );
490                 sp += sizeofW(StgUpdateFrame);
491                 su = su->link;
492                 break;
493         case SEQ_FRAME:
494                 printObj( stgCast(StgClosure*,su) );
495                 sp += sizeofW(StgSeqFrame);
496                 su = stgCast(StgSeqFrame*,su)->link;
497                 break;
498         case CATCH_FRAME:
499                 printObj( stgCast(StgClosure*,su) );
500                 sp += sizeofW(StgCatchFrame);
501                 su = stgCast(StgCatchFrame*,su)->link;
502                 break;
503         case STOP_FRAME:
504                 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
505                 printObj( stgCast(StgClosure*,su) );
506                 return;
507         default:
508                 barf("printStack: weird record found on update frame list.");
509         }
510         printStackChunk( sp, stgCast(StgPtr,su) );
511     }
512     ASSERT(stgCast(StgPtr,su) == spBottom);
513 }
514
515 void printTSO( StgTSO *tso )
516 {
517     printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
518     /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
519 }
520
521 /* -----------------------------------------------------------------------------
522    Closure types
523    
524    NOTE: must be kept in sync with the closure types in includes/ClosureTypes.h
525    -------------------------------------------------------------------------- */
526
527 static char *closure_type_names[] = {
528   "INVALID_OBJECT",             /* 0  */
529   "CONSTR",                     /* 1  */
530   "CONSTR_1_0",                 /* 2  */
531   "CONSTR_0_1",                 /* 3  */
532   "CONSTR_2_0",                 /* 4  */
533   "CONSTR_1_1",                 /* 5  */
534   "CONSTR_0_2",                 /* 6  */
535   "CONSTR_INTLIKE",             /* 7  */
536   "CONSTR_CHARLIKE",            /* 8  */
537   "CONSTR_STATIC",              /* 9  */
538   "CONSTR_NOCAF_STATIC",        /* 10 */
539   "FUN",                        /* 11 */
540   "FUN_1_0",                    /* 12 */
541   "FUN_0_1",                    /* 13 */
542   "FUN_2_0",                    /* 14 */
543   "FUN_1_1",                    /* 15 */
544   "FUN_0_2",                    /* 16 */
545   "FUN_STATIC",                 /* 17 */
546   "THUNK",                      /* 18 */
547   "THUNK_1_0",                  /* 19 */
548   "THUNK_0_1",                  /* 20 */
549   "THUNK_2_0",                  /* 21 */
550   "THUNK_1_1",                  /* 22 */
551   "THUNK_0_2",                  /* 23 */
552   "THUNK_STATIC",               /* 24 */
553   "THUNK_SELECTOR",             /* 25 */
554   "BCO",                        /* 26 */
555   "AP_UPD",                     /* 27 */
556   "PAP",                        /* 28 */
557   "IND",                        /* 29 */
558   "IND_OLDGEN",                 /* 30 */
559   "IND_PERM",                   /* 31 */
560   "IND_OLDGEN_PERM",            /* 32 */
561   "IND_STATIC",                 /* 33 */
562   "CAF_UNENTERED",              /* 34 */
563   "CAF_ENTERED",                /* 35 */
564   "CAF_BLACKHOLE",              /* 36 */
565   "RET_BCO",                    /* 37 */
566   "RET_SMALL",                  /* 38 */
567   "RET_VEC_SMALL",              /* 39 */
568   "RET_BIG",                    /* 40 */
569   "RET_VEC_BIG",                /* 41 */
570   "RET_DYN",                    /* 42 */
571   "UPDATE_FRAME",               /* 43 */
572   "CATCH_FRAME",                /* 44 */
573   "STOP_FRAME",                 /* 45 */
574   "SEQ_FRAME",                  /* 46 */
575   "BLACKHOLE",                  /* 47 */
576   "BLACKHOLE_BQ",               /* 48 */
577   "SE_BLACKHOLE",               /* 49 */
578   "SE_CAF_BLACKHOLE",           /* 50 */
579   "MVAR",                       /* 51 */
580   "ARR_WORDS",                  /* 52 */
581   "MUT_ARR_PTRS",               /* 53 */
582   "MUT_ARR_PTRS_FROZEN",        /* 54 */
583   "MUT_VAR",                    /* 55 */
584   "WEAK",                       /* 56 */
585   "FOREIGN",                    /* 57 */
586   "STABLE_NAME",                /* 58 */
587   "TSO",                        /* 59 */
588   "BLOCKED_FETCH",              /* 60 */
589   "FETCH_ME",                   /* 61 */
590   "FETCH_ME_BQ",                /* 62 */
591   "RBH",                        /* 63 */
592   "EVACUATED",                  /* 64 */
593   "N_CLOSURE_TYPES"             /* 65 */
594 };
595
596 char *
597 info_type(StgClosure *closure){ 
598   return closure_type_names[get_itbl(closure)->type];
599 }
600
601 char *
602 info_type_by_ip(StgInfoTable *ip){ 
603   return closure_type_names[ip->type];
604 }
605
606 void
607 info_hdr_type(StgClosure *closure, char *res){ 
608   strcpy(res,closure_type_names[get_itbl(closure)->type]);
609 }
610
611 /* --------------------------------------------------------------------------
612  * Address printing code
613  *
614  * Uses symbol table in (unstripped executable)
615  * ------------------------------------------------------------------------*/
616
617 /* --------------------------------------------------------------------------
618  * Simple lookup table
619  *
620  * Current implementation is pretty dumb!
621  * ------------------------------------------------------------------------*/
622
623 struct entry {
624     nat value;
625     const char *name;
626 };
627
628 static nat max_table_size;
629 static nat table_size;
630 static struct entry* table;
631
632 static void reset_table( int size )
633 {
634     max_table_size = size;
635     table_size = 0;
636     table = (struct entry *) malloc(size * sizeof(struct entry));
637 }
638
639 static void prepare_table( void )
640 {
641     /* Could sort it...  */
642 }
643
644 static void insert( unsigned value, const char *name )
645 {
646     if ( table_size >= max_table_size ) {
647         barf( "Symbol table overflow\n" );
648     }
649     table[table_size].value = value;
650     table[table_size].name = name;
651     table_size = table_size + 1;
652 }
653
654
655 #if 0
656 static rtsBool lookup_name( char *name, unsigned *result )
657 {
658     int i;
659     for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
660     }
661     if (i < table_size) {
662         *result = table[i].value;
663         return rtsTrue;
664     } else {
665         return rtsFalse;
666     }
667 }
668 #endif
669
670 /* Code from somewhere inside GHC (circa 1994)
671  * * Z-escapes:
672  *     "std"++xs -> "Zstd"++xs
673  *     char_to_c 'Z'  = "ZZ"
674  *     char_to_c '&'  = "Za"
675  *     char_to_c '|'  = "Zb"
676  *     char_to_c ':'  = "Zc"
677  *     char_to_c '/'  = "Zd"
678  *     char_to_c '='  = "Ze"
679  *     char_to_c '>'  = "Zg"
680  *     char_to_c '#'  = "Zh"
681  *     char_to_c '<'  = "Zl"
682  *     char_to_c '-'  = "Zm"
683  *     char_to_c '!'  = "Zn"
684  *     char_to_c '.'  = "Zo"
685  *     char_to_c '+'  = "Zp"
686  *     char_to_c '\'' = "Zq"
687  *     char_to_c '*'  = "Zt"
688  *     char_to_c '_'  = "Zu"
689  *     char_to_c c    = "Z" ++ show (ord c)
690  */
691 static char unZcode( char ch )
692 {
693     switch (ch) {
694     case 'a'  : return ('&');
695     case 'b'  : return ('|');
696     case 'c'  : return (':');
697     case 'd'  : return ('/');
698     case 'e'  : return ('=');
699     case 'g'  : return ('>');
700     case 'h'  : return ('#');
701     case 'l'  : return ('<');
702     case 'm'  : return ('-');
703     case 'n'  : return ('!');
704     case 'o'  : return ('.');
705     case 'p'  : return ('+');
706     case 'q'  : return ('\'');
707     case 't'  : return ('*');
708     case 'u'  : return ('_');
709     case 'Z'  :
710     case '\0' : return ('Z');
711     default   : return (ch);
712     }
713 }
714
715 #if 0
716 /* Precondition: out big enough to handle output (about twice length of in) */
717 static void enZcode( char *in, char *out )
718 {
719     int i, j;
720
721     j = 0;
722     out[ j++ ] = '_';
723     for( i = 0; in[i] != '\0'; ++i ) {
724         switch (in[i]) {
725         case 'Z'  : 
726                 out[j++] = 'Z';
727                 out[j++] = 'Z';
728                 break;
729         case '&'  : 
730                 out[j++] = 'Z';
731                 out[j++] = 'a';
732                 break;
733         case '|'  : 
734                 out[j++] = 'Z';
735                 out[j++] = 'b';
736                 break;
737         case ':'  : 
738                 out[j++] = 'Z';
739                 out[j++] = 'c';
740                 break;
741         case '/'  : 
742                 out[j++] = 'Z';
743                 out[j++] = 'd';
744                 break;
745         case '='  : 
746                 out[j++] = 'Z';
747                 out[j++] = 'e';
748                 break;
749         case '>'  : 
750                 out[j++] = 'Z';
751                 out[j++] = 'g';
752                 break;
753         case '#'  : 
754                 out[j++] = 'Z';
755                 out[j++] = 'h';
756                 break;
757         case '<'  : 
758                 out[j++] = 'Z';
759                 out[j++] = 'l';
760                 break;
761         case '-'  : 
762                 out[j++] = 'Z';
763                 out[j++] = 'm';
764                 break;
765         case '!'  : 
766                 out[j++] = 'Z';
767                 out[j++] = 'n';
768                 break;
769         case '.'  : 
770                 out[j++] = 'Z';
771                 out[j++] = 'o';
772                 break;
773         case '+'  : 
774                 out[j++] = 'Z';
775                 out[j++] = 'p';
776                 break;
777         case '\'' : 
778                 out[j++] = 'Z';
779                 out[j++] = 'q';
780                 break;
781         case '*'  : 
782                 out[j++] = 'Z';
783                 out[j++] = 't';
784                 break;
785         case '_'  : 
786                 out[j++] = 'Z';
787                 out[j++] = 'u';
788                 break;
789         default :
790                 out[j++] = in[i];
791                 break;
792         }
793     }
794     out[j] = '\0';
795 }
796 #endif
797
798 rtsBool lookupGHCName( StgPtr addr, const char **result )
799 {
800     nat i;
801     for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
802     }
803     if (i < table_size) {
804         *result = table[i].name;
805         return rtsTrue;
806     } else {
807         return rtsFalse;
808     }
809 }
810
811 static void printZcoded( const char *raw )
812 {
813     nat j = 0;
814     
815     while ( raw[j] != '\0' ) {
816         if (raw[j] == 'Z') {
817             fputc(unZcode(raw[j+1]),stderr);
818             j = j + 2;
819         } else {
820             fputc(raw[j],stderr);
821             j = j + 1;
822         }
823     }
824 }
825
826 /* --------------------------------------------------------------------------
827  * Symbol table loading
828  * ------------------------------------------------------------------------*/
829
830 /* Causing linking trouble on Win32 plats, so I'm
831    disabling this for now. 
832 */
833 #if defined(HAVE_BFD_H) && !defined(_WIN32)
834
835 #include <bfd.h>
836
837 /* Fairly ad-hoc piece of code that seems to filter out a lot of
838  * rubbish like the obj-splitting symbols
839  */
840
841 static rtsBool isReal( flagword flags, const char *name )
842 {
843 #if 0
844     /* ToDo: make this work on BFD */
845     int tp = type & N_TYPE;    
846     if (tp == N_TEXT || tp == N_DATA) {
847         return (name[0] == '_' && name[1] != '_');
848     } else {
849         return rtsFalse;
850     }
851 #else
852     (void)flags;   /* keep gcc -Wall happy */
853     if (*name == '\0'  || 
854         (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
855         (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
856         return rtsFalse;
857     }
858     return rtsTrue;
859 #endif
860 }
861
862 extern void DEBUG_LoadSymbols( char *name )
863 {
864     bfd* abfd;
865     char **matching;
866
867     bfd_init();
868     abfd = bfd_openr(name, "default");
869     if (abfd == NULL) {
870         barf("can't open executable %s to get symbol table", name);
871     }
872     if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
873         barf("mismatch");
874     }
875
876     {
877         long storage_needed;
878         asymbol **symbol_table;
879         long number_of_symbols;
880         long num_real_syms = 0;
881         long i;
882      
883         storage_needed = bfd_get_symtab_upper_bound (abfd);
884      
885         if (storage_needed < 0) {
886             barf("can't read symbol table");
887         }     
888 #if 0
889         if (storage_needed == 0) {
890             belch("no storage needed");
891         }
892 #endif
893         symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
894
895         number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
896      
897         if (number_of_symbols < 0) {
898             barf("can't canonicalise symbol table");
899         }
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             /*fprintf(stderr,"\t%c\t0x%x      \t%s\n",info.type,(nat)info.value,info.name); */
905             if (isReal(info.type, info.name)) {
906                 num_real_syms += 1;
907             }
908         }
909     
910         IF_DEBUG(evaluator,
911                  fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n", 
912                          number_of_symbols, num_real_syms)
913                  );
914
915         reset_table( num_real_syms );
916     
917         for( i = 0; i != number_of_symbols; ++i ) {
918             symbol_info info;
919             bfd_get_symbol_info(abfd,symbol_table[i],&info);
920             if (isReal(info.type, info.name)) {
921                 insert( info.value, info.name );
922             }
923         }
924         
925         free(symbol_table);
926     }
927     prepare_table();
928 }
929
930 #else /* HAVE_BFD_H */
931
932 extern void DEBUG_LoadSymbols( char *name STG_UNUSED )
933 {
934   /* nothing, yet */
935 }
936
937 #endif /* HAVE_BFD_H */
938
939 #include "StoragePriv.h"
940
941 void
942 findPtr(P_ p)
943 {
944   nat s, g;
945   P_ q;
946   bdescr *bd;
947
948   for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
949     for (s = 0; s < generations[g].n_steps; s++) {
950       for (bd = generations[g].steps[s].blocks; bd; bd = bd->link) {
951         for (q = bd->start; q < bd->free; q++) {
952           if (*q == (W_)p) {
953             printf("%p\n", q);
954           }
955         }
956       }
957     }
958   }
959 }
960
961 #else /* DEBUG */
962 void printPtr( StgPtr p )
963 {
964     fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
965 }
966   
967 void printObj( StgClosure *obj )
968 {
969     fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );
970 }
971 #endif /* DEBUG */