2 * QEMU System Emulator block driver
4 * Copyright (c) 2011 IBM Corp.
5 * Copyright (c) 2012 Red Hat, Inc.
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #include "qemu/osdep.h"
27 #include "qemu-common.h"
28 #include "block/block.h"
29 #include "block/blockjob_int.h"
30 #include "block/block_int.h"
31 #include "block/trace.h"
32 #include "sysemu/block-backend.h"
33 #include "qapi/error.h"
34 #include "qapi/qapi-events-block-core.h"
35 #include "qapi/qmp/qerror.h"
36 #include "qemu/coroutine.h"
38 #include "qemu/timer.h"
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
43 static QemuMutex block_job_mutex
;
45 /* BlockJob State Transition Table */
46 bool BlockJobSTT
[BLOCK_JOB_STATUS__MAX
][BLOCK_JOB_STATUS__MAX
] = {
47 /* U, C, R, P, Y, S, W, D, X, E, N */
48 /* U: */ [BLOCK_JOB_STATUS_UNDEFINED
] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0},
49 /* C: */ [BLOCK_JOB_STATUS_CREATED
] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1},
50 /* R: */ [BLOCK_JOB_STATUS_RUNNING
] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0},
51 /* P: */ [BLOCK_JOB_STATUS_PAUSED
] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0},
52 /* Y: */ [BLOCK_JOB_STATUS_READY
] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0},
53 /* S: */ [BLOCK_JOB_STATUS_STANDBY
] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0},
54 /* W: */ [BLOCK_JOB_STATUS_WAITING
] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0},
55 /* D: */ [BLOCK_JOB_STATUS_PENDING
] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0},
56 /* X: */ [BLOCK_JOB_STATUS_ABORTING
] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0},
57 /* E: */ [BLOCK_JOB_STATUS_CONCLUDED
] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1},
58 /* N: */ [BLOCK_JOB_STATUS_NULL
] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0},
61 bool BlockJobVerbTable
[BLOCK_JOB_VERB__MAX
][BLOCK_JOB_STATUS__MAX
] = {
62 /* U, C, R, P, Y, S, W, D, X, E, N */
63 [BLOCK_JOB_VERB_CANCEL
] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0},
64 [BLOCK_JOB_VERB_PAUSE
] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0},
65 [BLOCK_JOB_VERB_RESUME
] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0},
66 [BLOCK_JOB_VERB_SET_SPEED
] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0},
67 [BLOCK_JOB_VERB_COMPLETE
] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0},
68 [BLOCK_JOB_VERB_DISMISS
] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0},
71 static void block_job_state_transition(BlockJob
*job
, BlockJobStatus s1
)
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",
77 qapi_enum_lookup(&BlockJobStatus_lookup
,
79 qapi_enum_lookup(&BlockJobStatus_lookup
,
81 assert(BlockJobSTT
[s0
][s1
]);
85 static int block_job_apply_verb(BlockJob
*job
, BlockJobVerb bv
, Error
**errp
)
87 assert(bv
>= 0 && bv
<= BLOCK_JOB_VERB__MAX
);
88 trace_block_job_apply_verb(job
, qapi_enum_lookup(&BlockJobStatus_lookup
,
90 qapi_enum_lookup(&BlockJobVerb_lookup
, bv
),
91 BlockJobVerbTable
[bv
][job
->status
] ?
92 "allowed" : "prohibited");
93 if (BlockJobVerbTable
[bv
][job
->status
]) {
96 error_setg(errp
, "Job '%s' in state '%s' cannot accept command verb '%s'",
97 job
->id
, qapi_enum_lookup(&BlockJobStatus_lookup
, job
->status
),
98 qapi_enum_lookup(&BlockJobVerb_lookup
, bv
));
102 static void block_job_lock(void)
104 qemu_mutex_lock(&block_job_mutex
);
107 static void block_job_unlock(void)
109 qemu_mutex_unlock(&block_job_mutex
);
112 static void __attribute__((__constructor__
)) block_job_init(void)
114 qemu_mutex_init(&block_job_mutex
);
117 static void block_job_event_cancelled(BlockJob
*job
);
118 static void block_job_event_completed(BlockJob
*job
, const char *msg
);
119 static int block_job_event_pending(BlockJob
*job
);
120 static void block_job_enter_cond(BlockJob
*job
, bool(*fn
)(BlockJob
*job
));
122 /* Transactional group of block jobs */
125 /* Is this txn being cancelled? */
129 QLIST_HEAD(, BlockJob
) jobs
;
131 /* Reference count */
135 static QLIST_HEAD(, BlockJob
) block_jobs
= QLIST_HEAD_INITIALIZER(block_jobs
);
138 * The block job API is composed of two categories of functions.
140 * The first includes functions used by the monitor. The monitor is
141 * peculiar in that it accesses the block job list with block_job_get, and
142 * therefore needs consistency across block_job_get and the actual operation
143 * (e.g. block_job_set_speed). The consistency is achieved with
144 * aio_context_acquire/release. These functions are declared in blockjob.h.
146 * The second includes functions used by the block job drivers and sometimes
147 * by the core block layer. These do not care about locking, because the
148 * whole coroutine runs under the AioContext lock, and are declared in
152 BlockJob
*block_job_next(BlockJob
*job
)
155 return QLIST_FIRST(&block_jobs
);
157 return QLIST_NEXT(job
, job_list
);
160 BlockJob
*block_job_get(const char *id
)
164 QLIST_FOREACH(job
, &block_jobs
, job_list
) {
165 if (job
->id
&& !strcmp(id
, job
->id
)) {
173 BlockJobTxn
*block_job_txn_new(void)
175 BlockJobTxn
*txn
= g_new0(BlockJobTxn
, 1);
176 QLIST_INIT(&txn
->jobs
);
181 static void block_job_txn_ref(BlockJobTxn
*txn
)
186 void block_job_txn_unref(BlockJobTxn
*txn
)
188 if (txn
&& --txn
->refcnt
== 0) {
193 void block_job_txn_add_job(BlockJobTxn
*txn
, BlockJob
*job
)
202 QLIST_INSERT_HEAD(&txn
->jobs
, job
, txn_list
);
203 block_job_txn_ref(txn
);
206 static void block_job_pause(BlockJob
*job
)
211 static void block_job_resume(BlockJob
*job
)
213 assert(job
->pause_count
> 0);
215 if (job
->pause_count
) {
218 block_job_enter(job
);
221 void block_job_ref(BlockJob
*job
)
226 static void block_job_attached_aio_context(AioContext
*new_context
,
228 static void block_job_detach_aio_context(void *opaque
);
230 void block_job_unref(BlockJob
*job
)
232 if (--job
->refcnt
== 0) {
233 assert(job
->status
== BLOCK_JOB_STATUS_NULL
);
234 BlockDriverState
*bs
= blk_bs(job
->blk
);
235 QLIST_REMOVE(job
, job_list
);
237 block_job_remove_all_bdrv(job
);
238 blk_remove_aio_context_notifier(job
->blk
,
239 block_job_attached_aio_context
,
240 block_job_detach_aio_context
, job
);
242 error_free(job
->blocker
);
244 assert(!timer_pending(&job
->sleep_timer
));
249 static void block_job_attached_aio_context(AioContext
*new_context
,
252 BlockJob
*job
= opaque
;
254 if (job
->driver
->attached_aio_context
) {
255 job
->driver
->attached_aio_context(job
, new_context
);
258 block_job_resume(job
);
261 static void block_job_drain(BlockJob
*job
)
263 /* If job is !job->busy this kicks it into the next pause point. */
264 block_job_enter(job
);
267 if (job
->driver
->drain
) {
268 job
->driver
->drain(job
);
272 static void block_job_detach_aio_context(void *opaque
)
274 BlockJob
*job
= opaque
;
276 /* In case the job terminates during aio_poll()... */
279 block_job_pause(job
);
281 while (!job
->paused
&& !job
->completed
) {
282 block_job_drain(job
);
285 block_job_unref(job
);
288 static char *child_job_get_parent_desc(BdrvChild
*c
)
290 BlockJob
*job
= c
->opaque
;
291 return g_strdup_printf("%s job '%s'",
292 BlockJobType_str(job
->driver
->job_type
),
296 static void child_job_drained_begin(BdrvChild
*c
)
298 BlockJob
*job
= c
->opaque
;
299 block_job_pause(job
);
302 static void child_job_drained_end(BdrvChild
*c
)
304 BlockJob
*job
= c
->opaque
;
305 block_job_resume(job
);
308 static const BdrvChildRole child_job
= {
309 .get_parent_desc
= child_job_get_parent_desc
,
310 .drained_begin
= child_job_drained_begin
,
311 .drained_end
= child_job_drained_end
,
312 .stay_at_node
= true,
315 void block_job_remove_all_bdrv(BlockJob
*job
)
318 for (l
= job
->nodes
; l
; l
= l
->next
) {
319 BdrvChild
*c
= l
->data
;
320 bdrv_op_unblock_all(c
->bs
, job
->blocker
);
321 bdrv_root_unref_child(c
);
323 g_slist_free(job
->nodes
);
327 int block_job_add_bdrv(BlockJob
*job
, const char *name
, BlockDriverState
*bs
,
328 uint64_t perm
, uint64_t shared_perm
, Error
**errp
)
332 c
= bdrv_root_attach_child(bs
, name
, &child_job
, perm
, shared_perm
,
338 job
->nodes
= g_slist_prepend(job
->nodes
, c
);
340 bdrv_op_block_all(bs
, job
->blocker
);
345 bool block_job_is_internal(BlockJob
*job
)
347 return (job
->id
== NULL
);
350 static bool block_job_started(BlockJob
*job
)
356 * All jobs must allow a pause point before entering their job proper. This
357 * ensures that jobs can be paused prior to being started, then resumed later.
359 static void coroutine_fn
block_job_co_entry(void *opaque
)
361 BlockJob
*job
= opaque
;
363 assert(job
&& job
->driver
&& job
->driver
->start
);
364 block_job_pause_point(job
);
365 job
->driver
->start(job
);
368 static void block_job_sleep_timer_cb(void *opaque
)
370 BlockJob
*job
= opaque
;
372 block_job_enter(job
);
375 void block_job_start(BlockJob
*job
)
377 assert(job
&& !block_job_started(job
) && job
->paused
&&
378 job
->driver
&& job
->driver
->start
);
379 job
->co
= qemu_coroutine_create(block_job_co_entry
, job
);
383 block_job_state_transition(job
, BLOCK_JOB_STATUS_RUNNING
);
384 bdrv_coroutine_enter(blk_bs(job
->blk
), job
->co
);
387 static void block_job_decommission(BlockJob
*job
)
390 job
->completed
= true;
393 job
->deferred_to_main_loop
= true;
394 block_job_state_transition(job
, BLOCK_JOB_STATUS_NULL
);
395 block_job_unref(job
);
398 static void block_job_do_dismiss(BlockJob
*job
)
400 block_job_decommission(job
);
403 static void block_job_conclude(BlockJob
*job
)
405 block_job_state_transition(job
, BLOCK_JOB_STATUS_CONCLUDED
);
406 if (job
->auto_dismiss
|| !block_job_started(job
)) {
407 block_job_do_dismiss(job
);
411 static void block_job_update_rc(BlockJob
*job
)
413 if (!job
->ret
&& block_job_is_cancelled(job
)) {
414 job
->ret
= -ECANCELED
;
417 block_job_state_transition(job
, BLOCK_JOB_STATUS_ABORTING
);
421 static int block_job_prepare(BlockJob
*job
)
423 if (job
->ret
== 0 && job
->driver
->prepare
) {
424 job
->ret
= job
->driver
->prepare(job
);
429 static void block_job_commit(BlockJob
*job
)
432 if (job
->driver
->commit
) {
433 job
->driver
->commit(job
);
437 static void block_job_abort(BlockJob
*job
)
440 if (job
->driver
->abort
) {
441 job
->driver
->abort(job
);
445 static void block_job_clean(BlockJob
*job
)
447 if (job
->driver
->clean
) {
448 job
->driver
->clean(job
);
452 static int block_job_completed_single(BlockJob
*job
)
454 assert(job
->completed
);
456 /* Ensure abort is called for late-transactional failures */
457 block_job_update_rc(job
);
460 block_job_commit(job
);
462 block_job_abort(job
);
464 block_job_clean(job
);
467 job
->cb(job
->opaque
, job
->ret
);
470 /* Emit events only if we actually started */
471 if (block_job_started(job
)) {
472 if (block_job_is_cancelled(job
)) {
473 block_job_event_cancelled(job
);
475 const char *msg
= NULL
;
477 msg
= strerror(-job
->ret
);
479 block_job_event_completed(job
, msg
);
483 QLIST_REMOVE(job
, txn_list
);
484 block_job_txn_unref(job
->txn
);
485 block_job_conclude(job
);
489 static void block_job_cancel_async(BlockJob
*job
)
491 if (job
->iostatus
!= BLOCK_DEVICE_IO_STATUS_OK
) {
492 block_job_iostatus_reset(job
);
494 if (job
->user_paused
) {
495 /* Do not call block_job_enter here, the caller will handle it. */
496 job
->user_paused
= false;
499 job
->cancelled
= true;
502 static int block_job_txn_apply(BlockJobTxn
*txn
, int fn(BlockJob
*), bool lock
)
505 BlockJob
*job
, *next
;
508 QLIST_FOREACH_SAFE(job
, &txn
->jobs
, txn_list
, next
) {
510 ctx
= blk_get_aio_context(job
->blk
);
511 aio_context_acquire(ctx
);
515 aio_context_release(ctx
);
524 static int block_job_finish_sync(BlockJob
*job
,
525 void (*finish
)(BlockJob
*, Error
**errp
),
528 Error
*local_err
= NULL
;
531 assert(blk_bs(job
->blk
)->job
== job
);
536 finish(job
, &local_err
);
539 error_propagate(errp
, local_err
);
540 block_job_unref(job
);
543 /* block_job_drain calls block_job_enter, and it should be enough to
544 * induce progress until the job completes or moves to the main thread.
546 while (!job
->deferred_to_main_loop
&& !job
->completed
) {
547 block_job_drain(job
);
549 while (!job
->completed
) {
550 aio_poll(qemu_get_aio_context(), true);
552 ret
= (job
->cancelled
&& job
->ret
== 0) ? -ECANCELED
: job
->ret
;
553 block_job_unref(job
);
557 static void block_job_completed_txn_abort(BlockJob
*job
)
560 BlockJobTxn
*txn
= job
->txn
;
565 * We are cancelled by another job, which will handle everything.
569 txn
->aborting
= true;
570 block_job_txn_ref(txn
);
572 /* We are the first failed job. Cancel other jobs. */
573 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
574 ctx
= blk_get_aio_context(other_job
->blk
);
575 aio_context_acquire(ctx
);
578 /* Other jobs are effectively cancelled by us, set the status for
579 * them; this job, however, may or may not be cancelled, depending
580 * on the caller, so leave it. */
581 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
582 if (other_job
!= job
) {
583 block_job_cancel_async(other_job
);
586 while (!QLIST_EMPTY(&txn
->jobs
)) {
587 other_job
= QLIST_FIRST(&txn
->jobs
);
588 ctx
= blk_get_aio_context(other_job
->blk
);
589 if (!other_job
->completed
) {
590 assert(other_job
->cancelled
);
591 block_job_finish_sync(other_job
, NULL
, NULL
);
593 block_job_completed_single(other_job
);
594 aio_context_release(ctx
);
597 block_job_txn_unref(txn
);
600 static void block_job_completed_txn_success(BlockJob
*job
)
602 BlockJobTxn
*txn
= job
->txn
;
606 block_job_state_transition(job
, BLOCK_JOB_STATUS_WAITING
);
609 * Successful completion, see if there are other running jobs in this
612 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
613 if (!other_job
->completed
) {
616 assert(other_job
->ret
== 0);
619 /* Jobs may require some prep-work to complete without failure */
620 rc
= block_job_txn_apply(txn
, block_job_prepare
, true);
622 block_job_completed_txn_abort(job
);
626 /* We are the last completed job, commit the transaction. */
627 block_job_txn_apply(txn
, block_job_event_pending
, false);
628 block_job_txn_apply(txn
, block_job_completed_single
, true);
631 /* Assumes the block_job_mutex is held */
632 static bool block_job_timer_pending(BlockJob
*job
)
634 return timer_pending(&job
->sleep_timer
);
637 void block_job_set_speed(BlockJob
*job
, int64_t speed
, Error
**errp
)
639 Error
*local_err
= NULL
;
640 int64_t old_speed
= job
->speed
;
642 if (!job
->driver
->set_speed
) {
643 error_setg(errp
, QERR_UNSUPPORTED
);
646 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_SET_SPEED
, errp
)) {
649 job
->driver
->set_speed(job
, speed
, &local_err
);
651 error_propagate(errp
, local_err
);
656 if (speed
&& speed
<= old_speed
) {
660 /* kick only if a timer is pending */
661 block_job_enter_cond(job
, block_job_timer_pending
);
664 void block_job_complete(BlockJob
*job
, Error
**errp
)
666 /* Should not be reachable via external interface for internal jobs */
668 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_COMPLETE
, errp
)) {
671 if (job
->pause_count
|| job
->cancelled
|| !job
->driver
->complete
) {
672 error_setg(errp
, "The active block job '%s' cannot be completed",
677 job
->driver
->complete(job
, errp
);
680 void block_job_dismiss(BlockJob
**jobptr
, Error
**errp
)
682 BlockJob
*job
= *jobptr
;
683 /* similarly to _complete, this is QMP-interface only. */
685 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_DISMISS
, errp
)) {
689 block_job_do_dismiss(job
);
693 void block_job_user_pause(BlockJob
*job
, Error
**errp
)
695 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_PAUSE
, errp
)) {
698 if (job
->user_paused
) {
699 error_setg(errp
, "Job is already paused");
702 job
->user_paused
= true;
703 block_job_pause(job
);
706 bool block_job_user_paused(BlockJob
*job
)
708 return job
->user_paused
;
711 void block_job_user_resume(BlockJob
*job
, Error
**errp
)
714 if (!job
->user_paused
|| job
->pause_count
<= 0) {
715 error_setg(errp
, "Can't resume a job that was not paused");
718 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_RESUME
, errp
)) {
721 block_job_iostatus_reset(job
);
722 job
->user_paused
= false;
723 block_job_resume(job
);
726 void block_job_cancel(BlockJob
*job
)
728 if (job
->status
== BLOCK_JOB_STATUS_CONCLUDED
) {
729 block_job_do_dismiss(job
);
730 } else if (block_job_started(job
)) {
731 block_job_cancel_async(job
);
732 block_job_enter(job
);
734 block_job_completed(job
, -ECANCELED
);
738 void block_job_user_cancel(BlockJob
*job
, Error
**errp
)
740 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_CANCEL
, errp
)) {
743 block_job_cancel(job
);
746 /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
747 * used with block_job_finish_sync() without the need for (rather nasty)
748 * function pointer casts there. */
749 static void block_job_cancel_err(BlockJob
*job
, Error
**errp
)
751 block_job_cancel(job
);
754 int block_job_cancel_sync(BlockJob
*job
)
756 return block_job_finish_sync(job
, &block_job_cancel_err
, NULL
);
759 void block_job_cancel_sync_all(void)
762 AioContext
*aio_context
;
764 while ((job
= QLIST_FIRST(&block_jobs
))) {
765 aio_context
= blk_get_aio_context(job
->blk
);
766 aio_context_acquire(aio_context
);
767 block_job_cancel_sync(job
);
768 aio_context_release(aio_context
);
772 int block_job_complete_sync(BlockJob
*job
, Error
**errp
)
774 return block_job_finish_sync(job
, &block_job_complete
, errp
);
777 BlockJobInfo
*block_job_query(BlockJob
*job
, Error
**errp
)
781 if (block_job_is_internal(job
)) {
782 error_setg(errp
, "Cannot query QEMU internal jobs");
785 info
= g_new0(BlockJobInfo
, 1);
786 info
->type
= g_strdup(BlockJobType_str(job
->driver
->job_type
));
787 info
->device
= g_strdup(job
->id
);
788 info
->len
= job
->len
;
789 info
->busy
= atomic_read(&job
->busy
);
790 info
->paused
= job
->pause_count
> 0;
791 info
->offset
= job
->offset
;
792 info
->speed
= job
->speed
;
793 info
->io_status
= job
->iostatus
;
794 info
->ready
= job
->ready
;
795 info
->status
= job
->status
;
799 static void block_job_iostatus_set_err(BlockJob
*job
, int error
)
801 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
802 job
->iostatus
= error
== ENOSPC
? BLOCK_DEVICE_IO_STATUS_NOSPACE
:
803 BLOCK_DEVICE_IO_STATUS_FAILED
;
807 static void block_job_event_cancelled(BlockJob
*job
)
809 if (block_job_is_internal(job
)) {
813 qapi_event_send_block_job_cancelled(job
->driver
->job_type
,
821 static void block_job_event_completed(BlockJob
*job
, const char *msg
)
823 if (block_job_is_internal(job
)) {
827 qapi_event_send_block_job_completed(job
->driver
->job_type
,
837 static int block_job_event_pending(BlockJob
*job
)
839 block_job_state_transition(job
, BLOCK_JOB_STATUS_PENDING
);
840 if (!job
->auto_finalize
&& !block_job_is_internal(job
)) {
841 qapi_event_send_block_job_pending(job
->driver
->job_type
,
849 * API for block job drivers and the block layer. These functions are
850 * declared in blockjob_int.h.
853 void *block_job_create(const char *job_id
, const BlockJobDriver
*driver
,
854 BlockJobTxn
*txn
, BlockDriverState
*bs
, uint64_t perm
,
855 uint64_t shared_perm
, int64_t speed
, int flags
,
856 BlockCompletionFunc
*cb
, void *opaque
, Error
**errp
)
863 error_setg(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
867 if (job_id
== NULL
&& !(flags
& BLOCK_JOB_INTERNAL
)) {
868 job_id
= bdrv_get_device_name(bs
);
870 error_setg(errp
, "An explicit job ID is required for this node");
876 if (flags
& BLOCK_JOB_INTERNAL
) {
877 error_setg(errp
, "Cannot specify job ID for internal block job");
881 if (!id_wellformed(job_id
)) {
882 error_setg(errp
, "Invalid job ID '%s'", job_id
);
886 if (block_job_get(job_id
)) {
887 error_setg(errp
, "Job ID '%s' already in use", job_id
);
892 blk
= blk_new(perm
, shared_perm
);
893 ret
= blk_insert_bs(blk
, bs
, errp
);
899 job
= g_malloc0(driver
->instance_size
);
900 job
->driver
= driver
;
901 job
->id
= g_strdup(job_id
);
904 job
->opaque
= opaque
;
907 job
->pause_count
= 1;
909 job
->auto_finalize
= !(flags
& BLOCK_JOB_MANUAL_FINALIZE
);
910 job
->auto_dismiss
= !(flags
& BLOCK_JOB_MANUAL_DISMISS
);
911 block_job_state_transition(job
, BLOCK_JOB_STATUS_CREATED
);
912 aio_timer_init(qemu_get_aio_context(), &job
->sleep_timer
,
913 QEMU_CLOCK_REALTIME
, SCALE_NS
,
914 block_job_sleep_timer_cb
, job
);
916 error_setg(&job
->blocker
, "block device is in use by block job: %s",
917 BlockJobType_str(driver
->job_type
));
918 block_job_add_bdrv(job
, "main node", bs
, 0, BLK_PERM_ALL
, &error_abort
);
921 bdrv_op_unblock(bs
, BLOCK_OP_TYPE_DATAPLANE
, job
->blocker
);
923 QLIST_INSERT_HEAD(&block_jobs
, job
, job_list
);
925 blk_add_aio_context_notifier(blk
, block_job_attached_aio_context
,
926 block_job_detach_aio_context
, job
);
928 /* Only set speed when necessary to avoid NotSupported error */
930 Error
*local_err
= NULL
;
932 block_job_set_speed(job
, speed
, &local_err
);
934 block_job_early_fail(job
);
935 error_propagate(errp
, local_err
);
940 /* Single jobs are modeled as single-job transactions for sake of
941 * consolidating the job management logic */
943 txn
= block_job_txn_new();
944 block_job_txn_add_job(txn
, job
);
945 block_job_txn_unref(txn
);
947 block_job_txn_add_job(txn
, job
);
953 void block_job_pause_all(void)
955 BlockJob
*job
= NULL
;
956 while ((job
= block_job_next(job
))) {
957 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
959 aio_context_acquire(aio_context
);
961 block_job_pause(job
);
962 aio_context_release(aio_context
);
966 void block_job_early_fail(BlockJob
*job
)
968 assert(job
->status
== BLOCK_JOB_STATUS_CREATED
);
969 block_job_decommission(job
);
972 void block_job_completed(BlockJob
*job
, int ret
)
974 assert(job
&& job
->txn
&& !job
->completed
);
975 assert(blk_bs(job
->blk
)->job
== job
);
976 job
->completed
= true;
978 block_job_update_rc(job
);
979 trace_block_job_completed(job
, ret
, job
->ret
);
981 block_job_completed_txn_abort(job
);
983 block_job_completed_txn_success(job
);
987 static bool block_job_should_pause(BlockJob
*job
)
989 return job
->pause_count
> 0;
992 /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds.
993 * Reentering the job coroutine with block_job_enter() before the timer has
994 * expired is allowed and cancels the timer.
996 * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be
997 * called explicitly. */
998 static void block_job_do_yield(BlockJob
*job
, uint64_t ns
)
1002 timer_mod(&job
->sleep_timer
, ns
);
1006 qemu_coroutine_yield();
1008 /* Set by block_job_enter before re-entering the coroutine. */
1012 void coroutine_fn
block_job_pause_point(BlockJob
*job
)
1014 assert(job
&& block_job_started(job
));
1016 if (!block_job_should_pause(job
)) {
1019 if (block_job_is_cancelled(job
)) {
1023 if (job
->driver
->pause
) {
1024 job
->driver
->pause(job
);
1027 if (block_job_should_pause(job
) && !block_job_is_cancelled(job
)) {
1028 BlockJobStatus status
= job
->status
;
1029 block_job_state_transition(job
, status
== BLOCK_JOB_STATUS_READY
? \
1030 BLOCK_JOB_STATUS_STANDBY
: \
1031 BLOCK_JOB_STATUS_PAUSED
);
1033 block_job_do_yield(job
, -1);
1034 job
->paused
= false;
1035 block_job_state_transition(job
, status
);
1038 if (job
->driver
->resume
) {
1039 job
->driver
->resume(job
);
1043 void block_job_resume_all(void)
1045 BlockJob
*job
, *next
;
1047 QLIST_FOREACH_SAFE(job
, &block_jobs
, job_list
, next
) {
1048 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
1050 aio_context_acquire(aio_context
);
1051 block_job_resume(job
);
1052 block_job_unref(job
);
1053 aio_context_release(aio_context
);
1058 * Conditionally enter a block_job pending a call to fn() while
1059 * under the block_job_lock critical section.
1061 static void block_job_enter_cond(BlockJob
*job
, bool(*fn
)(BlockJob
*job
))
1063 if (!block_job_started(job
)) {
1066 if (job
->deferred_to_main_loop
) {
1076 if (fn
&& !fn(job
)) {
1081 assert(!job
->deferred_to_main_loop
);
1082 timer_del(&job
->sleep_timer
);
1085 aio_co_wake(job
->co
);
1088 void block_job_enter(BlockJob
*job
)
1090 block_job_enter_cond(job
, NULL
);
1093 bool block_job_is_cancelled(BlockJob
*job
)
1095 return job
->cancelled
;
1098 void block_job_sleep_ns(BlockJob
*job
, int64_t ns
)
1102 /* Check cancellation *before* setting busy = false, too! */
1103 if (block_job_is_cancelled(job
)) {
1107 if (!block_job_should_pause(job
)) {
1108 block_job_do_yield(job
, qemu_clock_get_ns(QEMU_CLOCK_REALTIME
) + ns
);
1111 block_job_pause_point(job
);
1114 void block_job_yield(BlockJob
*job
)
1118 /* Check cancellation *before* setting busy = false, too! */
1119 if (block_job_is_cancelled(job
)) {
1123 if (!block_job_should_pause(job
)) {
1124 block_job_do_yield(job
, -1);
1127 block_job_pause_point(job
);
1130 void block_job_iostatus_reset(BlockJob
*job
)
1132 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
1135 assert(job
->user_paused
&& job
->pause_count
> 0);
1136 job
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
1139 void block_job_event_ready(BlockJob
*job
)
1141 block_job_state_transition(job
, BLOCK_JOB_STATUS_READY
);
1144 if (block_job_is_internal(job
)) {
1148 qapi_event_send_block_job_ready(job
->driver
->job_type
,
1152 job
->speed
, &error_abort
);
1155 BlockErrorAction
block_job_error_action(BlockJob
*job
, BlockdevOnError on_err
,
1156 int is_read
, int error
)
1158 BlockErrorAction action
;
1161 case BLOCKDEV_ON_ERROR_ENOSPC
:
1162 case BLOCKDEV_ON_ERROR_AUTO
:
1163 action
= (error
== ENOSPC
) ?
1164 BLOCK_ERROR_ACTION_STOP
: BLOCK_ERROR_ACTION_REPORT
;
1166 case BLOCKDEV_ON_ERROR_STOP
:
1167 action
= BLOCK_ERROR_ACTION_STOP
;
1169 case BLOCKDEV_ON_ERROR_REPORT
:
1170 action
= BLOCK_ERROR_ACTION_REPORT
;
1172 case BLOCKDEV_ON_ERROR_IGNORE
:
1173 action
= BLOCK_ERROR_ACTION_IGNORE
;
1178 if (!block_job_is_internal(job
)) {
1179 qapi_event_send_block_job_error(job
->id
,
1180 is_read
? IO_OPERATION_TYPE_READ
:
1181 IO_OPERATION_TYPE_WRITE
,
1182 action
, &error_abort
);
1184 if (action
== BLOCK_ERROR_ACTION_STOP
) {
1185 block_job_pause(job
);
1186 /* make the pause user visible, which will be resumed from QMP. */
1187 job
->user_paused
= true;
1188 block_job_iostatus_set_err(job
, error
);
1195 AioContext
*aio_context
;
1196 BlockJobDeferToMainLoopFn
*fn
;
1198 } BlockJobDeferToMainLoopData
;
1200 static void block_job_defer_to_main_loop_bh(void *opaque
)
1202 BlockJobDeferToMainLoopData
*data
= opaque
;
1203 AioContext
*aio_context
;
1205 /* Prevent race with block_job_defer_to_main_loop() */
1206 aio_context_acquire(data
->aio_context
);
1208 /* Fetch BDS AioContext again, in case it has changed */
1209 aio_context
= blk_get_aio_context(data
->job
->blk
);
1210 if (aio_context
!= data
->aio_context
) {
1211 aio_context_acquire(aio_context
);
1214 data
->fn(data
->job
, data
->opaque
);
1216 if (aio_context
!= data
->aio_context
) {
1217 aio_context_release(aio_context
);
1220 aio_context_release(data
->aio_context
);
1225 void block_job_defer_to_main_loop(BlockJob
*job
,
1226 BlockJobDeferToMainLoopFn
*fn
,
1229 BlockJobDeferToMainLoopData
*data
= g_malloc(sizeof(*data
));
1231 data
->aio_context
= blk_get_aio_context(job
->blk
);
1233 data
->opaque
= opaque
;
1234 job
->deferred_to_main_loop
= true;
1236 aio_bh_schedule_oneshot(qemu_get_aio_context(),
1237 block_job_defer_to_main_loop_bh
, data
);