ghc/rts/Stable.c

   1 /* -----------------------------------------------------------------------------
   2  * $Id: Stable.c,v 1.9 1999/10/26 17:15:39 sewardj Exp $
   3  *
   4  * (c) The GHC Team, 1998-1999
   5  *
   6  * Stable names and stable pointers.
   7  *
   8  * ---------------------------------------------------------------------------*/
   9
  10 #include "Rts.h"
  11 #include "Hash.h"
  12 #include "StablePriv.h"
  13 #include "GC.h"
  14 #include "RtsUtils.h"
  15 #include "Storage.h"
  16 #include "RtsAPI.h"
  17 #include "RtsFlags.h"
  18
  19 /* Comment from ADR's implementation in old RTS:
  20
  21   This files (together with @ghc/runtime/storage/PerformIO.lhc@ and a
  22   small change in @HpOverflow.lc@) consists of the changes in the
  23   runtime system required to implement "Stable Pointers". But we're
  24   getting a bit ahead of ourselves --- what is a stable pointer and what
  25   is it used for?
  26
  27   When Haskell calls C, it normally just passes over primitive integers,
  28   floats, bools, strings, etc.  This doesn't cause any problems at all
  29   for garbage collection because the act of passing them makes a copy
  30   from the heap, stack or wherever they are onto the C-world stack.
  31   However, if we were to pass a heap object such as a (Haskell) @String@
  32   and a garbage collection occured before we finished using it, we'd run
  33   into problems since the heap object might have been moved or even
  34   deleted.
  35
  36   So, if a C call is able to cause a garbage collection or we want to
  37   store a pointer to a heap object between C calls, we must be careful
  38   when passing heap objects. Our solution is to keep a table of all
  39   objects we've given to the C-world and to make sure that the garbage
  40   collector collects these objects --- updating the table as required to
  41   make sure we can still find the object.
  42
  43
  44   Of course, all this rather begs the question: why would we want to
  45   pass a boxed value?
  46
  47   One very good reason is to preserve laziness across the language
  48   interface. Rather than evaluating an integer or a string because it
  49   {\em might\/} be required by the C function, we can wait until the C
  50   function actually wants the value and then force an evaluation.
  51
  52   Another very good reason (the motivating reason!) is that the C code
  53   might want to execute an object of sort $IO ()$ for the side-effects
  54   it will produce. For example, this is used when interfacing to an X
  55   widgets library to allow a direct implementation of callbacks.
  56
  57
  58   The @makeStablePointer :: a -> IO (StablePtr a)@ function
  59   converts a value into a stable pointer.  It is part of the @PrimIO@
  60   monad, because we want to be sure we don't allocate one twice by
  61   accident, and then only free one of the copies.
  62
  63   \begin{verbatim}
  64   makeStablePtr#  :: a -> State# RealWorld -> (# RealWorld, a #)
  65   freeStablePtr#  :: StablePtr# a -> State# RealWorld -> State# RealWorld
  66   deRefStablePtr# :: StablePtr# a -> State# RealWorld ->
  67         (# State# RealWorld, a #)
  68   \end{verbatim}
  69   There is also a C procedure @FreeStablePtr@ which frees a stable pointer.
  70
  71   There may be additional functions on the C side to allow evaluation,
  72   application, etc of a stable pointer.
  73
  74   When Haskell calls C, it normally just passes over primitive integers,
  75   floats, bools, strings, etc.  This doesn't cause any problems at all
  76   for garbage collection because the act of passing them makes a copy
  77   from the heap, stack or wherever they are onto the C-world stack.
  78   However, if we were to pass a heap object such as a (Haskell) @String@
  79   and a garbage collection occured before we finished using it, we'd run
  80   into problems since the heap object might have been moved or even
  81   deleted.
  82
  83   So, if a C call is able to cause a garbage collection or we want to
  84   store a pointer to a heap object between C calls, we must be careful
  85   when passing heap objects. Our solution is to keep a table of all
  86   objects we've given to the C-world and to make sure that the garbage
  87   collector collects these objects --- updating the table as required to
  88   make sure we can still find the object.
  89 */
  90
  91 snEntry *stable_ptr_table;
  92 snEntry *stable_ptr_free;
  93
  94 unsigned int SPT_size;
  95
  96 /* This hash table maps Haskell objects to stable names, so that every
  97  * call to lookupStableName on a given object will return the same
  98  * stable name.
  99  *
 100  * Reference counting
 101  * ------------------
 102  * A plain stable name entry has a zero reference count, which means
 103  * the entry will dissappear when the object it points to is
 104  * unreachable.  For stable pointers, we need an entry that sticks
 105  * around and keeps the object it points to alive, so each stable name
 106  * entry has an associated reference count.
 107  *
 108  * A stable pointer has a weighted reference count N attached to it
 109  * (actually in its upper 5 bits), which represents the weight
 110  * 2^N.  The stable name entry keeps a 32-bit reference count, which
 111  * represents any weight between 1 and 2^32 (represented as zero).
 112  * When the weight is 2^32, the stable name table owns "all" of the
 113  * stable pointers to this object, and the entry can be garbage
 114  * collected if the object isn't reachable.
 115  *
 116  * A new stable pointer is given the weight log2(W/2), where W is the
 117  * weight stored in the table entry.  The new weight in the table is W
 118  * - 2^log2(W/2).
 119  *
 120  * A stable pointer can be "split" into two stable pointers, by
 121  * dividing the weight by 2 and giving each pointer half.
 122  * When freeing a stable pointer, the weight of the pointer is added
 123  * to the weight stored in the table entry.
 124  * */
 125
 126 HashTable *addrToStableHash;
 127
 128 #define INIT_SPT_SIZE 64
 129
 130 static inline void
 131 initFreeList(snEntry *table, nat n, snEntry *free)
 132 {
 133   snEntry *p;
 134
 135   for (p = table + n - 1; p >= table; p--) {
 136     p->addr   = (P_)free;
 137     p->weight = 0;
 138     p->sn_obj = NULL;
 139     free = p;
 140   }
 141   stable_ptr_free = table;
 142 }
 143
 144 void
 145 initStablePtrTable(void)
 146 {
 147   /* the table will be allocated the first time makeStablePtr is
 148    * called */
 149   stable_ptr_table = NULL;
 150   stable_ptr_free  = NULL;
 151   addrToStableHash = NULL;
 152   SPT_size = 0;
 153 }
 154
 155 StgWord
 156 lookupStableName(StgPtr p)
 157 {
 158   StgWord sn;
 159
 160   if (stable_ptr_free == NULL) {
 161     enlargeStablePtrTable();
 162   }
 163
 164   (void *)sn = lookupHashTable(addrToStableHash,(W_)p);
 165
 166   if (sn != 0) {
 167     ASSERT(stable_ptr_table[sn].addr == p);
 168     IF_DEBUG(stable,fprintf(stderr,"cached stable name %d at %p\n",sn,p));
 169     return sn;
 170   } else {
 171     sn = stable_ptr_free - stable_ptr_table;
 172     (P_)stable_ptr_free  = stable_ptr_free->addr;
 173     stable_ptr_table[sn].weight = 0;
 174     stable_ptr_table[sn].addr = p;
 175     stable_ptr_table[sn].sn_obj = NULL;
 176     /* IF_DEBUG(stable,fprintf(stderr,"new stable name %d at
 177        %p\n",sn,p)); */
 178
 179     /* add the new stable name to the hash table */
 180     insertHashTable(addrToStableHash, (W_)p, (void *)sn);
 181
 182     return sn;
 183   }
 184 }
 185
 186 static inline void
 187 freeStableName(snEntry *sn)
 188 {
 189   ASSERT(sn->sn_obj == NULL);
 190   if (sn->addr != NULL) {
 191     removeHashTable(addrToStableHash, (W_)sn->addr, NULL);
 192   }
 193   sn->addr = (P_)stable_ptr_free;
 194   stable_ptr_free = sn;
 195 }
 196
 197 StgStablePtr
 198 getStablePtr(StgPtr p)
 199 {
 200   StgWord sn = lookupStableName(p);
 201   StgWord weight, weight_2;
 202   weight = stable_ptr_table[sn].weight;
 203   if (weight == 0) {
 204     weight = (StgWord)1 << (BITS_IN(StgWord)-1);
 205     stable_ptr_table[sn].weight = weight;
 206     return (StgStablePtr)(sn + ((BITS_IN(StgWord)-1) << STABLEPTR_WEIGHT_SHIFT));
 207   }
 208   else if (weight == 1) {
 209     barf("getStablePtr: too light");
 210   }
 211   else {
 212     weight /= 2;
 213     /* find log2(weight) */
 214     for (weight_2 = 1; weight != 1; weight_2++) {
 215       weight >>= 1;
 216     }
 217     stable_ptr_table[sn].weight -= 2^weight_2;
 218     return (StgStablePtr)(sn + (weight_2 << STABLEPTR_WEIGHT_SHIFT));
 219   }
 220 }
 221
 222 void
 223 enlargeStablePtrTable(void)
 224 {
 225   nat old_SPT_size = SPT_size;
 226
 227   if (SPT_size == 0) {
 228     /* 1st time */
 229     SPT_size = INIT_SPT_SIZE;
 230     stable_ptr_table = stgMallocWords(SPT_size * sizeof(snEntry),
 231                                       "initStablePtrTable");
 232
 233     /* we don't use index 0 in the stable name table, because that
 234      * would conflict with the hash table lookup operations which
 235      * return NULL if an entry isn't found in the hash table.
 236      */
 237     initFreeList(stable_ptr_table+1,INIT_SPT_SIZE-1,NULL);
 238     addrToStableHash = allocHashTable();
 239   }
 240   else {
 241     /* 2nd and subsequent times */
 242     SPT_size *= 2;
 243     stable_ptr_table =
 244       stgReallocWords(stable_ptr_table, SPT_size * sizeof(snEntry),
 245                       "enlargeStablePtrTable");
 246
 247     initFreeList(stable_ptr_table + old_SPT_size, old_SPT_size, NULL);
 248   }
 249 }
 250
 251 /* -----------------------------------------------------------------------------
 252  * Treat stable pointers as roots for the garbage collector.
 253  *
 254  * A stable pointer is any stable name entry with a weight > 0.  We'll
 255  * take the opportunity to zero the "keep" flags at the same time.
 256  * -------------------------------------------------------------------------- */
 257
 258 void
 259 markStablePtrTable(rtsBool full)
 260 {
 261   snEntry *p, *end_stable_ptr_table;
 262   StgPtr q;
 263   StgClosure *new;
 264
 265   if (SPT_size == 0)
 266     return;
 267
 268   if (full) {
 269     freeHashTable(addrToStableHash,NULL);
 270     addrToStableHash = allocHashTable();
 271   }
 272
 273   end_stable_ptr_table = &stable_ptr_table[SPT_size];
 274
 275   /* Mark all the stable *pointers* (not stable names).
 276    * _starting_ at index 1; index 0 is unused.
 277    */
 278   for (p = stable_ptr_table+1; p < end_stable_ptr_table; p++) {
 279     q = p->addr;
 280     /* internal pointers or NULL are free slots
 281      */
 282     if (q && (q < (P_)stable_ptr_table || q >= (P_)end_stable_ptr_table)) {
 283       if (p->weight != 0) {
 284         new = MarkRoot((StgClosure *)q);
 285         /* Update the hash table */
 286         if (full) {
 287           insertHashTable(addrToStableHash, (W_)new,
 288                           (void *)(p - stable_ptr_table));
 289           (StgClosure *)p->addr = new;
 290         } else if ((P_)new != q) {
 291           removeHashTable(addrToStableHash, (W_)q, NULL);
 292           if (!lookupHashTable(addrToStableHash, (W_)new)) {
 293             insertHashTable(addrToStableHash, (W_)new,
 294                             (void *)(p - stable_ptr_table));
 295           }
 296           (StgClosure *)p->addr = new;
 297         }
 298         IF_DEBUG(stable, fprintf(stderr,"Stable ptr %d still alive at %p, weight %d\n", p - stable_ptr_table, new, p->weight));
 299       }
 300     }
 301   }
 302 }
 303
 304 /* -----------------------------------------------------------------------------
 305  * Garbage collect any dead entries in the stable pointer table.
 306  *
 307  * A dead entry has:
 308  *
 309  *          - a weight of zero (i.e. 2^32)
 310  *          - a dead sn_obj
 311  *
 312  * Both of these conditions must be true in order to re-use the stable
 313  * name table entry.  We can re-use stable name table entries for live
 314  * heap objects, as long as the program has no StableName objects that
 315  * refer to the entry.
 316  *
 317  * The boolean argument 'full' indicates that a major collection is
 318  * being done, so we might as well throw away the hash table and build
 319  * a new one.  For a minor collection, we just re-hash the elements
 320  * that changed.
 321  * -------------------------------------------------------------------------- */
 322
 323 void
 324 gcStablePtrTable(rtsBool full)
 325 {
 326   snEntry *p, *end_stable_ptr_table;
 327   StgPtr q, new;
 328
 329   if (SPT_size == 0) {
 330     return;
 331   }
 332
 333   end_stable_ptr_table = &stable_ptr_table[SPT_size];
 334
 335   /* NOTE: _starting_ at index 1; index 0 is unused. */
 336   for (p = stable_ptr_table + 1; p < end_stable_ptr_table; p++) {
 337
 338     /* Update the pointer to the StableName object, if there is one */
 339     if (p->sn_obj != NULL) {
 340       p->sn_obj = isAlive(p->sn_obj);
 341     }
 342
 343     q = p->addr;
 344     if (q && (q < (P_)stable_ptr_table || q >= (P_)end_stable_ptr_table)) {
 345
 346       /* We're only interested in Stable Names here.  The weight != 0
 347        * case is handled in markStablePtrTable above.
 348        */
 349       if (p->weight == 0) {
 350
 351         if (p->sn_obj == NULL) {
 352           /* StableName object is dead */
 353           freeStableName(p);
 354           IF_DEBUG(stable, fprintf(stderr,"GC'd Stable name %d\n", p - stable_ptr_table));
 355         }
 356         else {
 357           (StgClosure *)new = isAlive((StgClosure *)q);
 358           IF_DEBUG(stable, fprintf(stderr,"Stable name %d still alive at %p, weight %d\n", p - stable_ptr_table, new, p->weight));
 359
 360           if (new == NULL) {
 361             /* The target has been garbage collected.  Remove its
 362              * entry from the hash table.
 363              */
 364             removeHashTable(addrToStableHash, (W_)q, NULL);
 365
 366           } else {
 367             /* Target still alive, Re-hash this stable name
 368              */
 369             if (full) {
 370               insertHashTable(addrToStableHash, (W_)new, (void *)(p - stable_ptr_table));
 371             } else if (new != q) {
 372               removeHashTable(addrToStableHash, (W_)q, NULL);
 373               insertHashTable(addrToStableHash, (W_)new, (void *)(p - stable_ptr_table));
 374             }
 375           }
 376
 377           /* finally update the address of the target to point to its
 378            * new location.
 379            */
 380           p->addr = new;
 381         }
 382       }
 383     }
 384   }
 385 }