]>
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" |
373340b2 | 31 | #include "sysemu/block-backend.h" |
cc7a8ea7 | 32 | #include "qapi/qmp/qerror.h" |
7b1b5d19 | 33 | #include "qapi/qmp/qjson.h" |
10817bf0 | 34 | #include "qemu/coroutine.h" |
7f0317cf | 35 | #include "qemu/id.h" |
2f0c9fe6 | 36 | #include "qmp-commands.h" |
1de7afc9 | 37 | #include "qemu/timer.h" |
5a2d2cbd | 38 | #include "qapi-event.h" |
2f0c9fe6 | 39 | |
8254b6d9 JS |
40 | static void block_job_event_cancelled(BlockJob *job); |
41 | static void block_job_event_completed(BlockJob *job, const char *msg); | |
42 | ||
c55a832f FZ |
43 | /* Transactional group of block jobs */ |
44 | struct BlockJobTxn { | |
45 | ||
46 | /* Is this txn being cancelled? */ | |
47 | bool aborting; | |
48 | ||
49 | /* List of jobs */ | |
50 | QLIST_HEAD(, BlockJob) jobs; | |
51 | ||
52 | /* Reference count */ | |
53 | int refcnt; | |
54 | }; | |
55 | ||
a7112795 AG |
56 | static QLIST_HEAD(, BlockJob) block_jobs = QLIST_HEAD_INITIALIZER(block_jobs); |
57 | ||
76d554e2 KW |
58 | static char *child_job_get_parent_desc(BdrvChild *c) |
59 | { | |
60 | BlockJob *job = c->opaque; | |
61 | return g_strdup_printf("%s job '%s'", | |
62 | BlockJobType_lookup[job->driver->job_type], | |
63 | job->id); | |
64 | } | |
65 | ||
66 | static const BdrvChildRole child_job = { | |
67 | .get_parent_desc = child_job_get_parent_desc, | |
68 | .stay_at_node = true, | |
69 | }; | |
70 | ||
600ac6a0 JS |
71 | static void block_job_drained_begin(void *opaque) |
72 | { | |
73 | BlockJob *job = opaque; | |
74 | block_job_pause(job); | |
75 | } | |
76 | ||
77 | static void block_job_drained_end(void *opaque) | |
78 | { | |
79 | BlockJob *job = opaque; | |
80 | block_job_resume(job); | |
81 | } | |
82 | ||
83 | static const BlockDevOps block_job_dev_ops = { | |
84 | .drained_begin = block_job_drained_begin, | |
85 | .drained_end = block_job_drained_end, | |
86 | }; | |
87 | ||
a7112795 AG |
88 | BlockJob *block_job_next(BlockJob *job) |
89 | { | |
90 | if (!job) { | |
91 | return QLIST_FIRST(&block_jobs); | |
92 | } | |
93 | return QLIST_NEXT(job, job_list); | |
94 | } | |
95 | ||
ffb1f10c AG |
96 | BlockJob *block_job_get(const char *id) |
97 | { | |
98 | BlockJob *job; | |
99 | ||
100 | QLIST_FOREACH(job, &block_jobs, job_list) { | |
559b935f | 101 | if (job->id && !strcmp(id, job->id)) { |
ffb1f10c AG |
102 | return job; |
103 | } | |
104 | } | |
105 | ||
106 | return NULL; | |
107 | } | |
108 | ||
05b0d8e3 PB |
109 | static void block_job_ref(BlockJob *job) |
110 | { | |
111 | ++job->refcnt; | |
112 | } | |
113 | ||
114 | static void block_job_attached_aio_context(AioContext *new_context, | |
115 | void *opaque); | |
116 | static void block_job_detach_aio_context(void *opaque); | |
117 | ||
118 | static void block_job_unref(BlockJob *job) | |
119 | { | |
120 | if (--job->refcnt == 0) { | |
121 | BlockDriverState *bs = blk_bs(job->blk); | |
122 | bs->job = NULL; | |
123 | block_job_remove_all_bdrv(job); | |
124 | blk_remove_aio_context_notifier(job->blk, | |
125 | block_job_attached_aio_context, | |
126 | block_job_detach_aio_context, job); | |
127 | blk_unref(job->blk); | |
128 | error_free(job->blocker); | |
129 | g_free(job->id); | |
130 | QLIST_REMOVE(job, job_list); | |
131 | g_free(job); | |
132 | } | |
133 | } | |
134 | ||
463e0be1 SH |
135 | static void block_job_attached_aio_context(AioContext *new_context, |
136 | void *opaque) | |
137 | { | |
138 | BlockJob *job = opaque; | |
139 | ||
140 | if (job->driver->attached_aio_context) { | |
141 | job->driver->attached_aio_context(job, new_context); | |
142 | } | |
143 | ||
144 | block_job_resume(job); | |
145 | } | |
146 | ||
bae8196d PB |
147 | static void block_job_drain(BlockJob *job) |
148 | { | |
149 | /* If job is !job->busy this kicks it into the next pause point. */ | |
150 | block_job_enter(job); | |
151 | ||
152 | blk_drain(job->blk); | |
153 | if (job->driver->drain) { | |
154 | job->driver->drain(job); | |
155 | } | |
156 | } | |
157 | ||
463e0be1 SH |
158 | static void block_job_detach_aio_context(void *opaque) |
159 | { | |
160 | BlockJob *job = opaque; | |
161 | ||
162 | /* In case the job terminates during aio_poll()... */ | |
163 | block_job_ref(job); | |
164 | ||
165 | block_job_pause(job); | |
166 | ||
463e0be1 | 167 | while (!job->paused && !job->completed) { |
bae8196d | 168 | block_job_drain(job); |
463e0be1 SH |
169 | } |
170 | ||
171 | block_job_unref(job); | |
172 | } | |
173 | ||
bbc02b90 KW |
174 | void block_job_remove_all_bdrv(BlockJob *job) |
175 | { | |
176 | GSList *l; | |
177 | for (l = job->nodes; l; l = l->next) { | |
178 | BdrvChild *c = l->data; | |
179 | bdrv_op_unblock_all(c->bs, job->blocker); | |
180 | bdrv_root_unref_child(c); | |
181 | } | |
182 | g_slist_free(job->nodes); | |
183 | job->nodes = NULL; | |
184 | } | |
185 | ||
76d554e2 KW |
186 | int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, |
187 | uint64_t perm, uint64_t shared_perm, Error **errp) | |
23d402d4 | 188 | { |
76d554e2 KW |
189 | BdrvChild *c; |
190 | ||
191 | c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm, | |
192 | job, errp); | |
193 | if (c == NULL) { | |
194 | return -EPERM; | |
195 | } | |
196 | ||
197 | job->nodes = g_slist_prepend(job->nodes, c); | |
23d402d4 AG |
198 | bdrv_ref(bs); |
199 | bdrv_op_block_all(bs, job->blocker); | |
76d554e2 KW |
200 | |
201 | return 0; | |
23d402d4 AG |
202 | } |
203 | ||
7f0317cf | 204 | void *block_job_create(const char *job_id, const BlockJobDriver *driver, |
c6cc12bf KW |
205 | BlockDriverState *bs, uint64_t perm, |
206 | uint64_t shared_perm, int64_t speed, int flags, | |
7f0317cf | 207 | BlockCompletionFunc *cb, void *opaque, Error **errp) |
2f0c9fe6 | 208 | { |
b6d2e599 | 209 | BlockBackend *blk; |
2f0c9fe6 | 210 | BlockJob *job; |
d7086422 | 211 | int ret; |
2f0c9fe6 | 212 | |
628ff683 | 213 | if (bs->job) { |
c6bd8c70 | 214 | error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); |
2f0c9fe6 PB |
215 | return NULL; |
216 | } | |
b6d2e599 | 217 | |
f81e0b45 | 218 | if (job_id == NULL && !(flags & BLOCK_JOB_INTERNAL)) { |
7f0317cf | 219 | job_id = bdrv_get_device_name(bs); |
1562047c KW |
220 | if (!*job_id) { |
221 | error_setg(errp, "An explicit job ID is required for this node"); | |
222 | return NULL; | |
223 | } | |
7f0317cf AG |
224 | } |
225 | ||
f81e0b45 JS |
226 | if (job_id) { |
227 | if (flags & BLOCK_JOB_INTERNAL) { | |
228 | error_setg(errp, "Cannot specify job ID for internal block job"); | |
229 | return NULL; | |
230 | } | |
7f0317cf | 231 | |
f81e0b45 JS |
232 | if (!id_wellformed(job_id)) { |
233 | error_setg(errp, "Invalid job ID '%s'", job_id); | |
234 | return NULL; | |
235 | } | |
236 | ||
237 | if (block_job_get(job_id)) { | |
238 | error_setg(errp, "Job ID '%s' already in use", job_id); | |
239 | return NULL; | |
240 | } | |
7f0317cf AG |
241 | } |
242 | ||
c6cc12bf | 243 | blk = blk_new(perm, shared_perm); |
d7086422 KW |
244 | ret = blk_insert_bs(blk, bs, errp); |
245 | if (ret < 0) { | |
246 | blk_unref(blk); | |
247 | return NULL; | |
248 | } | |
b6d2e599 | 249 | |
3fc4b10a FZ |
250 | job = g_malloc0(driver->instance_size); |
251 | job->driver = driver; | |
7f0317cf | 252 | job->id = g_strdup(job_id); |
b6d2e599 | 253 | job->blk = blk; |
2f0c9fe6 PB |
254 | job->cb = cb; |
255 | job->opaque = opaque; | |
5ccac6f1 JS |
256 | job->busy = false; |
257 | job->paused = true; | |
258 | job->pause_count = 1; | |
18930ba3 | 259 | job->refcnt = 1; |
600ac6a0 JS |
260 | |
261 | error_setg(&job->blocker, "block device is in use by block job: %s", | |
262 | BlockJobType_lookup[driver->job_type]); | |
263 | block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); | |
2f0c9fe6 PB |
264 | bs->job = job; |
265 | ||
600ac6a0 JS |
266 | blk_set_dev_ops(blk, &block_job_dev_ops, job); |
267 | bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); | |
268 | ||
a7112795 AG |
269 | QLIST_INSERT_HEAD(&block_jobs, job, job_list); |
270 | ||
463e0be1 SH |
271 | blk_add_aio_context_notifier(blk, block_job_attached_aio_context, |
272 | block_job_detach_aio_context, job); | |
273 | ||
2f0c9fe6 PB |
274 | /* Only set speed when necessary to avoid NotSupported error */ |
275 | if (speed != 0) { | |
276 | Error *local_err = NULL; | |
277 | ||
278 | block_job_set_speed(job, speed, &local_err); | |
84d18f06 | 279 | if (local_err) { |
18930ba3 | 280 | block_job_unref(job); |
2f0c9fe6 PB |
281 | error_propagate(errp, local_err); |
282 | return NULL; | |
283 | } | |
284 | } | |
285 | return job; | |
286 | } | |
287 | ||
559b935f JS |
288 | bool block_job_is_internal(BlockJob *job) |
289 | { | |
290 | return (job->id == NULL); | |
291 | } | |
292 | ||
5ccac6f1 JS |
293 | static bool block_job_started(BlockJob *job) |
294 | { | |
295 | return job->co; | |
296 | } | |
297 | ||
e3796a24 JS |
298 | /** |
299 | * All jobs must allow a pause point before entering their job proper. This | |
300 | * ensures that jobs can be paused prior to being started, then resumed later. | |
301 | */ | |
302 | static void coroutine_fn block_job_co_entry(void *opaque) | |
303 | { | |
304 | BlockJob *job = opaque; | |
305 | ||
306 | assert(job && job->driver && job->driver->start); | |
307 | block_job_pause_point(job); | |
308 | job->driver->start(job); | |
309 | } | |
310 | ||
5ccac6f1 JS |
311 | void block_job_start(BlockJob *job) |
312 | { | |
313 | assert(job && !block_job_started(job) && job->paused && | |
e3796a24 JS |
314 | job->driver && job->driver->start); |
315 | job->co = qemu_coroutine_create(block_job_co_entry, job); | |
316 | job->pause_count--; | |
317 | job->busy = true; | |
318 | job->paused = false; | |
aef4278c | 319 | bdrv_coroutine_enter(blk_bs(job->blk), job->co); |
5ccac6f1 JS |
320 | } |
321 | ||
05b0d8e3 | 322 | void block_job_early_fail(BlockJob *job) |
18930ba3 | 323 | { |
05b0d8e3 | 324 | block_job_unref(job); |
2f0c9fe6 PB |
325 | } |
326 | ||
c55a832f FZ |
327 | static void block_job_completed_single(BlockJob *job) |
328 | { | |
329 | if (!job->ret) { | |
330 | if (job->driver->commit) { | |
331 | job->driver->commit(job); | |
332 | } | |
333 | } else { | |
334 | if (job->driver->abort) { | |
335 | job->driver->abort(job); | |
336 | } | |
337 | } | |
e8a40bf7 JS |
338 | if (job->driver->clean) { |
339 | job->driver->clean(job); | |
340 | } | |
8254b6d9 JS |
341 | |
342 | if (job->cb) { | |
343 | job->cb(job->opaque, job->ret); | |
344 | } | |
5ccac6f1 JS |
345 | |
346 | /* Emit events only if we actually started */ | |
347 | if (block_job_started(job)) { | |
348 | if (block_job_is_cancelled(job)) { | |
349 | block_job_event_cancelled(job); | |
350 | } else { | |
351 | const char *msg = NULL; | |
352 | if (job->ret < 0) { | |
353 | msg = strerror(-job->ret); | |
354 | } | |
355 | block_job_event_completed(job, msg); | |
8254b6d9 | 356 | } |
8254b6d9 JS |
357 | } |
358 | ||
c55a832f | 359 | if (job->txn) { |
1e93b9fb | 360 | QLIST_REMOVE(job, txn_list); |
c55a832f FZ |
361 | block_job_txn_unref(job->txn); |
362 | } | |
363 | block_job_unref(job); | |
364 | } | |
365 | ||
366 | static void block_job_completed_txn_abort(BlockJob *job) | |
367 | { | |
368 | AioContext *ctx; | |
369 | BlockJobTxn *txn = job->txn; | |
370 | BlockJob *other_job, *next; | |
371 | ||
372 | if (txn->aborting) { | |
373 | /* | |
374 | * We are cancelled by another job, which will handle everything. | |
375 | */ | |
376 | return; | |
377 | } | |
378 | txn->aborting = true; | |
379 | /* We are the first failed job. Cancel other jobs. */ | |
380 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { | |
b6d2e599 | 381 | ctx = blk_get_aio_context(other_job->blk); |
c55a832f FZ |
382 | aio_context_acquire(ctx); |
383 | } | |
384 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { | |
385 | if (other_job == job || other_job->completed) { | |
386 | /* Other jobs are "effectively" cancelled by us, set the status for | |
387 | * them; this job, however, may or may not be cancelled, depending | |
388 | * on the caller, so leave it. */ | |
389 | if (other_job != job) { | |
390 | other_job->cancelled = true; | |
391 | } | |
392 | continue; | |
393 | } | |
394 | block_job_cancel_sync(other_job); | |
395 | assert(other_job->completed); | |
396 | } | |
397 | QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { | |
b6d2e599 | 398 | ctx = blk_get_aio_context(other_job->blk); |
c55a832f FZ |
399 | block_job_completed_single(other_job); |
400 | aio_context_release(ctx); | |
401 | } | |
402 | } | |
403 | ||
404 | static void block_job_completed_txn_success(BlockJob *job) | |
405 | { | |
406 | AioContext *ctx; | |
407 | BlockJobTxn *txn = job->txn; | |
408 | BlockJob *other_job, *next; | |
409 | /* | |
410 | * Successful completion, see if there are other running jobs in this | |
411 | * txn. | |
412 | */ | |
413 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { | |
414 | if (!other_job->completed) { | |
415 | return; | |
416 | } | |
417 | } | |
418 | /* We are the last completed job, commit the transaction. */ | |
419 | QLIST_FOREACH_SAFE(other_job, &txn->jobs, txn_list, next) { | |
b6d2e599 | 420 | ctx = blk_get_aio_context(other_job->blk); |
c55a832f FZ |
421 | aio_context_acquire(ctx); |
422 | assert(other_job->ret == 0); | |
423 | block_job_completed_single(other_job); | |
424 | aio_context_release(ctx); | |
425 | } | |
426 | } | |
427 | ||
97031164 TW |
428 | void block_job_completed(BlockJob *job, int ret) |
429 | { | |
b6d2e599 | 430 | assert(blk_bs(job->blk)->job == job); |
a689dbf2 FZ |
431 | assert(!job->completed); |
432 | job->completed = true; | |
433 | job->ret = ret; | |
c55a832f FZ |
434 | if (!job->txn) { |
435 | block_job_completed_single(job); | |
436 | } else if (ret < 0 || block_job_is_cancelled(job)) { | |
437 | block_job_completed_txn_abort(job); | |
438 | } else { | |
439 | block_job_completed_txn_success(job); | |
440 | } | |
97031164 TW |
441 | } |
442 | ||
2f0c9fe6 PB |
443 | void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) |
444 | { | |
445 | Error *local_err = NULL; | |
446 | ||
3fc4b10a | 447 | if (!job->driver->set_speed) { |
c6bd8c70 | 448 | error_setg(errp, QERR_UNSUPPORTED); |
2f0c9fe6 PB |
449 | return; |
450 | } | |
3fc4b10a | 451 | job->driver->set_speed(job, speed, &local_err); |
84d18f06 | 452 | if (local_err) { |
2f0c9fe6 PB |
453 | error_propagate(errp, local_err); |
454 | return; | |
455 | } | |
456 | ||
457 | job->speed = speed; | |
458 | } | |
459 | ||
aeae883b PB |
460 | void block_job_complete(BlockJob *job, Error **errp) |
461 | { | |
559b935f JS |
462 | /* Should not be reachable via external interface for internal jobs */ |
463 | assert(job->id); | |
5ccac6f1 JS |
464 | if (job->pause_count || job->cancelled || |
465 | !block_job_started(job) || !job->driver->complete) { | |
9df229c3 AG |
466 | error_setg(errp, "The active block job '%s' cannot be completed", |
467 | job->id); | |
aeae883b PB |
468 | return; |
469 | } | |
470 | ||
3fc4b10a | 471 | job->driver->complete(job, errp); |
aeae883b PB |
472 | } |
473 | ||
8acc72a4 | 474 | void block_job_pause(BlockJob *job) |
2f0c9fe6 | 475 | { |
751ebd76 | 476 | job->pause_count++; |
8acc72a4 PB |
477 | } |
478 | ||
0df4ba58 JS |
479 | void block_job_user_pause(BlockJob *job) |
480 | { | |
481 | job->user_paused = true; | |
482 | block_job_pause(job); | |
483 | } | |
484 | ||
a7f3b7ff | 485 | static bool block_job_should_pause(BlockJob *job) |
8acc72a4 | 486 | { |
751ebd76 | 487 | return job->pause_count > 0; |
8acc72a4 PB |
488 | } |
489 | ||
0df4ba58 JS |
490 | bool block_job_user_paused(BlockJob *job) |
491 | { | |
6573d9c6 | 492 | return job->user_paused; |
0df4ba58 JS |
493 | } |
494 | ||
fc9c0a9c SH |
495 | void coroutine_fn block_job_pause_point(BlockJob *job) |
496 | { | |
5ccac6f1 JS |
497 | assert(job && block_job_started(job)); |
498 | ||
fc9c0a9c SH |
499 | if (!block_job_should_pause(job)) { |
500 | return; | |
501 | } | |
502 | if (block_job_is_cancelled(job)) { | |
503 | return; | |
504 | } | |
505 | ||
506 | if (job->driver->pause) { | |
507 | job->driver->pause(job); | |
508 | } | |
509 | ||
510 | if (block_job_should_pause(job) && !block_job_is_cancelled(job)) { | |
511 | job->paused = true; | |
512 | job->busy = false; | |
513 | qemu_coroutine_yield(); /* wait for block_job_resume() */ | |
514 | job->busy = true; | |
515 | job->paused = false; | |
516 | } | |
517 | ||
518 | if (job->driver->resume) { | |
519 | job->driver->resume(job); | |
520 | } | |
521 | } | |
522 | ||
8acc72a4 PB |
523 | void block_job_resume(BlockJob *job) |
524 | { | |
751ebd76 FZ |
525 | assert(job->pause_count > 0); |
526 | job->pause_count--; | |
527 | if (job->pause_count) { | |
528 | return; | |
529 | } | |
530 | block_job_enter(job); | |
531 | } | |
532 | ||
0df4ba58 JS |
533 | void block_job_user_resume(BlockJob *job) |
534 | { | |
535 | if (job && job->user_paused && job->pause_count > 0) { | |
536 | job->user_paused = false; | |
537 | block_job_resume(job); | |
538 | } | |
539 | } | |
540 | ||
751ebd76 FZ |
541 | void block_job_enter(BlockJob *job) |
542 | { | |
2f0c9fe6 | 543 | if (job->co && !job->busy) { |
aef4278c | 544 | bdrv_coroutine_enter(blk_bs(job->blk), job->co); |
2f0c9fe6 PB |
545 | } |
546 | } | |
547 | ||
8acc72a4 PB |
548 | void block_job_cancel(BlockJob *job) |
549 | { | |
5ccac6f1 JS |
550 | if (block_job_started(job)) { |
551 | job->cancelled = true; | |
552 | block_job_iostatus_reset(job); | |
553 | block_job_enter(job); | |
554 | } else { | |
555 | block_job_completed(job, -ECANCELED); | |
556 | } | |
8acc72a4 PB |
557 | } |
558 | ||
2f0c9fe6 PB |
559 | bool block_job_is_cancelled(BlockJob *job) |
560 | { | |
561 | return job->cancelled; | |
562 | } | |
563 | ||
32c81a4a PB |
564 | void block_job_iostatus_reset(BlockJob *job) |
565 | { | |
566 | job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; | |
567 | } | |
568 | ||
345f9e1b HR |
569 | static int block_job_finish_sync(BlockJob *job, |
570 | void (*finish)(BlockJob *, Error **errp), | |
571 | Error **errp) | |
2f0c9fe6 | 572 | { |
345f9e1b | 573 | Error *local_err = NULL; |
94db6d2d | 574 | int ret; |
2f0c9fe6 | 575 | |
b6d2e599 | 576 | assert(blk_bs(job->blk)->job == job); |
2f0c9fe6 | 577 | |
94db6d2d | 578 | block_job_ref(job); |
bae8196d | 579 | |
345f9e1b HR |
580 | finish(job, &local_err); |
581 | if (local_err) { | |
582 | error_propagate(errp, local_err); | |
94db6d2d | 583 | block_job_unref(job); |
345f9e1b HR |
584 | return -EBUSY; |
585 | } | |
bae8196d PB |
586 | /* block_job_drain calls block_job_enter, and it should be enough to |
587 | * induce progress until the job completes or moves to the main thread. | |
588 | */ | |
589 | while (!job->deferred_to_main_loop && !job->completed) { | |
590 | block_job_drain(job); | |
591 | } | |
94db6d2d | 592 | while (!job->completed) { |
bae8196d | 593 | aio_poll(qemu_get_aio_context(), true); |
2f0c9fe6 | 594 | } |
94db6d2d FZ |
595 | ret = (job->cancelled && job->ret == 0) ? -ECANCELED : job->ret; |
596 | block_job_unref(job); | |
597 | return ret; | |
2f0c9fe6 PB |
598 | } |
599 | ||
345f9e1b HR |
600 | /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be |
601 | * used with block_job_finish_sync() without the need for (rather nasty) | |
602 | * function pointer casts there. */ | |
603 | static void block_job_cancel_err(BlockJob *job, Error **errp) | |
604 | { | |
605 | block_job_cancel(job); | |
606 | } | |
607 | ||
608 | int block_job_cancel_sync(BlockJob *job) | |
609 | { | |
610 | return block_job_finish_sync(job, &block_job_cancel_err, NULL); | |
611 | } | |
612 | ||
a1a2af07 KW |
613 | void block_job_cancel_sync_all(void) |
614 | { | |
615 | BlockJob *job; | |
616 | AioContext *aio_context; | |
617 | ||
618 | while ((job = QLIST_FIRST(&block_jobs))) { | |
b6d2e599 | 619 | aio_context = blk_get_aio_context(job->blk); |
a1a2af07 KW |
620 | aio_context_acquire(aio_context); |
621 | block_job_cancel_sync(job); | |
622 | aio_context_release(aio_context); | |
623 | } | |
624 | } | |
625 | ||
345f9e1b HR |
626 | int block_job_complete_sync(BlockJob *job, Error **errp) |
627 | { | |
628 | return block_job_finish_sync(job, &block_job_complete, errp); | |
629 | } | |
630 | ||
7483d1e5 | 631 | void block_job_sleep_ns(BlockJob *job, QEMUClockType type, int64_t ns) |
2f0c9fe6 | 632 | { |
8acc72a4 PB |
633 | assert(job->busy); |
634 | ||
2f0c9fe6 | 635 | /* Check cancellation *before* setting busy = false, too! */ |
8acc72a4 PB |
636 | if (block_job_is_cancelled(job)) { |
637 | return; | |
638 | } | |
639 | ||
640 | job->busy = false; | |
a7f3b7ff | 641 | if (!block_job_should_pause(job)) { |
0824afda AG |
642 | co_aio_sleep_ns(blk_get_aio_context(job->blk), type, ns); |
643 | } | |
8acc72a4 | 644 | job->busy = true; |
fc9c0a9c SH |
645 | |
646 | block_job_pause_point(job); | |
2f0c9fe6 | 647 | } |
30e628b7 | 648 | |
dc71ce45 FZ |
649 | void block_job_yield(BlockJob *job) |
650 | { | |
651 | assert(job->busy); | |
652 | ||
653 | /* Check cancellation *before* setting busy = false, too! */ | |
654 | if (block_job_is_cancelled(job)) { | |
655 | return; | |
656 | } | |
657 | ||
658 | job->busy = false; | |
fc9c0a9c SH |
659 | if (!block_job_should_pause(job)) { |
660 | qemu_coroutine_yield(); | |
661 | } | |
dc71ce45 | 662 | job->busy = true; |
fc9c0a9c SH |
663 | |
664 | block_job_pause_point(job); | |
dc71ce45 FZ |
665 | } |
666 | ||
559b935f | 667 | BlockJobInfo *block_job_query(BlockJob *job, Error **errp) |
30e628b7 | 668 | { |
559b935f JS |
669 | BlockJobInfo *info; |
670 | ||
671 | if (block_job_is_internal(job)) { | |
672 | error_setg(errp, "Cannot query QEMU internal jobs"); | |
673 | return NULL; | |
674 | } | |
675 | info = g_new0(BlockJobInfo, 1); | |
79e14bf7 | 676 | info->type = g_strdup(BlockJobType_lookup[job->driver->job_type]); |
8ccb9569 | 677 | info->device = g_strdup(job->id); |
32c81a4a PB |
678 | info->len = job->len; |
679 | info->busy = job->busy; | |
751ebd76 | 680 | info->paused = job->pause_count > 0; |
32c81a4a PB |
681 | info->offset = job->offset; |
682 | info->speed = job->speed; | |
683 | info->io_status = job->iostatus; | |
ef6dbf1e | 684 | info->ready = job->ready; |
30e628b7 PB |
685 | return info; |
686 | } | |
32c81a4a PB |
687 | |
688 | static void block_job_iostatus_set_err(BlockJob *job, int error) | |
689 | { | |
690 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { | |
691 | job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : | |
692 | BLOCK_DEVICE_IO_STATUS_FAILED; | |
693 | } | |
694 | } | |
695 | ||
8254b6d9 | 696 | static void block_job_event_cancelled(BlockJob *job) |
bcada37b | 697 | { |
559b935f JS |
698 | if (block_job_is_internal(job)) { |
699 | return; | |
700 | } | |
701 | ||
bcada37b | 702 | qapi_event_send_block_job_cancelled(job->driver->job_type, |
8ccb9569 | 703 | job->id, |
bcada37b WX |
704 | job->len, |
705 | job->offset, | |
706 | job->speed, | |
707 | &error_abort); | |
708 | } | |
32c81a4a | 709 | |
8254b6d9 | 710 | static void block_job_event_completed(BlockJob *job, const char *msg) |
a66a2a36 | 711 | { |
559b935f JS |
712 | if (block_job_is_internal(job)) { |
713 | return; | |
714 | } | |
715 | ||
bcada37b | 716 | qapi_event_send_block_job_completed(job->driver->job_type, |
8ccb9569 | 717 | job->id, |
bcada37b WX |
718 | job->len, |
719 | job->offset, | |
720 | job->speed, | |
721 | !!msg, | |
722 | msg, | |
723 | &error_abort); | |
a66a2a36 PB |
724 | } |
725 | ||
bcada37b | 726 | void block_job_event_ready(BlockJob *job) |
a66a2a36 | 727 | { |
ef6dbf1e HR |
728 | job->ready = true; |
729 | ||
559b935f JS |
730 | if (block_job_is_internal(job)) { |
731 | return; | |
732 | } | |
733 | ||
518848a2 | 734 | qapi_event_send_block_job_ready(job->driver->job_type, |
8ccb9569 | 735 | job->id, |
518848a2 MA |
736 | job->len, |
737 | job->offset, | |
738 | job->speed, &error_abort); | |
a66a2a36 PB |
739 | } |
740 | ||
81e254dc | 741 | BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, |
32c81a4a PB |
742 | int is_read, int error) |
743 | { | |
744 | BlockErrorAction action; | |
745 | ||
746 | switch (on_err) { | |
747 | case BLOCKDEV_ON_ERROR_ENOSPC: | |
8c398252 | 748 | case BLOCKDEV_ON_ERROR_AUTO: |
a589569f WX |
749 | action = (error == ENOSPC) ? |
750 | BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; | |
32c81a4a PB |
751 | break; |
752 | case BLOCKDEV_ON_ERROR_STOP: | |
a589569f | 753 | action = BLOCK_ERROR_ACTION_STOP; |
32c81a4a PB |
754 | break; |
755 | case BLOCKDEV_ON_ERROR_REPORT: | |
a589569f | 756 | action = BLOCK_ERROR_ACTION_REPORT; |
32c81a4a PB |
757 | break; |
758 | case BLOCKDEV_ON_ERROR_IGNORE: | |
a589569f | 759 | action = BLOCK_ERROR_ACTION_IGNORE; |
32c81a4a PB |
760 | break; |
761 | default: | |
762 | abort(); | |
763 | } | |
559b935f JS |
764 | if (!block_job_is_internal(job)) { |
765 | qapi_event_send_block_job_error(job->id, | |
766 | is_read ? IO_OPERATION_TYPE_READ : | |
767 | IO_OPERATION_TYPE_WRITE, | |
768 | action, &error_abort); | |
769 | } | |
a589569f | 770 | if (action == BLOCK_ERROR_ACTION_STOP) { |
751ebd76 | 771 | /* make the pause user visible, which will be resumed from QMP. */ |
0df4ba58 | 772 | block_job_user_pause(job); |
32c81a4a | 773 | block_job_iostatus_set_err(job, error); |
32c81a4a PB |
774 | } |
775 | return action; | |
776 | } | |
dec7d421 SH |
777 | |
778 | typedef struct { | |
779 | BlockJob *job; | |
dec7d421 SH |
780 | AioContext *aio_context; |
781 | BlockJobDeferToMainLoopFn *fn; | |
782 | void *opaque; | |
783 | } BlockJobDeferToMainLoopData; | |
784 | ||
785 | static void block_job_defer_to_main_loop_bh(void *opaque) | |
786 | { | |
787 | BlockJobDeferToMainLoopData *data = opaque; | |
788 | AioContext *aio_context; | |
789 | ||
dec7d421 SH |
790 | /* Prevent race with block_job_defer_to_main_loop() */ |
791 | aio_context_acquire(data->aio_context); | |
792 | ||
793 | /* Fetch BDS AioContext again, in case it has changed */ | |
b6d2e599 | 794 | aio_context = blk_get_aio_context(data->job->blk); |
d79df2a2 PB |
795 | if (aio_context != data->aio_context) { |
796 | aio_context_acquire(aio_context); | |
797 | } | |
dec7d421 | 798 | |
794f0141 | 799 | data->job->deferred_to_main_loop = false; |
dec7d421 SH |
800 | data->fn(data->job, data->opaque); |
801 | ||
d79df2a2 PB |
802 | if (aio_context != data->aio_context) { |
803 | aio_context_release(aio_context); | |
804 | } | |
dec7d421 SH |
805 | |
806 | aio_context_release(data->aio_context); | |
807 | ||
808 | g_free(data); | |
809 | } | |
810 | ||
811 | void block_job_defer_to_main_loop(BlockJob *job, | |
812 | BlockJobDeferToMainLoopFn *fn, | |
813 | void *opaque) | |
814 | { | |
815 | BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data)); | |
816 | data->job = job; | |
b6d2e599 | 817 | data->aio_context = blk_get_aio_context(job->blk); |
dec7d421 SH |
818 | data->fn = fn; |
819 | data->opaque = opaque; | |
794f0141 | 820 | job->deferred_to_main_loop = true; |
dec7d421 | 821 | |
fffb6e12 PB |
822 | aio_bh_schedule_oneshot(qemu_get_aio_context(), |
823 | block_job_defer_to_main_loop_bh, data); | |
dec7d421 | 824 | } |
c55a832f FZ |
825 | |
826 | BlockJobTxn *block_job_txn_new(void) | |
827 | { | |
828 | BlockJobTxn *txn = g_new0(BlockJobTxn, 1); | |
829 | QLIST_INIT(&txn->jobs); | |
830 | txn->refcnt = 1; | |
831 | return txn; | |
832 | } | |
833 | ||
834 | static void block_job_txn_ref(BlockJobTxn *txn) | |
835 | { | |
836 | txn->refcnt++; | |
837 | } | |
838 | ||
839 | void block_job_txn_unref(BlockJobTxn *txn) | |
840 | { | |
841 | if (txn && --txn->refcnt == 0) { | |
842 | g_free(txn); | |
843 | } | |
844 | } | |
845 | ||
846 | void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job) | |
847 | { | |
848 | if (!txn) { | |
849 | return; | |
850 | } | |
851 | ||
852 | assert(!job->txn); | |
853 | job->txn = txn; | |
854 | ||
855 | QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); | |
856 | block_job_txn_ref(txn); | |
857 | } |