]>
Commit | Line | Data |
---|---|---|
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 | ||
26 | #include "qemu/osdep.h" | |
27 | #include "block/aio-wait.h" | |
28 | #include "block/block.h" | |
29 | #include "block/blockjob_int.h" | |
30 | #include "block/block_int.h" | |
31 | #include "block/trace.h" | |
32 | #include "sysemu/block-backend.h" | |
33 | #include "qapi/error.h" | |
34 | #include "qapi/qapi-events-block-core.h" | |
35 | #include "qapi/qmp/qerror.h" | |
36 | #include "qemu/main-loop.h" | |
37 | #include "qemu/timer.h" | |
38 | ||
39 | static bool is_block_job(Job *job) | |
40 | { | |
41 | return job_type(job) == JOB_TYPE_BACKUP || | |
42 | job_type(job) == JOB_TYPE_COMMIT || | |
43 | job_type(job) == JOB_TYPE_MIRROR || | |
44 | job_type(job) == JOB_TYPE_STREAM; | |
45 | } | |
46 | ||
47 | BlockJob *block_job_next_locked(BlockJob *bjob) | |
48 | { | |
49 | Job *job = bjob ? &bjob->job : NULL; | |
50 | GLOBAL_STATE_CODE(); | |
51 | ||
52 | do { | |
53 | job = job_next_locked(job); | |
54 | } while (job && !is_block_job(job)); | |
55 | ||
56 | return job ? container_of(job, BlockJob, job) : NULL; | |
57 | } | |
58 | ||
59 | BlockJob *block_job_get_locked(const char *id) | |
60 | { | |
61 | Job *job = job_get_locked(id); | |
62 | GLOBAL_STATE_CODE(); | |
63 | ||
64 | if (job && is_block_job(job)) { | |
65 | return container_of(job, BlockJob, job); | |
66 | } else { | |
67 | return NULL; | |
68 | } | |
69 | } | |
70 | ||
71 | BlockJob *block_job_get(const char *id) | |
72 | { | |
73 | JOB_LOCK_GUARD(); | |
74 | return block_job_get_locked(id); | |
75 | } | |
76 | ||
77 | void block_job_free(Job *job) | |
78 | { | |
79 | BlockJob *bjob = container_of(job, BlockJob, job); | |
80 | GLOBAL_STATE_CODE(); | |
81 | ||
82 | block_job_remove_all_bdrv(bjob); | |
83 | ratelimit_destroy(&bjob->limit); | |
84 | error_free(bjob->blocker); | |
85 | } | |
86 | ||
87 | static char *child_job_get_parent_desc(BdrvChild *c) | |
88 | { | |
89 | BlockJob *job = c->opaque; | |
90 | return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); | |
91 | } | |
92 | ||
93 | static void child_job_drained_begin(BdrvChild *c) | |
94 | { | |
95 | BlockJob *job = c->opaque; | |
96 | job_pause(&job->job); | |
97 | } | |
98 | ||
99 | static bool child_job_drained_poll(BdrvChild *c) | |
100 | { | |
101 | BlockJob *bjob = c->opaque; | |
102 | Job *job = &bjob->job; | |
103 | const BlockJobDriver *drv = block_job_driver(bjob); | |
104 | ||
105 | /* An inactive or completed job doesn't have any pending requests. Jobs | |
106 | * with !job->busy are either already paused or have a pause point after | |
107 | * being reentered, so no job driver code will run before they pause. */ | |
108 | WITH_JOB_LOCK_GUARD() { | |
109 | if (!job->busy || job_is_completed_locked(job)) { | |
110 | return false; | |
111 | } | |
112 | } | |
113 | ||
114 | /* Otherwise, assume that it isn't fully stopped yet, but allow the job to | |
115 | * override this assumption. */ | |
116 | if (drv->drained_poll) { | |
117 | return drv->drained_poll(bjob); | |
118 | } else { | |
119 | return true; | |
120 | } | |
121 | } | |
122 | ||
123 | static void child_job_drained_end(BdrvChild *c) | |
124 | { | |
125 | BlockJob *job = c->opaque; | |
126 | job_resume(&job->job); | |
127 | } | |
128 | ||
129 | typedef struct BdrvStateChildJobContext { | |
130 | AioContext *new_ctx; | |
131 | BlockJob *job; | |
132 | } BdrvStateChildJobContext; | |
133 | ||
134 | static void child_job_set_aio_ctx_commit(void *opaque) | |
135 | { | |
136 | BdrvStateChildJobContext *s = opaque; | |
137 | BlockJob *job = s->job; | |
138 | ||
139 | job_set_aio_context(&job->job, s->new_ctx); | |
140 | } | |
141 | ||
142 | static TransactionActionDrv change_child_job_context = { | |
143 | .commit = child_job_set_aio_ctx_commit, | |
144 | .clean = g_free, | |
145 | }; | |
146 | ||
147 | static bool child_job_change_aio_ctx(BdrvChild *c, AioContext *ctx, | |
148 | GHashTable *visited, Transaction *tran, | |
149 | Error **errp) | |
150 | { | |
151 | BlockJob *job = c->opaque; | |
152 | BdrvStateChildJobContext *s; | |
153 | GSList *l; | |
154 | ||
155 | for (l = job->nodes; l; l = l->next) { | |
156 | BdrvChild *sibling = l->data; | |
157 | if (!bdrv_child_change_aio_context(sibling, ctx, visited, | |
158 | tran, errp)) { | |
159 | return false; | |
160 | } | |
161 | } | |
162 | ||
163 | s = g_new(BdrvStateChildJobContext, 1); | |
164 | *s = (BdrvStateChildJobContext) { | |
165 | .new_ctx = ctx, | |
166 | .job = job, | |
167 | }; | |
168 | ||
169 | tran_add(tran, &change_child_job_context, s); | |
170 | return true; | |
171 | } | |
172 | ||
173 | static AioContext *child_job_get_parent_aio_context(BdrvChild *c) | |
174 | { | |
175 | BlockJob *job = c->opaque; | |
176 | IO_CODE(); | |
177 | JOB_LOCK_GUARD(); | |
178 | ||
179 | return job->job.aio_context; | |
180 | } | |
181 | ||
182 | static const BdrvChildClass child_job = { | |
183 | .get_parent_desc = child_job_get_parent_desc, | |
184 | .drained_begin = child_job_drained_begin, | |
185 | .drained_poll = child_job_drained_poll, | |
186 | .drained_end = child_job_drained_end, | |
187 | .change_aio_ctx = child_job_change_aio_ctx, | |
188 | .stay_at_node = true, | |
189 | .get_parent_aio_context = child_job_get_parent_aio_context, | |
190 | }; | |
191 | ||
192 | void block_job_remove_all_bdrv(BlockJob *job) | |
193 | { | |
194 | GLOBAL_STATE_CODE(); | |
195 | /* | |
196 | * bdrv_root_unref_child() may reach child_job_[can_]set_aio_ctx(), | |
197 | * which will also traverse job->nodes, so consume the list one by | |
198 | * one to make sure that such a concurrent access does not attempt | |
199 | * to process an already freed BdrvChild. | |
200 | */ | |
201 | while (job->nodes) { | |
202 | GSList *l = job->nodes; | |
203 | BdrvChild *c = l->data; | |
204 | ||
205 | job->nodes = l->next; | |
206 | ||
207 | bdrv_op_unblock_all(c->bs, job->blocker); | |
208 | bdrv_root_unref_child(c); | |
209 | ||
210 | g_slist_free_1(l); | |
211 | } | |
212 | } | |
213 | ||
214 | bool block_job_has_bdrv(BlockJob *job, BlockDriverState *bs) | |
215 | { | |
216 | GSList *el; | |
217 | GLOBAL_STATE_CODE(); | |
218 | ||
219 | for (el = job->nodes; el; el = el->next) { | |
220 | BdrvChild *c = el->data; | |
221 | if (c->bs == bs) { | |
222 | return true; | |
223 | } | |
224 | } | |
225 | ||
226 | return false; | |
227 | } | |
228 | ||
229 | int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, | |
230 | uint64_t perm, uint64_t shared_perm, Error **errp) | |
231 | { | |
232 | BdrvChild *c; | |
233 | bool need_context_ops; | |
234 | GLOBAL_STATE_CODE(); | |
235 | ||
236 | bdrv_ref(bs); | |
237 | ||
238 | need_context_ops = bdrv_get_aio_context(bs) != job->job.aio_context; | |
239 | ||
240 | if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) { | |
241 | aio_context_release(job->job.aio_context); | |
242 | } | |
243 | c = bdrv_root_attach_child(bs, name, &child_job, 0, perm, shared_perm, job, | |
244 | errp); | |
245 | if (need_context_ops && job->job.aio_context != qemu_get_aio_context()) { | |
246 | aio_context_acquire(job->job.aio_context); | |
247 | } | |
248 | if (c == NULL) { | |
249 | return -EPERM; | |
250 | } | |
251 | ||
252 | job->nodes = g_slist_prepend(job->nodes, c); | |
253 | bdrv_op_block_all(bs, job->blocker); | |
254 | ||
255 | return 0; | |
256 | } | |
257 | ||
258 | /* Called with job_mutex lock held. */ | |
259 | static void block_job_on_idle_locked(Notifier *n, void *opaque) | |
260 | { | |
261 | aio_wait_kick(); | |
262 | } | |
263 | ||
264 | bool block_job_is_internal(BlockJob *job) | |
265 | { | |
266 | return (job->job.id == NULL); | |
267 | } | |
268 | ||
269 | const BlockJobDriver *block_job_driver(BlockJob *job) | |
270 | { | |
271 | return container_of(job->job.driver, BlockJobDriver, job_driver); | |
272 | } | |
273 | ||
274 | /* Assumes the job_mutex is held */ | |
275 | static bool job_timer_pending(Job *job) | |
276 | { | |
277 | return timer_pending(&job->sleep_timer); | |
278 | } | |
279 | ||
280 | bool block_job_set_speed_locked(BlockJob *job, int64_t speed, Error **errp) | |
281 | { | |
282 | const BlockJobDriver *drv = block_job_driver(job); | |
283 | int64_t old_speed = job->speed; | |
284 | ||
285 | GLOBAL_STATE_CODE(); | |
286 | ||
287 | if (job_apply_verb_locked(&job->job, JOB_VERB_SET_SPEED, errp) < 0) { | |
288 | return false; | |
289 | } | |
290 | if (speed < 0) { | |
291 | error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "speed", | |
292 | "a non-negative value"); | |
293 | return false; | |
294 | } | |
295 | ||
296 | ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); | |
297 | ||
298 | job->speed = speed; | |
299 | ||
300 | if (drv->set_speed) { | |
301 | job_unlock(); | |
302 | drv->set_speed(job, speed); | |
303 | job_lock(); | |
304 | } | |
305 | ||
306 | if (speed && speed <= old_speed) { | |
307 | return true; | |
308 | } | |
309 | ||
310 | /* kick only if a timer is pending */ | |
311 | job_enter_cond_locked(&job->job, job_timer_pending); | |
312 | ||
313 | return true; | |
314 | } | |
315 | ||
316 | static bool block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) | |
317 | { | |
318 | JOB_LOCK_GUARD(); | |
319 | return block_job_set_speed_locked(job, speed, errp); | |
320 | } | |
321 | ||
322 | int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) | |
323 | { | |
324 | IO_CODE(); | |
325 | return ratelimit_calculate_delay(&job->limit, n); | |
326 | } | |
327 | ||
328 | BlockJobInfo *block_job_query_locked(BlockJob *job, Error **errp) | |
329 | { | |
330 | BlockJobInfo *info; | |
331 | uint64_t progress_current, progress_total; | |
332 | ||
333 | GLOBAL_STATE_CODE(); | |
334 | ||
335 | if (block_job_is_internal(job)) { | |
336 | error_setg(errp, "Cannot query QEMU internal jobs"); | |
337 | return NULL; | |
338 | } | |
339 | ||
340 | progress_get_snapshot(&job->job.progress, &progress_current, | |
341 | &progress_total); | |
342 | ||
343 | info = g_new0(BlockJobInfo, 1); | |
344 | info->type = g_strdup(job_type_str(&job->job)); | |
345 | info->device = g_strdup(job->job.id); | |
346 | info->busy = job->job.busy; | |
347 | info->paused = job->job.pause_count > 0; | |
348 | info->offset = progress_current; | |
349 | info->len = progress_total; | |
350 | info->speed = job->speed; | |
351 | info->io_status = job->iostatus; | |
352 | info->ready = job_is_ready_locked(&job->job), | |
353 | info->status = job->job.status; | |
354 | info->auto_finalize = job->job.auto_finalize; | |
355 | info->auto_dismiss = job->job.auto_dismiss; | |
356 | if (job->job.ret) { | |
357 | info->error = job->job.err ? | |
358 | g_strdup(error_get_pretty(job->job.err)) : | |
359 | g_strdup(strerror(-job->job.ret)); | |
360 | } | |
361 | return info; | |
362 | } | |
363 | ||
364 | /* Called with job lock held */ | |
365 | static void block_job_iostatus_set_err_locked(BlockJob *job, int error) | |
366 | { | |
367 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { | |
368 | job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : | |
369 | BLOCK_DEVICE_IO_STATUS_FAILED; | |
370 | } | |
371 | } | |
372 | ||
373 | /* Called with job_mutex lock held. */ | |
374 | static void block_job_event_cancelled_locked(Notifier *n, void *opaque) | |
375 | { | |
376 | BlockJob *job = opaque; | |
377 | uint64_t progress_current, progress_total; | |
378 | ||
379 | if (block_job_is_internal(job)) { | |
380 | return; | |
381 | } | |
382 | ||
383 | progress_get_snapshot(&job->job.progress, &progress_current, | |
384 | &progress_total); | |
385 | ||
386 | qapi_event_send_block_job_cancelled(job_type(&job->job), | |
387 | job->job.id, | |
388 | progress_total, | |
389 | progress_current, | |
390 | job->speed); | |
391 | } | |
392 | ||
393 | /* Called with job_mutex lock held. */ | |
394 | static void block_job_event_completed_locked(Notifier *n, void *opaque) | |
395 | { | |
396 | BlockJob *job = opaque; | |
397 | const char *msg = NULL; | |
398 | uint64_t progress_current, progress_total; | |
399 | ||
400 | if (block_job_is_internal(job)) { | |
401 | return; | |
402 | } | |
403 | ||
404 | if (job->job.ret < 0) { | |
405 | msg = error_get_pretty(job->job.err); | |
406 | } | |
407 | ||
408 | progress_get_snapshot(&job->job.progress, &progress_current, | |
409 | &progress_total); | |
410 | ||
411 | qapi_event_send_block_job_completed(job_type(&job->job), | |
412 | job->job.id, | |
413 | progress_total, | |
414 | progress_current, | |
415 | job->speed, | |
416 | msg); | |
417 | } | |
418 | ||
419 | /* Called with job_mutex lock held. */ | |
420 | static void block_job_event_pending_locked(Notifier *n, void *opaque) | |
421 | { | |
422 | BlockJob *job = opaque; | |
423 | ||
424 | if (block_job_is_internal(job)) { | |
425 | return; | |
426 | } | |
427 | ||
428 | qapi_event_send_block_job_pending(job_type(&job->job), | |
429 | job->job.id); | |
430 | } | |
431 | ||
432 | /* Called with job_mutex lock held. */ | |
433 | static void block_job_event_ready_locked(Notifier *n, void *opaque) | |
434 | { | |
435 | BlockJob *job = opaque; | |
436 | uint64_t progress_current, progress_total; | |
437 | ||
438 | if (block_job_is_internal(job)) { | |
439 | return; | |
440 | } | |
441 | ||
442 | progress_get_snapshot(&job->job.progress, &progress_current, | |
443 | &progress_total); | |
444 | ||
445 | qapi_event_send_block_job_ready(job_type(&job->job), | |
446 | job->job.id, | |
447 | progress_total, | |
448 | progress_current, | |
449 | job->speed); | |
450 | } | |
451 | ||
452 | ||
453 | void *block_job_create(const char *job_id, const BlockJobDriver *driver, | |
454 | JobTxn *txn, BlockDriverState *bs, uint64_t perm, | |
455 | uint64_t shared_perm, int64_t speed, int flags, | |
456 | BlockCompletionFunc *cb, void *opaque, Error **errp) | |
457 | { | |
458 | BlockJob *job; | |
459 | int ret; | |
460 | GLOBAL_STATE_CODE(); | |
461 | ||
462 | if (job_id == NULL && !(flags & JOB_INTERNAL)) { | |
463 | job_id = bdrv_get_device_name(bs); | |
464 | } | |
465 | ||
466 | job = job_create(job_id, &driver->job_driver, txn, bdrv_get_aio_context(bs), | |
467 | flags, cb, opaque, errp); | |
468 | if (job == NULL) { | |
469 | return NULL; | |
470 | } | |
471 | ||
472 | assert(is_block_job(&job->job)); | |
473 | assert(job->job.driver->free == &block_job_free); | |
474 | assert(job->job.driver->user_resume == &block_job_user_resume); | |
475 | ||
476 | ratelimit_init(&job->limit); | |
477 | ||
478 | job->finalize_cancelled_notifier.notify = block_job_event_cancelled_locked; | |
479 | job->finalize_completed_notifier.notify = block_job_event_completed_locked; | |
480 | job->pending_notifier.notify = block_job_event_pending_locked; | |
481 | job->ready_notifier.notify = block_job_event_ready_locked; | |
482 | job->idle_notifier.notify = block_job_on_idle_locked; | |
483 | ||
484 | WITH_JOB_LOCK_GUARD() { | |
485 | notifier_list_add(&job->job.on_finalize_cancelled, | |
486 | &job->finalize_cancelled_notifier); | |
487 | notifier_list_add(&job->job.on_finalize_completed, | |
488 | &job->finalize_completed_notifier); | |
489 | notifier_list_add(&job->job.on_pending, &job->pending_notifier); | |
490 | notifier_list_add(&job->job.on_ready, &job->ready_notifier); | |
491 | notifier_list_add(&job->job.on_idle, &job->idle_notifier); | |
492 | } | |
493 | ||
494 | error_setg(&job->blocker, "block device is in use by block job: %s", | |
495 | job_type_str(&job->job)); | |
496 | ||
497 | ret = block_job_add_bdrv(job, "main node", bs, perm, shared_perm, errp); | |
498 | if (ret < 0) { | |
499 | goto fail; | |
500 | } | |
501 | ||
502 | bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); | |
503 | ||
504 | if (!block_job_set_speed(job, speed, errp)) { | |
505 | goto fail; | |
506 | } | |
507 | ||
508 | return job; | |
509 | ||
510 | fail: | |
511 | job_early_fail(&job->job); | |
512 | return NULL; | |
513 | } | |
514 | ||
515 | void block_job_iostatus_reset_locked(BlockJob *job) | |
516 | { | |
517 | GLOBAL_STATE_CODE(); | |
518 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { | |
519 | return; | |
520 | } | |
521 | assert(job->job.user_paused && job->job.pause_count > 0); | |
522 | job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; | |
523 | } | |
524 | ||
525 | static void block_job_iostatus_reset(BlockJob *job) | |
526 | { | |
527 | JOB_LOCK_GUARD(); | |
528 | block_job_iostatus_reset_locked(job); | |
529 | } | |
530 | ||
531 | void block_job_user_resume(Job *job) | |
532 | { | |
533 | BlockJob *bjob = container_of(job, BlockJob, job); | |
534 | GLOBAL_STATE_CODE(); | |
535 | block_job_iostatus_reset(bjob); | |
536 | } | |
537 | ||
538 | BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, | |
539 | int is_read, int error) | |
540 | { | |
541 | BlockErrorAction action; | |
542 | IO_CODE(); | |
543 | ||
544 | switch (on_err) { | |
545 | case BLOCKDEV_ON_ERROR_ENOSPC: | |
546 | case BLOCKDEV_ON_ERROR_AUTO: | |
547 | action = (error == ENOSPC) ? | |
548 | BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; | |
549 | break; | |
550 | case BLOCKDEV_ON_ERROR_STOP: | |
551 | action = BLOCK_ERROR_ACTION_STOP; | |
552 | break; | |
553 | case BLOCKDEV_ON_ERROR_REPORT: | |
554 | action = BLOCK_ERROR_ACTION_REPORT; | |
555 | break; | |
556 | case BLOCKDEV_ON_ERROR_IGNORE: | |
557 | action = BLOCK_ERROR_ACTION_IGNORE; | |
558 | break; | |
559 | default: | |
560 | abort(); | |
561 | } | |
562 | if (!block_job_is_internal(job)) { | |
563 | qapi_event_send_block_job_error(job->job.id, | |
564 | is_read ? IO_OPERATION_TYPE_READ : | |
565 | IO_OPERATION_TYPE_WRITE, | |
566 | action); | |
567 | } | |
568 | if (action == BLOCK_ERROR_ACTION_STOP) { | |
569 | WITH_JOB_LOCK_GUARD() { | |
570 | if (!job->job.user_paused) { | |
571 | job_pause_locked(&job->job); | |
572 | /* | |
573 | * make the pause user visible, which will be | |
574 | * resumed from QMP. | |
575 | */ | |
576 | job->job.user_paused = true; | |
577 | } | |
578 | block_job_iostatus_set_err_locked(job, error); | |
579 | } | |
580 | } | |
581 | return action; | |
582 | } | |
583 | ||
584 | AioContext *block_job_get_aio_context(BlockJob *job) | |
585 | { | |
586 | GLOBAL_STATE_CODE(); | |
587 | return job->job.aio_context; | |
588 | } |