Paolo Bonzini | 2f0c9fe | 2012-09-28 17:22:47 +0200 | [diff] [blame] | 1 | /* |
| 2 | * QEMU System Emulator block driver |
| 3 | * |
| 4 | * Copyright (c) 2011 IBM Corp. |
| 5 | * Copyright (c) 2012 Red Hat, Inc. |
| 6 | * |
| 7 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 8 | * of this software and associated documentation files (the "Software"), to deal |
| 9 | * in the Software without restriction, including without limitation the rights |
| 10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 11 | * copies of the Software, and to permit persons to whom the Software is |
| 12 | * furnished to do so, subject to the following conditions: |
| 13 | * |
| 14 | * The above copyright notice and this permission notice shall be included in |
| 15 | * all copies or substantial portions of the Software. |
| 16 | * |
| 17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 20 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 23 | * THE SOFTWARE. |
| 24 | */ |
| 25 | |
Peter Maydell | d38ea87 | 2016-01-29 17:50:05 +0000 | [diff] [blame] | 26 | #include "qemu/osdep.h" |
Paolo Bonzini | 737e150 | 2012-12-17 18:19:44 +0100 | [diff] [blame] | 27 | #include "block/block.h" |
John Snow | c87621e | 2016-10-27 12:07:00 -0400 | [diff] [blame] | 28 | #include "block/blockjob_int.h" |
Paolo Bonzini | 737e150 | 2012-12-17 18:19:44 +0100 | [diff] [blame] | 29 | #include "block/block_int.h" |
John Snow | c9de405 | 2018-03-10 03:27:30 -0500 | [diff] [blame] | 30 | #include "block/trace.h" |
Max Reitz | 373340b | 2015-10-19 17:53:22 +0200 | [diff] [blame] | 31 | #include "sysemu/block-backend.h" |
Markus Armbruster | e688df6 | 2018-02-01 12:18:31 +0100 | [diff] [blame] | 32 | #include "qapi/error.h" |
Markus Armbruster | 9af2398 | 2018-02-11 10:36:01 +0100 | [diff] [blame] | 33 | #include "qapi/qapi-events-block-core.h" |
Markus Armbruster | cc7a8ea | 2015-03-17 17:22:46 +0100 | [diff] [blame] | 34 | #include "qapi/qmp/qerror.h" |
Daniel P. Berrange | 10817bf | 2015-09-01 14:48:02 +0100 | [diff] [blame] | 35 | #include "qemu/coroutine.h" |
Markus Armbruster | db72581 | 2019-08-12 07:23:50 +0200 | [diff] [blame] | 36 | #include "qemu/main-loop.h" |
Paolo Bonzini | 1de7afc | 2012-12-17 18:20:00 +0100 | [diff] [blame] | 37 | #include "qemu/timer.h" |
Paolo Bonzini | 2f0c9fe | 2012-09-28 17:22:47 +0200 | [diff] [blame] | 38 | |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 39 | /* |
| 40 | * The block job API is composed of two categories of functions. |
| 41 | * |
| 42 | * The first includes functions used by the monitor. The monitor is |
| 43 | * peculiar in that it accesses the block job list with block_job_get, and |
| 44 | * therefore needs consistency across block_job_get and the actual operation |
| 45 | * (e.g. block_job_set_speed). The consistency is achieved with |
| 46 | * aio_context_acquire/release. These functions are declared in blockjob.h. |
| 47 | * |
| 48 | * The second includes functions used by the block job drivers and sometimes |
| 49 | * by the core block layer. These do not care about locking, because the |
| 50 | * whole coroutine runs under the AioContext lock, and are declared in |
| 51 | * blockjob_int.h. |
| 52 | */ |
| 53 | |
Kevin Wolf | e7c1d78 | 2018-04-12 17:54:37 +0200 | [diff] [blame] | 54 | static bool is_block_job(Job *job) |
Alberto Garcia | a711279 | 2016-04-04 16:43:51 +0300 | [diff] [blame] | 55 | { |
Kevin Wolf | e7c1d78 | 2018-04-12 17:54:37 +0200 | [diff] [blame] | 56 | return job_type(job) == JOB_TYPE_BACKUP || |
| 57 | job_type(job) == JOB_TYPE_COMMIT || |
| 58 | job_type(job) == JOB_TYPE_MIRROR || |
| 59 | job_type(job) == JOB_TYPE_STREAM; |
| 60 | } |
| 61 | |
| 62 | BlockJob *block_job_next(BlockJob *bjob) |
| 63 | { |
| 64 | Job *job = bjob ? &bjob->job : NULL; |
| 65 | |
| 66 | do { |
| 67 | job = job_next(job); |
| 68 | } while (job && !is_block_job(job)); |
| 69 | |
| 70 | return job ? container_of(job, BlockJob, job) : NULL; |
Alberto Garcia | a711279 | 2016-04-04 16:43:51 +0300 | [diff] [blame] | 71 | } |
| 72 | |
Alberto Garcia | ffb1f10 | 2016-07-05 17:28:54 +0300 | [diff] [blame] | 73 | BlockJob *block_job_get(const char *id) |
| 74 | { |
Kevin Wolf | e7c1d78 | 2018-04-12 17:54:37 +0200 | [diff] [blame] | 75 | Job *job = job_get(id); |
Alberto Garcia | ffb1f10 | 2016-07-05 17:28:54 +0300 | [diff] [blame] | 76 | |
Kevin Wolf | e7c1d78 | 2018-04-12 17:54:37 +0200 | [diff] [blame] | 77 | if (job && is_block_job(job)) { |
| 78 | return container_of(job, BlockJob, job); |
| 79 | } else { |
| 80 | return NULL; |
Alberto Garcia | ffb1f10 | 2016-07-05 17:28:54 +0300 | [diff] [blame] | 81 | } |
Alberto Garcia | ffb1f10 | 2016-07-05 17:28:54 +0300 | [diff] [blame] | 82 | } |
| 83 | |
Kevin Wolf | 80fa2c7 | 2018-04-13 18:50:05 +0200 | [diff] [blame] | 84 | void block_job_free(Job *job) |
Paolo Bonzini | 05b0d8e | 2017-05-08 16:13:02 +0200 | [diff] [blame] | 85 | { |
Kevin Wolf | 80fa2c7 | 2018-04-13 18:50:05 +0200 | [diff] [blame] | 86 | BlockJob *bjob = container_of(job, BlockJob, job); |
Kevin Wolf | 80fa2c7 | 2018-04-13 18:50:05 +0200 | [diff] [blame] | 87 | |
Kevin Wolf | 80fa2c7 | 2018-04-13 18:50:05 +0200 | [diff] [blame] | 88 | block_job_remove_all_bdrv(bjob); |
Kevin Wolf | 80fa2c7 | 2018-04-13 18:50:05 +0200 | [diff] [blame] | 89 | blk_unref(bjob->blk); |
| 90 | error_free(bjob->blocker); |
Paolo Bonzini | 05b0d8e | 2017-05-08 16:13:02 +0200 | [diff] [blame] | 91 | } |
| 92 | |
Paolo Bonzini | f321dcb | 2017-05-08 16:13:03 +0200 | [diff] [blame] | 93 | static char *child_job_get_parent_desc(BdrvChild *c) |
| 94 | { |
| 95 | BlockJob *job = c->opaque; |
Kevin Wolf | 252291e | 2018-04-12 17:57:08 +0200 | [diff] [blame] | 96 | return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); |
Paolo Bonzini | f321dcb | 2017-05-08 16:13:03 +0200 | [diff] [blame] | 97 | } |
| 98 | |
Kevin Wolf | ad90feb | 2017-12-12 19:04:28 +0100 | [diff] [blame] | 99 | static void child_job_drained_begin(BdrvChild *c) |
Paolo Bonzini | f321dcb | 2017-05-08 16:13:03 +0200 | [diff] [blame] | 100 | { |
Kevin Wolf | ad90feb | 2017-12-12 19:04:28 +0100 | [diff] [blame] | 101 | BlockJob *job = c->opaque; |
Kevin Wolf | b15de82 | 2018-04-18 17:10:26 +0200 | [diff] [blame] | 102 | job_pause(&job->job); |
Paolo Bonzini | f321dcb | 2017-05-08 16:13:03 +0200 | [diff] [blame] | 103 | } |
| 104 | |
Kevin Wolf | 89bd030 | 2018-03-22 14:11:20 +0100 | [diff] [blame] | 105 | static bool child_job_drained_poll(BdrvChild *c) |
| 106 | { |
| 107 | BlockJob *bjob = c->opaque; |
| 108 | Job *job = &bjob->job; |
| 109 | const BlockJobDriver *drv = block_job_driver(bjob); |
| 110 | |
| 111 | /* An inactive or completed job doesn't have any pending requests. Jobs |
| 112 | * with !job->busy are either already paused or have a pause point after |
| 113 | * being reentered, so no job driver code will run before they pause. */ |
Kevin Wolf | b5a7a05 | 2018-09-07 15:31:22 +0200 | [diff] [blame] | 114 | if (!job->busy || job_is_completed(job)) { |
Kevin Wolf | 89bd030 | 2018-03-22 14:11:20 +0100 | [diff] [blame] | 115 | return false; |
| 116 | } |
| 117 | |
| 118 | /* Otherwise, assume that it isn't fully stopped yet, but allow the job to |
| 119 | * override this assumption. */ |
| 120 | if (drv->drained_poll) { |
| 121 | return drv->drained_poll(bjob); |
| 122 | } else { |
| 123 | return true; |
| 124 | } |
| 125 | } |
| 126 | |
Max Reitz | e037c09 | 2019-07-19 11:26:14 +0200 | [diff] [blame] | 127 | static void child_job_drained_end(BdrvChild *c, int *drained_end_counter) |
Paolo Bonzini | f321dcb | 2017-05-08 16:13:03 +0200 | [diff] [blame] | 128 | { |
Kevin Wolf | ad90feb | 2017-12-12 19:04:28 +0100 | [diff] [blame] | 129 | BlockJob *job = c->opaque; |
Kevin Wolf | b15de82 | 2018-04-18 17:10:26 +0200 | [diff] [blame] | 130 | job_resume(&job->job); |
Paolo Bonzini | f321dcb | 2017-05-08 16:13:03 +0200 | [diff] [blame] | 131 | } |
| 132 | |
Kevin Wolf | 9ff7f0d | 2019-05-06 19:18:03 +0200 | [diff] [blame] | 133 | static bool child_job_can_set_aio_ctx(BdrvChild *c, AioContext *ctx, |
| 134 | GSList **ignore, Error **errp) |
| 135 | { |
| 136 | BlockJob *job = c->opaque; |
| 137 | GSList *l; |
| 138 | |
| 139 | for (l = job->nodes; l; l = l->next) { |
| 140 | BdrvChild *sibling = l->data; |
| 141 | if (!bdrv_child_can_set_aio_context(sibling, ctx, ignore, errp)) { |
| 142 | return false; |
| 143 | } |
| 144 | } |
| 145 | return true; |
| 146 | } |
| 147 | |
| 148 | static void child_job_set_aio_ctx(BdrvChild *c, AioContext *ctx, |
| 149 | GSList **ignore) |
| 150 | { |
| 151 | BlockJob *job = c->opaque; |
| 152 | GSList *l; |
| 153 | |
| 154 | for (l = job->nodes; l; l = l->next) { |
| 155 | BdrvChild *sibling = l->data; |
| 156 | if (g_slist_find(*ignore, sibling)) { |
| 157 | continue; |
| 158 | } |
| 159 | *ignore = g_slist_prepend(*ignore, sibling); |
| 160 | bdrv_set_aio_context_ignore(sibling->bs, ctx, ignore); |
| 161 | } |
Kevin Wolf | 657e120 | 2019-05-06 19:18:04 +0200 | [diff] [blame] | 162 | |
| 163 | job->job.aio_context = ctx; |
Kevin Wolf | 9ff7f0d | 2019-05-06 19:18:03 +0200 | [diff] [blame] | 164 | } |
| 165 | |
Max Reitz | bd86fb9 | 2020-05-13 13:05:13 +0200 | [diff] [blame] | 166 | static const BdrvChildClass child_job = { |
Kevin Wolf | ad90feb | 2017-12-12 19:04:28 +0100 | [diff] [blame] | 167 | .get_parent_desc = child_job_get_parent_desc, |
| 168 | .drained_begin = child_job_drained_begin, |
Kevin Wolf | 89bd030 | 2018-03-22 14:11:20 +0100 | [diff] [blame] | 169 | .drained_poll = child_job_drained_poll, |
Kevin Wolf | ad90feb | 2017-12-12 19:04:28 +0100 | [diff] [blame] | 170 | .drained_end = child_job_drained_end, |
Kevin Wolf | 9ff7f0d | 2019-05-06 19:18:03 +0200 | [diff] [blame] | 171 | .can_set_aio_ctx = child_job_can_set_aio_ctx, |
| 172 | .set_aio_ctx = child_job_set_aio_ctx, |
Kevin Wolf | ad90feb | 2017-12-12 19:04:28 +0100 | [diff] [blame] | 173 | .stay_at_node = true, |
Paolo Bonzini | f321dcb | 2017-05-08 16:13:03 +0200 | [diff] [blame] | 174 | }; |
| 175 | |
Kevin Wolf | bbc02b9 | 2017-02-28 12:45:58 +0100 | [diff] [blame] | 176 | void block_job_remove_all_bdrv(BlockJob *job) |
| 177 | { |
Sergio Lopez | d876bf6 | 2019-09-11 12:03:16 +0200 | [diff] [blame] | 178 | /* |
| 179 | * bdrv_root_unref_child() may reach child_job_[can_]set_aio_ctx(), |
| 180 | * which will also traverse job->nodes, so consume the list one by |
| 181 | * one to make sure that such a concurrent access does not attempt |
| 182 | * to process an already freed BdrvChild. |
| 183 | */ |
| 184 | while (job->nodes) { |
| 185 | GSList *l = job->nodes; |
Kevin Wolf | bbc02b9 | 2017-02-28 12:45:58 +0100 | [diff] [blame] | 186 | BdrvChild *c = l->data; |
Sergio Lopez | d876bf6 | 2019-09-11 12:03:16 +0200 | [diff] [blame] | 187 | |
| 188 | job->nodes = l->next; |
| 189 | |
Kevin Wolf | bbc02b9 | 2017-02-28 12:45:58 +0100 | [diff] [blame] | 190 | bdrv_op_unblock_all(c->bs, job->blocker); |
| 191 | bdrv_root_unref_child(c); |
Sergio Lopez | d876bf6 | 2019-09-11 12:03:16 +0200 | [diff] [blame] | 192 | |
| 193 | g_slist_free_1(l); |
Kevin Wolf | bbc02b9 | 2017-02-28 12:45:58 +0100 | [diff] [blame] | 194 | } |
Kevin Wolf | bbc02b9 | 2017-02-28 12:45:58 +0100 | [diff] [blame] | 195 | } |
| 196 | |
Vladimir Sementsov-Ogievskiy | 8164102 | 2019-06-06 18:41:31 +0300 | [diff] [blame] | 197 | bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs) |
| 198 | { |
| 199 | GSList *el; |
| 200 | |
| 201 | for (el = job->nodes; el; el = el->next) { |
| 202 | BdrvChild *c = el->data; |
| 203 | if (c->bs == bs) { |
| 204 | return true; |
| 205 | } |
| 206 | } |
| 207 | |
| 208 | return false; |
| 209 | } |
| 210 | |
Kevin Wolf | 76d554e | 2017-01-17 11:56:42 +0100 | [diff] [blame] | 211 | int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, |
| 212 | uint64_t perm, uint64_t shared_perm, Error **errp) |
Alberto Garcia | 23d402d | 2016-10-28 10:08:04 +0300 | [diff] [blame] | 213 | { |
Kevin Wolf | 76d554e | 2017-01-17 11:56:42 +0100 | [diff] [blame] | 214 | BdrvChild *c; |
| 215 | |
Alberto Garcia | b441dc7 | 2019-05-13 16:46:18 +0300 | [diff] [blame] | 216 | bdrv_ref(bs); |
Kevin Wolf | 132ada8 | 2019-04-24 17:41:46 +0200 | [diff] [blame] | 217 | if (job->job.aio_context != qemu_get_aio_context()) { |
| 218 | aio_context_release(job->job.aio_context); |
| 219 | } |
Max Reitz | 258b776 | 2020-05-13 13:05:15 +0200 | [diff] [blame] | 220 | c = bdrv_root_attach_child(bs, name, &child_job, 0, |
| 221 | job->job.aio_context, perm, shared_perm, job, |
| 222 | errp); |
Kevin Wolf | 132ada8 | 2019-04-24 17:41:46 +0200 | [diff] [blame] | 223 | if (job->job.aio_context != qemu_get_aio_context()) { |
| 224 | aio_context_acquire(job->job.aio_context); |
| 225 | } |
Kevin Wolf | 76d554e | 2017-01-17 11:56:42 +0100 | [diff] [blame] | 226 | if (c == NULL) { |
| 227 | return -EPERM; |
| 228 | } |
| 229 | |
| 230 | job->nodes = g_slist_prepend(job->nodes, c); |
Alberto Garcia | 23d402d | 2016-10-28 10:08:04 +0300 | [diff] [blame] | 231 | bdrv_op_block_all(bs, job->blocker); |
Kevin Wolf | 76d554e | 2017-01-17 11:56:42 +0100 | [diff] [blame] | 232 | |
| 233 | return 0; |
Alberto Garcia | 23d402d | 2016-10-28 10:08:04 +0300 | [diff] [blame] | 234 | } |
| 235 | |
Kevin Wolf | 34dc97b | 2018-08-17 14:53:05 +0200 | [diff] [blame] | 236 | static void block_job_on_idle(Notifier *n, void *opaque) |
| 237 | { |
Kevin Wolf | cfe29d8 | 2018-09-18 17:09:16 +0200 | [diff] [blame] | 238 | aio_wait_kick(); |
Kevin Wolf | 34dc97b | 2018-08-17 14:53:05 +0200 | [diff] [blame] | 239 | } |
| 240 | |
John Snow | 559b935 | 2016-10-27 12:06:55 -0400 | [diff] [blame] | 241 | bool block_job_is_internal(BlockJob *job) |
| 242 | { |
Kevin Wolf | 33e9e9b | 2018-04-12 17:29:59 +0200 | [diff] [blame] | 243 | return (job->job.id == NULL); |
John Snow | 559b935 | 2016-10-27 12:06:55 -0400 | [diff] [blame] | 244 | } |
| 245 | |
Kevin Wolf | bd21935 | 2018-01-19 15:54:40 +0100 | [diff] [blame] | 246 | const BlockJobDriver *block_job_driver(BlockJob *job) |
| 247 | { |
Kevin Wolf | 9f6bb4c | 2018-05-14 14:51:21 +0200 | [diff] [blame] | 248 | return container_of(job->job.driver, BlockJobDriver, job_driver); |
Kevin Wolf | bd21935 | 2018-01-19 15:54:40 +0100 | [diff] [blame] | 249 | } |
| 250 | |
Kevin Wolf | da01ff7 | 2018-04-13 17:31:02 +0200 | [diff] [blame] | 251 | /* Assumes the job_mutex is held */ |
| 252 | static bool job_timer_pending(Job *job) |
| 253 | { |
| 254 | return timer_pending(&job->sleep_timer); |
| 255 | } |
| 256 | |
Paolo Bonzini | 2f0c9fe | 2012-09-28 17:22:47 +0200 | [diff] [blame] | 257 | void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) |
| 258 | { |
John Snow | aa9ef2e | 2017-12-13 15:46:11 -0500 | [diff] [blame] | 259 | int64_t old_speed = job->speed; |
Paolo Bonzini | 2f0c9fe | 2012-09-28 17:22:47 +0200 | [diff] [blame] | 260 | |
Kevin Wolf | a50c2ab | 2018-04-13 17:19:31 +0200 | [diff] [blame] | 261 | if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp)) { |
John Snow | 0ec4dfb | 2018-03-10 03:27:32 -0500 | [diff] [blame] | 262 | return; |
| 263 | } |
Kevin Wolf | 18bb692 | 2018-01-18 20:25:40 +0100 | [diff] [blame] | 264 | if (speed < 0) { |
Kevin Wolf | 1ef7d9d | 2019-11-26 14:39:55 +0100 | [diff] [blame] | 265 | error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "speed", |
| 266 | "a non-negative value"); |
Paolo Bonzini | 2f0c9fe | 2012-09-28 17:22:47 +0200 | [diff] [blame] | 267 | return; |
| 268 | } |
| 269 | |
Kevin Wolf | 18bb692 | 2018-01-18 20:25:40 +0100 | [diff] [blame] | 270 | ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); |
| 271 | |
Paolo Bonzini | 2f0c9fe | 2012-09-28 17:22:47 +0200 | [diff] [blame] | 272 | job->speed = speed; |
John Snow | d4fce18 | 2018-03-10 03:27:26 -0500 | [diff] [blame] | 273 | if (speed && speed <= old_speed) { |
John Snow | aa9ef2e | 2017-12-13 15:46:11 -0500 | [diff] [blame] | 274 | return; |
| 275 | } |
| 276 | |
| 277 | /* kick only if a timer is pending */ |
Kevin Wolf | da01ff7 | 2018-04-13 17:31:02 +0200 | [diff] [blame] | 278 | job_enter_cond(&job->job, job_timer_pending); |
Paolo Bonzini | 2f0c9fe | 2012-09-28 17:22:47 +0200 | [diff] [blame] | 279 | } |
| 280 | |
Kevin Wolf | dee81d5 | 2018-01-18 21:19:38 +0100 | [diff] [blame] | 281 | int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) |
| 282 | { |
| 283 | if (!job->speed) { |
| 284 | return 0; |
| 285 | } |
| 286 | |
| 287 | return ratelimit_calculate_delay(&job->limit, n); |
| 288 | } |
| 289 | |
John Snow | 559b935 | 2016-10-27 12:06:55 -0400 | [diff] [blame] | 290 | BlockJobInfo *block_job_query(BlockJob *job, Error **errp) |
Paolo Bonzini | 30e628b | 2012-09-28 17:22:48 +0200 | [diff] [blame] | 291 | { |
John Snow | 559b935 | 2016-10-27 12:06:55 -0400 | [diff] [blame] | 292 | BlockJobInfo *info; |
| 293 | |
| 294 | if (block_job_is_internal(job)) { |
| 295 | error_setg(errp, "Cannot query QEMU internal jobs"); |
| 296 | return NULL; |
| 297 | } |
| 298 | info = g_new0(BlockJobInfo, 1); |
Kevin Wolf | 252291e | 2018-04-12 17:57:08 +0200 | [diff] [blame] | 299 | info->type = g_strdup(job_type_str(&job->job)); |
Kevin Wolf | 33e9e9b | 2018-04-12 17:29:59 +0200 | [diff] [blame] | 300 | info->device = g_strdup(job->job.id); |
Kevin Wolf | da01ff7 | 2018-04-13 17:31:02 +0200 | [diff] [blame] | 301 | info->busy = atomic_read(&job->job.busy); |
| 302 | info->paused = job->job.pause_count > 0; |
Vladimir Sementsov-Ogievskiy | 01fe1ca | 2020-03-11 13:29:56 +0300 | [diff] [blame] | 303 | info->offset = job->job.progress.current; |
| 304 | info->len = job->job.progress.total; |
Paolo Bonzini | 32c81a4 | 2012-09-28 17:22:58 +0200 | [diff] [blame] | 305 | info->speed = job->speed; |
| 306 | info->io_status = job->iostatus; |
Kevin Wolf | df956ae | 2018-04-25 15:09:58 +0200 | [diff] [blame] | 307 | info->ready = job_is_ready(&job->job), |
Kevin Wolf | a50c2ab | 2018-04-13 17:19:31 +0200 | [diff] [blame] | 308 | info->status = job->job.status; |
Kevin Wolf | bb02b65 | 2018-04-19 17:54:56 +0200 | [diff] [blame] | 309 | info->auto_finalize = job->job.auto_finalize; |
| 310 | info->auto_dismiss = job->job.auto_dismiss; |
Kevin Wolf | 4ad3518 | 2018-04-19 17:30:16 +0200 | [diff] [blame] | 311 | info->has_error = job->job.ret != 0; |
| 312 | info->error = job->job.ret ? g_strdup(strerror(-job->job.ret)) : NULL; |
Paolo Bonzini | 30e628b | 2012-09-28 17:22:48 +0200 | [diff] [blame] | 313 | return info; |
| 314 | } |
Paolo Bonzini | 32c81a4 | 2012-09-28 17:22:58 +0200 | [diff] [blame] | 315 | |
| 316 | static void block_job_iostatus_set_err(BlockJob *job, int error) |
| 317 | { |
| 318 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { |
| 319 | job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : |
| 320 | BLOCK_DEVICE_IO_STATUS_FAILED; |
| 321 | } |
| 322 | } |
| 323 | |
Kevin Wolf | 139a9f0 | 2018-04-23 18:04:57 +0200 | [diff] [blame] | 324 | static void block_job_event_cancelled(Notifier *n, void *opaque) |
Paolo Bonzini | a66a2a3 | 2012-07-23 15:15:47 +0200 | [diff] [blame] | 325 | { |
Kevin Wolf | 139a9f0 | 2018-04-23 18:04:57 +0200 | [diff] [blame] | 326 | BlockJob *job = opaque; |
| 327 | |
John Snow | 559b935 | 2016-10-27 12:06:55 -0400 | [diff] [blame] | 328 | if (block_job_is_internal(job)) { |
| 329 | return; |
| 330 | } |
| 331 | |
Kevin Wolf | 252291e | 2018-04-12 17:57:08 +0200 | [diff] [blame] | 332 | qapi_event_send_block_job_cancelled(job_type(&job->job), |
Kevin Wolf | 33e9e9b | 2018-04-12 17:29:59 +0200 | [diff] [blame] | 333 | job->job.id, |
Vladimir Sementsov-Ogievskiy | 01fe1ca | 2020-03-11 13:29:56 +0300 | [diff] [blame] | 334 | job->job.progress.total, |
| 335 | job->job.progress.current, |
Peter Xu | 3ab7238 | 2018-08-15 21:37:37 +0800 | [diff] [blame] | 336 | job->speed); |
Paolo Bonzini | a66a2a3 | 2012-07-23 15:15:47 +0200 | [diff] [blame] | 337 | } |
| 338 | |
Kevin Wolf | 139a9f0 | 2018-04-23 18:04:57 +0200 | [diff] [blame] | 339 | static void block_job_event_completed(Notifier *n, void *opaque) |
Paolo Bonzini | a66a2a3 | 2012-07-23 15:15:47 +0200 | [diff] [blame] | 340 | { |
Kevin Wolf | 139a9f0 | 2018-04-23 18:04:57 +0200 | [diff] [blame] | 341 | BlockJob *job = opaque; |
| 342 | const char *msg = NULL; |
| 343 | |
John Snow | 559b935 | 2016-10-27 12:06:55 -0400 | [diff] [blame] | 344 | if (block_job_is_internal(job)) { |
| 345 | return; |
| 346 | } |
| 347 | |
Kevin Wolf | 4ad3518 | 2018-04-19 17:30:16 +0200 | [diff] [blame] | 348 | if (job->job.ret < 0) { |
| 349 | msg = strerror(-job->job.ret); |
Kevin Wolf | 139a9f0 | 2018-04-23 18:04:57 +0200 | [diff] [blame] | 350 | } |
| 351 | |
Kevin Wolf | 252291e | 2018-04-12 17:57:08 +0200 | [diff] [blame] | 352 | qapi_event_send_block_job_completed(job_type(&job->job), |
Kevin Wolf | 33e9e9b | 2018-04-12 17:29:59 +0200 | [diff] [blame] | 353 | job->job.id, |
Vladimir Sementsov-Ogievskiy | 01fe1ca | 2020-03-11 13:29:56 +0300 | [diff] [blame] | 354 | job->job.progress.total, |
| 355 | job->job.progress.current, |
Wenchao Xia | bcada37b | 2014-06-18 08:43:47 +0200 | [diff] [blame] | 356 | job->speed, |
| 357 | !!msg, |
Peter Xu | 3ab7238 | 2018-08-15 21:37:37 +0800 | [diff] [blame] | 358 | msg); |
Wenchao Xia | bcada37b | 2014-06-18 08:43:47 +0200 | [diff] [blame] | 359 | } |
| 360 | |
Kevin Wolf | 139a9f0 | 2018-04-23 18:04:57 +0200 | [diff] [blame] | 361 | static void block_job_event_pending(Notifier *n, void *opaque) |
John Snow | 5f24159 | 2018-03-10 03:27:42 -0500 | [diff] [blame] | 362 | { |
Kevin Wolf | 139a9f0 | 2018-04-23 18:04:57 +0200 | [diff] [blame] | 363 | BlockJob *job = opaque; |
| 364 | |
Kevin Wolf | 5d4f376 | 2018-04-23 17:09:42 +0200 | [diff] [blame] | 365 | if (block_job_is_internal(job)) { |
| 366 | return; |
John Snow | 5f24159 | 2018-03-10 03:27:42 -0500 | [diff] [blame] | 367 | } |
Kevin Wolf | 5d4f376 | 2018-04-23 17:09:42 +0200 | [diff] [blame] | 368 | |
| 369 | qapi_event_send_block_job_pending(job_type(&job->job), |
Peter Xu | 3ab7238 | 2018-08-15 21:37:37 +0800 | [diff] [blame] | 370 | job->job.id); |
John Snow | 5f24159 | 2018-03-10 03:27:42 -0500 | [diff] [blame] | 371 | } |
| 372 | |
Kevin Wolf | 2e1795b | 2018-04-25 14:56:09 +0200 | [diff] [blame] | 373 | static void block_job_event_ready(Notifier *n, void *opaque) |
| 374 | { |
| 375 | BlockJob *job = opaque; |
| 376 | |
| 377 | if (block_job_is_internal(job)) { |
| 378 | return; |
| 379 | } |
| 380 | |
| 381 | qapi_event_send_block_job_ready(job_type(&job->job), |
| 382 | job->job.id, |
Vladimir Sementsov-Ogievskiy | 01fe1ca | 2020-03-11 13:29:56 +0300 | [diff] [blame] | 383 | job->job.progress.total, |
| 384 | job->job.progress.current, |
Peter Xu | 3ab7238 | 2018-08-15 21:37:37 +0800 | [diff] [blame] | 385 | job->speed); |
Kevin Wolf | 2e1795b | 2018-04-25 14:56:09 +0200 | [diff] [blame] | 386 | } |
| 387 | |
| 388 | |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 389 | /* |
| 390 | * API for block job drivers and the block layer. These functions are |
| 391 | * declared in blockjob_int.h. |
| 392 | */ |
| 393 | |
| 394 | void *block_job_create(const char *job_id, const BlockJobDriver *driver, |
Kevin Wolf | 62c9e41 | 2018-04-19 16:09:52 +0200 | [diff] [blame] | 395 | JobTxn *txn, BlockDriverState *bs, uint64_t perm, |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 396 | uint64_t shared_perm, int64_t speed, int flags, |
| 397 | BlockCompletionFunc *cb, void *opaque, Error **errp) |
| 398 | { |
| 399 | BlockBackend *blk; |
| 400 | BlockJob *job; |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 401 | |
Kevin Wolf | bb02b65 | 2018-04-19 17:54:56 +0200 | [diff] [blame] | 402 | if (job_id == NULL && !(flags & JOB_INTERNAL)) { |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 403 | job_id = bdrv_get_device_name(bs); |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 404 | } |
| 405 | |
Eric Blake | a3aeeab | 2020-04-28 14:26:46 -0500 | [diff] [blame] | 406 | blk = blk_new_with_bs(bs, perm, shared_perm, errp); |
| 407 | if (!blk) { |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 408 | return NULL; |
| 409 | } |
| 410 | |
Kevin Wolf | 7eaa8fb | 2018-04-23 16:06:26 +0200 | [diff] [blame] | 411 | job = job_create(job_id, &driver->job_driver, txn, blk_get_aio_context(blk), |
Kevin Wolf | 4ad3518 | 2018-04-19 17:30:16 +0200 | [diff] [blame] | 412 | flags, cb, opaque, errp); |
Kevin Wolf | 33e9e9b | 2018-04-12 17:29:59 +0200 | [diff] [blame] | 413 | if (job == NULL) { |
| 414 | blk_unref(blk); |
| 415 | return NULL; |
| 416 | } |
| 417 | |
Kevin Wolf | e7c1d78 | 2018-04-12 17:54:37 +0200 | [diff] [blame] | 418 | assert(is_block_job(&job->job)); |
Kevin Wolf | 80fa2c7 | 2018-04-13 18:50:05 +0200 | [diff] [blame] | 419 | assert(job->job.driver->free == &block_job_free); |
Kevin Wolf | b15de82 | 2018-04-18 17:10:26 +0200 | [diff] [blame] | 420 | assert(job->job.driver->user_resume == &block_job_user_resume); |
Kevin Wolf | e7c1d78 | 2018-04-12 17:54:37 +0200 | [diff] [blame] | 421 | |
Kevin Wolf | 9f6bb4c | 2018-05-14 14:51:21 +0200 | [diff] [blame] | 422 | job->blk = blk; |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 423 | |
Kevin Wolf | 139a9f0 | 2018-04-23 18:04:57 +0200 | [diff] [blame] | 424 | job->finalize_cancelled_notifier.notify = block_job_event_cancelled; |
| 425 | job->finalize_completed_notifier.notify = block_job_event_completed; |
| 426 | job->pending_notifier.notify = block_job_event_pending; |
Kevin Wolf | 2e1795b | 2018-04-25 14:56:09 +0200 | [diff] [blame] | 427 | job->ready_notifier.notify = block_job_event_ready; |
Kevin Wolf | 34dc97b | 2018-08-17 14:53:05 +0200 | [diff] [blame] | 428 | job->idle_notifier.notify = block_job_on_idle; |
Kevin Wolf | 139a9f0 | 2018-04-23 18:04:57 +0200 | [diff] [blame] | 429 | |
| 430 | notifier_list_add(&job->job.on_finalize_cancelled, |
| 431 | &job->finalize_cancelled_notifier); |
| 432 | notifier_list_add(&job->job.on_finalize_completed, |
| 433 | &job->finalize_completed_notifier); |
| 434 | notifier_list_add(&job->job.on_pending, &job->pending_notifier); |
Kevin Wolf | 2e1795b | 2018-04-25 14:56:09 +0200 | [diff] [blame] | 435 | notifier_list_add(&job->job.on_ready, &job->ready_notifier); |
Kevin Wolf | 34dc97b | 2018-08-17 14:53:05 +0200 | [diff] [blame] | 436 | notifier_list_add(&job->job.on_idle, &job->idle_notifier); |
Kevin Wolf | 139a9f0 | 2018-04-23 18:04:57 +0200 | [diff] [blame] | 437 | |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 438 | error_setg(&job->blocker, "block device is in use by block job: %s", |
Kevin Wolf | 252291e | 2018-04-12 17:57:08 +0200 | [diff] [blame] | 439 | job_type_str(&job->job)); |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 440 | block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 441 | |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 442 | bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); |
| 443 | |
Kevin Wolf | cf31293 | 2019-07-22 17:46:23 +0200 | [diff] [blame] | 444 | /* Disable request queuing in the BlockBackend to avoid deadlocks on drain: |
| 445 | * The job reports that it's busy until it reaches a pause point. */ |
| 446 | blk_set_disable_request_queuing(blk, true); |
Kevin Wolf | 9ff7f0d | 2019-05-06 19:18:03 +0200 | [diff] [blame] | 447 | blk_set_allow_aio_context_change(blk, true); |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 448 | |
| 449 | /* Only set speed when necessary to avoid NotSupported error */ |
| 450 | if (speed != 0) { |
| 451 | Error *local_err = NULL; |
| 452 | |
| 453 | block_job_set_speed(job, speed, &local_err); |
| 454 | if (local_err) { |
Kevin Wolf | 4ad3518 | 2018-04-19 17:30:16 +0200 | [diff] [blame] | 455 | job_early_fail(&job->job); |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 456 | error_propagate(errp, local_err); |
| 457 | return NULL; |
| 458 | } |
| 459 | } |
John Snow | 75859b9 | 2018-03-10 03:27:27 -0500 | [diff] [blame] | 460 | |
Paolo Bonzini | 88691b3 | 2017-05-08 16:13:04 +0200 | [diff] [blame] | 461 | return job; |
| 462 | } |
| 463 | |
Paolo Bonzini | 2caf63a | 2017-05-08 16:13:05 +0200 | [diff] [blame] | 464 | void block_job_iostatus_reset(BlockJob *job) |
| 465 | { |
Paolo Bonzini | 4c241cf | 2017-05-08 16:13:06 +0200 | [diff] [blame] | 466 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { |
| 467 | return; |
| 468 | } |
Kevin Wolf | b15de82 | 2018-04-18 17:10:26 +0200 | [diff] [blame] | 469 | assert(job->job.user_paused && job->job.pause_count > 0); |
Paolo Bonzini | 2caf63a | 2017-05-08 16:13:05 +0200 | [diff] [blame] | 470 | job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; |
| 471 | } |
| 472 | |
Kevin Wolf | b15de82 | 2018-04-18 17:10:26 +0200 | [diff] [blame] | 473 | void block_job_user_resume(Job *job) |
| 474 | { |
| 475 | BlockJob *bjob = container_of(job, BlockJob, job); |
| 476 | block_job_iostatus_reset(bjob); |
| 477 | } |
| 478 | |
Kevin Wolf | 81e254d | 2016-04-18 11:36:38 +0200 | [diff] [blame] | 479 | BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, |
Paolo Bonzini | 32c81a4 | 2012-09-28 17:22:58 +0200 | [diff] [blame] | 480 | int is_read, int error) |
| 481 | { |
| 482 | BlockErrorAction action; |
| 483 | |
| 484 | switch (on_err) { |
| 485 | case BLOCKDEV_ON_ERROR_ENOSPC: |
Kevin Wolf | 8c39825 | 2016-06-29 17:41:35 +0200 | [diff] [blame] | 486 | case BLOCKDEV_ON_ERROR_AUTO: |
Wenchao Xia | a589569 | 2014-06-18 08:43:30 +0200 | [diff] [blame] | 487 | action = (error == ENOSPC) ? |
| 488 | BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; |
Paolo Bonzini | 32c81a4 | 2012-09-28 17:22:58 +0200 | [diff] [blame] | 489 | break; |
| 490 | case BLOCKDEV_ON_ERROR_STOP: |
Wenchao Xia | a589569 | 2014-06-18 08:43:30 +0200 | [diff] [blame] | 491 | action = BLOCK_ERROR_ACTION_STOP; |
Paolo Bonzini | 32c81a4 | 2012-09-28 17:22:58 +0200 | [diff] [blame] | 492 | break; |
| 493 | case BLOCKDEV_ON_ERROR_REPORT: |
Wenchao Xia | a589569 | 2014-06-18 08:43:30 +0200 | [diff] [blame] | 494 | action = BLOCK_ERROR_ACTION_REPORT; |
Paolo Bonzini | 32c81a4 | 2012-09-28 17:22:58 +0200 | [diff] [blame] | 495 | break; |
| 496 | case BLOCKDEV_ON_ERROR_IGNORE: |
Wenchao Xia | a589569 | 2014-06-18 08:43:30 +0200 | [diff] [blame] | 497 | action = BLOCK_ERROR_ACTION_IGNORE; |
Paolo Bonzini | 32c81a4 | 2012-09-28 17:22:58 +0200 | [diff] [blame] | 498 | break; |
| 499 | default: |
| 500 | abort(); |
| 501 | } |
John Snow | 559b935 | 2016-10-27 12:06:55 -0400 | [diff] [blame] | 502 | if (!block_job_is_internal(job)) { |
Kevin Wolf | 33e9e9b | 2018-04-12 17:29:59 +0200 | [diff] [blame] | 503 | qapi_event_send_block_job_error(job->job.id, |
John Snow | 559b935 | 2016-10-27 12:06:55 -0400 | [diff] [blame] | 504 | is_read ? IO_OPERATION_TYPE_READ : |
| 505 | IO_OPERATION_TYPE_WRITE, |
Peter Xu | 3ab7238 | 2018-08-15 21:37:37 +0800 | [diff] [blame] | 506 | action); |
John Snow | 559b935 | 2016-10-27 12:06:55 -0400 | [diff] [blame] | 507 | } |
Wenchao Xia | a589569 | 2014-06-18 08:43:30 +0200 | [diff] [blame] | 508 | if (action == BLOCK_ERROR_ACTION_STOP) { |
Vladimir Sementsov-Ogievskiy | 8d9648c | 2019-03-19 12:24:42 +0300 | [diff] [blame] | 509 | if (!job->job.user_paused) { |
| 510 | job_pause(&job->job); |
| 511 | /* make the pause user visible, which will be resumed from QMP. */ |
| 512 | job->job.user_paused = true; |
| 513 | } |
Paolo Bonzini | 32c81a4 | 2012-09-28 17:22:58 +0200 | [diff] [blame] | 514 | block_job_iostatus_set_err(job, error); |
Paolo Bonzini | 32c81a4 | 2012-09-28 17:22:58 +0200 | [diff] [blame] | 515 | } |
| 516 | return action; |
| 517 | } |