1 /* -----------------------------------------------------------------------------
2 * $Id: Printer.c,v 1.45 2001/08/14 13:40:09 sewardj Exp $
4 * (c) The GHC Team, 1994-2000.
8 * ---------------------------------------------------------------------------*/
10 #include "PosixSource.h"
20 #include "Bytecodes.h" /* for InstrPtr */
21 #include "Disassembler.h"
25 #if defined(GRAN) || defined(PAR)
26 // HWL: explicit fixed header size to make debugging easier
27 int fixed_hs = FIXED_HS, itbl_sz = sizeofW(StgInfoTable),
28 uf_sz=sizeofW(StgUpdateFrame), sf_sz=sizeofW(StgSeqFrame);
31 /* --------------------------------------------------------------------------
32 * local function decls
33 * ------------------------------------------------------------------------*/
35 static void printStdObject( StgClosure *obj, char* tag );
36 static void reset_table ( int size );
37 static void prepare_table ( void );
38 static void insert ( unsigned value, const char *name );
39 #if 0 /* unused but might be useful sometime */
40 static rtsBool lookup_name ( char *name, unsigned *result );
41 static void enZcode ( char *in, char *out );
43 static char unZcode ( char ch );
44 rtsBool lookupGHCName ( StgPtr addr, const char **result );
45 static void printZcoded ( const char *raw );
47 /* --------------------------------------------------------------------------
49 * ------------------------------------------------------------------------*/
51 void printPtr( StgPtr p )
54 if (lookupGHCName( p, &raw )) {
57 fprintf(stderr, "%p", p);
61 void printObj( StgClosure *obj )
63 fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
67 static void printStdObject( StgClosure *obj, char* tag )
70 const StgInfoTable* info = get_itbl(obj);
71 fprintf(stderr,"%s(",tag);
72 printPtr((StgPtr)obj->header.info);
74 fprintf(stderr,", %s", obj->header.prof.ccs->cc->label);
76 for (i = 0; i < info->layout.payload.ptrs; ++i) {
78 printPtr((StgPtr)obj->payload[i]);
80 for (j = 0; j < info->layout.payload.nptrs; ++j) {
81 fprintf(stderr,", %pd#",obj->payload[i+j]);
83 fprintf(stderr,")\n");
86 void printClosure( StgClosure *obj )
92 switch ( info->type ) {
94 barf("Invalid object");
96 disassemble( (StgBCO*)obj );
101 StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
103 fprintf(stderr,"AP_UPD("); printPtr((StgPtr)ap->fun);
104 for (i = 0; i < ap->n_args; ++i) {
105 fprintf(stderr,", ");
106 printPtr((P_)ap->payload[i]);
108 fprintf(stderr,")\n");
114 StgPAP* pap = stgCast(StgPAP*,obj);
116 fprintf(stderr,"PAP("); printPtr((StgPtr)pap->fun);
117 for (i = 0; i < pap->n_args; ++i) {
118 fprintf(stderr,", ");
119 printPtr((StgPtr)pap->payload[i]);
121 fprintf(stderr,")\n");
126 fprintf(stderr,"FOREIGN(");
127 printPtr((StgPtr)( ((StgForeignObj*)obj)->data ));
128 fprintf(stderr,")\n");
132 fprintf(stderr,"IND(");
133 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
134 fprintf(stderr,")\n");
138 fprintf(stderr,"IND_STATIC(");
139 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
140 fprintf(stderr,")\n");
144 fprintf(stderr,"IND_OLDGEN(");
145 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
146 fprintf(stderr,")\n");
150 fprintf(stderr,"CAF_BH(");
151 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
152 fprintf(stderr,")\n");
156 fprintf(stderr,"SE_BH\n");
159 case SE_CAF_BLACKHOLE:
160 fprintf(stderr,"SE_CAF_BH\n");
164 fprintf(stderr,"BH\n");
168 fprintf(stderr,"BQ(");
169 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
170 fprintf(stderr,")\n");
174 fprintf(stderr,"TSO(");
175 fprintf(stderr,"%d (%p)",((StgTSO*)obj)->id, (StgTSO*)obj);
176 fprintf(stderr,")\n");
181 fprintf(stderr,"BLOCKED_FETCH(");
182 printGA(&(stgCast(StgBlockedFetch*,obj)->ga));
183 printPtr((StgPtr)(stgCast(StgBlockedFetch*,obj)->node));
184 fprintf(stderr,")\n");
188 fprintf(stderr,"FETCH_ME(");
189 printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
190 fprintf(stderr,")\n");
195 fprintf(stderr,"REMOTE_REF(");
196 printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
197 fprintf(stderr,")\n");
202 fprintf(stderr,"FETCH_ME_BQ(");
203 // printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
204 printPtr((StgPtr)stgCast(StgFetchMeBlockingQueue*,obj)->blocking_queue);
205 fprintf(stderr,")\n");
208 #if defined(GRAN) || defined(PAR)
210 fprintf(stderr,"RBH(");
211 printPtr((StgPtr)stgCast(StgRBH*,obj)->blocking_queue);
212 fprintf(stderr,")\n");
218 case CONSTR_1_0: case CONSTR_0_1:
219 case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
221 case CONSTR_CHARLIKE:
223 case CONSTR_NOCAF_STATIC:
225 /* We can't use printStdObject because we want to print the
230 fprintf(stderr,"%s(", info->prof.closure_desc);
231 fprintf(stderr,"%s", obj->header.prof.ccs->cc->label);
233 fprintf(stderr,"CONSTR(");
234 printPtr((StgPtr)obj->header.info);
235 fprintf(stderr,"(tag=%d)",info->srt_len);
237 for (i = 0; i < info->layout.payload.ptrs; ++i) {
238 fprintf(stderr,", ");
239 printPtr((StgPtr)obj->payload[i]);
241 for (j = 0; j < info->layout.payload.nptrs; ++j) {
242 fprintf(stderr,", %p#", obj->payload[i+j]);
244 fprintf(stderr,")\n");
249 /* rows are mutarrays in xmlambda, maybe we should make a new type: ROW */
250 case MUT_ARR_PTRS_FROZEN:
253 StgMutArrPtrs* p = stgCast(StgMutArrPtrs*,obj);
255 fprintf(stderr,"Row<%i>(",p->ptrs);
256 for (i = 0; i < p->ptrs; ++i) {
257 if (i > 0) fprintf(stderr,", ");
258 printPtr((StgPtr)(p->payload[i]));
260 fprintf(stderr,")\n");
266 case FUN_1_0: case FUN_0_1:
267 case FUN_1_1: case FUN_0_2: case FUN_2_0:
269 printStdObject(obj,"FUN");
273 case THUNK_1_0: case THUNK_0_1:
274 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
276 /* ToDo: will this work for THUNK_STATIC too? */
278 printStdObject(obj,info->prof.closure_desc);
280 printStdObject(obj,"THUNK");
285 printStdObject(obj,"THUNK_SELECTOR");
291 fprintf(stderr,"ARR_WORDS(\"");
292 /* ToDo: we can't safely assume that this is a string!
293 for (i = 0; arrWordsGetChar(obj,i); ++i) {
294 putchar(arrWordsGetChar(obj,i));
296 for (i=0; i<((StgArrWords *)obj)->words; i++)
297 fprintf(stderr, "%ld", ((StgArrWords *)obj)->payload[i]);
298 fprintf(stderr,"\")\n");
304 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
305 fprintf(stderr,"UpdateFrame(");
306 printPtr((StgPtr)GET_INFO(u));
308 printPtr((StgPtr)u->updatee);
310 printPtr((StgPtr)u->link);
311 fprintf(stderr,")\n");
317 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
318 fprintf(stderr,"CatchFrame(");
319 printPtr((StgPtr)GET_INFO(u));
321 printPtr((StgPtr)u->handler);
323 printPtr((StgPtr)u->link);
324 fprintf(stderr,")\n");
330 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
331 fprintf(stderr,"SeqFrame(");
332 printPtr((StgPtr)GET_INFO(u));
334 printPtr((StgPtr)u->link);
335 fprintf(stderr,")\n");
341 StgStopFrame* u = stgCast(StgStopFrame*,obj);
342 fprintf(stderr,"StopFrame(");
343 printPtr((StgPtr)GET_INFO(u));
344 fprintf(stderr,")\n");
348 //barf("printClosure %d",get_itbl(obj)->type);
349 fprintf(stderr, "*** printClosure: unknown type %d ****\n",
350 get_itbl(obj)->type );
351 barf("printClosure %d",get_itbl(obj)->type);
357 void printGraph( StgClosure *obj )
363 StgPtr printStackObj( StgPtr sp )
365 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
367 if (IS_ARG_TAG(*sp)) {
370 fprintf(stderr,"Tagged{");
371 for (i = 0; i < tag; i++) {
372 fprintf(stderr,"0x%x#", (unsigned)(*sp++));
373 if (i < tag-1) fprintf(stderr, ", ");
375 fprintf(stderr, "}\n");
377 StgClosure* c = (StgClosure*)(*sp);
378 printPtr((StgPtr)*sp);
379 if (c == (StgClosure*)&stg_ctoi_ret_R1p_info) {
380 fprintf(stderr, "\t\t\tstg_ctoi_ret_R1p_info\n" );
382 if (c == (StgClosure*)&stg_ctoi_ret_R1n_info) {
383 fprintf(stderr, "\t\t\tstg_ctoi_ret_R1n_info\n" );
385 if (c == (StgClosure*)&stg_ctoi_ret_F1_info) {
386 fprintf(stderr, "\t\t\tstg_ctoi_ret_F1_info\n" );
388 if (c == (StgClosure*)&stg_ctoi_ret_D1_info) {
389 fprintf(stderr, "\t\t\tstg_ctoi_ret_D1_info\n" );
391 if (c == (StgClosure*)&stg_ctoi_ret_V_info) {
392 fprintf(stderr, "\t\t\tstg_ctoi_ret_V_info\n" );
394 if (get_itbl(c)->type == BCO) {
395 fprintf(stderr, "\t\t\t");
396 fprintf(stderr, "BCO(...)\n");
399 fprintf(stderr, "\t\t\t");
400 printClosure ( (StgClosure*)(*sp));
408 void printStackChunk( StgPtr sp, StgPtr spBottom )
411 const StgInfoTable *info;
413 ASSERT(sp <= spBottom);
414 while (sp < spBottom) {
415 if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
416 info = get_itbl((StgClosure *)sp);
417 switch (info->type) {
420 printObj( stgCast(StgClosure*,sp) );
421 sp += sizeofW(StgUpdateFrame);
425 printObj( stgCast(StgClosure*,sp) );
426 sp += sizeofW(StgSeqFrame);
430 printObj( stgCast(StgClosure*,sp) );
431 sp += sizeofW(StgCatchFrame);
435 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
436 printObj( stgCast(StgClosure*,sp) );
440 fprintf(stderr, "RET_DYN (%p)\n", sp);
443 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
448 fprintf(stderr, "RET_SMALL (%p)\n", sp);
449 bitmap = info->layout.bitmap;
452 while (bitmap != 0) {
453 fprintf(stderr," stk[%ld] (%p) = ", spBottom-sp, sp);
454 if ((bitmap & 1) == 0) {
456 fprintf(stderr,"\n");
458 fprintf(stderr,"Word# %ld\n", *sp++);
461 bitmap = bitmap >> 1;
473 fprintf(stderr,"Stack[%ld] (%p) = ", spBottom-sp, sp);
474 sp = printStackObj(sp);
478 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
480 /* check everything down to the first update frame */
481 printStackChunk( sp, stgCast(StgPtr,su) );
482 while ( stgCast(StgPtr,su) < spBottom) {
483 sp = stgCast(StgPtr,su);
484 switch (get_itbl(su)->type) {
486 printObj( stgCast(StgClosure*,su) );
487 sp += sizeofW(StgUpdateFrame);
491 printObj( stgCast(StgClosure*,su) );
492 sp += sizeofW(StgSeqFrame);
493 su = stgCast(StgSeqFrame*,su)->link;
496 printObj( stgCast(StgClosure*,su) );
497 sp += sizeofW(StgCatchFrame);
498 su = stgCast(StgCatchFrame*,su)->link;
501 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
502 printObj( stgCast(StgClosure*,su) );
505 barf("printStack: weird record found on update frame list.");
507 printStackChunk( sp, stgCast(StgPtr,su) );
509 ASSERT(stgCast(StgPtr,su) == spBottom);
512 void printTSO( StgTSO *tso )
514 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
515 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
518 /* -----------------------------------------------------------------------------
521 NOTE: must be kept in sync with the closure types in includes/ClosureTypes.h
522 -------------------------------------------------------------------------- */
524 static char *closure_type_names[] = {
525 "INVALID_OBJECT", /* 0 */
527 "CONSTR_1_0", /* 2 */
528 "CONSTR_0_1", /* 3 */
529 "CONSTR_2_0", /* 4 */
530 "CONSTR_1_1", /* 5 */
531 "CONSTR_0_2", /* 6 */
532 "CONSTR_INTLIKE", /* 7 */
533 "CONSTR_CHARLIKE", /* 8 */
534 "CONSTR_STATIC", /* 9 */
535 "CONSTR_NOCAF_STATIC", /* 10 */
542 "FUN_STATIC", /* 17 */
544 "THUNK_1_0", /* 19 */
545 "THUNK_0_1", /* 20 */
546 "THUNK_2_0", /* 21 */
547 "THUNK_1_1", /* 22 */
548 "THUNK_0_2", /* 23 */
549 "THUNK_STATIC", /* 24 */
550 "THUNK_SELECTOR", /* 25 */
555 "IND_OLDGEN", /* 30 */
557 "IND_OLDGEN_PERM", /* 32 */
558 "IND_STATIC", /* 33 */
559 "CAF_BLACKHOLE", /* 36 */
561 "RET_SMALL", /* 38 */
562 "RET_VEC_SMALL", /* 39 */
564 "RET_VEC_BIG", /* 41 */
566 "UPDATE_FRAME", /* 43 */
567 "CATCH_FRAME", /* 44 */
568 "STOP_FRAME", /* 45 */
569 "SEQ_FRAME", /* 46 */
570 "BLACKHOLE", /* 47 */
571 "BLACKHOLE_BQ", /* 48 */
572 "SE_BLACKHOLE", /* 49 */
573 "SE_CAF_BLACKHOLE", /* 50 */
575 "ARR_WORDS", /* 52 */
576 "MUT_ARR_PTRS", /* 53 */
577 "MUT_ARR_PTRS_FROZEN", /* 54 */
581 "STABLE_NAME", /* 58 */
583 "BLOCKED_FETCH", /* 60 */
585 "FETCH_ME_BQ", /* 62 */
587 "EVACUATED", /* 64 */
588 "REMOTE_REF", /* 65 */
589 "N_CLOSURE_TYPES" /* 66 */
593 info_type(StgClosure *closure){
594 return closure_type_names[get_itbl(closure)->type];
598 info_type_by_ip(StgInfoTable *ip){
599 return closure_type_names[ip->type];
603 info_hdr_type(StgClosure *closure, char *res){
604 strcpy(res,closure_type_names[get_itbl(closure)->type]);
607 /* --------------------------------------------------------------------------
608 * Address printing code
610 * Uses symbol table in (unstripped executable)
611 * ------------------------------------------------------------------------*/
613 /* --------------------------------------------------------------------------
614 * Simple lookup table
616 * Current implementation is pretty dumb!
617 * ------------------------------------------------------------------------*/
624 static nat max_table_size;
625 static nat table_size;
626 static struct entry* table;
628 static void reset_table( int size )
630 max_table_size = size;
632 table = (struct entry *) malloc(size * sizeof(struct entry));
635 static void prepare_table( void )
637 /* Could sort it... */
640 static void insert( unsigned value, const char *name )
642 if ( table_size >= max_table_size ) {
643 barf( "Symbol table overflow\n" );
645 table[table_size].value = value;
646 table[table_size].name = name;
647 table_size = table_size + 1;
652 static rtsBool lookup_name( char *name, unsigned *result )
655 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
657 if (i < table_size) {
658 *result = table[i].value;
666 /* Code from somewhere inside GHC (circa 1994)
668 * "std"++xs -> "Zstd"++xs
669 * char_to_c 'Z' = "ZZ"
670 * char_to_c '&' = "Za"
671 * char_to_c '|' = "Zb"
672 * char_to_c ':' = "Zc"
673 * char_to_c '/' = "Zd"
674 * char_to_c '=' = "Ze"
675 * char_to_c '>' = "Zg"
676 * char_to_c '#' = "Zh"
677 * char_to_c '<' = "Zl"
678 * char_to_c '-' = "Zm"
679 * char_to_c '!' = "Zn"
680 * char_to_c '.' = "Zo"
681 * char_to_c '+' = "Zp"
682 * char_to_c '\'' = "Zq"
683 * char_to_c '*' = "Zt"
684 * char_to_c '_' = "Zu"
685 * char_to_c c = "Z" ++ show (ord c)
687 static char unZcode( char ch )
690 case 'a' : return ('&');
691 case 'b' : return ('|');
692 case 'c' : return (':');
693 case 'd' : return ('/');
694 case 'e' : return ('=');
695 case 'g' : return ('>');
696 case 'h' : return ('#');
697 case 'l' : return ('<');
698 case 'm' : return ('-');
699 case 'n' : return ('!');
700 case 'o' : return ('.');
701 case 'p' : return ('+');
702 case 'q' : return ('\'');
703 case 't' : return ('*');
704 case 'u' : return ('_');
706 case '\0' : return ('Z');
707 default : return (ch);
712 /* Precondition: out big enough to handle output (about twice length of in) */
713 static void enZcode( char *in, char *out )
719 for( i = 0; in[i] != '\0'; ++i ) {
794 rtsBool lookupGHCName( StgPtr addr, const char **result )
797 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
799 if (i < table_size) {
800 *result = table[i].name;
807 static void printZcoded( const char *raw )
811 while ( raw[j] != '\0' ) {
813 fputc(unZcode(raw[j+1]),stderr);
816 fputc(raw[j],stderr);
822 /* --------------------------------------------------------------------------
823 * Symbol table loading
824 * ------------------------------------------------------------------------*/
826 /* Causing linking trouble on Win32 plats, so I'm
827 disabling this for now.
833 /* Fairly ad-hoc piece of code that seems to filter out a lot of
834 * rubbish like the obj-splitting symbols
837 static rtsBool isReal( flagword flags, const char *name )
840 /* ToDo: make this work on BFD */
841 int tp = type & N_TYPE;
842 if (tp == N_TEXT || tp == N_DATA) {
843 return (name[0] == '_' && name[1] != '_');
848 (void)flags; /* keep gcc -Wall happy */
850 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
851 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
858 extern void DEBUG_LoadSymbols( char *name )
864 abfd = bfd_openr(name, "default");
866 barf("can't open executable %s to get symbol table", name);
868 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
874 asymbol **symbol_table;
875 long number_of_symbols;
876 long num_real_syms = 0;
879 storage_needed = bfd_get_symtab_upper_bound (abfd);
881 if (storage_needed < 0) {
882 barf("can't read symbol table");
885 if (storage_needed == 0) {
886 belch("no storage needed");
889 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
891 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
893 if (number_of_symbols < 0) {
894 barf("can't canonicalise symbol table");
897 for( i = 0; i != number_of_symbols; ++i ) {
899 bfd_get_symbol_info(abfd,symbol_table[i],&info);
900 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
901 if (isReal(info.type, info.name)) {
907 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
908 number_of_symbols, num_real_syms)
911 reset_table( num_real_syms );
913 for( i = 0; i != number_of_symbols; ++i ) {
915 bfd_get_symbol_info(abfd,symbol_table[i],&info);
916 if (isReal(info.type, info.name)) {
917 insert( info.value, info.name );
926 #else /* HAVE_BFD_H */
928 extern void DEBUG_LoadSymbols( char *name STG_UNUSED )
933 #endif /* HAVE_BFD_H */
935 #include "StoragePriv.h"
937 void findPtr(P_ p, int); /* keep gcc -Wall happy */
940 findPtr(P_ p, int follow)
945 const int arr_size = 1024;
946 StgPtr arr[arr_size];
949 for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
950 for (s = 0; s < generations[g].n_steps; s++) {
951 if (RtsFlags.GcFlags.generations == 1) {
952 bd = generations[g].steps[s].to_blocks;
954 bd = generations[g].steps[s].blocks;
956 for (; bd; bd = bd->link) {
957 for (q = bd->start; q < bd->free; q++) {
961 while (!LOOKS_LIKE_GHC_INFO(*r)) { r--; };
962 fprintf(stderr, "%p = ", r);
963 printClosure((StgClosure *)r);
973 if (follow && i == 1) {
974 fprintf(stderr, "-->\n");
980 void printPtr( StgPtr p )
982 fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
985 void printObj( StgClosure *obj )
987 fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );