]> git.proxmox.com Git - mirror_qemu.git/blame - blockjob.c
tests: wait for migration completion before looking for STOP event
[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
d38ea87a 26#include "qemu/osdep.h"
737e150e 27#include "block/block.h"
c87621ea 28#include "block/blockjob_int.h"
737e150e 29#include "block/block_int.h"
c9de4050 30#include "block/trace.h"
373340b2 31#include "sysemu/block-backend.h"
e688df6b 32#include "qapi/error.h"
9af23989 33#include "qapi/qapi-events-block-core.h"
cc7a8ea7 34#include "qapi/qmp/qerror.h"
10817bf0 35#include "qemu/coroutine.h"
db725815 36#include "qemu/main-loop.h"
1de7afc9 37#include "qemu/timer.h"
2f0c9fe6 38
88691b37
PB
39/*
40 * The block job API is composed of two categories of functions.
41 *
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.
47 *
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
51 * blockjob_int.h.
52 */
53
e7c1d78b 54static bool is_block_job(Job *job)
a7112795 55{
e7c1d78b
KW
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;
60}
61
62BlockJob *block_job_next(BlockJob *bjob)
63{
64 Job *job = bjob ? &bjob->job : NULL;
cf81ae28 65 GLOBAL_STATE_CODE();
e7c1d78b
KW
66
67 do {
68 job = job_next(job);
69 } while (job && !is_block_job(job));
70
71 return job ? container_of(job, BlockJob, job) : NULL;
a7112795
AG
72}
73
ffb1f10c
AG
74BlockJob *block_job_get(const char *id)
75{
e7c1d78b 76 Job *job = job_get(id);
cf81ae28 77 GLOBAL_STATE_CODE();
ffb1f10c 78
e7c1d78b
KW
79 if (job && is_block_job(job)) {
80 return container_of(job, BlockJob, job);
81 } else {
82 return NULL;
ffb1f10c 83 }
ffb1f10c
AG
84}
85
80fa2c75 86void block_job_free(Job *job)
05b0d8e3 87{
80fa2c75 88 BlockJob *bjob = container_of(job, BlockJob, job);
e2d9faf5 89 GLOBAL_STATE_CODE();
80fa2c75 90
80fa2c75 91 block_job_remove_all_bdrv(bjob);
4951967d 92 ratelimit_destroy(&bjob->limit);
80fa2c75 93 error_free(bjob->blocker);
05b0d8e3
PB
94}
95
f321dcb5
PB
96static char *child_job_get_parent_desc(BdrvChild *c)
97{
98 BlockJob *job = c->opaque;
252291ea 99 return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id);
f321dcb5
PB
100}
101
ad90feba 102static void child_job_drained_begin(BdrvChild *c)
f321dcb5 103{
ad90feba 104 BlockJob *job = c->opaque;
b15de828 105 job_pause(&job->job);
f321dcb5
PB
106}
107
89bd0305
KW
108static bool child_job_drained_poll(BdrvChild *c)
109{
110 BlockJob *bjob = c->opaque;
111 Job *job = &bjob->job;
112 const BlockJobDriver *drv = block_job_driver(bjob);
113
114 /* An inactive or completed job doesn't have any pending requests. Jobs
115 * with !job->busy are either already paused or have a pause point after
116 * being reentered, so no job driver code will run before they pause. */
b5a7a057 117 if (!job->busy || job_is_completed(job)) {
89bd0305
KW
118 return false;
119 }
120
121 /* Otherwise, assume that it isn't fully stopped yet, but allow the job to
122 * override this assumption. */
123 if (drv->drained_poll) {
124 return drv->drained_poll(bjob);
125 } else {
126 return true;
127 }
128}
129
e037c09c 130static void child_job_drained_end(BdrvChild *c, int *drained_end_counter)
f321dcb5 131{
ad90feba 132 BlockJob *job = c->opaque;
b15de828 133 job_resume(&job->job);
f321dcb5
PB
134}
135
9ff7f0df
KW
136static bool child_job_can_set_aio_ctx(BdrvChild *c, AioContext *ctx,
137 GSList **ignore, Error **errp)
138{
139 BlockJob *job = c->opaque;
140 GSList *l;
141
142 for (l = job->nodes; l; l = l->next) {
143 BdrvChild *sibling = l->data;
144 if (!bdrv_child_can_set_aio_context(sibling, ctx, ignore, errp)) {
145 return false;
146 }
147 }
148 return true;
149}
150
151static void child_job_set_aio_ctx(BdrvChild *c, AioContext *ctx,
152 GSList **ignore)
153{
154 BlockJob *job = c->opaque;
155 GSList *l;
156
157 for (l = job->nodes; l; l = l->next) {
158 BdrvChild *sibling = l->data;
159 if (g_slist_find(*ignore, sibling)) {
160 continue;
161 }
162 *ignore = g_slist_prepend(*ignore, sibling);
163 bdrv_set_aio_context_ignore(sibling->bs, ctx, ignore);
164 }
657e1203
KW
165
166 job->job.aio_context = ctx;
9ff7f0df
KW
167}
168
3ca1f322
VSO
169static AioContext *child_job_get_parent_aio_context(BdrvChild *c)
170{
171 BlockJob *job = c->opaque;
172
173 return job->job.aio_context;
174}
175
bd86fb99 176static const BdrvChildClass child_job = {
ad90feba
KW
177 .get_parent_desc = child_job_get_parent_desc,
178 .drained_begin = child_job_drained_begin,
89bd0305 179 .drained_poll = child_job_drained_poll,
ad90feba 180 .drained_end = child_job_drained_end,
9ff7f0df
KW
181 .can_set_aio_ctx = child_job_can_set_aio_ctx,
182 .set_aio_ctx = child_job_set_aio_ctx,
ad90feba 183 .stay_at_node = true,
3ca1f322 184 .get_parent_aio_context = child_job_get_parent_aio_context,
f321dcb5
PB
185};
186
bbc02b90
KW
187void block_job_remove_all_bdrv(BlockJob *job)
188{
cf81ae28 189 GLOBAL_STATE_CODE();
d876bf67
SL
190 /*
191 * bdrv_root_unref_child() may reach child_job_[can_]set_aio_ctx(),
192 * which will also traverse job->nodes, so consume the list one by
193 * one to make sure that such a concurrent access does not attempt
194 * to process an already freed BdrvChild.
195 */
196 while (job->nodes) {
197 GSList *l = job->nodes;
bbc02b90 198 BdrvChild *c = l->data;
d876bf67
SL
199
200 job->nodes = l->next;
201
bbc02b90
KW
202 bdrv_op_unblock_all(c->bs, job->blocker);
203 bdrv_root_unref_child(c);
d876bf67
SL
204
205 g_slist_free_1(l);
bbc02b90 206 }
bbc02b90
KW
207}
208
8164102f
VSO
209bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs)
210{
211 GSList *el;
cf81ae28 212 GLOBAL_STATE_CODE();
8164102f
VSO
213
214 for (el = job->nodes; el; el = el->next) {
215 BdrvChild *c = el->data;
216 if (c->bs == bs) {
217 return true;
218 }
219 }
220
221 return false;
222}
223
76d554e2
KW
224int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs,
225 uint64_t perm, uint64_t shared_perm, Error **errp)
23d402d4 226{
76d554e2 227 BdrvChild *c;
076d467a 228 bool need_context_ops;
cf81ae28 229 GLOBAL_STATE_CODE();
76d554e2 230
b441dc71 231 bdrv_ref(bs);
076d467a
MQ
232
233 need_context_ops = bdrv_get_aio_context(bs) != job->job.aio_context;
234
235 if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) {
132ada80
KW
236 aio_context_release(job->job.aio_context);
237 }
228ca37e 238 c = bdrv_root_attach_child(bs, name, &child_job, 0, perm, shared_perm, job,
258b7765 239 errp);
076d467a 240 if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) {
132ada80
KW
241 aio_context_acquire(job->job.aio_context);
242 }
76d554e2
KW
243 if (c == NULL) {
244 return -EPERM;
245 }
246
247 job->nodes = g_slist_prepend(job->nodes, c);
23d402d4 248 bdrv_op_block_all(bs, job->blocker);
76d554e2
KW
249
250 return 0;
23d402d4
AG
251}
252
34dc97b9
KW
253static void block_job_on_idle(Notifier *n, void *opaque)
254{
cfe29d82 255 aio_wait_kick();
34dc97b9
KW
256}
257
559b935f
JS
258bool block_job_is_internal(BlockJob *job)
259{
33e9e9bd 260 return (job->job.id == NULL);
559b935f
JS
261}
262
bd21935b
KW
263const BlockJobDriver *block_job_driver(BlockJob *job)
264{
9f6bb4c0 265 return container_of(job->job.driver, BlockJobDriver, job_driver);
bd21935b
KW
266}
267
da01ff7f
KW
268/* Assumes the job_mutex is held */
269static bool job_timer_pending(Job *job)
270{
271 return timer_pending(&job->sleep_timer);
272}
273
775d0c05 274bool block_job_set_speed(BlockJob *job, int64_t speed, Error **errp)
2f0c9fe6 275{
e0323a04 276 const BlockJobDriver *drv = block_job_driver(job);
aa9ef2e6 277 int64_t old_speed = job->speed;
2f0c9fe6 278
cf81ae28
EGE
279 GLOBAL_STATE_CODE();
280
775d0c05
VSO
281 if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp) < 0) {
282 return false;
0ec4dfb8 283 }
18bb6928 284 if (speed < 0) {
1ef7d9d3
KW
285 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "speed",
286 "a non-negative value");
775d0c05 287 return false;
2f0c9fe6
PB
288 }
289
18bb6928
KW
290 ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME);
291
2f0c9fe6 292 job->speed = speed;
e0323a04
VSO
293
294 if (drv->set_speed) {
295 drv->set_speed(job, speed);
296 }
297
d4fce188 298 if (speed && speed <= old_speed) {
775d0c05 299 return true;
aa9ef2e6
JS
300 }
301
302 /* kick only if a timer is pending */
da01ff7f 303 job_enter_cond(&job->job, job_timer_pending);
775d0c05
VSO
304
305 return true;
2f0c9fe6
PB
306}
307
dee81d51
KW
308int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n)
309{
e2d9faf5 310 IO_CODE();
dee81d51
KW
311 return ratelimit_calculate_delay(&job->limit, n);
312}
313
559b935f 314BlockJobInfo *block_job_query(BlockJob *job, Error **errp)
30e628b7 315{
559b935f 316 BlockJobInfo *info;
a7b4f8fc 317 uint64_t progress_current, progress_total;
559b935f 318
cf81ae28
EGE
319 GLOBAL_STATE_CODE();
320
559b935f
JS
321 if (block_job_is_internal(job)) {
322 error_setg(errp, "Cannot query QEMU internal jobs");
323 return NULL;
324 }
a7b4f8fc
EGE
325
326 progress_get_snapshot(&job->job.progress, &progress_current,
327 &progress_total);
328
559b935f 329 info = g_new0(BlockJobInfo, 1);
252291ea 330 info->type = g_strdup(job_type_str(&job->job));
33e9e9bd 331 info->device = g_strdup(job->job.id);
d73415a3 332 info->busy = qatomic_read(&job->job.busy);
da01ff7f 333 info->paused = job->job.pause_count > 0;
a7b4f8fc
EGE
334 info->offset = progress_current;
335 info->len = progress_total;
32c81a4a
PB
336 info->speed = job->speed;
337 info->io_status = job->iostatus;
df956ae2 338 info->ready = job_is_ready(&job->job),
a50c2ab8 339 info->status = job->job.status;
bb02b65c
KW
340 info->auto_finalize = job->job.auto_finalize;
341 info->auto_dismiss = job->job.auto_dismiss;
3b6ad623
SG
342 if (job->job.ret) {
343 info->has_error = true;
344 info->error = job->job.err ?
345 g_strdup(error_get_pretty(job->job.err)) :
346 g_strdup(strerror(-job->job.ret));
347 }
30e628b7
PB
348 return info;
349}
32c81a4a
PB
350
351static void block_job_iostatus_set_err(BlockJob *job, int error)
352{
353 if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
354 job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
355 BLOCK_DEVICE_IO_STATUS_FAILED;
356 }
357}
358
139a9f02 359static void block_job_event_cancelled(Notifier *n, void *opaque)
bcada37b 360{
139a9f02 361 BlockJob *job = opaque;
a7b4f8fc 362 uint64_t progress_current, progress_total;
139a9f02 363
559b935f
JS
364 if (block_job_is_internal(job)) {
365 return;
366 }
367
a7b4f8fc
EGE
368 progress_get_snapshot(&job->job.progress, &progress_current,
369 &progress_total);
370
252291ea 371 qapi_event_send_block_job_cancelled(job_type(&job->job),
33e9e9bd 372 job->job.id,
a7b4f8fc
EGE
373 progress_total,
374 progress_current,
3ab72385 375 job->speed);
bcada37b 376}
32c81a4a 377
139a9f02 378static void block_job_event_completed(Notifier *n, void *opaque)
a66a2a36 379{
139a9f02
KW
380 BlockJob *job = opaque;
381 const char *msg = NULL;
a7b4f8fc 382 uint64_t progress_current, progress_total;
139a9f02 383
559b935f
JS
384 if (block_job_is_internal(job)) {
385 return;
386 }
387
4ad35181 388 if (job->job.ret < 0) {
3b6ad623 389 msg = error_get_pretty(job->job.err);
139a9f02
KW
390 }
391
a7b4f8fc
EGE
392 progress_get_snapshot(&job->job.progress, &progress_current,
393 &progress_total);
394
252291ea 395 qapi_event_send_block_job_completed(job_type(&job->job),
33e9e9bd 396 job->job.id,
a7b4f8fc
EGE
397 progress_total,
398 progress_current,
bcada37b
WX
399 job->speed,
400 !!msg,
3ab72385 401 msg);
a66a2a36
PB
402}
403
139a9f02 404static void block_job_event_pending(Notifier *n, void *opaque)
5f241594 405{
139a9f02
KW
406 BlockJob *job = opaque;
407
5d4f3769
KW
408 if (block_job_is_internal(job)) {
409 return;
5f241594 410 }
5d4f3769
KW
411
412 qapi_event_send_block_job_pending(job_type(&job->job),
3ab72385 413 job->job.id);
5f241594
JS
414}
415
2e1795b5
KW
416static void block_job_event_ready(Notifier *n, void *opaque)
417{
418 BlockJob *job = opaque;
a7b4f8fc 419 uint64_t progress_current, progress_total;
2e1795b5
KW
420
421 if (block_job_is_internal(job)) {
422 return;
423 }
424
a7b4f8fc
EGE
425 progress_get_snapshot(&job->job.progress, &progress_current,
426 &progress_total);
427
2e1795b5
KW
428 qapi_event_send_block_job_ready(job_type(&job->job),
429 job->job.id,
a7b4f8fc
EGE
430 progress_total,
431 progress_current,
3ab72385 432 job->speed);
2e1795b5
KW
433}
434
435
88691b37
PB
436/*
437 * API for block job drivers and the block layer. These functions are
438 * declared in blockjob_int.h.
439 */
440
441void *block_job_create(const char *job_id, const BlockJobDriver *driver,
62c9e416 442 JobTxn *txn, BlockDriverState *bs, uint64_t perm,
88691b37
PB
443 uint64_t shared_perm, int64_t speed, int flags,
444 BlockCompletionFunc *cb, void *opaque, Error **errp)
445{
88691b37 446 BlockJob *job;
985cac8f 447 int ret;
e2d9faf5 448 GLOBAL_STATE_CODE();
88691b37 449
bb02b65c 450 if (job_id == NULL && !(flags & JOB_INTERNAL)) {
88691b37 451 job_id = bdrv_get_device_name(bs);
88691b37
PB
452 }
453
985cac8f 454 job = job_create(job_id, &driver->job_driver, txn, bdrv_get_aio_context(bs),
4ad35181 455 flags, cb, opaque, errp);
33e9e9bd 456 if (job == NULL) {
33e9e9bd
KW
457 return NULL;
458 }
459
e7c1d78b 460 assert(is_block_job(&job->job));
80fa2c75 461 assert(job->job.driver->free == &block_job_free);
b15de828 462 assert(job->job.driver->user_resume == &block_job_user_resume);
e7c1d78b 463
4951967d
PB
464 ratelimit_init(&job->limit);
465
139a9f02
KW
466 job->finalize_cancelled_notifier.notify = block_job_event_cancelled;
467 job->finalize_completed_notifier.notify = block_job_event_completed;
468 job->pending_notifier.notify = block_job_event_pending;
2e1795b5 469 job->ready_notifier.notify = block_job_event_ready;
34dc97b9 470 job->idle_notifier.notify = block_job_on_idle;
139a9f02
KW
471
472 notifier_list_add(&job->job.on_finalize_cancelled,
473 &job->finalize_cancelled_notifier);
474 notifier_list_add(&job->job.on_finalize_completed,
475 &job->finalize_completed_notifier);
476 notifier_list_add(&job->job.on_pending, &job->pending_notifier);
2e1795b5 477 notifier_list_add(&job->job.on_ready, &job->ready_notifier);
34dc97b9 478 notifier_list_add(&job->job.on_idle, &job->idle_notifier);
139a9f02 479
88691b37 480 error_setg(&job->blocker, "block device is in use by block job: %s",
252291ea 481 job_type_str(&job->job));
88691b37 482
985cac8f
VSO
483 ret = block_job_add_bdrv(job, "main node", bs, perm, shared_perm, errp);
484 if (ret < 0) {
485 goto fail;
486 }
88691b37 487
985cac8f 488 bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker);
88691b37 489
c02b83ed 490 if (!block_job_set_speed(job, speed, errp)) {
985cac8f 491 goto fail;
88691b37 492 }
75859b94 493
88691b37 494 return job;
985cac8f
VSO
495
496fail:
497 job_early_fail(&job->job);
498 return NULL;
88691b37
PB
499}
500
2caf63a9
PB
501void block_job_iostatus_reset(BlockJob *job)
502{
cf81ae28 503 GLOBAL_STATE_CODE();
4c241cf5
PB
504 if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
505 return;
506 }
b15de828 507 assert(job->job.user_paused && job->job.pause_count > 0);
2caf63a9
PB
508 job->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
509}
510
b15de828
KW
511void block_job_user_resume(Job *job)
512{
513 BlockJob *bjob = container_of(job, BlockJob, job);
e2d9faf5 514 GLOBAL_STATE_CODE();
b15de828
KW
515 block_job_iostatus_reset(bjob);
516}
517
81e254dc 518BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err,
32c81a4a
PB
519 int is_read, int error)
520{
521 BlockErrorAction action;
e2d9faf5 522 IO_CODE();
32c81a4a
PB
523
524 switch (on_err) {
525 case BLOCKDEV_ON_ERROR_ENOSPC:
8c398252 526 case BLOCKDEV_ON_ERROR_AUTO:
a589569f
WX
527 action = (error == ENOSPC) ?
528 BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
32c81a4a
PB
529 break;
530 case BLOCKDEV_ON_ERROR_STOP:
a589569f 531 action = BLOCK_ERROR_ACTION_STOP;
32c81a4a
PB
532 break;
533 case BLOCKDEV_ON_ERROR_REPORT:
a589569f 534 action = BLOCK_ERROR_ACTION_REPORT;
32c81a4a
PB
535 break;
536 case BLOCKDEV_ON_ERROR_IGNORE:
a589569f 537 action = BLOCK_ERROR_ACTION_IGNORE;
32c81a4a
PB
538 break;
539 default:
540 abort();
541 }
559b935f 542 if (!block_job_is_internal(job)) {
33e9e9bd 543 qapi_event_send_block_job_error(job->job.id,
559b935f
JS
544 is_read ? IO_OPERATION_TYPE_READ :
545 IO_OPERATION_TYPE_WRITE,
3ab72385 546 action);
559b935f 547 }
a589569f 548 if (action == BLOCK_ERROR_ACTION_STOP) {
8d9648cb
VSO
549 if (!job->job.user_paused) {
550 job_pause(&job->job);
551 /* make the pause user visible, which will be resumed from QMP. */
552 job->job.user_paused = true;
553 }
32c81a4a 554 block_job_iostatus_set_err(job, error);
32c81a4a
PB
555 }
556 return action;
557}
df9a3165
VSO
558
559AioContext *block_job_get_aio_context(BlockJob *job)
560{
cf81ae28 561 GLOBAL_STATE_CODE();
df9a3165
VSO
562 return job->job.aio_context;
563}