wenzelm@28165
|
1 |
(* Title: Pure/Concurrent/task_queue.ML
|
wenzelm@28165
|
2 |
Author: Makarius
|
wenzelm@28165
|
3 |
|
wenzelm@28165
|
4 |
Ordered queue of grouped tasks.
|
wenzelm@28165
|
5 |
*)
|
wenzelm@28165
|
6 |
|
wenzelm@28165
|
7 |
signature TASK_QUEUE =
|
wenzelm@28165
|
8 |
sig
|
wenzelm@29340
|
9 |
type task
|
wenzelm@34277
|
10 |
val dummy_task: task
|
wenzelm@29122
|
11 |
val pri_of_task: task -> int
|
wenzelm@28196
|
12 |
val str_of_task: task -> string
|
wenzelm@42560
|
13 |
val timing_of_task: task -> Time.time * Time.time * string list
|
wenzelm@42541
|
14 |
val running: task -> (unit -> 'a) -> 'a
|
wenzelm@42559
|
15 |
val joining: task -> (unit -> 'a) -> 'a
|
wenzelm@42560
|
16 |
val waiting: task -> task list -> (unit -> 'a) -> 'a
|
wenzelm@29340
|
17 |
type group
|
wenzelm@32221
|
18 |
val new_group: group option -> group
|
wenzelm@32052
|
19 |
val group_id: group -> int
|
wenzelm@29340
|
20 |
val eq_group: group * group -> bool
|
wenzelm@32221
|
21 |
val cancel_group: group -> exn -> unit
|
wenzelm@32221
|
22 |
val is_canceled: group -> bool
|
wenzelm@32121
|
23 |
val group_status: group -> exn list
|
wenzelm@28179
|
24 |
val str_of_group: group -> string
|
wenzelm@28165
|
25 |
type queue
|
wenzelm@28165
|
26 |
val empty: queue
|
wenzelm@34277
|
27 |
val all_passive: queue -> bool
|
wenzelm@34277
|
28 |
val status: queue -> {ready: int, pending: int, running: int, passive: int}
|
wenzelm@34280
|
29 |
val cancel: queue -> group -> bool
|
wenzelm@34280
|
30 |
val cancel_all: queue -> group list
|
wenzelm@38122
|
31 |
val enqueue_passive: group -> (unit -> bool) -> queue -> task * queue
|
wenzelm@42544
|
32 |
val enqueue: string -> group -> task list -> int -> (bool -> bool) ->
|
wenzelm@42544
|
33 |
queue -> (task * bool) * queue
|
wenzelm@29369
|
34 |
val extend: task -> (bool -> bool) -> queue -> queue option
|
wenzelm@39520
|
35 |
val dequeue_passive: Thread.thread -> task -> queue -> bool * queue
|
wenzelm@32253
|
36 |
val dequeue: Thread.thread -> queue -> (task * group * (bool -> bool) list) option * queue
|
wenzelm@32823
|
37 |
val depend: task -> task list -> queue -> queue
|
wenzelm@32253
|
38 |
val dequeue_towards: Thread.thread -> task list -> queue ->
|
wenzelm@32224
|
39 |
(((task * group * (bool -> bool) list) option * task list) * queue)
|
wenzelm@32221
|
40 |
val finish: task -> queue -> bool * queue
|
wenzelm@28165
|
41 |
end;
|
wenzelm@28165
|
42 |
|
wenzelm@35242
|
43 |
structure Task_Queue: TASK_QUEUE =
|
wenzelm@28165
|
44 |
struct
|
wenzelm@28165
|
45 |
|
wenzelm@40707
|
46 |
val new_id = Synchronized.counter ();
|
wenzelm@40707
|
47 |
|
wenzelm@40707
|
48 |
|
wenzelm@42541
|
49 |
(* timing *)
|
wenzelm@42541
|
50 |
|
wenzelm@42560
|
51 |
type timing = Time.time * Time.time * string list;
|
wenzelm@42541
|
52 |
|
wenzelm@42541
|
53 |
fun new_timing () =
|
wenzelm@42560
|
54 |
Synchronized.var "timing" ((Time.zeroTime, Time.zeroTime, []): timing);
|
wenzelm@42541
|
55 |
|
wenzelm@42559
|
56 |
fun gen_timing account timing e =
|
wenzelm@42541
|
57 |
let
|
wenzelm@42541
|
58 |
val start = Time.now ();
|
wenzelm@42541
|
59 |
val result = Exn.capture e ();
|
wenzelm@42541
|
60 |
val t = Time.- (Time.now (), start);
|
wenzelm@42559
|
61 |
val _ = Synchronized.change timing (account t);
|
wenzelm@42541
|
62 |
in Exn.release result end;
|
wenzelm@42541
|
63 |
|
wenzelm@42541
|
64 |
|
wenzelm@29122
|
65 |
(* tasks *)
|
wenzelm@28165
|
66 |
|
wenzelm@42544
|
67 |
abstype task = Task of
|
wenzelm@42544
|
68 |
{name: string,
|
wenzelm@42544
|
69 |
id: int,
|
wenzelm@42544
|
70 |
pri: int option,
|
wenzelm@42544
|
71 |
timing: timing Synchronized.var}
|
wenzelm@35242
|
72 |
with
|
wenzelm@35242
|
73 |
|
wenzelm@42544
|
74 |
val dummy_task = Task {name = "", id = ~1, pri = NONE, timing = new_timing ()};
|
wenzelm@42544
|
75 |
fun new_task name pri = Task {name = name, id = new_id (), pri = pri, timing = new_timing ()};
|
wenzelm@29003
|
76 |
|
wenzelm@42544
|
77 |
fun pri_of_task (Task {pri, ...}) = the_default 0 pri;
|
wenzelm@42544
|
78 |
fun str_of_task (Task {name, id, ...}) =
|
wenzelm@42544
|
79 |
if name = "" then string_of_int id else string_of_int id ^ " (" ^ name ^ ")";
|
wenzelm@28165
|
80 |
|
wenzelm@42544
|
81 |
fun timing_of_task (Task {timing, ...}) = Synchronized.value timing;
|
wenzelm@42559
|
82 |
|
wenzelm@42560
|
83 |
fun running (Task {timing, ...}) =
|
wenzelm@42560
|
84 |
gen_timing (fn t => fn (a, b, ds) => (Time.+ (a, t), b, ds)) timing;
|
wenzelm@42560
|
85 |
|
wenzelm@42560
|
86 |
fun joining (Task {timing, ...}) =
|
wenzelm@42560
|
87 |
gen_timing (fn t => fn (a, b, ds) => (Time.- (a, t), b, ds)) timing;
|
wenzelm@42560
|
88 |
|
wenzelm@42560
|
89 |
fun waiting (Task {timing, ...}) deps =
|
wenzelm@42560
|
90 |
timing |> gen_timing (fn t => fn (a, b, ds) =>
|
wenzelm@42560
|
91 |
(Time.- (a, t), Time.+ (b, t), fold (fn Task {name, ...} => insert (op =) name) deps ds));
|
wenzelm@42541
|
92 |
|
wenzelm@42544
|
93 |
fun task_ord (Task {id = id1, pri = pri1, ...}, Task {id = id2, pri = pri2, ...}) =
|
wenzelm@42544
|
94 |
prod_ord (rev_order o option_ord int_ord) int_ord ((pri1, id1), (pri2, id2));
|
wenzelm@42541
|
95 |
|
wenzelm@35242
|
96 |
val eq_task = is_equal o task_ord;
|
wenzelm@35242
|
97 |
|
wenzelm@35242
|
98 |
end;
|
wenzelm@35242
|
99 |
|
wenzelm@31972
|
100 |
structure Task_Graph = Graph(type key = task val ord = task_ord);
|
wenzelm@29122
|
101 |
|
wenzelm@29122
|
102 |
|
wenzelm@32121
|
103 |
(* nested groups *)
|
wenzelm@29003
|
104 |
|
wenzelm@35242
|
105 |
abstype group = Group of
|
wenzelm@32121
|
106 |
{parent: group option,
|
wenzelm@40707
|
107 |
id: int,
|
wenzelm@35242
|
108 |
status: exn list Synchronized.var}
|
wenzelm@35242
|
109 |
with
|
wenzelm@32052
|
110 |
|
wenzelm@32121
|
111 |
fun make_group (parent, id, status) = Group {parent = parent, id = id, status = status};
|
wenzelm@28551
|
112 |
|
wenzelm@40707
|
113 |
fun new_group parent = make_group (parent, new_id (), Synchronized.var "group" []);
|
wenzelm@29122
|
114 |
|
wenzelm@32121
|
115 |
fun group_id (Group {id, ...}) = id;
|
wenzelm@32121
|
116 |
fun eq_group (group1, group2) = group_id group1 = group_id group2;
|
wenzelm@28165
|
117 |
|
wenzelm@32121
|
118 |
fun group_ancestry (Group {parent, id, ...}) =
|
wenzelm@32121
|
119 |
id :: (case parent of NONE => [] | SOME group => group_ancestry group);
|
wenzelm@32121
|
120 |
|
wenzelm@32121
|
121 |
|
wenzelm@32221
|
122 |
(* group status *)
|
wenzelm@32221
|
123 |
|
wenzelm@32255
|
124 |
fun cancel_group (Group {status, ...}) exn =
|
wenzelm@32255
|
125 |
Synchronized.change status
|
wenzelm@32255
|
126 |
(fn exns =>
|
wenzelm@39509
|
127 |
if not (Exn.is_interrupt exn) orelse null exns then exn :: exns
|
wenzelm@39509
|
128 |
else exns);
|
wenzelm@32121
|
129 |
|
wenzelm@32255
|
130 |
fun is_canceled (Group {parent, status, ...}) =
|
wenzelm@32255
|
131 |
not (null (Synchronized.value status)) orelse
|
wenzelm@32255
|
132 |
(case parent of NONE => false | SOME group => is_canceled group);
|
wenzelm@32221
|
133 |
|
wenzelm@32255
|
134 |
fun group_status (Group {parent, status, ...}) =
|
wenzelm@32255
|
135 |
Synchronized.value status @
|
wenzelm@32255
|
136 |
(case parent of NONE => [] | SOME group => group_status group);
|
wenzelm@32121
|
137 |
|
wenzelm@32121
|
138 |
fun str_of_group group =
|
wenzelm@32121
|
139 |
(is_canceled group ? enclose "(" ")") (string_of_int (group_id group));
|
wenzelm@28179
|
140 |
|
wenzelm@35242
|
141 |
end;
|
wenzelm@35242
|
142 |
|
wenzelm@28165
|
143 |
|
wenzelm@28176
|
144 |
(* jobs *)
|
wenzelm@28165
|
145 |
|
wenzelm@28165
|
146 |
datatype job =
|
wenzelm@29369
|
147 |
Job of (bool -> bool) list |
|
wenzelm@34277
|
148 |
Running of Thread.thread |
|
wenzelm@38122
|
149 |
Passive of unit -> bool;
|
wenzelm@28165
|
150 |
|
wenzelm@29122
|
151 |
type jobs = (group * job) Task_Graph.T;
|
wenzelm@28176
|
152 |
|
wenzelm@29122
|
153 |
fun get_group (jobs: jobs) task = #1 (Task_Graph.get_node jobs task);
|
wenzelm@29122
|
154 |
fun get_job (jobs: jobs) task = #2 (Task_Graph.get_node jobs task);
|
wenzelm@29369
|
155 |
fun set_job task job (jobs: jobs) = Task_Graph.map_node task (fn (group, _) => (group, job)) jobs;
|
wenzelm@28202
|
156 |
|
wenzelm@32254
|
157 |
fun add_job task dep (jobs: jobs) =
|
wenzelm@32254
|
158 |
Task_Graph.add_edge (dep, task) jobs handle Task_Graph.UNDEF _ => jobs;
|
wenzelm@32254
|
159 |
|
wenzelm@32823
|
160 |
fun add_dep task dep (jobs: jobs) =
|
wenzelm@32823
|
161 |
if Task_Graph.is_edge jobs (task, dep) then
|
wenzelm@32823
|
162 |
raise Fail "Cyclic dependency of future tasks"
|
wenzelm@32823
|
163 |
else add_job task dep jobs;
|
wenzelm@32823
|
164 |
|
wenzelm@32254
|
165 |
fun get_deps (jobs: jobs) task =
|
wenzelm@32254
|
166 |
Task_Graph.imm_preds jobs task handle Task_Graph.UNDEF _ => [];
|
wenzelm@32254
|
167 |
|
wenzelm@28176
|
168 |
|
wenzelm@28176
|
169 |
(* queue of grouped jobs *)
|
wenzelm@28176
|
170 |
|
wenzelm@28165
|
171 |
datatype queue = Queue of
|
wenzelm@28184
|
172 |
{groups: task list Inttab.table, (*groups with presently active members*)
|
wenzelm@34280
|
173 |
jobs: jobs}; (*job dependency graph*)
|
wenzelm@28165
|
174 |
|
wenzelm@34280
|
175 |
fun make_queue groups jobs = Queue {groups = groups, jobs = jobs};
|
wenzelm@28204
|
176 |
|
wenzelm@34280
|
177 |
val empty = make_queue Inttab.empty Task_Graph.empty;
|
wenzelm@34277
|
178 |
|
wenzelm@38122
|
179 |
|
wenzelm@38122
|
180 |
(* job status *)
|
wenzelm@38122
|
181 |
|
wenzelm@38122
|
182 |
fun ready_job task ((group, Job list), ([], _)) = SOME (task, group, rev list)
|
wenzelm@38122
|
183 |
| ready_job task ((group, Passive abort), ([], _)) =
|
wenzelm@38122
|
184 |
if is_canceled group then SOME (task, group, [fn _ => abort ()])
|
wenzelm@38122
|
185 |
else NONE
|
wenzelm@38122
|
186 |
| ready_job _ _ = NONE;
|
wenzelm@38122
|
187 |
|
wenzelm@38122
|
188 |
fun active_job (_, Job _) = SOME ()
|
wenzelm@38122
|
189 |
| active_job (_, Running _) = SOME ()
|
wenzelm@38122
|
190 |
| active_job (group, Passive _) = if is_canceled group then SOME () else NONE;
|
wenzelm@38122
|
191 |
|
wenzelm@34277
|
192 |
fun all_passive (Queue {jobs, ...}) =
|
wenzelm@38122
|
193 |
is_none (Task_Graph.get_first (active_job o #1 o #2) jobs);
|
wenzelm@28165
|
194 |
|
wenzelm@28165
|
195 |
|
wenzelm@32121
|
196 |
(* queue status *)
|
wenzelm@32052
|
197 |
|
wenzelm@32052
|
198 |
fun status (Queue {jobs, ...}) =
|
wenzelm@32052
|
199 |
let
|
wenzelm@34277
|
200 |
val (x, y, z, w) =
|
wenzelm@38122
|
201 |
Task_Graph.fold (fn (_, ((_, job), (deps, _))) => fn (x, y, z, w) =>
|
wenzelm@32052
|
202 |
(case job of
|
wenzelm@38122
|
203 |
Job _ => if null deps then (x + 1, y, z, w) else (x, y + 1, z, w)
|
wenzelm@34277
|
204 |
| Running _ => (x, y, z + 1, w)
|
wenzelm@38122
|
205 |
| Passive _ => (x, y, z, w + 1)))
|
wenzelm@34277
|
206 |
jobs (0, 0, 0, 0);
|
wenzelm@34277
|
207 |
in {ready = x, pending = y, running = z, passive = w} end;
|
wenzelm@32052
|
208 |
|
wenzelm@32052
|
209 |
|
wenzelm@32121
|
210 |
(* cancel -- peers and sub-groups *)
|
wenzelm@32121
|
211 |
|
wenzelm@34280
|
212 |
fun cancel (Queue {groups, jobs}) group =
|
wenzelm@32121
|
213 |
let
|
wenzelm@32121
|
214 |
val _ = cancel_group group Exn.Interrupt;
|
wenzelm@32121
|
215 |
val tasks = Inttab.lookup_list groups (group_id group);
|
wenzelm@32121
|
216 |
val running =
|
wenzelm@32121
|
217 |
fold (get_job jobs #> (fn Running t => insert Thread.equal t | _ => I)) tasks [];
|
wenzelm@37216
|
218 |
val _ = List.app Simple_Thread.interrupt running;
|
wenzelm@34280
|
219 |
in null running end;
|
wenzelm@32121
|
220 |
|
wenzelm@38122
|
221 |
fun cancel_all (Queue {jobs, ...}) =
|
wenzelm@32121
|
222 |
let
|
wenzelm@32121
|
223 |
fun cancel_job (group, job) (groups, running) =
|
wenzelm@32121
|
224 |
(cancel_group group Exn.Interrupt;
|
wenzelm@34277
|
225 |
(case job of
|
wenzelm@34277
|
226 |
Running t => (insert eq_group group groups, insert Thread.equal t running)
|
wenzelm@32121
|
227 |
| _ => (groups, running)));
|
wenzelm@34277
|
228 |
val (running_groups, running) = Task_Graph.fold (cancel_job o #1 o #2) jobs ([], []);
|
wenzelm@37216
|
229 |
val _ = List.app Simple_Thread.interrupt running;
|
wenzelm@34280
|
230 |
in running_groups end;
|
wenzelm@32121
|
231 |
|
wenzelm@32121
|
232 |
|
wenzelm@28185
|
233 |
(* enqueue *)
|
wenzelm@28165
|
234 |
|
wenzelm@38122
|
235 |
fun enqueue_passive group abort (Queue {groups, jobs}) =
|
wenzelm@34277
|
236 |
let
|
wenzelm@42547
|
237 |
val task = new_task "passive" NONE;
|
wenzelm@34277
|
238 |
val groups' = groups
|
wenzelm@34277
|
239 |
|> fold (fn gid => Inttab.cons_list (gid, task)) (group_ancestry group);
|
wenzelm@38122
|
240 |
val jobs' = jobs |> Task_Graph.new_node (task, (group, Passive abort));
|
wenzelm@34280
|
241 |
in (task, make_queue groups' jobs') end;
|
wenzelm@34277
|
242 |
|
wenzelm@42544
|
243 |
fun enqueue name group deps pri job (Queue {groups, jobs}) =
|
wenzelm@28165
|
244 |
let
|
wenzelm@42544
|
245 |
val task = new_task name (SOME pri);
|
wenzelm@32121
|
246 |
val groups' = groups
|
wenzelm@32121
|
247 |
|> fold (fn gid => Inttab.cons_list (gid, task)) (group_ancestry group);
|
wenzelm@28185
|
248 |
val jobs' = jobs
|
wenzelm@32121
|
249 |
|> Task_Graph.new_node (task, (group, Job [job]))
|
wenzelm@32190
|
250 |
|> fold (add_job task) deps
|
wenzelm@32190
|
251 |
|> fold (fold (add_job task) o get_deps jobs) deps;
|
wenzelm@32218
|
252 |
val minimal = null (get_deps jobs' task);
|
wenzelm@34280
|
253 |
in ((task, minimal), make_queue groups' jobs') end;
|
wenzelm@28165
|
254 |
|
wenzelm@34280
|
255 |
fun extend task job (Queue {groups, jobs}) =
|
wenzelm@29369
|
256 |
(case try (get_job jobs) task of
|
wenzelm@34280
|
257 |
SOME (Job list) => SOME (make_queue groups (set_job task (Job (job :: list)) jobs))
|
wenzelm@29369
|
258 |
| _ => NONE);
|
wenzelm@29369
|
259 |
|
wenzelm@28185
|
260 |
|
wenzelm@28185
|
261 |
(* dequeue *)
|
wenzelm@28185
|
262 |
|
wenzelm@39520
|
263 |
fun dequeue_passive thread task (queue as Queue {groups, jobs}) =
|
wenzelm@39520
|
264 |
(case try (get_job jobs) task of
|
wenzelm@39520
|
265 |
SOME (Passive _) =>
|
wenzelm@39520
|
266 |
let val jobs' = set_job task (Running thread) jobs
|
wenzelm@39520
|
267 |
in (true, make_queue groups jobs') end
|
wenzelm@39520
|
268 |
| _ => (false, queue));
|
wenzelm@39520
|
269 |
|
wenzelm@34280
|
270 |
fun dequeue thread (queue as Queue {groups, jobs}) =
|
wenzelm@38122
|
271 |
(case Task_Graph.get_first (uncurry ready_job) jobs of
|
wenzelm@39520
|
272 |
SOME (result as (task, _, _)) =>
|
wenzelm@38122
|
273 |
let val jobs' = set_job task (Running thread) jobs
|
wenzelm@39520
|
274 |
in (SOME result, make_queue groups jobs') end
|
wenzelm@39520
|
275 |
| NONE => (NONE, queue));
|
wenzelm@28202
|
276 |
|
wenzelm@28176
|
277 |
|
wenzelm@32071
|
278 |
(* dequeue_towards -- adhoc dependencies *)
|
wenzelm@32071
|
279 |
|
wenzelm@34280
|
280 |
fun depend task deps (Queue {groups, jobs}) =
|
wenzelm@34280
|
281 |
make_queue groups (fold (add_dep task) deps jobs);
|
wenzelm@32823
|
282 |
|
wenzelm@34280
|
283 |
fun dequeue_towards thread deps (queue as Queue {groups, jobs}) =
|
wenzelm@32071
|
284 |
let
|
wenzelm@38122
|
285 |
fun ready task = ready_job task (Task_Graph.get_entry jobs task);
|
wenzelm@32071
|
286 |
val tasks = filter (can (Task_Graph.get_node jobs)) deps;
|
wenzelm@32192
|
287 |
fun result (res as (task, _, _)) =
|
wenzelm@34280
|
288 |
let val jobs' = set_job task (Running thread) jobs
|
wenzelm@34280
|
289 |
in ((SOME res, tasks), make_queue groups jobs') end;
|
wenzelm@32071
|
290 |
in
|
wenzelm@32113
|
291 |
(case get_first ready tasks of
|
wenzelm@32192
|
292 |
SOME res => result res
|
wenzelm@32192
|
293 |
| NONE =>
|
wenzelm@32254
|
294 |
(case get_first (get_first ready o get_deps jobs) tasks of
|
wenzelm@32192
|
295 |
SOME res => result res
|
wenzelm@32224
|
296 |
| NONE => ((NONE, tasks), queue)))
|
wenzelm@32071
|
297 |
end;
|
wenzelm@32071
|
298 |
|
wenzelm@32071
|
299 |
|
wenzelm@32221
|
300 |
(* finish *)
|
wenzelm@32221
|
301 |
|
wenzelm@34280
|
302 |
fun finish task (Queue {groups, jobs}) =
|
wenzelm@32221
|
303 |
let
|
wenzelm@32221
|
304 |
val group = get_group jobs task;
|
wenzelm@32221
|
305 |
val groups' = groups
|
wenzelm@35242
|
306 |
|> fold (fn gid => Inttab.remove_list eq_task (gid, task)) (group_ancestry group);
|
wenzelm@32221
|
307 |
val jobs' = Task_Graph.del_node task jobs;
|
wenzelm@32221
|
308 |
val maximal = null (Task_Graph.imm_succs jobs task);
|
wenzelm@34280
|
309 |
in (maximal, make_queue groups' jobs') end;
|
wenzelm@32221
|
310 |
|
wenzelm@28165
|
311 |
end;
|