SafeHaskell: Added SafeHaskell to base
[packages/base.git] / GHC / Stable.lhs
1 \begin{code}
2 {-# LANGUAGE NoImplicitPrelude
3            , MagicHash
4            , UnboxedTuples
5            , ForeignFunctionInterface
6   #-}
7 {-# OPTIONS_HADDOCK hide #-}
8
9 -----------------------------------------------------------------------------
10 -- |
11 -- Module      :  GHC.Stable
12 -- Copyright   :  (c) The University of Glasgow, 1992-2004
13 -- License     :  see libraries/base/LICENSE
14 -- 
15 -- Maintainer  :  ffi@haskell.org
16 -- Stability   :  internal
17 -- Portability :  non-portable (GHC Extensions)
18 --
19 -- Stable pointers.
20 --
21 -----------------------------------------------------------------------------
22
23 -- #hide
24 module GHC.Stable (
25         StablePtr(..),
26         newStablePtr,         -- :: a -> IO (StablePtr a)    
27         deRefStablePtr,       -- :: StablePtr a -> a
28         freeStablePtr,        -- :: StablePtr a -> IO ()
29         castStablePtrToPtr,   -- :: StablePtr a -> Ptr ()
30         castPtrToStablePtr    -- :: Ptr () -> StablePtr a
31     ) where
32
33 import GHC.Ptr
34 import GHC.Base
35
36 -----------------------------------------------------------------------------
37 -- Stable Pointers
38
39 {- |
40 A /stable pointer/ is a reference to a Haskell expression that is
41 guaranteed not to be affected by garbage collection, i.e., it will neither be
42 deallocated nor will the value of the stable pointer itself change during
43 garbage collection (ordinary references may be relocated during garbage
44 collection).  Consequently, stable pointers can be passed to foreign code,
45 which can treat it as an opaque reference to a Haskell value.
46
47 A value of type @StablePtr a@ is a stable pointer to a Haskell
48 expression of type @a@.
49 -}
50 data StablePtr a = StablePtr (StablePtr# a)
51
52 -- |
53 -- Create a stable pointer referring to the given Haskell value.
54 --
55 newStablePtr   :: a -> IO (StablePtr a)
56 newStablePtr a = IO $ \ s ->
57     case makeStablePtr# a s of (# s', sp #) -> (# s', StablePtr sp #)
58
59 -- |
60 -- Obtain the Haskell value referenced by a stable pointer, i.e., the
61 -- same value that was passed to the corresponding call to
62 -- 'makeStablePtr'.  If the argument to 'deRefStablePtr' has
63 -- already been freed using 'freeStablePtr', the behaviour of
64 -- 'deRefStablePtr' is undefined.
65 --
66 deRefStablePtr :: StablePtr a -> IO a
67 deRefStablePtr (StablePtr sp) = IO $ \s -> deRefStablePtr# sp s
68
69 -- |
70 -- Dissolve the association between the stable pointer and the Haskell
71 -- value. Afterwards, if the stable pointer is passed to
72 -- 'deRefStablePtr' or 'freeStablePtr', the behaviour is
73 -- undefined.  However, the stable pointer may still be passed to
74 -- 'castStablePtrToPtr', but the @'Foreign.Ptr.Ptr' ()@ value returned
75 -- by 'castStablePtrToPtr', in this case, is undefined (in particular,
76 -- it may be 'Foreign.Ptr.nullPtr').  Nevertheless, the call
77 -- to 'castStablePtrToPtr' is guaranteed not to diverge.
78 --
79 foreign import ccall unsafe "hs_free_stable_ptr" freeStablePtr :: StablePtr a -> IO ()
80
81 -- |
82 -- Coerce a stable pointer to an address. No guarantees are made about
83 -- the resulting value, except that the original stable pointer can be
84 -- recovered by 'castPtrToStablePtr'.  In particular, the address may not
85 -- refer to an accessible memory location and any attempt to pass it to
86 -- the member functions of the class 'Foreign.Storable.Storable' leads to
87 -- undefined behaviour.
88 --
89 castStablePtrToPtr :: StablePtr a -> Ptr ()
90 castStablePtrToPtr (StablePtr s) = Ptr (unsafeCoerce# s)
91
92
93 -- |
94 -- The inverse of 'castStablePtrToPtr', i.e., we have the identity
95 -- 
96 -- > sp == castPtrToStablePtr (castStablePtrToPtr sp)
97 -- 
98 -- for any stable pointer @sp@ on which 'freeStablePtr' has
99 -- not been executed yet.  Moreover, 'castPtrToStablePtr' may
100 -- only be applied to pointers that have been produced by
101 -- 'castStablePtrToPtr'.
102 --
103 castPtrToStablePtr :: Ptr () -> StablePtr a
104 castPtrToStablePtr (Ptr a) = StablePtr (unsafeCoerce# a)
105
106 instance Eq (StablePtr a) where 
107     (StablePtr sp1) == (StablePtr sp2) =
108         case eqStablePtr# sp1 sp2 of
109            0# -> False
110            _  -> True
111
112 \end{code}