ghc/rts/Stable.c

   1 /* -----------------------------------------------------------------------------
   2  * $Id: Stable.c,v 1.5 1999/07/16 09:53:44 panne 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   sn->addr = (P_)stable_ptr_free;
 191   stable_ptr_free = sn;
 192 }
 193
 194 StgStablePtr
 195 getStablePtr(StgPtr p)
 196 {
 197   StgWord sn = lookupStableName(p);
 198   StgWord weight, weight_2;
 199
 200   weight = stable_ptr_table[sn].weight;
 201   if (weight == 0) {
 202     weight = (StgWord)1 << (BITS_IN(StgWord)-1);
 203     stable_ptr_table[sn].weight = weight;
 204     return (StgStablePtr)(sn + ((BITS_IN(StgWord)-1) << STABLEPTR_WEIGHT_SHIFT));
 205   }
 206   else if (weight == 1) {
 207     barf("getStablePtr: too light");
 208   }
 209   else {
 210     weight /= 2;
 211     /* find log2(weight) */
 212     for (weight_2 = 1; weight != 1; weight_2++) {
 213       weight >>= 1;
 214     }
 215     stable_ptr_table[sn].weight -= 2^weight_2;
 216     return (StgStablePtr)(sn + (weight_2 << STABLEPTR_WEIGHT_SHIFT));
 217   }
 218 }
 219
 220 void
 221 enlargeStablePtrTable(void)
 222 {
 223   nat old_SPT_size = SPT_size;
 224
 225   if (SPT_size == 0) {
 226     /* 1st time */
 227     SPT_size = INIT_SPT_SIZE;
 228     stable_ptr_table = stgMallocWords(SPT_size * sizeof(snEntry),
 229                                       "initStablePtrTable");
 230
 231     initFreeList(stable_ptr_table,INIT_SPT_SIZE,NULL);
 232     addrToStableHash = allocHashTable();
 233   }
 234   else {
 235     /* 2nd and subsequent times */
 236     SPT_size *= 2;
 237     stable_ptr_table =
 238       stgReallocWords(stable_ptr_table, SPT_size * sizeof(snEntry),
 239                       "enlargeStablePtrTable");
 240
 241     initFreeList(stable_ptr_table + old_SPT_size, old_SPT_size, NULL);
 242   }
 243 }
 244
 245 /* -----------------------------------------------------------------------------
 246  * Treat stable pointers as roots for the garbage collector.
 247  *
 248  * A stable pointer is any stable name entry with a weight > 0.  We'll
 249  * take the opportunity to zero the "keep" flags at the same time.
 250  * -------------------------------------------------------------------------- */
 251
 252 void
 253 markStablePtrTable(rtsBool full)
 254 {
 255   snEntry *p, *end_stable_ptr_table;
 256   StgPtr q;
 257   StgClosure *new;
 258
 259   if (SPT_size == 0)
 260     return;
 261
 262   if (full) {
 263     freeHashTable(addrToStableHash,NULL);
 264     addrToStableHash = allocHashTable();
 265   }
 266
 267   end_stable_ptr_table = &stable_ptr_table[SPT_size];
 268
 269   /* Mark all the stable *pointers* (not stable names)
 270    */
 271   for (p = stable_ptr_table; p < end_stable_ptr_table; p++) {
 272     q = p->addr;
 273     /* internal pointers or NULL are free slots
 274      */
 275     if (q && (q < (P_)stable_ptr_table || q >= (P_)end_stable_ptr_table)) {
 276       if (p->weight != 0) {
 277         new = MarkRoot((StgClosure *)q);
 278         /* Update the hash table */
 279         if (full) {
 280           insertHashTable(addrToStableHash, (W_)new,
 281                           (void *)(p - stable_ptr_table));
 282           (StgClosure *)p->addr = new;
 283         } else if ((P_)new != q) {
 284           removeHashTable(addrToStableHash, (W_)q, NULL);
 285           insertHashTable(addrToStableHash, (W_)new,
 286                           (void *)(p - stable_ptr_table));
 287           (StgClosure *)p->addr = new;
 288         }
 289         IF_DEBUG(stable, fprintf(stderr,"Stable ptr %d still alive at %p, weight %d\n", p - stable_ptr_table, new, p->weight));
 290       }
 291     }
 292   }
 293 }
 294
 295 /* -----------------------------------------------------------------------------
 296  * Garbage collect any dead entries in the stable pointer table.
 297  *
 298  * A dead entry has:
 299  *
 300  *          - a weight of zero (i.e. 2^32)
 301  *          - a dead sn_obj
 302  *
 303  * Both of these conditions must be true in order to re-use the stable
 304  * name table entry.  We can re-use stable name table entries for live
 305  * heap objects, as long as the program has no StableName objects that
 306  * refer to the entry.
 307  *
 308  * The boolean argument 'full' indicates that a major collection is
 309  * being done, so we might as well throw away the hash table and build
 310  * a new one.  For a minor collection, we just re-hash the elements
 311  * that changed.
 312  * -------------------------------------------------------------------------- */
 313
 314 void
 315 gcStablePtrTable(rtsBool full)
 316 {
 317   snEntry *p, *end_stable_ptr_table;
 318   StgPtr q, new;
 319
 320   if (SPT_size == 0) {
 321     return;
 322   }
 323
 324   end_stable_ptr_table = &stable_ptr_table[SPT_size];
 325
 326   for (p = stable_ptr_table; p < end_stable_ptr_table; p++) {
 327
 328     /* Update the pointer to the StableName object, if there is one */
 329     if (p->sn_obj != NULL) {
 330       p->sn_obj = isAlive(p->sn_obj);
 331     }
 332
 333     q = p->addr;
 334     if (q && (q < (P_)stable_ptr_table || q >= (P_)end_stable_ptr_table)) {
 335
 336       /* We're only interested in Stable Names here.  The weight != 0
 337        * case is handled in markStablePtrTable above.
 338        */
 339       if (p->weight == 0) {
 340
 341         if (p->sn_obj == NULL) {
 342           /* StableName object is dead */
 343           freeStableName(p);
 344           IF_DEBUG(stable, fprintf(stderr,"GC'd Stable name %d\n", p - stable_ptr_table));
 345         }
 346         else {
 347           (StgClosure *)new = isAlive((StgClosure *)q);
 348           IF_DEBUG(stable, fprintf(stderr,"Stable name %d still alive at %p, weight %d\n", p - stable_ptr_table, new, p->weight));
 349
 350           p->addr = new;
 351           if (new != NULL) {
 352             /* Re-hash this stable name */
 353             if (full) {
 354               insertHashTable(addrToStableHash, (W_)new, (void *)(p - stable_ptr_table));
 355             } else if (new != q) {
 356               removeHashTable(addrToStableHash, (W_)q, NULL);
 357               insertHashTable(addrToStableHash, (W_)new, (void *)(p - stable_ptr_table));
 358             }
 359           }
 360         }
 361       }
 362     }
 363   }
 364 }