]>
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" | |
33e9e9bd KW |
27 | #include "qapi/error.h" |
28 | #include "qemu/job.h" | |
29 | #include "qemu/id.h" | |
1908a559 | 30 | #include "qemu/main-loop.h" |
de0fbe64 | 31 | #include "block/aio-wait.h" |
243af022 | 32 | #include "trace/trace-root.h" |
1dac83f1 | 33 | #include "qapi/qapi-events-job.h" |
33e9e9bd | 34 | |
bf61c583 EGE |
35 | /* |
36 | * The job API is composed of two categories of functions. | |
37 | * | |
38 | * The first includes functions used by the monitor. The monitor is | |
39 | * peculiar in that it accesses the job list with job_get, and | |
40 | * therefore needs consistency across job_get and the actual operation | |
41 | * (e.g. job_user_cancel). To achieve this consistency, the caller | |
42 | * calls job_lock/job_unlock itself around the whole operation. | |
43 | * | |
44 | * | |
45 | * The second includes functions used by the job drivers and sometimes | |
46 | * by the core block layer. These delegate the locking to the callee instead. | |
bf61c583 EGE |
47 | */ |
48 | ||
55c5a25a EGE |
49 | /* |
50 | * job_mutex protects the jobs list, but also makes the | |
51 | * struct job fields thread-safe. | |
52 | */ | |
53 | QemuMutex job_mutex; | |
54 | ||
afe1e8a7 | 55 | /* Protected by job_mutex */ |
e7c1d78b KW |
56 | static QLIST_HEAD(, Job) jobs = QLIST_HEAD_INITIALIZER(jobs); |
57 | ||
a50c2ab8 KW |
58 | /* Job State Transition Table */ |
59 | bool JobSTT[JOB_STATUS__MAX][JOB_STATUS__MAX] = { | |
60 | /* U, C, R, P, Y, S, W, D, X, E, N */ | |
61 | /* U: */ [JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0}, | |
62 | /* C: */ [JOB_STATUS_CREATED] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1}, | |
63 | /* R: */ [JOB_STATUS_RUNNING] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0}, | |
64 | /* P: */ [JOB_STATUS_PAUSED] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0}, | |
65 | /* Y: */ [JOB_STATUS_READY] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0}, | |
66 | /* S: */ [JOB_STATUS_STANDBY] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, | |
67 | /* W: */ [JOB_STATUS_WAITING] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0}, | |
68 | /* D: */ [JOB_STATUS_PENDING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, | |
69 | /* X: */ [JOB_STATUS_ABORTING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, | |
70 | /* E: */ [JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, | |
71 | /* N: */ [JOB_STATUS_NULL] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, | |
72 | }; | |
73 | ||
74 | bool JobVerbTable[JOB_VERB__MAX][JOB_STATUS__MAX] = { | |
75 | /* U, C, R, P, Y, S, W, D, X, E, N */ | |
76 | [JOB_VERB_CANCEL] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0}, | |
77 | [JOB_VERB_PAUSE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
78 | [JOB_VERB_RESUME] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
79 | [JOB_VERB_SET_SPEED] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
53ddb9c8 | 80 | [JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 1, 0, 0, 0, 0, 0}, |
a50c2ab8 KW |
81 | [JOB_VERB_FINALIZE] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0}, |
82 | [JOB_VERB_DISMISS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0}, | |
61a3a5a7 | 83 | [JOB_VERB_CHANGE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, |
a50c2ab8 KW |
84 | }; |
85 | ||
7eaa8fb5 KW |
86 | /* Transactional group of jobs */ |
87 | struct JobTxn { | |
88 | ||
89 | /* Is this txn being cancelled? */ | |
90 | bool aborting; | |
91 | ||
92 | /* List of jobs */ | |
93 | QLIST_HEAD(, Job) jobs; | |
94 | ||
95 | /* Reference count */ | |
96 | int refcnt; | |
97 | }; | |
98 | ||
55c5a25a | 99 | void job_lock(void) |
da01ff7f KW |
100 | { |
101 | qemu_mutex_lock(&job_mutex); | |
102 | } | |
103 | ||
6f592e5a | 104 | void job_unlock(void) |
da01ff7f KW |
105 | { |
106 | qemu_mutex_unlock(&job_mutex); | |
107 | } | |
108 | ||
109 | static void __attribute__((__constructor__)) job_init(void) | |
110 | { | |
111 | qemu_mutex_init(&job_mutex); | |
112 | } | |
113 | ||
7eaa8fb5 KW |
114 | JobTxn *job_txn_new(void) |
115 | { | |
116 | JobTxn *txn = g_new0(JobTxn, 1); | |
117 | QLIST_INIT(&txn->jobs); | |
118 | txn->refcnt = 1; | |
119 | return txn; | |
120 | } | |
121 | ||
afe1e8a7 EGE |
122 | /* Called with job_mutex held. */ |
123 | static void job_txn_ref_locked(JobTxn *txn) | |
7eaa8fb5 KW |
124 | { |
125 | txn->refcnt++; | |
126 | } | |
127 | ||
afe1e8a7 | 128 | void job_txn_unref_locked(JobTxn *txn) |
7eaa8fb5 KW |
129 | { |
130 | if (txn && --txn->refcnt == 0) { | |
131 | g_free(txn); | |
132 | } | |
133 | } | |
134 | ||
afe1e8a7 EGE |
135 | void job_txn_unref(JobTxn *txn) |
136 | { | |
137 | JOB_LOCK_GUARD(); | |
138 | job_txn_unref_locked(txn); | |
139 | } | |
140 | ||
544f4d52 EGE |
141 | /** |
142 | * @txn: The transaction (may be NULL) | |
143 | * @job: Job to add to the transaction | |
144 | * | |
145 | * Add @job to the transaction. The @job must not already be in a transaction. | |
146 | * The caller must call either job_txn_unref() or job_completed() to release | |
147 | * the reference that is automatically grabbed here. | |
148 | * | |
149 | * If @txn is NULL, the function does nothing. | |
afe1e8a7 EGE |
150 | * |
151 | * Called with job_mutex held. | |
544f4d52 | 152 | */ |
afe1e8a7 | 153 | static void job_txn_add_job_locked(JobTxn *txn, Job *job) |
7eaa8fb5 KW |
154 | { |
155 | if (!txn) { | |
156 | return; | |
157 | } | |
158 | ||
159 | assert(!job->txn); | |
160 | job->txn = txn; | |
161 | ||
162 | QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); | |
afe1e8a7 | 163 | job_txn_ref_locked(txn); |
7eaa8fb5 KW |
164 | } |
165 | ||
afe1e8a7 EGE |
166 | /* Called with job_mutex held. */ |
167 | static void job_txn_del_job_locked(Job *job) | |
7eaa8fb5 KW |
168 | { |
169 | if (job->txn) { | |
170 | QLIST_REMOVE(job, txn_list); | |
afe1e8a7 | 171 | job_txn_unref_locked(job->txn); |
7eaa8fb5 KW |
172 | job->txn = NULL; |
173 | } | |
174 | } | |
175 | ||
afe1e8a7 EGE |
176 | /* Called with job_mutex held, but releases it temporarily. */ |
177 | static int job_txn_apply_locked(Job *job, int fn(Job *)) | |
7eaa8fb5 | 178 | { |
b660a84b SR |
179 | Job *other_job, *next; |
180 | JobTxn *txn = job->txn; | |
7eaa8fb5 KW |
181 | int rc = 0; |
182 | ||
b660a84b SR |
183 | /* |
184 | * Similar to job_completed_txn_abort, we take each job's lock before | |
185 | * applying fn, but since we assume that outer_ctx is held by the caller, | |
186 | * we need to release it here to avoid holding the lock twice - which would | |
187 | * break AIO_WAIT_WHILE from within fn. | |
188 | */ | |
afe1e8a7 | 189 | job_ref_locked(job); |
b660a84b SR |
190 | |
191 | QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { | |
b660a84b | 192 | rc = fn(other_job); |
7eaa8fb5 KW |
193 | if (rc) { |
194 | break; | |
195 | } | |
196 | } | |
b660a84b | 197 | |
afe1e8a7 | 198 | job_unref_locked(job); |
7eaa8fb5 KW |
199 | return rc; |
200 | } | |
201 | ||
456273b0 | 202 | bool job_is_internal(Job *job) |
1dac83f1 KW |
203 | { |
204 | return (job->id == NULL); | |
205 | } | |
206 | ||
afe1e8a7 EGE |
207 | /* Called with job_mutex held. */ |
208 | static void job_state_transition_locked(Job *job, JobStatus s1) | |
a50c2ab8 KW |
209 | { |
210 | JobStatus s0 = job->status; | |
c2032289 | 211 | assert(s1 >= 0 && s1 < JOB_STATUS__MAX); |
4ad35181 | 212 | trace_job_state_transition(job, job->ret, |
a50c2ab8 KW |
213 | JobSTT[s0][s1] ? "allowed" : "disallowed", |
214 | JobStatus_str(s0), JobStatus_str(s1)); | |
215 | assert(JobSTT[s0][s1]); | |
216 | job->status = s1; | |
1dac83f1 KW |
217 | |
218 | if (!job_is_internal(job) && s1 != s0) { | |
3ab72385 | 219 | qapi_event_send_job_status_change(job->id, job->status); |
1dac83f1 | 220 | } |
a50c2ab8 KW |
221 | } |
222 | ||
afe1e8a7 | 223 | int job_apply_verb_locked(Job *job, JobVerb verb, Error **errp) |
a50c2ab8 KW |
224 | { |
225 | JobStatus s0 = job->status; | |
c2032289 | 226 | assert(verb >= 0 && verb < JOB_VERB__MAX); |
a50c2ab8 KW |
227 | trace_job_apply_verb(job, JobStatus_str(s0), JobVerb_str(verb), |
228 | JobVerbTable[verb][s0] ? "allowed" : "prohibited"); | |
229 | if (JobVerbTable[verb][s0]) { | |
230 | return 0; | |
231 | } | |
232 | error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", | |
233 | job->id, JobStatus_str(s0), JobVerb_str(verb)); | |
234 | return -EPERM; | |
235 | } | |
236 | ||
252291ea KW |
237 | JobType job_type(const Job *job) |
238 | { | |
239 | return job->driver->job_type; | |
240 | } | |
241 | ||
242 | const char *job_type_str(const Job *job) | |
243 | { | |
244 | return JobType_str(job_type(job)); | |
245 | } | |
246 | ||
afe1e8a7 | 247 | bool job_is_cancelled_locked(Job *job) |
08b83bff | 248 | { |
a640fa0e HR |
249 | /* force_cancel may be true only if cancelled is true, too */ |
250 | assert(job->cancelled || !job->force_cancel); | |
251 | return job->force_cancel; | |
08b83bff HR |
252 | } |
253 | ||
afe1e8a7 EGE |
254 | bool job_is_cancelled(Job *job) |
255 | { | |
256 | JOB_LOCK_GUARD(); | |
257 | return job_is_cancelled_locked(job); | |
258 | } | |
259 | ||
260 | /* Called with job_mutex held. */ | |
261 | static bool job_cancel_requested_locked(Job *job) | |
daa7f2f9 KW |
262 | { |
263 | return job->cancelled; | |
264 | } | |
265 | ||
afe1e8a7 EGE |
266 | bool job_cancel_requested(Job *job) |
267 | { | |
268 | JOB_LOCK_GUARD(); | |
269 | return job_cancel_requested_locked(job); | |
270 | } | |
271 | ||
272 | bool job_is_ready_locked(Job *job) | |
df956ae2 KW |
273 | { |
274 | switch (job->status) { | |
275 | case JOB_STATUS_UNDEFINED: | |
276 | case JOB_STATUS_CREATED: | |
277 | case JOB_STATUS_RUNNING: | |
278 | case JOB_STATUS_PAUSED: | |
279 | case JOB_STATUS_WAITING: | |
280 | case JOB_STATUS_PENDING: | |
281 | case JOB_STATUS_ABORTING: | |
282 | case JOB_STATUS_CONCLUDED: | |
283 | case JOB_STATUS_NULL: | |
284 | return false; | |
285 | case JOB_STATUS_READY: | |
286 | case JOB_STATUS_STANDBY: | |
287 | return true; | |
288 | default: | |
289 | g_assert_not_reached(); | |
290 | } | |
291 | return false; | |
292 | } | |
293 | ||
afe1e8a7 EGE |
294 | bool job_is_ready(Job *job) |
295 | { | |
296 | JOB_LOCK_GUARD(); | |
297 | return job_is_ready_locked(job); | |
298 | } | |
299 | ||
300 | bool job_is_completed_locked(Job *job) | |
dbe5e6c1 KW |
301 | { |
302 | switch (job->status) { | |
303 | case JOB_STATUS_UNDEFINED: | |
304 | case JOB_STATUS_CREATED: | |
305 | case JOB_STATUS_RUNNING: | |
306 | case JOB_STATUS_PAUSED: | |
307 | case JOB_STATUS_READY: | |
308 | case JOB_STATUS_STANDBY: | |
309 | return false; | |
310 | case JOB_STATUS_WAITING: | |
311 | case JOB_STATUS_PENDING: | |
312 | case JOB_STATUS_ABORTING: | |
313 | case JOB_STATUS_CONCLUDED: | |
314 | case JOB_STATUS_NULL: | |
315 | return true; | |
316 | default: | |
317 | g_assert_not_reached(); | |
318 | } | |
319 | return false; | |
320 | } | |
321 | ||
9bd4d3c2 | 322 | static bool job_is_completed(Job *job) |
afe1e8a7 EGE |
323 | { |
324 | JOB_LOCK_GUARD(); | |
325 | return job_is_completed_locked(job); | |
326 | } | |
327 | ||
328 | static bool job_started_locked(Job *job) | |
da01ff7f KW |
329 | { |
330 | return job->co; | |
331 | } | |
332 | ||
afe1e8a7 EGE |
333 | /* Called with job_mutex held. */ |
334 | static bool job_should_pause_locked(Job *job) | |
da01ff7f KW |
335 | { |
336 | return job->pause_count > 0; | |
337 | } | |
338 | ||
afe1e8a7 | 339 | Job *job_next_locked(Job *job) |
e7c1d78b KW |
340 | { |
341 | if (!job) { | |
342 | return QLIST_FIRST(&jobs); | |
343 | } | |
344 | return QLIST_NEXT(job, job_list); | |
345 | } | |
346 | ||
afe1e8a7 EGE |
347 | Job *job_next(Job *job) |
348 | { | |
349 | JOB_LOCK_GUARD(); | |
350 | return job_next_locked(job); | |
351 | } | |
352 | ||
353 | Job *job_get_locked(const char *id) | |
e7c1d78b KW |
354 | { |
355 | Job *job; | |
356 | ||
357 | QLIST_FOREACH(job, &jobs, job_list) { | |
358 | if (job->id && !strcmp(id, job->id)) { | |
359 | return job; | |
360 | } | |
361 | } | |
362 | ||
363 | return NULL; | |
364 | } | |
365 | ||
3ed4f708 EGE |
366 | void job_set_aio_context(Job *job, AioContext *ctx) |
367 | { | |
368 | /* protect against read in job_finish_sync_locked and job_start */ | |
369 | GLOBAL_STATE_CODE(); | |
370 | /* protect against read in job_do_yield_locked */ | |
371 | JOB_LOCK_GUARD(); | |
372 | /* ensure the job is quiescent while the AioContext is changed */ | |
373 | assert(job->paused || job_is_completed_locked(job)); | |
374 | job->aio_context = ctx; | |
375 | } | |
376 | ||
afe1e8a7 | 377 | /* Called with job_mutex *not* held. */ |
5d43e86e KW |
378 | static void job_sleep_timer_cb(void *opaque) |
379 | { | |
380 | Job *job = opaque; | |
381 | ||
382 | job_enter(job); | |
383 | } | |
384 | ||
7eaa8fb5 KW |
385 | void *job_create(const char *job_id, const JobDriver *driver, JobTxn *txn, |
386 | AioContext *ctx, int flags, BlockCompletionFunc *cb, | |
387 | void *opaque, Error **errp) | |
33e9e9bd KW |
388 | { |
389 | Job *job; | |
390 | ||
afe1e8a7 EGE |
391 | JOB_LOCK_GUARD(); |
392 | ||
33e9e9bd | 393 | if (job_id) { |
bb02b65c KW |
394 | if (flags & JOB_INTERNAL) { |
395 | error_setg(errp, "Cannot specify job ID for internal job"); | |
396 | return NULL; | |
397 | } | |
33e9e9bd KW |
398 | if (!id_wellformed(job_id)) { |
399 | error_setg(errp, "Invalid job ID '%s'", job_id); | |
400 | return NULL; | |
401 | } | |
afe1e8a7 | 402 | if (job_get_locked(job_id)) { |
e7c1d78b KW |
403 | error_setg(errp, "Job ID '%s' already in use", job_id); |
404 | return NULL; | |
405 | } | |
bb02b65c KW |
406 | } else if (!(flags & JOB_INTERNAL)) { |
407 | error_setg(errp, "An explicit job ID is required"); | |
408 | return NULL; | |
33e9e9bd KW |
409 | } |
410 | ||
411 | job = g_malloc0(driver->instance_size); | |
412 | job->driver = driver; | |
413 | job->id = g_strdup(job_id); | |
80fa2c75 | 414 | job->refcnt = 1; |
08be6fe2 | 415 | job->aio_context = ctx; |
da01ff7f KW |
416 | job->busy = false; |
417 | job->paused = true; | |
418 | job->pause_count = 1; | |
bb02b65c KW |
419 | job->auto_finalize = !(flags & JOB_MANUAL_FINALIZE); |
420 | job->auto_dismiss = !(flags & JOB_MANUAL_DISMISS); | |
4ad35181 KW |
421 | job->cb = cb; |
422 | job->opaque = opaque; | |
33e9e9bd | 423 | |
a7b4f8fc EGE |
424 | progress_init(&job->progress); |
425 | ||
139a9f02 KW |
426 | notifier_list_init(&job->on_finalize_cancelled); |
427 | notifier_list_init(&job->on_finalize_completed); | |
428 | notifier_list_init(&job->on_pending); | |
2e1795b5 | 429 | notifier_list_init(&job->on_ready); |
252f4091 | 430 | notifier_list_init(&job->on_idle); |
139a9f02 | 431 | |
afe1e8a7 | 432 | job_state_transition_locked(job, JOB_STATUS_CREATED); |
5d43e86e KW |
433 | aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, |
434 | QEMU_CLOCK_REALTIME, SCALE_NS, | |
435 | job_sleep_timer_cb, job); | |
a50c2ab8 | 436 | |
e7c1d78b KW |
437 | QLIST_INSERT_HEAD(&jobs, job, job_list); |
438 | ||
7eaa8fb5 KW |
439 | /* Single jobs are modeled as single-job transactions for sake of |
440 | * consolidating the job management logic */ | |
441 | if (!txn) { | |
442 | txn = job_txn_new(); | |
afe1e8a7 EGE |
443 | job_txn_add_job_locked(txn, job); |
444 | job_txn_unref_locked(txn); | |
7eaa8fb5 | 445 | } else { |
afe1e8a7 | 446 | job_txn_add_job_locked(txn, job); |
7eaa8fb5 KW |
447 | } |
448 | ||
33e9e9bd KW |
449 | return job; |
450 | } | |
fd61a701 | 451 | |
afe1e8a7 | 452 | void job_ref_locked(Job *job) |
fd61a701 | 453 | { |
80fa2c75 KW |
454 | ++job->refcnt; |
455 | } | |
456 | ||
afe1e8a7 | 457 | void job_unref_locked(Job *job) |
80fa2c75 | 458 | { |
c70b8031 EGE |
459 | GLOBAL_STATE_CODE(); |
460 | ||
80fa2c75 KW |
461 | if (--job->refcnt == 0) { |
462 | assert(job->status == JOB_STATUS_NULL); | |
5d43e86e | 463 | assert(!timer_pending(&job->sleep_timer)); |
7eaa8fb5 | 464 | assert(!job->txn); |
e7c1d78b | 465 | |
80fa2c75 | 466 | if (job->driver->free) { |
6f592e5a | 467 | AioContext *aio_context = job->aio_context; |
afe1e8a7 | 468 | job_unlock(); |
6f592e5a EGE |
469 | /* FIXME: aiocontext lock is required because cb calls blk_unref */ |
470 | aio_context_acquire(aio_context); | |
80fa2c75 | 471 | job->driver->free(job); |
6f592e5a | 472 | aio_context_release(aio_context); |
afe1e8a7 | 473 | job_lock(); |
80fa2c75 KW |
474 | } |
475 | ||
476 | QLIST_REMOVE(job, job_list); | |
477 | ||
a7b4f8fc | 478 | progress_destroy(&job->progress); |
3d1f8b07 | 479 | error_free(job->err); |
80fa2c75 KW |
480 | g_free(job->id); |
481 | g_free(job); | |
482 | } | |
fd61a701 | 483 | } |
1908a559 | 484 | |
30a5c887 KW |
485 | void job_progress_update(Job *job, uint64_t done) |
486 | { | |
01fe1ca9 | 487 | progress_work_done(&job->progress, done); |
30a5c887 KW |
488 | } |
489 | ||
490 | void job_progress_set_remaining(Job *job, uint64_t remaining) | |
491 | { | |
01fe1ca9 | 492 | progress_set_remaining(&job->progress, remaining); |
30a5c887 KW |
493 | } |
494 | ||
62f13600 HR |
495 | void job_progress_increase_remaining(Job *job, uint64_t delta) |
496 | { | |
01fe1ca9 | 497 | progress_increase_remaining(&job->progress, delta); |
62f13600 HR |
498 | } |
499 | ||
544f4d52 EGE |
500 | /** |
501 | * To be called when a cancelled job is finalised. | |
afe1e8a7 | 502 | * Called with job_mutex held. |
544f4d52 | 503 | */ |
afe1e8a7 | 504 | static void job_event_cancelled_locked(Job *job) |
139a9f02 KW |
505 | { |
506 | notifier_list_notify(&job->on_finalize_cancelled, job); | |
507 | } | |
508 | ||
544f4d52 EGE |
509 | /** |
510 | * To be called when a successfully completed job is finalised. | |
afe1e8a7 | 511 | * Called with job_mutex held. |
544f4d52 | 512 | */ |
afe1e8a7 | 513 | static void job_event_completed_locked(Job *job) |
139a9f02 KW |
514 | { |
515 | notifier_list_notify(&job->on_finalize_completed, job); | |
516 | } | |
517 | ||
afe1e8a7 EGE |
518 | /* Called with job_mutex held. */ |
519 | static void job_event_pending_locked(Job *job) | |
139a9f02 KW |
520 | { |
521 | notifier_list_notify(&job->on_pending, job); | |
522 | } | |
523 | ||
afe1e8a7 EGE |
524 | /* Called with job_mutex held. */ |
525 | static void job_event_ready_locked(Job *job) | |
2e1795b5 KW |
526 | { |
527 | notifier_list_notify(&job->on_ready, job); | |
528 | } | |
529 | ||
afe1e8a7 EGE |
530 | /* Called with job_mutex held. */ |
531 | static void job_event_idle_locked(Job *job) | |
34dc97b9 KW |
532 | { |
533 | notifier_list_notify(&job->on_idle, job); | |
534 | } | |
535 | ||
afe1e8a7 | 536 | void job_enter_cond_locked(Job *job, bool(*fn)(Job *job)) |
da01ff7f | 537 | { |
afe1e8a7 | 538 | if (!job_started_locked(job)) { |
da01ff7f KW |
539 | return; |
540 | } | |
541 | if (job->deferred_to_main_loop) { | |
542 | return; | |
543 | } | |
544 | ||
da01ff7f | 545 | if (job->busy) { |
da01ff7f KW |
546 | return; |
547 | } | |
548 | ||
549 | if (fn && !fn(job)) { | |
da01ff7f KW |
550 | return; |
551 | } | |
552 | ||
553 | assert(!job->deferred_to_main_loop); | |
554 | timer_del(&job->sleep_timer); | |
555 | job->busy = true; | |
afe1e8a7 | 556 | job_unlock(); |
ef02dac2 | 557 | aio_co_wake(job->co); |
afe1e8a7 EGE |
558 | job_lock(); |
559 | } | |
560 | ||
5d43e86e KW |
561 | void job_enter(Job *job) |
562 | { | |
afe1e8a7 EGE |
563 | JOB_LOCK_GUARD(); |
564 | job_enter_cond_locked(job, NULL); | |
5d43e86e KW |
565 | } |
566 | ||
da01ff7f | 567 | /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. |
3d70ff53 KW |
568 | * Reentering the job coroutine with job_enter() before the timer has expired |
569 | * is allowed and cancels the timer. | |
da01ff7f | 570 | * |
3d70ff53 | 571 | * If @ns is (uint64_t) -1, no timer is scheduled and job_enter() must be |
afe1e8a7 EGE |
572 | * called explicitly. |
573 | * | |
574 | * Called with job_mutex held, but releases it temporarily. | |
575 | */ | |
576 | static void coroutine_fn job_do_yield_locked(Job *job, uint64_t ns) | |
da01ff7f | 577 | { |
ef02dac2 PB |
578 | AioContext *next_aio_context; |
579 | ||
da01ff7f KW |
580 | if (ns != -1) { |
581 | timer_mod(&job->sleep_timer, ns); | |
582 | } | |
583 | job->busy = false; | |
afe1e8a7 | 584 | job_event_idle_locked(job); |
afe1e8a7 | 585 | job_unlock(); |
da01ff7f | 586 | qemu_coroutine_yield(); |
afe1e8a7 | 587 | job_lock(); |
da01ff7f | 588 | |
ef02dac2 PB |
589 | next_aio_context = job->aio_context; |
590 | /* | |
591 | * Coroutine has resumed, but in the meanwhile the job AioContext | |
142e6907 | 592 | * might have changed via bdrv_try_change_aio_context(), so we need to move |
ef02dac2 PB |
593 | * the coroutine too in the new aiocontext. |
594 | */ | |
595 | while (qemu_get_current_aio_context() != next_aio_context) { | |
596 | job_unlock(); | |
597 | aio_co_reschedule_self(next_aio_context); | |
598 | job_lock(); | |
599 | next_aio_context = job->aio_context; | |
600 | } | |
601 | ||
602 | /* Set by job_enter_cond_locked() before re-entering the coroutine. */ | |
da01ff7f KW |
603 | assert(job->busy); |
604 | } | |
605 | ||
afe1e8a7 EGE |
606 | /* Called with job_mutex held, but releases it temporarily. */ |
607 | static void coroutine_fn job_pause_point_locked(Job *job) | |
da01ff7f | 608 | { |
afe1e8a7 | 609 | assert(job && job_started_locked(job)); |
da01ff7f | 610 | |
afe1e8a7 | 611 | if (!job_should_pause_locked(job)) { |
da01ff7f KW |
612 | return; |
613 | } | |
afe1e8a7 | 614 | if (job_is_cancelled_locked(job)) { |
da01ff7f KW |
615 | return; |
616 | } | |
617 | ||
618 | if (job->driver->pause) { | |
afe1e8a7 | 619 | job_unlock(); |
da01ff7f | 620 | job->driver->pause(job); |
afe1e8a7 | 621 | job_lock(); |
da01ff7f KW |
622 | } |
623 | ||
afe1e8a7 | 624 | if (job_should_pause_locked(job) && !job_is_cancelled_locked(job)) { |
da01ff7f | 625 | JobStatus status = job->status; |
afe1e8a7 EGE |
626 | job_state_transition_locked(job, status == JOB_STATUS_READY |
627 | ? JOB_STATUS_STANDBY | |
628 | : JOB_STATUS_PAUSED); | |
da01ff7f | 629 | job->paused = true; |
afe1e8a7 | 630 | job_do_yield_locked(job, -1); |
da01ff7f | 631 | job->paused = false; |
afe1e8a7 | 632 | job_state_transition_locked(job, status); |
da01ff7f KW |
633 | } |
634 | ||
635 | if (job->driver->resume) { | |
afe1e8a7 | 636 | job_unlock(); |
da01ff7f | 637 | job->driver->resume(job); |
afe1e8a7 | 638 | job_lock(); |
da01ff7f KW |
639 | } |
640 | } | |
641 | ||
afe1e8a7 EGE |
642 | void coroutine_fn job_pause_point(Job *job) |
643 | { | |
644 | JOB_LOCK_GUARD(); | |
645 | job_pause_point_locked(job); | |
646 | } | |
647 | ||
9bd4d3c2 | 648 | void coroutine_fn job_yield(Job *job) |
198c49cc | 649 | { |
9bd4d3c2 | 650 | JOB_LOCK_GUARD(); |
198c49cc KW |
651 | assert(job->busy); |
652 | ||
653 | /* Check cancellation *before* setting busy = false, too! */ | |
afe1e8a7 | 654 | if (job_is_cancelled_locked(job)) { |
198c49cc KW |
655 | return; |
656 | } | |
657 | ||
afe1e8a7 EGE |
658 | if (!job_should_pause_locked(job)) { |
659 | job_do_yield_locked(job, -1); | |
198c49cc KW |
660 | } |
661 | ||
afe1e8a7 EGE |
662 | job_pause_point_locked(job); |
663 | } | |
664 | ||
5d43e86e KW |
665 | void coroutine_fn job_sleep_ns(Job *job, int64_t ns) |
666 | { | |
afe1e8a7 | 667 | JOB_LOCK_GUARD(); |
5d43e86e KW |
668 | assert(job->busy); |
669 | ||
670 | /* Check cancellation *before* setting busy = false, too! */ | |
afe1e8a7 | 671 | if (job_is_cancelled_locked(job)) { |
5d43e86e KW |
672 | return; |
673 | } | |
674 | ||
afe1e8a7 EGE |
675 | if (!job_should_pause_locked(job)) { |
676 | job_do_yield_locked(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); | |
5d43e86e KW |
677 | } |
678 | ||
afe1e8a7 | 679 | job_pause_point_locked(job); |
5d43e86e KW |
680 | } |
681 | ||
afe1e8a7 EGE |
682 | /* Assumes the job_mutex is held */ |
683 | static bool job_timer_not_pending_locked(Job *job) | |
b15de828 KW |
684 | { |
685 | return !timer_pending(&job->sleep_timer); | |
686 | } | |
687 | ||
afe1e8a7 | 688 | void job_pause_locked(Job *job) |
b15de828 KW |
689 | { |
690 | job->pause_count++; | |
3ee1483b | 691 | if (!job->paused) { |
afe1e8a7 | 692 | job_enter_cond_locked(job, NULL); |
3ee1483b | 693 | } |
b15de828 KW |
694 | } |
695 | ||
afe1e8a7 EGE |
696 | void job_pause(Job *job) |
697 | { | |
698 | JOB_LOCK_GUARD(); | |
699 | job_pause_locked(job); | |
700 | } | |
701 | ||
702 | void job_resume_locked(Job *job) | |
b15de828 KW |
703 | { |
704 | assert(job->pause_count > 0); | |
705 | job->pause_count--; | |
706 | if (job->pause_count) { | |
707 | return; | |
708 | } | |
709 | ||
710 | /* kick only if no timer is pending */ | |
afe1e8a7 | 711 | job_enter_cond_locked(job, job_timer_not_pending_locked); |
b15de828 KW |
712 | } |
713 | ||
afe1e8a7 | 714 | void job_resume(Job *job) |
b15de828 | 715 | { |
afe1e8a7 EGE |
716 | JOB_LOCK_GUARD(); |
717 | job_resume_locked(job); | |
718 | } | |
719 | ||
720 | void job_user_pause_locked(Job *job, Error **errp) | |
721 | { | |
722 | if (job_apply_verb_locked(job, JOB_VERB_PAUSE, errp)) { | |
b15de828 KW |
723 | return; |
724 | } | |
725 | if (job->user_paused) { | |
726 | error_setg(errp, "Job is already paused"); | |
727 | return; | |
728 | } | |
729 | job->user_paused = true; | |
afe1e8a7 | 730 | job_pause_locked(job); |
b15de828 KW |
731 | } |
732 | ||
afe1e8a7 | 733 | bool job_user_paused_locked(Job *job) |
b15de828 KW |
734 | { |
735 | return job->user_paused; | |
736 | } | |
737 | ||
afe1e8a7 | 738 | void job_user_resume_locked(Job *job, Error **errp) |
b15de828 KW |
739 | { |
740 | assert(job); | |
c70b8031 | 741 | GLOBAL_STATE_CODE(); |
b15de828 KW |
742 | if (!job->user_paused || job->pause_count <= 0) { |
743 | error_setg(errp, "Can't resume a job that was not paused"); | |
744 | return; | |
745 | } | |
afe1e8a7 | 746 | if (job_apply_verb_locked(job, JOB_VERB_RESUME, errp)) { |
b15de828 KW |
747 | return; |
748 | } | |
749 | if (job->driver->user_resume) { | |
afe1e8a7 | 750 | job_unlock(); |
b15de828 | 751 | job->driver->user_resume(job); |
afe1e8a7 | 752 | job_lock(); |
b15de828 KW |
753 | } |
754 | job->user_paused = false; | |
afe1e8a7 | 755 | job_resume_locked(job); |
b15de828 KW |
756 | } |
757 | ||
afe1e8a7 EGE |
758 | /* Called with job_mutex held, but releases it temporarily. */ |
759 | static void job_do_dismiss_locked(Job *job) | |
4ad35181 KW |
760 | { |
761 | assert(job); | |
762 | job->busy = false; | |
763 | job->paused = false; | |
764 | job->deferred_to_main_loop = true; | |
765 | ||
afe1e8a7 | 766 | job_txn_del_job_locked(job); |
4ad35181 | 767 | |
afe1e8a7 EGE |
768 | job_state_transition_locked(job, JOB_STATUS_NULL); |
769 | job_unref_locked(job); | |
4ad35181 KW |
770 | } |
771 | ||
afe1e8a7 | 772 | void job_dismiss_locked(Job **jobptr, Error **errp) |
5f9a6a08 KW |
773 | { |
774 | Job *job = *jobptr; | |
775 | /* similarly to _complete, this is QMP-interface only. */ | |
776 | assert(job->id); | |
afe1e8a7 | 777 | if (job_apply_verb_locked(job, JOB_VERB_DISMISS, errp)) { |
5f9a6a08 KW |
778 | return; |
779 | } | |
780 | ||
afe1e8a7 | 781 | job_do_dismiss_locked(job); |
5f9a6a08 KW |
782 | *jobptr = NULL; |
783 | } | |
784 | ||
4ad35181 KW |
785 | void job_early_fail(Job *job) |
786 | { | |
afe1e8a7 | 787 | JOB_LOCK_GUARD(); |
4ad35181 | 788 | assert(job->status == JOB_STATUS_CREATED); |
afe1e8a7 | 789 | job_do_dismiss_locked(job); |
4ad35181 KW |
790 | } |
791 | ||
afe1e8a7 EGE |
792 | /* Called with job_mutex held. */ |
793 | static void job_conclude_locked(Job *job) | |
4ad35181 | 794 | { |
afe1e8a7 EGE |
795 | job_state_transition_locked(job, JOB_STATUS_CONCLUDED); |
796 | if (job->auto_dismiss || !job_started_locked(job)) { | |
797 | job_do_dismiss_locked(job); | |
4ad35181 KW |
798 | } |
799 | } | |
800 | ||
afe1e8a7 EGE |
801 | /* Called with job_mutex held. */ |
802 | static void job_update_rc_locked(Job *job) | |
4ad35181 | 803 | { |
afe1e8a7 | 804 | if (!job->ret && job_is_cancelled_locked(job)) { |
4ad35181 KW |
805 | job->ret = -ECANCELED; |
806 | } | |
807 | if (job->ret) { | |
3d1f8b07 JS |
808 | if (!job->err) { |
809 | error_setg(&job->err, "%s", strerror(-job->ret)); | |
1266c9b9 | 810 | } |
afe1e8a7 | 811 | job_state_transition_locked(job, JOB_STATUS_ABORTING); |
4ad35181 KW |
812 | } |
813 | } | |
814 | ||
815 | static void job_commit(Job *job) | |
816 | { | |
817 | assert(!job->ret); | |
c70b8031 | 818 | GLOBAL_STATE_CODE(); |
4ad35181 KW |
819 | if (job->driver->commit) { |
820 | job->driver->commit(job); | |
821 | } | |
822 | } | |
823 | ||
824 | static void job_abort(Job *job) | |
825 | { | |
826 | assert(job->ret); | |
c70b8031 | 827 | GLOBAL_STATE_CODE(); |
4ad35181 KW |
828 | if (job->driver->abort) { |
829 | job->driver->abort(job); | |
830 | } | |
831 | } | |
832 | ||
833 | static void job_clean(Job *job) | |
834 | { | |
c70b8031 | 835 | GLOBAL_STATE_CODE(); |
4ad35181 KW |
836 | if (job->driver->clean) { |
837 | job->driver->clean(job); | |
838 | } | |
839 | } | |
840 | ||
6f592e5a EGE |
841 | /* |
842 | * Called with job_mutex held, but releases it temporarily. | |
843 | * Takes AioContext lock internally to invoke a job->driver callback. | |
844 | */ | |
afe1e8a7 | 845 | static int job_finalize_single_locked(Job *job) |
4ad35181 | 846 | { |
afe1e8a7 | 847 | int job_ret; |
6f592e5a | 848 | AioContext *ctx = job->aio_context; |
afe1e8a7 EGE |
849 | |
850 | assert(job_is_completed_locked(job)); | |
4ad35181 KW |
851 | |
852 | /* Ensure abort is called for late-transactional failures */ | |
afe1e8a7 EGE |
853 | job_update_rc_locked(job); |
854 | ||
855 | job_ret = job->ret; | |
856 | job_unlock(); | |
6f592e5a | 857 | aio_context_acquire(ctx); |
4ad35181 | 858 | |
afe1e8a7 | 859 | if (!job_ret) { |
4ad35181 KW |
860 | job_commit(job); |
861 | } else { | |
862 | job_abort(job); | |
863 | } | |
864 | job_clean(job); | |
865 | ||
866 | if (job->cb) { | |
afe1e8a7 | 867 | job->cb(job->opaque, job_ret); |
4ad35181 KW |
868 | } |
869 | ||
6f592e5a EGE |
870 | aio_context_release(ctx); |
871 | job_lock(); | |
872 | ||
4ad35181 | 873 | /* Emit events only if we actually started */ |
afe1e8a7 EGE |
874 | if (job_started_locked(job)) { |
875 | if (job_is_cancelled_locked(job)) { | |
876 | job_event_cancelled_locked(job); | |
4ad35181 | 877 | } else { |
afe1e8a7 | 878 | job_event_completed_locked(job); |
4ad35181 KW |
879 | } |
880 | } | |
881 | ||
afe1e8a7 EGE |
882 | job_txn_del_job_locked(job); |
883 | job_conclude_locked(job); | |
4ad35181 KW |
884 | return 0; |
885 | } | |
886 | ||
6f592e5a EGE |
887 | /* |
888 | * Called with job_mutex held, but releases it temporarily. | |
889 | * Takes AioContext lock internally to invoke a job->driver callback. | |
890 | */ | |
afe1e8a7 | 891 | static void job_cancel_async_locked(Job *job, bool force) |
7eaa8fb5 | 892 | { |
6f592e5a | 893 | AioContext *ctx = job->aio_context; |
c70b8031 | 894 | GLOBAL_STATE_CODE(); |
9820933b | 895 | if (job->driver->cancel) { |
afe1e8a7 | 896 | job_unlock(); |
6f592e5a | 897 | aio_context_acquire(ctx); |
73895f38 | 898 | force = job->driver->cancel(job, force); |
6f592e5a | 899 | aio_context_release(ctx); |
afe1e8a7 | 900 | job_lock(); |
73895f38 HR |
901 | } else { |
902 | /* No .cancel() means the job will behave as if force-cancelled */ | |
903 | force = true; | |
9820933b | 904 | } |
73895f38 | 905 | |
7eaa8fb5 KW |
906 | if (job->user_paused) { |
907 | /* Do not call job_enter here, the caller will handle it. */ | |
7eaa8fb5 | 908 | if (job->driver->user_resume) { |
afe1e8a7 | 909 | job_unlock(); |
7eaa8fb5 | 910 | job->driver->user_resume(job); |
afe1e8a7 | 911 | job_lock(); |
7eaa8fb5 | 912 | } |
e321c059 | 913 | job->user_paused = false; |
7eaa8fb5 KW |
914 | assert(job->pause_count > 0); |
915 | job->pause_count--; | |
916 | } | |
401dd096 HR |
917 | |
918 | /* | |
919 | * Ignore soft cancel requests after the job is already done | |
920 | * (We will still invoke job->driver->cancel() above, but if the | |
921 | * job driver supports soft cancelling and the job is done, that | |
922 | * should be a no-op, too. We still call it so it can override | |
923 | * @force.) | |
924 | */ | |
925 | if (force || !job->deferred_to_main_loop) { | |
926 | job->cancelled = true; | |
927 | /* To prevent 'force == false' overriding a previous 'force == true' */ | |
928 | job->force_cancel |= force; | |
929 | } | |
7eaa8fb5 KW |
930 | } |
931 | ||
6f592e5a EGE |
932 | /* |
933 | * Called with job_mutex held, but releases it temporarily. | |
934 | * Takes AioContext lock internally to invoke a job->driver callback. | |
935 | */ | |
afe1e8a7 | 936 | static void job_completed_txn_abort_locked(Job *job) |
7eaa8fb5 | 937 | { |
7eaa8fb5 KW |
938 | JobTxn *txn = job->txn; |
939 | Job *other_job; | |
940 | ||
941 | if (txn->aborting) { | |
942 | /* | |
943 | * We are cancelled by another job, which will handle everything. | |
944 | */ | |
945 | return; | |
946 | } | |
947 | txn->aborting = true; | |
afe1e8a7 | 948 | job_txn_ref_locked(txn); |
7eaa8fb5 | 949 | |
afe1e8a7 | 950 | job_ref_locked(job); |
7eaa8fb5 KW |
951 | |
952 | /* Other jobs are effectively cancelled by us, set the status for | |
953 | * them; this job, however, may or may not be cancelled, depending | |
954 | * on the caller, so leave it. */ | |
955 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { | |
956 | if (other_job != job) { | |
1d4a43e9 HR |
957 | /* |
958 | * This is a transaction: If one job failed, no result will matter. | |
959 | * Therefore, pass force=true to terminate all other jobs as quickly | |
960 | * as possible. | |
961 | */ | |
afe1e8a7 | 962 | job_cancel_async_locked(other_job, true); |
7eaa8fb5 KW |
963 | } |
964 | } | |
965 | while (!QLIST_EMPTY(&txn->jobs)) { | |
966 | other_job = QLIST_FIRST(&txn->jobs); | |
afe1e8a7 EGE |
967 | if (!job_is_completed_locked(other_job)) { |
968 | assert(job_cancel_requested_locked(other_job)); | |
969 | job_finish_sync_locked(other_job, NULL, NULL); | |
7eaa8fb5 | 970 | } |
afe1e8a7 | 971 | job_finalize_single_locked(other_job); |
7eaa8fb5 KW |
972 | } |
973 | ||
afe1e8a7 | 974 | job_unref_locked(job); |
afe1e8a7 | 975 | job_txn_unref_locked(txn); |
7eaa8fb5 KW |
976 | } |
977 | ||
afe1e8a7 EGE |
978 | /* Called with job_mutex held, but releases it temporarily */ |
979 | static int job_prepare_locked(Job *job) | |
7eaa8fb5 | 980 | { |
afe1e8a7 | 981 | int ret; |
6f592e5a | 982 | AioContext *ctx = job->aio_context; |
afe1e8a7 | 983 | |
c70b8031 | 984 | GLOBAL_STATE_CODE(); |
6f592e5a | 985 | |
7eaa8fb5 | 986 | if (job->ret == 0 && job->driver->prepare) { |
afe1e8a7 | 987 | job_unlock(); |
6f592e5a | 988 | aio_context_acquire(ctx); |
afe1e8a7 | 989 | ret = job->driver->prepare(job); |
6f592e5a | 990 | aio_context_release(ctx); |
afe1e8a7 EGE |
991 | job_lock(); |
992 | job->ret = ret; | |
993 | job_update_rc_locked(job); | |
7eaa8fb5 | 994 | } |
6f592e5a | 995 | |
7eaa8fb5 KW |
996 | return job->ret; |
997 | } | |
998 | ||
afe1e8a7 EGE |
999 | /* Called with job_mutex held */ |
1000 | static int job_needs_finalize_locked(Job *job) | |
7eaa8fb5 KW |
1001 | { |
1002 | return !job->auto_finalize; | |
1003 | } | |
1004 | ||
afe1e8a7 EGE |
1005 | /* Called with job_mutex held */ |
1006 | static void job_do_finalize_locked(Job *job) | |
7eaa8fb5 KW |
1007 | { |
1008 | int rc; | |
1009 | assert(job && job->txn); | |
1010 | ||
1011 | /* prepare the transaction to complete */ | |
afe1e8a7 | 1012 | rc = job_txn_apply_locked(job, job_prepare_locked); |
7eaa8fb5 | 1013 | if (rc) { |
afe1e8a7 | 1014 | job_completed_txn_abort_locked(job); |
7eaa8fb5 | 1015 | } else { |
afe1e8a7 | 1016 | job_txn_apply_locked(job, job_finalize_single_locked); |
7eaa8fb5 KW |
1017 | } |
1018 | } | |
1019 | ||
afe1e8a7 | 1020 | void job_finalize_locked(Job *job, Error **errp) |
7eaa8fb5 KW |
1021 | { |
1022 | assert(job && job->id); | |
afe1e8a7 | 1023 | if (job_apply_verb_locked(job, JOB_VERB_FINALIZE, errp)) { |
7eaa8fb5 KW |
1024 | return; |
1025 | } | |
afe1e8a7 | 1026 | job_do_finalize_locked(job); |
7eaa8fb5 KW |
1027 | } |
1028 | ||
afe1e8a7 EGE |
1029 | /* Called with job_mutex held. */ |
1030 | static int job_transition_to_pending_locked(Job *job) | |
1031 | { | |
1032 | job_state_transition_locked(job, JOB_STATUS_PENDING); | |
7eaa8fb5 | 1033 | if (!job->auto_finalize) { |
afe1e8a7 | 1034 | job_event_pending_locked(job); |
7eaa8fb5 KW |
1035 | } |
1036 | return 0; | |
1037 | } | |
1038 | ||
2e1795b5 KW |
1039 | void job_transition_to_ready(Job *job) |
1040 | { | |
afe1e8a7 EGE |
1041 | JOB_LOCK_GUARD(); |
1042 | job_state_transition_locked(job, JOB_STATUS_READY); | |
1043 | job_event_ready_locked(job); | |
2e1795b5 KW |
1044 | } |
1045 | ||
afe1e8a7 EGE |
1046 | /* Called with job_mutex held. */ |
1047 | static void job_completed_txn_success_locked(Job *job) | |
7eaa8fb5 KW |
1048 | { |
1049 | JobTxn *txn = job->txn; | |
1050 | Job *other_job; | |
1051 | ||
afe1e8a7 | 1052 | job_state_transition_locked(job, JOB_STATUS_WAITING); |
7eaa8fb5 KW |
1053 | |
1054 | /* | |
1055 | * Successful completion, see if there are other running jobs in this | |
1056 | * txn. | |
1057 | */ | |
1058 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { | |
afe1e8a7 | 1059 | if (!job_is_completed_locked(other_job)) { |
7eaa8fb5 KW |
1060 | return; |
1061 | } | |
1062 | assert(other_job->ret == 0); | |
1063 | } | |
1064 | ||
afe1e8a7 | 1065 | job_txn_apply_locked(job, job_transition_to_pending_locked); |
7eaa8fb5 KW |
1066 | |
1067 | /* If no jobs need manual finalization, automatically do so */ | |
afe1e8a7 EGE |
1068 | if (job_txn_apply_locked(job, job_needs_finalize_locked) == 0) { |
1069 | job_do_finalize_locked(job); | |
7eaa8fb5 KW |
1070 | } |
1071 | } | |
1072 | ||
afe1e8a7 EGE |
1073 | /* Called with job_mutex held. */ |
1074 | static void job_completed_locked(Job *job) | |
3d70ff53 | 1075 | { |
afe1e8a7 | 1076 | assert(job && job->txn && !job_is_completed_locked(job)); |
1266c9b9 | 1077 | |
afe1e8a7 | 1078 | job_update_rc_locked(job); |
404ff28d | 1079 | trace_job_completed(job, job->ret); |
3d70ff53 | 1080 | if (job->ret) { |
afe1e8a7 | 1081 | job_completed_txn_abort_locked(job); |
3d70ff53 | 1082 | } else { |
afe1e8a7 | 1083 | job_completed_txn_success_locked(job); |
3d70ff53 KW |
1084 | } |
1085 | } | |
1086 | ||
afe1e8a7 EGE |
1087 | /** |
1088 | * Useful only as a type shim for aio_bh_schedule_oneshot. | |
1089 | * Called with job_mutex *not* held. | |
1090 | */ | |
ccbfb331 JS |
1091 | static void job_exit(void *opaque) |
1092 | { | |
1093 | Job *job = (Job *)opaque; | |
afe1e8a7 | 1094 | JOB_LOCK_GUARD(); |
afe1e8a7 | 1095 | job_ref_locked(job); |
b5a7a057 KW |
1096 | |
1097 | /* This is a lie, we're not quiescent, but still doing the completion | |
1098 | * callbacks. However, completion callbacks tend to involve operations that | |
1099 | * drain block nodes, and if .drained_poll still returned true, we would | |
1100 | * deadlock. */ | |
1101 | job->busy = false; | |
afe1e8a7 | 1102 | job_event_idle_locked(job); |
b5a7a057 | 1103 | |
afe1e8a7 | 1104 | job_completed_locked(job); |
afe1e8a7 | 1105 | job_unref_locked(job); |
ccbfb331 JS |
1106 | } |
1107 | ||
1108 | /** | |
1109 | * All jobs must allow a pause point before entering their job proper. This | |
1110 | * ensures that jobs can be paused prior to being started, then resumed later. | |
1111 | */ | |
1112 | static void coroutine_fn job_co_entry(void *opaque) | |
1113 | { | |
1114 | Job *job = opaque; | |
afe1e8a7 | 1115 | int ret; |
ccbfb331 JS |
1116 | |
1117 | assert(job && job->driver && job->driver->run); | |
afe1e8a7 EGE |
1118 | WITH_JOB_LOCK_GUARD() { |
1119 | assert(job->aio_context == qemu_get_current_aio_context()); | |
1120 | job_pause_point_locked(job); | |
1121 | } | |
1122 | ret = job->driver->run(job, &job->err); | |
1123 | WITH_JOB_LOCK_GUARD() { | |
1124 | job->ret = ret; | |
1125 | job->deferred_to_main_loop = true; | |
1126 | job->busy = true; | |
1127 | } | |
ccbfb331 JS |
1128 | aio_bh_schedule_oneshot(qemu_get_aio_context(), job_exit, job); |
1129 | } | |
1130 | ||
1131 | void job_start(Job *job) | |
1132 | { | |
afe1e8a7 EGE |
1133 | assert(qemu_in_main_thread()); |
1134 | ||
1135 | WITH_JOB_LOCK_GUARD() { | |
1136 | assert(job && !job_started_locked(job) && job->paused && | |
1137 | job->driver && job->driver->run); | |
1138 | job->co = qemu_coroutine_create(job_co_entry, job); | |
1139 | job->pause_count--; | |
1140 | job->busy = true; | |
1141 | job->paused = false; | |
1142 | job_state_transition_locked(job, JOB_STATUS_RUNNING); | |
1143 | } | |
ccbfb331 JS |
1144 | aio_co_enter(job->aio_context, job->co); |
1145 | } | |
1146 | ||
afe1e8a7 | 1147 | void job_cancel_locked(Job *job, bool force) |
3d70ff53 KW |
1148 | { |
1149 | if (job->status == JOB_STATUS_CONCLUDED) { | |
afe1e8a7 | 1150 | job_do_dismiss_locked(job); |
3d70ff53 KW |
1151 | return; |
1152 | } | |
afe1e8a7 EGE |
1153 | job_cancel_async_locked(job, force); |
1154 | if (!job_started_locked(job)) { | |
1155 | job_completed_locked(job); | |
3d70ff53 | 1156 | } else if (job->deferred_to_main_loop) { |
401dd096 HR |
1157 | /* |
1158 | * job_cancel_async() ignores soft-cancel requests for jobs | |
1159 | * that are already done (i.e. deferred to the main loop). We | |
1160 | * have to check again whether the job is really cancelled. | |
08b83bff HR |
1161 | * (job_cancel_requested() and job_is_cancelled() are equivalent |
1162 | * here, because job_cancel_async() will make soft-cancel | |
1163 | * requests no-ops when deferred_to_main_loop is true. We | |
1164 | * choose to call job_is_cancelled() to show that we invoke | |
1165 | * job_completed_txn_abort() only for force-cancelled jobs.) | |
401dd096 | 1166 | */ |
afe1e8a7 EGE |
1167 | if (job_is_cancelled_locked(job)) { |
1168 | job_completed_txn_abort_locked(job); | |
401dd096 | 1169 | } |
3d70ff53 | 1170 | } else { |
afe1e8a7 | 1171 | job_enter_cond_locked(job, NULL); |
3d70ff53 KW |
1172 | } |
1173 | } | |
1174 | ||
afe1e8a7 EGE |
1175 | void job_user_cancel_locked(Job *job, bool force, Error **errp) |
1176 | { | |
1177 | if (job_apply_verb_locked(job, JOB_VERB_CANCEL, errp)) { | |
3d70ff53 KW |
1178 | return; |
1179 | } | |
afe1e8a7 EGE |
1180 | job_cancel_locked(job, force); |
1181 | } | |
1182 | ||
9bd4d3c2 EGE |
1183 | /* A wrapper around job_cancel_locked() taking an Error ** parameter so it may |
1184 | * be used with job_finish_sync_locked() without the need for (rather nasty) | |
1185 | * function pointer casts there. | |
afe1e8a7 EGE |
1186 | * |
1187 | * Called with job_mutex held. | |
1188 | */ | |
1189 | static void job_cancel_err_locked(Job *job, Error **errp) | |
3d70ff53 | 1190 | { |
afe1e8a7 | 1191 | job_cancel_locked(job, false); |
3d70ff53 KW |
1192 | } |
1193 | ||
4cfb3f05 HR |
1194 | /** |
1195 | * Same as job_cancel_err(), but force-cancel. | |
afe1e8a7 | 1196 | * Called with job_mutex held. |
4cfb3f05 | 1197 | */ |
afe1e8a7 | 1198 | static void job_force_cancel_err_locked(Job *job, Error **errp) |
3d70ff53 | 1199 | { |
afe1e8a7 | 1200 | job_cancel_locked(job, true); |
4cfb3f05 HR |
1201 | } |
1202 | ||
afe1e8a7 | 1203 | int job_cancel_sync_locked(Job *job, bool force) |
4cfb3f05 HR |
1204 | { |
1205 | if (force) { | |
afe1e8a7 | 1206 | return job_finish_sync_locked(job, &job_force_cancel_err_locked, NULL); |
4cfb3f05 | 1207 | } else { |
afe1e8a7 | 1208 | return job_finish_sync_locked(job, &job_cancel_err_locked, NULL); |
4cfb3f05 | 1209 | } |
3d70ff53 KW |
1210 | } |
1211 | ||
afe1e8a7 EGE |
1212 | int job_cancel_sync(Job *job, bool force) |
1213 | { | |
1214 | JOB_LOCK_GUARD(); | |
1215 | return job_cancel_sync_locked(job, force); | |
1216 | } | |
1217 | ||
3d70ff53 KW |
1218 | void job_cancel_sync_all(void) |
1219 | { | |
1220 | Job *job; | |
afe1e8a7 | 1221 | JOB_LOCK_GUARD(); |
3d70ff53 | 1222 | |
afe1e8a7 | 1223 | while ((job = job_next_locked(NULL))) { |
afe1e8a7 | 1224 | job_cancel_sync_locked(job, true); |
3d70ff53 KW |
1225 | } |
1226 | } | |
1227 | ||
afe1e8a7 EGE |
1228 | int job_complete_sync_locked(Job *job, Error **errp) |
1229 | { | |
1230 | return job_finish_sync_locked(job, job_complete_locked, errp); | |
1231 | } | |
1232 | ||
afe1e8a7 | 1233 | void job_complete_locked(Job *job, Error **errp) |
3453d972 KW |
1234 | { |
1235 | /* Should not be reachable via external interface for internal jobs */ | |
1236 | assert(job->id); | |
c70b8031 | 1237 | GLOBAL_STATE_CODE(); |
afe1e8a7 | 1238 | if (job_apply_verb_locked(job, JOB_VERB_COMPLETE, errp)) { |
3453d972 KW |
1239 | return; |
1240 | } | |
afe1e8a7 | 1241 | if (job_cancel_requested_locked(job) || !job->driver->complete) { |
3453d972 KW |
1242 | error_setg(errp, "The active block job '%s' cannot be completed", |
1243 | job->id); | |
1244 | return; | |
1245 | } | |
1246 | ||
afe1e8a7 | 1247 | job_unlock(); |
3453d972 | 1248 | job->driver->complete(job, errp); |
afe1e8a7 | 1249 | job_lock(); |
3453d972 KW |
1250 | } |
1251 | ||
afe1e8a7 EGE |
1252 | int job_finish_sync_locked(Job *job, |
1253 | void (*finish)(Job *, Error **errp), | |
1254 | Error **errp) | |
6a74c075 KW |
1255 | { |
1256 | Error *local_err = NULL; | |
1257 | int ret; | |
3ed4f708 | 1258 | GLOBAL_STATE_CODE(); |
6a74c075 | 1259 | |
afe1e8a7 | 1260 | job_ref_locked(job); |
6a74c075 KW |
1261 | |
1262 | if (finish) { | |
1263 | finish(job, &local_err); | |
1264 | } | |
1265 | if (local_err) { | |
1266 | error_propagate(errp, local_err); | |
afe1e8a7 | 1267 | job_unref_locked(job); |
6a74c075 KW |
1268 | return -EBUSY; |
1269 | } | |
de0fbe64 | 1270 | |
afe1e8a7 | 1271 | job_unlock(); |
6f592e5a EGE |
1272 | AIO_WAIT_WHILE_UNLOCKED(job->aio_context, |
1273 | (job_enter(job), !job_is_completed(job))); | |
afe1e8a7 | 1274 | job_lock(); |
de0fbe64 | 1275 | |
afe1e8a7 EGE |
1276 | ret = (job_is_cancelled_locked(job) && job->ret == 0) |
1277 | ? -ECANCELED : job->ret; | |
1278 | job_unref_locked(job); | |
6a74c075 KW |
1279 | return ret; |
1280 | } |