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" 27e2c1c34fSMarkus Armbruster #include "block/aio-wait.h" 28737e150eSPaolo Bonzini #include "block/block.h" 29c87621eaSJohn Snow #include "block/blockjob_int.h" 30737e150eSPaolo Bonzini #include "block/block_int.h" 31c9de4050SJohn Snow #include "block/trace.h" 32373340b2SMax Reitz #include "sysemu/block-backend.h" 33e688df6bSMarkus Armbruster #include "qapi/error.h" 349af23989SMarkus Armbruster #include "qapi/qapi-events-block-core.h" 35cc7a8ea7SMarkus Armbruster #include "qapi/qmp/qerror.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_get_locked(const char *id) 60f41ab73fSEmanuele Giuseppe Esposito { 61f41ab73fSEmanuele Giuseppe Esposito Job *job = job_get_locked(id); 62cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 63ffb1f10cSAlberto Garcia 64e7c1d78bSKevin Wolf if (job && is_block_job(job)) { 65e7c1d78bSKevin Wolf return container_of(job, BlockJob, job); 66e7c1d78bSKevin Wolf } else { 67ffb1f10cSAlberto Garcia return NULL; 68ffb1f10cSAlberto Garcia } 69e7c1d78bSKevin Wolf } 70ffb1f10cSAlberto Garcia 71f41ab73fSEmanuele Giuseppe Esposito BlockJob *block_job_get(const char *id) 72f41ab73fSEmanuele Giuseppe Esposito { 73f41ab73fSEmanuele Giuseppe Esposito JOB_LOCK_GUARD(); 74f41ab73fSEmanuele Giuseppe Esposito return block_job_get_locked(id); 75f41ab73fSEmanuele Giuseppe Esposito } 76f41ab73fSEmanuele Giuseppe Esposito 7780fa2c75SKevin Wolf void block_job_free(Job *job) 7805b0d8e3SPaolo Bonzini { 7980fa2c75SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 80e2d9faf5SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 8180fa2c75SKevin Wolf 8280fa2c75SKevin Wolf block_job_remove_all_bdrv(bjob); 834951967dSPaolo Bonzini ratelimit_destroy(&bjob->limit); 8480fa2c75SKevin Wolf error_free(bjob->blocker); 8505b0d8e3SPaolo Bonzini } 8605b0d8e3SPaolo Bonzini 87f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c) 88f321dcb5SPaolo Bonzini { 89f321dcb5SPaolo Bonzini BlockJob *job = c->opaque; 90252291eaSKevin Wolf return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); 91f321dcb5SPaolo Bonzini } 92f321dcb5SPaolo Bonzini 93ad90febaSKevin Wolf static void child_job_drained_begin(BdrvChild *c) 94f321dcb5SPaolo Bonzini { 95ad90febaSKevin Wolf BlockJob *job = c->opaque; 96b15de828SKevin Wolf job_pause(&job->job); 97f321dcb5SPaolo Bonzini } 98f321dcb5SPaolo Bonzini 9989bd0305SKevin Wolf static bool child_job_drained_poll(BdrvChild *c) 10089bd0305SKevin Wolf { 10189bd0305SKevin Wolf BlockJob *bjob = c->opaque; 10289bd0305SKevin Wolf Job *job = &bjob->job; 10389bd0305SKevin Wolf const BlockJobDriver *drv = block_job_driver(bjob); 10489bd0305SKevin Wolf 10589bd0305SKevin Wolf /* An inactive or completed job doesn't have any pending requests. Jobs 10689bd0305SKevin Wolf * with !job->busy are either already paused or have a pause point after 10789bd0305SKevin Wolf * being reentered, so no job driver code will run before they pause. */ 108880eeec6SEmanuele Giuseppe Esposito WITH_JOB_LOCK_GUARD() { 109880eeec6SEmanuele Giuseppe Esposito if (!job->busy || job_is_completed_locked(job)) { 11089bd0305SKevin Wolf return false; 11189bd0305SKevin Wolf } 112880eeec6SEmanuele Giuseppe Esposito } 11389bd0305SKevin Wolf 11489bd0305SKevin Wolf /* Otherwise, assume that it isn't fully stopped yet, but allow the job to 11589bd0305SKevin Wolf * override this assumption. */ 11689bd0305SKevin Wolf if (drv->drained_poll) { 11789bd0305SKevin Wolf return drv->drained_poll(bjob); 11889bd0305SKevin Wolf } else { 11989bd0305SKevin Wolf return true; 12089bd0305SKevin Wolf } 12189bd0305SKevin Wolf } 12289bd0305SKevin Wolf 1232f65df6eSKevin Wolf static void child_job_drained_end(BdrvChild *c) 124f321dcb5SPaolo Bonzini { 125ad90febaSKevin Wolf BlockJob *job = c->opaque; 126b15de828SKevin Wolf job_resume(&job->job); 127f321dcb5SPaolo Bonzini } 128f321dcb5SPaolo Bonzini 1293428b100SEmanuele Giuseppe Esposito typedef struct BdrvStateChildJobContext { 1303428b100SEmanuele Giuseppe Esposito AioContext *new_ctx; 1313428b100SEmanuele Giuseppe Esposito BlockJob *job; 1323428b100SEmanuele Giuseppe Esposito } BdrvStateChildJobContext; 1333428b100SEmanuele Giuseppe Esposito 1343428b100SEmanuele Giuseppe Esposito static void child_job_set_aio_ctx_commit(void *opaque) 1353428b100SEmanuele Giuseppe Esposito { 1363428b100SEmanuele Giuseppe Esposito BdrvStateChildJobContext *s = opaque; 1373428b100SEmanuele Giuseppe Esposito BlockJob *job = s->job; 1383428b100SEmanuele Giuseppe Esposito 1393428b100SEmanuele Giuseppe Esposito job_set_aio_context(&job->job, s->new_ctx); 1403428b100SEmanuele Giuseppe Esposito } 1413428b100SEmanuele Giuseppe Esposito 1423428b100SEmanuele Giuseppe Esposito static TransactionActionDrv change_child_job_context = { 1433428b100SEmanuele Giuseppe Esposito .commit = child_job_set_aio_ctx_commit, 1443428b100SEmanuele Giuseppe Esposito .clean = g_free, 1453428b100SEmanuele Giuseppe Esposito }; 1463428b100SEmanuele Giuseppe Esposito 1473428b100SEmanuele Giuseppe Esposito static bool child_job_change_aio_ctx(BdrvChild *c, AioContext *ctx, 1483428b100SEmanuele Giuseppe Esposito GHashTable *visited, Transaction *tran, 1493428b100SEmanuele Giuseppe Esposito Error **errp) 1503428b100SEmanuele Giuseppe Esposito { 1513428b100SEmanuele Giuseppe Esposito BlockJob *job = c->opaque; 1523428b100SEmanuele Giuseppe Esposito BdrvStateChildJobContext *s; 1533428b100SEmanuele Giuseppe Esposito GSList *l; 1543428b100SEmanuele Giuseppe Esposito 1553428b100SEmanuele Giuseppe Esposito for (l = job->nodes; l; l = l->next) { 1563428b100SEmanuele Giuseppe Esposito BdrvChild *sibling = l->data; 1573428b100SEmanuele Giuseppe Esposito if (!bdrv_child_change_aio_context(sibling, ctx, visited, 1583428b100SEmanuele Giuseppe Esposito tran, errp)) { 1593428b100SEmanuele Giuseppe Esposito return false; 1603428b100SEmanuele Giuseppe Esposito } 1613428b100SEmanuele Giuseppe Esposito } 1623428b100SEmanuele Giuseppe Esposito 1633428b100SEmanuele Giuseppe Esposito s = g_new(BdrvStateChildJobContext, 1); 1643428b100SEmanuele Giuseppe Esposito *s = (BdrvStateChildJobContext) { 1653428b100SEmanuele Giuseppe Esposito .new_ctx = ctx, 1663428b100SEmanuele Giuseppe Esposito .job = job, 1673428b100SEmanuele Giuseppe Esposito }; 1683428b100SEmanuele Giuseppe Esposito 1693428b100SEmanuele Giuseppe Esposito tran_add(tran, &change_child_job_context, s); 1703428b100SEmanuele Giuseppe Esposito return true; 1713428b100SEmanuele Giuseppe Esposito } 1723428b100SEmanuele Giuseppe Esposito 1733ca1f322SVladimir Sementsov-Ogievskiy static AioContext *child_job_get_parent_aio_context(BdrvChild *c) 1743ca1f322SVladimir Sementsov-Ogievskiy { 1753ca1f322SVladimir Sementsov-Ogievskiy BlockJob *job = c->opaque; 176d5f8d79cSHanna Reitz IO_CODE(); 177d5f8d79cSHanna Reitz JOB_LOCK_GUARD(); 1783ca1f322SVladimir Sementsov-Ogievskiy 1793ca1f322SVladimir Sementsov-Ogievskiy return job->job.aio_context; 1803ca1f322SVladimir Sementsov-Ogievskiy } 1813ca1f322SVladimir Sementsov-Ogievskiy 182bd86fb99SMax Reitz static const BdrvChildClass child_job = { 183ad90febaSKevin Wolf .get_parent_desc = child_job_get_parent_desc, 184ad90febaSKevin Wolf .drained_begin = child_job_drained_begin, 18589bd0305SKevin Wolf .drained_poll = child_job_drained_poll, 186ad90febaSKevin Wolf .drained_end = child_job_drained_end, 1873428b100SEmanuele Giuseppe Esposito .change_aio_ctx = child_job_change_aio_ctx, 188ad90febaSKevin Wolf .stay_at_node = true, 1893ca1f322SVladimir Sementsov-Ogievskiy .get_parent_aio_context = child_job_get_parent_aio_context, 190f321dcb5SPaolo Bonzini }; 191f321dcb5SPaolo Bonzini 192bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job) 193bbc02b90SKevin Wolf { 194cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 195d876bf67SSergio Lopez /* 196d876bf67SSergio Lopez * bdrv_root_unref_child() may reach child_job_[can_]set_aio_ctx(), 197d876bf67SSergio Lopez * which will also traverse job->nodes, so consume the list one by 198d876bf67SSergio Lopez * one to make sure that such a concurrent access does not attempt 199d876bf67SSergio Lopez * to process an already freed BdrvChild. 200d876bf67SSergio Lopez */ 20167446e60SFiona Ebner aio_context_release(job->job.aio_context); 202*6bc30f19SStefan Hajnoczi bdrv_graph_wrlock(); 20367446e60SFiona Ebner aio_context_acquire(job->job.aio_context); 204d876bf67SSergio Lopez while (job->nodes) { 205d876bf67SSergio Lopez GSList *l = job->nodes; 206bbc02b90SKevin Wolf BdrvChild *c = l->data; 207d876bf67SSergio Lopez 208d876bf67SSergio Lopez job->nodes = l->next; 209d876bf67SSergio Lopez 210bbc02b90SKevin Wolf bdrv_op_unblock_all(c->bs, job->blocker); 211bbc02b90SKevin Wolf bdrv_root_unref_child(c); 212d876bf67SSergio Lopez 213d876bf67SSergio Lopez g_slist_free_1(l); 214bbc02b90SKevin Wolf } 215*6bc30f19SStefan Hajnoczi bdrv_graph_wrunlock(); 216bbc02b90SKevin Wolf } 217bbc02b90SKevin Wolf 2188164102fSVladimir Sementsov-Ogievskiy bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs) 2198164102fSVladimir Sementsov-Ogievskiy { 2208164102fSVladimir Sementsov-Ogievskiy GSList *el; 221cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 2228164102fSVladimir Sementsov-Ogievskiy 2238164102fSVladimir Sementsov-Ogievskiy for (el = job->nodes; el; el = el->next) { 2248164102fSVladimir Sementsov-Ogievskiy BdrvChild *c = el->data; 2258164102fSVladimir Sementsov-Ogievskiy if (c->bs == bs) { 2268164102fSVladimir Sementsov-Ogievskiy return true; 2278164102fSVladimir Sementsov-Ogievskiy } 2288164102fSVladimir Sementsov-Ogievskiy } 2298164102fSVladimir Sementsov-Ogievskiy 2308164102fSVladimir Sementsov-Ogievskiy return false; 2318164102fSVladimir Sementsov-Ogievskiy } 2328164102fSVladimir Sementsov-Ogievskiy 23376d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 23476d554e2SKevin Wolf uint64_t perm, uint64_t shared_perm, Error **errp) 23523d402d4SAlberto Garcia { 23676d554e2SKevin Wolf BdrvChild *c; 23722dd9405SKevin Wolf AioContext *ctx = bdrv_get_aio_context(bs); 238076d467aSMichael Qiu bool need_context_ops; 239cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 24076d554e2SKevin Wolf 241b441dc71SAlberto Garcia bdrv_ref(bs); 242076d467aSMichael Qiu 24322dd9405SKevin Wolf need_context_ops = ctx != job->job.aio_context; 244076d467aSMichael Qiu 24522dd9405SKevin Wolf if (need_context_ops) { 24622dd9405SKevin Wolf if (job->job.aio_context != qemu_get_aio_context()) { 247132ada80SKevin Wolf aio_context_release(job->job.aio_context); 248132ada80SKevin Wolf } 24922dd9405SKevin Wolf aio_context_acquire(ctx); 25022dd9405SKevin Wolf } 251228ca37eSVladimir Sementsov-Ogievskiy c = bdrv_root_attach_child(bs, name, &child_job, 0, perm, shared_perm, job, 252258b7765SMax Reitz errp); 25322dd9405SKevin Wolf if (need_context_ops) { 25422dd9405SKevin Wolf aio_context_release(ctx); 25522dd9405SKevin Wolf if (job->job.aio_context != qemu_get_aio_context()) { 256132ada80SKevin Wolf aio_context_acquire(job->job.aio_context); 257132ada80SKevin Wolf } 25822dd9405SKevin Wolf } 25976d554e2SKevin Wolf if (c == NULL) { 26076d554e2SKevin Wolf return -EPERM; 26176d554e2SKevin Wolf } 26276d554e2SKevin Wolf 26376d554e2SKevin Wolf job->nodes = g_slist_prepend(job->nodes, c); 26423d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 26576d554e2SKevin Wolf 26676d554e2SKevin Wolf return 0; 26723d402d4SAlberto Garcia } 26823d402d4SAlberto Garcia 269243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 270243c6ec7SEmanuele Giuseppe Esposito static void block_job_on_idle_locked(Notifier *n, void *opaque) 27134dc97b9SKevin Wolf { 272cfe29d82SKevin Wolf aio_wait_kick(); 27334dc97b9SKevin Wolf } 27434dc97b9SKevin Wolf 275559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 276559b935fSJohn Snow { 27733e9e9bdSKevin Wolf return (job->job.id == NULL); 278559b935fSJohn Snow } 279559b935fSJohn Snow 280bd21935bSKevin Wolf const BlockJobDriver *block_job_driver(BlockJob *job) 281bd21935bSKevin Wolf { 2829f6bb4c0SKevin Wolf return container_of(job->job.driver, BlockJobDriver, job_driver); 283bd21935bSKevin Wolf } 284bd21935bSKevin Wolf 285da01ff7fSKevin Wolf /* Assumes the job_mutex is held */ 286da01ff7fSKevin Wolf static bool job_timer_pending(Job *job) 287da01ff7fSKevin Wolf { 288da01ff7fSKevin Wolf return timer_pending(&job->sleep_timer); 289da01ff7fSKevin Wolf } 290da01ff7fSKevin Wolf 291f41ab73fSEmanuele Giuseppe Esposito bool block_job_set_speed_locked(BlockJob *job, int64_t speed, Error **errp) 2922f0c9fe6SPaolo Bonzini { 293e0323a04SVladimir Sementsov-Ogievskiy const BlockJobDriver *drv = block_job_driver(job); 294aa9ef2e6SJohn Snow int64_t old_speed = job->speed; 2952f0c9fe6SPaolo Bonzini 296cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 297cf81ae28SEmanuele Giuseppe Esposito 298f41ab73fSEmanuele Giuseppe Esposito if (job_apply_verb_locked(&job->job, JOB_VERB_SET_SPEED, errp) < 0) { 299775d0c05SVladimir Sementsov-Ogievskiy return false; 3000ec4dfb8SJohn Snow } 30118bb6928SKevin Wolf if (speed < 0) { 3021ef7d9d3SKevin Wolf error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "speed", 3031ef7d9d3SKevin Wolf "a non-negative value"); 304775d0c05SVladimir Sementsov-Ogievskiy return false; 3052f0c9fe6SPaolo Bonzini } 3062f0c9fe6SPaolo Bonzini 30718bb6928SKevin Wolf ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); 30818bb6928SKevin Wolf 3092f0c9fe6SPaolo Bonzini job->speed = speed; 310e0323a04SVladimir Sementsov-Ogievskiy 311e0323a04SVladimir Sementsov-Ogievskiy if (drv->set_speed) { 312f41ab73fSEmanuele Giuseppe Esposito job_unlock(); 313e0323a04SVladimir Sementsov-Ogievskiy drv->set_speed(job, speed); 314f41ab73fSEmanuele Giuseppe Esposito job_lock(); 315e0323a04SVladimir Sementsov-Ogievskiy } 316e0323a04SVladimir Sementsov-Ogievskiy 317d4fce188SJohn Snow if (speed && speed <= old_speed) { 318775d0c05SVladimir Sementsov-Ogievskiy return true; 319aa9ef2e6SJohn Snow } 320aa9ef2e6SJohn Snow 321aa9ef2e6SJohn Snow /* kick only if a timer is pending */ 322f41ab73fSEmanuele Giuseppe Esposito job_enter_cond_locked(&job->job, job_timer_pending); 323775d0c05SVladimir Sementsov-Ogievskiy 324775d0c05SVladimir Sementsov-Ogievskiy return true; 3252f0c9fe6SPaolo Bonzini } 3262f0c9fe6SPaolo Bonzini 327ba6a9100SEmanuele Giuseppe Esposito static bool block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 328f41ab73fSEmanuele Giuseppe Esposito { 329f41ab73fSEmanuele Giuseppe Esposito JOB_LOCK_GUARD(); 330f41ab73fSEmanuele Giuseppe Esposito return block_job_set_speed_locked(job, speed, errp); 331f41ab73fSEmanuele Giuseppe Esposito } 332f41ab73fSEmanuele Giuseppe Esposito 33361a3a5a7SFiona Ebner void block_job_change_locked(BlockJob *job, BlockJobChangeOptions *opts, 33461a3a5a7SFiona Ebner Error **errp) 33561a3a5a7SFiona Ebner { 33661a3a5a7SFiona Ebner const BlockJobDriver *drv = block_job_driver(job); 33761a3a5a7SFiona Ebner 33861a3a5a7SFiona Ebner GLOBAL_STATE_CODE(); 33961a3a5a7SFiona Ebner 34061a3a5a7SFiona Ebner if (job_apply_verb_locked(&job->job, JOB_VERB_CHANGE, errp)) { 34161a3a5a7SFiona Ebner return; 34261a3a5a7SFiona Ebner } 34361a3a5a7SFiona Ebner 34461a3a5a7SFiona Ebner if (drv->change) { 34561a3a5a7SFiona Ebner job_unlock(); 34661a3a5a7SFiona Ebner drv->change(job, opts, errp); 34761a3a5a7SFiona Ebner job_lock(); 34861a3a5a7SFiona Ebner } else { 34961a3a5a7SFiona Ebner error_setg(errp, "Job type does not support change"); 35061a3a5a7SFiona Ebner } 35161a3a5a7SFiona Ebner } 35261a3a5a7SFiona Ebner 353018e5987SKevin Wolf void block_job_ratelimit_processed_bytes(BlockJob *job, uint64_t n) 354dee81d51SKevin Wolf { 355e2d9faf5SEmanuele Giuseppe Esposito IO_CODE(); 356018e5987SKevin Wolf ratelimit_calculate_delay(&job->limit, n); 357018e5987SKevin Wolf } 358018e5987SKevin Wolf 359018e5987SKevin Wolf void block_job_ratelimit_sleep(BlockJob *job) 360018e5987SKevin Wolf { 361018e5987SKevin Wolf uint64_t delay_ns; 362018e5987SKevin Wolf 363018e5987SKevin Wolf /* 364018e5987SKevin Wolf * Sleep at least once. If the job is reentered early, keep waiting until 365018e5987SKevin Wolf * we've waited for the full time that is necessary to keep the job at the 366018e5987SKevin Wolf * right speed. 367018e5987SKevin Wolf * 368018e5987SKevin Wolf * Make sure to recalculate the delay after each (possibly interrupted) 369018e5987SKevin Wolf * sleep because the speed can change while the job has yielded. 370018e5987SKevin Wolf */ 371018e5987SKevin Wolf do { 372018e5987SKevin Wolf delay_ns = ratelimit_calculate_delay(&job->limit, 0); 373018e5987SKevin Wolf job_sleep_ns(&job->job, delay_ns); 374018e5987SKevin Wolf } while (delay_ns && !job_is_cancelled(&job->job)); 375dee81d51SKevin Wolf } 376dee81d51SKevin Wolf 377f41ab73fSEmanuele Giuseppe Esposito BlockJobInfo *block_job_query_locked(BlockJob *job, Error **errp) 37830e628b7SPaolo Bonzini { 379559b935fSJohn Snow BlockJobInfo *info; 380a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 38159fd8254SFiona Ebner const BlockJobDriver *drv = block_job_driver(job); 382559b935fSJohn Snow 383cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 384cf81ae28SEmanuele Giuseppe Esposito 385559b935fSJohn Snow if (block_job_is_internal(job)) { 386559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 387559b935fSJohn Snow return NULL; 388559b935fSJohn Snow } 389a7b4f8fcSEmanuele Giuseppe Esposito 390a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 391a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 392a7b4f8fcSEmanuele Giuseppe Esposito 393559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 394d67c54d0SFiona Ebner info->type = job_type(&job->job); 39533e9e9bdSKevin Wolf info->device = g_strdup(job->job.id); 396fca26318SEmanuele Giuseppe Esposito info->busy = job->job.busy; 397da01ff7fSKevin Wolf info->paused = job->job.pause_count > 0; 398a7b4f8fcSEmanuele Giuseppe Esposito info->offset = progress_current; 399a7b4f8fcSEmanuele Giuseppe Esposito info->len = progress_total; 40030e628b7SPaolo Bonzini info->speed = job->speed; 40132c81a4aSPaolo Bonzini info->io_status = job->iostatus; 402f41ab73fSEmanuele Giuseppe Esposito info->ready = job_is_ready_locked(&job->job), 403a50c2ab8SKevin Wolf info->status = job->job.status; 404bb02b65cSKevin Wolf info->auto_finalize = job->job.auto_finalize; 405bb02b65cSKevin Wolf info->auto_dismiss = job->job.auto_dismiss; 4063b6ad623SStefano Garzarella if (job->job.ret) { 4073b6ad623SStefano Garzarella info->error = job->job.err ? 4083b6ad623SStefano Garzarella g_strdup(error_get_pretty(job->job.err)) : 4093b6ad623SStefano Garzarella g_strdup(strerror(-job->job.ret)); 4103b6ad623SStefano Garzarella } 41159fd8254SFiona Ebner if (drv->query) { 41259fd8254SFiona Ebner job_unlock(); 41359fd8254SFiona Ebner drv->query(job, info); 41459fd8254SFiona Ebner job_lock(); 41559fd8254SFiona Ebner } 41630e628b7SPaolo Bonzini return info; 41730e628b7SPaolo Bonzini } 41832c81a4aSPaolo Bonzini 419d59cb66dSEmanuele Giuseppe Esposito /* Called with job lock held */ 420d59cb66dSEmanuele Giuseppe Esposito static void block_job_iostatus_set_err_locked(BlockJob *job, int error) 42132c81a4aSPaolo Bonzini { 42232c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 42332c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 42432c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 42532c81a4aSPaolo Bonzini } 42632c81a4aSPaolo Bonzini } 42732c81a4aSPaolo Bonzini 428243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 429243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_cancelled_locked(Notifier *n, void *opaque) 430a66a2a36SPaolo Bonzini { 431139a9f02SKevin Wolf BlockJob *job = opaque; 432a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 433139a9f02SKevin Wolf 434559b935fSJohn Snow if (block_job_is_internal(job)) { 435559b935fSJohn Snow return; 436559b935fSJohn Snow } 437559b935fSJohn Snow 438a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 439a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 440a7b4f8fcSEmanuele Giuseppe Esposito 441252291eaSKevin Wolf qapi_event_send_block_job_cancelled(job_type(&job->job), 44233e9e9bdSKevin Wolf job->job.id, 443a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 444a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 4453ab72385SPeter Xu job->speed); 446a66a2a36SPaolo Bonzini } 447a66a2a36SPaolo Bonzini 448243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 449243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_completed_locked(Notifier *n, void *opaque) 450a66a2a36SPaolo Bonzini { 451139a9f02SKevin Wolf BlockJob *job = opaque; 452139a9f02SKevin Wolf const char *msg = NULL; 453a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 454139a9f02SKevin Wolf 455559b935fSJohn Snow if (block_job_is_internal(job)) { 456559b935fSJohn Snow return; 457559b935fSJohn Snow } 458559b935fSJohn Snow 4594ad35181SKevin Wolf if (job->job.ret < 0) { 4603b6ad623SStefano Garzarella msg = error_get_pretty(job->job.err); 461139a9f02SKevin Wolf } 462139a9f02SKevin Wolf 463a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 464a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 465a7b4f8fcSEmanuele Giuseppe Esposito 466252291eaSKevin Wolf qapi_event_send_block_job_completed(job_type(&job->job), 46733e9e9bdSKevin Wolf job->job.id, 468a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 469a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 470bcada37bSWenchao Xia job->speed, 4713ab72385SPeter Xu msg); 472bcada37bSWenchao Xia } 473bcada37bSWenchao Xia 474243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 475243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_pending_locked(Notifier *n, void *opaque) 4765f241594SJohn Snow { 477139a9f02SKevin Wolf BlockJob *job = opaque; 478139a9f02SKevin Wolf 4795d4f3769SKevin Wolf if (block_job_is_internal(job)) { 4805d4f3769SKevin Wolf return; 4815d4f3769SKevin Wolf } 4825d4f3769SKevin Wolf 483252291eaSKevin Wolf qapi_event_send_block_job_pending(job_type(&job->job), 4843ab72385SPeter Xu job->job.id); 4855f241594SJohn Snow } 4865f241594SJohn Snow 487243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 488243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_ready_locked(Notifier *n, void *opaque) 4892e1795b5SKevin Wolf { 4902e1795b5SKevin Wolf BlockJob *job = opaque; 491a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 4922e1795b5SKevin Wolf 4932e1795b5SKevin Wolf if (block_job_is_internal(job)) { 4942e1795b5SKevin Wolf return; 4952e1795b5SKevin Wolf } 4962e1795b5SKevin Wolf 497a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 498a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 499a7b4f8fcSEmanuele Giuseppe Esposito 5002e1795b5SKevin Wolf qapi_event_send_block_job_ready(job_type(&job->job), 5012e1795b5SKevin Wolf job->job.id, 502a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 503a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 5043ab72385SPeter Xu job->speed); 5052e1795b5SKevin Wolf } 5062e1795b5SKevin Wolf 5072e1795b5SKevin Wolf 50888691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver, 50962c9e416SKevin Wolf JobTxn *txn, BlockDriverState *bs, uint64_t perm, 51088691b37SPaolo Bonzini uint64_t shared_perm, int64_t speed, int flags, 51188691b37SPaolo Bonzini BlockCompletionFunc *cb, void *opaque, Error **errp) 51288691b37SPaolo Bonzini { 51388691b37SPaolo Bonzini BlockJob *job; 514985cac8fSVladimir Sementsov-Ogievskiy int ret; 515e2d9faf5SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 516f3bbc53dSKevin Wolf 517*6bc30f19SStefan Hajnoczi bdrv_graph_wrlock(); 51888691b37SPaolo Bonzini 519bb02b65cSKevin Wolf if (job_id == NULL && !(flags & JOB_INTERNAL)) { 52088691b37SPaolo Bonzini job_id = bdrv_get_device_name(bs); 52188691b37SPaolo Bonzini } 52288691b37SPaolo Bonzini 523985cac8fSVladimir Sementsov-Ogievskiy job = job_create(job_id, &driver->job_driver, txn, bdrv_get_aio_context(bs), 5244ad35181SKevin Wolf flags, cb, opaque, errp); 52533e9e9bdSKevin Wolf if (job == NULL) { 526*6bc30f19SStefan Hajnoczi bdrv_graph_wrunlock(); 52733e9e9bdSKevin Wolf return NULL; 52833e9e9bdSKevin Wolf } 52933e9e9bdSKevin Wolf 530e7c1d78bSKevin Wolf assert(is_block_job(&job->job)); 53180fa2c75SKevin Wolf assert(job->job.driver->free == &block_job_free); 532b15de828SKevin Wolf assert(job->job.driver->user_resume == &block_job_user_resume); 533e7c1d78bSKevin Wolf 5344951967dSPaolo Bonzini ratelimit_init(&job->limit); 5354951967dSPaolo Bonzini 536243c6ec7SEmanuele Giuseppe Esposito job->finalize_cancelled_notifier.notify = block_job_event_cancelled_locked; 537243c6ec7SEmanuele Giuseppe Esposito job->finalize_completed_notifier.notify = block_job_event_completed_locked; 538243c6ec7SEmanuele Giuseppe Esposito job->pending_notifier.notify = block_job_event_pending_locked; 539243c6ec7SEmanuele Giuseppe Esposito job->ready_notifier.notify = block_job_event_ready_locked; 540243c6ec7SEmanuele Giuseppe Esposito job->idle_notifier.notify = block_job_on_idle_locked; 541139a9f02SKevin Wolf 542880eeec6SEmanuele Giuseppe Esposito WITH_JOB_LOCK_GUARD() { 543139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_cancelled, 544139a9f02SKevin Wolf &job->finalize_cancelled_notifier); 545139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_completed, 546139a9f02SKevin Wolf &job->finalize_completed_notifier); 547139a9f02SKevin Wolf notifier_list_add(&job->job.on_pending, &job->pending_notifier); 5482e1795b5SKevin Wolf notifier_list_add(&job->job.on_ready, &job->ready_notifier); 54934dc97b9SKevin Wolf notifier_list_add(&job->job.on_idle, &job->idle_notifier); 550880eeec6SEmanuele Giuseppe Esposito } 551139a9f02SKevin Wolf 55288691b37SPaolo Bonzini error_setg(&job->blocker, "block device is in use by block job: %s", 553252291eaSKevin Wolf job_type_str(&job->job)); 554985cac8fSVladimir Sementsov-Ogievskiy 555985cac8fSVladimir Sementsov-Ogievskiy ret = block_job_add_bdrv(job, "main node", bs, perm, shared_perm, errp); 556985cac8fSVladimir Sementsov-Ogievskiy if (ret < 0) { 557985cac8fSVladimir Sementsov-Ogievskiy goto fail; 558985cac8fSVladimir Sementsov-Ogievskiy } 55988691b37SPaolo Bonzini 56088691b37SPaolo Bonzini bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 56188691b37SPaolo Bonzini 562775d0c05SVladimir Sementsov-Ogievskiy if (!block_job_set_speed(job, speed, errp)) { 563985cac8fSVladimir Sementsov-Ogievskiy goto fail; 56488691b37SPaolo Bonzini } 56575859b94SJohn Snow 566*6bc30f19SStefan Hajnoczi bdrv_graph_wrunlock(); 56788691b37SPaolo Bonzini return job; 568985cac8fSVladimir Sementsov-Ogievskiy 569985cac8fSVladimir Sementsov-Ogievskiy fail: 570*6bc30f19SStefan Hajnoczi bdrv_graph_wrunlock(); 571985cac8fSVladimir Sementsov-Ogievskiy job_early_fail(&job->job); 572985cac8fSVladimir Sementsov-Ogievskiy return NULL; 57388691b37SPaolo Bonzini } 57488691b37SPaolo Bonzini 575f41ab73fSEmanuele Giuseppe Esposito void block_job_iostatus_reset_locked(BlockJob *job) 5762caf63a9SPaolo Bonzini { 577cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 5784c241cf5SPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 5794c241cf5SPaolo Bonzini return; 5804c241cf5SPaolo Bonzini } 581b15de828SKevin Wolf assert(job->job.user_paused && job->job.pause_count > 0); 5822caf63a9SPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 5832caf63a9SPaolo Bonzini } 5842caf63a9SPaolo Bonzini 585ba6a9100SEmanuele Giuseppe Esposito static void block_job_iostatus_reset(BlockJob *job) 586f41ab73fSEmanuele Giuseppe Esposito { 587f41ab73fSEmanuele Giuseppe Esposito JOB_LOCK_GUARD(); 588f41ab73fSEmanuele Giuseppe Esposito block_job_iostatus_reset_locked(job); 589f41ab73fSEmanuele Giuseppe Esposito } 590f41ab73fSEmanuele Giuseppe Esposito 591b15de828SKevin Wolf void block_job_user_resume(Job *job) 592b15de828SKevin Wolf { 593b15de828SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 594e2d9faf5SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 595b15de828SKevin Wolf block_job_iostatus_reset(bjob); 596b15de828SKevin Wolf } 597b15de828SKevin Wolf 59881e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 59932c81a4aSPaolo Bonzini int is_read, int error) 60032c81a4aSPaolo Bonzini { 60132c81a4aSPaolo Bonzini BlockErrorAction action; 602e2d9faf5SEmanuele Giuseppe Esposito IO_CODE(); 60332c81a4aSPaolo Bonzini 60432c81a4aSPaolo Bonzini switch (on_err) { 60532c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 6068c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 607a589569fSWenchao Xia action = (error == ENOSPC) ? 608a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 60932c81a4aSPaolo Bonzini break; 61032c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 611a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 61232c81a4aSPaolo Bonzini break; 61332c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 614a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 61532c81a4aSPaolo Bonzini break; 61632c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 617a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 61832c81a4aSPaolo Bonzini break; 61932c81a4aSPaolo Bonzini default: 62032c81a4aSPaolo Bonzini abort(); 62132c81a4aSPaolo Bonzini } 622559b935fSJohn Snow if (!block_job_is_internal(job)) { 62333e9e9bdSKevin Wolf qapi_event_send_block_job_error(job->job.id, 6245a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 6255a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 6263ab72385SPeter Xu action); 627559b935fSJohn Snow } 628a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 629880eeec6SEmanuele Giuseppe Esposito WITH_JOB_LOCK_GUARD() { 6308d9648cbSVladimir Sementsov-Ogievskiy if (!job->job.user_paused) { 631880eeec6SEmanuele Giuseppe Esposito job_pause_locked(&job->job); 632880eeec6SEmanuele Giuseppe Esposito /* 633880eeec6SEmanuele Giuseppe Esposito * make the pause user visible, which will be 634880eeec6SEmanuele Giuseppe Esposito * resumed from QMP. 635880eeec6SEmanuele Giuseppe Esposito */ 636b15de828SKevin Wolf job->job.user_paused = true; 6378d9648cbSVladimir Sementsov-Ogievskiy } 638d59cb66dSEmanuele Giuseppe Esposito block_job_iostatus_set_err_locked(job, error); 639880eeec6SEmanuele Giuseppe Esposito } 64032c81a4aSPaolo Bonzini } 64132c81a4aSPaolo Bonzini return action; 64232c81a4aSPaolo Bonzini } 643df9a3165SVladimir Sementsov-Ogievskiy 644df9a3165SVladimir Sementsov-Ogievskiy AioContext *block_job_get_aio_context(BlockJob *job) 645df9a3165SVladimir Sementsov-Ogievskiy { 646cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 647df9a3165SVladimir Sementsov-Ogievskiy return job->job.aio_context; 648df9a3165SVladimir Sementsov-Ogievskiy } 649