]>
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" | |
d49b6836 | 29 | #include "qemu/error-report.h" |
1de7afc9 | 30 | #include "qemu/module.h" |
cc7a8ea7 | 31 | #include "qapi/qmp/qerror.h" |
91a097e7 | 32 | #include "qapi/qmp/qbool.h" |
7b1b5d19 | 33 | #include "qapi/qmp/qjson.h" |
bfb197e0 | 34 | #include "sysemu/block-backend.h" |
9c17d615 | 35 | #include "sysemu/sysemu.h" |
1de7afc9 | 36 | #include "qemu/notify.h" |
10817bf0 | 37 | #include "qemu/coroutine.h" |
c13163fb | 38 | #include "block/qapi.h" |
b2023818 | 39 | #include "qmp-commands.h" |
1de7afc9 | 40 | #include "qemu/timer.h" |
a5ee7bd4 | 41 | #include "qapi-event.h" |
db628338 | 42 | #include "block/throttle-groups.h" |
fc01f7e7 | 43 | |
71e72a19 | 44 | #ifdef CONFIG_BSD |
7674e7bf FB |
45 | #include <sys/types.h> |
46 | #include <sys/stat.h> | |
47 | #include <sys/ioctl.h> | |
72cf2d4f | 48 | #include <sys/queue.h> |
c5e97233 | 49 | #ifndef __DragonFly__ |
7674e7bf FB |
50 | #include <sys/disk.h> |
51 | #endif | |
c5e97233 | 52 | #endif |
7674e7bf | 53 | |
49dc768d AL |
54 | #ifdef _WIN32 |
55 | #include <windows.h> | |
56 | #endif | |
57 | ||
9bd2b08f JS |
58 | /** |
59 | * A BdrvDirtyBitmap can be in three possible states: | |
60 | * (1) successor is NULL and disabled is false: full r/w mode | |
61 | * (2) successor is NULL and disabled is true: read only mode ("disabled") | |
62 | * (3) successor is set: frozen mode. | |
63 | * A frozen bitmap cannot be renamed, deleted, anonymized, cleared, set, | |
64 | * or enabled. A frozen bitmap can only abdicate() or reclaim(). | |
65 | */ | |
e4654d2d | 66 | struct BdrvDirtyBitmap { |
aa0c7ca5 JS |
67 | HBitmap *bitmap; /* Dirty sector bitmap implementation */ |
68 | BdrvDirtyBitmap *successor; /* Anonymous child; implies frozen status */ | |
69 | char *name; /* Optional non-empty unique ID */ | |
70 | int64_t size; /* Size of the bitmap (Number of sectors) */ | |
71 | bool disabled; /* Bitmap is read-only */ | |
e4654d2d FZ |
72 | QLIST_ENTRY(BdrvDirtyBitmap) list; |
73 | }; | |
74 | ||
1c9805a3 SH |
75 | #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */ |
76 | ||
c69a4dd8 | 77 | struct BdrvStates bdrv_states = QTAILQ_HEAD_INITIALIZER(bdrv_states); |
7ee930d0 | 78 | |
dc364f4c BC |
79 | static QTAILQ_HEAD(, BlockDriverState) graph_bdrv_states = |
80 | QTAILQ_HEAD_INITIALIZER(graph_bdrv_states); | |
81 | ||
8a22f02a SH |
82 | static QLIST_HEAD(, BlockDriver) bdrv_drivers = |
83 | QLIST_HEAD_INITIALIZER(bdrv_drivers); | |
ea2384d3 | 84 | |
f3930ed0 KW |
85 | static int bdrv_open_inherit(BlockDriverState **pbs, const char *filename, |
86 | const char *reference, QDict *options, int flags, | |
87 | BlockDriverState *parent, | |
ce343771 | 88 | const BdrvChildRole *child_role, Error **errp); |
f3930ed0 | 89 | |
ce1ffea8 | 90 | static void bdrv_dirty_bitmap_truncate(BlockDriverState *bs); |
eb852011 MA |
91 | /* If non-zero, use only whitelisted block drivers */ |
92 | static int use_bdrv_whitelist; | |
93 | ||
9e0b22f4 SH |
94 | #ifdef _WIN32 |
95 | static int is_windows_drive_prefix(const char *filename) | |
96 | { | |
97 | return (((filename[0] >= 'a' && filename[0] <= 'z') || | |
98 | (filename[0] >= 'A' && filename[0] <= 'Z')) && | |
99 | filename[1] == ':'); | |
100 | } | |
101 | ||
102 | int is_windows_drive(const char *filename) | |
103 | { | |
104 | if (is_windows_drive_prefix(filename) && | |
105 | filename[2] == '\0') | |
106 | return 1; | |
107 | if (strstart(filename, "\\\\.\\", NULL) || | |
108 | strstart(filename, "//./", NULL)) | |
109 | return 1; | |
110 | return 0; | |
111 | } | |
112 | #endif | |
113 | ||
339064d5 KW |
114 | size_t bdrv_opt_mem_align(BlockDriverState *bs) |
115 | { | |
116 | if (!bs || !bs->drv) { | |
459b4e66 DL |
117 | /* page size or 4k (hdd sector size) should be on the safe side */ |
118 | return MAX(4096, getpagesize()); | |
339064d5 KW |
119 | } |
120 | ||
121 | return bs->bl.opt_mem_alignment; | |
122 | } | |
123 | ||
4196d2f0 DL |
124 | size_t bdrv_min_mem_align(BlockDriverState *bs) |
125 | { | |
126 | if (!bs || !bs->drv) { | |
459b4e66 DL |
127 | /* page size or 4k (hdd sector size) should be on the safe side */ |
128 | return MAX(4096, getpagesize()); | |
4196d2f0 DL |
129 | } |
130 | ||
131 | return bs->bl.min_mem_alignment; | |
132 | } | |
133 | ||
9e0b22f4 | 134 | /* check if the path starts with "<protocol>:" */ |
5c98415b | 135 | int path_has_protocol(const char *path) |
9e0b22f4 | 136 | { |
947995c0 PB |
137 | const char *p; |
138 | ||
9e0b22f4 SH |
139 | #ifdef _WIN32 |
140 | if (is_windows_drive(path) || | |
141 | is_windows_drive_prefix(path)) { | |
142 | return 0; | |
143 | } | |
947995c0 PB |
144 | p = path + strcspn(path, ":/\\"); |
145 | #else | |
146 | p = path + strcspn(path, ":/"); | |
9e0b22f4 SH |
147 | #endif |
148 | ||
947995c0 | 149 | return *p == ':'; |
9e0b22f4 SH |
150 | } |
151 | ||
83f64091 | 152 | int path_is_absolute(const char *path) |
3b0d4f61 | 153 | { |
21664424 FB |
154 | #ifdef _WIN32 |
155 | /* specific case for names like: "\\.\d:" */ | |
f53f4da9 | 156 | if (is_windows_drive(path) || is_windows_drive_prefix(path)) { |
21664424 | 157 | return 1; |
f53f4da9 PB |
158 | } |
159 | return (*path == '/' || *path == '\\'); | |
3b9f94e1 | 160 | #else |
f53f4da9 | 161 | return (*path == '/'); |
3b9f94e1 | 162 | #endif |
3b0d4f61 FB |
163 | } |
164 | ||
83f64091 FB |
165 | /* if filename is absolute, just copy it to dest. Otherwise, build a |
166 | path to it by considering it is relative to base_path. URL are | |
167 | supported. */ | |
168 | void path_combine(char *dest, int dest_size, | |
169 | const char *base_path, | |
170 | const char *filename) | |
3b0d4f61 | 171 | { |
83f64091 FB |
172 | const char *p, *p1; |
173 | int len; | |
174 | ||
175 | if (dest_size <= 0) | |
176 | return; | |
177 | if (path_is_absolute(filename)) { | |
178 | pstrcpy(dest, dest_size, filename); | |
179 | } else { | |
180 | p = strchr(base_path, ':'); | |
181 | if (p) | |
182 | p++; | |
183 | else | |
184 | p = base_path; | |
3b9f94e1 FB |
185 | p1 = strrchr(base_path, '/'); |
186 | #ifdef _WIN32 | |
187 | { | |
188 | const char *p2; | |
189 | p2 = strrchr(base_path, '\\'); | |
190 | if (!p1 || p2 > p1) | |
191 | p1 = p2; | |
192 | } | |
193 | #endif | |
83f64091 FB |
194 | if (p1) |
195 | p1++; | |
196 | else | |
197 | p1 = base_path; | |
198 | if (p1 > p) | |
199 | p = p1; | |
200 | len = p - base_path; | |
201 | if (len > dest_size - 1) | |
202 | len = dest_size - 1; | |
203 | memcpy(dest, base_path, len); | |
204 | dest[len] = '\0'; | |
205 | pstrcat(dest, dest_size, filename); | |
3b0d4f61 | 206 | } |
3b0d4f61 FB |
207 | } |
208 | ||
0a82855a HR |
209 | void bdrv_get_full_backing_filename_from_filename(const char *backed, |
210 | const char *backing, | |
9f07429e HR |
211 | char *dest, size_t sz, |
212 | Error **errp) | |
dc5a1371 | 213 | { |
9f07429e HR |
214 | if (backing[0] == '\0' || path_has_protocol(backing) || |
215 | path_is_absolute(backing)) | |
216 | { | |
0a82855a | 217 | pstrcpy(dest, sz, backing); |
9f07429e HR |
218 | } else if (backed[0] == '\0' || strstart(backed, "json:", NULL)) { |
219 | error_setg(errp, "Cannot use relative backing file names for '%s'", | |
220 | backed); | |
dc5a1371 | 221 | } else { |
0a82855a | 222 | path_combine(dest, sz, backed, backing); |
dc5a1371 PB |
223 | } |
224 | } | |
225 | ||
9f07429e HR |
226 | void bdrv_get_full_backing_filename(BlockDriverState *bs, char *dest, size_t sz, |
227 | Error **errp) | |
0a82855a | 228 | { |
9f07429e HR |
229 | char *backed = bs->exact_filename[0] ? bs->exact_filename : bs->filename; |
230 | ||
231 | bdrv_get_full_backing_filename_from_filename(backed, bs->backing_file, | |
232 | dest, sz, errp); | |
0a82855a HR |
233 | } |
234 | ||
0eb7217e SH |
235 | void bdrv_register(BlockDriver *bdrv) |
236 | { | |
237 | bdrv_setup_io_funcs(bdrv); | |
b2e12bc6 | 238 | |
8a22f02a | 239 | QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list); |
ea2384d3 | 240 | } |
b338082b | 241 | |
7f06d47e | 242 | BlockDriverState *bdrv_new_root(void) |
b338082b | 243 | { |
7f06d47e | 244 | BlockDriverState *bs = bdrv_new(); |
e4e9986b | 245 | |
e4e9986b | 246 | QTAILQ_INSERT_TAIL(&bdrv_states, bs, device_list); |
e4e9986b MA |
247 | return bs; |
248 | } | |
249 | ||
250 | BlockDriverState *bdrv_new(void) | |
251 | { | |
252 | BlockDriverState *bs; | |
253 | int i; | |
254 | ||
5839e53b | 255 | bs = g_new0(BlockDriverState, 1); |
e4654d2d | 256 | QLIST_INIT(&bs->dirty_bitmaps); |
fbe40ff7 FZ |
257 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { |
258 | QLIST_INIT(&bs->op_blockers[i]); | |
259 | } | |
d7d512f6 | 260 | notifier_list_init(&bs->close_notifiers); |
d616b224 | 261 | notifier_with_return_list_init(&bs->before_write_notifiers); |
cc0681c4 BC |
262 | qemu_co_queue_init(&bs->throttled_reqs[0]); |
263 | qemu_co_queue_init(&bs->throttled_reqs[1]); | |
9fcb0251 | 264 | bs->refcnt = 1; |
dcd04228 | 265 | bs->aio_context = qemu_get_aio_context(); |
d7d512f6 | 266 | |
b338082b FB |
267 | return bs; |
268 | } | |
269 | ||
d7d512f6 PB |
270 | void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify) |
271 | { | |
272 | notifier_list_add(&bs->close_notifiers, notify); | |
273 | } | |
274 | ||
ea2384d3 FB |
275 | BlockDriver *bdrv_find_format(const char *format_name) |
276 | { | |
277 | BlockDriver *drv1; | |
8a22f02a SH |
278 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { |
279 | if (!strcmp(drv1->format_name, format_name)) { | |
ea2384d3 | 280 | return drv1; |
8a22f02a | 281 | } |
ea2384d3 FB |
282 | } |
283 | return NULL; | |
284 | } | |
285 | ||
b64ec4e4 | 286 | static int bdrv_is_whitelisted(BlockDriver *drv, bool read_only) |
eb852011 | 287 | { |
b64ec4e4 FZ |
288 | static const char *whitelist_rw[] = { |
289 | CONFIG_BDRV_RW_WHITELIST | |
290 | }; | |
291 | static const char *whitelist_ro[] = { | |
292 | CONFIG_BDRV_RO_WHITELIST | |
eb852011 MA |
293 | }; |
294 | const char **p; | |
295 | ||
b64ec4e4 | 296 | if (!whitelist_rw[0] && !whitelist_ro[0]) { |
eb852011 | 297 | return 1; /* no whitelist, anything goes */ |
b64ec4e4 | 298 | } |
eb852011 | 299 | |
b64ec4e4 | 300 | for (p = whitelist_rw; *p; p++) { |
eb852011 MA |
301 | if (!strcmp(drv->format_name, *p)) { |
302 | return 1; | |
303 | } | |
304 | } | |
b64ec4e4 FZ |
305 | if (read_only) { |
306 | for (p = whitelist_ro; *p; p++) { | |
307 | if (!strcmp(drv->format_name, *p)) { | |
308 | return 1; | |
309 | } | |
310 | } | |
311 | } | |
eb852011 MA |
312 | return 0; |
313 | } | |
314 | ||
5b7e1542 ZYW |
315 | typedef struct CreateCo { |
316 | BlockDriver *drv; | |
317 | char *filename; | |
83d0521a | 318 | QemuOpts *opts; |
5b7e1542 | 319 | int ret; |
cc84d90f | 320 | Error *err; |
5b7e1542 ZYW |
321 | } CreateCo; |
322 | ||
323 | static void coroutine_fn bdrv_create_co_entry(void *opaque) | |
324 | { | |
cc84d90f HR |
325 | Error *local_err = NULL; |
326 | int ret; | |
327 | ||
5b7e1542 ZYW |
328 | CreateCo *cco = opaque; |
329 | assert(cco->drv); | |
330 | ||
c282e1fd | 331 | ret = cco->drv->bdrv_create(cco->filename, cco->opts, &local_err); |
84d18f06 | 332 | if (local_err) { |
cc84d90f HR |
333 | error_propagate(&cco->err, local_err); |
334 | } | |
335 | cco->ret = ret; | |
5b7e1542 ZYW |
336 | } |
337 | ||
0e7e1989 | 338 | int bdrv_create(BlockDriver *drv, const char* filename, |
83d0521a | 339 | QemuOpts *opts, Error **errp) |
ea2384d3 | 340 | { |
5b7e1542 ZYW |
341 | int ret; |
342 | ||
343 | Coroutine *co; | |
344 | CreateCo cco = { | |
345 | .drv = drv, | |
346 | .filename = g_strdup(filename), | |
83d0521a | 347 | .opts = opts, |
5b7e1542 | 348 | .ret = NOT_DONE, |
cc84d90f | 349 | .err = NULL, |
5b7e1542 ZYW |
350 | }; |
351 | ||
c282e1fd | 352 | if (!drv->bdrv_create) { |
cc84d90f | 353 | error_setg(errp, "Driver '%s' does not support image creation", drv->format_name); |
80168bff LC |
354 | ret = -ENOTSUP; |
355 | goto out; | |
5b7e1542 ZYW |
356 | } |
357 | ||
358 | if (qemu_in_coroutine()) { | |
359 | /* Fast-path if already in coroutine context */ | |
360 | bdrv_create_co_entry(&cco); | |
361 | } else { | |
362 | co = qemu_coroutine_create(bdrv_create_co_entry); | |
363 | qemu_coroutine_enter(co, &cco); | |
364 | while (cco.ret == NOT_DONE) { | |
b47ec2c4 | 365 | aio_poll(qemu_get_aio_context(), true); |
5b7e1542 ZYW |
366 | } |
367 | } | |
368 | ||
369 | ret = cco.ret; | |
cc84d90f | 370 | if (ret < 0) { |
84d18f06 | 371 | if (cco.err) { |
cc84d90f HR |
372 | error_propagate(errp, cco.err); |
373 | } else { | |
374 | error_setg_errno(errp, -ret, "Could not create image"); | |
375 | } | |
376 | } | |
0e7e1989 | 377 | |
80168bff LC |
378 | out: |
379 | g_free(cco.filename); | |
5b7e1542 | 380 | return ret; |
ea2384d3 FB |
381 | } |
382 | ||
c282e1fd | 383 | int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp) |
84a12e66 CH |
384 | { |
385 | BlockDriver *drv; | |
cc84d90f HR |
386 | Error *local_err = NULL; |
387 | int ret; | |
84a12e66 | 388 | |
b65a5e12 | 389 | drv = bdrv_find_protocol(filename, true, errp); |
84a12e66 | 390 | if (drv == NULL) { |
16905d71 | 391 | return -ENOENT; |
84a12e66 CH |
392 | } |
393 | ||
c282e1fd | 394 | ret = bdrv_create(drv, filename, opts, &local_err); |
84d18f06 | 395 | if (local_err) { |
cc84d90f HR |
396 | error_propagate(errp, local_err); |
397 | } | |
398 | return ret; | |
84a12e66 CH |
399 | } |
400 | ||
892b7de8 ET |
401 | /** |
402 | * Try to get @bs's logical and physical block size. | |
403 | * On success, store them in @bsz struct and return 0. | |
404 | * On failure return -errno. | |
405 | * @bs must not be empty. | |
406 | */ | |
407 | int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz) | |
408 | { | |
409 | BlockDriver *drv = bs->drv; | |
410 | ||
411 | if (drv && drv->bdrv_probe_blocksizes) { | |
412 | return drv->bdrv_probe_blocksizes(bs, bsz); | |
413 | } | |
414 | ||
415 | return -ENOTSUP; | |
416 | } | |
417 | ||
418 | /** | |
419 | * Try to get @bs's geometry (cyls, heads, sectors). | |
420 | * On success, store them in @geo struct and return 0. | |
421 | * On failure return -errno. | |
422 | * @bs must not be empty. | |
423 | */ | |
424 | int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo) | |
425 | { | |
426 | BlockDriver *drv = bs->drv; | |
427 | ||
428 | if (drv && drv->bdrv_probe_geometry) { | |
429 | return drv->bdrv_probe_geometry(bs, geo); | |
430 | } | |
431 | ||
432 | return -ENOTSUP; | |
433 | } | |
434 | ||
eba25057 JM |
435 | /* |
436 | * Create a uniquely-named empty temporary file. | |
437 | * Return 0 upon success, otherwise a negative errno value. | |
438 | */ | |
439 | int get_tmp_filename(char *filename, int size) | |
d5249393 | 440 | { |
eba25057 | 441 | #ifdef _WIN32 |
3b9f94e1 | 442 | char temp_dir[MAX_PATH]; |
eba25057 JM |
443 | /* GetTempFileName requires that its output buffer (4th param) |
444 | have length MAX_PATH or greater. */ | |
445 | assert(size >= MAX_PATH); | |
446 | return (GetTempPath(MAX_PATH, temp_dir) | |
447 | && GetTempFileName(temp_dir, "qem", 0, filename) | |
448 | ? 0 : -GetLastError()); | |
d5249393 | 449 | #else |
67b915a5 | 450 | int fd; |
7ccfb2eb | 451 | const char *tmpdir; |
0badc1ee | 452 | tmpdir = getenv("TMPDIR"); |
69bef793 AS |
453 | if (!tmpdir) { |
454 | tmpdir = "/var/tmp"; | |
455 | } | |
eba25057 JM |
456 | if (snprintf(filename, size, "%s/vl.XXXXXX", tmpdir) >= size) { |
457 | return -EOVERFLOW; | |
458 | } | |
ea2384d3 | 459 | fd = mkstemp(filename); |
fe235a06 DH |
460 | if (fd < 0) { |
461 | return -errno; | |
462 | } | |
463 | if (close(fd) != 0) { | |
464 | unlink(filename); | |
eba25057 JM |
465 | return -errno; |
466 | } | |
467 | return 0; | |
d5249393 | 468 | #endif |
eba25057 | 469 | } |
fc01f7e7 | 470 | |
84a12e66 CH |
471 | /* |
472 | * Detect host devices. By convention, /dev/cdrom[N] is always | |
473 | * recognized as a host CDROM. | |
474 | */ | |
475 | static BlockDriver *find_hdev_driver(const char *filename) | |
476 | { | |
477 | int score_max = 0, score; | |
478 | BlockDriver *drv = NULL, *d; | |
479 | ||
480 | QLIST_FOREACH(d, &bdrv_drivers, list) { | |
481 | if (d->bdrv_probe_device) { | |
482 | score = d->bdrv_probe_device(filename); | |
483 | if (score > score_max) { | |
484 | score_max = score; | |
485 | drv = d; | |
486 | } | |
487 | } | |
488 | } | |
489 | ||
490 | return drv; | |
491 | } | |
492 | ||
98289620 | 493 | BlockDriver *bdrv_find_protocol(const char *filename, |
b65a5e12 HR |
494 | bool allow_protocol_prefix, |
495 | Error **errp) | |
83f64091 FB |
496 | { |
497 | BlockDriver *drv1; | |
498 | char protocol[128]; | |
1cec71e3 | 499 | int len; |
83f64091 | 500 | const char *p; |
19cb3738 | 501 | |
66f82cee KW |
502 | /* TODO Drivers without bdrv_file_open must be specified explicitly */ |
503 | ||
39508e7a CH |
504 | /* |
505 | * XXX(hch): we really should not let host device detection | |
506 | * override an explicit protocol specification, but moving this | |
507 | * later breaks access to device names with colons in them. | |
508 | * Thanks to the brain-dead persistent naming schemes on udev- | |
509 | * based Linux systems those actually are quite common. | |
510 | */ | |
511 | drv1 = find_hdev_driver(filename); | |
512 | if (drv1) { | |
513 | return drv1; | |
514 | } | |
515 | ||
98289620 | 516 | if (!path_has_protocol(filename) || !allow_protocol_prefix) { |
ef810437 | 517 | return &bdrv_file; |
84a12e66 | 518 | } |
98289620 | 519 | |
9e0b22f4 SH |
520 | p = strchr(filename, ':'); |
521 | assert(p != NULL); | |
1cec71e3 AL |
522 | len = p - filename; |
523 | if (len > sizeof(protocol) - 1) | |
524 | len = sizeof(protocol) - 1; | |
525 | memcpy(protocol, filename, len); | |
526 | protocol[len] = '\0'; | |
8a22f02a | 527 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { |
5fafdf24 | 528 | if (drv1->protocol_name && |
8a22f02a | 529 | !strcmp(drv1->protocol_name, protocol)) { |
83f64091 | 530 | return drv1; |
8a22f02a | 531 | } |
83f64091 | 532 | } |
b65a5e12 HR |
533 | |
534 | error_setg(errp, "Unknown protocol '%s'", protocol); | |
83f64091 FB |
535 | return NULL; |
536 | } | |
537 | ||
c6684249 MA |
538 | /* |
539 | * Guess image format by probing its contents. | |
540 | * This is not a good idea when your image is raw (CVE-2008-2004), but | |
541 | * we do it anyway for backward compatibility. | |
542 | * | |
543 | * @buf contains the image's first @buf_size bytes. | |
7cddd372 KW |
544 | * @buf_size is the buffer size in bytes (generally BLOCK_PROBE_BUF_SIZE, |
545 | * but can be smaller if the image file is smaller) | |
c6684249 MA |
546 | * @filename is its filename. |
547 | * | |
548 | * For all block drivers, call the bdrv_probe() method to get its | |
549 | * probing score. | |
550 | * Return the first block driver with the highest probing score. | |
551 | */ | |
38f3ef57 KW |
552 | BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size, |
553 | const char *filename) | |
c6684249 MA |
554 | { |
555 | int score_max = 0, score; | |
556 | BlockDriver *drv = NULL, *d; | |
557 | ||
558 | QLIST_FOREACH(d, &bdrv_drivers, list) { | |
559 | if (d->bdrv_probe) { | |
560 | score = d->bdrv_probe(buf, buf_size, filename); | |
561 | if (score > score_max) { | |
562 | score_max = score; | |
563 | drv = d; | |
564 | } | |
565 | } | |
566 | } | |
567 | ||
568 | return drv; | |
569 | } | |
570 | ||
f500a6d3 | 571 | static int find_image_format(BlockDriverState *bs, const char *filename, |
34b5d2c6 | 572 | BlockDriver **pdrv, Error **errp) |
f3a5d3f8 | 573 | { |
c6684249 | 574 | BlockDriver *drv; |
7cddd372 | 575 | uint8_t buf[BLOCK_PROBE_BUF_SIZE]; |
f500a6d3 | 576 | int ret = 0; |
f8ea0b00 | 577 | |
08a00559 | 578 | /* Return the raw BlockDriver * to scsi-generic devices or empty drives */ |
b192af8a | 579 | if (bdrv_is_sg(bs) || !bdrv_is_inserted(bs) || bdrv_getlength(bs) == 0) { |
ef810437 | 580 | *pdrv = &bdrv_raw; |
c98ac35d | 581 | return ret; |
1a396859 | 582 | } |
f8ea0b00 | 583 | |
83f64091 | 584 | ret = bdrv_pread(bs, 0, buf, sizeof(buf)); |
83f64091 | 585 | if (ret < 0) { |
34b5d2c6 HR |
586 | error_setg_errno(errp, -ret, "Could not read image for determining its " |
587 | "format"); | |
c98ac35d SW |
588 | *pdrv = NULL; |
589 | return ret; | |
83f64091 FB |
590 | } |
591 | ||
c6684249 | 592 | drv = bdrv_probe_all(buf, ret, filename); |
c98ac35d | 593 | if (!drv) { |
34b5d2c6 HR |
594 | error_setg(errp, "Could not determine image format: No compatible " |
595 | "driver found"); | |
c98ac35d SW |
596 | ret = -ENOENT; |
597 | } | |
598 | *pdrv = drv; | |
599 | return ret; | |
ea2384d3 FB |
600 | } |
601 | ||
51762288 SH |
602 | /** |
603 | * Set the current 'total_sectors' value | |
65a9bb25 | 604 | * Return 0 on success, -errno on error. |
51762288 SH |
605 | */ |
606 | static int refresh_total_sectors(BlockDriverState *bs, int64_t hint) | |
607 | { | |
608 | BlockDriver *drv = bs->drv; | |
609 | ||
396759ad | 610 | /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */ |
b192af8a | 611 | if (bdrv_is_sg(bs)) |
396759ad NB |
612 | return 0; |
613 | ||
51762288 SH |
614 | /* query actual device if possible, otherwise just trust the hint */ |
615 | if (drv->bdrv_getlength) { | |
616 | int64_t length = drv->bdrv_getlength(bs); | |
617 | if (length < 0) { | |
618 | return length; | |
619 | } | |
7e382003 | 620 | hint = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE); |
51762288 SH |
621 | } |
622 | ||
623 | bs->total_sectors = hint; | |
624 | return 0; | |
625 | } | |
626 | ||
cddff5ba KW |
627 | /** |
628 | * Combines a QDict of new block driver @options with any missing options taken | |
629 | * from @old_options, so that leaving out an option defaults to its old value. | |
630 | */ | |
631 | static void bdrv_join_options(BlockDriverState *bs, QDict *options, | |
632 | QDict *old_options) | |
633 | { | |
634 | if (bs->drv && bs->drv->bdrv_join_options) { | |
635 | bs->drv->bdrv_join_options(options, old_options); | |
636 | } else { | |
637 | qdict_join(options, old_options, false); | |
638 | } | |
639 | } | |
640 | ||
9e8f1835 PB |
641 | /** |
642 | * Set open flags for a given discard mode | |
643 | * | |
644 | * Return 0 on success, -1 if the discard mode was invalid. | |
645 | */ | |
646 | int bdrv_parse_discard_flags(const char *mode, int *flags) | |
647 | { | |
648 | *flags &= ~BDRV_O_UNMAP; | |
649 | ||
650 | if (!strcmp(mode, "off") || !strcmp(mode, "ignore")) { | |
651 | /* do nothing */ | |
652 | } else if (!strcmp(mode, "on") || !strcmp(mode, "unmap")) { | |
653 | *flags |= BDRV_O_UNMAP; | |
654 | } else { | |
655 | return -1; | |
656 | } | |
657 | ||
658 | return 0; | |
659 | } | |
660 | ||
c3993cdc SH |
661 | /** |
662 | * Set open flags for a given cache mode | |
663 | * | |
664 | * Return 0 on success, -1 if the cache mode was invalid. | |
665 | */ | |
666 | int bdrv_parse_cache_flags(const char *mode, int *flags) | |
667 | { | |
668 | *flags &= ~BDRV_O_CACHE_MASK; | |
669 | ||
670 | if (!strcmp(mode, "off") || !strcmp(mode, "none")) { | |
671 | *flags |= BDRV_O_NOCACHE | BDRV_O_CACHE_WB; | |
92196b2f SH |
672 | } else if (!strcmp(mode, "directsync")) { |
673 | *flags |= BDRV_O_NOCACHE; | |
c3993cdc SH |
674 | } else if (!strcmp(mode, "writeback")) { |
675 | *flags |= BDRV_O_CACHE_WB; | |
676 | } else if (!strcmp(mode, "unsafe")) { | |
677 | *flags |= BDRV_O_CACHE_WB; | |
678 | *flags |= BDRV_O_NO_FLUSH; | |
679 | } else if (!strcmp(mode, "writethrough")) { | |
680 | /* this is the default */ | |
681 | } else { | |
682 | return -1; | |
683 | } | |
684 | ||
685 | return 0; | |
686 | } | |
687 | ||
b1e6fc08 KW |
688 | /* |
689 | * Returns the flags that a temporary snapshot should get, based on the | |
690 | * originally requested flags (the originally requested image will have flags | |
691 | * like a backing file) | |
692 | */ | |
693 | static int bdrv_temp_snapshot_flags(int flags) | |
694 | { | |
695 | return (flags & ~BDRV_O_SNAPSHOT) | BDRV_O_TEMPORARY; | |
696 | } | |
697 | ||
0b50cc88 | 698 | /* |
8e2160e2 KW |
699 | * Returns the options and flags that bs->file should get if a protocol driver |
700 | * is expected, based on the given options and flags for the parent BDS | |
0b50cc88 | 701 | */ |
8e2160e2 KW |
702 | static void bdrv_inherited_options(int *child_flags, QDict *child_options, |
703 | int parent_flags, QDict *parent_options) | |
0b50cc88 | 704 | { |
8e2160e2 KW |
705 | int flags = parent_flags; |
706 | ||
0b50cc88 KW |
707 | /* Enable protocol handling, disable format probing for bs->file */ |
708 | flags |= BDRV_O_PROTOCOL; | |
709 | ||
91a097e7 KW |
710 | /* If the cache mode isn't explicitly set, inherit direct and no-flush from |
711 | * the parent. */ | |
712 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT); | |
713 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH); | |
714 | ||
0b50cc88 | 715 | /* Our block drivers take care to send flushes and respect unmap policy, |
91a097e7 KW |
716 | * so we can default to enable both on lower layers regardless of the |
717 | * corresponding parent options. */ | |
718 | qdict_set_default_str(child_options, BDRV_OPT_CACHE_WB, "on"); | |
719 | flags |= BDRV_O_UNMAP; | |
0b50cc88 | 720 | |
0b50cc88 | 721 | /* Clear flags that only apply to the top layer */ |
5669b44d | 722 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ); |
0b50cc88 | 723 | |
8e2160e2 | 724 | *child_flags = flags; |
0b50cc88 KW |
725 | } |
726 | ||
f3930ed0 | 727 | const BdrvChildRole child_file = { |
8e2160e2 | 728 | .inherit_options = bdrv_inherited_options, |
f3930ed0 KW |
729 | }; |
730 | ||
731 | /* | |
8e2160e2 KW |
732 | * Returns the options and flags that bs->file should get if the use of formats |
733 | * (and not only protocols) is permitted for it, based on the given options and | |
734 | * flags for the parent BDS | |
f3930ed0 | 735 | */ |
8e2160e2 KW |
736 | static void bdrv_inherited_fmt_options(int *child_flags, QDict *child_options, |
737 | int parent_flags, QDict *parent_options) | |
f3930ed0 | 738 | { |
8e2160e2 KW |
739 | child_file.inherit_options(child_flags, child_options, |
740 | parent_flags, parent_options); | |
741 | ||
742 | *child_flags &= ~BDRV_O_PROTOCOL; | |
f3930ed0 KW |
743 | } |
744 | ||
745 | const BdrvChildRole child_format = { | |
8e2160e2 | 746 | .inherit_options = bdrv_inherited_fmt_options, |
f3930ed0 KW |
747 | }; |
748 | ||
317fc44e | 749 | /* |
8e2160e2 KW |
750 | * Returns the options and flags that bs->backing should get, based on the |
751 | * given options and flags for the parent BDS | |
317fc44e | 752 | */ |
8e2160e2 KW |
753 | static void bdrv_backing_options(int *child_flags, QDict *child_options, |
754 | int parent_flags, QDict *parent_options) | |
317fc44e | 755 | { |
8e2160e2 KW |
756 | int flags = parent_flags; |
757 | ||
91a097e7 KW |
758 | /* The cache mode is inherited unmodified for backing files */ |
759 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_WB); | |
760 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT); | |
761 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH); | |
762 | ||
317fc44e KW |
763 | /* backing files always opened read-only */ |
764 | flags &= ~(BDRV_O_RDWR | BDRV_O_COPY_ON_READ); | |
765 | ||
766 | /* snapshot=on is handled on the top layer */ | |
8bfea15d | 767 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_TEMPORARY); |
317fc44e | 768 | |
8e2160e2 | 769 | *child_flags = flags; |
317fc44e KW |
770 | } |
771 | ||
f3930ed0 | 772 | static const BdrvChildRole child_backing = { |
8e2160e2 | 773 | .inherit_options = bdrv_backing_options, |
f3930ed0 KW |
774 | }; |
775 | ||
7b272452 KW |
776 | static int bdrv_open_flags(BlockDriverState *bs, int flags) |
777 | { | |
778 | int open_flags = flags | BDRV_O_CACHE_WB; | |
779 | ||
780 | /* | |
781 | * Clear flags that are internal to the block layer before opening the | |
782 | * image. | |
783 | */ | |
20cca275 | 784 | open_flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_PROTOCOL); |
7b272452 KW |
785 | |
786 | /* | |
787 | * Snapshots should be writable. | |
788 | */ | |
8bfea15d | 789 | if (flags & BDRV_O_TEMPORARY) { |
7b272452 KW |
790 | open_flags |= BDRV_O_RDWR; |
791 | } | |
792 | ||
793 | return open_flags; | |
794 | } | |
795 | ||
91a097e7 KW |
796 | static void update_flags_from_options(int *flags, QemuOpts *opts) |
797 | { | |
798 | *flags &= ~BDRV_O_CACHE_MASK; | |
799 | ||
800 | assert(qemu_opt_find(opts, BDRV_OPT_CACHE_WB)); | |
801 | if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, false)) { | |
802 | *flags |= BDRV_O_CACHE_WB; | |
803 | } | |
804 | ||
805 | assert(qemu_opt_find(opts, BDRV_OPT_CACHE_NO_FLUSH)); | |
806 | if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_NO_FLUSH, false)) { | |
807 | *flags |= BDRV_O_NO_FLUSH; | |
808 | } | |
809 | ||
810 | assert(qemu_opt_find(opts, BDRV_OPT_CACHE_DIRECT)); | |
811 | if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_DIRECT, false)) { | |
812 | *flags |= BDRV_O_NOCACHE; | |
813 | } | |
814 | } | |
815 | ||
816 | static void update_options_from_flags(QDict *options, int flags) | |
817 | { | |
818 | if (!qdict_haskey(options, BDRV_OPT_CACHE_WB)) { | |
819 | qdict_put(options, BDRV_OPT_CACHE_WB, | |
820 | qbool_from_bool(flags & BDRV_O_CACHE_WB)); | |
821 | } | |
822 | if (!qdict_haskey(options, BDRV_OPT_CACHE_DIRECT)) { | |
823 | qdict_put(options, BDRV_OPT_CACHE_DIRECT, | |
824 | qbool_from_bool(flags & BDRV_O_NOCACHE)); | |
825 | } | |
826 | if (!qdict_haskey(options, BDRV_OPT_CACHE_NO_FLUSH)) { | |
827 | qdict_put(options, BDRV_OPT_CACHE_NO_FLUSH, | |
828 | qbool_from_bool(flags & BDRV_O_NO_FLUSH)); | |
829 | } | |
830 | } | |
831 | ||
636ea370 KW |
832 | static void bdrv_assign_node_name(BlockDriverState *bs, |
833 | const char *node_name, | |
834 | Error **errp) | |
6913c0c2 | 835 | { |
15489c76 | 836 | char *gen_node_name = NULL; |
6913c0c2 | 837 | |
15489c76 JC |
838 | if (!node_name) { |
839 | node_name = gen_node_name = id_generate(ID_BLOCK); | |
840 | } else if (!id_wellformed(node_name)) { | |
841 | /* | |
842 | * Check for empty string or invalid characters, but not if it is | |
843 | * generated (generated names use characters not available to the user) | |
844 | */ | |
9aebf3b8 | 845 | error_setg(errp, "Invalid node name"); |
636ea370 | 846 | return; |
6913c0c2 BC |
847 | } |
848 | ||
0c5e94ee | 849 | /* takes care of avoiding namespaces collisions */ |
7f06d47e | 850 | if (blk_by_name(node_name)) { |
0c5e94ee BC |
851 | error_setg(errp, "node-name=%s is conflicting with a device id", |
852 | node_name); | |
15489c76 | 853 | goto out; |
0c5e94ee BC |
854 | } |
855 | ||
6913c0c2 BC |
856 | /* takes care of avoiding duplicates node names */ |
857 | if (bdrv_find_node(node_name)) { | |
858 | error_setg(errp, "Duplicate node name"); | |
15489c76 | 859 | goto out; |
6913c0c2 BC |
860 | } |
861 | ||
862 | /* copy node name into the bs and insert it into the graph list */ | |
863 | pstrcpy(bs->node_name, sizeof(bs->node_name), node_name); | |
864 | QTAILQ_INSERT_TAIL(&graph_bdrv_states, bs, node_list); | |
15489c76 JC |
865 | out: |
866 | g_free(gen_node_name); | |
6913c0c2 BC |
867 | } |
868 | ||
18edf289 KW |
869 | static QemuOptsList bdrv_runtime_opts = { |
870 | .name = "bdrv_common", | |
871 | .head = QTAILQ_HEAD_INITIALIZER(bdrv_runtime_opts.head), | |
872 | .desc = { | |
873 | { | |
874 | .name = "node-name", | |
875 | .type = QEMU_OPT_STRING, | |
876 | .help = "Node name of the block device node", | |
877 | }, | |
62392ebb KW |
878 | { |
879 | .name = "driver", | |
880 | .type = QEMU_OPT_STRING, | |
881 | .help = "Block driver to use for the node", | |
882 | }, | |
91a097e7 KW |
883 | { |
884 | .name = BDRV_OPT_CACHE_WB, | |
885 | .type = QEMU_OPT_BOOL, | |
886 | .help = "Enable writeback mode", | |
887 | }, | |
888 | { | |
889 | .name = BDRV_OPT_CACHE_DIRECT, | |
890 | .type = QEMU_OPT_BOOL, | |
891 | .help = "Bypass software writeback cache on the host", | |
892 | }, | |
893 | { | |
894 | .name = BDRV_OPT_CACHE_NO_FLUSH, | |
895 | .type = QEMU_OPT_BOOL, | |
896 | .help = "Ignore flush requests", | |
897 | }, | |
18edf289 KW |
898 | { /* end of list */ } |
899 | }, | |
900 | }; | |
901 | ||
57915332 KW |
902 | /* |
903 | * Common part for opening disk images and files | |
b6ad491a KW |
904 | * |
905 | * Removes all processed options from *options. | |
57915332 | 906 | */ |
9a4f4c31 | 907 | static int bdrv_open_common(BlockDriverState *bs, BdrvChild *file, |
62392ebb | 908 | QDict *options, int flags, Error **errp) |
57915332 KW |
909 | { |
910 | int ret, open_flags; | |
035fccdf | 911 | const char *filename; |
62392ebb | 912 | const char *driver_name = NULL; |
6913c0c2 | 913 | const char *node_name = NULL; |
18edf289 | 914 | QemuOpts *opts; |
62392ebb | 915 | BlockDriver *drv; |
34b5d2c6 | 916 | Error *local_err = NULL; |
57915332 | 917 | |
6405875c | 918 | assert(bs->file == NULL); |
707ff828 | 919 | assert(options != NULL && bs->options != options); |
57915332 | 920 | |
62392ebb KW |
921 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); |
922 | qemu_opts_absorb_qdict(opts, options, &local_err); | |
923 | if (local_err) { | |
924 | error_propagate(errp, local_err); | |
925 | ret = -EINVAL; | |
926 | goto fail_opts; | |
927 | } | |
928 | ||
929 | driver_name = qemu_opt_get(opts, "driver"); | |
930 | drv = bdrv_find_format(driver_name); | |
931 | assert(drv != NULL); | |
932 | ||
45673671 | 933 | if (file != NULL) { |
9a4f4c31 | 934 | filename = file->bs->filename; |
45673671 KW |
935 | } else { |
936 | filename = qdict_get_try_str(options, "filename"); | |
937 | } | |
938 | ||
765003db KW |
939 | if (drv->bdrv_needs_filename && !filename) { |
940 | error_setg(errp, "The '%s' block driver requires a file name", | |
941 | drv->format_name); | |
18edf289 KW |
942 | ret = -EINVAL; |
943 | goto fail_opts; | |
6913c0c2 | 944 | } |
6913c0c2 | 945 | |
62392ebb KW |
946 | trace_bdrv_open_common(bs, filename ?: "", flags, drv->format_name); |
947 | ||
18edf289 | 948 | node_name = qemu_opt_get(opts, "node-name"); |
636ea370 | 949 | bdrv_assign_node_name(bs, node_name, &local_err); |
0fb6395c | 950 | if (local_err) { |
636ea370 | 951 | error_propagate(errp, local_err); |
18edf289 KW |
952 | ret = -EINVAL; |
953 | goto fail_opts; | |
5d186eb0 KW |
954 | } |
955 | ||
c25f53b0 | 956 | bs->request_alignment = 512; |
0d51b4de | 957 | bs->zero_beyond_eof = true; |
b64ec4e4 FZ |
958 | open_flags = bdrv_open_flags(bs, flags); |
959 | bs->read_only = !(open_flags & BDRV_O_RDWR); | |
960 | ||
961 | if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv, bs->read_only)) { | |
8f94a6e4 KW |
962 | error_setg(errp, |
963 | !bs->read_only && bdrv_is_whitelisted(drv, true) | |
964 | ? "Driver '%s' can only be used for read-only devices" | |
965 | : "Driver '%s' is not whitelisted", | |
966 | drv->format_name); | |
18edf289 KW |
967 | ret = -ENOTSUP; |
968 | goto fail_opts; | |
b64ec4e4 | 969 | } |
57915332 | 970 | |
53fec9d3 | 971 | assert(bs->copy_on_read == 0); /* bdrv_new() and bdrv_close() make it so */ |
0ebd24e0 KW |
972 | if (flags & BDRV_O_COPY_ON_READ) { |
973 | if (!bs->read_only) { | |
974 | bdrv_enable_copy_on_read(bs); | |
975 | } else { | |
976 | error_setg(errp, "Can't use copy-on-read on read-only device"); | |
18edf289 KW |
977 | ret = -EINVAL; |
978 | goto fail_opts; | |
0ebd24e0 | 979 | } |
53fec9d3 SH |
980 | } |
981 | ||
c2ad1b0c KW |
982 | if (filename != NULL) { |
983 | pstrcpy(bs->filename, sizeof(bs->filename), filename); | |
984 | } else { | |
985 | bs->filename[0] = '\0'; | |
986 | } | |
91af7014 | 987 | pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), bs->filename); |
57915332 | 988 | |
57915332 | 989 | bs->drv = drv; |
7267c094 | 990 | bs->opaque = g_malloc0(drv->instance_size); |
57915332 | 991 | |
91a097e7 KW |
992 | /* Apply cache mode options */ |
993 | update_flags_from_options(&bs->open_flags, opts); | |
994 | bdrv_set_enable_write_cache(bs, bs->open_flags & BDRV_O_CACHE_WB); | |
e7c63796 | 995 | |
66f82cee KW |
996 | /* Open the image, either directly or using a protocol */ |
997 | if (drv->bdrv_file_open) { | |
5d186eb0 | 998 | assert(file == NULL); |
030be321 | 999 | assert(!drv->bdrv_needs_filename || filename != NULL); |
34b5d2c6 | 1000 | ret = drv->bdrv_file_open(bs, options, open_flags, &local_err); |
f500a6d3 | 1001 | } else { |
2af5ef70 | 1002 | if (file == NULL) { |
34b5d2c6 HR |
1003 | error_setg(errp, "Can't use '%s' as a block driver for the " |
1004 | "protocol level", drv->format_name); | |
2af5ef70 KW |
1005 | ret = -EINVAL; |
1006 | goto free_and_fail; | |
1007 | } | |
f500a6d3 | 1008 | bs->file = file; |
34b5d2c6 | 1009 | ret = drv->bdrv_open(bs, options, open_flags, &local_err); |
66f82cee KW |
1010 | } |
1011 | ||
57915332 | 1012 | if (ret < 0) { |
84d18f06 | 1013 | if (local_err) { |
34b5d2c6 | 1014 | error_propagate(errp, local_err); |
2fa9aa59 DH |
1015 | } else if (bs->filename[0]) { |
1016 | error_setg_errno(errp, -ret, "Could not open '%s'", bs->filename); | |
34b5d2c6 HR |
1017 | } else { |
1018 | error_setg_errno(errp, -ret, "Could not open image"); | |
1019 | } | |
57915332 KW |
1020 | goto free_and_fail; |
1021 | } | |
1022 | ||
a1f688f4 MA |
1023 | if (bs->encrypted) { |
1024 | error_report("Encrypted images are deprecated"); | |
1025 | error_printf("Support for them will be removed in a future release.\n" | |
1026 | "You can use 'qemu-img convert' to convert your image" | |
1027 | " to an unencrypted one.\n"); | |
1028 | } | |
1029 | ||
51762288 SH |
1030 | ret = refresh_total_sectors(bs, bs->total_sectors); |
1031 | if (ret < 0) { | |
34b5d2c6 | 1032 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); |
51762288 | 1033 | goto free_and_fail; |
57915332 | 1034 | } |
51762288 | 1035 | |
3baca891 KW |
1036 | bdrv_refresh_limits(bs, &local_err); |
1037 | if (local_err) { | |
1038 | error_propagate(errp, local_err); | |
1039 | ret = -EINVAL; | |
1040 | goto free_and_fail; | |
1041 | } | |
1042 | ||
c25f53b0 | 1043 | assert(bdrv_opt_mem_align(bs) != 0); |
4196d2f0 | 1044 | assert(bdrv_min_mem_align(bs) != 0); |
b192af8a | 1045 | assert((bs->request_alignment != 0) || bdrv_is_sg(bs)); |
18edf289 KW |
1046 | |
1047 | qemu_opts_del(opts); | |
57915332 KW |
1048 | return 0; |
1049 | ||
1050 | free_and_fail: | |
f500a6d3 | 1051 | bs->file = NULL; |
7267c094 | 1052 | g_free(bs->opaque); |
57915332 KW |
1053 | bs->opaque = NULL; |
1054 | bs->drv = NULL; | |
18edf289 KW |
1055 | fail_opts: |
1056 | qemu_opts_del(opts); | |
57915332 KW |
1057 | return ret; |
1058 | } | |
1059 | ||
5e5c4f63 KW |
1060 | static QDict *parse_json_filename(const char *filename, Error **errp) |
1061 | { | |
1062 | QObject *options_obj; | |
1063 | QDict *options; | |
1064 | int ret; | |
1065 | ||
1066 | ret = strstart(filename, "json:", &filename); | |
1067 | assert(ret); | |
1068 | ||
1069 | options_obj = qobject_from_json(filename); | |
1070 | if (!options_obj) { | |
1071 | error_setg(errp, "Could not parse the JSON options"); | |
1072 | return NULL; | |
1073 | } | |
1074 | ||
1075 | if (qobject_type(options_obj) != QTYPE_QDICT) { | |
1076 | qobject_decref(options_obj); | |
1077 | error_setg(errp, "Invalid JSON object given"); | |
1078 | return NULL; | |
1079 | } | |
1080 | ||
1081 | options = qobject_to_qdict(options_obj); | |
1082 | qdict_flatten(options); | |
1083 | ||
1084 | return options; | |
1085 | } | |
1086 | ||
de3b53f0 KW |
1087 | static void parse_json_protocol(QDict *options, const char **pfilename, |
1088 | Error **errp) | |
1089 | { | |
1090 | QDict *json_options; | |
1091 | Error *local_err = NULL; | |
1092 | ||
1093 | /* Parse json: pseudo-protocol */ | |
1094 | if (!*pfilename || !g_str_has_prefix(*pfilename, "json:")) { | |
1095 | return; | |
1096 | } | |
1097 | ||
1098 | json_options = parse_json_filename(*pfilename, &local_err); | |
1099 | if (local_err) { | |
1100 | error_propagate(errp, local_err); | |
1101 | return; | |
1102 | } | |
1103 | ||
1104 | /* Options given in the filename have lower priority than options | |
1105 | * specified directly */ | |
1106 | qdict_join(options, json_options, false); | |
1107 | QDECREF(json_options); | |
1108 | *pfilename = NULL; | |
1109 | } | |
1110 | ||
b6ce07aa | 1111 | /* |
f54120ff KW |
1112 | * Fills in default options for opening images and converts the legacy |
1113 | * filename/flags pair to option QDict entries. | |
53a29513 HR |
1114 | * The BDRV_O_PROTOCOL flag in *flags will be set or cleared accordingly if a |
1115 | * block driver has been specified explicitly. | |
b6ce07aa | 1116 | */ |
de3b53f0 | 1117 | static int bdrv_fill_options(QDict **options, const char *filename, |
053e1578 | 1118 | int *flags, Error **errp) |
ea2384d3 | 1119 | { |
c2ad1b0c | 1120 | const char *drvname; |
53a29513 | 1121 | bool protocol = *flags & BDRV_O_PROTOCOL; |
e3fa4bfa | 1122 | bool parse_filename = false; |
053e1578 | 1123 | BlockDriver *drv = NULL; |
34b5d2c6 | 1124 | Error *local_err = NULL; |
83f64091 | 1125 | |
53a29513 | 1126 | drvname = qdict_get_try_str(*options, "driver"); |
053e1578 HR |
1127 | if (drvname) { |
1128 | drv = bdrv_find_format(drvname); | |
1129 | if (!drv) { | |
1130 | error_setg(errp, "Unknown driver '%s'", drvname); | |
1131 | return -ENOENT; | |
1132 | } | |
1133 | /* If the user has explicitly specified the driver, this choice should | |
1134 | * override the BDRV_O_PROTOCOL flag */ | |
1135 | protocol = drv->bdrv_file_open; | |
53a29513 HR |
1136 | } |
1137 | ||
1138 | if (protocol) { | |
1139 | *flags |= BDRV_O_PROTOCOL; | |
1140 | } else { | |
1141 | *flags &= ~BDRV_O_PROTOCOL; | |
1142 | } | |
1143 | ||
91a097e7 KW |
1144 | /* Translate cache options from flags into options */ |
1145 | update_options_from_flags(*options, *flags); | |
1146 | ||
035fccdf | 1147 | /* Fetch the file name from the options QDict if necessary */ |
17b005f1 | 1148 | if (protocol && filename) { |
f54120ff KW |
1149 | if (!qdict_haskey(*options, "filename")) { |
1150 | qdict_put(*options, "filename", qstring_from_str(filename)); | |
1151 | parse_filename = true; | |
1152 | } else { | |
1153 | error_setg(errp, "Can't specify 'file' and 'filename' options at " | |
1154 | "the same time"); | |
1155 | return -EINVAL; | |
1156 | } | |
035fccdf KW |
1157 | } |
1158 | ||
c2ad1b0c | 1159 | /* Find the right block driver */ |
f54120ff | 1160 | filename = qdict_get_try_str(*options, "filename"); |
f54120ff | 1161 | |
053e1578 HR |
1162 | if (!drvname && protocol) { |
1163 | if (filename) { | |
1164 | drv = bdrv_find_protocol(filename, parse_filename, errp); | |
17b005f1 | 1165 | if (!drv) { |
053e1578 | 1166 | return -EINVAL; |
17b005f1 | 1167 | } |
053e1578 HR |
1168 | |
1169 | drvname = drv->format_name; | |
1170 | qdict_put(*options, "driver", qstring_from_str(drvname)); | |
1171 | } else { | |
1172 | error_setg(errp, "Must specify either driver or file"); | |
1173 | return -EINVAL; | |
98289620 | 1174 | } |
c2ad1b0c KW |
1175 | } |
1176 | ||
17b005f1 | 1177 | assert(drv || !protocol); |
c2ad1b0c | 1178 | |
f54120ff | 1179 | /* Driver-specific filename parsing */ |
17b005f1 | 1180 | if (drv && drv->bdrv_parse_filename && parse_filename) { |
5acd9d81 | 1181 | drv->bdrv_parse_filename(filename, *options, &local_err); |
84d18f06 | 1182 | if (local_err) { |
34b5d2c6 | 1183 | error_propagate(errp, local_err); |
f54120ff | 1184 | return -EINVAL; |
6963a30d | 1185 | } |
cd5d031e HR |
1186 | |
1187 | if (!drv->bdrv_needs_filename) { | |
1188 | qdict_del(*options, "filename"); | |
cd5d031e | 1189 | } |
6963a30d KW |
1190 | } |
1191 | ||
d44f928a HR |
1192 | if (runstate_check(RUN_STATE_INMIGRATE)) { |
1193 | *flags |= BDRV_O_INCOMING; | |
1194 | } | |
1195 | ||
f54120ff KW |
1196 | return 0; |
1197 | } | |
1198 | ||
b4b059f6 KW |
1199 | static BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs, |
1200 | BlockDriverState *child_bs, | |
260fecf1 | 1201 | const char *child_name, |
b4b059f6 | 1202 | const BdrvChildRole *child_role) |
df581792 KW |
1203 | { |
1204 | BdrvChild *child = g_new(BdrvChild, 1); | |
1205 | *child = (BdrvChild) { | |
1206 | .bs = child_bs, | |
260fecf1 | 1207 | .name = g_strdup(child_name), |
df581792 KW |
1208 | .role = child_role, |
1209 | }; | |
1210 | ||
1211 | QLIST_INSERT_HEAD(&parent_bs->children, child, next); | |
d42a8a93 | 1212 | QLIST_INSERT_HEAD(&child_bs->parents, child, next_parent); |
b4b059f6 KW |
1213 | |
1214 | return child; | |
df581792 KW |
1215 | } |
1216 | ||
3f09bfbc | 1217 | static void bdrv_detach_child(BdrvChild *child) |
33a60407 KW |
1218 | { |
1219 | QLIST_REMOVE(child, next); | |
d42a8a93 | 1220 | QLIST_REMOVE(child, next_parent); |
260fecf1 | 1221 | g_free(child->name); |
33a60407 KW |
1222 | g_free(child); |
1223 | } | |
1224 | ||
1225 | void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child) | |
1226 | { | |
779020cb KW |
1227 | BlockDriverState *child_bs; |
1228 | ||
1229 | if (child == NULL) { | |
1230 | return; | |
1231 | } | |
33a60407 KW |
1232 | |
1233 | if (child->bs->inherits_from == parent) { | |
1234 | child->bs->inherits_from = NULL; | |
1235 | } | |
1236 | ||
779020cb | 1237 | child_bs = child->bs; |
33a60407 KW |
1238 | bdrv_detach_child(child); |
1239 | bdrv_unref(child_bs); | |
1240 | } | |
1241 | ||
5db15a57 KW |
1242 | /* |
1243 | * Sets the backing file link of a BDS. A new reference is created; callers | |
1244 | * which don't need their own reference any more must call bdrv_unref(). | |
1245 | */ | |
8d24cce1 FZ |
1246 | void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd) |
1247 | { | |
5db15a57 KW |
1248 | if (backing_hd) { |
1249 | bdrv_ref(backing_hd); | |
1250 | } | |
8d24cce1 | 1251 | |
760e0063 | 1252 | if (bs->backing) { |
826b6ca0 | 1253 | assert(bs->backing_blocker); |
760e0063 | 1254 | bdrv_op_unblock_all(bs->backing->bs, bs->backing_blocker); |
5db15a57 | 1255 | bdrv_unref_child(bs, bs->backing); |
826b6ca0 FZ |
1256 | } else if (backing_hd) { |
1257 | error_setg(&bs->backing_blocker, | |
81e5f78a AG |
1258 | "node is used as backing hd of '%s'", |
1259 | bdrv_get_device_or_node_name(bs)); | |
826b6ca0 FZ |
1260 | } |
1261 | ||
8d24cce1 | 1262 | if (!backing_hd) { |
826b6ca0 FZ |
1263 | error_free(bs->backing_blocker); |
1264 | bs->backing_blocker = NULL; | |
760e0063 | 1265 | bs->backing = NULL; |
8d24cce1 FZ |
1266 | goto out; |
1267 | } | |
260fecf1 | 1268 | bs->backing = bdrv_attach_child(bs, backing_hd, "backing", &child_backing); |
8d24cce1 FZ |
1269 | bs->open_flags &= ~BDRV_O_NO_BACKING; |
1270 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_hd->filename); | |
1271 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), | |
1272 | backing_hd->drv ? backing_hd->drv->format_name : ""); | |
826b6ca0 | 1273 | |
760e0063 | 1274 | bdrv_op_block_all(backing_hd, bs->backing_blocker); |
826b6ca0 | 1275 | /* Otherwise we won't be able to commit due to check in bdrv_commit */ |
760e0063 | 1276 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_COMMIT_TARGET, |
826b6ca0 | 1277 | bs->backing_blocker); |
8d24cce1 | 1278 | out: |
3baca891 | 1279 | bdrv_refresh_limits(bs, NULL); |
8d24cce1 FZ |
1280 | } |
1281 | ||
31ca6d07 KW |
1282 | /* |
1283 | * Opens the backing file for a BlockDriverState if not yet open | |
1284 | * | |
d9b7b057 KW |
1285 | * bdref_key specifies the key for the image's BlockdevRef in the options QDict. |
1286 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
1287 | * itself, all options starting with "${bdref_key}." are considered part of the | |
1288 | * BlockdevRef. | |
1289 | * | |
1290 | * TODO Can this be unified with bdrv_open_image()? | |
31ca6d07 | 1291 | */ |
d9b7b057 KW |
1292 | int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options, |
1293 | const char *bdref_key, Error **errp) | |
9156df12 | 1294 | { |
1ba4b6a5 | 1295 | char *backing_filename = g_malloc0(PATH_MAX); |
d9b7b057 KW |
1296 | char *bdref_key_dot; |
1297 | const char *reference = NULL; | |
317fc44e | 1298 | int ret = 0; |
8d24cce1 | 1299 | BlockDriverState *backing_hd; |
d9b7b057 KW |
1300 | QDict *options; |
1301 | QDict *tmp_parent_options = NULL; | |
34b5d2c6 | 1302 | Error *local_err = NULL; |
9156df12 | 1303 | |
760e0063 | 1304 | if (bs->backing != NULL) { |
1ba4b6a5 | 1305 | goto free_exit; |
9156df12 PB |
1306 | } |
1307 | ||
31ca6d07 | 1308 | /* NULL means an empty set of options */ |
d9b7b057 KW |
1309 | if (parent_options == NULL) { |
1310 | tmp_parent_options = qdict_new(); | |
1311 | parent_options = tmp_parent_options; | |
31ca6d07 KW |
1312 | } |
1313 | ||
9156df12 | 1314 | bs->open_flags &= ~BDRV_O_NO_BACKING; |
d9b7b057 KW |
1315 | |
1316 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); | |
1317 | qdict_extract_subqdict(parent_options, &options, bdref_key_dot); | |
1318 | g_free(bdref_key_dot); | |
1319 | ||
1320 | reference = qdict_get_try_str(parent_options, bdref_key); | |
1321 | if (reference || qdict_haskey(options, "file.filename")) { | |
1cb6f506 KW |
1322 | backing_filename[0] = '\0'; |
1323 | } else if (bs->backing_file[0] == '\0' && qdict_size(options) == 0) { | |
31ca6d07 | 1324 | QDECREF(options); |
1ba4b6a5 | 1325 | goto free_exit; |
dbecebdd | 1326 | } else { |
9f07429e HR |
1327 | bdrv_get_full_backing_filename(bs, backing_filename, PATH_MAX, |
1328 | &local_err); | |
1329 | if (local_err) { | |
1330 | ret = -EINVAL; | |
1331 | error_propagate(errp, local_err); | |
1332 | QDECREF(options); | |
1333 | goto free_exit; | |
1334 | } | |
9156df12 PB |
1335 | } |
1336 | ||
8ee79e70 KW |
1337 | if (!bs->drv || !bs->drv->supports_backing) { |
1338 | ret = -EINVAL; | |
1339 | error_setg(errp, "Driver doesn't support backing files"); | |
1340 | QDECREF(options); | |
1341 | goto free_exit; | |
1342 | } | |
1343 | ||
c5f6e493 KW |
1344 | if (bs->backing_format[0] != '\0' && !qdict_haskey(options, "driver")) { |
1345 | qdict_put(options, "driver", qstring_from_str(bs->backing_format)); | |
9156df12 PB |
1346 | } |
1347 | ||
d9b7b057 | 1348 | backing_hd = NULL; |
f3930ed0 KW |
1349 | ret = bdrv_open_inherit(&backing_hd, |
1350 | *backing_filename ? backing_filename : NULL, | |
d9b7b057 KW |
1351 | reference, options, 0, bs, &child_backing, |
1352 | &local_err); | |
9156df12 | 1353 | if (ret < 0) { |
9156df12 | 1354 | bs->open_flags |= BDRV_O_NO_BACKING; |
b04b6b6e FZ |
1355 | error_setg(errp, "Could not open backing file: %s", |
1356 | error_get_pretty(local_err)); | |
1357 | error_free(local_err); | |
1ba4b6a5 | 1358 | goto free_exit; |
9156df12 | 1359 | } |
df581792 | 1360 | |
5db15a57 KW |
1361 | /* Hook up the backing file link; drop our reference, bs owns the |
1362 | * backing_hd reference now */ | |
8d24cce1 | 1363 | bdrv_set_backing_hd(bs, backing_hd); |
5db15a57 | 1364 | bdrv_unref(backing_hd); |
d80ac658 | 1365 | |
d9b7b057 KW |
1366 | qdict_del(parent_options, bdref_key); |
1367 | ||
1ba4b6a5 BC |
1368 | free_exit: |
1369 | g_free(backing_filename); | |
d9b7b057 | 1370 | QDECREF(tmp_parent_options); |
1ba4b6a5 | 1371 | return ret; |
9156df12 PB |
1372 | } |
1373 | ||
da557aac HR |
1374 | /* |
1375 | * Opens a disk image whose options are given as BlockdevRef in another block | |
1376 | * device's options. | |
1377 | * | |
da557aac | 1378 | * If allow_none is true, no image will be opened if filename is false and no |
b4b059f6 | 1379 | * BlockdevRef is given. NULL will be returned, but errp remains unset. |
da557aac HR |
1380 | * |
1381 | * bdrev_key specifies the key for the image's BlockdevRef in the options QDict. | |
1382 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
1383 | * itself, all options starting with "${bdref_key}." are considered part of the | |
1384 | * BlockdevRef. | |
1385 | * | |
1386 | * The BlockdevRef will be removed from the options QDict. | |
1387 | */ | |
b4b059f6 KW |
1388 | BdrvChild *bdrv_open_child(const char *filename, |
1389 | QDict *options, const char *bdref_key, | |
1390 | BlockDriverState* parent, | |
1391 | const BdrvChildRole *child_role, | |
1392 | bool allow_none, Error **errp) | |
da557aac | 1393 | { |
b4b059f6 KW |
1394 | BdrvChild *c = NULL; |
1395 | BlockDriverState *bs; | |
da557aac HR |
1396 | QDict *image_options; |
1397 | int ret; | |
1398 | char *bdref_key_dot; | |
1399 | const char *reference; | |
1400 | ||
df581792 | 1401 | assert(child_role != NULL); |
f67503e5 | 1402 | |
da557aac HR |
1403 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); |
1404 | qdict_extract_subqdict(options, &image_options, bdref_key_dot); | |
1405 | g_free(bdref_key_dot); | |
1406 | ||
1407 | reference = qdict_get_try_str(options, bdref_key); | |
1408 | if (!filename && !reference && !qdict_size(image_options)) { | |
b4b059f6 | 1409 | if (!allow_none) { |
da557aac HR |
1410 | error_setg(errp, "A block device must be specified for \"%s\"", |
1411 | bdref_key); | |
da557aac | 1412 | } |
b20e61e0 | 1413 | QDECREF(image_options); |
da557aac HR |
1414 | goto done; |
1415 | } | |
1416 | ||
b4b059f6 KW |
1417 | bs = NULL; |
1418 | ret = bdrv_open_inherit(&bs, filename, reference, image_options, 0, | |
ce343771 | 1419 | parent, child_role, errp); |
df581792 KW |
1420 | if (ret < 0) { |
1421 | goto done; | |
1422 | } | |
1423 | ||
260fecf1 | 1424 | c = bdrv_attach_child(parent, bs, bdref_key, child_role); |
da557aac HR |
1425 | |
1426 | done: | |
1427 | qdict_del(options, bdref_key); | |
b4b059f6 KW |
1428 | return c; |
1429 | } | |
1430 | ||
6b8aeca5 | 1431 | int bdrv_append_temp_snapshot(BlockDriverState *bs, int flags, Error **errp) |
b998875d KW |
1432 | { |
1433 | /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */ | |
1ba4b6a5 | 1434 | char *tmp_filename = g_malloc0(PATH_MAX + 1); |
b998875d | 1435 | int64_t total_size; |
83d0521a | 1436 | QemuOpts *opts = NULL; |
b998875d KW |
1437 | QDict *snapshot_options; |
1438 | BlockDriverState *bs_snapshot; | |
c2e0dbbf | 1439 | Error *local_err = NULL; |
b998875d KW |
1440 | int ret; |
1441 | ||
1442 | /* if snapshot, we create a temporary backing file and open it | |
1443 | instead of opening 'filename' directly */ | |
1444 | ||
1445 | /* Get the required size from the image */ | |
f187743a KW |
1446 | total_size = bdrv_getlength(bs); |
1447 | if (total_size < 0) { | |
6b8aeca5 | 1448 | ret = total_size; |
f187743a | 1449 | error_setg_errno(errp, -total_size, "Could not get image size"); |
1ba4b6a5 | 1450 | goto out; |
f187743a | 1451 | } |
b998875d KW |
1452 | |
1453 | /* Create the temporary image */ | |
1ba4b6a5 | 1454 | ret = get_tmp_filename(tmp_filename, PATH_MAX + 1); |
b998875d KW |
1455 | if (ret < 0) { |
1456 | error_setg_errno(errp, -ret, "Could not get temporary filename"); | |
1ba4b6a5 | 1457 | goto out; |
b998875d KW |
1458 | } |
1459 | ||
ef810437 | 1460 | opts = qemu_opts_create(bdrv_qcow2.create_opts, NULL, 0, |
c282e1fd | 1461 | &error_abort); |
39101f25 | 1462 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_size, &error_abort); |
ef810437 | 1463 | ret = bdrv_create(&bdrv_qcow2, tmp_filename, opts, &local_err); |
83d0521a | 1464 | qemu_opts_del(opts); |
b998875d KW |
1465 | if (ret < 0) { |
1466 | error_setg_errno(errp, -ret, "Could not create temporary overlay " | |
1467 | "'%s': %s", tmp_filename, | |
1468 | error_get_pretty(local_err)); | |
1469 | error_free(local_err); | |
1ba4b6a5 | 1470 | goto out; |
b998875d KW |
1471 | } |
1472 | ||
1473 | /* Prepare a new options QDict for the temporary file */ | |
1474 | snapshot_options = qdict_new(); | |
1475 | qdict_put(snapshot_options, "file.driver", | |
1476 | qstring_from_str("file")); | |
1477 | qdict_put(snapshot_options, "file.filename", | |
1478 | qstring_from_str(tmp_filename)); | |
e6641719 HR |
1479 | qdict_put(snapshot_options, "driver", |
1480 | qstring_from_str("qcow2")); | |
b998875d | 1481 | |
e4e9986b | 1482 | bs_snapshot = bdrv_new(); |
b998875d KW |
1483 | |
1484 | ret = bdrv_open(&bs_snapshot, NULL, NULL, snapshot_options, | |
6ebf9aa2 | 1485 | flags, &local_err); |
b998875d KW |
1486 | if (ret < 0) { |
1487 | error_propagate(errp, local_err); | |
1ba4b6a5 | 1488 | goto out; |
b998875d KW |
1489 | } |
1490 | ||
1491 | bdrv_append(bs_snapshot, bs); | |
1ba4b6a5 BC |
1492 | |
1493 | out: | |
1494 | g_free(tmp_filename); | |
6b8aeca5 | 1495 | return ret; |
b998875d KW |
1496 | } |
1497 | ||
b6ce07aa KW |
1498 | /* |
1499 | * Opens a disk image (raw, qcow2, vmdk, ...) | |
de9c0cec KW |
1500 | * |
1501 | * options is a QDict of options to pass to the block drivers, or NULL for an | |
1502 | * empty set of options. The reference to the QDict belongs to the block layer | |
1503 | * after the call (even on failure), so if the caller intends to reuse the | |
1504 | * dictionary, it needs to use QINCREF() before calling bdrv_open. | |
f67503e5 HR |
1505 | * |
1506 | * If *pbs is NULL, a new BDS will be created with a pointer to it stored there. | |
1507 | * If it is not NULL, the referenced BDS will be reused. | |
ddf5636d HR |
1508 | * |
1509 | * The reference parameter may be used to specify an existing block device which | |
1510 | * should be opened. If specified, neither options nor a filename may be given, | |
1511 | * nor can an existing BDS be reused (that is, *pbs has to be NULL). | |
b6ce07aa | 1512 | */ |
f3930ed0 KW |
1513 | static int bdrv_open_inherit(BlockDriverState **pbs, const char *filename, |
1514 | const char *reference, QDict *options, int flags, | |
1515 | BlockDriverState *parent, | |
ce343771 | 1516 | const BdrvChildRole *child_role, Error **errp) |
ea2384d3 | 1517 | { |
b6ce07aa | 1518 | int ret; |
9a4f4c31 KW |
1519 | BdrvChild *file = NULL; |
1520 | BlockDriverState *bs; | |
ce343771 | 1521 | BlockDriver *drv = NULL; |
74fe54f2 | 1522 | const char *drvname; |
3e8c2e57 | 1523 | const char *backing; |
34b5d2c6 | 1524 | Error *local_err = NULL; |
b1e6fc08 | 1525 | int snapshot_flags = 0; |
712e7874 | 1526 | |
f67503e5 | 1527 | assert(pbs); |
f3930ed0 KW |
1528 | assert(!child_role || !flags); |
1529 | assert(!child_role == !parent); | |
f67503e5 | 1530 | |
ddf5636d HR |
1531 | if (reference) { |
1532 | bool options_non_empty = options ? qdict_size(options) : false; | |
1533 | QDECREF(options); | |
1534 | ||
1535 | if (*pbs) { | |
1536 | error_setg(errp, "Cannot reuse an existing BDS when referencing " | |
1537 | "another block device"); | |
1538 | return -EINVAL; | |
1539 | } | |
1540 | ||
1541 | if (filename || options_non_empty) { | |
1542 | error_setg(errp, "Cannot reference an existing block device with " | |
1543 | "additional options or a new filename"); | |
1544 | return -EINVAL; | |
1545 | } | |
1546 | ||
1547 | bs = bdrv_lookup_bs(reference, reference, errp); | |
1548 | if (!bs) { | |
1549 | return -ENODEV; | |
1550 | } | |
1551 | bdrv_ref(bs); | |
1552 | *pbs = bs; | |
1553 | return 0; | |
1554 | } | |
1555 | ||
f67503e5 HR |
1556 | if (*pbs) { |
1557 | bs = *pbs; | |
1558 | } else { | |
e4e9986b | 1559 | bs = bdrv_new(); |
f67503e5 HR |
1560 | } |
1561 | ||
de9c0cec KW |
1562 | /* NULL means an empty set of options */ |
1563 | if (options == NULL) { | |
1564 | options = qdict_new(); | |
1565 | } | |
1566 | ||
145f598e | 1567 | /* json: syntax counts as explicit options, as if in the QDict */ |
de3b53f0 KW |
1568 | parse_json_protocol(options, &filename, &local_err); |
1569 | if (local_err) { | |
1570 | ret = -EINVAL; | |
1571 | goto fail; | |
1572 | } | |
1573 | ||
145f598e KW |
1574 | bs->explicit_options = qdict_clone_shallow(options); |
1575 | ||
f3930ed0 | 1576 | if (child_role) { |
bddcec37 | 1577 | bs->inherits_from = parent; |
8e2160e2 KW |
1578 | child_role->inherit_options(&flags, options, |
1579 | parent->open_flags, parent->options); | |
f3930ed0 KW |
1580 | } |
1581 | ||
de3b53f0 | 1582 | ret = bdrv_fill_options(&options, filename, &flags, &local_err); |
462f5bcf KW |
1583 | if (local_err) { |
1584 | goto fail; | |
1585 | } | |
1586 | ||
62392ebb KW |
1587 | bs->open_flags = flags; |
1588 | bs->options = options; | |
1589 | options = qdict_clone_shallow(options); | |
1590 | ||
76c591b0 | 1591 | /* Find the right image format driver */ |
76c591b0 KW |
1592 | drvname = qdict_get_try_str(options, "driver"); |
1593 | if (drvname) { | |
1594 | drv = bdrv_find_format(drvname); | |
76c591b0 KW |
1595 | if (!drv) { |
1596 | error_setg(errp, "Unknown driver: '%s'", drvname); | |
1597 | ret = -EINVAL; | |
1598 | goto fail; | |
1599 | } | |
1600 | } | |
1601 | ||
1602 | assert(drvname || !(flags & BDRV_O_PROTOCOL)); | |
76c591b0 | 1603 | |
3e8c2e57 AG |
1604 | backing = qdict_get_try_str(options, "backing"); |
1605 | if (backing && *backing == '\0') { | |
1606 | flags |= BDRV_O_NO_BACKING; | |
1607 | qdict_del(options, "backing"); | |
1608 | } | |
1609 | ||
f500a6d3 | 1610 | /* Open image file without format layer */ |
f4788adc KW |
1611 | if ((flags & BDRV_O_PROTOCOL) == 0) { |
1612 | if (flags & BDRV_O_RDWR) { | |
1613 | flags |= BDRV_O_ALLOW_RDWR; | |
1614 | } | |
1615 | if (flags & BDRV_O_SNAPSHOT) { | |
1616 | snapshot_flags = bdrv_temp_snapshot_flags(flags); | |
8e2160e2 | 1617 | bdrv_backing_options(&flags, options, flags, options); |
f4788adc | 1618 | } |
f500a6d3 | 1619 | |
f3930ed0 | 1620 | bs->open_flags = flags; |
1fdd6933 | 1621 | |
9a4f4c31 KW |
1622 | file = bdrv_open_child(filename, options, "file", bs, |
1623 | &child_file, true, &local_err); | |
1fdd6933 KW |
1624 | if (local_err) { |
1625 | ret = -EINVAL; | |
f4788adc KW |
1626 | goto fail; |
1627 | } | |
f500a6d3 KW |
1628 | } |
1629 | ||
76c591b0 | 1630 | /* Image format probing */ |
38f3ef57 | 1631 | bs->probed = !drv; |
76c591b0 | 1632 | if (!drv && file) { |
9a4f4c31 | 1633 | ret = find_image_format(file->bs, filename, &drv, &local_err); |
17b005f1 | 1634 | if (ret < 0) { |
8bfea15d | 1635 | goto fail; |
2a05cbe4 | 1636 | } |
62392ebb KW |
1637 | /* |
1638 | * This option update would logically belong in bdrv_fill_options(), | |
1639 | * but we first need to open bs->file for the probing to work, while | |
1640 | * opening bs->file already requires the (mostly) final set of options | |
1641 | * so that cache mode etc. can be inherited. | |
1642 | * | |
1643 | * Adding the driver later is somewhat ugly, but it's not an option | |
1644 | * that would ever be inherited, so it's correct. We just need to make | |
1645 | * sure to update both bs->options (which has the full effective | |
1646 | * options for bs) and options (which has file.* already removed). | |
1647 | */ | |
1648 | qdict_put(bs->options, "driver", qstring_from_str(drv->format_name)); | |
1649 | qdict_put(options, "driver", qstring_from_str(drv->format_name)); | |
76c591b0 | 1650 | } else if (!drv) { |
17b005f1 KW |
1651 | error_setg(errp, "Must specify either driver or file"); |
1652 | ret = -EINVAL; | |
8bfea15d | 1653 | goto fail; |
ea2384d3 | 1654 | } |
b6ce07aa | 1655 | |
53a29513 HR |
1656 | /* BDRV_O_PROTOCOL must be set iff a protocol BDS is about to be created */ |
1657 | assert(!!(flags & BDRV_O_PROTOCOL) == !!drv->bdrv_file_open); | |
1658 | /* file must be NULL if a protocol BDS is about to be created | |
1659 | * (the inverse results in an error message from bdrv_open_common()) */ | |
1660 | assert(!(flags & BDRV_O_PROTOCOL) || !file); | |
1661 | ||
b6ce07aa | 1662 | /* Open the image */ |
62392ebb | 1663 | ret = bdrv_open_common(bs, file, options, flags, &local_err); |
b6ce07aa | 1664 | if (ret < 0) { |
8bfea15d | 1665 | goto fail; |
6987307c CH |
1666 | } |
1667 | ||
2a05cbe4 | 1668 | if (file && (bs->file != file)) { |
9a4f4c31 | 1669 | bdrv_unref_child(bs, file); |
f500a6d3 KW |
1670 | file = NULL; |
1671 | } | |
1672 | ||
b6ce07aa | 1673 | /* If there is a backing file, use it */ |
9156df12 | 1674 | if ((flags & BDRV_O_NO_BACKING) == 0) { |
d9b7b057 | 1675 | ret = bdrv_open_backing_file(bs, options, "backing", &local_err); |
b6ce07aa | 1676 | if (ret < 0) { |
b6ad491a | 1677 | goto close_and_fail; |
b6ce07aa | 1678 | } |
b6ce07aa KW |
1679 | } |
1680 | ||
91af7014 HR |
1681 | bdrv_refresh_filename(bs); |
1682 | ||
b6ad491a | 1683 | /* Check if any unknown options were used */ |
5acd9d81 | 1684 | if (options && (qdict_size(options) != 0)) { |
b6ad491a | 1685 | const QDictEntry *entry = qdict_first(options); |
5acd9d81 HR |
1686 | if (flags & BDRV_O_PROTOCOL) { |
1687 | error_setg(errp, "Block protocol '%s' doesn't support the option " | |
1688 | "'%s'", drv->format_name, entry->key); | |
1689 | } else { | |
1690 | error_setg(errp, "Block format '%s' used by device '%s' doesn't " | |
1691 | "support the option '%s'", drv->format_name, | |
bfb197e0 | 1692 | bdrv_get_device_name(bs), entry->key); |
5acd9d81 | 1693 | } |
b6ad491a KW |
1694 | |
1695 | ret = -EINVAL; | |
1696 | goto close_and_fail; | |
1697 | } | |
b6ad491a | 1698 | |
b6ce07aa | 1699 | if (!bdrv_key_required(bs)) { |
a7f53e26 MA |
1700 | if (bs->blk) { |
1701 | blk_dev_change_media_cb(bs->blk, true); | |
1702 | } | |
c3adb58f MA |
1703 | } else if (!runstate_check(RUN_STATE_PRELAUNCH) |
1704 | && !runstate_check(RUN_STATE_INMIGRATE) | |
1705 | && !runstate_check(RUN_STATE_PAUSED)) { /* HACK */ | |
1706 | error_setg(errp, | |
1707 | "Guest must be stopped for opening of encrypted image"); | |
1708 | ret = -EBUSY; | |
1709 | goto close_and_fail; | |
b6ce07aa KW |
1710 | } |
1711 | ||
c3adb58f | 1712 | QDECREF(options); |
f67503e5 | 1713 | *pbs = bs; |
dd62f1ca KW |
1714 | |
1715 | /* For snapshot=on, create a temporary qcow2 overlay. bs points to the | |
1716 | * temporary snapshot afterwards. */ | |
1717 | if (snapshot_flags) { | |
1718 | ret = bdrv_append_temp_snapshot(bs, snapshot_flags, &local_err); | |
1719 | if (local_err) { | |
1720 | goto close_and_fail; | |
1721 | } | |
1722 | } | |
1723 | ||
b6ce07aa KW |
1724 | return 0; |
1725 | ||
8bfea15d | 1726 | fail: |
f500a6d3 | 1727 | if (file != NULL) { |
9a4f4c31 | 1728 | bdrv_unref_child(bs, file); |
f500a6d3 | 1729 | } |
145f598e | 1730 | QDECREF(bs->explicit_options); |
de9c0cec | 1731 | QDECREF(bs->options); |
b6ad491a | 1732 | QDECREF(options); |
de9c0cec | 1733 | bs->options = NULL; |
f67503e5 HR |
1734 | if (!*pbs) { |
1735 | /* If *pbs is NULL, a new BDS has been created in this function and | |
1736 | needs to be freed now. Otherwise, it does not need to be closed, | |
1737 | since it has not really been opened yet. */ | |
1738 | bdrv_unref(bs); | |
1739 | } | |
84d18f06 | 1740 | if (local_err) { |
34b5d2c6 HR |
1741 | error_propagate(errp, local_err); |
1742 | } | |
b6ad491a | 1743 | return ret; |
de9c0cec | 1744 | |
b6ad491a | 1745 | close_and_fail: |
f67503e5 HR |
1746 | /* See fail path, but now the BDS has to be always closed */ |
1747 | if (*pbs) { | |
1748 | bdrv_close(bs); | |
1749 | } else { | |
1750 | bdrv_unref(bs); | |
1751 | } | |
b6ad491a | 1752 | QDECREF(options); |
84d18f06 | 1753 | if (local_err) { |
34b5d2c6 HR |
1754 | error_propagate(errp, local_err); |
1755 | } | |
b6ce07aa KW |
1756 | return ret; |
1757 | } | |
1758 | ||
f3930ed0 | 1759 | int bdrv_open(BlockDriverState **pbs, const char *filename, |
6ebf9aa2 | 1760 | const char *reference, QDict *options, int flags, Error **errp) |
f3930ed0 KW |
1761 | { |
1762 | return bdrv_open_inherit(pbs, filename, reference, options, flags, NULL, | |
ce343771 | 1763 | NULL, errp); |
f3930ed0 KW |
1764 | } |
1765 | ||
e971aa12 JC |
1766 | typedef struct BlockReopenQueueEntry { |
1767 | bool prepared; | |
1768 | BDRVReopenState state; | |
1769 | QSIMPLEQ_ENTRY(BlockReopenQueueEntry) entry; | |
1770 | } BlockReopenQueueEntry; | |
1771 | ||
1772 | /* | |
1773 | * Adds a BlockDriverState to a simple queue for an atomic, transactional | |
1774 | * reopen of multiple devices. | |
1775 | * | |
1776 | * bs_queue can either be an existing BlockReopenQueue that has had QSIMPLE_INIT | |
1777 | * already performed, or alternatively may be NULL a new BlockReopenQueue will | |
1778 | * be created and initialized. This newly created BlockReopenQueue should be | |
1779 | * passed back in for subsequent calls that are intended to be of the same | |
1780 | * atomic 'set'. | |
1781 | * | |
1782 | * bs is the BlockDriverState to add to the reopen queue. | |
1783 | * | |
4d2cb092 KW |
1784 | * options contains the changed options for the associated bs |
1785 | * (the BlockReopenQueue takes ownership) | |
1786 | * | |
e971aa12 JC |
1787 | * flags contains the open flags for the associated bs |
1788 | * | |
1789 | * returns a pointer to bs_queue, which is either the newly allocated | |
1790 | * bs_queue, or the existing bs_queue being used. | |
1791 | * | |
1792 | */ | |
28518102 KW |
1793 | static BlockReopenQueue *bdrv_reopen_queue_child(BlockReopenQueue *bs_queue, |
1794 | BlockDriverState *bs, | |
1795 | QDict *options, | |
1796 | int flags, | |
1797 | const BdrvChildRole *role, | |
1798 | QDict *parent_options, | |
1799 | int parent_flags) | |
e971aa12 JC |
1800 | { |
1801 | assert(bs != NULL); | |
1802 | ||
1803 | BlockReopenQueueEntry *bs_entry; | |
67251a31 | 1804 | BdrvChild *child; |
145f598e | 1805 | QDict *old_options, *explicit_options; |
67251a31 | 1806 | |
e971aa12 JC |
1807 | if (bs_queue == NULL) { |
1808 | bs_queue = g_new0(BlockReopenQueue, 1); | |
1809 | QSIMPLEQ_INIT(bs_queue); | |
1810 | } | |
1811 | ||
4d2cb092 KW |
1812 | if (!options) { |
1813 | options = qdict_new(); | |
1814 | } | |
1815 | ||
28518102 KW |
1816 | /* |
1817 | * Precedence of options: | |
1818 | * 1. Explicitly passed in options (highest) | |
91a097e7 | 1819 | * 2. Set in flags (only for top level) |
145f598e | 1820 | * 3. Retained from explicitly set options of bs |
8e2160e2 | 1821 | * 4. Inherited from parent node |
28518102 KW |
1822 | * 5. Retained from effective options of bs |
1823 | */ | |
1824 | ||
91a097e7 KW |
1825 | if (!parent_options) { |
1826 | /* | |
1827 | * Any setting represented by flags is always updated. If the | |
1828 | * corresponding QDict option is set, it takes precedence. Otherwise | |
1829 | * the flag is translated into a QDict option. The old setting of bs is | |
1830 | * not considered. | |
1831 | */ | |
1832 | update_options_from_flags(options, flags); | |
1833 | } | |
1834 | ||
145f598e KW |
1835 | /* Old explicitly set values (don't overwrite by inherited value) */ |
1836 | old_options = qdict_clone_shallow(bs->explicit_options); | |
1837 | bdrv_join_options(bs, options, old_options); | |
1838 | QDECREF(old_options); | |
1839 | ||
1840 | explicit_options = qdict_clone_shallow(options); | |
1841 | ||
28518102 KW |
1842 | /* Inherit from parent node */ |
1843 | if (parent_options) { | |
1844 | assert(!flags); | |
8e2160e2 | 1845 | role->inherit_options(&flags, options, parent_flags, parent_options); |
28518102 KW |
1846 | } |
1847 | ||
1848 | /* Old values are used for options that aren't set yet */ | |
4d2cb092 | 1849 | old_options = qdict_clone_shallow(bs->options); |
cddff5ba | 1850 | bdrv_join_options(bs, options, old_options); |
4d2cb092 KW |
1851 | QDECREF(old_options); |
1852 | ||
f1f25a2e KW |
1853 | /* bdrv_open() masks this flag out */ |
1854 | flags &= ~BDRV_O_PROTOCOL; | |
1855 | ||
67251a31 | 1856 | QLIST_FOREACH(child, &bs->children, next) { |
4c9dfe5d KW |
1857 | QDict *new_child_options; |
1858 | char *child_key_dot; | |
67251a31 | 1859 | |
4c9dfe5d KW |
1860 | /* reopen can only change the options of block devices that were |
1861 | * implicitly created and inherited options. For other (referenced) | |
1862 | * block devices, a syntax like "backing.foo" results in an error. */ | |
67251a31 KW |
1863 | if (child->bs->inherits_from != bs) { |
1864 | continue; | |
1865 | } | |
1866 | ||
4c9dfe5d KW |
1867 | child_key_dot = g_strdup_printf("%s.", child->name); |
1868 | qdict_extract_subqdict(options, &new_child_options, child_key_dot); | |
1869 | g_free(child_key_dot); | |
1870 | ||
28518102 KW |
1871 | bdrv_reopen_queue_child(bs_queue, child->bs, new_child_options, 0, |
1872 | child->role, options, flags); | |
e971aa12 JC |
1873 | } |
1874 | ||
1875 | bs_entry = g_new0(BlockReopenQueueEntry, 1); | |
1876 | QSIMPLEQ_INSERT_TAIL(bs_queue, bs_entry, entry); | |
1877 | ||
1878 | bs_entry->state.bs = bs; | |
4d2cb092 | 1879 | bs_entry->state.options = options; |
145f598e | 1880 | bs_entry->state.explicit_options = explicit_options; |
e971aa12 JC |
1881 | bs_entry->state.flags = flags; |
1882 | ||
1883 | return bs_queue; | |
1884 | } | |
1885 | ||
28518102 KW |
1886 | BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue, |
1887 | BlockDriverState *bs, | |
1888 | QDict *options, int flags) | |
1889 | { | |
1890 | return bdrv_reopen_queue_child(bs_queue, bs, options, flags, | |
1891 | NULL, NULL, 0); | |
1892 | } | |
1893 | ||
e971aa12 JC |
1894 | /* |
1895 | * Reopen multiple BlockDriverStates atomically & transactionally. | |
1896 | * | |
1897 | * The queue passed in (bs_queue) must have been built up previous | |
1898 | * via bdrv_reopen_queue(). | |
1899 | * | |
1900 | * Reopens all BDS specified in the queue, with the appropriate | |
1901 | * flags. All devices are prepared for reopen, and failure of any | |
1902 | * device will cause all device changes to be abandonded, and intermediate | |
1903 | * data cleaned up. | |
1904 | * | |
1905 | * If all devices prepare successfully, then the changes are committed | |
1906 | * to all devices. | |
1907 | * | |
1908 | */ | |
1909 | int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp) | |
1910 | { | |
1911 | int ret = -1; | |
1912 | BlockReopenQueueEntry *bs_entry, *next; | |
1913 | Error *local_err = NULL; | |
1914 | ||
1915 | assert(bs_queue != NULL); | |
1916 | ||
1917 | bdrv_drain_all(); | |
1918 | ||
1919 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { | |
1920 | if (bdrv_reopen_prepare(&bs_entry->state, bs_queue, &local_err)) { | |
1921 | error_propagate(errp, local_err); | |
1922 | goto cleanup; | |
1923 | } | |
1924 | bs_entry->prepared = true; | |
1925 | } | |
1926 | ||
1927 | /* If we reach this point, we have success and just need to apply the | |
1928 | * changes | |
1929 | */ | |
1930 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { | |
1931 | bdrv_reopen_commit(&bs_entry->state); | |
1932 | } | |
1933 | ||
1934 | ret = 0; | |
1935 | ||
1936 | cleanup: | |
1937 | QSIMPLEQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) { | |
1938 | if (ret && bs_entry->prepared) { | |
1939 | bdrv_reopen_abort(&bs_entry->state); | |
145f598e KW |
1940 | } else if (ret) { |
1941 | QDECREF(bs_entry->state.explicit_options); | |
e971aa12 | 1942 | } |
4d2cb092 | 1943 | QDECREF(bs_entry->state.options); |
e971aa12 JC |
1944 | g_free(bs_entry); |
1945 | } | |
1946 | g_free(bs_queue); | |
1947 | return ret; | |
1948 | } | |
1949 | ||
1950 | ||
1951 | /* Reopen a single BlockDriverState with the specified flags. */ | |
1952 | int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp) | |
1953 | { | |
1954 | int ret = -1; | |
1955 | Error *local_err = NULL; | |
4d2cb092 | 1956 | BlockReopenQueue *queue = bdrv_reopen_queue(NULL, bs, NULL, bdrv_flags); |
e971aa12 JC |
1957 | |
1958 | ret = bdrv_reopen_multiple(queue, &local_err); | |
1959 | if (local_err != NULL) { | |
1960 | error_propagate(errp, local_err); | |
1961 | } | |
1962 | return ret; | |
1963 | } | |
1964 | ||
1965 | ||
1966 | /* | |
1967 | * Prepares a BlockDriverState for reopen. All changes are staged in the | |
1968 | * 'opaque' field of the BDRVReopenState, which is used and allocated by | |
1969 | * the block driver layer .bdrv_reopen_prepare() | |
1970 | * | |
1971 | * bs is the BlockDriverState to reopen | |
1972 | * flags are the new open flags | |
1973 | * queue is the reopen queue | |
1974 | * | |
1975 | * Returns 0 on success, non-zero on error. On error errp will be set | |
1976 | * as well. | |
1977 | * | |
1978 | * On failure, bdrv_reopen_abort() will be called to clean up any data. | |
1979 | * It is the responsibility of the caller to then call the abort() or | |
1980 | * commit() for any other BDS that have been left in a prepare() state | |
1981 | * | |
1982 | */ | |
1983 | int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue, | |
1984 | Error **errp) | |
1985 | { | |
1986 | int ret = -1; | |
1987 | Error *local_err = NULL; | |
1988 | BlockDriver *drv; | |
ccf9dc07 KW |
1989 | QemuOpts *opts; |
1990 | const char *value; | |
e971aa12 JC |
1991 | |
1992 | assert(reopen_state != NULL); | |
1993 | assert(reopen_state->bs->drv != NULL); | |
1994 | drv = reopen_state->bs->drv; | |
1995 | ||
ccf9dc07 KW |
1996 | /* Process generic block layer options */ |
1997 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); | |
1998 | qemu_opts_absorb_qdict(opts, reopen_state->options, &local_err); | |
1999 | if (local_err) { | |
2000 | error_propagate(errp, local_err); | |
2001 | ret = -EINVAL; | |
2002 | goto error; | |
2003 | } | |
2004 | ||
91a097e7 KW |
2005 | update_flags_from_options(&reopen_state->flags, opts); |
2006 | ||
2007 | /* If a guest device is attached, it owns WCE */ | |
2008 | if (reopen_state->bs->blk && blk_get_attached_dev(reopen_state->bs->blk)) { | |
2009 | bool old_wce = bdrv_enable_write_cache(reopen_state->bs); | |
2010 | bool new_wce = (reopen_state->flags & BDRV_O_CACHE_WB); | |
2011 | if (old_wce != new_wce) { | |
2012 | error_setg(errp, "Cannot change cache.writeback: Device attached"); | |
2013 | ret = -EINVAL; | |
2014 | goto error; | |
2015 | } | |
2016 | } | |
2017 | ||
ccf9dc07 KW |
2018 | /* node-name and driver must be unchanged. Put them back into the QDict, so |
2019 | * that they are checked at the end of this function. */ | |
2020 | value = qemu_opt_get(opts, "node-name"); | |
2021 | if (value) { | |
2022 | qdict_put(reopen_state->options, "node-name", qstring_from_str(value)); | |
2023 | } | |
2024 | ||
2025 | value = qemu_opt_get(opts, "driver"); | |
2026 | if (value) { | |
2027 | qdict_put(reopen_state->options, "driver", qstring_from_str(value)); | |
2028 | } | |
2029 | ||
e971aa12 JC |
2030 | /* if we are to stay read-only, do not allow permission change |
2031 | * to r/w */ | |
2032 | if (!(reopen_state->bs->open_flags & BDRV_O_ALLOW_RDWR) && | |
2033 | reopen_state->flags & BDRV_O_RDWR) { | |
81e5f78a AG |
2034 | error_setg(errp, "Node '%s' is read only", |
2035 | bdrv_get_device_or_node_name(reopen_state->bs)); | |
e971aa12 JC |
2036 | goto error; |
2037 | } | |
2038 | ||
2039 | ||
2040 | ret = bdrv_flush(reopen_state->bs); | |
2041 | if (ret) { | |
455b0fde | 2042 | error_setg_errno(errp, -ret, "Error flushing drive"); |
e971aa12 JC |
2043 | goto error; |
2044 | } | |
2045 | ||
2046 | if (drv->bdrv_reopen_prepare) { | |
2047 | ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err); | |
2048 | if (ret) { | |
2049 | if (local_err != NULL) { | |
2050 | error_propagate(errp, local_err); | |
2051 | } else { | |
d8b6895f LC |
2052 | error_setg(errp, "failed while preparing to reopen image '%s'", |
2053 | reopen_state->bs->filename); | |
e971aa12 JC |
2054 | } |
2055 | goto error; | |
2056 | } | |
2057 | } else { | |
2058 | /* It is currently mandatory to have a bdrv_reopen_prepare() | |
2059 | * handler for each supported drv. */ | |
81e5f78a AG |
2060 | error_setg(errp, "Block format '%s' used by node '%s' " |
2061 | "does not support reopening files", drv->format_name, | |
2062 | bdrv_get_device_or_node_name(reopen_state->bs)); | |
e971aa12 JC |
2063 | ret = -1; |
2064 | goto error; | |
2065 | } | |
2066 | ||
4d2cb092 KW |
2067 | /* Options that are not handled are only okay if they are unchanged |
2068 | * compared to the old state. It is expected that some options are only | |
2069 | * used for the initial open, but not reopen (e.g. filename) */ | |
2070 | if (qdict_size(reopen_state->options)) { | |
2071 | const QDictEntry *entry = qdict_first(reopen_state->options); | |
2072 | ||
2073 | do { | |
2074 | QString *new_obj = qobject_to_qstring(entry->value); | |
2075 | const char *new = qstring_get_str(new_obj); | |
2076 | const char *old = qdict_get_try_str(reopen_state->bs->options, | |
2077 | entry->key); | |
2078 | ||
2079 | if (!old || strcmp(new, old)) { | |
2080 | error_setg(errp, "Cannot change the option '%s'", entry->key); | |
2081 | ret = -EINVAL; | |
2082 | goto error; | |
2083 | } | |
2084 | } while ((entry = qdict_next(reopen_state->options, entry))); | |
2085 | } | |
2086 | ||
e971aa12 JC |
2087 | ret = 0; |
2088 | ||
2089 | error: | |
ccf9dc07 | 2090 | qemu_opts_del(opts); |
e971aa12 JC |
2091 | return ret; |
2092 | } | |
2093 | ||
2094 | /* | |
2095 | * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and | |
2096 | * makes them final by swapping the staging BlockDriverState contents into | |
2097 | * the active BlockDriverState contents. | |
2098 | */ | |
2099 | void bdrv_reopen_commit(BDRVReopenState *reopen_state) | |
2100 | { | |
2101 | BlockDriver *drv; | |
2102 | ||
2103 | assert(reopen_state != NULL); | |
2104 | drv = reopen_state->bs->drv; | |
2105 | assert(drv != NULL); | |
2106 | ||
2107 | /* If there are any driver level actions to take */ | |
2108 | if (drv->bdrv_reopen_commit) { | |
2109 | drv->bdrv_reopen_commit(reopen_state); | |
2110 | } | |
2111 | ||
2112 | /* set BDS specific flags now */ | |
145f598e KW |
2113 | QDECREF(reopen_state->bs->explicit_options); |
2114 | ||
2115 | reopen_state->bs->explicit_options = reopen_state->explicit_options; | |
e971aa12 JC |
2116 | reopen_state->bs->open_flags = reopen_state->flags; |
2117 | reopen_state->bs->enable_write_cache = !!(reopen_state->flags & | |
2118 | BDRV_O_CACHE_WB); | |
2119 | reopen_state->bs->read_only = !(reopen_state->flags & BDRV_O_RDWR); | |
355ef4ac | 2120 | |
3baca891 | 2121 | bdrv_refresh_limits(reopen_state->bs, NULL); |
e971aa12 JC |
2122 | } |
2123 | ||
2124 | /* | |
2125 | * Abort the reopen, and delete and free the staged changes in | |
2126 | * reopen_state | |
2127 | */ | |
2128 | void bdrv_reopen_abort(BDRVReopenState *reopen_state) | |
2129 | { | |
2130 | BlockDriver *drv; | |
2131 | ||
2132 | assert(reopen_state != NULL); | |
2133 | drv = reopen_state->bs->drv; | |
2134 | assert(drv != NULL); | |
2135 | ||
2136 | if (drv->bdrv_reopen_abort) { | |
2137 | drv->bdrv_reopen_abort(reopen_state); | |
2138 | } | |
145f598e KW |
2139 | |
2140 | QDECREF(reopen_state->explicit_options); | |
e971aa12 JC |
2141 | } |
2142 | ||
2143 | ||
fc01f7e7 FB |
2144 | void bdrv_close(BlockDriverState *bs) |
2145 | { | |
33384421 HR |
2146 | BdrvAioNotifier *ban, *ban_next; |
2147 | ||
3cbc002c PB |
2148 | if (bs->job) { |
2149 | block_job_cancel_sync(bs->job); | |
2150 | } | |
99b7e775 AG |
2151 | |
2152 | /* Disable I/O limits and drain all pending throttled requests */ | |
a0d64a61 | 2153 | if (bs->throttle_state) { |
99b7e775 AG |
2154 | bdrv_io_limits_disable(bs); |
2155 | } | |
2156 | ||
fc27291d | 2157 | bdrv_drained_begin(bs); /* complete I/O */ |
58fda173 | 2158 | bdrv_flush(bs); |
53ec73e2 | 2159 | bdrv_drain(bs); /* in case flush left pending I/O */ |
fc27291d | 2160 | |
d7d512f6 | 2161 | notifier_list_notify(&bs->close_notifiers, bs); |
7094f12f | 2162 | |
b4d02820 HR |
2163 | if (bs->blk) { |
2164 | blk_dev_change_media_cb(bs->blk, false); | |
2165 | } | |
2166 | ||
3cbc002c | 2167 | if (bs->drv) { |
6e93e7c4 KW |
2168 | BdrvChild *child, *next; |
2169 | ||
9a7dedbc | 2170 | bs->drv->bdrv_close(bs); |
9a4f4c31 | 2171 | bs->drv = NULL; |
9a7dedbc | 2172 | |
5db15a57 | 2173 | bdrv_set_backing_hd(bs, NULL); |
9a7dedbc | 2174 | |
9a4f4c31 KW |
2175 | if (bs->file != NULL) { |
2176 | bdrv_unref_child(bs, bs->file); | |
2177 | bs->file = NULL; | |
2178 | } | |
2179 | ||
6e93e7c4 | 2180 | QLIST_FOREACH_SAFE(child, &bs->children, next, next) { |
33a60407 KW |
2181 | /* TODO Remove bdrv_unref() from drivers' close function and use |
2182 | * bdrv_unref_child() here */ | |
bddcec37 KW |
2183 | if (child->bs->inherits_from == bs) { |
2184 | child->bs->inherits_from = NULL; | |
2185 | } | |
33a60407 | 2186 | bdrv_detach_child(child); |
6e93e7c4 KW |
2187 | } |
2188 | ||
7267c094 | 2189 | g_free(bs->opaque); |
ea2384d3 | 2190 | bs->opaque = NULL; |
53fec9d3 | 2191 | bs->copy_on_read = 0; |
a275fa42 PB |
2192 | bs->backing_file[0] = '\0'; |
2193 | bs->backing_format[0] = '\0'; | |
6405875c PB |
2194 | bs->total_sectors = 0; |
2195 | bs->encrypted = 0; | |
2196 | bs->valid_key = 0; | |
2197 | bs->sg = 0; | |
0d51b4de | 2198 | bs->zero_beyond_eof = false; |
de9c0cec | 2199 | QDECREF(bs->options); |
145f598e | 2200 | QDECREF(bs->explicit_options); |
de9c0cec | 2201 | bs->options = NULL; |
91af7014 HR |
2202 | QDECREF(bs->full_open_options); |
2203 | bs->full_open_options = NULL; | |
b338082b | 2204 | } |
98f90dba | 2205 | |
33384421 HR |
2206 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { |
2207 | g_free(ban); | |
2208 | } | |
2209 | QLIST_INIT(&bs->aio_notifiers); | |
fc27291d | 2210 | bdrv_drained_end(bs); |
b338082b FB |
2211 | } |
2212 | ||
2bc93fed MK |
2213 | void bdrv_close_all(void) |
2214 | { | |
2215 | BlockDriverState *bs; | |
2216 | ||
dc364f4c | 2217 | QTAILQ_FOREACH(bs, &bdrv_states, device_list) { |
ed78cda3 SH |
2218 | AioContext *aio_context = bdrv_get_aio_context(bs); |
2219 | ||
2220 | aio_context_acquire(aio_context); | |
2bc93fed | 2221 | bdrv_close(bs); |
ed78cda3 | 2222 | aio_context_release(aio_context); |
2bc93fed MK |
2223 | } |
2224 | } | |
2225 | ||
dc364f4c BC |
2226 | /* make a BlockDriverState anonymous by removing from bdrv_state and |
2227 | * graph_bdrv_state list. | |
d22b2f41 RH |
2228 | Also, NULL terminate the device_name to prevent double remove */ |
2229 | void bdrv_make_anon(BlockDriverState *bs) | |
2230 | { | |
bfb197e0 MA |
2231 | /* |
2232 | * Take care to remove bs from bdrv_states only when it's actually | |
2233 | * in it. Note that bs->device_list.tqe_prev is initially null, | |
2234 | * and gets set to non-null by QTAILQ_INSERT_TAIL(). Establish | |
2235 | * the useful invariant "bs in bdrv_states iff bs->tqe_prev" by | |
2236 | * resetting it to null on remove. | |
2237 | */ | |
2238 | if (bs->device_list.tqe_prev) { | |
dc364f4c | 2239 | QTAILQ_REMOVE(&bdrv_states, bs, device_list); |
bfb197e0 | 2240 | bs->device_list.tqe_prev = NULL; |
d22b2f41 | 2241 | } |
dc364f4c BC |
2242 | if (bs->node_name[0] != '\0') { |
2243 | QTAILQ_REMOVE(&graph_bdrv_states, bs, node_list); | |
2244 | } | |
2245 | bs->node_name[0] = '\0'; | |
d22b2f41 RH |
2246 | } |
2247 | ||
8e419aef | 2248 | /* Fields that need to stay with the top-level BDS */ |
4ddc07ca PB |
2249 | static void bdrv_move_feature_fields(BlockDriverState *bs_dest, |
2250 | BlockDriverState *bs_src) | |
8802d1fd | 2251 | { |
4ddc07ca | 2252 | /* move some fields that need to stay attached to the device */ |
8802d1fd JC |
2253 | |
2254 | /* dev info */ | |
4ddc07ca | 2255 | bs_dest->copy_on_read = bs_src->copy_on_read; |
8802d1fd | 2256 | |
4ddc07ca | 2257 | bs_dest->enable_write_cache = bs_src->enable_write_cache; |
c4a248a1 | 2258 | |
a9fc4408 | 2259 | /* dirty bitmap */ |
e4654d2d | 2260 | bs_dest->dirty_bitmaps = bs_src->dirty_bitmaps; |
063dd40e | 2261 | } |
a9fc4408 | 2262 | |
dd62f1ca KW |
2263 | static void change_parent_backing_link(BlockDriverState *from, |
2264 | BlockDriverState *to) | |
2265 | { | |
2266 | BdrvChild *c, *next; | |
2267 | ||
2268 | QLIST_FOREACH_SAFE(c, &from->parents, next_parent, next) { | |
2269 | assert(c->role != &child_backing); | |
2270 | c->bs = to; | |
2271 | QLIST_REMOVE(c, next_parent); | |
2272 | QLIST_INSERT_HEAD(&to->parents, c, next_parent); | |
2273 | bdrv_ref(to); | |
2274 | bdrv_unref(from); | |
2275 | } | |
2276 | if (from->blk) { | |
2277 | blk_set_bs(from->blk, to); | |
2278 | if (!to->device_list.tqe_prev) { | |
2279 | QTAILQ_INSERT_BEFORE(from, to, device_list); | |
2280 | } | |
2281 | QTAILQ_REMOVE(&bdrv_states, from, device_list); | |
2282 | } | |
2283 | } | |
2284 | ||
2285 | static void swap_feature_fields(BlockDriverState *bs_top, | |
2286 | BlockDriverState *bs_new) | |
2287 | { | |
2288 | BlockDriverState tmp; | |
2289 | ||
2290 | bdrv_move_feature_fields(&tmp, bs_top); | |
2291 | bdrv_move_feature_fields(bs_top, bs_new); | |
2292 | bdrv_move_feature_fields(bs_new, &tmp); | |
2293 | ||
2294 | assert(!bs_new->throttle_state); | |
2295 | if (bs_top->throttle_state) { | |
2296 | assert(bs_top->io_limits_enabled); | |
2297 | bdrv_io_limits_enable(bs_new, throttle_group_get_name(bs_top)); | |
2298 | bdrv_io_limits_disable(bs_top); | |
2299 | } | |
2300 | } | |
2301 | ||
4ddc07ca PB |
2302 | /* |
2303 | * Add new bs contents at the top of an image chain while the chain is | |
2304 | * live, while keeping required fields on the top layer. | |
2305 | * | |
2306 | * This will modify the BlockDriverState fields, and swap contents | |
2307 | * between bs_new and bs_top. Both bs_new and bs_top are modified. | |
2308 | * | |
bfb197e0 | 2309 | * bs_new must not be attached to a BlockBackend. |
4ddc07ca PB |
2310 | * |
2311 | * This function does not create any image files. | |
dd62f1ca KW |
2312 | * |
2313 | * bdrv_append() takes ownership of a bs_new reference and unrefs it because | |
2314 | * that's what the callers commonly need. bs_new will be referenced by the old | |
2315 | * parents of bs_top after bdrv_append() returns. If the caller needs to keep a | |
2316 | * reference of its own, it must call bdrv_ref(). | |
4ddc07ca PB |
2317 | */ |
2318 | void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top) | |
2319 | { | |
dd62f1ca KW |
2320 | assert(!bdrv_requests_pending(bs_top)); |
2321 | assert(!bdrv_requests_pending(bs_new)); | |
2322 | ||
2323 | bdrv_ref(bs_top); | |
2324 | change_parent_backing_link(bs_top, bs_new); | |
2325 | ||
2326 | /* Some fields always stay on top of the backing file chain */ | |
2327 | swap_feature_fields(bs_top, bs_new); | |
2328 | ||
2329 | bdrv_set_backing_hd(bs_new, bs_top); | |
2330 | bdrv_unref(bs_top); | |
4ddc07ca | 2331 | |
dd62f1ca KW |
2332 | /* bs_new is now referenced by its new parents, we don't need the |
2333 | * additional reference any more. */ | |
2334 | bdrv_unref(bs_new); | |
8802d1fd JC |
2335 | } |
2336 | ||
3f09bfbc KW |
2337 | void bdrv_replace_in_backing_chain(BlockDriverState *old, BlockDriverState *new) |
2338 | { | |
2339 | assert(!bdrv_requests_pending(old)); | |
2340 | assert(!bdrv_requests_pending(new)); | |
2341 | ||
2342 | bdrv_ref(old); | |
2343 | ||
2344 | if (old->blk) { | |
2345 | /* As long as these fields aren't in BlockBackend, but in the top-level | |
2346 | * BlockDriverState, it's not possible for a BDS to have two BBs. | |
2347 | * | |
2348 | * We really want to copy the fields from old to new, but we go for a | |
2349 | * swap instead so that pointers aren't duplicated and cause trouble. | |
2350 | * (Also, bdrv_swap() used to do the same.) */ | |
2351 | assert(!new->blk); | |
2352 | swap_feature_fields(old, new); | |
2353 | } | |
2354 | change_parent_backing_link(old, new); | |
2355 | ||
2356 | /* Change backing files if a previously independent node is added to the | |
2357 | * chain. For active commit, we replace top by its own (indirect) backing | |
2358 | * file and don't do anything here so we don't build a loop. */ | |
2359 | if (new->backing == NULL && !bdrv_chain_contains(backing_bs(old), new)) { | |
2360 | bdrv_set_backing_hd(new, backing_bs(old)); | |
2361 | bdrv_set_backing_hd(old, NULL); | |
2362 | } | |
2363 | ||
2364 | bdrv_unref(old); | |
2365 | } | |
2366 | ||
4f6fd349 | 2367 | static void bdrv_delete(BlockDriverState *bs) |
b338082b | 2368 | { |
3e914655 | 2369 | assert(!bs->job); |
3718d8ab | 2370 | assert(bdrv_op_blocker_is_empty(bs)); |
4f6fd349 | 2371 | assert(!bs->refcnt); |
e4654d2d | 2372 | assert(QLIST_EMPTY(&bs->dirty_bitmaps)); |
18846dee | 2373 | |
e1b5c52e SH |
2374 | bdrv_close(bs); |
2375 | ||
1b7bdbc1 | 2376 | /* remove from list, if necessary */ |
d22b2f41 | 2377 | bdrv_make_anon(bs); |
34c6f050 | 2378 | |
7267c094 | 2379 | g_free(bs); |
fc01f7e7 FB |
2380 | } |
2381 | ||
e97fc193 AL |
2382 | /* |
2383 | * Run consistency checks on an image | |
2384 | * | |
e076f338 | 2385 | * Returns 0 if the check could be completed (it doesn't mean that the image is |
a1c7273b | 2386 | * free of errors) or -errno when an internal error occurred. The results of the |
e076f338 | 2387 | * check are stored in res. |
e97fc193 | 2388 | */ |
4534ff54 | 2389 | int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix) |
e97fc193 | 2390 | { |
908bcd54 HR |
2391 | if (bs->drv == NULL) { |
2392 | return -ENOMEDIUM; | |
2393 | } | |
e97fc193 AL |
2394 | if (bs->drv->bdrv_check == NULL) { |
2395 | return -ENOTSUP; | |
2396 | } | |
2397 | ||
e076f338 | 2398 | memset(res, 0, sizeof(*res)); |
4534ff54 | 2399 | return bs->drv->bdrv_check(bs, res, fix); |
e97fc193 AL |
2400 | } |
2401 | ||
8a426614 KW |
2402 | #define COMMIT_BUF_SECTORS 2048 |
2403 | ||
33e3963e FB |
2404 | /* commit COW file into the raw image */ |
2405 | int bdrv_commit(BlockDriverState *bs) | |
2406 | { | |
19cb3738 | 2407 | BlockDriver *drv = bs->drv; |
72706ea4 | 2408 | int64_t sector, total_sectors, length, backing_length; |
8a426614 | 2409 | int n, ro, open_flags; |
0bce597d | 2410 | int ret = 0; |
72706ea4 | 2411 | uint8_t *buf = NULL; |
33e3963e | 2412 | |
19cb3738 FB |
2413 | if (!drv) |
2414 | return -ENOMEDIUM; | |
6bb45158 | 2415 | |
760e0063 | 2416 | if (!bs->backing) { |
4dca4b63 | 2417 | return -ENOTSUP; |
33e3963e FB |
2418 | } |
2419 | ||
bb00021d | 2420 | if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, NULL) || |
760e0063 | 2421 | bdrv_op_is_blocked(bs->backing->bs, BLOCK_OP_TYPE_COMMIT_TARGET, NULL)) { |
2d3735d3 SH |
2422 | return -EBUSY; |
2423 | } | |
2424 | ||
760e0063 KW |
2425 | ro = bs->backing->bs->read_only; |
2426 | open_flags = bs->backing->bs->open_flags; | |
4dca4b63 NS |
2427 | |
2428 | if (ro) { | |
760e0063 | 2429 | if (bdrv_reopen(bs->backing->bs, open_flags | BDRV_O_RDWR, NULL)) { |
0bce597d | 2430 | return -EACCES; |
4dca4b63 | 2431 | } |
ea2384d3 | 2432 | } |
33e3963e | 2433 | |
72706ea4 JC |
2434 | length = bdrv_getlength(bs); |
2435 | if (length < 0) { | |
2436 | ret = length; | |
2437 | goto ro_cleanup; | |
2438 | } | |
2439 | ||
760e0063 | 2440 | backing_length = bdrv_getlength(bs->backing->bs); |
72706ea4 JC |
2441 | if (backing_length < 0) { |
2442 | ret = backing_length; | |
2443 | goto ro_cleanup; | |
2444 | } | |
2445 | ||
2446 | /* If our top snapshot is larger than the backing file image, | |
2447 | * grow the backing file image if possible. If not possible, | |
2448 | * we must return an error */ | |
2449 | if (length > backing_length) { | |
760e0063 | 2450 | ret = bdrv_truncate(bs->backing->bs, length); |
72706ea4 JC |
2451 | if (ret < 0) { |
2452 | goto ro_cleanup; | |
2453 | } | |
2454 | } | |
2455 | ||
2456 | total_sectors = length >> BDRV_SECTOR_BITS; | |
857d4f46 KW |
2457 | |
2458 | /* qemu_try_blockalign() for bs will choose an alignment that works for | |
760e0063 | 2459 | * bs->backing->bs as well, so no need to compare the alignment manually. */ |
857d4f46 KW |
2460 | buf = qemu_try_blockalign(bs, COMMIT_BUF_SECTORS * BDRV_SECTOR_SIZE); |
2461 | if (buf == NULL) { | |
2462 | ret = -ENOMEM; | |
2463 | goto ro_cleanup; | |
2464 | } | |
8a426614 KW |
2465 | |
2466 | for (sector = 0; sector < total_sectors; sector += n) { | |
d663640c PB |
2467 | ret = bdrv_is_allocated(bs, sector, COMMIT_BUF_SECTORS, &n); |
2468 | if (ret < 0) { | |
2469 | goto ro_cleanup; | |
2470 | } | |
2471 | if (ret) { | |
dabfa6cc KW |
2472 | ret = bdrv_read(bs, sector, buf, n); |
2473 | if (ret < 0) { | |
8a426614 KW |
2474 | goto ro_cleanup; |
2475 | } | |
2476 | ||
760e0063 | 2477 | ret = bdrv_write(bs->backing->bs, sector, buf, n); |
dabfa6cc | 2478 | if (ret < 0) { |
8a426614 KW |
2479 | goto ro_cleanup; |
2480 | } | |
ea2384d3 | 2481 | } |
33e3963e | 2482 | } |
95389c86 | 2483 | |
1d44952f CH |
2484 | if (drv->bdrv_make_empty) { |
2485 | ret = drv->bdrv_make_empty(bs); | |
dabfa6cc KW |
2486 | if (ret < 0) { |
2487 | goto ro_cleanup; | |
2488 | } | |
1d44952f CH |
2489 | bdrv_flush(bs); |
2490 | } | |
95389c86 | 2491 | |
3f5075ae CH |
2492 | /* |
2493 | * Make sure all data we wrote to the backing device is actually | |
2494 | * stable on disk. | |
2495 | */ | |
760e0063 KW |
2496 | if (bs->backing) { |
2497 | bdrv_flush(bs->backing->bs); | |
dabfa6cc | 2498 | } |
4dca4b63 | 2499 | |
dabfa6cc | 2500 | ret = 0; |
4dca4b63 | 2501 | ro_cleanup: |
857d4f46 | 2502 | qemu_vfree(buf); |
4dca4b63 NS |
2503 | |
2504 | if (ro) { | |
0bce597d | 2505 | /* ignoring error return here */ |
760e0063 | 2506 | bdrv_reopen(bs->backing->bs, open_flags & ~BDRV_O_RDWR, NULL); |
4dca4b63 NS |
2507 | } |
2508 | ||
1d44952f | 2509 | return ret; |
33e3963e FB |
2510 | } |
2511 | ||
e8877497 | 2512 | int bdrv_commit_all(void) |
6ab4b5ab MA |
2513 | { |
2514 | BlockDriverState *bs; | |
2515 | ||
dc364f4c | 2516 | QTAILQ_FOREACH(bs, &bdrv_states, device_list) { |
ed78cda3 SH |
2517 | AioContext *aio_context = bdrv_get_aio_context(bs); |
2518 | ||
2519 | aio_context_acquire(aio_context); | |
760e0063 | 2520 | if (bs->drv && bs->backing) { |
272d2d8e JC |
2521 | int ret = bdrv_commit(bs); |
2522 | if (ret < 0) { | |
ed78cda3 | 2523 | aio_context_release(aio_context); |
272d2d8e JC |
2524 | return ret; |
2525 | } | |
e8877497 | 2526 | } |
ed78cda3 | 2527 | aio_context_release(aio_context); |
6ab4b5ab | 2528 | } |
e8877497 | 2529 | return 0; |
6ab4b5ab MA |
2530 | } |
2531 | ||
756e6736 KW |
2532 | /* |
2533 | * Return values: | |
2534 | * 0 - success | |
2535 | * -EINVAL - backing format specified, but no file | |
2536 | * -ENOSPC - can't update the backing file because no space is left in the | |
2537 | * image file header | |
2538 | * -ENOTSUP - format driver doesn't support changing the backing file | |
2539 | */ | |
2540 | int bdrv_change_backing_file(BlockDriverState *bs, | |
2541 | const char *backing_file, const char *backing_fmt) | |
2542 | { | |
2543 | BlockDriver *drv = bs->drv; | |
469ef350 | 2544 | int ret; |
756e6736 | 2545 | |
5f377794 PB |
2546 | /* Backing file format doesn't make sense without a backing file */ |
2547 | if (backing_fmt && !backing_file) { | |
2548 | return -EINVAL; | |
2549 | } | |
2550 | ||
756e6736 | 2551 | if (drv->bdrv_change_backing_file != NULL) { |
469ef350 | 2552 | ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt); |
756e6736 | 2553 | } else { |
469ef350 | 2554 | ret = -ENOTSUP; |
756e6736 | 2555 | } |
469ef350 PB |
2556 | |
2557 | if (ret == 0) { | |
2558 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: ""); | |
2559 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: ""); | |
2560 | } | |
2561 | return ret; | |
756e6736 KW |
2562 | } |
2563 | ||
6ebdcee2 JC |
2564 | /* |
2565 | * Finds the image layer in the chain that has 'bs' as its backing file. | |
2566 | * | |
2567 | * active is the current topmost image. | |
2568 | * | |
2569 | * Returns NULL if bs is not found in active's image chain, | |
2570 | * or if active == bs. | |
4caf0fcd JC |
2571 | * |
2572 | * Returns the bottommost base image if bs == NULL. | |
6ebdcee2 JC |
2573 | */ |
2574 | BlockDriverState *bdrv_find_overlay(BlockDriverState *active, | |
2575 | BlockDriverState *bs) | |
2576 | { | |
760e0063 KW |
2577 | while (active && bs != backing_bs(active)) { |
2578 | active = backing_bs(active); | |
6ebdcee2 JC |
2579 | } |
2580 | ||
4caf0fcd JC |
2581 | return active; |
2582 | } | |
6ebdcee2 | 2583 | |
4caf0fcd JC |
2584 | /* Given a BDS, searches for the base layer. */ |
2585 | BlockDriverState *bdrv_find_base(BlockDriverState *bs) | |
2586 | { | |
2587 | return bdrv_find_overlay(bs, NULL); | |
6ebdcee2 JC |
2588 | } |
2589 | ||
6ebdcee2 JC |
2590 | /* |
2591 | * Drops images above 'base' up to and including 'top', and sets the image | |
2592 | * above 'top' to have base as its backing file. | |
2593 | * | |
2594 | * Requires that the overlay to 'top' is opened r/w, so that the backing file | |
2595 | * information in 'bs' can be properly updated. | |
2596 | * | |
2597 | * E.g., this will convert the following chain: | |
2598 | * bottom <- base <- intermediate <- top <- active | |
2599 | * | |
2600 | * to | |
2601 | * | |
2602 | * bottom <- base <- active | |
2603 | * | |
2604 | * It is allowed for bottom==base, in which case it converts: | |
2605 | * | |
2606 | * base <- intermediate <- top <- active | |
2607 | * | |
2608 | * to | |
2609 | * | |
2610 | * base <- active | |
2611 | * | |
54e26900 JC |
2612 | * If backing_file_str is non-NULL, it will be used when modifying top's |
2613 | * overlay image metadata. | |
2614 | * | |
6ebdcee2 JC |
2615 | * Error conditions: |
2616 | * if active == top, that is considered an error | |
2617 | * | |
2618 | */ | |
2619 | int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top, | |
54e26900 | 2620 | BlockDriverState *base, const char *backing_file_str) |
6ebdcee2 | 2621 | { |
6ebdcee2 | 2622 | BlockDriverState *new_top_bs = NULL; |
6ebdcee2 JC |
2623 | int ret = -EIO; |
2624 | ||
6ebdcee2 JC |
2625 | if (!top->drv || !base->drv) { |
2626 | goto exit; | |
2627 | } | |
2628 | ||
2629 | new_top_bs = bdrv_find_overlay(active, top); | |
2630 | ||
2631 | if (new_top_bs == NULL) { | |
2632 | /* we could not find the image above 'top', this is an error */ | |
2633 | goto exit; | |
2634 | } | |
2635 | ||
760e0063 | 2636 | /* special case of new_top_bs->backing->bs already pointing to base - nothing |
6ebdcee2 | 2637 | * to do, no intermediate images */ |
760e0063 | 2638 | if (backing_bs(new_top_bs) == base) { |
6ebdcee2 JC |
2639 | ret = 0; |
2640 | goto exit; | |
2641 | } | |
2642 | ||
5db15a57 KW |
2643 | /* Make sure that base is in the backing chain of top */ |
2644 | if (!bdrv_chain_contains(top, base)) { | |
6ebdcee2 JC |
2645 | goto exit; |
2646 | } | |
2647 | ||
2648 | /* success - we can delete the intermediate states, and link top->base */ | |
5db15a57 | 2649 | backing_file_str = backing_file_str ? backing_file_str : base->filename; |
54e26900 | 2650 | ret = bdrv_change_backing_file(new_top_bs, backing_file_str, |
5db15a57 | 2651 | base->drv ? base->drv->format_name : ""); |
6ebdcee2 JC |
2652 | if (ret) { |
2653 | goto exit; | |
2654 | } | |
5db15a57 | 2655 | bdrv_set_backing_hd(new_top_bs, base); |
6ebdcee2 | 2656 | |
6ebdcee2 | 2657 | ret = 0; |
6ebdcee2 | 2658 | exit: |
6ebdcee2 JC |
2659 | return ret; |
2660 | } | |
2661 | ||
61007b31 SH |
2662 | /** |
2663 | * Truncate file to 'offset' bytes (needed only for file protocols) | |
2664 | */ | |
2665 | int bdrv_truncate(BlockDriverState *bs, int64_t offset) | |
71d0770c | 2666 | { |
61007b31 SH |
2667 | BlockDriver *drv = bs->drv; |
2668 | int ret; | |
2669 | if (!drv) | |
71d0770c | 2670 | return -ENOMEDIUM; |
61007b31 SH |
2671 | if (!drv->bdrv_truncate) |
2672 | return -ENOTSUP; | |
2673 | if (bs->read_only) | |
2674 | return -EACCES; | |
71d0770c | 2675 | |
61007b31 SH |
2676 | ret = drv->bdrv_truncate(bs, offset); |
2677 | if (ret == 0) { | |
2678 | ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS); | |
2679 | bdrv_dirty_bitmap_truncate(bs); | |
2680 | if (bs->blk) { | |
2681 | blk_dev_resize_cb(bs->blk); | |
2682 | } | |
c0191e76 | 2683 | } |
61007b31 | 2684 | return ret; |
71d0770c AL |
2685 | } |
2686 | ||
61007b31 SH |
2687 | /** |
2688 | * Length of a allocated file in bytes. Sparse files are counted by actual | |
2689 | * allocated space. Return < 0 if error or unknown. | |
2690 | */ | |
2691 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs) | |
71d0770c | 2692 | { |
61007b31 SH |
2693 | BlockDriver *drv = bs->drv; |
2694 | if (!drv) { | |
2695 | return -ENOMEDIUM; | |
8f4754ed | 2696 | } |
61007b31 SH |
2697 | if (drv->bdrv_get_allocated_file_size) { |
2698 | return drv->bdrv_get_allocated_file_size(bs); | |
2699 | } | |
2700 | if (bs->file) { | |
9a4f4c31 | 2701 | return bdrv_get_allocated_file_size(bs->file->bs); |
1c9805a3 | 2702 | } |
61007b31 | 2703 | return -ENOTSUP; |
1c9805a3 | 2704 | } |
e7a8a783 | 2705 | |
61007b31 SH |
2706 | /** |
2707 | * Return number of sectors on success, -errno on error. | |
1c9805a3 | 2708 | */ |
61007b31 | 2709 | int64_t bdrv_nb_sectors(BlockDriverState *bs) |
1c9805a3 | 2710 | { |
61007b31 | 2711 | BlockDriver *drv = bs->drv; |
498e386c | 2712 | |
61007b31 SH |
2713 | if (!drv) |
2714 | return -ENOMEDIUM; | |
2572b37a | 2715 | |
61007b31 SH |
2716 | if (drv->has_variable_length) { |
2717 | int ret = refresh_total_sectors(bs, bs->total_sectors); | |
2718 | if (ret < 0) { | |
2719 | return ret; | |
1c9805a3 SH |
2720 | } |
2721 | } | |
61007b31 | 2722 | return bs->total_sectors; |
1c9805a3 | 2723 | } |
b338082b | 2724 | |
61007b31 SH |
2725 | /** |
2726 | * Return length in bytes on success, -errno on error. | |
2727 | * The length is always a multiple of BDRV_SECTOR_SIZE. | |
8d3b1a2d | 2728 | */ |
61007b31 | 2729 | int64_t bdrv_getlength(BlockDriverState *bs) |
8d3b1a2d | 2730 | { |
61007b31 | 2731 | int64_t ret = bdrv_nb_sectors(bs); |
8d3b1a2d | 2732 | |
4a9c9ea0 | 2733 | ret = ret > INT64_MAX / BDRV_SECTOR_SIZE ? -EFBIG : ret; |
61007b31 | 2734 | return ret < 0 ? ret : ret * BDRV_SECTOR_SIZE; |
fc01f7e7 FB |
2735 | } |
2736 | ||
61007b31 SH |
2737 | /* return 0 as number of sectors if no device present or error */ |
2738 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr) | |
07d27a44 | 2739 | { |
61007b31 | 2740 | int64_t nb_sectors = bdrv_nb_sectors(bs); |
07d27a44 | 2741 | |
61007b31 | 2742 | *nb_sectors_ptr = nb_sectors < 0 ? 0 : nb_sectors; |
07d27a44 MA |
2743 | } |
2744 | ||
61007b31 | 2745 | int bdrv_is_read_only(BlockDriverState *bs) |
8d3b1a2d | 2746 | { |
61007b31 | 2747 | return bs->read_only; |
83f64091 | 2748 | } |
83f64091 | 2749 | |
61007b31 | 2750 | int bdrv_is_sg(BlockDriverState *bs) |
f08145fe | 2751 | { |
61007b31 | 2752 | return bs->sg; |
f08145fe KW |
2753 | } |
2754 | ||
61007b31 | 2755 | int bdrv_enable_write_cache(BlockDriverState *bs) |
ab185921 | 2756 | { |
61007b31 | 2757 | return bs->enable_write_cache; |
ab185921 SH |
2758 | } |
2759 | ||
61007b31 | 2760 | void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce) |
da1fa91d | 2761 | { |
61007b31 | 2762 | bs->enable_write_cache = wce; |
ab185921 | 2763 | |
61007b31 SH |
2764 | /* so a reopen() will preserve wce */ |
2765 | if (wce) { | |
2766 | bs->open_flags |= BDRV_O_CACHE_WB; | |
893a8f62 | 2767 | } else { |
61007b31 | 2768 | bs->open_flags &= ~BDRV_O_CACHE_WB; |
893a8f62 | 2769 | } |
da1fa91d KW |
2770 | } |
2771 | ||
61007b31 | 2772 | int bdrv_is_encrypted(BlockDriverState *bs) |
fc3959e4 | 2773 | { |
760e0063 | 2774 | if (bs->backing && bs->backing->bs->encrypted) { |
61007b31 | 2775 | return 1; |
760e0063 | 2776 | } |
61007b31 | 2777 | return bs->encrypted; |
fc3959e4 FZ |
2778 | } |
2779 | ||
61007b31 | 2780 | int bdrv_key_required(BlockDriverState *bs) |
fc3959e4 | 2781 | { |
760e0063 | 2782 | BdrvChild *backing = bs->backing; |
61007b31 | 2783 | |
760e0063 | 2784 | if (backing && backing->bs->encrypted && !backing->bs->valid_key) { |
61007b31 | 2785 | return 1; |
760e0063 | 2786 | } |
61007b31 | 2787 | return (bs->encrypted && !bs->valid_key); |
fc3959e4 FZ |
2788 | } |
2789 | ||
61007b31 | 2790 | int bdrv_set_key(BlockDriverState *bs, const char *key) |
d0c7f642 | 2791 | { |
d0c7f642 | 2792 | int ret; |
760e0063 KW |
2793 | if (bs->backing && bs->backing->bs->encrypted) { |
2794 | ret = bdrv_set_key(bs->backing->bs, key); | |
61007b31 SH |
2795 | if (ret < 0) |
2796 | return ret; | |
2797 | if (!bs->encrypted) | |
2798 | return 0; | |
2799 | } | |
2800 | if (!bs->encrypted) { | |
2801 | return -EINVAL; | |
2802 | } else if (!bs->drv || !bs->drv->bdrv_set_key) { | |
d0c7f642 KW |
2803 | return -ENOMEDIUM; |
2804 | } | |
61007b31 | 2805 | ret = bs->drv->bdrv_set_key(bs, key); |
b9c64947 | 2806 | if (ret < 0) { |
61007b31 SH |
2807 | bs->valid_key = 0; |
2808 | } else if (!bs->valid_key) { | |
2809 | bs->valid_key = 1; | |
2810 | if (bs->blk) { | |
2811 | /* call the change callback now, we skipped it on open */ | |
2812 | blk_dev_change_media_cb(bs->blk, true); | |
2813 | } | |
1b0288ae | 2814 | } |
61007b31 SH |
2815 | return ret; |
2816 | } | |
f08f2dda | 2817 | |
c5fbe571 | 2818 | /* |
61007b31 SH |
2819 | * Provide an encryption key for @bs. |
2820 | * If @key is non-null: | |
2821 | * If @bs is not encrypted, fail. | |
2822 | * Else if the key is invalid, fail. | |
2823 | * Else set @bs's key to @key, replacing the existing key, if any. | |
2824 | * If @key is null: | |
2825 | * If @bs is encrypted and still lacks a key, fail. | |
2826 | * Else do nothing. | |
2827 | * On failure, store an error object through @errp if non-null. | |
c5fbe571 | 2828 | */ |
61007b31 | 2829 | void bdrv_add_key(BlockDriverState *bs, const char *key, Error **errp) |
c5fbe571 | 2830 | { |
61007b31 SH |
2831 | if (key) { |
2832 | if (!bdrv_is_encrypted(bs)) { | |
2833 | error_setg(errp, "Node '%s' is not encrypted", | |
2834 | bdrv_get_device_or_node_name(bs)); | |
2835 | } else if (bdrv_set_key(bs, key) < 0) { | |
c6bd8c70 | 2836 | error_setg(errp, QERR_INVALID_PASSWORD); |
4d2855a3 MA |
2837 | } |
2838 | } else { | |
2839 | if (bdrv_key_required(bs)) { | |
b1ca6391 MA |
2840 | error_set(errp, ERROR_CLASS_DEVICE_ENCRYPTED, |
2841 | "'%s' (%s) is encrypted", | |
81e5f78a | 2842 | bdrv_get_device_or_node_name(bs), |
4d2855a3 MA |
2843 | bdrv_get_encrypted_filename(bs)); |
2844 | } | |
2845 | } | |
2846 | } | |
2847 | ||
61007b31 | 2848 | const char *bdrv_get_format_name(BlockDriverState *bs) |
40b4f539 | 2849 | { |
61007b31 | 2850 | return bs->drv ? bs->drv->format_name : NULL; |
40b4f539 KW |
2851 | } |
2852 | ||
61007b31 | 2853 | static int qsort_strcmp(const void *a, const void *b) |
40b4f539 | 2854 | { |
61007b31 | 2855 | return strcmp(a, b); |
40b4f539 KW |
2856 | } |
2857 | ||
61007b31 SH |
2858 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
2859 | void *opaque) | |
40b4f539 | 2860 | { |
61007b31 SH |
2861 | BlockDriver *drv; |
2862 | int count = 0; | |
2863 | int i; | |
2864 | const char **formats = NULL; | |
40b4f539 | 2865 | |
61007b31 SH |
2866 | QLIST_FOREACH(drv, &bdrv_drivers, list) { |
2867 | if (drv->format_name) { | |
2868 | bool found = false; | |
2869 | int i = count; | |
2870 | while (formats && i && !found) { | |
2871 | found = !strcmp(formats[--i], drv->format_name); | |
2872 | } | |
e2a305fb | 2873 | |
61007b31 SH |
2874 | if (!found) { |
2875 | formats = g_renew(const char *, formats, count + 1); | |
2876 | formats[count++] = drv->format_name; | |
2877 | } | |
6c5a42ac | 2878 | } |
61007b31 | 2879 | } |
6c5a42ac | 2880 | |
61007b31 | 2881 | qsort(formats, count, sizeof(formats[0]), qsort_strcmp); |
40b4f539 | 2882 | |
61007b31 SH |
2883 | for (i = 0; i < count; i++) { |
2884 | it(opaque, formats[i]); | |
2885 | } | |
40b4f539 | 2886 | |
61007b31 SH |
2887 | g_free(formats); |
2888 | } | |
40b4f539 | 2889 | |
61007b31 SH |
2890 | /* This function is to find a node in the bs graph */ |
2891 | BlockDriverState *bdrv_find_node(const char *node_name) | |
2892 | { | |
2893 | BlockDriverState *bs; | |
391827eb | 2894 | |
61007b31 | 2895 | assert(node_name); |
40b4f539 | 2896 | |
61007b31 SH |
2897 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { |
2898 | if (!strcmp(node_name, bs->node_name)) { | |
2899 | return bs; | |
40b4f539 KW |
2900 | } |
2901 | } | |
61007b31 | 2902 | return NULL; |
40b4f539 KW |
2903 | } |
2904 | ||
61007b31 SH |
2905 | /* Put this QMP function here so it can access the static graph_bdrv_states. */ |
2906 | BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp) | |
40b4f539 | 2907 | { |
61007b31 SH |
2908 | BlockDeviceInfoList *list, *entry; |
2909 | BlockDriverState *bs; | |
40b4f539 | 2910 | |
61007b31 SH |
2911 | list = NULL; |
2912 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { | |
2913 | BlockDeviceInfo *info = bdrv_block_device_info(bs, errp); | |
2914 | if (!info) { | |
2915 | qapi_free_BlockDeviceInfoList(list); | |
2916 | return NULL; | |
301db7c2 | 2917 | } |
61007b31 SH |
2918 | entry = g_malloc0(sizeof(*entry)); |
2919 | entry->value = info; | |
2920 | entry->next = list; | |
2921 | list = entry; | |
301db7c2 RH |
2922 | } |
2923 | ||
61007b31 SH |
2924 | return list; |
2925 | } | |
40b4f539 | 2926 | |
61007b31 SH |
2927 | BlockDriverState *bdrv_lookup_bs(const char *device, |
2928 | const char *node_name, | |
2929 | Error **errp) | |
2930 | { | |
2931 | BlockBackend *blk; | |
2932 | BlockDriverState *bs; | |
40b4f539 | 2933 | |
61007b31 SH |
2934 | if (device) { |
2935 | blk = blk_by_name(device); | |
40b4f539 | 2936 | |
61007b31 | 2937 | if (blk) { |
9f4ed6fb AG |
2938 | bs = blk_bs(blk); |
2939 | if (!bs) { | |
5433c24f | 2940 | error_setg(errp, "Device '%s' has no medium", device); |
5433c24f HR |
2941 | } |
2942 | ||
9f4ed6fb | 2943 | return bs; |
61007b31 SH |
2944 | } |
2945 | } | |
40b4f539 | 2946 | |
61007b31 SH |
2947 | if (node_name) { |
2948 | bs = bdrv_find_node(node_name); | |
6d519a5f | 2949 | |
61007b31 SH |
2950 | if (bs) { |
2951 | return bs; | |
2952 | } | |
40b4f539 KW |
2953 | } |
2954 | ||
61007b31 SH |
2955 | error_setg(errp, "Cannot find device=%s nor node_name=%s", |
2956 | device ? device : "", | |
2957 | node_name ? node_name : ""); | |
2958 | return NULL; | |
40b4f539 KW |
2959 | } |
2960 | ||
61007b31 SH |
2961 | /* If 'base' is in the same chain as 'top', return true. Otherwise, |
2962 | * return false. If either argument is NULL, return false. */ | |
2963 | bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base) | |
83f64091 | 2964 | { |
61007b31 | 2965 | while (top && top != base) { |
760e0063 | 2966 | top = backing_bs(top); |
02c50efe | 2967 | } |
61007b31 SH |
2968 | |
2969 | return top != NULL; | |
02c50efe FZ |
2970 | } |
2971 | ||
61007b31 | 2972 | BlockDriverState *bdrv_next_node(BlockDriverState *bs) |
02c50efe | 2973 | { |
61007b31 SH |
2974 | if (!bs) { |
2975 | return QTAILQ_FIRST(&graph_bdrv_states); | |
02c50efe | 2976 | } |
61007b31 | 2977 | return QTAILQ_NEXT(bs, node_list); |
83f64091 FB |
2978 | } |
2979 | ||
61007b31 | 2980 | BlockDriverState *bdrv_next(BlockDriverState *bs) |
83f64091 | 2981 | { |
61007b31 SH |
2982 | if (!bs) { |
2983 | return QTAILQ_FIRST(&bdrv_states); | |
857d4f46 | 2984 | } |
61007b31 | 2985 | return QTAILQ_NEXT(bs, device_list); |
83f64091 | 2986 | } |
beac80cd | 2987 | |
61007b31 | 2988 | const char *bdrv_get_node_name(const BlockDriverState *bs) |
83f64091 | 2989 | { |
61007b31 | 2990 | return bs->node_name; |
beac80cd FB |
2991 | } |
2992 | ||
61007b31 SH |
2993 | /* TODO check what callers really want: bs->node_name or blk_name() */ |
2994 | const char *bdrv_get_device_name(const BlockDriverState *bs) | |
beac80cd | 2995 | { |
61007b31 | 2996 | return bs->blk ? blk_name(bs->blk) : ""; |
f141eafe | 2997 | } |
83f64091 | 2998 | |
61007b31 SH |
2999 | /* This can be used to identify nodes that might not have a device |
3000 | * name associated. Since node and device names live in the same | |
3001 | * namespace, the result is unambiguous. The exception is if both are | |
3002 | * absent, then this returns an empty (non-null) string. */ | |
3003 | const char *bdrv_get_device_or_node_name(const BlockDriverState *bs) | |
f141eafe | 3004 | { |
61007b31 | 3005 | return bs->blk ? blk_name(bs->blk) : bs->node_name; |
beac80cd | 3006 | } |
beac80cd | 3007 | |
61007b31 | 3008 | int bdrv_get_flags(BlockDriverState *bs) |
0b5a2445 | 3009 | { |
61007b31 | 3010 | return bs->open_flags; |
0b5a2445 PB |
3011 | } |
3012 | ||
61007b31 | 3013 | int bdrv_has_zero_init_1(BlockDriverState *bs) |
68485420 | 3014 | { |
61007b31 | 3015 | return 1; |
0b5a2445 PB |
3016 | } |
3017 | ||
61007b31 | 3018 | int bdrv_has_zero_init(BlockDriverState *bs) |
0b5a2445 | 3019 | { |
61007b31 | 3020 | assert(bs->drv); |
0b5a2445 | 3021 | |
61007b31 SH |
3022 | /* If BS is a copy on write image, it is initialized to |
3023 | the contents of the base image, which may not be zeroes. */ | |
760e0063 | 3024 | if (bs->backing) { |
61007b31 SH |
3025 | return 0; |
3026 | } | |
3027 | if (bs->drv->bdrv_has_zero_init) { | |
3028 | return bs->drv->bdrv_has_zero_init(bs); | |
0b5a2445 | 3029 | } |
61007b31 SH |
3030 | |
3031 | /* safe default */ | |
3032 | return 0; | |
68485420 KW |
3033 | } |
3034 | ||
61007b31 | 3035 | bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs) |
b2a61371 | 3036 | { |
61007b31 | 3037 | BlockDriverInfo bdi; |
b2a61371 | 3038 | |
760e0063 | 3039 | if (bs->backing) { |
61007b31 SH |
3040 | return false; |
3041 | } | |
3042 | ||
3043 | if (bdrv_get_info(bs, &bdi) == 0) { | |
3044 | return bdi.unallocated_blocks_are_zero; | |
b2a61371 SH |
3045 | } |
3046 | ||
61007b31 | 3047 | return false; |
b2a61371 SH |
3048 | } |
3049 | ||
61007b31 | 3050 | bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs) |
68485420 | 3051 | { |
61007b31 | 3052 | BlockDriverInfo bdi; |
68485420 | 3053 | |
760e0063 | 3054 | if (bs->backing || !(bs->open_flags & BDRV_O_UNMAP)) { |
61007b31 SH |
3055 | return false; |
3056 | } | |
68485420 | 3057 | |
61007b31 SH |
3058 | if (bdrv_get_info(bs, &bdi) == 0) { |
3059 | return bdi.can_write_zeroes_with_unmap; | |
3060 | } | |
68485420 | 3061 | |
61007b31 | 3062 | return false; |
68485420 KW |
3063 | } |
3064 | ||
61007b31 | 3065 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs) |
b2e12bc6 | 3066 | { |
760e0063 | 3067 | if (bs->backing && bs->backing->bs->encrypted) |
61007b31 SH |
3068 | return bs->backing_file; |
3069 | else if (bs->encrypted) | |
3070 | return bs->filename; | |
3071 | else | |
3072 | return NULL; | |
b2e12bc6 CH |
3073 | } |
3074 | ||
61007b31 SH |
3075 | void bdrv_get_backing_filename(BlockDriverState *bs, |
3076 | char *filename, int filename_size) | |
016f5cf6 | 3077 | { |
61007b31 SH |
3078 | pstrcpy(filename, filename_size, bs->backing_file); |
3079 | } | |
d318aea9 | 3080 | |
61007b31 SH |
3081 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi) |
3082 | { | |
3083 | BlockDriver *drv = bs->drv; | |
3084 | if (!drv) | |
3085 | return -ENOMEDIUM; | |
3086 | if (!drv->bdrv_get_info) | |
3087 | return -ENOTSUP; | |
3088 | memset(bdi, 0, sizeof(*bdi)); | |
3089 | return drv->bdrv_get_info(bs, bdi); | |
3090 | } | |
016f5cf6 | 3091 | |
61007b31 SH |
3092 | ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs) |
3093 | { | |
3094 | BlockDriver *drv = bs->drv; | |
3095 | if (drv && drv->bdrv_get_specific_info) { | |
3096 | return drv->bdrv_get_specific_info(bs); | |
3097 | } | |
3098 | return NULL; | |
016f5cf6 AG |
3099 | } |
3100 | ||
a31939e6 | 3101 | void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event) |
4265d620 | 3102 | { |
61007b31 SH |
3103 | if (!bs || !bs->drv || !bs->drv->bdrv_debug_event) { |
3104 | return; | |
3105 | } | |
4265d620 | 3106 | |
61007b31 | 3107 | bs->drv->bdrv_debug_event(bs, event); |
4265d620 PB |
3108 | } |
3109 | ||
61007b31 SH |
3110 | int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, |
3111 | const char *tag) | |
4265d620 | 3112 | { |
61007b31 | 3113 | while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) { |
9a4f4c31 | 3114 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 3115 | } |
4265d620 | 3116 | |
61007b31 SH |
3117 | if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) { |
3118 | return bs->drv->bdrv_debug_breakpoint(bs, event, tag); | |
3119 | } | |
4265d620 | 3120 | |
61007b31 | 3121 | return -ENOTSUP; |
4265d620 PB |
3122 | } |
3123 | ||
61007b31 | 3124 | int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag) |
ea2384d3 | 3125 | { |
61007b31 | 3126 | while (bs && bs->drv && !bs->drv->bdrv_debug_remove_breakpoint) { |
9a4f4c31 | 3127 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 3128 | } |
ce1a14dc | 3129 | |
61007b31 SH |
3130 | if (bs && bs->drv && bs->drv->bdrv_debug_remove_breakpoint) { |
3131 | return bs->drv->bdrv_debug_remove_breakpoint(bs, tag); | |
3132 | } | |
3133 | ||
3134 | return -ENOTSUP; | |
eb852011 MA |
3135 | } |
3136 | ||
61007b31 | 3137 | int bdrv_debug_resume(BlockDriverState *bs, const char *tag) |
ce1a14dc | 3138 | { |
61007b31 | 3139 | while (bs && (!bs->drv || !bs->drv->bdrv_debug_resume)) { |
9a4f4c31 | 3140 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 3141 | } |
ce1a14dc | 3142 | |
61007b31 SH |
3143 | if (bs && bs->drv && bs->drv->bdrv_debug_resume) { |
3144 | return bs->drv->bdrv_debug_resume(bs, tag); | |
3145 | } | |
ce1a14dc | 3146 | |
61007b31 | 3147 | return -ENOTSUP; |
f197fe2b FZ |
3148 | } |
3149 | ||
61007b31 | 3150 | bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag) |
ce1a14dc | 3151 | { |
61007b31 | 3152 | while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) { |
9a4f4c31 | 3153 | bs = bs->file ? bs->file->bs : NULL; |
f197fe2b | 3154 | } |
19cb3738 | 3155 | |
61007b31 SH |
3156 | if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) { |
3157 | return bs->drv->bdrv_debug_is_suspended(bs, tag); | |
3158 | } | |
f9f05dc5 | 3159 | |
61007b31 SH |
3160 | return false; |
3161 | } | |
f9f05dc5 | 3162 | |
61007b31 | 3163 | int bdrv_is_snapshot(BlockDriverState *bs) |
f9f05dc5 | 3164 | { |
61007b31 | 3165 | return !!(bs->open_flags & BDRV_O_SNAPSHOT); |
f9f05dc5 KW |
3166 | } |
3167 | ||
61007b31 SH |
3168 | /* backing_file can either be relative, or absolute, or a protocol. If it is |
3169 | * relative, it must be relative to the chain. So, passing in bs->filename | |
3170 | * from a BDS as backing_file should not be done, as that may be relative to | |
3171 | * the CWD rather than the chain. */ | |
3172 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, | |
3173 | const char *backing_file) | |
f9f05dc5 | 3174 | { |
61007b31 SH |
3175 | char *filename_full = NULL; |
3176 | char *backing_file_full = NULL; | |
3177 | char *filename_tmp = NULL; | |
3178 | int is_protocol = 0; | |
3179 | BlockDriverState *curr_bs = NULL; | |
3180 | BlockDriverState *retval = NULL; | |
f9f05dc5 | 3181 | |
61007b31 SH |
3182 | if (!bs || !bs->drv || !backing_file) { |
3183 | return NULL; | |
f9f05dc5 KW |
3184 | } |
3185 | ||
61007b31 SH |
3186 | filename_full = g_malloc(PATH_MAX); |
3187 | backing_file_full = g_malloc(PATH_MAX); | |
3188 | filename_tmp = g_malloc(PATH_MAX); | |
f9f05dc5 | 3189 | |
61007b31 | 3190 | is_protocol = path_has_protocol(backing_file); |
f9f05dc5 | 3191 | |
760e0063 | 3192 | for (curr_bs = bs; curr_bs->backing; curr_bs = curr_bs->backing->bs) { |
f9f05dc5 | 3193 | |
61007b31 SH |
3194 | /* If either of the filename paths is actually a protocol, then |
3195 | * compare unmodified paths; otherwise make paths relative */ | |
3196 | if (is_protocol || path_has_protocol(curr_bs->backing_file)) { | |
3197 | if (strcmp(backing_file, curr_bs->backing_file) == 0) { | |
760e0063 | 3198 | retval = curr_bs->backing->bs; |
61007b31 SH |
3199 | break; |
3200 | } | |
3201 | } else { | |
3202 | /* If not an absolute filename path, make it relative to the current | |
3203 | * image's filename path */ | |
3204 | path_combine(filename_tmp, PATH_MAX, curr_bs->filename, | |
3205 | backing_file); | |
f9f05dc5 | 3206 | |
61007b31 SH |
3207 | /* We are going to compare absolute pathnames */ |
3208 | if (!realpath(filename_tmp, filename_full)) { | |
3209 | continue; | |
3210 | } | |
07f07615 | 3211 | |
61007b31 SH |
3212 | /* We need to make sure the backing filename we are comparing against |
3213 | * is relative to the current image filename (or absolute) */ | |
3214 | path_combine(filename_tmp, PATH_MAX, curr_bs->filename, | |
3215 | curr_bs->backing_file); | |
07f07615 | 3216 | |
61007b31 SH |
3217 | if (!realpath(filename_tmp, backing_file_full)) { |
3218 | continue; | |
3219 | } | |
eb489bb1 | 3220 | |
61007b31 | 3221 | if (strcmp(backing_file_full, filename_full) == 0) { |
760e0063 | 3222 | retval = curr_bs->backing->bs; |
61007b31 SH |
3223 | break; |
3224 | } | |
3225 | } | |
eb489bb1 KW |
3226 | } |
3227 | ||
61007b31 SH |
3228 | g_free(filename_full); |
3229 | g_free(backing_file_full); | |
3230 | g_free(filename_tmp); | |
3231 | return retval; | |
3232 | } | |
3233 | ||
3234 | int bdrv_get_backing_file_depth(BlockDriverState *bs) | |
3235 | { | |
3236 | if (!bs->drv) { | |
3237 | return 0; | |
eb489bb1 KW |
3238 | } |
3239 | ||
760e0063 | 3240 | if (!bs->backing) { |
61007b31 | 3241 | return 0; |
ca716364 KW |
3242 | } |
3243 | ||
760e0063 | 3244 | return 1 + bdrv_get_backing_file_depth(bs->backing->bs); |
61007b31 | 3245 | } |
07f07615 | 3246 | |
61007b31 SH |
3247 | void bdrv_init(void) |
3248 | { | |
3249 | module_call_init(MODULE_INIT_BLOCK); | |
3250 | } | |
29cdb251 | 3251 | |
61007b31 SH |
3252 | void bdrv_init_with_whitelist(void) |
3253 | { | |
3254 | use_bdrv_whitelist = 1; | |
3255 | bdrv_init(); | |
07f07615 PB |
3256 | } |
3257 | ||
5a8a30db | 3258 | void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp) |
0f15423c | 3259 | { |
5a8a30db KW |
3260 | Error *local_err = NULL; |
3261 | int ret; | |
3262 | ||
3456a8d1 KW |
3263 | if (!bs->drv) { |
3264 | return; | |
3265 | } | |
3266 | ||
7ea2d269 AK |
3267 | if (!(bs->open_flags & BDRV_O_INCOMING)) { |
3268 | return; | |
3269 | } | |
3270 | bs->open_flags &= ~BDRV_O_INCOMING; | |
3271 | ||
3456a8d1 | 3272 | if (bs->drv->bdrv_invalidate_cache) { |
5a8a30db | 3273 | bs->drv->bdrv_invalidate_cache(bs, &local_err); |
3456a8d1 | 3274 | } else if (bs->file) { |
9a4f4c31 | 3275 | bdrv_invalidate_cache(bs->file->bs, &local_err); |
5a8a30db KW |
3276 | } |
3277 | if (local_err) { | |
3278 | error_propagate(errp, local_err); | |
3279 | return; | |
0f15423c | 3280 | } |
3456a8d1 | 3281 | |
5a8a30db KW |
3282 | ret = refresh_total_sectors(bs, bs->total_sectors); |
3283 | if (ret < 0) { | |
3284 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); | |
3285 | return; | |
3286 | } | |
0f15423c AL |
3287 | } |
3288 | ||
5a8a30db | 3289 | void bdrv_invalidate_cache_all(Error **errp) |
0f15423c AL |
3290 | { |
3291 | BlockDriverState *bs; | |
5a8a30db | 3292 | Error *local_err = NULL; |
0f15423c | 3293 | |
dc364f4c | 3294 | QTAILQ_FOREACH(bs, &bdrv_states, device_list) { |
ed78cda3 SH |
3295 | AioContext *aio_context = bdrv_get_aio_context(bs); |
3296 | ||
3297 | aio_context_acquire(aio_context); | |
5a8a30db | 3298 | bdrv_invalidate_cache(bs, &local_err); |
ed78cda3 | 3299 | aio_context_release(aio_context); |
5a8a30db KW |
3300 | if (local_err) { |
3301 | error_propagate(errp, local_err); | |
3302 | return; | |
3303 | } | |
0f15423c AL |
3304 | } |
3305 | } | |
3306 | ||
19cb3738 FB |
3307 | /**************************************************************/ |
3308 | /* removable device support */ | |
3309 | ||
3310 | /** | |
3311 | * Return TRUE if the media is present | |
3312 | */ | |
e031f750 | 3313 | bool bdrv_is_inserted(BlockDriverState *bs) |
19cb3738 FB |
3314 | { |
3315 | BlockDriver *drv = bs->drv; | |
28d7a789 | 3316 | BdrvChild *child; |
a1aff5bf | 3317 | |
e031f750 HR |
3318 | if (!drv) { |
3319 | return false; | |
3320 | } | |
28d7a789 HR |
3321 | if (drv->bdrv_is_inserted) { |
3322 | return drv->bdrv_is_inserted(bs); | |
3323 | } | |
3324 | QLIST_FOREACH(child, &bs->children, next) { | |
3325 | if (!bdrv_is_inserted(child->bs)) { | |
3326 | return false; | |
3327 | } | |
e031f750 | 3328 | } |
28d7a789 | 3329 | return true; |
19cb3738 FB |
3330 | } |
3331 | ||
3332 | /** | |
8e49ca46 MA |
3333 | * Return whether the media changed since the last call to this |
3334 | * function, or -ENOTSUP if we don't know. Most drivers don't know. | |
19cb3738 FB |
3335 | */ |
3336 | int bdrv_media_changed(BlockDriverState *bs) | |
3337 | { | |
3338 | BlockDriver *drv = bs->drv; | |
19cb3738 | 3339 | |
8e49ca46 MA |
3340 | if (drv && drv->bdrv_media_changed) { |
3341 | return drv->bdrv_media_changed(bs); | |
3342 | } | |
3343 | return -ENOTSUP; | |
19cb3738 FB |
3344 | } |
3345 | ||
3346 | /** | |
3347 | * If eject_flag is TRUE, eject the media. Otherwise, close the tray | |
3348 | */ | |
f36f3949 | 3349 | void bdrv_eject(BlockDriverState *bs, bool eject_flag) |
19cb3738 FB |
3350 | { |
3351 | BlockDriver *drv = bs->drv; | |
bfb197e0 | 3352 | const char *device_name; |
19cb3738 | 3353 | |
822e1cd1 MA |
3354 | if (drv && drv->bdrv_eject) { |
3355 | drv->bdrv_eject(bs, eject_flag); | |
19cb3738 | 3356 | } |
6f382ed2 | 3357 | |
bfb197e0 MA |
3358 | device_name = bdrv_get_device_name(bs); |
3359 | if (device_name[0] != '\0') { | |
3360 | qapi_event_send_device_tray_moved(device_name, | |
a5ee7bd4 | 3361 | eject_flag, &error_abort); |
6f382ed2 | 3362 | } |
19cb3738 FB |
3363 | } |
3364 | ||
19cb3738 FB |
3365 | /** |
3366 | * Lock or unlock the media (if it is locked, the user won't be able | |
3367 | * to eject it manually). | |
3368 | */ | |
025e849a | 3369 | void bdrv_lock_medium(BlockDriverState *bs, bool locked) |
19cb3738 FB |
3370 | { |
3371 | BlockDriver *drv = bs->drv; | |
3372 | ||
025e849a | 3373 | trace_bdrv_lock_medium(bs, locked); |
b8c6d095 | 3374 | |
025e849a MA |
3375 | if (drv && drv->bdrv_lock_medium) { |
3376 | drv->bdrv_lock_medium(bs, locked); | |
19cb3738 FB |
3377 | } |
3378 | } | |
985a03b0 | 3379 | |
0db6e54a FZ |
3380 | BdrvDirtyBitmap *bdrv_find_dirty_bitmap(BlockDriverState *bs, const char *name) |
3381 | { | |
3382 | BdrvDirtyBitmap *bm; | |
3383 | ||
3384 | assert(name); | |
3385 | QLIST_FOREACH(bm, &bs->dirty_bitmaps, list) { | |
3386 | if (bm->name && !strcmp(name, bm->name)) { | |
3387 | return bm; | |
3388 | } | |
3389 | } | |
3390 | return NULL; | |
3391 | } | |
3392 | ||
20dca810 | 3393 | void bdrv_dirty_bitmap_make_anon(BdrvDirtyBitmap *bitmap) |
0db6e54a | 3394 | { |
9bd2b08f | 3395 | assert(!bdrv_dirty_bitmap_frozen(bitmap)); |
0db6e54a FZ |
3396 | g_free(bitmap->name); |
3397 | bitmap->name = NULL; | |
3398 | } | |
3399 | ||
3400 | BdrvDirtyBitmap *bdrv_create_dirty_bitmap(BlockDriverState *bs, | |
5fba6c0e | 3401 | uint32_t granularity, |
0db6e54a | 3402 | const char *name, |
b8afb520 | 3403 | Error **errp) |
7cd1e32a LS |
3404 | { |
3405 | int64_t bitmap_size; | |
e4654d2d | 3406 | BdrvDirtyBitmap *bitmap; |
5fba6c0e | 3407 | uint32_t sector_granularity; |
a55eb92c | 3408 | |
50717e94 PB |
3409 | assert((granularity & (granularity - 1)) == 0); |
3410 | ||
0db6e54a FZ |
3411 | if (name && bdrv_find_dirty_bitmap(bs, name)) { |
3412 | error_setg(errp, "Bitmap already exists: %s", name); | |
3413 | return NULL; | |
3414 | } | |
5fba6c0e JS |
3415 | sector_granularity = granularity >> BDRV_SECTOR_BITS; |
3416 | assert(sector_granularity); | |
57322b78 | 3417 | bitmap_size = bdrv_nb_sectors(bs); |
b8afb520 FZ |
3418 | if (bitmap_size < 0) { |
3419 | error_setg_errno(errp, -bitmap_size, "could not get length of device"); | |
3420 | errno = -bitmap_size; | |
3421 | return NULL; | |
3422 | } | |
5839e53b | 3423 | bitmap = g_new0(BdrvDirtyBitmap, 1); |
5fba6c0e | 3424 | bitmap->bitmap = hbitmap_alloc(bitmap_size, ctz32(sector_granularity)); |
e74e6b78 | 3425 | bitmap->size = bitmap_size; |
0db6e54a | 3426 | bitmap->name = g_strdup(name); |
b8e6fb75 | 3427 | bitmap->disabled = false; |
e4654d2d FZ |
3428 | QLIST_INSERT_HEAD(&bs->dirty_bitmaps, bitmap, list); |
3429 | return bitmap; | |
3430 | } | |
3431 | ||
9bd2b08f JS |
3432 | bool bdrv_dirty_bitmap_frozen(BdrvDirtyBitmap *bitmap) |
3433 | { | |
3434 | return bitmap->successor; | |
3435 | } | |
3436 | ||
b8e6fb75 JS |
3437 | bool bdrv_dirty_bitmap_enabled(BdrvDirtyBitmap *bitmap) |
3438 | { | |
9bd2b08f JS |
3439 | return !(bitmap->disabled || bitmap->successor); |
3440 | } | |
3441 | ||
9abe3bdc JS |
3442 | DirtyBitmapStatus bdrv_dirty_bitmap_status(BdrvDirtyBitmap *bitmap) |
3443 | { | |
3444 | if (bdrv_dirty_bitmap_frozen(bitmap)) { | |
3445 | return DIRTY_BITMAP_STATUS_FROZEN; | |
3446 | } else if (!bdrv_dirty_bitmap_enabled(bitmap)) { | |
3447 | return DIRTY_BITMAP_STATUS_DISABLED; | |
3448 | } else { | |
3449 | return DIRTY_BITMAP_STATUS_ACTIVE; | |
3450 | } | |
3451 | } | |
3452 | ||
9bd2b08f JS |
3453 | /** |
3454 | * Create a successor bitmap destined to replace this bitmap after an operation. | |
3455 | * Requires that the bitmap is not frozen and has no successor. | |
3456 | */ | |
3457 | int bdrv_dirty_bitmap_create_successor(BlockDriverState *bs, | |
3458 | BdrvDirtyBitmap *bitmap, Error **errp) | |
3459 | { | |
3460 | uint64_t granularity; | |
3461 | BdrvDirtyBitmap *child; | |
3462 | ||
3463 | if (bdrv_dirty_bitmap_frozen(bitmap)) { | |
3464 | error_setg(errp, "Cannot create a successor for a bitmap that is " | |
3465 | "currently frozen"); | |
3466 | return -1; | |
3467 | } | |
3468 | assert(!bitmap->successor); | |
3469 | ||
3470 | /* Create an anonymous successor */ | |
3471 | granularity = bdrv_dirty_bitmap_granularity(bitmap); | |
3472 | child = bdrv_create_dirty_bitmap(bs, granularity, NULL, errp); | |
3473 | if (!child) { | |
3474 | return -1; | |
3475 | } | |
3476 | ||
3477 | /* Successor will be on or off based on our current state. */ | |
3478 | child->disabled = bitmap->disabled; | |
3479 | ||
3480 | /* Install the successor and freeze the parent */ | |
3481 | bitmap->successor = child; | |
3482 | return 0; | |
3483 | } | |
3484 | ||
3485 | /** | |
3486 | * For a bitmap with a successor, yield our name to the successor, | |
3487 | * delete the old bitmap, and return a handle to the new bitmap. | |
3488 | */ | |
3489 | BdrvDirtyBitmap *bdrv_dirty_bitmap_abdicate(BlockDriverState *bs, | |
3490 | BdrvDirtyBitmap *bitmap, | |
3491 | Error **errp) | |
3492 | { | |
3493 | char *name; | |
3494 | BdrvDirtyBitmap *successor = bitmap->successor; | |
3495 | ||
3496 | if (successor == NULL) { | |
3497 | error_setg(errp, "Cannot relinquish control if " | |
3498 | "there's no successor present"); | |
3499 | return NULL; | |
3500 | } | |
3501 | ||
3502 | name = bitmap->name; | |
3503 | bitmap->name = NULL; | |
3504 | successor->name = name; | |
3505 | bitmap->successor = NULL; | |
3506 | bdrv_release_dirty_bitmap(bs, bitmap); | |
3507 | ||
3508 | return successor; | |
3509 | } | |
3510 | ||
3511 | /** | |
3512 | * In cases of failure where we can no longer safely delete the parent, | |
3513 | * we may wish to re-join the parent and child/successor. | |
3514 | * The merged parent will be un-frozen, but not explicitly re-enabled. | |
3515 | */ | |
3516 | BdrvDirtyBitmap *bdrv_reclaim_dirty_bitmap(BlockDriverState *bs, | |
3517 | BdrvDirtyBitmap *parent, | |
3518 | Error **errp) | |
3519 | { | |
3520 | BdrvDirtyBitmap *successor = parent->successor; | |
3521 | ||
3522 | if (!successor) { | |
3523 | error_setg(errp, "Cannot reclaim a successor when none is present"); | |
3524 | return NULL; | |
3525 | } | |
3526 | ||
3527 | if (!hbitmap_merge(parent->bitmap, successor->bitmap)) { | |
3528 | error_setg(errp, "Merging of parent and successor bitmap failed"); | |
3529 | return NULL; | |
3530 | } | |
3531 | bdrv_release_dirty_bitmap(bs, successor); | |
3532 | parent->successor = NULL; | |
3533 | ||
3534 | return parent; | |
b8e6fb75 JS |
3535 | } |
3536 | ||
ce1ffea8 JS |
3537 | /** |
3538 | * Truncates _all_ bitmaps attached to a BDS. | |
3539 | */ | |
3540 | static void bdrv_dirty_bitmap_truncate(BlockDriverState *bs) | |
3541 | { | |
3542 | BdrvDirtyBitmap *bitmap; | |
3543 | uint64_t size = bdrv_nb_sectors(bs); | |
3544 | ||
3545 | QLIST_FOREACH(bitmap, &bs->dirty_bitmaps, list) { | |
06207b0f | 3546 | assert(!bdrv_dirty_bitmap_frozen(bitmap)); |
ce1ffea8 | 3547 | hbitmap_truncate(bitmap->bitmap, size); |
5270b6a0 | 3548 | bitmap->size = size; |
ce1ffea8 JS |
3549 | } |
3550 | } | |
3551 | ||
e4654d2d FZ |
3552 | void bdrv_release_dirty_bitmap(BlockDriverState *bs, BdrvDirtyBitmap *bitmap) |
3553 | { | |
3554 | BdrvDirtyBitmap *bm, *next; | |
3555 | QLIST_FOREACH_SAFE(bm, &bs->dirty_bitmaps, list, next) { | |
3556 | if (bm == bitmap) { | |
9bd2b08f | 3557 | assert(!bdrv_dirty_bitmap_frozen(bm)); |
e4654d2d FZ |
3558 | QLIST_REMOVE(bitmap, list); |
3559 | hbitmap_free(bitmap->bitmap); | |
0db6e54a | 3560 | g_free(bitmap->name); |
e4654d2d FZ |
3561 | g_free(bitmap); |
3562 | return; | |
a55eb92c | 3563 | } |
7cd1e32a LS |
3564 | } |
3565 | } | |
3566 | ||
b8e6fb75 JS |
3567 | void bdrv_disable_dirty_bitmap(BdrvDirtyBitmap *bitmap) |
3568 | { | |
9bd2b08f | 3569 | assert(!bdrv_dirty_bitmap_frozen(bitmap)); |
b8e6fb75 JS |
3570 | bitmap->disabled = true; |
3571 | } | |
3572 | ||
3573 | void bdrv_enable_dirty_bitmap(BdrvDirtyBitmap *bitmap) | |
3574 | { | |
9bd2b08f | 3575 | assert(!bdrv_dirty_bitmap_frozen(bitmap)); |
b8e6fb75 JS |
3576 | bitmap->disabled = false; |
3577 | } | |
3578 | ||
21b56835 FZ |
3579 | BlockDirtyInfoList *bdrv_query_dirty_bitmaps(BlockDriverState *bs) |
3580 | { | |
3581 | BdrvDirtyBitmap *bm; | |
3582 | BlockDirtyInfoList *list = NULL; | |
3583 | BlockDirtyInfoList **plist = &list; | |
3584 | ||
3585 | QLIST_FOREACH(bm, &bs->dirty_bitmaps, list) { | |
5839e53b MA |
3586 | BlockDirtyInfo *info = g_new0(BlockDirtyInfo, 1); |
3587 | BlockDirtyInfoList *entry = g_new0(BlockDirtyInfoList, 1); | |
20dca810 | 3588 | info->count = bdrv_get_dirty_count(bm); |
592fdd02 | 3589 | info->granularity = bdrv_dirty_bitmap_granularity(bm); |
0db6e54a FZ |
3590 | info->has_name = !!bm->name; |
3591 | info->name = g_strdup(bm->name); | |
9abe3bdc | 3592 | info->status = bdrv_dirty_bitmap_status(bm); |
21b56835 FZ |
3593 | entry->value = info; |
3594 | *plist = entry; | |
3595 | plist = &entry->next; | |
3596 | } | |
3597 | ||
3598 | return list; | |
3599 | } | |
3600 | ||
e4654d2d | 3601 | int bdrv_get_dirty(BlockDriverState *bs, BdrvDirtyBitmap *bitmap, int64_t sector) |
7cd1e32a | 3602 | { |
e4654d2d FZ |
3603 | if (bitmap) { |
3604 | return hbitmap_get(bitmap->bitmap, sector); | |
7cd1e32a LS |
3605 | } else { |
3606 | return 0; | |
3607 | } | |
3608 | } | |
3609 | ||
341ebc2f JS |
3610 | /** |
3611 | * Chooses a default granularity based on the existing cluster size, | |
3612 | * but clamped between [4K, 64K]. Defaults to 64K in the case that there | |
3613 | * is no cluster size information available. | |
3614 | */ | |
3615 | uint32_t bdrv_get_default_bitmap_granularity(BlockDriverState *bs) | |
3616 | { | |
3617 | BlockDriverInfo bdi; | |
3618 | uint32_t granularity; | |
3619 | ||
3620 | if (bdrv_get_info(bs, &bdi) >= 0 && bdi.cluster_size > 0) { | |
3621 | granularity = MAX(4096, bdi.cluster_size); | |
3622 | granularity = MIN(65536, granularity); | |
3623 | } else { | |
3624 | granularity = 65536; | |
3625 | } | |
3626 | ||
3627 | return granularity; | |
3628 | } | |
3629 | ||
592fdd02 JS |
3630 | uint32_t bdrv_dirty_bitmap_granularity(BdrvDirtyBitmap *bitmap) |
3631 | { | |
3632 | return BDRV_SECTOR_SIZE << hbitmap_granularity(bitmap->bitmap); | |
3633 | } | |
3634 | ||
20dca810 | 3635 | void bdrv_dirty_iter_init(BdrvDirtyBitmap *bitmap, HBitmapIter *hbi) |
1755da16 | 3636 | { |
e4654d2d | 3637 | hbitmap_iter_init(hbi, bitmap->bitmap, 0); |
1755da16 PB |
3638 | } |
3639 | ||
20dca810 | 3640 | void bdrv_set_dirty_bitmap(BdrvDirtyBitmap *bitmap, |
c4237dfa VSO |
3641 | int64_t cur_sector, int nr_sectors) |
3642 | { | |
b8e6fb75 | 3643 | assert(bdrv_dirty_bitmap_enabled(bitmap)); |
c4237dfa VSO |
3644 | hbitmap_set(bitmap->bitmap, cur_sector, nr_sectors); |
3645 | } | |
3646 | ||
20dca810 | 3647 | void bdrv_reset_dirty_bitmap(BdrvDirtyBitmap *bitmap, |
c4237dfa VSO |
3648 | int64_t cur_sector, int nr_sectors) |
3649 | { | |
b8e6fb75 | 3650 | assert(bdrv_dirty_bitmap_enabled(bitmap)); |
c4237dfa VSO |
3651 | hbitmap_reset(bitmap->bitmap, cur_sector, nr_sectors); |
3652 | } | |
3653 | ||
df9a681d | 3654 | void bdrv_clear_dirty_bitmap(BdrvDirtyBitmap *bitmap, HBitmap **out) |
e74e6b78 JS |
3655 | { |
3656 | assert(bdrv_dirty_bitmap_enabled(bitmap)); | |
df9a681d FZ |
3657 | if (!out) { |
3658 | hbitmap_reset_all(bitmap->bitmap); | |
3659 | } else { | |
3660 | HBitmap *backup = bitmap->bitmap; | |
3661 | bitmap->bitmap = hbitmap_alloc(bitmap->size, | |
3662 | hbitmap_granularity(backup)); | |
3663 | *out = backup; | |
3664 | } | |
3665 | } | |
3666 | ||
3667 | void bdrv_undo_clear_dirty_bitmap(BdrvDirtyBitmap *bitmap, HBitmap *in) | |
3668 | { | |
3669 | HBitmap *tmp = bitmap->bitmap; | |
3670 | assert(bdrv_dirty_bitmap_enabled(bitmap)); | |
3671 | bitmap->bitmap = in; | |
3672 | hbitmap_free(tmp); | |
e74e6b78 JS |
3673 | } |
3674 | ||
e0c47b6c SH |
3675 | void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, |
3676 | int nr_sectors) | |
1755da16 | 3677 | { |
e4654d2d FZ |
3678 | BdrvDirtyBitmap *bitmap; |
3679 | QLIST_FOREACH(bitmap, &bs->dirty_bitmaps, list) { | |
b8e6fb75 JS |
3680 | if (!bdrv_dirty_bitmap_enabled(bitmap)) { |
3681 | continue; | |
3682 | } | |
e4654d2d FZ |
3683 | hbitmap_set(bitmap->bitmap, cur_sector, nr_sectors); |
3684 | } | |
1755da16 PB |
3685 | } |
3686 | ||
d58d8453 JS |
3687 | /** |
3688 | * Advance an HBitmapIter to an arbitrary offset. | |
3689 | */ | |
3690 | void bdrv_set_dirty_iter(HBitmapIter *hbi, int64_t offset) | |
3691 | { | |
3692 | assert(hbi->hb); | |
3693 | hbitmap_iter_init(hbi, hbi->hb, offset); | |
3694 | } | |
3695 | ||
20dca810 | 3696 | int64_t bdrv_get_dirty_count(BdrvDirtyBitmap *bitmap) |
aaa0eb75 | 3697 | { |
e4654d2d | 3698 | return hbitmap_count(bitmap->bitmap); |
aaa0eb75 | 3699 | } |
f88e1a42 | 3700 | |
9fcb0251 FZ |
3701 | /* Get a reference to bs */ |
3702 | void bdrv_ref(BlockDriverState *bs) | |
3703 | { | |
3704 | bs->refcnt++; | |
3705 | } | |
3706 | ||
3707 | /* Release a previously grabbed reference to bs. | |
3708 | * If after releasing, reference count is zero, the BlockDriverState is | |
3709 | * deleted. */ | |
3710 | void bdrv_unref(BlockDriverState *bs) | |
3711 | { | |
9a4d5ca6 JC |
3712 | if (!bs) { |
3713 | return; | |
3714 | } | |
9fcb0251 FZ |
3715 | assert(bs->refcnt > 0); |
3716 | if (--bs->refcnt == 0) { | |
3717 | bdrv_delete(bs); | |
3718 | } | |
3719 | } | |
3720 | ||
fbe40ff7 FZ |
3721 | struct BdrvOpBlocker { |
3722 | Error *reason; | |
3723 | QLIST_ENTRY(BdrvOpBlocker) list; | |
3724 | }; | |
3725 | ||
3726 | bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp) | |
3727 | { | |
3728 | BdrvOpBlocker *blocker; | |
3729 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
3730 | if (!QLIST_EMPTY(&bs->op_blockers[op])) { | |
3731 | blocker = QLIST_FIRST(&bs->op_blockers[op]); | |
3732 | if (errp) { | |
81e5f78a AG |
3733 | error_setg(errp, "Node '%s' is busy: %s", |
3734 | bdrv_get_device_or_node_name(bs), | |
bfb197e0 | 3735 | error_get_pretty(blocker->reason)); |
fbe40ff7 FZ |
3736 | } |
3737 | return true; | |
3738 | } | |
3739 | return false; | |
3740 | } | |
3741 | ||
3742 | void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason) | |
3743 | { | |
3744 | BdrvOpBlocker *blocker; | |
3745 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
3746 | ||
5839e53b | 3747 | blocker = g_new0(BdrvOpBlocker, 1); |
fbe40ff7 FZ |
3748 | blocker->reason = reason; |
3749 | QLIST_INSERT_HEAD(&bs->op_blockers[op], blocker, list); | |
3750 | } | |
3751 | ||
3752 | void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason) | |
3753 | { | |
3754 | BdrvOpBlocker *blocker, *next; | |
3755 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
3756 | QLIST_FOREACH_SAFE(blocker, &bs->op_blockers[op], list, next) { | |
3757 | if (blocker->reason == reason) { | |
3758 | QLIST_REMOVE(blocker, list); | |
3759 | g_free(blocker); | |
3760 | } | |
3761 | } | |
3762 | } | |
3763 | ||
3764 | void bdrv_op_block_all(BlockDriverState *bs, Error *reason) | |
3765 | { | |
3766 | int i; | |
3767 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
3768 | bdrv_op_block(bs, i, reason); | |
3769 | } | |
3770 | } | |
3771 | ||
3772 | void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason) | |
3773 | { | |
3774 | int i; | |
3775 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
3776 | bdrv_op_unblock(bs, i, reason); | |
3777 | } | |
3778 | } | |
3779 | ||
3780 | bool bdrv_op_blocker_is_empty(BlockDriverState *bs) | |
3781 | { | |
3782 | int i; | |
3783 | ||
3784 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
3785 | if (!QLIST_EMPTY(&bs->op_blockers[i])) { | |
3786 | return false; | |
3787 | } | |
3788 | } | |
3789 | return true; | |
3790 | } | |
3791 | ||
d92ada22 LC |
3792 | void bdrv_img_create(const char *filename, const char *fmt, |
3793 | const char *base_filename, const char *base_fmt, | |
f382d43a MR |
3794 | char *options, uint64_t img_size, int flags, |
3795 | Error **errp, bool quiet) | |
f88e1a42 | 3796 | { |
83d0521a CL |
3797 | QemuOptsList *create_opts = NULL; |
3798 | QemuOpts *opts = NULL; | |
3799 | const char *backing_fmt, *backing_file; | |
3800 | int64_t size; | |
f88e1a42 | 3801 | BlockDriver *drv, *proto_drv; |
cc84d90f | 3802 | Error *local_err = NULL; |
f88e1a42 JS |
3803 | int ret = 0; |
3804 | ||
3805 | /* Find driver and parse its options */ | |
3806 | drv = bdrv_find_format(fmt); | |
3807 | if (!drv) { | |
71c79813 | 3808 | error_setg(errp, "Unknown file format '%s'", fmt); |
d92ada22 | 3809 | return; |
f88e1a42 JS |
3810 | } |
3811 | ||
b65a5e12 | 3812 | proto_drv = bdrv_find_protocol(filename, true, errp); |
f88e1a42 | 3813 | if (!proto_drv) { |
d92ada22 | 3814 | return; |
f88e1a42 JS |
3815 | } |
3816 | ||
c6149724 HR |
3817 | if (!drv->create_opts) { |
3818 | error_setg(errp, "Format driver '%s' does not support image creation", | |
3819 | drv->format_name); | |
3820 | return; | |
3821 | } | |
3822 | ||
3823 | if (!proto_drv->create_opts) { | |
3824 | error_setg(errp, "Protocol driver '%s' does not support image creation", | |
3825 | proto_drv->format_name); | |
3826 | return; | |
3827 | } | |
3828 | ||
c282e1fd CL |
3829 | create_opts = qemu_opts_append(create_opts, drv->create_opts); |
3830 | create_opts = qemu_opts_append(create_opts, proto_drv->create_opts); | |
f88e1a42 JS |
3831 | |
3832 | /* Create parameter list with default values */ | |
83d0521a | 3833 | opts = qemu_opts_create(create_opts, NULL, 0, &error_abort); |
39101f25 | 3834 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort); |
f88e1a42 JS |
3835 | |
3836 | /* Parse -o options */ | |
3837 | if (options) { | |
dc523cd3 MA |
3838 | qemu_opts_do_parse(opts, options, NULL, &local_err); |
3839 | if (local_err) { | |
3840 | error_report_err(local_err); | |
3841 | local_err = NULL; | |
83d0521a | 3842 | error_setg(errp, "Invalid options for file format '%s'", fmt); |
f88e1a42 JS |
3843 | goto out; |
3844 | } | |
3845 | } | |
3846 | ||
3847 | if (base_filename) { | |
f43e47db | 3848 | qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &local_err); |
6be4194b | 3849 | if (local_err) { |
71c79813 LC |
3850 | error_setg(errp, "Backing file not supported for file format '%s'", |
3851 | fmt); | |
f88e1a42 JS |
3852 | goto out; |
3853 | } | |
3854 | } | |
3855 | ||
3856 | if (base_fmt) { | |
f43e47db | 3857 | qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &local_err); |
6be4194b | 3858 | if (local_err) { |
71c79813 LC |
3859 | error_setg(errp, "Backing file format not supported for file " |
3860 | "format '%s'", fmt); | |
f88e1a42 JS |
3861 | goto out; |
3862 | } | |
3863 | } | |
3864 | ||
83d0521a CL |
3865 | backing_file = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE); |
3866 | if (backing_file) { | |
3867 | if (!strcmp(filename, backing_file)) { | |
71c79813 LC |
3868 | error_setg(errp, "Error: Trying to create an image with the " |
3869 | "same filename as the backing file"); | |
792da93a JS |
3870 | goto out; |
3871 | } | |
3872 | } | |
3873 | ||
83d0521a | 3874 | backing_fmt = qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT); |
f88e1a42 JS |
3875 | |
3876 | // The size for the image must always be specified, with one exception: | |
3877 | // If we are using a backing file, we can obtain the size from there | |
83d0521a CL |
3878 | size = qemu_opt_get_size(opts, BLOCK_OPT_SIZE, 0); |
3879 | if (size == -1) { | |
3880 | if (backing_file) { | |
66f6b814 | 3881 | BlockDriverState *bs; |
29168018 | 3882 | char *full_backing = g_new0(char, PATH_MAX); |
52bf1e72 | 3883 | int64_t size; |
63090dac | 3884 | int back_flags; |
e6641719 | 3885 | QDict *backing_options = NULL; |
63090dac | 3886 | |
29168018 HR |
3887 | bdrv_get_full_backing_filename_from_filename(filename, backing_file, |
3888 | full_backing, PATH_MAX, | |
3889 | &local_err); | |
3890 | if (local_err) { | |
3891 | g_free(full_backing); | |
3892 | goto out; | |
3893 | } | |
3894 | ||
63090dac PB |
3895 | /* backing files always opened read-only */ |
3896 | back_flags = | |
3897 | flags & ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING); | |
f88e1a42 | 3898 | |
e6641719 HR |
3899 | if (backing_fmt) { |
3900 | backing_options = qdict_new(); | |
3901 | qdict_put(backing_options, "driver", | |
3902 | qstring_from_str(backing_fmt)); | |
3903 | } | |
3904 | ||
f67503e5 | 3905 | bs = NULL; |
e6641719 | 3906 | ret = bdrv_open(&bs, full_backing, NULL, backing_options, |
6ebf9aa2 | 3907 | back_flags, &local_err); |
29168018 | 3908 | g_free(full_backing); |
f88e1a42 | 3909 | if (ret < 0) { |
f88e1a42 JS |
3910 | goto out; |
3911 | } | |
52bf1e72 MA |
3912 | size = bdrv_getlength(bs); |
3913 | if (size < 0) { | |
3914 | error_setg_errno(errp, -size, "Could not get size of '%s'", | |
3915 | backing_file); | |
3916 | bdrv_unref(bs); | |
3917 | goto out; | |
3918 | } | |
f88e1a42 | 3919 | |
39101f25 | 3920 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, size, &error_abort); |
66f6b814 HR |
3921 | |
3922 | bdrv_unref(bs); | |
f88e1a42 | 3923 | } else { |
71c79813 | 3924 | error_setg(errp, "Image creation needs a size parameter"); |
f88e1a42 JS |
3925 | goto out; |
3926 | } | |
3927 | } | |
3928 | ||
f382d43a | 3929 | if (!quiet) { |
fe646693 | 3930 | printf("Formatting '%s', fmt=%s ", filename, fmt); |
43c5d8f8 | 3931 | qemu_opts_print(opts, " "); |
f382d43a MR |
3932 | puts(""); |
3933 | } | |
83d0521a | 3934 | |
c282e1fd | 3935 | ret = bdrv_create(drv, filename, opts, &local_err); |
83d0521a | 3936 | |
cc84d90f HR |
3937 | if (ret == -EFBIG) { |
3938 | /* This is generally a better message than whatever the driver would | |
3939 | * deliver (especially because of the cluster_size_hint), since that | |
3940 | * is most probably not much different from "image too large". */ | |
3941 | const char *cluster_size_hint = ""; | |
83d0521a | 3942 | if (qemu_opt_get_size(opts, BLOCK_OPT_CLUSTER_SIZE, 0)) { |
cc84d90f | 3943 | cluster_size_hint = " (try using a larger cluster size)"; |
f88e1a42 | 3944 | } |
cc84d90f HR |
3945 | error_setg(errp, "The image size is too large for file format '%s'" |
3946 | "%s", fmt, cluster_size_hint); | |
3947 | error_free(local_err); | |
3948 | local_err = NULL; | |
f88e1a42 JS |
3949 | } |
3950 | ||
3951 | out: | |
83d0521a CL |
3952 | qemu_opts_del(opts); |
3953 | qemu_opts_free(create_opts); | |
84d18f06 | 3954 | if (local_err) { |
cc84d90f HR |
3955 | error_propagate(errp, local_err); |
3956 | } | |
f88e1a42 | 3957 | } |
85d126f3 SH |
3958 | |
3959 | AioContext *bdrv_get_aio_context(BlockDriverState *bs) | |
3960 | { | |
dcd04228 SH |
3961 | return bs->aio_context; |
3962 | } | |
3963 | ||
3964 | void bdrv_detach_aio_context(BlockDriverState *bs) | |
3965 | { | |
33384421 HR |
3966 | BdrvAioNotifier *baf; |
3967 | ||
dcd04228 SH |
3968 | if (!bs->drv) { |
3969 | return; | |
3970 | } | |
3971 | ||
33384421 HR |
3972 | QLIST_FOREACH(baf, &bs->aio_notifiers, list) { |
3973 | baf->detach_aio_context(baf->opaque); | |
3974 | } | |
3975 | ||
a0d64a61 | 3976 | if (bs->throttle_state) { |
0e5b0a2d | 3977 | throttle_timers_detach_aio_context(&bs->throttle_timers); |
13af91eb | 3978 | } |
dcd04228 SH |
3979 | if (bs->drv->bdrv_detach_aio_context) { |
3980 | bs->drv->bdrv_detach_aio_context(bs); | |
3981 | } | |
3982 | if (bs->file) { | |
9a4f4c31 | 3983 | bdrv_detach_aio_context(bs->file->bs); |
dcd04228 | 3984 | } |
760e0063 KW |
3985 | if (bs->backing) { |
3986 | bdrv_detach_aio_context(bs->backing->bs); | |
dcd04228 SH |
3987 | } |
3988 | ||
3989 | bs->aio_context = NULL; | |
3990 | } | |
3991 | ||
3992 | void bdrv_attach_aio_context(BlockDriverState *bs, | |
3993 | AioContext *new_context) | |
3994 | { | |
33384421 HR |
3995 | BdrvAioNotifier *ban; |
3996 | ||
dcd04228 SH |
3997 | if (!bs->drv) { |
3998 | return; | |
3999 | } | |
4000 | ||
4001 | bs->aio_context = new_context; | |
4002 | ||
760e0063 KW |
4003 | if (bs->backing) { |
4004 | bdrv_attach_aio_context(bs->backing->bs, new_context); | |
dcd04228 SH |
4005 | } |
4006 | if (bs->file) { | |
9a4f4c31 | 4007 | bdrv_attach_aio_context(bs->file->bs, new_context); |
dcd04228 SH |
4008 | } |
4009 | if (bs->drv->bdrv_attach_aio_context) { | |
4010 | bs->drv->bdrv_attach_aio_context(bs, new_context); | |
4011 | } | |
a0d64a61 | 4012 | if (bs->throttle_state) { |
0e5b0a2d | 4013 | throttle_timers_attach_aio_context(&bs->throttle_timers, new_context); |
13af91eb | 4014 | } |
33384421 HR |
4015 | |
4016 | QLIST_FOREACH(ban, &bs->aio_notifiers, list) { | |
4017 | ban->attached_aio_context(new_context, ban->opaque); | |
4018 | } | |
dcd04228 SH |
4019 | } |
4020 | ||
4021 | void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context) | |
4022 | { | |
53ec73e2 | 4023 | bdrv_drain(bs); /* ensure there are no in-flight requests */ |
dcd04228 SH |
4024 | |
4025 | bdrv_detach_aio_context(bs); | |
4026 | ||
4027 | /* This function executes in the old AioContext so acquire the new one in | |
4028 | * case it runs in a different thread. | |
4029 | */ | |
4030 | aio_context_acquire(new_context); | |
4031 | bdrv_attach_aio_context(bs, new_context); | |
4032 | aio_context_release(new_context); | |
85d126f3 | 4033 | } |
d616b224 | 4034 | |
33384421 HR |
4035 | void bdrv_add_aio_context_notifier(BlockDriverState *bs, |
4036 | void (*attached_aio_context)(AioContext *new_context, void *opaque), | |
4037 | void (*detach_aio_context)(void *opaque), void *opaque) | |
4038 | { | |
4039 | BdrvAioNotifier *ban = g_new(BdrvAioNotifier, 1); | |
4040 | *ban = (BdrvAioNotifier){ | |
4041 | .attached_aio_context = attached_aio_context, | |
4042 | .detach_aio_context = detach_aio_context, | |
4043 | .opaque = opaque | |
4044 | }; | |
4045 | ||
4046 | QLIST_INSERT_HEAD(&bs->aio_notifiers, ban, list); | |
4047 | } | |
4048 | ||
4049 | void bdrv_remove_aio_context_notifier(BlockDriverState *bs, | |
4050 | void (*attached_aio_context)(AioContext *, | |
4051 | void *), | |
4052 | void (*detach_aio_context)(void *), | |
4053 | void *opaque) | |
4054 | { | |
4055 | BdrvAioNotifier *ban, *ban_next; | |
4056 | ||
4057 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { | |
4058 | if (ban->attached_aio_context == attached_aio_context && | |
4059 | ban->detach_aio_context == detach_aio_context && | |
4060 | ban->opaque == opaque) | |
4061 | { | |
4062 | QLIST_REMOVE(ban, list); | |
4063 | g_free(ban); | |
4064 | ||
4065 | return; | |
4066 | } | |
4067 | } | |
4068 | ||
4069 | abort(); | |
4070 | } | |
4071 | ||
77485434 | 4072 | int bdrv_amend_options(BlockDriverState *bs, QemuOpts *opts, |
8b13976d | 4073 | BlockDriverAmendStatusCB *status_cb, void *cb_opaque) |
6f176b48 | 4074 | { |
c282e1fd | 4075 | if (!bs->drv->bdrv_amend_options) { |
6f176b48 HR |
4076 | return -ENOTSUP; |
4077 | } | |
8b13976d | 4078 | return bs->drv->bdrv_amend_options(bs, opts, status_cb, cb_opaque); |
6f176b48 | 4079 | } |
f6186f49 | 4080 | |
b5042a36 BC |
4081 | /* This function will be called by the bdrv_recurse_is_first_non_filter method |
4082 | * of block filter and by bdrv_is_first_non_filter. | |
4083 | * It is used to test if the given bs is the candidate or recurse more in the | |
4084 | * node graph. | |
212a5a8f | 4085 | */ |
b5042a36 | 4086 | bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs, |
212a5a8f | 4087 | BlockDriverState *candidate) |
f6186f49 | 4088 | { |
b5042a36 BC |
4089 | /* return false if basic checks fails */ |
4090 | if (!bs || !bs->drv) { | |
212a5a8f | 4091 | return false; |
f6186f49 BC |
4092 | } |
4093 | ||
b5042a36 BC |
4094 | /* the code reached a non block filter driver -> check if the bs is |
4095 | * the same as the candidate. It's the recursion termination condition. | |
4096 | */ | |
4097 | if (!bs->drv->is_filter) { | |
4098 | return bs == candidate; | |
212a5a8f | 4099 | } |
b5042a36 | 4100 | /* Down this path the driver is a block filter driver */ |
212a5a8f | 4101 | |
b5042a36 BC |
4102 | /* If the block filter recursion method is defined use it to recurse down |
4103 | * the node graph. | |
4104 | */ | |
4105 | if (bs->drv->bdrv_recurse_is_first_non_filter) { | |
212a5a8f | 4106 | return bs->drv->bdrv_recurse_is_first_non_filter(bs, candidate); |
f6186f49 BC |
4107 | } |
4108 | ||
b5042a36 BC |
4109 | /* the driver is a block filter but don't allow to recurse -> return false |
4110 | */ | |
4111 | return false; | |
f6186f49 BC |
4112 | } |
4113 | ||
212a5a8f BC |
4114 | /* This function checks if the candidate is the first non filter bs down it's |
4115 | * bs chain. Since we don't have pointers to parents it explore all bs chains | |
4116 | * from the top. Some filters can choose not to pass down the recursion. | |
4117 | */ | |
4118 | bool bdrv_is_first_non_filter(BlockDriverState *candidate) | |
f6186f49 | 4119 | { |
212a5a8f BC |
4120 | BlockDriverState *bs; |
4121 | ||
4122 | /* walk down the bs forest recursively */ | |
4123 | QTAILQ_FOREACH(bs, &bdrv_states, device_list) { | |
4124 | bool perm; | |
4125 | ||
b5042a36 | 4126 | /* try to recurse in this top level bs */ |
e6dc8a1f | 4127 | perm = bdrv_recurse_is_first_non_filter(bs, candidate); |
212a5a8f BC |
4128 | |
4129 | /* candidate is the first non filter */ | |
4130 | if (perm) { | |
4131 | return true; | |
4132 | } | |
4133 | } | |
4134 | ||
4135 | return false; | |
f6186f49 | 4136 | } |
09158f00 | 4137 | |
e12f3784 WC |
4138 | BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs, |
4139 | const char *node_name, Error **errp) | |
09158f00 BC |
4140 | { |
4141 | BlockDriverState *to_replace_bs = bdrv_find_node(node_name); | |
5a7e7a0b SH |
4142 | AioContext *aio_context; |
4143 | ||
09158f00 BC |
4144 | if (!to_replace_bs) { |
4145 | error_setg(errp, "Node name '%s' not found", node_name); | |
4146 | return NULL; | |
4147 | } | |
4148 | ||
5a7e7a0b SH |
4149 | aio_context = bdrv_get_aio_context(to_replace_bs); |
4150 | aio_context_acquire(aio_context); | |
4151 | ||
09158f00 | 4152 | if (bdrv_op_is_blocked(to_replace_bs, BLOCK_OP_TYPE_REPLACE, errp)) { |
5a7e7a0b SH |
4153 | to_replace_bs = NULL; |
4154 | goto out; | |
09158f00 BC |
4155 | } |
4156 | ||
4157 | /* We don't want arbitrary node of the BDS chain to be replaced only the top | |
4158 | * most non filter in order to prevent data corruption. | |
4159 | * Another benefit is that this tests exclude backing files which are | |
4160 | * blocked by the backing blockers. | |
4161 | */ | |
e12f3784 | 4162 | if (!bdrv_recurse_is_first_non_filter(parent_bs, to_replace_bs)) { |
09158f00 | 4163 | error_setg(errp, "Only top most non filter can be replaced"); |
5a7e7a0b SH |
4164 | to_replace_bs = NULL; |
4165 | goto out; | |
09158f00 BC |
4166 | } |
4167 | ||
5a7e7a0b SH |
4168 | out: |
4169 | aio_context_release(aio_context); | |
09158f00 BC |
4170 | return to_replace_bs; |
4171 | } | |
448ad91d | 4172 | |
91af7014 HR |
4173 | static bool append_open_options(QDict *d, BlockDriverState *bs) |
4174 | { | |
4175 | const QDictEntry *entry; | |
9e700c1a | 4176 | QemuOptDesc *desc; |
260fecf1 | 4177 | BdrvChild *child; |
91af7014 | 4178 | bool found_any = false; |
260fecf1 | 4179 | const char *p; |
91af7014 HR |
4180 | |
4181 | for (entry = qdict_first(bs->options); entry; | |
4182 | entry = qdict_next(bs->options, entry)) | |
4183 | { | |
260fecf1 KW |
4184 | /* Exclude options for children */ |
4185 | QLIST_FOREACH(child, &bs->children, next) { | |
4186 | if (strstart(qdict_entry_key(entry), child->name, &p) | |
4187 | && (!*p || *p == '.')) | |
4188 | { | |
4189 | break; | |
4190 | } | |
4191 | } | |
4192 | if (child) { | |
9e700c1a | 4193 | continue; |
91af7014 | 4194 | } |
9e700c1a KW |
4195 | |
4196 | /* And exclude all non-driver-specific options */ | |
4197 | for (desc = bdrv_runtime_opts.desc; desc->name; desc++) { | |
4198 | if (!strcmp(qdict_entry_key(entry), desc->name)) { | |
4199 | break; | |
4200 | } | |
4201 | } | |
4202 | if (desc->name) { | |
4203 | continue; | |
4204 | } | |
4205 | ||
4206 | qobject_incref(qdict_entry_value(entry)); | |
4207 | qdict_put_obj(d, qdict_entry_key(entry), qdict_entry_value(entry)); | |
4208 | found_any = true; | |
91af7014 HR |
4209 | } |
4210 | ||
4211 | return found_any; | |
4212 | } | |
4213 | ||
4214 | /* Updates the following BDS fields: | |
4215 | * - exact_filename: A filename which may be used for opening a block device | |
4216 | * which (mostly) equals the given BDS (even without any | |
4217 | * other options; so reading and writing must return the same | |
4218 | * results, but caching etc. may be different) | |
4219 | * - full_open_options: Options which, when given when opening a block device | |
4220 | * (without a filename), result in a BDS (mostly) | |
4221 | * equalling the given one | |
4222 | * - filename: If exact_filename is set, it is copied here. Otherwise, | |
4223 | * full_open_options is converted to a JSON object, prefixed with | |
4224 | * "json:" (for use through the JSON pseudo protocol) and put here. | |
4225 | */ | |
4226 | void bdrv_refresh_filename(BlockDriverState *bs) | |
4227 | { | |
4228 | BlockDriver *drv = bs->drv; | |
4229 | QDict *opts; | |
4230 | ||
4231 | if (!drv) { | |
4232 | return; | |
4233 | } | |
4234 | ||
4235 | /* This BDS's file name will most probably depend on its file's name, so | |
4236 | * refresh that first */ | |
4237 | if (bs->file) { | |
9a4f4c31 | 4238 | bdrv_refresh_filename(bs->file->bs); |
91af7014 HR |
4239 | } |
4240 | ||
4241 | if (drv->bdrv_refresh_filename) { | |
4242 | /* Obsolete information is of no use here, so drop the old file name | |
4243 | * information before refreshing it */ | |
4244 | bs->exact_filename[0] = '\0'; | |
4245 | if (bs->full_open_options) { | |
4246 | QDECREF(bs->full_open_options); | |
4247 | bs->full_open_options = NULL; | |
4248 | } | |
4249 | ||
4cdd01d3 KW |
4250 | opts = qdict_new(); |
4251 | append_open_options(opts, bs); | |
4252 | drv->bdrv_refresh_filename(bs, opts); | |
4253 | QDECREF(opts); | |
91af7014 HR |
4254 | } else if (bs->file) { |
4255 | /* Try to reconstruct valid information from the underlying file */ | |
4256 | bool has_open_options; | |
4257 | ||
4258 | bs->exact_filename[0] = '\0'; | |
4259 | if (bs->full_open_options) { | |
4260 | QDECREF(bs->full_open_options); | |
4261 | bs->full_open_options = NULL; | |
4262 | } | |
4263 | ||
4264 | opts = qdict_new(); | |
4265 | has_open_options = append_open_options(opts, bs); | |
4266 | ||
4267 | /* If no specific options have been given for this BDS, the filename of | |
4268 | * the underlying file should suffice for this one as well */ | |
9a4f4c31 KW |
4269 | if (bs->file->bs->exact_filename[0] && !has_open_options) { |
4270 | strcpy(bs->exact_filename, bs->file->bs->exact_filename); | |
91af7014 HR |
4271 | } |
4272 | /* Reconstructing the full options QDict is simple for most format block | |
4273 | * drivers, as long as the full options are known for the underlying | |
4274 | * file BDS. The full options QDict of that file BDS should somehow | |
4275 | * contain a representation of the filename, therefore the following | |
4276 | * suffices without querying the (exact_)filename of this BDS. */ | |
9a4f4c31 | 4277 | if (bs->file->bs->full_open_options) { |
91af7014 HR |
4278 | qdict_put_obj(opts, "driver", |
4279 | QOBJECT(qstring_from_str(drv->format_name))); | |
9a4f4c31 KW |
4280 | QINCREF(bs->file->bs->full_open_options); |
4281 | qdict_put_obj(opts, "file", | |
4282 | QOBJECT(bs->file->bs->full_open_options)); | |
91af7014 HR |
4283 | |
4284 | bs->full_open_options = opts; | |
4285 | } else { | |
4286 | QDECREF(opts); | |
4287 | } | |
4288 | } else if (!bs->full_open_options && qdict_size(bs->options)) { | |
4289 | /* There is no underlying file BDS (at least referenced by BDS.file), | |
4290 | * so the full options QDict should be equal to the options given | |
4291 | * specifically for this block device when it was opened (plus the | |
4292 | * driver specification). | |
4293 | * Because those options don't change, there is no need to update | |
4294 | * full_open_options when it's already set. */ | |
4295 | ||
4296 | opts = qdict_new(); | |
4297 | append_open_options(opts, bs); | |
4298 | qdict_put_obj(opts, "driver", | |
4299 | QOBJECT(qstring_from_str(drv->format_name))); | |
4300 | ||
4301 | if (bs->exact_filename[0]) { | |
4302 | /* This may not work for all block protocol drivers (some may | |
4303 | * require this filename to be parsed), but we have to find some | |
4304 | * default solution here, so just include it. If some block driver | |
4305 | * does not support pure options without any filename at all or | |
4306 | * needs some special format of the options QDict, it needs to | |
4307 | * implement the driver-specific bdrv_refresh_filename() function. | |
4308 | */ | |
4309 | qdict_put_obj(opts, "filename", | |
4310 | QOBJECT(qstring_from_str(bs->exact_filename))); | |
4311 | } | |
4312 | ||
4313 | bs->full_open_options = opts; | |
4314 | } | |
4315 | ||
4316 | if (bs->exact_filename[0]) { | |
4317 | pstrcpy(bs->filename, sizeof(bs->filename), bs->exact_filename); | |
4318 | } else if (bs->full_open_options) { | |
4319 | QString *json = qobject_to_json(QOBJECT(bs->full_open_options)); | |
4320 | snprintf(bs->filename, sizeof(bs->filename), "json:%s", | |
4321 | qstring_get_str(json)); | |
4322 | QDECREF(json); | |
4323 | } | |
4324 | } |