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