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) { 69ffb1f10cSAlberto Garcia if (!strcmp(id, job->id)) { 70ffb1f10cSAlberto Garcia return job; 71ffb1f10cSAlberto Garcia } 72ffb1f10cSAlberto Garcia } 73ffb1f10cSAlberto Garcia 74ffb1f10cSAlberto Garcia return NULL; 75ffb1f10cSAlberto Garcia } 76ffb1f10cSAlberto Garcia 779f6bc648SStefan Hajnoczi /* Normally the job runs in its BlockBackend's AioContext. The exception is 789f6bc648SStefan Hajnoczi * block_job_defer_to_main_loop() where it runs in the QEMU main loop. Code 799f6bc648SStefan Hajnoczi * that supports both cases uses this helper function. 809f6bc648SStefan Hajnoczi */ 819f6bc648SStefan Hajnoczi static AioContext *block_job_get_aio_context(BlockJob *job) 829f6bc648SStefan Hajnoczi { 839f6bc648SStefan Hajnoczi return job->deferred_to_main_loop ? 849f6bc648SStefan Hajnoczi qemu_get_aio_context() : 859f6bc648SStefan Hajnoczi blk_get_aio_context(job->blk); 869f6bc648SStefan Hajnoczi } 879f6bc648SStefan Hajnoczi 88463e0be1SStefan Hajnoczi static void block_job_attached_aio_context(AioContext *new_context, 89463e0be1SStefan Hajnoczi void *opaque) 90463e0be1SStefan Hajnoczi { 91463e0be1SStefan Hajnoczi BlockJob *job = opaque; 92463e0be1SStefan Hajnoczi 93463e0be1SStefan Hajnoczi if (job->driver->attached_aio_context) { 94463e0be1SStefan Hajnoczi job->driver->attached_aio_context(job, new_context); 95463e0be1SStefan Hajnoczi } 96463e0be1SStefan Hajnoczi 97463e0be1SStefan Hajnoczi block_job_resume(job); 98463e0be1SStefan Hajnoczi } 99463e0be1SStefan Hajnoczi 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 if (!job->paused) { 110463e0be1SStefan Hajnoczi /* If job is !job->busy this kicks it into the next pause point. */ 111463e0be1SStefan Hajnoczi block_job_enter(job); 112463e0be1SStefan Hajnoczi } 113463e0be1SStefan Hajnoczi while (!job->paused && !job->completed) { 114463e0be1SStefan Hajnoczi aio_poll(block_job_get_aio_context(job), true); 115463e0be1SStefan Hajnoczi } 116463e0be1SStefan Hajnoczi 117463e0be1SStefan Hajnoczi block_job_unref(job); 118463e0be1SStefan Hajnoczi } 119463e0be1SStefan Hajnoczi 1207f0317cfSAlberto Garcia void *block_job_create(const char *job_id, const BlockJobDriver *driver, 1217f0317cfSAlberto Garcia BlockDriverState *bs, int64_t speed, 1227f0317cfSAlberto Garcia BlockCompletionFunc *cb, void *opaque, Error **errp) 1232f0c9fe6SPaolo Bonzini { 124b6d2e599SKevin Wolf BlockBackend *blk; 1252f0c9fe6SPaolo Bonzini BlockJob *job; 1262f0c9fe6SPaolo Bonzini 127b48100cfSChanglong Xie assert(cb); 128628ff683SFam Zheng if (bs->job) { 129c6bd8c70SMarkus Armbruster error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); 1302f0c9fe6SPaolo Bonzini return NULL; 1312f0c9fe6SPaolo Bonzini } 132b6d2e599SKevin Wolf 1337f0317cfSAlberto Garcia if (job_id == NULL) { 1347f0317cfSAlberto Garcia job_id = bdrv_get_device_name(bs); 1357f0317cfSAlberto Garcia } 1367f0317cfSAlberto Garcia 1377f0317cfSAlberto Garcia if (!id_wellformed(job_id)) { 1387f0317cfSAlberto Garcia error_setg(errp, "Invalid job ID '%s'", job_id); 1397f0317cfSAlberto Garcia return NULL; 1407f0317cfSAlberto Garcia } 1417f0317cfSAlberto Garcia 1427f0317cfSAlberto Garcia if (block_job_get(job_id)) { 1437f0317cfSAlberto Garcia error_setg(errp, "Job ID '%s' already in use", job_id); 1447f0317cfSAlberto Garcia return NULL; 1457f0317cfSAlberto Garcia } 1467f0317cfSAlberto Garcia 147b6d2e599SKevin Wolf blk = blk_new(); 148b6d2e599SKevin Wolf blk_insert_bs(blk, bs); 149b6d2e599SKevin Wolf 1503fc4b10aSFam Zheng job = g_malloc0(driver->instance_size); 1513718d8abSFam Zheng error_setg(&job->blocker, "block device is in use by block job: %s", 1523718d8abSFam Zheng BlockJobType_lookup[driver->job_type]); 1533718d8abSFam Zheng bdrv_op_block_all(bs, job->blocker); 154b112a65cSStefan Hajnoczi bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 1553718d8abSFam Zheng 1563fc4b10aSFam Zheng job->driver = driver; 1577f0317cfSAlberto Garcia job->id = g_strdup(job_id); 158b6d2e599SKevin Wolf job->blk = blk; 1592f0c9fe6SPaolo Bonzini job->cb = cb; 1602f0c9fe6SPaolo Bonzini job->opaque = opaque; 1612f0c9fe6SPaolo Bonzini job->busy = true; 16218930ba3SFam Zheng job->refcnt = 1; 1632f0c9fe6SPaolo Bonzini bs->job = job; 1642f0c9fe6SPaolo Bonzini 165a7112795SAlberto Garcia QLIST_INSERT_HEAD(&block_jobs, job, job_list); 166a7112795SAlberto Garcia 167463e0be1SStefan Hajnoczi blk_add_aio_context_notifier(blk, block_job_attached_aio_context, 168463e0be1SStefan Hajnoczi block_job_detach_aio_context, job); 169463e0be1SStefan Hajnoczi 1702f0c9fe6SPaolo Bonzini /* Only set speed when necessary to avoid NotSupported error */ 1712f0c9fe6SPaolo Bonzini if (speed != 0) { 1722f0c9fe6SPaolo Bonzini Error *local_err = NULL; 1732f0c9fe6SPaolo Bonzini 1742f0c9fe6SPaolo Bonzini block_job_set_speed(job, speed, &local_err); 17584d18f06SMarkus Armbruster if (local_err) { 17618930ba3SFam Zheng block_job_unref(job); 1772f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 1782f0c9fe6SPaolo Bonzini return NULL; 1792f0c9fe6SPaolo Bonzini } 1802f0c9fe6SPaolo Bonzini } 1812f0c9fe6SPaolo Bonzini return job; 1822f0c9fe6SPaolo Bonzini } 1832f0c9fe6SPaolo Bonzini 18418930ba3SFam Zheng void block_job_ref(BlockJob *job) 18597031164STing Wang { 18618930ba3SFam Zheng ++job->refcnt; 18718930ba3SFam Zheng } 18897031164STing Wang 18918930ba3SFam Zheng void block_job_unref(BlockJob *job) 19018930ba3SFam Zheng { 19118930ba3SFam Zheng if (--job->refcnt == 0) { 192b6d2e599SKevin Wolf BlockDriverState *bs = blk_bs(job->blk); 193b6d2e599SKevin Wolf bs->job = NULL; 194b6d2e599SKevin Wolf bdrv_op_unblock_all(bs, job->blocker); 195463e0be1SStefan Hajnoczi blk_remove_aio_context_notifier(job->blk, 196463e0be1SStefan Hajnoczi block_job_attached_aio_context, 197463e0be1SStefan Hajnoczi block_job_detach_aio_context, job); 198b6d2e599SKevin Wolf blk_unref(job->blk); 19997031164STing Wang error_free(job->blocker); 2008ccb9569SKevin Wolf g_free(job->id); 201a7112795SAlberto Garcia QLIST_REMOVE(job, job_list); 20297031164STing Wang g_free(job); 20397031164STing Wang } 20418930ba3SFam Zheng } 20597031164STing Wang 206c55a832fSFam Zheng static void block_job_completed_single(BlockJob *job) 207c55a832fSFam Zheng { 208c55a832fSFam Zheng if (!job->ret) { 209c55a832fSFam Zheng if (job->driver->commit) { 210c55a832fSFam Zheng job->driver->commit(job); 211c55a832fSFam Zheng } 212c55a832fSFam Zheng } else { 213c55a832fSFam Zheng if (job->driver->abort) { 214c55a832fSFam Zheng job->driver->abort(job); 215c55a832fSFam Zheng } 216c55a832fSFam Zheng } 217c55a832fSFam Zheng job->cb(job->opaque, job->ret); 218c55a832fSFam Zheng if (job->txn) { 219c55a832fSFam Zheng block_job_txn_unref(job->txn); 220c55a832fSFam Zheng } 221c55a832fSFam Zheng block_job_unref(job); 222c55a832fSFam Zheng } 223c55a832fSFam Zheng 224c55a832fSFam Zheng static void block_job_completed_txn_abort(BlockJob *job) 225c55a832fSFam Zheng { 226c55a832fSFam Zheng AioContext *ctx; 227c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 228c55a832fSFam Zheng BlockJob *other_job, *next; 229c55a832fSFam Zheng 230c55a832fSFam Zheng if (txn->aborting) { 231c55a832fSFam Zheng /* 232c55a832fSFam Zheng * We are cancelled by another job, which will handle everything. 233c55a832fSFam Zheng */ 234c55a832fSFam Zheng return; 235c55a832fSFam Zheng } 236c55a832fSFam Zheng txn->aborting = true; 237c55a832fSFam Zheng /* We are the first failed job. Cancel other jobs. */ 238c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 239b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 240c55a832fSFam Zheng aio_context_acquire(ctx); 241c55a832fSFam Zheng } 242c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 243c55a832fSFam Zheng if (other_job == job || other_job->completed) { 244c55a832fSFam Zheng /* Other jobs are "effectively" cancelled by us, set the status for 245c55a832fSFam Zheng * them; this job, however, may or may not be cancelled, depending 246c55a832fSFam Zheng * on the caller, so leave it. */ 247c55a832fSFam Zheng if (other_job != job) { 248c55a832fSFam Zheng other_job->cancelled = true; 249c55a832fSFam Zheng } 250c55a832fSFam Zheng continue; 251c55a832fSFam Zheng } 252c55a832fSFam Zheng block_job_cancel_sync(other_job); 253c55a832fSFam Zheng assert(other_job->completed); 254c55a832fSFam Zheng } 255c55a832fSFam Zheng QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { 256b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 257c55a832fSFam Zheng block_job_completed_single(other_job); 258c55a832fSFam Zheng aio_context_release(ctx); 259c55a832fSFam Zheng } 260c55a832fSFam Zheng } 261c55a832fSFam Zheng 262c55a832fSFam Zheng static void block_job_completed_txn_success(BlockJob *job) 263c55a832fSFam Zheng { 264c55a832fSFam Zheng AioContext *ctx; 265c55a832fSFam Zheng BlockJobTxn *txn = job->txn; 266c55a832fSFam Zheng BlockJob *other_job, *next; 267c55a832fSFam Zheng /* 268c55a832fSFam Zheng * Successful completion, see if there are other running jobs in this 269c55a832fSFam Zheng * txn. 270c55a832fSFam Zheng */ 271c55a832fSFam Zheng QLIST_FOREACH(other_job, &txn->jobs, txn_list) { 272c55a832fSFam Zheng if (!other_job->completed) { 273c55a832fSFam Zheng return; 274c55a832fSFam Zheng } 275c55a832fSFam Zheng } 276c55a832fSFam Zheng /* We are the last completed job, commit the transaction. */ 277c55a832fSFam Zheng QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { 278b6d2e599SKevin Wolf ctx = blk_get_aio_context(other_job->blk); 279c55a832fSFam Zheng aio_context_acquire(ctx); 280c55a832fSFam Zheng assert(other_job->ret == 0); 281c55a832fSFam Zheng block_job_completed_single(other_job); 282c55a832fSFam Zheng aio_context_release(ctx); 283c55a832fSFam Zheng } 284c55a832fSFam Zheng } 285c55a832fSFam Zheng 28665f46322SPaolo Bonzini void block_job_completed(BlockJob *job, int ret) 2872f0c9fe6SPaolo Bonzini { 288b6d2e599SKevin Wolf assert(blk_bs(job->blk)->job == job); 289a689dbf2SFam Zheng assert(!job->completed); 290a689dbf2SFam Zheng job->completed = true; 291a689dbf2SFam Zheng job->ret = ret; 292c55a832fSFam Zheng if (!job->txn) { 293c55a832fSFam Zheng block_job_completed_single(job); 294c55a832fSFam Zheng } else if (ret < 0 || block_job_is_cancelled(job)) { 295c55a832fSFam Zheng block_job_completed_txn_abort(job); 296c55a832fSFam Zheng } else { 297c55a832fSFam Zheng block_job_completed_txn_success(job); 298c55a832fSFam Zheng } 2992f0c9fe6SPaolo Bonzini } 3002f0c9fe6SPaolo Bonzini 3012f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 3022f0c9fe6SPaolo Bonzini { 3032f0c9fe6SPaolo Bonzini Error *local_err = NULL; 3042f0c9fe6SPaolo Bonzini 3053fc4b10aSFam Zheng if (!job->driver->set_speed) { 306c6bd8c70SMarkus Armbruster error_setg(errp, QERR_UNSUPPORTED); 3072f0c9fe6SPaolo Bonzini return; 3082f0c9fe6SPaolo Bonzini } 3093fc4b10aSFam Zheng job->driver->set_speed(job, speed, &local_err); 31084d18f06SMarkus Armbruster if (local_err) { 3112f0c9fe6SPaolo Bonzini error_propagate(errp, local_err); 3122f0c9fe6SPaolo Bonzini return; 3132f0c9fe6SPaolo Bonzini } 3142f0c9fe6SPaolo Bonzini 3152f0c9fe6SPaolo Bonzini job->speed = speed; 3162f0c9fe6SPaolo Bonzini } 3172f0c9fe6SPaolo Bonzini 318aeae883bSPaolo Bonzini void block_job_complete(BlockJob *job, Error **errp) 319aeae883bSPaolo Bonzini { 320751ebd76SFam Zheng if (job->pause_count || job->cancelled || !job->driver->complete) { 3219df229c3SAlberto Garcia error_setg(errp, "The active block job '%s' cannot be completed", 3229df229c3SAlberto Garcia job->id); 323aeae883bSPaolo Bonzini return; 324aeae883bSPaolo Bonzini } 325aeae883bSPaolo Bonzini 3263fc4b10aSFam Zheng job->driver->complete(job, errp); 327aeae883bSPaolo Bonzini } 328aeae883bSPaolo Bonzini 3298acc72a4SPaolo Bonzini void block_job_pause(BlockJob *job) 3302f0c9fe6SPaolo Bonzini { 331751ebd76SFam Zheng job->pause_count++; 3328acc72a4SPaolo Bonzini } 3338acc72a4SPaolo Bonzini 334a7f3b7ffSStefan Hajnoczi static bool block_job_should_pause(BlockJob *job) 3358acc72a4SPaolo Bonzini { 336751ebd76SFam Zheng return job->pause_count > 0; 3378acc72a4SPaolo Bonzini } 3388acc72a4SPaolo Bonzini 339fc9c0a9cSStefan Hajnoczi void coroutine_fn block_job_pause_point(BlockJob *job) 340fc9c0a9cSStefan Hajnoczi { 341fc9c0a9cSStefan Hajnoczi if (!block_job_should_pause(job)) { 342fc9c0a9cSStefan Hajnoczi return; 343fc9c0a9cSStefan Hajnoczi } 344fc9c0a9cSStefan Hajnoczi if (block_job_is_cancelled(job)) { 345fc9c0a9cSStefan Hajnoczi return; 346fc9c0a9cSStefan Hajnoczi } 347fc9c0a9cSStefan Hajnoczi 348fc9c0a9cSStefan Hajnoczi if (job->driver->pause) { 349fc9c0a9cSStefan Hajnoczi job->driver->pause(job); 350fc9c0a9cSStefan Hajnoczi } 351fc9c0a9cSStefan Hajnoczi 352fc9c0a9cSStefan Hajnoczi if (block_job_should_pause(job) && !block_job_is_cancelled(job)) { 353fc9c0a9cSStefan Hajnoczi job->paused = true; 354fc9c0a9cSStefan Hajnoczi job->busy = false; 355fc9c0a9cSStefan Hajnoczi qemu_coroutine_yield(); /* wait for block_job_resume() */ 356fc9c0a9cSStefan Hajnoczi job->busy = true; 357fc9c0a9cSStefan Hajnoczi job->paused = false; 358fc9c0a9cSStefan Hajnoczi } 359fc9c0a9cSStefan Hajnoczi 360fc9c0a9cSStefan Hajnoczi if (job->driver->resume) { 361fc9c0a9cSStefan Hajnoczi job->driver->resume(job); 362fc9c0a9cSStefan Hajnoczi } 363fc9c0a9cSStefan Hajnoczi } 364fc9c0a9cSStefan Hajnoczi 3658acc72a4SPaolo Bonzini void block_job_resume(BlockJob *job) 3668acc72a4SPaolo Bonzini { 367751ebd76SFam Zheng assert(job->pause_count > 0); 368751ebd76SFam Zheng job->pause_count--; 369751ebd76SFam Zheng if (job->pause_count) { 370751ebd76SFam Zheng return; 371751ebd76SFam Zheng } 372751ebd76SFam Zheng block_job_enter(job); 373751ebd76SFam Zheng } 374751ebd76SFam Zheng 375751ebd76SFam Zheng void block_job_enter(BlockJob *job) 376751ebd76SFam Zheng { 3772f0c9fe6SPaolo Bonzini if (job->co && !job->busy) { 3780b8b8753SPaolo Bonzini qemu_coroutine_enter(job->co); 3792f0c9fe6SPaolo Bonzini } 3802f0c9fe6SPaolo Bonzini } 3812f0c9fe6SPaolo Bonzini 3828acc72a4SPaolo Bonzini void block_job_cancel(BlockJob *job) 3838acc72a4SPaolo Bonzini { 3848acc72a4SPaolo Bonzini job->cancelled = true; 38517bd51f9SStefan Hajnoczi block_job_iostatus_reset(job); 386751ebd76SFam Zheng block_job_enter(job); 3878acc72a4SPaolo Bonzini } 3888acc72a4SPaolo Bonzini 3892f0c9fe6SPaolo Bonzini bool block_job_is_cancelled(BlockJob *job) 3902f0c9fe6SPaolo Bonzini { 3912f0c9fe6SPaolo Bonzini return job->cancelled; 3922f0c9fe6SPaolo Bonzini } 3932f0c9fe6SPaolo Bonzini 39432c81a4aSPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 39532c81a4aSPaolo Bonzini { 39632c81a4aSPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 3973fc4b10aSFam Zheng if (job->driver->iostatus_reset) { 3983fc4b10aSFam Zheng job->driver->iostatus_reset(job); 3993bd293c3SPaolo Bonzini } 40032c81a4aSPaolo Bonzini } 40132c81a4aSPaolo Bonzini 402345f9e1bSMax Reitz static int block_job_finish_sync(BlockJob *job, 403345f9e1bSMax Reitz void (*finish)(BlockJob *, Error **errp), 404345f9e1bSMax Reitz Error **errp) 4052f0c9fe6SPaolo Bonzini { 406345f9e1bSMax Reitz Error *local_err = NULL; 40794db6d2dSFam Zheng int ret; 4082f0c9fe6SPaolo Bonzini 409b6d2e599SKevin Wolf assert(blk_bs(job->blk)->job == job); 4102f0c9fe6SPaolo Bonzini 41194db6d2dSFam Zheng block_job_ref(job); 412345f9e1bSMax Reitz finish(job, &local_err); 413345f9e1bSMax Reitz if (local_err) { 414345f9e1bSMax Reitz error_propagate(errp, local_err); 41594db6d2dSFam Zheng block_job_unref(job); 416345f9e1bSMax Reitz return -EBUSY; 417345f9e1bSMax Reitz } 41894db6d2dSFam Zheng while (!job->completed) { 4199f6bc648SStefan Hajnoczi aio_poll(block_job_get_aio_context(job), true); 4202f0c9fe6SPaolo Bonzini } 42194db6d2dSFam Zheng ret = (job->cancelled && job->ret == 0) ? -ECANCELED : job->ret; 42294db6d2dSFam Zheng block_job_unref(job); 42394db6d2dSFam Zheng return ret; 4242f0c9fe6SPaolo Bonzini } 4252f0c9fe6SPaolo Bonzini 426345f9e1bSMax Reitz /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be 427345f9e1bSMax Reitz * used with block_job_finish_sync() without the need for (rather nasty) 428345f9e1bSMax Reitz * function pointer casts there. */ 429345f9e1bSMax Reitz static void block_job_cancel_err(BlockJob *job, Error **errp) 430345f9e1bSMax Reitz { 431345f9e1bSMax Reitz block_job_cancel(job); 432345f9e1bSMax Reitz } 433345f9e1bSMax Reitz 434345f9e1bSMax Reitz int block_job_cancel_sync(BlockJob *job) 435345f9e1bSMax Reitz { 436345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_cancel_err, NULL); 437345f9e1bSMax Reitz } 438345f9e1bSMax Reitz 439a1a2af07SKevin Wolf void block_job_cancel_sync_all(void) 440a1a2af07SKevin Wolf { 441a1a2af07SKevin Wolf BlockJob *job; 442a1a2af07SKevin Wolf AioContext *aio_context; 443a1a2af07SKevin Wolf 444a1a2af07SKevin Wolf while ((job = QLIST_FIRST(&block_jobs))) { 445b6d2e599SKevin Wolf aio_context = blk_get_aio_context(job->blk); 446a1a2af07SKevin Wolf aio_context_acquire(aio_context); 447a1a2af07SKevin Wolf block_job_cancel_sync(job); 448a1a2af07SKevin Wolf aio_context_release(aio_context); 449a1a2af07SKevin Wolf } 450a1a2af07SKevin Wolf } 451a1a2af07SKevin Wolf 452345f9e1bSMax Reitz int block_job_complete_sync(BlockJob *job, Error **errp) 453345f9e1bSMax Reitz { 454345f9e1bSMax Reitz return block_job_finish_sync(job, &block_job_complete, errp); 455345f9e1bSMax Reitz } 456345f9e1bSMax Reitz 4577483d1e5SAlex Bligh void block_job_sleep_ns(BlockJob *job, QEMUClockType type, int64_t ns) 4582f0c9fe6SPaolo Bonzini { 4598acc72a4SPaolo Bonzini assert(job->busy); 4608acc72a4SPaolo Bonzini 4612f0c9fe6SPaolo Bonzini /* Check cancellation *before* setting busy = false, too! */ 4628acc72a4SPaolo Bonzini if (block_job_is_cancelled(job)) { 4638acc72a4SPaolo Bonzini return; 4642f0c9fe6SPaolo Bonzini } 4658acc72a4SPaolo Bonzini 4668acc72a4SPaolo Bonzini job->busy = false; 467a7f3b7ffSStefan Hajnoczi if (!block_job_should_pause(job)) { 4680824afdaSAlberto Garcia co_aio_sleep_ns(blk_get_aio_context(job->blk), type, ns); 4690824afdaSAlberto Garcia } 4708acc72a4SPaolo Bonzini job->busy = true; 471fc9c0a9cSStefan Hajnoczi 472fc9c0a9cSStefan Hajnoczi block_job_pause_point(job); 4732f0c9fe6SPaolo Bonzini } 47430e628b7SPaolo Bonzini 475dc71ce45SFam Zheng void block_job_yield(BlockJob *job) 476dc71ce45SFam Zheng { 477dc71ce45SFam Zheng assert(job->busy); 478dc71ce45SFam Zheng 479dc71ce45SFam Zheng /* Check cancellation *before* setting busy = false, too! */ 480dc71ce45SFam Zheng if (block_job_is_cancelled(job)) { 481dc71ce45SFam Zheng return; 482dc71ce45SFam Zheng } 483dc71ce45SFam Zheng 484dc71ce45SFam Zheng job->busy = false; 485fc9c0a9cSStefan Hajnoczi if (!block_job_should_pause(job)) { 486dc71ce45SFam Zheng qemu_coroutine_yield(); 487fc9c0a9cSStefan Hajnoczi } 488dc71ce45SFam Zheng job->busy = true; 489fc9c0a9cSStefan Hajnoczi 490fc9c0a9cSStefan Hajnoczi block_job_pause_point(job); 491dc71ce45SFam Zheng } 492dc71ce45SFam Zheng 49330e628b7SPaolo Bonzini BlockJobInfo *block_job_query(BlockJob *job) 49430e628b7SPaolo Bonzini { 49530e628b7SPaolo Bonzini BlockJobInfo *info = g_new0(BlockJobInfo, 1); 49679e14bf7SFam Zheng info->type = g_strdup(BlockJobType_lookup[job->driver->job_type]); 4978ccb9569SKevin Wolf info->device = g_strdup(job->id); 49830e628b7SPaolo Bonzini info->len = job->len; 4998d65883fSPaolo Bonzini info->busy = job->busy; 500751ebd76SFam Zheng info->paused = job->pause_count > 0; 50130e628b7SPaolo Bonzini info->offset = job->offset; 50230e628b7SPaolo Bonzini info->speed = job->speed; 50332c81a4aSPaolo Bonzini info->io_status = job->iostatus; 504ef6dbf1eSMax Reitz info->ready = job->ready; 50530e628b7SPaolo Bonzini return info; 50630e628b7SPaolo Bonzini } 50732c81a4aSPaolo Bonzini 50832c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 50932c81a4aSPaolo Bonzini { 51032c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 51132c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 51232c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 51332c81a4aSPaolo Bonzini } 51432c81a4aSPaolo Bonzini } 51532c81a4aSPaolo Bonzini 516bcada37bSWenchao Xia void block_job_event_cancelled(BlockJob *job) 517a66a2a36SPaolo Bonzini { 518bcada37bSWenchao Xia qapi_event_send_block_job_cancelled(job->driver->job_type, 5198ccb9569SKevin Wolf job->id, 520a66a2a36SPaolo Bonzini job->len, 521a66a2a36SPaolo Bonzini job->offset, 522bcada37bSWenchao Xia job->speed, 523bcada37bSWenchao Xia &error_abort); 524a66a2a36SPaolo Bonzini } 525a66a2a36SPaolo Bonzini 526bcada37bSWenchao Xia void block_job_event_completed(BlockJob *job, const char *msg) 527a66a2a36SPaolo Bonzini { 528bcada37bSWenchao Xia qapi_event_send_block_job_completed(job->driver->job_type, 5298ccb9569SKevin Wolf job->id, 530bcada37bSWenchao Xia job->len, 531bcada37bSWenchao Xia job->offset, 532bcada37bSWenchao Xia job->speed, 533bcada37bSWenchao Xia !!msg, 534bcada37bSWenchao Xia msg, 535bcada37bSWenchao Xia &error_abort); 536bcada37bSWenchao Xia } 537bcada37bSWenchao Xia 538bcada37bSWenchao Xia void block_job_event_ready(BlockJob *job) 539bcada37bSWenchao Xia { 540ef6dbf1eSMax Reitz job->ready = true; 541ef6dbf1eSMax Reitz 542518848a2SMarkus Armbruster qapi_event_send_block_job_ready(job->driver->job_type, 5438ccb9569SKevin Wolf job->id, 544518848a2SMarkus Armbruster job->len, 545518848a2SMarkus Armbruster job->offset, 546518848a2SMarkus Armbruster job->speed, &error_abort); 547a66a2a36SPaolo Bonzini } 548a66a2a36SPaolo Bonzini 54981e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 55032c81a4aSPaolo Bonzini int is_read, int error) 55132c81a4aSPaolo Bonzini { 55232c81a4aSPaolo Bonzini BlockErrorAction action; 55332c81a4aSPaolo Bonzini 55432c81a4aSPaolo Bonzini switch (on_err) { 55532c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 556*8c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 557a589569fSWenchao Xia action = (error == ENOSPC) ? 558a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 55932c81a4aSPaolo Bonzini break; 56032c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 561a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 56232c81a4aSPaolo Bonzini break; 56332c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 564a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 56532c81a4aSPaolo Bonzini break; 56632c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 567a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 56832c81a4aSPaolo Bonzini break; 56932c81a4aSPaolo Bonzini default: 57032c81a4aSPaolo Bonzini abort(); 57132c81a4aSPaolo Bonzini } 5728ccb9569SKevin Wolf qapi_event_send_block_job_error(job->id, 5735a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 5745a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 5755a2d2cbdSWenchao Xia action, &error_abort); 576a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 577751ebd76SFam Zheng /* make the pause user visible, which will be resumed from QMP. */ 578751ebd76SFam Zheng job->user_paused = true; 57932c81a4aSPaolo Bonzini block_job_pause(job); 58032c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 58132c81a4aSPaolo Bonzini } 58232c81a4aSPaolo Bonzini return action; 58332c81a4aSPaolo Bonzini } 584dec7d421SStefan Hajnoczi 585dec7d421SStefan Hajnoczi typedef struct { 586dec7d421SStefan Hajnoczi BlockJob *job; 587dec7d421SStefan Hajnoczi QEMUBH *bh; 588dec7d421SStefan Hajnoczi AioContext *aio_context; 589dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopFn *fn; 590dec7d421SStefan Hajnoczi void *opaque; 591dec7d421SStefan Hajnoczi } BlockJobDeferToMainLoopData; 592dec7d421SStefan Hajnoczi 593dec7d421SStefan Hajnoczi static void block_job_defer_to_main_loop_bh(void *opaque) 594dec7d421SStefan Hajnoczi { 595dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopData *data = opaque; 596dec7d421SStefan Hajnoczi AioContext *aio_context; 597dec7d421SStefan Hajnoczi 598dec7d421SStefan Hajnoczi qemu_bh_delete(data->bh); 599dec7d421SStefan Hajnoczi 600dec7d421SStefan Hajnoczi /* Prevent race with block_job_defer_to_main_loop() */ 601dec7d421SStefan Hajnoczi aio_context_acquire(data->aio_context); 602dec7d421SStefan Hajnoczi 603dec7d421SStefan Hajnoczi /* Fetch BDS AioContext again, in case it has changed */ 604b6d2e599SKevin Wolf aio_context = blk_get_aio_context(data->job->blk); 605dec7d421SStefan Hajnoczi aio_context_acquire(aio_context); 606dec7d421SStefan Hajnoczi 607794f0141SFam Zheng data->job->deferred_to_main_loop = false; 608dec7d421SStefan Hajnoczi data->fn(data->job, data->opaque); 609dec7d421SStefan Hajnoczi 610dec7d421SStefan Hajnoczi aio_context_release(aio_context); 611dec7d421SStefan Hajnoczi 612dec7d421SStefan Hajnoczi aio_context_release(data->aio_context); 613dec7d421SStefan Hajnoczi 614dec7d421SStefan Hajnoczi g_free(data); 615dec7d421SStefan Hajnoczi } 616dec7d421SStefan Hajnoczi 617dec7d421SStefan Hajnoczi void block_job_defer_to_main_loop(BlockJob *job, 618dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopFn *fn, 619dec7d421SStefan Hajnoczi void *opaque) 620dec7d421SStefan Hajnoczi { 621dec7d421SStefan Hajnoczi BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data)); 622dec7d421SStefan Hajnoczi data->job = job; 623dec7d421SStefan Hajnoczi data->bh = qemu_bh_new(block_job_defer_to_main_loop_bh, data); 624b6d2e599SKevin Wolf data->aio_context = blk_get_aio_context(job->blk); 625dec7d421SStefan Hajnoczi data->fn = fn; 626dec7d421SStefan Hajnoczi data->opaque = opaque; 627794f0141SFam Zheng job->deferred_to_main_loop = true; 628dec7d421SStefan Hajnoczi 629dec7d421SStefan Hajnoczi qemu_bh_schedule(data->bh); 630dec7d421SStefan Hajnoczi } 631c55a832fSFam Zheng 632c55a832fSFam Zheng BlockJobTxn *block_job_txn_new(void) 633c55a832fSFam Zheng { 634c55a832fSFam Zheng BlockJobTxn *txn = g_new0(BlockJobTxn, 1); 635c55a832fSFam Zheng QLIST_INIT(&txn->jobs); 636c55a832fSFam Zheng txn->refcnt = 1; 637c55a832fSFam Zheng return txn; 638c55a832fSFam Zheng } 639c55a832fSFam Zheng 640c55a832fSFam Zheng static void block_job_txn_ref(BlockJobTxn *txn) 641c55a832fSFam Zheng { 642c55a832fSFam Zheng txn->refcnt++; 643c55a832fSFam Zheng } 644c55a832fSFam Zheng 645c55a832fSFam Zheng void block_job_txn_unref(BlockJobTxn *txn) 646c55a832fSFam Zheng { 647c55a832fSFam Zheng if (txn && --txn->refcnt == 0) { 648c55a832fSFam Zheng g_free(txn); 649c55a832fSFam Zheng } 650c55a832fSFam Zheng } 651c55a832fSFam Zheng 652c55a832fSFam Zheng void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job) 653c55a832fSFam Zheng { 654c55a832fSFam Zheng if (!txn) { 655c55a832fSFam Zheng return; 656c55a832fSFam Zheng } 657c55a832fSFam Zheng 658c55a832fSFam Zheng assert(!job->txn); 659c55a832fSFam Zheng job->txn = txn; 660c55a832fSFam Zheng 661c55a832fSFam Zheng QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); 662c55a832fSFam Zheng block_job_txn_ref(txn); 663c55a832fSFam Zheng } 664