RTS tidyup sweep, first phase

[ghc-hetmet.git] / rts / sm / Storage.h

diff --git a/rts/sm/Storage.h b/rts/sm/Storage.h
new file mode 100644 (file)
index 0000000..c6aa45e
--- /dev/null
+++ b/rts/sm/Storage.h
@@ -0,0 +1,169 @@
+/* -----------------------------------------------------------------------------
+ *
+ * (c) The GHC Team, 1998-2009
+ *
+ * External Storage Manger Interface
+ *
+ * ---------------------------------------------------------------------------*/
+
+#ifndef SM_STORAGE_H
+#define SM_STORAGE_H
+
+/* -----------------------------------------------------------------------------
+   Initialisation / De-initialisation
+   -------------------------------------------------------------------------- */
+
+void initStorage(void);
+void exitStorage(void);
+void freeStorage(void);
+
+/* -----------------------------------------------------------------------------
+   Storage manager state
+   -------------------------------------------------------------------------- */
+
+extern bdescr * pinned_object_block;
+
+extern nat alloc_blocks;
+extern nat alloc_blocks_lim;
+
+INLINE_HEADER rtsBool
+doYouWantToGC( void )
+{
+  return (alloc_blocks >= alloc_blocks_lim);
+}
+
+/* for splitting blocks groups in two */
+bdescr * splitLargeBlock (bdescr *bd, nat blocks);
+
+/* -----------------------------------------------------------------------------
+   Generational garbage collection support
+
+   recordMutable(StgPtr p)       Informs the garbage collector that a
+                                previously immutable object has
+                                become (permanently) mutable.  Used
+                                by thawArray and similar.
+
+   updateWithIndirection(p1,p2)  Updates the object at p1 with an
+                                indirection pointing to p2.  This is
+                                normally called for objects in an old
+                                generation (>0) when they are updated.
+
+   updateWithPermIndirection(p1,p2)  As above but uses a permanent indir.
+
+   -------------------------------------------------------------------------- */
+
+/*
+ * Storage manager mutex
+ */
+#if defined(THREADED_RTS)
+extern Mutex sm_mutex;
+#endif
+
+#if defined(THREADED_RTS)
+#define ACQUIRE_SM_LOCK   ACQUIRE_LOCK(&sm_mutex);
+#define RELEASE_SM_LOCK   RELEASE_LOCK(&sm_mutex);
+#define ASSERT_SM_LOCK()  ASSERT_LOCK_HELD(&sm_mutex);
+#else
+#define ACQUIRE_SM_LOCK
+#define RELEASE_SM_LOCK
+#define ASSERT_SM_LOCK()
+#endif
+
+INLINE_HEADER void
+recordMutableGen(StgClosure *p, nat gen_no)
+{
+    bdescr *bd;
+
+    bd = generations[gen_no].mut_list;
+    if (bd->free >= bd->start + BLOCK_SIZE_W) {
+       bdescr *new_bd;
+       new_bd = allocBlock();
+       new_bd->link = bd;
+       bd = new_bd;
+       generations[gen_no].mut_list = bd;
+    }
+    *bd->free++ = (StgWord)p;
+
+}
+
+INLINE_HEADER void
+recordMutableGenLock(StgClosure *p, nat gen_no)
+{
+    ACQUIRE_SM_LOCK;
+    recordMutableGen(p,gen_no);
+    RELEASE_SM_LOCK;
+}
+
+INLINE_HEADER void
+recordMutable(StgClosure *p)
+{
+    bdescr *bd;
+    ASSERT(closure_MUTABLE(p));
+    bd = Bdescr((P_)p);
+    if (bd->gen_no > 0) recordMutableGen(p, bd->gen_no);
+}
+
+INLINE_HEADER void
+recordMutableLock(StgClosure *p)
+{
+    ACQUIRE_SM_LOCK;
+    recordMutable(p);
+    RELEASE_SM_LOCK;
+}
+
+/* -----------------------------------------------------------------------------
+   This is the write barrier for MUT_VARs, a.k.a. IORefs.  A
+   MUT_VAR_CLEAN object is not on the mutable list; a MUT_VAR_DIRTY
+   is.  When written to, a MUT_VAR_CLEAN turns into a MUT_VAR_DIRTY
+   and is put on the mutable list.
+   -------------------------------------------------------------------------- */
+
+void dirty_MUT_VAR(StgRegTable *reg, StgClosure *p);
+
+/* -----------------------------------------------------------------------------
+   Similarly, the write barrier for MVARs
+   -------------------------------------------------------------------------- */
+
+void dirty_MVAR(StgRegTable *reg, StgClosure *p);
+
+/* -----------------------------------------------------------------------------
+   Nursery manipulation
+   -------------------------------------------------------------------------- */
+
+void     resetNurseries       ( void );
+void     resizeNurseries      ( nat blocks );
+void     resizeNurseriesFixed ( nat blocks );
+lnat     countNurseryBlocks   ( void );
+
+/* -----------------------------------------------------------------------------
+   Stats 'n' DEBUG stuff
+   -------------------------------------------------------------------------- */
+
+extern ullong total_allocated;
+
+lnat    calcAllocated  (void);
+lnat    calcLiveBlocks (void);
+lnat    calcLiveWords  (void);
+lnat    countOccupied  (bdescr *bd);
+lnat    calcNeeded     (void);
+HsInt64 getAllocations (void);
+
+#if defined(DEBUG)
+void    memInventory       (rtsBool show);
+void    checkSanity        (void);
+nat     countBlocks        (bdescr *);
+void    checkNurserySanity (step *stp);
+#endif
+
+/* ----------------------------------------------------------------------------
+   Storage manager internal APIs and globals
+   ------------------------------------------------------------------------- */
+
+#define END_OF_STATIC_LIST ((StgClosure*)1)
+
+void move_TSO  (StgTSO *src, StgTSO *dest);
+
+extern StgClosure * caf_list;
+extern StgClosure * revertible_caf_list;
+
+#endif /* SM_STORAGE_H */