]>
Commit | Line | Data |
---|---|---|
2f0c9fe6 PB |
1 | /* |
2 | * QEMU System Emulator block driver | |
3 | * | |
4 | * Copyright (c) 2011 IBM Corp. | |
5 | * Copyright (c) 2012 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 | ||
d38ea87a | 26 | #include "qemu/osdep.h" |
2f0c9fe6 | 27 | #include "qemu-common.h" |
737e150e | 28 | #include "block/block.h" |
c87621ea | 29 | #include "block/blockjob_int.h" |
737e150e | 30 | #include "block/block_int.h" |
c9de4050 | 31 | #include "block/trace.h" |
373340b2 | 32 | #include "sysemu/block-backend.h" |
e688df6b | 33 | #include "qapi/error.h" |
9af23989 | 34 | #include "qapi/qapi-events-block-core.h" |
cc7a8ea7 | 35 | #include "qapi/qmp/qerror.h" |
10817bf0 | 36 | #include "qemu/coroutine.h" |
1de7afc9 | 37 | #include "qemu/timer.h" |
2f0c9fe6 | 38 | |
fc24908e PB |
39 | /* Right now, this mutex is only needed to synchronize accesses to job->busy |
40 | * and job->sleep_timer, such as concurrent calls to block_job_do_yield and | |
41 | * block_job_enter. */ | |
42 | static QemuMutex block_job_mutex; | |
43 | ||
c9de4050 JS |
44 | /* BlockJob State Transition Table */ |
45 | bool BlockJobSTT[BLOCK_JOB_STATUS__MAX][BLOCK_JOB_STATUS__MAX] = { | |
5f241594 JS |
46 | /* U, C, R, P, Y, S, W, D, X, E, N */ |
47 | /* U: */ [BLOCK_JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0}, | |
48 | /* C: */ [BLOCK_JOB_STATUS_CREATED] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1}, | |
49 | /* R: */ [BLOCK_JOB_STATUS_RUNNING] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0}, | |
50 | /* P: */ [BLOCK_JOB_STATUS_PAUSED] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0}, | |
51 | /* Y: */ [BLOCK_JOB_STATUS_READY] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0}, | |
52 | /* S: */ [BLOCK_JOB_STATUS_STANDBY] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, | |
53 | /* W: */ [BLOCK_JOB_STATUS_WAITING] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0}, | |
54 | /* D: */ [BLOCK_JOB_STATUS_PENDING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, | |
55 | /* X: */ [BLOCK_JOB_STATUS_ABORTING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, | |
56 | /* E: */ [BLOCK_JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, | |
57 | /* N: */ [BLOCK_JOB_STATUS_NULL] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, | |
c9de4050 JS |
58 | }; |
59 | ||
0ec4dfb8 | 60 | bool BlockJobVerbTable[BLOCK_JOB_VERB__MAX][BLOCK_JOB_STATUS__MAX] = { |
5f241594 JS |
61 | /* U, C, R, P, Y, S, W, D, X, E, N */ |
62 | [BLOCK_JOB_VERB_CANCEL] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0}, | |
63 | [BLOCK_JOB_VERB_PAUSE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
64 | [BLOCK_JOB_VERB_RESUME] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
65 | [BLOCK_JOB_VERB_SET_SPEED] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
66 | [BLOCK_JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, | |
11b61fbc | 67 | [BLOCK_JOB_VERB_FINALIZE] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0}, |
5f241594 | 68 | [BLOCK_JOB_VERB_DISMISS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0}, |
0ec4dfb8 JS |
69 | }; |
70 | ||
c9de4050 JS |
71 | static void block_job_state_transition(BlockJob *job, BlockJobStatus s1) |
72 | { | |
73 | BlockJobStatus s0 = job->status; | |
74 | assert(s1 >= 0 && s1 <= BLOCK_JOB_STATUS__MAX); | |
75 | trace_block_job_state_transition(job, job->ret, BlockJobSTT[s0][s1] ? | |
76 | "allowed" : "disallowed", | |
604343ce MAL |
77 | BlockJobStatus_str(s0), |
78 | BlockJobStatus_str(s1)); | |
c9de4050 JS |
79 | assert(BlockJobSTT[s0][s1]); |
80 | job->status = s1; | |
81 | } | |
82 | ||
0ec4dfb8 JS |
83 | static int block_job_apply_verb(BlockJob *job, BlockJobVerb bv, Error **errp) |
84 | { | |
85 | assert(bv >= 0 && bv <= BLOCK_JOB_VERB__MAX); | |
604343ce MAL |
86 | trace_block_job_apply_verb(job, BlockJobStatus_str(job->status), |
87 | BlockJobVerb_str(bv), | |
0ec4dfb8 JS |
88 | BlockJobVerbTable[bv][job->status] ? |
89 | "allowed" : "prohibited"); | |
90 | if (BlockJobVerbTable[bv][job->status]) { | |
91 | return 0; | |
92 | } | |
93 | error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", | |
33e9e9bd KW |
94 | job->job.id, BlockJobStatus_str(job->status), |
95 | BlockJobVerb_str(bv)); | |
0ec4dfb8 JS |
96 | return -EPERM; |
97 | } | |
98 | ||
fc24908e PB |
99 | static void block_job_lock(void) |
100 | { | |
101 | qemu_mutex_lock(&block_job_mutex); | |
102 | } | |
103 | ||
104 | static void block_job_unlock(void) | |
105 | { | |
106 | qemu_mutex_unlock(&block_job_mutex); | |
107 | } | |
108 | ||
109 | static void __attribute__((__constructor__)) block_job_init(void) | |
110 | { | |
111 | qemu_mutex_init(&block_job_mutex); | |
112 | } | |
113 | ||
8254b6d9 JS |
114 | static void block_job_event_cancelled(BlockJob *job); |
115 | static void block_job_event_completed(BlockJob *job, const char *msg); | |
5f241594 | 116 | static int block_job_event_pending(BlockJob *job); |
aa9ef2e6 | 117 | static void block_job_enter_cond(BlockJob *job, bool(*fn)(BlockJob *job)); |
8254b6d9 | 118 | |
c55a832f FZ |
119 | /* Transactional group of block jobs */ |
120 | struct BlockJobTxn { | |
121 | ||
122 | /* Is this txn being cancelled? */ | |
123 | bool aborting; | |
124 | ||
125 | /* List of jobs */ | |
126 | QLIST_HEAD(, BlockJob) jobs; | |
127 | ||
128 | /* Reference count */ | |
129 | int refcnt; | |
130 | }; | |
131 | ||
88691b37 PB |
132 | /* |
133 | * The block job API is composed of two categories of functions. | |
134 | * | |
135 | * The first includes functions used by the monitor. The monitor is | |
136 | * peculiar in that it accesses the block job list with block_job_get, and | |
137 | * therefore needs consistency across block_job_get and the actual operation | |
138 | * (e.g. block_job_set_speed). The consistency is achieved with | |
139 | * aio_context_acquire/release. These functions are declared in blockjob.h. | |
140 | * | |
141 | * The second includes functions used by the block job drivers and sometimes | |
142 | * by the core block layer. These do not care about locking, because the | |
143 | * whole coroutine runs under the AioContext lock, and are declared in | |
144 | * blockjob_int.h. | |
145 | */ | |
146 | ||
e7c1d78b | 147 | static bool is_block_job(Job *job) |
a7112795 | 148 | { |
e7c1d78b KW |
149 | return job_type(job) == JOB_TYPE_BACKUP || |
150 | job_type(job) == JOB_TYPE_COMMIT || | |
151 | job_type(job) == JOB_TYPE_MIRROR || | |
152 | job_type(job) == JOB_TYPE_STREAM; | |
153 | } | |
154 | ||
155 | BlockJob *block_job_next(BlockJob *bjob) | |
156 | { | |
157 | Job *job = bjob ? &bjob->job : NULL; | |
158 | ||
159 | do { | |
160 | job = job_next(job); | |
161 | } while (job && !is_block_job(job)); | |
162 | ||
163 | return job ? container_of(job, BlockJob, job) : NULL; | |
a7112795 AG |
164 | } |
165 | ||
ffb1f10c AG |
166 | BlockJob *block_job_get(const char *id) |
167 | { | |
e7c1d78b | 168 | Job *job = job_get(id); |
ffb1f10c | 169 | |
e7c1d78b KW |
170 | if (job && is_block_job(job)) { |
171 | return container_of(job, BlockJob, job); | |
172 | } else { | |
173 | return NULL; | |
ffb1f10c | 174 | } |
ffb1f10c AG |
175 | } |
176 | ||
c8ab5c2d PB |
177 | BlockJobTxn *block_job_txn_new(void) |
178 | { | |
179 | BlockJobTxn *txn = g_new0(BlockJobTxn, 1); | |
180 | QLIST_INIT(&txn->jobs); | |
181 | txn->refcnt = 1; | |
182 | return txn; | |
183 | } | |
184 | ||
185 | static void block_job_txn_ref(BlockJobTxn *txn) | |
186 | { | |
187 | txn->refcnt++; | |
188 | } | |
189 | ||
190 | void block_job_txn_unref(BlockJobTxn *txn) | |
191 | { | |
192 | if (txn && --txn->refcnt == 0) { | |
193 | g_free(txn); | |
194 | } | |
195 | } | |
196 | ||
197 | void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job) | |
198 | { | |
199 | if (!txn) { | |
200 | return; | |
201 | } | |
202 | ||
203 | assert(!job->txn); | |
204 | job->txn = txn; | |
205 | ||
206 | QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); | |
207 | block_job_txn_ref(txn); | |
208 | } | |
209 | ||
a865cebb MAL |
210 | static void block_job_txn_del_job(BlockJob *job) |
211 | { | |
212 | if (job->txn) { | |
213 | QLIST_REMOVE(job, txn_list); | |
214 | block_job_txn_unref(job->txn); | |
215 | job->txn = NULL; | |
216 | } | |
217 | } | |
218 | ||
4c7e813c SH |
219 | /* Assumes the block_job_mutex is held */ |
220 | static bool block_job_timer_pending(BlockJob *job) | |
221 | { | |
222 | return timer_pending(&job->sleep_timer); | |
223 | } | |
224 | ||
225 | /* Assumes the block_job_mutex is held */ | |
226 | static bool block_job_timer_not_pending(BlockJob *job) | |
227 | { | |
228 | return !block_job_timer_pending(job); | |
229 | } | |
230 | ||
f321dcb5 PB |
231 | static void block_job_pause(BlockJob *job) |
232 | { | |
233 | job->pause_count++; | |
234 | } | |
235 | ||
236 | static void block_job_resume(BlockJob *job) | |
237 | { | |
238 | assert(job->pause_count > 0); | |
239 | job->pause_count--; | |
240 | if (job->pause_count) { | |
241 | return; | |
242 | } | |
4c7e813c SH |
243 | |
244 | /* kick only if no timer is pending */ | |
245 | block_job_enter_cond(job, block_job_timer_not_pending); | |
f321dcb5 PB |
246 | } |
247 | ||
4172a003 | 248 | void block_job_ref(BlockJob *job) |
05b0d8e3 PB |
249 | { |
250 | ++job->refcnt; | |
251 | } | |
252 | ||
253 | static void block_job_attached_aio_context(AioContext *new_context, | |
254 | void *opaque); | |
255 | static void block_job_detach_aio_context(void *opaque); | |
256 | ||
4172a003 | 257 | void block_job_unref(BlockJob *job) |
05b0d8e3 PB |
258 | { |
259 | if (--job->refcnt == 0) { | |
3925cd3b | 260 | assert(job->status == BLOCK_JOB_STATUS_NULL); |
a865cebb | 261 | assert(!job->txn); |
05b0d8e3 PB |
262 | BlockDriverState *bs = blk_bs(job->blk); |
263 | bs->job = NULL; | |
264 | block_job_remove_all_bdrv(job); | |
265 | blk_remove_aio_context_notifier(job->blk, | |
266 | block_job_attached_aio_context, | |
267 | block_job_detach_aio_context, job); | |
268 | blk_unref(job->blk); | |
269 | error_free(job->blocker); | |
fc24908e | 270 | assert(!timer_pending(&job->sleep_timer)); |
fd61a701 | 271 | job_delete(&job->job); |
05b0d8e3 PB |
272 | } |
273 | } | |
274 | ||
463e0be1 SH |
275 | static void block_job_attached_aio_context(AioContext *new_context, |
276 | void *opaque) | |
277 | { | |
278 | BlockJob *job = opaque; | |
279 | ||
280 | if (job->driver->attached_aio_context) { | |
281 | job->driver->attached_aio_context(job, new_context); | |
282 | } | |
283 | ||
284 | block_job_resume(job); | |
285 | } | |
286 | ||
bae8196d PB |
287 | static void block_job_drain(BlockJob *job) |
288 | { | |
289 | /* If job is !job->busy this kicks it into the next pause point. */ | |
290 | block_job_enter(job); | |
291 | ||
292 | blk_drain(job->blk); | |
293 | if (job->driver->drain) { | |
294 | job->driver->drain(job); | |
295 | } | |
296 | } | |
297 | ||
463e0be1 SH |
298 | static void block_job_detach_aio_context(void *opaque) |
299 | { | |
300 | BlockJob *job = opaque; | |
301 | ||
302 | /* In case the job terminates during aio_poll()... */ | |
303 | block_job_ref(job); | |
304 | ||
305 | block_job_pause(job); | |
306 | ||
463e0be1 | 307 | while (!job->paused && !job->completed) { |
bae8196d | 308 | block_job_drain(job); |
463e0be1 SH |
309 | } |
310 | ||
311 | block_job_unref(job); | |
312 | } | |
313 | ||
f321dcb5 PB |
314 | static char *child_job_get_parent_desc(BdrvChild *c) |
315 | { | |
316 | BlockJob *job = c->opaque; | |
252291ea | 317 | return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); |
f321dcb5 PB |
318 | } |
319 | ||
ad90feba | 320 | static void child_job_drained_begin(BdrvChild *c) |
f321dcb5 | 321 | { |
ad90feba | 322 | BlockJob *job = c->opaque; |
f321dcb5 PB |
323 | block_job_pause(job); |
324 | } | |
325 | ||
ad90feba | 326 | static void child_job_drained_end(BdrvChild *c) |
f321dcb5 | 327 | { |
ad90feba | 328 | BlockJob *job = c->opaque; |
f321dcb5 PB |
329 | block_job_resume(job); |
330 | } | |
331 | ||
ad90feba KW |
332 | static const BdrvChildRole child_job = { |
333 | .get_parent_desc = child_job_get_parent_desc, | |
334 | .drained_begin = child_job_drained_begin, | |
335 | .drained_end = child_job_drained_end, | |
336 | .stay_at_node = true, | |
f321dcb5 PB |
337 | }; |
338 | ||
bbc02b90 KW |
339 | void block_job_remove_all_bdrv(BlockJob *job) |
340 | { | |
341 | GSList *l; | |
342 | for (l = job->nodes; l; l = l->next) { | |
343 | BdrvChild *c = l->data; | |
344 | bdrv_op_unblock_all(c->bs, job->blocker); | |
345 | bdrv_root_unref_child(c); | |
346 | } | |
347 | g_slist_free(job->nodes); | |
348 | job->nodes = NULL; | |
349 | } | |
350 | ||
76d554e2 KW |
351 | int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, |
352 | uint64_t perm, uint64_t shared_perm, Error **errp) | |
23d402d4 | 353 | { |
76d554e2 KW |
354 | BdrvChild *c; |
355 | ||
356 | c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm, | |
357 | job, errp); | |
358 | if (c == NULL) { | |
359 | return -EPERM; | |
360 | } | |
361 | ||
362 | job->nodes = g_slist_prepend(job->nodes, c); | |
23d402d4 AG |
363 | bdrv_ref(bs); |
364 | bdrv_op_block_all(bs, job->blocker); | |
76d554e2 KW |
365 | |
366 | return 0; | |
23d402d4 AG |
367 | } |
368 | ||
559b935f JS |
369 | bool block_job_is_internal(BlockJob *job) |
370 | { | |
33e9e9bd | 371 | return (job->job.id == NULL); |
559b935f JS |
372 | } |
373 | ||
5ccac6f1 JS |
374 | static bool block_job_started(BlockJob *job) |
375 | { | |
376 | return job->co; | |
377 | } | |
378 | ||
bd21935b KW |
379 | const BlockJobDriver *block_job_driver(BlockJob *job) |
380 | { | |
381 | return job->driver; | |
382 | } | |
383 | ||
e3796a24 JS |
384 | /** |
385 | * All jobs must allow a pause point before entering their job proper. This | |
386 | * ensures that jobs can be paused prior to being started, then resumed later. | |
387 | */ | |
388 | static void coroutine_fn block_job_co_entry(void *opaque) | |
389 | { | |
390 | BlockJob *job = opaque; | |
391 | ||
392 | assert(job && job->driver && job->driver->start); | |
393 | block_job_pause_point(job); | |
394 | job->driver->start(job); | |
395 | } | |
396 | ||
fc24908e PB |
397 | static void block_job_sleep_timer_cb(void *opaque) |
398 | { | |
399 | BlockJob *job = opaque; | |
400 | ||
401 | block_job_enter(job); | |
402 | } | |
403 | ||
5ccac6f1 JS |
404 | void block_job_start(BlockJob *job) |
405 | { | |
406 | assert(job && !block_job_started(job) && job->paused && | |
e3796a24 JS |
407 | job->driver && job->driver->start); |
408 | job->co = qemu_coroutine_create(block_job_co_entry, job); | |
409 | job->pause_count--; | |
410 | job->busy = true; | |
411 | job->paused = false; | |
c9de4050 | 412 | block_job_state_transition(job, BLOCK_JOB_STATUS_RUNNING); |
aef4278c | 413 | bdrv_coroutine_enter(blk_bs(job->blk), job->co); |
5ccac6f1 JS |
414 | } |
415 | ||
3925cd3b JS |
416 | static void block_job_decommission(BlockJob *job) |
417 | { | |
418 | assert(job); | |
419 | job->completed = true; | |
420 | job->busy = false; | |
421 | job->paused = false; | |
422 | job->deferred_to_main_loop = true; | |
a865cebb | 423 | block_job_txn_del_job(job); |
3925cd3b JS |
424 | block_job_state_transition(job, BLOCK_JOB_STATUS_NULL); |
425 | block_job_unref(job); | |
426 | } | |
427 | ||
75f71059 JS |
428 | static void block_job_do_dismiss(BlockJob *job) |
429 | { | |
430 | block_job_decommission(job); | |
431 | } | |
432 | ||
e0cf0364 JS |
433 | static void block_job_conclude(BlockJob *job) |
434 | { | |
435 | block_job_state_transition(job, BLOCK_JOB_STATUS_CONCLUDED); | |
75f71059 JS |
436 | if (job->auto_dismiss || !block_job_started(job)) { |
437 | block_job_do_dismiss(job); | |
438 | } | |
e0cf0364 JS |
439 | } |
440 | ||
35d6b368 JS |
441 | static void block_job_update_rc(BlockJob *job) |
442 | { | |
443 | if (!job->ret && block_job_is_cancelled(job)) { | |
444 | job->ret = -ECANCELED; | |
445 | } | |
446 | if (job->ret) { | |
447 | block_job_state_transition(job, BLOCK_JOB_STATUS_ABORTING); | |
448 | } | |
449 | } | |
450 | ||
2da4617a JS |
451 | static int block_job_prepare(BlockJob *job) |
452 | { | |
453 | if (job->ret == 0 && job->driver->prepare) { | |
454 | job->ret = job->driver->prepare(job); | |
455 | } | |
456 | return job->ret; | |
457 | } | |
458 | ||
43628d93 JS |
459 | static void block_job_commit(BlockJob *job) |
460 | { | |
461 | assert(!job->ret); | |
462 | if (job->driver->commit) { | |
463 | job->driver->commit(job); | |
464 | } | |
465 | } | |
466 | ||
467 | static void block_job_abort(BlockJob *job) | |
468 | { | |
469 | assert(job->ret); | |
470 | if (job->driver->abort) { | |
471 | job->driver->abort(job); | |
472 | } | |
473 | } | |
474 | ||
475 | static void block_job_clean(BlockJob *job) | |
476 | { | |
477 | if (job->driver->clean) { | |
478 | job->driver->clean(job); | |
479 | } | |
480 | } | |
481 | ||
11b61fbc | 482 | static int block_job_finalize_single(BlockJob *job) |
c55a832f | 483 | { |
4fb588e9 PB |
484 | assert(job->completed); |
485 | ||
35d6b368 JS |
486 | /* Ensure abort is called for late-transactional failures */ |
487 | block_job_update_rc(job); | |
10a3fbb0 | 488 | |
c55a832f | 489 | if (!job->ret) { |
43628d93 | 490 | block_job_commit(job); |
c55a832f | 491 | } else { |
43628d93 | 492 | block_job_abort(job); |
e8a40bf7 | 493 | } |
43628d93 | 494 | block_job_clean(job); |
8254b6d9 JS |
495 | |
496 | if (job->cb) { | |
497 | job->cb(job->opaque, job->ret); | |
498 | } | |
5ccac6f1 JS |
499 | |
500 | /* Emit events only if we actually started */ | |
501 | if (block_job_started(job)) { | |
502 | if (block_job_is_cancelled(job)) { | |
503 | block_job_event_cancelled(job); | |
504 | } else { | |
505 | const char *msg = NULL; | |
506 | if (job->ret < 0) { | |
507 | msg = strerror(-job->ret); | |
508 | } | |
509 | block_job_event_completed(job, msg); | |
8254b6d9 | 510 | } |
8254b6d9 JS |
511 | } |
512 | ||
a865cebb | 513 | block_job_txn_del_job(job); |
e0cf0364 | 514 | block_job_conclude(job); |
2da4617a | 515 | return 0; |
c55a832f FZ |
516 | } |
517 | ||
b76e4458 | 518 | static void block_job_cancel_async(BlockJob *job, bool force) |
4c241cf5 PB |
519 | { |
520 | if (job->iostatus != BLOCK_DEVICE_IO_STATUS_OK) { | |
521 | block_job_iostatus_reset(job); | |
522 | } | |
523 | if (job->user_paused) { | |
524 | /* Do not call block_job_enter here, the caller will handle it. */ | |
525 | job->user_paused = false; | |
526 | job->pause_count--; | |
527 | } | |
528 | job->cancelled = true; | |
b76e4458 LL |
529 | /* To prevent 'force == false' overriding a previous 'force == true' */ |
530 | job->force |= force; | |
4c241cf5 PB |
531 | } |
532 | ||
5f241594 | 533 | static int block_job_txn_apply(BlockJobTxn *txn, int fn(BlockJob *), bool lock) |
efe4d4b7 JS |
534 | { |
535 | AioContext *ctx; | |
536 | BlockJob *job, *next; | |
2da4617a | 537 | int rc = 0; |
efe4d4b7 JS |
538 | |
539 | QLIST_FOREACH_SAFE(job, &txn->jobs, txn_list, next) { | |
5f241594 JS |
540 | if (lock) { |
541 | ctx = blk_get_aio_context(job->blk); | |
542 | aio_context_acquire(ctx); | |
543 | } | |
2da4617a | 544 | rc = fn(job); |
5f241594 JS |
545 | if (lock) { |
546 | aio_context_release(ctx); | |
547 | } | |
2da4617a JS |
548 | if (rc) { |
549 | break; | |
550 | } | |
efe4d4b7 | 551 | } |
2da4617a | 552 | return rc; |
efe4d4b7 JS |
553 | } |
554 | ||
c8ab5c2d PB |
555 | static int block_job_finish_sync(BlockJob *job, |
556 | void (*finish)(BlockJob *, Error **errp), | |
557 | Error **errp) | |
558 | { | |
559 | Error *local_err = NULL; | |
560 | int ret; | |
561 | ||
562 | assert(blk_bs(job->blk)->job == job); | |
563 | ||
564 | block_job_ref(job); | |
565 | ||
4fb588e9 PB |
566 | if (finish) { |
567 | finish(job, &local_err); | |
568 | } | |
c8ab5c2d PB |
569 | if (local_err) { |
570 | error_propagate(errp, local_err); | |
571 | block_job_unref(job); | |
572 | return -EBUSY; | |
573 | } | |
574 | /* block_job_drain calls block_job_enter, and it should be enough to | |
575 | * induce progress until the job completes or moves to the main thread. | |
576 | */ | |
577 | while (!job->deferred_to_main_loop && !job->completed) { | |
578 | block_job_drain(job); | |
579 | } | |
580 | while (!job->completed) { | |
581 | aio_poll(qemu_get_aio_context(), true); | |
582 | } | |
583 | ret = (job->cancelled && job->ret == 0) ? -ECANCELED : job->ret; | |
584 | block_job_unref(job); | |
585 | return ret; | |
586 | } | |
587 | ||
c55a832f FZ |
588 | static void block_job_completed_txn_abort(BlockJob *job) |
589 | { | |
590 | AioContext *ctx; | |
591 | BlockJobTxn *txn = job->txn; | |
4fb588e9 | 592 | BlockJob *other_job; |
c55a832f FZ |
593 | |
594 | if (txn->aborting) { | |
595 | /* | |
596 | * We are cancelled by another job, which will handle everything. | |
597 | */ | |
598 | return; | |
599 | } | |
600 | txn->aborting = true; | |
4fb588e9 PB |
601 | block_job_txn_ref(txn); |
602 | ||
c55a832f FZ |
603 | /* We are the first failed job. Cancel other jobs. */ |
604 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { | |
b6d2e599 | 605 | ctx = blk_get_aio_context(other_job->blk); |
c55a832f FZ |
606 | aio_context_acquire(ctx); |
607 | } | |
4fb588e9 PB |
608 | |
609 | /* Other jobs are effectively cancelled by us, set the status for | |
610 | * them; this job, however, may or may not be cancelled, depending | |
611 | * on the caller, so leave it. */ | |
c55a832f | 612 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { |
4fb588e9 | 613 | if (other_job != job) { |
b76e4458 | 614 | block_job_cancel_async(other_job, false); |
c55a832f | 615 | } |
c55a832f | 616 | } |
4fb588e9 PB |
617 | while (!QLIST_EMPTY(&txn->jobs)) { |
618 | other_job = QLIST_FIRST(&txn->jobs); | |
b6d2e599 | 619 | ctx = blk_get_aio_context(other_job->blk); |
4fb588e9 PB |
620 | if (!other_job->completed) { |
621 | assert(other_job->cancelled); | |
622 | block_job_finish_sync(other_job, NULL, NULL); | |
623 | } | |
11b61fbc | 624 | block_job_finalize_single(other_job); |
c55a832f FZ |
625 | aio_context_release(ctx); |
626 | } | |
4fb588e9 PB |
627 | |
628 | block_job_txn_unref(txn); | |
c55a832f FZ |
629 | } |
630 | ||
11b61fbc JS |
631 | static int block_job_needs_finalize(BlockJob *job) |
632 | { | |
633 | return !job->auto_finalize; | |
634 | } | |
635 | ||
636 | static void block_job_do_finalize(BlockJob *job) | |
637 | { | |
638 | int rc; | |
639 | assert(job && job->txn); | |
640 | ||
641 | /* prepare the transaction to complete */ | |
642 | rc = block_job_txn_apply(job->txn, block_job_prepare, true); | |
643 | if (rc) { | |
644 | block_job_completed_txn_abort(job); | |
645 | } else { | |
646 | block_job_txn_apply(job->txn, block_job_finalize_single, true); | |
647 | } | |
648 | } | |
649 | ||
c55a832f FZ |
650 | static void block_job_completed_txn_success(BlockJob *job) |
651 | { | |
c55a832f | 652 | BlockJobTxn *txn = job->txn; |
efe4d4b7 | 653 | BlockJob *other_job; |
2da4617a | 654 | |
e8af5686 JS |
655 | block_job_state_transition(job, BLOCK_JOB_STATUS_WAITING); |
656 | ||
c55a832f FZ |
657 | /* |
658 | * Successful completion, see if there are other running jobs in this | |
659 | * txn. | |
660 | */ | |
661 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { | |
662 | if (!other_job->completed) { | |
663 | return; | |
664 | } | |
c55a832f | 665 | assert(other_job->ret == 0); |
c55a832f | 666 | } |
2da4617a | 667 | |
5f241594 | 668 | block_job_txn_apply(txn, block_job_event_pending, false); |
11b61fbc JS |
669 | |
670 | /* If no jobs need manual finalization, automatically do so */ | |
671 | if (block_job_txn_apply(txn, block_job_needs_finalize, false) == 0) { | |
672 | block_job_do_finalize(job); | |
673 | } | |
c55a832f FZ |
674 | } |
675 | ||
2f0c9fe6 PB |
676 | void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) |
677 | { | |
aa9ef2e6 | 678 | int64_t old_speed = job->speed; |
2f0c9fe6 | 679 | |
0ec4dfb8 JS |
680 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_SET_SPEED, errp)) { |
681 | return; | |
682 | } | |
18bb6928 KW |
683 | if (speed < 0) { |
684 | error_setg(errp, QERR_INVALID_PARAMETER, "speed"); | |
2f0c9fe6 PB |
685 | return; |
686 | } | |
687 | ||
18bb6928 KW |
688 | ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); |
689 | ||
2f0c9fe6 | 690 | job->speed = speed; |
d4fce188 | 691 | if (speed && speed <= old_speed) { |
aa9ef2e6 JS |
692 | return; |
693 | } | |
694 | ||
695 | /* kick only if a timer is pending */ | |
696 | block_job_enter_cond(job, block_job_timer_pending); | |
2f0c9fe6 PB |
697 | } |
698 | ||
dee81d51 KW |
699 | int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) |
700 | { | |
701 | if (!job->speed) { | |
702 | return 0; | |
703 | } | |
704 | ||
705 | return ratelimit_calculate_delay(&job->limit, n); | |
706 | } | |
707 | ||
aeae883b PB |
708 | void block_job_complete(BlockJob *job, Error **errp) |
709 | { | |
559b935f | 710 | /* Should not be reachable via external interface for internal jobs */ |
33e9e9bd | 711 | assert(job->job.id); |
0ec4dfb8 JS |
712 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_COMPLETE, errp)) { |
713 | return; | |
714 | } | |
715 | if (job->pause_count || job->cancelled || !job->driver->complete) { | |
9df229c3 | 716 | error_setg(errp, "The active block job '%s' cannot be completed", |
33e9e9bd | 717 | job->job.id); |
aeae883b PB |
718 | return; |
719 | } | |
720 | ||
3fc4b10a | 721 | job->driver->complete(job, errp); |
aeae883b PB |
722 | } |
723 | ||
11b61fbc JS |
724 | void block_job_finalize(BlockJob *job, Error **errp) |
725 | { | |
33e9e9bd | 726 | assert(job && job->job.id); |
11b61fbc JS |
727 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_FINALIZE, errp)) { |
728 | return; | |
729 | } | |
730 | block_job_do_finalize(job); | |
731 | } | |
732 | ||
75f71059 JS |
733 | void block_job_dismiss(BlockJob **jobptr, Error **errp) |
734 | { | |
735 | BlockJob *job = *jobptr; | |
736 | /* similarly to _complete, this is QMP-interface only. */ | |
33e9e9bd | 737 | assert(job->job.id); |
75f71059 JS |
738 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_DISMISS, errp)) { |
739 | return; | |
740 | } | |
741 | ||
742 | block_job_do_dismiss(job); | |
743 | *jobptr = NULL; | |
744 | } | |
745 | ||
0ec4dfb8 | 746 | void block_job_user_pause(BlockJob *job, Error **errp) |
0df4ba58 | 747 | { |
0ec4dfb8 JS |
748 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_PAUSE, errp)) { |
749 | return; | |
750 | } | |
751 | if (job->user_paused) { | |
752 | error_setg(errp, "Job is already paused"); | |
753 | return; | |
754 | } | |
0df4ba58 JS |
755 | job->user_paused = true; |
756 | block_job_pause(job); | |
757 | } | |
758 | ||
0df4ba58 JS |
759 | bool block_job_user_paused(BlockJob *job) |
760 | { | |
6573d9c6 | 761 | return job->user_paused; |
0df4ba58 JS |
762 | } |
763 | ||
0ec4dfb8 | 764 | void block_job_user_resume(BlockJob *job, Error **errp) |
0df4ba58 | 765 | { |
0ec4dfb8 JS |
766 | assert(job); |
767 | if (!job->user_paused || job->pause_count <= 0) { | |
768 | error_setg(errp, "Can't resume a job that was not paused"); | |
769 | return; | |
0df4ba58 | 770 | } |
0ec4dfb8 JS |
771 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_RESUME, errp)) { |
772 | return; | |
773 | } | |
774 | block_job_iostatus_reset(job); | |
775 | job->user_paused = false; | |
776 | block_job_resume(job); | |
0df4ba58 JS |
777 | } |
778 | ||
b76e4458 | 779 | void block_job_cancel(BlockJob *job, bool force) |
8acc72a4 | 780 | { |
e0cf0364 | 781 | if (job->status == BLOCK_JOB_STATUS_CONCLUDED) { |
75f71059 | 782 | block_job_do_dismiss(job); |
11b61fbc JS |
783 | return; |
784 | } | |
b76e4458 | 785 | block_job_cancel_async(job, force); |
11b61fbc | 786 | if (!block_job_started(job)) { |
5ccac6f1 | 787 | block_job_completed(job, -ECANCELED); |
11b61fbc JS |
788 | } else if (job->deferred_to_main_loop) { |
789 | block_job_completed_txn_abort(job); | |
790 | } else { | |
791 | block_job_enter(job); | |
5ccac6f1 | 792 | } |
8acc72a4 PB |
793 | } |
794 | ||
b76e4458 | 795 | void block_job_user_cancel(BlockJob *job, bool force, Error **errp) |
0ec4dfb8 JS |
796 | { |
797 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_CANCEL, errp)) { | |
798 | return; | |
799 | } | |
b76e4458 | 800 | block_job_cancel(job, force); |
0ec4dfb8 JS |
801 | } |
802 | ||
345f9e1b HR |
803 | /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be |
804 | * used with block_job_finish_sync() without the need for (rather nasty) | |
805 | * function pointer casts there. */ | |
806 | static void block_job_cancel_err(BlockJob *job, Error **errp) | |
807 | { | |
b76e4458 | 808 | block_job_cancel(job, false); |
345f9e1b HR |
809 | } |
810 | ||
811 | int block_job_cancel_sync(BlockJob *job) | |
812 | { | |
813 | return block_job_finish_sync(job, &block_job_cancel_err, NULL); | |
814 | } | |
815 | ||
a1a2af07 KW |
816 | void block_job_cancel_sync_all(void) |
817 | { | |
818 | BlockJob *job; | |
819 | AioContext *aio_context; | |
820 | ||
e7c1d78b | 821 | while ((job = block_job_next(NULL))) { |
b6d2e599 | 822 | aio_context = blk_get_aio_context(job->blk); |
a1a2af07 KW |
823 | aio_context_acquire(aio_context); |
824 | block_job_cancel_sync(job); | |
825 | aio_context_release(aio_context); | |
826 | } | |
827 | } | |
828 | ||
345f9e1b HR |
829 | int block_job_complete_sync(BlockJob *job, Error **errp) |
830 | { | |
831 | return block_job_finish_sync(job, &block_job_complete, errp); | |
832 | } | |
833 | ||
05df8a6a KW |
834 | void block_job_progress_update(BlockJob *job, uint64_t done) |
835 | { | |
836 | job->offset += done; | |
837 | } | |
838 | ||
839 | void block_job_progress_set_remaining(BlockJob *job, uint64_t remaining) | |
840 | { | |
841 | job->len = job->offset + remaining; | |
842 | } | |
843 | ||
559b935f | 844 | BlockJobInfo *block_job_query(BlockJob *job, Error **errp) |
30e628b7 | 845 | { |
559b935f JS |
846 | BlockJobInfo *info; |
847 | ||
848 | if (block_job_is_internal(job)) { | |
849 | error_setg(errp, "Cannot query QEMU internal jobs"); | |
850 | return NULL; | |
851 | } | |
852 | info = g_new0(BlockJobInfo, 1); | |
252291ea | 853 | info->type = g_strdup(job_type_str(&job->job)); |
33e9e9bd | 854 | info->device = g_strdup(job->job.id); |
32c81a4a | 855 | info->len = job->len; |
fc24908e | 856 | info->busy = atomic_read(&job->busy); |
751ebd76 | 857 | info->paused = job->pause_count > 0; |
32c81a4a PB |
858 | info->offset = job->offset; |
859 | info->speed = job->speed; | |
860 | info->io_status = job->iostatus; | |
ef6dbf1e | 861 | info->ready = job->ready; |
58b295ba | 862 | info->status = job->status; |
b40dacdc JS |
863 | info->auto_finalize = job->auto_finalize; |
864 | info->auto_dismiss = job->auto_dismiss; | |
ab9ba614 JS |
865 | info->has_error = job->ret != 0; |
866 | info->error = job->ret ? g_strdup(strerror(-job->ret)) : NULL; | |
30e628b7 PB |
867 | return info; |
868 | } | |
32c81a4a PB |
869 | |
870 | static void block_job_iostatus_set_err(BlockJob *job, int error) | |
871 | { | |
872 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { | |
873 | job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : | |
874 | BLOCK_DEVICE_IO_STATUS_FAILED; | |
875 | } | |
876 | } | |
877 | ||
8254b6d9 | 878 | static void block_job_event_cancelled(BlockJob *job) |
bcada37b | 879 | { |
559b935f JS |
880 | if (block_job_is_internal(job)) { |
881 | return; | |
882 | } | |
883 | ||
252291ea | 884 | qapi_event_send_block_job_cancelled(job_type(&job->job), |
33e9e9bd | 885 | job->job.id, |
bcada37b WX |
886 | job->len, |
887 | job->offset, | |
888 | job->speed, | |
889 | &error_abort); | |
890 | } | |
32c81a4a | 891 | |
8254b6d9 | 892 | static void block_job_event_completed(BlockJob *job, const char *msg) |
a66a2a36 | 893 | { |
559b935f JS |
894 | if (block_job_is_internal(job)) { |
895 | return; | |
896 | } | |
897 | ||
252291ea | 898 | qapi_event_send_block_job_completed(job_type(&job->job), |
33e9e9bd | 899 | job->job.id, |
bcada37b WX |
900 | job->len, |
901 | job->offset, | |
902 | job->speed, | |
903 | !!msg, | |
904 | msg, | |
905 | &error_abort); | |
a66a2a36 PB |
906 | } |
907 | ||
5f241594 JS |
908 | static int block_job_event_pending(BlockJob *job) |
909 | { | |
910 | block_job_state_transition(job, BLOCK_JOB_STATUS_PENDING); | |
911 | if (!job->auto_finalize && !block_job_is_internal(job)) { | |
252291ea | 912 | qapi_event_send_block_job_pending(job_type(&job->job), |
33e9e9bd | 913 | job->job.id, |
5f241594 JS |
914 | &error_abort); |
915 | } | |
916 | return 0; | |
917 | } | |
918 | ||
88691b37 PB |
919 | /* |
920 | * API for block job drivers and the block layer. These functions are | |
921 | * declared in blockjob_int.h. | |
922 | */ | |
923 | ||
924 | void *block_job_create(const char *job_id, const BlockJobDriver *driver, | |
75859b94 | 925 | BlockJobTxn *txn, BlockDriverState *bs, uint64_t perm, |
88691b37 PB |
926 | uint64_t shared_perm, int64_t speed, int flags, |
927 | BlockCompletionFunc *cb, void *opaque, Error **errp) | |
928 | { | |
929 | BlockBackend *blk; | |
930 | BlockJob *job; | |
931 | int ret; | |
932 | ||
933 | if (bs->job) { | |
934 | error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); | |
935 | return NULL; | |
936 | } | |
937 | ||
938 | if (job_id == NULL && !(flags & BLOCK_JOB_INTERNAL)) { | |
939 | job_id = bdrv_get_device_name(bs); | |
940 | if (!*job_id) { | |
941 | error_setg(errp, "An explicit job ID is required for this node"); | |
942 | return NULL; | |
943 | } | |
944 | } | |
945 | ||
946 | if (job_id) { | |
947 | if (flags & BLOCK_JOB_INTERNAL) { | |
948 | error_setg(errp, "Cannot specify job ID for internal block job"); | |
949 | return NULL; | |
950 | } | |
88691b37 PB |
951 | } |
952 | ||
953 | blk = blk_new(perm, shared_perm); | |
954 | ret = blk_insert_bs(blk, bs, errp); | |
955 | if (ret < 0) { | |
956 | blk_unref(blk); | |
957 | return NULL; | |
958 | } | |
959 | ||
33e9e9bd KW |
960 | job = job_create(job_id, &driver->job_driver, errp); |
961 | if (job == NULL) { | |
962 | blk_unref(blk); | |
963 | return NULL; | |
964 | } | |
965 | ||
e7c1d78b KW |
966 | assert(is_block_job(&job->job)); |
967 | ||
88691b37 | 968 | job->driver = driver; |
88691b37 PB |
969 | job->blk = blk; |
970 | job->cb = cb; | |
971 | job->opaque = opaque; | |
972 | job->busy = false; | |
973 | job->paused = true; | |
974 | job->pause_count = 1; | |
975 | job->refcnt = 1; | |
5f241594 | 976 | job->auto_finalize = !(flags & BLOCK_JOB_MANUAL_FINALIZE); |
75f71059 | 977 | job->auto_dismiss = !(flags & BLOCK_JOB_MANUAL_DISMISS); |
c9de4050 | 978 | block_job_state_transition(job, BLOCK_JOB_STATUS_CREATED); |
fc24908e PB |
979 | aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, |
980 | QEMU_CLOCK_REALTIME, SCALE_NS, | |
981 | block_job_sleep_timer_cb, job); | |
88691b37 PB |
982 | |
983 | error_setg(&job->blocker, "block device is in use by block job: %s", | |
252291ea | 984 | job_type_str(&job->job)); |
88691b37 PB |
985 | block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); |
986 | bs->job = job; | |
987 | ||
88691b37 PB |
988 | bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); |
989 | ||
88691b37 PB |
990 | blk_add_aio_context_notifier(blk, block_job_attached_aio_context, |
991 | block_job_detach_aio_context, job); | |
992 | ||
993 | /* Only set speed when necessary to avoid NotSupported error */ | |
994 | if (speed != 0) { | |
995 | Error *local_err = NULL; | |
996 | ||
997 | block_job_set_speed(job, speed, &local_err); | |
998 | if (local_err) { | |
3925cd3b | 999 | block_job_early_fail(job); |
88691b37 PB |
1000 | error_propagate(errp, local_err); |
1001 | return NULL; | |
1002 | } | |
1003 | } | |
75859b94 JS |
1004 | |
1005 | /* Single jobs are modeled as single-job transactions for sake of | |
1006 | * consolidating the job management logic */ | |
1007 | if (!txn) { | |
1008 | txn = block_job_txn_new(); | |
1009 | block_job_txn_add_job(txn, job); | |
1010 | block_job_txn_unref(txn); | |
1011 | } else { | |
1012 | block_job_txn_add_job(txn, job); | |
1013 | } | |
1014 | ||
88691b37 PB |
1015 | return job; |
1016 | } | |
1017 | ||
88691b37 PB |
1018 | void block_job_early_fail(BlockJob *job) |
1019 | { | |
3925cd3b JS |
1020 | assert(job->status == BLOCK_JOB_STATUS_CREATED); |
1021 | block_job_decommission(job); | |
88691b37 PB |
1022 | } |
1023 | ||
1024 | void block_job_completed(BlockJob *job, int ret) | |
1025 | { | |
75859b94 | 1026 | assert(job && job->txn && !job->completed); |
88691b37 | 1027 | assert(blk_bs(job->blk)->job == job); |
88691b37 PB |
1028 | job->completed = true; |
1029 | job->ret = ret; | |
35d6b368 JS |
1030 | block_job_update_rc(job); |
1031 | trace_block_job_completed(job, ret, job->ret); | |
1032 | if (job->ret) { | |
88691b37 PB |
1033 | block_job_completed_txn_abort(job); |
1034 | } else { | |
1035 | block_job_completed_txn_success(job); | |
1036 | } | |
1037 | } | |
1038 | ||
1039 | static bool block_job_should_pause(BlockJob *job) | |
1040 | { | |
1041 | return job->pause_count > 0; | |
1042 | } | |
1043 | ||
fc24908e PB |
1044 | /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. |
1045 | * Reentering the job coroutine with block_job_enter() before the timer has | |
1046 | * expired is allowed and cancels the timer. | |
1047 | * | |
1048 | * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be | |
1049 | * called explicitly. */ | |
1050 | static void block_job_do_yield(BlockJob *job, uint64_t ns) | |
356f59b8 | 1051 | { |
fc24908e PB |
1052 | block_job_lock(); |
1053 | if (ns != -1) { | |
1054 | timer_mod(&job->sleep_timer, ns); | |
1055 | } | |
356f59b8 | 1056 | job->busy = false; |
fc24908e | 1057 | block_job_unlock(); |
356f59b8 PB |
1058 | qemu_coroutine_yield(); |
1059 | ||
1060 | /* Set by block_job_enter before re-entering the coroutine. */ | |
1061 | assert(job->busy); | |
1062 | } | |
1063 | ||
88691b37 PB |
1064 | void coroutine_fn block_job_pause_point(BlockJob *job) |
1065 | { | |
1066 | assert(job && block_job_started(job)); | |
1067 | ||
1068 | if (!block_job_should_pause(job)) { | |
1069 | return; | |
1070 | } | |
1071 | if (block_job_is_cancelled(job)) { | |
1072 | return; | |
1073 | } | |
1074 | ||
1075 | if (job->driver->pause) { | |
1076 | job->driver->pause(job); | |
1077 | } | |
1078 | ||
1079 | if (block_job_should_pause(job) && !block_job_is_cancelled(job)) { | |
58b295ba | 1080 | BlockJobStatus status = job->status; |
c9de4050 JS |
1081 | block_job_state_transition(job, status == BLOCK_JOB_STATUS_READY ? \ |
1082 | BLOCK_JOB_STATUS_STANDBY : \ | |
1083 | BLOCK_JOB_STATUS_PAUSED); | |
88691b37 | 1084 | job->paused = true; |
fc24908e | 1085 | block_job_do_yield(job, -1); |
88691b37 | 1086 | job->paused = false; |
c9de4050 | 1087 | block_job_state_transition(job, status); |
88691b37 PB |
1088 | } |
1089 | ||
1090 | if (job->driver->resume) { | |
1091 | job->driver->resume(job); | |
1092 | } | |
1093 | } | |
1094 | ||
aa9ef2e6 JS |
1095 | /* |
1096 | * Conditionally enter a block_job pending a call to fn() while | |
1097 | * under the block_job_lock critical section. | |
1098 | */ | |
1099 | static void block_job_enter_cond(BlockJob *job, bool(*fn)(BlockJob *job)) | |
88691b37 | 1100 | { |
eb05e011 PB |
1101 | if (!block_job_started(job)) { |
1102 | return; | |
1103 | } | |
1104 | if (job->deferred_to_main_loop) { | |
1105 | return; | |
1106 | } | |
1107 | ||
fc24908e | 1108 | block_job_lock(); |
356f59b8 | 1109 | if (job->busy) { |
fc24908e | 1110 | block_job_unlock(); |
356f59b8 | 1111 | return; |
88691b37 | 1112 | } |
356f59b8 | 1113 | |
aa9ef2e6 JS |
1114 | if (fn && !fn(job)) { |
1115 | block_job_unlock(); | |
1116 | return; | |
1117 | } | |
1118 | ||
fc24908e PB |
1119 | assert(!job->deferred_to_main_loop); |
1120 | timer_del(&job->sleep_timer); | |
356f59b8 | 1121 | job->busy = true; |
fc24908e | 1122 | block_job_unlock(); |
356f59b8 | 1123 | aio_co_wake(job->co); |
88691b37 PB |
1124 | } |
1125 | ||
aa9ef2e6 JS |
1126 | void block_job_enter(BlockJob *job) |
1127 | { | |
1128 | block_job_enter_cond(job, NULL); | |
1129 | } | |
1130 | ||
88691b37 PB |
1131 | bool block_job_is_cancelled(BlockJob *job) |
1132 | { | |
1133 | return job->cancelled; | |
1134 | } | |
1135 | ||
5bf1d5a7 | 1136 | void block_job_sleep_ns(BlockJob *job, int64_t ns) |
88691b37 PB |
1137 | { |
1138 | assert(job->busy); | |
1139 | ||
1140 | /* Check cancellation *before* setting busy = false, too! */ | |
1141 | if (block_job_is_cancelled(job)) { | |
1142 | return; | |
1143 | } | |
1144 | ||
88691b37 | 1145 | if (!block_job_should_pause(job)) { |
fc24908e | 1146 | block_job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); |
88691b37 | 1147 | } |
88691b37 PB |
1148 | |
1149 | block_job_pause_point(job); | |
1150 | } | |
1151 | ||
1152 | void block_job_yield(BlockJob *job) | |
1153 | { | |
1154 | assert(job->busy); | |
1155 | ||
1156 | /* Check cancellation *before* setting busy = false, too! */ | |
1157 | if (block_job_is_cancelled(job)) { | |
1158 | return; | |
1159 | } | |
1160 | ||
88691b37 | 1161 | if (!block_job_should_pause(job)) { |
fc24908e | 1162 | block_job_do_yield(job, -1); |
88691b37 | 1163 | } |
88691b37 PB |
1164 | |
1165 | block_job_pause_point(job); | |
1166 | } | |
1167 | ||
2caf63a9 PB |
1168 | void block_job_iostatus_reset(BlockJob *job) |
1169 | { | |
4c241cf5 PB |
1170 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { |
1171 | return; | |
1172 | } | |
1173 | assert(job->user_paused && job->pause_count > 0); | |
2caf63a9 PB |
1174 | job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; |
1175 | } | |
1176 | ||
bcada37b | 1177 | void block_job_event_ready(BlockJob *job) |
a66a2a36 | 1178 | { |
c9de4050 | 1179 | block_job_state_transition(job, BLOCK_JOB_STATUS_READY); |
ef6dbf1e HR |
1180 | job->ready = true; |
1181 | ||
559b935f JS |
1182 | if (block_job_is_internal(job)) { |
1183 | return; | |
1184 | } | |
1185 | ||
252291ea | 1186 | qapi_event_send_block_job_ready(job_type(&job->job), |
33e9e9bd | 1187 | job->job.id, |
518848a2 MA |
1188 | job->len, |
1189 | job->offset, | |
1190 | job->speed, &error_abort); | |
a66a2a36 PB |
1191 | } |
1192 | ||
81e254dc | 1193 | BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, |
32c81a4a PB |
1194 | int is_read, int error) |
1195 | { | |
1196 | BlockErrorAction action; | |
1197 | ||
1198 | switch (on_err) { | |
1199 | case BLOCKDEV_ON_ERROR_ENOSPC: | |
8c398252 | 1200 | case BLOCKDEV_ON_ERROR_AUTO: |
a589569f WX |
1201 | action = (error == ENOSPC) ? |
1202 | BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; | |
32c81a4a PB |
1203 | break; |
1204 | case BLOCKDEV_ON_ERROR_STOP: | |
a589569f | 1205 | action = BLOCK_ERROR_ACTION_STOP; |
32c81a4a PB |
1206 | break; |
1207 | case BLOCKDEV_ON_ERROR_REPORT: | |
a589569f | 1208 | action = BLOCK_ERROR_ACTION_REPORT; |
32c81a4a PB |
1209 | break; |
1210 | case BLOCKDEV_ON_ERROR_IGNORE: | |
a589569f | 1211 | action = BLOCK_ERROR_ACTION_IGNORE; |
32c81a4a PB |
1212 | break; |
1213 | default: | |
1214 | abort(); | |
1215 | } | |
559b935f | 1216 | if (!block_job_is_internal(job)) { |
33e9e9bd | 1217 | qapi_event_send_block_job_error(job->job.id, |
559b935f JS |
1218 | is_read ? IO_OPERATION_TYPE_READ : |
1219 | IO_OPERATION_TYPE_WRITE, | |
1220 | action, &error_abort); | |
1221 | } | |
a589569f | 1222 | if (action == BLOCK_ERROR_ACTION_STOP) { |
0ec4dfb8 | 1223 | block_job_pause(job); |
751ebd76 | 1224 | /* make the pause user visible, which will be resumed from QMP. */ |
0ec4dfb8 | 1225 | job->user_paused = true; |
32c81a4a | 1226 | block_job_iostatus_set_err(job, error); |
32c81a4a PB |
1227 | } |
1228 | return action; | |
1229 | } | |
dec7d421 SH |
1230 | |
1231 | typedef struct { | |
1232 | BlockJob *job; | |
dec7d421 SH |
1233 | AioContext *aio_context; |
1234 | BlockJobDeferToMainLoopFn *fn; | |
1235 | void *opaque; | |
1236 | } BlockJobDeferToMainLoopData; | |
1237 | ||
1238 | static void block_job_defer_to_main_loop_bh(void *opaque) | |
1239 | { | |
1240 | BlockJobDeferToMainLoopData *data = opaque; | |
1241 | AioContext *aio_context; | |
1242 | ||
dec7d421 SH |
1243 | /* Prevent race with block_job_defer_to_main_loop() */ |
1244 | aio_context_acquire(data->aio_context); | |
1245 | ||
1246 | /* Fetch BDS AioContext again, in case it has changed */ | |
b6d2e599 | 1247 | aio_context = blk_get_aio_context(data->job->blk); |
d79df2a2 PB |
1248 | if (aio_context != data->aio_context) { |
1249 | aio_context_acquire(aio_context); | |
1250 | } | |
dec7d421 SH |
1251 | |
1252 | data->fn(data->job, data->opaque); | |
1253 | ||
d79df2a2 PB |
1254 | if (aio_context != data->aio_context) { |
1255 | aio_context_release(aio_context); | |
1256 | } | |
dec7d421 SH |
1257 | |
1258 | aio_context_release(data->aio_context); | |
1259 | ||
1260 | g_free(data); | |
1261 | } | |
1262 | ||
1263 | void block_job_defer_to_main_loop(BlockJob *job, | |
1264 | BlockJobDeferToMainLoopFn *fn, | |
1265 | void *opaque) | |
1266 | { | |
1267 | BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data)); | |
1268 | data->job = job; | |
b6d2e599 | 1269 | data->aio_context = blk_get_aio_context(job->blk); |
dec7d421 SH |
1270 | data->fn = fn; |
1271 | data->opaque = opaque; | |
794f0141 | 1272 | job->deferred_to_main_loop = true; |
dec7d421 | 1273 | |
fffb6e12 PB |
1274 | aio_bh_schedule_oneshot(qemu_get_aio_context(), |
1275 | block_job_defer_to_main_loop_bh, data); | |
dec7d421 | 1276 | } |