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" 27737e150eSPaolo Bonzini #include "block/block.h" 28c87621eaSJohn Snow #include "block/blockjob_int.h" 29737e150eSPaolo Bonzini #include "block/block_int.h" 30c9de4050SJohn Snow #include "block/trace.h" 31373340b2SMax Reitz #include "sysemu/block-backend.h" 32e688df6bSMarkus Armbruster #include "qapi/error.h" 339af23989SMarkus Armbruster #include "qapi/qapi-events-block-core.h" 34cc7a8ea7SMarkus Armbruster #include "qapi/qmp/qerror.h" 3510817bf0SDaniel P. Berrange #include "qemu/coroutine.h" 36db725815SMarkus Armbruster #include "qemu/main-loop.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 8480fa2c75SKevin Wolf void block_job_free(Job *job) 8505b0d8e3SPaolo Bonzini { 8680fa2c75SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 8780fa2c75SKevin Wolf 8880fa2c75SKevin Wolf block_job_remove_all_bdrv(bjob); 8980fa2c75SKevin Wolf blk_unref(bjob->blk); 904951967dSPaolo Bonzini ratelimit_destroy(&bjob->limit); 9180fa2c75SKevin Wolf error_free(bjob->blocker); 9205b0d8e3SPaolo Bonzini } 9305b0d8e3SPaolo Bonzini 94f321dcb5SPaolo Bonzini static char *child_job_get_parent_desc(BdrvChild *c) 95f321dcb5SPaolo Bonzini { 96f321dcb5SPaolo Bonzini BlockJob *job = c->opaque; 97252291eaSKevin Wolf return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); 98f321dcb5SPaolo Bonzini } 99f321dcb5SPaolo Bonzini 100ad90febaSKevin Wolf static void child_job_drained_begin(BdrvChild *c) 101f321dcb5SPaolo Bonzini { 102ad90febaSKevin Wolf BlockJob *job = c->opaque; 103b15de828SKevin Wolf job_pause(&job->job); 104f321dcb5SPaolo Bonzini } 105f321dcb5SPaolo Bonzini 10689bd0305SKevin Wolf static bool child_job_drained_poll(BdrvChild *c) 10789bd0305SKevin Wolf { 10889bd0305SKevin Wolf BlockJob *bjob = c->opaque; 10989bd0305SKevin Wolf Job *job = &bjob->job; 11089bd0305SKevin Wolf const BlockJobDriver *drv = block_job_driver(bjob); 11189bd0305SKevin Wolf 11289bd0305SKevin Wolf /* An inactive or completed job doesn't have any pending requests. Jobs 11389bd0305SKevin Wolf * with !job->busy are either already paused or have a pause point after 11489bd0305SKevin Wolf * being reentered, so no job driver code will run before they pause. */ 115b5a7a057SKevin Wolf if (!job->busy || job_is_completed(job)) { 11689bd0305SKevin Wolf return false; 11789bd0305SKevin Wolf } 11889bd0305SKevin Wolf 11989bd0305SKevin Wolf /* Otherwise, assume that it isn't fully stopped yet, but allow the job to 12089bd0305SKevin Wolf * override this assumption. */ 12189bd0305SKevin Wolf if (drv->drained_poll) { 12289bd0305SKevin Wolf return drv->drained_poll(bjob); 12389bd0305SKevin Wolf } else { 12489bd0305SKevin Wolf return true; 12589bd0305SKevin Wolf } 12689bd0305SKevin Wolf } 12789bd0305SKevin Wolf 128e037c09cSMax Reitz static void child_job_drained_end(BdrvChild *c, int *drained_end_counter) 129f321dcb5SPaolo Bonzini { 130ad90febaSKevin Wolf BlockJob *job = c->opaque; 131b15de828SKevin Wolf job_resume(&job->job); 132f321dcb5SPaolo Bonzini } 133f321dcb5SPaolo Bonzini 1349ff7f0dfSKevin Wolf static bool child_job_can_set_aio_ctx(BdrvChild *c, AioContext *ctx, 1359ff7f0dfSKevin Wolf GSList **ignore, Error **errp) 1369ff7f0dfSKevin Wolf { 1379ff7f0dfSKevin Wolf BlockJob *job = c->opaque; 1389ff7f0dfSKevin Wolf GSList *l; 1399ff7f0dfSKevin Wolf 1409ff7f0dfSKevin Wolf for (l = job->nodes; l; l = l->next) { 1419ff7f0dfSKevin Wolf BdrvChild *sibling = l->data; 1429ff7f0dfSKevin Wolf if (!bdrv_child_can_set_aio_context(sibling, ctx, ignore, errp)) { 1439ff7f0dfSKevin Wolf return false; 1449ff7f0dfSKevin Wolf } 1459ff7f0dfSKevin Wolf } 1469ff7f0dfSKevin Wolf return true; 1479ff7f0dfSKevin Wolf } 1489ff7f0dfSKevin Wolf 1499ff7f0dfSKevin Wolf static void child_job_set_aio_ctx(BdrvChild *c, AioContext *ctx, 1509ff7f0dfSKevin Wolf GSList **ignore) 1519ff7f0dfSKevin Wolf { 1529ff7f0dfSKevin Wolf BlockJob *job = c->opaque; 1539ff7f0dfSKevin Wolf GSList *l; 1549ff7f0dfSKevin Wolf 1559ff7f0dfSKevin Wolf for (l = job->nodes; l; l = l->next) { 1569ff7f0dfSKevin Wolf BdrvChild *sibling = l->data; 1579ff7f0dfSKevin Wolf if (g_slist_find(*ignore, sibling)) { 1589ff7f0dfSKevin Wolf continue; 1599ff7f0dfSKevin Wolf } 1609ff7f0dfSKevin Wolf *ignore = g_slist_prepend(*ignore, sibling); 1619ff7f0dfSKevin Wolf bdrv_set_aio_context_ignore(sibling->bs, ctx, ignore); 1629ff7f0dfSKevin Wolf } 163657e1203SKevin Wolf 164657e1203SKevin Wolf job->job.aio_context = ctx; 1659ff7f0dfSKevin Wolf } 1669ff7f0dfSKevin Wolf 1673ca1f322SVladimir Sementsov-Ogievskiy static AioContext *child_job_get_parent_aio_context(BdrvChild *c) 1683ca1f322SVladimir Sementsov-Ogievskiy { 1693ca1f322SVladimir Sementsov-Ogievskiy BlockJob *job = c->opaque; 1703ca1f322SVladimir Sementsov-Ogievskiy 1713ca1f322SVladimir Sementsov-Ogievskiy return job->job.aio_context; 1723ca1f322SVladimir Sementsov-Ogievskiy } 1733ca1f322SVladimir Sementsov-Ogievskiy 174bd86fb99SMax Reitz static const BdrvChildClass child_job = { 175ad90febaSKevin Wolf .get_parent_desc = child_job_get_parent_desc, 176ad90febaSKevin Wolf .drained_begin = child_job_drained_begin, 17789bd0305SKevin Wolf .drained_poll = child_job_drained_poll, 178ad90febaSKevin Wolf .drained_end = child_job_drained_end, 1799ff7f0dfSKevin Wolf .can_set_aio_ctx = child_job_can_set_aio_ctx, 1809ff7f0dfSKevin Wolf .set_aio_ctx = child_job_set_aio_ctx, 181ad90febaSKevin Wolf .stay_at_node = true, 1823ca1f322SVladimir Sementsov-Ogievskiy .get_parent_aio_context = child_job_get_parent_aio_context, 183f321dcb5SPaolo Bonzini }; 184f321dcb5SPaolo Bonzini 185bbc02b90SKevin Wolf void block_job_remove_all_bdrv(BlockJob *job) 186bbc02b90SKevin Wolf { 187d876bf67SSergio Lopez /* 188d876bf67SSergio Lopez * bdrv_root_unref_child() may reach child_job_[can_]set_aio_ctx(), 189d876bf67SSergio Lopez * which will also traverse job->nodes, so consume the list one by 190d876bf67SSergio Lopez * one to make sure that such a concurrent access does not attempt 191d876bf67SSergio Lopez * to process an already freed BdrvChild. 192d876bf67SSergio Lopez */ 193d876bf67SSergio Lopez while (job->nodes) { 194d876bf67SSergio Lopez GSList *l = job->nodes; 195bbc02b90SKevin Wolf BdrvChild *c = l->data; 196d876bf67SSergio Lopez 197d876bf67SSergio Lopez job->nodes = l->next; 198d876bf67SSergio Lopez 199bbc02b90SKevin Wolf bdrv_op_unblock_all(c->bs, job->blocker); 200bbc02b90SKevin Wolf bdrv_root_unref_child(c); 201d876bf67SSergio Lopez 202d876bf67SSergio Lopez g_slist_free_1(l); 203bbc02b90SKevin Wolf } 204bbc02b90SKevin Wolf } 205bbc02b90SKevin Wolf 2068164102fSVladimir Sementsov-Ogievskiy bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs) 2078164102fSVladimir Sementsov-Ogievskiy { 2088164102fSVladimir Sementsov-Ogievskiy GSList *el; 2098164102fSVladimir Sementsov-Ogievskiy 2108164102fSVladimir Sementsov-Ogievskiy for (el = job->nodes; el; el = el->next) { 2118164102fSVladimir Sementsov-Ogievskiy BdrvChild *c = el->data; 2128164102fSVladimir Sementsov-Ogievskiy if (c->bs == bs) { 2138164102fSVladimir Sementsov-Ogievskiy return true; 2148164102fSVladimir Sementsov-Ogievskiy } 2158164102fSVladimir Sementsov-Ogievskiy } 2168164102fSVladimir Sementsov-Ogievskiy 2178164102fSVladimir Sementsov-Ogievskiy return false; 2188164102fSVladimir Sementsov-Ogievskiy } 2198164102fSVladimir Sementsov-Ogievskiy 22076d554e2SKevin Wolf int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, 22176d554e2SKevin Wolf uint64_t perm, uint64_t shared_perm, Error **errp) 22223d402d4SAlberto Garcia { 22376d554e2SKevin Wolf BdrvChild *c; 224076d467aSMichael Qiu bool need_context_ops; 22576d554e2SKevin Wolf 226b441dc71SAlberto Garcia bdrv_ref(bs); 227076d467aSMichael Qiu 228076d467aSMichael Qiu need_context_ops = bdrv_get_aio_context(bs) != job->job.aio_context; 229076d467aSMichael Qiu 230076d467aSMichael Qiu if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) { 231132ada80SKevin Wolf aio_context_release(job->job.aio_context); 232132ada80SKevin Wolf } 233228ca37eSVladimir Sementsov-Ogievskiy c = bdrv_root_attach_child(bs, name, &child_job, 0, perm, shared_perm, job, 234258b7765SMax Reitz errp); 235076d467aSMichael Qiu if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) { 236132ada80SKevin Wolf aio_context_acquire(job->job.aio_context); 237132ada80SKevin Wolf } 23876d554e2SKevin Wolf if (c == NULL) { 23976d554e2SKevin Wolf return -EPERM; 24076d554e2SKevin Wolf } 24176d554e2SKevin Wolf 24276d554e2SKevin Wolf job->nodes = g_slist_prepend(job->nodes, c); 24323d402d4SAlberto Garcia bdrv_op_block_all(bs, job->blocker); 24476d554e2SKevin Wolf 24576d554e2SKevin Wolf return 0; 24623d402d4SAlberto Garcia } 24723d402d4SAlberto Garcia 24834dc97b9SKevin Wolf static void block_job_on_idle(Notifier *n, void *opaque) 24934dc97b9SKevin Wolf { 250cfe29d82SKevin Wolf aio_wait_kick(); 25134dc97b9SKevin Wolf } 25234dc97b9SKevin Wolf 253559b935fSJohn Snow bool block_job_is_internal(BlockJob *job) 254559b935fSJohn Snow { 25533e9e9bdSKevin Wolf return (job->job.id == NULL); 256559b935fSJohn Snow } 257559b935fSJohn Snow 258bd21935bSKevin Wolf const BlockJobDriver *block_job_driver(BlockJob *job) 259bd21935bSKevin Wolf { 2609f6bb4c0SKevin Wolf return container_of(job->job.driver, BlockJobDriver, job_driver); 261bd21935bSKevin Wolf } 262bd21935bSKevin Wolf 263da01ff7fSKevin Wolf /* Assumes the job_mutex is held */ 264da01ff7fSKevin Wolf static bool job_timer_pending(Job *job) 265da01ff7fSKevin Wolf { 266da01ff7fSKevin Wolf return timer_pending(&job->sleep_timer); 267da01ff7fSKevin Wolf } 268da01ff7fSKevin Wolf 269775d0c05SVladimir Sementsov-Ogievskiy bool block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) 2702f0c9fe6SPaolo Bonzini { 271e0323a04SVladimir Sementsov-Ogievskiy const BlockJobDriver *drv = block_job_driver(job); 272aa9ef2e6SJohn Snow int64_t old_speed = job->speed; 2732f0c9fe6SPaolo Bonzini 274775d0c05SVladimir Sementsov-Ogievskiy if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp) < 0) { 275775d0c05SVladimir Sementsov-Ogievskiy return false; 2760ec4dfb8SJohn Snow } 27718bb6928SKevin Wolf if (speed < 0) { 2781ef7d9d3SKevin Wolf error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "speed", 2791ef7d9d3SKevin Wolf "a non-negative value"); 280775d0c05SVladimir Sementsov-Ogievskiy return false; 2812f0c9fe6SPaolo Bonzini } 2822f0c9fe6SPaolo Bonzini 28318bb6928SKevin Wolf ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); 28418bb6928SKevin Wolf 2852f0c9fe6SPaolo Bonzini job->speed = speed; 286e0323a04SVladimir Sementsov-Ogievskiy 287e0323a04SVladimir Sementsov-Ogievskiy if (drv->set_speed) { 288e0323a04SVladimir Sementsov-Ogievskiy drv->set_speed(job, speed); 289e0323a04SVladimir Sementsov-Ogievskiy } 290e0323a04SVladimir Sementsov-Ogievskiy 291d4fce188SJohn Snow if (speed && speed <= old_speed) { 292775d0c05SVladimir Sementsov-Ogievskiy return true; 293aa9ef2e6SJohn Snow } 294aa9ef2e6SJohn Snow 295aa9ef2e6SJohn Snow /* kick only if a timer is pending */ 296da01ff7fSKevin Wolf job_enter_cond(&job->job, job_timer_pending); 297775d0c05SVladimir Sementsov-Ogievskiy 298775d0c05SVladimir Sementsov-Ogievskiy return true; 2992f0c9fe6SPaolo Bonzini } 3002f0c9fe6SPaolo Bonzini 301dee81d51SKevin Wolf int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) 302dee81d51SKevin Wolf { 303dee81d51SKevin Wolf return ratelimit_calculate_delay(&job->limit, n); 304dee81d51SKevin Wolf } 305dee81d51SKevin Wolf 306559b935fSJohn Snow BlockJobInfo *block_job_query(BlockJob *job, Error **errp) 30730e628b7SPaolo Bonzini { 308559b935fSJohn Snow BlockJobInfo *info; 309a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 310559b935fSJohn Snow 311559b935fSJohn Snow if (block_job_is_internal(job)) { 312559b935fSJohn Snow error_setg(errp, "Cannot query QEMU internal jobs"); 313559b935fSJohn Snow return NULL; 314559b935fSJohn Snow } 315a7b4f8fcSEmanuele Giuseppe Esposito 316a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 317a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 318a7b4f8fcSEmanuele Giuseppe Esposito 319559b935fSJohn Snow info = g_new0(BlockJobInfo, 1); 320252291eaSKevin Wolf info->type = g_strdup(job_type_str(&job->job)); 32133e9e9bdSKevin Wolf info->device = g_strdup(job->job.id); 322d73415a3SStefan Hajnoczi info->busy = qatomic_read(&job->job.busy); 323da01ff7fSKevin Wolf info->paused = job->job.pause_count > 0; 324a7b4f8fcSEmanuele Giuseppe Esposito info->offset = progress_current; 325a7b4f8fcSEmanuele Giuseppe Esposito info->len = progress_total; 32630e628b7SPaolo Bonzini info->speed = job->speed; 32732c81a4aSPaolo Bonzini info->io_status = job->iostatus; 328df956ae2SKevin Wolf info->ready = job_is_ready(&job->job), 329a50c2ab8SKevin Wolf info->status = job->job.status; 330bb02b65cSKevin Wolf info->auto_finalize = job->job.auto_finalize; 331bb02b65cSKevin Wolf info->auto_dismiss = job->job.auto_dismiss; 3323b6ad623SStefano Garzarella if (job->job.ret) { 3333b6ad623SStefano Garzarella info->has_error = true; 3343b6ad623SStefano Garzarella info->error = job->job.err ? 3353b6ad623SStefano Garzarella g_strdup(error_get_pretty(job->job.err)) : 3363b6ad623SStefano Garzarella g_strdup(strerror(-job->job.ret)); 3373b6ad623SStefano Garzarella } 33830e628b7SPaolo Bonzini return info; 33930e628b7SPaolo Bonzini } 34032c81a4aSPaolo Bonzini 34132c81a4aSPaolo Bonzini static void block_job_iostatus_set_err(BlockJob *job, int error) 34232c81a4aSPaolo Bonzini { 34332c81a4aSPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 34432c81a4aSPaolo Bonzini job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : 34532c81a4aSPaolo Bonzini BLOCK_DEVICE_IO_STATUS_FAILED; 34632c81a4aSPaolo Bonzini } 34732c81a4aSPaolo Bonzini } 34832c81a4aSPaolo Bonzini 349139a9f02SKevin Wolf static void block_job_event_cancelled(Notifier *n, void *opaque) 350a66a2a36SPaolo Bonzini { 351139a9f02SKevin Wolf BlockJob *job = opaque; 352a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 353139a9f02SKevin Wolf 354559b935fSJohn Snow if (block_job_is_internal(job)) { 355559b935fSJohn Snow return; 356559b935fSJohn Snow } 357559b935fSJohn Snow 358a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 359a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 360a7b4f8fcSEmanuele Giuseppe Esposito 361252291eaSKevin Wolf qapi_event_send_block_job_cancelled(job_type(&job->job), 36233e9e9bdSKevin Wolf job->job.id, 363a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 364a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 3653ab72385SPeter Xu job->speed); 366a66a2a36SPaolo Bonzini } 367a66a2a36SPaolo Bonzini 368139a9f02SKevin Wolf static void block_job_event_completed(Notifier *n, void *opaque) 369a66a2a36SPaolo Bonzini { 370139a9f02SKevin Wolf BlockJob *job = opaque; 371139a9f02SKevin Wolf const char *msg = NULL; 372a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 373139a9f02SKevin Wolf 374559b935fSJohn Snow if (block_job_is_internal(job)) { 375559b935fSJohn Snow return; 376559b935fSJohn Snow } 377559b935fSJohn Snow 3784ad35181SKevin Wolf if (job->job.ret < 0) { 3793b6ad623SStefano Garzarella msg = error_get_pretty(job->job.err); 380139a9f02SKevin Wolf } 381139a9f02SKevin Wolf 382a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 383a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 384a7b4f8fcSEmanuele Giuseppe Esposito 385252291eaSKevin Wolf qapi_event_send_block_job_completed(job_type(&job->job), 38633e9e9bdSKevin Wolf job->job.id, 387a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 388a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 389bcada37bSWenchao Xia job->speed, 390bcada37bSWenchao Xia !!msg, 3913ab72385SPeter Xu msg); 392bcada37bSWenchao Xia } 393bcada37bSWenchao Xia 394139a9f02SKevin Wolf static void block_job_event_pending(Notifier *n, void *opaque) 3955f241594SJohn Snow { 396139a9f02SKevin Wolf BlockJob *job = opaque; 397139a9f02SKevin Wolf 3985d4f3769SKevin Wolf if (block_job_is_internal(job)) { 3995d4f3769SKevin Wolf return; 4005d4f3769SKevin Wolf } 4015d4f3769SKevin Wolf 402252291eaSKevin Wolf qapi_event_send_block_job_pending(job_type(&job->job), 4033ab72385SPeter Xu job->job.id); 4045f241594SJohn Snow } 4055f241594SJohn Snow 4062e1795b5SKevin Wolf static void block_job_event_ready(Notifier *n, void *opaque) 4072e1795b5SKevin Wolf { 4082e1795b5SKevin Wolf BlockJob *job = opaque; 409a7b4f8fcSEmanuele Giuseppe Esposito uint64_t progress_current, progress_total; 4102e1795b5SKevin Wolf 4112e1795b5SKevin Wolf if (block_job_is_internal(job)) { 4122e1795b5SKevin Wolf return; 4132e1795b5SKevin Wolf } 4142e1795b5SKevin Wolf 415a7b4f8fcSEmanuele Giuseppe Esposito progress_get_snapshot(&job->job.progress, &progress_current, 416a7b4f8fcSEmanuele Giuseppe Esposito &progress_total); 417a7b4f8fcSEmanuele Giuseppe Esposito 4182e1795b5SKevin Wolf qapi_event_send_block_job_ready(job_type(&job->job), 4192e1795b5SKevin Wolf job->job.id, 420a7b4f8fcSEmanuele Giuseppe Esposito progress_total, 421a7b4f8fcSEmanuele Giuseppe Esposito progress_current, 4223ab72385SPeter Xu job->speed); 4232e1795b5SKevin Wolf } 4242e1795b5SKevin Wolf 4252e1795b5SKevin Wolf 42688691b37SPaolo Bonzini /* 42788691b37SPaolo Bonzini * API for block job drivers and the block layer. These functions are 42888691b37SPaolo Bonzini * declared in blockjob_int.h. 42988691b37SPaolo Bonzini */ 43088691b37SPaolo Bonzini 43188691b37SPaolo Bonzini void *block_job_create(const char *job_id, const BlockJobDriver *driver, 43262c9e416SKevin Wolf JobTxn *txn, BlockDriverState *bs, uint64_t perm, 43388691b37SPaolo Bonzini uint64_t shared_perm, int64_t speed, int flags, 43488691b37SPaolo Bonzini BlockCompletionFunc *cb, void *opaque, Error **errp) 43588691b37SPaolo Bonzini { 43688691b37SPaolo Bonzini BlockBackend *blk; 43788691b37SPaolo Bonzini BlockJob *job; 43888691b37SPaolo Bonzini 439bb02b65cSKevin Wolf if (job_id == NULL && !(flags & JOB_INTERNAL)) { 44088691b37SPaolo Bonzini job_id = bdrv_get_device_name(bs); 44188691b37SPaolo Bonzini } 44288691b37SPaolo Bonzini 443a3aeeab5SEric Blake blk = blk_new_with_bs(bs, perm, shared_perm, errp); 444a3aeeab5SEric Blake if (!blk) { 44588691b37SPaolo Bonzini return NULL; 44688691b37SPaolo Bonzini } 44788691b37SPaolo Bonzini 4487eaa8fb5SKevin Wolf job = job_create(job_id, &driver->job_driver, txn, blk_get_aio_context(blk), 4494ad35181SKevin Wolf flags, cb, opaque, errp); 45033e9e9bdSKevin Wolf if (job == NULL) { 45133e9e9bdSKevin Wolf blk_unref(blk); 45233e9e9bdSKevin Wolf return NULL; 45333e9e9bdSKevin Wolf } 45433e9e9bdSKevin Wolf 455e7c1d78bSKevin Wolf assert(is_block_job(&job->job)); 45680fa2c75SKevin Wolf assert(job->job.driver->free == &block_job_free); 457b15de828SKevin Wolf assert(job->job.driver->user_resume == &block_job_user_resume); 458e7c1d78bSKevin Wolf 4594951967dSPaolo Bonzini ratelimit_init(&job->limit); 4604951967dSPaolo Bonzini 46188691b37SPaolo Bonzini job->blk = blk; 46288691b37SPaolo Bonzini 463139a9f02SKevin Wolf job->finalize_cancelled_notifier.notify = block_job_event_cancelled; 464139a9f02SKevin Wolf job->finalize_completed_notifier.notify = block_job_event_completed; 465139a9f02SKevin Wolf job->pending_notifier.notify = block_job_event_pending; 4662e1795b5SKevin Wolf job->ready_notifier.notify = block_job_event_ready; 46734dc97b9SKevin Wolf job->idle_notifier.notify = block_job_on_idle; 468139a9f02SKevin Wolf 469139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_cancelled, 470139a9f02SKevin Wolf &job->finalize_cancelled_notifier); 471139a9f02SKevin Wolf notifier_list_add(&job->job.on_finalize_completed, 472139a9f02SKevin Wolf &job->finalize_completed_notifier); 473139a9f02SKevin Wolf notifier_list_add(&job->job.on_pending, &job->pending_notifier); 4742e1795b5SKevin Wolf notifier_list_add(&job->job.on_ready, &job->ready_notifier); 47534dc97b9SKevin Wolf notifier_list_add(&job->job.on_idle, &job->idle_notifier); 476139a9f02SKevin Wolf 47788691b37SPaolo Bonzini error_setg(&job->blocker, "block device is in use by block job: %s", 478252291eaSKevin Wolf job_type_str(&job->job)); 47988691b37SPaolo Bonzini block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); 48088691b37SPaolo Bonzini 48188691b37SPaolo Bonzini bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); 48288691b37SPaolo Bonzini 483cf312932SKevin Wolf /* Disable request queuing in the BlockBackend to avoid deadlocks on drain: 484cf312932SKevin Wolf * The job reports that it's busy until it reaches a pause point. */ 485cf312932SKevin Wolf blk_set_disable_request_queuing(blk, true); 4869ff7f0dfSKevin Wolf blk_set_allow_aio_context_change(blk, true); 48788691b37SPaolo Bonzini 488775d0c05SVladimir Sementsov-Ogievskiy if (!block_job_set_speed(job, speed, errp)) { 4894ad35181SKevin Wolf job_early_fail(&job->job); 49088691b37SPaolo Bonzini return NULL; 49188691b37SPaolo Bonzini } 49275859b94SJohn Snow 49388691b37SPaolo Bonzini return job; 49488691b37SPaolo Bonzini } 49588691b37SPaolo Bonzini 4962caf63a9SPaolo Bonzini void block_job_iostatus_reset(BlockJob *job) 4972caf63a9SPaolo Bonzini { 4984c241cf5SPaolo Bonzini if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { 4994c241cf5SPaolo Bonzini return; 5004c241cf5SPaolo Bonzini } 501b15de828SKevin Wolf assert(job->job.user_paused && job->job.pause_count > 0); 5022caf63a9SPaolo Bonzini job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; 5032caf63a9SPaolo Bonzini } 5042caf63a9SPaolo Bonzini 505b15de828SKevin Wolf void block_job_user_resume(Job *job) 506b15de828SKevin Wolf { 507b15de828SKevin Wolf BlockJob *bjob = container_of(job, BlockJob, job); 508b15de828SKevin Wolf block_job_iostatus_reset(bjob); 509b15de828SKevin Wolf } 510b15de828SKevin Wolf 51181e254dcSKevin Wolf BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, 51232c81a4aSPaolo Bonzini int is_read, int error) 51332c81a4aSPaolo Bonzini { 51432c81a4aSPaolo Bonzini BlockErrorAction action; 51532c81a4aSPaolo Bonzini 51632c81a4aSPaolo Bonzini switch (on_err) { 51732c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_ENOSPC: 5188c398252SKevin Wolf case BLOCKDEV_ON_ERROR_AUTO: 519a589569fSWenchao Xia action = (error == ENOSPC) ? 520a589569fSWenchao Xia BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; 52132c81a4aSPaolo Bonzini break; 52232c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_STOP: 523a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_STOP; 52432c81a4aSPaolo Bonzini break; 52532c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_REPORT: 526a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_REPORT; 52732c81a4aSPaolo Bonzini break; 52832c81a4aSPaolo Bonzini case BLOCKDEV_ON_ERROR_IGNORE: 529a589569fSWenchao Xia action = BLOCK_ERROR_ACTION_IGNORE; 53032c81a4aSPaolo Bonzini break; 53132c81a4aSPaolo Bonzini default: 53232c81a4aSPaolo Bonzini abort(); 53332c81a4aSPaolo Bonzini } 534559b935fSJohn Snow if (!block_job_is_internal(job)) { 53533e9e9bdSKevin Wolf qapi_event_send_block_job_error(job->job.id, 5365a2d2cbdSWenchao Xia is_read ? IO_OPERATION_TYPE_READ : 5375a2d2cbdSWenchao Xia IO_OPERATION_TYPE_WRITE, 5383ab72385SPeter Xu action); 539559b935fSJohn Snow } 540a589569fSWenchao Xia if (action == BLOCK_ERROR_ACTION_STOP) { 5418d9648cbSVladimir Sementsov-Ogievskiy if (!job->job.user_paused) { 542b15de828SKevin Wolf job_pause(&job->job); 543751ebd76SFam Zheng /* make the pause user visible, which will be resumed from QMP. */ 544b15de828SKevin Wolf job->job.user_paused = true; 5458d9648cbSVladimir Sementsov-Ogievskiy } 54632c81a4aSPaolo Bonzini block_job_iostatus_set_err(job, error); 54732c81a4aSPaolo Bonzini } 54832c81a4aSPaolo Bonzini return action; 54932c81a4aSPaolo Bonzini } 550*df9a3165SVladimir Sementsov-Ogievskiy 551*df9a3165SVladimir Sementsov-Ogievskiy AioContext *block_job_get_aio_context(BlockJob *job) 552*df9a3165SVladimir Sementsov-Ogievskiy { 553*df9a3165SVladimir Sementsov-Ogievskiy return job->job.aio_context; 554*df9a3165SVladimir Sementsov-Ogievskiy } 555