Merge pull request #4 from ocaml-multicore/prepare-release-0.0.3

Prepare release

Author: Sudha247

.ocamlformat

@@ -0,0 +1,4 @@
+version = 0.24.1
+profile = conventional
+
+ocaml-version = 5.0.0

CHANGES.md

@@ -1,3 +1,9 @@
+## v0.0.3 (2023-02-17)
+
+* Add memory_size function (@crackcomm, #1)
+* Change memory_size return type to int (@crackcomm, #2)
+* Fix build with dune 3.6 (@emillon, #3)
+
 ## v0.0.2 (2022-07-07)
 
 * Moved repository

hdr_histogram.opam

@@ -33,4 +33,7 @@ build: [
     "@doc" {with-doc}
   ]
 ]
+available: [
+  (arch = "x86_64" | arch = "arm64")
+]
 dev-repo: "git+https://github.com/ocaml-multicore/hdr_histogram_ocaml.git"

lib/dune

@@ -4,16 +4,18 @@
  (install_c_headers hdr_histogram)
  (foreign_archives hdr_histogram)
  ; ctypes backward compatibility shims warn sometimes; suppress them
- (flags (:standard -w -9-27))
+ (flags
+  (:standard -w -9-27))
  (ctypes
   (external_library_name hdr_histogram)
   (deps hdr_histogram.h dllhdr_histogram.so libhdr_histogram.a)
   (build_flags_resolver
-  (vendored
+   (vendored
     ; hack: multiple -I directives to work around cc commands being run from
     ; different relative directories.  Is there a cleaner way to do this?
     (c_flags :standard "-Ilib" "-I.")))
-  (headers (include "hdr_histogram.h"))
+  (headers
+   (include "hdr_histogram.h"))
   (type_description
    (instance Type)
    (functor Type_description))
@@ -27,17 +29,25 @@
 (data_only_dirs libhdr_histogram)
 
 (rule
-  (deps (source_tree libhdr_histogram))
-  (targets dllhdr_histogram.so libhdr_histogram.a hdr_histogram.h)
-  (action (no-infer
-  (progn (chdir libhdr_histogram
-            (progn (run mkdir -p _build)
-                   (chdir _build
-                      (progn (run cmake ..)
-                             (run make)))))
-         (copy libhdr_histogram/_build/src/libhdr_histogram_static.a
-               libhdr_histogram.a)
-         (copy libhdr_histogram/_build/src/libhdr_histogram.so
-               dllhdr_histogram.so)
-         (copy libhdr_histogram/include/hdr/hdr_histogram.h
-               hdr_histogram.h)))))
+ (deps
+  (source_tree libhdr_histogram))
+ (targets dllhdr_histogram.so libhdr_histogram.a hdr_histogram.h)
+ (action
+  (no-infer
+   (progn
+    (chdir
+     libhdr_histogram
+     (progn
+      (run mkdir -p _build)
+      (chdir
+       _build
+       (progn
+        (run cmake ..)
+        (run make)))))
+    (copy
+     libhdr_histogram/_build/src/libhdr_histogram_static.a
+     libhdr_histogram.a)
+    (copy
+     libhdr_histogram/_build/src/libhdr_histogram.so
+     dllhdr_histogram.so)
+    (copy libhdr_histogram/include/hdr/hdr_histogram.h hdr_histogram.h)))))

lib/function_description.ml

@@ -8,31 +8,32 @@ module Types = Types_generated
 module Functions (F : Ctypes.FOREIGN) = struct
   open F
 
-  let hdr_init = foreign "hdr_init"
-    (int64_t @-> int64_t @-> int @-> ptr (ptr Types.hdr_histogram) @->
-     returning int)
+  let hdr_init =
+    foreign "hdr_init"
+      (int64_t @-> int64_t @-> int
+      @-> ptr (ptr Types.hdr_histogram)
+      @-> returning int)
 
-  let hdr_record_value = foreign "hdr_record_value"
-    (ptr Types.hdr_histogram @-> int64_t @-> returning bool)
+  let hdr_record_value =
+    foreign "hdr_record_value"
+      (ptr Types.hdr_histogram @-> int64_t @-> returning bool)
 
-  let hdr_close = foreign "hdr_close"
-    (ptr Types.hdr_histogram @-> returning void)
+  let hdr_close =
+    foreign "hdr_close" (ptr Types.hdr_histogram @-> returning void)
 
-  let hdr_value_at_percentile = foreign "hdr_value_at_percentile"
-    (ptr Types.hdr_histogram @-> double @-> returning int64_t)
+  let hdr_value_at_percentile =
+    foreign "hdr_value_at_percentile"
+      (ptr Types.hdr_histogram @-> double @-> returning int64_t)
 
-  let hdr_min = foreign "hdr_min"
-    (ptr Types.hdr_histogram @-> returning int64_t)
+  let hdr_min = foreign "hdr_min" (ptr Types.hdr_histogram @-> returning int64_t)
+  let hdr_max = foreign "hdr_max" (ptr Types.hdr_histogram @-> returning int64_t)
 
-  let hdr_max = foreign "hdr_max"
-    (ptr Types.hdr_histogram @-> returning int64_t)
+  let hdr_mean =
+    foreign "hdr_mean" (ptr Types.hdr_histogram @-> returning double)
 
-  let hdr_mean = foreign "hdr_mean"
-    (ptr Types.hdr_histogram @-> returning double)
+  let hdr_stddev =
+    foreign "hdr_stddev" (ptr Types.hdr_histogram @-> returning double)
 
-  let hdr_stddev = foreign "hdr_stddev"
-    (ptr Types.hdr_histogram @-> returning double)
-
-  let hdr_get_memory_size = foreign "hdr_get_memory_size"
-    (ptr Types.hdr_histogram @-> returning size_t)
+  let hdr_get_memory_size =
+    foreign "hdr_get_memory_size" (ptr Types.hdr_histogram @-> returning size_t)
 end

lib/hdr_histogram.ml

@@ -1,24 +1,24 @@
 open Ctypes
-
 module Types = Types_generated
 
 type t = Types.hdr_histogram structure ptr
 
-let init ~lowest_discernible_value ~highest_trackable_value
-             ~significant_figures =
-  let h = allocate (ptr Types.hdr_histogram)
-                   (from_voidp (Types.hdr_histogram) null)
+let init ~lowest_discernible_value ~highest_trackable_value ~significant_figures
+    =
+  let h =
+    allocate (ptr Types.hdr_histogram) (from_voidp Types.hdr_histogram null)
   in
-  let res = C.Function.hdr_init (Int64.of_int lowest_discernible_value)
-                                (Int64.of_int highest_trackable_value)
-                                significant_figures h
+  let res =
+    C.Function.hdr_init
+      (Int64.of_int lowest_discernible_value)
+      (Int64.of_int highest_trackable_value)
+      significant_figures h
   in
   assert (res = 0);
-  let h' : t = !@ h in
+  let h' : t = !@h in
   h'
 
 let record_value h v = C.Function.hdr_record_value h (Int64.of_int v)
-
 let close h = C.Function.hdr_close h
 
 let value_at_percentile h p =

lib/hdr_histogram.mli

@@ -1,10 +1,11 @@
 type t
 (** The type of histogram values *)
 
-val init : lowest_discernible_value:int
-        -> highest_trackable_value:int
-        -> significant_figures:int
-        -> t
+val init :
+  lowest_discernible_value:int ->
+  highest_trackable_value:int ->
+  significant_figures:int ->
+  t
 (** Initialize a new histogram *)
 
 val record_value : t -> int -> bool

lib/type_description.ml

@@ -1,8 +1,9 @@
 open Ctypes
 
 module Types (F : Ctypes.TYPE) = struct
-(*   open F *)
+  (*   open F *)
 
   type hdr_histogram
+
   let hdr_histogram : hdr_histogram structure typ = structure "hdr_histogram"
 end

test/test1.ml

@@ -3,21 +3,22 @@ open Hdr_histogram
 let print_percentiles h =
   let percentiles = [| 50.0; 75.0; 90.0; 99.0; 99.9; 99.99; 99.999; 100.0 |] in
   Fun.flip Array.iter percentiles (fun p ->
-    Printf.printf "%f \t %d\n" p (value_at_percentile h p))
+      Printf.printf "%f \t %d\n" p (value_at_percentile h p))
 
 let main () =
-  let h = init ~lowest_discernible_value:1 ~highest_trackable_value:100_000_000
-               ~significant_figures:3
+  let h =
+    init ~lowest_discernible_value:1 ~highest_trackable_value:100_000_000
+      ~significant_figures:3
   in
-  for i=1000 to 100_000 do
-    for _j =1 to 1000 do
+  for i = 1000 to 100_000 do
+    for _j = 1 to 1000 do
       ignore @@ record_value h i
-    done;
+    done
   done;
-  for i=100_001 to 110_000 do
+  for i = 100_001 to 110_000 do
     for _j = 1 to 100 do
       ignore @@ record_value h i
-    done;
+    done
   done;
   print_percentiles h;
   close h