blob: 864a9d0caea8f661fee2c4e89e1427f8fc4f5d41 (
plain)
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
|
# Multicore OCaml
A concurrent and shared-memory parallel extension of the OCaml compiler.
Multicore OCaml cleanly separates abstractions for concurrency (overlapped
execution) from parallelism (simultaneous execution). Concurrency is expressed
through [effect handlers](http://kcsrk.info/papers/system_effects_feb_18.pdf)
and parallelism through
[domains](https://github.com/ocaml-multicore/ocaml-multicore/blob/master/stdlib/domain.mli).
Much of the work in supporting shared memory parallelism is the development of a
mostly-concurrent, generational, mark-and-sweep collector that strikes a balance
between single-threaded performance and feature backwards compatibility, and
multicore scalability.
See the
[wiki](https://github.com/ocaml-multicore/ocaml-multicore/wiki) for more
resources.
## Variants
* **Parallel Minor GC (default)** -- A variant that performs stop-the-world parallel
minor collection. The branch is
[`parallel_minor_gc`](https://github.com/ocaml-multicore/ocaml-multicore/tree/parallel_minor_gc).
* **Concurrent Minor GC** -- A variant that garbage collects each domain's minor
heap concurrently. The branch is [`master`](https://github.com/ocaml-multicore/ocaml-multicore/tree/master).
* **Parallel Minor GC + No effect syntax** -- This branch does not have syntax
extension for effects (but includes the compiler and runtime system changes).
The branch is
[`no-effect-syntax`](https://github.com/ocaml-multicore/ocaml-multicore/tree/no-effect-syntax).
This branch is useful to install ppx libraries.
## Installation
If you want to try out Multicore OCaml, the easiest way is to install the compiler using [OPAM](https://github.com/ocaml-multicore/multicore-opam#install-multicore-ocaml).
Parallel programming examples are available in the [domainslib](https://github.com/ocaml-multicore/domainslib/tree/master/test) library.
Effect handler (concurrent programming) examples are available in [effects-examples](https://github.com/kayceesrk/effects-examples) repo.
## Notes
The original README.adoc file has been moved to
[README.stock.adoc](README.stock.adoc).
|
