Renaming atomicskiplist to skiplist

bench/bench_atomic_skiplist.ml → bench/bench_skiplist.ml

@@ -1,18 +1,18 @@
 open Lockfree
 
 let workload num_elems num_threads add remove =
-  let sl = Atomicskiplist.create () in
+  let sl = Skiplist.create () in
   let elems = Array.init num_elems (fun _ -> Random.int 10000) in
   let push () =
     Domain.spawn (fun () ->
         let start_time = Unix.gettimeofday () in
         for i = 0 to (num_elems - 1) / num_threads do
           Domain.cpu_relax ();
           let prob = Random.float 1.0 in
-          if prob < add then Atomicskiplist.add sl (Random.int 10000) |> ignore
+          if prob < add then Skiplist.add sl (Random.int 10000) |> ignore
           else if prob >= add && prob < add +. remove then
-            Atomicskiplist.remove sl (Random.int 10000) |> ignore
-          else Atomicskiplist.mem sl elems.(i) |> ignore
+            Skiplist.remove sl (Random.int 10000) |> ignore
+          else Skiplist.mem sl elems.(i) |> ignore
         done;
         start_time)
   in

bench/main.ml

@@ -16,10 +16,10 @@ let benchmark_list =
     Mpmc_queue.bench ~use_cas:true ~takers:4 ~pushers:4;
     Mpmc_queue.bench ~use_cas:true ~takers:1 ~pushers:8;
     Mpmc_queue.bench ~use_cas:true ~takers:8 ~pushers:1;
-    Bench_atomic_skiplist.bench ~workload_type:"read_heavy" ~num_elems:2000000
+    Bench_skiplist.bench ~workload_type:"read_heavy" ~num_elems:2000000
+      ~num_threads:2;
+    Bench_skiplist.bench ~workload_type:"moderate_heavy" ~num_elems:2000000
       ~num_threads:2;
-    Bench_atomic_skiplist.bench ~workload_type:"moderate_heavy"
-      ~num_elems:2000000 ~num_threads:2;
   ]
   @ backoff_benchmarks
 

src/atomicskiplist.ml → src/skiplist.ml

@@ -31,7 +31,7 @@ let get_random_level sl =
   count_level 1
 
 (** Create a new skiplist *)
