]>
Commit | Line | Data |
---|---|---|
fc01f7e7 FB |
1 | /* |
2 | * QEMU System Emulator block driver | |
5fafdf24 | 3 | * |
fc01f7e7 | 4 | * Copyright (c) 2003 Fabrice Bellard |
5fafdf24 | 5 | * |
fc01f7e7 FB |
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
7 | * of this software and associated documentation files (the "Software"), to deal | |
8 | * in the Software without restriction, including without limitation the rights | |
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
10 | * copies of the Software, and to permit persons to whom the Software is | |
11 | * furnished to do so, subject to the following conditions: | |
12 | * | |
13 | * The above copyright notice and this permission notice shall be included in | |
14 | * all copies or substantial portions of the Software. | |
15 | * | |
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
19 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
22 | * THE SOFTWARE. | |
23 | */ | |
3990d09a | 24 | #include "config-host.h" |
faf07963 | 25 | #include "qemu-common.h" |
6d519a5f | 26 | #include "trace.h" |
737e150e PB |
27 | #include "block/block_int.h" |
28 | #include "block/blockjob.h" | |
1de7afc9 | 29 | #include "qemu/module.h" |
7b1b5d19 | 30 | #include "qapi/qmp/qjson.h" |
bfb197e0 | 31 | #include "sysemu/block-backend.h" |
9c17d615 | 32 | #include "sysemu/sysemu.h" |
1de7afc9 | 33 | #include "qemu/notify.h" |
737e150e | 34 | #include "block/coroutine.h" |
c13163fb | 35 | #include "block/qapi.h" |
b2023818 | 36 | #include "qmp-commands.h" |
1de7afc9 | 37 | #include "qemu/timer.h" |
a5ee7bd4 | 38 | #include "qapi-event.h" |
fc01f7e7 | 39 | |
71e72a19 | 40 | #ifdef CONFIG_BSD |
7674e7bf FB |
41 | #include <sys/types.h> |
42 | #include <sys/stat.h> | |
43 | #include <sys/ioctl.h> | |
72cf2d4f | 44 | #include <sys/queue.h> |
c5e97233 | 45 | #ifndef __DragonFly__ |
7674e7bf FB |
46 | #include <sys/disk.h> |
47 | #endif | |
c5e97233 | 48 | #endif |
7674e7bf | 49 | |
49dc768d AL |
50 | #ifdef _WIN32 |
51 | #include <windows.h> | |
52 | #endif | |
53 | ||
e4654d2d FZ |
54 | struct BdrvDirtyBitmap { |
55 | HBitmap *bitmap; | |
56 | QLIST_ENTRY(BdrvDirtyBitmap) list; | |
57 | }; | |
58 | ||
1c9805a3 SH |
59 | #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */ |
60 | ||
7c84b1b8 | 61 | static BlockAIOCB *bdrv_aio_readv_em(BlockDriverState *bs, |
f141eafe | 62 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, |
097310b5 | 63 | BlockCompletionFunc *cb, void *opaque); |
7c84b1b8 | 64 | static BlockAIOCB *bdrv_aio_writev_em(BlockDriverState *bs, |
f141eafe | 65 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, |
097310b5 | 66 | BlockCompletionFunc *cb, void *opaque); |
f9f05dc5 KW |
67 | static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs, |
68 | int64_t sector_num, int nb_sectors, | |
69 | QEMUIOVector *iov); | |
70 | static int coroutine_fn bdrv_co_writev_em(BlockDriverState *bs, | |
71 | int64_t sector_num, int nb_sectors, | |
72 | QEMUIOVector *iov); | |
775aa8b6 KW |
73 | static int coroutine_fn bdrv_co_do_preadv(BlockDriverState *bs, |
74 | int64_t offset, unsigned int bytes, QEMUIOVector *qiov, | |
470c0504 | 75 | BdrvRequestFlags flags); |
775aa8b6 KW |
76 | static int coroutine_fn bdrv_co_do_pwritev(BlockDriverState *bs, |
77 | int64_t offset, unsigned int bytes, QEMUIOVector *qiov, | |
f08f2dda | 78 | BdrvRequestFlags flags); |
7c84b1b8 MA |
79 | static BlockAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs, |
80 | int64_t sector_num, | |
81 | QEMUIOVector *qiov, | |
82 | int nb_sectors, | |
83 | BdrvRequestFlags flags, | |
097310b5 | 84 | BlockCompletionFunc *cb, |
7c84b1b8 MA |
85 | void *opaque, |
86 | bool is_write); | |
b2a61371 | 87 | static void coroutine_fn bdrv_co_do_rw(void *opaque); |
621f0589 | 88 | static int coroutine_fn bdrv_co_do_write_zeroes(BlockDriverState *bs, |
aa7bfbff | 89 | int64_t sector_num, int nb_sectors, BdrvRequestFlags flags); |
ec530c81 | 90 | |
1b7bdbc1 SH |
91 | static QTAILQ_HEAD(, BlockDriverState) bdrv_states = |
92 | QTAILQ_HEAD_INITIALIZER(bdrv_states); | |
7ee930d0 | 93 | |
dc364f4c BC |
94 | static QTAILQ_HEAD(, BlockDriverState) graph_bdrv_states = |
95 | QTAILQ_HEAD_INITIALIZER(graph_bdrv_states); | |
96 | ||
8a22f02a SH |
97 | static QLIST_HEAD(, BlockDriver) bdrv_drivers = |
98 | QLIST_HEAD_INITIALIZER(bdrv_drivers); | |
ea2384d3 | 99 | |
eb852011 MA |
100 | /* If non-zero, use only whitelisted block drivers */ |
101 | static int use_bdrv_whitelist; | |
102 | ||
9e0b22f4 SH |
103 | #ifdef _WIN32 |
104 | static int is_windows_drive_prefix(const char *filename) | |
105 | { | |
106 | return (((filename[0] >= 'a' && filename[0] <= 'z') || | |
107 | (filename[0] >= 'A' && filename[0] <= 'Z')) && | |
108 | filename[1] == ':'); | |
109 | } | |
110 | ||
111 | int is_windows_drive(const char *filename) | |
112 | { | |
113 | if (is_windows_drive_prefix(filename) && | |
114 | filename[2] == '\0') | |
115 | return 1; | |
116 | if (strstart(filename, "\\\\.\\", NULL) || | |
117 | strstart(filename, "//./", NULL)) | |
118 | return 1; | |
119 | return 0; | |
120 | } | |
121 | #endif | |
122 | ||
0563e191 | 123 | /* throttling disk I/O limits */ |
cc0681c4 BC |
124 | void bdrv_set_io_limits(BlockDriverState *bs, |
125 | ThrottleConfig *cfg) | |
98f90dba | 126 | { |
cc0681c4 | 127 | int i; |
98f90dba | 128 | |
cc0681c4 | 129 | throttle_config(&bs->throttle_state, cfg); |
98f90dba | 130 | |
cc0681c4 BC |
131 | for (i = 0; i < 2; i++) { |
132 | qemu_co_enter_next(&bs->throttled_reqs[i]); | |
98f90dba | 133 | } |
cc0681c4 BC |
134 | } |
135 | ||
136 | /* this function drain all the throttled IOs */ | |
137 | static bool bdrv_start_throttled_reqs(BlockDriverState *bs) | |
138 | { | |
139 | bool drained = false; | |
140 | bool enabled = bs->io_limits_enabled; | |
141 | int i; | |
142 | ||
143 | bs->io_limits_enabled = false; | |
144 | ||
145 | for (i = 0; i < 2; i++) { | |
146 | while (qemu_co_enter_next(&bs->throttled_reqs[i])) { | |
147 | drained = true; | |
148 | } | |
149 | } | |
150 | ||
151 | bs->io_limits_enabled = enabled; | |
98f90dba | 152 | |
cc0681c4 | 153 | return drained; |
98f90dba ZYW |
154 | } |
155 | ||
cc0681c4 | 156 | void bdrv_io_limits_disable(BlockDriverState *bs) |
0563e191 | 157 | { |
cc0681c4 | 158 | bs->io_limits_enabled = false; |
0563e191 | 159 | |
cc0681c4 BC |
160 | bdrv_start_throttled_reqs(bs); |
161 | ||
162 | throttle_destroy(&bs->throttle_state); | |
0563e191 ZYW |
163 | } |
164 | ||
cc0681c4 | 165 | static void bdrv_throttle_read_timer_cb(void *opaque) |
0563e191 | 166 | { |
cc0681c4 BC |
167 | BlockDriverState *bs = opaque; |
168 | qemu_co_enter_next(&bs->throttled_reqs[0]); | |
0563e191 ZYW |
169 | } |
170 | ||
cc0681c4 | 171 | static void bdrv_throttle_write_timer_cb(void *opaque) |
0563e191 | 172 | { |
cc0681c4 BC |
173 | BlockDriverState *bs = opaque; |
174 | qemu_co_enter_next(&bs->throttled_reqs[1]); | |
0563e191 ZYW |
175 | } |
176 | ||
cc0681c4 BC |
177 | /* should be called before bdrv_set_io_limits if a limit is set */ |
178 | void bdrv_io_limits_enable(BlockDriverState *bs) | |
179 | { | |
180 | assert(!bs->io_limits_enabled); | |
181 | throttle_init(&bs->throttle_state, | |
13af91eb | 182 | bdrv_get_aio_context(bs), |
cc0681c4 BC |
183 | QEMU_CLOCK_VIRTUAL, |
184 | bdrv_throttle_read_timer_cb, | |
185 | bdrv_throttle_write_timer_cb, | |
186 | bs); | |
187 | bs->io_limits_enabled = true; | |
188 | } | |
189 | ||
190 | /* This function makes an IO wait if needed | |
191 | * | |
192 | * @nb_sectors: the number of sectors of the IO | |
193 | * @is_write: is the IO a write | |
194 | */ | |
98f90dba | 195 | static void bdrv_io_limits_intercept(BlockDriverState *bs, |
d5103588 | 196 | unsigned int bytes, |
cc0681c4 | 197 | bool is_write) |
98f90dba | 198 | { |
cc0681c4 BC |
199 | /* does this io must wait */ |
200 | bool must_wait = throttle_schedule_timer(&bs->throttle_state, is_write); | |
98f90dba | 201 | |
cc0681c4 BC |
202 | /* if must wait or any request of this type throttled queue the IO */ |
203 | if (must_wait || | |
204 | !qemu_co_queue_empty(&bs->throttled_reqs[is_write])) { | |
205 | qemu_co_queue_wait(&bs->throttled_reqs[is_write]); | |
98f90dba ZYW |
206 | } |
207 | ||
cc0681c4 | 208 | /* the IO will be executed, do the accounting */ |
d5103588 KW |
209 | throttle_account(&bs->throttle_state, is_write, bytes); |
210 | ||
98f90dba | 211 | |
cc0681c4 BC |
212 | /* if the next request must wait -> do nothing */ |
213 | if (throttle_schedule_timer(&bs->throttle_state, is_write)) { | |
214 | return; | |
98f90dba ZYW |
215 | } |
216 | ||
cc0681c4 BC |
217 | /* else queue next request for execution */ |
218 | qemu_co_queue_next(&bs->throttled_reqs[is_write]); | |
98f90dba ZYW |
219 | } |
220 | ||
339064d5 KW |
221 | size_t bdrv_opt_mem_align(BlockDriverState *bs) |
222 | { | |
223 | if (!bs || !bs->drv) { | |
224 | /* 4k should be on the safe side */ | |
225 | return 4096; | |
226 | } | |
227 | ||
228 | return bs->bl.opt_mem_alignment; | |
229 | } | |
230 | ||
9e0b22f4 SH |
231 | /* check if the path starts with "<protocol>:" */ |
232 | static int path_has_protocol(const char *path) | |
233 | { | |
947995c0 PB |
234 | const char *p; |
235 | ||
9e0b22f4 SH |
236 | #ifdef _WIN32 |
237 | if (is_windows_drive(path) || | |
238 | is_windows_drive_prefix(path)) { | |
239 | return 0; | |
240 | } | |
947995c0 PB |
241 | p = path + strcspn(path, ":/\\"); |
242 | #else | |
243 | p = path + strcspn(path, ":/"); | |
9e0b22f4 SH |
244 | #endif |
245 | ||
947995c0 | 246 | return *p == ':'; |
9e0b22f4 SH |
247 | } |
248 | ||
83f64091 | 249 | int path_is_absolute(const char *path) |
3b0d4f61 | 250 | { |
21664424 FB |
251 | #ifdef _WIN32 |
252 | /* specific case for names like: "\\.\d:" */ | |
f53f4da9 | 253 | if (is_windows_drive(path) || is_windows_drive_prefix(path)) { |
21664424 | 254 | return 1; |
f53f4da9 PB |
255 | } |
256 | return (*path == '/' || *path == '\\'); | |
3b9f94e1 | 257 | #else |
f53f4da9 | 258 | return (*path == '/'); |
3b9f94e1 | 259 | #endif |
3b0d4f61 FB |
260 | } |
261 | ||
83f64091 FB |
262 | /* if filename is absolute, just copy it to dest. Otherwise, build a |
263 | path to it by considering it is relative to base_path. URL are | |
264 | supported. */ | |
265 | void path_combine(char *dest, int dest_size, | |
266 | const char *base_path, | |
267 | const char *filename) | |
3b0d4f61 | 268 | { |
83f64091 FB |
269 | const char *p, *p1; |
270 | int len; | |
271 | ||
272 | if (dest_size <= 0) | |
273 | return; | |
274 | if (path_is_absolute(filename)) { | |
275 | pstrcpy(dest, dest_size, filename); | |
276 | } else { | |
277 | p = strchr(base_path, ':'); | |
278 | if (p) | |
279 | p++; | |
280 | else | |
281 | p = base_path; | |
3b9f94e1 FB |
282 | p1 = strrchr(base_path, '/'); |
283 | #ifdef _WIN32 | |
284 | { | |
285 | const char *p2; | |
286 | p2 = strrchr(base_path, '\\'); | |
287 | if (!p1 || p2 > p1) | |
288 | p1 = p2; | |
289 | } | |
290 | #endif | |
83f64091 FB |
291 | if (p1) |
292 | p1++; | |
293 | else | |
294 | p1 = base_path; | |
295 | if (p1 > p) | |
296 | p = p1; | |
297 | len = p - base_path; | |
298 | if (len > dest_size - 1) | |
299 | len = dest_size - 1; | |
300 | memcpy(dest, base_path, len); | |
301 | dest[len] = '\0'; | |
302 | pstrcat(dest, dest_size, filename); | |
3b0d4f61 | 303 | } |
3b0d4f61 FB |
304 | } |
305 | ||
dc5a1371 PB |
306 | void bdrv_get_full_backing_filename(BlockDriverState *bs, char *dest, size_t sz) |
307 | { | |
308 | if (bs->backing_file[0] == '\0' || path_has_protocol(bs->backing_file)) { | |
309 | pstrcpy(dest, sz, bs->backing_file); | |
310 | } else { | |
311 | path_combine(dest, sz, bs->filename, bs->backing_file); | |
312 | } | |
313 | } | |
314 | ||
5efa9d5a | 315 | void bdrv_register(BlockDriver *bdrv) |
ea2384d3 | 316 | { |
8c5873d6 SH |
317 | /* Block drivers without coroutine functions need emulation */ |
318 | if (!bdrv->bdrv_co_readv) { | |
f9f05dc5 KW |
319 | bdrv->bdrv_co_readv = bdrv_co_readv_em; |
320 | bdrv->bdrv_co_writev = bdrv_co_writev_em; | |
321 | ||
f8c35c1d SH |
322 | /* bdrv_co_readv_em()/brdv_co_writev_em() work in terms of aio, so if |
323 | * the block driver lacks aio we need to emulate that too. | |
324 | */ | |
f9f05dc5 KW |
325 | if (!bdrv->bdrv_aio_readv) { |
326 | /* add AIO emulation layer */ | |
327 | bdrv->bdrv_aio_readv = bdrv_aio_readv_em; | |
328 | bdrv->bdrv_aio_writev = bdrv_aio_writev_em; | |
f9f05dc5 | 329 | } |
83f64091 | 330 | } |
b2e12bc6 | 331 | |
8a22f02a | 332 | QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list); |
ea2384d3 | 333 | } |
b338082b | 334 | |
7f06d47e | 335 | BlockDriverState *bdrv_new_root(void) |
b338082b | 336 | { |
7f06d47e | 337 | BlockDriverState *bs = bdrv_new(); |
e4e9986b | 338 | |
e4e9986b | 339 | QTAILQ_INSERT_TAIL(&bdrv_states, bs, device_list); |
e4e9986b MA |
340 | return bs; |
341 | } | |
342 | ||
343 | BlockDriverState *bdrv_new(void) | |
344 | { | |
345 | BlockDriverState *bs; | |
346 | int i; | |
347 | ||
5839e53b | 348 | bs = g_new0(BlockDriverState, 1); |
e4654d2d | 349 | QLIST_INIT(&bs->dirty_bitmaps); |
fbe40ff7 FZ |
350 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { |
351 | QLIST_INIT(&bs->op_blockers[i]); | |
352 | } | |
28a7282a | 353 | bdrv_iostatus_disable(bs); |
d7d512f6 | 354 | notifier_list_init(&bs->close_notifiers); |
d616b224 | 355 | notifier_with_return_list_init(&bs->before_write_notifiers); |
cc0681c4 BC |
356 | qemu_co_queue_init(&bs->throttled_reqs[0]); |
357 | qemu_co_queue_init(&bs->throttled_reqs[1]); | |
9fcb0251 | 358 | bs->refcnt = 1; |
dcd04228 | 359 | bs->aio_context = qemu_get_aio_context(); |
d7d512f6 | 360 | |
b338082b FB |
361 | return bs; |
362 | } | |
363 | ||
d7d512f6 PB |
364 | void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify) |
365 | { | |
366 | notifier_list_add(&bs->close_notifiers, notify); | |
367 | } | |
368 | ||
ea2384d3 FB |
369 | BlockDriver *bdrv_find_format(const char *format_name) |
370 | { | |
371 | BlockDriver *drv1; | |
8a22f02a SH |
372 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { |
373 | if (!strcmp(drv1->format_name, format_name)) { | |
ea2384d3 | 374 | return drv1; |
8a22f02a | 375 | } |
ea2384d3 FB |
376 | } |
377 | return NULL; | |
378 | } | |
379 | ||
b64ec4e4 | 380 | static int bdrv_is_whitelisted(BlockDriver *drv, bool read_only) |
eb852011 | 381 | { |
b64ec4e4 FZ |
382 | static const char *whitelist_rw[] = { |
383 | CONFIG_BDRV_RW_WHITELIST | |
384 | }; | |
385 | static const char *whitelist_ro[] = { | |
386 | CONFIG_BDRV_RO_WHITELIST | |
eb852011 MA |
387 | }; |
388 | const char **p; | |
389 | ||
b64ec4e4 | 390 | if (!whitelist_rw[0] && !whitelist_ro[0]) { |
eb852011 | 391 | return 1; /* no whitelist, anything goes */ |
b64ec4e4 | 392 | } |
eb852011 | 393 | |
b64ec4e4 | 394 | for (p = whitelist_rw; *p; p++) { |
eb852011 MA |
395 | if (!strcmp(drv->format_name, *p)) { |
396 | return 1; | |
397 | } | |
398 | } | |
b64ec4e4 FZ |
399 | if (read_only) { |
400 | for (p = whitelist_ro; *p; p++) { | |
401 | if (!strcmp(drv->format_name, *p)) { | |
402 | return 1; | |
403 | } | |
404 | } | |
405 | } | |
eb852011 MA |
406 | return 0; |
407 | } | |
408 | ||
b64ec4e4 FZ |
409 | BlockDriver *bdrv_find_whitelisted_format(const char *format_name, |
410 | bool read_only) | |
eb852011 MA |
411 | { |
412 | BlockDriver *drv = bdrv_find_format(format_name); | |
b64ec4e4 | 413 | return drv && bdrv_is_whitelisted(drv, read_only) ? drv : NULL; |
eb852011 MA |
414 | } |
415 | ||
5b7e1542 ZYW |
416 | typedef struct CreateCo { |
417 | BlockDriver *drv; | |
418 | char *filename; | |
83d0521a | 419 | QemuOpts *opts; |
5b7e1542 | 420 | int ret; |
cc84d90f | 421 | Error *err; |
5b7e1542 ZYW |
422 | } CreateCo; |
423 | ||
424 | static void coroutine_fn bdrv_create_co_entry(void *opaque) | |
425 | { | |
cc84d90f HR |
426 | Error *local_err = NULL; |
427 | int ret; | |
428 | ||
5b7e1542 ZYW |
429 | CreateCo *cco = opaque; |
430 | assert(cco->drv); | |
431 | ||
c282e1fd | 432 | ret = cco->drv->bdrv_create(cco->filename, cco->opts, &local_err); |
84d18f06 | 433 | if (local_err) { |
cc84d90f HR |
434 | error_propagate(&cco->err, local_err); |
435 | } | |
436 | cco->ret = ret; | |
5b7e1542 ZYW |
437 | } |
438 | ||
0e7e1989 | 439 | int bdrv_create(BlockDriver *drv, const char* filename, |
83d0521a | 440 | QemuOpts *opts, Error **errp) |
ea2384d3 | 441 | { |
5b7e1542 ZYW |
442 | int ret; |
443 | ||
444 | Coroutine *co; | |
445 | CreateCo cco = { | |
446 | .drv = drv, | |
447 | .filename = g_strdup(filename), | |
83d0521a | 448 | .opts = opts, |
5b7e1542 | 449 | .ret = NOT_DONE, |
cc84d90f | 450 | .err = NULL, |
5b7e1542 ZYW |
451 | }; |
452 | ||
c282e1fd | 453 | if (!drv->bdrv_create) { |
cc84d90f | 454 | error_setg(errp, "Driver '%s' does not support image creation", drv->format_name); |
80168bff LC |
455 | ret = -ENOTSUP; |
456 | goto out; | |
5b7e1542 ZYW |
457 | } |
458 | ||
459 | if (qemu_in_coroutine()) { | |
460 | /* Fast-path if already in coroutine context */ | |
461 | bdrv_create_co_entry(&cco); | |
462 | } else { | |
463 | co = qemu_coroutine_create(bdrv_create_co_entry); | |
464 | qemu_coroutine_enter(co, &cco); | |
465 | while (cco.ret == NOT_DONE) { | |
b47ec2c4 | 466 | aio_poll(qemu_get_aio_context(), true); |
5b7e1542 ZYW |
467 | } |
468 | } | |
469 | ||
470 | ret = cco.ret; | |
cc84d90f | 471 | if (ret < 0) { |
84d18f06 | 472 | if (cco.err) { |
cc84d90f HR |
473 | error_propagate(errp, cco.err); |
474 | } else { | |
475 | error_setg_errno(errp, -ret, "Could not create image"); | |
476 | } | |
477 | } | |
0e7e1989 | 478 | |
80168bff LC |
479 | out: |
480 | g_free(cco.filename); | |
5b7e1542 | 481 | return ret; |
ea2384d3 FB |
482 | } |
483 | ||
c282e1fd | 484 | int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp) |
84a12e66 CH |
485 | { |
486 | BlockDriver *drv; | |
cc84d90f HR |
487 | Error *local_err = NULL; |
488 | int ret; | |
84a12e66 | 489 | |
98289620 | 490 | drv = bdrv_find_protocol(filename, true); |
84a12e66 | 491 | if (drv == NULL) { |
cc84d90f | 492 | error_setg(errp, "Could not find protocol for file '%s'", filename); |
16905d71 | 493 | return -ENOENT; |
84a12e66 CH |
494 | } |
495 | ||
c282e1fd | 496 | ret = bdrv_create(drv, filename, opts, &local_err); |
84d18f06 | 497 | if (local_err) { |
cc84d90f HR |
498 | error_propagate(errp, local_err); |
499 | } | |
500 | return ret; | |
84a12e66 CH |
501 | } |
502 | ||
3baca891 | 503 | void bdrv_refresh_limits(BlockDriverState *bs, Error **errp) |
d34682cd KW |
504 | { |
505 | BlockDriver *drv = bs->drv; | |
3baca891 | 506 | Error *local_err = NULL; |
d34682cd KW |
507 | |
508 | memset(&bs->bl, 0, sizeof(bs->bl)); | |
509 | ||
466ad822 | 510 | if (!drv) { |
3baca891 | 511 | return; |
466ad822 KW |
512 | } |
513 | ||
514 | /* Take some limits from the children as a default */ | |
515 | if (bs->file) { | |
3baca891 KW |
516 | bdrv_refresh_limits(bs->file, &local_err); |
517 | if (local_err) { | |
518 | error_propagate(errp, local_err); | |
519 | return; | |
520 | } | |
466ad822 | 521 | bs->bl.opt_transfer_length = bs->file->bl.opt_transfer_length; |
2647fab5 | 522 | bs->bl.max_transfer_length = bs->file->bl.max_transfer_length; |
339064d5 KW |
523 | bs->bl.opt_mem_alignment = bs->file->bl.opt_mem_alignment; |
524 | } else { | |
525 | bs->bl.opt_mem_alignment = 512; | |
466ad822 KW |
526 | } |
527 | ||
528 | if (bs->backing_hd) { | |
3baca891 KW |
529 | bdrv_refresh_limits(bs->backing_hd, &local_err); |
530 | if (local_err) { | |
531 | error_propagate(errp, local_err); | |
532 | return; | |
533 | } | |
466ad822 KW |
534 | bs->bl.opt_transfer_length = |
535 | MAX(bs->bl.opt_transfer_length, | |
536 | bs->backing_hd->bl.opt_transfer_length); | |
2647fab5 PL |
537 | bs->bl.max_transfer_length = |
538 | MIN_NON_ZERO(bs->bl.max_transfer_length, | |
539 | bs->backing_hd->bl.max_transfer_length); | |
339064d5 KW |
540 | bs->bl.opt_mem_alignment = |
541 | MAX(bs->bl.opt_mem_alignment, | |
542 | bs->backing_hd->bl.opt_mem_alignment); | |
466ad822 KW |
543 | } |
544 | ||
545 | /* Then let the driver override it */ | |
546 | if (drv->bdrv_refresh_limits) { | |
3baca891 | 547 | drv->bdrv_refresh_limits(bs, errp); |
d34682cd | 548 | } |
d34682cd KW |
549 | } |
550 | ||
eba25057 JM |
551 | /* |
552 | * Create a uniquely-named empty temporary file. | |
553 | * Return 0 upon success, otherwise a negative errno value. | |
554 | */ | |
555 | int get_tmp_filename(char *filename, int size) | |
d5249393 | 556 | { |
eba25057 | 557 | #ifdef _WIN32 |
3b9f94e1 | 558 | char temp_dir[MAX_PATH]; |
eba25057 JM |
559 | /* GetTempFileName requires that its output buffer (4th param) |
560 | have length MAX_PATH or greater. */ | |
561 | assert(size >= MAX_PATH); | |
562 | return (GetTempPath(MAX_PATH, temp_dir) | |
563 | && GetTempFileName(temp_dir, "qem", 0, filename) | |
564 | ? 0 : -GetLastError()); | |
d5249393 | 565 | #else |
67b915a5 | 566 | int fd; |
7ccfb2eb | 567 | const char *tmpdir; |
0badc1ee | 568 | tmpdir = getenv("TMPDIR"); |
69bef793 AS |
569 | if (!tmpdir) { |
570 | tmpdir = "/var/tmp"; | |
571 | } | |
eba25057 JM |
572 | if (snprintf(filename, size, "%s/vl.XXXXXX", tmpdir) >= size) { |
573 | return -EOVERFLOW; | |
574 | } | |
ea2384d3 | 575 | fd = mkstemp(filename); |
fe235a06 DH |
576 | if (fd < 0) { |
577 | return -errno; | |
578 | } | |
579 | if (close(fd) != 0) { | |
580 | unlink(filename); | |
eba25057 JM |
581 | return -errno; |
582 | } | |
583 | return 0; | |
d5249393 | 584 | #endif |
eba25057 | 585 | } |
fc01f7e7 | 586 | |
84a12e66 CH |
587 | /* |
588 | * Detect host devices. By convention, /dev/cdrom[N] is always | |
589 | * recognized as a host CDROM. | |
590 | */ | |
591 | static BlockDriver *find_hdev_driver(const char *filename) | |
592 | { | |
593 | int score_max = 0, score; | |
594 | BlockDriver *drv = NULL, *d; | |
595 | ||
596 | QLIST_FOREACH(d, &bdrv_drivers, list) { | |
597 | if (d->bdrv_probe_device) { | |
598 | score = d->bdrv_probe_device(filename); | |
599 | if (score > score_max) { | |
600 | score_max = score; | |
601 | drv = d; | |
602 | } | |
603 | } | |
604 | } | |
605 | ||
606 | return drv; | |
607 | } | |
608 | ||
98289620 KW |
609 | BlockDriver *bdrv_find_protocol(const char *filename, |
610 | bool allow_protocol_prefix) | |
83f64091 FB |
611 | { |
612 | BlockDriver *drv1; | |
613 | char protocol[128]; | |
1cec71e3 | 614 | int len; |
83f64091 | 615 | const char *p; |
19cb3738 | 616 | |
66f82cee KW |
617 | /* TODO Drivers without bdrv_file_open must be specified explicitly */ |
618 | ||
39508e7a CH |
619 | /* |
620 | * XXX(hch): we really should not let host device detection | |
621 | * override an explicit protocol specification, but moving this | |
622 | * later breaks access to device names with colons in them. | |
623 | * Thanks to the brain-dead persistent naming schemes on udev- | |
624 | * based Linux systems those actually are quite common. | |
625 | */ | |
626 | drv1 = find_hdev_driver(filename); | |
627 | if (drv1) { | |
628 | return drv1; | |
629 | } | |
630 | ||
98289620 | 631 | if (!path_has_protocol(filename) || !allow_protocol_prefix) { |
39508e7a | 632 | return bdrv_find_format("file"); |
84a12e66 | 633 | } |
98289620 | 634 | |
9e0b22f4 SH |
635 | p = strchr(filename, ':'); |
636 | assert(p != NULL); | |
1cec71e3 AL |
637 | len = p - filename; |
638 | if (len > sizeof(protocol) - 1) | |
639 | len = sizeof(protocol) - 1; | |
640 | memcpy(protocol, filename, len); | |
641 | protocol[len] = '\0'; | |
8a22f02a | 642 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { |
5fafdf24 | 643 | if (drv1->protocol_name && |
8a22f02a | 644 | !strcmp(drv1->protocol_name, protocol)) { |
83f64091 | 645 | return drv1; |
8a22f02a | 646 | } |
83f64091 FB |
647 | } |
648 | return NULL; | |
649 | } | |
650 | ||
f500a6d3 | 651 | static int find_image_format(BlockDriverState *bs, const char *filename, |
34b5d2c6 | 652 | BlockDriver **pdrv, Error **errp) |
f3a5d3f8 | 653 | { |
f500a6d3 | 654 | int score, score_max; |
f3a5d3f8 CH |
655 | BlockDriver *drv1, *drv; |
656 | uint8_t buf[2048]; | |
f500a6d3 | 657 | int ret = 0; |
f8ea0b00 | 658 | |
08a00559 | 659 | /* Return the raw BlockDriver * to scsi-generic devices or empty drives */ |
8e895599 | 660 | if (bs->sg || !bdrv_is_inserted(bs) || bdrv_getlength(bs) == 0) { |
c98ac35d SW |
661 | drv = bdrv_find_format("raw"); |
662 | if (!drv) { | |
34b5d2c6 | 663 | error_setg(errp, "Could not find raw image format"); |
c98ac35d SW |
664 | ret = -ENOENT; |
665 | } | |
666 | *pdrv = drv; | |
667 | return ret; | |
1a396859 | 668 | } |
f8ea0b00 | 669 | |
83f64091 | 670 | ret = bdrv_pread(bs, 0, buf, sizeof(buf)); |
83f64091 | 671 | if (ret < 0) { |
34b5d2c6 HR |
672 | error_setg_errno(errp, -ret, "Could not read image for determining its " |
673 | "format"); | |
c98ac35d SW |
674 | *pdrv = NULL; |
675 | return ret; | |
83f64091 FB |
676 | } |
677 | ||
ea2384d3 | 678 | score_max = 0; |
84a12e66 | 679 | drv = NULL; |
8a22f02a | 680 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { |
83f64091 FB |
681 | if (drv1->bdrv_probe) { |
682 | score = drv1->bdrv_probe(buf, ret, filename); | |
683 | if (score > score_max) { | |
684 | score_max = score; | |
685 | drv = drv1; | |
686 | } | |
0849bf08 | 687 | } |
fc01f7e7 | 688 | } |
c98ac35d | 689 | if (!drv) { |
34b5d2c6 HR |
690 | error_setg(errp, "Could not determine image format: No compatible " |
691 | "driver found"); | |
c98ac35d SW |
692 | ret = -ENOENT; |
693 | } | |
694 | *pdrv = drv; | |
695 | return ret; | |
ea2384d3 FB |
696 | } |
697 | ||
51762288 SH |
698 | /** |
699 | * Set the current 'total_sectors' value | |
65a9bb25 | 700 | * Return 0 on success, -errno on error. |
51762288 SH |
701 | */ |
702 | static int refresh_total_sectors(BlockDriverState *bs, int64_t hint) | |
703 | { | |
704 | BlockDriver *drv = bs->drv; | |
705 | ||
396759ad NB |
706 | /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */ |
707 | if (bs->sg) | |
708 | return 0; | |
709 | ||
51762288 SH |
710 | /* query actual device if possible, otherwise just trust the hint */ |
711 | if (drv->bdrv_getlength) { | |
712 | int64_t length = drv->bdrv_getlength(bs); | |
713 | if (length < 0) { | |
714 | return length; | |
715 | } | |
7e382003 | 716 | hint = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE); |
51762288 SH |
717 | } |
718 | ||
719 | bs->total_sectors = hint; | |
720 | return 0; | |
721 | } | |
722 | ||
9e8f1835 PB |
723 | /** |
724 | * Set open flags for a given discard mode | |
725 | * | |
726 | * Return 0 on success, -1 if the discard mode was invalid. | |
727 | */ | |
728 | int bdrv_parse_discard_flags(const char *mode, int *flags) | |
729 | { | |
730 | *flags &= ~BDRV_O_UNMAP; | |
731 | ||
732 | if (!strcmp(mode, "off") || !strcmp(mode, "ignore")) { | |
733 | /* do nothing */ | |
734 | } else if (!strcmp(mode, "on") || !strcmp(mode, "unmap")) { | |
735 | *flags |= BDRV_O_UNMAP; | |
736 | } else { | |
737 | return -1; | |
738 | } | |
739 | ||
740 | return 0; | |
741 | } | |
742 | ||
c3993cdc SH |
743 | /** |
744 | * Set open flags for a given cache mode | |
745 | * | |
746 | * Return 0 on success, -1 if the cache mode was invalid. | |
747 | */ | |
748 | int bdrv_parse_cache_flags(const char *mode, int *flags) | |
749 | { | |
750 | *flags &= ~BDRV_O_CACHE_MASK; | |
751 | ||
752 | if (!strcmp(mode, "off") || !strcmp(mode, "none")) { | |
753 | *flags |= BDRV_O_NOCACHE | BDRV_O_CACHE_WB; | |
92196b2f SH |
754 | } else if (!strcmp(mode, "directsync")) { |
755 | *flags |= BDRV_O_NOCACHE; | |
c3993cdc SH |
756 | } else if (!strcmp(mode, "writeback")) { |
757 | *flags |= BDRV_O_CACHE_WB; | |
758 | } else if (!strcmp(mode, "unsafe")) { | |
759 | *flags |= BDRV_O_CACHE_WB; | |
760 | *flags |= BDRV_O_NO_FLUSH; | |
761 | } else if (!strcmp(mode, "writethrough")) { | |
762 | /* this is the default */ | |
763 | } else { | |
764 | return -1; | |
765 | } | |
766 | ||
767 | return 0; | |
768 | } | |
769 | ||
53fec9d3 SH |
770 | /** |
771 | * The copy-on-read flag is actually a reference count so multiple users may | |
772 | * use the feature without worrying about clobbering its previous state. | |
773 | * Copy-on-read stays enabled until all users have called to disable it. | |
774 | */ | |
775 | void bdrv_enable_copy_on_read(BlockDriverState *bs) | |
776 | { | |
777 | bs->copy_on_read++; | |
778 | } | |
779 | ||
780 | void bdrv_disable_copy_on_read(BlockDriverState *bs) | |
781 | { | |
782 | assert(bs->copy_on_read > 0); | |
783 | bs->copy_on_read--; | |
784 | } | |
785 | ||
b1e6fc08 KW |
786 | /* |
787 | * Returns the flags that a temporary snapshot should get, based on the | |
788 | * originally requested flags (the originally requested image will have flags | |
789 | * like a backing file) | |
790 | */ | |
791 | static int bdrv_temp_snapshot_flags(int flags) | |
792 | { | |
793 | return (flags & ~BDRV_O_SNAPSHOT) | BDRV_O_TEMPORARY; | |
794 | } | |
795 | ||
0b50cc88 KW |
796 | /* |
797 | * Returns the flags that bs->file should get, based on the given flags for | |
798 | * the parent BDS | |
799 | */ | |
800 | static int bdrv_inherited_flags(int flags) | |
801 | { | |
802 | /* Enable protocol handling, disable format probing for bs->file */ | |
803 | flags |= BDRV_O_PROTOCOL; | |
804 | ||
805 | /* Our block drivers take care to send flushes and respect unmap policy, | |
806 | * so we can enable both unconditionally on lower layers. */ | |
807 | flags |= BDRV_O_CACHE_WB | BDRV_O_UNMAP; | |
808 | ||
0b50cc88 | 809 | /* Clear flags that only apply to the top layer */ |
5669b44d | 810 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ); |
0b50cc88 KW |
811 | |
812 | return flags; | |
813 | } | |
814 | ||
317fc44e KW |
815 | /* |
816 | * Returns the flags that bs->backing_hd should get, based on the given flags | |
817 | * for the parent BDS | |
818 | */ | |
819 | static int bdrv_backing_flags(int flags) | |
820 | { | |
821 | /* backing files always opened read-only */ | |
822 | flags &= ~(BDRV_O_RDWR | BDRV_O_COPY_ON_READ); | |
823 | ||
824 | /* snapshot=on is handled on the top layer */ | |
8bfea15d | 825 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_TEMPORARY); |
317fc44e KW |
826 | |
827 | return flags; | |
828 | } | |
829 | ||
7b272452 KW |
830 | static int bdrv_open_flags(BlockDriverState *bs, int flags) |
831 | { | |
832 | int open_flags = flags | BDRV_O_CACHE_WB; | |
833 | ||
834 | /* | |
835 | * Clear flags that are internal to the block layer before opening the | |
836 | * image. | |
837 | */ | |
20cca275 | 838 | open_flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_PROTOCOL); |
7b272452 KW |
839 | |
840 | /* | |
841 | * Snapshots should be writable. | |
842 | */ | |
8bfea15d | 843 | if (flags & BDRV_O_TEMPORARY) { |
7b272452 KW |
844 | open_flags |= BDRV_O_RDWR; |
845 | } | |
846 | ||
847 | return open_flags; | |
848 | } | |
849 | ||
636ea370 KW |
850 | static void bdrv_assign_node_name(BlockDriverState *bs, |
851 | const char *node_name, | |
852 | Error **errp) | |
6913c0c2 BC |
853 | { |
854 | if (!node_name) { | |
636ea370 | 855 | return; |
6913c0c2 BC |
856 | } |
857 | ||
9aebf3b8 | 858 | /* Check for empty string or invalid characters */ |
f5bebbbb | 859 | if (!id_wellformed(node_name)) { |
9aebf3b8 | 860 | error_setg(errp, "Invalid node name"); |
636ea370 | 861 | return; |
6913c0c2 BC |
862 | } |
863 | ||
0c5e94ee | 864 | /* takes care of avoiding namespaces collisions */ |
7f06d47e | 865 | if (blk_by_name(node_name)) { |
0c5e94ee BC |
866 | error_setg(errp, "node-name=%s is conflicting with a device id", |
867 | node_name); | |
636ea370 | 868 | return; |
0c5e94ee BC |
869 | } |
870 | ||
6913c0c2 BC |
871 | /* takes care of avoiding duplicates node names */ |
872 | if (bdrv_find_node(node_name)) { | |
873 | error_setg(errp, "Duplicate node name"); | |
636ea370 | 874 | return; |
6913c0c2 BC |
875 | } |
876 | ||
877 | /* copy node name into the bs and insert it into the graph list */ | |
878 | pstrcpy(bs->node_name, sizeof(bs->node_name), node_name); | |
879 | QTAILQ_INSERT_TAIL(&graph_bdrv_states, bs, node_list); | |
6913c0c2 BC |
880 | } |
881 | ||
57915332 KW |
882 | /* |
883 | * Common part for opening disk images and files | |
b6ad491a KW |
884 | * |
885 | * Removes all processed options from *options. | |
57915332 | 886 | */ |
f500a6d3 | 887 | static int bdrv_open_common(BlockDriverState *bs, BlockDriverState *file, |
34b5d2c6 | 888 | QDict *options, int flags, BlockDriver *drv, Error **errp) |
57915332 KW |
889 | { |
890 | int ret, open_flags; | |
035fccdf | 891 | const char *filename; |
6913c0c2 | 892 | const char *node_name = NULL; |
34b5d2c6 | 893 | Error *local_err = NULL; |
57915332 KW |
894 | |
895 | assert(drv != NULL); | |
6405875c | 896 | assert(bs->file == NULL); |
707ff828 | 897 | assert(options != NULL && bs->options != options); |
57915332 | 898 | |
45673671 KW |
899 | if (file != NULL) { |
900 | filename = file->filename; | |
901 | } else { | |
902 | filename = qdict_get_try_str(options, "filename"); | |
903 | } | |
904 | ||
765003db KW |
905 | if (drv->bdrv_needs_filename && !filename) { |
906 | error_setg(errp, "The '%s' block driver requires a file name", | |
907 | drv->format_name); | |
908 | return -EINVAL; | |
909 | } | |
910 | ||
45673671 | 911 | trace_bdrv_open_common(bs, filename ?: "", flags, drv->format_name); |
28dcee10 | 912 | |
6913c0c2 | 913 | node_name = qdict_get_try_str(options, "node-name"); |
636ea370 | 914 | bdrv_assign_node_name(bs, node_name, &local_err); |
0fb6395c | 915 | if (local_err) { |
636ea370 KW |
916 | error_propagate(errp, local_err); |
917 | return -EINVAL; | |
6913c0c2 BC |
918 | } |
919 | qdict_del(options, "node-name"); | |
920 | ||
5d186eb0 KW |
921 | /* bdrv_open() with directly using a protocol as drv. This layer is already |
922 | * opened, so assign it to bs (while file becomes a closed BlockDriverState) | |
923 | * and return immediately. */ | |
924 | if (file != NULL && drv->bdrv_file_open) { | |
925 | bdrv_swap(file, bs); | |
926 | return 0; | |
927 | } | |
928 | ||
57915332 | 929 | bs->open_flags = flags; |
1b7fd729 | 930 | bs->guest_block_size = 512; |
c25f53b0 | 931 | bs->request_alignment = 512; |
0d51b4de | 932 | bs->zero_beyond_eof = true; |
b64ec4e4 FZ |
933 | open_flags = bdrv_open_flags(bs, flags); |
934 | bs->read_only = !(open_flags & BDRV_O_RDWR); | |
20cca275 | 935 | bs->growable = !!(flags & BDRV_O_PROTOCOL); |
b64ec4e4 FZ |
936 | |
937 | if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv, bs->read_only)) { | |
8f94a6e4 KW |
938 | error_setg(errp, |
939 | !bs->read_only && bdrv_is_whitelisted(drv, true) | |
940 | ? "Driver '%s' can only be used for read-only devices" | |
941 | : "Driver '%s' is not whitelisted", | |
942 | drv->format_name); | |
b64ec4e4 FZ |
943 | return -ENOTSUP; |
944 | } | |
57915332 | 945 | |
53fec9d3 | 946 | assert(bs->copy_on_read == 0); /* bdrv_new() and bdrv_close() make it so */ |
0ebd24e0 KW |
947 | if (flags & BDRV_O_COPY_ON_READ) { |
948 | if (!bs->read_only) { | |
949 | bdrv_enable_copy_on_read(bs); | |
950 | } else { | |
951 | error_setg(errp, "Can't use copy-on-read on read-only device"); | |
952 | return -EINVAL; | |
953 | } | |
53fec9d3 SH |
954 | } |
955 | ||
c2ad1b0c KW |
956 | if (filename != NULL) { |
957 | pstrcpy(bs->filename, sizeof(bs->filename), filename); | |
958 | } else { | |
959 | bs->filename[0] = '\0'; | |
960 | } | |
91af7014 | 961 | pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), bs->filename); |
57915332 | 962 | |
57915332 | 963 | bs->drv = drv; |
7267c094 | 964 | bs->opaque = g_malloc0(drv->instance_size); |
57915332 | 965 | |
03f541bd | 966 | bs->enable_write_cache = !!(flags & BDRV_O_CACHE_WB); |
e7c63796 | 967 | |
66f82cee KW |
968 | /* Open the image, either directly or using a protocol */ |
969 | if (drv->bdrv_file_open) { | |
5d186eb0 | 970 | assert(file == NULL); |
030be321 | 971 | assert(!drv->bdrv_needs_filename || filename != NULL); |
34b5d2c6 | 972 | ret = drv->bdrv_file_open(bs, options, open_flags, &local_err); |
f500a6d3 | 973 | } else { |
2af5ef70 | 974 | if (file == NULL) { |
34b5d2c6 HR |
975 | error_setg(errp, "Can't use '%s' as a block driver for the " |
976 | "protocol level", drv->format_name); | |
2af5ef70 KW |
977 | ret = -EINVAL; |
978 | goto free_and_fail; | |
979 | } | |
f500a6d3 | 980 | bs->file = file; |
34b5d2c6 | 981 | ret = drv->bdrv_open(bs, options, open_flags, &local_err); |
66f82cee KW |
982 | } |
983 | ||
57915332 | 984 | if (ret < 0) { |
84d18f06 | 985 | if (local_err) { |
34b5d2c6 | 986 | error_propagate(errp, local_err); |
2fa9aa59 DH |
987 | } else if (bs->filename[0]) { |
988 | error_setg_errno(errp, -ret, "Could not open '%s'", bs->filename); | |
34b5d2c6 HR |
989 | } else { |
990 | error_setg_errno(errp, -ret, "Could not open image"); | |
991 | } | |
57915332 KW |
992 | goto free_and_fail; |
993 | } | |
994 | ||
51762288 SH |
995 | ret = refresh_total_sectors(bs, bs->total_sectors); |
996 | if (ret < 0) { | |
34b5d2c6 | 997 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); |
51762288 | 998 | goto free_and_fail; |
57915332 | 999 | } |
51762288 | 1000 | |
3baca891 KW |
1001 | bdrv_refresh_limits(bs, &local_err); |
1002 | if (local_err) { | |
1003 | error_propagate(errp, local_err); | |
1004 | ret = -EINVAL; | |
1005 | goto free_and_fail; | |
1006 | } | |
1007 | ||
c25f53b0 | 1008 | assert(bdrv_opt_mem_align(bs) != 0); |
47ea2de2 | 1009 | assert((bs->request_alignment != 0) || bs->sg); |
57915332 KW |
1010 | return 0; |
1011 | ||
1012 | free_and_fail: | |
f500a6d3 | 1013 | bs->file = NULL; |
7267c094 | 1014 | g_free(bs->opaque); |
57915332 KW |
1015 | bs->opaque = NULL; |
1016 | bs->drv = NULL; | |
1017 | return ret; | |
1018 | } | |
1019 | ||
5e5c4f63 KW |
1020 | static QDict *parse_json_filename(const char *filename, Error **errp) |
1021 | { | |
1022 | QObject *options_obj; | |
1023 | QDict *options; | |
1024 | int ret; | |
1025 | ||
1026 | ret = strstart(filename, "json:", &filename); | |
1027 | assert(ret); | |
1028 | ||
1029 | options_obj = qobject_from_json(filename); | |
1030 | if (!options_obj) { | |
1031 | error_setg(errp, "Could not parse the JSON options"); | |
1032 | return NULL; | |
1033 | } | |
1034 | ||
1035 | if (qobject_type(options_obj) != QTYPE_QDICT) { | |
1036 | qobject_decref(options_obj); | |
1037 | error_setg(errp, "Invalid JSON object given"); | |
1038 | return NULL; | |
1039 | } | |
1040 | ||
1041 | options = qobject_to_qdict(options_obj); | |
1042 | qdict_flatten(options); | |
1043 | ||
1044 | return options; | |
1045 | } | |
1046 | ||
b6ce07aa | 1047 | /* |
f54120ff KW |
1048 | * Fills in default options for opening images and converts the legacy |
1049 | * filename/flags pair to option QDict entries. | |
b6ce07aa | 1050 | */ |
5e5c4f63 | 1051 | static int bdrv_fill_options(QDict **options, const char **pfilename, int flags, |
17b005f1 | 1052 | BlockDriver *drv, Error **errp) |
ea2384d3 | 1053 | { |
5e5c4f63 | 1054 | const char *filename = *pfilename; |
c2ad1b0c | 1055 | const char *drvname; |
462f5bcf | 1056 | bool protocol = flags & BDRV_O_PROTOCOL; |
e3fa4bfa | 1057 | bool parse_filename = false; |
34b5d2c6 | 1058 | Error *local_err = NULL; |
83f64091 | 1059 | |
5e5c4f63 KW |
1060 | /* Parse json: pseudo-protocol */ |
1061 | if (filename && g_str_has_prefix(filename, "json:")) { | |
1062 | QDict *json_options = parse_json_filename(filename, &local_err); | |
1063 | if (local_err) { | |
1064 | error_propagate(errp, local_err); | |
1065 | return -EINVAL; | |
1066 | } | |
1067 | ||
1068 | /* Options given in the filename have lower priority than options | |
1069 | * specified directly */ | |
1070 | qdict_join(*options, json_options, false); | |
1071 | QDECREF(json_options); | |
1072 | *pfilename = filename = NULL; | |
1073 | } | |
1074 | ||
035fccdf | 1075 | /* Fetch the file name from the options QDict if necessary */ |
17b005f1 | 1076 | if (protocol && filename) { |
f54120ff KW |
1077 | if (!qdict_haskey(*options, "filename")) { |
1078 | qdict_put(*options, "filename", qstring_from_str(filename)); | |
1079 | parse_filename = true; | |
1080 | } else { | |
1081 | error_setg(errp, "Can't specify 'file' and 'filename' options at " | |
1082 | "the same time"); | |
1083 | return -EINVAL; | |
1084 | } | |
035fccdf KW |
1085 | } |
1086 | ||
c2ad1b0c | 1087 | /* Find the right block driver */ |
f54120ff | 1088 | filename = qdict_get_try_str(*options, "filename"); |
5acd9d81 | 1089 | drvname = qdict_get_try_str(*options, "driver"); |
f54120ff | 1090 | |
17b005f1 KW |
1091 | if (drv) { |
1092 | if (drvname) { | |
1093 | error_setg(errp, "Driver specified twice"); | |
1094 | return -EINVAL; | |
1095 | } | |
1096 | drvname = drv->format_name; | |
1097 | qdict_put(*options, "driver", qstring_from_str(drvname)); | |
1098 | } else { | |
1099 | if (!drvname && protocol) { | |
1100 | if (filename) { | |
1101 | drv = bdrv_find_protocol(filename, parse_filename); | |
1102 | if (!drv) { | |
1103 | error_setg(errp, "Unknown protocol"); | |
1104 | return -EINVAL; | |
1105 | } | |
1106 | ||
1107 | drvname = drv->format_name; | |
1108 | qdict_put(*options, "driver", qstring_from_str(drvname)); | |
1109 | } else { | |
1110 | error_setg(errp, "Must specify either driver or file"); | |
f54120ff KW |
1111 | return -EINVAL; |
1112 | } | |
17b005f1 KW |
1113 | } else if (drvname) { |
1114 | drv = bdrv_find_format(drvname); | |
1115 | if (!drv) { | |
1116 | error_setg(errp, "Unknown driver '%s'", drvname); | |
1117 | return -ENOENT; | |
1118 | } | |
98289620 | 1119 | } |
c2ad1b0c KW |
1120 | } |
1121 | ||
17b005f1 | 1122 | assert(drv || !protocol); |
c2ad1b0c | 1123 | |
f54120ff | 1124 | /* Driver-specific filename parsing */ |
17b005f1 | 1125 | if (drv && drv->bdrv_parse_filename && parse_filename) { |
5acd9d81 | 1126 | drv->bdrv_parse_filename(filename, *options, &local_err); |
84d18f06 | 1127 | if (local_err) { |
34b5d2c6 | 1128 | error_propagate(errp, local_err); |
f54120ff | 1129 | return -EINVAL; |
6963a30d | 1130 | } |
cd5d031e HR |
1131 | |
1132 | if (!drv->bdrv_needs_filename) { | |
1133 | qdict_del(*options, "filename"); | |
cd5d031e | 1134 | } |
6963a30d KW |
1135 | } |
1136 | ||
f54120ff KW |
1137 | return 0; |
1138 | } | |
1139 | ||
8d24cce1 FZ |
1140 | void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd) |
1141 | { | |
1142 | ||
826b6ca0 FZ |
1143 | if (bs->backing_hd) { |
1144 | assert(bs->backing_blocker); | |
1145 | bdrv_op_unblock_all(bs->backing_hd, bs->backing_blocker); | |
1146 | } else if (backing_hd) { | |
1147 | error_setg(&bs->backing_blocker, | |
1148 | "device is used as backing hd of '%s'", | |
bfb197e0 | 1149 | bdrv_get_device_name(bs)); |
826b6ca0 FZ |
1150 | } |
1151 | ||
8d24cce1 FZ |
1152 | bs->backing_hd = backing_hd; |
1153 | if (!backing_hd) { | |
826b6ca0 FZ |
1154 | error_free(bs->backing_blocker); |
1155 | bs->backing_blocker = NULL; | |
8d24cce1 FZ |
1156 | goto out; |
1157 | } | |
1158 | bs->open_flags &= ~BDRV_O_NO_BACKING; | |
1159 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_hd->filename); | |
1160 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), | |
1161 | backing_hd->drv ? backing_hd->drv->format_name : ""); | |
826b6ca0 FZ |
1162 | |
1163 | bdrv_op_block_all(bs->backing_hd, bs->backing_blocker); | |
1164 | /* Otherwise we won't be able to commit due to check in bdrv_commit */ | |
1165 | bdrv_op_unblock(bs->backing_hd, BLOCK_OP_TYPE_COMMIT, | |
1166 | bs->backing_blocker); | |
8d24cce1 | 1167 | out: |
3baca891 | 1168 | bdrv_refresh_limits(bs, NULL); |
8d24cce1 FZ |
1169 | } |
1170 | ||
31ca6d07 KW |
1171 | /* |
1172 | * Opens the backing file for a BlockDriverState if not yet open | |
1173 | * | |
1174 | * options is a QDict of options to pass to the block drivers, or NULL for an | |
1175 | * empty set of options. The reference to the QDict is transferred to this | |
1176 | * function (even on failure), so if the caller intends to reuse the dictionary, | |
1177 | * it needs to use QINCREF() before calling bdrv_file_open. | |
1178 | */ | |
34b5d2c6 | 1179 | int bdrv_open_backing_file(BlockDriverState *bs, QDict *options, Error **errp) |
9156df12 | 1180 | { |
1ba4b6a5 | 1181 | char *backing_filename = g_malloc0(PATH_MAX); |
317fc44e | 1182 | int ret = 0; |
9156df12 | 1183 | BlockDriver *back_drv = NULL; |
8d24cce1 | 1184 | BlockDriverState *backing_hd; |
34b5d2c6 | 1185 | Error *local_err = NULL; |
9156df12 PB |
1186 | |
1187 | if (bs->backing_hd != NULL) { | |
31ca6d07 | 1188 | QDECREF(options); |
1ba4b6a5 | 1189 | goto free_exit; |
9156df12 PB |
1190 | } |
1191 | ||
31ca6d07 KW |
1192 | /* NULL means an empty set of options */ |
1193 | if (options == NULL) { | |
1194 | options = qdict_new(); | |
1195 | } | |
1196 | ||
9156df12 | 1197 | bs->open_flags &= ~BDRV_O_NO_BACKING; |
1cb6f506 KW |
1198 | if (qdict_haskey(options, "file.filename")) { |
1199 | backing_filename[0] = '\0'; | |
1200 | } else if (bs->backing_file[0] == '\0' && qdict_size(options) == 0) { | |
31ca6d07 | 1201 | QDECREF(options); |
1ba4b6a5 | 1202 | goto free_exit; |
dbecebdd | 1203 | } else { |
1ba4b6a5 | 1204 | bdrv_get_full_backing_filename(bs, backing_filename, PATH_MAX); |
9156df12 PB |
1205 | } |
1206 | ||
8ee79e70 KW |
1207 | if (!bs->drv || !bs->drv->supports_backing) { |
1208 | ret = -EINVAL; | |
1209 | error_setg(errp, "Driver doesn't support backing files"); | |
1210 | QDECREF(options); | |
1211 | goto free_exit; | |
1212 | } | |
1213 | ||
e4e9986b | 1214 | backing_hd = bdrv_new(); |
8d24cce1 | 1215 | |
9156df12 PB |
1216 | if (bs->backing_format[0] != '\0') { |
1217 | back_drv = bdrv_find_format(bs->backing_format); | |
1218 | } | |
1219 | ||
f67503e5 | 1220 | assert(bs->backing_hd == NULL); |
8d24cce1 | 1221 | ret = bdrv_open(&backing_hd, |
ddf5636d | 1222 | *backing_filename ? backing_filename : NULL, NULL, options, |
317fc44e | 1223 | bdrv_backing_flags(bs->open_flags), back_drv, &local_err); |
9156df12 | 1224 | if (ret < 0) { |
8d24cce1 FZ |
1225 | bdrv_unref(backing_hd); |
1226 | backing_hd = NULL; | |
9156df12 | 1227 | bs->open_flags |= BDRV_O_NO_BACKING; |
b04b6b6e FZ |
1228 | error_setg(errp, "Could not open backing file: %s", |
1229 | error_get_pretty(local_err)); | |
1230 | error_free(local_err); | |
1ba4b6a5 | 1231 | goto free_exit; |
9156df12 | 1232 | } |
8d24cce1 | 1233 | bdrv_set_backing_hd(bs, backing_hd); |
d80ac658 | 1234 | |
1ba4b6a5 BC |
1235 | free_exit: |
1236 | g_free(backing_filename); | |
1237 | return ret; | |
9156df12 PB |
1238 | } |
1239 | ||
da557aac HR |
1240 | /* |
1241 | * Opens a disk image whose options are given as BlockdevRef in another block | |
1242 | * device's options. | |
1243 | * | |
da557aac HR |
1244 | * If allow_none is true, no image will be opened if filename is false and no |
1245 | * BlockdevRef is given. *pbs will remain unchanged and 0 will be returned. | |
1246 | * | |
1247 | * bdrev_key specifies the key for the image's BlockdevRef in the options QDict. | |
1248 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
1249 | * itself, all options starting with "${bdref_key}." are considered part of the | |
1250 | * BlockdevRef. | |
1251 | * | |
1252 | * The BlockdevRef will be removed from the options QDict. | |
f67503e5 HR |
1253 | * |
1254 | * To conform with the behavior of bdrv_open(), *pbs has to be NULL. | |
da557aac HR |
1255 | */ |
1256 | int bdrv_open_image(BlockDriverState **pbs, const char *filename, | |
1257 | QDict *options, const char *bdref_key, int flags, | |
f7d9fd8c | 1258 | bool allow_none, Error **errp) |
da557aac HR |
1259 | { |
1260 | QDict *image_options; | |
1261 | int ret; | |
1262 | char *bdref_key_dot; | |
1263 | const char *reference; | |
1264 | ||
f67503e5 HR |
1265 | assert(pbs); |
1266 | assert(*pbs == NULL); | |
1267 | ||
da557aac HR |
1268 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); |
1269 | qdict_extract_subqdict(options, &image_options, bdref_key_dot); | |
1270 | g_free(bdref_key_dot); | |
1271 | ||
1272 | reference = qdict_get_try_str(options, bdref_key); | |
1273 | if (!filename && !reference && !qdict_size(image_options)) { | |
1274 | if (allow_none) { | |
1275 | ret = 0; | |
1276 | } else { | |
1277 | error_setg(errp, "A block device must be specified for \"%s\"", | |
1278 | bdref_key); | |
1279 | ret = -EINVAL; | |
1280 | } | |
b20e61e0 | 1281 | QDECREF(image_options); |
da557aac HR |
1282 | goto done; |
1283 | } | |
1284 | ||
f7d9fd8c | 1285 | ret = bdrv_open(pbs, filename, reference, image_options, flags, NULL, errp); |
da557aac HR |
1286 | |
1287 | done: | |
1288 | qdict_del(options, bdref_key); | |
1289 | return ret; | |
1290 | } | |
1291 | ||
6b8aeca5 | 1292 | int bdrv_append_temp_snapshot(BlockDriverState *bs, int flags, Error **errp) |
b998875d KW |
1293 | { |
1294 | /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */ | |
1ba4b6a5 | 1295 | char *tmp_filename = g_malloc0(PATH_MAX + 1); |
b998875d KW |
1296 | int64_t total_size; |
1297 | BlockDriver *bdrv_qcow2; | |
83d0521a | 1298 | QemuOpts *opts = NULL; |
b998875d KW |
1299 | QDict *snapshot_options; |
1300 | BlockDriverState *bs_snapshot; | |
1301 | Error *local_err; | |
1302 | int ret; | |
1303 | ||
1304 | /* if snapshot, we create a temporary backing file and open it | |
1305 | instead of opening 'filename' directly */ | |
1306 | ||
1307 | /* Get the required size from the image */ | |
f187743a KW |
1308 | total_size = bdrv_getlength(bs); |
1309 | if (total_size < 0) { | |
6b8aeca5 | 1310 | ret = total_size; |
f187743a | 1311 | error_setg_errno(errp, -total_size, "Could not get image size"); |
1ba4b6a5 | 1312 | goto out; |
f187743a | 1313 | } |
b998875d KW |
1314 | |
1315 | /* Create the temporary image */ | |
1ba4b6a5 | 1316 | ret = get_tmp_filename(tmp_filename, PATH_MAX + 1); |
b998875d KW |
1317 | if (ret < 0) { |
1318 | error_setg_errno(errp, -ret, "Could not get temporary filename"); | |
1ba4b6a5 | 1319 | goto out; |
b998875d KW |
1320 | } |
1321 | ||
1322 | bdrv_qcow2 = bdrv_find_format("qcow2"); | |
c282e1fd CL |
1323 | opts = qemu_opts_create(bdrv_qcow2->create_opts, NULL, 0, |
1324 | &error_abort); | |
83d0521a | 1325 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_size); |
c282e1fd | 1326 | ret = bdrv_create(bdrv_qcow2, tmp_filename, opts, &local_err); |
83d0521a | 1327 | qemu_opts_del(opts); |
b998875d KW |
1328 | if (ret < 0) { |
1329 | error_setg_errno(errp, -ret, "Could not create temporary overlay " | |
1330 | "'%s': %s", tmp_filename, | |
1331 | error_get_pretty(local_err)); | |
1332 | error_free(local_err); | |
1ba4b6a5 | 1333 | goto out; |
b998875d KW |
1334 | } |
1335 | ||
1336 | /* Prepare a new options QDict for the temporary file */ | |
1337 | snapshot_options = qdict_new(); | |
1338 | qdict_put(snapshot_options, "file.driver", | |
1339 | qstring_from_str("file")); | |
1340 | qdict_put(snapshot_options, "file.filename", | |
1341 | qstring_from_str(tmp_filename)); | |
1342 | ||
e4e9986b | 1343 | bs_snapshot = bdrv_new(); |
b998875d KW |
1344 | |
1345 | ret = bdrv_open(&bs_snapshot, NULL, NULL, snapshot_options, | |
b1e6fc08 | 1346 | flags, bdrv_qcow2, &local_err); |
b998875d KW |
1347 | if (ret < 0) { |
1348 | error_propagate(errp, local_err); | |
1ba4b6a5 | 1349 | goto out; |
b998875d KW |
1350 | } |
1351 | ||
1352 | bdrv_append(bs_snapshot, bs); | |
1ba4b6a5 BC |
1353 | |
1354 | out: | |
1355 | g_free(tmp_filename); | |
6b8aeca5 | 1356 | return ret; |
b998875d KW |
1357 | } |
1358 | ||
b6ce07aa KW |
1359 | /* |
1360 | * Opens a disk image (raw, qcow2, vmdk, ...) | |
de9c0cec KW |
1361 | * |
1362 | * options is a QDict of options to pass to the block drivers, or NULL for an | |
1363 | * empty set of options. The reference to the QDict belongs to the block layer | |
1364 | * after the call (even on failure), so if the caller intends to reuse the | |
1365 | * dictionary, it needs to use QINCREF() before calling bdrv_open. | |
f67503e5 HR |
1366 | * |
1367 | * If *pbs is NULL, a new BDS will be created with a pointer to it stored there. | |
1368 | * If it is not NULL, the referenced BDS will be reused. | |
ddf5636d HR |
1369 | * |
1370 | * The reference parameter may be used to specify an existing block device which | |
1371 | * should be opened. If specified, neither options nor a filename may be given, | |
1372 | * nor can an existing BDS be reused (that is, *pbs has to be NULL). | |
b6ce07aa | 1373 | */ |
ddf5636d HR |
1374 | int bdrv_open(BlockDriverState **pbs, const char *filename, |
1375 | const char *reference, QDict *options, int flags, | |
1376 | BlockDriver *drv, Error **errp) | |
ea2384d3 | 1377 | { |
b6ce07aa | 1378 | int ret; |
f67503e5 | 1379 | BlockDriverState *file = NULL, *bs; |
74fe54f2 | 1380 | const char *drvname; |
34b5d2c6 | 1381 | Error *local_err = NULL; |
b1e6fc08 | 1382 | int snapshot_flags = 0; |
712e7874 | 1383 | |
f67503e5 HR |
1384 | assert(pbs); |
1385 | ||
ddf5636d HR |
1386 | if (reference) { |
1387 | bool options_non_empty = options ? qdict_size(options) : false; | |
1388 | QDECREF(options); | |
1389 | ||
1390 | if (*pbs) { | |
1391 | error_setg(errp, "Cannot reuse an existing BDS when referencing " | |
1392 | "another block device"); | |
1393 | return -EINVAL; | |
1394 | } | |
1395 | ||
1396 | if (filename || options_non_empty) { | |
1397 | error_setg(errp, "Cannot reference an existing block device with " | |
1398 | "additional options or a new filename"); | |
1399 | return -EINVAL; | |
1400 | } | |
1401 | ||
1402 | bs = bdrv_lookup_bs(reference, reference, errp); | |
1403 | if (!bs) { | |
1404 | return -ENODEV; | |
1405 | } | |
1406 | bdrv_ref(bs); | |
1407 | *pbs = bs; | |
1408 | return 0; | |
1409 | } | |
1410 | ||
f67503e5 HR |
1411 | if (*pbs) { |
1412 | bs = *pbs; | |
1413 | } else { | |
e4e9986b | 1414 | bs = bdrv_new(); |
f67503e5 HR |
1415 | } |
1416 | ||
de9c0cec KW |
1417 | /* NULL means an empty set of options */ |
1418 | if (options == NULL) { | |
1419 | options = qdict_new(); | |
1420 | } | |
1421 | ||
17b005f1 | 1422 | ret = bdrv_fill_options(&options, &filename, flags, drv, &local_err); |
462f5bcf KW |
1423 | if (local_err) { |
1424 | goto fail; | |
1425 | } | |
1426 | ||
76c591b0 KW |
1427 | /* Find the right image format driver */ |
1428 | drv = NULL; | |
1429 | drvname = qdict_get_try_str(options, "driver"); | |
1430 | if (drvname) { | |
1431 | drv = bdrv_find_format(drvname); | |
1432 | qdict_del(options, "driver"); | |
1433 | if (!drv) { | |
1434 | error_setg(errp, "Unknown driver: '%s'", drvname); | |
1435 | ret = -EINVAL; | |
1436 | goto fail; | |
1437 | } | |
1438 | } | |
1439 | ||
1440 | assert(drvname || !(flags & BDRV_O_PROTOCOL)); | |
1441 | if (drv && !drv->bdrv_file_open) { | |
1442 | /* If the user explicitly wants a format driver here, we'll need to add | |
1443 | * another layer for the protocol in bs->file */ | |
1444 | flags &= ~BDRV_O_PROTOCOL; | |
1445 | } | |
1446 | ||
de9c0cec | 1447 | bs->options = options; |
b6ad491a | 1448 | options = qdict_clone_shallow(options); |
de9c0cec | 1449 | |
f500a6d3 | 1450 | /* Open image file without format layer */ |
f4788adc KW |
1451 | if ((flags & BDRV_O_PROTOCOL) == 0) { |
1452 | if (flags & BDRV_O_RDWR) { | |
1453 | flags |= BDRV_O_ALLOW_RDWR; | |
1454 | } | |
1455 | if (flags & BDRV_O_SNAPSHOT) { | |
1456 | snapshot_flags = bdrv_temp_snapshot_flags(flags); | |
1457 | flags = bdrv_backing_flags(flags); | |
1458 | } | |
f500a6d3 | 1459 | |
f4788adc KW |
1460 | assert(file == NULL); |
1461 | ret = bdrv_open_image(&file, filename, options, "file", | |
1462 | bdrv_inherited_flags(flags), | |
1463 | true, &local_err); | |
1464 | if (ret < 0) { | |
1465 | goto fail; | |
1466 | } | |
f500a6d3 KW |
1467 | } |
1468 | ||
76c591b0 KW |
1469 | /* Image format probing */ |
1470 | if (!drv && file) { | |
17b005f1 KW |
1471 | ret = find_image_format(file, filename, &drv, &local_err); |
1472 | if (ret < 0) { | |
8bfea15d | 1473 | goto fail; |
2a05cbe4 | 1474 | } |
76c591b0 | 1475 | } else if (!drv) { |
17b005f1 KW |
1476 | error_setg(errp, "Must specify either driver or file"); |
1477 | ret = -EINVAL; | |
8bfea15d | 1478 | goto fail; |
ea2384d3 | 1479 | } |
b6ce07aa KW |
1480 | |
1481 | /* Open the image */ | |
34b5d2c6 | 1482 | ret = bdrv_open_common(bs, file, options, flags, drv, &local_err); |
b6ce07aa | 1483 | if (ret < 0) { |
8bfea15d | 1484 | goto fail; |
6987307c CH |
1485 | } |
1486 | ||
2a05cbe4 | 1487 | if (file && (bs->file != file)) { |
4f6fd349 | 1488 | bdrv_unref(file); |
f500a6d3 KW |
1489 | file = NULL; |
1490 | } | |
1491 | ||
b6ce07aa | 1492 | /* If there is a backing file, use it */ |
9156df12 | 1493 | if ((flags & BDRV_O_NO_BACKING) == 0) { |
31ca6d07 KW |
1494 | QDict *backing_options; |
1495 | ||
5726d872 | 1496 | qdict_extract_subqdict(options, &backing_options, "backing."); |
34b5d2c6 | 1497 | ret = bdrv_open_backing_file(bs, backing_options, &local_err); |
b6ce07aa | 1498 | if (ret < 0) { |
b6ad491a | 1499 | goto close_and_fail; |
b6ce07aa | 1500 | } |
b6ce07aa KW |
1501 | } |
1502 | ||
91af7014 HR |
1503 | bdrv_refresh_filename(bs); |
1504 | ||
b998875d KW |
1505 | /* For snapshot=on, create a temporary qcow2 overlay. bs points to the |
1506 | * temporary snapshot afterwards. */ | |
b1e6fc08 | 1507 | if (snapshot_flags) { |
6b8aeca5 | 1508 | ret = bdrv_append_temp_snapshot(bs, snapshot_flags, &local_err); |
b998875d | 1509 | if (local_err) { |
b998875d KW |
1510 | goto close_and_fail; |
1511 | } | |
1512 | } | |
1513 | ||
b6ad491a | 1514 | /* Check if any unknown options were used */ |
5acd9d81 | 1515 | if (options && (qdict_size(options) != 0)) { |
b6ad491a | 1516 | const QDictEntry *entry = qdict_first(options); |
5acd9d81 HR |
1517 | if (flags & BDRV_O_PROTOCOL) { |
1518 | error_setg(errp, "Block protocol '%s' doesn't support the option " | |
1519 | "'%s'", drv->format_name, entry->key); | |
1520 | } else { | |
1521 | error_setg(errp, "Block format '%s' used by device '%s' doesn't " | |
1522 | "support the option '%s'", drv->format_name, | |
bfb197e0 | 1523 | bdrv_get_device_name(bs), entry->key); |
5acd9d81 | 1524 | } |
b6ad491a KW |
1525 | |
1526 | ret = -EINVAL; | |
1527 | goto close_and_fail; | |
1528 | } | |
b6ad491a | 1529 | |
b6ce07aa | 1530 | if (!bdrv_key_required(bs)) { |
a7f53e26 MA |
1531 | if (bs->blk) { |
1532 | blk_dev_change_media_cb(bs->blk, true); | |
1533 | } | |
c3adb58f MA |
1534 | } else if (!runstate_check(RUN_STATE_PRELAUNCH) |
1535 | && !runstate_check(RUN_STATE_INMIGRATE) | |
1536 | && !runstate_check(RUN_STATE_PAUSED)) { /* HACK */ | |
1537 | error_setg(errp, | |
1538 | "Guest must be stopped for opening of encrypted image"); | |
1539 | ret = -EBUSY; | |
1540 | goto close_and_fail; | |
b6ce07aa KW |
1541 | } |
1542 | ||
c3adb58f | 1543 | QDECREF(options); |
f67503e5 | 1544 | *pbs = bs; |
b6ce07aa KW |
1545 | return 0; |
1546 | ||
8bfea15d | 1547 | fail: |
f500a6d3 | 1548 | if (file != NULL) { |
4f6fd349 | 1549 | bdrv_unref(file); |
f500a6d3 | 1550 | } |
de9c0cec | 1551 | QDECREF(bs->options); |
b6ad491a | 1552 | QDECREF(options); |
de9c0cec | 1553 | bs->options = NULL; |
f67503e5 HR |
1554 | if (!*pbs) { |
1555 | /* If *pbs is NULL, a new BDS has been created in this function and | |
1556 | needs to be freed now. Otherwise, it does not need to be closed, | |
1557 | since it has not really been opened yet. */ | |
1558 | bdrv_unref(bs); | |
1559 | } | |
84d18f06 | 1560 | if (local_err) { |
34b5d2c6 HR |
1561 | error_propagate(errp, local_err); |
1562 | } | |
b6ad491a | 1563 | return ret; |
de9c0cec | 1564 | |
b6ad491a | 1565 | close_and_fail: |
f67503e5 HR |
1566 | /* See fail path, but now the BDS has to be always closed */ |
1567 | if (*pbs) { | |
1568 | bdrv_close(bs); | |
1569 | } else { | |
1570 | bdrv_unref(bs); | |
1571 | } | |
b6ad491a | 1572 | QDECREF(options); |
84d18f06 | 1573 | if (local_err) { |
34b5d2c6 HR |
1574 | error_propagate(errp, local_err); |
1575 | } | |
b6ce07aa KW |
1576 | return ret; |
1577 | } | |
1578 | ||
e971aa12 JC |
1579 | typedef struct BlockReopenQueueEntry { |
1580 | bool prepared; | |
1581 | BDRVReopenState state; | |
1582 | QSIMPLEQ_ENTRY(BlockReopenQueueEntry) entry; | |
1583 | } BlockReopenQueueEntry; | |
1584 | ||
1585 | /* | |
1586 | * Adds a BlockDriverState to a simple queue for an atomic, transactional | |
1587 | * reopen of multiple devices. | |
1588 | * | |
1589 | * bs_queue can either be an existing BlockReopenQueue that has had QSIMPLE_INIT | |
1590 | * already performed, or alternatively may be NULL a new BlockReopenQueue will | |
1591 | * be created and initialized. This newly created BlockReopenQueue should be | |
1592 | * passed back in for subsequent calls that are intended to be of the same | |
1593 | * atomic 'set'. | |
1594 | * | |
1595 | * bs is the BlockDriverState to add to the reopen queue. | |
1596 | * | |
1597 | * flags contains the open flags for the associated bs | |
1598 | * | |
1599 | * returns a pointer to bs_queue, which is either the newly allocated | |
1600 | * bs_queue, or the existing bs_queue being used. | |
1601 | * | |
1602 | */ | |
1603 | BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue, | |
1604 | BlockDriverState *bs, int flags) | |
1605 | { | |
1606 | assert(bs != NULL); | |
1607 | ||
1608 | BlockReopenQueueEntry *bs_entry; | |
1609 | if (bs_queue == NULL) { | |
1610 | bs_queue = g_new0(BlockReopenQueue, 1); | |
1611 | QSIMPLEQ_INIT(bs_queue); | |
1612 | } | |
1613 | ||
f1f25a2e KW |
1614 | /* bdrv_open() masks this flag out */ |
1615 | flags &= ~BDRV_O_PROTOCOL; | |
1616 | ||
e971aa12 | 1617 | if (bs->file) { |
f1f25a2e | 1618 | bdrv_reopen_queue(bs_queue, bs->file, bdrv_inherited_flags(flags)); |
e971aa12 JC |
1619 | } |
1620 | ||
1621 | bs_entry = g_new0(BlockReopenQueueEntry, 1); | |
1622 | QSIMPLEQ_INSERT_TAIL(bs_queue, bs_entry, entry); | |
1623 | ||
1624 | bs_entry->state.bs = bs; | |
1625 | bs_entry->state.flags = flags; | |
1626 | ||
1627 | return bs_queue; | |
1628 | } | |
1629 | ||
1630 | /* | |
1631 | * Reopen multiple BlockDriverStates atomically & transactionally. | |
1632 | * | |
1633 | * The queue passed in (bs_queue) must have been built up previous | |
1634 | * via bdrv_reopen_queue(). | |
1635 | * | |
1636 | * Reopens all BDS specified in the queue, with the appropriate | |
1637 | * flags. All devices are prepared for reopen, and failure of any | |
1638 | * device will cause all device changes to be abandonded, and intermediate | |
1639 | * data cleaned up. | |
1640 | * | |
1641 | * If all devices prepare successfully, then the changes are committed | |
1642 | * to all devices. | |
1643 | * | |
1644 | */ | |
1645 | int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp) | |
1646 | { | |
1647 | int ret = -1; | |
1648 | BlockReopenQueueEntry *bs_entry, *next; | |
1649 | Error *local_err = NULL; | |
1650 | ||
1651 | assert(bs_queue != NULL); | |
1652 | ||
1653 | bdrv_drain_all(); | |
1654 | ||
1655 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { | |
1656 | if (bdrv_reopen_prepare(&bs_entry->state, bs_queue, &local_err)) { | |
1657 | error_propagate(errp, local_err); | |
1658 | goto cleanup; | |
1659 | } | |
1660 | bs_entry->prepared = true; | |
1661 | } | |
1662 | ||
1663 | /* If we reach this point, we have success and just need to apply the | |
1664 | * changes | |
1665 | */ | |
1666 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { | |
1667 | bdrv_reopen_commit(&bs_entry->state); | |
1668 | } | |
1669 | ||
1670 | ret = 0; | |
1671 | ||
1672 | cleanup: | |
1673 | QSIMPLEQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) { | |
1674 | if (ret && bs_entry->prepared) { | |
1675 | bdrv_reopen_abort(&bs_entry->state); | |
1676 | } | |
1677 | g_free(bs_entry); | |
1678 | } | |
1679 | g_free(bs_queue); | |
1680 | return ret; | |
1681 | } | |
1682 | ||
1683 | ||
1684 | /* Reopen a single BlockDriverState with the specified flags. */ | |
1685 | int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp) | |
1686 | { | |
1687 | int ret = -1; | |
1688 | Error *local_err = NULL; | |
1689 | BlockReopenQueue *queue = bdrv_reopen_queue(NULL, bs, bdrv_flags); | |
1690 | ||
1691 | ret = bdrv_reopen_multiple(queue, &local_err); | |
1692 | if (local_err != NULL) { | |
1693 | error_propagate(errp, local_err); | |
1694 | } | |
1695 | return ret; | |
1696 | } | |
1697 | ||
1698 | ||
1699 | /* | |
1700 | * Prepares a BlockDriverState for reopen. All changes are staged in the | |
1701 | * 'opaque' field of the BDRVReopenState, which is used and allocated by | |
1702 | * the block driver layer .bdrv_reopen_prepare() | |
1703 | * | |
1704 | * bs is the BlockDriverState to reopen | |
1705 | * flags are the new open flags | |
1706 | * queue is the reopen queue | |
1707 | * | |
1708 | * Returns 0 on success, non-zero on error. On error errp will be set | |
1709 | * as well. | |
1710 | * | |
1711 | * On failure, bdrv_reopen_abort() will be called to clean up any data. | |
1712 | * It is the responsibility of the caller to then call the abort() or | |
1713 | * commit() for any other BDS that have been left in a prepare() state | |
1714 | * | |
1715 | */ | |
1716 | int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue, | |
1717 | Error **errp) | |
1718 | { | |
1719 | int ret = -1; | |
1720 | Error *local_err = NULL; | |
1721 | BlockDriver *drv; | |
1722 | ||
1723 | assert(reopen_state != NULL); | |
1724 | assert(reopen_state->bs->drv != NULL); | |
1725 | drv = reopen_state->bs->drv; | |
1726 | ||
1727 | /* if we are to stay read-only, do not allow permission change | |
1728 | * to r/w */ | |
1729 | if (!(reopen_state->bs->open_flags & BDRV_O_ALLOW_RDWR) && | |
1730 | reopen_state->flags & BDRV_O_RDWR) { | |
1731 | error_set(errp, QERR_DEVICE_IS_READ_ONLY, | |
bfb197e0 | 1732 | bdrv_get_device_name(reopen_state->bs)); |
e971aa12 JC |
1733 | goto error; |
1734 | } | |
1735 | ||
1736 | ||
1737 | ret = bdrv_flush(reopen_state->bs); | |
1738 | if (ret) { | |
1739 | error_set(errp, ERROR_CLASS_GENERIC_ERROR, "Error (%s) flushing drive", | |
1740 | strerror(-ret)); | |
1741 | goto error; | |
1742 | } | |
1743 | ||
1744 | if (drv->bdrv_reopen_prepare) { | |
1745 | ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err); | |
1746 | if (ret) { | |
1747 | if (local_err != NULL) { | |
1748 | error_propagate(errp, local_err); | |
1749 | } else { | |
d8b6895f LC |
1750 | error_setg(errp, "failed while preparing to reopen image '%s'", |
1751 | reopen_state->bs->filename); | |
e971aa12 JC |
1752 | } |
1753 | goto error; | |
1754 | } | |
1755 | } else { | |
1756 | /* It is currently mandatory to have a bdrv_reopen_prepare() | |
1757 | * handler for each supported drv. */ | |
1758 | error_set(errp, QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED, | |
bfb197e0 | 1759 | drv->format_name, bdrv_get_device_name(reopen_state->bs), |
e971aa12 JC |
1760 | "reopening of file"); |
1761 | ret = -1; | |
1762 | goto error; | |
1763 | } | |
1764 | ||
1765 | ret = 0; | |
1766 | ||
1767 | error: | |
1768 | return ret; | |
1769 | } | |
1770 | ||
1771 | /* | |
1772 | * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and | |
1773 | * makes them final by swapping the staging BlockDriverState contents into | |
1774 | * the active BlockDriverState contents. | |
1775 | */ | |
1776 | void bdrv_reopen_commit(BDRVReopenState *reopen_state) | |
1777 | { | |
1778 | BlockDriver *drv; | |
1779 | ||
1780 | assert(reopen_state != NULL); | |
1781 | drv = reopen_state->bs->drv; | |
1782 | assert(drv != NULL); | |
1783 | ||
1784 | /* If there are any driver level actions to take */ | |
1785 | if (drv->bdrv_reopen_commit) { | |
1786 | drv->bdrv_reopen_commit(reopen_state); | |
1787 | } | |
1788 | ||
1789 | /* set BDS specific flags now */ | |
1790 | reopen_state->bs->open_flags = reopen_state->flags; | |
1791 | reopen_state->bs->enable_write_cache = !!(reopen_state->flags & | |
1792 | BDRV_O_CACHE_WB); | |
1793 | reopen_state->bs->read_only = !(reopen_state->flags & BDRV_O_RDWR); | |
355ef4ac | 1794 | |
3baca891 | 1795 | bdrv_refresh_limits(reopen_state->bs, NULL); |
e971aa12 JC |
1796 | } |
1797 | ||
1798 | /* | |
1799 | * Abort the reopen, and delete and free the staged changes in | |
1800 | * reopen_state | |
1801 | */ | |
1802 | void bdrv_reopen_abort(BDRVReopenState *reopen_state) | |
1803 | { | |
1804 | BlockDriver *drv; | |
1805 | ||
1806 | assert(reopen_state != NULL); | |
1807 | drv = reopen_state->bs->drv; | |
1808 | assert(drv != NULL); | |
1809 | ||
1810 | if (drv->bdrv_reopen_abort) { | |
1811 | drv->bdrv_reopen_abort(reopen_state); | |
1812 | } | |
1813 | } | |
1814 | ||
1815 | ||
fc01f7e7 FB |
1816 | void bdrv_close(BlockDriverState *bs) |
1817 | { | |
33384421 HR |
1818 | BdrvAioNotifier *ban, *ban_next; |
1819 | ||
3cbc002c PB |
1820 | if (bs->job) { |
1821 | block_job_cancel_sync(bs->job); | |
1822 | } | |
58fda173 SH |
1823 | bdrv_drain_all(); /* complete I/O */ |
1824 | bdrv_flush(bs); | |
1825 | bdrv_drain_all(); /* in case flush left pending I/O */ | |
d7d512f6 | 1826 | notifier_list_notify(&bs->close_notifiers, bs); |
7094f12f | 1827 | |
3cbc002c | 1828 | if (bs->drv) { |
557df6ac | 1829 | if (bs->backing_hd) { |
826b6ca0 FZ |
1830 | BlockDriverState *backing_hd = bs->backing_hd; |
1831 | bdrv_set_backing_hd(bs, NULL); | |
1832 | bdrv_unref(backing_hd); | |
557df6ac | 1833 | } |
ea2384d3 | 1834 | bs->drv->bdrv_close(bs); |
7267c094 | 1835 | g_free(bs->opaque); |
ea2384d3 FB |
1836 | bs->opaque = NULL; |
1837 | bs->drv = NULL; | |
53fec9d3 | 1838 | bs->copy_on_read = 0; |
a275fa42 PB |
1839 | bs->backing_file[0] = '\0'; |
1840 | bs->backing_format[0] = '\0'; | |
6405875c PB |
1841 | bs->total_sectors = 0; |
1842 | bs->encrypted = 0; | |
1843 | bs->valid_key = 0; | |
1844 | bs->sg = 0; | |
1845 | bs->growable = 0; | |
0d51b4de | 1846 | bs->zero_beyond_eof = false; |
de9c0cec KW |
1847 | QDECREF(bs->options); |
1848 | bs->options = NULL; | |
91af7014 HR |
1849 | QDECREF(bs->full_open_options); |
1850 | bs->full_open_options = NULL; | |
b338082b | 1851 | |
66f82cee | 1852 | if (bs->file != NULL) { |
4f6fd349 | 1853 | bdrv_unref(bs->file); |
0ac9377d | 1854 | bs->file = NULL; |
66f82cee | 1855 | } |
b338082b | 1856 | } |
98f90dba | 1857 | |
a7f53e26 MA |
1858 | if (bs->blk) { |
1859 | blk_dev_change_media_cb(bs->blk, false); | |
1860 | } | |
9ca11154 | 1861 | |
98f90dba ZYW |
1862 | /*throttling disk I/O limits*/ |
1863 | if (bs->io_limits_enabled) { | |
1864 | bdrv_io_limits_disable(bs); | |
1865 | } | |
33384421 HR |
1866 | |
1867 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { | |
1868 | g_free(ban); | |
1869 | } | |
1870 | QLIST_INIT(&bs->aio_notifiers); | |
b338082b FB |
1871 | } |
1872 | ||
2bc93fed MK |
1873 | void bdrv_close_all(void) |
1874 | { | |
1875 | BlockDriverState *bs; | |
1876 | ||
dc364f4c | 1877 | QTAILQ_FOREACH(bs, &bdrv_states, device_list) { |
ed78cda3 SH |
1878 | AioContext *aio_context = bdrv_get_aio_context(bs); |
1879 | ||
1880 | aio_context_acquire(aio_context); | |
2bc93fed | 1881 | bdrv_close(bs); |
ed78cda3 | 1882 | aio_context_release(aio_context); |
2bc93fed MK |
1883 | } |
1884 | } | |
1885 | ||
88266f5a SH |
1886 | /* Check if any requests are in-flight (including throttled requests) */ |
1887 | static bool bdrv_requests_pending(BlockDriverState *bs) | |
1888 | { | |
1889 | if (!QLIST_EMPTY(&bs->tracked_requests)) { | |
1890 | return true; | |
1891 | } | |
cc0681c4 BC |
1892 | if (!qemu_co_queue_empty(&bs->throttled_reqs[0])) { |
1893 | return true; | |
1894 | } | |
1895 | if (!qemu_co_queue_empty(&bs->throttled_reqs[1])) { | |
88266f5a SH |
1896 | return true; |
1897 | } | |
1898 | if (bs->file && bdrv_requests_pending(bs->file)) { | |
1899 | return true; | |
1900 | } | |
1901 | if (bs->backing_hd && bdrv_requests_pending(bs->backing_hd)) { | |
1902 | return true; | |
1903 | } | |
1904 | return false; | |
1905 | } | |
1906 | ||
5b98db0a SH |
1907 | static bool bdrv_drain_one(BlockDriverState *bs) |
1908 | { | |
1909 | bool bs_busy; | |
1910 | ||
1911 | bdrv_flush_io_queue(bs); | |
1912 | bdrv_start_throttled_reqs(bs); | |
1913 | bs_busy = bdrv_requests_pending(bs); | |
1914 | bs_busy |= aio_poll(bdrv_get_aio_context(bs), bs_busy); | |
1915 | return bs_busy; | |
1916 | } | |
1917 | ||
1918 | /* | |
1919 | * Wait for pending requests to complete on a single BlockDriverState subtree | |
1920 | * | |
1921 | * See the warning in bdrv_drain_all(). This function can only be called if | |
1922 | * you are sure nothing can generate I/O because you have op blockers | |
1923 | * installed. | |
1924 | * | |
1925 | * Note that unlike bdrv_drain_all(), the caller must hold the BlockDriverState | |
1926 | * AioContext. | |
1927 | */ | |
1928 | void bdrv_drain(BlockDriverState *bs) | |
1929 | { | |
1930 | while (bdrv_drain_one(bs)) { | |
1931 | /* Keep iterating */ | |
1932 | } | |
1933 | } | |
1934 | ||
922453bc SH |
1935 | /* |
1936 | * Wait for pending requests to complete across all BlockDriverStates | |
1937 | * | |
1938 | * This function does not flush data to disk, use bdrv_flush_all() for that | |
1939 | * after calling this function. | |
4c355d53 ZYW |
1940 | * |
1941 | * Note that completion of an asynchronous I/O operation can trigger any | |
1942 | * number of other I/O operations on other devices---for example a coroutine | |
1943 | * can be arbitrarily complex and a constant flow of I/O can come until the | |
1944 | * coroutine is complete. Because of this, it is not possible to have a | |
1945 | * function to drain a single device's I/O queue. | |
922453bc SH |
1946 | */ |
1947 | void bdrv_drain_all(void) | |
1948 | { | |
88266f5a SH |
1949 | /* Always run first iteration so any pending completion BHs run */ |
1950 | bool busy = true; | |
922453bc SH |
1951 | BlockDriverState *bs; |
1952 | ||
88266f5a | 1953 | while (busy) { |
9b536adc SH |
1954 | busy = false; |
1955 | ||
dc364f4c | 1956 | QTAILQ_FOREACH(bs, &bdrv_states, device_list) { |
9b536adc | 1957 | AioContext *aio_context = bdrv_get_aio_context(bs); |
9b536adc SH |
1958 | |
1959 | aio_context_acquire(aio_context); | |
5b98db0a | 1960 | busy |= bdrv_drain_one(bs); |
9b536adc | 1961 | aio_context_release(aio_context); |
9b536adc | 1962 | } |
922453bc SH |
1963 | } |
1964 | } | |
1965 | ||
dc364f4c BC |
1966 | /* make a BlockDriverState anonymous by removing from bdrv_state and |
1967 | * graph_bdrv_state list. | |
d22b2f41 RH |
1968 | Also, NULL terminate the device_name to prevent double remove */ |
1969 | void bdrv_make_anon(BlockDriverState *bs) | |
1970 | { | |
bfb197e0 MA |
1971 | /* |
1972 | * Take care to remove bs from bdrv_states only when it's actually | |
1973 | * in it. Note that bs->device_list.tqe_prev is initially null, | |
1974 | * and gets set to non-null by QTAILQ_INSERT_TAIL(). Establish | |
1975 | * the useful invariant "bs in bdrv_states iff bs->tqe_prev" by | |
1976 | * resetting it to null on remove. | |
1977 | */ | |
1978 | if (bs->device_list.tqe_prev) { | |
dc364f4c | 1979 | QTAILQ_REMOVE(&bdrv_states, bs, device_list); |
bfb197e0 | 1980 | bs->device_list.tqe_prev = NULL; |
d22b2f41 | 1981 | } |
dc364f4c BC |
1982 | if (bs->node_name[0] != '\0') { |
1983 | QTAILQ_REMOVE(&graph_bdrv_states, bs, node_list); | |
1984 | } | |
1985 | bs->node_name[0] = '\0'; | |
d22b2f41 RH |
1986 | } |
1987 | ||
e023b2e2 PB |
1988 | static void bdrv_rebind(BlockDriverState *bs) |
1989 | { | |
1990 | if (bs->drv && bs->drv->bdrv_rebind) { | |
1991 | bs->drv->bdrv_rebind(bs); | |
1992 | } | |
1993 | } | |
1994 | ||
4ddc07ca PB |
1995 | static void bdrv_move_feature_fields(BlockDriverState *bs_dest, |
1996 | BlockDriverState *bs_src) | |
8802d1fd | 1997 | { |
4ddc07ca | 1998 | /* move some fields that need to stay attached to the device */ |
8802d1fd JC |
1999 | |
2000 | /* dev info */ | |
1b7fd729 | 2001 | bs_dest->guest_block_size = bs_src->guest_block_size; |
4ddc07ca | 2002 | bs_dest->copy_on_read = bs_src->copy_on_read; |
8802d1fd | 2003 | |
4ddc07ca | 2004 | bs_dest->enable_write_cache = bs_src->enable_write_cache; |
c4a248a1 | 2005 | |
cc0681c4 BC |
2006 | /* i/o throttled req */ |
2007 | memcpy(&bs_dest->throttle_state, | |
2008 | &bs_src->throttle_state, | |
2009 | sizeof(ThrottleState)); | |
2010 | bs_dest->throttled_reqs[0] = bs_src->throttled_reqs[0]; | |
2011 | bs_dest->throttled_reqs[1] = bs_src->throttled_reqs[1]; | |
4ddc07ca | 2012 | bs_dest->io_limits_enabled = bs_src->io_limits_enabled; |
8802d1fd | 2013 | |
8802d1fd | 2014 | /* r/w error */ |
4ddc07ca PB |
2015 | bs_dest->on_read_error = bs_src->on_read_error; |
2016 | bs_dest->on_write_error = bs_src->on_write_error; | |
8802d1fd JC |
2017 | |
2018 | /* i/o status */ | |
4ddc07ca PB |
2019 | bs_dest->iostatus_enabled = bs_src->iostatus_enabled; |
2020 | bs_dest->iostatus = bs_src->iostatus; | |
8802d1fd | 2021 | |
a9fc4408 | 2022 | /* dirty bitmap */ |
e4654d2d | 2023 | bs_dest->dirty_bitmaps = bs_src->dirty_bitmaps; |
a9fc4408 | 2024 | |
9fcb0251 FZ |
2025 | /* reference count */ |
2026 | bs_dest->refcnt = bs_src->refcnt; | |
2027 | ||
a9fc4408 | 2028 | /* job */ |
4ddc07ca | 2029 | bs_dest->job = bs_src->job; |
a9fc4408 | 2030 | |
8802d1fd | 2031 | /* keep the same entry in bdrv_states */ |
dc364f4c | 2032 | bs_dest->device_list = bs_src->device_list; |
7e7d56d9 MA |
2033 | bs_dest->blk = bs_src->blk; |
2034 | ||
fbe40ff7 FZ |
2035 | memcpy(bs_dest->op_blockers, bs_src->op_blockers, |
2036 | sizeof(bs_dest->op_blockers)); | |
4ddc07ca | 2037 | } |
8802d1fd | 2038 | |
4ddc07ca PB |
2039 | /* |
2040 | * Swap bs contents for two image chains while they are live, | |
2041 | * while keeping required fields on the BlockDriverState that is | |
2042 | * actually attached to a device. | |
2043 | * | |
2044 | * This will modify the BlockDriverState fields, and swap contents | |
2045 | * between bs_new and bs_old. Both bs_new and bs_old are modified. | |
2046 | * | |
bfb197e0 | 2047 | * bs_new must not be attached to a BlockBackend. |
4ddc07ca PB |
2048 | * |
2049 | * This function does not create any image files. | |
2050 | */ | |
2051 | void bdrv_swap(BlockDriverState *bs_new, BlockDriverState *bs_old) | |
2052 | { | |
2053 | BlockDriverState tmp; | |
f6801b83 | 2054 | |
90ce8a06 BC |
2055 | /* The code needs to swap the node_name but simply swapping node_list won't |
2056 | * work so first remove the nodes from the graph list, do the swap then | |
2057 | * insert them back if needed. | |
2058 | */ | |
2059 | if (bs_new->node_name[0] != '\0') { | |
2060 | QTAILQ_REMOVE(&graph_bdrv_states, bs_new, node_list); | |
2061 | } | |
2062 | if (bs_old->node_name[0] != '\0') { | |
2063 | QTAILQ_REMOVE(&graph_bdrv_states, bs_old, node_list); | |
2064 | } | |
2065 | ||
bfb197e0 | 2066 | /* bs_new must be unattached and shouldn't have anything fancy enabled */ |
7e7d56d9 | 2067 | assert(!bs_new->blk); |
e4654d2d | 2068 | assert(QLIST_EMPTY(&bs_new->dirty_bitmaps)); |
4ddc07ca | 2069 | assert(bs_new->job == NULL); |
4ddc07ca | 2070 | assert(bs_new->io_limits_enabled == false); |
cc0681c4 | 2071 | assert(!throttle_have_timer(&bs_new->throttle_state)); |
8802d1fd | 2072 | |
4ddc07ca PB |
2073 | tmp = *bs_new; |
2074 | *bs_new = *bs_old; | |
2075 | *bs_old = tmp; | |
a9fc4408 | 2076 | |
4ddc07ca PB |
2077 | /* there are some fields that should not be swapped, move them back */ |
2078 | bdrv_move_feature_fields(&tmp, bs_old); | |
2079 | bdrv_move_feature_fields(bs_old, bs_new); | |
2080 | bdrv_move_feature_fields(bs_new, &tmp); | |
8802d1fd | 2081 | |
bfb197e0 | 2082 | /* bs_new must remain unattached */ |
7e7d56d9 | 2083 | assert(!bs_new->blk); |
4ddc07ca PB |
2084 | |
2085 | /* Check a few fields that should remain attached to the device */ | |
4ddc07ca | 2086 | assert(bs_new->job == NULL); |
4ddc07ca | 2087 | assert(bs_new->io_limits_enabled == false); |
cc0681c4 | 2088 | assert(!throttle_have_timer(&bs_new->throttle_state)); |
e023b2e2 | 2089 | |
90ce8a06 BC |
2090 | /* insert the nodes back into the graph node list if needed */ |
2091 | if (bs_new->node_name[0] != '\0') { | |
2092 | QTAILQ_INSERT_TAIL(&graph_bdrv_states, bs_new, node_list); | |
2093 | } | |
2094 | if (bs_old->node_name[0] != '\0') { | |
2095 | QTAILQ_INSERT_TAIL(&graph_bdrv_states, bs_old, node_list); | |
2096 | } | |
2097 | ||
e023b2e2 | 2098 | bdrv_rebind(bs_new); |
4ddc07ca PB |
2099 | bdrv_rebind(bs_old); |
2100 | } | |
2101 | ||
2102 | /* | |
2103 | * Add new bs contents at the top of an image chain while the chain is | |
2104 | * live, while keeping required fields on the top layer. | |
2105 | * | |
2106 | * This will modify the BlockDriverState fields, and swap contents | |
2107 | * between bs_new and bs_top. Both bs_new and bs_top are modified. | |
2108 | * | |
bfb197e0 | 2109 | * bs_new must not be attached to a BlockBackend. |
4ddc07ca PB |
2110 | * |
2111 | * This function does not create any image files. | |
2112 | */ | |
2113 | void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top) | |
2114 | { | |
2115 | bdrv_swap(bs_new, bs_top); | |
2116 | ||
2117 | /* The contents of 'tmp' will become bs_top, as we are | |
2118 | * swapping bs_new and bs_top contents. */ | |
8d24cce1 | 2119 | bdrv_set_backing_hd(bs_top, bs_new); |
8802d1fd JC |
2120 | } |
2121 | ||
4f6fd349 | 2122 | static void bdrv_delete(BlockDriverState *bs) |
b338082b | 2123 | { |
3e914655 | 2124 | assert(!bs->job); |
3718d8ab | 2125 | assert(bdrv_op_blocker_is_empty(bs)); |
4f6fd349 | 2126 | assert(!bs->refcnt); |
e4654d2d | 2127 | assert(QLIST_EMPTY(&bs->dirty_bitmaps)); |
18846dee | 2128 | |
e1b5c52e SH |
2129 | bdrv_close(bs); |
2130 | ||
1b7bdbc1 | 2131 | /* remove from list, if necessary */ |
d22b2f41 | 2132 | bdrv_make_anon(bs); |
34c6f050 | 2133 | |
7267c094 | 2134 | g_free(bs); |
fc01f7e7 FB |
2135 | } |
2136 | ||
e97fc193 AL |
2137 | /* |
2138 | * Run consistency checks on an image | |
2139 | * | |
e076f338 | 2140 | * Returns 0 if the check could be completed (it doesn't mean that the image is |
a1c7273b | 2141 | * free of errors) or -errno when an internal error occurred. The results of the |
e076f338 | 2142 | * check are stored in res. |
e97fc193 | 2143 | */ |
4534ff54 | 2144 | int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix) |
e97fc193 | 2145 | { |
908bcd54 HR |
2146 | if (bs->drv == NULL) { |
2147 | return -ENOMEDIUM; | |
2148 | } | |
e97fc193 AL |
2149 | if (bs->drv->bdrv_check == NULL) { |
2150 | return -ENOTSUP; | |
2151 | } | |
2152 | ||
e076f338 | 2153 | memset(res, 0, sizeof(*res)); |
4534ff54 | 2154 | return bs->drv->bdrv_check(bs, res, fix); |
e97fc193 AL |
2155 | } |
2156 | ||
8a426614 KW |
2157 | #define COMMIT_BUF_SECTORS 2048 |
2158 | ||
33e3963e FB |
2159 | /* commit COW file into the raw image */ |
2160 | int bdrv_commit(BlockDriverState *bs) | |
2161 | { | |
19cb3738 | 2162 | BlockDriver *drv = bs->drv; |
72706ea4 | 2163 | int64_t sector, total_sectors, length, backing_length; |
8a426614 | 2164 | int n, ro, open_flags; |
0bce597d | 2165 | int ret = 0; |
72706ea4 | 2166 | uint8_t *buf = NULL; |
c2cba3d9 | 2167 | char filename[PATH_MAX]; |
33e3963e | 2168 | |
19cb3738 FB |
2169 | if (!drv) |
2170 | return -ENOMEDIUM; | |
6bb45158 | 2171 | |
4dca4b63 NS |
2172 | if (!bs->backing_hd) { |
2173 | return -ENOTSUP; | |
33e3963e FB |
2174 | } |
2175 | ||
3718d8ab FZ |
2176 | if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT, NULL) || |
2177 | bdrv_op_is_blocked(bs->backing_hd, BLOCK_OP_TYPE_COMMIT, NULL)) { | |
2d3735d3 SH |
2178 | return -EBUSY; |
2179 | } | |
2180 | ||
4dca4b63 | 2181 | ro = bs->backing_hd->read_only; |
c2cba3d9 JM |
2182 | /* Use pstrcpy (not strncpy): filename must be NUL-terminated. */ |
2183 | pstrcpy(filename, sizeof(filename), bs->backing_hd->filename); | |
4dca4b63 NS |
2184 | open_flags = bs->backing_hd->open_flags; |
2185 | ||
2186 | if (ro) { | |
0bce597d JC |
2187 | if (bdrv_reopen(bs->backing_hd, open_flags | BDRV_O_RDWR, NULL)) { |
2188 | return -EACCES; | |
4dca4b63 | 2189 | } |
ea2384d3 | 2190 | } |
33e3963e | 2191 | |
72706ea4 JC |
2192 | length = bdrv_getlength(bs); |
2193 | if (length < 0) { | |
2194 | ret = length; | |
2195 | goto ro_cleanup; | |
2196 | } | |
2197 | ||
2198 | backing_length = bdrv_getlength(bs->backing_hd); | |
2199 | if (backing_length < 0) { | |
2200 | ret = backing_length; | |
2201 | goto ro_cleanup; | |
2202 | } | |
2203 | ||
2204 | /* If our top snapshot is larger than the backing file image, | |
2205 | * grow the backing file image if possible. If not possible, | |
2206 | * we must return an error */ | |
2207 | if (length > backing_length) { | |
2208 | ret = bdrv_truncate(bs->backing_hd, length); | |
2209 | if (ret < 0) { | |
2210 | goto ro_cleanup; | |
2211 | } | |
2212 | } | |
2213 | ||
2214 | total_sectors = length >> BDRV_SECTOR_BITS; | |
857d4f46 KW |
2215 | |
2216 | /* qemu_try_blockalign() for bs will choose an alignment that works for | |
2217 | * bs->backing_hd as well, so no need to compare the alignment manually. */ | |
2218 | buf = qemu_try_blockalign(bs, COMMIT_BUF_SECTORS * BDRV_SECTOR_SIZE); | |
2219 | if (buf == NULL) { | |
2220 | ret = -ENOMEM; | |
2221 | goto ro_cleanup; | |
2222 | } | |
8a426614 KW |
2223 | |
2224 | for (sector = 0; sector < total_sectors; sector += n) { | |
d663640c PB |
2225 | ret = bdrv_is_allocated(bs, sector, COMMIT_BUF_SECTORS, &n); |
2226 | if (ret < 0) { | |
2227 | goto ro_cleanup; | |
2228 | } | |
2229 | if (ret) { | |
dabfa6cc KW |
2230 | ret = bdrv_read(bs, sector, buf, n); |
2231 | if (ret < 0) { | |
8a426614 KW |
2232 | goto ro_cleanup; |
2233 | } | |
2234 | ||
dabfa6cc KW |
2235 | ret = bdrv_write(bs->backing_hd, sector, buf, n); |
2236 | if (ret < 0) { | |
8a426614 KW |
2237 | goto ro_cleanup; |
2238 | } | |
ea2384d3 | 2239 | } |
33e3963e | 2240 | } |
95389c86 | 2241 | |
1d44952f CH |
2242 | if (drv->bdrv_make_empty) { |
2243 | ret = drv->bdrv_make_empty(bs); | |
dabfa6cc KW |
2244 | if (ret < 0) { |
2245 | goto ro_cleanup; | |
2246 | } | |
1d44952f CH |
2247 | bdrv_flush(bs); |
2248 | } | |
95389c86 | 2249 | |
3f5075ae CH |
2250 | /* |
2251 | * Make sure all data we wrote to the backing device is actually | |
2252 | * stable on disk. | |
2253 | */ | |
dabfa6cc | 2254 | if (bs->backing_hd) { |
3f5075ae | 2255 | bdrv_flush(bs->backing_hd); |
dabfa6cc | 2256 | } |
4dca4b63 | 2257 | |
dabfa6cc | 2258 | ret = 0; |
4dca4b63 | 2259 | ro_cleanup: |
857d4f46 | 2260 | qemu_vfree(buf); |
4dca4b63 NS |
2261 | |
2262 | if (ro) { | |
0bce597d JC |
2263 | /* ignoring error return here */ |
2264 | bdrv_reopen(bs->backing_hd, open_flags & ~BDRV_O_RDWR, NULL); | |
4dca4b63 NS |
2265 | } |
2266 | ||
1d44952f | 2267 | return ret; |
33e3963e FB |
2268 | } |
2269 | ||
e8877497 | 2270 | int bdrv_commit_all(void) |
6ab4b5ab MA |
2271 | { |
2272 | BlockDriverState *bs; | |
2273 | ||
dc364f4c | 2274 | QTAILQ_FOREACH(bs, &bdrv_states, device_list) { |
ed78cda3 SH |
2275 | AioContext *aio_context = bdrv_get_aio_context(bs); |
2276 | ||
2277 | aio_context_acquire(aio_context); | |
272d2d8e JC |
2278 | if (bs->drv && bs->backing_hd) { |
2279 | int ret = bdrv_commit(bs); | |
2280 | if (ret < 0) { | |
ed78cda3 | 2281 | aio_context_release(aio_context); |
272d2d8e JC |
2282 | return ret; |
2283 | } | |
e8877497 | 2284 | } |
ed78cda3 | 2285 | aio_context_release(aio_context); |
6ab4b5ab | 2286 | } |
e8877497 | 2287 | return 0; |
6ab4b5ab MA |
2288 | } |
2289 | ||
dbffbdcf SH |
2290 | /** |
2291 | * Remove an active request from the tracked requests list | |
2292 | * | |
2293 | * This function should be called when a tracked request is completing. | |
2294 | */ | |
2295 | static void tracked_request_end(BdrvTrackedRequest *req) | |
2296 | { | |
2dbafdc0 KW |
2297 | if (req->serialising) { |
2298 | req->bs->serialising_in_flight--; | |
2299 | } | |
2300 | ||
dbffbdcf | 2301 | QLIST_REMOVE(req, list); |
f4658285 | 2302 | qemu_co_queue_restart_all(&req->wait_queue); |
dbffbdcf SH |
2303 | } |
2304 | ||
2305 | /** | |
2306 | * Add an active request to the tracked requests list | |
2307 | */ | |
2308 | static void tracked_request_begin(BdrvTrackedRequest *req, | |
2309 | BlockDriverState *bs, | |
793ed47a KW |
2310 | int64_t offset, |
2311 | unsigned int bytes, bool is_write) | |
dbffbdcf SH |
2312 | { |
2313 | *req = (BdrvTrackedRequest){ | |
2314 | .bs = bs, | |
2dbafdc0 KW |
2315 | .offset = offset, |
2316 | .bytes = bytes, | |
2317 | .is_write = is_write, | |
2318 | .co = qemu_coroutine_self(), | |
2319 | .serialising = false, | |
7327145f KW |
2320 | .overlap_offset = offset, |
2321 | .overlap_bytes = bytes, | |
dbffbdcf SH |
2322 | }; |
2323 | ||
f4658285 SH |
2324 | qemu_co_queue_init(&req->wait_queue); |
2325 | ||
dbffbdcf SH |
2326 | QLIST_INSERT_HEAD(&bs->tracked_requests, req, list); |
2327 | } | |
2328 | ||
e96126ff | 2329 | static void mark_request_serialising(BdrvTrackedRequest *req, uint64_t align) |
2dbafdc0 | 2330 | { |
7327145f | 2331 | int64_t overlap_offset = req->offset & ~(align - 1); |
e96126ff KW |
2332 | unsigned int overlap_bytes = ROUND_UP(req->offset + req->bytes, align) |
2333 | - overlap_offset; | |
7327145f | 2334 | |
2dbafdc0 KW |
2335 | if (!req->serialising) { |
2336 | req->bs->serialising_in_flight++; | |
2337 | req->serialising = true; | |
2338 | } | |
7327145f KW |
2339 | |
2340 | req->overlap_offset = MIN(req->overlap_offset, overlap_offset); | |
2341 | req->overlap_bytes = MAX(req->overlap_bytes, overlap_bytes); | |
2dbafdc0 KW |
2342 | } |
2343 | ||
d83947ac SH |
2344 | /** |
2345 | * Round a region to cluster boundaries | |
2346 | */ | |
343bded4 PB |
2347 | void bdrv_round_to_clusters(BlockDriverState *bs, |
2348 | int64_t sector_num, int nb_sectors, | |
2349 | int64_t *cluster_sector_num, | |
2350 | int *cluster_nb_sectors) | |
d83947ac SH |
2351 | { |
2352 | BlockDriverInfo bdi; | |
2353 | ||
2354 | if (bdrv_get_info(bs, &bdi) < 0 || bdi.cluster_size == 0) { | |
2355 | *cluster_sector_num = sector_num; | |
2356 | *cluster_nb_sectors = nb_sectors; | |
2357 | } else { | |
2358 | int64_t c = bdi.cluster_size / BDRV_SECTOR_SIZE; | |
2359 | *cluster_sector_num = QEMU_ALIGN_DOWN(sector_num, c); | |
2360 | *cluster_nb_sectors = QEMU_ALIGN_UP(sector_num - *cluster_sector_num + | |
2361 | nb_sectors, c); | |
2362 | } | |
2363 | } | |
2364 | ||
7327145f | 2365 | static int bdrv_get_cluster_size(BlockDriverState *bs) |
793ed47a KW |
2366 | { |
2367 | BlockDriverInfo bdi; | |
7327145f | 2368 | int ret; |
793ed47a | 2369 | |
7327145f KW |
2370 | ret = bdrv_get_info(bs, &bdi); |
2371 | if (ret < 0 || bdi.cluster_size == 0) { | |
2372 | return bs->request_alignment; | |
793ed47a | 2373 | } else { |
7327145f | 2374 | return bdi.cluster_size; |
793ed47a KW |
2375 | } |
2376 | } | |
2377 | ||
f4658285 | 2378 | static bool tracked_request_overlaps(BdrvTrackedRequest *req, |
793ed47a KW |
2379 | int64_t offset, unsigned int bytes) |
2380 | { | |
d83947ac | 2381 | /* aaaa bbbb */ |
7327145f | 2382 | if (offset >= req->overlap_offset + req->overlap_bytes) { |
d83947ac SH |
2383 | return false; |
2384 | } | |
2385 | /* bbbb aaaa */ | |
7327145f | 2386 | if (req->overlap_offset >= offset + bytes) { |
d83947ac SH |
2387 | return false; |
2388 | } | |
2389 | return true; | |
f4658285 SH |
2390 | } |
2391 | ||
28de2dcd | 2392 | static bool coroutine_fn wait_serialising_requests(BdrvTrackedRequest *self) |
f4658285 | 2393 | { |
2dbafdc0 | 2394 | BlockDriverState *bs = self->bs; |
f4658285 SH |
2395 | BdrvTrackedRequest *req; |
2396 | bool retry; | |
28de2dcd | 2397 | bool waited = false; |
f4658285 | 2398 | |
2dbafdc0 | 2399 | if (!bs->serialising_in_flight) { |
28de2dcd | 2400 | return false; |
2dbafdc0 KW |
2401 | } |
2402 | ||
f4658285 SH |
2403 | do { |
2404 | retry = false; | |
2405 | QLIST_FOREACH(req, &bs->tracked_requests, list) { | |
2dbafdc0 | 2406 | if (req == self || (!req->serialising && !self->serialising)) { |
65afd211 KW |
2407 | continue; |
2408 | } | |
7327145f KW |
2409 | if (tracked_request_overlaps(req, self->overlap_offset, |
2410 | self->overlap_bytes)) | |
2411 | { | |
5f8b6491 SH |
2412 | /* Hitting this means there was a reentrant request, for |
2413 | * example, a block driver issuing nested requests. This must | |
2414 | * never happen since it means deadlock. | |
2415 | */ | |
2416 | assert(qemu_coroutine_self() != req->co); | |
2417 | ||
6460440f KW |
2418 | /* If the request is already (indirectly) waiting for us, or |
2419 | * will wait for us as soon as it wakes up, then just go on | |
2420 | * (instead of producing a deadlock in the former case). */ | |
2421 | if (!req->waiting_for) { | |
2422 | self->waiting_for = req; | |
2423 | qemu_co_queue_wait(&req->wait_queue); | |
2424 | self->waiting_for = NULL; | |
2425 | retry = true; | |
28de2dcd | 2426 | waited = true; |
6460440f KW |
2427 | break; |
2428 | } | |
f4658285 SH |
2429 | } |
2430 | } | |
2431 | } while (retry); | |
28de2dcd KW |
2432 | |
2433 | return waited; | |
f4658285 SH |
2434 | } |
2435 | ||
756e6736 KW |
2436 | /* |
2437 | * Return values: | |
2438 | * 0 - success | |
2439 | * -EINVAL - backing format specified, but no file | |
2440 | * -ENOSPC - can't update the backing file because no space is left in the | |
2441 | * image file header | |
2442 | * -ENOTSUP - format driver doesn't support changing the backing file | |
2443 | */ | |
2444 | int bdrv_change_backing_file(BlockDriverState *bs, | |
2445 | const char *backing_file, const char *backing_fmt) | |
2446 | { | |
2447 | BlockDriver *drv = bs->drv; | |
469ef350 | 2448 | int ret; |
756e6736 | 2449 | |
5f377794 PB |
2450 | /* Backing file format doesn't make sense without a backing file */ |
2451 | if (backing_fmt && !backing_file) { | |
2452 | return -EINVAL; | |
2453 | } | |
2454 | ||
756e6736 | 2455 | if (drv->bdrv_change_backing_file != NULL) { |
469ef350 | 2456 | ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt); |
756e6736 | 2457 | } else { |
469ef350 | 2458 | ret = -ENOTSUP; |
756e6736 | 2459 | } |
469ef350 PB |
2460 | |
2461 | if (ret == 0) { | |
2462 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: ""); | |
2463 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: ""); | |
2464 | } | |
2465 | return ret; | |
756e6736 KW |
2466 | } |
2467 | ||
6ebdcee2 JC |
2468 | /* |
2469 | * Finds the image layer in the chain that has 'bs' as its backing file. | |
2470 | * | |
2471 | * active is the current topmost image. | |
2472 | * | |
2473 | * Returns NULL if bs is not found in active's image chain, | |
2474 | * or if active == bs. | |
4caf0fcd JC |
2475 | * |
2476 | * Returns the bottommost base image if bs == NULL. | |
6ebdcee2 JC |
2477 | */ |
2478 | BlockDriverState *bdrv_find_overlay(BlockDriverState *active, | |
2479 | BlockDriverState *bs) | |
2480 | { | |
4caf0fcd JC |
2481 | while (active && bs != active->backing_hd) { |
2482 | active = active->backing_hd; | |
6ebdcee2 JC |
2483 | } |
2484 | ||
4caf0fcd JC |
2485 | return active; |
2486 | } | |
6ebdcee2 | 2487 | |
4caf0fcd JC |
2488 | /* Given a BDS, searches for the base layer. */ |
2489 | BlockDriverState *bdrv_find_base(BlockDriverState *bs) | |
2490 | { | |
2491 | return bdrv_find_overlay(bs, NULL); | |
6ebdcee2 JC |
2492 | } |
2493 | ||
2494 | typedef struct BlkIntermediateStates { | |
2495 | BlockDriverState *bs; | |
2496 | QSIMPLEQ_ENTRY(BlkIntermediateStates) entry; | |
2497 | } BlkIntermediateStates; | |
2498 | ||
2499 | ||
2500 | /* | |
2501 | * Drops images above 'base' up to and including 'top', and sets the image | |
2502 | * above 'top' to have base as its backing file. | |
2503 | * | |
2504 | * Requires that the overlay to 'top' is opened r/w, so that the backing file | |
2505 | * information in 'bs' can be properly updated. | |
2506 | * | |
2507 | * E.g., this will convert the following chain: | |
2508 | * bottom <- base <- intermediate <- top <- active | |
2509 | * | |
2510 | * to | |
2511 | * | |
2512 | * bottom <- base <- active | |
2513 | * | |
2514 | * It is allowed for bottom==base, in which case it converts: | |
2515 | * | |
2516 | * base <- intermediate <- top <- active | |
2517 | * | |
2518 | * to | |
2519 | * | |
2520 | * base <- active | |
2521 | * | |
54e26900 JC |
2522 | * If backing_file_str is non-NULL, it will be used when modifying top's |
2523 | * overlay image metadata. | |
2524 | * | |
6ebdcee2 JC |
2525 | * Error conditions: |
2526 | * if active == top, that is considered an error | |
2527 | * | |
2528 | */ | |
2529 | int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top, | |
54e26900 | 2530 | BlockDriverState *base, const char *backing_file_str) |
6ebdcee2 JC |
2531 | { |
2532 | BlockDriverState *intermediate; | |
2533 | BlockDriverState *base_bs = NULL; | |
2534 | BlockDriverState *new_top_bs = NULL; | |
2535 | BlkIntermediateStates *intermediate_state, *next; | |
2536 | int ret = -EIO; | |
2537 | ||
2538 | QSIMPLEQ_HEAD(states_to_delete, BlkIntermediateStates) states_to_delete; | |
2539 | QSIMPLEQ_INIT(&states_to_delete); | |
2540 | ||
2541 | if (!top->drv || !base->drv) { | |
2542 | goto exit; | |
2543 | } | |
2544 | ||
2545 | new_top_bs = bdrv_find_overlay(active, top); | |
2546 | ||
2547 | if (new_top_bs == NULL) { | |
2548 | /* we could not find the image above 'top', this is an error */ | |
2549 | goto exit; | |
2550 | } | |
2551 | ||
2552 | /* special case of new_top_bs->backing_hd already pointing to base - nothing | |
2553 | * to do, no intermediate images */ | |
2554 | if (new_top_bs->backing_hd == base) { | |
2555 | ret = 0; | |
2556 | goto exit; | |
2557 | } | |
2558 | ||
2559 | intermediate = top; | |
2560 | ||
2561 | /* now we will go down through the list, and add each BDS we find | |
2562 | * into our deletion queue, until we hit the 'base' | |
2563 | */ | |
2564 | while (intermediate) { | |
5839e53b | 2565 | intermediate_state = g_new0(BlkIntermediateStates, 1); |
6ebdcee2 JC |
2566 | intermediate_state->bs = intermediate; |
2567 | QSIMPLEQ_INSERT_TAIL(&states_to_delete, intermediate_state, entry); | |
2568 | ||
2569 | if (intermediate->backing_hd == base) { | |
2570 | base_bs = intermediate->backing_hd; | |
2571 | break; | |
2572 | } | |
2573 | intermediate = intermediate->backing_hd; | |
2574 | } | |
2575 | if (base_bs == NULL) { | |
2576 | /* something went wrong, we did not end at the base. safely | |
2577 | * unravel everything, and exit with error */ | |
2578 | goto exit; | |
2579 | } | |
2580 | ||
2581 | /* success - we can delete the intermediate states, and link top->base */ | |
54e26900 JC |
2582 | backing_file_str = backing_file_str ? backing_file_str : base_bs->filename; |
2583 | ret = bdrv_change_backing_file(new_top_bs, backing_file_str, | |
6ebdcee2 JC |
2584 | base_bs->drv ? base_bs->drv->format_name : ""); |
2585 | if (ret) { | |
2586 | goto exit; | |
2587 | } | |
920beae1 | 2588 | bdrv_set_backing_hd(new_top_bs, base_bs); |
6ebdcee2 JC |
2589 | |
2590 | QSIMPLEQ_FOREACH_SAFE(intermediate_state, &states_to_delete, entry, next) { | |
2591 | /* so that bdrv_close() does not recursively close the chain */ | |
920beae1 | 2592 | bdrv_set_backing_hd(intermediate_state->bs, NULL); |
4f6fd349 | 2593 | bdrv_unref(intermediate_state->bs); |
6ebdcee2 JC |
2594 | } |
2595 | ret = 0; | |
2596 | ||
2597 | exit: | |
2598 | QSIMPLEQ_FOREACH_SAFE(intermediate_state, &states_to_delete, entry, next) { | |
2599 | g_free(intermediate_state); | |
2600 | } | |
2601 | return ret; | |
2602 | } | |
2603 | ||
2604 | ||
71d0770c AL |
2605 | static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset, |
2606 | size_t size) | |
2607 | { | |
2608 | int64_t len; | |
2609 | ||
1dd3a447 KW |
2610 | if (size > INT_MAX) { |
2611 | return -EIO; | |
2612 | } | |
2613 | ||
71d0770c AL |
2614 | if (!bdrv_is_inserted(bs)) |
2615 | return -ENOMEDIUM; | |
2616 | ||
2617 | if (bs->growable) | |
2618 | return 0; | |
2619 | ||
2620 | len = bdrv_getlength(bs); | |
2621 | ||
fbb7b4e0 KW |
2622 | if (offset < 0) |
2623 | return -EIO; | |
2624 | ||
2625 | if ((offset > len) || (len - offset < size)) | |
71d0770c AL |
2626 | return -EIO; |
2627 | ||
2628 | return 0; | |
2629 | } | |
2630 | ||
2631 | static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num, | |
2632 | int nb_sectors) | |
2633 | { | |
54db38a4 | 2634 | if (nb_sectors < 0 || nb_sectors > INT_MAX / BDRV_SECTOR_SIZE) { |
8f4754ed KW |
2635 | return -EIO; |
2636 | } | |
2637 | ||
eb5a3165 JS |
2638 | return bdrv_check_byte_request(bs, sector_num * BDRV_SECTOR_SIZE, |
2639 | nb_sectors * BDRV_SECTOR_SIZE); | |
71d0770c AL |
2640 | } |
2641 | ||
1c9805a3 SH |
2642 | typedef struct RwCo { |
2643 | BlockDriverState *bs; | |
775aa8b6 | 2644 | int64_t offset; |
1c9805a3 SH |
2645 | QEMUIOVector *qiov; |
2646 | bool is_write; | |
2647 | int ret; | |
4105eaaa | 2648 | BdrvRequestFlags flags; |
1c9805a3 SH |
2649 | } RwCo; |
2650 | ||
2651 | static void coroutine_fn bdrv_rw_co_entry(void *opaque) | |
fc01f7e7 | 2652 | { |
1c9805a3 | 2653 | RwCo *rwco = opaque; |
ea2384d3 | 2654 | |
1c9805a3 | 2655 | if (!rwco->is_write) { |
775aa8b6 KW |
2656 | rwco->ret = bdrv_co_do_preadv(rwco->bs, rwco->offset, |
2657 | rwco->qiov->size, rwco->qiov, | |
4105eaaa | 2658 | rwco->flags); |
775aa8b6 KW |
2659 | } else { |
2660 | rwco->ret = bdrv_co_do_pwritev(rwco->bs, rwco->offset, | |
2661 | rwco->qiov->size, rwco->qiov, | |
2662 | rwco->flags); | |
1c9805a3 SH |
2663 | } |
2664 | } | |
e7a8a783 | 2665 | |
1c9805a3 | 2666 | /* |
8d3b1a2d | 2667 | * Process a vectored synchronous request using coroutines |
1c9805a3 | 2668 | */ |
775aa8b6 KW |
2669 | static int bdrv_prwv_co(BlockDriverState *bs, int64_t offset, |
2670 | QEMUIOVector *qiov, bool is_write, | |
2671 | BdrvRequestFlags flags) | |
1c9805a3 | 2672 | { |
1c9805a3 SH |
2673 | Coroutine *co; |
2674 | RwCo rwco = { | |
2675 | .bs = bs, | |
775aa8b6 | 2676 | .offset = offset, |
8d3b1a2d | 2677 | .qiov = qiov, |
1c9805a3 SH |
2678 | .is_write = is_write, |
2679 | .ret = NOT_DONE, | |
4105eaaa | 2680 | .flags = flags, |
1c9805a3 | 2681 | }; |
e7a8a783 | 2682 | |
498e386c ZYW |
2683 | /** |
2684 | * In sync call context, when the vcpu is blocked, this throttling timer | |
2685 | * will not fire; so the I/O throttling function has to be disabled here | |
2686 | * if it has been enabled. | |
2687 | */ | |
2688 | if (bs->io_limits_enabled) { | |
2689 | fprintf(stderr, "Disabling I/O throttling on '%s' due " | |
2690 | "to synchronous I/O.\n", bdrv_get_device_name(bs)); | |
2691 | bdrv_io_limits_disable(bs); | |
2692 | } | |
2693 | ||
1c9805a3 SH |
2694 | if (qemu_in_coroutine()) { |
2695 | /* Fast-path if already in coroutine context */ | |
2696 | bdrv_rw_co_entry(&rwco); | |
2697 | } else { | |
2572b37a SH |
2698 | AioContext *aio_context = bdrv_get_aio_context(bs); |
2699 | ||
1c9805a3 SH |
2700 | co = qemu_coroutine_create(bdrv_rw_co_entry); |
2701 | qemu_coroutine_enter(co, &rwco); | |
2702 | while (rwco.ret == NOT_DONE) { | |
2572b37a | 2703 | aio_poll(aio_context, true); |
1c9805a3 SH |
2704 | } |
2705 | } | |
2706 | return rwco.ret; | |
2707 | } | |
b338082b | 2708 | |
8d3b1a2d KW |
2709 | /* |
2710 | * Process a synchronous request using coroutines | |
2711 | */ | |
2712 | static int bdrv_rw_co(BlockDriverState *bs, int64_t sector_num, uint8_t *buf, | |
4105eaaa | 2713 | int nb_sectors, bool is_write, BdrvRequestFlags flags) |
8d3b1a2d KW |
2714 | { |
2715 | QEMUIOVector qiov; | |
2716 | struct iovec iov = { | |
2717 | .iov_base = (void *)buf, | |
2718 | .iov_len = nb_sectors * BDRV_SECTOR_SIZE, | |
2719 | }; | |
2720 | ||
da15ee51 KW |
2721 | if (nb_sectors < 0 || nb_sectors > INT_MAX / BDRV_SECTOR_SIZE) { |
2722 | return -EINVAL; | |
2723 | } | |
2724 | ||
8d3b1a2d | 2725 | qemu_iovec_init_external(&qiov, &iov, 1); |
775aa8b6 KW |
2726 | return bdrv_prwv_co(bs, sector_num << BDRV_SECTOR_BITS, |
2727 | &qiov, is_write, flags); | |
8d3b1a2d KW |
2728 | } |
2729 | ||
1c9805a3 SH |
2730 | /* return < 0 if error. See bdrv_write() for the return codes */ |
2731 | int bdrv_read(BlockDriverState *bs, int64_t sector_num, | |
2732 | uint8_t *buf, int nb_sectors) | |
2733 | { | |
4105eaaa | 2734 | return bdrv_rw_co(bs, sector_num, buf, nb_sectors, false, 0); |
fc01f7e7 FB |
2735 | } |
2736 | ||
07d27a44 MA |
2737 | /* Just like bdrv_read(), but with I/O throttling temporarily disabled */ |
2738 | int bdrv_read_unthrottled(BlockDriverState *bs, int64_t sector_num, | |
2739 | uint8_t *buf, int nb_sectors) | |
2740 | { | |
2741 | bool enabled; | |
2742 | int ret; | |
2743 | ||
2744 | enabled = bs->io_limits_enabled; | |
2745 | bs->io_limits_enabled = false; | |
4e7395e8 | 2746 | ret = bdrv_read(bs, sector_num, buf, nb_sectors); |
07d27a44 MA |
2747 | bs->io_limits_enabled = enabled; |
2748 | return ret; | |
2749 | } | |
2750 | ||
5fafdf24 | 2751 | /* Return < 0 if error. Important errors are: |
19cb3738 FB |
2752 | -EIO generic I/O error (may happen for all errors) |
2753 | -ENOMEDIUM No media inserted. | |
2754 | -EINVAL Invalid sector number or nb_sectors | |
2755 | -EACCES Trying to write a read-only device | |
2756 | */ | |
5fafdf24 | 2757 | int bdrv_write(BlockDriverState *bs, int64_t sector_num, |
fc01f7e7 FB |
2758 | const uint8_t *buf, int nb_sectors) |
2759 | { | |
4105eaaa | 2760 | return bdrv_rw_co(bs, sector_num, (uint8_t *)buf, nb_sectors, true, 0); |
83f64091 FB |
2761 | } |
2762 | ||
aa7bfbff PL |
2763 | int bdrv_write_zeroes(BlockDriverState *bs, int64_t sector_num, |
2764 | int nb_sectors, BdrvRequestFlags flags) | |
4105eaaa PL |
2765 | { |
2766 | return bdrv_rw_co(bs, sector_num, NULL, nb_sectors, true, | |
aa7bfbff | 2767 | BDRV_REQ_ZERO_WRITE | flags); |
8d3b1a2d KW |
2768 | } |
2769 | ||
d75cbb5e PL |
2770 | /* |
2771 | * Completely zero out a block device with the help of bdrv_write_zeroes. | |
2772 | * The operation is sped up by checking the block status and only writing | |
2773 | * zeroes to the device if they currently do not return zeroes. Optional | |
2774 | * flags are passed through to bdrv_write_zeroes (e.g. BDRV_REQ_MAY_UNMAP). | |
2775 | * | |
2776 | * Returns < 0 on error, 0 on success. For error codes see bdrv_write(). | |
2777 | */ | |
2778 | int bdrv_make_zero(BlockDriverState *bs, BdrvRequestFlags flags) | |
2779 | { | |
d32f7c10 | 2780 | int64_t target_sectors, ret, nb_sectors, sector_num = 0; |
d75cbb5e PL |
2781 | int n; |
2782 | ||
d32f7c10 MA |
2783 | target_sectors = bdrv_nb_sectors(bs); |
2784 | if (target_sectors < 0) { | |
2785 | return target_sectors; | |
9ce10c0b | 2786 | } |
9ce10c0b | 2787 | |
d75cbb5e | 2788 | for (;;) { |
d32f7c10 | 2789 | nb_sectors = target_sectors - sector_num; |
d75cbb5e PL |
2790 | if (nb_sectors <= 0) { |
2791 | return 0; | |
2792 | } | |
2793 | if (nb_sectors > INT_MAX) { | |
2794 | nb_sectors = INT_MAX; | |
2795 | } | |
2796 | ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &n); | |
3d94ce60 PL |
2797 | if (ret < 0) { |
2798 | error_report("error getting block status at sector %" PRId64 ": %s", | |
2799 | sector_num, strerror(-ret)); | |
2800 | return ret; | |
2801 | } | |
d75cbb5e PL |
2802 | if (ret & BDRV_BLOCK_ZERO) { |
2803 | sector_num += n; | |
2804 | continue; | |
2805 | } | |
2806 | ret = bdrv_write_zeroes(bs, sector_num, n, flags); | |
2807 | if (ret < 0) { | |
2808 | error_report("error writing zeroes at sector %" PRId64 ": %s", | |
2809 | sector_num, strerror(-ret)); | |
2810 | return ret; | |
2811 | } | |
2812 | sector_num += n; | |
2813 | } | |
2814 | } | |
2815 | ||
a3ef6571 | 2816 | int bdrv_pread(BlockDriverState *bs, int64_t offset, void *buf, int bytes) |
83f64091 | 2817 | { |
a3ef6571 KW |
2818 | QEMUIOVector qiov; |
2819 | struct iovec iov = { | |
2820 | .iov_base = (void *)buf, | |
2821 | .iov_len = bytes, | |
2822 | }; | |
9a8c4cce | 2823 | int ret; |
83f64091 | 2824 | |
a3ef6571 KW |
2825 | if (bytes < 0) { |
2826 | return -EINVAL; | |
83f64091 FB |
2827 | } |
2828 | ||
a3ef6571 KW |
2829 | qemu_iovec_init_external(&qiov, &iov, 1); |
2830 | ret = bdrv_prwv_co(bs, offset, &qiov, false, 0); | |
2831 | if (ret < 0) { | |
2832 | return ret; | |
83f64091 | 2833 | } |
a3ef6571 KW |
2834 | |
2835 | return bytes; | |
83f64091 FB |
2836 | } |
2837 | ||
8d3b1a2d | 2838 | int bdrv_pwritev(BlockDriverState *bs, int64_t offset, QEMUIOVector *qiov) |
83f64091 | 2839 | { |
9a8c4cce | 2840 | int ret; |
83f64091 | 2841 | |
8407d5d7 KW |
2842 | ret = bdrv_prwv_co(bs, offset, qiov, true, 0); |
2843 | if (ret < 0) { | |
2844 | return ret; | |
83f64091 FB |
2845 | } |
2846 | ||
8d3b1a2d KW |
2847 | return qiov->size; |
2848 | } | |
2849 | ||
2850 | int bdrv_pwrite(BlockDriverState *bs, int64_t offset, | |
8407d5d7 | 2851 | const void *buf, int bytes) |
8d3b1a2d KW |
2852 | { |
2853 | QEMUIOVector qiov; | |
2854 | struct iovec iov = { | |
2855 | .iov_base = (void *) buf, | |
8407d5d7 | 2856 | .iov_len = bytes, |
8d3b1a2d KW |
2857 | }; |
2858 | ||
8407d5d7 KW |
2859 | if (bytes < 0) { |
2860 | return -EINVAL; | |
2861 | } | |
2862 | ||
8d3b1a2d KW |
2863 | qemu_iovec_init_external(&qiov, &iov, 1); |
2864 | return bdrv_pwritev(bs, offset, &qiov); | |
83f64091 | 2865 | } |
83f64091 | 2866 | |
f08145fe KW |
2867 | /* |
2868 | * Writes to the file and ensures that no writes are reordered across this | |
2869 | * request (acts as a barrier) | |
2870 | * | |
2871 | * Returns 0 on success, -errno in error cases. | |
2872 | */ | |
2873 | int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset, | |
2874 | const void *buf, int count) | |
2875 | { | |
2876 | int ret; | |
2877 | ||
2878 | ret = bdrv_pwrite(bs, offset, buf, count); | |
2879 | if (ret < 0) { | |
2880 | return ret; | |
2881 | } | |
2882 | ||
f05fa4ad PB |
2883 | /* No flush needed for cache modes that already do it */ |
2884 | if (bs->enable_write_cache) { | |
f08145fe KW |
2885 | bdrv_flush(bs); |
2886 | } | |
2887 | ||
2888 | return 0; | |
2889 | } | |
2890 | ||
470c0504 | 2891 | static int coroutine_fn bdrv_co_do_copy_on_readv(BlockDriverState *bs, |
ab185921 SH |
2892 | int64_t sector_num, int nb_sectors, QEMUIOVector *qiov) |
2893 | { | |
2894 | /* Perform I/O through a temporary buffer so that users who scribble over | |
2895 | * their read buffer while the operation is in progress do not end up | |
2896 | * modifying the image file. This is critical for zero-copy guest I/O | |
2897 | * where anything might happen inside guest memory. | |
2898 | */ | |
2899 | void *bounce_buffer; | |
2900 | ||
79c053bd | 2901 | BlockDriver *drv = bs->drv; |
ab185921 SH |
2902 | struct iovec iov; |
2903 | QEMUIOVector bounce_qiov; | |
2904 | int64_t cluster_sector_num; | |
2905 | int cluster_nb_sectors; | |
2906 | size_t skip_bytes; | |
2907 | int ret; | |
2908 | ||
2909 | /* Cover entire cluster so no additional backing file I/O is required when | |
2910 | * allocating cluster in the image file. | |
2911 | */ | |
343bded4 PB |
2912 | bdrv_round_to_clusters(bs, sector_num, nb_sectors, |
2913 | &cluster_sector_num, &cluster_nb_sectors); | |
ab185921 | 2914 | |
470c0504 SH |
2915 | trace_bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors, |
2916 | cluster_sector_num, cluster_nb_sectors); | |
ab185921 SH |
2917 | |
2918 | iov.iov_len = cluster_nb_sectors * BDRV_SECTOR_SIZE; | |
857d4f46 KW |
2919 | iov.iov_base = bounce_buffer = qemu_try_blockalign(bs, iov.iov_len); |
2920 | if (bounce_buffer == NULL) { | |
2921 | ret = -ENOMEM; | |
2922 | goto err; | |
2923 | } | |
2924 | ||
ab185921 SH |
2925 | qemu_iovec_init_external(&bounce_qiov, &iov, 1); |
2926 | ||
79c053bd SH |
2927 | ret = drv->bdrv_co_readv(bs, cluster_sector_num, cluster_nb_sectors, |
2928 | &bounce_qiov); | |
ab185921 SH |
2929 | if (ret < 0) { |
2930 | goto err; | |
2931 | } | |
2932 | ||
79c053bd SH |
2933 | if (drv->bdrv_co_write_zeroes && |
2934 | buffer_is_zero(bounce_buffer, iov.iov_len)) { | |
621f0589 | 2935 | ret = bdrv_co_do_write_zeroes(bs, cluster_sector_num, |
aa7bfbff | 2936 | cluster_nb_sectors, 0); |
79c053bd | 2937 | } else { |
f05fa4ad PB |
2938 | /* This does not change the data on the disk, it is not necessary |
2939 | * to flush even in cache=writethrough mode. | |
2940 | */ | |
79c053bd | 2941 | ret = drv->bdrv_co_writev(bs, cluster_sector_num, cluster_nb_sectors, |
ab185921 | 2942 | &bounce_qiov); |
79c053bd SH |
2943 | } |
2944 | ||
ab185921 SH |
2945 | if (ret < 0) { |
2946 | /* It might be okay to ignore write errors for guest requests. If this | |
2947 | * is a deliberate copy-on-read then we don't want to ignore the error. | |
2948 | * Simply report it in all cases. | |
2949 | */ | |
2950 | goto err; | |
2951 | } | |
2952 | ||
2953 | skip_bytes = (sector_num - cluster_sector_num) * BDRV_SECTOR_SIZE; | |
03396148 MT |
2954 | qemu_iovec_from_buf(qiov, 0, bounce_buffer + skip_bytes, |
2955 | nb_sectors * BDRV_SECTOR_SIZE); | |
ab185921 SH |
2956 | |
2957 | err: | |
2958 | qemu_vfree(bounce_buffer); | |
2959 | return ret; | |
2960 | } | |
2961 | ||
c5fbe571 | 2962 | /* |
d0c7f642 KW |
2963 | * Forwards an already correctly aligned request to the BlockDriver. This |
2964 | * handles copy on read and zeroing after EOF; any other features must be | |
2965 | * implemented by the caller. | |
c5fbe571 | 2966 | */ |
d0c7f642 | 2967 | static int coroutine_fn bdrv_aligned_preadv(BlockDriverState *bs, |
65afd211 | 2968 | BdrvTrackedRequest *req, int64_t offset, unsigned int bytes, |
ec746e10 | 2969 | int64_t align, QEMUIOVector *qiov, int flags) |
da1fa91d KW |
2970 | { |
2971 | BlockDriver *drv = bs->drv; | |
dbffbdcf | 2972 | int ret; |
da1fa91d | 2973 | |
d0c7f642 KW |
2974 | int64_t sector_num = offset >> BDRV_SECTOR_BITS; |
2975 | unsigned int nb_sectors = bytes >> BDRV_SECTOR_BITS; | |
da1fa91d | 2976 | |
d0c7f642 KW |
2977 | assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0); |
2978 | assert((bytes & (BDRV_SECTOR_SIZE - 1)) == 0); | |
8eb029c2 | 2979 | assert(!qiov || bytes == qiov->size); |
d0c7f642 KW |
2980 | |
2981 | /* Handle Copy on Read and associated serialisation */ | |
470c0504 | 2982 | if (flags & BDRV_REQ_COPY_ON_READ) { |
7327145f KW |
2983 | /* If we touch the same cluster it counts as an overlap. This |
2984 | * guarantees that allocating writes will be serialized and not race | |
2985 | * with each other for the same cluster. For example, in copy-on-read | |
2986 | * it ensures that the CoR read and write operations are atomic and | |
2987 | * guest writes cannot interleave between them. */ | |
2988 | mark_request_serialising(req, bdrv_get_cluster_size(bs)); | |
470c0504 SH |
2989 | } |
2990 | ||
2dbafdc0 | 2991 | wait_serialising_requests(req); |
f4658285 | 2992 | |
470c0504 | 2993 | if (flags & BDRV_REQ_COPY_ON_READ) { |
ab185921 SH |
2994 | int pnum; |
2995 | ||
bdad13b9 | 2996 | ret = bdrv_is_allocated(bs, sector_num, nb_sectors, &pnum); |
ab185921 SH |
2997 | if (ret < 0) { |
2998 | goto out; | |
2999 | } | |
3000 | ||
3001 | if (!ret || pnum != nb_sectors) { | |
470c0504 | 3002 | ret = bdrv_co_do_copy_on_readv(bs, sector_num, nb_sectors, qiov); |
ab185921 SH |
3003 | goto out; |
3004 | } | |
3005 | } | |
3006 | ||
d0c7f642 | 3007 | /* Forward the request to the BlockDriver */ |
893a8f62 MK |
3008 | if (!(bs->zero_beyond_eof && bs->growable)) { |
3009 | ret = drv->bdrv_co_readv(bs, sector_num, nb_sectors, qiov); | |
3010 | } else { | |
3011 | /* Read zeros after EOF of growable BDSes */ | |
4049082c | 3012 | int64_t total_sectors, max_nb_sectors; |
893a8f62 | 3013 | |
4049082c MA |
3014 | total_sectors = bdrv_nb_sectors(bs); |
3015 | if (total_sectors < 0) { | |
3016 | ret = total_sectors; | |
893a8f62 MK |
3017 | goto out; |
3018 | } | |
3019 | ||
5f5bcd80 KW |
3020 | max_nb_sectors = ROUND_UP(MAX(0, total_sectors - sector_num), |
3021 | align >> BDRV_SECTOR_BITS); | |
893a8f62 | 3022 | if (max_nb_sectors > 0) { |
33f461e0 KW |
3023 | QEMUIOVector local_qiov; |
3024 | size_t local_sectors; | |
3025 | ||
3026 | max_nb_sectors = MIN(max_nb_sectors, SIZE_MAX / BDRV_SECTOR_BITS); | |
3027 | local_sectors = MIN(max_nb_sectors, nb_sectors); | |
3028 | ||
3029 | qemu_iovec_init(&local_qiov, qiov->niov); | |
3030 | qemu_iovec_concat(&local_qiov, qiov, 0, | |
3031 | local_sectors * BDRV_SECTOR_SIZE); | |
3032 | ||
3033 | ret = drv->bdrv_co_readv(bs, sector_num, local_sectors, | |
3034 | &local_qiov); | |
3035 | ||
3036 | qemu_iovec_destroy(&local_qiov); | |
893a8f62 MK |
3037 | } else { |
3038 | ret = 0; | |
3039 | } | |
3040 | ||
3041 | /* Reading beyond end of file is supposed to produce zeroes */ | |
3042 | if (ret == 0 && total_sectors < sector_num + nb_sectors) { | |
3043 | uint64_t offset = MAX(0, total_sectors - sector_num); | |
3044 | uint64_t bytes = (sector_num + nb_sectors - offset) * | |
3045 | BDRV_SECTOR_SIZE; | |
3046 | qemu_iovec_memset(qiov, offset * BDRV_SECTOR_SIZE, 0, bytes); | |
3047 | } | |
3048 | } | |
ab185921 SH |
3049 | |
3050 | out: | |
dbffbdcf | 3051 | return ret; |
da1fa91d KW |
3052 | } |
3053 | ||
d0c7f642 KW |
3054 | /* |
3055 | * Handle a read request in coroutine context | |
3056 | */ | |
1b0288ae KW |
3057 | static int coroutine_fn bdrv_co_do_preadv(BlockDriverState *bs, |
3058 | int64_t offset, unsigned int bytes, QEMUIOVector *qiov, | |
d0c7f642 KW |
3059 | BdrvRequestFlags flags) |
3060 | { | |
3061 | BlockDriver *drv = bs->drv; | |
65afd211 KW |
3062 | BdrvTrackedRequest req; |
3063 | ||
1b0288ae KW |
3064 | /* TODO Lift BDRV_SECTOR_SIZE restriction in BlockDriver interface */ |
3065 | uint64_t align = MAX(BDRV_SECTOR_SIZE, bs->request_alignment); | |
3066 | uint8_t *head_buf = NULL; | |
3067 | uint8_t *tail_buf = NULL; | |
3068 | QEMUIOVector local_qiov; | |
3069 | bool use_local_qiov = false; | |
d0c7f642 KW |
3070 | int ret; |
3071 | ||
3072 | if (!drv) { | |
3073 | return -ENOMEDIUM; | |
3074 | } | |
1b0288ae | 3075 | if (bdrv_check_byte_request(bs, offset, bytes)) { |
d0c7f642 KW |
3076 | return -EIO; |
3077 | } | |
3078 | ||
3079 | if (bs->copy_on_read) { | |
3080 | flags |= BDRV_REQ_COPY_ON_READ; | |
3081 | } | |
3082 | ||
3083 | /* throttling disk I/O */ | |
3084 | if (bs->io_limits_enabled) { | |
d5103588 | 3085 | bdrv_io_limits_intercept(bs, bytes, false); |
1b0288ae KW |
3086 | } |
3087 | ||
3088 | /* Align read if necessary by padding qiov */ | |
3089 | if (offset & (align - 1)) { | |
3090 | head_buf = qemu_blockalign(bs, align); | |
3091 | qemu_iovec_init(&local_qiov, qiov->niov + 2); | |
3092 | qemu_iovec_add(&local_qiov, head_buf, offset & (align - 1)); | |
3093 | qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size); | |
3094 | use_local_qiov = true; | |
3095 | ||
3096 | bytes += offset & (align - 1); | |
3097 | offset = offset & ~(align - 1); | |
3098 | } | |
3099 | ||
3100 | if ((offset + bytes) & (align - 1)) { | |
3101 | if (!use_local_qiov) { | |
3102 | qemu_iovec_init(&local_qiov, qiov->niov + 1); | |
3103 | qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size); | |
3104 | use_local_qiov = true; | |
3105 | } | |
3106 | tail_buf = qemu_blockalign(bs, align); | |
3107 | qemu_iovec_add(&local_qiov, tail_buf, | |
3108 | align - ((offset + bytes) & (align - 1))); | |
3109 | ||
3110 | bytes = ROUND_UP(bytes, align); | |
3111 | } | |
3112 | ||
65afd211 | 3113 | tracked_request_begin(&req, bs, offset, bytes, false); |
ec746e10 | 3114 | ret = bdrv_aligned_preadv(bs, &req, offset, bytes, align, |
1b0288ae KW |
3115 | use_local_qiov ? &local_qiov : qiov, |
3116 | flags); | |
65afd211 | 3117 | tracked_request_end(&req); |
1b0288ae KW |
3118 | |
3119 | if (use_local_qiov) { | |
3120 | qemu_iovec_destroy(&local_qiov); | |
3121 | qemu_vfree(head_buf); | |
3122 | qemu_vfree(tail_buf); | |
d0c7f642 KW |
3123 | } |
3124 | ||
d0c7f642 KW |
3125 | return ret; |
3126 | } | |
3127 | ||
1b0288ae KW |
3128 | static int coroutine_fn bdrv_co_do_readv(BlockDriverState *bs, |
3129 | int64_t sector_num, int nb_sectors, QEMUIOVector *qiov, | |
3130 | BdrvRequestFlags flags) | |
3131 | { | |
3132 | if (nb_sectors < 0 || nb_sectors > (UINT_MAX >> BDRV_SECTOR_BITS)) { | |
3133 | return -EINVAL; | |
3134 | } | |
3135 | ||
3136 | return bdrv_co_do_preadv(bs, sector_num << BDRV_SECTOR_BITS, | |
3137 | nb_sectors << BDRV_SECTOR_BITS, qiov, flags); | |
3138 | } | |
3139 | ||
c5fbe571 | 3140 | int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num, |
da1fa91d KW |
3141 | int nb_sectors, QEMUIOVector *qiov) |
3142 | { | |
c5fbe571 | 3143 | trace_bdrv_co_readv(bs, sector_num, nb_sectors); |
da1fa91d | 3144 | |
470c0504 SH |
3145 | return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov, 0); |
3146 | } | |
3147 | ||
3148 | int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs, | |
3149 | int64_t sector_num, int nb_sectors, QEMUIOVector *qiov) | |
3150 | { | |
3151 | trace_bdrv_co_copy_on_readv(bs, sector_num, nb_sectors); | |
3152 | ||
3153 | return bdrv_co_do_readv(bs, sector_num, nb_sectors, qiov, | |
3154 | BDRV_REQ_COPY_ON_READ); | |
c5fbe571 SH |
3155 | } |
3156 | ||
c31cb707 PL |
3157 | /* if no limit is specified in the BlockLimits use a default |
3158 | * of 32768 512-byte sectors (16 MiB) per request. | |
3159 | */ | |
3160 | #define MAX_WRITE_ZEROES_DEFAULT 32768 | |
3161 | ||
f08f2dda | 3162 | static int coroutine_fn bdrv_co_do_write_zeroes(BlockDriverState *bs, |
aa7bfbff | 3163 | int64_t sector_num, int nb_sectors, BdrvRequestFlags flags) |
f08f2dda SH |
3164 | { |
3165 | BlockDriver *drv = bs->drv; | |
3166 | QEMUIOVector qiov; | |
c31cb707 PL |
3167 | struct iovec iov = {0}; |
3168 | int ret = 0; | |
f08f2dda | 3169 | |
c31cb707 PL |
3170 | int max_write_zeroes = bs->bl.max_write_zeroes ? |
3171 | bs->bl.max_write_zeroes : MAX_WRITE_ZEROES_DEFAULT; | |
621f0589 | 3172 | |
c31cb707 PL |
3173 | while (nb_sectors > 0 && !ret) { |
3174 | int num = nb_sectors; | |
3175 | ||
b8d71c09 PB |
3176 | /* Align request. Block drivers can expect the "bulk" of the request |
3177 | * to be aligned. | |
3178 | */ | |
3179 | if (bs->bl.write_zeroes_alignment | |
3180 | && num > bs->bl.write_zeroes_alignment) { | |
3181 | if (sector_num % bs->bl.write_zeroes_alignment != 0) { | |
3182 | /* Make a small request up to the first aligned sector. */ | |
c31cb707 | 3183 | num = bs->bl.write_zeroes_alignment; |
b8d71c09 PB |
3184 | num -= sector_num % bs->bl.write_zeroes_alignment; |
3185 | } else if ((sector_num + num) % bs->bl.write_zeroes_alignment != 0) { | |
3186 | /* Shorten the request to the last aligned sector. num cannot | |
3187 | * underflow because num > bs->bl.write_zeroes_alignment. | |
3188 | */ | |
3189 | num -= (sector_num + num) % bs->bl.write_zeroes_alignment; | |
c31cb707 | 3190 | } |
621f0589 | 3191 | } |
f08f2dda | 3192 | |
c31cb707 PL |
3193 | /* limit request size */ |
3194 | if (num > max_write_zeroes) { | |
3195 | num = max_write_zeroes; | |
3196 | } | |
3197 | ||
3198 | ret = -ENOTSUP; | |
3199 | /* First try the efficient write zeroes operation */ | |
3200 | if (drv->bdrv_co_write_zeroes) { | |
3201 | ret = drv->bdrv_co_write_zeroes(bs, sector_num, num, flags); | |
3202 | } | |
3203 | ||
3204 | if (ret == -ENOTSUP) { | |
3205 | /* Fall back to bounce buffer if write zeroes is unsupported */ | |
3206 | iov.iov_len = num * BDRV_SECTOR_SIZE; | |
3207 | if (iov.iov_base == NULL) { | |
857d4f46 KW |
3208 | iov.iov_base = qemu_try_blockalign(bs, num * BDRV_SECTOR_SIZE); |
3209 | if (iov.iov_base == NULL) { | |
3210 | ret = -ENOMEM; | |
3211 | goto fail; | |
3212 | } | |
b8d71c09 | 3213 | memset(iov.iov_base, 0, num * BDRV_SECTOR_SIZE); |
c31cb707 PL |
3214 | } |
3215 | qemu_iovec_init_external(&qiov, &iov, 1); | |
f08f2dda | 3216 | |
c31cb707 | 3217 | ret = drv->bdrv_co_writev(bs, sector_num, num, &qiov); |
b8d71c09 PB |
3218 | |
3219 | /* Keep bounce buffer around if it is big enough for all | |
3220 | * all future requests. | |
3221 | */ | |
3222 | if (num < max_write_zeroes) { | |
3223 | qemu_vfree(iov.iov_base); | |
3224 | iov.iov_base = NULL; | |
3225 | } | |
c31cb707 PL |
3226 | } |
3227 | ||
3228 | sector_num += num; | |
3229 | nb_sectors -= num; | |
3230 | } | |
f08f2dda | 3231 | |
857d4f46 | 3232 | fail: |
f08f2dda SH |
3233 | qemu_vfree(iov.iov_base); |
3234 | return ret; | |
3235 | } | |
3236 | ||
c5fbe571 | 3237 | /* |
b404f720 | 3238 | * Forwards an already correctly aligned write request to the BlockDriver. |
c5fbe571 | 3239 | */ |
b404f720 | 3240 | static int coroutine_fn bdrv_aligned_pwritev(BlockDriverState *bs, |
65afd211 KW |
3241 | BdrvTrackedRequest *req, int64_t offset, unsigned int bytes, |
3242 | QEMUIOVector *qiov, int flags) | |
c5fbe571 SH |
3243 | { |
3244 | BlockDriver *drv = bs->drv; | |
28de2dcd | 3245 | bool waited; |
6b7cb247 | 3246 | int ret; |
da1fa91d | 3247 | |
b404f720 KW |
3248 | int64_t sector_num = offset >> BDRV_SECTOR_BITS; |
3249 | unsigned int nb_sectors = bytes >> BDRV_SECTOR_BITS; | |
f4658285 | 3250 | |
b404f720 KW |
3251 | assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0); |
3252 | assert((bytes & (BDRV_SECTOR_SIZE - 1)) == 0); | |
8eb029c2 | 3253 | assert(!qiov || bytes == qiov->size); |
cc0681c4 | 3254 | |
28de2dcd KW |
3255 | waited = wait_serialising_requests(req); |
3256 | assert(!waited || !req->serialising); | |
af91f9a7 KW |
3257 | assert(req->overlap_offset <= offset); |
3258 | assert(offset + bytes <= req->overlap_offset + req->overlap_bytes); | |
244eadef | 3259 | |
65afd211 | 3260 | ret = notifier_with_return_list_notify(&bs->before_write_notifiers, req); |
d616b224 | 3261 | |
465bee1d PL |
3262 | if (!ret && bs->detect_zeroes != BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF && |
3263 | !(flags & BDRV_REQ_ZERO_WRITE) && drv->bdrv_co_write_zeroes && | |
3264 | qemu_iovec_is_zero(qiov)) { | |
3265 | flags |= BDRV_REQ_ZERO_WRITE; | |
3266 | if (bs->detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP) { | |
3267 | flags |= BDRV_REQ_MAY_UNMAP; | |
3268 | } | |
3269 | } | |
3270 | ||
d616b224 SH |
3271 | if (ret < 0) { |
3272 | /* Do nothing, write notifier decided to fail this request */ | |
3273 | } else if (flags & BDRV_REQ_ZERO_WRITE) { | |
9e1cb96d | 3274 | BLKDBG_EVENT(bs, BLKDBG_PWRITEV_ZERO); |
aa7bfbff | 3275 | ret = bdrv_co_do_write_zeroes(bs, sector_num, nb_sectors, flags); |
f08f2dda | 3276 | } else { |
9e1cb96d | 3277 | BLKDBG_EVENT(bs, BLKDBG_PWRITEV); |
f08f2dda SH |
3278 | ret = drv->bdrv_co_writev(bs, sector_num, nb_sectors, qiov); |
3279 | } | |
9e1cb96d | 3280 | BLKDBG_EVENT(bs, BLKDBG_PWRITEV_DONE); |
6b7cb247 | 3281 | |
f05fa4ad PB |
3282 | if (ret == 0 && !bs->enable_write_cache) { |
3283 | ret = bdrv_co_flush(bs); | |
3284 | } | |
3285 | ||
e4654d2d | 3286 | bdrv_set_dirty(bs, sector_num, nb_sectors); |
da1fa91d | 3287 | |
5366d0c8 | 3288 | block_acct_highest_sector(&bs->stats, sector_num, nb_sectors); |
5e5a94b6 | 3289 | |
df2a6f29 PB |
3290 | if (bs->growable && ret >= 0) { |
3291 | bs->total_sectors = MAX(bs->total_sectors, sector_num + nb_sectors); | |
3292 | } | |
da1fa91d | 3293 | |
6b7cb247 | 3294 | return ret; |
da1fa91d KW |
3295 | } |
3296 | ||
b404f720 KW |
3297 | /* |
3298 | * Handle a write request in coroutine context | |
3299 | */ | |
6601553e KW |
3300 | static int coroutine_fn bdrv_co_do_pwritev(BlockDriverState *bs, |
3301 | int64_t offset, unsigned int bytes, QEMUIOVector *qiov, | |
b404f720 KW |
3302 | BdrvRequestFlags flags) |
3303 | { | |
65afd211 | 3304 | BdrvTrackedRequest req; |
3b8242e0 KW |
3305 | /* TODO Lift BDRV_SECTOR_SIZE restriction in BlockDriver interface */ |
3306 | uint64_t align = MAX(BDRV_SECTOR_SIZE, bs->request_alignment); | |
3307 | uint8_t *head_buf = NULL; | |
3308 | uint8_t *tail_buf = NULL; | |
3309 | QEMUIOVector local_qiov; | |
3310 | bool use_local_qiov = false; | |
b404f720 KW |
3311 | int ret; |
3312 | ||
3313 | if (!bs->drv) { | |
3314 | return -ENOMEDIUM; | |
3315 | } | |
3316 | if (bs->read_only) { | |
3317 | return -EACCES; | |
3318 | } | |
6601553e | 3319 | if (bdrv_check_byte_request(bs, offset, bytes)) { |
b404f720 KW |
3320 | return -EIO; |
3321 | } | |
3322 | ||
b404f720 KW |
3323 | /* throttling disk I/O */ |
3324 | if (bs->io_limits_enabled) { | |
d5103588 | 3325 | bdrv_io_limits_intercept(bs, bytes, true); |
b404f720 KW |
3326 | } |
3327 | ||
3b8242e0 KW |
3328 | /* |
3329 | * Align write if necessary by performing a read-modify-write cycle. | |
3330 | * Pad qiov with the read parts and be sure to have a tracked request not | |
3331 | * only for bdrv_aligned_pwritev, but also for the reads of the RMW cycle. | |
3332 | */ | |
65afd211 | 3333 | tracked_request_begin(&req, bs, offset, bytes, true); |
3b8242e0 KW |
3334 | |
3335 | if (offset & (align - 1)) { | |
3336 | QEMUIOVector head_qiov; | |
3337 | struct iovec head_iov; | |
3338 | ||
3339 | mark_request_serialising(&req, align); | |
3340 | wait_serialising_requests(&req); | |
3341 | ||
3342 | head_buf = qemu_blockalign(bs, align); | |
3343 | head_iov = (struct iovec) { | |
3344 | .iov_base = head_buf, | |
3345 | .iov_len = align, | |
3346 | }; | |
3347 | qemu_iovec_init_external(&head_qiov, &head_iov, 1); | |
3348 | ||
9e1cb96d | 3349 | BLKDBG_EVENT(bs, BLKDBG_PWRITEV_RMW_HEAD); |
3b8242e0 KW |
3350 | ret = bdrv_aligned_preadv(bs, &req, offset & ~(align - 1), align, |
3351 | align, &head_qiov, 0); | |
3352 | if (ret < 0) { | |
3353 | goto fail; | |
3354 | } | |
9e1cb96d | 3355 | BLKDBG_EVENT(bs, BLKDBG_PWRITEV_RMW_AFTER_HEAD); |
3b8242e0 KW |
3356 | |
3357 | qemu_iovec_init(&local_qiov, qiov->niov + 2); | |
3358 | qemu_iovec_add(&local_qiov, head_buf, offset & (align - 1)); | |
3359 | qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size); | |
3360 | use_local_qiov = true; | |
3361 | ||
3362 | bytes += offset & (align - 1); | |
3363 | offset = offset & ~(align - 1); | |
3364 | } | |
3365 | ||
3366 | if ((offset + bytes) & (align - 1)) { | |
3367 | QEMUIOVector tail_qiov; | |
3368 | struct iovec tail_iov; | |
3369 | size_t tail_bytes; | |
28de2dcd | 3370 | bool waited; |
3b8242e0 KW |
3371 | |
3372 | mark_request_serialising(&req, align); | |
28de2dcd KW |
3373 | waited = wait_serialising_requests(&req); |
3374 | assert(!waited || !use_local_qiov); | |
3b8242e0 KW |
3375 | |
3376 | tail_buf = qemu_blockalign(bs, align); | |
3377 | tail_iov = (struct iovec) { | |
3378 | .iov_base = tail_buf, | |
3379 | .iov_len = align, | |
3380 | }; | |
3381 | qemu_iovec_init_external(&tail_qiov, &tail_iov, 1); | |
3382 | ||
9e1cb96d | 3383 | BLKDBG_EVENT(bs, BLKDBG_PWRITEV_RMW_TAIL); |
3b8242e0 KW |
3384 | ret = bdrv_aligned_preadv(bs, &req, (offset + bytes) & ~(align - 1), align, |
3385 | align, &tail_qiov, 0); | |
3386 | if (ret < 0) { | |
3387 | goto fail; | |
3388 | } | |
9e1cb96d | 3389 | BLKDBG_EVENT(bs, BLKDBG_PWRITEV_RMW_AFTER_TAIL); |
3b8242e0 KW |
3390 | |
3391 | if (!use_local_qiov) { | |
3392 | qemu_iovec_init(&local_qiov, qiov->niov + 1); | |
3393 | qemu_iovec_concat(&local_qiov, qiov, 0, qiov->size); | |
3394 | use_local_qiov = true; | |
3395 | } | |
3396 | ||
3397 | tail_bytes = (offset + bytes) & (align - 1); | |
3398 | qemu_iovec_add(&local_qiov, tail_buf + tail_bytes, align - tail_bytes); | |
3399 | ||
3400 | bytes = ROUND_UP(bytes, align); | |
3401 | } | |
3402 | ||
3403 | ret = bdrv_aligned_pwritev(bs, &req, offset, bytes, | |
3404 | use_local_qiov ? &local_qiov : qiov, | |
3405 | flags); | |
3406 | ||
3407 | fail: | |
65afd211 | 3408 | tracked_request_end(&req); |
b404f720 | 3409 | |
3b8242e0 KW |
3410 | if (use_local_qiov) { |
3411 | qemu_iovec_destroy(&local_qiov); | |
3b8242e0 | 3412 | } |
99c4a85c KW |
3413 | qemu_vfree(head_buf); |
3414 | qemu_vfree(tail_buf); | |
3b8242e0 | 3415 | |
b404f720 KW |
3416 | return ret; |
3417 | } | |
3418 | ||
6601553e KW |
3419 | static int coroutine_fn bdrv_co_do_writev(BlockDriverState *bs, |
3420 | int64_t sector_num, int nb_sectors, QEMUIOVector *qiov, | |
3421 | BdrvRequestFlags flags) | |
3422 | { | |
3423 | if (nb_sectors < 0 || nb_sectors > (INT_MAX >> BDRV_SECTOR_BITS)) { | |
3424 | return -EINVAL; | |
3425 | } | |
3426 | ||
3427 | return bdrv_co_do_pwritev(bs, sector_num << BDRV_SECTOR_BITS, | |
3428 | nb_sectors << BDRV_SECTOR_BITS, qiov, flags); | |
3429 | } | |
3430 | ||
c5fbe571 SH |
3431 | int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num, |
3432 | int nb_sectors, QEMUIOVector *qiov) | |
3433 | { | |
3434 | trace_bdrv_co_writev(bs, sector_num, nb_sectors); | |
3435 | ||
f08f2dda SH |
3436 | return bdrv_co_do_writev(bs, sector_num, nb_sectors, qiov, 0); |
3437 | } | |
3438 | ||
3439 | int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, | |
aa7bfbff PL |
3440 | int64_t sector_num, int nb_sectors, |
3441 | BdrvRequestFlags flags) | |
f08f2dda | 3442 | { |
94d6ff21 | 3443 | trace_bdrv_co_write_zeroes(bs, sector_num, nb_sectors, flags); |
f08f2dda | 3444 | |
d32f35cb PL |
3445 | if (!(bs->open_flags & BDRV_O_UNMAP)) { |
3446 | flags &= ~BDRV_REQ_MAY_UNMAP; | |
3447 | } | |
3448 | ||
f08f2dda | 3449 | return bdrv_co_do_writev(bs, sector_num, nb_sectors, NULL, |
aa7bfbff | 3450 | BDRV_REQ_ZERO_WRITE | flags); |
c5fbe571 SH |
3451 | } |
3452 | ||
83f64091 FB |
3453 | /** |
3454 | * Truncate file to 'offset' bytes (needed only for file protocols) | |
3455 | */ | |
3456 | int bdrv_truncate(BlockDriverState *bs, int64_t offset) | |
3457 | { | |
3458 | BlockDriver *drv = bs->drv; | |
51762288 | 3459 | int ret; |
83f64091 | 3460 | if (!drv) |
19cb3738 | 3461 | return -ENOMEDIUM; |
83f64091 FB |
3462 | if (!drv->bdrv_truncate) |
3463 | return -ENOTSUP; | |
59f2689d NS |
3464 | if (bs->read_only) |
3465 | return -EACCES; | |
9c75e168 | 3466 | |
51762288 SH |
3467 | ret = drv->bdrv_truncate(bs, offset); |
3468 | if (ret == 0) { | |
3469 | ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS); | |
a7f53e26 MA |
3470 | if (bs->blk) { |
3471 | blk_dev_resize_cb(bs->blk); | |
3472 | } | |
51762288 SH |
3473 | } |
3474 | return ret; | |
83f64091 FB |
3475 | } |
3476 | ||
4a1d5e1f FZ |
3477 | /** |
3478 | * Length of a allocated file in bytes. Sparse files are counted by actual | |
3479 | * allocated space. Return < 0 if error or unknown. | |
3480 | */ | |
3481 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs) | |
3482 | { | |
3483 | BlockDriver *drv = bs->drv; | |
3484 | if (!drv) { | |
3485 | return -ENOMEDIUM; | |
3486 | } | |
3487 | if (drv->bdrv_get_allocated_file_size) { | |
3488 | return drv->bdrv_get_allocated_file_size(bs); | |
3489 | } | |
3490 | if (bs->file) { | |
3491 | return bdrv_get_allocated_file_size(bs->file); | |
3492 | } | |
3493 | return -ENOTSUP; | |
3494 | } | |
3495 | ||
83f64091 | 3496 | /** |
65a9bb25 | 3497 | * Return number of sectors on success, -errno on error. |
83f64091 | 3498 | */ |
65a9bb25 | 3499 | int64_t bdrv_nb_sectors(BlockDriverState *bs) |
83f64091 FB |
3500 | { |
3501 | BlockDriver *drv = bs->drv; | |
65a9bb25 | 3502 | |
83f64091 | 3503 | if (!drv) |
19cb3738 | 3504 | return -ENOMEDIUM; |
51762288 | 3505 | |
b94a2610 KW |
3506 | if (drv->has_variable_length) { |
3507 | int ret = refresh_total_sectors(bs, bs->total_sectors); | |
3508 | if (ret < 0) { | |
3509 | return ret; | |
46a4e4e6 | 3510 | } |
83f64091 | 3511 | } |
65a9bb25 MA |
3512 | return bs->total_sectors; |
3513 | } | |
3514 | ||
3515 | /** | |
3516 | * Return length in bytes on success, -errno on error. | |
3517 | * The length is always a multiple of BDRV_SECTOR_SIZE. | |
3518 | */ | |
3519 | int64_t bdrv_getlength(BlockDriverState *bs) | |
3520 | { | |
3521 | int64_t ret = bdrv_nb_sectors(bs); | |
3522 | ||
3523 | return ret < 0 ? ret : ret * BDRV_SECTOR_SIZE; | |
fc01f7e7 FB |
3524 | } |
3525 | ||
19cb3738 | 3526 | /* return 0 as number of sectors if no device present or error */ |
96b8f136 | 3527 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr) |
fc01f7e7 | 3528 | { |
65a9bb25 MA |
3529 | int64_t nb_sectors = bdrv_nb_sectors(bs); |
3530 | ||
3531 | *nb_sectors_ptr = nb_sectors < 0 ? 0 : nb_sectors; | |
fc01f7e7 | 3532 | } |
cf98951b | 3533 | |
ff06f5f3 PB |
3534 | void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error, |
3535 | BlockdevOnError on_write_error) | |
abd7f68d MA |
3536 | { |
3537 | bs->on_read_error = on_read_error; | |
3538 | bs->on_write_error = on_write_error; | |
3539 | } | |
3540 | ||
1ceee0d5 | 3541 | BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read) |
abd7f68d MA |
3542 | { |
3543 | return is_read ? bs->on_read_error : bs->on_write_error; | |
3544 | } | |
3545 | ||
3e1caa5f PB |
3546 | BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error) |
3547 | { | |
3548 | BlockdevOnError on_err = is_read ? bs->on_read_error : bs->on_write_error; | |
3549 | ||
3550 | switch (on_err) { | |
3551 | case BLOCKDEV_ON_ERROR_ENOSPC: | |
a589569f WX |
3552 | return (error == ENOSPC) ? |
3553 | BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT; | |
3e1caa5f | 3554 | case BLOCKDEV_ON_ERROR_STOP: |
a589569f | 3555 | return BLOCK_ERROR_ACTION_STOP; |
3e1caa5f | 3556 | case BLOCKDEV_ON_ERROR_REPORT: |
a589569f | 3557 | return BLOCK_ERROR_ACTION_REPORT; |
3e1caa5f | 3558 | case BLOCKDEV_ON_ERROR_IGNORE: |
a589569f | 3559 | return BLOCK_ERROR_ACTION_IGNORE; |
3e1caa5f PB |
3560 | default: |
3561 | abort(); | |
3562 | } | |
3563 | } | |
3564 | ||
c7c2ff0c LC |
3565 | static void send_qmp_error_event(BlockDriverState *bs, |
3566 | BlockErrorAction action, | |
3567 | bool is_read, int error) | |
3568 | { | |
573742a5 | 3569 | IoOperationType optype; |
c7c2ff0c | 3570 | |
573742a5 PM |
3571 | optype = is_read ? IO_OPERATION_TYPE_READ : IO_OPERATION_TYPE_WRITE; |
3572 | qapi_event_send_block_io_error(bdrv_get_device_name(bs), optype, action, | |
c7c2ff0c | 3573 | bdrv_iostatus_is_enabled(bs), |
624ff573 LC |
3574 | error == ENOSPC, strerror(error), |
3575 | &error_abort); | |
c7c2ff0c LC |
3576 | } |
3577 | ||
3e1caa5f PB |
3578 | /* This is done by device models because, while the block layer knows |
3579 | * about the error, it does not know whether an operation comes from | |
3580 | * the device or the block layer (from a job, for example). | |
3581 | */ | |
3582 | void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action, | |
3583 | bool is_read, int error) | |
3584 | { | |
3585 | assert(error >= 0); | |
2bd3bce8 | 3586 | |
a589569f | 3587 | if (action == BLOCK_ERROR_ACTION_STOP) { |
2bd3bce8 PB |
3588 | /* First set the iostatus, so that "info block" returns an iostatus |
3589 | * that matches the events raised so far (an additional error iostatus | |
3590 | * is fine, but not a lost one). | |
3591 | */ | |
3e1caa5f | 3592 | bdrv_iostatus_set_err(bs, error); |
2bd3bce8 PB |
3593 | |
3594 | /* Then raise the request to stop the VM and the event. | |
3595 | * qemu_system_vmstop_request_prepare has two effects. First, | |
3596 | * it ensures that the STOP event always comes after the | |
3597 | * BLOCK_IO_ERROR event. Second, it ensures that even if management | |
3598 | * can observe the STOP event and do a "cont" before the STOP | |
3599 | * event is issued, the VM will not stop. In this case, vm_start() | |
3600 | * also ensures that the STOP/RESUME pair of events is emitted. | |
3601 | */ | |
3602 | qemu_system_vmstop_request_prepare(); | |
c7c2ff0c | 3603 | send_qmp_error_event(bs, action, is_read, error); |
2bd3bce8 PB |
3604 | qemu_system_vmstop_request(RUN_STATE_IO_ERROR); |
3605 | } else { | |
c7c2ff0c | 3606 | send_qmp_error_event(bs, action, is_read, error); |
3e1caa5f PB |
3607 | } |
3608 | } | |
3609 | ||
b338082b FB |
3610 | int bdrv_is_read_only(BlockDriverState *bs) |
3611 | { | |
3612 | return bs->read_only; | |
3613 | } | |
3614 | ||
985a03b0 TS |
3615 | int bdrv_is_sg(BlockDriverState *bs) |
3616 | { | |
3617 | return bs->sg; | |
3618 | } | |
3619 | ||
e900a7b7 CH |
3620 | int bdrv_enable_write_cache(BlockDriverState *bs) |
3621 | { | |
3622 | return bs->enable_write_cache; | |
3623 | } | |
3624 | ||
425b0148 PB |
3625 | void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce) |
3626 | { | |
3627 | bs->enable_write_cache = wce; | |
55b110f2 JC |
3628 | |
3629 | /* so a reopen() will preserve wce */ | |
3630 | if (wce) { | |
3631 | bs->open_flags |= BDRV_O_CACHE_WB; | |
3632 | } else { | |
3633 | bs->open_flags &= ~BDRV_O_CACHE_WB; | |
3634 | } | |
425b0148 PB |
3635 | } |
3636 | ||
ea2384d3 FB |
3637 | int bdrv_is_encrypted(BlockDriverState *bs) |
3638 | { | |
3639 | if (bs->backing_hd && bs->backing_hd->encrypted) | |
3640 | return 1; | |
3641 | return bs->encrypted; | |
3642 | } | |
3643 | ||
c0f4ce77 AL |
3644 | int bdrv_key_required(BlockDriverState *bs) |
3645 | { | |
3646 | BlockDriverState *backing_hd = bs->backing_hd; | |
3647 | ||
3648 | if (backing_hd && backing_hd->encrypted && !backing_hd->valid_key) | |
3649 | return 1; | |
3650 | return (bs->encrypted && !bs->valid_key); | |
3651 | } | |
3652 | ||
ea2384d3 FB |
3653 | int bdrv_set_key(BlockDriverState *bs, const char *key) |
3654 | { | |
3655 | int ret; | |
3656 | if (bs->backing_hd && bs->backing_hd->encrypted) { | |
3657 | ret = bdrv_set_key(bs->backing_hd, key); | |
3658 | if (ret < 0) | |
3659 | return ret; | |
3660 | if (!bs->encrypted) | |
3661 | return 0; | |
3662 | } | |
fd04a2ae SH |
3663 | if (!bs->encrypted) { |
3664 | return -EINVAL; | |
3665 | } else if (!bs->drv || !bs->drv->bdrv_set_key) { | |
3666 | return -ENOMEDIUM; | |
3667 | } | |
c0f4ce77 | 3668 | ret = bs->drv->bdrv_set_key(bs, key); |
bb5fc20f AL |
3669 | if (ret < 0) { |
3670 | bs->valid_key = 0; | |
3671 | } else if (!bs->valid_key) { | |
3672 | bs->valid_key = 1; | |
a7f53e26 MA |
3673 | if (bs->blk) { |
3674 | /* call the change callback now, we skipped it on open */ | |
3675 | blk_dev_change_media_cb(bs->blk, true); | |
3676 | } | |
bb5fc20f | 3677 | } |
c0f4ce77 | 3678 | return ret; |
ea2384d3 FB |
3679 | } |
3680 | ||
f8d6bba1 | 3681 | const char *bdrv_get_format_name(BlockDriverState *bs) |
ea2384d3 | 3682 | { |
f8d6bba1 | 3683 | return bs->drv ? bs->drv->format_name : NULL; |
ea2384d3 FB |
3684 | } |
3685 | ||
ada42401 SH |
3686 | static int qsort_strcmp(const void *a, const void *b) |
3687 | { | |
3688 | return strcmp(a, b); | |
3689 | } | |
3690 | ||
5fafdf24 | 3691 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
ea2384d3 FB |
3692 | void *opaque) |
3693 | { | |
3694 | BlockDriver *drv; | |
e855e4fb | 3695 | int count = 0; |
ada42401 | 3696 | int i; |
e855e4fb | 3697 | const char **formats = NULL; |
ea2384d3 | 3698 | |
8a22f02a | 3699 | QLIST_FOREACH(drv, &bdrv_drivers, list) { |
e855e4fb JC |
3700 | if (drv->format_name) { |
3701 | bool found = false; | |
3702 | int i = count; | |
3703 | while (formats && i && !found) { | |
3704 | found = !strcmp(formats[--i], drv->format_name); | |
3705 | } | |
3706 | ||
3707 | if (!found) { | |
5839e53b | 3708 | formats = g_renew(const char *, formats, count + 1); |
e855e4fb | 3709 | formats[count++] = drv->format_name; |
e855e4fb JC |
3710 | } |
3711 | } | |
ea2384d3 | 3712 | } |
ada42401 SH |
3713 | |
3714 | qsort(formats, count, sizeof(formats[0]), qsort_strcmp); | |
3715 | ||
3716 | for (i = 0; i < count; i++) { | |
3717 | it(opaque, formats[i]); | |
3718 | } | |
3719 | ||
e855e4fb | 3720 | g_free(formats); |
ea2384d3 FB |
3721 | } |
3722 | ||
dc364f4c | 3723 | /* This function is to find block backend bs */ |
7f06d47e | 3724 | /* TODO convert callers to blk_by_name(), then remove */ |
b338082b FB |
3725 | BlockDriverState *bdrv_find(const char *name) |
3726 | { | |
7f06d47e | 3727 | BlockBackend *blk = blk_by_name(name); |
b338082b | 3728 | |
7f06d47e | 3729 | return blk ? blk_bs(blk) : NULL; |
b338082b FB |
3730 | } |
3731 | ||
dc364f4c BC |
3732 | /* This function is to find a node in the bs graph */ |
3733 | BlockDriverState *bdrv_find_node(const char *node_name) | |
3734 | { | |
3735 | BlockDriverState *bs; | |
3736 | ||
3737 | assert(node_name); | |
3738 | ||
3739 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { | |
3740 | if (!strcmp(node_name, bs->node_name)) { | |
3741 | return bs; | |
3742 | } | |
3743 | } | |
3744 | return NULL; | |
3745 | } | |
3746 | ||
c13163fb BC |
3747 | /* Put this QMP function here so it can access the static graph_bdrv_states. */ |
3748 | BlockDeviceInfoList *bdrv_named_nodes_list(void) | |
3749 | { | |
3750 | BlockDeviceInfoList *list, *entry; | |
3751 | BlockDriverState *bs; | |
3752 | ||
3753 | list = NULL; | |
3754 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { | |
3755 | entry = g_malloc0(sizeof(*entry)); | |
3756 | entry->value = bdrv_block_device_info(bs); | |
3757 | entry->next = list; | |
3758 | list = entry; | |
3759 | } | |
3760 | ||
3761 | return list; | |
3762 | } | |
3763 | ||
12d3ba82 BC |
3764 | BlockDriverState *bdrv_lookup_bs(const char *device, |
3765 | const char *node_name, | |
3766 | Error **errp) | |
3767 | { | |
7f06d47e MA |
3768 | BlockBackend *blk; |
3769 | BlockDriverState *bs; | |
12d3ba82 | 3770 | |
12d3ba82 | 3771 | if (device) { |
7f06d47e | 3772 | blk = blk_by_name(device); |
12d3ba82 | 3773 | |
7f06d47e MA |
3774 | if (blk) { |
3775 | return blk_bs(blk); | |
12d3ba82 | 3776 | } |
12d3ba82 BC |
3777 | } |
3778 | ||
dd67fa50 BC |
3779 | if (node_name) { |
3780 | bs = bdrv_find_node(node_name); | |
12d3ba82 | 3781 | |
dd67fa50 BC |
3782 | if (bs) { |
3783 | return bs; | |
3784 | } | |
12d3ba82 BC |
3785 | } |
3786 | ||
dd67fa50 BC |
3787 | error_setg(errp, "Cannot find device=%s nor node_name=%s", |
3788 | device ? device : "", | |
3789 | node_name ? node_name : ""); | |
3790 | return NULL; | |
12d3ba82 BC |
3791 | } |
3792 | ||
5a6684d2 JC |
3793 | /* If 'base' is in the same chain as 'top', return true. Otherwise, |
3794 | * return false. If either argument is NULL, return false. */ | |
3795 | bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base) | |
3796 | { | |
3797 | while (top && top != base) { | |
3798 | top = top->backing_hd; | |
3799 | } | |
3800 | ||
3801 | return top != NULL; | |
3802 | } | |
3803 | ||
2f399b0a MA |
3804 | BlockDriverState *bdrv_next(BlockDriverState *bs) |
3805 | { | |
3806 | if (!bs) { | |
3807 | return QTAILQ_FIRST(&bdrv_states); | |
3808 | } | |
dc364f4c | 3809 | return QTAILQ_NEXT(bs, device_list); |
2f399b0a MA |
3810 | } |
3811 | ||
7f06d47e | 3812 | /* TODO check what callers really want: bs->node_name or blk_name() */ |
bfb197e0 | 3813 | const char *bdrv_get_device_name(const BlockDriverState *bs) |
ea2384d3 | 3814 | { |
bfb197e0 | 3815 | return bs->blk ? blk_name(bs->blk) : ""; |
ea2384d3 FB |
3816 | } |
3817 | ||
c8433287 MA |
3818 | int bdrv_get_flags(BlockDriverState *bs) |
3819 | { | |
3820 | return bs->open_flags; | |
3821 | } | |
3822 | ||
f0f0fdfe | 3823 | int bdrv_flush_all(void) |
c6ca28d6 AL |
3824 | { |
3825 | BlockDriverState *bs; | |
f0f0fdfe | 3826 | int result = 0; |
c6ca28d6 | 3827 | |
dc364f4c | 3828 | QTAILQ_FOREACH(bs, &bdrv_states, device_list) { |
ed78cda3 SH |
3829 | AioContext *aio_context = bdrv_get_aio_context(bs); |
3830 | int ret; | |
3831 | ||
3832 | aio_context_acquire(aio_context); | |
3833 | ret = bdrv_flush(bs); | |
f0f0fdfe KW |
3834 | if (ret < 0 && !result) { |
3835 | result = ret; | |
3836 | } | |
ed78cda3 | 3837 | aio_context_release(aio_context); |
1b7bdbc1 | 3838 | } |
f0f0fdfe KW |
3839 | |
3840 | return result; | |
c6ca28d6 AL |
3841 | } |
3842 | ||
3ac21627 PL |
3843 | int bdrv_has_zero_init_1(BlockDriverState *bs) |
3844 | { | |
3845 | return 1; | |
3846 | } | |
3847 | ||
f2feebbd KW |
3848 | int bdrv_has_zero_init(BlockDriverState *bs) |
3849 | { | |
3850 | assert(bs->drv); | |
3851 | ||
11212d8f PB |
3852 | /* If BS is a copy on write image, it is initialized to |
3853 | the contents of the base image, which may not be zeroes. */ | |
3854 | if (bs->backing_hd) { | |
3855 | return 0; | |
3856 | } | |
336c1c12 KW |
3857 | if (bs->drv->bdrv_has_zero_init) { |
3858 | return bs->drv->bdrv_has_zero_init(bs); | |
f2feebbd KW |
3859 | } |
3860 | ||
3ac21627 PL |
3861 | /* safe default */ |
3862 | return 0; | |
f2feebbd KW |
3863 | } |
3864 | ||
4ce78691 PL |
3865 | bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs) |
3866 | { | |
3867 | BlockDriverInfo bdi; | |
3868 | ||
3869 | if (bs->backing_hd) { | |
3870 | return false; | |
3871 | } | |
3872 | ||
3873 | if (bdrv_get_info(bs, &bdi) == 0) { | |
3874 | return bdi.unallocated_blocks_are_zero; | |
3875 | } | |
3876 | ||
3877 | return false; | |
3878 | } | |
3879 | ||
3880 | bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs) | |
3881 | { | |
3882 | BlockDriverInfo bdi; | |
3883 | ||
3884 | if (bs->backing_hd || !(bs->open_flags & BDRV_O_UNMAP)) { | |
3885 | return false; | |
3886 | } | |
3887 | ||
3888 | if (bdrv_get_info(bs, &bdi) == 0) { | |
3889 | return bdi.can_write_zeroes_with_unmap; | |
3890 | } | |
3891 | ||
3892 | return false; | |
3893 | } | |
3894 | ||
b6b8a333 | 3895 | typedef struct BdrvCoGetBlockStatusData { |
376ae3f1 | 3896 | BlockDriverState *bs; |
b35b2bba | 3897 | BlockDriverState *base; |
376ae3f1 SH |
3898 | int64_t sector_num; |
3899 | int nb_sectors; | |
3900 | int *pnum; | |
b6b8a333 | 3901 | int64_t ret; |
376ae3f1 | 3902 | bool done; |
b6b8a333 | 3903 | } BdrvCoGetBlockStatusData; |
376ae3f1 | 3904 | |
f58c7b35 TS |
3905 | /* |
3906 | * Returns true iff the specified sector is present in the disk image. Drivers | |
3907 | * not implementing the functionality are assumed to not support backing files, | |
3908 | * hence all their sectors are reported as allocated. | |
3909 | * | |
bd9533e3 SH |
3910 | * If 'sector_num' is beyond the end of the disk image the return value is 0 |
3911 | * and 'pnum' is set to 0. | |
3912 | * | |
f58c7b35 TS |
3913 | * 'pnum' is set to the number of sectors (including and immediately following |
3914 | * the specified sector) that are known to be in the same | |
3915 | * allocated/unallocated state. | |
3916 | * | |
bd9533e3 SH |
3917 | * 'nb_sectors' is the max value 'pnum' should be set to. If nb_sectors goes |
3918 | * beyond the end of the disk image it will be clamped. | |
f58c7b35 | 3919 | */ |
b6b8a333 PB |
3920 | static int64_t coroutine_fn bdrv_co_get_block_status(BlockDriverState *bs, |
3921 | int64_t sector_num, | |
3922 | int nb_sectors, int *pnum) | |
f58c7b35 | 3923 | { |
30a7f2fc | 3924 | int64_t total_sectors; |
bd9533e3 | 3925 | int64_t n; |
5daa74a6 | 3926 | int64_t ret, ret2; |
bd9533e3 | 3927 | |
30a7f2fc MA |
3928 | total_sectors = bdrv_nb_sectors(bs); |
3929 | if (total_sectors < 0) { | |
3930 | return total_sectors; | |
617ccb46 PB |
3931 | } |
3932 | ||
30a7f2fc | 3933 | if (sector_num >= total_sectors) { |
bd9533e3 SH |
3934 | *pnum = 0; |
3935 | return 0; | |
3936 | } | |
3937 | ||
30a7f2fc | 3938 | n = total_sectors - sector_num; |
bd9533e3 SH |
3939 | if (n < nb_sectors) { |
3940 | nb_sectors = n; | |
3941 | } | |
3942 | ||
b6b8a333 | 3943 | if (!bs->drv->bdrv_co_get_block_status) { |
bd9533e3 | 3944 | *pnum = nb_sectors; |
e88ae226 | 3945 | ret = BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED; |
918e92d7 PB |
3946 | if (bs->drv->protocol_name) { |
3947 | ret |= BDRV_BLOCK_OFFSET_VALID | (sector_num * BDRV_SECTOR_SIZE); | |
3948 | } | |
3949 | return ret; | |
f58c7b35 | 3950 | } |
6aebab14 | 3951 | |
415b5b01 PB |
3952 | ret = bs->drv->bdrv_co_get_block_status(bs, sector_num, nb_sectors, pnum); |
3953 | if (ret < 0) { | |
3e0a233d | 3954 | *pnum = 0; |
415b5b01 PB |
3955 | return ret; |
3956 | } | |
3957 | ||
92bc50a5 PL |
3958 | if (ret & BDRV_BLOCK_RAW) { |
3959 | assert(ret & BDRV_BLOCK_OFFSET_VALID); | |
3960 | return bdrv_get_block_status(bs->file, ret >> BDRV_SECTOR_BITS, | |
3961 | *pnum, pnum); | |
3962 | } | |
3963 | ||
e88ae226 KW |
3964 | if (ret & (BDRV_BLOCK_DATA | BDRV_BLOCK_ZERO)) { |
3965 | ret |= BDRV_BLOCK_ALLOCATED; | |
3966 | } | |
3967 | ||
c3d86884 PL |
3968 | if (!(ret & BDRV_BLOCK_DATA) && !(ret & BDRV_BLOCK_ZERO)) { |
3969 | if (bdrv_unallocated_blocks_are_zero(bs)) { | |
f0ad5712 | 3970 | ret |= BDRV_BLOCK_ZERO; |
1f9db224 | 3971 | } else if (bs->backing_hd) { |
f0ad5712 | 3972 | BlockDriverState *bs2 = bs->backing_hd; |
30a7f2fc MA |
3973 | int64_t nb_sectors2 = bdrv_nb_sectors(bs2); |
3974 | if (nb_sectors2 >= 0 && sector_num >= nb_sectors2) { | |
f0ad5712 PB |
3975 | ret |= BDRV_BLOCK_ZERO; |
3976 | } | |
3977 | } | |
415b5b01 | 3978 | } |
5daa74a6 PB |
3979 | |
3980 | if (bs->file && | |
3981 | (ret & BDRV_BLOCK_DATA) && !(ret & BDRV_BLOCK_ZERO) && | |
3982 | (ret & BDRV_BLOCK_OFFSET_VALID)) { | |
59c9a95f HR |
3983 | int file_pnum; |
3984 | ||
5daa74a6 | 3985 | ret2 = bdrv_co_get_block_status(bs->file, ret >> BDRV_SECTOR_BITS, |
59c9a95f | 3986 | *pnum, &file_pnum); |
5daa74a6 PB |
3987 | if (ret2 >= 0) { |
3988 | /* Ignore errors. This is just providing extra information, it | |
3989 | * is useful but not necessary. | |
3990 | */ | |
59c9a95f HR |
3991 | if (!file_pnum) { |
3992 | /* !file_pnum indicates an offset at or beyond the EOF; it is | |
3993 | * perfectly valid for the format block driver to point to such | |
3994 | * offsets, so catch it and mark everything as zero */ | |
3995 | ret |= BDRV_BLOCK_ZERO; | |
3996 | } else { | |
3997 | /* Limit request to the range reported by the protocol driver */ | |
3998 | *pnum = file_pnum; | |
3999 | ret |= (ret2 & BDRV_BLOCK_ZERO); | |
4000 | } | |
5daa74a6 PB |
4001 | } |
4002 | } | |
4003 | ||
415b5b01 | 4004 | return ret; |
060f51c9 SH |
4005 | } |
4006 | ||
b6b8a333 PB |
4007 | /* Coroutine wrapper for bdrv_get_block_status() */ |
4008 | static void coroutine_fn bdrv_get_block_status_co_entry(void *opaque) | |
060f51c9 | 4009 | { |
b6b8a333 | 4010 | BdrvCoGetBlockStatusData *data = opaque; |
060f51c9 SH |
4011 | BlockDriverState *bs = data->bs; |
4012 | ||
b6b8a333 PB |
4013 | data->ret = bdrv_co_get_block_status(bs, data->sector_num, data->nb_sectors, |
4014 | data->pnum); | |
060f51c9 SH |
4015 | data->done = true; |
4016 | } | |
4017 | ||
4018 | /* | |
b6b8a333 | 4019 | * Synchronous wrapper around bdrv_co_get_block_status(). |
060f51c9 | 4020 | * |
b6b8a333 | 4021 | * See bdrv_co_get_block_status() for details. |
060f51c9 | 4022 | */ |
b6b8a333 PB |
4023 | int64_t bdrv_get_block_status(BlockDriverState *bs, int64_t sector_num, |
4024 | int nb_sectors, int *pnum) | |
060f51c9 | 4025 | { |
6aebab14 | 4026 | Coroutine *co; |
b6b8a333 | 4027 | BdrvCoGetBlockStatusData data = { |
6aebab14 SH |
4028 | .bs = bs, |
4029 | .sector_num = sector_num, | |
4030 | .nb_sectors = nb_sectors, | |
4031 | .pnum = pnum, | |
4032 | .done = false, | |
4033 | }; | |
4034 | ||
bdad13b9 PB |
4035 | if (qemu_in_coroutine()) { |
4036 | /* Fast-path if already in coroutine context */ | |
b6b8a333 | 4037 | bdrv_get_block_status_co_entry(&data); |
bdad13b9 | 4038 | } else { |
2572b37a SH |
4039 | AioContext *aio_context = bdrv_get_aio_context(bs); |
4040 | ||
b6b8a333 | 4041 | co = qemu_coroutine_create(bdrv_get_block_status_co_entry); |
bdad13b9 PB |
4042 | qemu_coroutine_enter(co, &data); |
4043 | while (!data.done) { | |
2572b37a | 4044 | aio_poll(aio_context, true); |
bdad13b9 | 4045 | } |
6aebab14 SH |
4046 | } |
4047 | return data.ret; | |
f58c7b35 TS |
4048 | } |
4049 | ||
b6b8a333 PB |
4050 | int coroutine_fn bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, |
4051 | int nb_sectors, int *pnum) | |
4052 | { | |
4333bb71 PB |
4053 | int64_t ret = bdrv_get_block_status(bs, sector_num, nb_sectors, pnum); |
4054 | if (ret < 0) { | |
4055 | return ret; | |
4056 | } | |
01fb2705 | 4057 | return !!(ret & BDRV_BLOCK_ALLOCATED); |
b6b8a333 PB |
4058 | } |
4059 | ||
188a7bbf PB |
4060 | /* |
4061 | * Given an image chain: ... -> [BASE] -> [INTER1] -> [INTER2] -> [TOP] | |
4062 | * | |
4063 | * Return true if the given sector is allocated in any image between | |
4064 | * BASE and TOP (inclusive). BASE can be NULL to check if the given | |
4065 | * sector is allocated in any image of the chain. Return false otherwise. | |
4066 | * | |
4067 | * 'pnum' is set to the number of sectors (including and immediately following | |
4068 | * the specified sector) that are known to be in the same | |
4069 | * allocated/unallocated state. | |
4070 | * | |
4071 | */ | |
4f578637 PB |
4072 | int bdrv_is_allocated_above(BlockDriverState *top, |
4073 | BlockDriverState *base, | |
4074 | int64_t sector_num, | |
4075 | int nb_sectors, int *pnum) | |
188a7bbf PB |
4076 | { |
4077 | BlockDriverState *intermediate; | |
4078 | int ret, n = nb_sectors; | |
4079 | ||
4080 | intermediate = top; | |
4081 | while (intermediate && intermediate != base) { | |
4082 | int pnum_inter; | |
bdad13b9 PB |
4083 | ret = bdrv_is_allocated(intermediate, sector_num, nb_sectors, |
4084 | &pnum_inter); | |
188a7bbf PB |
4085 | if (ret < 0) { |
4086 | return ret; | |
4087 | } else if (ret) { | |
4088 | *pnum = pnum_inter; | |
4089 | return 1; | |
4090 | } | |
4091 | ||
4092 | /* | |
4093 | * [sector_num, nb_sectors] is unallocated on top but intermediate | |
4094 | * might have | |
4095 | * | |
4096 | * [sector_num+x, nr_sectors] allocated. | |
4097 | */ | |
63ba17d3 VI |
4098 | if (n > pnum_inter && |
4099 | (intermediate == top || | |
4100 | sector_num + pnum_inter < intermediate->total_sectors)) { | |
188a7bbf PB |
4101 | n = pnum_inter; |
4102 | } | |
4103 | ||
4104 | intermediate = intermediate->backing_hd; | |
4105 | } | |
4106 | ||
4107 | *pnum = n; | |
4108 | return 0; | |
4109 | } | |
4110 | ||
045df330 AL |
4111 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs) |
4112 | { | |
4113 | if (bs->backing_hd && bs->backing_hd->encrypted) | |
4114 | return bs->backing_file; | |
4115 | else if (bs->encrypted) | |
4116 | return bs->filename; | |
4117 | else | |
4118 | return NULL; | |
4119 | } | |
4120 | ||
5fafdf24 | 4121 | void bdrv_get_backing_filename(BlockDriverState *bs, |
83f64091 FB |
4122 | char *filename, int filename_size) |
4123 | { | |
3574c608 | 4124 | pstrcpy(filename, filename_size, bs->backing_file); |
83f64091 FB |
4125 | } |
4126 | ||
5fafdf24 | 4127 | int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num, |
faea38e7 FB |
4128 | const uint8_t *buf, int nb_sectors) |
4129 | { | |
4130 | BlockDriver *drv = bs->drv; | |
4131 | if (!drv) | |
19cb3738 | 4132 | return -ENOMEDIUM; |
faea38e7 FB |
4133 | if (!drv->bdrv_write_compressed) |
4134 | return -ENOTSUP; | |
fbb7b4e0 KW |
4135 | if (bdrv_check_request(bs, sector_num, nb_sectors)) |
4136 | return -EIO; | |
a55eb92c | 4137 | |
e4654d2d | 4138 | assert(QLIST_EMPTY(&bs->dirty_bitmaps)); |
a55eb92c | 4139 | |
faea38e7 FB |
4140 | return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors); |
4141 | } | |
3b46e624 | 4142 | |
faea38e7 FB |
4143 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi) |
4144 | { | |
4145 | BlockDriver *drv = bs->drv; | |
4146 | if (!drv) | |
19cb3738 | 4147 | return -ENOMEDIUM; |
faea38e7 FB |
4148 | if (!drv->bdrv_get_info) |
4149 | return -ENOTSUP; | |
4150 | memset(bdi, 0, sizeof(*bdi)); | |
4151 | return drv->bdrv_get_info(bs, bdi); | |
4152 | } | |
4153 | ||
eae041fe HR |
4154 | ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs) |
4155 | { | |
4156 | BlockDriver *drv = bs->drv; | |
4157 | if (drv && drv->bdrv_get_specific_info) { | |
4158 | return drv->bdrv_get_specific_info(bs); | |
4159 | } | |
4160 | return NULL; | |
4161 | } | |
4162 | ||
45566e9c CH |
4163 | int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf, |
4164 | int64_t pos, int size) | |
cf8074b3 KW |
4165 | { |
4166 | QEMUIOVector qiov; | |
4167 | struct iovec iov = { | |
4168 | .iov_base = (void *) buf, | |
4169 | .iov_len = size, | |
4170 | }; | |
4171 | ||
4172 | qemu_iovec_init_external(&qiov, &iov, 1); | |
4173 | return bdrv_writev_vmstate(bs, &qiov, pos); | |
4174 | } | |
4175 | ||
4176 | int bdrv_writev_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, int64_t pos) | |
178e08a5 AL |
4177 | { |
4178 | BlockDriver *drv = bs->drv; | |
cf8074b3 KW |
4179 | |
4180 | if (!drv) { | |
178e08a5 | 4181 | return -ENOMEDIUM; |
cf8074b3 KW |
4182 | } else if (drv->bdrv_save_vmstate) { |
4183 | return drv->bdrv_save_vmstate(bs, qiov, pos); | |
4184 | } else if (bs->file) { | |
4185 | return bdrv_writev_vmstate(bs->file, qiov, pos); | |
4186 | } | |
4187 | ||
7cdb1f6d | 4188 | return -ENOTSUP; |
178e08a5 AL |
4189 | } |
4190 | ||
45566e9c CH |
4191 | int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf, |
4192 | int64_t pos, int size) | |
178e08a5 AL |
4193 | { |
4194 | BlockDriver *drv = bs->drv; | |
4195 | if (!drv) | |
4196 | return -ENOMEDIUM; | |
7cdb1f6d MK |
4197 | if (drv->bdrv_load_vmstate) |
4198 | return drv->bdrv_load_vmstate(bs, buf, pos, size); | |
4199 | if (bs->file) | |
4200 | return bdrv_load_vmstate(bs->file, buf, pos, size); | |
4201 | return -ENOTSUP; | |
178e08a5 AL |
4202 | } |
4203 | ||
8b9b0cc2 KW |
4204 | void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event) |
4205 | { | |
bf736fe3 | 4206 | if (!bs || !bs->drv || !bs->drv->bdrv_debug_event) { |
8b9b0cc2 KW |
4207 | return; |
4208 | } | |
4209 | ||
bf736fe3 | 4210 | bs->drv->bdrv_debug_event(bs, event); |
41c695c7 KW |
4211 | } |
4212 | ||
4213 | int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, | |
4214 | const char *tag) | |
4215 | { | |
4216 | while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) { | |
4217 | bs = bs->file; | |
4218 | } | |
4219 | ||
4220 | if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) { | |
4221 | return bs->drv->bdrv_debug_breakpoint(bs, event, tag); | |
4222 | } | |
4223 | ||
4224 | return -ENOTSUP; | |
4225 | } | |
4226 | ||
4cc70e93 FZ |
4227 | int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag) |
4228 | { | |
4229 | while (bs && bs->drv && !bs->drv->bdrv_debug_remove_breakpoint) { | |
4230 | bs = bs->file; | |
4231 | } | |
4232 | ||
4233 | if (bs && bs->drv && bs->drv->bdrv_debug_remove_breakpoint) { | |
4234 | return bs->drv->bdrv_debug_remove_breakpoint(bs, tag); | |
4235 | } | |
4236 | ||
4237 | return -ENOTSUP; | |
4238 | } | |
4239 | ||
41c695c7 KW |
4240 | int bdrv_debug_resume(BlockDriverState *bs, const char *tag) |
4241 | { | |
938789ea | 4242 | while (bs && (!bs->drv || !bs->drv->bdrv_debug_resume)) { |
41c695c7 KW |
4243 | bs = bs->file; |
4244 | } | |
8b9b0cc2 | 4245 | |
41c695c7 KW |
4246 | if (bs && bs->drv && bs->drv->bdrv_debug_resume) { |
4247 | return bs->drv->bdrv_debug_resume(bs, tag); | |
4248 | } | |
4249 | ||
4250 | return -ENOTSUP; | |
4251 | } | |
4252 | ||
4253 | bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag) | |
4254 | { | |
4255 | while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) { | |
4256 | bs = bs->file; | |
4257 | } | |
4258 | ||
4259 | if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) { | |
4260 | return bs->drv->bdrv_debug_is_suspended(bs, tag); | |
4261 | } | |
4262 | ||
4263 | return false; | |
8b9b0cc2 KW |
4264 | } |
4265 | ||
199630b6 BS |
4266 | int bdrv_is_snapshot(BlockDriverState *bs) |
4267 | { | |
4268 | return !!(bs->open_flags & BDRV_O_SNAPSHOT); | |
4269 | } | |
4270 | ||
b1b1d783 JC |
4271 | /* backing_file can either be relative, or absolute, or a protocol. If it is |
4272 | * relative, it must be relative to the chain. So, passing in bs->filename | |
4273 | * from a BDS as backing_file should not be done, as that may be relative to | |
4274 | * the CWD rather than the chain. */ | |
e8a6bb9c MT |
4275 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, |
4276 | const char *backing_file) | |
4277 | { | |
b1b1d783 JC |
4278 | char *filename_full = NULL; |
4279 | char *backing_file_full = NULL; | |
4280 | char *filename_tmp = NULL; | |
4281 | int is_protocol = 0; | |
4282 | BlockDriverState *curr_bs = NULL; | |
4283 | BlockDriverState *retval = NULL; | |
4284 | ||
4285 | if (!bs || !bs->drv || !backing_file) { | |
e8a6bb9c MT |
4286 | return NULL; |
4287 | } | |
4288 | ||
b1b1d783 JC |
4289 | filename_full = g_malloc(PATH_MAX); |
4290 | backing_file_full = g_malloc(PATH_MAX); | |
4291 | filename_tmp = g_malloc(PATH_MAX); | |
4292 | ||
4293 | is_protocol = path_has_protocol(backing_file); | |
4294 | ||
4295 | for (curr_bs = bs; curr_bs->backing_hd; curr_bs = curr_bs->backing_hd) { | |
4296 | ||
4297 | /* If either of the filename paths is actually a protocol, then | |
4298 | * compare unmodified paths; otherwise make paths relative */ | |
4299 | if (is_protocol || path_has_protocol(curr_bs->backing_file)) { | |
4300 | if (strcmp(backing_file, curr_bs->backing_file) == 0) { | |
4301 | retval = curr_bs->backing_hd; | |
4302 | break; | |
4303 | } | |
e8a6bb9c | 4304 | } else { |
b1b1d783 JC |
4305 | /* If not an absolute filename path, make it relative to the current |
4306 | * image's filename path */ | |
4307 | path_combine(filename_tmp, PATH_MAX, curr_bs->filename, | |
4308 | backing_file); | |
4309 | ||
4310 | /* We are going to compare absolute pathnames */ | |
4311 | if (!realpath(filename_tmp, filename_full)) { | |
4312 | continue; | |
4313 | } | |
4314 | ||
4315 | /* We need to make sure the backing filename we are comparing against | |
4316 | * is relative to the current image filename (or absolute) */ | |
4317 | path_combine(filename_tmp, PATH_MAX, curr_bs->filename, | |
4318 | curr_bs->backing_file); | |
4319 | ||
4320 | if (!realpath(filename_tmp, backing_file_full)) { | |
4321 | continue; | |
4322 | } | |
4323 | ||
4324 | if (strcmp(backing_file_full, filename_full) == 0) { | |
4325 | retval = curr_bs->backing_hd; | |
4326 | break; | |
4327 | } | |
e8a6bb9c MT |
4328 | } |
4329 | } | |
4330 | ||
b1b1d783 JC |
4331 | g_free(filename_full); |
4332 | g_free(backing_file_full); | |
4333 | g_free(filename_tmp); | |
4334 | return retval; | |
e8a6bb9c MT |
4335 | } |
4336 | ||
f198fd1c BC |
4337 | int bdrv_get_backing_file_depth(BlockDriverState *bs) |
4338 | { | |
4339 | if (!bs->drv) { | |
4340 | return 0; | |
4341 | } | |
4342 | ||
4343 | if (!bs->backing_hd) { | |
4344 | return 0; | |
4345 | } | |
4346 | ||
4347 | return 1 + bdrv_get_backing_file_depth(bs->backing_hd); | |
4348 | } | |
4349 | ||
ea2384d3 | 4350 | /**************************************************************/ |
83f64091 | 4351 | /* async I/Os */ |
ea2384d3 | 4352 | |
7c84b1b8 MA |
4353 | BlockAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num, |
4354 | QEMUIOVector *qiov, int nb_sectors, | |
097310b5 | 4355 | BlockCompletionFunc *cb, void *opaque) |
83f64091 | 4356 | { |
bbf0a440 SH |
4357 | trace_bdrv_aio_readv(bs, sector_num, nb_sectors, opaque); |
4358 | ||
d20d9b7c | 4359 | return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors, 0, |
8c5873d6 | 4360 | cb, opaque, false); |
ea2384d3 FB |
4361 | } |
4362 | ||
7c84b1b8 MA |
4363 | BlockAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num, |
4364 | QEMUIOVector *qiov, int nb_sectors, | |
097310b5 | 4365 | BlockCompletionFunc *cb, void *opaque) |
ea2384d3 | 4366 | { |
bbf0a440 SH |
4367 | trace_bdrv_aio_writev(bs, sector_num, nb_sectors, opaque); |
4368 | ||
d20d9b7c | 4369 | return bdrv_co_aio_rw_vector(bs, sector_num, qiov, nb_sectors, 0, |
8c5873d6 | 4370 | cb, opaque, true); |
83f64091 FB |
4371 | } |
4372 | ||
7c84b1b8 | 4373 | BlockAIOCB *bdrv_aio_write_zeroes(BlockDriverState *bs, |
d5ef94d4 | 4374 | int64_t sector_num, int nb_sectors, BdrvRequestFlags flags, |
097310b5 | 4375 | BlockCompletionFunc *cb, void *opaque) |
d5ef94d4 PB |
4376 | { |
4377 | trace_bdrv_aio_write_zeroes(bs, sector_num, nb_sectors, flags, opaque); | |
4378 | ||
4379 | return bdrv_co_aio_rw_vector(bs, sector_num, NULL, nb_sectors, | |
4380 | BDRV_REQ_ZERO_WRITE | flags, | |
4381 | cb, opaque, true); | |
4382 | } | |
4383 | ||
40b4f539 KW |
4384 | |
4385 | typedef struct MultiwriteCB { | |
4386 | int error; | |
4387 | int num_requests; | |
4388 | int num_callbacks; | |
4389 | struct { | |
097310b5 | 4390 | BlockCompletionFunc *cb; |
40b4f539 KW |
4391 | void *opaque; |
4392 | QEMUIOVector *free_qiov; | |
40b4f539 KW |
4393 | } callbacks[]; |
4394 | } MultiwriteCB; | |
4395 | ||
4396 | static void multiwrite_user_cb(MultiwriteCB *mcb) | |
4397 | { | |
4398 | int i; | |
4399 | ||
4400 | for (i = 0; i < mcb->num_callbacks; i++) { | |
4401 | mcb->callbacks[i].cb(mcb->callbacks[i].opaque, mcb->error); | |
1e1ea48d SH |
4402 | if (mcb->callbacks[i].free_qiov) { |
4403 | qemu_iovec_destroy(mcb->callbacks[i].free_qiov); | |
4404 | } | |
7267c094 | 4405 | g_free(mcb->callbacks[i].free_qiov); |
40b4f539 KW |
4406 | } |
4407 | } | |
4408 | ||
4409 | static void multiwrite_cb(void *opaque, int ret) | |
4410 | { | |
4411 | MultiwriteCB *mcb = opaque; | |
4412 | ||
6d519a5f SH |
4413 | trace_multiwrite_cb(mcb, ret); |
4414 | ||
cb6d3ca0 | 4415 | if (ret < 0 && !mcb->error) { |
40b4f539 | 4416 | mcb->error = ret; |
40b4f539 KW |
4417 | } |
4418 | ||
4419 | mcb->num_requests--; | |
4420 | if (mcb->num_requests == 0) { | |
de189a1b | 4421 | multiwrite_user_cb(mcb); |
7267c094 | 4422 | g_free(mcb); |
40b4f539 KW |
4423 | } |
4424 | } | |
4425 | ||
4426 | static int multiwrite_req_compare(const void *a, const void *b) | |
4427 | { | |
77be4366 CH |
4428 | const BlockRequest *req1 = a, *req2 = b; |
4429 | ||
4430 | /* | |
4431 | * Note that we can't simply subtract req2->sector from req1->sector | |
4432 | * here as that could overflow the return value. | |
4433 | */ | |
4434 | if (req1->sector > req2->sector) { | |
4435 | return 1; | |
4436 | } else if (req1->sector < req2->sector) { | |
4437 | return -1; | |
4438 | } else { | |
4439 | return 0; | |
4440 | } | |
40b4f539 KW |
4441 | } |
4442 | ||
4443 | /* | |
4444 | * Takes a bunch of requests and tries to merge them. Returns the number of | |
4445 | * requests that remain after merging. | |
4446 | */ | |
4447 | static int multiwrite_merge(BlockDriverState *bs, BlockRequest *reqs, | |
4448 | int num_reqs, MultiwriteCB *mcb) | |
4449 | { | |
4450 | int i, outidx; | |
4451 | ||
4452 | // Sort requests by start sector | |
4453 | qsort(reqs, num_reqs, sizeof(*reqs), &multiwrite_req_compare); | |
4454 | ||
4455 | // Check if adjacent requests touch the same clusters. If so, combine them, | |
4456 | // filling up gaps with zero sectors. | |
4457 | outidx = 0; | |
4458 | for (i = 1; i < num_reqs; i++) { | |
4459 | int merge = 0; | |
4460 | int64_t oldreq_last = reqs[outidx].sector + reqs[outidx].nb_sectors; | |
4461 | ||
b6a127a1 | 4462 | // Handle exactly sequential writes and overlapping writes. |
40b4f539 KW |
4463 | if (reqs[i].sector <= oldreq_last) { |
4464 | merge = 1; | |
4465 | } | |
4466 | ||
e2a305fb CH |
4467 | if (reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1 > IOV_MAX) { |
4468 | merge = 0; | |
4469 | } | |
4470 | ||
6c5a42ac PL |
4471 | if (bs->bl.max_transfer_length && reqs[outidx].nb_sectors + |
4472 | reqs[i].nb_sectors > bs->bl.max_transfer_length) { | |
4473 | merge = 0; | |
4474 | } | |
4475 | ||
40b4f539 KW |
4476 | if (merge) { |
4477 | size_t size; | |
7267c094 | 4478 | QEMUIOVector *qiov = g_malloc0(sizeof(*qiov)); |
40b4f539 KW |
4479 | qemu_iovec_init(qiov, |
4480 | reqs[outidx].qiov->niov + reqs[i].qiov->niov + 1); | |
4481 | ||
4482 | // Add the first request to the merged one. If the requests are | |
4483 | // overlapping, drop the last sectors of the first request. | |
4484 | size = (reqs[i].sector - reqs[outidx].sector) << 9; | |
1b093c48 | 4485 | qemu_iovec_concat(qiov, reqs[outidx].qiov, 0, size); |
40b4f539 | 4486 | |
b6a127a1 PB |
4487 | // We should need to add any zeros between the two requests |
4488 | assert (reqs[i].sector <= oldreq_last); | |
40b4f539 KW |
4489 | |
4490 | // Add the second request | |
1b093c48 | 4491 | qemu_iovec_concat(qiov, reqs[i].qiov, 0, reqs[i].qiov->size); |
40b4f539 | 4492 | |
391827eb SH |
4493 | // Add tail of first request, if necessary |
4494 | if (qiov->size < reqs[outidx].qiov->size) { | |
4495 | qemu_iovec_concat(qiov, reqs[outidx].qiov, qiov->size, | |
4496 | reqs[outidx].qiov->size - qiov->size); | |
4497 | } | |
4498 | ||
cbf1dff2 | 4499 | reqs[outidx].nb_sectors = qiov->size >> 9; |
40b4f539 KW |
4500 | reqs[outidx].qiov = qiov; |
4501 | ||
4502 | mcb->callbacks[i].free_qiov = reqs[outidx].qiov; | |
4503 | } else { | |
4504 | outidx++; | |
4505 | reqs[outidx].sector = reqs[i].sector; | |
4506 | reqs[outidx].nb_sectors = reqs[i].nb_sectors; | |
4507 | reqs[outidx].qiov = reqs[i].qiov; | |
4508 | } | |
4509 | } | |
4510 | ||
4511 | return outidx + 1; | |
4512 | } | |
4513 | ||
4514 | /* | |
4515 | * Submit multiple AIO write requests at once. | |
4516 | * | |
4517 | * On success, the function returns 0 and all requests in the reqs array have | |
4518 | * been submitted. In error case this function returns -1, and any of the | |
4519 | * requests may or may not be submitted yet. In particular, this means that the | |
4520 | * callback will be called for some of the requests, for others it won't. The | |
4521 | * caller must check the error field of the BlockRequest to wait for the right | |
4522 | * callbacks (if error != 0, no callback will be called). | |
4523 | * | |
4524 | * The implementation may modify the contents of the reqs array, e.g. to merge | |
4525 | * requests. However, the fields opaque and error are left unmodified as they | |
4526 | * are used to signal failure for a single request to the caller. | |
4527 | */ | |
4528 | int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs, int num_reqs) | |
4529 | { | |
40b4f539 KW |
4530 | MultiwriteCB *mcb; |
4531 | int i; | |
4532 | ||
301db7c2 RH |
4533 | /* don't submit writes if we don't have a medium */ |
4534 | if (bs->drv == NULL) { | |
4535 | for (i = 0; i < num_reqs; i++) { | |
4536 | reqs[i].error = -ENOMEDIUM; | |
4537 | } | |
4538 | return -1; | |
4539 | } | |
4540 | ||
40b4f539 KW |
4541 | if (num_reqs == 0) { |
4542 | return 0; | |
4543 | } | |
4544 | ||
4545 | // Create MultiwriteCB structure | |
7267c094 | 4546 | mcb = g_malloc0(sizeof(*mcb) + num_reqs * sizeof(*mcb->callbacks)); |
40b4f539 KW |
4547 | mcb->num_requests = 0; |
4548 | mcb->num_callbacks = num_reqs; | |
4549 | ||
4550 | for (i = 0; i < num_reqs; i++) { | |
4551 | mcb->callbacks[i].cb = reqs[i].cb; | |
4552 | mcb->callbacks[i].opaque = reqs[i].opaque; | |
4553 | } | |
4554 | ||
4555 | // Check for mergable requests | |
4556 | num_reqs = multiwrite_merge(bs, reqs, num_reqs, mcb); | |
4557 | ||
6d519a5f SH |
4558 | trace_bdrv_aio_multiwrite(mcb, mcb->num_callbacks, num_reqs); |
4559 | ||
df9309fb PB |
4560 | /* Run the aio requests. */ |
4561 | mcb->num_requests = num_reqs; | |
40b4f539 | 4562 | for (i = 0; i < num_reqs; i++) { |
d20d9b7c PB |
4563 | bdrv_co_aio_rw_vector(bs, reqs[i].sector, reqs[i].qiov, |
4564 | reqs[i].nb_sectors, reqs[i].flags, | |
4565 | multiwrite_cb, mcb, | |
4566 | true); | |
40b4f539 KW |
4567 | } |
4568 | ||
4569 | return 0; | |
40b4f539 KW |
4570 | } |
4571 | ||
7c84b1b8 | 4572 | void bdrv_aio_cancel(BlockAIOCB *acb) |
83f64091 | 4573 | { |
ca5fd113 FZ |
4574 | qemu_aio_ref(acb); |
4575 | bdrv_aio_cancel_async(acb); | |
4576 | while (acb->refcnt > 1) { | |
4577 | if (acb->aiocb_info->get_aio_context) { | |
4578 | aio_poll(acb->aiocb_info->get_aio_context(acb), true); | |
4579 | } else if (acb->bs) { | |
4580 | aio_poll(bdrv_get_aio_context(acb->bs), true); | |
4581 | } else { | |
4582 | abort(); | |
02c50efe | 4583 | } |
02c50efe | 4584 | } |
8007429a | 4585 | qemu_aio_unref(acb); |
02c50efe FZ |
4586 | } |
4587 | ||
4588 | /* Async version of aio cancel. The caller is not blocked if the acb implements | |
4589 | * cancel_async, otherwise we do nothing and let the request normally complete. | |
4590 | * In either case the completion callback must be called. */ | |
7c84b1b8 | 4591 | void bdrv_aio_cancel_async(BlockAIOCB *acb) |
02c50efe FZ |
4592 | { |
4593 | if (acb->aiocb_info->cancel_async) { | |
4594 | acb->aiocb_info->cancel_async(acb); | |
4595 | } | |
83f64091 FB |
4596 | } |
4597 | ||
4598 | /**************************************************************/ | |
4599 | /* async block device emulation */ | |
4600 | ||
7c84b1b8 MA |
4601 | typedef struct BlockAIOCBSync { |
4602 | BlockAIOCB common; | |
c16b5a2c CH |
4603 | QEMUBH *bh; |
4604 | int ret; | |
4605 | /* vector translation state */ | |
4606 | QEMUIOVector *qiov; | |
4607 | uint8_t *bounce; | |
4608 | int is_write; | |
7c84b1b8 | 4609 | } BlockAIOCBSync; |
c16b5a2c | 4610 | |
d7331bed | 4611 | static const AIOCBInfo bdrv_em_aiocb_info = { |
7c84b1b8 | 4612 | .aiocb_size = sizeof(BlockAIOCBSync), |
c16b5a2c CH |
4613 | }; |
4614 | ||
ce1a14dc | 4615 | static void bdrv_aio_bh_cb(void *opaque) |
83f64091 | 4616 | { |
7c84b1b8 | 4617 | BlockAIOCBSync *acb = opaque; |
f141eafe | 4618 | |
857d4f46 | 4619 | if (!acb->is_write && acb->ret >= 0) { |
03396148 | 4620 | qemu_iovec_from_buf(acb->qiov, 0, acb->bounce, acb->qiov->size); |
857d4f46 | 4621 | } |
ceb42de8 | 4622 | qemu_vfree(acb->bounce); |
ce1a14dc | 4623 | acb->common.cb(acb->common.opaque, acb->ret); |
6a7ad299 | 4624 | qemu_bh_delete(acb->bh); |
36afc451 | 4625 | acb->bh = NULL; |
8007429a | 4626 | qemu_aio_unref(acb); |
83f64091 | 4627 | } |
beac80cd | 4628 | |
7c84b1b8 MA |
4629 | static BlockAIOCB *bdrv_aio_rw_vector(BlockDriverState *bs, |
4630 | int64_t sector_num, | |
4631 | QEMUIOVector *qiov, | |
4632 | int nb_sectors, | |
097310b5 | 4633 | BlockCompletionFunc *cb, |
7c84b1b8 MA |
4634 | void *opaque, |
4635 | int is_write) | |
f141eafe | 4636 | |
83f64091 | 4637 | { |
7c84b1b8 | 4638 | BlockAIOCBSync *acb; |
ce1a14dc | 4639 | |
d7331bed | 4640 | acb = qemu_aio_get(&bdrv_em_aiocb_info, bs, cb, opaque); |
f141eafe AL |
4641 | acb->is_write = is_write; |
4642 | acb->qiov = qiov; | |
857d4f46 | 4643 | acb->bounce = qemu_try_blockalign(bs, qiov->size); |
2572b37a | 4644 | acb->bh = aio_bh_new(bdrv_get_aio_context(bs), bdrv_aio_bh_cb, acb); |
f141eafe | 4645 | |
857d4f46 KW |
4646 | if (acb->bounce == NULL) { |
4647 | acb->ret = -ENOMEM; | |
4648 | } else if (is_write) { | |
d5e6b161 | 4649 | qemu_iovec_to_buf(acb->qiov, 0, acb->bounce, qiov->size); |
1ed20acf | 4650 | acb->ret = bs->drv->bdrv_write(bs, sector_num, acb->bounce, nb_sectors); |
f141eafe | 4651 | } else { |
1ed20acf | 4652 | acb->ret = bs->drv->bdrv_read(bs, sector_num, acb->bounce, nb_sectors); |
f141eafe AL |
4653 | } |
4654 | ||
ce1a14dc | 4655 | qemu_bh_schedule(acb->bh); |
f141eafe | 4656 | |
ce1a14dc | 4657 | return &acb->common; |
beac80cd FB |
4658 | } |
4659 | ||
7c84b1b8 | 4660 | static BlockAIOCB *bdrv_aio_readv_em(BlockDriverState *bs, |
f141eafe | 4661 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, |
097310b5 | 4662 | BlockCompletionFunc *cb, void *opaque) |
beac80cd | 4663 | { |
f141eafe AL |
4664 | return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 0); |
4665 | } | |
83f64091 | 4666 | |
7c84b1b8 | 4667 | static BlockAIOCB *bdrv_aio_writev_em(BlockDriverState *bs, |
f141eafe | 4668 | int64_t sector_num, QEMUIOVector *qiov, int nb_sectors, |
097310b5 | 4669 | BlockCompletionFunc *cb, void *opaque) |
f141eafe AL |
4670 | { |
4671 | return bdrv_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 1); | |
beac80cd | 4672 | } |
beac80cd | 4673 | |
68485420 | 4674 | |
7c84b1b8 MA |
4675 | typedef struct BlockAIOCBCoroutine { |
4676 | BlockAIOCB common; | |
68485420 KW |
4677 | BlockRequest req; |
4678 | bool is_write; | |
d318aea9 | 4679 | bool *done; |
68485420 | 4680 | QEMUBH* bh; |
7c84b1b8 | 4681 | } BlockAIOCBCoroutine; |
68485420 | 4682 | |
d7331bed | 4683 | static const AIOCBInfo bdrv_em_co_aiocb_info = { |
7c84b1b8 | 4684 | .aiocb_size = sizeof(BlockAIOCBCoroutine), |
68485420 KW |
4685 | }; |
4686 | ||
35246a68 | 4687 | static void bdrv_co_em_bh(void *opaque) |
68485420 | 4688 | { |
7c84b1b8 | 4689 | BlockAIOCBCoroutine *acb = opaque; |
68485420 KW |
4690 | |
4691 | acb->common.cb(acb->common.opaque, acb->req.error); | |
d318aea9 | 4692 | |
68485420 | 4693 | qemu_bh_delete(acb->bh); |
8007429a | 4694 | qemu_aio_unref(acb); |
68485420 KW |
4695 | } |
4696 | ||
b2a61371 SH |
4697 | /* Invoke bdrv_co_do_readv/bdrv_co_do_writev */ |
4698 | static void coroutine_fn bdrv_co_do_rw(void *opaque) | |
4699 | { | |
7c84b1b8 | 4700 | BlockAIOCBCoroutine *acb = opaque; |
b2a61371 SH |
4701 | BlockDriverState *bs = acb->common.bs; |
4702 | ||
4703 | if (!acb->is_write) { | |
4704 | acb->req.error = bdrv_co_do_readv(bs, acb->req.sector, | |
d20d9b7c | 4705 | acb->req.nb_sectors, acb->req.qiov, acb->req.flags); |
b2a61371 SH |
4706 | } else { |
4707 | acb->req.error = bdrv_co_do_writev(bs, acb->req.sector, | |
d20d9b7c | 4708 | acb->req.nb_sectors, acb->req.qiov, acb->req.flags); |
b2a61371 SH |
4709 | } |
4710 | ||
2572b37a | 4711 | acb->bh = aio_bh_new(bdrv_get_aio_context(bs), bdrv_co_em_bh, acb); |
b2a61371 SH |
4712 | qemu_bh_schedule(acb->bh); |
4713 | } | |
4714 | ||
7c84b1b8 MA |
4715 | static BlockAIOCB *bdrv_co_aio_rw_vector(BlockDriverState *bs, |
4716 | int64_t sector_num, | |
4717 | QEMUIOVector *qiov, | |
4718 | int nb_sectors, | |
4719 | BdrvRequestFlags flags, | |
097310b5 | 4720 | BlockCompletionFunc *cb, |
7c84b1b8 MA |
4721 | void *opaque, |
4722 | bool is_write) | |
68485420 KW |
4723 | { |
4724 | Coroutine *co; | |
7c84b1b8 | 4725 | BlockAIOCBCoroutine *acb; |
68485420 | 4726 | |
d7331bed | 4727 | acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque); |
68485420 KW |
4728 | acb->req.sector = sector_num; |
4729 | acb->req.nb_sectors = nb_sectors; | |
4730 | acb->req.qiov = qiov; | |
d20d9b7c | 4731 | acb->req.flags = flags; |
68485420 KW |
4732 | acb->is_write = is_write; |
4733 | ||
8c5873d6 | 4734 | co = qemu_coroutine_create(bdrv_co_do_rw); |
68485420 KW |
4735 | qemu_coroutine_enter(co, acb); |
4736 | ||
4737 | return &acb->common; | |
4738 | } | |
4739 | ||
07f07615 | 4740 | static void coroutine_fn bdrv_aio_flush_co_entry(void *opaque) |
b2e12bc6 | 4741 | { |
7c84b1b8 | 4742 | BlockAIOCBCoroutine *acb = opaque; |
07f07615 | 4743 | BlockDriverState *bs = acb->common.bs; |
b2e12bc6 | 4744 | |
07f07615 | 4745 | acb->req.error = bdrv_co_flush(bs); |
2572b37a | 4746 | acb->bh = aio_bh_new(bdrv_get_aio_context(bs), bdrv_co_em_bh, acb); |
b2e12bc6 | 4747 | qemu_bh_schedule(acb->bh); |
b2e12bc6 CH |
4748 | } |
4749 | ||
7c84b1b8 | 4750 | BlockAIOCB *bdrv_aio_flush(BlockDriverState *bs, |
097310b5 | 4751 | BlockCompletionFunc *cb, void *opaque) |
016f5cf6 | 4752 | { |
07f07615 | 4753 | trace_bdrv_aio_flush(bs, opaque); |
016f5cf6 | 4754 | |
07f07615 | 4755 | Coroutine *co; |
7c84b1b8 | 4756 | BlockAIOCBCoroutine *acb; |
016f5cf6 | 4757 | |
d7331bed | 4758 | acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque); |
d318aea9 | 4759 | |
07f07615 PB |
4760 | co = qemu_coroutine_create(bdrv_aio_flush_co_entry); |
4761 | qemu_coroutine_enter(co, acb); | |
016f5cf6 | 4762 | |
016f5cf6 AG |
4763 | return &acb->common; |
4764 | } | |
4765 | ||
4265d620 PB |
4766 | static void coroutine_fn bdrv_aio_discard_co_entry(void *opaque) |
4767 | { | |
7c84b1b8 | 4768 | BlockAIOCBCoroutine *acb = opaque; |
4265d620 PB |
4769 | BlockDriverState *bs = acb->common.bs; |
4770 | ||
4771 | acb->req.error = bdrv_co_discard(bs, acb->req.sector, acb->req.nb_sectors); | |
2572b37a | 4772 | acb->bh = aio_bh_new(bdrv_get_aio_context(bs), bdrv_co_em_bh, acb); |
4265d620 PB |
4773 | qemu_bh_schedule(acb->bh); |
4774 | } | |
4775 | ||
7c84b1b8 | 4776 | BlockAIOCB *bdrv_aio_discard(BlockDriverState *bs, |
4265d620 | 4777 | int64_t sector_num, int nb_sectors, |
097310b5 | 4778 | BlockCompletionFunc *cb, void *opaque) |
4265d620 PB |
4779 | { |
4780 | Coroutine *co; | |
7c84b1b8 | 4781 | BlockAIOCBCoroutine *acb; |
4265d620 PB |
4782 | |
4783 | trace_bdrv_aio_discard(bs, sector_num, nb_sectors, opaque); | |
4784 | ||
d7331bed | 4785 | acb = qemu_aio_get(&bdrv_em_co_aiocb_info, bs, cb, opaque); |
4265d620 PB |
4786 | acb->req.sector = sector_num; |
4787 | acb->req.nb_sectors = nb_sectors; | |
4788 | co = qemu_coroutine_create(bdrv_aio_discard_co_entry); | |
4789 | qemu_coroutine_enter(co, acb); | |
4790 | ||
4791 | return &acb->common; | |
4792 | } | |
4793 | ||
ea2384d3 FB |
4794 | void bdrv_init(void) |
4795 | { | |
5efa9d5a | 4796 | module_call_init(MODULE_INIT_BLOCK); |
ea2384d3 | 4797 | } |
ce1a14dc | 4798 | |
eb852011 MA |
4799 | void bdrv_init_with_whitelist(void) |
4800 | { | |
4801 | use_bdrv_whitelist = 1; | |
4802 | bdrv_init(); | |
4803 | } | |
4804 | ||
d7331bed | 4805 | void *qemu_aio_get(const AIOCBInfo *aiocb_info, BlockDriverState *bs, |
097310b5 | 4806 | BlockCompletionFunc *cb, void *opaque) |
ce1a14dc | 4807 | { |
7c84b1b8 | 4808 | BlockAIOCB *acb; |
ce1a14dc | 4809 | |
d7331bed SH |
4810 | acb = g_slice_alloc(aiocb_info->aiocb_size); |
4811 | acb->aiocb_info = aiocb_info; | |
ce1a14dc PB |
4812 | acb->bs = bs; |
4813 | acb->cb = cb; | |
4814 | acb->opaque = opaque; | |
f197fe2b | 4815 | acb->refcnt = 1; |
ce1a14dc PB |
4816 | return acb; |
4817 | } | |
4818 | ||
f197fe2b FZ |
4819 | void qemu_aio_ref(void *p) |
4820 | { | |
7c84b1b8 | 4821 | BlockAIOCB *acb = p; |
f197fe2b FZ |
4822 | acb->refcnt++; |
4823 | } | |
4824 | ||
8007429a | 4825 | void qemu_aio_unref(void *p) |
ce1a14dc | 4826 | { |
7c84b1b8 | 4827 | BlockAIOCB *acb = p; |
f197fe2b FZ |
4828 | assert(acb->refcnt > 0); |
4829 | if (--acb->refcnt == 0) { | |
4830 | g_slice_free1(acb->aiocb_info->aiocb_size, acb); | |
4831 | } | |
ce1a14dc | 4832 | } |
19cb3738 | 4833 | |
f9f05dc5 KW |
4834 | /**************************************************************/ |
4835 | /* Coroutine block device emulation */ | |
4836 | ||
4837 | typedef struct CoroutineIOCompletion { | |
4838 | Coroutine *coroutine; | |
4839 | int ret; | |
4840 | } CoroutineIOCompletion; | |
4841 | ||
4842 | static void bdrv_co_io_em_complete(void *opaque, int ret) | |
4843 | { | |
4844 | CoroutineIOCompletion *co = opaque; | |
4845 | ||
4846 | co->ret = ret; | |
4847 | qemu_coroutine_enter(co->coroutine, NULL); | |
4848 | } | |
4849 | ||
4850 | static int coroutine_fn bdrv_co_io_em(BlockDriverState *bs, int64_t sector_num, | |
4851 | int nb_sectors, QEMUIOVector *iov, | |
4852 | bool is_write) | |
4853 | { | |
4854 | CoroutineIOCompletion co = { | |
4855 | .coroutine = qemu_coroutine_self(), | |
4856 | }; | |
7c84b1b8 | 4857 | BlockAIOCB *acb; |
f9f05dc5 KW |
4858 | |
4859 | if (is_write) { | |
a652d160 SH |
4860 | acb = bs->drv->bdrv_aio_writev(bs, sector_num, iov, nb_sectors, |
4861 | bdrv_co_io_em_complete, &co); | |
f9f05dc5 | 4862 | } else { |
a652d160 SH |
4863 | acb = bs->drv->bdrv_aio_readv(bs, sector_num, iov, nb_sectors, |
4864 | bdrv_co_io_em_complete, &co); | |
f9f05dc5 KW |
4865 | } |
4866 | ||
59370aaa | 4867 | trace_bdrv_co_io_em(bs, sector_num, nb_sectors, is_write, acb); |
f9f05dc5 KW |
4868 | if (!acb) { |
4869 | return -EIO; | |
4870 | } | |
4871 | qemu_coroutine_yield(); | |
4872 | ||
4873 | return co.ret; | |
4874 | } | |
4875 | ||
4876 | static int coroutine_fn bdrv_co_readv_em(BlockDriverState *bs, | |
4877 | int64_t sector_num, int nb_sectors, | |
4878 | QEMUIOVector *iov) | |
4879 | { | |
4880 | return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, false); | |
4881 | } | |
4882 | ||
4883 | static int coroutine_fn bdrv_co_writev_em(BlockDriverState *bs, | |
4884 | int64_t sector_num, int nb_sectors, | |
4885 | QEMUIOVector *iov) | |
4886 | { | |
4887 | return bdrv_co_io_em(bs, sector_num, nb_sectors, iov, true); | |
4888 | } | |
4889 | ||
07f07615 | 4890 | static void coroutine_fn bdrv_flush_co_entry(void *opaque) |
e7a8a783 | 4891 | { |
07f07615 PB |
4892 | RwCo *rwco = opaque; |
4893 | ||
4894 | rwco->ret = bdrv_co_flush(rwco->bs); | |
4895 | } | |
4896 | ||
4897 | int coroutine_fn bdrv_co_flush(BlockDriverState *bs) | |
4898 | { | |
eb489bb1 KW |
4899 | int ret; |
4900 | ||
29cdb251 | 4901 | if (!bs || !bdrv_is_inserted(bs) || bdrv_is_read_only(bs)) { |
07f07615 | 4902 | return 0; |
eb489bb1 KW |
4903 | } |
4904 | ||
ca716364 | 4905 | /* Write back cached data to the OS even with cache=unsafe */ |
bf736fe3 | 4906 | BLKDBG_EVENT(bs->file, BLKDBG_FLUSH_TO_OS); |
eb489bb1 KW |
4907 | if (bs->drv->bdrv_co_flush_to_os) { |
4908 | ret = bs->drv->bdrv_co_flush_to_os(bs); | |
4909 | if (ret < 0) { | |
4910 | return ret; | |
4911 | } | |
4912 | } | |
4913 | ||
ca716364 KW |
4914 | /* But don't actually force it to the disk with cache=unsafe */ |
4915 | if (bs->open_flags & BDRV_O_NO_FLUSH) { | |
d4c82329 | 4916 | goto flush_parent; |
ca716364 KW |
4917 | } |
4918 | ||
bf736fe3 | 4919 | BLKDBG_EVENT(bs->file, BLKDBG_FLUSH_TO_DISK); |
eb489bb1 | 4920 | if (bs->drv->bdrv_co_flush_to_disk) { |
29cdb251 | 4921 | ret = bs->drv->bdrv_co_flush_to_disk(bs); |
07f07615 | 4922 | } else if (bs->drv->bdrv_aio_flush) { |
7c84b1b8 | 4923 | BlockAIOCB *acb; |
07f07615 PB |
4924 | CoroutineIOCompletion co = { |
4925 | .coroutine = qemu_coroutine_self(), | |
4926 | }; | |
4927 | ||
4928 | acb = bs->drv->bdrv_aio_flush(bs, bdrv_co_io_em_complete, &co); | |
4929 | if (acb == NULL) { | |
29cdb251 | 4930 | ret = -EIO; |
07f07615 PB |
4931 | } else { |
4932 | qemu_coroutine_yield(); | |
29cdb251 | 4933 | ret = co.ret; |
07f07615 | 4934 | } |
07f07615 PB |
4935 | } else { |
4936 | /* | |
4937 | * Some block drivers always operate in either writethrough or unsafe | |
4938 | * mode and don't support bdrv_flush therefore. Usually qemu doesn't | |
4939 | * know how the server works (because the behaviour is hardcoded or | |
4940 | * depends on server-side configuration), so we can't ensure that | |
4941 | * everything is safe on disk. Returning an error doesn't work because | |
4942 | * that would break guests even if the server operates in writethrough | |
4943 | * mode. | |
4944 | * | |
4945 | * Let's hope the user knows what he's doing. | |
4946 | */ | |
29cdb251 | 4947 | ret = 0; |
07f07615 | 4948 | } |
29cdb251 PB |
4949 | if (ret < 0) { |
4950 | return ret; | |
4951 | } | |
4952 | ||
4953 | /* Now flush the underlying protocol. It will also have BDRV_O_NO_FLUSH | |
4954 | * in the case of cache=unsafe, so there are no useless flushes. | |
4955 | */ | |
d4c82329 | 4956 | flush_parent: |
29cdb251 | 4957 | return bdrv_co_flush(bs->file); |
07f07615 PB |
4958 | } |
4959 | ||
5a8a30db | 4960 | void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp) |
0f15423c | 4961 | { |
5a8a30db KW |
4962 | Error *local_err = NULL; |
4963 | int ret; | |
4964 | ||
3456a8d1 KW |
4965 | if (!bs->drv) { |
4966 | return; | |
4967 | } | |
4968 | ||
7ea2d269 AK |
4969 | if (!(bs->open_flags & BDRV_O_INCOMING)) { |
4970 | return; | |
4971 | } | |
4972 | bs->open_flags &= ~BDRV_O_INCOMING; | |
4973 | ||
3456a8d1 | 4974 | if (bs->drv->bdrv_invalidate_cache) { |
5a8a30db | 4975 | bs->drv->bdrv_invalidate_cache(bs, &local_err); |
3456a8d1 | 4976 | } else if (bs->file) { |
5a8a30db KW |
4977 | bdrv_invalidate_cache(bs->file, &local_err); |
4978 | } | |
4979 | if (local_err) { | |
4980 | error_propagate(errp, local_err); | |
4981 | return; | |
0f15423c | 4982 | } |
3456a8d1 | 4983 | |
5a8a30db KW |
4984 | ret = refresh_total_sectors(bs, bs->total_sectors); |
4985 | if (ret < 0) { | |
4986 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); | |
4987 | return; | |
4988 | } | |
0f15423c AL |
4989 | } |
4990 | ||
5a8a30db | 4991 | void bdrv_invalidate_cache_all(Error **errp) |
0f15423c AL |
4992 | { |
4993 | BlockDriverState *bs; | |
5a8a30db | 4994 | Error *local_err = NULL; |
0f15423c | 4995 | |
dc364f4c | 4996 | QTAILQ_FOREACH(bs, &bdrv_states, device_list) { |
ed78cda3 SH |
4997 | AioContext *aio_context = bdrv_get_aio_context(bs); |
4998 | ||
4999 | aio_context_acquire(aio_context); | |
5a8a30db | 5000 | bdrv_invalidate_cache(bs, &local_err); |
ed78cda3 | 5001 | aio_context_release(aio_context); |
5a8a30db KW |
5002 | if (local_err) { |
5003 | error_propagate(errp, local_err); | |
5004 | return; | |
5005 | } | |
0f15423c AL |
5006 | } |
5007 | } | |
5008 | ||
07f07615 PB |
5009 | int bdrv_flush(BlockDriverState *bs) |
5010 | { | |
5011 | Coroutine *co; | |
5012 | RwCo rwco = { | |
5013 | .bs = bs, | |
5014 | .ret = NOT_DONE, | |
e7a8a783 | 5015 | }; |
e7a8a783 | 5016 | |
07f07615 PB |
5017 | if (qemu_in_coroutine()) { |
5018 | /* Fast-path if already in coroutine context */ | |
5019 | bdrv_flush_co_entry(&rwco); | |
5020 | } else { | |
2572b37a SH |
5021 | AioContext *aio_context = bdrv_get_aio_context(bs); |
5022 | ||
07f07615 PB |
5023 | co = qemu_coroutine_create(bdrv_flush_co_entry); |
5024 | qemu_coroutine_enter(co, &rwco); | |
5025 | while (rwco.ret == NOT_DONE) { | |
2572b37a | 5026 | aio_poll(aio_context, true); |
07f07615 | 5027 | } |
e7a8a783 | 5028 | } |
07f07615 PB |
5029 | |
5030 | return rwco.ret; | |
e7a8a783 KW |
5031 | } |
5032 | ||
775aa8b6 KW |
5033 | typedef struct DiscardCo { |
5034 | BlockDriverState *bs; | |
5035 | int64_t sector_num; | |
5036 | int nb_sectors; | |
5037 | int ret; | |
5038 | } DiscardCo; | |
4265d620 PB |
5039 | static void coroutine_fn bdrv_discard_co_entry(void *opaque) |
5040 | { | |
775aa8b6 | 5041 | DiscardCo *rwco = opaque; |
4265d620 PB |
5042 | |
5043 | rwco->ret = bdrv_co_discard(rwco->bs, rwco->sector_num, rwco->nb_sectors); | |
5044 | } | |
5045 | ||
6f14da52 PL |
5046 | /* if no limit is specified in the BlockLimits use a default |
5047 | * of 32768 512-byte sectors (16 MiB) per request. | |
5048 | */ | |
5049 | #define MAX_DISCARD_DEFAULT 32768 | |
5050 | ||
4265d620 PB |
5051 | int coroutine_fn bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, |
5052 | int nb_sectors) | |
5053 | { | |
d51e9fe5 PB |
5054 | int max_discard; |
5055 | ||
4265d620 PB |
5056 | if (!bs->drv) { |
5057 | return -ENOMEDIUM; | |
5058 | } else if (bdrv_check_request(bs, sector_num, nb_sectors)) { | |
5059 | return -EIO; | |
5060 | } else if (bs->read_only) { | |
5061 | return -EROFS; | |
df702c9b PB |
5062 | } |
5063 | ||
e4654d2d | 5064 | bdrv_reset_dirty(bs, sector_num, nb_sectors); |
df702c9b | 5065 | |
9e8f1835 PB |
5066 | /* Do nothing if disabled. */ |
5067 | if (!(bs->open_flags & BDRV_O_UNMAP)) { | |
5068 | return 0; | |
5069 | } | |
5070 | ||
d51e9fe5 PB |
5071 | if (!bs->drv->bdrv_co_discard && !bs->drv->bdrv_aio_discard) { |
5072 | return 0; | |
5073 | } | |
6f14da52 | 5074 | |
d51e9fe5 PB |
5075 | max_discard = bs->bl.max_discard ? bs->bl.max_discard : MAX_DISCARD_DEFAULT; |
5076 | while (nb_sectors > 0) { | |
5077 | int ret; | |
5078 | int num = nb_sectors; | |
6f14da52 | 5079 | |
d51e9fe5 PB |
5080 | /* align request */ |
5081 | if (bs->bl.discard_alignment && | |
5082 | num >= bs->bl.discard_alignment && | |
5083 | sector_num % bs->bl.discard_alignment) { | |
5084 | if (num > bs->bl.discard_alignment) { | |
5085 | num = bs->bl.discard_alignment; | |
6f14da52 | 5086 | } |
d51e9fe5 PB |
5087 | num -= sector_num % bs->bl.discard_alignment; |
5088 | } | |
6f14da52 | 5089 | |
d51e9fe5 PB |
5090 | /* limit request size */ |
5091 | if (num > max_discard) { | |
5092 | num = max_discard; | |
5093 | } | |
6f14da52 | 5094 | |
d51e9fe5 | 5095 | if (bs->drv->bdrv_co_discard) { |
6f14da52 | 5096 | ret = bs->drv->bdrv_co_discard(bs, sector_num, num); |
d51e9fe5 | 5097 | } else { |
7c84b1b8 | 5098 | BlockAIOCB *acb; |
d51e9fe5 PB |
5099 | CoroutineIOCompletion co = { |
5100 | .coroutine = qemu_coroutine_self(), | |
5101 | }; | |
5102 | ||
5103 | acb = bs->drv->bdrv_aio_discard(bs, sector_num, nb_sectors, | |
5104 | bdrv_co_io_em_complete, &co); | |
5105 | if (acb == NULL) { | |
5106 | return -EIO; | |
5107 | } else { | |
5108 | qemu_coroutine_yield(); | |
5109 | ret = co.ret; | |
6f14da52 | 5110 | } |
6f14da52 | 5111 | } |
7ce21016 | 5112 | if (ret && ret != -ENOTSUP) { |
d51e9fe5 | 5113 | return ret; |
4265d620 | 5114 | } |
d51e9fe5 PB |
5115 | |
5116 | sector_num += num; | |
5117 | nb_sectors -= num; | |
4265d620 | 5118 | } |
d51e9fe5 | 5119 | return 0; |
4265d620 PB |
5120 | } |
5121 | ||
5122 | int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors) | |
5123 | { | |
5124 | Coroutine *co; | |
775aa8b6 | 5125 | DiscardCo rwco = { |
4265d620 PB |
5126 | .bs = bs, |
5127 | .sector_num = sector_num, | |
5128 | .nb_sectors = nb_sectors, | |
5129 | .ret = NOT_DONE, | |
5130 | }; | |
5131 | ||
5132 | if (qemu_in_coroutine()) { | |
5133 | /* Fast-path if already in coroutine context */ | |
5134 | bdrv_discard_co_entry(&rwco); | |
5135 | } else { | |
2572b37a SH |
5136 | AioContext *aio_context = bdrv_get_aio_context(bs); |
5137 | ||
4265d620 PB |
5138 | co = qemu_coroutine_create(bdrv_discard_co_entry); |
5139 | qemu_coroutine_enter(co, &rwco); | |
5140 | while (rwco.ret == NOT_DONE) { | |
2572b37a | 5141 | aio_poll(aio_context, true); |
4265d620 PB |
5142 | } |
5143 | } | |
5144 | ||
5145 | return rwco.ret; | |
5146 | } | |
5147 | ||
19cb3738 FB |
5148 | /**************************************************************/ |
5149 | /* removable device support */ | |
5150 | ||
5151 | /** | |
5152 | * Return TRUE if the media is present | |
5153 | */ | |
5154 | int bdrv_is_inserted(BlockDriverState *bs) | |
5155 | { | |
5156 | BlockDriver *drv = bs->drv; | |
a1aff5bf | 5157 | |
19cb3738 FB |
5158 | if (!drv) |
5159 | return 0; | |
5160 | if (!drv->bdrv_is_inserted) | |
a1aff5bf MA |
5161 | return 1; |
5162 | return drv->bdrv_is_inserted(bs); | |
19cb3738 FB |
5163 | } |
5164 | ||
5165 | /** | |
8e49ca46 MA |
5166 | * Return whether the media changed since the last call to this |
5167 | * function, or -ENOTSUP if we don't know. Most drivers don't know. | |
19cb3738 FB |
5168 | */ |
5169 | int bdrv_media_changed(BlockDriverState *bs) | |
5170 | { | |
5171 | BlockDriver *drv = bs->drv; | |
19cb3738 | 5172 | |
8e49ca46 MA |
5173 | if (drv && drv->bdrv_media_changed) { |
5174 | return drv->bdrv_media_changed(bs); | |
5175 | } | |
5176 | return -ENOTSUP; | |
19cb3738 FB |
5177 | } |
5178 | ||
5179 | /** | |
5180 | * If eject_flag is TRUE, eject the media. Otherwise, close the tray | |
5181 | */ | |
f36f3949 | 5182 | void bdrv_eject(BlockDriverState *bs, bool eject_flag) |
19cb3738 FB |
5183 | { |
5184 | BlockDriver *drv = bs->drv; | |
bfb197e0 | 5185 | const char *device_name; |
19cb3738 | 5186 | |
822e1cd1 MA |
5187 | if (drv && drv->bdrv_eject) { |
5188 | drv->bdrv_eject(bs, eject_flag); | |
19cb3738 | 5189 | } |
6f382ed2 | 5190 | |
bfb197e0 MA |
5191 | device_name = bdrv_get_device_name(bs); |
5192 | if (device_name[0] != '\0') { | |
5193 | qapi_event_send_device_tray_moved(device_name, | |
a5ee7bd4 | 5194 | eject_flag, &error_abort); |
6f382ed2 | 5195 | } |
19cb3738 FB |
5196 | } |
5197 | ||
19cb3738 FB |
5198 | /** |
5199 | * Lock or unlock the media (if it is locked, the user won't be able | |
5200 | * to eject it manually). | |
5201 | */ | |
025e849a | 5202 | void bdrv_lock_medium(BlockDriverState *bs, bool locked) |
19cb3738 FB |
5203 | { |
5204 | BlockDriver *drv = bs->drv; | |
5205 | ||
025e849a | 5206 | trace_bdrv_lock_medium(bs, locked); |
b8c6d095 | 5207 | |
025e849a MA |
5208 | if (drv && drv->bdrv_lock_medium) { |
5209 | drv->bdrv_lock_medium(bs, locked); | |
19cb3738 FB |
5210 | } |
5211 | } | |
985a03b0 TS |
5212 | |
5213 | /* needed for generic scsi interface */ | |
5214 | ||
5215 | int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf) | |
5216 | { | |
5217 | BlockDriver *drv = bs->drv; | |
5218 | ||
5219 | if (drv && drv->bdrv_ioctl) | |
5220 | return drv->bdrv_ioctl(bs, req, buf); | |
5221 | return -ENOTSUP; | |
5222 | } | |
7d780669 | 5223 | |
7c84b1b8 | 5224 | BlockAIOCB *bdrv_aio_ioctl(BlockDriverState *bs, |
221f715d | 5225 | unsigned long int req, void *buf, |
097310b5 | 5226 | BlockCompletionFunc *cb, void *opaque) |
7d780669 | 5227 | { |
221f715d | 5228 | BlockDriver *drv = bs->drv; |
7d780669 | 5229 | |
221f715d AL |
5230 | if (drv && drv->bdrv_aio_ioctl) |
5231 | return drv->bdrv_aio_ioctl(bs, req, buf, cb, opaque); | |
5232 | return NULL; | |
7d780669 | 5233 | } |
e268ca52 | 5234 | |
1b7fd729 | 5235 | void bdrv_set_guest_block_size(BlockDriverState *bs, int align) |
7b6f9300 | 5236 | { |
1b7fd729 | 5237 | bs->guest_block_size = align; |
7b6f9300 | 5238 | } |
7cd1e32a | 5239 | |
e268ca52 AL |
5240 | void *qemu_blockalign(BlockDriverState *bs, size_t size) |
5241 | { | |
339064d5 | 5242 | return qemu_memalign(bdrv_opt_mem_align(bs), size); |
e268ca52 | 5243 | } |
7cd1e32a | 5244 | |
9ebd8448 HR |
5245 | void *qemu_blockalign0(BlockDriverState *bs, size_t size) |
5246 | { | |
5247 | return memset(qemu_blockalign(bs, size), 0, size); | |
5248 | } | |
5249 | ||
7d2a35cc KW |
5250 | void *qemu_try_blockalign(BlockDriverState *bs, size_t size) |
5251 | { | |
5252 | size_t align = bdrv_opt_mem_align(bs); | |
5253 | ||
5254 | /* Ensure that NULL is never returned on success */ | |
5255 | assert(align > 0); | |
5256 | if (size == 0) { | |
5257 | size = align; | |
5258 | } | |
5259 | ||
5260 | return qemu_try_memalign(align, size); | |
5261 | } | |
5262 | ||
9ebd8448 HR |
5263 | void *qemu_try_blockalign0(BlockDriverState *bs, size_t size) |
5264 | { | |
5265 | void *mem = qemu_try_blockalign(bs, size); | |
5266 | ||
5267 | if (mem) { | |
5268 | memset(mem, 0, size); | |
5269 | } | |
5270 | ||
5271 | return mem; | |
5272 | } | |
5273 | ||
c53b1c51 SH |
5274 | /* |
5275 | * Check if all memory in this vector is sector aligned. | |
5276 | */ | |
5277 | bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov) | |
5278 | { | |
5279 | int i; | |
339064d5 | 5280 | size_t alignment = bdrv_opt_mem_align(bs); |
c53b1c51 SH |
5281 | |
5282 | for (i = 0; i < qiov->niov; i++) { | |
339064d5 | 5283 | if ((uintptr_t) qiov->iov[i].iov_base % alignment) { |
c53b1c51 | 5284 | return false; |
1ff735bd | 5285 | } |
339064d5 | 5286 | if (qiov->iov[i].iov_len % alignment) { |
1ff735bd | 5287 | return false; |
c53b1c51 SH |
5288 | } |
5289 | } | |
5290 | ||
5291 | return true; | |
5292 | } | |
5293 | ||
b8afb520 FZ |
5294 | BdrvDirtyBitmap *bdrv_create_dirty_bitmap(BlockDriverState *bs, int granularity, |
5295 | Error **errp) | |
7cd1e32a LS |
5296 | { |
5297 | int64_t bitmap_size; | |
e4654d2d | 5298 | BdrvDirtyBitmap *bitmap; |
a55eb92c | 5299 | |
50717e94 PB |
5300 | assert((granularity & (granularity - 1)) == 0); |
5301 | ||
e4654d2d FZ |
5302 | granularity >>= BDRV_SECTOR_BITS; |
5303 | assert(granularity); | |
57322b78 | 5304 | bitmap_size = bdrv_nb_sectors(bs); |
b8afb520 FZ |
5305 | if (bitmap_size < 0) { |
5306 | error_setg_errno(errp, -bitmap_size, "could not get length of device"); | |
5307 | errno = -bitmap_size; | |
5308 | return NULL; | |
5309 | } | |
5839e53b | 5310 | bitmap = g_new0(BdrvDirtyBitmap, 1); |
e4654d2d FZ |
5311 | bitmap->bitmap = hbitmap_alloc(bitmap_size, ffs(granularity) - 1); |
5312 | QLIST_INSERT_HEAD(&bs->dirty_bitmaps, bitmap, list); | |
5313 | return bitmap; | |
5314 | } | |
5315 | ||
5316 | void bdrv_release_dirty_bitmap(BlockDriverState *bs, BdrvDirtyBitmap *bitmap) | |
5317 | { | |
5318 | BdrvDirtyBitmap *bm, *next; | |
5319 | QLIST_FOREACH_SAFE(bm, &bs->dirty_bitmaps, list, next) { | |
5320 | if (bm == bitmap) { | |
5321 | QLIST_REMOVE(bitmap, list); | |
5322 | hbitmap_free(bitmap->bitmap); | |
5323 | g_free(bitmap); | |
5324 | return; | |
a55eb92c | 5325 | } |
7cd1e32a LS |
5326 | } |
5327 | } | |
5328 | ||
21b56835 FZ |
5329 | BlockDirtyInfoList *bdrv_query_dirty_bitmaps(BlockDriverState *bs) |
5330 | { | |
5331 | BdrvDirtyBitmap *bm; | |
5332 | BlockDirtyInfoList *list = NULL; | |
5333 | BlockDirtyInfoList **plist = &list; | |
5334 | ||
5335 | QLIST_FOREACH(bm, &bs->dirty_bitmaps, list) { | |
5839e53b MA |
5336 | BlockDirtyInfo *info = g_new0(BlockDirtyInfo, 1); |
5337 | BlockDirtyInfoList *entry = g_new0(BlockDirtyInfoList, 1); | |
21b56835 FZ |
5338 | info->count = bdrv_get_dirty_count(bs, bm); |
5339 | info->granularity = | |
5340 | ((int64_t) BDRV_SECTOR_SIZE << hbitmap_granularity(bm->bitmap)); | |
5341 | entry->value = info; | |
5342 | *plist = entry; | |
5343 | plist = &entry->next; | |
5344 | } | |
5345 | ||
5346 | return list; | |
5347 | } | |
5348 | ||
e4654d2d | 5349 | int bdrv_get_dirty(BlockDriverState *bs, BdrvDirtyBitmap *bitmap, int64_t sector) |
7cd1e32a | 5350 | { |
e4654d2d FZ |
5351 | if (bitmap) { |
5352 | return hbitmap_get(bitmap->bitmap, sector); | |
7cd1e32a LS |
5353 | } else { |
5354 | return 0; | |
5355 | } | |
5356 | } | |
5357 | ||
e4654d2d FZ |
5358 | void bdrv_dirty_iter_init(BlockDriverState *bs, |
5359 | BdrvDirtyBitmap *bitmap, HBitmapIter *hbi) | |
1755da16 | 5360 | { |
e4654d2d | 5361 | hbitmap_iter_init(hbi, bitmap->bitmap, 0); |
1755da16 PB |
5362 | } |
5363 | ||
5364 | void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, | |
5365 | int nr_sectors) | |
5366 | { | |
e4654d2d FZ |
5367 | BdrvDirtyBitmap *bitmap; |
5368 | QLIST_FOREACH(bitmap, &bs->dirty_bitmaps, list) { | |
5369 | hbitmap_set(bitmap->bitmap, cur_sector, nr_sectors); | |
5370 | } | |
1755da16 PB |
5371 | } |
5372 | ||
e4654d2d | 5373 | void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors) |
7cd1e32a | 5374 | { |
e4654d2d FZ |
5375 | BdrvDirtyBitmap *bitmap; |
5376 | QLIST_FOREACH(bitmap, &bs->dirty_bitmaps, list) { | |
5377 | hbitmap_reset(bitmap->bitmap, cur_sector, nr_sectors); | |
5378 | } | |
7cd1e32a | 5379 | } |
aaa0eb75 | 5380 | |
e4654d2d | 5381 | int64_t bdrv_get_dirty_count(BlockDriverState *bs, BdrvDirtyBitmap *bitmap) |
aaa0eb75 | 5382 | { |
e4654d2d | 5383 | return hbitmap_count(bitmap->bitmap); |
aaa0eb75 | 5384 | } |
f88e1a42 | 5385 | |
9fcb0251 FZ |
5386 | /* Get a reference to bs */ |
5387 | void bdrv_ref(BlockDriverState *bs) | |
5388 | { | |
5389 | bs->refcnt++; | |
5390 | } | |
5391 | ||
5392 | /* Release a previously grabbed reference to bs. | |
5393 | * If after releasing, reference count is zero, the BlockDriverState is | |
5394 | * deleted. */ | |
5395 | void bdrv_unref(BlockDriverState *bs) | |
5396 | { | |
9a4d5ca6 JC |
5397 | if (!bs) { |
5398 | return; | |
5399 | } | |
9fcb0251 FZ |
5400 | assert(bs->refcnt > 0); |
5401 | if (--bs->refcnt == 0) { | |
5402 | bdrv_delete(bs); | |
5403 | } | |
5404 | } | |
5405 | ||
fbe40ff7 FZ |
5406 | struct BdrvOpBlocker { |
5407 | Error *reason; | |
5408 | QLIST_ENTRY(BdrvOpBlocker) list; | |
5409 | }; | |
5410 | ||
5411 | bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp) | |
5412 | { | |
5413 | BdrvOpBlocker *blocker; | |
5414 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
5415 | if (!QLIST_EMPTY(&bs->op_blockers[op])) { | |
5416 | blocker = QLIST_FIRST(&bs->op_blockers[op]); | |
5417 | if (errp) { | |
5418 | error_setg(errp, "Device '%s' is busy: %s", | |
bfb197e0 MA |
5419 | bdrv_get_device_name(bs), |
5420 | error_get_pretty(blocker->reason)); | |
fbe40ff7 FZ |
5421 | } |
5422 | return true; | |
5423 | } | |
5424 | return false; | |
5425 | } | |
5426 | ||
5427 | void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason) | |
5428 | { | |
5429 | BdrvOpBlocker *blocker; | |
5430 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
5431 | ||
5839e53b | 5432 | blocker = g_new0(BdrvOpBlocker, 1); |
fbe40ff7 FZ |
5433 | blocker->reason = reason; |
5434 | QLIST_INSERT_HEAD(&bs->op_blockers[op], blocker, list); | |
5435 | } | |
5436 | ||
5437 | void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason) | |
5438 | { | |
5439 | BdrvOpBlocker *blocker, *next; | |
5440 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
5441 | QLIST_FOREACH_SAFE(blocker, &bs->op_blockers[op], list, next) { | |
5442 | if (blocker->reason == reason) { | |
5443 | QLIST_REMOVE(blocker, list); | |
5444 | g_free(blocker); | |
5445 | } | |
5446 | } | |
5447 | } | |
5448 | ||
5449 | void bdrv_op_block_all(BlockDriverState *bs, Error *reason) | |
5450 | { | |
5451 | int i; | |
5452 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
5453 | bdrv_op_block(bs, i, reason); | |
5454 | } | |
5455 | } | |
5456 | ||
5457 | void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason) | |
5458 | { | |
5459 | int i; | |
5460 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
5461 | bdrv_op_unblock(bs, i, reason); | |
5462 | } | |
5463 | } | |
5464 | ||
5465 | bool bdrv_op_blocker_is_empty(BlockDriverState *bs) | |
5466 | { | |
5467 | int i; | |
5468 | ||
5469 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
5470 | if (!QLIST_EMPTY(&bs->op_blockers[i])) { | |
5471 | return false; | |
5472 | } | |
5473 | } | |
5474 | return true; | |
5475 | } | |
5476 | ||
28a7282a LC |
5477 | void bdrv_iostatus_enable(BlockDriverState *bs) |
5478 | { | |
d6bf279e | 5479 | bs->iostatus_enabled = true; |
58e21ef5 | 5480 | bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK; |
28a7282a LC |
5481 | } |
5482 | ||
5483 | /* The I/O status is only enabled if the drive explicitly | |
5484 | * enables it _and_ the VM is configured to stop on errors */ | |
5485 | bool bdrv_iostatus_is_enabled(const BlockDriverState *bs) | |
5486 | { | |
d6bf279e | 5487 | return (bs->iostatus_enabled && |
92aa5c6d PB |
5488 | (bs->on_write_error == BLOCKDEV_ON_ERROR_ENOSPC || |
5489 | bs->on_write_error == BLOCKDEV_ON_ERROR_STOP || | |
5490 | bs->on_read_error == BLOCKDEV_ON_ERROR_STOP)); | |
28a7282a LC |
5491 | } |
5492 | ||
5493 | void bdrv_iostatus_disable(BlockDriverState *bs) | |
5494 | { | |
d6bf279e | 5495 | bs->iostatus_enabled = false; |
28a7282a LC |
5496 | } |
5497 | ||
5498 | void bdrv_iostatus_reset(BlockDriverState *bs) | |
5499 | { | |
5500 | if (bdrv_iostatus_is_enabled(bs)) { | |
58e21ef5 | 5501 | bs->iostatus = BLOCK_DEVICE_IO_STATUS_OK; |
3bd293c3 PB |
5502 | if (bs->job) { |
5503 | block_job_iostatus_reset(bs->job); | |
5504 | } | |
28a7282a LC |
5505 | } |
5506 | } | |
5507 | ||
28a7282a LC |
5508 | void bdrv_iostatus_set_err(BlockDriverState *bs, int error) |
5509 | { | |
3e1caa5f PB |
5510 | assert(bdrv_iostatus_is_enabled(bs)); |
5511 | if (bs->iostatus == BLOCK_DEVICE_IO_STATUS_OK) { | |
58e21ef5 LC |
5512 | bs->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE : |
5513 | BLOCK_DEVICE_IO_STATUS_FAILED; | |
28a7282a LC |
5514 | } |
5515 | } | |
5516 | ||
d92ada22 LC |
5517 | void bdrv_img_create(const char *filename, const char *fmt, |
5518 | const char *base_filename, const char *base_fmt, | |
f382d43a MR |
5519 | char *options, uint64_t img_size, int flags, |
5520 | Error **errp, bool quiet) | |
f88e1a42 | 5521 | { |
83d0521a CL |
5522 | QemuOptsList *create_opts = NULL; |
5523 | QemuOpts *opts = NULL; | |
5524 | const char *backing_fmt, *backing_file; | |
5525 | int64_t size; | |
f88e1a42 | 5526 | BlockDriver *drv, *proto_drv; |
96df67d1 | 5527 | BlockDriver *backing_drv = NULL; |
cc84d90f | 5528 | Error *local_err = NULL; |
f88e1a42 JS |
5529 | int ret = 0; |
5530 | ||
5531 | /* Find driver and parse its options */ | |
5532 | drv = bdrv_find_format(fmt); | |
5533 | if (!drv) { | |
71c79813 | 5534 | error_setg(errp, "Unknown file format '%s'", fmt); |
d92ada22 | 5535 | return; |
f88e1a42 JS |
5536 | } |
5537 | ||
98289620 | 5538 | proto_drv = bdrv_find_protocol(filename, true); |
f88e1a42 | 5539 | if (!proto_drv) { |
71c79813 | 5540 | error_setg(errp, "Unknown protocol '%s'", filename); |
d92ada22 | 5541 | return; |
f88e1a42 JS |
5542 | } |
5543 | ||
c282e1fd CL |
5544 | create_opts = qemu_opts_append(create_opts, drv->create_opts); |
5545 | create_opts = qemu_opts_append(create_opts, proto_drv->create_opts); | |
f88e1a42 JS |
5546 | |
5547 | /* Create parameter list with default values */ | |
83d0521a CL |
5548 | opts = qemu_opts_create(create_opts, NULL, 0, &error_abort); |
5549 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size); | |
f88e1a42 JS |
5550 | |
5551 | /* Parse -o options */ | |
5552 | if (options) { | |
83d0521a CL |
5553 | if (qemu_opts_do_parse(opts, options, NULL) != 0) { |
5554 | error_setg(errp, "Invalid options for file format '%s'", fmt); | |
f88e1a42 JS |
5555 | goto out; |
5556 | } | |
5557 | } | |
5558 | ||
5559 | if (base_filename) { | |
83d0521a | 5560 | if (qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename)) { |
71c79813 LC |
5561 | error_setg(errp, "Backing file not supported for file format '%s'", |
5562 | fmt); | |
f88e1a42 JS |
5563 | goto out; |
5564 | } | |
5565 | } | |
5566 | ||
5567 | if (base_fmt) { | |
83d0521a | 5568 | if (qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt)) { |
71c79813 LC |
5569 | error_setg(errp, "Backing file format not supported for file " |
5570 | "format '%s'", fmt); | |
f88e1a42 JS |
5571 | goto out; |
5572 | } | |
5573 | } | |
5574 | ||
83d0521a CL |
5575 | backing_file = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE); |
5576 | if (backing_file) { | |
5577 | if (!strcmp(filename, backing_file)) { | |
71c79813 LC |
5578 | error_setg(errp, "Error: Trying to create an image with the " |
5579 | "same filename as the backing file"); | |
792da93a JS |
5580 | goto out; |
5581 | } | |
5582 | } | |
5583 | ||
83d0521a CL |
5584 | backing_fmt = qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT); |
5585 | if (backing_fmt) { | |
5586 | backing_drv = bdrv_find_format(backing_fmt); | |
96df67d1 | 5587 | if (!backing_drv) { |
71c79813 | 5588 | error_setg(errp, "Unknown backing file format '%s'", |
83d0521a | 5589 | backing_fmt); |
f88e1a42 JS |
5590 | goto out; |
5591 | } | |
5592 | } | |
5593 | ||
5594 | // The size for the image must always be specified, with one exception: | |
5595 | // If we are using a backing file, we can obtain the size from there | |
83d0521a CL |
5596 | size = qemu_opt_get_size(opts, BLOCK_OPT_SIZE, 0); |
5597 | if (size == -1) { | |
5598 | if (backing_file) { | |
66f6b814 | 5599 | BlockDriverState *bs; |
52bf1e72 | 5600 | int64_t size; |
63090dac PB |
5601 | int back_flags; |
5602 | ||
5603 | /* backing files always opened read-only */ | |
5604 | back_flags = | |
5605 | flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING); | |
f88e1a42 | 5606 | |
f67503e5 | 5607 | bs = NULL; |
83d0521a | 5608 | ret = bdrv_open(&bs, backing_file, NULL, NULL, back_flags, |
cc84d90f | 5609 | backing_drv, &local_err); |
f88e1a42 | 5610 | if (ret < 0) { |
cc84d90f | 5611 | error_setg_errno(errp, -ret, "Could not open '%s': %s", |
83d0521a | 5612 | backing_file, |
cc84d90f HR |
5613 | error_get_pretty(local_err)); |
5614 | error_free(local_err); | |
5615 | local_err = NULL; | |
f88e1a42 JS |
5616 | goto out; |
5617 | } | |
52bf1e72 MA |
5618 | size = bdrv_getlength(bs); |
5619 | if (size < 0) { | |
5620 | error_setg_errno(errp, -size, "Could not get size of '%s'", | |
5621 | backing_file); | |
5622 | bdrv_unref(bs); | |
5623 | goto out; | |
5624 | } | |
f88e1a42 | 5625 | |
83d0521a | 5626 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, size); |
66f6b814 HR |
5627 | |
5628 | bdrv_unref(bs); | |
f88e1a42 | 5629 | } else { |
71c79813 | 5630 | error_setg(errp, "Image creation needs a size parameter"); |
f88e1a42 JS |
5631 | goto out; |
5632 | } | |
5633 | } | |
5634 | ||
f382d43a MR |
5635 | if (!quiet) { |
5636 | printf("Formatting '%s', fmt=%s ", filename, fmt); | |
83d0521a | 5637 | qemu_opts_print(opts); |
f382d43a MR |
5638 | puts(""); |
5639 | } | |
83d0521a | 5640 | |
c282e1fd | 5641 | ret = bdrv_create(drv, filename, opts, &local_err); |
83d0521a | 5642 | |
cc84d90f HR |
5643 | if (ret == -EFBIG) { |
5644 | /* This is generally a better message than whatever the driver would | |
5645 | * deliver (especially because of the cluster_size_hint), since that | |
5646 | * is most probably not much different from "image too large". */ | |
5647 | const char *cluster_size_hint = ""; | |
83d0521a | 5648 | if (qemu_opt_get_size(opts, BLOCK_OPT_CLUSTER_SIZE, 0)) { |
cc84d90f | 5649 | cluster_size_hint = " (try using a larger cluster size)"; |
f88e1a42 | 5650 | } |
cc84d90f HR |
5651 | error_setg(errp, "The image size is too large for file format '%s'" |
5652 | "%s", fmt, cluster_size_hint); | |
5653 | error_free(local_err); | |
5654 | local_err = NULL; | |
f88e1a42 JS |
5655 | } |
5656 | ||
5657 | out: | |
83d0521a CL |
5658 | qemu_opts_del(opts); |
5659 | qemu_opts_free(create_opts); | |
84d18f06 | 5660 | if (local_err) { |
cc84d90f HR |
5661 | error_propagate(errp, local_err); |
5662 | } | |
f88e1a42 | 5663 | } |
85d126f3 SH |
5664 | |
5665 | AioContext *bdrv_get_aio_context(BlockDriverState *bs) | |
5666 | { | |
dcd04228 SH |
5667 | return bs->aio_context; |
5668 | } | |
5669 | ||
5670 | void bdrv_detach_aio_context(BlockDriverState *bs) | |
5671 | { | |
33384421 HR |
5672 | BdrvAioNotifier *baf; |
5673 | ||
dcd04228 SH |
5674 | if (!bs->drv) { |
5675 | return; | |
5676 | } | |
5677 | ||
33384421 HR |
5678 | QLIST_FOREACH(baf, &bs->aio_notifiers, list) { |
5679 | baf->detach_aio_context(baf->opaque); | |
5680 | } | |
5681 | ||
13af91eb SH |
5682 | if (bs->io_limits_enabled) { |
5683 | throttle_detach_aio_context(&bs->throttle_state); | |
5684 | } | |
dcd04228 SH |
5685 | if (bs->drv->bdrv_detach_aio_context) { |
5686 | bs->drv->bdrv_detach_aio_context(bs); | |
5687 | } | |
5688 | if (bs->file) { | |
5689 | bdrv_detach_aio_context(bs->file); | |
5690 | } | |
5691 | if (bs->backing_hd) { | |
5692 | bdrv_detach_aio_context(bs->backing_hd); | |
5693 | } | |
5694 | ||
5695 | bs->aio_context = NULL; | |
5696 | } | |
5697 | ||
5698 | void bdrv_attach_aio_context(BlockDriverState *bs, | |
5699 | AioContext *new_context) | |
5700 | { | |
33384421 HR |
5701 | BdrvAioNotifier *ban; |
5702 | ||
dcd04228 SH |
5703 | if (!bs->drv) { |
5704 | return; | |
5705 | } | |
5706 | ||
5707 | bs->aio_context = new_context; | |
5708 | ||
5709 | if (bs->backing_hd) { | |
5710 | bdrv_attach_aio_context(bs->backing_hd, new_context); | |
5711 | } | |
5712 | if (bs->file) { | |
5713 | bdrv_attach_aio_context(bs->file, new_context); | |
5714 | } | |
5715 | if (bs->drv->bdrv_attach_aio_context) { | |
5716 | bs->drv->bdrv_attach_aio_context(bs, new_context); | |
5717 | } | |
13af91eb SH |
5718 | if (bs->io_limits_enabled) { |
5719 | throttle_attach_aio_context(&bs->throttle_state, new_context); | |
5720 | } | |
33384421 HR |
5721 | |
5722 | QLIST_FOREACH(ban, &bs->aio_notifiers, list) { | |
5723 | ban->attached_aio_context(new_context, ban->opaque); | |
5724 | } | |
dcd04228 SH |
5725 | } |
5726 | ||
5727 | void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context) | |
5728 | { | |
5729 | bdrv_drain_all(); /* ensure there are no in-flight requests */ | |
5730 | ||
5731 | bdrv_detach_aio_context(bs); | |
5732 | ||
5733 | /* This function executes in the old AioContext so acquire the new one in | |
5734 | * case it runs in a different thread. | |
5735 | */ | |
5736 | aio_context_acquire(new_context); | |
5737 | bdrv_attach_aio_context(bs, new_context); | |
5738 | aio_context_release(new_context); | |
85d126f3 | 5739 | } |
d616b224 | 5740 | |
33384421 HR |
5741 | void bdrv_add_aio_context_notifier(BlockDriverState *bs, |
5742 | void (*attached_aio_context)(AioContext *new_context, void *opaque), | |
5743 | void (*detach_aio_context)(void *opaque), void *opaque) | |
5744 | { | |
5745 | BdrvAioNotifier *ban = g_new(BdrvAioNotifier, 1); | |
5746 | *ban = (BdrvAioNotifier){ | |
5747 | .attached_aio_context = attached_aio_context, | |
5748 | .detach_aio_context = detach_aio_context, | |
5749 | .opaque = opaque | |
5750 | }; | |
5751 | ||
5752 | QLIST_INSERT_HEAD(&bs->aio_notifiers, ban, list); | |
5753 | } | |
5754 | ||
5755 | void bdrv_remove_aio_context_notifier(BlockDriverState *bs, | |
5756 | void (*attached_aio_context)(AioContext *, | |
5757 | void *), | |
5758 | void (*detach_aio_context)(void *), | |
5759 | void *opaque) | |
5760 | { | |
5761 | BdrvAioNotifier *ban, *ban_next; | |
5762 | ||
5763 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { | |
5764 | if (ban->attached_aio_context == attached_aio_context && | |
5765 | ban->detach_aio_context == detach_aio_context && | |
5766 | ban->opaque == opaque) | |
5767 | { | |
5768 | QLIST_REMOVE(ban, list); | |
5769 | g_free(ban); | |
5770 | ||
5771 | return; | |
5772 | } | |
5773 | } | |
5774 | ||
5775 | abort(); | |
5776 | } | |
5777 | ||
d616b224 SH |
5778 | void bdrv_add_before_write_notifier(BlockDriverState *bs, |
5779 | NotifierWithReturn *notifier) | |
5780 | { | |
5781 | notifier_with_return_list_add(&bs->before_write_notifiers, notifier); | |
5782 | } | |
6f176b48 | 5783 | |
77485434 HR |
5784 | int bdrv_amend_options(BlockDriverState *bs, QemuOpts *opts, |
5785 | BlockDriverAmendStatusCB *status_cb) | |
6f176b48 | 5786 | { |
c282e1fd | 5787 | if (!bs->drv->bdrv_amend_options) { |
6f176b48 HR |
5788 | return -ENOTSUP; |
5789 | } | |
77485434 | 5790 | return bs->drv->bdrv_amend_options(bs, opts, status_cb); |
6f176b48 | 5791 | } |
f6186f49 | 5792 | |
b5042a36 BC |
5793 | /* This function will be called by the bdrv_recurse_is_first_non_filter method |
5794 | * of block filter and by bdrv_is_first_non_filter. | |
5795 | * It is used to test if the given bs is the candidate or recurse more in the | |
5796 | * node graph. | |
212a5a8f | 5797 | */ |
b5042a36 | 5798 | bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs, |
212a5a8f | 5799 | BlockDriverState *candidate) |
f6186f49 | 5800 | { |
b5042a36 BC |
5801 | /* return false if basic checks fails */ |
5802 | if (!bs || !bs->drv) { | |
212a5a8f | 5803 | return false; |
f6186f49 BC |
5804 | } |
5805 | ||
b5042a36 BC |
5806 | /* the code reached a non block filter driver -> check if the bs is |
5807 | * the same as the candidate. It's the recursion termination condition. | |
5808 | */ | |
5809 | if (!bs->drv->is_filter) { | |
5810 | return bs == candidate; | |
212a5a8f | 5811 | } |
b5042a36 | 5812 | /* Down this path the driver is a block filter driver */ |
212a5a8f | 5813 | |
b5042a36 BC |
5814 | /* If the block filter recursion method is defined use it to recurse down |
5815 | * the node graph. | |
5816 | */ | |
5817 | if (bs->drv->bdrv_recurse_is_first_non_filter) { | |
212a5a8f | 5818 | return bs->drv->bdrv_recurse_is_first_non_filter(bs, candidate); |
f6186f49 BC |
5819 | } |
5820 | ||
b5042a36 BC |
5821 | /* the driver is a block filter but don't allow to recurse -> return false |
5822 | */ | |
5823 | return false; | |
f6186f49 BC |
5824 | } |
5825 | ||
212a5a8f BC |
5826 | /* This function checks if the candidate is the first non filter bs down it's |
5827 | * bs chain. Since we don't have pointers to parents it explore all bs chains | |
5828 | * from the top. Some filters can choose not to pass down the recursion. | |
5829 | */ | |
5830 | bool bdrv_is_first_non_filter(BlockDriverState *candidate) | |
f6186f49 | 5831 | { |
212a5a8f BC |
5832 | BlockDriverState *bs; |
5833 | ||
5834 | /* walk down the bs forest recursively */ | |
5835 | QTAILQ_FOREACH(bs, &bdrv_states, device_list) { | |
5836 | bool perm; | |
5837 | ||
b5042a36 | 5838 | /* try to recurse in this top level bs */ |
e6dc8a1f | 5839 | perm = bdrv_recurse_is_first_non_filter(bs, candidate); |
212a5a8f BC |
5840 | |
5841 | /* candidate is the first non filter */ | |
5842 | if (perm) { | |
5843 | return true; | |
5844 | } | |
5845 | } | |
5846 | ||
5847 | return false; | |
f6186f49 | 5848 | } |
09158f00 BC |
5849 | |
5850 | BlockDriverState *check_to_replace_node(const char *node_name, Error **errp) | |
5851 | { | |
5852 | BlockDriverState *to_replace_bs = bdrv_find_node(node_name); | |
5a7e7a0b SH |
5853 | AioContext *aio_context; |
5854 | ||
09158f00 BC |
5855 | if (!to_replace_bs) { |
5856 | error_setg(errp, "Node name '%s' not found", node_name); | |
5857 | return NULL; | |
5858 | } | |
5859 | ||
5a7e7a0b SH |
5860 | aio_context = bdrv_get_aio_context(to_replace_bs); |
5861 | aio_context_acquire(aio_context); | |
5862 | ||
09158f00 | 5863 | if (bdrv_op_is_blocked(to_replace_bs, BLOCK_OP_TYPE_REPLACE, errp)) { |
5a7e7a0b SH |
5864 | to_replace_bs = NULL; |
5865 | goto out; | |
09158f00 BC |
5866 | } |
5867 | ||
5868 | /* We don't want arbitrary node of the BDS chain to be replaced only the top | |
5869 | * most non filter in order to prevent data corruption. | |
5870 | * Another benefit is that this tests exclude backing files which are | |
5871 | * blocked by the backing blockers. | |
5872 | */ | |
5873 | if (!bdrv_is_first_non_filter(to_replace_bs)) { | |
5874 | error_setg(errp, "Only top most non filter can be replaced"); | |
5a7e7a0b SH |
5875 | to_replace_bs = NULL; |
5876 | goto out; | |
09158f00 BC |
5877 | } |
5878 | ||
5a7e7a0b SH |
5879 | out: |
5880 | aio_context_release(aio_context); | |
09158f00 BC |
5881 | return to_replace_bs; |
5882 | } | |
448ad91d ML |
5883 | |
5884 | void bdrv_io_plug(BlockDriverState *bs) | |
5885 | { | |
5886 | BlockDriver *drv = bs->drv; | |
5887 | if (drv && drv->bdrv_io_plug) { | |
5888 | drv->bdrv_io_plug(bs); | |
5889 | } else if (bs->file) { | |
5890 | bdrv_io_plug(bs->file); | |
5891 | } | |
5892 | } | |
5893 | ||
5894 | void bdrv_io_unplug(BlockDriverState *bs) | |
5895 | { | |
5896 | BlockDriver *drv = bs->drv; | |
5897 | if (drv && drv->bdrv_io_unplug) { | |
5898 | drv->bdrv_io_unplug(bs); | |
5899 | } else if (bs->file) { | |
5900 | bdrv_io_unplug(bs->file); | |
5901 | } | |
5902 | } | |
5903 | ||
5904 | void bdrv_flush_io_queue(BlockDriverState *bs) | |
5905 | { | |
5906 | BlockDriver *drv = bs->drv; | |
5907 | if (drv && drv->bdrv_flush_io_queue) { | |
5908 | drv->bdrv_flush_io_queue(bs); | |
5909 | } else if (bs->file) { | |
5910 | bdrv_flush_io_queue(bs->file); | |
5911 | } | |
5912 | } | |
91af7014 HR |
5913 | |
5914 | static bool append_open_options(QDict *d, BlockDriverState *bs) | |
5915 | { | |
5916 | const QDictEntry *entry; | |
5917 | bool found_any = false; | |
5918 | ||
5919 | for (entry = qdict_first(bs->options); entry; | |
5920 | entry = qdict_next(bs->options, entry)) | |
5921 | { | |
5922 | /* Only take options for this level and exclude all non-driver-specific | |
5923 | * options */ | |
5924 | if (!strchr(qdict_entry_key(entry), '.') && | |
5925 | strcmp(qdict_entry_key(entry), "node-name")) | |
5926 | { | |
5927 | qobject_incref(qdict_entry_value(entry)); | |
5928 | qdict_put_obj(d, qdict_entry_key(entry), qdict_entry_value(entry)); | |
5929 | found_any = true; | |
5930 | } | |
5931 | } | |
5932 | ||
5933 | return found_any; | |
5934 | } | |
5935 | ||
5936 | /* Updates the following BDS fields: | |
5937 | * - exact_filename: A filename which may be used for opening a block device | |
5938 | * which (mostly) equals the given BDS (even without any | |
5939 | * other options; so reading and writing must return the same | |
5940 | * results, but caching etc. may be different) | |
5941 | * - full_open_options: Options which, when given when opening a block device | |
5942 | * (without a filename), result in a BDS (mostly) | |
5943 | * equalling the given one | |
5944 | * - filename: If exact_filename is set, it is copied here. Otherwise, | |
5945 | * full_open_options is converted to a JSON object, prefixed with | |
5946 | * "json:" (for use through the JSON pseudo protocol) and put here. | |
5947 | */ | |
5948 | void bdrv_refresh_filename(BlockDriverState *bs) | |
5949 | { | |
5950 | BlockDriver *drv = bs->drv; | |
5951 | QDict *opts; | |
5952 | ||
5953 | if (!drv) { | |
5954 | return; | |
5955 | } | |
5956 | ||
5957 | /* This BDS's file name will most probably depend on its file's name, so | |
5958 | * refresh that first */ | |
5959 | if (bs->file) { | |
5960 | bdrv_refresh_filename(bs->file); | |
5961 | } | |
5962 | ||
5963 | if (drv->bdrv_refresh_filename) { | |
5964 | /* Obsolete information is of no use here, so drop the old file name | |
5965 | * information before refreshing it */ | |
5966 | bs->exact_filename[0] = '\0'; | |
5967 | if (bs->full_open_options) { | |
5968 | QDECREF(bs->full_open_options); | |
5969 | bs->full_open_options = NULL; | |
5970 | } | |
5971 | ||
5972 | drv->bdrv_refresh_filename(bs); | |
5973 | } else if (bs->file) { | |
5974 | /* Try to reconstruct valid information from the underlying file */ | |
5975 | bool has_open_options; | |
5976 | ||
5977 | bs->exact_filename[0] = '\0'; | |
5978 | if (bs->full_open_options) { | |
5979 | QDECREF(bs->full_open_options); | |
5980 | bs->full_open_options = NULL; | |
5981 | } | |
5982 | ||
5983 | opts = qdict_new(); | |
5984 | has_open_options = append_open_options(opts, bs); | |
5985 | ||
5986 | /* If no specific options have been given for this BDS, the filename of | |
5987 | * the underlying file should suffice for this one as well */ | |
5988 | if (bs->file->exact_filename[0] && !has_open_options) { | |
5989 | strcpy(bs->exact_filename, bs->file->exact_filename); | |
5990 | } | |
5991 | /* Reconstructing the full options QDict is simple for most format block | |
5992 | * drivers, as long as the full options are known for the underlying | |
5993 | * file BDS. The full options QDict of that file BDS should somehow | |
5994 | * contain a representation of the filename, therefore the following | |
5995 | * suffices without querying the (exact_)filename of this BDS. */ | |
5996 | if (bs->file->full_open_options) { | |
5997 | qdict_put_obj(opts, "driver", | |
5998 | QOBJECT(qstring_from_str(drv->format_name))); | |
5999 | QINCREF(bs->file->full_open_options); | |
6000 | qdict_put_obj(opts, "file", QOBJECT(bs->file->full_open_options)); | |
6001 | ||
6002 | bs->full_open_options = opts; | |
6003 | } else { | |
6004 | QDECREF(opts); | |
6005 | } | |
6006 | } else if (!bs->full_open_options && qdict_size(bs->options)) { | |
6007 | /* There is no underlying file BDS (at least referenced by BDS.file), | |
6008 | * so the full options QDict should be equal to the options given | |
6009 | * specifically for this block device when it was opened (plus the | |
6010 | * driver specification). | |
6011 | * Because those options don't change, there is no need to update | |
6012 | * full_open_options when it's already set. */ | |
6013 | ||
6014 | opts = qdict_new(); | |
6015 | append_open_options(opts, bs); | |
6016 | qdict_put_obj(opts, "driver", | |
6017 | QOBJECT(qstring_from_str(drv->format_name))); | |
6018 | ||
6019 | if (bs->exact_filename[0]) { | |
6020 | /* This may not work for all block protocol drivers (some may | |
6021 | * require this filename to be parsed), but we have to find some | |
6022 | * default solution here, so just include it. If some block driver | |
6023 | * does not support pure options without any filename at all or | |
6024 | * needs some special format of the options QDict, it needs to | |
6025 | * implement the driver-specific bdrv_refresh_filename() function. | |
6026 | */ | |
6027 | qdict_put_obj(opts, "filename", | |
6028 | QOBJECT(qstring_from_str(bs->exact_filename))); | |
6029 | } | |
6030 | ||
6031 | bs->full_open_options = opts; | |
6032 | } | |
6033 | ||
6034 | if (bs->exact_filename[0]) { | |
6035 | pstrcpy(bs->filename, sizeof(bs->filename), bs->exact_filename); | |
6036 | } else if (bs->full_open_options) { | |
6037 | QString *json = qobject_to_json(QOBJECT(bs->full_open_options)); | |
6038 | snprintf(bs->filename, sizeof(bs->filename), "json:%s", | |
6039 | qstring_get_str(json)); | |
6040 | QDECREF(json); | |
6041 | } | |
6042 | } | |
5366d0c8 BC |
6043 | |
6044 | /* This accessor function purpose is to allow the device models to access the | |
6045 | * BlockAcctStats structure embedded inside a BlockDriverState without being | |
6046 | * aware of the BlockDriverState structure layout. | |
6047 | * It will go away when the BlockAcctStats structure will be moved inside | |
6048 | * the device models. | |
6049 | */ | |
6050 | BlockAcctStats *bdrv_get_stats(BlockDriverState *bs) | |
6051 | { | |
6052 | return &bs->stats; | |
6053 | } |