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