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 "monitor/monitor.h"
30 #include "block/block.h"
31 #include "block/blockjob.h"
32 #include "block/block_int.h"
33 #include "qapi/qmp/qjson.h"
34 #include "block/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
, BlockDriverCompletionFunc
*cb
,
41 void *opaque
, Error
**errp
)
46 error_set(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
);
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_set(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
->paused
|| job
->cancelled
|| !job
->driver
->complete
) {
111 error_set(errp
, QERR_BLOCK_JOB_NOT_READY
, job
->bs
->device_name
);
115 job
->driver
->complete(job
, errp
);
118 void block_job_pause(BlockJob
*job
)
123 bool block_job_is_paused(BlockJob
*job
)
128 void block_job_resume(BlockJob
*job
)
131 block_job_iostatus_reset(job
);
132 if (job
->co
&& !job
->busy
) {
133 qemu_coroutine_enter(job
->co
, NULL
);
137 void block_job_cancel(BlockJob
*job
)
139 job
->cancelled
= true;
140 block_job_resume(job
);
143 bool block_job_is_cancelled(BlockJob
*job
)
145 return job
->cancelled
;
148 void block_job_iostatus_reset(BlockJob
*job
)
150 job
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
151 if (job
->driver
->iostatus_reset
) {
152 job
->driver
->iostatus_reset(job
);
156 struct BlockCancelData
{
158 BlockDriverCompletionFunc
*cb
;
164 static void block_job_cancel_cb(void *opaque
, int ret
)
166 struct BlockCancelData
*data
= opaque
;
168 data
->cancelled
= block_job_is_cancelled(data
->job
);
170 data
->cb(data
->opaque
, ret
);
173 int block_job_cancel_sync(BlockJob
*job
)
175 struct BlockCancelData data
;
176 BlockDriverState
*bs
= job
->bs
;
178 assert(bs
->job
== job
);
180 /* Set up our own callback to store the result and chain to
181 * the original callback.
185 data
.opaque
= job
->opaque
;
186 data
.ret
= -EINPROGRESS
;
187 job
->cb
= block_job_cancel_cb
;
189 block_job_cancel(job
);
190 while (data
.ret
== -EINPROGRESS
) {
193 return (data
.cancelled
&& data
.ret
== 0) ? -ECANCELED
: data
.ret
;
196 void block_job_sleep_ns(BlockJob
*job
, QEMUClockType type
, int64_t ns
)
200 /* Check cancellation *before* setting busy = false, too! */
201 if (block_job_is_cancelled(job
)) {
206 if (block_job_is_paused(job
)) {
207 qemu_coroutine_yield();
209 co_sleep_ns(type
, ns
);
214 BlockJobInfo
*block_job_query(BlockJob
*job
)
216 BlockJobInfo
*info
= g_new0(BlockJobInfo
, 1);
217 info
->type
= g_strdup(BlockJobType_lookup
[job
->driver
->job_type
]);
218 info
->device
= g_strdup(bdrv_get_device_name(job
->bs
));
219 info
->len
= job
->len
;
220 info
->busy
= job
->busy
;
221 info
->paused
= job
->paused
;
222 info
->offset
= job
->offset
;
223 info
->speed
= job
->speed
;
224 info
->io_status
= job
->iostatus
;
228 static void block_job_iostatus_set_err(BlockJob
*job
, int error
)
230 if (job
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
231 job
->iostatus
= error
== ENOSPC
? BLOCK_DEVICE_IO_STATUS_NOSPACE
:
232 BLOCK_DEVICE_IO_STATUS_FAILED
;
237 QObject
*qobject_from_block_job(BlockJob
*job
)
239 return qobject_from_jsonf("{ 'type': %s,"
241 "'len': %" PRId64
","
242 "'offset': %" PRId64
","
243 "'speed': %" PRId64
" }",
244 BlockJobType_lookup
[job
->driver
->job_type
],
245 bdrv_get_device_name(job
->bs
),
251 void block_job_ready(BlockJob
*job
)
253 QObject
*data
= qobject_from_block_job(job
);
254 monitor_protocol_event(QEVENT_BLOCK_JOB_READY
, data
);
255 qobject_decref(data
);
258 BlockErrorAction
block_job_error_action(BlockJob
*job
, BlockDriverState
*bs
,
259 BlockdevOnError on_err
,
260 int is_read
, int error
)
262 BlockErrorAction action
;
265 case BLOCKDEV_ON_ERROR_ENOSPC
:
266 action
= (error
== ENOSPC
) ?
267 BLOCK_ERROR_ACTION_STOP
: BLOCK_ERROR_ACTION_REPORT
;
269 case BLOCKDEV_ON_ERROR_STOP
:
270 action
= BLOCK_ERROR_ACTION_STOP
;
272 case BLOCKDEV_ON_ERROR_REPORT
:
273 action
= BLOCK_ERROR_ACTION_REPORT
;
275 case BLOCKDEV_ON_ERROR_IGNORE
:
276 action
= BLOCK_ERROR_ACTION_IGNORE
;
281 qapi_event_send_block_job_error(bdrv_get_device_name(bs
),
282 is_read
? IO_OPERATION_TYPE_READ
:
283 IO_OPERATION_TYPE_WRITE
,
284 action
, &error_abort
);
285 if (action
== BLOCK_ERROR_ACTION_STOP
) {
286 block_job_pause(job
);
287 block_job_iostatus_set_err(job
, error
);
289 bdrv_iostatus_set_err(bs
, error
);