omango 0.2.4

Lock-free collections
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

<p align="center">
  <a href='https://postimg.cc/1gBgL2MX' target='_blank'>
    <img src='https://i.postimg.cc/1gBgL2MX/Pngtree-omango-in-flat-style-omango-3626110.png' border='0' alt='Pngtree-omango-in-flat-style-omango-3626110'/>
  </a>
</p>
<br/>
<p align="center">
  <a href="https://github.com/tqtrungse/omango/actions/workflows/rust.yml"><img src="https://github.com/tqtrungse/omango/actions/workflows/rust.yml/badge.svg?branch=master" alt="Rust"></a>
  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
  <a href="https://github.com/tqtrungse/omango"><img src="https://img.shields.io/github/v/release/tqtrungse/omango" alt="Release"></a>
  <a href="https://crates.io/crates/omango"><img src="https://img.shields.io/crates/v/omango.svg" alt="Cargo"></a>
  <a href="https://www.rust-lang.org"><img src="https://img.shields.io/badge/rust-1.49+-lightgray.svg" alt="Rust 1.49+"></a>
</p>
<br/>

# Omango


This is a concurrency library.<br />

The crate provides a lock-free bounded and unbounded single-producer-single-consumer channel and
multi-producer-multi-consumer channel.<br />

The queues are simple, lightweight, fast and safe in multithreading environment.
It is faster than [std::mpsc::sync_channel](https://github.com/rust-lang/rust/tree/master/library/std/src/sync/mpsc) 
and other open source's bounded queue (
    [ringbuf](https://github.com/agerasev/ringbuf), 
    [rtrb](https://github.com/mgeier/rtrb), 
    [flume](https://github.com/zesterer/flume), 
    [crossbeam-channel](https://github.com/crossbeam-rs/crossbeam/tree/master/crossbeam-channel)
). <br/>

## Table of Contents


- [Introduction](#introduction)
- [Usage](#usage)
- [Compatibility](#compatibility)
- [Benchmarks](#benchmarks)
- [License](#license)
- [Reference](#refecence)

## Introduction


Both `SPSC` and `MPMC` queue are implemented based on pseudocode of [Dmitry Vyukov](https://docs.google.com/document/d/1yIAYmbvL3JxOKOjuCyon7JhW4cSv1wy5hC0ApeGMV9s/pub).
The implementation way is exactly the same. But there are still some differences between them about wait-retry and blocking.<br />

`MPMC` is high contention multithreading environment. If the retry is continuous and immediate, the CPU cache coherence
will be increased rapidly and decrease performance. Therefore, we must wait then retry.
However, this thing is unsuitable in `SPSC` is lower contention multithreading environment (Just 2 threads).
In `SPSC`, the immediate retry still guarantees performance.<br />

Both `SPSC` and `MPMC` queue can be used as channels.<br /><br />

#### Compared with version 0.1.*


* Performance is better.


* Supported unbounded queues (SPSC + MPMC).


* Can use `recv` to get remaining items when the queue was closed.

## Usage


Add this to your `Cargo.toml`:
```toml
[dependencies]
omango = "0.2.4"
```

## Compatibility


The minimum supported Rust version is `1.57`.

## Benchmarks


Tests were performed on an Intel Core I5 with 4 cores running Windows 10 and 
M1 with 8 cores running macOS BigSur 11.3.

# <img src="./misc/SPSC.png" alt="Omango benchmarks SPSC" width="100%"/>

# <img src="./misc/MPSC.png" alt="Omango benchmarks MPSC" width="100%"/>

# <img src="./misc/MPMC.png" alt="Omango benchmarks MPMC" width="100%"/>

# <img src="./misc/Unbounded.png" alt="Omango benchmarks Unbounded" width="100%"/>


## License


The crate is licensed under the terms of the MIT
license. See [LICENSE](LICENSE) for more information.

## Reference


* [Crossbeam-Channel](https://github.com/crossbeam-rs/crossbeam/tree/master/crossbeam-channel)
* [Blog of Dmitry Vyukov](https://docs.google.com/document/d/1yIAYmbvL3JxOKOjuCyon7JhW4cSv1wy5hC0ApeGMV9s/pub)
* [The cache coherence protocols](https://www.sciencedirect.com/topics/engineering/cache-coherence)
* [CppCon 2017: C++ atomics, from basic to advanced](https://www.youtube.com/watch?v=ZQFzMfHIxng)