1 /* -*- mode: hugs-c; -*- */
2 /* -----------------------------------------------------------------------------
3 * $Id: Printer.c,v 1.6 1999/02/05 16:02:46 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 * ------------------------------------------------------------------------*/
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)obj->header.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");
92 StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
94 fprintf(stderr,"AP_UPD("); printPtr((StgPtr)ap->fun);
95 for (i = 0; i < ap->n_args; ++i) {
97 printPtr(payloadPtr(ap,i));
99 fprintf(stderr,")\n");
105 StgPAP* pap = stgCast(StgPAP*,obj);
107 fprintf(stderr,"PAP("); printPtr((StgPtr)pap->fun);
108 for (i = 0; i < pap->n_args; ++i) {
109 fprintf(stderr,", ");
110 printPtr(payloadPtr(pap,i));
112 fprintf(stderr,")\n");
117 fprintf(stderr,"IND(");
118 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
119 fprintf(stderr,")\n");
123 fprintf(stderr,"IND_STATIC(");
124 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
125 fprintf(stderr,")\n");
129 fprintf(stderr,"IND_OLDGEN(");
130 printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
131 fprintf(stderr,")\n");
136 StgCAF* caf = stgCast(StgCAF*,obj);
137 fprintf(stderr,"CAF_UNENTERED(");
138 printPtr((StgPtr)caf->body);
139 fprintf(stderr,", ");
140 printPtr((StgPtr)caf->value); /* should be null */
141 fprintf(stderr,", ");
142 printPtr((StgPtr)caf->link); /* should be null */
143 fprintf(stderr,")\n");
149 StgCAF* caf = stgCast(StgCAF*,obj);
150 fprintf(stderr,"CAF_ENTERED(");
151 printPtr((StgPtr)caf->body);
152 fprintf(stderr,", ");
153 printPtr((StgPtr)caf->value);
154 fprintf(stderr,", ");
155 printPtr((StgPtr)caf->link);
156 fprintf(stderr,")\n");
161 fprintf(stderr,"CAF_BH(");
162 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
163 fprintf(stderr,")\n");
167 fprintf(stderr,"BH\n");
171 fprintf(stderr,"BQ(");
172 printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
173 fprintf(stderr,")\n");
177 case CONSTR_1_0: case CONSTR_0_1:
178 case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
180 case CONSTR_CHARLIKE:
182 case CONSTR_NOCAF_STATIC:
184 /* We can't use printStdObject because we want to print the
188 const StgInfoTable* info = get_itbl(obj);
189 fprintf(stderr,"PACK(");
190 printPtr((StgPtr)obj->header.info);
191 fprintf(stderr,"(tag=%d)",info->srt_len);
192 for (i = 0; i < info->layout.payload.ptrs; ++i) {
193 fprintf(stderr,", ");
194 printPtr(payloadPtr(obj,i));
196 for (j = 0; j < info->layout.payload.nptrs; ++j) {
197 fprintf(stderr,", %x#",payloadWord(obj,i+j));
199 fprintf(stderr,")\n");
204 case FUN_1_0: case FUN_0_1:
205 case FUN_1_1: case FUN_0_2: case FUN_2_0:
207 printStdObject(obj,"FUN");
211 case THUNK_1_0: case THUNK_0_1:
212 case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
214 /* ToDo: will this work for THUNK_STATIC too? */
215 printStdObject(obj,"THUNK");
221 fprintf(stderr,"ARR_WORDS(\"");
222 /* ToDo: we can't safely assume that this is a string! */
223 for (i = 0; arrWordsGetChar(obj,i); ++i) {
224 putchar(arrWordsGetChar(obj,i));
226 fprintf(stderr,"\")\n");
232 StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
233 fprintf(stderr,"UpdateFrame(");
234 printPtr((StgPtr)GET_INFO(u));
236 printPtr((StgPtr)u->updatee);
238 printPtr((StgPtr)u->link);
239 fprintf(stderr,")\n");
245 StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
246 fprintf(stderr,"CatchFrame(");
247 printPtr((StgPtr)GET_INFO(u));
249 printPtr((StgPtr)u->handler);
251 printPtr((StgPtr)u->link);
252 fprintf(stderr,")\n");
258 StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
259 fprintf(stderr,"SeqFrame(");
260 printPtr((StgPtr)GET_INFO(u));
262 printPtr((StgPtr)u->link);
263 fprintf(stderr,")\n");
269 StgStopFrame* u = stgCast(StgStopFrame*,obj);
270 fprintf(stderr,"StopFrame(");
271 printPtr((StgPtr)GET_INFO(u));
272 fprintf(stderr,")\n");
276 barf("printClosure %d",get_itbl(obj)->type);
281 StgPtr printStackObj( StgPtr sp )
283 /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
285 if (IS_ARG_TAG(*sp)) {
288 StackTag tag = (StackTag)*sp;
291 barf("printStackObj: ILLEGAL_TAG");
294 fprintf(stderr,"RealWorld#\n");
297 fprintf(stderr,"Int# %d\n", *(StgInt*)(sp+1));
300 fprintf(stderr,"Int64# %lld\n", *(StgInt64*)(sp+1));
303 fprintf(stderr,"Word# %d\n", *(StgWord*)(sp+1));
306 fprintf(stderr,"Addr# "); printPtr(*(StgAddr*)(sp+1)); fprintf(stderr,"\n");
309 fprintf(stderr,"Char# %d\n", *(StgChar*)(sp+1));
312 fprintf(stderr,"Float# %f\n", PK_FLT(sp+1));
315 fprintf(stderr,"Double# %f\n", PK_DBL(sp+1));
318 barf("printStackObj: unrecognised ARGTAG %d",tag);
320 sp += 1 + ARG_SIZE(tag);
322 #else /* !DEBUG_EXTRA */
326 fprintf(stderr,"Tag: %d words\n", tag);
327 for (i = 0; i < tag; i++) {
328 fprintf(stderr,"Word# %d\n", *sp++);
334 printPtr((StgPtr)*sp);
335 fprintf(stderr,"\n");
342 void printStackChunk( StgPtr sp, StgPtr spBottom )
345 const StgInfoTable *info;
347 ASSERT(sp <= spBottom);
348 while (sp < spBottom) {
349 if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
350 info = get_itbl((StgClosure *)sp);
351 switch (info->type) {
354 printObj( stgCast(StgClosure*,sp) );
355 sp += sizeofW(StgUpdateFrame);
359 printObj( stgCast(StgClosure*,sp) );
360 sp += sizeofW(StgSeqFrame);
364 printObj( stgCast(StgClosure*,sp) );
365 sp += sizeofW(StgCatchFrame);
369 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
370 printObj( stgCast(StgClosure*,sp) );
374 fprintf(stderr, "RET_DYN (%p)\n", sp);
377 fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
382 fprintf(stderr, "RET_SMALL (%p)\n", sp);
383 bitmap = info->layout.bitmap;
386 while (bitmap != 0) {
387 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
388 if ((bitmap & 1) == 0) {
390 fprintf(stderr,"\n");
392 fprintf(stderr,"Word# %d\n", *sp++);
395 bitmap = bitmap >> 1;
407 fprintf(stderr,"Stack[%d] (%p) = ", spBottom-sp, sp);
408 sp = printStackObj(sp);
412 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
414 /* check everything down to the first update frame */
415 printStackChunk( sp, stgCast(StgPtr,su) );
416 while ( stgCast(StgPtr,su) < spBottom) {
417 sp = stgCast(StgPtr,su);
418 switch (get_itbl(su)->type) {
420 printObj( stgCast(StgClosure*,su) );
421 sp += sizeofW(StgUpdateFrame);
425 printObj( stgCast(StgClosure*,su) );
426 sp += sizeofW(StgSeqFrame);
427 su = stgCast(StgSeqFrame*,su)->link;
430 printObj( stgCast(StgClosure*,su) );
431 sp += sizeofW(StgCatchFrame);
432 su = stgCast(StgCatchFrame*,su)->link;
435 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
436 printObj( stgCast(StgClosure*,su) );
439 barf("printStack: weird record found on update frame list.");
441 printStackChunk( sp, stgCast(StgPtr,su) );
443 ASSERT(stgCast(StgPtr,su) == spBottom);
446 void printTSO( StgTSO *tso )
448 printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
449 /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
453 /* --------------------------------------------------------------------------
454 * Address printing code
456 * Uses symbol table in (unstripped executable)
457 * ------------------------------------------------------------------------*/
459 /* --------------------------------------------------------------------------
460 * Simple lookup table
462 * Current implementation is pretty dumb!
463 * ------------------------------------------------------------------------*/
470 static nat max_table_size;
471 static nat table_size;
472 static struct entry* table;
474 static void reset_table( int size )
476 max_table_size = size;
478 table = (struct entry *) malloc(size * sizeof(struct entry));
481 static void prepare_table( void )
483 /* Could sort it... */
486 static void insert( unsigned value, const char *name )
488 if ( table_size >= max_table_size ) {
489 barf( "Symbol table overflow\n" );
491 table[table_size].value = value;
492 table[table_size].name = name;
493 table_size = table_size + 1;
498 static rtsBool lookup_name( char *name, unsigned *result )
501 for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
503 if (i < table_size) {
504 *result = table[i].value;
512 /* Code from somewhere inside GHC (circa 1994)
514 * "std"++xs -> "Zstd"++xs
515 * char_to_c 'Z' = "ZZ"
516 * char_to_c '&' = "Za"
517 * char_to_c '|' = "Zb"
518 * char_to_c ':' = "Zc"
519 * char_to_c '/' = "Zd"
520 * char_to_c '=' = "Ze"
521 * char_to_c '>' = "Zg"
522 * char_to_c '#' = "Zh"
523 * char_to_c '<' = "Zl"
524 * char_to_c '-' = "Zm"
525 * char_to_c '!' = "Zn"
526 * char_to_c '.' = "Zo"
527 * char_to_c '+' = "Zp"
528 * char_to_c '\'' = "Zq"
529 * char_to_c '*' = "Zt"
530 * char_to_c '_' = "Zu"
531 * char_to_c c = "Z" ++ show (ord c)
533 static char unZcode( char ch )
536 case 'a' : return ('&');
537 case 'b' : return ('|');
538 case 'c' : return (':');
539 case 'd' : return ('/');
540 case 'e' : return ('=');
541 case 'g' : return ('>');
542 case 'h' : return ('#');
543 case 'l' : return ('<');
544 case 'm' : return ('-');
545 case 'n' : return ('!');
546 case 'o' : return ('.');
547 case 'p' : return ('+');
548 case 'q' : return ('\'');
549 case 't' : return ('*');
550 case 'u' : return ('_');
552 case '\0' : return ('Z');
553 default : return (ch);
558 /* Precondition: out big enough to handle output (about twice length of in) */
559 static void enZcode( char *in, char *out )
565 for( i = 0; in[i] != '\0'; ++i ) {
640 rtsBool lookupGHCName( StgPtr addr, const char **result )
643 for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
645 if (i < table_size) {
646 *result = table[i].name;
653 static void printZcoded( const char *raw )
657 while ( raw[j] != '\0' ) {
659 fputc(unZcode(raw[j+1]),stderr);
662 fputc(raw[j],stderr);
668 /* --------------------------------------------------------------------------
669 * Symbol table loading
670 * ------------------------------------------------------------------------*/
676 /* Fairly ad-hoc piece of code that seems to filter out a lot of
677 * rubbish like the obj-splitting symbols
680 static rtsBool isReal( flagword flags, const char *name )
683 /* ToDo: make this work on BFD */
684 int tp = type & N_TYPE;
685 if (tp == N_TEXT || tp == N_DATA) {
686 return (name[0] == '_' && name[1] != '_');
692 (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
693 (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
700 extern void DEBUG_LoadSymbols( char *name )
706 abfd = bfd_openr(name, "default");
708 barf("can't open executable %s to get symbol table", name);
710 if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
716 asymbol **symbol_table;
717 long number_of_symbols;
718 long num_real_syms = 0;
721 storage_needed = bfd_get_symtab_upper_bound (abfd);
723 if (storage_needed < 0) {
724 barf("can't read symbol table");
727 if (storage_needed == 0) {
728 belch("no storage needed");
731 symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
733 number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
735 if (number_of_symbols < 0) {
736 barf("can't canonicalise symbol table");
739 for( i = 0; i != number_of_symbols; ++i ) {
741 bfd_get_symbol_info(abfd,symbol_table[i],&info);
742 /*fprintf(stderr,"\t%c\t0x%x \t%s\n",info.type,(nat)info.value,info.name); */
743 if (isReal(info.type, info.name)) {
749 fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
750 number_of_symbols, num_real_syms)
753 reset_table( num_real_syms );
755 for( i = 0; i != number_of_symbols; ++i ) {
757 bfd_get_symbol_info(abfd,symbol_table[i],&info);
758 if (isReal(info.type, info.name)) {
759 insert( info.value, info.name );
768 #else /* HAVE_BFD_H */
770 extern void DEBUG_LoadSymbols( char *name )
775 #endif /* HAVE_BFD_H */