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" 31373340b2SMax Reitz #include "sysemu/block-backend.h" 32*e688df6bSMarkus Armbruster #include "qapi/error.h" 33cc7a8ea7SMarkus Armbruster #include "qapi/qmp/qerror.h" 347b1b5d19SPaolo Bonzini #include "qapi/qmp/qjson.h" 3510817bf0SDaniel P. Berrange #include "qemu/coroutine.h" 367f0317cfSAlberto Garcia #include "qemu/id.h" 372f0c9fe6SPaolo Bonzini #include "qmp-commands.h" 381de7afc9SPaolo Bonzini #include "qemu/timer.h" 395a2d2cbdSWenchao Xia #include "qapi-event.h" 402f0c9fe6SPaolo Bonzini 41fc24908eSPaolo Bonzini /* Right now, this mutex is only needed to synchronize accesses to job->busy 42fc24908eSPaolo Bonzini * and job->sleep_timer, such as concurrent calls to block_job_do_yield and 43fc24908eSPaolo Bonzini * block_job_enter. */ 44fc24908eSPaolo Bonzini static QemuMutex block_job_mutex; 45fc24908eSPaolo Bonzini 46fc24908eSPaolo Bonzini static void block_job_lock(void) 47fc24908eSPaolo Bonzini { 48fc24908eSPaolo Bonzini qemu_mutex_lock(&block_job_mutex); 49fc24908eSPaolo Bonzini } 50fc24908eSPaolo Bonzini 51fc24908eSPaolo Bonzini static void block_job_unlock(void) 52fc24908eSPaolo Bonzini { 53fc24908eSPaolo Bonzini qemu_mutex_unlock(&block_job_mutex); 54fc24908eSPaolo Bonzini } 55fc24908eSPaolo Bonzini 56fc24908eSPaolo Bonzini static void __attribute__((__constructor__)) block_job_init(void) 57fc24908eSPaolo Bonzini { 58fc24908eSPaolo Bonzini qemu_mutex_init(&block_job_mutex); 59fc24908eSPaolo Bonzini } 60fc24908eSPaolo Bonzini 618254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job); 628254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg); 63aa9ef2e6SJohn Snow static void block_job_enter_cond(BlockJob *job, bool(*fn)(BlockJob *job)); 648254b6d9SJohn Snow 65c55a832fSFam Zheng /* Transactional group of block jobs */ 66c55a832fSFam Zheng struct BlockJobTxn { 67c55a832fSFam Zheng 68c55a832fSFam Zheng /* Is this txn being cancelled? */ 69c55a832fSFam Zheng bool aborting; 70c55a832fSFam Zheng 71c55a832fSFam Zheng /* List of jobs */ 72c55a832fSFam Zheng QLIST_HEAD(, BlockJob) jobs; 73c55a832fSFam Zheng 74c55a832fSFam Zheng /* Reference count */ 75c55a832fSFam Zheng int refcnt; 76c55a832fSFam Zheng }; 77c55a832fSFam Zheng 78a7112795SAlberto Garcia static QLIST_HEAD(, BlockJob) block_jobs = QLIST_HEAD_INITIALIZER(block_jobs); 79a7112795SAlberto Garcia 8088691b37SPaolo Bonzini /* 8188691b37SPaolo Bonzini * The block job API is composed of two categories of functions. 8288691b37SPaolo Bonzini * 8388691b37SPaolo Bonzini * The first includes functions used by the monitor. The monitor is 8488691b37SPaolo Bonzini * peculiar in that it accesses the block job list with block_job_get, and 8588691b37SPaolo Bonzini * therefore needs consistency across block_job_get and the actual operation 8688691b37SPaolo Bonzini * (e.g. block_job_set_speed). The consistency is achieved with 8788691b37SPaolo Bonzini * aio_context_acquire/release. These functions are declared in blockjob.h. 8888691b37SPaolo Bonzini * 8988691b37SPaolo Bonzini * The second includes functions used by the block job drivers and sometimes 9088691b37SPaolo Bonzini * by the core block layer. These do not care about locking, because the 9188691b37SPaolo Bonzini * whole coroutine runs under the AioContext lock, and are declared in 9288691b37SPaolo Bonzini * blockjob_int.h. 9388691b37SPaolo Bonzini */ 9488691b37SPaolo Bonzini 95a7112795SAlberto Garcia BlockJob *block_job_next(BlockJob *job) 96a7112795SAlberto Garcia { 97a7112795SAlberto Garcia if (!job) { 98a7112795SAlberto Garcia return QLIST_FIRST(&block_jobs); 99a7112795SAlberto Garcia } 100a7112795SAlberto Garcia return QLIST_NEXT(job, job_list); 101a7112795SAlberto Garcia } 102a7112795SAlberto Garcia 103ffb1f10cSAlberto Garcia BlockJob *block_job_get(const char *id) 104ffb1f10cSAlberto Garcia { 105ffb1f10cSAlberto Garcia BlockJob *job; 106ffb1f10cSAlberto Garcia 107ffb1f10cSAlberto Garcia QLIST_FOREACH(job, &block_jobs, job_list) { 108559b935fSJohn Snow if (job->id && !strcmp(id, job->id)) { 109ffb1f10cSAlberto Garcia return job; 110ffb1f10cSAlberto Garcia } 111ffb1f10cSAlberto Garcia } 112ffb1f10cSAlberto Garcia 113ffb1f10cSAlberto Garcia return NULL; 114ffb1f10cSAlberto Garcia } 115ffb1f10cSAlberto Garcia 116c8ab5c2dSPaolo Bonzini BlockJobTxn *block_job_txn_new(void) 117c8ab5c2dSPaolo Bonzini { 118c8ab5c2dSPaolo Bonzini BlockJobTxn *txn = g_new0(BlockJobTxn, 1); 119c8ab5c2dSPaolo Bonzini QLIST_INIT(&txn->jobs); 120c8ab5c2dSPaolo Bonzini txn->refcnt = 1; 121c8ab5c2dSPaolo Bonzini return txn; 122c8ab5c2dSPaolo Bonzini } 123c8ab5c2dSPaolo Bonzini 124c8ab5c2dSPaolo Bonzini static void block_job_txn_ref(BlockJobTxn *txn) 125c8ab5c2dSPaolo Bonzini { 126c8ab5c2dSPaolo Bonzini txn->refcnt++; 127c8ab5c2dSPaolo Bonzini } 128c8ab5c2dSPaolo Bonzini 129c8ab5c2dSPaolo Bonzini void block_job_txn_unref(BlockJobTxn *txn) 130c8ab5c2dSPaolo Bonzini { 131c8ab5c2dSPaolo Bonzini if (txn && --txn->refcnt == 0) { 132c8ab5c2dSPaolo Bonzini g_free(txn); 133c8ab5c2dSPaolo Bonzini } 134c8ab5c2dSPaolo Bonzini } 135c8ab5c2dSPaolo Bonzini 136c8ab5c2dSPaolo Bonzini void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job) 137c8ab5c2dSPaolo Bonzini { 138c8ab5c2dSPaolo Bonzini if (!txn) { 139c8ab5c2dSPaolo Bonzini return; 140c8ab5c2dSPaolo Bonzini } 141c8ab5c2dSPaolo Bonzini 142c8ab5c2dSPaolo Bonzini assert(!job->txn); 143c8ab5c2dSPaolo Bonzini job->txn = txn; 144c8ab5c2dSPaolo Bonzini 145c8ab5c2dSPaolo Bonzini QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 146c8ab5c2dSPaolo Bonzini block_job_txn_ref(txn); 147c8ab5c2dSPaolo Bonzini } 148c8ab5c2dSPaolo Bonzini 149f321dcb5SPaolo Bonzini static void block_job_pause(BlockJob *job) 150f321dcb5SPaolo Bonzini { 151f321dcb5SPaolo Bonzini job->pause_count++; 152f321dcb5SPaolo Bonzini } 153f321dcb5SPaolo Bonzini 154f321dcb5SPaolo Bonzini static void block_job_resume(BlockJob *job) 155f321dcb5SPaolo Bonzini { 156f321dcb5SPaolo Bonzini assert(job->pause_count > 0); 157f321dcb5SPaolo Bonzini job->pause_count--; 158f321dcb5SPaolo Bonzini if (job->pause_count) { 159f321dcb5SPaolo Bonzini return; 160f321dcb5SPaolo Bonzini } 161f321dcb5SPaolo Bonzini block_job_enter(job); 162f321dcb5SPaolo Bonzini } 163f321dcb5SPaolo Bonzini 1644172a003Ssochin.jiang void block_job_ref(BlockJob *job) 16505b0d8e3SPaolo Bonzini { 16605b0d8e3SPaolo Bonzini ++job->refcnt; 16705b0d8e3SPaolo Bonzini } 16805b0d8e3SPaolo Bonzini 16905b0d8e3SPaolo Bonzini static void block_job_attached_aio_context(AioContext *new_context, 17005b0d8e3SPaolo Bonzini void *opaque); 17105b0d8e3SPaolo Bonzini static void block_job_detach_aio_context(void *opaque); 17205b0d8e3SPaolo Bonzini 1734172a003Ssochin.jiang void block_job_unref(BlockJob *job) 17405b0d8e3SPaolo Bonzini { 17505b0d8e3SPaolo Bonzini if (--job->refcnt == 0) { 17605b0d8e3SPaolo Bonzini BlockDriverState *bs = blk_bs(job->blk); 1770a3e155fSAlberto Garcia QLIST_REMOVE(job, job_list); 17805b0d8e3SPaolo Bonzini bs->job = NULL; 17905b0d8e3SPaolo Bonzini block_job_remove_all_bdrv(job); 18005b0d8e3SPaolo Bonzini blk_remove_aio_context_notifier(job->blk, 18105b0d8e3SPaolo Bonzini block_job_attached_aio_context, 18205b0d8e3SPaolo Bonzini block_job_detach_aio_context, job); 18305b0d8e3SPaolo Bonzini blk_unref(job->blk); 18405b0d8e3SPaolo Bonzini error_free(job->blocker); 18505b0d8e3SPaolo Bonzini g_free(job->id); 186fc24908eSPaolo Bonzini assert(!timer_pending(&job->sleep_timer)); 18705b0d8e3SPaolo Bonzini g_free(job); 18805b0d8e3SPaolo Bonzini } 18905b0d8e3SPaolo Bonzini } 19005b0d8e3SPaolo Bonzini 191463e0be1SStefan Hajnoczi static void block_job_attached_aio_context(AioContext *new_context, 192463e0be1SStefan Hajnoczi void *opaque) 193463e0be1SStefan Hajnoczi { 194463e0be1SStefan Hajnoczi BlockJob *job = opaque; 195463e0be1SStefan Hajnoczi 196463e0be1SStefan Hajnoczi if (job->driver->attached_aio_context) { 197463e0be1SStefan Hajnoczi job->driver->attached_aio_context(job, new_context); 198463e0be1SStefan Hajnoczi } 199463e0be1SStefan Hajnoczi 200463e0be1SStefan Hajnoczi block_job_resume(job); 201463e0be1SStefan Hajnoczi } 202463e0be1SStefan Hajnoczi 203bae8196dSPaolo Bonzini static void block_job_drain(BlockJob *job) 204bae8196dSPaolo Bonzini { 205bae8196dSPaolo Bonzini /* If job is !job->busy this kicks it into the next pause point. */ 206bae8196dSPaolo Bonzini block_job_enter(job); 207bae8196dSPaolo Bonzini 208bae8196dSPaolo Bonzini blk_drain(job->blk); 209bae8196dSPaolo Bonzini if (job->driver->drain) { 210bae8196dSPaolo Bonzini job->driver->drain(job); 211bae8196dSPaolo Bonzini } 212bae8196dSPaolo Bonzini } 213bae8196dSPaolo Bonzini 214463e0be1SStefan Hajnoczi static void block_job_detach_aio_context(void *opaque) 215463e0be1SStefan Hajnoczi { 216463e0be1SStefan Hajnoczi BlockJob *job = opaque; 217463e0be1SStefan Hajnoczi 218463e0be1SStefan Hajnoczi /* In case the job terminates during aio_poll()... */ 219463e0be1SStefan Hajnoczi block_job_ref(job); 220463e0be1SStefan Hajnoczi 221463e0be1SStefan Hajnoczi block_job_pause(job); 222463e0be1SStefan Hajnoczi 223463e0be1SStefan Hajnoczi while (!job->paused && !job->completed) { 224bae8196dSPaolo Bonzini block_job_drain(job); 225463e0be1SStefan Hajnoczi } 226463e0be1SStefan Hajnoczi 227463e0be1SStefan Hajnoczi block_job_unref(job); 228463e0be1SStefan Hajnoczi } 229463e0be1SStefan Hajnoczi 230f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c) 231f321dcb5SPaolo Bonzini { 232f321dcb5SPaolo Bonzini BlockJob *job = c->opaque; 233f321dcb5SPaolo Bonzini return g_strdup_printf("%s job '%s'", 234977c736fSMarkus Armbruster BlockJobType_str(job->driver->job_type), 235f321dcb5SPaolo Bonzini job->id); 236f321dcb5SPaolo Bonzini } 237f321dcb5SPaolo Bonzini 238ad90febaSKevin Wolf static void child_job_drained_begin(BdrvChild *c) 239f321dcb5SPaolo Bonzini { 240ad90febaSKevin Wolf BlockJob *job = c->opaque; 241f321dcb5SPaolo Bonzini block_job_pause(job); 242f321dcb5SPaolo Bonzini } 243f321dcb5SPaolo Bonzini 244ad90febaSKevin Wolf static void child_job_drained_end(BdrvChild *c) 245f321dcb5SPaolo Bonzini { 246ad90febaSKevin Wolf BlockJob *job = c->opaque; 247f321dcb5SPaolo Bonzini block_job_resume(job); 248f321dcb5SPaolo Bonzini } 249f321dcb5SPaolo Bonzini 250ad90febaSKevin Wolf static const BdrvChildRole child_job = { 251ad90febaSKevin Wolf .get_parent_desc = child_job_get_parent_desc, 252ad90febaSKevin Wolf .drained_begin = child_job_drained_begin, 253ad90febaSKevin Wolf .drained_end = child_job_drained_end, 254ad90febaSKevin Wolf .stay_at_node = true, 255f321dcb5SPaolo Bonzini }; 256f321dcb5SPaolo Bonzini 257bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job) 258bbc02b90SKevin Wolf { 259bbc02b90SKevin Wolf GSList *l; 260bbc02b90SKevin Wolf for (l = job->nodes; l; l = l->next) { 261bbc02b90SKevin Wolf BdrvChild *c = l->data; 262bbc02b90SKevin Wolf bdrv_op_unblock_all(c->bs, job->blocker); 263bbc02b90SKevin Wolf bdrv_root_unref_child(c); 264bbc02b90SKevin Wolf } 265bbc02b90SKevin Wolf g_slist_free(job->nodes); 266bbc02b90SKevin Wolf job->nodes = NULL; 267bbc02b90SKevin Wolf } 268bbc02b90SKevin Wolf 26976d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 27076d554e2SKevin Wolf uint64_t perm, uint64_t shared_perm, Error **errp) 27123d402d4SAlberto Garcia { 27276d554e2SKevin Wolf BdrvChild *c; 27376d554e2SKevin Wolf 27476d554e2SKevin Wolf c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm, 27576d554e2SKevin Wolf job, errp); 27676d554e2SKevin Wolf if (c == NULL) { 27776d554e2SKevin Wolf return -EPERM; 27876d554e2SKevin Wolf } 27976d554e2SKevin Wolf 28076d554e2SKevin Wolf job->nodes = g_slist_prepend(job->nodes, c); 28123d402d4SAlberto Garcia bdrv_ref(bs); 28223d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 28376d554e2SKevin Wolf 28476d554e2SKevin Wolf return 0; 28523d402d4SAlberto Garcia } 28623d402d4SAlberto Garcia 287559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 288559b935fSJohn Snow { 289559b935fSJohn Snow return (job->id == NULL); 290559b935fSJohn Snow } 291559b935fSJohn Snow 2925ccac6f1SJohn Snow static bool block_job_started(BlockJob *job) 2935ccac6f1SJohn Snow { 2945ccac6f1SJohn Snow return job->co; 2955ccac6f1SJohn Snow } 2965ccac6f1SJohn Snow 297e3796a24SJohn Snow /** 298e3796a24SJohn Snow * All jobs must allow a pause point before entering their job proper. This 299e3796a24SJohn Snow * ensures that jobs can be paused prior to being started, then resumed later. 300e3796a24SJohn Snow */ 301e3796a24SJohn Snow static void coroutine_fn block_job_co_entry(void *opaque) 302e3796a24SJohn Snow { 303e3796a24SJohn Snow BlockJob *job = opaque; 304e3796a24SJohn Snow 305e3796a24SJohn Snow assert(job && job->driver && job->driver->start); 306e3796a24SJohn Snow block_job_pause_point(job); 307e3796a24SJohn Snow job->driver->start(job); 308e3796a24SJohn Snow } 309e3796a24SJohn Snow 310fc24908eSPaolo Bonzini static void block_job_sleep_timer_cb(void *opaque) 311fc24908eSPaolo Bonzini { 312fc24908eSPaolo Bonzini BlockJob *job = opaque; 313fc24908eSPaolo Bonzini 314fc24908eSPaolo Bonzini block_job_enter(job); 315fc24908eSPaolo Bonzini } 316fc24908eSPaolo Bonzini 3175ccac6f1SJohn Snow void block_job_start(BlockJob *job) 3185ccac6f1SJohn Snow { 3195ccac6f1SJohn Snow assert(job && !block_job_started(job) && job->paused && 320e3796a24SJohn Snow job->driver && job->driver->start); 321e3796a24SJohn Snow job->co = qemu_coroutine_create(block_job_co_entry, job); 322e3796a24SJohn Snow job->pause_count--; 3235ccac6f1SJohn Snow job->busy = true; 324e3796a24SJohn Snow job->paused = false; 325aef4278cSFam Zheng bdrv_coroutine_enter(blk_bs(job->blk), job->co); 3265ccac6f1SJohn Snow } 3275ccac6f1SJohn Snow 328c55a832fSFam Zheng static void block_job_completed_single(BlockJob *job) 329c55a832fSFam Zheng { 3304fb588e9SPaolo Bonzini assert(job->completed); 3314fb588e9SPaolo Bonzini 332c55a832fSFam Zheng if (!job->ret) { 333c55a832fSFam Zheng if (job->driver->commit) { 334c55a832fSFam Zheng job->driver->commit(job); 335c55a832fSFam Zheng } 336c55a832fSFam Zheng } else { 337c55a832fSFam Zheng if (job->driver->abort) { 338c55a832fSFam Zheng job->driver->abort(job); 339c55a832fSFam Zheng } 340c55a832fSFam Zheng } 341e8a40bf7SJohn Snow if (job->driver->clean) { 342e8a40bf7SJohn Snow job->driver->clean(job); 343e8a40bf7SJohn Snow } 3448254b6d9SJohn Snow 3458254b6d9SJohn Snow if (job->cb) { 346c55a832fSFam Zheng job->cb(job->opaque, job->ret); 3478254b6d9SJohn Snow } 3485ccac6f1SJohn Snow 3495ccac6f1SJohn Snow /* Emit events only if we actually started */ 3505ccac6f1SJohn Snow if (block_job_started(job)) { 3518254b6d9SJohn Snow if (block_job_is_cancelled(job)) { 3528254b6d9SJohn Snow block_job_event_cancelled(job); 3538254b6d9SJohn Snow } else { 3548254b6d9SJohn Snow const char *msg = NULL; 3558254b6d9SJohn Snow if (job->ret < 0) { 3568254b6d9SJohn Snow msg = strerror(-job->ret); 3578254b6d9SJohn Snow } 3588254b6d9SJohn Snow block_job_event_completed(job, msg); 3598254b6d9SJohn Snow } 3605ccac6f1SJohn Snow } 3618254b6d9SJohn Snow 362c55a832fSFam Zheng if (job->txn) { 3631e93b9fbSVladimir Sementsov-Ogievskiy QLIST_REMOVE(job, txn_list); 364c55a832fSFam Zheng block_job_txn_unref(job->txn); 365c55a832fSFam Zheng } 366c55a832fSFam Zheng block_job_unref(job); 367c55a832fSFam Zheng } 368c55a832fSFam Zheng 3694c241cf5SPaolo Bonzini static void block_job_cancel_async(BlockJob *job) 3704c241cf5SPaolo Bonzini { 3714c241cf5SPaolo Bonzini if (job->iostatus != BLOCK_DEVICE_IO_STATUS_OK) { 3724c241cf5SPaolo Bonzini block_job_iostatus_reset(job); 3734c241cf5SPaolo Bonzini } 3744c241cf5SPaolo Bonzini if (job->user_paused) { 3754c241cf5SPaolo Bonzini /* Do not call block_job_enter here, the caller will handle it. */ 3764c241cf5SPaolo Bonzini job->user_paused = false; 3774c241cf5SPaolo Bonzini job->pause_count--; 3784c241cf5SPaolo Bonzini } 3794c241cf5SPaolo Bonzini job->cancelled = true; 3804c241cf5SPaolo Bonzini } 3814c241cf5SPaolo Bonzini 382c8ab5c2dSPaolo Bonzini static int block_job_finish_sync(BlockJob *job, 383c8ab5c2dSPaolo Bonzini void (*finish)(BlockJob *, Error **errp), 384c8ab5c2dSPaolo Bonzini Error **errp) 385c8ab5c2dSPaolo Bonzini { 386c8ab5c2dSPaolo Bonzini Error *local_err = NULL; 387c8ab5c2dSPaolo Bonzini int ret; 388c8ab5c2dSPaolo Bonzini 389c8ab5c2dSPaolo Bonzini assert(blk_bs(job->blk)->job == job); 390c8ab5c2dSPaolo Bonzini 391c8ab5c2dSPaolo Bonzini block_job_ref(job); 392c8ab5c2dSPaolo Bonzini 3934fb588e9SPaolo Bonzini if (finish) { 394c8ab5c2dSPaolo Bonzini finish(job, &local_err); 3954fb588e9SPaolo Bonzini } 396c8ab5c2dSPaolo Bonzini if (local_err) { 397c8ab5c2dSPaolo Bonzini error_propagate(errp, local_err); 398c8ab5c2dSPaolo Bonzini block_job_unref(job); 399c8ab5c2dSPaolo Bonzini return -EBUSY; 400c8ab5c2dSPaolo Bonzini } 401c8ab5c2dSPaolo Bonzini /* block_job_drain calls block_job_enter, and it should be enough to 402c8ab5c2dSPaolo Bonzini * induce progress until the job completes or moves to the main thread. 403c8ab5c2dSPaolo Bonzini */ 404c8ab5c2dSPaolo Bonzini while (!job->deferred_to_main_loop && !job->completed) { 405c8ab5c2dSPaolo Bonzini block_job_drain(job); 406c8ab5c2dSPaolo Bonzini } 407c8ab5c2dSPaolo Bonzini while (!job->completed) { 408c8ab5c2dSPaolo Bonzini aio_poll(qemu_get_aio_context(), true); 409c8ab5c2dSPaolo Bonzini } 410c8ab5c2dSPaolo Bonzini ret = (job->cancelled && job->ret == 0) ? -ECANCELED : job->ret; 411c8ab5c2dSPaolo Bonzini block_job_unref(job); 412c8ab5c2dSPaolo Bonzini return ret; 413c8ab5c2dSPaolo Bonzini } 414c8ab5c2dSPaolo Bonzini 415c55a832fSFam Zheng static void block_job_completed_txn_abort(BlockJob *job) 416c55a832fSFam Zheng { 417c55a832fSFam Zheng AioContext *ctx; 418c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 4194fb588e9SPaolo Bonzini BlockJob *other_job; 420c55a832fSFam Zheng 421c55a832fSFam Zheng if (txn->aborting) { 422c55a832fSFam Zheng /* 423c55a832fSFam Zheng * We are cancelled by another job, which will handle everything. 424c55a832fSFam Zheng */ 425c55a832fSFam Zheng return; 426c55a832fSFam Zheng } 427c55a832fSFam Zheng txn->aborting = true; 4284fb588e9SPaolo Bonzini block_job_txn_ref(txn); 4294fb588e9SPaolo Bonzini 430c55a832fSFam Zheng /* We are the first failed job. Cancel other jobs. */ 431c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 432b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 433c55a832fSFam Zheng aio_context_acquire(ctx); 434c55a832fSFam Zheng } 4354fb588e9SPaolo Bonzini 4364fb588e9SPaolo Bonzini /* Other jobs are effectively cancelled by us, set the status for 437c55a832fSFam Zheng * them; this job, however, may or may not be cancelled, depending 438c55a832fSFam Zheng * on the caller, so leave it. */ 4394fb588e9SPaolo Bonzini QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 440c55a832fSFam Zheng if (other_job != job) { 4414c241cf5SPaolo Bonzini block_job_cancel_async(other_job); 442c55a832fSFam Zheng } 443c55a832fSFam Zheng } 4444fb588e9SPaolo Bonzini while (!QLIST_EMPTY(&txn->jobs)) { 4454fb588e9SPaolo Bonzini other_job = QLIST_FIRST(&txn->jobs); 446b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 4474fb588e9SPaolo Bonzini if (!other_job->completed) { 4484fb588e9SPaolo Bonzini assert(other_job->cancelled); 4494fb588e9SPaolo Bonzini block_job_finish_sync(other_job, NULL, NULL); 4504fb588e9SPaolo Bonzini } 451c55a832fSFam Zheng block_job_completed_single(other_job); 452c55a832fSFam Zheng aio_context_release(ctx); 453c55a832fSFam Zheng } 4544fb588e9SPaolo Bonzini 4554fb588e9SPaolo Bonzini block_job_txn_unref(txn); 456c55a832fSFam Zheng } 457c55a832fSFam Zheng 458c55a832fSFam Zheng static void block_job_completed_txn_success(BlockJob *job) 459c55a832fSFam Zheng { 460c55a832fSFam Zheng AioContext *ctx; 461c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 462c55a832fSFam Zheng BlockJob *other_job, *next; 463c55a832fSFam Zheng /* 464c55a832fSFam Zheng * Successful completion, see if there are other running jobs in this 465c55a832fSFam Zheng * txn. 466c55a832fSFam Zheng */ 467c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 468c55a832fSFam Zheng if (!other_job->completed) { 469c55a832fSFam Zheng return; 470c55a832fSFam Zheng } 471c55a832fSFam Zheng } 472c55a832fSFam Zheng /* We are the last completed job, commit the transaction. */ 473c55a832fSFam Zheng QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { 474b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 475c55a832fSFam Zheng aio_context_acquire(ctx); 476c55a832fSFam Zheng assert(other_job->ret == 0); 477c55a832fSFam Zheng block_job_completed_single(other_job); 478c55a832fSFam Zheng aio_context_release(ctx); 479c55a832fSFam Zheng } 480c55a832fSFam Zheng } 481c55a832fSFam Zheng 482aa9ef2e6SJohn Snow /* Assumes the block_job_mutex is held */ 483aa9ef2e6SJohn Snow static bool block_job_timer_pending(BlockJob *job) 484aa9ef2e6SJohn Snow { 485aa9ef2e6SJohn Snow return timer_pending(&job->sleep_timer); 486aa9ef2e6SJohn Snow } 487aa9ef2e6SJohn Snow 4882f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 4892f0c9fe6SPaolo Bonzini { 4902f0c9fe6SPaolo Bonzini Error *local_err = NULL; 491aa9ef2e6SJohn Snow int64_t old_speed = job->speed; 4922f0c9fe6SPaolo Bonzini 4933fc4b10aSFam Zheng if (!job->driver->set_speed) { 494c6bd8c70SMarkus Armbruster error_setg(errp, QERR_UNSUPPORTED); 4952f0c9fe6SPaolo Bonzini return; 4962f0c9fe6SPaolo Bonzini } 4973fc4b10aSFam Zheng job->driver->set_speed(job, speed, &local_err); 49884d18f06SMarkus Armbruster if (local_err) { 4992f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 5002f0c9fe6SPaolo Bonzini return; 5012f0c9fe6SPaolo Bonzini } 5022f0c9fe6SPaolo Bonzini 5032f0c9fe6SPaolo Bonzini job->speed = speed; 504aa9ef2e6SJohn Snow if (speed <= old_speed) { 505aa9ef2e6SJohn Snow return; 506aa9ef2e6SJohn Snow } 507aa9ef2e6SJohn Snow 508aa9ef2e6SJohn Snow /* kick only if a timer is pending */ 509aa9ef2e6SJohn Snow block_job_enter_cond(job, block_job_timer_pending); 5102f0c9fe6SPaolo Bonzini } 5112f0c9fe6SPaolo Bonzini 512aeae883bSPaolo Bonzini void block_job_complete(BlockJob *job, Error **errp) 513aeae883bSPaolo Bonzini { 514559b935fSJohn Snow /* Should not be reachable via external interface for internal jobs */ 515559b935fSJohn Snow assert(job->id); 5165ccac6f1SJohn Snow if (job->pause_count || job->cancelled || 5175ccac6f1SJohn Snow !block_job_started(job) || !job->driver->complete) { 5189df229c3SAlberto Garcia error_setg(errp, "The active block job '%s' cannot be completed", 5199df229c3SAlberto Garcia job->id); 520aeae883bSPaolo Bonzini return; 521aeae883bSPaolo Bonzini } 522aeae883bSPaolo Bonzini 5233fc4b10aSFam Zheng job->driver->complete(job, errp); 524aeae883bSPaolo Bonzini } 525aeae883bSPaolo Bonzini 5260df4ba58SJohn Snow void block_job_user_pause(BlockJob *job) 5270df4ba58SJohn Snow { 5280df4ba58SJohn Snow job->user_paused = true; 5290df4ba58SJohn Snow block_job_pause(job); 5300df4ba58SJohn Snow } 5310df4ba58SJohn Snow 5320df4ba58SJohn Snow bool block_job_user_paused(BlockJob *job) 5330df4ba58SJohn Snow { 5346573d9c6SPaolo Bonzini return job->user_paused; 5350df4ba58SJohn Snow } 5360df4ba58SJohn Snow 5370df4ba58SJohn Snow void block_job_user_resume(BlockJob *job) 5380df4ba58SJohn Snow { 5390df4ba58SJohn Snow if (job && job->user_paused && job->pause_count > 0) { 5402caf63a9SPaolo Bonzini block_job_iostatus_reset(job); 5414c241cf5SPaolo Bonzini job->user_paused = false; 5420df4ba58SJohn Snow block_job_resume(job); 5430df4ba58SJohn Snow } 5440df4ba58SJohn Snow } 5450df4ba58SJohn Snow 5468acc72a4SPaolo Bonzini void block_job_cancel(BlockJob *job) 5478acc72a4SPaolo Bonzini { 5485ccac6f1SJohn Snow if (block_job_started(job)) { 5494c241cf5SPaolo Bonzini block_job_cancel_async(job); 550751ebd76SFam Zheng block_job_enter(job); 5515ccac6f1SJohn Snow } else { 5525ccac6f1SJohn Snow block_job_completed(job, -ECANCELED); 5535ccac6f1SJohn Snow } 5548acc72a4SPaolo Bonzini } 5558acc72a4SPaolo Bonzini 556345f9e1bSMax Reitz /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be 557345f9e1bSMax Reitz * used with block_job_finish_sync() without the need for (rather nasty) 558345f9e1bSMax Reitz * function pointer casts there. */ 559345f9e1bSMax Reitz static void block_job_cancel_err(BlockJob *job, Error **errp) 560345f9e1bSMax Reitz { 561345f9e1bSMax Reitz block_job_cancel(job); 562345f9e1bSMax Reitz } 563345f9e1bSMax Reitz 564345f9e1bSMax Reitz int block_job_cancel_sync(BlockJob *job) 565345f9e1bSMax Reitz { 566345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_cancel_err, NULL); 567345f9e1bSMax Reitz } 568345f9e1bSMax Reitz 569a1a2af07SKevin Wolf void block_job_cancel_sync_all(void) 570a1a2af07SKevin Wolf { 571a1a2af07SKevin Wolf BlockJob *job; 572a1a2af07SKevin Wolf AioContext *aio_context; 573a1a2af07SKevin Wolf 574a1a2af07SKevin Wolf while ((job = QLIST_FIRST(&block_jobs))) { 575b6d2e599SKevin Wolf aio_context = blk_get_aio_context(job->blk); 576a1a2af07SKevin Wolf aio_context_acquire(aio_context); 577a1a2af07SKevin Wolf block_job_cancel_sync(job); 578a1a2af07SKevin Wolf aio_context_release(aio_context); 579a1a2af07SKevin Wolf } 580a1a2af07SKevin Wolf } 581a1a2af07SKevin Wolf 582345f9e1bSMax Reitz int block_job_complete_sync(BlockJob *job, Error **errp) 583345f9e1bSMax Reitz { 584345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_complete, errp); 585345f9e1bSMax Reitz } 586345f9e1bSMax Reitz 587559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp) 58830e628b7SPaolo Bonzini { 589559b935fSJohn Snow BlockJobInfo *info; 590559b935fSJohn Snow 591559b935fSJohn Snow if (block_job_is_internal(job)) { 592559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 593559b935fSJohn Snow return NULL; 594559b935fSJohn Snow } 595559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 596977c736fSMarkus Armbruster info->type = g_strdup(BlockJobType_str(job->driver->job_type)); 5978ccb9569SKevin Wolf info->device = g_strdup(job->id); 59830e628b7SPaolo Bonzini info->len = job->len; 599fc24908eSPaolo Bonzini info->busy = atomic_read(&job->busy); 600751ebd76SFam Zheng info->paused = job->pause_count > 0; 60130e628b7SPaolo Bonzini info->offset = job->offset; 60230e628b7SPaolo Bonzini info->speed = job->speed; 60332c81a4aSPaolo Bonzini info->io_status = job->iostatus; 604ef6dbf1eSMax Reitz info->ready = job->ready; 60530e628b7SPaolo Bonzini return info; 60630e628b7SPaolo Bonzini } 60732c81a4aSPaolo Bonzini 60832c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 60932c81a4aSPaolo Bonzini { 61032c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 61132c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 61232c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 61332c81a4aSPaolo Bonzini } 61432c81a4aSPaolo Bonzini } 61532c81a4aSPaolo Bonzini 6168254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job) 617a66a2a36SPaolo Bonzini { 618559b935fSJohn Snow if (block_job_is_internal(job)) { 619559b935fSJohn Snow return; 620559b935fSJohn Snow } 621559b935fSJohn Snow 622bcada37bSWenchao Xia qapi_event_send_block_job_cancelled(job->driver->job_type, 6238ccb9569SKevin Wolf job->id, 624a66a2a36SPaolo Bonzini job->len, 625a66a2a36SPaolo Bonzini job->offset, 626bcada37bSWenchao Xia job->speed, 627bcada37bSWenchao Xia &error_abort); 628a66a2a36SPaolo Bonzini } 629a66a2a36SPaolo Bonzini 6308254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg) 631a66a2a36SPaolo Bonzini { 632559b935fSJohn Snow if (block_job_is_internal(job)) { 633559b935fSJohn Snow return; 634559b935fSJohn Snow } 635559b935fSJohn Snow 636bcada37bSWenchao Xia qapi_event_send_block_job_completed(job->driver->job_type, 6378ccb9569SKevin Wolf job->id, 638bcada37bSWenchao Xia job->len, 639bcada37bSWenchao Xia job->offset, 640bcada37bSWenchao Xia job->speed, 641bcada37bSWenchao Xia !!msg, 642bcada37bSWenchao Xia msg, 643bcada37bSWenchao Xia &error_abort); 644bcada37bSWenchao Xia } 645bcada37bSWenchao Xia 64688691b37SPaolo Bonzini /* 64788691b37SPaolo Bonzini * API for block job drivers and the block layer. These functions are 64888691b37SPaolo Bonzini * declared in blockjob_int.h. 64988691b37SPaolo Bonzini */ 65088691b37SPaolo Bonzini 65188691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver, 65288691b37SPaolo Bonzini BlockDriverState *bs, uint64_t perm, 65388691b37SPaolo Bonzini uint64_t shared_perm, int64_t speed, int flags, 65488691b37SPaolo Bonzini BlockCompletionFunc *cb, void *opaque, Error **errp) 65588691b37SPaolo Bonzini { 65688691b37SPaolo Bonzini BlockBackend *blk; 65788691b37SPaolo Bonzini BlockJob *job; 65888691b37SPaolo Bonzini int ret; 65988691b37SPaolo Bonzini 66088691b37SPaolo Bonzini if (bs->job) { 66188691b37SPaolo Bonzini error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); 66288691b37SPaolo Bonzini return NULL; 66388691b37SPaolo Bonzini } 66488691b37SPaolo Bonzini 66588691b37SPaolo Bonzini if (job_id == NULL && !(flags & BLOCK_JOB_INTERNAL)) { 66688691b37SPaolo Bonzini job_id = bdrv_get_device_name(bs); 66788691b37SPaolo Bonzini if (!*job_id) { 66888691b37SPaolo Bonzini error_setg(errp, "An explicit job ID is required for this node"); 66988691b37SPaolo Bonzini return NULL; 67088691b37SPaolo Bonzini } 67188691b37SPaolo Bonzini } 67288691b37SPaolo Bonzini 67388691b37SPaolo Bonzini if (job_id) { 67488691b37SPaolo Bonzini if (flags & BLOCK_JOB_INTERNAL) { 67588691b37SPaolo Bonzini error_setg(errp, "Cannot specify job ID for internal block job"); 67688691b37SPaolo Bonzini return NULL; 67788691b37SPaolo Bonzini } 67888691b37SPaolo Bonzini 67988691b37SPaolo Bonzini if (!id_wellformed(job_id)) { 68088691b37SPaolo Bonzini error_setg(errp, "Invalid job ID '%s'", job_id); 68188691b37SPaolo Bonzini return NULL; 68288691b37SPaolo Bonzini } 68388691b37SPaolo Bonzini 68488691b37SPaolo Bonzini if (block_job_get(job_id)) { 68588691b37SPaolo Bonzini error_setg(errp, "Job ID '%s' already in use", job_id); 68688691b37SPaolo Bonzini return NULL; 68788691b37SPaolo Bonzini } 68888691b37SPaolo Bonzini } 68988691b37SPaolo Bonzini 69088691b37SPaolo Bonzini blk = blk_new(perm, shared_perm); 69188691b37SPaolo Bonzini ret = blk_insert_bs(blk, bs, errp); 69288691b37SPaolo Bonzini if (ret < 0) { 69388691b37SPaolo Bonzini blk_unref(blk); 69488691b37SPaolo Bonzini return NULL; 69588691b37SPaolo Bonzini } 69688691b37SPaolo Bonzini 69788691b37SPaolo Bonzini job = g_malloc0(driver->instance_size); 69888691b37SPaolo Bonzini job->driver = driver; 69988691b37SPaolo Bonzini job->id = g_strdup(job_id); 70088691b37SPaolo Bonzini job->blk = blk; 70188691b37SPaolo Bonzini job->cb = cb; 70288691b37SPaolo Bonzini job->opaque = opaque; 70388691b37SPaolo Bonzini job->busy = false; 70488691b37SPaolo Bonzini job->paused = true; 70588691b37SPaolo Bonzini job->pause_count = 1; 70688691b37SPaolo Bonzini job->refcnt = 1; 707fc24908eSPaolo Bonzini aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 708fc24908eSPaolo Bonzini QEMU_CLOCK_REALTIME, SCALE_NS, 709fc24908eSPaolo Bonzini block_job_sleep_timer_cb, job); 71088691b37SPaolo Bonzini 71188691b37SPaolo Bonzini error_setg(&job->blocker, "block device is in use by block job: %s", 712977c736fSMarkus Armbruster BlockJobType_str(driver->job_type)); 71388691b37SPaolo Bonzini block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); 71488691b37SPaolo Bonzini bs->job = job; 71588691b37SPaolo Bonzini 71688691b37SPaolo Bonzini bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 71788691b37SPaolo Bonzini 71888691b37SPaolo Bonzini QLIST_INSERT_HEAD(&block_jobs, job, job_list); 71988691b37SPaolo Bonzini 72088691b37SPaolo Bonzini blk_add_aio_context_notifier(blk, block_job_attached_aio_context, 72188691b37SPaolo Bonzini block_job_detach_aio_context, job); 72288691b37SPaolo Bonzini 72388691b37SPaolo Bonzini /* Only set speed when necessary to avoid NotSupported error */ 72488691b37SPaolo Bonzini if (speed != 0) { 72588691b37SPaolo Bonzini Error *local_err = NULL; 72688691b37SPaolo Bonzini 72788691b37SPaolo Bonzini block_job_set_speed(job, speed, &local_err); 72888691b37SPaolo Bonzini if (local_err) { 72988691b37SPaolo Bonzini block_job_unref(job); 73088691b37SPaolo Bonzini error_propagate(errp, local_err); 73188691b37SPaolo Bonzini return NULL; 73288691b37SPaolo Bonzini } 73388691b37SPaolo Bonzini } 73488691b37SPaolo Bonzini return job; 73588691b37SPaolo Bonzini } 73688691b37SPaolo Bonzini 737f321dcb5SPaolo Bonzini void block_job_pause_all(void) 738f321dcb5SPaolo Bonzini { 739f321dcb5SPaolo Bonzini BlockJob *job = NULL; 740f321dcb5SPaolo Bonzini while ((job = block_job_next(job))) { 741f321dcb5SPaolo Bonzini AioContext *aio_context = blk_get_aio_context(job->blk); 742f321dcb5SPaolo Bonzini 743f321dcb5SPaolo Bonzini aio_context_acquire(aio_context); 7443d5d319eSAlberto Garcia block_job_ref(job); 745f321dcb5SPaolo Bonzini block_job_pause(job); 746f321dcb5SPaolo Bonzini aio_context_release(aio_context); 747f321dcb5SPaolo Bonzini } 748f321dcb5SPaolo Bonzini } 749f321dcb5SPaolo Bonzini 75088691b37SPaolo Bonzini void block_job_early_fail(BlockJob *job) 75188691b37SPaolo Bonzini { 75288691b37SPaolo Bonzini block_job_unref(job); 75388691b37SPaolo Bonzini } 75488691b37SPaolo Bonzini 75588691b37SPaolo Bonzini void block_job_completed(BlockJob *job, int ret) 75688691b37SPaolo Bonzini { 75788691b37SPaolo Bonzini assert(blk_bs(job->blk)->job == job); 75888691b37SPaolo Bonzini assert(!job->completed); 75988691b37SPaolo Bonzini job->completed = true; 76088691b37SPaolo Bonzini job->ret = ret; 76188691b37SPaolo Bonzini if (!job->txn) { 76288691b37SPaolo Bonzini block_job_completed_single(job); 76388691b37SPaolo Bonzini } else if (ret < 0 || block_job_is_cancelled(job)) { 76488691b37SPaolo Bonzini block_job_completed_txn_abort(job); 76588691b37SPaolo Bonzini } else { 76688691b37SPaolo Bonzini block_job_completed_txn_success(job); 76788691b37SPaolo Bonzini } 76888691b37SPaolo Bonzini } 76988691b37SPaolo Bonzini 77088691b37SPaolo Bonzini static bool block_job_should_pause(BlockJob *job) 77188691b37SPaolo Bonzini { 77288691b37SPaolo Bonzini return job->pause_count > 0; 77388691b37SPaolo Bonzini } 77488691b37SPaolo Bonzini 775fc24908eSPaolo Bonzini /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 776fc24908eSPaolo Bonzini * Reentering the job coroutine with block_job_enter() before the timer has 777fc24908eSPaolo Bonzini * expired is allowed and cancels the timer. 778fc24908eSPaolo Bonzini * 779fc24908eSPaolo Bonzini * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be 780fc24908eSPaolo Bonzini * called explicitly. */ 781fc24908eSPaolo Bonzini static void block_job_do_yield(BlockJob *job, uint64_t ns) 782356f59b8SPaolo Bonzini { 783fc24908eSPaolo Bonzini block_job_lock(); 784fc24908eSPaolo Bonzini if (ns != -1) { 785fc24908eSPaolo Bonzini timer_mod(&job->sleep_timer, ns); 786fc24908eSPaolo Bonzini } 787356f59b8SPaolo Bonzini job->busy = false; 788fc24908eSPaolo Bonzini block_job_unlock(); 789356f59b8SPaolo Bonzini qemu_coroutine_yield(); 790356f59b8SPaolo Bonzini 791356f59b8SPaolo Bonzini /* Set by block_job_enter before re-entering the coroutine. */ 792356f59b8SPaolo Bonzini assert(job->busy); 793356f59b8SPaolo Bonzini } 794356f59b8SPaolo Bonzini 79588691b37SPaolo Bonzini void coroutine_fn block_job_pause_point(BlockJob *job) 79688691b37SPaolo Bonzini { 79788691b37SPaolo Bonzini assert(job && block_job_started(job)); 79888691b37SPaolo Bonzini 79988691b37SPaolo Bonzini if (!block_job_should_pause(job)) { 80088691b37SPaolo Bonzini return; 80188691b37SPaolo Bonzini } 80288691b37SPaolo Bonzini if (block_job_is_cancelled(job)) { 80388691b37SPaolo Bonzini return; 80488691b37SPaolo Bonzini } 80588691b37SPaolo Bonzini 80688691b37SPaolo Bonzini if (job->driver->pause) { 80788691b37SPaolo Bonzini job->driver->pause(job); 80888691b37SPaolo Bonzini } 80988691b37SPaolo Bonzini 81088691b37SPaolo Bonzini if (block_job_should_pause(job) && !block_job_is_cancelled(job)) { 81188691b37SPaolo Bonzini job->paused = true; 812fc24908eSPaolo Bonzini block_job_do_yield(job, -1); 81388691b37SPaolo Bonzini job->paused = false; 81488691b37SPaolo Bonzini } 81588691b37SPaolo Bonzini 81688691b37SPaolo Bonzini if (job->driver->resume) { 81788691b37SPaolo Bonzini job->driver->resume(job); 81888691b37SPaolo Bonzini } 81988691b37SPaolo Bonzini } 82088691b37SPaolo Bonzini 821f321dcb5SPaolo Bonzini void block_job_resume_all(void) 822f321dcb5SPaolo Bonzini { 8233d5d319eSAlberto Garcia BlockJob *job, *next; 8243d5d319eSAlberto Garcia 8253d5d319eSAlberto Garcia QLIST_FOREACH_SAFE(job, &block_jobs, job_list, next) { 826f321dcb5SPaolo Bonzini AioContext *aio_context = blk_get_aio_context(job->blk); 827f321dcb5SPaolo Bonzini 828f321dcb5SPaolo Bonzini aio_context_acquire(aio_context); 829f321dcb5SPaolo Bonzini block_job_resume(job); 8303d5d319eSAlberto Garcia block_job_unref(job); 831f321dcb5SPaolo Bonzini aio_context_release(aio_context); 832f321dcb5SPaolo Bonzini } 833f321dcb5SPaolo Bonzini } 834f321dcb5SPaolo Bonzini 835aa9ef2e6SJohn Snow /* 836aa9ef2e6SJohn Snow * Conditionally enter a block_job pending a call to fn() while 837aa9ef2e6SJohn Snow * under the block_job_lock critical section. 838aa9ef2e6SJohn Snow */ 839aa9ef2e6SJohn Snow static void block_job_enter_cond(BlockJob *job, bool(*fn)(BlockJob *job)) 84088691b37SPaolo Bonzini { 841eb05e011SPaolo Bonzini if (!block_job_started(job)) { 842eb05e011SPaolo Bonzini return; 843eb05e011SPaolo Bonzini } 844eb05e011SPaolo Bonzini if (job->deferred_to_main_loop) { 845eb05e011SPaolo Bonzini return; 846eb05e011SPaolo Bonzini } 847eb05e011SPaolo Bonzini 848fc24908eSPaolo Bonzini block_job_lock(); 849356f59b8SPaolo Bonzini if (job->busy) { 850fc24908eSPaolo Bonzini block_job_unlock(); 851356f59b8SPaolo Bonzini return; 85288691b37SPaolo Bonzini } 853356f59b8SPaolo Bonzini 854aa9ef2e6SJohn Snow if (fn && !fn(job)) { 855aa9ef2e6SJohn Snow block_job_unlock(); 856aa9ef2e6SJohn Snow return; 857aa9ef2e6SJohn Snow } 858aa9ef2e6SJohn Snow 859fc24908eSPaolo Bonzini assert(!job->deferred_to_main_loop); 860fc24908eSPaolo Bonzini timer_del(&job->sleep_timer); 861356f59b8SPaolo Bonzini job->busy = true; 862fc24908eSPaolo Bonzini block_job_unlock(); 863356f59b8SPaolo Bonzini aio_co_wake(job->co); 86488691b37SPaolo Bonzini } 86588691b37SPaolo Bonzini 866aa9ef2e6SJohn Snow void block_job_enter(BlockJob *job) 867aa9ef2e6SJohn Snow { 868aa9ef2e6SJohn Snow block_job_enter_cond(job, NULL); 869aa9ef2e6SJohn Snow } 870aa9ef2e6SJohn Snow 87188691b37SPaolo Bonzini bool block_job_is_cancelled(BlockJob *job) 87288691b37SPaolo Bonzini { 87388691b37SPaolo Bonzini return job->cancelled; 87488691b37SPaolo Bonzini } 87588691b37SPaolo Bonzini 8765bf1d5a7SPaolo Bonzini void block_job_sleep_ns(BlockJob *job, int64_t ns) 87788691b37SPaolo Bonzini { 87888691b37SPaolo Bonzini assert(job->busy); 87988691b37SPaolo Bonzini 88088691b37SPaolo Bonzini /* Check cancellation *before* setting busy = false, too! */ 88188691b37SPaolo Bonzini if (block_job_is_cancelled(job)) { 88288691b37SPaolo Bonzini return; 88388691b37SPaolo Bonzini } 88488691b37SPaolo Bonzini 88588691b37SPaolo Bonzini if (!block_job_should_pause(job)) { 886fc24908eSPaolo Bonzini block_job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 88788691b37SPaolo Bonzini } 88888691b37SPaolo Bonzini 88988691b37SPaolo Bonzini block_job_pause_point(job); 89088691b37SPaolo Bonzini } 89188691b37SPaolo Bonzini 89288691b37SPaolo Bonzini void block_job_yield(BlockJob *job) 89388691b37SPaolo Bonzini { 89488691b37SPaolo Bonzini assert(job->busy); 89588691b37SPaolo Bonzini 89688691b37SPaolo Bonzini /* Check cancellation *before* setting busy = false, too! */ 89788691b37SPaolo Bonzini if (block_job_is_cancelled(job)) { 89888691b37SPaolo Bonzini return; 89988691b37SPaolo Bonzini } 90088691b37SPaolo Bonzini 90188691b37SPaolo Bonzini if (!block_job_should_pause(job)) { 902fc24908eSPaolo Bonzini block_job_do_yield(job, -1); 90388691b37SPaolo Bonzini } 90488691b37SPaolo Bonzini 90588691b37SPaolo Bonzini block_job_pause_point(job); 90688691b37SPaolo Bonzini } 90788691b37SPaolo Bonzini 9082caf63a9SPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 9092caf63a9SPaolo Bonzini { 9104c241cf5SPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 9114c241cf5SPaolo Bonzini return; 9124c241cf5SPaolo Bonzini } 9134c241cf5SPaolo Bonzini assert(job->user_paused && job->pause_count > 0); 9142caf63a9SPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 9152caf63a9SPaolo Bonzini } 9162caf63a9SPaolo Bonzini 917bcada37bSWenchao Xia void block_job_event_ready(BlockJob *job) 918bcada37bSWenchao Xia { 919ef6dbf1eSMax Reitz job->ready = true; 920ef6dbf1eSMax Reitz 921559b935fSJohn Snow if (block_job_is_internal(job)) { 922559b935fSJohn Snow return; 923559b935fSJohn Snow } 924559b935fSJohn Snow 925518848a2SMarkus Armbruster qapi_event_send_block_job_ready(job->driver->job_type, 9268ccb9569SKevin Wolf job->id, 927518848a2SMarkus Armbruster job->len, 928518848a2SMarkus Armbruster job->offset, 929518848a2SMarkus Armbruster job->speed, &error_abort); 930a66a2a36SPaolo Bonzini } 931a66a2a36SPaolo Bonzini 93281e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 93332c81a4aSPaolo Bonzini int is_read, int error) 93432c81a4aSPaolo Bonzini { 93532c81a4aSPaolo Bonzini BlockErrorAction action; 93632c81a4aSPaolo Bonzini 93732c81a4aSPaolo Bonzini switch (on_err) { 93832c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 9398c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 940a589569fSWenchao Xia action = (error == ENOSPC) ? 941a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 94232c81a4aSPaolo Bonzini break; 94332c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 944a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 94532c81a4aSPaolo Bonzini break; 94632c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 947a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 94832c81a4aSPaolo Bonzini break; 94932c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 950a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 95132c81a4aSPaolo Bonzini break; 95232c81a4aSPaolo Bonzini default: 95332c81a4aSPaolo Bonzini abort(); 95432c81a4aSPaolo Bonzini } 955559b935fSJohn Snow if (!block_job_is_internal(job)) { 9568ccb9569SKevin Wolf qapi_event_send_block_job_error(job->id, 9575a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 9585a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 9595a2d2cbdSWenchao Xia action, &error_abort); 960559b935fSJohn Snow } 961a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 962751ebd76SFam Zheng /* make the pause user visible, which will be resumed from QMP. */ 9630df4ba58SJohn Snow block_job_user_pause(job); 96432c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 96532c81a4aSPaolo Bonzini } 96632c81a4aSPaolo Bonzini return action; 96732c81a4aSPaolo Bonzini } 968dec7d421SStefan Hajnoczi 969dec7d421SStefan Hajnoczi typedef struct { 970dec7d421SStefan Hajnoczi BlockJob *job; 971dec7d421SStefan Hajnoczi AioContext *aio_context; 972dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopFn *fn; 973dec7d421SStefan Hajnoczi void *opaque; 974dec7d421SStefan Hajnoczi } BlockJobDeferToMainLoopData; 975dec7d421SStefan Hajnoczi 976dec7d421SStefan Hajnoczi static void block_job_defer_to_main_loop_bh(void *opaque) 977dec7d421SStefan Hajnoczi { 978dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopData *data = opaque; 979dec7d421SStefan Hajnoczi AioContext *aio_context; 980dec7d421SStefan Hajnoczi 981dec7d421SStefan Hajnoczi /* Prevent race with block_job_defer_to_main_loop() */ 982dec7d421SStefan Hajnoczi aio_context_acquire(data->aio_context); 983dec7d421SStefan Hajnoczi 984dec7d421SStefan Hajnoczi /* Fetch BDS AioContext again, in case it has changed */ 985b6d2e599SKevin Wolf aio_context = blk_get_aio_context(data->job->blk); 986d79df2a2SPaolo Bonzini if (aio_context != data->aio_context) { 987dec7d421SStefan Hajnoczi aio_context_acquire(aio_context); 988d79df2a2SPaolo Bonzini } 989dec7d421SStefan Hajnoczi 990dec7d421SStefan Hajnoczi data->fn(data->job, data->opaque); 991dec7d421SStefan Hajnoczi 992d79df2a2SPaolo Bonzini if (aio_context != data->aio_context) { 993dec7d421SStefan Hajnoczi aio_context_release(aio_context); 994d79df2a2SPaolo Bonzini } 995dec7d421SStefan Hajnoczi 996dec7d421SStefan Hajnoczi aio_context_release(data->aio_context); 997dec7d421SStefan Hajnoczi 998dec7d421SStefan Hajnoczi g_free(data); 999dec7d421SStefan Hajnoczi } 1000dec7d421SStefan Hajnoczi 1001dec7d421SStefan Hajnoczi void block_job_defer_to_main_loop(BlockJob *job, 1002dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopFn *fn, 1003dec7d421SStefan Hajnoczi void *opaque) 1004dec7d421SStefan Hajnoczi { 1005dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data)); 1006dec7d421SStefan Hajnoczi data->job = job; 1007b6d2e599SKevin Wolf data->aio_context = blk_get_aio_context(job->blk); 1008dec7d421SStefan Hajnoczi data->fn = fn; 1009dec7d421SStefan Hajnoczi data->opaque = opaque; 1010794f0141SFam Zheng job->deferred_to_main_loop = true; 1011dec7d421SStefan Hajnoczi 1012fffb6e12SPaolo Bonzini aio_bh_schedule_oneshot(qemu_get_aio_context(), 1013fffb6e12SPaolo Bonzini block_job_defer_to_main_loop_bh, data); 1014dec7d421SStefan Hajnoczi } 1015