]> git.proxmox.com Git - mirror_qemu.git/blame - blockjob.c
blockjob: Simplify block_job_finish_sync
[mirror_qemu.git] / blockjob.c
CommitLineData
2f0c9fe6
PB
1/*
2 * QEMU System Emulator block driver
3 *
4 * Copyright (c) 2011 IBM Corp.
5 * Copyright (c) 2012 Red Hat, Inc.
6 *
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:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
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
23 * THE SOFTWARE.
24 */
25
26#include "config-host.h"
27#include "qemu-common.h"
28#include "trace.h"
737e150e
PB
29#include "block/block.h"
30#include "block/blockjob.h"
31#include "block/block_int.h"
373340b2 32#include "sysemu/block-backend.h"
cc7a8ea7 33#include "qapi/qmp/qerror.h"
7b1b5d19 34#include "qapi/qmp/qjson.h"
10817bf0 35#include "qemu/coroutine.h"
2f0c9fe6 36#include "qmp-commands.h"
1de7afc9 37#include "qemu/timer.h"
5a2d2cbd 38#include "qapi-event.h"
2f0c9fe6 39
3fc4b10a 40void *block_job_create(const BlockJobDriver *driver, BlockDriverState *bs,
097310b5 41 int64_t speed, BlockCompletionFunc *cb,
2f0c9fe6
PB
42 void *opaque, Error **errp)
43{
44 BlockJob *job;
45
628ff683 46 if (bs->job) {
c6bd8c70 47 error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs));
2f0c9fe6
PB
48 return NULL;
49 }
fa510ebf 50 bdrv_ref(bs);
3fc4b10a 51 job = g_malloc0(driver->instance_size);
3718d8ab
FZ
52 error_setg(&job->blocker, "block device is in use by block job: %s",
53 BlockJobType_lookup[driver->job_type]);
54 bdrv_op_block_all(bs, job->blocker);
b112a65c 55 bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker);
3718d8ab 56
3fc4b10a 57 job->driver = driver;
8ccb9569 58 job->id = g_strdup(bdrv_get_device_name(bs));
2f0c9fe6
PB
59 job->bs = bs;
60 job->cb = cb;
61 job->opaque = opaque;
62 job->busy = true;
18930ba3 63 job->refcnt = 1;
2f0c9fe6
PB
64 bs->job = job;
65
66 /* Only set speed when necessary to avoid NotSupported error */
67 if (speed != 0) {
68 Error *local_err = NULL;
69
70 block_job_set_speed(job, speed, &local_err);
84d18f06 71 if (local_err) {
18930ba3 72 block_job_unref(job);
2f0c9fe6
PB
73 error_propagate(errp, local_err);
74 return NULL;
75 }
76 }
77 return job;
78}
79
18930ba3 80void block_job_ref(BlockJob *job)
2f0c9fe6 81{
18930ba3
FZ
82 ++job->refcnt;
83}
2f0c9fe6 84
18930ba3
FZ
85void block_job_unref(BlockJob *job)
86{
87 if (--job->refcnt == 0) {
88 job->bs->job = NULL;
89 bdrv_op_unblock_all(job->bs, job->blocker);
90 bdrv_unref(job->bs);
91 error_free(job->blocker);
92 g_free(job->id);
93 g_free(job);
94 }
2f0c9fe6
PB
95}
96
97031164
TW
97void block_job_completed(BlockJob *job, int ret)
98{
99 BlockDriverState *bs = job->bs;
100
101 assert(bs->job == job);
a689dbf2
FZ
102 assert(!job->completed);
103 job->completed = true;
104 job->ret = ret;
97031164 105 job->cb(job->opaque, ret);
18930ba3 106 block_job_unref(job);
97031164
TW
107}
108
2f0c9fe6
PB
109void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp)
110{
111 Error *local_err = NULL;
112
3fc4b10a 113 if (!job->driver->set_speed) {
c6bd8c70 114 error_setg(errp, QERR_UNSUPPORTED);
2f0c9fe6
PB
115 return;
116 }
3fc4b10a 117 job->driver->set_speed(job, speed, &local_err);
84d18f06 118 if (local_err) {
2f0c9fe6
PB
119 error_propagate(errp, local_err);
120 return;
121 }
122
123 job->speed = speed;
124}
125
aeae883b
PB
126void block_job_complete(BlockJob *job, Error **errp)
127{
751ebd76 128 if (job->pause_count || job->cancelled || !job->driver->complete) {
8ccb9569 129 error_setg(errp, QERR_BLOCK_JOB_NOT_READY, job->id);
aeae883b
PB
130 return;
131 }
132
3fc4b10a 133 job->driver->complete(job, errp);
aeae883b
PB
134}
135
8acc72a4 136void block_job_pause(BlockJob *job)
2f0c9fe6 137{
751ebd76 138 job->pause_count++;
8acc72a4
PB
139}
140
141bool block_job_is_paused(BlockJob *job)
142{
751ebd76 143 return job->pause_count > 0;
8acc72a4
PB
144}
145
146void block_job_resume(BlockJob *job)
147{
751ebd76
FZ
148 assert(job->pause_count > 0);
149 job->pause_count--;
150 if (job->pause_count) {
151 return;
152 }
153 block_job_enter(job);
154}
155
156void block_job_enter(BlockJob *job)
157{
32c81a4a 158 block_job_iostatus_reset(job);
2f0c9fe6
PB
159 if (job->co && !job->busy) {
160 qemu_coroutine_enter(job->co, NULL);
161 }
162}
163
8acc72a4
PB
164void block_job_cancel(BlockJob *job)
165{
166 job->cancelled = true;
751ebd76 167 block_job_enter(job);
8acc72a4
PB
168}
169
2f0c9fe6
PB
170bool block_job_is_cancelled(BlockJob *job)
171{
172 return job->cancelled;
173}
174
32c81a4a
PB
175void block_job_iostatus_reset(BlockJob *job)
176{
177 job->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
3fc4b10a
FZ
178 if (job->driver->iostatus_reset) {
179 job->driver->iostatus_reset(job);
3bd293c3 180 }
32c81a4a
PB
181}
182
345f9e1b 183struct BlockFinishData {
2f0c9fe6 184 BlockJob *job;
097310b5 185 BlockCompletionFunc *cb;
2f0c9fe6
PB
186 void *opaque;
187 bool cancelled;
188 int ret;
189};
190
345f9e1b
HR
191static int block_job_finish_sync(BlockJob *job,
192 void (*finish)(BlockJob *, Error **errp),
193 Error **errp)
2f0c9fe6 194{
2f0c9fe6 195 BlockDriverState *bs = job->bs;
345f9e1b 196 Error *local_err = NULL;
94db6d2d 197 int ret;
2f0c9fe6
PB
198
199 assert(bs->job == job);
200
94db6d2d 201 block_job_ref(job);
345f9e1b
HR
202 finish(job, &local_err);
203 if (local_err) {
204 error_propagate(errp, local_err);
94db6d2d 205 block_job_unref(job);
345f9e1b
HR
206 return -EBUSY;
207 }
94db6d2d 208 while (!job->completed) {
b47ec2c4 209 aio_poll(bdrv_get_aio_context(bs), true);
2f0c9fe6 210 }
94db6d2d
FZ
211 ret = (job->cancelled && job->ret == 0) ? -ECANCELED : job->ret;
212 block_job_unref(job);
213 return ret;
2f0c9fe6
PB
214}
215
345f9e1b
HR
216/* A wrapper around block_job_cancel() taking an Error ** parameter so it may be
217 * used with block_job_finish_sync() without the need for (rather nasty)
218 * function pointer casts there. */
219static void block_job_cancel_err(BlockJob *job, Error **errp)
220{
221 block_job_cancel(job);
222}
223
224int block_job_cancel_sync(BlockJob *job)
225{
226 return block_job_finish_sync(job, &block_job_cancel_err, NULL);
227}
228
229int block_job_complete_sync(BlockJob *job, Error **errp)
230{
231 return block_job_finish_sync(job, &block_job_complete, errp);
232}
233
7483d1e5 234void block_job_sleep_ns(BlockJob *job, QEMUClockType type, int64_t ns)
2f0c9fe6 235{
8acc72a4
PB
236 assert(job->busy);
237
2f0c9fe6 238 /* Check cancellation *before* setting busy = false, too! */
8acc72a4
PB
239 if (block_job_is_cancelled(job)) {
240 return;
241 }
242
243 job->busy = false;
244 if (block_job_is_paused(job)) {
245 qemu_coroutine_yield();
246 } else {
0b9caf9b 247 co_aio_sleep_ns(bdrv_get_aio_context(job->bs), type, ns);
2f0c9fe6 248 }
8acc72a4 249 job->busy = true;
2f0c9fe6 250}
30e628b7 251
dc71ce45
FZ
252void block_job_yield(BlockJob *job)
253{
254 assert(job->busy);
255
256 /* Check cancellation *before* setting busy = false, too! */
257 if (block_job_is_cancelled(job)) {
258 return;
259 }
260
261 job->busy = false;
262 qemu_coroutine_yield();
263 job->busy = true;
264}
265
30e628b7
PB
266BlockJobInfo *block_job_query(BlockJob *job)
267{
268 BlockJobInfo *info = g_new0(BlockJobInfo, 1);
79e14bf7 269 info->type = g_strdup(BlockJobType_lookup[job->driver->job_type]);
8ccb9569 270 info->device = g_strdup(job->id);
32c81a4a
PB
271 info->len = job->len;
272 info->busy = job->busy;
751ebd76 273 info->paused = job->pause_count > 0;
32c81a4a
PB
274 info->offset = job->offset;
275 info->speed = job->speed;
276 info->io_status = job->iostatus;
ef6dbf1e 277 info->ready = job->ready;
30e628b7
PB
278 return info;
279}
32c81a4a
PB
280
281static void block_job_iostatus_set_err(BlockJob *job, int error)
282{
283 if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
284 job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
285 BLOCK_DEVICE_IO_STATUS_FAILED;
286 }
287}
288
bcada37b
WX
289void block_job_event_cancelled(BlockJob *job)
290{
291 qapi_event_send_block_job_cancelled(job->driver->job_type,
8ccb9569 292 job->id,
bcada37b
WX
293 job->len,
294 job->offset,
295 job->speed,
296 &error_abort);
297}
32c81a4a 298
bcada37b 299void block_job_event_completed(BlockJob *job, const char *msg)
a66a2a36 300{
bcada37b 301 qapi_event_send_block_job_completed(job->driver->job_type,
8ccb9569 302 job->id,
bcada37b
WX
303 job->len,
304 job->offset,
305 job->speed,
306 !!msg,
307 msg,
308 &error_abort);
a66a2a36
PB
309}
310
bcada37b 311void block_job_event_ready(BlockJob *job)
a66a2a36 312{
ef6dbf1e
HR
313 job->ready = true;
314
518848a2 315 qapi_event_send_block_job_ready(job->driver->job_type,
8ccb9569 316 job->id,
518848a2
MA
317 job->len,
318 job->offset,
319 job->speed, &error_abort);
a66a2a36
PB
320}
321
32c81a4a
PB
322BlockErrorAction block_job_error_action(BlockJob *job, BlockDriverState *bs,
323 BlockdevOnError on_err,
324 int is_read, int error)
325{
326 BlockErrorAction action;
327
328 switch (on_err) {
329 case BLOCKDEV_ON_ERROR_ENOSPC:
a589569f
WX
330 action = (error == ENOSPC) ?
331 BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
32c81a4a
PB
332 break;
333 case BLOCKDEV_ON_ERROR_STOP:
a589569f 334 action = BLOCK_ERROR_ACTION_STOP;
32c81a4a
PB
335 break;
336 case BLOCKDEV_ON_ERROR_REPORT:
a589569f 337 action = BLOCK_ERROR_ACTION_REPORT;
32c81a4a
PB
338 break;
339 case BLOCKDEV_ON_ERROR_IGNORE:
a589569f 340 action = BLOCK_ERROR_ACTION_IGNORE;
32c81a4a
PB
341 break;
342 default:
343 abort();
344 }
8ccb9569 345 qapi_event_send_block_job_error(job->id,
5a2d2cbd
WX
346 is_read ? IO_OPERATION_TYPE_READ :
347 IO_OPERATION_TYPE_WRITE,
348 action, &error_abort);
a589569f 349 if (action == BLOCK_ERROR_ACTION_STOP) {
751ebd76
FZ
350 /* make the pause user visible, which will be resumed from QMP. */
351 job->user_paused = true;
32c81a4a
PB
352 block_job_pause(job);
353 block_job_iostatus_set_err(job, error);
373340b2
HR
354 if (bs->blk && bs != job->bs) {
355 blk_iostatus_set_err(bs->blk, error);
32c81a4a
PB
356 }
357 }
358 return action;
359}
dec7d421
SH
360
361typedef struct {
362 BlockJob *job;
363 QEMUBH *bh;
364 AioContext *aio_context;
365 BlockJobDeferToMainLoopFn *fn;
366 void *opaque;
367} BlockJobDeferToMainLoopData;
368
369static void block_job_defer_to_main_loop_bh(void *opaque)
370{
371 BlockJobDeferToMainLoopData *data = opaque;
372 AioContext *aio_context;
373
374 qemu_bh_delete(data->bh);
375
376 /* Prevent race with block_job_defer_to_main_loop() */
377 aio_context_acquire(data->aio_context);
378
379 /* Fetch BDS AioContext again, in case it has changed */
380 aio_context = bdrv_get_aio_context(data->job->bs);
381 aio_context_acquire(aio_context);
382
383 data->fn(data->job, data->opaque);
384
385 aio_context_release(aio_context);
386
387 aio_context_release(data->aio_context);
388
389 g_free(data);
390}
391
392void block_job_defer_to_main_loop(BlockJob *job,
393 BlockJobDeferToMainLoopFn *fn,
394 void *opaque)
395{
396 BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data));
397 data->job = job;
398 data->bh = qemu_bh_new(block_job_defer_to_main_loop_bh, data);
399 data->aio_context = bdrv_get_aio_context(job->bs);
400 data->fn = fn;
401 data->opaque = opaque;
402
403 qemu_bh_schedule(data->bh);
404}