Simple Haskell thread management in hierarchical manner
|LTS Haskell 20.16:||0.3.0.2|
|Stackage Nightly 2023-03-27:||0.3.0.2|
|Latest on Hackage:||0.3.0.2|
Module documentation for 0.3.0.2
Managing Haskell threads in hierarchical manner.
This package provides parent-child association and guaranteed clean-up of children over plain Haskell thread. You can terminate all child threads and grand child threads by just killing their parent thread.
Unlike Unix process, plain Haskell thread, created by forkIO, has no parent-child relation each other. This means termination of parent thread doesn’t result its children also terminated. This is good design as a low level API because it gives user greatest flexibility. However, it also means managing entire lifecycle of thread is totally a responsibility of user.
Here one thing you need to be aware. Garbage collection doesn’t work on living thread. When you lost reference to an object, garbage collector frees up the object for you. However, even though you lost the thread ID of your child thread, Haskell runtime doesn’t consider the thread is orphaned. The child thread continue running.
This is prone to create thread leakage. You can accidentally lose thread ID of child thread by crash of parent thread. Now you no longer have way to kill orphaned child thread. This is thread leakage.
The low level forkIO API requires you keep track and manage entire thread lifecycle including accidental case like the above. Hand crafting it might be painful.
This package is intended to provide simple replacement API over plain forkIO in case of when all you need to do on parent termination is just terminating all its children.
If you need to keep your child running after parent terminated, this API is not for you.
Why not withAsync?
The typical use case for this package is TCP server style use case. In such use case, you have to create virtually infinite number of threads and they finish in random timing but you are not so interested in their return value.
withAsync coming with
async package solves different problem than this package.
It is good for taking actions asynchronously but eventually you need their return values.
Or, even you aren’t care of return values, you only need to take several finite number of
Bellow explains why
withAsync is not good for managing large number of threads.
withAsync is essentially a sugar over bracket pattern like this.
withAsync action inner = bracket (async action) uninterruptibleCancel inner
uninterruptibleCancel to the
action is executed on asynchronous exception
at parent thread where withAsync itself is living. However it also guarantees the
is executed on normal exit from
inner too. Thus, the
action can only live within the
lifecycle of the
withAsync call. If you want to keep your
action alive, you have to
inner continue running until your
So, what if let async action go and make recursive call form
inner back to your loop?
It is a bad idea. Because
withAsync is a
bracket, recursive call from
In other words, the difference between
newChild is strategy of un-installing
withAsync uninstalls its cleanup handler based on its lexical scope.
newChild uninstalls it based on actual dynamic thread termination.
Almost all you need to know is one data type and one function:
Threads created by
newChild guarantee automatic cleanup on its exit
regardless normal exit or cancellation by asynchronous exception.
In order to that works properly, user must ensure following rules.
- User provided thread handler must accept
ThreadMapas its first argument.
- When the user provided handler creates its child thread, it must use newChild with given
- For 1st thread you create by newChild, give it a
ThreadMap is house-keeping object for your thread. It is a mutable map keeping track
living child threads of your thread. When your thread handler started, you receives
ThreadMap via 1st argument of your handler. When you create a child thread
of your thread,
newChild automatically update (mutate) your
ThreadMap by adding
newly created child thread. When your child thread terminated, it is automatically removed
Same manner is applied to child thread and grandchild thread as long as you follow the rule the above.
How it works
newChild creates a new thread, it installs two cleanup tasks for you.
- Killing all thread contained in
ThreadMapof the new thread. It kills all children of the new thread.
- Removing the new thread itself from parent’s
The cleanup tasks are called when the new thread exit normally or terminated by asynchronous exception. By this mechanism, termination of top level thread is propagated down to all its children, children of children, and so on.
When you create the first thread managed by this module, create a new empty
ThreadMap then call
newChild with it. The newCall automatically install cleanup routine to the handler you provided.
createRootThread :: IO ThreadId createRootThread = do rootThreadMap <- newThreadMap threadID <- newChild rootThreadMap rootThreadHandler return threadID
When a thread managed by this module creates its child thread, call newChild with
received via handlers argument.
rootThreadHandler :: ThreadMap -> IO () rootThreadHandler myChildrenThreadMap = do void $ newChild myChildrenThreadMap $ \grandChildrenThreadMap -> do yourCode return ()
You can install your own cleanup routine using finally or both resource acquisition and cleanup routine using bracket.
-- Forking a new child with your own cleanup void $ newChild childrenOfCurrentThread $ \childrenOfHandler -> yourThreadHandler `finally` yourCleanupRoutine -- Forking a new child with resource acquisition and cleanup void $ newChild childrenOfCurrentThread $ \childrenOfHandler -> bracket yourResourceAcquiringRoutine yourCleanupRoutine yourThreadHandler
Currently, unlike async function, this module is not designed to back any return value from child thread to parent thread. This module focuses on guaranteed cleanup on thread termination.
- Include .cabal file in source repo.
- Migrate CI from Travis to GitHub Actions.
- Build and test for multiple platforms and GHC versions.
- Move to hpack from hand written cabal project file
- Back to basic. Unlifted APIs to IO.
- Improved implementation of previous fix.
- No longer expose constructor of ThreadMap.
- Fixed BlockedIndefinitelyOnMVar under race condition.
- Fixed space leaks in map operation.
- Timing dependencies are removed from tests.
- Initial release.