1 /* -----------------------------------------------------------------------------
2 * $Id: Printer.c,v 1.40 2001/04/03 10:09:23 rrt Exp $
4 * (c) The GHC Team, 1994-2000.
8 * ---------------------------------------------------------------------------*/
19 #include "Bytecodes.h" /* for InstrPtr */
20 #include "Disassembler.h"
24 #if defined(GRAN) || defined(PAR)
25 // HWL: explicit fixed header size to make debugging easier
26 int fixed_hs = FIXED_HS, itbl_sz = sizeofW(StgInfoTable),
27 uf_sz=sizeofW(StgUpdateFrame), sf_sz=sizeofW(StgSeqFrame);
30 /* --------------------------------------------------------------------------
31 * local function decls
32 * ------------------------------------------------------------------------*/
34 static void printStdObject( StgClosure *obj, char* tag );
35 static void reset_table ( int size );
36 static void prepare_table ( void );
37 static void insert ( unsigned value, const char *name );
38 #if 0 /* unused but might be useful sometime */
39 static rtsBool lookup_name ( char *name, unsigned *result );
40 static void enZcode ( char *in, char *out );
42 static char unZcode ( char ch );
43 rtsBool lookupGHCName ( StgPtr addr, const char **result );
44 static void printZcoded ( const char *raw );
46 /* --------------------------------------------------------------------------
48 * ------------------------------------------------------------------------*/
50 void printPtr( StgPtr p )
53 if (lookupGHCName( p, &raw )) {
56 fprintf(stderr, "%p", p);
60 void printObj( StgClosure *obj )
62 fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
66 static void printStdObject( StgClosure *obj, char* tag )
69 const StgInfoTable* info = get_itbl(obj);
70 fprintf(stderr,"%s(",tag);
71 printPtr((StgPtr)obj->header.info);
73 fprintf(stderr,", %s", obj->header.prof.ccs->cc->label);
75 for (i = 0; i < info->layout.payload.ptrs; ++i) {
77 printPtr((StgPtr)obj->payload[i]);
79 for (j = 0; j < info->layout.payload.nptrs; ++j) {
80 fprintf(stderr,", %pd#",obj->payload[i+j]);
82 fprintf(stderr,")\n");
85 void printClosure( StgClosure *obj )
91 switch ( info->type ) {
93 barf("Invalid object");
95 disassemble( (StgBCO*)obj );
100 StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
102 fprintf(stderr,"AP_UPD("); printPtr((StgPtr)ap->fun);
103 for (i = 0; i < ap->n_args; ++i) {
104 fprintf(stderr,", ");
105 printPtr((P_)ap->payload[i]);
107 fprintf(stderr,")\n");
113 StgPAP* pap = stgCast(StgPAP*,obj);
115 fprintf(stderr,"PAP("); printPtr((StgPtr)pap->fun);
116 for (i = 0; i < pap->n_args; ++i) {
117 fprintf(stderr,", ");
118 printPtr((StgPtr)pap->payload[i]);
120 fprintf(stderr,")\n");
125 fprintf(stderr,"IND(");
126 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
127 fprintf(stderr,")\n");
131 fprintf(stderr,"IND_STATIC(");
132 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
133 fprintf(stderr,")\n");
137 fprintf(stderr,"IND_OLDGEN(");
138 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
139 fprintf(stderr,")\n");
143 fprintf(stderr,"CAF_BH(");
144 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
145 fprintf(stderr,")\n");
149 fprintf(stderr,"SE_BH\n");
152 case SE_CAF_BLACKHOLE:
153 fprintf(stderr,"SE_CAF_BH\n");
157 fprintf(stderr,"BH\n");
161 fprintf(stderr,"BQ(");
162 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
163 fprintf(stderr,")\n");
167 fprintf(stderr,"TSO(");
168 fprintf(stderr,"%d (%p)",((StgTSO*)obj)->id, (StgTSO*)obj);
169 fprintf(stderr,")\n");
174 fprintf(stderr,"BLOCKED_FETCH(");
175 printGA(&(stgCast(StgBlockedFetch*,obj)->ga));
176 printPtr((StgPtr)(stgCast(StgBlockedFetch*,obj)->node));
177 fprintf(stderr,")\n");
181 fprintf(stderr,"FETCH_ME(");
182 printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
183 fprintf(stderr,")\n");
188 fprintf(stderr,"REMOTE_REF(");
189 printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
190 fprintf(stderr,")\n");
195 fprintf(stderr,"FETCH_ME_BQ(");
196 // printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
197 printPtr((StgPtr)stgCast(StgFetchMeBlockingQueue*,obj)->blocking_queue);
198 fprintf(stderr,")\n");
201 #if defined(GRAN) || defined(PAR)
203 fprintf(stderr,"RBH(");
204 printPtr((StgPtr)stgCast(StgRBH*,obj)->blocking_queue);
205 fprintf(stderr,")\n");
211 case CONSTR_1_0: case CONSTR_0_1:
212 case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
214 case CONSTR_CHARLIKE:
216 case CONSTR_NOCAF_STATIC:
218 /* We can't use printStdObject because we want to print the
223 fprintf(stderr,"%s(", info->prof.closure_desc);
224 fprintf(stderr,"%s", obj->header.prof.ccs->cc->label);
226 fprintf(stderr,"CONSTR(");
227 printPtr((StgPtr)obj->header.info);
228 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 /* rows are mutarrays in xmlambda, maybe we should make a new type: ROW */
243 case MUT_ARR_PTRS_FROZEN:
246 StgMutArrPtrs* p = stgCast(StgMutArrPtrs*,obj);
248 fprintf(stderr,"Row<%i>(",p->ptrs);
249 for (i = 0; i < p->ptrs; ++i) {
250 if (i > 0) fprintf(stderr,", ");
251 printPtr((StgPtr)(p->payload[i]));
253 fprintf(stderr,")\n");
259 case FUN_1_0: case FUN_0_1:
260 case FUN_1_1: case FUN_0_2: case FUN_2_0:
262 printStdObject(obj,"FUN");
266 case THUNK_1_0: case THUNK_0_1:
267 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
269 /* ToDo: will this work for THUNK_STATIC too? */
271 printStdObject(obj,info->prof.closure_desc);
273 printStdObject(obj,"THUNK");
278 printStdObject(obj,"THUNK_SELECTOR");
284 fprintf(stderr,"ARR_WORDS(\"");
285 /* ToDo: we can't safely assume that this is a string!
286 for (i = 0; arrWordsGetChar(obj,i); ++i) {
287 putchar(arrWordsGetChar(obj,i));
289 for (i=0; i<((StgArrWords *)obj)->words; i++)
290 fprintf(stderr, "%d", ((StgArrWords *)obj)->payload[i]);
291 fprintf(stderr,"\")\n");
297 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
298 fprintf(stderr,"UpdateFrame(");
299 printPtr((StgPtr)GET_INFO(u));
301 printPtr((StgPtr)u->updatee);
303 printPtr((StgPtr)u->link);
304 fprintf(stderr,")\n");
310 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
311 fprintf(stderr,"CatchFrame(");
312 printPtr((StgPtr)GET_INFO(u));
314 printPtr((StgPtr)u->handler);
316 printPtr((StgPtr)u->link);
317 fprintf(stderr,")\n");
323 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
324 fprintf(stderr,"SeqFrame(");
325 printPtr((StgPtr)GET_INFO(u));
327 printPtr((StgPtr)u->link);
328 fprintf(stderr,")\n");
334 StgStopFrame* u = stgCast(StgStopFrame*,obj);
335 fprintf(stderr,"StopFrame(");
336 printPtr((StgPtr)GET_INFO(u));
337 fprintf(stderr,")\n");
341 //barf("printClosure %d",get_itbl(obj)->type);
342 fprintf(stderr, "*** printClosure: unknown type %d ****\n",
343 get_itbl(obj)->type );
349 void printGraph( StgClosure *obj )
355 StgPtr printStackObj( StgPtr sp )
357 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
359 if (IS_ARG_TAG(*sp)) {
362 fprintf(stderr,"Tagged{");
363 for (i = 0; i < tag; i++) {
364 fprintf(stderr,"0x%x#", (unsigned)(*sp++));
365 if (i < tag-1) fprintf(stderr, ", ");
367 fprintf(stderr, "}\n");
369 StgClosure* c = (StgClosure*)(*sp);
370 printPtr((StgPtr)*sp);
371 if (c == (StgClosure*)&stg_ctoi_ret_R1p_info) {
372 fprintf(stderr, "\t\t\tstg_ctoi_ret_R1p_info\n" );
374 if (c == (StgClosure*)&stg_ctoi_ret_R1n_info) {
375 fprintf(stderr, "\t\t\tstg_ctoi_ret_R1n_info\n" );
377 if (c == (StgClosure*)&stg_ctoi_ret_F1_info) {
378 fprintf(stderr, "\t\t\tstg_ctoi_ret_F1_info\n" );
380 if (c == (StgClosure*)&stg_ctoi_ret_D1_info) {
381 fprintf(stderr, "\t\t\tstg_ctoi_ret_D1_info\n" );
383 if (c == (StgClosure*)&stg_ctoi_ret_V_info) {
384 fprintf(stderr, "\t\t\tstg_ctoi_ret_V_info\n" );
386 if (get_itbl(c)->type == BCO) {
387 fprintf(stderr, "\t\t\t");
388 fprintf(stderr, "BCO(...)\n");
391 fprintf(stderr, "\t\t\t");
392 printClosure ( (StgClosure*)(*sp));
400 void printStackChunk( StgPtr sp, StgPtr spBottom )
403 const StgInfoTable *info;
405 ASSERT(sp <= spBottom);
406 while (sp < spBottom) {
407 if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
408 info = get_itbl((StgClosure *)sp);
409 switch (info->type) {
412 printObj( stgCast(StgClosure*,sp) );
413 sp += sizeofW(StgUpdateFrame);
417 printObj( stgCast(StgClosure*,sp) );
418 sp += sizeofW(StgSeqFrame);
422 printObj( stgCast(StgClosure*,sp) );
423 sp += sizeofW(StgCatchFrame);
427 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
428 printObj( stgCast(StgClosure*,sp) );
432 fprintf(stderr, "RET_DYN (%p)\n", sp);
435 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
440 fprintf(stderr, "RET_SMALL (%p)\n", sp);
441 bitmap = info->layout.bitmap;
444 while (bitmap != 0) {
445 fprintf(stderr," stk[%d] (%p) = ", spBottom-sp, sp);
446 if ((bitmap & 1) == 0) {
448 fprintf(stderr,"\n");
450 fprintf(stderr,"Word# %d\n", *sp++);
453 bitmap = bitmap >> 1;
465 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
466 sp = printStackObj(sp);
470 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
472 /* check everything down to the first update frame */
473 printStackChunk( sp, stgCast(StgPtr,su) );
474 while ( stgCast(StgPtr,su) < spBottom) {
475 sp = stgCast(StgPtr,su);
476 switch (get_itbl(su)->type) {
478 printObj( stgCast(StgClosure*,su) );
479 sp += sizeofW(StgUpdateFrame);
483 printObj( stgCast(StgClosure*,su) );
484 sp += sizeofW(StgSeqFrame);
485 su = stgCast(StgSeqFrame*,su)->link;
488 printObj( stgCast(StgClosure*,su) );
489 sp += sizeofW(StgCatchFrame);
490 su = stgCast(StgCatchFrame*,su)->link;
493 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
494 printObj( stgCast(StgClosure*,su) );
497 barf("printStack: weird record found on update frame list.");
499 printStackChunk( sp, stgCast(StgPtr,su) );
501 ASSERT(stgCast(StgPtr,su) == spBottom);
504 void printTSO( StgTSO *tso )
506 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
507 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
510 /* -----------------------------------------------------------------------------
513 NOTE: must be kept in sync with the closure types in includes/ClosureTypes.h
514 -------------------------------------------------------------------------- */
516 static char *closure_type_names[] = {
517 "INVALID_OBJECT", /* 0 */
519 "CONSTR_1_0", /* 2 */
520 "CONSTR_0_1", /* 3 */
521 "CONSTR_2_0", /* 4 */
522 "CONSTR_1_1", /* 5 */
523 "CONSTR_0_2", /* 6 */
524 "CONSTR_INTLIKE", /* 7 */
525 "CONSTR_CHARLIKE", /* 8 */
526 "CONSTR_STATIC", /* 9 */
527 "CONSTR_NOCAF_STATIC", /* 10 */
534 "FUN_STATIC", /* 17 */
536 "THUNK_1_0", /* 19 */
537 "THUNK_0_1", /* 20 */
538 "THUNK_2_0", /* 21 */
539 "THUNK_1_1", /* 22 */
540 "THUNK_0_2", /* 23 */
541 "THUNK_STATIC", /* 24 */
542 "THUNK_SELECTOR", /* 25 */
547 "IND_OLDGEN", /* 30 */
549 "IND_OLDGEN_PERM", /* 32 */
550 "IND_STATIC", /* 33 */
551 "CAF_BLACKHOLE", /* 36 */
553 "RET_SMALL", /* 38 */
554 "RET_VEC_SMALL", /* 39 */
556 "RET_VEC_BIG", /* 41 */
558 "UPDATE_FRAME", /* 43 */
559 "CATCH_FRAME", /* 44 */
560 "STOP_FRAME", /* 45 */
561 "SEQ_FRAME", /* 46 */
562 "BLACKHOLE", /* 47 */
563 "BLACKHOLE_BQ", /* 48 */
564 "SE_BLACKHOLE", /* 49 */
565 "SE_CAF_BLACKHOLE", /* 50 */
567 "ARR_WORDS", /* 52 */
568 "MUT_ARR_PTRS", /* 53 */
569 "MUT_ARR_PTRS_FROZEN", /* 54 */
573 "STABLE_NAME", /* 58 */
575 "BLOCKED_FETCH", /* 60 */
577 "FETCH_ME_BQ", /* 62 */
579 "EVACUATED", /* 64 */
580 "REMOTE_REF", /* 65 */
581 "N_CLOSURE_TYPES" /* 66 */
585 info_type(StgClosure *closure){
586 return closure_type_names[get_itbl(closure)->type];
590 info_type_by_ip(StgInfoTable *ip){
591 return closure_type_names[ip->type];
595 info_hdr_type(StgClosure *closure, char *res){
596 strcpy(res,closure_type_names[get_itbl(closure)->type]);
599 /* --------------------------------------------------------------------------
600 * Address printing code
602 * Uses symbol table in (unstripped executable)
603 * ------------------------------------------------------------------------*/
605 /* --------------------------------------------------------------------------
606 * Simple lookup table
608 * Current implementation is pretty dumb!
609 * ------------------------------------------------------------------------*/
616 static nat max_table_size;
617 static nat table_size;
618 static struct entry* table;
620 static void reset_table( int size )
622 max_table_size = size;
624 table = (struct entry *) malloc(size * sizeof(struct entry));
627 static void prepare_table( void )
629 /* Could sort it... */
632 static void insert( unsigned value, const char *name )
634 if ( table_size >= max_table_size ) {
635 barf( "Symbol table overflow\n" );
637 table[table_size].value = value;
638 table[table_size].name = name;
639 table_size = table_size + 1;
644 static rtsBool lookup_name( char *name, unsigned *result )
647 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
649 if (i < table_size) {
650 *result = table[i].value;
658 /* Code from somewhere inside GHC (circa 1994)
660 * "std"++xs -> "Zstd"++xs
661 * char_to_c 'Z' = "ZZ"
662 * char_to_c '&' = "Za"
663 * char_to_c '|' = "Zb"
664 * char_to_c ':' = "Zc"
665 * char_to_c '/' = "Zd"
666 * char_to_c '=' = "Ze"
667 * char_to_c '>' = "Zg"
668 * char_to_c '#' = "Zh"
669 * char_to_c '<' = "Zl"
670 * char_to_c '-' = "Zm"
671 * char_to_c '!' = "Zn"
672 * char_to_c '.' = "Zo"
673 * char_to_c '+' = "Zp"
674 * char_to_c '\'' = "Zq"
675 * char_to_c '*' = "Zt"
676 * char_to_c '_' = "Zu"
677 * char_to_c c = "Z" ++ show (ord c)
679 static char unZcode( char ch )
682 case 'a' : return ('&');
683 case 'b' : return ('|');
684 case 'c' : return (':');
685 case 'd' : return ('/');
686 case 'e' : return ('=');
687 case 'g' : return ('>');
688 case 'h' : return ('#');
689 case 'l' : return ('<');
690 case 'm' : return ('-');
691 case 'n' : return ('!');
692 case 'o' : return ('.');
693 case 'p' : return ('+');
694 case 'q' : return ('\'');
695 case 't' : return ('*');
696 case 'u' : return ('_');
698 case '\0' : return ('Z');
699 default : return (ch);
704 /* Precondition: out big enough to handle output (about twice length of in) */
705 static void enZcode( char *in, char *out )
711 for( i = 0; in[i] != '\0'; ++i ) {
786 rtsBool lookupGHCName( StgPtr addr, const char **result )
789 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
791 if (i < table_size) {
792 *result = table[i].name;
799 static void printZcoded( const char *raw )
803 while ( raw[j] != '\0' ) {
805 fputc(unZcode(raw[j+1]),stderr);
808 fputc(raw[j],stderr);
814 /* --------------------------------------------------------------------------
815 * Symbol table loading
816 * ------------------------------------------------------------------------*/
818 /* Causing linking trouble on Win32 plats, so I'm
819 disabling this for now.
821 #if defined(HAVE_BFD_H) && !defined(_WIN32) && !defined(PAR) && !defined(GRAN)
825 /* Fairly ad-hoc piece of code that seems to filter out a lot of
826 * rubbish like the obj-splitting symbols
829 static rtsBool isReal( flagword flags, const char *name )
832 /* ToDo: make this work on BFD */
833 int tp = type & N_TYPE;
834 if (tp == N_TEXT || tp == N_DATA) {
835 return (name[0] == '_' && name[1] != '_');
840 (void)flags; /* keep gcc -Wall happy */
842 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
843 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
850 extern void DEBUG_LoadSymbols( char *name )
856 abfd = bfd_openr(name, "default");
858 barf("can't open executable %s to get symbol table", name);
860 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
866 asymbol **symbol_table;
867 long number_of_symbols;
868 long num_real_syms = 0;
871 storage_needed = bfd_get_symtab_upper_bound (abfd);
873 if (storage_needed < 0) {
874 barf("can't read symbol table");
877 if (storage_needed == 0) {
878 belch("no storage needed");
881 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
883 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
885 if (number_of_symbols < 0) {
886 barf("can't canonicalise symbol table");
889 for( i = 0; i != number_of_symbols; ++i ) {
891 bfd_get_symbol_info(abfd,symbol_table[i],&info);
892 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
893 if (isReal(info.type, info.name)) {
899 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
900 number_of_symbols, num_real_syms)
903 reset_table( num_real_syms );
905 for( i = 0; i != number_of_symbols; ++i ) {
907 bfd_get_symbol_info(abfd,symbol_table[i],&info);
908 if (isReal(info.type, info.name)) {
909 insert( info.value, info.name );
918 #else /* HAVE_BFD_H */
920 extern void DEBUG_LoadSymbols( char *name STG_UNUSED )
925 #endif /* HAVE_BFD_H */
927 #include "StoragePriv.h"
929 void findPtr(P_ p, int); /* keep gcc -Wall happy */
932 findPtr(P_ p, int follow)
937 const int arr_size = 1024;
938 StgPtr arr[arr_size];
941 for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
942 for (s = 0; s < generations[g].n_steps; s++) {
943 if (RtsFlags.GcFlags.generations == 1) {
944 bd = generations[g].steps[s].to_space;
946 bd = generations[g].steps[s].blocks;
948 for (; bd; bd = bd->link) {
949 for (q = bd->start; q < bd->free; q++) {
953 while (!LOOKS_LIKE_GHC_INFO(*r)) { r--; };
954 fprintf(stderr, "%p = ", r);
955 printClosure((StgClosure *)r);
965 if (follow && i == 1) {
966 fprintf(stderr, "-->\n");
972 void printPtr( StgPtr p )
974 fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
977 void printObj( StgClosure *obj )
979 fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );