]>
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 | */ | |
e688df6b | 24 | |
d38ea87a | 25 | #include "qemu/osdep.h" |
0ab8ed18 | 26 | #include "block/trace.h" |
737e150e PB |
27 | #include "block/block_int.h" |
28 | #include "block/blockjob.h" | |
cd7fca95 | 29 | #include "block/nbd.h" |
609f45ea | 30 | #include "block/qdict.h" |
d49b6836 | 31 | #include "qemu/error-report.h" |
88d88798 | 32 | #include "module_block.h" |
1de7afc9 | 33 | #include "qemu/module.h" |
e688df6b | 34 | #include "qapi/error.h" |
452fcdbc | 35 | #include "qapi/qmp/qdict.h" |
7b1b5d19 | 36 | #include "qapi/qmp/qjson.h" |
e59a0cf1 | 37 | #include "qapi/qmp/qnull.h" |
fc81fa1e | 38 | #include "qapi/qmp/qstring.h" |
e1d74bc6 KW |
39 | #include "qapi/qobject-output-visitor.h" |
40 | #include "qapi/qapi-visit-block-core.h" | |
bfb197e0 | 41 | #include "sysemu/block-backend.h" |
9c17d615 | 42 | #include "sysemu/sysemu.h" |
1de7afc9 | 43 | #include "qemu/notify.h" |
922a01a0 | 44 | #include "qemu/option.h" |
10817bf0 | 45 | #include "qemu/coroutine.h" |
c13163fb | 46 | #include "block/qapi.h" |
1de7afc9 | 47 | #include "qemu/timer.h" |
f348b6d1 VB |
48 | #include "qemu/cutils.h" |
49 | #include "qemu/id.h" | |
fc01f7e7 | 50 | |
71e72a19 | 51 | #ifdef CONFIG_BSD |
7674e7bf | 52 | #include <sys/ioctl.h> |
72cf2d4f | 53 | #include <sys/queue.h> |
c5e97233 | 54 | #ifndef __DragonFly__ |
7674e7bf FB |
55 | #include <sys/disk.h> |
56 | #endif | |
c5e97233 | 57 | #endif |
7674e7bf | 58 | |
49dc768d AL |
59 | #ifdef _WIN32 |
60 | #include <windows.h> | |
61 | #endif | |
62 | ||
1c9805a3 SH |
63 | #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */ |
64 | ||
dc364f4c BC |
65 | static QTAILQ_HEAD(, BlockDriverState) graph_bdrv_states = |
66 | QTAILQ_HEAD_INITIALIZER(graph_bdrv_states); | |
67 | ||
2c1d04e0 HR |
68 | static QTAILQ_HEAD(, BlockDriverState) all_bdrv_states = |
69 | QTAILQ_HEAD_INITIALIZER(all_bdrv_states); | |
70 | ||
8a22f02a SH |
71 | static QLIST_HEAD(, BlockDriver) bdrv_drivers = |
72 | QLIST_HEAD_INITIALIZER(bdrv_drivers); | |
ea2384d3 | 73 | |
5b363937 HR |
74 | static BlockDriverState *bdrv_open_inherit(const char *filename, |
75 | const char *reference, | |
76 | QDict *options, int flags, | |
77 | BlockDriverState *parent, | |
78 | const BdrvChildRole *child_role, | |
79 | Error **errp); | |
f3930ed0 | 80 | |
eb852011 MA |
81 | /* If non-zero, use only whitelisted block drivers */ |
82 | static int use_bdrv_whitelist; | |
83 | ||
9e0b22f4 SH |
84 | #ifdef _WIN32 |
85 | static int is_windows_drive_prefix(const char *filename) | |
86 | { | |
87 | return (((filename[0] >= 'a' && filename[0] <= 'z') || | |
88 | (filename[0] >= 'A' && filename[0] <= 'Z')) && | |
89 | filename[1] == ':'); | |
90 | } | |
91 | ||
92 | int is_windows_drive(const char *filename) | |
93 | { | |
94 | if (is_windows_drive_prefix(filename) && | |
95 | filename[2] == '\0') | |
96 | return 1; | |
97 | if (strstart(filename, "\\\\.\\", NULL) || | |
98 | strstart(filename, "//./", NULL)) | |
99 | return 1; | |
100 | return 0; | |
101 | } | |
102 | #endif | |
103 | ||
339064d5 KW |
104 | size_t bdrv_opt_mem_align(BlockDriverState *bs) |
105 | { | |
106 | if (!bs || !bs->drv) { | |
459b4e66 DL |
107 | /* page size or 4k (hdd sector size) should be on the safe side */ |
108 | return MAX(4096, getpagesize()); | |
339064d5 KW |
109 | } |
110 | ||
111 | return bs->bl.opt_mem_alignment; | |
112 | } | |
113 | ||
4196d2f0 DL |
114 | size_t bdrv_min_mem_align(BlockDriverState *bs) |
115 | { | |
116 | if (!bs || !bs->drv) { | |
459b4e66 DL |
117 | /* page size or 4k (hdd sector size) should be on the safe side */ |
118 | return MAX(4096, getpagesize()); | |
4196d2f0 DL |
119 | } |
120 | ||
121 | return bs->bl.min_mem_alignment; | |
122 | } | |
123 | ||
9e0b22f4 | 124 | /* check if the path starts with "<protocol>:" */ |
5c98415b | 125 | int path_has_protocol(const char *path) |
9e0b22f4 | 126 | { |
947995c0 PB |
127 | const char *p; |
128 | ||
9e0b22f4 SH |
129 | #ifdef _WIN32 |
130 | if (is_windows_drive(path) || | |
131 | is_windows_drive_prefix(path)) { | |
132 | return 0; | |
133 | } | |
947995c0 PB |
134 | p = path + strcspn(path, ":/\\"); |
135 | #else | |
136 | p = path + strcspn(path, ":/"); | |
9e0b22f4 SH |
137 | #endif |
138 | ||
947995c0 | 139 | return *p == ':'; |
9e0b22f4 SH |
140 | } |
141 | ||
83f64091 | 142 | int path_is_absolute(const char *path) |
3b0d4f61 | 143 | { |
21664424 FB |
144 | #ifdef _WIN32 |
145 | /* specific case for names like: "\\.\d:" */ | |
f53f4da9 | 146 | if (is_windows_drive(path) || is_windows_drive_prefix(path)) { |
21664424 | 147 | return 1; |
f53f4da9 PB |
148 | } |
149 | return (*path == '/' || *path == '\\'); | |
3b9f94e1 | 150 | #else |
f53f4da9 | 151 | return (*path == '/'); |
3b9f94e1 | 152 | #endif |
3b0d4f61 FB |
153 | } |
154 | ||
83f64091 FB |
155 | /* if filename is absolute, just copy it to dest. Otherwise, build a |
156 | path to it by considering it is relative to base_path. URL are | |
157 | supported. */ | |
158 | void path_combine(char *dest, int dest_size, | |
159 | const char *base_path, | |
160 | const char *filename) | |
3b0d4f61 | 161 | { |
83f64091 FB |
162 | const char *p, *p1; |
163 | int len; | |
164 | ||
165 | if (dest_size <= 0) | |
166 | return; | |
167 | if (path_is_absolute(filename)) { | |
168 | pstrcpy(dest, dest_size, filename); | |
169 | } else { | |
0d54a6fe HR |
170 | const char *protocol_stripped = NULL; |
171 | ||
172 | if (path_has_protocol(base_path)) { | |
173 | protocol_stripped = strchr(base_path, ':'); | |
174 | if (protocol_stripped) { | |
175 | protocol_stripped++; | |
176 | } | |
177 | } | |
178 | p = protocol_stripped ?: base_path; | |
179 | ||
3b9f94e1 FB |
180 | p1 = strrchr(base_path, '/'); |
181 | #ifdef _WIN32 | |
182 | { | |
183 | const char *p2; | |
184 | p2 = strrchr(base_path, '\\'); | |
185 | if (!p1 || p2 > p1) | |
186 | p1 = p2; | |
187 | } | |
188 | #endif | |
83f64091 FB |
189 | if (p1) |
190 | p1++; | |
191 | else | |
192 | p1 = base_path; | |
193 | if (p1 > p) | |
194 | p = p1; | |
195 | len = p - base_path; | |
196 | if (len > dest_size - 1) | |
197 | len = dest_size - 1; | |
198 | memcpy(dest, base_path, len); | |
199 | dest[len] = '\0'; | |
200 | pstrcat(dest, dest_size, filename); | |
3b0d4f61 | 201 | } |
3b0d4f61 FB |
202 | } |
203 | ||
03c320d8 HR |
204 | /* |
205 | * Helper function for bdrv_parse_filename() implementations to remove optional | |
206 | * protocol prefixes (especially "file:") from a filename and for putting the | |
207 | * stripped filename into the options QDict if there is such a prefix. | |
208 | */ | |
209 | void bdrv_parse_filename_strip_prefix(const char *filename, const char *prefix, | |
210 | QDict *options) | |
211 | { | |
212 | if (strstart(filename, prefix, &filename)) { | |
213 | /* Stripping the explicit protocol prefix may result in a protocol | |
214 | * prefix being (wrongly) detected (if the filename contains a colon) */ | |
215 | if (path_has_protocol(filename)) { | |
216 | QString *fat_filename; | |
217 | ||
218 | /* This means there is some colon before the first slash; therefore, | |
219 | * this cannot be an absolute path */ | |
220 | assert(!path_is_absolute(filename)); | |
221 | ||
222 | /* And we can thus fix the protocol detection issue by prefixing it | |
223 | * by "./" */ | |
224 | fat_filename = qstring_from_str("./"); | |
225 | qstring_append(fat_filename, filename); | |
226 | ||
227 | assert(!path_has_protocol(qstring_get_str(fat_filename))); | |
228 | ||
229 | qdict_put(options, "filename", fat_filename); | |
230 | } else { | |
231 | /* If no protocol prefix was detected, we can use the shortened | |
232 | * filename as-is */ | |
233 | qdict_put_str(options, "filename", filename); | |
234 | } | |
235 | } | |
236 | } | |
237 | ||
238 | ||
9c5e6594 KW |
239 | /* Returns whether the image file is opened as read-only. Note that this can |
240 | * return false and writing to the image file is still not possible because the | |
241 | * image is inactivated. */ | |
93ed524e JC |
242 | bool bdrv_is_read_only(BlockDriverState *bs) |
243 | { | |
244 | return bs->read_only; | |
245 | } | |
246 | ||
54a32bfe KW |
247 | int bdrv_can_set_read_only(BlockDriverState *bs, bool read_only, |
248 | bool ignore_allow_rdw, Error **errp) | |
fe5241bf | 249 | { |
e2b8247a JC |
250 | /* Do not set read_only if copy_on_read is enabled */ |
251 | if (bs->copy_on_read && read_only) { | |
252 | error_setg(errp, "Can't set node '%s' to r/o with copy-on-read enabled", | |
253 | bdrv_get_device_or_node_name(bs)); | |
254 | return -EINVAL; | |
255 | } | |
256 | ||
d6fcdf06 | 257 | /* Do not clear read_only if it is prohibited */ |
54a32bfe KW |
258 | if (!read_only && !(bs->open_flags & BDRV_O_ALLOW_RDWR) && |
259 | !ignore_allow_rdw) | |
260 | { | |
d6fcdf06 JC |
261 | error_setg(errp, "Node '%s' is read only", |
262 | bdrv_get_device_or_node_name(bs)); | |
263 | return -EPERM; | |
264 | } | |
265 | ||
45803a03 JC |
266 | return 0; |
267 | } | |
268 | ||
398e6ad0 KW |
269 | /* TODO Remove (deprecated since 2.11) |
270 | * Block drivers are not supposed to automatically change bs->read_only. | |
271 | * Instead, they should just check whether they can provide what the user | |
272 | * explicitly requested and error out if read-write is requested, but they can | |
273 | * only provide read-only access. */ | |
45803a03 JC |
274 | int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp) |
275 | { | |
276 | int ret = 0; | |
277 | ||
54a32bfe | 278 | ret = bdrv_can_set_read_only(bs, read_only, false, errp); |
45803a03 JC |
279 | if (ret < 0) { |
280 | return ret; | |
281 | } | |
282 | ||
fe5241bf | 283 | bs->read_only = read_only; |
e2b8247a | 284 | return 0; |
fe5241bf JC |
285 | } |
286 | ||
0a82855a HR |
287 | void bdrv_get_full_backing_filename_from_filename(const char *backed, |
288 | const char *backing, | |
9f07429e HR |
289 | char *dest, size_t sz, |
290 | Error **errp) | |
dc5a1371 | 291 | { |
9f07429e HR |
292 | if (backing[0] == '\0' || path_has_protocol(backing) || |
293 | path_is_absolute(backing)) | |
294 | { | |
0a82855a | 295 | pstrcpy(dest, sz, backing); |
9f07429e HR |
296 | } else if (backed[0] == '\0' || strstart(backed, "json:", NULL)) { |
297 | error_setg(errp, "Cannot use relative backing file names for '%s'", | |
298 | backed); | |
dc5a1371 | 299 | } else { |
0a82855a | 300 | path_combine(dest, sz, backed, backing); |
dc5a1371 PB |
301 | } |
302 | } | |
303 | ||
9f07429e HR |
304 | void bdrv_get_full_backing_filename(BlockDriverState *bs, char *dest, size_t sz, |
305 | Error **errp) | |
0a82855a | 306 | { |
9f07429e HR |
307 | char *backed = bs->exact_filename[0] ? bs->exact_filename : bs->filename; |
308 | ||
309 | bdrv_get_full_backing_filename_from_filename(backed, bs->backing_file, | |
310 | dest, sz, errp); | |
0a82855a HR |
311 | } |
312 | ||
0eb7217e SH |
313 | void bdrv_register(BlockDriver *bdrv) |
314 | { | |
8a22f02a | 315 | QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list); |
ea2384d3 | 316 | } |
b338082b | 317 | |
e4e9986b MA |
318 | BlockDriverState *bdrv_new(void) |
319 | { | |
320 | BlockDriverState *bs; | |
321 | int i; | |
322 | ||
5839e53b | 323 | bs = g_new0(BlockDriverState, 1); |
e4654d2d | 324 | QLIST_INIT(&bs->dirty_bitmaps); |
fbe40ff7 FZ |
325 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { |
326 | QLIST_INIT(&bs->op_blockers[i]); | |
327 | } | |
d616b224 | 328 | notifier_with_return_list_init(&bs->before_write_notifiers); |
3783fa3d | 329 | qemu_co_mutex_init(&bs->reqs_lock); |
2119882c | 330 | qemu_mutex_init(&bs->dirty_bitmap_mutex); |
9fcb0251 | 331 | bs->refcnt = 1; |
dcd04228 | 332 | bs->aio_context = qemu_get_aio_context(); |
d7d512f6 | 333 | |
3ff2f67a EY |
334 | qemu_co_queue_init(&bs->flush_queue); |
335 | ||
2c1d04e0 HR |
336 | QTAILQ_INSERT_TAIL(&all_bdrv_states, bs, bs_list); |
337 | ||
b338082b FB |
338 | return bs; |
339 | } | |
340 | ||
88d88798 | 341 | static BlockDriver *bdrv_do_find_format(const char *format_name) |
ea2384d3 FB |
342 | { |
343 | BlockDriver *drv1; | |
88d88798 | 344 | |
8a22f02a SH |
345 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { |
346 | if (!strcmp(drv1->format_name, format_name)) { | |
ea2384d3 | 347 | return drv1; |
8a22f02a | 348 | } |
ea2384d3 | 349 | } |
88d88798 | 350 | |
ea2384d3 FB |
351 | return NULL; |
352 | } | |
353 | ||
88d88798 MM |
354 | BlockDriver *bdrv_find_format(const char *format_name) |
355 | { | |
356 | BlockDriver *drv1; | |
357 | int i; | |
358 | ||
359 | drv1 = bdrv_do_find_format(format_name); | |
360 | if (drv1) { | |
361 | return drv1; | |
362 | } | |
363 | ||
364 | /* The driver isn't registered, maybe we need to load a module */ | |
365 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); ++i) { | |
366 | if (!strcmp(block_driver_modules[i].format_name, format_name)) { | |
367 | block_module_load_one(block_driver_modules[i].library_name); | |
368 | break; | |
369 | } | |
370 | } | |
371 | ||
372 | return bdrv_do_find_format(format_name); | |
373 | } | |
374 | ||
e8eb8637 | 375 | int bdrv_is_whitelisted(BlockDriver *drv, bool read_only) |
eb852011 | 376 | { |
b64ec4e4 FZ |
377 | static const char *whitelist_rw[] = { |
378 | CONFIG_BDRV_RW_WHITELIST | |
379 | }; | |
380 | static const char *whitelist_ro[] = { | |
381 | CONFIG_BDRV_RO_WHITELIST | |
eb852011 MA |
382 | }; |
383 | const char **p; | |
384 | ||
b64ec4e4 | 385 | if (!whitelist_rw[0] && !whitelist_ro[0]) { |
eb852011 | 386 | return 1; /* no whitelist, anything goes */ |
b64ec4e4 | 387 | } |
eb852011 | 388 | |
b64ec4e4 | 389 | for (p = whitelist_rw; *p; p++) { |
eb852011 MA |
390 | if (!strcmp(drv->format_name, *p)) { |
391 | return 1; | |
392 | } | |
393 | } | |
b64ec4e4 FZ |
394 | if (read_only) { |
395 | for (p = whitelist_ro; *p; p++) { | |
396 | if (!strcmp(drv->format_name, *p)) { | |
397 | return 1; | |
398 | } | |
399 | } | |
400 | } | |
eb852011 MA |
401 | return 0; |
402 | } | |
403 | ||
e6ff69bf DB |
404 | bool bdrv_uses_whitelist(void) |
405 | { | |
406 | return use_bdrv_whitelist; | |
407 | } | |
408 | ||
5b7e1542 ZYW |
409 | typedef struct CreateCo { |
410 | BlockDriver *drv; | |
411 | char *filename; | |
83d0521a | 412 | QemuOpts *opts; |
5b7e1542 | 413 | int ret; |
cc84d90f | 414 | Error *err; |
5b7e1542 ZYW |
415 | } CreateCo; |
416 | ||
417 | static void coroutine_fn bdrv_create_co_entry(void *opaque) | |
418 | { | |
cc84d90f HR |
419 | Error *local_err = NULL; |
420 | int ret; | |
421 | ||
5b7e1542 ZYW |
422 | CreateCo *cco = opaque; |
423 | assert(cco->drv); | |
424 | ||
efc75e2a | 425 | ret = cco->drv->bdrv_co_create_opts(cco->filename, cco->opts, &local_err); |
621ff94d | 426 | error_propagate(&cco->err, local_err); |
cc84d90f | 427 | cco->ret = ret; |
5b7e1542 ZYW |
428 | } |
429 | ||
0e7e1989 | 430 | int bdrv_create(BlockDriver *drv, const char* filename, |
83d0521a | 431 | QemuOpts *opts, Error **errp) |
ea2384d3 | 432 | { |
5b7e1542 ZYW |
433 | int ret; |
434 | ||
435 | Coroutine *co; | |
436 | CreateCo cco = { | |
437 | .drv = drv, | |
438 | .filename = g_strdup(filename), | |
83d0521a | 439 | .opts = opts, |
5b7e1542 | 440 | .ret = NOT_DONE, |
cc84d90f | 441 | .err = NULL, |
5b7e1542 ZYW |
442 | }; |
443 | ||
efc75e2a | 444 | if (!drv->bdrv_co_create_opts) { |
cc84d90f | 445 | error_setg(errp, "Driver '%s' does not support image creation", drv->format_name); |
80168bff LC |
446 | ret = -ENOTSUP; |
447 | goto out; | |
5b7e1542 ZYW |
448 | } |
449 | ||
450 | if (qemu_in_coroutine()) { | |
451 | /* Fast-path if already in coroutine context */ | |
452 | bdrv_create_co_entry(&cco); | |
453 | } else { | |
0b8b8753 PB |
454 | co = qemu_coroutine_create(bdrv_create_co_entry, &cco); |
455 | qemu_coroutine_enter(co); | |
5b7e1542 | 456 | while (cco.ret == NOT_DONE) { |
b47ec2c4 | 457 | aio_poll(qemu_get_aio_context(), true); |
5b7e1542 ZYW |
458 | } |
459 | } | |
460 | ||
461 | ret = cco.ret; | |
cc84d90f | 462 | if (ret < 0) { |
84d18f06 | 463 | if (cco.err) { |
cc84d90f HR |
464 | error_propagate(errp, cco.err); |
465 | } else { | |
466 | error_setg_errno(errp, -ret, "Could not create image"); | |
467 | } | |
468 | } | |
0e7e1989 | 469 | |
80168bff LC |
470 | out: |
471 | g_free(cco.filename); | |
5b7e1542 | 472 | return ret; |
ea2384d3 FB |
473 | } |
474 | ||
c282e1fd | 475 | int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp) |
84a12e66 CH |
476 | { |
477 | BlockDriver *drv; | |
cc84d90f HR |
478 | Error *local_err = NULL; |
479 | int ret; | |
84a12e66 | 480 | |
b65a5e12 | 481 | drv = bdrv_find_protocol(filename, true, errp); |
84a12e66 | 482 | if (drv == NULL) { |
16905d71 | 483 | return -ENOENT; |
84a12e66 CH |
484 | } |
485 | ||
c282e1fd | 486 | ret = bdrv_create(drv, filename, opts, &local_err); |
621ff94d | 487 | error_propagate(errp, local_err); |
cc84d90f | 488 | return ret; |
84a12e66 CH |
489 | } |
490 | ||
892b7de8 ET |
491 | /** |
492 | * Try to get @bs's logical and physical block size. | |
493 | * On success, store them in @bsz struct and return 0. | |
494 | * On failure return -errno. | |
495 | * @bs must not be empty. | |
496 | */ | |
497 | int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz) | |
498 | { | |
499 | BlockDriver *drv = bs->drv; | |
500 | ||
501 | if (drv && drv->bdrv_probe_blocksizes) { | |
502 | return drv->bdrv_probe_blocksizes(bs, bsz); | |
5a612c00 MP |
503 | } else if (drv && drv->is_filter && bs->file) { |
504 | return bdrv_probe_blocksizes(bs->file->bs, bsz); | |
892b7de8 ET |
505 | } |
506 | ||
507 | return -ENOTSUP; | |
508 | } | |
509 | ||
510 | /** | |
511 | * Try to get @bs's geometry (cyls, heads, sectors). | |
512 | * On success, store them in @geo struct and return 0. | |
513 | * On failure return -errno. | |
514 | * @bs must not be empty. | |
515 | */ | |
516 | int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo) | |
517 | { | |
518 | BlockDriver *drv = bs->drv; | |
519 | ||
520 | if (drv && drv->bdrv_probe_geometry) { | |
521 | return drv->bdrv_probe_geometry(bs, geo); | |
5a612c00 MP |
522 | } else if (drv && drv->is_filter && bs->file) { |
523 | return bdrv_probe_geometry(bs->file->bs, geo); | |
892b7de8 ET |
524 | } |
525 | ||
526 | return -ENOTSUP; | |
527 | } | |
528 | ||
eba25057 JM |
529 | /* |
530 | * Create a uniquely-named empty temporary file. | |
531 | * Return 0 upon success, otherwise a negative errno value. | |
532 | */ | |
533 | int get_tmp_filename(char *filename, int size) | |
d5249393 | 534 | { |
eba25057 | 535 | #ifdef _WIN32 |
3b9f94e1 | 536 | char temp_dir[MAX_PATH]; |
eba25057 JM |
537 | /* GetTempFileName requires that its output buffer (4th param) |
538 | have length MAX_PATH or greater. */ | |
539 | assert(size >= MAX_PATH); | |
540 | return (GetTempPath(MAX_PATH, temp_dir) | |
541 | && GetTempFileName(temp_dir, "qem", 0, filename) | |
542 | ? 0 : -GetLastError()); | |
d5249393 | 543 | #else |
67b915a5 | 544 | int fd; |
7ccfb2eb | 545 | const char *tmpdir; |
0badc1ee | 546 | tmpdir = getenv("TMPDIR"); |
69bef793 AS |
547 | if (!tmpdir) { |
548 | tmpdir = "/var/tmp"; | |
549 | } | |
eba25057 JM |
550 | if (snprintf(filename, size, "%s/vl.XXXXXX", tmpdir) >= size) { |
551 | return -EOVERFLOW; | |
552 | } | |
ea2384d3 | 553 | fd = mkstemp(filename); |
fe235a06 DH |
554 | if (fd < 0) { |
555 | return -errno; | |
556 | } | |
557 | if (close(fd) != 0) { | |
558 | unlink(filename); | |
eba25057 JM |
559 | return -errno; |
560 | } | |
561 | return 0; | |
d5249393 | 562 | #endif |
eba25057 | 563 | } |
fc01f7e7 | 564 | |
84a12e66 CH |
565 | /* |
566 | * Detect host devices. By convention, /dev/cdrom[N] is always | |
567 | * recognized as a host CDROM. | |
568 | */ | |
569 | static BlockDriver *find_hdev_driver(const char *filename) | |
570 | { | |
571 | int score_max = 0, score; | |
572 | BlockDriver *drv = NULL, *d; | |
573 | ||
574 | QLIST_FOREACH(d, &bdrv_drivers, list) { | |
575 | if (d->bdrv_probe_device) { | |
576 | score = d->bdrv_probe_device(filename); | |
577 | if (score > score_max) { | |
578 | score_max = score; | |
579 | drv = d; | |
580 | } | |
581 | } | |
582 | } | |
583 | ||
584 | return drv; | |
585 | } | |
586 | ||
88d88798 MM |
587 | static BlockDriver *bdrv_do_find_protocol(const char *protocol) |
588 | { | |
589 | BlockDriver *drv1; | |
590 | ||
591 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { | |
592 | if (drv1->protocol_name && !strcmp(drv1->protocol_name, protocol)) { | |
593 | return drv1; | |
594 | } | |
595 | } | |
596 | ||
597 | return NULL; | |
598 | } | |
599 | ||
98289620 | 600 | BlockDriver *bdrv_find_protocol(const char *filename, |
b65a5e12 HR |
601 | bool allow_protocol_prefix, |
602 | Error **errp) | |
83f64091 FB |
603 | { |
604 | BlockDriver *drv1; | |
605 | char protocol[128]; | |
1cec71e3 | 606 | int len; |
83f64091 | 607 | const char *p; |
88d88798 | 608 | int i; |
19cb3738 | 609 | |
66f82cee KW |
610 | /* TODO Drivers without bdrv_file_open must be specified explicitly */ |
611 | ||
39508e7a CH |
612 | /* |
613 | * XXX(hch): we really should not let host device detection | |
614 | * override an explicit protocol specification, but moving this | |
615 | * later breaks access to device names with colons in them. | |
616 | * Thanks to the brain-dead persistent naming schemes on udev- | |
617 | * based Linux systems those actually are quite common. | |
618 | */ | |
619 | drv1 = find_hdev_driver(filename); | |
620 | if (drv1) { | |
621 | return drv1; | |
622 | } | |
623 | ||
98289620 | 624 | if (!path_has_protocol(filename) || !allow_protocol_prefix) { |
ef810437 | 625 | return &bdrv_file; |
84a12e66 | 626 | } |
98289620 | 627 | |
9e0b22f4 SH |
628 | p = strchr(filename, ':'); |
629 | assert(p != NULL); | |
1cec71e3 AL |
630 | len = p - filename; |
631 | if (len > sizeof(protocol) - 1) | |
632 | len = sizeof(protocol) - 1; | |
633 | memcpy(protocol, filename, len); | |
634 | protocol[len] = '\0'; | |
88d88798 MM |
635 | |
636 | drv1 = bdrv_do_find_protocol(protocol); | |
637 | if (drv1) { | |
638 | return drv1; | |
639 | } | |
640 | ||
641 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); ++i) { | |
642 | if (block_driver_modules[i].protocol_name && | |
643 | !strcmp(block_driver_modules[i].protocol_name, protocol)) { | |
644 | block_module_load_one(block_driver_modules[i].library_name); | |
645 | break; | |
8a22f02a | 646 | } |
83f64091 | 647 | } |
b65a5e12 | 648 | |
88d88798 MM |
649 | drv1 = bdrv_do_find_protocol(protocol); |
650 | if (!drv1) { | |
651 | error_setg(errp, "Unknown protocol '%s'", protocol); | |
652 | } | |
653 | return drv1; | |
83f64091 FB |
654 | } |
655 | ||
c6684249 MA |
656 | /* |
657 | * Guess image format by probing its contents. | |
658 | * This is not a good idea when your image is raw (CVE-2008-2004), but | |
659 | * we do it anyway for backward compatibility. | |
660 | * | |
661 | * @buf contains the image's first @buf_size bytes. | |
7cddd372 KW |
662 | * @buf_size is the buffer size in bytes (generally BLOCK_PROBE_BUF_SIZE, |
663 | * but can be smaller if the image file is smaller) | |
c6684249 MA |
664 | * @filename is its filename. |
665 | * | |
666 | * For all block drivers, call the bdrv_probe() method to get its | |
667 | * probing score. | |
668 | * Return the first block driver with the highest probing score. | |
669 | */ | |
38f3ef57 KW |
670 | BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size, |
671 | const char *filename) | |
c6684249 MA |
672 | { |
673 | int score_max = 0, score; | |
674 | BlockDriver *drv = NULL, *d; | |
675 | ||
676 | QLIST_FOREACH(d, &bdrv_drivers, list) { | |
677 | if (d->bdrv_probe) { | |
678 | score = d->bdrv_probe(buf, buf_size, filename); | |
679 | if (score > score_max) { | |
680 | score_max = score; | |
681 | drv = d; | |
682 | } | |
683 | } | |
684 | } | |
685 | ||
686 | return drv; | |
687 | } | |
688 | ||
5696c6e3 | 689 | static int find_image_format(BlockBackend *file, const char *filename, |
34b5d2c6 | 690 | BlockDriver **pdrv, Error **errp) |
f3a5d3f8 | 691 | { |
c6684249 | 692 | BlockDriver *drv; |
7cddd372 | 693 | uint8_t buf[BLOCK_PROBE_BUF_SIZE]; |
f500a6d3 | 694 | int ret = 0; |
f8ea0b00 | 695 | |
08a00559 | 696 | /* Return the raw BlockDriver * to scsi-generic devices or empty drives */ |
5696c6e3 | 697 | if (blk_is_sg(file) || !blk_is_inserted(file) || blk_getlength(file) == 0) { |
ef810437 | 698 | *pdrv = &bdrv_raw; |
c98ac35d | 699 | return ret; |
1a396859 | 700 | } |
f8ea0b00 | 701 | |
5696c6e3 | 702 | ret = blk_pread(file, 0, buf, sizeof(buf)); |
83f64091 | 703 | if (ret < 0) { |
34b5d2c6 HR |
704 | error_setg_errno(errp, -ret, "Could not read image for determining its " |
705 | "format"); | |
c98ac35d SW |
706 | *pdrv = NULL; |
707 | return ret; | |
83f64091 FB |
708 | } |
709 | ||
c6684249 | 710 | drv = bdrv_probe_all(buf, ret, filename); |
c98ac35d | 711 | if (!drv) { |
34b5d2c6 HR |
712 | error_setg(errp, "Could not determine image format: No compatible " |
713 | "driver found"); | |
c98ac35d SW |
714 | ret = -ENOENT; |
715 | } | |
716 | *pdrv = drv; | |
717 | return ret; | |
ea2384d3 FB |
718 | } |
719 | ||
51762288 SH |
720 | /** |
721 | * Set the current 'total_sectors' value | |
65a9bb25 | 722 | * Return 0 on success, -errno on error. |
51762288 SH |
723 | */ |
724 | static int refresh_total_sectors(BlockDriverState *bs, int64_t hint) | |
725 | { | |
726 | BlockDriver *drv = bs->drv; | |
727 | ||
d470ad42 HR |
728 | if (!drv) { |
729 | return -ENOMEDIUM; | |
730 | } | |
731 | ||
396759ad | 732 | /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */ |
b192af8a | 733 | if (bdrv_is_sg(bs)) |
396759ad NB |
734 | return 0; |
735 | ||
51762288 SH |
736 | /* query actual device if possible, otherwise just trust the hint */ |
737 | if (drv->bdrv_getlength) { | |
738 | int64_t length = drv->bdrv_getlength(bs); | |
739 | if (length < 0) { | |
740 | return length; | |
741 | } | |
7e382003 | 742 | hint = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE); |
51762288 SH |
743 | } |
744 | ||
745 | bs->total_sectors = hint; | |
746 | return 0; | |
747 | } | |
748 | ||
cddff5ba KW |
749 | /** |
750 | * Combines a QDict of new block driver @options with any missing options taken | |
751 | * from @old_options, so that leaving out an option defaults to its old value. | |
752 | */ | |
753 | static void bdrv_join_options(BlockDriverState *bs, QDict *options, | |
754 | QDict *old_options) | |
755 | { | |
756 | if (bs->drv && bs->drv->bdrv_join_options) { | |
757 | bs->drv->bdrv_join_options(options, old_options); | |
758 | } else { | |
759 | qdict_join(options, old_options, false); | |
760 | } | |
761 | } | |
762 | ||
9e8f1835 PB |
763 | /** |
764 | * Set open flags for a given discard mode | |
765 | * | |
766 | * Return 0 on success, -1 if the discard mode was invalid. | |
767 | */ | |
768 | int bdrv_parse_discard_flags(const char *mode, int *flags) | |
769 | { | |
770 | *flags &= ~BDRV_O_UNMAP; | |
771 | ||
772 | if (!strcmp(mode, "off") || !strcmp(mode, "ignore")) { | |
773 | /* do nothing */ | |
774 | } else if (!strcmp(mode, "on") || !strcmp(mode, "unmap")) { | |
775 | *flags |= BDRV_O_UNMAP; | |
776 | } else { | |
777 | return -1; | |
778 | } | |
779 | ||
780 | return 0; | |
781 | } | |
782 | ||
c3993cdc SH |
783 | /** |
784 | * Set open flags for a given cache mode | |
785 | * | |
786 | * Return 0 on success, -1 if the cache mode was invalid. | |
787 | */ | |
53e8ae01 | 788 | int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough) |
c3993cdc SH |
789 | { |
790 | *flags &= ~BDRV_O_CACHE_MASK; | |
791 | ||
792 | if (!strcmp(mode, "off") || !strcmp(mode, "none")) { | |
53e8ae01 KW |
793 | *writethrough = false; |
794 | *flags |= BDRV_O_NOCACHE; | |
92196b2f | 795 | } else if (!strcmp(mode, "directsync")) { |
53e8ae01 | 796 | *writethrough = true; |
92196b2f | 797 | *flags |= BDRV_O_NOCACHE; |
c3993cdc | 798 | } else if (!strcmp(mode, "writeback")) { |
53e8ae01 | 799 | *writethrough = false; |
c3993cdc | 800 | } else if (!strcmp(mode, "unsafe")) { |
53e8ae01 | 801 | *writethrough = false; |
c3993cdc SH |
802 | *flags |= BDRV_O_NO_FLUSH; |
803 | } else if (!strcmp(mode, "writethrough")) { | |
53e8ae01 | 804 | *writethrough = true; |
c3993cdc SH |
805 | } else { |
806 | return -1; | |
807 | } | |
808 | ||
809 | return 0; | |
810 | } | |
811 | ||
b5411555 KW |
812 | static char *bdrv_child_get_parent_desc(BdrvChild *c) |
813 | { | |
814 | BlockDriverState *parent = c->opaque; | |
815 | return g_strdup(bdrv_get_device_or_node_name(parent)); | |
816 | } | |
817 | ||
20018e12 KW |
818 | static void bdrv_child_cb_drained_begin(BdrvChild *child) |
819 | { | |
820 | BlockDriverState *bs = child->opaque; | |
6cd5c9d7 | 821 | bdrv_do_drained_begin_quiesce(bs, NULL, false); |
20018e12 KW |
822 | } |
823 | ||
89bd0305 KW |
824 | static bool bdrv_child_cb_drained_poll(BdrvChild *child) |
825 | { | |
826 | BlockDriverState *bs = child->opaque; | |
6cd5c9d7 | 827 | return bdrv_drain_poll(bs, false, NULL, false); |
89bd0305 KW |
828 | } |
829 | ||
20018e12 KW |
830 | static void bdrv_child_cb_drained_end(BdrvChild *child) |
831 | { | |
832 | BlockDriverState *bs = child->opaque; | |
833 | bdrv_drained_end(bs); | |
834 | } | |
835 | ||
d736f119 KW |
836 | static void bdrv_child_cb_attach(BdrvChild *child) |
837 | { | |
838 | BlockDriverState *bs = child->opaque; | |
839 | bdrv_apply_subtree_drain(child, bs); | |
840 | } | |
841 | ||
842 | static void bdrv_child_cb_detach(BdrvChild *child) | |
843 | { | |
844 | BlockDriverState *bs = child->opaque; | |
845 | bdrv_unapply_subtree_drain(child, bs); | |
846 | } | |
847 | ||
38701b6a KW |
848 | static int bdrv_child_cb_inactivate(BdrvChild *child) |
849 | { | |
850 | BlockDriverState *bs = child->opaque; | |
851 | assert(bs->open_flags & BDRV_O_INACTIVE); | |
852 | return 0; | |
853 | } | |
854 | ||
b1e6fc08 | 855 | /* |
73176bee KW |
856 | * Returns the options and flags that a temporary snapshot should get, based on |
857 | * the originally requested flags (the originally requested image will have | |
858 | * flags like a backing file) | |
b1e6fc08 | 859 | */ |
73176bee KW |
860 | static void bdrv_temp_snapshot_options(int *child_flags, QDict *child_options, |
861 | int parent_flags, QDict *parent_options) | |
b1e6fc08 | 862 | { |
73176bee KW |
863 | *child_flags = (parent_flags & ~BDRV_O_SNAPSHOT) | BDRV_O_TEMPORARY; |
864 | ||
865 | /* For temporary files, unconditional cache=unsafe is fine */ | |
73176bee KW |
866 | qdict_set_default_str(child_options, BDRV_OPT_CACHE_DIRECT, "off"); |
867 | qdict_set_default_str(child_options, BDRV_OPT_CACHE_NO_FLUSH, "on"); | |
41869044 | 868 | |
f87a0e29 AG |
869 | /* Copy the read-only option from the parent */ |
870 | qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY); | |
871 | ||
41869044 KW |
872 | /* aio=native doesn't work for cache.direct=off, so disable it for the |
873 | * temporary snapshot */ | |
874 | *child_flags &= ~BDRV_O_NATIVE_AIO; | |
b1e6fc08 KW |
875 | } |
876 | ||
0b50cc88 | 877 | /* |
8e2160e2 KW |
878 | * Returns the options and flags that bs->file should get if a protocol driver |
879 | * is expected, based on the given options and flags for the parent BDS | |
0b50cc88 | 880 | */ |
8e2160e2 KW |
881 | static void bdrv_inherited_options(int *child_flags, QDict *child_options, |
882 | int parent_flags, QDict *parent_options) | |
0b50cc88 | 883 | { |
8e2160e2 KW |
884 | int flags = parent_flags; |
885 | ||
0b50cc88 KW |
886 | /* Enable protocol handling, disable format probing for bs->file */ |
887 | flags |= BDRV_O_PROTOCOL; | |
888 | ||
91a097e7 KW |
889 | /* If the cache mode isn't explicitly set, inherit direct and no-flush from |
890 | * the parent. */ | |
891 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT); | |
892 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH); | |
5a9347c6 | 893 | qdict_copy_default(child_options, parent_options, BDRV_OPT_FORCE_SHARE); |
91a097e7 | 894 | |
f87a0e29 AG |
895 | /* Inherit the read-only option from the parent if it's not set */ |
896 | qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY); | |
897 | ||
0b50cc88 | 898 | /* Our block drivers take care to send flushes and respect unmap policy, |
91a097e7 KW |
899 | * so we can default to enable both on lower layers regardless of the |
900 | * corresponding parent options. */ | |
818584a4 | 901 | qdict_set_default_str(child_options, BDRV_OPT_DISCARD, "unmap"); |
0b50cc88 | 902 | |
0b50cc88 | 903 | /* Clear flags that only apply to the top layer */ |
abb06c5a DB |
904 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ | |
905 | BDRV_O_NO_IO); | |
0b50cc88 | 906 | |
8e2160e2 | 907 | *child_flags = flags; |
0b50cc88 KW |
908 | } |
909 | ||
f3930ed0 | 910 | const BdrvChildRole child_file = { |
6cd5c9d7 | 911 | .parent_is_bds = true, |
b5411555 | 912 | .get_parent_desc = bdrv_child_get_parent_desc, |
8e2160e2 | 913 | .inherit_options = bdrv_inherited_options, |
20018e12 | 914 | .drained_begin = bdrv_child_cb_drained_begin, |
89bd0305 | 915 | .drained_poll = bdrv_child_cb_drained_poll, |
20018e12 | 916 | .drained_end = bdrv_child_cb_drained_end, |
d736f119 KW |
917 | .attach = bdrv_child_cb_attach, |
918 | .detach = bdrv_child_cb_detach, | |
38701b6a | 919 | .inactivate = bdrv_child_cb_inactivate, |
f3930ed0 KW |
920 | }; |
921 | ||
922 | /* | |
8e2160e2 KW |
923 | * Returns the options and flags that bs->file should get if the use of formats |
924 | * (and not only protocols) is permitted for it, based on the given options and | |
925 | * flags for the parent BDS | |
f3930ed0 | 926 | */ |
8e2160e2 KW |
927 | static void bdrv_inherited_fmt_options(int *child_flags, QDict *child_options, |
928 | int parent_flags, QDict *parent_options) | |
f3930ed0 | 929 | { |
8e2160e2 KW |
930 | child_file.inherit_options(child_flags, child_options, |
931 | parent_flags, parent_options); | |
932 | ||
abb06c5a | 933 | *child_flags &= ~(BDRV_O_PROTOCOL | BDRV_O_NO_IO); |
f3930ed0 KW |
934 | } |
935 | ||
936 | const BdrvChildRole child_format = { | |
6cd5c9d7 | 937 | .parent_is_bds = true, |
b5411555 | 938 | .get_parent_desc = bdrv_child_get_parent_desc, |
8e2160e2 | 939 | .inherit_options = bdrv_inherited_fmt_options, |
20018e12 | 940 | .drained_begin = bdrv_child_cb_drained_begin, |
89bd0305 | 941 | .drained_poll = bdrv_child_cb_drained_poll, |
20018e12 | 942 | .drained_end = bdrv_child_cb_drained_end, |
d736f119 KW |
943 | .attach = bdrv_child_cb_attach, |
944 | .detach = bdrv_child_cb_detach, | |
38701b6a | 945 | .inactivate = bdrv_child_cb_inactivate, |
f3930ed0 KW |
946 | }; |
947 | ||
db95dbba KW |
948 | static void bdrv_backing_attach(BdrvChild *c) |
949 | { | |
950 | BlockDriverState *parent = c->opaque; | |
951 | BlockDriverState *backing_hd = c->bs; | |
952 | ||
953 | assert(!parent->backing_blocker); | |
954 | error_setg(&parent->backing_blocker, | |
955 | "node is used as backing hd of '%s'", | |
956 | bdrv_get_device_or_node_name(parent)); | |
957 | ||
958 | parent->open_flags &= ~BDRV_O_NO_BACKING; | |
959 | pstrcpy(parent->backing_file, sizeof(parent->backing_file), | |
960 | backing_hd->filename); | |
961 | pstrcpy(parent->backing_format, sizeof(parent->backing_format), | |
962 | backing_hd->drv ? backing_hd->drv->format_name : ""); | |
963 | ||
964 | bdrv_op_block_all(backing_hd, parent->backing_blocker); | |
965 | /* Otherwise we won't be able to commit or stream */ | |
966 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_COMMIT_TARGET, | |
967 | parent->backing_blocker); | |
968 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_STREAM, | |
969 | parent->backing_blocker); | |
970 | /* | |
971 | * We do backup in 3 ways: | |
972 | * 1. drive backup | |
973 | * The target bs is new opened, and the source is top BDS | |
974 | * 2. blockdev backup | |
975 | * Both the source and the target are top BDSes. | |
976 | * 3. internal backup(used for block replication) | |
977 | * Both the source and the target are backing file | |
978 | * | |
979 | * In case 1 and 2, neither the source nor the target is the backing file. | |
980 | * In case 3, we will block the top BDS, so there is only one block job | |
981 | * for the top BDS and its backing chain. | |
982 | */ | |
983 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_SOURCE, | |
984 | parent->backing_blocker); | |
985 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_TARGET, | |
986 | parent->backing_blocker); | |
d736f119 KW |
987 | |
988 | bdrv_child_cb_attach(c); | |
db95dbba KW |
989 | } |
990 | ||
991 | static void bdrv_backing_detach(BdrvChild *c) | |
992 | { | |
993 | BlockDriverState *parent = c->opaque; | |
994 | ||
995 | assert(parent->backing_blocker); | |
996 | bdrv_op_unblock_all(c->bs, parent->backing_blocker); | |
997 | error_free(parent->backing_blocker); | |
998 | parent->backing_blocker = NULL; | |
d736f119 KW |
999 | |
1000 | bdrv_child_cb_detach(c); | |
db95dbba KW |
1001 | } |
1002 | ||
317fc44e | 1003 | /* |
8e2160e2 KW |
1004 | * Returns the options and flags that bs->backing should get, based on the |
1005 | * given options and flags for the parent BDS | |
317fc44e | 1006 | */ |
8e2160e2 KW |
1007 | static void bdrv_backing_options(int *child_flags, QDict *child_options, |
1008 | int parent_flags, QDict *parent_options) | |
317fc44e | 1009 | { |
8e2160e2 KW |
1010 | int flags = parent_flags; |
1011 | ||
b8816a43 KW |
1012 | /* The cache mode is inherited unmodified for backing files; except WCE, |
1013 | * which is only applied on the top level (BlockBackend) */ | |
91a097e7 KW |
1014 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT); |
1015 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH); | |
5a9347c6 | 1016 | qdict_copy_default(child_options, parent_options, BDRV_OPT_FORCE_SHARE); |
91a097e7 | 1017 | |
317fc44e | 1018 | /* backing files always opened read-only */ |
f87a0e29 AG |
1019 | qdict_set_default_str(child_options, BDRV_OPT_READ_ONLY, "on"); |
1020 | flags &= ~BDRV_O_COPY_ON_READ; | |
317fc44e KW |
1021 | |
1022 | /* snapshot=on is handled on the top layer */ | |
8bfea15d | 1023 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_TEMPORARY); |
317fc44e | 1024 | |
8e2160e2 | 1025 | *child_flags = flags; |
317fc44e KW |
1026 | } |
1027 | ||
6858eba0 KW |
1028 | static int bdrv_backing_update_filename(BdrvChild *c, BlockDriverState *base, |
1029 | const char *filename, Error **errp) | |
1030 | { | |
1031 | BlockDriverState *parent = c->opaque; | |
61f09cea | 1032 | int orig_flags = bdrv_get_flags(parent); |
6858eba0 KW |
1033 | int ret; |
1034 | ||
61f09cea KW |
1035 | if (!(orig_flags & BDRV_O_RDWR)) { |
1036 | ret = bdrv_reopen(parent, orig_flags | BDRV_O_RDWR, errp); | |
1037 | if (ret < 0) { | |
1038 | return ret; | |
1039 | } | |
1040 | } | |
1041 | ||
6858eba0 KW |
1042 | ret = bdrv_change_backing_file(parent, filename, |
1043 | base->drv ? base->drv->format_name : ""); | |
1044 | if (ret < 0) { | |
64730694 | 1045 | error_setg_errno(errp, -ret, "Could not update backing file link"); |
6858eba0 KW |
1046 | } |
1047 | ||
61f09cea KW |
1048 | if (!(orig_flags & BDRV_O_RDWR)) { |
1049 | bdrv_reopen(parent, orig_flags, NULL); | |
1050 | } | |
1051 | ||
6858eba0 KW |
1052 | return ret; |
1053 | } | |
1054 | ||
91ef3825 | 1055 | const BdrvChildRole child_backing = { |
6cd5c9d7 | 1056 | .parent_is_bds = true, |
b5411555 | 1057 | .get_parent_desc = bdrv_child_get_parent_desc, |
db95dbba KW |
1058 | .attach = bdrv_backing_attach, |
1059 | .detach = bdrv_backing_detach, | |
8e2160e2 | 1060 | .inherit_options = bdrv_backing_options, |
20018e12 | 1061 | .drained_begin = bdrv_child_cb_drained_begin, |
89bd0305 | 1062 | .drained_poll = bdrv_child_cb_drained_poll, |
20018e12 | 1063 | .drained_end = bdrv_child_cb_drained_end, |
38701b6a | 1064 | .inactivate = bdrv_child_cb_inactivate, |
6858eba0 | 1065 | .update_filename = bdrv_backing_update_filename, |
f3930ed0 KW |
1066 | }; |
1067 | ||
7b272452 KW |
1068 | static int bdrv_open_flags(BlockDriverState *bs, int flags) |
1069 | { | |
61de4c68 | 1070 | int open_flags = flags; |
7b272452 KW |
1071 | |
1072 | /* | |
1073 | * Clear flags that are internal to the block layer before opening the | |
1074 | * image. | |
1075 | */ | |
20cca275 | 1076 | open_flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_PROTOCOL); |
7b272452 KW |
1077 | |
1078 | /* | |
1079 | * Snapshots should be writable. | |
1080 | */ | |
8bfea15d | 1081 | if (flags & BDRV_O_TEMPORARY) { |
7b272452 KW |
1082 | open_flags |= BDRV_O_RDWR; |
1083 | } | |
1084 | ||
1085 | return open_flags; | |
1086 | } | |
1087 | ||
91a097e7 KW |
1088 | static void update_flags_from_options(int *flags, QemuOpts *opts) |
1089 | { | |
1090 | *flags &= ~BDRV_O_CACHE_MASK; | |
1091 | ||
91a097e7 KW |
1092 | assert(qemu_opt_find(opts, BDRV_OPT_CACHE_NO_FLUSH)); |
1093 | if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_NO_FLUSH, false)) { | |
1094 | *flags |= BDRV_O_NO_FLUSH; | |
1095 | } | |
1096 | ||
1097 | assert(qemu_opt_find(opts, BDRV_OPT_CACHE_DIRECT)); | |
1098 | if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_DIRECT, false)) { | |
1099 | *flags |= BDRV_O_NOCACHE; | |
1100 | } | |
f87a0e29 AG |
1101 | |
1102 | *flags &= ~BDRV_O_RDWR; | |
1103 | ||
1104 | assert(qemu_opt_find(opts, BDRV_OPT_READ_ONLY)); | |
1105 | if (!qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false)) { | |
1106 | *flags |= BDRV_O_RDWR; | |
1107 | } | |
1108 | ||
91a097e7 KW |
1109 | } |
1110 | ||
1111 | static void update_options_from_flags(QDict *options, int flags) | |
1112 | { | |
91a097e7 | 1113 | if (!qdict_haskey(options, BDRV_OPT_CACHE_DIRECT)) { |
46f5ac20 | 1114 | qdict_put_bool(options, BDRV_OPT_CACHE_DIRECT, flags & BDRV_O_NOCACHE); |
91a097e7 KW |
1115 | } |
1116 | if (!qdict_haskey(options, BDRV_OPT_CACHE_NO_FLUSH)) { | |
46f5ac20 EB |
1117 | qdict_put_bool(options, BDRV_OPT_CACHE_NO_FLUSH, |
1118 | flags & BDRV_O_NO_FLUSH); | |
91a097e7 | 1119 | } |
f87a0e29 | 1120 | if (!qdict_haskey(options, BDRV_OPT_READ_ONLY)) { |
46f5ac20 | 1121 | qdict_put_bool(options, BDRV_OPT_READ_ONLY, !(flags & BDRV_O_RDWR)); |
f87a0e29 | 1122 | } |
91a097e7 KW |
1123 | } |
1124 | ||
636ea370 KW |
1125 | static void bdrv_assign_node_name(BlockDriverState *bs, |
1126 | const char *node_name, | |
1127 | Error **errp) | |
6913c0c2 | 1128 | { |
15489c76 | 1129 | char *gen_node_name = NULL; |
6913c0c2 | 1130 | |
15489c76 JC |
1131 | if (!node_name) { |
1132 | node_name = gen_node_name = id_generate(ID_BLOCK); | |
1133 | } else if (!id_wellformed(node_name)) { | |
1134 | /* | |
1135 | * Check for empty string or invalid characters, but not if it is | |
1136 | * generated (generated names use characters not available to the user) | |
1137 | */ | |
9aebf3b8 | 1138 | error_setg(errp, "Invalid node name"); |
636ea370 | 1139 | return; |
6913c0c2 BC |
1140 | } |
1141 | ||
0c5e94ee | 1142 | /* takes care of avoiding namespaces collisions */ |
7f06d47e | 1143 | if (blk_by_name(node_name)) { |
0c5e94ee BC |
1144 | error_setg(errp, "node-name=%s is conflicting with a device id", |
1145 | node_name); | |
15489c76 | 1146 | goto out; |
0c5e94ee BC |
1147 | } |
1148 | ||
6913c0c2 BC |
1149 | /* takes care of avoiding duplicates node names */ |
1150 | if (bdrv_find_node(node_name)) { | |
1151 | error_setg(errp, "Duplicate node name"); | |
15489c76 | 1152 | goto out; |
6913c0c2 BC |
1153 | } |
1154 | ||
1155 | /* copy node name into the bs and insert it into the graph list */ | |
1156 | pstrcpy(bs->node_name, sizeof(bs->node_name), node_name); | |
1157 | QTAILQ_INSERT_TAIL(&graph_bdrv_states, bs, node_list); | |
15489c76 JC |
1158 | out: |
1159 | g_free(gen_node_name); | |
6913c0c2 BC |
1160 | } |
1161 | ||
01a56501 KW |
1162 | static int bdrv_open_driver(BlockDriverState *bs, BlockDriver *drv, |
1163 | const char *node_name, QDict *options, | |
1164 | int open_flags, Error **errp) | |
1165 | { | |
1166 | Error *local_err = NULL; | |
1167 | int ret; | |
1168 | ||
1169 | bdrv_assign_node_name(bs, node_name, &local_err); | |
1170 | if (local_err) { | |
1171 | error_propagate(errp, local_err); | |
1172 | return -EINVAL; | |
1173 | } | |
1174 | ||
1175 | bs->drv = drv; | |
680c7f96 | 1176 | bs->read_only = !(bs->open_flags & BDRV_O_RDWR); |
01a56501 KW |
1177 | bs->opaque = g_malloc0(drv->instance_size); |
1178 | ||
1179 | if (drv->bdrv_file_open) { | |
1180 | assert(!drv->bdrv_needs_filename || bs->filename[0]); | |
1181 | ret = drv->bdrv_file_open(bs, options, open_flags, &local_err); | |
680c7f96 | 1182 | } else if (drv->bdrv_open) { |
01a56501 | 1183 | ret = drv->bdrv_open(bs, options, open_flags, &local_err); |
680c7f96 KW |
1184 | } else { |
1185 | ret = 0; | |
01a56501 KW |
1186 | } |
1187 | ||
1188 | if (ret < 0) { | |
1189 | if (local_err) { | |
1190 | error_propagate(errp, local_err); | |
1191 | } else if (bs->filename[0]) { | |
1192 | error_setg_errno(errp, -ret, "Could not open '%s'", bs->filename); | |
1193 | } else { | |
1194 | error_setg_errno(errp, -ret, "Could not open image"); | |
1195 | } | |
180ca19a | 1196 | goto open_failed; |
01a56501 KW |
1197 | } |
1198 | ||
1199 | ret = refresh_total_sectors(bs, bs->total_sectors); | |
1200 | if (ret < 0) { | |
1201 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); | |
180ca19a | 1202 | return ret; |
01a56501 KW |
1203 | } |
1204 | ||
1205 | bdrv_refresh_limits(bs, &local_err); | |
1206 | if (local_err) { | |
1207 | error_propagate(errp, local_err); | |
180ca19a | 1208 | return -EINVAL; |
01a56501 KW |
1209 | } |
1210 | ||
1211 | assert(bdrv_opt_mem_align(bs) != 0); | |
1212 | assert(bdrv_min_mem_align(bs) != 0); | |
1213 | assert(is_power_of_2(bs->bl.request_alignment)); | |
1214 | ||
1215 | return 0; | |
180ca19a MP |
1216 | open_failed: |
1217 | bs->drv = NULL; | |
1218 | if (bs->file != NULL) { | |
1219 | bdrv_unref_child(bs, bs->file); | |
1220 | bs->file = NULL; | |
1221 | } | |
01a56501 KW |
1222 | g_free(bs->opaque); |
1223 | bs->opaque = NULL; | |
01a56501 KW |
1224 | return ret; |
1225 | } | |
1226 | ||
680c7f96 KW |
1227 | BlockDriverState *bdrv_new_open_driver(BlockDriver *drv, const char *node_name, |
1228 | int flags, Error **errp) | |
1229 | { | |
1230 | BlockDriverState *bs; | |
1231 | int ret; | |
1232 | ||
1233 | bs = bdrv_new(); | |
1234 | bs->open_flags = flags; | |
1235 | bs->explicit_options = qdict_new(); | |
1236 | bs->options = qdict_new(); | |
1237 | bs->opaque = NULL; | |
1238 | ||
1239 | update_options_from_flags(bs->options, flags); | |
1240 | ||
1241 | ret = bdrv_open_driver(bs, drv, node_name, bs->options, flags, errp); | |
1242 | if (ret < 0) { | |
cb3e7f08 | 1243 | qobject_unref(bs->explicit_options); |
180ca19a | 1244 | bs->explicit_options = NULL; |
cb3e7f08 | 1245 | qobject_unref(bs->options); |
180ca19a | 1246 | bs->options = NULL; |
680c7f96 KW |
1247 | bdrv_unref(bs); |
1248 | return NULL; | |
1249 | } | |
1250 | ||
1251 | return bs; | |
1252 | } | |
1253 | ||
c5f3014b | 1254 | QemuOptsList bdrv_runtime_opts = { |
18edf289 KW |
1255 | .name = "bdrv_common", |
1256 | .head = QTAILQ_HEAD_INITIALIZER(bdrv_runtime_opts.head), | |
1257 | .desc = { | |
1258 | { | |
1259 | .name = "node-name", | |
1260 | .type = QEMU_OPT_STRING, | |
1261 | .help = "Node name of the block device node", | |
1262 | }, | |
62392ebb KW |
1263 | { |
1264 | .name = "driver", | |
1265 | .type = QEMU_OPT_STRING, | |
1266 | .help = "Block driver to use for the node", | |
1267 | }, | |
91a097e7 KW |
1268 | { |
1269 | .name = BDRV_OPT_CACHE_DIRECT, | |
1270 | .type = QEMU_OPT_BOOL, | |
1271 | .help = "Bypass software writeback cache on the host", | |
1272 | }, | |
1273 | { | |
1274 | .name = BDRV_OPT_CACHE_NO_FLUSH, | |
1275 | .type = QEMU_OPT_BOOL, | |
1276 | .help = "Ignore flush requests", | |
1277 | }, | |
f87a0e29 AG |
1278 | { |
1279 | .name = BDRV_OPT_READ_ONLY, | |
1280 | .type = QEMU_OPT_BOOL, | |
1281 | .help = "Node is opened in read-only mode", | |
1282 | }, | |
692e01a2 KW |
1283 | { |
1284 | .name = "detect-zeroes", | |
1285 | .type = QEMU_OPT_STRING, | |
1286 | .help = "try to optimize zero writes (off, on, unmap)", | |
1287 | }, | |
818584a4 KW |
1288 | { |
1289 | .name = "discard", | |
1290 | .type = QEMU_OPT_STRING, | |
1291 | .help = "discard operation (ignore/off, unmap/on)", | |
1292 | }, | |
5a9347c6 FZ |
1293 | { |
1294 | .name = BDRV_OPT_FORCE_SHARE, | |
1295 | .type = QEMU_OPT_BOOL, | |
1296 | .help = "always accept other writers (default: off)", | |
1297 | }, | |
18edf289 KW |
1298 | { /* end of list */ } |
1299 | }, | |
1300 | }; | |
1301 | ||
57915332 KW |
1302 | /* |
1303 | * Common part for opening disk images and files | |
b6ad491a KW |
1304 | * |
1305 | * Removes all processed options from *options. | |
57915332 | 1306 | */ |
5696c6e3 | 1307 | static int bdrv_open_common(BlockDriverState *bs, BlockBackend *file, |
82dc8b41 | 1308 | QDict *options, Error **errp) |
57915332 KW |
1309 | { |
1310 | int ret, open_flags; | |
035fccdf | 1311 | const char *filename; |
62392ebb | 1312 | const char *driver_name = NULL; |
6913c0c2 | 1313 | const char *node_name = NULL; |
818584a4 | 1314 | const char *discard; |
692e01a2 | 1315 | const char *detect_zeroes; |
18edf289 | 1316 | QemuOpts *opts; |
62392ebb | 1317 | BlockDriver *drv; |
34b5d2c6 | 1318 | Error *local_err = NULL; |
57915332 | 1319 | |
6405875c | 1320 | assert(bs->file == NULL); |
707ff828 | 1321 | assert(options != NULL && bs->options != options); |
57915332 | 1322 | |
62392ebb KW |
1323 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); |
1324 | qemu_opts_absorb_qdict(opts, options, &local_err); | |
1325 | if (local_err) { | |
1326 | error_propagate(errp, local_err); | |
1327 | ret = -EINVAL; | |
1328 | goto fail_opts; | |
1329 | } | |
1330 | ||
9b7e8691 AG |
1331 | update_flags_from_options(&bs->open_flags, opts); |
1332 | ||
62392ebb KW |
1333 | driver_name = qemu_opt_get(opts, "driver"); |
1334 | drv = bdrv_find_format(driver_name); | |
1335 | assert(drv != NULL); | |
1336 | ||
5a9347c6 FZ |
1337 | bs->force_share = qemu_opt_get_bool(opts, BDRV_OPT_FORCE_SHARE, false); |
1338 | ||
1339 | if (bs->force_share && (bs->open_flags & BDRV_O_RDWR)) { | |
1340 | error_setg(errp, | |
1341 | BDRV_OPT_FORCE_SHARE | |
1342 | "=on can only be used with read-only images"); | |
1343 | ret = -EINVAL; | |
1344 | goto fail_opts; | |
1345 | } | |
1346 | ||
45673671 | 1347 | if (file != NULL) { |
5696c6e3 | 1348 | filename = blk_bs(file)->filename; |
45673671 | 1349 | } else { |
129c7d1c MA |
1350 | /* |
1351 | * Caution: while qdict_get_try_str() is fine, getting | |
1352 | * non-string types would require more care. When @options | |
1353 | * come from -blockdev or blockdev_add, its members are typed | |
1354 | * according to the QAPI schema, but when they come from | |
1355 | * -drive, they're all QString. | |
1356 | */ | |
45673671 KW |
1357 | filename = qdict_get_try_str(options, "filename"); |
1358 | } | |
1359 | ||
4a008240 | 1360 | if (drv->bdrv_needs_filename && (!filename || !filename[0])) { |
765003db KW |
1361 | error_setg(errp, "The '%s' block driver requires a file name", |
1362 | drv->format_name); | |
18edf289 KW |
1363 | ret = -EINVAL; |
1364 | goto fail_opts; | |
6913c0c2 | 1365 | } |
6913c0c2 | 1366 | |
82dc8b41 KW |
1367 | trace_bdrv_open_common(bs, filename ?: "", bs->open_flags, |
1368 | drv->format_name); | |
62392ebb | 1369 | |
82dc8b41 | 1370 | bs->read_only = !(bs->open_flags & BDRV_O_RDWR); |
b64ec4e4 FZ |
1371 | |
1372 | if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv, bs->read_only)) { | |
8f94a6e4 KW |
1373 | error_setg(errp, |
1374 | !bs->read_only && bdrv_is_whitelisted(drv, true) | |
1375 | ? "Driver '%s' can only be used for read-only devices" | |
1376 | : "Driver '%s' is not whitelisted", | |
1377 | drv->format_name); | |
18edf289 KW |
1378 | ret = -ENOTSUP; |
1379 | goto fail_opts; | |
b64ec4e4 | 1380 | } |
57915332 | 1381 | |
d3faa13e PB |
1382 | /* bdrv_new() and bdrv_close() make it so */ |
1383 | assert(atomic_read(&bs->copy_on_read) == 0); | |
1384 | ||
82dc8b41 | 1385 | if (bs->open_flags & BDRV_O_COPY_ON_READ) { |
0ebd24e0 KW |
1386 | if (!bs->read_only) { |
1387 | bdrv_enable_copy_on_read(bs); | |
1388 | } else { | |
1389 | error_setg(errp, "Can't use copy-on-read on read-only device"); | |
18edf289 KW |
1390 | ret = -EINVAL; |
1391 | goto fail_opts; | |
0ebd24e0 | 1392 | } |
53fec9d3 SH |
1393 | } |
1394 | ||
818584a4 KW |
1395 | discard = qemu_opt_get(opts, "discard"); |
1396 | if (discard != NULL) { | |
1397 | if (bdrv_parse_discard_flags(discard, &bs->open_flags) != 0) { | |
1398 | error_setg(errp, "Invalid discard option"); | |
1399 | ret = -EINVAL; | |
1400 | goto fail_opts; | |
1401 | } | |
1402 | } | |
1403 | ||
692e01a2 KW |
1404 | detect_zeroes = qemu_opt_get(opts, "detect-zeroes"); |
1405 | if (detect_zeroes) { | |
1406 | BlockdevDetectZeroesOptions value = | |
f7abe0ec | 1407 | qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup, |
692e01a2 | 1408 | detect_zeroes, |
692e01a2 KW |
1409 | BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF, |
1410 | &local_err); | |
1411 | if (local_err) { | |
1412 | error_propagate(errp, local_err); | |
1413 | ret = -EINVAL; | |
1414 | goto fail_opts; | |
1415 | } | |
1416 | ||
1417 | if (value == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP && | |
1418 | !(bs->open_flags & BDRV_O_UNMAP)) | |
1419 | { | |
1420 | error_setg(errp, "setting detect-zeroes to unmap is not allowed " | |
1421 | "without setting discard operation to unmap"); | |
1422 | ret = -EINVAL; | |
1423 | goto fail_opts; | |
1424 | } | |
1425 | ||
1426 | bs->detect_zeroes = value; | |
1427 | } | |
1428 | ||
c2ad1b0c KW |
1429 | if (filename != NULL) { |
1430 | pstrcpy(bs->filename, sizeof(bs->filename), filename); | |
1431 | } else { | |
1432 | bs->filename[0] = '\0'; | |
1433 | } | |
91af7014 | 1434 | pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), bs->filename); |
57915332 | 1435 | |
66f82cee | 1436 | /* Open the image, either directly or using a protocol */ |
82dc8b41 | 1437 | open_flags = bdrv_open_flags(bs, bs->open_flags); |
01a56501 | 1438 | node_name = qemu_opt_get(opts, "node-name"); |
57915332 | 1439 | |
01a56501 KW |
1440 | assert(!drv->bdrv_file_open || file == NULL); |
1441 | ret = bdrv_open_driver(bs, drv, node_name, options, open_flags, errp); | |
51762288 | 1442 | if (ret < 0) { |
01a56501 | 1443 | goto fail_opts; |
3baca891 KW |
1444 | } |
1445 | ||
18edf289 | 1446 | qemu_opts_del(opts); |
57915332 KW |
1447 | return 0; |
1448 | ||
18edf289 KW |
1449 | fail_opts: |
1450 | qemu_opts_del(opts); | |
57915332 KW |
1451 | return ret; |
1452 | } | |
1453 | ||
5e5c4f63 KW |
1454 | static QDict *parse_json_filename(const char *filename, Error **errp) |
1455 | { | |
1456 | QObject *options_obj; | |
1457 | QDict *options; | |
1458 | int ret; | |
1459 | ||
1460 | ret = strstart(filename, "json:", &filename); | |
1461 | assert(ret); | |
1462 | ||
5577fff7 | 1463 | options_obj = qobject_from_json(filename, errp); |
5e5c4f63 | 1464 | if (!options_obj) { |
5577fff7 MA |
1465 | /* Work around qobject_from_json() lossage TODO fix that */ |
1466 | if (errp && !*errp) { | |
1467 | error_setg(errp, "Could not parse the JSON options"); | |
1468 | return NULL; | |
1469 | } | |
1470 | error_prepend(errp, "Could not parse the JSON options: "); | |
5e5c4f63 KW |
1471 | return NULL; |
1472 | } | |
1473 | ||
7dc847eb | 1474 | options = qobject_to(QDict, options_obj); |
ca6b6e1e | 1475 | if (!options) { |
cb3e7f08 | 1476 | qobject_unref(options_obj); |
5e5c4f63 KW |
1477 | error_setg(errp, "Invalid JSON object given"); |
1478 | return NULL; | |
1479 | } | |
1480 | ||
5e5c4f63 KW |
1481 | qdict_flatten(options); |
1482 | ||
1483 | return options; | |
1484 | } | |
1485 | ||
de3b53f0 KW |
1486 | static void parse_json_protocol(QDict *options, const char **pfilename, |
1487 | Error **errp) | |
1488 | { | |
1489 | QDict *json_options; | |
1490 | Error *local_err = NULL; | |
1491 | ||
1492 | /* Parse json: pseudo-protocol */ | |
1493 | if (!*pfilename || !g_str_has_prefix(*pfilename, "json:")) { | |
1494 | return; | |
1495 | } | |
1496 | ||
1497 | json_options = parse_json_filename(*pfilename, &local_err); | |
1498 | if (local_err) { | |
1499 | error_propagate(errp, local_err); | |
1500 | return; | |
1501 | } | |
1502 | ||
1503 | /* Options given in the filename have lower priority than options | |
1504 | * specified directly */ | |
1505 | qdict_join(options, json_options, false); | |
cb3e7f08 | 1506 | qobject_unref(json_options); |
de3b53f0 KW |
1507 | *pfilename = NULL; |
1508 | } | |
1509 | ||
b6ce07aa | 1510 | /* |
f54120ff KW |
1511 | * Fills in default options for opening images and converts the legacy |
1512 | * filename/flags pair to option QDict entries. | |
53a29513 HR |
1513 | * The BDRV_O_PROTOCOL flag in *flags will be set or cleared accordingly if a |
1514 | * block driver has been specified explicitly. | |
b6ce07aa | 1515 | */ |
de3b53f0 | 1516 | static int bdrv_fill_options(QDict **options, const char *filename, |
053e1578 | 1517 | int *flags, Error **errp) |
ea2384d3 | 1518 | { |
c2ad1b0c | 1519 | const char *drvname; |
53a29513 | 1520 | bool protocol = *flags & BDRV_O_PROTOCOL; |
e3fa4bfa | 1521 | bool parse_filename = false; |
053e1578 | 1522 | BlockDriver *drv = NULL; |
34b5d2c6 | 1523 | Error *local_err = NULL; |
83f64091 | 1524 | |
129c7d1c MA |
1525 | /* |
1526 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
1527 | * types would require more care. When @options come from | |
1528 | * -blockdev or blockdev_add, its members are typed according to | |
1529 | * the QAPI schema, but when they come from -drive, they're all | |
1530 | * QString. | |
1531 | */ | |
53a29513 | 1532 | drvname = qdict_get_try_str(*options, "driver"); |
053e1578 HR |
1533 | if (drvname) { |
1534 | drv = bdrv_find_format(drvname); | |
1535 | if (!drv) { | |
1536 | error_setg(errp, "Unknown driver '%s'", drvname); | |
1537 | return -ENOENT; | |
1538 | } | |
1539 | /* If the user has explicitly specified the driver, this choice should | |
1540 | * override the BDRV_O_PROTOCOL flag */ | |
1541 | protocol = drv->bdrv_file_open; | |
53a29513 HR |
1542 | } |
1543 | ||
1544 | if (protocol) { | |
1545 | *flags |= BDRV_O_PROTOCOL; | |
1546 | } else { | |
1547 | *flags &= ~BDRV_O_PROTOCOL; | |
1548 | } | |
1549 | ||
91a097e7 KW |
1550 | /* Translate cache options from flags into options */ |
1551 | update_options_from_flags(*options, *flags); | |
1552 | ||
035fccdf | 1553 | /* Fetch the file name from the options QDict if necessary */ |
17b005f1 | 1554 | if (protocol && filename) { |
f54120ff | 1555 | if (!qdict_haskey(*options, "filename")) { |
46f5ac20 | 1556 | qdict_put_str(*options, "filename", filename); |
f54120ff KW |
1557 | parse_filename = true; |
1558 | } else { | |
1559 | error_setg(errp, "Can't specify 'file' and 'filename' options at " | |
1560 | "the same time"); | |
1561 | return -EINVAL; | |
1562 | } | |
035fccdf KW |
1563 | } |
1564 | ||
c2ad1b0c | 1565 | /* Find the right block driver */ |
129c7d1c | 1566 | /* See cautionary note on accessing @options above */ |
f54120ff | 1567 | filename = qdict_get_try_str(*options, "filename"); |
f54120ff | 1568 | |
053e1578 HR |
1569 | if (!drvname && protocol) { |
1570 | if (filename) { | |
1571 | drv = bdrv_find_protocol(filename, parse_filename, errp); | |
17b005f1 | 1572 | if (!drv) { |
053e1578 | 1573 | return -EINVAL; |
17b005f1 | 1574 | } |
053e1578 HR |
1575 | |
1576 | drvname = drv->format_name; | |
46f5ac20 | 1577 | qdict_put_str(*options, "driver", drvname); |
053e1578 HR |
1578 | } else { |
1579 | error_setg(errp, "Must specify either driver or file"); | |
1580 | return -EINVAL; | |
98289620 | 1581 | } |
c2ad1b0c KW |
1582 | } |
1583 | ||
17b005f1 | 1584 | assert(drv || !protocol); |
c2ad1b0c | 1585 | |
f54120ff | 1586 | /* Driver-specific filename parsing */ |
17b005f1 | 1587 | if (drv && drv->bdrv_parse_filename && parse_filename) { |
5acd9d81 | 1588 | drv->bdrv_parse_filename(filename, *options, &local_err); |
84d18f06 | 1589 | if (local_err) { |
34b5d2c6 | 1590 | error_propagate(errp, local_err); |
f54120ff | 1591 | return -EINVAL; |
6963a30d | 1592 | } |
cd5d031e HR |
1593 | |
1594 | if (!drv->bdrv_needs_filename) { | |
1595 | qdict_del(*options, "filename"); | |
cd5d031e | 1596 | } |
6963a30d KW |
1597 | } |
1598 | ||
f54120ff KW |
1599 | return 0; |
1600 | } | |
1601 | ||
3121fb45 KW |
1602 | static int bdrv_child_check_perm(BdrvChild *c, BlockReopenQueue *q, |
1603 | uint64_t perm, uint64_t shared, | |
c1cef672 FZ |
1604 | GSList *ignore_children, Error **errp); |
1605 | static void bdrv_child_abort_perm_update(BdrvChild *c); | |
1606 | static void bdrv_child_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared); | |
1607 | ||
148eb13c KW |
1608 | typedef struct BlockReopenQueueEntry { |
1609 | bool prepared; | |
1610 | BDRVReopenState state; | |
1611 | QSIMPLEQ_ENTRY(BlockReopenQueueEntry) entry; | |
1612 | } BlockReopenQueueEntry; | |
1613 | ||
1614 | /* | |
1615 | * Return the flags that @bs will have after the reopens in @q have | |
1616 | * successfully completed. If @q is NULL (or @bs is not contained in @q), | |
1617 | * return the current flags. | |
1618 | */ | |
1619 | static int bdrv_reopen_get_flags(BlockReopenQueue *q, BlockDriverState *bs) | |
1620 | { | |
1621 | BlockReopenQueueEntry *entry; | |
1622 | ||
1623 | if (q != NULL) { | |
1624 | QSIMPLEQ_FOREACH(entry, q, entry) { | |
1625 | if (entry->state.bs == bs) { | |
1626 | return entry->state.flags; | |
1627 | } | |
1628 | } | |
1629 | } | |
1630 | ||
1631 | return bs->open_flags; | |
1632 | } | |
1633 | ||
1634 | /* Returns whether the image file can be written to after the reopen queue @q | |
1635 | * has been successfully applied, or right now if @q is NULL. */ | |
cc022140 HR |
1636 | static bool bdrv_is_writable_after_reopen(BlockDriverState *bs, |
1637 | BlockReopenQueue *q) | |
148eb13c KW |
1638 | { |
1639 | int flags = bdrv_reopen_get_flags(q, bs); | |
1640 | ||
1641 | return (flags & (BDRV_O_RDWR | BDRV_O_INACTIVE)) == BDRV_O_RDWR; | |
1642 | } | |
1643 | ||
cc022140 HR |
1644 | /* |
1645 | * Return whether the BDS can be written to. This is not necessarily | |
1646 | * the same as !bdrv_is_read_only(bs), as inactivated images may not | |
1647 | * be written to but do not count as read-only images. | |
1648 | */ | |
1649 | bool bdrv_is_writable(BlockDriverState *bs) | |
1650 | { | |
1651 | return bdrv_is_writable_after_reopen(bs, NULL); | |
1652 | } | |
1653 | ||
ffd1a5a2 | 1654 | static void bdrv_child_perm(BlockDriverState *bs, BlockDriverState *child_bs, |
e0995dc3 KW |
1655 | BdrvChild *c, const BdrvChildRole *role, |
1656 | BlockReopenQueue *reopen_queue, | |
ffd1a5a2 FZ |
1657 | uint64_t parent_perm, uint64_t parent_shared, |
1658 | uint64_t *nperm, uint64_t *nshared) | |
1659 | { | |
1660 | if (bs->drv && bs->drv->bdrv_child_perm) { | |
e0995dc3 | 1661 | bs->drv->bdrv_child_perm(bs, c, role, reopen_queue, |
ffd1a5a2 FZ |
1662 | parent_perm, parent_shared, |
1663 | nperm, nshared); | |
1664 | } | |
e0995dc3 | 1665 | /* TODO Take force_share from reopen_queue */ |
ffd1a5a2 FZ |
1666 | if (child_bs && child_bs->force_share) { |
1667 | *nshared = BLK_PERM_ALL; | |
1668 | } | |
1669 | } | |
1670 | ||
33a610c3 KW |
1671 | /* |
1672 | * Check whether permissions on this node can be changed in a way that | |
1673 | * @cumulative_perms and @cumulative_shared_perms are the new cumulative | |
1674 | * permissions of all its parents. This involves checking whether all necessary | |
1675 | * permission changes to child nodes can be performed. | |
1676 | * | |
1677 | * A call to this function must always be followed by a call to bdrv_set_perm() | |
1678 | * or bdrv_abort_perm_update(). | |
1679 | */ | |
3121fb45 KW |
1680 | static int bdrv_check_perm(BlockDriverState *bs, BlockReopenQueue *q, |
1681 | uint64_t cumulative_perms, | |
46181129 KW |
1682 | uint64_t cumulative_shared_perms, |
1683 | GSList *ignore_children, Error **errp) | |
33a610c3 KW |
1684 | { |
1685 | BlockDriver *drv = bs->drv; | |
1686 | BdrvChild *c; | |
1687 | int ret; | |
1688 | ||
1689 | /* Write permissions never work with read-only images */ | |
1690 | if ((cumulative_perms & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED)) && | |
cc022140 | 1691 | !bdrv_is_writable_after_reopen(bs, q)) |
33a610c3 KW |
1692 | { |
1693 | error_setg(errp, "Block node is read-only"); | |
1694 | return -EPERM; | |
1695 | } | |
1696 | ||
1697 | /* Check this node */ | |
1698 | if (!drv) { | |
1699 | return 0; | |
1700 | } | |
1701 | ||
1702 | if (drv->bdrv_check_perm) { | |
1703 | return drv->bdrv_check_perm(bs, cumulative_perms, | |
1704 | cumulative_shared_perms, errp); | |
1705 | } | |
1706 | ||
78e421c9 | 1707 | /* Drivers that never have children can omit .bdrv_child_perm() */ |
33a610c3 | 1708 | if (!drv->bdrv_child_perm) { |
78e421c9 | 1709 | assert(QLIST_EMPTY(&bs->children)); |
33a610c3 KW |
1710 | return 0; |
1711 | } | |
1712 | ||
1713 | /* Check all children */ | |
1714 | QLIST_FOREACH(c, &bs->children, next) { | |
1715 | uint64_t cur_perm, cur_shared; | |
3121fb45 | 1716 | bdrv_child_perm(bs, c->bs, c, c->role, q, |
ffd1a5a2 FZ |
1717 | cumulative_perms, cumulative_shared_perms, |
1718 | &cur_perm, &cur_shared); | |
3121fb45 KW |
1719 | ret = bdrv_child_check_perm(c, q, cur_perm, cur_shared, |
1720 | ignore_children, errp); | |
33a610c3 KW |
1721 | if (ret < 0) { |
1722 | return ret; | |
1723 | } | |
1724 | } | |
1725 | ||
1726 | return 0; | |
1727 | } | |
1728 | ||
1729 | /* | |
1730 | * Notifies drivers that after a previous bdrv_check_perm() call, the | |
1731 | * permission update is not performed and any preparations made for it (e.g. | |
1732 | * taken file locks) need to be undone. | |
1733 | * | |
1734 | * This function recursively notifies all child nodes. | |
1735 | */ | |
1736 | static void bdrv_abort_perm_update(BlockDriverState *bs) | |
1737 | { | |
1738 | BlockDriver *drv = bs->drv; | |
1739 | BdrvChild *c; | |
1740 | ||
1741 | if (!drv) { | |
1742 | return; | |
1743 | } | |
1744 | ||
1745 | if (drv->bdrv_abort_perm_update) { | |
1746 | drv->bdrv_abort_perm_update(bs); | |
1747 | } | |
1748 | ||
1749 | QLIST_FOREACH(c, &bs->children, next) { | |
1750 | bdrv_child_abort_perm_update(c); | |
1751 | } | |
1752 | } | |
1753 | ||
1754 | static void bdrv_set_perm(BlockDriverState *bs, uint64_t cumulative_perms, | |
1755 | uint64_t cumulative_shared_perms) | |
1756 | { | |
1757 | BlockDriver *drv = bs->drv; | |
1758 | BdrvChild *c; | |
1759 | ||
1760 | if (!drv) { | |
1761 | return; | |
1762 | } | |
1763 | ||
1764 | /* Update this node */ | |
1765 | if (drv->bdrv_set_perm) { | |
1766 | drv->bdrv_set_perm(bs, cumulative_perms, cumulative_shared_perms); | |
1767 | } | |
1768 | ||
78e421c9 | 1769 | /* Drivers that never have children can omit .bdrv_child_perm() */ |
33a610c3 | 1770 | if (!drv->bdrv_child_perm) { |
78e421c9 | 1771 | assert(QLIST_EMPTY(&bs->children)); |
33a610c3 KW |
1772 | return; |
1773 | } | |
1774 | ||
1775 | /* Update all children */ | |
1776 | QLIST_FOREACH(c, &bs->children, next) { | |
1777 | uint64_t cur_perm, cur_shared; | |
e0995dc3 | 1778 | bdrv_child_perm(bs, c->bs, c, c->role, NULL, |
ffd1a5a2 FZ |
1779 | cumulative_perms, cumulative_shared_perms, |
1780 | &cur_perm, &cur_shared); | |
33a610c3 KW |
1781 | bdrv_child_set_perm(c, cur_perm, cur_shared); |
1782 | } | |
1783 | } | |
1784 | ||
1785 | static void bdrv_get_cumulative_perm(BlockDriverState *bs, uint64_t *perm, | |
1786 | uint64_t *shared_perm) | |
1787 | { | |
1788 | BdrvChild *c; | |
1789 | uint64_t cumulative_perms = 0; | |
1790 | uint64_t cumulative_shared_perms = BLK_PERM_ALL; | |
1791 | ||
1792 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
1793 | cumulative_perms |= c->perm; | |
1794 | cumulative_shared_perms &= c->shared_perm; | |
1795 | } | |
1796 | ||
1797 | *perm = cumulative_perms; | |
1798 | *shared_perm = cumulative_shared_perms; | |
1799 | } | |
1800 | ||
d083319f KW |
1801 | static char *bdrv_child_user_desc(BdrvChild *c) |
1802 | { | |
1803 | if (c->role->get_parent_desc) { | |
1804 | return c->role->get_parent_desc(c); | |
1805 | } | |
1806 | ||
1807 | return g_strdup("another user"); | |
1808 | } | |
1809 | ||
5176196c | 1810 | char *bdrv_perm_names(uint64_t perm) |
d083319f KW |
1811 | { |
1812 | struct perm_name { | |
1813 | uint64_t perm; | |
1814 | const char *name; | |
1815 | } permissions[] = { | |
1816 | { BLK_PERM_CONSISTENT_READ, "consistent read" }, | |
1817 | { BLK_PERM_WRITE, "write" }, | |
1818 | { BLK_PERM_WRITE_UNCHANGED, "write unchanged" }, | |
1819 | { BLK_PERM_RESIZE, "resize" }, | |
1820 | { BLK_PERM_GRAPH_MOD, "change children" }, | |
1821 | { 0, NULL } | |
1822 | }; | |
1823 | ||
1824 | char *result = g_strdup(""); | |
1825 | struct perm_name *p; | |
1826 | ||
1827 | for (p = permissions; p->name; p++) { | |
1828 | if (perm & p->perm) { | |
1829 | char *old = result; | |
1830 | result = g_strdup_printf("%s%s%s", old, *old ? ", " : "", p->name); | |
1831 | g_free(old); | |
1832 | } | |
1833 | } | |
1834 | ||
1835 | return result; | |
1836 | } | |
1837 | ||
33a610c3 KW |
1838 | /* |
1839 | * Checks whether a new reference to @bs can be added if the new user requires | |
46181129 KW |
1840 | * @new_used_perm/@new_shared_perm as its permissions. If @ignore_children is |
1841 | * set, the BdrvChild objects in this list are ignored in the calculations; | |
1842 | * this allows checking permission updates for an existing reference. | |
33a610c3 KW |
1843 | * |
1844 | * Needs to be followed by a call to either bdrv_set_perm() or | |
1845 | * bdrv_abort_perm_update(). */ | |
3121fb45 KW |
1846 | static int bdrv_check_update_perm(BlockDriverState *bs, BlockReopenQueue *q, |
1847 | uint64_t new_used_perm, | |
d5e6f437 | 1848 | uint64_t new_shared_perm, |
46181129 | 1849 | GSList *ignore_children, Error **errp) |
d5e6f437 KW |
1850 | { |
1851 | BdrvChild *c; | |
33a610c3 KW |
1852 | uint64_t cumulative_perms = new_used_perm; |
1853 | uint64_t cumulative_shared_perms = new_shared_perm; | |
d5e6f437 KW |
1854 | |
1855 | /* There is no reason why anyone couldn't tolerate write_unchanged */ | |
1856 | assert(new_shared_perm & BLK_PERM_WRITE_UNCHANGED); | |
1857 | ||
1858 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
46181129 | 1859 | if (g_slist_find(ignore_children, c)) { |
d5e6f437 KW |
1860 | continue; |
1861 | } | |
1862 | ||
d083319f KW |
1863 | if ((new_used_perm & c->shared_perm) != new_used_perm) { |
1864 | char *user = bdrv_child_user_desc(c); | |
1865 | char *perm_names = bdrv_perm_names(new_used_perm & ~c->shared_perm); | |
1866 | error_setg(errp, "Conflicts with use by %s as '%s', which does not " | |
1867 | "allow '%s' on %s", | |
1868 | user, c->name, perm_names, bdrv_get_node_name(c->bs)); | |
1869 | g_free(user); | |
1870 | g_free(perm_names); | |
1871 | return -EPERM; | |
1872 | } | |
1873 | ||
1874 | if ((c->perm & new_shared_perm) != c->perm) { | |
1875 | char *user = bdrv_child_user_desc(c); | |
1876 | char *perm_names = bdrv_perm_names(c->perm & ~new_shared_perm); | |
1877 | error_setg(errp, "Conflicts with use by %s as '%s', which uses " | |
1878 | "'%s' on %s", | |
1879 | user, c->name, perm_names, bdrv_get_node_name(c->bs)); | |
1880 | g_free(user); | |
1881 | g_free(perm_names); | |
d5e6f437 KW |
1882 | return -EPERM; |
1883 | } | |
33a610c3 KW |
1884 | |
1885 | cumulative_perms |= c->perm; | |
1886 | cumulative_shared_perms &= c->shared_perm; | |
d5e6f437 KW |
1887 | } |
1888 | ||
3121fb45 | 1889 | return bdrv_check_perm(bs, q, cumulative_perms, cumulative_shared_perms, |
46181129 | 1890 | ignore_children, errp); |
33a610c3 KW |
1891 | } |
1892 | ||
1893 | /* Needs to be followed by a call to either bdrv_child_set_perm() or | |
1894 | * bdrv_child_abort_perm_update(). */ | |
3121fb45 KW |
1895 | static int bdrv_child_check_perm(BdrvChild *c, BlockReopenQueue *q, |
1896 | uint64_t perm, uint64_t shared, | |
c1cef672 | 1897 | GSList *ignore_children, Error **errp) |
33a610c3 | 1898 | { |
46181129 KW |
1899 | int ret; |
1900 | ||
1901 | ignore_children = g_slist_prepend(g_slist_copy(ignore_children), c); | |
3121fb45 | 1902 | ret = bdrv_check_update_perm(c->bs, q, perm, shared, ignore_children, errp); |
46181129 KW |
1903 | g_slist_free(ignore_children); |
1904 | ||
1905 | return ret; | |
33a610c3 KW |
1906 | } |
1907 | ||
c1cef672 | 1908 | static void bdrv_child_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared) |
33a610c3 KW |
1909 | { |
1910 | uint64_t cumulative_perms, cumulative_shared_perms; | |
1911 | ||
1912 | c->perm = perm; | |
1913 | c->shared_perm = shared; | |
1914 | ||
1915 | bdrv_get_cumulative_perm(c->bs, &cumulative_perms, | |
1916 | &cumulative_shared_perms); | |
1917 | bdrv_set_perm(c->bs, cumulative_perms, cumulative_shared_perms); | |
1918 | } | |
1919 | ||
c1cef672 | 1920 | static void bdrv_child_abort_perm_update(BdrvChild *c) |
33a610c3 KW |
1921 | { |
1922 | bdrv_abort_perm_update(c->bs); | |
1923 | } | |
1924 | ||
1925 | int bdrv_child_try_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared, | |
1926 | Error **errp) | |
1927 | { | |
1928 | int ret; | |
1929 | ||
3121fb45 | 1930 | ret = bdrv_child_check_perm(c, NULL, perm, shared, NULL, errp); |
33a610c3 KW |
1931 | if (ret < 0) { |
1932 | bdrv_child_abort_perm_update(c); | |
1933 | return ret; | |
1934 | } | |
1935 | ||
1936 | bdrv_child_set_perm(c, perm, shared); | |
1937 | ||
d5e6f437 KW |
1938 | return 0; |
1939 | } | |
1940 | ||
6a1b9ee1 KW |
1941 | #define DEFAULT_PERM_PASSTHROUGH (BLK_PERM_CONSISTENT_READ \ |
1942 | | BLK_PERM_WRITE \ | |
1943 | | BLK_PERM_WRITE_UNCHANGED \ | |
1944 | | BLK_PERM_RESIZE) | |
1945 | #define DEFAULT_PERM_UNCHANGED (BLK_PERM_ALL & ~DEFAULT_PERM_PASSTHROUGH) | |
1946 | ||
1947 | void bdrv_filter_default_perms(BlockDriverState *bs, BdrvChild *c, | |
1948 | const BdrvChildRole *role, | |
e0995dc3 | 1949 | BlockReopenQueue *reopen_queue, |
6a1b9ee1 KW |
1950 | uint64_t perm, uint64_t shared, |
1951 | uint64_t *nperm, uint64_t *nshared) | |
1952 | { | |
1953 | if (c == NULL) { | |
1954 | *nperm = perm & DEFAULT_PERM_PASSTHROUGH; | |
1955 | *nshared = (shared & DEFAULT_PERM_PASSTHROUGH) | DEFAULT_PERM_UNCHANGED; | |
1956 | return; | |
1957 | } | |
1958 | ||
1959 | *nperm = (perm & DEFAULT_PERM_PASSTHROUGH) | | |
1960 | (c->perm & DEFAULT_PERM_UNCHANGED); | |
1961 | *nshared = (shared & DEFAULT_PERM_PASSTHROUGH) | | |
1962 | (c->shared_perm & DEFAULT_PERM_UNCHANGED); | |
1963 | } | |
1964 | ||
6b1a044a KW |
1965 | void bdrv_format_default_perms(BlockDriverState *bs, BdrvChild *c, |
1966 | const BdrvChildRole *role, | |
e0995dc3 | 1967 | BlockReopenQueue *reopen_queue, |
6b1a044a KW |
1968 | uint64_t perm, uint64_t shared, |
1969 | uint64_t *nperm, uint64_t *nshared) | |
1970 | { | |
1971 | bool backing = (role == &child_backing); | |
1972 | assert(role == &child_backing || role == &child_file); | |
1973 | ||
1974 | if (!backing) { | |
5fbfabd3 KW |
1975 | int flags = bdrv_reopen_get_flags(reopen_queue, bs); |
1976 | ||
6b1a044a KW |
1977 | /* Apart from the modifications below, the same permissions are |
1978 | * forwarded and left alone as for filters */ | |
e0995dc3 KW |
1979 | bdrv_filter_default_perms(bs, c, role, reopen_queue, perm, shared, |
1980 | &perm, &shared); | |
6b1a044a KW |
1981 | |
1982 | /* Format drivers may touch metadata even if the guest doesn't write */ | |
cc022140 | 1983 | if (bdrv_is_writable_after_reopen(bs, reopen_queue)) { |
6b1a044a KW |
1984 | perm |= BLK_PERM_WRITE | BLK_PERM_RESIZE; |
1985 | } | |
1986 | ||
1987 | /* bs->file always needs to be consistent because of the metadata. We | |
1988 | * can never allow other users to resize or write to it. */ | |
5fbfabd3 KW |
1989 | if (!(flags & BDRV_O_NO_IO)) { |
1990 | perm |= BLK_PERM_CONSISTENT_READ; | |
1991 | } | |
6b1a044a KW |
1992 | shared &= ~(BLK_PERM_WRITE | BLK_PERM_RESIZE); |
1993 | } else { | |
1994 | /* We want consistent read from backing files if the parent needs it. | |
1995 | * No other operations are performed on backing files. */ | |
1996 | perm &= BLK_PERM_CONSISTENT_READ; | |
1997 | ||
1998 | /* If the parent can deal with changing data, we're okay with a | |
1999 | * writable and resizable backing file. */ | |
2000 | /* TODO Require !(perm & BLK_PERM_CONSISTENT_READ), too? */ | |
2001 | if (shared & BLK_PERM_WRITE) { | |
2002 | shared = BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
2003 | } else { | |
2004 | shared = 0; | |
2005 | } | |
2006 | ||
2007 | shared |= BLK_PERM_CONSISTENT_READ | BLK_PERM_GRAPH_MOD | | |
2008 | BLK_PERM_WRITE_UNCHANGED; | |
2009 | } | |
2010 | ||
9c5e6594 KW |
2011 | if (bs->open_flags & BDRV_O_INACTIVE) { |
2012 | shared |= BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
2013 | } | |
2014 | ||
6b1a044a KW |
2015 | *nperm = perm; |
2016 | *nshared = shared; | |
2017 | } | |
2018 | ||
8ee03995 KW |
2019 | static void bdrv_replace_child_noperm(BdrvChild *child, |
2020 | BlockDriverState *new_bs) | |
e9740bc6 KW |
2021 | { |
2022 | BlockDriverState *old_bs = child->bs; | |
0152bf40 | 2023 | int i; |
e9740bc6 | 2024 | |
bb2614e9 FZ |
2025 | if (old_bs && new_bs) { |
2026 | assert(bdrv_get_aio_context(old_bs) == bdrv_get_aio_context(new_bs)); | |
2027 | } | |
e9740bc6 | 2028 | if (old_bs) { |
d736f119 KW |
2029 | /* Detach first so that the recursive drain sections coming from @child |
2030 | * are already gone and we only end the drain sections that came from | |
2031 | * elsewhere. */ | |
2032 | if (child->role->detach) { | |
2033 | child->role->detach(child); | |
2034 | } | |
36fe1331 | 2035 | if (old_bs->quiesce_counter && child->role->drained_end) { |
0152bf40 KW |
2036 | for (i = 0; i < old_bs->quiesce_counter; i++) { |
2037 | child->role->drained_end(child); | |
2038 | } | |
36fe1331 | 2039 | } |
e9740bc6 KW |
2040 | QLIST_REMOVE(child, next_parent); |
2041 | } | |
36fe1331 KW |
2042 | |
2043 | child->bs = new_bs; | |
2044 | ||
e9740bc6 KW |
2045 | if (new_bs) { |
2046 | QLIST_INSERT_HEAD(&new_bs->parents, child, next_parent); | |
36fe1331 | 2047 | if (new_bs->quiesce_counter && child->role->drained_begin) { |
0152bf40 KW |
2048 | for (i = 0; i < new_bs->quiesce_counter; i++) { |
2049 | child->role->drained_begin(child); | |
2050 | } | |
36fe1331 | 2051 | } |
33a610c3 | 2052 | |
d736f119 KW |
2053 | /* Attach only after starting new drained sections, so that recursive |
2054 | * drain sections coming from @child don't get an extra .drained_begin | |
2055 | * callback. */ | |
8ee03995 KW |
2056 | if (child->role->attach) { |
2057 | child->role->attach(child); | |
2058 | } | |
2059 | } | |
2060 | } | |
33a610c3 | 2061 | |
466787fb KW |
2062 | /* |
2063 | * Updates @child to change its reference to point to @new_bs, including | |
2064 | * checking and applying the necessary permisson updates both to the old node | |
2065 | * and to @new_bs. | |
2066 | * | |
2067 | * NULL is passed as @new_bs for removing the reference before freeing @child. | |
2068 | * | |
2069 | * If @new_bs is not NULL, bdrv_check_perm() must be called beforehand, as this | |
2070 | * function uses bdrv_set_perm() to update the permissions according to the new | |
2071 | * reference that @new_bs gets. | |
2072 | */ | |
2073 | static void bdrv_replace_child(BdrvChild *child, BlockDriverState *new_bs) | |
8ee03995 KW |
2074 | { |
2075 | BlockDriverState *old_bs = child->bs; | |
2076 | uint64_t perm, shared_perm; | |
2077 | ||
8aecf1d1 KW |
2078 | bdrv_replace_child_noperm(child, new_bs); |
2079 | ||
8ee03995 | 2080 | if (old_bs) { |
33a610c3 KW |
2081 | /* Update permissions for old node. This is guaranteed to succeed |
2082 | * because we're just taking a parent away, so we're loosening | |
2083 | * restrictions. */ | |
2084 | bdrv_get_cumulative_perm(old_bs, &perm, &shared_perm); | |
3121fb45 | 2085 | bdrv_check_perm(old_bs, NULL, perm, shared_perm, NULL, &error_abort); |
33a610c3 | 2086 | bdrv_set_perm(old_bs, perm, shared_perm); |
e9740bc6 | 2087 | } |
36fe1331 | 2088 | |
e9740bc6 | 2089 | if (new_bs) { |
33a610c3 | 2090 | bdrv_get_cumulative_perm(new_bs, &perm, &shared_perm); |
33a610c3 | 2091 | bdrv_set_perm(new_bs, perm, shared_perm); |
e9740bc6 | 2092 | } |
e9740bc6 KW |
2093 | } |
2094 | ||
f21d96d0 KW |
2095 | BdrvChild *bdrv_root_attach_child(BlockDriverState *child_bs, |
2096 | const char *child_name, | |
36fe1331 | 2097 | const BdrvChildRole *child_role, |
d5e6f437 KW |
2098 | uint64_t perm, uint64_t shared_perm, |
2099 | void *opaque, Error **errp) | |
df581792 | 2100 | { |
d5e6f437 KW |
2101 | BdrvChild *child; |
2102 | int ret; | |
2103 | ||
3121fb45 | 2104 | ret = bdrv_check_update_perm(child_bs, NULL, perm, shared_perm, NULL, errp); |
d5e6f437 | 2105 | if (ret < 0) { |
33a610c3 | 2106 | bdrv_abort_perm_update(child_bs); |
d5e6f437 KW |
2107 | return NULL; |
2108 | } | |
2109 | ||
2110 | child = g_new(BdrvChild, 1); | |
df581792 | 2111 | *child = (BdrvChild) { |
d5e6f437 KW |
2112 | .bs = NULL, |
2113 | .name = g_strdup(child_name), | |
2114 | .role = child_role, | |
2115 | .perm = perm, | |
2116 | .shared_perm = shared_perm, | |
2117 | .opaque = opaque, | |
df581792 KW |
2118 | }; |
2119 | ||
33a610c3 | 2120 | /* This performs the matching bdrv_set_perm() for the above check. */ |
466787fb | 2121 | bdrv_replace_child(child, child_bs); |
b4b059f6 KW |
2122 | |
2123 | return child; | |
df581792 KW |
2124 | } |
2125 | ||
98292c61 WC |
2126 | BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs, |
2127 | BlockDriverState *child_bs, | |
2128 | const char *child_name, | |
8b2ff529 KW |
2129 | const BdrvChildRole *child_role, |
2130 | Error **errp) | |
f21d96d0 | 2131 | { |
d5e6f437 | 2132 | BdrvChild *child; |
f68c598b KW |
2133 | uint64_t perm, shared_perm; |
2134 | ||
2135 | bdrv_get_cumulative_perm(parent_bs, &perm, &shared_perm); | |
2136 | ||
2137 | assert(parent_bs->drv); | |
bb2614e9 | 2138 | assert(bdrv_get_aio_context(parent_bs) == bdrv_get_aio_context(child_bs)); |
e0995dc3 | 2139 | bdrv_child_perm(parent_bs, child_bs, NULL, child_role, NULL, |
ffd1a5a2 | 2140 | perm, shared_perm, &perm, &shared_perm); |
d5e6f437 | 2141 | |
d5e6f437 | 2142 | child = bdrv_root_attach_child(child_bs, child_name, child_role, |
f68c598b | 2143 | perm, shared_perm, parent_bs, errp); |
d5e6f437 KW |
2144 | if (child == NULL) { |
2145 | return NULL; | |
2146 | } | |
2147 | ||
f21d96d0 KW |
2148 | QLIST_INSERT_HEAD(&parent_bs->children, child, next); |
2149 | return child; | |
2150 | } | |
2151 | ||
3f09bfbc | 2152 | static void bdrv_detach_child(BdrvChild *child) |
33a60407 | 2153 | { |
f21d96d0 KW |
2154 | if (child->next.le_prev) { |
2155 | QLIST_REMOVE(child, next); | |
2156 | child->next.le_prev = NULL; | |
2157 | } | |
e9740bc6 | 2158 | |
466787fb | 2159 | bdrv_replace_child(child, NULL); |
e9740bc6 | 2160 | |
260fecf1 | 2161 | g_free(child->name); |
33a60407 KW |
2162 | g_free(child); |
2163 | } | |
2164 | ||
f21d96d0 | 2165 | void bdrv_root_unref_child(BdrvChild *child) |
33a60407 | 2166 | { |
779020cb KW |
2167 | BlockDriverState *child_bs; |
2168 | ||
f21d96d0 KW |
2169 | child_bs = child->bs; |
2170 | bdrv_detach_child(child); | |
2171 | bdrv_unref(child_bs); | |
2172 | } | |
2173 | ||
2174 | void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child) | |
2175 | { | |
779020cb KW |
2176 | if (child == NULL) { |
2177 | return; | |
2178 | } | |
33a60407 KW |
2179 | |
2180 | if (child->bs->inherits_from == parent) { | |
4e4bf5c4 KW |
2181 | BdrvChild *c; |
2182 | ||
2183 | /* Remove inherits_from only when the last reference between parent and | |
2184 | * child->bs goes away. */ | |
2185 | QLIST_FOREACH(c, &parent->children, next) { | |
2186 | if (c != child && c->bs == child->bs) { | |
2187 | break; | |
2188 | } | |
2189 | } | |
2190 | if (c == NULL) { | |
2191 | child->bs->inherits_from = NULL; | |
2192 | } | |
33a60407 KW |
2193 | } |
2194 | ||
f21d96d0 | 2195 | bdrv_root_unref_child(child); |
33a60407 KW |
2196 | } |
2197 | ||
5c8cab48 KW |
2198 | |
2199 | static void bdrv_parent_cb_change_media(BlockDriverState *bs, bool load) | |
2200 | { | |
2201 | BdrvChild *c; | |
2202 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
2203 | if (c->role->change_media) { | |
2204 | c->role->change_media(c, load); | |
2205 | } | |
2206 | } | |
2207 | } | |
2208 | ||
2209 | static void bdrv_parent_cb_resize(BlockDriverState *bs) | |
2210 | { | |
2211 | BdrvChild *c; | |
2212 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
2213 | if (c->role->resize) { | |
2214 | c->role->resize(c); | |
2215 | } | |
2216 | } | |
2217 | } | |
2218 | ||
5db15a57 KW |
2219 | /* |
2220 | * Sets the backing file link of a BDS. A new reference is created; callers | |
2221 | * which don't need their own reference any more must call bdrv_unref(). | |
2222 | */ | |
12fa4af6 KW |
2223 | void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd, |
2224 | Error **errp) | |
8d24cce1 | 2225 | { |
5db15a57 KW |
2226 | if (backing_hd) { |
2227 | bdrv_ref(backing_hd); | |
2228 | } | |
8d24cce1 | 2229 | |
760e0063 | 2230 | if (bs->backing) { |
5db15a57 | 2231 | bdrv_unref_child(bs, bs->backing); |
826b6ca0 FZ |
2232 | } |
2233 | ||
8d24cce1 | 2234 | if (!backing_hd) { |
760e0063 | 2235 | bs->backing = NULL; |
8d24cce1 FZ |
2236 | goto out; |
2237 | } | |
12fa4af6 | 2238 | |
8b2ff529 | 2239 | bs->backing = bdrv_attach_child(bs, backing_hd, "backing", &child_backing, |
12fa4af6 KW |
2240 | errp); |
2241 | if (!bs->backing) { | |
2242 | bdrv_unref(backing_hd); | |
2243 | } | |
826b6ca0 | 2244 | |
9e7e940c KW |
2245 | bdrv_refresh_filename(bs); |
2246 | ||
8d24cce1 | 2247 | out: |
3baca891 | 2248 | bdrv_refresh_limits(bs, NULL); |
8d24cce1 FZ |
2249 | } |
2250 | ||
31ca6d07 KW |
2251 | /* |
2252 | * Opens the backing file for a BlockDriverState if not yet open | |
2253 | * | |
d9b7b057 KW |
2254 | * bdref_key specifies the key for the image's BlockdevRef in the options QDict. |
2255 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
2256 | * itself, all options starting with "${bdref_key}." are considered part of the | |
2257 | * BlockdevRef. | |
2258 | * | |
2259 | * TODO Can this be unified with bdrv_open_image()? | |
31ca6d07 | 2260 | */ |
d9b7b057 KW |
2261 | int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options, |
2262 | const char *bdref_key, Error **errp) | |
9156df12 | 2263 | { |
1ba4b6a5 | 2264 | char *backing_filename = g_malloc0(PATH_MAX); |
d9b7b057 KW |
2265 | char *bdref_key_dot; |
2266 | const char *reference = NULL; | |
317fc44e | 2267 | int ret = 0; |
8d24cce1 | 2268 | BlockDriverState *backing_hd; |
d9b7b057 KW |
2269 | QDict *options; |
2270 | QDict *tmp_parent_options = NULL; | |
34b5d2c6 | 2271 | Error *local_err = NULL; |
9156df12 | 2272 | |
760e0063 | 2273 | if (bs->backing != NULL) { |
1ba4b6a5 | 2274 | goto free_exit; |
9156df12 PB |
2275 | } |
2276 | ||
31ca6d07 | 2277 | /* NULL means an empty set of options */ |
d9b7b057 KW |
2278 | if (parent_options == NULL) { |
2279 | tmp_parent_options = qdict_new(); | |
2280 | parent_options = tmp_parent_options; | |
31ca6d07 KW |
2281 | } |
2282 | ||
9156df12 | 2283 | bs->open_flags &= ~BDRV_O_NO_BACKING; |
d9b7b057 KW |
2284 | |
2285 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); | |
2286 | qdict_extract_subqdict(parent_options, &options, bdref_key_dot); | |
2287 | g_free(bdref_key_dot); | |
2288 | ||
129c7d1c MA |
2289 | /* |
2290 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
2291 | * types would require more care. When @parent_options come from | |
2292 | * -blockdev or blockdev_add, its members are typed according to | |
2293 | * the QAPI schema, but when they come from -drive, they're all | |
2294 | * QString. | |
2295 | */ | |
d9b7b057 KW |
2296 | reference = qdict_get_try_str(parent_options, bdref_key); |
2297 | if (reference || qdict_haskey(options, "file.filename")) { | |
1cb6f506 KW |
2298 | backing_filename[0] = '\0'; |
2299 | } else if (bs->backing_file[0] == '\0' && qdict_size(options) == 0) { | |
cb3e7f08 | 2300 | qobject_unref(options); |
1ba4b6a5 | 2301 | goto free_exit; |
dbecebdd | 2302 | } else { |
9f07429e HR |
2303 | bdrv_get_full_backing_filename(bs, backing_filename, PATH_MAX, |
2304 | &local_err); | |
2305 | if (local_err) { | |
2306 | ret = -EINVAL; | |
2307 | error_propagate(errp, local_err); | |
cb3e7f08 | 2308 | qobject_unref(options); |
9f07429e HR |
2309 | goto free_exit; |
2310 | } | |
9156df12 PB |
2311 | } |
2312 | ||
8ee79e70 KW |
2313 | if (!bs->drv || !bs->drv->supports_backing) { |
2314 | ret = -EINVAL; | |
2315 | error_setg(errp, "Driver doesn't support backing files"); | |
cb3e7f08 | 2316 | qobject_unref(options); |
8ee79e70 KW |
2317 | goto free_exit; |
2318 | } | |
2319 | ||
6bff597b PK |
2320 | if (!reference && |
2321 | bs->backing_format[0] != '\0' && !qdict_haskey(options, "driver")) { | |
46f5ac20 | 2322 | qdict_put_str(options, "driver", bs->backing_format); |
9156df12 PB |
2323 | } |
2324 | ||
5b363937 HR |
2325 | backing_hd = bdrv_open_inherit(*backing_filename ? backing_filename : NULL, |
2326 | reference, options, 0, bs, &child_backing, | |
2327 | errp); | |
2328 | if (!backing_hd) { | |
9156df12 | 2329 | bs->open_flags |= BDRV_O_NO_BACKING; |
e43bfd9c | 2330 | error_prepend(errp, "Could not open backing file: "); |
5b363937 | 2331 | ret = -EINVAL; |
1ba4b6a5 | 2332 | goto free_exit; |
9156df12 | 2333 | } |
5ce6bfe2 | 2334 | bdrv_set_aio_context(backing_hd, bdrv_get_aio_context(bs)); |
df581792 | 2335 | |
5db15a57 KW |
2336 | /* Hook up the backing file link; drop our reference, bs owns the |
2337 | * backing_hd reference now */ | |
12fa4af6 | 2338 | bdrv_set_backing_hd(bs, backing_hd, &local_err); |
5db15a57 | 2339 | bdrv_unref(backing_hd); |
12fa4af6 | 2340 | if (local_err) { |
8cd1a3e4 | 2341 | error_propagate(errp, local_err); |
12fa4af6 KW |
2342 | ret = -EINVAL; |
2343 | goto free_exit; | |
2344 | } | |
d80ac658 | 2345 | |
d9b7b057 KW |
2346 | qdict_del(parent_options, bdref_key); |
2347 | ||
1ba4b6a5 BC |
2348 | free_exit: |
2349 | g_free(backing_filename); | |
cb3e7f08 | 2350 | qobject_unref(tmp_parent_options); |
1ba4b6a5 | 2351 | return ret; |
9156df12 PB |
2352 | } |
2353 | ||
2d6b86af KW |
2354 | static BlockDriverState * |
2355 | bdrv_open_child_bs(const char *filename, QDict *options, const char *bdref_key, | |
2356 | BlockDriverState *parent, const BdrvChildRole *child_role, | |
2357 | bool allow_none, Error **errp) | |
da557aac | 2358 | { |
2d6b86af | 2359 | BlockDriverState *bs = NULL; |
da557aac | 2360 | QDict *image_options; |
da557aac HR |
2361 | char *bdref_key_dot; |
2362 | const char *reference; | |
2363 | ||
df581792 | 2364 | assert(child_role != NULL); |
f67503e5 | 2365 | |
da557aac HR |
2366 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); |
2367 | qdict_extract_subqdict(options, &image_options, bdref_key_dot); | |
2368 | g_free(bdref_key_dot); | |
2369 | ||
129c7d1c MA |
2370 | /* |
2371 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
2372 | * types would require more care. When @options come from | |
2373 | * -blockdev or blockdev_add, its members are typed according to | |
2374 | * the QAPI schema, but when they come from -drive, they're all | |
2375 | * QString. | |
2376 | */ | |
da557aac HR |
2377 | reference = qdict_get_try_str(options, bdref_key); |
2378 | if (!filename && !reference && !qdict_size(image_options)) { | |
b4b059f6 | 2379 | if (!allow_none) { |
da557aac HR |
2380 | error_setg(errp, "A block device must be specified for \"%s\"", |
2381 | bdref_key); | |
da557aac | 2382 | } |
cb3e7f08 | 2383 | qobject_unref(image_options); |
da557aac HR |
2384 | goto done; |
2385 | } | |
2386 | ||
5b363937 HR |
2387 | bs = bdrv_open_inherit(filename, reference, image_options, 0, |
2388 | parent, child_role, errp); | |
2389 | if (!bs) { | |
df581792 KW |
2390 | goto done; |
2391 | } | |
2392 | ||
da557aac HR |
2393 | done: |
2394 | qdict_del(options, bdref_key); | |
2d6b86af KW |
2395 | return bs; |
2396 | } | |
2397 | ||
2398 | /* | |
2399 | * Opens a disk image whose options are given as BlockdevRef in another block | |
2400 | * device's options. | |
2401 | * | |
2402 | * If allow_none is true, no image will be opened if filename is false and no | |
2403 | * BlockdevRef is given. NULL will be returned, but errp remains unset. | |
2404 | * | |
2405 | * bdrev_key specifies the key for the image's BlockdevRef in the options QDict. | |
2406 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
2407 | * itself, all options starting with "${bdref_key}." are considered part of the | |
2408 | * BlockdevRef. | |
2409 | * | |
2410 | * The BlockdevRef will be removed from the options QDict. | |
2411 | */ | |
2412 | BdrvChild *bdrv_open_child(const char *filename, | |
2413 | QDict *options, const char *bdref_key, | |
2414 | BlockDriverState *parent, | |
2415 | const BdrvChildRole *child_role, | |
2416 | bool allow_none, Error **errp) | |
2417 | { | |
8b2ff529 | 2418 | BdrvChild *c; |
2d6b86af KW |
2419 | BlockDriverState *bs; |
2420 | ||
2421 | bs = bdrv_open_child_bs(filename, options, bdref_key, parent, child_role, | |
2422 | allow_none, errp); | |
2423 | if (bs == NULL) { | |
2424 | return NULL; | |
2425 | } | |
2426 | ||
8b2ff529 KW |
2427 | c = bdrv_attach_child(parent, bs, bdref_key, child_role, errp); |
2428 | if (!c) { | |
2429 | bdrv_unref(bs); | |
2430 | return NULL; | |
2431 | } | |
2432 | ||
2433 | return c; | |
b4b059f6 KW |
2434 | } |
2435 | ||
e1d74bc6 KW |
2436 | /* TODO Future callers may need to specify parent/child_role in order for |
2437 | * option inheritance to work. Existing callers use it for the root node. */ | |
2438 | BlockDriverState *bdrv_open_blockdev_ref(BlockdevRef *ref, Error **errp) | |
2439 | { | |
2440 | BlockDriverState *bs = NULL; | |
2441 | Error *local_err = NULL; | |
2442 | QObject *obj = NULL; | |
2443 | QDict *qdict = NULL; | |
2444 | const char *reference = NULL; | |
2445 | Visitor *v = NULL; | |
2446 | ||
2447 | if (ref->type == QTYPE_QSTRING) { | |
2448 | reference = ref->u.reference; | |
2449 | } else { | |
2450 | BlockdevOptions *options = &ref->u.definition; | |
2451 | assert(ref->type == QTYPE_QDICT); | |
2452 | ||
2453 | v = qobject_output_visitor_new(&obj); | |
2454 | visit_type_BlockdevOptions(v, NULL, &options, &local_err); | |
2455 | if (local_err) { | |
2456 | error_propagate(errp, local_err); | |
2457 | goto fail; | |
2458 | } | |
2459 | visit_complete(v, &obj); | |
2460 | ||
7dc847eb | 2461 | qdict = qobject_to(QDict, obj); |
e1d74bc6 KW |
2462 | qdict_flatten(qdict); |
2463 | ||
2464 | /* bdrv_open_inherit() defaults to the values in bdrv_flags (for | |
2465 | * compatibility with other callers) rather than what we want as the | |
2466 | * real defaults. Apply the defaults here instead. */ | |
2467 | qdict_set_default_str(qdict, BDRV_OPT_CACHE_DIRECT, "off"); | |
2468 | qdict_set_default_str(qdict, BDRV_OPT_CACHE_NO_FLUSH, "off"); | |
2469 | qdict_set_default_str(qdict, BDRV_OPT_READ_ONLY, "off"); | |
2470 | } | |
2471 | ||
2472 | bs = bdrv_open_inherit(NULL, reference, qdict, 0, NULL, NULL, errp); | |
2473 | obj = NULL; | |
2474 | ||
2475 | fail: | |
cb3e7f08 | 2476 | qobject_unref(obj); |
e1d74bc6 KW |
2477 | visit_free(v); |
2478 | return bs; | |
2479 | } | |
2480 | ||
66836189 HR |
2481 | static BlockDriverState *bdrv_append_temp_snapshot(BlockDriverState *bs, |
2482 | int flags, | |
2483 | QDict *snapshot_options, | |
2484 | Error **errp) | |
b998875d KW |
2485 | { |
2486 | /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */ | |
1ba4b6a5 | 2487 | char *tmp_filename = g_malloc0(PATH_MAX + 1); |
b998875d | 2488 | int64_t total_size; |
83d0521a | 2489 | QemuOpts *opts = NULL; |
ff6ed714 | 2490 | BlockDriverState *bs_snapshot = NULL; |
b2c2832c | 2491 | Error *local_err = NULL; |
b998875d KW |
2492 | int ret; |
2493 | ||
2494 | /* if snapshot, we create a temporary backing file and open it | |
2495 | instead of opening 'filename' directly */ | |
2496 | ||
2497 | /* Get the required size from the image */ | |
f187743a KW |
2498 | total_size = bdrv_getlength(bs); |
2499 | if (total_size < 0) { | |
2500 | error_setg_errno(errp, -total_size, "Could not get image size"); | |
1ba4b6a5 | 2501 | goto out; |
f187743a | 2502 | } |
b998875d KW |
2503 | |
2504 | /* Create the temporary image */ | |
1ba4b6a5 | 2505 | ret = get_tmp_filename(tmp_filename, PATH_MAX + 1); |
b998875d KW |
2506 | if (ret < 0) { |
2507 | error_setg_errno(errp, -ret, "Could not get temporary filename"); | |
1ba4b6a5 | 2508 | goto out; |
b998875d KW |
2509 | } |
2510 | ||
ef810437 | 2511 | opts = qemu_opts_create(bdrv_qcow2.create_opts, NULL, 0, |
c282e1fd | 2512 | &error_abort); |
39101f25 | 2513 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_size, &error_abort); |
e43bfd9c | 2514 | ret = bdrv_create(&bdrv_qcow2, tmp_filename, opts, errp); |
83d0521a | 2515 | qemu_opts_del(opts); |
b998875d | 2516 | if (ret < 0) { |
e43bfd9c MA |
2517 | error_prepend(errp, "Could not create temporary overlay '%s': ", |
2518 | tmp_filename); | |
1ba4b6a5 | 2519 | goto out; |
b998875d KW |
2520 | } |
2521 | ||
73176bee | 2522 | /* Prepare options QDict for the temporary file */ |
46f5ac20 EB |
2523 | qdict_put_str(snapshot_options, "file.driver", "file"); |
2524 | qdict_put_str(snapshot_options, "file.filename", tmp_filename); | |
2525 | qdict_put_str(snapshot_options, "driver", "qcow2"); | |
b998875d | 2526 | |
5b363937 | 2527 | bs_snapshot = bdrv_open(NULL, NULL, snapshot_options, flags, errp); |
73176bee | 2528 | snapshot_options = NULL; |
5b363937 | 2529 | if (!bs_snapshot) { |
1ba4b6a5 | 2530 | goto out; |
b998875d KW |
2531 | } |
2532 | ||
ff6ed714 EB |
2533 | /* bdrv_append() consumes a strong reference to bs_snapshot |
2534 | * (i.e. it will call bdrv_unref() on it) even on error, so in | |
2535 | * order to be able to return one, we have to increase | |
2536 | * bs_snapshot's refcount here */ | |
66836189 | 2537 | bdrv_ref(bs_snapshot); |
b2c2832c KW |
2538 | bdrv_append(bs_snapshot, bs, &local_err); |
2539 | if (local_err) { | |
2540 | error_propagate(errp, local_err); | |
ff6ed714 | 2541 | bs_snapshot = NULL; |
b2c2832c KW |
2542 | goto out; |
2543 | } | |
1ba4b6a5 BC |
2544 | |
2545 | out: | |
cb3e7f08 | 2546 | qobject_unref(snapshot_options); |
1ba4b6a5 | 2547 | g_free(tmp_filename); |
ff6ed714 | 2548 | return bs_snapshot; |
b998875d KW |
2549 | } |
2550 | ||
b6ce07aa KW |
2551 | /* |
2552 | * Opens a disk image (raw, qcow2, vmdk, ...) | |
de9c0cec KW |
2553 | * |
2554 | * options is a QDict of options to pass to the block drivers, or NULL for an | |
2555 | * empty set of options. The reference to the QDict belongs to the block layer | |
2556 | * after the call (even on failure), so if the caller intends to reuse the | |
cb3e7f08 | 2557 | * dictionary, it needs to use qobject_ref() before calling bdrv_open. |
f67503e5 HR |
2558 | * |
2559 | * If *pbs is NULL, a new BDS will be created with a pointer to it stored there. | |
2560 | * If it is not NULL, the referenced BDS will be reused. | |
ddf5636d HR |
2561 | * |
2562 | * The reference parameter may be used to specify an existing block device which | |
2563 | * should be opened. If specified, neither options nor a filename may be given, | |
2564 | * nor can an existing BDS be reused (that is, *pbs has to be NULL). | |
b6ce07aa | 2565 | */ |
5b363937 HR |
2566 | static BlockDriverState *bdrv_open_inherit(const char *filename, |
2567 | const char *reference, | |
2568 | QDict *options, int flags, | |
2569 | BlockDriverState *parent, | |
2570 | const BdrvChildRole *child_role, | |
2571 | Error **errp) | |
ea2384d3 | 2572 | { |
b6ce07aa | 2573 | int ret; |
5696c6e3 | 2574 | BlockBackend *file = NULL; |
9a4f4c31 | 2575 | BlockDriverState *bs; |
ce343771 | 2576 | BlockDriver *drv = NULL; |
74fe54f2 | 2577 | const char *drvname; |
3e8c2e57 | 2578 | const char *backing; |
34b5d2c6 | 2579 | Error *local_err = NULL; |
73176bee | 2580 | QDict *snapshot_options = NULL; |
b1e6fc08 | 2581 | int snapshot_flags = 0; |
712e7874 | 2582 | |
f3930ed0 KW |
2583 | assert(!child_role || !flags); |
2584 | assert(!child_role == !parent); | |
f67503e5 | 2585 | |
ddf5636d HR |
2586 | if (reference) { |
2587 | bool options_non_empty = options ? qdict_size(options) : false; | |
cb3e7f08 | 2588 | qobject_unref(options); |
ddf5636d | 2589 | |
ddf5636d HR |
2590 | if (filename || options_non_empty) { |
2591 | error_setg(errp, "Cannot reference an existing block device with " | |
2592 | "additional options or a new filename"); | |
5b363937 | 2593 | return NULL; |
ddf5636d HR |
2594 | } |
2595 | ||
2596 | bs = bdrv_lookup_bs(reference, reference, errp); | |
2597 | if (!bs) { | |
5b363937 | 2598 | return NULL; |
ddf5636d | 2599 | } |
76b22320 | 2600 | |
ddf5636d | 2601 | bdrv_ref(bs); |
5b363937 | 2602 | return bs; |
ddf5636d HR |
2603 | } |
2604 | ||
5b363937 | 2605 | bs = bdrv_new(); |
f67503e5 | 2606 | |
de9c0cec KW |
2607 | /* NULL means an empty set of options */ |
2608 | if (options == NULL) { | |
2609 | options = qdict_new(); | |
2610 | } | |
2611 | ||
145f598e | 2612 | /* json: syntax counts as explicit options, as if in the QDict */ |
de3b53f0 KW |
2613 | parse_json_protocol(options, &filename, &local_err); |
2614 | if (local_err) { | |
de3b53f0 KW |
2615 | goto fail; |
2616 | } | |
2617 | ||
145f598e KW |
2618 | bs->explicit_options = qdict_clone_shallow(options); |
2619 | ||
f3930ed0 | 2620 | if (child_role) { |
bddcec37 | 2621 | bs->inherits_from = parent; |
8e2160e2 KW |
2622 | child_role->inherit_options(&flags, options, |
2623 | parent->open_flags, parent->options); | |
f3930ed0 KW |
2624 | } |
2625 | ||
de3b53f0 | 2626 | ret = bdrv_fill_options(&options, filename, &flags, &local_err); |
462f5bcf KW |
2627 | if (local_err) { |
2628 | goto fail; | |
2629 | } | |
2630 | ||
129c7d1c MA |
2631 | /* |
2632 | * Set the BDRV_O_RDWR and BDRV_O_ALLOW_RDWR flags. | |
2633 | * Caution: getting a boolean member of @options requires care. | |
2634 | * When @options come from -blockdev or blockdev_add, members are | |
2635 | * typed according to the QAPI schema, but when they come from | |
2636 | * -drive, they're all QString. | |
2637 | */ | |
f87a0e29 AG |
2638 | if (g_strcmp0(qdict_get_try_str(options, BDRV_OPT_READ_ONLY), "on") && |
2639 | !qdict_get_try_bool(options, BDRV_OPT_READ_ONLY, false)) { | |
2640 | flags |= (BDRV_O_RDWR | BDRV_O_ALLOW_RDWR); | |
2641 | } else { | |
2642 | flags &= ~BDRV_O_RDWR; | |
14499ea5 AG |
2643 | } |
2644 | ||
2645 | if (flags & BDRV_O_SNAPSHOT) { | |
2646 | snapshot_options = qdict_new(); | |
2647 | bdrv_temp_snapshot_options(&snapshot_flags, snapshot_options, | |
2648 | flags, options); | |
f87a0e29 AG |
2649 | /* Let bdrv_backing_options() override "read-only" */ |
2650 | qdict_del(options, BDRV_OPT_READ_ONLY); | |
14499ea5 AG |
2651 | bdrv_backing_options(&flags, options, flags, options); |
2652 | } | |
2653 | ||
62392ebb KW |
2654 | bs->open_flags = flags; |
2655 | bs->options = options; | |
2656 | options = qdict_clone_shallow(options); | |
2657 | ||
76c591b0 | 2658 | /* Find the right image format driver */ |
129c7d1c | 2659 | /* See cautionary note on accessing @options above */ |
76c591b0 KW |
2660 | drvname = qdict_get_try_str(options, "driver"); |
2661 | if (drvname) { | |
2662 | drv = bdrv_find_format(drvname); | |
76c591b0 KW |
2663 | if (!drv) { |
2664 | error_setg(errp, "Unknown driver: '%s'", drvname); | |
76c591b0 KW |
2665 | goto fail; |
2666 | } | |
2667 | } | |
2668 | ||
2669 | assert(drvname || !(flags & BDRV_O_PROTOCOL)); | |
76c591b0 | 2670 | |
129c7d1c | 2671 | /* See cautionary note on accessing @options above */ |
3e8c2e57 | 2672 | backing = qdict_get_try_str(options, "backing"); |
e59a0cf1 HR |
2673 | if (qobject_to(QNull, qdict_get(options, "backing")) != NULL || |
2674 | (backing && *backing == '\0')) | |
2675 | { | |
4f7be280 HR |
2676 | if (backing) { |
2677 | warn_report("Use of \"backing\": \"\" is deprecated; " | |
2678 | "use \"backing\": null instead"); | |
2679 | } | |
3e8c2e57 AG |
2680 | flags |= BDRV_O_NO_BACKING; |
2681 | qdict_del(options, "backing"); | |
2682 | } | |
2683 | ||
5696c6e3 | 2684 | /* Open image file without format layer. This BlockBackend is only used for |
4e4bf5c4 KW |
2685 | * probing, the block drivers will do their own bdrv_open_child() for the |
2686 | * same BDS, which is why we put the node name back into options. */ | |
f4788adc | 2687 | if ((flags & BDRV_O_PROTOCOL) == 0) { |
5696c6e3 KW |
2688 | BlockDriverState *file_bs; |
2689 | ||
2690 | file_bs = bdrv_open_child_bs(filename, options, "file", bs, | |
2691 | &child_file, true, &local_err); | |
1fdd6933 | 2692 | if (local_err) { |
f4788adc KW |
2693 | goto fail; |
2694 | } | |
5696c6e3 | 2695 | if (file_bs != NULL) { |
dacaa162 KW |
2696 | /* Not requesting BLK_PERM_CONSISTENT_READ because we're only |
2697 | * looking at the header to guess the image format. This works even | |
2698 | * in cases where a guest would not see a consistent state. */ | |
2699 | file = blk_new(0, BLK_PERM_ALL); | |
d7086422 | 2700 | blk_insert_bs(file, file_bs, &local_err); |
5696c6e3 | 2701 | bdrv_unref(file_bs); |
d7086422 KW |
2702 | if (local_err) { |
2703 | goto fail; | |
2704 | } | |
5696c6e3 | 2705 | |
46f5ac20 | 2706 | qdict_put_str(options, "file", bdrv_get_node_name(file_bs)); |
4e4bf5c4 | 2707 | } |
f500a6d3 KW |
2708 | } |
2709 | ||
76c591b0 | 2710 | /* Image format probing */ |
38f3ef57 | 2711 | bs->probed = !drv; |
76c591b0 | 2712 | if (!drv && file) { |
cf2ab8fc | 2713 | ret = find_image_format(file, filename, &drv, &local_err); |
17b005f1 | 2714 | if (ret < 0) { |
8bfea15d | 2715 | goto fail; |
2a05cbe4 | 2716 | } |
62392ebb KW |
2717 | /* |
2718 | * This option update would logically belong in bdrv_fill_options(), | |
2719 | * but we first need to open bs->file for the probing to work, while | |
2720 | * opening bs->file already requires the (mostly) final set of options | |
2721 | * so that cache mode etc. can be inherited. | |
2722 | * | |
2723 | * Adding the driver later is somewhat ugly, but it's not an option | |
2724 | * that would ever be inherited, so it's correct. We just need to make | |
2725 | * sure to update both bs->options (which has the full effective | |
2726 | * options for bs) and options (which has file.* already removed). | |
2727 | */ | |
46f5ac20 EB |
2728 | qdict_put_str(bs->options, "driver", drv->format_name); |
2729 | qdict_put_str(options, "driver", drv->format_name); | |
76c591b0 | 2730 | } else if (!drv) { |
17b005f1 | 2731 | error_setg(errp, "Must specify either driver or file"); |
8bfea15d | 2732 | goto fail; |
ea2384d3 | 2733 | } |
b6ce07aa | 2734 | |
53a29513 HR |
2735 | /* BDRV_O_PROTOCOL must be set iff a protocol BDS is about to be created */ |
2736 | assert(!!(flags & BDRV_O_PROTOCOL) == !!drv->bdrv_file_open); | |
2737 | /* file must be NULL if a protocol BDS is about to be created | |
2738 | * (the inverse results in an error message from bdrv_open_common()) */ | |
2739 | assert(!(flags & BDRV_O_PROTOCOL) || !file); | |
2740 | ||
b6ce07aa | 2741 | /* Open the image */ |
82dc8b41 | 2742 | ret = bdrv_open_common(bs, file, options, &local_err); |
b6ce07aa | 2743 | if (ret < 0) { |
8bfea15d | 2744 | goto fail; |
6987307c CH |
2745 | } |
2746 | ||
4e4bf5c4 | 2747 | if (file) { |
5696c6e3 | 2748 | blk_unref(file); |
f500a6d3 KW |
2749 | file = NULL; |
2750 | } | |
2751 | ||
b6ce07aa | 2752 | /* If there is a backing file, use it */ |
9156df12 | 2753 | if ((flags & BDRV_O_NO_BACKING) == 0) { |
d9b7b057 | 2754 | ret = bdrv_open_backing_file(bs, options, "backing", &local_err); |
b6ce07aa | 2755 | if (ret < 0) { |
b6ad491a | 2756 | goto close_and_fail; |
b6ce07aa | 2757 | } |
b6ce07aa KW |
2758 | } |
2759 | ||
91af7014 HR |
2760 | bdrv_refresh_filename(bs); |
2761 | ||
b6ad491a | 2762 | /* Check if any unknown options were used */ |
7ad2757f | 2763 | if (qdict_size(options) != 0) { |
b6ad491a | 2764 | const QDictEntry *entry = qdict_first(options); |
5acd9d81 HR |
2765 | if (flags & BDRV_O_PROTOCOL) { |
2766 | error_setg(errp, "Block protocol '%s' doesn't support the option " | |
2767 | "'%s'", drv->format_name, entry->key); | |
2768 | } else { | |
d0e46a55 HR |
2769 | error_setg(errp, |
2770 | "Block format '%s' does not support the option '%s'", | |
2771 | drv->format_name, entry->key); | |
5acd9d81 | 2772 | } |
b6ad491a | 2773 | |
b6ad491a KW |
2774 | goto close_and_fail; |
2775 | } | |
b6ad491a | 2776 | |
c01c214b | 2777 | bdrv_parent_cb_change_media(bs, true); |
b6ce07aa | 2778 | |
cb3e7f08 | 2779 | qobject_unref(options); |
dd62f1ca KW |
2780 | |
2781 | /* For snapshot=on, create a temporary qcow2 overlay. bs points to the | |
2782 | * temporary snapshot afterwards. */ | |
2783 | if (snapshot_flags) { | |
66836189 HR |
2784 | BlockDriverState *snapshot_bs; |
2785 | snapshot_bs = bdrv_append_temp_snapshot(bs, snapshot_flags, | |
2786 | snapshot_options, &local_err); | |
73176bee | 2787 | snapshot_options = NULL; |
dd62f1ca KW |
2788 | if (local_err) { |
2789 | goto close_and_fail; | |
2790 | } | |
5b363937 HR |
2791 | /* We are not going to return bs but the overlay on top of it |
2792 | * (snapshot_bs); thus, we have to drop the strong reference to bs | |
2793 | * (which we obtained by calling bdrv_new()). bs will not be deleted, | |
2794 | * though, because the overlay still has a reference to it. */ | |
2795 | bdrv_unref(bs); | |
2796 | bs = snapshot_bs; | |
dd62f1ca KW |
2797 | } |
2798 | ||
5b363937 | 2799 | return bs; |
b6ce07aa | 2800 | |
8bfea15d | 2801 | fail: |
5696c6e3 | 2802 | blk_unref(file); |
cb3e7f08 MAL |
2803 | qobject_unref(snapshot_options); |
2804 | qobject_unref(bs->explicit_options); | |
2805 | qobject_unref(bs->options); | |
2806 | qobject_unref(options); | |
de9c0cec | 2807 | bs->options = NULL; |
998cbd6a | 2808 | bs->explicit_options = NULL; |
5b363937 | 2809 | bdrv_unref(bs); |
621ff94d | 2810 | error_propagate(errp, local_err); |
5b363937 | 2811 | return NULL; |
de9c0cec | 2812 | |
b6ad491a | 2813 | close_and_fail: |
5b363937 | 2814 | bdrv_unref(bs); |
cb3e7f08 MAL |
2815 | qobject_unref(snapshot_options); |
2816 | qobject_unref(options); | |
621ff94d | 2817 | error_propagate(errp, local_err); |
5b363937 | 2818 | return NULL; |
b6ce07aa KW |
2819 | } |
2820 | ||
5b363937 HR |
2821 | BlockDriverState *bdrv_open(const char *filename, const char *reference, |
2822 | QDict *options, int flags, Error **errp) | |
f3930ed0 | 2823 | { |
5b363937 | 2824 | return bdrv_open_inherit(filename, reference, options, flags, NULL, |
ce343771 | 2825 | NULL, errp); |
f3930ed0 KW |
2826 | } |
2827 | ||
e971aa12 JC |
2828 | /* |
2829 | * Adds a BlockDriverState to a simple queue for an atomic, transactional | |
2830 | * reopen of multiple devices. | |
2831 | * | |
2832 | * bs_queue can either be an existing BlockReopenQueue that has had QSIMPLE_INIT | |
2833 | * already performed, or alternatively may be NULL a new BlockReopenQueue will | |
2834 | * be created and initialized. This newly created BlockReopenQueue should be | |
2835 | * passed back in for subsequent calls that are intended to be of the same | |
2836 | * atomic 'set'. | |
2837 | * | |
2838 | * bs is the BlockDriverState to add to the reopen queue. | |
2839 | * | |
4d2cb092 KW |
2840 | * options contains the changed options for the associated bs |
2841 | * (the BlockReopenQueue takes ownership) | |
2842 | * | |
e971aa12 JC |
2843 | * flags contains the open flags for the associated bs |
2844 | * | |
2845 | * returns a pointer to bs_queue, which is either the newly allocated | |
2846 | * bs_queue, or the existing bs_queue being used. | |
2847 | * | |
1a63a907 | 2848 | * bs must be drained between bdrv_reopen_queue() and bdrv_reopen_multiple(). |
e971aa12 | 2849 | */ |
28518102 KW |
2850 | static BlockReopenQueue *bdrv_reopen_queue_child(BlockReopenQueue *bs_queue, |
2851 | BlockDriverState *bs, | |
2852 | QDict *options, | |
2853 | int flags, | |
2854 | const BdrvChildRole *role, | |
2855 | QDict *parent_options, | |
2856 | int parent_flags) | |
e971aa12 JC |
2857 | { |
2858 | assert(bs != NULL); | |
2859 | ||
2860 | BlockReopenQueueEntry *bs_entry; | |
67251a31 | 2861 | BdrvChild *child; |
145f598e | 2862 | QDict *old_options, *explicit_options; |
67251a31 | 2863 | |
1a63a907 KW |
2864 | /* Make sure that the caller remembered to use a drained section. This is |
2865 | * important to avoid graph changes between the recursive queuing here and | |
2866 | * bdrv_reopen_multiple(). */ | |
2867 | assert(bs->quiesce_counter > 0); | |
2868 | ||
e971aa12 JC |
2869 | if (bs_queue == NULL) { |
2870 | bs_queue = g_new0(BlockReopenQueue, 1); | |
2871 | QSIMPLEQ_INIT(bs_queue); | |
2872 | } | |
2873 | ||
4d2cb092 KW |
2874 | if (!options) { |
2875 | options = qdict_new(); | |
2876 | } | |
2877 | ||
5b7ba05f AG |
2878 | /* Check if this BlockDriverState is already in the queue */ |
2879 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { | |
2880 | if (bs == bs_entry->state.bs) { | |
2881 | break; | |
2882 | } | |
2883 | } | |
2884 | ||
28518102 KW |
2885 | /* |
2886 | * Precedence of options: | |
2887 | * 1. Explicitly passed in options (highest) | |
91a097e7 | 2888 | * 2. Set in flags (only for top level) |
145f598e | 2889 | * 3. Retained from explicitly set options of bs |
8e2160e2 | 2890 | * 4. Inherited from parent node |
28518102 KW |
2891 | * 5. Retained from effective options of bs |
2892 | */ | |
2893 | ||
91a097e7 KW |
2894 | if (!parent_options) { |
2895 | /* | |
2896 | * Any setting represented by flags is always updated. If the | |
2897 | * corresponding QDict option is set, it takes precedence. Otherwise | |
2898 | * the flag is translated into a QDict option. The old setting of bs is | |
2899 | * not considered. | |
2900 | */ | |
2901 | update_options_from_flags(options, flags); | |
2902 | } | |
2903 | ||
145f598e | 2904 | /* Old explicitly set values (don't overwrite by inherited value) */ |
5b7ba05f AG |
2905 | if (bs_entry) { |
2906 | old_options = qdict_clone_shallow(bs_entry->state.explicit_options); | |
2907 | } else { | |
2908 | old_options = qdict_clone_shallow(bs->explicit_options); | |
2909 | } | |
145f598e | 2910 | bdrv_join_options(bs, options, old_options); |
cb3e7f08 | 2911 | qobject_unref(old_options); |
145f598e KW |
2912 | |
2913 | explicit_options = qdict_clone_shallow(options); | |
2914 | ||
28518102 KW |
2915 | /* Inherit from parent node */ |
2916 | if (parent_options) { | |
1a529736 FZ |
2917 | QemuOpts *opts; |
2918 | QDict *options_copy; | |
28518102 | 2919 | assert(!flags); |
8e2160e2 | 2920 | role->inherit_options(&flags, options, parent_flags, parent_options); |
1a529736 FZ |
2921 | options_copy = qdict_clone_shallow(options); |
2922 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); | |
2923 | qemu_opts_absorb_qdict(opts, options_copy, NULL); | |
2924 | update_flags_from_options(&flags, opts); | |
2925 | qemu_opts_del(opts); | |
cb3e7f08 | 2926 | qobject_unref(options_copy); |
28518102 KW |
2927 | } |
2928 | ||
2929 | /* Old values are used for options that aren't set yet */ | |
4d2cb092 | 2930 | old_options = qdict_clone_shallow(bs->options); |
cddff5ba | 2931 | bdrv_join_options(bs, options, old_options); |
cb3e7f08 | 2932 | qobject_unref(old_options); |
4d2cb092 | 2933 | |
fd452021 | 2934 | /* bdrv_open_inherit() sets and clears some additional flags internally */ |
f1f25a2e | 2935 | flags &= ~BDRV_O_PROTOCOL; |
fd452021 KW |
2936 | if (flags & BDRV_O_RDWR) { |
2937 | flags |= BDRV_O_ALLOW_RDWR; | |
2938 | } | |
f1f25a2e | 2939 | |
1857c97b KW |
2940 | if (!bs_entry) { |
2941 | bs_entry = g_new0(BlockReopenQueueEntry, 1); | |
2942 | QSIMPLEQ_INSERT_TAIL(bs_queue, bs_entry, entry); | |
2943 | } else { | |
cb3e7f08 MAL |
2944 | qobject_unref(bs_entry->state.options); |
2945 | qobject_unref(bs_entry->state.explicit_options); | |
1857c97b KW |
2946 | } |
2947 | ||
2948 | bs_entry->state.bs = bs; | |
2949 | bs_entry->state.options = options; | |
2950 | bs_entry->state.explicit_options = explicit_options; | |
2951 | bs_entry->state.flags = flags; | |
2952 | ||
30450259 KW |
2953 | /* This needs to be overwritten in bdrv_reopen_prepare() */ |
2954 | bs_entry->state.perm = UINT64_MAX; | |
2955 | bs_entry->state.shared_perm = 0; | |
2956 | ||
67251a31 | 2957 | QLIST_FOREACH(child, &bs->children, next) { |
4c9dfe5d KW |
2958 | QDict *new_child_options; |
2959 | char *child_key_dot; | |
67251a31 | 2960 | |
4c9dfe5d KW |
2961 | /* reopen can only change the options of block devices that were |
2962 | * implicitly created and inherited options. For other (referenced) | |
2963 | * block devices, a syntax like "backing.foo" results in an error. */ | |
67251a31 KW |
2964 | if (child->bs->inherits_from != bs) { |
2965 | continue; | |
2966 | } | |
2967 | ||
4c9dfe5d KW |
2968 | child_key_dot = g_strdup_printf("%s.", child->name); |
2969 | qdict_extract_subqdict(options, &new_child_options, child_key_dot); | |
2970 | g_free(child_key_dot); | |
2971 | ||
28518102 KW |
2972 | bdrv_reopen_queue_child(bs_queue, child->bs, new_child_options, 0, |
2973 | child->role, options, flags); | |
e971aa12 JC |
2974 | } |
2975 | ||
e971aa12 JC |
2976 | return bs_queue; |
2977 | } | |
2978 | ||
28518102 KW |
2979 | BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue, |
2980 | BlockDriverState *bs, | |
2981 | QDict *options, int flags) | |
2982 | { | |
2983 | return bdrv_reopen_queue_child(bs_queue, bs, options, flags, | |
2984 | NULL, NULL, 0); | |
2985 | } | |
2986 | ||
e971aa12 JC |
2987 | /* |
2988 | * Reopen multiple BlockDriverStates atomically & transactionally. | |
2989 | * | |
2990 | * The queue passed in (bs_queue) must have been built up previous | |
2991 | * via bdrv_reopen_queue(). | |
2992 | * | |
2993 | * Reopens all BDS specified in the queue, with the appropriate | |
2994 | * flags. All devices are prepared for reopen, and failure of any | |
2995 | * device will cause all device changes to be abandonded, and intermediate | |
2996 | * data cleaned up. | |
2997 | * | |
2998 | * If all devices prepare successfully, then the changes are committed | |
2999 | * to all devices. | |
3000 | * | |
1a63a907 KW |
3001 | * All affected nodes must be drained between bdrv_reopen_queue() and |
3002 | * bdrv_reopen_multiple(). | |
e971aa12 | 3003 | */ |
720150f3 | 3004 | int bdrv_reopen_multiple(AioContext *ctx, BlockReopenQueue *bs_queue, Error **errp) |
e971aa12 JC |
3005 | { |
3006 | int ret = -1; | |
3007 | BlockReopenQueueEntry *bs_entry, *next; | |
3008 | Error *local_err = NULL; | |
3009 | ||
3010 | assert(bs_queue != NULL); | |
3011 | ||
e971aa12 | 3012 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { |
1a63a907 | 3013 | assert(bs_entry->state.bs->quiesce_counter > 0); |
e971aa12 JC |
3014 | if (bdrv_reopen_prepare(&bs_entry->state, bs_queue, &local_err)) { |
3015 | error_propagate(errp, local_err); | |
3016 | goto cleanup; | |
3017 | } | |
3018 | bs_entry->prepared = true; | |
3019 | } | |
3020 | ||
3021 | /* If we reach this point, we have success and just need to apply the | |
3022 | * changes | |
3023 | */ | |
3024 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { | |
3025 | bdrv_reopen_commit(&bs_entry->state); | |
3026 | } | |
3027 | ||
3028 | ret = 0; | |
3029 | ||
3030 | cleanup: | |
3031 | QSIMPLEQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) { | |
3032 | if (ret && bs_entry->prepared) { | |
3033 | bdrv_reopen_abort(&bs_entry->state); | |
145f598e | 3034 | } else if (ret) { |
cb3e7f08 | 3035 | qobject_unref(bs_entry->state.explicit_options); |
e971aa12 | 3036 | } |
cb3e7f08 | 3037 | qobject_unref(bs_entry->state.options); |
e971aa12 JC |
3038 | g_free(bs_entry); |
3039 | } | |
3040 | g_free(bs_queue); | |
40840e41 | 3041 | |
e971aa12 JC |
3042 | return ret; |
3043 | } | |
3044 | ||
3045 | ||
3046 | /* Reopen a single BlockDriverState with the specified flags. */ | |
3047 | int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp) | |
3048 | { | |
3049 | int ret = -1; | |
3050 | Error *local_err = NULL; | |
1a63a907 | 3051 | BlockReopenQueue *queue; |
e971aa12 | 3052 | |
1a63a907 KW |
3053 | bdrv_subtree_drained_begin(bs); |
3054 | ||
3055 | queue = bdrv_reopen_queue(NULL, bs, NULL, bdrv_flags); | |
720150f3 | 3056 | ret = bdrv_reopen_multiple(bdrv_get_aio_context(bs), queue, &local_err); |
e971aa12 JC |
3057 | if (local_err != NULL) { |
3058 | error_propagate(errp, local_err); | |
3059 | } | |
1a63a907 KW |
3060 | |
3061 | bdrv_subtree_drained_end(bs); | |
3062 | ||
e971aa12 JC |
3063 | return ret; |
3064 | } | |
3065 | ||
30450259 KW |
3066 | static BlockReopenQueueEntry *find_parent_in_reopen_queue(BlockReopenQueue *q, |
3067 | BdrvChild *c) | |
3068 | { | |
3069 | BlockReopenQueueEntry *entry; | |
3070 | ||
3071 | QSIMPLEQ_FOREACH(entry, q, entry) { | |
3072 | BlockDriverState *bs = entry->state.bs; | |
3073 | BdrvChild *child; | |
3074 | ||
3075 | QLIST_FOREACH(child, &bs->children, next) { | |
3076 | if (child == c) { | |
3077 | return entry; | |
3078 | } | |
3079 | } | |
3080 | } | |
3081 | ||
3082 | return NULL; | |
3083 | } | |
3084 | ||
3085 | static void bdrv_reopen_perm(BlockReopenQueue *q, BlockDriverState *bs, | |
3086 | uint64_t *perm, uint64_t *shared) | |
3087 | { | |
3088 | BdrvChild *c; | |
3089 | BlockReopenQueueEntry *parent; | |
3090 | uint64_t cumulative_perms = 0; | |
3091 | uint64_t cumulative_shared_perms = BLK_PERM_ALL; | |
3092 | ||
3093 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
3094 | parent = find_parent_in_reopen_queue(q, c); | |
3095 | if (!parent) { | |
3096 | cumulative_perms |= c->perm; | |
3097 | cumulative_shared_perms &= c->shared_perm; | |
3098 | } else { | |
3099 | uint64_t nperm, nshared; | |
3100 | ||
3101 | bdrv_child_perm(parent->state.bs, bs, c, c->role, q, | |
3102 | parent->state.perm, parent->state.shared_perm, | |
3103 | &nperm, &nshared); | |
3104 | ||
3105 | cumulative_perms |= nperm; | |
3106 | cumulative_shared_perms &= nshared; | |
3107 | } | |
3108 | } | |
3109 | *perm = cumulative_perms; | |
3110 | *shared = cumulative_shared_perms; | |
3111 | } | |
e971aa12 JC |
3112 | |
3113 | /* | |
3114 | * Prepares a BlockDriverState for reopen. All changes are staged in the | |
3115 | * 'opaque' field of the BDRVReopenState, which is used and allocated by | |
3116 | * the block driver layer .bdrv_reopen_prepare() | |
3117 | * | |
3118 | * bs is the BlockDriverState to reopen | |
3119 | * flags are the new open flags | |
3120 | * queue is the reopen queue | |
3121 | * | |
3122 | * Returns 0 on success, non-zero on error. On error errp will be set | |
3123 | * as well. | |
3124 | * | |
3125 | * On failure, bdrv_reopen_abort() will be called to clean up any data. | |
3126 | * It is the responsibility of the caller to then call the abort() or | |
3127 | * commit() for any other BDS that have been left in a prepare() state | |
3128 | * | |
3129 | */ | |
3130 | int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue, | |
3131 | Error **errp) | |
3132 | { | |
3133 | int ret = -1; | |
3134 | Error *local_err = NULL; | |
3135 | BlockDriver *drv; | |
ccf9dc07 KW |
3136 | QemuOpts *opts; |
3137 | const char *value; | |
3d8ce171 | 3138 | bool read_only; |
e971aa12 JC |
3139 | |
3140 | assert(reopen_state != NULL); | |
3141 | assert(reopen_state->bs->drv != NULL); | |
3142 | drv = reopen_state->bs->drv; | |
3143 | ||
ccf9dc07 KW |
3144 | /* Process generic block layer options */ |
3145 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); | |
3146 | qemu_opts_absorb_qdict(opts, reopen_state->options, &local_err); | |
3147 | if (local_err) { | |
3148 | error_propagate(errp, local_err); | |
3149 | ret = -EINVAL; | |
3150 | goto error; | |
3151 | } | |
3152 | ||
91a097e7 KW |
3153 | update_flags_from_options(&reopen_state->flags, opts); |
3154 | ||
ccf9dc07 KW |
3155 | /* node-name and driver must be unchanged. Put them back into the QDict, so |
3156 | * that they are checked at the end of this function. */ | |
3157 | value = qemu_opt_get(opts, "node-name"); | |
3158 | if (value) { | |
46f5ac20 | 3159 | qdict_put_str(reopen_state->options, "node-name", value); |
ccf9dc07 KW |
3160 | } |
3161 | ||
3162 | value = qemu_opt_get(opts, "driver"); | |
3163 | if (value) { | |
46f5ac20 | 3164 | qdict_put_str(reopen_state->options, "driver", value); |
ccf9dc07 KW |
3165 | } |
3166 | ||
3d8ce171 JC |
3167 | /* If we are to stay read-only, do not allow permission change |
3168 | * to r/w. Attempting to set to r/w may fail if either BDRV_O_ALLOW_RDWR is | |
3169 | * not set, or if the BDS still has copy_on_read enabled */ | |
3170 | read_only = !(reopen_state->flags & BDRV_O_RDWR); | |
54a32bfe | 3171 | ret = bdrv_can_set_read_only(reopen_state->bs, read_only, true, &local_err); |
3d8ce171 JC |
3172 | if (local_err) { |
3173 | error_propagate(errp, local_err); | |
e971aa12 JC |
3174 | goto error; |
3175 | } | |
3176 | ||
30450259 KW |
3177 | /* Calculate required permissions after reopening */ |
3178 | bdrv_reopen_perm(queue, reopen_state->bs, | |
3179 | &reopen_state->perm, &reopen_state->shared_perm); | |
e971aa12 JC |
3180 | |
3181 | ret = bdrv_flush(reopen_state->bs); | |
3182 | if (ret) { | |
455b0fde | 3183 | error_setg_errno(errp, -ret, "Error flushing drive"); |
e971aa12 JC |
3184 | goto error; |
3185 | } | |
3186 | ||
3187 | if (drv->bdrv_reopen_prepare) { | |
3188 | ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err); | |
3189 | if (ret) { | |
3190 | if (local_err != NULL) { | |
3191 | error_propagate(errp, local_err); | |
3192 | } else { | |
d8b6895f LC |
3193 | error_setg(errp, "failed while preparing to reopen image '%s'", |
3194 | reopen_state->bs->filename); | |
e971aa12 JC |
3195 | } |
3196 | goto error; | |
3197 | } | |
3198 | } else { | |
3199 | /* It is currently mandatory to have a bdrv_reopen_prepare() | |
3200 | * handler for each supported drv. */ | |
81e5f78a AG |
3201 | error_setg(errp, "Block format '%s' used by node '%s' " |
3202 | "does not support reopening files", drv->format_name, | |
3203 | bdrv_get_device_or_node_name(reopen_state->bs)); | |
e971aa12 JC |
3204 | ret = -1; |
3205 | goto error; | |
3206 | } | |
3207 | ||
4d2cb092 KW |
3208 | /* Options that are not handled are only okay if they are unchanged |
3209 | * compared to the old state. It is expected that some options are only | |
3210 | * used for the initial open, but not reopen (e.g. filename) */ | |
3211 | if (qdict_size(reopen_state->options)) { | |
3212 | const QDictEntry *entry = qdict_first(reopen_state->options); | |
3213 | ||
3214 | do { | |
54fd1b0d HR |
3215 | QObject *new = entry->value; |
3216 | QObject *old = qdict_get(reopen_state->bs->options, entry->key); | |
3217 | ||
129c7d1c | 3218 | /* |
54fd1b0d HR |
3219 | * TODO: When using -drive to specify blockdev options, all values |
3220 | * will be strings; however, when using -blockdev, blockdev-add or | |
3221 | * filenames using the json:{} pseudo-protocol, they will be | |
3222 | * correctly typed. | |
3223 | * In contrast, reopening options are (currently) always strings | |
3224 | * (because you can only specify them through qemu-io; all other | |
3225 | * callers do not specify any options). | |
3226 | * Therefore, when using anything other than -drive to create a BDS, | |
3227 | * this cannot detect non-string options as unchanged, because | |
3228 | * qobject_is_equal() always returns false for objects of different | |
3229 | * type. In the future, this should be remedied by correctly typing | |
3230 | * all options. For now, this is not too big of an issue because | |
3231 | * the user can simply omit options which cannot be changed anyway, | |
3232 | * so they will stay unchanged. | |
129c7d1c | 3233 | */ |
54fd1b0d | 3234 | if (!qobject_is_equal(new, old)) { |
4d2cb092 KW |
3235 | error_setg(errp, "Cannot change the option '%s'", entry->key); |
3236 | ret = -EINVAL; | |
3237 | goto error; | |
3238 | } | |
3239 | } while ((entry = qdict_next(reopen_state->options, entry))); | |
3240 | } | |
3241 | ||
30450259 KW |
3242 | ret = bdrv_check_perm(reopen_state->bs, queue, reopen_state->perm, |
3243 | reopen_state->shared_perm, NULL, errp); | |
3244 | if (ret < 0) { | |
3245 | goto error; | |
3246 | } | |
3247 | ||
e971aa12 JC |
3248 | ret = 0; |
3249 | ||
3250 | error: | |
ccf9dc07 | 3251 | qemu_opts_del(opts); |
e971aa12 JC |
3252 | return ret; |
3253 | } | |
3254 | ||
3255 | /* | |
3256 | * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and | |
3257 | * makes them final by swapping the staging BlockDriverState contents into | |
3258 | * the active BlockDriverState contents. | |
3259 | */ | |
3260 | void bdrv_reopen_commit(BDRVReopenState *reopen_state) | |
3261 | { | |
3262 | BlockDriver *drv; | |
50bf65ba | 3263 | BlockDriverState *bs; |
cb9ff6c2 | 3264 | bool old_can_write, new_can_write; |
e971aa12 JC |
3265 | |
3266 | assert(reopen_state != NULL); | |
50bf65ba VSO |
3267 | bs = reopen_state->bs; |
3268 | drv = bs->drv; | |
e971aa12 JC |
3269 | assert(drv != NULL); |
3270 | ||
cb9ff6c2 VSO |
3271 | old_can_write = |
3272 | !bdrv_is_read_only(bs) && !(bdrv_get_flags(bs) & BDRV_O_INACTIVE); | |
3273 | ||
e971aa12 JC |
3274 | /* If there are any driver level actions to take */ |
3275 | if (drv->bdrv_reopen_commit) { | |
3276 | drv->bdrv_reopen_commit(reopen_state); | |
3277 | } | |
3278 | ||
3279 | /* set BDS specific flags now */ | |
cb3e7f08 | 3280 | qobject_unref(bs->explicit_options); |
145f598e | 3281 | |
50bf65ba VSO |
3282 | bs->explicit_options = reopen_state->explicit_options; |
3283 | bs->open_flags = reopen_state->flags; | |
3284 | bs->read_only = !(reopen_state->flags & BDRV_O_RDWR); | |
355ef4ac | 3285 | |
50bf65ba | 3286 | bdrv_refresh_limits(bs, NULL); |
cb9ff6c2 | 3287 | |
30450259 KW |
3288 | bdrv_set_perm(reopen_state->bs, reopen_state->perm, |
3289 | reopen_state->shared_perm); | |
3290 | ||
cb9ff6c2 VSO |
3291 | new_can_write = |
3292 | !bdrv_is_read_only(bs) && !(bdrv_get_flags(bs) & BDRV_O_INACTIVE); | |
3293 | if (!old_can_write && new_can_write && drv->bdrv_reopen_bitmaps_rw) { | |
3294 | Error *local_err = NULL; | |
3295 | if (drv->bdrv_reopen_bitmaps_rw(bs, &local_err) < 0) { | |
3296 | /* This is not fatal, bitmaps just left read-only, so all following | |
3297 | * writes will fail. User can remove read-only bitmaps to unblock | |
3298 | * writes. | |
3299 | */ | |
3300 | error_reportf_err(local_err, | |
3301 | "%s: Failed to make dirty bitmaps writable: ", | |
3302 | bdrv_get_node_name(bs)); | |
3303 | } | |
3304 | } | |
e971aa12 JC |
3305 | } |
3306 | ||
3307 | /* | |
3308 | * Abort the reopen, and delete and free the staged changes in | |
3309 | * reopen_state | |
3310 | */ | |
3311 | void bdrv_reopen_abort(BDRVReopenState *reopen_state) | |
3312 | { | |
3313 | BlockDriver *drv; | |
3314 | ||
3315 | assert(reopen_state != NULL); | |
3316 | drv = reopen_state->bs->drv; | |
3317 | assert(drv != NULL); | |
3318 | ||
3319 | if (drv->bdrv_reopen_abort) { | |
3320 | drv->bdrv_reopen_abort(reopen_state); | |
3321 | } | |
145f598e | 3322 | |
cb3e7f08 | 3323 | qobject_unref(reopen_state->explicit_options); |
30450259 KW |
3324 | |
3325 | bdrv_abort_perm_update(reopen_state->bs); | |
e971aa12 JC |
3326 | } |
3327 | ||
3328 | ||
64dff520 | 3329 | static void bdrv_close(BlockDriverState *bs) |
fc01f7e7 | 3330 | { |
33384421 | 3331 | BdrvAioNotifier *ban, *ban_next; |
50a3efb0 | 3332 | BdrvChild *child, *next; |
33384421 | 3333 | |
ca9bd24c | 3334 | assert(!bs->job); |
30f55fb8 | 3335 | assert(!bs->refcnt); |
99b7e775 | 3336 | |
fc27291d | 3337 | bdrv_drained_begin(bs); /* complete I/O */ |
58fda173 | 3338 | bdrv_flush(bs); |
53ec73e2 | 3339 | bdrv_drain(bs); /* in case flush left pending I/O */ |
fc27291d | 3340 | |
3cbc002c | 3341 | if (bs->drv) { |
9a7dedbc | 3342 | bs->drv->bdrv_close(bs); |
9a4f4c31 | 3343 | bs->drv = NULL; |
50a3efb0 | 3344 | } |
9a7dedbc | 3345 | |
50a3efb0 | 3346 | bdrv_set_backing_hd(bs, NULL, &error_abort); |
9a7dedbc | 3347 | |
50a3efb0 AG |
3348 | if (bs->file != NULL) { |
3349 | bdrv_unref_child(bs, bs->file); | |
3350 | bs->file = NULL; | |
3351 | } | |
9a4f4c31 | 3352 | |
50a3efb0 AG |
3353 | QLIST_FOREACH_SAFE(child, &bs->children, next, next) { |
3354 | /* TODO Remove bdrv_unref() from drivers' close function and use | |
3355 | * bdrv_unref_child() here */ | |
3356 | if (child->bs->inherits_from == bs) { | |
3357 | child->bs->inherits_from = NULL; | |
6e93e7c4 | 3358 | } |
50a3efb0 | 3359 | bdrv_detach_child(child); |
b338082b | 3360 | } |
98f90dba | 3361 | |
50a3efb0 AG |
3362 | g_free(bs->opaque); |
3363 | bs->opaque = NULL; | |
3364 | atomic_set(&bs->copy_on_read, 0); | |
3365 | bs->backing_file[0] = '\0'; | |
3366 | bs->backing_format[0] = '\0'; | |
3367 | bs->total_sectors = 0; | |
3368 | bs->encrypted = false; | |
3369 | bs->sg = false; | |
cb3e7f08 MAL |
3370 | qobject_unref(bs->options); |
3371 | qobject_unref(bs->explicit_options); | |
50a3efb0 AG |
3372 | bs->options = NULL; |
3373 | bs->explicit_options = NULL; | |
cb3e7f08 | 3374 | qobject_unref(bs->full_open_options); |
50a3efb0 AG |
3375 | bs->full_open_options = NULL; |
3376 | ||
cca43ae1 VSO |
3377 | bdrv_release_named_dirty_bitmaps(bs); |
3378 | assert(QLIST_EMPTY(&bs->dirty_bitmaps)); | |
3379 | ||
33384421 HR |
3380 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { |
3381 | g_free(ban); | |
3382 | } | |
3383 | QLIST_INIT(&bs->aio_notifiers); | |
fc27291d | 3384 | bdrv_drained_end(bs); |
b338082b FB |
3385 | } |
3386 | ||
2bc93fed MK |
3387 | void bdrv_close_all(void) |
3388 | { | |
b3b5299d | 3389 | assert(job_next(NULL) == NULL); |
cd7fca95 | 3390 | nbd_export_close_all(); |
ca9bd24c HR |
3391 | |
3392 | /* Drop references from requests still in flight, such as canceled block | |
3393 | * jobs whose AIO context has not been polled yet */ | |
3394 | bdrv_drain_all(); | |
2bc93fed | 3395 | |
ca9bd24c HR |
3396 | blk_remove_all_bs(); |
3397 | blockdev_close_all_bdrv_states(); | |
ed78cda3 | 3398 | |
a1a2af07 | 3399 | assert(QTAILQ_EMPTY(&all_bdrv_states)); |
2bc93fed MK |
3400 | } |
3401 | ||
d0ac0380 KW |
3402 | static bool should_update_child(BdrvChild *c, BlockDriverState *to) |
3403 | { | |
3404 | BdrvChild *to_c; | |
3405 | ||
3406 | if (c->role->stay_at_node) { | |
3407 | return false; | |
3408 | } | |
3409 | ||
3410 | if (c->role == &child_backing) { | |
3411 | /* If @from is a backing file of @to, ignore the child to avoid | |
3412 | * creating a loop. We only want to change the pointer of other | |
3413 | * parents. */ | |
3414 | QLIST_FOREACH(to_c, &to->children, next) { | |
3415 | if (to_c == c) { | |
3416 | break; | |
3417 | } | |
3418 | } | |
3419 | if (to_c) { | |
3420 | return false; | |
3421 | } | |
3422 | } | |
3423 | ||
3424 | return true; | |
3425 | } | |
3426 | ||
5fe31c25 KW |
3427 | void bdrv_replace_node(BlockDriverState *from, BlockDriverState *to, |
3428 | Error **errp) | |
dd62f1ca | 3429 | { |
d0ac0380 | 3430 | BdrvChild *c, *next; |
234ac1a9 KW |
3431 | GSList *list = NULL, *p; |
3432 | uint64_t old_perm, old_shared; | |
3433 | uint64_t perm = 0, shared = BLK_PERM_ALL; | |
3434 | int ret; | |
3435 | ||
5fe31c25 KW |
3436 | assert(!atomic_read(&from->in_flight)); |
3437 | assert(!atomic_read(&to->in_flight)); | |
dd62f1ca | 3438 | |
234ac1a9 KW |
3439 | /* Make sure that @from doesn't go away until we have successfully attached |
3440 | * all of its parents to @to. */ | |
3441 | bdrv_ref(from); | |
dd62f1ca | 3442 | |
234ac1a9 | 3443 | /* Put all parents into @list and calculate their cumulative permissions */ |
dd62f1ca | 3444 | QLIST_FOREACH_SAFE(c, &from->parents, next_parent, next) { |
d0ac0380 | 3445 | if (!should_update_child(c, to)) { |
26de9438 KW |
3446 | continue; |
3447 | } | |
234ac1a9 KW |
3448 | list = g_slist_prepend(list, c); |
3449 | perm |= c->perm; | |
3450 | shared &= c->shared_perm; | |
3451 | } | |
3452 | ||
3453 | /* Check whether the required permissions can be granted on @to, ignoring | |
3454 | * all BdrvChild in @list so that they can't block themselves. */ | |
3121fb45 | 3455 | ret = bdrv_check_update_perm(to, NULL, perm, shared, list, errp); |
234ac1a9 KW |
3456 | if (ret < 0) { |
3457 | bdrv_abort_perm_update(to); | |
3458 | goto out; | |
3459 | } | |
3460 | ||
3461 | /* Now actually perform the change. We performed the permission check for | |
3462 | * all elements of @list at once, so set the permissions all at once at the | |
3463 | * very end. */ | |
3464 | for (p = list; p != NULL; p = p->next) { | |
3465 | c = p->data; | |
9bd910e2 | 3466 | |
dd62f1ca | 3467 | bdrv_ref(to); |
234ac1a9 | 3468 | bdrv_replace_child_noperm(c, to); |
dd62f1ca KW |
3469 | bdrv_unref(from); |
3470 | } | |
234ac1a9 KW |
3471 | |
3472 | bdrv_get_cumulative_perm(to, &old_perm, &old_shared); | |
3473 | bdrv_set_perm(to, old_perm | perm, old_shared | shared); | |
3474 | ||
3475 | out: | |
3476 | g_slist_free(list); | |
3477 | bdrv_unref(from); | |
dd62f1ca KW |
3478 | } |
3479 | ||
4ddc07ca PB |
3480 | /* |
3481 | * Add new bs contents at the top of an image chain while the chain is | |
3482 | * live, while keeping required fields on the top layer. | |
3483 | * | |
3484 | * This will modify the BlockDriverState fields, and swap contents | |
3485 | * between bs_new and bs_top. Both bs_new and bs_top are modified. | |
3486 | * | |
bfb197e0 | 3487 | * bs_new must not be attached to a BlockBackend. |
4ddc07ca PB |
3488 | * |
3489 | * This function does not create any image files. | |
dd62f1ca KW |
3490 | * |
3491 | * bdrv_append() takes ownership of a bs_new reference and unrefs it because | |
3492 | * that's what the callers commonly need. bs_new will be referenced by the old | |
3493 | * parents of bs_top after bdrv_append() returns. If the caller needs to keep a | |
3494 | * reference of its own, it must call bdrv_ref(). | |
4ddc07ca | 3495 | */ |
b2c2832c KW |
3496 | void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top, |
3497 | Error **errp) | |
4ddc07ca | 3498 | { |
b2c2832c KW |
3499 | Error *local_err = NULL; |
3500 | ||
b2c2832c KW |
3501 | bdrv_set_backing_hd(bs_new, bs_top, &local_err); |
3502 | if (local_err) { | |
3503 | error_propagate(errp, local_err); | |
3504 | goto out; | |
3505 | } | |
dd62f1ca | 3506 | |
5fe31c25 | 3507 | bdrv_replace_node(bs_top, bs_new, &local_err); |
234ac1a9 KW |
3508 | if (local_err) { |
3509 | error_propagate(errp, local_err); | |
3510 | bdrv_set_backing_hd(bs_new, NULL, &error_abort); | |
3511 | goto out; | |
3512 | } | |
4ddc07ca | 3513 | |
dd62f1ca KW |
3514 | /* bs_new is now referenced by its new parents, we don't need the |
3515 | * additional reference any more. */ | |
b2c2832c | 3516 | out: |
dd62f1ca | 3517 | bdrv_unref(bs_new); |
8802d1fd JC |
3518 | } |
3519 | ||
4f6fd349 | 3520 | static void bdrv_delete(BlockDriverState *bs) |
b338082b | 3521 | { |
3e914655 | 3522 | assert(!bs->job); |
3718d8ab | 3523 | assert(bdrv_op_blocker_is_empty(bs)); |
4f6fd349 | 3524 | assert(!bs->refcnt); |
18846dee | 3525 | |
e1b5c52e SH |
3526 | bdrv_close(bs); |
3527 | ||
1b7bdbc1 | 3528 | /* remove from list, if necessary */ |
63eaaae0 KW |
3529 | if (bs->node_name[0] != '\0') { |
3530 | QTAILQ_REMOVE(&graph_bdrv_states, bs, node_list); | |
3531 | } | |
2c1d04e0 HR |
3532 | QTAILQ_REMOVE(&all_bdrv_states, bs, bs_list); |
3533 | ||
7267c094 | 3534 | g_free(bs); |
fc01f7e7 FB |
3535 | } |
3536 | ||
e97fc193 AL |
3537 | /* |
3538 | * Run consistency checks on an image | |
3539 | * | |
e076f338 | 3540 | * Returns 0 if the check could be completed (it doesn't mean that the image is |
a1c7273b | 3541 | * free of errors) or -errno when an internal error occurred. The results of the |
e076f338 | 3542 | * check are stored in res. |
e97fc193 | 3543 | */ |
2fd61638 PB |
3544 | static int coroutine_fn bdrv_co_check(BlockDriverState *bs, |
3545 | BdrvCheckResult *res, BdrvCheckMode fix) | |
e97fc193 | 3546 | { |
908bcd54 HR |
3547 | if (bs->drv == NULL) { |
3548 | return -ENOMEDIUM; | |
3549 | } | |
2fd61638 | 3550 | if (bs->drv->bdrv_co_check == NULL) { |
e97fc193 AL |
3551 | return -ENOTSUP; |
3552 | } | |
3553 | ||
e076f338 | 3554 | memset(res, 0, sizeof(*res)); |
2fd61638 PB |
3555 | return bs->drv->bdrv_co_check(bs, res, fix); |
3556 | } | |
3557 | ||
3558 | typedef struct CheckCo { | |
3559 | BlockDriverState *bs; | |
3560 | BdrvCheckResult *res; | |
3561 | BdrvCheckMode fix; | |
3562 | int ret; | |
3563 | } CheckCo; | |
3564 | ||
3565 | static void bdrv_check_co_entry(void *opaque) | |
3566 | { | |
3567 | CheckCo *cco = opaque; | |
3568 | cco->ret = bdrv_co_check(cco->bs, cco->res, cco->fix); | |
3569 | } | |
3570 | ||
3571 | int bdrv_check(BlockDriverState *bs, | |
3572 | BdrvCheckResult *res, BdrvCheckMode fix) | |
3573 | { | |
3574 | Coroutine *co; | |
3575 | CheckCo cco = { | |
3576 | .bs = bs, | |
3577 | .res = res, | |
3578 | .ret = -EINPROGRESS, | |
3579 | .fix = fix, | |
3580 | }; | |
3581 | ||
3582 | if (qemu_in_coroutine()) { | |
3583 | /* Fast-path if already in coroutine context */ | |
3584 | bdrv_check_co_entry(&cco); | |
3585 | } else { | |
3586 | co = qemu_coroutine_create(bdrv_check_co_entry, &cco); | |
3587 | qemu_coroutine_enter(co); | |
3588 | BDRV_POLL_WHILE(bs, cco.ret == -EINPROGRESS); | |
3589 | } | |
3590 | ||
3591 | return cco.ret; | |
e97fc193 AL |
3592 | } |
3593 | ||
756e6736 KW |
3594 | /* |
3595 | * Return values: | |
3596 | * 0 - success | |
3597 | * -EINVAL - backing format specified, but no file | |
3598 | * -ENOSPC - can't update the backing file because no space is left in the | |
3599 | * image file header | |
3600 | * -ENOTSUP - format driver doesn't support changing the backing file | |
3601 | */ | |
3602 | int bdrv_change_backing_file(BlockDriverState *bs, | |
3603 | const char *backing_file, const char *backing_fmt) | |
3604 | { | |
3605 | BlockDriver *drv = bs->drv; | |
469ef350 | 3606 | int ret; |
756e6736 | 3607 | |
d470ad42 HR |
3608 | if (!drv) { |
3609 | return -ENOMEDIUM; | |
3610 | } | |
3611 | ||
5f377794 PB |
3612 | /* Backing file format doesn't make sense without a backing file */ |
3613 | if (backing_fmt && !backing_file) { | |
3614 | return -EINVAL; | |
3615 | } | |
3616 | ||
756e6736 | 3617 | if (drv->bdrv_change_backing_file != NULL) { |
469ef350 | 3618 | ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt); |
756e6736 | 3619 | } else { |
469ef350 | 3620 | ret = -ENOTSUP; |
756e6736 | 3621 | } |
469ef350 PB |
3622 | |
3623 | if (ret == 0) { | |
3624 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: ""); | |
3625 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: ""); | |
3626 | } | |
3627 | return ret; | |
756e6736 KW |
3628 | } |
3629 | ||
6ebdcee2 JC |
3630 | /* |
3631 | * Finds the image layer in the chain that has 'bs' as its backing file. | |
3632 | * | |
3633 | * active is the current topmost image. | |
3634 | * | |
3635 | * Returns NULL if bs is not found in active's image chain, | |
3636 | * or if active == bs. | |
4caf0fcd JC |
3637 | * |
3638 | * Returns the bottommost base image if bs == NULL. | |
6ebdcee2 JC |
3639 | */ |
3640 | BlockDriverState *bdrv_find_overlay(BlockDriverState *active, | |
3641 | BlockDriverState *bs) | |
3642 | { | |
760e0063 KW |
3643 | while (active && bs != backing_bs(active)) { |
3644 | active = backing_bs(active); | |
6ebdcee2 JC |
3645 | } |
3646 | ||
4caf0fcd JC |
3647 | return active; |
3648 | } | |
6ebdcee2 | 3649 | |
4caf0fcd JC |
3650 | /* Given a BDS, searches for the base layer. */ |
3651 | BlockDriverState *bdrv_find_base(BlockDriverState *bs) | |
3652 | { | |
3653 | return bdrv_find_overlay(bs, NULL); | |
6ebdcee2 JC |
3654 | } |
3655 | ||
6ebdcee2 JC |
3656 | /* |
3657 | * Drops images above 'base' up to and including 'top', and sets the image | |
3658 | * above 'top' to have base as its backing file. | |
3659 | * | |
3660 | * Requires that the overlay to 'top' is opened r/w, so that the backing file | |
3661 | * information in 'bs' can be properly updated. | |
3662 | * | |
3663 | * E.g., this will convert the following chain: | |
3664 | * bottom <- base <- intermediate <- top <- active | |
3665 | * | |
3666 | * to | |
3667 | * | |
3668 | * bottom <- base <- active | |
3669 | * | |
3670 | * It is allowed for bottom==base, in which case it converts: | |
3671 | * | |
3672 | * base <- intermediate <- top <- active | |
3673 | * | |
3674 | * to | |
3675 | * | |
3676 | * base <- active | |
3677 | * | |
54e26900 JC |
3678 | * If backing_file_str is non-NULL, it will be used when modifying top's |
3679 | * overlay image metadata. | |
3680 | * | |
6ebdcee2 JC |
3681 | * Error conditions: |
3682 | * if active == top, that is considered an error | |
3683 | * | |
3684 | */ | |
bde70715 KW |
3685 | int bdrv_drop_intermediate(BlockDriverState *top, BlockDriverState *base, |
3686 | const char *backing_file_str) | |
6ebdcee2 | 3687 | { |
61f09cea | 3688 | BdrvChild *c, *next; |
12fa4af6 | 3689 | Error *local_err = NULL; |
6ebdcee2 JC |
3690 | int ret = -EIO; |
3691 | ||
6858eba0 KW |
3692 | bdrv_ref(top); |
3693 | ||
6ebdcee2 JC |
3694 | if (!top->drv || !base->drv) { |
3695 | goto exit; | |
3696 | } | |
3697 | ||
5db15a57 KW |
3698 | /* Make sure that base is in the backing chain of top */ |
3699 | if (!bdrv_chain_contains(top, base)) { | |
6ebdcee2 JC |
3700 | goto exit; |
3701 | } | |
3702 | ||
3703 | /* success - we can delete the intermediate states, and link top->base */ | |
bde70715 KW |
3704 | /* TODO Check graph modification op blockers (BLK_PERM_GRAPH_MOD) once |
3705 | * we've figured out how they should work. */ | |
61f09cea KW |
3706 | backing_file_str = backing_file_str ? backing_file_str : base->filename; |
3707 | ||
3708 | QLIST_FOREACH_SAFE(c, &top->parents, next_parent, next) { | |
3709 | /* Check whether we are allowed to switch c from top to base */ | |
3710 | GSList *ignore_children = g_slist_prepend(NULL, c); | |
3711 | bdrv_check_update_perm(base, NULL, c->perm, c->shared_perm, | |
3712 | ignore_children, &local_err); | |
2c860e79 | 3713 | g_slist_free(ignore_children); |
61f09cea KW |
3714 | if (local_err) { |
3715 | ret = -EPERM; | |
3716 | error_report_err(local_err); | |
6858eba0 KW |
3717 | goto exit; |
3718 | } | |
12fa4af6 | 3719 | |
61f09cea KW |
3720 | /* If so, update the backing file path in the image file */ |
3721 | if (c->role->update_filename) { | |
3722 | ret = c->role->update_filename(c, base, backing_file_str, | |
3723 | &local_err); | |
3724 | if (ret < 0) { | |
3725 | bdrv_abort_perm_update(base); | |
3726 | error_report_err(local_err); | |
3727 | goto exit; | |
3728 | } | |
3729 | } | |
3730 | ||
3731 | /* Do the actual switch in the in-memory graph. | |
3732 | * Completes bdrv_check_update_perm() transaction internally. */ | |
3733 | bdrv_ref(base); | |
3734 | bdrv_replace_child(c, base); | |
3735 | bdrv_unref(top); | |
12fa4af6 | 3736 | } |
6ebdcee2 | 3737 | |
6ebdcee2 | 3738 | ret = 0; |
6ebdcee2 | 3739 | exit: |
6858eba0 | 3740 | bdrv_unref(top); |
6ebdcee2 JC |
3741 | return ret; |
3742 | } | |
3743 | ||
61007b31 SH |
3744 | /** |
3745 | * Truncate file to 'offset' bytes (needed only for file protocols) | |
3746 | */ | |
7ea37c30 HR |
3747 | int bdrv_truncate(BdrvChild *child, int64_t offset, PreallocMode prealloc, |
3748 | Error **errp) | |
71d0770c | 3749 | { |
52cdbc58 | 3750 | BlockDriverState *bs = child->bs; |
61007b31 SH |
3751 | BlockDriver *drv = bs->drv; |
3752 | int ret; | |
c8f6d58e | 3753 | |
362b3786 | 3754 | assert(child->perm & BLK_PERM_RESIZE); |
c8f6d58e | 3755 | |
5a612c00 | 3756 | /* if bs->drv == NULL, bs is closed, so there's nothing to do here */ |
ed3d2ec9 HR |
3757 | if (!drv) { |
3758 | error_setg(errp, "No medium inserted"); | |
71d0770c | 3759 | return -ENOMEDIUM; |
ed3d2ec9 | 3760 | } |
cd8b7aaa KW |
3761 | if (offset < 0) { |
3762 | error_setg(errp, "Image size cannot be negative"); | |
3763 | return -EINVAL; | |
3764 | } | |
3765 | ||
ed3d2ec9 | 3766 | if (!drv->bdrv_truncate) { |
5a612c00 MP |
3767 | if (bs->file && drv->is_filter) { |
3768 | return bdrv_truncate(bs->file, offset, prealloc, errp); | |
3769 | } | |
ed3d2ec9 | 3770 | error_setg(errp, "Image format driver does not support resize"); |
61007b31 | 3771 | return -ENOTSUP; |
ed3d2ec9 HR |
3772 | } |
3773 | if (bs->read_only) { | |
3774 | error_setg(errp, "Image is read-only"); | |
61007b31 | 3775 | return -EACCES; |
ed3d2ec9 | 3776 | } |
71d0770c | 3777 | |
504c205a DL |
3778 | assert(!(bs->open_flags & BDRV_O_INACTIVE)); |
3779 | ||
7ea37c30 | 3780 | ret = drv->bdrv_truncate(bs, offset, prealloc, errp); |
1b6cc579 EB |
3781 | if (ret < 0) { |
3782 | return ret; | |
3783 | } | |
3784 | ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS); | |
3785 | if (ret < 0) { | |
3786 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); | |
3787 | } else { | |
3788 | offset = bs->total_sectors * BDRV_SECTOR_SIZE; | |
c0191e76 | 3789 | } |
1b6cc579 EB |
3790 | bdrv_dirty_bitmap_truncate(bs, offset); |
3791 | bdrv_parent_cb_resize(bs); | |
3792 | atomic_inc(&bs->write_gen); | |
61007b31 | 3793 | return ret; |
71d0770c AL |
3794 | } |
3795 | ||
61007b31 SH |
3796 | /** |
3797 | * Length of a allocated file in bytes. Sparse files are counted by actual | |
3798 | * allocated space. Return < 0 if error or unknown. | |
3799 | */ | |
3800 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs) | |
71d0770c | 3801 | { |
61007b31 SH |
3802 | BlockDriver *drv = bs->drv; |
3803 | if (!drv) { | |
3804 | return -ENOMEDIUM; | |
8f4754ed | 3805 | } |
61007b31 SH |
3806 | if (drv->bdrv_get_allocated_file_size) { |
3807 | return drv->bdrv_get_allocated_file_size(bs); | |
3808 | } | |
3809 | if (bs->file) { | |
9a4f4c31 | 3810 | return bdrv_get_allocated_file_size(bs->file->bs); |
1c9805a3 | 3811 | } |
61007b31 | 3812 | return -ENOTSUP; |
1c9805a3 | 3813 | } |
e7a8a783 | 3814 | |
90880ff1 SH |
3815 | /* |
3816 | * bdrv_measure: | |
3817 | * @drv: Format driver | |
3818 | * @opts: Creation options for new image | |
3819 | * @in_bs: Existing image containing data for new image (may be NULL) | |
3820 | * @errp: Error object | |
3821 | * Returns: A #BlockMeasureInfo (free using qapi_free_BlockMeasureInfo()) | |
3822 | * or NULL on error | |
3823 | * | |
3824 | * Calculate file size required to create a new image. | |
3825 | * | |
3826 | * If @in_bs is given then space for allocated clusters and zero clusters | |
3827 | * from that image are included in the calculation. If @opts contains a | |
3828 | * backing file that is shared by @in_bs then backing clusters may be omitted | |
3829 | * from the calculation. | |
3830 | * | |
3831 | * If @in_bs is NULL then the calculation includes no allocated clusters | |
3832 | * unless a preallocation option is given in @opts. | |
3833 | * | |
3834 | * Note that @in_bs may use a different BlockDriver from @drv. | |
3835 | * | |
3836 | * If an error occurs the @errp pointer is set. | |
3837 | */ | |
3838 | BlockMeasureInfo *bdrv_measure(BlockDriver *drv, QemuOpts *opts, | |
3839 | BlockDriverState *in_bs, Error **errp) | |
3840 | { | |
3841 | if (!drv->bdrv_measure) { | |
3842 | error_setg(errp, "Block driver '%s' does not support size measurement", | |
3843 | drv->format_name); | |
3844 | return NULL; | |
3845 | } | |
3846 | ||
3847 | return drv->bdrv_measure(opts, in_bs, errp); | |
3848 | } | |
3849 | ||
61007b31 SH |
3850 | /** |
3851 | * Return number of sectors on success, -errno on error. | |
1c9805a3 | 3852 | */ |
61007b31 | 3853 | int64_t bdrv_nb_sectors(BlockDriverState *bs) |
1c9805a3 | 3854 | { |
61007b31 | 3855 | BlockDriver *drv = bs->drv; |
498e386c | 3856 | |
61007b31 SH |
3857 | if (!drv) |
3858 | return -ENOMEDIUM; | |
2572b37a | 3859 | |
61007b31 SH |
3860 | if (drv->has_variable_length) { |
3861 | int ret = refresh_total_sectors(bs, bs->total_sectors); | |
3862 | if (ret < 0) { | |
3863 | return ret; | |
1c9805a3 SH |
3864 | } |
3865 | } | |
61007b31 | 3866 | return bs->total_sectors; |
1c9805a3 | 3867 | } |
b338082b | 3868 | |
61007b31 SH |
3869 | /** |
3870 | * Return length in bytes on success, -errno on error. | |
3871 | * The length is always a multiple of BDRV_SECTOR_SIZE. | |
8d3b1a2d | 3872 | */ |
61007b31 | 3873 | int64_t bdrv_getlength(BlockDriverState *bs) |
8d3b1a2d | 3874 | { |
61007b31 | 3875 | int64_t ret = bdrv_nb_sectors(bs); |
8d3b1a2d | 3876 | |
4a9c9ea0 | 3877 | ret = ret > INT64_MAX / BDRV_SECTOR_SIZE ? -EFBIG : ret; |
61007b31 | 3878 | return ret < 0 ? ret : ret * BDRV_SECTOR_SIZE; |
fc01f7e7 FB |
3879 | } |
3880 | ||
61007b31 SH |
3881 | /* return 0 as number of sectors if no device present or error */ |
3882 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr) | |
07d27a44 | 3883 | { |
61007b31 | 3884 | int64_t nb_sectors = bdrv_nb_sectors(bs); |
07d27a44 | 3885 | |
61007b31 | 3886 | *nb_sectors_ptr = nb_sectors < 0 ? 0 : nb_sectors; |
07d27a44 MA |
3887 | } |
3888 | ||
54115412 | 3889 | bool bdrv_is_sg(BlockDriverState *bs) |
f08145fe | 3890 | { |
61007b31 | 3891 | return bs->sg; |
f08145fe KW |
3892 | } |
3893 | ||
54115412 | 3894 | bool bdrv_is_encrypted(BlockDriverState *bs) |
fc3959e4 | 3895 | { |
760e0063 | 3896 | if (bs->backing && bs->backing->bs->encrypted) { |
54115412 | 3897 | return true; |
760e0063 | 3898 | } |
61007b31 | 3899 | return bs->encrypted; |
fc3959e4 FZ |
3900 | } |
3901 | ||
61007b31 | 3902 | const char *bdrv_get_format_name(BlockDriverState *bs) |
40b4f539 | 3903 | { |
61007b31 | 3904 | return bs->drv ? bs->drv->format_name : NULL; |
40b4f539 KW |
3905 | } |
3906 | ||
61007b31 | 3907 | static int qsort_strcmp(const void *a, const void *b) |
40b4f539 | 3908 | { |
ceff5bd7 | 3909 | return strcmp(*(char *const *)a, *(char *const *)b); |
40b4f539 KW |
3910 | } |
3911 | ||
61007b31 SH |
3912 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
3913 | void *opaque) | |
40b4f539 | 3914 | { |
61007b31 SH |
3915 | BlockDriver *drv; |
3916 | int count = 0; | |
3917 | int i; | |
3918 | const char **formats = NULL; | |
40b4f539 | 3919 | |
61007b31 SH |
3920 | QLIST_FOREACH(drv, &bdrv_drivers, list) { |
3921 | if (drv->format_name) { | |
3922 | bool found = false; | |
3923 | int i = count; | |
3924 | while (formats && i && !found) { | |
3925 | found = !strcmp(formats[--i], drv->format_name); | |
3926 | } | |
e2a305fb | 3927 | |
61007b31 SH |
3928 | if (!found) { |
3929 | formats = g_renew(const char *, formats, count + 1); | |
3930 | formats[count++] = drv->format_name; | |
3931 | } | |
6c5a42ac | 3932 | } |
61007b31 | 3933 | } |
6c5a42ac | 3934 | |
eb0df69f HR |
3935 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); i++) { |
3936 | const char *format_name = block_driver_modules[i].format_name; | |
3937 | ||
3938 | if (format_name) { | |
3939 | bool found = false; | |
3940 | int j = count; | |
3941 | ||
3942 | while (formats && j && !found) { | |
3943 | found = !strcmp(formats[--j], format_name); | |
3944 | } | |
3945 | ||
3946 | if (!found) { | |
3947 | formats = g_renew(const char *, formats, count + 1); | |
3948 | formats[count++] = format_name; | |
3949 | } | |
3950 | } | |
3951 | } | |
3952 | ||
61007b31 | 3953 | qsort(formats, count, sizeof(formats[0]), qsort_strcmp); |
40b4f539 | 3954 | |
61007b31 SH |
3955 | for (i = 0; i < count; i++) { |
3956 | it(opaque, formats[i]); | |
3957 | } | |
40b4f539 | 3958 | |
61007b31 SH |
3959 | g_free(formats); |
3960 | } | |
40b4f539 | 3961 | |
61007b31 SH |
3962 | /* This function is to find a node in the bs graph */ |
3963 | BlockDriverState *bdrv_find_node(const char *node_name) | |
3964 | { | |
3965 | BlockDriverState *bs; | |
391827eb | 3966 | |
61007b31 | 3967 | assert(node_name); |
40b4f539 | 3968 | |
61007b31 SH |
3969 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { |
3970 | if (!strcmp(node_name, bs->node_name)) { | |
3971 | return bs; | |
40b4f539 KW |
3972 | } |
3973 | } | |
61007b31 | 3974 | return NULL; |
40b4f539 KW |
3975 | } |
3976 | ||
61007b31 SH |
3977 | /* Put this QMP function here so it can access the static graph_bdrv_states. */ |
3978 | BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp) | |
40b4f539 | 3979 | { |
61007b31 SH |
3980 | BlockDeviceInfoList *list, *entry; |
3981 | BlockDriverState *bs; | |
40b4f539 | 3982 | |
61007b31 SH |
3983 | list = NULL; |
3984 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { | |
c83f9fba | 3985 | BlockDeviceInfo *info = bdrv_block_device_info(NULL, bs, errp); |
61007b31 SH |
3986 | if (!info) { |
3987 | qapi_free_BlockDeviceInfoList(list); | |
3988 | return NULL; | |
301db7c2 | 3989 | } |
61007b31 SH |
3990 | entry = g_malloc0(sizeof(*entry)); |
3991 | entry->value = info; | |
3992 | entry->next = list; | |
3993 | list = entry; | |
301db7c2 RH |
3994 | } |
3995 | ||
61007b31 SH |
3996 | return list; |
3997 | } | |
40b4f539 | 3998 | |
61007b31 SH |
3999 | BlockDriverState *bdrv_lookup_bs(const char *device, |
4000 | const char *node_name, | |
4001 | Error **errp) | |
4002 | { | |
4003 | BlockBackend *blk; | |
4004 | BlockDriverState *bs; | |
40b4f539 | 4005 | |
61007b31 SH |
4006 | if (device) { |
4007 | blk = blk_by_name(device); | |
40b4f539 | 4008 | |
61007b31 | 4009 | if (blk) { |
9f4ed6fb AG |
4010 | bs = blk_bs(blk); |
4011 | if (!bs) { | |
5433c24f | 4012 | error_setg(errp, "Device '%s' has no medium", device); |
5433c24f HR |
4013 | } |
4014 | ||
9f4ed6fb | 4015 | return bs; |
61007b31 SH |
4016 | } |
4017 | } | |
40b4f539 | 4018 | |
61007b31 SH |
4019 | if (node_name) { |
4020 | bs = bdrv_find_node(node_name); | |
6d519a5f | 4021 | |
61007b31 SH |
4022 | if (bs) { |
4023 | return bs; | |
4024 | } | |
40b4f539 KW |
4025 | } |
4026 | ||
61007b31 SH |
4027 | error_setg(errp, "Cannot find device=%s nor node_name=%s", |
4028 | device ? device : "", | |
4029 | node_name ? node_name : ""); | |
4030 | return NULL; | |
40b4f539 KW |
4031 | } |
4032 | ||
61007b31 SH |
4033 | /* If 'base' is in the same chain as 'top', return true. Otherwise, |
4034 | * return false. If either argument is NULL, return false. */ | |
4035 | bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base) | |
83f64091 | 4036 | { |
61007b31 | 4037 | while (top && top != base) { |
760e0063 | 4038 | top = backing_bs(top); |
02c50efe | 4039 | } |
61007b31 SH |
4040 | |
4041 | return top != NULL; | |
02c50efe FZ |
4042 | } |
4043 | ||
61007b31 | 4044 | BlockDriverState *bdrv_next_node(BlockDriverState *bs) |
02c50efe | 4045 | { |
61007b31 SH |
4046 | if (!bs) { |
4047 | return QTAILQ_FIRST(&graph_bdrv_states); | |
02c50efe | 4048 | } |
61007b31 | 4049 | return QTAILQ_NEXT(bs, node_list); |
83f64091 FB |
4050 | } |
4051 | ||
61007b31 | 4052 | const char *bdrv_get_node_name(const BlockDriverState *bs) |
83f64091 | 4053 | { |
61007b31 | 4054 | return bs->node_name; |
beac80cd FB |
4055 | } |
4056 | ||
1f0c461b | 4057 | const char *bdrv_get_parent_name(const BlockDriverState *bs) |
4c265bf9 KW |
4058 | { |
4059 | BdrvChild *c; | |
4060 | const char *name; | |
4061 | ||
4062 | /* If multiple parents have a name, just pick the first one. */ | |
4063 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
4064 | if (c->role->get_name) { | |
4065 | name = c->role->get_name(c); | |
4066 | if (name && *name) { | |
4067 | return name; | |
4068 | } | |
4069 | } | |
4070 | } | |
4071 | ||
4072 | return NULL; | |
4073 | } | |
4074 | ||
61007b31 SH |
4075 | /* TODO check what callers really want: bs->node_name or blk_name() */ |
4076 | const char *bdrv_get_device_name(const BlockDriverState *bs) | |
beac80cd | 4077 | { |
4c265bf9 | 4078 | return bdrv_get_parent_name(bs) ?: ""; |
f141eafe | 4079 | } |
83f64091 | 4080 | |
61007b31 SH |
4081 | /* This can be used to identify nodes that might not have a device |
4082 | * name associated. Since node and device names live in the same | |
4083 | * namespace, the result is unambiguous. The exception is if both are | |
4084 | * absent, then this returns an empty (non-null) string. */ | |
4085 | const char *bdrv_get_device_or_node_name(const BlockDriverState *bs) | |
f141eafe | 4086 | { |
4c265bf9 | 4087 | return bdrv_get_parent_name(bs) ?: bs->node_name; |
beac80cd | 4088 | } |
beac80cd | 4089 | |
61007b31 | 4090 | int bdrv_get_flags(BlockDriverState *bs) |
0b5a2445 | 4091 | { |
61007b31 | 4092 | return bs->open_flags; |
0b5a2445 PB |
4093 | } |
4094 | ||
61007b31 | 4095 | int bdrv_has_zero_init_1(BlockDriverState *bs) |
68485420 | 4096 | { |
61007b31 | 4097 | return 1; |
0b5a2445 PB |
4098 | } |
4099 | ||
61007b31 | 4100 | int bdrv_has_zero_init(BlockDriverState *bs) |
0b5a2445 | 4101 | { |
d470ad42 HR |
4102 | if (!bs->drv) { |
4103 | return 0; | |
4104 | } | |
0b5a2445 | 4105 | |
61007b31 SH |
4106 | /* If BS is a copy on write image, it is initialized to |
4107 | the contents of the base image, which may not be zeroes. */ | |
760e0063 | 4108 | if (bs->backing) { |
61007b31 SH |
4109 | return 0; |
4110 | } | |
4111 | if (bs->drv->bdrv_has_zero_init) { | |
4112 | return bs->drv->bdrv_has_zero_init(bs); | |
0b5a2445 | 4113 | } |
5a612c00 MP |
4114 | if (bs->file && bs->drv->is_filter) { |
4115 | return bdrv_has_zero_init(bs->file->bs); | |
4116 | } | |
61007b31 SH |
4117 | |
4118 | /* safe default */ | |
4119 | return 0; | |
68485420 KW |
4120 | } |
4121 | ||
61007b31 | 4122 | bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs) |
b2a61371 | 4123 | { |
61007b31 | 4124 | BlockDriverInfo bdi; |
b2a61371 | 4125 | |
760e0063 | 4126 | if (bs->backing) { |
61007b31 SH |
4127 | return false; |
4128 | } | |
4129 | ||
4130 | if (bdrv_get_info(bs, &bdi) == 0) { | |
4131 | return bdi.unallocated_blocks_are_zero; | |
b2a61371 SH |
4132 | } |
4133 | ||
61007b31 | 4134 | return false; |
b2a61371 SH |
4135 | } |
4136 | ||
61007b31 | 4137 | bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs) |
68485420 | 4138 | { |
2f0342ef | 4139 | if (!(bs->open_flags & BDRV_O_UNMAP)) { |
61007b31 SH |
4140 | return false; |
4141 | } | |
68485420 | 4142 | |
e24d813b | 4143 | return bs->supported_zero_flags & BDRV_REQ_MAY_UNMAP; |
68485420 KW |
4144 | } |
4145 | ||
61007b31 | 4146 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs) |
b2e12bc6 | 4147 | { |
760e0063 | 4148 | if (bs->backing && bs->backing->bs->encrypted) |
61007b31 SH |
4149 | return bs->backing_file; |
4150 | else if (bs->encrypted) | |
4151 | return bs->filename; | |
4152 | else | |
4153 | return NULL; | |
b2e12bc6 CH |
4154 | } |
4155 | ||
61007b31 SH |
4156 | void bdrv_get_backing_filename(BlockDriverState *bs, |
4157 | char *filename, int filename_size) | |
016f5cf6 | 4158 | { |
61007b31 SH |
4159 | pstrcpy(filename, filename_size, bs->backing_file); |
4160 | } | |
d318aea9 | 4161 | |
61007b31 SH |
4162 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi) |
4163 | { | |
4164 | BlockDriver *drv = bs->drv; | |
5a612c00 MP |
4165 | /* if bs->drv == NULL, bs is closed, so there's nothing to do here */ |
4166 | if (!drv) { | |
61007b31 | 4167 | return -ENOMEDIUM; |
5a612c00 MP |
4168 | } |
4169 | if (!drv->bdrv_get_info) { | |
4170 | if (bs->file && drv->is_filter) { | |
4171 | return bdrv_get_info(bs->file->bs, bdi); | |
4172 | } | |
61007b31 | 4173 | return -ENOTSUP; |
5a612c00 | 4174 | } |
61007b31 SH |
4175 | memset(bdi, 0, sizeof(*bdi)); |
4176 | return drv->bdrv_get_info(bs, bdi); | |
4177 | } | |
016f5cf6 | 4178 | |
61007b31 SH |
4179 | ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs) |
4180 | { | |
4181 | BlockDriver *drv = bs->drv; | |
4182 | if (drv && drv->bdrv_get_specific_info) { | |
4183 | return drv->bdrv_get_specific_info(bs); | |
4184 | } | |
4185 | return NULL; | |
016f5cf6 AG |
4186 | } |
4187 | ||
a31939e6 | 4188 | void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event) |
4265d620 | 4189 | { |
61007b31 SH |
4190 | if (!bs || !bs->drv || !bs->drv->bdrv_debug_event) { |
4191 | return; | |
4192 | } | |
4265d620 | 4193 | |
61007b31 | 4194 | bs->drv->bdrv_debug_event(bs, event); |
4265d620 PB |
4195 | } |
4196 | ||
61007b31 SH |
4197 | int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, |
4198 | const char *tag) | |
4265d620 | 4199 | { |
61007b31 | 4200 | while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) { |
9a4f4c31 | 4201 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 4202 | } |
4265d620 | 4203 | |
61007b31 SH |
4204 | if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) { |
4205 | return bs->drv->bdrv_debug_breakpoint(bs, event, tag); | |
4206 | } | |
4265d620 | 4207 | |
61007b31 | 4208 | return -ENOTSUP; |
4265d620 PB |
4209 | } |
4210 | ||
61007b31 | 4211 | int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag) |
ea2384d3 | 4212 | { |
61007b31 | 4213 | while (bs && bs->drv && !bs->drv->bdrv_debug_remove_breakpoint) { |
9a4f4c31 | 4214 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 4215 | } |
ce1a14dc | 4216 | |
61007b31 SH |
4217 | if (bs && bs->drv && bs->drv->bdrv_debug_remove_breakpoint) { |
4218 | return bs->drv->bdrv_debug_remove_breakpoint(bs, tag); | |
4219 | } | |
4220 | ||
4221 | return -ENOTSUP; | |
eb852011 MA |
4222 | } |
4223 | ||
61007b31 | 4224 | int bdrv_debug_resume(BlockDriverState *bs, const char *tag) |
ce1a14dc | 4225 | { |
61007b31 | 4226 | while (bs && (!bs->drv || !bs->drv->bdrv_debug_resume)) { |
9a4f4c31 | 4227 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 4228 | } |
ce1a14dc | 4229 | |
61007b31 SH |
4230 | if (bs && bs->drv && bs->drv->bdrv_debug_resume) { |
4231 | return bs->drv->bdrv_debug_resume(bs, tag); | |
4232 | } | |
ce1a14dc | 4233 | |
61007b31 | 4234 | return -ENOTSUP; |
f197fe2b FZ |
4235 | } |
4236 | ||
61007b31 | 4237 | bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag) |
ce1a14dc | 4238 | { |
61007b31 | 4239 | while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) { |
9a4f4c31 | 4240 | bs = bs->file ? bs->file->bs : NULL; |
f197fe2b | 4241 | } |
19cb3738 | 4242 | |
61007b31 SH |
4243 | if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) { |
4244 | return bs->drv->bdrv_debug_is_suspended(bs, tag); | |
4245 | } | |
f9f05dc5 | 4246 | |
61007b31 SH |
4247 | return false; |
4248 | } | |
f9f05dc5 | 4249 | |
61007b31 SH |
4250 | /* backing_file can either be relative, or absolute, or a protocol. If it is |
4251 | * relative, it must be relative to the chain. So, passing in bs->filename | |
4252 | * from a BDS as backing_file should not be done, as that may be relative to | |
4253 | * the CWD rather than the chain. */ | |
4254 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, | |
4255 | const char *backing_file) | |
f9f05dc5 | 4256 | { |
61007b31 SH |
4257 | char *filename_full = NULL; |
4258 | char *backing_file_full = NULL; | |
4259 | char *filename_tmp = NULL; | |
4260 | int is_protocol = 0; | |
4261 | BlockDriverState *curr_bs = NULL; | |
4262 | BlockDriverState *retval = NULL; | |
418661e0 | 4263 | Error *local_error = NULL; |
f9f05dc5 | 4264 | |
61007b31 SH |
4265 | if (!bs || !bs->drv || !backing_file) { |
4266 | return NULL; | |
f9f05dc5 KW |
4267 | } |
4268 | ||
61007b31 SH |
4269 | filename_full = g_malloc(PATH_MAX); |
4270 | backing_file_full = g_malloc(PATH_MAX); | |
4271 | filename_tmp = g_malloc(PATH_MAX); | |
f9f05dc5 | 4272 | |
61007b31 | 4273 | is_protocol = path_has_protocol(backing_file); |
f9f05dc5 | 4274 | |
760e0063 | 4275 | for (curr_bs = bs; curr_bs->backing; curr_bs = curr_bs->backing->bs) { |
f9f05dc5 | 4276 | |
61007b31 SH |
4277 | /* If either of the filename paths is actually a protocol, then |
4278 | * compare unmodified paths; otherwise make paths relative */ | |
4279 | if (is_protocol || path_has_protocol(curr_bs->backing_file)) { | |
4280 | if (strcmp(backing_file, curr_bs->backing_file) == 0) { | |
760e0063 | 4281 | retval = curr_bs->backing->bs; |
61007b31 SH |
4282 | break; |
4283 | } | |
418661e0 JC |
4284 | /* Also check against the full backing filename for the image */ |
4285 | bdrv_get_full_backing_filename(curr_bs, backing_file_full, PATH_MAX, | |
4286 | &local_error); | |
4287 | if (local_error == NULL) { | |
4288 | if (strcmp(backing_file, backing_file_full) == 0) { | |
4289 | retval = curr_bs->backing->bs; | |
4290 | break; | |
4291 | } | |
4292 | } else { | |
4293 | error_free(local_error); | |
4294 | local_error = NULL; | |
4295 | } | |
61007b31 SH |
4296 | } else { |
4297 | /* If not an absolute filename path, make it relative to the current | |
4298 | * image's filename path */ | |
4299 | path_combine(filename_tmp, PATH_MAX, curr_bs->filename, | |
4300 | backing_file); | |
f9f05dc5 | 4301 | |
61007b31 SH |
4302 | /* We are going to compare absolute pathnames */ |
4303 | if (!realpath(filename_tmp, filename_full)) { | |
4304 | continue; | |
4305 | } | |
07f07615 | 4306 | |
61007b31 SH |
4307 | /* We need to make sure the backing filename we are comparing against |
4308 | * is relative to the current image filename (or absolute) */ | |
4309 | path_combine(filename_tmp, PATH_MAX, curr_bs->filename, | |
4310 | curr_bs->backing_file); | |
07f07615 | 4311 | |
61007b31 SH |
4312 | if (!realpath(filename_tmp, backing_file_full)) { |
4313 | continue; | |
4314 | } | |
eb489bb1 | 4315 | |
61007b31 | 4316 | if (strcmp(backing_file_full, filename_full) == 0) { |
760e0063 | 4317 | retval = curr_bs->backing->bs; |
61007b31 SH |
4318 | break; |
4319 | } | |
4320 | } | |
eb489bb1 KW |
4321 | } |
4322 | ||
61007b31 SH |
4323 | g_free(filename_full); |
4324 | g_free(backing_file_full); | |
4325 | g_free(filename_tmp); | |
4326 | return retval; | |
4327 | } | |
4328 | ||
61007b31 SH |
4329 | void bdrv_init(void) |
4330 | { | |
4331 | module_call_init(MODULE_INIT_BLOCK); | |
4332 | } | |
29cdb251 | 4333 | |
61007b31 SH |
4334 | void bdrv_init_with_whitelist(void) |
4335 | { | |
4336 | use_bdrv_whitelist = 1; | |
4337 | bdrv_init(); | |
07f07615 PB |
4338 | } |
4339 | ||
2b148f39 PB |
4340 | static void coroutine_fn bdrv_co_invalidate_cache(BlockDriverState *bs, |
4341 | Error **errp) | |
0f15423c | 4342 | { |
4417ab7a | 4343 | BdrvChild *child, *parent; |
9c5e6594 | 4344 | uint64_t perm, shared_perm; |
5a8a30db KW |
4345 | Error *local_err = NULL; |
4346 | int ret; | |
4347 | ||
3456a8d1 KW |
4348 | if (!bs->drv) { |
4349 | return; | |
4350 | } | |
4351 | ||
04c01a5c | 4352 | if (!(bs->open_flags & BDRV_O_INACTIVE)) { |
7ea2d269 AK |
4353 | return; |
4354 | } | |
7ea2d269 | 4355 | |
16e977d5 | 4356 | QLIST_FOREACH(child, &bs->children, next) { |
2b148f39 | 4357 | bdrv_co_invalidate_cache(child->bs, &local_err); |
0d1c5c91 | 4358 | if (local_err) { |
0d1c5c91 FZ |
4359 | error_propagate(errp, local_err); |
4360 | return; | |
4361 | } | |
5a8a30db | 4362 | } |
0d1c5c91 | 4363 | |
dafe0960 KW |
4364 | /* |
4365 | * Update permissions, they may differ for inactive nodes. | |
4366 | * | |
4367 | * Note that the required permissions of inactive images are always a | |
4368 | * subset of the permissions required after activating the image. This | |
4369 | * allows us to just get the permissions upfront without restricting | |
4370 | * drv->bdrv_invalidate_cache(). | |
4371 | * | |
4372 | * It also means that in error cases, we don't have to try and revert to | |
4373 | * the old permissions (which is an operation that could fail, too). We can | |
4374 | * just keep the extended permissions for the next time that an activation | |
4375 | * of the image is tried. | |
4376 | */ | |
16e977d5 | 4377 | bs->open_flags &= ~BDRV_O_INACTIVE; |
dafe0960 KW |
4378 | bdrv_get_cumulative_perm(bs, &perm, &shared_perm); |
4379 | ret = bdrv_check_perm(bs, NULL, perm, shared_perm, NULL, &local_err); | |
4380 | if (ret < 0) { | |
4381 | bs->open_flags |= BDRV_O_INACTIVE; | |
4382 | error_propagate(errp, local_err); | |
4383 | return; | |
4384 | } | |
4385 | bdrv_set_perm(bs, perm, shared_perm); | |
4386 | ||
2b148f39 PB |
4387 | if (bs->drv->bdrv_co_invalidate_cache) { |
4388 | bs->drv->bdrv_co_invalidate_cache(bs, &local_err); | |
0d1c5c91 FZ |
4389 | if (local_err) { |
4390 | bs->open_flags |= BDRV_O_INACTIVE; | |
4391 | error_propagate(errp, local_err); | |
4392 | return; | |
4393 | } | |
0f15423c | 4394 | } |
3456a8d1 | 4395 | |
5a8a30db KW |
4396 | ret = refresh_total_sectors(bs, bs->total_sectors); |
4397 | if (ret < 0) { | |
04c01a5c | 4398 | bs->open_flags |= BDRV_O_INACTIVE; |
5a8a30db KW |
4399 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); |
4400 | return; | |
4401 | } | |
4417ab7a KW |
4402 | |
4403 | QLIST_FOREACH(parent, &bs->parents, next_parent) { | |
4404 | if (parent->role->activate) { | |
4405 | parent->role->activate(parent, &local_err); | |
4406 | if (local_err) { | |
4407 | error_propagate(errp, local_err); | |
4408 | return; | |
4409 | } | |
4410 | } | |
4411 | } | |
0f15423c AL |
4412 | } |
4413 | ||
2b148f39 PB |
4414 | typedef struct InvalidateCacheCo { |
4415 | BlockDriverState *bs; | |
4416 | Error **errp; | |
4417 | bool done; | |
4418 | } InvalidateCacheCo; | |
4419 | ||
4420 | static void coroutine_fn bdrv_invalidate_cache_co_entry(void *opaque) | |
4421 | { | |
4422 | InvalidateCacheCo *ico = opaque; | |
4423 | bdrv_co_invalidate_cache(ico->bs, ico->errp); | |
4424 | ico->done = true; | |
4425 | } | |
4426 | ||
4427 | void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp) | |
4428 | { | |
4429 | Coroutine *co; | |
4430 | InvalidateCacheCo ico = { | |
4431 | .bs = bs, | |
4432 | .done = false, | |
4433 | .errp = errp | |
4434 | }; | |
4435 | ||
4436 | if (qemu_in_coroutine()) { | |
4437 | /* Fast-path if already in coroutine context */ | |
4438 | bdrv_invalidate_cache_co_entry(&ico); | |
4439 | } else { | |
4440 | co = qemu_coroutine_create(bdrv_invalidate_cache_co_entry, &ico); | |
4441 | qemu_coroutine_enter(co); | |
4442 | BDRV_POLL_WHILE(bs, !ico.done); | |
4443 | } | |
4444 | } | |
4445 | ||
5a8a30db | 4446 | void bdrv_invalidate_cache_all(Error **errp) |
0f15423c | 4447 | { |
7c8eece4 | 4448 | BlockDriverState *bs; |
5a8a30db | 4449 | Error *local_err = NULL; |
88be7b4b | 4450 | BdrvNextIterator it; |
0f15423c | 4451 | |
88be7b4b | 4452 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
ed78cda3 SH |
4453 | AioContext *aio_context = bdrv_get_aio_context(bs); |
4454 | ||
4455 | aio_context_acquire(aio_context); | |
5a8a30db | 4456 | bdrv_invalidate_cache(bs, &local_err); |
ed78cda3 | 4457 | aio_context_release(aio_context); |
5a8a30db KW |
4458 | if (local_err) { |
4459 | error_propagate(errp, local_err); | |
5e003f17 | 4460 | bdrv_next_cleanup(&it); |
5a8a30db KW |
4461 | return; |
4462 | } | |
0f15423c AL |
4463 | } |
4464 | } | |
4465 | ||
aad0b7a0 FZ |
4466 | static int bdrv_inactivate_recurse(BlockDriverState *bs, |
4467 | bool setting_flag) | |
76b1c7fe | 4468 | { |
cfa1a572 | 4469 | BdrvChild *child, *parent; |
76b1c7fe KW |
4470 | int ret; |
4471 | ||
d470ad42 HR |
4472 | if (!bs->drv) { |
4473 | return -ENOMEDIUM; | |
4474 | } | |
4475 | ||
aad0b7a0 | 4476 | if (!setting_flag && bs->drv->bdrv_inactivate) { |
76b1c7fe KW |
4477 | ret = bs->drv->bdrv_inactivate(bs); |
4478 | if (ret < 0) { | |
4479 | return ret; | |
4480 | } | |
4481 | } | |
4482 | ||
7d5b5261 | 4483 | if (setting_flag && !(bs->open_flags & BDRV_O_INACTIVE)) { |
9c5e6594 KW |
4484 | uint64_t perm, shared_perm; |
4485 | ||
cfa1a572 KW |
4486 | QLIST_FOREACH(parent, &bs->parents, next_parent) { |
4487 | if (parent->role->inactivate) { | |
4488 | ret = parent->role->inactivate(parent); | |
4489 | if (ret < 0) { | |
cfa1a572 KW |
4490 | return ret; |
4491 | } | |
4492 | } | |
4493 | } | |
9c5e6594 | 4494 | |
7d5b5261 SH |
4495 | bs->open_flags |= BDRV_O_INACTIVE; |
4496 | ||
9c5e6594 KW |
4497 | /* Update permissions, they may differ for inactive nodes */ |
4498 | bdrv_get_cumulative_perm(bs, &perm, &shared_perm); | |
3121fb45 | 4499 | bdrv_check_perm(bs, NULL, perm, shared_perm, NULL, &error_abort); |
9c5e6594 | 4500 | bdrv_set_perm(bs, perm, shared_perm); |
aad0b7a0 | 4501 | } |
38701b6a KW |
4502 | |
4503 | QLIST_FOREACH(child, &bs->children, next) { | |
4504 | ret = bdrv_inactivate_recurse(child->bs, setting_flag); | |
4505 | if (ret < 0) { | |
4506 | return ret; | |
4507 | } | |
4508 | } | |
4509 | ||
615b5dcf VSO |
4510 | /* At this point persistent bitmaps should be already stored by the format |
4511 | * driver */ | |
4512 | bdrv_release_persistent_dirty_bitmaps(bs); | |
4513 | ||
76b1c7fe KW |
4514 | return 0; |
4515 | } | |
4516 | ||
4517 | int bdrv_inactivate_all(void) | |
4518 | { | |
79720af6 | 4519 | BlockDriverState *bs = NULL; |
88be7b4b | 4520 | BdrvNextIterator it; |
aad0b7a0 FZ |
4521 | int ret = 0; |
4522 | int pass; | |
bd6458e4 | 4523 | GSList *aio_ctxs = NULL, *ctx; |
76b1c7fe | 4524 | |
88be7b4b | 4525 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
bd6458e4 PB |
4526 | AioContext *aio_context = bdrv_get_aio_context(bs); |
4527 | ||
4528 | if (!g_slist_find(aio_ctxs, aio_context)) { | |
4529 | aio_ctxs = g_slist_prepend(aio_ctxs, aio_context); | |
4530 | aio_context_acquire(aio_context); | |
4531 | } | |
aad0b7a0 | 4532 | } |
76b1c7fe | 4533 | |
aad0b7a0 FZ |
4534 | /* We do two passes of inactivation. The first pass calls to drivers' |
4535 | * .bdrv_inactivate callbacks recursively so all cache is flushed to disk; | |
4536 | * the second pass sets the BDRV_O_INACTIVE flag so that no further write | |
4537 | * is allowed. */ | |
4538 | for (pass = 0; pass < 2; pass++) { | |
88be7b4b | 4539 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
aad0b7a0 FZ |
4540 | ret = bdrv_inactivate_recurse(bs, pass); |
4541 | if (ret < 0) { | |
5e003f17 | 4542 | bdrv_next_cleanup(&it); |
aad0b7a0 FZ |
4543 | goto out; |
4544 | } | |
76b1c7fe KW |
4545 | } |
4546 | } | |
4547 | ||
aad0b7a0 | 4548 | out: |
bd6458e4 PB |
4549 | for (ctx = aio_ctxs; ctx != NULL; ctx = ctx->next) { |
4550 | AioContext *aio_context = ctx->data; | |
4551 | aio_context_release(aio_context); | |
aad0b7a0 | 4552 | } |
bd6458e4 | 4553 | g_slist_free(aio_ctxs); |
aad0b7a0 FZ |
4554 | |
4555 | return ret; | |
76b1c7fe KW |
4556 | } |
4557 | ||
19cb3738 FB |
4558 | /**************************************************************/ |
4559 | /* removable device support */ | |
4560 | ||
4561 | /** | |
4562 | * Return TRUE if the media is present | |
4563 | */ | |
e031f750 | 4564 | bool bdrv_is_inserted(BlockDriverState *bs) |
19cb3738 FB |
4565 | { |
4566 | BlockDriver *drv = bs->drv; | |
28d7a789 | 4567 | BdrvChild *child; |
a1aff5bf | 4568 | |
e031f750 HR |
4569 | if (!drv) { |
4570 | return false; | |
4571 | } | |
28d7a789 HR |
4572 | if (drv->bdrv_is_inserted) { |
4573 | return drv->bdrv_is_inserted(bs); | |
4574 | } | |
4575 | QLIST_FOREACH(child, &bs->children, next) { | |
4576 | if (!bdrv_is_inserted(child->bs)) { | |
4577 | return false; | |
4578 | } | |
e031f750 | 4579 | } |
28d7a789 | 4580 | return true; |
19cb3738 FB |
4581 | } |
4582 | ||
19cb3738 FB |
4583 | /** |
4584 | * If eject_flag is TRUE, eject the media. Otherwise, close the tray | |
4585 | */ | |
f36f3949 | 4586 | void bdrv_eject(BlockDriverState *bs, bool eject_flag) |
19cb3738 FB |
4587 | { |
4588 | BlockDriver *drv = bs->drv; | |
19cb3738 | 4589 | |
822e1cd1 MA |
4590 | if (drv && drv->bdrv_eject) { |
4591 | drv->bdrv_eject(bs, eject_flag); | |
19cb3738 FB |
4592 | } |
4593 | } | |
4594 | ||
19cb3738 FB |
4595 | /** |
4596 | * Lock or unlock the media (if it is locked, the user won't be able | |
4597 | * to eject it manually). | |
4598 | */ | |
025e849a | 4599 | void bdrv_lock_medium(BlockDriverState *bs, bool locked) |
19cb3738 FB |
4600 | { |
4601 | BlockDriver *drv = bs->drv; | |
4602 | ||
025e849a | 4603 | trace_bdrv_lock_medium(bs, locked); |
b8c6d095 | 4604 | |
025e849a MA |
4605 | if (drv && drv->bdrv_lock_medium) { |
4606 | drv->bdrv_lock_medium(bs, locked); | |
19cb3738 FB |
4607 | } |
4608 | } | |
985a03b0 | 4609 | |
9fcb0251 FZ |
4610 | /* Get a reference to bs */ |
4611 | void bdrv_ref(BlockDriverState *bs) | |
4612 | { | |
4613 | bs->refcnt++; | |
4614 | } | |
4615 | ||
4616 | /* Release a previously grabbed reference to bs. | |
4617 | * If after releasing, reference count is zero, the BlockDriverState is | |
4618 | * deleted. */ | |
4619 | void bdrv_unref(BlockDriverState *bs) | |
4620 | { | |
9a4d5ca6 JC |
4621 | if (!bs) { |
4622 | return; | |
4623 | } | |
9fcb0251 FZ |
4624 | assert(bs->refcnt > 0); |
4625 | if (--bs->refcnt == 0) { | |
4626 | bdrv_delete(bs); | |
4627 | } | |
4628 | } | |
4629 | ||
fbe40ff7 FZ |
4630 | struct BdrvOpBlocker { |
4631 | Error *reason; | |
4632 | QLIST_ENTRY(BdrvOpBlocker) list; | |
4633 | }; | |
4634 | ||
4635 | bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp) | |
4636 | { | |
4637 | BdrvOpBlocker *blocker; | |
4638 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
4639 | if (!QLIST_EMPTY(&bs->op_blockers[op])) { | |
4640 | blocker = QLIST_FIRST(&bs->op_blockers[op]); | |
57ef3f12 EH |
4641 | error_propagate(errp, error_copy(blocker->reason)); |
4642 | error_prepend(errp, "Node '%s' is busy: ", | |
4643 | bdrv_get_device_or_node_name(bs)); | |
fbe40ff7 FZ |
4644 | return true; |
4645 | } | |
4646 | return false; | |
4647 | } | |
4648 | ||
4649 | void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason) | |
4650 | { | |
4651 | BdrvOpBlocker *blocker; | |
4652 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
4653 | ||
5839e53b | 4654 | blocker = g_new0(BdrvOpBlocker, 1); |
fbe40ff7 FZ |
4655 | blocker->reason = reason; |
4656 | QLIST_INSERT_HEAD(&bs->op_blockers[op], blocker, list); | |
4657 | } | |
4658 | ||
4659 | void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason) | |
4660 | { | |
4661 | BdrvOpBlocker *blocker, *next; | |
4662 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
4663 | QLIST_FOREACH_SAFE(blocker, &bs->op_blockers[op], list, next) { | |
4664 | if (blocker->reason == reason) { | |
4665 | QLIST_REMOVE(blocker, list); | |
4666 | g_free(blocker); | |
4667 | } | |
4668 | } | |
4669 | } | |
4670 | ||
4671 | void bdrv_op_block_all(BlockDriverState *bs, Error *reason) | |
4672 | { | |
4673 | int i; | |
4674 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
4675 | bdrv_op_block(bs, i, reason); | |
4676 | } | |
4677 | } | |
4678 | ||
4679 | void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason) | |
4680 | { | |
4681 | int i; | |
4682 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
4683 | bdrv_op_unblock(bs, i, reason); | |
4684 | } | |
4685 | } | |
4686 | ||
4687 | bool bdrv_op_blocker_is_empty(BlockDriverState *bs) | |
4688 | { | |
4689 | int i; | |
4690 | ||
4691 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
4692 | if (!QLIST_EMPTY(&bs->op_blockers[i])) { | |
4693 | return false; | |
4694 | } | |
4695 | } | |
4696 | return true; | |
4697 | } | |
4698 | ||
d92ada22 LC |
4699 | void bdrv_img_create(const char *filename, const char *fmt, |
4700 | const char *base_filename, const char *base_fmt, | |
9217283d FZ |
4701 | char *options, uint64_t img_size, int flags, bool quiet, |
4702 | Error **errp) | |
f88e1a42 | 4703 | { |
83d0521a CL |
4704 | QemuOptsList *create_opts = NULL; |
4705 | QemuOpts *opts = NULL; | |
4706 | const char *backing_fmt, *backing_file; | |
4707 | int64_t size; | |
f88e1a42 | 4708 | BlockDriver *drv, *proto_drv; |
cc84d90f | 4709 | Error *local_err = NULL; |
f88e1a42 JS |
4710 | int ret = 0; |
4711 | ||
4712 | /* Find driver and parse its options */ | |
4713 | drv = bdrv_find_format(fmt); | |
4714 | if (!drv) { | |
71c79813 | 4715 | error_setg(errp, "Unknown file format '%s'", fmt); |
d92ada22 | 4716 | return; |
f88e1a42 JS |
4717 | } |
4718 | ||
b65a5e12 | 4719 | proto_drv = bdrv_find_protocol(filename, true, errp); |
f88e1a42 | 4720 | if (!proto_drv) { |
d92ada22 | 4721 | return; |
f88e1a42 JS |
4722 | } |
4723 | ||
c6149724 HR |
4724 | if (!drv->create_opts) { |
4725 | error_setg(errp, "Format driver '%s' does not support image creation", | |
4726 | drv->format_name); | |
4727 | return; | |
4728 | } | |
4729 | ||
4730 | if (!proto_drv->create_opts) { | |
4731 | error_setg(errp, "Protocol driver '%s' does not support image creation", | |
4732 | proto_drv->format_name); | |
4733 | return; | |
4734 | } | |
4735 | ||
c282e1fd CL |
4736 | create_opts = qemu_opts_append(create_opts, drv->create_opts); |
4737 | create_opts = qemu_opts_append(create_opts, proto_drv->create_opts); | |
f88e1a42 JS |
4738 | |
4739 | /* Create parameter list with default values */ | |
83d0521a | 4740 | opts = qemu_opts_create(create_opts, NULL, 0, &error_abort); |
39101f25 | 4741 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort); |
f88e1a42 JS |
4742 | |
4743 | /* Parse -o options */ | |
4744 | if (options) { | |
dc523cd3 MA |
4745 | qemu_opts_do_parse(opts, options, NULL, &local_err); |
4746 | if (local_err) { | |
4747 | error_report_err(local_err); | |
4748 | local_err = NULL; | |
83d0521a | 4749 | error_setg(errp, "Invalid options for file format '%s'", fmt); |
f88e1a42 JS |
4750 | goto out; |
4751 | } | |
4752 | } | |
4753 | ||
4754 | if (base_filename) { | |
f43e47db | 4755 | qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &local_err); |
6be4194b | 4756 | if (local_err) { |
71c79813 LC |
4757 | error_setg(errp, "Backing file not supported for file format '%s'", |
4758 | fmt); | |
f88e1a42 JS |
4759 | goto out; |
4760 | } | |
4761 | } | |
4762 | ||
4763 | if (base_fmt) { | |
f43e47db | 4764 | qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &local_err); |
6be4194b | 4765 | if (local_err) { |
71c79813 LC |
4766 | error_setg(errp, "Backing file format not supported for file " |
4767 | "format '%s'", fmt); | |
f88e1a42 JS |
4768 | goto out; |
4769 | } | |
4770 | } | |
4771 | ||
83d0521a CL |
4772 | backing_file = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE); |
4773 | if (backing_file) { | |
4774 | if (!strcmp(filename, backing_file)) { | |
71c79813 LC |
4775 | error_setg(errp, "Error: Trying to create an image with the " |
4776 | "same filename as the backing file"); | |
792da93a JS |
4777 | goto out; |
4778 | } | |
4779 | } | |
4780 | ||
83d0521a | 4781 | backing_fmt = qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT); |
f88e1a42 | 4782 | |
6e6e55f5 JS |
4783 | /* The size for the image must always be specified, unless we have a backing |
4784 | * file and we have not been forbidden from opening it. */ | |
a8b42a1c | 4785 | size = qemu_opt_get_size(opts, BLOCK_OPT_SIZE, img_size); |
6e6e55f5 JS |
4786 | if (backing_file && !(flags & BDRV_O_NO_BACKING)) { |
4787 | BlockDriverState *bs; | |
4788 | char *full_backing = g_new0(char, PATH_MAX); | |
4789 | int back_flags; | |
4790 | QDict *backing_options = NULL; | |
4791 | ||
4792 | bdrv_get_full_backing_filename_from_filename(filename, backing_file, | |
4793 | full_backing, PATH_MAX, | |
4794 | &local_err); | |
4795 | if (local_err) { | |
4796 | g_free(full_backing); | |
4797 | goto out; | |
4798 | } | |
29168018 | 4799 | |
6e6e55f5 JS |
4800 | /* backing files always opened read-only */ |
4801 | back_flags = flags; | |
4802 | back_flags &= ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING); | |
f88e1a42 | 4803 | |
cc954f01 | 4804 | backing_options = qdict_new(); |
6e6e55f5 | 4805 | if (backing_fmt) { |
6e6e55f5 JS |
4806 | qdict_put_str(backing_options, "driver", backing_fmt); |
4807 | } | |
cc954f01 | 4808 | qdict_put_bool(backing_options, BDRV_OPT_FORCE_SHARE, true); |
e6641719 | 4809 | |
6e6e55f5 JS |
4810 | bs = bdrv_open(full_backing, NULL, backing_options, back_flags, |
4811 | &local_err); | |
4812 | g_free(full_backing); | |
4813 | if (!bs && size != -1) { | |
4814 | /* Couldn't open BS, but we have a size, so it's nonfatal */ | |
4815 | warn_reportf_err(local_err, | |
4816 | "Could not verify backing image. " | |
4817 | "This may become an error in future versions.\n"); | |
4818 | local_err = NULL; | |
4819 | } else if (!bs) { | |
4820 | /* Couldn't open bs, do not have size */ | |
4821 | error_append_hint(&local_err, | |
4822 | "Could not open backing image to determine size.\n"); | |
4823 | goto out; | |
4824 | } else { | |
4825 | if (size == -1) { | |
4826 | /* Opened BS, have no size */ | |
4827 | size = bdrv_getlength(bs); | |
4828 | if (size < 0) { | |
4829 | error_setg_errno(errp, -size, "Could not get size of '%s'", | |
4830 | backing_file); | |
4831 | bdrv_unref(bs); | |
4832 | goto out; | |
4833 | } | |
4834 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, size, &error_abort); | |
52bf1e72 | 4835 | } |
66f6b814 | 4836 | bdrv_unref(bs); |
f88e1a42 | 4837 | } |
6e6e55f5 JS |
4838 | } /* (backing_file && !(flags & BDRV_O_NO_BACKING)) */ |
4839 | ||
4840 | if (size == -1) { | |
4841 | error_setg(errp, "Image creation needs a size parameter"); | |
4842 | goto out; | |
f88e1a42 JS |
4843 | } |
4844 | ||
f382d43a | 4845 | if (!quiet) { |
fe646693 | 4846 | printf("Formatting '%s', fmt=%s ", filename, fmt); |
43c5d8f8 | 4847 | qemu_opts_print(opts, " "); |
f382d43a MR |
4848 | puts(""); |
4849 | } | |
83d0521a | 4850 | |
c282e1fd | 4851 | ret = bdrv_create(drv, filename, opts, &local_err); |
83d0521a | 4852 | |
cc84d90f HR |
4853 | if (ret == -EFBIG) { |
4854 | /* This is generally a better message than whatever the driver would | |
4855 | * deliver (especially because of the cluster_size_hint), since that | |
4856 | * is most probably not much different from "image too large". */ | |
4857 | const char *cluster_size_hint = ""; | |
83d0521a | 4858 | if (qemu_opt_get_size(opts, BLOCK_OPT_CLUSTER_SIZE, 0)) { |
cc84d90f | 4859 | cluster_size_hint = " (try using a larger cluster size)"; |
f88e1a42 | 4860 | } |
cc84d90f HR |
4861 | error_setg(errp, "The image size is too large for file format '%s'" |
4862 | "%s", fmt, cluster_size_hint); | |
4863 | error_free(local_err); | |
4864 | local_err = NULL; | |
f88e1a42 JS |
4865 | } |
4866 | ||
4867 | out: | |
83d0521a CL |
4868 | qemu_opts_del(opts); |
4869 | qemu_opts_free(create_opts); | |
621ff94d | 4870 | error_propagate(errp, local_err); |
f88e1a42 | 4871 | } |
85d126f3 SH |
4872 | |
4873 | AioContext *bdrv_get_aio_context(BlockDriverState *bs) | |
4874 | { | |
33f2a757 | 4875 | return bs ? bs->aio_context : qemu_get_aio_context(); |
dcd04228 SH |
4876 | } |
4877 | ||
7719f3c9 SH |
4878 | AioWait *bdrv_get_aio_wait(BlockDriverState *bs) |
4879 | { | |
4880 | return bs ? &bs->wait : NULL; | |
dcd04228 SH |
4881 | } |
4882 | ||
052a7572 FZ |
4883 | void bdrv_coroutine_enter(BlockDriverState *bs, Coroutine *co) |
4884 | { | |
4885 | aio_co_enter(bdrv_get_aio_context(bs), co); | |
4886 | } | |
4887 | ||
e8a095da SH |
4888 | static void bdrv_do_remove_aio_context_notifier(BdrvAioNotifier *ban) |
4889 | { | |
4890 | QLIST_REMOVE(ban, list); | |
4891 | g_free(ban); | |
4892 | } | |
4893 | ||
dcd04228 SH |
4894 | void bdrv_detach_aio_context(BlockDriverState *bs) |
4895 | { | |
e8a095da | 4896 | BdrvAioNotifier *baf, *baf_tmp; |
b97511c7 | 4897 | BdrvChild *child; |
33384421 | 4898 | |
dcd04228 SH |
4899 | if (!bs->drv) { |
4900 | return; | |
4901 | } | |
4902 | ||
e8a095da SH |
4903 | assert(!bs->walking_aio_notifiers); |
4904 | bs->walking_aio_notifiers = true; | |
4905 | QLIST_FOREACH_SAFE(baf, &bs->aio_notifiers, list, baf_tmp) { | |
4906 | if (baf->deleted) { | |
4907 | bdrv_do_remove_aio_context_notifier(baf); | |
4908 | } else { | |
4909 | baf->detach_aio_context(baf->opaque); | |
4910 | } | |
33384421 | 4911 | } |
e8a095da SH |
4912 | /* Never mind iterating again to check for ->deleted. bdrv_close() will |
4913 | * remove remaining aio notifiers if we aren't called again. | |
4914 | */ | |
4915 | bs->walking_aio_notifiers = false; | |
33384421 | 4916 | |
dcd04228 SH |
4917 | if (bs->drv->bdrv_detach_aio_context) { |
4918 | bs->drv->bdrv_detach_aio_context(bs); | |
4919 | } | |
b97511c7 HR |
4920 | QLIST_FOREACH(child, &bs->children, next) { |
4921 | bdrv_detach_aio_context(child->bs); | |
dcd04228 SH |
4922 | } |
4923 | ||
4924 | bs->aio_context = NULL; | |
4925 | } | |
4926 | ||
4927 | void bdrv_attach_aio_context(BlockDriverState *bs, | |
4928 | AioContext *new_context) | |
4929 | { | |
e8a095da | 4930 | BdrvAioNotifier *ban, *ban_tmp; |
b97511c7 | 4931 | BdrvChild *child; |
33384421 | 4932 | |
dcd04228 SH |
4933 | if (!bs->drv) { |
4934 | return; | |
4935 | } | |
4936 | ||
4937 | bs->aio_context = new_context; | |
4938 | ||
b97511c7 HR |
4939 | QLIST_FOREACH(child, &bs->children, next) { |
4940 | bdrv_attach_aio_context(child->bs, new_context); | |
dcd04228 SH |
4941 | } |
4942 | if (bs->drv->bdrv_attach_aio_context) { | |
4943 | bs->drv->bdrv_attach_aio_context(bs, new_context); | |
4944 | } | |
33384421 | 4945 | |
e8a095da SH |
4946 | assert(!bs->walking_aio_notifiers); |
4947 | bs->walking_aio_notifiers = true; | |
4948 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_tmp) { | |
4949 | if (ban->deleted) { | |
4950 | bdrv_do_remove_aio_context_notifier(ban); | |
4951 | } else { | |
4952 | ban->attached_aio_context(new_context, ban->opaque); | |
4953 | } | |
33384421 | 4954 | } |
e8a095da | 4955 | bs->walking_aio_notifiers = false; |
dcd04228 SH |
4956 | } |
4957 | ||
4958 | void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context) | |
4959 | { | |
aabf5910 | 4960 | AioContext *ctx = bdrv_get_aio_context(bs); |
c2b6428d | 4961 | |
aabf5910 | 4962 | aio_disable_external(ctx); |
6cd5c9d7 | 4963 | bdrv_parent_drained_begin(bs, NULL, false); |
53ec73e2 | 4964 | bdrv_drain(bs); /* ensure there are no in-flight requests */ |
dcd04228 | 4965 | |
c2b6428d PB |
4966 | while (aio_poll(ctx, false)) { |
4967 | /* wait for all bottom halves to execute */ | |
4968 | } | |
4969 | ||
dcd04228 SH |
4970 | bdrv_detach_aio_context(bs); |
4971 | ||
4972 | /* This function executes in the old AioContext so acquire the new one in | |
4973 | * case it runs in a different thread. | |
4974 | */ | |
4975 | aio_context_acquire(new_context); | |
4976 | bdrv_attach_aio_context(bs, new_context); | |
6cd5c9d7 | 4977 | bdrv_parent_drained_end(bs, NULL, false); |
aabf5910 | 4978 | aio_enable_external(ctx); |
dcd04228 | 4979 | aio_context_release(new_context); |
85d126f3 | 4980 | } |
d616b224 | 4981 | |
33384421 HR |
4982 | void bdrv_add_aio_context_notifier(BlockDriverState *bs, |
4983 | void (*attached_aio_context)(AioContext *new_context, void *opaque), | |
4984 | void (*detach_aio_context)(void *opaque), void *opaque) | |
4985 | { | |
4986 | BdrvAioNotifier *ban = g_new(BdrvAioNotifier, 1); | |
4987 | *ban = (BdrvAioNotifier){ | |
4988 | .attached_aio_context = attached_aio_context, | |
4989 | .detach_aio_context = detach_aio_context, | |
4990 | .opaque = opaque | |
4991 | }; | |
4992 | ||
4993 | QLIST_INSERT_HEAD(&bs->aio_notifiers, ban, list); | |
4994 | } | |
4995 | ||
4996 | void bdrv_remove_aio_context_notifier(BlockDriverState *bs, | |
4997 | void (*attached_aio_context)(AioContext *, | |
4998 | void *), | |
4999 | void (*detach_aio_context)(void *), | |
5000 | void *opaque) | |
5001 | { | |
5002 | BdrvAioNotifier *ban, *ban_next; | |
5003 | ||
5004 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { | |
5005 | if (ban->attached_aio_context == attached_aio_context && | |
5006 | ban->detach_aio_context == detach_aio_context && | |
e8a095da SH |
5007 | ban->opaque == opaque && |
5008 | ban->deleted == false) | |
33384421 | 5009 | { |
e8a095da SH |
5010 | if (bs->walking_aio_notifiers) { |
5011 | ban->deleted = true; | |
5012 | } else { | |
5013 | bdrv_do_remove_aio_context_notifier(ban); | |
5014 | } | |
33384421 HR |
5015 | return; |
5016 | } | |
5017 | } | |
5018 | ||
5019 | abort(); | |
5020 | } | |
5021 | ||
77485434 | 5022 | int bdrv_amend_options(BlockDriverState *bs, QemuOpts *opts, |
d1402b50 HR |
5023 | BlockDriverAmendStatusCB *status_cb, void *cb_opaque, |
5024 | Error **errp) | |
6f176b48 | 5025 | { |
d470ad42 | 5026 | if (!bs->drv) { |
d1402b50 | 5027 | error_setg(errp, "Node is ejected"); |
d470ad42 HR |
5028 | return -ENOMEDIUM; |
5029 | } | |
c282e1fd | 5030 | if (!bs->drv->bdrv_amend_options) { |
d1402b50 HR |
5031 | error_setg(errp, "Block driver '%s' does not support option amendment", |
5032 | bs->drv->format_name); | |
6f176b48 HR |
5033 | return -ENOTSUP; |
5034 | } | |
d1402b50 | 5035 | return bs->drv->bdrv_amend_options(bs, opts, status_cb, cb_opaque, errp); |
6f176b48 | 5036 | } |
f6186f49 | 5037 | |
b5042a36 BC |
5038 | /* This function will be called by the bdrv_recurse_is_first_non_filter method |
5039 | * of block filter and by bdrv_is_first_non_filter. | |
5040 | * It is used to test if the given bs is the candidate or recurse more in the | |
5041 | * node graph. | |
212a5a8f | 5042 | */ |
b5042a36 | 5043 | bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs, |
212a5a8f | 5044 | BlockDriverState *candidate) |
f6186f49 | 5045 | { |
b5042a36 BC |
5046 | /* return false if basic checks fails */ |
5047 | if (!bs || !bs->drv) { | |
212a5a8f | 5048 | return false; |
f6186f49 BC |
5049 | } |
5050 | ||
b5042a36 BC |
5051 | /* the code reached a non block filter driver -> check if the bs is |
5052 | * the same as the candidate. It's the recursion termination condition. | |
5053 | */ | |
5054 | if (!bs->drv->is_filter) { | |
5055 | return bs == candidate; | |
212a5a8f | 5056 | } |
b5042a36 | 5057 | /* Down this path the driver is a block filter driver */ |
212a5a8f | 5058 | |
b5042a36 BC |
5059 | /* If the block filter recursion method is defined use it to recurse down |
5060 | * the node graph. | |
5061 | */ | |
5062 | if (bs->drv->bdrv_recurse_is_first_non_filter) { | |
212a5a8f | 5063 | return bs->drv->bdrv_recurse_is_first_non_filter(bs, candidate); |
f6186f49 BC |
5064 | } |
5065 | ||
b5042a36 BC |
5066 | /* the driver is a block filter but don't allow to recurse -> return false |
5067 | */ | |
5068 | return false; | |
f6186f49 BC |
5069 | } |
5070 | ||
212a5a8f BC |
5071 | /* This function checks if the candidate is the first non filter bs down it's |
5072 | * bs chain. Since we don't have pointers to parents it explore all bs chains | |
5073 | * from the top. Some filters can choose not to pass down the recursion. | |
5074 | */ | |
5075 | bool bdrv_is_first_non_filter(BlockDriverState *candidate) | |
f6186f49 | 5076 | { |
7c8eece4 | 5077 | BlockDriverState *bs; |
88be7b4b | 5078 | BdrvNextIterator it; |
212a5a8f BC |
5079 | |
5080 | /* walk down the bs forest recursively */ | |
88be7b4b | 5081 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
212a5a8f BC |
5082 | bool perm; |
5083 | ||
b5042a36 | 5084 | /* try to recurse in this top level bs */ |
e6dc8a1f | 5085 | perm = bdrv_recurse_is_first_non_filter(bs, candidate); |
212a5a8f BC |
5086 | |
5087 | /* candidate is the first non filter */ | |
5088 | if (perm) { | |
5e003f17 | 5089 | bdrv_next_cleanup(&it); |
212a5a8f BC |
5090 | return true; |
5091 | } | |
5092 | } | |
5093 | ||
5094 | return false; | |
f6186f49 | 5095 | } |
09158f00 | 5096 | |
e12f3784 WC |
5097 | BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs, |
5098 | const char *node_name, Error **errp) | |
09158f00 BC |
5099 | { |
5100 | BlockDriverState *to_replace_bs = bdrv_find_node(node_name); | |
5a7e7a0b SH |
5101 | AioContext *aio_context; |
5102 | ||
09158f00 BC |
5103 | if (!to_replace_bs) { |
5104 | error_setg(errp, "Node name '%s' not found", node_name); | |
5105 | return NULL; | |
5106 | } | |
5107 | ||
5a7e7a0b SH |
5108 | aio_context = bdrv_get_aio_context(to_replace_bs); |
5109 | aio_context_acquire(aio_context); | |
5110 | ||
09158f00 | 5111 | if (bdrv_op_is_blocked(to_replace_bs, BLOCK_OP_TYPE_REPLACE, errp)) { |
5a7e7a0b SH |
5112 | to_replace_bs = NULL; |
5113 | goto out; | |
09158f00 BC |
5114 | } |
5115 | ||
5116 | /* We don't want arbitrary node of the BDS chain to be replaced only the top | |
5117 | * most non filter in order to prevent data corruption. | |
5118 | * Another benefit is that this tests exclude backing files which are | |
5119 | * blocked by the backing blockers. | |
5120 | */ | |
e12f3784 | 5121 | if (!bdrv_recurse_is_first_non_filter(parent_bs, to_replace_bs)) { |
09158f00 | 5122 | error_setg(errp, "Only top most non filter can be replaced"); |
5a7e7a0b SH |
5123 | to_replace_bs = NULL; |
5124 | goto out; | |
09158f00 BC |
5125 | } |
5126 | ||
5a7e7a0b SH |
5127 | out: |
5128 | aio_context_release(aio_context); | |
09158f00 BC |
5129 | return to_replace_bs; |
5130 | } | |
448ad91d | 5131 | |
91af7014 HR |
5132 | static bool append_open_options(QDict *d, BlockDriverState *bs) |
5133 | { | |
5134 | const QDictEntry *entry; | |
9e700c1a | 5135 | QemuOptDesc *desc; |
260fecf1 | 5136 | BdrvChild *child; |
91af7014 | 5137 | bool found_any = false; |
260fecf1 | 5138 | const char *p; |
91af7014 HR |
5139 | |
5140 | for (entry = qdict_first(bs->options); entry; | |
5141 | entry = qdict_next(bs->options, entry)) | |
5142 | { | |
260fecf1 KW |
5143 | /* Exclude options for children */ |
5144 | QLIST_FOREACH(child, &bs->children, next) { | |
5145 | if (strstart(qdict_entry_key(entry), child->name, &p) | |
5146 | && (!*p || *p == '.')) | |
5147 | { | |
5148 | break; | |
5149 | } | |
5150 | } | |
5151 | if (child) { | |
9e700c1a | 5152 | continue; |
91af7014 | 5153 | } |
9e700c1a KW |
5154 | |
5155 | /* And exclude all non-driver-specific options */ | |
5156 | for (desc = bdrv_runtime_opts.desc; desc->name; desc++) { | |
5157 | if (!strcmp(qdict_entry_key(entry), desc->name)) { | |
5158 | break; | |
5159 | } | |
5160 | } | |
5161 | if (desc->name) { | |
5162 | continue; | |
5163 | } | |
5164 | ||
f5a74a5a MAL |
5165 | qdict_put_obj(d, qdict_entry_key(entry), |
5166 | qobject_ref(qdict_entry_value(entry))); | |
9e700c1a | 5167 | found_any = true; |
91af7014 HR |
5168 | } |
5169 | ||
5170 | return found_any; | |
5171 | } | |
5172 | ||
5173 | /* Updates the following BDS fields: | |
5174 | * - exact_filename: A filename which may be used for opening a block device | |
5175 | * which (mostly) equals the given BDS (even without any | |
5176 | * other options; so reading and writing must return the same | |
5177 | * results, but caching etc. may be different) | |
5178 | * - full_open_options: Options which, when given when opening a block device | |
5179 | * (without a filename), result in a BDS (mostly) | |
5180 | * equalling the given one | |
5181 | * - filename: If exact_filename is set, it is copied here. Otherwise, | |
5182 | * full_open_options is converted to a JSON object, prefixed with | |
5183 | * "json:" (for use through the JSON pseudo protocol) and put here. | |
5184 | */ | |
5185 | void bdrv_refresh_filename(BlockDriverState *bs) | |
5186 | { | |
5187 | BlockDriver *drv = bs->drv; | |
5188 | QDict *opts; | |
5189 | ||
5190 | if (!drv) { | |
5191 | return; | |
5192 | } | |
5193 | ||
5194 | /* This BDS's file name will most probably depend on its file's name, so | |
5195 | * refresh that first */ | |
5196 | if (bs->file) { | |
9a4f4c31 | 5197 | bdrv_refresh_filename(bs->file->bs); |
91af7014 HR |
5198 | } |
5199 | ||
5200 | if (drv->bdrv_refresh_filename) { | |
5201 | /* Obsolete information is of no use here, so drop the old file name | |
5202 | * information before refreshing it */ | |
5203 | bs->exact_filename[0] = '\0'; | |
5204 | if (bs->full_open_options) { | |
cb3e7f08 | 5205 | qobject_unref(bs->full_open_options); |
91af7014 HR |
5206 | bs->full_open_options = NULL; |
5207 | } | |
5208 | ||
4cdd01d3 KW |
5209 | opts = qdict_new(); |
5210 | append_open_options(opts, bs); | |
5211 | drv->bdrv_refresh_filename(bs, opts); | |
cb3e7f08 | 5212 | qobject_unref(opts); |
91af7014 HR |
5213 | } else if (bs->file) { |
5214 | /* Try to reconstruct valid information from the underlying file */ | |
5215 | bool has_open_options; | |
5216 | ||
5217 | bs->exact_filename[0] = '\0'; | |
5218 | if (bs->full_open_options) { | |
cb3e7f08 | 5219 | qobject_unref(bs->full_open_options); |
91af7014 HR |
5220 | bs->full_open_options = NULL; |
5221 | } | |
5222 | ||
5223 | opts = qdict_new(); | |
5224 | has_open_options = append_open_options(opts, bs); | |
5225 | ||
5226 | /* If no specific options have been given for this BDS, the filename of | |
5227 | * the underlying file should suffice for this one as well */ | |
9a4f4c31 KW |
5228 | if (bs->file->bs->exact_filename[0] && !has_open_options) { |
5229 | strcpy(bs->exact_filename, bs->file->bs->exact_filename); | |
91af7014 HR |
5230 | } |
5231 | /* Reconstructing the full options QDict is simple for most format block | |
5232 | * drivers, as long as the full options are known for the underlying | |
5233 | * file BDS. The full options QDict of that file BDS should somehow | |
5234 | * contain a representation of the filename, therefore the following | |
5235 | * suffices without querying the (exact_)filename of this BDS. */ | |
9a4f4c31 | 5236 | if (bs->file->bs->full_open_options) { |
46f5ac20 | 5237 | qdict_put_str(opts, "driver", drv->format_name); |
f5a74a5a MAL |
5238 | qdict_put(opts, "file", |
5239 | qobject_ref(bs->file->bs->full_open_options)); | |
91af7014 HR |
5240 | |
5241 | bs->full_open_options = opts; | |
5242 | } else { | |
cb3e7f08 | 5243 | qobject_unref(opts); |
91af7014 HR |
5244 | } |
5245 | } else if (!bs->full_open_options && qdict_size(bs->options)) { | |
5246 | /* There is no underlying file BDS (at least referenced by BDS.file), | |
5247 | * so the full options QDict should be equal to the options given | |
5248 | * specifically for this block device when it was opened (plus the | |
5249 | * driver specification). | |
5250 | * Because those options don't change, there is no need to update | |
5251 | * full_open_options when it's already set. */ | |
5252 | ||
5253 | opts = qdict_new(); | |
5254 | append_open_options(opts, bs); | |
46f5ac20 | 5255 | qdict_put_str(opts, "driver", drv->format_name); |
91af7014 HR |
5256 | |
5257 | if (bs->exact_filename[0]) { | |
5258 | /* This may not work for all block protocol drivers (some may | |
5259 | * require this filename to be parsed), but we have to find some | |
5260 | * default solution here, so just include it. If some block driver | |
5261 | * does not support pure options without any filename at all or | |
5262 | * needs some special format of the options QDict, it needs to | |
5263 | * implement the driver-specific bdrv_refresh_filename() function. | |
5264 | */ | |
46f5ac20 | 5265 | qdict_put_str(opts, "filename", bs->exact_filename); |
91af7014 HR |
5266 | } |
5267 | ||
5268 | bs->full_open_options = opts; | |
5269 | } | |
5270 | ||
5271 | if (bs->exact_filename[0]) { | |
5272 | pstrcpy(bs->filename, sizeof(bs->filename), bs->exact_filename); | |
5273 | } else if (bs->full_open_options) { | |
5274 | QString *json = qobject_to_json(QOBJECT(bs->full_open_options)); | |
5275 | snprintf(bs->filename, sizeof(bs->filename), "json:%s", | |
5276 | qstring_get_str(json)); | |
cb3e7f08 | 5277 | qobject_unref(json); |
91af7014 HR |
5278 | } |
5279 | } | |
e06018ad WC |
5280 | |
5281 | /* | |
5282 | * Hot add/remove a BDS's child. So the user can take a child offline when | |
5283 | * it is broken and take a new child online | |
5284 | */ | |
5285 | void bdrv_add_child(BlockDriverState *parent_bs, BlockDriverState *child_bs, | |
5286 | Error **errp) | |
5287 | { | |
5288 | ||
5289 | if (!parent_bs->drv || !parent_bs->drv->bdrv_add_child) { | |
5290 | error_setg(errp, "The node %s does not support adding a child", | |
5291 | bdrv_get_device_or_node_name(parent_bs)); | |
5292 | return; | |
5293 | } | |
5294 | ||
5295 | if (!QLIST_EMPTY(&child_bs->parents)) { | |
5296 | error_setg(errp, "The node %s already has a parent", | |
5297 | child_bs->node_name); | |
5298 | return; | |
5299 | } | |
5300 | ||
5301 | parent_bs->drv->bdrv_add_child(parent_bs, child_bs, errp); | |
5302 | } | |
5303 | ||
5304 | void bdrv_del_child(BlockDriverState *parent_bs, BdrvChild *child, Error **errp) | |
5305 | { | |
5306 | BdrvChild *tmp; | |
5307 | ||
5308 | if (!parent_bs->drv || !parent_bs->drv->bdrv_del_child) { | |
5309 | error_setg(errp, "The node %s does not support removing a child", | |
5310 | bdrv_get_device_or_node_name(parent_bs)); | |
5311 | return; | |
5312 | } | |
5313 | ||
5314 | QLIST_FOREACH(tmp, &parent_bs->children, next) { | |
5315 | if (tmp == child) { | |
5316 | break; | |
5317 | } | |
5318 | } | |
5319 | ||
5320 | if (!tmp) { | |
5321 | error_setg(errp, "The node %s does not have a child named %s", | |
5322 | bdrv_get_device_or_node_name(parent_bs), | |
5323 | bdrv_get_device_or_node_name(child->bs)); | |
5324 | return; | |
5325 | } | |
5326 | ||
5327 | parent_bs->drv->bdrv_del_child(parent_bs, child, errp); | |
5328 | } | |
67b792f5 VSO |
5329 | |
5330 | bool bdrv_can_store_new_dirty_bitmap(BlockDriverState *bs, const char *name, | |
5331 | uint32_t granularity, Error **errp) | |
5332 | { | |
5333 | BlockDriver *drv = bs->drv; | |
5334 | ||
5335 | if (!drv) { | |
5336 | error_setg_errno(errp, ENOMEDIUM, | |
5337 | "Can't store persistent bitmaps to %s", | |
5338 | bdrv_get_device_or_node_name(bs)); | |
5339 | return false; | |
5340 | } | |
5341 | ||
5342 | if (!drv->bdrv_can_store_new_dirty_bitmap) { | |
5343 | error_setg_errno(errp, ENOTSUP, | |
5344 | "Can't store persistent bitmaps to %s", | |
5345 | bdrv_get_device_or_node_name(bs)); | |
5346 | return false; | |
5347 | } | |
5348 | ||
5349 | return drv->bdrv_can_store_new_dirty_bitmap(bs, name, granularity, errp); | |
5350 | } |