-{-# OPTIONS -fno-implicit-prelude #-}
+{-# OPTIONS_GHC -fno-implicit-prelude #-}
-----------------------------------------------------------------------------
-- |
-- Module : GHC.ForeignPtr
--
-----------------------------------------------------------------------------
+-- #hide
module GHC.ForeignPtr
(
ForeignPtr(..),
import Control.Monad ( sequence_ )
import Foreign.Ptr
import Foreign.Storable
-import Data.Typeable
import GHC.List ( null )
import GHC.Base
import GHC.IOBase
+import GHC.STRef ( STRef(..) )
import GHC.Ptr ( Ptr(..) )
import GHC.Err
import GHC.Show
-- type argument of 'ForeignPtr' should normally be an instance of
-- class 'Storable'.
--
-data ForeignPtr a
- = ForeignPtr ForeignObj# !(IORef [IO ()])
+data ForeignPtr a = ForeignPtr Addr# ForeignPtrContents
+ -- we cache the Addr# in the ForeignPtr object, but attach
+ -- the finalizer to the IORef (or the MutableByteArray# in
+ -- the case of a MallocPtr). The aim of the representation
+ -- is to make withForeignPtr efficient; in fact, withForeignPtr
+ -- should be just as efficient as unpacking a Ptr, and multiple
+ -- withForeignPtrs can share an unpacked ForeignPtr. Note
+ -- that touchForeignPtr only has to touch the ForeignPtrContents
+ -- object, because that ensures that whatever the finalizer is
+ -- attached to is kept alive.
+
+data ForeignPtrContents
+ = PlainForeignPtr !(IORef [IO ()])
| MallocPtr (MutableByteArray# RealWorld) !(IORef [IO ()])
instance Eq (ForeignPtr a) where
instance Show (ForeignPtr a) where
showsPrec p f = showsPrec p (unsafeForeignPtrToPtr f)
-#include "Typeable.h"
-INSTANCE_TYPEABLE1(ForeignPtr,foreignPtrTc,"ForeignPtr")
-
-- |A Finalizer is represented as a pointer to a foreign function that, at
-- finalisation time, gets as an argument a plain pointer variant of the
-- foreign pointer that the finalizer is associated with.
-- in fact there is no guarantee that the finalizer will eventually
-- run at all.
--
+-- Note that references from a finalizer do not necessarily prevent
+-- another object from being finalized. If A's finalizer refers to B
+-- (perhaps using 'touchForeignPtr', then the only guarantee is that
+-- B's finalizer will never be started before A's. If both A and B
+-- are unreachable, then both finalizers will start together. See
+-- 'touchForeignPtr' for more on finalizer ordering.
+--
newConcForeignPtr p finalizer
= do fObj <- newForeignPtr_ p
addForeignPtrConcFinalizer fObj finalizer
-- assume that the memory returned by 'mallocForeignPtr' has been
-- allocated with 'Foreign.Marshal.Alloc.malloc'.
mallocForeignPtr = doMalloc undefined
- where doMalloc :: Storable a => a -> IO (ForeignPtr a)
+ where doMalloc :: Storable b => b -> IO (ForeignPtr b)
doMalloc a = do
r <- newIORef []
IO $ \s ->
case newPinnedByteArray# size s of { (# s, mbarr# #) ->
- (# s, MallocPtr mbarr# r #)
+ (# s, ForeignPtr (byteArrayContents# (unsafeCoerce# mbarr#))
+ (MallocPtr mbarr# r) #)
}
where (I# size) = sizeOf a
r <- newIORef []
IO $ \s ->
case newPinnedByteArray# size s of { (# s, mbarr# #) ->
- (# s, MallocPtr mbarr# r #)
+ (# s, ForeignPtr (byteArrayContents# (unsafeCoerce# mbarr#))
+ (MallocPtr mbarr# r) #)
}
addForeignPtrFinalizer :: FinalizerPtr a -> ForeignPtr a -> IO ()
-- are finalized objects, so a finalizer should not refer to a 'Handle'
-- (including @stdout@, @stdin@ or @stderr@).
--
-addForeignPtrConcFinalizer f@(ForeignPtr fo r) finalizer = do
+addForeignPtrConcFinalizer (ForeignPtr a c) finalizer =
+ addForeignPtrConcFinalizer_ c finalizer
+
+addForeignPtrConcFinalizer_ f@(PlainForeignPtr r) finalizer = do
fs <- readIORef r
writeIORef r (finalizer : fs)
if (null fs)
then IO $ \s ->
- let p = unsafeForeignPtrToPtr f in
- case mkWeak# fo () (foreignPtrFinalizer r p) s of
- (# s1, w #) -> (# s1, () #)
+ case r of { IORef (STRef r#) ->
+ case mkWeak# r# () (foreignPtrFinalizer r) s of { (# s1, w #) ->
+ (# s1, () #) }}
else return ()
-addForeignPtrConcFinalizer f@(MallocPtr fo r) finalizer = do
+addForeignPtrConcFinalizer_ f@(MallocPtr fo r) finalizer = do
fs <- readIORef r
writeIORef r (finalizer : fs)
if (null fs)
then IO $ \s ->
- let p = unsafeForeignPtrToPtr f in
- case mkWeak# fo () (do foreignPtrFinalizer r p
- touchPinnedByteArray# fo) s of
+ case mkWeak# fo () (do foreignPtrFinalizer r; touch f) s of
(# s1, w #) -> (# s1, () #)
else return ()
foreign import ccall "dynamic"
mkFinalizer :: FinalizerPtr a -> Ptr a -> IO ()
-foreignPtrFinalizer :: IORef [IO ()] -> Ptr a -> IO ()
-foreignPtrFinalizer r p = do
- fs <- readIORef r
- sequence_ fs
+foreignPtrFinalizer :: IORef [IO ()] -> IO ()
+foreignPtrFinalizer r = do fs <- readIORef r; sequence_ fs
newForeignPtr_ :: Ptr a -> IO (ForeignPtr a)
-- ^Turns a plain memory reference into a foreign pointer that may be
-- associated with finalizers by using 'addForeignPtrFinalizer'.
newForeignPtr_ (Ptr obj) = do
r <- newIORef []
- IO $ \ s# ->
- case mkForeignObj# obj s# of
- (# s1#, fo# #) -> (# s1#, ForeignPtr fo# r #)
-
-touchPinnedByteArray# :: MutableByteArray# RealWorld -> IO ()
-touchPinnedByteArray# ba# = IO $ \s -> case touch# ba# s of s -> (# s, () #)
+ return (ForeignPtr obj (PlainForeignPtr r))
touchForeignPtr :: ForeignPtr a -> IO ()
-- ^This function ensures that the foreign object in
-- does a 'touchForeignPtr' after it
-- executes the user action.
--
--- Note that this function should not be used to express liveness
--- dependencies between 'ForeignPtr's. For example, if the finalizer
+-- Note that this function should not be used to express dependencies
+-- between finalizers on 'ForeignPtr's. For example, if the finalizer
-- for a 'ForeignPtr' @F1@ calls 'touchForeignPtr' on a second
-- 'ForeignPtr' @F2@, then the only guarantee is that the finalizer
-- for @F2@ is never started before the finalizer for @F1@. They
-- between the finalizers, but even then the runtime sometimes runs
-- multiple finalizers sequentially in a single thread (for
-- performance reasons), so synchronisation between finalizers could
--- result in artificial deadlock.
+-- result in artificial deadlock. Another alternative is to use
+-- explicit reference counting.
--
-touchForeignPtr (ForeignPtr fo r)
- = IO $ \s -> case touch# fo s of s -> (# s, () #)
-touchForeignPtr (MallocPtr fo r)
- = touchPinnedByteArray# fo
+touchForeignPtr (ForeignPtr fo r) = touch r
+
+touch r = IO $ \s -> case touch# r s of s -> (# s, () #)
unsafeForeignPtrToPtr :: ForeignPtr a -> Ptr a
-- ^This function extracts the pointer component of a foreign
-- than combinations of 'unsafeForeignPtrToPtr' and
-- 'touchForeignPtr'. However, the later routines
-- are occasionally preferred in tool generated marshalling code.
-unsafeForeignPtrToPtr (ForeignPtr fo r) = Ptr (foreignObjToAddr# fo)
-unsafeForeignPtrToPtr (MallocPtr fo r) = Ptr (byteArrayContents# (unsafeCoerce# fo))
+unsafeForeignPtrToPtr (ForeignPtr fo r) = Ptr fo
castForeignPtr :: ForeignPtr a -> ForeignPtr b
-- ^This function casts a 'ForeignPtr'
-- parameterised by one type into another type.
castForeignPtr f = unsafeCoerce# f
--- | Causes a the finalizers associated with a foreign pointer to be run
+-- | Causes the finalizers associated with a foreign pointer to be run
-- immediately.
finalizeForeignPtr :: ForeignPtr a -> IO ()
-finalizeForeignPtr foreignPtr = do
+finalizeForeignPtr (ForeignPtr _ foreignPtr) = do
finalizers <- readIORef refFinalizers
sequence_ finalizers
writeIORef refFinalizers []
where
refFinalizers = case foreignPtr of
- (ForeignPtr _ ref) -> ref
+ (PlainForeignPtr ref) -> ref
(MallocPtr _ ref) -> ref
projects / haskell-directory.git / blobdiff