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" 32cc7a8ea7SMarkus Armbruster #include "qapi/qmp/qerror.h" 337b1b5d19SPaolo Bonzini #include "qapi/qmp/qjson.h" 3410817bf0SDaniel P. Berrange #include "qemu/coroutine.h" 357f0317cfSAlberto Garcia #include "qemu/id.h" 362f0c9fe6SPaolo Bonzini #include "qmp-commands.h" 371de7afc9SPaolo Bonzini #include "qemu/timer.h" 385a2d2cbdSWenchao Xia #include "qapi-event.h" 392f0c9fe6SPaolo Bonzini 40fc24908eSPaolo Bonzini /* Right now, this mutex is only needed to synchronize accesses to job->busy 41fc24908eSPaolo Bonzini * and job->sleep_timer, such as concurrent calls to block_job_do_yield and 42fc24908eSPaolo Bonzini * block_job_enter. */ 43fc24908eSPaolo Bonzini static QemuMutex block_job_mutex; 44fc24908eSPaolo Bonzini 45fc24908eSPaolo Bonzini static void block_job_lock(void) 46fc24908eSPaolo Bonzini { 47fc24908eSPaolo Bonzini qemu_mutex_lock(&block_job_mutex); 48fc24908eSPaolo Bonzini } 49fc24908eSPaolo Bonzini 50fc24908eSPaolo Bonzini static void block_job_unlock(void) 51fc24908eSPaolo Bonzini { 52fc24908eSPaolo Bonzini qemu_mutex_unlock(&block_job_mutex); 53fc24908eSPaolo Bonzini } 54fc24908eSPaolo Bonzini 55fc24908eSPaolo Bonzini static void __attribute__((__constructor__)) block_job_init(void) 56fc24908eSPaolo Bonzini { 57fc24908eSPaolo Bonzini qemu_mutex_init(&block_job_mutex); 58fc24908eSPaolo Bonzini } 59fc24908eSPaolo Bonzini 608254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job); 618254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg); 62*aa9ef2e6SJohn Snow static void block_job_enter_cond(BlockJob *job, bool(*fn)(BlockJob *job)); 638254b6d9SJohn Snow 64c55a832fSFam Zheng /* Transactional group of block jobs */ 65c55a832fSFam Zheng struct BlockJobTxn { 66c55a832fSFam Zheng 67c55a832fSFam Zheng /* Is this txn being cancelled? */ 68c55a832fSFam Zheng bool aborting; 69c55a832fSFam Zheng 70c55a832fSFam Zheng /* List of jobs */ 71c55a832fSFam Zheng QLIST_HEAD(, BlockJob) jobs; 72c55a832fSFam Zheng 73c55a832fSFam Zheng /* Reference count */ 74c55a832fSFam Zheng int refcnt; 75c55a832fSFam Zheng }; 76c55a832fSFam Zheng 77a7112795SAlberto Garcia static QLIST_HEAD(, BlockJob) block_jobs = QLIST_HEAD_INITIALIZER(block_jobs); 78a7112795SAlberto Garcia 7988691b37SPaolo Bonzini /* 8088691b37SPaolo Bonzini * The block job API is composed of two categories of functions. 8188691b37SPaolo Bonzini * 8288691b37SPaolo Bonzini * The first includes functions used by the monitor. The monitor is 8388691b37SPaolo Bonzini * peculiar in that it accesses the block job list with block_job_get, and 8488691b37SPaolo Bonzini * therefore needs consistency across block_job_get and the actual operation 8588691b37SPaolo Bonzini * (e.g. block_job_set_speed). The consistency is achieved with 8688691b37SPaolo Bonzini * aio_context_acquire/release. These functions are declared in blockjob.h. 8788691b37SPaolo Bonzini * 8888691b37SPaolo Bonzini * The second includes functions used by the block job drivers and sometimes 8988691b37SPaolo Bonzini * by the core block layer. These do not care about locking, because the 9088691b37SPaolo Bonzini * whole coroutine runs under the AioContext lock, and are declared in 9188691b37SPaolo Bonzini * blockjob_int.h. 9288691b37SPaolo Bonzini */ 9388691b37SPaolo Bonzini 94a7112795SAlberto Garcia BlockJob *block_job_next(BlockJob *job) 95a7112795SAlberto Garcia { 96a7112795SAlberto Garcia if (!job) { 97a7112795SAlberto Garcia return QLIST_FIRST(&block_jobs); 98a7112795SAlberto Garcia } 99a7112795SAlberto Garcia return QLIST_NEXT(job, job_list); 100a7112795SAlberto Garcia } 101a7112795SAlberto Garcia 102ffb1f10cSAlberto Garcia BlockJob *block_job_get(const char *id) 103ffb1f10cSAlberto Garcia { 104ffb1f10cSAlberto Garcia BlockJob *job; 105ffb1f10cSAlberto Garcia 106ffb1f10cSAlberto Garcia QLIST_FOREACH(job, &block_jobs, job_list) { 107559b935fSJohn Snow if (job->id && !strcmp(id, job->id)) { 108ffb1f10cSAlberto Garcia return job; 109ffb1f10cSAlberto Garcia } 110ffb1f10cSAlberto Garcia } 111ffb1f10cSAlberto Garcia 112ffb1f10cSAlberto Garcia return NULL; 113ffb1f10cSAlberto Garcia } 114ffb1f10cSAlberto Garcia 115c8ab5c2dSPaolo Bonzini BlockJobTxn *block_job_txn_new(void) 116c8ab5c2dSPaolo Bonzini { 117c8ab5c2dSPaolo Bonzini BlockJobTxn *txn = g_new0(BlockJobTxn, 1); 118c8ab5c2dSPaolo Bonzini QLIST_INIT(&txn->jobs); 119c8ab5c2dSPaolo Bonzini txn->refcnt = 1; 120c8ab5c2dSPaolo Bonzini return txn; 121c8ab5c2dSPaolo Bonzini } 122c8ab5c2dSPaolo Bonzini 123c8ab5c2dSPaolo Bonzini static void block_job_txn_ref(BlockJobTxn *txn) 124c8ab5c2dSPaolo Bonzini { 125c8ab5c2dSPaolo Bonzini txn->refcnt++; 126c8ab5c2dSPaolo Bonzini } 127c8ab5c2dSPaolo Bonzini 128c8ab5c2dSPaolo Bonzini void block_job_txn_unref(BlockJobTxn *txn) 129c8ab5c2dSPaolo Bonzini { 130c8ab5c2dSPaolo Bonzini if (txn && --txn->refcnt == 0) { 131c8ab5c2dSPaolo Bonzini g_free(txn); 132c8ab5c2dSPaolo Bonzini } 133c8ab5c2dSPaolo Bonzini } 134c8ab5c2dSPaolo Bonzini 135c8ab5c2dSPaolo Bonzini void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job) 136c8ab5c2dSPaolo Bonzini { 137c8ab5c2dSPaolo Bonzini if (!txn) { 138c8ab5c2dSPaolo Bonzini return; 139c8ab5c2dSPaolo Bonzini } 140c8ab5c2dSPaolo Bonzini 141c8ab5c2dSPaolo Bonzini assert(!job->txn); 142c8ab5c2dSPaolo Bonzini job->txn = txn; 143c8ab5c2dSPaolo Bonzini 144c8ab5c2dSPaolo Bonzini QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 145c8ab5c2dSPaolo Bonzini block_job_txn_ref(txn); 146c8ab5c2dSPaolo Bonzini } 147c8ab5c2dSPaolo Bonzini 148f321dcb5SPaolo Bonzini static void block_job_pause(BlockJob *job) 149f321dcb5SPaolo Bonzini { 150f321dcb5SPaolo Bonzini job->pause_count++; 151f321dcb5SPaolo Bonzini } 152f321dcb5SPaolo Bonzini 153f321dcb5SPaolo Bonzini static void block_job_resume(BlockJob *job) 154f321dcb5SPaolo Bonzini { 155f321dcb5SPaolo Bonzini assert(job->pause_count > 0); 156f321dcb5SPaolo Bonzini job->pause_count--; 157f321dcb5SPaolo Bonzini if (job->pause_count) { 158f321dcb5SPaolo Bonzini return; 159f321dcb5SPaolo Bonzini } 160f321dcb5SPaolo Bonzini block_job_enter(job); 161f321dcb5SPaolo Bonzini } 162f321dcb5SPaolo Bonzini 1634172a003Ssochin.jiang void block_job_ref(BlockJob *job) 16405b0d8e3SPaolo Bonzini { 16505b0d8e3SPaolo Bonzini ++job->refcnt; 16605b0d8e3SPaolo Bonzini } 16705b0d8e3SPaolo Bonzini 16805b0d8e3SPaolo Bonzini static void block_job_attached_aio_context(AioContext *new_context, 16905b0d8e3SPaolo Bonzini void *opaque); 17005b0d8e3SPaolo Bonzini static void block_job_detach_aio_context(void *opaque); 17105b0d8e3SPaolo Bonzini 1724172a003Ssochin.jiang void block_job_unref(BlockJob *job) 17305b0d8e3SPaolo Bonzini { 17405b0d8e3SPaolo Bonzini if (--job->refcnt == 0) { 17505b0d8e3SPaolo Bonzini BlockDriverState *bs = blk_bs(job->blk); 1760a3e155fSAlberto Garcia QLIST_REMOVE(job, job_list); 17705b0d8e3SPaolo Bonzini bs->job = NULL; 17805b0d8e3SPaolo Bonzini block_job_remove_all_bdrv(job); 17905b0d8e3SPaolo Bonzini blk_remove_aio_context_notifier(job->blk, 18005b0d8e3SPaolo Bonzini block_job_attached_aio_context, 18105b0d8e3SPaolo Bonzini block_job_detach_aio_context, job); 18205b0d8e3SPaolo Bonzini blk_unref(job->blk); 18305b0d8e3SPaolo Bonzini error_free(job->blocker); 18405b0d8e3SPaolo Bonzini g_free(job->id); 185fc24908eSPaolo Bonzini assert(!timer_pending(&job->sleep_timer)); 18605b0d8e3SPaolo Bonzini g_free(job); 18705b0d8e3SPaolo Bonzini } 18805b0d8e3SPaolo Bonzini } 18905b0d8e3SPaolo Bonzini 190463e0be1SStefan Hajnoczi static void block_job_attached_aio_context(AioContext *new_context, 191463e0be1SStefan Hajnoczi void *opaque) 192463e0be1SStefan Hajnoczi { 193463e0be1SStefan Hajnoczi BlockJob *job = opaque; 194463e0be1SStefan Hajnoczi 195463e0be1SStefan Hajnoczi if (job->driver->attached_aio_context) { 196463e0be1SStefan Hajnoczi job->driver->attached_aio_context(job, new_context); 197463e0be1SStefan Hajnoczi } 198463e0be1SStefan Hajnoczi 199463e0be1SStefan Hajnoczi block_job_resume(job); 200463e0be1SStefan Hajnoczi } 201463e0be1SStefan Hajnoczi 202bae8196dSPaolo Bonzini static void block_job_drain(BlockJob *job) 203bae8196dSPaolo Bonzini { 204bae8196dSPaolo Bonzini /* If job is !job->busy this kicks it into the next pause point. */ 205bae8196dSPaolo Bonzini block_job_enter(job); 206bae8196dSPaolo Bonzini 207bae8196dSPaolo Bonzini blk_drain(job->blk); 208bae8196dSPaolo Bonzini if (job->driver->drain) { 209bae8196dSPaolo Bonzini job->driver->drain(job); 210bae8196dSPaolo Bonzini } 211bae8196dSPaolo Bonzini } 212bae8196dSPaolo Bonzini 213463e0be1SStefan Hajnoczi static void block_job_detach_aio_context(void *opaque) 214463e0be1SStefan Hajnoczi { 215463e0be1SStefan Hajnoczi BlockJob *job = opaque; 216463e0be1SStefan Hajnoczi 217463e0be1SStefan Hajnoczi /* In case the job terminates during aio_poll()... */ 218463e0be1SStefan Hajnoczi block_job_ref(job); 219463e0be1SStefan Hajnoczi 220463e0be1SStefan Hajnoczi block_job_pause(job); 221463e0be1SStefan Hajnoczi 222463e0be1SStefan Hajnoczi while (!job->paused && !job->completed) { 223bae8196dSPaolo Bonzini block_job_drain(job); 224463e0be1SStefan Hajnoczi } 225463e0be1SStefan Hajnoczi 226463e0be1SStefan Hajnoczi block_job_unref(job); 227463e0be1SStefan Hajnoczi } 228463e0be1SStefan Hajnoczi 229f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c) 230f321dcb5SPaolo Bonzini { 231f321dcb5SPaolo Bonzini BlockJob *job = c->opaque; 232f321dcb5SPaolo Bonzini return g_strdup_printf("%s job '%s'", 233977c736fSMarkus Armbruster BlockJobType_str(job->driver->job_type), 234f321dcb5SPaolo Bonzini job->id); 235f321dcb5SPaolo Bonzini } 236f321dcb5SPaolo Bonzini 237f321dcb5SPaolo Bonzini static const BdrvChildRole child_job = { 238f321dcb5SPaolo Bonzini .get_parent_desc = child_job_get_parent_desc, 239f321dcb5SPaolo Bonzini .stay_at_node = true, 240f321dcb5SPaolo Bonzini }; 241f321dcb5SPaolo Bonzini 242f321dcb5SPaolo Bonzini static void block_job_drained_begin(void *opaque) 243f321dcb5SPaolo Bonzini { 244f321dcb5SPaolo Bonzini BlockJob *job = opaque; 245f321dcb5SPaolo Bonzini block_job_pause(job); 246f321dcb5SPaolo Bonzini } 247f321dcb5SPaolo Bonzini 248f321dcb5SPaolo Bonzini static void block_job_drained_end(void *opaque) 249f321dcb5SPaolo Bonzini { 250f321dcb5SPaolo Bonzini BlockJob *job = opaque; 251f321dcb5SPaolo Bonzini block_job_resume(job); 252f321dcb5SPaolo Bonzini } 253f321dcb5SPaolo Bonzini 254f321dcb5SPaolo Bonzini static const BlockDevOps block_job_dev_ops = { 255f321dcb5SPaolo Bonzini .drained_begin = block_job_drained_begin, 256f321dcb5SPaolo Bonzini .drained_end = block_job_drained_end, 257f321dcb5SPaolo Bonzini }; 258f321dcb5SPaolo Bonzini 259bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job) 260bbc02b90SKevin Wolf { 261bbc02b90SKevin Wolf GSList *l; 262bbc02b90SKevin Wolf for (l = job->nodes; l; l = l->next) { 263bbc02b90SKevin Wolf BdrvChild *c = l->data; 264bbc02b90SKevin Wolf bdrv_op_unblock_all(c->bs, job->blocker); 265bbc02b90SKevin Wolf bdrv_root_unref_child(c); 266bbc02b90SKevin Wolf } 267bbc02b90SKevin Wolf g_slist_free(job->nodes); 268bbc02b90SKevin Wolf job->nodes = NULL; 269bbc02b90SKevin Wolf } 270bbc02b90SKevin Wolf 27176d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 27276d554e2SKevin Wolf uint64_t perm, uint64_t shared_perm, Error **errp) 27323d402d4SAlberto Garcia { 27476d554e2SKevin Wolf BdrvChild *c; 27576d554e2SKevin Wolf 27676d554e2SKevin Wolf c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm, 27776d554e2SKevin Wolf job, errp); 27876d554e2SKevin Wolf if (c == NULL) { 27976d554e2SKevin Wolf return -EPERM; 28076d554e2SKevin Wolf } 28176d554e2SKevin Wolf 28276d554e2SKevin Wolf job->nodes = g_slist_prepend(job->nodes, c); 28323d402d4SAlberto Garcia bdrv_ref(bs); 28423d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 28576d554e2SKevin Wolf 28676d554e2SKevin Wolf return 0; 28723d402d4SAlberto Garcia } 28823d402d4SAlberto Garcia 289559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 290559b935fSJohn Snow { 291559b935fSJohn Snow return (job->id == NULL); 292559b935fSJohn Snow } 293559b935fSJohn Snow 2945ccac6f1SJohn Snow static bool block_job_started(BlockJob *job) 2955ccac6f1SJohn Snow { 2965ccac6f1SJohn Snow return job->co; 2975ccac6f1SJohn Snow } 2985ccac6f1SJohn Snow 299e3796a24SJohn Snow /** 300e3796a24SJohn Snow * All jobs must allow a pause point before entering their job proper. This 301e3796a24SJohn Snow * ensures that jobs can be paused prior to being started, then resumed later. 302e3796a24SJohn Snow */ 303e3796a24SJohn Snow static void coroutine_fn block_job_co_entry(void *opaque) 304e3796a24SJohn Snow { 305e3796a24SJohn Snow BlockJob *job = opaque; 306e3796a24SJohn Snow 307e3796a24SJohn Snow assert(job && job->driver && job->driver->start); 308e3796a24SJohn Snow block_job_pause_point(job); 309e3796a24SJohn Snow job->driver->start(job); 310e3796a24SJohn Snow } 311e3796a24SJohn Snow 312fc24908eSPaolo Bonzini static void block_job_sleep_timer_cb(void *opaque) 313fc24908eSPaolo Bonzini { 314fc24908eSPaolo Bonzini BlockJob *job = opaque; 315fc24908eSPaolo Bonzini 316fc24908eSPaolo Bonzini block_job_enter(job); 317fc24908eSPaolo Bonzini } 318fc24908eSPaolo Bonzini 3195ccac6f1SJohn Snow void block_job_start(BlockJob *job) 3205ccac6f1SJohn Snow { 3215ccac6f1SJohn Snow assert(job && !block_job_started(job) && job->paused && 322e3796a24SJohn Snow job->driver && job->driver->start); 323e3796a24SJohn Snow job->co = qemu_coroutine_create(block_job_co_entry, job); 324e3796a24SJohn Snow job->pause_count--; 3255ccac6f1SJohn Snow job->busy = true; 326e3796a24SJohn Snow job->paused = false; 327aef4278cSFam Zheng bdrv_coroutine_enter(blk_bs(job->blk), job->co); 3285ccac6f1SJohn Snow } 3295ccac6f1SJohn Snow 330c55a832fSFam Zheng static void block_job_completed_single(BlockJob *job) 331c55a832fSFam Zheng { 3324fb588e9SPaolo Bonzini assert(job->completed); 3334fb588e9SPaolo Bonzini 334c55a832fSFam Zheng if (!job->ret) { 335c55a832fSFam Zheng if (job->driver->commit) { 336c55a832fSFam Zheng job->driver->commit(job); 337c55a832fSFam Zheng } 338c55a832fSFam Zheng } else { 339c55a832fSFam Zheng if (job->driver->abort) { 340c55a832fSFam Zheng job->driver->abort(job); 341c55a832fSFam Zheng } 342c55a832fSFam Zheng } 343e8a40bf7SJohn Snow if (job->driver->clean) { 344e8a40bf7SJohn Snow job->driver->clean(job); 345e8a40bf7SJohn Snow } 3468254b6d9SJohn Snow 3478254b6d9SJohn Snow if (job->cb) { 348c55a832fSFam Zheng job->cb(job->opaque, job->ret); 3498254b6d9SJohn Snow } 3505ccac6f1SJohn Snow 3515ccac6f1SJohn Snow /* Emit events only if we actually started */ 3525ccac6f1SJohn Snow if (block_job_started(job)) { 3538254b6d9SJohn Snow if (block_job_is_cancelled(job)) { 3548254b6d9SJohn Snow block_job_event_cancelled(job); 3558254b6d9SJohn Snow } else { 3568254b6d9SJohn Snow const char *msg = NULL; 3578254b6d9SJohn Snow if (job->ret < 0) { 3588254b6d9SJohn Snow msg = strerror(-job->ret); 3598254b6d9SJohn Snow } 3608254b6d9SJohn Snow block_job_event_completed(job, msg); 3618254b6d9SJohn Snow } 3625ccac6f1SJohn Snow } 3638254b6d9SJohn Snow 364c55a832fSFam Zheng if (job->txn) { 3651e93b9fbSVladimir Sementsov-Ogievskiy QLIST_REMOVE(job, txn_list); 366c55a832fSFam Zheng block_job_txn_unref(job->txn); 367c55a832fSFam Zheng } 368c55a832fSFam Zheng block_job_unref(job); 369c55a832fSFam Zheng } 370c55a832fSFam Zheng 3714c241cf5SPaolo Bonzini static void block_job_cancel_async(BlockJob *job) 3724c241cf5SPaolo Bonzini { 3734c241cf5SPaolo Bonzini if (job->iostatus != BLOCK_DEVICE_IO_STATUS_OK) { 3744c241cf5SPaolo Bonzini block_job_iostatus_reset(job); 3754c241cf5SPaolo Bonzini } 3764c241cf5SPaolo Bonzini if (job->user_paused) { 3774c241cf5SPaolo Bonzini /* Do not call block_job_enter here, the caller will handle it. */ 3784c241cf5SPaolo Bonzini job->user_paused = false; 3794c241cf5SPaolo Bonzini job->pause_count--; 3804c241cf5SPaolo Bonzini } 3814c241cf5SPaolo Bonzini job->cancelled = true; 3824c241cf5SPaolo Bonzini } 3834c241cf5SPaolo Bonzini 384c8ab5c2dSPaolo Bonzini static int block_job_finish_sync(BlockJob *job, 385c8ab5c2dSPaolo Bonzini void (*finish)(BlockJob *, Error **errp), 386c8ab5c2dSPaolo Bonzini Error **errp) 387c8ab5c2dSPaolo Bonzini { 388c8ab5c2dSPaolo Bonzini Error *local_err = NULL; 389c8ab5c2dSPaolo Bonzini int ret; 390c8ab5c2dSPaolo Bonzini 391c8ab5c2dSPaolo Bonzini assert(blk_bs(job->blk)->job == job); 392c8ab5c2dSPaolo Bonzini 393c8ab5c2dSPaolo Bonzini block_job_ref(job); 394c8ab5c2dSPaolo Bonzini 3954fb588e9SPaolo Bonzini if (finish) { 396c8ab5c2dSPaolo Bonzini finish(job, &local_err); 3974fb588e9SPaolo Bonzini } 398c8ab5c2dSPaolo Bonzini if (local_err) { 399c8ab5c2dSPaolo Bonzini error_propagate(errp, local_err); 400c8ab5c2dSPaolo Bonzini block_job_unref(job); 401c8ab5c2dSPaolo Bonzini return -EBUSY; 402c8ab5c2dSPaolo Bonzini } 403c8ab5c2dSPaolo Bonzini /* block_job_drain calls block_job_enter, and it should be enough to 404c8ab5c2dSPaolo Bonzini * induce progress until the job completes or moves to the main thread. 405c8ab5c2dSPaolo Bonzini */ 406c8ab5c2dSPaolo Bonzini while (!job->deferred_to_main_loop && !job->completed) { 407c8ab5c2dSPaolo Bonzini block_job_drain(job); 408c8ab5c2dSPaolo Bonzini } 409c8ab5c2dSPaolo Bonzini while (!job->completed) { 410c8ab5c2dSPaolo Bonzini aio_poll(qemu_get_aio_context(), true); 411c8ab5c2dSPaolo Bonzini } 412c8ab5c2dSPaolo Bonzini ret = (job->cancelled && job->ret == 0) ? -ECANCELED : job->ret; 413c8ab5c2dSPaolo Bonzini block_job_unref(job); 414c8ab5c2dSPaolo Bonzini return ret; 415c8ab5c2dSPaolo Bonzini } 416c8ab5c2dSPaolo Bonzini 417c55a832fSFam Zheng static void block_job_completed_txn_abort(BlockJob *job) 418c55a832fSFam Zheng { 419c55a832fSFam Zheng AioContext *ctx; 420c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 4214fb588e9SPaolo Bonzini BlockJob *other_job; 422c55a832fSFam Zheng 423c55a832fSFam Zheng if (txn->aborting) { 424c55a832fSFam Zheng /* 425c55a832fSFam Zheng * We are cancelled by another job, which will handle everything. 426c55a832fSFam Zheng */ 427c55a832fSFam Zheng return; 428c55a832fSFam Zheng } 429c55a832fSFam Zheng txn->aborting = true; 4304fb588e9SPaolo Bonzini block_job_txn_ref(txn); 4314fb588e9SPaolo Bonzini 432c55a832fSFam Zheng /* We are the first failed job. Cancel other jobs. */ 433c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 434b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 435c55a832fSFam Zheng aio_context_acquire(ctx); 436c55a832fSFam Zheng } 4374fb588e9SPaolo Bonzini 4384fb588e9SPaolo Bonzini /* Other jobs are effectively cancelled by us, set the status for 439c55a832fSFam Zheng * them; this job, however, may or may not be cancelled, depending 440c55a832fSFam Zheng * on the caller, so leave it. */ 4414fb588e9SPaolo Bonzini QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 442c55a832fSFam Zheng if (other_job != job) { 4434c241cf5SPaolo Bonzini block_job_cancel_async(other_job); 444c55a832fSFam Zheng } 445c55a832fSFam Zheng } 4464fb588e9SPaolo Bonzini while (!QLIST_EMPTY(&txn->jobs)) { 4474fb588e9SPaolo Bonzini other_job = QLIST_FIRST(&txn->jobs); 448b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 4494fb588e9SPaolo Bonzini if (!other_job->completed) { 4504fb588e9SPaolo Bonzini assert(other_job->cancelled); 4514fb588e9SPaolo Bonzini block_job_finish_sync(other_job, NULL, NULL); 4524fb588e9SPaolo Bonzini } 453c55a832fSFam Zheng block_job_completed_single(other_job); 454c55a832fSFam Zheng aio_context_release(ctx); 455c55a832fSFam Zheng } 4564fb588e9SPaolo Bonzini 4574fb588e9SPaolo Bonzini block_job_txn_unref(txn); 458c55a832fSFam Zheng } 459c55a832fSFam Zheng 460c55a832fSFam Zheng static void block_job_completed_txn_success(BlockJob *job) 461c55a832fSFam Zheng { 462c55a832fSFam Zheng AioContext *ctx; 463c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 464c55a832fSFam Zheng BlockJob *other_job, *next; 465c55a832fSFam Zheng /* 466c55a832fSFam Zheng * Successful completion, see if there are other running jobs in this 467c55a832fSFam Zheng * txn. 468c55a832fSFam Zheng */ 469c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 470c55a832fSFam Zheng if (!other_job->completed) { 471c55a832fSFam Zheng return; 472c55a832fSFam Zheng } 473c55a832fSFam Zheng } 474c55a832fSFam Zheng /* We are the last completed job, commit the transaction. */ 475c55a832fSFam Zheng QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { 476b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 477c55a832fSFam Zheng aio_context_acquire(ctx); 478c55a832fSFam Zheng assert(other_job->ret == 0); 479c55a832fSFam Zheng block_job_completed_single(other_job); 480c55a832fSFam Zheng aio_context_release(ctx); 481c55a832fSFam Zheng } 482c55a832fSFam Zheng } 483c55a832fSFam Zheng 484*aa9ef2e6SJohn Snow /* Assumes the block_job_mutex is held */ 485*aa9ef2e6SJohn Snow static bool block_job_timer_pending(BlockJob *job) 486*aa9ef2e6SJohn Snow { 487*aa9ef2e6SJohn Snow return timer_pending(&job->sleep_timer); 488*aa9ef2e6SJohn Snow } 489*aa9ef2e6SJohn Snow 4902f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 4912f0c9fe6SPaolo Bonzini { 4922f0c9fe6SPaolo Bonzini Error *local_err = NULL; 493*aa9ef2e6SJohn Snow int64_t old_speed = job->speed; 4942f0c9fe6SPaolo Bonzini 4953fc4b10aSFam Zheng if (!job->driver->set_speed) { 496c6bd8c70SMarkus Armbruster error_setg(errp, QERR_UNSUPPORTED); 4972f0c9fe6SPaolo Bonzini return; 4982f0c9fe6SPaolo Bonzini } 4993fc4b10aSFam Zheng job->driver->set_speed(job, speed, &local_err); 50084d18f06SMarkus Armbruster if (local_err) { 5012f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 5022f0c9fe6SPaolo Bonzini return; 5032f0c9fe6SPaolo Bonzini } 5042f0c9fe6SPaolo Bonzini 5052f0c9fe6SPaolo Bonzini job->speed = speed; 506*aa9ef2e6SJohn Snow if (speed <= old_speed) { 507*aa9ef2e6SJohn Snow return; 508*aa9ef2e6SJohn Snow } 509*aa9ef2e6SJohn Snow 510*aa9ef2e6SJohn Snow /* kick only if a timer is pending */ 511*aa9ef2e6SJohn Snow block_job_enter_cond(job, block_job_timer_pending); 5122f0c9fe6SPaolo Bonzini } 5132f0c9fe6SPaolo Bonzini 514aeae883bSPaolo Bonzini void block_job_complete(BlockJob *job, Error **errp) 515aeae883bSPaolo Bonzini { 516559b935fSJohn Snow /* Should not be reachable via external interface for internal jobs */ 517559b935fSJohn Snow assert(job->id); 5185ccac6f1SJohn Snow if (job->pause_count || job->cancelled || 5195ccac6f1SJohn Snow !block_job_started(job) || !job->driver->complete) { 5209df229c3SAlberto Garcia error_setg(errp, "The active block job '%s' cannot be completed", 5219df229c3SAlberto Garcia job->id); 522aeae883bSPaolo Bonzini return; 523aeae883bSPaolo Bonzini } 524aeae883bSPaolo Bonzini 5253fc4b10aSFam Zheng job->driver->complete(job, errp); 526aeae883bSPaolo Bonzini } 527aeae883bSPaolo Bonzini 5280df4ba58SJohn Snow void block_job_user_pause(BlockJob *job) 5290df4ba58SJohn Snow { 5300df4ba58SJohn Snow job->user_paused = true; 5310df4ba58SJohn Snow block_job_pause(job); 5320df4ba58SJohn Snow } 5330df4ba58SJohn Snow 5340df4ba58SJohn Snow bool block_job_user_paused(BlockJob *job) 5350df4ba58SJohn Snow { 5366573d9c6SPaolo Bonzini return job->user_paused; 5370df4ba58SJohn Snow } 5380df4ba58SJohn Snow 5390df4ba58SJohn Snow void block_job_user_resume(BlockJob *job) 5400df4ba58SJohn Snow { 5410df4ba58SJohn Snow if (job && job->user_paused && job->pause_count > 0) { 5422caf63a9SPaolo Bonzini block_job_iostatus_reset(job); 5434c241cf5SPaolo Bonzini job->user_paused = false; 5440df4ba58SJohn Snow block_job_resume(job); 5450df4ba58SJohn Snow } 5460df4ba58SJohn Snow } 5470df4ba58SJohn Snow 5488acc72a4SPaolo Bonzini void block_job_cancel(BlockJob *job) 5498acc72a4SPaolo Bonzini { 5505ccac6f1SJohn Snow if (block_job_started(job)) { 5514c241cf5SPaolo Bonzini block_job_cancel_async(job); 552751ebd76SFam Zheng block_job_enter(job); 5535ccac6f1SJohn Snow } else { 5545ccac6f1SJohn Snow block_job_completed(job, -ECANCELED); 5555ccac6f1SJohn Snow } 5568acc72a4SPaolo Bonzini } 5578acc72a4SPaolo Bonzini 558345f9e1bSMax Reitz /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be 559345f9e1bSMax Reitz * used with block_job_finish_sync() without the need for (rather nasty) 560345f9e1bSMax Reitz * function pointer casts there. */ 561345f9e1bSMax Reitz static void block_job_cancel_err(BlockJob *job, Error **errp) 562345f9e1bSMax Reitz { 563345f9e1bSMax Reitz block_job_cancel(job); 564345f9e1bSMax Reitz } 565345f9e1bSMax Reitz 566345f9e1bSMax Reitz int block_job_cancel_sync(BlockJob *job) 567345f9e1bSMax Reitz { 568345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_cancel_err, NULL); 569345f9e1bSMax Reitz } 570345f9e1bSMax Reitz 571a1a2af07SKevin Wolf void block_job_cancel_sync_all(void) 572a1a2af07SKevin Wolf { 573a1a2af07SKevin Wolf BlockJob *job; 574a1a2af07SKevin Wolf AioContext *aio_context; 575a1a2af07SKevin Wolf 576a1a2af07SKevin Wolf while ((job = QLIST_FIRST(&block_jobs))) { 577b6d2e599SKevin Wolf aio_context = blk_get_aio_context(job->blk); 578a1a2af07SKevin Wolf aio_context_acquire(aio_context); 579a1a2af07SKevin Wolf block_job_cancel_sync(job); 580a1a2af07SKevin Wolf aio_context_release(aio_context); 581a1a2af07SKevin Wolf } 582a1a2af07SKevin Wolf } 583a1a2af07SKevin Wolf 584345f9e1bSMax Reitz int block_job_complete_sync(BlockJob *job, Error **errp) 585345f9e1bSMax Reitz { 586345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_complete, errp); 587345f9e1bSMax Reitz } 588345f9e1bSMax Reitz 589559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp) 59030e628b7SPaolo Bonzini { 591559b935fSJohn Snow BlockJobInfo *info; 592559b935fSJohn Snow 593559b935fSJohn Snow if (block_job_is_internal(job)) { 594559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 595559b935fSJohn Snow return NULL; 596559b935fSJohn Snow } 597559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 598977c736fSMarkus Armbruster info->type = g_strdup(BlockJobType_str(job->driver->job_type)); 5998ccb9569SKevin Wolf info->device = g_strdup(job->id); 60030e628b7SPaolo Bonzini info->len = job->len; 601fc24908eSPaolo Bonzini info->busy = atomic_read(&job->busy); 602751ebd76SFam Zheng info->paused = job->pause_count > 0; 60330e628b7SPaolo Bonzini info->offset = job->offset; 60430e628b7SPaolo Bonzini info->speed = job->speed; 60532c81a4aSPaolo Bonzini info->io_status = job->iostatus; 606ef6dbf1eSMax Reitz info->ready = job->ready; 60730e628b7SPaolo Bonzini return info; 60830e628b7SPaolo Bonzini } 60932c81a4aSPaolo Bonzini 61032c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 61132c81a4aSPaolo Bonzini { 61232c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 61332c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 61432c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 61532c81a4aSPaolo Bonzini } 61632c81a4aSPaolo Bonzini } 61732c81a4aSPaolo Bonzini 6188254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job) 619a66a2a36SPaolo Bonzini { 620559b935fSJohn Snow if (block_job_is_internal(job)) { 621559b935fSJohn Snow return; 622559b935fSJohn Snow } 623559b935fSJohn Snow 624bcada37bSWenchao Xia qapi_event_send_block_job_cancelled(job->driver->job_type, 6258ccb9569SKevin Wolf job->id, 626a66a2a36SPaolo Bonzini job->len, 627a66a2a36SPaolo Bonzini job->offset, 628bcada37bSWenchao Xia job->speed, 629bcada37bSWenchao Xia &error_abort); 630a66a2a36SPaolo Bonzini } 631a66a2a36SPaolo Bonzini 6328254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg) 633a66a2a36SPaolo Bonzini { 634559b935fSJohn Snow if (block_job_is_internal(job)) { 635559b935fSJohn Snow return; 636559b935fSJohn Snow } 637559b935fSJohn Snow 638bcada37bSWenchao Xia qapi_event_send_block_job_completed(job->driver->job_type, 6398ccb9569SKevin Wolf job->id, 640bcada37bSWenchao Xia job->len, 641bcada37bSWenchao Xia job->offset, 642bcada37bSWenchao Xia job->speed, 643bcada37bSWenchao Xia !!msg, 644bcada37bSWenchao Xia msg, 645bcada37bSWenchao Xia &error_abort); 646bcada37bSWenchao Xia } 647bcada37bSWenchao Xia 64888691b37SPaolo Bonzini /* 64988691b37SPaolo Bonzini * API for block job drivers and the block layer. These functions are 65088691b37SPaolo Bonzini * declared in blockjob_int.h. 65188691b37SPaolo Bonzini */ 65288691b37SPaolo Bonzini 65388691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver, 65488691b37SPaolo Bonzini BlockDriverState *bs, uint64_t perm, 65588691b37SPaolo Bonzini uint64_t shared_perm, int64_t speed, int flags, 65688691b37SPaolo Bonzini BlockCompletionFunc *cb, void *opaque, Error **errp) 65788691b37SPaolo Bonzini { 65888691b37SPaolo Bonzini BlockBackend *blk; 65988691b37SPaolo Bonzini BlockJob *job; 66088691b37SPaolo Bonzini int ret; 66188691b37SPaolo Bonzini 66288691b37SPaolo Bonzini if (bs->job) { 66388691b37SPaolo Bonzini error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); 66488691b37SPaolo Bonzini return NULL; 66588691b37SPaolo Bonzini } 66688691b37SPaolo Bonzini 66788691b37SPaolo Bonzini if (job_id == NULL && !(flags & BLOCK_JOB_INTERNAL)) { 66888691b37SPaolo Bonzini job_id = bdrv_get_device_name(bs); 66988691b37SPaolo Bonzini if (!*job_id) { 67088691b37SPaolo Bonzini error_setg(errp, "An explicit job ID is required for this node"); 67188691b37SPaolo Bonzini return NULL; 67288691b37SPaolo Bonzini } 67388691b37SPaolo Bonzini } 67488691b37SPaolo Bonzini 67588691b37SPaolo Bonzini if (job_id) { 67688691b37SPaolo Bonzini if (flags & BLOCK_JOB_INTERNAL) { 67788691b37SPaolo Bonzini error_setg(errp, "Cannot specify job ID for internal block job"); 67888691b37SPaolo Bonzini return NULL; 67988691b37SPaolo Bonzini } 68088691b37SPaolo Bonzini 68188691b37SPaolo Bonzini if (!id_wellformed(job_id)) { 68288691b37SPaolo Bonzini error_setg(errp, "Invalid job ID '%s'", job_id); 68388691b37SPaolo Bonzini return NULL; 68488691b37SPaolo Bonzini } 68588691b37SPaolo Bonzini 68688691b37SPaolo Bonzini if (block_job_get(job_id)) { 68788691b37SPaolo Bonzini error_setg(errp, "Job ID '%s' already in use", job_id); 68888691b37SPaolo Bonzini return NULL; 68988691b37SPaolo Bonzini } 69088691b37SPaolo Bonzini } 69188691b37SPaolo Bonzini 69288691b37SPaolo Bonzini blk = blk_new(perm, shared_perm); 69388691b37SPaolo Bonzini ret = blk_insert_bs(blk, bs, errp); 69488691b37SPaolo Bonzini if (ret < 0) { 69588691b37SPaolo Bonzini blk_unref(blk); 69688691b37SPaolo Bonzini return NULL; 69788691b37SPaolo Bonzini } 69888691b37SPaolo Bonzini 69988691b37SPaolo Bonzini job = g_malloc0(driver->instance_size); 70088691b37SPaolo Bonzini job->driver = driver; 70188691b37SPaolo Bonzini job->id = g_strdup(job_id); 70288691b37SPaolo Bonzini job->blk = blk; 70388691b37SPaolo Bonzini job->cb = cb; 70488691b37SPaolo Bonzini job->opaque = opaque; 70588691b37SPaolo Bonzini job->busy = false; 70688691b37SPaolo Bonzini job->paused = true; 70788691b37SPaolo Bonzini job->pause_count = 1; 70888691b37SPaolo Bonzini job->refcnt = 1; 709fc24908eSPaolo Bonzini aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, 710fc24908eSPaolo Bonzini QEMU_CLOCK_REALTIME, SCALE_NS, 711fc24908eSPaolo Bonzini block_job_sleep_timer_cb, job); 71288691b37SPaolo Bonzini 71388691b37SPaolo Bonzini error_setg(&job->blocker, "block device is in use by block job: %s", 714977c736fSMarkus Armbruster BlockJobType_str(driver->job_type)); 71588691b37SPaolo Bonzini block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); 71688691b37SPaolo Bonzini bs->job = job; 71788691b37SPaolo Bonzini 71888691b37SPaolo Bonzini blk_set_dev_ops(blk, &block_job_dev_ops, job); 71988691b37SPaolo Bonzini bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 72088691b37SPaolo Bonzini 72188691b37SPaolo Bonzini QLIST_INSERT_HEAD(&block_jobs, job, job_list); 72288691b37SPaolo Bonzini 72388691b37SPaolo Bonzini blk_add_aio_context_notifier(blk, block_job_attached_aio_context, 72488691b37SPaolo Bonzini block_job_detach_aio_context, job); 72588691b37SPaolo Bonzini 72688691b37SPaolo Bonzini /* Only set speed when necessary to avoid NotSupported error */ 72788691b37SPaolo Bonzini if (speed != 0) { 72888691b37SPaolo Bonzini Error *local_err = NULL; 72988691b37SPaolo Bonzini 73088691b37SPaolo Bonzini block_job_set_speed(job, speed, &local_err); 73188691b37SPaolo Bonzini if (local_err) { 73288691b37SPaolo Bonzini block_job_unref(job); 73388691b37SPaolo Bonzini error_propagate(errp, local_err); 73488691b37SPaolo Bonzini return NULL; 73588691b37SPaolo Bonzini } 73688691b37SPaolo Bonzini } 73788691b37SPaolo Bonzini return job; 73888691b37SPaolo Bonzini } 73988691b37SPaolo Bonzini 740f321dcb5SPaolo Bonzini void block_job_pause_all(void) 741f321dcb5SPaolo Bonzini { 742f321dcb5SPaolo Bonzini BlockJob *job = NULL; 743f321dcb5SPaolo Bonzini while ((job = block_job_next(job))) { 744f321dcb5SPaolo Bonzini AioContext *aio_context = blk_get_aio_context(job->blk); 745f321dcb5SPaolo Bonzini 746f321dcb5SPaolo Bonzini aio_context_acquire(aio_context); 7473d5d319eSAlberto Garcia block_job_ref(job); 748f321dcb5SPaolo Bonzini block_job_pause(job); 749f321dcb5SPaolo Bonzini aio_context_release(aio_context); 750f321dcb5SPaolo Bonzini } 751f321dcb5SPaolo Bonzini } 752f321dcb5SPaolo Bonzini 75388691b37SPaolo Bonzini void block_job_early_fail(BlockJob *job) 75488691b37SPaolo Bonzini { 75588691b37SPaolo Bonzini block_job_unref(job); 75688691b37SPaolo Bonzini } 75788691b37SPaolo Bonzini 75888691b37SPaolo Bonzini void block_job_completed(BlockJob *job, int ret) 75988691b37SPaolo Bonzini { 76088691b37SPaolo Bonzini assert(blk_bs(job->blk)->job == job); 76188691b37SPaolo Bonzini assert(!job->completed); 76288691b37SPaolo Bonzini job->completed = true; 76388691b37SPaolo Bonzini job->ret = ret; 76488691b37SPaolo Bonzini if (!job->txn) { 76588691b37SPaolo Bonzini block_job_completed_single(job); 76688691b37SPaolo Bonzini } else if (ret < 0 || block_job_is_cancelled(job)) { 76788691b37SPaolo Bonzini block_job_completed_txn_abort(job); 76888691b37SPaolo Bonzini } else { 76988691b37SPaolo Bonzini block_job_completed_txn_success(job); 77088691b37SPaolo Bonzini } 77188691b37SPaolo Bonzini } 77288691b37SPaolo Bonzini 77388691b37SPaolo Bonzini static bool block_job_should_pause(BlockJob *job) 77488691b37SPaolo Bonzini { 77588691b37SPaolo Bonzini return job->pause_count > 0; 77688691b37SPaolo Bonzini } 77788691b37SPaolo Bonzini 778fc24908eSPaolo Bonzini /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. 779fc24908eSPaolo Bonzini * Reentering the job coroutine with block_job_enter() before the timer has 780fc24908eSPaolo Bonzini * expired is allowed and cancels the timer. 781fc24908eSPaolo Bonzini * 782fc24908eSPaolo Bonzini * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be 783fc24908eSPaolo Bonzini * called explicitly. */ 784fc24908eSPaolo Bonzini static void block_job_do_yield(BlockJob *job, uint64_t ns) 785356f59b8SPaolo Bonzini { 786fc24908eSPaolo Bonzini block_job_lock(); 787fc24908eSPaolo Bonzini if (ns != -1) { 788fc24908eSPaolo Bonzini timer_mod(&job->sleep_timer, ns); 789fc24908eSPaolo Bonzini } 790356f59b8SPaolo Bonzini job->busy = false; 791fc24908eSPaolo Bonzini block_job_unlock(); 792356f59b8SPaolo Bonzini qemu_coroutine_yield(); 793356f59b8SPaolo Bonzini 794356f59b8SPaolo Bonzini /* Set by block_job_enter before re-entering the coroutine. */ 795356f59b8SPaolo Bonzini assert(job->busy); 796356f59b8SPaolo Bonzini } 797356f59b8SPaolo Bonzini 79888691b37SPaolo Bonzini void coroutine_fn block_job_pause_point(BlockJob *job) 79988691b37SPaolo Bonzini { 80088691b37SPaolo Bonzini assert(job && block_job_started(job)); 80188691b37SPaolo Bonzini 80288691b37SPaolo Bonzini if (!block_job_should_pause(job)) { 80388691b37SPaolo Bonzini return; 80488691b37SPaolo Bonzini } 80588691b37SPaolo Bonzini if (block_job_is_cancelled(job)) { 80688691b37SPaolo Bonzini return; 80788691b37SPaolo Bonzini } 80888691b37SPaolo Bonzini 80988691b37SPaolo Bonzini if (job->driver->pause) { 81088691b37SPaolo Bonzini job->driver->pause(job); 81188691b37SPaolo Bonzini } 81288691b37SPaolo Bonzini 81388691b37SPaolo Bonzini if (block_job_should_pause(job) && !block_job_is_cancelled(job)) { 81488691b37SPaolo Bonzini job->paused = true; 815fc24908eSPaolo Bonzini block_job_do_yield(job, -1); 81688691b37SPaolo Bonzini job->paused = false; 81788691b37SPaolo Bonzini } 81888691b37SPaolo Bonzini 81988691b37SPaolo Bonzini if (job->driver->resume) { 82088691b37SPaolo Bonzini job->driver->resume(job); 82188691b37SPaolo Bonzini } 82288691b37SPaolo Bonzini } 82388691b37SPaolo Bonzini 824f321dcb5SPaolo Bonzini void block_job_resume_all(void) 825f321dcb5SPaolo Bonzini { 8263d5d319eSAlberto Garcia BlockJob *job, *next; 8273d5d319eSAlberto Garcia 8283d5d319eSAlberto Garcia QLIST_FOREACH_SAFE(job, &block_jobs, job_list, next) { 829f321dcb5SPaolo Bonzini AioContext *aio_context = blk_get_aio_context(job->blk); 830f321dcb5SPaolo Bonzini 831f321dcb5SPaolo Bonzini aio_context_acquire(aio_context); 832f321dcb5SPaolo Bonzini block_job_resume(job); 8333d5d319eSAlberto Garcia block_job_unref(job); 834f321dcb5SPaolo Bonzini aio_context_release(aio_context); 835f321dcb5SPaolo Bonzini } 836f321dcb5SPaolo Bonzini } 837f321dcb5SPaolo Bonzini 838*aa9ef2e6SJohn Snow /* 839*aa9ef2e6SJohn Snow * Conditionally enter a block_job pending a call to fn() while 840*aa9ef2e6SJohn Snow * under the block_job_lock critical section. 841*aa9ef2e6SJohn Snow */ 842*aa9ef2e6SJohn Snow static void block_job_enter_cond(BlockJob *job, bool(*fn)(BlockJob *job)) 84388691b37SPaolo Bonzini { 844eb05e011SPaolo Bonzini if (!block_job_started(job)) { 845eb05e011SPaolo Bonzini return; 846eb05e011SPaolo Bonzini } 847eb05e011SPaolo Bonzini if (job->deferred_to_main_loop) { 848eb05e011SPaolo Bonzini return; 849eb05e011SPaolo Bonzini } 850eb05e011SPaolo Bonzini 851fc24908eSPaolo Bonzini block_job_lock(); 852356f59b8SPaolo Bonzini if (job->busy) { 853fc24908eSPaolo Bonzini block_job_unlock(); 854356f59b8SPaolo Bonzini return; 85588691b37SPaolo Bonzini } 856356f59b8SPaolo Bonzini 857*aa9ef2e6SJohn Snow if (fn && !fn(job)) { 858*aa9ef2e6SJohn Snow block_job_unlock(); 859*aa9ef2e6SJohn Snow return; 860*aa9ef2e6SJohn Snow } 861*aa9ef2e6SJohn Snow 862fc24908eSPaolo Bonzini assert(!job->deferred_to_main_loop); 863fc24908eSPaolo Bonzini timer_del(&job->sleep_timer); 864356f59b8SPaolo Bonzini job->busy = true; 865fc24908eSPaolo Bonzini block_job_unlock(); 866356f59b8SPaolo Bonzini aio_co_wake(job->co); 86788691b37SPaolo Bonzini } 86888691b37SPaolo Bonzini 869*aa9ef2e6SJohn Snow void block_job_enter(BlockJob *job) 870*aa9ef2e6SJohn Snow { 871*aa9ef2e6SJohn Snow block_job_enter_cond(job, NULL); 872*aa9ef2e6SJohn Snow } 873*aa9ef2e6SJohn Snow 87488691b37SPaolo Bonzini bool block_job_is_cancelled(BlockJob *job) 87588691b37SPaolo Bonzini { 87688691b37SPaolo Bonzini return job->cancelled; 87788691b37SPaolo Bonzini } 87888691b37SPaolo Bonzini 8795bf1d5a7SPaolo Bonzini void block_job_sleep_ns(BlockJob *job, int64_t ns) 88088691b37SPaolo Bonzini { 88188691b37SPaolo Bonzini assert(job->busy); 88288691b37SPaolo Bonzini 88388691b37SPaolo Bonzini /* Check cancellation *before* setting busy = false, too! */ 88488691b37SPaolo Bonzini if (block_job_is_cancelled(job)) { 88588691b37SPaolo Bonzini return; 88688691b37SPaolo Bonzini } 88788691b37SPaolo Bonzini 88888691b37SPaolo Bonzini if (!block_job_should_pause(job)) { 889fc24908eSPaolo Bonzini block_job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); 89088691b37SPaolo Bonzini } 89188691b37SPaolo Bonzini 89288691b37SPaolo Bonzini block_job_pause_point(job); 89388691b37SPaolo Bonzini } 89488691b37SPaolo Bonzini 89588691b37SPaolo Bonzini void block_job_yield(BlockJob *job) 89688691b37SPaolo Bonzini { 89788691b37SPaolo Bonzini assert(job->busy); 89888691b37SPaolo Bonzini 89988691b37SPaolo Bonzini /* Check cancellation *before* setting busy = false, too! */ 90088691b37SPaolo Bonzini if (block_job_is_cancelled(job)) { 90188691b37SPaolo Bonzini return; 90288691b37SPaolo Bonzini } 90388691b37SPaolo Bonzini 90488691b37SPaolo Bonzini if (!block_job_should_pause(job)) { 905fc24908eSPaolo Bonzini block_job_do_yield(job, -1); 90688691b37SPaolo Bonzini } 90788691b37SPaolo Bonzini 90888691b37SPaolo Bonzini block_job_pause_point(job); 90988691b37SPaolo Bonzini } 91088691b37SPaolo Bonzini 9112caf63a9SPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 9122caf63a9SPaolo Bonzini { 9134c241cf5SPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 9144c241cf5SPaolo Bonzini return; 9154c241cf5SPaolo Bonzini } 9164c241cf5SPaolo Bonzini assert(job->user_paused && job->pause_count > 0); 9172caf63a9SPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 9182caf63a9SPaolo Bonzini } 9192caf63a9SPaolo Bonzini 920bcada37bSWenchao Xia void block_job_event_ready(BlockJob *job) 921bcada37bSWenchao Xia { 922ef6dbf1eSMax Reitz job->ready = true; 923ef6dbf1eSMax Reitz 924559b935fSJohn Snow if (block_job_is_internal(job)) { 925559b935fSJohn Snow return; 926559b935fSJohn Snow } 927559b935fSJohn Snow 928518848a2SMarkus Armbruster qapi_event_send_block_job_ready(job->driver->job_type, 9298ccb9569SKevin Wolf job->id, 930518848a2SMarkus Armbruster job->len, 931518848a2SMarkus Armbruster job->offset, 932518848a2SMarkus Armbruster job->speed, &error_abort); 933a66a2a36SPaolo Bonzini } 934a66a2a36SPaolo Bonzini 93581e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 93632c81a4aSPaolo Bonzini int is_read, int error) 93732c81a4aSPaolo Bonzini { 93832c81a4aSPaolo Bonzini BlockErrorAction action; 93932c81a4aSPaolo Bonzini 94032c81a4aSPaolo Bonzini switch (on_err) { 94132c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 9428c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 943a589569fSWenchao Xia action = (error == ENOSPC) ? 944a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 94532c81a4aSPaolo Bonzini break; 94632c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 947a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 94832c81a4aSPaolo Bonzini break; 94932c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 950a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 95132c81a4aSPaolo Bonzini break; 95232c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 953a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 95432c81a4aSPaolo Bonzini break; 95532c81a4aSPaolo Bonzini default: 95632c81a4aSPaolo Bonzini abort(); 95732c81a4aSPaolo Bonzini } 958559b935fSJohn Snow if (!block_job_is_internal(job)) { 9598ccb9569SKevin Wolf qapi_event_send_block_job_error(job->id, 9605a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 9615a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 9625a2d2cbdSWenchao Xia action, &error_abort); 963559b935fSJohn Snow } 964a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 965751ebd76SFam Zheng /* make the pause user visible, which will be resumed from QMP. */ 9660df4ba58SJohn Snow block_job_user_pause(job); 96732c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 96832c81a4aSPaolo Bonzini } 96932c81a4aSPaolo Bonzini return action; 97032c81a4aSPaolo Bonzini } 971dec7d421SStefan Hajnoczi 972dec7d421SStefan Hajnoczi typedef struct { 973dec7d421SStefan Hajnoczi BlockJob *job; 974dec7d421SStefan Hajnoczi AioContext *aio_context; 975dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopFn *fn; 976dec7d421SStefan Hajnoczi void *opaque; 977dec7d421SStefan Hajnoczi } BlockJobDeferToMainLoopData; 978dec7d421SStefan Hajnoczi 979dec7d421SStefan Hajnoczi static void block_job_defer_to_main_loop_bh(void *opaque) 980dec7d421SStefan Hajnoczi { 981dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopData *data = opaque; 982dec7d421SStefan Hajnoczi AioContext *aio_context; 983dec7d421SStefan Hajnoczi 984dec7d421SStefan Hajnoczi /* Prevent race with block_job_defer_to_main_loop() */ 985dec7d421SStefan Hajnoczi aio_context_acquire(data->aio_context); 986dec7d421SStefan Hajnoczi 987dec7d421SStefan Hajnoczi /* Fetch BDS AioContext again, in case it has changed */ 988b6d2e599SKevin Wolf aio_context = blk_get_aio_context(data->job->blk); 989d79df2a2SPaolo Bonzini if (aio_context != data->aio_context) { 990dec7d421SStefan Hajnoczi aio_context_acquire(aio_context); 991d79df2a2SPaolo Bonzini } 992dec7d421SStefan Hajnoczi 993dec7d421SStefan Hajnoczi data->fn(data->job, data->opaque); 994dec7d421SStefan Hajnoczi 995d79df2a2SPaolo Bonzini if (aio_context != data->aio_context) { 996dec7d421SStefan Hajnoczi aio_context_release(aio_context); 997d79df2a2SPaolo Bonzini } 998dec7d421SStefan Hajnoczi 999dec7d421SStefan Hajnoczi aio_context_release(data->aio_context); 1000dec7d421SStefan Hajnoczi 1001dec7d421SStefan Hajnoczi g_free(data); 1002dec7d421SStefan Hajnoczi } 1003dec7d421SStefan Hajnoczi 1004dec7d421SStefan Hajnoczi void block_job_defer_to_main_loop(BlockJob *job, 1005dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopFn *fn, 1006dec7d421SStefan Hajnoczi void *opaque) 1007dec7d421SStefan Hajnoczi { 1008dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data)); 1009dec7d421SStefan Hajnoczi data->job = job; 1010b6d2e599SKevin Wolf data->aio_context = blk_get_aio_context(job->blk); 1011dec7d421SStefan Hajnoczi data->fn = fn; 1012dec7d421SStefan Hajnoczi data->opaque = opaque; 1013794f0141SFam Zheng job->deferred_to_main_loop = true; 1014dec7d421SStefan Hajnoczi 1015fffb6e12SPaolo Bonzini aio_bh_schedule_oneshot(qemu_get_aio_context(), 1016fffb6e12SPaolo Bonzini block_job_defer_to_main_loop_bh, data); 1017dec7d421SStefan Hajnoczi } 1018