]>
Commit | Line | Data |
---|---|---|
2f0c9fe6 PB |
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 | ||
d38ea87a | 26 | #include "qemu/osdep.h" |
2f0c9fe6 | 27 | #include "qemu-common.h" |
737e150e | 28 | #include "block/block.h" |
c87621ea | 29 | #include "block/blockjob_int.h" |
737e150e | 30 | #include "block/block_int.h" |
c9de4050 | 31 | #include "block/trace.h" |
373340b2 | 32 | #include "sysemu/block-backend.h" |
e688df6b | 33 | #include "qapi/error.h" |
9af23989 | 34 | #include "qapi/qapi-events-block-core.h" |
cc7a8ea7 | 35 | #include "qapi/qmp/qerror.h" |
10817bf0 | 36 | #include "qemu/coroutine.h" |
1de7afc9 | 37 | #include "qemu/timer.h" |
2f0c9fe6 | 38 | |
88691b37 PB |
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 | ||
e7c1d78b | 54 | static bool is_block_job(Job *job) |
a7112795 | 55 | { |
e7c1d78b KW |
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; | |
a7112795 AG |
71 | } |
72 | ||
ffb1f10c AG |
73 | BlockJob *block_job_get(const char *id) |
74 | { | |
e7c1d78b | 75 | Job *job = job_get(id); |
ffb1f10c | 76 | |
e7c1d78b KW |
77 | if (job && is_block_job(job)) { |
78 | return container_of(job, BlockJob, job); | |
79 | } else { | |
80 | return NULL; | |
ffb1f10c | 81 | } |
ffb1f10c AG |
82 | } |
83 | ||
05b0d8e3 PB |
84 | static void block_job_attached_aio_context(AioContext *new_context, |
85 | void *opaque); | |
86 | static void block_job_detach_aio_context(void *opaque); | |
87 | ||
80fa2c75 | 88 | void block_job_free(Job *job) |
05b0d8e3 | 89 | { |
80fa2c75 KW |
90 | BlockJob *bjob = container_of(job, BlockJob, job); |
91 | BlockDriverState *bs = blk_bs(bjob->blk); | |
92 | ||
80fa2c75 KW |
93 | bs->job = NULL; |
94 | block_job_remove_all_bdrv(bjob); | |
95 | blk_remove_aio_context_notifier(bjob->blk, | |
96 | block_job_attached_aio_context, | |
97 | block_job_detach_aio_context, bjob); | |
98 | blk_unref(bjob->blk); | |
99 | error_free(bjob->blocker); | |
05b0d8e3 PB |
100 | } |
101 | ||
463e0be1 SH |
102 | static void block_job_attached_aio_context(AioContext *new_context, |
103 | void *opaque) | |
104 | { | |
105 | BlockJob *job = opaque; | |
106 | ||
08be6fe2 | 107 | job->job.aio_context = new_context; |
463e0be1 SH |
108 | if (job->driver->attached_aio_context) { |
109 | job->driver->attached_aio_context(job, new_context); | |
110 | } | |
111 | ||
b15de828 | 112 | job_resume(&job->job); |
463e0be1 SH |
113 | } |
114 | ||
b69f777d | 115 | void block_job_drain(Job *job) |
bae8196d | 116 | { |
b69f777d | 117 | BlockJob *bjob = container_of(job, BlockJob, job); |
bae8196d | 118 | |
b69f777d KW |
119 | blk_drain(bjob->blk); |
120 | if (bjob->driver->drain) { | |
121 | bjob->driver->drain(bjob); | |
bae8196d PB |
122 | } |
123 | } | |
124 | ||
463e0be1 SH |
125 | static void block_job_detach_aio_context(void *opaque) |
126 | { | |
127 | BlockJob *job = opaque; | |
128 | ||
129 | /* In case the job terminates during aio_poll()... */ | |
80fa2c75 | 130 | job_ref(&job->job); |
463e0be1 | 131 | |
b15de828 | 132 | job_pause(&job->job); |
463e0be1 | 133 | |
dbe5e6c1 | 134 | while (!job->job.paused && !job_is_completed(&job->job)) { |
b69f777d | 135 | job_drain(&job->job); |
463e0be1 SH |
136 | } |
137 | ||
08be6fe2 | 138 | job->job.aio_context = NULL; |
80fa2c75 | 139 | job_unref(&job->job); |
463e0be1 SH |
140 | } |
141 | ||
f321dcb5 PB |
142 | static char *child_job_get_parent_desc(BdrvChild *c) |
143 | { | |
144 | BlockJob *job = c->opaque; | |
252291ea | 145 | return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); |
f321dcb5 PB |
146 | } |
147 | ||
ad90feba | 148 | static void child_job_drained_begin(BdrvChild *c) |
f321dcb5 | 149 | { |
ad90feba | 150 | BlockJob *job = c->opaque; |
b15de828 | 151 | job_pause(&job->job); |
f321dcb5 PB |
152 | } |
153 | ||
ad90feba | 154 | static void child_job_drained_end(BdrvChild *c) |
f321dcb5 | 155 | { |
ad90feba | 156 | BlockJob *job = c->opaque; |
b15de828 | 157 | job_resume(&job->job); |
f321dcb5 PB |
158 | } |
159 | ||
ad90feba KW |
160 | static const BdrvChildRole child_job = { |
161 | .get_parent_desc = child_job_get_parent_desc, | |
162 | .drained_begin = child_job_drained_begin, | |
163 | .drained_end = child_job_drained_end, | |
164 | .stay_at_node = true, | |
f321dcb5 PB |
165 | }; |
166 | ||
bbc02b90 KW |
167 | void block_job_remove_all_bdrv(BlockJob *job) |
168 | { | |
169 | GSList *l; | |
170 | for (l = job->nodes; l; l = l->next) { | |
171 | BdrvChild *c = l->data; | |
172 | bdrv_op_unblock_all(c->bs, job->blocker); | |
173 | bdrv_root_unref_child(c); | |
174 | } | |
175 | g_slist_free(job->nodes); | |
176 | job->nodes = NULL; | |
177 | } | |
178 | ||
76d554e2 KW |
179 | int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, |
180 | uint64_t perm, uint64_t shared_perm, Error **errp) | |
23d402d4 | 181 | { |
76d554e2 KW |
182 | BdrvChild *c; |
183 | ||
184 | c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm, | |
185 | job, errp); | |
186 | if (c == NULL) { | |
187 | return -EPERM; | |
188 | } | |
189 | ||
190 | job->nodes = g_slist_prepend(job->nodes, c); | |
23d402d4 AG |
191 | bdrv_ref(bs); |
192 | bdrv_op_block_all(bs, job->blocker); | |
76d554e2 KW |
193 | |
194 | return 0; | |
23d402d4 AG |
195 | } |
196 | ||
559b935f JS |
197 | bool block_job_is_internal(BlockJob *job) |
198 | { | |
33e9e9bd | 199 | return (job->job.id == NULL); |
559b935f JS |
200 | } |
201 | ||
bd21935b KW |
202 | const BlockJobDriver *block_job_driver(BlockJob *job) |
203 | { | |
204 | return job->driver; | |
205 | } | |
206 | ||
da01ff7f KW |
207 | /* Assumes the job_mutex is held */ |
208 | static bool job_timer_pending(Job *job) | |
209 | { | |
210 | return timer_pending(&job->sleep_timer); | |
211 | } | |
212 | ||
2f0c9fe6 PB |
213 | void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) |
214 | { | |
aa9ef2e6 | 215 | int64_t old_speed = job->speed; |
2f0c9fe6 | 216 | |
a50c2ab8 | 217 | if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp)) { |
0ec4dfb8 JS |
218 | return; |
219 | } | |
18bb6928 KW |
220 | if (speed < 0) { |
221 | error_setg(errp, QERR_INVALID_PARAMETER, "speed"); | |
2f0c9fe6 PB |
222 | return; |
223 | } | |
224 | ||
18bb6928 KW |
225 | ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); |
226 | ||
2f0c9fe6 | 227 | job->speed = speed; |
d4fce188 | 228 | if (speed && speed <= old_speed) { |
aa9ef2e6 JS |
229 | return; |
230 | } | |
231 | ||
232 | /* kick only if a timer is pending */ | |
da01ff7f | 233 | job_enter_cond(&job->job, job_timer_pending); |
2f0c9fe6 PB |
234 | } |
235 | ||
dee81d51 KW |
236 | int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) |
237 | { | |
238 | if (!job->speed) { | |
239 | return 0; | |
240 | } | |
241 | ||
242 | return ratelimit_calculate_delay(&job->limit, n); | |
243 | } | |
244 | ||
05df8a6a KW |
245 | void block_job_progress_update(BlockJob *job, uint64_t done) |
246 | { | |
247 | job->offset += done; | |
248 | } | |
249 | ||
250 | void block_job_progress_set_remaining(BlockJob *job, uint64_t remaining) | |
251 | { | |
252 | job->len = job->offset + remaining; | |
253 | } | |
254 | ||
559b935f | 255 | BlockJobInfo *block_job_query(BlockJob *job, Error **errp) |
30e628b7 | 256 | { |
559b935f JS |
257 | BlockJobInfo *info; |
258 | ||
259 | if (block_job_is_internal(job)) { | |
260 | error_setg(errp, "Cannot query QEMU internal jobs"); | |
261 | return NULL; | |
262 | } | |
263 | info = g_new0(BlockJobInfo, 1); | |
252291ea | 264 | info->type = g_strdup(job_type_str(&job->job)); |
33e9e9bd | 265 | info->device = g_strdup(job->job.id); |
32c81a4a | 266 | info->len = job->len; |
da01ff7f KW |
267 | info->busy = atomic_read(&job->job.busy); |
268 | info->paused = job->job.pause_count > 0; | |
32c81a4a PB |
269 | info->offset = job->offset; |
270 | info->speed = job->speed; | |
271 | info->io_status = job->iostatus; | |
df956ae2 | 272 | info->ready = job_is_ready(&job->job), |
a50c2ab8 | 273 | info->status = job->job.status; |
bb02b65c KW |
274 | info->auto_finalize = job->job.auto_finalize; |
275 | info->auto_dismiss = job->job.auto_dismiss; | |
4ad35181 KW |
276 | info->has_error = job->job.ret != 0; |
277 | info->error = job->job.ret ? g_strdup(strerror(-job->job.ret)) : NULL; | |
30e628b7 PB |
278 | return info; |
279 | } | |
32c81a4a PB |
280 | |
281 | static void block_job_iostatus_set_err(BlockJob *job, int error) | |
282 | { | |
283 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { | |
284 | job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : | |
285 | BLOCK_DEVICE_IO_STATUS_FAILED; | |
286 | } | |
287 | } | |
288 | ||
139a9f02 | 289 | static void block_job_event_cancelled(Notifier *n, void *opaque) |
bcada37b | 290 | { |
139a9f02 KW |
291 | BlockJob *job = opaque; |
292 | ||
559b935f JS |
293 | if (block_job_is_internal(job)) { |
294 | return; | |
295 | } | |
296 | ||
252291ea | 297 | qapi_event_send_block_job_cancelled(job_type(&job->job), |
33e9e9bd | 298 | job->job.id, |
bcada37b WX |
299 | job->len, |
300 | job->offset, | |
301 | job->speed, | |
302 | &error_abort); | |
303 | } | |
32c81a4a | 304 | |
139a9f02 | 305 | static void block_job_event_completed(Notifier *n, void *opaque) |
a66a2a36 | 306 | { |
139a9f02 KW |
307 | BlockJob *job = opaque; |
308 | const char *msg = NULL; | |
309 | ||
559b935f JS |
310 | if (block_job_is_internal(job)) { |
311 | return; | |
312 | } | |
313 | ||
4ad35181 KW |
314 | if (job->job.ret < 0) { |
315 | msg = strerror(-job->job.ret); | |
139a9f02 KW |
316 | } |
317 | ||
252291ea | 318 | qapi_event_send_block_job_completed(job_type(&job->job), |
33e9e9bd | 319 | job->job.id, |
bcada37b WX |
320 | job->len, |
321 | job->offset, | |
322 | job->speed, | |
323 | !!msg, | |
324 | msg, | |
325 | &error_abort); | |
a66a2a36 PB |
326 | } |
327 | ||
139a9f02 | 328 | static void block_job_event_pending(Notifier *n, void *opaque) |
5f241594 | 329 | { |
139a9f02 KW |
330 | BlockJob *job = opaque; |
331 | ||
5d4f3769 KW |
332 | if (block_job_is_internal(job)) { |
333 | return; | |
5f241594 | 334 | } |
5d4f3769 KW |
335 | |
336 | qapi_event_send_block_job_pending(job_type(&job->job), | |
337 | job->job.id, | |
338 | &error_abort); | |
5f241594 JS |
339 | } |
340 | ||
88691b37 PB |
341 | /* |
342 | * API for block job drivers and the block layer. These functions are | |
343 | * declared in blockjob_int.h. | |
344 | */ | |
345 | ||
346 | void *block_job_create(const char *job_id, const BlockJobDriver *driver, | |
62c9e416 | 347 | JobTxn *txn, BlockDriverState *bs, uint64_t perm, |
88691b37 PB |
348 | uint64_t shared_perm, int64_t speed, int flags, |
349 | BlockCompletionFunc *cb, void *opaque, Error **errp) | |
350 | { | |
351 | BlockBackend *blk; | |
352 | BlockJob *job; | |
353 | int ret; | |
354 | ||
355 | if (bs->job) { | |
356 | error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); | |
357 | return NULL; | |
358 | } | |
359 | ||
bb02b65c | 360 | if (job_id == NULL && !(flags & JOB_INTERNAL)) { |
88691b37 | 361 | job_id = bdrv_get_device_name(bs); |
88691b37 PB |
362 | } |
363 | ||
364 | blk = blk_new(perm, shared_perm); | |
365 | ret = blk_insert_bs(blk, bs, errp); | |
366 | if (ret < 0) { | |
367 | blk_unref(blk); | |
368 | return NULL; | |
369 | } | |
370 | ||
7eaa8fb5 | 371 | job = job_create(job_id, &driver->job_driver, txn, blk_get_aio_context(blk), |
4ad35181 | 372 | flags, cb, opaque, errp); |
33e9e9bd KW |
373 | if (job == NULL) { |
374 | blk_unref(blk); | |
375 | return NULL; | |
376 | } | |
377 | ||
e7c1d78b | 378 | assert(is_block_job(&job->job)); |
80fa2c75 | 379 | assert(job->job.driver->free == &block_job_free); |
b15de828 | 380 | assert(job->job.driver->user_resume == &block_job_user_resume); |
b69f777d | 381 | assert(job->job.driver->drain == &block_job_drain); |
e7c1d78b | 382 | |
88691b37 | 383 | job->driver = driver; |
88691b37 | 384 | job->blk = blk; |
88691b37 | 385 | |
139a9f02 KW |
386 | job->finalize_cancelled_notifier.notify = block_job_event_cancelled; |
387 | job->finalize_completed_notifier.notify = block_job_event_completed; | |
388 | job->pending_notifier.notify = block_job_event_pending; | |
389 | ||
390 | notifier_list_add(&job->job.on_finalize_cancelled, | |
391 | &job->finalize_cancelled_notifier); | |
392 | notifier_list_add(&job->job.on_finalize_completed, | |
393 | &job->finalize_completed_notifier); | |
394 | notifier_list_add(&job->job.on_pending, &job->pending_notifier); | |
395 | ||
88691b37 | 396 | error_setg(&job->blocker, "block device is in use by block job: %s", |
252291ea | 397 | job_type_str(&job->job)); |
88691b37 PB |
398 | block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); |
399 | bs->job = job; | |
400 | ||
88691b37 PB |
401 | bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); |
402 | ||
88691b37 PB |
403 | blk_add_aio_context_notifier(blk, block_job_attached_aio_context, |
404 | block_job_detach_aio_context, job); | |
405 | ||
406 | /* Only set speed when necessary to avoid NotSupported error */ | |
407 | if (speed != 0) { | |
408 | Error *local_err = NULL; | |
409 | ||
410 | block_job_set_speed(job, speed, &local_err); | |
411 | if (local_err) { | |
4ad35181 | 412 | job_early_fail(&job->job); |
88691b37 PB |
413 | error_propagate(errp, local_err); |
414 | return NULL; | |
415 | } | |
416 | } | |
75859b94 | 417 | |
88691b37 PB |
418 | return job; |
419 | } | |
420 | ||
2caf63a9 PB |
421 | void block_job_iostatus_reset(BlockJob *job) |
422 | { | |
4c241cf5 PB |
423 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { |
424 | return; | |
425 | } | |
b15de828 | 426 | assert(job->job.user_paused && job->job.pause_count > 0); |
2caf63a9 PB |
427 | job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; |
428 | } | |
429 | ||
b15de828 KW |
430 | void block_job_user_resume(Job *job) |
431 | { | |
432 | BlockJob *bjob = container_of(job, BlockJob, job); | |
433 | block_job_iostatus_reset(bjob); | |
434 | } | |
435 | ||
bcada37b | 436 | void block_job_event_ready(BlockJob *job) |
a66a2a36 | 437 | { |
a50c2ab8 | 438 | job_state_transition(&job->job, JOB_STATUS_READY); |
ef6dbf1e | 439 | |
559b935f JS |
440 | if (block_job_is_internal(job)) { |
441 | return; | |
442 | } | |
443 | ||
252291ea | 444 | qapi_event_send_block_job_ready(job_type(&job->job), |
33e9e9bd | 445 | job->job.id, |
518848a2 MA |
446 | job->len, |
447 | job->offset, | |
448 | job->speed, &error_abort); | |
a66a2a36 PB |
449 | } |
450 | ||
81e254dc | 451 | BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, |
32c81a4a PB |
452 | int is_read, int error) |
453 | { | |
454 | BlockErrorAction action; | |
455 | ||
456 | switch (on_err) { | |
457 | case BLOCKDEV_ON_ERROR_ENOSPC: | |
8c398252 | 458 | case BLOCKDEV_ON_ERROR_AUTO: |
a589569f WX |
459 | action = (error == ENOSPC) ? |
460 | BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; | |
32c81a4a PB |
461 | break; |
462 | case BLOCKDEV_ON_ERROR_STOP: | |
a589569f | 463 | action = BLOCK_ERROR_ACTION_STOP; |
32c81a4a PB |
464 | break; |
465 | case BLOCKDEV_ON_ERROR_REPORT: | |
a589569f | 466 | action = BLOCK_ERROR_ACTION_REPORT; |
32c81a4a PB |
467 | break; |
468 | case BLOCKDEV_ON_ERROR_IGNORE: | |
a589569f | 469 | action = BLOCK_ERROR_ACTION_IGNORE; |
32c81a4a PB |
470 | break; |
471 | default: | |
472 | abort(); | |
473 | } | |
559b935f | 474 | if (!block_job_is_internal(job)) { |
33e9e9bd | 475 | qapi_event_send_block_job_error(job->job.id, |
559b935f JS |
476 | is_read ? IO_OPERATION_TYPE_READ : |
477 | IO_OPERATION_TYPE_WRITE, | |
478 | action, &error_abort); | |
479 | } | |
a589569f | 480 | if (action == BLOCK_ERROR_ACTION_STOP) { |
b15de828 | 481 | job_pause(&job->job); |
751ebd76 | 482 | /* make the pause user visible, which will be resumed from QMP. */ |
b15de828 | 483 | job->job.user_paused = true; |
32c81a4a | 484 | block_job_iostatus_set_err(job, error); |
32c81a4a PB |
485 | } |
486 | return action; | |
487 | } |