unliftio-messagebox: Fast and robust message queues for concurrent processes

[ bsd2, concurrency, library, program ] [ Propose Tags ]

Please see the README on GitHub at https://github.com/sheyll/unliftio-messagebox#readme

[Skip to Readme]
Versions [RSS] [faq] 1.0.0, 1.0.2, 2.0.0
Dependencies atomic-primops, base (>=4.14 && <5), containers (>=0.5.8 && <0.7), data-default (==0.7.*), hashable, mtl, QuickCheck, text, unagi-chan, unliftio, unliftio-messagebox [details]
License BSD-2-Clause
Copyright Copyright Sven Heyll
Author Sven Heyll
Maintainer sven.heyll@gmail.com
Category Concurrency
Home page https://github.com/sheyll/unliftio-messagebox#readme
Bug tracker https://github.com/sheyll/unliftio-messagebox/issues
Source repo head: git clone https://github.com/sheyll/unliftio-messagebox
Uploaded by SvenHeyll at 2021-02-16T15:18:50Z
Distributions NixOS:2.0.0
Executables unliftio-messagebox-memleak-test
Downloads 178 total (8 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2021-02-16 [all 1 reports]


[Index] [Quick Jump]

Manual Flags


Configure a development version, i.e. -fprof-auto and -Werror

Automatic Flags

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info


Maintainer's Corner

For package maintainers and hackage trustees


Readme for unliftio-messagebox-2.0.0

[back to package description]

main Build Results Latest Build Results

Fast and Robust Message Queues for Concurrent Processes

NOTE: To be able to fully view this README, use the GitHub Pages Version.

A thin wrapper around a subset of unagi-chan based on unliftio.

The unit tests and benchmarks in this project excercise a subset of unagi-chan, so hopefully the user of this library doesn't have to worry about this.

This project also aims to implicitly verify parts of unagi-chan.

The overall goal is to reduce the risk of live and dead locks and thread starvation, as well as acceptable performance even in massively concurrent programs.

Module Structure

The library is contained in modules with names starting with UnliftIO.MessageBox.

Module Structure

Also the module UnliftIO.MessageBox (API docs) (Hackage) exposes the API, and can be used to import everything.

The full documentation is either on this page(build log) or on Hackage.


Unit Tests

Heap Profiling

Test Heap Profiling Report

Time Profiling

Test Profiling Report

Memory Leak Tests

This is a small application with a 1002 processes, each performing a fix amount of work.

When the work is done, all processes synchronise before starting a new iteration. After each iteration, the memory usage is queried from the GHC runtime statistics. There are 10 iterations like that.

After that all processes are shutdown, and the process starts all over again, 5 times.

In total 50 iterations.

If memory is leaked it should become visible.

The test program is executed with the +RTS -Mxxxm option that instructs the runtime to limit the available heap to xxx MB, so if there is a memory leak, the program would at some point crash with a heap exhaustion error.

Memleak Test Heap Profiling Report

The output is printed into this log file.