1 /* -----------------------------------------------------------------------------
2 * $Id: Printer.c,v 1.28 2000/08/15 11:48:06 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 * ------------------------------------------------------------------------*/
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((P_)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 (%p)",((StgTSO*)obj)->id, (StgTSO*)obj);
200 fprintf(stderr,")\n");
205 fprintf(stderr,"BLOCKED_FETCH(");
206 printGA(&(stgCast(StgBlockedFetch*,obj)->ga));
207 printPtr((StgPtr)(stgCast(StgBlockedFetch*,obj)->node));
208 fprintf(stderr,")\n");
212 fprintf(stderr,"FETCH_ME(");
213 printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
214 fprintf(stderr,")\n");
218 fprintf(stderr,"FETCH_ME_BQ(");
219 // printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
220 printPtr((StgPtr)stgCast(StgFetchMeBlockingQueue*,obj)->blocking_queue);
221 fprintf(stderr,")\n");
224 #if defined(GRAN) || defined(PAR)
226 fprintf(stderr,"RBH(");
227 printPtr((StgPtr)stgCast(StgRBH*,obj)->blocking_queue);
228 fprintf(stderr,")\n");
234 case CONSTR_1_0: case CONSTR_0_1:
235 case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
237 case CONSTR_CHARLIKE:
239 case CONSTR_NOCAF_STATIC:
241 /* We can't use printStdObject because we want to print the
245 const StgInfoTable* info = get_itbl(obj);
246 fprintf(stderr,"PACK(");
247 printPtr((StgPtr)obj->header.info);
248 fprintf(stderr,"(tag=%d)",info->srt_len);
249 for (i = 0; i < info->layout.payload.ptrs; ++i) {
250 fprintf(stderr,", ");
251 printPtr((StgPtr)obj->payload[i]);
253 for (j = 0; j < info->layout.payload.nptrs; ++j) {
254 fprintf(stderr,", %p#", obj->payload[i+j]);
256 fprintf(stderr,")\n");
261 /* rows are mutarrays in xmlambda, maybe we should make a new type: ROW */
262 case MUT_ARR_PTRS_FROZEN:
265 StgMutArrPtrs* p = stgCast(StgMutArrPtrs*,obj);
267 fprintf(stderr,"Row<%i>(",p->ptrs);
268 for (i = 0; i < p->ptrs; ++i) {
269 if (i > 0) fprintf(stderr,", ");
270 printPtr((StgPtr)(p->payload[i]));
272 fprintf(stderr,")\n");
278 case FUN_1_0: case FUN_0_1:
279 case FUN_1_1: case FUN_0_2: case FUN_2_0:
281 printStdObject(obj,"FUN");
285 case THUNK_1_0: case THUNK_0_1:
286 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
288 /* ToDo: will this work for THUNK_STATIC too? */
289 printStdObject(obj,"THUNK");
293 printStdObject(obj,"THUNK_SELECTOR");
299 fprintf(stderr,"ARR_WORDS(\"");
300 /* ToDo: we can't safely assume that this is a string!
301 for (i = 0; arrWordsGetChar(obj,i); ++i) {
302 putchar(arrWordsGetChar(obj,i));
304 for (i=0; i<((StgArrWords *)obj)->words; i++)
305 fprintf(stderr, "%d", ((StgArrWords *)obj)->payload[i]);
306 fprintf(stderr,"\")\n");
312 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
313 fprintf(stderr,"UpdateFrame(");
314 printPtr((StgPtr)GET_INFO(u));
316 printPtr((StgPtr)u->updatee);
318 printPtr((StgPtr)u->link);
319 fprintf(stderr,")\n");
325 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
326 fprintf(stderr,"CatchFrame(");
327 printPtr((StgPtr)GET_INFO(u));
329 printPtr((StgPtr)u->handler);
331 printPtr((StgPtr)u->link);
332 fprintf(stderr,")\n");
338 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
339 fprintf(stderr,"SeqFrame(");
340 printPtr((StgPtr)GET_INFO(u));
342 printPtr((StgPtr)u->link);
343 fprintf(stderr,")\n");
349 StgStopFrame* u = stgCast(StgStopFrame*,obj);
350 fprintf(stderr,"StopFrame(");
351 printPtr((StgPtr)GET_INFO(u));
352 fprintf(stderr,")\n");
356 //barf("printClosure %d",get_itbl(obj)->type);
357 fprintf(stderr, "*** printClosure: unknown type %d ****\n",
358 get_itbl(obj)->type );
364 void printGraph( StgClosure *obj )
370 StgPtr printStackObj( StgPtr sp )
372 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
374 if (IS_ARG_TAG(*sp)) {
377 fprintf(stderr,"Tagged{");
378 for (i = 0; i < tag; i++) {
379 fprintf(stderr,"0x%x#", (unsigned)(*sp++));
380 if (i < tag-1) fprintf(stderr, ", ");
382 fprintf(stderr, "}\n");
384 StgClosure* c = (StgClosure*)(*sp);
385 printPtr((StgPtr)*sp);
387 if (c == &ret_bco_info) {
388 fprintf(stderr, "\t\t");
389 fprintf(stderr, "ret_bco_info\n" );
391 if (IS_HUGS_CONSTR_INFO(GET_INFO(c))) {
392 fprintf(stderr, "\t\t\t");
393 fprintf(stderr, "ConstrInfoTable\n" );
396 if (get_itbl(c)->type == BCO) {
397 fprintf(stderr, "\t\t\t");
398 fprintf(stderr, "BCO(...)\n");
401 fprintf(stderr, "\t\t\t");
402 printClosure ( (StgClosure*)(*sp));
410 void printStackChunk( StgPtr sp, StgPtr spBottom )
413 const StgInfoTable *info;
415 ASSERT(sp <= spBottom);
416 while (sp < spBottom) {
417 if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
418 info = get_itbl((StgClosure *)sp);
419 switch (info->type) {
422 printObj( stgCast(StgClosure*,sp) );
423 sp += sizeofW(StgUpdateFrame);
427 printObj( stgCast(StgClosure*,sp) );
428 sp += sizeofW(StgSeqFrame);
432 printObj( stgCast(StgClosure*,sp) );
433 sp += sizeofW(StgCatchFrame);
437 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
438 printObj( stgCast(StgClosure*,sp) );
442 fprintf(stderr, "RET_DYN (%p)\n", sp);
445 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
450 fprintf(stderr, "RET_SMALL (%p)\n", sp);
451 bitmap = info->layout.bitmap;
454 while (bitmap != 0) {
455 fprintf(stderr," stk[%d] (%p) = ", spBottom-sp, sp);
456 if ((bitmap & 1) == 0) {
458 fprintf(stderr,"\n");
460 fprintf(stderr,"Word# %d\n", *sp++);
463 bitmap = bitmap >> 1;
475 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
476 sp = printStackObj(sp);
480 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
482 /* check everything down to the first update frame */
483 printStackChunk( sp, stgCast(StgPtr,su) );
484 while ( stgCast(StgPtr,su) < spBottom) {
485 sp = stgCast(StgPtr,su);
486 switch (get_itbl(su)->type) {
488 printObj( stgCast(StgClosure*,su) );
489 sp += sizeofW(StgUpdateFrame);
493 printObj( stgCast(StgClosure*,su) );
494 sp += sizeofW(StgSeqFrame);
495 su = stgCast(StgSeqFrame*,su)->link;
498 printObj( stgCast(StgClosure*,su) );
499 sp += sizeofW(StgCatchFrame);
500 su = stgCast(StgCatchFrame*,su)->link;
503 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
504 printObj( stgCast(StgClosure*,su) );
507 barf("printStack: weird record found on update frame list.");
509 printStackChunk( sp, stgCast(StgPtr,su) );
511 ASSERT(stgCast(StgPtr,su) == spBottom);
514 void printTSO( StgTSO *tso )
516 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
517 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
520 /* -----------------------------------------------------------------------------
523 NOTE: must be kept in sync with the closure types in includes/ClosureTypes.h
524 -------------------------------------------------------------------------- */
526 static char *closure_type_names[] = {
527 "INVALID_OBJECT", /* 0 */
529 "CONSTR_1_0", /* 2 */
530 "CONSTR_0_1", /* 3 */
531 "CONSTR_2_0", /* 4 */
532 "CONSTR_1_1", /* 5 */
533 "CONSTR_0_2", /* 6 */
534 "CONSTR_INTLIKE", /* 7 */
535 "CONSTR_CHARLIKE", /* 8 */
536 "CONSTR_STATIC", /* 9 */
537 "CONSTR_NOCAF_STATIC", /* 10 */
544 "FUN_STATIC", /* 17 */
546 "THUNK_1_0", /* 19 */
547 "THUNK_0_1", /* 20 */
548 "THUNK_2_0", /* 21 */
549 "THUNK_1_1", /* 22 */
550 "THUNK_0_2", /* 23 */
551 "THUNK_STATIC", /* 24 */
552 "THUNK_SELECTOR", /* 25 */
557 "IND_OLDGEN", /* 30 */
559 "IND_OLDGEN_PERM", /* 32 */
560 "IND_STATIC", /* 33 */
561 "CAF_UNENTERED", /* 34 */
562 "CAF_ENTERED", /* 35 */
563 "CAF_BLACKHOLE", /* 36 */
565 "RET_SMALL", /* 38 */
566 "RET_VEC_SMALL", /* 39 */
568 "RET_VEC_BIG", /* 41 */
570 "UPDATE_FRAME", /* 43 */
571 "CATCH_FRAME", /* 44 */
572 "STOP_FRAME", /* 45 */
573 "SEQ_FRAME", /* 46 */
574 "BLACKHOLE", /* 47 */
575 "BLACKHOLE_BQ", /* 48 */
576 "SE_BLACKHOLE", /* 49 */
577 "SE_CAF_BLACKHOLE", /* 50 */
579 "ARR_WORDS", /* 52 */
580 "MUT_ARR_PTRS", /* 53 */
581 "MUT_ARR_PTRS_FROZEN", /* 54 */
585 "STABLE_NAME", /* 58 */
587 "BLOCKED_FETCH", /* 60 */
589 "FETCH_ME_BQ", /* 62 */
591 "EVACUATED", /* 64 */
592 "N_CLOSURE_TYPES" /* 65 */
596 info_type(StgClosure *closure){
597 return closure_type_names[get_itbl(closure)->type];
601 info_type_by_ip(StgInfoTable *ip){
602 return closure_type_names[ip->type];
606 info_hdr_type(StgClosure *closure, char *res){
607 strcpy(res,closure_type_names[get_itbl(closure)->type]);
610 /* --------------------------------------------------------------------------
611 * Address printing code
613 * Uses symbol table in (unstripped executable)
614 * ------------------------------------------------------------------------*/
616 /* --------------------------------------------------------------------------
617 * Simple lookup table
619 * Current implementation is pretty dumb!
620 * ------------------------------------------------------------------------*/
627 static nat max_table_size;
628 static nat table_size;
629 static struct entry* table;
631 static void reset_table( int size )
633 max_table_size = size;
635 table = (struct entry *) malloc(size * sizeof(struct entry));
638 static void prepare_table( void )
640 /* Could sort it... */
643 static void insert( unsigned value, const char *name )
645 if ( table_size >= max_table_size ) {
646 barf( "Symbol table overflow\n" );
648 table[table_size].value = value;
649 table[table_size].name = name;
650 table_size = table_size + 1;
655 static rtsBool lookup_name( char *name, unsigned *result )
658 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
660 if (i < table_size) {
661 *result = table[i].value;
669 /* Code from somewhere inside GHC (circa 1994)
671 * "std"++xs -> "Zstd"++xs
672 * char_to_c 'Z' = "ZZ"
673 * char_to_c '&' = "Za"
674 * char_to_c '|' = "Zb"
675 * char_to_c ':' = "Zc"
676 * char_to_c '/' = "Zd"
677 * char_to_c '=' = "Ze"
678 * char_to_c '>' = "Zg"
679 * char_to_c '#' = "Zh"
680 * char_to_c '<' = "Zl"
681 * char_to_c '-' = "Zm"
682 * char_to_c '!' = "Zn"
683 * char_to_c '.' = "Zo"
684 * char_to_c '+' = "Zp"
685 * char_to_c '\'' = "Zq"
686 * char_to_c '*' = "Zt"
687 * char_to_c '_' = "Zu"
688 * char_to_c c = "Z" ++ show (ord c)
690 static char unZcode( char ch )
693 case 'a' : return ('&');
694 case 'b' : return ('|');
695 case 'c' : return (':');
696 case 'd' : return ('/');
697 case 'e' : return ('=');
698 case 'g' : return ('>');
699 case 'h' : return ('#');
700 case 'l' : return ('<');
701 case 'm' : return ('-');
702 case 'n' : return ('!');
703 case 'o' : return ('.');
704 case 'p' : return ('+');
705 case 'q' : return ('\'');
706 case 't' : return ('*');
707 case 'u' : return ('_');
709 case '\0' : return ('Z');
710 default : return (ch);
715 /* Precondition: out big enough to handle output (about twice length of in) */
716 static void enZcode( char *in, char *out )
722 for( i = 0; in[i] != '\0'; ++i ) {
797 rtsBool lookupGHCName( StgPtr addr, const char **result )
800 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
802 if (i < table_size) {
803 *result = table[i].name;
810 static void printZcoded( const char *raw )
814 while ( raw[j] != '\0' ) {
816 fputc(unZcode(raw[j+1]),stderr);
819 fputc(raw[j],stderr);
825 /* --------------------------------------------------------------------------
826 * Symbol table loading
827 * ------------------------------------------------------------------------*/
829 /* Causing linking trouble on Win32 plats, so I'm
830 disabling this for now.
832 #if defined(HAVE_BFD_H) && !defined(_WIN32)
836 /* Fairly ad-hoc piece of code that seems to filter out a lot of
837 * rubbish like the obj-splitting symbols
840 static rtsBool isReal( flagword flags, const char *name )
843 /* ToDo: make this work on BFD */
844 int tp = type & N_TYPE;
845 if (tp == N_TEXT || tp == N_DATA) {
846 return (name[0] == '_' && name[1] != '_');
851 (void)flags; /* keep gcc -Wall happy */
853 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
854 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
861 extern void DEBUG_LoadSymbols( char *name )
867 abfd = bfd_openr(name, "default");
869 barf("can't open executable %s to get symbol table", name);
871 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
877 asymbol **symbol_table;
878 long number_of_symbols;
879 long num_real_syms = 0;
882 storage_needed = bfd_get_symtab_upper_bound (abfd);
884 if (storage_needed < 0) {
885 barf("can't read symbol table");
888 if (storage_needed == 0) {
889 belch("no storage needed");
892 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
894 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
896 if (number_of_symbols < 0) {
897 barf("can't canonicalise symbol table");
900 for( i = 0; i != number_of_symbols; ++i ) {
902 bfd_get_symbol_info(abfd,symbol_table[i],&info);
903 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
904 if (isReal(info.type, info.name)) {
910 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
911 number_of_symbols, num_real_syms)
914 reset_table( num_real_syms );
916 for( i = 0; i != number_of_symbols; ++i ) {
918 bfd_get_symbol_info(abfd,symbol_table[i],&info);
919 if (isReal(info.type, info.name)) {
920 insert( info.value, info.name );
929 #else /* HAVE_BFD_H */
931 extern void DEBUG_LoadSymbols( char *name STG_UNUSED )
936 #endif /* HAVE_BFD_H */
938 #include "StoragePriv.h"
940 void findPtr(P_ p); /* keep gcc -Wall happy */
949 for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
950 for (s = 0; s < generations[g].n_steps; s++) {
951 for (bd = generations[g].steps[s].blocks; bd; bd = bd->link) {
952 for (q = bd->start; q < bd->free; q++) {
963 void printPtr( StgPtr p )
965 fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
968 void printObj( StgClosure *obj )
970 fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );