Merge pull request #50 from jmid/lockfree-0.2

Update to lockfree 0.2.0

Author: jmid

multicoretests.opam

@@ -30,7 +30,7 @@ pin-depends: [
   ["ppx_deriving_qcheck.0.2.0" "git+https://github.com/c-cube/qcheck.git#master"]
 
   ["kcas.0.14"                 "git+https://github.com/ocaml-multicore/kcas#master"]
-  ["lockfree.0.13"             "git+https://github.com/ocaml-multicore/lockfree#master"]
+  ["lockfree.v0.2.0"           "git+https://github.com/ocaml-multicore/lockfree#main"]
 ]
 
 build: [

src/domainslib/dune

@@ -1,31 +1,10 @@
-;; test of ws_deque from domainslib
+;; tests of Domainslib
 
 ;; this prevents the tests from running on a default build
 (alias
  (name default)
  (package multicoretests)
- (deps ws_deque_test.exe task_one_dep.exe task_more_deps.exe task_parallel.exe))
-
-(executable
- (name ws_deque_test)
- (modules ws_deque_test)
- (libraries qcheck STM domainslib)
- (preprocess (pps ppx_deriving.show)))
-
-(env
- (_
-  (binaries
-   (../check_error_count.exe as check_error_count))))
-
-(rule
- (alias runtest)
- (package multicoretests)
- (deps ws_deque_test.exe)
- (action
-  (progn
-   (bash "(./ws_deque_test.exe --no-colors --verbose || echo 'test run triggered an error') | tee wsd-output.txt")
-   (run %{bin:check_error_count} "domainslib/ws_deque_test" 1 wsd-output.txt))))
-
+ (deps task_one_dep.exe task_more_deps.exe task_parallel.exe))
 
 ;; tests of Domainslib.Task's async functionality (non-STM)
 

src/lockfree/README.md

@@ -1,7 +1,23 @@
 Tests of the lockfree library
 =============================
 
-Two linearizability tests fail:
+This contains a test of work-stealing deque - the only module in lockfree.v0.2.0.
+
+- A previous version found an issue with `size` sometimes returning `-1` when invoked in parallel.
+  This observation was taken into account for v.0.2.0, which would eliminate `size` and `is_empty` from the interface,
+  leaving only `push`, `pop`, and `steal`.
+
+We test the above in two ways:
+- a positive test lets an owner domain invoke `push` and `pop` and a parallel stealer domain invoke only `steal`.
+- a negative test lets both owner and stealer invoke all three operations, thus breaking the contract.
+
+
+
+
+Older tests
+-----------
+
+An older version tested lockfree.0.1.3 in which two linearizability tests would fail:
 
 - The Lockfree.Hash test in [lin_tests.ml](lin_tests.ml)
 

src/lockfree/dune

@@ -1,16 +1,18 @@
 ;; Test of the lockfree library
 
+;; test of ws_deque
+
 ;; this prevents the tests from running on a default build
 (alias
  (name default)
  (package multicoretests)
- (deps lf_list_test.exe lin_tests.exe))
+ (deps ws_deque_test.exe))
 
 (executable
- (name lf_list_test)
- (modules lf_list_test)
+ (name ws_deque_test)
+ (modules ws_deque_test)
  (libraries qcheck STM lockfree)
- (preprocess (pps ppx_deriving.show ppx_deriving.eq)))
+ (preprocess (pps ppx_deriving.show)))
 
 (env
  (_
@@ -20,24 +22,8 @@
 (rule
  (alias runtest)
  (package multicoretests)
- (deps lf_list_test.exe)
- (action (run ./%{deps} --no-colors --verbose)))
-
-
-;; Linearizability tests of the lockfree library
-
-(executable
- (name lin_tests)
- (modules lin_tests)
- (flags (:standard -w -27))
- (libraries qcheck lin lockfree)
- (preprocess (pps ppx_deriving_qcheck ppx_deriving.show ppx_deriving.eq)))
-
-(rule
- (alias runtest)
- (package multicoretests)
- (deps lin_tests.exe)
+ (deps ws_deque_test.exe)
  (action
   (progn
-   (bash "(./lin_tests.exe --no-colors --verbose || echo 'test run triggered an error') | tee lin-output.txt")
-   (run %{bin:check_error_count} "lockfree/lin_tests" 2 lin-output.txt))))
+   (bash "(./ws_deque_test.exe --no-colors --verbose || echo 'test run triggered an error') | tee wsd-output.txt")
+   (run %{bin:check_error_count} "lockfree/ws_deque_test" 1 wsd-output.txt))))