Prepare release

Author: Sudha247

.github/workflows/main.yml

@@ -8,44 +8,30 @@ on:
     - cron: 0 1 * * MON
 
 jobs:
-  build:
-    strategy:
-      matrix:
-        os:
-          - ubuntu-latest
-          - macos-latest
-        ocaml-compiler:
-          - 5.0.x
-          - ocaml-variants.5.1.0+trunk
-
-    runs-on: ${{ matrix.os }}
+  windows:
+    runs-on: windows-latest
 
     env:
       QCHECK_MSG_INTERVAL: '60'
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Get latest OCaml commit hash
-        id: multicore_hash
-        shell: bash
-        run: |
-          curl -sH "Accept: application/vnd.github.v3+json" \
-          https://api.github.com/repos/ocaml/ocaml/commits/trunk \
-          | jq .commit.tree.sha | xargs printf '::set-output name=commit::%s'
+        uses: actions/checkout@v2
+
       - name: Use OCaml ${{ matrix.ocaml-compiler }}
         uses: ocaml/setup-ocaml@v2
         with:
-          ocaml-compiler: ${{ matrix.ocaml-compiler }}
+          opam-pin: false
+          opam-depext: false
+          ocaml-compiler: ocaml.5.0.0,ocaml-option-mingw
           opam-repositories: |
-            default: https://github.com/ocaml/opam-repository.git
-            alpha: git+https://github.com/kit-ty-kate/opam-alpha-repository
+            dra27: https://github.com/dra27/opam-repository.git#windows-5.0
+            default: https://github.com/ocaml-opam/opam-repository-mingw.git#sunset
+            upstream: https://github.com/ocaml/opam-repository.git
           cache-prefix: ${{ steps.multicore_hash.outputs.commit }}
-          opam-depext: false
 
       - run: opam install . --deps-only --with-test
 
-      - run: opam exec -- make all
+      - run: opam exec -- dune build
 
-      - run: opam exec -- make run_test
+      - run: opam exec -- dune runtest

CHANGES.md

