Skip to content
This repository has been archived by the owner on Jun 21, 2024. It is now read-only.

Commit

Permalink
New README file with multicore specific information.
Browse files Browse the repository at this point in the history
The old readme file is now `README.stock.adoc`.
  • Loading branch information
kayceesrk committed Mar 26, 2020
1 parent bf8de04 commit ed197a3
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 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`.
* Concurrent Minor GC -- A variant that garbage collects each domain's minor
heap concurrently. The branch is `master`.

## Notes

The original README.adoc file has been moved to
[README.stock.adoc](README.stock.adoc).
File renamed without changes.

0 comments on commit ed197a3

Please sign in to comment.