Source file `Domain_local_await.ml`

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
type t = { release : unit -> unit; await : unit -> unit }

module Default = struct
  type t = { mutex : Mutex.t; condition : Condition.t }

  let init () =
    let t =
      let mutex = Mutex.create () and condition = Condition.create () in
      { mutex; condition }
    in
    fun () ->
      let released = ref false in
      let release () =
        if not !released then begin
          Mutex.lock t.mutex;
          if not !released then begin
            released := true;
            Mutex.unlock t.mutex;
            Condition.broadcast t.condition
          end
          else Mutex.unlock t.mutex
        end
      and await () =
        if not !released then begin
          Mutex.lock t.mutex;
          match
            while not !released do
              (* NOTE: [Condition.wait] may raise an asynchronous exception. *)
              Condition.wait t.condition t.mutex
            done
          with
          | () -> Mutex.unlock t.mutex
          | exception exn ->
              Mutex.unlock t.mutex;
              raise exn
        end
      in
      { release; await }
end

include Thread_intf

type config =
  | Per_domain : { mutable prepare_for_await : unit -> t } -> config
  | Per_thread : {
      mutable prepare_for_await : unit -> t;
      self : unit -> 'handle;
      id : 'handle -> int;
      id_to_prepare : (unit -> t) Thread_table.t;
    }
      -> config

let default_init = ref (fun () -> failwith "unimplemented")
let default () = !default_init ()

let key =
  Domain.DLS.new_key @@ fun () -> Per_domain { prepare_for_await = default }

(* Below we use [@poll error] and [@inline never] to ensure that there are no
   safe-points where thread switches might occur during critical section. *)

let[@poll error] [@inline never] update_prepare_atomically state
    prepare_for_await =
  match state with
  | Per_domain r ->
      let current = r.prepare_for_await in
      if current == default then begin
        r.prepare_for_await <- prepare_for_await;
        prepare_for_await
      end
      else current
  | Per_thread r ->
      let current = r.prepare_for_await in
      if current == default then begin
        r.prepare_for_await <- prepare_for_await;
        prepare_for_await
      end
      else current

let () =
  default_init :=
    fun () ->
      let prepare_for_await = Default.init () in
      let prepare_for_await =
        update_prepare_atomically (Domain.DLS.get key) prepare_for_await
      in
      prepare_for_await ()

let per_thread (module Thread : Thread) =
  match Domain.DLS.get key with
  | Per_thread _ ->
      failwith "Domain_local_await: per_thread called twice on a single domain"
  | Per_domain { prepare_for_await } ->
      let open Thread in
      let id_to_prepare = Thread_table.create () in
      Domain.DLS.set key
        (Per_thread { prepare_for_await; self; id; id_to_prepare })

let using ~prepare_for_await ~while_running =
  match Domain.DLS.get key with
  | Per_domain r ->
      let previous = r.prepare_for_await in
      r.prepare_for_await <- prepare_for_await;
      Fun.protect while_running ~finally:(fun () ->
          r.prepare_for_await <- previous)
  | Per_thread r ->
      let id = r.id (r.self ()) in
      Thread_table.add r.id_to_prepare id prepare_for_await;
      Fun.protect while_running ~finally:(fun () ->
          Thread_table.remove r.id_to_prepare id)

let prepare_for_await () =
  match Domain.DLS.get key with
  | Per_domain r -> r.prepare_for_await ()
  | Per_thread r -> begin
      match Thread_table.find r.id_to_prepare (r.id (r.self ())) with
      | prepare -> prepare ()
      | exception Not_found -> r.prepare_for_await ()
    end