12f0c9fe6SPaolo Bonzini /* 22f0c9fe6SPaolo Bonzini * QEMU System Emulator block driver 32f0c9fe6SPaolo Bonzini * 42f0c9fe6SPaolo Bonzini * Copyright (c) 2011 IBM Corp. 52f0c9fe6SPaolo Bonzini * Copyright (c) 2012 Red Hat, Inc. 62f0c9fe6SPaolo Bonzini * 72f0c9fe6SPaolo Bonzini * Permission is hereby granted, free of charge, to any person obtaining a copy 82f0c9fe6SPaolo Bonzini * of this software and associated documentation files (the "Software"), to deal 92f0c9fe6SPaolo Bonzini * in the Software without restriction, including without limitation the rights 102f0c9fe6SPaolo Bonzini * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 112f0c9fe6SPaolo Bonzini * copies of the Software, and to permit persons to whom the Software is 122f0c9fe6SPaolo Bonzini * furnished to do so, subject to the following conditions: 132f0c9fe6SPaolo Bonzini * 142f0c9fe6SPaolo Bonzini * The above copyright notice and this permission notice shall be included in 152f0c9fe6SPaolo Bonzini * all copies or substantial portions of the Software. 162f0c9fe6SPaolo Bonzini * 172f0c9fe6SPaolo Bonzini * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 182f0c9fe6SPaolo Bonzini * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 192f0c9fe6SPaolo Bonzini * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 202f0c9fe6SPaolo Bonzini * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 212f0c9fe6SPaolo Bonzini * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 222f0c9fe6SPaolo Bonzini * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 232f0c9fe6SPaolo Bonzini * THE SOFTWARE. 242f0c9fe6SPaolo Bonzini */ 252f0c9fe6SPaolo Bonzini 26d38ea87aSPeter Maydell #include "qemu/osdep.h" 272f0c9fe6SPaolo Bonzini #include "qemu-common.h" 28737e150eSPaolo Bonzini #include "block/block.h" 29c87621eaSJohn Snow #include "block/blockjob_int.h" 30737e150eSPaolo Bonzini #include "block/block_int.h" 31c9de4050SJohn Snow #include "block/trace.h" 32373340b2SMax Reitz #include "sysemu/block-backend.h" 33e688df6bSMarkus Armbruster #include "qapi/error.h" 349af23989SMarkus Armbruster #include "qapi/qapi-events-block-core.h" 35cc7a8ea7SMarkus Armbruster #include "qapi/qmp/qerror.h" 3610817bf0SDaniel P. Berrange #include "qemu/coroutine.h" 371de7afc9SPaolo Bonzini #include "qemu/timer.h" 382f0c9fe6SPaolo Bonzini 3988691b37SPaolo Bonzini /* 4088691b37SPaolo Bonzini * The block job API is composed of two categories of functions. 4188691b37SPaolo Bonzini * 4288691b37SPaolo Bonzini * The first includes functions used by the monitor. The monitor is 4388691b37SPaolo Bonzini * peculiar in that it accesses the block job list with block_job_get, and 4488691b37SPaolo Bonzini * therefore needs consistency across block_job_get and the actual operation 4588691b37SPaolo Bonzini * (e.g. block_job_set_speed). The consistency is achieved with 4688691b37SPaolo Bonzini * aio_context_acquire/release. These functions are declared in blockjob.h. 4788691b37SPaolo Bonzini * 4888691b37SPaolo Bonzini * The second includes functions used by the block job drivers and sometimes 4988691b37SPaolo Bonzini * by the core block layer. These do not care about locking, because the 5088691b37SPaolo Bonzini * whole coroutine runs under the AioContext lock, and are declared in 5188691b37SPaolo Bonzini * blockjob_int.h. 5288691b37SPaolo Bonzini */ 5388691b37SPaolo Bonzini 54e7c1d78bSKevin Wolf static bool is_block_job(Job *job) 55a7112795SAlberto Garcia { 56e7c1d78bSKevin Wolf return job_type(job) == JOB_TYPE_BACKUP || 57e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_COMMIT || 58e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_MIRROR || 59e7c1d78bSKevin Wolf job_type(job) == JOB_TYPE_STREAM; 60a7112795SAlberto Garcia } 61e7c1d78bSKevin Wolf 62e7c1d78bSKevin Wolf BlockJob *block_job_next(BlockJob *bjob) 63e7c1d78bSKevin Wolf { 64e7c1d78bSKevin Wolf Job *job = bjob ? &bjob->job : NULL; 65e7c1d78bSKevin Wolf 66e7c1d78bSKevin Wolf do { 67e7c1d78bSKevin Wolf job = job_next(job); 68e7c1d78bSKevin Wolf } while (job && !is_block_job(job)); 69e7c1d78bSKevin Wolf 70e7c1d78bSKevin Wolf return job ? container_of(job, BlockJob, job) : NULL; 71a7112795SAlberto Garcia } 72a7112795SAlberto Garcia 73ffb1f10cSAlberto Garcia BlockJob *block_job_get(const char *id) 74ffb1f10cSAlberto Garcia { 75e7c1d78bSKevin Wolf Job *job = job_get(id); 76ffb1f10cSAlberto Garcia 77e7c1d78bSKevin Wolf if (job && is_block_job(job)) { 78e7c1d78bSKevin Wolf return container_of(job, BlockJob, job); 79e7c1d78bSKevin Wolf } else { 80ffb1f10cSAlberto Garcia return NULL; 81ffb1f10cSAlberto Garcia } 82e7c1d78bSKevin Wolf } 83ffb1f10cSAlberto Garcia 8405b0d8e3SPaolo Bonzini static void block_job_attached_aio_context(AioContext *new_context, 8505b0d8e3SPaolo Bonzini void *opaque); 8605b0d8e3SPaolo Bonzini static void block_job_detach_aio_context(void *opaque); 8705b0d8e3SPaolo Bonzini 8880fa2c75SKevin Wolf void block_job_free(Job *job) 8905b0d8e3SPaolo Bonzini { 9080fa2c75SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 9180fa2c75SKevin Wolf BlockDriverState *bs = blk_bs(bjob->blk); 9280fa2c75SKevin Wolf 9305b0d8e3SPaolo Bonzini bs->job = NULL; 9480fa2c75SKevin Wolf block_job_remove_all_bdrv(bjob); 9580fa2c75SKevin Wolf blk_remove_aio_context_notifier(bjob->blk, 9605b0d8e3SPaolo Bonzini block_job_attached_aio_context, 9780fa2c75SKevin Wolf block_job_detach_aio_context, bjob); 9880fa2c75SKevin Wolf blk_unref(bjob->blk); 9980fa2c75SKevin Wolf error_free(bjob->blocker); 10005b0d8e3SPaolo Bonzini } 10105b0d8e3SPaolo Bonzini 102463e0be1SStefan Hajnoczi static void block_job_attached_aio_context(AioContext *new_context, 103463e0be1SStefan Hajnoczi void *opaque) 104463e0be1SStefan Hajnoczi { 105463e0be1SStefan Hajnoczi BlockJob *job = opaque; 1069f6bb4c0SKevin Wolf const JobDriver *drv = job->job.driver; 1079f6bb4c0SKevin Wolf BlockJobDriver *bjdrv = container_of(drv, BlockJobDriver, job_driver); 108463e0be1SStefan Hajnoczi 10908be6fe2SKevin Wolf job->job.aio_context = new_context; 1109f6bb4c0SKevin Wolf if (bjdrv->attached_aio_context) { 1119f6bb4c0SKevin Wolf bjdrv->attached_aio_context(job, new_context); 112463e0be1SStefan Hajnoczi } 113463e0be1SStefan Hajnoczi 114b15de828SKevin Wolf job_resume(&job->job); 115463e0be1SStefan Hajnoczi } 116463e0be1SStefan Hajnoczi 117b69f777dSKevin Wolf void block_job_drain(Job *job) 118bae8196dSPaolo Bonzini { 119b69f777dSKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 1209f6bb4c0SKevin Wolf const JobDriver *drv = job->driver; 1219f6bb4c0SKevin Wolf BlockJobDriver *bjdrv = container_of(drv, BlockJobDriver, job_driver); 122bae8196dSPaolo Bonzini 123b69f777dSKevin Wolf blk_drain(bjob->blk); 1249f6bb4c0SKevin Wolf if (bjdrv->drain) { 1259f6bb4c0SKevin Wolf bjdrv->drain(bjob); 126bae8196dSPaolo Bonzini } 127bae8196dSPaolo Bonzini } 128bae8196dSPaolo Bonzini 129463e0be1SStefan Hajnoczi static void block_job_detach_aio_context(void *opaque) 130463e0be1SStefan Hajnoczi { 131463e0be1SStefan Hajnoczi BlockJob *job = opaque; 132463e0be1SStefan Hajnoczi 133463e0be1SStefan Hajnoczi /* In case the job terminates during aio_poll()... */ 13480fa2c75SKevin Wolf job_ref(&job->job); 135463e0be1SStefan Hajnoczi 136b15de828SKevin Wolf job_pause(&job->job); 137463e0be1SStefan Hajnoczi 138dbe5e6c1SKevin Wolf while (!job->job.paused && !job_is_completed(&job->job)) { 139b69f777dSKevin Wolf job_drain(&job->job); 140463e0be1SStefan Hajnoczi } 141463e0be1SStefan Hajnoczi 14208be6fe2SKevin Wolf job->job.aio_context = NULL; 14380fa2c75SKevin Wolf job_unref(&job->job); 144463e0be1SStefan Hajnoczi } 145463e0be1SStefan Hajnoczi 146f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c) 147f321dcb5SPaolo Bonzini { 148f321dcb5SPaolo Bonzini BlockJob *job = c->opaque; 149252291eaSKevin Wolf return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); 150f321dcb5SPaolo Bonzini } 151f321dcb5SPaolo Bonzini 152ad90febaSKevin Wolf static void child_job_drained_begin(BdrvChild *c) 153f321dcb5SPaolo Bonzini { 154ad90febaSKevin Wolf BlockJob *job = c->opaque; 155b15de828SKevin Wolf job_pause(&job->job); 156f321dcb5SPaolo Bonzini } 157f321dcb5SPaolo Bonzini 15889bd0305SKevin Wolf static bool child_job_drained_poll(BdrvChild *c) 15989bd0305SKevin Wolf { 16089bd0305SKevin Wolf BlockJob *bjob = c->opaque; 16189bd0305SKevin Wolf Job *job = &bjob->job; 16289bd0305SKevin Wolf const BlockJobDriver *drv = block_job_driver(bjob); 16389bd0305SKevin Wolf 16489bd0305SKevin Wolf /* An inactive or completed job doesn't have any pending requests. Jobs 16589bd0305SKevin Wolf * with !job->busy are either already paused or have a pause point after 16689bd0305SKevin Wolf * being reentered, so no job driver code will run before they pause. */ 16789bd0305SKevin Wolf if (!job->busy || job_is_completed(job) || job->deferred_to_main_loop) { 16889bd0305SKevin Wolf return false; 16989bd0305SKevin Wolf } 17089bd0305SKevin Wolf 17189bd0305SKevin Wolf /* Otherwise, assume that it isn't fully stopped yet, but allow the job to 17289bd0305SKevin Wolf * override this assumption. */ 17389bd0305SKevin Wolf if (drv->drained_poll) { 17489bd0305SKevin Wolf return drv->drained_poll(bjob); 17589bd0305SKevin Wolf } else { 17689bd0305SKevin Wolf return true; 17789bd0305SKevin Wolf } 17889bd0305SKevin Wolf } 17989bd0305SKevin Wolf 180ad90febaSKevin Wolf static void child_job_drained_end(BdrvChild *c) 181f321dcb5SPaolo Bonzini { 182ad90febaSKevin Wolf BlockJob *job = c->opaque; 183b15de828SKevin Wolf job_resume(&job->job); 184f321dcb5SPaolo Bonzini } 185f321dcb5SPaolo Bonzini 186ad90febaSKevin Wolf static const BdrvChildRole child_job = { 187ad90febaSKevin Wolf .get_parent_desc = child_job_get_parent_desc, 188ad90febaSKevin Wolf .drained_begin = child_job_drained_begin, 18989bd0305SKevin Wolf .drained_poll = child_job_drained_poll, 190ad90febaSKevin Wolf .drained_end = child_job_drained_end, 191ad90febaSKevin Wolf .stay_at_node = true, 192f321dcb5SPaolo Bonzini }; 193f321dcb5SPaolo Bonzini 194bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job) 195bbc02b90SKevin Wolf { 196bbc02b90SKevin Wolf GSList *l; 197bbc02b90SKevin Wolf for (l = job->nodes; l; l = l->next) { 198bbc02b90SKevin Wolf BdrvChild *c = l->data; 199bbc02b90SKevin Wolf bdrv_op_unblock_all(c->bs, job->blocker); 200bbc02b90SKevin Wolf bdrv_root_unref_child(c); 201bbc02b90SKevin Wolf } 202bbc02b90SKevin Wolf g_slist_free(job->nodes); 203bbc02b90SKevin Wolf job->nodes = NULL; 204bbc02b90SKevin Wolf } 205bbc02b90SKevin Wolf 20676d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 20776d554e2SKevin Wolf uint64_t perm, uint64_t shared_perm, Error **errp) 20823d402d4SAlberto Garcia { 20976d554e2SKevin Wolf BdrvChild *c; 21076d554e2SKevin Wolf 21176d554e2SKevin Wolf c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm, 21276d554e2SKevin Wolf job, errp); 21376d554e2SKevin Wolf if (c == NULL) { 21476d554e2SKevin Wolf return -EPERM; 21576d554e2SKevin Wolf } 21676d554e2SKevin Wolf 21776d554e2SKevin Wolf job->nodes = g_slist_prepend(job->nodes, c); 21823d402d4SAlberto Garcia bdrv_ref(bs); 21923d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 22076d554e2SKevin Wolf 22176d554e2SKevin Wolf return 0; 22223d402d4SAlberto Garcia } 22323d402d4SAlberto Garcia 224*34dc97b9SKevin Wolf void block_job_wakeup_all_bdrv(BlockJob *job) 225*34dc97b9SKevin Wolf { 226*34dc97b9SKevin Wolf GSList *l; 227*34dc97b9SKevin Wolf 228*34dc97b9SKevin Wolf for (l = job->nodes; l; l = l->next) { 229*34dc97b9SKevin Wolf BdrvChild *c = l->data; 230*34dc97b9SKevin Wolf bdrv_wakeup(c->bs); 231*34dc97b9SKevin Wolf } 232*34dc97b9SKevin Wolf } 233*34dc97b9SKevin Wolf 234*34dc97b9SKevin Wolf static void block_job_on_idle(Notifier *n, void *opaque) 235*34dc97b9SKevin Wolf { 236*34dc97b9SKevin Wolf BlockJob *job = opaque; 237*34dc97b9SKevin Wolf block_job_wakeup_all_bdrv(job); 238*34dc97b9SKevin Wolf } 239*34dc97b9SKevin Wolf 240559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 241559b935fSJohn Snow { 24233e9e9bdSKevin Wolf return (job->job.id == NULL); 243559b935fSJohn Snow } 244559b935fSJohn Snow 245bd21935bSKevin Wolf const BlockJobDriver *block_job_driver(BlockJob *job) 246bd21935bSKevin Wolf { 2479f6bb4c0SKevin Wolf return container_of(job->job.driver, BlockJobDriver, job_driver); 248bd21935bSKevin Wolf } 249bd21935bSKevin Wolf 250da01ff7fSKevin Wolf /* Assumes the job_mutex is held */ 251da01ff7fSKevin Wolf static bool job_timer_pending(Job *job) 252da01ff7fSKevin Wolf { 253da01ff7fSKevin Wolf return timer_pending(&job->sleep_timer); 254da01ff7fSKevin Wolf } 255da01ff7fSKevin Wolf 2562f0c9fe6SPaolo Bonzini void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 2572f0c9fe6SPaolo Bonzini { 258aa9ef2e6SJohn Snow int64_t old_speed = job->speed; 2592f0c9fe6SPaolo Bonzini 260a50c2ab8SKevin Wolf if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp)) { 2610ec4dfb8SJohn Snow return; 2620ec4dfb8SJohn Snow } 26318bb6928SKevin Wolf if (speed < 0) { 26418bb6928SKevin Wolf error_setg(errp, QERR_INVALID_PARAMETER, "speed"); 2652f0c9fe6SPaolo Bonzini return; 2662f0c9fe6SPaolo Bonzini } 2672f0c9fe6SPaolo Bonzini 26818bb6928SKevin Wolf ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); 26918bb6928SKevin Wolf 2702f0c9fe6SPaolo Bonzini job->speed = speed; 271d4fce188SJohn Snow if (speed && speed <= old_speed) { 272aa9ef2e6SJohn Snow return; 273aa9ef2e6SJohn Snow } 274aa9ef2e6SJohn Snow 275aa9ef2e6SJohn Snow /* kick only if a timer is pending */ 276da01ff7fSKevin Wolf job_enter_cond(&job->job, job_timer_pending); 2772f0c9fe6SPaolo Bonzini } 2782f0c9fe6SPaolo Bonzini 279dee81d51SKevin Wolf int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) 280dee81d51SKevin Wolf { 281dee81d51SKevin Wolf if (!job->speed) { 282dee81d51SKevin Wolf return 0; 283dee81d51SKevin Wolf } 284dee81d51SKevin Wolf 285dee81d51SKevin Wolf return ratelimit_calculate_delay(&job->limit, n); 286dee81d51SKevin Wolf } 287dee81d51SKevin Wolf 288559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp) 28930e628b7SPaolo Bonzini { 290559b935fSJohn Snow BlockJobInfo *info; 291559b935fSJohn Snow 292559b935fSJohn Snow if (block_job_is_internal(job)) { 293559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 294559b935fSJohn Snow return NULL; 295559b935fSJohn Snow } 296559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 297252291eaSKevin Wolf info->type = g_strdup(job_type_str(&job->job)); 29833e9e9bdSKevin Wolf info->device = g_strdup(job->job.id); 299da01ff7fSKevin Wolf info->busy = atomic_read(&job->job.busy); 300da01ff7fSKevin Wolf info->paused = job->job.pause_count > 0; 30130a5c887SKevin Wolf info->offset = job->job.progress_current; 30230a5c887SKevin Wolf info->len = job->job.progress_total; 30330e628b7SPaolo Bonzini info->speed = job->speed; 30432c81a4aSPaolo Bonzini info->io_status = job->iostatus; 305df956ae2SKevin Wolf info->ready = job_is_ready(&job->job), 306a50c2ab8SKevin Wolf info->status = job->job.status; 307bb02b65cSKevin Wolf info->auto_finalize = job->job.auto_finalize; 308bb02b65cSKevin Wolf info->auto_dismiss = job->job.auto_dismiss; 3094ad35181SKevin Wolf info->has_error = job->job.ret != 0; 3104ad35181SKevin Wolf info->error = job->job.ret ? g_strdup(strerror(-job->job.ret)) : NULL; 31130e628b7SPaolo Bonzini return info; 31230e628b7SPaolo Bonzini } 31332c81a4aSPaolo Bonzini 31432c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 31532c81a4aSPaolo Bonzini { 31632c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 31732c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 31832c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 31932c81a4aSPaolo Bonzini } 32032c81a4aSPaolo Bonzini } 32132c81a4aSPaolo Bonzini 322139a9f02SKevin Wolf static void block_job_event_cancelled(Notifier *n, void *opaque) 323a66a2a36SPaolo Bonzini { 324139a9f02SKevin Wolf BlockJob *job = opaque; 325139a9f02SKevin Wolf 326559b935fSJohn Snow if (block_job_is_internal(job)) { 327559b935fSJohn Snow return; 328559b935fSJohn Snow } 329559b935fSJohn Snow 330252291eaSKevin Wolf qapi_event_send_block_job_cancelled(job_type(&job->job), 33133e9e9bdSKevin Wolf job->job.id, 33230a5c887SKevin Wolf job->job.progress_total, 33330a5c887SKevin Wolf job->job.progress_current, 3343ab72385SPeter Xu job->speed); 335a66a2a36SPaolo Bonzini } 336a66a2a36SPaolo Bonzini 337139a9f02SKevin Wolf static void block_job_event_completed(Notifier *n, void *opaque) 338a66a2a36SPaolo Bonzini { 339139a9f02SKevin Wolf BlockJob *job = opaque; 340139a9f02SKevin Wolf const char *msg = NULL; 341139a9f02SKevin Wolf 342559b935fSJohn Snow if (block_job_is_internal(job)) { 343559b935fSJohn Snow return; 344559b935fSJohn Snow } 345559b935fSJohn Snow 3464ad35181SKevin Wolf if (job->job.ret < 0) { 3474ad35181SKevin Wolf msg = strerror(-job->job.ret); 348139a9f02SKevin Wolf } 349139a9f02SKevin Wolf 350252291eaSKevin Wolf qapi_event_send_block_job_completed(job_type(&job->job), 35133e9e9bdSKevin Wolf job->job.id, 35230a5c887SKevin Wolf job->job.progress_total, 35330a5c887SKevin Wolf job->job.progress_current, 354bcada37bSWenchao Xia job->speed, 355bcada37bSWenchao Xia !!msg, 3563ab72385SPeter Xu msg); 357bcada37bSWenchao Xia } 358bcada37bSWenchao Xia 359139a9f02SKevin Wolf static void block_job_event_pending(Notifier *n, void *opaque) 3605f241594SJohn Snow { 361139a9f02SKevin Wolf BlockJob *job = opaque; 362139a9f02SKevin Wolf 3635d4f3769SKevin Wolf if (block_job_is_internal(job)) { 3645d4f3769SKevin Wolf return; 3655d4f3769SKevin Wolf } 3665d4f3769SKevin Wolf 367252291eaSKevin Wolf qapi_event_send_block_job_pending(job_type(&job->job), 3683ab72385SPeter Xu job->job.id); 3695f241594SJohn Snow } 3705f241594SJohn Snow 3712e1795b5SKevin Wolf static void block_job_event_ready(Notifier *n, void *opaque) 3722e1795b5SKevin Wolf { 3732e1795b5SKevin Wolf BlockJob *job = opaque; 3742e1795b5SKevin Wolf 3752e1795b5SKevin Wolf if (block_job_is_internal(job)) { 3762e1795b5SKevin Wolf return; 3772e1795b5SKevin Wolf } 3782e1795b5SKevin Wolf 3792e1795b5SKevin Wolf qapi_event_send_block_job_ready(job_type(&job->job), 3802e1795b5SKevin Wolf job->job.id, 38130a5c887SKevin Wolf job->job.progress_total, 38230a5c887SKevin Wolf job->job.progress_current, 3833ab72385SPeter Xu job->speed); 3842e1795b5SKevin Wolf } 3852e1795b5SKevin Wolf 3862e1795b5SKevin Wolf 38788691b37SPaolo Bonzini /* 38888691b37SPaolo Bonzini * API for block job drivers and the block layer. These functions are 38988691b37SPaolo Bonzini * declared in blockjob_int.h. 39088691b37SPaolo Bonzini */ 39188691b37SPaolo Bonzini 39288691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver, 39362c9e416SKevin Wolf JobTxn *txn, BlockDriverState *bs, uint64_t perm, 39488691b37SPaolo Bonzini uint64_t shared_perm, int64_t speed, int flags, 39588691b37SPaolo Bonzini BlockCompletionFunc *cb, void *opaque, Error **errp) 39688691b37SPaolo Bonzini { 39788691b37SPaolo Bonzini BlockBackend *blk; 39888691b37SPaolo Bonzini BlockJob *job; 39988691b37SPaolo Bonzini int ret; 40088691b37SPaolo Bonzini 40188691b37SPaolo Bonzini if (bs->job) { 40288691b37SPaolo Bonzini error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); 40388691b37SPaolo Bonzini return NULL; 40488691b37SPaolo Bonzini } 40588691b37SPaolo Bonzini 406bb02b65cSKevin Wolf if (job_id == NULL && !(flags & JOB_INTERNAL)) { 40788691b37SPaolo Bonzini job_id = bdrv_get_device_name(bs); 40888691b37SPaolo Bonzini } 40988691b37SPaolo Bonzini 41088691b37SPaolo Bonzini blk = blk_new(perm, shared_perm); 41188691b37SPaolo Bonzini ret = blk_insert_bs(blk, bs, errp); 41288691b37SPaolo Bonzini if (ret < 0) { 41388691b37SPaolo Bonzini blk_unref(blk); 41488691b37SPaolo Bonzini return NULL; 41588691b37SPaolo Bonzini } 41688691b37SPaolo Bonzini 4177eaa8fb5SKevin Wolf job = job_create(job_id, &driver->job_driver, txn, blk_get_aio_context(blk), 4184ad35181SKevin Wolf flags, cb, opaque, errp); 41933e9e9bdSKevin Wolf if (job == NULL) { 42033e9e9bdSKevin Wolf blk_unref(blk); 42133e9e9bdSKevin Wolf return NULL; 42233e9e9bdSKevin Wolf } 42333e9e9bdSKevin Wolf 424e7c1d78bSKevin Wolf assert(is_block_job(&job->job)); 42580fa2c75SKevin Wolf assert(job->job.driver->free == &block_job_free); 426b15de828SKevin Wolf assert(job->job.driver->user_resume == &block_job_user_resume); 427b69f777dSKevin Wolf assert(job->job.driver->drain == &block_job_drain); 428e7c1d78bSKevin Wolf 42988691b37SPaolo Bonzini job->blk = blk; 43088691b37SPaolo Bonzini 431139a9f02SKevin Wolf job->finalize_cancelled_notifier.notify = block_job_event_cancelled; 432139a9f02SKevin Wolf job->finalize_completed_notifier.notify = block_job_event_completed; 433139a9f02SKevin Wolf job->pending_notifier.notify = block_job_event_pending; 4342e1795b5SKevin Wolf job->ready_notifier.notify = block_job_event_ready; 435*34dc97b9SKevin Wolf job->idle_notifier.notify = block_job_on_idle; 436139a9f02SKevin Wolf 437139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_cancelled, 438139a9f02SKevin Wolf &job->finalize_cancelled_notifier); 439139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_completed, 440139a9f02SKevin Wolf &job->finalize_completed_notifier); 441139a9f02SKevin Wolf notifier_list_add(&job->job.on_pending, &job->pending_notifier); 4422e1795b5SKevin Wolf notifier_list_add(&job->job.on_ready, &job->ready_notifier); 443*34dc97b9SKevin Wolf notifier_list_add(&job->job.on_idle, &job->idle_notifier); 444139a9f02SKevin Wolf 44588691b37SPaolo Bonzini error_setg(&job->blocker, "block device is in use by block job: %s", 446252291eaSKevin Wolf job_type_str(&job->job)); 44788691b37SPaolo Bonzini block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); 44888691b37SPaolo Bonzini bs->job = job; 44988691b37SPaolo Bonzini 45088691b37SPaolo Bonzini bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 45188691b37SPaolo Bonzini 45288691b37SPaolo Bonzini blk_add_aio_context_notifier(blk, block_job_attached_aio_context, 45388691b37SPaolo Bonzini block_job_detach_aio_context, job); 45488691b37SPaolo Bonzini 45588691b37SPaolo Bonzini /* Only set speed when necessary to avoid NotSupported error */ 45688691b37SPaolo Bonzini if (speed != 0) { 45788691b37SPaolo Bonzini Error *local_err = NULL; 45888691b37SPaolo Bonzini 45988691b37SPaolo Bonzini block_job_set_speed(job, speed, &local_err); 46088691b37SPaolo Bonzini if (local_err) { 4614ad35181SKevin Wolf job_early_fail(&job->job); 46288691b37SPaolo Bonzini error_propagate(errp, local_err); 46388691b37SPaolo Bonzini return NULL; 46488691b37SPaolo Bonzini } 46588691b37SPaolo Bonzini } 46675859b94SJohn Snow 46788691b37SPaolo Bonzini return job; 46888691b37SPaolo Bonzini } 46988691b37SPaolo Bonzini 4702caf63a9SPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 4712caf63a9SPaolo Bonzini { 4724c241cf5SPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 4734c241cf5SPaolo Bonzini return; 4744c241cf5SPaolo Bonzini } 475b15de828SKevin Wolf assert(job->job.user_paused && job->job.pause_count > 0); 4762caf63a9SPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 4772caf63a9SPaolo Bonzini } 4782caf63a9SPaolo Bonzini 479b15de828SKevin Wolf void block_job_user_resume(Job *job) 480b15de828SKevin Wolf { 481b15de828SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 482b15de828SKevin Wolf block_job_iostatus_reset(bjob); 483b15de828SKevin Wolf } 484b15de828SKevin Wolf 48581e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 48632c81a4aSPaolo Bonzini int is_read, int error) 48732c81a4aSPaolo Bonzini { 48832c81a4aSPaolo Bonzini BlockErrorAction action; 48932c81a4aSPaolo Bonzini 49032c81a4aSPaolo Bonzini switch (on_err) { 49132c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 4928c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 493a589569fSWenchao Xia action = (error == ENOSPC) ? 494a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 49532c81a4aSPaolo Bonzini break; 49632c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 497a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 49832c81a4aSPaolo Bonzini break; 49932c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 500a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 50132c81a4aSPaolo Bonzini break; 50232c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 503a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 50432c81a4aSPaolo Bonzini break; 50532c81a4aSPaolo Bonzini default: 50632c81a4aSPaolo Bonzini abort(); 50732c81a4aSPaolo Bonzini } 508559b935fSJohn Snow if (!block_job_is_internal(job)) { 50933e9e9bdSKevin Wolf qapi_event_send_block_job_error(job->job.id, 5105a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 5115a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 5123ab72385SPeter Xu action); 513559b935fSJohn Snow } 514a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 515b15de828SKevin Wolf job_pause(&job->job); 516751ebd76SFam Zheng /* make the pause user visible, which will be resumed from QMP. */ 517b15de828SKevin Wolf job->job.user_paused = true; 51832c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 51932c81a4aSPaolo Bonzini } 52032c81a4aSPaolo Bonzini return action; 52132c81a4aSPaolo Bonzini } 522