ghc/rts/Sanity.c

   1 /* -----------------------------------------------------------------------------
   2  * $Id: Sanity.c,v 1.3 1999/01/13 17:25:43 simonm Exp $
   3  *
   4  * Sanity checking code for the heap and stack.
   5  *
   6  * Used when debugging: check that the stack looks reasonable.
   7  *
   8  *    - All things that are supposed to be pointers look like pointers.
   9  *
  10  *    - Objects in text space are marked as static closures, those
  11  *      in the heap are dynamic.
  12  *
  13  * ---------------------------------------------------------------------------*/
  14
  15 #include "Rts.h"
  16
  17 #ifdef DEBUG
  18
  19 #include "RtsFlags.h"
  20 #include "RtsUtils.h"
  21 #include "BlockAlloc.h"
  22 #include "Sanity.h"
  23
  24 #define LOOKS_LIKE_PTR(r) \
  25   (IS_DATA_PTR(r) || ((IS_USER_PTR(r) && Bdescr((P_)r)->free != (void *)-1)))
  26
  27 /* -----------------------------------------------------------------------------
  28    Check stack sanity
  29    -------------------------------------------------------------------------- */
  30
  31 StgOffset checkStackClosure( StgClosure* c );
  32
  33 StgOffset checkStackObject( StgPtr sp );
  34
  35 void      checkStackChunk( StgPtr sp, StgPtr stack_end );
  36
  37 static StgOffset checkSmallBitmap(  StgPtr payload, StgNat32 bitmap );
  38
  39 static StgOffset checkLargeBitmap( StgPtr payload,
  40                                    StgLargeBitmap* large_bitmap );
  41
  42 void checkClosureShallow( StgClosure* p );
  43
  44 static StgOffset
  45 checkSmallBitmap( StgPtr payload, StgNat32 bitmap )
  46 {
  47     StgOffset i;
  48
  49     i = 0;
  50     for(; bitmap != 0; ++i, bitmap >>= 1 ) {
  51         if ((bitmap & 1) == 0) {
  52             checkClosure(stgCast(StgClosure*,payload[i]));
  53         }
  54     }
  55     return i;
  56 }
  57
  58
  59 static StgOffset
  60 checkLargeBitmap( StgPtr payload, StgLargeBitmap* large_bitmap )
  61 {
  62     StgNat32 bmp;
  63     StgOffset i;
  64
  65     i = 0;
  66     for (bmp=0; bmp<large_bitmap->size; bmp++) {
  67         StgNat32 bitmap = large_bitmap->bitmap[bmp];
  68         for(; bitmap != 0; ++i, bitmap >>= 1 ) {
  69             if ((bitmap & 1) == 0) {
  70                 checkClosure(stgCast(StgClosure*,payload[i]));
  71             }
  72         }
  73     }
  74     return i;
  75 }
  76
  77 StgOffset
  78 checkStackClosure( StgClosure* c )
  79 {
  80     const StgInfoTable* info = get_itbl(c);
  81
  82     /* All activation records have 'bitmap' style layout info. */
  83     switch (info->type) {
  84     case RET_DYN: /* Dynamic bitmap: the mask is stored on the stack */
  85         {
  86             StgRetDyn* r = stgCast(StgRetDyn*,c);
  87             return sizeofW(StgRetDyn) +
  88                    checkSmallBitmap(r->payload,r->liveness);
  89         }
  90     case RET_BCO: /* small bitmap (<= 32 entries) */
  91     case RET_SMALL:
  92     case RET_VEC_SMALL:
  93     case UPDATE_FRAME:
  94     case CATCH_FRAME:
  95     case STOP_FRAME:
  96     case SEQ_FRAME:
  97             return sizeofW(StgClosure) +
  98                    checkSmallBitmap((StgPtr)c->payload,info->layout.bitmap);
  99     case RET_BIG: /* large bitmap (> 32 entries) */
 100     case RET_VEC_BIG:
 101             return sizeofW(StgClosure) +
 102                    checkLargeBitmap((StgPtr)c->payload,
 103                                     info->layout.large_bitmap);
 104     case FUN:
 105     case FUN_STATIC: /* probably a slow-entry point return address: */
 106             return 1;
 107     default:
 108             /* if none of the above, maybe it's a closure which looks a
 109              * little like an infotable
 110              */
 111             checkClosureShallow(*stgCast(StgClosure**,c));
 112             return 1;
 113             /* barf("checkStackClosure: weird activation record found on stack (%p).",c); */
 114     }
 115 }
 116
 117 /*
 118  * check that it looks like a valid closure - without checking its payload
 119  * used to avoid recursion between checking PAPs and checking stack
 120  * chunks.
 121  */
 122
 123 void
 124 checkClosureShallow( StgClosure* p )
 125 {
 126     ASSERT(LOOKS_LIKE_GHC_INFO(p->header.info));
 127
 128     /* Is it a static closure (i.e. in the data segment)? */
 129     if (LOOKS_LIKE_STATIC(p)) {
 130         ASSERT(closure_STATIC(p));
 131     } else {
 132         ASSERT(!closure_STATIC(p));
 133         ASSERT(LOOKS_LIKE_PTR(p));
 134     }
 135 }
 136
 137 /* check an individual stack object */
 138 StgOffset
 139 checkStackObject( StgPtr sp )
 140 {
 141     if (IS_ARG_TAG(*sp)) {
 142         /* Tagged words might be "stubbed" pointers, so there's no
 143          * point checking to see whether they look like pointers or
 144          * not (some of them will).
 145          */
 146         return ARG_SIZE(*sp) + 1;
 147     } else if (LOOKS_LIKE_GHC_INFO(*stgCast(StgPtr*,sp))) {
 148         return checkStackClosure(stgCast(StgClosure*,sp));
 149     } else { /* must be an untagged closure pointer in the stack */
 150         checkClosureShallow(*stgCast(StgClosure**,sp));
 151         return 1;
 152     }
 153 }
 154
 155 /* check sections of stack between update frames */
 156 void
 157 checkStackChunk( StgPtr sp, StgPtr stack_end )
 158 {
 159     StgPtr p;
 160
 161     p = sp;
 162     while (p < stack_end) {
 163         p += checkStackObject( p );
 164     }
 165     ASSERT( p == stack_end );
 166 }
 167
 168 StgOffset
 169 checkClosure( StgClosure* p )
 170 {
 171     const StgInfoTable *info;
 172
 173 #ifndef INTERPRETER
 174     ASSERT(LOOKS_LIKE_GHC_INFO(p->header.info));
 175 #endif
 176
 177     /* Is it a static closure (i.e. in the data segment)? */
 178     if (LOOKS_LIKE_STATIC(p)) {
 179         ASSERT(closure_STATIC(p));
 180     } else {
 181         ASSERT(!closure_STATIC(p));
 182         ASSERT(LOOKS_LIKE_PTR(p));
 183     }
 184
 185     info = get_itbl(p);
 186     switch (info->type) {
 187     case BCO:
 188         {
 189             StgBCO* bco = stgCast(StgBCO*,p);
 190             nat i;
 191             for(i=0; i < bco->n_ptrs; ++i) {
 192                 ASSERT(LOOKS_LIKE_PTR(bcoConstPtr(bco,i)));
 193             }
 194             return bco_sizeW(bco);
 195         }
 196     case FUN:
 197     case THUNK:
 198     case CONSTR:
 199     case IND_PERM:
 200     case IND_OLDGEN:
 201     case IND_OLDGEN_PERM:
 202     case CAF_UNENTERED:
 203     case CAF_ENTERED:
 204     case CAF_BLACKHOLE:
 205     case BLACKHOLE:
 206     case FOREIGN:
 207     case MVAR:
 208     case MUT_VAR:
 209     case CONSTR_INTLIKE:
 210     case CONSTR_CHARLIKE:
 211     case CONSTR_STATIC:
 212     case CONSTR_NOCAF_STATIC:
 213     case THUNK_STATIC:
 214     case FUN_STATIC:
 215     case IND_STATIC:
 216         {
 217             nat i;
 218             for (i = 0; i < info->layout.payload.ptrs; i++) {
 219                 ASSERT(LOOKS_LIKE_PTR(payloadPtr(p,i)));
 220             }
 221             return sizeW_fromITBL(info);
 222         }
 223
 224     case WEAK:
 225       /* deal with these specially - the info table isn't
 226        * representative of the actual layout.
 227        */
 228       { StgWeak *w = (StgWeak *)p;
 229         ASSERT(LOOKS_LIKE_PTR(w->key));
 230         ASSERT(LOOKS_LIKE_PTR(w->value));
 231         ASSERT(LOOKS_LIKE_PTR(w->finaliser));
 232         if (w->link) {
 233           ASSERT(LOOKS_LIKE_PTR(w->link));
 234         }
 235         return sizeW_fromITBL(info);
 236       }
 237
 238     case THUNK_SELECTOR:
 239             ASSERT(LOOKS_LIKE_PTR(stgCast(StgSelector*,p)->selectee));
 240             return sizeofW(StgHeader) + MIN_UPD_SIZE;
 241
 242     case IND:
 243         {
 244             /* we don't expect to see any of these after GC
 245              * but they might appear during execution
 246              */
 247             P_ q;
 248             StgInd *ind = stgCast(StgInd*,p);
 249             ASSERT(LOOKS_LIKE_PTR(ind->indirectee));
 250             q = (P_)p + sizeofW(StgInd);
 251             while (!*q) { q++; }; /* skip padding words (see GC.c: evacuate())*/
 252             return q - (P_)p;
 253         }
 254
 255     case RET_BCO:
 256     case RET_SMALL:
 257     case RET_VEC_SMALL:
 258     case RET_BIG:
 259     case RET_VEC_BIG:
 260     case RET_DYN:
 261     case UPDATE_FRAME:
 262     case STOP_FRAME:
 263     case CATCH_FRAME:
 264     case SEQ_FRAME:
 265             barf("checkClosure: stack frame");
 266
 267     case AP_UPD: /* we can treat this as being the same as a PAP */
 268     case PAP:
 269         {
 270             StgPAP *pap = stgCast(StgPAP*,p);
 271             ASSERT(LOOKS_LIKE_PTR(pap->fun));
 272             checkStackChunk((StgPtr)pap->payload,
 273                             (StgPtr)pap->payload + pap->n_args
 274                             );
 275             return pap_sizeW(pap);
 276         }
 277
 278     case ARR_WORDS:
 279     case MUT_ARR_WORDS:
 280             return arr_words_sizeW(stgCast(StgArrWords*,p));
 281
 282     case MUT_ARR_PTRS:
 283     case MUT_ARR_PTRS_FROZEN:
 284         {
 285             StgMutArrPtrs* a = stgCast(StgMutArrPtrs*,p);
 286             nat i;
 287             for (i = 0; i < a->ptrs; i++) {
 288                 ASSERT(LOOKS_LIKE_PTR(a->payload[i]));
 289             }
 290             return mut_arr_ptrs_sizeW(a);
 291         }
 292
 293     case TSO:
 294         checkTSO((StgTSO *)p);
 295         return tso_sizeW((StgTSO *)p);
 296
 297     case BLOCKED_FETCH:
 298     case FETCH_ME:
 299     case EVACUATED:
 300             barf("checkClosure: unimplemented/strange closure type");
 301     default:
 302             barf("checkClosure");
 303     }
 304 #undef LOOKS_LIKE_PTR
 305 }
 306
 307 /* -----------------------------------------------------------------------------
 308    Check Heap Sanity
 309
 310    After garbage collection, the live heap is in a state where we can
 311    run through and check that all the pointers point to the right
 312    place.  This function starts at a given position and sanity-checks
 313    all the objects in the remainder of the chain.
 314    -------------------------------------------------------------------------- */
 315
 316 extern void
 317 checkHeap(bdescr *bd, StgPtr start)
 318 {
 319     StgPtr p;
 320
 321     if (start == NULL) {
 322       p = bd->start;
 323     } else {
 324       p = start;
 325     }
 326
 327     while (bd != NULL) {
 328       while (p < bd->free) {
 329         nat size = checkClosure(stgCast(StgClosure*,p));
 330         /* This is the smallest size of closure that can live in the heap. */
 331         ASSERT( size >= MIN_NONUPD_SIZE + sizeofW(StgHeader) );
 332         p += size;
 333         while (*p == 0) { p++; } /* skip over slop */
 334       }
 335       bd = bd->link;
 336       if (bd != NULL) {
 337         p = bd->start;
 338       }
 339     }
 340 }
 341
 342 extern void
 343 checkChain(bdescr *bd)
 344 {
 345   while (bd != NULL) {
 346     checkClosure((StgClosure *)bd->start);
 347     bd = bd->link;
 348   }
 349 }
 350
 351 /* check stack - making sure that update frames are linked correctly */
 352 void
 353 checkStack(StgPtr sp, StgPtr stack_end, StgUpdateFrame* su )
 354 {
 355     /* check everything down to the first update frame */
 356     checkStackChunk( sp, stgCast(StgPtr,su) );
 357     while ( stgCast(StgPtr,su) < stack_end) {
 358         sp = stgCast(StgPtr,su);
 359         switch (get_itbl(su)->type) {
 360         case UPDATE_FRAME:
 361                 su = su->link;
 362                 break;
 363         case SEQ_FRAME:
 364                 su = stgCast(StgSeqFrame*,su)->link;
 365                 break;
 366         case CATCH_FRAME:
 367                 su = stgCast(StgCatchFrame*,su)->link;
 368                 break;
 369         case STOP_FRAME:
 370                 /* not quite: ASSERT(stgCast(StgPtr,su) == stack_end); */
 371                 return;
 372         default:
 373                 barf("checkStack: weird record found on update frame list.");
 374         }
 375         checkStackChunk( sp, stgCast(StgPtr,su) );
 376     }
 377     ASSERT(stgCast(StgPtr,su) == stack_end);
 378 }
 379
 380 extern void
 381 checkTSO(StgTSO *tso)
 382 {
 383     StgPtr sp = tso->sp;
 384     StgPtr stack = tso->stack;
 385     StgUpdateFrame* su = tso->su;
 386     StgOffset stack_size = tso->stack_size;
 387     StgPtr stack_end = stack + stack_size;
 388
 389     if (tso->whatNext == ThreadComplete ||  tso->whatNext == ThreadKilled) {
 390       /* The garbage collector doesn't bother following any pointers
 391        * from dead threads, so don't check sanity here.
 392        */
 393       return;
 394     }
 395
 396     ASSERT(stack <= sp && sp < stack_end);
 397     ASSERT(sp <= stgCast(StgPtr,su));
 398
 399     checkStack(sp, stack_end, su);
 400 }
 401
 402 /* -----------------------------------------------------------------------------
 403    Check Blackhole Sanity
 404
 405    Test whether an object is already on the update list.
 406    It isn't necessarily an rts error if it is - it might be a programming
 407    error.
 408
 409    Future versions might be able to test for a blackhole without traversing
 410    the update frame list.
 411
 412    -------------------------------------------------------------------------- */
 413 rtsBool isBlackhole( StgTSO* tso, StgClosure* p )
 414 {
 415   StgUpdateFrame* su = tso->su;
 416   do {
 417     switch (get_itbl(su)->type) {
 418     case UPDATE_FRAME:
 419       if (su->updatee == p) {
 420         return rtsTrue;
 421       } else {
 422         su = su->link;
 423       }
 424       break;
 425     case SEQ_FRAME:
 426       su = stgCast(StgSeqFrame*,su)->link;
 427       break;
 428     case CATCH_FRAME:
 429       su = stgCast(StgCatchFrame*,su)->link;
 430       break;
 431     case STOP_FRAME:
 432       return rtsFalse;
 433     default:
 434       barf("isBlackhole: weird record found on update frame list.");
 435     }
 436   } while (1);
 437 }
 438
 439 #endif /* DEBUG */