1 /* -*- mode: hugs-c; -*- */
2 /* -----------------------------------------------------------------------------
3 * $Id: Printer.c,v 1.2 1998/12/02 13:28:33 simonm Exp $
5 * Copyright (c) 1994-1998.
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 * ------------------------------------------------------------------------*/
42 extern void printPtr( StgPtr p )
45 if (lookupGHCName( p, &raw )) {
48 } else if ((raw = lookupHugsName(p)) != 0) {
49 fprintf(stderr, "%s", raw);
52 fprintf(stderr, "%p", p);
56 void printObj( StgClosure *obj )
58 fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
62 static void printStdObject( StgClosure *obj, char* tag )
65 const StgInfoTable* info = get_itbl(obj);
66 fprintf(stderr,"%s(",tag);
67 printPtr((StgPtr)info);
68 for (i = 0; i < info->layout.payload.ptrs; ++i) {
70 printPtr(payloadPtr(obj,i));
72 for (j = 0; j < info->layout.payload.nptrs; ++j) {
73 fprintf(stderr,", %xd#",payloadWord(obj,i+j));
75 fprintf(stderr,")\n");
78 void printClosure( StgClosure *obj )
80 switch ( get_itbl(obj)->type ) {
82 barf("Invalid object");
85 fprintf(stderr,"BCO\n");
86 disassemble(stgCast(StgBCO*,obj),"\t");
91 StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
93 fprintf(stderr,"AP_UPD("); printPtr((StgPtr)ap->fun);
94 for (i = 0; i < ap->n_args; ++i) {
96 printPtr(payloadPtr(ap,i));
98 fprintf(stderr,")\n");
103 StgPAP* pap = stgCast(StgPAP*,obj);
105 fprintf(stderr,"AP_NUPD("); printPtr((StgPtr)pap->fun);
106 for (i = 0; i < pap->n_args; ++i) {
107 fprintf(stderr,", ");
108 printPtr(payloadPtr(pap,i));
110 fprintf(stderr,")\n");
114 fprintf(stderr,"IND(");
115 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
116 fprintf(stderr,")\n");
120 StgCAF* caf = stgCast(StgCAF*,obj);
121 fprintf(stderr,"CAF_UNENTERED(");
122 printPtr((StgPtr)caf->body);
123 fprintf(stderr,", ");
124 printPtr((StgPtr)caf->value); /* should be null */
125 fprintf(stderr,", ");
126 printPtr((StgPtr)caf->link); /* should be null */
127 fprintf(stderr,")\n");
132 StgCAF* caf = stgCast(StgCAF*,obj);
133 fprintf(stderr,"CAF_ENTERED(");
134 printPtr((StgPtr)caf->body);
135 fprintf(stderr,", ");
136 printPtr((StgPtr)caf->value);
137 fprintf(stderr,", ");
138 printPtr((StgPtr)caf->link);
139 fprintf(stderr,")\n");
143 fprintf(stderr,"CAF_BH(");
144 printPtr((StgPtr)stgCast(StgBlackHole*,obj)->blocking_queue);
145 fprintf(stderr,")\n");
148 fprintf(stderr,"BH(");
149 printPtr((StgPtr)stgCast(StgBlackHole*,obj)->blocking_queue);
150 fprintf(stderr,")\n");
154 case CONSTR_CHARLIKE:
156 case CONSTR_NOCAF_STATIC:
158 /* We can't use printStdObject because we want to print the
162 const StgInfoTable* info = get_itbl(obj);
163 fprintf(stderr,"PACK(");
164 printPtr((StgPtr)info);
165 fprintf(stderr,"(tag=%d)",info->srt_len);
166 for (i = 0; i < info->layout.payload.ptrs; ++i) {
167 fprintf(stderr,", ");
168 printPtr(payloadPtr(obj,i));
170 for (j = 0; j < info->layout.payload.nptrs; ++j) {
171 fprintf(stderr,", %x#",payloadWord(obj,i+j));
173 fprintf(stderr,")\n");
178 printStdObject(obj,"FUN");
182 /* ToDo: will this work for THUNK_STATIC too? */
183 printStdObject(obj,"THUNK");
189 fprintf(stderr,"ARR_WORDS(\"");
190 /* ToDo: we can't safely assume that this is a string! */
191 for (i = 0; arrWordsGetChar(obj,i); ++i) {
192 putchar(arrWordsGetChar(obj,i));
194 fprintf(stderr,"\")\n");
200 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
201 fprintf(stderr,"UpdateFrame(");
202 printPtr((StgPtr)GET_INFO(u));
204 printPtr((StgPtr)u->updatee);
206 printPtr((StgPtr)u->link);
207 fprintf(stderr,")\n");
212 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
213 fprintf(stderr,"CatchFrame(");
214 printPtr((StgPtr)GET_INFO(u));
216 printPtr((StgPtr)u->handler);
218 printPtr((StgPtr)u->link);
219 fprintf(stderr,")\n");
224 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
225 fprintf(stderr,"SeqFrame(");
226 printPtr((StgPtr)GET_INFO(u));
228 printPtr((StgPtr)u->link);
229 fprintf(stderr,")\n");
234 StgStopFrame* u = stgCast(StgStopFrame*,obj);
235 fprintf(stderr,"StopFrame(");
236 printPtr((StgPtr)GET_INFO(u));
237 fprintf(stderr,")\n");
241 barf("printClosure %d",get_itbl(obj)->type);
246 StgPtr printStackObj( StgPtr sp )
248 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
250 if (IS_ARG_TAG(*sp)) {
253 StackTag tag = (StackTag)*sp;
256 barf("printStackObj: ILLEGAL_TAG");
259 fprintf(stderr,"RealWorld#\n");
262 fprintf(stderr,"Int# %d\n", *(StgInt*)(sp+1));
265 fprintf(stderr,"Int64# %lld\n", *(StgInt64*)(sp+1));
268 fprintf(stderr,"Word# %d\n", *(StgWord*)(sp+1));
271 fprintf(stderr,"Addr# "); printPtr(*(StgAddr*)(sp+1)); fprintf(stderr,"\n");
274 fprintf(stderr,"Char# %d\n", *(StgChar*)(sp+1));
277 fprintf(stderr,"Float# %f\n", PK_FLT(sp+1));
280 fprintf(stderr,"Double# %f\n", PK_DBL(sp+1));
283 barf("printStackObj: unrecognised ARGTAG %d",tag);
285 sp += 1 + ARG_SIZE(tag);
287 #else /* !DEBUG_EXTRA */
291 fprintf(stderr,"Tag: %d words\n", tag);
292 for (i = 0; i < tag; i++) {
293 fprintf(stderr,"Word# %d\n", *sp++);
299 printPtr((StgPtr)*sp);
300 fprintf(stderr,"\n");
307 void printStackChunk( StgPtr sp, StgPtr spBottom )
310 const StgInfoTable *info;
312 ASSERT(sp <= spBottom);
313 while (sp < spBottom) {
314 if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
315 info = get_itbl((StgClosure *)sp);
316 switch (info->type) {
319 printObj( stgCast(StgClosure*,sp) );
320 sp += sizeofW(StgUpdateFrame);
324 printObj( stgCast(StgClosure*,sp) );
325 sp += sizeofW(StgSeqFrame);
329 printObj( stgCast(StgClosure*,sp) );
330 sp += sizeofW(StgCatchFrame);
334 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
335 printObj( stgCast(StgClosure*,sp) );
339 fprintf(stderr, "RET_DYN (%p)\n", sp);
342 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
347 fprintf(stderr, "RET_SMALL (%p)\n", sp);
348 bitmap = info->layout.bitmap;
351 while (bitmap != 0) {
352 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
353 if ((bitmap & 1) == 0) {
355 fprintf(stderr,"\n");
357 fprintf(stderr,"Word# %d\n", *sp++);
360 bitmap = bitmap >> 1;
372 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
373 sp = printStackObj(sp);
377 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
379 /* check everything down to the first update frame */
380 printStackChunk( sp, stgCast(StgPtr,su) );
381 while ( stgCast(StgPtr,su) < spBottom) {
382 sp = stgCast(StgPtr,su);
383 switch (get_itbl(su)->type) {
385 printObj( stgCast(StgClosure*,su) );
386 sp += sizeofW(StgUpdateFrame);
390 printObj( stgCast(StgClosure*,su) );
391 sp += sizeofW(StgSeqFrame);
392 su = stgCast(StgSeqFrame*,su)->link;
395 printObj( stgCast(StgClosure*,su) );
396 sp += sizeofW(StgCatchFrame);
397 su = stgCast(StgCatchFrame*,su)->link;
400 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
401 printObj( stgCast(StgClosure*,su) );
404 barf("printStack: weird record found on update frame list.");
406 printStackChunk( sp, stgCast(StgPtr,su) );
408 ASSERT(stgCast(StgPtr,su) == spBottom);
411 void printTSO( StgTSO *tso )
413 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
414 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
418 /* --------------------------------------------------------------------------
419 * Address printing code
421 * Uses symbol table in (unstripped executable)
422 * ------------------------------------------------------------------------*/
424 /* --------------------------------------------------------------------------
425 * Simple lookup table
427 * Current implementation is pretty dumb!
428 * ------------------------------------------------------------------------*/
435 static nat max_table_size;
436 static nat table_size;
437 static struct entry* table;
439 static void reset_table( int size )
441 max_table_size = size;
443 table = (struct entry *) malloc(size * sizeof(struct entry));
446 static void prepare_table( void )
448 /* Could sort it... */
451 static void insert( unsigned value, const char *name )
453 if ( table_size >= max_table_size ) {
454 barf( "Symbol table overflow\n" );
456 table[table_size].value = value;
457 table[table_size].name = name;
458 table_size = table_size + 1;
463 static rtsBool lookup_name( char *name, unsigned *result )
466 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
468 if (i < table_size) {
469 *result = table[i].value;
477 /* Code from somewhere inside GHC (circa 1994)
479 * "std"++xs -> "Zstd"++xs
480 * char_to_c 'Z' = "ZZ"
481 * char_to_c '&' = "Za"
482 * char_to_c '|' = "Zb"
483 * char_to_c ':' = "Zc"
484 * char_to_c '/' = "Zd"
485 * char_to_c '=' = "Ze"
486 * char_to_c '>' = "Zg"
487 * char_to_c '#' = "Zh"
488 * char_to_c '<' = "Zl"
489 * char_to_c '-' = "Zm"
490 * char_to_c '!' = "Zn"
491 * char_to_c '.' = "Zo"
492 * char_to_c '+' = "Zp"
493 * char_to_c '\'' = "Zq"
494 * char_to_c '*' = "Zt"
495 * char_to_c '_' = "Zu"
496 * char_to_c c = "Z" ++ show (ord c)
498 static char unZcode( char ch )
501 case 'a' : return ('&');
502 case 'b' : return ('|');
503 case 'c' : return (':');
504 case 'd' : return ('/');
505 case 'e' : return ('=');
506 case 'g' : return ('>');
507 case 'h' : return ('#');
508 case 'l' : return ('<');
509 case 'm' : return ('-');
510 case 'n' : return ('!');
511 case 'o' : return ('.');
512 case 'p' : return ('+');
513 case 'q' : return ('\'');
514 case 't' : return ('*');
515 case 'u' : return ('_');
517 case '\0' : return ('Z');
518 default : return (ch);
523 /* Precondition: out big enough to handle output (about twice length of in) */
524 static void enZcode( char *in, char *out )
530 for( i = 0; in[i] != '\0'; ++i ) {
605 rtsBool lookupGHCName( StgPtr addr, const char **result )
608 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
610 if (i < table_size) {
611 *result = table[i].name;
618 static void printZcoded( const char *raw )
622 while ( raw[j] != '\0' ) {
624 fputc(unZcode(raw[j+1]),stderr);
627 fputc(raw[j],stderr);
633 /* --------------------------------------------------------------------------
634 * Symbol table loading
635 * ------------------------------------------------------------------------*/
641 /* Fairly ad-hoc piece of code that seems to filter out a lot of
642 * rubbish like the obj-splitting symbols
645 static rtsBool isReal( flagword flags, const char *name )
648 /* ToDo: make this work on BFD */
649 int tp = type & N_TYPE;
650 if (tp == N_TEXT || tp == N_DATA) {
651 return (name[0] == '_' && name[1] != '_');
657 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
658 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
665 extern void DEBUG_LoadSymbols( char *name )
671 abfd = bfd_openr(name, "default");
673 barf("can't open executable %s to get symbol table", name);
675 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
681 asymbol **symbol_table;
682 long number_of_symbols;
683 long num_real_syms = 0;
686 storage_needed = bfd_get_symtab_upper_bound (abfd);
688 if (storage_needed < 0) {
689 barf("can't read symbol table");
692 if (storage_needed == 0) {
693 belch("no storage needed");
696 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
698 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
700 if (number_of_symbols < 0) {
701 barf("can't canonicalise symbol table");
704 for( i = 0; i != number_of_symbols; ++i ) {
706 bfd_get_symbol_info(abfd,symbol_table[i],&info);
707 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
708 if (isReal(info.type, info.name)) {
714 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
715 number_of_symbols, num_real_syms)
718 reset_table( num_real_syms );
720 for( i = 0; i != number_of_symbols; ++i ) {
722 bfd_get_symbol_info(abfd,symbol_table[i],&info);
723 if (isReal(info.type, info.name)) {
724 insert( info.value, info.name );
733 #else /* HAVE_BFD_H */
735 extern void DEBUG_LoadSymbols( char *name )
740 #endif /* HAVE_BFD_H */