author | wenzelm |
Mon, 27 Jul 2009 17:36:30 +0200 | |
changeset 32230 | 9f6461b1c9cc |
parent 32229 | abdc0f6214c8 |
child 32246 | d4f7934e9555 |
permissions | -rw-r--r-- |
28156 | 1 |
(* Title: Pure/Concurrent/future.ML |
2 |
Author: Makarius |
|
3 |
||
28201 | 4 |
Future values. |
5 |
||
6 |
Notes: |
|
7 |
||
8 |
* Futures are similar to delayed evaluation, i.e. delay/force is |
|
9 |
generalized to fork/join (and variants). The idea is to model |
|
10 |
parallel value-oriented computations, but *not* communicating |
|
11 |
processes. |
|
12 |
||
13 |
* Futures are grouped; failure of one group member causes the whole |
|
32220 | 14 |
group to be interrupted eventually. Groups are block-structured. |
28201 | 15 |
|
16 |
* Forked futures are evaluated spontaneously by a farm of worker |
|
17 |
threads in the background; join resynchronizes the computation and |
|
18 |
delivers results (values or exceptions). |
|
19 |
||
20 |
* The pool of worker threads is limited, usually in correlation with |
|
21 |
the number of physical cores on the machine. Note that allocation |
|
22 |
of runtime resources is distorted either if workers yield CPU time |
|
23 |
(e.g. via system sleep or wait operations), or if non-worker |
|
24 |
threads contend for significant runtime resources independently. |
|
28156 | 25 |
*) |
26 |
||
27 |
signature FUTURE = |
|
28 |
sig |
|
28645 | 29 |
val enabled: unit -> bool |
29119 | 30 |
type task = Task_Queue.task |
31 |
type group = Task_Queue.group |
|
32058 | 32 |
val is_worker: unit -> bool |
32102 | 33 |
val worker_group: unit -> Task_Queue.group option |
28972 | 34 |
type 'a future |
35 |
val task_of: 'a future -> task |
|
36 |
val group_of: 'a future -> group |
|
37 |
val peek: 'a future -> 'a Exn.result option |
|
38 |
val is_finished: 'a future -> bool |
|
28997 | 39 |
val value: 'a -> 'a future |
28972 | 40 |
val fork: (unit -> 'a) -> 'a future |
28979
3ce619d8d432
fork/map: no inheritance of group (structure is nested, not parallel);
wenzelm
parents:
28972
diff
changeset
|
41 |
val fork_group: group -> (unit -> 'a) -> 'a future |
3ce619d8d432
fork/map: no inheritance of group (structure is nested, not parallel);
wenzelm
parents:
28972
diff
changeset
|
42 |
val fork_deps: 'b future list -> (unit -> 'a) -> 'a future |
29119 | 43 |
val fork_pri: int -> (unit -> 'a) -> 'a future |
28972 | 44 |
val join_results: 'a future list -> 'a Exn.result list |
45 |
val join_result: 'a future -> 'a Exn.result |
|
46 |
val join: 'a future -> 'a |
|
47 |
val map: ('a -> 'b) -> 'a future -> 'b future |
|
30618
046f4f986fb5
restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents:
30612
diff
changeset
|
48 |
val interruptible_task: ('a -> 'b) -> 'a -> 'b |
29431 | 49 |
val cancel_group: group -> unit |
28972 | 50 |
val cancel: 'a future -> unit |
28203 | 51 |
val shutdown: unit -> unit |
28156 | 52 |
end; |
53 |
||
54 |
structure Future: FUTURE = |
|
55 |
struct |
|
56 |
||
28177
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
57 |
(** future values **) |
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
58 |
|
28645 | 59 |
fun enabled () = |
29118 | 60 |
Multithreading.enabled () andalso |
28645 | 61 |
not (Multithreading.self_critical ()); |
62 |
||
63 |
||
28167 | 64 |
(* identifiers *) |
65 |
||
29119 | 66 |
type task = Task_Queue.task; |
67 |
type group = Task_Queue.group; |
|
28167 | 68 |
|
32058 | 69 |
local |
70 |
val tag = Universal.tag () : (string * task * group) option Universal.tag; |
|
71 |
in |
|
28177
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
72 |
fun thread_data () = the_default NONE (Thread.getLocal tag); |
32058 | 73 |
fun setmp_thread_data data f x = |
74 |
Library.setmp_thread_data tag (thread_data ()) (SOME data) f x; |
|
28167 | 75 |
end; |
76 |
||
32058 | 77 |
val is_worker = is_some o thread_data; |
32102 | 78 |
val worker_group = Option.map #3 o thread_data; |
32058 | 79 |
|
28167 | 80 |
|
81 |
(* datatype future *) |
|
82 |
||
28972 | 83 |
datatype 'a future = Future of |
28167 | 84 |
{task: task, |
28177
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
85 |
group: group, |
28167 | 86 |
result: 'a Exn.result option ref}; |
87 |
||
88 |
fun task_of (Future {task, ...}) = task; |
|
89 |
fun group_of (Future {group, ...}) = group; |
|
90 |
||
28558 | 91 |
fun peek (Future {result, ...}) = ! result; |
92 |
fun is_finished x = is_some (peek x); |
|
28320 | 93 |
|
28997 | 94 |
fun value x = Future |
29119 | 95 |
{task = Task_Queue.new_task 0, |
32102 | 96 |
group = Task_Queue.new_group NONE, |
28997 | 97 |
result = ref (SOME (Exn.Result x))}; |
98 |
||
28167 | 99 |
|
28177
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
100 |
|
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
101 |
(** scheduling **) |
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
102 |
|
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
103 |
(* global state *) |
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
104 |
|
29119 | 105 |
val queue = ref Task_Queue.empty; |
28468 | 106 |
val next = ref 0; |
28192 | 107 |
val workers = ref ([]: (Thread.thread * bool) list); |
28177
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
108 |
val scheduler = ref (NONE: Thread.thread option); |
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
109 |
val excessive = ref 0; |
29119 | 110 |
val canceled = ref ([]: Task_Queue.group list); |
28206
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
111 |
val do_shutdown = ref false; |
28177
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
112 |
|
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
113 |
|
8c0335bc9336
inherit group from running thread, or create a new one -- make it harder to re-use canceled groups;
wenzelm
parents:
28170
diff
changeset
|
114 |
(* synchronization *) |
28156 | 115 |
|
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
116 |
val scheduler_event = ConditionVar.conditionVar (); |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
117 |
val work_available = ConditionVar.conditionVar (); |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
118 |
val work_finished = ConditionVar.conditionVar (); |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
119 |
|
28156 | 120 |
local |
121 |
val lock = Mutex.mutex (); |
|
122 |
in |
|
123 |
||
28575 | 124 |
fun SYNCHRONIZED name = SimpleThread.synchronized name lock; |
28156 | 125 |
|
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
126 |
fun wait cond = (*requires SYNCHRONIZED*) |
32229 | 127 |
ConditionVar.wait (cond, lock) handle Exn.Interrupt => (); |
28206
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
128 |
|
32229 | 129 |
fun wait_interruptible cond timeout = (*requires SYNCHRONIZED*) |
130 |
interruptible (fn () => |
|
131 |
ignore (ConditionVar.waitUntil (cond, lock, Time.+ (Time.now (), timeout)))) (); |
|
28166
43087721a66e
moved task, thread_data, group, queue to task_queue.ML;
wenzelm
parents:
28163
diff
changeset
|
132 |
|
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
133 |
fun signal cond = (*requires SYNCHRONIZED*) |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
134 |
ConditionVar.signal cond; |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
135 |
|
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
136 |
fun broadcast cond = (*requires SYNCHRONIZED*) |
28166
43087721a66e
moved task, thread_data, group, queue to task_queue.ML;
wenzelm
parents:
28163
diff
changeset
|
137 |
ConditionVar.broadcast cond; |
28156 | 138 |
|
32225
d5d6f47fb018
cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents:
32224
diff
changeset
|
139 |
fun broadcast_all () = (*requires SYNCHRONIZED*) |
d5d6f47fb018
cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents:
32224
diff
changeset
|
140 |
(ConditionVar.broadcast scheduler_event; |
d5d6f47fb018
cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents:
32224
diff
changeset
|
141 |
ConditionVar.broadcast work_available; |
d5d6f47fb018
cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents:
32224
diff
changeset
|
142 |
ConditionVar.broadcast work_finished); |
d5d6f47fb018
cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents:
32224
diff
changeset
|
143 |
|
28156 | 144 |
end; |
145 |
||
146 |
||
28382 | 147 |
(* worker activity *) |
148 |
||
32095 | 149 |
fun count_active ws = |
150 |
fold (fn (_, active) => fn i => if active then i + 1 else i) ws 0; |
|
151 |
||
28382 | 152 |
fun change_active active = (*requires SYNCHRONIZED*) |
153 |
change workers (AList.update Thread.equal (Thread.self (), active)); |
|
154 |
||
32095 | 155 |
fun overloaded () = |
156 |
count_active (! workers) > Multithreading.max_threads_value (); |
|
157 |
||
28382 | 158 |
|
32099 | 159 |
(* execute future jobs *) |
160 |
||
161 |
fun future_job group (e: unit -> 'a) = |
|
162 |
let |
|
163 |
val result = ref (NONE: 'a Exn.result option); |
|
32107
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
164 |
fun job ok = |
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
165 |
let |
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
166 |
val res = |
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
167 |
if ok then |
32230
9f6461b1c9cc
interruptible: Thread.testInterrupt before changing thread attributes;
wenzelm
parents:
32229
diff
changeset
|
168 |
Exn.capture (fn () => |
9f6461b1c9cc
interruptible: Thread.testInterrupt before changing thread attributes;
wenzelm
parents:
32229
diff
changeset
|
169 |
(Thread.testInterrupt (); |
9f6461b1c9cc
interruptible: Thread.testInterrupt before changing thread attributes;
wenzelm
parents:
32229
diff
changeset
|
170 |
Multithreading.with_attributes Multithreading.restricted_interrupts |
9f6461b1c9cc
interruptible: Thread.testInterrupt before changing thread attributes;
wenzelm
parents:
32229
diff
changeset
|
171 |
(fn _ => fn () => e ())) ()) () |
32107
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
172 |
else Exn.Exn Exn.Interrupt; |
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
173 |
val _ = result := SOME res; |
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
174 |
in |
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
175 |
(case res of |
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
176 |
Exn.Exn exn => (Task_Queue.cancel_group group exn; false) |
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
177 |
| Exn.Result _ => true) |
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
178 |
end; |
32099 | 179 |
in (result, job) end; |
28156 | 180 |
|
29341
6bb007a0f9f2
more reactive scheduler: reduced loop timeout, propagate broadcast interrupt via TaskQueue.cancel_all;
wenzelm
parents:
29119
diff
changeset
|
181 |
fun do_cancel group = (*requires SYNCHRONIZED*) |
32225
d5d6f47fb018
cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents:
32224
diff
changeset
|
182 |
(change canceled (insert Task_Queue.eq_group group); broadcast scheduler_event); |
29341
6bb007a0f9f2
more reactive scheduler: reduced loop timeout, propagate broadcast interrupt via TaskQueue.cancel_all;
wenzelm
parents:
29119
diff
changeset
|
183 |
|
29366 | 184 |
fun execute name (task, group, jobs) = |
28167 | 185 |
let |
32102 | 186 |
val valid = not (Task_Queue.is_canceled group); |
32058 | 187 |
val ok = setmp_thread_data (name, task, group) (fn () => |
29384
a3c7e9ae9b71
more robust propagation of errors through bulk jobs;
wenzelm
parents:
29366
diff
changeset
|
188 |
fold (fn job => fn ok => job valid andalso ok) jobs true) (); |
28192 | 189 |
val _ = SYNCHRONIZED "execute" (fn () => |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
190 |
let |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
191 |
val maximal = change_result queue (Task_Queue.finish task); |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
192 |
val _ = |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
193 |
if ok then () |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
194 |
else if Task_Queue.cancel (! queue) group then () |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
195 |
else do_cancel group; |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
196 |
val _ = broadcast work_finished; |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
197 |
val _ = if maximal then () else broadcast work_available; |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
198 |
in () end); |
28167 | 199 |
in () end; |
200 |
||
201 |
||
202 |
(* worker threads *) |
|
203 |
||
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
204 |
fun worker_wait cond = (*requires SYNCHRONIZED*) |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
205 |
(change_active false; broadcast scheduler_event; |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
206 |
wait cond; |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
207 |
change_active true; broadcast scheduler_event); |
28162 | 208 |
|
29119 | 209 |
fun worker_next () = (*requires SYNCHRONIZED*) |
28167 | 210 |
if ! excessive > 0 then |
211 |
(dec excessive; |
|
28192 | 212 |
change workers (filter_out (fn (thread, _) => Thread.equal (thread, Thread.self ()))); |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
213 |
broadcast scheduler_event; |
28167 | 214 |
NONE) |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
215 |
else if overloaded () then (worker_wait scheduler_event; worker_next ()) |
28166
43087721a66e
moved task, thread_data, group, queue to task_queue.ML;
wenzelm
parents:
28163
diff
changeset
|
216 |
else |
29119 | 217 |
(case change_result queue Task_Queue.dequeue of |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
218 |
NONE => (worker_wait work_available; worker_next ()) |
28166
43087721a66e
moved task, thread_data, group, queue to task_queue.ML;
wenzelm
parents:
28163
diff
changeset
|
219 |
| some => some); |
28156 | 220 |
|
28167 | 221 |
fun worker_loop name = |
32107
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
222 |
(case SYNCHRONIZED name (fn () => worker_next ()) of |
29119 | 223 |
NONE => () |
28167 | 224 |
| SOME work => (execute name work; worker_loop name)); |
28156 | 225 |
|
28167 | 226 |
fun worker_start name = (*requires SYNCHRONIZED*) |
28242 | 227 |
change workers (cons (SimpleThread.fork false (fn () => worker_loop name), true)); |
28156 | 228 |
|
229 |
||
230 |
(* scheduler *) |
|
231 |
||
32226 | 232 |
val last_status = ref Time.zeroTime; |
233 |
val next_status = Time.fromMilliseconds 450; |
|
234 |
||
28206
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
235 |
fun scheduler_next () = (*requires SYNCHRONIZED*) |
28156 | 236 |
let |
32226 | 237 |
(*queue and worker status*) |
238 |
val _ = |
|
239 |
let val now = Time.now () in |
|
240 |
if Time.> (Time.+ (! last_status, next_status), now) then () |
|
241 |
else |
|
242 |
(last_status := now; Multithreading.tracing 1 (fn () => |
|
243 |
let |
|
244 |
val {ready, pending, running} = Task_Queue.status (! queue); |
|
245 |
val total = length (! workers); |
|
246 |
val active = count_active (! workers); |
|
247 |
in |
|
248 |
"SCHEDULE: " ^ |
|
249 |
string_of_int ready ^ " ready, " ^ |
|
250 |
string_of_int pending ^ " pending, " ^ |
|
251 |
string_of_int running ^ " running; " ^ |
|
252 |
string_of_int total ^ " workers, " ^ |
|
253 |
string_of_int active ^ " active" |
|
254 |
end)) |
|
255 |
end; |
|
32053 | 256 |
|
28206
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
257 |
(*worker threads*) |
28191 | 258 |
val _ = |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
259 |
if forall (Thread.isActive o #1) (! workers) then () |
32095 | 260 |
else |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
261 |
(case List.partition (Thread.isActive o #1) (! workers) of |
32095 | 262 |
(_, []) => () |
32220 | 263 |
| (alive, dead) => |
264 |
(workers := alive; Multithreading.tracing 0 (fn () => |
|
265 |
"SCHEDULE: disposed " ^ string_of_int (length dead) ^ " dead worker threads"))); |
|
28191 | 266 |
|
28206
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
267 |
val m = if ! do_shutdown then 0 else Multithreading.max_threads_value (); |
32095 | 268 |
val mm = (m * 3) div 2; |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
269 |
val l = length (! workers); |
32095 | 270 |
val _ = excessive := l - mm; |
28203 | 271 |
val _ = |
32095 | 272 |
if mm > l then |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
273 |
(funpow (mm - l) (fn () => worker_start ("worker " ^ string_of_int (inc next))) (); |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
274 |
broadcast scheduler_event) |
28203 | 275 |
else (); |
28206
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
276 |
|
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
277 |
(*canceled groups*) |
32225
d5d6f47fb018
cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents:
32224
diff
changeset
|
278 |
val _ = |
d5d6f47fb018
cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents:
32224
diff
changeset
|
279 |
if null (! canceled) then () |
d5d6f47fb018
cancel: improved reactivity due to more careful broadcasting;
wenzelm
parents:
32224
diff
changeset
|
280 |
else (change canceled (filter_out (Task_Queue.cancel (! queue))); broadcast_all ()); |
28206
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
281 |
|
32228
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
282 |
(*delay loop*) |
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
283 |
val delay = |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
284 |
Time.fromMilliseconds (if not (! do_shutdown) andalso null (! canceled) then 500 else 50); |
32229 | 285 |
val _ = wait_interruptible scheduler_event delay |
32230
9f6461b1c9cc
interruptible: Thread.testInterrupt before changing thread attributes;
wenzelm
parents:
32229
diff
changeset
|
286 |
handle Exn.Interrupt => |
9f6461b1c9cc
interruptible: Thread.testInterrupt before changing thread attributes;
wenzelm
parents:
32229
diff
changeset
|
287 |
(Multithreading.tracing 1 (fn () => "Interrupt"); |
9f6461b1c9cc
interruptible: Thread.testInterrupt before changing thread attributes;
wenzelm
parents:
32229
diff
changeset
|
288 |
List.app do_cancel (Task_Queue.cancel_all (! queue))); |
28167 | 289 |
|
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
290 |
(*shutdown*) |
32228
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
291 |
val _ = if Task_Queue.is_empty (! queue) then do_shutdown := true else (); |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
292 |
val continue = not (! do_shutdown andalso null (! workers)); |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
293 |
val _ = if continue then () else scheduler := NONE; |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
294 |
val _ = broadcast scheduler_event; |
28206
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
295 |
in continue end; |
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
296 |
|
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
297 |
fun scheduler_loop () = |
32107
47d0da617fcc
future_job: tight scope for interrupts, to prevent shooting ourselves in the foot via cancel_group;
wenzelm
parents:
32102
diff
changeset
|
298 |
while SYNCHRONIZED "scheduler" (fn () => scheduler_next ()) do (); |
28156 | 299 |
|
28203 | 300 |
fun scheduler_active () = (*requires SYNCHRONIZED*) |
301 |
(case ! scheduler of NONE => false | SOME thread => Thread.isActive thread); |
|
302 |
||
32228
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
303 |
fun scheduler_check () = (*requires SYNCHRONIZED*) |
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
304 |
(do_shutdown := false; |
28206
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
305 |
if not (scheduler_active ()) then |
32228
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
306 |
(scheduler := SOME (SimpleThread.fork false scheduler_loop); broadcast scheduler_event) |
28206
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
307 |
else ()); |
28156 | 308 |
|
309 |
||
29366 | 310 |
|
311 |
(** futures **) |
|
28156 | 312 |
|
29366 | 313 |
(* fork *) |
314 |
||
315 |
fun fork_future opt_group deps pri e = |
|
316 |
let |
|
32102 | 317 |
val group = |
318 |
(case opt_group of |
|
319 |
SOME group => group |
|
320 |
| NONE => Task_Queue.new_group (worker_group ())); |
|
29366 | 321 |
val (result, job) = future_job group e; |
28192 | 322 |
val task = SYNCHRONIZED "future" (fn () => |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
323 |
let |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
324 |
val (task, minimal) = change_result queue (Task_Queue.enqueue group deps pri job); |
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
325 |
val _ = if minimal then signal work_available else (); |
32228
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
326 |
val _ = scheduler_check (); |
32219
9a2566d1fdbd
more specific conditions: scheduler_event, work_available, work_finished -- considereably reduces overhead with many threads;
wenzelm
parents:
32186
diff
changeset
|
327 |
in task end); |
28166
43087721a66e
moved task, thread_data, group, queue to task_queue.ML;
wenzelm
parents:
28163
diff
changeset
|
328 |
in Future {task = task, group = group, result = result} end; |
28162 | 329 |
|
29366 | 330 |
fun fork e = fork_future NONE [] 0 e; |
331 |
fun fork_group group e = fork_future (SOME group) [] 0 e; |
|
332 |
fun fork_deps deps e = fork_future NONE (map task_of deps) 0 e; |
|
333 |
fun fork_pri pri e = fork_future NONE [] pri e; |
|
28186 | 334 |
|
335 |
||
29366 | 336 |
(* join *) |
337 |
||
29551
95e469919c3e
join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents:
29431
diff
changeset
|
338 |
local |
95e469919c3e
join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents:
29431
diff
changeset
|
339 |
|
32099 | 340 |
fun get_result x = |
341 |
(case peek x of |
|
32102 | 342 |
NONE => Exn.Exn (SYS_ERROR "unfinished future") |
343 |
| SOME (Exn.Exn Exn.Interrupt) => |
|
344 |
Exn.Exn (Exn.EXCEPTIONS (Exn.flatten_list (Task_Queue.group_status (group_of x)))) |
|
345 |
| SOME res => res); |
|
28186 | 346 |
|
32224 | 347 |
fun join_wait x = |
348 |
if SYNCHRONIZED "join_wait" (fn () => |
|
349 |
is_finished x orelse (wait work_finished; false)) |
|
350 |
then () else join_wait x; |
|
351 |
||
32095 | 352 |
fun join_next deps = (*requires SYNCHRONIZED*) |
32224 | 353 |
if null deps then NONE |
354 |
else |
|
355 |
(case change_result queue (Task_Queue.dequeue_towards deps) of |
|
356 |
(NONE, []) => NONE |
|
357 |
| (NONE, deps') => (worker_wait work_finished; join_next deps') |
|
358 |
| (SOME work, deps') => SOME (work, deps')); |
|
32095 | 359 |
|
32224 | 360 |
fun join_work deps = |
32095 | 361 |
(case SYNCHRONIZED "join" (fn () => join_next deps) of |
29551
95e469919c3e
join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents:
29431
diff
changeset
|
362 |
NONE => () |
32224 | 363 |
| SOME (work, deps') => (execute "join" work; join_work deps')); |
29551
95e469919c3e
join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents:
29431
diff
changeset
|
364 |
|
95e469919c3e
join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents:
29431
diff
changeset
|
365 |
in |
95e469919c3e
join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents:
29431
diff
changeset
|
366 |
|
29366 | 367 |
fun join_results xs = |
368 |
if forall is_finished xs then map get_result xs |
|
369 |
else uninterruptible (fn _ => fn () => |
|
370 |
let |
|
371 |
val _ = Multithreading.self_critical () andalso |
|
372 |
error "Cannot join future values within critical section"; |
|
32224 | 373 |
val _ = |
374 |
if is_worker () then join_work (map task_of xs) |
|
375 |
else List.app join_wait xs; |
|
29366 | 376 |
in map get_result xs end) (); |
28186 | 377 |
|
29551
95e469919c3e
join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents:
29431
diff
changeset
|
378 |
end; |
95e469919c3e
join_results: when dependencies are resulved (but not finished yet),
wenzelm
parents:
29431
diff
changeset
|
379 |
|
28647
8068cdc84e7e
join_results: allow CRITICAL join of finished futures;
wenzelm
parents:
28645
diff
changeset
|
380 |
fun join_result x = singleton join_results x; |
8068cdc84e7e
join_results: allow CRITICAL join of finished futures;
wenzelm
parents:
28645
diff
changeset
|
381 |
fun join x = Exn.release (join_result x); |
28156 | 382 |
|
29366 | 383 |
|
384 |
(* map *) |
|
385 |
||
29384
a3c7e9ae9b71
more robust propagation of errors through bulk jobs;
wenzelm
parents:
29366
diff
changeset
|
386 |
fun map_future f x = |
29366 | 387 |
let |
29384
a3c7e9ae9b71
more robust propagation of errors through bulk jobs;
wenzelm
parents:
29366
diff
changeset
|
388 |
val task = task_of x; |
32102 | 389 |
val group = Task_Queue.new_group (SOME (group_of x)); |
29384
a3c7e9ae9b71
more robust propagation of errors through bulk jobs;
wenzelm
parents:
29366
diff
changeset
|
390 |
val (result, job) = future_job group (fn () => f (join x)); |
a3c7e9ae9b71
more robust propagation of errors through bulk jobs;
wenzelm
parents:
29366
diff
changeset
|
391 |
|
29366 | 392 |
val extended = SYNCHRONIZED "map_future" (fn () => |
393 |
(case Task_Queue.extend task job (! queue) of |
|
394 |
SOME queue' => (queue := queue'; true) |
|
395 |
| NONE => false)); |
|
396 |
in |
|
29384
a3c7e9ae9b71
more robust propagation of errors through bulk jobs;
wenzelm
parents:
29366
diff
changeset
|
397 |
if extended then Future {task = task, group = group, result = result} |
32099 | 398 |
else fork_future (SOME group) [task] (Task_Queue.pri_of_task task) (fn () => f (join x)) |
29366 | 399 |
end; |
28979
3ce619d8d432
fork/map: no inheritance of group (structure is nested, not parallel);
wenzelm
parents:
28972
diff
changeset
|
400 |
|
28191 | 401 |
|
29431 | 402 |
(* cancellation *) |
28202
23cb9a974630
added focus, which indicates a particular collection of high-priority tasks;
wenzelm
parents:
28201
diff
changeset
|
403 |
|
30618
046f4f986fb5
restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents:
30612
diff
changeset
|
404 |
fun interruptible_task f x = |
046f4f986fb5
restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents:
30612
diff
changeset
|
405 |
if Multithreading.available then |
046f4f986fb5
restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents:
30612
diff
changeset
|
406 |
Multithreading.with_attributes |
32058 | 407 |
(if is_worker () |
30618
046f4f986fb5
restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents:
30612
diff
changeset
|
408 |
then Multithreading.restricted_interrupts |
046f4f986fb5
restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents:
30612
diff
changeset
|
409 |
else Multithreading.regular_interrupts) |
046f4f986fb5
restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents:
30612
diff
changeset
|
410 |
(fn _ => f) x |
046f4f986fb5
restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents:
30612
diff
changeset
|
411 |
else interruptible f x; |
046f4f986fb5
restricted interrupts for tasks running as future worker thread -- attempt to prevent interrupt race conditions;
wenzelm
parents:
30612
diff
changeset
|
412 |
|
32228
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
413 |
(*cancel: present and future group members will be interrupted eventually*) |
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
414 |
fun cancel_group group = SYNCHRONIZED "cancel" (fn () => do_cancel group); |
29431 | 415 |
fun cancel x = cancel_group (group_of x); |
28206
bcd48c6897d4
eliminated requests, use global state variables uniformly;
wenzelm
parents:
28203
diff
changeset
|
416 |
|
29366 | 417 |
|
32228
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
418 |
(* shutdown *) |
29366 | 419 |
|
28203 | 420 |
fun shutdown () = |
28276 | 421 |
if Multithreading.available then |
422 |
SYNCHRONIZED "shutdown" (fn () => |
|
32228
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
423 |
while scheduler_active () do |
7622c03141b0
scheduler: shutdown spontaneously (after some delay) if queue is empty;
wenzelm
parents:
32227
diff
changeset
|
424 |
(wait scheduler_event; broadcast_all ())) |
28276 | 425 |
else (); |
28203 | 426 |
|
29366 | 427 |
|
428 |
(*final declarations of this structure!*) |
|
429 |
val map = map_future; |
|
430 |
||
28156 | 431 |
end; |
28972 | 432 |
|
433 |
type 'a future = 'a Future.future; |
|
434 |