rts/Stable.c

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2002
   4  *
   5  * Stable names and stable pointers.
   6  *
   7  * ---------------------------------------------------------------------------*/
   8
   9 // Make static versions of inline functions in Stable.h:
  10 #define RTS_STABLE_C
  11
  12 #include "PosixSource.h"
  13 #include "Rts.h"
  14 #include "Hash.h"
  15 #include "RtsUtils.h"
  16 #include "OSThreads.h"
  17 #include "Storage.h"
  18 #include "RtsAPI.h"
  19 #include "RtsFlags.h"
  20 #include "OSThreads.h"
  21 #include "Trace.h"
  22 #include "Stable.h"
  23
  24 /* Comment from ADR's implementation in old RTS:
  25
  26   This files (together with @ghc/runtime/storage/PerformIO.lhc@ and a
  27   small change in @HpOverflow.lc@) consists of the changes in the
  28   runtime system required to implement "Stable Pointers". But we're
  29   getting a bit ahead of ourselves --- what is a stable pointer and what
  30   is it used for?
  31
  32   When Haskell calls C, it normally just passes over primitive integers,
  33   floats, bools, strings, etc.  This doesn't cause any problems at all
  34   for garbage collection because the act of passing them makes a copy
  35   from the heap, stack or wherever they are onto the C-world stack.
  36   However, if we were to pass a heap object such as a (Haskell) @String@
  37   and a garbage collection occured before we finished using it, we'd run
  38   into problems since the heap object might have been moved or even
  39   deleted.
  40
  41   So, if a C call is able to cause a garbage collection or we want to
  42   store a pointer to a heap object between C calls, we must be careful
  43   when passing heap objects. Our solution is to keep a table of all
  44   objects we've given to the C-world and to make sure that the garbage
  45   collector collects these objects --- updating the table as required to
  46   make sure we can still find the object.
  47
  48
  49   Of course, all this rather begs the question: why would we want to
  50   pass a boxed value?
  51
  52   One very good reason is to preserve laziness across the language
  53   interface. Rather than evaluating an integer or a string because it
  54   {\em might\/} be required by the C function, we can wait until the C
  55   function actually wants the value and then force an evaluation.
  56
  57   Another very good reason (the motivating reason!) is that the C code
  58   might want to execute an object of sort $IO ()$ for the side-effects
  59   it will produce. For example, this is used when interfacing to an X
  60   widgets library to allow a direct implementation of callbacks.
  61
  62
  63   The @makeStablePointer :: a -> IO (StablePtr a)@ function
  64   converts a value into a stable pointer.  It is part of the @PrimIO@
  65   monad, because we want to be sure we don't allocate one twice by
  66   accident, and then only free one of the copies.
  67
  68   \begin{verbatim}
  69   makeStablePtr#  :: a -> State# RealWorld -> (# RealWorld, a #)
  70   freeStablePtr#  :: StablePtr# a -> State# RealWorld -> State# RealWorld
  71   deRefStablePtr# :: StablePtr# a -> State# RealWorld ->
  72         (# State# RealWorld, a #)
  73   \end{verbatim}
  74
  75   There may be additional functions on the C side to allow evaluation,
  76   application, etc of a stable pointer.
  77
  78 */
  79
  80 snEntry *stable_ptr_table = NULL;
  81 static snEntry *stable_ptr_free = NULL;
  82
  83 static unsigned int SPT_size = 0;
  84
  85 #ifdef THREADED_RTS
  86 static Mutex stable_mutex;
  87 #endif
  88
  89 /* This hash table maps Haskell objects to stable names, so that every
  90  * call to lookupStableName on a given object will return the same
  91  * stable name.
  92  *
  93  * OLD COMMENTS about reference counting follow.  The reference count
  94  * in a stable name entry is now just a counter.
  95  *
  96  * Reference counting
  97  * ------------------
  98  * A plain stable name entry has a zero reference count, which means
  99  * the entry will dissappear when the object it points to is
 100  * unreachable.  For stable pointers, we need an entry that sticks
 101  * around and keeps the object it points to alive, so each stable name
 102  * entry has an associated reference count.
 103  *
 104  * A stable pointer has a weighted reference count N attached to it
 105  * (actually in its upper 5 bits), which represents the weight
 106  * 2^(N-1).  The stable name entry keeps a 32-bit reference count, which
 107  * represents any weight between 1 and 2^32 (represented as zero).
 108  * When the weight is 2^32, the stable name table owns "all" of the
 109  * stable pointers to this object, and the entry can be garbage
 110  * collected if the object isn't reachable.
 111  *
 112  * A new stable pointer is given the weight log2(W/2), where W is the
 113  * weight stored in the table entry.  The new weight in the table is W
 114  * - 2^log2(W/2).
 115  *
 116  * A stable pointer can be "split" into two stable pointers, by
 117  * dividing the weight by 2 and giving each pointer half.
 118  * When freeing a stable pointer, the weight of the pointer is added
 119  * to the weight stored in the table entry.
 120  * */
 121
 122 static HashTable *addrToStableHash = NULL;
 123
 124 #define INIT_SPT_SIZE 64
 125
 126 STATIC_INLINE void
 127 initFreeList(snEntry *table, nat n, snEntry *free)
 128 {
 129   snEntry *p;
 130
 131   for (p = table + n - 1; p >= table; p--) {
 132     p->addr   = (P_)free;
 133     p->old    = NULL;
 134     p->ref    = 0;
 135     p->sn_obj = NULL;
 136     free = p;
 137   }
 138   stable_ptr_free = table;
 139 }
 140
 141 void
 142 initStablePtrTable(void)
 143 {
 144         if (SPT_size > 0)
 145                 return;
 146
 147     SPT_size = INIT_SPT_SIZE;
 148     stable_ptr_table = stgMallocBytes(SPT_size * sizeof(snEntry),
 149                                       "initStablePtrTable");
 150
 151     /* we don't use index 0 in the stable name table, because that
 152      * would conflict with the hash table lookup operations which
 153      * return NULL if an entry isn't found in the hash table.
 154      */
 155     initFreeList(stable_ptr_table+1,INIT_SPT_SIZE-1,NULL);
 156     addrToStableHash = allocHashTable();
 157
 158 #ifdef THREADED_RTS
 159     initMutex(&stable_mutex);
 160 #endif
 161 }
 162
 163 void
 164 exitStablePtrTable(void)
 165 {
 166   if (addrToStableHash)
 167     freeHashTable(addrToStableHash, NULL);
 168   addrToStableHash = NULL;
 169   if (stable_ptr_table)
 170     stgFree(stable_ptr_table);
 171   stable_ptr_table = NULL;
 172   SPT_size = 0;
 173 #ifdef THREADED_RTS
 174   closeMutex(&stable_mutex);
 175 #endif
 176 }
 177
 178 /*
 179  * get at the real stuff...remove indirections.
 180  * It untags pointers before dereferencing and
 181  * retags the real stuff with its tag (if there
 182  * is any) when returning.
 183  *
 184  * ToDo: move to a better home.
 185  */
 186 static
 187 StgClosure*
 188 removeIndirections(StgClosure* p)
 189 {
 190   StgWord tag = GET_CLOSURE_TAG(p);
 191   StgClosure* q = UNTAG_CLOSURE(p);
 192
 193   while (get_itbl(q)->type == IND ||
 194          get_itbl(q)->type == IND_STATIC ||
 195          get_itbl(q)->type == IND_OLDGEN ||
 196          get_itbl(q)->type == IND_PERM ||
 197          get_itbl(q)->type == IND_OLDGEN_PERM ) {
 198       q = ((StgInd *)q)->indirectee;
 199       tag = GET_CLOSURE_TAG(q);
 200       q = UNTAG_CLOSURE(q);
 201   }
 202
 203   return TAG_CLOSURE(tag,q);
 204 }
 205
 206 static StgWord
 207 lookupStableName_(StgPtr p)
 208 {
 209   StgWord sn;
 210   void* sn_tmp;
 211
 212   if (stable_ptr_free == NULL) {
 213     enlargeStablePtrTable();
 214   }
 215
 216   /* removing indirections increases the likelihood
 217    * of finding a match in the stable name hash table.
 218    */
 219   p = (StgPtr)removeIndirections((StgClosure*)p);
 220
 221   // register the untagged pointer.  This just makes things simpler.
 222   p = (StgPtr)UNTAG_CLOSURE((StgClosure*)p);
 223
 224   sn_tmp = lookupHashTable(addrToStableHash,(W_)p);
 225   sn = (StgWord)sn_tmp;
 226
 227   if (sn != 0) {
 228     ASSERT(stable_ptr_table[sn].addr == p);
 229     debugTrace(DEBUG_stable, "cached stable name %ld at %p",sn,p);
 230     return sn;
 231   } else {
 232     sn = stable_ptr_free - stable_ptr_table;
 233     stable_ptr_free  = (snEntry*)(stable_ptr_free->addr);
 234     stable_ptr_table[sn].ref = 0;
 235     stable_ptr_table[sn].addr = p;
 236     stable_ptr_table[sn].sn_obj = NULL;
 237     /* debugTrace(DEBUG_stable, "new stable name %d at %p\n",sn,p); */
 238
 239     /* add the new stable name to the hash table */
 240     insertHashTable(addrToStableHash, (W_)p, (void *)sn);
 241
 242     return sn;
 243   }
 244 }
 245
 246 StgWord
 247 lookupStableName(StgPtr p)
 248 {
 249     StgWord res;
 250
 251     initStablePtrTable();
 252     ACQUIRE_LOCK(&stable_mutex);
 253     res = lookupStableName_(p);
 254     RELEASE_LOCK(&stable_mutex);
 255     return res;
 256 }
 257
 258 STATIC_INLINE void
 259 freeStableName(snEntry *sn)
 260 {
 261   ASSERT(sn->sn_obj == NULL);
 262   if (sn->addr != NULL) {
 263       removeHashTable(addrToStableHash, (W_)sn->addr, NULL);
 264   }
 265   sn->addr = (P_)stable_ptr_free;
 266   stable_ptr_free = sn;
 267 }
 268
 269 StgStablePtr
 270 getStablePtr(StgPtr p)
 271 {
 272   StgWord sn;
 273
 274   initStablePtrTable();
 275   ACQUIRE_LOCK(&stable_mutex);
 276   sn = lookupStableName_(p);
 277   stable_ptr_table[sn].ref++;
 278   RELEASE_LOCK(&stable_mutex);
 279   return (StgStablePtr)(sn);
 280 }
 281
 282 void
 283 freeStablePtr(StgStablePtr sp)
 284 {
 285     snEntry *sn;
 286
 287         initStablePtrTable();
 288     ACQUIRE_LOCK(&stable_mutex);
 289
 290     sn = &stable_ptr_table[(StgWord)sp];
 291
 292     ASSERT((StgWord)sp < SPT_size  &&  sn->addr != NULL  &&  sn->ref > 0);
 293
 294     sn->ref--;
 295
 296     // If this entry has no StableName attached, then just free it
 297     // immediately.  This is important; it might be a while before the
 298     // next major GC which actually collects the entry.
 299     if (sn->sn_obj == NULL && sn->ref == 0) {
 300         freeStableName(sn);
 301     }
 302
 303     RELEASE_LOCK(&stable_mutex);
 304 }
 305
 306 void
 307 enlargeStablePtrTable(void)
 308 {
 309   nat old_SPT_size = SPT_size;
 310
 311     // 2nd and subsequent times
 312   SPT_size *= 2;
 313   stable_ptr_table =
 314     stgReallocBytes(stable_ptr_table,
 315                       SPT_size * sizeof(snEntry),
 316                       "enlargeStablePtrTable");
 317
 318   initFreeList(stable_ptr_table + old_SPT_size, old_SPT_size, NULL);
 319 }
 320
 321 /* -----------------------------------------------------------------------------
 322  * Treat stable pointers as roots for the garbage collector.
 323  *
 324  * A stable pointer is any stable name entry with a ref > 0.  We'll
 325  * take the opportunity to zero the "keep" flags at the same time.
 326  * -------------------------------------------------------------------------- */
 327
 328 void
 329 markStablePtrTable(evac_fn evac, void *user)
 330 {
 331     snEntry *p, *end_stable_ptr_table;
 332     StgPtr q;
 333
 334     end_stable_ptr_table = &stable_ptr_table[SPT_size];
 335
 336     // Mark all the stable *pointers* (not stable names).
 337     // _starting_ at index 1; index 0 is unused.
 338     for (p = stable_ptr_table+1; p < end_stable_ptr_table; p++) {
 339         q = p->addr;
 340
 341         // Internal pointers are free slots.  If q == NULL, it's a
 342         // stable name where the object has been GC'd, but the
 343         // StableName object (sn_obj) is still alive.
 344         if (q && (q < (P_)stable_ptr_table || q >= (P_)end_stable_ptr_table)) {
 345
 346             // save the current addr away: we need to be able to tell
 347             // whether the objects moved in order to be able to update
 348             // the hash table later.
 349             p->old = p->addr;
 350
 351             // if the ref is non-zero, treat addr as a root
 352             if (p->ref != 0) {
 353                 evac(user, (StgClosure **)&p->addr);
 354             }
 355         }
 356     }
 357 }
 358
 359 /* -----------------------------------------------------------------------------
 360  * Thread the stable pointer table for compacting GC.
 361  *
 362  * Here we must call the supplied evac function for each pointer into
 363  * the heap from the stable pointer table, because the compacting
 364  * collector may move the object it points to.
 365  * -------------------------------------------------------------------------- */
 366
 367 void
 368 threadStablePtrTable( evac_fn evac, void *user )
 369 {
 370     snEntry *p, *end_stable_ptr_table;
 371     StgPtr q;
 372
 373     end_stable_ptr_table = &stable_ptr_table[SPT_size];
 374
 375     for (p = stable_ptr_table+1; p < end_stable_ptr_table; p++) {
 376
 377         if (p->sn_obj != NULL) {
 378             evac(user, (StgClosure **)&p->sn_obj);
 379         }
 380
 381         q = p->addr;
 382         if (q && (q < (P_)stable_ptr_table || q >= (P_)end_stable_ptr_table)) {
 383             evac(user, (StgClosure **)&p->addr);
 384         }
 385     }
 386 }
 387
 388 /* -----------------------------------------------------------------------------
 389  * Garbage collect any dead entries in the stable pointer table.
 390  *
 391  * A dead entry has:
 392  *
 393  *          - a zero reference count
 394  *          - a dead sn_obj
 395  *
 396  * Both of these conditions must be true in order to re-use the stable
 397  * name table entry.  We can re-use stable name table entries for live
 398  * heap objects, as long as the program has no StableName objects that
 399  * refer to the entry.
 400  * -------------------------------------------------------------------------- */
 401
 402 void
 403 gcStablePtrTable( void )
 404 {
 405     snEntry *p, *end_stable_ptr_table;
 406     StgPtr q;
 407
 408     end_stable_ptr_table = &stable_ptr_table[SPT_size];
 409
 410     // NOTE: _starting_ at index 1; index 0 is unused.
 411     for (p = stable_ptr_table + 1; p < end_stable_ptr_table; p++) {
 412
 413         // Update the pointer to the StableName object, if there is one
 414         if (p->sn_obj != NULL) {
 415             p->sn_obj = isAlive(p->sn_obj);
 416         }
 417
 418         // Internal pointers are free slots.  If q == NULL, it's a
 419         // stable name where the object has been GC'd, but the
 420         // StableName object (sn_obj) is still alive.
 421         q = p->addr;
 422         if (q && (q < (P_)stable_ptr_table || q >= (P_)end_stable_ptr_table)) {
 423
 424             // StableNames only:
 425             if (p->ref == 0) {
 426                 if (p->sn_obj == NULL) {
 427                     // StableName object is dead
 428                     freeStableName(p);
 429                     debugTrace(DEBUG_stable, "GC'd Stable name %ld",
 430                                (long)(p - stable_ptr_table));
 431                     continue;
 432
 433                 } else {
 434                   p->addr = (StgPtr)isAlive((StgClosure *)p->addr);
 435                   debugTrace(DEBUG_stable,
 436                              "stable name %ld still alive at %p, ref %ld\n",
 437                              (long)(p - stable_ptr_table), p->addr, p->ref);
 438                 }
 439             }
 440         }
 441     }
 442 }
 443
 444 /* -----------------------------------------------------------------------------
 445  * Update the StablePtr/StableName hash table
 446  *
 447  * The boolean argument 'full' indicates that a major collection is
 448  * being done, so we might as well throw away the hash table and build
 449  * a new one.  For a minor collection, we just re-hash the elements
 450  * that changed.
 451  * -------------------------------------------------------------------------- */
 452
 453 void
 454 updateStablePtrTable(rtsBool full)
 455 {
 456     snEntry *p, *end_stable_ptr_table;
 457
 458     if (full && addrToStableHash != NULL) {
 459         freeHashTable(addrToStableHash,NULL);
 460         addrToStableHash = allocHashTable();
 461     }
 462
 463     end_stable_ptr_table = &stable_ptr_table[SPT_size];
 464
 465     // NOTE: _starting_ at index 1; index 0 is unused.
 466     for (p = stable_ptr_table + 1; p < end_stable_ptr_table; p++) {
 467
 468         if (p->addr == NULL) {
 469             if (p->old != NULL) {
 470                 // The target has been garbage collected.  Remove its
 471                 // entry from the hash table.
 472                 removeHashTable(addrToStableHash, (W_)p->old, NULL);
 473                 p->old = NULL;
 474             }
 475         }
 476         else if (p->addr < (P_)stable_ptr_table
 477                  || p->addr >= (P_)end_stable_ptr_table) {
 478             // Target still alive, Re-hash this stable name
 479             if (full) {
 480                 insertHashTable(addrToStableHash, (W_)p->addr,
 481                                 (void *)(p - stable_ptr_table));
 482             } else if (p->addr != p->old) {
 483                 removeHashTable(addrToStableHash, (W_)p->old, NULL);
 484                 insertHashTable(addrToStableHash, (W_)p->addr,
 485                                 (void *)(p - stable_ptr_table));
 486             }
 487         }
 488     }
 489 }