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 */ 201d876bf67SSergio Lopez while (job->nodes) { 202d876bf67SSergio Lopez GSList *l = job->nodes; 203bbc02b90SKevin Wolf BdrvChild *c = l->data; 204d876bf67SSergio Lopez 205d876bf67SSergio Lopez job->nodes = l->next; 206d876bf67SSergio Lopez 207bbc02b90SKevin Wolf bdrv_op_unblock_all(c->bs, job->blocker); 208bbc02b90SKevin Wolf bdrv_root_unref_child(c); 209d876bf67SSergio Lopez 210d876bf67SSergio Lopez g_slist_free_1(l); 211bbc02b90SKevin Wolf } 212bbc02b90SKevin Wolf } 213bbc02b90SKevin Wolf 2148164102fSVladimir Sementsov-Ogievskiy bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs) 2158164102fSVladimir Sementsov-Ogievskiy { 2168164102fSVladimir Sementsov-Ogievskiy GSList *el; 217cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 2188164102fSVladimir Sementsov-Ogievskiy 2198164102fSVladimir Sementsov-Ogievskiy for (el = job->nodes; el; el = el->next) { 2208164102fSVladimir Sementsov-Ogievskiy BdrvChild *c = el->data; 2218164102fSVladimir Sementsov-Ogievskiy if (c->bs == bs) { 2228164102fSVladimir Sementsov-Ogievskiy return true; 2238164102fSVladimir Sementsov-Ogievskiy } 2248164102fSVladimir Sementsov-Ogievskiy } 2258164102fSVladimir Sementsov-Ogievskiy 2268164102fSVladimir Sementsov-Ogievskiy return false; 2278164102fSVladimir Sementsov-Ogievskiy } 2288164102fSVladimir Sementsov-Ogievskiy 22976d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 23076d554e2SKevin Wolf uint64_t perm, uint64_t shared_perm, Error **errp) 23123d402d4SAlberto Garcia { 23276d554e2SKevin Wolf BdrvChild *c; 233076d467aSMichael Qiu bool need_context_ops; 234cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 23576d554e2SKevin Wolf 236b441dc71SAlberto Garcia bdrv_ref(bs); 237076d467aSMichael Qiu 238076d467aSMichael Qiu need_context_ops = bdrv_get_aio_context(bs) != job->job.aio_context; 239076d467aSMichael Qiu 240076d467aSMichael Qiu if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) { 241132ada80SKevin Wolf aio_context_release(job->job.aio_context); 242132ada80SKevin Wolf } 243228ca37eSVladimir Sementsov-Ogievskiy c = bdrv_root_attach_child(bs, name, &child_job, 0, perm, shared_perm, job, 244258b7765SMax Reitz errp); 245076d467aSMichael Qiu if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) { 246132ada80SKevin Wolf aio_context_acquire(job->job.aio_context); 247132ada80SKevin Wolf } 24876d554e2SKevin Wolf if (c == NULL) { 24976d554e2SKevin Wolf return -EPERM; 25076d554e2SKevin Wolf } 25176d554e2SKevin Wolf 25276d554e2SKevin Wolf job->nodes = g_slist_prepend(job->nodes, c); 25323d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 25476d554e2SKevin Wolf 25576d554e2SKevin Wolf return 0; 25623d402d4SAlberto Garcia } 25723d402d4SAlberto Garcia 258243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 259243c6ec7SEmanuele Giuseppe Esposito static void block_job_on_idle_locked(Notifier *n, void *opaque) 26034dc97b9SKevin Wolf { 261cfe29d82SKevin Wolf aio_wait_kick(); 26234dc97b9SKevin Wolf } 26334dc97b9SKevin Wolf 264559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 265559b935fSJohn Snow { 26633e9e9bdSKevin Wolf return (job->job.id == NULL); 267559b935fSJohn Snow } 268559b935fSJohn Snow 269bd21935bSKevin Wolf const BlockJobDriver *block_job_driver(BlockJob *job) 270bd21935bSKevin Wolf { 2719f6bb4c0SKevin Wolf return container_of(job->job.driver, BlockJobDriver, job_driver); 272bd21935bSKevin Wolf } 273bd21935bSKevin Wolf 274da01ff7fSKevin Wolf /* Assumes the job_mutex is held */ 275da01ff7fSKevin Wolf static bool job_timer_pending(Job *job) 276da01ff7fSKevin Wolf { 277da01ff7fSKevin Wolf return timer_pending(&job->sleep_timer); 278da01ff7fSKevin Wolf } 279da01ff7fSKevin Wolf 280f41ab73fSEmanuele Giuseppe Esposito bool block_job_set_speed_locked(BlockJob *job, int64_t speed, Error **errp) 2812f0c9fe6SPaolo Bonzini { 282e0323a04SVladimir Sementsov-Ogievskiy const BlockJobDriver *drv = block_job_driver(job); 283aa9ef2e6SJohn Snow int64_t old_speed = job->speed; 2842f0c9fe6SPaolo Bonzini 285cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 286cf81ae28SEmanuele Giuseppe Esposito 287f41ab73fSEmanuele Giuseppe Esposito if (job_apply_verb_locked(&job->job, JOB_VERB_SET_SPEED, errp) < 0) { 288775d0c05SVladimir Sementsov-Ogievskiy return false; 2890ec4dfb8SJohn Snow } 29018bb6928SKevin Wolf if (speed < 0) { 2911ef7d9d3SKevin Wolf error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "speed", 2921ef7d9d3SKevin Wolf "a non-negative value"); 293775d0c05SVladimir Sementsov-Ogievskiy return false; 2942f0c9fe6SPaolo Bonzini } 2952f0c9fe6SPaolo Bonzini 29618bb6928SKevin Wolf ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); 29718bb6928SKevin Wolf 2982f0c9fe6SPaolo Bonzini job->speed = speed; 299e0323a04SVladimir Sementsov-Ogievskiy 300e0323a04SVladimir Sementsov-Ogievskiy if (drv->set_speed) { 301f41ab73fSEmanuele Giuseppe Esposito job_unlock(); 302e0323a04SVladimir Sementsov-Ogievskiy drv->set_speed(job, speed); 303f41ab73fSEmanuele Giuseppe Esposito job_lock(); 304e0323a04SVladimir Sementsov-Ogievskiy } 305e0323a04SVladimir Sementsov-Ogievskiy 306d4fce188SJohn Snow if (speed && speed <= old_speed) { 307775d0c05SVladimir Sementsov-Ogievskiy return true; 308aa9ef2e6SJohn Snow } 309aa9ef2e6SJohn Snow 310aa9ef2e6SJohn Snow /* kick only if a timer is pending */ 311f41ab73fSEmanuele Giuseppe Esposito job_enter_cond_locked(&job->job, job_timer_pending); 312775d0c05SVladimir Sementsov-Ogievskiy 313775d0c05SVladimir Sementsov-Ogievskiy return true; 3142f0c9fe6SPaolo Bonzini } 3152f0c9fe6SPaolo Bonzini 316ba6a9100SEmanuele Giuseppe Esposito static bool block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 317f41ab73fSEmanuele Giuseppe Esposito { 318f41ab73fSEmanuele Giuseppe Esposito JOB_LOCK_GUARD(); 319f41ab73fSEmanuele Giuseppe Esposito return block_job_set_speed_locked(job, speed, errp); 320f41ab73fSEmanuele Giuseppe Esposito } 321f41ab73fSEmanuele Giuseppe Esposito 322018e5987SKevin Wolf void block_job_ratelimit_processed_bytes(BlockJob *job, uint64_t n) 323dee81d51SKevin Wolf { 324e2d9faf5SEmanuele Giuseppe Esposito IO_CODE(); 325018e5987SKevin Wolf ratelimit_calculate_delay(&job->limit, n); 326018e5987SKevin Wolf } 327018e5987SKevin Wolf 328018e5987SKevin Wolf void block_job_ratelimit_sleep(BlockJob *job) 329018e5987SKevin Wolf { 330018e5987SKevin Wolf uint64_t delay_ns; 331018e5987SKevin Wolf 332018e5987SKevin Wolf /* 333018e5987SKevin Wolf * Sleep at least once. If the job is reentered early, keep waiting until 334018e5987SKevin Wolf * we've waited for the full time that is necessary to keep the job at the 335018e5987SKevin Wolf * right speed. 336018e5987SKevin Wolf * 337018e5987SKevin Wolf * Make sure to recalculate the delay after each (possibly interrupted) 338018e5987SKevin Wolf * sleep because the speed can change while the job has yielded. 339018e5987SKevin Wolf */ 340018e5987SKevin Wolf do { 341018e5987SKevin Wolf delay_ns = ratelimit_calculate_delay(&job->limit, 0); 342018e5987SKevin Wolf job_sleep_ns(&job->job, delay_ns); 343018e5987SKevin Wolf } while (delay_ns && !job_is_cancelled(&job->job)); 344dee81d51SKevin Wolf } 345dee81d51SKevin Wolf 346f41ab73fSEmanuele Giuseppe Esposito BlockJobInfo *block_job_query_locked(BlockJob *job, Error **errp) 34730e628b7SPaolo Bonzini { 348559b935fSJohn Snow BlockJobInfo *info; 349a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 350559b935fSJohn Snow 351cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 352cf81ae28SEmanuele Giuseppe Esposito 353559b935fSJohn Snow if (block_job_is_internal(job)) { 354559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 355559b935fSJohn Snow return NULL; 356559b935fSJohn Snow } 357a7b4f8fcSEmanuele Giuseppe Esposito 358a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 359a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 360a7b4f8fcSEmanuele Giuseppe Esposito 361559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 362252291eaSKevin Wolf info->type = g_strdup(job_type_str(&job->job)); 36333e9e9bdSKevin Wolf info->device = g_strdup(job->job.id); 364fca26318SEmanuele Giuseppe Esposito info->busy = job->job.busy; 365da01ff7fSKevin Wolf info->paused = job->job.pause_count > 0; 366a7b4f8fcSEmanuele Giuseppe Esposito info->offset = progress_current; 367a7b4f8fcSEmanuele Giuseppe Esposito info->len = progress_total; 36830e628b7SPaolo Bonzini info->speed = job->speed; 36932c81a4aSPaolo Bonzini info->io_status = job->iostatus; 370f41ab73fSEmanuele Giuseppe Esposito info->ready = job_is_ready_locked(&job->job), 371a50c2ab8SKevin Wolf info->status = job->job.status; 372bb02b65cSKevin Wolf info->auto_finalize = job->job.auto_finalize; 373bb02b65cSKevin Wolf info->auto_dismiss = job->job.auto_dismiss; 3743b6ad623SStefano Garzarella if (job->job.ret) { 3753b6ad623SStefano Garzarella info->error = job->job.err ? 3763b6ad623SStefano Garzarella g_strdup(error_get_pretty(job->job.err)) : 3773b6ad623SStefano Garzarella g_strdup(strerror(-job->job.ret)); 3783b6ad623SStefano Garzarella } 37930e628b7SPaolo Bonzini return info; 38030e628b7SPaolo Bonzini } 38132c81a4aSPaolo Bonzini 382d59cb66dSEmanuele Giuseppe Esposito /* Called with job lock held */ 383d59cb66dSEmanuele Giuseppe Esposito static void block_job_iostatus_set_err_locked(BlockJob *job, int error) 38432c81a4aSPaolo Bonzini { 38532c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 38632c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 38732c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 38832c81a4aSPaolo Bonzini } 38932c81a4aSPaolo Bonzini } 39032c81a4aSPaolo Bonzini 391243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 392243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_cancelled_locked(Notifier *n, void *opaque) 393a66a2a36SPaolo Bonzini { 394139a9f02SKevin Wolf BlockJob *job = opaque; 395a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 396139a9f02SKevin Wolf 397559b935fSJohn Snow if (block_job_is_internal(job)) { 398559b935fSJohn Snow return; 399559b935fSJohn Snow } 400559b935fSJohn Snow 401a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 402a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 403a7b4f8fcSEmanuele Giuseppe Esposito 404252291eaSKevin Wolf qapi_event_send_block_job_cancelled(job_type(&job->job), 40533e9e9bdSKevin Wolf job->job.id, 406a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 407a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 4083ab72385SPeter Xu job->speed); 409a66a2a36SPaolo Bonzini } 410a66a2a36SPaolo Bonzini 411243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 412243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_completed_locked(Notifier *n, void *opaque) 413a66a2a36SPaolo Bonzini { 414139a9f02SKevin Wolf BlockJob *job = opaque; 415139a9f02SKevin Wolf const char *msg = NULL; 416a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 417139a9f02SKevin Wolf 418559b935fSJohn Snow if (block_job_is_internal(job)) { 419559b935fSJohn Snow return; 420559b935fSJohn Snow } 421559b935fSJohn Snow 4224ad35181SKevin Wolf if (job->job.ret < 0) { 4233b6ad623SStefano Garzarella msg = error_get_pretty(job->job.err); 424139a9f02SKevin Wolf } 425139a9f02SKevin Wolf 426a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 427a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 428a7b4f8fcSEmanuele Giuseppe Esposito 429252291eaSKevin Wolf qapi_event_send_block_job_completed(job_type(&job->job), 43033e9e9bdSKevin Wolf job->job.id, 431a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 432a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 433bcada37bSWenchao Xia job->speed, 4343ab72385SPeter Xu msg); 435bcada37bSWenchao Xia } 436bcada37bSWenchao Xia 437243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 438243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_pending_locked(Notifier *n, void *opaque) 4395f241594SJohn Snow { 440139a9f02SKevin Wolf BlockJob *job = opaque; 441139a9f02SKevin Wolf 4425d4f3769SKevin Wolf if (block_job_is_internal(job)) { 4435d4f3769SKevin Wolf return; 4445d4f3769SKevin Wolf } 4455d4f3769SKevin Wolf 446252291eaSKevin Wolf qapi_event_send_block_job_pending(job_type(&job->job), 4473ab72385SPeter Xu job->job.id); 4485f241594SJohn Snow } 4495f241594SJohn Snow 450243c6ec7SEmanuele Giuseppe Esposito /* Called with job_mutex lock held. */ 451243c6ec7SEmanuele Giuseppe Esposito static void block_job_event_ready_locked(Notifier *n, void *opaque) 4522e1795b5SKevin Wolf { 4532e1795b5SKevin Wolf BlockJob *job = opaque; 454a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 4552e1795b5SKevin Wolf 4562e1795b5SKevin Wolf if (block_job_is_internal(job)) { 4572e1795b5SKevin Wolf return; 4582e1795b5SKevin Wolf } 4592e1795b5SKevin Wolf 460a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 461a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 462a7b4f8fcSEmanuele Giuseppe Esposito 4632e1795b5SKevin Wolf qapi_event_send_block_job_ready(job_type(&job->job), 4642e1795b5SKevin Wolf job->job.id, 465a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 466a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 4673ab72385SPeter Xu job->speed); 4682e1795b5SKevin Wolf } 4692e1795b5SKevin Wolf 4702e1795b5SKevin Wolf 47188691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver, 47262c9e416SKevin Wolf JobTxn *txn, BlockDriverState *bs, uint64_t perm, 47388691b37SPaolo Bonzini uint64_t shared_perm, int64_t speed, int flags, 47488691b37SPaolo Bonzini BlockCompletionFunc *cb, void *opaque, Error **errp) 47588691b37SPaolo Bonzini { 47688691b37SPaolo Bonzini BlockJob *job; 477985cac8fSVladimir Sementsov-Ogievskiy int ret; 478e2d9faf5SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 47988691b37SPaolo Bonzini 480bb02b65cSKevin Wolf if (job_id == NULL && !(flags & JOB_INTERNAL)) { 48188691b37SPaolo Bonzini job_id = bdrv_get_device_name(bs); 48288691b37SPaolo Bonzini } 48388691b37SPaolo Bonzini 484985cac8fSVladimir Sementsov-Ogievskiy job = job_create(job_id, &driver->job_driver, txn, bdrv_get_aio_context(bs), 4854ad35181SKevin Wolf flags, cb, opaque, errp); 48633e9e9bdSKevin Wolf if (job == NULL) { 48733e9e9bdSKevin Wolf return NULL; 48833e9e9bdSKevin Wolf } 48933e9e9bdSKevin Wolf 490e7c1d78bSKevin Wolf assert(is_block_job(&job->job)); 49180fa2c75SKevin Wolf assert(job->job.driver->free == &block_job_free); 492b15de828SKevin Wolf assert(job->job.driver->user_resume == &block_job_user_resume); 493e7c1d78bSKevin Wolf 4944951967dSPaolo Bonzini ratelimit_init(&job->limit); 4954951967dSPaolo Bonzini 496243c6ec7SEmanuele Giuseppe Esposito job->finalize_cancelled_notifier.notify = block_job_event_cancelled_locked; 497243c6ec7SEmanuele Giuseppe Esposito job->finalize_completed_notifier.notify = block_job_event_completed_locked; 498243c6ec7SEmanuele Giuseppe Esposito job->pending_notifier.notify = block_job_event_pending_locked; 499243c6ec7SEmanuele Giuseppe Esposito job->ready_notifier.notify = block_job_event_ready_locked; 500243c6ec7SEmanuele Giuseppe Esposito job->idle_notifier.notify = block_job_on_idle_locked; 501139a9f02SKevin Wolf 502880eeec6SEmanuele Giuseppe Esposito WITH_JOB_LOCK_GUARD() { 503139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_cancelled, 504139a9f02SKevin Wolf &job->finalize_cancelled_notifier); 505139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_completed, 506139a9f02SKevin Wolf &job->finalize_completed_notifier); 507139a9f02SKevin Wolf notifier_list_add(&job->job.on_pending, &job->pending_notifier); 5082e1795b5SKevin Wolf notifier_list_add(&job->job.on_ready, &job->ready_notifier); 50934dc97b9SKevin Wolf notifier_list_add(&job->job.on_idle, &job->idle_notifier); 510880eeec6SEmanuele Giuseppe Esposito } 511139a9f02SKevin Wolf 51288691b37SPaolo Bonzini error_setg(&job->blocker, "block device is in use by block job: %s", 513252291eaSKevin Wolf job_type_str(&job->job)); 514985cac8fSVladimir Sementsov-Ogievskiy 515985cac8fSVladimir Sementsov-Ogievskiy ret = block_job_add_bdrv(job, "main node", bs, perm, shared_perm, errp); 516985cac8fSVladimir Sementsov-Ogievskiy if (ret < 0) { 517985cac8fSVladimir Sementsov-Ogievskiy goto fail; 518985cac8fSVladimir Sementsov-Ogievskiy } 51988691b37SPaolo Bonzini 52088691b37SPaolo Bonzini bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 52188691b37SPaolo Bonzini 522775d0c05SVladimir Sementsov-Ogievskiy if (!block_job_set_speed(job, speed, errp)) { 523985cac8fSVladimir Sementsov-Ogievskiy goto fail; 52488691b37SPaolo Bonzini } 52575859b94SJohn Snow 52688691b37SPaolo Bonzini return job; 527985cac8fSVladimir Sementsov-Ogievskiy 528985cac8fSVladimir Sementsov-Ogievskiy fail: 529985cac8fSVladimir Sementsov-Ogievskiy job_early_fail(&job->job); 530985cac8fSVladimir Sementsov-Ogievskiy return NULL; 53188691b37SPaolo Bonzini } 53288691b37SPaolo Bonzini 533f41ab73fSEmanuele Giuseppe Esposito void block_job_iostatus_reset_locked(BlockJob *job) 5342caf63a9SPaolo Bonzini { 535cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 5364c241cf5SPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 5374c241cf5SPaolo Bonzini return; 5384c241cf5SPaolo Bonzini } 539b15de828SKevin Wolf assert(job->job.user_paused && job->job.pause_count > 0); 5402caf63a9SPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 5412caf63a9SPaolo Bonzini } 5422caf63a9SPaolo Bonzini 543ba6a9100SEmanuele Giuseppe Esposito static void block_job_iostatus_reset(BlockJob *job) 544f41ab73fSEmanuele Giuseppe Esposito { 545f41ab73fSEmanuele Giuseppe Esposito JOB_LOCK_GUARD(); 546f41ab73fSEmanuele Giuseppe Esposito block_job_iostatus_reset_locked(job); 547f41ab73fSEmanuele Giuseppe Esposito } 548f41ab73fSEmanuele Giuseppe Esposito 549b15de828SKevin Wolf void block_job_user_resume(Job *job) 550b15de828SKevin Wolf { 551b15de828SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 552e2d9faf5SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 553b15de828SKevin Wolf block_job_iostatus_reset(bjob); 554b15de828SKevin Wolf } 555b15de828SKevin Wolf 55681e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 55732c81a4aSPaolo Bonzini int is_read, int error) 55832c81a4aSPaolo Bonzini { 55932c81a4aSPaolo Bonzini BlockErrorAction action; 560e2d9faf5SEmanuele Giuseppe Esposito IO_CODE(); 56132c81a4aSPaolo Bonzini 56232c81a4aSPaolo Bonzini switch (on_err) { 56332c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 5648c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 565a589569fSWenchao Xia action = (error == ENOSPC) ? 566a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 56732c81a4aSPaolo Bonzini break; 56832c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 569a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 57032c81a4aSPaolo Bonzini break; 57132c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 572a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 57332c81a4aSPaolo Bonzini break; 57432c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 575a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 57632c81a4aSPaolo Bonzini break; 57732c81a4aSPaolo Bonzini default: 57832c81a4aSPaolo Bonzini abort(); 57932c81a4aSPaolo Bonzini } 580559b935fSJohn Snow if (!block_job_is_internal(job)) { 58133e9e9bdSKevin Wolf qapi_event_send_block_job_error(job->job.id, 5825a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 5835a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 5843ab72385SPeter Xu action); 585559b935fSJohn Snow } 586a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 587880eeec6SEmanuele Giuseppe Esposito WITH_JOB_LOCK_GUARD() { 5888d9648cbSVladimir Sementsov-Ogievskiy if (!job->job.user_paused) { 589880eeec6SEmanuele Giuseppe Esposito job_pause_locked(&job->job); 590880eeec6SEmanuele Giuseppe Esposito /* 591880eeec6SEmanuele Giuseppe Esposito * make the pause user visible, which will be 592880eeec6SEmanuele Giuseppe Esposito * resumed from QMP. 593880eeec6SEmanuele Giuseppe Esposito */ 594b15de828SKevin Wolf job->job.user_paused = true; 5958d9648cbSVladimir Sementsov-Ogievskiy } 596d59cb66dSEmanuele Giuseppe Esposito block_job_iostatus_set_err_locked(job, error); 597880eeec6SEmanuele Giuseppe Esposito } 59832c81a4aSPaolo Bonzini } 59932c81a4aSPaolo Bonzini return action; 60032c81a4aSPaolo Bonzini } 601df9a3165SVladimir Sementsov-Ogievskiy 602df9a3165SVladimir Sementsov-Ogievskiy AioContext *block_job_get_aio_context(BlockJob *job) 603df9a3165SVladimir Sementsov-Ogievskiy { 604cf81ae28SEmanuele Giuseppe Esposito GLOBAL_STATE_CODE(); 605df9a3165SVladimir Sementsov-Ogievskiy return job->job.aio_context; 606df9a3165SVladimir Sementsov-Ogievskiy } 607