@@ -2,7 +2,20 @@
 
 * `parallel_find` function that stops early (#129, #130)
 
-## v0.5.0
+## 0.5.1
+
+* Add parallel_find (#90, @gasche)
+* Update CI (#93, @Sudha247)
+* Optimisation to work-stealing (#96, @art-w)
+* Improve docs presentation (#99, @metanivek)
+* Property based tests (#100, jmid)
+* Task: avoid double handler installation (#101, @gasche & @clef-men)
+* Fix a benign data-race in Chan reported by ocaml-tsan (#103, @art-w)
+* Dune, opam, and GitHub Actions fixes (#105, @MisterDA)
+* domain local await support (#107, @polytypic)
+* Windows run on GitHub Actions (#110, @Sudha247)
+
+## 0.5.0
 
 This release includes:
 
@@ -13,35 +26,35 @@ This release includes:
 * Breaking change: Rename `num_additional_domains` to `num_domains` for setup_pool
 * Documentation updates (#80, #81, #82)
 
-## v0.4.2
+## 0.4.2
 
 Includes Effect.eff -> Effect.t change from OCaml trunk. (#65)
 
-## v0.4.1
+## 0.4.1
 
 This release fixes compatibility with OCaml 5.00.0+trunk in #61. Breaks compatibility with older Multicore variants 4.12.0+domains and 4.12.0+domains+effects
 
-## v0.4.0
+## 0.4.0
 
 This release includes:
 
 * Usage of effect handlers for task creation. This introduces a breaking change; all computations need to be enclosed in a Task.run function. See #51.
 * Multi_channel uses a per-channel domain-local key, removing the global key. #50
 * Bug fixes in parallel_scan. #60
 
-## v0.3.2
+## 0.3.2
 
 Corresponding updates for breaking changes introduced in ocaml-multicore/ocaml-multicore#704
 
 * Updated with the new interface Domain.cpu_relax
 * Domain.timer_ticks replaced with Mirage clock.
 
-## v0.3.1
+## 0.3.1
 
 * #45 adds support for named pools. This is a breaking change with setup_pool taking an optional name parameter and an extra unit parameter.
 * A minor bug fix in parallel_for_reduce.
 
-## v0.3.0
+## 0.3.0
 
 This release includes:
 
@@ -51,25 +64,25 @@ This release includes:
 * A move to using the Mutex & Condition modules for the implementation of Chan #24.
 * Various documentation and packaging improvements (#21, #27, #30, #32).
 
-## v0.2.2
+## 0.2.2
 
 Updates to:
 
 * parallel_for to use new task distribution algorithm and allow default chunk_size (#16)
 * parallel_for_reduce to use new task distribution algorithm and allow default chunk_size parameter (#18)
 
-## v0.2.1
+## 0.2.1
 
 * `recv_poll` made non-allocating
 * Addition of parallel_scan #5
 
-## v0.2.0
+## 0.2.0
 
 * New Tasks library with support for async/await parallelism and parallel for loops.
 * Adds support for non-blocking Chan.send_poll and Chan.recv_poll.
 
 Thanks to @gasche for API design discussions.
 
-## v0.1.0
+## 0.1.0
 
 Initial release

CODE_OF_CONDUCT.md

@@ -0,0 +1,14 @@
+# Code of Conduct
+
+This project has adopted the [OCaml Code of Conduct](https://github.com/ocaml/code-of-conduct/blob/main/CODE_OF_CONDUCT.md).
+
+# Enforcement
+
+This project follows the OCaml Code of Conduct
+[enforcement policy](https://github.com/ocaml/code-of-conduct/blob/main/CODE_OF_CONDUCT.md#enforcement).
+
+To report any violations, please contact:
+
+* KC Sivaramakrishnan <kc [at] tarides [dot] com>
+* Sudha Parimala <sudha [at] tarides [dot] com>
+* Vesa Karvonen <vesa [at] tarides [dot] com>

domainslib.opam

@@ -2,15 +2,15 @@
 opam-version: "2.0"
 synopsis: "Parallel Structures over Domains for Multicore OCaml"
 maintainer: ["KC Sivaramakrishnan <kc@kcsrk.info>"]
-authors: ["KC Sivaramakrishnan <kc@kcsrk.info>"]
+authors: ["KC Sivaramakrishnan <kc@kcsrk.info>" "Sudha Parimala"]
 license: "ISC"
 homepage: "https://github.com/ocaml-multicore/domainslib"
 doc: "https://kayceesrk.github.io/domainslib/doc"
 bug-reports: "https://github.com/ocaml-multicore/domainslib/issues"
 depends: [
   "dune" {>= "3.0"}
   "ocaml" {>= "5.0"}
-  "lockfree" {>= "0.2.0"}
+  "lockfree" {>= "0.3.1"}
   "domain-local-await" {>= "0.1.0"}
   "kcas" {>= "0.3.0" & with-test}
   "mirage-clock-unix" {with-test & >= "4.2.0"}

test/dune

@@ -1,140 +1,132 @@
 (test
  (name test_chan)
  (libraries domainslib)
- (modules test_chan)
- (modes native))
+ (modules test_chan))
 
 (test
  (name fib)
- (modules fib)
- (modes native))
+ (modules fib))
 
 (test
  (name fib_par)
  (libraries domainslib)
- (modules fib_par)
- (modes native))
+ (modules fib_par))
 
 (test
  (name kcas_integration)
  (libraries domainslib kcas)
- (modules kcas_integration)
- (modes native))
+ (modules kcas_integration))
 
 (test
  (name enumerate_par)
  (libraries domainslib)
- (modules enumerate_par)
- (modes native))
+ (modules enumerate_par))
 
 (test
  (name game_of_life)
- (modules game_of_life)
- (modes native))
+ (modules game_of_life))
 
 (test
  (name game_of_life_multicore)
  (libraries domainslib)
- (modules game_of_life_multicore)
- (modes native))
+ (modules game_of_life_multicore))
 
 (test
  (name LU_decomposition_multicore)
  (libraries domainslib)
  (flags (:standard -runtime-variant d))
  (modules LU_decomposition_multicore)
- (modes native))
+ (enabled_if (or (= %{arch_sixtyfour} true) (<> %{architecture} arm))))
+   ;; disabled temporarily on arm32 due to failure: ocaml/ocaml#12267
 
 
 (test
  (name spectralnorm2)
- (modules spectralnorm2)
- (modes native))
+ (modules spectralnorm2))
 
 (test
-  (name sum_par)
-  (libraries domainslib)
-	(modules sum_par)
-	(modes native))
+ (name sum_par)
+ (libraries domainslib)
+ (modules sum_par))
 
 (test
  (name task_throughput)
  (libraries domainslib mirage-clock-unix)
- (modules task_throughput)
- (modes native))
+ (modules task_throughput))
 
 (test
  (name spectralnorm2_multicore)
  (libraries domainslib)
- (modules spectralnorm2_multicore)
- (modes native))
+ (modules spectralnorm2_multicore))
 
 (test
  (name summed_area_table)
  (libraries domainslib)
- (modules summed_area_table)
- (modes native))
+ (modules summed_area_table))
 
 (test
  (name prefix_sum)
  (libraries domainslib unix)
- (modules prefix_sum)
- (modes native))
+ (modules prefix_sum))
 
 (test
  (name test_task)
  (libraries domainslib)
- (modules test_task)
- (modes native))
+ (modules test_task))
 
 (test
  (name test_parallel_find)
  (libraries domainslib)
- (modules test_parallel_find)
- (modes native))
+ (modules test_parallel_find))
 
 (test
  (name test_deadlock)
  (libraries domainslib)
- (modules test_deadlock)
- (modes native))
+ (modules test_deadlock))
 
 (test
  (name test_task_crash)
  (libraries domainslib)
- (modules test_task_crash)
- (modes native))
+ (modules test_task_crash))
 
 (test
  (name test_task_empty)
  (libraries domainslib)
- (modules test_task_empty)
- (modes native))
+ (modules test_task_empty))
 
 (test
  (name backtrace)
  (libraries domainslib)
  (modules backtrace)
- (modes native))
+ (enabled_if (<> %{system} mingw64)) ;; triggers a known issue on mingw https://github.com/ocaml/ocaml/pull/12231
+ (modes byte native))
+ ;; byte_complete .exes don't include debug+trace info https://github.com/ocaml/dune/issues/7845
+ ;; so on a bytecode switch/platform we build a plain bytecode version w/trace info
+ ;; and rename it to .exe
+(rule
+ (target backtrace.exe)
+ (action (copy backtrace.bc backtrace.exe))
+ (enabled_if (and (= %{bin-available:ocamlopt} false) (<> %{system} mingw64))))
 
 (test
  (name off_by_one)
  (libraries domainslib)
- (modules off_by_one)
- (modes native))
+ (modules off_by_one))
 
 ;; Custom property-based tests using QCheck
 
 (test
  (name task_one_dep)
  (modules task_one_dep)
  (libraries qcheck-multicoretests-util qcheck-core qcheck-core.runner domainslib)
+ (enabled_if %{bin-available:ocamlopt}) ;; takes forever on bytecode
  (action (run %{test} --verbose)))
 
 (test
  (name task_more_deps)
  (modules task_more_deps)
  (libraries qcheck-multicoretests-util qcheck-core qcheck-core.runner domainslib)
+ (enabled_if %{bin-available:ocamlopt}) ;; takes forever on bytecode
  (action (run %{test} --verbose)))
 
 (test

test/off_by_one.ml

@@ -10,11 +10,18 @@ let print_array a =
 let r = Array.init 20 (fun i -> i + 1)
 
 let scan_task num_doms =
-  let pool = Task.setup_pool ~num_domains:num_doms () in
-  let a = Task.run pool (fun () -> Task.parallel_scan pool (+) (Array.make 20 1)) in
-  Task.teardown_pool pool;
-  Printf.printf "%i:  %s\n%!" num_doms (print_array a);
-  assert (a = r)
+  try
+    let pool = Task.setup_pool ~num_domains:num_doms () in
+    let a = Task.run pool (fun () -> Task.parallel_scan pool (+) (Array.make 20 1)) in
+    Task.teardown_pool pool;
+    Printf.printf "%i:  %s\n%!" num_doms (print_array a);
+    assert (a = r)
+  with Failure msg ->
+    begin
+      assert (msg = "failed to allocate domain");
+      Printf.printf "Failed to allocate %i domains, recommended_domain_count: %i\n%!"
+        num_doms (Domain.recommended_domain_count ());
+    end
 ;;
 for num_dom=0 to 21 do
   scan_task num_dom;