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 "config-host.h"
27 #include "qemu-common.h"
29 #include "block/block.h"
30 #include "block/blockjob.h"
31 #include "block/block_int.h"
32 #include "qapi/qmp/qjson.h"
33 #include "block/coroutine.h"
34 #include "qmp-commands.h"
35 #include "qemu/timer.h"
36 #include "qapi-event.h"
38 void *block_job_create(const BlockJobDriver
*driver
, BlockDriverState
*bs
,
39 int64_t speed
, BlockCompletionFunc
*cb
,
40 void *opaque
, Error
**errp
)
45 error_setg(errp
, QERR_DEVICE_IN_USE
, bdrv_get_device_name(bs
));
49 job
= g_malloc0(driver
->instance_size
);
50 error_setg(&job
->blocker
, "block device is in use by block job: %s",
51 BlockJobType_lookup
[driver
->job_type
]);
52 bdrv_op_block_all(bs
, job
->blocker
);
53 bdrv_op_unblock(bs
, BLOCK_OP_TYPE_DATAPLANE
, job
->blocker
);
62 /* Only set speed when necessary to avoid NotSupported error */
64 Error
*local_err
= NULL
;
66 block_job_set_speed(job
, speed
, &local_err
);
69 bdrv_op_unblock_all(bs
, job
->blocker
);
70 error_free(job
->blocker
);
72 error_propagate(errp
, local_err
);
79 void block_job_completed(BlockJob
*job
, int ret
)
81 BlockDriverState
*bs
= job
->bs
;
83 assert(bs
->job
== job
);
84 job
->cb(job
->opaque
, ret
);
86 bdrv_op_unblock_all(bs
, job
->blocker
);
87 error_free(job
->blocker
);
91 void block_job_set_speed(BlockJob
*job
, int64_t speed
, Error
**errp
)
93 Error
*local_err
= NULL
;
95 if (!job
->driver
->set_speed
) {
96 error_setg(errp
, QERR_UNSUPPORTED
);
99 job
->driver
->set_speed(job
, speed
, &local_err
);
101 error_propagate(errp
, local_err
);
108 void block_job_complete(BlockJob
*job
, Error
**errp
)
110 if (job
->pause_count
|| job
->cancelled
|| !job
->driver
->complete
) {
111 error_setg(errp
, QERR_BLOCK_JOB_NOT_READY
,
112 bdrv_get_device_name(job
->bs
));
116 job
->driver
->complete(job
, errp
);
119 void block_job_pause(BlockJob
*job
)
124 bool block_job_is_paused(BlockJob
*job
)
126 return job
->pause_count
> 0;
129 void block_job_resume(BlockJob
*job
)
131 assert(job
->pause_count
> 0);
133 if (job
->pause_count
) {
136 block_job_enter(job
);
139 void block_job_enter(BlockJob
*job
)
141 block_job_iostatus_reset(job
);
142 if (job
->co
&& !job
->busy
) {
143 qemu_coroutine_enter(job
->co
, NULL
);
147 void block_job_cancel(BlockJob
*job
)
149 job
->cancelled
= true;
150 block_job_enter(job
);
153 bool block_job_is_cancelled(BlockJob
*job
)
155 return job
->cancelled
;
158 void block_job_iostatus_reset(BlockJob
*job
)
160 job
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
161 if (job
->driver
->iostatus_reset
) {
162 job
->driver
->iostatus_reset(job
);
166 struct BlockFinishData
{
168 BlockCompletionFunc
*cb
;
174 static void block_job_finish_cb(void *opaque
, int ret
)
176 struct BlockFinishData
*data
= opaque
;
178 data
->cancelled
= block_job_is_cancelled(data
->job
);
180 data
->cb(data
->opaque
, ret
);
183 static int block_job_finish_sync(BlockJob
*job
,
184 void (*finish
)(BlockJob
*, Error
**errp
),
187 struct BlockFinishData data
;
188 BlockDriverState
*bs
= job
->bs
;
189 Error
*local_err
= NULL
;
191 assert(bs
->job
== job
);
193 /* Set up our own callback to store the result and chain to
194 * the original callback.
198 data
.opaque
= job
->opaque
;
199 data
.ret
= -EINPROGRESS
;
200 job
->cb
= block_job_finish_cb
;
202 finish(job
, &local_err
);
204 error_propagate(errp
, local_err
);
207 while (data
.ret
== -EINPROGRESS
) {
208 aio_poll(bdrv_get_aio_context(bs
), true);
210 return (data
.cancelled
&& data
.ret
== 0) ? -ECANCELED
: data
.ret
;
213 /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
214 * used with block_job_finish_sync() without the need for (rather nasty)
215 * function pointer casts there. */
216 static void block_job_cancel_err(BlockJob
*job
, Error
**errp
)
218 block_job_cancel(job
);
221 int block_job_cancel_sync(BlockJob
*job
)
223 return block_job_finish_sync(job
, &block_job_cancel_err
, NULL
);
226 int block_job_complete_sync(BlockJob
*job
, Error
**errp
)
228 return block_job_finish_sync(job
, &block_job_complete
, errp
);
231 void block_job_sleep_ns(BlockJob
*job
, QEMUClockType type
, int64_t ns
)
235 /* Check cancellation *before* setting busy = false, too! */
236 if (block_job_is_cancelled(job
)) {
241 if (block_job_is_paused(job
)) {
242 qemu_coroutine_yield();
244 co_aio_sleep_ns(bdrv_get_aio_context(job
->bs
), type
, ns
);
249 void block_job_yield(BlockJob
*job
)
253 /* Check cancellation *before* setting busy = false, too! */
254 if (block_job_is_cancelled(job
)) {
259 qemu_coroutine_yield();
263 BlockJobInfo
*block_job_query(BlockJob
*job
)
265 BlockJobInfo
*info
= g_new0(BlockJobInfo
, 1);
266 info
->type
= g_strdup(BlockJobType_lookup
[job
->driver
->job_type
]);
267 info
->device
= g_strdup(bdrv_get_device_name(job
->bs
));
268 info
->len
= job
->len
;
269 info
->busy
= job
->busy
;
270 info
->paused
= job
->pause_count
> 0;
271 info
->offset
= job
->offset
;
272 info
->speed
= job
->speed
;
273 info
->io_status
= job
->iostatus
;
274 info
->ready
= job
->ready
;
278 static void block_job_iostatus_set_err(BlockJob
*job
, int error
)
280 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
281 job
->iostatus
= error
== ENOSPC
? BLOCK_DEVICE_IO_STATUS_NOSPACE
:
282 BLOCK_DEVICE_IO_STATUS_FAILED
;
286 void block_job_event_cancelled(BlockJob
*job
)
288 qapi_event_send_block_job_cancelled(job
->driver
->job_type
,
289 bdrv_get_device_name(job
->bs
),
296 void block_job_event_completed(BlockJob
*job
, const char *msg
)
298 qapi_event_send_block_job_completed(job
->driver
->job_type
,
299 bdrv_get_device_name(job
->bs
),
308 void block_job_event_ready(BlockJob
*job
)
312 qapi_event_send_block_job_ready(job
->driver
->job_type
,
313 bdrv_get_device_name(job
->bs
),
316 job
->speed
, &error_abort
);
319 BlockErrorAction
block_job_error_action(BlockJob
*job
, BlockDriverState
*bs
,
320 BlockdevOnError on_err
,
321 int is_read
, int error
)
323 BlockErrorAction action
;
326 case BLOCKDEV_ON_ERROR_ENOSPC
:
327 action
= (error
== ENOSPC
) ?
328 BLOCK_ERROR_ACTION_STOP
: BLOCK_ERROR_ACTION_REPORT
;
330 case BLOCKDEV_ON_ERROR_STOP
:
331 action
= BLOCK_ERROR_ACTION_STOP
;
333 case BLOCKDEV_ON_ERROR_REPORT
:
334 action
= BLOCK_ERROR_ACTION_REPORT
;
336 case BLOCKDEV_ON_ERROR_IGNORE
:
337 action
= BLOCK_ERROR_ACTION_IGNORE
;
342 qapi_event_send_block_job_error(bdrv_get_device_name(job
->bs
),
343 is_read
? IO_OPERATION_TYPE_READ
:
344 IO_OPERATION_TYPE_WRITE
,
345 action
, &error_abort
);
346 if (action
== BLOCK_ERROR_ACTION_STOP
) {
347 /* make the pause user visible, which will be resumed from QMP. */
348 job
->user_paused
= true;
349 block_job_pause(job
);
350 block_job_iostatus_set_err(job
, error
);
352 bdrv_iostatus_set_err(bs
, error
);
361 AioContext
*aio_context
;
362 BlockJobDeferToMainLoopFn
*fn
;
364 } BlockJobDeferToMainLoopData
;
366 static void block_job_defer_to_main_loop_bh(void *opaque
)
368 BlockJobDeferToMainLoopData
*data
= opaque
;
369 AioContext
*aio_context
;
371 qemu_bh_delete(data
->bh
);
373 /* Prevent race with block_job_defer_to_main_loop() */
374 aio_context_acquire(data
->aio_context
);
376 /* Fetch BDS AioContext again, in case it has changed */
377 aio_context
= bdrv_get_aio_context(data
->job
->bs
);
378 aio_context_acquire(aio_context
);
380 data
->fn(data
->job
, data
->opaque
);
382 aio_context_release(aio_context
);
384 aio_context_release(data
->aio_context
);
389 void block_job_defer_to_main_loop(BlockJob
*job
,
390 BlockJobDeferToMainLoopFn
*fn
,
393 BlockJobDeferToMainLoopData
*data
= g_malloc(sizeof(*data
));
395 data
->bh
= qemu_bh_new(block_job_defer_to_main_loop_bh
, data
);
396 data
->aio_context
= bdrv_get_aio_context(job
->bs
);
398 data
->opaque
= opaque
;
400 qemu_bh_schedule(data
->bh
);