ghc/rts/Printer.c

   1 /* -----------------------------------------------------------------------------
   2  * $Id: Printer.c,v 1.46 2001/08/21 10:12:02 sewardj Exp $
   3  *
   4  * (c) The GHC Team, 1994-2000.
   5  *
   6  * Heap printer
   7  *
   8  * ---------------------------------------------------------------------------*/
   9
  10 #include "PosixSource.h"
  11 #include "Rts.h"
  12 #include "Printer.h"
  13
  14 #ifdef DEBUG
  15
  16 #include "RtsUtils.h"
  17 #include "RtsFlags.h"
  18 #include "MBlock.h"
  19 #include "Storage.h"
  20 #include "Bytecodes.h"  /* for InstrPtr */
  21 #include "Disassembler.h"
  22
  23 #include "Printer.h"
  24
  25 #if defined(GRAN) || defined(PAR)
  26 // HWL: explicit fixed header size to make debugging easier
  27 int fixed_hs = FIXED_HS, itbl_sz = sizeofW(StgInfoTable),
  28     uf_sz=sizeofW(StgUpdateFrame), sf_sz=sizeofW(StgSeqFrame);
  29 #endif
  30
  31 /* --------------------------------------------------------------------------
  32  * local function decls
  33  * ------------------------------------------------------------------------*/
  34
  35 static void    printStdObject( StgClosure *obj, char* tag );
  36 static void    reset_table   ( int size );
  37 static void    prepare_table ( void );
  38 static void    insert        ( unsigned value, const char *name );
  39 #if 0 /* unused but might be useful sometime */
  40 static rtsBool lookup_name   ( char *name, unsigned *result );
  41 static void    enZcode       ( char *in, char *out );
  42 #endif
  43 static char    unZcode       ( char ch );
  44 rtsBool lookupGHCName ( StgPtr addr, const char **result );
  45 static void    printZcoded   ( const char *raw );
  46
  47 /* --------------------------------------------------------------------------
  48  * Printer
  49  * ------------------------------------------------------------------------*/
  50
  51 void printPtr( StgPtr p )
  52 {
  53     const char *raw;
  54     if (lookupGHCName( p, &raw )) {
  55         printZcoded(raw);
  56     } else {
  57         fprintf(stderr, "%p", p);
  58     }
  59 }
  60
  61 void printObj( StgClosure *obj )
  62 {
  63     fprintf(stderr,"Object "); printPtr((StgPtr)obj); fprintf(stderr," = ");
  64     printClosure(obj);
  65 }
  66
  67 static void printStdObject( StgClosure *obj, char* tag )
  68 {
  69     StgWord i, j;
  70     const StgInfoTable* info = get_itbl(obj);
  71     fprintf(stderr,"%s(",tag);
  72     printPtr((StgPtr)obj->header.info);
  73 #ifdef PROFILING
  74     fprintf(stderr,", %s", obj->header.prof.ccs->cc->label);
  75 #endif
  76     for (i = 0; i < info->layout.payload.ptrs; ++i) {
  77         fprintf(stderr,", ");
  78         printPtr((StgPtr)obj->payload[i]);
  79     }
  80     for (j = 0; j < info->layout.payload.nptrs; ++j) {
  81         fprintf(stderr,", %pd#",obj->payload[i+j]);
  82     }
  83     fprintf(stderr,")\n");
  84 }
  85
  86 void printClosure( StgClosure *obj )
  87 {
  88     StgInfoTable *info;
  89
  90     info = get_itbl(obj);
  91
  92     switch ( info->type ) {
  93     case INVALID_OBJECT:
  94             barf("Invalid object");
  95     case BCO:
  96             disassemble( (StgBCO*)obj );
  97             break;
  98
  99     case MUT_VAR:
 100         {
 101           StgMutVar* mv = (StgMutVar*)obj;
 102           fprintf(stderr,"MUT_VAR(var=%p, link=%p)\n", mv->var, mv->mut_link);
 103           break;
 104         }
 105
 106     case AP_UPD:
 107         {
 108             StgAP_UPD* ap = stgCast(StgAP_UPD*,obj);
 109             StgWord i;
 110             fprintf(stderr,"AP_UPD("); printPtr((StgPtr)ap->fun);
 111             for (i = 0; i < ap->n_args; ++i) {
 112                 fprintf(stderr,", ");
 113                 printPtr((P_)ap->payload[i]);
 114             }
 115             fprintf(stderr,")\n");
 116             break;
 117         }
 118
 119     case PAP:
 120         {
 121             StgPAP* pap = stgCast(StgPAP*,obj);
 122             StgWord i;
 123             fprintf(stderr,"PAP("); printPtr((StgPtr)pap->fun);
 124             for (i = 0; i < pap->n_args; ++i) {
 125                 fprintf(stderr,", ");
 126                 printPtr((StgPtr)pap->payload[i]);
 127             }
 128             fprintf(stderr,")\n");
 129             break;
 130         }
 131
 132     case FOREIGN:
 133             fprintf(stderr,"FOREIGN(");
 134             printPtr((StgPtr)( ((StgForeignObj*)obj)->data ));
 135             fprintf(stderr,")\n");
 136             break;
 137
 138     case IND:
 139             fprintf(stderr,"IND(");
 140             printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
 141             fprintf(stderr,")\n");
 142             break;
 143
 144     case IND_STATIC:
 145             fprintf(stderr,"IND_STATIC(");
 146             printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
 147             fprintf(stderr,")\n");
 148             break;
 149
 150     case IND_OLDGEN:
 151             fprintf(stderr,"IND_OLDGEN(");
 152             printPtr((StgPtr)stgCast(StgInd*,obj)->indirectee);
 153             fprintf(stderr,")\n");
 154             break;
 155
 156     case CAF_BLACKHOLE:
 157             fprintf(stderr,"CAF_BH(");
 158             printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
 159             fprintf(stderr,")\n");
 160             break;
 161
 162     case SE_BLACKHOLE:
 163             fprintf(stderr,"SE_BH\n");
 164             break;
 165
 166     case SE_CAF_BLACKHOLE:
 167             fprintf(stderr,"SE_CAF_BH\n");
 168             break;
 169
 170     case BLACKHOLE:
 171             fprintf(stderr,"BH\n");
 172             break;
 173
 174     case BLACKHOLE_BQ:
 175             fprintf(stderr,"BQ(");
 176             printPtr((StgPtr)stgCast(StgBlockingQueue*,obj)->blocking_queue);
 177             fprintf(stderr,")\n");
 178             break;
 179
 180     case TSO:
 181       fprintf(stderr,"TSO(");
 182       fprintf(stderr,"%d (%p)",((StgTSO*)obj)->id, (StgTSO*)obj);
 183       fprintf(stderr,")\n");
 184       break;
 185
 186 #if defined(PAR)
 187     case BLOCKED_FETCH:
 188       fprintf(stderr,"BLOCKED_FETCH(");
 189       printGA(&(stgCast(StgBlockedFetch*,obj)->ga));
 190       printPtr((StgPtr)(stgCast(StgBlockedFetch*,obj)->node));
 191       fprintf(stderr,")\n");
 192       break;
 193
 194     case FETCH_ME:
 195       fprintf(stderr,"FETCH_ME(");
 196       printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
 197       fprintf(stderr,")\n");
 198       break;
 199
 200 #ifdef DIST
 201     case REMOTE_REF:
 202       fprintf(stderr,"REMOTE_REF(");
 203       printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
 204       fprintf(stderr,")\n");
 205       break;
 206 #endif
 207
 208     case FETCH_ME_BQ:
 209       fprintf(stderr,"FETCH_ME_BQ(");
 210       // printGA((globalAddr *)stgCast(StgFetchMe*,obj)->ga);
 211       printPtr((StgPtr)stgCast(StgFetchMeBlockingQueue*,obj)->blocking_queue);
 212       fprintf(stderr,")\n");
 213       break;
 214 #endif
 215 #if defined(GRAN) || defined(PAR)
 216     case RBH:
 217       fprintf(stderr,"RBH(");
 218       printPtr((StgPtr)stgCast(StgRBH*,obj)->blocking_queue);
 219       fprintf(stderr,")\n");
 220       break;
 221
 222 #endif
 223
 224     case CONSTR:
 225     case CONSTR_1_0: case CONSTR_0_1:
 226     case CONSTR_1_1: case CONSTR_0_2: case CONSTR_2_0:
 227     case CONSTR_INTLIKE:
 228     case CONSTR_CHARLIKE:
 229     case CONSTR_STATIC:
 230     case CONSTR_NOCAF_STATIC:
 231         {
 232             /* We can't use printStdObject because we want to print the
 233              * tag as well.
 234              */
 235             StgWord i, j;
 236 #ifdef PROFILING
 237             fprintf(stderr,"%s(", info->prof.closure_desc);
 238             fprintf(stderr,"%s", obj->header.prof.ccs->cc->label);
 239 #else
 240             fprintf(stderr,"CONSTR(");
 241             printPtr((StgPtr)obj->header.info);
 242             fprintf(stderr,"(tag=%d)",info->srt_len);
 243 #endif
 244             for (i = 0; i < info->layout.payload.ptrs; ++i) {
 245                 fprintf(stderr,", ");
 246                 printPtr((StgPtr)obj->payload[i]);
 247             }
 248             for (j = 0; j < info->layout.payload.nptrs; ++j) {
 249                 fprintf(stderr,", %p#", obj->payload[i+j]);
 250             }
 251             fprintf(stderr,")\n");
 252             break;
 253         }
 254
 255 #ifdef XMLAMBDA
 256 /* rows are mutarrays in xmlambda, maybe we should make a new type: ROW */
 257     case MUT_ARR_PTRS_FROZEN:
 258           {
 259             StgWord i;
 260             StgMutArrPtrs* p = stgCast(StgMutArrPtrs*,obj);
 261
 262             fprintf(stderr,"Row<%i>(",p->ptrs);
 263             for (i = 0; i < p->ptrs; ++i) {
 264                 if (i > 0) fprintf(stderr,", ");
 265                 printPtr((StgPtr)(p->payload[i]));
 266             }
 267             fprintf(stderr,")\n");
 268             break;
 269           }
 270 #endif
 271
 272     case FUN:
 273     case FUN_1_0: case FUN_0_1:
 274     case FUN_1_1: case FUN_0_2: case FUN_2_0:
 275     case FUN_STATIC:
 276             printStdObject(obj,"FUN");
 277             break;
 278
 279     case THUNK:
 280     case THUNK_1_0: case THUNK_0_1:
 281     case THUNK_1_1: case THUNK_0_2: case THUNK_2_0:
 282     case THUNK_STATIC:
 283             /* ToDo: will this work for THUNK_STATIC too? */
 284 #ifdef PROFILING
 285             printStdObject(obj,info->prof.closure_desc);
 286 #else
 287             printStdObject(obj,"THUNK");
 288 #endif
 289             break;
 290
 291     case THUNK_SELECTOR:
 292             printStdObject(obj,"THUNK_SELECTOR");
 293             break;
 294
 295     case ARR_WORDS:
 296         {
 297             StgWord i;
 298             fprintf(stderr,"ARR_WORDS(\"");
 299             /* ToDo: we can't safely assume that this is a string!
 300             for (i = 0; arrWordsGetChar(obj,i); ++i) {
 301                 putchar(arrWordsGetChar(obj,i));
 302                 } */
 303             for (i=0; i<((StgArrWords *)obj)->words; i++)
 304               fprintf(stderr, "%ld", ((StgArrWords *)obj)->payload[i]);
 305             fprintf(stderr,"\")\n");
 306             break;
 307         }
 308
 309     case UPDATE_FRAME:
 310         {
 311             StgUpdateFrame* u = stgCast(StgUpdateFrame*,obj);
 312             fprintf(stderr,"UpdateFrame(");
 313             printPtr((StgPtr)GET_INFO(u));
 314             fprintf(stderr,",");
 315             printPtr((StgPtr)u->updatee);
 316             fprintf(stderr,",");
 317             printPtr((StgPtr)u->link);
 318             fprintf(stderr,")\n");
 319             break;
 320         }
 321
 322     case CATCH_FRAME:
 323         {
 324             StgCatchFrame* u = stgCast(StgCatchFrame*,obj);
 325             fprintf(stderr,"CatchFrame(");
 326             printPtr((StgPtr)GET_INFO(u));
 327             fprintf(stderr,",");
 328             printPtr((StgPtr)u->handler);
 329             fprintf(stderr,",");
 330             printPtr((StgPtr)u->link);
 331             fprintf(stderr,")\n");
 332             break;
 333         }
 334
 335     case SEQ_FRAME:
 336         {
 337             StgSeqFrame* u = stgCast(StgSeqFrame*,obj);
 338             fprintf(stderr,"SeqFrame(");
 339             printPtr((StgPtr)GET_INFO(u));
 340             fprintf(stderr,",");
 341             printPtr((StgPtr)u->link);
 342             fprintf(stderr,")\n");
 343             break;
 344         }
 345
 346     case STOP_FRAME:
 347         {
 348             StgStopFrame* u = stgCast(StgStopFrame*,obj);
 349             fprintf(stderr,"StopFrame(");
 350             printPtr((StgPtr)GET_INFO(u));
 351             fprintf(stderr,")\n");
 352             break;
 353         }
 354     default:
 355             //barf("printClosure %d",get_itbl(obj)->type);
 356             fprintf(stderr, "*** printClosure: unknown type %d ****\n",
 357                     get_itbl(obj)->type );
 358             barf("printClosure %d",get_itbl(obj)->type);
 359             return;
 360     }
 361 }
 362
 363 /*
 364 void printGraph( StgClosure *obj )
 365 {
 366  printClosure(obj);
 367 }
 368 */
 369
 370 StgPtr printStackObj( StgPtr sp )
 371 {
 372     /*fprintf(stderr,"Stack[%d] = ", &stgStack[STACK_SIZE] - sp); */
 373
 374     if (IS_ARG_TAG(*sp)) {
 375         nat i;
 376         StgWord tag = *sp++;
 377         fprintf(stderr,"Tagged{");
 378         for (i = 0; i < tag; i++) {
 379             fprintf(stderr,"0x%x#", (unsigned)(*sp++));
 380             if (i < tag-1) fprintf(stderr, ", ");
 381         }
 382         fprintf(stderr, "}\n");
 383     } else {
 384         StgClosure* c = (StgClosure*)(*sp);
 385         printPtr((StgPtr)*sp);
 386         if (c == (StgClosure*)&stg_ctoi_ret_R1p_info) {
 387            fprintf(stderr, "\t\t\tstg_ctoi_ret_R1p_info\n" );
 388         } else
 389         if (c == (StgClosure*)&stg_ctoi_ret_R1n_info) {
 390            fprintf(stderr, "\t\t\tstg_ctoi_ret_R1n_info\n" );
 391         } else
 392         if (c == (StgClosure*)&stg_ctoi_ret_F1_info) {
 393            fprintf(stderr, "\t\t\tstg_ctoi_ret_F1_info\n" );
 394         } else
 395         if (c == (StgClosure*)&stg_ctoi_ret_D1_info) {
 396            fprintf(stderr, "\t\t\tstg_ctoi_ret_D1_info\n" );
 397         } else
 398         if (c == (StgClosure*)&stg_ctoi_ret_V_info) {
 399            fprintf(stderr, "\t\t\tstg_ctoi_ret_V_info\n" );
 400         } else
 401         if (get_itbl(c)->type == BCO) {
 402            fprintf(stderr, "\t\t\t");
 403            fprintf(stderr, "BCO(...)\n");
 404         }
 405         else {
 406            fprintf(stderr, "\t\t\t");
 407            printClosure ( (StgClosure*)(*sp));
 408         }
 409         sp += 1;
 410     }
 411     return sp;
 412
 413 }
 414
 415 void printStackChunk( StgPtr sp, StgPtr spBottom )
 416 {
 417     StgWord bitmap;
 418     const StgInfoTable *info;
 419
 420     ASSERT(sp <= spBottom);
 421     while (sp < spBottom) {
 422       if (!IS_ARG_TAG(*sp) && LOOKS_LIKE_GHC_INFO(*sp)) {
 423         info = get_itbl((StgClosure *)sp);
 424         switch (info->type) {
 425
 426         case UPDATE_FRAME:
 427             printObj( stgCast(StgClosure*,sp) );
 428             sp += sizeofW(StgUpdateFrame);
 429             continue;
 430
 431         case SEQ_FRAME:
 432             printObj( stgCast(StgClosure*,sp) );
 433             sp += sizeofW(StgSeqFrame);
 434             continue;
 435
 436         case CATCH_FRAME:
 437             printObj( stgCast(StgClosure*,sp) );
 438             sp += sizeofW(StgCatchFrame);
 439             continue;
 440
 441         case STOP_FRAME:
 442             /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
 443             printObj( stgCast(StgClosure*,sp) );
 444             continue;
 445
 446         case RET_DYN:
 447           fprintf(stderr, "RET_DYN (%p)\n", sp);
 448           bitmap = *++sp;
 449           ++sp;
 450           fprintf(stderr, "Bitmap: 0x%x\n", bitmap);
 451           goto small_bitmap;
 452
 453         case RET_SMALL:
 454         case RET_VEC_SMALL:
 455           fprintf(stderr, "RET_SMALL (%p)\n", sp);
 456           bitmap = info->layout.bitmap;
 457           sp++;
 458         small_bitmap:
 459           while (bitmap != 0) {
 460             fprintf(stderr,"   stk[%ld] (%p) = ", spBottom-sp, sp);
 461             if ((bitmap & 1) == 0) {
 462               printPtr((P_)*sp);
 463               fprintf(stderr,"\n");
 464             } else {
 465               fprintf(stderr,"Word# %ld\n", *sp++);
 466             }
 467             sp++;
 468             bitmap = bitmap >> 1;
 469             }
 470           continue;
 471
 472         case RET_BIG:
 473         case RET_VEC_BIG:
 474           barf("todo");
 475
 476         default:
 477           break;
 478         }
 479       }
 480       fprintf(stderr,"Stack[%ld] (%p) = ", spBottom-sp, sp);
 481       sp = printStackObj(sp);
 482     }
 483 }
 484
 485 void printStack( StgPtr sp, StgPtr spBottom, StgUpdateFrame* su )
 486 {
 487     /* check everything down to the first update frame */
 488     printStackChunk( sp, stgCast(StgPtr,su) );
 489     while ( stgCast(StgPtr,su) < spBottom) {
 490         sp = stgCast(StgPtr,su);
 491         switch (get_itbl(su)->type) {
 492         case UPDATE_FRAME:
 493                 printObj( stgCast(StgClosure*,su) );
 494                 sp += sizeofW(StgUpdateFrame);
 495                 su = su->link;
 496                 break;
 497         case SEQ_FRAME:
 498                 printObj( stgCast(StgClosure*,su) );
 499                 sp += sizeofW(StgSeqFrame);
 500                 su = stgCast(StgSeqFrame*,su)->link;
 501                 break;
 502         case CATCH_FRAME:
 503                 printObj( stgCast(StgClosure*,su) );
 504                 sp += sizeofW(StgCatchFrame);
 505                 su = stgCast(StgCatchFrame*,su)->link;
 506                 break;
 507         case STOP_FRAME:
 508                 /* not quite: ASSERT(stgCast(StgPtr,su) == spBottom); */
 509                 printObj( stgCast(StgClosure*,su) );
 510                 return;
 511         default:
 512                 barf("printStack: weird record found on update frame list.");
 513         }
 514         printStackChunk( sp, stgCast(StgPtr,su) );
 515     }
 516     ASSERT(stgCast(StgPtr,su) == spBottom);
 517 }
 518
 519 void printTSO( StgTSO *tso )
 520 {
 521     printStack( tso->sp, tso->stack+tso->stack_size,tso->su);
 522     /* printStackChunk( tso->sp, tso->stack+tso->stack_size); */
 523 }
 524
 525 /* -----------------------------------------------------------------------------
 526    Closure types
 527
 528    NOTE: must be kept in sync with the closure types in includes/ClosureTypes.h
 529    -------------------------------------------------------------------------- */
 530
 531 static char *closure_type_names[] = {
 532   "INVALID_OBJECT",             /* 0  */
 533   "CONSTR",                     /* 1  */
 534   "CONSTR_1_0",                 /* 2  */
 535   "CONSTR_0_1",                 /* 3  */
 536   "CONSTR_2_0",                 /* 4  */
 537   "CONSTR_1_1",                 /* 5  */
 538   "CONSTR_0_2",                 /* 6  */
 539   "CONSTR_INTLIKE",             /* 7  */
 540   "CONSTR_CHARLIKE",            /* 8  */
 541   "CONSTR_STATIC",              /* 9  */
 542   "CONSTR_NOCAF_STATIC",        /* 10 */
 543   "FUN",                        /* 11 */
 544   "FUN_1_0",                    /* 12 */
 545   "FUN_0_1",                    /* 13 */
 546   "FUN_2_0",                    /* 14 */
 547   "FUN_1_1",                    /* 15 */
 548   "FUN_0_2",                    /* 16 */
 549   "FUN_STATIC",                 /* 17 */
 550   "THUNK",                      /* 18 */
 551   "THUNK_1_0",                  /* 19 */
 552   "THUNK_0_1",                  /* 20 */
 553   "THUNK_2_0",                  /* 21 */
 554   "THUNK_1_1",                  /* 22 */
 555   "THUNK_0_2",                  /* 23 */
 556   "THUNK_STATIC",               /* 24 */
 557   "THUNK_SELECTOR",             /* 25 */
 558   "BCO",                        /* 26 */
 559   "AP_UPD",                     /* 27 */
 560   "PAP",                        /* 28 */
 561   "IND",                        /* 29 */
 562   "IND_OLDGEN",                 /* 30 */
 563   "IND_PERM",                   /* 31 */
 564   "IND_OLDGEN_PERM",            /* 32 */
 565   "IND_STATIC",                 /* 33 */
 566   "CAF_BLACKHOLE",              /* 36 */
 567   "RET_BCO",                    /* 37 */
 568   "RET_SMALL",                  /* 38 */
 569   "RET_VEC_SMALL",              /* 39 */
 570   "RET_BIG",                    /* 40 */
 571   "RET_VEC_BIG",                /* 41 */
 572   "RET_DYN",                    /* 42 */
 573   "UPDATE_FRAME",               /* 43 */
 574   "CATCH_FRAME",                /* 44 */
 575   "STOP_FRAME",                 /* 45 */
 576   "SEQ_FRAME",                  /* 46 */
 577   "BLACKHOLE",                  /* 47 */
 578   "BLACKHOLE_BQ",               /* 48 */
 579   "SE_BLACKHOLE",               /* 49 */
 580   "SE_CAF_BLACKHOLE",           /* 50 */
 581   "MVAR",                       /* 51 */
 582   "ARR_WORDS",                  /* 52 */
 583   "MUT_ARR_PTRS",               /* 53 */
 584   "MUT_ARR_PTRS_FROZEN",        /* 54 */
 585   "MUT_VAR",                    /* 55 */
 586   "WEAK",                       /* 56 */
 587   "FOREIGN",                    /* 57 */
 588   "STABLE_NAME",                /* 58 */
 589   "TSO",                        /* 59 */
 590   "BLOCKED_FETCH",              /* 60 */
 591   "FETCH_ME",                   /* 61 */
 592   "FETCH_ME_BQ",                /* 62 */
 593   "RBH",                        /* 63 */
 594   "EVACUATED",                  /* 64 */
 595   "REMOTE_REF",                 /* 65 */
 596   "N_CLOSURE_TYPES"             /* 66 */
 597 };
 598
 599 char *
 600 info_type(StgClosure *closure){
 601   return closure_type_names[get_itbl(closure)->type];
 602 }
 603
 604 char *
 605 info_type_by_ip(StgInfoTable *ip){
 606   return closure_type_names[ip->type];
 607 }
 608
 609 void
 610 info_hdr_type(StgClosure *closure, char *res){
 611   strcpy(res,closure_type_names[get_itbl(closure)->type]);
 612 }
 613
 614 /* --------------------------------------------------------------------------
 615  * Address printing code
 616  *
 617  * Uses symbol table in (unstripped executable)
 618  * ------------------------------------------------------------------------*/
 619
 620 /* --------------------------------------------------------------------------
 621  * Simple lookup table
 622  *
 623  * Current implementation is pretty dumb!
 624  * ------------------------------------------------------------------------*/
 625
 626 struct entry {
 627     nat value;
 628     const char *name;
 629 };
 630
 631 static nat max_table_size;
 632 static nat table_size;
 633 static struct entry* table;
 634
 635 static void reset_table( int size )
 636 {
 637     max_table_size = size;
 638     table_size = 0;
 639     table = (struct entry *) malloc(size * sizeof(struct entry));
 640 }
 641
 642 static void prepare_table( void )
 643 {
 644     /* Could sort it...  */
 645 }
 646
 647 static void insert( unsigned value, const char *name )
 648 {
 649     if ( table_size >= max_table_size ) {
 650         barf( "Symbol table overflow\n" );
 651     }
 652     table[table_size].value = value;
 653     table[table_size].name = name;
 654     table_size = table_size + 1;
 655 }
 656
 657
 658 #if 0
 659 static rtsBool lookup_name( char *name, unsigned *result )
 660 {
 661     int i;
 662     for( i = 0; i < table_size && strcmp(name,table[i].name) != 0; ++i ) {
 663     }
 664     if (i < table_size) {
 665         *result = table[i].value;
 666         return rtsTrue;
 667     } else {
 668         return rtsFalse;
 669     }
 670 }
 671 #endif
 672
 673 /* Code from somewhere inside GHC (circa 1994)
 674  * * Z-escapes:
 675  *     "std"++xs -> "Zstd"++xs
 676  *     char_to_c 'Z'  = "ZZ"
 677  *     char_to_c '&'  = "Za"
 678  *     char_to_c '|'  = "Zb"
 679  *     char_to_c ':'  = "Zc"
 680  *     char_to_c '/'  = "Zd"
 681  *     char_to_c '='  = "Ze"
 682  *     char_to_c '>'  = "Zg"
 683  *     char_to_c '#'  = "Zh"
 684  *     char_to_c '<'  = "Zl"
 685  *     char_to_c '-'  = "Zm"
 686  *     char_to_c '!'  = "Zn"
 687  *     char_to_c '.'  = "Zo"
 688  *     char_to_c '+'  = "Zp"
 689  *     char_to_c '\'' = "Zq"
 690  *     char_to_c '*'  = "Zt"
 691  *     char_to_c '_'  = "Zu"
 692  *     char_to_c c    = "Z" ++ show (ord c)
 693  */
 694 static char unZcode( char ch )
 695 {
 696     switch (ch) {
 697     case 'a'  : return ('&');
 698     case 'b'  : return ('|');
 699     case 'c'  : return (':');
 700     case 'd'  : return ('/');
 701     case 'e'  : return ('=');
 702     case 'g'  : return ('>');
 703     case 'h'  : return ('#');
 704     case 'l'  : return ('<');
 705     case 'm'  : return ('-');
 706     case 'n'  : return ('!');
 707     case 'o'  : return ('.');
 708     case 'p'  : return ('+');
 709     case 'q'  : return ('\'');
 710     case 't'  : return ('*');
 711     case 'u'  : return ('_');
 712     case 'Z'  :
 713     case '\0' : return ('Z');
 714     default   : return (ch);
 715     }
 716 }
 717
 718 #if 0
 719 /* Precondition: out big enough to handle output (about twice length of in) */
 720 static void enZcode( char *in, char *out )
 721 {
 722     int i, j;
 723
 724     j = 0;
 725     out[ j++ ] = '_';
 726     for( i = 0; in[i] != '\0'; ++i ) {
 727         switch (in[i]) {
 728         case 'Z'  :
 729                 out[j++] = 'Z';
 730                 out[j++] = 'Z';
 731                 break;
 732         case '&'  :
 733                 out[j++] = 'Z';
 734                 out[j++] = 'a';
 735                 break;
 736         case '|'  :
 737                 out[j++] = 'Z';
 738                 out[j++] = 'b';
 739                 break;
 740         case ':'  :
 741                 out[j++] = 'Z';
 742                 out[j++] = 'c';
 743                 break;
 744         case '/'  :
 745                 out[j++] = 'Z';
 746                 out[j++] = 'd';
 747                 break;
 748         case '='  :
 749                 out[j++] = 'Z';
 750                 out[j++] = 'e';
 751                 break;
 752         case '>'  :
 753                 out[j++] = 'Z';
 754                 out[j++] = 'g';
 755                 break;
 756         case '#'  :
 757                 out[j++] = 'Z';
 758                 out[j++] = 'h';
 759                 break;
 760         case '<'  :
 761                 out[j++] = 'Z';
 762                 out[j++] = 'l';
 763                 break;
 764         case '-'  :
 765                 out[j++] = 'Z';
 766                 out[j++] = 'm';
 767                 break;
 768         case '!'  :
 769                 out[j++] = 'Z';
 770                 out[j++] = 'n';
 771                 break;
 772         case '.'  :
 773                 out[j++] = 'Z';
 774                 out[j++] = 'o';
 775                 break;
 776         case '+'  :
 777                 out[j++] = 'Z';
 778                 out[j++] = 'p';
 779                 break;
 780         case '\'' :
 781                 out[j++] = 'Z';
 782                 out[j++] = 'q';
 783                 break;
 784         case '*'  :
 785                 out[j++] = 'Z';
 786                 out[j++] = 't';
 787                 break;
 788         case '_'  :
 789                 out[j++] = 'Z';
 790                 out[j++] = 'u';
 791                 break;
 792         default :
 793                 out[j++] = in[i];
 794                 break;
 795         }
 796     }
 797     out[j] = '\0';
 798 }
 799 #endif
 800
 801 rtsBool lookupGHCName( StgPtr addr, const char **result )
 802 {
 803     nat i;
 804     for( i = 0; i < table_size && table[i].value != (unsigned) addr; ++i ) {
 805     }
 806     if (i < table_size) {
 807         *result = table[i].name;
 808         return rtsTrue;
 809     } else {
 810         return rtsFalse;
 811     }
 812 }
 813
 814 static void printZcoded( const char *raw )
 815 {
 816     nat j = 0;
 817
 818     while ( raw[j] != '\0' ) {
 819         if (raw[j] == 'Z') {
 820             fputc(unZcode(raw[j+1]),stderr);
 821             j = j + 2;
 822         } else {
 823             fputc(raw[j],stderr);
 824             j = j + 1;
 825         }
 826     }
 827 }
 828
 829 /* --------------------------------------------------------------------------
 830  * Symbol table loading
 831  * ------------------------------------------------------------------------*/
 832
 833 /* Causing linking trouble on Win32 plats, so I'm
 834    disabling this for now.
 835 */
 836 #ifdef USING_LIBBFD
 837
 838 #include <bfd.h>
 839
 840 /* Fairly ad-hoc piece of code that seems to filter out a lot of
 841  * rubbish like the obj-splitting symbols
 842  */
 843
 844 static rtsBool isReal( flagword flags, const char *name )
 845 {
 846 #if 0
 847     /* ToDo: make this work on BFD */
 848     int tp = type & N_TYPE;
 849     if (tp == N_TEXT || tp == N_DATA) {
 850         return (name[0] == '_' && name[1] != '_');
 851     } else {
 852         return rtsFalse;
 853     }
 854 #else
 855     (void)flags;   /* keep gcc -Wall happy */
 856     if (*name == '\0'  ||
 857         (name[0] == 'g' && name[1] == 'c' && name[2] == 'c') ||
 858         (name[0] == 'c' && name[1] == 'c' && name[2] == '.')) {
 859         return rtsFalse;
 860     }
 861     return rtsTrue;
 862 #endif
 863 }
 864
 865 extern void DEBUG_LoadSymbols( char *name )
 866 {
 867     bfd* abfd;
 868     char **matching;
 869
 870     bfd_init();
 871     abfd = bfd_openr(name, "default");
 872     if (abfd == NULL) {
 873         barf("can't open executable %s to get symbol table", name);
 874     }
 875     if (!bfd_check_format_matches (abfd, bfd_object, &matching)) {
 876         barf("mismatch");
 877     }
 878
 879     {
 880         long storage_needed;
 881         asymbol **symbol_table;
 882         long number_of_symbols;
 883         long num_real_syms = 0;
 884         long i;
 885
 886         storage_needed = bfd_get_symtab_upper_bound (abfd);
 887
 888         if (storage_needed < 0) {
 889             barf("can't read symbol table");
 890         }
 891 #if 0
 892         if (storage_needed == 0) {
 893             belch("no storage needed");
 894         }
 895 #endif
 896         symbol_table = (asymbol **) stgMallocBytes(storage_needed,"DEBUG_LoadSymbols");
 897
 898         number_of_symbols = bfd_canonicalize_symtab (abfd, symbol_table);
 899
 900         if (number_of_symbols < 0) {
 901             barf("can't canonicalise symbol table");
 902         }
 903
 904         for( i = 0; i != number_of_symbols; ++i ) {
 905             symbol_info info;
 906             bfd_get_symbol_info(abfd,symbol_table[i],&info);
 907             /*fprintf(stderr,"\t%c\t0x%x      \t%s\n",info.type,(nat)info.value,info.name); */
 908             if (isReal(info.type, info.name)) {
 909                 num_real_syms += 1;
 910             }
 911         }
 912
 913         IF_DEBUG(evaluator,
 914                  fprintf(stderr,"Loaded %ld symbols. Of which %ld are real symbols\n",
 915                          number_of_symbols, num_real_syms)
 916                  );
 917
 918         reset_table( num_real_syms );
 919
 920         for( i = 0; i != number_of_symbols; ++i ) {
 921             symbol_info info;
 922             bfd_get_symbol_info(abfd,symbol_table[i],&info);
 923             if (isReal(info.type, info.name)) {
 924                 insert( info.value, info.name );
 925             }
 926         }
 927
 928         free(symbol_table);
 929     }
 930     prepare_table();
 931 }
 932
 933 #else /* HAVE_BFD_H */
 934
 935 extern void DEBUG_LoadSymbols( char *name STG_UNUSED )
 936 {
 937   /* nothing, yet */
 938 }
 939
 940 #endif /* HAVE_BFD_H */
 941
 942 #include "StoragePriv.h"
 943
 944 void findPtr(P_ p, int);                /* keep gcc -Wall happy */
 945
 946 void
 947 findPtr(P_ p, int follow)
 948 {
 949   nat s, g;
 950   P_ q, r;
 951   bdescr *bd;
 952   const int arr_size = 1024;
 953   StgPtr arr[arr_size];
 954   int i = 0;
 955
 956   for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
 957       for (s = 0; s < generations[g].n_steps; s++) {
 958           if (RtsFlags.GcFlags.generations == 1) {
 959               bd = generations[g].steps[s].to_blocks;
 960           } else {
 961               bd = generations[g].steps[s].blocks;
 962           }
 963           for (; bd; bd = bd->link) {
 964               for (q = bd->start; q < bd->free; q++) {
 965                   if (*q == (W_)p) {
 966                       if (i < arr_size) {
 967                           r = q;
 968                           while (!LOOKS_LIKE_GHC_INFO(*r)) { r--; };
 969                           fprintf(stderr, "%p = ", r);
 970                           printClosure((StgClosure *)r);
 971                           arr[i++] = r;
 972                       } else {
 973                           return;
 974                       }
 975                   }
 976               }
 977           }
 978       }
 979   }
 980   if (follow && i == 1) {
 981       fprintf(stderr, "-->\n");
 982       findPtr(arr[0], 1);
 983   }
 984 }
 985
 986 #else /* DEBUG */
 987 void printPtr( StgPtr p )
 988 {
 989     fprintf(stderr, "ptr 0x%p (enable -DDEBUG for more info) " , p );
 990 }
 991
 992 void printObj( StgClosure *obj )
 993 {
 994     fprintf(stderr, "obj 0x%p (enable -DDEBUG for more info) " , obj );
 995 }
 996 #endif /* DEBUG */