]>
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 | |
c55a832f | 39 | /* Transactional group of block jobs */ |
62c9e416 | 40 | struct JobTxn { |
c55a832f FZ |
41 | |
42 | /* Is this txn being cancelled? */ | |
43 | bool aborting; | |
44 | ||
45 | /* List of jobs */ | |
62c9e416 | 46 | QLIST_HEAD(, Job) jobs; |
c55a832f FZ |
47 | |
48 | /* Reference count */ | |
49 | int refcnt; | |
50 | }; | |
51 | ||
88691b37 PB |
52 | /* |
53 | * The block job API is composed of two categories of functions. | |
54 | * | |
55 | * The first includes functions used by the monitor. The monitor is | |
56 | * peculiar in that it accesses the block job list with block_job_get, and | |
57 | * therefore needs consistency across block_job_get and the actual operation | |
58 | * (e.g. block_job_set_speed). The consistency is achieved with | |
59 | * aio_context_acquire/release. These functions are declared in blockjob.h. | |
60 | * | |
61 | * The second includes functions used by the block job drivers and sometimes | |
62 | * by the core block layer. These do not care about locking, because the | |
63 | * whole coroutine runs under the AioContext lock, and are declared in | |
64 | * blockjob_int.h. | |
65 | */ | |
66 | ||
e7c1d78b | 67 | static bool is_block_job(Job *job) |
a7112795 | 68 | { |
e7c1d78b KW |
69 | return job_type(job) == JOB_TYPE_BACKUP || |
70 | job_type(job) == JOB_TYPE_COMMIT || | |
71 | job_type(job) == JOB_TYPE_MIRROR || | |
72 | job_type(job) == JOB_TYPE_STREAM; | |
73 | } | |
74 | ||
75 | BlockJob *block_job_next(BlockJob *bjob) | |
76 | { | |
77 | Job *job = bjob ? &bjob->job : NULL; | |
78 | ||
79 | do { | |
80 | job = job_next(job); | |
81 | } while (job && !is_block_job(job)); | |
82 | ||
83 | return job ? container_of(job, BlockJob, job) : NULL; | |
a7112795 AG |
84 | } |
85 | ||
ffb1f10c AG |
86 | BlockJob *block_job_get(const char *id) |
87 | { | |
e7c1d78b | 88 | Job *job = job_get(id); |
ffb1f10c | 89 | |
e7c1d78b KW |
90 | if (job && is_block_job(job)) { |
91 | return container_of(job, BlockJob, job); | |
92 | } else { | |
93 | return NULL; | |
ffb1f10c | 94 | } |
ffb1f10c AG |
95 | } |
96 | ||
62c9e416 | 97 | JobTxn *block_job_txn_new(void) |
c8ab5c2d | 98 | { |
62c9e416 | 99 | JobTxn *txn = g_new0(JobTxn, 1); |
c8ab5c2d PB |
100 | QLIST_INIT(&txn->jobs); |
101 | txn->refcnt = 1; | |
102 | return txn; | |
103 | } | |
104 | ||
62c9e416 | 105 | static void block_job_txn_ref(JobTxn *txn) |
c8ab5c2d PB |
106 | { |
107 | txn->refcnt++; | |
108 | } | |
109 | ||
62c9e416 | 110 | void block_job_txn_unref(JobTxn *txn) |
c8ab5c2d PB |
111 | { |
112 | if (txn && --txn->refcnt == 0) { | |
113 | g_free(txn); | |
114 | } | |
115 | } | |
116 | ||
62c9e416 | 117 | void block_job_txn_add_job(JobTxn *txn, BlockJob *job) |
c8ab5c2d PB |
118 | { |
119 | if (!txn) { | |
120 | return; | |
121 | } | |
122 | ||
123 | assert(!job->txn); | |
124 | job->txn = txn; | |
125 | ||
62c9e416 | 126 | QLIST_INSERT_HEAD(&txn->jobs, &job->job, txn_list); |
c8ab5c2d PB |
127 | block_job_txn_ref(txn); |
128 | } | |
129 | ||
4ad35181 | 130 | void block_job_txn_del_job(BlockJob *job) |
a865cebb MAL |
131 | { |
132 | if (job->txn) { | |
62c9e416 | 133 | QLIST_REMOVE(&job->job, txn_list); |
a865cebb MAL |
134 | block_job_txn_unref(job->txn); |
135 | job->txn = NULL; | |
136 | } | |
137 | } | |
138 | ||
05b0d8e3 PB |
139 | static void block_job_attached_aio_context(AioContext *new_context, |
140 | void *opaque); | |
141 | static void block_job_detach_aio_context(void *opaque); | |
142 | ||
80fa2c75 | 143 | void block_job_free(Job *job) |
05b0d8e3 | 144 | { |
80fa2c75 KW |
145 | BlockJob *bjob = container_of(job, BlockJob, job); |
146 | BlockDriverState *bs = blk_bs(bjob->blk); | |
147 | ||
148 | assert(!bjob->txn); | |
149 | ||
150 | bs->job = NULL; | |
151 | block_job_remove_all_bdrv(bjob); | |
152 | blk_remove_aio_context_notifier(bjob->blk, | |
153 | block_job_attached_aio_context, | |
154 | block_job_detach_aio_context, bjob); | |
155 | blk_unref(bjob->blk); | |
156 | error_free(bjob->blocker); | |
05b0d8e3 PB |
157 | } |
158 | ||
463e0be1 SH |
159 | static void block_job_attached_aio_context(AioContext *new_context, |
160 | void *opaque) | |
161 | { | |
162 | BlockJob *job = opaque; | |
163 | ||
08be6fe2 | 164 | job->job.aio_context = new_context; |
463e0be1 SH |
165 | if (job->driver->attached_aio_context) { |
166 | job->driver->attached_aio_context(job, new_context); | |
167 | } | |
168 | ||
b15de828 | 169 | job_resume(&job->job); |
463e0be1 SH |
170 | } |
171 | ||
b69f777d | 172 | void block_job_drain(Job *job) |
bae8196d | 173 | { |
b69f777d | 174 | BlockJob *bjob = container_of(job, BlockJob, job); |
bae8196d | 175 | |
b69f777d KW |
176 | blk_drain(bjob->blk); |
177 | if (bjob->driver->drain) { | |
178 | bjob->driver->drain(bjob); | |
bae8196d PB |
179 | } |
180 | } | |
181 | ||
463e0be1 SH |
182 | static void block_job_detach_aio_context(void *opaque) |
183 | { | |
184 | BlockJob *job = opaque; | |
185 | ||
186 | /* In case the job terminates during aio_poll()... */ | |
80fa2c75 | 187 | job_ref(&job->job); |
463e0be1 | 188 | |
b15de828 | 189 | job_pause(&job->job); |
463e0be1 | 190 | |
dbe5e6c1 | 191 | while (!job->job.paused && !job_is_completed(&job->job)) { |
b69f777d | 192 | job_drain(&job->job); |
463e0be1 SH |
193 | } |
194 | ||
08be6fe2 | 195 | job->job.aio_context = NULL; |
80fa2c75 | 196 | job_unref(&job->job); |
463e0be1 SH |
197 | } |
198 | ||
f321dcb5 PB |
199 | static char *child_job_get_parent_desc(BdrvChild *c) |
200 | { | |
201 | BlockJob *job = c->opaque; | |
252291ea | 202 | return g_strdup_printf("%s job '%s'", job_type_str(&job->job), job->job.id); |
f321dcb5 PB |
203 | } |
204 | ||
ad90feba | 205 | static void child_job_drained_begin(BdrvChild *c) |
f321dcb5 | 206 | { |
ad90feba | 207 | BlockJob *job = c->opaque; |
b15de828 | 208 | job_pause(&job->job); |
f321dcb5 PB |
209 | } |
210 | ||
ad90feba | 211 | static void child_job_drained_end(BdrvChild *c) |
f321dcb5 | 212 | { |
ad90feba | 213 | BlockJob *job = c->opaque; |
b15de828 | 214 | job_resume(&job->job); |
f321dcb5 PB |
215 | } |
216 | ||
ad90feba KW |
217 | static const BdrvChildRole child_job = { |
218 | .get_parent_desc = child_job_get_parent_desc, | |
219 | .drained_begin = child_job_drained_begin, | |
220 | .drained_end = child_job_drained_end, | |
221 | .stay_at_node = true, | |
f321dcb5 PB |
222 | }; |
223 | ||
bbc02b90 KW |
224 | void block_job_remove_all_bdrv(BlockJob *job) |
225 | { | |
226 | GSList *l; | |
227 | for (l = job->nodes; l; l = l->next) { | |
228 | BdrvChild *c = l->data; | |
229 | bdrv_op_unblock_all(c->bs, job->blocker); | |
230 | bdrv_root_unref_child(c); | |
231 | } | |
232 | g_slist_free(job->nodes); | |
233 | job->nodes = NULL; | |
234 | } | |
235 | ||
76d554e2 KW |
236 | int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, |
237 | uint64_t perm, uint64_t shared_perm, Error **errp) | |
23d402d4 | 238 | { |
76d554e2 KW |
239 | BdrvChild *c; |
240 | ||
241 | c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm, | |
242 | job, errp); | |
243 | if (c == NULL) { | |
244 | return -EPERM; | |
245 | } | |
246 | ||
247 | job->nodes = g_slist_prepend(job->nodes, c); | |
23d402d4 AG |
248 | bdrv_ref(bs); |
249 | bdrv_op_block_all(bs, job->blocker); | |
76d554e2 KW |
250 | |
251 | return 0; | |
23d402d4 AG |
252 | } |
253 | ||
559b935f JS |
254 | bool block_job_is_internal(BlockJob *job) |
255 | { | |
33e9e9bd | 256 | return (job->job.id == NULL); |
559b935f JS |
257 | } |
258 | ||
bd21935b KW |
259 | const BlockJobDriver *block_job_driver(BlockJob *job) |
260 | { | |
261 | return job->driver; | |
262 | } | |
263 | ||
2da4617a JS |
264 | static int block_job_prepare(BlockJob *job) |
265 | { | |
4ad35181 KW |
266 | if (job->job.ret == 0 && job->driver->prepare) { |
267 | job->job.ret = job->driver->prepare(job); | |
43628d93 | 268 | } |
4ad35181 | 269 | return job->job.ret; |
c55a832f FZ |
270 | } |
271 | ||
004e95df | 272 | static void job_cancel_async(Job *job, bool force) |
4c241cf5 | 273 | { |
004e95df KW |
274 | if (job->user_paused) { |
275 | /* Do not call job_enter here, the caller will handle it. */ | |
276 | job->user_paused = false; | |
277 | if (job->driver->user_resume) { | |
278 | job->driver->user_resume(job); | |
279 | } | |
280 | assert(job->pause_count > 0); | |
281 | job->pause_count--; | |
4c241cf5 | 282 | } |
004e95df | 283 | job->cancelled = true; |
b76e4458 | 284 | /* To prevent 'force == false' overriding a previous 'force == true' */ |
004e95df | 285 | job->force_cancel |= force; |
4c241cf5 PB |
286 | } |
287 | ||
62c9e416 | 288 | static int block_job_txn_apply(JobTxn *txn, int fn(BlockJob *), bool lock) |
efe4d4b7 JS |
289 | { |
290 | AioContext *ctx; | |
62c9e416 KW |
291 | Job *job, *next; |
292 | BlockJob *bjob; | |
2da4617a | 293 | int rc = 0; |
efe4d4b7 JS |
294 | |
295 | QLIST_FOREACH_SAFE(job, &txn->jobs, txn_list, next) { | |
62c9e416 KW |
296 | assert(is_block_job(job)); |
297 | bjob = container_of(job, BlockJob, job); | |
298 | ||
5f241594 | 299 | if (lock) { |
62c9e416 | 300 | ctx = job->aio_context; |
5f241594 JS |
301 | aio_context_acquire(ctx); |
302 | } | |
62c9e416 | 303 | rc = fn(bjob); |
5f241594 JS |
304 | if (lock) { |
305 | aio_context_release(ctx); | |
306 | } | |
2da4617a JS |
307 | if (rc) { |
308 | break; | |
309 | } | |
efe4d4b7 | 310 | } |
2da4617a | 311 | return rc; |
efe4d4b7 JS |
312 | } |
313 | ||
c55a832f FZ |
314 | static void block_job_completed_txn_abort(BlockJob *job) |
315 | { | |
316 | AioContext *ctx; | |
62c9e416 KW |
317 | JobTxn *txn = job->txn; |
318 | Job *other_job; | |
c55a832f FZ |
319 | |
320 | if (txn->aborting) { | |
321 | /* | |
322 | * We are cancelled by another job, which will handle everything. | |
323 | */ | |
324 | return; | |
325 | } | |
326 | txn->aborting = true; | |
4fb588e9 PB |
327 | block_job_txn_ref(txn); |
328 | ||
c55a832f FZ |
329 | /* We are the first failed job. Cancel other jobs. */ |
330 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { | |
62c9e416 | 331 | ctx = other_job->aio_context; |
c55a832f FZ |
332 | aio_context_acquire(ctx); |
333 | } | |
4fb588e9 PB |
334 | |
335 | /* Other jobs are effectively cancelled by us, set the status for | |
336 | * them; this job, however, may or may not be cancelled, depending | |
337 | * on the caller, so leave it. */ | |
c55a832f | 338 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { |
62c9e416 KW |
339 | if (other_job != &job->job) { |
340 | job_cancel_async(other_job, false); | |
c55a832f | 341 | } |
c55a832f | 342 | } |
4fb588e9 PB |
343 | while (!QLIST_EMPTY(&txn->jobs)) { |
344 | other_job = QLIST_FIRST(&txn->jobs); | |
62c9e416 KW |
345 | ctx = other_job->aio_context; |
346 | if (!job_is_completed(other_job)) { | |
347 | assert(job_is_cancelled(other_job)); | |
348 | job_finish_sync(other_job, NULL, NULL); | |
4fb588e9 | 349 | } |
62c9e416 | 350 | job_finalize_single(other_job); |
c55a832f FZ |
351 | aio_context_release(ctx); |
352 | } | |
4fb588e9 PB |
353 | |
354 | block_job_txn_unref(txn); | |
c55a832f FZ |
355 | } |
356 | ||
11b61fbc JS |
357 | static int block_job_needs_finalize(BlockJob *job) |
358 | { | |
bb02b65c | 359 | return !job->job.auto_finalize; |
11b61fbc JS |
360 | } |
361 | ||
4ad35181 KW |
362 | static int block_job_finalize_single(BlockJob *job) |
363 | { | |
364 | return job_finalize_single(&job->job); | |
365 | } | |
366 | ||
11b61fbc JS |
367 | static void block_job_do_finalize(BlockJob *job) |
368 | { | |
369 | int rc; | |
370 | assert(job && job->txn); | |
371 | ||
372 | /* prepare the transaction to complete */ | |
373 | rc = block_job_txn_apply(job->txn, block_job_prepare, true); | |
374 | if (rc) { | |
375 | block_job_completed_txn_abort(job); | |
376 | } else { | |
377 | block_job_txn_apply(job->txn, block_job_finalize_single, true); | |
378 | } | |
379 | } | |
380 | ||
5d4f3769 KW |
381 | static int block_job_transition_to_pending(BlockJob *job) |
382 | { | |
383 | job_state_transition(&job->job, JOB_STATUS_PENDING); | |
384 | if (!job->job.auto_finalize) { | |
139a9f02 | 385 | job_event_pending(&job->job); |
5d4f3769 KW |
386 | } |
387 | return 0; | |
388 | } | |
389 | ||
c55a832f FZ |
390 | static void block_job_completed_txn_success(BlockJob *job) |
391 | { | |
62c9e416 KW |
392 | JobTxn *txn = job->txn; |
393 | Job *other_job; | |
2da4617a | 394 | |
a50c2ab8 | 395 | job_state_transition(&job->job, JOB_STATUS_WAITING); |
e8af5686 | 396 | |
c55a832f FZ |
397 | /* |
398 | * Successful completion, see if there are other running jobs in this | |
399 | * txn. | |
400 | */ | |
401 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { | |
62c9e416 | 402 | if (!job_is_completed(other_job)) { |
c55a832f FZ |
403 | return; |
404 | } | |
62c9e416 | 405 | assert(other_job->ret == 0); |
c55a832f | 406 | } |
2da4617a | 407 | |
5d4f3769 | 408 | block_job_txn_apply(txn, block_job_transition_to_pending, false); |
11b61fbc JS |
409 | |
410 | /* If no jobs need manual finalization, automatically do so */ | |
411 | if (block_job_txn_apply(txn, block_job_needs_finalize, false) == 0) { | |
412 | block_job_do_finalize(job); | |
413 | } | |
c55a832f FZ |
414 | } |
415 | ||
da01ff7f KW |
416 | /* Assumes the job_mutex is held */ |
417 | static bool job_timer_pending(Job *job) | |
418 | { | |
419 | return timer_pending(&job->sleep_timer); | |
420 | } | |
421 | ||
2f0c9fe6 PB |
422 | void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) |
423 | { | |
aa9ef2e6 | 424 | int64_t old_speed = job->speed; |
2f0c9fe6 | 425 | |
a50c2ab8 | 426 | if (job_apply_verb(&job->job, JOB_VERB_SET_SPEED, errp)) { |
0ec4dfb8 JS |
427 | return; |
428 | } | |
18bb6928 KW |
429 | if (speed < 0) { |
430 | error_setg(errp, QERR_INVALID_PARAMETER, "speed"); | |
2f0c9fe6 PB |
431 | return; |
432 | } | |
433 | ||
18bb6928 KW |
434 | ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); |
435 | ||
2f0c9fe6 | 436 | job->speed = speed; |
d4fce188 | 437 | if (speed && speed <= old_speed) { |
aa9ef2e6 JS |
438 | return; |
439 | } | |
440 | ||
441 | /* kick only if a timer is pending */ | |
da01ff7f | 442 | job_enter_cond(&job->job, job_timer_pending); |
2f0c9fe6 PB |
443 | } |
444 | ||
dee81d51 KW |
445 | int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) |
446 | { | |
447 | if (!job->speed) { | |
448 | return 0; | |
449 | } | |
450 | ||
451 | return ratelimit_calculate_delay(&job->limit, n); | |
452 | } | |
453 | ||
11b61fbc JS |
454 | void block_job_finalize(BlockJob *job, Error **errp) |
455 | { | |
33e9e9bd | 456 | assert(job && job->job.id); |
a50c2ab8 | 457 | if (job_apply_verb(&job->job, JOB_VERB_FINALIZE, errp)) { |
11b61fbc JS |
458 | return; |
459 | } | |
460 | block_job_do_finalize(job); | |
461 | } | |
462 | ||
75f71059 JS |
463 | void block_job_dismiss(BlockJob **jobptr, Error **errp) |
464 | { | |
465 | BlockJob *job = *jobptr; | |
466 | /* similarly to _complete, this is QMP-interface only. */ | |
33e9e9bd | 467 | assert(job->job.id); |
a50c2ab8 | 468 | if (job_apply_verb(&job->job, JOB_VERB_DISMISS, errp)) { |
75f71059 JS |
469 | return; |
470 | } | |
471 | ||
4ad35181 | 472 | job_do_dismiss(&job->job); |
75f71059 JS |
473 | *jobptr = NULL; |
474 | } | |
475 | ||
b76e4458 | 476 | void block_job_cancel(BlockJob *job, bool force) |
8acc72a4 | 477 | { |
a50c2ab8 | 478 | if (job->job.status == JOB_STATUS_CONCLUDED) { |
4ad35181 | 479 | job_do_dismiss(&job->job); |
11b61fbc JS |
480 | return; |
481 | } | |
004e95df | 482 | job_cancel_async(&job->job, force); |
da01ff7f | 483 | if (!job_started(&job->job)) { |
5ccac6f1 | 484 | block_job_completed(job, -ECANCELED); |
1908a559 | 485 | } else if (job->job.deferred_to_main_loop) { |
11b61fbc JS |
486 | block_job_completed_txn_abort(job); |
487 | } else { | |
488 | block_job_enter(job); | |
5ccac6f1 | 489 | } |
8acc72a4 PB |
490 | } |
491 | ||
b76e4458 | 492 | void block_job_user_cancel(BlockJob *job, bool force, Error **errp) |
0ec4dfb8 | 493 | { |
a50c2ab8 | 494 | if (job_apply_verb(&job->job, JOB_VERB_CANCEL, errp)) { |
0ec4dfb8 JS |
495 | return; |
496 | } | |
b76e4458 | 497 | block_job_cancel(job, force); |
0ec4dfb8 JS |
498 | } |
499 | ||
345f9e1b | 500 | /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be |
6a74c075 KW |
501 | * used with job_finish_sync() without the need for (rather nasty) function |
502 | * pointer casts there. */ | |
503 | static void block_job_cancel_err(Job *job, Error **errp) | |
345f9e1b | 504 | { |
6a74c075 KW |
505 | BlockJob *bjob = container_of(job, BlockJob, job); |
506 | assert(is_block_job(job)); | |
507 | block_job_cancel(bjob, false); | |
345f9e1b HR |
508 | } |
509 | ||
510 | int block_job_cancel_sync(BlockJob *job) | |
511 | { | |
6a74c075 | 512 | return job_finish_sync(&job->job, &block_job_cancel_err, NULL); |
345f9e1b HR |
513 | } |
514 | ||
a1a2af07 KW |
515 | void block_job_cancel_sync_all(void) |
516 | { | |
517 | BlockJob *job; | |
518 | AioContext *aio_context; | |
519 | ||
e7c1d78b | 520 | while ((job = block_job_next(NULL))) { |
b6d2e599 | 521 | aio_context = blk_get_aio_context(job->blk); |
a1a2af07 KW |
522 | aio_context_acquire(aio_context); |
523 | block_job_cancel_sync(job); | |
524 | aio_context_release(aio_context); | |
525 | } | |
526 | } | |
527 | ||
345f9e1b HR |
528 | int block_job_complete_sync(BlockJob *job, Error **errp) |
529 | { | |
6a74c075 | 530 | return job_finish_sync(&job->job, job_complete, errp); |
345f9e1b HR |
531 | } |
532 | ||
05df8a6a KW |
533 | void block_job_progress_update(BlockJob *job, uint64_t done) |
534 | { | |
535 | job->offset += done; | |
536 | } | |
537 | ||
538 | void block_job_progress_set_remaining(BlockJob *job, uint64_t remaining) | |
539 | { | |
540 | job->len = job->offset + remaining; | |
541 | } | |
542 | ||
559b935f | 543 | BlockJobInfo *block_job_query(BlockJob *job, Error **errp) |
30e628b7 | 544 | { |
559b935f JS |
545 | BlockJobInfo *info; |
546 | ||
547 | if (block_job_is_internal(job)) { | |
548 | error_setg(errp, "Cannot query QEMU internal jobs"); | |
549 | return NULL; | |
550 | } | |
551 | info = g_new0(BlockJobInfo, 1); | |
252291ea | 552 | info->type = g_strdup(job_type_str(&job->job)); |
33e9e9bd | 553 | info->device = g_strdup(job->job.id); |
32c81a4a | 554 | info->len = job->len; |
da01ff7f KW |
555 | info->busy = atomic_read(&job->job.busy); |
556 | info->paused = job->job.pause_count > 0; | |
32c81a4a PB |
557 | info->offset = job->offset; |
558 | info->speed = job->speed; | |
559 | info->io_status = job->iostatus; | |
ef6dbf1e | 560 | info->ready = job->ready; |
a50c2ab8 | 561 | info->status = job->job.status; |
bb02b65c KW |
562 | info->auto_finalize = job->job.auto_finalize; |
563 | info->auto_dismiss = job->job.auto_dismiss; | |
4ad35181 KW |
564 | info->has_error = job->job.ret != 0; |
565 | info->error = job->job.ret ? g_strdup(strerror(-job->job.ret)) : NULL; | |
30e628b7 PB |
566 | return info; |
567 | } | |
32c81a4a PB |
568 | |
569 | static void block_job_iostatus_set_err(BlockJob *job, int error) | |
570 | { | |
571 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { | |
572 | job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : | |
573 | BLOCK_DEVICE_IO_STATUS_FAILED; | |
574 | } | |
575 | } | |
576 | ||
139a9f02 | 577 | static void block_job_event_cancelled(Notifier *n, void *opaque) |
bcada37b | 578 | { |
139a9f02 KW |
579 | BlockJob *job = opaque; |
580 | ||
559b935f JS |
581 | if (block_job_is_internal(job)) { |
582 | return; | |
583 | } | |
584 | ||
252291ea | 585 | qapi_event_send_block_job_cancelled(job_type(&job->job), |
33e9e9bd | 586 | job->job.id, |
bcada37b WX |
587 | job->len, |
588 | job->offset, | |
589 | job->speed, | |
590 | &error_abort); | |
591 | } | |
32c81a4a | 592 | |
139a9f02 | 593 | static void block_job_event_completed(Notifier *n, void *opaque) |
a66a2a36 | 594 | { |
139a9f02 KW |
595 | BlockJob *job = opaque; |
596 | const char *msg = NULL; | |
597 | ||
559b935f JS |
598 | if (block_job_is_internal(job)) { |
599 | return; | |
600 | } | |
601 | ||
4ad35181 KW |
602 | if (job->job.ret < 0) { |
603 | msg = strerror(-job->job.ret); | |
139a9f02 KW |
604 | } |
605 | ||
252291ea | 606 | qapi_event_send_block_job_completed(job_type(&job->job), |
33e9e9bd | 607 | job->job.id, |
bcada37b WX |
608 | job->len, |
609 | job->offset, | |
610 | job->speed, | |
611 | !!msg, | |
612 | msg, | |
613 | &error_abort); | |
a66a2a36 PB |
614 | } |
615 | ||
139a9f02 | 616 | static void block_job_event_pending(Notifier *n, void *opaque) |
5f241594 | 617 | { |
139a9f02 KW |
618 | BlockJob *job = opaque; |
619 | ||
5d4f3769 KW |
620 | if (block_job_is_internal(job)) { |
621 | return; | |
5f241594 | 622 | } |
5d4f3769 KW |
623 | |
624 | qapi_event_send_block_job_pending(job_type(&job->job), | |
625 | job->job.id, | |
626 | &error_abort); | |
5f241594 JS |
627 | } |
628 | ||
88691b37 PB |
629 | /* |
630 | * API for block job drivers and the block layer. These functions are | |
631 | * declared in blockjob_int.h. | |
632 | */ | |
633 | ||
634 | void *block_job_create(const char *job_id, const BlockJobDriver *driver, | |
62c9e416 | 635 | JobTxn *txn, BlockDriverState *bs, uint64_t perm, |
88691b37 PB |
636 | uint64_t shared_perm, int64_t speed, int flags, |
637 | BlockCompletionFunc *cb, void *opaque, Error **errp) | |
638 | { | |
639 | BlockBackend *blk; | |
640 | BlockJob *job; | |
641 | int ret; | |
642 | ||
643 | if (bs->job) { | |
644 | error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); | |
645 | return NULL; | |
646 | } | |
647 | ||
bb02b65c | 648 | if (job_id == NULL && !(flags & JOB_INTERNAL)) { |
88691b37 | 649 | job_id = bdrv_get_device_name(bs); |
88691b37 PB |
650 | } |
651 | ||
652 | blk = blk_new(perm, shared_perm); | |
653 | ret = blk_insert_bs(blk, bs, errp); | |
654 | if (ret < 0) { | |
655 | blk_unref(blk); | |
656 | return NULL; | |
657 | } | |
658 | ||
08be6fe2 | 659 | job = job_create(job_id, &driver->job_driver, blk_get_aio_context(blk), |
4ad35181 | 660 | flags, cb, opaque, errp); |
33e9e9bd KW |
661 | if (job == NULL) { |
662 | blk_unref(blk); | |
663 | return NULL; | |
664 | } | |
665 | ||
e7c1d78b | 666 | assert(is_block_job(&job->job)); |
80fa2c75 | 667 | assert(job->job.driver->free == &block_job_free); |
b15de828 | 668 | assert(job->job.driver->user_resume == &block_job_user_resume); |
b69f777d | 669 | assert(job->job.driver->drain == &block_job_drain); |
e7c1d78b | 670 | |
88691b37 | 671 | job->driver = driver; |
88691b37 | 672 | job->blk = blk; |
88691b37 | 673 | |
139a9f02 KW |
674 | job->finalize_cancelled_notifier.notify = block_job_event_cancelled; |
675 | job->finalize_completed_notifier.notify = block_job_event_completed; | |
676 | job->pending_notifier.notify = block_job_event_pending; | |
677 | ||
678 | notifier_list_add(&job->job.on_finalize_cancelled, | |
679 | &job->finalize_cancelled_notifier); | |
680 | notifier_list_add(&job->job.on_finalize_completed, | |
681 | &job->finalize_completed_notifier); | |
682 | notifier_list_add(&job->job.on_pending, &job->pending_notifier); | |
683 | ||
88691b37 | 684 | error_setg(&job->blocker, "block device is in use by block job: %s", |
252291ea | 685 | job_type_str(&job->job)); |
88691b37 PB |
686 | block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); |
687 | bs->job = job; | |
688 | ||
88691b37 PB |
689 | bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); |
690 | ||
88691b37 PB |
691 | blk_add_aio_context_notifier(blk, block_job_attached_aio_context, |
692 | block_job_detach_aio_context, job); | |
693 | ||
694 | /* Only set speed when necessary to avoid NotSupported error */ | |
695 | if (speed != 0) { | |
696 | Error *local_err = NULL; | |
697 | ||
698 | block_job_set_speed(job, speed, &local_err); | |
699 | if (local_err) { | |
4ad35181 | 700 | job_early_fail(&job->job); |
88691b37 PB |
701 | error_propagate(errp, local_err); |
702 | return NULL; | |
703 | } | |
704 | } | |
75859b94 JS |
705 | |
706 | /* Single jobs are modeled as single-job transactions for sake of | |
707 | * consolidating the job management logic */ | |
708 | if (!txn) { | |
709 | txn = block_job_txn_new(); | |
710 | block_job_txn_add_job(txn, job); | |
711 | block_job_txn_unref(txn); | |
712 | } else { | |
713 | block_job_txn_add_job(txn, job); | |
714 | } | |
715 | ||
88691b37 PB |
716 | return job; |
717 | } | |
718 | ||
88691b37 PB |
719 | void block_job_completed(BlockJob *job, int ret) |
720 | { | |
dbe5e6c1 | 721 | assert(job && job->txn && !job_is_completed(&job->job)); |
88691b37 | 722 | assert(blk_bs(job->blk)->job == job); |
4ad35181 KW |
723 | job->job.ret = ret; |
724 | job_update_rc(&job->job); | |
725 | trace_block_job_completed(job, ret, job->job.ret); | |
726 | if (job->job.ret) { | |
88691b37 PB |
727 | block_job_completed_txn_abort(job); |
728 | } else { | |
729 | block_job_completed_txn_success(job); | |
730 | } | |
731 | } | |
732 | ||
aa9ef2e6 JS |
733 | void block_job_enter(BlockJob *job) |
734 | { | |
da01ff7f | 735 | job_enter_cond(&job->job, NULL); |
aa9ef2e6 JS |
736 | } |
737 | ||
88691b37 PB |
738 | void block_job_yield(BlockJob *job) |
739 | { | |
da01ff7f | 740 | assert(job->job.busy); |
88691b37 PB |
741 | |
742 | /* Check cancellation *before* setting busy = false, too! */ | |
daa7f2f9 | 743 | if (job_is_cancelled(&job->job)) { |
88691b37 PB |
744 | return; |
745 | } | |
746 | ||
da01ff7f KW |
747 | if (!job_should_pause(&job->job)) { |
748 | job_do_yield(&job->job, -1); | |
88691b37 | 749 | } |
88691b37 | 750 | |
da01ff7f | 751 | job_pause_point(&job->job); |
88691b37 PB |
752 | } |
753 | ||
2caf63a9 PB |
754 | void block_job_iostatus_reset(BlockJob *job) |
755 | { | |
4c241cf5 PB |
756 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { |
757 | return; | |
758 | } | |
b15de828 | 759 | assert(job->job.user_paused && job->job.pause_count > 0); |
2caf63a9 PB |
760 | job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; |
761 | } | |
762 | ||
b15de828 KW |
763 | void block_job_user_resume(Job *job) |
764 | { | |
765 | BlockJob *bjob = container_of(job, BlockJob, job); | |
766 | block_job_iostatus_reset(bjob); | |
767 | } | |
768 | ||
bcada37b | 769 | void block_job_event_ready(BlockJob *job) |
a66a2a36 | 770 | { |
a50c2ab8 | 771 | job_state_transition(&job->job, JOB_STATUS_READY); |
ef6dbf1e HR |
772 | job->ready = true; |
773 | ||
559b935f JS |
774 | if (block_job_is_internal(job)) { |
775 | return; | |
776 | } | |
777 | ||
252291ea | 778 | qapi_event_send_block_job_ready(job_type(&job->job), |
33e9e9bd | 779 | job->job.id, |
518848a2 MA |
780 | job->len, |
781 | job->offset, | |
782 | job->speed, &error_abort); | |
a66a2a36 PB |
783 | } |
784 | ||
81e254dc | 785 | BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, |
32c81a4a PB |
786 | int is_read, int error) |
787 | { | |
788 | BlockErrorAction action; | |
789 | ||
790 | switch (on_err) { | |
791 | case BLOCKDEV_ON_ERROR_ENOSPC: | |
8c398252 | 792 | case BLOCKDEV_ON_ERROR_AUTO: |
a589569f WX |
793 | action = (error == ENOSPC) ? |
794 | BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; | |
32c81a4a PB |
795 | break; |
796 | case BLOCKDEV_ON_ERROR_STOP: | |
a589569f | 797 | action = BLOCK_ERROR_ACTION_STOP; |
32c81a4a PB |
798 | break; |
799 | case BLOCKDEV_ON_ERROR_REPORT: | |
a589569f | 800 | action = BLOCK_ERROR_ACTION_REPORT; |
32c81a4a PB |
801 | break; |
802 | case BLOCKDEV_ON_ERROR_IGNORE: | |
a589569f | 803 | action = BLOCK_ERROR_ACTION_IGNORE; |
32c81a4a PB |
804 | break; |
805 | default: | |
806 | abort(); | |
807 | } | |
559b935f | 808 | if (!block_job_is_internal(job)) { |
33e9e9bd | 809 | qapi_event_send_block_job_error(job->job.id, |
559b935f JS |
810 | is_read ? IO_OPERATION_TYPE_READ : |
811 | IO_OPERATION_TYPE_WRITE, | |
812 | action, &error_abort); | |
813 | } | |
a589569f | 814 | if (action == BLOCK_ERROR_ACTION_STOP) { |
b15de828 | 815 | job_pause(&job->job); |
751ebd76 | 816 | /* make the pause user visible, which will be resumed from QMP. */ |
b15de828 | 817 | job->job.user_paused = true; |
32c81a4a | 818 | block_job_iostatus_set_err(job, error); |
32c81a4a PB |
819 | } |
820 | return action; | |
821 | } |