File: test_threads.ml

package info (click to toggle)
ocaml-ctypes 0.24.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,180 kB
  • sloc: ml: 13,406; ansic: 3,316; makefile: 72
file content (166 lines) | stat: -rw-r--r-- 4,511 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
(*
 * Copyright (c) 2013 Jeremy Yallop.
 *
 * This file is distributed under the terms of the MIT License.
 * See the file LICENSE for details.
 *)

[@@@warning "-33-35"]
open Ctypes
open OUnit2
open Foreign

let () =
  (* temporary workaround due to flexlink limitations *)
  if Sys.os_type = "Win32" then
    ignore (Dl.(dlopen ~filename:"../clib/clib.so" ~flags:[RTLD_NOW]))


let callback_with_pointers = Foreign.foreign "passing_pointers_to_callback"
  ~release_runtime_lock:true
  (Foreign.funptr ~runtime_lock:true
     (ptr int @-> ptr int @-> returning int) @-> returning int)


module Common_tests(S : Cstubs.FOREIGN with type 'a result = 'a
                                        and type 'a return = 'a) =
struct
  module M = Functions.Stubs(S)

  (*
    Ensure that passing ~release_runtime_lock releases the runtime lock.
  *)
  let test_release_runtime_lock _ =
    begin
      M.initialize_waiters ();
      let t1 = Thread.create M.post1_wait2 () in
      let t2 = Thread.create M.post2_wait1 () in
      Thread.join t1;
      Thread.join t2;
    end
end

module Foreign_tests = Common_tests(struct 
    type 'a fn = 'a Ctypes.fn
    type 'a return = 'a
    let (@->) = Ctypes.(@->)
    let returning = Ctypes.returning
                      
    type 'a result = 'a
    let foreign name fn = Foreign.foreign name fn
    ~release_runtime_lock:true
    let foreign_value name fn = Foreign.foreign_value name fn
  end)

module Stub_tests = Common_tests(Generated_bindings)


(*
  Ensure that passing ~runtime_lock to funptr causes a callback to acquire
  the runtime lock.
*)
let test_acquire_runtime_lock _ =
  begin
    let f x y = let _ = Gc.full_major () in !@x + !@y in
    let t1 = Thread.create Gc.full_major () in
    assert (callback_with_pointers f = 7);
    Thread.join t1
  end


(* 
   Acquire the runtime lock in a callback while other threads execute OCaml
   code.
*)
let test_acquire_runtime_lock_parallel _ =
  begin
    let r = ref None in
    let g size n =
      for i = 0 to n do
        r := Some (CArray.make float size ~initial:0.0);
        Thread.yield ();
      done
    in
    let f x y = let _ = Gc.compact () in !@x + !@y in
    let threads = ref [] in
    for i  = 0 to 10 do
      threads := Thread.create (g 100) 10000 :: !threads;
    done;
    for i = 0 to 10 do
      assert (callback_with_pointers f = 7);
      Thread.yield ();
    done;
    List.iter Thread.join !threads;
  end

(*
   Ensure that threads created by external code are registered with
   caml_c_thread_register
*)
let create_threads_that_call_back =
  Foreign.foreign "foreign_thread_registration_test"
    (Foreign.funptr ~thread_registration:true ~runtime_lock:true
       (uint64_t @-> returning void) @-> uint @-> uint @->
     returning int)
    ~release_runtime_lock:true

let test_register_thread _ =
  begin
    (* number of threads to create *)
    let n_threads = 25 in
    (* how often each thread calls back *)
    let n_callback = 3 in
    let protect =
      let m = Mutex.create () in
      fun f ->
        Mutex.lock m;
        let r = try f () with x -> Mutex.unlock m; raise x in
        Mutex.unlock m;
        r
    in
    let rs = Random.State.make_self_init () in
    let htl_res = Hashtbl.create (succ n_threads) in
    let cb d =
      let cnt,delay = protect @@ fun () ->
        let c = try Hashtbl.find htl_res d with Not_found -> 0 in
        Hashtbl.replace htl_res d (succ c);
        let d = Random.State.float rs 0.1 in
        c,d
      in
      Thread.delay (if cnt <> 0 then delay else delay +. 0.2)
    in
    let un_threads = Unsigned.UInt.of_int n_threads in
    let un_callback = Unsigned.UInt.of_int n_callback in
    let result =
      if create_threads_that_call_back cb un_threads un_callback <> 0 then
        false
      else if Hashtbl.length htl_res <> succ n_threads then
        false
      else
        Hashtbl.fold ( fun _k v ac ->
            if v = n_callback then ac else false
          ) htl_res true
    in
    OUnit2.assert_equal true result
  end

let suite = "Thread tests" >:::
  ["test_release_runtime_lock (foreign)"
   >:: Foreign_tests.test_release_runtime_lock;

   "test_release_runtime_lock (stubs)"
   >:: Stub_tests.test_release_runtime_lock;

   "test_acquire_runtime_lock (foreign)"
   >:: test_acquire_runtime_lock;

   "test_acquire_runtime_lock_parallel (foreign)"
   >:: test_acquire_runtime_lock_parallel;

   "test_register_thread (foreign)"
   >:: test_register_thread;
  ]


let _ =
  run_test_tt_main suite