includes/Stable.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2004
   4  *
   5  * Stable Pointers: A stable pointer is represented as an index into
   6  * the stable pointer table in the low BITS_PER_WORD-8 bits with a
   7  * weight in the upper 8 bits.
   8  *
   9  * SUP: StgStablePtr used to be a synonym for StgWord, but stable pointers
  10  * are guaranteed to be void* on the C-side, so we have to do some occasional
  11  * casting. Size is not a matter, because StgWord is always the same size as
  12  * a void*.
  13  *
  14  * ---------------------------------------------------------------------------*/
  15
  16 #ifndef STABLE_H
  17 #define STABLE_H
  18
  19 /* -----------------------------------------------------------------------------
  20    External C Interface
  21    -------------------------------------------------------------------------- */
  22
  23 EXTERN_INLINE StgPtr  deRefStablePtr(StgStablePtr stable_ptr);
  24 extern void           freeStablePtr(StgStablePtr sp);
  25 extern StgStablePtr   splitStablePtr(StgStablePtr sp);
  26 extern StgStablePtr   getStablePtr(StgPtr p);
  27
  28 /* -----------------------------------------------------------------------------
  29    PRIVATE from here.
  30    -------------------------------------------------------------------------- */
  31
  32 typedef struct {
  33   StgPtr  addr;                 /* Haskell object, free list, or NULL */
  34   StgPtr  old;                  /* old Haskell object, used during GC */
  35   StgWord ref;                  /* used for reference counting */
  36   StgClosure *sn_obj;           /* the StableName object (or NULL) */
  37 } snEntry;
  38
  39 extern DLL_IMPORT_RTS snEntry *stable_ptr_table;
  40
  41 extern void freeStablePtr(StgStablePtr sp);
  42
  43 EXTERN_INLINE
  44 StgPtr deRefStablePtr(StgStablePtr sp)
  45 {
  46     ASSERT(stable_ptr_table[(StgWord)sp].ref > 0);
  47     return stable_ptr_table[(StgWord)sp].addr;
  48 }
  49
  50 extern void    initStablePtrTable    ( void );
  51 extern void    exitStablePtrTable    ( void );
  52 extern void    enlargeStablePtrTable ( void );
  53 extern StgWord lookupStableName      ( StgPtr p );
  54
  55 extern void    markStablePtrTable    ( evac_fn evac, void *user );
  56 extern void    threadStablePtrTable  ( evac_fn evac, void *user );
  57 extern void    gcStablePtrTable      ( void );
  58 extern void    updateStablePtrTable  ( rtsBool full );
  59
  60 extern void    stablePtrPreGC        ( void );
  61 extern void    stablePtrPostGC       ( void );
  62
  63 #endif