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" 30737e150eSPaolo Bonzini #include "block/blockjob.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 41c55a832fSFam Zheng /* Transactional group of block jobs */ 42c55a832fSFam Zheng struct BlockJobTxn { 43c55a832fSFam Zheng 44c55a832fSFam Zheng /* Is this txn being cancelled? */ 45c55a832fSFam Zheng bool aborting; 46c55a832fSFam Zheng 47c55a832fSFam Zheng /* List of jobs */ 48c55a832fSFam Zheng QLIST_HEAD(, BlockJob) jobs; 49c55a832fSFam Zheng 50c55a832fSFam Zheng /* Reference count */ 51c55a832fSFam Zheng int refcnt; 52c55a832fSFam Zheng }; 53c55a832fSFam Zheng 54a7112795SAlberto Garcia static QLIST_HEAD(, BlockJob) block_jobs = QLIST_HEAD_INITIALIZER(block_jobs); 55a7112795SAlberto Garcia 56a7112795SAlberto Garcia BlockJob *block_job_next(BlockJob *job) 57a7112795SAlberto Garcia { 58a7112795SAlberto Garcia if (!job) { 59a7112795SAlberto Garcia return QLIST_FIRST(&block_jobs); 60a7112795SAlberto Garcia } 61a7112795SAlberto Garcia return QLIST_NEXT(job, job_list); 62a7112795SAlberto Garcia } 63a7112795SAlberto Garcia 64ffb1f10cSAlberto Garcia BlockJob *block_job_get(const char *id) 65ffb1f10cSAlberto Garcia { 66ffb1f10cSAlberto Garcia BlockJob *job; 67ffb1f10cSAlberto Garcia 68ffb1f10cSAlberto Garcia QLIST_FOREACH(job, &block_jobs, job_list) { 69*559b935fSJohn Snow if (job->id && !strcmp(id, job->id)) { 70ffb1f10cSAlberto Garcia return job; 71ffb1f10cSAlberto Garcia } 72ffb1f10cSAlberto Garcia } 73ffb1f10cSAlberto Garcia 74ffb1f10cSAlberto Garcia return NULL; 75ffb1f10cSAlberto Garcia } 76ffb1f10cSAlberto Garcia 77463e0be1SStefan Hajnoczi static void block_job_attached_aio_context(AioContext *new_context, 78463e0be1SStefan Hajnoczi void *opaque) 79463e0be1SStefan Hajnoczi { 80463e0be1SStefan Hajnoczi BlockJob *job = opaque; 81463e0be1SStefan Hajnoczi 82463e0be1SStefan Hajnoczi if (job->driver->attached_aio_context) { 83463e0be1SStefan Hajnoczi job->driver->attached_aio_context(job, new_context); 84463e0be1SStefan Hajnoczi } 85463e0be1SStefan Hajnoczi 86463e0be1SStefan Hajnoczi block_job_resume(job); 87463e0be1SStefan Hajnoczi } 88463e0be1SStefan Hajnoczi 89bae8196dSPaolo Bonzini static void block_job_drain(BlockJob *job) 90bae8196dSPaolo Bonzini { 91bae8196dSPaolo Bonzini /* If job is !job->busy this kicks it into the next pause point. */ 92bae8196dSPaolo Bonzini block_job_enter(job); 93bae8196dSPaolo Bonzini 94bae8196dSPaolo Bonzini blk_drain(job->blk); 95bae8196dSPaolo Bonzini if (job->driver->drain) { 96bae8196dSPaolo Bonzini job->driver->drain(job); 97bae8196dSPaolo Bonzini } 98bae8196dSPaolo Bonzini } 99bae8196dSPaolo Bonzini 100463e0be1SStefan Hajnoczi static void block_job_detach_aio_context(void *opaque) 101463e0be1SStefan Hajnoczi { 102463e0be1SStefan Hajnoczi BlockJob *job = opaque; 103463e0be1SStefan Hajnoczi 104463e0be1SStefan Hajnoczi /* In case the job terminates during aio_poll()... */ 105463e0be1SStefan Hajnoczi block_job_ref(job); 106463e0be1SStefan Hajnoczi 107463e0be1SStefan Hajnoczi block_job_pause(job); 108463e0be1SStefan Hajnoczi 109463e0be1SStefan Hajnoczi while (!job->paused && !job->completed) { 110bae8196dSPaolo Bonzini block_job_drain(job); 111463e0be1SStefan Hajnoczi } 112463e0be1SStefan Hajnoczi 113463e0be1SStefan Hajnoczi block_job_unref(job); 114463e0be1SStefan Hajnoczi } 115463e0be1SStefan Hajnoczi 11623d402d4SAlberto Garcia void block_job_add_bdrv(BlockJob *job, BlockDriverState *bs) 11723d402d4SAlberto Garcia { 11823d402d4SAlberto Garcia job->nodes = g_slist_prepend(job->nodes, bs); 11923d402d4SAlberto Garcia bdrv_ref(bs); 12023d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 12123d402d4SAlberto Garcia } 12223d402d4SAlberto Garcia 1237f0317cfSAlberto Garcia void *block_job_create(const char *job_id, const BlockJobDriver *driver, 1247f0317cfSAlberto Garcia BlockDriverState *bs, int64_t speed, 1257f0317cfSAlberto Garcia BlockCompletionFunc *cb, void *opaque, Error **errp) 1262f0c9fe6SPaolo Bonzini { 127b6d2e599SKevin Wolf BlockBackend *blk; 1282f0c9fe6SPaolo Bonzini BlockJob *job; 1292f0c9fe6SPaolo Bonzini 130b48100cfSChanglong Xie assert(cb); 131628ff683SFam Zheng if (bs->job) { 132c6bd8c70SMarkus Armbruster error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); 1332f0c9fe6SPaolo Bonzini return NULL; 1342f0c9fe6SPaolo Bonzini } 135b6d2e599SKevin Wolf 1367f0317cfSAlberto Garcia if (job_id == NULL) { 1377f0317cfSAlberto Garcia job_id = bdrv_get_device_name(bs); 1381562047cSKevin Wolf if (!*job_id) { 1391562047cSKevin Wolf error_setg(errp, "An explicit job ID is required for this node"); 1401562047cSKevin Wolf return NULL; 1411562047cSKevin Wolf } 1427f0317cfSAlberto Garcia } 1437f0317cfSAlberto Garcia 1447f0317cfSAlberto Garcia if (!id_wellformed(job_id)) { 1457f0317cfSAlberto Garcia error_setg(errp, "Invalid job ID '%s'", job_id); 1467f0317cfSAlberto Garcia return NULL; 1477f0317cfSAlberto Garcia } 1487f0317cfSAlberto Garcia 1497f0317cfSAlberto Garcia if (block_job_get(job_id)) { 1507f0317cfSAlberto Garcia error_setg(errp, "Job ID '%s' already in use", job_id); 1517f0317cfSAlberto Garcia return NULL; 1527f0317cfSAlberto Garcia } 1537f0317cfSAlberto Garcia 154b6d2e599SKevin Wolf blk = blk_new(); 155b6d2e599SKevin Wolf blk_insert_bs(blk, bs); 156b6d2e599SKevin Wolf 1573fc4b10aSFam Zheng job = g_malloc0(driver->instance_size); 1583718d8abSFam Zheng error_setg(&job->blocker, "block device is in use by block job: %s", 1593718d8abSFam Zheng BlockJobType_lookup[driver->job_type]); 16023d402d4SAlberto Garcia block_job_add_bdrv(job, bs); 161b112a65cSStefan Hajnoczi bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 1623718d8abSFam Zheng 1633fc4b10aSFam Zheng job->driver = driver; 1647f0317cfSAlberto Garcia job->id = g_strdup(job_id); 165b6d2e599SKevin Wolf job->blk = blk; 1662f0c9fe6SPaolo Bonzini job->cb = cb; 1672f0c9fe6SPaolo Bonzini job->opaque = opaque; 1682f0c9fe6SPaolo Bonzini job->busy = true; 16918930ba3SFam Zheng job->refcnt = 1; 1702f0c9fe6SPaolo Bonzini bs->job = job; 1712f0c9fe6SPaolo Bonzini 172a7112795SAlberto Garcia QLIST_INSERT_HEAD(&block_jobs, job, job_list); 173a7112795SAlberto Garcia 174463e0be1SStefan Hajnoczi blk_add_aio_context_notifier(blk, block_job_attached_aio_context, 175463e0be1SStefan Hajnoczi block_job_detach_aio_context, job); 176463e0be1SStefan Hajnoczi 1772f0c9fe6SPaolo Bonzini /* Only set speed when necessary to avoid NotSupported error */ 1782f0c9fe6SPaolo Bonzini if (speed != 0) { 1792f0c9fe6SPaolo Bonzini Error *local_err = NULL; 1802f0c9fe6SPaolo Bonzini 1812f0c9fe6SPaolo Bonzini block_job_set_speed(job, speed, &local_err); 18284d18f06SMarkus Armbruster if (local_err) { 18318930ba3SFam Zheng block_job_unref(job); 1842f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 1852f0c9fe6SPaolo Bonzini return NULL; 1862f0c9fe6SPaolo Bonzini } 1872f0c9fe6SPaolo Bonzini } 1882f0c9fe6SPaolo Bonzini return job; 1892f0c9fe6SPaolo Bonzini } 1902f0c9fe6SPaolo Bonzini 191*559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 192*559b935fSJohn Snow { 193*559b935fSJohn Snow return (job->id == NULL); 194*559b935fSJohn Snow } 195*559b935fSJohn Snow 19618930ba3SFam Zheng void block_job_ref(BlockJob *job) 19797031164STing Wang { 19818930ba3SFam Zheng ++job->refcnt; 19918930ba3SFam Zheng } 20097031164STing Wang 20118930ba3SFam Zheng void block_job_unref(BlockJob *job) 20218930ba3SFam Zheng { 20318930ba3SFam Zheng if (--job->refcnt == 0) { 20423d402d4SAlberto Garcia GSList *l; 205b6d2e599SKevin Wolf BlockDriverState *bs = blk_bs(job->blk); 206b6d2e599SKevin Wolf bs->job = NULL; 20723d402d4SAlberto Garcia for (l = job->nodes; l; l = l->next) { 20823d402d4SAlberto Garcia bs = l->data; 209b6d2e599SKevin Wolf bdrv_op_unblock_all(bs, job->blocker); 21023d402d4SAlberto Garcia bdrv_unref(bs); 21123d402d4SAlberto Garcia } 21223d402d4SAlberto Garcia g_slist_free(job->nodes); 213463e0be1SStefan Hajnoczi blk_remove_aio_context_notifier(job->blk, 214463e0be1SStefan Hajnoczi block_job_attached_aio_context, 215463e0be1SStefan Hajnoczi block_job_detach_aio_context, job); 216b6d2e599SKevin Wolf blk_unref(job->blk); 21797031164STing Wang error_free(job->blocker); 2188ccb9569SKevin Wolf g_free(job->id); 219a7112795SAlberto Garcia QLIST_REMOVE(job, job_list); 22097031164STing Wang g_free(job); 22197031164STing Wang } 22218930ba3SFam Zheng } 22397031164STing Wang 224c55a832fSFam Zheng static void block_job_completed_single(BlockJob *job) 225c55a832fSFam Zheng { 226c55a832fSFam Zheng if (!job->ret) { 227c55a832fSFam Zheng if (job->driver->commit) { 228c55a832fSFam Zheng job->driver->commit(job); 229c55a832fSFam Zheng } 230c55a832fSFam Zheng } else { 231c55a832fSFam Zheng if (job->driver->abort) { 232c55a832fSFam Zheng job->driver->abort(job); 233c55a832fSFam Zheng } 234c55a832fSFam Zheng } 235c55a832fSFam Zheng job->cb(job->opaque, job->ret); 236c55a832fSFam Zheng if (job->txn) { 237c55a832fSFam Zheng block_job_txn_unref(job->txn); 238c55a832fSFam Zheng } 239c55a832fSFam Zheng block_job_unref(job); 240c55a832fSFam Zheng } 241c55a832fSFam Zheng 242c55a832fSFam Zheng static void block_job_completed_txn_abort(BlockJob *job) 243c55a832fSFam Zheng { 244c55a832fSFam Zheng AioContext *ctx; 245c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 246c55a832fSFam Zheng BlockJob *other_job, *next; 247c55a832fSFam Zheng 248c55a832fSFam Zheng if (txn->aborting) { 249c55a832fSFam Zheng /* 250c55a832fSFam Zheng * We are cancelled by another job, which will handle everything. 251c55a832fSFam Zheng */ 252c55a832fSFam Zheng return; 253c55a832fSFam Zheng } 254c55a832fSFam Zheng txn->aborting = true; 255c55a832fSFam Zheng /* We are the first failed job. Cancel other jobs. */ 256c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 257b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 258c55a832fSFam Zheng aio_context_acquire(ctx); 259c55a832fSFam Zheng } 260c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 261c55a832fSFam Zheng if (other_job == job || other_job->completed) { 262c55a832fSFam Zheng /* Other jobs are "effectively" cancelled by us, set the status for 263c55a832fSFam Zheng * them; this job, however, may or may not be cancelled, depending 264c55a832fSFam Zheng * on the caller, so leave it. */ 265c55a832fSFam Zheng if (other_job != job) { 266c55a832fSFam Zheng other_job->cancelled = true; 267c55a832fSFam Zheng } 268c55a832fSFam Zheng continue; 269c55a832fSFam Zheng } 270c55a832fSFam Zheng block_job_cancel_sync(other_job); 271c55a832fSFam Zheng assert(other_job->completed); 272c55a832fSFam Zheng } 273c55a832fSFam Zheng QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { 274b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 275c55a832fSFam Zheng block_job_completed_single(other_job); 276c55a832fSFam Zheng aio_context_release(ctx); 277c55a832fSFam Zheng } 278c55a832fSFam Zheng } 279c55a832fSFam Zheng 280c55a832fSFam Zheng static void block_job_completed_txn_success(BlockJob *job) 281c55a832fSFam Zheng { 282c55a832fSFam Zheng AioContext *ctx; 283c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 284c55a832fSFam Zheng BlockJob *other_job, *next; 285c55a832fSFam Zheng /* 286c55a832fSFam Zheng * Successful completion, see if there are other running jobs in this 287c55a832fSFam Zheng * txn. 288c55a832fSFam Zheng */ 289c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 290c55a832fSFam Zheng if (!other_job->completed) { 291c55a832fSFam Zheng return; 292c55a832fSFam Zheng } 293c55a832fSFam Zheng } 294c55a832fSFam Zheng /* We are the last completed job, commit the transaction. */ 295c55a832fSFam Zheng QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { 296b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 297c55a832fSFam Zheng aio_context_acquire(ctx); 298c55a832fSFam Zheng assert(other_job->ret == 0); 299c55a832fSFam Zheng block_job_completed_single(other_job); 300c55a832fSFam Zheng aio_context_release(ctx); 301c55a832fSFam Zheng } 302c55a832fSFam Zheng } 303c55a832fSFam Zheng 30465f46322SPaolo Bonzini void block_job_completed(BlockJob *job, int ret) 3052f0c9fe6SPaolo Bonzini { 306b6d2e599SKevin Wolf assert(blk_bs(job->blk)->job == job); 307a689dbf2SFam Zheng assert(!job->completed); 308a689dbf2SFam Zheng job->completed = true; 309a689dbf2SFam Zheng job->ret = ret; 310c55a832fSFam Zheng if (!job->txn) { 311c55a832fSFam Zheng block_job_completed_single(job); 312c55a832fSFam Zheng } else if (ret < 0 || block_job_is_cancelled(job)) { 313c55a832fSFam Zheng block_job_completed_txn_abort(job); 314c55a832fSFam Zheng } else { 315c55a832fSFam Zheng block_job_completed_txn_success(job); 316c55a832fSFam Zheng } 3172f0c9fe6SPaolo Bonzini } 3182f0c9fe6SPaolo Bonzini 3192f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 3202f0c9fe6SPaolo Bonzini { 3212f0c9fe6SPaolo Bonzini Error *local_err = NULL; 3222f0c9fe6SPaolo Bonzini 3233fc4b10aSFam Zheng if (!job->driver->set_speed) { 324c6bd8c70SMarkus Armbruster error_setg(errp, QERR_UNSUPPORTED); 3252f0c9fe6SPaolo Bonzini return; 3262f0c9fe6SPaolo Bonzini } 3273fc4b10aSFam Zheng job->driver->set_speed(job, speed, &local_err); 32884d18f06SMarkus Armbruster if (local_err) { 3292f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 3302f0c9fe6SPaolo Bonzini return; 3312f0c9fe6SPaolo Bonzini } 3322f0c9fe6SPaolo Bonzini 3332f0c9fe6SPaolo Bonzini job->speed = speed; 3342f0c9fe6SPaolo Bonzini } 3352f0c9fe6SPaolo Bonzini 336aeae883bSPaolo Bonzini void block_job_complete(BlockJob *job, Error **errp) 337aeae883bSPaolo Bonzini { 338*559b935fSJohn Snow /* Should not be reachable via external interface for internal jobs */ 339*559b935fSJohn Snow assert(job->id); 340751ebd76SFam Zheng if (job->pause_count || job->cancelled || !job->driver->complete) { 3419df229c3SAlberto Garcia error_setg(errp, "The active block job '%s' cannot be completed", 3429df229c3SAlberto Garcia job->id); 343aeae883bSPaolo Bonzini return; 344aeae883bSPaolo Bonzini } 345aeae883bSPaolo Bonzini 3463fc4b10aSFam Zheng job->driver->complete(job, errp); 347aeae883bSPaolo Bonzini } 348aeae883bSPaolo Bonzini 3498acc72a4SPaolo Bonzini void block_job_pause(BlockJob *job) 3502f0c9fe6SPaolo Bonzini { 351751ebd76SFam Zheng job->pause_count++; 3528acc72a4SPaolo Bonzini } 3538acc72a4SPaolo Bonzini 354a7f3b7ffSStefan Hajnoczi static bool block_job_should_pause(BlockJob *job) 3558acc72a4SPaolo Bonzini { 356751ebd76SFam Zheng return job->pause_count > 0; 3578acc72a4SPaolo Bonzini } 3588acc72a4SPaolo Bonzini 359fc9c0a9cSStefan Hajnoczi void coroutine_fn block_job_pause_point(BlockJob *job) 360fc9c0a9cSStefan Hajnoczi { 361fc9c0a9cSStefan Hajnoczi if (!block_job_should_pause(job)) { 362fc9c0a9cSStefan Hajnoczi return; 363fc9c0a9cSStefan Hajnoczi } 364fc9c0a9cSStefan Hajnoczi if (block_job_is_cancelled(job)) { 365fc9c0a9cSStefan Hajnoczi return; 366fc9c0a9cSStefan Hajnoczi } 367fc9c0a9cSStefan Hajnoczi 368fc9c0a9cSStefan Hajnoczi if (job->driver->pause) { 369fc9c0a9cSStefan Hajnoczi job->driver->pause(job); 370fc9c0a9cSStefan Hajnoczi } 371fc9c0a9cSStefan Hajnoczi 372fc9c0a9cSStefan Hajnoczi if (block_job_should_pause(job) && !block_job_is_cancelled(job)) { 373fc9c0a9cSStefan Hajnoczi job->paused = true; 374fc9c0a9cSStefan Hajnoczi job->busy = false; 375fc9c0a9cSStefan Hajnoczi qemu_coroutine_yield(); /* wait for block_job_resume() */ 376fc9c0a9cSStefan Hajnoczi job->busy = true; 377fc9c0a9cSStefan Hajnoczi job->paused = false; 378fc9c0a9cSStefan Hajnoczi } 379fc9c0a9cSStefan Hajnoczi 380fc9c0a9cSStefan Hajnoczi if (job->driver->resume) { 381fc9c0a9cSStefan Hajnoczi job->driver->resume(job); 382fc9c0a9cSStefan Hajnoczi } 383fc9c0a9cSStefan Hajnoczi } 384fc9c0a9cSStefan Hajnoczi 3858acc72a4SPaolo Bonzini void block_job_resume(BlockJob *job) 3868acc72a4SPaolo Bonzini { 387751ebd76SFam Zheng assert(job->pause_count > 0); 388751ebd76SFam Zheng job->pause_count--; 389751ebd76SFam Zheng if (job->pause_count) { 390751ebd76SFam Zheng return; 391751ebd76SFam Zheng } 392751ebd76SFam Zheng block_job_enter(job); 393751ebd76SFam Zheng } 394751ebd76SFam Zheng 395751ebd76SFam Zheng void block_job_enter(BlockJob *job) 396751ebd76SFam Zheng { 3972f0c9fe6SPaolo Bonzini if (job->co && !job->busy) { 3980b8b8753SPaolo Bonzini qemu_coroutine_enter(job->co); 3992f0c9fe6SPaolo Bonzini } 4002f0c9fe6SPaolo Bonzini } 4012f0c9fe6SPaolo Bonzini 4028acc72a4SPaolo Bonzini void block_job_cancel(BlockJob *job) 4038acc72a4SPaolo Bonzini { 4048acc72a4SPaolo Bonzini job->cancelled = true; 40517bd51f9SStefan Hajnoczi block_job_iostatus_reset(job); 406751ebd76SFam Zheng block_job_enter(job); 4078acc72a4SPaolo Bonzini } 4088acc72a4SPaolo Bonzini 4092f0c9fe6SPaolo Bonzini bool block_job_is_cancelled(BlockJob *job) 4102f0c9fe6SPaolo Bonzini { 4112f0c9fe6SPaolo Bonzini return job->cancelled; 4122f0c9fe6SPaolo Bonzini } 4132f0c9fe6SPaolo Bonzini 41432c81a4aSPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 41532c81a4aSPaolo Bonzini { 41632c81a4aSPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 4173fc4b10aSFam Zheng if (job->driver->iostatus_reset) { 4183fc4b10aSFam Zheng job->driver->iostatus_reset(job); 4193bd293c3SPaolo Bonzini } 42032c81a4aSPaolo Bonzini } 42132c81a4aSPaolo Bonzini 422345f9e1bSMax Reitz static int block_job_finish_sync(BlockJob *job, 423345f9e1bSMax Reitz void (*finish)(BlockJob *, Error **errp), 424345f9e1bSMax Reitz Error **errp) 4252f0c9fe6SPaolo Bonzini { 426345f9e1bSMax Reitz Error *local_err = NULL; 42794db6d2dSFam Zheng int ret; 4282f0c9fe6SPaolo Bonzini 429b6d2e599SKevin Wolf assert(blk_bs(job->blk)->job == job); 4302f0c9fe6SPaolo Bonzini 43194db6d2dSFam Zheng block_job_ref(job); 432bae8196dSPaolo Bonzini 433345f9e1bSMax Reitz finish(job, &local_err); 434345f9e1bSMax Reitz if (local_err) { 435345f9e1bSMax Reitz error_propagate(errp, local_err); 43694db6d2dSFam Zheng block_job_unref(job); 437345f9e1bSMax Reitz return -EBUSY; 438345f9e1bSMax Reitz } 439bae8196dSPaolo Bonzini /* block_job_drain calls block_job_enter, and it should be enough to 440bae8196dSPaolo Bonzini * induce progress until the job completes or moves to the main thread. 441bae8196dSPaolo Bonzini */ 442bae8196dSPaolo Bonzini while (!job->deferred_to_main_loop && !job->completed) { 443bae8196dSPaolo Bonzini block_job_drain(job); 444bae8196dSPaolo Bonzini } 44594db6d2dSFam Zheng while (!job->completed) { 446bae8196dSPaolo Bonzini aio_poll(qemu_get_aio_context(), true); 4472f0c9fe6SPaolo Bonzini } 44894db6d2dSFam Zheng ret = (job->cancelled && job->ret == 0) ? -ECANCELED : job->ret; 44994db6d2dSFam Zheng block_job_unref(job); 45094db6d2dSFam Zheng return ret; 4512f0c9fe6SPaolo Bonzini } 4522f0c9fe6SPaolo Bonzini 453345f9e1bSMax Reitz /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be 454345f9e1bSMax Reitz * used with block_job_finish_sync() without the need for (rather nasty) 455345f9e1bSMax Reitz * function pointer casts there. */ 456345f9e1bSMax Reitz static void block_job_cancel_err(BlockJob *job, Error **errp) 457345f9e1bSMax Reitz { 458345f9e1bSMax Reitz block_job_cancel(job); 459345f9e1bSMax Reitz } 460345f9e1bSMax Reitz 461345f9e1bSMax Reitz int block_job_cancel_sync(BlockJob *job) 462345f9e1bSMax Reitz { 463345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_cancel_err, NULL); 464345f9e1bSMax Reitz } 465345f9e1bSMax Reitz 466a1a2af07SKevin Wolf void block_job_cancel_sync_all(void) 467a1a2af07SKevin Wolf { 468a1a2af07SKevin Wolf BlockJob *job; 469a1a2af07SKevin Wolf AioContext *aio_context; 470a1a2af07SKevin Wolf 471a1a2af07SKevin Wolf while ((job = QLIST_FIRST(&block_jobs))) { 472b6d2e599SKevin Wolf aio_context = blk_get_aio_context(job->blk); 473a1a2af07SKevin Wolf aio_context_acquire(aio_context); 474a1a2af07SKevin Wolf block_job_cancel_sync(job); 475a1a2af07SKevin Wolf aio_context_release(aio_context); 476a1a2af07SKevin Wolf } 477a1a2af07SKevin Wolf } 478a1a2af07SKevin Wolf 479345f9e1bSMax Reitz int block_job_complete_sync(BlockJob *job, Error **errp) 480345f9e1bSMax Reitz { 481345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_complete, errp); 482345f9e1bSMax Reitz } 483345f9e1bSMax Reitz 4847483d1e5SAlex Bligh void block_job_sleep_ns(BlockJob *job, QEMUClockType type, int64_t ns) 4852f0c9fe6SPaolo Bonzini { 4868acc72a4SPaolo Bonzini assert(job->busy); 4878acc72a4SPaolo Bonzini 4882f0c9fe6SPaolo Bonzini /* Check cancellation *before* setting busy = false, too! */ 4898acc72a4SPaolo Bonzini if (block_job_is_cancelled(job)) { 4908acc72a4SPaolo Bonzini return; 4912f0c9fe6SPaolo Bonzini } 4928acc72a4SPaolo Bonzini 4938acc72a4SPaolo Bonzini job->busy = false; 494a7f3b7ffSStefan Hajnoczi if (!block_job_should_pause(job)) { 4950824afdaSAlberto Garcia co_aio_sleep_ns(blk_get_aio_context(job->blk), type, ns); 4960824afdaSAlberto Garcia } 4978acc72a4SPaolo Bonzini job->busy = true; 498fc9c0a9cSStefan Hajnoczi 499fc9c0a9cSStefan Hajnoczi block_job_pause_point(job); 5002f0c9fe6SPaolo Bonzini } 50130e628b7SPaolo Bonzini 502dc71ce45SFam Zheng void block_job_yield(BlockJob *job) 503dc71ce45SFam Zheng { 504dc71ce45SFam Zheng assert(job->busy); 505dc71ce45SFam Zheng 506dc71ce45SFam Zheng /* Check cancellation *before* setting busy = false, too! */ 507dc71ce45SFam Zheng if (block_job_is_cancelled(job)) { 508dc71ce45SFam Zheng return; 509dc71ce45SFam Zheng } 510dc71ce45SFam Zheng 511dc71ce45SFam Zheng job->busy = false; 512fc9c0a9cSStefan Hajnoczi if (!block_job_should_pause(job)) { 513dc71ce45SFam Zheng qemu_coroutine_yield(); 514fc9c0a9cSStefan Hajnoczi } 515dc71ce45SFam Zheng job->busy = true; 516fc9c0a9cSStefan Hajnoczi 517fc9c0a9cSStefan Hajnoczi block_job_pause_point(job); 518dc71ce45SFam Zheng } 519dc71ce45SFam Zheng 520*559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp) 52130e628b7SPaolo Bonzini { 522*559b935fSJohn Snow BlockJobInfo *info; 523*559b935fSJohn Snow 524*559b935fSJohn Snow if (block_job_is_internal(job)) { 525*559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 526*559b935fSJohn Snow return NULL; 527*559b935fSJohn Snow } 528*559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 52979e14bf7SFam Zheng info->type = g_strdup(BlockJobType_lookup[job->driver->job_type]); 5308ccb9569SKevin Wolf info->device = g_strdup(job->id); 53130e628b7SPaolo Bonzini info->len = job->len; 5328d65883fSPaolo Bonzini info->busy = job->busy; 533751ebd76SFam Zheng info->paused = job->pause_count > 0; 53430e628b7SPaolo Bonzini info->offset = job->offset; 53530e628b7SPaolo Bonzini info->speed = job->speed; 53632c81a4aSPaolo Bonzini info->io_status = job->iostatus; 537ef6dbf1eSMax Reitz info->ready = job->ready; 53830e628b7SPaolo Bonzini return info; 53930e628b7SPaolo Bonzini } 54032c81a4aSPaolo Bonzini 54132c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 54232c81a4aSPaolo Bonzini { 54332c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 54432c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 54532c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 54632c81a4aSPaolo Bonzini } 54732c81a4aSPaolo Bonzini } 54832c81a4aSPaolo Bonzini 549bcada37bSWenchao Xia void block_job_event_cancelled(BlockJob *job) 550a66a2a36SPaolo Bonzini { 551*559b935fSJohn Snow if (block_job_is_internal(job)) { 552*559b935fSJohn Snow return; 553*559b935fSJohn Snow } 554*559b935fSJohn Snow 555bcada37bSWenchao Xia qapi_event_send_block_job_cancelled(job->driver->job_type, 5568ccb9569SKevin Wolf job->id, 557a66a2a36SPaolo Bonzini job->len, 558a66a2a36SPaolo Bonzini job->offset, 559bcada37bSWenchao Xia job->speed, 560bcada37bSWenchao Xia &error_abort); 561a66a2a36SPaolo Bonzini } 562a66a2a36SPaolo Bonzini 563bcada37bSWenchao Xia void block_job_event_completed(BlockJob *job, const char *msg) 564a66a2a36SPaolo Bonzini { 565*559b935fSJohn Snow if (block_job_is_internal(job)) { 566*559b935fSJohn Snow return; 567*559b935fSJohn Snow } 568*559b935fSJohn Snow 569bcada37bSWenchao Xia qapi_event_send_block_job_completed(job->driver->job_type, 5708ccb9569SKevin Wolf job->id, 571bcada37bSWenchao Xia job->len, 572bcada37bSWenchao Xia job->offset, 573bcada37bSWenchao Xia job->speed, 574bcada37bSWenchao Xia !!msg, 575bcada37bSWenchao Xia msg, 576bcada37bSWenchao Xia &error_abort); 577bcada37bSWenchao Xia } 578bcada37bSWenchao Xia 579bcada37bSWenchao Xia void block_job_event_ready(BlockJob *job) 580bcada37bSWenchao Xia { 581ef6dbf1eSMax Reitz job->ready = true; 582ef6dbf1eSMax Reitz 583*559b935fSJohn Snow if (block_job_is_internal(job)) { 584*559b935fSJohn Snow return; 585*559b935fSJohn Snow } 586*559b935fSJohn Snow 587518848a2SMarkus Armbruster qapi_event_send_block_job_ready(job->driver->job_type, 5888ccb9569SKevin Wolf job->id, 589518848a2SMarkus Armbruster job->len, 590518848a2SMarkus Armbruster job->offset, 591518848a2SMarkus Armbruster job->speed, &error_abort); 592a66a2a36SPaolo Bonzini } 593a66a2a36SPaolo Bonzini 59481e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 59532c81a4aSPaolo Bonzini int is_read, int error) 59632c81a4aSPaolo Bonzini { 59732c81a4aSPaolo Bonzini BlockErrorAction action; 59832c81a4aSPaolo Bonzini 59932c81a4aSPaolo Bonzini switch (on_err) { 60032c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 6018c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 602a589569fSWenchao Xia action = (error == ENOSPC) ? 603a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 60432c81a4aSPaolo Bonzini break; 60532c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 606a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 60732c81a4aSPaolo Bonzini break; 60832c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 609a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 61032c81a4aSPaolo Bonzini break; 61132c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 612a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 61332c81a4aSPaolo Bonzini break; 61432c81a4aSPaolo Bonzini default: 61532c81a4aSPaolo Bonzini abort(); 61632c81a4aSPaolo Bonzini } 617*559b935fSJohn Snow if (!block_job_is_internal(job)) { 6188ccb9569SKevin Wolf qapi_event_send_block_job_error(job->id, 6195a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 6205a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 6215a2d2cbdSWenchao Xia action, &error_abort); 622*559b935fSJohn Snow } 623a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 624751ebd76SFam Zheng /* make the pause user visible, which will be resumed from QMP. */ 625751ebd76SFam Zheng job->user_paused = true; 62632c81a4aSPaolo Bonzini block_job_pause(job); 62732c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 62832c81a4aSPaolo Bonzini } 62932c81a4aSPaolo Bonzini return action; 63032c81a4aSPaolo Bonzini } 631dec7d421SStefan Hajnoczi 632dec7d421SStefan Hajnoczi typedef struct { 633dec7d421SStefan Hajnoczi BlockJob *job; 634dec7d421SStefan Hajnoczi AioContext *aio_context; 635dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopFn *fn; 636dec7d421SStefan Hajnoczi void *opaque; 637dec7d421SStefan Hajnoczi } BlockJobDeferToMainLoopData; 638dec7d421SStefan Hajnoczi 639dec7d421SStefan Hajnoczi static void block_job_defer_to_main_loop_bh(void *opaque) 640dec7d421SStefan Hajnoczi { 641dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopData *data = opaque; 642dec7d421SStefan Hajnoczi AioContext *aio_context; 643dec7d421SStefan Hajnoczi 644dec7d421SStefan Hajnoczi /* Prevent race with block_job_defer_to_main_loop() */ 645dec7d421SStefan Hajnoczi aio_context_acquire(data->aio_context); 646dec7d421SStefan Hajnoczi 647dec7d421SStefan Hajnoczi /* Fetch BDS AioContext again, in case it has changed */ 648b6d2e599SKevin Wolf aio_context = blk_get_aio_context(data->job->blk); 649dec7d421SStefan Hajnoczi aio_context_acquire(aio_context); 650dec7d421SStefan Hajnoczi 651794f0141SFam Zheng data->job->deferred_to_main_loop = false; 652dec7d421SStefan Hajnoczi data->fn(data->job, data->opaque); 653dec7d421SStefan Hajnoczi 654dec7d421SStefan Hajnoczi aio_context_release(aio_context); 655dec7d421SStefan Hajnoczi 656dec7d421SStefan Hajnoczi aio_context_release(data->aio_context); 657dec7d421SStefan Hajnoczi 658dec7d421SStefan Hajnoczi g_free(data); 659dec7d421SStefan Hajnoczi } 660dec7d421SStefan Hajnoczi 661dec7d421SStefan Hajnoczi void block_job_defer_to_main_loop(BlockJob *job, 662dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopFn *fn, 663dec7d421SStefan Hajnoczi void *opaque) 664dec7d421SStefan Hajnoczi { 665dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data)); 666dec7d421SStefan Hajnoczi data->job = job; 667b6d2e599SKevin Wolf data->aio_context = blk_get_aio_context(job->blk); 668dec7d421SStefan Hajnoczi data->fn = fn; 669dec7d421SStefan Hajnoczi data->opaque = opaque; 670794f0141SFam Zheng job->deferred_to_main_loop = true; 671dec7d421SStefan Hajnoczi 672fffb6e12SPaolo Bonzini aio_bh_schedule_oneshot(qemu_get_aio_context(), 673fffb6e12SPaolo Bonzini block_job_defer_to_main_loop_bh, data); 674dec7d421SStefan Hajnoczi } 675c55a832fSFam Zheng 676c55a832fSFam Zheng BlockJobTxn *block_job_txn_new(void) 677c55a832fSFam Zheng { 678c55a832fSFam Zheng BlockJobTxn *txn = g_new0(BlockJobTxn, 1); 679c55a832fSFam Zheng QLIST_INIT(&txn->jobs); 680c55a832fSFam Zheng txn->refcnt = 1; 681c55a832fSFam Zheng return txn; 682c55a832fSFam Zheng } 683c55a832fSFam Zheng 684c55a832fSFam Zheng static void block_job_txn_ref(BlockJobTxn *txn) 685c55a832fSFam Zheng { 686c55a832fSFam Zheng txn->refcnt++; 687c55a832fSFam Zheng } 688c55a832fSFam Zheng 689c55a832fSFam Zheng void block_job_txn_unref(BlockJobTxn *txn) 690c55a832fSFam Zheng { 691c55a832fSFam Zheng if (txn && --txn->refcnt == 0) { 692c55a832fSFam Zheng g_free(txn); 693c55a832fSFam Zheng } 694c55a832fSFam Zheng } 695c55a832fSFam Zheng 696c55a832fSFam Zheng void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job) 697c55a832fSFam Zheng { 698c55a832fSFam Zheng if (!txn) { 699c55a832fSFam Zheng return; 700c55a832fSFam Zheng } 701c55a832fSFam Zheng 702c55a832fSFam Zheng assert(!job->txn); 703c55a832fSFam Zheng job->txn = txn; 704c55a832fSFam Zheng 705c55a832fSFam Zheng QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 706c55a832fSFam Zheng block_job_txn_ref(txn); 707c55a832fSFam Zheng } 708