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" 272f0c9fe6SPaolo Bonzini #include "qemu-common.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" 3610817bf0SDaniel P. Berrange #include "qemu/coroutine.h" 371de7afc9SPaolo Bonzini #include "qemu/timer.h" 382f0c9fe6SPaolo Bonzini 398254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job); 408254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg); 415f241594SJohn Snow static int block_job_event_pending(BlockJob *job); 428254b6d9SJohn Snow 43c55a832fSFam Zheng /* Transactional group of block jobs */ 44c55a832fSFam Zheng struct BlockJobTxn { 45c55a832fSFam Zheng 46c55a832fSFam Zheng /* Is this txn being cancelled? */ 47c55a832fSFam Zheng bool aborting; 48c55a832fSFam Zheng 49c55a832fSFam Zheng /* List of jobs */ 50c55a832fSFam Zheng QLIST_HEAD(, BlockJob) jobs; 51c55a832fSFam Zheng 52c55a832fSFam Zheng /* Reference count */ 53c55a832fSFam Zheng int refcnt; 54c55a832fSFam Zheng }; 55c55a832fSFam Zheng 5688691b37SPaolo Bonzini /* 5788691b37SPaolo Bonzini * The block job API is composed of two categories of functions. 5888691b37SPaolo Bonzini * 5988691b37SPaolo Bonzini * The first includes functions used by the monitor. The monitor is 6088691b37SPaolo Bonzini * peculiar in that it accesses the block job list with block_job_get, and 6188691b37SPaolo Bonzini * therefore needs consistency across block_job_get and the actual operation 6288691b37SPaolo Bonzini * (e.g. block_job_set_speed). The consistency is achieved with 6388691b37SPaolo Bonzini * aio_context_acquire/release. These functions are declared in blockjob.h. 6488691b37SPaolo Bonzini * 6588691b37SPaolo Bonzini * The second includes functions used by the block job drivers and sometimes 6688691b37SPaolo Bonzini * by the core block layer. These do not care about locking, because the 6788691b37SPaolo Bonzini * whole coroutine runs under the AioContext lock, and are declared in 6888691b37SPaolo Bonzini * blockjob_int.h. 6988691b37SPaolo Bonzini */ 7088691b37SPaolo Bonzini 71e7c1d78bSKevin Wolf static bool is_block_job(Job *job) 72a7112795SAlberto Garcia { 73e7c1d78bSKevin Wolf return job_type(job) == JOB_TYPE_BACKUP || 74e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_COMMIT || 75e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_MIRROR || 76e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_STREAM; 77a7112795SAlberto Garcia } 78e7c1d78bSKevin Wolf 79e7c1d78bSKevin Wolf BlockJob *block_job_next(BlockJob *bjob) 80e7c1d78bSKevin Wolf { 81e7c1d78bSKevin Wolf Job *job = bjob ? &bjob->job : NULL; 82e7c1d78bSKevin Wolf 83e7c1d78bSKevin Wolf do { 84e7c1d78bSKevin Wolf job = job_next(job); 85e7c1d78bSKevin Wolf } while (job && !is_block_job(job)); 86e7c1d78bSKevin Wolf 87e7c1d78bSKevin Wolf return job ? container_of(job, BlockJob, job) : NULL; 88a7112795SAlberto Garcia } 89a7112795SAlberto Garcia 90ffb1f10cSAlberto Garcia BlockJob *block_job_get(const char *id) 91ffb1f10cSAlberto Garcia { 92e7c1d78bSKevin Wolf Job *job = job_get(id); 93ffb1f10cSAlberto Garcia 94e7c1d78bSKevin Wolf if (job && is_block_job(job)) { 95e7c1d78bSKevin Wolf return container_of(job, BlockJob, job); 96e7c1d78bSKevin Wolf } else { 97ffb1f10cSAlberto Garcia return NULL; 98ffb1f10cSAlberto Garcia } 99e7c1d78bSKevin Wolf } 100ffb1f10cSAlberto Garcia 101c8ab5c2dSPaolo Bonzini BlockJobTxn *block_job_txn_new(void) 102c8ab5c2dSPaolo Bonzini { 103c8ab5c2dSPaolo Bonzini BlockJobTxn *txn = g_new0(BlockJobTxn, 1); 104c8ab5c2dSPaolo Bonzini QLIST_INIT(&txn->jobs); 105c8ab5c2dSPaolo Bonzini txn->refcnt = 1; 106c8ab5c2dSPaolo Bonzini return txn; 107c8ab5c2dSPaolo Bonzini } 108c8ab5c2dSPaolo Bonzini 109c8ab5c2dSPaolo Bonzini static void block_job_txn_ref(BlockJobTxn *txn) 110c8ab5c2dSPaolo Bonzini { 111c8ab5c2dSPaolo Bonzini txn->refcnt++; 112c8ab5c2dSPaolo Bonzini } 113c8ab5c2dSPaolo Bonzini 114c8ab5c2dSPaolo Bonzini void block_job_txn_unref(BlockJobTxn *txn) 115c8ab5c2dSPaolo Bonzini { 116c8ab5c2dSPaolo Bonzini if (txn && --txn->refcnt == 0) { 117c8ab5c2dSPaolo Bonzini g_free(txn); 118c8ab5c2dSPaolo Bonzini } 119c8ab5c2dSPaolo Bonzini } 120c8ab5c2dSPaolo Bonzini 121c8ab5c2dSPaolo Bonzini void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job) 122c8ab5c2dSPaolo Bonzini { 123c8ab5c2dSPaolo Bonzini if (!txn) { 124c8ab5c2dSPaolo Bonzini return; 125c8ab5c2dSPaolo Bonzini } 126c8ab5c2dSPaolo Bonzini 127c8ab5c2dSPaolo Bonzini assert(!job->txn); 128c8ab5c2dSPaolo Bonzini job->txn = txn; 129c8ab5c2dSPaolo Bonzini 130c8ab5c2dSPaolo Bonzini QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 131c8ab5c2dSPaolo Bonzini block_job_txn_ref(txn); 132c8ab5c2dSPaolo Bonzini } 133c8ab5c2dSPaolo Bonzini 134a865cebbSMarc-André Lureau static void block_job_txn_del_job(BlockJob *job) 135a865cebbSMarc-André Lureau { 136a865cebbSMarc-André Lureau if (job->txn) { 137a865cebbSMarc-André Lureau QLIST_REMOVE(job, txn_list); 138a865cebbSMarc-André Lureau block_job_txn_unref(job->txn); 139a865cebbSMarc-André Lureau job->txn = NULL; 140a865cebbSMarc-André Lureau } 141a865cebbSMarc-André Lureau } 142a865cebbSMarc-André Lureau 143*da01ff7fSKevin Wolf /* Assumes the job_mutex is held */ 144*da01ff7fSKevin Wolf static bool job_timer_not_pending(Job *job) 1454c7e813cSStefan Hajnoczi { 146*da01ff7fSKevin Wolf return !timer_pending(&job->sleep_timer); 1474c7e813cSStefan Hajnoczi } 1484c7e813cSStefan Hajnoczi 149f321dcb5SPaolo Bonzini static void block_job_pause(BlockJob *job) 150f321dcb5SPaolo Bonzini { 151*da01ff7fSKevin Wolf job->job.pause_count++; 152f321dcb5SPaolo Bonzini } 153f321dcb5SPaolo Bonzini 154f321dcb5SPaolo Bonzini static void block_job_resume(BlockJob *job) 155f321dcb5SPaolo Bonzini { 156*da01ff7fSKevin Wolf assert(job->job.pause_count > 0); 157*da01ff7fSKevin Wolf job->job.pause_count--; 158*da01ff7fSKevin Wolf if (job->job.pause_count) { 159f321dcb5SPaolo Bonzini return; 160f321dcb5SPaolo Bonzini } 1614c7e813cSStefan Hajnoczi 1624c7e813cSStefan Hajnoczi /* kick only if no timer is pending */ 163*da01ff7fSKevin Wolf job_enter_cond(&job->job, job_timer_not_pending); 164f321dcb5SPaolo Bonzini } 165f321dcb5SPaolo Bonzini 16605b0d8e3SPaolo Bonzini static void block_job_attached_aio_context(AioContext *new_context, 16705b0d8e3SPaolo Bonzini void *opaque); 16805b0d8e3SPaolo Bonzini static void block_job_detach_aio_context(void *opaque); 16905b0d8e3SPaolo Bonzini 17080fa2c75SKevin Wolf void block_job_free(Job *job) 17105b0d8e3SPaolo Bonzini { 17280fa2c75SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 17380fa2c75SKevin Wolf BlockDriverState *bs = blk_bs(bjob->blk); 17480fa2c75SKevin Wolf 17580fa2c75SKevin Wolf assert(!bjob->txn); 17680fa2c75SKevin Wolf 17705b0d8e3SPaolo Bonzini bs->job = NULL; 17880fa2c75SKevin Wolf block_job_remove_all_bdrv(bjob); 17980fa2c75SKevin Wolf blk_remove_aio_context_notifier(bjob->blk, 18005b0d8e3SPaolo Bonzini block_job_attached_aio_context, 18180fa2c75SKevin Wolf block_job_detach_aio_context, bjob); 18280fa2c75SKevin Wolf blk_unref(bjob->blk); 18380fa2c75SKevin Wolf error_free(bjob->blocker); 184*da01ff7fSKevin Wolf assert(!timer_pending(&bjob->job.sleep_timer)); 18505b0d8e3SPaolo Bonzini } 18605b0d8e3SPaolo Bonzini 187463e0be1SStefan Hajnoczi static void block_job_attached_aio_context(AioContext *new_context, 188463e0be1SStefan Hajnoczi void *opaque) 189463e0be1SStefan Hajnoczi { 190463e0be1SStefan Hajnoczi BlockJob *job = opaque; 191463e0be1SStefan Hajnoczi 19208be6fe2SKevin Wolf job->job.aio_context = new_context; 193463e0be1SStefan Hajnoczi if (job->driver->attached_aio_context) { 194463e0be1SStefan Hajnoczi job->driver->attached_aio_context(job, new_context); 195463e0be1SStefan Hajnoczi } 196463e0be1SStefan Hajnoczi 197463e0be1SStefan Hajnoczi block_job_resume(job); 198463e0be1SStefan Hajnoczi } 199463e0be1SStefan Hajnoczi 200bae8196dSPaolo Bonzini static void block_job_drain(BlockJob *job) 201bae8196dSPaolo Bonzini { 202*da01ff7fSKevin Wolf /* If job is !job->job.busy this kicks it into the next pause point. */ 203bae8196dSPaolo Bonzini block_job_enter(job); 204bae8196dSPaolo Bonzini 205bae8196dSPaolo Bonzini blk_drain(job->blk); 206bae8196dSPaolo Bonzini if (job->driver->drain) { 207bae8196dSPaolo Bonzini job->driver->drain(job); 208bae8196dSPaolo Bonzini } 209bae8196dSPaolo Bonzini } 210bae8196dSPaolo Bonzini 211463e0be1SStefan Hajnoczi static void block_job_detach_aio_context(void *opaque) 212463e0be1SStefan Hajnoczi { 213463e0be1SStefan Hajnoczi BlockJob *job = opaque; 214463e0be1SStefan Hajnoczi 215463e0be1SStefan Hajnoczi /* In case the job terminates during aio_poll()... */ 21680fa2c75SKevin Wolf job_ref(&job->job); 217463e0be1SStefan Hajnoczi 218463e0be1SStefan Hajnoczi block_job_pause(job); 219463e0be1SStefan Hajnoczi 220*da01ff7fSKevin Wolf while (!job->job.paused && !job->completed) { 221bae8196dSPaolo Bonzini block_job_drain(job); 222463e0be1SStefan Hajnoczi } 223463e0be1SStefan Hajnoczi 22408be6fe2SKevin Wolf job->job.aio_context = NULL; 22580fa2c75SKevin Wolf job_unref(&job->job); 226463e0be1SStefan Hajnoczi } 227463e0be1SStefan Hajnoczi 228f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c) 229f321dcb5SPaolo Bonzini { 230f321dcb5SPaolo Bonzini BlockJob *job = c->opaque; 231252291eaSKevin Wolf return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); 232f321dcb5SPaolo Bonzini } 233f321dcb5SPaolo Bonzini 234ad90febaSKevin Wolf static void child_job_drained_begin(BdrvChild *c) 235f321dcb5SPaolo Bonzini { 236ad90febaSKevin Wolf BlockJob *job = c->opaque; 237f321dcb5SPaolo Bonzini block_job_pause(job); 238f321dcb5SPaolo Bonzini } 239f321dcb5SPaolo Bonzini 240ad90febaSKevin Wolf static void child_job_drained_end(BdrvChild *c) 241f321dcb5SPaolo Bonzini { 242ad90febaSKevin Wolf BlockJob *job = c->opaque; 243f321dcb5SPaolo Bonzini block_job_resume(job); 244f321dcb5SPaolo Bonzini } 245f321dcb5SPaolo Bonzini 246ad90febaSKevin Wolf static const BdrvChildRole child_job = { 247ad90febaSKevin Wolf .get_parent_desc = child_job_get_parent_desc, 248ad90febaSKevin Wolf .drained_begin = child_job_drained_begin, 249ad90febaSKevin Wolf .drained_end = child_job_drained_end, 250ad90febaSKevin Wolf .stay_at_node = true, 251f321dcb5SPaolo Bonzini }; 252f321dcb5SPaolo Bonzini 253bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job) 254bbc02b90SKevin Wolf { 255bbc02b90SKevin Wolf GSList *l; 256bbc02b90SKevin Wolf for (l = job->nodes; l; l = l->next) { 257bbc02b90SKevin Wolf BdrvChild *c = l->data; 258bbc02b90SKevin Wolf bdrv_op_unblock_all(c->bs, job->blocker); 259bbc02b90SKevin Wolf bdrv_root_unref_child(c); 260bbc02b90SKevin Wolf } 261bbc02b90SKevin Wolf g_slist_free(job->nodes); 262bbc02b90SKevin Wolf job->nodes = NULL; 263bbc02b90SKevin Wolf } 264bbc02b90SKevin Wolf 26576d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 26676d554e2SKevin Wolf uint64_t perm, uint64_t shared_perm, Error **errp) 26723d402d4SAlberto Garcia { 26876d554e2SKevin Wolf BdrvChild *c; 26976d554e2SKevin Wolf 27076d554e2SKevin Wolf c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm, 27176d554e2SKevin Wolf job, errp); 27276d554e2SKevin Wolf if (c == NULL) { 27376d554e2SKevin Wolf return -EPERM; 27476d554e2SKevin Wolf } 27576d554e2SKevin Wolf 27676d554e2SKevin Wolf job->nodes = g_slist_prepend(job->nodes, c); 27723d402d4SAlberto Garcia bdrv_ref(bs); 27823d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 27976d554e2SKevin Wolf 28076d554e2SKevin Wolf return 0; 28123d402d4SAlberto Garcia } 28223d402d4SAlberto Garcia 283559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 284559b935fSJohn Snow { 28533e9e9bdSKevin Wolf return (job->job.id == NULL); 286559b935fSJohn Snow } 287559b935fSJohn Snow 288bd21935bSKevin Wolf const BlockJobDriver *block_job_driver(BlockJob *job) 289bd21935bSKevin Wolf { 290bd21935bSKevin Wolf return job->driver; 291bd21935bSKevin Wolf } 292bd21935bSKevin Wolf 293fc24908eSPaolo Bonzini static void block_job_sleep_timer_cb(void *opaque) 294fc24908eSPaolo Bonzini { 295fc24908eSPaolo Bonzini BlockJob *job = opaque; 296fc24908eSPaolo Bonzini 297fc24908eSPaolo Bonzini block_job_enter(job); 298fc24908eSPaolo Bonzini } 299fc24908eSPaolo Bonzini 3003925cd3bSJohn Snow static void block_job_decommission(BlockJob *job) 3013925cd3bSJohn Snow { 3023925cd3bSJohn Snow assert(job); 3033925cd3bSJohn Snow job->completed = true; 304*da01ff7fSKevin Wolf job->job.busy = false; 305*da01ff7fSKevin Wolf job->job.paused = false; 3061908a559SKevin Wolf job->job.deferred_to_main_loop = true; 307a865cebbSMarc-André Lureau block_job_txn_del_job(job); 308a50c2ab8SKevin Wolf job_state_transition(&job->job, JOB_STATUS_NULL); 30980fa2c75SKevin Wolf job_unref(&job->job); 3103925cd3bSJohn Snow } 3113925cd3bSJohn Snow 31275f71059SJohn Snow static void block_job_do_dismiss(BlockJob *job) 31375f71059SJohn Snow { 31475f71059SJohn Snow block_job_decommission(job); 31575f71059SJohn Snow } 31675f71059SJohn Snow 317e0cf0364SJohn Snow static void block_job_conclude(BlockJob *job) 318e0cf0364SJohn Snow { 319a50c2ab8SKevin Wolf job_state_transition(&job->job, JOB_STATUS_CONCLUDED); 320*da01ff7fSKevin Wolf if (job->auto_dismiss || !job_started(&job->job)) { 32175f71059SJohn Snow block_job_do_dismiss(job); 32275f71059SJohn Snow } 323e0cf0364SJohn Snow } 324e0cf0364SJohn Snow 32535d6b368SJohn Snow static void block_job_update_rc(BlockJob *job) 32635d6b368SJohn Snow { 327daa7f2f9SKevin Wolf if (!job->ret && job_is_cancelled(&job->job)) { 32835d6b368SJohn Snow job->ret = -ECANCELED; 32935d6b368SJohn Snow } 33035d6b368SJohn Snow if (job->ret) { 331a50c2ab8SKevin Wolf job_state_transition(&job->job, JOB_STATUS_ABORTING); 33235d6b368SJohn Snow } 33335d6b368SJohn Snow } 33435d6b368SJohn Snow 3352da4617aSJohn Snow static int block_job_prepare(BlockJob *job) 3362da4617aSJohn Snow { 3372da4617aSJohn Snow if (job->ret == 0 && job->driver->prepare) { 3382da4617aSJohn Snow job->ret = job->driver->prepare(job); 3392da4617aSJohn Snow } 3402da4617aSJohn Snow return job->ret; 3412da4617aSJohn Snow } 3422da4617aSJohn Snow 34343628d93SJohn Snow static void block_job_commit(BlockJob *job) 34443628d93SJohn Snow { 34543628d93SJohn Snow assert(!job->ret); 34643628d93SJohn Snow if (job->driver->commit) { 34743628d93SJohn Snow job->driver->commit(job); 34843628d93SJohn Snow } 34943628d93SJohn Snow } 35043628d93SJohn Snow 35143628d93SJohn Snow static void block_job_abort(BlockJob *job) 35243628d93SJohn Snow { 35343628d93SJohn Snow assert(job->ret); 35443628d93SJohn Snow if (job->driver->abort) { 35543628d93SJohn Snow job->driver->abort(job); 35643628d93SJohn Snow } 35743628d93SJohn Snow } 35843628d93SJohn Snow 35943628d93SJohn Snow static void block_job_clean(BlockJob *job) 36043628d93SJohn Snow { 36143628d93SJohn Snow if (job->driver->clean) { 36243628d93SJohn Snow job->driver->clean(job); 36343628d93SJohn Snow } 36443628d93SJohn Snow } 36543628d93SJohn Snow 36611b61fbcSJohn Snow static int block_job_finalize_single(BlockJob *job) 367c55a832fSFam Zheng { 3684fb588e9SPaolo Bonzini assert(job->completed); 3694fb588e9SPaolo Bonzini 37035d6b368SJohn Snow /* Ensure abort is called for late-transactional failures */ 37135d6b368SJohn Snow block_job_update_rc(job); 37210a3fbb0SJohn Snow 373c55a832fSFam Zheng if (!job->ret) { 37443628d93SJohn Snow block_job_commit(job); 375c55a832fSFam Zheng } else { 37643628d93SJohn Snow block_job_abort(job); 377c55a832fSFam Zheng } 37843628d93SJohn Snow block_job_clean(job); 3798254b6d9SJohn Snow 3808254b6d9SJohn Snow if (job->cb) { 381c55a832fSFam Zheng job->cb(job->opaque, job->ret); 3828254b6d9SJohn Snow } 3835ccac6f1SJohn Snow 3845ccac6f1SJohn Snow /* Emit events only if we actually started */ 385*da01ff7fSKevin Wolf if (job_started(&job->job)) { 386daa7f2f9SKevin Wolf if (job_is_cancelled(&job->job)) { 3878254b6d9SJohn Snow block_job_event_cancelled(job); 3888254b6d9SJohn Snow } else { 3898254b6d9SJohn Snow const char *msg = NULL; 3908254b6d9SJohn Snow if (job->ret < 0) { 3918254b6d9SJohn Snow msg = strerror(-job->ret); 3928254b6d9SJohn Snow } 3938254b6d9SJohn Snow block_job_event_completed(job, msg); 3948254b6d9SJohn Snow } 3955ccac6f1SJohn Snow } 3968254b6d9SJohn Snow 397a865cebbSMarc-André Lureau block_job_txn_del_job(job); 398e0cf0364SJohn Snow block_job_conclude(job); 3992da4617aSJohn Snow return 0; 400c55a832fSFam Zheng } 401c55a832fSFam Zheng 402b76e4458SLiang Li static void block_job_cancel_async(BlockJob *job, bool force) 4034c241cf5SPaolo Bonzini { 4044c241cf5SPaolo Bonzini if (job->iostatus != BLOCK_DEVICE_IO_STATUS_OK) { 4054c241cf5SPaolo Bonzini block_job_iostatus_reset(job); 4064c241cf5SPaolo Bonzini } 4074c241cf5SPaolo Bonzini if (job->user_paused) { 4084c241cf5SPaolo Bonzini /* Do not call block_job_enter here, the caller will handle it. */ 4094c241cf5SPaolo Bonzini job->user_paused = false; 410*da01ff7fSKevin Wolf job->job.pause_count--; 4114c241cf5SPaolo Bonzini } 412daa7f2f9SKevin Wolf job->job.cancelled = true; 413b76e4458SLiang Li /* To prevent 'force == false' overriding a previous 'force == true' */ 414b76e4458SLiang Li job->force |= force; 4154c241cf5SPaolo Bonzini } 4164c241cf5SPaolo Bonzini 4175f241594SJohn Snow static int block_job_txn_apply(BlockJobTxn *txn, int fn(BlockJob *), bool lock) 418efe4d4b7SJohn Snow { 419efe4d4b7SJohn Snow AioContext *ctx; 420efe4d4b7SJohn Snow BlockJob *job, *next; 4212da4617aSJohn Snow int rc = 0; 422efe4d4b7SJohn Snow 423efe4d4b7SJohn Snow QLIST_FOREACH_SAFE(job, &txn->jobs, txn_list, next) { 4245f241594SJohn Snow if (lock) { 425efe4d4b7SJohn Snow ctx = blk_get_aio_context(job->blk); 426efe4d4b7SJohn Snow aio_context_acquire(ctx); 4275f241594SJohn Snow } 4282da4617aSJohn Snow rc = fn(job); 4295f241594SJohn Snow if (lock) { 430efe4d4b7SJohn Snow aio_context_release(ctx); 4315f241594SJohn Snow } 4322da4617aSJohn Snow if (rc) { 4332da4617aSJohn Snow break; 434efe4d4b7SJohn Snow } 435efe4d4b7SJohn Snow } 4362da4617aSJohn Snow return rc; 4372da4617aSJohn Snow } 438efe4d4b7SJohn Snow 439c8ab5c2dSPaolo Bonzini static int block_job_finish_sync(BlockJob *job, 440c8ab5c2dSPaolo Bonzini void (*finish)(BlockJob *, Error **errp), 441c8ab5c2dSPaolo Bonzini Error **errp) 442c8ab5c2dSPaolo Bonzini { 443c8ab5c2dSPaolo Bonzini Error *local_err = NULL; 444c8ab5c2dSPaolo Bonzini int ret; 445c8ab5c2dSPaolo Bonzini 446c8ab5c2dSPaolo Bonzini assert(blk_bs(job->blk)->job == job); 447c8ab5c2dSPaolo Bonzini 44880fa2c75SKevin Wolf job_ref(&job->job); 449c8ab5c2dSPaolo Bonzini 4504fb588e9SPaolo Bonzini if (finish) { 451c8ab5c2dSPaolo Bonzini finish(job, &local_err); 4524fb588e9SPaolo Bonzini } 453c8ab5c2dSPaolo Bonzini if (local_err) { 454c8ab5c2dSPaolo Bonzini error_propagate(errp, local_err); 45580fa2c75SKevin Wolf job_unref(&job->job); 456c8ab5c2dSPaolo Bonzini return -EBUSY; 457c8ab5c2dSPaolo Bonzini } 458c8ab5c2dSPaolo Bonzini /* block_job_drain calls block_job_enter, and it should be enough to 459c8ab5c2dSPaolo Bonzini * induce progress until the job completes or moves to the main thread. 460c8ab5c2dSPaolo Bonzini */ 4611908a559SKevin Wolf while (!job->job.deferred_to_main_loop && !job->completed) { 462c8ab5c2dSPaolo Bonzini block_job_drain(job); 463c8ab5c2dSPaolo Bonzini } 464c8ab5c2dSPaolo Bonzini while (!job->completed) { 465c8ab5c2dSPaolo Bonzini aio_poll(qemu_get_aio_context(), true); 466c8ab5c2dSPaolo Bonzini } 467daa7f2f9SKevin Wolf ret = (job_is_cancelled(&job->job) && job->ret == 0) 468daa7f2f9SKevin Wolf ? -ECANCELED : job->ret; 46980fa2c75SKevin Wolf job_unref(&job->job); 470c8ab5c2dSPaolo Bonzini return ret; 471c8ab5c2dSPaolo Bonzini } 472c8ab5c2dSPaolo Bonzini 473c55a832fSFam Zheng static void block_job_completed_txn_abort(BlockJob *job) 474c55a832fSFam Zheng { 475c55a832fSFam Zheng AioContext *ctx; 476c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 4774fb588e9SPaolo Bonzini BlockJob *other_job; 478c55a832fSFam Zheng 479c55a832fSFam Zheng if (txn->aborting) { 480c55a832fSFam Zheng /* 481c55a832fSFam Zheng * We are cancelled by another job, which will handle everything. 482c55a832fSFam Zheng */ 483c55a832fSFam Zheng return; 484c55a832fSFam Zheng } 485c55a832fSFam Zheng txn->aborting = true; 4864fb588e9SPaolo Bonzini block_job_txn_ref(txn); 4874fb588e9SPaolo Bonzini 488c55a832fSFam Zheng /* We are the first failed job. Cancel other jobs. */ 489c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 490b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 491c55a832fSFam Zheng aio_context_acquire(ctx); 492c55a832fSFam Zheng } 4934fb588e9SPaolo Bonzini 4944fb588e9SPaolo Bonzini /* Other jobs are effectively cancelled by us, set the status for 495c55a832fSFam Zheng * them; this job, however, may or may not be cancelled, depending 496c55a832fSFam Zheng * on the caller, so leave it. */ 4974fb588e9SPaolo Bonzini QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 498c55a832fSFam Zheng if (other_job != job) { 499b76e4458SLiang Li block_job_cancel_async(other_job, false); 500c55a832fSFam Zheng } 501c55a832fSFam Zheng } 5024fb588e9SPaolo Bonzini while (!QLIST_EMPTY(&txn->jobs)) { 5034fb588e9SPaolo Bonzini other_job = QLIST_FIRST(&txn->jobs); 504b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 5054fb588e9SPaolo Bonzini if (!other_job->completed) { 506daa7f2f9SKevin Wolf assert(job_is_cancelled(&other_job->job)); 5074fb588e9SPaolo Bonzini block_job_finish_sync(other_job, NULL, NULL); 5084fb588e9SPaolo Bonzini } 50911b61fbcSJohn Snow block_job_finalize_single(other_job); 510c55a832fSFam Zheng aio_context_release(ctx); 511c55a832fSFam Zheng } 5124fb588e9SPaolo Bonzini 5134fb588e9SPaolo Bonzini block_job_txn_unref(txn); 514c55a832fSFam Zheng } 515c55a832fSFam Zheng 51611b61fbcSJohn Snow static int block_job_needs_finalize(BlockJob *job) 51711b61fbcSJohn Snow { 51811b61fbcSJohn Snow return !job->auto_finalize; 51911b61fbcSJohn Snow } 52011b61fbcSJohn Snow 52111b61fbcSJohn Snow static void block_job_do_finalize(BlockJob *job) 52211b61fbcSJohn Snow { 52311b61fbcSJohn Snow int rc; 52411b61fbcSJohn Snow assert(job && job->txn); 52511b61fbcSJohn Snow 52611b61fbcSJohn Snow /* prepare the transaction to complete */ 52711b61fbcSJohn Snow rc = block_job_txn_apply(job->txn, block_job_prepare, true); 52811b61fbcSJohn Snow if (rc) { 52911b61fbcSJohn Snow block_job_completed_txn_abort(job); 53011b61fbcSJohn Snow } else { 53111b61fbcSJohn Snow block_job_txn_apply(job->txn, block_job_finalize_single, true); 53211b61fbcSJohn Snow } 53311b61fbcSJohn Snow } 53411b61fbcSJohn Snow 535c55a832fSFam Zheng static void block_job_completed_txn_success(BlockJob *job) 536c55a832fSFam Zheng { 537c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 538efe4d4b7SJohn Snow BlockJob *other_job; 5392da4617aSJohn Snow 540a50c2ab8SKevin Wolf job_state_transition(&job->job, JOB_STATUS_WAITING); 541e8af5686SJohn Snow 542c55a832fSFam Zheng /* 543c55a832fSFam Zheng * Successful completion, see if there are other running jobs in this 544c55a832fSFam Zheng * txn. 545c55a832fSFam Zheng */ 546c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 547c55a832fSFam Zheng if (!other_job->completed) { 548c55a832fSFam Zheng return; 549c55a832fSFam Zheng } 550efe4d4b7SJohn Snow assert(other_job->ret == 0); 551c55a832fSFam Zheng } 5522da4617aSJohn Snow 5535f241594SJohn Snow block_job_txn_apply(txn, block_job_event_pending, false); 55411b61fbcSJohn Snow 55511b61fbcSJohn Snow /* If no jobs need manual finalization, automatically do so */ 55611b61fbcSJohn Snow if (block_job_txn_apply(txn, block_job_needs_finalize, false) == 0) { 55711b61fbcSJohn Snow block_job_do_finalize(job); 55811b61fbcSJohn Snow } 559c55a832fSFam Zheng } 560c55a832fSFam Zheng 561*da01ff7fSKevin Wolf /* Assumes the job_mutex is held */ 562*da01ff7fSKevin Wolf static bool job_timer_pending(Job *job) 563*da01ff7fSKevin Wolf { 564*da01ff7fSKevin Wolf return timer_pending(&job->sleep_timer); 565*da01ff7fSKevin Wolf } 566*da01ff7fSKevin Wolf 5672f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 5682f0c9fe6SPaolo Bonzini { 569aa9ef2e6SJohn Snow int64_t old_speed = job->speed; 5702f0c9fe6SPaolo Bonzini 571a50c2ab8SKevin Wolf if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp)) { 5720ec4dfb8SJohn Snow return; 5730ec4dfb8SJohn Snow } 57418bb6928SKevin Wolf if (speed < 0) { 57518bb6928SKevin Wolf error_setg(errp, QERR_INVALID_PARAMETER, "speed"); 5762f0c9fe6SPaolo Bonzini return; 5772f0c9fe6SPaolo Bonzini } 5782f0c9fe6SPaolo Bonzini 57918bb6928SKevin Wolf ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); 58018bb6928SKevin Wolf 5812f0c9fe6SPaolo Bonzini job->speed = speed; 582d4fce188SJohn Snow if (speed && speed <= old_speed) { 583aa9ef2e6SJohn Snow return; 584aa9ef2e6SJohn Snow } 585aa9ef2e6SJohn Snow 586aa9ef2e6SJohn Snow /* kick only if a timer is pending */ 587*da01ff7fSKevin Wolf job_enter_cond(&job->job, job_timer_pending); 5882f0c9fe6SPaolo Bonzini } 5892f0c9fe6SPaolo Bonzini 590dee81d51SKevin Wolf int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) 591dee81d51SKevin Wolf { 592dee81d51SKevin Wolf if (!job->speed) { 593dee81d51SKevin Wolf return 0; 594dee81d51SKevin Wolf } 595dee81d51SKevin Wolf 596dee81d51SKevin Wolf return ratelimit_calculate_delay(&job->limit, n); 597dee81d51SKevin Wolf } 598dee81d51SKevin Wolf 599aeae883bSPaolo Bonzini void block_job_complete(BlockJob *job, Error **errp) 600aeae883bSPaolo Bonzini { 601559b935fSJohn Snow /* Should not be reachable via external interface for internal jobs */ 60233e9e9bdSKevin Wolf assert(job->job.id); 603a50c2ab8SKevin Wolf if (job_apply_verb(&job->job, JOB_VERB_COMPLETE, errp)) { 6040ec4dfb8SJohn Snow return; 6050ec4dfb8SJohn Snow } 606*da01ff7fSKevin Wolf if (job->job.pause_count || job_is_cancelled(&job->job) || 607daa7f2f9SKevin Wolf !job->driver->complete) 608daa7f2f9SKevin Wolf { 6099df229c3SAlberto Garcia error_setg(errp, "The active block job '%s' cannot be completed", 61033e9e9bdSKevin Wolf job->job.id); 611aeae883bSPaolo Bonzini return; 612aeae883bSPaolo Bonzini } 613aeae883bSPaolo Bonzini 6143fc4b10aSFam Zheng job->driver->complete(job, errp); 615aeae883bSPaolo Bonzini } 616aeae883bSPaolo Bonzini 61711b61fbcSJohn Snow void block_job_finalize(BlockJob *job, Error **errp) 61811b61fbcSJohn Snow { 61933e9e9bdSKevin Wolf assert(job && job->job.id); 620a50c2ab8SKevin Wolf if (job_apply_verb(&job->job, JOB_VERB_FINALIZE, errp)) { 62111b61fbcSJohn Snow return; 62211b61fbcSJohn Snow } 62311b61fbcSJohn Snow block_job_do_finalize(job); 62411b61fbcSJohn Snow } 62511b61fbcSJohn Snow 62675f71059SJohn Snow void block_job_dismiss(BlockJob **jobptr, Error **errp) 62775f71059SJohn Snow { 62875f71059SJohn Snow BlockJob *job = *jobptr; 62975f71059SJohn Snow /* similarly to _complete, this is QMP-interface only. */ 63033e9e9bdSKevin Wolf assert(job->job.id); 631a50c2ab8SKevin Wolf if (job_apply_verb(&job->job, JOB_VERB_DISMISS, errp)) { 63275f71059SJohn Snow return; 63375f71059SJohn Snow } 63475f71059SJohn Snow 63575f71059SJohn Snow block_job_do_dismiss(job); 63675f71059SJohn Snow *jobptr = NULL; 63775f71059SJohn Snow } 63875f71059SJohn Snow 6390ec4dfb8SJohn Snow void block_job_user_pause(BlockJob *job, Error **errp) 6400df4ba58SJohn Snow { 641a50c2ab8SKevin Wolf if (job_apply_verb(&job->job, JOB_VERB_PAUSE, errp)) { 6420ec4dfb8SJohn Snow return; 6430ec4dfb8SJohn Snow } 6440ec4dfb8SJohn Snow if (job->user_paused) { 6450ec4dfb8SJohn Snow error_setg(errp, "Job is already paused"); 6460ec4dfb8SJohn Snow return; 6470ec4dfb8SJohn Snow } 6480df4ba58SJohn Snow job->user_paused = true; 6490df4ba58SJohn Snow block_job_pause(job); 6500df4ba58SJohn Snow } 6510df4ba58SJohn Snow 6520df4ba58SJohn Snow bool block_job_user_paused(BlockJob *job) 6530df4ba58SJohn Snow { 6546573d9c6SPaolo Bonzini return job->user_paused; 6550df4ba58SJohn Snow } 6560df4ba58SJohn Snow 6570ec4dfb8SJohn Snow void block_job_user_resume(BlockJob *job, Error **errp) 6580df4ba58SJohn Snow { 6590ec4dfb8SJohn Snow assert(job); 660*da01ff7fSKevin Wolf if (!job->user_paused || job->job.pause_count <= 0) { 6610ec4dfb8SJohn Snow error_setg(errp, "Can't resume a job that was not paused"); 6620ec4dfb8SJohn Snow return; 6630ec4dfb8SJohn Snow } 664a50c2ab8SKevin Wolf if (job_apply_verb(&job->job, JOB_VERB_RESUME, errp)) { 6650ec4dfb8SJohn Snow return; 6660ec4dfb8SJohn Snow } 6672caf63a9SPaolo Bonzini block_job_iostatus_reset(job); 6684c241cf5SPaolo Bonzini job->user_paused = false; 6690df4ba58SJohn Snow block_job_resume(job); 6700df4ba58SJohn Snow } 6710df4ba58SJohn Snow 672b76e4458SLiang Li void block_job_cancel(BlockJob *job, bool force) 6738acc72a4SPaolo Bonzini { 674a50c2ab8SKevin Wolf if (job->job.status == JOB_STATUS_CONCLUDED) { 67575f71059SJohn Snow block_job_do_dismiss(job); 67611b61fbcSJohn Snow return; 67711b61fbcSJohn Snow } 678b76e4458SLiang Li block_job_cancel_async(job, force); 679*da01ff7fSKevin Wolf if (!job_started(&job->job)) { 6805ccac6f1SJohn Snow block_job_completed(job, -ECANCELED); 6811908a559SKevin Wolf } else if (job->job.deferred_to_main_loop) { 68211b61fbcSJohn Snow block_job_completed_txn_abort(job); 68311b61fbcSJohn Snow } else { 68411b61fbcSJohn Snow block_job_enter(job); 6855ccac6f1SJohn Snow } 6868acc72a4SPaolo Bonzini } 6878acc72a4SPaolo Bonzini 688b76e4458SLiang Li void block_job_user_cancel(BlockJob *job, bool force, Error **errp) 6890ec4dfb8SJohn Snow { 690a50c2ab8SKevin Wolf if (job_apply_verb(&job->job, JOB_VERB_CANCEL, errp)) { 6910ec4dfb8SJohn Snow return; 6920ec4dfb8SJohn Snow } 693b76e4458SLiang Li block_job_cancel(job, force); 6940ec4dfb8SJohn Snow } 6950ec4dfb8SJohn Snow 696345f9e1bSMax Reitz /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be 697345f9e1bSMax Reitz * used with block_job_finish_sync() without the need for (rather nasty) 698345f9e1bSMax Reitz * function pointer casts there. */ 699345f9e1bSMax Reitz static void block_job_cancel_err(BlockJob *job, Error **errp) 700345f9e1bSMax Reitz { 701b76e4458SLiang Li block_job_cancel(job, false); 702345f9e1bSMax Reitz } 703345f9e1bSMax Reitz 704345f9e1bSMax Reitz int block_job_cancel_sync(BlockJob *job) 705345f9e1bSMax Reitz { 706345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_cancel_err, NULL); 707345f9e1bSMax Reitz } 708345f9e1bSMax Reitz 709a1a2af07SKevin Wolf void block_job_cancel_sync_all(void) 710a1a2af07SKevin Wolf { 711a1a2af07SKevin Wolf BlockJob *job; 712a1a2af07SKevin Wolf AioContext *aio_context; 713a1a2af07SKevin Wolf 714e7c1d78bSKevin Wolf while ((job = block_job_next(NULL))) { 715b6d2e599SKevin Wolf aio_context = blk_get_aio_context(job->blk); 716a1a2af07SKevin Wolf aio_context_acquire(aio_context); 717a1a2af07SKevin Wolf block_job_cancel_sync(job); 718a1a2af07SKevin Wolf aio_context_release(aio_context); 719a1a2af07SKevin Wolf } 720a1a2af07SKevin Wolf } 721a1a2af07SKevin Wolf 722345f9e1bSMax Reitz int block_job_complete_sync(BlockJob *job, Error **errp) 723345f9e1bSMax Reitz { 724345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_complete, errp); 725345f9e1bSMax Reitz } 726345f9e1bSMax Reitz 72705df8a6aSKevin Wolf void block_job_progress_update(BlockJob *job, uint64_t done) 72805df8a6aSKevin Wolf { 72905df8a6aSKevin Wolf job->offset += done; 73005df8a6aSKevin Wolf } 73105df8a6aSKevin Wolf 73205df8a6aSKevin Wolf void block_job_progress_set_remaining(BlockJob *job, uint64_t remaining) 73305df8a6aSKevin Wolf { 73405df8a6aSKevin Wolf job->len = job->offset + remaining; 73505df8a6aSKevin Wolf } 73605df8a6aSKevin Wolf 737559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp) 73830e628b7SPaolo Bonzini { 739559b935fSJohn Snow BlockJobInfo *info; 740559b935fSJohn Snow 741559b935fSJohn Snow if (block_job_is_internal(job)) { 742559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 743559b935fSJohn Snow return NULL; 744559b935fSJohn Snow } 745559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 746252291eaSKevin Wolf info->type = g_strdup(job_type_str(&job->job)); 74733e9e9bdSKevin Wolf info->device = g_strdup(job->job.id); 74830e628b7SPaolo Bonzini info->len = job->len; 749*da01ff7fSKevin Wolf info->busy = atomic_read(&job->job.busy); 750*da01ff7fSKevin Wolf info->paused = job->job.pause_count > 0; 75130e628b7SPaolo Bonzini info->offset = job->offset; 75230e628b7SPaolo Bonzini info->speed = job->speed; 75332c81a4aSPaolo Bonzini info->io_status = job->iostatus; 754ef6dbf1eSMax Reitz info->ready = job->ready; 755a50c2ab8SKevin Wolf info->status = job->job.status; 756b40dacdcSJohn Snow info->auto_finalize = job->auto_finalize; 757b40dacdcSJohn Snow info->auto_dismiss = job->auto_dismiss; 758ab9ba614SJohn Snow info->has_error = job->ret != 0; 759ab9ba614SJohn Snow info->error = job->ret ? g_strdup(strerror(-job->ret)) : NULL; 76030e628b7SPaolo Bonzini return info; 76130e628b7SPaolo Bonzini } 76232c81a4aSPaolo Bonzini 76332c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 76432c81a4aSPaolo Bonzini { 76532c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 76632c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 76732c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 76832c81a4aSPaolo Bonzini } 76932c81a4aSPaolo Bonzini } 77032c81a4aSPaolo Bonzini 7718254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job) 772a66a2a36SPaolo Bonzini { 773559b935fSJohn Snow if (block_job_is_internal(job)) { 774559b935fSJohn Snow return; 775559b935fSJohn Snow } 776559b935fSJohn Snow 777252291eaSKevin Wolf qapi_event_send_block_job_cancelled(job_type(&job->job), 77833e9e9bdSKevin Wolf job->job.id, 779a66a2a36SPaolo Bonzini job->len, 780a66a2a36SPaolo Bonzini job->offset, 781bcada37bSWenchao Xia job->speed, 782bcada37bSWenchao Xia &error_abort); 783a66a2a36SPaolo Bonzini } 784a66a2a36SPaolo Bonzini 7858254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg) 786a66a2a36SPaolo Bonzini { 787559b935fSJohn Snow if (block_job_is_internal(job)) { 788559b935fSJohn Snow return; 789559b935fSJohn Snow } 790559b935fSJohn Snow 791252291eaSKevin Wolf qapi_event_send_block_job_completed(job_type(&job->job), 79233e9e9bdSKevin Wolf job->job.id, 793bcada37bSWenchao Xia job->len, 794bcada37bSWenchao Xia job->offset, 795bcada37bSWenchao Xia job->speed, 796bcada37bSWenchao Xia !!msg, 797bcada37bSWenchao Xia msg, 798bcada37bSWenchao Xia &error_abort); 799bcada37bSWenchao Xia } 800bcada37bSWenchao Xia 8015f241594SJohn Snow static int block_job_event_pending(BlockJob *job) 8025f241594SJohn Snow { 803a50c2ab8SKevin Wolf job_state_transition(&job->job, JOB_STATUS_PENDING); 8045f241594SJohn Snow if (!job->auto_finalize && !block_job_is_internal(job)) { 805252291eaSKevin Wolf qapi_event_send_block_job_pending(job_type(&job->job), 80633e9e9bdSKevin Wolf job->job.id, 8075f241594SJohn Snow &error_abort); 8085f241594SJohn Snow } 8095f241594SJohn Snow return 0; 8105f241594SJohn Snow } 8115f241594SJohn Snow 81288691b37SPaolo Bonzini /* 81388691b37SPaolo Bonzini * API for block job drivers and the block layer. These functions are 81488691b37SPaolo Bonzini * declared in blockjob_int.h. 81588691b37SPaolo Bonzini */ 81688691b37SPaolo Bonzini 81788691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver, 81875859b94SJohn Snow BlockJobTxn *txn, BlockDriverState *bs, uint64_t perm, 81988691b37SPaolo Bonzini uint64_t shared_perm, int64_t speed, int flags, 82088691b37SPaolo Bonzini BlockCompletionFunc *cb, void *opaque, Error **errp) 82188691b37SPaolo Bonzini { 82288691b37SPaolo Bonzini BlockBackend *blk; 82388691b37SPaolo Bonzini BlockJob *job; 82488691b37SPaolo Bonzini int ret; 82588691b37SPaolo Bonzini 82688691b37SPaolo Bonzini if (bs->job) { 82788691b37SPaolo Bonzini error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); 82888691b37SPaolo Bonzini return NULL; 82988691b37SPaolo Bonzini } 83088691b37SPaolo Bonzini 83188691b37SPaolo Bonzini if (job_id == NULL && !(flags & BLOCK_JOB_INTERNAL)) { 83288691b37SPaolo Bonzini job_id = bdrv_get_device_name(bs); 83388691b37SPaolo Bonzini if (!*job_id) { 83488691b37SPaolo Bonzini error_setg(errp, "An explicit job ID is required for this node"); 83588691b37SPaolo Bonzini return NULL; 83688691b37SPaolo Bonzini } 83788691b37SPaolo Bonzini } 83888691b37SPaolo Bonzini 83988691b37SPaolo Bonzini if (job_id) { 84088691b37SPaolo Bonzini if (flags & BLOCK_JOB_INTERNAL) { 84188691b37SPaolo Bonzini error_setg(errp, "Cannot specify job ID for internal block job"); 84288691b37SPaolo Bonzini return NULL; 84388691b37SPaolo Bonzini } 84488691b37SPaolo Bonzini } 84588691b37SPaolo Bonzini 84688691b37SPaolo Bonzini blk = blk_new(perm, shared_perm); 84788691b37SPaolo Bonzini ret = blk_insert_bs(blk, bs, errp); 84888691b37SPaolo Bonzini if (ret < 0) { 84988691b37SPaolo Bonzini blk_unref(blk); 85088691b37SPaolo Bonzini return NULL; 85188691b37SPaolo Bonzini } 85288691b37SPaolo Bonzini 85308be6fe2SKevin Wolf job = job_create(job_id, &driver->job_driver, blk_get_aio_context(blk), 85408be6fe2SKevin Wolf errp); 85533e9e9bdSKevin Wolf if (job == NULL) { 85633e9e9bdSKevin Wolf blk_unref(blk); 85733e9e9bdSKevin Wolf return NULL; 85833e9e9bdSKevin Wolf } 85933e9e9bdSKevin Wolf 860e7c1d78bSKevin Wolf assert(is_block_job(&job->job)); 86180fa2c75SKevin Wolf assert(job->job.driver->free == &block_job_free); 862e7c1d78bSKevin Wolf 86388691b37SPaolo Bonzini job->driver = driver; 86488691b37SPaolo Bonzini job->blk = blk; 86588691b37SPaolo Bonzini job->cb = cb; 86688691b37SPaolo Bonzini job->opaque = opaque; 8675f241594SJohn Snow job->auto_finalize = !(flags & BLOCK_JOB_MANUAL_FINALIZE); 86875f71059SJohn Snow job->auto_dismiss = !(flags & BLOCK_JOB_MANUAL_DISMISS); 869*da01ff7fSKevin Wolf aio_timer_init(qemu_get_aio_context(), &job->job.sleep_timer, 870fc24908eSPaolo Bonzini QEMU_CLOCK_REALTIME, SCALE_NS, 871fc24908eSPaolo Bonzini block_job_sleep_timer_cb, job); 87288691b37SPaolo Bonzini 87388691b37SPaolo Bonzini error_setg(&job->blocker, "block device is in use by block job: %s", 874252291eaSKevin Wolf job_type_str(&job->job)); 87588691b37SPaolo Bonzini block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); 87688691b37SPaolo Bonzini bs->job = job; 87788691b37SPaolo Bonzini 87888691b37SPaolo Bonzini bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 87988691b37SPaolo Bonzini 88088691b37SPaolo Bonzini blk_add_aio_context_notifier(blk, block_job_attached_aio_context, 88188691b37SPaolo Bonzini block_job_detach_aio_context, job); 88288691b37SPaolo Bonzini 88388691b37SPaolo Bonzini /* Only set speed when necessary to avoid NotSupported error */ 88488691b37SPaolo Bonzini if (speed != 0) { 88588691b37SPaolo Bonzini Error *local_err = NULL; 88688691b37SPaolo Bonzini 88788691b37SPaolo Bonzini block_job_set_speed(job, speed, &local_err); 88888691b37SPaolo Bonzini if (local_err) { 8893925cd3bSJohn Snow block_job_early_fail(job); 89088691b37SPaolo Bonzini error_propagate(errp, local_err); 89188691b37SPaolo Bonzini return NULL; 89288691b37SPaolo Bonzini } 89388691b37SPaolo Bonzini } 89475859b94SJohn Snow 89575859b94SJohn Snow /* Single jobs are modeled as single-job transactions for sake of 89675859b94SJohn Snow * consolidating the job management logic */ 89775859b94SJohn Snow if (!txn) { 89875859b94SJohn Snow txn = block_job_txn_new(); 89975859b94SJohn Snow block_job_txn_add_job(txn, job); 90075859b94SJohn Snow block_job_txn_unref(txn); 90175859b94SJohn Snow } else { 90275859b94SJohn Snow block_job_txn_add_job(txn, job); 90375859b94SJohn Snow } 90475859b94SJohn Snow 90588691b37SPaolo Bonzini return job; 90688691b37SPaolo Bonzini } 90788691b37SPaolo Bonzini 90888691b37SPaolo Bonzini void block_job_early_fail(BlockJob *job) 90988691b37SPaolo Bonzini { 910a50c2ab8SKevin Wolf assert(job->job.status == JOB_STATUS_CREATED); 9113925cd3bSJohn Snow block_job_decommission(job); 91288691b37SPaolo Bonzini } 91388691b37SPaolo Bonzini 91488691b37SPaolo Bonzini void block_job_completed(BlockJob *job, int ret) 91588691b37SPaolo Bonzini { 91675859b94SJohn Snow assert(job && job->txn && !job->completed); 91788691b37SPaolo Bonzini assert(blk_bs(job->blk)->job == job); 91888691b37SPaolo Bonzini job->completed = true; 91988691b37SPaolo Bonzini job->ret = ret; 92035d6b368SJohn Snow block_job_update_rc(job); 92135d6b368SJohn Snow trace_block_job_completed(job, ret, job->ret); 92235d6b368SJohn Snow if (job->ret) { 92388691b37SPaolo Bonzini block_job_completed_txn_abort(job); 92488691b37SPaolo Bonzini } else { 92588691b37SPaolo Bonzini block_job_completed_txn_success(job); 92688691b37SPaolo Bonzini } 92788691b37SPaolo Bonzini } 92888691b37SPaolo Bonzini 929aa9ef2e6SJohn Snow void block_job_enter(BlockJob *job) 930aa9ef2e6SJohn Snow { 931*da01ff7fSKevin Wolf job_enter_cond(&job->job, NULL); 932aa9ef2e6SJohn Snow } 933aa9ef2e6SJohn Snow 9345bf1d5a7SPaolo Bonzini void block_job_sleep_ns(BlockJob *job, int64_t ns) 93588691b37SPaolo Bonzini { 936*da01ff7fSKevin Wolf assert(job->job.busy); 93788691b37SPaolo Bonzini 93888691b37SPaolo Bonzini /* Check cancellation *before* setting busy = false, too! */ 939daa7f2f9SKevin Wolf if (job_is_cancelled(&job->job)) { 94088691b37SPaolo Bonzini return; 94188691b37SPaolo Bonzini } 94288691b37SPaolo Bonzini 943*da01ff7fSKevin Wolf if (!job_should_pause(&job->job)) { 944*da01ff7fSKevin Wolf job_do_yield(&job->job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 94588691b37SPaolo Bonzini } 94688691b37SPaolo Bonzini 947*da01ff7fSKevin Wolf job_pause_point(&job->job); 94888691b37SPaolo Bonzini } 94988691b37SPaolo Bonzini 95088691b37SPaolo Bonzini void block_job_yield(BlockJob *job) 95188691b37SPaolo Bonzini { 952*da01ff7fSKevin Wolf assert(job->job.busy); 95388691b37SPaolo Bonzini 95488691b37SPaolo Bonzini /* Check cancellation *before* setting busy = false, too! */ 955daa7f2f9SKevin Wolf if (job_is_cancelled(&job->job)) { 95688691b37SPaolo Bonzini return; 95788691b37SPaolo Bonzini } 95888691b37SPaolo Bonzini 959*da01ff7fSKevin Wolf if (!job_should_pause(&job->job)) { 960*da01ff7fSKevin Wolf job_do_yield(&job->job, -1); 96188691b37SPaolo Bonzini } 96288691b37SPaolo Bonzini 963*da01ff7fSKevin Wolf job_pause_point(&job->job); 96488691b37SPaolo Bonzini } 96588691b37SPaolo Bonzini 9662caf63a9SPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 9672caf63a9SPaolo Bonzini { 9684c241cf5SPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 9694c241cf5SPaolo Bonzini return; 9704c241cf5SPaolo Bonzini } 971*da01ff7fSKevin Wolf assert(job->user_paused && job->job.pause_count > 0); 9722caf63a9SPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 9732caf63a9SPaolo Bonzini } 9742caf63a9SPaolo Bonzini 975bcada37bSWenchao Xia void block_job_event_ready(BlockJob *job) 976bcada37bSWenchao Xia { 977a50c2ab8SKevin Wolf job_state_transition(&job->job, JOB_STATUS_READY); 978ef6dbf1eSMax Reitz job->ready = true; 979ef6dbf1eSMax Reitz 980559b935fSJohn Snow if (block_job_is_internal(job)) { 981559b935fSJohn Snow return; 982559b935fSJohn Snow } 983559b935fSJohn Snow 984252291eaSKevin Wolf qapi_event_send_block_job_ready(job_type(&job->job), 98533e9e9bdSKevin Wolf job->job.id, 986518848a2SMarkus Armbruster job->len, 987518848a2SMarkus Armbruster job->offset, 988518848a2SMarkus Armbruster job->speed, &error_abort); 989a66a2a36SPaolo Bonzini } 990a66a2a36SPaolo Bonzini 99181e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 99232c81a4aSPaolo Bonzini int is_read, int error) 99332c81a4aSPaolo Bonzini { 99432c81a4aSPaolo Bonzini BlockErrorAction action; 99532c81a4aSPaolo Bonzini 99632c81a4aSPaolo Bonzini switch (on_err) { 99732c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 9988c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 999a589569fSWenchao Xia action = (error == ENOSPC) ? 1000a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 100132c81a4aSPaolo Bonzini break; 100232c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 1003a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 100432c81a4aSPaolo Bonzini break; 100532c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 1006a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 100732c81a4aSPaolo Bonzini break; 100832c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 1009a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 101032c81a4aSPaolo Bonzini break; 101132c81a4aSPaolo Bonzini default: 101232c81a4aSPaolo Bonzini abort(); 101332c81a4aSPaolo Bonzini } 1014559b935fSJohn Snow if (!block_job_is_internal(job)) { 101533e9e9bdSKevin Wolf qapi_event_send_block_job_error(job->job.id, 10165a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 10175a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 10185a2d2cbdSWenchao Xia action, &error_abort); 1019559b935fSJohn Snow } 1020a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 10210ec4dfb8SJohn Snow block_job_pause(job); 1022751ebd76SFam Zheng /* make the pause user visible, which will be resumed from QMP. */ 10230ec4dfb8SJohn Snow job->user_paused = true; 102432c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 102532c81a4aSPaolo Bonzini } 102632c81a4aSPaolo Bonzini return action; 102732c81a4aSPaolo Bonzini } 1028