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