]>
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 | ||
b5411555 KW |
710 | static char *bdrv_child_get_parent_desc(BdrvChild *c) |
711 | { | |
712 | BlockDriverState *parent = c->opaque; | |
713 | return g_strdup(bdrv_get_device_or_node_name(parent)); | |
714 | } | |
715 | ||
20018e12 KW |
716 | static void bdrv_child_cb_drained_begin(BdrvChild *child) |
717 | { | |
718 | BlockDriverState *bs = child->opaque; | |
719 | bdrv_drained_begin(bs); | |
720 | } | |
721 | ||
722 | static void bdrv_child_cb_drained_end(BdrvChild *child) | |
723 | { | |
724 | BlockDriverState *bs = child->opaque; | |
725 | bdrv_drained_end(bs); | |
726 | } | |
727 | ||
b1e6fc08 | 728 | /* |
73176bee KW |
729 | * Returns the options and flags that a temporary snapshot should get, based on |
730 | * the originally requested flags (the originally requested image will have | |
731 | * flags like a backing file) | |
b1e6fc08 | 732 | */ |
73176bee KW |
733 | static void bdrv_temp_snapshot_options(int *child_flags, QDict *child_options, |
734 | int parent_flags, QDict *parent_options) | |
b1e6fc08 | 735 | { |
73176bee KW |
736 | *child_flags = (parent_flags & ~BDRV_O_SNAPSHOT) | BDRV_O_TEMPORARY; |
737 | ||
738 | /* For temporary files, unconditional cache=unsafe is fine */ | |
73176bee KW |
739 | qdict_set_default_str(child_options, BDRV_OPT_CACHE_DIRECT, "off"); |
740 | qdict_set_default_str(child_options, BDRV_OPT_CACHE_NO_FLUSH, "on"); | |
41869044 | 741 | |
f87a0e29 AG |
742 | /* Copy the read-only option from the parent */ |
743 | qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY); | |
744 | ||
41869044 KW |
745 | /* aio=native doesn't work for cache.direct=off, so disable it for the |
746 | * temporary snapshot */ | |
747 | *child_flags &= ~BDRV_O_NATIVE_AIO; | |
b1e6fc08 KW |
748 | } |
749 | ||
0b50cc88 | 750 | /* |
8e2160e2 KW |
751 | * Returns the options and flags that bs->file should get if a protocol driver |
752 | * is expected, based on the given options and flags for the parent BDS | |
0b50cc88 | 753 | */ |
8e2160e2 KW |
754 | static void bdrv_inherited_options(int *child_flags, QDict *child_options, |
755 | int parent_flags, QDict *parent_options) | |
0b50cc88 | 756 | { |
8e2160e2 KW |
757 | int flags = parent_flags; |
758 | ||
0b50cc88 KW |
759 | /* Enable protocol handling, disable format probing for bs->file */ |
760 | flags |= BDRV_O_PROTOCOL; | |
761 | ||
91a097e7 KW |
762 | /* If the cache mode isn't explicitly set, inherit direct and no-flush from |
763 | * the parent. */ | |
764 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT); | |
765 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH); | |
766 | ||
f87a0e29 AG |
767 | /* Inherit the read-only option from the parent if it's not set */ |
768 | qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY); | |
769 | ||
0b50cc88 | 770 | /* Our block drivers take care to send flushes and respect unmap policy, |
91a097e7 KW |
771 | * so we can default to enable both on lower layers regardless of the |
772 | * corresponding parent options. */ | |
818584a4 | 773 | qdict_set_default_str(child_options, BDRV_OPT_DISCARD, "unmap"); |
0b50cc88 | 774 | |
0b50cc88 | 775 | /* Clear flags that only apply to the top layer */ |
abb06c5a DB |
776 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ | |
777 | BDRV_O_NO_IO); | |
0b50cc88 | 778 | |
8e2160e2 | 779 | *child_flags = flags; |
0b50cc88 KW |
780 | } |
781 | ||
f3930ed0 | 782 | const BdrvChildRole child_file = { |
b5411555 | 783 | .get_parent_desc = bdrv_child_get_parent_desc, |
8e2160e2 | 784 | .inherit_options = bdrv_inherited_options, |
20018e12 KW |
785 | .drained_begin = bdrv_child_cb_drained_begin, |
786 | .drained_end = bdrv_child_cb_drained_end, | |
f3930ed0 KW |
787 | }; |
788 | ||
789 | /* | |
8e2160e2 KW |
790 | * Returns the options and flags that bs->file should get if the use of formats |
791 | * (and not only protocols) is permitted for it, based on the given options and | |
792 | * flags for the parent BDS | |
f3930ed0 | 793 | */ |
8e2160e2 KW |
794 | static void bdrv_inherited_fmt_options(int *child_flags, QDict *child_options, |
795 | int parent_flags, QDict *parent_options) | |
f3930ed0 | 796 | { |
8e2160e2 KW |
797 | child_file.inherit_options(child_flags, child_options, |
798 | parent_flags, parent_options); | |
799 | ||
abb06c5a | 800 | *child_flags &= ~(BDRV_O_PROTOCOL | BDRV_O_NO_IO); |
f3930ed0 KW |
801 | } |
802 | ||
803 | const BdrvChildRole child_format = { | |
b5411555 | 804 | .get_parent_desc = bdrv_child_get_parent_desc, |
8e2160e2 | 805 | .inherit_options = bdrv_inherited_fmt_options, |
20018e12 KW |
806 | .drained_begin = bdrv_child_cb_drained_begin, |
807 | .drained_end = bdrv_child_cb_drained_end, | |
f3930ed0 KW |
808 | }; |
809 | ||
db95dbba KW |
810 | static void bdrv_backing_attach(BdrvChild *c) |
811 | { | |
812 | BlockDriverState *parent = c->opaque; | |
813 | BlockDriverState *backing_hd = c->bs; | |
814 | ||
815 | assert(!parent->backing_blocker); | |
816 | error_setg(&parent->backing_blocker, | |
817 | "node is used as backing hd of '%s'", | |
818 | bdrv_get_device_or_node_name(parent)); | |
819 | ||
820 | parent->open_flags &= ~BDRV_O_NO_BACKING; | |
821 | pstrcpy(parent->backing_file, sizeof(parent->backing_file), | |
822 | backing_hd->filename); | |
823 | pstrcpy(parent->backing_format, sizeof(parent->backing_format), | |
824 | backing_hd->drv ? backing_hd->drv->format_name : ""); | |
825 | ||
826 | bdrv_op_block_all(backing_hd, parent->backing_blocker); | |
827 | /* Otherwise we won't be able to commit or stream */ | |
828 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_COMMIT_TARGET, | |
829 | parent->backing_blocker); | |
830 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_STREAM, | |
831 | parent->backing_blocker); | |
832 | /* | |
833 | * We do backup in 3 ways: | |
834 | * 1. drive backup | |
835 | * The target bs is new opened, and the source is top BDS | |
836 | * 2. blockdev backup | |
837 | * Both the source and the target are top BDSes. | |
838 | * 3. internal backup(used for block replication) | |
839 | * Both the source and the target are backing file | |
840 | * | |
841 | * In case 1 and 2, neither the source nor the target is the backing file. | |
842 | * In case 3, we will block the top BDS, so there is only one block job | |
843 | * for the top BDS and its backing chain. | |
844 | */ | |
845 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_SOURCE, | |
846 | parent->backing_blocker); | |
847 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_TARGET, | |
848 | parent->backing_blocker); | |
849 | } | |
850 | ||
851 | static void bdrv_backing_detach(BdrvChild *c) | |
852 | { | |
853 | BlockDriverState *parent = c->opaque; | |
854 | ||
855 | assert(parent->backing_blocker); | |
856 | bdrv_op_unblock_all(c->bs, parent->backing_blocker); | |
857 | error_free(parent->backing_blocker); | |
858 | parent->backing_blocker = NULL; | |
859 | } | |
860 | ||
317fc44e | 861 | /* |
8e2160e2 KW |
862 | * Returns the options and flags that bs->backing should get, based on the |
863 | * given options and flags for the parent BDS | |
317fc44e | 864 | */ |
8e2160e2 KW |
865 | static void bdrv_backing_options(int *child_flags, QDict *child_options, |
866 | int parent_flags, QDict *parent_options) | |
317fc44e | 867 | { |
8e2160e2 KW |
868 | int flags = parent_flags; |
869 | ||
b8816a43 KW |
870 | /* The cache mode is inherited unmodified for backing files; except WCE, |
871 | * which is only applied on the top level (BlockBackend) */ | |
91a097e7 KW |
872 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT); |
873 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH); | |
874 | ||
317fc44e | 875 | /* backing files always opened read-only */ |
f87a0e29 AG |
876 | qdict_set_default_str(child_options, BDRV_OPT_READ_ONLY, "on"); |
877 | flags &= ~BDRV_O_COPY_ON_READ; | |
317fc44e KW |
878 | |
879 | /* snapshot=on is handled on the top layer */ | |
8bfea15d | 880 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_TEMPORARY); |
317fc44e | 881 | |
8e2160e2 | 882 | *child_flags = flags; |
317fc44e KW |
883 | } |
884 | ||
91ef3825 | 885 | const BdrvChildRole child_backing = { |
b5411555 | 886 | .get_parent_desc = bdrv_child_get_parent_desc, |
db95dbba KW |
887 | .attach = bdrv_backing_attach, |
888 | .detach = bdrv_backing_detach, | |
8e2160e2 | 889 | .inherit_options = bdrv_backing_options, |
20018e12 KW |
890 | .drained_begin = bdrv_child_cb_drained_begin, |
891 | .drained_end = bdrv_child_cb_drained_end, | |
f3930ed0 KW |
892 | }; |
893 | ||
7b272452 KW |
894 | static int bdrv_open_flags(BlockDriverState *bs, int flags) |
895 | { | |
61de4c68 | 896 | int open_flags = flags; |
7b272452 KW |
897 | |
898 | /* | |
899 | * Clear flags that are internal to the block layer before opening the | |
900 | * image. | |
901 | */ | |
20cca275 | 902 | open_flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_PROTOCOL); |
7b272452 KW |
903 | |
904 | /* | |
905 | * Snapshots should be writable. | |
906 | */ | |
8bfea15d | 907 | if (flags & BDRV_O_TEMPORARY) { |
7b272452 KW |
908 | open_flags |= BDRV_O_RDWR; |
909 | } | |
910 | ||
911 | return open_flags; | |
912 | } | |
913 | ||
91a097e7 KW |
914 | static void update_flags_from_options(int *flags, QemuOpts *opts) |
915 | { | |
916 | *flags &= ~BDRV_O_CACHE_MASK; | |
917 | ||
91a097e7 KW |
918 | assert(qemu_opt_find(opts, BDRV_OPT_CACHE_NO_FLUSH)); |
919 | if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_NO_FLUSH, false)) { | |
920 | *flags |= BDRV_O_NO_FLUSH; | |
921 | } | |
922 | ||
923 | assert(qemu_opt_find(opts, BDRV_OPT_CACHE_DIRECT)); | |
924 | if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_DIRECT, false)) { | |
925 | *flags |= BDRV_O_NOCACHE; | |
926 | } | |
f87a0e29 AG |
927 | |
928 | *flags &= ~BDRV_O_RDWR; | |
929 | ||
930 | assert(qemu_opt_find(opts, BDRV_OPT_READ_ONLY)); | |
931 | if (!qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false)) { | |
932 | *flags |= BDRV_O_RDWR; | |
933 | } | |
934 | ||
91a097e7 KW |
935 | } |
936 | ||
937 | static void update_options_from_flags(QDict *options, int flags) | |
938 | { | |
91a097e7 KW |
939 | if (!qdict_haskey(options, BDRV_OPT_CACHE_DIRECT)) { |
940 | qdict_put(options, BDRV_OPT_CACHE_DIRECT, | |
941 | qbool_from_bool(flags & BDRV_O_NOCACHE)); | |
942 | } | |
943 | if (!qdict_haskey(options, BDRV_OPT_CACHE_NO_FLUSH)) { | |
944 | qdict_put(options, BDRV_OPT_CACHE_NO_FLUSH, | |
945 | qbool_from_bool(flags & BDRV_O_NO_FLUSH)); | |
946 | } | |
f87a0e29 AG |
947 | if (!qdict_haskey(options, BDRV_OPT_READ_ONLY)) { |
948 | qdict_put(options, BDRV_OPT_READ_ONLY, | |
949 | qbool_from_bool(!(flags & BDRV_O_RDWR))); | |
950 | } | |
91a097e7 KW |
951 | } |
952 | ||
636ea370 KW |
953 | static void bdrv_assign_node_name(BlockDriverState *bs, |
954 | const char *node_name, | |
955 | Error **errp) | |
6913c0c2 | 956 | { |
15489c76 | 957 | char *gen_node_name = NULL; |
6913c0c2 | 958 | |
15489c76 JC |
959 | if (!node_name) { |
960 | node_name = gen_node_name = id_generate(ID_BLOCK); | |
961 | } else if (!id_wellformed(node_name)) { | |
962 | /* | |
963 | * Check for empty string or invalid characters, but not if it is | |
964 | * generated (generated names use characters not available to the user) | |
965 | */ | |
9aebf3b8 | 966 | error_setg(errp, "Invalid node name"); |
636ea370 | 967 | return; |
6913c0c2 BC |
968 | } |
969 | ||
0c5e94ee | 970 | /* takes care of avoiding namespaces collisions */ |
7f06d47e | 971 | if (blk_by_name(node_name)) { |
0c5e94ee BC |
972 | error_setg(errp, "node-name=%s is conflicting with a device id", |
973 | node_name); | |
15489c76 | 974 | goto out; |
0c5e94ee BC |
975 | } |
976 | ||
6913c0c2 BC |
977 | /* takes care of avoiding duplicates node names */ |
978 | if (bdrv_find_node(node_name)) { | |
979 | error_setg(errp, "Duplicate node name"); | |
15489c76 | 980 | goto out; |
6913c0c2 BC |
981 | } |
982 | ||
983 | /* copy node name into the bs and insert it into the graph list */ | |
984 | pstrcpy(bs->node_name, sizeof(bs->node_name), node_name); | |
985 | QTAILQ_INSERT_TAIL(&graph_bdrv_states, bs, node_list); | |
15489c76 JC |
986 | out: |
987 | g_free(gen_node_name); | |
6913c0c2 BC |
988 | } |
989 | ||
01a56501 KW |
990 | static int bdrv_open_driver(BlockDriverState *bs, BlockDriver *drv, |
991 | const char *node_name, QDict *options, | |
992 | int open_flags, Error **errp) | |
993 | { | |
994 | Error *local_err = NULL; | |
995 | int ret; | |
996 | ||
997 | bdrv_assign_node_name(bs, node_name, &local_err); | |
998 | if (local_err) { | |
999 | error_propagate(errp, local_err); | |
1000 | return -EINVAL; | |
1001 | } | |
1002 | ||
1003 | bs->drv = drv; | |
680c7f96 | 1004 | bs->read_only = !(bs->open_flags & BDRV_O_RDWR); |
01a56501 KW |
1005 | bs->opaque = g_malloc0(drv->instance_size); |
1006 | ||
1007 | if (drv->bdrv_file_open) { | |
1008 | assert(!drv->bdrv_needs_filename || bs->filename[0]); | |
1009 | ret = drv->bdrv_file_open(bs, options, open_flags, &local_err); | |
680c7f96 | 1010 | } else if (drv->bdrv_open) { |
01a56501 | 1011 | ret = drv->bdrv_open(bs, options, open_flags, &local_err); |
680c7f96 KW |
1012 | } else { |
1013 | ret = 0; | |
01a56501 KW |
1014 | } |
1015 | ||
1016 | if (ret < 0) { | |
1017 | if (local_err) { | |
1018 | error_propagate(errp, local_err); | |
1019 | } else if (bs->filename[0]) { | |
1020 | error_setg_errno(errp, -ret, "Could not open '%s'", bs->filename); | |
1021 | } else { | |
1022 | error_setg_errno(errp, -ret, "Could not open image"); | |
1023 | } | |
1024 | goto free_and_fail; | |
1025 | } | |
1026 | ||
1027 | ret = refresh_total_sectors(bs, bs->total_sectors); | |
1028 | if (ret < 0) { | |
1029 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); | |
1030 | goto free_and_fail; | |
1031 | } | |
1032 | ||
1033 | bdrv_refresh_limits(bs, &local_err); | |
1034 | if (local_err) { | |
1035 | error_propagate(errp, local_err); | |
1036 | ret = -EINVAL; | |
1037 | goto free_and_fail; | |
1038 | } | |
1039 | ||
1040 | assert(bdrv_opt_mem_align(bs) != 0); | |
1041 | assert(bdrv_min_mem_align(bs) != 0); | |
1042 | assert(is_power_of_2(bs->bl.request_alignment)); | |
1043 | ||
1044 | return 0; | |
1045 | ||
1046 | free_and_fail: | |
1047 | /* FIXME Close bs first if already opened*/ | |
1048 | g_free(bs->opaque); | |
1049 | bs->opaque = NULL; | |
1050 | bs->drv = NULL; | |
1051 | return ret; | |
1052 | } | |
1053 | ||
680c7f96 KW |
1054 | BlockDriverState *bdrv_new_open_driver(BlockDriver *drv, const char *node_name, |
1055 | int flags, Error **errp) | |
1056 | { | |
1057 | BlockDriverState *bs; | |
1058 | int ret; | |
1059 | ||
1060 | bs = bdrv_new(); | |
1061 | bs->open_flags = flags; | |
1062 | bs->explicit_options = qdict_new(); | |
1063 | bs->options = qdict_new(); | |
1064 | bs->opaque = NULL; | |
1065 | ||
1066 | update_options_from_flags(bs->options, flags); | |
1067 | ||
1068 | ret = bdrv_open_driver(bs, drv, node_name, bs->options, flags, errp); | |
1069 | if (ret < 0) { | |
1070 | QDECREF(bs->explicit_options); | |
1071 | QDECREF(bs->options); | |
1072 | bdrv_unref(bs); | |
1073 | return NULL; | |
1074 | } | |
1075 | ||
1076 | return bs; | |
1077 | } | |
1078 | ||
c5f3014b | 1079 | QemuOptsList bdrv_runtime_opts = { |
18edf289 KW |
1080 | .name = "bdrv_common", |
1081 | .head = QTAILQ_HEAD_INITIALIZER(bdrv_runtime_opts.head), | |
1082 | .desc = { | |
1083 | { | |
1084 | .name = "node-name", | |
1085 | .type = QEMU_OPT_STRING, | |
1086 | .help = "Node name of the block device node", | |
1087 | }, | |
62392ebb KW |
1088 | { |
1089 | .name = "driver", | |
1090 | .type = QEMU_OPT_STRING, | |
1091 | .help = "Block driver to use for the node", | |
1092 | }, | |
91a097e7 KW |
1093 | { |
1094 | .name = BDRV_OPT_CACHE_DIRECT, | |
1095 | .type = QEMU_OPT_BOOL, | |
1096 | .help = "Bypass software writeback cache on the host", | |
1097 | }, | |
1098 | { | |
1099 | .name = BDRV_OPT_CACHE_NO_FLUSH, | |
1100 | .type = QEMU_OPT_BOOL, | |
1101 | .help = "Ignore flush requests", | |
1102 | }, | |
f87a0e29 AG |
1103 | { |
1104 | .name = BDRV_OPT_READ_ONLY, | |
1105 | .type = QEMU_OPT_BOOL, | |
1106 | .help = "Node is opened in read-only mode", | |
1107 | }, | |
692e01a2 KW |
1108 | { |
1109 | .name = "detect-zeroes", | |
1110 | .type = QEMU_OPT_STRING, | |
1111 | .help = "try to optimize zero writes (off, on, unmap)", | |
1112 | }, | |
818584a4 KW |
1113 | { |
1114 | .name = "discard", | |
1115 | .type = QEMU_OPT_STRING, | |
1116 | .help = "discard operation (ignore/off, unmap/on)", | |
1117 | }, | |
18edf289 KW |
1118 | { /* end of list */ } |
1119 | }, | |
1120 | }; | |
1121 | ||
57915332 KW |
1122 | /* |
1123 | * Common part for opening disk images and files | |
b6ad491a KW |
1124 | * |
1125 | * Removes all processed options from *options. | |
57915332 | 1126 | */ |
5696c6e3 | 1127 | static int bdrv_open_common(BlockDriverState *bs, BlockBackend *file, |
82dc8b41 | 1128 | QDict *options, Error **errp) |
57915332 KW |
1129 | { |
1130 | int ret, open_flags; | |
035fccdf | 1131 | const char *filename; |
62392ebb | 1132 | const char *driver_name = NULL; |
6913c0c2 | 1133 | const char *node_name = NULL; |
818584a4 | 1134 | const char *discard; |
692e01a2 | 1135 | const char *detect_zeroes; |
18edf289 | 1136 | QemuOpts *opts; |
62392ebb | 1137 | BlockDriver *drv; |
34b5d2c6 | 1138 | Error *local_err = NULL; |
57915332 | 1139 | |
6405875c | 1140 | assert(bs->file == NULL); |
707ff828 | 1141 | assert(options != NULL && bs->options != options); |
57915332 | 1142 | |
62392ebb KW |
1143 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); |
1144 | qemu_opts_absorb_qdict(opts, options, &local_err); | |
1145 | if (local_err) { | |
1146 | error_propagate(errp, local_err); | |
1147 | ret = -EINVAL; | |
1148 | goto fail_opts; | |
1149 | } | |
1150 | ||
9b7e8691 AG |
1151 | update_flags_from_options(&bs->open_flags, opts); |
1152 | ||
62392ebb KW |
1153 | driver_name = qemu_opt_get(opts, "driver"); |
1154 | drv = bdrv_find_format(driver_name); | |
1155 | assert(drv != NULL); | |
1156 | ||
45673671 | 1157 | if (file != NULL) { |
5696c6e3 | 1158 | filename = blk_bs(file)->filename; |
45673671 | 1159 | } else { |
129c7d1c MA |
1160 | /* |
1161 | * Caution: while qdict_get_try_str() is fine, getting | |
1162 | * non-string types would require more care. When @options | |
1163 | * come from -blockdev or blockdev_add, its members are typed | |
1164 | * according to the QAPI schema, but when they come from | |
1165 | * -drive, they're all QString. | |
1166 | */ | |
45673671 KW |
1167 | filename = qdict_get_try_str(options, "filename"); |
1168 | } | |
1169 | ||
765003db KW |
1170 | if (drv->bdrv_needs_filename && !filename) { |
1171 | error_setg(errp, "The '%s' block driver requires a file name", | |
1172 | drv->format_name); | |
18edf289 KW |
1173 | ret = -EINVAL; |
1174 | goto fail_opts; | |
6913c0c2 | 1175 | } |
6913c0c2 | 1176 | |
82dc8b41 KW |
1177 | trace_bdrv_open_common(bs, filename ?: "", bs->open_flags, |
1178 | drv->format_name); | |
62392ebb | 1179 | |
82dc8b41 | 1180 | bs->read_only = !(bs->open_flags & BDRV_O_RDWR); |
b64ec4e4 FZ |
1181 | |
1182 | if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv, bs->read_only)) { | |
8f94a6e4 KW |
1183 | error_setg(errp, |
1184 | !bs->read_only && bdrv_is_whitelisted(drv, true) | |
1185 | ? "Driver '%s' can only be used for read-only devices" | |
1186 | : "Driver '%s' is not whitelisted", | |
1187 | drv->format_name); | |
18edf289 KW |
1188 | ret = -ENOTSUP; |
1189 | goto fail_opts; | |
b64ec4e4 | 1190 | } |
57915332 | 1191 | |
53fec9d3 | 1192 | assert(bs->copy_on_read == 0); /* bdrv_new() and bdrv_close() make it so */ |
82dc8b41 | 1193 | if (bs->open_flags & BDRV_O_COPY_ON_READ) { |
0ebd24e0 KW |
1194 | if (!bs->read_only) { |
1195 | bdrv_enable_copy_on_read(bs); | |
1196 | } else { | |
1197 | error_setg(errp, "Can't use copy-on-read on read-only device"); | |
18edf289 KW |
1198 | ret = -EINVAL; |
1199 | goto fail_opts; | |
0ebd24e0 | 1200 | } |
53fec9d3 SH |
1201 | } |
1202 | ||
818584a4 KW |
1203 | discard = qemu_opt_get(opts, "discard"); |
1204 | if (discard != NULL) { | |
1205 | if (bdrv_parse_discard_flags(discard, &bs->open_flags) != 0) { | |
1206 | error_setg(errp, "Invalid discard option"); | |
1207 | ret = -EINVAL; | |
1208 | goto fail_opts; | |
1209 | } | |
1210 | } | |
1211 | ||
692e01a2 KW |
1212 | detect_zeroes = qemu_opt_get(opts, "detect-zeroes"); |
1213 | if (detect_zeroes) { | |
1214 | BlockdevDetectZeroesOptions value = | |
1215 | qapi_enum_parse(BlockdevDetectZeroesOptions_lookup, | |
1216 | detect_zeroes, | |
1217 | BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX, | |
1218 | BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF, | |
1219 | &local_err); | |
1220 | if (local_err) { | |
1221 | error_propagate(errp, local_err); | |
1222 | ret = -EINVAL; | |
1223 | goto fail_opts; | |
1224 | } | |
1225 | ||
1226 | if (value == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP && | |
1227 | !(bs->open_flags & BDRV_O_UNMAP)) | |
1228 | { | |
1229 | error_setg(errp, "setting detect-zeroes to unmap is not allowed " | |
1230 | "without setting discard operation to unmap"); | |
1231 | ret = -EINVAL; | |
1232 | goto fail_opts; | |
1233 | } | |
1234 | ||
1235 | bs->detect_zeroes = value; | |
1236 | } | |
1237 | ||
c2ad1b0c KW |
1238 | if (filename != NULL) { |
1239 | pstrcpy(bs->filename, sizeof(bs->filename), filename); | |
1240 | } else { | |
1241 | bs->filename[0] = '\0'; | |
1242 | } | |
91af7014 | 1243 | pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), bs->filename); |
57915332 | 1244 | |
66f82cee | 1245 | /* Open the image, either directly or using a protocol */ |
82dc8b41 | 1246 | open_flags = bdrv_open_flags(bs, bs->open_flags); |
01a56501 | 1247 | node_name = qemu_opt_get(opts, "node-name"); |
57915332 | 1248 | |
01a56501 KW |
1249 | assert(!drv->bdrv_file_open || file == NULL); |
1250 | ret = bdrv_open_driver(bs, drv, node_name, options, open_flags, errp); | |
51762288 | 1251 | if (ret < 0) { |
01a56501 | 1252 | goto fail_opts; |
3baca891 KW |
1253 | } |
1254 | ||
18edf289 | 1255 | qemu_opts_del(opts); |
57915332 KW |
1256 | return 0; |
1257 | ||
18edf289 KW |
1258 | fail_opts: |
1259 | qemu_opts_del(opts); | |
57915332 KW |
1260 | return ret; |
1261 | } | |
1262 | ||
5e5c4f63 KW |
1263 | static QDict *parse_json_filename(const char *filename, Error **errp) |
1264 | { | |
1265 | QObject *options_obj; | |
1266 | QDict *options; | |
1267 | int ret; | |
1268 | ||
1269 | ret = strstart(filename, "json:", &filename); | |
1270 | assert(ret); | |
1271 | ||
5577fff7 | 1272 | options_obj = qobject_from_json(filename, errp); |
5e5c4f63 | 1273 | if (!options_obj) { |
5577fff7 MA |
1274 | /* Work around qobject_from_json() lossage TODO fix that */ |
1275 | if (errp && !*errp) { | |
1276 | error_setg(errp, "Could not parse the JSON options"); | |
1277 | return NULL; | |
1278 | } | |
1279 | error_prepend(errp, "Could not parse the JSON options: "); | |
5e5c4f63 KW |
1280 | return NULL; |
1281 | } | |
1282 | ||
ca6b6e1e MA |
1283 | options = qobject_to_qdict(options_obj); |
1284 | if (!options) { | |
5e5c4f63 KW |
1285 | qobject_decref(options_obj); |
1286 | error_setg(errp, "Invalid JSON object given"); | |
1287 | return NULL; | |
1288 | } | |
1289 | ||
5e5c4f63 KW |
1290 | qdict_flatten(options); |
1291 | ||
1292 | return options; | |
1293 | } | |
1294 | ||
de3b53f0 KW |
1295 | static void parse_json_protocol(QDict *options, const char **pfilename, |
1296 | Error **errp) | |
1297 | { | |
1298 | QDict *json_options; | |
1299 | Error *local_err = NULL; | |
1300 | ||
1301 | /* Parse json: pseudo-protocol */ | |
1302 | if (!*pfilename || !g_str_has_prefix(*pfilename, "json:")) { | |
1303 | return; | |
1304 | } | |
1305 | ||
1306 | json_options = parse_json_filename(*pfilename, &local_err); | |
1307 | if (local_err) { | |
1308 | error_propagate(errp, local_err); | |
1309 | return; | |
1310 | } | |
1311 | ||
1312 | /* Options given in the filename have lower priority than options | |
1313 | * specified directly */ | |
1314 | qdict_join(options, json_options, false); | |
1315 | QDECREF(json_options); | |
1316 | *pfilename = NULL; | |
1317 | } | |
1318 | ||
b6ce07aa | 1319 | /* |
f54120ff KW |
1320 | * Fills in default options for opening images and converts the legacy |
1321 | * filename/flags pair to option QDict entries. | |
53a29513 HR |
1322 | * The BDRV_O_PROTOCOL flag in *flags will be set or cleared accordingly if a |
1323 | * block driver has been specified explicitly. | |
b6ce07aa | 1324 | */ |
de3b53f0 | 1325 | static int bdrv_fill_options(QDict **options, const char *filename, |
053e1578 | 1326 | int *flags, Error **errp) |
ea2384d3 | 1327 | { |
c2ad1b0c | 1328 | const char *drvname; |
53a29513 | 1329 | bool protocol = *flags & BDRV_O_PROTOCOL; |
e3fa4bfa | 1330 | bool parse_filename = false; |
053e1578 | 1331 | BlockDriver *drv = NULL; |
34b5d2c6 | 1332 | Error *local_err = NULL; |
83f64091 | 1333 | |
129c7d1c MA |
1334 | /* |
1335 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
1336 | * types would require more care. When @options come from | |
1337 | * -blockdev or blockdev_add, its members are typed according to | |
1338 | * the QAPI schema, but when they come from -drive, they're all | |
1339 | * QString. | |
1340 | */ | |
53a29513 | 1341 | drvname = qdict_get_try_str(*options, "driver"); |
053e1578 HR |
1342 | if (drvname) { |
1343 | drv = bdrv_find_format(drvname); | |
1344 | if (!drv) { | |
1345 | error_setg(errp, "Unknown driver '%s'", drvname); | |
1346 | return -ENOENT; | |
1347 | } | |
1348 | /* If the user has explicitly specified the driver, this choice should | |
1349 | * override the BDRV_O_PROTOCOL flag */ | |
1350 | protocol = drv->bdrv_file_open; | |
53a29513 HR |
1351 | } |
1352 | ||
1353 | if (protocol) { | |
1354 | *flags |= BDRV_O_PROTOCOL; | |
1355 | } else { | |
1356 | *flags &= ~BDRV_O_PROTOCOL; | |
1357 | } | |
1358 | ||
91a097e7 KW |
1359 | /* Translate cache options from flags into options */ |
1360 | update_options_from_flags(*options, *flags); | |
1361 | ||
035fccdf | 1362 | /* Fetch the file name from the options QDict if necessary */ |
17b005f1 | 1363 | if (protocol && filename) { |
f54120ff KW |
1364 | if (!qdict_haskey(*options, "filename")) { |
1365 | qdict_put(*options, "filename", qstring_from_str(filename)); | |
1366 | parse_filename = true; | |
1367 | } else { | |
1368 | error_setg(errp, "Can't specify 'file' and 'filename' options at " | |
1369 | "the same time"); | |
1370 | return -EINVAL; | |
1371 | } | |
035fccdf KW |
1372 | } |
1373 | ||
c2ad1b0c | 1374 | /* Find the right block driver */ |
129c7d1c | 1375 | /* See cautionary note on accessing @options above */ |
f54120ff | 1376 | filename = qdict_get_try_str(*options, "filename"); |
f54120ff | 1377 | |
053e1578 HR |
1378 | if (!drvname && protocol) { |
1379 | if (filename) { | |
1380 | drv = bdrv_find_protocol(filename, parse_filename, errp); | |
17b005f1 | 1381 | if (!drv) { |
053e1578 | 1382 | return -EINVAL; |
17b005f1 | 1383 | } |
053e1578 HR |
1384 | |
1385 | drvname = drv->format_name; | |
1386 | qdict_put(*options, "driver", qstring_from_str(drvname)); | |
1387 | } else { | |
1388 | error_setg(errp, "Must specify either driver or file"); | |
1389 | return -EINVAL; | |
98289620 | 1390 | } |
c2ad1b0c KW |
1391 | } |
1392 | ||
17b005f1 | 1393 | assert(drv || !protocol); |
c2ad1b0c | 1394 | |
f54120ff | 1395 | /* Driver-specific filename parsing */ |
17b005f1 | 1396 | if (drv && drv->bdrv_parse_filename && parse_filename) { |
5acd9d81 | 1397 | drv->bdrv_parse_filename(filename, *options, &local_err); |
84d18f06 | 1398 | if (local_err) { |
34b5d2c6 | 1399 | error_propagate(errp, local_err); |
f54120ff | 1400 | return -EINVAL; |
6963a30d | 1401 | } |
cd5d031e HR |
1402 | |
1403 | if (!drv->bdrv_needs_filename) { | |
1404 | qdict_del(*options, "filename"); | |
cd5d031e | 1405 | } |
6963a30d KW |
1406 | } |
1407 | ||
f54120ff KW |
1408 | return 0; |
1409 | } | |
1410 | ||
c1cef672 FZ |
1411 | static int bdrv_child_check_perm(BdrvChild *c, uint64_t perm, uint64_t shared, |
1412 | GSList *ignore_children, Error **errp); | |
1413 | static void bdrv_child_abort_perm_update(BdrvChild *c); | |
1414 | static void bdrv_child_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared); | |
1415 | ||
33a610c3 KW |
1416 | /* |
1417 | * Check whether permissions on this node can be changed in a way that | |
1418 | * @cumulative_perms and @cumulative_shared_perms are the new cumulative | |
1419 | * permissions of all its parents. This involves checking whether all necessary | |
1420 | * permission changes to child nodes can be performed. | |
1421 | * | |
1422 | * A call to this function must always be followed by a call to bdrv_set_perm() | |
1423 | * or bdrv_abort_perm_update(). | |
1424 | */ | |
1425 | static int bdrv_check_perm(BlockDriverState *bs, uint64_t cumulative_perms, | |
46181129 KW |
1426 | uint64_t cumulative_shared_perms, |
1427 | GSList *ignore_children, Error **errp) | |
33a610c3 KW |
1428 | { |
1429 | BlockDriver *drv = bs->drv; | |
1430 | BdrvChild *c; | |
1431 | int ret; | |
1432 | ||
1433 | /* Write permissions never work with read-only images */ | |
1434 | if ((cumulative_perms & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED)) && | |
1435 | bdrv_is_read_only(bs)) | |
1436 | { | |
1437 | error_setg(errp, "Block node is read-only"); | |
1438 | return -EPERM; | |
1439 | } | |
1440 | ||
1441 | /* Check this node */ | |
1442 | if (!drv) { | |
1443 | return 0; | |
1444 | } | |
1445 | ||
1446 | if (drv->bdrv_check_perm) { | |
1447 | return drv->bdrv_check_perm(bs, cumulative_perms, | |
1448 | cumulative_shared_perms, errp); | |
1449 | } | |
1450 | ||
78e421c9 | 1451 | /* Drivers that never have children can omit .bdrv_child_perm() */ |
33a610c3 | 1452 | if (!drv->bdrv_child_perm) { |
78e421c9 | 1453 | assert(QLIST_EMPTY(&bs->children)); |
33a610c3 KW |
1454 | return 0; |
1455 | } | |
1456 | ||
1457 | /* Check all children */ | |
1458 | QLIST_FOREACH(c, &bs->children, next) { | |
1459 | uint64_t cur_perm, cur_shared; | |
1460 | drv->bdrv_child_perm(bs, c, c->role, | |
1461 | cumulative_perms, cumulative_shared_perms, | |
1462 | &cur_perm, &cur_shared); | |
46181129 KW |
1463 | ret = bdrv_child_check_perm(c, cur_perm, cur_shared, ignore_children, |
1464 | errp); | |
33a610c3 KW |
1465 | if (ret < 0) { |
1466 | return ret; | |
1467 | } | |
1468 | } | |
1469 | ||
1470 | return 0; | |
1471 | } | |
1472 | ||
1473 | /* | |
1474 | * Notifies drivers that after a previous bdrv_check_perm() call, the | |
1475 | * permission update is not performed and any preparations made for it (e.g. | |
1476 | * taken file locks) need to be undone. | |
1477 | * | |
1478 | * This function recursively notifies all child nodes. | |
1479 | */ | |
1480 | static void bdrv_abort_perm_update(BlockDriverState *bs) | |
1481 | { | |
1482 | BlockDriver *drv = bs->drv; | |
1483 | BdrvChild *c; | |
1484 | ||
1485 | if (!drv) { | |
1486 | return; | |
1487 | } | |
1488 | ||
1489 | if (drv->bdrv_abort_perm_update) { | |
1490 | drv->bdrv_abort_perm_update(bs); | |
1491 | } | |
1492 | ||
1493 | QLIST_FOREACH(c, &bs->children, next) { | |
1494 | bdrv_child_abort_perm_update(c); | |
1495 | } | |
1496 | } | |
1497 | ||
1498 | static void bdrv_set_perm(BlockDriverState *bs, uint64_t cumulative_perms, | |
1499 | uint64_t cumulative_shared_perms) | |
1500 | { | |
1501 | BlockDriver *drv = bs->drv; | |
1502 | BdrvChild *c; | |
1503 | ||
1504 | if (!drv) { | |
1505 | return; | |
1506 | } | |
1507 | ||
1508 | /* Update this node */ | |
1509 | if (drv->bdrv_set_perm) { | |
1510 | drv->bdrv_set_perm(bs, cumulative_perms, cumulative_shared_perms); | |
1511 | } | |
1512 | ||
78e421c9 | 1513 | /* Drivers that never have children can omit .bdrv_child_perm() */ |
33a610c3 | 1514 | if (!drv->bdrv_child_perm) { |
78e421c9 | 1515 | assert(QLIST_EMPTY(&bs->children)); |
33a610c3 KW |
1516 | return; |
1517 | } | |
1518 | ||
1519 | /* Update all children */ | |
1520 | QLIST_FOREACH(c, &bs->children, next) { | |
1521 | uint64_t cur_perm, cur_shared; | |
1522 | drv->bdrv_child_perm(bs, c, c->role, | |
1523 | cumulative_perms, cumulative_shared_perms, | |
1524 | &cur_perm, &cur_shared); | |
1525 | bdrv_child_set_perm(c, cur_perm, cur_shared); | |
1526 | } | |
1527 | } | |
1528 | ||
1529 | static void bdrv_get_cumulative_perm(BlockDriverState *bs, uint64_t *perm, | |
1530 | uint64_t *shared_perm) | |
1531 | { | |
1532 | BdrvChild *c; | |
1533 | uint64_t cumulative_perms = 0; | |
1534 | uint64_t cumulative_shared_perms = BLK_PERM_ALL; | |
1535 | ||
1536 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
1537 | cumulative_perms |= c->perm; | |
1538 | cumulative_shared_perms &= c->shared_perm; | |
1539 | } | |
1540 | ||
1541 | *perm = cumulative_perms; | |
1542 | *shared_perm = cumulative_shared_perms; | |
1543 | } | |
1544 | ||
d083319f KW |
1545 | static char *bdrv_child_user_desc(BdrvChild *c) |
1546 | { | |
1547 | if (c->role->get_parent_desc) { | |
1548 | return c->role->get_parent_desc(c); | |
1549 | } | |
1550 | ||
1551 | return g_strdup("another user"); | |
1552 | } | |
1553 | ||
1554 | static char *bdrv_perm_names(uint64_t perm) | |
1555 | { | |
1556 | struct perm_name { | |
1557 | uint64_t perm; | |
1558 | const char *name; | |
1559 | } permissions[] = { | |
1560 | { BLK_PERM_CONSISTENT_READ, "consistent read" }, | |
1561 | { BLK_PERM_WRITE, "write" }, | |
1562 | { BLK_PERM_WRITE_UNCHANGED, "write unchanged" }, | |
1563 | { BLK_PERM_RESIZE, "resize" }, | |
1564 | { BLK_PERM_GRAPH_MOD, "change children" }, | |
1565 | { 0, NULL } | |
1566 | }; | |
1567 | ||
1568 | char *result = g_strdup(""); | |
1569 | struct perm_name *p; | |
1570 | ||
1571 | for (p = permissions; p->name; p++) { | |
1572 | if (perm & p->perm) { | |
1573 | char *old = result; | |
1574 | result = g_strdup_printf("%s%s%s", old, *old ? ", " : "", p->name); | |
1575 | g_free(old); | |
1576 | } | |
1577 | } | |
1578 | ||
1579 | return result; | |
1580 | } | |
1581 | ||
33a610c3 KW |
1582 | /* |
1583 | * Checks whether a new reference to @bs can be added if the new user requires | |
46181129 KW |
1584 | * @new_used_perm/@new_shared_perm as its permissions. If @ignore_children is |
1585 | * set, the BdrvChild objects in this list are ignored in the calculations; | |
1586 | * this allows checking permission updates for an existing reference. | |
33a610c3 KW |
1587 | * |
1588 | * Needs to be followed by a call to either bdrv_set_perm() or | |
1589 | * bdrv_abort_perm_update(). */ | |
d5e6f437 KW |
1590 | static int bdrv_check_update_perm(BlockDriverState *bs, uint64_t new_used_perm, |
1591 | uint64_t new_shared_perm, | |
46181129 | 1592 | GSList *ignore_children, Error **errp) |
d5e6f437 KW |
1593 | { |
1594 | BdrvChild *c; | |
33a610c3 KW |
1595 | uint64_t cumulative_perms = new_used_perm; |
1596 | uint64_t cumulative_shared_perms = new_shared_perm; | |
d5e6f437 KW |
1597 | |
1598 | /* There is no reason why anyone couldn't tolerate write_unchanged */ | |
1599 | assert(new_shared_perm & BLK_PERM_WRITE_UNCHANGED); | |
1600 | ||
1601 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
46181129 | 1602 | if (g_slist_find(ignore_children, c)) { |
d5e6f437 KW |
1603 | continue; |
1604 | } | |
1605 | ||
d083319f KW |
1606 | if ((new_used_perm & c->shared_perm) != new_used_perm) { |
1607 | char *user = bdrv_child_user_desc(c); | |
1608 | char *perm_names = bdrv_perm_names(new_used_perm & ~c->shared_perm); | |
1609 | error_setg(errp, "Conflicts with use by %s as '%s', which does not " | |
1610 | "allow '%s' on %s", | |
1611 | user, c->name, perm_names, bdrv_get_node_name(c->bs)); | |
1612 | g_free(user); | |
1613 | g_free(perm_names); | |
1614 | return -EPERM; | |
1615 | } | |
1616 | ||
1617 | if ((c->perm & new_shared_perm) != c->perm) { | |
1618 | char *user = bdrv_child_user_desc(c); | |
1619 | char *perm_names = bdrv_perm_names(c->perm & ~new_shared_perm); | |
1620 | error_setg(errp, "Conflicts with use by %s as '%s', which uses " | |
1621 | "'%s' on %s", | |
1622 | user, c->name, perm_names, bdrv_get_node_name(c->bs)); | |
1623 | g_free(user); | |
1624 | g_free(perm_names); | |
d5e6f437 KW |
1625 | return -EPERM; |
1626 | } | |
33a610c3 KW |
1627 | |
1628 | cumulative_perms |= c->perm; | |
1629 | cumulative_shared_perms &= c->shared_perm; | |
d5e6f437 KW |
1630 | } |
1631 | ||
46181129 KW |
1632 | return bdrv_check_perm(bs, cumulative_perms, cumulative_shared_perms, |
1633 | ignore_children, errp); | |
33a610c3 KW |
1634 | } |
1635 | ||
1636 | /* Needs to be followed by a call to either bdrv_child_set_perm() or | |
1637 | * bdrv_child_abort_perm_update(). */ | |
c1cef672 FZ |
1638 | static int bdrv_child_check_perm(BdrvChild *c, uint64_t perm, uint64_t shared, |
1639 | GSList *ignore_children, Error **errp) | |
33a610c3 | 1640 | { |
46181129 KW |
1641 | int ret; |
1642 | ||
1643 | ignore_children = g_slist_prepend(g_slist_copy(ignore_children), c); | |
1644 | ret = bdrv_check_update_perm(c->bs, perm, shared, ignore_children, errp); | |
1645 | g_slist_free(ignore_children); | |
1646 | ||
1647 | return ret; | |
33a610c3 KW |
1648 | } |
1649 | ||
c1cef672 | 1650 | static void bdrv_child_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared) |
33a610c3 KW |
1651 | { |
1652 | uint64_t cumulative_perms, cumulative_shared_perms; | |
1653 | ||
1654 | c->perm = perm; | |
1655 | c->shared_perm = shared; | |
1656 | ||
1657 | bdrv_get_cumulative_perm(c->bs, &cumulative_perms, | |
1658 | &cumulative_shared_perms); | |
1659 | bdrv_set_perm(c->bs, cumulative_perms, cumulative_shared_perms); | |
1660 | } | |
1661 | ||
c1cef672 | 1662 | static void bdrv_child_abort_perm_update(BdrvChild *c) |
33a610c3 KW |
1663 | { |
1664 | bdrv_abort_perm_update(c->bs); | |
1665 | } | |
1666 | ||
1667 | int bdrv_child_try_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared, | |
1668 | Error **errp) | |
1669 | { | |
1670 | int ret; | |
1671 | ||
46181129 | 1672 | ret = bdrv_child_check_perm(c, perm, shared, NULL, errp); |
33a610c3 KW |
1673 | if (ret < 0) { |
1674 | bdrv_child_abort_perm_update(c); | |
1675 | return ret; | |
1676 | } | |
1677 | ||
1678 | bdrv_child_set_perm(c, perm, shared); | |
1679 | ||
d5e6f437 KW |
1680 | return 0; |
1681 | } | |
1682 | ||
6a1b9ee1 KW |
1683 | #define DEFAULT_PERM_PASSTHROUGH (BLK_PERM_CONSISTENT_READ \ |
1684 | | BLK_PERM_WRITE \ | |
1685 | | BLK_PERM_WRITE_UNCHANGED \ | |
1686 | | BLK_PERM_RESIZE) | |
1687 | #define DEFAULT_PERM_UNCHANGED (BLK_PERM_ALL & ~DEFAULT_PERM_PASSTHROUGH) | |
1688 | ||
1689 | void bdrv_filter_default_perms(BlockDriverState *bs, BdrvChild *c, | |
1690 | const BdrvChildRole *role, | |
1691 | uint64_t perm, uint64_t shared, | |
1692 | uint64_t *nperm, uint64_t *nshared) | |
1693 | { | |
1694 | if (c == NULL) { | |
1695 | *nperm = perm & DEFAULT_PERM_PASSTHROUGH; | |
1696 | *nshared = (shared & DEFAULT_PERM_PASSTHROUGH) | DEFAULT_PERM_UNCHANGED; | |
1697 | return; | |
1698 | } | |
1699 | ||
1700 | *nperm = (perm & DEFAULT_PERM_PASSTHROUGH) | | |
1701 | (c->perm & DEFAULT_PERM_UNCHANGED); | |
1702 | *nshared = (shared & DEFAULT_PERM_PASSTHROUGH) | | |
1703 | (c->shared_perm & DEFAULT_PERM_UNCHANGED); | |
1704 | } | |
1705 | ||
6b1a044a KW |
1706 | void bdrv_format_default_perms(BlockDriverState *bs, BdrvChild *c, |
1707 | const BdrvChildRole *role, | |
1708 | uint64_t perm, uint64_t shared, | |
1709 | uint64_t *nperm, uint64_t *nshared) | |
1710 | { | |
1711 | bool backing = (role == &child_backing); | |
1712 | assert(role == &child_backing || role == &child_file); | |
1713 | ||
1714 | if (!backing) { | |
1715 | /* Apart from the modifications below, the same permissions are | |
1716 | * forwarded and left alone as for filters */ | |
1717 | bdrv_filter_default_perms(bs, c, role, perm, shared, &perm, &shared); | |
1718 | ||
1719 | /* Format drivers may touch metadata even if the guest doesn't write */ | |
1720 | if (!bdrv_is_read_only(bs)) { | |
1721 | perm |= BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
1722 | } | |
1723 | ||
1724 | /* bs->file always needs to be consistent because of the metadata. We | |
1725 | * can never allow other users to resize or write to it. */ | |
1726 | perm |= BLK_PERM_CONSISTENT_READ; | |
1727 | shared &= ~(BLK_PERM_WRITE | BLK_PERM_RESIZE); | |
1728 | } else { | |
1729 | /* We want consistent read from backing files if the parent needs it. | |
1730 | * No other operations are performed on backing files. */ | |
1731 | perm &= BLK_PERM_CONSISTENT_READ; | |
1732 | ||
1733 | /* If the parent can deal with changing data, we're okay with a | |
1734 | * writable and resizable backing file. */ | |
1735 | /* TODO Require !(perm & BLK_PERM_CONSISTENT_READ), too? */ | |
1736 | if (shared & BLK_PERM_WRITE) { | |
1737 | shared = BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
1738 | } else { | |
1739 | shared = 0; | |
1740 | } | |
1741 | ||
1742 | shared |= BLK_PERM_CONSISTENT_READ | BLK_PERM_GRAPH_MOD | | |
1743 | BLK_PERM_WRITE_UNCHANGED; | |
1744 | } | |
1745 | ||
1746 | *nperm = perm; | |
1747 | *nshared = shared; | |
1748 | } | |
1749 | ||
8ee03995 KW |
1750 | static void bdrv_replace_child_noperm(BdrvChild *child, |
1751 | BlockDriverState *new_bs) | |
e9740bc6 KW |
1752 | { |
1753 | BlockDriverState *old_bs = child->bs; | |
1754 | ||
1755 | if (old_bs) { | |
36fe1331 KW |
1756 | if (old_bs->quiesce_counter && child->role->drained_end) { |
1757 | child->role->drained_end(child); | |
1758 | } | |
db95dbba KW |
1759 | if (child->role->detach) { |
1760 | child->role->detach(child); | |
1761 | } | |
e9740bc6 KW |
1762 | QLIST_REMOVE(child, next_parent); |
1763 | } | |
36fe1331 KW |
1764 | |
1765 | child->bs = new_bs; | |
1766 | ||
e9740bc6 KW |
1767 | if (new_bs) { |
1768 | QLIST_INSERT_HEAD(&new_bs->parents, child, next_parent); | |
36fe1331 KW |
1769 | if (new_bs->quiesce_counter && child->role->drained_begin) { |
1770 | child->role->drained_begin(child); | |
1771 | } | |
33a610c3 | 1772 | |
8ee03995 KW |
1773 | if (child->role->attach) { |
1774 | child->role->attach(child); | |
1775 | } | |
1776 | } | |
1777 | } | |
33a610c3 | 1778 | |
466787fb KW |
1779 | /* |
1780 | * Updates @child to change its reference to point to @new_bs, including | |
1781 | * checking and applying the necessary permisson updates both to the old node | |
1782 | * and to @new_bs. | |
1783 | * | |
1784 | * NULL is passed as @new_bs for removing the reference before freeing @child. | |
1785 | * | |
1786 | * If @new_bs is not NULL, bdrv_check_perm() must be called beforehand, as this | |
1787 | * function uses bdrv_set_perm() to update the permissions according to the new | |
1788 | * reference that @new_bs gets. | |
1789 | */ | |
1790 | static void bdrv_replace_child(BdrvChild *child, BlockDriverState *new_bs) | |
8ee03995 KW |
1791 | { |
1792 | BlockDriverState *old_bs = child->bs; | |
1793 | uint64_t perm, shared_perm; | |
1794 | ||
1795 | if (old_bs) { | |
33a610c3 KW |
1796 | /* Update permissions for old node. This is guaranteed to succeed |
1797 | * because we're just taking a parent away, so we're loosening | |
1798 | * restrictions. */ | |
1799 | bdrv_get_cumulative_perm(old_bs, &perm, &shared_perm); | |
46181129 | 1800 | bdrv_check_perm(old_bs, perm, shared_perm, NULL, &error_abort); |
33a610c3 | 1801 | bdrv_set_perm(old_bs, perm, shared_perm); |
e9740bc6 | 1802 | } |
36fe1331 | 1803 | |
8ee03995 | 1804 | bdrv_replace_child_noperm(child, new_bs); |
36fe1331 | 1805 | |
e9740bc6 | 1806 | if (new_bs) { |
33a610c3 | 1807 | bdrv_get_cumulative_perm(new_bs, &perm, &shared_perm); |
33a610c3 | 1808 | bdrv_set_perm(new_bs, perm, shared_perm); |
e9740bc6 | 1809 | } |
e9740bc6 KW |
1810 | } |
1811 | ||
f21d96d0 KW |
1812 | BdrvChild *bdrv_root_attach_child(BlockDriverState *child_bs, |
1813 | const char *child_name, | |
36fe1331 | 1814 | const BdrvChildRole *child_role, |
d5e6f437 KW |
1815 | uint64_t perm, uint64_t shared_perm, |
1816 | void *opaque, Error **errp) | |
df581792 | 1817 | { |
d5e6f437 KW |
1818 | BdrvChild *child; |
1819 | int ret; | |
1820 | ||
1821 | ret = bdrv_check_update_perm(child_bs, perm, shared_perm, NULL, errp); | |
1822 | if (ret < 0) { | |
33a610c3 | 1823 | bdrv_abort_perm_update(child_bs); |
d5e6f437 KW |
1824 | return NULL; |
1825 | } | |
1826 | ||
1827 | child = g_new(BdrvChild, 1); | |
df581792 | 1828 | *child = (BdrvChild) { |
d5e6f437 KW |
1829 | .bs = NULL, |
1830 | .name = g_strdup(child_name), | |
1831 | .role = child_role, | |
1832 | .perm = perm, | |
1833 | .shared_perm = shared_perm, | |
1834 | .opaque = opaque, | |
df581792 KW |
1835 | }; |
1836 | ||
33a610c3 | 1837 | /* This performs the matching bdrv_set_perm() for the above check. */ |
466787fb | 1838 | bdrv_replace_child(child, child_bs); |
b4b059f6 KW |
1839 | |
1840 | return child; | |
df581792 KW |
1841 | } |
1842 | ||
98292c61 WC |
1843 | BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs, |
1844 | BlockDriverState *child_bs, | |
1845 | const char *child_name, | |
8b2ff529 KW |
1846 | const BdrvChildRole *child_role, |
1847 | Error **errp) | |
f21d96d0 | 1848 | { |
d5e6f437 | 1849 | BdrvChild *child; |
f68c598b KW |
1850 | uint64_t perm, shared_perm; |
1851 | ||
1852 | bdrv_get_cumulative_perm(parent_bs, &perm, &shared_perm); | |
1853 | ||
1854 | assert(parent_bs->drv); | |
1855 | parent_bs->drv->bdrv_child_perm(parent_bs, NULL, child_role, | |
1856 | perm, shared_perm, &perm, &shared_perm); | |
d5e6f437 | 1857 | |
d5e6f437 | 1858 | child = bdrv_root_attach_child(child_bs, child_name, child_role, |
f68c598b | 1859 | perm, shared_perm, parent_bs, errp); |
d5e6f437 KW |
1860 | if (child == NULL) { |
1861 | return NULL; | |
1862 | } | |
1863 | ||
f21d96d0 KW |
1864 | QLIST_INSERT_HEAD(&parent_bs->children, child, next); |
1865 | return child; | |
1866 | } | |
1867 | ||
3f09bfbc | 1868 | static void bdrv_detach_child(BdrvChild *child) |
33a60407 | 1869 | { |
f21d96d0 KW |
1870 | if (child->next.le_prev) { |
1871 | QLIST_REMOVE(child, next); | |
1872 | child->next.le_prev = NULL; | |
1873 | } | |
e9740bc6 | 1874 | |
466787fb | 1875 | bdrv_replace_child(child, NULL); |
e9740bc6 | 1876 | |
260fecf1 | 1877 | g_free(child->name); |
33a60407 KW |
1878 | g_free(child); |
1879 | } | |
1880 | ||
f21d96d0 | 1881 | void bdrv_root_unref_child(BdrvChild *child) |
33a60407 | 1882 | { |
779020cb KW |
1883 | BlockDriverState *child_bs; |
1884 | ||
f21d96d0 KW |
1885 | child_bs = child->bs; |
1886 | bdrv_detach_child(child); | |
1887 | bdrv_unref(child_bs); | |
1888 | } | |
1889 | ||
1890 | void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child) | |
1891 | { | |
779020cb KW |
1892 | if (child == NULL) { |
1893 | return; | |
1894 | } | |
33a60407 KW |
1895 | |
1896 | if (child->bs->inherits_from == parent) { | |
4e4bf5c4 KW |
1897 | BdrvChild *c; |
1898 | ||
1899 | /* Remove inherits_from only when the last reference between parent and | |
1900 | * child->bs goes away. */ | |
1901 | QLIST_FOREACH(c, &parent->children, next) { | |
1902 | if (c != child && c->bs == child->bs) { | |
1903 | break; | |
1904 | } | |
1905 | } | |
1906 | if (c == NULL) { | |
1907 | child->bs->inherits_from = NULL; | |
1908 | } | |
33a60407 KW |
1909 | } |
1910 | ||
f21d96d0 | 1911 | bdrv_root_unref_child(child); |
33a60407 KW |
1912 | } |
1913 | ||
5c8cab48 KW |
1914 | |
1915 | static void bdrv_parent_cb_change_media(BlockDriverState *bs, bool load) | |
1916 | { | |
1917 | BdrvChild *c; | |
1918 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
1919 | if (c->role->change_media) { | |
1920 | c->role->change_media(c, load); | |
1921 | } | |
1922 | } | |
1923 | } | |
1924 | ||
1925 | static void bdrv_parent_cb_resize(BlockDriverState *bs) | |
1926 | { | |
1927 | BdrvChild *c; | |
1928 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
1929 | if (c->role->resize) { | |
1930 | c->role->resize(c); | |
1931 | } | |
1932 | } | |
1933 | } | |
1934 | ||
5db15a57 KW |
1935 | /* |
1936 | * Sets the backing file link of a BDS. A new reference is created; callers | |
1937 | * which don't need their own reference any more must call bdrv_unref(). | |
1938 | */ | |
12fa4af6 KW |
1939 | void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd, |
1940 | Error **errp) | |
8d24cce1 | 1941 | { |
5db15a57 KW |
1942 | if (backing_hd) { |
1943 | bdrv_ref(backing_hd); | |
1944 | } | |
8d24cce1 | 1945 | |
760e0063 | 1946 | if (bs->backing) { |
5db15a57 | 1947 | bdrv_unref_child(bs, bs->backing); |
826b6ca0 FZ |
1948 | } |
1949 | ||
8d24cce1 | 1950 | if (!backing_hd) { |
760e0063 | 1951 | bs->backing = NULL; |
8d24cce1 FZ |
1952 | goto out; |
1953 | } | |
12fa4af6 | 1954 | |
8b2ff529 | 1955 | bs->backing = bdrv_attach_child(bs, backing_hd, "backing", &child_backing, |
12fa4af6 KW |
1956 | errp); |
1957 | if (!bs->backing) { | |
1958 | bdrv_unref(backing_hd); | |
1959 | } | |
826b6ca0 | 1960 | |
9e7e940c KW |
1961 | bdrv_refresh_filename(bs); |
1962 | ||
8d24cce1 | 1963 | out: |
3baca891 | 1964 | bdrv_refresh_limits(bs, NULL); |
8d24cce1 FZ |
1965 | } |
1966 | ||
31ca6d07 KW |
1967 | /* |
1968 | * Opens the backing file for a BlockDriverState if not yet open | |
1969 | * | |
d9b7b057 KW |
1970 | * bdref_key specifies the key for the image's BlockdevRef in the options QDict. |
1971 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
1972 | * itself, all options starting with "${bdref_key}." are considered part of the | |
1973 | * BlockdevRef. | |
1974 | * | |
1975 | * TODO Can this be unified with bdrv_open_image()? | |
31ca6d07 | 1976 | */ |
d9b7b057 KW |
1977 | int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options, |
1978 | const char *bdref_key, Error **errp) | |
9156df12 | 1979 | { |
1ba4b6a5 | 1980 | char *backing_filename = g_malloc0(PATH_MAX); |
d9b7b057 KW |
1981 | char *bdref_key_dot; |
1982 | const char *reference = NULL; | |
317fc44e | 1983 | int ret = 0; |
8d24cce1 | 1984 | BlockDriverState *backing_hd; |
d9b7b057 KW |
1985 | QDict *options; |
1986 | QDict *tmp_parent_options = NULL; | |
34b5d2c6 | 1987 | Error *local_err = NULL; |
9156df12 | 1988 | |
760e0063 | 1989 | if (bs->backing != NULL) { |
1ba4b6a5 | 1990 | goto free_exit; |
9156df12 PB |
1991 | } |
1992 | ||
31ca6d07 | 1993 | /* NULL means an empty set of options */ |
d9b7b057 KW |
1994 | if (parent_options == NULL) { |
1995 | tmp_parent_options = qdict_new(); | |
1996 | parent_options = tmp_parent_options; | |
31ca6d07 KW |
1997 | } |
1998 | ||
9156df12 | 1999 | bs->open_flags &= ~BDRV_O_NO_BACKING; |
d9b7b057 KW |
2000 | |
2001 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); | |
2002 | qdict_extract_subqdict(parent_options, &options, bdref_key_dot); | |
2003 | g_free(bdref_key_dot); | |
2004 | ||
129c7d1c MA |
2005 | /* |
2006 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
2007 | * types would require more care. When @parent_options come from | |
2008 | * -blockdev or blockdev_add, its members are typed according to | |
2009 | * the QAPI schema, but when they come from -drive, they're all | |
2010 | * QString. | |
2011 | */ | |
d9b7b057 KW |
2012 | reference = qdict_get_try_str(parent_options, bdref_key); |
2013 | if (reference || qdict_haskey(options, "file.filename")) { | |
1cb6f506 KW |
2014 | backing_filename[0] = '\0'; |
2015 | } else if (bs->backing_file[0] == '\0' && qdict_size(options) == 0) { | |
31ca6d07 | 2016 | QDECREF(options); |
1ba4b6a5 | 2017 | goto free_exit; |
dbecebdd | 2018 | } else { |
9f07429e HR |
2019 | bdrv_get_full_backing_filename(bs, backing_filename, PATH_MAX, |
2020 | &local_err); | |
2021 | if (local_err) { | |
2022 | ret = -EINVAL; | |
2023 | error_propagate(errp, local_err); | |
2024 | QDECREF(options); | |
2025 | goto free_exit; | |
2026 | } | |
9156df12 PB |
2027 | } |
2028 | ||
8ee79e70 KW |
2029 | if (!bs->drv || !bs->drv->supports_backing) { |
2030 | ret = -EINVAL; | |
2031 | error_setg(errp, "Driver doesn't support backing files"); | |
2032 | QDECREF(options); | |
2033 | goto free_exit; | |
2034 | } | |
2035 | ||
c5f6e493 KW |
2036 | if (bs->backing_format[0] != '\0' && !qdict_haskey(options, "driver")) { |
2037 | qdict_put(options, "driver", qstring_from_str(bs->backing_format)); | |
9156df12 PB |
2038 | } |
2039 | ||
5b363937 HR |
2040 | backing_hd = bdrv_open_inherit(*backing_filename ? backing_filename : NULL, |
2041 | reference, options, 0, bs, &child_backing, | |
2042 | errp); | |
2043 | if (!backing_hd) { | |
9156df12 | 2044 | bs->open_flags |= BDRV_O_NO_BACKING; |
e43bfd9c | 2045 | error_prepend(errp, "Could not open backing file: "); |
5b363937 | 2046 | ret = -EINVAL; |
1ba4b6a5 | 2047 | goto free_exit; |
9156df12 | 2048 | } |
df581792 | 2049 | |
5db15a57 KW |
2050 | /* Hook up the backing file link; drop our reference, bs owns the |
2051 | * backing_hd reference now */ | |
12fa4af6 | 2052 | bdrv_set_backing_hd(bs, backing_hd, &local_err); |
5db15a57 | 2053 | bdrv_unref(backing_hd); |
12fa4af6 | 2054 | if (local_err) { |
8cd1a3e4 | 2055 | error_propagate(errp, local_err); |
12fa4af6 KW |
2056 | ret = -EINVAL; |
2057 | goto free_exit; | |
2058 | } | |
d80ac658 | 2059 | |
d9b7b057 KW |
2060 | qdict_del(parent_options, bdref_key); |
2061 | ||
1ba4b6a5 BC |
2062 | free_exit: |
2063 | g_free(backing_filename); | |
d9b7b057 | 2064 | QDECREF(tmp_parent_options); |
1ba4b6a5 | 2065 | return ret; |
9156df12 PB |
2066 | } |
2067 | ||
2d6b86af KW |
2068 | static BlockDriverState * |
2069 | bdrv_open_child_bs(const char *filename, QDict *options, const char *bdref_key, | |
2070 | BlockDriverState *parent, const BdrvChildRole *child_role, | |
2071 | bool allow_none, Error **errp) | |
da557aac | 2072 | { |
2d6b86af | 2073 | BlockDriverState *bs = NULL; |
da557aac | 2074 | QDict *image_options; |
da557aac HR |
2075 | char *bdref_key_dot; |
2076 | const char *reference; | |
2077 | ||
df581792 | 2078 | assert(child_role != NULL); |
f67503e5 | 2079 | |
da557aac HR |
2080 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); |
2081 | qdict_extract_subqdict(options, &image_options, bdref_key_dot); | |
2082 | g_free(bdref_key_dot); | |
2083 | ||
129c7d1c MA |
2084 | /* |
2085 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
2086 | * types would require more care. When @options come from | |
2087 | * -blockdev or blockdev_add, its members are typed according to | |
2088 | * the QAPI schema, but when they come from -drive, they're all | |
2089 | * QString. | |
2090 | */ | |
da557aac HR |
2091 | reference = qdict_get_try_str(options, bdref_key); |
2092 | if (!filename && !reference && !qdict_size(image_options)) { | |
b4b059f6 | 2093 | if (!allow_none) { |
da557aac HR |
2094 | error_setg(errp, "A block device must be specified for \"%s\"", |
2095 | bdref_key); | |
da557aac | 2096 | } |
b20e61e0 | 2097 | QDECREF(image_options); |
da557aac HR |
2098 | goto done; |
2099 | } | |
2100 | ||
5b363937 HR |
2101 | bs = bdrv_open_inherit(filename, reference, image_options, 0, |
2102 | parent, child_role, errp); | |
2103 | if (!bs) { | |
df581792 KW |
2104 | goto done; |
2105 | } | |
2106 | ||
da557aac HR |
2107 | done: |
2108 | qdict_del(options, bdref_key); | |
2d6b86af KW |
2109 | return bs; |
2110 | } | |
2111 | ||
2112 | /* | |
2113 | * Opens a disk image whose options are given as BlockdevRef in another block | |
2114 | * device's options. | |
2115 | * | |
2116 | * If allow_none is true, no image will be opened if filename is false and no | |
2117 | * BlockdevRef is given. NULL will be returned, but errp remains unset. | |
2118 | * | |
2119 | * bdrev_key specifies the key for the image's BlockdevRef in the options QDict. | |
2120 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
2121 | * itself, all options starting with "${bdref_key}." are considered part of the | |
2122 | * BlockdevRef. | |
2123 | * | |
2124 | * The BlockdevRef will be removed from the options QDict. | |
2125 | */ | |
2126 | BdrvChild *bdrv_open_child(const char *filename, | |
2127 | QDict *options, const char *bdref_key, | |
2128 | BlockDriverState *parent, | |
2129 | const BdrvChildRole *child_role, | |
2130 | bool allow_none, Error **errp) | |
2131 | { | |
8b2ff529 | 2132 | BdrvChild *c; |
2d6b86af KW |
2133 | BlockDriverState *bs; |
2134 | ||
2135 | bs = bdrv_open_child_bs(filename, options, bdref_key, parent, child_role, | |
2136 | allow_none, errp); | |
2137 | if (bs == NULL) { | |
2138 | return NULL; | |
2139 | } | |
2140 | ||
8b2ff529 KW |
2141 | c = bdrv_attach_child(parent, bs, bdref_key, child_role, errp); |
2142 | if (!c) { | |
2143 | bdrv_unref(bs); | |
2144 | return NULL; | |
2145 | } | |
2146 | ||
2147 | return c; | |
b4b059f6 KW |
2148 | } |
2149 | ||
66836189 HR |
2150 | static BlockDriverState *bdrv_append_temp_snapshot(BlockDriverState *bs, |
2151 | int flags, | |
2152 | QDict *snapshot_options, | |
2153 | Error **errp) | |
b998875d KW |
2154 | { |
2155 | /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */ | |
1ba4b6a5 | 2156 | char *tmp_filename = g_malloc0(PATH_MAX + 1); |
b998875d | 2157 | int64_t total_size; |
83d0521a | 2158 | QemuOpts *opts = NULL; |
b998875d | 2159 | BlockDriverState *bs_snapshot; |
b2c2832c | 2160 | Error *local_err = NULL; |
b998875d KW |
2161 | int ret; |
2162 | ||
2163 | /* if snapshot, we create a temporary backing file and open it | |
2164 | instead of opening 'filename' directly */ | |
2165 | ||
2166 | /* Get the required size from the image */ | |
f187743a KW |
2167 | total_size = bdrv_getlength(bs); |
2168 | if (total_size < 0) { | |
2169 | error_setg_errno(errp, -total_size, "Could not get image size"); | |
1ba4b6a5 | 2170 | goto out; |
f187743a | 2171 | } |
b998875d KW |
2172 | |
2173 | /* Create the temporary image */ | |
1ba4b6a5 | 2174 | ret = get_tmp_filename(tmp_filename, PATH_MAX + 1); |
b998875d KW |
2175 | if (ret < 0) { |
2176 | error_setg_errno(errp, -ret, "Could not get temporary filename"); | |
1ba4b6a5 | 2177 | goto out; |
b998875d KW |
2178 | } |
2179 | ||
ef810437 | 2180 | opts = qemu_opts_create(bdrv_qcow2.create_opts, NULL, 0, |
c282e1fd | 2181 | &error_abort); |
39101f25 | 2182 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_size, &error_abort); |
e43bfd9c | 2183 | ret = bdrv_create(&bdrv_qcow2, tmp_filename, opts, errp); |
83d0521a | 2184 | qemu_opts_del(opts); |
b998875d | 2185 | if (ret < 0) { |
e43bfd9c MA |
2186 | error_prepend(errp, "Could not create temporary overlay '%s': ", |
2187 | tmp_filename); | |
1ba4b6a5 | 2188 | goto out; |
b998875d KW |
2189 | } |
2190 | ||
73176bee | 2191 | /* Prepare options QDict for the temporary file */ |
b998875d KW |
2192 | qdict_put(snapshot_options, "file.driver", |
2193 | qstring_from_str("file")); | |
2194 | qdict_put(snapshot_options, "file.filename", | |
2195 | qstring_from_str(tmp_filename)); | |
e6641719 HR |
2196 | qdict_put(snapshot_options, "driver", |
2197 | qstring_from_str("qcow2")); | |
b998875d | 2198 | |
5b363937 | 2199 | bs_snapshot = bdrv_open(NULL, NULL, snapshot_options, flags, errp); |
73176bee | 2200 | snapshot_options = NULL; |
5b363937 HR |
2201 | if (!bs_snapshot) { |
2202 | ret = -EINVAL; | |
1ba4b6a5 | 2203 | goto out; |
b998875d KW |
2204 | } |
2205 | ||
66836189 HR |
2206 | /* bdrv_append() consumes a strong reference to bs_snapshot (i.e. it will |
2207 | * call bdrv_unref() on it), so in order to be able to return one, we have | |
2208 | * to increase bs_snapshot's refcount here */ | |
2209 | bdrv_ref(bs_snapshot); | |
b2c2832c KW |
2210 | bdrv_append(bs_snapshot, bs, &local_err); |
2211 | if (local_err) { | |
2212 | error_propagate(errp, local_err); | |
2213 | ret = -EINVAL; | |
2214 | goto out; | |
2215 | } | |
1ba4b6a5 | 2216 | |
66836189 HR |
2217 | g_free(tmp_filename); |
2218 | return bs_snapshot; | |
2219 | ||
1ba4b6a5 | 2220 | out: |
73176bee | 2221 | QDECREF(snapshot_options); |
1ba4b6a5 | 2222 | g_free(tmp_filename); |
66836189 | 2223 | return NULL; |
b998875d KW |
2224 | } |
2225 | ||
b6ce07aa KW |
2226 | /* |
2227 | * Opens a disk image (raw, qcow2, vmdk, ...) | |
de9c0cec KW |
2228 | * |
2229 | * options is a QDict of options to pass to the block drivers, or NULL for an | |
2230 | * empty set of options. The reference to the QDict belongs to the block layer | |
2231 | * after the call (even on failure), so if the caller intends to reuse the | |
2232 | * dictionary, it needs to use QINCREF() before calling bdrv_open. | |
f67503e5 HR |
2233 | * |
2234 | * If *pbs is NULL, a new BDS will be created with a pointer to it stored there. | |
2235 | * If it is not NULL, the referenced BDS will be reused. | |
ddf5636d HR |
2236 | * |
2237 | * The reference parameter may be used to specify an existing block device which | |
2238 | * should be opened. If specified, neither options nor a filename may be given, | |
2239 | * nor can an existing BDS be reused (that is, *pbs has to be NULL). | |
b6ce07aa | 2240 | */ |
5b363937 HR |
2241 | static BlockDriverState *bdrv_open_inherit(const char *filename, |
2242 | const char *reference, | |
2243 | QDict *options, int flags, | |
2244 | BlockDriverState *parent, | |
2245 | const BdrvChildRole *child_role, | |
2246 | Error **errp) | |
ea2384d3 | 2247 | { |
b6ce07aa | 2248 | int ret; |
5696c6e3 | 2249 | BlockBackend *file = NULL; |
9a4f4c31 | 2250 | BlockDriverState *bs; |
ce343771 | 2251 | BlockDriver *drv = NULL; |
74fe54f2 | 2252 | const char *drvname; |
3e8c2e57 | 2253 | const char *backing; |
34b5d2c6 | 2254 | Error *local_err = NULL; |
73176bee | 2255 | QDict *snapshot_options = NULL; |
b1e6fc08 | 2256 | int snapshot_flags = 0; |
712e7874 | 2257 | |
f3930ed0 KW |
2258 | assert(!child_role || !flags); |
2259 | assert(!child_role == !parent); | |
f67503e5 | 2260 | |
ddf5636d HR |
2261 | if (reference) { |
2262 | bool options_non_empty = options ? qdict_size(options) : false; | |
2263 | QDECREF(options); | |
2264 | ||
ddf5636d HR |
2265 | if (filename || options_non_empty) { |
2266 | error_setg(errp, "Cannot reference an existing block device with " | |
2267 | "additional options or a new filename"); | |
5b363937 | 2268 | return NULL; |
ddf5636d HR |
2269 | } |
2270 | ||
2271 | bs = bdrv_lookup_bs(reference, reference, errp); | |
2272 | if (!bs) { | |
5b363937 | 2273 | return NULL; |
ddf5636d | 2274 | } |
76b22320 | 2275 | |
ddf5636d | 2276 | bdrv_ref(bs); |
5b363937 | 2277 | return bs; |
ddf5636d HR |
2278 | } |
2279 | ||
5b363937 | 2280 | bs = bdrv_new(); |
f67503e5 | 2281 | |
de9c0cec KW |
2282 | /* NULL means an empty set of options */ |
2283 | if (options == NULL) { | |
2284 | options = qdict_new(); | |
2285 | } | |
2286 | ||
145f598e | 2287 | /* json: syntax counts as explicit options, as if in the QDict */ |
de3b53f0 KW |
2288 | parse_json_protocol(options, &filename, &local_err); |
2289 | if (local_err) { | |
de3b53f0 KW |
2290 | goto fail; |
2291 | } | |
2292 | ||
145f598e KW |
2293 | bs->explicit_options = qdict_clone_shallow(options); |
2294 | ||
f3930ed0 | 2295 | if (child_role) { |
bddcec37 | 2296 | bs->inherits_from = parent; |
8e2160e2 KW |
2297 | child_role->inherit_options(&flags, options, |
2298 | parent->open_flags, parent->options); | |
f3930ed0 KW |
2299 | } |
2300 | ||
de3b53f0 | 2301 | ret = bdrv_fill_options(&options, filename, &flags, &local_err); |
462f5bcf KW |
2302 | if (local_err) { |
2303 | goto fail; | |
2304 | } | |
2305 | ||
129c7d1c MA |
2306 | /* |
2307 | * Set the BDRV_O_RDWR and BDRV_O_ALLOW_RDWR flags. | |
2308 | * Caution: getting a boolean member of @options requires care. | |
2309 | * When @options come from -blockdev or blockdev_add, members are | |
2310 | * typed according to the QAPI schema, but when they come from | |
2311 | * -drive, they're all QString. | |
2312 | */ | |
f87a0e29 AG |
2313 | if (g_strcmp0(qdict_get_try_str(options, BDRV_OPT_READ_ONLY), "on") && |
2314 | !qdict_get_try_bool(options, BDRV_OPT_READ_ONLY, false)) { | |
2315 | flags |= (BDRV_O_RDWR | BDRV_O_ALLOW_RDWR); | |
2316 | } else { | |
2317 | flags &= ~BDRV_O_RDWR; | |
14499ea5 AG |
2318 | } |
2319 | ||
2320 | if (flags & BDRV_O_SNAPSHOT) { | |
2321 | snapshot_options = qdict_new(); | |
2322 | bdrv_temp_snapshot_options(&snapshot_flags, snapshot_options, | |
2323 | flags, options); | |
f87a0e29 AG |
2324 | /* Let bdrv_backing_options() override "read-only" */ |
2325 | qdict_del(options, BDRV_OPT_READ_ONLY); | |
14499ea5 AG |
2326 | bdrv_backing_options(&flags, options, flags, options); |
2327 | } | |
2328 | ||
62392ebb KW |
2329 | bs->open_flags = flags; |
2330 | bs->options = options; | |
2331 | options = qdict_clone_shallow(options); | |
2332 | ||
76c591b0 | 2333 | /* Find the right image format driver */ |
129c7d1c | 2334 | /* See cautionary note on accessing @options above */ |
76c591b0 KW |
2335 | drvname = qdict_get_try_str(options, "driver"); |
2336 | if (drvname) { | |
2337 | drv = bdrv_find_format(drvname); | |
76c591b0 KW |
2338 | if (!drv) { |
2339 | error_setg(errp, "Unknown driver: '%s'", drvname); | |
76c591b0 KW |
2340 | goto fail; |
2341 | } | |
2342 | } | |
2343 | ||
2344 | assert(drvname || !(flags & BDRV_O_PROTOCOL)); | |
76c591b0 | 2345 | |
129c7d1c | 2346 | /* See cautionary note on accessing @options above */ |
3e8c2e57 AG |
2347 | backing = qdict_get_try_str(options, "backing"); |
2348 | if (backing && *backing == '\0') { | |
2349 | flags |= BDRV_O_NO_BACKING; | |
2350 | qdict_del(options, "backing"); | |
2351 | } | |
2352 | ||
5696c6e3 | 2353 | /* Open image file without format layer. This BlockBackend is only used for |
4e4bf5c4 KW |
2354 | * probing, the block drivers will do their own bdrv_open_child() for the |
2355 | * same BDS, which is why we put the node name back into options. */ | |
f4788adc | 2356 | if ((flags & BDRV_O_PROTOCOL) == 0) { |
5696c6e3 KW |
2357 | BlockDriverState *file_bs; |
2358 | ||
2359 | file_bs = bdrv_open_child_bs(filename, options, "file", bs, | |
2360 | &child_file, true, &local_err); | |
1fdd6933 | 2361 | if (local_err) { |
f4788adc KW |
2362 | goto fail; |
2363 | } | |
5696c6e3 | 2364 | if (file_bs != NULL) { |
6d0eb64d | 2365 | file = blk_new(BLK_PERM_CONSISTENT_READ, BLK_PERM_ALL); |
d7086422 | 2366 | blk_insert_bs(file, file_bs, &local_err); |
5696c6e3 | 2367 | bdrv_unref(file_bs); |
d7086422 KW |
2368 | if (local_err) { |
2369 | goto fail; | |
2370 | } | |
5696c6e3 | 2371 | |
4e4bf5c4 | 2372 | qdict_put(options, "file", |
5696c6e3 | 2373 | qstring_from_str(bdrv_get_node_name(file_bs))); |
4e4bf5c4 | 2374 | } |
f500a6d3 KW |
2375 | } |
2376 | ||
76c591b0 | 2377 | /* Image format probing */ |
38f3ef57 | 2378 | bs->probed = !drv; |
76c591b0 | 2379 | if (!drv && file) { |
cf2ab8fc | 2380 | ret = find_image_format(file, filename, &drv, &local_err); |
17b005f1 | 2381 | if (ret < 0) { |
8bfea15d | 2382 | goto fail; |
2a05cbe4 | 2383 | } |
62392ebb KW |
2384 | /* |
2385 | * This option update would logically belong in bdrv_fill_options(), | |
2386 | * but we first need to open bs->file for the probing to work, while | |
2387 | * opening bs->file already requires the (mostly) final set of options | |
2388 | * so that cache mode etc. can be inherited. | |
2389 | * | |
2390 | * Adding the driver later is somewhat ugly, but it's not an option | |
2391 | * that would ever be inherited, so it's correct. We just need to make | |
2392 | * sure to update both bs->options (which has the full effective | |
2393 | * options for bs) and options (which has file.* already removed). | |
2394 | */ | |
2395 | qdict_put(bs->options, "driver", qstring_from_str(drv->format_name)); | |
2396 | qdict_put(options, "driver", qstring_from_str(drv->format_name)); | |
76c591b0 | 2397 | } else if (!drv) { |
17b005f1 | 2398 | error_setg(errp, "Must specify either driver or file"); |
8bfea15d | 2399 | goto fail; |
ea2384d3 | 2400 | } |
b6ce07aa | 2401 | |
53a29513 HR |
2402 | /* BDRV_O_PROTOCOL must be set iff a protocol BDS is about to be created */ |
2403 | assert(!!(flags & BDRV_O_PROTOCOL) == !!drv->bdrv_file_open); | |
2404 | /* file must be NULL if a protocol BDS is about to be created | |
2405 | * (the inverse results in an error message from bdrv_open_common()) */ | |
2406 | assert(!(flags & BDRV_O_PROTOCOL) || !file); | |
2407 | ||
b6ce07aa | 2408 | /* Open the image */ |
82dc8b41 | 2409 | ret = bdrv_open_common(bs, file, options, &local_err); |
b6ce07aa | 2410 | if (ret < 0) { |
8bfea15d | 2411 | goto fail; |
6987307c CH |
2412 | } |
2413 | ||
4e4bf5c4 | 2414 | if (file) { |
5696c6e3 | 2415 | blk_unref(file); |
f500a6d3 KW |
2416 | file = NULL; |
2417 | } | |
2418 | ||
b6ce07aa | 2419 | /* If there is a backing file, use it */ |
9156df12 | 2420 | if ((flags & BDRV_O_NO_BACKING) == 0) { |
d9b7b057 | 2421 | ret = bdrv_open_backing_file(bs, options, "backing", &local_err); |
b6ce07aa | 2422 | if (ret < 0) { |
b6ad491a | 2423 | goto close_and_fail; |
b6ce07aa | 2424 | } |
b6ce07aa KW |
2425 | } |
2426 | ||
91af7014 HR |
2427 | bdrv_refresh_filename(bs); |
2428 | ||
b6ad491a | 2429 | /* Check if any unknown options were used */ |
7ad2757f | 2430 | if (qdict_size(options) != 0) { |
b6ad491a | 2431 | const QDictEntry *entry = qdict_first(options); |
5acd9d81 HR |
2432 | if (flags & BDRV_O_PROTOCOL) { |
2433 | error_setg(errp, "Block protocol '%s' doesn't support the option " | |
2434 | "'%s'", drv->format_name, entry->key); | |
2435 | } else { | |
d0e46a55 HR |
2436 | error_setg(errp, |
2437 | "Block format '%s' does not support the option '%s'", | |
2438 | drv->format_name, entry->key); | |
5acd9d81 | 2439 | } |
b6ad491a | 2440 | |
b6ad491a KW |
2441 | goto close_and_fail; |
2442 | } | |
b6ad491a | 2443 | |
b6ce07aa | 2444 | if (!bdrv_key_required(bs)) { |
5c8cab48 | 2445 | bdrv_parent_cb_change_media(bs, true); |
c3adb58f MA |
2446 | } else if (!runstate_check(RUN_STATE_PRELAUNCH) |
2447 | && !runstate_check(RUN_STATE_INMIGRATE) | |
2448 | && !runstate_check(RUN_STATE_PAUSED)) { /* HACK */ | |
2449 | error_setg(errp, | |
2450 | "Guest must be stopped for opening of encrypted image"); | |
c3adb58f | 2451 | goto close_and_fail; |
b6ce07aa KW |
2452 | } |
2453 | ||
c3adb58f | 2454 | QDECREF(options); |
dd62f1ca KW |
2455 | |
2456 | /* For snapshot=on, create a temporary qcow2 overlay. bs points to the | |
2457 | * temporary snapshot afterwards. */ | |
2458 | if (snapshot_flags) { | |
66836189 HR |
2459 | BlockDriverState *snapshot_bs; |
2460 | snapshot_bs = bdrv_append_temp_snapshot(bs, snapshot_flags, | |
2461 | snapshot_options, &local_err); | |
73176bee | 2462 | snapshot_options = NULL; |
dd62f1ca KW |
2463 | if (local_err) { |
2464 | goto close_and_fail; | |
2465 | } | |
5b363937 HR |
2466 | /* We are not going to return bs but the overlay on top of it |
2467 | * (snapshot_bs); thus, we have to drop the strong reference to bs | |
2468 | * (which we obtained by calling bdrv_new()). bs will not be deleted, | |
2469 | * though, because the overlay still has a reference to it. */ | |
2470 | bdrv_unref(bs); | |
2471 | bs = snapshot_bs; | |
dd62f1ca KW |
2472 | } |
2473 | ||
5b363937 | 2474 | return bs; |
b6ce07aa | 2475 | |
8bfea15d | 2476 | fail: |
5696c6e3 | 2477 | blk_unref(file); |
4e4bf5c4 KW |
2478 | if (bs->file != NULL) { |
2479 | bdrv_unref_child(bs, bs->file); | |
f500a6d3 | 2480 | } |
73176bee | 2481 | QDECREF(snapshot_options); |
145f598e | 2482 | QDECREF(bs->explicit_options); |
de9c0cec | 2483 | QDECREF(bs->options); |
b6ad491a | 2484 | QDECREF(options); |
de9c0cec | 2485 | bs->options = NULL; |
5b363937 | 2486 | bdrv_unref(bs); |
621ff94d | 2487 | error_propagate(errp, local_err); |
5b363937 | 2488 | return NULL; |
de9c0cec | 2489 | |
b6ad491a | 2490 | close_and_fail: |
5b363937 | 2491 | bdrv_unref(bs); |
73176bee | 2492 | QDECREF(snapshot_options); |
b6ad491a | 2493 | QDECREF(options); |
621ff94d | 2494 | error_propagate(errp, local_err); |
5b363937 | 2495 | return NULL; |
b6ce07aa KW |
2496 | } |
2497 | ||
5b363937 HR |
2498 | BlockDriverState *bdrv_open(const char *filename, const char *reference, |
2499 | QDict *options, int flags, Error **errp) | |
f3930ed0 | 2500 | { |
5b363937 | 2501 | return bdrv_open_inherit(filename, reference, options, flags, NULL, |
ce343771 | 2502 | NULL, errp); |
f3930ed0 KW |
2503 | } |
2504 | ||
e971aa12 JC |
2505 | typedef struct BlockReopenQueueEntry { |
2506 | bool prepared; | |
2507 | BDRVReopenState state; | |
2508 | QSIMPLEQ_ENTRY(BlockReopenQueueEntry) entry; | |
2509 | } BlockReopenQueueEntry; | |
2510 | ||
2511 | /* | |
2512 | * Adds a BlockDriverState to a simple queue for an atomic, transactional | |
2513 | * reopen of multiple devices. | |
2514 | * | |
2515 | * bs_queue can either be an existing BlockReopenQueue that has had QSIMPLE_INIT | |
2516 | * already performed, or alternatively may be NULL a new BlockReopenQueue will | |
2517 | * be created and initialized. This newly created BlockReopenQueue should be | |
2518 | * passed back in for subsequent calls that are intended to be of the same | |
2519 | * atomic 'set'. | |
2520 | * | |
2521 | * bs is the BlockDriverState to add to the reopen queue. | |
2522 | * | |
4d2cb092 KW |
2523 | * options contains the changed options for the associated bs |
2524 | * (the BlockReopenQueue takes ownership) | |
2525 | * | |
e971aa12 JC |
2526 | * flags contains the open flags for the associated bs |
2527 | * | |
2528 | * returns a pointer to bs_queue, which is either the newly allocated | |
2529 | * bs_queue, or the existing bs_queue being used. | |
2530 | * | |
2531 | */ | |
28518102 KW |
2532 | static BlockReopenQueue *bdrv_reopen_queue_child(BlockReopenQueue *bs_queue, |
2533 | BlockDriverState *bs, | |
2534 | QDict *options, | |
2535 | int flags, | |
2536 | const BdrvChildRole *role, | |
2537 | QDict *parent_options, | |
2538 | int parent_flags) | |
e971aa12 JC |
2539 | { |
2540 | assert(bs != NULL); | |
2541 | ||
2542 | BlockReopenQueueEntry *bs_entry; | |
67251a31 | 2543 | BdrvChild *child; |
145f598e | 2544 | QDict *old_options, *explicit_options; |
67251a31 | 2545 | |
e971aa12 JC |
2546 | if (bs_queue == NULL) { |
2547 | bs_queue = g_new0(BlockReopenQueue, 1); | |
2548 | QSIMPLEQ_INIT(bs_queue); | |
2549 | } | |
2550 | ||
4d2cb092 KW |
2551 | if (!options) { |
2552 | options = qdict_new(); | |
2553 | } | |
2554 | ||
5b7ba05f AG |
2555 | /* Check if this BlockDriverState is already in the queue */ |
2556 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { | |
2557 | if (bs == bs_entry->state.bs) { | |
2558 | break; | |
2559 | } | |
2560 | } | |
2561 | ||
28518102 KW |
2562 | /* |
2563 | * Precedence of options: | |
2564 | * 1. Explicitly passed in options (highest) | |
91a097e7 | 2565 | * 2. Set in flags (only for top level) |
145f598e | 2566 | * 3. Retained from explicitly set options of bs |
8e2160e2 | 2567 | * 4. Inherited from parent node |
28518102 KW |
2568 | * 5. Retained from effective options of bs |
2569 | */ | |
2570 | ||
91a097e7 KW |
2571 | if (!parent_options) { |
2572 | /* | |
2573 | * Any setting represented by flags is always updated. If the | |
2574 | * corresponding QDict option is set, it takes precedence. Otherwise | |
2575 | * the flag is translated into a QDict option. The old setting of bs is | |
2576 | * not considered. | |
2577 | */ | |
2578 | update_options_from_flags(options, flags); | |
2579 | } | |
2580 | ||
145f598e | 2581 | /* Old explicitly set values (don't overwrite by inherited value) */ |
5b7ba05f AG |
2582 | if (bs_entry) { |
2583 | old_options = qdict_clone_shallow(bs_entry->state.explicit_options); | |
2584 | } else { | |
2585 | old_options = qdict_clone_shallow(bs->explicit_options); | |
2586 | } | |
145f598e KW |
2587 | bdrv_join_options(bs, options, old_options); |
2588 | QDECREF(old_options); | |
2589 | ||
2590 | explicit_options = qdict_clone_shallow(options); | |
2591 | ||
28518102 KW |
2592 | /* Inherit from parent node */ |
2593 | if (parent_options) { | |
2594 | assert(!flags); | |
8e2160e2 | 2595 | role->inherit_options(&flags, options, parent_flags, parent_options); |
28518102 KW |
2596 | } |
2597 | ||
2598 | /* Old values are used for options that aren't set yet */ | |
4d2cb092 | 2599 | old_options = qdict_clone_shallow(bs->options); |
cddff5ba | 2600 | bdrv_join_options(bs, options, old_options); |
4d2cb092 KW |
2601 | QDECREF(old_options); |
2602 | ||
f1f25a2e KW |
2603 | /* bdrv_open() masks this flag out */ |
2604 | flags &= ~BDRV_O_PROTOCOL; | |
2605 | ||
67251a31 | 2606 | QLIST_FOREACH(child, &bs->children, next) { |
4c9dfe5d KW |
2607 | QDict *new_child_options; |
2608 | char *child_key_dot; | |
67251a31 | 2609 | |
4c9dfe5d KW |
2610 | /* reopen can only change the options of block devices that were |
2611 | * implicitly created and inherited options. For other (referenced) | |
2612 | * block devices, a syntax like "backing.foo" results in an error. */ | |
67251a31 KW |
2613 | if (child->bs->inherits_from != bs) { |
2614 | continue; | |
2615 | } | |
2616 | ||
4c9dfe5d KW |
2617 | child_key_dot = g_strdup_printf("%s.", child->name); |
2618 | qdict_extract_subqdict(options, &new_child_options, child_key_dot); | |
2619 | g_free(child_key_dot); | |
2620 | ||
28518102 KW |
2621 | bdrv_reopen_queue_child(bs_queue, child->bs, new_child_options, 0, |
2622 | child->role, options, flags); | |
e971aa12 JC |
2623 | } |
2624 | ||
5b7ba05f AG |
2625 | if (!bs_entry) { |
2626 | bs_entry = g_new0(BlockReopenQueueEntry, 1); | |
2627 | QSIMPLEQ_INSERT_TAIL(bs_queue, bs_entry, entry); | |
2628 | } else { | |
2629 | QDECREF(bs_entry->state.options); | |
2630 | QDECREF(bs_entry->state.explicit_options); | |
2631 | } | |
e971aa12 JC |
2632 | |
2633 | bs_entry->state.bs = bs; | |
4d2cb092 | 2634 | bs_entry->state.options = options; |
145f598e | 2635 | bs_entry->state.explicit_options = explicit_options; |
e971aa12 JC |
2636 | bs_entry->state.flags = flags; |
2637 | ||
2638 | return bs_queue; | |
2639 | } | |
2640 | ||
28518102 KW |
2641 | BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue, |
2642 | BlockDriverState *bs, | |
2643 | QDict *options, int flags) | |
2644 | { | |
2645 | return bdrv_reopen_queue_child(bs_queue, bs, options, flags, | |
2646 | NULL, NULL, 0); | |
2647 | } | |
2648 | ||
e971aa12 JC |
2649 | /* |
2650 | * Reopen multiple BlockDriverStates atomically & transactionally. | |
2651 | * | |
2652 | * The queue passed in (bs_queue) must have been built up previous | |
2653 | * via bdrv_reopen_queue(). | |
2654 | * | |
2655 | * Reopens all BDS specified in the queue, with the appropriate | |
2656 | * flags. All devices are prepared for reopen, and failure of any | |
2657 | * device will cause all device changes to be abandonded, and intermediate | |
2658 | * data cleaned up. | |
2659 | * | |
2660 | * If all devices prepare successfully, then the changes are committed | |
2661 | * to all devices. | |
2662 | * | |
2663 | */ | |
720150f3 | 2664 | int bdrv_reopen_multiple(AioContext *ctx, BlockReopenQueue *bs_queue, Error **errp) |
e971aa12 JC |
2665 | { |
2666 | int ret = -1; | |
2667 | BlockReopenQueueEntry *bs_entry, *next; | |
2668 | Error *local_err = NULL; | |
2669 | ||
2670 | assert(bs_queue != NULL); | |
2671 | ||
c9d1a561 | 2672 | aio_context_release(ctx); |
40840e41 | 2673 | bdrv_drain_all_begin(); |
c9d1a561 | 2674 | aio_context_acquire(ctx); |
e971aa12 JC |
2675 | |
2676 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { | |
2677 | if (bdrv_reopen_prepare(&bs_entry->state, bs_queue, &local_err)) { | |
2678 | error_propagate(errp, local_err); | |
2679 | goto cleanup; | |
2680 | } | |
2681 | bs_entry->prepared = true; | |
2682 | } | |
2683 | ||
2684 | /* If we reach this point, we have success and just need to apply the | |
2685 | * changes | |
2686 | */ | |
2687 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { | |
2688 | bdrv_reopen_commit(&bs_entry->state); | |
2689 | } | |
2690 | ||
2691 | ret = 0; | |
2692 | ||
2693 | cleanup: | |
2694 | QSIMPLEQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) { | |
2695 | if (ret && bs_entry->prepared) { | |
2696 | bdrv_reopen_abort(&bs_entry->state); | |
145f598e KW |
2697 | } else if (ret) { |
2698 | QDECREF(bs_entry->state.explicit_options); | |
e971aa12 | 2699 | } |
4d2cb092 | 2700 | QDECREF(bs_entry->state.options); |
e971aa12 JC |
2701 | g_free(bs_entry); |
2702 | } | |
2703 | g_free(bs_queue); | |
40840e41 AG |
2704 | |
2705 | bdrv_drain_all_end(); | |
2706 | ||
e971aa12 JC |
2707 | return ret; |
2708 | } | |
2709 | ||
2710 | ||
2711 | /* Reopen a single BlockDriverState with the specified flags. */ | |
2712 | int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp) | |
2713 | { | |
2714 | int ret = -1; | |
2715 | Error *local_err = NULL; | |
4d2cb092 | 2716 | BlockReopenQueue *queue = bdrv_reopen_queue(NULL, bs, NULL, bdrv_flags); |
e971aa12 | 2717 | |
720150f3 | 2718 | ret = bdrv_reopen_multiple(bdrv_get_aio_context(bs), queue, &local_err); |
e971aa12 JC |
2719 | if (local_err != NULL) { |
2720 | error_propagate(errp, local_err); | |
2721 | } | |
2722 | return ret; | |
2723 | } | |
2724 | ||
2725 | ||
2726 | /* | |
2727 | * Prepares a BlockDriverState for reopen. All changes are staged in the | |
2728 | * 'opaque' field of the BDRVReopenState, which is used and allocated by | |
2729 | * the block driver layer .bdrv_reopen_prepare() | |
2730 | * | |
2731 | * bs is the BlockDriverState to reopen | |
2732 | * flags are the new open flags | |
2733 | * queue is the reopen queue | |
2734 | * | |
2735 | * Returns 0 on success, non-zero on error. On error errp will be set | |
2736 | * as well. | |
2737 | * | |
2738 | * On failure, bdrv_reopen_abort() will be called to clean up any data. | |
2739 | * It is the responsibility of the caller to then call the abort() or | |
2740 | * commit() for any other BDS that have been left in a prepare() state | |
2741 | * | |
2742 | */ | |
2743 | int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue, | |
2744 | Error **errp) | |
2745 | { | |
2746 | int ret = -1; | |
2747 | Error *local_err = NULL; | |
2748 | BlockDriver *drv; | |
ccf9dc07 KW |
2749 | QemuOpts *opts; |
2750 | const char *value; | |
e971aa12 JC |
2751 | |
2752 | assert(reopen_state != NULL); | |
2753 | assert(reopen_state->bs->drv != NULL); | |
2754 | drv = reopen_state->bs->drv; | |
2755 | ||
ccf9dc07 KW |
2756 | /* Process generic block layer options */ |
2757 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); | |
2758 | qemu_opts_absorb_qdict(opts, reopen_state->options, &local_err); | |
2759 | if (local_err) { | |
2760 | error_propagate(errp, local_err); | |
2761 | ret = -EINVAL; | |
2762 | goto error; | |
2763 | } | |
2764 | ||
91a097e7 KW |
2765 | update_flags_from_options(&reopen_state->flags, opts); |
2766 | ||
ccf9dc07 KW |
2767 | /* node-name and driver must be unchanged. Put them back into the QDict, so |
2768 | * that they are checked at the end of this function. */ | |
2769 | value = qemu_opt_get(opts, "node-name"); | |
2770 | if (value) { | |
2771 | qdict_put(reopen_state->options, "node-name", qstring_from_str(value)); | |
2772 | } | |
2773 | ||
2774 | value = qemu_opt_get(opts, "driver"); | |
2775 | if (value) { | |
2776 | qdict_put(reopen_state->options, "driver", qstring_from_str(value)); | |
2777 | } | |
2778 | ||
e971aa12 JC |
2779 | /* if we are to stay read-only, do not allow permission change |
2780 | * to r/w */ | |
2781 | if (!(reopen_state->bs->open_flags & BDRV_O_ALLOW_RDWR) && | |
2782 | reopen_state->flags & BDRV_O_RDWR) { | |
81e5f78a AG |
2783 | error_setg(errp, "Node '%s' is read only", |
2784 | bdrv_get_device_or_node_name(reopen_state->bs)); | |
e971aa12 JC |
2785 | goto error; |
2786 | } | |
2787 | ||
2788 | ||
2789 | ret = bdrv_flush(reopen_state->bs); | |
2790 | if (ret) { | |
455b0fde | 2791 | error_setg_errno(errp, -ret, "Error flushing drive"); |
e971aa12 JC |
2792 | goto error; |
2793 | } | |
2794 | ||
2795 | if (drv->bdrv_reopen_prepare) { | |
2796 | ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err); | |
2797 | if (ret) { | |
2798 | if (local_err != NULL) { | |
2799 | error_propagate(errp, local_err); | |
2800 | } else { | |
d8b6895f LC |
2801 | error_setg(errp, "failed while preparing to reopen image '%s'", |
2802 | reopen_state->bs->filename); | |
e971aa12 JC |
2803 | } |
2804 | goto error; | |
2805 | } | |
2806 | } else { | |
2807 | /* It is currently mandatory to have a bdrv_reopen_prepare() | |
2808 | * handler for each supported drv. */ | |
81e5f78a AG |
2809 | error_setg(errp, "Block format '%s' used by node '%s' " |
2810 | "does not support reopening files", drv->format_name, | |
2811 | bdrv_get_device_or_node_name(reopen_state->bs)); | |
e971aa12 JC |
2812 | ret = -1; |
2813 | goto error; | |
2814 | } | |
2815 | ||
4d2cb092 KW |
2816 | /* Options that are not handled are only okay if they are unchanged |
2817 | * compared to the old state. It is expected that some options are only | |
2818 | * used for the initial open, but not reopen (e.g. filename) */ | |
2819 | if (qdict_size(reopen_state->options)) { | |
2820 | const QDictEntry *entry = qdict_first(reopen_state->options); | |
2821 | ||
2822 | do { | |
2823 | QString *new_obj = qobject_to_qstring(entry->value); | |
2824 | const char *new = qstring_get_str(new_obj); | |
129c7d1c MA |
2825 | /* |
2826 | * Caution: while qdict_get_try_str() is fine, getting | |
2827 | * non-string types would require more care. When | |
2828 | * bs->options come from -blockdev or blockdev_add, its | |
2829 | * members are typed according to the QAPI schema, but | |
2830 | * when they come from -drive, they're all QString. | |
2831 | */ | |
4d2cb092 KW |
2832 | const char *old = qdict_get_try_str(reopen_state->bs->options, |
2833 | entry->key); | |
2834 | ||
2835 | if (!old || strcmp(new, old)) { | |
2836 | error_setg(errp, "Cannot change the option '%s'", entry->key); | |
2837 | ret = -EINVAL; | |
2838 | goto error; | |
2839 | } | |
2840 | } while ((entry = qdict_next(reopen_state->options, entry))); | |
2841 | } | |
2842 | ||
e971aa12 JC |
2843 | ret = 0; |
2844 | ||
2845 | error: | |
ccf9dc07 | 2846 | qemu_opts_del(opts); |
e971aa12 JC |
2847 | return ret; |
2848 | } | |
2849 | ||
2850 | /* | |
2851 | * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and | |
2852 | * makes them final by swapping the staging BlockDriverState contents into | |
2853 | * the active BlockDriverState contents. | |
2854 | */ | |
2855 | void bdrv_reopen_commit(BDRVReopenState *reopen_state) | |
2856 | { | |
2857 | BlockDriver *drv; | |
2858 | ||
2859 | assert(reopen_state != NULL); | |
2860 | drv = reopen_state->bs->drv; | |
2861 | assert(drv != NULL); | |
2862 | ||
2863 | /* If there are any driver level actions to take */ | |
2864 | if (drv->bdrv_reopen_commit) { | |
2865 | drv->bdrv_reopen_commit(reopen_state); | |
2866 | } | |
2867 | ||
2868 | /* set BDS specific flags now */ | |
145f598e KW |
2869 | QDECREF(reopen_state->bs->explicit_options); |
2870 | ||
2871 | reopen_state->bs->explicit_options = reopen_state->explicit_options; | |
e971aa12 | 2872 | reopen_state->bs->open_flags = reopen_state->flags; |
e971aa12 | 2873 | reopen_state->bs->read_only = !(reopen_state->flags & BDRV_O_RDWR); |
355ef4ac | 2874 | |
3baca891 | 2875 | bdrv_refresh_limits(reopen_state->bs, NULL); |
e971aa12 JC |
2876 | } |
2877 | ||
2878 | /* | |
2879 | * Abort the reopen, and delete and free the staged changes in | |
2880 | * reopen_state | |
2881 | */ | |
2882 | void bdrv_reopen_abort(BDRVReopenState *reopen_state) | |
2883 | { | |
2884 | BlockDriver *drv; | |
2885 | ||
2886 | assert(reopen_state != NULL); | |
2887 | drv = reopen_state->bs->drv; | |
2888 | assert(drv != NULL); | |
2889 | ||
2890 | if (drv->bdrv_reopen_abort) { | |
2891 | drv->bdrv_reopen_abort(reopen_state); | |
2892 | } | |
145f598e KW |
2893 | |
2894 | QDECREF(reopen_state->explicit_options); | |
e971aa12 JC |
2895 | } |
2896 | ||
2897 | ||
64dff520 | 2898 | static void bdrv_close(BlockDriverState *bs) |
fc01f7e7 | 2899 | { |
33384421 HR |
2900 | BdrvAioNotifier *ban, *ban_next; |
2901 | ||
ca9bd24c | 2902 | assert(!bs->job); |
30f55fb8 | 2903 | assert(!bs->refcnt); |
99b7e775 | 2904 | |
fc27291d | 2905 | bdrv_drained_begin(bs); /* complete I/O */ |
58fda173 | 2906 | bdrv_flush(bs); |
53ec73e2 | 2907 | bdrv_drain(bs); /* in case flush left pending I/O */ |
fc27291d | 2908 | |
c5acdc9a HR |
2909 | bdrv_release_named_dirty_bitmaps(bs); |
2910 | assert(QLIST_EMPTY(&bs->dirty_bitmaps)); | |
2911 | ||
3cbc002c | 2912 | if (bs->drv) { |
6e93e7c4 KW |
2913 | BdrvChild *child, *next; |
2914 | ||
9a7dedbc | 2915 | bs->drv->bdrv_close(bs); |
9a4f4c31 | 2916 | bs->drv = NULL; |
9a7dedbc | 2917 | |
12fa4af6 | 2918 | bdrv_set_backing_hd(bs, NULL, &error_abort); |
9a7dedbc | 2919 | |
9a4f4c31 KW |
2920 | if (bs->file != NULL) { |
2921 | bdrv_unref_child(bs, bs->file); | |
2922 | bs->file = NULL; | |
2923 | } | |
2924 | ||
6e93e7c4 | 2925 | QLIST_FOREACH_SAFE(child, &bs->children, next, next) { |
33a60407 KW |
2926 | /* TODO Remove bdrv_unref() from drivers' close function and use |
2927 | * bdrv_unref_child() here */ | |
bddcec37 KW |
2928 | if (child->bs->inherits_from == bs) { |
2929 | child->bs->inherits_from = NULL; | |
2930 | } | |
33a60407 | 2931 | bdrv_detach_child(child); |
6e93e7c4 KW |
2932 | } |
2933 | ||
7267c094 | 2934 | g_free(bs->opaque); |
ea2384d3 | 2935 | bs->opaque = NULL; |
53fec9d3 | 2936 | bs->copy_on_read = 0; |
a275fa42 PB |
2937 | bs->backing_file[0] = '\0'; |
2938 | bs->backing_format[0] = '\0'; | |
6405875c | 2939 | bs->total_sectors = 0; |
54115412 EB |
2940 | bs->encrypted = false; |
2941 | bs->valid_key = false; | |
2942 | bs->sg = false; | |
de9c0cec | 2943 | QDECREF(bs->options); |
145f598e | 2944 | QDECREF(bs->explicit_options); |
de9c0cec | 2945 | bs->options = NULL; |
91af7014 HR |
2946 | QDECREF(bs->full_open_options); |
2947 | bs->full_open_options = NULL; | |
b338082b | 2948 | } |
98f90dba | 2949 | |
33384421 HR |
2950 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { |
2951 | g_free(ban); | |
2952 | } | |
2953 | QLIST_INIT(&bs->aio_notifiers); | |
fc27291d | 2954 | bdrv_drained_end(bs); |
b338082b FB |
2955 | } |
2956 | ||
2bc93fed MK |
2957 | void bdrv_close_all(void) |
2958 | { | |
a1a2af07 | 2959 | block_job_cancel_sync_all(); |
cd7fca95 | 2960 | nbd_export_close_all(); |
ca9bd24c HR |
2961 | |
2962 | /* Drop references from requests still in flight, such as canceled block | |
2963 | * jobs whose AIO context has not been polled yet */ | |
2964 | bdrv_drain_all(); | |
2bc93fed | 2965 | |
ca9bd24c HR |
2966 | blk_remove_all_bs(); |
2967 | blockdev_close_all_bdrv_states(); | |
ed78cda3 | 2968 | |
a1a2af07 | 2969 | assert(QTAILQ_EMPTY(&all_bdrv_states)); |
2bc93fed MK |
2970 | } |
2971 | ||
d0ac0380 KW |
2972 | static bool should_update_child(BdrvChild *c, BlockDriverState *to) |
2973 | { | |
2974 | BdrvChild *to_c; | |
2975 | ||
2976 | if (c->role->stay_at_node) { | |
2977 | return false; | |
2978 | } | |
2979 | ||
2980 | if (c->role == &child_backing) { | |
2981 | /* If @from is a backing file of @to, ignore the child to avoid | |
2982 | * creating a loop. We only want to change the pointer of other | |
2983 | * parents. */ | |
2984 | QLIST_FOREACH(to_c, &to->children, next) { | |
2985 | if (to_c == c) { | |
2986 | break; | |
2987 | } | |
2988 | } | |
2989 | if (to_c) { | |
2990 | return false; | |
2991 | } | |
2992 | } | |
2993 | ||
2994 | return true; | |
2995 | } | |
2996 | ||
5fe31c25 KW |
2997 | void bdrv_replace_node(BlockDriverState *from, BlockDriverState *to, |
2998 | Error **errp) | |
dd62f1ca | 2999 | { |
d0ac0380 | 3000 | BdrvChild *c, *next; |
234ac1a9 KW |
3001 | GSList *list = NULL, *p; |
3002 | uint64_t old_perm, old_shared; | |
3003 | uint64_t perm = 0, shared = BLK_PERM_ALL; | |
3004 | int ret; | |
3005 | ||
5fe31c25 KW |
3006 | assert(!atomic_read(&from->in_flight)); |
3007 | assert(!atomic_read(&to->in_flight)); | |
dd62f1ca | 3008 | |
234ac1a9 KW |
3009 | /* Make sure that @from doesn't go away until we have successfully attached |
3010 | * all of its parents to @to. */ | |
3011 | bdrv_ref(from); | |
dd62f1ca | 3012 | |
234ac1a9 | 3013 | /* Put all parents into @list and calculate their cumulative permissions */ |
dd62f1ca | 3014 | QLIST_FOREACH_SAFE(c, &from->parents, next_parent, next) { |
d0ac0380 | 3015 | if (!should_update_child(c, to)) { |
26de9438 KW |
3016 | continue; |
3017 | } | |
234ac1a9 KW |
3018 | list = g_slist_prepend(list, c); |
3019 | perm |= c->perm; | |
3020 | shared &= c->shared_perm; | |
3021 | } | |
3022 | ||
3023 | /* Check whether the required permissions can be granted on @to, ignoring | |
3024 | * all BdrvChild in @list so that they can't block themselves. */ | |
3025 | ret = bdrv_check_update_perm(to, perm, shared, list, errp); | |
3026 | if (ret < 0) { | |
3027 | bdrv_abort_perm_update(to); | |
3028 | goto out; | |
3029 | } | |
3030 | ||
3031 | /* Now actually perform the change. We performed the permission check for | |
3032 | * all elements of @list at once, so set the permissions all at once at the | |
3033 | * very end. */ | |
3034 | for (p = list; p != NULL; p = p->next) { | |
3035 | c = p->data; | |
9bd910e2 | 3036 | |
dd62f1ca | 3037 | bdrv_ref(to); |
234ac1a9 | 3038 | bdrv_replace_child_noperm(c, to); |
dd62f1ca KW |
3039 | bdrv_unref(from); |
3040 | } | |
234ac1a9 KW |
3041 | |
3042 | bdrv_get_cumulative_perm(to, &old_perm, &old_shared); | |
3043 | bdrv_set_perm(to, old_perm | perm, old_shared | shared); | |
3044 | ||
3045 | out: | |
3046 | g_slist_free(list); | |
3047 | bdrv_unref(from); | |
dd62f1ca KW |
3048 | } |
3049 | ||
4ddc07ca PB |
3050 | /* |
3051 | * Add new bs contents at the top of an image chain while the chain is | |
3052 | * live, while keeping required fields on the top layer. | |
3053 | * | |
3054 | * This will modify the BlockDriverState fields, and swap contents | |
3055 | * between bs_new and bs_top. Both bs_new and bs_top are modified. | |
3056 | * | |
bfb197e0 | 3057 | * bs_new must not be attached to a BlockBackend. |
4ddc07ca PB |
3058 | * |
3059 | * This function does not create any image files. | |
dd62f1ca KW |
3060 | * |
3061 | * bdrv_append() takes ownership of a bs_new reference and unrefs it because | |
3062 | * that's what the callers commonly need. bs_new will be referenced by the old | |
3063 | * parents of bs_top after bdrv_append() returns. If the caller needs to keep a | |
3064 | * reference of its own, it must call bdrv_ref(). | |
4ddc07ca | 3065 | */ |
b2c2832c KW |
3066 | void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top, |
3067 | Error **errp) | |
4ddc07ca | 3068 | { |
b2c2832c KW |
3069 | Error *local_err = NULL; |
3070 | ||
b2c2832c KW |
3071 | bdrv_set_backing_hd(bs_new, bs_top, &local_err); |
3072 | if (local_err) { | |
3073 | error_propagate(errp, local_err); | |
3074 | goto out; | |
3075 | } | |
dd62f1ca | 3076 | |
5fe31c25 | 3077 | bdrv_replace_node(bs_top, bs_new, &local_err); |
234ac1a9 KW |
3078 | if (local_err) { |
3079 | error_propagate(errp, local_err); | |
3080 | bdrv_set_backing_hd(bs_new, NULL, &error_abort); | |
3081 | goto out; | |
3082 | } | |
4ddc07ca | 3083 | |
dd62f1ca KW |
3084 | /* bs_new is now referenced by its new parents, we don't need the |
3085 | * additional reference any more. */ | |
b2c2832c | 3086 | out: |
dd62f1ca | 3087 | bdrv_unref(bs_new); |
8802d1fd JC |
3088 | } |
3089 | ||
4f6fd349 | 3090 | static void bdrv_delete(BlockDriverState *bs) |
b338082b | 3091 | { |
3e914655 | 3092 | assert(!bs->job); |
3718d8ab | 3093 | assert(bdrv_op_blocker_is_empty(bs)); |
4f6fd349 | 3094 | assert(!bs->refcnt); |
18846dee | 3095 | |
e1b5c52e SH |
3096 | bdrv_close(bs); |
3097 | ||
1b7bdbc1 | 3098 | /* remove from list, if necessary */ |
63eaaae0 KW |
3099 | if (bs->node_name[0] != '\0') { |
3100 | QTAILQ_REMOVE(&graph_bdrv_states, bs, node_list); | |
3101 | } | |
2c1d04e0 HR |
3102 | QTAILQ_REMOVE(&all_bdrv_states, bs, bs_list); |
3103 | ||
7267c094 | 3104 | g_free(bs); |
fc01f7e7 FB |
3105 | } |
3106 | ||
e97fc193 AL |
3107 | /* |
3108 | * Run consistency checks on an image | |
3109 | * | |
e076f338 | 3110 | * Returns 0 if the check could be completed (it doesn't mean that the image is |
a1c7273b | 3111 | * free of errors) or -errno when an internal error occurred. The results of the |
e076f338 | 3112 | * check are stored in res. |
e97fc193 | 3113 | */ |
4534ff54 | 3114 | int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix) |
e97fc193 | 3115 | { |
908bcd54 HR |
3116 | if (bs->drv == NULL) { |
3117 | return -ENOMEDIUM; | |
3118 | } | |
e97fc193 AL |
3119 | if (bs->drv->bdrv_check == NULL) { |
3120 | return -ENOTSUP; | |
3121 | } | |
3122 | ||
e076f338 | 3123 | memset(res, 0, sizeof(*res)); |
4534ff54 | 3124 | return bs->drv->bdrv_check(bs, res, fix); |
e97fc193 AL |
3125 | } |
3126 | ||
756e6736 KW |
3127 | /* |
3128 | * Return values: | |
3129 | * 0 - success | |
3130 | * -EINVAL - backing format specified, but no file | |
3131 | * -ENOSPC - can't update the backing file because no space is left in the | |
3132 | * image file header | |
3133 | * -ENOTSUP - format driver doesn't support changing the backing file | |
3134 | */ | |
3135 | int bdrv_change_backing_file(BlockDriverState *bs, | |
3136 | const char *backing_file, const char *backing_fmt) | |
3137 | { | |
3138 | BlockDriver *drv = bs->drv; | |
469ef350 | 3139 | int ret; |
756e6736 | 3140 | |
5f377794 PB |
3141 | /* Backing file format doesn't make sense without a backing file */ |
3142 | if (backing_fmt && !backing_file) { | |
3143 | return -EINVAL; | |
3144 | } | |
3145 | ||
756e6736 | 3146 | if (drv->bdrv_change_backing_file != NULL) { |
469ef350 | 3147 | ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt); |
756e6736 | 3148 | } else { |
469ef350 | 3149 | ret = -ENOTSUP; |
756e6736 | 3150 | } |
469ef350 PB |
3151 | |
3152 | if (ret == 0) { | |
3153 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: ""); | |
3154 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: ""); | |
3155 | } | |
3156 | return ret; | |
756e6736 KW |
3157 | } |
3158 | ||
6ebdcee2 JC |
3159 | /* |
3160 | * Finds the image layer in the chain that has 'bs' as its backing file. | |
3161 | * | |
3162 | * active is the current topmost image. | |
3163 | * | |
3164 | * Returns NULL if bs is not found in active's image chain, | |
3165 | * or if active == bs. | |
4caf0fcd JC |
3166 | * |
3167 | * Returns the bottommost base image if bs == NULL. | |
6ebdcee2 JC |
3168 | */ |
3169 | BlockDriverState *bdrv_find_overlay(BlockDriverState *active, | |
3170 | BlockDriverState *bs) | |
3171 | { | |
760e0063 KW |
3172 | while (active && bs != backing_bs(active)) { |
3173 | active = backing_bs(active); | |
6ebdcee2 JC |
3174 | } |
3175 | ||
4caf0fcd JC |
3176 | return active; |
3177 | } | |
6ebdcee2 | 3178 | |
4caf0fcd JC |
3179 | /* Given a BDS, searches for the base layer. */ |
3180 | BlockDriverState *bdrv_find_base(BlockDriverState *bs) | |
3181 | { | |
3182 | return bdrv_find_overlay(bs, NULL); | |
6ebdcee2 JC |
3183 | } |
3184 | ||
6ebdcee2 JC |
3185 | /* |
3186 | * Drops images above 'base' up to and including 'top', and sets the image | |
3187 | * above 'top' to have base as its backing file. | |
3188 | * | |
3189 | * Requires that the overlay to 'top' is opened r/w, so that the backing file | |
3190 | * information in 'bs' can be properly updated. | |
3191 | * | |
3192 | * E.g., this will convert the following chain: | |
3193 | * bottom <- base <- intermediate <- top <- active | |
3194 | * | |
3195 | * to | |
3196 | * | |
3197 | * bottom <- base <- active | |
3198 | * | |
3199 | * It is allowed for bottom==base, in which case it converts: | |
3200 | * | |
3201 | * base <- intermediate <- top <- active | |
3202 | * | |
3203 | * to | |
3204 | * | |
3205 | * base <- active | |
3206 | * | |
54e26900 JC |
3207 | * If backing_file_str is non-NULL, it will be used when modifying top's |
3208 | * overlay image metadata. | |
3209 | * | |
6ebdcee2 JC |
3210 | * Error conditions: |
3211 | * if active == top, that is considered an error | |
3212 | * | |
3213 | */ | |
3214 | int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top, | |
54e26900 | 3215 | BlockDriverState *base, const char *backing_file_str) |
6ebdcee2 | 3216 | { |
6ebdcee2 | 3217 | BlockDriverState *new_top_bs = NULL; |
12fa4af6 | 3218 | Error *local_err = NULL; |
6ebdcee2 JC |
3219 | int ret = -EIO; |
3220 | ||
6ebdcee2 JC |
3221 | if (!top->drv || !base->drv) { |
3222 | goto exit; | |
3223 | } | |
3224 | ||
3225 | new_top_bs = bdrv_find_overlay(active, top); | |
3226 | ||
3227 | if (new_top_bs == NULL) { | |
3228 | /* we could not find the image above 'top', this is an error */ | |
3229 | goto exit; | |
3230 | } | |
3231 | ||
760e0063 | 3232 | /* special case of new_top_bs->backing->bs already pointing to base - nothing |
6ebdcee2 | 3233 | * to do, no intermediate images */ |
760e0063 | 3234 | if (backing_bs(new_top_bs) == base) { |
6ebdcee2 JC |
3235 | ret = 0; |
3236 | goto exit; | |
3237 | } | |
3238 | ||
5db15a57 KW |
3239 | /* Make sure that base is in the backing chain of top */ |
3240 | if (!bdrv_chain_contains(top, base)) { | |
6ebdcee2 JC |
3241 | goto exit; |
3242 | } | |
3243 | ||
3244 | /* success - we can delete the intermediate states, and link top->base */ | |
5db15a57 | 3245 | backing_file_str = backing_file_str ? backing_file_str : base->filename; |
54e26900 | 3246 | ret = bdrv_change_backing_file(new_top_bs, backing_file_str, |
5db15a57 | 3247 | base->drv ? base->drv->format_name : ""); |
6ebdcee2 JC |
3248 | if (ret) { |
3249 | goto exit; | |
3250 | } | |
12fa4af6 KW |
3251 | |
3252 | bdrv_set_backing_hd(new_top_bs, base, &local_err); | |
3253 | if (local_err) { | |
3254 | ret = -EPERM; | |
3255 | error_report_err(local_err); | |
3256 | goto exit; | |
3257 | } | |
6ebdcee2 | 3258 | |
6ebdcee2 | 3259 | ret = 0; |
6ebdcee2 | 3260 | exit: |
6ebdcee2 JC |
3261 | return ret; |
3262 | } | |
3263 | ||
61007b31 SH |
3264 | /** |
3265 | * Truncate file to 'offset' bytes (needed only for file protocols) | |
3266 | */ | |
52cdbc58 | 3267 | int bdrv_truncate(BdrvChild *child, int64_t offset) |
71d0770c | 3268 | { |
52cdbc58 | 3269 | BlockDriverState *bs = child->bs; |
61007b31 SH |
3270 | BlockDriver *drv = bs->drv; |
3271 | int ret; | |
c8f6d58e KW |
3272 | |
3273 | assert(child->perm & BLK_PERM_RESIZE); | |
3274 | ||
61007b31 | 3275 | if (!drv) |
71d0770c | 3276 | return -ENOMEDIUM; |
61007b31 SH |
3277 | if (!drv->bdrv_truncate) |
3278 | return -ENOTSUP; | |
3279 | if (bs->read_only) | |
3280 | return -EACCES; | |
71d0770c | 3281 | |
61007b31 SH |
3282 | ret = drv->bdrv_truncate(bs, offset); |
3283 | if (ret == 0) { | |
3284 | ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS); | |
3285 | bdrv_dirty_bitmap_truncate(bs); | |
5c8cab48 | 3286 | bdrv_parent_cb_resize(bs); |
3ff2f67a | 3287 | ++bs->write_gen; |
c0191e76 | 3288 | } |
61007b31 | 3289 | return ret; |
71d0770c AL |
3290 | } |
3291 | ||
61007b31 SH |
3292 | /** |
3293 | * Length of a allocated file in bytes. Sparse files are counted by actual | |
3294 | * allocated space. Return < 0 if error or unknown. | |
3295 | */ | |
3296 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs) | |
71d0770c | 3297 | { |
61007b31 SH |
3298 | BlockDriver *drv = bs->drv; |
3299 | if (!drv) { | |
3300 | return -ENOMEDIUM; | |
8f4754ed | 3301 | } |
61007b31 SH |
3302 | if (drv->bdrv_get_allocated_file_size) { |
3303 | return drv->bdrv_get_allocated_file_size(bs); | |
3304 | } | |
3305 | if (bs->file) { | |
9a4f4c31 | 3306 | return bdrv_get_allocated_file_size(bs->file->bs); |
1c9805a3 | 3307 | } |
61007b31 | 3308 | return -ENOTSUP; |
1c9805a3 | 3309 | } |
e7a8a783 | 3310 | |
61007b31 SH |
3311 | /** |
3312 | * Return number of sectors on success, -errno on error. | |
1c9805a3 | 3313 | */ |
61007b31 | 3314 | int64_t bdrv_nb_sectors(BlockDriverState *bs) |
1c9805a3 | 3315 | { |
61007b31 | 3316 | BlockDriver *drv = bs->drv; |
498e386c | 3317 | |
61007b31 SH |
3318 | if (!drv) |
3319 | return -ENOMEDIUM; | |
2572b37a | 3320 | |
61007b31 SH |
3321 | if (drv->has_variable_length) { |
3322 | int ret = refresh_total_sectors(bs, bs->total_sectors); | |
3323 | if (ret < 0) { | |
3324 | return ret; | |
1c9805a3 SH |
3325 | } |
3326 | } | |
61007b31 | 3327 | return bs->total_sectors; |
1c9805a3 | 3328 | } |
b338082b | 3329 | |
61007b31 SH |
3330 | /** |
3331 | * Return length in bytes on success, -errno on error. | |
3332 | * The length is always a multiple of BDRV_SECTOR_SIZE. | |
8d3b1a2d | 3333 | */ |
61007b31 | 3334 | int64_t bdrv_getlength(BlockDriverState *bs) |
8d3b1a2d | 3335 | { |
61007b31 | 3336 | int64_t ret = bdrv_nb_sectors(bs); |
8d3b1a2d | 3337 | |
4a9c9ea0 | 3338 | ret = ret > INT64_MAX / BDRV_SECTOR_SIZE ? -EFBIG : ret; |
61007b31 | 3339 | return ret < 0 ? ret : ret * BDRV_SECTOR_SIZE; |
fc01f7e7 FB |
3340 | } |
3341 | ||
61007b31 SH |
3342 | /* return 0 as number of sectors if no device present or error */ |
3343 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr) | |
07d27a44 | 3344 | { |
61007b31 | 3345 | int64_t nb_sectors = bdrv_nb_sectors(bs); |
07d27a44 | 3346 | |
61007b31 | 3347 | *nb_sectors_ptr = nb_sectors < 0 ? 0 : nb_sectors; |
07d27a44 MA |
3348 | } |
3349 | ||
54115412 | 3350 | bool bdrv_is_read_only(BlockDriverState *bs) |
8d3b1a2d | 3351 | { |
61007b31 | 3352 | return bs->read_only; |
83f64091 | 3353 | } |
83f64091 | 3354 | |
54115412 | 3355 | bool bdrv_is_sg(BlockDriverState *bs) |
f08145fe | 3356 | { |
61007b31 | 3357 | return bs->sg; |
f08145fe KW |
3358 | } |
3359 | ||
54115412 | 3360 | bool bdrv_is_encrypted(BlockDriverState *bs) |
fc3959e4 | 3361 | { |
760e0063 | 3362 | if (bs->backing && bs->backing->bs->encrypted) { |
54115412 | 3363 | return true; |
760e0063 | 3364 | } |
61007b31 | 3365 | return bs->encrypted; |
fc3959e4 FZ |
3366 | } |
3367 | ||
54115412 | 3368 | bool bdrv_key_required(BlockDriverState *bs) |
fc3959e4 | 3369 | { |
760e0063 | 3370 | BdrvChild *backing = bs->backing; |
61007b31 | 3371 | |
760e0063 | 3372 | if (backing && backing->bs->encrypted && !backing->bs->valid_key) { |
54115412 | 3373 | return true; |
760e0063 | 3374 | } |
61007b31 | 3375 | return (bs->encrypted && !bs->valid_key); |
fc3959e4 FZ |
3376 | } |
3377 | ||
61007b31 | 3378 | int bdrv_set_key(BlockDriverState *bs, const char *key) |
d0c7f642 | 3379 | { |
d0c7f642 | 3380 | int ret; |
760e0063 KW |
3381 | if (bs->backing && bs->backing->bs->encrypted) { |
3382 | ret = bdrv_set_key(bs->backing->bs, key); | |
61007b31 SH |
3383 | if (ret < 0) |
3384 | return ret; | |
3385 | if (!bs->encrypted) | |
3386 | return 0; | |
3387 | } | |
3388 | if (!bs->encrypted) { | |
3389 | return -EINVAL; | |
3390 | } else if (!bs->drv || !bs->drv->bdrv_set_key) { | |
d0c7f642 KW |
3391 | return -ENOMEDIUM; |
3392 | } | |
61007b31 | 3393 | ret = bs->drv->bdrv_set_key(bs, key); |
b9c64947 | 3394 | if (ret < 0) { |
54115412 | 3395 | bs->valid_key = false; |
61007b31 | 3396 | } else if (!bs->valid_key) { |
5c8cab48 | 3397 | /* call the change callback now, we skipped it on open */ |
54115412 | 3398 | bs->valid_key = true; |
5c8cab48 | 3399 | bdrv_parent_cb_change_media(bs, true); |
1b0288ae | 3400 | } |
61007b31 SH |
3401 | return ret; |
3402 | } | |
f08f2dda | 3403 | |
c5fbe571 | 3404 | /* |
61007b31 SH |
3405 | * Provide an encryption key for @bs. |
3406 | * If @key is non-null: | |
3407 | * If @bs is not encrypted, fail. | |
3408 | * Else if the key is invalid, fail. | |
3409 | * Else set @bs's key to @key, replacing the existing key, if any. | |
3410 | * If @key is null: | |
3411 | * If @bs is encrypted and still lacks a key, fail. | |
3412 | * Else do nothing. | |
3413 | * On failure, store an error object through @errp if non-null. | |
c5fbe571 | 3414 | */ |
61007b31 | 3415 | void bdrv_add_key(BlockDriverState *bs, const char *key, Error **errp) |
c5fbe571 | 3416 | { |
61007b31 SH |
3417 | if (key) { |
3418 | if (!bdrv_is_encrypted(bs)) { | |
3419 | error_setg(errp, "Node '%s' is not encrypted", | |
3420 | bdrv_get_device_or_node_name(bs)); | |
3421 | } else if (bdrv_set_key(bs, key) < 0) { | |
c6bd8c70 | 3422 | error_setg(errp, QERR_INVALID_PASSWORD); |
4d2855a3 MA |
3423 | } |
3424 | } else { | |
3425 | if (bdrv_key_required(bs)) { | |
b1ca6391 MA |
3426 | error_set(errp, ERROR_CLASS_DEVICE_ENCRYPTED, |
3427 | "'%s' (%s) is encrypted", | |
81e5f78a | 3428 | bdrv_get_device_or_node_name(bs), |
4d2855a3 MA |
3429 | bdrv_get_encrypted_filename(bs)); |
3430 | } | |
3431 | } | |
3432 | } | |
3433 | ||
61007b31 | 3434 | const char *bdrv_get_format_name(BlockDriverState *bs) |
40b4f539 | 3435 | { |
61007b31 | 3436 | return bs->drv ? bs->drv->format_name : NULL; |
40b4f539 KW |
3437 | } |
3438 | ||
61007b31 | 3439 | static int qsort_strcmp(const void *a, const void *b) |
40b4f539 | 3440 | { |
ceff5bd7 | 3441 | return strcmp(*(char *const *)a, *(char *const *)b); |
40b4f539 KW |
3442 | } |
3443 | ||
61007b31 SH |
3444 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
3445 | void *opaque) | |
40b4f539 | 3446 | { |
61007b31 SH |
3447 | BlockDriver *drv; |
3448 | int count = 0; | |
3449 | int i; | |
3450 | const char **formats = NULL; | |
40b4f539 | 3451 | |
61007b31 SH |
3452 | QLIST_FOREACH(drv, &bdrv_drivers, list) { |
3453 | if (drv->format_name) { | |
3454 | bool found = false; | |
3455 | int i = count; | |
3456 | while (formats && i && !found) { | |
3457 | found = !strcmp(formats[--i], drv->format_name); | |
3458 | } | |
e2a305fb | 3459 | |
61007b31 SH |
3460 | if (!found) { |
3461 | formats = g_renew(const char *, formats, count + 1); | |
3462 | formats[count++] = drv->format_name; | |
3463 | } | |
6c5a42ac | 3464 | } |
61007b31 | 3465 | } |
6c5a42ac | 3466 | |
eb0df69f HR |
3467 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); i++) { |
3468 | const char *format_name = block_driver_modules[i].format_name; | |
3469 | ||
3470 | if (format_name) { | |
3471 | bool found = false; | |
3472 | int j = count; | |
3473 | ||
3474 | while (formats && j && !found) { | |
3475 | found = !strcmp(formats[--j], format_name); | |
3476 | } | |
3477 | ||
3478 | if (!found) { | |
3479 | formats = g_renew(const char *, formats, count + 1); | |
3480 | formats[count++] = format_name; | |
3481 | } | |
3482 | } | |
3483 | } | |
3484 | ||
61007b31 | 3485 | qsort(formats, count, sizeof(formats[0]), qsort_strcmp); |
40b4f539 | 3486 | |
61007b31 SH |
3487 | for (i = 0; i < count; i++) { |
3488 | it(opaque, formats[i]); | |
3489 | } | |
40b4f539 | 3490 | |
61007b31 SH |
3491 | g_free(formats); |
3492 | } | |
40b4f539 | 3493 | |
61007b31 SH |
3494 | /* This function is to find a node in the bs graph */ |
3495 | BlockDriverState *bdrv_find_node(const char *node_name) | |
3496 | { | |
3497 | BlockDriverState *bs; | |
391827eb | 3498 | |
61007b31 | 3499 | assert(node_name); |
40b4f539 | 3500 | |
61007b31 SH |
3501 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { |
3502 | if (!strcmp(node_name, bs->node_name)) { | |
3503 | return bs; | |
40b4f539 KW |
3504 | } |
3505 | } | |
61007b31 | 3506 | return NULL; |
40b4f539 KW |
3507 | } |
3508 | ||
61007b31 SH |
3509 | /* Put this QMP function here so it can access the static graph_bdrv_states. */ |
3510 | BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp) | |
40b4f539 | 3511 | { |
61007b31 SH |
3512 | BlockDeviceInfoList *list, *entry; |
3513 | BlockDriverState *bs; | |
40b4f539 | 3514 | |
61007b31 SH |
3515 | list = NULL; |
3516 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { | |
c83f9fba | 3517 | BlockDeviceInfo *info = bdrv_block_device_info(NULL, bs, errp); |
61007b31 SH |
3518 | if (!info) { |
3519 | qapi_free_BlockDeviceInfoList(list); | |
3520 | return NULL; | |
301db7c2 | 3521 | } |
61007b31 SH |
3522 | entry = g_malloc0(sizeof(*entry)); |
3523 | entry->value = info; | |
3524 | entry->next = list; | |
3525 | list = entry; | |
301db7c2 RH |
3526 | } |
3527 | ||
61007b31 SH |
3528 | return list; |
3529 | } | |
40b4f539 | 3530 | |
61007b31 SH |
3531 | BlockDriverState *bdrv_lookup_bs(const char *device, |
3532 | const char *node_name, | |
3533 | Error **errp) | |
3534 | { | |
3535 | BlockBackend *blk; | |
3536 | BlockDriverState *bs; | |
40b4f539 | 3537 | |
61007b31 SH |
3538 | if (device) { |
3539 | blk = blk_by_name(device); | |
40b4f539 | 3540 | |
61007b31 | 3541 | if (blk) { |
9f4ed6fb AG |
3542 | bs = blk_bs(blk); |
3543 | if (!bs) { | |
5433c24f | 3544 | error_setg(errp, "Device '%s' has no medium", device); |
5433c24f HR |
3545 | } |
3546 | ||
9f4ed6fb | 3547 | return bs; |
61007b31 SH |
3548 | } |
3549 | } | |
40b4f539 | 3550 | |
61007b31 SH |
3551 | if (node_name) { |
3552 | bs = bdrv_find_node(node_name); | |
6d519a5f | 3553 | |
61007b31 SH |
3554 | if (bs) { |
3555 | return bs; | |
3556 | } | |
40b4f539 KW |
3557 | } |
3558 | ||
61007b31 SH |
3559 | error_setg(errp, "Cannot find device=%s nor node_name=%s", |
3560 | device ? device : "", | |
3561 | node_name ? node_name : ""); | |
3562 | return NULL; | |
40b4f539 KW |
3563 | } |
3564 | ||
61007b31 SH |
3565 | /* If 'base' is in the same chain as 'top', return true. Otherwise, |
3566 | * return false. If either argument is NULL, return false. */ | |
3567 | bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base) | |
83f64091 | 3568 | { |
61007b31 | 3569 | while (top && top != base) { |
760e0063 | 3570 | top = backing_bs(top); |
02c50efe | 3571 | } |
61007b31 SH |
3572 | |
3573 | return top != NULL; | |
02c50efe FZ |
3574 | } |
3575 | ||
61007b31 | 3576 | BlockDriverState *bdrv_next_node(BlockDriverState *bs) |
02c50efe | 3577 | { |
61007b31 SH |
3578 | if (!bs) { |
3579 | return QTAILQ_FIRST(&graph_bdrv_states); | |
02c50efe | 3580 | } |
61007b31 | 3581 | return QTAILQ_NEXT(bs, node_list); |
83f64091 FB |
3582 | } |
3583 | ||
61007b31 | 3584 | const char *bdrv_get_node_name(const BlockDriverState *bs) |
83f64091 | 3585 | { |
61007b31 | 3586 | return bs->node_name; |
beac80cd FB |
3587 | } |
3588 | ||
1f0c461b | 3589 | const char *bdrv_get_parent_name(const BlockDriverState *bs) |
4c265bf9 KW |
3590 | { |
3591 | BdrvChild *c; | |
3592 | const char *name; | |
3593 | ||
3594 | /* If multiple parents have a name, just pick the first one. */ | |
3595 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
3596 | if (c->role->get_name) { | |
3597 | name = c->role->get_name(c); | |
3598 | if (name && *name) { | |
3599 | return name; | |
3600 | } | |
3601 | } | |
3602 | } | |
3603 | ||
3604 | return NULL; | |
3605 | } | |
3606 | ||
61007b31 SH |
3607 | /* TODO check what callers really want: bs->node_name or blk_name() */ |
3608 | const char *bdrv_get_device_name(const BlockDriverState *bs) | |
beac80cd | 3609 | { |
4c265bf9 | 3610 | return bdrv_get_parent_name(bs) ?: ""; |
f141eafe | 3611 | } |
83f64091 | 3612 | |
61007b31 SH |
3613 | /* This can be used to identify nodes that might not have a device |
3614 | * name associated. Since node and device names live in the same | |
3615 | * namespace, the result is unambiguous. The exception is if both are | |
3616 | * absent, then this returns an empty (non-null) string. */ | |
3617 | const char *bdrv_get_device_or_node_name(const BlockDriverState *bs) | |
f141eafe | 3618 | { |
4c265bf9 | 3619 | return bdrv_get_parent_name(bs) ?: bs->node_name; |
beac80cd | 3620 | } |
beac80cd | 3621 | |
61007b31 | 3622 | int bdrv_get_flags(BlockDriverState *bs) |
0b5a2445 | 3623 | { |
61007b31 | 3624 | return bs->open_flags; |
0b5a2445 PB |
3625 | } |
3626 | ||
61007b31 | 3627 | int bdrv_has_zero_init_1(BlockDriverState *bs) |
68485420 | 3628 | { |
61007b31 | 3629 | return 1; |
0b5a2445 PB |
3630 | } |
3631 | ||
61007b31 | 3632 | int bdrv_has_zero_init(BlockDriverState *bs) |
0b5a2445 | 3633 | { |
61007b31 | 3634 | assert(bs->drv); |
0b5a2445 | 3635 | |
61007b31 SH |
3636 | /* If BS is a copy on write image, it is initialized to |
3637 | the contents of the base image, which may not be zeroes. */ | |
760e0063 | 3638 | if (bs->backing) { |
61007b31 SH |
3639 | return 0; |
3640 | } | |
3641 | if (bs->drv->bdrv_has_zero_init) { | |
3642 | return bs->drv->bdrv_has_zero_init(bs); | |
0b5a2445 | 3643 | } |
61007b31 SH |
3644 | |
3645 | /* safe default */ | |
3646 | return 0; | |
68485420 KW |
3647 | } |
3648 | ||
61007b31 | 3649 | bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs) |
b2a61371 | 3650 | { |
61007b31 | 3651 | BlockDriverInfo bdi; |
b2a61371 | 3652 | |
760e0063 | 3653 | if (bs->backing) { |
61007b31 SH |
3654 | return false; |
3655 | } | |
3656 | ||
3657 | if (bdrv_get_info(bs, &bdi) == 0) { | |
3658 | return bdi.unallocated_blocks_are_zero; | |
b2a61371 SH |
3659 | } |
3660 | ||
61007b31 | 3661 | return false; |
b2a61371 SH |
3662 | } |
3663 | ||
61007b31 | 3664 | bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs) |
68485420 | 3665 | { |
61007b31 | 3666 | BlockDriverInfo bdi; |
68485420 | 3667 | |
2f0342ef | 3668 | if (!(bs->open_flags & BDRV_O_UNMAP)) { |
61007b31 SH |
3669 | return false; |
3670 | } | |
68485420 | 3671 | |
61007b31 SH |
3672 | if (bdrv_get_info(bs, &bdi) == 0) { |
3673 | return bdi.can_write_zeroes_with_unmap; | |
3674 | } | |
68485420 | 3675 | |
61007b31 | 3676 | return false; |
68485420 KW |
3677 | } |
3678 | ||
61007b31 | 3679 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs) |
b2e12bc6 | 3680 | { |
760e0063 | 3681 | if (bs->backing && bs->backing->bs->encrypted) |
61007b31 SH |
3682 | return bs->backing_file; |
3683 | else if (bs->encrypted) | |
3684 | return bs->filename; | |
3685 | else | |
3686 | return NULL; | |
b2e12bc6 CH |
3687 | } |
3688 | ||
61007b31 SH |
3689 | void bdrv_get_backing_filename(BlockDriverState *bs, |
3690 | char *filename, int filename_size) | |
016f5cf6 | 3691 | { |
61007b31 SH |
3692 | pstrcpy(filename, filename_size, bs->backing_file); |
3693 | } | |
d318aea9 | 3694 | |
61007b31 SH |
3695 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi) |
3696 | { | |
3697 | BlockDriver *drv = bs->drv; | |
3698 | if (!drv) | |
3699 | return -ENOMEDIUM; | |
3700 | if (!drv->bdrv_get_info) | |
3701 | return -ENOTSUP; | |
3702 | memset(bdi, 0, sizeof(*bdi)); | |
3703 | return drv->bdrv_get_info(bs, bdi); | |
3704 | } | |
016f5cf6 | 3705 | |
61007b31 SH |
3706 | ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs) |
3707 | { | |
3708 | BlockDriver *drv = bs->drv; | |
3709 | if (drv && drv->bdrv_get_specific_info) { | |
3710 | return drv->bdrv_get_specific_info(bs); | |
3711 | } | |
3712 | return NULL; | |
016f5cf6 AG |
3713 | } |
3714 | ||
a31939e6 | 3715 | void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event) |
4265d620 | 3716 | { |
61007b31 SH |
3717 | if (!bs || !bs->drv || !bs->drv->bdrv_debug_event) { |
3718 | return; | |
3719 | } | |
4265d620 | 3720 | |
61007b31 | 3721 | bs->drv->bdrv_debug_event(bs, event); |
4265d620 PB |
3722 | } |
3723 | ||
61007b31 SH |
3724 | int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, |
3725 | const char *tag) | |
4265d620 | 3726 | { |
61007b31 | 3727 | while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) { |
9a4f4c31 | 3728 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 3729 | } |
4265d620 | 3730 | |
61007b31 SH |
3731 | if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) { |
3732 | return bs->drv->bdrv_debug_breakpoint(bs, event, tag); | |
3733 | } | |
4265d620 | 3734 | |
61007b31 | 3735 | return -ENOTSUP; |
4265d620 PB |
3736 | } |
3737 | ||
61007b31 | 3738 | int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag) |
ea2384d3 | 3739 | { |
61007b31 | 3740 | while (bs && bs->drv && !bs->drv->bdrv_debug_remove_breakpoint) { |
9a4f4c31 | 3741 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 3742 | } |
ce1a14dc | 3743 | |
61007b31 SH |
3744 | if (bs && bs->drv && bs->drv->bdrv_debug_remove_breakpoint) { |
3745 | return bs->drv->bdrv_debug_remove_breakpoint(bs, tag); | |
3746 | } | |
3747 | ||
3748 | return -ENOTSUP; | |
eb852011 MA |
3749 | } |
3750 | ||
61007b31 | 3751 | int bdrv_debug_resume(BlockDriverState *bs, const char *tag) |
ce1a14dc | 3752 | { |
61007b31 | 3753 | while (bs && (!bs->drv || !bs->drv->bdrv_debug_resume)) { |
9a4f4c31 | 3754 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 3755 | } |
ce1a14dc | 3756 | |
61007b31 SH |
3757 | if (bs && bs->drv && bs->drv->bdrv_debug_resume) { |
3758 | return bs->drv->bdrv_debug_resume(bs, tag); | |
3759 | } | |
ce1a14dc | 3760 | |
61007b31 | 3761 | return -ENOTSUP; |
f197fe2b FZ |
3762 | } |
3763 | ||
61007b31 | 3764 | bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag) |
ce1a14dc | 3765 | { |
61007b31 | 3766 | while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) { |
9a4f4c31 | 3767 | bs = bs->file ? bs->file->bs : NULL; |
f197fe2b | 3768 | } |
19cb3738 | 3769 | |
61007b31 SH |
3770 | if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) { |
3771 | return bs->drv->bdrv_debug_is_suspended(bs, tag); | |
3772 | } | |
f9f05dc5 | 3773 | |
61007b31 SH |
3774 | return false; |
3775 | } | |
f9f05dc5 | 3776 | |
61007b31 SH |
3777 | /* backing_file can either be relative, or absolute, or a protocol. If it is |
3778 | * relative, it must be relative to the chain. So, passing in bs->filename | |
3779 | * from a BDS as backing_file should not be done, as that may be relative to | |
3780 | * the CWD rather than the chain. */ | |
3781 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, | |
3782 | const char *backing_file) | |
f9f05dc5 | 3783 | { |
61007b31 SH |
3784 | char *filename_full = NULL; |
3785 | char *backing_file_full = NULL; | |
3786 | char *filename_tmp = NULL; | |
3787 | int is_protocol = 0; | |
3788 | BlockDriverState *curr_bs = NULL; | |
3789 | BlockDriverState *retval = NULL; | |
418661e0 | 3790 | Error *local_error = NULL; |
f9f05dc5 | 3791 | |
61007b31 SH |
3792 | if (!bs || !bs->drv || !backing_file) { |
3793 | return NULL; | |
f9f05dc5 KW |
3794 | } |
3795 | ||
61007b31 SH |
3796 | filename_full = g_malloc(PATH_MAX); |
3797 | backing_file_full = g_malloc(PATH_MAX); | |
3798 | filename_tmp = g_malloc(PATH_MAX); | |
f9f05dc5 | 3799 | |
61007b31 | 3800 | is_protocol = path_has_protocol(backing_file); |
f9f05dc5 | 3801 | |
760e0063 | 3802 | for (curr_bs = bs; curr_bs->backing; curr_bs = curr_bs->backing->bs) { |
f9f05dc5 | 3803 | |
61007b31 SH |
3804 | /* If either of the filename paths is actually a protocol, then |
3805 | * compare unmodified paths; otherwise make paths relative */ | |
3806 | if (is_protocol || path_has_protocol(curr_bs->backing_file)) { | |
3807 | if (strcmp(backing_file, curr_bs->backing_file) == 0) { | |
760e0063 | 3808 | retval = curr_bs->backing->bs; |
61007b31 SH |
3809 | break; |
3810 | } | |
418661e0 JC |
3811 | /* Also check against the full backing filename for the image */ |
3812 | bdrv_get_full_backing_filename(curr_bs, backing_file_full, PATH_MAX, | |
3813 | &local_error); | |
3814 | if (local_error == NULL) { | |
3815 | if (strcmp(backing_file, backing_file_full) == 0) { | |
3816 | retval = curr_bs->backing->bs; | |
3817 | break; | |
3818 | } | |
3819 | } else { | |
3820 | error_free(local_error); | |
3821 | local_error = NULL; | |
3822 | } | |
61007b31 SH |
3823 | } else { |
3824 | /* If not an absolute filename path, make it relative to the current | |
3825 | * image's filename path */ | |
3826 | path_combine(filename_tmp, PATH_MAX, curr_bs->filename, | |
3827 | backing_file); | |
f9f05dc5 | 3828 | |
61007b31 SH |
3829 | /* We are going to compare absolute pathnames */ |
3830 | if (!realpath(filename_tmp, filename_full)) { | |
3831 | continue; | |
3832 | } | |
07f07615 | 3833 | |
61007b31 SH |
3834 | /* We need to make sure the backing filename we are comparing against |
3835 | * is relative to the current image filename (or absolute) */ | |
3836 | path_combine(filename_tmp, PATH_MAX, curr_bs->filename, | |
3837 | curr_bs->backing_file); | |
07f07615 | 3838 | |
61007b31 SH |
3839 | if (!realpath(filename_tmp, backing_file_full)) { |
3840 | continue; | |
3841 | } | |
eb489bb1 | 3842 | |
61007b31 | 3843 | if (strcmp(backing_file_full, filename_full) == 0) { |
760e0063 | 3844 | retval = curr_bs->backing->bs; |
61007b31 SH |
3845 | break; |
3846 | } | |
3847 | } | |
eb489bb1 KW |
3848 | } |
3849 | ||
61007b31 SH |
3850 | g_free(filename_full); |
3851 | g_free(backing_file_full); | |
3852 | g_free(filename_tmp); | |
3853 | return retval; | |
3854 | } | |
3855 | ||
3856 | int bdrv_get_backing_file_depth(BlockDriverState *bs) | |
3857 | { | |
3858 | if (!bs->drv) { | |
3859 | return 0; | |
eb489bb1 KW |
3860 | } |
3861 | ||
760e0063 | 3862 | if (!bs->backing) { |
61007b31 | 3863 | return 0; |
ca716364 KW |
3864 | } |
3865 | ||
760e0063 | 3866 | return 1 + bdrv_get_backing_file_depth(bs->backing->bs); |
61007b31 | 3867 | } |
07f07615 | 3868 | |
61007b31 SH |
3869 | void bdrv_init(void) |
3870 | { | |
3871 | module_call_init(MODULE_INIT_BLOCK); | |
3872 | } | |
29cdb251 | 3873 | |
61007b31 SH |
3874 | void bdrv_init_with_whitelist(void) |
3875 | { | |
3876 | use_bdrv_whitelist = 1; | |
3877 | bdrv_init(); | |
07f07615 PB |
3878 | } |
3879 | ||
5a8a30db | 3880 | void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp) |
0f15423c | 3881 | { |
0d1c5c91 | 3882 | BdrvChild *child; |
5a8a30db KW |
3883 | Error *local_err = NULL; |
3884 | int ret; | |
3885 | ||
3456a8d1 KW |
3886 | if (!bs->drv) { |
3887 | return; | |
3888 | } | |
3889 | ||
04c01a5c | 3890 | if (!(bs->open_flags & BDRV_O_INACTIVE)) { |
7ea2d269 AK |
3891 | return; |
3892 | } | |
7ea2d269 | 3893 | |
16e977d5 VSO |
3894 | QLIST_FOREACH(child, &bs->children, next) { |
3895 | bdrv_invalidate_cache(child->bs, &local_err); | |
0d1c5c91 | 3896 | if (local_err) { |
0d1c5c91 FZ |
3897 | error_propagate(errp, local_err); |
3898 | return; | |
3899 | } | |
5a8a30db | 3900 | } |
0d1c5c91 | 3901 | |
16e977d5 VSO |
3902 | bs->open_flags &= ~BDRV_O_INACTIVE; |
3903 | if (bs->drv->bdrv_invalidate_cache) { | |
3904 | bs->drv->bdrv_invalidate_cache(bs, &local_err); | |
0d1c5c91 FZ |
3905 | if (local_err) { |
3906 | bs->open_flags |= BDRV_O_INACTIVE; | |
3907 | error_propagate(errp, local_err); | |
3908 | return; | |
3909 | } | |
0f15423c | 3910 | } |
3456a8d1 | 3911 | |
5a8a30db KW |
3912 | ret = refresh_total_sectors(bs, bs->total_sectors); |
3913 | if (ret < 0) { | |
04c01a5c | 3914 | bs->open_flags |= BDRV_O_INACTIVE; |
5a8a30db KW |
3915 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); |
3916 | return; | |
3917 | } | |
0f15423c AL |
3918 | } |
3919 | ||
5a8a30db | 3920 | void bdrv_invalidate_cache_all(Error **errp) |
0f15423c | 3921 | { |
7c8eece4 | 3922 | BlockDriverState *bs; |
5a8a30db | 3923 | Error *local_err = NULL; |
88be7b4b | 3924 | BdrvNextIterator it; |
0f15423c | 3925 | |
88be7b4b | 3926 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
ed78cda3 SH |
3927 | AioContext *aio_context = bdrv_get_aio_context(bs); |
3928 | ||
3929 | aio_context_acquire(aio_context); | |
5a8a30db | 3930 | bdrv_invalidate_cache(bs, &local_err); |
ed78cda3 | 3931 | aio_context_release(aio_context); |
5a8a30db KW |
3932 | if (local_err) { |
3933 | error_propagate(errp, local_err); | |
3934 | return; | |
3935 | } | |
0f15423c AL |
3936 | } |
3937 | } | |
3938 | ||
aad0b7a0 FZ |
3939 | static int bdrv_inactivate_recurse(BlockDriverState *bs, |
3940 | bool setting_flag) | |
76b1c7fe | 3941 | { |
aad0b7a0 | 3942 | BdrvChild *child; |
76b1c7fe KW |
3943 | int ret; |
3944 | ||
aad0b7a0 | 3945 | if (!setting_flag && bs->drv->bdrv_inactivate) { |
76b1c7fe KW |
3946 | ret = bs->drv->bdrv_inactivate(bs); |
3947 | if (ret < 0) { | |
3948 | return ret; | |
3949 | } | |
3950 | } | |
3951 | ||
aad0b7a0 FZ |
3952 | QLIST_FOREACH(child, &bs->children, next) { |
3953 | ret = bdrv_inactivate_recurse(child->bs, setting_flag); | |
3954 | if (ret < 0) { | |
3955 | return ret; | |
3956 | } | |
3957 | } | |
3958 | ||
3959 | if (setting_flag) { | |
3960 | bs->open_flags |= BDRV_O_INACTIVE; | |
3961 | } | |
76b1c7fe KW |
3962 | return 0; |
3963 | } | |
3964 | ||
3965 | int bdrv_inactivate_all(void) | |
3966 | { | |
79720af6 | 3967 | BlockDriverState *bs = NULL; |
88be7b4b | 3968 | BdrvNextIterator it; |
aad0b7a0 FZ |
3969 | int ret = 0; |
3970 | int pass; | |
76b1c7fe | 3971 | |
88be7b4b | 3972 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
aad0b7a0 FZ |
3973 | aio_context_acquire(bdrv_get_aio_context(bs)); |
3974 | } | |
76b1c7fe | 3975 | |
aad0b7a0 FZ |
3976 | /* We do two passes of inactivation. The first pass calls to drivers' |
3977 | * .bdrv_inactivate callbacks recursively so all cache is flushed to disk; | |
3978 | * the second pass sets the BDRV_O_INACTIVE flag so that no further write | |
3979 | * is allowed. */ | |
3980 | for (pass = 0; pass < 2; pass++) { | |
88be7b4b | 3981 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
aad0b7a0 FZ |
3982 | ret = bdrv_inactivate_recurse(bs, pass); |
3983 | if (ret < 0) { | |
3984 | goto out; | |
3985 | } | |
76b1c7fe KW |
3986 | } |
3987 | } | |
3988 | ||
aad0b7a0 | 3989 | out: |
88be7b4b | 3990 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
aad0b7a0 FZ |
3991 | aio_context_release(bdrv_get_aio_context(bs)); |
3992 | } | |
3993 | ||
3994 | return ret; | |
76b1c7fe KW |
3995 | } |
3996 | ||
19cb3738 FB |
3997 | /**************************************************************/ |
3998 | /* removable device support */ | |
3999 | ||
4000 | /** | |
4001 | * Return TRUE if the media is present | |
4002 | */ | |
e031f750 | 4003 | bool bdrv_is_inserted(BlockDriverState *bs) |
19cb3738 FB |
4004 | { |
4005 | BlockDriver *drv = bs->drv; | |
28d7a789 | 4006 | BdrvChild *child; |
a1aff5bf | 4007 | |
e031f750 HR |
4008 | if (!drv) { |
4009 | return false; | |
4010 | } | |
28d7a789 HR |
4011 | if (drv->bdrv_is_inserted) { |
4012 | return drv->bdrv_is_inserted(bs); | |
4013 | } | |
4014 | QLIST_FOREACH(child, &bs->children, next) { | |
4015 | if (!bdrv_is_inserted(child->bs)) { | |
4016 | return false; | |
4017 | } | |
e031f750 | 4018 | } |
28d7a789 | 4019 | return true; |
19cb3738 FB |
4020 | } |
4021 | ||
4022 | /** | |
8e49ca46 MA |
4023 | * Return whether the media changed since the last call to this |
4024 | * function, or -ENOTSUP if we don't know. Most drivers don't know. | |
19cb3738 FB |
4025 | */ |
4026 | int bdrv_media_changed(BlockDriverState *bs) | |
4027 | { | |
4028 | BlockDriver *drv = bs->drv; | |
19cb3738 | 4029 | |
8e49ca46 MA |
4030 | if (drv && drv->bdrv_media_changed) { |
4031 | return drv->bdrv_media_changed(bs); | |
4032 | } | |
4033 | return -ENOTSUP; | |
19cb3738 FB |
4034 | } |
4035 | ||
4036 | /** | |
4037 | * If eject_flag is TRUE, eject the media. Otherwise, close the tray | |
4038 | */ | |
f36f3949 | 4039 | void bdrv_eject(BlockDriverState *bs, bool eject_flag) |
19cb3738 FB |
4040 | { |
4041 | BlockDriver *drv = bs->drv; | |
19cb3738 | 4042 | |
822e1cd1 MA |
4043 | if (drv && drv->bdrv_eject) { |
4044 | drv->bdrv_eject(bs, eject_flag); | |
19cb3738 FB |
4045 | } |
4046 | } | |
4047 | ||
19cb3738 FB |
4048 | /** |
4049 | * Lock or unlock the media (if it is locked, the user won't be able | |
4050 | * to eject it manually). | |
4051 | */ | |
025e849a | 4052 | void bdrv_lock_medium(BlockDriverState *bs, bool locked) |
19cb3738 FB |
4053 | { |
4054 | BlockDriver *drv = bs->drv; | |
4055 | ||
025e849a | 4056 | trace_bdrv_lock_medium(bs, locked); |
b8c6d095 | 4057 | |
025e849a MA |
4058 | if (drv && drv->bdrv_lock_medium) { |
4059 | drv->bdrv_lock_medium(bs, locked); | |
19cb3738 FB |
4060 | } |
4061 | } | |
985a03b0 | 4062 | |
9fcb0251 FZ |
4063 | /* Get a reference to bs */ |
4064 | void bdrv_ref(BlockDriverState *bs) | |
4065 | { | |
4066 | bs->refcnt++; | |
4067 | } | |
4068 | ||
4069 | /* Release a previously grabbed reference to bs. | |
4070 | * If after releasing, reference count is zero, the BlockDriverState is | |
4071 | * deleted. */ | |
4072 | void bdrv_unref(BlockDriverState *bs) | |
4073 | { | |
9a4d5ca6 JC |
4074 | if (!bs) { |
4075 | return; | |
4076 | } | |
9fcb0251 FZ |
4077 | assert(bs->refcnt > 0); |
4078 | if (--bs->refcnt == 0) { | |
4079 | bdrv_delete(bs); | |
4080 | } | |
4081 | } | |
4082 | ||
fbe40ff7 FZ |
4083 | struct BdrvOpBlocker { |
4084 | Error *reason; | |
4085 | QLIST_ENTRY(BdrvOpBlocker) list; | |
4086 | }; | |
4087 | ||
4088 | bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp) | |
4089 | { | |
4090 | BdrvOpBlocker *blocker; | |
4091 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
4092 | if (!QLIST_EMPTY(&bs->op_blockers[op])) { | |
4093 | blocker = QLIST_FIRST(&bs->op_blockers[op]); | |
4094 | if (errp) { | |
e43bfd9c MA |
4095 | *errp = error_copy(blocker->reason); |
4096 | error_prepend(errp, "Node '%s' is busy: ", | |
4097 | bdrv_get_device_or_node_name(bs)); | |
fbe40ff7 FZ |
4098 | } |
4099 | return true; | |
4100 | } | |
4101 | return false; | |
4102 | } | |
4103 | ||
4104 | void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason) | |
4105 | { | |
4106 | BdrvOpBlocker *blocker; | |
4107 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
4108 | ||
5839e53b | 4109 | blocker = g_new0(BdrvOpBlocker, 1); |
fbe40ff7 FZ |
4110 | blocker->reason = reason; |
4111 | QLIST_INSERT_HEAD(&bs->op_blockers[op], blocker, list); | |
4112 | } | |
4113 | ||
4114 | void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason) | |
4115 | { | |
4116 | BdrvOpBlocker *blocker, *next; | |
4117 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
4118 | QLIST_FOREACH_SAFE(blocker, &bs->op_blockers[op], list, next) { | |
4119 | if (blocker->reason == reason) { | |
4120 | QLIST_REMOVE(blocker, list); | |
4121 | g_free(blocker); | |
4122 | } | |
4123 | } | |
4124 | } | |
4125 | ||
4126 | void bdrv_op_block_all(BlockDriverState *bs, Error *reason) | |
4127 | { | |
4128 | int i; | |
4129 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
4130 | bdrv_op_block(bs, i, reason); | |
4131 | } | |
4132 | } | |
4133 | ||
4134 | void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason) | |
4135 | { | |
4136 | int i; | |
4137 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
4138 | bdrv_op_unblock(bs, i, reason); | |
4139 | } | |
4140 | } | |
4141 | ||
4142 | bool bdrv_op_blocker_is_empty(BlockDriverState *bs) | |
4143 | { | |
4144 | int i; | |
4145 | ||
4146 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
4147 | if (!QLIST_EMPTY(&bs->op_blockers[i])) { | |
4148 | return false; | |
4149 | } | |
4150 | } | |
4151 | return true; | |
4152 | } | |
4153 | ||
d92ada22 LC |
4154 | void bdrv_img_create(const char *filename, const char *fmt, |
4155 | const char *base_filename, const char *base_fmt, | |
f382d43a MR |
4156 | char *options, uint64_t img_size, int flags, |
4157 | Error **errp, bool quiet) | |
f88e1a42 | 4158 | { |
83d0521a CL |
4159 | QemuOptsList *create_opts = NULL; |
4160 | QemuOpts *opts = NULL; | |
4161 | const char *backing_fmt, *backing_file; | |
4162 | int64_t size; | |
f88e1a42 | 4163 | BlockDriver *drv, *proto_drv; |
cc84d90f | 4164 | Error *local_err = NULL; |
f88e1a42 JS |
4165 | int ret = 0; |
4166 | ||
4167 | /* Find driver and parse its options */ | |
4168 | drv = bdrv_find_format(fmt); | |
4169 | if (!drv) { | |
71c79813 | 4170 | error_setg(errp, "Unknown file format '%s'", fmt); |
d92ada22 | 4171 | return; |
f88e1a42 JS |
4172 | } |
4173 | ||
b65a5e12 | 4174 | proto_drv = bdrv_find_protocol(filename, true, errp); |
f88e1a42 | 4175 | if (!proto_drv) { |
d92ada22 | 4176 | return; |
f88e1a42 JS |
4177 | } |
4178 | ||
c6149724 HR |
4179 | if (!drv->create_opts) { |
4180 | error_setg(errp, "Format driver '%s' does not support image creation", | |
4181 | drv->format_name); | |
4182 | return; | |
4183 | } | |
4184 | ||
4185 | if (!proto_drv->create_opts) { | |
4186 | error_setg(errp, "Protocol driver '%s' does not support image creation", | |
4187 | proto_drv->format_name); | |
4188 | return; | |
4189 | } | |
4190 | ||
c282e1fd CL |
4191 | create_opts = qemu_opts_append(create_opts, drv->create_opts); |
4192 | create_opts = qemu_opts_append(create_opts, proto_drv->create_opts); | |
f88e1a42 JS |
4193 | |
4194 | /* Create parameter list with default values */ | |
83d0521a | 4195 | opts = qemu_opts_create(create_opts, NULL, 0, &error_abort); |
39101f25 | 4196 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort); |
f88e1a42 JS |
4197 | |
4198 | /* Parse -o options */ | |
4199 | if (options) { | |
dc523cd3 MA |
4200 | qemu_opts_do_parse(opts, options, NULL, &local_err); |
4201 | if (local_err) { | |
4202 | error_report_err(local_err); | |
4203 | local_err = NULL; | |
83d0521a | 4204 | error_setg(errp, "Invalid options for file format '%s'", fmt); |
f88e1a42 JS |
4205 | goto out; |
4206 | } | |
4207 | } | |
4208 | ||
4209 | if (base_filename) { | |
f43e47db | 4210 | qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &local_err); |
6be4194b | 4211 | if (local_err) { |
71c79813 LC |
4212 | error_setg(errp, "Backing file not supported for file format '%s'", |
4213 | fmt); | |
f88e1a42 JS |
4214 | goto out; |
4215 | } | |
4216 | } | |
4217 | ||
4218 | if (base_fmt) { | |
f43e47db | 4219 | qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &local_err); |
6be4194b | 4220 | if (local_err) { |
71c79813 LC |
4221 | error_setg(errp, "Backing file format not supported for file " |
4222 | "format '%s'", fmt); | |
f88e1a42 JS |
4223 | goto out; |
4224 | } | |
4225 | } | |
4226 | ||
83d0521a CL |
4227 | backing_file = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE); |
4228 | if (backing_file) { | |
4229 | if (!strcmp(filename, backing_file)) { | |
71c79813 LC |
4230 | error_setg(errp, "Error: Trying to create an image with the " |
4231 | "same filename as the backing file"); | |
792da93a JS |
4232 | goto out; |
4233 | } | |
4234 | } | |
4235 | ||
83d0521a | 4236 | backing_fmt = qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT); |
f88e1a42 JS |
4237 | |
4238 | // The size for the image must always be specified, with one exception: | |
4239 | // If we are using a backing file, we can obtain the size from there | |
83d0521a CL |
4240 | size = qemu_opt_get_size(opts, BLOCK_OPT_SIZE, 0); |
4241 | if (size == -1) { | |
4242 | if (backing_file) { | |
66f6b814 | 4243 | BlockDriverState *bs; |
29168018 | 4244 | char *full_backing = g_new0(char, PATH_MAX); |
52bf1e72 | 4245 | int64_t size; |
63090dac | 4246 | int back_flags; |
e6641719 | 4247 | QDict *backing_options = NULL; |
63090dac | 4248 | |
29168018 HR |
4249 | bdrv_get_full_backing_filename_from_filename(filename, backing_file, |
4250 | full_backing, PATH_MAX, | |
4251 | &local_err); | |
4252 | if (local_err) { | |
4253 | g_free(full_backing); | |
4254 | goto out; | |
4255 | } | |
4256 | ||
63090dac | 4257 | /* backing files always opened read-only */ |
61de4c68 | 4258 | back_flags = flags; |
bfd18d1e | 4259 | back_flags &= ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING); |
f88e1a42 | 4260 | |
e6641719 HR |
4261 | if (backing_fmt) { |
4262 | backing_options = qdict_new(); | |
4263 | qdict_put(backing_options, "driver", | |
4264 | qstring_from_str(backing_fmt)); | |
4265 | } | |
4266 | ||
5b363937 HR |
4267 | bs = bdrv_open(full_backing, NULL, backing_options, back_flags, |
4268 | &local_err); | |
29168018 | 4269 | g_free(full_backing); |
5b363937 | 4270 | if (!bs) { |
f88e1a42 JS |
4271 | goto out; |
4272 | } | |
52bf1e72 MA |
4273 | size = bdrv_getlength(bs); |
4274 | if (size < 0) { | |
4275 | error_setg_errno(errp, -size, "Could not get size of '%s'", | |
4276 | backing_file); | |
4277 | bdrv_unref(bs); | |
4278 | goto out; | |
4279 | } | |
f88e1a42 | 4280 | |
39101f25 | 4281 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, size, &error_abort); |
66f6b814 HR |
4282 | |
4283 | bdrv_unref(bs); | |
f88e1a42 | 4284 | } else { |
71c79813 | 4285 | error_setg(errp, "Image creation needs a size parameter"); |
f88e1a42 JS |
4286 | goto out; |
4287 | } | |
4288 | } | |
4289 | ||
f382d43a | 4290 | if (!quiet) { |
fe646693 | 4291 | printf("Formatting '%s', fmt=%s ", filename, fmt); |
43c5d8f8 | 4292 | qemu_opts_print(opts, " "); |
f382d43a MR |
4293 | puts(""); |
4294 | } | |
83d0521a | 4295 | |
c282e1fd | 4296 | ret = bdrv_create(drv, filename, opts, &local_err); |
83d0521a | 4297 | |
cc84d90f HR |
4298 | if (ret == -EFBIG) { |
4299 | /* This is generally a better message than whatever the driver would | |
4300 | * deliver (especially because of the cluster_size_hint), since that | |
4301 | * is most probably not much different from "image too large". */ | |
4302 | const char *cluster_size_hint = ""; | |
83d0521a | 4303 | if (qemu_opt_get_size(opts, BLOCK_OPT_CLUSTER_SIZE, 0)) { |
cc84d90f | 4304 | cluster_size_hint = " (try using a larger cluster size)"; |
f88e1a42 | 4305 | } |
cc84d90f HR |
4306 | error_setg(errp, "The image size is too large for file format '%s'" |
4307 | "%s", fmt, cluster_size_hint); | |
4308 | error_free(local_err); | |
4309 | local_err = NULL; | |
f88e1a42 JS |
4310 | } |
4311 | ||
4312 | out: | |
83d0521a CL |
4313 | qemu_opts_del(opts); |
4314 | qemu_opts_free(create_opts); | |
621ff94d | 4315 | error_propagate(errp, local_err); |
f88e1a42 | 4316 | } |
85d126f3 SH |
4317 | |
4318 | AioContext *bdrv_get_aio_context(BlockDriverState *bs) | |
4319 | { | |
dcd04228 SH |
4320 | return bs->aio_context; |
4321 | } | |
4322 | ||
e8a095da SH |
4323 | static void bdrv_do_remove_aio_context_notifier(BdrvAioNotifier *ban) |
4324 | { | |
4325 | QLIST_REMOVE(ban, list); | |
4326 | g_free(ban); | |
4327 | } | |
4328 | ||
dcd04228 SH |
4329 | void bdrv_detach_aio_context(BlockDriverState *bs) |
4330 | { | |
e8a095da | 4331 | BdrvAioNotifier *baf, *baf_tmp; |
b97511c7 | 4332 | BdrvChild *child; |
33384421 | 4333 | |
dcd04228 SH |
4334 | if (!bs->drv) { |
4335 | return; | |
4336 | } | |
4337 | ||
e8a095da SH |
4338 | assert(!bs->walking_aio_notifiers); |
4339 | bs->walking_aio_notifiers = true; | |
4340 | QLIST_FOREACH_SAFE(baf, &bs->aio_notifiers, list, baf_tmp) { | |
4341 | if (baf->deleted) { | |
4342 | bdrv_do_remove_aio_context_notifier(baf); | |
4343 | } else { | |
4344 | baf->detach_aio_context(baf->opaque); | |
4345 | } | |
33384421 | 4346 | } |
e8a095da SH |
4347 | /* Never mind iterating again to check for ->deleted. bdrv_close() will |
4348 | * remove remaining aio notifiers if we aren't called again. | |
4349 | */ | |
4350 | bs->walking_aio_notifiers = false; | |
33384421 | 4351 | |
dcd04228 SH |
4352 | if (bs->drv->bdrv_detach_aio_context) { |
4353 | bs->drv->bdrv_detach_aio_context(bs); | |
4354 | } | |
b97511c7 HR |
4355 | QLIST_FOREACH(child, &bs->children, next) { |
4356 | bdrv_detach_aio_context(child->bs); | |
dcd04228 SH |
4357 | } |
4358 | ||
4359 | bs->aio_context = NULL; | |
4360 | } | |
4361 | ||
4362 | void bdrv_attach_aio_context(BlockDriverState *bs, | |
4363 | AioContext *new_context) | |
4364 | { | |
e8a095da | 4365 | BdrvAioNotifier *ban, *ban_tmp; |
b97511c7 | 4366 | BdrvChild *child; |
33384421 | 4367 | |
dcd04228 SH |
4368 | if (!bs->drv) { |
4369 | return; | |
4370 | } | |
4371 | ||
4372 | bs->aio_context = new_context; | |
4373 | ||
b97511c7 HR |
4374 | QLIST_FOREACH(child, &bs->children, next) { |
4375 | bdrv_attach_aio_context(child->bs, new_context); | |
dcd04228 SH |
4376 | } |
4377 | if (bs->drv->bdrv_attach_aio_context) { | |
4378 | bs->drv->bdrv_attach_aio_context(bs, new_context); | |
4379 | } | |
33384421 | 4380 | |
e8a095da SH |
4381 | assert(!bs->walking_aio_notifiers); |
4382 | bs->walking_aio_notifiers = true; | |
4383 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_tmp) { | |
4384 | if (ban->deleted) { | |
4385 | bdrv_do_remove_aio_context_notifier(ban); | |
4386 | } else { | |
4387 | ban->attached_aio_context(new_context, ban->opaque); | |
4388 | } | |
33384421 | 4389 | } |
e8a095da | 4390 | bs->walking_aio_notifiers = false; |
dcd04228 SH |
4391 | } |
4392 | ||
4393 | void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context) | |
4394 | { | |
c2b6428d PB |
4395 | AioContext *ctx; |
4396 | ||
53ec73e2 | 4397 | bdrv_drain(bs); /* ensure there are no in-flight requests */ |
dcd04228 | 4398 | |
c2b6428d PB |
4399 | ctx = bdrv_get_aio_context(bs); |
4400 | while (aio_poll(ctx, false)) { | |
4401 | /* wait for all bottom halves to execute */ | |
4402 | } | |
4403 | ||
dcd04228 SH |
4404 | bdrv_detach_aio_context(bs); |
4405 | ||
4406 | /* This function executes in the old AioContext so acquire the new one in | |
4407 | * case it runs in a different thread. | |
4408 | */ | |
4409 | aio_context_acquire(new_context); | |
4410 | bdrv_attach_aio_context(bs, new_context); | |
4411 | aio_context_release(new_context); | |
85d126f3 | 4412 | } |
d616b224 | 4413 | |
33384421 HR |
4414 | void bdrv_add_aio_context_notifier(BlockDriverState *bs, |
4415 | void (*attached_aio_context)(AioContext *new_context, void *opaque), | |
4416 | void (*detach_aio_context)(void *opaque), void *opaque) | |
4417 | { | |
4418 | BdrvAioNotifier *ban = g_new(BdrvAioNotifier, 1); | |
4419 | *ban = (BdrvAioNotifier){ | |
4420 | .attached_aio_context = attached_aio_context, | |
4421 | .detach_aio_context = detach_aio_context, | |
4422 | .opaque = opaque | |
4423 | }; | |
4424 | ||
4425 | QLIST_INSERT_HEAD(&bs->aio_notifiers, ban, list); | |
4426 | } | |
4427 | ||
4428 | void bdrv_remove_aio_context_notifier(BlockDriverState *bs, | |
4429 | void (*attached_aio_context)(AioContext *, | |
4430 | void *), | |
4431 | void (*detach_aio_context)(void *), | |
4432 | void *opaque) | |
4433 | { | |
4434 | BdrvAioNotifier *ban, *ban_next; | |
4435 | ||
4436 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { | |
4437 | if (ban->attached_aio_context == attached_aio_context && | |
4438 | ban->detach_aio_context == detach_aio_context && | |
e8a095da SH |
4439 | ban->opaque == opaque && |
4440 | ban->deleted == false) | |
33384421 | 4441 | { |
e8a095da SH |
4442 | if (bs->walking_aio_notifiers) { |
4443 | ban->deleted = true; | |
4444 | } else { | |
4445 | bdrv_do_remove_aio_context_notifier(ban); | |
4446 | } | |
33384421 HR |
4447 | return; |
4448 | } | |
4449 | } | |
4450 | ||
4451 | abort(); | |
4452 | } | |
4453 | ||
77485434 | 4454 | int bdrv_amend_options(BlockDriverState *bs, QemuOpts *opts, |
8b13976d | 4455 | BlockDriverAmendStatusCB *status_cb, void *cb_opaque) |
6f176b48 | 4456 | { |
c282e1fd | 4457 | if (!bs->drv->bdrv_amend_options) { |
6f176b48 HR |
4458 | return -ENOTSUP; |
4459 | } | |
8b13976d | 4460 | return bs->drv->bdrv_amend_options(bs, opts, status_cb, cb_opaque); |
6f176b48 | 4461 | } |
f6186f49 | 4462 | |
b5042a36 BC |
4463 | /* This function will be called by the bdrv_recurse_is_first_non_filter method |
4464 | * of block filter and by bdrv_is_first_non_filter. | |
4465 | * It is used to test if the given bs is the candidate or recurse more in the | |
4466 | * node graph. | |
212a5a8f | 4467 | */ |
b5042a36 | 4468 | bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs, |
212a5a8f | 4469 | BlockDriverState *candidate) |
f6186f49 | 4470 | { |
b5042a36 BC |
4471 | /* return false if basic checks fails */ |
4472 | if (!bs || !bs->drv) { | |
212a5a8f | 4473 | return false; |
f6186f49 BC |
4474 | } |
4475 | ||
b5042a36 BC |
4476 | /* the code reached a non block filter driver -> check if the bs is |
4477 | * the same as the candidate. It's the recursion termination condition. | |
4478 | */ | |
4479 | if (!bs->drv->is_filter) { | |
4480 | return bs == candidate; | |
212a5a8f | 4481 | } |
b5042a36 | 4482 | /* Down this path the driver is a block filter driver */ |
212a5a8f | 4483 | |
b5042a36 BC |
4484 | /* If the block filter recursion method is defined use it to recurse down |
4485 | * the node graph. | |
4486 | */ | |
4487 | if (bs->drv->bdrv_recurse_is_first_non_filter) { | |
212a5a8f | 4488 | return bs->drv->bdrv_recurse_is_first_non_filter(bs, candidate); |
f6186f49 BC |
4489 | } |
4490 | ||
b5042a36 BC |
4491 | /* the driver is a block filter but don't allow to recurse -> return false |
4492 | */ | |
4493 | return false; | |
f6186f49 BC |
4494 | } |
4495 | ||
212a5a8f BC |
4496 | /* This function checks if the candidate is the first non filter bs down it's |
4497 | * bs chain. Since we don't have pointers to parents it explore all bs chains | |
4498 | * from the top. Some filters can choose not to pass down the recursion. | |
4499 | */ | |
4500 | bool bdrv_is_first_non_filter(BlockDriverState *candidate) | |
f6186f49 | 4501 | { |
7c8eece4 | 4502 | BlockDriverState *bs; |
88be7b4b | 4503 | BdrvNextIterator it; |
212a5a8f BC |
4504 | |
4505 | /* walk down the bs forest recursively */ | |
88be7b4b | 4506 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
212a5a8f BC |
4507 | bool perm; |
4508 | ||
b5042a36 | 4509 | /* try to recurse in this top level bs */ |
e6dc8a1f | 4510 | perm = bdrv_recurse_is_first_non_filter(bs, candidate); |
212a5a8f BC |
4511 | |
4512 | /* candidate is the first non filter */ | |
4513 | if (perm) { | |
4514 | return true; | |
4515 | } | |
4516 | } | |
4517 | ||
4518 | return false; | |
f6186f49 | 4519 | } |
09158f00 | 4520 | |
e12f3784 WC |
4521 | BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs, |
4522 | const char *node_name, Error **errp) | |
09158f00 BC |
4523 | { |
4524 | BlockDriverState *to_replace_bs = bdrv_find_node(node_name); | |
5a7e7a0b SH |
4525 | AioContext *aio_context; |
4526 | ||
09158f00 BC |
4527 | if (!to_replace_bs) { |
4528 | error_setg(errp, "Node name '%s' not found", node_name); | |
4529 | return NULL; | |
4530 | } | |
4531 | ||
5a7e7a0b SH |
4532 | aio_context = bdrv_get_aio_context(to_replace_bs); |
4533 | aio_context_acquire(aio_context); | |
4534 | ||
09158f00 | 4535 | if (bdrv_op_is_blocked(to_replace_bs, BLOCK_OP_TYPE_REPLACE, errp)) { |
5a7e7a0b SH |
4536 | to_replace_bs = NULL; |
4537 | goto out; | |
09158f00 BC |
4538 | } |
4539 | ||
4540 | /* We don't want arbitrary node of the BDS chain to be replaced only the top | |
4541 | * most non filter in order to prevent data corruption. | |
4542 | * Another benefit is that this tests exclude backing files which are | |
4543 | * blocked by the backing blockers. | |
4544 | */ | |
e12f3784 | 4545 | if (!bdrv_recurse_is_first_non_filter(parent_bs, to_replace_bs)) { |
09158f00 | 4546 | error_setg(errp, "Only top most non filter can be replaced"); |
5a7e7a0b SH |
4547 | to_replace_bs = NULL; |
4548 | goto out; | |
09158f00 BC |
4549 | } |
4550 | ||
5a7e7a0b SH |
4551 | out: |
4552 | aio_context_release(aio_context); | |
09158f00 BC |
4553 | return to_replace_bs; |
4554 | } | |
448ad91d | 4555 | |
91af7014 HR |
4556 | static bool append_open_options(QDict *d, BlockDriverState *bs) |
4557 | { | |
4558 | const QDictEntry *entry; | |
9e700c1a | 4559 | QemuOptDesc *desc; |
260fecf1 | 4560 | BdrvChild *child; |
91af7014 | 4561 | bool found_any = false; |
260fecf1 | 4562 | const char *p; |
91af7014 HR |
4563 | |
4564 | for (entry = qdict_first(bs->options); entry; | |
4565 | entry = qdict_next(bs->options, entry)) | |
4566 | { | |
260fecf1 KW |
4567 | /* Exclude options for children */ |
4568 | QLIST_FOREACH(child, &bs->children, next) { | |
4569 | if (strstart(qdict_entry_key(entry), child->name, &p) | |
4570 | && (!*p || *p == '.')) | |
4571 | { | |
4572 | break; | |
4573 | } | |
4574 | } | |
4575 | if (child) { | |
9e700c1a | 4576 | continue; |
91af7014 | 4577 | } |
9e700c1a KW |
4578 | |
4579 | /* And exclude all non-driver-specific options */ | |
4580 | for (desc = bdrv_runtime_opts.desc; desc->name; desc++) { | |
4581 | if (!strcmp(qdict_entry_key(entry), desc->name)) { | |
4582 | break; | |
4583 | } | |
4584 | } | |
4585 | if (desc->name) { | |
4586 | continue; | |
4587 | } | |
4588 | ||
4589 | qobject_incref(qdict_entry_value(entry)); | |
4590 | qdict_put_obj(d, qdict_entry_key(entry), qdict_entry_value(entry)); | |
4591 | found_any = true; | |
91af7014 HR |
4592 | } |
4593 | ||
4594 | return found_any; | |
4595 | } | |
4596 | ||
4597 | /* Updates the following BDS fields: | |
4598 | * - exact_filename: A filename which may be used for opening a block device | |
4599 | * which (mostly) equals the given BDS (even without any | |
4600 | * other options; so reading and writing must return the same | |
4601 | * results, but caching etc. may be different) | |
4602 | * - full_open_options: Options which, when given when opening a block device | |
4603 | * (without a filename), result in a BDS (mostly) | |
4604 | * equalling the given one | |
4605 | * - filename: If exact_filename is set, it is copied here. Otherwise, | |
4606 | * full_open_options is converted to a JSON object, prefixed with | |
4607 | * "json:" (for use through the JSON pseudo protocol) and put here. | |
4608 | */ | |
4609 | void bdrv_refresh_filename(BlockDriverState *bs) | |
4610 | { | |
4611 | BlockDriver *drv = bs->drv; | |
4612 | QDict *opts; | |
4613 | ||
4614 | if (!drv) { | |
4615 | return; | |
4616 | } | |
4617 | ||
4618 | /* This BDS's file name will most probably depend on its file's name, so | |
4619 | * refresh that first */ | |
4620 | if (bs->file) { | |
9a4f4c31 | 4621 | bdrv_refresh_filename(bs->file->bs); |
91af7014 HR |
4622 | } |
4623 | ||
4624 | if (drv->bdrv_refresh_filename) { | |
4625 | /* Obsolete information is of no use here, so drop the old file name | |
4626 | * information before refreshing it */ | |
4627 | bs->exact_filename[0] = '\0'; | |
4628 | if (bs->full_open_options) { | |
4629 | QDECREF(bs->full_open_options); | |
4630 | bs->full_open_options = NULL; | |
4631 | } | |
4632 | ||
4cdd01d3 KW |
4633 | opts = qdict_new(); |
4634 | append_open_options(opts, bs); | |
4635 | drv->bdrv_refresh_filename(bs, opts); | |
4636 | QDECREF(opts); | |
91af7014 HR |
4637 | } else if (bs->file) { |
4638 | /* Try to reconstruct valid information from the underlying file */ | |
4639 | bool has_open_options; | |
4640 | ||
4641 | bs->exact_filename[0] = '\0'; | |
4642 | if (bs->full_open_options) { | |
4643 | QDECREF(bs->full_open_options); | |
4644 | bs->full_open_options = NULL; | |
4645 | } | |
4646 | ||
4647 | opts = qdict_new(); | |
4648 | has_open_options = append_open_options(opts, bs); | |
4649 | ||
4650 | /* If no specific options have been given for this BDS, the filename of | |
4651 | * the underlying file should suffice for this one as well */ | |
9a4f4c31 KW |
4652 | if (bs->file->bs->exact_filename[0] && !has_open_options) { |
4653 | strcpy(bs->exact_filename, bs->file->bs->exact_filename); | |
91af7014 HR |
4654 | } |
4655 | /* Reconstructing the full options QDict is simple for most format block | |
4656 | * drivers, as long as the full options are known for the underlying | |
4657 | * file BDS. The full options QDict of that file BDS should somehow | |
4658 | * contain a representation of the filename, therefore the following | |
4659 | * suffices without querying the (exact_)filename of this BDS. */ | |
9a4f4c31 | 4660 | if (bs->file->bs->full_open_options) { |
91af7014 HR |
4661 | qdict_put_obj(opts, "driver", |
4662 | QOBJECT(qstring_from_str(drv->format_name))); | |
9a4f4c31 KW |
4663 | QINCREF(bs->file->bs->full_open_options); |
4664 | qdict_put_obj(opts, "file", | |
4665 | QOBJECT(bs->file->bs->full_open_options)); | |
91af7014 HR |
4666 | |
4667 | bs->full_open_options = opts; | |
4668 | } else { | |
4669 | QDECREF(opts); | |
4670 | } | |
4671 | } else if (!bs->full_open_options && qdict_size(bs->options)) { | |
4672 | /* There is no underlying file BDS (at least referenced by BDS.file), | |
4673 | * so the full options QDict should be equal to the options given | |
4674 | * specifically for this block device when it was opened (plus the | |
4675 | * driver specification). | |
4676 | * Because those options don't change, there is no need to update | |
4677 | * full_open_options when it's already set. */ | |
4678 | ||
4679 | opts = qdict_new(); | |
4680 | append_open_options(opts, bs); | |
4681 | qdict_put_obj(opts, "driver", | |
4682 | QOBJECT(qstring_from_str(drv->format_name))); | |
4683 | ||
4684 | if (bs->exact_filename[0]) { | |
4685 | /* This may not work for all block protocol drivers (some may | |
4686 | * require this filename to be parsed), but we have to find some | |
4687 | * default solution here, so just include it. If some block driver | |
4688 | * does not support pure options without any filename at all or | |
4689 | * needs some special format of the options QDict, it needs to | |
4690 | * implement the driver-specific bdrv_refresh_filename() function. | |
4691 | */ | |
4692 | qdict_put_obj(opts, "filename", | |
4693 | QOBJECT(qstring_from_str(bs->exact_filename))); | |
4694 | } | |
4695 | ||
4696 | bs->full_open_options = opts; | |
4697 | } | |
4698 | ||
4699 | if (bs->exact_filename[0]) { | |
4700 | pstrcpy(bs->filename, sizeof(bs->filename), bs->exact_filename); | |
4701 | } else if (bs->full_open_options) { | |
4702 | QString *json = qobject_to_json(QOBJECT(bs->full_open_options)); | |
4703 | snprintf(bs->filename, sizeof(bs->filename), "json:%s", | |
4704 | qstring_get_str(json)); | |
4705 | QDECREF(json); | |
4706 | } | |
4707 | } | |
e06018ad WC |
4708 | |
4709 | /* | |
4710 | * Hot add/remove a BDS's child. So the user can take a child offline when | |
4711 | * it is broken and take a new child online | |
4712 | */ | |
4713 | void bdrv_add_child(BlockDriverState *parent_bs, BlockDriverState *child_bs, | |
4714 | Error **errp) | |
4715 | { | |
4716 | ||
4717 | if (!parent_bs->drv || !parent_bs->drv->bdrv_add_child) { | |
4718 | error_setg(errp, "The node %s does not support adding a child", | |
4719 | bdrv_get_device_or_node_name(parent_bs)); | |
4720 | return; | |
4721 | } | |
4722 | ||
4723 | if (!QLIST_EMPTY(&child_bs->parents)) { | |
4724 | error_setg(errp, "The node %s already has a parent", | |
4725 | child_bs->node_name); | |
4726 | return; | |
4727 | } | |
4728 | ||
4729 | parent_bs->drv->bdrv_add_child(parent_bs, child_bs, errp); | |
4730 | } | |
4731 | ||
4732 | void bdrv_del_child(BlockDriverState *parent_bs, BdrvChild *child, Error **errp) | |
4733 | { | |
4734 | BdrvChild *tmp; | |
4735 | ||
4736 | if (!parent_bs->drv || !parent_bs->drv->bdrv_del_child) { | |
4737 | error_setg(errp, "The node %s does not support removing a child", | |
4738 | bdrv_get_device_or_node_name(parent_bs)); | |
4739 | return; | |
4740 | } | |
4741 | ||
4742 | QLIST_FOREACH(tmp, &parent_bs->children, next) { | |
4743 | if (tmp == child) { | |
4744 | break; | |
4745 | } | |
4746 | } | |
4747 | ||
4748 | if (!tmp) { | |
4749 | error_setg(errp, "The node %s does not have a child named %s", | |
4750 | bdrv_get_device_or_node_name(parent_bs), | |
4751 | bdrv_get_device_or_node_name(child->bs)); | |
4752 | return; | |
4753 | } | |
4754 | ||
4755 | parent_bs->drv->bdrv_del_child(parent_bs, child, errp); | |
4756 | } |