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 "sysemu/block-backend.h"
32 #include "qapi/qmp/qerror.h"
33 #include "qapi/qmp/qjson.h"
34 #include "qemu/coroutine.h"
36 #include "qmp-commands.h"
37 #include "qemu/timer.h"
38 #include "qapi-event.h"
40 static void block_job_event_cancelled(BlockJob
*job
);
41 static void block_job_event_completed(BlockJob
*job
, const char *msg
);
43 /* Transactional group of block jobs */
46 /* Is this txn being cancelled? */
50 QLIST_HEAD(, BlockJob
) jobs
;
56 static QLIST_HEAD(, BlockJob
) block_jobs
= QLIST_HEAD_INITIALIZER(block_jobs
);
58 static char *child_job_get_parent_desc(BdrvChild
*c
)
60 BlockJob
*job
= c
->opaque
;
61 return g_strdup_printf("%s job '%s'",
62 BlockJobType_lookup
[job
->driver
->job_type
],
66 static const BdrvChildRole child_job
= {
67 .get_parent_desc
= child_job_get_parent_desc
,
71 BlockJob
*block_job_next(BlockJob
*job
)
74 return QLIST_FIRST(&block_jobs
);
76 return QLIST_NEXT(job
, job_list
);
79 BlockJob
*block_job_get(const char *id
)
83 QLIST_FOREACH(job
, &block_jobs
, job_list
) {
84 if (job
->id
&& !strcmp(id
, job
->id
)) {
92 static void block_job_attached_aio_context(AioContext
*new_context
,
95 BlockJob
*job
= opaque
;
97 if (job
->driver
->attached_aio_context
) {
98 job
->driver
->attached_aio_context(job
, new_context
);
101 block_job_resume(job
);
104 static void block_job_drain(BlockJob
*job
)
106 /* If job is !job->busy this kicks it into the next pause point. */
107 block_job_enter(job
);
110 if (job
->driver
->drain
) {
111 job
->driver
->drain(job
);
115 static void block_job_detach_aio_context(void *opaque
)
117 BlockJob
*job
= opaque
;
119 /* In case the job terminates during aio_poll()... */
122 block_job_pause(job
);
124 while (!job
->paused
&& !job
->completed
) {
125 block_job_drain(job
);
128 block_job_unref(job
);
131 void block_job_remove_all_bdrv(BlockJob
*job
)
134 for (l
= job
->nodes
; l
; l
= l
->next
) {
135 BdrvChild
*c
= l
->data
;
136 bdrv_op_unblock_all(c
->bs
, job
->blocker
);
137 bdrv_root_unref_child(c
);
139 g_slist_free(job
->nodes
);
143 int block_job_add_bdrv(BlockJob
*job
, const char *name
, BlockDriverState
*bs
,
144 uint64_t perm
, uint64_t shared_perm
, Error
**errp
)
148 c
= bdrv_root_attach_child(bs
, name
, &child_job
, perm
, shared_perm
,
154 job
->nodes
= g_slist_prepend(job
->nodes
, c
);
156 bdrv_op_block_all(bs
, job
->blocker
);
161 void *block_job_create(const char *job_id
, const BlockJobDriver
*driver
,
162 BlockDriverState
*bs
, uint64_t perm
,
163 uint64_t shared_perm
, int64_t speed
, int flags
,
164 BlockCompletionFunc
*cb
, void *opaque
, Error
**errp
)
171 error_setg(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
175 if (job_id
== NULL
&& !(flags
& BLOCK_JOB_INTERNAL
)) {
176 job_id
= bdrv_get_device_name(bs
);
178 error_setg(errp
, "An explicit job ID is required for this node");
184 if (flags
& BLOCK_JOB_INTERNAL
) {
185 error_setg(errp
, "Cannot specify job ID for internal block job");
189 if (!id_wellformed(job_id
)) {
190 error_setg(errp
, "Invalid job ID '%s'", job_id
);
194 if (block_job_get(job_id
)) {
195 error_setg(errp
, "Job ID '%s' already in use", job_id
);
200 blk
= blk_new(perm
, shared_perm
);
201 ret
= blk_insert_bs(blk
, bs
, errp
);
207 job
= g_malloc0(driver
->instance_size
);
208 error_setg(&job
->blocker
, "block device is in use by block job: %s",
209 BlockJobType_lookup
[driver
->job_type
]);
210 block_job_add_bdrv(job
, "main node", bs
, 0, BLK_PERM_ALL
, &error_abort
);
211 bdrv_op_unblock(bs
, BLOCK_OP_TYPE_DATAPLANE
, job
->blocker
);
213 job
->driver
= driver
;
214 job
->id
= g_strdup(job_id
);
217 job
->opaque
= opaque
;
220 job
->pause_count
= 1;
224 QLIST_INSERT_HEAD(&block_jobs
, job
, job_list
);
226 blk_add_aio_context_notifier(blk
, block_job_attached_aio_context
,
227 block_job_detach_aio_context
, job
);
229 /* Only set speed when necessary to avoid NotSupported error */
231 Error
*local_err
= NULL
;
233 block_job_set_speed(job
, speed
, &local_err
);
235 block_job_unref(job
);
236 error_propagate(errp
, local_err
);
243 bool block_job_is_internal(BlockJob
*job
)
245 return (job
->id
== NULL
);
248 static bool block_job_started(BlockJob
*job
)
254 * All jobs must allow a pause point before entering their job proper. This
255 * ensures that jobs can be paused prior to being started, then resumed later.
257 static void coroutine_fn
block_job_co_entry(void *opaque
)
259 BlockJob
*job
= opaque
;
261 assert(job
&& job
->driver
&& job
->driver
->start
);
262 block_job_pause_point(job
);
263 job
->driver
->start(job
);
266 void block_job_start(BlockJob
*job
)
268 assert(job
&& !block_job_started(job
) && job
->paused
&&
269 job
->driver
&& job
->driver
->start
);
270 job
->co
= qemu_coroutine_create(block_job_co_entry
, job
);
274 qemu_coroutine_enter(job
->co
);
277 void block_job_ref(BlockJob
*job
)
282 void block_job_unref(BlockJob
*job
)
284 if (--job
->refcnt
== 0) {
285 BlockDriverState
*bs
= blk_bs(job
->blk
);
287 block_job_remove_all_bdrv(job
);
288 blk_remove_aio_context_notifier(job
->blk
,
289 block_job_attached_aio_context
,
290 block_job_detach_aio_context
, job
);
292 error_free(job
->blocker
);
294 QLIST_REMOVE(job
, job_list
);
299 static void block_job_completed_single(BlockJob
*job
)
302 if (job
->driver
->commit
) {
303 job
->driver
->commit(job
);
306 if (job
->driver
->abort
) {
307 job
->driver
->abort(job
);
310 if (job
->driver
->clean
) {
311 job
->driver
->clean(job
);
315 job
->cb(job
->opaque
, job
->ret
);
318 /* Emit events only if we actually started */
319 if (block_job_started(job
)) {
320 if (block_job_is_cancelled(job
)) {
321 block_job_event_cancelled(job
);
323 const char *msg
= NULL
;
325 msg
= strerror(-job
->ret
);
327 block_job_event_completed(job
, msg
);
332 QLIST_REMOVE(job
, txn_list
);
333 block_job_txn_unref(job
->txn
);
335 block_job_unref(job
);
338 static void block_job_completed_txn_abort(BlockJob
*job
)
341 BlockJobTxn
*txn
= job
->txn
;
342 BlockJob
*other_job
, *next
;
346 * We are cancelled by another job, which will handle everything.
350 txn
->aborting
= true;
351 /* We are the first failed job. Cancel other jobs. */
352 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
353 ctx
= blk_get_aio_context(other_job
->blk
);
354 aio_context_acquire(ctx
);
356 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
357 if (other_job
== job
|| other_job
->completed
) {
358 /* Other jobs are "effectively" cancelled by us, set the status for
359 * them; this job, however, may or may not be cancelled, depending
360 * on the caller, so leave it. */
361 if (other_job
!= job
) {
362 other_job
->cancelled
= true;
366 block_job_cancel_sync(other_job
);
367 assert(other_job
->completed
);
369 QLIST_FOREACH_SAFE(other_job
, &txn
->jobs
, txn_list
, next
) {
370 ctx
= blk_get_aio_context(other_job
->blk
);
371 block_job_completed_single(other_job
);
372 aio_context_release(ctx
);
376 static void block_job_completed_txn_success(BlockJob
*job
)
379 BlockJobTxn
*txn
= job
->txn
;
380 BlockJob
*other_job
, *next
;
382 * Successful completion, see if there are other running jobs in this
385 QLIST_FOREACH(other_job
, &txn
->jobs
, txn_list
) {
386 if (!other_job
->completed
) {
390 /* We are the last completed job, commit the transaction. */
391 QLIST_FOREACH_SAFE(other_job
, &txn
->jobs
, txn_list
, next
) {
392 ctx
= blk_get_aio_context(other_job
->blk
);
393 aio_context_acquire(ctx
);
394 assert(other_job
->ret
== 0);
395 block_job_completed_single(other_job
);
396 aio_context_release(ctx
);
400 void block_job_completed(BlockJob
*job
, int ret
)
402 assert(blk_bs(job
->blk
)->job
== job
);
403 assert(!job
->completed
);
404 job
->completed
= true;
407 block_job_completed_single(job
);
408 } else if (ret
< 0 || block_job_is_cancelled(job
)) {
409 block_job_completed_txn_abort(job
);
411 block_job_completed_txn_success(job
);
415 void block_job_set_speed(BlockJob
*job
, int64_t speed
, Error
**errp
)
417 Error
*local_err
= NULL
;
419 if (!job
->driver
->set_speed
) {
420 error_setg(errp
, QERR_UNSUPPORTED
);
423 job
->driver
->set_speed(job
, speed
, &local_err
);
425 error_propagate(errp
, local_err
);
432 void block_job_complete(BlockJob
*job
, Error
**errp
)
434 /* Should not be reachable via external interface for internal jobs */
436 if (job
->pause_count
|| job
->cancelled
||
437 !block_job_started(job
) || !job
->driver
->complete
) {
438 error_setg(errp
, "The active block job '%s' cannot be completed",
443 job
->driver
->complete(job
, errp
);
446 void block_job_pause(BlockJob
*job
)
451 void block_job_user_pause(BlockJob
*job
)
453 job
->user_paused
= true;
454 block_job_pause(job
);
457 static bool block_job_should_pause(BlockJob
*job
)
459 return job
->pause_count
> 0;
462 bool block_job_user_paused(BlockJob
*job
)
464 return job
? job
->user_paused
: 0;
467 void coroutine_fn
block_job_pause_point(BlockJob
*job
)
469 assert(job
&& block_job_started(job
));
471 if (!block_job_should_pause(job
)) {
474 if (block_job_is_cancelled(job
)) {
478 if (job
->driver
->pause
) {
479 job
->driver
->pause(job
);
482 if (block_job_should_pause(job
) && !block_job_is_cancelled(job
)) {
485 qemu_coroutine_yield(); /* wait for block_job_resume() */
490 if (job
->driver
->resume
) {
491 job
->driver
->resume(job
);
495 void block_job_resume(BlockJob
*job
)
497 assert(job
->pause_count
> 0);
499 if (job
->pause_count
) {
502 block_job_enter(job
);
505 void block_job_user_resume(BlockJob
*job
)
507 if (job
&& job
->user_paused
&& job
->pause_count
> 0) {
508 job
->user_paused
= false;
509 block_job_resume(job
);
513 void block_job_enter(BlockJob
*job
)
515 if (job
->co
&& !job
->busy
) {
516 qemu_coroutine_enter(job
->co
);
520 void block_job_cancel(BlockJob
*job
)
522 if (block_job_started(job
)) {
523 job
->cancelled
= true;
524 block_job_iostatus_reset(job
);
525 block_job_enter(job
);
527 block_job_completed(job
, -ECANCELED
);
531 bool block_job_is_cancelled(BlockJob
*job
)
533 return job
->cancelled
;
536 void block_job_iostatus_reset(BlockJob
*job
)
538 job
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
539 if (job
->driver
->iostatus_reset
) {
540 job
->driver
->iostatus_reset(job
);
544 static int block_job_finish_sync(BlockJob
*job
,
545 void (*finish
)(BlockJob
*, Error
**errp
),
548 Error
*local_err
= NULL
;
551 assert(blk_bs(job
->blk
)->job
== job
);
555 finish(job
, &local_err
);
557 error_propagate(errp
, local_err
);
558 block_job_unref(job
);
561 /* block_job_drain calls block_job_enter, and it should be enough to
562 * induce progress until the job completes or moves to the main thread.
564 while (!job
->deferred_to_main_loop
&& !job
->completed
) {
565 block_job_drain(job
);
567 while (!job
->completed
) {
568 aio_poll(qemu_get_aio_context(), true);
570 ret
= (job
->cancelled
&& job
->ret
== 0) ? -ECANCELED
: job
->ret
;
571 block_job_unref(job
);
575 /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
576 * used with block_job_finish_sync() without the need for (rather nasty)
577 * function pointer casts there. */
578 static void block_job_cancel_err(BlockJob
*job
, Error
**errp
)
580 block_job_cancel(job
);
583 int block_job_cancel_sync(BlockJob
*job
)
585 return block_job_finish_sync(job
, &block_job_cancel_err
, NULL
);
588 void block_job_cancel_sync_all(void)
591 AioContext
*aio_context
;
593 while ((job
= QLIST_FIRST(&block_jobs
))) {
594 aio_context
= blk_get_aio_context(job
->blk
);
595 aio_context_acquire(aio_context
);
596 block_job_cancel_sync(job
);
597 aio_context_release(aio_context
);
601 int block_job_complete_sync(BlockJob
*job
, Error
**errp
)
603 return block_job_finish_sync(job
, &block_job_complete
, errp
);
606 void block_job_sleep_ns(BlockJob
*job
, QEMUClockType type
, int64_t ns
)
610 /* Check cancellation *before* setting busy = false, too! */
611 if (block_job_is_cancelled(job
)) {
616 if (!block_job_should_pause(job
)) {
617 co_aio_sleep_ns(blk_get_aio_context(job
->blk
), type
, ns
);
621 block_job_pause_point(job
);
624 void block_job_yield(BlockJob
*job
)
628 /* Check cancellation *before* setting busy = false, too! */
629 if (block_job_is_cancelled(job
)) {
634 if (!block_job_should_pause(job
)) {
635 qemu_coroutine_yield();
639 block_job_pause_point(job
);
642 BlockJobInfo
*block_job_query(BlockJob
*job
, Error
**errp
)
646 if (block_job_is_internal(job
)) {
647 error_setg(errp
, "Cannot query QEMU internal jobs");
650 info
= g_new0(BlockJobInfo
, 1);
651 info
->type
= g_strdup(BlockJobType_lookup
[job
->driver
->job_type
]);
652 info
->device
= g_strdup(job
->id
);
653 info
->len
= job
->len
;
654 info
->busy
= job
->busy
;
655 info
->paused
= job
->pause_count
> 0;
656 info
->offset
= job
->offset
;
657 info
->speed
= job
->speed
;
658 info
->io_status
= job
->iostatus
;
659 info
->ready
= job
->ready
;
663 static void block_job_iostatus_set_err(BlockJob
*job
, int error
)
665 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
666 job
->iostatus
= error
== ENOSPC
? BLOCK_DEVICE_IO_STATUS_NOSPACE
:
667 BLOCK_DEVICE_IO_STATUS_FAILED
;
671 static void block_job_event_cancelled(BlockJob
*job
)
673 if (block_job_is_internal(job
)) {
677 qapi_event_send_block_job_cancelled(job
->driver
->job_type
,
685 static void block_job_event_completed(BlockJob
*job
, const char *msg
)
687 if (block_job_is_internal(job
)) {
691 qapi_event_send_block_job_completed(job
->driver
->job_type
,
701 void block_job_event_ready(BlockJob
*job
)
705 if (block_job_is_internal(job
)) {
709 qapi_event_send_block_job_ready(job
->driver
->job_type
,
713 job
->speed
, &error_abort
);
716 BlockErrorAction
block_job_error_action(BlockJob
*job
, BlockdevOnError on_err
,
717 int is_read
, int error
)
719 BlockErrorAction action
;
722 case BLOCKDEV_ON_ERROR_ENOSPC
:
723 case BLOCKDEV_ON_ERROR_AUTO
:
724 action
= (error
== ENOSPC
) ?
725 BLOCK_ERROR_ACTION_STOP
: BLOCK_ERROR_ACTION_REPORT
;
727 case BLOCKDEV_ON_ERROR_STOP
:
728 action
= BLOCK_ERROR_ACTION_STOP
;
730 case BLOCKDEV_ON_ERROR_REPORT
:
731 action
= BLOCK_ERROR_ACTION_REPORT
;
733 case BLOCKDEV_ON_ERROR_IGNORE
:
734 action
= BLOCK_ERROR_ACTION_IGNORE
;
739 if (!block_job_is_internal(job
)) {
740 qapi_event_send_block_job_error(job
->id
,
741 is_read
? IO_OPERATION_TYPE_READ
:
742 IO_OPERATION_TYPE_WRITE
,
743 action
, &error_abort
);
745 if (action
== BLOCK_ERROR_ACTION_STOP
) {
746 /* make the pause user visible, which will be resumed from QMP. */
747 block_job_user_pause(job
);
748 block_job_iostatus_set_err(job
, error
);
755 AioContext
*aio_context
;
756 BlockJobDeferToMainLoopFn
*fn
;
758 } BlockJobDeferToMainLoopData
;
760 static void block_job_defer_to_main_loop_bh(void *opaque
)
762 BlockJobDeferToMainLoopData
*data
= opaque
;
763 AioContext
*aio_context
;
765 /* Prevent race with block_job_defer_to_main_loop() */
766 aio_context_acquire(data
->aio_context
);
768 /* Fetch BDS AioContext again, in case it has changed */
769 aio_context
= blk_get_aio_context(data
->job
->blk
);
770 if (aio_context
!= data
->aio_context
) {
771 aio_context_acquire(aio_context
);
774 data
->job
->deferred_to_main_loop
= false;
775 data
->fn(data
->job
, data
->opaque
);
777 if (aio_context
!= data
->aio_context
) {
778 aio_context_release(aio_context
);
781 aio_context_release(data
->aio_context
);
786 void block_job_defer_to_main_loop(BlockJob
*job
,
787 BlockJobDeferToMainLoopFn
*fn
,
790 BlockJobDeferToMainLoopData
*data
= g_malloc(sizeof(*data
));
792 data
->aio_context
= blk_get_aio_context(job
->blk
);
794 data
->opaque
= opaque
;
795 job
->deferred_to_main_loop
= true;
797 aio_bh_schedule_oneshot(qemu_get_aio_context(),
798 block_job_defer_to_main_loop_bh
, data
);
801 BlockJobTxn
*block_job_txn_new(void)
803 BlockJobTxn
*txn
= g_new0(BlockJobTxn
, 1);
804 QLIST_INIT(&txn
->jobs
);
809 static void block_job_txn_ref(BlockJobTxn
*txn
)
814 void block_job_txn_unref(BlockJobTxn
*txn
)
816 if (txn
&& --txn
->refcnt
== 0) {
821 void block_job_txn_add_job(BlockJobTxn
*txn
, BlockJob
*job
)
830 QLIST_INSERT_HEAD(&txn
->jobs
, job
, txn_list
);
831 block_job_txn_ref(txn
);