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, X, E, N */
48 /* U: */ [BLOCK_JOB_STATUS_UNDEFINED
] = {0, 1, 0, 0, 0, 0, 0, 0, 0},
49 /* C: */ [BLOCK_JOB_STATUS_CREATED
] = {0, 0, 1, 0, 0, 0, 1, 0, 1},
50 /* R: */ [BLOCK_JOB_STATUS_RUNNING
] = {0, 0, 0, 1, 1, 0, 1, 1, 0},
51 /* P: */ [BLOCK_JOB_STATUS_PAUSED
] = {0, 0, 1, 0, 0, 0, 0, 0, 0},
52 /* Y: */ [BLOCK_JOB_STATUS_READY
] = {0, 0, 0, 0, 0, 1, 1, 1, 0},
53 /* S: */ [BLOCK_JOB_STATUS_STANDBY
] = {0, 0, 0, 0, 1, 0, 0, 0, 0},
54 /* X: */ [BLOCK_JOB_STATUS_ABORTING
] = {0, 0, 0, 0, 0, 0, 1, 1, 0},
55 /* E: */ [BLOCK_JOB_STATUS_CONCLUDED
] = {0, 0, 0, 0, 0, 0, 0, 0, 1},
56 /* N: */ [BLOCK_JOB_STATUS_NULL
] = {0, 0, 0, 0, 0, 0, 0, 0, 0},
59 bool BlockJobVerbTable
[BLOCK_JOB_VERB__MAX
][BLOCK_JOB_STATUS__MAX
] = {
60 /* U, C, R, P, Y, S, X, E, N */
61 [BLOCK_JOB_VERB_CANCEL
] = {0, 1, 1, 1, 1, 1, 0, 0, 0},
62 [BLOCK_JOB_VERB_PAUSE
] = {0, 1, 1, 1, 1, 1, 0, 0, 0},
63 [BLOCK_JOB_VERB_RESUME
] = {0, 1, 1, 1, 1, 1, 0, 0, 0},
64 [BLOCK_JOB_VERB_SET_SPEED
] = {0, 1, 1, 1, 1, 1, 0, 0, 0},
65 [BLOCK_JOB_VERB_COMPLETE
] = {0, 0, 0, 0, 1, 0, 0, 0, 0},
66 [BLOCK_JOB_VERB_DISMISS
] = {0, 0, 0, 0, 0, 0, 0, 1, 0},
69 static void block_job_state_transition(BlockJob
*job
, BlockJobStatus s1
)
71 BlockJobStatus s0
= job
->status
;
72 assert(s1
>= 0 && s1
<= BLOCK_JOB_STATUS__MAX
);
73 trace_block_job_state_transition(job
, job
->ret
, BlockJobSTT
[s0
][s1
] ?
74 "allowed" : "disallowed",
75 qapi_enum_lookup(&BlockJobStatus_lookup
,
77 qapi_enum_lookup(&BlockJobStatus_lookup
,
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
, qapi_enum_lookup(&BlockJobStatus_lookup
,
88 qapi_enum_lookup(&BlockJobVerb_lookup
, bv
),
89 BlockJobVerbTable
[bv
][job
->status
] ?
90 "allowed" : "prohibited");
91 if (BlockJobVerbTable
[bv
][job
->status
]) {
94 error_setg(errp
, "Job '%s' in state '%s' cannot accept command verb '%s'",
95 job
->id
, qapi_enum_lookup(&BlockJobStatus_lookup
, job
->status
),
96 qapi_enum_lookup(&BlockJobVerb_lookup
, bv
));
100 static void block_job_lock(void)
102 qemu_mutex_lock(&block_job_mutex
);
105 static void block_job_unlock(void)
107 qemu_mutex_unlock(&block_job_mutex
);
110 static void __attribute__((__constructor__
)) block_job_init(void)
112 qemu_mutex_init(&block_job_mutex
);
115 static void block_job_event_cancelled(BlockJob
*job
);
116 static void block_job_event_completed(BlockJob
*job
, const char *msg
);
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
->id
&& !strcmp(id
, 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_pause(BlockJob
*job
)
208 static void block_job_resume(BlockJob
*job
)
210 assert(job
->pause_count
> 0);
212 if (job
->pause_count
) {
215 block_job_enter(job
);
218 void block_job_ref(BlockJob
*job
)
223 static void block_job_attached_aio_context(AioContext
*new_context
,
225 static void block_job_detach_aio_context(void *opaque
);
227 void block_job_unref(BlockJob
*job
)
229 if (--job
->refcnt
== 0) {
230 assert(job
->status
== BLOCK_JOB_STATUS_NULL
);
231 BlockDriverState
*bs
= blk_bs(job
->blk
);
232 QLIST_REMOVE(job
, job_list
);
234 block_job_remove_all_bdrv(job
);
235 blk_remove_aio_context_notifier(job
->blk
,
236 block_job_attached_aio_context
,
237 block_job_detach_aio_context
, job
);
239 error_free(job
->blocker
);
241 assert(!timer_pending(&job
->sleep_timer
));
246 static void block_job_attached_aio_context(AioContext
*new_context
,
249 BlockJob
*job
= opaque
;
251 if (job
->driver
->attached_aio_context
) {
252 job
->driver
->attached_aio_context(job
, new_context
);
255 block_job_resume(job
);
258 static void block_job_drain(BlockJob
*job
)
260 /* If job is !job->busy this kicks it into the next pause point. */
261 block_job_enter(job
);
264 if (job
->driver
->drain
) {
265 job
->driver
->drain(job
);
269 static void block_job_detach_aio_context(void *opaque
)
271 BlockJob
*job
= opaque
;
273 /* In case the job terminates during aio_poll()... */
276 block_job_pause(job
);
278 while (!job
->paused
&& !job
->completed
) {
279 block_job_drain(job
);
282 block_job_unref(job
);
285 static char *child_job_get_parent_desc(BdrvChild
*c
)
287 BlockJob
*job
= c
->opaque
;
288 return g_strdup_printf("%s job '%s'",
289 BlockJobType_str(job
->driver
->job_type
),
293 static void child_job_drained_begin(BdrvChild
*c
)
295 BlockJob
*job
= c
->opaque
;
296 block_job_pause(job
);
299 static void child_job_drained_end(BdrvChild
*c
)
301 BlockJob
*job
= c
->opaque
;
302 block_job_resume(job
);
305 static const BdrvChildRole child_job
= {
306 .get_parent_desc
= child_job_get_parent_desc
,
307 .drained_begin
= child_job_drained_begin
,
308 .drained_end
= child_job_drained_end
,
309 .stay_at_node
= true,
312 void block_job_remove_all_bdrv(BlockJob
*job
)
315 for (l
= job
->nodes
; l
; l
= l
->next
) {
316 BdrvChild
*c
= l
->data
;
317 bdrv_op_unblock_all(c
->bs
, job
->blocker
);
318 bdrv_root_unref_child(c
);
320 g_slist_free(job
->nodes
);
324 int block_job_add_bdrv(BlockJob
*job
, const char *name
, BlockDriverState
*bs
,
325 uint64_t perm
, uint64_t shared_perm
, Error
**errp
)
329 c
= bdrv_root_attach_child(bs
, name
, &child_job
, perm
, shared_perm
,
335 job
->nodes
= g_slist_prepend(job
->nodes
, c
);
337 bdrv_op_block_all(bs
, job
->blocker
);
342 bool block_job_is_internal(BlockJob
*job
)
344 return (job
->id
== NULL
);
347 static bool block_job_started(BlockJob
*job
)
353 * All jobs must allow a pause point before entering their job proper. This
354 * ensures that jobs can be paused prior to being started, then resumed later.
356 static void coroutine_fn
block_job_co_entry(void *opaque
)
358 BlockJob
*job
= opaque
;
360 assert(job
&& job
->driver
&& job
->driver
->start
);
361 block_job_pause_point(job
);
362 job
->driver
->start(job
);
365 static void block_job_sleep_timer_cb(void *opaque
)
367 BlockJob
*job
= opaque
;
369 block_job_enter(job
);
372 void block_job_start(BlockJob
*job
)
374 assert(job
&& !block_job_started(job
) && job
->paused
&&
375 job
->driver
&& job
->driver
->start
);
376 job
->co
= qemu_coroutine_create(block_job_co_entry
, job
);
380 block_job_state_transition(job
, BLOCK_JOB_STATUS_RUNNING
);
381 bdrv_coroutine_enter(blk_bs(job
->blk
), job
->co
);
384 static void block_job_decommission(BlockJob
*job
)
387 job
->completed
= true;
390 job
->deferred_to_main_loop
= true;
391 block_job_state_transition(job
, BLOCK_JOB_STATUS_NULL
);
392 block_job_unref(job
);
395 static void block_job_do_dismiss(BlockJob
*job
)
397 block_job_decommission(job
);
400 static void block_job_conclude(BlockJob
*job
)
402 block_job_state_transition(job
, BLOCK_JOB_STATUS_CONCLUDED
);
403 if (job
->auto_dismiss
|| !block_job_started(job
)) {
404 block_job_do_dismiss(job
);
408 static void block_job_update_rc(BlockJob
*job
)
410 if (!job
->ret
&& block_job_is_cancelled(job
)) {
411 job
->ret
= -ECANCELED
;
414 block_job_state_transition(job
, BLOCK_JOB_STATUS_ABORTING
);
418 static int block_job_prepare(BlockJob
*job
)
420 if (job
->ret
== 0 && job
->driver
->prepare
) {
421 job
->ret
= job
->driver
->prepare(job
);
426 static void block_job_commit(BlockJob
*job
)
429 if (job
->driver
->commit
) {
430 job
->driver
->commit(job
);
434 static void block_job_abort(BlockJob
*job
)
437 if (job
->driver
->abort
) {
438 job
->driver
->abort(job
);
442 static void block_job_clean(BlockJob
*job
)
444 if (job
->driver
->clean
) {
445 job
->driver
->clean(job
);
449 static int block_job_completed_single(BlockJob
*job
)
451 assert(job
->completed
);
453 /* Ensure abort is called for late-transactional failures */
454 block_job_update_rc(job
);
457 block_job_commit(job
);
459 block_job_abort(job
);
461 block_job_clean(job
);
464 job
->cb(job
->opaque
, job
->ret
);
467 /* Emit events only if we actually started */
468 if (block_job_started(job
)) {
469 if (block_job_is_cancelled(job
)) {
470 block_job_event_cancelled(job
);
472 const char *msg
= NULL
;
474 msg
= strerror(-job
->ret
);
476 block_job_event_completed(job
, msg
);
480 QLIST_REMOVE(job
, txn_list
);
481 block_job_txn_unref(job
->txn
);
482 block_job_conclude(job
);
486 static void block_job_cancel_async(BlockJob
*job
)
488 if (job
->iostatus
!= BLOCK_DEVICE_IO_STATUS_OK
) {
489 block_job_iostatus_reset(job
);
491 if (job
->user_paused
) {
492 /* Do not call block_job_enter here, the caller will handle it. */
493 job
->user_paused
= false;
496 job
->cancelled
= true;
499 static int block_job_txn_apply(BlockJobTxn
*txn
, int fn(BlockJob
*))
502 BlockJob
*job
, *next
;
505 QLIST_FOREACH_SAFE(job
, &txn
->jobs
, txn_list
, next
) {
506 ctx
= blk_get_aio_context(job
->blk
);
507 aio_context_acquire(ctx
);
509 aio_context_release(ctx
);
517 static int block_job_finish_sync(BlockJob
*job
,
518 void (*finish
)(BlockJob
*, Error
**errp
),
521 Error
*local_err
= NULL
;
524 assert(blk_bs(job
->blk
)->job
== job
);
529 finish(job
, &local_err
);
532 error_propagate(errp
, local_err
);
533 block_job_unref(job
);
536 /* block_job_drain calls block_job_enter, and it should be enough to
537 * induce progress until the job completes or moves to the main thread.
539 while (!job
->deferred_to_main_loop
&& !job
->completed
) {
540 block_job_drain(job
);
542 while (!job
->completed
) {
543 aio_poll(qemu_get_aio_context(), true);
545 ret
= (job
->cancelled
&& job
->ret
== 0) ? -ECANCELED
: job
->ret
;
546 block_job_unref(job
);
550 static void block_job_completed_txn_abort(BlockJob
*job
)
553 BlockJobTxn
*txn
= job
->txn
;
558 * We are cancelled by another job, which will handle everything.
562 txn
->aborting
= true;
563 block_job_txn_ref(txn
);
565 /* We are the first failed job. Cancel other jobs. */
566 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
567 ctx
= blk_get_aio_context(other_job
->blk
);
568 aio_context_acquire(ctx
);
571 /* Other jobs are effectively cancelled by us, set the status for
572 * them; this job, however, may or may not be cancelled, depending
573 * on the caller, so leave it. */
574 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
575 if (other_job
!= job
) {
576 block_job_cancel_async(other_job
);
579 while (!QLIST_EMPTY(&txn
->jobs
)) {
580 other_job
= QLIST_FIRST(&txn
->jobs
);
581 ctx
= blk_get_aio_context(other_job
->blk
);
582 if (!other_job
->completed
) {
583 assert(other_job
->cancelled
);
584 block_job_finish_sync(other_job
, NULL
, NULL
);
586 block_job_completed_single(other_job
);
587 aio_context_release(ctx
);
590 block_job_txn_unref(txn
);
593 static void block_job_completed_txn_success(BlockJob
*job
)
595 BlockJobTxn
*txn
= job
->txn
;
600 * Successful completion, see if there are other running jobs in this
603 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
604 if (!other_job
->completed
) {
607 assert(other_job
->ret
== 0);
610 /* Jobs may require some prep-work to complete without failure */
611 rc
= block_job_txn_apply(txn
, block_job_prepare
);
613 block_job_completed_txn_abort(job
);
617 /* We are the last completed job, commit the transaction. */
618 block_job_txn_apply(txn
, block_job_completed_single
);
621 /* Assumes the block_job_mutex is held */
622 static bool block_job_timer_pending(BlockJob
*job
)
624 return timer_pending(&job
->sleep_timer
);
627 void block_job_set_speed(BlockJob
*job
, int64_t speed
, Error
**errp
)
629 Error
*local_err
= NULL
;
630 int64_t old_speed
= job
->speed
;
632 if (!job
->driver
->set_speed
) {
633 error_setg(errp
, QERR_UNSUPPORTED
);
636 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_SET_SPEED
, errp
)) {
639 job
->driver
->set_speed(job
, speed
, &local_err
);
641 error_propagate(errp
, local_err
);
646 if (speed
&& speed
<= old_speed
) {
650 /* kick only if a timer is pending */
651 block_job_enter_cond(job
, block_job_timer_pending
);
654 void block_job_complete(BlockJob
*job
, Error
**errp
)
656 /* Should not be reachable via external interface for internal jobs */
658 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_COMPLETE
, errp
)) {
661 if (job
->pause_count
|| job
->cancelled
|| !job
->driver
->complete
) {
662 error_setg(errp
, "The active block job '%s' cannot be completed",
667 job
->driver
->complete(job
, errp
);
670 void block_job_dismiss(BlockJob
**jobptr
, Error
**errp
)
672 BlockJob
*job
= *jobptr
;
673 /* similarly to _complete, this is QMP-interface only. */
675 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_DISMISS
, errp
)) {
679 block_job_do_dismiss(job
);
683 void block_job_user_pause(BlockJob
*job
, Error
**errp
)
685 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_PAUSE
, errp
)) {
688 if (job
->user_paused
) {
689 error_setg(errp
, "Job is already paused");
692 job
->user_paused
= true;
693 block_job_pause(job
);
696 bool block_job_user_paused(BlockJob
*job
)
698 return job
->user_paused
;
701 void block_job_user_resume(BlockJob
*job
, Error
**errp
)
704 if (!job
->user_paused
|| job
->pause_count
<= 0) {
705 error_setg(errp
, "Can't resume a job that was not paused");
708 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_RESUME
, errp
)) {
711 block_job_iostatus_reset(job
);
712 job
->user_paused
= false;
713 block_job_resume(job
);
716 void block_job_cancel(BlockJob
*job
)
718 if (job
->status
== BLOCK_JOB_STATUS_CONCLUDED
) {
719 block_job_do_dismiss(job
);
720 } else if (block_job_started(job
)) {
721 block_job_cancel_async(job
);
722 block_job_enter(job
);
724 block_job_completed(job
, -ECANCELED
);
728 void block_job_user_cancel(BlockJob
*job
, Error
**errp
)
730 if (block_job_apply_verb(job
, BLOCK_JOB_VERB_CANCEL
, errp
)) {
733 block_job_cancel(job
);
736 /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
737 * used with block_job_finish_sync() without the need for (rather nasty)
738 * function pointer casts there. */
739 static void block_job_cancel_err(BlockJob
*job
, Error
**errp
)
741 block_job_cancel(job
);
744 int block_job_cancel_sync(BlockJob
*job
)
746 return block_job_finish_sync(job
, &block_job_cancel_err
, NULL
);
749 void block_job_cancel_sync_all(void)
752 AioContext
*aio_context
;
754 while ((job
= QLIST_FIRST(&block_jobs
))) {
755 aio_context
= blk_get_aio_context(job
->blk
);
756 aio_context_acquire(aio_context
);
757 block_job_cancel_sync(job
);
758 aio_context_release(aio_context
);
762 int block_job_complete_sync(BlockJob
*job
, Error
**errp
)
764 return block_job_finish_sync(job
, &block_job_complete
, errp
);
767 BlockJobInfo
*block_job_query(BlockJob
*job
, Error
**errp
)
771 if (block_job_is_internal(job
)) {
772 error_setg(errp
, "Cannot query QEMU internal jobs");
775 info
= g_new0(BlockJobInfo
, 1);
776 info
->type
= g_strdup(BlockJobType_str(job
->driver
->job_type
));
777 info
->device
= g_strdup(job
->id
);
778 info
->len
= job
->len
;
779 info
->busy
= atomic_read(&job
->busy
);
780 info
->paused
= job
->pause_count
> 0;
781 info
->offset
= job
->offset
;
782 info
->speed
= job
->speed
;
783 info
->io_status
= job
->iostatus
;
784 info
->ready
= job
->ready
;
785 info
->status
= job
->status
;
789 static void block_job_iostatus_set_err(BlockJob
*job
, int error
)
791 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
792 job
->iostatus
= error
== ENOSPC
? BLOCK_DEVICE_IO_STATUS_NOSPACE
:
793 BLOCK_DEVICE_IO_STATUS_FAILED
;
797 static void block_job_event_cancelled(BlockJob
*job
)
799 if (block_job_is_internal(job
)) {
803 qapi_event_send_block_job_cancelled(job
->driver
->job_type
,
811 static void block_job_event_completed(BlockJob
*job
, const char *msg
)
813 if (block_job_is_internal(job
)) {
817 qapi_event_send_block_job_completed(job
->driver
->job_type
,
828 * API for block job drivers and the block layer. These functions are
829 * declared in blockjob_int.h.
832 void *block_job_create(const char *job_id
, const BlockJobDriver
*driver
,
833 BlockJobTxn
*txn
, BlockDriverState
*bs
, uint64_t perm
,
834 uint64_t shared_perm
, int64_t speed
, int flags
,
835 BlockCompletionFunc
*cb
, void *opaque
, Error
**errp
)
842 error_setg(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
846 if (job_id
== NULL
&& !(flags
& BLOCK_JOB_INTERNAL
)) {
847 job_id
= bdrv_get_device_name(bs
);
849 error_setg(errp
, "An explicit job ID is required for this node");
855 if (flags
& BLOCK_JOB_INTERNAL
) {
856 error_setg(errp
, "Cannot specify job ID for internal block job");
860 if (!id_wellformed(job_id
)) {
861 error_setg(errp
, "Invalid job ID '%s'", job_id
);
865 if (block_job_get(job_id
)) {
866 error_setg(errp
, "Job ID '%s' already in use", job_id
);
871 blk
= blk_new(perm
, shared_perm
);
872 ret
= blk_insert_bs(blk
, bs
, errp
);
878 job
= g_malloc0(driver
->instance_size
);
879 job
->driver
= driver
;
880 job
->id
= g_strdup(job_id
);
883 job
->opaque
= opaque
;
886 job
->pause_count
= 1;
888 job
->auto_dismiss
= !(flags
& BLOCK_JOB_MANUAL_DISMISS
);
889 block_job_state_transition(job
, BLOCK_JOB_STATUS_CREATED
);
890 aio_timer_init(qemu_get_aio_context(), &job
->sleep_timer
,
891 QEMU_CLOCK_REALTIME
, SCALE_NS
,
892 block_job_sleep_timer_cb
, job
);
894 error_setg(&job
->blocker
, "block device is in use by block job: %s",
895 BlockJobType_str(driver
->job_type
));
896 block_job_add_bdrv(job
, "main node", bs
, 0, BLK_PERM_ALL
, &error_abort
);
899 bdrv_op_unblock(bs
, BLOCK_OP_TYPE_DATAPLANE
, job
->blocker
);
901 QLIST_INSERT_HEAD(&block_jobs
, job
, job_list
);
903 blk_add_aio_context_notifier(blk
, block_job_attached_aio_context
,
904 block_job_detach_aio_context
, job
);
906 /* Only set speed when necessary to avoid NotSupported error */
908 Error
*local_err
= NULL
;
910 block_job_set_speed(job
, speed
, &local_err
);
912 block_job_early_fail(job
);
913 error_propagate(errp
, local_err
);
918 /* Single jobs are modeled as single-job transactions for sake of
919 * consolidating the job management logic */
921 txn
= block_job_txn_new();
922 block_job_txn_add_job(txn
, job
);
923 block_job_txn_unref(txn
);
925 block_job_txn_add_job(txn
, job
);
931 void block_job_pause_all(void)
933 BlockJob
*job
= NULL
;
934 while ((job
= block_job_next(job
))) {
935 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
937 aio_context_acquire(aio_context
);
939 block_job_pause(job
);
940 aio_context_release(aio_context
);
944 void block_job_early_fail(BlockJob
*job
)
946 assert(job
->status
== BLOCK_JOB_STATUS_CREATED
);
947 block_job_decommission(job
);
950 void block_job_completed(BlockJob
*job
, int ret
)
952 assert(job
&& job
->txn
&& !job
->completed
);
953 assert(blk_bs(job
->blk
)->job
== job
);
954 job
->completed
= true;
956 block_job_update_rc(job
);
957 trace_block_job_completed(job
, ret
, job
->ret
);
959 block_job_completed_txn_abort(job
);
961 block_job_completed_txn_success(job
);
965 static bool block_job_should_pause(BlockJob
*job
)
967 return job
->pause_count
> 0;
970 /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds.
971 * Reentering the job coroutine with block_job_enter() before the timer has
972 * expired is allowed and cancels the timer.
974 * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be
975 * called explicitly. */
976 static void block_job_do_yield(BlockJob
*job
, uint64_t ns
)
980 timer_mod(&job
->sleep_timer
, ns
);
984 qemu_coroutine_yield();
986 /* Set by block_job_enter before re-entering the coroutine. */
990 void coroutine_fn
block_job_pause_point(BlockJob
*job
)
992 assert(job
&& block_job_started(job
));
994 if (!block_job_should_pause(job
)) {
997 if (block_job_is_cancelled(job
)) {
1001 if (job
->driver
->pause
) {
1002 job
->driver
->pause(job
);
1005 if (block_job_should_pause(job
) && !block_job_is_cancelled(job
)) {
1006 BlockJobStatus status
= job
->status
;
1007 block_job_state_transition(job
, status
== BLOCK_JOB_STATUS_READY
? \
1008 BLOCK_JOB_STATUS_STANDBY
: \
1009 BLOCK_JOB_STATUS_PAUSED
);
1011 block_job_do_yield(job
, -1);
1012 job
->paused
= false;
1013 block_job_state_transition(job
, status
);
1016 if (job
->driver
->resume
) {
1017 job
->driver
->resume(job
);
1021 void block_job_resume_all(void)
1023 BlockJob
*job
, *next
;
1025 QLIST_FOREACH_SAFE(job
, &block_jobs
, job_list
, next
) {
1026 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
1028 aio_context_acquire(aio_context
);
1029 block_job_resume(job
);
1030 block_job_unref(job
);
1031 aio_context_release(aio_context
);
1036 * Conditionally enter a block_job pending a call to fn() while
1037 * under the block_job_lock critical section.
1039 static void block_job_enter_cond(BlockJob
*job
, bool(*fn
)(BlockJob
*job
))
1041 if (!block_job_started(job
)) {
1044 if (job
->deferred_to_main_loop
) {
1054 if (fn
&& !fn(job
)) {
1059 assert(!job
->deferred_to_main_loop
);
1060 timer_del(&job
->sleep_timer
);
1063 aio_co_wake(job
->co
);
1066 void block_job_enter(BlockJob
*job
)
1068 block_job_enter_cond(job
, NULL
);
1071 bool block_job_is_cancelled(BlockJob
*job
)
1073 return job
->cancelled
;
1076 void block_job_sleep_ns(BlockJob
*job
, int64_t ns
)
1080 /* Check cancellation *before* setting busy = false, too! */
1081 if (block_job_is_cancelled(job
)) {
1085 if (!block_job_should_pause(job
)) {
1086 block_job_do_yield(job
, qemu_clock_get_ns(QEMU_CLOCK_REALTIME
) + ns
);
1089 block_job_pause_point(job
);
1092 void block_job_yield(BlockJob
*job
)
1096 /* Check cancellation *before* setting busy = false, too! */
1097 if (block_job_is_cancelled(job
)) {
1101 if (!block_job_should_pause(job
)) {
1102 block_job_do_yield(job
, -1);
1105 block_job_pause_point(job
);
1108 void block_job_iostatus_reset(BlockJob
*job
)
1110 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
1113 assert(job
->user_paused
&& job
->pause_count
> 0);
1114 job
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
1117 void block_job_event_ready(BlockJob
*job
)
1119 block_job_state_transition(job
, BLOCK_JOB_STATUS_READY
);
1122 if (block_job_is_internal(job
)) {
1126 qapi_event_send_block_job_ready(job
->driver
->job_type
,
1130 job
->speed
, &error_abort
);
1133 BlockErrorAction
block_job_error_action(BlockJob
*job
, BlockdevOnError on_err
,
1134 int is_read
, int error
)
1136 BlockErrorAction action
;
1139 case BLOCKDEV_ON_ERROR_ENOSPC
:
1140 case BLOCKDEV_ON_ERROR_AUTO
:
1141 action
= (error
== ENOSPC
) ?
1142 BLOCK_ERROR_ACTION_STOP
: BLOCK_ERROR_ACTION_REPORT
;
1144 case BLOCKDEV_ON_ERROR_STOP
:
1145 action
= BLOCK_ERROR_ACTION_STOP
;
1147 case BLOCKDEV_ON_ERROR_REPORT
:
1148 action
= BLOCK_ERROR_ACTION_REPORT
;
1150 case BLOCKDEV_ON_ERROR_IGNORE
:
1151 action
= BLOCK_ERROR_ACTION_IGNORE
;
1156 if (!block_job_is_internal(job
)) {
1157 qapi_event_send_block_job_error(job
->id
,
1158 is_read
? IO_OPERATION_TYPE_READ
:
1159 IO_OPERATION_TYPE_WRITE
,
1160 action
, &error_abort
);
1162 if (action
== BLOCK_ERROR_ACTION_STOP
) {
1163 block_job_pause(job
);
1164 /* make the pause user visible, which will be resumed from QMP. */
1165 job
->user_paused
= true;
1166 block_job_iostatus_set_err(job
, error
);
1173 AioContext
*aio_context
;
1174 BlockJobDeferToMainLoopFn
*fn
;
1176 } BlockJobDeferToMainLoopData
;
1178 static void block_job_defer_to_main_loop_bh(void *opaque
)
1180 BlockJobDeferToMainLoopData
*data
= opaque
;
1181 AioContext
*aio_context
;
1183 /* Prevent race with block_job_defer_to_main_loop() */
1184 aio_context_acquire(data
->aio_context
);
1186 /* Fetch BDS AioContext again, in case it has changed */
1187 aio_context
= blk_get_aio_context(data
->job
->blk
);
1188 if (aio_context
!= data
->aio_context
) {
1189 aio_context_acquire(aio_context
);
1192 data
->fn(data
->job
, data
->opaque
);
1194 if (aio_context
!= data
->aio_context
) {
1195 aio_context_release(aio_context
);
1198 aio_context_release(data
->aio_context
);
1203 void block_job_defer_to_main_loop(BlockJob
*job
,
1204 BlockJobDeferToMainLoopFn
*fn
,
1207 BlockJobDeferToMainLoopData
*data
= g_malloc(sizeof(*data
));
1209 data
->aio_context
= blk_get_aio_context(job
->blk
);
1211 data
->opaque
= opaque
;
1212 job
->deferred_to_main_loop
= true;
1214 aio_bh_schedule_oneshot(qemu_get_aio_context(),
1215 block_job_defer_to_main_loop_bh
, data
);