]>
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" |
7f0317cf | 37 | #include "qemu/id.h" |
1de7afc9 | 38 | #include "qemu/timer.h" |
2f0c9fe6 | 39 | |
fc24908e PB |
40 | /* Right now, this mutex is only needed to synchronize accesses to job->busy |
41 | * and job->sleep_timer, such as concurrent calls to block_job_do_yield and | |
42 | * block_job_enter. */ | |
43 | static QemuMutex block_job_mutex; | |
44 | ||
c9de4050 JS |
45 | /* BlockJob State Transition Table */ |
46 | bool BlockJobSTT[BLOCK_JOB_STATUS__MAX][BLOCK_JOB_STATUS__MAX] = { | |
5f241594 JS |
47 | /* U, C, R, P, Y, S, W, D, X, E, N */ |
48 | /* U: */ [BLOCK_JOB_STATUS_UNDEFINED] = {0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0}, | |
49 | /* C: */ [BLOCK_JOB_STATUS_CREATED] = {0, 0, 1, 0, 0, 0, 0, 0, 1, 0, 1}, | |
50 | /* R: */ [BLOCK_JOB_STATUS_RUNNING] = {0, 0, 0, 1, 1, 0, 1, 0, 1, 0, 0}, | |
51 | /* P: */ [BLOCK_JOB_STATUS_PAUSED] = {0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0}, | |
52 | /* Y: */ [BLOCK_JOB_STATUS_READY] = {0, 0, 0, 0, 0, 1, 1, 0, 1, 0, 0}, | |
53 | /* S: */ [BLOCK_JOB_STATUS_STANDBY] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, | |
54 | /* W: */ [BLOCK_JOB_STATUS_WAITING] = {0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0}, | |
55 | /* D: */ [BLOCK_JOB_STATUS_PENDING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, | |
56 | /* X: */ [BLOCK_JOB_STATUS_ABORTING] = {0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0}, | |
57 | /* E: */ [BLOCK_JOB_STATUS_CONCLUDED] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}, | |
58 | /* N: */ [BLOCK_JOB_STATUS_NULL] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}, | |
c9de4050 JS |
59 | }; |
60 | ||
0ec4dfb8 | 61 | bool BlockJobVerbTable[BLOCK_JOB_VERB__MAX][BLOCK_JOB_STATUS__MAX] = { |
5f241594 JS |
62 | /* U, C, R, P, Y, S, W, D, X, E, N */ |
63 | [BLOCK_JOB_VERB_CANCEL] = {0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0}, | |
64 | [BLOCK_JOB_VERB_PAUSE] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
65 | [BLOCK_JOB_VERB_RESUME] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
66 | [BLOCK_JOB_VERB_SET_SPEED] = {0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0}, | |
67 | [BLOCK_JOB_VERB_COMPLETE] = {0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0}, | |
11b61fbc | 68 | [BLOCK_JOB_VERB_FINALIZE] = {0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0}, |
5f241594 | 69 | [BLOCK_JOB_VERB_DISMISS] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0}, |
0ec4dfb8 JS |
70 | }; |
71 | ||
c9de4050 JS |
72 | static void block_job_state_transition(BlockJob *job, BlockJobStatus s1) |
73 | { | |
74 | BlockJobStatus s0 = job->status; | |
75 | assert(s1 >= 0 && s1 <= BLOCK_JOB_STATUS__MAX); | |
76 | trace_block_job_state_transition(job, job->ret, BlockJobSTT[s0][s1] ? | |
77 | "allowed" : "disallowed", | |
604343ce MAL |
78 | BlockJobStatus_str(s0), |
79 | BlockJobStatus_str(s1)); | |
c9de4050 JS |
80 | assert(BlockJobSTT[s0][s1]); |
81 | job->status = s1; | |
82 | } | |
83 | ||
0ec4dfb8 JS |
84 | static int block_job_apply_verb(BlockJob *job, BlockJobVerb bv, Error **errp) |
85 | { | |
86 | assert(bv >= 0 && bv <= BLOCK_JOB_VERB__MAX); | |
604343ce MAL |
87 | trace_block_job_apply_verb(job, BlockJobStatus_str(job->status), |
88 | BlockJobVerb_str(bv), | |
0ec4dfb8 JS |
89 | BlockJobVerbTable[bv][job->status] ? |
90 | "allowed" : "prohibited"); | |
91 | if (BlockJobVerbTable[bv][job->status]) { | |
92 | return 0; | |
93 | } | |
94 | error_setg(errp, "Job '%s' in state '%s' cannot accept command verb '%s'", | |
604343ce | 95 | job->id, BlockJobStatus_str(job->status), BlockJobVerb_str(bv)); |
0ec4dfb8 JS |
96 | return -EPERM; |
97 | } | |
98 | ||
fc24908e PB |
99 | static void block_job_lock(void) |
100 | { | |
101 | qemu_mutex_lock(&block_job_mutex); | |
102 | } | |
103 | ||
104 | static void block_job_unlock(void) | |
105 | { | |
106 | qemu_mutex_unlock(&block_job_mutex); | |
107 | } | |
108 | ||
109 | static void __attribute__((__constructor__)) block_job_init(void) | |
110 | { | |
111 | qemu_mutex_init(&block_job_mutex); | |
112 | } | |
113 | ||
8254b6d9 JS |
114 | static void block_job_event_cancelled(BlockJob *job); |
115 | static void block_job_event_completed(BlockJob *job, const char *msg); | |
5f241594 | 116 | static int block_job_event_pending(BlockJob *job); |
aa9ef2e6 | 117 | static void block_job_enter_cond(BlockJob *job, bool(*fn)(BlockJob *job)); |
8254b6d9 | 118 | |
c55a832f FZ |
119 | /* Transactional group of block jobs */ |
120 | struct BlockJobTxn { | |
121 | ||
122 | /* Is this txn being cancelled? */ | |
123 | bool aborting; | |
124 | ||
125 | /* List of jobs */ | |
126 | QLIST_HEAD(, BlockJob) jobs; | |
127 | ||
128 | /* Reference count */ | |
129 | int refcnt; | |
130 | }; | |
131 | ||
a7112795 AG |
132 | static QLIST_HEAD(, BlockJob) block_jobs = QLIST_HEAD_INITIALIZER(block_jobs); |
133 | ||
88691b37 PB |
134 | /* |
135 | * The block job API is composed of two categories of functions. | |
136 | * | |
137 | * The first includes functions used by the monitor. The monitor is | |
138 | * peculiar in that it accesses the block job list with block_job_get, and | |
139 | * therefore needs consistency across block_job_get and the actual operation | |
140 | * (e.g. block_job_set_speed). The consistency is achieved with | |
141 | * aio_context_acquire/release. These functions are declared in blockjob.h. | |
142 | * | |
143 | * The second includes functions used by the block job drivers and sometimes | |
144 | * by the core block layer. These do not care about locking, because the | |
145 | * whole coroutine runs under the AioContext lock, and are declared in | |
146 | * blockjob_int.h. | |
147 | */ | |
148 | ||
a7112795 AG |
149 | BlockJob *block_job_next(BlockJob *job) |
150 | { | |
151 | if (!job) { | |
152 | return QLIST_FIRST(&block_jobs); | |
153 | } | |
154 | return QLIST_NEXT(job, job_list); | |
155 | } | |
156 | ||
ffb1f10c AG |
157 | BlockJob *block_job_get(const char *id) |
158 | { | |
159 | BlockJob *job; | |
160 | ||
161 | QLIST_FOREACH(job, &block_jobs, job_list) { | |
559b935f | 162 | if (job->id && !strcmp(id, job->id)) { |
ffb1f10c AG |
163 | return job; |
164 | } | |
165 | } | |
166 | ||
167 | return NULL; | |
168 | } | |
169 | ||
c8ab5c2d PB |
170 | BlockJobTxn *block_job_txn_new(void) |
171 | { | |
172 | BlockJobTxn *txn = g_new0(BlockJobTxn, 1); | |
173 | QLIST_INIT(&txn->jobs); | |
174 | txn->refcnt = 1; | |
175 | return txn; | |
176 | } | |
177 | ||
178 | static void block_job_txn_ref(BlockJobTxn *txn) | |
179 | { | |
180 | txn->refcnt++; | |
181 | } | |
182 | ||
183 | void block_job_txn_unref(BlockJobTxn *txn) | |
184 | { | |
185 | if (txn && --txn->refcnt == 0) { | |
186 | g_free(txn); | |
187 | } | |
188 | } | |
189 | ||
190 | void block_job_txn_add_job(BlockJobTxn *txn, BlockJob *job) | |
191 | { | |
192 | if (!txn) { | |
193 | return; | |
194 | } | |
195 | ||
196 | assert(!job->txn); | |
197 | job->txn = txn; | |
198 | ||
199 | QLIST_INSERT_HEAD(&txn->jobs, job, txn_list); | |
200 | block_job_txn_ref(txn); | |
201 | } | |
202 | ||
a865cebb MAL |
203 | static void block_job_txn_del_job(BlockJob *job) |
204 | { | |
205 | if (job->txn) { | |
206 | QLIST_REMOVE(job, txn_list); | |
207 | block_job_txn_unref(job->txn); | |
208 | job->txn = NULL; | |
209 | } | |
210 | } | |
211 | ||
f321dcb5 PB |
212 | static void block_job_pause(BlockJob *job) |
213 | { | |
214 | job->pause_count++; | |
215 | } | |
216 | ||
217 | static void block_job_resume(BlockJob *job) | |
218 | { | |
219 | assert(job->pause_count > 0); | |
220 | job->pause_count--; | |
221 | if (job->pause_count) { | |
222 | return; | |
223 | } | |
224 | block_job_enter(job); | |
225 | } | |
226 | ||
4172a003 | 227 | void block_job_ref(BlockJob *job) |
05b0d8e3 PB |
228 | { |
229 | ++job->refcnt; | |
230 | } | |
231 | ||
232 | static void block_job_attached_aio_context(AioContext *new_context, | |
233 | void *opaque); | |
234 | static void block_job_detach_aio_context(void *opaque); | |
235 | ||
4172a003 | 236 | void block_job_unref(BlockJob *job) |
05b0d8e3 PB |
237 | { |
238 | if (--job->refcnt == 0) { | |
3925cd3b | 239 | assert(job->status == BLOCK_JOB_STATUS_NULL); |
a865cebb | 240 | assert(!job->txn); |
05b0d8e3 | 241 | BlockDriverState *bs = blk_bs(job->blk); |
0a3e155f | 242 | QLIST_REMOVE(job, job_list); |
05b0d8e3 PB |
243 | bs->job = NULL; |
244 | block_job_remove_all_bdrv(job); | |
245 | blk_remove_aio_context_notifier(job->blk, | |
246 | block_job_attached_aio_context, | |
247 | block_job_detach_aio_context, job); | |
248 | blk_unref(job->blk); | |
249 | error_free(job->blocker); | |
250 | g_free(job->id); | |
fc24908e | 251 | assert(!timer_pending(&job->sleep_timer)); |
05b0d8e3 PB |
252 | g_free(job); |
253 | } | |
254 | } | |
255 | ||
463e0be1 SH |
256 | static void block_job_attached_aio_context(AioContext *new_context, |
257 | void *opaque) | |
258 | { | |
259 | BlockJob *job = opaque; | |
260 | ||
261 | if (job->driver->attached_aio_context) { | |
262 | job->driver->attached_aio_context(job, new_context); | |
263 | } | |
264 | ||
265 | block_job_resume(job); | |
266 | } | |
267 | ||
bae8196d PB |
268 | static void block_job_drain(BlockJob *job) |
269 | { | |
270 | /* If job is !job->busy this kicks it into the next pause point. */ | |
271 | block_job_enter(job); | |
272 | ||
273 | blk_drain(job->blk); | |
274 | if (job->driver->drain) { | |
275 | job->driver->drain(job); | |
276 | } | |
277 | } | |
278 | ||
463e0be1 SH |
279 | static void block_job_detach_aio_context(void *opaque) |
280 | { | |
281 | BlockJob *job = opaque; | |
282 | ||
283 | /* In case the job terminates during aio_poll()... */ | |
284 | block_job_ref(job); | |
285 | ||
286 | block_job_pause(job); | |
287 | ||
463e0be1 | 288 | while (!job->paused && !job->completed) { |
bae8196d | 289 | block_job_drain(job); |
463e0be1 SH |
290 | } |
291 | ||
292 | block_job_unref(job); | |
293 | } | |
294 | ||
f321dcb5 PB |
295 | static char *child_job_get_parent_desc(BdrvChild *c) |
296 | { | |
297 | BlockJob *job = c->opaque; | |
298 | return g_strdup_printf("%s job '%s'", | |
977c736f | 299 | BlockJobType_str(job->driver->job_type), |
f321dcb5 PB |
300 | job->id); |
301 | } | |
302 | ||
ad90feba | 303 | static void child_job_drained_begin(BdrvChild *c) |
f321dcb5 | 304 | { |
ad90feba | 305 | BlockJob *job = c->opaque; |
f321dcb5 PB |
306 | block_job_pause(job); |
307 | } | |
308 | ||
ad90feba | 309 | static void child_job_drained_end(BdrvChild *c) |
f321dcb5 | 310 | { |
ad90feba | 311 | BlockJob *job = c->opaque; |
f321dcb5 PB |
312 | block_job_resume(job); |
313 | } | |
314 | ||
ad90feba KW |
315 | static const BdrvChildRole child_job = { |
316 | .get_parent_desc = child_job_get_parent_desc, | |
317 | .drained_begin = child_job_drained_begin, | |
318 | .drained_end = child_job_drained_end, | |
319 | .stay_at_node = true, | |
f321dcb5 PB |
320 | }; |
321 | ||
bbc02b90 KW |
322 | void block_job_remove_all_bdrv(BlockJob *job) |
323 | { | |
324 | GSList *l; | |
325 | for (l = job->nodes; l; l = l->next) { | |
326 | BdrvChild *c = l->data; | |
327 | bdrv_op_unblock_all(c->bs, job->blocker); | |
328 | bdrv_root_unref_child(c); | |
329 | } | |
330 | g_slist_free(job->nodes); | |
331 | job->nodes = NULL; | |
332 | } | |
333 | ||
76d554e2 KW |
334 | int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs, |
335 | uint64_t perm, uint64_t shared_perm, Error **errp) | |
23d402d4 | 336 | { |
76d554e2 KW |
337 | BdrvChild *c; |
338 | ||
339 | c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm, | |
340 | job, errp); | |
341 | if (c == NULL) { | |
342 | return -EPERM; | |
343 | } | |
344 | ||
345 | job->nodes = g_slist_prepend(job->nodes, c); | |
23d402d4 AG |
346 | bdrv_ref(bs); |
347 | bdrv_op_block_all(bs, job->blocker); | |
76d554e2 KW |
348 | |
349 | return 0; | |
23d402d4 AG |
350 | } |
351 | ||
559b935f JS |
352 | bool block_job_is_internal(BlockJob *job) |
353 | { | |
354 | return (job->id == NULL); | |
355 | } | |
356 | ||
5ccac6f1 JS |
357 | static bool block_job_started(BlockJob *job) |
358 | { | |
359 | return job->co; | |
360 | } | |
361 | ||
bd21935b KW |
362 | const BlockJobDriver *block_job_driver(BlockJob *job) |
363 | { | |
364 | return job->driver; | |
365 | } | |
366 | ||
e3796a24 JS |
367 | /** |
368 | * All jobs must allow a pause point before entering their job proper. This | |
369 | * ensures that jobs can be paused prior to being started, then resumed later. | |
370 | */ | |
371 | static void coroutine_fn block_job_co_entry(void *opaque) | |
372 | { | |
373 | BlockJob *job = opaque; | |
374 | ||
375 | assert(job && job->driver && job->driver->start); | |
376 | block_job_pause_point(job); | |
377 | job->driver->start(job); | |
378 | } | |
379 | ||
fc24908e PB |
380 | static void block_job_sleep_timer_cb(void *opaque) |
381 | { | |
382 | BlockJob *job = opaque; | |
383 | ||
384 | block_job_enter(job); | |
385 | } | |
386 | ||
5ccac6f1 JS |
387 | void block_job_start(BlockJob *job) |
388 | { | |
389 | assert(job && !block_job_started(job) && job->paused && | |
e3796a24 JS |
390 | job->driver && job->driver->start); |
391 | job->co = qemu_coroutine_create(block_job_co_entry, job); | |
392 | job->pause_count--; | |
393 | job->busy = true; | |
394 | job->paused = false; | |
c9de4050 | 395 | block_job_state_transition(job, BLOCK_JOB_STATUS_RUNNING); |
aef4278c | 396 | bdrv_coroutine_enter(blk_bs(job->blk), job->co); |
5ccac6f1 JS |
397 | } |
398 | ||
3925cd3b JS |
399 | static void block_job_decommission(BlockJob *job) |
400 | { | |
401 | assert(job); | |
402 | job->completed = true; | |
403 | job->busy = false; | |
404 | job->paused = false; | |
405 | job->deferred_to_main_loop = true; | |
a865cebb | 406 | block_job_txn_del_job(job); |
3925cd3b JS |
407 | block_job_state_transition(job, BLOCK_JOB_STATUS_NULL); |
408 | block_job_unref(job); | |
409 | } | |
410 | ||
75f71059 JS |
411 | static void block_job_do_dismiss(BlockJob *job) |
412 | { | |
413 | block_job_decommission(job); | |
414 | } | |
415 | ||
e0cf0364 JS |
416 | static void block_job_conclude(BlockJob *job) |
417 | { | |
418 | block_job_state_transition(job, BLOCK_JOB_STATUS_CONCLUDED); | |
75f71059 JS |
419 | if (job->auto_dismiss || !block_job_started(job)) { |
420 | block_job_do_dismiss(job); | |
421 | } | |
e0cf0364 JS |
422 | } |
423 | ||
35d6b368 JS |
424 | static void block_job_update_rc(BlockJob *job) |
425 | { | |
426 | if (!job->ret && block_job_is_cancelled(job)) { | |
427 | job->ret = -ECANCELED; | |
428 | } | |
429 | if (job->ret) { | |
430 | block_job_state_transition(job, BLOCK_JOB_STATUS_ABORTING); | |
431 | } | |
432 | } | |
433 | ||
2da4617a JS |
434 | static int block_job_prepare(BlockJob *job) |
435 | { | |
436 | if (job->ret == 0 && job->driver->prepare) { | |
437 | job->ret = job->driver->prepare(job); | |
438 | } | |
439 | return job->ret; | |
440 | } | |
441 | ||
43628d93 JS |
442 | static void block_job_commit(BlockJob *job) |
443 | { | |
444 | assert(!job->ret); | |
445 | if (job->driver->commit) { | |
446 | job->driver->commit(job); | |
447 | } | |
448 | } | |
449 | ||
450 | static void block_job_abort(BlockJob *job) | |
451 | { | |
452 | assert(job->ret); | |
453 | if (job->driver->abort) { | |
454 | job->driver->abort(job); | |
455 | } | |
456 | } | |
457 | ||
458 | static void block_job_clean(BlockJob *job) | |
459 | { | |
460 | if (job->driver->clean) { | |
461 | job->driver->clean(job); | |
462 | } | |
463 | } | |
464 | ||
11b61fbc | 465 | static int block_job_finalize_single(BlockJob *job) |
c55a832f | 466 | { |
4fb588e9 PB |
467 | assert(job->completed); |
468 | ||
35d6b368 JS |
469 | /* Ensure abort is called for late-transactional failures */ |
470 | block_job_update_rc(job); | |
10a3fbb0 | 471 | |
c55a832f | 472 | if (!job->ret) { |
43628d93 | 473 | block_job_commit(job); |
c55a832f | 474 | } else { |
43628d93 | 475 | block_job_abort(job); |
e8a40bf7 | 476 | } |
43628d93 | 477 | block_job_clean(job); |
8254b6d9 JS |
478 | |
479 | if (job->cb) { | |
480 | job->cb(job->opaque, job->ret); | |
481 | } | |
5ccac6f1 JS |
482 | |
483 | /* Emit events only if we actually started */ | |
484 | if (block_job_started(job)) { | |
485 | if (block_job_is_cancelled(job)) { | |
486 | block_job_event_cancelled(job); | |
487 | } else { | |
488 | const char *msg = NULL; | |
489 | if (job->ret < 0) { | |
490 | msg = strerror(-job->ret); | |
491 | } | |
492 | block_job_event_completed(job, msg); | |
8254b6d9 | 493 | } |
8254b6d9 JS |
494 | } |
495 | ||
a865cebb | 496 | block_job_txn_del_job(job); |
e0cf0364 | 497 | block_job_conclude(job); |
2da4617a | 498 | return 0; |
c55a832f FZ |
499 | } |
500 | ||
b76e4458 | 501 | static void block_job_cancel_async(BlockJob *job, bool force) |
4c241cf5 PB |
502 | { |
503 | if (job->iostatus != BLOCK_DEVICE_IO_STATUS_OK) { | |
504 | block_job_iostatus_reset(job); | |
505 | } | |
506 | if (job->user_paused) { | |
507 | /* Do not call block_job_enter here, the caller will handle it. */ | |
508 | job->user_paused = false; | |
509 | job->pause_count--; | |
510 | } | |
511 | job->cancelled = true; | |
b76e4458 LL |
512 | /* To prevent 'force == false' overriding a previous 'force == true' */ |
513 | job->force |= force; | |
4c241cf5 PB |
514 | } |
515 | ||
5f241594 | 516 | static int block_job_txn_apply(BlockJobTxn *txn, int fn(BlockJob *), bool lock) |
efe4d4b7 JS |
517 | { |
518 | AioContext *ctx; | |
519 | BlockJob *job, *next; | |
2da4617a | 520 | int rc = 0; |
efe4d4b7 JS |
521 | |
522 | QLIST_FOREACH_SAFE(job, &txn->jobs, txn_list, next) { | |
5f241594 JS |
523 | if (lock) { |
524 | ctx = blk_get_aio_context(job->blk); | |
525 | aio_context_acquire(ctx); | |
526 | } | |
2da4617a | 527 | rc = fn(job); |
5f241594 JS |
528 | if (lock) { |
529 | aio_context_release(ctx); | |
530 | } | |
2da4617a JS |
531 | if (rc) { |
532 | break; | |
533 | } | |
efe4d4b7 | 534 | } |
2da4617a | 535 | return rc; |
efe4d4b7 JS |
536 | } |
537 | ||
c8ab5c2d PB |
538 | static int block_job_finish_sync(BlockJob *job, |
539 | void (*finish)(BlockJob *, Error **errp), | |
540 | Error **errp) | |
541 | { | |
542 | Error *local_err = NULL; | |
543 | int ret; | |
544 | ||
545 | assert(blk_bs(job->blk)->job == job); | |
546 | ||
547 | block_job_ref(job); | |
548 | ||
4fb588e9 PB |
549 | if (finish) { |
550 | finish(job, &local_err); | |
551 | } | |
c8ab5c2d PB |
552 | if (local_err) { |
553 | error_propagate(errp, local_err); | |
554 | block_job_unref(job); | |
555 | return -EBUSY; | |
556 | } | |
557 | /* block_job_drain calls block_job_enter, and it should be enough to | |
558 | * induce progress until the job completes or moves to the main thread. | |
559 | */ | |
560 | while (!job->deferred_to_main_loop && !job->completed) { | |
561 | block_job_drain(job); | |
562 | } | |
563 | while (!job->completed) { | |
564 | aio_poll(qemu_get_aio_context(), true); | |
565 | } | |
566 | ret = (job->cancelled && job->ret == 0) ? -ECANCELED : job->ret; | |
567 | block_job_unref(job); | |
568 | return ret; | |
569 | } | |
570 | ||
c55a832f FZ |
571 | static void block_job_completed_txn_abort(BlockJob *job) |
572 | { | |
573 | AioContext *ctx; | |
574 | BlockJobTxn *txn = job->txn; | |
4fb588e9 | 575 | BlockJob *other_job; |
c55a832f FZ |
576 | |
577 | if (txn->aborting) { | |
578 | /* | |
579 | * We are cancelled by another job, which will handle everything. | |
580 | */ | |
581 | return; | |
582 | } | |
583 | txn->aborting = true; | |
4fb588e9 PB |
584 | block_job_txn_ref(txn); |
585 | ||
c55a832f FZ |
586 | /* We are the first failed job. Cancel other jobs. */ |
587 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { | |
b6d2e599 | 588 | ctx = blk_get_aio_context(other_job->blk); |
c55a832f FZ |
589 | aio_context_acquire(ctx); |
590 | } | |
4fb588e9 PB |
591 | |
592 | /* Other jobs are effectively cancelled by us, set the status for | |
593 | * them; this job, however, may or may not be cancelled, depending | |
594 | * on the caller, so leave it. */ | |
c55a832f | 595 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { |
4fb588e9 | 596 | if (other_job != job) { |
b76e4458 | 597 | block_job_cancel_async(other_job, false); |
c55a832f | 598 | } |
c55a832f | 599 | } |
4fb588e9 PB |
600 | while (!QLIST_EMPTY(&txn->jobs)) { |
601 | other_job = QLIST_FIRST(&txn->jobs); | |
b6d2e599 | 602 | ctx = blk_get_aio_context(other_job->blk); |
4fb588e9 PB |
603 | if (!other_job->completed) { |
604 | assert(other_job->cancelled); | |
605 | block_job_finish_sync(other_job, NULL, NULL); | |
606 | } | |
11b61fbc | 607 | block_job_finalize_single(other_job); |
c55a832f FZ |
608 | aio_context_release(ctx); |
609 | } | |
4fb588e9 PB |
610 | |
611 | block_job_txn_unref(txn); | |
c55a832f FZ |
612 | } |
613 | ||
11b61fbc JS |
614 | static int block_job_needs_finalize(BlockJob *job) |
615 | { | |
616 | return !job->auto_finalize; | |
617 | } | |
618 | ||
619 | static void block_job_do_finalize(BlockJob *job) | |
620 | { | |
621 | int rc; | |
622 | assert(job && job->txn); | |
623 | ||
624 | /* prepare the transaction to complete */ | |
625 | rc = block_job_txn_apply(job->txn, block_job_prepare, true); | |
626 | if (rc) { | |
627 | block_job_completed_txn_abort(job); | |
628 | } else { | |
629 | block_job_txn_apply(job->txn, block_job_finalize_single, true); | |
630 | } | |
631 | } | |
632 | ||
c55a832f FZ |
633 | static void block_job_completed_txn_success(BlockJob *job) |
634 | { | |
c55a832f | 635 | BlockJobTxn *txn = job->txn; |
efe4d4b7 | 636 | BlockJob *other_job; |
2da4617a | 637 | |
e8af5686 JS |
638 | block_job_state_transition(job, BLOCK_JOB_STATUS_WAITING); |
639 | ||
c55a832f FZ |
640 | /* |
641 | * Successful completion, see if there are other running jobs in this | |
642 | * txn. | |
643 | */ | |
644 | QLIST_FOREACH(other_job, &txn->jobs, txn_list) { | |
645 | if (!other_job->completed) { | |
646 | return; | |
647 | } | |
c55a832f | 648 | assert(other_job->ret == 0); |
c55a832f | 649 | } |
2da4617a | 650 | |
5f241594 | 651 | block_job_txn_apply(txn, block_job_event_pending, false); |
11b61fbc JS |
652 | |
653 | /* If no jobs need manual finalization, automatically do so */ | |
654 | if (block_job_txn_apply(txn, block_job_needs_finalize, false) == 0) { | |
655 | block_job_do_finalize(job); | |
656 | } | |
c55a832f FZ |
657 | } |
658 | ||
aa9ef2e6 JS |
659 | /* Assumes the block_job_mutex is held */ |
660 | static bool block_job_timer_pending(BlockJob *job) | |
661 | { | |
662 | return timer_pending(&job->sleep_timer); | |
663 | } | |
664 | ||
2f0c9fe6 PB |
665 | void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) |
666 | { | |
aa9ef2e6 | 667 | int64_t old_speed = job->speed; |
2f0c9fe6 | 668 | |
0ec4dfb8 JS |
669 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_SET_SPEED, errp)) { |
670 | return; | |
671 | } | |
18bb6928 KW |
672 | if (speed < 0) { |
673 | error_setg(errp, QERR_INVALID_PARAMETER, "speed"); | |
2f0c9fe6 PB |
674 | return; |
675 | } | |
676 | ||
18bb6928 KW |
677 | ratelimit_set_speed(&job->limit, speed, BLOCK_JOB_SLICE_TIME); |
678 | ||
2f0c9fe6 | 679 | job->speed = speed; |
d4fce188 | 680 | if (speed && speed <= old_speed) { |
aa9ef2e6 JS |
681 | return; |
682 | } | |
683 | ||
684 | /* kick only if a timer is pending */ | |
685 | block_job_enter_cond(job, block_job_timer_pending); | |
2f0c9fe6 PB |
686 | } |
687 | ||
dee81d51 KW |
688 | int64_t block_job_ratelimit_get_delay(BlockJob *job, uint64_t n) |
689 | { | |
690 | if (!job->speed) { | |
691 | return 0; | |
692 | } | |
693 | ||
694 | return ratelimit_calculate_delay(&job->limit, n); | |
695 | } | |
696 | ||
aeae883b PB |
697 | void block_job_complete(BlockJob *job, Error **errp) |
698 | { | |
559b935f JS |
699 | /* Should not be reachable via external interface for internal jobs */ |
700 | assert(job->id); | |
0ec4dfb8 JS |
701 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_COMPLETE, errp)) { |
702 | return; | |
703 | } | |
704 | if (job->pause_count || job->cancelled || !job->driver->complete) { | |
9df229c3 AG |
705 | error_setg(errp, "The active block job '%s' cannot be completed", |
706 | job->id); | |
aeae883b PB |
707 | return; |
708 | } | |
709 | ||
3fc4b10a | 710 | job->driver->complete(job, errp); |
aeae883b PB |
711 | } |
712 | ||
11b61fbc JS |
713 | void block_job_finalize(BlockJob *job, Error **errp) |
714 | { | |
37aa19b6 | 715 | assert(job && job->id); |
11b61fbc JS |
716 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_FINALIZE, errp)) { |
717 | return; | |
718 | } | |
719 | block_job_do_finalize(job); | |
720 | } | |
721 | ||
75f71059 JS |
722 | void block_job_dismiss(BlockJob **jobptr, Error **errp) |
723 | { | |
724 | BlockJob *job = *jobptr; | |
725 | /* similarly to _complete, this is QMP-interface only. */ | |
726 | assert(job->id); | |
727 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_DISMISS, errp)) { | |
728 | return; | |
729 | } | |
730 | ||
731 | block_job_do_dismiss(job); | |
732 | *jobptr = NULL; | |
733 | } | |
734 | ||
0ec4dfb8 | 735 | void block_job_user_pause(BlockJob *job, Error **errp) |
0df4ba58 | 736 | { |
0ec4dfb8 JS |
737 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_PAUSE, errp)) { |
738 | return; | |
739 | } | |
740 | if (job->user_paused) { | |
741 | error_setg(errp, "Job is already paused"); | |
742 | return; | |
743 | } | |
0df4ba58 JS |
744 | job->user_paused = true; |
745 | block_job_pause(job); | |
746 | } | |
747 | ||
0df4ba58 JS |
748 | bool block_job_user_paused(BlockJob *job) |
749 | { | |
6573d9c6 | 750 | return job->user_paused; |
0df4ba58 JS |
751 | } |
752 | ||
0ec4dfb8 | 753 | void block_job_user_resume(BlockJob *job, Error **errp) |
0df4ba58 | 754 | { |
0ec4dfb8 JS |
755 | assert(job); |
756 | if (!job->user_paused || job->pause_count <= 0) { | |
757 | error_setg(errp, "Can't resume a job that was not paused"); | |
758 | return; | |
0df4ba58 | 759 | } |
0ec4dfb8 JS |
760 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_RESUME, errp)) { |
761 | return; | |
762 | } | |
763 | block_job_iostatus_reset(job); | |
764 | job->user_paused = false; | |
765 | block_job_resume(job); | |
0df4ba58 JS |
766 | } |
767 | ||
b76e4458 | 768 | void block_job_cancel(BlockJob *job, bool force) |
8acc72a4 | 769 | { |
e0cf0364 | 770 | if (job->status == BLOCK_JOB_STATUS_CONCLUDED) { |
75f71059 | 771 | block_job_do_dismiss(job); |
11b61fbc JS |
772 | return; |
773 | } | |
b76e4458 | 774 | block_job_cancel_async(job, force); |
11b61fbc | 775 | if (!block_job_started(job)) { |
5ccac6f1 | 776 | block_job_completed(job, -ECANCELED); |
11b61fbc JS |
777 | } else if (job->deferred_to_main_loop) { |
778 | block_job_completed_txn_abort(job); | |
779 | } else { | |
780 | block_job_enter(job); | |
5ccac6f1 | 781 | } |
8acc72a4 PB |
782 | } |
783 | ||
b76e4458 | 784 | void block_job_user_cancel(BlockJob *job, bool force, Error **errp) |
0ec4dfb8 JS |
785 | { |
786 | if (block_job_apply_verb(job, BLOCK_JOB_VERB_CANCEL, errp)) { | |
787 | return; | |
788 | } | |
b76e4458 | 789 | block_job_cancel(job, force); |
0ec4dfb8 JS |
790 | } |
791 | ||
345f9e1b HR |
792 | /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be |
793 | * used with block_job_finish_sync() without the need for (rather nasty) | |
794 | * function pointer casts there. */ | |
795 | static void block_job_cancel_err(BlockJob *job, Error **errp) | |
796 | { | |
b76e4458 | 797 | block_job_cancel(job, false); |
345f9e1b HR |
798 | } |
799 | ||
800 | int block_job_cancel_sync(BlockJob *job) | |
801 | { | |
802 | return block_job_finish_sync(job, &block_job_cancel_err, NULL); | |
803 | } | |
804 | ||
a1a2af07 KW |
805 | void block_job_cancel_sync_all(void) |
806 | { | |
807 | BlockJob *job; | |
808 | AioContext *aio_context; | |
809 | ||
810 | while ((job = QLIST_FIRST(&block_jobs))) { | |
b6d2e599 | 811 | aio_context = blk_get_aio_context(job->blk); |
a1a2af07 KW |
812 | aio_context_acquire(aio_context); |
813 | block_job_cancel_sync(job); | |
814 | aio_context_release(aio_context); | |
815 | } | |
816 | } | |
817 | ||
345f9e1b HR |
818 | int block_job_complete_sync(BlockJob *job, Error **errp) |
819 | { | |
820 | return block_job_finish_sync(job, &block_job_complete, errp); | |
821 | } | |
822 | ||
05df8a6a KW |
823 | void block_job_progress_update(BlockJob *job, uint64_t done) |
824 | { | |
825 | job->offset += done; | |
826 | } | |
827 | ||
828 | void block_job_progress_set_remaining(BlockJob *job, uint64_t remaining) | |
829 | { | |
830 | job->len = job->offset + remaining; | |
831 | } | |
832 | ||
559b935f | 833 | BlockJobInfo *block_job_query(BlockJob *job, Error **errp) |
30e628b7 | 834 | { |
559b935f JS |
835 | BlockJobInfo *info; |
836 | ||
837 | if (block_job_is_internal(job)) { | |
838 | error_setg(errp, "Cannot query QEMU internal jobs"); | |
839 | return NULL; | |
840 | } | |
841 | info = g_new0(BlockJobInfo, 1); | |
977c736f | 842 | info->type = g_strdup(BlockJobType_str(job->driver->job_type)); |
8ccb9569 | 843 | info->device = g_strdup(job->id); |
32c81a4a | 844 | info->len = job->len; |
fc24908e | 845 | info->busy = atomic_read(&job->busy); |
751ebd76 | 846 | info->paused = job->pause_count > 0; |
32c81a4a PB |
847 | info->offset = job->offset; |
848 | info->speed = job->speed; | |
849 | info->io_status = job->iostatus; | |
ef6dbf1e | 850 | info->ready = job->ready; |
58b295ba | 851 | info->status = job->status; |
b40dacdc JS |
852 | info->auto_finalize = job->auto_finalize; |
853 | info->auto_dismiss = job->auto_dismiss; | |
ab9ba614 JS |
854 | info->has_error = job->ret != 0; |
855 | info->error = job->ret ? g_strdup(strerror(-job->ret)) : NULL; | |
30e628b7 PB |
856 | return info; |
857 | } | |
32c81a4a PB |
858 | |
859 | static void block_job_iostatus_set_err(BlockJob *job, int error) | |
860 | { | |
861 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { | |
862 | job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : | |
863 | BLOCK_DEVICE_IO_STATUS_FAILED; | |
864 | } | |
865 | } | |
866 | ||
8254b6d9 | 867 | static void block_job_event_cancelled(BlockJob *job) |
bcada37b | 868 | { |
559b935f JS |
869 | if (block_job_is_internal(job)) { |
870 | return; | |
871 | } | |
872 | ||
bcada37b | 873 | qapi_event_send_block_job_cancelled(job->driver->job_type, |
8ccb9569 | 874 | job->id, |
bcada37b WX |
875 | job->len, |
876 | job->offset, | |
877 | job->speed, | |
878 | &error_abort); | |
879 | } | |
32c81a4a | 880 | |
8254b6d9 | 881 | static void block_job_event_completed(BlockJob *job, const char *msg) |
a66a2a36 | 882 | { |
559b935f JS |
883 | if (block_job_is_internal(job)) { |
884 | return; | |
885 | } | |
886 | ||
bcada37b | 887 | qapi_event_send_block_job_completed(job->driver->job_type, |
8ccb9569 | 888 | job->id, |
bcada37b WX |
889 | job->len, |
890 | job->offset, | |
891 | job->speed, | |
892 | !!msg, | |
893 | msg, | |
894 | &error_abort); | |
a66a2a36 PB |
895 | } |
896 | ||
5f241594 JS |
897 | static int block_job_event_pending(BlockJob *job) |
898 | { | |
899 | block_job_state_transition(job, BLOCK_JOB_STATUS_PENDING); | |
900 | if (!job->auto_finalize && !block_job_is_internal(job)) { | |
901 | qapi_event_send_block_job_pending(job->driver->job_type, | |
902 | job->id, | |
903 | &error_abort); | |
904 | } | |
905 | return 0; | |
906 | } | |
907 | ||
88691b37 PB |
908 | /* |
909 | * API for block job drivers and the block layer. These functions are | |
910 | * declared in blockjob_int.h. | |
911 | */ | |
912 | ||
913 | void *block_job_create(const char *job_id, const BlockJobDriver *driver, | |
75859b94 | 914 | BlockJobTxn *txn, BlockDriverState *bs, uint64_t perm, |
88691b37 PB |
915 | uint64_t shared_perm, int64_t speed, int flags, |
916 | BlockCompletionFunc *cb, void *opaque, Error **errp) | |
917 | { | |
918 | BlockBackend *blk; | |
919 | BlockJob *job; | |
920 | int ret; | |
921 | ||
922 | if (bs->job) { | |
923 | error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); | |
924 | return NULL; | |
925 | } | |
926 | ||
927 | if (job_id == NULL && !(flags & BLOCK_JOB_INTERNAL)) { | |
928 | job_id = bdrv_get_device_name(bs); | |
929 | if (!*job_id) { | |
930 | error_setg(errp, "An explicit job ID is required for this node"); | |
931 | return NULL; | |
932 | } | |
933 | } | |
934 | ||
935 | if (job_id) { | |
936 | if (flags & BLOCK_JOB_INTERNAL) { | |
937 | error_setg(errp, "Cannot specify job ID for internal block job"); | |
938 | return NULL; | |
939 | } | |
940 | ||
941 | if (!id_wellformed(job_id)) { | |
942 | error_setg(errp, "Invalid job ID '%s'", job_id); | |
943 | return NULL; | |
944 | } | |
945 | ||
946 | if (block_job_get(job_id)) { | |
947 | error_setg(errp, "Job ID '%s' already in use", job_id); | |
948 | return NULL; | |
949 | } | |
950 | } | |
951 | ||
952 | blk = blk_new(perm, shared_perm); | |
953 | ret = blk_insert_bs(blk, bs, errp); | |
954 | if (ret < 0) { | |
955 | blk_unref(blk); | |
956 | return NULL; | |
957 | } | |
958 | ||
959 | job = g_malloc0(driver->instance_size); | |
960 | job->driver = driver; | |
961 | job->id = g_strdup(job_id); | |
962 | job->blk = blk; | |
963 | job->cb = cb; | |
964 | job->opaque = opaque; | |
965 | job->busy = false; | |
966 | job->paused = true; | |
967 | job->pause_count = 1; | |
968 | job->refcnt = 1; | |
5f241594 | 969 | job->auto_finalize = !(flags & BLOCK_JOB_MANUAL_FINALIZE); |
75f71059 | 970 | job->auto_dismiss = !(flags & BLOCK_JOB_MANUAL_DISMISS); |
c9de4050 | 971 | block_job_state_transition(job, BLOCK_JOB_STATUS_CREATED); |
fc24908e PB |
972 | aio_timer_init(qemu_get_aio_context(), &job->sleep_timer, |
973 | QEMU_CLOCK_REALTIME, SCALE_NS, | |
974 | block_job_sleep_timer_cb, job); | |
88691b37 PB |
975 | |
976 | error_setg(&job->blocker, "block device is in use by block job: %s", | |
977c736f | 977 | BlockJobType_str(driver->job_type)); |
88691b37 PB |
978 | block_job_add_bdrv(job, "main node", bs, 0, BLK_PERM_ALL, &error_abort); |
979 | bs->job = job; | |
980 | ||
88691b37 PB |
981 | bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); |
982 | ||
983 | QLIST_INSERT_HEAD(&block_jobs, job, job_list); | |
984 | ||
985 | blk_add_aio_context_notifier(blk, block_job_attached_aio_context, | |
986 | block_job_detach_aio_context, job); | |
987 | ||
988 | /* Only set speed when necessary to avoid NotSupported error */ | |
989 | if (speed != 0) { | |
990 | Error *local_err = NULL; | |
991 | ||
992 | block_job_set_speed(job, speed, &local_err); | |
993 | if (local_err) { | |
3925cd3b | 994 | block_job_early_fail(job); |
88691b37 PB |
995 | error_propagate(errp, local_err); |
996 | return NULL; | |
997 | } | |
998 | } | |
75859b94 JS |
999 | |
1000 | /* Single jobs are modeled as single-job transactions for sake of | |
1001 | * consolidating the job management logic */ | |
1002 | if (!txn) { | |
1003 | txn = block_job_txn_new(); | |
1004 | block_job_txn_add_job(txn, job); | |
1005 | block_job_txn_unref(txn); | |
1006 | } else { | |
1007 | block_job_txn_add_job(txn, job); | |
1008 | } | |
1009 | ||
88691b37 PB |
1010 | return job; |
1011 | } | |
1012 | ||
88691b37 PB |
1013 | void block_job_early_fail(BlockJob *job) |
1014 | { | |
3925cd3b JS |
1015 | assert(job->status == BLOCK_JOB_STATUS_CREATED); |
1016 | block_job_decommission(job); | |
88691b37 PB |
1017 | } |
1018 | ||
1019 | void block_job_completed(BlockJob *job, int ret) | |
1020 | { | |
75859b94 | 1021 | assert(job && job->txn && !job->completed); |
88691b37 | 1022 | assert(blk_bs(job->blk)->job == job); |
88691b37 PB |
1023 | job->completed = true; |
1024 | job->ret = ret; | |
35d6b368 JS |
1025 | block_job_update_rc(job); |
1026 | trace_block_job_completed(job, ret, job->ret); | |
1027 | if (job->ret) { | |
88691b37 PB |
1028 | block_job_completed_txn_abort(job); |
1029 | } else { | |
1030 | block_job_completed_txn_success(job); | |
1031 | } | |
1032 | } | |
1033 | ||
1034 | static bool block_job_should_pause(BlockJob *job) | |
1035 | { | |
1036 | return job->pause_count > 0; | |
1037 | } | |
1038 | ||
fc24908e PB |
1039 | /* Yield, and schedule a timer to reenter the coroutine after @ns nanoseconds. |
1040 | * Reentering the job coroutine with block_job_enter() before the timer has | |
1041 | * expired is allowed and cancels the timer. | |
1042 | * | |
1043 | * If @ns is (uint64_t) -1, no timer is scheduled and block_job_enter() must be | |
1044 | * called explicitly. */ | |
1045 | static void block_job_do_yield(BlockJob *job, uint64_t ns) | |
356f59b8 | 1046 | { |
fc24908e PB |
1047 | block_job_lock(); |
1048 | if (ns != -1) { | |
1049 | timer_mod(&job->sleep_timer, ns); | |
1050 | } | |
356f59b8 | 1051 | job->busy = false; |
fc24908e | 1052 | block_job_unlock(); |
356f59b8 PB |
1053 | qemu_coroutine_yield(); |
1054 | ||
1055 | /* Set by block_job_enter before re-entering the coroutine. */ | |
1056 | assert(job->busy); | |
1057 | } | |
1058 | ||
88691b37 PB |
1059 | void coroutine_fn block_job_pause_point(BlockJob *job) |
1060 | { | |
1061 | assert(job && block_job_started(job)); | |
1062 | ||
1063 | if (!block_job_should_pause(job)) { | |
1064 | return; | |
1065 | } | |
1066 | if (block_job_is_cancelled(job)) { | |
1067 | return; | |
1068 | } | |
1069 | ||
1070 | if (job->driver->pause) { | |
1071 | job->driver->pause(job); | |
1072 | } | |
1073 | ||
1074 | if (block_job_should_pause(job) && !block_job_is_cancelled(job)) { | |
58b295ba | 1075 | BlockJobStatus status = job->status; |
c9de4050 JS |
1076 | block_job_state_transition(job, status == BLOCK_JOB_STATUS_READY ? \ |
1077 | BLOCK_JOB_STATUS_STANDBY : \ | |
1078 | BLOCK_JOB_STATUS_PAUSED); | |
88691b37 | 1079 | job->paused = true; |
fc24908e | 1080 | block_job_do_yield(job, -1); |
88691b37 | 1081 | job->paused = false; |
c9de4050 | 1082 | block_job_state_transition(job, status); |
88691b37 PB |
1083 | } |
1084 | ||
1085 | if (job->driver->resume) { | |
1086 | job->driver->resume(job); | |
1087 | } | |
1088 | } | |
1089 | ||
aa9ef2e6 JS |
1090 | /* |
1091 | * Conditionally enter a block_job pending a call to fn() while | |
1092 | * under the block_job_lock critical section. | |
1093 | */ | |
1094 | static void block_job_enter_cond(BlockJob *job, bool(*fn)(BlockJob *job)) | |
88691b37 | 1095 | { |
eb05e011 PB |
1096 | if (!block_job_started(job)) { |
1097 | return; | |
1098 | } | |
1099 | if (job->deferred_to_main_loop) { | |
1100 | return; | |
1101 | } | |
1102 | ||
fc24908e | 1103 | block_job_lock(); |
356f59b8 | 1104 | if (job->busy) { |
fc24908e | 1105 | block_job_unlock(); |
356f59b8 | 1106 | return; |
88691b37 | 1107 | } |
356f59b8 | 1108 | |
aa9ef2e6 JS |
1109 | if (fn && !fn(job)) { |
1110 | block_job_unlock(); | |
1111 | return; | |
1112 | } | |
1113 | ||
fc24908e PB |
1114 | assert(!job->deferred_to_main_loop); |
1115 | timer_del(&job->sleep_timer); | |
356f59b8 | 1116 | job->busy = true; |
fc24908e | 1117 | block_job_unlock(); |
356f59b8 | 1118 | aio_co_wake(job->co); |
88691b37 PB |
1119 | } |
1120 | ||
aa9ef2e6 JS |
1121 | void block_job_enter(BlockJob *job) |
1122 | { | |
1123 | block_job_enter_cond(job, NULL); | |
1124 | } | |
1125 | ||
88691b37 PB |
1126 | bool block_job_is_cancelled(BlockJob *job) |
1127 | { | |
1128 | return job->cancelled; | |
1129 | } | |
1130 | ||
5bf1d5a7 | 1131 | void block_job_sleep_ns(BlockJob *job, int64_t ns) |
88691b37 PB |
1132 | { |
1133 | assert(job->busy); | |
1134 | ||
1135 | /* Check cancellation *before* setting busy = false, too! */ | |
1136 | if (block_job_is_cancelled(job)) { | |
1137 | return; | |
1138 | } | |
1139 | ||
88691b37 | 1140 | if (!block_job_should_pause(job)) { |
fc24908e | 1141 | block_job_do_yield(job, qemu_clock_get_ns(QEMU_CLOCK_REALTIME) + ns); |
88691b37 | 1142 | } |
88691b37 PB |
1143 | |
1144 | block_job_pause_point(job); | |
1145 | } | |
1146 | ||
1147 | void block_job_yield(BlockJob *job) | |
1148 | { | |
1149 | assert(job->busy); | |
1150 | ||
1151 | /* Check cancellation *before* setting busy = false, too! */ | |
1152 | if (block_job_is_cancelled(job)) { | |
1153 | return; | |
1154 | } | |
1155 | ||
88691b37 | 1156 | if (!block_job_should_pause(job)) { |
fc24908e | 1157 | block_job_do_yield(job, -1); |
88691b37 | 1158 | } |
88691b37 PB |
1159 | |
1160 | block_job_pause_point(job); | |
1161 | } | |
1162 | ||
2caf63a9 PB |
1163 | void block_job_iostatus_reset(BlockJob *job) |
1164 | { | |
4c241cf5 PB |
1165 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { |
1166 | return; | |
1167 | } | |
1168 | assert(job->user_paused && job->pause_count > 0); | |
2caf63a9 PB |
1169 | job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; |
1170 | } | |
1171 | ||
bcada37b | 1172 | void block_job_event_ready(BlockJob *job) |
a66a2a36 | 1173 | { |
c9de4050 | 1174 | block_job_state_transition(job, BLOCK_JOB_STATUS_READY); |
ef6dbf1e HR |
1175 | job->ready = true; |
1176 | ||
559b935f JS |
1177 | if (block_job_is_internal(job)) { |
1178 | return; | |
1179 | } | |
1180 | ||
518848a2 | 1181 | qapi_event_send_block_job_ready(job->driver->job_type, |
8ccb9569 | 1182 | job->id, |
518848a2 MA |
1183 | job->len, |
1184 | job->offset, | |
1185 | job->speed, &error_abort); | |
a66a2a36 PB |
1186 | } |
1187 | ||
81e254dc | 1188 | BlockErrorAction block_job_error_action(BlockJob *job, BlockdevOnError on_err, |
32c81a4a PB |
1189 | int is_read, int error) |
1190 | { | |
1191 | BlockErrorAction action; | |
1192 | ||
1193 | switch (on_err) { | |
1194 | case BLOCKDEV_ON_ERROR_ENOSPC: | |
8c398252 | 1195 | case BLOCKDEV_ON_ERROR_AUTO: |
a589569f WX |
1196 | action = (error == ENOSPC) ? |
1197 | BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; | |
32c81a4a PB |
1198 | break; |
1199 | case BLOCKDEV_ON_ERROR_STOP: | |
a589569f | 1200 | action = BLOCK_ERROR_ACTION_STOP; |
32c81a4a PB |
1201 | break; |
1202 | case BLOCKDEV_ON_ERROR_REPORT: | |
a589569f | 1203 | action = BLOCK_ERROR_ACTION_REPORT; |
32c81a4a PB |
1204 | break; |
1205 | case BLOCKDEV_ON_ERROR_IGNORE: | |
a589569f | 1206 | action = BLOCK_ERROR_ACTION_IGNORE; |
32c81a4a PB |
1207 | break; |
1208 | default: | |
1209 | abort(); | |
1210 | } | |
559b935f JS |
1211 | if (!block_job_is_internal(job)) { |
1212 | qapi_event_send_block_job_error(job->id, | |
1213 | is_read ? IO_OPERATION_TYPE_READ : | |
1214 | IO_OPERATION_TYPE_WRITE, | |
1215 | action, &error_abort); | |
1216 | } | |
a589569f | 1217 | if (action == BLOCK_ERROR_ACTION_STOP) { |
0ec4dfb8 | 1218 | block_job_pause(job); |
751ebd76 | 1219 | /* make the pause user visible, which will be resumed from QMP. */ |
0ec4dfb8 | 1220 | job->user_paused = true; |
32c81a4a | 1221 | block_job_iostatus_set_err(job, error); |
32c81a4a PB |
1222 | } |
1223 | return action; | |
1224 | } | |
dec7d421 SH |
1225 | |
1226 | typedef struct { | |
1227 | BlockJob *job; | |
dec7d421 SH |
1228 | AioContext *aio_context; |
1229 | BlockJobDeferToMainLoopFn *fn; | |
1230 | void *opaque; | |
1231 | } BlockJobDeferToMainLoopData; | |
1232 | ||
1233 | static void block_job_defer_to_main_loop_bh(void *opaque) | |
1234 | { | |
1235 | BlockJobDeferToMainLoopData *data = opaque; | |
1236 | AioContext *aio_context; | |
1237 | ||
dec7d421 SH |
1238 | /* Prevent race with block_job_defer_to_main_loop() */ |
1239 | aio_context_acquire(data->aio_context); | |
1240 | ||
1241 | /* Fetch BDS AioContext again, in case it has changed */ | |
b6d2e599 | 1242 | aio_context = blk_get_aio_context(data->job->blk); |
d79df2a2 PB |
1243 | if (aio_context != data->aio_context) { |
1244 | aio_context_acquire(aio_context); | |
1245 | } | |
dec7d421 SH |
1246 | |
1247 | data->fn(data->job, data->opaque); | |
1248 | ||
d79df2a2 PB |
1249 | if (aio_context != data->aio_context) { |
1250 | aio_context_release(aio_context); | |
1251 | } | |
dec7d421 SH |
1252 | |
1253 | aio_context_release(data->aio_context); | |
1254 | ||
1255 | g_free(data); | |
1256 | } | |
1257 | ||
1258 | void block_job_defer_to_main_loop(BlockJob *job, | |
1259 | BlockJobDeferToMainLoopFn *fn, | |
1260 | void *opaque) | |
1261 | { | |
1262 | BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data)); | |
1263 | data->job = job; | |
b6d2e599 | 1264 | data->aio_context = blk_get_aio_context(job->blk); |
dec7d421 SH |
1265 | data->fn = fn; |
1266 | data->opaque = opaque; | |
794f0141 | 1267 | job->deferred_to_main_loop = true; |
dec7d421 | 1268 | |
fffb6e12 PB |
1269 | aio_bh_schedule_oneshot(qemu_get_aio_context(), |
1270 | block_job_defer_to_main_loop_bh, data); | |
dec7d421 | 1271 | } |