1 /* -----------------------------------------------------------------------------
2 * $Id: Printer.c,v 1.22 2000/03/17 14:37:21 simonmar Exp $
4 * (c) The GHC Team, 1994-2000.
8 * ---------------------------------------------------------------------------*/
17 #include "Bytecodes.h" /* for InstrPtr */
18 #include "Disassembler.h"
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);
26 /* --------------------------------------------------------------------------
27 * local function decls
28 * ------------------------------------------------------------------------*/
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 );
38 static char unZcode ( char ch );
39 rtsBool lookupGHCName ( StgPtr addr, const char **result );
40 static void printZcoded ( const char *raw );
42 /* --------------------------------------------------------------------------
44 * ------------------------------------------------------------------------*/
48 extern void* itblNames[];
49 extern int nItblNames;
50 char* lookupHugsItblName ( void* v )
53 for (i = 0; i < nItblNames; i += 2)
54 if (itblNames[i] == v) return itblNames[i+1];
59 void printPtr( StgPtr p )
65 if (lookupGHCName( p, &raw )) {
68 } else if ((raw = lookupHugsName(p)) != 0) {
69 fprintf(stderr, "%s", raw);
70 } else if ((str = lookupHugsItblName(p)) != 0) {
71 fprintf(stderr, "%p=%s", p, str);
74 fprintf(stderr, "%p", p);
78 void printObj( StgClosure *obj )
80 fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
84 static void printStdObject( StgClosure *obj, char* tag )
87 const StgInfoTable* info = get_itbl(obj);
88 fprintf(stderr,"%s(",tag);
89 printPtr((StgPtr)obj->header.info);
90 for (i = 0; i < info->layout.payload.ptrs; ++i) {
92 printPtr((StgPtr)obj->payload[i]);
94 for (j = 0; j < info->layout.payload.nptrs; ++j) {
95 fprintf(stderr,", %pd#",obj->payload[i+j]);
97 fprintf(stderr,")\n");
100 void printClosure( StgClosure *obj )
102 switch ( get_itbl(obj)->type ) {
104 barf("Invalid object");
107 fprintf(stderr,"BCO\n");
108 disassemble(stgCast(StgBCO*,obj),"\t");
114 StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
116 fprintf(stderr,"AP_UPD("); printPtr((StgPtr)ap->fun);
117 for (i = 0; i < ap->n_args; ++i) {
118 fprintf(stderr,", ");
119 printPtr(ap->payload[i]);
121 fprintf(stderr,")\n");
127 StgPAP* pap = stgCast(StgPAP*,obj);
129 fprintf(stderr,"PAP("); printPtr((StgPtr)pap->fun);
130 for (i = 0; i < pap->n_args; ++i) {
131 fprintf(stderr,", ");
132 printPtr((StgPtr)pap->payload[i]);
134 fprintf(stderr,")\n");
139 fprintf(stderr,"IND(");
140 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
141 fprintf(stderr,")\n");
145 fprintf(stderr,"IND_STATIC(");
146 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
147 fprintf(stderr,")\n");
151 fprintf(stderr,"IND_OLDGEN(");
152 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
153 fprintf(stderr,")\n");
158 StgCAF* caf = stgCast(StgCAF*,obj);
159 fprintf(stderr,"CAF_UNENTERED(");
160 printPtr((StgPtr)caf->body);
161 fprintf(stderr,", ");
162 printPtr((StgPtr)caf->value); /* should be null */
163 fprintf(stderr,", ");
164 printPtr((StgPtr)caf->link); /* should be null */
165 fprintf(stderr,")\n");
171 StgCAF* caf = stgCast(StgCAF*,obj);
172 fprintf(stderr,"CAF_ENTERED(");
173 printPtr((StgPtr)caf->body);
174 fprintf(stderr,", ");
175 printPtr((StgPtr)caf->value);
176 fprintf(stderr,", ");
177 printPtr((StgPtr)caf->link);
178 fprintf(stderr,")\n");
183 fprintf(stderr,"CAF_BH(");
184 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
185 fprintf(stderr,")\n");
189 fprintf(stderr,"SE_BH\n");
192 case SE_CAF_BLACKHOLE:
193 fprintf(stderr,"SE_CAF_BH\n");
197 fprintf(stderr,"BH\n");
201 fprintf(stderr,"BQ(");
202 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
203 fprintf(stderr,")\n");
206 #if defined(GRAN) || defined(PAR)
208 fprintf(stderr,"RBH(");
209 printPtr((StgPtr)stgCast(StgRBH*,obj)->blocking_queue);
210 fprintf(stderr,")\n");
215 case CONSTR_1_0: case CONSTR_0_1:
216 case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
218 case CONSTR_CHARLIKE:
220 case CONSTR_NOCAF_STATIC:
222 /* We can't use printStdObject because we want to print the
226 const StgInfoTable* info = get_itbl(obj);
227 fprintf(stderr,"PACK(");
228 printPtr((StgPtr)obj->header.info);
229 fprintf(stderr,"(tag=%d)",info->srt_len);
230 for (i = 0; i < info->layout.payload.ptrs; ++i) {
231 fprintf(stderr,", ");
232 printPtr((StgPtr)obj->payload[i]);
234 for (j = 0; j < info->layout.payload.nptrs; ++j) {
235 fprintf(stderr,", %p#", obj->payload[i+j]);
237 fprintf(stderr,")\n");
242 case FUN_1_0: case FUN_0_1:
243 case FUN_1_1: case FUN_0_2: case FUN_2_0:
245 printStdObject(obj,"FUN");
249 case THUNK_1_0: case THUNK_0_1:
250 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
252 /* ToDo: will this work for THUNK_STATIC too? */
253 printStdObject(obj,"THUNK");
259 fprintf(stderr,"ARR_WORDS(\"");
260 /* ToDo: we can't safely assume that this is a string! */
261 for (i = 0; arrWordsGetChar(obj,i); ++i) {
262 putchar(arrWordsGetChar(obj,i));
264 fprintf(stderr,"\")\n");
270 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
271 fprintf(stderr,"UpdateFrame(");
272 printPtr((StgPtr)GET_INFO(u));
274 printPtr((StgPtr)u->updatee);
276 printPtr((StgPtr)u->link);
277 fprintf(stderr,")\n");
283 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
284 fprintf(stderr,"CatchFrame(");
285 printPtr((StgPtr)GET_INFO(u));
287 printPtr((StgPtr)u->handler);
289 printPtr((StgPtr)u->link);
290 fprintf(stderr,")\n");
296 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
297 fprintf(stderr,"SeqFrame(");
298 printPtr((StgPtr)GET_INFO(u));
300 printPtr((StgPtr)u->link);
301 fprintf(stderr,")\n");
307 StgStopFrame* u = stgCast(StgStopFrame*,obj);
308 fprintf(stderr,"StopFrame(");
309 printPtr((StgPtr)GET_INFO(u));
310 fprintf(stderr,")\n");
314 //barf("printClosure %d",get_itbl(obj)->type);
315 fprintf(stderr, "*** printClosure: unknown type %d ****\n",
316 get_itbl(obj)->type );
322 void printGraph( StgClosure *obj )
328 StgPtr printStackObj( StgPtr sp )
330 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
332 if (IS_ARG_TAG(*sp)) {
335 fprintf(stderr,"Tagged{");
336 for (i = 0; i < tag; i++) {
337 fprintf(stderr,"0x%x#", (unsigned)(*sp++));
338 if (i < tag-1) fprintf(stderr, ", ");
340 fprintf(stderr, "}\n");
342 StgClosure* c = (StgClosure*)(*sp);
343 printPtr((StgPtr)*sp);
345 if (c == &ret_bco_info) {
346 fprintf(stderr, "\t\t");
347 fprintf(stderr, "ret_bco_info\n" );
349 if (IS_HUGS_CONSTR_INFO(GET_INFO(c))) {
350 fprintf(stderr, "\t\t\t");
351 fprintf(stderr, "ConstrInfoTable\n" );
354 if (get_itbl(c)->type == BCO) {
355 fprintf(stderr, "\t\t\t");
356 fprintf(stderr, "BCO(...)\n");
359 fprintf(stderr, "\t\t\t");
360 printClosure ( (StgClosure*)(*sp));
368 void printStackChunk( StgPtr sp, StgPtr spBottom )
371 const StgInfoTable *info;
373 ASSERT(sp <= spBottom);
374 while (sp < spBottom) {
375 if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
376 info = get_itbl((StgClosure *)sp);
377 switch (info->type) {
380 printObj( stgCast(StgClosure*,sp) );
381 sp += sizeofW(StgUpdateFrame);
385 printObj( stgCast(StgClosure*,sp) );
386 sp += sizeofW(StgSeqFrame);
390 printObj( stgCast(StgClosure*,sp) );
391 sp += sizeofW(StgCatchFrame);
395 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
396 printObj( stgCast(StgClosure*,sp) );
400 fprintf(stderr, "RET_DYN (%p)\n", sp);
403 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
408 fprintf(stderr, "RET_SMALL (%p)\n", sp);
409 bitmap = info->layout.bitmap;
412 while (bitmap != 0) {
413 fprintf(stderr," stk[%d] (%p) = ", spBottom-sp, sp);
414 if ((bitmap & 1) == 0) {
416 fprintf(stderr,"\n");
418 fprintf(stderr,"Word# %d\n", *sp++);
421 bitmap = bitmap >> 1;
433 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
434 sp = printStackObj(sp);
438 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
440 /* check everything down to the first update frame */
441 printStackChunk( sp, stgCast(StgPtr,su) );
442 while ( stgCast(StgPtr,su) < spBottom) {
443 sp = stgCast(StgPtr,su);
444 switch (get_itbl(su)->type) {
446 printObj( stgCast(StgClosure*,su) );
447 sp += sizeofW(StgUpdateFrame);
451 printObj( stgCast(StgClosure*,su) );
452 sp += sizeofW(StgSeqFrame);
453 su = stgCast(StgSeqFrame*,su)->link;
456 printObj( stgCast(StgClosure*,su) );
457 sp += sizeofW(StgCatchFrame);
458 su = stgCast(StgCatchFrame*,su)->link;
461 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
462 printObj( stgCast(StgClosure*,su) );
465 barf("printStack: weird record found on update frame list.");
467 printStackChunk( sp, stgCast(StgPtr,su) );
469 ASSERT(stgCast(StgPtr,su) == spBottom);
472 void printTSO( StgTSO *tso )
474 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
475 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
478 /* -----------------------------------------------------------------------------
481 NOTE: must be kept in sync with the closure types in includes/ClosureTypes.h
482 -------------------------------------------------------------------------- */
484 static char *closure_type_names[] = {
485 "INVALID_OBJECT", /* 0 */
487 "CONSTR_1_0", /* 2 */
488 "CONSTR_0_1", /* 3 */
489 "CONSTR_2_0", /* 4 */
490 "CONSTR_1_1", /* 5 */
491 "CONSTR_0_2", /* 6 */
492 "CONSTR_INTLIKE", /* 7 */
493 "CONSTR_CHARLIKE", /* 8 */
494 "CONSTR_STATIC", /* 9 */
495 "CONSTR_NOCAF_STATIC", /* 10 */
502 "FUN_STATIC", /* 17 */
504 "THUNK_1_0", /* 19 */
505 "THUNK_0_1", /* 20 */
506 "THUNK_2_0", /* 21 */
507 "THUNK_1_1", /* 22 */
508 "THUNK_0_2", /* 23 */
509 "THUNK_STATIC", /* 24 */
510 "THUNK_SELECTOR", /* 25 */
515 "IND_OLDGEN", /* 30 */
517 "IND_OLDGEN_PERM", /* 32 */
518 "IND_STATIC", /* 33 */
519 "CAF_UNENTERED", /* 34 */
520 "CAF_ENTERED", /* 35 */
521 "CAF_BLACKHOLE", /* 36 */
523 "RET_SMALL", /* 38 */
524 "RET_VEC_SMALL", /* 39 */
526 "RET_VEC_BIG", /* 41 */
528 "UPDATE_FRAME", /* 43 */
529 "CATCH_FRAME", /* 44 */
530 "STOP_FRAME", /* 45 */
531 "SEQ_FRAME", /* 46 */
532 "BLACKHOLE", /* 47 */
533 "BLACKHOLE_BQ", /* 48 */
534 "SE_BLACKHOLE", /* 49 */
535 "SE_CAF_BLACKHOLE", /* 50 */
537 "ARR_WORDS", /* 52 */
538 "MUT_ARR_PTRS", /* 53 */
539 "MUT_ARR_PTRS_FROZEN", /* 54 */
543 "STABLE_NAME", /* 58 */
545 "BLOCKED_FETCH", /* 60 */
547 "EVACUATED", /* 62 */
548 "N_CLOSURE_TYPES", /* 63 */
549 "FETCH_ME_BQ", /* 64 */
554 info_type(StgClosure *closure){
555 return closure_type_names[get_itbl(closure)->type];
559 info_type_by_ip(StgInfoTable *ip){
560 return closure_type_names[ip->type];
564 info_hdr_type(StgClosure *closure, char *res){
565 strcpy(res,closure_type_names[get_itbl(closure)->type]);
568 /* --------------------------------------------------------------------------
569 * Address printing code
571 * Uses symbol table in (unstripped executable)
572 * ------------------------------------------------------------------------*/
574 /* --------------------------------------------------------------------------
575 * Simple lookup table
577 * Current implementation is pretty dumb!
578 * ------------------------------------------------------------------------*/
585 static nat max_table_size;
586 static nat table_size;
587 static struct entry* table;
589 static void reset_table( int size )
591 max_table_size = size;
593 table = (struct entry *) malloc(size * sizeof(struct entry));
596 static void prepare_table( void )
598 /* Could sort it... */
601 static void insert( unsigned value, const char *name )
603 if ( table_size >= max_table_size ) {
604 barf( "Symbol table overflow\n" );
606 table[table_size].value = value;
607 table[table_size].name = name;
608 table_size = table_size + 1;
613 static rtsBool lookup_name( char *name, unsigned *result )
616 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
618 if (i < table_size) {
619 *result = table[i].value;
627 /* Code from somewhere inside GHC (circa 1994)
629 * "std"++xs -> "Zstd"++xs
630 * char_to_c 'Z' = "ZZ"
631 * char_to_c '&' = "Za"
632 * char_to_c '|' = "Zb"
633 * char_to_c ':' = "Zc"
634 * char_to_c '/' = "Zd"
635 * char_to_c '=' = "Ze"
636 * char_to_c '>' = "Zg"
637 * char_to_c '#' = "Zh"
638 * char_to_c '<' = "Zl"
639 * char_to_c '-' = "Zm"
640 * char_to_c '!' = "Zn"
641 * char_to_c '.' = "Zo"
642 * char_to_c '+' = "Zp"
643 * char_to_c '\'' = "Zq"
644 * char_to_c '*' = "Zt"
645 * char_to_c '_' = "Zu"
646 * char_to_c c = "Z" ++ show (ord c)
648 static char unZcode( char ch )
651 case 'a' : return ('&');
652 case 'b' : return ('|');
653 case 'c' : return (':');
654 case 'd' : return ('/');
655 case 'e' : return ('=');
656 case 'g' : return ('>');
657 case 'h' : return ('#');
658 case 'l' : return ('<');
659 case 'm' : return ('-');
660 case 'n' : return ('!');
661 case 'o' : return ('.');
662 case 'p' : return ('+');
663 case 'q' : return ('\'');
664 case 't' : return ('*');
665 case 'u' : return ('_');
667 case '\0' : return ('Z');
668 default : return (ch);
673 /* Precondition: out big enough to handle output (about twice length of in) */
674 static void enZcode( char *in, char *out )
680 for( i = 0; in[i] != '\0'; ++i ) {
755 rtsBool lookupGHCName( StgPtr addr, const char **result )
758 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
760 if (i < table_size) {
761 *result = table[i].name;
768 static void printZcoded( const char *raw )
772 while ( raw[j] != '\0' ) {
774 fputc(unZcode(raw[j+1]),stderr);
777 fputc(raw[j],stderr);
783 /* --------------------------------------------------------------------------
784 * Symbol table loading
785 * ------------------------------------------------------------------------*/
787 /* Causing linking trouble on Win32 plats, so I'm
788 disabling this for now.
790 #if defined(HAVE_BFD_H) && !defined(_WIN32)
794 /* Fairly ad-hoc piece of code that seems to filter out a lot of
795 * rubbish like the obj-splitting symbols
798 static rtsBool isReal( flagword flags, const char *name )
801 /* ToDo: make this work on BFD */
802 int tp = type & N_TYPE;
803 if (tp == N_TEXT || tp == N_DATA) {
804 return (name[0] == '_' && name[1] != '_');
809 (void)flags; /* keep gcc -Wall happy */
811 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
812 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
819 extern void DEBUG_LoadSymbols( char *name )
825 abfd = bfd_openr(name, "default");
827 barf("can't open executable %s to get symbol table", name);
829 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
835 asymbol **symbol_table;
836 long number_of_symbols;
837 long num_real_syms = 0;
840 storage_needed = bfd_get_symtab_upper_bound (abfd);
842 if (storage_needed < 0) {
843 barf("can't read symbol table");
846 if (storage_needed == 0) {
847 belch("no storage needed");
850 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
852 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
854 if (number_of_symbols < 0) {
855 barf("can't canonicalise symbol table");
858 for( i = 0; i != number_of_symbols; ++i ) {
860 bfd_get_symbol_info(abfd,symbol_table[i],&info);
861 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
862 if (isReal(info.type, info.name)) {
868 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
869 number_of_symbols, num_real_syms)
872 reset_table( num_real_syms );
874 for( i = 0; i != number_of_symbols; ++i ) {
876 bfd_get_symbol_info(abfd,symbol_table[i],&info);
877 if (isReal(info.type, info.name)) {
878 insert( info.value, info.name );
887 #else /* HAVE_BFD_H */
889 extern void DEBUG_LoadSymbols( char *name STG_UNUSED )
894 #endif /* HAVE_BFD_H */
896 #include "StoragePriv.h"
905 for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
906 for (s = 0; s < generations[g].n_steps; s++) {
907 for (bd = generations[g].steps[s].blocks; bd; bd = bd->link) {
908 for (q = bd->start; q < bd->free; q++) {
919 void printPtr( StgPtr p )
921 fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
924 void printObj( StgClosure *obj )
926 fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );