1 /* -----------------------------------------------------------------------------
2 * $Id: Printer.c,v 1.33 2001/01/15 16:55:25 sewardj Exp $
4 * (c) The GHC Team, 1994-2000.
8 * ---------------------------------------------------------------------------*/
19 #include "Bytecodes.h" /* for InstrPtr */
20 #include "Disassembler.h"
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);
28 /* --------------------------------------------------------------------------
29 * local function decls
30 * ------------------------------------------------------------------------*/
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 );
40 static char unZcode ( char ch );
41 rtsBool lookupGHCName ( StgPtr addr, const char **result );
42 static void printZcoded ( const char *raw );
44 /* --------------------------------------------------------------------------
46 * ------------------------------------------------------------------------*/
49 char* lookupHugsItblName ( void* itbl );
52 void printPtr( StgPtr p )
58 if (lookupGHCName( p, &raw )) {
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);
67 fprintf(stderr, "%p", p);
71 void printObj( StgClosure *obj )
73 fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
77 static void printStdObject( StgClosure *obj, char* tag )
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) {
85 printPtr((StgPtr)obj->payload[i]);
87 for (j = 0; j < info->layout.payload.nptrs; ++j) {
88 fprintf(stderr,", %pd#",obj->payload[i+j]);
90 fprintf(stderr,")\n");
93 void printClosure( StgClosure *obj )
95 switch ( get_itbl(obj)->type ) {
97 barf("Invalid object");
100 disassemble( (StgBCO*)obj );
106 StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
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]);
113 fprintf(stderr,")\n");
119 StgPAP* pap = stgCast(StgPAP*,obj);
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]);
126 fprintf(stderr,")\n");
131 fprintf(stderr,"IND(");
132 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
133 fprintf(stderr,")\n");
137 fprintf(stderr,"IND_STATIC(");
138 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
139 fprintf(stderr,")\n");
143 fprintf(stderr,"IND_OLDGEN(");
144 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
145 fprintf(stderr,")\n");
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");
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");
175 fprintf(stderr,"CAF_BH(");
176 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
177 fprintf(stderr,")\n");
181 fprintf(stderr,"SE_BH\n");
184 case SE_CAF_BLACKHOLE:
185 fprintf(stderr,"SE_CAF_BH\n");
189 fprintf(stderr,"BH\n");
193 fprintf(stderr,"BQ(");
194 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
195 fprintf(stderr,")\n");
199 fprintf(stderr,"TSO(");
200 fprintf(stderr,"%d (%p)",((StgTSO*)obj)->id, (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 /* rows are mutarrays in xmlambda, maybe we should make a new type: ROW */
263 case MUT_ARR_PTRS_FROZEN:
266 StgMutArrPtrs* p = stgCast(StgMutArrPtrs*,obj);
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]));
273 fprintf(stderr,")\n");
279 case FUN_1_0: case FUN_0_1:
280 case FUN_1_1: case FUN_0_2: case FUN_2_0:
282 printStdObject(obj,"FUN");
286 case THUNK_1_0: case THUNK_0_1:
287 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
289 /* ToDo: will this work for THUNK_STATIC too? */
290 printStdObject(obj,"THUNK");
294 printStdObject(obj,"THUNK_SELECTOR");
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));
305 for (i=0; i<((StgArrWords *)obj)->words; i++)
306 fprintf(stderr, "%d", ((StgArrWords *)obj)->payload[i]);
307 fprintf(stderr,"\")\n");
313 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
314 fprintf(stderr,"UpdateFrame(");
315 printPtr((StgPtr)GET_INFO(u));
317 printPtr((StgPtr)u->updatee);
319 printPtr((StgPtr)u->link);
320 fprintf(stderr,")\n");
326 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
327 fprintf(stderr,"CatchFrame(");
328 printPtr((StgPtr)GET_INFO(u));
330 printPtr((StgPtr)u->handler);
332 printPtr((StgPtr)u->link);
333 fprintf(stderr,")\n");
339 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
340 fprintf(stderr,"SeqFrame(");
341 printPtr((StgPtr)GET_INFO(u));
343 printPtr((StgPtr)u->link);
344 fprintf(stderr,")\n");
350 StgStopFrame* u = stgCast(StgStopFrame*,obj);
351 fprintf(stderr,"StopFrame(");
352 printPtr((StgPtr)GET_INFO(u));
353 fprintf(stderr,")\n");
357 //barf("printClosure %d",get_itbl(obj)->type);
358 fprintf(stderr, "*** printClosure: unknown type %d ****\n",
359 get_itbl(obj)->type );
365 void printGraph( StgClosure *obj )
371 StgPtr printStackObj( StgPtr sp )
373 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
375 if (IS_ARG_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, ", ");
383 fprintf(stderr, "}\n");
385 StgClosure* c = (StgClosure*)(*sp);
386 printPtr((StgPtr)*sp);
388 if (c == (StgClosure*)&stg_ctoi_ret_R1p_info) {
389 fprintf(stderr, "\t\t\tstg_ctoi_ret_R1p_info\n" );
391 if (c == (StgClosure*)&stg_ctoi_ret_R1n_info) {
392 fprintf(stderr, "\t\t\tstg_ctoi_ret_R1n_info\n" );
394 if (c == (StgClosure*)&stg_ctoi_ret_F1_info) {
395 fprintf(stderr, "\t\t\tstg_ctoi_ret_F1_info\n" );
397 if (c == (StgClosure*)&stg_ctoi_ret_D1_info) {
398 fprintf(stderr, "\t\t\tstg_ctoi_ret_D1_info\n" );
401 if (get_itbl(c)->type == BCO) {
402 fprintf(stderr, "\t\t\t");
403 fprintf(stderr, "BCO(...)\n");
406 fprintf(stderr, "\t\t\t");
407 printClosure ( (StgClosure*)(*sp));
415 void printStackChunk( StgPtr sp, StgPtr spBottom )
418 const StgInfoTable *info;
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) {
427 printObj( stgCast(StgClosure*,sp) );
428 sp += sizeofW(StgUpdateFrame);
432 printObj( stgCast(StgClosure*,sp) );
433 sp += sizeofW(StgSeqFrame);
437 printObj( stgCast(StgClosure*,sp) );
438 sp += sizeofW(StgCatchFrame);
442 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
443 printObj( stgCast(StgClosure*,sp) );
447 fprintf(stderr, "RET_DYN (%p)\n", sp);
450 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
455 fprintf(stderr, "RET_SMALL (%p)\n", sp);
456 bitmap = info->layout.bitmap;
459 while (bitmap != 0) {
460 fprintf(stderr," stk[%d] (%p) = ", spBottom-sp, sp);
461 if ((bitmap & 1) == 0) {
463 fprintf(stderr,"\n");
465 fprintf(stderr,"Word# %d\n", *sp++);
468 bitmap = bitmap >> 1;
480 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
481 sp = printStackObj(sp);
485 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
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) {
493 printObj( stgCast(StgClosure*,su) );
494 sp += sizeofW(StgUpdateFrame);
498 printObj( stgCast(StgClosure*,su) );
499 sp += sizeofW(StgSeqFrame);
500 su = stgCast(StgSeqFrame*,su)->link;
503 printObj( stgCast(StgClosure*,su) );
504 sp += sizeofW(StgCatchFrame);
505 su = stgCast(StgCatchFrame*,su)->link;
508 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
509 printObj( stgCast(StgClosure*,su) );
512 barf("printStack: weird record found on update frame list.");
514 printStackChunk( sp, stgCast(StgPtr,su) );
516 ASSERT(stgCast(StgPtr,su) == spBottom);
519 void printTSO( StgTSO *tso )
521 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
522 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
525 /* -----------------------------------------------------------------------------
528 NOTE: must be kept in sync with the closure types in includes/ClosureTypes.h
529 -------------------------------------------------------------------------- */
531 static char *closure_type_names[] = {
532 "INVALID_OBJECT", /* 0 */
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 */
549 "FUN_STATIC", /* 17 */
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 */
562 "IND_OLDGEN", /* 30 */
564 "IND_OLDGEN_PERM", /* 32 */
565 "IND_STATIC", /* 33 */
566 "CAF_UNENTERED", /* 34 */
567 "CAF_ENTERED", /* 35 */
568 "CAF_BLACKHOLE", /* 36 */
570 "RET_SMALL", /* 38 */
571 "RET_VEC_SMALL", /* 39 */
573 "RET_VEC_BIG", /* 41 */
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 */
584 "ARR_WORDS", /* 52 */
585 "MUT_ARR_PTRS", /* 53 */
586 "MUT_ARR_PTRS_FROZEN", /* 54 */
590 "STABLE_NAME", /* 58 */
592 "BLOCKED_FETCH", /* 60 */
594 "FETCH_ME_BQ", /* 62 */
596 "EVACUATED", /* 64 */
597 "N_CLOSURE_TYPES" /* 65 */
601 info_type(StgClosure *closure){
602 return closure_type_names[get_itbl(closure)->type];
606 info_type_by_ip(StgInfoTable *ip){
607 return closure_type_names[ip->type];
611 info_hdr_type(StgClosure *closure, char *res){
612 strcpy(res,closure_type_names[get_itbl(closure)->type]);
615 /* --------------------------------------------------------------------------
616 * Address printing code
618 * Uses symbol table in (unstripped executable)
619 * ------------------------------------------------------------------------*/
621 /* --------------------------------------------------------------------------
622 * Simple lookup table
624 * Current implementation is pretty dumb!
625 * ------------------------------------------------------------------------*/
632 static nat max_table_size;
633 static nat table_size;
634 static struct entry* table;
636 static void reset_table( int size )
638 max_table_size = size;
640 table = (struct entry *) malloc(size * sizeof(struct entry));
643 static void prepare_table( void )
645 /* Could sort it... */
648 static void insert( unsigned value, const char *name )
650 if ( table_size >= max_table_size ) {
651 barf( "Symbol table overflow\n" );
653 table[table_size].value = value;
654 table[table_size].name = name;
655 table_size = table_size + 1;
660 static rtsBool lookup_name( char *name, unsigned *result )
663 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
665 if (i < table_size) {
666 *result = table[i].value;
674 /* Code from somewhere inside GHC (circa 1994)
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)
695 static char unZcode( char 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 ('_');
714 case '\0' : return ('Z');
715 default : return (ch);
720 /* Precondition: out big enough to handle output (about twice length of in) */
721 static void enZcode( char *in, char *out )
727 for( i = 0; in[i] != '\0'; ++i ) {
802 rtsBool lookupGHCName( StgPtr addr, const char **result )
805 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
807 if (i < table_size) {
808 *result = table[i].name;
815 static void printZcoded( const char *raw )
819 while ( raw[j] != '\0' ) {
821 fputc(unZcode(raw[j+1]),stderr);
824 fputc(raw[j],stderr);
830 /* --------------------------------------------------------------------------
831 * Symbol table loading
832 * ------------------------------------------------------------------------*/
834 /* Causing linking trouble on Win32 plats, so I'm
835 disabling this for now.
837 #if defined(HAVE_BFD_H) && !defined(_WIN32)
841 /* Fairly ad-hoc piece of code that seems to filter out a lot of
842 * rubbish like the obj-splitting symbols
845 static rtsBool isReal( flagword flags, const char *name )
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] != '_');
856 (void)flags; /* keep gcc -Wall happy */
858 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
859 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
866 extern void DEBUG_LoadSymbols( char *name )
872 abfd = bfd_openr(name, "default");
874 barf("can't open executable %s to get symbol table", name);
876 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
882 asymbol **symbol_table;
883 long number_of_symbols;
884 long num_real_syms = 0;
887 storage_needed = bfd_get_symtab_upper_bound (abfd);
889 if (storage_needed < 0) {
890 barf("can't read symbol table");
893 if (storage_needed == 0) {
894 belch("no storage needed");
897 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
899 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
901 if (number_of_symbols < 0) {
902 barf("can't canonicalise symbol table");
905 for( i = 0; i != number_of_symbols; ++i ) {
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)) {
915 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
916 number_of_symbols, num_real_syms)
919 reset_table( num_real_syms );
921 for( i = 0; i != number_of_symbols; ++i ) {
923 bfd_get_symbol_info(abfd,symbol_table[i],&info);
924 if (isReal(info.type, info.name)) {
925 insert( info.value, info.name );
934 #else /* HAVE_BFD_H */
936 extern void DEBUG_LoadSymbols( char *name STG_UNUSED )
941 #endif /* HAVE_BFD_H */
943 #include "StoragePriv.h"
945 void findPtr(P_ p); /* keep gcc -Wall happy */
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++) {
968 void printPtr( StgPtr p )
970 fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
973 void printObj( StgClosure *obj )
975 fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );