Remove Saturn_lockfree package. (#159)

ocaml-multicore · Nov 5, 2024 · 37d41e2 · 37d41e2
1 parent 357c1fe
commit 37d41e2
Show file tree

Hide file tree

Showing 76 changed files with 169 additions and 359 deletions.
diff --git a/bench/bench_htbl.ml b/bench/bench_htbl.ml
@@ -74,6 +74,6 @@ let run_suite ~budgetf =
   in
   List.fold_right2
     (fun safe unsafe acc -> safe :: unsafe :: acc)
-    (run ~unsafe:false (module Saturn_lockfree.Htbl))
-    (run ~unsafe:true (module Saturn_lockfree.Htbl_unsafe))
+    (run ~unsafe:false (module Saturn.Htbl))
+    (run ~unsafe:true (module Saturn.Htbl_unsafe))
     []
diff --git a/bench/bench_queue.ml b/bench/bench_queue.ml
@@ -1,5 +1,5 @@
 open Multicore_bench
-module Queue = Saturn_lockfree.Queue
+module Queue = Saturn.Queue
 
 let run_one_domain ~budgetf ?(n_msgs = 50 * Util.iter_factor) () =
   let t = Queue.create () in

diff --git a/bench/bench_size.ml b/bench/bench_size.ml
@@ -1,5 +1,5 @@
 open Multicore_bench
-module Size = Saturn_lockfree.Size
+module Size = Saturn.Size
 
 let run_one ~budgetf ~n_domains ?(n_ops = 250 * n_domains * Util.iter_factor) ()
     =

diff --git a/bench/bench_spsc_queue.ml b/bench/bench_spsc_queue.ml
@@ -5,7 +5,7 @@ let run_one ~unsafe ~budgetf ?(size_exponent = 3)
   let init _ = () in
   let work, before =
     if unsafe then
-      let module Queue = Saturn_lockfree.Single_prod_single_cons_queue_unsafe in
+      let module Queue = Saturn.Single_prod_single_cons_queue_unsafe in
       let t = Queue.create ~size_exponent in
 
       let before () =
@@ -41,7 +41,7 @@ let run_one ~unsafe ~budgetf ?(size_exponent = 3)
       in
       (work, before)
     else
-      let module Queue = Saturn_lockfree.Single_prod_single_cons_queue in
+      let module Queue = Saturn.Single_prod_single_cons_queue in
       let t = Queue.create ~size_exponent in
 
       let before () =

diff --git a/bench/bench_stack.ml b/bench/bench_stack.ml
@@ -1,5 +1,5 @@
 open Multicore_bench
-module Stack = Saturn_lockfree.Stack
+module Stack = Saturn.Stack
 
 let run_one_domain ~budgetf ?(n_msgs = 50 * Util.iter_factor) () =
   let t = Stack.create () in

diff --git a/bench/bench_ws_deque.ml b/bench/bench_ws_deque.ml
@@ -1,5 +1,5 @@
 open Multicore_bench
-module Ws_deque = Saturn_lockfree.Work_stealing_deque
+module Ws_deque = Saturn.Work_stealing_deque
 
 let run_as_scheduler ~budgetf ?(n_domains = 1) () =
   let spawns =

diff --git a/bench/dune b/bench/dune
@@ -9,8 +9,8 @@ let () =
 
 (rule
  (action
-  (copy ../src_lockfree/htbl/htbl_intf.mli htbl_intf.ml))
- (package saturn_lockfree))
+  (copy ../src/htbl/htbl_intf.mli htbl_intf.ml))
+ (package saturn))
 
 (test
  (package saturn)

diff --git a/bench/main.ml b/bench/main.ml
@@ -1,12 +1,12 @@
 let benchmarks =
   [
-    ("Saturn_lockfree Queue", Bench_queue.run_suite);
-    ("Saturn_lockfree Single_prod_single_cons_queue", Bench_spsc_queue.run_suite);
-    ("Saturn_lockfree Size", Bench_size.run_suite);
-    ("Saturn_lockfree Skiplist", Bench_skiplist.run_suite);
-    ("Saturn_lockfree Htbl", Bench_htbl.run_suite);
-    ("Saturn_lockfree Stack", Bench_stack.run_suite);
-    ("Saturn_lockfree Work_stealing_deque", Bench_ws_deque.run_suite);
+    ("Saturn Queue", Bench_queue.run_suite);
+    ("Saturn Single_prod_single_cons_queue", Bench_spsc_queue.run_suite);
+    ("Saturn Size", Bench_size.run_suite);
+    ("Saturn Skiplist", Bench_skiplist.run_suite);
+    ("Saturn Htbl", Bench_htbl.run_suite);
+    ("Saturn Stack", Bench_stack.run_suite);
+    ("Saturn Work_stealing_deque", Bench_ws_deque.run_suite);
   ]
 
 let () = Multicore_bench.Cmd.run ~benchmarks ()
diff --git a/dune-project b/dune-project
@@ -12,42 +12,21 @@
 
 (package
  (name saturn)
- (synopsis "Collection of parallelism-safe data structures for Multicore OCaml")
+ (synopsis "Collection of concurent-safe data structures for Multicore OCaml")
  (depends
   (ocaml (>= 4.14))
+  (backoff (>= 0.1.0))
+  (multicore-magic (>= 2.3.0))
+  (alcotest (and (>= 1.7.0) :with-test))
   (domain_shims (and (>= 0.1.0) :with-test))
-  (saturn_lockfree (= :version))
+  (dscheck (and (>= 0.5.0) :with-test))
   (mdx (and (>= 0.4) :with-test))
-  (multicore-magic (and (>= 2.3.0) :with-test))
   (multicore-bench (and (>= 0.1.7) :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.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.14))
-  (domain_shims (and (>= 0.1.0) :with-test))
-  (backoff (>= 0.1.0))
-  (multicore-magic (>= 2.3.0))
-  (multicore-magic-dscheck (and (>= 2.3.0) :with-test))
-  (mdx (and (>= 0.4) :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.5.0) :with-test))
   (sherlodoc (and (>= 0.2) :with-doc))
   (odoc (and (>= 2.4.1) :with-doc))))
diff --git a/saturn.opam b/saturn.opam
@@ -1,7 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-synopsis:
-  "Collection of parallelism-safe data structures for Multicore OCaml"
+synopsis: "Collection of concurent-safe data structures for Multicore OCaml"
 maintainer: ["Carine Morel" "KC Sivaramakrishnan" "Sudha Parimala"]
 authors: ["KC Sivaramakrishnan"]
 license: "ISC"
@@ -11,19 +10,19 @@ bug-reports: "https://github.com/ocaml-multicore/saturn/issues"
 depends: [
   "dune" {>= "3.14"}
   "ocaml" {>= "4.14"}
+  "backoff" {>= "0.1.0"}
+  "multicore-magic" {>= "2.3.0"}
+  "alcotest" {>= "1.7.0" & with-test}
   "domain_shims" {>= "0.1.0" & with-test}
-  "saturn_lockfree" {= version}
+  "dscheck" {>= "0.5.0" & with-test}
   "mdx" {>= "0.4" & with-test}
-  "multicore-magic" {>= "2.3.0" & with-test}
   "multicore-bench" {>= "0.1.7" & 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}
+  "qcheck-core" {>= "0.21.3" & with-test}
+  "qcheck-stm" {>= "0.3" & with-test}
   "yojson" {>= "2.0.2" & with-test}
-  "dscheck" {>= "0.5.0" & with-test}
   "sherlodoc" {>= "0.2" & with-doc}
   "odoc" {>= "2.4.1" & with-doc}
 ]

diff --git a/saturn_lockfree.opam b/saturn_lockfree.opam
diff --git a/src_lockfree/ArrayExtra.ml → src/ArrayExtra.ml b/src_lockfree/ArrayExtra.ml → src/ArrayExtra.ml
diff --git a/src_lockfree/atomic.without_contended.ml → src/atomic.without_contended.ml b/src_lockfree/atomic.without_contended.ml → src/atomic.without_contended.ml
diff --git a/src/dune b/src/dune
@@ -7,11 +7,13 @@ let () =
   Jbuild_plugin.V1.send
   @@ {|
 
+ (include_subdirs unqualified)
+
 (library
  (name saturn)
  (public_name saturn)
- (libraries
-  (re_export saturn_lockfree) |}
+ (modules_without_implementation htbl_intf)
+ (libraries backoff multicore-magic |}
   ^ maybe_threads
   ^ {| ))
 
@@ -20,4 +22,10 @@ let () =
   (< %{ocaml_version} 5.0.0))
  (action
   (copy domain.ocaml4.ml domain.ml)))
+
+(rule
+ (enabled_if
+  (< %{ocaml_version} 5.2.0))
+ (action
+  (copy atomic.without_contended.ml atomic.ml))) 
 |}
diff --git a/src_lockfree/htbl/dune → src/htbl/dune b/src_lockfree/htbl/dune → src/htbl/dune
@@ -19,10 +19,10 @@
     (cat htbl.body.ml)))))
 
 (mdx
- (package saturn_lockfree)
+ (package saturn)
  (enabled_if
   (and
    (<> %{os_type} Win32)
    (>= %{ocaml_version} 5.1.0)))
- (libraries saturn_lockfree)
+ (libraries saturn)
  (files htbl_intf.mli))
diff --git a/src_lockfree/htbl/htbl.body.ml → src/htbl/htbl.body.ml b/src_lockfree/htbl/htbl.body.ml → src/htbl/htbl.body.ml
diff --git a/src_lockfree/htbl/htbl.head_safe.ml → src/htbl/htbl.head_safe.ml b/src_lockfree/htbl/htbl.head_safe.ml → src/htbl/htbl.head_safe.ml
diff --git a/src_lockfree/htbl/htbl.head_unsafe.ml → src/htbl/htbl.head_unsafe.ml b/src_lockfree/htbl/htbl.head_unsafe.ml → src/htbl/htbl.head_unsafe.ml
diff --git a/src_lockfree/htbl/htbl.mli → src/htbl/htbl.mli b/src_lockfree/htbl/htbl.mli → src/htbl/htbl.mli
diff --git a/src_lockfree/htbl/htbl_intf.mli → src/htbl/htbl_intf.mli b/src_lockfree/htbl/htbl_intf.mli → src/htbl/htbl_intf.mli
@@ -146,8 +146,8 @@ module type HTBL = sig
 
     An example top-level session:
     {[
-      # module Htbl = Saturn_lockfree.Htbl
-      module Htbl = Saturn_lockfree.Htbl
+      # module Htbl = Saturn.Htbl
+      module Htbl = Saturn.Htbl
 
       # let t : (int, string) Htbl.t =
           Htbl.create

diff --git a/src_lockfree/htbl/htbl_unsafe.mli → src/htbl/htbl_unsafe.mli b/src_lockfree/htbl/htbl_unsafe.mli → src/htbl/htbl_unsafe.mli
diff --git a/src_lockfree/htbl/htbl_utils.ml → src/htbl/htbl_utils.ml b/src_lockfree/htbl/htbl_utils.ml → src/htbl/htbl_utils.ml
diff --git a/...ichael_scott_queue/michael_scott_queue.ml → ...ichael_scott_queue/michael_scott_queue.ml b/...ichael_scott_queue/michael_scott_queue.ml → ...ichael_scott_queue/michael_scott_queue.ml
diff --git a/...chael_scott_queue/michael_scott_queue.mli → ...chael_scott_queue/michael_scott_queue.mli b/...chael_scott_queue/michael_scott_queue.mli → ...chael_scott_queue/michael_scott_queue.mli
diff --git a/...l_scott_queue/michael_scott_queue_intf.ml → ...l_scott_queue/michael_scott_queue_intf.ml b/...l_scott_queue/michael_scott_queue_intf.ml → ...l_scott_queue/michael_scott_queue_intf.ml
diff --git a/...scott_queue/michael_scott_queue_unsafe.ml → ...scott_queue/michael_scott_queue_unsafe.ml b/...scott_queue/michael_scott_queue_unsafe.ml → ...scott_queue/michael_scott_queue_unsafe.ml
diff --git a/...cott_queue/michael_scott_queue_unsafe.mli → ...cott_queue/michael_scott_queue_unsafe.mli b/...cott_queue/michael_scott_queue_unsafe.mli → ...cott_queue/michael_scott_queue_unsafe.mli
diff --git a/..._queue/michael_scott_queue_unsafe_node.ml → ..._queue/michael_scott_queue_unsafe_node.ml b/..._queue/michael_scott_queue_unsafe_node.ml → ..._queue/michael_scott_queue_unsafe_node.ml
diff --git a/src_lockfree/mpsc_queue.ml → src/mpsc_queue.ml b/src_lockfree/mpsc_queue.ml → src/mpsc_queue.ml
diff --git a/src_lockfree/mpsc_queue.mli → src/mpsc_queue.mli b/src_lockfree/mpsc_queue.mli → src/mpsc_queue.mli
diff --git a/src/saturn.ml b/src/saturn.ml
@@ -26,18 +26,14 @@ Copyright (c) 2017, Nicolas ASSOUAD <[email protected]>
 ########
 *)
 
-module Queue = Saturn_lockfree.Queue
-module Queue_unsafe = Saturn_lockfree.Queue_unsafe
-module Stack = Saturn_lockfree.Stack
-module Work_stealing_deque = Saturn_lockfree.Work_stealing_deque
-
-module Single_prod_single_cons_queue =
-  Saturn_lockfree.Single_prod_single_cons_queue
-
-module Single_prod_single_cons_queue_unsafe =
-  Saturn_lockfree.Single_prod_single_cons_queue_unsafe
-
-module Single_consumer_queue = Saturn_lockfree.Single_consumer_queue
-module Skiplist = Saturn_lockfree.Skiplist
-module Htbl = Saturn_lockfree.Htbl
-module Htbl_unsafe = Saturn_lockfree.Htbl_unsafe
+module Queue = Michael_scott_queue
+module Queue_unsafe = Michael_scott_queue_unsafe
+module Stack = Treiber_stack
+module Work_stealing_deque = Ws_deque
+module Single_prod_single_cons_queue = Spsc_queue
+module Single_prod_single_cons_queue_unsafe = Spsc_queue_unsafe
+module Single_consumer_queue = Mpsc_queue
+module Size = Size
+module Skiplist = Skiplist
+module Htbl = Htbl
+module Htbl_unsafe = Htbl_unsafe
diff --git a/src/saturn.mli b/src/saturn.mli
@@ -26,22 +26,18 @@ Copyright (c) 2017, Nicolas ASSOUAD <[email protected]>
 ########
 *)
 
