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