-let create ?(max_height=10) () =
+let create ?(max_height = 10) () =
   let tail = create_new_node Int.max_int max_height in
   let next =
     Array.init (max_height + 1) (fun _ ->

src_lockfree/saturn_lockfree.ml

@@ -33,4 +33,4 @@ module Single_prod_single_cons_queue = Spsc_queue
 module Single_consumer_queue = Mpsc_queue
 module Relaxed_queue = Mpmc_relaxed_queue
 module Backoff = Backoff
-module Atomicskiplist = Atomicskiplist
+module Skiplist = Skiplist

src_lockfree/saturn_lockfree.mli

@@ -40,4 +40,4 @@ module Relaxed_queue = Mpmc_relaxed_queue
 (** {2 Other} *)
 
 module Backoff = Backoff
-module Atomicskiplist = Atomicskiplist
+module Skiplist = Skiplist

test/skiplist/dune

@@ -0,0 +1,22 @@
+(rule
+ (copy ../../src/backoff.ml backoff.ml))
+
+(rule
+ (copy ../../src/skiplist.ml skiplist.ml))
+
+(test
+ (name skiplist_dscheck)
+ (libraries atomic dscheck alcotest)
+ (modules skiplist skiplist_dscheck))
+
+(test
+ (name qcheck_skiplist)
+ (libraries lockfree qcheck qcheck-alcotest)
+ (modules qcheck_skiplist))
+
+(test
+ (name stm_skiplist)
+ (modules stm_skiplist)
+ (libraries lockfree qcheck-stm.sequential qcheck-stm.domain)
+ (action
+  (run %{test} --verbose)))

test/atomicskiplist/qcheck_atomic_skiplist.ml → test/skiplist/qcheck_skiplist.ml

@@ -1,65 +1,62 @@
-module Atomicskiplist = Lockfree.Atomicskiplist
+module Skiplist = Lockfree.Skiplist
 
 let tests_sequential =
   QCheck.
     [
       (* TEST 1: add*)
       Test.make ~name:"add" (list int) (fun lpush ->
           assume (lpush <> []);
-          let sl = Atomicskiplist.create () in
+          let sl = Skiplist.create () in
           let rec add_all_elems l =
             match l with
-            | h :: t ->
-                if Atomicskiplist.add sl h then add_all_elems t else false
+            | h :: t -> if Skiplist.add sl h then add_all_elems t else false
             | [] -> true
           in
           add_all_elems lpush);
       (*TEST 2: add_remove*)
       Test.make ~name:"add_remove" (list int) (fun lpush ->
           let lpush = List.sort_uniq Int.compare lpush in
-          let sl = Atomicskiplist.create () in
-          List.iter (fun key -> ignore (Atomicskiplist.add sl key)) lpush;
+          let sl = Skiplist.create () in
+          List.iter (fun key -> ignore (Skiplist.add sl key)) lpush;
           let rec remove_all_elems l =
             match l with
             | h :: t ->
-                if Atomicskiplist.remove sl h then remove_all_elems t else false
+                if Skiplist.remove sl h then remove_all_elems t else false
             | [] -> true
           in
           remove_all_elems lpush);
       (*TEST 3: add_find*)
       Test.make ~name:"add_find" (list int) (fun lpush ->
           let lpush = List.sort_uniq Int.compare lpush in
           let lpush = Array.of_list lpush in
-          let sl = Atomicskiplist.create () in
+          let sl = Skiplist.create () in
           let len = Array.length lpush in
           let pos = Array.sub lpush 0 (len / 2) in
           let neg = Array.sub lpush (len / 2) (len / 2) in
-          Array.iter (fun key -> ignore @@ Atomicskiplist.add sl key) pos;
+          Array.iter (fun key -> ignore @@ Skiplist.add sl key) pos;
           let rec check_pos index =
             if index < len / 2 then
-              if Atomicskiplist.mem sl pos.(index) then check_pos (index + 1)
+              if Skiplist.mem sl pos.(index) then check_pos (index + 1)
               else false
             else true
           in
           let rec check_neg index =
             if index < len / 2 then
-              if not @@ Atomicskiplist.mem sl neg.(index) then
-                check_neg (index + 1)
+              if not @@ Skiplist.mem sl neg.(index) then check_neg (index + 1)
               else false
             else true
           in
           check_pos 0 && check_neg 0);
       (* TEST 4: add_remove_find *)
       Test.make ~name:"add_remove_find" (list int) (fun lpush ->
           let lpush = List.sort_uniq Int.compare lpush in
-          let sl = Atomicskiplist.create () in
-          List.iter (fun key -> ignore @@ Atomicskiplist.add sl key) lpush;
-          List.iter (fun key -> ignore @@ Atomicskiplist.remove sl key) lpush;
+          let sl = Skiplist.create () in
+          List.iter (fun key -> ignore @@ Skiplist.add sl key) lpush;
+          List.iter (fun key -> ignore @@ Skiplist.remove sl key) lpush;
           let rec not_find_all_elems l =
             match l with
             | h :: t ->
-                if not @@ Atomicskiplist.mem sl h then not_find_all_elems t
-                else false
+                if not @@ Skiplist.mem sl h then not_find_all_elems t else false
             | [] -> true
           in
 
@@ -72,14 +69,14 @@ let tests_two_domains =
       (* TEST 1: Two domains doing multiple adds *)
       Test.make ~name:"parallel_add" (pair small_nat small_nat)
         (fun (npush1, npush2) ->
-          let sl = Atomicskiplist.create () in
+          let sl = Skiplist.create () in
           let sema = Semaphore.Binary.make false in
           let lpush1 = List.init npush1 (fun i -> i) in
           let lpush2 = List.init npush2 (fun i -> i + npush1) in
           let work lpush =
             List.map
               (fun elt ->
-                let completed = Atomicskiplist.add sl elt in
+                let completed = Skiplist.add sl elt in
                 Domain.cpu_relax ();
                 completed)
               lpush
@@ -107,7 +104,7 @@ let tests_two_domains =
       (* TEST 2: Two domains doing multiple one push and one pop in parallel *)
       Test.make ~count:10000 ~name:"parallel_add_remove"
         (pair small_nat small_nat) (fun (npush1, npush2) ->
-          let sl = Atomicskiplist.create () in
+          let sl = Skiplist.create () in
           let sema = Semaphore.Binary.make false in
 
           let lpush1 = List.init npush1 (fun i -> i) in
@@ -116,9 +113,9 @@ let tests_two_domains =
           let work lpush =
             List.map
               (fun elt ->
-                ignore @@ Atomicskiplist.add sl elt;
+                ignore @@ Skiplist.add sl elt;
                 Domain.cpu_relax ();
-                Atomicskiplist.remove sl elt)
+                Skiplist.remove sl elt)
               lpush
           in
 
@@ -138,17 +135,17 @@ let tests_two_domains =
           let rec check_none_present l =
             match l with
             | h :: t ->
-                if Atomicskiplist.mem sl h then false else check_none_present t
+                if Skiplist.mem sl h then false else check_none_present t
             | [] -> true
           in
           check_none_present lpush1 && check_none_present lpush2);
       (* TEST 3: Parallel push and pop using the same elements in two domains
  *)
       Test.make ~name:"parallel_add_remove_same_list" (list int) (fun lpush ->
-          let sl = Atomicskiplist.create () in
+          let sl = Skiplist.create () in
           let sema = Semaphore.Binary.make false in
-          let add_all_elems l = List.map (Atomicskiplist.add sl) l in
-          let remove_all_elems l = List.map (Atomicskiplist.remove sl) l in
+          let add_all_elems l = List.map (Skiplist.add sl) l in
+          let remove_all_elems l = List.map (Skiplist.remove sl) l in
 
           let domain1 =
             Domain.spawn (fun () ->
@@ -170,15 +167,15 @@ let tests_two_domains =
           let rec check_none_present l =
             match l with
             | h :: t ->
-                if Atomicskiplist.mem sl h then false else check_none_present t
+                if Skiplist.mem sl h then false else check_none_present t
             | [] -> true
           in
           check_none_present lpush);
     ]
 
 let () =
   let to_alcotest = List.map QCheck_alcotest.to_alcotest in
-  Alcotest.run "Atomic Skip List"
+  Alcotest.run "Skip List"
     [
       ("test_sequential", to_alcotest tests_sequential);
       ("tests_two_domains", to_alcotest tests_two_domains);

test/atomicskiplist/atomic_skiplist_dscheck.ml → test/skiplist/skiplist_dscheck.ml

@@ -1,4 +1,4 @@
-open Atomicskiplist
+open Skiplist
 
 let _two_mem () =
   Atomic.trace (fun () ->
@@ -80,7 +80,7 @@ let _two_remove () =
       Atomic.final (fun () ->
           Atomic.check (fun () ->
               let found1 = mem sl 1 in
-              !added1 && !removed1 && not !removed2 && not found1)))
+              !added1 && !removed1 && (not !removed2) && not found1)))
 
 let () =
   let open Alcotest in

test/atomicskiplist/stm_atomicskiplist.ml → test/skiplist/stm_skiplist.ml

@@ -2,7 +2,7 @@
 
 open QCheck
 open STM
-module Skiplist = Lockfree.Atomicskiplist
+module Skiplist = Lockfree.Skiplist
 
 module WSDConf = struct
   type cmd = Mem of int | Add of int | Remove of int
@@ -13,11 +13,11 @@ module WSDConf = struct
     | Add i -> "Add " ^ string_of_int i
     | Remove i -> "Remove " ^ string_of_int i
 
-  module Sint = Set.Make (
-                    struct
-                      type t = int
-                      let compare = compare
-                    end)
+  module Sint = Set.Make (struct
+    type t = int
+
+    let compare = compare
+  end)
 
   type state = Sint.t
   type sut = Skiplist.t
@@ -67,4 +67,4 @@ let () =
     [
       WSDT_seq.agree_test ~count ~name:"STM Lockfree.Skiplist test sequential";
       WSDT_dom.agree_test_par ~count ~name:"STM Lockfree.Skiplist test parallel";
-       ]
+    ]