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" 361de7afc9SPaolo Bonzini #include "qemu/timer.h" 372f0c9fe6SPaolo Bonzini 3888691b37SPaolo Bonzini /* 3988691b37SPaolo Bonzini * The block job API is composed of two categories of functions. 4088691b37SPaolo Bonzini * 4188691b37SPaolo Bonzini * The first includes functions used by the monitor. The monitor is 4288691b37SPaolo Bonzini * peculiar in that it accesses the block job list with block_job_get, and 4388691b37SPaolo Bonzini * therefore needs consistency across block_job_get and the actual operation 4488691b37SPaolo Bonzini * (e.g. block_job_set_speed). The consistency is achieved with 4588691b37SPaolo Bonzini * aio_context_acquire/release. These functions are declared in blockjob.h. 4688691b37SPaolo Bonzini * 4788691b37SPaolo Bonzini * The second includes functions used by the block job drivers and sometimes 4888691b37SPaolo Bonzini * by the core block layer. These do not care about locking, because the 4988691b37SPaolo Bonzini * whole coroutine runs under the AioContext lock, and are declared in 5088691b37SPaolo Bonzini * blockjob_int.h. 5188691b37SPaolo Bonzini */ 5288691b37SPaolo Bonzini 53e7c1d78bSKevin Wolf static bool is_block_job(Job *job) 54a7112795SAlberto Garcia { 55e7c1d78bSKevin Wolf return job_type(job) == JOB_TYPE_BACKUP || 56e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_COMMIT || 57e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_MIRROR || 58e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_STREAM; 59a7112795SAlberto Garcia } 60e7c1d78bSKevin Wolf 61e7c1d78bSKevin Wolf BlockJob *block_job_next(BlockJob *bjob) 62e7c1d78bSKevin Wolf { 63e7c1d78bSKevin Wolf Job *job = bjob ? &bjob->job : NULL; 64e7c1d78bSKevin Wolf 65e7c1d78bSKevin Wolf do { 66e7c1d78bSKevin Wolf job = job_next(job); 67e7c1d78bSKevin Wolf } while (job && !is_block_job(job)); 68e7c1d78bSKevin Wolf 69e7c1d78bSKevin Wolf return job ? container_of(job, BlockJob, job) : NULL; 70a7112795SAlberto Garcia } 71a7112795SAlberto Garcia 72ffb1f10cSAlberto Garcia BlockJob *block_job_get(const char *id) 73ffb1f10cSAlberto Garcia { 74e7c1d78bSKevin Wolf Job *job = job_get(id); 75ffb1f10cSAlberto Garcia 76e7c1d78bSKevin Wolf if (job && is_block_job(job)) { 77e7c1d78bSKevin Wolf return container_of(job, BlockJob, job); 78e7c1d78bSKevin Wolf } else { 79ffb1f10cSAlberto Garcia return NULL; 80ffb1f10cSAlberto Garcia } 81e7c1d78bSKevin Wolf } 82ffb1f10cSAlberto Garcia 8380fa2c75SKevin Wolf void block_job_free(Job *job) 8405b0d8e3SPaolo Bonzini { 8580fa2c75SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 8680fa2c75SKevin Wolf BlockDriverState *bs = blk_bs(bjob->blk); 8780fa2c75SKevin Wolf 8805b0d8e3SPaolo Bonzini bs->job = NULL; 8980fa2c75SKevin Wolf block_job_remove_all_bdrv(bjob); 9080fa2c75SKevin Wolf blk_unref(bjob->blk); 9180fa2c75SKevin Wolf error_free(bjob->blocker); 9205b0d8e3SPaolo Bonzini } 9305b0d8e3SPaolo Bonzini 94b69f777dSKevin Wolf void block_job_drain(Job *job) 95bae8196dSPaolo Bonzini { 96b69f777dSKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 979f6bb4c0SKevin Wolf const JobDriver *drv = job->driver; 989f6bb4c0SKevin Wolf BlockJobDriver *bjdrv = container_of(drv, BlockJobDriver, job_driver); 99bae8196dSPaolo Bonzini 100b69f777dSKevin Wolf blk_drain(bjob->blk); 1019f6bb4c0SKevin Wolf if (bjdrv->drain) { 1029f6bb4c0SKevin Wolf bjdrv->drain(bjob); 103bae8196dSPaolo Bonzini } 104bae8196dSPaolo Bonzini } 105bae8196dSPaolo Bonzini 106f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c) 107f321dcb5SPaolo Bonzini { 108f321dcb5SPaolo Bonzini BlockJob *job = c->opaque; 109252291eaSKevin Wolf return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); 110f321dcb5SPaolo Bonzini } 111f321dcb5SPaolo Bonzini 112ad90febaSKevin Wolf static void child_job_drained_begin(BdrvChild *c) 113f321dcb5SPaolo Bonzini { 114ad90febaSKevin Wolf BlockJob *job = c->opaque; 115b15de828SKevin Wolf job_pause(&job->job); 116f321dcb5SPaolo Bonzini } 117f321dcb5SPaolo Bonzini 11889bd0305SKevin Wolf static bool child_job_drained_poll(BdrvChild *c) 11989bd0305SKevin Wolf { 12089bd0305SKevin Wolf BlockJob *bjob = c->opaque; 12189bd0305SKevin Wolf Job *job = &bjob->job; 12289bd0305SKevin Wolf const BlockJobDriver *drv = block_job_driver(bjob); 12389bd0305SKevin Wolf 12489bd0305SKevin Wolf /* An inactive or completed job doesn't have any pending requests. Jobs 12589bd0305SKevin Wolf * with !job->busy are either already paused or have a pause point after 12689bd0305SKevin Wolf * being reentered, so no job driver code will run before they pause. */ 127b5a7a057SKevin Wolf if (!job->busy || job_is_completed(job)) { 12889bd0305SKevin Wolf return false; 12989bd0305SKevin Wolf } 13089bd0305SKevin Wolf 13189bd0305SKevin Wolf /* Otherwise, assume that it isn't fully stopped yet, but allow the job to 13289bd0305SKevin Wolf * override this assumption. */ 13389bd0305SKevin Wolf if (drv->drained_poll) { 13489bd0305SKevin Wolf return drv->drained_poll(bjob); 13589bd0305SKevin Wolf } else { 13689bd0305SKevin Wolf return true; 13789bd0305SKevin Wolf } 13889bd0305SKevin Wolf } 13989bd0305SKevin Wolf 140ad90febaSKevin Wolf static void child_job_drained_end(BdrvChild *c) 141f321dcb5SPaolo Bonzini { 142ad90febaSKevin Wolf BlockJob *job = c->opaque; 143b15de828SKevin Wolf job_resume(&job->job); 144f321dcb5SPaolo Bonzini } 145f321dcb5SPaolo Bonzini 1469ff7f0dfSKevin Wolf static bool child_job_can_set_aio_ctx(BdrvChild *c, AioContext *ctx, 1479ff7f0dfSKevin Wolf GSList **ignore, Error **errp) 1489ff7f0dfSKevin Wolf { 1499ff7f0dfSKevin Wolf BlockJob *job = c->opaque; 1509ff7f0dfSKevin Wolf GSList *l; 1519ff7f0dfSKevin Wolf 1529ff7f0dfSKevin Wolf for (l = job->nodes; l; l = l->next) { 1539ff7f0dfSKevin Wolf BdrvChild *sibling = l->data; 1549ff7f0dfSKevin Wolf if (!bdrv_child_can_set_aio_context(sibling, ctx, ignore, errp)) { 1559ff7f0dfSKevin Wolf return false; 1569ff7f0dfSKevin Wolf } 1579ff7f0dfSKevin Wolf } 1589ff7f0dfSKevin Wolf return true; 1599ff7f0dfSKevin Wolf } 1609ff7f0dfSKevin Wolf 1619ff7f0dfSKevin Wolf static void child_job_set_aio_ctx(BdrvChild *c, AioContext *ctx, 1629ff7f0dfSKevin Wolf GSList **ignore) 1639ff7f0dfSKevin Wolf { 1649ff7f0dfSKevin Wolf BlockJob *job = c->opaque; 1659ff7f0dfSKevin Wolf GSList *l; 1669ff7f0dfSKevin Wolf 1679ff7f0dfSKevin Wolf for (l = job->nodes; l; l = l->next) { 1689ff7f0dfSKevin Wolf BdrvChild *sibling = l->data; 1699ff7f0dfSKevin Wolf if (g_slist_find(*ignore, sibling)) { 1709ff7f0dfSKevin Wolf continue; 1719ff7f0dfSKevin Wolf } 1729ff7f0dfSKevin Wolf *ignore = g_slist_prepend(*ignore, sibling); 1739ff7f0dfSKevin Wolf bdrv_set_aio_context_ignore(sibling->bs, ctx, ignore); 1749ff7f0dfSKevin Wolf } 175657e1203SKevin Wolf 176657e1203SKevin Wolf job->job.aio_context = ctx; 1779ff7f0dfSKevin Wolf } 1789ff7f0dfSKevin Wolf 179ad90febaSKevin Wolf static const BdrvChildRole child_job = { 180ad90febaSKevin Wolf .get_parent_desc = child_job_get_parent_desc, 181ad90febaSKevin Wolf .drained_begin = child_job_drained_begin, 18289bd0305SKevin Wolf .drained_poll = child_job_drained_poll, 183ad90febaSKevin Wolf .drained_end = child_job_drained_end, 1849ff7f0dfSKevin Wolf .can_set_aio_ctx = child_job_can_set_aio_ctx, 1859ff7f0dfSKevin Wolf .set_aio_ctx = child_job_set_aio_ctx, 186ad90febaSKevin Wolf .stay_at_node = true, 187f321dcb5SPaolo Bonzini }; 188f321dcb5SPaolo Bonzini 189bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job) 190bbc02b90SKevin Wolf { 191bbc02b90SKevin Wolf GSList *l; 192bbc02b90SKevin Wolf for (l = job->nodes; l; l = l->next) { 193bbc02b90SKevin Wolf BdrvChild *c = l->data; 194bbc02b90SKevin Wolf bdrv_op_unblock_all(c->bs, job->blocker); 195bbc02b90SKevin Wolf bdrv_root_unref_child(c); 196bbc02b90SKevin Wolf } 197bbc02b90SKevin Wolf g_slist_free(job->nodes); 198bbc02b90SKevin Wolf job->nodes = NULL; 199bbc02b90SKevin Wolf } 200bbc02b90SKevin Wolf 201*8164102fSVladimir Sementsov-Ogievskiy bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs) 202*8164102fSVladimir Sementsov-Ogievskiy { 203*8164102fSVladimir Sementsov-Ogievskiy GSList *el; 204*8164102fSVladimir Sementsov-Ogievskiy 205*8164102fSVladimir Sementsov-Ogievskiy for (el = job->nodes; el; el = el->next) { 206*8164102fSVladimir Sementsov-Ogievskiy BdrvChild *c = el->data; 207*8164102fSVladimir Sementsov-Ogievskiy if (c->bs == bs) { 208*8164102fSVladimir Sementsov-Ogievskiy return true; 209*8164102fSVladimir Sementsov-Ogievskiy } 210*8164102fSVladimir Sementsov-Ogievskiy } 211*8164102fSVladimir Sementsov-Ogievskiy 212*8164102fSVladimir Sementsov-Ogievskiy return false; 213*8164102fSVladimir Sementsov-Ogievskiy } 214*8164102fSVladimir Sementsov-Ogievskiy 21576d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 21676d554e2SKevin Wolf uint64_t perm, uint64_t shared_perm, Error **errp) 21723d402d4SAlberto Garcia { 21876d554e2SKevin Wolf BdrvChild *c; 21976d554e2SKevin Wolf 220b441dc71SAlberto Garcia bdrv_ref(bs); 221132ada80SKevin Wolf if (job->job.aio_context != qemu_get_aio_context()) { 222132ada80SKevin Wolf aio_context_release(job->job.aio_context); 223132ada80SKevin Wolf } 224132ada80SKevin Wolf c = bdrv_root_attach_child(bs, name, &child_job, job->job.aio_context, 225132ada80SKevin Wolf perm, shared_perm, job, errp); 226132ada80SKevin Wolf if (job->job.aio_context != qemu_get_aio_context()) { 227132ada80SKevin Wolf aio_context_acquire(job->job.aio_context); 228132ada80SKevin Wolf } 22976d554e2SKevin Wolf if (c == NULL) { 23076d554e2SKevin Wolf return -EPERM; 23176d554e2SKevin Wolf } 23276d554e2SKevin Wolf 23376d554e2SKevin Wolf job->nodes = g_slist_prepend(job->nodes, c); 23423d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 23576d554e2SKevin Wolf 23676d554e2SKevin Wolf return 0; 23723d402d4SAlberto Garcia } 23823d402d4SAlberto Garcia 23934dc97b9SKevin Wolf static void block_job_on_idle(Notifier *n, void *opaque) 24034dc97b9SKevin Wolf { 241cfe29d82SKevin Wolf aio_wait_kick(); 24234dc97b9SKevin Wolf } 24334dc97b9SKevin Wolf 244559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 245559b935fSJohn Snow { 24633e9e9bdSKevin Wolf return (job->job.id == NULL); 247559b935fSJohn Snow } 248559b935fSJohn Snow 249bd21935bSKevin Wolf const BlockJobDriver *block_job_driver(BlockJob *job) 250bd21935bSKevin Wolf { 2519f6bb4c0SKevin Wolf return container_of(job->job.driver, BlockJobDriver, job_driver); 252bd21935bSKevin Wolf } 253bd21935bSKevin Wolf 254da01ff7fSKevin Wolf /* Assumes the job_mutex is held */ 255da01ff7fSKevin Wolf static bool job_timer_pending(Job *job) 256da01ff7fSKevin Wolf { 257da01ff7fSKevin Wolf return timer_pending(&job->sleep_timer); 258da01ff7fSKevin Wolf } 259da01ff7fSKevin Wolf 2602f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 2612f0c9fe6SPaolo Bonzini { 262aa9ef2e6SJohn Snow int64_t old_speed = job->speed; 2632f0c9fe6SPaolo Bonzini 264a50c2ab8SKevin Wolf if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp)) { 2650ec4dfb8SJohn Snow return; 2660ec4dfb8SJohn Snow } 26718bb6928SKevin Wolf if (speed < 0) { 26818bb6928SKevin Wolf error_setg(errp, QERR_INVALID_PARAMETER, "speed"); 2692f0c9fe6SPaolo Bonzini return; 2702f0c9fe6SPaolo Bonzini } 2712f0c9fe6SPaolo Bonzini 27218bb6928SKevin Wolf ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); 27318bb6928SKevin Wolf 2742f0c9fe6SPaolo Bonzini job->speed = speed; 275d4fce188SJohn Snow if (speed && speed <= old_speed) { 276aa9ef2e6SJohn Snow return; 277aa9ef2e6SJohn Snow } 278aa9ef2e6SJohn Snow 279aa9ef2e6SJohn Snow /* kick only if a timer is pending */ 280da01ff7fSKevin Wolf job_enter_cond(&job->job, job_timer_pending); 2812f0c9fe6SPaolo Bonzini } 2822f0c9fe6SPaolo Bonzini 283dee81d51SKevin Wolf int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) 284dee81d51SKevin Wolf { 285dee81d51SKevin Wolf if (!job->speed) { 286dee81d51SKevin Wolf return 0; 287dee81d51SKevin Wolf } 288dee81d51SKevin Wolf 289dee81d51SKevin Wolf return ratelimit_calculate_delay(&job->limit, n); 290dee81d51SKevin Wolf } 291dee81d51SKevin Wolf 292559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp) 29330e628b7SPaolo Bonzini { 294559b935fSJohn Snow BlockJobInfo *info; 295559b935fSJohn Snow 296559b935fSJohn Snow if (block_job_is_internal(job)) { 297559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 298559b935fSJohn Snow return NULL; 299559b935fSJohn Snow } 300559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 301252291eaSKevin Wolf info->type = g_strdup(job_type_str(&job->job)); 30233e9e9bdSKevin Wolf info->device = g_strdup(job->job.id); 303da01ff7fSKevin Wolf info->busy = atomic_read(&job->job.busy); 304da01ff7fSKevin Wolf info->paused = job->job.pause_count > 0; 30530a5c887SKevin Wolf info->offset = job->job.progress_current; 30630a5c887SKevin Wolf info->len = job->job.progress_total; 30730e628b7SPaolo Bonzini info->speed = job->speed; 30832c81a4aSPaolo Bonzini info->io_status = job->iostatus; 309df956ae2SKevin Wolf info->ready = job_is_ready(&job->job), 310a50c2ab8SKevin Wolf info->status = job->job.status; 311bb02b65cSKevin Wolf info->auto_finalize = job->job.auto_finalize; 312bb02b65cSKevin Wolf info->auto_dismiss = job->job.auto_dismiss; 3134ad35181SKevin Wolf info->has_error = job->job.ret != 0; 3144ad35181SKevin Wolf info->error = job->job.ret ? g_strdup(strerror(-job->job.ret)) : NULL; 31530e628b7SPaolo Bonzini return info; 31630e628b7SPaolo Bonzini } 31732c81a4aSPaolo Bonzini 31832c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 31932c81a4aSPaolo Bonzini { 32032c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 32132c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 32232c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 32332c81a4aSPaolo Bonzini } 32432c81a4aSPaolo Bonzini } 32532c81a4aSPaolo Bonzini 326139a9f02SKevin Wolf static void block_job_event_cancelled(Notifier *n, void *opaque) 327a66a2a36SPaolo Bonzini { 328139a9f02SKevin Wolf BlockJob *job = opaque; 329139a9f02SKevin Wolf 330559b935fSJohn Snow if (block_job_is_internal(job)) { 331559b935fSJohn Snow return; 332559b935fSJohn Snow } 333559b935fSJohn Snow 334252291eaSKevin Wolf qapi_event_send_block_job_cancelled(job_type(&job->job), 33533e9e9bdSKevin Wolf job->job.id, 33630a5c887SKevin Wolf job->job.progress_total, 33730a5c887SKevin Wolf job->job.progress_current, 3383ab72385SPeter Xu job->speed); 339a66a2a36SPaolo Bonzini } 340a66a2a36SPaolo Bonzini 341139a9f02SKevin Wolf static void block_job_event_completed(Notifier *n, void *opaque) 342a66a2a36SPaolo Bonzini { 343139a9f02SKevin Wolf BlockJob *job = opaque; 344139a9f02SKevin Wolf const char *msg = NULL; 345139a9f02SKevin Wolf 346559b935fSJohn Snow if (block_job_is_internal(job)) { 347559b935fSJohn Snow return; 348559b935fSJohn Snow } 349559b935fSJohn Snow 3504ad35181SKevin Wolf if (job->job.ret < 0) { 3514ad35181SKevin Wolf msg = strerror(-job->job.ret); 352139a9f02SKevin Wolf } 353139a9f02SKevin Wolf 354252291eaSKevin Wolf qapi_event_send_block_job_completed(job_type(&job->job), 35533e9e9bdSKevin Wolf job->job.id, 35630a5c887SKevin Wolf job->job.progress_total, 35730a5c887SKevin Wolf job->job.progress_current, 358bcada37bSWenchao Xia job->speed, 359bcada37bSWenchao Xia !!msg, 3603ab72385SPeter Xu msg); 361bcada37bSWenchao Xia } 362bcada37bSWenchao Xia 363139a9f02SKevin Wolf static void block_job_event_pending(Notifier *n, void *opaque) 3645f241594SJohn Snow { 365139a9f02SKevin Wolf BlockJob *job = opaque; 366139a9f02SKevin Wolf 3675d4f3769SKevin Wolf if (block_job_is_internal(job)) { 3685d4f3769SKevin Wolf return; 3695d4f3769SKevin Wolf } 3705d4f3769SKevin Wolf 371252291eaSKevin Wolf qapi_event_send_block_job_pending(job_type(&job->job), 3723ab72385SPeter Xu job->job.id); 3735f241594SJohn Snow } 3745f241594SJohn Snow 3752e1795b5SKevin Wolf static void block_job_event_ready(Notifier *n, void *opaque) 3762e1795b5SKevin Wolf { 3772e1795b5SKevin Wolf BlockJob *job = opaque; 3782e1795b5SKevin Wolf 3792e1795b5SKevin Wolf if (block_job_is_internal(job)) { 3802e1795b5SKevin Wolf return; 3812e1795b5SKevin Wolf } 3822e1795b5SKevin Wolf 3832e1795b5SKevin Wolf qapi_event_send_block_job_ready(job_type(&job->job), 3842e1795b5SKevin Wolf job->job.id, 38530a5c887SKevin Wolf job->job.progress_total, 38630a5c887SKevin Wolf job->job.progress_current, 3873ab72385SPeter Xu job->speed); 3882e1795b5SKevin Wolf } 3892e1795b5SKevin Wolf 3902e1795b5SKevin Wolf 39188691b37SPaolo Bonzini /* 39288691b37SPaolo Bonzini * API for block job drivers and the block layer. These functions are 39388691b37SPaolo Bonzini * declared in blockjob_int.h. 39488691b37SPaolo Bonzini */ 39588691b37SPaolo Bonzini 39688691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver, 39762c9e416SKevin Wolf JobTxn *txn, BlockDriverState *bs, uint64_t perm, 39888691b37SPaolo Bonzini uint64_t shared_perm, int64_t speed, int flags, 39988691b37SPaolo Bonzini BlockCompletionFunc *cb, void *opaque, Error **errp) 40088691b37SPaolo Bonzini { 40188691b37SPaolo Bonzini BlockBackend *blk; 40288691b37SPaolo Bonzini BlockJob *job; 40388691b37SPaolo Bonzini int ret; 40488691b37SPaolo Bonzini 40588691b37SPaolo Bonzini if (bs->job) { 40688691b37SPaolo Bonzini error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); 40788691b37SPaolo Bonzini return NULL; 40888691b37SPaolo Bonzini } 40988691b37SPaolo Bonzini 410bb02b65cSKevin Wolf if (job_id == NULL && !(flags & JOB_INTERNAL)) { 41188691b37SPaolo Bonzini job_id = bdrv_get_device_name(bs); 41288691b37SPaolo Bonzini } 41388691b37SPaolo Bonzini 414d861ab3aSKevin Wolf blk = blk_new(bdrv_get_aio_context(bs), perm, shared_perm); 41588691b37SPaolo Bonzini ret = blk_insert_bs(blk, bs, errp); 41688691b37SPaolo Bonzini if (ret < 0) { 41788691b37SPaolo Bonzini blk_unref(blk); 41888691b37SPaolo Bonzini return NULL; 41988691b37SPaolo Bonzini } 42088691b37SPaolo Bonzini 4217eaa8fb5SKevin Wolf job = job_create(job_id, &driver->job_driver, txn, blk_get_aio_context(blk), 4224ad35181SKevin Wolf flags, cb, opaque, errp); 42333e9e9bdSKevin Wolf if (job == NULL) { 42433e9e9bdSKevin Wolf blk_unref(blk); 42533e9e9bdSKevin Wolf return NULL; 42633e9e9bdSKevin Wolf } 42733e9e9bdSKevin Wolf 428e7c1d78bSKevin Wolf assert(is_block_job(&job->job)); 42980fa2c75SKevin Wolf assert(job->job.driver->free == &block_job_free); 430b15de828SKevin Wolf assert(job->job.driver->user_resume == &block_job_user_resume); 431b69f777dSKevin Wolf assert(job->job.driver->drain == &block_job_drain); 432e7c1d78bSKevin Wolf 43388691b37SPaolo Bonzini job->blk = blk; 43488691b37SPaolo Bonzini 435139a9f02SKevin Wolf job->finalize_cancelled_notifier.notify = block_job_event_cancelled; 436139a9f02SKevin Wolf job->finalize_completed_notifier.notify = block_job_event_completed; 437139a9f02SKevin Wolf job->pending_notifier.notify = block_job_event_pending; 4382e1795b5SKevin Wolf job->ready_notifier.notify = block_job_event_ready; 43934dc97b9SKevin Wolf job->idle_notifier.notify = block_job_on_idle; 440139a9f02SKevin Wolf 441139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_cancelled, 442139a9f02SKevin Wolf &job->finalize_cancelled_notifier); 443139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_completed, 444139a9f02SKevin Wolf &job->finalize_completed_notifier); 445139a9f02SKevin Wolf notifier_list_add(&job->job.on_pending, &job->pending_notifier); 4462e1795b5SKevin Wolf notifier_list_add(&job->job.on_ready, &job->ready_notifier); 44734dc97b9SKevin Wolf notifier_list_add(&job->job.on_idle, &job->idle_notifier); 448139a9f02SKevin Wolf 44988691b37SPaolo Bonzini error_setg(&job->blocker, "block device is in use by block job: %s", 450252291eaSKevin Wolf job_type_str(&job->job)); 45188691b37SPaolo Bonzini block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); 45288691b37SPaolo Bonzini bs->job = job; 45388691b37SPaolo Bonzini 45488691b37SPaolo Bonzini bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 45588691b37SPaolo Bonzini 4569ff7f0dfSKevin Wolf blk_set_allow_aio_context_change(blk, true); 45788691b37SPaolo Bonzini 45888691b37SPaolo Bonzini /* Only set speed when necessary to avoid NotSupported error */ 45988691b37SPaolo Bonzini if (speed != 0) { 46088691b37SPaolo Bonzini Error *local_err = NULL; 46188691b37SPaolo Bonzini 46288691b37SPaolo Bonzini block_job_set_speed(job, speed, &local_err); 46388691b37SPaolo Bonzini if (local_err) { 4644ad35181SKevin Wolf job_early_fail(&job->job); 46588691b37SPaolo Bonzini error_propagate(errp, local_err); 46688691b37SPaolo Bonzini return NULL; 46788691b37SPaolo Bonzini } 46888691b37SPaolo Bonzini } 46975859b94SJohn Snow 47088691b37SPaolo Bonzini return job; 47188691b37SPaolo Bonzini } 47288691b37SPaolo Bonzini 4732caf63a9SPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 4742caf63a9SPaolo Bonzini { 4754c241cf5SPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 4764c241cf5SPaolo Bonzini return; 4774c241cf5SPaolo Bonzini } 478b15de828SKevin Wolf assert(job->job.user_paused && job->job.pause_count > 0); 4792caf63a9SPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 4802caf63a9SPaolo Bonzini } 4812caf63a9SPaolo Bonzini 482b15de828SKevin Wolf void block_job_user_resume(Job *job) 483b15de828SKevin Wolf { 484b15de828SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 485b15de828SKevin Wolf block_job_iostatus_reset(bjob); 486b15de828SKevin Wolf } 487b15de828SKevin Wolf 48881e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 48932c81a4aSPaolo Bonzini int is_read, int error) 49032c81a4aSPaolo Bonzini { 49132c81a4aSPaolo Bonzini BlockErrorAction action; 49232c81a4aSPaolo Bonzini 49332c81a4aSPaolo Bonzini switch (on_err) { 49432c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 4958c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 496a589569fSWenchao Xia action = (error == ENOSPC) ? 497a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 49832c81a4aSPaolo Bonzini break; 49932c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 500a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 50132c81a4aSPaolo Bonzini break; 50232c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 503a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 50432c81a4aSPaolo Bonzini break; 50532c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 506a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 50732c81a4aSPaolo Bonzini break; 50832c81a4aSPaolo Bonzini default: 50932c81a4aSPaolo Bonzini abort(); 51032c81a4aSPaolo Bonzini } 511559b935fSJohn Snow if (!block_job_is_internal(job)) { 51233e9e9bdSKevin Wolf qapi_event_send_block_job_error(job->job.id, 5135a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 5145a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 5153ab72385SPeter Xu action); 516559b935fSJohn Snow } 517a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 5188d9648cbSVladimir Sementsov-Ogievskiy if (!job->job.user_paused) { 519b15de828SKevin Wolf job_pause(&job->job); 520751ebd76SFam Zheng /* make the pause user visible, which will be resumed from QMP. */ 521b15de828SKevin Wolf job->job.user_paused = true; 5228d9648cbSVladimir Sementsov-Ogievskiy } 52332c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 52432c81a4aSPaolo Bonzini } 52532c81a4aSPaolo Bonzini return action; 52632c81a4aSPaolo Bonzini } 527