-(** Domain-safe data structures for Multicore OCaml *)
+(** Lock-free data structures for Multicore OCaml *)
 
 (** {1 Data structures} *)
 
-module Queue = Saturn_lockfree.Queue
-module Queue_unsafe = Saturn_lockfree.Queue_unsafe
-module Stack = Saturn_lockfree.Stack
-module Work_stealing_deque = Saturn_lockfree.Work_stealing_deque
-
-module Single_prod_single_cons_queue =
-  Saturn_lockfree.Single_prod_single_cons_queue
-
-module Single_prod_single_cons_queue_unsafe =
-  Saturn_lockfree.Single_prod_single_cons_queue_unsafe
-
-module Single_consumer_queue = Saturn_lockfree.Single_consumer_queue
-module Skiplist = Saturn_lockfree.Skiplist
-module Htbl = Saturn_lockfree.Htbl
-module Htbl_unsafe = Saturn_lockfree.Htbl_unsafe
+module Queue = Michael_scott_queue
+module Queue_unsafe = Michael_scott_queue_unsafe
+module Stack = Treiber_stack
+module Work_stealing_deque = Ws_deque
+module Single_prod_single_cons_queue = Spsc_queue
+module Single_prod_single_cons_queue_unsafe = Spsc_queue_unsafe
+module Single_consumer_queue = Mpsc_queue
+module Skiplist = Skiplist
+module Size = Size
+module Htbl = Htbl
+module Htbl_unsafe = Htbl_unsafe
diff --git a/src_lockfree/size.ml → src/size.ml b/src_lockfree/size.ml → src/size.ml
diff --git a/src_lockfree/size.mli → src/size.mli b/src_lockfree/size.mli → src/size.mli
diff --git a/src_lockfree/skiplist.ml → src/skiplist.ml b/src_lockfree/skiplist.ml → src/skiplist.ml
diff --git a/src_lockfree/skiplist.mli → src/skiplist.mli b/src_lockfree/skiplist.mli → src/skiplist.mli
diff --git a/src_lockfree/spsc_queue/spsc_queue.ml → src/spsc_queue/spsc_queue.ml b/src_lockfree/spsc_queue/spsc_queue.ml → src/spsc_queue/spsc_queue.ml
diff --git a/src_lockfree/spsc_queue/spsc_queue.mli → src/spsc_queue/spsc_queue.mli b/src_lockfree/spsc_queue/spsc_queue.mli → src/spsc_queue/spsc_queue.mli
diff --git a/src_lockfree/spsc_queue/spsc_queue_intf.ml → src/spsc_queue/spsc_queue_intf.ml b/src_lockfree/spsc_queue/spsc_queue_intf.ml → src/spsc_queue/spsc_queue_intf.ml
diff --git a/src_lockfree/spsc_queue/spsc_queue_unsafe.ml → src/spsc_queue/spsc_queue_unsafe.ml b/src_lockfree/spsc_queue/spsc_queue_unsafe.ml → src/spsc_queue/spsc_queue_unsafe.ml
diff --git a/...lockfree/spsc_queue/spsc_queue_unsafe.mli → src/spsc_queue/spsc_queue_unsafe.mli b/...lockfree/spsc_queue/spsc_queue_unsafe.mli → src/spsc_queue/spsc_queue_unsafe.mli
diff --git a/src_lockfree/treiber_stack.ml → src/treiber_stack.ml b/src_lockfree/treiber_stack.ml → src/treiber_stack.ml
diff --git a/src_lockfree/treiber_stack.mli → src/treiber_stack.mli b/src_lockfree/treiber_stack.mli → src/treiber_stack.mli
diff --git a/src_lockfree/ws_deque.ml → src/ws_deque.ml b/src_lockfree/ws_deque.ml → src/ws_deque.ml
diff --git a/src_lockfree/ws_deque.mli → src/ws_deque.mli b/src_lockfree/ws_deque.mli → src/ws_deque.mli
diff --git a/src_lockfree/domain.ocaml4.ml b/src_lockfree/domain.ocaml4.ml
diff --git a/src_lockfree/dune b/src_lockfree/dune