]>
Commit | Line | Data |
---|---|---|
33e9e9bd KW |
1 | /* |
2 | * Background jobs (long-running operations) | |
3 | * | |
4 | * Copyright (c) 2011 IBM Corp. | |
5 | * Copyright (c) 2012, 2018 Red Hat, Inc. | |
6 | * | |
7 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
8 | * of this software and associated documentation files (the "Software"), to deal | |
9 | * in the Software without restriction, including without limitation the rights | |
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
11 | * copies of the Software, and to permit persons to whom the Software is | |
12 | * furnished to do so, subject to the following conditions: | |
13 | * | |
14 | * The above copyright notice and this permission notice shall be included in | |
15 | * all copies or substantial portions of the Software. | |
16 | * | |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
20 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
23 | * THE SOFTWARE. | |
24 | */ | |
25 | ||
26 | #include "qemu/osdep.h" | |
27 | #include "qemu-common.h" | |
28 | #include "qapi/error.h" | |
29 | #include "qemu/job.h" | |
30 | #include "qemu/id.h" | |
1908a559 | 31 | #include "qemu/main-loop.h" |
a50c2ab8 | 32 | #include "trace-root.h" |
33e9e9bd | 33 | |
e7c1d78b KW |
34 | static QLIST_HEAD(, Job) jobs = QLIST_HEAD_INITIALIZER(jobs); |
35 | ||
a50c2ab8 KW |
36 | /* Job State Transition Table */ |
37 | bool JobSTT[JOB_STATUS__MAX][JOB_STATUS__MAX] = { | |
38 | /* U, C, R, P, Y, S, W, D, X, E, N */ | |
39 | /* U: */ [JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0}, | |
40 | /* C: */ [JOB_STATUS_CREATED] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1}, | |
41 | /* R: */ [JOB_STATUS_RUNNING] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0}, | |
42 | /* P: */ [JOB_STATUS_PAUSED] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0}, | |
43 | /* Y: */ [JOB_STATUS_READY] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0}, | |
44 | /* S: */ [JOB_STATUS_STANDBY] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, | |
45 | /* W: */ [JOB_STATUS_WAITING] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0}, | |
46 | /* D: */ [JOB_STATUS_PENDING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, | |
47 | /* X: */ [JOB_STATUS_ABORTING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, | |
48 | /* E: */ [JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, | |
49 | /* N: */ [JOB_STATUS_NULL] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, | |
50 | }; | |
51 | ||
52 | bool JobVerbTable[JOB_VERB__MAX][JOB_STATUS__MAX] = { | |
53 | /* U, C, R, P, Y, S, W, D, X, E, N */ | |
54 | [JOB_VERB_CANCEL] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0}, | |
55 | [JOB_VERB_PAUSE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
56 | [JOB_VERB_RESUME] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
57 | [JOB_VERB_SET_SPEED] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
58 | [JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, | |
59 | [JOB_VERB_FINALIZE] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0}, | |
60 | [JOB_VERB_DISMISS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0}, | |
61 | }; | |
62 | ||
da01ff7f KW |
63 | /* Right now, this mutex is only needed to synchronize accesses to job->busy |
64 | * and job->sleep_timer, such as concurrent calls to job_do_yield and | |
65 | * job_enter. */ | |
66 | static QemuMutex job_mutex; | |
67 | ||
68 | static void job_lock(void) | |
69 | { | |
70 | qemu_mutex_lock(&job_mutex); | |
71 | } | |
72 | ||
73 | static void job_unlock(void) | |
74 | { | |
75 | qemu_mutex_unlock(&job_mutex); | |
76 | } | |
77 | ||
78 | static void __attribute__((__constructor__)) job_init(void) | |
79 | { | |
80 | qemu_mutex_init(&job_mutex); | |
81 | } | |
82 | ||
a50c2ab8 KW |
83 | /* TODO Make static once the whole state machine is in job.c */ |
84 | void job_state_transition(Job *job, JobStatus s1) | |
85 | { | |
86 | JobStatus s0 = job->status; | |
87 | assert(s1 >= 0 && s1 <= JOB_STATUS__MAX); | |
88 | trace_job_state_transition(job, /* TODO re-enable: job->ret */ 0, | |
89 | JobSTT[s0][s1] ? "allowed" : "disallowed", | |
90 | JobStatus_str(s0), JobStatus_str(s1)); | |
91 | assert(JobSTT[s0][s1]); | |
92 | job->status = s1; | |
93 | } | |
94 | ||
95 | int job_apply_verb(Job *job, JobVerb verb, Error **errp) | |
96 | { | |
97 | JobStatus s0 = job->status; | |
98 | assert(verb >= 0 && verb <= JOB_VERB__MAX); | |
99 | trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), | |
100 | JobVerbTable[verb][s0] ? "allowed" : "prohibited"); | |
101 | if (JobVerbTable[verb][s0]) { | |
102 | return 0; | |
103 | } | |
104 | error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", | |
105 | job->id, JobStatus_str(s0), JobVerb_str(verb)); | |
106 | return -EPERM; | |
107 | } | |
108 | ||
252291ea KW |
109 | JobType job_type(const Job *job) |
110 | { | |
111 | return job->driver->job_type; | |
112 | } | |
113 | ||
114 | const char *job_type_str(const Job *job) | |
115 | { | |
116 | return JobType_str(job_type(job)); | |
117 | } | |
118 | ||
daa7f2f9 KW |
119 | bool job_is_cancelled(Job *job) |
120 | { | |
121 | return job->cancelled; | |
122 | } | |
123 | ||
dbe5e6c1 KW |
124 | bool job_is_completed(Job *job) |
125 | { | |
126 | switch (job->status) { | |
127 | case JOB_STATUS_UNDEFINED: | |
128 | case JOB_STATUS_CREATED: | |
129 | case JOB_STATUS_RUNNING: | |
130 | case JOB_STATUS_PAUSED: | |
131 | case JOB_STATUS_READY: | |
132 | case JOB_STATUS_STANDBY: | |
133 | return false; | |
134 | case JOB_STATUS_WAITING: | |
135 | case JOB_STATUS_PENDING: | |
136 | case JOB_STATUS_ABORTING: | |
137 | case JOB_STATUS_CONCLUDED: | |
138 | case JOB_STATUS_NULL: | |
139 | return true; | |
140 | default: | |
141 | g_assert_not_reached(); | |
142 | } | |
143 | return false; | |
144 | } | |
145 | ||
da01ff7f KW |
146 | bool job_started(Job *job) |
147 | { | |
148 | return job->co; | |
149 | } | |
150 | ||
151 | bool job_should_pause(Job *job) | |
152 | { | |
153 | return job->pause_count > 0; | |
154 | } | |
155 | ||
e7c1d78b KW |
156 | Job *job_next(Job *job) |
157 | { | |
158 | if (!job) { | |
159 | return QLIST_FIRST(&jobs); | |
160 | } | |
161 | return QLIST_NEXT(job, job_list); | |
162 | } | |
163 | ||
164 | Job *job_get(const char *id) | |
165 | { | |
166 | Job *job; | |
167 | ||
168 | QLIST_FOREACH(job, &jobs, job_list) { | |
169 | if (job->id && !strcmp(id, job->id)) { | |
170 | return job; | |
171 | } | |
172 | } | |
173 | ||
174 | return NULL; | |
175 | } | |
176 | ||
5d43e86e KW |
177 | static void job_sleep_timer_cb(void *opaque) |
178 | { | |
179 | Job *job = opaque; | |
180 | ||
181 | job_enter(job); | |
182 | } | |
183 | ||
08be6fe2 | 184 | void *job_create(const char *job_id, const JobDriver *driver, AioContext *ctx, |
bb02b65c | 185 | int flags, Error **errp) |
33e9e9bd KW |
186 | { |
187 | Job *job; | |
188 | ||
189 | if (job_id) { | |
bb02b65c KW |
190 | if (flags & JOB_INTERNAL) { |
191 | error_setg(errp, "Cannot specify job ID for internal job"); | |
192 | return NULL; | |
193 | } | |
33e9e9bd KW |
194 | if (!id_wellformed(job_id)) { |
195 | error_setg(errp, "Invalid job ID '%s'", job_id); | |
196 | return NULL; | |
197 | } | |
e7c1d78b KW |
198 | if (job_get(job_id)) { |
199 | error_setg(errp, "Job ID '%s' already in use", job_id); | |
200 | return NULL; | |
201 | } | |
bb02b65c KW |
202 | } else if (!(flags & JOB_INTERNAL)) { |
203 | error_setg(errp, "An explicit job ID is required"); | |
204 | return NULL; | |
33e9e9bd KW |
205 | } |
206 | ||
207 | job = g_malloc0(driver->instance_size); | |
208 | job->driver = driver; | |
209 | job->id = g_strdup(job_id); | |
80fa2c75 | 210 | job->refcnt = 1; |
08be6fe2 | 211 | job->aio_context = ctx; |
da01ff7f KW |
212 | job->busy = false; |
213 | job->paused = true; | |
214 | job->pause_count = 1; | |
bb02b65c KW |
215 | job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); |
216 | job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); | |
33e9e9bd | 217 | |
139a9f02 KW |
218 | notifier_list_init(&job->on_finalize_cancelled); |
219 | notifier_list_init(&job->on_finalize_completed); | |
220 | notifier_list_init(&job->on_pending); | |
221 | ||
a50c2ab8 | 222 | job_state_transition(job, JOB_STATUS_CREATED); |
5d43e86e KW |
223 | aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, |
224 | QEMU_CLOCK_REALTIME, SCALE_NS, | |
225 | job_sleep_timer_cb, job); | |
a50c2ab8 | 226 | |
e7c1d78b KW |
227 | QLIST_INSERT_HEAD(&jobs, job, job_list); |
228 | ||
33e9e9bd KW |
229 | return job; |
230 | } | |
fd61a701 | 231 | |
80fa2c75 | 232 | void job_ref(Job *job) |
fd61a701 | 233 | { |
80fa2c75 KW |
234 | ++job->refcnt; |
235 | } | |
236 | ||
237 | void job_unref(Job *job) | |
238 | { | |
239 | if (--job->refcnt == 0) { | |
240 | assert(job->status == JOB_STATUS_NULL); | |
5d43e86e | 241 | assert(!timer_pending(&job->sleep_timer)); |
e7c1d78b | 242 | |
80fa2c75 KW |
243 | if (job->driver->free) { |
244 | job->driver->free(job); | |
245 | } | |
246 | ||
247 | QLIST_REMOVE(job, job_list); | |
248 | ||
249 | g_free(job->id); | |
250 | g_free(job); | |
251 | } | |
fd61a701 | 252 | } |
1908a559 | 253 | |
139a9f02 KW |
254 | void job_event_cancelled(Job *job) |
255 | { | |
256 | notifier_list_notify(&job->on_finalize_cancelled, job); | |
257 | } | |
258 | ||
259 | void job_event_completed(Job *job) | |
260 | { | |
261 | notifier_list_notify(&job->on_finalize_completed, job); | |
262 | } | |
263 | ||
264 | void job_event_pending(Job *job) | |
265 | { | |
266 | notifier_list_notify(&job->on_pending, job); | |
267 | } | |
268 | ||
da01ff7f KW |
269 | void job_enter_cond(Job *job, bool(*fn)(Job *job)) |
270 | { | |
271 | if (!job_started(job)) { | |
272 | return; | |
273 | } | |
274 | if (job->deferred_to_main_loop) { | |
275 | return; | |
276 | } | |
277 | ||
278 | job_lock(); | |
279 | if (job->busy) { | |
280 | job_unlock(); | |
281 | return; | |
282 | } | |
283 | ||
284 | if (fn && !fn(job)) { | |
285 | job_unlock(); | |
286 | return; | |
287 | } | |
288 | ||
289 | assert(!job->deferred_to_main_loop); | |
290 | timer_del(&job->sleep_timer); | |
291 | job->busy = true; | |
292 | job_unlock(); | |
293 | aio_co_wake(job->co); | |
294 | } | |
295 | ||
5d43e86e KW |
296 | void job_enter(Job *job) |
297 | { | |
298 | job_enter_cond(job, NULL); | |
299 | } | |
300 | ||
da01ff7f KW |
301 | /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. |
302 | * Reentering the job coroutine with block_job_enter() before the timer has | |
303 | * expired is allowed and cancels the timer. | |
304 | * | |
305 | * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be | |
306 | * called explicitly. */ | |
307 | void coroutine_fn job_do_yield(Job *job, uint64_t ns) | |
308 | { | |
309 | job_lock(); | |
310 | if (ns != -1) { | |
311 | timer_mod(&job->sleep_timer, ns); | |
312 | } | |
313 | job->busy = false; | |
314 | job_unlock(); | |
315 | qemu_coroutine_yield(); | |
316 | ||
317 | /* Set by job_enter_cond() before re-entering the coroutine. */ | |
318 | assert(job->busy); | |
319 | } | |
320 | ||
321 | void coroutine_fn job_pause_point(Job *job) | |
322 | { | |
323 | assert(job && job_started(job)); | |
324 | ||
325 | if (!job_should_pause(job)) { | |
326 | return; | |
327 | } | |
328 | if (job_is_cancelled(job)) { | |
329 | return; | |
330 | } | |
331 | ||
332 | if (job->driver->pause) { | |
333 | job->driver->pause(job); | |
334 | } | |
335 | ||
336 | if (job_should_pause(job) && !job_is_cancelled(job)) { | |
337 | JobStatus status = job->status; | |
338 | job_state_transition(job, status == JOB_STATUS_READY | |
339 | ? JOB_STATUS_STANDBY | |
340 | : JOB_STATUS_PAUSED); | |
341 | job->paused = true; | |
342 | job_do_yield(job, -1); | |
343 | job->paused = false; | |
344 | job_state_transition(job, status); | |
345 | } | |
346 | ||
347 | if (job->driver->resume) { | |
348 | job->driver->resume(job); | |
349 | } | |
350 | } | |
351 | ||
5d43e86e KW |
352 | void coroutine_fn job_sleep_ns(Job *job, int64_t ns) |
353 | { | |
354 | assert(job->busy); | |
355 | ||
356 | /* Check cancellation *before* setting busy = false, too! */ | |
357 | if (job_is_cancelled(job)) { | |
358 | return; | |
359 | } | |
360 | ||
361 | if (!job_should_pause(job)) { | |
362 | job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); | |
363 | } | |
364 | ||
365 | job_pause_point(job); | |
366 | } | |
367 | ||
da01ff7f KW |
368 | /** |
369 | * All jobs must allow a pause point before entering their job proper. This | |
370 | * ensures that jobs can be paused prior to being started, then resumed later. | |
371 | */ | |
372 | static void coroutine_fn job_co_entry(void *opaque) | |
373 | { | |
374 | Job *job = opaque; | |
375 | ||
376 | assert(job && job->driver && job->driver->start); | |
377 | job_pause_point(job); | |
378 | job->driver->start(job); | |
379 | } | |
380 | ||
381 | ||
382 | void job_start(Job *job) | |
383 | { | |
384 | assert(job && !job_started(job) && job->paused && | |
385 | job->driver && job->driver->start); | |
386 | job->co = qemu_coroutine_create(job_co_entry, job); | |
387 | job->pause_count--; | |
388 | job->busy = true; | |
389 | job->paused = false; | |
390 | job_state_transition(job, JOB_STATUS_RUNNING); | |
391 | aio_co_enter(job->aio_context, job->co); | |
392 | } | |
393 | ||
b15de828 KW |
394 | /* Assumes the block_job_mutex is held */ |
395 | static bool job_timer_not_pending(Job *job) | |
396 | { | |
397 | return !timer_pending(&job->sleep_timer); | |
398 | } | |
399 | ||
400 | void job_pause(Job *job) | |
401 | { | |
402 | job->pause_count++; | |
403 | } | |
404 | ||
405 | void job_resume(Job *job) | |
406 | { | |
407 | assert(job->pause_count > 0); | |
408 | job->pause_count--; | |
409 | if (job->pause_count) { | |
410 | return; | |
411 | } | |
412 | ||
413 | /* kick only if no timer is pending */ | |
414 | job_enter_cond(job, job_timer_not_pending); | |
415 | } | |
416 | ||
417 | void job_user_pause(Job *job, Error **errp) | |
418 | { | |
419 | if (job_apply_verb(job, JOB_VERB_PAUSE, errp)) { | |
420 | return; | |
421 | } | |
422 | if (job->user_paused) { | |
423 | error_setg(errp, "Job is already paused"); | |
424 | return; | |
425 | } | |
426 | job->user_paused = true; | |
427 | job_pause(job); | |
428 | } | |
429 | ||
430 | bool job_user_paused(Job *job) | |
431 | { | |
432 | return job->user_paused; | |
433 | } | |
434 | ||
435 | void job_user_resume(Job *job, Error **errp) | |
436 | { | |
437 | assert(job); | |
438 | if (!job->user_paused || job->pause_count <= 0) { | |
439 | error_setg(errp, "Can't resume a job that was not paused"); | |
440 | return; | |
441 | } | |
442 | if (job_apply_verb(job, JOB_VERB_RESUME, errp)) { | |
443 | return; | |
444 | } | |
445 | if (job->driver->user_resume) { | |
446 | job->driver->user_resume(job); | |
447 | } | |
448 | job->user_paused = false; | |
449 | job_resume(job); | |
450 | } | |
451 | ||
452 | ||
1908a559 KW |
453 | typedef struct { |
454 | Job *job; | |
455 | JobDeferToMainLoopFn *fn; | |
456 | void *opaque; | |
457 | } JobDeferToMainLoopData; | |
458 | ||
459 | static void job_defer_to_main_loop_bh(void *opaque) | |
460 | { | |
461 | JobDeferToMainLoopData *data = opaque; | |
462 | Job *job = data->job; | |
463 | AioContext *aio_context = job->aio_context; | |
464 | ||
465 | aio_context_acquire(aio_context); | |
466 | data->fn(data->job, data->opaque); | |
467 | aio_context_release(aio_context); | |
468 | ||
469 | g_free(data); | |
470 | } | |
471 | ||
472 | void job_defer_to_main_loop(Job *job, JobDeferToMainLoopFn *fn, void *opaque) | |
473 | { | |
474 | JobDeferToMainLoopData *data = g_malloc(sizeof(*data)); | |
475 | data->job = job; | |
476 | data->fn = fn; | |
477 | data->opaque = opaque; | |
478 | job->deferred_to_main_loop = true; | |
479 | ||
480 | aio_bh_schedule_oneshot(qemu_get_aio_context(), | |
481 | job_defer_to_main_loop_bh, data); | |
482 | } |