2 /* -----------------------------------------------------------------------------
3 * $Id: Printer.c,v 1.15 1999/07/14 13:44:19 simonmar Exp $
5 * Copyright (c) 1994-1999.
9 * ---------------------------------------------------------------------------*/
18 #include "Bytecodes.h" /* for InstrPtr */
19 #include "Disassembler.h"
21 /* --------------------------------------------------------------------------
22 * local function decls
23 * ------------------------------------------------------------------------*/
25 static void printStdObject( StgClosure *obj, char* tag );
26 static void reset_table ( int size );
27 static void prepare_table ( void );
28 static void insert ( unsigned value, const char *name );
29 #if 0 /* unused but might be useful sometime */
30 static rtsBool lookup_name ( char *name, unsigned *result );
31 static void enZcode ( char *in, char *out );
33 static char unZcode ( char ch );
34 rtsBool lookupGHCName ( StgPtr addr, const char **result );
35 static void printZcoded ( const char *raw );
37 /* --------------------------------------------------------------------------
39 * ------------------------------------------------------------------------*/
43 extern void* itblNames[];
44 extern int nItblNames;
45 char* lookupHugsItblName ( void* v )
48 for (i = 0; i < nItblNames; i += 2)
49 if (itblNames[i] == v) return itblNames[i+1];
54 void printPtr( StgPtr p )
60 if (lookupGHCName( p, &raw )) {
63 } else if ((raw = lookupHugsName(p)) != 0) {
64 fprintf(stderr, "%s", raw);
65 } else if ((str = lookupHugsItblName(p)) != 0) {
66 fprintf(stderr, "%p=%s", p, str);
69 fprintf(stderr, "%p", p);
73 void printObj( StgClosure *obj )
75 fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
79 static void printStdObject( StgClosure *obj, char* tag )
82 const StgInfoTable* info = get_itbl(obj);
83 fprintf(stderr,"%s(",tag);
84 printPtr((StgPtr)obj->header.info);
85 for (i = 0; i < info->layout.payload.ptrs; ++i) {
87 printPtr(payloadPtr(obj,i));
89 for (j = 0; j < info->layout.payload.nptrs; ++j) {
90 fprintf(stderr,", %xd#",payloadWord(obj,i+j));
92 fprintf(stderr,")\n");
95 void printClosure( StgClosure *obj )
97 switch ( get_itbl(obj)->type ) {
99 barf("Invalid object");
102 fprintf(stderr,"BCO\n");
103 disassemble(stgCast(StgBCO*,obj),"\t");
109 StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
111 fprintf(stderr,"AP_UPD("); printPtr((StgPtr)ap->fun);
112 for (i = 0; i < ap->n_args; ++i) {
113 fprintf(stderr,", ");
114 printPtr(payloadPtr(ap,i));
116 fprintf(stderr,")\n");
122 StgPAP* pap = stgCast(StgPAP*,obj);
124 fprintf(stderr,"PAP("); printPtr((StgPtr)pap->fun);
125 for (i = 0; i < pap->n_args; ++i) {
126 fprintf(stderr,", ");
127 printPtr(payloadPtr(pap,i));
129 fprintf(stderr,")\n");
134 fprintf(stderr,"IND(");
135 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
136 fprintf(stderr,")\n");
140 fprintf(stderr,"IND_STATIC(");
141 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
142 fprintf(stderr,")\n");
146 fprintf(stderr,"IND_OLDGEN(");
147 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
148 fprintf(stderr,")\n");
153 StgCAF* caf = stgCast(StgCAF*,obj);
154 fprintf(stderr,"CAF_UNENTERED(");
155 printPtr((StgPtr)caf->body);
156 fprintf(stderr,", ");
157 printPtr((StgPtr)caf->value); /* should be null */
158 fprintf(stderr,", ");
159 printPtr((StgPtr)caf->link); /* should be null */
160 fprintf(stderr,")\n");
166 StgCAF* caf = stgCast(StgCAF*,obj);
167 fprintf(stderr,"CAF_ENTERED(");
168 printPtr((StgPtr)caf->body);
169 fprintf(stderr,", ");
170 printPtr((StgPtr)caf->value);
171 fprintf(stderr,", ");
172 printPtr((StgPtr)caf->link);
173 fprintf(stderr,")\n");
178 fprintf(stderr,"CAF_BH(");
179 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
180 fprintf(stderr,")\n");
184 fprintf(stderr,"SE_BH\n");
187 case SE_CAF_BLACKHOLE:
188 fprintf(stderr,"SE_CAF_BH\n");
192 fprintf(stderr,"BH\n");
196 fprintf(stderr,"BQ(");
197 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
198 fprintf(stderr,")\n");
202 case CONSTR_1_0: case CONSTR_0_1:
203 case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
205 case CONSTR_CHARLIKE:
207 case CONSTR_NOCAF_STATIC:
209 /* We can't use printStdObject because we want to print the
213 const StgInfoTable* info = get_itbl(obj);
214 fprintf(stderr,"PACK(");
215 printPtr((StgPtr)obj->header.info);
216 fprintf(stderr,"(tag=%d)",info->srt_len);
217 for (i = 0; i < info->layout.payload.ptrs; ++i) {
218 fprintf(stderr,", ");
219 printPtr(payloadPtr(obj,i));
221 for (j = 0; j < info->layout.payload.nptrs; ++j) {
222 fprintf(stderr,", %x#",payloadWord(obj,i+j));
224 fprintf(stderr,")\n");
229 case FUN_1_0: case FUN_0_1:
230 case FUN_1_1: case FUN_0_2: case FUN_2_0:
232 printStdObject(obj,"FUN");
236 case THUNK_1_0: case THUNK_0_1:
237 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
239 /* ToDo: will this work for THUNK_STATIC too? */
240 printStdObject(obj,"THUNK");
246 fprintf(stderr,"ARR_WORDS(\"");
247 /* ToDo: we can't safely assume that this is a string! */
248 for (i = 0; arrWordsGetChar(obj,i); ++i) {
249 putchar(arrWordsGetChar(obj,i));
251 fprintf(stderr,"\")\n");
257 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
258 fprintf(stderr,"UpdateFrame(");
259 printPtr((StgPtr)GET_INFO(u));
261 printPtr((StgPtr)u->updatee);
263 printPtr((StgPtr)u->link);
264 fprintf(stderr,")\n");
270 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
271 fprintf(stderr,"CatchFrame(");
272 printPtr((StgPtr)GET_INFO(u));
274 printPtr((StgPtr)u->handler);
276 printPtr((StgPtr)u->link);
277 fprintf(stderr,")\n");
283 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
284 fprintf(stderr,"SeqFrame(");
285 printPtr((StgPtr)GET_INFO(u));
287 printPtr((StgPtr)u->link);
288 fprintf(stderr,")\n");
294 StgStopFrame* u = stgCast(StgStopFrame*,obj);
295 fprintf(stderr,"StopFrame(");
296 printPtr((StgPtr)GET_INFO(u));
297 fprintf(stderr,")\n");
301 //barf("printClosure %d",get_itbl(obj)->type);
302 fprintf(stderr, "*** printClosure: unknown type %d ****\n",get_itbl(obj)->type );
307 StgPtr printStackObj( StgPtr sp )
309 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
311 if (IS_ARG_TAG(*sp)) {
314 StackTag tag = (StackTag)*sp;
317 barf("printStackObj: ILLEGAL_TAG");
320 fprintf(stderr,"RealWorld#\n");
323 fprintf(stderr,"Int# %d\n", *(StgInt*)(sp+1));
326 fprintf(stderr,"Int64# %lld\n", *(StgInt64*)(sp+1));
329 fprintf(stderr,"Word# %d\n", *(StgWord*)(sp+1));
332 fprintf(stderr,"Addr# "); printPtr(*(StgAddr*)(sp+1)); fprintf(stderr,"\n");
335 fprintf(stderr,"Char# %d\n", *(StgChar*)(sp+1));
338 fprintf(stderr,"Float# %f\n", PK_FLT(sp+1));
341 fprintf(stderr,"Double# %f\n", PK_DBL(sp+1));
344 barf("printStackObj: unrecognised ARGTAG %d",tag);
346 sp += 1 + ARG_SIZE(tag);
348 #else /* !DEBUG_EXTRA */
352 fprintf(stderr,"Tag: %d words\n", tag);
353 for (i = 0; i < tag; i++) {
354 fprintf(stderr,"Word# %d\n", *sp++);
360 StgClosure* c = (StgClosure*)(*sp);
361 printPtr((StgPtr)*sp);
363 if (c == &ret_bco_info) {
364 fprintf(stderr, "\t\t");
365 fprintf(stderr, "ret_bco_info\n" );
367 if (IS_HUGS_CONSTR_INFO(GET_INFO(c))) {
368 fprintf(stderr, "\t\t\t");
369 fprintf(stderr, "ConstrInfoTable\n" );
372 if (get_itbl(c)->type == BCO) {
373 fprintf(stderr, "\t\t\t");
374 fprintf(stderr, "BCO(...)\n");
377 fprintf(stderr, "\t\t\t");
378 printClosure ( (StgClosure*)(*sp));
386 void printStackChunk( StgPtr sp, StgPtr spBottom )
389 const StgInfoTable *info;
391 ASSERT(sp <= spBottom);
392 while (sp < spBottom) {
393 if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
394 info = get_itbl((StgClosure *)sp);
395 switch (info->type) {
398 printObj( stgCast(StgClosure*,sp) );
399 sp += sizeofW(StgUpdateFrame);
403 printObj( stgCast(StgClosure*,sp) );
404 sp += sizeofW(StgSeqFrame);
408 printObj( stgCast(StgClosure*,sp) );
409 sp += sizeofW(StgCatchFrame);
413 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
414 printObj( stgCast(StgClosure*,sp) );
418 fprintf(stderr, "RET_DYN (%p)\n", sp);
421 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
426 fprintf(stderr, "RET_SMALL (%p)\n", sp);
427 bitmap = info->layout.bitmap;
430 while (bitmap != 0) {
431 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
432 if ((bitmap & 1) == 0) {
434 fprintf(stderr,"\n");
436 fprintf(stderr,"Word# %d\n", *sp++);
439 bitmap = bitmap >> 1;
451 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
452 sp = printStackObj(sp);
456 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
458 /* check everything down to the first update frame */
459 printStackChunk( sp, stgCast(StgPtr,su) );
460 while ( stgCast(StgPtr,su) < spBottom) {
461 sp = stgCast(StgPtr,su);
462 switch (get_itbl(su)->type) {
464 printObj( stgCast(StgClosure*,su) );
465 sp += sizeofW(StgUpdateFrame);
469 printObj( stgCast(StgClosure*,su) );
470 sp += sizeofW(StgSeqFrame);
471 su = stgCast(StgSeqFrame*,su)->link;
474 printObj( stgCast(StgClosure*,su) );
475 sp += sizeofW(StgCatchFrame);
476 su = stgCast(StgCatchFrame*,su)->link;
479 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
480 printObj( stgCast(StgClosure*,su) );
483 barf("printStack: weird record found on update frame list.");
485 printStackChunk( sp, stgCast(StgPtr,su) );
487 ASSERT(stgCast(StgPtr,su) == spBottom);
490 void printTSO( StgTSO *tso )
492 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
493 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
497 /* --------------------------------------------------------------------------
498 * Address printing code
500 * Uses symbol table in (unstripped executable)
501 * ------------------------------------------------------------------------*/
503 /* --------------------------------------------------------------------------
504 * Simple lookup table
506 * Current implementation is pretty dumb!
507 * ------------------------------------------------------------------------*/
514 static nat max_table_size;
515 static nat table_size;
516 static struct entry* table;
518 static void reset_table( int size )
520 max_table_size = size;
522 table = (struct entry *) malloc(size * sizeof(struct entry));
525 static void prepare_table( void )
527 /* Could sort it... */
530 static void insert( unsigned value, const char *name )
532 if ( table_size >= max_table_size ) {
533 barf( "Symbol table overflow\n" );
535 table[table_size].value = value;
536 table[table_size].name = name;
537 table_size = table_size + 1;
542 static rtsBool lookup_name( char *name, unsigned *result )
545 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
547 if (i < table_size) {
548 *result = table[i].value;
556 /* Code from somewhere inside GHC (circa 1994)
558 * "std"++xs -> "Zstd"++xs
559 * char_to_c 'Z' = "ZZ"
560 * char_to_c '&' = "Za"
561 * char_to_c '|' = "Zb"
562 * char_to_c ':' = "Zc"
563 * char_to_c '/' = "Zd"
564 * char_to_c '=' = "Ze"
565 * char_to_c '>' = "Zg"
566 * char_to_c '#' = "Zh"
567 * char_to_c '<' = "Zl"
568 * char_to_c '-' = "Zm"
569 * char_to_c '!' = "Zn"
570 * char_to_c '.' = "Zo"
571 * char_to_c '+' = "Zp"
572 * char_to_c '\'' = "Zq"
573 * char_to_c '*' = "Zt"
574 * char_to_c '_' = "Zu"
575 * char_to_c c = "Z" ++ show (ord c)
577 static char unZcode( char ch )
580 case 'a' : return ('&');
581 case 'b' : return ('|');
582 case 'c' : return (':');
583 case 'd' : return ('/');
584 case 'e' : return ('=');
585 case 'g' : return ('>');
586 case 'h' : return ('#');
587 case 'l' : return ('<');
588 case 'm' : return ('-');
589 case 'n' : return ('!');
590 case 'o' : return ('.');
591 case 'p' : return ('+');
592 case 'q' : return ('\'');
593 case 't' : return ('*');
594 case 'u' : return ('_');
596 case '\0' : return ('Z');
597 default : return (ch);
602 /* Precondition: out big enough to handle output (about twice length of in) */
603 static void enZcode( char *in, char *out )
609 for( i = 0; in[i] != '\0'; ++i ) {
684 rtsBool lookupGHCName( StgPtr addr, const char **result )
687 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
689 if (i < table_size) {
690 *result = table[i].name;
697 static void printZcoded( const char *raw )
701 while ( raw[j] != '\0' ) {
703 fputc(unZcode(raw[j+1]),stderr);
706 fputc(raw[j],stderr);
712 /* --------------------------------------------------------------------------
713 * Symbol table loading
714 * ------------------------------------------------------------------------*/
716 /* Causing linking trouble on Win32 plats, so I'm
717 disabling this for now.
719 #if defined(HAVE_BFD_H) && !defined(_WIN32)
723 /* Fairly ad-hoc piece of code that seems to filter out a lot of
724 * rubbish like the obj-splitting symbols
727 static rtsBool isReal( flagword flags, const char *name )
730 /* ToDo: make this work on BFD */
731 int tp = type & N_TYPE;
732 if (tp == N_TEXT || tp == N_DATA) {
733 return (name[0] == '_' && name[1] != '_');
738 (void)flags; /* keep gcc -Wall happy */
740 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
741 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
748 extern void DEBUG_LoadSymbols( char *name )
754 abfd = bfd_openr(name, "default");
756 barf("can't open executable %s to get symbol table", name);
758 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
764 asymbol **symbol_table;
765 long number_of_symbols;
766 long num_real_syms = 0;
769 storage_needed = bfd_get_symtab_upper_bound (abfd);
771 if (storage_needed < 0) {
772 barf("can't read symbol table");
775 if (storage_needed == 0) {
776 belch("no storage needed");
779 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
781 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
783 if (number_of_symbols < 0) {
784 barf("can't canonicalise symbol table");
787 for( i = 0; i != number_of_symbols; ++i ) {
789 bfd_get_symbol_info(abfd,symbol_table[i],&info);
790 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
791 if (isReal(info.type, info.name)) {
797 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
798 number_of_symbols, num_real_syms)
801 reset_table( num_real_syms );
803 for( i = 0; i != number_of_symbols; ++i ) {
805 bfd_get_symbol_info(abfd,symbol_table[i],&info);
806 if (isReal(info.type, info.name)) {
807 insert( info.value, info.name );
816 #else /* HAVE_BFD_H */
818 extern void DEBUG_LoadSymbols( char *name )
823 #endif /* HAVE_BFD_H */
825 #include "StoragePriv.h"
834 for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
835 for (s = 0; s < generations[g].n_steps; s++) {
836 for (bd = generations[g].steps[s].blocks; bd; bd = bd->link) {
837 for (q = bd->start; q < bd->free; q++) {
848 void printPtr( StgPtr p )
850 fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
853 void printObj( StgClosure *obj )
855 fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );