2 /* -----------------------------------------------------------------------------
3 * $Id: Printer.c,v 1.10 1999/03/15 16:30:29 simonm Exp $
5 * Copyright (c) 1994-1999.
9 * ---------------------------------------------------------------------------*/
17 #include "Bytecodes.h" /* for InstrPtr */
18 #include "Disassembler.h"
22 /* --------------------------------------------------------------------------
23 * local function decls
24 * ------------------------------------------------------------------------*/
26 static void printStdObject( StgClosure *obj, char* tag );
27 static void reset_table ( int size );
28 static void prepare_table ( void );
29 static void insert ( unsigned value, const char *name );
30 #if 0 /* unused but might be useful sometime */
31 static rtsBool lookup_name ( char *name, unsigned *result );
32 static void enZcode ( char *in, char *out );
34 static char unZcode ( char ch );
35 rtsBool lookupGHCName ( StgPtr addr, const char **result );
36 static void printZcoded ( const char *raw );
38 /* --------------------------------------------------------------------------
40 * ------------------------------------------------------------------------*/
44 extern void* itblNames[];
45 extern int nItblNames;
46 char* lookupHugsItblName ( void* v )
49 for (i = 0; i < nItblNames; i += 2)
50 if (itblNames[i] == v) return itblNames[i+1];
55 extern void printPtr( StgPtr p )
59 if (lookupGHCName( p, &raw )) {
62 } else if ((raw = lookupHugsName(p)) != 0) {
63 fprintf(stderr, "%s", raw);
64 } else if ((str = lookupHugsItblName(p)) != 0) {
65 fprintf(stderr, "%p=%s", p, str);
68 fprintf(stderr, "%p", p);
72 void printObj( StgClosure *obj )
74 fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
78 static void printStdObject( StgClosure *obj, char* tag )
81 const StgInfoTable* info = get_itbl(obj);
82 fprintf(stderr,"%s(",tag);
83 printPtr((StgPtr)obj->header.info);
84 for (i = 0; i < info->layout.payload.ptrs; ++i) {
86 printPtr(payloadPtr(obj,i));
88 for (j = 0; j < info->layout.payload.nptrs; ++j) {
89 fprintf(stderr,", %xd#",payloadWord(obj,i+j));
91 fprintf(stderr,")\n");
94 void printClosure( StgClosure *obj )
96 switch ( get_itbl(obj)->type ) {
98 barf("Invalid object");
101 fprintf(stderr,"BCO\n");
102 disassemble(stgCast(StgBCO*,obj),"\t");
108 StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
110 fprintf(stderr,"AP_UPD("); printPtr((StgPtr)ap->fun);
111 for (i = 0; i < ap->n_args; ++i) {
112 fprintf(stderr,", ");
113 printPtr(payloadPtr(ap,i));
115 fprintf(stderr,")\n");
121 StgPAP* pap = stgCast(StgPAP*,obj);
123 fprintf(stderr,"PAP("); printPtr((StgPtr)pap->fun);
124 for (i = 0; i < pap->n_args; ++i) {
125 fprintf(stderr,", ");
126 printPtr(payloadPtr(pap,i));
128 fprintf(stderr,")\n");
133 fprintf(stderr,"IND(");
134 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
135 fprintf(stderr,")\n");
139 fprintf(stderr,"IND_STATIC(");
140 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
141 fprintf(stderr,")\n");
145 fprintf(stderr,"IND_OLDGEN(");
146 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
147 fprintf(stderr,")\n");
152 StgCAF* caf = stgCast(StgCAF*,obj);
153 fprintf(stderr,"CAF_UNENTERED(");
154 printPtr((StgPtr)caf->body);
155 fprintf(stderr,", ");
156 printPtr((StgPtr)caf->value); /* should be null */
157 fprintf(stderr,", ");
158 printPtr((StgPtr)caf->link); /* should be null */
159 fprintf(stderr,")\n");
165 StgCAF* caf = stgCast(StgCAF*,obj);
166 fprintf(stderr,"CAF_ENTERED(");
167 printPtr((StgPtr)caf->body);
168 fprintf(stderr,", ");
169 printPtr((StgPtr)caf->value);
170 fprintf(stderr,", ");
171 printPtr((StgPtr)caf->link);
172 fprintf(stderr,")\n");
177 fprintf(stderr,"CAF_BH(");
178 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
179 fprintf(stderr,")\n");
183 fprintf(stderr,"BH\n");
187 fprintf(stderr,"BQ(");
188 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
189 fprintf(stderr,")\n");
193 case CONSTR_1_0: case CONSTR_0_1:
194 case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
196 case CONSTR_CHARLIKE:
198 case CONSTR_NOCAF_STATIC:
200 /* We can't use printStdObject because we want to print the
204 const StgInfoTable* info = get_itbl(obj);
205 fprintf(stderr,"PACK(");
206 printPtr((StgPtr)obj->header.info);
207 fprintf(stderr,"(tag=%d)",info->srt_len);
208 for (i = 0; i < info->layout.payload.ptrs; ++i) {
209 fprintf(stderr,", ");
210 printPtr(payloadPtr(obj,i));
212 for (j = 0; j < info->layout.payload.nptrs; ++j) {
213 fprintf(stderr,", %x#",payloadWord(obj,i+j));
215 fprintf(stderr,")\n");
220 case FUN_1_0: case FUN_0_1:
221 case FUN_1_1: case FUN_0_2: case FUN_2_0:
223 printStdObject(obj,"FUN");
227 case THUNK_1_0: case THUNK_0_1:
228 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
230 /* ToDo: will this work for THUNK_STATIC too? */
231 printStdObject(obj,"THUNK");
237 fprintf(stderr,"ARR_WORDS(\"");
238 /* ToDo: we can't safely assume that this is a string! */
239 for (i = 0; arrWordsGetChar(obj,i); ++i) {
240 putchar(arrWordsGetChar(obj,i));
242 fprintf(stderr,"\")\n");
248 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
249 fprintf(stderr,"UpdateFrame(");
250 printPtr((StgPtr)GET_INFO(u));
252 printPtr((StgPtr)u->updatee);
254 printPtr((StgPtr)u->link);
255 fprintf(stderr,")\n");
261 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
262 fprintf(stderr,"CatchFrame(");
263 printPtr((StgPtr)GET_INFO(u));
265 printPtr((StgPtr)u->handler);
267 printPtr((StgPtr)u->link);
268 fprintf(stderr,")\n");
274 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
275 fprintf(stderr,"SeqFrame(");
276 printPtr((StgPtr)GET_INFO(u));
278 printPtr((StgPtr)u->link);
279 fprintf(stderr,")\n");
285 StgStopFrame* u = stgCast(StgStopFrame*,obj);
286 fprintf(stderr,"StopFrame(");
287 printPtr((StgPtr)GET_INFO(u));
288 fprintf(stderr,")\n");
292 //barf("printClosure %d",get_itbl(obj)->type);
293 fprintf(stderr, "*** printClosure: unknown type %d ****\n",get_itbl(obj)->type );
298 StgPtr printStackObj( StgPtr sp )
300 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
302 if (IS_ARG_TAG(*sp)) {
305 StackTag tag = (StackTag)*sp;
308 barf("printStackObj: ILLEGAL_TAG");
311 fprintf(stderr,"RealWorld#\n");
314 fprintf(stderr,"Int# %d\n", *(StgInt*)(sp+1));
317 fprintf(stderr,"Int64# %lld\n", *(StgInt64*)(sp+1));
320 fprintf(stderr,"Word# %d\n", *(StgWord*)(sp+1));
323 fprintf(stderr,"Addr# "); printPtr(*(StgAddr*)(sp+1)); fprintf(stderr,"\n");
326 fprintf(stderr,"Char# %d\n", *(StgChar*)(sp+1));
329 fprintf(stderr,"Float# %f\n", PK_FLT(sp+1));
332 fprintf(stderr,"Double# %f\n", PK_DBL(sp+1));
335 barf("printStackObj: unrecognised ARGTAG %d",tag);
337 sp += 1 + ARG_SIZE(tag);
339 #else /* !DEBUG_EXTRA */
343 fprintf(stderr,"Tag: %d words\n", tag);
344 for (i = 0; i < tag; i++) {
345 fprintf(stderr,"Word# %d\n", *sp++);
351 StgClosure* c = (StgClosure*)(*sp);
352 printPtr((StgPtr)*sp);
354 if (c == &ret_bco_info) {
355 fprintf(stderr, "\t\t");
356 fprintf(stderr, "ret_bco_info\n" );
358 if (IS_HUGS_CONSTR_INFO(GET_INFO(c))) {
359 fprintf(stderr, "\t\t\t");
360 fprintf(stderr, "ConstrInfoTable\n" );
363 if (get_itbl(c)->type == BCO) {
364 fprintf(stderr, "\t\t\t");
365 fprintf(stderr, "BCO(...)\n");
368 fprintf(stderr, "\t\t\t");
369 printClosure ( (StgClosure*)(*sp));
377 void printStackChunk( StgPtr sp, StgPtr spBottom )
380 const StgInfoTable *info;
382 ASSERT(sp <= spBottom);
383 while (sp < spBottom) {
384 if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
385 info = get_itbl((StgClosure *)sp);
386 switch (info->type) {
389 printObj( stgCast(StgClosure*,sp) );
390 sp += sizeofW(StgUpdateFrame);
394 printObj( stgCast(StgClosure*,sp) );
395 sp += sizeofW(StgSeqFrame);
399 printObj( stgCast(StgClosure*,sp) );
400 sp += sizeofW(StgCatchFrame);
404 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
405 printObj( stgCast(StgClosure*,sp) );
409 fprintf(stderr, "RET_DYN (%p)\n", sp);
412 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
417 fprintf(stderr, "RET_SMALL (%p)\n", sp);
418 bitmap = info->layout.bitmap;
421 while (bitmap != 0) {
422 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
423 if ((bitmap & 1) == 0) {
425 fprintf(stderr,"\n");
427 fprintf(stderr,"Word# %d\n", *sp++);
430 bitmap = bitmap >> 1;
442 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
443 sp = printStackObj(sp);
447 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
449 /* check everything down to the first update frame */
450 printStackChunk( sp, stgCast(StgPtr,su) );
451 while ( stgCast(StgPtr,su) < spBottom) {
452 sp = stgCast(StgPtr,su);
453 switch (get_itbl(su)->type) {
455 printObj( stgCast(StgClosure*,su) );
456 sp += sizeofW(StgUpdateFrame);
460 printObj( stgCast(StgClosure*,su) );
461 sp += sizeofW(StgSeqFrame);
462 su = stgCast(StgSeqFrame*,su)->link;
465 printObj( stgCast(StgClosure*,su) );
466 sp += sizeofW(StgCatchFrame);
467 su = stgCast(StgCatchFrame*,su)->link;
470 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
471 printObj( stgCast(StgClosure*,su) );
474 barf("printStack: weird record found on update frame list.");
476 printStackChunk( sp, stgCast(StgPtr,su) );
478 ASSERT(stgCast(StgPtr,su) == spBottom);
481 void printTSO( StgTSO *tso )
483 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
484 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
488 /* --------------------------------------------------------------------------
489 * Address printing code
491 * Uses symbol table in (unstripped executable)
492 * ------------------------------------------------------------------------*/
494 /* --------------------------------------------------------------------------
495 * Simple lookup table
497 * Current implementation is pretty dumb!
498 * ------------------------------------------------------------------------*/
505 static nat max_table_size;
506 static nat table_size;
507 static struct entry* table;
509 static void reset_table( int size )
511 max_table_size = size;
513 table = (struct entry *) malloc(size * sizeof(struct entry));
516 static void prepare_table( void )
518 /* Could sort it... */
521 static void insert( unsigned value, const char *name )
523 if ( table_size >= max_table_size ) {
524 barf( "Symbol table overflow\n" );
526 table[table_size].value = value;
527 table[table_size].name = name;
528 table_size = table_size + 1;
533 static rtsBool lookup_name( char *name, unsigned *result )
536 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
538 if (i < table_size) {
539 *result = table[i].value;
547 /* Code from somewhere inside GHC (circa 1994)
549 * "std"++xs -> "Zstd"++xs
550 * char_to_c 'Z' = "ZZ"
551 * char_to_c '&' = "Za"
552 * char_to_c '|' = "Zb"
553 * char_to_c ':' = "Zc"
554 * char_to_c '/' = "Zd"
555 * char_to_c '=' = "Ze"
556 * char_to_c '>' = "Zg"
557 * char_to_c '#' = "Zh"
558 * char_to_c '<' = "Zl"
559 * char_to_c '-' = "Zm"
560 * char_to_c '!' = "Zn"
561 * char_to_c '.' = "Zo"
562 * char_to_c '+' = "Zp"
563 * char_to_c '\'' = "Zq"
564 * char_to_c '*' = "Zt"
565 * char_to_c '_' = "Zu"
566 * char_to_c c = "Z" ++ show (ord c)
568 static char unZcode( char ch )
571 case 'a' : return ('&');
572 case 'b' : return ('|');
573 case 'c' : return (':');
574 case 'd' : return ('/');
575 case 'e' : return ('=');
576 case 'g' : return ('>');
577 case 'h' : return ('#');
578 case 'l' : return ('<');
579 case 'm' : return ('-');
580 case 'n' : return ('!');
581 case 'o' : return ('.');
582 case 'p' : return ('+');
583 case 'q' : return ('\'');
584 case 't' : return ('*');
585 case 'u' : return ('_');
587 case '\0' : return ('Z');
588 default : return (ch);
593 /* Precondition: out big enough to handle output (about twice length of in) */
594 static void enZcode( char *in, char *out )
600 for( i = 0; in[i] != '\0'; ++i ) {
675 rtsBool lookupGHCName( StgPtr addr, const char **result )
678 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
680 if (i < table_size) {
681 *result = table[i].name;
688 static void printZcoded( const char *raw )
692 while ( raw[j] != '\0' ) {
694 fputc(unZcode(raw[j+1]),stderr);
697 fputc(raw[j],stderr);
703 /* --------------------------------------------------------------------------
704 * Symbol table loading
705 * ------------------------------------------------------------------------*/
711 /* Fairly ad-hoc piece of code that seems to filter out a lot of
712 * rubbish like the obj-splitting symbols
715 static rtsBool isReal( flagword flags, const char *name )
718 /* ToDo: make this work on BFD */
719 int tp = type & N_TYPE;
720 if (tp == N_TEXT || tp == N_DATA) {
721 return (name[0] == '_' && name[1] != '_');
727 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
728 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
735 extern void DEBUG_LoadSymbols( char *name )
741 abfd = bfd_openr(name, "default");
743 barf("can't open executable %s to get symbol table", name);
745 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
751 asymbol **symbol_table;
752 long number_of_symbols;
753 long num_real_syms = 0;
756 storage_needed = bfd_get_symtab_upper_bound (abfd);
758 if (storage_needed < 0) {
759 barf("can't read symbol table");
762 if (storage_needed == 0) {
763 belch("no storage needed");
766 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
768 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
770 if (number_of_symbols < 0) {
771 barf("can't canonicalise symbol table");
774 for( i = 0; i != number_of_symbols; ++i ) {
776 bfd_get_symbol_info(abfd,symbol_table[i],&info);
777 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
778 if (isReal(info.type, info.name)) {
784 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
785 number_of_symbols, num_real_syms)
788 reset_table( num_real_syms );
790 for( i = 0; i != number_of_symbols; ++i ) {
792 bfd_get_symbol_info(abfd,symbol_table[i],&info);
793 if (isReal(info.type, info.name)) {
794 insert( info.value, info.name );
803 #else /* HAVE_BFD_H */
805 extern void DEBUG_LoadSymbols( char *name )
810 #endif /* HAVE_BFD_H */