package picos_mux

  1. Overview
  2. Docs

Source file picos_mux_fifo.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
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
open Picos

let[@inline never] quota_non_positive _ = invalid_arg "quota must be positive"

type ready =
  | Spawn of Fiber.t * (Fiber.t -> unit)
  | Continue of Fiber.t * (unit, unit) Effect.Deep.continuation
  | Resume of
      Fiber.t
      * ((exn * Printexc.raw_backtrace) option, unit) Effect.Deep.continuation
  | Return of Fiber.t * (unit, unit) Effect.Deep.continuation

module Mpscq = Picos_aux_mpscq

type t = {
  ready : ready Mpscq.t;
  needs_wakeup : bool Atomic.t;
  mutex : Mutex.t;
  condition : Condition.t;
  mutable resume :
    Trigger.t ->
    Fiber.t ->
    ((exn * Printexc.raw_backtrace) option, unit) Effect.Deep.continuation ->
    unit;
  mutable current : ((Fiber.t, unit) Effect.Deep.continuation -> unit) option;
  mutable yield : ((unit, unit) Effect.Deep.continuation -> unit) option;
  mutable return : ((unit, unit) Effect.Deep.continuation -> unit) option;
  mutable discontinue : ((unit, unit) Effect.Deep.continuation -> unit) option;
  mutable handler : (unit, unit) Effect.Deep.handler;
  quota : int;
  mutable fiber : Fiber.Maybe.t;
  mutable remaining_quota : int;
  mutable num_alive_fibers : int;
}

let rec next t =
  match Mpscq.pop_exn t.ready with
  | ready -> begin
      t.remaining_quota <- t.quota;
      t.fiber <-
        (match ready with
        | Spawn (fiber, _)
        | Continue (fiber, _)
        | Resume (fiber, _)
        | Return (fiber, _) ->
            Fiber.Maybe.of_fiber fiber);
      match ready with
      | Spawn (fiber, main) -> Effect.Deep.match_with main fiber t.handler
      | Return (_, k) -> Effect.Deep.continue k ()
      | Continue (fiber, k) -> Fiber.continue fiber k ()
      | Resume (fiber, k) -> Fiber.resume fiber k
    end
  | exception Mpscq.Empty ->
      t.fiber <- Fiber.Maybe.nothing;
      if t.num_alive_fibers <> 0 then begin
        if Atomic.get t.needs_wakeup then begin
          Mutex.lock t.mutex;
          match
            if Atomic.get t.needs_wakeup then Condition.wait t.condition t.mutex
          with
          | () -> Mutex.unlock t.mutex
          | exception exn ->
              Mutex.unlock t.mutex;
              raise exn
        end
        else Atomic.set t.needs_wakeup true;
        next t
      end

let run_fiber ?quota ?fatal_exn_handler fiber main =
  Select.check_configured ();
  let t =
    let quota =
      match quota with
      | None -> Int.max_int
      | Some quota -> if quota <= 0 then quota_non_positive quota else quota
    in
    {
      ready = Mpscq.create ~padded:true ();
      needs_wakeup = Atomic.make false |> Multicore_magic.copy_as_padded;
      mutex = Mutex.create ();
      condition = Condition.create ();
      resume = Obj.magic ();
      current = Obj.magic ();
      yield = Obj.magic ();
      return = Obj.magic ();
      discontinue = Obj.magic ();
      handler = Obj.magic ();
      quota;
      fiber = Fiber.Maybe.of_fiber fiber;
      remaining_quota = quota;
      num_alive_fibers = 1;
    }
  in
  t.handler <-
    {
      exnc = (match fatal_exn_handler with None -> raise | Some exnc -> exnc);
      effc =
        (fun (type a) (e : a Effect.t) :
             ((a, _) Effect.Deep.continuation -> _) option ->
          match e with
          | Fiber.Current -> t.current
          | Fiber.Spawn r ->
              let fiber = Fiber.Maybe.to_fiber t.fiber in
              if Fiber.is_canceled fiber then t.discontinue
              else begin
                t.num_alive_fibers <- t.num_alive_fibers + 1;
                Mpscq.push t.ready (Spawn (r.fiber, r.main));
                t.return
              end
          | Fiber.Yield -> t.yield
          | Computation.Cancel_after r -> begin
              let fiber = Fiber.Maybe.to_fiber t.fiber in
              if Fiber.is_canceled fiber then t.discontinue
              else
                match
                  Select.cancel_after r.computation ~seconds:r.seconds r.exn
                    r.bt
                with
                | () -> t.return
                | exception exn ->
                    let bt = Printexc.get_raw_backtrace () in
                    Some
                      (fun k -> Effect.Deep.discontinue_with_backtrace k exn bt)
            end
          | Trigger.Await trigger ->
              Some
                (fun k ->
                  let fiber = Fiber.Maybe.to_fiber t.fiber in
                  if Fiber.try_suspend fiber trigger fiber k t.resume then
                    next t
                  else
                    let remaining_quota = t.remaining_quota - 1 in
                    if 0 < remaining_quota then begin
                      t.remaining_quota <- remaining_quota;
                      Fiber.resume fiber k
                    end
                    else begin
                      Mpscq.push t.ready (Resume (fiber, k));
                      next t
                    end)
          | _ -> None);
      retc =
        (fun () ->
          t.num_alive_fibers <- t.num_alive_fibers - 1;
          next t);
    };
  t.resume <-
    (fun trigger fiber k ->
      let resume = Resume (fiber, k) in
      if Fiber.unsuspend fiber trigger then Mpscq.push t.ready resume
      else Mpscq.push_head t.ready resume;
      if
        Atomic.get t.needs_wakeup
        && Atomic.compare_and_set t.needs_wakeup true false
      then begin
        begin
          match Mutex.lock t.mutex with
          | () -> Mutex.unlock t.mutex
          | exception Sys_error _ -> ()
        end;
        Condition.broadcast t.condition
      end);
  t.current <-
    Some
      (fun k ->
        let fiber = Fiber.Maybe.to_fiber t.fiber in
        Effect.Deep.continue k fiber);
  t.yield <-
    Some
      (fun k ->
        let fiber = Fiber.Maybe.to_fiber t.fiber in
        Mpscq.push t.ready (Continue (fiber, k));
        next t);
  t.return <-
    Some
      (fun k ->
        let remaining_quota = t.remaining_quota - 1 in
        if 0 < remaining_quota then begin
          t.remaining_quota <- remaining_quota;
          Effect.Deep.continue k ()
        end
        else begin
          Mpscq.push t.ready (Return (Fiber.Maybe.to_fiber t.fiber, k));
          next t
        end);
  t.discontinue <-
    Some
      (fun k ->
        let fiber = Fiber.Maybe.to_fiber t.fiber in
        Fiber.continue fiber k ());
  Effect.Deep.match_with main fiber t.handler

let[@inline never] run ?quota ?fatal_exn_handler fiber main computation =
  run_fiber ?quota ?fatal_exn_handler fiber main;
  Computation.peek_exn computation

let run ?quota ?fatal_exn_handler ?forbid main =
  let forbid = match forbid with None -> false | Some forbid -> forbid in
  let computation = Computation.create ~mode:`LIFO () in
  let fiber = Fiber.create ~forbid computation in
  let main _ = Computation.capture computation main () in
  run ?quota ?fatal_exn_handler fiber main computation
OCaml

Innovation. Community. Security.