ghc/rts/Stable.c

   1 /* -----------------------------------------------------------------------------
   2  * $Id: Stable.c,v 1.13 2000/09/04 15:17:03 simonmar 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-1).  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 /*
 156  * get at the real stuff...remove indirections.
 157  *
 158  * ToDo: move to a better home.
 159  */
 160 static
 161 StgClosure*
 162 removeIndirections(StgClosure* p)
 163 {
 164   StgClosure* q = p;
 165
 166   while (get_itbl(q)->type == IND ||
 167          get_itbl(q)->type == IND_STATIC ||
 168          get_itbl(q)->type == IND_OLDGEN ||
 169          get_itbl(q)->type == IND_PERM ||
 170          get_itbl(q)->type == IND_OLDGEN_PERM ) {
 171       q = ((StgInd *)q)->indirectee;
 172   }
 173   return q;
 174 }
 175
 176 StgWord
 177 lookupStableName(StgPtr p)
 178 {
 179   StgWord sn;
 180
 181   if (stable_ptr_free == NULL) {
 182     enlargeStablePtrTable();
 183   }
 184
 185   /* removing indirections increases the likelihood
 186    * of finding a match in the stable name
 187    * hash table.
 188    */
 189   p = (StgPtr)removeIndirections((StgClosure*)p);
 190
 191   (void *)sn = lookupHashTable(addrToStableHash,(W_)p);
 192
 193   if (sn != 0) {
 194     ASSERT(stable_ptr_table[sn].addr == p);
 195     IF_DEBUG(stable,fprintf(stderr,"cached stable name %d at %p\n",sn,p));
 196     return sn;
 197   } else {
 198     sn = stable_ptr_free - stable_ptr_table;
 199     (P_)stable_ptr_free  = stable_ptr_free->addr;
 200     stable_ptr_table[sn].weight = 0;
 201     stable_ptr_table[sn].addr = p;
 202     stable_ptr_table[sn].sn_obj = NULL;
 203     /* IF_DEBUG(stable,fprintf(stderr,"new stable name %d at
 204        %p\n",sn,p)); */
 205
 206     /* add the new stable name to the hash table */
 207     insertHashTable(addrToStableHash, (W_)p, (void *)sn);
 208
 209     return sn;
 210   }
 211 }
 212
 213 static inline void
 214 freeStableName(snEntry *sn)
 215 {
 216   ASSERT(sn->sn_obj == NULL);
 217   if (sn->addr != NULL) {
 218     removeHashTable(addrToStableHash, (W_)sn->addr, NULL);
 219   }
 220   sn->addr = (P_)stable_ptr_free;
 221   stable_ptr_free = sn;
 222 }
 223
 224 StgStablePtr
 225 getStablePtr(StgPtr p)
 226 {
 227   StgWord sn = lookupStableName(p);
 228   StgWord weight, n;
 229   weight = stable_ptr_table[sn].weight;
 230   if (weight == 0) {
 231     weight = (StgWord)1 << (BITS_IN(StgWord)-1);
 232     stable_ptr_table[sn].weight = weight;
 233     return (StgStablePtr)(sn + (BITS_IN(StgWord) << STABLEPTR_WEIGHT_SHIFT));
 234   }
 235   else if (weight == 1) {
 236     barf("getStablePtr: too light");
 237   }
 238   else {
 239     weight /= 2;
 240     /* find log2(weight) */
 241     for (n = 0; weight != 1; n++) {
 242       weight >>= 1;
 243     }
 244     stable_ptr_table[sn].weight -= 1 << n;
 245     return (StgStablePtr)(sn + ((n+1) << STABLEPTR_WEIGHT_SHIFT));
 246   }
 247 }
 248
 249 void
 250 enlargeStablePtrTable(void)
 251 {
 252   nat old_SPT_size = SPT_size;
 253
 254   if (SPT_size == 0) {
 255     /* 1st time */
 256     SPT_size = INIT_SPT_SIZE;
 257     stable_ptr_table = stgMallocWords(SPT_size * sizeof(snEntry),
 258                                       "initStablePtrTable");
 259
 260     /* we don't use index 0 in the stable name table, because that
 261      * would conflict with the hash table lookup operations which
 262      * return NULL if an entry isn't found in the hash table.
 263      */
 264     initFreeList(stable_ptr_table+1,INIT_SPT_SIZE-1,NULL);
 265     addrToStableHash = allocHashTable();
 266   }
 267   else {
 268     /* 2nd and subsequent times */
 269     SPT_size *= 2;
 270     stable_ptr_table =
 271       stgReallocWords(stable_ptr_table, SPT_size * sizeof(snEntry),
 272                       "enlargeStablePtrTable");
 273
 274     initFreeList(stable_ptr_table + old_SPT_size, old_SPT_size, NULL);
 275   }
 276 }
 277
 278 /* -----------------------------------------------------------------------------
 279  * Treat stable pointers as roots for the garbage collector.
 280  *
 281  * A stable pointer is any stable name entry with a weight > 0.  We'll
 282  * take the opportunity to zero the "keep" flags at the same time.
 283  * -------------------------------------------------------------------------- */
 284
 285 void
 286 markStablePtrTable(rtsBool full)
 287 {
 288   snEntry *p, *end_stable_ptr_table;
 289   StgPtr q;
 290   StgClosure *new;
 291
 292   if (SPT_size == 0)
 293     return;
 294
 295   if (full) {
 296     freeHashTable(addrToStableHash,NULL);
 297     addrToStableHash = allocHashTable();
 298   }
 299
 300   end_stable_ptr_table = &stable_ptr_table[SPT_size];
 301
 302   /* Mark all the stable *pointers* (not stable names).
 303    * _starting_ at index 1; index 0 is unused.
 304    */
 305   for (p = stable_ptr_table+1; p < end_stable_ptr_table; p++) {
 306     q = p->addr;
 307     /* internal pointers or NULL are free slots
 308      */
 309     if (q && (q < (P_)stable_ptr_table || q >= (P_)end_stable_ptr_table)) {
 310       if (p->weight != 0) {
 311         new = MarkRoot((StgClosure *)q);
 312         /* Update the hash table */
 313         if (full) {
 314           insertHashTable(addrToStableHash, (W_)new,
 315                           (void *)(p - stable_ptr_table));
 316           (StgClosure *)p->addr = new;
 317         } else if ((P_)new != q) {
 318           removeHashTable(addrToStableHash, (W_)q, NULL);
 319           if (!lookupHashTable(addrToStableHash, (W_)new)) {
 320             insertHashTable(addrToStableHash, (W_)new,
 321                             (void *)(p - stable_ptr_table));
 322           }
 323           (StgClosure *)p->addr = new;
 324         }
 325         IF_DEBUG(stable, fprintf(stderr,"Stable ptr %d still alive at %p, weight %u\n", p - stable_ptr_table, new, p->weight));
 326       }
 327     }
 328   }
 329 }
 330
 331 /* -----------------------------------------------------------------------------
 332  * Garbage collect any dead entries in the stable pointer table.
 333  *
 334  * A dead entry has:
 335  *
 336  *          - a weight of zero (i.e. 2^32)
 337  *          - a dead sn_obj
 338  *
 339  * Both of these conditions must be true in order to re-use the stable
 340  * name table entry.  We can re-use stable name table entries for live
 341  * heap objects, as long as the program has no StableName objects that
 342  * refer to the entry.
 343  *
 344  * The boolean argument 'full' indicates that a major collection is
 345  * being done, so we might as well throw away the hash table and build
 346  * a new one.  For a minor collection, we just re-hash the elements
 347  * that changed.
 348  * -------------------------------------------------------------------------- */
 349
 350 void
 351 gcStablePtrTable(rtsBool full)
 352 {
 353   snEntry *p, *end_stable_ptr_table;
 354   StgPtr q, new;
 355
 356   if (SPT_size == 0) {
 357     return;
 358   }
 359
 360   end_stable_ptr_table = &stable_ptr_table[SPT_size];
 361
 362   /* NOTE: _starting_ at index 1; index 0 is unused. */
 363   for (p = stable_ptr_table + 1; p < end_stable_ptr_table; p++) {
 364
 365     /* Update the pointer to the StableName object, if there is one */
 366     if (p->sn_obj != NULL) {
 367       p->sn_obj = isAlive(p->sn_obj);
 368     }
 369
 370     q = p->addr;
 371     if (q && (q < (P_)stable_ptr_table || q >= (P_)end_stable_ptr_table)) {
 372
 373       /* We're only interested in Stable Names here.  The weight != 0
 374        * case is handled in markStablePtrTable above.
 375        */
 376       if (p->weight == 0) {
 377
 378         if (p->sn_obj == NULL) {
 379           /* StableName object is dead */
 380           freeStableName(p);
 381           IF_DEBUG(stable, fprintf(stderr,"GC'd Stable name %d\n", p - stable_ptr_table));
 382         }
 383         else {
 384           (StgClosure *)new = isAlive((StgClosure *)q);
 385           IF_DEBUG(stable, fprintf(stderr,"Stable name %d still alive at %p, weight %d\n", p - stable_ptr_table, new, p->weight));
 386
 387           if (new == NULL) {
 388             /* The target has been garbage collected.  Remove its
 389              * entry from the hash table.
 390              */
 391             removeHashTable(addrToStableHash, (W_)q, NULL);
 392
 393           } else {
 394             /* Target still alive, Re-hash this stable name
 395              */
 396             if (full) {
 397               insertHashTable(addrToStableHash, (W_)new, (void *)(p - stable_ptr_table));
 398             } else if (new != q) {
 399               removeHashTable(addrToStableHash, (W_)q, NULL);
 400               insertHashTable(addrToStableHash, (W_)new, (void *)(p - stable_ptr_table));
 401             }
 402           }
 403
 404           /* finally update the address of the target to point to its
 405            * new location.
 406            */
 407           p->addr = new;
 408         }
 409       }
 410     }
 411   }
 412 }