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