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 3988691b37SPaolo Bonzini /* 4088691b37SPaolo Bonzini * The block job API is composed of two categories of functions. 4188691b37SPaolo Bonzini * 4288691b37SPaolo Bonzini * The first includes functions used by the monitor. The monitor is 4388691b37SPaolo Bonzini * peculiar in that it accesses the block job list with block_job_get, and 4488691b37SPaolo Bonzini * therefore needs consistency across block_job_get and the actual operation 4588691b37SPaolo Bonzini * (e.g. block_job_set_speed). The consistency is achieved with 4688691b37SPaolo Bonzini * aio_context_acquire/release. These functions are declared in blockjob.h. 4788691b37SPaolo Bonzini * 4888691b37SPaolo Bonzini * The second includes functions used by the block job drivers and sometimes 4988691b37SPaolo Bonzini * by the core block layer. These do not care about locking, because the 5088691b37SPaolo Bonzini * whole coroutine runs under the AioContext lock, and are declared in 5188691b37SPaolo Bonzini * blockjob_int.h. 5288691b37SPaolo Bonzini */ 5388691b37SPaolo Bonzini 54e7c1d78bSKevin Wolf static bool is_block_job(Job *job) 55a7112795SAlberto Garcia { 56e7c1d78bSKevin Wolf return job_type(job) == JOB_TYPE_BACKUP || 57e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_COMMIT || 58e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_MIRROR || 59e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_STREAM; 60a7112795SAlberto Garcia } 61e7c1d78bSKevin Wolf 62e7c1d78bSKevin Wolf BlockJob *block_job_next(BlockJob *bjob) 63e7c1d78bSKevin Wolf { 64e7c1d78bSKevin Wolf Job *job = bjob ? &bjob->job : NULL; 65e7c1d78bSKevin Wolf 66e7c1d78bSKevin Wolf do { 67e7c1d78bSKevin Wolf job = job_next(job); 68e7c1d78bSKevin Wolf } while (job && !is_block_job(job)); 69e7c1d78bSKevin Wolf 70e7c1d78bSKevin Wolf return job ? container_of(job, BlockJob, job) : NULL; 71a7112795SAlberto Garcia } 72a7112795SAlberto Garcia 73ffb1f10cSAlberto Garcia BlockJob *block_job_get(const char *id) 74ffb1f10cSAlberto Garcia { 75e7c1d78bSKevin Wolf Job *job = job_get(id); 76ffb1f10cSAlberto Garcia 77e7c1d78bSKevin Wolf if (job && is_block_job(job)) { 78e7c1d78bSKevin Wolf return container_of(job, BlockJob, job); 79e7c1d78bSKevin Wolf } else { 80ffb1f10cSAlberto Garcia return NULL; 81ffb1f10cSAlberto Garcia } 82e7c1d78bSKevin Wolf } 83ffb1f10cSAlberto Garcia 8480fa2c75SKevin Wolf void block_job_free(Job *job) 8505b0d8e3SPaolo Bonzini { 8680fa2c75SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 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. */ 114b5a7a057SKevin Wolf if (!job->busy || job_is_completed(job)) { 11589bd0305SKevin Wolf return false; 11689bd0305SKevin Wolf } 11789bd0305SKevin Wolf 11889bd0305SKevin Wolf /* Otherwise, assume that it isn't fully stopped yet, but allow the job to 11989bd0305SKevin Wolf * override this assumption. */ 12089bd0305SKevin Wolf if (drv->drained_poll) { 12189bd0305SKevin Wolf return drv->drained_poll(bjob); 12289bd0305SKevin Wolf } else { 12389bd0305SKevin Wolf return true; 12489bd0305SKevin Wolf } 12589bd0305SKevin Wolf } 12689bd0305SKevin Wolf 127e037c09cSMax Reitz static void child_job_drained_end(BdrvChild *c, int *drained_end_counter) 128f321dcb5SPaolo Bonzini { 129ad90febaSKevin Wolf BlockJob *job = c->opaque; 130b15de828SKevin Wolf job_resume(&job->job); 131f321dcb5SPaolo Bonzini } 132f321dcb5SPaolo Bonzini 1339ff7f0dfSKevin Wolf static bool child_job_can_set_aio_ctx(BdrvChild *c, AioContext *ctx, 1349ff7f0dfSKevin Wolf GSList **ignore, Error **errp) 1359ff7f0dfSKevin Wolf { 1369ff7f0dfSKevin Wolf BlockJob *job = c->opaque; 1379ff7f0dfSKevin Wolf GSList *l; 1389ff7f0dfSKevin Wolf 1399ff7f0dfSKevin Wolf for (l = job->nodes; l; l = l->next) { 1409ff7f0dfSKevin Wolf BdrvChild *sibling = l->data; 1419ff7f0dfSKevin Wolf if (!bdrv_child_can_set_aio_context(sibling, ctx, ignore, errp)) { 1429ff7f0dfSKevin Wolf return false; 1439ff7f0dfSKevin Wolf } 1449ff7f0dfSKevin Wolf } 1459ff7f0dfSKevin Wolf return true; 1469ff7f0dfSKevin Wolf } 1479ff7f0dfSKevin Wolf 1489ff7f0dfSKevin Wolf static void child_job_set_aio_ctx(BdrvChild *c, AioContext *ctx, 1499ff7f0dfSKevin Wolf GSList **ignore) 1509ff7f0dfSKevin Wolf { 1519ff7f0dfSKevin Wolf BlockJob *job = c->opaque; 1529ff7f0dfSKevin Wolf GSList *l; 1539ff7f0dfSKevin Wolf 1549ff7f0dfSKevin Wolf for (l = job->nodes; l; l = l->next) { 1559ff7f0dfSKevin Wolf BdrvChild *sibling = l->data; 1569ff7f0dfSKevin Wolf if (g_slist_find(*ignore, sibling)) { 1579ff7f0dfSKevin Wolf continue; 1589ff7f0dfSKevin Wolf } 1599ff7f0dfSKevin Wolf *ignore = g_slist_prepend(*ignore, sibling); 1609ff7f0dfSKevin Wolf bdrv_set_aio_context_ignore(sibling->bs, ctx, ignore); 1619ff7f0dfSKevin Wolf } 162657e1203SKevin Wolf 163657e1203SKevin Wolf job->job.aio_context = ctx; 1649ff7f0dfSKevin Wolf } 1659ff7f0dfSKevin Wolf 1663ca1f322SVladimir Sementsov-Ogievskiy static AioContext *child_job_get_parent_aio_context(BdrvChild *c) 1673ca1f322SVladimir Sementsov-Ogievskiy { 1683ca1f322SVladimir Sementsov-Ogievskiy BlockJob *job = c->opaque; 1693ca1f322SVladimir Sementsov-Ogievskiy 1703ca1f322SVladimir Sementsov-Ogievskiy return job->job.aio_context; 1713ca1f322SVladimir Sementsov-Ogievskiy } 1723ca1f322SVladimir Sementsov-Ogievskiy 173bd86fb99SMax Reitz static const BdrvChildClass child_job = { 174ad90febaSKevin Wolf .get_parent_desc = child_job_get_parent_desc, 175ad90febaSKevin Wolf .drained_begin = child_job_drained_begin, 17689bd0305SKevin Wolf .drained_poll = child_job_drained_poll, 177ad90febaSKevin Wolf .drained_end = child_job_drained_end, 1789ff7f0dfSKevin Wolf .can_set_aio_ctx = child_job_can_set_aio_ctx, 1799ff7f0dfSKevin Wolf .set_aio_ctx = child_job_set_aio_ctx, 180ad90febaSKevin Wolf .stay_at_node = true, 1813ca1f322SVladimir Sementsov-Ogievskiy .get_parent_aio_context = child_job_get_parent_aio_context, 182f321dcb5SPaolo Bonzini }; 183f321dcb5SPaolo Bonzini 184bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job) 185bbc02b90SKevin Wolf { 186d876bf67SSergio Lopez /* 187d876bf67SSergio Lopez * bdrv_root_unref_child() may reach child_job_[can_]set_aio_ctx(), 188d876bf67SSergio Lopez * which will also traverse job->nodes, so consume the list one by 189d876bf67SSergio Lopez * one to make sure that such a concurrent access does not attempt 190d876bf67SSergio Lopez * to process an already freed BdrvChild. 191d876bf67SSergio Lopez */ 192d876bf67SSergio Lopez while (job->nodes) { 193d876bf67SSergio Lopez GSList *l = job->nodes; 194bbc02b90SKevin Wolf BdrvChild *c = l->data; 195d876bf67SSergio Lopez 196d876bf67SSergio Lopez job->nodes = l->next; 197d876bf67SSergio Lopez 198bbc02b90SKevin Wolf bdrv_op_unblock_all(c->bs, job->blocker); 199bbc02b90SKevin Wolf bdrv_root_unref_child(c); 200d876bf67SSergio Lopez 201d876bf67SSergio Lopez g_slist_free_1(l); 202bbc02b90SKevin Wolf } 203bbc02b90SKevin Wolf } 204bbc02b90SKevin Wolf 2058164102fSVladimir Sementsov-Ogievskiy bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs) 2068164102fSVladimir Sementsov-Ogievskiy { 2078164102fSVladimir Sementsov-Ogievskiy GSList *el; 2088164102fSVladimir Sementsov-Ogievskiy 2098164102fSVladimir Sementsov-Ogievskiy for (el = job->nodes; el; el = el->next) { 2108164102fSVladimir Sementsov-Ogievskiy BdrvChild *c = el->data; 2118164102fSVladimir Sementsov-Ogievskiy if (c->bs == bs) { 2128164102fSVladimir Sementsov-Ogievskiy return true; 2138164102fSVladimir Sementsov-Ogievskiy } 2148164102fSVladimir Sementsov-Ogievskiy } 2158164102fSVladimir Sementsov-Ogievskiy 2168164102fSVladimir Sementsov-Ogievskiy return false; 2178164102fSVladimir Sementsov-Ogievskiy } 2188164102fSVladimir Sementsov-Ogievskiy 21976d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 22076d554e2SKevin Wolf uint64_t perm, uint64_t shared_perm, Error **errp) 22123d402d4SAlberto Garcia { 22276d554e2SKevin Wolf BdrvChild *c; 223076d467aSMichael Qiu bool need_context_ops; 22476d554e2SKevin Wolf 225b441dc71SAlberto Garcia bdrv_ref(bs); 226076d467aSMichael Qiu 227076d467aSMichael Qiu need_context_ops = bdrv_get_aio_context(bs) != job->job.aio_context; 228076d467aSMichael Qiu 229076d467aSMichael Qiu if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) { 230132ada80SKevin Wolf aio_context_release(job->job.aio_context); 231132ada80SKevin Wolf } 232228ca37eSVladimir Sementsov-Ogievskiy c = bdrv_root_attach_child(bs, name, &child_job, 0, perm, shared_perm, job, 233258b7765SMax Reitz errp); 234076d467aSMichael Qiu if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) { 235132ada80SKevin Wolf aio_context_acquire(job->job.aio_context); 236132ada80SKevin Wolf } 23776d554e2SKevin Wolf if (c == NULL) { 23876d554e2SKevin Wolf return -EPERM; 23976d554e2SKevin Wolf } 24076d554e2SKevin Wolf 24176d554e2SKevin Wolf job->nodes = g_slist_prepend(job->nodes, c); 24223d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 24376d554e2SKevin Wolf 24476d554e2SKevin Wolf return 0; 24523d402d4SAlberto Garcia } 24623d402d4SAlberto Garcia 24734dc97b9SKevin Wolf static void block_job_on_idle(Notifier *n, void *opaque) 24834dc97b9SKevin Wolf { 249cfe29d82SKevin Wolf aio_wait_kick(); 25034dc97b9SKevin Wolf } 25134dc97b9SKevin Wolf 252559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 253559b935fSJohn Snow { 25433e9e9bdSKevin Wolf return (job->job.id == NULL); 255559b935fSJohn Snow } 256559b935fSJohn Snow 257bd21935bSKevin Wolf const BlockJobDriver *block_job_driver(BlockJob *job) 258bd21935bSKevin Wolf { 2599f6bb4c0SKevin Wolf return container_of(job->job.driver, BlockJobDriver, job_driver); 260bd21935bSKevin Wolf } 261bd21935bSKevin Wolf 262da01ff7fSKevin Wolf /* Assumes the job_mutex is held */ 263da01ff7fSKevin Wolf static bool job_timer_pending(Job *job) 264da01ff7fSKevin Wolf { 265da01ff7fSKevin Wolf return timer_pending(&job->sleep_timer); 266da01ff7fSKevin Wolf } 267da01ff7fSKevin Wolf 268775d0c05SVladimir Sementsov-Ogievskiy bool block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 2692f0c9fe6SPaolo Bonzini { 270e0323a04SVladimir Sementsov-Ogievskiy const BlockJobDriver *drv = block_job_driver(job); 271aa9ef2e6SJohn Snow int64_t old_speed = job->speed; 2722f0c9fe6SPaolo Bonzini 273775d0c05SVladimir Sementsov-Ogievskiy if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp) < 0) { 274775d0c05SVladimir Sementsov-Ogievskiy return false; 2750ec4dfb8SJohn Snow } 27618bb6928SKevin Wolf if (speed < 0) { 2771ef7d9d3SKevin Wolf error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "speed", 2781ef7d9d3SKevin Wolf "a non-negative value"); 279775d0c05SVladimir Sementsov-Ogievskiy return false; 2802f0c9fe6SPaolo Bonzini } 2812f0c9fe6SPaolo Bonzini 28218bb6928SKevin Wolf ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); 28318bb6928SKevin Wolf 2842f0c9fe6SPaolo Bonzini job->speed = speed; 285e0323a04SVladimir Sementsov-Ogievskiy 286e0323a04SVladimir Sementsov-Ogievskiy if (drv->set_speed) { 287e0323a04SVladimir Sementsov-Ogievskiy drv->set_speed(job, speed); 288e0323a04SVladimir Sementsov-Ogievskiy } 289e0323a04SVladimir Sementsov-Ogievskiy 290d4fce188SJohn Snow if (speed && speed <= old_speed) { 291775d0c05SVladimir Sementsov-Ogievskiy return true; 292aa9ef2e6SJohn Snow } 293aa9ef2e6SJohn Snow 294aa9ef2e6SJohn Snow /* kick only if a timer is pending */ 295da01ff7fSKevin Wolf job_enter_cond(&job->job, job_timer_pending); 296775d0c05SVladimir Sementsov-Ogievskiy 297775d0c05SVladimir Sementsov-Ogievskiy return true; 2982f0c9fe6SPaolo Bonzini } 2992f0c9fe6SPaolo Bonzini 300dee81d51SKevin Wolf int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) 301dee81d51SKevin Wolf { 302dee81d51SKevin Wolf return ratelimit_calculate_delay(&job->limit, n); 303dee81d51SKevin Wolf } 304dee81d51SKevin Wolf 305559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp) 30630e628b7SPaolo Bonzini { 307559b935fSJohn Snow BlockJobInfo *info; 308a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 309559b935fSJohn Snow 310559b935fSJohn Snow if (block_job_is_internal(job)) { 311559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 312559b935fSJohn Snow return NULL; 313559b935fSJohn Snow } 314a7b4f8fcSEmanuele Giuseppe Esposito 315a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 316a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 317a7b4f8fcSEmanuele Giuseppe Esposito 318559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 319252291eaSKevin Wolf info->type = g_strdup(job_type_str(&job->job)); 32033e9e9bdSKevin Wolf info->device = g_strdup(job->job.id); 321d73415a3SStefan Hajnoczi info->busy = qatomic_read(&job->job.busy); 322da01ff7fSKevin Wolf info->paused = job->job.pause_count > 0; 323a7b4f8fcSEmanuele Giuseppe Esposito info->offset = progress_current; 324a7b4f8fcSEmanuele Giuseppe Esposito info->len = progress_total; 32530e628b7SPaolo Bonzini info->speed = job->speed; 32632c81a4aSPaolo Bonzini info->io_status = job->iostatus; 327df956ae2SKevin Wolf info->ready = job_is_ready(&job->job), 328a50c2ab8SKevin Wolf info->status = job->job.status; 329bb02b65cSKevin Wolf info->auto_finalize = job->job.auto_finalize; 330bb02b65cSKevin Wolf info->auto_dismiss = job->job.auto_dismiss; 3313b6ad623SStefano Garzarella if (job->job.ret) { 3323b6ad623SStefano Garzarella info->has_error = true; 3333b6ad623SStefano Garzarella info->error = job->job.err ? 3343b6ad623SStefano Garzarella g_strdup(error_get_pretty(job->job.err)) : 3353b6ad623SStefano Garzarella g_strdup(strerror(-job->job.ret)); 3363b6ad623SStefano Garzarella } 33730e628b7SPaolo Bonzini return info; 33830e628b7SPaolo Bonzini } 33932c81a4aSPaolo Bonzini 34032c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 34132c81a4aSPaolo Bonzini { 34232c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 34332c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 34432c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 34532c81a4aSPaolo Bonzini } 34632c81a4aSPaolo Bonzini } 34732c81a4aSPaolo Bonzini 348139a9f02SKevin Wolf static void block_job_event_cancelled(Notifier *n, void *opaque) 349a66a2a36SPaolo Bonzini { 350139a9f02SKevin Wolf BlockJob *job = opaque; 351a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 352139a9f02SKevin Wolf 353559b935fSJohn Snow if (block_job_is_internal(job)) { 354559b935fSJohn Snow return; 355559b935fSJohn Snow } 356559b935fSJohn Snow 357a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 358a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 359a7b4f8fcSEmanuele Giuseppe Esposito 360252291eaSKevin Wolf qapi_event_send_block_job_cancelled(job_type(&job->job), 36133e9e9bdSKevin Wolf job->job.id, 362a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 363a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 3643ab72385SPeter Xu job->speed); 365a66a2a36SPaolo Bonzini } 366a66a2a36SPaolo Bonzini 367139a9f02SKevin Wolf static void block_job_event_completed(Notifier *n, void *opaque) 368a66a2a36SPaolo Bonzini { 369139a9f02SKevin Wolf BlockJob *job = opaque; 370139a9f02SKevin Wolf const char *msg = NULL; 371a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 372139a9f02SKevin Wolf 373559b935fSJohn Snow if (block_job_is_internal(job)) { 374559b935fSJohn Snow return; 375559b935fSJohn Snow } 376559b935fSJohn Snow 3774ad35181SKevin Wolf if (job->job.ret < 0) { 3783b6ad623SStefano Garzarella msg = error_get_pretty(job->job.err); 379139a9f02SKevin Wolf } 380139a9f02SKevin Wolf 381a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 382a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 383a7b4f8fcSEmanuele Giuseppe Esposito 384252291eaSKevin Wolf qapi_event_send_block_job_completed(job_type(&job->job), 38533e9e9bdSKevin Wolf job->job.id, 386a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 387a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 388bcada37bSWenchao Xia job->speed, 389bcada37bSWenchao Xia !!msg, 3903ab72385SPeter Xu msg); 391bcada37bSWenchao Xia } 392bcada37bSWenchao Xia 393139a9f02SKevin Wolf static void block_job_event_pending(Notifier *n, void *opaque) 3945f241594SJohn Snow { 395139a9f02SKevin Wolf BlockJob *job = opaque; 396139a9f02SKevin Wolf 3975d4f3769SKevin Wolf if (block_job_is_internal(job)) { 3985d4f3769SKevin Wolf return; 3995d4f3769SKevin Wolf } 4005d4f3769SKevin Wolf 401252291eaSKevin Wolf qapi_event_send_block_job_pending(job_type(&job->job), 4023ab72385SPeter Xu job->job.id); 4035f241594SJohn Snow } 4045f241594SJohn Snow 4052e1795b5SKevin Wolf static void block_job_event_ready(Notifier *n, void *opaque) 4062e1795b5SKevin Wolf { 4072e1795b5SKevin Wolf BlockJob *job = opaque; 408a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 4092e1795b5SKevin Wolf 4102e1795b5SKevin Wolf if (block_job_is_internal(job)) { 4112e1795b5SKevin Wolf return; 4122e1795b5SKevin Wolf } 4132e1795b5SKevin Wolf 414a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 415a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 416a7b4f8fcSEmanuele Giuseppe Esposito 4172e1795b5SKevin Wolf qapi_event_send_block_job_ready(job_type(&job->job), 4182e1795b5SKevin Wolf job->job.id, 419a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 420a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 4213ab72385SPeter Xu job->speed); 4222e1795b5SKevin Wolf } 4232e1795b5SKevin Wolf 4242e1795b5SKevin Wolf 42588691b37SPaolo Bonzini /* 42688691b37SPaolo Bonzini * API for block job drivers and the block layer. These functions are 42788691b37SPaolo Bonzini * declared in blockjob_int.h. 42888691b37SPaolo Bonzini */ 42988691b37SPaolo Bonzini 43088691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver, 43162c9e416SKevin Wolf JobTxn *txn, BlockDriverState *bs, uint64_t perm, 43288691b37SPaolo Bonzini uint64_t shared_perm, int64_t speed, int flags, 43388691b37SPaolo Bonzini BlockCompletionFunc *cb, void *opaque, Error **errp) 43488691b37SPaolo Bonzini { 43588691b37SPaolo Bonzini BlockJob *job; 436*985cac8fSVladimir Sementsov-Ogievskiy int ret; 43788691b37SPaolo Bonzini 438bb02b65cSKevin Wolf if (job_id == NULL && !(flags & JOB_INTERNAL)) { 43988691b37SPaolo Bonzini job_id = bdrv_get_device_name(bs); 44088691b37SPaolo Bonzini } 44188691b37SPaolo Bonzini 442*985cac8fSVladimir Sementsov-Ogievskiy job = job_create(job_id, &driver->job_driver, txn, bdrv_get_aio_context(bs), 4434ad35181SKevin Wolf flags, cb, opaque, errp); 44433e9e9bdSKevin Wolf if (job == NULL) { 44533e9e9bdSKevin Wolf return NULL; 44633e9e9bdSKevin Wolf } 44733e9e9bdSKevin Wolf 448e7c1d78bSKevin Wolf assert(is_block_job(&job->job)); 44980fa2c75SKevin Wolf assert(job->job.driver->free == &block_job_free); 450b15de828SKevin Wolf assert(job->job.driver->user_resume == &block_job_user_resume); 451e7c1d78bSKevin Wolf 4524951967dSPaolo Bonzini ratelimit_init(&job->limit); 4534951967dSPaolo Bonzini 454139a9f02SKevin Wolf job->finalize_cancelled_notifier.notify = block_job_event_cancelled; 455139a9f02SKevin Wolf job->finalize_completed_notifier.notify = block_job_event_completed; 456139a9f02SKevin Wolf job->pending_notifier.notify = block_job_event_pending; 4572e1795b5SKevin Wolf job->ready_notifier.notify = block_job_event_ready; 45834dc97b9SKevin Wolf job->idle_notifier.notify = block_job_on_idle; 459139a9f02SKevin Wolf 460139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_cancelled, 461139a9f02SKevin Wolf &job->finalize_cancelled_notifier); 462139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_completed, 463139a9f02SKevin Wolf &job->finalize_completed_notifier); 464139a9f02SKevin Wolf notifier_list_add(&job->job.on_pending, &job->pending_notifier); 4652e1795b5SKevin Wolf notifier_list_add(&job->job.on_ready, &job->ready_notifier); 46634dc97b9SKevin Wolf notifier_list_add(&job->job.on_idle, &job->idle_notifier); 467139a9f02SKevin Wolf 46888691b37SPaolo Bonzini error_setg(&job->blocker, "block device is in use by block job: %s", 469252291eaSKevin Wolf job_type_str(&job->job)); 470*985cac8fSVladimir Sementsov-Ogievskiy 471*985cac8fSVladimir Sementsov-Ogievskiy ret = block_job_add_bdrv(job, "main node", bs, perm, shared_perm, errp); 472*985cac8fSVladimir Sementsov-Ogievskiy if (ret < 0) { 473*985cac8fSVladimir Sementsov-Ogievskiy goto fail; 474*985cac8fSVladimir Sementsov-Ogievskiy } 47588691b37SPaolo Bonzini 47688691b37SPaolo Bonzini bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 47788691b37SPaolo Bonzini 478775d0c05SVladimir Sementsov-Ogievskiy if (!block_job_set_speed(job, speed, errp)) { 479*985cac8fSVladimir Sementsov-Ogievskiy goto fail; 48088691b37SPaolo Bonzini } 48175859b94SJohn Snow 48288691b37SPaolo Bonzini return job; 483*985cac8fSVladimir Sementsov-Ogievskiy 484*985cac8fSVladimir Sementsov-Ogievskiy fail: 485*985cac8fSVladimir Sementsov-Ogievskiy job_early_fail(&job->job); 486*985cac8fSVladimir Sementsov-Ogievskiy return NULL; 48788691b37SPaolo Bonzini } 48888691b37SPaolo Bonzini 4892caf63a9SPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 4902caf63a9SPaolo Bonzini { 4914c241cf5SPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 4924c241cf5SPaolo Bonzini return; 4934c241cf5SPaolo Bonzini } 494b15de828SKevin Wolf assert(job->job.user_paused && job->job.pause_count > 0); 4952caf63a9SPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 4962caf63a9SPaolo Bonzini } 4972caf63a9SPaolo Bonzini 498b15de828SKevin Wolf void block_job_user_resume(Job *job) 499b15de828SKevin Wolf { 500b15de828SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 501b15de828SKevin Wolf block_job_iostatus_reset(bjob); 502b15de828SKevin Wolf } 503b15de828SKevin Wolf 50481e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 50532c81a4aSPaolo Bonzini int is_read, int error) 50632c81a4aSPaolo Bonzini { 50732c81a4aSPaolo Bonzini BlockErrorAction action; 50832c81a4aSPaolo Bonzini 50932c81a4aSPaolo Bonzini switch (on_err) { 51032c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 5118c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 512a589569fSWenchao Xia action = (error == ENOSPC) ? 513a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 51432c81a4aSPaolo Bonzini break; 51532c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 516a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 51732c81a4aSPaolo Bonzini break; 51832c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 519a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 52032c81a4aSPaolo Bonzini break; 52132c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 522a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 52332c81a4aSPaolo Bonzini break; 52432c81a4aSPaolo Bonzini default: 52532c81a4aSPaolo Bonzini abort(); 52632c81a4aSPaolo Bonzini } 527559b935fSJohn Snow if (!block_job_is_internal(job)) { 52833e9e9bdSKevin Wolf qapi_event_send_block_job_error(job->job.id, 5295a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 5305a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 5313ab72385SPeter Xu action); 532559b935fSJohn Snow } 533a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 5348d9648cbSVladimir Sementsov-Ogievskiy if (!job->job.user_paused) { 535b15de828SKevin Wolf job_pause(&job->job); 536751ebd76SFam Zheng /* make the pause user visible, which will be resumed from QMP. */ 537b15de828SKevin Wolf job->job.user_paused = true; 5388d9648cbSVladimir Sementsov-Ogievskiy } 53932c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 54032c81a4aSPaolo Bonzini } 54132c81a4aSPaolo Bonzini return action; 54232c81a4aSPaolo Bonzini } 543df9a3165SVladimir Sementsov-Ogievskiy 544df9a3165SVladimir Sementsov-Ogievskiy AioContext *block_job_get_aio_context(BlockJob *job) 545df9a3165SVladimir Sementsov-Ogievskiy { 546df9a3165SVladimir Sementsov-Ogievskiy return job->job.aio_context; 547df9a3165SVladimir Sementsov-Ogievskiy } 548