2 /* -----------------------------------------------------------------------------
3 * $Id: Printer.c,v 1.9 1999/03/09 14:51:23 sewardj 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 * ------------------------------------------------------------------------*/
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];
53 extern void printPtr( StgPtr p )
57 if (lookupGHCName( p, &raw )) {
60 } else if ((raw = lookupHugsName(p)) != 0) {
61 fprintf(stderr, "%s", raw);
63 } else if ((str = lookupHugsItblName(p)) != 0) {
64 fprintf(stderr, "%p=%s", p, str);
66 fprintf(stderr, "%p", p);
70 void printObj( StgClosure *obj )
72 fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
76 static void printStdObject( StgClosure *obj, char* tag )
79 const StgInfoTable* info = get_itbl(obj);
80 fprintf(stderr,"%s(",tag);
81 printPtr((StgPtr)obj->header.info);
82 for (i = 0; i < info->layout.payload.ptrs; ++i) {
84 printPtr(payloadPtr(obj,i));
86 for (j = 0; j < info->layout.payload.nptrs; ++j) {
87 fprintf(stderr,", %xd#",payloadWord(obj,i+j));
89 fprintf(stderr,")\n");
92 void printClosure( StgClosure *obj )
94 switch ( get_itbl(obj)->type ) {
96 barf("Invalid object");
99 fprintf(stderr,"BCO\n");
100 disassemble(stgCast(StgBCO*,obj),"\t");
106 StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
108 fprintf(stderr,"AP_UPD("); printPtr((StgPtr)ap->fun);
109 for (i = 0; i < ap->n_args; ++i) {
110 fprintf(stderr,", ");
111 printPtr(payloadPtr(ap,i));
113 fprintf(stderr,")\n");
119 StgPAP* pap = stgCast(StgPAP*,obj);
121 fprintf(stderr,"PAP("); printPtr((StgPtr)pap->fun);
122 for (i = 0; i < pap->n_args; ++i) {
123 fprintf(stderr,", ");
124 printPtr(payloadPtr(pap,i));
126 fprintf(stderr,")\n");
131 fprintf(stderr,"IND(");
132 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
133 fprintf(stderr,")\n");
137 fprintf(stderr,"IND_STATIC(");
138 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
139 fprintf(stderr,")\n");
143 fprintf(stderr,"IND_OLDGEN(");
144 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
145 fprintf(stderr,")\n");
150 StgCAF* caf = stgCast(StgCAF*,obj);
151 fprintf(stderr,"CAF_UNENTERED(");
152 printPtr((StgPtr)caf->body);
153 fprintf(stderr,", ");
154 printPtr((StgPtr)caf->value); /* should be null */
155 fprintf(stderr,", ");
156 printPtr((StgPtr)caf->link); /* should be null */
157 fprintf(stderr,")\n");
163 StgCAF* caf = stgCast(StgCAF*,obj);
164 fprintf(stderr,"CAF_ENTERED(");
165 printPtr((StgPtr)caf->body);
166 fprintf(stderr,", ");
167 printPtr((StgPtr)caf->value);
168 fprintf(stderr,", ");
169 printPtr((StgPtr)caf->link);
170 fprintf(stderr,")\n");
175 fprintf(stderr,"CAF_BH(");
176 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
177 fprintf(stderr,")\n");
181 fprintf(stderr,"BH\n");
185 fprintf(stderr,"BQ(");
186 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
187 fprintf(stderr,")\n");
191 case CONSTR_1_0: case CONSTR_0_1:
192 case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
194 case CONSTR_CHARLIKE:
196 case CONSTR_NOCAF_STATIC:
198 /* We can't use printStdObject because we want to print the
202 const StgInfoTable* info = get_itbl(obj);
203 fprintf(stderr,"PACK(");
204 printPtr((StgPtr)obj->header.info);
205 fprintf(stderr,"(tag=%d)",info->srt_len);
206 for (i = 0; i < info->layout.payload.ptrs; ++i) {
207 fprintf(stderr,", ");
208 printPtr(payloadPtr(obj,i));
210 for (j = 0; j < info->layout.payload.nptrs; ++j) {
211 fprintf(stderr,", %x#",payloadWord(obj,i+j));
213 fprintf(stderr,")\n");
218 case FUN_1_0: case FUN_0_1:
219 case FUN_1_1: case FUN_0_2: case FUN_2_0:
221 printStdObject(obj,"FUN");
225 case THUNK_1_0: case THUNK_0_1:
226 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
228 /* ToDo: will this work for THUNK_STATIC too? */
229 printStdObject(obj,"THUNK");
235 fprintf(stderr,"ARR_WORDS(\"");
236 /* ToDo: we can't safely assume that this is a string! */
237 for (i = 0; arrWordsGetChar(obj,i); ++i) {
238 putchar(arrWordsGetChar(obj,i));
240 fprintf(stderr,"\")\n");
246 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
247 fprintf(stderr,"UpdateFrame(");
248 printPtr((StgPtr)GET_INFO(u));
250 printPtr((StgPtr)u->updatee);
252 printPtr((StgPtr)u->link);
253 fprintf(stderr,")\n");
259 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
260 fprintf(stderr,"CatchFrame(");
261 printPtr((StgPtr)GET_INFO(u));
263 printPtr((StgPtr)u->handler);
265 printPtr((StgPtr)u->link);
266 fprintf(stderr,")\n");
272 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
273 fprintf(stderr,"SeqFrame(");
274 printPtr((StgPtr)GET_INFO(u));
276 printPtr((StgPtr)u->link);
277 fprintf(stderr,")\n");
283 StgStopFrame* u = stgCast(StgStopFrame*,obj);
284 fprintf(stderr,"StopFrame(");
285 printPtr((StgPtr)GET_INFO(u));
286 fprintf(stderr,")\n");
290 //barf("printClosure %d",get_itbl(obj)->type);
291 fprintf(stderr, "*** printClosure: unknown type %d ****\n",get_itbl(obj)->type );
296 StgPtr printStackObj( StgPtr sp )
298 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
300 if (IS_ARG_TAG(*sp)) {
303 StackTag tag = (StackTag)*sp;
306 barf("printStackObj: ILLEGAL_TAG");
309 fprintf(stderr,"RealWorld#\n");
312 fprintf(stderr,"Int# %d\n", *(StgInt*)(sp+1));
315 fprintf(stderr,"Int64# %lld\n", *(StgInt64*)(sp+1));
318 fprintf(stderr,"Word# %d\n", *(StgWord*)(sp+1));
321 fprintf(stderr,"Addr# "); printPtr(*(StgAddr*)(sp+1)); fprintf(stderr,"\n");
324 fprintf(stderr,"Char# %d\n", *(StgChar*)(sp+1));
327 fprintf(stderr,"Float# %f\n", PK_FLT(sp+1));
330 fprintf(stderr,"Double# %f\n", PK_DBL(sp+1));
333 barf("printStackObj: unrecognised ARGTAG %d",tag);
335 sp += 1 + ARG_SIZE(tag);
337 #else /* !DEBUG_EXTRA */
341 fprintf(stderr,"Tag: %d words\n", tag);
342 for (i = 0; i < tag; i++) {
343 fprintf(stderr,"Word# %d\n", *sp++);
349 StgClosure* c = (StgClosure*)(*sp);
350 printPtr((StgPtr)*sp);
351 if (c == &ret_bco_info) {
352 fprintf(stderr, "\t\t");
353 fprintf(stderr, "ret_bco_info\n" );
355 if (IS_HUGS_CONSTR_INFO(GET_INFO(c))) {
356 fprintf(stderr, "\t\t\t");
357 fprintf(stderr, "ConstrInfoTable\n" );
359 if (get_itbl(c)->type == BCO) {
360 fprintf(stderr, "\t\t\t");
361 fprintf(stderr, "BCO(...)\n");
364 fprintf(stderr, "\t\t\t");
365 printClosure ( (StgClosure*)(*sp));
373 void printStackChunk( StgPtr sp, StgPtr spBottom )
376 const StgInfoTable *info;
378 ASSERT(sp <= spBottom);
379 while (sp < spBottom) {
380 if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
381 info = get_itbl((StgClosure *)sp);
382 switch (info->type) {
385 printObj( stgCast(StgClosure*,sp) );
386 sp += sizeofW(StgUpdateFrame);
390 printObj( stgCast(StgClosure*,sp) );
391 sp += sizeofW(StgSeqFrame);
395 printObj( stgCast(StgClosure*,sp) );
396 sp += sizeofW(StgCatchFrame);
400 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
401 printObj( stgCast(StgClosure*,sp) );
405 fprintf(stderr, "RET_DYN (%p)\n", sp);
408 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
413 fprintf(stderr, "RET_SMALL (%p)\n", sp);
414 bitmap = info->layout.bitmap;
417 while (bitmap != 0) {
418 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
419 if ((bitmap & 1) == 0) {
421 fprintf(stderr,"\n");
423 fprintf(stderr,"Word# %d\n", *sp++);
426 bitmap = bitmap >> 1;
438 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
439 sp = printStackObj(sp);
443 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
445 /* check everything down to the first update frame */
446 printStackChunk( sp, stgCast(StgPtr,su) );
447 while ( stgCast(StgPtr,su) < spBottom) {
448 sp = stgCast(StgPtr,su);
449 switch (get_itbl(su)->type) {
451 printObj( stgCast(StgClosure*,su) );
452 sp += sizeofW(StgUpdateFrame);
456 printObj( stgCast(StgClosure*,su) );
457 sp += sizeofW(StgSeqFrame);
458 su = stgCast(StgSeqFrame*,su)->link;
461 printObj( stgCast(StgClosure*,su) );
462 sp += sizeofW(StgCatchFrame);
463 su = stgCast(StgCatchFrame*,su)->link;
466 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
467 printObj( stgCast(StgClosure*,su) );
470 barf("printStack: weird record found on update frame list.");
472 printStackChunk( sp, stgCast(StgPtr,su) );
474 ASSERT(stgCast(StgPtr,su) == spBottom);
477 void printTSO( StgTSO *tso )
479 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
480 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
484 /* --------------------------------------------------------------------------
485 * Address printing code
487 * Uses symbol table in (unstripped executable)
488 * ------------------------------------------------------------------------*/
490 /* --------------------------------------------------------------------------
491 * Simple lookup table
493 * Current implementation is pretty dumb!
494 * ------------------------------------------------------------------------*/
501 static nat max_table_size;
502 static nat table_size;
503 static struct entry* table;
505 static void reset_table( int size )
507 max_table_size = size;
509 table = (struct entry *) malloc(size * sizeof(struct entry));
512 static void prepare_table( void )
514 /* Could sort it... */
517 static void insert( unsigned value, const char *name )
519 if ( table_size >= max_table_size ) {
520 barf( "Symbol table overflow\n" );
522 table[table_size].value = value;
523 table[table_size].name = name;
524 table_size = table_size + 1;
529 static rtsBool lookup_name( char *name, unsigned *result )
532 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
534 if (i < table_size) {
535 *result = table[i].value;
543 /* Code from somewhere inside GHC (circa 1994)
545 * "std"++xs -> "Zstd"++xs
546 * char_to_c 'Z' = "ZZ"
547 * char_to_c '&' = "Za"
548 * char_to_c '|' = "Zb"
549 * char_to_c ':' = "Zc"
550 * char_to_c '/' = "Zd"
551 * char_to_c '=' = "Ze"
552 * char_to_c '>' = "Zg"
553 * char_to_c '#' = "Zh"
554 * char_to_c '<' = "Zl"
555 * char_to_c '-' = "Zm"
556 * char_to_c '!' = "Zn"
557 * char_to_c '.' = "Zo"
558 * char_to_c '+' = "Zp"
559 * char_to_c '\'' = "Zq"
560 * char_to_c '*' = "Zt"
561 * char_to_c '_' = "Zu"
562 * char_to_c c = "Z" ++ show (ord c)
564 static char unZcode( char ch )
567 case 'a' : return ('&');
568 case 'b' : return ('|');
569 case 'c' : return (':');
570 case 'd' : return ('/');
571 case 'e' : return ('=');
572 case 'g' : return ('>');
573 case 'h' : return ('#');
574 case 'l' : return ('<');
575 case 'm' : return ('-');
576 case 'n' : return ('!');
577 case 'o' : return ('.');
578 case 'p' : return ('+');
579 case 'q' : return ('\'');
580 case 't' : return ('*');
581 case 'u' : return ('_');
583 case '\0' : return ('Z');
584 default : return (ch);
589 /* Precondition: out big enough to handle output (about twice length of in) */
590 static void enZcode( char *in, char *out )
596 for( i = 0; in[i] != '\0'; ++i ) {
671 rtsBool lookupGHCName( StgPtr addr, const char **result )
674 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
676 if (i < table_size) {
677 *result = table[i].name;
684 static void printZcoded( const char *raw )
688 while ( raw[j] != '\0' ) {
690 fputc(unZcode(raw[j+1]),stderr);
693 fputc(raw[j],stderr);
699 /* --------------------------------------------------------------------------
700 * Symbol table loading
701 * ------------------------------------------------------------------------*/
707 /* Fairly ad-hoc piece of code that seems to filter out a lot of
708 * rubbish like the obj-splitting symbols
711 static rtsBool isReal( flagword flags, const char *name )
714 /* ToDo: make this work on BFD */
715 int tp = type & N_TYPE;
716 if (tp == N_TEXT || tp == N_DATA) {
717 return (name[0] == '_' && name[1] != '_');
723 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
724 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
731 extern void DEBUG_LoadSymbols( char *name )
737 abfd = bfd_openr(name, "default");
739 barf("can't open executable %s to get symbol table", name);
741 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
747 asymbol **symbol_table;
748 long number_of_symbols;
749 long num_real_syms = 0;
752 storage_needed = bfd_get_symtab_upper_bound (abfd);
754 if (storage_needed < 0) {
755 barf("can't read symbol table");
758 if (storage_needed == 0) {
759 belch("no storage needed");
762 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
764 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
766 if (number_of_symbols < 0) {
767 barf("can't canonicalise symbol table");
770 for( i = 0; i != number_of_symbols; ++i ) {
772 bfd_get_symbol_info(abfd,symbol_table[i],&info);
773 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
774 if (isReal(info.type, info.name)) {
780 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
781 number_of_symbols, num_real_syms)
784 reset_table( num_real_syms );
786 for( i = 0; i != number_of_symbols; ++i ) {
788 bfd_get_symbol_info(abfd,symbol_table[i],&info);
789 if (isReal(info.type, info.name)) {
790 insert( info.value, info.name );
799 #else /* HAVE_BFD_H */
801 extern void DEBUG_LoadSymbols( char *name )
806 #endif /* HAVE_BFD_H */