Using multicore-magic-dscheck for dscheck tests (#143)

Add multicore-magic-dscheck to write dscheck tests on a data structure using  Multicore-magic.

Author: lyrm

dune-project

@@ -7,39 +7,43 @@
 (authors "KC Sivaramakrishnan")
 (maintainers "Carine Morel" "KC Sivaramakrishnan" "Sudha Parimala")
 (documentation "https://ocaml-multicore.github.io/saturn/")
+
 (package
  (name saturn)
  (synopsis "Collection of parallelism-safe data structures for Multicore OCaml")
  (depends
   (ocaml (>= 4.13))
   (domain_shims (and (>= 0.1.0) :with-test))
   (saturn_lockfree (= :version))
-  (multicore-magic (and (>= 2.1.0) :with-test))
+  (multicore-magic (and (>= 2.3.0) :with-test))
   (multicore-bench (and (>= 0.1.2) :with-test))
+  (multicore-magic-dscheck (and (>= 2.3.0) :with-test))
   (backoff (and (>= 0.1.0) :with-test))
   (alcotest (and (>= 1.7.0) :with-test))
   (qcheck (and (>= 0.21.3) :with-test))
   (qcheck-stm (and (>= 0.3) :with-test))
   (qcheck-alcotest (and (>= 0.21.3) :with-test))
   (yojson (and (>= 2.0.2) :with-test))
-  (dscheck (and (>= 0.4.0) :with-test))
+  (dscheck (and (>= 0.5.0) :with-test))
   (sherlodoc (and (>= 0.2) :with-doc))
   (odoc (and (>= 2.4.1) :with-doc))))
+
 (package
  (name saturn_lockfree)
  (synopsis "Collection of lock-free data structures for Multicore OCaml")
  (depends
   (ocaml (>= 4.13))
   (domain_shims (and (>= 0.1.0) :with-test))
   (backoff (>= 0.1.0))
-  (multicore-magic (>= 2.1.0))
+  (multicore-magic (>= 2.3.0))
+  (multicore-magic-dscheck (and (>= 2.3.0) :with-test))
   (alcotest (and (>= 1.7.0) :with-test))
   (qcheck (and (>= 0.21.3) :with-test))
   (qcheck-core (and (>= 0.21.3) :with-test))
   (qcheck-stm (and (>= 0.3) :with-test))
   (qcheck-multicoretests-util (and (>= 0.3) :with-test))
   (qcheck-alcotest (and (>= 0.21.3) :with-test))
   (yojson (and (>= 2.0.2) :with-test))
-  (dscheck (and (>= 0.4.0) :with-test))
+  (dscheck (and (>= 0.5.0) :with-test))
   (sherlodoc (and (>= 0.2) :with-doc))
   (odoc (and (>= 2.4.1) :with-doc))))

saturn.opam

@@ -13,15 +13,16 @@ depends: [
   "ocaml" {>= "4.13"}
   "domain_shims" {>= "0.1.0" & with-test}
   "saturn_lockfree" {= version}
-  "multicore-magic" {>= "2.1.0" & with-test}
+  "multicore-magic" {>= "2.3.0" & with-test}
   "multicore-bench" {>= "0.1.2" & with-test}
+  "multicore-magic-dscheck" {>= "2.3.0" & with-test}
   "backoff" {>= "0.1.0" & with-test}
   "alcotest" {>= "1.7.0" & with-test}
   "qcheck" {>= "0.21.3" & with-test}
   "qcheck-stm" {>= "0.3" & with-test}
   "qcheck-alcotest" {>= "0.21.3" & with-test}
   "yojson" {>= "2.0.2" & with-test}
-  "dscheck" {>= "0.4.0" & with-test}
+  "dscheck" {>= "0.5.0" & with-test}
   "sherlodoc" {>= "0.2" & with-doc}
   "odoc" {>= "2.4.1" & with-doc}
 ]

saturn_lockfree.opam

@@ -12,15 +12,16 @@ depends: [
   "ocaml" {>= "4.13"}
   "domain_shims" {>= "0.1.0" & with-test}
   "backoff" {>= "0.1.0"}
-  "multicore-magic" {>= "2.1.0"}
+  "multicore-magic" {>= "2.3.0"}
+  "multicore-magic-dscheck" {>= "2.3.0" & with-test}
   "alcotest" {>= "1.7.0" & with-test}
   "qcheck" {>= "0.21.3" & with-test}
   "qcheck-core" {>= "0.21.3" & with-test}
   "qcheck-stm" {>= "0.3" & with-test}
   "qcheck-multicoretests-util" {>= "0.3" & with-test}
   "qcheck-alcotest" {>= "0.21.3" & with-test}
   "yojson" {>= "2.0.2" & with-test}
-  "dscheck" {>= "0.4.0" & with-test}
+  "dscheck" {>= "0.5.0" & with-test}
   "sherlodoc" {>= "0.2" & with-doc}
   "odoc" {>= "2.4.1" & with-doc}
 ]

src_lockfree/size.ml

@@ -15,7 +15,7 @@
 (** ⚠️ Beware that this implementation uses a bunch of low level data
     representation tricks to minimize overheads. *)
 
-module Atomic = Transparent_atomic
+module Atomic = Multicore_magic.Transparent_atomic
 
 let max_value = Int.max_int
 

src_lockfree/skiplist.ml

@@ -28,7 +28,7 @@
 (* TODO: Grow and possibly shrink the skiplist or e.g. adjust search and node
    generation based on the dynamic number of bindings. *)
 
-module Atomic = Transparent_atomic
+module Atomic = Multicore_magic.Transparent_atomic
 
 (* OCaml doesn't allow us to use one of the unused (always 0) bits in pointers
    for the marks and an indirection is needed.  This representation avoids the

src_lockfree/spsc_queue_unsafe.ml

@@ -22,7 +22,7 @@
  * https://dl.acm.org/doi/pdf/10.1145/3437801.3441583
  *)
 
-module Atomic = Transparent_atomic
+module Atomic = Multicore_magic.Transparent_atomic
 
 type not_float = [ `Not_float of not_float ]
 

src_lockfree/transparent_atomic.ml

@@ -1,3 +1 @@
 include Dscheck.TracedAtomic
-
-let make_contended = make

test/atomic/atomic.ml

@@ -1,3 +1,4 @@
+module Atomic = Dscheck.TracedAtomic
 open Linked_set.Make (Atomic) (Size)
 
 let test_underflow_and_overflow () =

test/size/dscheck_size.ml

@@ -14,13 +14,9 @@
  (modules dscheck_size size)
  (build_if
   (>= %{ocaml_version} 5))
- (libraries
-  atomic
-  transparent_atomic
-  linked_set
-  dscheck
-  alcotest
-  multicore-magic))
+ (libraries dscheck linked_set alcotest multicore-magic-dscheck)
+ (flags
+  (:standard -open Multicore_magic_dscheck)))
 
 (test
  (package saturn_lockfree)

test/size/dune

@@ -1,5 +1,13 @@
 open Skiplist
 
+module Atomic = Dscheck.TracedAtomic
+(** This is needed in this order as the skiplist.ml file contains 
+  {[
+  module Atomic = Multicore_magic.Transparent_atomic 
+  ]}
+  which is in multicore-magic-dscheck library only a subset of [Dscheck.TracedAtomic] function.
+*)
+
 let test_max_height_of () =
   let s = create ~max_height:1 ~compare () in
   assert (max_height_of s = 1);

test/skiplist/dscheck_skiplist.ml

@@ -11,7 +11,9 @@
  (modules skiplist size dscheck_skiplist)
  (build_if
   (>= %{ocaml_version} 5))
- (libraries atomic transparent_atomic dscheck alcotest multicore-magic))
+ (libraries alcotest dscheck multicore-magic-dscheck)
+ (flags
+  (:standard -open Multicore_magic_dscheck)))
 
 (test
  (package saturn_lockfree)

test/skiplist/dune

@@ -16,10 +16,12 @@
 (test
  (package saturn_lockfree)
  (name spsc_queue_dscheck)
- (libraries atomic dscheck alcotest multicore-magic transparent_atomic)
+ (libraries alcotest atomic dscheck multicore-magic-dscheck)
  (build_if
   (>= %{ocaml_version} 5))
- (modules spsc_queue spsc_queue_unsafe spsc_queue_intf spsc_queue_dscheck))
+ (modules spsc_queue spsc_queue_unsafe spsc_queue_intf spsc_queue_dscheck)
+ (flags
+  (:standard -open Multicore_magic_dscheck)))
 
 (test
  (package saturn_lockfree)

test/spsc_queue/dune

@@ -1,3 +1,5 @@
+module Atomic = Dscheck.TracedAtomic
+
 module Dscheck_spsc (Spsc_queue : Spsc_queue_intf.SPSC_queue) = struct
   let create_test ~shift_by () =
     let queue = Spsc_queue.create ~size_exponent:2 in