1 /* -----------------------------------------------------------------------------
2 * $Id: Printer.c,v 1.55 2002/12/19 18:00:42 panne Exp $
4 * (c) The GHC Team, 1994-2000.
8 * ---------------------------------------------------------------------------*/
10 #include "PosixSource.h"
22 #include "Bytecodes.h" /* for InstrPtr */
23 #include "Disassembler.h"
28 #if defined(GRAN) || defined(PAR)
29 // HWL: explicit fixed header size to make debugging easier
30 int fixed_hs = FIXED_HS, itbl_sz = sizeofW(StgInfoTable),
31 uf_sz=sizeofW(StgUpdateFrame);
34 /* --------------------------------------------------------------------------
35 * local function decls
36 * ------------------------------------------------------------------------*/
38 static void printStdObject( StgClosure *obj, char* tag );
39 static void printStdObjPayload( StgClosure *obj );
40 static void reset_table ( int size );
41 static void prepare_table ( void );
42 static void insert ( unsigned value, const char *name );
43 #if 0 /* unused but might be useful sometime */
44 static rtsBool lookup_name ( char *name, unsigned *result );
45 static void enZcode ( char *in, char *out );
47 static char unZcode ( char ch );
48 const char * lookupGHCName ( void *addr );
49 static void printZcoded ( const char *raw );
51 /* --------------------------------------------------------------------------
53 * ------------------------------------------------------------------------*/
55 void printPtr( StgPtr p )
58 raw = lookupGHCName(p);
62 fprintf(stderr, "%p", p);
66 void printObj( StgClosure *obj )
68 fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
73 printStdObjHdr( StgClosure *obj, char* tag )
75 fprintf(stderr,"%s(",tag);
76 printPtr((StgPtr)obj->header.info);
78 fprintf(stderr,", %s", obj->header.prof.ccs->cc->label);
83 printStdObjPayload( StgClosure *obj )
86 const StgInfoTable* info;
89 for (i = 0; i < info->layout.payload.ptrs; ++i) {
91 printPtr((StgPtr)obj->payload[i]);
93 for (j = 0; j < info->layout.payload.nptrs; ++j) {
94 fprintf(stderr,", %pd#",obj->payload[i+j]);
96 fprintf(stderr,")\n");
100 printStdObject( StgClosure *obj, char* tag )
102 printStdObjHdr( obj, tag );
103 printStdObjPayload( obj );
107 printClosure( StgClosure *obj )
111 info = get_itbl(obj);
113 switch ( info->type ) {
115 barf("Invalid object");
117 disassemble( (StgBCO*)obj );
122 StgMutVar* mv = (StgMutVar*)obj;
123 fprintf(stderr,"MUT_VAR(var=%p, link=%p)\n", mv->var, mv->mut_link);
129 StgAP_STACK* ap = stgCast(StgAP_STACK*,obj);
131 fprintf(stderr,"AP_STACK("); printPtr((StgPtr)ap->fun);
132 for (i = 0; i < ap->size; ++i) {
133 fprintf(stderr,", ");
134 printPtr((P_)ap->payload[i]);
136 fprintf(stderr,")\n");
142 StgPAP* ap = stgCast(StgPAP*,obj);
144 fprintf(stderr,"AP("); printPtr((StgPtr)ap->fun);
145 for (i = 0; i < ap->n_args; ++i) {
146 fprintf(stderr,", ");
147 printPtr((P_)ap->payload[i]);
149 fprintf(stderr,")\n");
155 StgPAP* pap = stgCast(StgPAP*,obj);
157 fprintf(stderr,"PAP/%d(",pap->arity);
158 printPtr((StgPtr)pap->fun);
159 for (i = 0; i < pap->n_args; ++i) {
160 fprintf(stderr,", ");
161 printPtr((StgPtr)pap->payload[i]);
163 fprintf(stderr,")\n");
168 fprintf(stderr,"FOREIGN(");
169 printPtr((StgPtr)( ((StgForeignObj*)obj)->data ));
170 fprintf(stderr,")\n");
174 fprintf(stderr,"IND(");
175 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
176 fprintf(stderr,")\n");
180 fprintf(stderr,"IND(");
181 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
182 fprintf(stderr,")\n");
186 fprintf(stderr,"IND_STATIC(");
187 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
188 fprintf(stderr,")\n");
192 fprintf(stderr,"IND_OLDGEN(");
193 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
194 fprintf(stderr,")\n");
198 fprintf(stderr,"CAF_BH(");
199 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
200 fprintf(stderr,")\n");
204 fprintf(stderr,"SE_BH\n");
207 case SE_CAF_BLACKHOLE:
208 fprintf(stderr,"SE_CAF_BH\n");
212 fprintf(stderr,"BH\n");
216 fprintf(stderr,"BQ(");
217 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
218 fprintf(stderr,")\n");
222 fprintf(stderr,"TSO(");
223 fprintf(stderr,"%d (%p)",((StgTSO*)obj)->id, (StgTSO*)obj);
224 fprintf(stderr,")\n");
229 fprintf(stderr,"BLOCKED_FETCH(");
230 printGA(&(stgCast(StgBlockedFetch*,obj)->ga));
231 printPtr((StgPtr)(stgCast(StgBlockedFetch*,obj)->node));
232 fprintf(stderr,")\n");
236 fprintf(stderr,"FETCH_ME(");
237 printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
238 fprintf(stderr,")\n");
243 fprintf(stderr,"REMOTE_REF(");
244 printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
245 fprintf(stderr,")\n");
250 fprintf(stderr,"FETCH_ME_BQ(");
251 // printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
252 printPtr((StgPtr)stgCast(StgFetchMeBlockingQueue*,obj)->blocking_queue);
253 fprintf(stderr,")\n");
256 #if defined(GRAN) || defined(PAR)
258 fprintf(stderr,"RBH(");
259 printPtr((StgPtr)stgCast(StgRBH*,obj)->blocking_queue);
260 fprintf(stderr,")\n");
266 case CONSTR_1_0: case CONSTR_0_1:
267 case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
269 case CONSTR_CHARLIKE:
271 case CONSTR_NOCAF_STATIC:
273 /* We can't use printStdObject because we want to print the
278 fprintf(stderr,"%s(", info->prof.closure_desc);
279 fprintf(stderr,"%s", obj->header.prof.ccs->cc->label);
281 fprintf(stderr,"CONSTR(");
282 printPtr((StgPtr)obj->header.info);
283 fprintf(stderr,"(tag=%d)",info->srt_len);
285 for (i = 0; i < info->layout.payload.ptrs; ++i) {
286 fprintf(stderr,", ");
287 printPtr((StgPtr)obj->payload[i]);
289 for (j = 0; j < info->layout.payload.nptrs; ++j) {
290 fprintf(stderr,", %p#", obj->payload[i+j]);
292 fprintf(stderr,")\n");
297 /* rows are mutarrays in xmlambda, maybe we should make a new type: ROW */
298 case MUT_ARR_PTRS_FROZEN:
301 StgMutArrPtrs* p = stgCast(StgMutArrPtrs*,obj);
303 fprintf(stderr,"Row<%i>(",p->ptrs);
304 for (i = 0; i < p->ptrs; ++i) {
305 if (i > 0) fprintf(stderr,", ");
306 printPtr((StgPtr)(p->payload[i]));
308 fprintf(stderr,")\n");
314 case FUN_1_0: case FUN_0_1:
315 case FUN_1_1: case FUN_0_2: case FUN_2_0:
317 fprintf(stderr,"FUN/%d(",itbl_to_fun_itbl(info)->arity);
318 printPtr((StgPtr)obj->header.info);
320 fprintf(stderr,", %s", obj->header.prof.ccs->cc->label);
322 printStdObjPayload(obj);
326 case THUNK_1_0: case THUNK_0_1:
327 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
329 /* ToDo: will this work for THUNK_STATIC too? */
331 printStdObject(obj,info->prof.closure_desc);
333 printStdObject(obj,"THUNK");
338 printStdObjHdr(obj, "THUNK_SELECTOR");
339 fprintf(stderr, ", %p)\n", ((StgSelector *)obj)->selectee);
343 fprintf(stderr,"MUT_ARR_PTRS(size=%d)\n", ((StgMutArrPtrs *)obj)->ptrs);
345 case MUT_ARR_PTRS_FROZEN:
346 fprintf(stderr,"MUT_ARR_PTRS_FROZEN(size=%d)\n", ((StgMutArrPtrs *)obj)->ptrs);
352 fprintf(stderr,"ARR_WORDS(\"");
353 /* ToDo: we can't safely assume that this is a string!
354 for (i = 0; arrWordsGetChar(obj,i); ++i) {
355 putchar(arrWordsGetChar(obj,i));
357 for (i=0; i<((StgArrWords *)obj)->words; i++)
358 fprintf(stderr, "%u", ((StgArrWords *)obj)->payload[i]);
359 fprintf(stderr,"\")\n");
365 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
366 fprintf(stderr,"UPDATE_FRAME(");
367 printPtr((StgPtr)GET_INFO(u));
369 printPtr((StgPtr)u->updatee);
370 fprintf(stderr,")\n");
376 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
377 fprintf(stderr,"CATCH_FRAME(");
378 printPtr((StgPtr)GET_INFO(u));
380 printPtr((StgPtr)u->handler);
381 fprintf(stderr,")\n");
387 StgStopFrame* u = stgCast(StgStopFrame*,obj);
388 fprintf(stderr,"STOP_FRAME(");
389 printPtr((StgPtr)GET_INFO(u));
390 fprintf(stderr,")\n");
394 //barf("printClosure %d",get_itbl(obj)->type);
395 fprintf(stderr, "*** printClosure: unknown type %d ****\n",
396 get_itbl(obj)->type );
397 barf("printClosure %d",get_itbl(obj)->type);
403 void printGraph( StgClosure *obj )
410 printStackObj( StgPtr sp )
412 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
414 StgClosure* c = (StgClosure*)(*sp);
415 printPtr((StgPtr)*sp);
416 if (c == (StgClosure*)&stg_ctoi_ret_R1p_info) {
417 fprintf(stderr, "\t\t\tstg_ctoi_ret_R1p_info\n" );
419 if (c == (StgClosure*)&stg_ctoi_ret_R1n_info) {
420 fprintf(stderr, "\t\t\tstg_ctoi_ret_R1n_info\n" );
422 if (c == (StgClosure*)&stg_ctoi_ret_F1_info) {
423 fprintf(stderr, "\t\t\tstg_ctoi_ret_F1_info\n" );
425 if (c == (StgClosure*)&stg_ctoi_ret_D1_info) {
426 fprintf(stderr, "\t\t\tstg_ctoi_ret_D1_info\n" );
428 if (c == (StgClosure*)&stg_ctoi_ret_V_info) {
429 fprintf(stderr, "\t\t\tstg_ctoi_ret_V_info\n" );
431 if (get_itbl(c)->type == BCO) {
432 fprintf(stderr, "\t\t\t");
433 fprintf(stderr, "BCO(...)\n");
436 fprintf(stderr, "\t\t\t");
437 printClosure ( (StgClosure*)(*sp));
446 printSmallBitmap( StgPtr spBottom, StgPtr payload, StgWord bitmap, nat size )
452 for(i = 0; i < size; i++, bitmap >>= 1 ) {
453 fprintf(stderr," stk[%d] (%p) = ", spBottom-(payload+i), payload+i);
454 if ((bitmap & 1) == 0) {
455 printPtr((P_)payload[i]);
456 fprintf(stderr,"\n");
458 fprintf(stderr,"Word# %d\n", payload[i]);
464 printLargeBitmap( StgPtr spBottom, StgPtr payload, StgLargeBitmap* large_bitmap, nat size )
470 for (bmp=0; i < size; bmp++) {
471 StgWord bitmap = large_bitmap->bitmap[bmp];
473 for(; i < size && j < BITS_IN(W_); j++, i++, bitmap >>= 1 ) {
474 fprintf(stderr," stk[%d] (%p) = ", spBottom-(payload+i), payload+i);
475 if ((bitmap & 1) == 0) {
476 printPtr((P_)payload[i]);
477 fprintf(stderr,"\n");
479 fprintf(stderr,"Word# %d\n", payload[i]);
486 printStackChunk( StgPtr sp, StgPtr spBottom )
489 const StgInfoTable *info;
491 ASSERT(sp <= spBottom);
492 for (; sp < spBottom; sp += stack_frame_sizeW((StgClosure *)sp)) {
494 info = get_itbl((StgClosure *)sp);
496 switch (info->type) {
501 printObj((StgClosure*)sp);
513 fprintf(stderr, "RET_DYN (%p)\n", r);
515 p = (P_)(r->payload);
516 printSmallBitmap(spBottom, sp,
517 GET_LIVENESS(r->liveness), RET_DYN_SIZE);
520 for (size = GET_NONPTRS(dyn); size > 0; size--) {
521 fprintf(stderr," stk[%ld] (%p) = ", spBottom-p, p);
522 fprintf(stderr,"Word# %ld\n", *p);
526 for (size = GET_PTRS(dyn); size > 0; size--) {
527 fprintf(stderr," stk[%ld] (%p) = ", spBottom-p, p);
536 fprintf(stderr, "RET_SMALL (%p)\n", sp);
537 bitmap = info->layout.bitmap;
538 printSmallBitmap(spBottom, sp+1,
539 BITMAP_BITS(bitmap), BITMAP_SIZE(bitmap));
545 bco = ((StgBCO *)sp[1]);
547 fprintf(stderr, "RET_BCO (%p)\n", sp);
548 printLargeBitmap(spBottom, sp+2,
549 BCO_BITMAP(bco), BCO_BITMAP_SIZE(bco));
558 barf("printStackChunk");
563 void printTSO( StgTSO *tso )
565 printStackChunk( tso->sp, tso->stack+tso->stack_size);
568 /* -----------------------------------------------------------------------------
571 NOTE: must be kept in sync with the closure types in includes/ClosureTypes.h
572 -------------------------------------------------------------------------- */
574 static char *closure_type_names[] = {
585 "CONSTR_NOCAF_STATIC",
627 "MUT_ARR_PTRS_FROZEN",
644 info_type(StgClosure *closure){
645 return closure_type_names[get_itbl(closure)->type];
649 info_type_by_ip(StgInfoTable *ip){
650 return closure_type_names[ip->type];
654 info_hdr_type(StgClosure *closure, char *res){
655 strcpy(res,closure_type_names[get_itbl(closure)->type]);
658 /* --------------------------------------------------------------------------
659 * Address printing code
661 * Uses symbol table in (unstripped executable)
662 * ------------------------------------------------------------------------*/
664 /* --------------------------------------------------------------------------
665 * Simple lookup table
667 * Current implementation is pretty dumb!
668 * ------------------------------------------------------------------------*/
675 static nat max_table_size;
676 static nat table_size;
677 static struct entry* table;
679 static void reset_table( int size )
681 max_table_size = size;
683 table = (struct entry *) malloc(size * sizeof(struct entry));
686 static void prepare_table( void )
688 /* Could sort it... */
691 static void insert( unsigned value, const char *name )
693 if ( table_size >= max_table_size ) {
694 barf( "Symbol table overflow\n" );
696 table[table_size].value = value;
697 table[table_size].name = name;
698 table_size = table_size + 1;
703 static rtsBool lookup_name( char *name, unsigned *result )
706 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
708 if (i < table_size) {
709 *result = table[i].value;
717 /* Code from somewhere inside GHC (circa 1994)
719 * "std"++xs -> "Zstd"++xs
720 * char_to_c 'Z' = "ZZ"
721 * char_to_c '&' = "Za"
722 * char_to_c '|' = "Zb"
723 * char_to_c ':' = "Zc"
724 * char_to_c '/' = "Zd"
725 * char_to_c '=' = "Ze"
726 * char_to_c '>' = "Zg"
727 * char_to_c '#' = "Zh"
728 * char_to_c '<' = "Zl"
729 * char_to_c '-' = "Zm"
730 * char_to_c '!' = "Zn"
731 * char_to_c '.' = "Zo"
732 * char_to_c '+' = "Zp"
733 * char_to_c '\'' = "Zq"
734 * char_to_c '*' = "Zt"
735 * char_to_c '_' = "Zu"
736 * char_to_c c = "Z" ++ show (ord c)
738 static char unZcode( char ch )
741 case 'a' : return ('&');
742 case 'b' : return ('|');
743 case 'c' : return (':');
744 case 'd' : return ('/');
745 case 'e' : return ('=');
746 case 'g' : return ('>');
747 case 'h' : return ('#');
748 case 'l' : return ('<');
749 case 'm' : return ('-');
750 case 'n' : return ('!');
751 case 'o' : return ('.');
752 case 'p' : return ('+');
753 case 'q' : return ('\'');
754 case 't' : return ('*');
755 case 'u' : return ('_');
757 case '\0' : return ('Z');
758 default : return (ch);
763 /* Precondition: out big enough to handle output (about twice length of in) */
764 static void enZcode( char *in, char *out )
770 for( i = 0; in[i] != '\0'; ++i ) {
845 const char *lookupGHCName( void *addr )
848 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
850 if (i < table_size) {
851 return table[i].name;
857 static void printZcoded( const char *raw )
861 while ( raw[j] != '\0' ) {
863 fputc(unZcode(raw[j+1]),stderr);
866 fputc(raw[j],stderr);
872 /* --------------------------------------------------------------------------
873 * Symbol table loading
874 * ------------------------------------------------------------------------*/
876 /* Causing linking trouble on Win32 plats, so I'm
877 disabling this for now.
883 /* Fairly ad-hoc piece of code that seems to filter out a lot of
884 * rubbish like the obj-splitting symbols
887 static rtsBool isReal( flagword flags STG_UNUSED, const char *name )
890 /* ToDo: make this work on BFD */
891 int tp = type & N_TYPE;
892 if (tp == N_TEXT || tp == N_DATA) {
893 return (name[0] == '_' && name[1] != '_');
899 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
900 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
907 extern void DEBUG_LoadSymbols( char *name )
913 abfd = bfd_openr(name, "default");
915 barf("can't open executable %s to get symbol table", name);
917 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
923 asymbol **symbol_table;
924 long number_of_symbols;
925 long num_real_syms = 0;
928 storage_needed = bfd_get_symtab_upper_bound (abfd);
930 if (storage_needed < 0) {
931 barf("can't read symbol table");
934 if (storage_needed == 0) {
935 belch("no storage needed");
938 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
940 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
942 if (number_of_symbols < 0) {
943 barf("can't canonicalise symbol table");
946 for( i = 0; i != number_of_symbols; ++i ) {
948 bfd_get_symbol_info(abfd,symbol_table[i],&info);
949 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
950 if (isReal(info.type, info.name)) {
955 IF_DEBUG(interpreter,
956 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
957 number_of_symbols, num_real_syms)
960 reset_table( num_real_syms );
962 for( i = 0; i != number_of_symbols; ++i ) {
964 bfd_get_symbol_info(abfd,symbol_table[i],&info);
965 if (isReal(info.type, info.name)) {
966 insert( info.value, info.name );
975 #else /* HAVE_BFD_H */
977 extern void DEBUG_LoadSymbols( char *name STG_UNUSED )
982 #endif /* HAVE_BFD_H */
984 #include "StoragePriv.h"
986 void findPtr(P_ p, int); /* keep gcc -Wall happy */
989 findPtr(P_ p, int follow)
994 const int arr_size = 1024;
995 StgPtr arr[arr_size];
998 for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
999 for (s = 0; s < generations[g].n_steps; s++) {
1000 if (RtsFlags.GcFlags.generations == 1) {
1001 bd = generations[g].steps[s].to_blocks;
1003 bd = generations[g].steps[s].blocks;
1005 for (; bd; bd = bd->link) {
1006 for (q = bd->start; q < bd->free; q++) {
1010 while (!LOOKS_LIKE_INFO_PTR(*r) || (P_)*r == NULL) {
1013 fprintf(stderr, "%p = ", r);
1014 printClosure((StgClosure *)r);
1024 if (follow && i == 1) {
1025 fprintf(stderr, "-->\n");
1031 void printPtr( StgPtr p )
1033 fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
1036 void printObj( StgClosure *obj )
1038 fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );