e52785fc7d17441c837947942ec4cfede0a1d603
[packages/random.git] / GHC / Conc.lhs
1 \begin{code}
2 {-# OPTIONS_GHC -fno-implicit-prelude #-}
3 -----------------------------------------------------------------------------
4 -- |
5 -- Module      :  GHC.Conc
6 -- Copyright   :  (c) The University of Glasgow, 1994-2002
7 -- License     :  see libraries/base/LICENSE
8 -- 
9 -- Maintainer  :  cvs-ghc@haskell.org
10 -- Stability   :  internal
11 -- Portability :  non-portable (GHC extensions)
12 --
13 -- Basic concurrency stuff.
14 -- 
15 -----------------------------------------------------------------------------
16
17 -- No: #hide, because bits of this module are exposed by the stm package.
18 -- However, we don't want this module to be the home location for the
19 -- bits it exports, we'd rather have Control.Concurrent and the other
20 -- higher level modules be the home.  Hence:
21
22 #include "Typeable.h"
23
24 -- #not-home
25 module GHC.Conc
26         ( ThreadId(..)
27
28         -- * Forking and suchlike
29         , forkIO        -- :: IO a -> IO ThreadId
30         , forkOnIO      -- :: Int -> IO a -> IO ThreadId
31         , childHandler  -- :: Exception -> IO ()
32         , myThreadId    -- :: IO ThreadId
33         , killThread    -- :: ThreadId -> IO ()
34         , throwTo       -- :: ThreadId -> Exception -> IO ()
35         , par           -- :: a -> b -> b
36         , pseq          -- :: a -> b -> b
37         , yield         -- :: IO ()
38         , labelThread   -- :: ThreadId -> String -> IO ()
39
40         -- * Waiting
41         , threadDelay           -- :: Int -> IO ()
42         , registerDelay         -- :: Int -> IO (TVar Bool)
43         , threadWaitRead        -- :: Int -> IO ()
44         , threadWaitWrite       -- :: Int -> IO ()
45
46         -- * MVars
47         , MVar          -- abstract
48         , newMVar       -- :: a -> IO (MVar a)
49         , newEmptyMVar  -- :: IO (MVar a)
50         , takeMVar      -- :: MVar a -> IO a
51         , putMVar       -- :: MVar a -> a -> IO ()
52         , tryTakeMVar   -- :: MVar a -> IO (Maybe a)
53         , tryPutMVar    -- :: MVar a -> a -> IO Bool
54         , isEmptyMVar   -- :: MVar a -> IO Bool
55         , addMVarFinalizer -- :: MVar a -> IO () -> IO ()
56
57         -- * TVars
58         , STM           -- abstract
59         , atomically    -- :: STM a -> IO a
60         , retry         -- :: STM a
61         , orElse        -- :: STM a -> STM a -> STM a
62         , catchSTM      -- :: STM a -> (Exception -> STM a) -> STM a
63         , alwaysSucceeds -- :: STM a -> STM ()
64         , always        -- :: STM Bool -> STM ()
65         , TVar          -- abstract
66         , newTVar       -- :: a -> STM (TVar a)
67         , newTVarIO     -- :: a -> STM (TVar a)
68         , readTVar      -- :: TVar a -> STM a
69         , writeTVar     -- :: a -> TVar a -> STM ()
70         , unsafeIOToSTM -- :: IO a -> STM a
71
72         -- * Miscellaneous
73 #ifdef mingw32_HOST_OS
74         , asyncRead     -- :: Int -> Int -> Int -> Ptr a -> IO (Int, Int)
75         , asyncWrite    -- :: Int -> Int -> Int -> Ptr a -> IO (Int, Int)
76         , asyncDoProc   -- :: FunPtr (Ptr a -> IO Int) -> Ptr a -> IO Int
77
78         , asyncReadBA   -- :: Int -> Int -> Int -> Int -> MutableByteArray# RealWorld -> IO (Int, Int)
79         , asyncWriteBA  -- :: Int -> Int -> Int -> Int -> MutableByteArray# RealWorld -> IO (Int, Int)
80 #endif
81
82         , ensureIOManagerIsRunning
83         ) where
84
85 import System.Posix.Types
86 #ifndef mingw32_HOST_OS
87 import System.Posix.Internals
88 #endif
89 import Foreign
90 import Foreign.C
91
92 #ifndef __HADDOCK__
93 import {-# SOURCE #-} GHC.TopHandler ( reportError, reportStackOverflow )
94 #endif
95
96 import Data.Maybe
97
98 import GHC.Base
99 import GHC.IOBase
100 import GHC.Num          ( Num(..) )
101 import GHC.Real         ( fromIntegral, div )
102 #ifndef mingw32_HOST_OS
103 import GHC.Base         ( Int(..) )
104 #endif
105 import GHC.Exception    ( catchException, Exception(..), AsyncException(..) )
106 import GHC.Pack         ( packCString# )
107 import GHC.Ptr          ( Ptr(..), plusPtr, FunPtr(..) )
108 import GHC.STRef
109 import GHC.Show         ( Show(..), showString )
110 import Data.Typeable
111
112 infixr 0 `par`, `pseq`
113 \end{code}
114
115 %************************************************************************
116 %*                                                                      *
117 \subsection{@ThreadId@, @par@, and @fork@}
118 %*                                                                      *
119 %************************************************************************
120
121 \begin{code}
122 data ThreadId = ThreadId ThreadId# deriving( Typeable )
123 -- ToDo: data ThreadId = ThreadId (Weak ThreadId#)
124 -- But since ThreadId# is unlifted, the Weak type must use open
125 -- type variables.
126 {- ^
127 A 'ThreadId' is an abstract type representing a handle to a thread.
128 'ThreadId' is an instance of 'Eq', 'Ord' and 'Show', where
129 the 'Ord' instance implements an arbitrary total ordering over
130 'ThreadId's. The 'Show' instance lets you convert an arbitrary-valued
131 'ThreadId' to string form; showing a 'ThreadId' value is occasionally
132 useful when debugging or diagnosing the behaviour of a concurrent
133 program.
134
135 /Note/: in GHC, if you have a 'ThreadId', you essentially have
136 a pointer to the thread itself.  This means the thread itself can\'t be
137 garbage collected until you drop the 'ThreadId'.
138 This misfeature will hopefully be corrected at a later date.
139
140 /Note/: Hugs does not provide any operations on other threads;
141 it defines 'ThreadId' as a synonym for ().
142 -}
143
144 instance Show ThreadId where
145    showsPrec d t = 
146         showString "ThreadId " . 
147         showsPrec d (getThreadId (id2TSO t))
148
149 foreign import ccall unsafe "rts_getThreadId" getThreadId :: ThreadId# -> Int
150
151 id2TSO :: ThreadId -> ThreadId#
152 id2TSO (ThreadId t) = t
153
154 foreign import ccall unsafe "cmp_thread" cmp_thread :: ThreadId# -> ThreadId# -> CInt
155 -- Returns -1, 0, 1
156
157 cmpThread :: ThreadId -> ThreadId -> Ordering
158 cmpThread t1 t2 = 
159    case cmp_thread (id2TSO t1) (id2TSO t2) of
160       -1 -> LT
161       0  -> EQ
162       _  -> GT -- must be 1
163
164 instance Eq ThreadId where
165    t1 == t2 = 
166       case t1 `cmpThread` t2 of
167          EQ -> True
168          _  -> False
169
170 instance Ord ThreadId where
171    compare = cmpThread
172
173 {- |
174 This sparks off a new thread to run the 'IO' computation passed as the
175 first argument, and returns the 'ThreadId' of the newly created
176 thread.
177
178 The new thread will be a lightweight thread; if you want to use a foreign
179 library that uses thread-local storage, use 'forkOS' instead.
180 -}
181 forkIO :: IO () -> IO ThreadId
182 forkIO action = IO $ \ s -> 
183    case (fork# action_plus s) of (# s1, id #) -> (# s1, ThreadId id #)
184  where
185   action_plus = catchException action childHandler
186
187 forkOnIO :: Int -> IO () -> IO ThreadId
188 forkOnIO (I# cpu) action = IO $ \ s -> 
189    case (forkOn# cpu action_plus s) of (# s1, id #) -> (# s1, ThreadId id #)
190  where
191   action_plus = catchException action childHandler
192
193 childHandler :: Exception -> IO ()
194 childHandler err = catchException (real_handler err) childHandler
195
196 real_handler :: Exception -> IO ()
197 real_handler ex =
198   case ex of
199         -- ignore thread GC and killThread exceptions:
200         BlockedOnDeadMVar            -> return ()
201         BlockedIndefinitely          -> return ()
202         AsyncException ThreadKilled  -> return ()
203
204         -- report all others:
205         AsyncException StackOverflow -> reportStackOverflow
206         other       -> reportError other
207
208 {- | 'killThread' terminates the given thread (GHC only).
209 Any work already done by the thread isn\'t
210 lost: the computation is suspended until required by another thread.
211 The memory used by the thread will be garbage collected if it isn\'t
212 referenced from anywhere.  The 'killThread' function is defined in
213 terms of 'throwTo':
214
215 > killThread tid = throwTo tid (AsyncException ThreadKilled)
216
217 -}
218 killThread :: ThreadId -> IO ()
219 killThread tid = throwTo tid (AsyncException ThreadKilled)
220
221 {- | 'throwTo' raises an arbitrary exception in the target thread (GHC only).
222
223 'throwTo' does not return until the exception has been raised in the
224 target thread. 
225 The calling thread can thus be certain that the target
226 thread has received the exception.  This is a useful property to know
227 when dealing with race conditions: eg. if there are two threads that
228 can kill each other, it is guaranteed that only one of the threads
229 will get to kill the other.
230
231 If the target thread is currently making a foreign call, then the
232 exception will not be raised (and hence 'throwTo' will not return)
233 until the call has completed.  This is the case regardless of whether
234 the call is inside a 'block' or not.
235
236 Important note: the behaviour of 'throwTo' differs from that described in
237 the paper "Asynchronous exceptions in Haskell" 
238 (<http://research.microsoft.com/~simonpj/Papers/asynch-exns.htm>).
239 In the paper, 'throwTo' is non-blocking; but the library implementation adopts
240 a more synchronous design in which 'throwTo' does not return until the exception
241 is received by the target thread.  The trade-off is discussed in Section 8 of the paper.
242 Like any blocking operation, 'throwTo' is therefore interruptible (see Section 4.3 of
243 the paper).
244
245 There is currently no guarantee that the exception delivered by 'throwTo' will be
246 delivered at the first possible opportunity.  In particular, if a thread may 
247 unblock and then re-block exceptions (using 'unblock' and 'block') without receiving
248 a pending 'throwTo'.  This is arguably undesirable behaviour.
249
250  -}
251 throwTo :: ThreadId -> Exception -> IO ()
252 throwTo (ThreadId id) ex = IO $ \ s ->
253    case (killThread# id ex s) of s1 -> (# s1, () #)
254
255 -- | Returns the 'ThreadId' of the calling thread (GHC only).
256 myThreadId :: IO ThreadId
257 myThreadId = IO $ \s ->
258    case (myThreadId# s) of (# s1, id #) -> (# s1, ThreadId id #)
259
260
261 -- |The 'yield' action allows (forces, in a co-operative multitasking
262 -- implementation) a context-switch to any other currently runnable
263 -- threads (if any), and is occasionally useful when implementing
264 -- concurrency abstractions.
265 yield :: IO ()
266 yield = IO $ \s -> 
267    case (yield# s) of s1 -> (# s1, () #)
268
269 {- | 'labelThread' stores a string as identifier for this thread if
270 you built a RTS with debugging support. This identifier will be used in
271 the debugging output to make distinction of different threads easier
272 (otherwise you only have the thread state object\'s address in the heap).
273
274 Other applications like the graphical Concurrent Haskell Debugger
275 (<http://www.informatik.uni-kiel.de/~fhu/chd/>) may choose to overload
276 'labelThread' for their purposes as well.
277 -}
278
279 labelThread :: ThreadId -> String -> IO ()
280 labelThread (ThreadId t) str = IO $ \ s ->
281    let ps  = packCString# str
282        adr = byteArrayContents# ps in
283      case (labelThread# t adr s) of s1 -> (# s1, () #)
284
285 --      Nota Bene: 'pseq' used to be 'seq'
286 --                 but 'seq' is now defined in PrelGHC
287 --
288 -- "pseq" is defined a bit weirdly (see below)
289 --
290 -- The reason for the strange "lazy" call is that
291 -- it fools the compiler into thinking that pseq  and par are non-strict in
292 -- their second argument (even if it inlines pseq at the call site).
293 -- If it thinks pseq is strict in "y", then it often evaluates
294 -- "y" before "x", which is totally wrong.  
295
296 {-# INLINE pseq  #-}
297 pseq :: a -> b -> b
298 pseq  x y = x `seq` lazy y
299
300 {-# INLINE par  #-}
301 par :: a -> b -> b
302 par  x y = case (par# x) of { _ -> lazy y }
303 \end{code}
304
305
306 %************************************************************************
307 %*                                                                      *
308 \subsection[stm]{Transactional heap operations}
309 %*                                                                      *
310 %************************************************************************
311
312 TVars are shared memory locations which support atomic memory
313 transactions.
314
315 \begin{code}
316 -- |A monad supporting atomic memory transactions.
317 newtype STM a = STM (State# RealWorld -> (# State# RealWorld, a #))
318
319 unSTM :: STM a -> (State# RealWorld -> (# State# RealWorld, a #))
320 unSTM (STM a) = a
321
322 INSTANCE_TYPEABLE1(STM,stmTc,"STM")
323
324 instance  Functor STM where
325    fmap f x = x >>= (return . f)
326
327 instance  Monad STM  where
328     {-# INLINE return #-}
329     {-# INLINE (>>)   #-}
330     {-# INLINE (>>=)  #-}
331     m >> k      = thenSTM m k
332     return x    = returnSTM x
333     m >>= k     = bindSTM m k
334
335 bindSTM :: STM a -> (a -> STM b) -> STM b
336 bindSTM (STM m) k = STM ( \s ->
337   case m s of 
338     (# new_s, a #) -> unSTM (k a) new_s
339   )
340
341 thenSTM :: STM a -> STM b -> STM b
342 thenSTM (STM m) k = STM ( \s ->
343   case m s of 
344     (# new_s, a #) -> unSTM k new_s
345   )
346
347 returnSTM :: a -> STM a
348 returnSTM x = STM (\s -> (# s, x #))
349
350 -- | Unsafely performs IO in the STM monad.
351 unsafeIOToSTM :: IO a -> STM a
352 unsafeIOToSTM (IO m) = STM m
353
354 -- |Perform a series of STM actions atomically.
355 --
356 -- You cannot use 'atomically' inside an 'unsafePerformIO' or 'unsafeInterleaveIO'. 
357 -- Any attempt to do so will result in a runtime error.  (Reason: allowing
358 -- this would effectively allow a transaction inside a transaction, depending
359 -- on exactly when the thunk is evaluated.)
360 --
361 -- However, see 'newTVarIO', which can be called inside 'unsafePerformIO',
362 -- and which allows top-level TVars to be allocated.
363
364 atomically :: STM a -> IO a
365 atomically (STM m) = IO (\s -> (atomically# m) s )
366
367 -- |Retry execution of the current memory transaction because it has seen
368 -- values in TVars which mean that it should not continue (e.g. the TVars
369 -- represent a shared buffer that is now empty).  The implementation may
370 -- block the thread until one of the TVars that it has read from has been
371 -- udpated. (GHC only)
372 retry :: STM a
373 retry = STM $ \s# -> retry# s#
374
375 -- |Compose two alternative STM actions (GHC only).  If the first action
376 -- completes without retrying then it forms the result of the orElse.
377 -- Otherwise, if the first action retries, then the second action is
378 -- tried in its place.  If both actions retry then the orElse as a
379 -- whole retries.
380 orElse :: STM a -> STM a -> STM a
381 orElse (STM m) e = STM $ \s -> catchRetry# m (unSTM e) s
382
383 -- |Exception handling within STM actions.
384 catchSTM :: STM a -> (Exception -> STM a) -> STM a
385 catchSTM (STM m) k = STM $ \s -> catchSTM# m (\ex -> unSTM (k ex)) s
386
387 -- | Low-level primitive on which always and alwaysSucceeds are built.
388 -- checkInv differs form these in that (i) the invariant is not 
389 -- checked when checkInv is called, only at the end of this and
390 -- subsequent transcations, (ii) the invariant failure is indicated
391 -- by raising an exception.
392 checkInv :: STM a -> STM ()
393 checkInv (STM m) = STM (\s -> (check# m) s)
394
395 -- | alwaysSucceeds adds a new invariant that must be true when passed
396 -- to alwaysSucceeds, at the end of the current transaction, and at
397 -- the end of every subsequent transaction.  If it fails at any
398 -- of those points then the transaction violating it is aborted
399 -- and the exception raised by the invariant is propagated.
400 alwaysSucceeds :: STM a -> STM ()
401 alwaysSucceeds i = do ( do i ; retry ) `orElse` ( return () ) 
402                       checkInv i
403
404 -- | always is a variant of alwaysSucceeds in which the invariant is
405 -- expressed as an STM Bool action that must return True.  Returning
406 -- False or raising an exception are both treated as invariant failures.
407 always :: STM Bool -> STM ()
408 always i = alwaysSucceeds ( do v <- i
409                                if (v) then return () else ( error "Transacional invariant violation" ) )
410
411 -- |Shared memory locations that support atomic memory transactions.
412 data TVar a = TVar (TVar# RealWorld a)
413
414 INSTANCE_TYPEABLE1(TVar,tvarTc,"TVar")
415
416 instance Eq (TVar a) where
417         (TVar tvar1#) == (TVar tvar2#) = sameTVar# tvar1# tvar2#
418
419 -- |Create a new TVar holding a value supplied
420 newTVar :: a -> STM (TVar a)
421 newTVar val = STM $ \s1# ->
422     case newTVar# val s1# of
423          (# s2#, tvar# #) -> (# s2#, TVar tvar# #)
424
425 -- |@IO@ version of 'newTVar'.  This is useful for creating top-level
426 -- 'TVar's using 'System.IO.Unsafe.unsafePerformIO', because using
427 -- 'atomically' inside 'System.IO.Unsafe.unsafePerformIO' isn't
428 -- possible.
429 newTVarIO :: a -> IO (TVar a)
430 newTVarIO val = IO $ \s1# ->
431     case newTVar# val s1# of
432          (# s2#, tvar# #) -> (# s2#, TVar tvar# #)
433
434 -- |Return the current value stored in a TVar
435 readTVar :: TVar a -> STM a
436 readTVar (TVar tvar#) = STM $ \s# -> readTVar# tvar# s#
437
438 -- |Write the supplied value into a TVar
439 writeTVar :: TVar a -> a -> STM ()
440 writeTVar (TVar tvar#) val = STM $ \s1# ->
441     case writeTVar# tvar# val s1# of
442          s2# -> (# s2#, () #)
443   
444 \end{code}
445
446 %************************************************************************
447 %*                                                                      *
448 \subsection[mvars]{M-Structures}
449 %*                                                                      *
450 %************************************************************************
451
452 M-Vars are rendezvous points for concurrent threads.  They begin
453 empty, and any attempt to read an empty M-Var blocks.  When an M-Var
454 is written, a single blocked thread may be freed.  Reading an M-Var
455 toggles its state from full back to empty.  Therefore, any value
456 written to an M-Var may only be read once.  Multiple reads and writes
457 are allowed, but there must be at least one read between any two
458 writes.
459
460 \begin{code}
461 --Defined in IOBase to avoid cycle: data MVar a = MVar (SynchVar# RealWorld a)
462
463 -- |Create an 'MVar' which is initially empty.
464 newEmptyMVar  :: IO (MVar a)
465 newEmptyMVar = IO $ \ s# ->
466     case newMVar# s# of
467          (# s2#, svar# #) -> (# s2#, MVar svar# #)
468
469 -- |Create an 'MVar' which contains the supplied value.
470 newMVar :: a -> IO (MVar a)
471 newMVar value =
472     newEmptyMVar        >>= \ mvar ->
473     putMVar mvar value  >>
474     return mvar
475
476 -- |Return the contents of the 'MVar'.  If the 'MVar' is currently
477 -- empty, 'takeMVar' will wait until it is full.  After a 'takeMVar', 
478 -- the 'MVar' is left empty.
479 -- 
480 -- There are two further important properties of 'takeMVar':
481 --
482 --   * 'takeMVar' is single-wakeup.  That is, if there are multiple
483 --     threads blocked in 'takeMVar', and the 'MVar' becomes full,
484 --     only one thread will be woken up.  The runtime guarantees that
485 --     the woken thread completes its 'takeMVar' operation.
486 --
487 --   * When multiple threads are blocked on an 'MVar', they are
488 --     woken up in FIFO order.  This is useful for providing
489 --     fairness properties of abstractions built using 'MVar's.
490 --
491 takeMVar :: MVar a -> IO a
492 takeMVar (MVar mvar#) = IO $ \ s# -> takeMVar# mvar# s#
493
494 -- |Put a value into an 'MVar'.  If the 'MVar' is currently full,
495 -- 'putMVar' will wait until it becomes empty.
496 --
497 -- There are two further important properties of 'putMVar':
498 --
499 --   * 'putMVar' is single-wakeup.  That is, if there are multiple
500 --     threads blocked in 'putMVar', and the 'MVar' becomes empty,
501 --     only one thread will be woken up.  The runtime guarantees that
502 --     the woken thread completes its 'putMVar' operation.
503 --
504 --   * When multiple threads are blocked on an 'MVar', they are
505 --     woken up in FIFO order.  This is useful for providing
506 --     fairness properties of abstractions built using 'MVar's.
507 --
508 putMVar  :: MVar a -> a -> IO ()
509 putMVar (MVar mvar#) x = IO $ \ s# ->
510     case putMVar# mvar# x s# of
511         s2# -> (# s2#, () #)
512
513 -- |A non-blocking version of 'takeMVar'.  The 'tryTakeMVar' function
514 -- returns immediately, with 'Nothing' if the 'MVar' was empty, or
515 -- @'Just' a@ if the 'MVar' was full with contents @a@.  After 'tryTakeMVar',
516 -- the 'MVar' is left empty.
517 tryTakeMVar :: MVar a -> IO (Maybe a)
518 tryTakeMVar (MVar m) = IO $ \ s ->
519     case tryTakeMVar# m s of
520         (# s, 0#, _ #) -> (# s, Nothing #)      -- MVar is empty
521         (# s, _,  a #) -> (# s, Just a  #)      -- MVar is full
522
523 -- |A non-blocking version of 'putMVar'.  The 'tryPutMVar' function
524 -- attempts to put the value @a@ into the 'MVar', returning 'True' if
525 -- it was successful, or 'False' otherwise.
526 tryPutMVar  :: MVar a -> a -> IO Bool
527 tryPutMVar (MVar mvar#) x = IO $ \ s# ->
528     case tryPutMVar# mvar# x s# of
529         (# s, 0# #) -> (# s, False #)
530         (# s, _  #) -> (# s, True #)
531
532 -- |Check whether a given 'MVar' is empty.
533 --
534 -- Notice that the boolean value returned  is just a snapshot of
535 -- the state of the MVar. By the time you get to react on its result,
536 -- the MVar may have been filled (or emptied) - so be extremely
537 -- careful when using this operation.   Use 'tryTakeMVar' instead if possible.
538 isEmptyMVar :: MVar a -> IO Bool
539 isEmptyMVar (MVar mv#) = IO $ \ s# -> 
540     case isEmptyMVar# mv# s# of
541         (# s2#, flg #) -> (# s2#, not (flg ==# 0#) #)
542
543 -- |Add a finalizer to an 'MVar' (GHC only).  See "Foreign.ForeignPtr" and
544 -- "System.Mem.Weak" for more about finalizers.
545 addMVarFinalizer :: MVar a -> IO () -> IO ()
546 addMVarFinalizer (MVar m) finalizer = 
547   IO $ \s -> case mkWeak# m () finalizer s of { (# s1, w #) -> (# s1, () #) }
548 \end{code}
549
550
551 %************************************************************************
552 %*                                                                      *
553 \subsection{Thread waiting}
554 %*                                                                      *
555 %************************************************************************
556
557 \begin{code}
558 #ifdef mingw32_HOST_OS
559
560 -- Note: threadDelay, threadWaitRead and threadWaitWrite aren't really functional
561 -- on Win32, but left in there because lib code (still) uses them (the manner
562 -- in which they're used doesn't cause problems on a Win32 platform though.)
563
564 asyncRead :: Int -> Int -> Int -> Ptr a -> IO (Int, Int)
565 asyncRead  (I# fd) (I# isSock) (I# len) (Ptr buf) =
566   IO $ \s -> case asyncRead# fd isSock len buf s of 
567                (# s, len#, err# #) -> (# s, (I# len#, I# err#) #)
568
569 asyncWrite :: Int -> Int -> Int -> Ptr a -> IO (Int, Int)
570 asyncWrite  (I# fd) (I# isSock) (I# len) (Ptr buf) =
571   IO $ \s -> case asyncWrite# fd isSock len buf s of 
572                (# s, len#, err# #) -> (# s, (I# len#, I# err#) #)
573
574 asyncDoProc :: FunPtr (Ptr a -> IO Int) -> Ptr a -> IO Int
575 asyncDoProc (FunPtr proc) (Ptr param) = 
576     -- the 'length' value is ignored; simplifies implementation of
577     -- the async*# primops to have them all return the same result.
578   IO $ \s -> case asyncDoProc# proc param s  of 
579                (# s, len#, err# #) -> (# s, I# err# #)
580
581 -- to aid the use of these primops by the IO Handle implementation,
582 -- provide the following convenience funs:
583
584 -- this better be a pinned byte array!
585 asyncReadBA :: Int -> Int -> Int -> Int -> MutableByteArray# RealWorld -> IO (Int,Int)
586 asyncReadBA fd isSock len off bufB = 
587   asyncRead fd isSock len ((Ptr (byteArrayContents# (unsafeCoerce# bufB))) `plusPtr` off)
588   
589 asyncWriteBA :: Int -> Int -> Int -> Int -> MutableByteArray# RealWorld -> IO (Int,Int)
590 asyncWriteBA fd isSock len off bufB = 
591   asyncWrite fd isSock len ((Ptr (byteArrayContents# (unsafeCoerce# bufB))) `plusPtr` off)
592
593 #endif
594
595 -- -----------------------------------------------------------------------------
596 -- Thread IO API
597
598 -- | Block the current thread until data is available to read on the
599 -- given file descriptor (GHC only).
600 threadWaitRead :: Fd -> IO ()
601 threadWaitRead fd
602 #ifndef mingw32_HOST_OS
603   | threaded  = waitForReadEvent fd
604 #endif
605   | otherwise = IO $ \s -> 
606         case fromIntegral fd of { I# fd# ->
607         case waitRead# fd# s of { s -> (# s, () #)
608         }}
609
610 -- | Block the current thread until data can be written to the
611 -- given file descriptor (GHC only).
612 threadWaitWrite :: Fd -> IO ()
613 threadWaitWrite fd
614 #ifndef mingw32_HOST_OS
615   | threaded  = waitForWriteEvent fd
616 #endif
617   | otherwise = IO $ \s -> 
618         case fromIntegral fd of { I# fd# ->
619         case waitWrite# fd# s of { s -> (# s, () #)
620         }}
621
622 -- | Suspends the current thread for a given number of microseconds
623 -- (GHC only).
624 --
625 -- There is no guarantee that the thread will be rescheduled promptly
626 -- when the delay has expired, but the thread will never continue to
627 -- run /earlier/ than specified.
628 --
629 threadDelay :: Int -> IO ()
630 threadDelay time
631   | threaded  = waitForDelayEvent time
632   | otherwise = IO $ \s -> 
633         case fromIntegral time of { I# time# ->
634         case delay# time# s of { s -> (# s, () #)
635         }}
636
637
638 -- | Set the value of returned TVar to True after a given number of
639 -- microseconds. The caveats associated with threadDelay also apply.
640 --
641 registerDelay :: Int -> IO (TVar Bool)
642 registerDelay usecs 
643   | threaded = waitForDelayEventSTM usecs
644   | otherwise = error "registerDelay: requires -threaded"
645
646 foreign import ccall unsafe "rtsSupportsBoundThreads" threaded :: Bool
647
648 waitForDelayEvent :: Int -> IO ()
649 waitForDelayEvent usecs = do
650   m <- newEmptyMVar
651   target <- calculateTarget usecs
652   atomicModifyIORef pendingDelays (\xs -> (Delay target m : xs, ()))
653   prodServiceThread
654   takeMVar m
655
656 -- Delays for use in STM
657 waitForDelayEventSTM :: Int -> IO (TVar Bool)
658 waitForDelayEventSTM usecs = do
659    t <- atomically $ newTVar False
660    target <- calculateTarget usecs
661    atomicModifyIORef pendingDelays (\xs -> (DelaySTM target t : xs, ()))
662    prodServiceThread
663    return t  
664     
665 calculateTarget :: Int -> IO USecs
666 calculateTarget usecs = do
667     now <- getUSecOfDay
668     return $ now + (fromIntegral usecs)
669
670
671 -- ----------------------------------------------------------------------------
672 -- Threaded RTS implementation of threadWaitRead, threadWaitWrite, threadDelay
673
674 -- In the threaded RTS, we employ a single IO Manager thread to wait
675 -- for all outstanding IO requests (threadWaitRead,threadWaitWrite)
676 -- and delays (threadDelay).  
677 --
678 -- We can do this because in the threaded RTS the IO Manager can make
679 -- a non-blocking call to select(), so we don't have to do select() in
680 -- the scheduler as we have to in the non-threaded RTS.  We get performance
681 -- benefits from doing it this way, because we only have to restart the select()
682 -- when a new request arrives, rather than doing one select() each time
683 -- around the scheduler loop.  Furthermore, the scheduler can be simplified
684 -- by not having to check for completed IO requests.
685
686 -- Issues, possible problems:
687 --
688 --      - we might want bound threads to just do the blocking
689 --        operation rather than communicating with the IO manager
690 --        thread.  This would prevent simgle-threaded programs which do
691 --        IO from requiring multiple OS threads.  However, it would also
692 --        prevent bound threads waiting on IO from being killed or sent
693 --        exceptions.
694 --
695 --      - Apprently exec() doesn't work on Linux in a multithreaded program.
696 --        I couldn't repeat this.
697 --
698 --      - How do we handle signal delivery in the multithreaded RTS?
699 --
700 --      - forkProcess will kill the IO manager thread.  Let's just
701 --        hope we don't need to do any blocking IO between fork & exec.
702
703 #ifndef mingw32_HOST_OS
704 data IOReq
705   = Read   {-# UNPACK #-} !Fd {-# UNPACK #-} !(MVar ())
706   | Write  {-# UNPACK #-} !Fd {-# UNPACK #-} !(MVar ())
707 #endif
708
709 data DelayReq
710   = Delay    {-# UNPACK #-} !USecs {-# UNPACK #-} !(MVar ())
711   | DelaySTM {-# UNPACK #-} !USecs {-# UNPACK #-} !(TVar Bool)
712
713 #ifndef mingw32_HOST_OS
714 pendingEvents :: IORef [IOReq]
715 #endif
716 pendingDelays :: IORef [DelayReq]
717         -- could use a strict list or array here
718 {-# NOINLINE pendingEvents #-}
719 {-# NOINLINE pendingDelays #-}
720 (pendingEvents,pendingDelays) = unsafePerformIO $ do
721   startIOManagerThread
722   reqs <- newIORef []
723   dels <- newIORef []
724   return (reqs, dels)
725         -- the first time we schedule an IO request, the service thread
726         -- will be created (cool, huh?)
727
728 ensureIOManagerIsRunning :: IO ()
729 ensureIOManagerIsRunning 
730   | threaded  = seq pendingEvents $ return ()
731   | otherwise = return ()
732
733 insertDelay :: DelayReq -> [DelayReq] -> [DelayReq]
734 insertDelay d [] = [d]
735 insertDelay d1 ds@(d2 : rest)
736   | delayTime d1 <= delayTime d2 = d1 : ds
737   | otherwise                    = d2 : insertDelay d1 rest
738
739 delayTime :: DelayReq -> USecs
740 delayTime (Delay t _) = t
741 delayTime (DelaySTM t _) = t
742
743 type USecs = Word64
744
745 -- XXX: move into GHC.IOBase from Data.IORef?
746 atomicModifyIORef :: IORef a -> (a -> (a,b)) -> IO b
747 atomicModifyIORef (IORef (STRef r#)) f = IO $ \s -> atomicModifyMutVar# r# f s
748
749 foreign import ccall unsafe "getUSecOfDay" 
750   getUSecOfDay :: IO USecs
751
752 prodding :: IORef Bool
753 {-# NOINLINE prodding #-}
754 prodding = unsafePerformIO (newIORef False)
755
756 prodServiceThread :: IO ()
757 prodServiceThread = do
758   was_set <- atomicModifyIORef prodding (\a -> (True,a))
759   if (not (was_set)) then wakeupIOManager else return ()
760
761 #ifdef mingw32_HOST_OS
762 -- ----------------------------------------------------------------------------
763 -- Windows IO manager thread
764
765 startIOManagerThread :: IO ()
766 startIOManagerThread = do
767   wakeup <- c_getIOManagerEvent
768   forkIO $ service_loop wakeup []
769   return ()
770
771 service_loop :: HANDLE          -- read end of pipe
772              -> [DelayReq]      -- current delay requests
773              -> IO ()
774
775 service_loop wakeup old_delays = do
776   -- pick up new delay requests
777   new_delays <- atomicModifyIORef pendingDelays (\a -> ([],a))
778   let  delays = foldr insertDelay old_delays new_delays
779
780   now <- getUSecOfDay
781   (delays', timeout) <- getDelay now delays
782
783   r <- c_WaitForSingleObject wakeup timeout
784   case r of
785     0xffffffff -> do c_maperrno; throwErrno "service_loop"
786     0 -> do
787         r <- c_readIOManagerEvent
788         exit <- 
789               case r of
790                 _ | r == io_MANAGER_WAKEUP -> return False
791                 _ | r == io_MANAGER_DIE    -> return True
792                 0 -> return False -- spurious wakeup
793                 r -> do start_console_handler (r `shiftR` 1); return False
794         if exit
795           then return ()
796           else service_cont wakeup delays'
797
798     _other -> service_cont wakeup delays' -- probably timeout        
799
800 service_cont wakeup delays = do
801   atomicModifyIORef prodding (\_ -> (False,False))
802   service_loop wakeup delays
803
804 -- must agree with rts/win32/ThrIOManager.c
805 io_MANAGER_WAKEUP = 0xffffffff :: Word32
806 io_MANAGER_DIE    = 0xfffffffe :: Word32
807
808 start_console_handler :: Word32 -> IO ()
809 start_console_handler r = do                   
810   stableptr <- peek console_handler
811   forkIO $ do io <- deRefStablePtr stableptr; io (fromIntegral r)
812   return ()
813
814 foreign import ccall "&console_handler" 
815    console_handler :: Ptr (StablePtr (CInt -> IO ()))
816
817 stick :: IORef HANDLE
818 {-# NOINLINE stick #-}
819 stick = unsafePerformIO (newIORef nullPtr)
820
821 wakeupIOManager = do 
822   hdl <- readIORef stick
823   c_sendIOManagerEvent io_MANAGER_WAKEUP
824
825 -- Walk the queue of pending delays, waking up any that have passed
826 -- and return the smallest delay to wait for.  The queue of pending
827 -- delays is kept ordered.
828 getDelay :: USecs -> [DelayReq] -> IO ([DelayReq], DWORD)
829 getDelay now [] = return ([], iNFINITE)
830 getDelay now all@(d : rest) 
831   = case d of
832      Delay time m | now >= time -> do
833         putMVar m ()
834         getDelay now rest
835      DelaySTM time t | now >= time -> do
836         atomically $ writeTVar t True
837         getDelay now rest
838      _otherwise ->
839         -- delay is in millisecs for WaitForSingleObject
840         let micro_seconds = delayTime d - now
841             milli_seconds = (micro_seconds + 999) `div` 1000
842         in return (all, fromIntegral milli_seconds)
843
844 -- ToDo: this just duplicates part of System.Win32.Types, which isn't
845 -- available yet.  We should move some Win32 functionality down here,
846 -- maybe as part of the grand reorganisation of the base package...
847 type HANDLE       = Ptr ()
848 type DWORD        = Word32
849
850 iNFINITE = 0xFFFFFFFF :: DWORD -- urgh
851
852 foreign import ccall unsafe "getIOManagerEvent" -- in the RTS (ThrIOManager.c)
853   c_getIOManagerEvent :: IO HANDLE
854
855 foreign import ccall unsafe "readIOManagerEvent" -- in the RTS (ThrIOManager.c)
856   c_readIOManagerEvent :: IO Word32
857
858 foreign import ccall unsafe "sendIOManagerEvent" -- in the RTS (ThrIOManager.c)
859   c_sendIOManagerEvent :: Word32 -> IO ()
860
861 foreign import ccall unsafe "maperrno"             -- in runProcess.c
862    c_maperrno :: IO ()
863
864 foreign import stdcall "WaitForSingleObject"
865    c_WaitForSingleObject :: HANDLE -> DWORD -> IO DWORD
866
867 #else
868 -- ----------------------------------------------------------------------------
869 -- Unix IO manager thread, using select()
870
871 startIOManagerThread :: IO ()
872 startIOManagerThread = do
873         allocaArray 2 $ \fds -> do
874         throwErrnoIfMinus1 "startIOManagerThread" (c_pipe fds)
875         rd_end <- peekElemOff fds 0
876         wr_end <- peekElemOff fds 1
877         writeIORef stick (fromIntegral wr_end)
878         c_setIOManagerPipe wr_end
879         forkIO $ do
880             allocaBytes sizeofFdSet   $ \readfds -> do
881             allocaBytes sizeofFdSet   $ \writefds -> do 
882             allocaBytes sizeofTimeVal $ \timeval -> do
883             service_loop (fromIntegral rd_end) readfds writefds timeval [] []
884         return ()
885
886 service_loop
887    :: Fd                -- listen to this for wakeup calls
888    -> Ptr CFdSet
889    -> Ptr CFdSet
890    -> Ptr CTimeVal
891    -> [IOReq]
892    -> [DelayReq]
893    -> IO ()
894 service_loop wakeup readfds writefds ptimeval old_reqs old_delays = do
895
896   -- pick up new IO requests
897   new_reqs <- atomicModifyIORef pendingEvents (\a -> ([],a))
898   let reqs = new_reqs ++ old_reqs
899
900   -- pick up new delay requests
901   new_delays <- atomicModifyIORef pendingDelays (\a -> ([],a))
902   let  delays = foldr insertDelay old_delays new_delays
903
904   -- build the FDSets for select()
905   fdZero readfds
906   fdZero writefds
907   fdSet wakeup readfds
908   maxfd <- buildFdSets 0 readfds writefds reqs
909
910   -- perform the select()
911   let do_select delays = do
912           -- check the current time and wake up any thread in
913           -- threadDelay whose timeout has expired.  Also find the
914           -- timeout value for the select() call.
915           now <- getUSecOfDay
916           (delays', timeout) <- getDelay now ptimeval delays
917
918           res <- c_select ((max wakeup maxfd)+1) readfds writefds 
919                         nullPtr timeout
920           if (res == -1)
921              then do
922                 err <- getErrno
923                 case err of
924                   _ | err == eINTR ->  do_select delays'
925                         -- EINTR: just redo the select()
926                   _ | err == eBADF ->  return (True, delays)
927                         -- EBADF: one of the file descriptors is closed or bad,
928                         -- we don't know which one, so wake everyone up.
929                   _ | otherwise    ->  throwErrno "select"
930                         -- otherwise (ENOMEM or EINVAL) something has gone
931                         -- wrong; report the error.
932              else
933                 return (False,delays')
934
935   (wakeup_all,delays') <- do_select delays
936
937   exit <-
938     if wakeup_all then return False
939       else do
940         b <- fdIsSet wakeup readfds
941         if b == 0 
942           then return False
943           else alloca $ \p -> do 
944                  c_read (fromIntegral wakeup) p 1; return ()
945                  s <- peek p            
946                  case s of
947                   _ | s == io_MANAGER_WAKEUP -> return False
948                   _ | s == io_MANAGER_DIE    -> return True
949                   _ -> do handler_tbl <- peek handlers
950                           sp <- peekElemOff handler_tbl (fromIntegral s)
951                           forkIO (do io <- deRefStablePtr sp; io)
952                           return False
953
954   if exit then return () else do
955
956   atomicModifyIORef prodding (\_ -> (False,False))
957
958   reqs' <- if wakeup_all then do wakeupAll reqs; return []
959                          else completeRequests reqs readfds writefds []
960
961   service_loop wakeup readfds writefds ptimeval reqs' delays'
962
963 io_MANAGER_WAKEUP = 0xff :: CChar
964 io_MANAGER_DIE    = 0xfe :: CChar
965
966 stick :: IORef Fd
967 {-# NOINLINE stick #-}
968 stick = unsafePerformIO (newIORef 0)
969
970 wakeupIOManager :: IO ()
971 wakeupIOManager = do
972   fd <- readIORef stick
973   with io_MANAGER_WAKEUP $ \pbuf -> do 
974     c_write (fromIntegral fd) pbuf 1; return ()
975
976 foreign import ccall "&signal_handlers" handlers :: Ptr (Ptr (StablePtr (IO ())))
977
978 foreign import ccall "setIOManagerPipe"
979   c_setIOManagerPipe :: CInt -> IO ()
980
981 -- -----------------------------------------------------------------------------
982 -- IO requests
983
984 buildFdSets maxfd readfds writefds [] = return maxfd
985 buildFdSets maxfd readfds writefds (Read fd m : reqs)
986   | fd >= fD_SETSIZE =  error "buildFdSets: file descriptor out of range"
987   | otherwise        =  do
988         fdSet fd readfds
989         buildFdSets (max maxfd fd) readfds writefds reqs
990 buildFdSets maxfd readfds writefds (Write fd m : reqs)
991   | fd >= fD_SETSIZE =  error "buildFdSets: file descriptor out of range"
992   | otherwise        =  do
993         fdSet fd writefds
994         buildFdSets (max maxfd fd) readfds writefds reqs
995
996 completeRequests [] _ _ reqs' = return reqs'
997 completeRequests (Read fd m : reqs) readfds writefds reqs' = do
998   b <- fdIsSet fd readfds
999   if b /= 0
1000     then do putMVar m (); completeRequests reqs readfds writefds reqs'
1001     else completeRequests reqs readfds writefds (Read fd m : reqs')
1002 completeRequests (Write fd m : reqs) readfds writefds reqs' = do
1003   b <- fdIsSet fd writefds
1004   if b /= 0
1005     then do putMVar m (); completeRequests reqs readfds writefds reqs'
1006     else completeRequests reqs readfds writefds (Write fd m : reqs')
1007
1008 wakeupAll [] = return ()
1009 wakeupAll (Read  fd m : reqs) = do putMVar m (); wakeupAll reqs
1010 wakeupAll (Write fd m : reqs) = do putMVar m (); wakeupAll reqs
1011
1012 waitForReadEvent :: Fd -> IO ()
1013 waitForReadEvent fd = do
1014   m <- newEmptyMVar
1015   atomicModifyIORef pendingEvents (\xs -> (Read fd m : xs, ()))
1016   prodServiceThread
1017   takeMVar m
1018
1019 waitForWriteEvent :: Fd -> IO ()
1020 waitForWriteEvent fd = do
1021   m <- newEmptyMVar
1022   atomicModifyIORef pendingEvents (\xs -> (Write fd m : xs, ()))
1023   prodServiceThread
1024   takeMVar m
1025
1026 -- -----------------------------------------------------------------------------
1027 -- Delays
1028
1029 -- Walk the queue of pending delays, waking up any that have passed
1030 -- and return the smallest delay to wait for.  The queue of pending
1031 -- delays is kept ordered.
1032 getDelay :: USecs -> Ptr CTimeVal -> [DelayReq] -> IO ([DelayReq], Ptr CTimeVal)
1033 getDelay now ptimeval [] = return ([],nullPtr)
1034 getDelay now ptimeval all@(d : rest) 
1035   = case d of
1036      Delay time m | now >= time -> do
1037         putMVar m ()
1038         getDelay now ptimeval rest
1039      DelaySTM time t | now >= time -> do
1040         atomically $ writeTVar t True
1041         getDelay now ptimeval rest
1042      _otherwise -> do
1043         setTimevalTicks ptimeval (delayTime d - now)
1044         return (all,ptimeval)
1045
1046 newtype CTimeVal = CTimeVal ()
1047
1048 foreign import ccall unsafe "sizeofTimeVal"
1049   sizeofTimeVal :: Int
1050
1051 foreign import ccall unsafe "setTimevalTicks" 
1052   setTimevalTicks :: Ptr CTimeVal -> USecs -> IO ()
1053
1054 {- 
1055   On Win32 we're going to have a single Pipe, and a
1056   waitForSingleObject with the delay time.  For signals, we send a
1057   byte down the pipe just like on Unix.
1058 -}
1059
1060 -- ----------------------------------------------------------------------------
1061 -- select() interface
1062
1063 -- ToDo: move to System.Posix.Internals?
1064
1065 newtype CFdSet = CFdSet ()
1066
1067 foreign import ccall safe "select"
1068   c_select :: Fd -> Ptr CFdSet -> Ptr CFdSet -> Ptr CFdSet -> Ptr CTimeVal
1069            -> IO CInt
1070
1071 foreign import ccall unsafe "hsFD_SETSIZE"
1072   fD_SETSIZE :: Fd
1073
1074 foreign import ccall unsafe "hsFD_CLR"
1075   fdClr :: Fd -> Ptr CFdSet -> IO ()
1076
1077 foreign import ccall unsafe "hsFD_ISSET"
1078   fdIsSet :: Fd -> Ptr CFdSet -> IO CInt
1079
1080 foreign import ccall unsafe "hsFD_SET"
1081   fdSet :: Fd -> Ptr CFdSet -> IO ()
1082
1083 foreign import ccall unsafe "hsFD_ZERO"
1084   fdZero :: Ptr CFdSet -> IO ()
1085
1086 foreign import ccall unsafe "sizeof_fd_set"
1087   sizeofFdSet :: Int
1088
1089 #endif
1090
1091 \end{code}