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