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" 282f0c9fe6SPaolo Bonzini #include "trace.h" 29737e150eSPaolo Bonzini #include "block/block.h" 30*c87621eaSJohn Snow #include "block/blockjob_int.h" 31737e150eSPaolo Bonzini #include "block/block_int.h" 32373340b2SMax Reitz #include "sysemu/block-backend.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 418254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job); 428254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg); 438254b6d9SJohn Snow 44c55a832fSFam Zheng /* Transactional group of block jobs */ 45c55a832fSFam Zheng struct BlockJobTxn { 46c55a832fSFam Zheng 47c55a832fSFam Zheng /* Is this txn being cancelled? */ 48c55a832fSFam Zheng bool aborting; 49c55a832fSFam Zheng 50c55a832fSFam Zheng /* List of jobs */ 51c55a832fSFam Zheng QLIST_HEAD(, BlockJob) jobs; 52c55a832fSFam Zheng 53c55a832fSFam Zheng /* Reference count */ 54c55a832fSFam Zheng int refcnt; 55c55a832fSFam Zheng }; 56c55a832fSFam Zheng 57a7112795SAlberto Garcia static QLIST_HEAD(, BlockJob) block_jobs = QLIST_HEAD_INITIALIZER(block_jobs); 58a7112795SAlberto Garcia 59a7112795SAlberto Garcia BlockJob *block_job_next(BlockJob *job) 60a7112795SAlberto Garcia { 61a7112795SAlberto Garcia if (!job) { 62a7112795SAlberto Garcia return QLIST_FIRST(&block_jobs); 63a7112795SAlberto Garcia } 64a7112795SAlberto Garcia return QLIST_NEXT(job, job_list); 65a7112795SAlberto Garcia } 66a7112795SAlberto Garcia 67ffb1f10cSAlberto Garcia BlockJob *block_job_get(const char *id) 68ffb1f10cSAlberto Garcia { 69ffb1f10cSAlberto Garcia BlockJob *job; 70ffb1f10cSAlberto Garcia 71ffb1f10cSAlberto Garcia QLIST_FOREACH(job, &block_jobs, job_list) { 72559b935fSJohn Snow if (job->id && !strcmp(id, job->id)) { 73ffb1f10cSAlberto Garcia return job; 74ffb1f10cSAlberto Garcia } 75ffb1f10cSAlberto Garcia } 76ffb1f10cSAlberto Garcia 77ffb1f10cSAlberto Garcia return NULL; 78ffb1f10cSAlberto Garcia } 79ffb1f10cSAlberto Garcia 80463e0be1SStefan Hajnoczi static void block_job_attached_aio_context(AioContext *new_context, 81463e0be1SStefan Hajnoczi void *opaque) 82463e0be1SStefan Hajnoczi { 83463e0be1SStefan Hajnoczi BlockJob *job = opaque; 84463e0be1SStefan Hajnoczi 85463e0be1SStefan Hajnoczi if (job->driver->attached_aio_context) { 86463e0be1SStefan Hajnoczi job->driver->attached_aio_context(job, new_context); 87463e0be1SStefan Hajnoczi } 88463e0be1SStefan Hajnoczi 89463e0be1SStefan Hajnoczi block_job_resume(job); 90463e0be1SStefan Hajnoczi } 91463e0be1SStefan Hajnoczi 92bae8196dSPaolo Bonzini static void block_job_drain(BlockJob *job) 93bae8196dSPaolo Bonzini { 94bae8196dSPaolo Bonzini /* If job is !job->busy this kicks it into the next pause point. */ 95bae8196dSPaolo Bonzini block_job_enter(job); 96bae8196dSPaolo Bonzini 97bae8196dSPaolo Bonzini blk_drain(job->blk); 98bae8196dSPaolo Bonzini if (job->driver->drain) { 99bae8196dSPaolo Bonzini job->driver->drain(job); 100bae8196dSPaolo Bonzini } 101bae8196dSPaolo Bonzini } 102bae8196dSPaolo Bonzini 103463e0be1SStefan Hajnoczi static void block_job_detach_aio_context(void *opaque) 104463e0be1SStefan Hajnoczi { 105463e0be1SStefan Hajnoczi BlockJob *job = opaque; 106463e0be1SStefan Hajnoczi 107463e0be1SStefan Hajnoczi /* In case the job terminates during aio_poll()... */ 108463e0be1SStefan Hajnoczi block_job_ref(job); 109463e0be1SStefan Hajnoczi 110463e0be1SStefan Hajnoczi block_job_pause(job); 111463e0be1SStefan Hajnoczi 112463e0be1SStefan Hajnoczi while (!job->paused && !job->completed) { 113bae8196dSPaolo Bonzini block_job_drain(job); 114463e0be1SStefan Hajnoczi } 115463e0be1SStefan Hajnoczi 116463e0be1SStefan Hajnoczi block_job_unref(job); 117463e0be1SStefan Hajnoczi } 118463e0be1SStefan Hajnoczi 11923d402d4SAlberto Garcia void block_job_add_bdrv(BlockJob *job, BlockDriverState *bs) 12023d402d4SAlberto Garcia { 12123d402d4SAlberto Garcia job->nodes = g_slist_prepend(job->nodes, bs); 12223d402d4SAlberto Garcia bdrv_ref(bs); 12323d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 12423d402d4SAlberto Garcia } 12523d402d4SAlberto Garcia 1267f0317cfSAlberto Garcia void *block_job_create(const char *job_id, const BlockJobDriver *driver, 127f81e0b45SJohn Snow BlockDriverState *bs, int64_t speed, int flags, 1287f0317cfSAlberto Garcia BlockCompletionFunc *cb, void *opaque, Error **errp) 1292f0c9fe6SPaolo Bonzini { 130b6d2e599SKevin Wolf BlockBackend *blk; 1312f0c9fe6SPaolo Bonzini BlockJob *job; 1322f0c9fe6SPaolo Bonzini 133628ff683SFam Zheng if (bs->job) { 134c6bd8c70SMarkus Armbruster error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); 1352f0c9fe6SPaolo Bonzini return NULL; 1362f0c9fe6SPaolo Bonzini } 137b6d2e599SKevin Wolf 138f81e0b45SJohn Snow if (job_id == NULL && !(flags & BLOCK_JOB_INTERNAL)) { 1397f0317cfSAlberto Garcia job_id = bdrv_get_device_name(bs); 1401562047cSKevin Wolf if (!*job_id) { 1411562047cSKevin Wolf error_setg(errp, "An explicit job ID is required for this node"); 1421562047cSKevin Wolf return NULL; 1431562047cSKevin Wolf } 1447f0317cfSAlberto Garcia } 1457f0317cfSAlberto Garcia 146f81e0b45SJohn Snow if (job_id) { 147f81e0b45SJohn Snow if (flags & BLOCK_JOB_INTERNAL) { 148f81e0b45SJohn Snow error_setg(errp, "Cannot specify job ID for internal block job"); 149f81e0b45SJohn Snow return NULL; 150f81e0b45SJohn Snow } 151f81e0b45SJohn Snow 1527f0317cfSAlberto Garcia if (!id_wellformed(job_id)) { 1537f0317cfSAlberto Garcia error_setg(errp, "Invalid job ID '%s'", job_id); 1547f0317cfSAlberto Garcia return NULL; 1557f0317cfSAlberto Garcia } 1567f0317cfSAlberto Garcia 1577f0317cfSAlberto Garcia if (block_job_get(job_id)) { 1587f0317cfSAlberto Garcia error_setg(errp, "Job ID '%s' already in use", job_id); 1597f0317cfSAlberto Garcia return NULL; 1607f0317cfSAlberto Garcia } 161f81e0b45SJohn Snow } 1627f0317cfSAlberto Garcia 163b6d2e599SKevin Wolf blk = blk_new(); 164b6d2e599SKevin Wolf blk_insert_bs(blk, bs); 165b6d2e599SKevin Wolf 1663fc4b10aSFam Zheng job = g_malloc0(driver->instance_size); 1673718d8abSFam Zheng error_setg(&job->blocker, "block device is in use by block job: %s", 1683718d8abSFam Zheng BlockJobType_lookup[driver->job_type]); 16923d402d4SAlberto Garcia block_job_add_bdrv(job, bs); 170b112a65cSStefan Hajnoczi bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 1713718d8abSFam Zheng 1723fc4b10aSFam Zheng job->driver = driver; 1737f0317cfSAlberto Garcia job->id = g_strdup(job_id); 174b6d2e599SKevin Wolf job->blk = blk; 1752f0c9fe6SPaolo Bonzini job->cb = cb; 1762f0c9fe6SPaolo Bonzini job->opaque = opaque; 1772f0c9fe6SPaolo Bonzini job->busy = true; 17818930ba3SFam Zheng job->refcnt = 1; 1792f0c9fe6SPaolo Bonzini bs->job = job; 1802f0c9fe6SPaolo Bonzini 181a7112795SAlberto Garcia QLIST_INSERT_HEAD(&block_jobs, job, job_list); 182a7112795SAlberto Garcia 183463e0be1SStefan Hajnoczi blk_add_aio_context_notifier(blk, block_job_attached_aio_context, 184463e0be1SStefan Hajnoczi block_job_detach_aio_context, job); 185463e0be1SStefan Hajnoczi 1862f0c9fe6SPaolo Bonzini /* Only set speed when necessary to avoid NotSupported error */ 1872f0c9fe6SPaolo Bonzini if (speed != 0) { 1882f0c9fe6SPaolo Bonzini Error *local_err = NULL; 1892f0c9fe6SPaolo Bonzini 1902f0c9fe6SPaolo Bonzini block_job_set_speed(job, speed, &local_err); 19184d18f06SMarkus Armbruster if (local_err) { 19218930ba3SFam Zheng block_job_unref(job); 1932f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 1942f0c9fe6SPaolo Bonzini return NULL; 1952f0c9fe6SPaolo Bonzini } 1962f0c9fe6SPaolo Bonzini } 1972f0c9fe6SPaolo Bonzini return job; 1982f0c9fe6SPaolo Bonzini } 1992f0c9fe6SPaolo Bonzini 200559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 201559b935fSJohn Snow { 202559b935fSJohn Snow return (job->id == NULL); 203559b935fSJohn Snow } 204559b935fSJohn Snow 20518930ba3SFam Zheng void block_job_ref(BlockJob *job) 20697031164STing Wang { 20718930ba3SFam Zheng ++job->refcnt; 20818930ba3SFam Zheng } 20997031164STing Wang 21018930ba3SFam Zheng void block_job_unref(BlockJob *job) 21118930ba3SFam Zheng { 21218930ba3SFam Zheng if (--job->refcnt == 0) { 21323d402d4SAlberto Garcia GSList *l; 214b6d2e599SKevin Wolf BlockDriverState *bs = blk_bs(job->blk); 215b6d2e599SKevin Wolf bs->job = NULL; 21623d402d4SAlberto Garcia for (l = job->nodes; l; l = l->next) { 21723d402d4SAlberto Garcia bs = l->data; 218b6d2e599SKevin Wolf bdrv_op_unblock_all(bs, job->blocker); 21923d402d4SAlberto Garcia bdrv_unref(bs); 22023d402d4SAlberto Garcia } 22123d402d4SAlberto Garcia g_slist_free(job->nodes); 222463e0be1SStefan Hajnoczi blk_remove_aio_context_notifier(job->blk, 223463e0be1SStefan Hajnoczi block_job_attached_aio_context, 224463e0be1SStefan Hajnoczi block_job_detach_aio_context, job); 225b6d2e599SKevin Wolf blk_unref(job->blk); 22697031164STing Wang error_free(job->blocker); 2278ccb9569SKevin Wolf g_free(job->id); 228a7112795SAlberto Garcia QLIST_REMOVE(job, job_list); 22997031164STing Wang g_free(job); 23097031164STing Wang } 23118930ba3SFam Zheng } 23297031164STing Wang 233c55a832fSFam Zheng static void block_job_completed_single(BlockJob *job) 234c55a832fSFam Zheng { 235c55a832fSFam Zheng if (!job->ret) { 236c55a832fSFam Zheng if (job->driver->commit) { 237c55a832fSFam Zheng job->driver->commit(job); 238c55a832fSFam Zheng } 239c55a832fSFam Zheng } else { 240c55a832fSFam Zheng if (job->driver->abort) { 241c55a832fSFam Zheng job->driver->abort(job); 242c55a832fSFam Zheng } 243c55a832fSFam Zheng } 2448254b6d9SJohn Snow 2458254b6d9SJohn Snow if (job->cb) { 246c55a832fSFam Zheng job->cb(job->opaque, job->ret); 2478254b6d9SJohn Snow } 2488254b6d9SJohn Snow if (block_job_is_cancelled(job)) { 2498254b6d9SJohn Snow block_job_event_cancelled(job); 2508254b6d9SJohn Snow } else { 2518254b6d9SJohn Snow const char *msg = NULL; 2528254b6d9SJohn Snow if (job->ret < 0) { 2538254b6d9SJohn Snow msg = strerror(-job->ret); 2548254b6d9SJohn Snow } 2558254b6d9SJohn Snow block_job_event_completed(job, msg); 2568254b6d9SJohn Snow } 2578254b6d9SJohn Snow 258c55a832fSFam Zheng if (job->txn) { 259c55a832fSFam Zheng block_job_txn_unref(job->txn); 260c55a832fSFam Zheng } 261c55a832fSFam Zheng block_job_unref(job); 262c55a832fSFam Zheng } 263c55a832fSFam Zheng 264c55a832fSFam Zheng static void block_job_completed_txn_abort(BlockJob *job) 265c55a832fSFam Zheng { 266c55a832fSFam Zheng AioContext *ctx; 267c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 268c55a832fSFam Zheng BlockJob *other_job, *next; 269c55a832fSFam Zheng 270c55a832fSFam Zheng if (txn->aborting) { 271c55a832fSFam Zheng /* 272c55a832fSFam Zheng * We are cancelled by another job, which will handle everything. 273c55a832fSFam Zheng */ 274c55a832fSFam Zheng return; 275c55a832fSFam Zheng } 276c55a832fSFam Zheng txn->aborting = true; 277c55a832fSFam Zheng /* We are the first failed job. Cancel other jobs. */ 278c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 279b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 280c55a832fSFam Zheng aio_context_acquire(ctx); 281c55a832fSFam Zheng } 282c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 283c55a832fSFam Zheng if (other_job == job || other_job->completed) { 284c55a832fSFam Zheng /* Other jobs are "effectively" cancelled by us, set the status for 285c55a832fSFam Zheng * them; this job, however, may or may not be cancelled, depending 286c55a832fSFam Zheng * on the caller, so leave it. */ 287c55a832fSFam Zheng if (other_job != job) { 288c55a832fSFam Zheng other_job->cancelled = true; 289c55a832fSFam Zheng } 290c55a832fSFam Zheng continue; 291c55a832fSFam Zheng } 292c55a832fSFam Zheng block_job_cancel_sync(other_job); 293c55a832fSFam Zheng assert(other_job->completed); 294c55a832fSFam Zheng } 295c55a832fSFam Zheng QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { 296b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 297c55a832fSFam Zheng block_job_completed_single(other_job); 298c55a832fSFam Zheng aio_context_release(ctx); 299c55a832fSFam Zheng } 300c55a832fSFam Zheng } 301c55a832fSFam Zheng 302c55a832fSFam Zheng static void block_job_completed_txn_success(BlockJob *job) 303c55a832fSFam Zheng { 304c55a832fSFam Zheng AioContext *ctx; 305c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 306c55a832fSFam Zheng BlockJob *other_job, *next; 307c55a832fSFam Zheng /* 308c55a832fSFam Zheng * Successful completion, see if there are other running jobs in this 309c55a832fSFam Zheng * txn. 310c55a832fSFam Zheng */ 311c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 312c55a832fSFam Zheng if (!other_job->completed) { 313c55a832fSFam Zheng return; 314c55a832fSFam Zheng } 315c55a832fSFam Zheng } 316c55a832fSFam Zheng /* We are the last completed job, commit the transaction. */ 317c55a832fSFam Zheng QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { 318b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 319c55a832fSFam Zheng aio_context_acquire(ctx); 320c55a832fSFam Zheng assert(other_job->ret == 0); 321c55a832fSFam Zheng block_job_completed_single(other_job); 322c55a832fSFam Zheng aio_context_release(ctx); 323c55a832fSFam Zheng } 324c55a832fSFam Zheng } 325c55a832fSFam Zheng 32665f46322SPaolo Bonzini void block_job_completed(BlockJob *job, int ret) 3272f0c9fe6SPaolo Bonzini { 328b6d2e599SKevin Wolf assert(blk_bs(job->blk)->job == job); 329a689dbf2SFam Zheng assert(!job->completed); 330a689dbf2SFam Zheng job->completed = true; 331a689dbf2SFam Zheng job->ret = ret; 332c55a832fSFam Zheng if (!job->txn) { 333c55a832fSFam Zheng block_job_completed_single(job); 334c55a832fSFam Zheng } else if (ret < 0 || block_job_is_cancelled(job)) { 335c55a832fSFam Zheng block_job_completed_txn_abort(job); 336c55a832fSFam Zheng } else { 337c55a832fSFam Zheng block_job_completed_txn_success(job); 338c55a832fSFam Zheng } 3392f0c9fe6SPaolo Bonzini } 3402f0c9fe6SPaolo Bonzini 3412f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 3422f0c9fe6SPaolo Bonzini { 3432f0c9fe6SPaolo Bonzini Error *local_err = NULL; 3442f0c9fe6SPaolo Bonzini 3453fc4b10aSFam Zheng if (!job->driver->set_speed) { 346c6bd8c70SMarkus Armbruster error_setg(errp, QERR_UNSUPPORTED); 3472f0c9fe6SPaolo Bonzini return; 3482f0c9fe6SPaolo Bonzini } 3493fc4b10aSFam Zheng job->driver->set_speed(job, speed, &local_err); 35084d18f06SMarkus Armbruster if (local_err) { 3512f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 3522f0c9fe6SPaolo Bonzini return; 3532f0c9fe6SPaolo Bonzini } 3542f0c9fe6SPaolo Bonzini 3552f0c9fe6SPaolo Bonzini job->speed = speed; 3562f0c9fe6SPaolo Bonzini } 3572f0c9fe6SPaolo Bonzini 358aeae883bSPaolo Bonzini void block_job_complete(BlockJob *job, Error **errp) 359aeae883bSPaolo Bonzini { 360559b935fSJohn Snow /* Should not be reachable via external interface for internal jobs */ 361559b935fSJohn Snow assert(job->id); 362751ebd76SFam Zheng if (job->pause_count || job->cancelled || !job->driver->complete) { 3639df229c3SAlberto Garcia error_setg(errp, "The active block job '%s' cannot be completed", 3649df229c3SAlberto Garcia job->id); 365aeae883bSPaolo Bonzini return; 366aeae883bSPaolo Bonzini } 367aeae883bSPaolo Bonzini 3683fc4b10aSFam Zheng job->driver->complete(job, errp); 369aeae883bSPaolo Bonzini } 370aeae883bSPaolo Bonzini 3718acc72a4SPaolo Bonzini void block_job_pause(BlockJob *job) 3722f0c9fe6SPaolo Bonzini { 373751ebd76SFam Zheng job->pause_count++; 3748acc72a4SPaolo Bonzini } 3758acc72a4SPaolo Bonzini 3760df4ba58SJohn Snow void block_job_user_pause(BlockJob *job) 3770df4ba58SJohn Snow { 3780df4ba58SJohn Snow job->user_paused = true; 3790df4ba58SJohn Snow block_job_pause(job); 3800df4ba58SJohn Snow } 3810df4ba58SJohn Snow 382a7f3b7ffSStefan Hajnoczi static bool block_job_should_pause(BlockJob *job) 3838acc72a4SPaolo Bonzini { 384751ebd76SFam Zheng return job->pause_count > 0; 3858acc72a4SPaolo Bonzini } 3868acc72a4SPaolo Bonzini 3870df4ba58SJohn Snow bool block_job_user_paused(BlockJob *job) 3880df4ba58SJohn Snow { 3890df4ba58SJohn Snow return job ? job->user_paused : 0; 3900df4ba58SJohn Snow } 3910df4ba58SJohn Snow 392fc9c0a9cSStefan Hajnoczi void coroutine_fn block_job_pause_point(BlockJob *job) 393fc9c0a9cSStefan Hajnoczi { 394fc9c0a9cSStefan Hajnoczi if (!block_job_should_pause(job)) { 395fc9c0a9cSStefan Hajnoczi return; 396fc9c0a9cSStefan Hajnoczi } 397fc9c0a9cSStefan Hajnoczi if (block_job_is_cancelled(job)) { 398fc9c0a9cSStefan Hajnoczi return; 399fc9c0a9cSStefan Hajnoczi } 400fc9c0a9cSStefan Hajnoczi 401fc9c0a9cSStefan Hajnoczi if (job->driver->pause) { 402fc9c0a9cSStefan Hajnoczi job->driver->pause(job); 403fc9c0a9cSStefan Hajnoczi } 404fc9c0a9cSStefan Hajnoczi 405fc9c0a9cSStefan Hajnoczi if (block_job_should_pause(job) && !block_job_is_cancelled(job)) { 406fc9c0a9cSStefan Hajnoczi job->paused = true; 407fc9c0a9cSStefan Hajnoczi job->busy = false; 408fc9c0a9cSStefan Hajnoczi qemu_coroutine_yield(); /* wait for block_job_resume() */ 409fc9c0a9cSStefan Hajnoczi job->busy = true; 410fc9c0a9cSStefan Hajnoczi job->paused = false; 411fc9c0a9cSStefan Hajnoczi } 412fc9c0a9cSStefan Hajnoczi 413fc9c0a9cSStefan Hajnoczi if (job->driver->resume) { 414fc9c0a9cSStefan Hajnoczi job->driver->resume(job); 415fc9c0a9cSStefan Hajnoczi } 416fc9c0a9cSStefan Hajnoczi } 417fc9c0a9cSStefan Hajnoczi 4188acc72a4SPaolo Bonzini void block_job_resume(BlockJob *job) 4198acc72a4SPaolo Bonzini { 420751ebd76SFam Zheng assert(job->pause_count > 0); 421751ebd76SFam Zheng job->pause_count--; 422751ebd76SFam Zheng if (job->pause_count) { 423751ebd76SFam Zheng return; 424751ebd76SFam Zheng } 425751ebd76SFam Zheng block_job_enter(job); 426751ebd76SFam Zheng } 427751ebd76SFam Zheng 4280df4ba58SJohn Snow void block_job_user_resume(BlockJob *job) 4290df4ba58SJohn Snow { 4300df4ba58SJohn Snow if (job && job->user_paused && job->pause_count > 0) { 4310df4ba58SJohn Snow job->user_paused = false; 4320df4ba58SJohn Snow block_job_resume(job); 4330df4ba58SJohn Snow } 4340df4ba58SJohn Snow } 4350df4ba58SJohn Snow 436751ebd76SFam Zheng void block_job_enter(BlockJob *job) 437751ebd76SFam Zheng { 4382f0c9fe6SPaolo Bonzini if (job->co && !job->busy) { 4390b8b8753SPaolo Bonzini qemu_coroutine_enter(job->co); 4402f0c9fe6SPaolo Bonzini } 4412f0c9fe6SPaolo Bonzini } 4422f0c9fe6SPaolo Bonzini 4438acc72a4SPaolo Bonzini void block_job_cancel(BlockJob *job) 4448acc72a4SPaolo Bonzini { 4458acc72a4SPaolo Bonzini job->cancelled = true; 44617bd51f9SStefan Hajnoczi block_job_iostatus_reset(job); 447751ebd76SFam Zheng block_job_enter(job); 4488acc72a4SPaolo Bonzini } 4498acc72a4SPaolo Bonzini 4502f0c9fe6SPaolo Bonzini bool block_job_is_cancelled(BlockJob *job) 4512f0c9fe6SPaolo Bonzini { 4522f0c9fe6SPaolo Bonzini return job->cancelled; 4532f0c9fe6SPaolo Bonzini } 4542f0c9fe6SPaolo Bonzini 45532c81a4aSPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 45632c81a4aSPaolo Bonzini { 45732c81a4aSPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 4583fc4b10aSFam Zheng if (job->driver->iostatus_reset) { 4593fc4b10aSFam Zheng job->driver->iostatus_reset(job); 4603bd293c3SPaolo Bonzini } 46132c81a4aSPaolo Bonzini } 46232c81a4aSPaolo Bonzini 463345f9e1bSMax Reitz static int block_job_finish_sync(BlockJob *job, 464345f9e1bSMax Reitz void (*finish)(BlockJob *, Error **errp), 465345f9e1bSMax Reitz Error **errp) 4662f0c9fe6SPaolo Bonzini { 467345f9e1bSMax Reitz Error *local_err = NULL; 46894db6d2dSFam Zheng int ret; 4692f0c9fe6SPaolo Bonzini 470b6d2e599SKevin Wolf assert(blk_bs(job->blk)->job == job); 4712f0c9fe6SPaolo Bonzini 47294db6d2dSFam Zheng block_job_ref(job); 473bae8196dSPaolo Bonzini 474345f9e1bSMax Reitz finish(job, &local_err); 475345f9e1bSMax Reitz if (local_err) { 476345f9e1bSMax Reitz error_propagate(errp, local_err); 47794db6d2dSFam Zheng block_job_unref(job); 478345f9e1bSMax Reitz return -EBUSY; 479345f9e1bSMax Reitz } 480bae8196dSPaolo Bonzini /* block_job_drain calls block_job_enter, and it should be enough to 481bae8196dSPaolo Bonzini * induce progress until the job completes or moves to the main thread. 482bae8196dSPaolo Bonzini */ 483bae8196dSPaolo Bonzini while (!job->deferred_to_main_loop && !job->completed) { 484bae8196dSPaolo Bonzini block_job_drain(job); 485bae8196dSPaolo Bonzini } 48694db6d2dSFam Zheng while (!job->completed) { 487bae8196dSPaolo Bonzini aio_poll(qemu_get_aio_context(), true); 4882f0c9fe6SPaolo Bonzini } 48994db6d2dSFam Zheng ret = (job->cancelled && job->ret == 0) ? -ECANCELED : job->ret; 49094db6d2dSFam Zheng block_job_unref(job); 49194db6d2dSFam Zheng return ret; 4922f0c9fe6SPaolo Bonzini } 4932f0c9fe6SPaolo Bonzini 494345f9e1bSMax Reitz /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be 495345f9e1bSMax Reitz * used with block_job_finish_sync() without the need for (rather nasty) 496345f9e1bSMax Reitz * function pointer casts there. */ 497345f9e1bSMax Reitz static void block_job_cancel_err(BlockJob *job, Error **errp) 498345f9e1bSMax Reitz { 499345f9e1bSMax Reitz block_job_cancel(job); 500345f9e1bSMax Reitz } 501345f9e1bSMax Reitz 502345f9e1bSMax Reitz int block_job_cancel_sync(BlockJob *job) 503345f9e1bSMax Reitz { 504345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_cancel_err, NULL); 505345f9e1bSMax Reitz } 506345f9e1bSMax Reitz 507a1a2af07SKevin Wolf void block_job_cancel_sync_all(void) 508a1a2af07SKevin Wolf { 509a1a2af07SKevin Wolf BlockJob *job; 510a1a2af07SKevin Wolf AioContext *aio_context; 511a1a2af07SKevin Wolf 512a1a2af07SKevin Wolf while ((job = QLIST_FIRST(&block_jobs))) { 513b6d2e599SKevin Wolf aio_context = blk_get_aio_context(job->blk); 514a1a2af07SKevin Wolf aio_context_acquire(aio_context); 515a1a2af07SKevin Wolf block_job_cancel_sync(job); 516a1a2af07SKevin Wolf aio_context_release(aio_context); 517a1a2af07SKevin Wolf } 518a1a2af07SKevin Wolf } 519a1a2af07SKevin Wolf 520345f9e1bSMax Reitz int block_job_complete_sync(BlockJob *job, Error **errp) 521345f9e1bSMax Reitz { 522345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_complete, errp); 523345f9e1bSMax Reitz } 524345f9e1bSMax Reitz 5257483d1e5SAlex Bligh void block_job_sleep_ns(BlockJob *job, QEMUClockType type, int64_t ns) 5262f0c9fe6SPaolo Bonzini { 5278acc72a4SPaolo Bonzini assert(job->busy); 5288acc72a4SPaolo Bonzini 5292f0c9fe6SPaolo Bonzini /* Check cancellation *before* setting busy = false, too! */ 5308acc72a4SPaolo Bonzini if (block_job_is_cancelled(job)) { 5318acc72a4SPaolo Bonzini return; 5322f0c9fe6SPaolo Bonzini } 5338acc72a4SPaolo Bonzini 5348acc72a4SPaolo Bonzini job->busy = false; 535a7f3b7ffSStefan Hajnoczi if (!block_job_should_pause(job)) { 5360824afdaSAlberto Garcia co_aio_sleep_ns(blk_get_aio_context(job->blk), type, ns); 5370824afdaSAlberto Garcia } 5388acc72a4SPaolo Bonzini job->busy = true; 539fc9c0a9cSStefan Hajnoczi 540fc9c0a9cSStefan Hajnoczi block_job_pause_point(job); 5412f0c9fe6SPaolo Bonzini } 54230e628b7SPaolo Bonzini 543dc71ce45SFam Zheng void block_job_yield(BlockJob *job) 544dc71ce45SFam Zheng { 545dc71ce45SFam Zheng assert(job->busy); 546dc71ce45SFam Zheng 547dc71ce45SFam Zheng /* Check cancellation *before* setting busy = false, too! */ 548dc71ce45SFam Zheng if (block_job_is_cancelled(job)) { 549dc71ce45SFam Zheng return; 550dc71ce45SFam Zheng } 551dc71ce45SFam Zheng 552dc71ce45SFam Zheng job->busy = false; 553fc9c0a9cSStefan Hajnoczi if (!block_job_should_pause(job)) { 554dc71ce45SFam Zheng qemu_coroutine_yield(); 555fc9c0a9cSStefan Hajnoczi } 556dc71ce45SFam Zheng job->busy = true; 557fc9c0a9cSStefan Hajnoczi 558fc9c0a9cSStefan Hajnoczi block_job_pause_point(job); 559dc71ce45SFam Zheng } 560dc71ce45SFam Zheng 561559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp) 56230e628b7SPaolo Bonzini { 563559b935fSJohn Snow BlockJobInfo *info; 564559b935fSJohn Snow 565559b935fSJohn Snow if (block_job_is_internal(job)) { 566559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 567559b935fSJohn Snow return NULL; 568559b935fSJohn Snow } 569559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 57079e14bf7SFam Zheng info->type = g_strdup(BlockJobType_lookup[job->driver->job_type]); 5718ccb9569SKevin Wolf info->device = g_strdup(job->id); 57230e628b7SPaolo Bonzini info->len = job->len; 5738d65883fSPaolo Bonzini info->busy = job->busy; 574751ebd76SFam Zheng info->paused = job->pause_count > 0; 57530e628b7SPaolo Bonzini info->offset = job->offset; 57630e628b7SPaolo Bonzini info->speed = job->speed; 57732c81a4aSPaolo Bonzini info->io_status = job->iostatus; 578ef6dbf1eSMax Reitz info->ready = job->ready; 57930e628b7SPaolo Bonzini return info; 58030e628b7SPaolo Bonzini } 58132c81a4aSPaolo Bonzini 58232c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 58332c81a4aSPaolo Bonzini { 58432c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 58532c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 58632c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 58732c81a4aSPaolo Bonzini } 58832c81a4aSPaolo Bonzini } 58932c81a4aSPaolo Bonzini 5908254b6d9SJohn Snow static void block_job_event_cancelled(BlockJob *job) 591a66a2a36SPaolo Bonzini { 592559b935fSJohn Snow if (block_job_is_internal(job)) { 593559b935fSJohn Snow return; 594559b935fSJohn Snow } 595559b935fSJohn Snow 596bcada37bSWenchao Xia qapi_event_send_block_job_cancelled(job->driver->job_type, 5978ccb9569SKevin Wolf job->id, 598a66a2a36SPaolo Bonzini job->len, 599a66a2a36SPaolo Bonzini job->offset, 600bcada37bSWenchao Xia job->speed, 601bcada37bSWenchao Xia &error_abort); 602a66a2a36SPaolo Bonzini } 603a66a2a36SPaolo Bonzini 6048254b6d9SJohn Snow static void block_job_event_completed(BlockJob *job, const char *msg) 605a66a2a36SPaolo Bonzini { 606559b935fSJohn Snow if (block_job_is_internal(job)) { 607559b935fSJohn Snow return; 608559b935fSJohn Snow } 609559b935fSJohn Snow 610bcada37bSWenchao Xia qapi_event_send_block_job_completed(job->driver->job_type, 6118ccb9569SKevin Wolf job->id, 612bcada37bSWenchao Xia job->len, 613bcada37bSWenchao Xia job->offset, 614bcada37bSWenchao Xia job->speed, 615bcada37bSWenchao Xia !!msg, 616bcada37bSWenchao Xia msg, 617bcada37bSWenchao Xia &error_abort); 618bcada37bSWenchao Xia } 619bcada37bSWenchao Xia 620bcada37bSWenchao Xia void block_job_event_ready(BlockJob *job) 621bcada37bSWenchao Xia { 622ef6dbf1eSMax Reitz job->ready = true; 623ef6dbf1eSMax Reitz 624559b935fSJohn Snow if (block_job_is_internal(job)) { 625559b935fSJohn Snow return; 626559b935fSJohn Snow } 627559b935fSJohn Snow 628518848a2SMarkus Armbruster qapi_event_send_block_job_ready(job->driver->job_type, 6298ccb9569SKevin Wolf job->id, 630518848a2SMarkus Armbruster job->len, 631518848a2SMarkus Armbruster job->offset, 632518848a2SMarkus Armbruster job->speed, &error_abort); 633a66a2a36SPaolo Bonzini } 634a66a2a36SPaolo Bonzini 63581e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 63632c81a4aSPaolo Bonzini int is_read, int error) 63732c81a4aSPaolo Bonzini { 63832c81a4aSPaolo Bonzini BlockErrorAction action; 63932c81a4aSPaolo Bonzini 64032c81a4aSPaolo Bonzini switch (on_err) { 64132c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 6428c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 643a589569fSWenchao Xia action = (error == ENOSPC) ? 644a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 64532c81a4aSPaolo Bonzini break; 64632c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 647a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 64832c81a4aSPaolo Bonzini break; 64932c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 650a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 65132c81a4aSPaolo Bonzini break; 65232c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 653a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 65432c81a4aSPaolo Bonzini break; 65532c81a4aSPaolo Bonzini default: 65632c81a4aSPaolo Bonzini abort(); 65732c81a4aSPaolo Bonzini } 658559b935fSJohn Snow if (!block_job_is_internal(job)) { 6598ccb9569SKevin Wolf qapi_event_send_block_job_error(job->id, 6605a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 6615a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 6625a2d2cbdSWenchao Xia action, &error_abort); 663559b935fSJohn Snow } 664a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 665751ebd76SFam Zheng /* make the pause user visible, which will be resumed from QMP. */ 6660df4ba58SJohn Snow block_job_user_pause(job); 66732c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 66832c81a4aSPaolo Bonzini } 66932c81a4aSPaolo Bonzini return action; 67032c81a4aSPaolo Bonzini } 671dec7d421SStefan Hajnoczi 672dec7d421SStefan Hajnoczi typedef struct { 673dec7d421SStefan Hajnoczi BlockJob *job; 674dec7d421SStefan Hajnoczi AioContext *aio_context; 675dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopFn *fn; 676dec7d421SStefan Hajnoczi void *opaque; 677dec7d421SStefan Hajnoczi } BlockJobDeferToMainLoopData; 678dec7d421SStefan Hajnoczi 679dec7d421SStefan Hajnoczi static void block_job_defer_to_main_loop_bh(void *opaque) 680dec7d421SStefan Hajnoczi { 681dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopData *data = opaque; 682dec7d421SStefan Hajnoczi AioContext *aio_context; 683dec7d421SStefan Hajnoczi 684dec7d421SStefan Hajnoczi /* Prevent race with block_job_defer_to_main_loop() */ 685dec7d421SStefan Hajnoczi aio_context_acquire(data->aio_context); 686dec7d421SStefan Hajnoczi 687dec7d421SStefan Hajnoczi /* Fetch BDS AioContext again, in case it has changed */ 688b6d2e599SKevin Wolf aio_context = blk_get_aio_context(data->job->blk); 689dec7d421SStefan Hajnoczi aio_context_acquire(aio_context); 690dec7d421SStefan Hajnoczi 691794f0141SFam Zheng data->job->deferred_to_main_loop = false; 692dec7d421SStefan Hajnoczi data->fn(data->job, data->opaque); 693dec7d421SStefan Hajnoczi 694dec7d421SStefan Hajnoczi aio_context_release(aio_context); 695dec7d421SStefan Hajnoczi 696dec7d421SStefan Hajnoczi aio_context_release(data->aio_context); 697dec7d421SStefan Hajnoczi 698dec7d421SStefan Hajnoczi g_free(data); 699dec7d421SStefan Hajnoczi } 700dec7d421SStefan Hajnoczi 701dec7d421SStefan Hajnoczi void block_job_defer_to_main_loop(BlockJob *job, 702dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopFn *fn, 703dec7d421SStefan Hajnoczi void *opaque) 704dec7d421SStefan Hajnoczi { 705dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data)); 706dec7d421SStefan Hajnoczi data->job = job; 707b6d2e599SKevin Wolf data->aio_context = blk_get_aio_context(job->blk); 708dec7d421SStefan Hajnoczi data->fn = fn; 709dec7d421SStefan Hajnoczi data->opaque = opaque; 710794f0141SFam Zheng job->deferred_to_main_loop = true; 711dec7d421SStefan Hajnoczi 712fffb6e12SPaolo Bonzini aio_bh_schedule_oneshot(qemu_get_aio_context(), 713fffb6e12SPaolo Bonzini block_job_defer_to_main_loop_bh, data); 714dec7d421SStefan Hajnoczi } 715c55a832fSFam Zheng 716c55a832fSFam Zheng BlockJobTxn *block_job_txn_new(void) 717c55a832fSFam Zheng { 718c55a832fSFam Zheng BlockJobTxn *txn = g_new0(BlockJobTxn, 1); 719c55a832fSFam Zheng QLIST_INIT(&txn->jobs); 720c55a832fSFam Zheng txn->refcnt = 1; 721c55a832fSFam Zheng return txn; 722c55a832fSFam Zheng } 723c55a832fSFam Zheng 724c55a832fSFam Zheng static void block_job_txn_ref(BlockJobTxn *txn) 725c55a832fSFam Zheng { 726c55a832fSFam Zheng txn->refcnt++; 727c55a832fSFam Zheng } 728c55a832fSFam Zheng 729c55a832fSFam Zheng void block_job_txn_unref(BlockJobTxn *txn) 730c55a832fSFam Zheng { 731c55a832fSFam Zheng if (txn && --txn->refcnt == 0) { 732c55a832fSFam Zheng g_free(txn); 733c55a832fSFam Zheng } 734c55a832fSFam Zheng } 735c55a832fSFam Zheng 736c55a832fSFam Zheng void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job) 737c55a832fSFam Zheng { 738c55a832fSFam Zheng if (!txn) { 739c55a832fSFam Zheng return; 740c55a832fSFam Zheng } 741c55a832fSFam Zheng 742c55a832fSFam Zheng assert(!job->txn); 743c55a832fSFam Zheng job->txn = txn; 744c55a832fSFam Zheng 745c55a832fSFam Zheng QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 746c55a832fSFam Zheng block_job_txn_ref(txn); 747c55a832fSFam Zheng } 748