]>
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 | ||
26 | #include "config-host.h" | |
27 | #include "qemu-common.h" | |
28 | #include "trace.h" | |
737e150e PB |
29 | #include "block/block.h" |
30 | #include "block/blockjob.h" | |
31 | #include "block/block_int.h" | |
373340b2 | 32 | #include "sysemu/block-backend.h" |
cc7a8ea7 | 33 | #include "qapi/qmp/qerror.h" |
7b1b5d19 | 34 | #include "qapi/qmp/qjson.h" |
10817bf0 | 35 | #include "qemu/coroutine.h" |
2f0c9fe6 | 36 | #include "qmp-commands.h" |
1de7afc9 | 37 | #include "qemu/timer.h" |
5a2d2cbd | 38 | #include "qapi-event.h" |
2f0c9fe6 | 39 | |
3fc4b10a | 40 | void *block_job_create(const BlockJobDriver *driver, BlockDriverState *bs, |
097310b5 | 41 | int64_t speed, BlockCompletionFunc *cb, |
2f0c9fe6 PB |
42 | void *opaque, Error **errp) |
43 | { | |
44 | BlockJob *job; | |
45 | ||
628ff683 | 46 | if (bs->job) { |
c6bd8c70 | 47 | error_setg(errp, QERR_DEVICE_IN_USE, bdrv_get_device_name(bs)); |
2f0c9fe6 PB |
48 | return NULL; |
49 | } | |
fa510ebf | 50 | bdrv_ref(bs); |
3fc4b10a | 51 | job = g_malloc0(driver->instance_size); |
3718d8ab FZ |
52 | error_setg(&job->blocker, "block device is in use by block job: %s", |
53 | BlockJobType_lookup[driver->job_type]); | |
54 | bdrv_op_block_all(bs, job->blocker); | |
b112a65c | 55 | bdrv_op_unblock(bs, BLOCK_OP_TYPE_DATAPLANE, job->blocker); |
3718d8ab | 56 | |
3fc4b10a | 57 | job->driver = driver; |
8ccb9569 | 58 | job->id = g_strdup(bdrv_get_device_name(bs)); |
2f0c9fe6 PB |
59 | job->bs = bs; |
60 | job->cb = cb; | |
61 | job->opaque = opaque; | |
62 | job->busy = true; | |
18930ba3 | 63 | job->refcnt = 1; |
2f0c9fe6 PB |
64 | bs->job = job; |
65 | ||
66 | /* Only set speed when necessary to avoid NotSupported error */ | |
67 | if (speed != 0) { | |
68 | Error *local_err = NULL; | |
69 | ||
70 | block_job_set_speed(job, speed, &local_err); | |
84d18f06 | 71 | if (local_err) { |
18930ba3 | 72 | block_job_unref(job); |
2f0c9fe6 PB |
73 | error_propagate(errp, local_err); |
74 | return NULL; | |
75 | } | |
76 | } | |
77 | return job; | |
78 | } | |
79 | ||
18930ba3 | 80 | void block_job_ref(BlockJob *job) |
2f0c9fe6 | 81 | { |
18930ba3 FZ |
82 | ++job->refcnt; |
83 | } | |
2f0c9fe6 | 84 | |
18930ba3 FZ |
85 | void block_job_unref(BlockJob *job) |
86 | { | |
87 | if (--job->refcnt == 0) { | |
88 | job->bs->job = NULL; | |
89 | bdrv_op_unblock_all(job->bs, job->blocker); | |
90 | bdrv_unref(job->bs); | |
91 | error_free(job->blocker); | |
92 | g_free(job->id); | |
93 | g_free(job); | |
94 | } | |
2f0c9fe6 PB |
95 | } |
96 | ||
97031164 TW |
97 | void block_job_completed(BlockJob *job, int ret) |
98 | { | |
99 | BlockDriverState *bs = job->bs; | |
100 | ||
101 | assert(bs->job == job); | |
a689dbf2 FZ |
102 | assert(!job->completed); |
103 | job->completed = true; | |
104 | job->ret = ret; | |
97031164 | 105 | job->cb(job->opaque, ret); |
18930ba3 | 106 | block_job_unref(job); |
97031164 TW |
107 | } |
108 | ||
2f0c9fe6 PB |
109 | void block_job_set_speed(BlockJob *job, int64_t speed, Error **errp) |
110 | { | |
111 | Error *local_err = NULL; | |
112 | ||
3fc4b10a | 113 | if (!job->driver->set_speed) { |
c6bd8c70 | 114 | error_setg(errp, QERR_UNSUPPORTED); |
2f0c9fe6 PB |
115 | return; |
116 | } | |
3fc4b10a | 117 | job->driver->set_speed(job, speed, &local_err); |
84d18f06 | 118 | if (local_err) { |
2f0c9fe6 PB |
119 | error_propagate(errp, local_err); |
120 | return; | |
121 | } | |
122 | ||
123 | job->speed = speed; | |
124 | } | |
125 | ||
aeae883b PB |
126 | void block_job_complete(BlockJob *job, Error **errp) |
127 | { | |
751ebd76 | 128 | if (job->pause_count || job->cancelled || !job->driver->complete) { |
8ccb9569 | 129 | error_setg(errp, QERR_BLOCK_JOB_NOT_READY, job->id); |
aeae883b PB |
130 | return; |
131 | } | |
132 | ||
3fc4b10a | 133 | job->driver->complete(job, errp); |
aeae883b PB |
134 | } |
135 | ||
8acc72a4 | 136 | void block_job_pause(BlockJob *job) |
2f0c9fe6 | 137 | { |
751ebd76 | 138 | job->pause_count++; |
8acc72a4 PB |
139 | } |
140 | ||
141 | bool block_job_is_paused(BlockJob *job) | |
142 | { | |
751ebd76 | 143 | return job->pause_count > 0; |
8acc72a4 PB |
144 | } |
145 | ||
146 | void block_job_resume(BlockJob *job) | |
147 | { | |
751ebd76 FZ |
148 | assert(job->pause_count > 0); |
149 | job->pause_count--; | |
150 | if (job->pause_count) { | |
151 | return; | |
152 | } | |
153 | block_job_enter(job); | |
154 | } | |
155 | ||
156 | void block_job_enter(BlockJob *job) | |
157 | { | |
32c81a4a | 158 | block_job_iostatus_reset(job); |
2f0c9fe6 PB |
159 | if (job->co && !job->busy) { |
160 | qemu_coroutine_enter(job->co, NULL); | |
161 | } | |
162 | } | |
163 | ||
8acc72a4 PB |
164 | void block_job_cancel(BlockJob *job) |
165 | { | |
166 | job->cancelled = true; | |
751ebd76 | 167 | block_job_enter(job); |
8acc72a4 PB |
168 | } |
169 | ||
2f0c9fe6 PB |
170 | bool block_job_is_cancelled(BlockJob *job) |
171 | { | |
172 | return job->cancelled; | |
173 | } | |
174 | ||
32c81a4a PB |
175 | void block_job_iostatus_reset(BlockJob *job) |
176 | { | |
177 | job->iostatus = BLOCK_DEVICE_IO_STATUS_OK; | |
3fc4b10a FZ |
178 | if (job->driver->iostatus_reset) { |
179 | job->driver->iostatus_reset(job); | |
3bd293c3 | 180 | } |
32c81a4a PB |
181 | } |
182 | ||
345f9e1b | 183 | struct BlockFinishData { |
2f0c9fe6 | 184 | BlockJob *job; |
097310b5 | 185 | BlockCompletionFunc *cb; |
2f0c9fe6 PB |
186 | void *opaque; |
187 | bool cancelled; | |
188 | int ret; | |
189 | }; | |
190 | ||
345f9e1b | 191 | static void block_job_finish_cb(void *opaque, int ret) |
2f0c9fe6 | 192 | { |
345f9e1b | 193 | struct BlockFinishData *data = opaque; |
2f0c9fe6 PB |
194 | |
195 | data->cancelled = block_job_is_cancelled(data->job); | |
196 | data->ret = ret; | |
197 | data->cb(data->opaque, ret); | |
198 | } | |
199 | ||
345f9e1b HR |
200 | static int block_job_finish_sync(BlockJob *job, |
201 | void (*finish)(BlockJob *, Error **errp), | |
202 | Error **errp) | |
2f0c9fe6 | 203 | { |
345f9e1b | 204 | struct BlockFinishData data; |
2f0c9fe6 | 205 | BlockDriverState *bs = job->bs; |
345f9e1b | 206 | Error *local_err = NULL; |
2f0c9fe6 PB |
207 | |
208 | assert(bs->job == job); | |
209 | ||
210 | /* Set up our own callback to store the result and chain to | |
211 | * the original callback. | |
212 | */ | |
213 | data.job = job; | |
214 | data.cb = job->cb; | |
215 | data.opaque = job->opaque; | |
216 | data.ret = -EINPROGRESS; | |
345f9e1b | 217 | job->cb = block_job_finish_cb; |
2f0c9fe6 | 218 | job->opaque = &data; |
345f9e1b HR |
219 | finish(job, &local_err); |
220 | if (local_err) { | |
221 | error_propagate(errp, local_err); | |
222 | return -EBUSY; | |
223 | } | |
2f0c9fe6 | 224 | while (data.ret == -EINPROGRESS) { |
b47ec2c4 | 225 | aio_poll(bdrv_get_aio_context(bs), true); |
2f0c9fe6 PB |
226 | } |
227 | return (data.cancelled && data.ret == 0) ? -ECANCELED : data.ret; | |
228 | } | |
229 | ||
345f9e1b HR |
230 | /* A wrapper around block_job_cancel() taking an Error ** parameter so it may be |
231 | * used with block_job_finish_sync() without the need for (rather nasty) | |
232 | * function pointer casts there. */ | |
233 | static void block_job_cancel_err(BlockJob *job, Error **errp) | |
234 | { | |
235 | block_job_cancel(job); | |
236 | } | |
237 | ||
238 | int block_job_cancel_sync(BlockJob *job) | |
239 | { | |
240 | return block_job_finish_sync(job, &block_job_cancel_err, NULL); | |
241 | } | |
242 | ||
243 | int block_job_complete_sync(BlockJob *job, Error **errp) | |
244 | { | |
245 | return block_job_finish_sync(job, &block_job_complete, errp); | |
246 | } | |
247 | ||
7483d1e5 | 248 | void block_job_sleep_ns(BlockJob *job, QEMUClockType type, int64_t ns) |
2f0c9fe6 | 249 | { |
8acc72a4 PB |
250 | assert(job->busy); |
251 | ||
2f0c9fe6 | 252 | /* Check cancellation *before* setting busy = false, too! */ |
8acc72a4 PB |
253 | if (block_job_is_cancelled(job)) { |
254 | return; | |
255 | } | |
256 | ||
257 | job->busy = false; | |
258 | if (block_job_is_paused(job)) { | |
259 | qemu_coroutine_yield(); | |
260 | } else { | |
0b9caf9b | 261 | co_aio_sleep_ns(bdrv_get_aio_context(job->bs), type, ns); |
2f0c9fe6 | 262 | } |
8acc72a4 | 263 | job->busy = true; |
2f0c9fe6 | 264 | } |
30e628b7 | 265 | |
dc71ce45 FZ |
266 | void block_job_yield(BlockJob *job) |
267 | { | |
268 | assert(job->busy); | |
269 | ||
270 | /* Check cancellation *before* setting busy = false, too! */ | |
271 | if (block_job_is_cancelled(job)) { | |
272 | return; | |
273 | } | |
274 | ||
275 | job->busy = false; | |
276 | qemu_coroutine_yield(); | |
277 | job->busy = true; | |
278 | } | |
279 | ||
30e628b7 PB |
280 | BlockJobInfo *block_job_query(BlockJob *job) |
281 | { | |
282 | BlockJobInfo *info = g_new0(BlockJobInfo, 1); | |
79e14bf7 | 283 | info->type = g_strdup(BlockJobType_lookup[job->driver->job_type]); |
8ccb9569 | 284 | info->device = g_strdup(job->id); |
32c81a4a PB |
285 | info->len = job->len; |
286 | info->busy = job->busy; | |
751ebd76 | 287 | info->paused = job->pause_count > 0; |
32c81a4a PB |
288 | info->offset = job->offset; |
289 | info->speed = job->speed; | |
290 | info->io_status = job->iostatus; | |
ef6dbf1e | 291 | info->ready = job->ready; |
30e628b7 PB |
292 | return info; |
293 | } | |
32c81a4a PB |
294 | |
295 | static void block_job_iostatus_set_err(BlockJob *job, int error) | |
296 | { | |
297 | if (job->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { | |
298 | job->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : | |
299 | BLOCK_DEVICE_IO_STATUS_FAILED; | |
300 | } | |
301 | } | |
302 | ||
bcada37b WX |
303 | void block_job_event_cancelled(BlockJob *job) |
304 | { | |
305 | qapi_event_send_block_job_cancelled(job->driver->job_type, | |
8ccb9569 | 306 | job->id, |
bcada37b WX |
307 | job->len, |
308 | job->offset, | |
309 | job->speed, | |
310 | &error_abort); | |
311 | } | |
32c81a4a | 312 | |
bcada37b | 313 | void block_job_event_completed(BlockJob *job, const char *msg) |
a66a2a36 | 314 | { |
bcada37b | 315 | qapi_event_send_block_job_completed(job->driver->job_type, |
8ccb9569 | 316 | job->id, |
bcada37b WX |
317 | job->len, |
318 | job->offset, | |
319 | job->speed, | |
320 | !!msg, | |
321 | msg, | |
322 | &error_abort); | |
a66a2a36 PB |
323 | } |
324 | ||
bcada37b | 325 | void block_job_event_ready(BlockJob *job) |
a66a2a36 | 326 | { |
ef6dbf1e HR |
327 | job->ready = true; |
328 | ||
518848a2 | 329 | qapi_event_send_block_job_ready(job->driver->job_type, |
8ccb9569 | 330 | job->id, |
518848a2 MA |
331 | job->len, |
332 | job->offset, | |
333 | job->speed, &error_abort); | |
a66a2a36 PB |
334 | } |
335 | ||
32c81a4a PB |
336 | BlockErrorAction block_job_error_action(BlockJob *job, BlockDriverState *bs, |
337 | BlockdevOnError on_err, | |
338 | int is_read, int error) | |
339 | { | |
340 | BlockErrorAction action; | |
341 | ||
342 | switch (on_err) { | |
343 | case BLOCKDEV_ON_ERROR_ENOSPC: | |
a589569f WX |
344 | action = (error == ENOSPC) ? |
345 | BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; | |
32c81a4a PB |
346 | break; |
347 | case BLOCKDEV_ON_ERROR_STOP: | |
a589569f | 348 | action = BLOCK_ERROR_ACTION_STOP; |
32c81a4a PB |
349 | break; |
350 | case BLOCKDEV_ON_ERROR_REPORT: | |
a589569f | 351 | action = BLOCK_ERROR_ACTION_REPORT; |
32c81a4a PB |
352 | break; |
353 | case BLOCKDEV_ON_ERROR_IGNORE: | |
a589569f | 354 | action = BLOCK_ERROR_ACTION_IGNORE; |
32c81a4a PB |
355 | break; |
356 | default: | |
357 | abort(); | |
358 | } | |
8ccb9569 | 359 | qapi_event_send_block_job_error(job->id, |
5a2d2cbd WX |
360 | is_read ? IO_OPERATION_TYPE_READ : |
361 | IO_OPERATION_TYPE_WRITE, | |
362 | action, &error_abort); | |
a589569f | 363 | if (action == BLOCK_ERROR_ACTION_STOP) { |
751ebd76 FZ |
364 | /* make the pause user visible, which will be resumed from QMP. */ |
365 | job->user_paused = true; | |
32c81a4a PB |
366 | block_job_pause(job); |
367 | block_job_iostatus_set_err(job, error); | |
373340b2 HR |
368 | if (bs->blk && bs != job->bs) { |
369 | blk_iostatus_set_err(bs->blk, error); | |
32c81a4a PB |
370 | } |
371 | } | |
372 | return action; | |
373 | } | |
dec7d421 SH |
374 | |
375 | typedef struct { | |
376 | BlockJob *job; | |
377 | QEMUBH *bh; | |
378 | AioContext *aio_context; | |
379 | BlockJobDeferToMainLoopFn *fn; | |
380 | void *opaque; | |
381 | } BlockJobDeferToMainLoopData; | |
382 | ||
383 | static void block_job_defer_to_main_loop_bh(void *opaque) | |
384 | { | |
385 | BlockJobDeferToMainLoopData *data = opaque; | |
386 | AioContext *aio_context; | |
387 | ||
388 | qemu_bh_delete(data->bh); | |
389 | ||
390 | /* Prevent race with block_job_defer_to_main_loop() */ | |
391 | aio_context_acquire(data->aio_context); | |
392 | ||
393 | /* Fetch BDS AioContext again, in case it has changed */ | |
394 | aio_context = bdrv_get_aio_context(data->job->bs); | |
395 | aio_context_acquire(aio_context); | |
396 | ||
397 | data->fn(data->job, data->opaque); | |
398 | ||
399 | aio_context_release(aio_context); | |
400 | ||
401 | aio_context_release(data->aio_context); | |
402 | ||
403 | g_free(data); | |
404 | } | |
405 | ||
406 | void block_job_defer_to_main_loop(BlockJob *job, | |
407 | BlockJobDeferToMainLoopFn *fn, | |
408 | void *opaque) | |
409 | { | |
410 | BlockJobDeferToMainLoopData *data = g_malloc(sizeof(*data)); | |
411 | data->job = job; | |
412 | data->bh = qemu_bh_new(block_job_defer_to_main_loop_bh, data); | |
413 | data->aio_context = bdrv_get_aio_context(job->bs); | |
414 | data->fn = fn; | |
415 | data->opaque = opaque; | |
416 | ||
417 | qemu_bh_schedule(data->bh); | |
418 | } |