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"
37 #include "qemu/timer.h"
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
42 static QemuMutex block_job_mutex
;
44 /* BlockJob State Transition Table */
45 bool BlockJobSTT
[BLOCK_JOB_STATUS__MAX
][BLOCK_JOB_STATUS__MAX
] = {
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},
60 bool BlockJobVerbTable
[BLOCK_JOB_VERB__MAX
][BLOCK_JOB_STATUS__MAX
] = {
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},
67 [BLOCK_JOB_VERB_FINALIZE
] = {0, 0, 0, 0, 0, 0, 0, 1, 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 BlockJobStatus_str(s0
),
78 BlockJobStatus_str(s1
));
79 assert(BlockJobSTT
[s0
][s1
]);
83 static int block_job_apply_verb(BlockJob
*job
, BlockJobVerb bv
, Error
**errp
)
85 assert(bv
>= 0 && bv
<= BLOCK_JOB_VERB__MAX
);
86 trace_block_job_apply_verb(job
, BlockJobStatus_str(job
->status
),
88 BlockJobVerbTable
[bv
][job
->status
] ?
89 "allowed" : "prohibited");
90 if (BlockJobVerbTable
[bv
][job
->status
]) {
93 error_setg(errp
, "Job '%s' in state '%s' cannot accept command verb '%s'",
94 job
->job
.id
, BlockJobStatus_str(job
->status
),
95 BlockJobVerb_str(bv
));
99 static void block_job_lock(void)
101 qemu_mutex_lock(&block_job_mutex
);
104 static void block_job_unlock(void)
106 qemu_mutex_unlock(&block_job_mutex
);
109 static void __attribute__((__constructor__
)) block_job_init(void)
111 qemu_mutex_init(&block_job_mutex
);
114 static void block_job_event_cancelled(BlockJob
*job
);
115 static void block_job_event_completed(BlockJob
*job
, const char *msg
);
116 static int block_job_event_pending(BlockJob
*job
);
117 static void block_job_enter_cond(BlockJob
*job
, bool(*fn
)(BlockJob
*job
));
119 /* Transactional group of block jobs */
122 /* Is this txn being cancelled? */
126 QLIST_HEAD(, BlockJob
) jobs
;
128 /* Reference count */
132 static QLIST_HEAD(, BlockJob
) block_jobs
= QLIST_HEAD_INITIALIZER(block_jobs
);
135 * The block job API is composed of two categories of functions.
137 * The first includes functions used by the monitor. The monitor is
138 * peculiar in that it accesses the block job list with block_job_get, and
139 * therefore needs consistency across block_job_get and the actual operation
140 * (e.g. block_job_set_speed). The consistency is achieved with
141 * aio_context_acquire/release. These functions are declared in blockjob.h.
143 * The second includes functions used by the block job drivers and sometimes
144 * by the core block layer. These do not care about locking, because the
145 * whole coroutine runs under the AioContext lock, and are declared in
149 BlockJob
*block_job_next(BlockJob
*job
)
152 return QLIST_FIRST(&block_jobs
);
154 return QLIST_NEXT(job
, job_list
);
157 BlockJob
*block_job_get(const char *id
)
161 QLIST_FOREACH(job
, &block_jobs
, job_list
) {
162 if (job
->job
.id
&& !strcmp(id
, job
->job
.id
)) {
170 BlockJobTxn
*block_job_txn_new(void)
172 BlockJobTxn
*txn
= g_new0(BlockJobTxn
, 1);
173 QLIST_INIT(&txn
->jobs
);
178 static void block_job_txn_ref(BlockJobTxn
*txn
)
183 void block_job_txn_unref(BlockJobTxn
*txn
)
185 if (txn
&& --txn
->refcnt
== 0) {
190 void block_job_txn_add_job(BlockJobTxn
*txn
, BlockJob
*job
)
199 QLIST_INSERT_HEAD(&txn
->jobs
, job
, txn_list
);
200 block_job_txn_ref(txn
);
203 static void block_job_txn_del_job(BlockJob
*job
)
206 QLIST_REMOVE(job
, txn_list
);
207 block_job_txn_unref(job
->txn
);
212 /* Assumes the block_job_mutex is held */
213 static bool block_job_timer_pending(BlockJob
*job
)
215 return timer_pending(&job
->sleep_timer
);
218 /* Assumes the block_job_mutex is held */
219 static bool block_job_timer_not_pending(BlockJob
*job
)
221 return !block_job_timer_pending(job
);
224 static void block_job_pause(BlockJob
*job
)
229 static void block_job_resume(BlockJob
*job
)
231 assert(job
->pause_count
> 0);
233 if (job
->pause_count
) {
237 /* kick only if no timer is pending */
238 block_job_enter_cond(job
, block_job_timer_not_pending
);
241 void block_job_ref(BlockJob
*job
)
246 static void block_job_attached_aio_context(AioContext
*new_context
,
248 static void block_job_detach_aio_context(void *opaque
);
250 void block_job_unref(BlockJob
*job
)
252 if (--job
->refcnt
== 0) {
253 assert(job
->status
== BLOCK_JOB_STATUS_NULL
);
255 BlockDriverState
*bs
= blk_bs(job
->blk
);
256 QLIST_REMOVE(job
, job_list
);
258 block_job_remove_all_bdrv(job
);
259 blk_remove_aio_context_notifier(job
->blk
,
260 block_job_attached_aio_context
,
261 block_job_detach_aio_context
, job
);
263 error_free(job
->blocker
);
264 assert(!timer_pending(&job
->sleep_timer
));
265 job_delete(&job
->job
);
269 static void block_job_attached_aio_context(AioContext
*new_context
,
272 BlockJob
*job
= opaque
;
274 if (job
->driver
->attached_aio_context
) {
275 job
->driver
->attached_aio_context(job
, new_context
);
278 block_job_resume(job
);
281 static void block_job_drain(BlockJob
*job
)
283 /* If job is !job->busy this kicks it into the next pause point. */
284 block_job_enter(job
);
287 if (job
->driver
->drain
) {
288 job
->driver
->drain(job
);
292 static void block_job_detach_aio_context(void *opaque
)
294 BlockJob
*job
= opaque
;
296 /* In case the job terminates during aio_poll()... */
299 block_job_pause(job
);
301 while (!job
->paused
&& !job
->completed
) {
302 block_job_drain(job
);
305 block_job_unref(job
);
308 static char *child_job_get_parent_desc(BdrvChild
*c
)
310 BlockJob
*job
= c
->opaque
;
311 return g_strdup_printf("%s job '%s'", job_type_str(&job
->job
), job
->job
.id
);
314 static void child_job_drained_begin(BdrvChild
*c
)
316 BlockJob
*job
= c
->opaque
;
317 block_job_pause(job
);
320 static void child_job_drained_end(BdrvChild
*c
)
322 BlockJob
*job
= c
->opaque
;
323 block_job_resume(job
);
326 static const BdrvChildRole child_job
= {
327 .get_parent_desc
= child_job_get_parent_desc
,
328 .drained_begin
= child_job_drained_begin
,
329 .drained_end
= child_job_drained_end
,
330 .stay_at_node
= true,
333 void block_job_remove_all_bdrv(BlockJob
*job
)
336 for (l
= job
->nodes
; l
; l
= l
->next
) {
337 BdrvChild
*c
= l
->data
;
338 bdrv_op_unblock_all(c
->bs
, job
->blocker
);
339 bdrv_root_unref_child(c
);
341 g_slist_free(job
->nodes
);
345 int block_job_add_bdrv(BlockJob
*job
, const char *name
, BlockDriverState
*bs
,
346 uint64_t perm
, uint64_t shared_perm
, Error
**errp
)
350 c
= bdrv_root_attach_child(bs
, name
, &child_job
, perm
, shared_perm
,
356 job
->nodes
= g_slist_prepend(job
->nodes
, c
);
358 bdrv_op_block_all(bs
, job
->blocker
);
363 bool block_job_is_internal(BlockJob
*job
)
365 return (job
->job
.id
== NULL
);
368 static bool block_job_started(BlockJob
*job
)
373 const BlockJobDriver
*block_job_driver(BlockJob
*job
)
379 * All jobs must allow a pause point before entering their job proper. This
380 * ensures that jobs can be paused prior to being started, then resumed later.
382 static void coroutine_fn
block_job_co_entry(void *opaque
)
384 BlockJob
*job
= opaque
;
386 assert(job
&& job
->driver
&& job
->driver
->start
);
387 block_job_pause_point(job
);
388 job
->driver
->start(job
);
391 static void block_job_sleep_timer_cb(void *opaque
)
393 BlockJob
*job
= opaque
;
395 block_job_enter(job
);
398 void block_job_start(BlockJob
*job
)
400 assert(job
&& !block_job_started(job
) && job
->paused
&&
401 job
->driver
&& job
->driver
->start
);
402 job
->co
= qemu_coroutine_create(block_job_co_entry
, job
);
406 block_job_state_transition(job
, BLOCK_JOB_STATUS_RUNNING
);
407 bdrv_coroutine_enter(blk_bs(job
->blk
), job
->co
);
410 static void block_job_decommission(BlockJob
*job
)
413 job
->completed
= true;
416 job
->deferred_to_main_loop
= true;
417 block_job_txn_del_job(job
);
418 block_job_state_transition(job
, BLOCK_JOB_STATUS_NULL
);
419 block_job_unref(job
);
422 static void block_job_do_dismiss(BlockJob
*job
)
424 block_job_decommission(job
);
427 static void block_job_conclude(BlockJob
*job
)
429 block_job_state_transition(job
, BLOCK_JOB_STATUS_CONCLUDED
);
430 if (job
->auto_dismiss
|| !block_job_started(job
)) {
431 block_job_do_dismiss(job
);
435 static void block_job_update_rc(BlockJob
*job
)
437 if (!job
->ret
&& block_job_is_cancelled(job
)) {
438 job
->ret
= -ECANCELED
;
441 block_job_state_transition(job
, BLOCK_JOB_STATUS_ABORTING
);
445 static int block_job_prepare(BlockJob
*job
)
447 if (job
->ret
== 0 && job
->driver
->prepare
) {
448 job
->ret
= job
->driver
->prepare(job
);
453 static void block_job_commit(BlockJob
*job
)
456 if (job
->driver
->commit
) {
457 job
->driver
->commit(job
);
461 static void block_job_abort(BlockJob
*job
)
464 if (job
->driver
->abort
) {
465 job
->driver
->abort(job
);
469 static void block_job_clean(BlockJob
*job
)
471 if (job
->driver
->clean
) {
472 job
->driver
->clean(job
);
476 static int block_job_finalize_single(BlockJob
*job
)
478 assert(job
->completed
);
480 /* Ensure abort is called for late-transactional failures */
481 block_job_update_rc(job
);
484 block_job_commit(job
);
486 block_job_abort(job
);
488 block_job_clean(job
);
491 job
->cb(job
->opaque
, job
->ret
);
494 /* Emit events only if we actually started */
495 if (block_job_started(job
)) {
496 if (block_job_is_cancelled(job
)) {
497 block_job_event_cancelled(job
);
499 const char *msg
= NULL
;
501 msg
= strerror(-job
->ret
);
503 block_job_event_completed(job
, msg
);
507 block_job_txn_del_job(job
);
508 block_job_conclude(job
);
512 static void block_job_cancel_async(BlockJob
*job
, bool force
)
514 if (job
->iostatus
!= BLOCK_DEVICE_IO_STATUS_OK
) {
515 block_job_iostatus_reset(job
);
517 if (job
->user_paused
) {
518 /* Do not call block_job_enter here, the caller will handle it. */
519 job
->user_paused
= false;
522 job
->cancelled
= true;
523 /* To prevent 'force == false' overriding a previous 'force == true' */
527 static int block_job_txn_apply(BlockJobTxn
*txn
, int fn(BlockJob
*), bool lock
)
530 BlockJob
*job
, *next
;
533 QLIST_FOREACH_SAFE(job
, &txn
->jobs
, txn_list
, next
) {
535 ctx
= blk_get_aio_context(job
->blk
);
536 aio_context_acquire(ctx
);
540 aio_context_release(ctx
);
549 static int block_job_finish_sync(BlockJob
*job
,
550 void (*finish
)(BlockJob
*, Error
**errp
),
553 Error
*local_err
= NULL
;
556 assert(blk_bs(job
->blk
)->job
== job
);
561 finish(job
, &local_err
);
564 error_propagate(errp
, local_err
);
565 block_job_unref(job
);
568 /* block_job_drain calls block_job_enter, and it should be enough to
569 * induce progress until the job completes or moves to the main thread.
571 while (!job
->deferred_to_main_loop
&& !job
->completed
) {
572 block_job_drain(job
);
574 while (!job
->completed
) {
575 aio_poll(qemu_get_aio_context(), true);
577 ret
= (job
->cancelled
&& job
->ret
== 0) ? -ECANCELED
: job
->ret
;
578 block_job_unref(job
);
582 static void block_job_completed_txn_abort(BlockJob
*job
)
585 BlockJobTxn
*txn
= job
->txn
;
590 * We are cancelled by another job, which will handle everything.
594 txn
->aborting
= true;
595 block_job_txn_ref(txn
);
597 /* We are the first failed job. Cancel other jobs. */
598 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
599 ctx
= blk_get_aio_context(other_job
->blk
);
600 aio_context_acquire(ctx
);
603 /* Other jobs are effectively cancelled by us, set the status for
604 * them; this job, however, may or may not be cancelled, depending
605 * on the caller, so leave it. */
606 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
607 if (other_job
!= job
) {
608 block_job_cancel_async(other_job
, false);
611 while (!QLIST_EMPTY(&txn
->jobs
)) {
612 other_job
= QLIST_FIRST(&txn
->jobs
);
613 ctx
= blk_get_aio_context(other_job
->blk
);
614 if (!other_job
->completed
) {
615 assert(other_job
->cancelled
);
616 block_job_finish_sync(other_job
, NULL
, NULL
);
618 block_job_finalize_single(other_job
);
619 aio_context_release(ctx
);
622 block_job_txn_unref(txn
);
625 static int block_job_needs_finalize(BlockJob
*job
)
627 return !job
->auto_finalize
;
630 static void block_job_do_finalize(BlockJob
*job
)
633 assert(job
&& job
->txn
);
635 /* prepare the transaction to complete */
636 rc
= block_job_txn_apply(job
->txn
, block_job_prepare
, true);
638 block_job_completed_txn_abort(job
);
640 block_job_txn_apply(job
->txn
, block_job_finalize_single
, true);
644 static void block_job_completed_txn_success(BlockJob
*job
)
646 BlockJobTxn
*txn
= job
->txn
;
649 block_job_state_transition(job
, BLOCK_JOB_STATUS_WAITING
);
652 * Successful completion, see if there are other running jobs in this
655 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
656 if (!other_job
->completed
) {
659 assert(other_job
->ret
== 0);
662 block_job_txn_apply(txn
, block_job_event_pending
, false);
664 /* If no jobs need manual finalization, automatically do so */
665 if (block_job_txn_apply(txn
, block_job_needs_finalize
, false) == 0) {
666 block_job_do_finalize(job
);
670 void block_job_set_speed(BlockJob
*job
, int64_t speed
, Error
**errp
)
672 int64_t old_speed
= job
->speed
;
674 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_SET_SPEED
, errp
)) {
678 error_setg(errp
, QERR_INVALID_PARAMETER
, "speed");
682 ratelimit_set_speed(&job
->limit
, speed
, BLOCK_JOB_SLICE_TIME
);
685 if (speed
&& speed
<= old_speed
) {
689 /* kick only if a timer is pending */
690 block_job_enter_cond(job
, block_job_timer_pending
);
693 int64_t block_job_ratelimit_get_delay(BlockJob
*job
, uint64_t n
)
699 return ratelimit_calculate_delay(&job
->limit
, n
);
702 void block_job_complete(BlockJob
*job
, Error
**errp
)
704 /* Should not be reachable via external interface for internal jobs */
706 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_COMPLETE
, errp
)) {
709 if (job
->pause_count
|| job
->cancelled
|| !job
->driver
->complete
) {
710 error_setg(errp
, "The active block job '%s' cannot be completed",
715 job
->driver
->complete(job
, errp
);
718 void block_job_finalize(BlockJob
*job
, Error
**errp
)
720 assert(job
&& job
->job
.id
);
721 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_FINALIZE
, errp
)) {
724 block_job_do_finalize(job
);
727 void block_job_dismiss(BlockJob
**jobptr
, Error
**errp
)
729 BlockJob
*job
= *jobptr
;
730 /* similarly to _complete, this is QMP-interface only. */
732 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_DISMISS
, errp
)) {
736 block_job_do_dismiss(job
);
740 void block_job_user_pause(BlockJob
*job
, Error
**errp
)
742 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_PAUSE
, errp
)) {
745 if (job
->user_paused
) {
746 error_setg(errp
, "Job is already paused");
749 job
->user_paused
= true;
750 block_job_pause(job
);
753 bool block_job_user_paused(BlockJob
*job
)
755 return job
->user_paused
;
758 void block_job_user_resume(BlockJob
*job
, Error
**errp
)
761 if (!job
->user_paused
|| job
->pause_count
<= 0) {
762 error_setg(errp
, "Can't resume a job that was not paused");
765 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_RESUME
, errp
)) {
768 block_job_iostatus_reset(job
);
769 job
->user_paused
= false;
770 block_job_resume(job
);
773 void block_job_cancel(BlockJob
*job
, bool force
)
775 if (job
->status
== BLOCK_JOB_STATUS_CONCLUDED
) {
776 block_job_do_dismiss(job
);
779 block_job_cancel_async(job
, force
);
780 if (!block_job_started(job
)) {
781 block_job_completed(job
, -ECANCELED
);
782 } else if (job
->deferred_to_main_loop
) {
783 block_job_completed_txn_abort(job
);
785 block_job_enter(job
);
789 void block_job_user_cancel(BlockJob
*job
, bool force
, Error
**errp
)
791 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_CANCEL
, errp
)) {
794 block_job_cancel(job
, force
);
797 /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
798 * used with block_job_finish_sync() without the need for (rather nasty)
799 * function pointer casts there. */
800 static void block_job_cancel_err(BlockJob
*job
, Error
**errp
)
802 block_job_cancel(job
, false);
805 int block_job_cancel_sync(BlockJob
*job
)
807 return block_job_finish_sync(job
, &block_job_cancel_err
, NULL
);
810 void block_job_cancel_sync_all(void)
813 AioContext
*aio_context
;
815 while ((job
= QLIST_FIRST(&block_jobs
))) {
816 aio_context
= blk_get_aio_context(job
->blk
);
817 aio_context_acquire(aio_context
);
818 block_job_cancel_sync(job
);
819 aio_context_release(aio_context
);
823 int block_job_complete_sync(BlockJob
*job
, Error
**errp
)
825 return block_job_finish_sync(job
, &block_job_complete
, errp
);
828 void block_job_progress_update(BlockJob
*job
, uint64_t done
)
833 void block_job_progress_set_remaining(BlockJob
*job
, uint64_t remaining
)
835 job
->len
= job
->offset
+ remaining
;
838 BlockJobInfo
*block_job_query(BlockJob
*job
, Error
**errp
)
842 if (block_job_is_internal(job
)) {
843 error_setg(errp
, "Cannot query QEMU internal jobs");
846 info
= g_new0(BlockJobInfo
, 1);
847 info
->type
= g_strdup(job_type_str(&job
->job
));
848 info
->device
= g_strdup(job
->job
.id
);
849 info
->len
= job
->len
;
850 info
->busy
= atomic_read(&job
->busy
);
851 info
->paused
= job
->pause_count
> 0;
852 info
->offset
= job
->offset
;
853 info
->speed
= job
->speed
;
854 info
->io_status
= job
->iostatus
;
855 info
->ready
= job
->ready
;
856 info
->status
= job
->status
;
857 info
->auto_finalize
= job
->auto_finalize
;
858 info
->auto_dismiss
= job
->auto_dismiss
;
859 info
->has_error
= job
->ret
!= 0;
860 info
->error
= job
->ret
? g_strdup(strerror(-job
->ret
)) : NULL
;
864 static void block_job_iostatus_set_err(BlockJob
*job
, int error
)
866 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
867 job
->iostatus
= error
== ENOSPC
? BLOCK_DEVICE_IO_STATUS_NOSPACE
:
868 BLOCK_DEVICE_IO_STATUS_FAILED
;
872 static void block_job_event_cancelled(BlockJob
*job
)
874 if (block_job_is_internal(job
)) {
878 qapi_event_send_block_job_cancelled(job_type(&job
->job
),
886 static void block_job_event_completed(BlockJob
*job
, const char *msg
)
888 if (block_job_is_internal(job
)) {
892 qapi_event_send_block_job_completed(job_type(&job
->job
),
902 static int block_job_event_pending(BlockJob
*job
)
904 block_job_state_transition(job
, BLOCK_JOB_STATUS_PENDING
);
905 if (!job
->auto_finalize
&& !block_job_is_internal(job
)) {
906 qapi_event_send_block_job_pending(job_type(&job
->job
),
914 * API for block job drivers and the block layer. These functions are
915 * declared in blockjob_int.h.
918 void *block_job_create(const char *job_id
, const BlockJobDriver
*driver
,
919 BlockJobTxn
*txn
, BlockDriverState
*bs
, uint64_t perm
,
920 uint64_t shared_perm
, int64_t speed
, int flags
,
921 BlockCompletionFunc
*cb
, void *opaque
, Error
**errp
)
928 error_setg(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
932 if (job_id
== NULL
&& !(flags
& BLOCK_JOB_INTERNAL
)) {
933 job_id
= bdrv_get_device_name(bs
);
935 error_setg(errp
, "An explicit job ID is required for this node");
941 if (flags
& BLOCK_JOB_INTERNAL
) {
942 error_setg(errp
, "Cannot specify job ID for internal block job");
945 if (block_job_get(job_id
)) {
946 error_setg(errp
, "Job ID '%s' already in use", job_id
);
951 blk
= blk_new(perm
, shared_perm
);
952 ret
= blk_insert_bs(blk
, bs
, errp
);
958 job
= job_create(job_id
, &driver
->job_driver
, errp
);
964 job
->driver
= driver
;
967 job
->opaque
= opaque
;
970 job
->pause_count
= 1;
972 job
->auto_finalize
= !(flags
& BLOCK_JOB_MANUAL_FINALIZE
);
973 job
->auto_dismiss
= !(flags
& BLOCK_JOB_MANUAL_DISMISS
);
974 block_job_state_transition(job
, BLOCK_JOB_STATUS_CREATED
);
975 aio_timer_init(qemu_get_aio_context(), &job
->sleep_timer
,
976 QEMU_CLOCK_REALTIME
, SCALE_NS
,
977 block_job_sleep_timer_cb
, job
);
979 error_setg(&job
->blocker
, "block device is in use by block job: %s",
980 job_type_str(&job
->job
));
981 block_job_add_bdrv(job
, "main node", bs
, 0, BLK_PERM_ALL
, &error_abort
);
984 bdrv_op_unblock(bs
, BLOCK_OP_TYPE_DATAPLANE
, job
->blocker
);
986 QLIST_INSERT_HEAD(&block_jobs
, job
, job_list
);
988 blk_add_aio_context_notifier(blk
, block_job_attached_aio_context
,
989 block_job_detach_aio_context
, job
);
991 /* Only set speed when necessary to avoid NotSupported error */
993 Error
*local_err
= NULL
;
995 block_job_set_speed(job
, speed
, &local_err
);
997 block_job_early_fail(job
);
998 error_propagate(errp
, local_err
);
1003 /* Single jobs are modeled as single-job transactions for sake of
1004 * consolidating the job management logic */
1006 txn
= block_job_txn_new();
1007 block_job_txn_add_job(txn
, job
);
1008 block_job_txn_unref(txn
);
1010 block_job_txn_add_job(txn
, job
);
1016 void block_job_early_fail(BlockJob
*job
)
1018 assert(job
->status
== BLOCK_JOB_STATUS_CREATED
);
1019 block_job_decommission(job
);
1022 void block_job_completed(BlockJob
*job
, int ret
)
1024 assert(job
&& job
->txn
&& !job
->completed
);
1025 assert(blk_bs(job
->blk
)->job
== job
);
1026 job
->completed
= true;
1028 block_job_update_rc(job
);
1029 trace_block_job_completed(job
, ret
, job
->ret
);
1031 block_job_completed_txn_abort(job
);
1033 block_job_completed_txn_success(job
);
1037 static bool block_job_should_pause(BlockJob
*job
)
1039 return job
->pause_count
> 0;
1042 /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds.
1043 * Reentering the job coroutine with block_job_enter() before the timer has
1044 * expired is allowed and cancels the timer.
1046 * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be
1047 * called explicitly. */
1048 static void block_job_do_yield(BlockJob
*job
, uint64_t ns
)
1052 timer_mod(&job
->sleep_timer
, ns
);
1056 qemu_coroutine_yield();
1058 /* Set by block_job_enter before re-entering the coroutine. */
1062 void coroutine_fn
block_job_pause_point(BlockJob
*job
)
1064 assert(job
&& block_job_started(job
));
1066 if (!block_job_should_pause(job
)) {
1069 if (block_job_is_cancelled(job
)) {
1073 if (job
->driver
->pause
) {
1074 job
->driver
->pause(job
);
1077 if (block_job_should_pause(job
) && !block_job_is_cancelled(job
)) {
1078 BlockJobStatus status
= job
->status
;
1079 block_job_state_transition(job
, status
== BLOCK_JOB_STATUS_READY
? \
1080 BLOCK_JOB_STATUS_STANDBY
: \
1081 BLOCK_JOB_STATUS_PAUSED
);
1083 block_job_do_yield(job
, -1);
1084 job
->paused
= false;
1085 block_job_state_transition(job
, status
);
1088 if (job
->driver
->resume
) {
1089 job
->driver
->resume(job
);
1094 * Conditionally enter a block_job pending a call to fn() while
1095 * under the block_job_lock critical section.
1097 static void block_job_enter_cond(BlockJob
*job
, bool(*fn
)(BlockJob
*job
))
1099 if (!block_job_started(job
)) {
1102 if (job
->deferred_to_main_loop
) {
1112 if (fn
&& !fn(job
)) {
1117 assert(!job
->deferred_to_main_loop
);
1118 timer_del(&job
->sleep_timer
);
1121 aio_co_wake(job
->co
);
1124 void block_job_enter(BlockJob
*job
)
1126 block_job_enter_cond(job
, NULL
);
1129 bool block_job_is_cancelled(BlockJob
*job
)
1131 return job
->cancelled
;
1134 void block_job_sleep_ns(BlockJob
*job
, int64_t ns
)
1138 /* Check cancellation *before* setting busy = false, too! */
1139 if (block_job_is_cancelled(job
)) {
1143 if (!block_job_should_pause(job
)) {
1144 block_job_do_yield(job
, qemu_clock_get_ns(QEMU_CLOCK_REALTIME
) + ns
);
1147 block_job_pause_point(job
);
1150 void block_job_yield(BlockJob
*job
)
1154 /* Check cancellation *before* setting busy = false, too! */
1155 if (block_job_is_cancelled(job
)) {
1159 if (!block_job_should_pause(job
)) {
1160 block_job_do_yield(job
, -1);
1163 block_job_pause_point(job
);
1166 void block_job_iostatus_reset(BlockJob
*job
)
1168 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
1171 assert(job
->user_paused
&& job
->pause_count
> 0);
1172 job
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
1175 void block_job_event_ready(BlockJob
*job
)
1177 block_job_state_transition(job
, BLOCK_JOB_STATUS_READY
);
1180 if (block_job_is_internal(job
)) {
1184 qapi_event_send_block_job_ready(job_type(&job
->job
),
1188 job
->speed
, &error_abort
);
1191 BlockErrorAction
block_job_error_action(BlockJob
*job
, BlockdevOnError on_err
,
1192 int is_read
, int error
)
1194 BlockErrorAction action
;
1197 case BLOCKDEV_ON_ERROR_ENOSPC
:
1198 case BLOCKDEV_ON_ERROR_AUTO
:
1199 action
= (error
== ENOSPC
) ?
1200 BLOCK_ERROR_ACTION_STOP
: BLOCK_ERROR_ACTION_REPORT
;
1202 case BLOCKDEV_ON_ERROR_STOP
:
1203 action
= BLOCK_ERROR_ACTION_STOP
;
1205 case BLOCKDEV_ON_ERROR_REPORT
:
1206 action
= BLOCK_ERROR_ACTION_REPORT
;
1208 case BLOCKDEV_ON_ERROR_IGNORE
:
1209 action
= BLOCK_ERROR_ACTION_IGNORE
;
1214 if (!block_job_is_internal(job
)) {
1215 qapi_event_send_block_job_error(job
->job
.id
,
1216 is_read
? IO_OPERATION_TYPE_READ
:
1217 IO_OPERATION_TYPE_WRITE
,
1218 action
, &error_abort
);
1220 if (action
== BLOCK_ERROR_ACTION_STOP
) {
1221 block_job_pause(job
);
1222 /* make the pause user visible, which will be resumed from QMP. */
1223 job
->user_paused
= true;
1224 block_job_iostatus_set_err(job
, error
);
1231 AioContext
*aio_context
;
1232 BlockJobDeferToMainLoopFn
*fn
;
1234 } BlockJobDeferToMainLoopData
;
1236 static void block_job_defer_to_main_loop_bh(void *opaque
)
1238 BlockJobDeferToMainLoopData
*data
= opaque
;
1239 AioContext
*aio_context
;
1241 /* Prevent race with block_job_defer_to_main_loop() */
1242 aio_context_acquire(data
->aio_context
);
1244 /* Fetch BDS AioContext again, in case it has changed */
1245 aio_context
= blk_get_aio_context(data
->job
->blk
);
1246 if (aio_context
!= data
->aio_context
) {
1247 aio_context_acquire(aio_context
);
1250 data
->fn(data
->job
, data
->opaque
);
1252 if (aio_context
!= data
->aio_context
) {
1253 aio_context_release(aio_context
);
1256 aio_context_release(data
->aio_context
);
1261 void block_job_defer_to_main_loop(BlockJob
*job
,
1262 BlockJobDeferToMainLoopFn
*fn
,
1265 BlockJobDeferToMainLoopData
*data
= g_malloc(sizeof(*data
));
1267 data
->aio_context
= blk_get_aio_context(job
->blk
);
1269 data
->opaque
= opaque
;
1270 job
->deferred_to_main_loop
= true;
1272 aio_bh_schedule_oneshot(qemu_get_aio_context(),
1273 block_job_defer_to_main_loop_bh
, data
);