1 /* -----------------------------------------------------------------------------
2 * $Id: Printer.c,v 1.34 2001/01/29 17:23:41 simonmar 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");
149 fprintf(stderr,"CAF_BH(");
150 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
151 fprintf(stderr,")\n");
155 fprintf(stderr,"SE_BH\n");
158 case SE_CAF_BLACKHOLE:
159 fprintf(stderr,"SE_CAF_BH\n");
163 fprintf(stderr,"BH\n");
167 fprintf(stderr,"BQ(");
168 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
169 fprintf(stderr,")\n");
173 fprintf(stderr,"TSO(");
174 fprintf(stderr,"%d (%p)",((StgTSO*)obj)->id, (StgTSO*)obj);
175 fprintf(stderr,")\n");
180 fprintf(stderr,"BLOCKED_FETCH(");
181 printGA(&(stgCast(StgBlockedFetch*,obj)->ga));
182 printPtr((StgPtr)(stgCast(StgBlockedFetch*,obj)->node));
183 fprintf(stderr,")\n");
187 fprintf(stderr,"FETCH_ME(");
188 printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
189 fprintf(stderr,")\n");
193 fprintf(stderr,"FETCH_ME_BQ(");
194 // printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
195 printPtr((StgPtr)stgCast(StgFetchMeBlockingQueue*,obj)->blocking_queue);
196 fprintf(stderr,")\n");
199 #if defined(GRAN) || defined(PAR)
201 fprintf(stderr,"RBH(");
202 printPtr((StgPtr)stgCast(StgRBH*,obj)->blocking_queue);
203 fprintf(stderr,")\n");
209 case CONSTR_1_0: case CONSTR_0_1:
210 case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
212 case CONSTR_CHARLIKE:
214 case CONSTR_NOCAF_STATIC:
216 /* We can't use printStdObject because we want to print the
220 const StgInfoTable* info = get_itbl(obj);
221 fprintf(stderr,"PACK(");
222 printPtr((StgPtr)obj->header.info);
223 fprintf(stderr,"(tag=%d)",info->srt_len);
224 for (i = 0; i < info->layout.payload.ptrs; ++i) {
225 fprintf(stderr,", ");
226 printPtr((StgPtr)obj->payload[i]);
228 for (j = 0; j < info->layout.payload.nptrs; ++j) {
229 fprintf(stderr,", %p#", obj->payload[i+j]);
231 fprintf(stderr,")\n");
236 /* rows are mutarrays in xmlambda, maybe we should make a new type: ROW */
237 case MUT_ARR_PTRS_FROZEN:
240 StgMutArrPtrs* p = stgCast(StgMutArrPtrs*,obj);
242 fprintf(stderr,"Row<%i>(",p->ptrs);
243 for (i = 0; i < p->ptrs; ++i) {
244 if (i > 0) fprintf(stderr,", ");
245 printPtr((StgPtr)(p->payload[i]));
247 fprintf(stderr,")\n");
253 case FUN_1_0: case FUN_0_1:
254 case FUN_1_1: case FUN_0_2: case FUN_2_0:
256 printStdObject(obj,"FUN");
260 case THUNK_1_0: case THUNK_0_1:
261 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
263 /* ToDo: will this work for THUNK_STATIC too? */
264 printStdObject(obj,"THUNK");
268 printStdObject(obj,"THUNK_SELECTOR");
274 fprintf(stderr,"ARR_WORDS(\"");
275 /* ToDo: we can't safely assume that this is a string!
276 for (i = 0; arrWordsGetChar(obj,i); ++i) {
277 putchar(arrWordsGetChar(obj,i));
279 for (i=0; i<((StgArrWords *)obj)->words; i++)
280 fprintf(stderr, "%d", ((StgArrWords *)obj)->payload[i]);
281 fprintf(stderr,"\")\n");
287 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
288 fprintf(stderr,"UpdateFrame(");
289 printPtr((StgPtr)GET_INFO(u));
291 printPtr((StgPtr)u->updatee);
293 printPtr((StgPtr)u->link);
294 fprintf(stderr,")\n");
300 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
301 fprintf(stderr,"CatchFrame(");
302 printPtr((StgPtr)GET_INFO(u));
304 printPtr((StgPtr)u->handler);
306 printPtr((StgPtr)u->link);
307 fprintf(stderr,")\n");
313 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
314 fprintf(stderr,"SeqFrame(");
315 printPtr((StgPtr)GET_INFO(u));
317 printPtr((StgPtr)u->link);
318 fprintf(stderr,")\n");
324 StgStopFrame* u = stgCast(StgStopFrame*,obj);
325 fprintf(stderr,"StopFrame(");
326 printPtr((StgPtr)GET_INFO(u));
327 fprintf(stderr,")\n");
331 //barf("printClosure %d",get_itbl(obj)->type);
332 fprintf(stderr, "*** printClosure: unknown type %d ****\n",
333 get_itbl(obj)->type );
339 void printGraph( StgClosure *obj )
345 StgPtr printStackObj( StgPtr sp )
347 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
349 if (IS_ARG_TAG(*sp)) {
352 fprintf(stderr,"Tagged{");
353 for (i = 0; i < tag; i++) {
354 fprintf(stderr,"0x%x#", (unsigned)(*sp++));
355 if (i < tag-1) fprintf(stderr, ", ");
357 fprintf(stderr, "}\n");
359 StgClosure* c = (StgClosure*)(*sp);
360 printPtr((StgPtr)*sp);
362 if (c == (StgClosure*)&stg_ctoi_ret_R1p_info) {
363 fprintf(stderr, "\t\t\tstg_ctoi_ret_R1p_info\n" );
365 if (c == (StgClosure*)&stg_ctoi_ret_R1n_info) {
366 fprintf(stderr, "\t\t\tstg_ctoi_ret_R1n_info\n" );
368 if (c == (StgClosure*)&stg_ctoi_ret_F1_info) {
369 fprintf(stderr, "\t\t\tstg_ctoi_ret_F1_info\n" );
371 if (c == (StgClosure*)&stg_ctoi_ret_D1_info) {
372 fprintf(stderr, "\t\t\tstg_ctoi_ret_D1_info\n" );
375 if (get_itbl(c)->type == BCO) {
376 fprintf(stderr, "\t\t\t");
377 fprintf(stderr, "BCO(...)\n");
380 fprintf(stderr, "\t\t\t");
381 printClosure ( (StgClosure*)(*sp));
389 void printStackChunk( StgPtr sp, StgPtr spBottom )
392 const StgInfoTable *info;
394 ASSERT(sp <= spBottom);
395 while (sp < spBottom) {
396 if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
397 info = get_itbl((StgClosure *)sp);
398 switch (info->type) {
401 printObj( stgCast(StgClosure*,sp) );
402 sp += sizeofW(StgUpdateFrame);
406 printObj( stgCast(StgClosure*,sp) );
407 sp += sizeofW(StgSeqFrame);
411 printObj( stgCast(StgClosure*,sp) );
412 sp += sizeofW(StgCatchFrame);
416 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
417 printObj( stgCast(StgClosure*,sp) );
421 fprintf(stderr, "RET_DYN (%p)\n", sp);
424 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
429 fprintf(stderr, "RET_SMALL (%p)\n", sp);
430 bitmap = info->layout.bitmap;
433 while (bitmap != 0) {
434 fprintf(stderr," stk[%d] (%p) = ", spBottom-sp, sp);
435 if ((bitmap & 1) == 0) {
437 fprintf(stderr,"\n");
439 fprintf(stderr,"Word# %d\n", *sp++);
442 bitmap = bitmap >> 1;
454 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
455 sp = printStackObj(sp);
459 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
461 /* check everything down to the first update frame */
462 printStackChunk( sp, stgCast(StgPtr,su) );
463 while ( stgCast(StgPtr,su) < spBottom) {
464 sp = stgCast(StgPtr,su);
465 switch (get_itbl(su)->type) {
467 printObj( stgCast(StgClosure*,su) );
468 sp += sizeofW(StgUpdateFrame);
472 printObj( stgCast(StgClosure*,su) );
473 sp += sizeofW(StgSeqFrame);
474 su = stgCast(StgSeqFrame*,su)->link;
477 printObj( stgCast(StgClosure*,su) );
478 sp += sizeofW(StgCatchFrame);
479 su = stgCast(StgCatchFrame*,su)->link;
482 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
483 printObj( stgCast(StgClosure*,su) );
486 barf("printStack: weird record found on update frame list.");
488 printStackChunk( sp, stgCast(StgPtr,su) );
490 ASSERT(stgCast(StgPtr,su) == spBottom);
493 void printTSO( StgTSO *tso )
495 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
496 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
499 /* -----------------------------------------------------------------------------
502 NOTE: must be kept in sync with the closure types in includes/ClosureTypes.h
503 -------------------------------------------------------------------------- */
505 static char *closure_type_names[] = {
506 "INVALID_OBJECT", /* 0 */
508 "CONSTR_1_0", /* 2 */
509 "CONSTR_0_1", /* 3 */
510 "CONSTR_2_0", /* 4 */
511 "CONSTR_1_1", /* 5 */
512 "CONSTR_0_2", /* 6 */
513 "CONSTR_INTLIKE", /* 7 */
514 "CONSTR_CHARLIKE", /* 8 */
515 "CONSTR_STATIC", /* 9 */
516 "CONSTR_NOCAF_STATIC", /* 10 */
523 "FUN_STATIC", /* 17 */
525 "THUNK_1_0", /* 19 */
526 "THUNK_0_1", /* 20 */
527 "THUNK_2_0", /* 21 */
528 "THUNK_1_1", /* 22 */
529 "THUNK_0_2", /* 23 */
530 "THUNK_STATIC", /* 24 */
531 "THUNK_SELECTOR", /* 25 */
536 "IND_OLDGEN", /* 30 */
538 "IND_OLDGEN_PERM", /* 32 */
539 "IND_STATIC", /* 33 */
540 "CAF_BLACKHOLE", /* 36 */
542 "RET_SMALL", /* 38 */
543 "RET_VEC_SMALL", /* 39 */
545 "RET_VEC_BIG", /* 41 */
547 "UPDATE_FRAME", /* 43 */
548 "CATCH_FRAME", /* 44 */
549 "STOP_FRAME", /* 45 */
550 "SEQ_FRAME", /* 46 */
551 "BLACKHOLE", /* 47 */
552 "BLACKHOLE_BQ", /* 48 */
553 "SE_BLACKHOLE", /* 49 */
554 "SE_CAF_BLACKHOLE", /* 50 */
556 "ARR_WORDS", /* 52 */
557 "MUT_ARR_PTRS", /* 53 */
558 "MUT_ARR_PTRS_FROZEN", /* 54 */
562 "STABLE_NAME", /* 58 */
564 "BLOCKED_FETCH", /* 60 */
566 "FETCH_ME_BQ", /* 62 */
568 "EVACUATED", /* 64 */
569 "N_CLOSURE_TYPES" /* 65 */
573 info_type(StgClosure *closure){
574 return closure_type_names[get_itbl(closure)->type];
578 info_type_by_ip(StgInfoTable *ip){
579 return closure_type_names[ip->type];
583 info_hdr_type(StgClosure *closure, char *res){
584 strcpy(res,closure_type_names[get_itbl(closure)->type]);
587 /* --------------------------------------------------------------------------
588 * Address printing code
590 * Uses symbol table in (unstripped executable)
591 * ------------------------------------------------------------------------*/
593 /* --------------------------------------------------------------------------
594 * Simple lookup table
596 * Current implementation is pretty dumb!
597 * ------------------------------------------------------------------------*/
604 static nat max_table_size;
605 static nat table_size;
606 static struct entry* table;
608 static void reset_table( int size )
610 max_table_size = size;
612 table = (struct entry *) malloc(size * sizeof(struct entry));
615 static void prepare_table( void )
617 /* Could sort it... */
620 static void insert( unsigned value, const char *name )
622 if ( table_size >= max_table_size ) {
623 barf( "Symbol table overflow\n" );
625 table[table_size].value = value;
626 table[table_size].name = name;
627 table_size = table_size + 1;
632 static rtsBool lookup_name( char *name, unsigned *result )
635 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
637 if (i < table_size) {
638 *result = table[i].value;
646 /* Code from somewhere inside GHC (circa 1994)
648 * "std"++xs -> "Zstd"++xs
649 * char_to_c 'Z' = "ZZ"
650 * char_to_c '&' = "Za"
651 * char_to_c '|' = "Zb"
652 * char_to_c ':' = "Zc"
653 * char_to_c '/' = "Zd"
654 * char_to_c '=' = "Ze"
655 * char_to_c '>' = "Zg"
656 * char_to_c '#' = "Zh"
657 * char_to_c '<' = "Zl"
658 * char_to_c '-' = "Zm"
659 * char_to_c '!' = "Zn"
660 * char_to_c '.' = "Zo"
661 * char_to_c '+' = "Zp"
662 * char_to_c '\'' = "Zq"
663 * char_to_c '*' = "Zt"
664 * char_to_c '_' = "Zu"
665 * char_to_c c = "Z" ++ show (ord c)
667 static char unZcode( char ch )
670 case 'a' : return ('&');
671 case 'b' : return ('|');
672 case 'c' : return (':');
673 case 'd' : return ('/');
674 case 'e' : return ('=');
675 case 'g' : return ('>');
676 case 'h' : return ('#');
677 case 'l' : return ('<');
678 case 'm' : return ('-');
679 case 'n' : return ('!');
680 case 'o' : return ('.');
681 case 'p' : return ('+');
682 case 'q' : return ('\'');
683 case 't' : return ('*');
684 case 'u' : return ('_');
686 case '\0' : return ('Z');
687 default : return (ch);
692 /* Precondition: out big enough to handle output (about twice length of in) */
693 static void enZcode( char *in, char *out )
699 for( i = 0; in[i] != '\0'; ++i ) {
774 rtsBool lookupGHCName( StgPtr addr, const char **result )
777 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
779 if (i < table_size) {
780 *result = table[i].name;
787 static void printZcoded( const char *raw )
791 while ( raw[j] != '\0' ) {
793 fputc(unZcode(raw[j+1]),stderr);
796 fputc(raw[j],stderr);
802 /* --------------------------------------------------------------------------
803 * Symbol table loading
804 * ------------------------------------------------------------------------*/
806 /* Causing linking trouble on Win32 plats, so I'm
807 disabling this for now.
809 #if defined(HAVE_BFD_H) && !defined(_WIN32)
813 /* Fairly ad-hoc piece of code that seems to filter out a lot of
814 * rubbish like the obj-splitting symbols
817 static rtsBool isReal( flagword flags, const char *name )
820 /* ToDo: make this work on BFD */
821 int tp = type & N_TYPE;
822 if (tp == N_TEXT || tp == N_DATA) {
823 return (name[0] == '_' && name[1] != '_');
828 (void)flags; /* keep gcc -Wall happy */
830 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
831 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
838 extern void DEBUG_LoadSymbols( char *name )
844 abfd = bfd_openr(name, "default");
846 barf("can't open executable %s to get symbol table", name);
848 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
854 asymbol **symbol_table;
855 long number_of_symbols;
856 long num_real_syms = 0;
859 storage_needed = bfd_get_symtab_upper_bound (abfd);
861 if (storage_needed < 0) {
862 barf("can't read symbol table");
865 if (storage_needed == 0) {
866 belch("no storage needed");
869 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
871 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
873 if (number_of_symbols < 0) {
874 barf("can't canonicalise symbol table");
877 for( i = 0; i != number_of_symbols; ++i ) {
879 bfd_get_symbol_info(abfd,symbol_table[i],&info);
880 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
881 if (isReal(info.type, info.name)) {
887 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
888 number_of_symbols, num_real_syms)
891 reset_table( num_real_syms );
893 for( i = 0; i != number_of_symbols; ++i ) {
895 bfd_get_symbol_info(abfd,symbol_table[i],&info);
896 if (isReal(info.type, info.name)) {
897 insert( info.value, info.name );
906 #else /* HAVE_BFD_H */
908 extern void DEBUG_LoadSymbols( char *name STG_UNUSED )
913 #endif /* HAVE_BFD_H */
915 #include "StoragePriv.h"
917 void findPtr(P_ p); /* keep gcc -Wall happy */
926 for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
927 for (s = 0; s < generations[g].n_steps; s++) {
928 for (bd = generations[g].steps[s].blocks; bd; bd = bd->link) {
929 for (q = bd->start; q < bd->free; q++) {
940 void printPtr( StgPtr p )
942 fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
945 void printObj( StgClosure *obj )
947 fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );