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