ghc/rts/Stable.c

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