]> git.proxmox.com Git - mirror_qemu.git/blame - blockjob.c
Merge remote-tracking branch 'remotes/dgibson/tags/ppc-for-2.11-20171204' into staging
[mirror_qemu.git] / blockjob.c
CommitLineData
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"
373340b2 31#include "sysemu/block-backend.h"
cc7a8ea7 32#include "qapi/qmp/qerror.h"
7b1b5d19 33#include "qapi/qmp/qjson.h"
10817bf0 34#include "qemu/coroutine.h"
7f0317cf 35#include "qemu/id.h"
2f0c9fe6 36#include "qmp-commands.h"
1de7afc9 37#include "qemu/timer.h"
5a2d2cbd 38#include "qapi-event.h"
2f0c9fe6 39
fc24908e
PB
40/* Right now, this mutex is only needed to synchronize accesses to job->busy
41 * and job->sleep_timer, such as concurrent calls to block_job_do_yield and
42 * block_job_enter. */
43static QemuMutex block_job_mutex;
44
45static void block_job_lock(void)
46{
47 qemu_mutex_lock(&block_job_mutex);
48}
49
50static void block_job_unlock(void)
51{
52 qemu_mutex_unlock(&block_job_mutex);
53}
54
55static void __attribute__((__constructor__)) block_job_init(void)
56{
57 qemu_mutex_init(&block_job_mutex);
58}
59
8254b6d9
JS
60static void block_job_event_cancelled(BlockJob *job);
61static void block_job_event_completed(BlockJob *job, const char *msg);
62
c55a832f
FZ
63/* Transactional group of block jobs */
64struct BlockJobTxn {
65
66 /* Is this txn being cancelled? */
67 bool aborting;
68
69 /* List of jobs */
70 QLIST_HEAD(, BlockJob) jobs;
71
72 /* Reference count */
73 int refcnt;
74};
75
a7112795
AG
76static QLIST_HEAD(, BlockJob) block_jobs = QLIST_HEAD_INITIALIZER(block_jobs);
77
88691b37
PB
78/*
79 * The block job API is composed of two categories of functions.
80 *
81 * The first includes functions used by the monitor. The monitor is
82 * peculiar in that it accesses the block job list with block_job_get, and
83 * therefore needs consistency across block_job_get and the actual operation
84 * (e.g. block_job_set_speed). The consistency is achieved with
85 * aio_context_acquire/release. These functions are declared in blockjob.h.
86 *
87 * The second includes functions used by the block job drivers and sometimes
88 * by the core block layer. These do not care about locking, because the
89 * whole coroutine runs under the AioContext lock, and are declared in
90 * blockjob_int.h.
91 */
92
a7112795
AG
93BlockJob *block_job_next(BlockJob *job)
94{
95 if (!job) {
96 return QLIST_FIRST(&block_jobs);
97 }
98 return QLIST_NEXT(job, job_list);
99}
100
ffb1f10c
AG
101BlockJob *block_job_get(const char *id)
102{
103 BlockJob *job;
104
105 QLIST_FOREACH(job, &block_jobs, job_list) {
559b935f 106 if (job->id && !strcmp(id, job->id)) {
ffb1f10c
AG
107 return job;
108 }
109 }
110
111 return NULL;
112}
113
c8ab5c2d
PB
114BlockJobTxn *block_job_txn_new(void)
115{
116 BlockJobTxn *txn = g_new0(BlockJobTxn, 1);
117 QLIST_INIT(&txn->jobs);
118 txn->refcnt = 1;
119 return txn;
120}
121
122static void block_job_txn_ref(BlockJobTxn *txn)
123{
124 txn->refcnt++;
125}
126
127void block_job_txn_unref(BlockJobTxn *txn)
128{
129 if (txn && --txn->refcnt == 0) {
130 g_free(txn);
131 }
132}
133
134void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job)
135{
136 if (!txn) {
137 return;
138 }
139
140 assert(!job->txn);
141 job->txn = txn;
142
143 QLIST_INSERT_HEAD(&txn->jobs, job, txn_list);
144 block_job_txn_ref(txn);
145}
146
f321dcb5
PB
147static void block_job_pause(BlockJob *job)
148{
149 job->pause_count++;
150}
151
152static void block_job_resume(BlockJob *job)
153{
154 assert(job->pause_count > 0);
155 job->pause_count--;
156 if (job->pause_count) {
157 return;
158 }
159 block_job_enter(job);
160}
161
4172a003 162void block_job_ref(BlockJob *job)
05b0d8e3
PB
163{
164 ++job->refcnt;
165}
166
167static void block_job_attached_aio_context(AioContext *new_context,
168 void *opaque);
169static void block_job_detach_aio_context(void *opaque);
170
4172a003 171void block_job_unref(BlockJob *job)
05b0d8e3
PB
172{
173 if (--job->refcnt == 0) {
174 BlockDriverState *bs = blk_bs(job->blk);
0a3e155f 175 QLIST_REMOVE(job, job_list);
05b0d8e3
PB
176 bs->job = NULL;
177 block_job_remove_all_bdrv(job);
178 blk_remove_aio_context_notifier(job->blk,
179 block_job_attached_aio_context,
180 block_job_detach_aio_context, job);
181 blk_unref(job->blk);
182 error_free(job->blocker);
183 g_free(job->id);
fc24908e 184 assert(!timer_pending(&job->sleep_timer));
05b0d8e3
PB
185 g_free(job);
186 }
187}
188
463e0be1
SH
189static void block_job_attached_aio_context(AioContext *new_context,
190 void *opaque)
191{
192 BlockJob *job = opaque;
193
194 if (job->driver->attached_aio_context) {
195 job->driver->attached_aio_context(job, new_context);
196 }
197
198 block_job_resume(job);
199}
200
bae8196d
PB
201static void block_job_drain(BlockJob *job)
202{
203 /* If job is !job->busy this kicks it into the next pause point. */
204 block_job_enter(job);
205
206 blk_drain(job->blk);
207 if (job->driver->drain) {
208 job->driver->drain(job);
209 }
210}
211
463e0be1
SH
212static void block_job_detach_aio_context(void *opaque)
213{
214 BlockJob *job = opaque;
215
216 /* In case the job terminates during aio_poll()... */
217 block_job_ref(job);
218
219 block_job_pause(job);
220
463e0be1 221 while (!job->paused && !job->completed) {
bae8196d 222 block_job_drain(job);
463e0be1
SH
223 }
224
225 block_job_unref(job);
226}
227
f321dcb5
PB
228static char *child_job_get_parent_desc(BdrvChild *c)
229{
230 BlockJob *job = c->opaque;
231 return g_strdup_printf("%s job '%s'",
977c736f 232 BlockJobType_str(job->driver->job_type),
f321dcb5
PB
233 job->id);
234}
235
236static const BdrvChildRole child_job = {
237 .get_parent_desc = child_job_get_parent_desc,
238 .stay_at_node = true,
239};
240
241static void block_job_drained_begin(void *opaque)
242{
243 BlockJob *job = opaque;
244 block_job_pause(job);
245}
246
247static void block_job_drained_end(void *opaque)
248{
249 BlockJob *job = opaque;
250 block_job_resume(job);
251}
252
253static const BlockDevOps block_job_dev_ops = {
254 .drained_begin = block_job_drained_begin,
255 .drained_end = block_job_drained_end,
256};
257
bbc02b90
KW
258void block_job_remove_all_bdrv(BlockJob *job)
259{
260 GSList *l;
261 for (l = job->nodes; l; l = l->next) {
262 BdrvChild *c = l->data;
263 bdrv_op_unblock_all(c->bs, job->blocker);
264 bdrv_root_unref_child(c);
265 }
266 g_slist_free(job->nodes);
267 job->nodes = NULL;
268}
269
76d554e2
KW
270int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs,
271 uint64_t perm, uint64_t shared_perm, Error **errp)
23d402d4 272{
76d554e2
KW
273 BdrvChild *c;
274
275 c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm,
276 job, errp);
277 if (c == NULL) {
278 return -EPERM;
279 }
280
281 job->nodes = g_slist_prepend(job->nodes, c);
23d402d4
AG
282 bdrv_ref(bs);
283 bdrv_op_block_all(bs, job->blocker);
76d554e2
KW
284
285 return 0;
23d402d4
AG
286}
287
559b935f
JS
288bool block_job_is_internal(BlockJob *job)
289{
290 return (job->id == NULL);
291}
292
5ccac6f1
JS
293static bool block_job_started(BlockJob *job)
294{
295 return job->co;
296}
297
e3796a24
JS
298/**
299 * All jobs must allow a pause point before entering their job proper. This
300 * ensures that jobs can be paused prior to being started, then resumed later.
301 */
302static void coroutine_fn block_job_co_entry(void *opaque)
303{
304 BlockJob *job = opaque;
305
306 assert(job && job->driver && job->driver->start);
307 block_job_pause_point(job);
308 job->driver->start(job);
309}
310
fc24908e
PB
311static void block_job_sleep_timer_cb(void *opaque)
312{
313 BlockJob *job = opaque;
314
315 block_job_enter(job);
316}
317
5ccac6f1
JS
318void block_job_start(BlockJob *job)
319{
320 assert(job && !block_job_started(job) && job->paused &&
e3796a24
JS
321 job->driver && job->driver->start);
322 job->co = qemu_coroutine_create(block_job_co_entry, job);
323 job->pause_count--;
324 job->busy = true;
325 job->paused = false;
aef4278c 326 bdrv_coroutine_enter(blk_bs(job->blk), job->co);
5ccac6f1
JS
327}
328
c55a832f
FZ
329static void block_job_completed_single(BlockJob *job)
330{
4fb588e9
PB
331 assert(job->completed);
332
c55a832f
FZ
333 if (!job->ret) {
334 if (job->driver->commit) {
335 job->driver->commit(job);
336 }
337 } else {
338 if (job->driver->abort) {
339 job->driver->abort(job);
340 }
341 }
e8a40bf7
JS
342 if (job->driver->clean) {
343 job->driver->clean(job);
344 }
8254b6d9
JS
345
346 if (job->cb) {
347 job->cb(job->opaque, job->ret);
348 }
5ccac6f1
JS
349
350 /* Emit events only if we actually started */
351 if (block_job_started(job)) {
352 if (block_job_is_cancelled(job)) {
353 block_job_event_cancelled(job);
354 } else {
355 const char *msg = NULL;
356 if (job->ret < 0) {
357 msg = strerror(-job->ret);
358 }
359 block_job_event_completed(job, msg);
8254b6d9 360 }
8254b6d9
JS
361 }
362
c55a832f 363 if (job->txn) {
1e93b9fb 364 QLIST_REMOVE(job, txn_list);
c55a832f
FZ
365 block_job_txn_unref(job->txn);
366 }
367 block_job_unref(job);
368}
369
4c241cf5
PB
370static void block_job_cancel_async(BlockJob *job)
371{
372 if (job->iostatus != BLOCK_DEVICE_IO_STATUS_OK) {
373 block_job_iostatus_reset(job);
374 }
375 if (job->user_paused) {
376 /* Do not call block_job_enter here, the caller will handle it. */
377 job->user_paused = false;
378 job->pause_count--;
379 }
380 job->cancelled = true;
381}
382
c8ab5c2d
PB
383static int block_job_finish_sync(BlockJob *job,
384 void (*finish)(BlockJob *, Error **errp),
385 Error **errp)
386{
387 Error *local_err = NULL;
388 int ret;
389
390 assert(blk_bs(job->blk)->job == job);
391
392 block_job_ref(job);
393
4fb588e9
PB
394 if (finish) {
395 finish(job, &local_err);
396 }
c8ab5c2d
PB
397 if (local_err) {
398 error_propagate(errp, local_err);
399 block_job_unref(job);
400 return -EBUSY;
401 }
402 /* block_job_drain calls block_job_enter, and it should be enough to
403 * induce progress until the job completes or moves to the main thread.
404 */
405 while (!job->deferred_to_main_loop && !job->completed) {
406 block_job_drain(job);
407 }
408 while (!job->completed) {
409 aio_poll(qemu_get_aio_context(), true);
410 }
411 ret = (job->cancelled && job->ret == 0) ? -ECANCELED : job->ret;
412 block_job_unref(job);
413 return ret;
414}
415
c55a832f
FZ
416static void block_job_completed_txn_abort(BlockJob *job)
417{
418 AioContext *ctx;
419 BlockJobTxn *txn = job->txn;
4fb588e9 420 BlockJob *other_job;
c55a832f
FZ
421
422 if (txn->aborting) {
423 /*
424 * We are cancelled by another job, which will handle everything.
425 */
426 return;
427 }
428 txn->aborting = true;
4fb588e9
PB
429 block_job_txn_ref(txn);
430
c55a832f
FZ
431 /* We are the first failed job. Cancel other jobs. */
432 QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
b6d2e599 433 ctx = blk_get_aio_context(other_job->blk);
c55a832f
FZ
434 aio_context_acquire(ctx);
435 }
4fb588e9
PB
436
437 /* Other jobs are effectively cancelled by us, set the status for
438 * them; this job, however, may or may not be cancelled, depending
439 * on the caller, so leave it. */
c55a832f 440 QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
4fb588e9
PB
441 if (other_job != job) {
442 block_job_cancel_async(other_job);
c55a832f 443 }
c55a832f 444 }
4fb588e9
PB
445 while (!QLIST_EMPTY(&txn->jobs)) {
446 other_job = QLIST_FIRST(&txn->jobs);
b6d2e599 447 ctx = blk_get_aio_context(other_job->blk);
4fb588e9
PB
448 if (!other_job->completed) {
449 assert(other_job->cancelled);
450 block_job_finish_sync(other_job, NULL, NULL);
451 }
c55a832f
FZ
452 block_job_completed_single(other_job);
453 aio_context_release(ctx);
454 }
4fb588e9
PB
455
456 block_job_txn_unref(txn);
c55a832f
FZ
457}
458
459static void block_job_completed_txn_success(BlockJob *job)
460{
461 AioContext *ctx;
462 BlockJobTxn *txn = job->txn;
463 BlockJob *other_job, *next;
464 /*
465 * Successful completion, see if there are other running jobs in this
466 * txn.
467 */
468 QLIST_FOREACH(other_job, &txn->jobs, txn_list) {
469 if (!other_job->completed) {
470 return;
471 }
472 }
473 /* We are the last completed job, commit the transaction. */
474 QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) {
b6d2e599 475 ctx = blk_get_aio_context(other_job->blk);
c55a832f
FZ
476 aio_context_acquire(ctx);
477 assert(other_job->ret == 0);
478 block_job_completed_single(other_job);
479 aio_context_release(ctx);
480 }
481}
482
2f0c9fe6
PB
483void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp)
484{
485 Error *local_err = NULL;
486
3fc4b10a 487 if (!job->driver->set_speed) {
c6bd8c70 488 error_setg(errp, QERR_UNSUPPORTED);
2f0c9fe6
PB
489 return;
490 }
3fc4b10a 491 job->driver->set_speed(job, speed, &local_err);
84d18f06 492 if (local_err) {
2f0c9fe6
PB
493 error_propagate(errp, local_err);
494 return;
495 }
496
497 job->speed = speed;
498}
499
aeae883b
PB
500void block_job_complete(BlockJob *job, Error **errp)
501{
559b935f
JS
502 /* Should not be reachable via external interface for internal jobs */
503 assert(job->id);
5ccac6f1
JS
504 if (job->pause_count || job->cancelled ||
505 !block_job_started(job) || !job->driver->complete) {
9df229c3
AG
506 error_setg(errp, "The active block job '%s' cannot be completed",
507 job->id);
aeae883b
PB
508 return;
509 }
510
3fc4b10a 511 job->driver->complete(job, errp);
aeae883b
PB
512}
513
0df4ba58
JS
514void block_job_user_pause(BlockJob *job)
515{
516 job->user_paused = true;
517 block_job_pause(job);
518}
519
0df4ba58
JS
520bool block_job_user_paused(BlockJob *job)
521{
6573d9c6 522 return job->user_paused;
0df4ba58
JS
523}
524
0df4ba58
JS
525void block_job_user_resume(BlockJob *job)
526{
527 if (job && job->user_paused && job->pause_count > 0) {
2caf63a9 528 block_job_iostatus_reset(job);
4c241cf5 529 job->user_paused = false;
0df4ba58
JS
530 block_job_resume(job);
531 }
532}
533
8acc72a4
PB
534void block_job_cancel(BlockJob *job)
535{
5ccac6f1 536 if (block_job_started(job)) {
4c241cf5 537 block_job_cancel_async(job);
5ccac6f1
JS
538 block_job_enter(job);
539 } else {
540 block_job_completed(job, -ECANCELED);
541 }
8acc72a4
PB
542}
543
345f9e1b
HR
544/* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
545 * used with block_job_finish_sync() without the need for (rather nasty)
546 * function pointer casts there. */
547static void block_job_cancel_err(BlockJob *job, Error **errp)
548{
549 block_job_cancel(job);
550}
551
552int block_job_cancel_sync(BlockJob *job)
553{
554 return block_job_finish_sync(job, &block_job_cancel_err, NULL);
555}
556
a1a2af07
KW
557void block_job_cancel_sync_all(void)
558{
559 BlockJob *job;
560 AioContext *aio_context;
561
562 while ((job = QLIST_FIRST(&block_jobs))) {
b6d2e599 563 aio_context = blk_get_aio_context(job->blk);
a1a2af07
KW
564 aio_context_acquire(aio_context);
565 block_job_cancel_sync(job);
566 aio_context_release(aio_context);
567 }
568}
569
345f9e1b
HR
570int block_job_complete_sync(BlockJob *job, Error **errp)
571{
572 return block_job_finish_sync(job, &block_job_complete, errp);
573}
574
559b935f 575BlockJobInfo *block_job_query(BlockJob *job, Error **errp)
30e628b7 576{
559b935f
JS
577 BlockJobInfo *info;
578
579 if (block_job_is_internal(job)) {
580 error_setg(errp, "Cannot query QEMU internal jobs");
581 return NULL;
582 }
583 info = g_new0(BlockJobInfo, 1);
977c736f 584 info->type = g_strdup(BlockJobType_str(job->driver->job_type));
8ccb9569 585 info->device = g_strdup(job->id);
32c81a4a 586 info->len = job->len;
fc24908e 587 info->busy = atomic_read(&job->busy);
751ebd76 588 info->paused = job->pause_count > 0;
32c81a4a
PB
589 info->offset = job->offset;
590 info->speed = job->speed;
591 info->io_status = job->iostatus;
ef6dbf1e 592 info->ready = job->ready;
30e628b7
PB
593 return info;
594}
32c81a4a
PB
595
596static void block_job_iostatus_set_err(BlockJob *job, int error)
597{
598 if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
599 job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
600 BLOCK_DEVICE_IO_STATUS_FAILED;
601 }
602}
603
8254b6d9 604static void block_job_event_cancelled(BlockJob *job)
bcada37b 605{
559b935f
JS
606 if (block_job_is_internal(job)) {
607 return;
608 }
609
bcada37b 610 qapi_event_send_block_job_cancelled(job->driver->job_type,
8ccb9569 611 job->id,
bcada37b
WX
612 job->len,
613 job->offset,
614 job->speed,
615 &error_abort);
616}
32c81a4a 617
8254b6d9 618static void block_job_event_completed(BlockJob *job, const char *msg)
a66a2a36 619{
559b935f
JS
620 if (block_job_is_internal(job)) {
621 return;
622 }
623
bcada37b 624 qapi_event_send_block_job_completed(job->driver->job_type,
8ccb9569 625 job->id,
bcada37b
WX
626 job->len,
627 job->offset,
628 job->speed,
629 !!msg,
630 msg,
631 &error_abort);
a66a2a36
PB
632}
633
88691b37
PB
634/*
635 * API for block job drivers and the block layer. These functions are
636 * declared in blockjob_int.h.
637 */
638
639void *block_job_create(const char *job_id, const BlockJobDriver *driver,
640 BlockDriverState *bs, uint64_t perm,
641 uint64_t shared_perm, int64_t speed, int flags,
642 BlockCompletionFunc *cb, void *opaque, Error **errp)
643{
644 BlockBackend *blk;
645 BlockJob *job;
646 int ret;
647
648 if (bs->job) {
649 error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
650 return NULL;
651 }
652
653 if (job_id == NULL && !(flags & BLOCK_JOB_INTERNAL)) {
654 job_id = bdrv_get_device_name(bs);
655 if (!*job_id) {
656 error_setg(errp, "An explicit job ID is required for this node");
657 return NULL;
658 }
659 }
660
661 if (job_id) {
662 if (flags & BLOCK_JOB_INTERNAL) {
663 error_setg(errp, "Cannot specify job ID for internal block job");
664 return NULL;
665 }
666
667 if (!id_wellformed(job_id)) {
668 error_setg(errp, "Invalid job ID '%s'", job_id);
669 return NULL;
670 }
671
672 if (block_job_get(job_id)) {
673 error_setg(errp, "Job ID '%s' already in use", job_id);
674 return NULL;
675 }
676 }
677
678 blk = blk_new(perm, shared_perm);
679 ret = blk_insert_bs(blk, bs, errp);
680 if (ret < 0) {
681 blk_unref(blk);
682 return NULL;
683 }
684
685 job = g_malloc0(driver->instance_size);
686 job->driver = driver;
687 job->id = g_strdup(job_id);
688 job->blk = blk;
689 job->cb = cb;
690 job->opaque = opaque;
691 job->busy = false;
692 job->paused = true;
693 job->pause_count = 1;
694 job->refcnt = 1;
fc24908e
PB
695 aio_timer_init(qemu_get_aio_context(), &job->sleep_timer,
696 QEMU_CLOCK_REALTIME, SCALE_NS,
697 block_job_sleep_timer_cb, job);
88691b37
PB
698
699 error_setg(&job->blocker, "block device is in use by block job: %s",
977c736f 700 BlockJobType_str(driver->job_type));
88691b37
PB
701 block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort);
702 bs->job = job;
703
704 blk_set_dev_ops(blk, &block_job_dev_ops, job);
705 bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker);
706
707 QLIST_INSERT_HEAD(&block_jobs, job, job_list);
708
709 blk_add_aio_context_notifier(blk, block_job_attached_aio_context,
710 block_job_detach_aio_context, job);
711
712 /* Only set speed when necessary to avoid NotSupported error */
713 if (speed != 0) {
714 Error *local_err = NULL;
715
716 block_job_set_speed(job, speed, &local_err);
717 if (local_err) {
718 block_job_unref(job);
719 error_propagate(errp, local_err);
720 return NULL;
721 }
722 }
723 return job;
724}
725
f321dcb5
PB
726void block_job_pause_all(void)
727{
728 BlockJob *job = NULL;
729 while ((job = block_job_next(job))) {
730 AioContext *aio_context = blk_get_aio_context(job->blk);
731
732 aio_context_acquire(aio_context);
733 block_job_pause(job);
734 aio_context_release(aio_context);
735 }
736}
737
88691b37
PB
738void block_job_early_fail(BlockJob *job)
739{
740 block_job_unref(job);
741}
742
743void block_job_completed(BlockJob *job, int ret)
744{
745 assert(blk_bs(job->blk)->job == job);
746 assert(!job->completed);
747 job->completed = true;
748 job->ret = ret;
749 if (!job->txn) {
750 block_job_completed_single(job);
751 } else if (ret < 0 || block_job_is_cancelled(job)) {
752 block_job_completed_txn_abort(job);
753 } else {
754 block_job_completed_txn_success(job);
755 }
756}
757
758static bool block_job_should_pause(BlockJob *job)
759{
760 return job->pause_count > 0;
761}
762
fc24908e
PB
763/* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds.
764 * Reentering the job coroutine with block_job_enter() before the timer has
765 * expired is allowed and cancels the timer.
766 *
767 * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be
768 * called explicitly. */
769static void block_job_do_yield(BlockJob *job, uint64_t ns)
356f59b8 770{
fc24908e
PB
771 block_job_lock();
772 if (ns != -1) {
773 timer_mod(&job->sleep_timer, ns);
774 }
356f59b8 775 job->busy = false;
fc24908e 776 block_job_unlock();
356f59b8
PB
777 qemu_coroutine_yield();
778
779 /* Set by block_job_enter before re-entering the coroutine. */
780 assert(job->busy);
781}
782
88691b37
PB
783void coroutine_fn block_job_pause_point(BlockJob *job)
784{
785 assert(job && block_job_started(job));
786
787 if (!block_job_should_pause(job)) {
788 return;
789 }
790 if (block_job_is_cancelled(job)) {
791 return;
792 }
793
794 if (job->driver->pause) {
795 job->driver->pause(job);
796 }
797
798 if (block_job_should_pause(job) && !block_job_is_cancelled(job)) {
799 job->paused = true;
fc24908e 800 block_job_do_yield(job, -1);
88691b37
PB
801 job->paused = false;
802 }
803
804 if (job->driver->resume) {
805 job->driver->resume(job);
806 }
807}
808
f321dcb5
PB
809void block_job_resume_all(void)
810{
811 BlockJob *job = NULL;
812 while ((job = block_job_next(job))) {
813 AioContext *aio_context = blk_get_aio_context(job->blk);
814
815 aio_context_acquire(aio_context);
816 block_job_resume(job);
817 aio_context_release(aio_context);
818 }
819}
820
88691b37
PB
821void block_job_enter(BlockJob *job)
822{
eb05e011
PB
823 if (!block_job_started(job)) {
824 return;
825 }
826 if (job->deferred_to_main_loop) {
827 return;
828 }
829
fc24908e 830 block_job_lock();
356f59b8 831 if (job->busy) {
fc24908e 832 block_job_unlock();
356f59b8 833 return;
88691b37 834 }
356f59b8 835
fc24908e
PB
836 assert(!job->deferred_to_main_loop);
837 timer_del(&job->sleep_timer);
356f59b8 838 job->busy = true;
fc24908e 839 block_job_unlock();
356f59b8 840 aio_co_wake(job->co);
88691b37
PB
841}
842
843bool block_job_is_cancelled(BlockJob *job)
844{
845 return job->cancelled;
846}
847
5bf1d5a7 848void block_job_sleep_ns(BlockJob *job, int64_t ns)
88691b37
PB
849{
850 assert(job->busy);
851
852 /* Check cancellation *before* setting busy = false, too! */
853 if (block_job_is_cancelled(job)) {
854 return;
855 }
856
88691b37 857 if (!block_job_should_pause(job)) {
fc24908e 858 block_job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns);
88691b37 859 }
88691b37
PB
860
861 block_job_pause_point(job);
862}
863
864void block_job_yield(BlockJob *job)
865{
866 assert(job->busy);
867
868 /* Check cancellation *before* setting busy = false, too! */
869 if (block_job_is_cancelled(job)) {
870 return;
871 }
872
88691b37 873 if (!block_job_should_pause(job)) {
fc24908e 874 block_job_do_yield(job, -1);
88691b37 875 }
88691b37
PB
876
877 block_job_pause_point(job);
878}
879
2caf63a9
PB
880void block_job_iostatus_reset(BlockJob *job)
881{
4c241cf5
PB
882 if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
883 return;
884 }
885 assert(job->user_paused && job->pause_count > 0);
2caf63a9
PB
886 job->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
887}
888
bcada37b 889void block_job_event_ready(BlockJob *job)
a66a2a36 890{
ef6dbf1e
HR
891 job->ready = true;
892
559b935f
JS
893 if (block_job_is_internal(job)) {
894 return;
895 }
896
518848a2 897 qapi_event_send_block_job_ready(job->driver->job_type,
8ccb9569 898 job->id,
518848a2
MA
899 job->len,
900 job->offset,
901 job->speed, &error_abort);
a66a2a36
PB
902}
903
81e254dc 904BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err,
32c81a4a
PB
905 int is_read, int error)
906{
907 BlockErrorAction action;
908
909 switch (on_err) {
910 case BLOCKDEV_ON_ERROR_ENOSPC:
8c398252 911 case BLOCKDEV_ON_ERROR_AUTO:
a589569f
WX
912 action = (error == ENOSPC) ?
913 BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
32c81a4a
PB
914 break;
915 case BLOCKDEV_ON_ERROR_STOP:
a589569f 916 action = BLOCK_ERROR_ACTION_STOP;
32c81a4a
PB
917 break;
918 case BLOCKDEV_ON_ERROR_REPORT:
a589569f 919 action = BLOCK_ERROR_ACTION_REPORT;
32c81a4a
PB
920 break;
921 case BLOCKDEV_ON_ERROR_IGNORE:
a589569f 922 action = BLOCK_ERROR_ACTION_IGNORE;
32c81a4a
PB
923 break;
924 default:
925 abort();
926 }
559b935f
JS
927 if (!block_job_is_internal(job)) {
928 qapi_event_send_block_job_error(job->id,
929 is_read ? IO_OPERATION_TYPE_READ :
930 IO_OPERATION_TYPE_WRITE,
931 action, &error_abort);
932 }
a589569f 933 if (action == BLOCK_ERROR_ACTION_STOP) {
751ebd76 934 /* make the pause user visible, which will be resumed from QMP. */
0df4ba58 935 block_job_user_pause(job);
32c81a4a 936 block_job_iostatus_set_err(job, error);
32c81a4a
PB
937 }
938 return action;
939}
dec7d421
SH
940
941typedef struct {
942 BlockJob *job;
dec7d421
SH
943 AioContext *aio_context;
944 BlockJobDeferToMainLoopFn *fn;
945 void *opaque;
946} BlockJobDeferToMainLoopData;
947
948static void block_job_defer_to_main_loop_bh(void *opaque)
949{
950 BlockJobDeferToMainLoopData *data = opaque;
951 AioContext *aio_context;
952
dec7d421
SH
953 /* Prevent race with block_job_defer_to_main_loop() */
954 aio_context_acquire(data->aio_context);
955
956 /* Fetch BDS AioContext again, in case it has changed */
b6d2e599 957 aio_context = blk_get_aio_context(data->job->blk);
d79df2a2
PB
958 if (aio_context != data->aio_context) {
959 aio_context_acquire(aio_context);
960 }
dec7d421
SH
961
962 data->fn(data->job, data->opaque);
963
d79df2a2
PB
964 if (aio_context != data->aio_context) {
965 aio_context_release(aio_context);
966 }
dec7d421
SH
967
968 aio_context_release(data->aio_context);
969
970 g_free(data);
971}
972
973void block_job_defer_to_main_loop(BlockJob *job,
974 BlockJobDeferToMainLoopFn *fn,
975 void *opaque)
976{
977 BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data));
978 data->job = job;
b6d2e599 979 data->aio_context = blk_get_aio_context(job->blk);
dec7d421
SH
980 data->fn = fn;
981 data->opaque = opaque;
794f0141 982 job->deferred_to_main_loop = true;
dec7d421 983
fffb6e12
PB
984 aio_bh_schedule_oneshot(qemu_get_aio_context(),
985 block_job_defer_to_main_loop_bh, data);
dec7d421 986}