wenzelm@28156
|
1 |
(* Title: Pure/Concurrent/future.ML
|
wenzelm@28156
|
2 |
Author: Makarius
|
wenzelm@28156
|
3 |
|
wenzelm@32250
|
4 |
Future values, see also
|
wenzelm@32250
|
5 |
http://www4.in.tum.de/~wenzelm/papers/parallel-isabelle.pdf
|
wenzelm@38175
|
6 |
http://www4.in.tum.de/~wenzelm/papers/parallel-ml.pdf
|
wenzelm@28201
|
7 |
|
wenzelm@28201
|
8 |
Notes:
|
wenzelm@28201
|
9 |
|
wenzelm@28201
|
10 |
* Futures are similar to delayed evaluation, i.e. delay/force is
|
wenzelm@28201
|
11 |
generalized to fork/join (and variants). The idea is to model
|
wenzelm@28201
|
12 |
parallel value-oriented computations, but *not* communicating
|
wenzelm@28201
|
13 |
processes.
|
wenzelm@28201
|
14 |
|
wenzelm@28201
|
15 |
* Futures are grouped; failure of one group member causes the whole
|
wenzelm@32220
|
16 |
group to be interrupted eventually. Groups are block-structured.
|
wenzelm@28201
|
17 |
|
wenzelm@28201
|
18 |
* Forked futures are evaluated spontaneously by a farm of worker
|
wenzelm@28201
|
19 |
threads in the background; join resynchronizes the computation and
|
wenzelm@28201
|
20 |
delivers results (values or exceptions).
|
wenzelm@28201
|
21 |
|
wenzelm@28201
|
22 |
* The pool of worker threads is limited, usually in correlation with
|
wenzelm@28201
|
23 |
the number of physical cores on the machine. Note that allocation
|
wenzelm@28201
|
24 |
of runtime resources is distorted either if workers yield CPU time
|
wenzelm@28201
|
25 |
(e.g. via system sleep or wait operations), or if non-worker
|
wenzelm@28201
|
26 |
threads contend for significant runtime resources independently.
|
wenzelm@34277
|
27 |
|
wenzelm@34277
|
28 |
* Promised futures are fulfilled by external means. There is no
|
wenzelm@34277
|
29 |
associated evaluation task, but other futures can depend on them
|
wenzelm@34277
|
30 |
as usual.
|
wenzelm@28156
|
31 |
*)
|
wenzelm@28156
|
32 |
|
wenzelm@28156
|
33 |
signature FUTURE =
|
wenzelm@28156
|
34 |
sig
|
wenzelm@29120
|
35 |
type task = Task_Queue.task
|
wenzelm@29120
|
36 |
type group = Task_Queue.group
|
wenzelm@32074
|
37 |
val is_worker: unit -> bool
|
wenzelm@32823
|
38 |
val worker_task: unit -> Task_Queue.task option
|
wenzelm@32122
|
39 |
val worker_group: unit -> Task_Queue.group option
|
wenzelm@38133
|
40 |
val worker_subgroup: unit -> Task_Queue.group
|
wenzelm@28972
|
41 |
type 'a future
|
wenzelm@28972
|
42 |
val task_of: 'a future -> task
|
wenzelm@28972
|
43 |
val group_of: 'a future -> group
|
wenzelm@28972
|
44 |
val peek: 'a future -> 'a Exn.result option
|
wenzelm@28972
|
45 |
val is_finished: 'a future -> bool
|
wenzelm@28979
|
46 |
val fork_group: group -> (unit -> 'a) -> 'a future
|
wenzelm@32729
|
47 |
val fork_deps_pri: 'b future list -> int -> (unit -> 'a) -> 'a future
|
wenzelm@28979
|
48 |
val fork_deps: 'b future list -> (unit -> 'a) -> 'a future
|
wenzelm@29120
|
49 |
val fork_pri: int -> (unit -> 'a) -> 'a future
|
wenzelm@32729
|
50 |
val fork: (unit -> 'a) -> 'a future
|
wenzelm@28972
|
51 |
val join_results: 'a future list -> 'a Exn.result list
|
wenzelm@28972
|
52 |
val join_result: 'a future -> 'a Exn.result
|
wenzelm@28972
|
53 |
val join: 'a future -> 'a
|
wenzelm@34277
|
54 |
val value: 'a -> 'a future
|
wenzelm@28972
|
55 |
val map: ('a -> 'b) -> 'a future -> 'b future
|
wenzelm@34277
|
56 |
val promise_group: group -> 'a future
|
wenzelm@34277
|
57 |
val promise: unit -> 'a future
|
wenzelm@34277
|
58 |
val fulfill_result: 'a future -> 'a Exn.result -> unit
|
wenzelm@34277
|
59 |
val fulfill: 'a future -> 'a -> unit
|
wenzelm@30621
|
60 |
val interruptible_task: ('a -> 'b) -> 'a -> 'b
|
wenzelm@29431
|
61 |
val cancel_group: group -> unit
|
wenzelm@28972
|
62 |
val cancel: 'a future -> unit
|
wenzelm@28203
|
63 |
val shutdown: unit -> unit
|
wenzelm@38492
|
64 |
val status: (unit -> 'a) -> 'a
|
wenzelm@28156
|
65 |
end;
|
wenzelm@28156
|
66 |
|
wenzelm@28156
|
67 |
structure Future: FUTURE =
|
wenzelm@28156
|
68 |
struct
|
wenzelm@28156
|
69 |
|
wenzelm@28177
|
70 |
(** future values **)
|
wenzelm@28177
|
71 |
|
wenzelm@28167
|
72 |
(* identifiers *)
|
wenzelm@28167
|
73 |
|
wenzelm@29120
|
74 |
type task = Task_Queue.task;
|
wenzelm@29120
|
75 |
type group = Task_Queue.group;
|
wenzelm@28167
|
76 |
|
wenzelm@32074
|
77 |
local
|
wenzelm@33429
|
78 |
val tag = Universal.tag () : (task * group) option Universal.tag;
|
wenzelm@32074
|
79 |
in
|
wenzelm@28177
|
80 |
fun thread_data () = the_default NONE (Thread.getLocal tag);
|
wenzelm@32074
|
81 |
fun setmp_thread_data data f x =
|
wenzelm@32074
|
82 |
Library.setmp_thread_data tag (thread_data ()) (SOME data) f x;
|
wenzelm@28167
|
83 |
end;
|
wenzelm@28167
|
84 |
|
wenzelm@32074
|
85 |
val is_worker = is_some o thread_data;
|
wenzelm@33429
|
86 |
val worker_task = Option.map #1 o thread_data;
|
wenzelm@33429
|
87 |
val worker_group = Option.map #2 o thread_data;
|
wenzelm@38133
|
88 |
fun worker_subgroup () = Task_Queue.new_group (worker_group ());
|
wenzelm@34277
|
89 |
|
wenzelm@28167
|
90 |
|
wenzelm@28167
|
91 |
(* datatype future *)
|
wenzelm@28167
|
92 |
|
wenzelm@35016
|
93 |
type 'a result = 'a Exn.result Single_Assignment.var;
|
wenzelm@35016
|
94 |
|
wenzelm@28972
|
95 |
datatype 'a future = Future of
|
wenzelm@34277
|
96 |
{promised: bool,
|
wenzelm@34277
|
97 |
task: task,
|
wenzelm@28177
|
98 |
group: group,
|
wenzelm@35016
|
99 |
result: 'a result};
|
wenzelm@28167
|
100 |
|
wenzelm@28167
|
101 |
fun task_of (Future {task, ...}) = task;
|
wenzelm@28167
|
102 |
fun group_of (Future {group, ...}) = group;
|
wenzelm@32257
|
103 |
fun result_of (Future {result, ...}) = result;
|
wenzelm@28167
|
104 |
|
wenzelm@35016
|
105 |
fun peek x = Single_Assignment.peek (result_of x);
|
wenzelm@28558
|
106 |
fun is_finished x = is_some (peek x);
|
wenzelm@28320
|
107 |
|
wenzelm@34277
|
108 |
fun assign_result group result res =
|
wenzelm@34277
|
109 |
let
|
wenzelm@38122
|
110 |
val _ = Single_Assignment.assign result res
|
wenzelm@38122
|
111 |
handle exn as Fail _ =>
|
wenzelm@38122
|
112 |
(case Single_Assignment.peek result of
|
wenzelm@38122
|
113 |
SOME (Exn.Exn Exn.Interrupt) => raise Exn.Interrupt
|
wenzelm@38122
|
114 |
| _ => reraise exn);
|
wenzelm@34277
|
115 |
val ok =
|
wenzelm@38122
|
116 |
(case the (Single_Assignment.peek result) of
|
wenzelm@34277
|
117 |
Exn.Exn exn => (Task_Queue.cancel_group group exn; false)
|
wenzelm@34277
|
118 |
| Exn.Result _ => true);
|
wenzelm@34277
|
119 |
in ok end;
|
wenzelm@29002
|
120 |
|
wenzelm@28167
|
121 |
|
wenzelm@28177
|
122 |
|
wenzelm@28177
|
123 |
(** scheduling **)
|
wenzelm@28177
|
124 |
|
wenzelm@28177
|
125 |
(* synchronization *)
|
wenzelm@28156
|
126 |
|
wenzelm@32219
|
127 |
val scheduler_event = ConditionVar.conditionVar ();
|
wenzelm@32219
|
128 |
val work_available = ConditionVar.conditionVar ();
|
wenzelm@32219
|
129 |
val work_finished = ConditionVar.conditionVar ();
|
wenzelm@32219
|
130 |
|
wenzelm@28156
|
131 |
local
|
wenzelm@28156
|
132 |
val lock = Mutex.mutex ();
|
wenzelm@28156
|
133 |
in
|
wenzelm@28156
|
134 |
|
wenzelm@37216
|
135 |
fun SYNCHRONIZED name = Simple_Thread.synchronized name lock;
|
wenzelm@28156
|
136 |
|
wenzelm@32219
|
137 |
fun wait cond = (*requires SYNCHRONIZED*)
|
wenzelm@32298
|
138 |
Multithreading.sync_wait NONE NONE cond lock;
|
wenzelm@28206
|
139 |
|
wenzelm@32298
|
140 |
fun wait_timeout timeout cond = (*requires SYNCHRONIZED*)
|
wenzelm@32298
|
141 |
Multithreading.sync_wait NONE (SOME (Time.+ (Time.now (), timeout))) cond lock;
|
wenzelm@28166
|
142 |
|
wenzelm@32219
|
143 |
fun signal cond = (*requires SYNCHRONIZED*)
|
wenzelm@32219
|
144 |
ConditionVar.signal cond;
|
wenzelm@32219
|
145 |
|
wenzelm@32219
|
146 |
fun broadcast cond = (*requires SYNCHRONIZED*)
|
wenzelm@28166
|
147 |
ConditionVar.broadcast cond;
|
wenzelm@28156
|
148 |
|
wenzelm@32252
|
149 |
fun broadcast_work () = (*requires SYNCHRONIZED*)
|
wenzelm@32252
|
150 |
(ConditionVar.broadcast work_available;
|
wenzelm@32225
|
151 |
ConditionVar.broadcast work_finished);
|
wenzelm@32225
|
152 |
|
wenzelm@28156
|
153 |
end;
|
wenzelm@28156
|
154 |
|
wenzelm@28156
|
155 |
|
wenzelm@33431
|
156 |
(* global state *)
|
wenzelm@33431
|
157 |
|
wenzelm@33431
|
158 |
val queue = Unsynchronized.ref Task_Queue.empty;
|
wenzelm@33431
|
159 |
val next = Unsynchronized.ref 0;
|
wenzelm@33431
|
160 |
val scheduler = Unsynchronized.ref (NONE: Thread.thread option);
|
wenzelm@33431
|
161 |
val canceled = Unsynchronized.ref ([]: Task_Queue.group list);
|
wenzelm@33431
|
162 |
val do_shutdown = Unsynchronized.ref false;
|
wenzelm@33431
|
163 |
val max_workers = Unsynchronized.ref 0;
|
wenzelm@33431
|
164 |
val max_active = Unsynchronized.ref 0;
|
wenzelm@33432
|
165 |
val worker_trend = Unsynchronized.ref 0;
|
wenzelm@33431
|
166 |
|
wenzelm@33431
|
167 |
datatype worker_state = Working | Waiting | Sleeping;
|
wenzelm@33431
|
168 |
val workers = Unsynchronized.ref ([]: (Thread.thread * worker_state Unsynchronized.ref) list);
|
wenzelm@33431
|
169 |
|
wenzelm@33431
|
170 |
fun count_workers state = (*requires SYNCHRONIZED*)
|
wenzelm@33431
|
171 |
fold (fn (_, state_ref) => fn i => if ! state_ref = state then i + 1 else i) (! workers) 0;
|
wenzelm@33431
|
172 |
|
wenzelm@33431
|
173 |
|
wenzelm@32119
|
174 |
(* execute future jobs *)
|
wenzelm@32119
|
175 |
|
wenzelm@32119
|
176 |
fun future_job group (e: unit -> 'a) =
|
wenzelm@32119
|
177 |
let
|
wenzelm@35016
|
178 |
val result = Single_Assignment.var "future" : 'a result;
|
wenzelm@37053
|
179 |
val pos = Position.thread_data ();
|
wenzelm@32127
|
180 |
fun job ok =
|
wenzelm@32127
|
181 |
let
|
wenzelm@32127
|
182 |
val res =
|
wenzelm@32127
|
183 |
if ok then
|
wenzelm@32230
|
184 |
Exn.capture (fn () =>
|
wenzelm@37053
|
185 |
Multithreading.with_attributes Multithreading.private_interrupts
|
wenzelm@37053
|
186 |
(fn _ => Position.setmp_thread_data pos e ())) ()
|
wenzelm@32127
|
187 |
else Exn.Exn Exn.Interrupt;
|
wenzelm@34277
|
188 |
in assign_result group result res end;
|
wenzelm@32119
|
189 |
in (result, job) end;
|
wenzelm@28156
|
190 |
|
wenzelm@34279
|
191 |
fun cancel_now group = (*requires SYNCHRONIZED*)
|
wenzelm@34280
|
192 |
Task_Queue.cancel (! queue) group;
|
wenzelm@34279
|
193 |
|
wenzelm@34279
|
194 |
fun cancel_later group = (*requires SYNCHRONIZED*)
|
wenzelm@32738
|
195 |
(Unsynchronized.change canceled (insert Task_Queue.eq_group group);
|
wenzelm@32738
|
196 |
broadcast scheduler_event);
|
wenzelm@29341
|
197 |
|
wenzelm@33429
|
198 |
fun execute (task, group, jobs) =
|
wenzelm@28167
|
199 |
let
|
wenzelm@32122
|
200 |
val valid = not (Task_Queue.is_canceled group);
|
wenzelm@33429
|
201 |
val ok = setmp_thread_data (task, group) (fn () =>
|
wenzelm@29384
|
202 |
fold (fn job => fn ok => job valid andalso ok) jobs true) ();
|
wenzelm@32250
|
203 |
val _ = SYNCHRONIZED "finish" (fn () =>
|
wenzelm@32219
|
204 |
let
|
wenzelm@32738
|
205 |
val maximal = Unsynchronized.change_result queue (Task_Queue.finish task);
|
wenzelm@32219
|
206 |
val _ =
|
wenzelm@32219
|
207 |
if ok then ()
|
wenzelm@34279
|
208 |
else if cancel_now group then ()
|
wenzelm@34279
|
209 |
else cancel_later group;
|
wenzelm@32219
|
210 |
val _ = broadcast work_finished;
|
wenzelm@33434
|
211 |
val _ = if maximal then () else signal work_available;
|
wenzelm@32219
|
212 |
in () end);
|
wenzelm@28167
|
213 |
in () end;
|
wenzelm@28167
|
214 |
|
wenzelm@28167
|
215 |
|
wenzelm@28167
|
216 |
(* worker threads *)
|
wenzelm@28167
|
217 |
|
wenzelm@33431
|
218 |
fun worker_wait active cond = (*requires SYNCHRONIZED*)
|
wenzelm@33427
|
219 |
let
|
wenzelm@33431
|
220 |
val state =
|
wenzelm@33431
|
221 |
(case AList.lookup Thread.equal (! workers) (Thread.self ()) of
|
wenzelm@33431
|
222 |
SOME state => state
|
wenzelm@33431
|
223 |
| NONE => raise Fail "Unregistered worker thread");
|
wenzelm@33431
|
224 |
val _ = state := (if active then Waiting else Sleeping);
|
wenzelm@33427
|
225 |
val _ = wait cond;
|
wenzelm@33431
|
226 |
val _ = state := Working;
|
wenzelm@33427
|
227 |
in () end;
|
wenzelm@28162
|
228 |
|
wenzelm@33436
|
229 |
fun worker_next () = (*requires SYNCHRONIZED*)
|
wenzelm@33427
|
230 |
if length (! workers) > ! max_workers then
|
wenzelm@33427
|
231 |
(Unsynchronized.change workers (AList.delete Thread.equal (Thread.self ()));
|
wenzelm@33436
|
232 |
signal work_available;
|
wenzelm@28167
|
233 |
NONE)
|
wenzelm@33431
|
234 |
else if count_workers Working > ! max_active then
|
wenzelm@33436
|
235 |
(worker_wait false work_available; worker_next ())
|
wenzelm@28166
|
236 |
else
|
wenzelm@32738
|
237 |
(case Unsynchronized.change_result queue (Task_Queue.dequeue (Thread.self ())) of
|
wenzelm@33436
|
238 |
NONE => (worker_wait false work_available; worker_next ())
|
wenzelm@33434
|
239 |
| some => (signal work_available; some));
|
wenzelm@28156
|
240 |
|
wenzelm@28167
|
241 |
fun worker_loop name =
|
wenzelm@33436
|
242 |
(case SYNCHRONIZED name (fn () => worker_next ()) of
|
wenzelm@29120
|
243 |
NONE => ()
|
wenzelm@33429
|
244 |
| SOME work => (execute work; worker_loop name));
|
wenzelm@28156
|
245 |
|
wenzelm@33428
|
246 |
fun worker_start name = (*requires SYNCHRONIZED*)
|
wenzelm@37216
|
247 |
Unsynchronized.change workers (cons (Simple_Thread.fork false (fn () => worker_loop name),
|
wenzelm@33431
|
248 |
Unsynchronized.ref Working));
|
wenzelm@28156
|
249 |
|
wenzelm@28156
|
250 |
|
wenzelm@28156
|
251 |
(* scheduler *)
|
wenzelm@28156
|
252 |
|
wenzelm@33428
|
253 |
val status_ticks = Unsynchronized.ref 0;
|
wenzelm@33428
|
254 |
|
wenzelm@33428
|
255 |
val last_round = Unsynchronized.ref Time.zeroTime;
|
wenzelm@32252
|
256 |
val next_round = Time.fromMilliseconds 50;
|
wenzelm@32226
|
257 |
|
wenzelm@28206
|
258 |
fun scheduler_next () = (*requires SYNCHRONIZED*)
|
wenzelm@28156
|
259 |
let
|
wenzelm@33428
|
260 |
val now = Time.now ();
|
wenzelm@33428
|
261 |
val tick = Time.<= (Time.+ (! last_round, next_round), now);
|
wenzelm@33428
|
262 |
val _ = if tick then last_round := now else ();
|
wenzelm@33428
|
263 |
|
wenzelm@33436
|
264 |
|
wenzelm@33436
|
265 |
(* queue and worker status *)
|
wenzelm@33436
|
266 |
|
wenzelm@32226
|
267 |
val _ =
|
wenzelm@33428
|
268 |
if tick then Unsynchronized.change status_ticks (fn i => (i + 1) mod 10) else ();
|
wenzelm@33428
|
269 |
val _ =
|
wenzelm@33428
|
270 |
if tick andalso ! status_ticks = 0 then
|
wenzelm@33428
|
271 |
Multithreading.tracing 1 (fn () =>
|
wenzelm@33428
|
272 |
let
|
wenzelm@34277
|
273 |
val {ready, pending, running, passive} = Task_Queue.status (! queue);
|
wenzelm@33428
|
274 |
val total = length (! workers);
|
wenzelm@33431
|
275 |
val active = count_workers Working;
|
wenzelm@33431
|
276 |
val waiting = count_workers Waiting;
|
wenzelm@33428
|
277 |
in
|
wenzelm@33428
|
278 |
"SCHEDULE " ^ Time.toString now ^ ": " ^
|
wenzelm@33428
|
279 |
string_of_int ready ^ " ready, " ^
|
wenzelm@33428
|
280 |
string_of_int pending ^ " pending, " ^
|
wenzelm@34277
|
281 |
string_of_int running ^ " running, " ^
|
wenzelm@34277
|
282 |
string_of_int passive ^ " passive; " ^
|
wenzelm@33428
|
283 |
string_of_int total ^ " workers, " ^
|
wenzelm@33431
|
284 |
string_of_int active ^ " active, " ^
|
wenzelm@33431
|
285 |
string_of_int waiting ^ " waiting "
|
wenzelm@33428
|
286 |
end)
|
wenzelm@33428
|
287 |
else ();
|
wenzelm@32053
|
288 |
|
wenzelm@28191
|
289 |
val _ =
|
wenzelm@32219
|
290 |
if forall (Thread.isActive o #1) (! workers) then ()
|
wenzelm@32115
|
291 |
else
|
wenzelm@33430
|
292 |
let
|
wenzelm@37698
|
293 |
val (alive, dead) = List.partition (Thread.isActive o #1) (! workers);
|
wenzelm@33430
|
294 |
val _ = workers := alive;
|
wenzelm@33430
|
295 |
in
|
wenzelm@33430
|
296 |
Multithreading.tracing 0 (fn () =>
|
wenzelm@33430
|
297 |
"SCHEDULE: disposed " ^ string_of_int (length dead) ^ " dead worker threads")
|
wenzelm@33430
|
298 |
end;
|
wenzelm@28191
|
299 |
|
wenzelm@33436
|
300 |
|
wenzelm@33436
|
301 |
(* worker pool adjustments *)
|
wenzelm@33436
|
302 |
|
wenzelm@33436
|
303 |
val max_active0 = ! max_active;
|
wenzelm@33436
|
304 |
val max_workers0 = ! max_workers;
|
wenzelm@33436
|
305 |
|
wenzelm@28206
|
306 |
val m = if ! do_shutdown then 0 else Multithreading.max_threads_value ();
|
wenzelm@33427
|
307 |
val _ = max_active := m;
|
wenzelm@33427
|
308 |
|
wenzelm@33432
|
309 |
val mm =
|
wenzelm@33432
|
310 |
if ! do_shutdown then 0
|
wenzelm@33432
|
311 |
else if m = 9999 then 1
|
wenzelm@33434
|
312 |
else Int.min (Int.max (count_workers Working + 2 * count_workers Waiting, m), 4 * m);
|
wenzelm@33432
|
313 |
val _ =
|
wenzelm@33432
|
314 |
if tick andalso mm > ! max_workers then
|
wenzelm@33432
|
315 |
Unsynchronized.change worker_trend (fn w => if w < 0 then 0 else w + 1)
|
wenzelm@33432
|
316 |
else if tick andalso mm < ! max_workers then
|
wenzelm@33432
|
317 |
Unsynchronized.change worker_trend (fn w => if w > 0 then 0 else w - 1)
|
wenzelm@33432
|
318 |
else ();
|
wenzelm@33432
|
319 |
val _ =
|
wenzelm@33436
|
320 |
if mm = 0 orelse ! worker_trend > 50 orelse ! worker_trend < ~50 then
|
wenzelm@33436
|
321 |
max_workers := mm
|
wenzelm@33436
|
322 |
else if ! worker_trend > 5 andalso ! max_workers < 2 * m then
|
wenzelm@33436
|
323 |
max_workers := Int.min (mm, 2 * m)
|
wenzelm@33432
|
324 |
else ();
|
wenzelm@33427
|
325 |
|
wenzelm@33428
|
326 |
val missing = ! max_workers - length (! workers);
|
wenzelm@28203
|
327 |
val _ =
|
wenzelm@33428
|
328 |
if missing > 0 then
|
wenzelm@33436
|
329 |
funpow missing (fn () =>
|
wenzelm@33436
|
330 |
ignore (worker_start ("worker " ^ string_of_int (Unsynchronized.inc next)))) ()
|
wenzelm@28203
|
331 |
else ();
|
wenzelm@28206
|
332 |
|
wenzelm@33436
|
333 |
val _ =
|
wenzelm@33436
|
334 |
if ! max_active = max_active0 andalso ! max_workers = max_workers0 then ()
|
wenzelm@33436
|
335 |
else signal work_available;
|
wenzelm@33436
|
336 |
|
wenzelm@33436
|
337 |
|
wenzelm@33436
|
338 |
(* canceled groups *)
|
wenzelm@33436
|
339 |
|
wenzelm@32225
|
340 |
val _ =
|
wenzelm@32225
|
341 |
if null (! canceled) then ()
|
wenzelm@32293
|
342 |
else
|
wenzelm@32293
|
343 |
(Multithreading.tracing 1 (fn () =>
|
wenzelm@32293
|
344 |
string_of_int (length (! canceled)) ^ " canceled groups");
|
wenzelm@34279
|
345 |
Unsynchronized.change canceled (filter_out cancel_now);
|
wenzelm@32293
|
346 |
broadcast_work ());
|
wenzelm@28206
|
347 |
|
wenzelm@33436
|
348 |
|
wenzelm@33436
|
349 |
(* delay loop *)
|
wenzelm@33436
|
350 |
|
wenzelm@32298
|
351 |
val _ = Exn.release (wait_timeout next_round scheduler_event);
|
wenzelm@32219
|
352 |
|
wenzelm@33436
|
353 |
|
wenzelm@33436
|
354 |
(* shutdown *)
|
wenzelm@33436
|
355 |
|
wenzelm@34277
|
356 |
val _ = if Task_Queue.all_passive (! queue) then do_shutdown := true else ();
|
wenzelm@32219
|
357 |
val continue = not (! do_shutdown andalso null (! workers));
|
wenzelm@28206
|
358 |
val _ = if continue then () else scheduler := NONE;
|
wenzelm@33436
|
359 |
|
wenzelm@32219
|
360 |
val _ = broadcast scheduler_event;
|
wenzelm@32298
|
361 |
in continue end
|
wenzelm@32298
|
362 |
handle Exn.Interrupt =>
|
wenzelm@32298
|
363 |
(Multithreading.tracing 1 (fn () => "Interrupt");
|
wenzelm@34280
|
364 |
List.app cancel_later (Task_Queue.cancel_all (! queue));
|
wenzelm@34279
|
365 |
broadcast_work (); true);
|
wenzelm@32298
|
366 |
|
wenzelm@28206
|
367 |
fun scheduler_loop () =
|
wenzelm@33437
|
368 |
while
|
wenzelm@33437
|
369 |
Multithreading.with_attributes
|
wenzelm@33437
|
370 |
(Multithreading.sync_interrupts Multithreading.public_interrupts)
|
wenzelm@33437
|
371 |
(fn _ => SYNCHRONIZED "scheduler" (fn () => scheduler_next ()))
|
wenzelm@33437
|
372 |
do ();
|
wenzelm@28191
|
373 |
|
wenzelm@28203
|
374 |
fun scheduler_active () = (*requires SYNCHRONIZED*)
|
wenzelm@28203
|
375 |
(case ! scheduler of NONE => false | SOME thread => Thread.isActive thread);
|
wenzelm@28203
|
376 |
|
wenzelm@32228
|
377 |
fun scheduler_check () = (*requires SYNCHRONIZED*)
|
wenzelm@32228
|
378 |
(do_shutdown := false;
|
wenzelm@32252
|
379 |
if scheduler_active () then ()
|
wenzelm@37216
|
380 |
else scheduler := SOME (Simple_Thread.fork false scheduler_loop));
|
wenzelm@28191
|
381 |
|
wenzelm@28191
|
382 |
|
wenzelm@28191
|
383 |
|
wenzelm@29370
|
384 |
(** futures **)
|
wenzelm@29370
|
385 |
|
wenzelm@29370
|
386 |
(* fork *)
|
wenzelm@29370
|
387 |
|
wenzelm@29370
|
388 |
fun fork_future opt_group deps pri e =
|
wenzelm@29370
|
389 |
let
|
wenzelm@32122
|
390 |
val group =
|
wenzelm@32122
|
391 |
(case opt_group of
|
wenzelm@38133
|
392 |
NONE => worker_subgroup ()
|
wenzelm@34277
|
393 |
| SOME group => group);
|
wenzelm@29370
|
394 |
val (result, job) = future_job group e;
|
wenzelm@32250
|
395 |
val task = SYNCHRONIZED "enqueue" (fn () =>
|
wenzelm@32219
|
396 |
let
|
wenzelm@32738
|
397 |
val (task, minimal) =
|
wenzelm@32738
|
398 |
Unsynchronized.change_result queue (Task_Queue.enqueue group deps pri job);
|
wenzelm@32219
|
399 |
val _ = if minimal then signal work_available else ();
|
wenzelm@32228
|
400 |
val _ = scheduler_check ();
|
wenzelm@32219
|
401 |
in task end);
|
wenzelm@34277
|
402 |
in Future {promised = false, task = task, group = group, result = result} end;
|
wenzelm@28162
|
403 |
|
wenzelm@29370
|
404 |
fun fork_group group e = fork_future (SOME group) [] 0 e;
|
wenzelm@32729
|
405 |
fun fork_deps_pri deps pri e = fork_future NONE (map task_of deps) pri e;
|
wenzelm@32729
|
406 |
fun fork_deps deps e = fork_deps_pri deps 0 e;
|
wenzelm@32729
|
407 |
fun fork_pri pri e = fork_deps_pri [] pri e;
|
wenzelm@32729
|
408 |
fun fork e = fork_deps [] e;
|
wenzelm@28162
|
409 |
|
wenzelm@28186
|
410 |
|
wenzelm@29370
|
411 |
(* join *)
|
wenzelm@28186
|
412 |
|
wenzelm@29551
|
413 |
local
|
wenzelm@29551
|
414 |
|
wenzelm@32119
|
415 |
fun get_result x =
|
wenzelm@32119
|
416 |
(case peek x of
|
wenzelm@38120
|
417 |
NONE => Exn.Exn (Fail "Unfinished future")
|
wenzelm@37182
|
418 |
| SOME (exn as Exn.Exn Exn.Interrupt) =>
|
wenzelm@37182
|
419 |
(case Exn.flatten_list (Task_Queue.group_status (group_of x)) of
|
wenzelm@37182
|
420 |
[] => exn
|
wenzelm@37182
|
421 |
| exns => Exn.Exn (Exn.EXCEPTIONS exns))
|
wenzelm@32122
|
422 |
| SOME res => res);
|
wenzelm@28177
|
423 |
|
wenzelm@32115
|
424 |
fun join_next deps = (*requires SYNCHRONIZED*)
|
wenzelm@32224
|
425 |
if null deps then NONE
|
wenzelm@32224
|
426 |
else
|
wenzelm@32738
|
427 |
(case Unsynchronized.change_result queue (Task_Queue.dequeue_towards (Thread.self ()) deps) of
|
wenzelm@32224
|
428 |
(NONE, []) => NONE
|
wenzelm@33431
|
429 |
| (NONE, deps') => (worker_wait true work_finished; join_next deps')
|
wenzelm@32224
|
430 |
| (SOME work, deps') => SOME (work, deps'));
|
wenzelm@32115
|
431 |
|
wenzelm@32823
|
432 |
fun execute_work NONE = ()
|
wenzelm@33429
|
433 |
| execute_work (SOME (work, deps')) = (execute work; join_work deps')
|
wenzelm@32823
|
434 |
and join_work deps =
|
wenzelm@32823
|
435 |
execute_work (SYNCHRONIZED "join" (fn () => join_next deps));
|
wenzelm@32823
|
436 |
|
wenzelm@32823
|
437 |
fun join_depend task deps =
|
wenzelm@32823
|
438 |
execute_work (SYNCHRONIZED "join" (fn () =>
|
wenzelm@32823
|
439 |
(Unsynchronized.change queue (Task_Queue.depend task deps); join_next deps)));
|
wenzelm@29551
|
440 |
|
wenzelm@29551
|
441 |
in
|
wenzelm@29551
|
442 |
|
wenzelm@29370
|
443 |
fun join_results xs =
|
wenzelm@29370
|
444 |
if forall is_finished xs then map get_result xs
|
wenzelm@32250
|
445 |
else if Multithreading.self_critical () then
|
wenzelm@32250
|
446 |
error "Cannot join future values within critical section"
|
wenzelm@32823
|
447 |
else
|
wenzelm@32823
|
448 |
(case worker_task () of
|
wenzelm@32823
|
449 |
SOME task => join_depend task (map task_of xs)
|
wenzelm@35016
|
450 |
| NONE => List.app (ignore o Single_Assignment.await o result_of) xs;
|
wenzelm@32823
|
451 |
map get_result xs);
|
wenzelm@28186
|
452 |
|
wenzelm@29551
|
453 |
end;
|
wenzelm@29551
|
454 |
|
wenzelm@28647
|
455 |
fun join_result x = singleton join_results x;
|
wenzelm@28647
|
456 |
fun join x = Exn.release (join_result x);
|
wenzelm@28156
|
457 |
|
wenzelm@28979
|
458 |
|
wenzelm@34277
|
459 |
(* fast-path versions -- bypassing full task management *)
|
wenzelm@34277
|
460 |
|
wenzelm@34277
|
461 |
fun value (x: 'a) =
|
wenzelm@34277
|
462 |
let
|
wenzelm@34277
|
463 |
val group = Task_Queue.new_group NONE;
|
wenzelm@35016
|
464 |
val result = Single_Assignment.var "value" : 'a result;
|
wenzelm@34277
|
465 |
val _ = assign_result group result (Exn.Result x);
|
wenzelm@34277
|
466 |
in Future {promised = false, task = Task_Queue.dummy_task, group = group, result = result} end;
|
wenzelm@28191
|
467 |
|
wenzelm@29384
|
468 |
fun map_future f x =
|
wenzelm@29370
|
469 |
let
|
wenzelm@29384
|
470 |
val task = task_of x;
|
wenzelm@32122
|
471 |
val group = Task_Queue.new_group (SOME (group_of x));
|
wenzelm@29384
|
472 |
val (result, job) = future_job group (fn () => f (join x));
|
wenzelm@29384
|
473 |
|
wenzelm@32250
|
474 |
val extended = SYNCHRONIZED "extend" (fn () =>
|
wenzelm@29370
|
475 |
(case Task_Queue.extend task job (! queue) of
|
wenzelm@29370
|
476 |
SOME queue' => (queue := queue'; true)
|
wenzelm@29370
|
477 |
| NONE => false));
|
wenzelm@29370
|
478 |
in
|
wenzelm@34277
|
479 |
if extended then Future {promised = false, task = task, group = group, result = result}
|
wenzelm@32119
|
480 |
else fork_future (SOME group) [task] (Task_Queue.pri_of_task task) (fn () => f (join x))
|
wenzelm@29370
|
481 |
end;
|
wenzelm@29370
|
482 |
|
wenzelm@29370
|
483 |
|
wenzelm@34277
|
484 |
(* promised futures -- fulfilled by external means *)
|
wenzelm@34277
|
485 |
|
wenzelm@34277
|
486 |
fun promise_group group : 'a future =
|
wenzelm@34277
|
487 |
let
|
wenzelm@35016
|
488 |
val result = Single_Assignment.var "promise" : 'a result;
|
wenzelm@38122
|
489 |
fun abort () = assign_result group result (Exn.Exn Exn.Interrupt) handle Fail _ => true;
|
wenzelm@38122
|
490 |
val task = SYNCHRONIZED "enqueue_passive" (fn () =>
|
wenzelm@38122
|
491 |
Unsynchronized.change_result queue (Task_Queue.enqueue_passive group abort));
|
wenzelm@34277
|
492 |
in Future {promised = true, task = task, group = group, result = result} end;
|
wenzelm@34277
|
493 |
|
wenzelm@38133
|
494 |
fun promise () = promise_group (worker_subgroup ());
|
wenzelm@34277
|
495 |
|
wenzelm@34277
|
496 |
fun fulfill_result (Future {promised, task, group, result}) res =
|
wenzelm@34277
|
497 |
let
|
wenzelm@34277
|
498 |
val _ = promised orelse raise Fail "Not a promised future";
|
wenzelm@34277
|
499 |
fun job ok = assign_result group result (if ok then res else Exn.Exn Exn.Interrupt);
|
wenzelm@34277
|
500 |
val _ = execute (task, group, [job]);
|
wenzelm@34277
|
501 |
in () end;
|
wenzelm@34277
|
502 |
|
wenzelm@34277
|
503 |
fun fulfill x res = fulfill_result x (Exn.Result res);
|
wenzelm@34277
|
504 |
|
wenzelm@34277
|
505 |
|
wenzelm@29431
|
506 |
(* cancellation *)
|
wenzelm@28202
|
507 |
|
wenzelm@30621
|
508 |
fun interruptible_task f x =
|
wenzelm@30621
|
509 |
if Multithreading.available then
|
wenzelm@30621
|
510 |
Multithreading.with_attributes
|
wenzelm@32074
|
511 |
(if is_worker ()
|
wenzelm@32298
|
512 |
then Multithreading.private_interrupts
|
wenzelm@32298
|
513 |
else Multithreading.public_interrupts)
|
wenzelm@32298
|
514 |
(fn _ => f x)
|
wenzelm@30621
|
515 |
else interruptible f x;
|
wenzelm@30621
|
516 |
|
wenzelm@32228
|
517 |
(*cancel: present and future group members will be interrupted eventually*)
|
wenzelm@38122
|
518 |
fun cancel_group group = SYNCHRONIZED "cancel" (fn () =>
|
wenzelm@38122
|
519 |
(if cancel_now group then () else cancel_later group;
|
wenzelm@38122
|
520 |
signal work_available; scheduler_check ()));
|
wenzelm@38122
|
521 |
|
wenzelm@29431
|
522 |
fun cancel x = cancel_group (group_of x);
|
wenzelm@28206
|
523 |
|
wenzelm@29370
|
524 |
|
wenzelm@32228
|
525 |
(* shutdown *)
|
wenzelm@29370
|
526 |
|
wenzelm@28203
|
527 |
fun shutdown () =
|
wenzelm@28276
|
528 |
if Multithreading.available then
|
wenzelm@28276
|
529 |
SYNCHRONIZED "shutdown" (fn () =>
|
wenzelm@32228
|
530 |
while scheduler_active () do
|
wenzelm@34279
|
531 |
(wait scheduler_event; broadcast_work ()))
|
wenzelm@28276
|
532 |
else ();
|
wenzelm@28203
|
533 |
|
wenzelm@29370
|
534 |
|
wenzelm@38492
|
535 |
(* status markup *)
|
wenzelm@37706
|
536 |
|
wenzelm@38492
|
537 |
fun status e =
|
wenzelm@37706
|
538 |
let
|
wenzelm@37706
|
539 |
val _ = Output.status (Markup.markup Markup.forked "");
|
wenzelm@37706
|
540 |
val x = e (); (*sic -- report "joined" only for success*)
|
wenzelm@37706
|
541 |
val _ = Output.status (Markup.markup Markup.joined "");
|
wenzelm@37706
|
542 |
in x end;
|
wenzelm@37706
|
543 |
|
wenzelm@37706
|
544 |
|
wenzelm@29370
|
545 |
(*final declarations of this structure!*)
|
wenzelm@29370
|
546 |
val map = map_future;
|
wenzelm@29370
|
547 |
|
wenzelm@28156
|
548 |
end;
|
wenzelm@28972
|
549 |
|
wenzelm@28972
|
550 |
type 'a future = 'a Future.future;
|
wenzelm@28972
|
551 |
|