1 -----------------------------------------------------------------------------
3 -- Module : Control.Concurrent
4 -- Copyright : (c) The University of Glasgow 2001
5 -- License : BSD-style (see the file libraries/base/LICENSE)
7 -- Maintainer : libraries@haskell.org
8 -- Stability : experimental
9 -- Portability : non-portable (concurrency)
11 -- A common interface to a collection of useful concurrency
14 -----------------------------------------------------------------------------
16 module Control.Concurrent (
17 -- * Concurrent Haskell
21 -- * Basic concurrency operations
24 #ifdef __GLASGOW_HASKELL__
29 #ifdef __GLASGOW_HASKELL__
43 #ifdef __GLASGOW_HASKELL__
45 threadDelay, -- :: Int -> IO ()
46 threadWaitRead, -- :: Int -> IO ()
47 threadWaitWrite, -- :: Int -> IO ()
50 -- * Communication abstractions
52 module Control.Concurrent.MVar,
53 module Control.Concurrent.Chan,
54 module Control.Concurrent.QSem,
55 module Control.Concurrent.QSemN,
56 module Control.Concurrent.SampleVar,
58 -- * Merging of streams
60 mergeIO, -- :: [a] -> [a] -> IO [a]
61 nmergeIO, -- :: [[a]] -> IO [a]
65 #ifdef __GLASGOW_HASKELL__
68 rtsSupportsBoundThreads,
75 -- * GHC's implementation of concurrency
77 -- |This section describes features specific to GHC's
78 -- implementation of Concurrent Haskell.
80 -- ** Terminating the program
91 import Control.Exception as Exception
93 #ifdef __GLASGOW_HASKELL__
94 import GHC.Conc ( ThreadId(..), myThreadId, killThread, yield,
95 threadDelay, threadWaitRead, threadWaitWrite )
96 import GHC.TopHandler ( reportStackOverflow, reportError )
97 import GHC.IOBase ( IO(..) )
98 import GHC.IOBase ( unsafeInterleaveIO )
99 import GHC.IOBase ( newIORef, readIORef, writeIORef )
102 import Foreign.StablePtr
103 import Foreign.C.Types ( CInt )
104 import Control.Monad ( when )
111 import Control.Concurrent.MVar
112 import Control.Concurrent.Chan
113 import Control.Concurrent.QSem
114 import Control.Concurrent.QSemN
115 import Control.Concurrent.SampleVar
123 The concurrency extension for Haskell is described in the paper
125 <http://www.haskell.org/ghc/docs/papers/concurrent-haskell.ps.gz>.
127 Concurrency is \"lightweight\", which means that both thread creation
128 and context switching overheads are extremely low. Scheduling of
129 Haskell threads is done internally in the Haskell runtime system, and
130 doesn't make use of any operating system-supplied thread packages.
132 However, if you want to interact with a foreign library that expects your
133 program to use the operating system-supplied thread package, you can do so
134 by using 'forkOS' instead of 'forkIO'.
136 Haskell threads can communicate via 'MVar's, a kind of synchronised
137 mutable variable (see "Control.Concurrent.MVar"). Several common
138 concurrency abstractions can be built from 'MVar's, and these are
139 provided by the "Control.Concurrent" library.
140 In GHC, threads may also communicate via exceptions.
145 Scheduling may be either pre-emptive or co-operative,
146 depending on the implementation of Concurrent Haskell (see below
147 for information related to specific compilers). In a co-operative
148 system, context switches only occur when you use one of the
149 primitives defined in this module. This means that programs such
153 > main = forkIO (write 'a') >> write 'b'
154 > where write c = putChar c >> write c
156 will print either @aaaaaaaaaaaaaa...@ or @bbbbbbbbbbbb...@,
157 instead of some random interleaving of @a@s and @b@s. In
158 practice, cooperative multitasking is sufficient for writing
159 simple graphical user interfaces.
163 Calling a foreign C procedure (such as @getchar@) that blocks waiting
164 for input will block /all/ threads, unless the @threadsafe@ attribute
165 is used on the foreign call (and your compiler \/ operating system
166 supports it). GHC's I\/O system uses non-blocking I\/O internally to
167 implement thread-friendly I\/O, so calling standard Haskell I\/O
168 functions blocks only the thread making the call.
171 -- Thread Ids, specifically the instances of Eq and Ord for these things.
172 -- The ThreadId type itself is defined in std/PrelConc.lhs.
174 -- Rather than define a new primitve, we use a little helper function
175 -- cmp_thread in the RTS.
177 #ifdef __GLASGOW_HASKELL__
178 id2TSO :: ThreadId -> ThreadId#
179 id2TSO (ThreadId t) = t
181 foreign import ccall unsafe "cmp_thread" cmp_thread :: ThreadId# -> ThreadId# -> Int
184 cmpThread :: ThreadId -> ThreadId -> Ordering
186 case cmp_thread (id2TSO t1) (id2TSO t2) of
191 instance Eq ThreadId where
193 case t1 `cmpThread` t2 of
197 instance Ord ThreadId where
200 foreign import ccall unsafe "rts_getThreadId" getThreadId :: ThreadId# -> Int
202 instance Show ThreadId where
204 showString "ThreadId " .
205 showsPrec d (getThreadId (id2TSO t))
208 This sparks off a new thread to run the 'IO' computation passed as the
209 first argument, and returns the 'ThreadId' of the newly created
212 The new thread will be a lightweight thread; if you want to use a foreign
213 library that uses thread-local storage, use 'forkOS' instead.
215 forkIO :: IO () -> IO ThreadId
216 forkIO action = IO $ \ s ->
217 case (fork# action_plus s) of (# s1, id #) -> (# s1, ThreadId id #)
219 action_plus = Exception.catch action childHandler
221 childHandler :: Exception -> IO ()
222 childHandler err = Exception.catch (real_handler err) childHandler
224 real_handler :: Exception -> IO ()
227 -- ignore thread GC and killThread exceptions:
228 BlockedOnDeadMVar -> return ()
229 AsyncException ThreadKilled -> return ()
231 -- report all others:
232 AsyncException StackOverflow -> reportStackOverflow False
233 other -> reportError False other
235 #endif /* __GLASGOW_HASKELL__ */
241 mergeIO :: [a] -> [a] -> IO [a]
242 nmergeIO :: [[a]] -> IO [a]
245 -- The 'mergeIO' and 'nmergeIO' functions fork one thread for each
246 -- input list that concurrently evaluates that list; the results are
247 -- merged into a single output list.
249 -- Note: Hugs does not provide these functions, since they require
250 -- preemptive multitasking.
253 = newEmptyMVar >>= \ tail_node ->
254 newMVar tail_node >>= \ tail_list ->
255 newQSem max_buff_size >>= \ e ->
256 newMVar 2 >>= \ branches_running ->
260 forkIO (suckIO branches_running buff ls) >>
261 forkIO (suckIO branches_running buff rs) >>
262 takeMVar tail_node >>= \ val ->
267 = (MVar (MVar [a]), QSem)
269 suckIO :: MVar Int -> Buffer a -> [a] -> IO ()
271 suckIO branches_running buff@(tail_list,e) vs
273 [] -> takeMVar branches_running >>= \ val ->
275 takeMVar tail_list >>= \ node ->
277 putMVar tail_list node
279 putMVar branches_running (val-1)
282 takeMVar tail_list >>= \ node ->
283 newEmptyMVar >>= \ next_node ->
285 takeMVar next_node >>= \ y ->
287 return y) >>= \ next_node_val ->
288 putMVar node (x:next_node_val) >>
289 putMVar tail_list next_node >>
290 suckIO branches_running buff xs
296 newEmptyMVar >>= \ tail_node ->
297 newMVar tail_node >>= \ tail_list ->
298 newQSem max_buff_size >>= \ e ->
299 newMVar len >>= \ branches_running ->
303 mapIO (\ x -> forkIO (suckIO branches_running buff x)) lss >>
304 takeMVar tail_node >>= \ val ->
308 mapIO f xs = sequence (map f xs)
309 #endif /* __HUGS__ */
311 #ifdef __GLASGOW_HASKELL__
312 -- ---------------------------------------------------------------------------
317 Support for multiple operating system threads and bound threads as described
318 below is currently only available in the GHC runtime system if you use the
319 /-threaded/ option when linking.
321 Other Haskell systems do not currently support multiple operating system threads.
323 A bound thread is a haskell thread that is /bound/ to an operating system
324 thread. While the bound thread is still scheduled by the Haskell run-time
325 system, the operating system thread takes care of all the foreign calls made
328 To a foreign library, the bound thread will look exactly like an ordinary
329 operating system thread created using OS functions like @pthread_create@
332 Bound threads can be created using the 'forkOS' function below. All foreign
333 exported functions are run in a bound thread (bound to the OS thread that
334 called the function). Also, the @main@ action of every Haskell program is
335 run in a bound thread.
337 Why do we need this? Because if a foreign library is called from a thread
338 created using 'forkIO', it won't have access to any /thread-local state/ -
339 state variables that have specific values for each OS thread
340 (see POSIX's @pthread_key_create@ or Win32's @TlsAlloc@). Therefore, some
341 libraries (OpenGL, for example) will not work from a thread created using
342 'forkIO'. They work fine in threads created using 'forkOS' or when called
343 from @main@ or from a @foreign export@.
346 -- | 'True' if bound threads are supported.
347 -- If @rtsSupportsBoundThreads@ is 'False', 'isCurrentThreadBound'
348 -- will always return 'False' and both 'forkOS' and 'runInBoundThread' will
350 foreign import ccall rtsSupportsBoundThreads :: Bool
354 Like 'forkIO', this sparks off a new thread to run the 'IO' computation passed as the
355 first argument, and returns the 'ThreadId' of the newly created
358 However, @forkOS@ uses operating system-supplied multithreading support to create
359 a new operating system thread. The new thread is /bound/, which means that
360 all foreign calls made by the 'IO' computation are guaranteed to be executed
361 in this new operating system thread; also, the operating system thread is not
362 used for any other foreign calls.
364 This means that you can use all kinds of foreign libraries from this thread
365 (even those that rely on thread-local state), without the limitations of 'forkIO'.
367 forkOS :: IO () -> IO ThreadId
369 foreign export ccall forkOS_entry
370 :: StablePtr (IO ()) -> IO ()
372 foreign import ccall "forkOS_entry" forkOS_entry_reimported
373 :: StablePtr (IO ()) -> IO ()
375 forkOS_entry stableAction = do
376 action <- deRefStablePtr stableAction
379 foreign import ccall forkOS_createThread
380 :: StablePtr (IO ()) -> IO CInt
382 failNonThreaded = fail $ "RTS doesn't support multiple OS threads "
383 ++"(use ghc -threaded when linking)"
386 | rtsSupportsBoundThreads = do
388 let action_plus = Exception.catch action childHandler
389 entry <- newStablePtr (myThreadId >>= putMVar mv >> action_plus)
390 err <- forkOS_createThread entry
391 when (err /= 0) $ fail "Cannot create OS thread."
395 | otherwise = failNonThreaded
397 -- | Returns 'True' if the calling thread is /bound/, that is, if it is
398 -- safe to use foreign libraries that rely on thread-local state from the
400 isCurrentThreadBound :: IO Bool
401 isCurrentThreadBound = IO $ \ s# ->
402 case isCurrentThreadBound# s# of
403 (# s2#, flg #) -> (# s2#, not (flg ==# 0#) #)
407 Run the 'IO' computation passed as the first argument. If the calling thread
408 is not /bound/, a bound thread is created temporarily. @runInBoundThread@
409 doesn't finish until the 'IO' computation finishes.
411 You can wrap a series of foreign function calls that rely on thread-local state
412 with @runInBoundThread@ so that you can use them without knowing whether the
413 current thread is /bound/.
415 runInBoundThread :: IO a -> IO a
417 runInBoundThread action
418 | rtsSupportsBoundThreads = do
419 bound <- isCurrentThreadBound
423 ref <- newIORef undefined
424 let action_plus = Exception.try action >>= writeIORef ref
426 bracket (newStablePtr action_plus)
428 (\cEntry -> forkOS_entry_reimported cEntry >> readIORef ref)
429 case resultOrException of
430 Left exception -> Exception.throw exception
431 Right result -> return result
432 | otherwise = failNonThreaded
435 Run the 'IO' computation passed as the first argument. If the calling thread
436 is /bound/, an unbound thread is created temporarily using 'forkIO'.
437 @runInBoundThread@ doesn't finish until the 'IO' computation finishes.
439 Use this function /only/ in the rare case that you have actually observed a
440 performance loss due to the use of bound threads. A program that
441 doesn't need it's main thread to be bound and makes /heavy/ use of concurrency
442 (e.g. a web server), might want to wrap it's @main@ action in
443 @runInUnboundThread@.
445 runInUnboundThread :: IO a -> IO a
447 runInUnboundThread action = do
448 bound <- isCurrentThreadBound
452 forkIO (Exception.try action >>= putMVar mv)
453 takeMVar mv >>= \either -> case either of
454 Left exception -> Exception.throw exception
455 Right result -> return result
458 #endif /* __GLASGOW_HASKELL__ */
460 -- ---------------------------------------------------------------------------
465 In a standalone GHC program, only the main thread is
466 required to terminate in order for the process to terminate.
467 Thus all other forked threads will simply terminate at the same
468 time as the main thread (the terminology for this kind of
469 behaviour is \"daemonic threads\").
471 If you want the program to wait for child threads to
472 finish before exiting, you need to program this yourself. A
473 simple mechanism is to have each child thread write to an
474 'MVar' when it completes, and have the main
475 thread wait on all the 'MVar's before
478 > myForkIO :: IO () -> IO (MVar ())
480 > mvar \<- newEmptyMVar
481 > forkIO (io \`finally\` putMVar mvar ())
484 Note that we use 'finally' from the
485 "Control.Exception" module to make sure that the
486 'MVar' is written to even if the thread dies or
487 is killed for some reason.
489 A better method is to keep a global list of all child
490 threads which we should wait for at the end of the program:
492 > children :: MVar [MVar ()]
493 > children = unsafePerformIO (newMVar [])
495 > waitForChildren :: IO ()
496 > waitForChildren = do
497 > (mvar:mvars) \<- takeMVar children
498 > putMVar children mvars
502 > forkChild :: IO () -> IO ()
504 > mvar \<- newEmptyMVar
505 > forkIO (p \`finally\` putMVar mvar ())
506 > childs \<- takeMVar children
507 > putMVar children (mvar:childs)
509 > later = flip finally
512 > later waitForChildren $
515 The main thread principle also applies to calls to Haskell from
516 outside, using @foreign export@. When the @foreign export@ed
517 function is invoked, it starts a new main thread, and it returns
518 when this main thread terminates. If the call causes new
519 threads to be forked, they may remain in the system after the
520 @foreign export@ed function has returned.
525 GHC implements pre-emptive multitasking: the execution of
526 threads are interleaved in a random fashion. More specifically,
527 a thread may be pre-empted whenever it allocates some memory,
528 which unfortunately means that tight loops which do no
529 allocation tend to lock out other threads (this only seems to
530 happen with pathological benchmark-style code, however).
532 The rescheduling timer runs on a 20ms granularity by
533 default, but this may be altered using the
534 @-i\<n\>@ RTS option. After a rescheduling
535 \"tick\" the running thread is pre-empted as soon as
539 @aaaa@ @bbbb@ example may not
540 work too well on GHC (see Scheduling, above), due
541 to the locking on a 'System.IO.Handle'. Only one thread
542 may hold the lock on a 'System.IO.Handle' at any one
543 time, so if a reschedule happens while a thread is holding the
544 lock, the other thread won't be able to run. The upshot is that
545 the switch from @aaaa@ to
546 @bbbbb@ happens infrequently. It can be
547 improved by lowering the reschedule tick period. We also have a
548 patch that causes a reschedule whenever a thread waiting on a
549 lock is woken up, but haven't found it to be useful for anything
550 other than this example :-)