simon/move to picos

.github/workflows/gh-pages.yml

@@ -19,11 +19,12 @@ jobs:
           dune-cache: true
           allow-prerelease-opam: true
 
-      - name: Deps
-        run: opam install odig moonpool moonpool-lwt
+      # temporary until it's in a release
+      - run: opam pin https://github.com/ocaml-multicore/picos.git -y -n
 
-      - name: Build
-        run: opam exec -- odig odoc --cache-dir=_doc/ moonpool moonpool-lwt
+      - run: opam install odig moonpool moonpool-lwt moonpool-io
+
+      - run: opam exec -- odig odoc --cache-dir=_doc/ moonpool moonpool-lwt
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3

.github/workflows/main.yml

@@ -16,7 +16,6 @@ jobs:
         os:
             - ubuntu-latest
         ocaml-compiler:
-            - '4.08'
             - '4.14'
             - '5.2'
 
@@ -30,14 +29,17 @@ jobs:
           dune-cache: true
           allow-prerelease-opam: true
 
-      - run: opam install -t moonpool moonpool-lwt --deps-only
+      # temporary until it's in a release
+      - run: opam pin https://github.com/ocaml-multicore/picos.git -y -n
+
+      - run: opam install -t moonpool moonpool-lwt moonpool-io --deps-only
         if: matrix.ocaml-compiler == '5.2'
       - run: opam install -t moonpool --deps-only
         if: matrix.ocaml-compiler != '5.2'
       - run: opam exec -- dune build @install
 
       # install some depopts
-      - run: opam install thread-local-storage trace domain-local-await
+      - run: opam install thread-local-storage trace hmap
         if: matrix.ocaml-compiler == '5.2'
 
       - run: opam exec -- dune build --profile=release --force @install @runtest
@@ -63,7 +65,10 @@ jobs:
           dune-cache: true
           allow-prerelease-opam: true
 
-      - run: opam install -t moonpool moonpool-lwt --deps-only
+      # temporary until it's in a release
+      - run: opam pin https://github.com/ocaml-multicore/picos.git -y -n
+
+      - run: opam install -t moonpool moonpool-lwt moonpool-io --deps-only
       - run: opam exec -- dune build @install
       # install some depopts
       - run: opam install thread-local-storage trace domain-local-await

.gitignore

@@ -1,2 +1,3 @@
 _build
 _opam
+*.tmp

Makefile

@@ -9,6 +9,9 @@ clean:
 test:
 	@dune runtest $(DUNE_OPTS)
 
+test-autopromote:
+	@dune runtest $(DUNE_OPTS) --auto-promote
+
 doc:
 	@dune build $(DUNE_OPTS) @doc
 

dune-project

@@ -16,21 +16,24 @@
  (name moonpool)
  (synopsis "Pools of threads supported by a pool of domains")
  (depends
-  (ocaml (>= 4.08))
+  (ocaml (>= 4.14))
   dune
   (either (>= 1.0))
   (trace :with-test)
   (trace-tef :with-test)
   (qcheck-core (and :with-test (>= 0.19)))
+  (thread-local-storage (and (>= 0.2) (< 0.3)))
   (odoc :with-doc)
+  (hmap :with-test)
+  (picos (and (>= 0.5) (< 0.6)))
+  (picos_std (and (>= 0.5) (< 0.6)))
   (mdx
    (and
     (>= 1.9.0)
     :with-test)))
  (depopts
-   (trace (>= 0.6))
-   thread-local-storage)
- (conflicts (thread-local-storage (< 0.2)))
+   hmap
+   (trace (>= 0.6)))
  (tags
   (thread pool domain futures fork-join)))
 
@@ -47,4 +50,17 @@
     (trace-tef :with-test)
     (odoc :with-doc)))
 
+(package
+  (name moonpool-io)
+  (synopsis "Async IO for moonpool, relying on picos")
+  (allow_empty)  ; on < 5.0
+  (depends
+    (moonpool (= :version))
+    (picos_io (and (>= 0.5) (< 0.6)))
+    (ocaml (>= 5.0))
+    (trace :with-test)
+    (trace-tef :with-test)
+    (odoc :with-doc)))
+
+
 ; See the complete stanza docs at https://dune.readthedocs.io/en/stable/dune-files.html#dune-project

moonpool-io.opam

