2 {-# OPTIONS_GHC -XNoImplicitPrelude #-}
3 {-# OPTIONS_GHC -fno-warn-missing-signatures #-}
4 {-# OPTIONS_HADDOCK not-home #-}
5 -----------------------------------------------------------------------------
8 -- Copyright : (c) The University of Glasgow, 1994-2002
9 -- License : see libraries/base/LICENSE
11 -- Maintainer : cvs-ghc@haskell.org
12 -- Stability : internal
13 -- Portability : non-portable (GHC extensions)
15 -- Basic concurrency stuff.
17 -----------------------------------------------------------------------------
19 -- No: #hide, because bits of this module are exposed by the stm package.
20 -- However, we don't want this module to be the home location for the
21 -- bits it exports, we'd rather have Control.Concurrent and the other
22 -- higher level modules be the home. Hence:
30 -- * Forking and suchlike
31 , forkIO -- :: IO a -> IO ThreadId
32 , forkOnIO -- :: Int -> IO a -> IO ThreadId
33 , numCapabilities -- :: Int
34 , childHandler -- :: Exception -> IO ()
35 , myThreadId -- :: IO ThreadId
36 , killThread -- :: ThreadId -> IO ()
37 , throwTo -- :: ThreadId -> Exception -> IO ()
38 , par -- :: a -> b -> b
39 , pseq -- :: a -> b -> b
42 , labelThread -- :: ThreadId -> String -> IO ()
44 , ThreadStatus(..), BlockReason(..)
45 , threadStatus -- :: ThreadId -> IO ThreadStatus
48 , threadDelay -- :: Int -> IO ()
49 , registerDelay -- :: Int -> IO (TVar Bool)
50 , threadWaitRead -- :: Int -> IO ()
51 , threadWaitWrite -- :: Int -> IO ()
55 , atomically -- :: STM a -> IO a
57 , orElse -- :: STM a -> STM a -> STM a
58 , catchSTM -- :: STM a -> (Exception -> STM a) -> STM a
59 , alwaysSucceeds -- :: STM a -> STM ()
60 , always -- :: STM Bool -> STM ()
62 , newTVar -- :: a -> STM (TVar a)
63 , newTVarIO -- :: a -> STM (TVar a)
64 , readTVar -- :: TVar a -> STM a
65 , readTVarIO -- :: TVar a -> IO a
66 , writeTVar -- :: a -> TVar a -> STM ()
67 , unsafeIOToSTM -- :: IO a -> STM a
71 #ifdef mingw32_HOST_OS
72 , asyncRead -- :: Int -> Int -> Int -> Ptr a -> IO (Int, Int)
73 , asyncWrite -- :: Int -> Int -> Int -> Ptr a -> IO (Int, Int)
74 , asyncDoProc -- :: FunPtr (Ptr a -> IO Int) -> Ptr a -> IO Int
76 , asyncReadBA -- :: Int -> Int -> Int -> Int -> MutableByteArray# RealWorld -> IO (Int, Int)
77 , asyncWriteBA -- :: Int -> Int -> Int -> Int -> MutableByteArray# RealWorld -> IO (Int, Int)
80 #ifndef mingw32_HOST_OS
81 , Signal, HandlerFun, setHandler, runHandlers
84 , ensureIOManagerIsRunning
85 #ifndef mingw32_HOST_OS
89 #ifdef mingw32_HOST_OS
94 , setUncaughtExceptionHandler -- :: (Exception -> IO ()) -> IO ()
95 , getUncaughtExceptionHandler -- :: IO (Exception -> IO ())
97 , reportError, reportStackOverflow
100 import System.Posix.Types
101 #ifndef mingw32_HOST_OS
102 import System.Posix.Internals
107 #ifdef mingw32_HOST_OS
111 #ifndef mingw32_HOST_OS
118 #ifndef mingw32_HOST_OS
121 import {-# SOURCE #-} GHC.IO.Handle ( hFlush )
122 import {-# SOURCE #-} GHC.IO.Handle.FD ( stdout )
124 import GHC.IO.Exception
128 import GHC.Num ( Num(..) )
129 import GHC.Real ( fromIntegral )
130 #ifndef mingw32_HOST_OS
132 import GHC.Arr ( inRange )
134 #ifdef mingw32_HOST_OS
135 import GHC.Real ( div )
138 #ifdef mingw32_HOST_OS
139 import GHC.Read ( Read )
140 import GHC.Enum ( Enum )
142 import GHC.Pack ( packCString# )
143 import GHC.Show ( Show(..), showString )
145 infixr 0 `par`, `pseq`
148 %************************************************************************
150 \subsection{@ThreadId@, @par@, and @fork@}
152 %************************************************************************
155 data ThreadId = ThreadId ThreadId# deriving( Typeable )
156 -- ToDo: data ThreadId = ThreadId (Weak ThreadId#)
157 -- But since ThreadId# is unlifted, the Weak type must use open
160 A 'ThreadId' is an abstract type representing a handle to a thread.
161 'ThreadId' is an instance of 'Eq', 'Ord' and 'Show', where
162 the 'Ord' instance implements an arbitrary total ordering over
163 'ThreadId's. The 'Show' instance lets you convert an arbitrary-valued
164 'ThreadId' to string form; showing a 'ThreadId' value is occasionally
165 useful when debugging or diagnosing the behaviour of a concurrent
168 /Note/: in GHC, if you have a 'ThreadId', you essentially have
169 a pointer to the thread itself. This means the thread itself can\'t be
170 garbage collected until you drop the 'ThreadId'.
171 This misfeature will hopefully be corrected at a later date.
173 /Note/: Hugs does not provide any operations on other threads;
174 it defines 'ThreadId' as a synonym for ().
177 instance Show ThreadId where
179 showString "ThreadId " .
180 showsPrec d (getThreadId (id2TSO t))
182 foreign import ccall unsafe "rts_getThreadId" getThreadId :: ThreadId# -> CInt
184 id2TSO :: ThreadId -> ThreadId#
185 id2TSO (ThreadId t) = t
187 foreign import ccall unsafe "cmp_thread" cmp_thread :: ThreadId# -> ThreadId# -> CInt
190 cmpThread :: ThreadId -> ThreadId -> Ordering
192 case cmp_thread (id2TSO t1) (id2TSO t2) of
197 instance Eq ThreadId where
199 case t1 `cmpThread` t2 of
203 instance Ord ThreadId where
207 Sparks off a new thread to run the 'IO' computation passed as the
208 first argument, and returns the 'ThreadId' of the newly created
211 The new thread will be a lightweight thread; if you want to use a foreign
212 library that uses thread-local storage, use 'Control.Concurrent.forkOS' instead.
214 GHC note: the new thread inherits the /blocked/ state of the parent
215 (see 'Control.Exception.block').
217 The newly created thread has an exception handler that discards the
218 exceptions 'BlockedOnDeadMVar', 'BlockedIndefinitely', and
219 'ThreadKilled', and passes all other exceptions to the uncaught
220 exception handler (see 'setUncaughtExceptionHandler').
222 forkIO :: IO () -> IO ThreadId
223 forkIO action = IO $ \ s ->
224 case (fork# action_plus s) of (# s1, tid #) -> (# s1, ThreadId tid #)
226 action_plus = catchException action childHandler
229 Like 'forkIO', but lets you specify on which CPU the thread is
230 created. Unlike a `forkIO` thread, a thread created by `forkOnIO`
231 will stay on the same CPU for its entire lifetime (`forkIO` threads
232 can migrate between CPUs according to the scheduling policy).
233 `forkOnIO` is useful for overriding the scheduling policy when you
234 know in advance how best to distribute the threads.
236 The `Int` argument specifies the CPU number; it is interpreted modulo
237 'numCapabilities' (note that it actually specifies a capability number
238 rather than a CPU number, but to a first approximation the two are
241 forkOnIO :: Int -> IO () -> IO ThreadId
242 forkOnIO (I# cpu) action = IO $ \ s ->
243 case (forkOn# cpu action_plus s) of (# s1, tid #) -> (# s1, ThreadId tid #)
245 action_plus = catchException action childHandler
247 -- | the value passed to the @+RTS -N@ flag. This is the number of
248 -- Haskell threads that can run truly simultaneously at any given
249 -- time, and is typically set to the number of physical CPU cores on
251 numCapabilities :: Int
252 numCapabilities = unsafePerformIO $ do
253 n <- peek n_capabilities
254 return (fromIntegral n)
256 #if defined(mingw32_HOST_OS) && defined(__PIC__)
257 foreign import ccall "_imp__n_capabilities" n_capabilities :: Ptr CInt
259 foreign import ccall "&n_capabilities" n_capabilities :: Ptr CInt
261 childHandler :: SomeException -> IO ()
262 childHandler err = catchException (real_handler err) childHandler
264 real_handler :: SomeException -> IO ()
265 real_handler se@(SomeException ex) =
266 -- ignore thread GC and killThread exceptions:
268 Just BlockedIndefinitelyOnMVar -> return ()
270 Just BlockedIndefinitelyOnSTM -> return ()
272 Just ThreadKilled -> return ()
274 -- report all others:
275 Just StackOverflow -> reportStackOverflow
278 {- | 'killThread' terminates the given thread (GHC only).
279 Any work already done by the thread isn\'t
280 lost: the computation is suspended until required by another thread.
281 The memory used by the thread will be garbage collected if it isn\'t
282 referenced from anywhere. The 'killThread' function is defined in
285 > killThread tid = throwTo tid ThreadKilled
287 Killthread is a no-op if the target thread has already completed.
289 killThread :: ThreadId -> IO ()
290 killThread tid = throwTo tid ThreadKilled
292 {- | 'throwTo' raises an arbitrary exception in the target thread (GHC only).
294 'throwTo' does not return until the exception has been raised in the
296 The calling thread can thus be certain that the target
297 thread has received the exception. This is a useful property to know
298 when dealing with race conditions: eg. if there are two threads that
299 can kill each other, it is guaranteed that only one of the threads
300 will get to kill the other.
302 If the target thread is currently making a foreign call, then the
303 exception will not be raised (and hence 'throwTo' will not return)
304 until the call has completed. This is the case regardless of whether
305 the call is inside a 'block' or not.
307 Important note: the behaviour of 'throwTo' differs from that described in
308 the paper \"Asynchronous exceptions in Haskell\"
309 (<http://research.microsoft.com/~simonpj/Papers/asynch-exns.htm>).
310 In the paper, 'throwTo' is non-blocking; but the library implementation adopts
311 a more synchronous design in which 'throwTo' does not return until the exception
312 is received by the target thread. The trade-off is discussed in Section 9 of the paper.
313 Like any blocking operation, 'throwTo' is therefore interruptible (see Section 5.3 of
316 There is currently no guarantee that the exception delivered by 'throwTo' will be
317 delivered at the first possible opportunity. In particular, a thread may
318 unblock and then re-block exceptions (using 'unblock' and 'block') without receiving
319 a pending 'throwTo'. This is arguably undesirable behaviour.
322 throwTo :: Exception e => ThreadId -> e -> IO ()
323 throwTo (ThreadId tid) ex = IO $ \ s ->
324 case (killThread# tid (toException ex) s) of s1 -> (# s1, () #)
326 -- | Returns the 'ThreadId' of the calling thread (GHC only).
327 myThreadId :: IO ThreadId
328 myThreadId = IO $ \s ->
329 case (myThreadId# s) of (# s1, tid #) -> (# s1, ThreadId tid #)
332 -- |The 'yield' action allows (forces, in a co-operative multitasking
333 -- implementation) a context-switch to any other currently runnable
334 -- threads (if any), and is occasionally useful when implementing
335 -- concurrency abstractions.
338 case (yield# s) of s1 -> (# s1, () #)
340 {- | 'labelThread' stores a string as identifier for this thread if
341 you built a RTS with debugging support. This identifier will be used in
342 the debugging output to make distinction of different threads easier
343 (otherwise you only have the thread state object\'s address in the heap).
345 Other applications like the graphical Concurrent Haskell Debugger
346 (<http://www.informatik.uni-kiel.de/~fhu/chd/>) may choose to overload
347 'labelThread' for their purposes as well.
350 labelThread :: ThreadId -> String -> IO ()
351 labelThread (ThreadId t) str = IO $ \ s ->
352 let !ps = packCString# str
353 !adr = byteArrayContents# ps in
354 case (labelThread# t adr s) of s1 -> (# s1, () #)
356 -- Nota Bene: 'pseq' used to be 'seq'
357 -- but 'seq' is now defined in PrelGHC
359 -- "pseq" is defined a bit weirdly (see below)
361 -- The reason for the strange "lazy" call is that
362 -- it fools the compiler into thinking that pseq and par are non-strict in
363 -- their second argument (even if it inlines pseq at the call site).
364 -- If it thinks pseq is strict in "y", then it often evaluates
365 -- "y" before "x", which is totally wrong.
369 pseq x y = x `seq` lazy y
373 par x y = case (par# x) of { _ -> lazy y }
375 -- | Internal function used by the RTS to run sparks.
378 where loop s = case getSpark# s of
380 if n ==# 0# then (# s', () #)
385 -- ^blocked on on 'MVar'
387 -- ^blocked on a computation in progress by another thread
389 -- ^blocked in 'throwTo'
391 -- ^blocked in 'retry' in an STM transaction
392 | BlockedOnForeignCall
393 -- ^currently in a foreign call
395 -- ^blocked on some other resource. Without @-threaded@,
396 -- I\/O and 'threadDelay' show up as 'BlockedOnOther', with @-threaded@
397 -- they show up as 'BlockedOnMVar'.
398 deriving (Eq,Ord,Show)
400 -- | The current status of a thread
403 -- ^the thread is currently runnable or running
405 -- ^the thread has finished
406 | ThreadBlocked BlockReason
407 -- ^the thread is blocked on some resource
409 -- ^the thread received an uncaught exception
410 deriving (Eq,Ord,Show)
412 threadStatus :: ThreadId -> IO ThreadStatus
413 threadStatus (ThreadId t) = IO $ \s ->
414 case threadStatus# t s of
415 (# s', stat #) -> (# s', mk_stat (I# stat) #)
417 -- NB. keep these in sync with includes/Constants.h
418 mk_stat 0 = ThreadRunning
419 mk_stat 1 = ThreadBlocked BlockedOnMVar
420 mk_stat 2 = ThreadBlocked BlockedOnBlackHole
421 mk_stat 3 = ThreadBlocked BlockedOnException
422 mk_stat 7 = ThreadBlocked BlockedOnSTM
423 mk_stat 11 = ThreadBlocked BlockedOnForeignCall
424 mk_stat 12 = ThreadBlocked BlockedOnForeignCall
425 mk_stat 16 = ThreadFinished
426 mk_stat 17 = ThreadDied
427 mk_stat _ = ThreadBlocked BlockedOnOther
431 %************************************************************************
433 \subsection[stm]{Transactional heap operations}
435 %************************************************************************
437 TVars are shared memory locations which support atomic memory
441 -- |A monad supporting atomic memory transactions.
442 newtype STM a = STM (State# RealWorld -> (# State# RealWorld, a #))
444 unSTM :: STM a -> (State# RealWorld -> (# State# RealWorld, a #))
447 INSTANCE_TYPEABLE1(STM,stmTc,"STM")
449 instance Functor STM where
450 fmap f x = x >>= (return . f)
452 instance Monad STM where
453 {-# INLINE return #-}
457 return x = returnSTM x
458 m >>= k = bindSTM m k
460 bindSTM :: STM a -> (a -> STM b) -> STM b
461 bindSTM (STM m) k = STM ( \s ->
463 (# new_s, a #) -> unSTM (k a) new_s
466 thenSTM :: STM a -> STM b -> STM b
467 thenSTM (STM m) k = STM ( \s ->
469 (# new_s, _ #) -> unSTM k new_s
472 returnSTM :: a -> STM a
473 returnSTM x = STM (\s -> (# s, x #))
475 -- | Unsafely performs IO in the STM monad. Beware: this is a highly
476 -- dangerous thing to do.
478 -- * The STM implementation will often run transactions multiple
479 -- times, so you need to be prepared for this if your IO has any
482 -- * The STM implementation will abort transactions that are known to
483 -- be invalid and need to be restarted. This may happen in the middle
484 -- of `unsafeIOToSTM`, so make sure you don't acquire any resources
485 -- that need releasing (exception handlers are ignored when aborting
486 -- the transaction). That includes doing any IO using Handles, for
487 -- example. Getting this wrong will probably lead to random deadlocks.
489 -- * The transaction may have seen an inconsistent view of memory when
490 -- the IO runs. Invariants that you expect to be true throughout
491 -- your program may not be true inside a transaction, due to the
492 -- way transactions are implemented. Normally this wouldn't be visible
493 -- to the programmer, but using `unsafeIOToSTM` can expose it.
495 unsafeIOToSTM :: IO a -> STM a
496 unsafeIOToSTM (IO m) = STM m
498 -- |Perform a series of STM actions atomically.
500 -- You cannot use 'atomically' inside an 'unsafePerformIO' or 'unsafeInterleaveIO'.
501 -- Any attempt to do so will result in a runtime error. (Reason: allowing
502 -- this would effectively allow a transaction inside a transaction, depending
503 -- on exactly when the thunk is evaluated.)
505 -- However, see 'newTVarIO', which can be called inside 'unsafePerformIO',
506 -- and which allows top-level TVars to be allocated.
508 atomically :: STM a -> IO a
509 atomically (STM m) = IO (\s -> (atomically# m) s )
511 -- |Retry execution of the current memory transaction because it has seen
512 -- values in TVars which mean that it should not continue (e.g. the TVars
513 -- represent a shared buffer that is now empty). The implementation may
514 -- block the thread until one of the TVars that it has read from has been
515 -- udpated. (GHC only)
517 retry = STM $ \s# -> retry# s#
519 -- |Compose two alternative STM actions (GHC only). If the first action
520 -- completes without retrying then it forms the result of the orElse.
521 -- Otherwise, if the first action retries, then the second action is
522 -- tried in its place. If both actions retry then the orElse as a
524 orElse :: STM a -> STM a -> STM a
525 orElse (STM m) e = STM $ \s -> catchRetry# m (unSTM e) s
527 -- |Exception handling within STM actions.
528 catchSTM :: STM a -> (SomeException -> STM a) -> STM a
529 catchSTM (STM m) k = STM $ \s -> catchSTM# m (\ex -> unSTM (k ex)) s
531 -- | Low-level primitive on which always and alwaysSucceeds are built.
532 -- checkInv differs form these in that (i) the invariant is not
533 -- checked when checkInv is called, only at the end of this and
534 -- subsequent transcations, (ii) the invariant failure is indicated
535 -- by raising an exception.
536 checkInv :: STM a -> STM ()
537 checkInv (STM m) = STM (\s -> (check# m) s)
539 -- | alwaysSucceeds adds a new invariant that must be true when passed
540 -- to alwaysSucceeds, at the end of the current transaction, and at
541 -- the end of every subsequent transaction. If it fails at any
542 -- of those points then the transaction violating it is aborted
543 -- and the exception raised by the invariant is propagated.
544 alwaysSucceeds :: STM a -> STM ()
545 alwaysSucceeds i = do ( i >> retry ) `orElse` ( return () )
548 -- | always is a variant of alwaysSucceeds in which the invariant is
549 -- expressed as an STM Bool action that must return True. Returning
550 -- False or raising an exception are both treated as invariant failures.
551 always :: STM Bool -> STM ()
552 always i = alwaysSucceeds ( do v <- i
553 if (v) then return () else ( error "Transacional invariant violation" ) )
555 -- |Shared memory locations that support atomic memory transactions.
556 data TVar a = TVar (TVar# RealWorld a)
558 INSTANCE_TYPEABLE1(TVar,tvarTc,"TVar")
560 instance Eq (TVar a) where
561 (TVar tvar1#) == (TVar tvar2#) = sameTVar# tvar1# tvar2#
563 -- |Create a new TVar holding a value supplied
564 newTVar :: a -> STM (TVar a)
565 newTVar val = STM $ \s1# ->
566 case newTVar# val s1# of
567 (# s2#, tvar# #) -> (# s2#, TVar tvar# #)
569 -- |@IO@ version of 'newTVar'. This is useful for creating top-level
570 -- 'TVar's using 'System.IO.Unsafe.unsafePerformIO', because using
571 -- 'atomically' inside 'System.IO.Unsafe.unsafePerformIO' isn't
573 newTVarIO :: a -> IO (TVar a)
574 newTVarIO val = IO $ \s1# ->
575 case newTVar# val s1# of
576 (# s2#, tvar# #) -> (# s2#, TVar tvar# #)
578 -- |Return the current value stored in a TVar.
579 -- This is equivalent to
581 -- > readTVarIO = atomically . readTVar
583 -- but works much faster, because it doesn't perform a complete
584 -- transaction, it just reads the current value of the 'TVar'.
585 readTVarIO :: TVar a -> IO a
586 readTVarIO (TVar tvar#) = IO $ \s# -> readTVarIO# tvar# s#
588 -- |Return the current value stored in a TVar
589 readTVar :: TVar a -> STM a
590 readTVar (TVar tvar#) = STM $ \s# -> readTVar# tvar# s#
592 -- |Write the supplied value into a TVar
593 writeTVar :: TVar a -> a -> STM ()
594 writeTVar (TVar tvar#) val = STM $ \s1# ->
595 case writeTVar# tvar# val s1# of
603 withMVar :: MVar a -> (a -> IO b) -> IO b
607 b <- catchAny (unblock (io a))
608 (\e -> do putMVar m a; throw e)
612 modifyMVar_ :: MVar a -> (a -> IO a) -> IO ()
616 a' <- catchAny (unblock (io a))
617 (\e -> do putMVar m a; throw e)
622 %************************************************************************
624 \subsection{Thread waiting}
626 %************************************************************************
629 #ifdef mingw32_HOST_OS
631 -- Note: threadWaitRead and threadWaitWrite aren't really functional
632 -- on Win32, but left in there because lib code (still) uses them (the manner
633 -- in which they're used doesn't cause problems on a Win32 platform though.)
635 asyncRead :: Int -> Int -> Int -> Ptr a -> IO (Int, Int)
636 asyncRead (I# fd) (I# isSock) (I# len) (Ptr buf) =
637 IO $ \s -> case asyncRead# fd isSock len buf s of
638 (# s', len#, err# #) -> (# s', (I# len#, I# err#) #)
640 asyncWrite :: Int -> Int -> Int -> Ptr a -> IO (Int, Int)
641 asyncWrite (I# fd) (I# isSock) (I# len) (Ptr buf) =
642 IO $ \s -> case asyncWrite# fd isSock len buf s of
643 (# s', len#, err# #) -> (# s', (I# len#, I# err#) #)
645 asyncDoProc :: FunPtr (Ptr a -> IO Int) -> Ptr a -> IO Int
646 asyncDoProc (FunPtr proc) (Ptr param) =
647 -- the 'length' value is ignored; simplifies implementation of
648 -- the async*# primops to have them all return the same result.
649 IO $ \s -> case asyncDoProc# proc param s of
650 (# s', _len#, err# #) -> (# s', I# err# #)
652 -- to aid the use of these primops by the IO Handle implementation,
653 -- provide the following convenience funs:
655 -- this better be a pinned byte array!
656 asyncReadBA :: Int -> Int -> Int -> Int -> MutableByteArray# RealWorld -> IO (Int,Int)
657 asyncReadBA fd isSock len off bufB =
658 asyncRead fd isSock len ((Ptr (byteArrayContents# (unsafeCoerce# bufB))) `plusPtr` off)
660 asyncWriteBA :: Int -> Int -> Int -> Int -> MutableByteArray# RealWorld -> IO (Int,Int)
661 asyncWriteBA fd isSock len off bufB =
662 asyncWrite fd isSock len ((Ptr (byteArrayContents# (unsafeCoerce# bufB))) `plusPtr` off)
666 -- -----------------------------------------------------------------------------
669 -- | Block the current thread until data is available to read on the
670 -- given file descriptor (GHC only).
671 threadWaitRead :: Fd -> IO ()
673 #ifndef mingw32_HOST_OS
674 | threaded = waitForReadEvent fd
676 | otherwise = IO $ \s ->
677 case fromIntegral fd of { I# fd# ->
678 case waitRead# fd# s of { s' -> (# s', () #)
681 -- | Block the current thread until data can be written to the
682 -- given file descriptor (GHC only).
683 threadWaitWrite :: Fd -> IO ()
685 #ifndef mingw32_HOST_OS
686 | threaded = waitForWriteEvent fd
688 | otherwise = IO $ \s ->
689 case fromIntegral fd of { I# fd# ->
690 case waitWrite# fd# s of { s' -> (# s', () #)
693 -- | Suspends the current thread for a given number of microseconds
696 -- There is no guarantee that the thread will be rescheduled promptly
697 -- when the delay has expired, but the thread will never continue to
698 -- run /earlier/ than specified.
700 threadDelay :: Int -> IO ()
702 | threaded = waitForDelayEvent time
703 | otherwise = IO $ \s ->
704 case fromIntegral time of { I# time# ->
705 case delay# time# s of { s' -> (# s', () #)
709 -- | Set the value of returned TVar to True after a given number of
710 -- microseconds. The caveats associated with threadDelay also apply.
712 registerDelay :: Int -> IO (TVar Bool)
714 | threaded = waitForDelayEventSTM usecs
715 | otherwise = error "registerDelay: requires -threaded"
717 foreign import ccall unsafe "rtsSupportsBoundThreads" threaded :: Bool
719 waitForDelayEvent :: Int -> IO ()
720 waitForDelayEvent usecs = do
722 target <- calculateTarget usecs
723 atomicModifyIORef pendingDelays (\xs -> (Delay target m : xs, ()))
727 -- Delays for use in STM
728 waitForDelayEventSTM :: Int -> IO (TVar Bool)
729 waitForDelayEventSTM usecs = do
730 t <- atomically $ newTVar False
731 target <- calculateTarget usecs
732 atomicModifyIORef pendingDelays (\xs -> (DelaySTM target t : xs, ()))
736 calculateTarget :: Int -> IO USecs
737 calculateTarget usecs = do
739 return $ now + (fromIntegral usecs)
742 -- ----------------------------------------------------------------------------
743 -- Threaded RTS implementation of threadWaitRead, threadWaitWrite, threadDelay
745 -- In the threaded RTS, we employ a single IO Manager thread to wait
746 -- for all outstanding IO requests (threadWaitRead,threadWaitWrite)
747 -- and delays (threadDelay).
749 -- We can do this because in the threaded RTS the IO Manager can make
750 -- a non-blocking call to select(), so we don't have to do select() in
751 -- the scheduler as we have to in the non-threaded RTS. We get performance
752 -- benefits from doing it this way, because we only have to restart the select()
753 -- when a new request arrives, rather than doing one select() each time
754 -- around the scheduler loop. Furthermore, the scheduler can be simplified
755 -- by not having to check for completed IO requests.
757 #ifndef mingw32_HOST_OS
759 = Read {-# UNPACK #-} !Fd {-# UNPACK #-} !(MVar ())
760 | Write {-# UNPACK #-} !Fd {-# UNPACK #-} !(MVar ())
764 = Delay {-# UNPACK #-} !USecs {-# UNPACK #-} !(MVar ())
765 | DelaySTM {-# UNPACK #-} !USecs {-# UNPACK #-} !(TVar Bool)
767 #ifndef mingw32_HOST_OS
768 {-# NOINLINE pendingEvents #-}
769 pendingEvents :: IORef [IOReq]
770 pendingEvents = unsafePerformIO $ do
772 sharedCAF m getOrSetGHCConcPendingEventsStore
774 foreign import ccall unsafe "getOrSetGHCConcPendingEventsStore"
775 getOrSetGHCConcPendingEventsStore :: Ptr a -> IO (Ptr a)
778 {-# NOINLINE pendingDelays #-}
779 pendingDelays :: IORef [DelayReq]
780 pendingDelays = unsafePerformIO $ do
782 sharedCAF m getOrSetGHCConcPendingDelaysStore
784 foreign import ccall unsafe "getOrSetGHCConcPendingDelaysStore"
785 getOrSetGHCConcPendingDelaysStore :: Ptr a -> IO (Ptr a)
787 {-# NOINLINE ioManagerThread #-}
788 ioManagerThread :: MVar (Maybe ThreadId)
789 ioManagerThread = unsafePerformIO $ do
791 sharedCAF m getOrSetGHCConcIOManagerThreadStore
793 foreign import ccall unsafe "getOrSetGHCConcIOManagerThreadStore"
794 getOrSetGHCConcIOManagerThreadStore :: Ptr a -> IO (Ptr a)
796 ensureIOManagerIsRunning :: IO ()
797 ensureIOManagerIsRunning
798 | threaded = startIOManagerThread
799 | otherwise = return ()
801 startIOManagerThread :: IO ()
802 startIOManagerThread = do
803 modifyMVar_ ioManagerThread $ \old -> do
804 let create = do t <- forkIO ioManager; return (Just t)
810 ThreadFinished -> create
812 _other -> return (Just t)
814 insertDelay :: DelayReq -> [DelayReq] -> [DelayReq]
815 insertDelay d [] = [d]
816 insertDelay d1 ds@(d2 : rest)
817 | delayTime d1 <= delayTime d2 = d1 : ds
818 | otherwise = d2 : insertDelay d1 rest
820 delayTime :: DelayReq -> USecs
821 delayTime (Delay t _) = t
822 delayTime (DelaySTM t _) = t
826 foreign import ccall unsafe "getUSecOfDay"
827 getUSecOfDay :: IO USecs
829 {-# NOINLINE prodding #-}
830 prodding :: IORef Bool
831 prodding = unsafePerformIO $ do
833 sharedCAF r getOrSetGHCConcProddingStore
835 foreign import ccall unsafe "getOrSetGHCConcProddingStore"
836 getOrSetGHCConcProddingStore :: Ptr a -> IO (Ptr a)
838 prodServiceThread :: IO ()
839 prodServiceThread = do
840 was_set <- readIORef prodding
841 writeIORef prodding True
842 -- no need for atomicModifyIORef, extra prods are harmless.
843 if (not (was_set)) then wakeupIOManager else return ()
845 -- Machinery needed to ensure that we only have one copy of certain
846 -- CAFs in this module even when the base package is present twice, as
847 -- it is when base is dynamically loaded into GHCi. The RTS keeps
848 -- track of the single true value of the CAF, so even when the CAFs in
849 -- the dynamically-loaded base package are reverted, nothing bad
852 sharedCAF :: a -> (Ptr a -> IO (Ptr a)) -> IO a
853 sharedCAF a get_or_set =
855 stable_ref <- newStablePtr a
856 let ref = castPtr (castStablePtrToPtr stable_ref)
857 ref2 <- get_or_set ref
860 else do freeStablePtr stable_ref
861 deRefStablePtr (castPtrToStablePtr (castPtr ref2))
863 #ifdef mingw32_HOST_OS
864 -- ----------------------------------------------------------------------------
865 -- Windows IO manager thread
869 wakeup <- c_getIOManagerEvent
870 service_loop wakeup []
872 service_loop :: HANDLE -- read end of pipe
873 -> [DelayReq] -- current delay requests
876 service_loop wakeup old_delays = do
877 -- pick up new delay requests
878 new_delays <- atomicModifyIORef pendingDelays (\a -> ([],a))
879 let delays = foldr insertDelay old_delays new_delays
882 (delays', timeout) <- getDelay now delays
884 r <- c_WaitForSingleObject wakeup timeout
886 0xffffffff -> do c_maperrno; throwErrno "service_loop"
888 r2 <- c_readIOManagerEvent
891 _ | r2 == io_MANAGER_WAKEUP -> return False
892 _ | r2 == io_MANAGER_DIE -> return True
893 0 -> return False -- spurious wakeup
894 _ -> do start_console_handler (r2 `shiftR` 1); return False
895 unless exit $ service_cont wakeup delays'
897 _other -> service_cont wakeup delays' -- probably timeout
899 service_cont :: HANDLE -> [DelayReq] -> IO ()
900 service_cont wakeup delays = do
901 r <- atomicModifyIORef prodding (\_ -> (False,False))
902 r `seq` return () -- avoid space leak
903 service_loop wakeup delays
905 -- must agree with rts/win32/ThrIOManager.c
906 io_MANAGER_WAKEUP, io_MANAGER_DIE :: Word32
907 io_MANAGER_WAKEUP = 0xffffffff
908 io_MANAGER_DIE = 0xfffffffe
914 -- these are sent to Services only.
917 deriving (Eq, Ord, Enum, Show, Read, Typeable)
919 start_console_handler :: Word32 -> IO ()
920 start_console_handler r =
921 case toWin32ConsoleEvent r of
922 Just x -> withMVar win32ConsoleHandler $ \handler -> do
923 _ <- forkIO (handler x)
927 toWin32ConsoleEvent :: Num a => a -> Maybe ConsoleEvent
928 toWin32ConsoleEvent ev =
930 0 {- CTRL_C_EVENT-} -> Just ControlC
931 1 {- CTRL_BREAK_EVENT-} -> Just Break
932 2 {- CTRL_CLOSE_EVENT-} -> Just Close
933 5 {- CTRL_LOGOFF_EVENT-} -> Just Logoff
934 6 {- CTRL_SHUTDOWN_EVENT-} -> Just Shutdown
937 win32ConsoleHandler :: MVar (ConsoleEvent -> IO ())
938 win32ConsoleHandler = unsafePerformIO (newMVar (error "win32ConsoleHandler"))
940 wakeupIOManager :: IO ()
941 wakeupIOManager = c_sendIOManagerEvent io_MANAGER_WAKEUP
943 -- Walk the queue of pending delays, waking up any that have passed
944 -- and return the smallest delay to wait for. The queue of pending
945 -- delays is kept ordered.
946 getDelay :: USecs -> [DelayReq] -> IO ([DelayReq], DWORD)
947 getDelay _ [] = return ([], iNFINITE)
948 getDelay now all@(d : rest)
950 Delay time m | now >= time -> do
953 DelaySTM time t | now >= time -> do
954 atomically $ writeTVar t True
957 -- delay is in millisecs for WaitForSingleObject
958 let micro_seconds = delayTime d - now
959 milli_seconds = (micro_seconds + 999) `div` 1000
960 in return (all, fromIntegral milli_seconds)
962 -- ToDo: this just duplicates part of System.Win32.Types, which isn't
963 -- available yet. We should move some Win32 functionality down here,
964 -- maybe as part of the grand reorganisation of the base package...
969 iNFINITE = 0xFFFFFFFF -- urgh
971 foreign import ccall unsafe "getIOManagerEvent" -- in the RTS (ThrIOManager.c)
972 c_getIOManagerEvent :: IO HANDLE
974 foreign import ccall unsafe "readIOManagerEvent" -- in the RTS (ThrIOManager.c)
975 c_readIOManagerEvent :: IO Word32
977 foreign import ccall unsafe "sendIOManagerEvent" -- in the RTS (ThrIOManager.c)
978 c_sendIOManagerEvent :: Word32 -> IO ()
980 foreign import ccall unsafe "maperrno" -- in Win32Utils.c
983 foreign import stdcall "WaitForSingleObject"
984 c_WaitForSingleObject :: HANDLE -> DWORD -> IO DWORD
987 -- ----------------------------------------------------------------------------
988 -- Unix IO manager thread, using select()
992 allocaArray 2 $ \fds -> do
993 throwErrnoIfMinus1_ "startIOManagerThread" (c_pipe fds)
994 rd_end <- peekElemOff fds 0
995 wr_end <- peekElemOff fds 1
996 setNonBlockingFD wr_end True -- writes happen in a signal handler, we
997 -- don't want them to block.
998 setCloseOnExec rd_end
999 setCloseOnExec wr_end
1000 c_setIOManagerPipe wr_end
1001 allocaBytes sizeofFdSet $ \readfds -> do
1002 allocaBytes sizeofFdSet $ \writefds -> do
1003 allocaBytes sizeofTimeVal $ \timeval -> do
1004 service_loop (fromIntegral rd_end) readfds writefds timeval [] []
1008 :: Fd -- listen to this for wakeup calls
1015 service_loop wakeup readfds writefds ptimeval old_reqs old_delays = do
1017 -- pick up new IO requests
1018 new_reqs <- atomicModifyIORef pendingEvents (\a -> ([],a))
1019 let reqs = new_reqs ++ old_reqs
1021 -- pick up new delay requests
1022 new_delays <- atomicModifyIORef pendingDelays (\a -> ([],a))
1023 let delays0 = foldr insertDelay old_delays new_delays
1025 -- build the FDSets for select()
1028 fdSet wakeup readfds
1029 maxfd <- buildFdSets 0 readfds writefds reqs
1031 -- perform the select()
1032 let do_select delays = do
1033 -- check the current time and wake up any thread in
1034 -- threadDelay whose timeout has expired. Also find the
1035 -- timeout value for the select() call.
1037 (delays', timeout) <- getDelay now ptimeval delays
1039 res <- c_select (fromIntegral ((max wakeup maxfd)+1)) readfds writefds
1045 _ | err == eINTR -> do_select delays'
1046 -- EINTR: just redo the select()
1047 _ | err == eBADF -> return (True, delays)
1048 -- EBADF: one of the file descriptors is closed or bad,
1049 -- we don't know which one, so wake everyone up.
1050 _ | otherwise -> throwErrno "select"
1051 -- otherwise (ENOMEM or EINVAL) something has gone
1052 -- wrong; report the error.
1054 return (False,delays')
1056 (wakeup_all,delays') <- do_select delays0
1059 if wakeup_all then return False
1061 b <- fdIsSet wakeup readfds
1064 else alloca $ \p -> do
1065 warnErrnoIfMinus1_ "service_loop" $
1066 c_read (fromIntegral wakeup) p 1
1069 _ | s == io_MANAGER_WAKEUP -> return False
1070 _ | s == io_MANAGER_DIE -> return True
1071 _ | s == io_MANAGER_SYNC -> do
1072 mvars <- readIORef sync
1073 mapM_ (flip putMVar ()) mvars
1076 fp <- mallocForeignPtrBytes (fromIntegral sizeof_siginfo_t)
1077 withForeignPtr fp $ \p_siginfo -> do
1078 r <- c_read (fromIntegral wakeup) (castPtr p_siginfo)
1080 when (r /= fromIntegral sizeof_siginfo_t) $
1081 error "failed to read siginfo_t"
1082 runHandlers' fp (fromIntegral s)
1087 atomicModifyIORef prodding (\_ -> (False, ()))
1089 reqs' <- if wakeup_all then do wakeupAll reqs; return []
1090 else completeRequests reqs readfds writefds []
1092 service_loop wakeup readfds writefds ptimeval reqs' delays'
1094 io_MANAGER_WAKEUP, io_MANAGER_DIE, io_MANAGER_SYNC :: Word8
1095 io_MANAGER_WAKEUP = 0xff
1096 io_MANAGER_DIE = 0xfe
1097 io_MANAGER_SYNC = 0xfd
1099 {-# NOINLINE sync #-}
1100 sync :: IORef [MVar ()]
1101 sync = unsafePerformIO (newIORef [])
1103 -- waits for the IO manager to drain the pipe
1104 syncIOManager :: IO ()
1107 atomicModifyIORef sync (\old -> (m:old,()))
1111 foreign import ccall unsafe "ioManagerSync" c_ioManagerSync :: IO ()
1112 foreign import ccall unsafe "ioManagerWakeup" wakeupIOManager :: IO ()
1114 -- For the non-threaded RTS
1115 runHandlers :: Ptr Word8 -> Int -> IO ()
1116 runHandlers p_info sig = do
1117 fp <- mallocForeignPtrBytes (fromIntegral sizeof_siginfo_t)
1118 withForeignPtr fp $ \p -> do
1119 copyBytes p p_info (fromIntegral sizeof_siginfo_t)
1121 runHandlers' fp (fromIntegral sig)
1123 runHandlers' :: ForeignPtr Word8 -> Signal -> IO ()
1124 runHandlers' p_info sig = do
1125 let int = fromIntegral sig
1126 withMVar signal_handlers $ \arr ->
1127 if not (inRange (boundsIOArray arr) int)
1129 else do handler <- unsafeReadIOArray arr int
1131 Nothing -> return ()
1132 Just (f,_) -> do _ <- forkIO (f p_info)
1135 warnErrnoIfMinus1_ :: Num a => String -> IO a -> IO ()
1136 warnErrnoIfMinus1_ what io
1140 str <- strerror errno >>= peekCString
1142 debugErrLn ("Warning: " ++ what ++ " failed: " ++ str)
1144 foreign import ccall unsafe "string.h" strerror :: Errno -> IO (Ptr CChar)
1146 foreign import ccall "setIOManagerPipe"
1147 c_setIOManagerPipe :: CInt -> IO ()
1149 foreign import ccall "__hscore_sizeof_siginfo_t"
1150 sizeof_siginfo_t :: CSize
1156 type HandlerFun = ForeignPtr Word8 -> IO ()
1158 -- Lock used to protect concurrent access to signal_handlers. Symptom of
1159 -- this race condition is #1922, although that bug was on Windows a similar
1160 -- bug also exists on Unix.
1161 {-# NOINLINE signal_handlers #-}
1162 signal_handlers :: MVar (IOArray Int (Maybe (HandlerFun,Dynamic)))
1163 signal_handlers = unsafePerformIO $ do
1164 arr <- newIOArray (0,maxSig) Nothing
1166 sharedCAF m getOrSetGHCConcSignalHandlerStore
1168 foreign import ccall unsafe "getOrSetGHCConcSignalHandlerStore"
1169 getOrSetGHCConcSignalHandlerStore :: Ptr a -> IO (Ptr a)
1171 setHandler :: Signal -> Maybe (HandlerFun,Dynamic) -> IO (Maybe (HandlerFun,Dynamic))
1172 setHandler sig handler = do
1173 let int = fromIntegral sig
1174 withMVar signal_handlers $ \arr ->
1175 if not (inRange (boundsIOArray arr) int)
1176 then error "GHC.Conc.setHandler: signal out of range"
1177 else do old <- unsafeReadIOArray arr int
1178 unsafeWriteIOArray arr int handler
1181 -- -----------------------------------------------------------------------------
1184 buildFdSets :: Fd -> Ptr CFdSet -> Ptr CFdSet -> [IOReq] -> IO Fd
1185 buildFdSets maxfd _ _ [] = return maxfd
1186 buildFdSets maxfd readfds writefds (Read fd _ : reqs)
1187 | fd >= fD_SETSIZE = error "buildFdSets: file descriptor out of range"
1190 buildFdSets (max maxfd fd) readfds writefds reqs
1191 buildFdSets maxfd readfds writefds (Write fd _ : reqs)
1192 | fd >= fD_SETSIZE = error "buildFdSets: file descriptor out of range"
1195 buildFdSets (max maxfd fd) readfds writefds reqs
1197 completeRequests :: [IOReq] -> Ptr CFdSet -> Ptr CFdSet -> [IOReq]
1199 completeRequests [] _ _ reqs' = return reqs'
1200 completeRequests (Read fd m : reqs) readfds writefds reqs' = do
1201 b <- fdIsSet fd readfds
1203 then do putMVar m (); completeRequests reqs readfds writefds reqs'
1204 else completeRequests reqs readfds writefds (Read fd m : reqs')
1205 completeRequests (Write fd m : reqs) readfds writefds reqs' = do
1206 b <- fdIsSet fd writefds
1208 then do putMVar m (); completeRequests reqs readfds writefds reqs'
1209 else completeRequests reqs readfds writefds (Write fd m : reqs')
1211 wakeupAll :: [IOReq] -> IO ()
1212 wakeupAll [] = return ()
1213 wakeupAll (Read _ m : reqs) = do putMVar m (); wakeupAll reqs
1214 wakeupAll (Write _ m : reqs) = do putMVar m (); wakeupAll reqs
1216 waitForReadEvent :: Fd -> IO ()
1217 waitForReadEvent fd = do
1219 atomicModifyIORef pendingEvents (\xs -> (Read fd m : xs, ()))
1223 waitForWriteEvent :: Fd -> IO ()
1224 waitForWriteEvent fd = do
1226 atomicModifyIORef pendingEvents (\xs -> (Write fd m : xs, ()))
1230 -- -----------------------------------------------------------------------------
1233 -- Walk the queue of pending delays, waking up any that have passed
1234 -- and return the smallest delay to wait for. The queue of pending
1235 -- delays is kept ordered.
1236 getDelay :: USecs -> Ptr CTimeVal -> [DelayReq] -> IO ([DelayReq], Ptr CTimeVal)
1237 getDelay _ _ [] = return ([],nullPtr)
1238 getDelay now ptimeval all@(d : rest)
1240 Delay time m | now >= time -> do
1242 getDelay now ptimeval rest
1243 DelaySTM time t | now >= time -> do
1244 atomically $ writeTVar t True
1245 getDelay now ptimeval rest
1247 setTimevalTicks ptimeval (delayTime d - now)
1248 return (all,ptimeval)
1252 foreign import ccall unsafe "sizeofTimeVal"
1253 sizeofTimeVal :: Int
1255 foreign import ccall unsafe "setTimevalTicks"
1256 setTimevalTicks :: Ptr CTimeVal -> USecs -> IO ()
1259 On Win32 we're going to have a single Pipe, and a
1260 waitForSingleObject with the delay time. For signals, we send a
1261 byte down the pipe just like on Unix.
1264 -- ----------------------------------------------------------------------------
1265 -- select() interface
1267 -- ToDo: move to System.Posix.Internals?
1271 foreign import ccall safe "__hscore_select"
1272 c_select :: CInt -> Ptr CFdSet -> Ptr CFdSet -> Ptr CFdSet -> Ptr CTimeVal
1275 foreign import ccall unsafe "hsFD_SETSIZE"
1276 c_fD_SETSIZE :: CInt
1279 fD_SETSIZE = fromIntegral c_fD_SETSIZE
1281 foreign import ccall unsafe "hsFD_ISSET"
1282 c_fdIsSet :: CInt -> Ptr CFdSet -> IO CInt
1284 fdIsSet :: Fd -> Ptr CFdSet -> IO CInt
1285 fdIsSet (Fd fd) fdset = c_fdIsSet fd fdset
1287 foreign import ccall unsafe "hsFD_SET"
1288 c_fdSet :: CInt -> Ptr CFdSet -> IO ()
1290 fdSet :: Fd -> Ptr CFdSet -> IO ()
1291 fdSet (Fd fd) fdset = c_fdSet fd fdset
1293 foreign import ccall unsafe "hsFD_ZERO"
1294 fdZero :: Ptr CFdSet -> IO ()
1296 foreign import ccall unsafe "sizeof_fd_set"
1301 reportStackOverflow :: IO ()
1302 reportStackOverflow = callStackOverflowHook
1304 reportError :: SomeException -> IO ()
1306 handler <- getUncaughtExceptionHandler
1309 -- SUP: Are the hooks allowed to re-enter Haskell land? If so, remove
1310 -- the unsafe below.
1311 foreign import ccall unsafe "stackOverflow"
1312 callStackOverflowHook :: IO ()
1314 {-# NOINLINE uncaughtExceptionHandler #-}
1315 uncaughtExceptionHandler :: IORef (SomeException -> IO ())
1316 uncaughtExceptionHandler = unsafePerformIO (newIORef defaultHandler)
1318 defaultHandler :: SomeException -> IO ()
1319 defaultHandler se@(SomeException ex) = do
1320 (hFlush stdout) `catchAny` (\ _ -> return ())
1321 let msg = case cast ex of
1322 Just Deadlock -> "no threads to run: infinite loop or deadlock?"
1323 _ -> case cast ex of
1324 Just (ErrorCall s) -> s
1325 _ -> showsPrec 0 se ""
1326 withCString "%s" $ \cfmt ->
1327 withCString msg $ \cmsg ->
1328 errorBelch cfmt cmsg
1330 -- don't use errorBelch() directly, because we cannot call varargs functions
1332 foreign import ccall unsafe "HsBase.h errorBelch2"
1333 errorBelch :: CString -> CString -> IO ()
1335 setUncaughtExceptionHandler :: (SomeException -> IO ()) -> IO ()
1336 setUncaughtExceptionHandler = writeIORef uncaughtExceptionHandler
1338 getUncaughtExceptionHandler :: IO (SomeException -> IO ())
1339 getUncaughtExceptionHandler = readIORef uncaughtExceptionHandler