1 /* -----------------------------------------------------------------------------
2 * $Id: Printer.c,v 1.26 2000/04/17 14:31:19 sewardj 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 * ------------------------------------------------------------------------*/
47 char* lookupHugsItblName ( void* itbl );
50 void printPtr( StgPtr p )
56 if (lookupGHCName( p, &raw )) {
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);
65 fprintf(stderr, "%p", p);
69 void printObj( StgClosure *obj )
71 fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
75 static void printStdObject( StgClosure *obj, char* tag )
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) {
83 printPtr((StgPtr)obj->payload[i]);
85 for (j = 0; j < info->layout.payload.nptrs; ++j) {
86 fprintf(stderr,", %pd#",obj->payload[i+j]);
88 fprintf(stderr,")\n");
91 void printClosure( StgClosure *obj )
93 switch ( get_itbl(obj)->type ) {
95 barf("Invalid object");
98 fprintf(stderr,"BCO\n");
99 disassemble(stgCast(StgBCO*,obj),"\t");
105 StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
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]);
112 fprintf(stderr,")\n");
118 StgPAP* pap = stgCast(StgPAP*,obj);
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]);
125 fprintf(stderr,")\n");
130 fprintf(stderr,"IND(");
131 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
132 fprintf(stderr,")\n");
136 fprintf(stderr,"IND_STATIC(");
137 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
138 fprintf(stderr,")\n");
142 fprintf(stderr,"IND_OLDGEN(");
143 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
144 fprintf(stderr,")\n");
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");
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");
174 fprintf(stderr,"CAF_BH(");
175 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
176 fprintf(stderr,")\n");
180 fprintf(stderr,"SE_BH\n");
183 case SE_CAF_BLACKHOLE:
184 fprintf(stderr,"SE_CAF_BH\n");
188 fprintf(stderr,"BH\n");
192 fprintf(stderr,"BQ(");
193 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
194 fprintf(stderr,")\n");
198 fprintf(stderr,"TSO(");
199 fprintf(stderr,"%d (%x)",
200 stgCast(StgTSO*,obj)->id, stgCast(StgTSO*,obj));
201 fprintf(stderr,")\n");
206 fprintf(stderr,"BLOCKED_FETCH(");
207 printGA(&(stgCast(StgBlockedFetch*,obj)->ga));
208 printPtr((StgPtr)(stgCast(StgBlockedFetch*,obj)->node));
209 fprintf(stderr,")\n");
213 fprintf(stderr,"FETCH_ME(");
214 printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
215 fprintf(stderr,")\n");
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");
225 #if defined(GRAN) || defined(PAR)
227 fprintf(stderr,"RBH(");
228 printPtr((StgPtr)stgCast(StgRBH*,obj)->blocking_queue);
229 fprintf(stderr,")\n");
235 case CONSTR_1_0: case CONSTR_0_1:
236 case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
238 case CONSTR_CHARLIKE:
240 case CONSTR_NOCAF_STATIC:
242 /* We can't use printStdObject because we want to print the
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]);
254 for (j = 0; j < info->layout.payload.nptrs; ++j) {
255 fprintf(stderr,", %p#", obj->payload[i+j]);
257 fprintf(stderr,")\n");
262 case FUN_1_0: case FUN_0_1:
263 case FUN_1_1: case FUN_0_2: case FUN_2_0:
265 printStdObject(obj,"FUN");
269 case THUNK_1_0: case THUNK_0_1:
270 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
272 /* ToDo: will this work for THUNK_STATIC too? */
273 printStdObject(obj,"THUNK");
277 printStdObject(obj,"THUNK_SELECTOR");
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));
288 for (i=0; i<((StgArrWords *)obj)->words; i++)
289 fprintf(stderr, "%d", ((StgArrWords *)obj)->payload[i]);
290 fprintf(stderr,"\")\n");
296 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
297 fprintf(stderr,"UpdateFrame(");
298 printPtr((StgPtr)GET_INFO(u));
300 printPtr((StgPtr)u->updatee);
302 printPtr((StgPtr)u->link);
303 fprintf(stderr,")\n");
309 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
310 fprintf(stderr,"CatchFrame(");
311 printPtr((StgPtr)GET_INFO(u));
313 printPtr((StgPtr)u->handler);
315 printPtr((StgPtr)u->link);
316 fprintf(stderr,")\n");
322 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
323 fprintf(stderr,"SeqFrame(");
324 printPtr((StgPtr)GET_INFO(u));
326 printPtr((StgPtr)u->link);
327 fprintf(stderr,")\n");
333 StgStopFrame* u = stgCast(StgStopFrame*,obj);
334 fprintf(stderr,"StopFrame(");
335 printPtr((StgPtr)GET_INFO(u));
336 fprintf(stderr,")\n");
340 //barf("printClosure %d",get_itbl(obj)->type);
341 fprintf(stderr, "*** printClosure: unknown type %d ****\n",
342 get_itbl(obj)->type );
348 void printGraph( StgClosure *obj )
354 StgPtr printStackObj( StgPtr sp )
356 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
358 if (IS_ARG_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, ", ");
366 fprintf(stderr, "}\n");
368 StgClosure* c = (StgClosure*)(*sp);
369 printPtr((StgPtr)*sp);
371 if (c == &ret_bco_info) {
372 fprintf(stderr, "\t\t");
373 fprintf(stderr, "ret_bco_info\n" );
375 if (IS_HUGS_CONSTR_INFO(GET_INFO(c))) {
376 fprintf(stderr, "\t\t\t");
377 fprintf(stderr, "ConstrInfoTable\n" );
380 if (get_itbl(c)->type == BCO) {
381 fprintf(stderr, "\t\t\t");
382 fprintf(stderr, "BCO(...)\n");
385 fprintf(stderr, "\t\t\t");
386 printClosure ( (StgClosure*)(*sp));
394 void printStackChunk( StgPtr sp, StgPtr spBottom )
397 const StgInfoTable *info;
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) {
406 printObj( stgCast(StgClosure*,sp) );
407 sp += sizeofW(StgUpdateFrame);
411 printObj( stgCast(StgClosure*,sp) );
412 sp += sizeofW(StgSeqFrame);
416 printObj( stgCast(StgClosure*,sp) );
417 sp += sizeofW(StgCatchFrame);
421 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
422 printObj( stgCast(StgClosure*,sp) );
426 fprintf(stderr, "RET_DYN (%p)\n", sp);
429 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
434 fprintf(stderr, "RET_SMALL (%p)\n", sp);
435 bitmap = info->layout.bitmap;
438 while (bitmap != 0) {
439 fprintf(stderr," stk[%d] (%p) = ", spBottom-sp, sp);
440 if ((bitmap & 1) == 0) {
442 fprintf(stderr,"\n");
444 fprintf(stderr,"Word# %d\n", *sp++);
447 bitmap = bitmap >> 1;
459 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
460 sp = printStackObj(sp);
464 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
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) {
472 printObj( stgCast(StgClosure*,su) );
473 sp += sizeofW(StgUpdateFrame);
477 printObj( stgCast(StgClosure*,su) );
478 sp += sizeofW(StgSeqFrame);
479 su = stgCast(StgSeqFrame*,su)->link;
482 printObj( stgCast(StgClosure*,su) );
483 sp += sizeofW(StgCatchFrame);
484 su = stgCast(StgCatchFrame*,su)->link;
487 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
488 printObj( stgCast(StgClosure*,su) );
491 barf("printStack: weird record found on update frame list.");
493 printStackChunk( sp, stgCast(StgPtr,su) );
495 ASSERT(stgCast(StgPtr,su) == spBottom);
498 void printTSO( StgTSO *tso )
500 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
501 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
504 /* -----------------------------------------------------------------------------
507 NOTE: must be kept in sync with the closure types in includes/ClosureTypes.h
508 -------------------------------------------------------------------------- */
510 static char *closure_type_names[] = {
511 "INVALID_OBJECT", /* 0 */
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 */
528 "FUN_STATIC", /* 17 */
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 */
541 "IND_OLDGEN", /* 30 */
543 "IND_OLDGEN_PERM", /* 32 */
544 "IND_STATIC", /* 33 */
545 "CAF_UNENTERED", /* 34 */
546 "CAF_ENTERED", /* 35 */
547 "CAF_BLACKHOLE", /* 36 */
549 "RET_SMALL", /* 38 */
550 "RET_VEC_SMALL", /* 39 */
552 "RET_VEC_BIG", /* 41 */
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 */
563 "ARR_WORDS", /* 52 */
564 "MUT_ARR_PTRS", /* 53 */
565 "MUT_ARR_PTRS_FROZEN", /* 54 */
569 "STABLE_NAME", /* 58 */
571 "BLOCKED_FETCH", /* 60 */
573 "FETCH_ME_BQ", /* 62 */
575 "EVACUATED", /* 64 */
576 "N_CLOSURE_TYPES" /* 65 */
580 info_type(StgClosure *closure){
581 return closure_type_names[get_itbl(closure)->type];
585 info_type_by_ip(StgInfoTable *ip){
586 return closure_type_names[ip->type];
590 info_hdr_type(StgClosure *closure, char *res){
591 strcpy(res,closure_type_names[get_itbl(closure)->type]);
594 /* --------------------------------------------------------------------------
595 * Address printing code
597 * Uses symbol table in (unstripped executable)
598 * ------------------------------------------------------------------------*/
600 /* --------------------------------------------------------------------------
601 * Simple lookup table
603 * Current implementation is pretty dumb!
604 * ------------------------------------------------------------------------*/
611 static nat max_table_size;
612 static nat table_size;
613 static struct entry* table;
615 static void reset_table( int size )
617 max_table_size = size;
619 table = (struct entry *) malloc(size * sizeof(struct entry));
622 static void prepare_table( void )
624 /* Could sort it... */
627 static void insert( unsigned value, const char *name )
629 if ( table_size >= max_table_size ) {
630 barf( "Symbol table overflow\n" );
632 table[table_size].value = value;
633 table[table_size].name = name;
634 table_size = table_size + 1;
639 static rtsBool lookup_name( char *name, unsigned *result )
642 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
644 if (i < table_size) {
645 *result = table[i].value;
653 /* Code from somewhere inside GHC (circa 1994)
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)
674 static char unZcode( char 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 ('_');
693 case '\0' : return ('Z');
694 default : return (ch);
699 /* Precondition: out big enough to handle output (about twice length of in) */
700 static void enZcode( char *in, char *out )
706 for( i = 0; in[i] != '\0'; ++i ) {
781 rtsBool lookupGHCName( StgPtr addr, const char **result )
784 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
786 if (i < table_size) {
787 *result = table[i].name;
794 static void printZcoded( const char *raw )
798 while ( raw[j] != '\0' ) {
800 fputc(unZcode(raw[j+1]),stderr);
803 fputc(raw[j],stderr);
809 /* --------------------------------------------------------------------------
810 * Symbol table loading
811 * ------------------------------------------------------------------------*/
813 /* Causing linking trouble on Win32 plats, so I'm
814 disabling this for now.
816 #if defined(HAVE_BFD_H) && !defined(_WIN32)
820 /* Fairly ad-hoc piece of code that seems to filter out a lot of
821 * rubbish like the obj-splitting symbols
824 static rtsBool isReal( flagword flags, const char *name )
827 /* ToDo: make this work on BFD */
828 int tp = type & N_TYPE;
829 if (tp == N_TEXT || tp == N_DATA) {
830 return (name[0] == '_' && name[1] != '_');
835 (void)flags; /* keep gcc -Wall happy */
837 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
838 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
845 extern void DEBUG_LoadSymbols( char *name )
851 abfd = bfd_openr(name, "default");
853 barf("can't open executable %s to get symbol table", name);
855 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
861 asymbol **symbol_table;
862 long number_of_symbols;
863 long num_real_syms = 0;
866 storage_needed = bfd_get_symtab_upper_bound (abfd);
868 if (storage_needed < 0) {
869 barf("can't read symbol table");
872 if (storage_needed == 0) {
873 belch("no storage needed");
876 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
878 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
880 if (number_of_symbols < 0) {
881 barf("can't canonicalise symbol table");
884 for( i = 0; i != number_of_symbols; ++i ) {
886 bfd_get_symbol_info(abfd,symbol_table[i],&info);
887 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
888 if (isReal(info.type, info.name)) {
894 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
895 number_of_symbols, num_real_syms)
898 reset_table( num_real_syms );
900 for( i = 0; i != number_of_symbols; ++i ) {
902 bfd_get_symbol_info(abfd,symbol_table[i],&info);
903 if (isReal(info.type, info.name)) {
904 insert( info.value, info.name );
913 #else /* HAVE_BFD_H */
915 extern void DEBUG_LoadSymbols( char *name STG_UNUSED )
920 #endif /* HAVE_BFD_H */
922 #include "StoragePriv.h"
931 for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
932 for (s = 0; s < generations[g].n_steps; s++) {
933 for (bd = generations[g].steps[s].blocks; bd; bd = bd->link) {
934 for (q = bd->start; q < bd->free; q++) {
945 void printPtr( StgPtr p )
947 fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
950 void printObj( StgClosure *obj )
952 fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );