12f0c9fe6SPaolo Bonzini /* 22f0c9fe6SPaolo Bonzini * QEMU System Emulator block driver 32f0c9fe6SPaolo Bonzini * 42f0c9fe6SPaolo Bonzini * Copyright (c) 2011 IBM Corp. 52f0c9fe6SPaolo Bonzini * Copyright (c) 2012 Red Hat, Inc. 62f0c9fe6SPaolo Bonzini * 72f0c9fe6SPaolo Bonzini * Permission is hereby granted, free of charge, to any person obtaining a copy 82f0c9fe6SPaolo Bonzini * of this software and associated documentation files (the "Software"), to deal 92f0c9fe6SPaolo Bonzini * in the Software without restriction, including without limitation the rights 102f0c9fe6SPaolo Bonzini * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 112f0c9fe6SPaolo Bonzini * copies of the Software, and to permit persons to whom the Software is 122f0c9fe6SPaolo Bonzini * furnished to do so, subject to the following conditions: 132f0c9fe6SPaolo Bonzini * 142f0c9fe6SPaolo Bonzini * The above copyright notice and this permission notice shall be included in 152f0c9fe6SPaolo Bonzini * all copies or substantial portions of the Software. 162f0c9fe6SPaolo Bonzini * 172f0c9fe6SPaolo Bonzini * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 182f0c9fe6SPaolo Bonzini * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 192f0c9fe6SPaolo Bonzini * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 202f0c9fe6SPaolo Bonzini * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 212f0c9fe6SPaolo Bonzini * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 222f0c9fe6SPaolo Bonzini * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 232f0c9fe6SPaolo Bonzini * THE SOFTWARE. 242f0c9fe6SPaolo Bonzini */ 252f0c9fe6SPaolo Bonzini 26d38ea87aSPeter Maydell #include "qemu/osdep.h" 27737e150eSPaolo Bonzini #include "block/block.h" 28c87621eaSJohn Snow #include "block/blockjob_int.h" 29737e150eSPaolo Bonzini #include "block/block_int.h" 30c9de4050SJohn Snow #include "block/trace.h" 31373340b2SMax Reitz #include "sysemu/block-backend.h" 32e688df6bSMarkus Armbruster #include "qapi/error.h" 339af23989SMarkus Armbruster #include "qapi/qapi-events-block-core.h" 34cc7a8ea7SMarkus Armbruster #include "qapi/qmp/qerror.h" 3510817bf0SDaniel P. Berrange #include "qemu/coroutine.h" 36db725815SMarkus Armbruster #include "qemu/main-loop.h" 371de7afc9SPaolo Bonzini #include "qemu/timer.h" 382f0c9fe6SPaolo Bonzini 39e7c1d78bSKevin Wolf static bool is_block_job(Job *job) 40a7112795SAlberto Garcia { 41e7c1d78bSKevin Wolf return job_type(job) == JOB_TYPE_BACKUP || 42e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_COMMIT || 43e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_MIRROR || 44e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_STREAM; 45a7112795SAlberto Garcia } 46e7c1d78bSKevin Wolf 47f41ab73fSEmanuele Giuseppe Esposito BlockJob *block_job_next_locked(BlockJob *bjob) 48e7c1d78bSKevin Wolf { 49e7c1d78bSKevin Wolf Job *job = bjob ? &bjob->job : NULL; 50cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 51e7c1d78bSKevin Wolf 52e7c1d78bSKevin Wolf do { 53f41ab73fSEmanuele Giuseppe Esposito job = job_next_locked(job); 54e7c1d78bSKevin Wolf } while (job && !is_block_job(job)); 55e7c1d78bSKevin Wolf 56e7c1d78bSKevin Wolf return job ? container_of(job, BlockJob, job) : NULL; 57a7112795SAlberto Garcia } 58a7112795SAlberto Garcia 59f41ab73fSEmanuele Giuseppe Esposito BlockJob *block_job_next(BlockJob *bjob) 60ffb1f10cSAlberto Garcia { 61f41ab73fSEmanuele Giuseppe Esposito JOB_LOCK_GUARD(); 62f41ab73fSEmanuele Giuseppe Esposito return block_job_next_locked(bjob); 63f41ab73fSEmanuele Giuseppe Esposito } 64f41ab73fSEmanuele Giuseppe Esposito 65f41ab73fSEmanuele Giuseppe Esposito BlockJob *block_job_get_locked(const char *id) 66f41ab73fSEmanuele Giuseppe Esposito { 67f41ab73fSEmanuele Giuseppe Esposito Job *job = job_get_locked(id); 68cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 69ffb1f10cSAlberto Garcia 70e7c1d78bSKevin Wolf if (job && is_block_job(job)) { 71e7c1d78bSKevin Wolf return container_of(job, BlockJob, job); 72e7c1d78bSKevin Wolf } else { 73ffb1f10cSAlberto Garcia return NULL; 74ffb1f10cSAlberto Garcia } 75e7c1d78bSKevin Wolf } 76ffb1f10cSAlberto Garcia 77f41ab73fSEmanuele Giuseppe Esposito BlockJob *block_job_get(const char *id) 78f41ab73fSEmanuele Giuseppe Esposito { 79f41ab73fSEmanuele Giuseppe Esposito JOB_LOCK_GUARD(); 80f41ab73fSEmanuele Giuseppe Esposito return block_job_get_locked(id); 81f41ab73fSEmanuele Giuseppe Esposito } 82f41ab73fSEmanuele Giuseppe Esposito 8380fa2c75SKevin Wolf void block_job_free(Job *job) 8405b0d8e3SPaolo Bonzini { 8580fa2c75SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 86e2d9faf5SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 8780fa2c75SKevin Wolf 8880fa2c75SKevin Wolf block_job_remove_all_bdrv(bjob); 894951967dSPaolo Bonzini ratelimit_destroy(&bjob->limit); 9080fa2c75SKevin Wolf error_free(bjob->blocker); 9105b0d8e3SPaolo Bonzini } 9205b0d8e3SPaolo Bonzini 93f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c) 94f321dcb5SPaolo Bonzini { 95f321dcb5SPaolo Bonzini BlockJob *job = c->opaque; 96252291eaSKevin Wolf return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); 97f321dcb5SPaolo Bonzini } 98f321dcb5SPaolo Bonzini 99ad90febaSKevin Wolf static void child_job_drained_begin(BdrvChild *c) 100f321dcb5SPaolo Bonzini { 101ad90febaSKevin Wolf BlockJob *job = c->opaque; 102b15de828SKevin Wolf job_pause(&job->job); 103f321dcb5SPaolo Bonzini } 104f321dcb5SPaolo Bonzini 10589bd0305SKevin Wolf static bool child_job_drained_poll(BdrvChild *c) 10689bd0305SKevin Wolf { 10789bd0305SKevin Wolf BlockJob *bjob = c->opaque; 10889bd0305SKevin Wolf Job *job = &bjob->job; 10989bd0305SKevin Wolf const BlockJobDriver *drv = block_job_driver(bjob); 11089bd0305SKevin Wolf 11189bd0305SKevin Wolf /* An inactive or completed job doesn't have any pending requests. Jobs 11289bd0305SKevin Wolf * with !job->busy are either already paused or have a pause point after 11389bd0305SKevin Wolf * being reentered, so no job driver code will run before they pause. */ 114880eeec6SEmanuele Giuseppe Esposito WITH_JOB_LOCK_GUARD() { 115880eeec6SEmanuele Giuseppe Esposito if (!job->busy || job_is_completed_locked(job)) { 11689bd0305SKevin Wolf return false; 11789bd0305SKevin Wolf } 118880eeec6SEmanuele Giuseppe Esposito } 11989bd0305SKevin Wolf 12089bd0305SKevin Wolf /* Otherwise, assume that it isn't fully stopped yet, but allow the job to 12189bd0305SKevin Wolf * override this assumption. */ 12289bd0305SKevin Wolf if (drv->drained_poll) { 12389bd0305SKevin Wolf return drv->drained_poll(bjob); 12489bd0305SKevin Wolf } else { 12589bd0305SKevin Wolf return true; 12689bd0305SKevin Wolf } 12789bd0305SKevin Wolf } 12889bd0305SKevin Wolf 129e037c09cSMax Reitz static void child_job_drained_end(BdrvChild *c, int *drained_end_counter) 130f321dcb5SPaolo Bonzini { 131ad90febaSKevin Wolf BlockJob *job = c->opaque; 132b15de828SKevin Wolf job_resume(&job->job); 133f321dcb5SPaolo Bonzini } 134f321dcb5SPaolo Bonzini 1359ff7f0dfSKevin Wolf static bool child_job_can_set_aio_ctx(BdrvChild *c, AioContext *ctx, 1369ff7f0dfSKevin Wolf GSList **ignore, Error **errp) 1379ff7f0dfSKevin Wolf { 1389ff7f0dfSKevin Wolf BlockJob *job = c->opaque; 1399ff7f0dfSKevin Wolf GSList *l; 1409ff7f0dfSKevin Wolf 1419ff7f0dfSKevin Wolf for (l = job->nodes; l; l = l->next) { 1429ff7f0dfSKevin Wolf BdrvChild *sibling = l->data; 1439ff7f0dfSKevin Wolf if (!bdrv_child_can_set_aio_context(sibling, ctx, ignore, errp)) { 1449ff7f0dfSKevin Wolf return false; 1459ff7f0dfSKevin Wolf } 1469ff7f0dfSKevin Wolf } 1479ff7f0dfSKevin Wolf return true; 1489ff7f0dfSKevin Wolf } 1499ff7f0dfSKevin Wolf 1509ff7f0dfSKevin Wolf static void child_job_set_aio_ctx(BdrvChild *c, AioContext *ctx, 1519ff7f0dfSKevin Wolf GSList **ignore) 1529ff7f0dfSKevin Wolf { 1539ff7f0dfSKevin Wolf BlockJob *job = c->opaque; 1549ff7f0dfSKevin Wolf GSList *l; 1559ff7f0dfSKevin Wolf 1569ff7f0dfSKevin Wolf for (l = job->nodes; l; l = l->next) { 1579ff7f0dfSKevin Wolf BdrvChild *sibling = l->data; 1589ff7f0dfSKevin Wolf if (g_slist_find(*ignore, sibling)) { 1599ff7f0dfSKevin Wolf continue; 1609ff7f0dfSKevin Wolf } 1619ff7f0dfSKevin Wolf *ignore = g_slist_prepend(*ignore, sibling); 1629ff7f0dfSKevin Wolf bdrv_set_aio_context_ignore(sibling->bs, ctx, ignore); 1639ff7f0dfSKevin Wolf } 164657e1203SKevin Wolf 1653ed4f708SEmanuele Giuseppe Esposito job_set_aio_context(&job->job, ctx); 1669ff7f0dfSKevin Wolf } 1679ff7f0dfSKevin Wolf 1683ca1f322SVladimir Sementsov-Ogievskiy static AioContext *child_job_get_parent_aio_context(BdrvChild *c) 1693ca1f322SVladimir Sementsov-Ogievskiy { 1703ca1f322SVladimir Sementsov-Ogievskiy BlockJob *job = c->opaque; 1713ed4f708SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 1723ca1f322SVladimir Sementsov-Ogievskiy 1733ca1f322SVladimir Sementsov-Ogievskiy return job->job.aio_context; 1743ca1f322SVladimir Sementsov-Ogievskiy } 1753ca1f322SVladimir Sementsov-Ogievskiy 176bd86fb99SMax Reitz static const BdrvChildClass child_job = { 177ad90febaSKevin Wolf .get_parent_desc = child_job_get_parent_desc, 178ad90febaSKevin Wolf .drained_begin = child_job_drained_begin, 17989bd0305SKevin Wolf .drained_poll = child_job_drained_poll, 180ad90febaSKevin Wolf .drained_end = child_job_drained_end, 1819ff7f0dfSKevin Wolf .can_set_aio_ctx = child_job_can_set_aio_ctx, 1829ff7f0dfSKevin Wolf .set_aio_ctx = child_job_set_aio_ctx, 183ad90febaSKevin Wolf .stay_at_node = true, 1843ca1f322SVladimir Sementsov-Ogievskiy .get_parent_aio_context = child_job_get_parent_aio_context, 185f321dcb5SPaolo Bonzini }; 186f321dcb5SPaolo Bonzini 187bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job) 188bbc02b90SKevin Wolf { 189cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 190d876bf67SSergio Lopez /* 191d876bf67SSergio Lopez * bdrv_root_unref_child() may reach child_job_[can_]set_aio_ctx(), 192d876bf67SSergio Lopez * which will also traverse job->nodes, so consume the list one by 193d876bf67SSergio Lopez * one to make sure that such a concurrent access does not attempt 194d876bf67SSergio Lopez * to process an already freed BdrvChild. 195d876bf67SSergio Lopez */ 196d876bf67SSergio Lopez while (job->nodes) { 197d876bf67SSergio Lopez GSList *l = job->nodes; 198bbc02b90SKevin Wolf BdrvChild *c = l->data; 199d876bf67SSergio Lopez 200d876bf67SSergio Lopez job->nodes = l->next; 201d876bf67SSergio Lopez 202bbc02b90SKevin Wolf bdrv_op_unblock_all(c->bs, job->blocker); 203bbc02b90SKevin Wolf bdrv_root_unref_child(c); 204d876bf67SSergio Lopez 205d876bf67SSergio Lopez g_slist_free_1(l); 206bbc02b90SKevin Wolf } 207bbc02b90SKevin Wolf } 208bbc02b90SKevin Wolf 2098164102fSVladimir Sementsov-Ogievskiy bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs) 2108164102fSVladimir Sementsov-Ogievskiy { 2118164102fSVladimir Sementsov-Ogievskiy GSList *el; 212cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 2138164102fSVladimir Sementsov-Ogievskiy 2148164102fSVladimir Sementsov-Ogievskiy for (el = job->nodes; el; el = el->next) { 2158164102fSVladimir Sementsov-Ogievskiy BdrvChild *c = el->data; 2168164102fSVladimir Sementsov-Ogievskiy if (c->bs == bs) { 2178164102fSVladimir Sementsov-Ogievskiy return true; 2188164102fSVladimir Sementsov-Ogievskiy } 2198164102fSVladimir Sementsov-Ogievskiy } 2208164102fSVladimir Sementsov-Ogievskiy 2218164102fSVladimir Sementsov-Ogievskiy return false; 2228164102fSVladimir Sementsov-Ogievskiy } 2238164102fSVladimir Sementsov-Ogievskiy 22476d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 22576d554e2SKevin Wolf uint64_t perm, uint64_t shared_perm, Error **errp) 22623d402d4SAlberto Garcia { 22776d554e2SKevin Wolf BdrvChild *c; 228076d467aSMichael Qiu bool need_context_ops; 229cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 23076d554e2SKevin Wolf 231b441dc71SAlberto Garcia bdrv_ref(bs); 232076d467aSMichael Qiu 233076d467aSMichael Qiu need_context_ops = bdrv_get_aio_context(bs) != job->job.aio_context; 234076d467aSMichael Qiu 235076d467aSMichael Qiu if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) { 236132ada80SKevin Wolf aio_context_release(job->job.aio_context); 237132ada80SKevin Wolf } 238228ca37eSVladimir Sementsov-Ogievskiy c = bdrv_root_attach_child(bs, name, &child_job, 0, perm, shared_perm, job, 239258b7765SMax Reitz errp); 240076d467aSMichael Qiu if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) { 241132ada80SKevin Wolf aio_context_acquire(job->job.aio_context); 242132ada80SKevin Wolf } 24376d554e2SKevin Wolf if (c == NULL) { 24476d554e2SKevin Wolf return -EPERM; 24576d554e2SKevin Wolf } 24676d554e2SKevin Wolf 24776d554e2SKevin Wolf job->nodes = g_slist_prepend(job->nodes, c); 24823d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 24976d554e2SKevin Wolf 25076d554e2SKevin Wolf return 0; 25123d402d4SAlberto Garcia } 25223d402d4SAlberto Garcia 253243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 254243c6ec7SEmanuele Giuseppe Esposito static void block_job_on_idle_locked(Notifier *n, void *opaque) 25534dc97b9SKevin Wolf { 256cfe29d82SKevin Wolf aio_wait_kick(); 25734dc97b9SKevin Wolf } 25834dc97b9SKevin Wolf 259559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 260559b935fSJohn Snow { 26133e9e9bdSKevin Wolf return (job->job.id == NULL); 262559b935fSJohn Snow } 263559b935fSJohn Snow 264bd21935bSKevin Wolf const BlockJobDriver *block_job_driver(BlockJob *job) 265bd21935bSKevin Wolf { 2669f6bb4c0SKevin Wolf return container_of(job->job.driver, BlockJobDriver, job_driver); 267bd21935bSKevin Wolf } 268bd21935bSKevin Wolf 269da01ff7fSKevin Wolf /* Assumes the job_mutex is held */ 270da01ff7fSKevin Wolf static bool job_timer_pending(Job *job) 271da01ff7fSKevin Wolf { 272da01ff7fSKevin Wolf return timer_pending(&job->sleep_timer); 273da01ff7fSKevin Wolf } 274da01ff7fSKevin Wolf 275f41ab73fSEmanuele Giuseppe Esposito bool block_job_set_speed_locked(BlockJob *job, int64_t speed, Error **errp) 2762f0c9fe6SPaolo Bonzini { 277e0323a04SVladimir Sementsov-Ogievskiy const BlockJobDriver *drv = block_job_driver(job); 278aa9ef2e6SJohn Snow int64_t old_speed = job->speed; 2792f0c9fe6SPaolo Bonzini 280cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 281cf81ae28SEmanuele Giuseppe Esposito 282f41ab73fSEmanuele Giuseppe Esposito if (job_apply_verb_locked(&job->job, JOB_VERB_SET_SPEED, errp) < 0) { 283775d0c05SVladimir Sementsov-Ogievskiy return false; 2840ec4dfb8SJohn Snow } 28518bb6928SKevin Wolf if (speed < 0) { 2861ef7d9d3SKevin Wolf error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "speed", 2871ef7d9d3SKevin Wolf "a non-negative value"); 288775d0c05SVladimir Sementsov-Ogievskiy return false; 2892f0c9fe6SPaolo Bonzini } 2902f0c9fe6SPaolo Bonzini 29118bb6928SKevin Wolf ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); 29218bb6928SKevin Wolf 2932f0c9fe6SPaolo Bonzini job->speed = speed; 294e0323a04SVladimir Sementsov-Ogievskiy 295e0323a04SVladimir Sementsov-Ogievskiy if (drv->set_speed) { 296f41ab73fSEmanuele Giuseppe Esposito job_unlock(); 297e0323a04SVladimir Sementsov-Ogievskiy drv->set_speed(job, speed); 298f41ab73fSEmanuele Giuseppe Esposito job_lock(); 299e0323a04SVladimir Sementsov-Ogievskiy } 300e0323a04SVladimir Sementsov-Ogievskiy 301d4fce188SJohn Snow if (speed && speed <= old_speed) { 302775d0c05SVladimir Sementsov-Ogievskiy return true; 303aa9ef2e6SJohn Snow } 304aa9ef2e6SJohn Snow 305aa9ef2e6SJohn Snow /* kick only if a timer is pending */ 306f41ab73fSEmanuele Giuseppe Esposito job_enter_cond_locked(&job->job, job_timer_pending); 307775d0c05SVladimir Sementsov-Ogievskiy 308775d0c05SVladimir Sementsov-Ogievskiy return true; 3092f0c9fe6SPaolo Bonzini } 3102f0c9fe6SPaolo Bonzini 311f41ab73fSEmanuele Giuseppe Esposito bool block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 312f41ab73fSEmanuele Giuseppe Esposito { 313f41ab73fSEmanuele Giuseppe Esposito JOB_LOCK_GUARD(); 314f41ab73fSEmanuele Giuseppe Esposito return block_job_set_speed_locked(job, speed, errp); 315f41ab73fSEmanuele Giuseppe Esposito } 316f41ab73fSEmanuele Giuseppe Esposito 317dee81d51SKevin Wolf int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) 318dee81d51SKevin Wolf { 319e2d9faf5SEmanuele Giuseppe Esposito IO_CODE(); 320dee81d51SKevin Wolf return ratelimit_calculate_delay(&job->limit, n); 321dee81d51SKevin Wolf } 322dee81d51SKevin Wolf 323f41ab73fSEmanuele Giuseppe Esposito BlockJobInfo *block_job_query_locked(BlockJob *job, Error **errp) 32430e628b7SPaolo Bonzini { 325559b935fSJohn Snow BlockJobInfo *info; 326a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 327559b935fSJohn Snow 328cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 329cf81ae28SEmanuele Giuseppe Esposito 330559b935fSJohn Snow if (block_job_is_internal(job)) { 331559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 332559b935fSJohn Snow return NULL; 333559b935fSJohn Snow } 334a7b4f8fcSEmanuele Giuseppe Esposito 335a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 336a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 337a7b4f8fcSEmanuele Giuseppe Esposito 338559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 339252291eaSKevin Wolf info->type = g_strdup(job_type_str(&job->job)); 34033e9e9bdSKevin Wolf info->device = g_strdup(job->job.id); 341d73415a3SStefan Hajnoczi info->busy = qatomic_read(&job->job.busy); 342da01ff7fSKevin Wolf info->paused = job->job.pause_count > 0; 343a7b4f8fcSEmanuele Giuseppe Esposito info->offset = progress_current; 344a7b4f8fcSEmanuele Giuseppe Esposito info->len = progress_total; 34530e628b7SPaolo Bonzini info->speed = job->speed; 34632c81a4aSPaolo Bonzini info->io_status = job->iostatus; 347f41ab73fSEmanuele Giuseppe Esposito info->ready = job_is_ready_locked(&job->job), 348a50c2ab8SKevin Wolf info->status = job->job.status; 349bb02b65cSKevin Wolf info->auto_finalize = job->job.auto_finalize; 350bb02b65cSKevin Wolf info->auto_dismiss = job->job.auto_dismiss; 3513b6ad623SStefano Garzarella if (job->job.ret) { 3523b6ad623SStefano Garzarella info->has_error = true; 3533b6ad623SStefano Garzarella info->error = job->job.err ? 3543b6ad623SStefano Garzarella g_strdup(error_get_pretty(job->job.err)) : 3553b6ad623SStefano Garzarella g_strdup(strerror(-job->job.ret)); 3563b6ad623SStefano Garzarella } 35730e628b7SPaolo Bonzini return info; 35830e628b7SPaolo Bonzini } 35932c81a4aSPaolo Bonzini 360f41ab73fSEmanuele Giuseppe Esposito BlockJobInfo *block_job_query(BlockJob *job, Error **errp) 361f41ab73fSEmanuele Giuseppe Esposito { 362f41ab73fSEmanuele Giuseppe Esposito JOB_LOCK_GUARD(); 363f41ab73fSEmanuele Giuseppe Esposito return block_job_query_locked(job, errp); 364f41ab73fSEmanuele Giuseppe Esposito } 365f41ab73fSEmanuele Giuseppe Esposito 366d59cb66dSEmanuele Giuseppe Esposito /* Called with job lock held */ 367d59cb66dSEmanuele Giuseppe Esposito static void block_job_iostatus_set_err_locked(BlockJob *job, int error) 36832c81a4aSPaolo Bonzini { 36932c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 37032c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 37132c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 37232c81a4aSPaolo Bonzini } 37332c81a4aSPaolo Bonzini } 37432c81a4aSPaolo Bonzini 375243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 376243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_cancelled_locked(Notifier *n, void *opaque) 377a66a2a36SPaolo Bonzini { 378139a9f02SKevin Wolf BlockJob *job = opaque; 379a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 380139a9f02SKevin Wolf 381559b935fSJohn Snow if (block_job_is_internal(job)) { 382559b935fSJohn Snow return; 383559b935fSJohn Snow } 384559b935fSJohn Snow 385a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 386a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 387a7b4f8fcSEmanuele Giuseppe Esposito 388252291eaSKevin Wolf qapi_event_send_block_job_cancelled(job_type(&job->job), 38933e9e9bdSKevin Wolf job->job.id, 390a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 391a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 3923ab72385SPeter Xu job->speed); 393a66a2a36SPaolo Bonzini } 394a66a2a36SPaolo Bonzini 395243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 396243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_completed_locked(Notifier *n, void *opaque) 397a66a2a36SPaolo Bonzini { 398139a9f02SKevin Wolf BlockJob *job = opaque; 399139a9f02SKevin Wolf const char *msg = NULL; 400a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 401139a9f02SKevin Wolf 402559b935fSJohn Snow if (block_job_is_internal(job)) { 403559b935fSJohn Snow return; 404559b935fSJohn Snow } 405559b935fSJohn Snow 4064ad35181SKevin Wolf if (job->job.ret < 0) { 4073b6ad623SStefano Garzarella msg = error_get_pretty(job->job.err); 408139a9f02SKevin Wolf } 409139a9f02SKevin Wolf 410a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 411a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 412a7b4f8fcSEmanuele Giuseppe Esposito 413252291eaSKevin Wolf qapi_event_send_block_job_completed(job_type(&job->job), 41433e9e9bdSKevin Wolf job->job.id, 415a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 416a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 417bcada37bSWenchao Xia job->speed, 418bcada37bSWenchao Xia !!msg, 4193ab72385SPeter Xu msg); 420bcada37bSWenchao Xia } 421bcada37bSWenchao Xia 422243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 423243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_pending_locked(Notifier *n, void *opaque) 4245f241594SJohn Snow { 425139a9f02SKevin Wolf BlockJob *job = opaque; 426139a9f02SKevin Wolf 4275d4f3769SKevin Wolf if (block_job_is_internal(job)) { 4285d4f3769SKevin Wolf return; 4295d4f3769SKevin Wolf } 4305d4f3769SKevin Wolf 431252291eaSKevin Wolf qapi_event_send_block_job_pending(job_type(&job->job), 4323ab72385SPeter Xu job->job.id); 4335f241594SJohn Snow } 4345f241594SJohn Snow 435243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 436243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_ready_locked(Notifier *n, void *opaque) 4372e1795b5SKevin Wolf { 4382e1795b5SKevin Wolf BlockJob *job = opaque; 439a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 4402e1795b5SKevin Wolf 4412e1795b5SKevin Wolf if (block_job_is_internal(job)) { 4422e1795b5SKevin Wolf return; 4432e1795b5SKevin Wolf } 4442e1795b5SKevin Wolf 445a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 446a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 447a7b4f8fcSEmanuele Giuseppe Esposito 4482e1795b5SKevin Wolf qapi_event_send_block_job_ready(job_type(&job->job), 4492e1795b5SKevin Wolf job->job.id, 450a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 451a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 4523ab72385SPeter Xu job->speed); 4532e1795b5SKevin Wolf } 4542e1795b5SKevin Wolf 4552e1795b5SKevin Wolf 45688691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver, 45762c9e416SKevin Wolf JobTxn *txn, BlockDriverState *bs, uint64_t perm, 45888691b37SPaolo Bonzini uint64_t shared_perm, int64_t speed, int flags, 45988691b37SPaolo Bonzini BlockCompletionFunc *cb, void *opaque, Error **errp) 46088691b37SPaolo Bonzini { 46188691b37SPaolo Bonzini BlockJob *job; 462985cac8fSVladimir Sementsov-Ogievskiy int ret; 463e2d9faf5SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 46488691b37SPaolo Bonzini 465bb02b65cSKevin Wolf if (job_id == NULL && !(flags & JOB_INTERNAL)) { 46688691b37SPaolo Bonzini job_id = bdrv_get_device_name(bs); 46788691b37SPaolo Bonzini } 46888691b37SPaolo Bonzini 469985cac8fSVladimir Sementsov-Ogievskiy job = job_create(job_id, &driver->job_driver, txn, bdrv_get_aio_context(bs), 4704ad35181SKevin Wolf flags, cb, opaque, errp); 47133e9e9bdSKevin Wolf if (job == NULL) { 47233e9e9bdSKevin Wolf return NULL; 47333e9e9bdSKevin Wolf } 47433e9e9bdSKevin Wolf 475e7c1d78bSKevin Wolf assert(is_block_job(&job->job)); 47680fa2c75SKevin Wolf assert(job->job.driver->free == &block_job_free); 477b15de828SKevin Wolf assert(job->job.driver->user_resume == &block_job_user_resume); 478e7c1d78bSKevin Wolf 4794951967dSPaolo Bonzini ratelimit_init(&job->limit); 4804951967dSPaolo Bonzini 481243c6ec7SEmanuele Giuseppe Esposito job->finalize_cancelled_notifier.notify = block_job_event_cancelled_locked; 482243c6ec7SEmanuele Giuseppe Esposito job->finalize_completed_notifier.notify = block_job_event_completed_locked; 483243c6ec7SEmanuele Giuseppe Esposito job->pending_notifier.notify = block_job_event_pending_locked; 484243c6ec7SEmanuele Giuseppe Esposito job->ready_notifier.notify = block_job_event_ready_locked; 485243c6ec7SEmanuele Giuseppe Esposito job->idle_notifier.notify = block_job_on_idle_locked; 486139a9f02SKevin Wolf 487880eeec6SEmanuele Giuseppe Esposito WITH_JOB_LOCK_GUARD() { 488139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_cancelled, 489139a9f02SKevin Wolf &job->finalize_cancelled_notifier); 490139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_completed, 491139a9f02SKevin Wolf &job->finalize_completed_notifier); 492139a9f02SKevin Wolf notifier_list_add(&job->job.on_pending, &job->pending_notifier); 4932e1795b5SKevin Wolf notifier_list_add(&job->job.on_ready, &job->ready_notifier); 49434dc97b9SKevin Wolf notifier_list_add(&job->job.on_idle, &job->idle_notifier); 495880eeec6SEmanuele Giuseppe Esposito } 496139a9f02SKevin Wolf 49788691b37SPaolo Bonzini error_setg(&job->blocker, "block device is in use by block job: %s", 498252291eaSKevin Wolf job_type_str(&job->job)); 499985cac8fSVladimir Sementsov-Ogievskiy 500985cac8fSVladimir Sementsov-Ogievskiy ret = block_job_add_bdrv(job, "main node", bs, perm, shared_perm, errp); 501985cac8fSVladimir Sementsov-Ogievskiy if (ret < 0) { 502985cac8fSVladimir Sementsov-Ogievskiy goto fail; 503985cac8fSVladimir Sementsov-Ogievskiy } 50488691b37SPaolo Bonzini 50588691b37SPaolo Bonzini bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 50688691b37SPaolo Bonzini 507775d0c05SVladimir Sementsov-Ogievskiy if (!block_job_set_speed(job, speed, errp)) { 508985cac8fSVladimir Sementsov-Ogievskiy goto fail; 50988691b37SPaolo Bonzini } 51075859b94SJohn Snow 51188691b37SPaolo Bonzini return job; 512985cac8fSVladimir Sementsov-Ogievskiy 513985cac8fSVladimir Sementsov-Ogievskiy fail: 514985cac8fSVladimir Sementsov-Ogievskiy job_early_fail(&job->job); 515985cac8fSVladimir Sementsov-Ogievskiy return NULL; 51688691b37SPaolo Bonzini } 51788691b37SPaolo Bonzini 518f41ab73fSEmanuele Giuseppe Esposito void block_job_iostatus_reset_locked(BlockJob *job) 5192caf63a9SPaolo Bonzini { 520cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 5214c241cf5SPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 5224c241cf5SPaolo Bonzini return; 5234c241cf5SPaolo Bonzini } 524b15de828SKevin Wolf assert(job->job.user_paused && job->job.pause_count > 0); 5252caf63a9SPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 5262caf63a9SPaolo Bonzini } 5272caf63a9SPaolo Bonzini 528f41ab73fSEmanuele Giuseppe Esposito void block_job_iostatus_reset(BlockJob *job) 529f41ab73fSEmanuele Giuseppe Esposito { 530f41ab73fSEmanuele Giuseppe Esposito JOB_LOCK_GUARD(); 531f41ab73fSEmanuele Giuseppe Esposito block_job_iostatus_reset_locked(job); 532f41ab73fSEmanuele Giuseppe Esposito } 533f41ab73fSEmanuele Giuseppe Esposito 534b15de828SKevin Wolf void block_job_user_resume(Job *job) 535b15de828SKevin Wolf { 536b15de828SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 537e2d9faf5SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 538b15de828SKevin Wolf block_job_iostatus_reset(bjob); 539b15de828SKevin Wolf } 540b15de828SKevin Wolf 54181e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 54232c81a4aSPaolo Bonzini int is_read, int error) 54332c81a4aSPaolo Bonzini { 54432c81a4aSPaolo Bonzini BlockErrorAction action; 545e2d9faf5SEmanuele Giuseppe Esposito IO_CODE(); 54632c81a4aSPaolo Bonzini 54732c81a4aSPaolo Bonzini switch (on_err) { 54832c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 5498c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 550a589569fSWenchao Xia action = (error == ENOSPC) ? 551a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 55232c81a4aSPaolo Bonzini break; 55332c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 554a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 55532c81a4aSPaolo Bonzini break; 55632c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 557a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 55832c81a4aSPaolo Bonzini break; 55932c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 560a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 56132c81a4aSPaolo Bonzini break; 56232c81a4aSPaolo Bonzini default: 56332c81a4aSPaolo Bonzini abort(); 56432c81a4aSPaolo Bonzini } 565559b935fSJohn Snow if (!block_job_is_internal(job)) { 56633e9e9bdSKevin Wolf qapi_event_send_block_job_error(job->job.id, 5675a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 5685a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 5693ab72385SPeter Xu action); 570559b935fSJohn Snow } 571a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 572880eeec6SEmanuele Giuseppe Esposito WITH_JOB_LOCK_GUARD() { 5738d9648cbSVladimir Sementsov-Ogievskiy if (!job->job.user_paused) { 574880eeec6SEmanuele Giuseppe Esposito job_pause_locked(&job->job); 575880eeec6SEmanuele Giuseppe Esposito /* 576880eeec6SEmanuele Giuseppe Esposito * make the pause user visible, which will be 577880eeec6SEmanuele Giuseppe Esposito * resumed from QMP. 578880eeec6SEmanuele Giuseppe Esposito */ 579b15de828SKevin Wolf job->job.user_paused = true; 5808d9648cbSVladimir Sementsov-Ogievskiy } 581d59cb66dSEmanuele Giuseppe Esposito block_job_iostatus_set_err_locked(job, error); 582880eeec6SEmanuele Giuseppe Esposito } 58332c81a4aSPaolo Bonzini } 58432c81a4aSPaolo Bonzini return action; 58532c81a4aSPaolo Bonzini } 586df9a3165SVladimir Sementsov-Ogievskiy 587df9a3165SVladimir Sementsov-Ogievskiy AioContext *block_job_get_aio_context(BlockJob *job) 588df9a3165SVladimir Sementsov-Ogievskiy { 589cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 590df9a3165SVladimir Sementsov-Ogievskiy return job->job.aio_context; 591df9a3165SVladimir Sementsov-Ogievskiy } 592