@@ -0,0 +1,33 @@
+# This file is generated by dune, edit dune-project instead
+opam-version: "2.0"
+version: "0.6"
+synopsis: "Async IO for moonpool, relying on picos"
+maintainer: ["Simon Cruanes"]
+authors: ["Simon Cruanes"]
+license: "MIT"
+homepage: "https://github.com/c-cube/moonpool"
+bug-reports: "https://github.com/c-cube/moonpool/issues"
+depends: [
+  "dune" {>= "3.0"}
+  "moonpool" {= version}
+  "picos_io" {>= "0.5" & < "0.6"}
+  "ocaml" {>= "5.0"}
+  "trace" {with-test}
+  "trace-tef" {with-test}
+  "odoc" {with-doc}
+]
+build: [
+  ["dune" "subst"] {dev}
+  [
+    "dune"
+    "build"
+    "-p"
+    name
+    "-j"
+    jobs
+    "@install"
+    "@runtest" {with-test}
+    "@doc" {with-doc}
+  ]
+]
+dev-repo: "git+https://github.com/c-cube/moonpool.git"

moonpool.opam

@@ -9,21 +9,22 @@ tags: ["thread" "pool" "domain" "futures" "fork-join"]
 homepage: "https://github.com/c-cube/moonpool"
 bug-reports: "https://github.com/c-cube/moonpool/issues"
 depends: [
-  "ocaml" {>= "4.08"}
+  "ocaml" {>= "4.14"}
   "dune" {>= "3.0"}
   "either" {>= "1.0"}
   "trace" {with-test}
   "trace-tef" {with-test}
   "qcheck-core" {with-test & >= "0.19"}
+  "thread-local-storage" {>= "0.2" & < "0.3"}
   "odoc" {with-doc}
+  "hmap" {with-test}
+  "picos" {>= "0.5" & < "0.6"}
+  "picos_std" {>= "0.5" & < "0.6"}
   "mdx" {>= "1.9.0" & with-test}
 ]
 depopts: [
+  "hmap"
   "trace" {>= "0.6"}
-  "thread-local-storage"
-]
-conflicts: [
-  "thread-local-storage" {< "0.2"}
 ]
 build: [
   ["dune" "subst"] {dev}

src/core/dune

@@ -1,9 +1,18 @@
 (library
  (public_name moonpool)
  (name moonpool)
- (libraries moonpool.private moonpool.dpool)
+ (libraries
+  moonpool.private
+  (re_export thread-local-storage)
+  (select
+   hmap_ls_.ml
+   from
+   (hmap -> hmap_ls_.real.ml)
+   (-> hmap_ls_.dummy.ml))
+  moonpool.dpool
+  (re_export picos))
  (flags :standard -open Moonpool_private)
- (private_modules types_ util_pool_)
+ (private_modules util_pool_)
  (preprocess
   (action
    (run %{project_root}/src/cpp/cpp.exe %{input-file}))))

src/core/exn_bt.ml

@@ -3,6 +3,9 @@ type t = exn * Printexc.raw_backtrace
 let[@inline] make exn bt : t = exn, bt
 let[@inline] exn (e, _) = e
 let[@inline] bt (_, bt) = bt
+let show self = Printexc.to_string (exn self)
+let pp out self = Format.pp_print_string out (show self)
+let[@inline] raise (e, bt) = Printexc.raise_with_backtrace e bt
 
 let[@inline] get exn =
   let bt = Printexc.get_raw_backtrace () in
@@ -12,8 +15,8 @@ let[@inline] get_callstack n exn =
   let bt = Printexc.get_callstack n in
   make exn bt
 
-let show self = Printexc.to_string (fst self)
-let pp out self = Format.pp_print_string out (show self)
-let[@inline] raise self = Printexc.raise_with_backtrace (exn self) (bt self)
-
 type nonrec 'a result = ('a, t) result
+
+let[@inline] unwrap = function
+  | Ok x -> x
+  | Error ebt -> raise ebt

src/core/exn_bt.mli

@@ -1,27 +1,29 @@
 (** Exception with backtrace.
 
+    Type changed @since NEXT_RELEASE
+
     @since 0.6 *)
 
-type t = exn * Printexc.raw_backtrace
 (** An exception bundled with a backtrace *)
 
+type t = exn * Printexc.raw_backtrace
+
 val exn : t -> exn
 val bt : t -> Printexc.raw_backtrace
-
-val make : exn -> Printexc.raw_backtrace -> t
-(** Trivial builder *)
-
+val raise : t -> 'a
 val get : exn -> t
-(** [get exn] is [make exn (get_raw_backtrace ())] *)
-
 val get_callstack : int -> exn -> t
 
-val raise : t -> 'a
-(** Raise the exception with its save backtrace *)
+val make : exn -> Printexc.raw_backtrace -> t
+(** Trivial builder *)
 
 val show : t -> string
 (** Simple printing *)
 
 val pp : Format.formatter -> t -> unit
 
 type nonrec 'a result = ('a, t) result
+
+val unwrap : 'a result -> 'a
+(** [unwrap (Ok x)] is [x], [unwrap (Error ebt)] re-raises [ebt].
+    @since NEXT_RELEASE *)