-{-# OPTIONS_GHC -fno-implicit-prelude #-}
+{-# OPTIONS_GHC -XNoImplicitPrelude #-}
+{-# OPTIONS_HADDOCK hide #-}
-----------------------------------------------------------------------------
-- |
-- Module : GHC.ForeignPtr
-- #hide
module GHC.ForeignPtr
(
- ForeignPtr(..),
- FinalizerPtr,
- newForeignPtr_,
- mallocForeignPtr,
- mallocForeignPtrBytes,
- addForeignPtrFinalizer,
- touchForeignPtr,
- unsafeForeignPtrToPtr,
- castForeignPtr,
- newConcForeignPtr,
- addForeignPtrConcFinalizer,
- finalizeForeignPtr
+ ForeignPtr(..),
+ FinalizerPtr,
+ newForeignPtr_,
+ mallocForeignPtr,
+ mallocPlainForeignPtr,
+ mallocForeignPtrBytes,
+ mallocPlainForeignPtrBytes,
+ addForeignPtrFinalizer,
+ touchForeignPtr,
+ unsafeForeignPtrToPtr,
+ castForeignPtr,
+ newConcForeignPtr,
+ addForeignPtrConcFinalizer,
+ finalizeForeignPtr
) where
-import Control.Monad ( sequence_ )
+import Control.Monad ( sequence_ )
import Foreign.Storable
-import Numeric ( showHex )
+import Data.Typeable
import GHC.Show
-import GHC.Num
-import GHC.List ( null, replicate, length )
+import GHC.List ( null )
import GHC.Base
import GHC.IOBase
-import GHC.STRef ( STRef(..) )
-import GHC.Ptr ( Ptr(..), FunPtr, castFunPtrToPtr )
+import GHC.STRef ( STRef(..) )
+import GHC.Ptr ( Ptr(..), FunPtr )
import GHC.Err
+#include "Typeable.h"
+
-- |The type 'ForeignPtr' represents references to objects that are
-- maintained in a foreign language, i.e., that are not part of the
-- data structures usually managed by the Haskell storage manager.
-- class 'Storable'.
--
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.
+ -- 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.
+
+INSTANCE_TYPEABLE1(ForeignPtr,foreignPtrTc,"ForeignPtr")
-data ForeignPtrContents
+data ForeignPtrContents
= PlainForeignPtr !(IORef [IO ()])
- | MallocPtr (MutableByteArray# RealWorld) !(IORef [IO ()])
+ | MallocPtr (MutableByteArray# RealWorld) !(IORef [IO ()])
+ | PlainPtr (MutableByteArray# RealWorld)
instance Eq (ForeignPtr a) where
p == q = unsafeForeignPtrToPtr p == unsafeForeignPtrToPtr q
instance Show (ForeignPtr a) where
showsPrec p f = showsPrec p (unsafeForeignPtrToPtr f)
-#include "MachDeps.h"
-
-#if (WORD_SIZE_IN_BITS == 32 || WORD_SIZE_IN_BITS == 64)
-instance Show (Ptr a) where
- showsPrec p (Ptr a) rs = pad_out (showHex (word2Integer(int2Word#(addr2Int# a))) "") rs
- where
- -- want 0s prefixed to pad it out to a fixed length.
- pad_out ls rs =
- '0':'x':(replicate (2*SIZEOF_HSPTR - length ls) '0') ++ ls ++ rs
- -- word2Integer :: Word# -> Integer (stolen from Word.lhs)
- word2Integer w = case word2Integer# w of
- (# s, d #) -> J# s d
-
-instance Show (FunPtr a) where
- showsPrec p = showsPrec p . castFunPtrToPtr
-#endif
-- |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
mallocForeignPtr = doMalloc undefined
where doMalloc :: Storable b => b -> IO (ForeignPtr b)
doMalloc a = do
- r <- newIORef []
- IO $ \s ->
- case newPinnedByteArray# size s of { (# s, mbarr# #) ->
- (# s, ForeignPtr (byteArrayContents# (unsafeCoerce# mbarr#))
- (MallocPtr mbarr# r) #)
+ r <- newIORef []
+ IO $ \s ->
+ case newPinnedByteArray# size s of { (# s', mbarr# #) ->
+ (# s', ForeignPtr (byteArrayContents# (unsafeCoerce# mbarr#))
+ (MallocPtr mbarr# r) #)
}
- where (I# size) = sizeOf a
+ where (I# size) = sizeOf a
-- | This function is similar to 'mallocForeignPtr', except that the
-- size of the memory required is given explicitly as a number of bytes.
mallocForeignPtrBytes (I# size) = do
r <- newIORef []
IO $ \s ->
- case newPinnedByteArray# size s of { (# s, mbarr# #) ->
- (# s, ForeignPtr (byteArrayContents# (unsafeCoerce# mbarr#))
- (MallocPtr mbarr# r) #)
+ case newPinnedByteArray# size s of { (# s', mbarr# #) ->
+ (# s', ForeignPtr (byteArrayContents# (unsafeCoerce# mbarr#))
+ (MallocPtr mbarr# r) #)
+ }
+
+-- | Allocate some memory and return a 'ForeignPtr' to it. The memory
+-- will be released automatically when the 'ForeignPtr' is discarded.
+--
+-- GHC notes: 'mallocPlainForeignPtr' has a heavily optimised
+-- implementation in GHC. It uses pinned memory in the garbage
+-- collected heap, as for mallocForeignPtr. Unlike mallocForeignPtr, a
+-- ForeignPtr created with mallocPlainForeignPtr carries no finalizers.
+-- It is not possible to add a finalizer to a ForeignPtr created with
+-- mallocPlainForeignPtr. This is useful for ForeignPtrs that will live
+-- only inside Haskell (such as those created for packed strings).
+-- Attempts to add a finalizer to a ForeignPtr created this way, or to
+-- finalize such a pointer, will throw an exception.
+--
+mallocPlainForeignPtr :: Storable a => IO (ForeignPtr a)
+mallocPlainForeignPtr = doMalloc undefined
+ where doMalloc :: Storable b => b -> IO (ForeignPtr b)
+ doMalloc a = IO $ \s ->
+ case newPinnedByteArray# size s of { (# s', mbarr# #) ->
+ (# s', ForeignPtr (byteArrayContents# (unsafeCoerce# mbarr#))
+ (PlainPtr mbarr#) #)
+ }
+ where (I# size) = sizeOf a
+
+-- | This function is similar to 'mallocForeignPtrBytes', except that
+-- the internally an optimised ForeignPtr representation with no
+-- finalizer is used. Attempts to add a finalizer will cause an
+-- exception to be thrown.
+mallocPlainForeignPtrBytes :: Int -> IO (ForeignPtr a)
+mallocPlainForeignPtrBytes (I# size) = IO $ \s ->
+ case newPinnedByteArray# size s of { (# s', mbarr# #) ->
+ (# s', ForeignPtr (byteArrayContents# (unsafeCoerce# mbarr#))
+ (PlainPtr mbarr#) #)
}
addForeignPtrFinalizer :: FinalizerPtr a -> ForeignPtr a -> IO ()
-- object which have already been registered.
addForeignPtrFinalizer finalizer fptr =
addForeignPtrConcFinalizer fptr
- (mkFinalizer finalizer (unsafeForeignPtrToPtr fptr))
+ (mkFinalizer finalizer (unsafeForeignPtrToPtr fptr))
addForeignPtrConcFinalizer :: ForeignPtr a -> IO () -> IO ()
-- ^This function adds a finalizer to the given @ForeignPtr@. The
-- are finalized objects, so a finalizer should not refer to a 'Handle'
-- (including @stdout@, @stdin@ or @stderr@).
--
-addForeignPtrConcFinalizer (ForeignPtr a c) finalizer =
+addForeignPtrConcFinalizer (ForeignPtr _ c) finalizer =
addForeignPtrConcFinalizer_ c finalizer
-addForeignPtrConcFinalizer_ f@(PlainForeignPtr r) finalizer = do
+addForeignPtrConcFinalizer_ :: ForeignPtrContents -> IO () -> IO ()
+addForeignPtrConcFinalizer_ (PlainForeignPtr r) finalizer = do
fs <- readIORef r
writeIORef r (finalizer : fs)
if (null fs)
then IO $ \s ->
- case r of { IORef (STRef r#) ->
- case mkWeak# r# () (foreignPtrFinalizer r) s of { (# s1, w #) ->
- (# s1, () #) }}
+ case r of { IORef (STRef r#) ->
+ case mkWeak# r# () (foreignPtrFinalizer r) s of { (# s1, _ #) ->
+ (# s1, () #) }}
else return ()
addForeignPtrConcFinalizer_ f@(MallocPtr fo r) finalizer = do
fs <- readIORef r
writeIORef r (finalizer : fs)
if (null fs)
then IO $ \s ->
- case mkWeak# fo () (do foreignPtrFinalizer r; touch f) s of
- (# s1, w #) -> (# s1, () #)
+ case mkWeak# fo () (do foreignPtrFinalizer r; touch f) s of
+ (# s1, _ #) -> (# s1, () #)
else return ()
+addForeignPtrConcFinalizer_ _ _ =
+ error "GHC.ForeignPtr: attempt to add a finalizer to plain pointer"
+
foreign import ccall "dynamic"
mkFinalizer :: FinalizerPtr a -> Ptr a -> IO ()
-- result in artificial deadlock. Another alternative is to use
-- explicit reference counting.
--
-touchForeignPtr (ForeignPtr fo r) = touch r
+touchForeignPtr (ForeignPtr _ r) = touch r
-touch r = IO $ \s -> case touch# r s of s -> (# s, () #)
+touch :: ForeignPtrContents -> IO ()
+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 fo
+unsafeForeignPtrToPtr (ForeignPtr fo _) = Ptr fo
castForeignPtr :: ForeignPtr a -> ForeignPtr b
-- ^This function casts a 'ForeignPtr'
-- | Causes the finalizers associated with a foreign pointer to be run
-- immediately.
finalizeForeignPtr :: ForeignPtr a -> IO ()
+finalizeForeignPtr (ForeignPtr _ (PlainPtr _)) = return () -- no effect
finalizeForeignPtr (ForeignPtr _ foreignPtr) = do
- finalizers <- readIORef refFinalizers
- sequence_ finalizers
- writeIORef refFinalizers []
- where
- refFinalizers = case foreignPtr of
- (PlainForeignPtr ref) -> ref
- (MallocPtr _ ref) -> ref
+ finalizers <- readIORef refFinalizers
+ sequence_ finalizers
+ writeIORef refFinalizers []
+ where
+ refFinalizers = case foreignPtr of
+ (PlainForeignPtr ref) -> ref
+ (MallocPtr _ ref) -> ref
+ PlainPtr _ ->
+ error "finalizeForeignPtr PlainPtr"
+