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" 36*db725815SMarkus 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); 8980fa2c75SKevin Wolf blk_unref(bjob->blk); 9080fa2c75SKevin Wolf error_free(bjob->blocker); 9105b0d8e3SPaolo Bonzini } 9205b0d8e3SPaolo Bonzini 93b69f777dSKevin Wolf void block_job_drain(Job *job) 94bae8196dSPaolo Bonzini { 95b69f777dSKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 969f6bb4c0SKevin Wolf const JobDriver *drv = job->driver; 979f6bb4c0SKevin Wolf BlockJobDriver *bjdrv = container_of(drv, BlockJobDriver, job_driver); 98bae8196dSPaolo Bonzini 99b69f777dSKevin Wolf blk_drain(bjob->blk); 1009f6bb4c0SKevin Wolf if (bjdrv->drain) { 1019f6bb4c0SKevin Wolf bjdrv->drain(bjob); 102bae8196dSPaolo Bonzini } 103bae8196dSPaolo Bonzini } 104bae8196dSPaolo Bonzini 105f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c) 106f321dcb5SPaolo Bonzini { 107f321dcb5SPaolo Bonzini BlockJob *job = c->opaque; 108252291eaSKevin Wolf return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); 109f321dcb5SPaolo Bonzini } 110f321dcb5SPaolo Bonzini 111ad90febaSKevin Wolf static void child_job_drained_begin(BdrvChild *c) 112f321dcb5SPaolo Bonzini { 113ad90febaSKevin Wolf BlockJob *job = c->opaque; 114b15de828SKevin Wolf job_pause(&job->job); 115f321dcb5SPaolo Bonzini } 116f321dcb5SPaolo Bonzini 11789bd0305SKevin Wolf static bool child_job_drained_poll(BdrvChild *c) 11889bd0305SKevin Wolf { 11989bd0305SKevin Wolf BlockJob *bjob = c->opaque; 12089bd0305SKevin Wolf Job *job = &bjob->job; 12189bd0305SKevin Wolf const BlockJobDriver *drv = block_job_driver(bjob); 12289bd0305SKevin Wolf 12389bd0305SKevin Wolf /* An inactive or completed job doesn't have any pending requests. Jobs 12489bd0305SKevin Wolf * with !job->busy are either already paused or have a pause point after 12589bd0305SKevin Wolf * being reentered, so no job driver code will run before they pause. */ 126b5a7a057SKevin Wolf if (!job->busy || job_is_completed(job)) { 12789bd0305SKevin Wolf return false; 12889bd0305SKevin Wolf } 12989bd0305SKevin Wolf 13089bd0305SKevin Wolf /* Otherwise, assume that it isn't fully stopped yet, but allow the job to 13189bd0305SKevin Wolf * override this assumption. */ 13289bd0305SKevin Wolf if (drv->drained_poll) { 13389bd0305SKevin Wolf return drv->drained_poll(bjob); 13489bd0305SKevin Wolf } else { 13589bd0305SKevin Wolf return true; 13689bd0305SKevin Wolf } 13789bd0305SKevin Wolf } 13889bd0305SKevin Wolf 139e037c09cSMax Reitz static void child_job_drained_end(BdrvChild *c, int *drained_end_counter) 140f321dcb5SPaolo Bonzini { 141ad90febaSKevin Wolf BlockJob *job = c->opaque; 142b15de828SKevin Wolf job_resume(&job->job); 143f321dcb5SPaolo Bonzini } 144f321dcb5SPaolo Bonzini 1459ff7f0dfSKevin Wolf static bool child_job_can_set_aio_ctx(BdrvChild *c, AioContext *ctx, 1469ff7f0dfSKevin Wolf GSList **ignore, Error **errp) 1479ff7f0dfSKevin Wolf { 1489ff7f0dfSKevin Wolf BlockJob *job = c->opaque; 1499ff7f0dfSKevin Wolf GSList *l; 1509ff7f0dfSKevin Wolf 1519ff7f0dfSKevin Wolf for (l = job->nodes; l; l = l->next) { 1529ff7f0dfSKevin Wolf BdrvChild *sibling = l->data; 1539ff7f0dfSKevin Wolf if (!bdrv_child_can_set_aio_context(sibling, ctx, ignore, errp)) { 1549ff7f0dfSKevin Wolf return false; 1559ff7f0dfSKevin Wolf } 1569ff7f0dfSKevin Wolf } 1579ff7f0dfSKevin Wolf return true; 1589ff7f0dfSKevin Wolf } 1599ff7f0dfSKevin Wolf 1609ff7f0dfSKevin Wolf static void child_job_set_aio_ctx(BdrvChild *c, AioContext *ctx, 1619ff7f0dfSKevin Wolf GSList **ignore) 1629ff7f0dfSKevin Wolf { 1639ff7f0dfSKevin Wolf BlockJob *job = c->opaque; 1649ff7f0dfSKevin Wolf GSList *l; 1659ff7f0dfSKevin Wolf 1669ff7f0dfSKevin Wolf for (l = job->nodes; l; l = l->next) { 1679ff7f0dfSKevin Wolf BdrvChild *sibling = l->data; 1689ff7f0dfSKevin Wolf if (g_slist_find(*ignore, sibling)) { 1699ff7f0dfSKevin Wolf continue; 1709ff7f0dfSKevin Wolf } 1719ff7f0dfSKevin Wolf *ignore = g_slist_prepend(*ignore, sibling); 1729ff7f0dfSKevin Wolf bdrv_set_aio_context_ignore(sibling->bs, ctx, ignore); 1739ff7f0dfSKevin Wolf } 174657e1203SKevin Wolf 175657e1203SKevin Wolf job->job.aio_context = ctx; 1769ff7f0dfSKevin Wolf } 1779ff7f0dfSKevin Wolf 178ad90febaSKevin Wolf static const BdrvChildRole child_job = { 179ad90febaSKevin Wolf .get_parent_desc = child_job_get_parent_desc, 180ad90febaSKevin Wolf .drained_begin = child_job_drained_begin, 18189bd0305SKevin Wolf .drained_poll = child_job_drained_poll, 182ad90febaSKevin Wolf .drained_end = child_job_drained_end, 1839ff7f0dfSKevin Wolf .can_set_aio_ctx = child_job_can_set_aio_ctx, 1849ff7f0dfSKevin Wolf .set_aio_ctx = child_job_set_aio_ctx, 185ad90febaSKevin Wolf .stay_at_node = true, 186f321dcb5SPaolo Bonzini }; 187f321dcb5SPaolo Bonzini 188bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job) 189bbc02b90SKevin Wolf { 190bbc02b90SKevin Wolf GSList *l; 191bbc02b90SKevin Wolf for (l = job->nodes; l; l = l->next) { 192bbc02b90SKevin Wolf BdrvChild *c = l->data; 193bbc02b90SKevin Wolf bdrv_op_unblock_all(c->bs, job->blocker); 194bbc02b90SKevin Wolf bdrv_root_unref_child(c); 195bbc02b90SKevin Wolf } 196bbc02b90SKevin Wolf g_slist_free(job->nodes); 197bbc02b90SKevin Wolf job->nodes = NULL; 198bbc02b90SKevin Wolf } 199bbc02b90SKevin Wolf 2008164102fSVladimir Sementsov-Ogievskiy bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs) 2018164102fSVladimir Sementsov-Ogievskiy { 2028164102fSVladimir Sementsov-Ogievskiy GSList *el; 2038164102fSVladimir Sementsov-Ogievskiy 2048164102fSVladimir Sementsov-Ogievskiy for (el = job->nodes; el; el = el->next) { 2058164102fSVladimir Sementsov-Ogievskiy BdrvChild *c = el->data; 2068164102fSVladimir Sementsov-Ogievskiy if (c->bs == bs) { 2078164102fSVladimir Sementsov-Ogievskiy return true; 2088164102fSVladimir Sementsov-Ogievskiy } 2098164102fSVladimir Sementsov-Ogievskiy } 2108164102fSVladimir Sementsov-Ogievskiy 2118164102fSVladimir Sementsov-Ogievskiy return false; 2128164102fSVladimir Sementsov-Ogievskiy } 2138164102fSVladimir Sementsov-Ogievskiy 21476d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 21576d554e2SKevin Wolf uint64_t perm, uint64_t shared_perm, Error **errp) 21623d402d4SAlberto Garcia { 21776d554e2SKevin Wolf BdrvChild *c; 21876d554e2SKevin Wolf 219b441dc71SAlberto Garcia bdrv_ref(bs); 220132ada80SKevin Wolf if (job->job.aio_context != qemu_get_aio_context()) { 221132ada80SKevin Wolf aio_context_release(job->job.aio_context); 222132ada80SKevin Wolf } 223132ada80SKevin Wolf c = bdrv_root_attach_child(bs, name, &child_job, job->job.aio_context, 224132ada80SKevin Wolf perm, shared_perm, job, errp); 225132ada80SKevin Wolf if (job->job.aio_context != qemu_get_aio_context()) { 226132ada80SKevin Wolf aio_context_acquire(job->job.aio_context); 227132ada80SKevin Wolf } 22876d554e2SKevin Wolf if (c == NULL) { 22976d554e2SKevin Wolf return -EPERM; 23076d554e2SKevin Wolf } 23176d554e2SKevin Wolf 23276d554e2SKevin Wolf job->nodes = g_slist_prepend(job->nodes, c); 23323d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 23476d554e2SKevin Wolf 23576d554e2SKevin Wolf return 0; 23623d402d4SAlberto Garcia } 23723d402d4SAlberto Garcia 23834dc97b9SKevin Wolf static void block_job_on_idle(Notifier *n, void *opaque) 23934dc97b9SKevin Wolf { 240cfe29d82SKevin Wolf aio_wait_kick(); 24134dc97b9SKevin Wolf } 24234dc97b9SKevin Wolf 243559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 244559b935fSJohn Snow { 24533e9e9bdSKevin Wolf return (job->job.id == NULL); 246559b935fSJohn Snow } 247559b935fSJohn Snow 248bd21935bSKevin Wolf const BlockJobDriver *block_job_driver(BlockJob *job) 249bd21935bSKevin Wolf { 2509f6bb4c0SKevin Wolf return container_of(job->job.driver, BlockJobDriver, job_driver); 251bd21935bSKevin Wolf } 252bd21935bSKevin Wolf 253da01ff7fSKevin Wolf /* Assumes the job_mutex is held */ 254da01ff7fSKevin Wolf static bool job_timer_pending(Job *job) 255da01ff7fSKevin Wolf { 256da01ff7fSKevin Wolf return timer_pending(&job->sleep_timer); 257da01ff7fSKevin Wolf } 258da01ff7fSKevin Wolf 2592f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 2602f0c9fe6SPaolo Bonzini { 261aa9ef2e6SJohn Snow int64_t old_speed = job->speed; 2622f0c9fe6SPaolo Bonzini 263a50c2ab8SKevin Wolf if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp)) { 2640ec4dfb8SJohn Snow return; 2650ec4dfb8SJohn Snow } 26618bb6928SKevin Wolf if (speed < 0) { 26718bb6928SKevin Wolf error_setg(errp, QERR_INVALID_PARAMETER, "speed"); 2682f0c9fe6SPaolo Bonzini return; 2692f0c9fe6SPaolo Bonzini } 2702f0c9fe6SPaolo Bonzini 27118bb6928SKevin Wolf ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); 27218bb6928SKevin Wolf 2732f0c9fe6SPaolo Bonzini job->speed = speed; 274d4fce188SJohn Snow if (speed && speed <= old_speed) { 275aa9ef2e6SJohn Snow return; 276aa9ef2e6SJohn Snow } 277aa9ef2e6SJohn Snow 278aa9ef2e6SJohn Snow /* kick only if a timer is pending */ 279da01ff7fSKevin Wolf job_enter_cond(&job->job, job_timer_pending); 2802f0c9fe6SPaolo Bonzini } 2812f0c9fe6SPaolo Bonzini 282dee81d51SKevin Wolf int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) 283dee81d51SKevin Wolf { 284dee81d51SKevin Wolf if (!job->speed) { 285dee81d51SKevin Wolf return 0; 286dee81d51SKevin Wolf } 287dee81d51SKevin Wolf 288dee81d51SKevin Wolf return ratelimit_calculate_delay(&job->limit, n); 289dee81d51SKevin Wolf } 290dee81d51SKevin Wolf 291559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp) 29230e628b7SPaolo Bonzini { 293559b935fSJohn Snow BlockJobInfo *info; 294559b935fSJohn Snow 295559b935fSJohn Snow if (block_job_is_internal(job)) { 296559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 297559b935fSJohn Snow return NULL; 298559b935fSJohn Snow } 299559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 300252291eaSKevin Wolf info->type = g_strdup(job_type_str(&job->job)); 30133e9e9bdSKevin Wolf info->device = g_strdup(job->job.id); 302da01ff7fSKevin Wolf info->busy = atomic_read(&job->job.busy); 303da01ff7fSKevin Wolf info->paused = job->job.pause_count > 0; 30430a5c887SKevin Wolf info->offset = job->job.progress_current; 30530a5c887SKevin Wolf info->len = job->job.progress_total; 30630e628b7SPaolo Bonzini info->speed = job->speed; 30732c81a4aSPaolo Bonzini info->io_status = job->iostatus; 308df956ae2SKevin Wolf info->ready = job_is_ready(&job->job), 309a50c2ab8SKevin Wolf info->status = job->job.status; 310bb02b65cSKevin Wolf info->auto_finalize = job->job.auto_finalize; 311bb02b65cSKevin Wolf info->auto_dismiss = job->job.auto_dismiss; 3124ad35181SKevin Wolf info->has_error = job->job.ret != 0; 3134ad35181SKevin Wolf info->error = job->job.ret ? g_strdup(strerror(-job->job.ret)) : NULL; 31430e628b7SPaolo Bonzini return info; 31530e628b7SPaolo Bonzini } 31632c81a4aSPaolo Bonzini 31732c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 31832c81a4aSPaolo Bonzini { 31932c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 32032c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 32132c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 32232c81a4aSPaolo Bonzini } 32332c81a4aSPaolo Bonzini } 32432c81a4aSPaolo Bonzini 325139a9f02SKevin Wolf static void block_job_event_cancelled(Notifier *n, void *opaque) 326a66a2a36SPaolo Bonzini { 327139a9f02SKevin Wolf BlockJob *job = opaque; 328139a9f02SKevin Wolf 329559b935fSJohn Snow if (block_job_is_internal(job)) { 330559b935fSJohn Snow return; 331559b935fSJohn Snow } 332559b935fSJohn Snow 333252291eaSKevin Wolf qapi_event_send_block_job_cancelled(job_type(&job->job), 33433e9e9bdSKevin Wolf job->job.id, 33530a5c887SKevin Wolf job->job.progress_total, 33630a5c887SKevin Wolf job->job.progress_current, 3373ab72385SPeter Xu job->speed); 338a66a2a36SPaolo Bonzini } 339a66a2a36SPaolo Bonzini 340139a9f02SKevin Wolf static void block_job_event_completed(Notifier *n, void *opaque) 341a66a2a36SPaolo Bonzini { 342139a9f02SKevin Wolf BlockJob *job = opaque; 343139a9f02SKevin Wolf const char *msg = NULL; 344139a9f02SKevin Wolf 345559b935fSJohn Snow if (block_job_is_internal(job)) { 346559b935fSJohn Snow return; 347559b935fSJohn Snow } 348559b935fSJohn Snow 3494ad35181SKevin Wolf if (job->job.ret < 0) { 3504ad35181SKevin Wolf msg = strerror(-job->job.ret); 351139a9f02SKevin Wolf } 352139a9f02SKevin Wolf 353252291eaSKevin Wolf qapi_event_send_block_job_completed(job_type(&job->job), 35433e9e9bdSKevin Wolf job->job.id, 35530a5c887SKevin Wolf job->job.progress_total, 35630a5c887SKevin Wolf job->job.progress_current, 357bcada37bSWenchao Xia job->speed, 358bcada37bSWenchao Xia !!msg, 3593ab72385SPeter Xu msg); 360bcada37bSWenchao Xia } 361bcada37bSWenchao Xia 362139a9f02SKevin Wolf static void block_job_event_pending(Notifier *n, void *opaque) 3635f241594SJohn Snow { 364139a9f02SKevin Wolf BlockJob *job = opaque; 365139a9f02SKevin Wolf 3665d4f3769SKevin Wolf if (block_job_is_internal(job)) { 3675d4f3769SKevin Wolf return; 3685d4f3769SKevin Wolf } 3695d4f3769SKevin Wolf 370252291eaSKevin Wolf qapi_event_send_block_job_pending(job_type(&job->job), 3713ab72385SPeter Xu job->job.id); 3725f241594SJohn Snow } 3735f241594SJohn Snow 3742e1795b5SKevin Wolf static void block_job_event_ready(Notifier *n, void *opaque) 3752e1795b5SKevin Wolf { 3762e1795b5SKevin Wolf BlockJob *job = opaque; 3772e1795b5SKevin Wolf 3782e1795b5SKevin Wolf if (block_job_is_internal(job)) { 3792e1795b5SKevin Wolf return; 3802e1795b5SKevin Wolf } 3812e1795b5SKevin Wolf 3822e1795b5SKevin Wolf qapi_event_send_block_job_ready(job_type(&job->job), 3832e1795b5SKevin Wolf job->job.id, 38430a5c887SKevin Wolf job->job.progress_total, 38530a5c887SKevin Wolf job->job.progress_current, 3863ab72385SPeter Xu job->speed); 3872e1795b5SKevin Wolf } 3882e1795b5SKevin Wolf 3892e1795b5SKevin Wolf 39088691b37SPaolo Bonzini /* 39188691b37SPaolo Bonzini * API for block job drivers and the block layer. These functions are 39288691b37SPaolo Bonzini * declared in blockjob_int.h. 39388691b37SPaolo Bonzini */ 39488691b37SPaolo Bonzini 39588691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver, 39662c9e416SKevin Wolf JobTxn *txn, BlockDriverState *bs, uint64_t perm, 39788691b37SPaolo Bonzini uint64_t shared_perm, int64_t speed, int flags, 39888691b37SPaolo Bonzini BlockCompletionFunc *cb, void *opaque, Error **errp) 39988691b37SPaolo Bonzini { 40088691b37SPaolo Bonzini BlockBackend *blk; 40188691b37SPaolo Bonzini BlockJob *job; 40288691b37SPaolo Bonzini int ret; 40388691b37SPaolo Bonzini 404bb02b65cSKevin Wolf if (job_id == NULL && !(flags & JOB_INTERNAL)) { 40588691b37SPaolo Bonzini job_id = bdrv_get_device_name(bs); 40688691b37SPaolo Bonzini } 40788691b37SPaolo Bonzini 408d861ab3aSKevin Wolf blk = blk_new(bdrv_get_aio_context(bs), perm, shared_perm); 40988691b37SPaolo Bonzini ret = blk_insert_bs(blk, bs, errp); 41088691b37SPaolo Bonzini if (ret < 0) { 41188691b37SPaolo Bonzini blk_unref(blk); 41288691b37SPaolo Bonzini return NULL; 41388691b37SPaolo Bonzini } 41488691b37SPaolo Bonzini 4157eaa8fb5SKevin Wolf job = job_create(job_id, &driver->job_driver, txn, blk_get_aio_context(blk), 4164ad35181SKevin Wolf flags, cb, opaque, errp); 41733e9e9bdSKevin Wolf if (job == NULL) { 41833e9e9bdSKevin Wolf blk_unref(blk); 41933e9e9bdSKevin Wolf return NULL; 42033e9e9bdSKevin Wolf } 42133e9e9bdSKevin Wolf 422e7c1d78bSKevin Wolf assert(is_block_job(&job->job)); 42380fa2c75SKevin Wolf assert(job->job.driver->free == &block_job_free); 424b15de828SKevin Wolf assert(job->job.driver->user_resume == &block_job_user_resume); 425b69f777dSKevin Wolf assert(job->job.driver->drain == &block_job_drain); 426e7c1d78bSKevin Wolf 42788691b37SPaolo Bonzini job->blk = blk; 42888691b37SPaolo Bonzini 429139a9f02SKevin Wolf job->finalize_cancelled_notifier.notify = block_job_event_cancelled; 430139a9f02SKevin Wolf job->finalize_completed_notifier.notify = block_job_event_completed; 431139a9f02SKevin Wolf job->pending_notifier.notify = block_job_event_pending; 4322e1795b5SKevin Wolf job->ready_notifier.notify = block_job_event_ready; 43334dc97b9SKevin Wolf job->idle_notifier.notify = block_job_on_idle; 434139a9f02SKevin Wolf 435139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_cancelled, 436139a9f02SKevin Wolf &job->finalize_cancelled_notifier); 437139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_completed, 438139a9f02SKevin Wolf &job->finalize_completed_notifier); 439139a9f02SKevin Wolf notifier_list_add(&job->job.on_pending, &job->pending_notifier); 4402e1795b5SKevin Wolf notifier_list_add(&job->job.on_ready, &job->ready_notifier); 44134dc97b9SKevin Wolf notifier_list_add(&job->job.on_idle, &job->idle_notifier); 442139a9f02SKevin Wolf 44388691b37SPaolo Bonzini error_setg(&job->blocker, "block device is in use by block job: %s", 444252291eaSKevin Wolf job_type_str(&job->job)); 44588691b37SPaolo Bonzini block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); 44688691b37SPaolo Bonzini 44788691b37SPaolo Bonzini bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 44888691b37SPaolo Bonzini 4499ff7f0dfSKevin Wolf blk_set_allow_aio_context_change(blk, true); 45088691b37SPaolo Bonzini 45188691b37SPaolo Bonzini /* Only set speed when necessary to avoid NotSupported error */ 45288691b37SPaolo Bonzini if (speed != 0) { 45388691b37SPaolo Bonzini Error *local_err = NULL; 45488691b37SPaolo Bonzini 45588691b37SPaolo Bonzini block_job_set_speed(job, speed, &local_err); 45688691b37SPaolo Bonzini if (local_err) { 4574ad35181SKevin Wolf job_early_fail(&job->job); 45888691b37SPaolo Bonzini error_propagate(errp, local_err); 45988691b37SPaolo Bonzini return NULL; 46088691b37SPaolo Bonzini } 46188691b37SPaolo Bonzini } 46275859b94SJohn Snow 46388691b37SPaolo Bonzini return job; 46488691b37SPaolo Bonzini } 46588691b37SPaolo Bonzini 4662caf63a9SPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 4672caf63a9SPaolo Bonzini { 4684c241cf5SPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 4694c241cf5SPaolo Bonzini return; 4704c241cf5SPaolo Bonzini } 471b15de828SKevin Wolf assert(job->job.user_paused && job->job.pause_count > 0); 4722caf63a9SPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 4732caf63a9SPaolo Bonzini } 4742caf63a9SPaolo Bonzini 475b15de828SKevin Wolf void block_job_user_resume(Job *job) 476b15de828SKevin Wolf { 477b15de828SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 478b15de828SKevin Wolf block_job_iostatus_reset(bjob); 479b15de828SKevin Wolf } 480b15de828SKevin Wolf 48181e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 48232c81a4aSPaolo Bonzini int is_read, int error) 48332c81a4aSPaolo Bonzini { 48432c81a4aSPaolo Bonzini BlockErrorAction action; 48532c81a4aSPaolo Bonzini 48632c81a4aSPaolo Bonzini switch (on_err) { 48732c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 4888c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 489a589569fSWenchao Xia action = (error == ENOSPC) ? 490a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 49132c81a4aSPaolo Bonzini break; 49232c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 493a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 49432c81a4aSPaolo Bonzini break; 49532c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 496a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 49732c81a4aSPaolo Bonzini break; 49832c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 499a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 50032c81a4aSPaolo Bonzini break; 50132c81a4aSPaolo Bonzini default: 50232c81a4aSPaolo Bonzini abort(); 50332c81a4aSPaolo Bonzini } 504559b935fSJohn Snow if (!block_job_is_internal(job)) { 50533e9e9bdSKevin Wolf qapi_event_send_block_job_error(job->job.id, 5065a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 5075a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 5083ab72385SPeter Xu action); 509559b935fSJohn Snow } 510a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 5118d9648cbSVladimir Sementsov-Ogievskiy if (!job->job.user_paused) { 512b15de828SKevin Wolf job_pause(&job->job); 513751ebd76SFam Zheng /* make the pause user visible, which will be resumed from QMP. */ 514b15de828SKevin Wolf job->job.user_paused = true; 5158d9648cbSVladimir Sementsov-Ogievskiy } 51632c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 51732c81a4aSPaolo Bonzini } 51832c81a4aSPaolo Bonzini return action; 51932c81a4aSPaolo Bonzini } 520