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_FINALIZE
] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0},
69 [BLOCK_JOB_VERB_DISMISS
] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0},
72 static void block_job_state_transition(BlockJob
*job
, BlockJobStatus s1
)
74 BlockJobStatus s0
= job
->status
;
75 assert(s1
>= 0 && s1
<= BLOCK_JOB_STATUS__MAX
);
76 trace_block_job_state_transition(job
, job
->ret
, BlockJobSTT
[s0
][s1
] ?
77 "allowed" : "disallowed",
78 qapi_enum_lookup(&BlockJobStatus_lookup
,
80 qapi_enum_lookup(&BlockJobStatus_lookup
,
82 assert(BlockJobSTT
[s0
][s1
]);
86 static int block_job_apply_verb(BlockJob
*job
, BlockJobVerb bv
, Error
**errp
)
88 assert(bv
>= 0 && bv
<= BLOCK_JOB_VERB__MAX
);
89 trace_block_job_apply_verb(job
, qapi_enum_lookup(&BlockJobStatus_lookup
,
91 qapi_enum_lookup(&BlockJobVerb_lookup
, bv
),
92 BlockJobVerbTable
[bv
][job
->status
] ?
93 "allowed" : "prohibited");
94 if (BlockJobVerbTable
[bv
][job
->status
]) {
97 error_setg(errp
, "Job '%s' in state '%s' cannot accept command verb '%s'",
98 job
->id
, qapi_enum_lookup(&BlockJobStatus_lookup
, job
->status
),
99 qapi_enum_lookup(&BlockJobVerb_lookup
, bv
));
103 static void block_job_lock(void)
105 qemu_mutex_lock(&block_job_mutex
);
108 static void block_job_unlock(void)
110 qemu_mutex_unlock(&block_job_mutex
);
113 static void __attribute__((__constructor__
)) block_job_init(void)
115 qemu_mutex_init(&block_job_mutex
);
118 static void block_job_event_cancelled(BlockJob
*job
);
119 static void block_job_event_completed(BlockJob
*job
, const char *msg
);
120 static int block_job_event_pending(BlockJob
*job
);
121 static void block_job_enter_cond(BlockJob
*job
, bool(*fn
)(BlockJob
*job
));
123 /* Transactional group of block jobs */
126 /* Is this txn being cancelled? */
130 QLIST_HEAD(, BlockJob
) jobs
;
132 /* Reference count */
136 static QLIST_HEAD(, BlockJob
) block_jobs
= QLIST_HEAD_INITIALIZER(block_jobs
);
139 * The block job API is composed of two categories of functions.
141 * The first includes functions used by the monitor. The monitor is
142 * peculiar in that it accesses the block job list with block_job_get, and
143 * therefore needs consistency across block_job_get and the actual operation
144 * (e.g. block_job_set_speed). The consistency is achieved with
145 * aio_context_acquire/release. These functions are declared in blockjob.h.
147 * The second includes functions used by the block job drivers and sometimes
148 * by the core block layer. These do not care about locking, because the
149 * whole coroutine runs under the AioContext lock, and are declared in
153 BlockJob
*block_job_next(BlockJob
*job
)
156 return QLIST_FIRST(&block_jobs
);
158 return QLIST_NEXT(job
, job_list
);
161 BlockJob
*block_job_get(const char *id
)
165 QLIST_FOREACH(job
, &block_jobs
, job_list
) {
166 if (job
->id
&& !strcmp(id
, job
->id
)) {
174 BlockJobTxn
*block_job_txn_new(void)
176 BlockJobTxn
*txn
= g_new0(BlockJobTxn
, 1);
177 QLIST_INIT(&txn
->jobs
);
182 static void block_job_txn_ref(BlockJobTxn
*txn
)
187 void block_job_txn_unref(BlockJobTxn
*txn
)
189 if (txn
&& --txn
->refcnt
== 0) {
194 void block_job_txn_add_job(BlockJobTxn
*txn
, BlockJob
*job
)
203 QLIST_INSERT_HEAD(&txn
->jobs
, job
, txn_list
);
204 block_job_txn_ref(txn
);
207 static void block_job_pause(BlockJob
*job
)
212 static void block_job_resume(BlockJob
*job
)
214 assert(job
->pause_count
> 0);
216 if (job
->pause_count
) {
219 block_job_enter(job
);
222 void block_job_ref(BlockJob
*job
)
227 static void block_job_attached_aio_context(AioContext
*new_context
,
229 static void block_job_detach_aio_context(void *opaque
);
231 void block_job_unref(BlockJob
*job
)
233 if (--job
->refcnt
== 0) {
234 assert(job
->status
== BLOCK_JOB_STATUS_NULL
);
235 BlockDriverState
*bs
= blk_bs(job
->blk
);
236 QLIST_REMOVE(job
, job_list
);
238 block_job_remove_all_bdrv(job
);
239 blk_remove_aio_context_notifier(job
->blk
,
240 block_job_attached_aio_context
,
241 block_job_detach_aio_context
, job
);
243 error_free(job
->blocker
);
245 assert(!timer_pending(&job
->sleep_timer
));
250 static void block_job_attached_aio_context(AioContext
*new_context
,
253 BlockJob
*job
= opaque
;
255 if (job
->driver
->attached_aio_context
) {
256 job
->driver
->attached_aio_context(job
, new_context
);
259 block_job_resume(job
);
262 static void block_job_drain(BlockJob
*job
)
264 /* If job is !job->busy this kicks it into the next pause point. */
265 block_job_enter(job
);
268 if (job
->driver
->drain
) {
269 job
->driver
->drain(job
);
273 static void block_job_detach_aio_context(void *opaque
)
275 BlockJob
*job
= opaque
;
277 /* In case the job terminates during aio_poll()... */
280 block_job_pause(job
);
282 while (!job
->paused
&& !job
->completed
) {
283 block_job_drain(job
);
286 block_job_unref(job
);
289 static char *child_job_get_parent_desc(BdrvChild
*c
)
291 BlockJob
*job
= c
->opaque
;
292 return g_strdup_printf("%s job '%s'",
293 BlockJobType_str(job
->driver
->job_type
),
297 static void child_job_drained_begin(BdrvChild
*c
)
299 BlockJob
*job
= c
->opaque
;
300 block_job_pause(job
);
303 static void child_job_drained_end(BdrvChild
*c
)
305 BlockJob
*job
= c
->opaque
;
306 block_job_resume(job
);
309 static const BdrvChildRole child_job
= {
310 .get_parent_desc
= child_job_get_parent_desc
,
311 .drained_begin
= child_job_drained_begin
,
312 .drained_end
= child_job_drained_end
,
313 .stay_at_node
= true,
316 void block_job_remove_all_bdrv(BlockJob
*job
)
319 for (l
= job
->nodes
; l
; l
= l
->next
) {
320 BdrvChild
*c
= l
->data
;
321 bdrv_op_unblock_all(c
->bs
, job
->blocker
);
322 bdrv_root_unref_child(c
);
324 g_slist_free(job
->nodes
);
328 int block_job_add_bdrv(BlockJob
*job
, const char *name
, BlockDriverState
*bs
,
329 uint64_t perm
, uint64_t shared_perm
, Error
**errp
)
333 c
= bdrv_root_attach_child(bs
, name
, &child_job
, perm
, shared_perm
,
339 job
->nodes
= g_slist_prepend(job
->nodes
, c
);
341 bdrv_op_block_all(bs
, job
->blocker
);
346 bool block_job_is_internal(BlockJob
*job
)
348 return (job
->id
== NULL
);
351 static bool block_job_started(BlockJob
*job
)
357 * All jobs must allow a pause point before entering their job proper. This
358 * ensures that jobs can be paused prior to being started, then resumed later.
360 static void coroutine_fn
block_job_co_entry(void *opaque
)
362 BlockJob
*job
= opaque
;
364 assert(job
&& job
->driver
&& job
->driver
->start
);
365 block_job_pause_point(job
);
366 job
->driver
->start(job
);
369 static void block_job_sleep_timer_cb(void *opaque
)
371 BlockJob
*job
= opaque
;
373 block_job_enter(job
);
376 void block_job_start(BlockJob
*job
)
378 assert(job
&& !block_job_started(job
) && job
->paused
&&
379 job
->driver
&& job
->driver
->start
);
380 job
->co
= qemu_coroutine_create(block_job_co_entry
, job
);
384 block_job_state_transition(job
, BLOCK_JOB_STATUS_RUNNING
);
385 bdrv_coroutine_enter(blk_bs(job
->blk
), job
->co
);
388 static void block_job_decommission(BlockJob
*job
)
391 job
->completed
= true;
394 job
->deferred_to_main_loop
= true;
395 block_job_state_transition(job
, BLOCK_JOB_STATUS_NULL
);
396 block_job_unref(job
);
399 static void block_job_do_dismiss(BlockJob
*job
)
401 block_job_decommission(job
);
404 static void block_job_conclude(BlockJob
*job
)
406 block_job_state_transition(job
, BLOCK_JOB_STATUS_CONCLUDED
);
407 if (job
->auto_dismiss
|| !block_job_started(job
)) {
408 block_job_do_dismiss(job
);
412 static void block_job_update_rc(BlockJob
*job
)
414 if (!job
->ret
&& block_job_is_cancelled(job
)) {
415 job
->ret
= -ECANCELED
;
418 block_job_state_transition(job
, BLOCK_JOB_STATUS_ABORTING
);
422 static int block_job_prepare(BlockJob
*job
)
424 if (job
->ret
== 0 && job
->driver
->prepare
) {
425 job
->ret
= job
->driver
->prepare(job
);
430 static void block_job_commit(BlockJob
*job
)
433 if (job
->driver
->commit
) {
434 job
->driver
->commit(job
);
438 static void block_job_abort(BlockJob
*job
)
441 if (job
->driver
->abort
) {
442 job
->driver
->abort(job
);
446 static void block_job_clean(BlockJob
*job
)
448 if (job
->driver
->clean
) {
449 job
->driver
->clean(job
);
453 static int block_job_finalize_single(BlockJob
*job
)
455 assert(job
->completed
);
457 /* Ensure abort is called for late-transactional failures */
458 block_job_update_rc(job
);
461 block_job_commit(job
);
463 block_job_abort(job
);
465 block_job_clean(job
);
468 job
->cb(job
->opaque
, job
->ret
);
471 /* Emit events only if we actually started */
472 if (block_job_started(job
)) {
473 if (block_job_is_cancelled(job
)) {
474 block_job_event_cancelled(job
);
476 const char *msg
= NULL
;
478 msg
= strerror(-job
->ret
);
480 block_job_event_completed(job
, msg
);
484 QLIST_REMOVE(job
, txn_list
);
485 block_job_txn_unref(job
->txn
);
486 block_job_conclude(job
);
490 static void block_job_cancel_async(BlockJob
*job
)
492 if (job
->iostatus
!= BLOCK_DEVICE_IO_STATUS_OK
) {
493 block_job_iostatus_reset(job
);
495 if (job
->user_paused
) {
496 /* Do not call block_job_enter here, the caller will handle it. */
497 job
->user_paused
= false;
500 job
->cancelled
= true;
503 static int block_job_txn_apply(BlockJobTxn
*txn
, int fn(BlockJob
*), bool lock
)
506 BlockJob
*job
, *next
;
509 QLIST_FOREACH_SAFE(job
, &txn
->jobs
, txn_list
, next
) {
511 ctx
= blk_get_aio_context(job
->blk
);
512 aio_context_acquire(ctx
);
516 aio_context_release(ctx
);
525 static int block_job_finish_sync(BlockJob
*job
,
526 void (*finish
)(BlockJob
*, Error
**errp
),
529 Error
*local_err
= NULL
;
532 assert(blk_bs(job
->blk
)->job
== job
);
537 finish(job
, &local_err
);
540 error_propagate(errp
, local_err
);
541 block_job_unref(job
);
544 /* block_job_drain calls block_job_enter, and it should be enough to
545 * induce progress until the job completes or moves to the main thread.
547 while (!job
->deferred_to_main_loop
&& !job
->completed
) {
548 block_job_drain(job
);
550 while (!job
->completed
) {
551 aio_poll(qemu_get_aio_context(), true);
553 ret
= (job
->cancelled
&& job
->ret
== 0) ? -ECANCELED
: job
->ret
;
554 block_job_unref(job
);
558 static void block_job_completed_txn_abort(BlockJob
*job
)
561 BlockJobTxn
*txn
= job
->txn
;
566 * We are cancelled by another job, which will handle everything.
570 txn
->aborting
= true;
571 block_job_txn_ref(txn
);
573 /* We are the first failed job. Cancel other jobs. */
574 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
575 ctx
= blk_get_aio_context(other_job
->blk
);
576 aio_context_acquire(ctx
);
579 /* Other jobs are effectively cancelled by us, set the status for
580 * them; this job, however, may or may not be cancelled, depending
581 * on the caller, so leave it. */
582 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
583 if (other_job
!= job
) {
584 block_job_cancel_async(other_job
);
587 while (!QLIST_EMPTY(&txn
->jobs
)) {
588 other_job
= QLIST_FIRST(&txn
->jobs
);
589 ctx
= blk_get_aio_context(other_job
->blk
);
590 if (!other_job
->completed
) {
591 assert(other_job
->cancelled
);
592 block_job_finish_sync(other_job
, NULL
, NULL
);
594 block_job_finalize_single(other_job
);
595 aio_context_release(ctx
);
598 block_job_txn_unref(txn
);
601 static int block_job_needs_finalize(BlockJob
*job
)
603 return !job
->auto_finalize
;
606 static void block_job_do_finalize(BlockJob
*job
)
609 assert(job
&& job
->txn
);
611 /* prepare the transaction to complete */
612 rc
= block_job_txn_apply(job
->txn
, block_job_prepare
, true);
614 block_job_completed_txn_abort(job
);
616 block_job_txn_apply(job
->txn
, block_job_finalize_single
, true);
620 static void block_job_completed_txn_success(BlockJob
*job
)
622 BlockJobTxn
*txn
= job
->txn
;
625 block_job_state_transition(job
, BLOCK_JOB_STATUS_WAITING
);
628 * Successful completion, see if there are other running jobs in this
631 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
632 if (!other_job
->completed
) {
635 assert(other_job
->ret
== 0);
638 block_job_txn_apply(txn
, block_job_event_pending
, false);
640 /* If no jobs need manual finalization, automatically do so */
641 if (block_job_txn_apply(txn
, block_job_needs_finalize
, false) == 0) {
642 block_job_do_finalize(job
);
646 /* Assumes the block_job_mutex is held */
647 static bool block_job_timer_pending(BlockJob
*job
)
649 return timer_pending(&job
->sleep_timer
);
652 void block_job_set_speed(BlockJob
*job
, int64_t speed
, Error
**errp
)
654 Error
*local_err
= NULL
;
655 int64_t old_speed
= job
->speed
;
657 if (!job
->driver
->set_speed
) {
658 error_setg(errp
, QERR_UNSUPPORTED
);
661 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_SET_SPEED
, errp
)) {
664 job
->driver
->set_speed(job
, speed
, &local_err
);
666 error_propagate(errp
, local_err
);
671 if (speed
&& speed
<= old_speed
) {
675 /* kick only if a timer is pending */
676 block_job_enter_cond(job
, block_job_timer_pending
);
679 void block_job_complete(BlockJob
*job
, Error
**errp
)
681 /* Should not be reachable via external interface for internal jobs */
683 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_COMPLETE
, errp
)) {
686 if (job
->pause_count
|| job
->cancelled
|| !job
->driver
->complete
) {
687 error_setg(errp
, "The active block job '%s' cannot be completed",
692 job
->driver
->complete(job
, errp
);
695 void block_job_finalize(BlockJob
*job
, Error
**errp
)
697 assert(job
&& job
->id
&& job
->txn
);
698 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_FINALIZE
, errp
)) {
701 block_job_do_finalize(job
);
704 void block_job_dismiss(BlockJob
**jobptr
, Error
**errp
)
706 BlockJob
*job
= *jobptr
;
707 /* similarly to _complete, this is QMP-interface only. */
709 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_DISMISS
, errp
)) {
713 block_job_do_dismiss(job
);
717 void block_job_user_pause(BlockJob
*job
, Error
**errp
)
719 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_PAUSE
, errp
)) {
722 if (job
->user_paused
) {
723 error_setg(errp
, "Job is already paused");
726 job
->user_paused
= true;
727 block_job_pause(job
);
730 bool block_job_user_paused(BlockJob
*job
)
732 return job
->user_paused
;
735 void block_job_user_resume(BlockJob
*job
, Error
**errp
)
738 if (!job
->user_paused
|| job
->pause_count
<= 0) {
739 error_setg(errp
, "Can't resume a job that was not paused");
742 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_RESUME
, errp
)) {
745 block_job_iostatus_reset(job
);
746 job
->user_paused
= false;
747 block_job_resume(job
);
750 void block_job_cancel(BlockJob
*job
)
752 if (job
->status
== BLOCK_JOB_STATUS_CONCLUDED
) {
753 block_job_do_dismiss(job
);
756 block_job_cancel_async(job
);
757 if (!block_job_started(job
)) {
758 block_job_completed(job
, -ECANCELED
);
759 } else if (job
->deferred_to_main_loop
) {
760 block_job_completed_txn_abort(job
);
762 block_job_enter(job
);
766 void block_job_user_cancel(BlockJob
*job
, Error
**errp
)
768 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_CANCEL
, errp
)) {
771 block_job_cancel(job
);
774 /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
775 * used with block_job_finish_sync() without the need for (rather nasty)
776 * function pointer casts there. */
777 static void block_job_cancel_err(BlockJob
*job
, Error
**errp
)
779 block_job_cancel(job
);
782 int block_job_cancel_sync(BlockJob
*job
)
784 return block_job_finish_sync(job
, &block_job_cancel_err
, NULL
);
787 void block_job_cancel_sync_all(void)
790 AioContext
*aio_context
;
792 while ((job
= QLIST_FIRST(&block_jobs
))) {
793 aio_context
= blk_get_aio_context(job
->blk
);
794 aio_context_acquire(aio_context
);
795 block_job_cancel_sync(job
);
796 aio_context_release(aio_context
);
800 int block_job_complete_sync(BlockJob
*job
, Error
**errp
)
802 return block_job_finish_sync(job
, &block_job_complete
, errp
);
805 BlockJobInfo
*block_job_query(BlockJob
*job
, Error
**errp
)
809 if (block_job_is_internal(job
)) {
810 error_setg(errp
, "Cannot query QEMU internal jobs");
813 info
= g_new0(BlockJobInfo
, 1);
814 info
->type
= g_strdup(BlockJobType_str(job
->driver
->job_type
));
815 info
->device
= g_strdup(job
->id
);
816 info
->len
= job
->len
;
817 info
->busy
= atomic_read(&job
->busy
);
818 info
->paused
= job
->pause_count
> 0;
819 info
->offset
= job
->offset
;
820 info
->speed
= job
->speed
;
821 info
->io_status
= job
->iostatus
;
822 info
->ready
= job
->ready
;
823 info
->status
= job
->status
;
827 static void block_job_iostatus_set_err(BlockJob
*job
, int error
)
829 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
830 job
->iostatus
= error
== ENOSPC
? BLOCK_DEVICE_IO_STATUS_NOSPACE
:
831 BLOCK_DEVICE_IO_STATUS_FAILED
;
835 static void block_job_event_cancelled(BlockJob
*job
)
837 if (block_job_is_internal(job
)) {
841 qapi_event_send_block_job_cancelled(job
->driver
->job_type
,
849 static void block_job_event_completed(BlockJob
*job
, const char *msg
)
851 if (block_job_is_internal(job
)) {
855 qapi_event_send_block_job_completed(job
->driver
->job_type
,
865 static int block_job_event_pending(BlockJob
*job
)
867 block_job_state_transition(job
, BLOCK_JOB_STATUS_PENDING
);
868 if (!job
->auto_finalize
&& !block_job_is_internal(job
)) {
869 qapi_event_send_block_job_pending(job
->driver
->job_type
,
877 * API for block job drivers and the block layer. These functions are
878 * declared in blockjob_int.h.
881 void *block_job_create(const char *job_id
, const BlockJobDriver
*driver
,
882 BlockJobTxn
*txn
, BlockDriverState
*bs
, uint64_t perm
,
883 uint64_t shared_perm
, int64_t speed
, int flags
,
884 BlockCompletionFunc
*cb
, void *opaque
, Error
**errp
)
891 error_setg(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
895 if (job_id
== NULL
&& !(flags
& BLOCK_JOB_INTERNAL
)) {
896 job_id
= bdrv_get_device_name(bs
);
898 error_setg(errp
, "An explicit job ID is required for this node");
904 if (flags
& BLOCK_JOB_INTERNAL
) {
905 error_setg(errp
, "Cannot specify job ID for internal block job");
909 if (!id_wellformed(job_id
)) {
910 error_setg(errp
, "Invalid job ID '%s'", job_id
);
914 if (block_job_get(job_id
)) {
915 error_setg(errp
, "Job ID '%s' already in use", job_id
);
920 blk
= blk_new(perm
, shared_perm
);
921 ret
= blk_insert_bs(blk
, bs
, errp
);
927 job
= g_malloc0(driver
->instance_size
);
928 job
->driver
= driver
;
929 job
->id
= g_strdup(job_id
);
932 job
->opaque
= opaque
;
935 job
->pause_count
= 1;
937 job
->auto_finalize
= !(flags
& BLOCK_JOB_MANUAL_FINALIZE
);
938 job
->auto_dismiss
= !(flags
& BLOCK_JOB_MANUAL_DISMISS
);
939 block_job_state_transition(job
, BLOCK_JOB_STATUS_CREATED
);
940 aio_timer_init(qemu_get_aio_context(), &job
->sleep_timer
,
941 QEMU_CLOCK_REALTIME
, SCALE_NS
,
942 block_job_sleep_timer_cb
, job
);
944 error_setg(&job
->blocker
, "block device is in use by block job: %s",
945 BlockJobType_str(driver
->job_type
));
946 block_job_add_bdrv(job
, "main node", bs
, 0, BLK_PERM_ALL
, &error_abort
);
949 bdrv_op_unblock(bs
, BLOCK_OP_TYPE_DATAPLANE
, job
->blocker
);
951 QLIST_INSERT_HEAD(&block_jobs
, job
, job_list
);
953 blk_add_aio_context_notifier(blk
, block_job_attached_aio_context
,
954 block_job_detach_aio_context
, job
);
956 /* Only set speed when necessary to avoid NotSupported error */
958 Error
*local_err
= NULL
;
960 block_job_set_speed(job
, speed
, &local_err
);
962 block_job_early_fail(job
);
963 error_propagate(errp
, local_err
);
968 /* Single jobs are modeled as single-job transactions for sake of
969 * consolidating the job management logic */
971 txn
= block_job_txn_new();
972 block_job_txn_add_job(txn
, job
);
973 block_job_txn_unref(txn
);
975 block_job_txn_add_job(txn
, job
);
981 void block_job_pause_all(void)
983 BlockJob
*job
= NULL
;
984 while ((job
= block_job_next(job
))) {
985 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
987 aio_context_acquire(aio_context
);
989 block_job_pause(job
);
990 aio_context_release(aio_context
);
994 void block_job_early_fail(BlockJob
*job
)
996 assert(job
->status
== BLOCK_JOB_STATUS_CREATED
);
997 block_job_decommission(job
);
1000 void block_job_completed(BlockJob
*job
, int ret
)
1002 assert(job
&& job
->txn
&& !job
->completed
);
1003 assert(blk_bs(job
->blk
)->job
== job
);
1004 job
->completed
= true;
1006 block_job_update_rc(job
);
1007 trace_block_job_completed(job
, ret
, job
->ret
);
1009 block_job_completed_txn_abort(job
);
1011 block_job_completed_txn_success(job
);
1015 static bool block_job_should_pause(BlockJob
*job
)
1017 return job
->pause_count
> 0;
1020 /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds.
1021 * Reentering the job coroutine with block_job_enter() before the timer has
1022 * expired is allowed and cancels the timer.
1024 * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be
1025 * called explicitly. */
1026 static void block_job_do_yield(BlockJob
*job
, uint64_t ns
)
1030 timer_mod(&job
->sleep_timer
, ns
);
1034 qemu_coroutine_yield();
1036 /* Set by block_job_enter before re-entering the coroutine. */
1040 void coroutine_fn
block_job_pause_point(BlockJob
*job
)
1042 assert(job
&& block_job_started(job
));
1044 if (!block_job_should_pause(job
)) {
1047 if (block_job_is_cancelled(job
)) {
1051 if (job
->driver
->pause
) {
1052 job
->driver
->pause(job
);
1055 if (block_job_should_pause(job
) && !block_job_is_cancelled(job
)) {
1056 BlockJobStatus status
= job
->status
;
1057 block_job_state_transition(job
, status
== BLOCK_JOB_STATUS_READY
? \
1058 BLOCK_JOB_STATUS_STANDBY
: \
1059 BLOCK_JOB_STATUS_PAUSED
);
1061 block_job_do_yield(job
, -1);
1062 job
->paused
= false;
1063 block_job_state_transition(job
, status
);
1066 if (job
->driver
->resume
) {
1067 job
->driver
->resume(job
);
1071 void block_job_resume_all(void)
1073 BlockJob
*job
, *next
;
1075 QLIST_FOREACH_SAFE(job
, &block_jobs
, job_list
, next
) {
1076 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
1078 aio_context_acquire(aio_context
);
1079 block_job_resume(job
);
1080 block_job_unref(job
);
1081 aio_context_release(aio_context
);
1086 * Conditionally enter a block_job pending a call to fn() while
1087 * under the block_job_lock critical section.
1089 static void block_job_enter_cond(BlockJob
*job
, bool(*fn
)(BlockJob
*job
))
1091 if (!block_job_started(job
)) {
1094 if (job
->deferred_to_main_loop
) {
1104 if (fn
&& !fn(job
)) {
1109 assert(!job
->deferred_to_main_loop
);
1110 timer_del(&job
->sleep_timer
);
1113 aio_co_wake(job
->co
);
1116 void block_job_enter(BlockJob
*job
)
1118 block_job_enter_cond(job
, NULL
);
1121 bool block_job_is_cancelled(BlockJob
*job
)
1123 return job
->cancelled
;
1126 void block_job_sleep_ns(BlockJob
*job
, int64_t ns
)
1130 /* Check cancellation *before* setting busy = false, too! */
1131 if (block_job_is_cancelled(job
)) {
1135 if (!block_job_should_pause(job
)) {
1136 block_job_do_yield(job
, qemu_clock_get_ns(QEMU_CLOCK_REALTIME
) + ns
);
1139 block_job_pause_point(job
);
1142 void block_job_yield(BlockJob
*job
)
1146 /* Check cancellation *before* setting busy = false, too! */
1147 if (block_job_is_cancelled(job
)) {
1151 if (!block_job_should_pause(job
)) {
1152 block_job_do_yield(job
, -1);
1155 block_job_pause_point(job
);
1158 void block_job_iostatus_reset(BlockJob
*job
)
1160 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
1163 assert(job
->user_paused
&& job
->pause_count
> 0);
1164 job
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
1167 void block_job_event_ready(BlockJob
*job
)
1169 block_job_state_transition(job
, BLOCK_JOB_STATUS_READY
);
1172 if (block_job_is_internal(job
)) {
1176 qapi_event_send_block_job_ready(job
->driver
->job_type
,
1180 job
->speed
, &error_abort
);
1183 BlockErrorAction
block_job_error_action(BlockJob
*job
, BlockdevOnError on_err
,
1184 int is_read
, int error
)
1186 BlockErrorAction action
;
1189 case BLOCKDEV_ON_ERROR_ENOSPC
:
1190 case BLOCKDEV_ON_ERROR_AUTO
:
1191 action
= (error
== ENOSPC
) ?
1192 BLOCK_ERROR_ACTION_STOP
: BLOCK_ERROR_ACTION_REPORT
;
1194 case BLOCKDEV_ON_ERROR_STOP
:
1195 action
= BLOCK_ERROR_ACTION_STOP
;
1197 case BLOCKDEV_ON_ERROR_REPORT
:
1198 action
= BLOCK_ERROR_ACTION_REPORT
;
1200 case BLOCKDEV_ON_ERROR_IGNORE
:
1201 action
= BLOCK_ERROR_ACTION_IGNORE
;
1206 if (!block_job_is_internal(job
)) {
1207 qapi_event_send_block_job_error(job
->id
,
1208 is_read
? IO_OPERATION_TYPE_READ
:
1209 IO_OPERATION_TYPE_WRITE
,
1210 action
, &error_abort
);
1212 if (action
== BLOCK_ERROR_ACTION_STOP
) {
1213 block_job_pause(job
);
1214 /* make the pause user visible, which will be resumed from QMP. */
1215 job
->user_paused
= true;
1216 block_job_iostatus_set_err(job
, error
);
1223 AioContext
*aio_context
;
1224 BlockJobDeferToMainLoopFn
*fn
;
1226 } BlockJobDeferToMainLoopData
;
1228 static void block_job_defer_to_main_loop_bh(void *opaque
)
1230 BlockJobDeferToMainLoopData
*data
= opaque
;
1231 AioContext
*aio_context
;
1233 /* Prevent race with block_job_defer_to_main_loop() */
1234 aio_context_acquire(data
->aio_context
);
1236 /* Fetch BDS AioContext again, in case it has changed */
1237 aio_context
= blk_get_aio_context(data
->job
->blk
);
1238 if (aio_context
!= data
->aio_context
) {
1239 aio_context_acquire(aio_context
);
1242 data
->fn(data
->job
, data
->opaque
);
1244 if (aio_context
!= data
->aio_context
) {
1245 aio_context_release(aio_context
);
1248 aio_context_release(data
->aio_context
);
1253 void block_job_defer_to_main_loop(BlockJob
*job
,
1254 BlockJobDeferToMainLoopFn
*fn
,
1257 BlockJobDeferToMainLoopData
*data
= g_malloc(sizeof(*data
));
1259 data
->aio_context
= blk_get_aio_context(job
->blk
);
1261 data
->opaque
= opaque
;
1262 job
->deferred_to_main_loop
= true;
1264 aio_bh_schedule_oneshot(qemu_get_aio_context(),
1265 block_job_defer_to_main_loop_bh
, data
);