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@29122
|
10 |
val new_task: int -> task
|
wenzelm@29122
|
11 |
val pri_of_task: task -> int
|
wenzelm@28196
|
12 |
val str_of_task: task -> string
|
wenzelm@29340
|
13 |
type group
|
wenzelm@32052
|
14 |
val group_id: group -> int
|
wenzelm@29340
|
15 |
val eq_group: group * group -> bool
|
wenzelm@28165
|
16 |
val new_group: unit -> group
|
wenzelm@29369
|
17 |
val is_valid: group -> bool
|
wenzelm@28551
|
18 |
val invalidate_group: group -> unit
|
wenzelm@28179
|
19 |
val str_of_group: group -> string
|
wenzelm@28165
|
20 |
type queue
|
wenzelm@28165
|
21 |
val empty: queue
|
wenzelm@28204
|
22 |
val is_empty: queue -> bool
|
wenzelm@32052
|
23 |
val status: queue -> {ready: int, pending: int, running: int}
|
wenzelm@29122
|
24 |
val enqueue: group -> task list -> int -> (bool -> bool) -> queue -> task * queue
|
wenzelm@29369
|
25 |
val extend: task -> (bool -> bool) -> queue -> queue option
|
wenzelm@29369
|
26 |
val dequeue: queue -> (task * group * (bool -> bool) list) option * queue
|
wenzelm@32071
|
27 |
val dequeue_towards: task list -> queue ->
|
wenzelm@32071
|
28 |
(((task * group * (bool -> bool) list) * task list) option * queue)
|
wenzelm@28190
|
29 |
val interrupt: queue -> task -> unit
|
wenzelm@28190
|
30 |
val interrupt_external: queue -> string -> unit
|
wenzelm@29340
|
31 |
val cancel: queue -> group -> bool
|
wenzelm@29340
|
32 |
val cancel_all: queue -> group list
|
wenzelm@28176
|
33 |
val finish: task -> queue -> queue
|
wenzelm@28165
|
34 |
end;
|
wenzelm@28165
|
35 |
|
wenzelm@29340
|
36 |
structure Task_Queue:> TASK_QUEUE =
|
wenzelm@28165
|
37 |
struct
|
wenzelm@28165
|
38 |
|
wenzelm@29122
|
39 |
(* tasks *)
|
wenzelm@28165
|
40 |
|
wenzelm@29122
|
41 |
datatype task = Task of int * serial;
|
wenzelm@29122
|
42 |
fun new_task pri = Task (pri, serial ());
|
wenzelm@29003
|
43 |
|
wenzelm@29122
|
44 |
fun pri_of_task (Task (pri, _)) = pri;
|
wenzelm@29122
|
45 |
fun str_of_task (Task (_, i)) = string_of_int i;
|
wenzelm@28165
|
46 |
|
wenzelm@29122
|
47 |
fun task_ord (Task t1, Task t2) = prod_ord (rev_order o int_ord) int_ord (t1, t2);
|
wenzelm@31972
|
48 |
structure Task_Graph = Graph(type key = task val ord = task_ord);
|
wenzelm@29122
|
49 |
|
wenzelm@29122
|
50 |
|
wenzelm@29122
|
51 |
(* groups *)
|
wenzelm@29003
|
52 |
|
wenzelm@28190
|
53 |
datatype group = Group of serial * bool ref;
|
wenzelm@32052
|
54 |
|
wenzelm@32052
|
55 |
fun group_id (Group (gid, _)) = gid;
|
wenzelm@29340
|
56 |
fun eq_group (Group (gid1, _), Group (gid2, _)) = gid1 = gid2;
|
wenzelm@28551
|
57 |
|
wenzelm@28190
|
58 |
fun new_group () = Group (serial (), ref true);
|
wenzelm@29122
|
59 |
|
wenzelm@29369
|
60 |
fun is_valid (Group (_, ref ok)) = ok;
|
wenzelm@28551
|
61 |
fun invalidate_group (Group (_, ok)) = ok := false;
|
wenzelm@28165
|
62 |
|
wenzelm@28190
|
63 |
fun str_of_group (Group (i, ref ok)) =
|
wenzelm@28190
|
64 |
if ok then string_of_int i else enclose "(" ")" (string_of_int i);
|
wenzelm@28179
|
65 |
|
wenzelm@28165
|
66 |
|
wenzelm@28176
|
67 |
(* jobs *)
|
wenzelm@28165
|
68 |
|
wenzelm@28165
|
69 |
datatype job =
|
wenzelm@29369
|
70 |
Job of (bool -> bool) list |
|
wenzelm@28165
|
71 |
Running of Thread.thread;
|
wenzelm@28165
|
72 |
|
wenzelm@29122
|
73 |
type jobs = (group * job) Task_Graph.T;
|
wenzelm@28176
|
74 |
|
wenzelm@29122
|
75 |
fun get_group (jobs: jobs) task = #1 (Task_Graph.get_node jobs task);
|
wenzelm@29122
|
76 |
fun get_job (jobs: jobs) task = #2 (Task_Graph.get_node jobs task);
|
wenzelm@29369
|
77 |
fun set_job task job (jobs: jobs) = Task_Graph.map_node task (fn (group, _) => (group, job)) jobs;
|
wenzelm@28202
|
78 |
|
wenzelm@29122
|
79 |
fun add_job task dep (jobs: jobs) =
|
wenzelm@29122
|
80 |
Task_Graph.add_edge (dep, task) jobs handle Task_Graph.UNDEF _ => jobs;
|
wenzelm@29117
|
81 |
|
wenzelm@28176
|
82 |
|
wenzelm@28176
|
83 |
(* queue of grouped jobs *)
|
wenzelm@28176
|
84 |
|
wenzelm@31617
|
85 |
datatype result = Unknown | Result of task | No_Result;
|
wenzelm@31617
|
86 |
|
wenzelm@28165
|
87 |
datatype queue = Queue of
|
wenzelm@28184
|
88 |
{groups: task list Inttab.table, (*groups with presently active members*)
|
wenzelm@31617
|
89 |
jobs: jobs, (*job dependency graph*)
|
wenzelm@31617
|
90 |
cache: result}; (*last dequeue result*)
|
wenzelm@28165
|
91 |
|
wenzelm@31617
|
92 |
fun make_queue groups jobs cache = Queue {groups = groups, jobs = jobs, cache = cache};
|
wenzelm@28204
|
93 |
|
wenzelm@31617
|
94 |
val empty = make_queue Inttab.empty Task_Graph.empty No_Result;
|
wenzelm@29122
|
95 |
fun is_empty (Queue {jobs, ...}) = Task_Graph.is_empty jobs;
|
wenzelm@28165
|
96 |
|
wenzelm@28165
|
97 |
|
wenzelm@32052
|
98 |
(* status *)
|
wenzelm@32052
|
99 |
|
wenzelm@32052
|
100 |
fun status (Queue {jobs, ...}) =
|
wenzelm@32052
|
101 |
let
|
wenzelm@32052
|
102 |
val (x, y, z) =
|
wenzelm@32052
|
103 |
Task_Graph.fold (fn (task, ((_, job), (deps, _))) => fn (x, y, z) =>
|
wenzelm@32052
|
104 |
(case job of
|
wenzelm@32052
|
105 |
Job _ => if null deps then (x + 1, y, z) else (x, y + 1, z)
|
wenzelm@32052
|
106 |
| Running _ => (x, y, z + 1)))
|
wenzelm@32052
|
107 |
jobs (0, 0, 0);
|
wenzelm@32052
|
108 |
in {ready = x, pending = y, running = z} end;
|
wenzelm@32052
|
109 |
|
wenzelm@32052
|
110 |
|
wenzelm@28185
|
111 |
(* enqueue *)
|
wenzelm@28165
|
112 |
|
wenzelm@31638
|
113 |
fun enqueue (group as Group (gid, _)) deps pri job (Queue {groups, jobs, cache}) =
|
wenzelm@28165
|
114 |
let
|
wenzelm@29122
|
115 |
val task = new_task pri;
|
wenzelm@28176
|
116 |
val groups' = Inttab.cons_list (gid, task) groups;
|
wenzelm@28185
|
117 |
val jobs' = jobs
|
wenzelm@29369
|
118 |
|> Task_Graph.new_node (task, (group, Job [job])) |> fold (add_job task) deps;
|
wenzelm@31638
|
119 |
val cache' =
|
wenzelm@31638
|
120 |
(case cache of
|
wenzelm@31638
|
121 |
Result last =>
|
wenzelm@31638
|
122 |
if task_ord (last, task) = LESS
|
wenzelm@31638
|
123 |
then cache else Unknown
|
wenzelm@31638
|
124 |
| _ => Unknown);
|
wenzelm@31638
|
125 |
in (task, make_queue groups' jobs' cache') end;
|
wenzelm@28165
|
126 |
|
wenzelm@31617
|
127 |
fun extend task job (Queue {groups, jobs, cache}) =
|
wenzelm@29369
|
128 |
(case try (get_job jobs) task of
|
wenzelm@31617
|
129 |
SOME (Job list) => SOME (make_queue groups (set_job task (Job (job :: list)) jobs) cache)
|
wenzelm@29369
|
130 |
| _ => NONE);
|
wenzelm@29369
|
131 |
|
wenzelm@28185
|
132 |
|
wenzelm@28185
|
133 |
(* dequeue *)
|
wenzelm@28185
|
134 |
|
wenzelm@31617
|
135 |
fun dequeue (queue as Queue {groups, jobs, cache}) =
|
wenzelm@29122
|
136 |
let
|
wenzelm@29369
|
137 |
fun ready (task, ((group, Job list), ([], _))) = SOME (task, group, rev list)
|
wenzelm@29122
|
138 |
| ready _ = NONE;
|
wenzelm@31617
|
139 |
fun deq boundary =
|
wenzelm@31617
|
140 |
(case Task_Graph.get_first boundary ready jobs of
|
wenzelm@31617
|
141 |
NONE => (NONE, make_queue groups jobs No_Result)
|
wenzelm@31617
|
142 |
| SOME (result as (task, _, _)) =>
|
wenzelm@31617
|
143 |
let
|
wenzelm@31617
|
144 |
val jobs' = set_job task (Running (Thread.self ())) jobs;
|
wenzelm@31617
|
145 |
val cache' = Result task;
|
wenzelm@31617
|
146 |
in (SOME result, make_queue groups jobs' cache') end);
|
wenzelm@29122
|
147 |
in
|
wenzelm@31617
|
148 |
(case cache of
|
wenzelm@31617
|
149 |
Unknown => deq NONE
|
wenzelm@31617
|
150 |
| Result last => deq (SOME last)
|
wenzelm@31617
|
151 |
| No_Result => (NONE, queue))
|
wenzelm@28384
|
152 |
end;
|
wenzelm@28202
|
153 |
|
wenzelm@28176
|
154 |
|
wenzelm@32071
|
155 |
(* dequeue_towards -- adhoc dependencies *)
|
wenzelm@32071
|
156 |
|
wenzelm@32071
|
157 |
fun dequeue_towards deps (queue as Queue {groups, jobs, ...}) =
|
wenzelm@32071
|
158 |
let
|
wenzelm@32071
|
159 |
fun ready task =
|
wenzelm@32071
|
160 |
(case Task_Graph.get_node jobs task of
|
wenzelm@32071
|
161 |
(group, Job list) =>
|
wenzelm@32071
|
162 |
if null (Task_Graph.imm_preds jobs task) then SOME (task, group, rev list)
|
wenzelm@32071
|
163 |
else NONE
|
wenzelm@32071
|
164 |
| _ => NONE);
|
wenzelm@32071
|
165 |
val tasks = filter (can (Task_Graph.get_node jobs)) deps;
|
wenzelm@32071
|
166 |
in
|
wenzelm@32071
|
167 |
(case get_first ready (Task_Graph.all_preds jobs tasks) of
|
wenzelm@32071
|
168 |
NONE => (NONE, queue)
|
wenzelm@32071
|
169 |
| SOME (result as (task, _, _)) =>
|
wenzelm@32071
|
170 |
let
|
wenzelm@32071
|
171 |
val jobs' = set_job task (Running (Thread.self ())) jobs;
|
wenzelm@32071
|
172 |
val cache' = Unknown;
|
wenzelm@32071
|
173 |
in (SOME (result, tasks), make_queue groups jobs' cache') end)
|
wenzelm@32071
|
174 |
end;
|
wenzelm@32071
|
175 |
|
wenzelm@32071
|
176 |
|
wenzelm@28190
|
177 |
(* sporadic interrupts *)
|
wenzelm@28190
|
178 |
|
wenzelm@28190
|
179 |
fun interrupt (Queue {jobs, ...}) task =
|
wenzelm@28551
|
180 |
(case try (get_job jobs) task of SOME (Running thread) => SimpleThread.interrupt thread | _ => ());
|
wenzelm@28190
|
181 |
|
wenzelm@29122
|
182 |
fun interrupt_external (queue as Queue {jobs, ...}) str =
|
wenzelm@29122
|
183 |
(case Int.fromString str of
|
wenzelm@29122
|
184 |
SOME i =>
|
wenzelm@31617
|
185 |
(case Task_Graph.get_first NONE
|
wenzelm@29122
|
186 |
(fn (task as Task (_, j), _) => if i = j then SOME task else NONE) jobs
|
wenzelm@29122
|
187 |
of SOME task => interrupt queue task | NONE => ())
|
wenzelm@29122
|
188 |
| NONE => ());
|
wenzelm@28190
|
189 |
|
wenzelm@28190
|
190 |
|
wenzelm@29340
|
191 |
(* termination *)
|
wenzelm@28176
|
192 |
|
wenzelm@28551
|
193 |
fun cancel (Queue {groups, jobs, ...}) (group as Group (gid, _)) =
|
wenzelm@28165
|
194 |
let
|
wenzelm@28551
|
195 |
val _ = invalidate_group group;
|
wenzelm@28176
|
196 |
val tasks = Inttab.lookup_list groups gid;
|
wenzelm@29342
|
197 |
val running = fold (get_job jobs #> (fn Running t => insert Thread.equal t | _ => I)) tasks [];
|
wenzelm@28551
|
198 |
val _ = List.app SimpleThread.interrupt running;
|
wenzelm@28190
|
199 |
in null running end;
|
wenzelm@28176
|
200 |
|
wenzelm@29340
|
201 |
fun cancel_all (Queue {jobs, ...}) =
|
wenzelm@29340
|
202 |
let
|
wenzelm@29340
|
203 |
fun cancel_job (group, job) (groups, running) =
|
wenzelm@29340
|
204 |
(invalidate_group group;
|
wenzelm@29342
|
205 |
(case job of Running t => (insert eq_group group groups, insert Thread.equal t running)
|
wenzelm@29340
|
206 |
| _ => (groups, running)));
|
wenzelm@29340
|
207 |
val (groups, running) = Task_Graph.fold (cancel_job o #1 o #2) jobs ([], []);
|
wenzelm@29340
|
208 |
val _ = List.app SimpleThread.interrupt running;
|
wenzelm@29340
|
209 |
in groups end;
|
wenzelm@29340
|
210 |
|
wenzelm@31638
|
211 |
fun finish task (Queue {groups, jobs, cache}) =
|
wenzelm@28176
|
212 |
let
|
wenzelm@28190
|
213 |
val Group (gid, _) = get_group jobs task;
|
wenzelm@28176
|
214 |
val groups' = Inttab.remove_list (op =) (gid, task) groups;
|
wenzelm@29122
|
215 |
val jobs' = Task_Graph.del_node task jobs;
|
wenzelm@31638
|
216 |
val cache' =
|
wenzelm@31638
|
217 |
if null (Task_Graph.imm_succs jobs task) then cache
|
wenzelm@31638
|
218 |
else Unknown;
|
wenzelm@31638
|
219 |
in make_queue groups' jobs' cache' end;
|
wenzelm@28165
|
220 |
|
wenzelm@28165
|
221 |
end;
|