From: Simon Marlow <simonmar@microsoft.com>
Date: Thu, 19 Oct 2006 10:12:00 +0000 (+0000)
Subject: comments only: document allocateLocal()
X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=commitdiff_plain;h=fa4ee2f36b0b685c3cd1935f1a56bfb796aca0e2

comments only: document allocateLocal()
---

diff --git a/includes/Storage.h b/includes/Storage.h
index 1346715..09b1b04 100644
--- a/includes/Storage.h
+++ b/includes/Storage.h
@@ -118,6 +118,12 @@ extern void freeStorage(void);
    				n words long, returning a pointer to
 				the first word.  Always succeeds.
 				
+   StgPtr allocateLocal(Capability *cap, nat n)
+                                Allocates memory from the nursery in
+				the current Capability.  This can be
+				done without taking a global lock,
+                                unlike allocate().
+
    StgPtr allocatePinned(nat n) Allocates a chunk of contiguous store
    				n words long, which is at a fixed
 				address (won't be moved by GC).  
@@ -141,8 +147,6 @@ extern void freeStorage(void);
                                 via allocate() since the last GC.
 				Used in the reporting of statistics.
 
-   THREADED_RTS: allocate and doYouWantToGC can be used from STG code, they are
-   surrounded by a mutex.
    -------------------------------------------------------------------------- */
 
 extern StgPtr  allocate        ( nat n );