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"
40 * The block job API is composed of two categories of functions.
42 * The first includes functions used by the monitor. The monitor is
43 * peculiar in that it accesses the block job list with block_job_get, and
44 * therefore needs consistency across block_job_get and the actual operation
45 * (e.g. block_job_set_speed). The consistency is achieved with
46 * aio_context_acquire/release. These functions are declared in blockjob.h.
48 * The second includes functions used by the block job drivers and sometimes
49 * by the core block layer. These do not care about locking, because the
50 * whole coroutine runs under the AioContext lock, and are declared in
54 static bool is_block_job(Job
*job
)
56 return job_type(job
) == JOB_TYPE_BACKUP
||
57 job_type(job
) == JOB_TYPE_COMMIT
||
58 job_type(job
) == JOB_TYPE_MIRROR
||
59 job_type(job
) == JOB_TYPE_STREAM
;
62 BlockJob
*block_job_next(BlockJob
*bjob
)
64 Job
*job
= bjob
? &bjob
->job
: NULL
;
68 } while (job
&& !is_block_job(job
));
70 return job
? container_of(job
, BlockJob
, job
) : NULL
;
73 BlockJob
*block_job_get(const char *id
)
75 Job
*job
= job_get(id
);
77 if (job
&& is_block_job(job
)) {
78 return container_of(job
, BlockJob
, job
);
84 static void block_job_attached_aio_context(AioContext
*new_context
,
86 static void block_job_detach_aio_context(void *opaque
);
88 void block_job_free(Job
*job
)
90 BlockJob
*bjob
= container_of(job
, BlockJob
, job
);
91 BlockDriverState
*bs
= blk_bs(bjob
->blk
);
94 block_job_remove_all_bdrv(bjob
);
95 blk_remove_aio_context_notifier(bjob
->blk
,
96 block_job_attached_aio_context
,
97 block_job_detach_aio_context
, bjob
);
99 error_free(bjob
->blocker
);
102 static void block_job_attached_aio_context(AioContext
*new_context
,
105 BlockJob
*job
= opaque
;
107 job
->job
.aio_context
= new_context
;
108 if (job
->driver
->attached_aio_context
) {
109 job
->driver
->attached_aio_context(job
, new_context
);
112 job_resume(&job
->job
);
115 void block_job_drain(Job
*job
)
117 BlockJob
*bjob
= container_of(job
, BlockJob
, job
);
119 blk_drain(bjob
->blk
);
120 if (bjob
->driver
->drain
) {
121 bjob
->driver
->drain(bjob
);
125 static void block_job_detach_aio_context(void *opaque
)
127 BlockJob
*job
= opaque
;
129 /* In case the job terminates during aio_poll()... */
132 job_pause(&job
->job
);
134 while (!job
->job
.paused
&& !job_is_completed(&job
->job
)) {
135 job_drain(&job
->job
);
138 job
->job
.aio_context
= NULL
;
139 job_unref(&job
->job
);
142 static char *child_job_get_parent_desc(BdrvChild
*c
)
144 BlockJob
*job
= c
->opaque
;
145 return g_strdup_printf("%s job '%s'", job_type_str(&job
->job
), job
->job
.id
);
148 static void child_job_drained_begin(BdrvChild
*c
)
150 BlockJob
*job
= c
->opaque
;
151 job_pause(&job
->job
);
154 static void child_job_drained_end(BdrvChild
*c
)
156 BlockJob
*job
= c
->opaque
;
157 job_resume(&job
->job
);
160 static const BdrvChildRole child_job
= {
161 .get_parent_desc
= child_job_get_parent_desc
,
162 .drained_begin
= child_job_drained_begin
,
163 .drained_end
= child_job_drained_end
,
164 .stay_at_node
= true,
167 void block_job_remove_all_bdrv(BlockJob
*job
)
170 for (l
= job
->nodes
; l
; l
= l
->next
) {
171 BdrvChild
*c
= l
->data
;
172 bdrv_op_unblock_all(c
->bs
, job
->blocker
);
173 bdrv_root_unref_child(c
);
175 g_slist_free(job
->nodes
);
179 int block_job_add_bdrv(BlockJob
*job
, const char *name
, BlockDriverState
*bs
,
180 uint64_t perm
, uint64_t shared_perm
, Error
**errp
)
184 c
= bdrv_root_attach_child(bs
, name
, &child_job
, perm
, shared_perm
,
190 job
->nodes
= g_slist_prepend(job
->nodes
, c
);
192 bdrv_op_block_all(bs
, job
->blocker
);
197 bool block_job_is_internal(BlockJob
*job
)
199 return (job
->job
.id
== NULL
);
202 const BlockJobDriver
*block_job_driver(BlockJob
*job
)
207 /* Assumes the job_mutex is held */
208 static bool job_timer_pending(Job
*job
)
210 return timer_pending(&job
->sleep_timer
);
213 void block_job_set_speed(BlockJob
*job
, int64_t speed
, Error
**errp
)
215 int64_t old_speed
= job
->speed
;
217 if (job_apply_verb(&job
->job
, JOB_VERB_SET_SPEED
, errp
)) {
221 error_setg(errp
, QERR_INVALID_PARAMETER
, "speed");
225 ratelimit_set_speed(&job
->limit
, speed
, BLOCK_JOB_SLICE_TIME
);
228 if (speed
&& speed
<= old_speed
) {
232 /* kick only if a timer is pending */
233 job_enter_cond(&job
->job
, job_timer_pending
);
236 int64_t block_job_ratelimit_get_delay(BlockJob
*job
, uint64_t n
)
242 return ratelimit_calculate_delay(&job
->limit
, n
);
245 BlockJobInfo
*block_job_query(BlockJob
*job
, Error
**errp
)
249 if (block_job_is_internal(job
)) {
250 error_setg(errp
, "Cannot query QEMU internal jobs");
253 info
= g_new0(BlockJobInfo
, 1);
254 info
->type
= g_strdup(job_type_str(&job
->job
));
255 info
->device
= g_strdup(job
->job
.id
);
256 info
->busy
= atomic_read(&job
->job
.busy
);
257 info
->paused
= job
->job
.pause_count
> 0;
258 info
->offset
= job
->job
.progress_current
;
259 info
->len
= job
->job
.progress_total
;
260 info
->speed
= job
->speed
;
261 info
->io_status
= job
->iostatus
;
262 info
->ready
= job_is_ready(&job
->job
),
263 info
->status
= job
->job
.status
;
264 info
->auto_finalize
= job
->job
.auto_finalize
;
265 info
->auto_dismiss
= job
->job
.auto_dismiss
;
266 info
->has_error
= job
->job
.ret
!= 0;
267 info
->error
= job
->job
.ret
? g_strdup(strerror(-job
->job
.ret
)) : NULL
;
271 static void block_job_iostatus_set_err(BlockJob
*job
, int error
)
273 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
274 job
->iostatus
= error
== ENOSPC
? BLOCK_DEVICE_IO_STATUS_NOSPACE
:
275 BLOCK_DEVICE_IO_STATUS_FAILED
;
279 static void block_job_event_cancelled(Notifier
*n
, void *opaque
)
281 BlockJob
*job
= opaque
;
283 if (block_job_is_internal(job
)) {
287 qapi_event_send_block_job_cancelled(job_type(&job
->job
),
289 job
->job
.progress_total
,
290 job
->job
.progress_current
,
295 static void block_job_event_completed(Notifier
*n
, void *opaque
)
297 BlockJob
*job
= opaque
;
298 const char *msg
= NULL
;
300 if (block_job_is_internal(job
)) {
304 if (job
->job
.ret
< 0) {
305 msg
= strerror(-job
->job
.ret
);
308 qapi_event_send_block_job_completed(job_type(&job
->job
),
310 job
->job
.progress_total
,
311 job
->job
.progress_current
,
318 static void block_job_event_pending(Notifier
*n
, void *opaque
)
320 BlockJob
*job
= opaque
;
322 if (block_job_is_internal(job
)) {
326 qapi_event_send_block_job_pending(job_type(&job
->job
),
331 static void block_job_event_ready(Notifier
*n
, void *opaque
)
333 BlockJob
*job
= opaque
;
335 if (block_job_is_internal(job
)) {
339 qapi_event_send_block_job_ready(job_type(&job
->job
),
341 job
->job
.progress_total
,
342 job
->job
.progress_current
,
343 job
->speed
, &error_abort
);
348 * API for block job drivers and the block layer. These functions are
349 * declared in blockjob_int.h.
352 void *block_job_create(const char *job_id
, const BlockJobDriver
*driver
,
353 JobTxn
*txn
, BlockDriverState
*bs
, uint64_t perm
,
354 uint64_t shared_perm
, int64_t speed
, int flags
,
355 BlockCompletionFunc
*cb
, void *opaque
, Error
**errp
)
362 error_setg(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
366 if (job_id
== NULL
&& !(flags
& JOB_INTERNAL
)) {
367 job_id
= bdrv_get_device_name(bs
);
370 blk
= blk_new(perm
, shared_perm
);
371 ret
= blk_insert_bs(blk
, bs
, errp
);
377 job
= job_create(job_id
, &driver
->job_driver
, txn
, blk_get_aio_context(blk
),
378 flags
, cb
, opaque
, errp
);
384 assert(is_block_job(&job
->job
));
385 assert(job
->job
.driver
->free
== &block_job_free
);
386 assert(job
->job
.driver
->user_resume
== &block_job_user_resume
);
387 assert(job
->job
.driver
->drain
== &block_job_drain
);
389 job
->driver
= driver
;
392 job
->finalize_cancelled_notifier
.notify
= block_job_event_cancelled
;
393 job
->finalize_completed_notifier
.notify
= block_job_event_completed
;
394 job
->pending_notifier
.notify
= block_job_event_pending
;
395 job
->ready_notifier
.notify
= block_job_event_ready
;
397 notifier_list_add(&job
->job
.on_finalize_cancelled
,
398 &job
->finalize_cancelled_notifier
);
399 notifier_list_add(&job
->job
.on_finalize_completed
,
400 &job
->finalize_completed_notifier
);
401 notifier_list_add(&job
->job
.on_pending
, &job
->pending_notifier
);
402 notifier_list_add(&job
->job
.on_ready
, &job
->ready_notifier
);
404 error_setg(&job
->blocker
, "block device is in use by block job: %s",
405 job_type_str(&job
->job
));
406 block_job_add_bdrv(job
, "main node", bs
, 0, BLK_PERM_ALL
, &error_abort
);
409 bdrv_op_unblock(bs
, BLOCK_OP_TYPE_DATAPLANE
, job
->blocker
);
411 blk_add_aio_context_notifier(blk
, block_job_attached_aio_context
,
412 block_job_detach_aio_context
, job
);
414 /* Only set speed when necessary to avoid NotSupported error */
416 Error
*local_err
= NULL
;
418 block_job_set_speed(job
, speed
, &local_err
);
420 job_early_fail(&job
->job
);
421 error_propagate(errp
, local_err
);
429 void block_job_iostatus_reset(BlockJob
*job
)
431 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
434 assert(job
->job
.user_paused
&& job
->job
.pause_count
> 0);
435 job
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
438 void block_job_user_resume(Job
*job
)
440 BlockJob
*bjob
= container_of(job
, BlockJob
, job
);
441 block_job_iostatus_reset(bjob
);
444 BlockErrorAction
block_job_error_action(BlockJob
*job
, BlockdevOnError on_err
,
445 int is_read
, int error
)
447 BlockErrorAction action
;
450 case BLOCKDEV_ON_ERROR_ENOSPC
:
451 case BLOCKDEV_ON_ERROR_AUTO
:
452 action
= (error
== ENOSPC
) ?
453 BLOCK_ERROR_ACTION_STOP
: BLOCK_ERROR_ACTION_REPORT
;
455 case BLOCKDEV_ON_ERROR_STOP
:
456 action
= BLOCK_ERROR_ACTION_STOP
;
458 case BLOCKDEV_ON_ERROR_REPORT
:
459 action
= BLOCK_ERROR_ACTION_REPORT
;
461 case BLOCKDEV_ON_ERROR_IGNORE
:
462 action
= BLOCK_ERROR_ACTION_IGNORE
;
467 if (!block_job_is_internal(job
)) {
468 qapi_event_send_block_job_error(job
->job
.id
,
469 is_read
? IO_OPERATION_TYPE_READ
:
470 IO_OPERATION_TYPE_WRITE
,
471 action
, &error_abort
);
473 if (action
== BLOCK_ERROR_ACTION_STOP
) {
474 job_pause(&job
->job
);
475 /* make the pause user visible, which will be resumed from QMP. */
476 job
->job
.user_paused
= true;
477 block_job_iostatus_set_err(job
, error
);