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/qerror.h"
33 #include "qapi/qmp/qjson.h"
34 #include "qemu/coroutine.h"
35 #include "qmp-commands.h"
36 #include "qemu/timer.h"
37 #include "qapi-event.h"
39 void *block_job_create(const BlockJobDriver *driver, BlockDriverState *bs,
40 int64_t speed, BlockCompletionFunc *cb,
41 void *opaque, Error **errp)
46 error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
50 job = g_malloc0(driver->instance_size);
51 error_setg(&job->blocker, "block device is in use by block job: %s",
52 BlockJobType_lookup[driver->job_type]);
53 bdrv_op_block_all(bs, job->blocker);
54 bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker);
57 job->id = g_strdup(bdrv_get_device_name(bs));
64 /* Only set speed when necessary to avoid NotSupported error */
66 Error *local_err = NULL;
68 block_job_set_speed(job, speed, &local_err);
70 block_job_release(bs);
71 error_propagate(errp, local_err);
78 void block_job_release(BlockDriverState *bs)
80 BlockJob *job = bs->job;
83 bdrv_op_unblock_all(bs, job->blocker);
84 error_free(job->blocker);
89 void block_job_completed(BlockJob *job, int ret)
91 BlockDriverState *bs = job->bs;
93 assert(bs->job == job);
94 job->cb(job->opaque, ret);
95 block_job_release(bs);
98 void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp)
100 Error *local_err = NULL;
102 if (!job->driver->set_speed) {
103 error_setg(errp, QERR_UNSUPPORTED);
106 job->driver->set_speed(job, speed, &local_err);
108 error_propagate(errp, local_err);
115 void block_job_complete(BlockJob *job, Error **errp)
117 if (job->pause_count || job->cancelled || !job->driver->complete) {
118 error_setg(errp, QERR_BLOCK_JOB_NOT_READY, job->id);
122 job->driver->complete(job, errp);
125 void block_job_pause(BlockJob *job)
130 bool block_job_is_paused(BlockJob *job)
132 return job->pause_count > 0;
135 void block_job_resume(BlockJob *job)
137 assert(job->pause_count > 0);
139 if (job->pause_count) {
142 block_job_enter(job);
145 void block_job_enter(BlockJob *job)
147 block_job_iostatus_reset(job);
148 if (job->co && !job->busy) {
149 qemu_coroutine_enter(job->co, NULL);
153 void block_job_cancel(BlockJob *job)
155 job->cancelled = true;
156 block_job_enter(job);
159 bool block_job_is_cancelled(BlockJob *job)
161 return job->cancelled;
164 void block_job_iostatus_reset(BlockJob *job)
166 job->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
167 if (job->driver->iostatus_reset) {
168 job->driver->iostatus_reset(job);
172 struct BlockFinishData {
174 BlockCompletionFunc *cb;
180 static void block_job_finish_cb(void *opaque, int ret)
182 struct BlockFinishData *data = opaque;
184 data->cancelled = block_job_is_cancelled(data->job);
186 data->cb(data->opaque, ret);
189 static int block_job_finish_sync(BlockJob *job,
190 void (*finish)(BlockJob *, Error **errp),
193 struct BlockFinishData data;
194 BlockDriverState *bs = job->bs;
195 Error *local_err = NULL;
197 assert(bs->job == job);
199 /* Set up our own callback to store the result and chain to
200 * the original callback.
204 data.opaque = job->opaque;
205 data.ret = -EINPROGRESS;
206 job->cb = block_job_finish_cb;
208 finish(job, &local_err);
210 error_propagate(errp, local_err);
213 while (data.ret == -EINPROGRESS) {
214 aio_poll(bdrv_get_aio_context(bs), true);
216 return (data.cancelled && data.ret == 0) ? -ECANCELED : data.ret;
219 /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
220 * used with block_job_finish_sync() without the need for (rather nasty)
221 * function pointer casts there. */
222 static void block_job_cancel_err(BlockJob *job, Error **errp)
224 block_job_cancel(job);
227 int block_job_cancel_sync(BlockJob *job)
229 return block_job_finish_sync(job, &block_job_cancel_err, NULL);
232 int block_job_complete_sync(BlockJob *job, Error **errp)
234 return block_job_finish_sync(job, &block_job_complete, errp);
237 void block_job_sleep_ns(BlockJob *job, QEMUClockType type, int64_t ns)
241 /* Check cancellation *before* setting busy = false, too! */
242 if (block_job_is_cancelled(job)) {
247 if (block_job_is_paused(job)) {
248 qemu_coroutine_yield();
250 co_aio_sleep_ns(bdrv_get_aio_context(job->bs), type, ns);
255 void block_job_yield(BlockJob *job)
259 /* Check cancellation *before* setting busy = false, too! */
260 if (block_job_is_cancelled(job)) {
265 qemu_coroutine_yield();
269 BlockJobInfo *block_job_query(BlockJob *job)
271 BlockJobInfo *info = g_new0(BlockJobInfo, 1);
272 info->type = g_strdup(BlockJobType_lookup[job->driver->job_type]);
273 info->device = g_strdup(job->id);
274 info->len = job->len;
275 info->busy = job->busy;
276 info->paused = job->pause_count > 0;
277 info->offset = job->offset;
278 info->speed = job->speed;
279 info->io_status = job->iostatus;
280 info->ready = job->ready;
284 static void block_job_iostatus_set_err(BlockJob *job, int error)
286 if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
287 job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
288 BLOCK_DEVICE_IO_STATUS_FAILED;
292 void block_job_event_cancelled(BlockJob *job)
294 qapi_event_send_block_job_cancelled(job->driver->job_type,
302 void block_job_event_completed(BlockJob *job, const char *msg)
304 qapi_event_send_block_job_completed(job->driver->job_type,
314 void block_job_event_ready(BlockJob *job)
318 qapi_event_send_block_job_ready(job->driver->job_type,
322 job->speed, &error_abort);
325 BlockErrorAction block_job_error_action(BlockJob *job, BlockDriverState *bs,
326 BlockdevOnError on_err,
327 int is_read, int error)
329 BlockErrorAction action;
332 case BLOCKDEV_ON_ERROR_ENOSPC:
333 action = (error == ENOSPC) ?
334 BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
336 case BLOCKDEV_ON_ERROR_STOP:
337 action = BLOCK_ERROR_ACTION_STOP;
339 case BLOCKDEV_ON_ERROR_REPORT:
340 action = BLOCK_ERROR_ACTION_REPORT;
342 case BLOCKDEV_ON_ERROR_IGNORE:
343 action = BLOCK_ERROR_ACTION_IGNORE;
348 qapi_event_send_block_job_error(job->id,
349 is_read ? IO_OPERATION_TYPE_READ :
350 IO_OPERATION_TYPE_WRITE,
351 action, &error_abort);
352 if (action == BLOCK_ERROR_ACTION_STOP) {
353 /* make the pause user visible, which will be resumed from QMP. */
354 job->user_paused = true;
355 block_job_pause(job);
356 block_job_iostatus_set_err(job, error);
358 bdrv_iostatus_set_err(bs, error);
367 AioContext *aio_context;
368 BlockJobDeferToMainLoopFn *fn;
370 } BlockJobDeferToMainLoopData;
372 static void block_job_defer_to_main_loop_bh(void *opaque)
374 BlockJobDeferToMainLoopData *data = opaque;
375 AioContext *aio_context;
377 qemu_bh_delete(data->bh);
379 /* Prevent race with block_job_defer_to_main_loop() */
380 aio_context_acquire(data->aio_context);
382 /* Fetch BDS AioContext again, in case it has changed */
383 aio_context = bdrv_get_aio_context(data->job->bs);
384 aio_context_acquire(aio_context);
386 data->fn(data->job, data->opaque);
388 aio_context_release(aio_context);
390 aio_context_release(data->aio_context);
395 void block_job_defer_to_main_loop(BlockJob *job,
396 BlockJobDeferToMainLoopFn *fn,
399 BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data));
401 data->bh = qemu_bh_new(block_job_defer_to_main_loop_bh, data);
402 data->aio_context = bdrv_get_aio_context(job->bs);
404 data->opaque = opaque;
406 qemu_bh_schedule(data->bh);