]>
Commit | Line | Data |
---|---|---|
fc01f7e7 FB |
1 | /* |
2 | * QEMU System Emulator block driver | |
5fafdf24 | 3 | * |
fc01f7e7 | 4 | * Copyright (c) 2003 Fabrice Bellard |
c20555e1 | 5 | * Copyright (c) 2020 Virtuozzo International GmbH. |
5fafdf24 | 6 | * |
fc01f7e7 FB |
7 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
8 | * of this software and associated documentation files (the "Software"), to deal | |
9 | * in the Software without restriction, including without limitation the rights | |
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
11 | * copies of the Software, and to permit persons to whom the Software is | |
12 | * furnished to do so, subject to the following conditions: | |
13 | * | |
14 | * The above copyright notice and this permission notice shall be included in | |
15 | * all copies or substantial portions of the Software. | |
16 | * | |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
20 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
23 | * THE SOFTWARE. | |
24 | */ | |
e688df6b | 25 | |
d38ea87a | 26 | #include "qemu/osdep.h" |
0ab8ed18 | 27 | #include "block/trace.h" |
737e150e PB |
28 | #include "block/block_int.h" |
29 | #include "block/blockjob.h" | |
0c9b70d5 | 30 | #include "block/fuse.h" |
cd7fca95 | 31 | #include "block/nbd.h" |
609f45ea | 32 | #include "block/qdict.h" |
d49b6836 | 33 | #include "qemu/error-report.h" |
5e5733e5 | 34 | #include "block/module_block.h" |
db725815 | 35 | #include "qemu/main-loop.h" |
1de7afc9 | 36 | #include "qemu/module.h" |
e688df6b | 37 | #include "qapi/error.h" |
452fcdbc | 38 | #include "qapi/qmp/qdict.h" |
7b1b5d19 | 39 | #include "qapi/qmp/qjson.h" |
e59a0cf1 | 40 | #include "qapi/qmp/qnull.h" |
fc81fa1e | 41 | #include "qapi/qmp/qstring.h" |
e1d74bc6 KW |
42 | #include "qapi/qobject-output-visitor.h" |
43 | #include "qapi/qapi-visit-block-core.h" | |
bfb197e0 | 44 | #include "sysemu/block-backend.h" |
1de7afc9 | 45 | #include "qemu/notify.h" |
922a01a0 | 46 | #include "qemu/option.h" |
10817bf0 | 47 | #include "qemu/coroutine.h" |
c13163fb | 48 | #include "block/qapi.h" |
1de7afc9 | 49 | #include "qemu/timer.h" |
f348b6d1 VB |
50 | #include "qemu/cutils.h" |
51 | #include "qemu/id.h" | |
0bc329fb HR |
52 | #include "qemu/range.h" |
53 | #include "qemu/rcu.h" | |
21c2283e | 54 | #include "block/coroutines.h" |
fc01f7e7 | 55 | |
71e72a19 | 56 | #ifdef CONFIG_BSD |
7674e7bf | 57 | #include <sys/ioctl.h> |
72cf2d4f | 58 | #include <sys/queue.h> |
feccdcee | 59 | #if defined(HAVE_SYS_DISK_H) |
7674e7bf FB |
60 | #include <sys/disk.h> |
61 | #endif | |
c5e97233 | 62 | #endif |
7674e7bf | 63 | |
49dc768d AL |
64 | #ifdef _WIN32 |
65 | #include <windows.h> | |
66 | #endif | |
67 | ||
1c9805a3 SH |
68 | #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */ |
69 | ||
dc364f4c BC |
70 | static QTAILQ_HEAD(, BlockDriverState) graph_bdrv_states = |
71 | QTAILQ_HEAD_INITIALIZER(graph_bdrv_states); | |
72 | ||
2c1d04e0 HR |
73 | static QTAILQ_HEAD(, BlockDriverState) all_bdrv_states = |
74 | QTAILQ_HEAD_INITIALIZER(all_bdrv_states); | |
75 | ||
8a22f02a SH |
76 | static QLIST_HEAD(, BlockDriver) bdrv_drivers = |
77 | QLIST_HEAD_INITIALIZER(bdrv_drivers); | |
ea2384d3 | 78 | |
5b363937 HR |
79 | static BlockDriverState *bdrv_open_inherit(const char *filename, |
80 | const char *reference, | |
81 | QDict *options, int flags, | |
82 | BlockDriverState *parent, | |
bd86fb99 | 83 | const BdrvChildClass *child_class, |
272c02ea | 84 | BdrvChildRole child_role, |
5b363937 | 85 | Error **errp); |
f3930ed0 | 86 | |
0978623e VSO |
87 | static void bdrv_replace_child_noperm(BdrvChild *child, |
88 | BlockDriverState *new_bs); | |
e9238278 VSO |
89 | static void bdrv_remove_file_or_backing_child(BlockDriverState *bs, |
90 | BdrvChild *child, | |
91 | Transaction *tran); | |
160333e1 VSO |
92 | static void bdrv_remove_filter_or_cow_child(BlockDriverState *bs, |
93 | Transaction *tran); | |
0978623e | 94 | |
72373e40 VSO |
95 | static int bdrv_reopen_prepare(BDRVReopenState *reopen_state, |
96 | BlockReopenQueue *queue, | |
ecd30d2d | 97 | Transaction *change_child_tran, Error **errp); |
53e96d1e VSO |
98 | static void bdrv_reopen_commit(BDRVReopenState *reopen_state); |
99 | static void bdrv_reopen_abort(BDRVReopenState *reopen_state); | |
100 | ||
eb852011 MA |
101 | /* If non-zero, use only whitelisted block drivers */ |
102 | static int use_bdrv_whitelist; | |
103 | ||
9e0b22f4 SH |
104 | #ifdef _WIN32 |
105 | static int is_windows_drive_prefix(const char *filename) | |
106 | { | |
107 | return (((filename[0] >= 'a' && filename[0] <= 'z') || | |
108 | (filename[0] >= 'A' && filename[0] <= 'Z')) && | |
109 | filename[1] == ':'); | |
110 | } | |
111 | ||
112 | int is_windows_drive(const char *filename) | |
113 | { | |
114 | if (is_windows_drive_prefix(filename) && | |
115 | filename[2] == '\0') | |
116 | return 1; | |
117 | if (strstart(filename, "\\\\.\\", NULL) || | |
118 | strstart(filename, "//./", NULL)) | |
119 | return 1; | |
120 | return 0; | |
121 | } | |
122 | #endif | |
123 | ||
339064d5 KW |
124 | size_t bdrv_opt_mem_align(BlockDriverState *bs) |
125 | { | |
126 | if (!bs || !bs->drv) { | |
459b4e66 | 127 | /* page size or 4k (hdd sector size) should be on the safe side */ |
038adc2f | 128 | return MAX(4096, qemu_real_host_page_size); |
339064d5 KW |
129 | } |
130 | ||
131 | return bs->bl.opt_mem_alignment; | |
132 | } | |
133 | ||
4196d2f0 DL |
134 | size_t bdrv_min_mem_align(BlockDriverState *bs) |
135 | { | |
136 | if (!bs || !bs->drv) { | |
459b4e66 | 137 | /* page size or 4k (hdd sector size) should be on the safe side */ |
038adc2f | 138 | return MAX(4096, qemu_real_host_page_size); |
4196d2f0 DL |
139 | } |
140 | ||
141 | return bs->bl.min_mem_alignment; | |
142 | } | |
143 | ||
9e0b22f4 | 144 | /* check if the path starts with "<protocol>:" */ |
5c98415b | 145 | int path_has_protocol(const char *path) |
9e0b22f4 | 146 | { |
947995c0 PB |
147 | const char *p; |
148 | ||
9e0b22f4 SH |
149 | #ifdef _WIN32 |
150 | if (is_windows_drive(path) || | |
151 | is_windows_drive_prefix(path)) { | |
152 | return 0; | |
153 | } | |
947995c0 PB |
154 | p = path + strcspn(path, ":/\\"); |
155 | #else | |
156 | p = path + strcspn(path, ":/"); | |
9e0b22f4 SH |
157 | #endif |
158 | ||
947995c0 | 159 | return *p == ':'; |
9e0b22f4 SH |
160 | } |
161 | ||
83f64091 | 162 | int path_is_absolute(const char *path) |
3b0d4f61 | 163 | { |
21664424 FB |
164 | #ifdef _WIN32 |
165 | /* specific case for names like: "\\.\d:" */ | |
f53f4da9 | 166 | if (is_windows_drive(path) || is_windows_drive_prefix(path)) { |
21664424 | 167 | return 1; |
f53f4da9 PB |
168 | } |
169 | return (*path == '/' || *path == '\\'); | |
3b9f94e1 | 170 | #else |
f53f4da9 | 171 | return (*path == '/'); |
3b9f94e1 | 172 | #endif |
3b0d4f61 FB |
173 | } |
174 | ||
009b03aa | 175 | /* if filename is absolute, just return its duplicate. Otherwise, build a |
83f64091 FB |
176 | path to it by considering it is relative to base_path. URL are |
177 | supported. */ | |
009b03aa | 178 | char *path_combine(const char *base_path, const char *filename) |
3b0d4f61 | 179 | { |
009b03aa | 180 | const char *protocol_stripped = NULL; |
83f64091 | 181 | const char *p, *p1; |
009b03aa | 182 | char *result; |
83f64091 FB |
183 | int len; |
184 | ||
83f64091 | 185 | if (path_is_absolute(filename)) { |
009b03aa HR |
186 | return g_strdup(filename); |
187 | } | |
0d54a6fe | 188 | |
009b03aa HR |
189 | if (path_has_protocol(base_path)) { |
190 | protocol_stripped = strchr(base_path, ':'); | |
191 | if (protocol_stripped) { | |
192 | protocol_stripped++; | |
0d54a6fe | 193 | } |
009b03aa HR |
194 | } |
195 | p = protocol_stripped ?: base_path; | |
0d54a6fe | 196 | |
009b03aa | 197 | p1 = strrchr(base_path, '/'); |
3b9f94e1 | 198 | #ifdef _WIN32 |
009b03aa HR |
199 | { |
200 | const char *p2; | |
201 | p2 = strrchr(base_path, '\\'); | |
202 | if (!p1 || p2 > p1) { | |
203 | p1 = p2; | |
3b9f94e1 | 204 | } |
009b03aa | 205 | } |
3b9f94e1 | 206 | #endif |
009b03aa HR |
207 | if (p1) { |
208 | p1++; | |
209 | } else { | |
210 | p1 = base_path; | |
211 | } | |
212 | if (p1 > p) { | |
213 | p = p1; | |
3b0d4f61 | 214 | } |
009b03aa HR |
215 | len = p - base_path; |
216 | ||
217 | result = g_malloc(len + strlen(filename) + 1); | |
218 | memcpy(result, base_path, len); | |
219 | strcpy(result + len, filename); | |
220 | ||
221 | return result; | |
222 | } | |
223 | ||
03c320d8 HR |
224 | /* |
225 | * Helper function for bdrv_parse_filename() implementations to remove optional | |
226 | * protocol prefixes (especially "file:") from a filename and for putting the | |
227 | * stripped filename into the options QDict if there is such a prefix. | |
228 | */ | |
229 | void bdrv_parse_filename_strip_prefix(const char *filename, const char *prefix, | |
230 | QDict *options) | |
231 | { | |
232 | if (strstart(filename, prefix, &filename)) { | |
233 | /* Stripping the explicit protocol prefix may result in a protocol | |
234 | * prefix being (wrongly) detected (if the filename contains a colon) */ | |
235 | if (path_has_protocol(filename)) { | |
18cf67c5 | 236 | GString *fat_filename; |
03c320d8 HR |
237 | |
238 | /* This means there is some colon before the first slash; therefore, | |
239 | * this cannot be an absolute path */ | |
240 | assert(!path_is_absolute(filename)); | |
241 | ||
242 | /* And we can thus fix the protocol detection issue by prefixing it | |
243 | * by "./" */ | |
18cf67c5 MA |
244 | fat_filename = g_string_new("./"); |
245 | g_string_append(fat_filename, filename); | |
03c320d8 | 246 | |
18cf67c5 | 247 | assert(!path_has_protocol(fat_filename->str)); |
03c320d8 | 248 | |
18cf67c5 MA |
249 | qdict_put(options, "filename", |
250 | qstring_from_gstring(fat_filename)); | |
03c320d8 HR |
251 | } else { |
252 | /* If no protocol prefix was detected, we can use the shortened | |
253 | * filename as-is */ | |
254 | qdict_put_str(options, "filename", filename); | |
255 | } | |
256 | } | |
257 | } | |
258 | ||
259 | ||
9c5e6594 KW |
260 | /* Returns whether the image file is opened as read-only. Note that this can |
261 | * return false and writing to the image file is still not possible because the | |
262 | * image is inactivated. */ | |
93ed524e JC |
263 | bool bdrv_is_read_only(BlockDriverState *bs) |
264 | { | |
975da073 | 265 | return !(bs->open_flags & BDRV_O_RDWR); |
93ed524e JC |
266 | } |
267 | ||
54a32bfe KW |
268 | int bdrv_can_set_read_only(BlockDriverState *bs, bool read_only, |
269 | bool ignore_allow_rdw, Error **errp) | |
fe5241bf | 270 | { |
e2b8247a JC |
271 | /* Do not set read_only if copy_on_read is enabled */ |
272 | if (bs->copy_on_read && read_only) { | |
273 | error_setg(errp, "Can't set node '%s' to r/o with copy-on-read enabled", | |
274 | bdrv_get_device_or_node_name(bs)); | |
275 | return -EINVAL; | |
276 | } | |
277 | ||
d6fcdf06 | 278 | /* Do not clear read_only if it is prohibited */ |
54a32bfe KW |
279 | if (!read_only && !(bs->open_flags & BDRV_O_ALLOW_RDWR) && |
280 | !ignore_allow_rdw) | |
281 | { | |
d6fcdf06 JC |
282 | error_setg(errp, "Node '%s' is read only", |
283 | bdrv_get_device_or_node_name(bs)); | |
284 | return -EPERM; | |
285 | } | |
286 | ||
45803a03 JC |
287 | return 0; |
288 | } | |
289 | ||
eaa2410f KW |
290 | /* |
291 | * Called by a driver that can only provide a read-only image. | |
292 | * | |
293 | * Returns 0 if the node is already read-only or it could switch the node to | |
294 | * read-only because BDRV_O_AUTO_RDONLY is set. | |
295 | * | |
296 | * Returns -EACCES if the node is read-write and BDRV_O_AUTO_RDONLY is not set | |
297 | * or bdrv_can_set_read_only() forbids making the node read-only. If @errmsg | |
298 | * is not NULL, it is used as the error message for the Error object. | |
299 | */ | |
300 | int bdrv_apply_auto_read_only(BlockDriverState *bs, const char *errmsg, | |
301 | Error **errp) | |
45803a03 JC |
302 | { |
303 | int ret = 0; | |
304 | ||
eaa2410f KW |
305 | if (!(bs->open_flags & BDRV_O_RDWR)) { |
306 | return 0; | |
307 | } | |
308 | if (!(bs->open_flags & BDRV_O_AUTO_RDONLY)) { | |
309 | goto fail; | |
45803a03 JC |
310 | } |
311 | ||
eaa2410f KW |
312 | ret = bdrv_can_set_read_only(bs, true, false, NULL); |
313 | if (ret < 0) { | |
314 | goto fail; | |
eeae6a59 KW |
315 | } |
316 | ||
eaa2410f KW |
317 | bs->open_flags &= ~BDRV_O_RDWR; |
318 | ||
e2b8247a | 319 | return 0; |
eaa2410f KW |
320 | |
321 | fail: | |
322 | error_setg(errp, "%s", errmsg ?: "Image is read-only"); | |
323 | return -EACCES; | |
fe5241bf JC |
324 | } |
325 | ||
645ae7d8 HR |
326 | /* |
327 | * If @backing is empty, this function returns NULL without setting | |
328 | * @errp. In all other cases, NULL will only be returned with @errp | |
329 | * set. | |
330 | * | |
331 | * Therefore, a return value of NULL without @errp set means that | |
332 | * there is no backing file; if @errp is set, there is one but its | |
333 | * absolute filename cannot be generated. | |
334 | */ | |
335 | char *bdrv_get_full_backing_filename_from_filename(const char *backed, | |
336 | const char *backing, | |
337 | Error **errp) | |
dc5a1371 | 338 | { |
645ae7d8 HR |
339 | if (backing[0] == '\0') { |
340 | return NULL; | |
341 | } else if (path_has_protocol(backing) || path_is_absolute(backing)) { | |
342 | return g_strdup(backing); | |
9f07429e HR |
343 | } else if (backed[0] == '\0' || strstart(backed, "json:", NULL)) { |
344 | error_setg(errp, "Cannot use relative backing file names for '%s'", | |
345 | backed); | |
645ae7d8 | 346 | return NULL; |
dc5a1371 | 347 | } else { |
645ae7d8 | 348 | return path_combine(backed, backing); |
dc5a1371 PB |
349 | } |
350 | } | |
351 | ||
9f4793d8 HR |
352 | /* |
353 | * If @filename is empty or NULL, this function returns NULL without | |
354 | * setting @errp. In all other cases, NULL will only be returned with | |
355 | * @errp set. | |
356 | */ | |
357 | static char *bdrv_make_absolute_filename(BlockDriverState *relative_to, | |
358 | const char *filename, Error **errp) | |
0a82855a | 359 | { |
8df68616 | 360 | char *dir, *full_name; |
9f4793d8 | 361 | |
8df68616 HR |
362 | if (!filename || filename[0] == '\0') { |
363 | return NULL; | |
364 | } else if (path_has_protocol(filename) || path_is_absolute(filename)) { | |
365 | return g_strdup(filename); | |
366 | } | |
9f07429e | 367 | |
8df68616 HR |
368 | dir = bdrv_dirname(relative_to, errp); |
369 | if (!dir) { | |
370 | return NULL; | |
371 | } | |
f30c66ba | 372 | |
8df68616 HR |
373 | full_name = g_strconcat(dir, filename, NULL); |
374 | g_free(dir); | |
375 | return full_name; | |
9f4793d8 HR |
376 | } |
377 | ||
378 | char *bdrv_get_full_backing_filename(BlockDriverState *bs, Error **errp) | |
379 | { | |
380 | return bdrv_make_absolute_filename(bs, bs->backing_file, errp); | |
0a82855a HR |
381 | } |
382 | ||
0eb7217e SH |
383 | void bdrv_register(BlockDriver *bdrv) |
384 | { | |
a15f08dc | 385 | assert(bdrv->format_name); |
8a22f02a | 386 | QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list); |
ea2384d3 | 387 | } |
b338082b | 388 | |
e4e9986b MA |
389 | BlockDriverState *bdrv_new(void) |
390 | { | |
391 | BlockDriverState *bs; | |
392 | int i; | |
393 | ||
5839e53b | 394 | bs = g_new0(BlockDriverState, 1); |
e4654d2d | 395 | QLIST_INIT(&bs->dirty_bitmaps); |
fbe40ff7 FZ |
396 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { |
397 | QLIST_INIT(&bs->op_blockers[i]); | |
398 | } | |
3783fa3d | 399 | qemu_co_mutex_init(&bs->reqs_lock); |
2119882c | 400 | qemu_mutex_init(&bs->dirty_bitmap_mutex); |
9fcb0251 | 401 | bs->refcnt = 1; |
dcd04228 | 402 | bs->aio_context = qemu_get_aio_context(); |
d7d512f6 | 403 | |
3ff2f67a EY |
404 | qemu_co_queue_init(&bs->flush_queue); |
405 | ||
0bc329fb HR |
406 | qemu_co_mutex_init(&bs->bsc_modify_lock); |
407 | bs->block_status_cache = g_new0(BdrvBlockStatusCache, 1); | |
408 | ||
0f12264e KW |
409 | for (i = 0; i < bdrv_drain_all_count; i++) { |
410 | bdrv_drained_begin(bs); | |
411 | } | |
412 | ||
2c1d04e0 HR |
413 | QTAILQ_INSERT_TAIL(&all_bdrv_states, bs, bs_list); |
414 | ||
b338082b FB |
415 | return bs; |
416 | } | |
417 | ||
88d88798 | 418 | static BlockDriver *bdrv_do_find_format(const char *format_name) |
ea2384d3 FB |
419 | { |
420 | BlockDriver *drv1; | |
88d88798 | 421 | |
8a22f02a SH |
422 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { |
423 | if (!strcmp(drv1->format_name, format_name)) { | |
ea2384d3 | 424 | return drv1; |
8a22f02a | 425 | } |
ea2384d3 | 426 | } |
88d88798 | 427 | |
ea2384d3 FB |
428 | return NULL; |
429 | } | |
430 | ||
88d88798 MM |
431 | BlockDriver *bdrv_find_format(const char *format_name) |
432 | { | |
433 | BlockDriver *drv1; | |
434 | int i; | |
435 | ||
436 | drv1 = bdrv_do_find_format(format_name); | |
437 | if (drv1) { | |
438 | return drv1; | |
439 | } | |
440 | ||
441 | /* The driver isn't registered, maybe we need to load a module */ | |
442 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); ++i) { | |
443 | if (!strcmp(block_driver_modules[i].format_name, format_name)) { | |
444 | block_module_load_one(block_driver_modules[i].library_name); | |
445 | break; | |
446 | } | |
447 | } | |
448 | ||
449 | return bdrv_do_find_format(format_name); | |
450 | } | |
451 | ||
9ac404c5 | 452 | static int bdrv_format_is_whitelisted(const char *format_name, bool read_only) |
eb852011 | 453 | { |
b64ec4e4 FZ |
454 | static const char *whitelist_rw[] = { |
455 | CONFIG_BDRV_RW_WHITELIST | |
859aef02 | 456 | NULL |
b64ec4e4 FZ |
457 | }; |
458 | static const char *whitelist_ro[] = { | |
459 | CONFIG_BDRV_RO_WHITELIST | |
859aef02 | 460 | NULL |
eb852011 MA |
461 | }; |
462 | const char **p; | |
463 | ||
b64ec4e4 | 464 | if (!whitelist_rw[0] && !whitelist_ro[0]) { |
eb852011 | 465 | return 1; /* no whitelist, anything goes */ |
b64ec4e4 | 466 | } |
eb852011 | 467 | |
b64ec4e4 | 468 | for (p = whitelist_rw; *p; p++) { |
9ac404c5 | 469 | if (!strcmp(format_name, *p)) { |
eb852011 MA |
470 | return 1; |
471 | } | |
472 | } | |
b64ec4e4 FZ |
473 | if (read_only) { |
474 | for (p = whitelist_ro; *p; p++) { | |
9ac404c5 | 475 | if (!strcmp(format_name, *p)) { |
b64ec4e4 FZ |
476 | return 1; |
477 | } | |
478 | } | |
479 | } | |
eb852011 MA |
480 | return 0; |
481 | } | |
482 | ||
9ac404c5 AS |
483 | int bdrv_is_whitelisted(BlockDriver *drv, bool read_only) |
484 | { | |
485 | return bdrv_format_is_whitelisted(drv->format_name, read_only); | |
486 | } | |
487 | ||
e6ff69bf DB |
488 | bool bdrv_uses_whitelist(void) |
489 | { | |
490 | return use_bdrv_whitelist; | |
491 | } | |
492 | ||
5b7e1542 ZYW |
493 | typedef struct CreateCo { |
494 | BlockDriver *drv; | |
495 | char *filename; | |
83d0521a | 496 | QemuOpts *opts; |
5b7e1542 | 497 | int ret; |
cc84d90f | 498 | Error *err; |
5b7e1542 ZYW |
499 | } CreateCo; |
500 | ||
501 | static void coroutine_fn bdrv_create_co_entry(void *opaque) | |
502 | { | |
cc84d90f HR |
503 | Error *local_err = NULL; |
504 | int ret; | |
505 | ||
5b7e1542 ZYW |
506 | CreateCo *cco = opaque; |
507 | assert(cco->drv); | |
508 | ||
b92902df ML |
509 | ret = cco->drv->bdrv_co_create_opts(cco->drv, |
510 | cco->filename, cco->opts, &local_err); | |
621ff94d | 511 | error_propagate(&cco->err, local_err); |
cc84d90f | 512 | cco->ret = ret; |
5b7e1542 ZYW |
513 | } |
514 | ||
0e7e1989 | 515 | int bdrv_create(BlockDriver *drv, const char* filename, |
83d0521a | 516 | QemuOpts *opts, Error **errp) |
ea2384d3 | 517 | { |
5b7e1542 ZYW |
518 | int ret; |
519 | ||
520 | Coroutine *co; | |
521 | CreateCo cco = { | |
522 | .drv = drv, | |
523 | .filename = g_strdup(filename), | |
83d0521a | 524 | .opts = opts, |
5b7e1542 | 525 | .ret = NOT_DONE, |
cc84d90f | 526 | .err = NULL, |
5b7e1542 ZYW |
527 | }; |
528 | ||
efc75e2a | 529 | if (!drv->bdrv_co_create_opts) { |
cc84d90f | 530 | error_setg(errp, "Driver '%s' does not support image creation", drv->format_name); |
80168bff LC |
531 | ret = -ENOTSUP; |
532 | goto out; | |
5b7e1542 ZYW |
533 | } |
534 | ||
535 | if (qemu_in_coroutine()) { | |
536 | /* Fast-path if already in coroutine context */ | |
537 | bdrv_create_co_entry(&cco); | |
538 | } else { | |
0b8b8753 PB |
539 | co = qemu_coroutine_create(bdrv_create_co_entry, &cco); |
540 | qemu_coroutine_enter(co); | |
5b7e1542 | 541 | while (cco.ret == NOT_DONE) { |
b47ec2c4 | 542 | aio_poll(qemu_get_aio_context(), true); |
5b7e1542 ZYW |
543 | } |
544 | } | |
545 | ||
546 | ret = cco.ret; | |
cc84d90f | 547 | if (ret < 0) { |
84d18f06 | 548 | if (cco.err) { |
cc84d90f HR |
549 | error_propagate(errp, cco.err); |
550 | } else { | |
551 | error_setg_errno(errp, -ret, "Could not create image"); | |
552 | } | |
553 | } | |
0e7e1989 | 554 | |
80168bff LC |
555 | out: |
556 | g_free(cco.filename); | |
5b7e1542 | 557 | return ret; |
ea2384d3 FB |
558 | } |
559 | ||
fd17146c HR |
560 | /** |
561 | * Helper function for bdrv_create_file_fallback(): Resize @blk to at | |
562 | * least the given @minimum_size. | |
563 | * | |
564 | * On success, return @blk's actual length. | |
565 | * Otherwise, return -errno. | |
566 | */ | |
567 | static int64_t create_file_fallback_truncate(BlockBackend *blk, | |
568 | int64_t minimum_size, Error **errp) | |
84a12e66 | 569 | { |
cc84d90f | 570 | Error *local_err = NULL; |
fd17146c | 571 | int64_t size; |
cc84d90f | 572 | int ret; |
84a12e66 | 573 | |
8c6242b6 KW |
574 | ret = blk_truncate(blk, minimum_size, false, PREALLOC_MODE_OFF, 0, |
575 | &local_err); | |
fd17146c HR |
576 | if (ret < 0 && ret != -ENOTSUP) { |
577 | error_propagate(errp, local_err); | |
578 | return ret; | |
579 | } | |
580 | ||
581 | size = blk_getlength(blk); | |
582 | if (size < 0) { | |
583 | error_free(local_err); | |
584 | error_setg_errno(errp, -size, | |
585 | "Failed to inquire the new image file's length"); | |
586 | return size; | |
587 | } | |
588 | ||
589 | if (size < minimum_size) { | |
590 | /* Need to grow the image, but we failed to do that */ | |
591 | error_propagate(errp, local_err); | |
592 | return -ENOTSUP; | |
593 | } | |
594 | ||
595 | error_free(local_err); | |
596 | local_err = NULL; | |
597 | ||
598 | return size; | |
599 | } | |
600 | ||
601 | /** | |
602 | * Helper function for bdrv_create_file_fallback(): Zero the first | |
603 | * sector to remove any potentially pre-existing image header. | |
604 | */ | |
605 | static int create_file_fallback_zero_first_sector(BlockBackend *blk, | |
606 | int64_t current_size, | |
607 | Error **errp) | |
608 | { | |
609 | int64_t bytes_to_clear; | |
610 | int ret; | |
611 | ||
612 | bytes_to_clear = MIN(current_size, BDRV_SECTOR_SIZE); | |
613 | if (bytes_to_clear) { | |
614 | ret = blk_pwrite_zeroes(blk, 0, bytes_to_clear, BDRV_REQ_MAY_UNMAP); | |
615 | if (ret < 0) { | |
616 | error_setg_errno(errp, -ret, | |
617 | "Failed to clear the new image's first sector"); | |
618 | return ret; | |
619 | } | |
620 | } | |
621 | ||
622 | return 0; | |
623 | } | |
624 | ||
5a5e7f8c ML |
625 | /** |
626 | * Simple implementation of bdrv_co_create_opts for protocol drivers | |
627 | * which only support creation via opening a file | |
628 | * (usually existing raw storage device) | |
629 | */ | |
630 | int coroutine_fn bdrv_co_create_opts_simple(BlockDriver *drv, | |
631 | const char *filename, | |
632 | QemuOpts *opts, | |
633 | Error **errp) | |
fd17146c HR |
634 | { |
635 | BlockBackend *blk; | |
eeea1faa | 636 | QDict *options; |
fd17146c HR |
637 | int64_t size = 0; |
638 | char *buf = NULL; | |
639 | PreallocMode prealloc; | |
640 | Error *local_err = NULL; | |
641 | int ret; | |
642 | ||
643 | size = qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0); | |
644 | buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC); | |
645 | prealloc = qapi_enum_parse(&PreallocMode_lookup, buf, | |
646 | PREALLOC_MODE_OFF, &local_err); | |
647 | g_free(buf); | |
648 | if (local_err) { | |
649 | error_propagate(errp, local_err); | |
650 | return -EINVAL; | |
651 | } | |
652 | ||
653 | if (prealloc != PREALLOC_MODE_OFF) { | |
654 | error_setg(errp, "Unsupported preallocation mode '%s'", | |
655 | PreallocMode_str(prealloc)); | |
656 | return -ENOTSUP; | |
657 | } | |
658 | ||
eeea1faa | 659 | options = qdict_new(); |
fd17146c HR |
660 | qdict_put_str(options, "driver", drv->format_name); |
661 | ||
662 | blk = blk_new_open(filename, NULL, options, | |
663 | BDRV_O_RDWR | BDRV_O_RESIZE, errp); | |
664 | if (!blk) { | |
665 | error_prepend(errp, "Protocol driver '%s' does not support image " | |
666 | "creation, and opening the image failed: ", | |
667 | drv->format_name); | |
668 | return -EINVAL; | |
669 | } | |
670 | ||
671 | size = create_file_fallback_truncate(blk, size, errp); | |
672 | if (size < 0) { | |
673 | ret = size; | |
674 | goto out; | |
675 | } | |
676 | ||
677 | ret = create_file_fallback_zero_first_sector(blk, size, errp); | |
678 | if (ret < 0) { | |
679 | goto out; | |
680 | } | |
681 | ||
682 | ret = 0; | |
683 | out: | |
684 | blk_unref(blk); | |
685 | return ret; | |
686 | } | |
687 | ||
688 | int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp) | |
689 | { | |
729222af | 690 | QemuOpts *protocol_opts; |
fd17146c | 691 | BlockDriver *drv; |
729222af SG |
692 | QDict *qdict; |
693 | int ret; | |
fd17146c | 694 | |
b65a5e12 | 695 | drv = bdrv_find_protocol(filename, true, errp); |
84a12e66 | 696 | if (drv == NULL) { |
16905d71 | 697 | return -ENOENT; |
84a12e66 CH |
698 | } |
699 | ||
729222af SG |
700 | if (!drv->create_opts) { |
701 | error_setg(errp, "Driver '%s' does not support image creation", | |
702 | drv->format_name); | |
703 | return -ENOTSUP; | |
704 | } | |
705 | ||
706 | /* | |
707 | * 'opts' contains a QemuOptsList with a combination of format and protocol | |
708 | * default values. | |
709 | * | |
710 | * The format properly removes its options, but the default values remain | |
711 | * in 'opts->list'. So if the protocol has options with the same name | |
712 | * (e.g. rbd has 'cluster_size' as qcow2), it will see the default values | |
713 | * of the format, since for overlapping options, the format wins. | |
714 | * | |
715 | * To avoid this issue, lets convert QemuOpts to QDict, in this way we take | |
716 | * only the set options, and then convert it back to QemuOpts, using the | |
717 | * create_opts of the protocol. So the new QemuOpts, will contain only the | |
718 | * protocol defaults. | |
719 | */ | |
720 | qdict = qemu_opts_to_qdict(opts, NULL); | |
721 | protocol_opts = qemu_opts_from_qdict(drv->create_opts, qdict, errp); | |
722 | if (protocol_opts == NULL) { | |
723 | ret = -EINVAL; | |
724 | goto out; | |
725 | } | |
726 | ||
727 | ret = bdrv_create(drv, filename, protocol_opts, errp); | |
728 | out: | |
729 | qemu_opts_del(protocol_opts); | |
730 | qobject_unref(qdict); | |
731 | return ret; | |
84a12e66 CH |
732 | } |
733 | ||
e1d7f8bb DHB |
734 | int coroutine_fn bdrv_co_delete_file(BlockDriverState *bs, Error **errp) |
735 | { | |
736 | Error *local_err = NULL; | |
737 | int ret; | |
738 | ||
739 | assert(bs != NULL); | |
740 | ||
741 | if (!bs->drv) { | |
742 | error_setg(errp, "Block node '%s' is not opened", bs->filename); | |
743 | return -ENOMEDIUM; | |
744 | } | |
745 | ||
746 | if (!bs->drv->bdrv_co_delete_file) { | |
747 | error_setg(errp, "Driver '%s' does not support image deletion", | |
748 | bs->drv->format_name); | |
749 | return -ENOTSUP; | |
750 | } | |
751 | ||
752 | ret = bs->drv->bdrv_co_delete_file(bs, &local_err); | |
753 | if (ret < 0) { | |
754 | error_propagate(errp, local_err); | |
755 | } | |
756 | ||
757 | return ret; | |
758 | } | |
759 | ||
a890f08e ML |
760 | void coroutine_fn bdrv_co_delete_file_noerr(BlockDriverState *bs) |
761 | { | |
762 | Error *local_err = NULL; | |
763 | int ret; | |
764 | ||
765 | if (!bs) { | |
766 | return; | |
767 | } | |
768 | ||
769 | ret = bdrv_co_delete_file(bs, &local_err); | |
770 | /* | |
771 | * ENOTSUP will happen if the block driver doesn't support | |
772 | * the 'bdrv_co_delete_file' interface. This is a predictable | |
773 | * scenario and shouldn't be reported back to the user. | |
774 | */ | |
775 | if (ret == -ENOTSUP) { | |
776 | error_free(local_err); | |
777 | } else if (ret < 0) { | |
778 | error_report_err(local_err); | |
779 | } | |
780 | } | |
781 | ||
892b7de8 ET |
782 | /** |
783 | * Try to get @bs's logical and physical block size. | |
784 | * On success, store them in @bsz struct and return 0. | |
785 | * On failure return -errno. | |
786 | * @bs must not be empty. | |
787 | */ | |
788 | int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz) | |
789 | { | |
790 | BlockDriver *drv = bs->drv; | |
93393e69 | 791 | BlockDriverState *filtered = bdrv_filter_bs(bs); |
892b7de8 ET |
792 | |
793 | if (drv && drv->bdrv_probe_blocksizes) { | |
794 | return drv->bdrv_probe_blocksizes(bs, bsz); | |
93393e69 HR |
795 | } else if (filtered) { |
796 | return bdrv_probe_blocksizes(filtered, bsz); | |
892b7de8 ET |
797 | } |
798 | ||
799 | return -ENOTSUP; | |
800 | } | |
801 | ||
802 | /** | |
803 | * Try to get @bs's geometry (cyls, heads, sectors). | |
804 | * On success, store them in @geo struct and return 0. | |
805 | * On failure return -errno. | |
806 | * @bs must not be empty. | |
807 | */ | |
808 | int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo) | |
809 | { | |
810 | BlockDriver *drv = bs->drv; | |
93393e69 | 811 | BlockDriverState *filtered = bdrv_filter_bs(bs); |
892b7de8 ET |
812 | |
813 | if (drv && drv->bdrv_probe_geometry) { | |
814 | return drv->bdrv_probe_geometry(bs, geo); | |
93393e69 HR |
815 | } else if (filtered) { |
816 | return bdrv_probe_geometry(filtered, geo); | |
892b7de8 ET |
817 | } |
818 | ||
819 | return -ENOTSUP; | |
820 | } | |
821 | ||
eba25057 JM |
822 | /* |
823 | * Create a uniquely-named empty temporary file. | |
824 | * Return 0 upon success, otherwise a negative errno value. | |
825 | */ | |
826 | int get_tmp_filename(char *filename, int size) | |
d5249393 | 827 | { |
eba25057 | 828 | #ifdef _WIN32 |
3b9f94e1 | 829 | char temp_dir[MAX_PATH]; |
eba25057 JM |
830 | /* GetTempFileName requires that its output buffer (4th param) |
831 | have length MAX_PATH or greater. */ | |
832 | assert(size >= MAX_PATH); | |
833 | return (GetTempPath(MAX_PATH, temp_dir) | |
834 | && GetTempFileName(temp_dir, "qem", 0, filename) | |
835 | ? 0 : -GetLastError()); | |
d5249393 | 836 | #else |
67b915a5 | 837 | int fd; |
7ccfb2eb | 838 | const char *tmpdir; |
0badc1ee | 839 | tmpdir = getenv("TMPDIR"); |
69bef793 AS |
840 | if (!tmpdir) { |
841 | tmpdir = "/var/tmp"; | |
842 | } | |
eba25057 JM |
843 | if (snprintf(filename, size, "%s/vl.XXXXXX", tmpdir) >= size) { |
844 | return -EOVERFLOW; | |
845 | } | |
ea2384d3 | 846 | fd = mkstemp(filename); |
fe235a06 DH |
847 | if (fd < 0) { |
848 | return -errno; | |
849 | } | |
850 | if (close(fd) != 0) { | |
851 | unlink(filename); | |
eba25057 JM |
852 | return -errno; |
853 | } | |
854 | return 0; | |
d5249393 | 855 | #endif |
eba25057 | 856 | } |
fc01f7e7 | 857 | |
84a12e66 CH |
858 | /* |
859 | * Detect host devices. By convention, /dev/cdrom[N] is always | |
860 | * recognized as a host CDROM. | |
861 | */ | |
862 | static BlockDriver *find_hdev_driver(const char *filename) | |
863 | { | |
864 | int score_max = 0, score; | |
865 | BlockDriver *drv = NULL, *d; | |
866 | ||
867 | QLIST_FOREACH(d, &bdrv_drivers, list) { | |
868 | if (d->bdrv_probe_device) { | |
869 | score = d->bdrv_probe_device(filename); | |
870 | if (score > score_max) { | |
871 | score_max = score; | |
872 | drv = d; | |
873 | } | |
874 | } | |
875 | } | |
876 | ||
877 | return drv; | |
878 | } | |
879 | ||
88d88798 MM |
880 | static BlockDriver *bdrv_do_find_protocol(const char *protocol) |
881 | { | |
882 | BlockDriver *drv1; | |
883 | ||
884 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { | |
885 | if (drv1->protocol_name && !strcmp(drv1->protocol_name, protocol)) { | |
886 | return drv1; | |
887 | } | |
888 | } | |
889 | ||
890 | return NULL; | |
891 | } | |
892 | ||
98289620 | 893 | BlockDriver *bdrv_find_protocol(const char *filename, |
b65a5e12 HR |
894 | bool allow_protocol_prefix, |
895 | Error **errp) | |
83f64091 FB |
896 | { |
897 | BlockDriver *drv1; | |
898 | char protocol[128]; | |
1cec71e3 | 899 | int len; |
83f64091 | 900 | const char *p; |
88d88798 | 901 | int i; |
19cb3738 | 902 | |
66f82cee KW |
903 | /* TODO Drivers without bdrv_file_open must be specified explicitly */ |
904 | ||
39508e7a CH |
905 | /* |
906 | * XXX(hch): we really should not let host device detection | |
907 | * override an explicit protocol specification, but moving this | |
908 | * later breaks access to device names with colons in them. | |
909 | * Thanks to the brain-dead persistent naming schemes on udev- | |
910 | * based Linux systems those actually are quite common. | |
911 | */ | |
912 | drv1 = find_hdev_driver(filename); | |
913 | if (drv1) { | |
914 | return drv1; | |
915 | } | |
916 | ||
98289620 | 917 | if (!path_has_protocol(filename) || !allow_protocol_prefix) { |
ef810437 | 918 | return &bdrv_file; |
84a12e66 | 919 | } |
98289620 | 920 | |
9e0b22f4 SH |
921 | p = strchr(filename, ':'); |
922 | assert(p != NULL); | |
1cec71e3 AL |
923 | len = p - filename; |
924 | if (len > sizeof(protocol) - 1) | |
925 | len = sizeof(protocol) - 1; | |
926 | memcpy(protocol, filename, len); | |
927 | protocol[len] = '\0'; | |
88d88798 MM |
928 | |
929 | drv1 = bdrv_do_find_protocol(protocol); | |
930 | if (drv1) { | |
931 | return drv1; | |
932 | } | |
933 | ||
934 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); ++i) { | |
935 | if (block_driver_modules[i].protocol_name && | |
936 | !strcmp(block_driver_modules[i].protocol_name, protocol)) { | |
937 | block_module_load_one(block_driver_modules[i].library_name); | |
938 | break; | |
8a22f02a | 939 | } |
83f64091 | 940 | } |
b65a5e12 | 941 | |
88d88798 MM |
942 | drv1 = bdrv_do_find_protocol(protocol); |
943 | if (!drv1) { | |
944 | error_setg(errp, "Unknown protocol '%s'", protocol); | |
945 | } | |
946 | return drv1; | |
83f64091 FB |
947 | } |
948 | ||
c6684249 MA |
949 | /* |
950 | * Guess image format by probing its contents. | |
951 | * This is not a good idea when your image is raw (CVE-2008-2004), but | |
952 | * we do it anyway for backward compatibility. | |
953 | * | |
954 | * @buf contains the image's first @buf_size bytes. | |
7cddd372 KW |
955 | * @buf_size is the buffer size in bytes (generally BLOCK_PROBE_BUF_SIZE, |
956 | * but can be smaller if the image file is smaller) | |
c6684249 MA |
957 | * @filename is its filename. |
958 | * | |
959 | * For all block drivers, call the bdrv_probe() method to get its | |
960 | * probing score. | |
961 | * Return the first block driver with the highest probing score. | |
962 | */ | |
38f3ef57 KW |
963 | BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size, |
964 | const char *filename) | |
c6684249 MA |
965 | { |
966 | int score_max = 0, score; | |
967 | BlockDriver *drv = NULL, *d; | |
968 | ||
969 | QLIST_FOREACH(d, &bdrv_drivers, list) { | |
970 | if (d->bdrv_probe) { | |
971 | score = d->bdrv_probe(buf, buf_size, filename); | |
972 | if (score > score_max) { | |
973 | score_max = score; | |
974 | drv = d; | |
975 | } | |
976 | } | |
977 | } | |
978 | ||
979 | return drv; | |
980 | } | |
981 | ||
5696c6e3 | 982 | static int find_image_format(BlockBackend *file, const char *filename, |
34b5d2c6 | 983 | BlockDriver **pdrv, Error **errp) |
f3a5d3f8 | 984 | { |
c6684249 | 985 | BlockDriver *drv; |
7cddd372 | 986 | uint8_t buf[BLOCK_PROBE_BUF_SIZE]; |
f500a6d3 | 987 | int ret = 0; |
f8ea0b00 | 988 | |
08a00559 | 989 | /* Return the raw BlockDriver * to scsi-generic devices or empty drives */ |
5696c6e3 | 990 | if (blk_is_sg(file) || !blk_is_inserted(file) || blk_getlength(file) == 0) { |
ef810437 | 991 | *pdrv = &bdrv_raw; |
c98ac35d | 992 | return ret; |
1a396859 | 993 | } |
f8ea0b00 | 994 | |
5696c6e3 | 995 | ret = blk_pread(file, 0, buf, sizeof(buf)); |
83f64091 | 996 | if (ret < 0) { |
34b5d2c6 HR |
997 | error_setg_errno(errp, -ret, "Could not read image for determining its " |
998 | "format"); | |
c98ac35d SW |
999 | *pdrv = NULL; |
1000 | return ret; | |
83f64091 FB |
1001 | } |
1002 | ||
c6684249 | 1003 | drv = bdrv_probe_all(buf, ret, filename); |
c98ac35d | 1004 | if (!drv) { |
34b5d2c6 HR |
1005 | error_setg(errp, "Could not determine image format: No compatible " |
1006 | "driver found"); | |
c98ac35d SW |
1007 | ret = -ENOENT; |
1008 | } | |
1009 | *pdrv = drv; | |
1010 | return ret; | |
ea2384d3 FB |
1011 | } |
1012 | ||
51762288 SH |
1013 | /** |
1014 | * Set the current 'total_sectors' value | |
65a9bb25 | 1015 | * Return 0 on success, -errno on error. |
51762288 | 1016 | */ |
3d9f2d2a | 1017 | int refresh_total_sectors(BlockDriverState *bs, int64_t hint) |
51762288 SH |
1018 | { |
1019 | BlockDriver *drv = bs->drv; | |
1020 | ||
d470ad42 HR |
1021 | if (!drv) { |
1022 | return -ENOMEDIUM; | |
1023 | } | |
1024 | ||
396759ad | 1025 | /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */ |
b192af8a | 1026 | if (bdrv_is_sg(bs)) |
396759ad NB |
1027 | return 0; |
1028 | ||
51762288 SH |
1029 | /* query actual device if possible, otherwise just trust the hint */ |
1030 | if (drv->bdrv_getlength) { | |
1031 | int64_t length = drv->bdrv_getlength(bs); | |
1032 | if (length < 0) { | |
1033 | return length; | |
1034 | } | |
7e382003 | 1035 | hint = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE); |
51762288 SH |
1036 | } |
1037 | ||
1038 | bs->total_sectors = hint; | |
8b117001 VSO |
1039 | |
1040 | if (bs->total_sectors * BDRV_SECTOR_SIZE > BDRV_MAX_LENGTH) { | |
1041 | return -EFBIG; | |
1042 | } | |
1043 | ||
51762288 SH |
1044 | return 0; |
1045 | } | |
1046 | ||
cddff5ba KW |
1047 | /** |
1048 | * Combines a QDict of new block driver @options with any missing options taken | |
1049 | * from @old_options, so that leaving out an option defaults to its old value. | |
1050 | */ | |
1051 | static void bdrv_join_options(BlockDriverState *bs, QDict *options, | |
1052 | QDict *old_options) | |
1053 | { | |
1054 | if (bs->drv && bs->drv->bdrv_join_options) { | |
1055 | bs->drv->bdrv_join_options(options, old_options); | |
1056 | } else { | |
1057 | qdict_join(options, old_options, false); | |
1058 | } | |
1059 | } | |
1060 | ||
543770bd AG |
1061 | static BlockdevDetectZeroesOptions bdrv_parse_detect_zeroes(QemuOpts *opts, |
1062 | int open_flags, | |
1063 | Error **errp) | |
1064 | { | |
1065 | Error *local_err = NULL; | |
1066 | char *value = qemu_opt_get_del(opts, "detect-zeroes"); | |
1067 | BlockdevDetectZeroesOptions detect_zeroes = | |
1068 | qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup, value, | |
1069 | BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF, &local_err); | |
1070 | g_free(value); | |
1071 | if (local_err) { | |
1072 | error_propagate(errp, local_err); | |
1073 | return detect_zeroes; | |
1074 | } | |
1075 | ||
1076 | if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP && | |
1077 | !(open_flags & BDRV_O_UNMAP)) | |
1078 | { | |
1079 | error_setg(errp, "setting detect-zeroes to unmap is not allowed " | |
1080 | "without setting discard operation to unmap"); | |
1081 | } | |
1082 | ||
1083 | return detect_zeroes; | |
1084 | } | |
1085 | ||
f80f2673 AM |
1086 | /** |
1087 | * Set open flags for aio engine | |
1088 | * | |
1089 | * Return 0 on success, -1 if the engine specified is invalid | |
1090 | */ | |
1091 | int bdrv_parse_aio(const char *mode, int *flags) | |
1092 | { | |
1093 | if (!strcmp(mode, "threads")) { | |
1094 | /* do nothing, default */ | |
1095 | } else if (!strcmp(mode, "native")) { | |
1096 | *flags |= BDRV_O_NATIVE_AIO; | |
1097 | #ifdef CONFIG_LINUX_IO_URING | |
1098 | } else if (!strcmp(mode, "io_uring")) { | |
1099 | *flags |= BDRV_O_IO_URING; | |
1100 | #endif | |
1101 | } else { | |
1102 | return -1; | |
1103 | } | |
1104 | ||
1105 | return 0; | |
1106 | } | |
1107 | ||
9e8f1835 PB |
1108 | /** |
1109 | * Set open flags for a given discard mode | |
1110 | * | |
1111 | * Return 0 on success, -1 if the discard mode was invalid. | |
1112 | */ | |
1113 | int bdrv_parse_discard_flags(const char *mode, int *flags) | |
1114 | { | |
1115 | *flags &= ~BDRV_O_UNMAP; | |
1116 | ||
1117 | if (!strcmp(mode, "off") || !strcmp(mode, "ignore")) { | |
1118 | /* do nothing */ | |
1119 | } else if (!strcmp(mode, "on") || !strcmp(mode, "unmap")) { | |
1120 | *flags |= BDRV_O_UNMAP; | |
1121 | } else { | |
1122 | return -1; | |
1123 | } | |
1124 | ||
1125 | return 0; | |
1126 | } | |
1127 | ||
c3993cdc SH |
1128 | /** |
1129 | * Set open flags for a given cache mode | |
1130 | * | |
1131 | * Return 0 on success, -1 if the cache mode was invalid. | |
1132 | */ | |
53e8ae01 | 1133 | int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough) |
c3993cdc SH |
1134 | { |
1135 | *flags &= ~BDRV_O_CACHE_MASK; | |
1136 | ||
1137 | if (!strcmp(mode, "off") || !strcmp(mode, "none")) { | |
53e8ae01 KW |
1138 | *writethrough = false; |
1139 | *flags |= BDRV_O_NOCACHE; | |
92196b2f | 1140 | } else if (!strcmp(mode, "directsync")) { |
53e8ae01 | 1141 | *writethrough = true; |
92196b2f | 1142 | *flags |= BDRV_O_NOCACHE; |
c3993cdc | 1143 | } else if (!strcmp(mode, "writeback")) { |
53e8ae01 | 1144 | *writethrough = false; |
c3993cdc | 1145 | } else if (!strcmp(mode, "unsafe")) { |
53e8ae01 | 1146 | *writethrough = false; |
c3993cdc SH |
1147 | *flags |= BDRV_O_NO_FLUSH; |
1148 | } else if (!strcmp(mode, "writethrough")) { | |
53e8ae01 | 1149 | *writethrough = true; |
c3993cdc SH |
1150 | } else { |
1151 | return -1; | |
1152 | } | |
1153 | ||
1154 | return 0; | |
1155 | } | |
1156 | ||
b5411555 KW |
1157 | static char *bdrv_child_get_parent_desc(BdrvChild *c) |
1158 | { | |
1159 | BlockDriverState *parent = c->opaque; | |
2c0a3acb | 1160 | return g_strdup_printf("node '%s'", bdrv_get_node_name(parent)); |
b5411555 KW |
1161 | } |
1162 | ||
20018e12 KW |
1163 | static void bdrv_child_cb_drained_begin(BdrvChild *child) |
1164 | { | |
1165 | BlockDriverState *bs = child->opaque; | |
6cd5c9d7 | 1166 | bdrv_do_drained_begin_quiesce(bs, NULL, false); |
20018e12 KW |
1167 | } |
1168 | ||
89bd0305 KW |
1169 | static bool bdrv_child_cb_drained_poll(BdrvChild *child) |
1170 | { | |
1171 | BlockDriverState *bs = child->opaque; | |
6cd5c9d7 | 1172 | return bdrv_drain_poll(bs, false, NULL, false); |
89bd0305 KW |
1173 | } |
1174 | ||
e037c09c HR |
1175 | static void bdrv_child_cb_drained_end(BdrvChild *child, |
1176 | int *drained_end_counter) | |
20018e12 KW |
1177 | { |
1178 | BlockDriverState *bs = child->opaque; | |
e037c09c | 1179 | bdrv_drained_end_no_poll(bs, drained_end_counter); |
20018e12 KW |
1180 | } |
1181 | ||
38701b6a KW |
1182 | static int bdrv_child_cb_inactivate(BdrvChild *child) |
1183 | { | |
1184 | BlockDriverState *bs = child->opaque; | |
1185 | assert(bs->open_flags & BDRV_O_INACTIVE); | |
1186 | return 0; | |
1187 | } | |
1188 | ||
5d231849 KW |
1189 | static bool bdrv_child_cb_can_set_aio_ctx(BdrvChild *child, AioContext *ctx, |
1190 | GSList **ignore, Error **errp) | |
1191 | { | |
1192 | BlockDriverState *bs = child->opaque; | |
1193 | return bdrv_can_set_aio_context(bs, ctx, ignore, errp); | |
1194 | } | |
1195 | ||
53a7d041 KW |
1196 | static void bdrv_child_cb_set_aio_ctx(BdrvChild *child, AioContext *ctx, |
1197 | GSList **ignore) | |
1198 | { | |
1199 | BlockDriverState *bs = child->opaque; | |
1200 | return bdrv_set_aio_context_ignore(bs, ctx, ignore); | |
1201 | } | |
1202 | ||
b1e6fc08 | 1203 | /* |
73176bee KW |
1204 | * Returns the options and flags that a temporary snapshot should get, based on |
1205 | * the originally requested flags (the originally requested image will have | |
1206 | * flags like a backing file) | |
b1e6fc08 | 1207 | */ |
73176bee KW |
1208 | static void bdrv_temp_snapshot_options(int *child_flags, QDict *child_options, |
1209 | int parent_flags, QDict *parent_options) | |
b1e6fc08 | 1210 | { |
73176bee KW |
1211 | *child_flags = (parent_flags & ~BDRV_O_SNAPSHOT) | BDRV_O_TEMPORARY; |
1212 | ||
1213 | /* For temporary files, unconditional cache=unsafe is fine */ | |
73176bee KW |
1214 | qdict_set_default_str(child_options, BDRV_OPT_CACHE_DIRECT, "off"); |
1215 | qdict_set_default_str(child_options, BDRV_OPT_CACHE_NO_FLUSH, "on"); | |
41869044 | 1216 | |
3f48686f | 1217 | /* Copy the read-only and discard options from the parent */ |
f87a0e29 | 1218 | qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY); |
3f48686f | 1219 | qdict_copy_default(child_options, parent_options, BDRV_OPT_DISCARD); |
f87a0e29 | 1220 | |
41869044 KW |
1221 | /* aio=native doesn't work for cache.direct=off, so disable it for the |
1222 | * temporary snapshot */ | |
1223 | *child_flags &= ~BDRV_O_NATIVE_AIO; | |
b1e6fc08 KW |
1224 | } |
1225 | ||
db95dbba KW |
1226 | static void bdrv_backing_attach(BdrvChild *c) |
1227 | { | |
1228 | BlockDriverState *parent = c->opaque; | |
1229 | BlockDriverState *backing_hd = c->bs; | |
1230 | ||
1231 | assert(!parent->backing_blocker); | |
1232 | error_setg(&parent->backing_blocker, | |
1233 | "node is used as backing hd of '%s'", | |
1234 | bdrv_get_device_or_node_name(parent)); | |
1235 | ||
f30c66ba HR |
1236 | bdrv_refresh_filename(backing_hd); |
1237 | ||
db95dbba | 1238 | parent->open_flags &= ~BDRV_O_NO_BACKING; |
db95dbba KW |
1239 | |
1240 | bdrv_op_block_all(backing_hd, parent->backing_blocker); | |
1241 | /* Otherwise we won't be able to commit or stream */ | |
1242 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_COMMIT_TARGET, | |
1243 | parent->backing_blocker); | |
1244 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_STREAM, | |
1245 | parent->backing_blocker); | |
1246 | /* | |
1247 | * We do backup in 3 ways: | |
1248 | * 1. drive backup | |
1249 | * The target bs is new opened, and the source is top BDS | |
1250 | * 2. blockdev backup | |
1251 | * Both the source and the target are top BDSes. | |
1252 | * 3. internal backup(used for block replication) | |
1253 | * Both the source and the target are backing file | |
1254 | * | |
1255 | * In case 1 and 2, neither the source nor the target is the backing file. | |
1256 | * In case 3, we will block the top BDS, so there is only one block job | |
1257 | * for the top BDS and its backing chain. | |
1258 | */ | |
1259 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_SOURCE, | |
1260 | parent->backing_blocker); | |
1261 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_TARGET, | |
1262 | parent->backing_blocker); | |
ca2f1234 | 1263 | } |
d736f119 | 1264 | |
db95dbba KW |
1265 | static void bdrv_backing_detach(BdrvChild *c) |
1266 | { | |
1267 | BlockDriverState *parent = c->opaque; | |
1268 | ||
1269 | assert(parent->backing_blocker); | |
1270 | bdrv_op_unblock_all(c->bs, parent->backing_blocker); | |
1271 | error_free(parent->backing_blocker); | |
1272 | parent->backing_blocker = NULL; | |
48e08288 | 1273 | } |
d736f119 | 1274 | |
6858eba0 KW |
1275 | static int bdrv_backing_update_filename(BdrvChild *c, BlockDriverState *base, |
1276 | const char *filename, Error **errp) | |
1277 | { | |
1278 | BlockDriverState *parent = c->opaque; | |
e94d3dba | 1279 | bool read_only = bdrv_is_read_only(parent); |
6858eba0 KW |
1280 | int ret; |
1281 | ||
e94d3dba AG |
1282 | if (read_only) { |
1283 | ret = bdrv_reopen_set_read_only(parent, false, errp); | |
61f09cea KW |
1284 | if (ret < 0) { |
1285 | return ret; | |
1286 | } | |
1287 | } | |
1288 | ||
6858eba0 | 1289 | ret = bdrv_change_backing_file(parent, filename, |
e54ee1b3 EB |
1290 | base->drv ? base->drv->format_name : "", |
1291 | false); | |
6858eba0 | 1292 | if (ret < 0) { |
64730694 | 1293 | error_setg_errno(errp, -ret, "Could not update backing file link"); |
6858eba0 KW |
1294 | } |
1295 | ||
e94d3dba AG |
1296 | if (read_only) { |
1297 | bdrv_reopen_set_read_only(parent, true, NULL); | |
61f09cea KW |
1298 | } |
1299 | ||
6858eba0 KW |
1300 | return ret; |
1301 | } | |
1302 | ||
fae8bd39 HR |
1303 | /* |
1304 | * Returns the options and flags that a generic child of a BDS should | |
1305 | * get, based on the given options and flags for the parent BDS. | |
1306 | */ | |
00ff7ffd HR |
1307 | static void bdrv_inherited_options(BdrvChildRole role, bool parent_is_format, |
1308 | int *child_flags, QDict *child_options, | |
1309 | int parent_flags, QDict *parent_options) | |
fae8bd39 HR |
1310 | { |
1311 | int flags = parent_flags; | |
1312 | ||
1313 | /* | |
1314 | * First, decide whether to set, clear, or leave BDRV_O_PROTOCOL. | |
1315 | * Generally, the question to answer is: Should this child be | |
1316 | * format-probed by default? | |
1317 | */ | |
1318 | ||
1319 | /* | |
1320 | * Pure and non-filtered data children of non-format nodes should | |
1321 | * be probed by default (even when the node itself has BDRV_O_PROTOCOL | |
1322 | * set). This only affects a very limited set of drivers (namely | |
1323 | * quorum and blkverify when this comment was written). | |
1324 | * Force-clear BDRV_O_PROTOCOL then. | |
1325 | */ | |
1326 | if (!parent_is_format && | |
1327 | (role & BDRV_CHILD_DATA) && | |
1328 | !(role & (BDRV_CHILD_METADATA | BDRV_CHILD_FILTERED))) | |
1329 | { | |
1330 | flags &= ~BDRV_O_PROTOCOL; | |
1331 | } | |
1332 | ||
1333 | /* | |
1334 | * All children of format nodes (except for COW children) and all | |
1335 | * metadata children in general should never be format-probed. | |
1336 | * Force-set BDRV_O_PROTOCOL then. | |
1337 | */ | |
1338 | if ((parent_is_format && !(role & BDRV_CHILD_COW)) || | |
1339 | (role & BDRV_CHILD_METADATA)) | |
1340 | { | |
1341 | flags |= BDRV_O_PROTOCOL; | |
1342 | } | |
1343 | ||
1344 | /* | |
1345 | * If the cache mode isn't explicitly set, inherit direct and no-flush from | |
1346 | * the parent. | |
1347 | */ | |
1348 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT); | |
1349 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH); | |
1350 | qdict_copy_default(child_options, parent_options, BDRV_OPT_FORCE_SHARE); | |
1351 | ||
1352 | if (role & BDRV_CHILD_COW) { | |
1353 | /* backing files are opened read-only by default */ | |
1354 | qdict_set_default_str(child_options, BDRV_OPT_READ_ONLY, "on"); | |
1355 | qdict_set_default_str(child_options, BDRV_OPT_AUTO_READ_ONLY, "off"); | |
1356 | } else { | |
1357 | /* Inherit the read-only option from the parent if it's not set */ | |
1358 | qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY); | |
1359 | qdict_copy_default(child_options, parent_options, | |
1360 | BDRV_OPT_AUTO_READ_ONLY); | |
1361 | } | |
1362 | ||
1363 | /* | |
1364 | * bdrv_co_pdiscard() respects unmap policy for the parent, so we | |
1365 | * can default to enable it on lower layers regardless of the | |
1366 | * parent option. | |
1367 | */ | |
1368 | qdict_set_default_str(child_options, BDRV_OPT_DISCARD, "unmap"); | |
1369 | ||
1370 | /* Clear flags that only apply to the top layer */ | |
1371 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ); | |
1372 | ||
1373 | if (role & BDRV_CHILD_METADATA) { | |
1374 | flags &= ~BDRV_O_NO_IO; | |
1375 | } | |
1376 | if (role & BDRV_CHILD_COW) { | |
1377 | flags &= ~BDRV_O_TEMPORARY; | |
1378 | } | |
1379 | ||
1380 | *child_flags = flags; | |
1381 | } | |
1382 | ||
ca2f1234 HR |
1383 | static void bdrv_child_cb_attach(BdrvChild *child) |
1384 | { | |
1385 | BlockDriverState *bs = child->opaque; | |
1386 | ||
1387 | if (child->role & BDRV_CHILD_COW) { | |
1388 | bdrv_backing_attach(child); | |
1389 | } | |
1390 | ||
1391 | bdrv_apply_subtree_drain(child, bs); | |
1392 | } | |
1393 | ||
48e08288 HR |
1394 | static void bdrv_child_cb_detach(BdrvChild *child) |
1395 | { | |
1396 | BlockDriverState *bs = child->opaque; | |
1397 | ||
1398 | if (child->role & BDRV_CHILD_COW) { | |
1399 | bdrv_backing_detach(child); | |
1400 | } | |
1401 | ||
1402 | bdrv_unapply_subtree_drain(child, bs); | |
1403 | } | |
1404 | ||
43483550 HR |
1405 | static int bdrv_child_cb_update_filename(BdrvChild *c, BlockDriverState *base, |
1406 | const char *filename, Error **errp) | |
1407 | { | |
1408 | if (c->role & BDRV_CHILD_COW) { | |
1409 | return bdrv_backing_update_filename(c, base, filename, errp); | |
1410 | } | |
1411 | return 0; | |
1412 | } | |
1413 | ||
fb62b588 | 1414 | AioContext *child_of_bds_get_parent_aio_context(BdrvChild *c) |
3ca1f322 VSO |
1415 | { |
1416 | BlockDriverState *bs = c->opaque; | |
1417 | ||
1418 | return bdrv_get_aio_context(bs); | |
1419 | } | |
1420 | ||
43483550 HR |
1421 | const BdrvChildClass child_of_bds = { |
1422 | .parent_is_bds = true, | |
1423 | .get_parent_desc = bdrv_child_get_parent_desc, | |
1424 | .inherit_options = bdrv_inherited_options, | |
1425 | .drained_begin = bdrv_child_cb_drained_begin, | |
1426 | .drained_poll = bdrv_child_cb_drained_poll, | |
1427 | .drained_end = bdrv_child_cb_drained_end, | |
1428 | .attach = bdrv_child_cb_attach, | |
1429 | .detach = bdrv_child_cb_detach, | |
1430 | .inactivate = bdrv_child_cb_inactivate, | |
1431 | .can_set_aio_ctx = bdrv_child_cb_can_set_aio_ctx, | |
1432 | .set_aio_ctx = bdrv_child_cb_set_aio_ctx, | |
1433 | .update_filename = bdrv_child_cb_update_filename, | |
fb62b588 | 1434 | .get_parent_aio_context = child_of_bds_get_parent_aio_context, |
43483550 HR |
1435 | }; |
1436 | ||
3ca1f322 VSO |
1437 | AioContext *bdrv_child_get_parent_aio_context(BdrvChild *c) |
1438 | { | |
1439 | return c->klass->get_parent_aio_context(c); | |
1440 | } | |
1441 | ||
7b272452 KW |
1442 | static int bdrv_open_flags(BlockDriverState *bs, int flags) |
1443 | { | |
61de4c68 | 1444 | int open_flags = flags; |
7b272452 KW |
1445 | |
1446 | /* | |
1447 | * Clear flags that are internal to the block layer before opening the | |
1448 | * image. | |
1449 | */ | |
20cca275 | 1450 | open_flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_PROTOCOL); |
7b272452 | 1451 | |
7b272452 KW |
1452 | return open_flags; |
1453 | } | |
1454 | ||
91a097e7 KW |
1455 | static void update_flags_from_options(int *flags, QemuOpts *opts) |
1456 | { | |
2a3d4331 | 1457 | *flags &= ~(BDRV_O_CACHE_MASK | BDRV_O_RDWR | BDRV_O_AUTO_RDONLY); |
91a097e7 | 1458 | |
57f9db9a | 1459 | if (qemu_opt_get_bool_del(opts, BDRV_OPT_CACHE_NO_FLUSH, false)) { |
91a097e7 KW |
1460 | *flags |= BDRV_O_NO_FLUSH; |
1461 | } | |
1462 | ||
57f9db9a | 1463 | if (qemu_opt_get_bool_del(opts, BDRV_OPT_CACHE_DIRECT, false)) { |
91a097e7 KW |
1464 | *flags |= BDRV_O_NOCACHE; |
1465 | } | |
f87a0e29 | 1466 | |
57f9db9a | 1467 | if (!qemu_opt_get_bool_del(opts, BDRV_OPT_READ_ONLY, false)) { |
f87a0e29 AG |
1468 | *flags |= BDRV_O_RDWR; |
1469 | } | |
1470 | ||
e35bdc12 KW |
1471 | if (qemu_opt_get_bool_del(opts, BDRV_OPT_AUTO_READ_ONLY, false)) { |
1472 | *flags |= BDRV_O_AUTO_RDONLY; | |
1473 | } | |
91a097e7 KW |
1474 | } |
1475 | ||
1476 | static void update_options_from_flags(QDict *options, int flags) | |
1477 | { | |
91a097e7 | 1478 | if (!qdict_haskey(options, BDRV_OPT_CACHE_DIRECT)) { |
46f5ac20 | 1479 | qdict_put_bool(options, BDRV_OPT_CACHE_DIRECT, flags & BDRV_O_NOCACHE); |
91a097e7 KW |
1480 | } |
1481 | if (!qdict_haskey(options, BDRV_OPT_CACHE_NO_FLUSH)) { | |
46f5ac20 EB |
1482 | qdict_put_bool(options, BDRV_OPT_CACHE_NO_FLUSH, |
1483 | flags & BDRV_O_NO_FLUSH); | |
91a097e7 | 1484 | } |
f87a0e29 | 1485 | if (!qdict_haskey(options, BDRV_OPT_READ_ONLY)) { |
46f5ac20 | 1486 | qdict_put_bool(options, BDRV_OPT_READ_ONLY, !(flags & BDRV_O_RDWR)); |
f87a0e29 | 1487 | } |
e35bdc12 KW |
1488 | if (!qdict_haskey(options, BDRV_OPT_AUTO_READ_ONLY)) { |
1489 | qdict_put_bool(options, BDRV_OPT_AUTO_READ_ONLY, | |
1490 | flags & BDRV_O_AUTO_RDONLY); | |
1491 | } | |
91a097e7 KW |
1492 | } |
1493 | ||
636ea370 KW |
1494 | static void bdrv_assign_node_name(BlockDriverState *bs, |
1495 | const char *node_name, | |
1496 | Error **errp) | |
6913c0c2 | 1497 | { |
15489c76 | 1498 | char *gen_node_name = NULL; |
6913c0c2 | 1499 | |
15489c76 JC |
1500 | if (!node_name) { |
1501 | node_name = gen_node_name = id_generate(ID_BLOCK); | |
1502 | } else if (!id_wellformed(node_name)) { | |
1503 | /* | |
1504 | * Check for empty string or invalid characters, but not if it is | |
1505 | * generated (generated names use characters not available to the user) | |
1506 | */ | |
785ec4b1 | 1507 | error_setg(errp, "Invalid node-name: '%s'", node_name); |
636ea370 | 1508 | return; |
6913c0c2 BC |
1509 | } |
1510 | ||
0c5e94ee | 1511 | /* takes care of avoiding namespaces collisions */ |
7f06d47e | 1512 | if (blk_by_name(node_name)) { |
0c5e94ee BC |
1513 | error_setg(errp, "node-name=%s is conflicting with a device id", |
1514 | node_name); | |
15489c76 | 1515 | goto out; |
0c5e94ee BC |
1516 | } |
1517 | ||
6913c0c2 BC |
1518 | /* takes care of avoiding duplicates node names */ |
1519 | if (bdrv_find_node(node_name)) { | |
785ec4b1 | 1520 | error_setg(errp, "Duplicate nodes with node-name='%s'", node_name); |
15489c76 | 1521 | goto out; |
6913c0c2 BC |
1522 | } |
1523 | ||
824808dd KW |
1524 | /* Make sure that the node name isn't truncated */ |
1525 | if (strlen(node_name) >= sizeof(bs->node_name)) { | |
1526 | error_setg(errp, "Node name too long"); | |
1527 | goto out; | |
1528 | } | |
1529 | ||
6913c0c2 BC |
1530 | /* copy node name into the bs and insert it into the graph list */ |
1531 | pstrcpy(bs->node_name, sizeof(bs->node_name), node_name); | |
1532 | QTAILQ_INSERT_TAIL(&graph_bdrv_states, bs, node_list); | |
15489c76 JC |
1533 | out: |
1534 | g_free(gen_node_name); | |
6913c0c2 BC |
1535 | } |
1536 | ||
01a56501 KW |
1537 | static int bdrv_open_driver(BlockDriverState *bs, BlockDriver *drv, |
1538 | const char *node_name, QDict *options, | |
1539 | int open_flags, Error **errp) | |
1540 | { | |
1541 | Error *local_err = NULL; | |
0f12264e | 1542 | int i, ret; |
01a56501 KW |
1543 | |
1544 | bdrv_assign_node_name(bs, node_name, &local_err); | |
1545 | if (local_err) { | |
1546 | error_propagate(errp, local_err); | |
1547 | return -EINVAL; | |
1548 | } | |
1549 | ||
1550 | bs->drv = drv; | |
1551 | bs->opaque = g_malloc0(drv->instance_size); | |
1552 | ||
1553 | if (drv->bdrv_file_open) { | |
1554 | assert(!drv->bdrv_needs_filename || bs->filename[0]); | |
1555 | ret = drv->bdrv_file_open(bs, options, open_flags, &local_err); | |
680c7f96 | 1556 | } else if (drv->bdrv_open) { |
01a56501 | 1557 | ret = drv->bdrv_open(bs, options, open_flags, &local_err); |
680c7f96 KW |
1558 | } else { |
1559 | ret = 0; | |
01a56501 KW |
1560 | } |
1561 | ||
1562 | if (ret < 0) { | |
1563 | if (local_err) { | |
1564 | error_propagate(errp, local_err); | |
1565 | } else if (bs->filename[0]) { | |
1566 | error_setg_errno(errp, -ret, "Could not open '%s'", bs->filename); | |
1567 | } else { | |
1568 | error_setg_errno(errp, -ret, "Could not open image"); | |
1569 | } | |
180ca19a | 1570 | goto open_failed; |
01a56501 KW |
1571 | } |
1572 | ||
1573 | ret = refresh_total_sectors(bs, bs->total_sectors); | |
1574 | if (ret < 0) { | |
1575 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); | |
180ca19a | 1576 | return ret; |
01a56501 KW |
1577 | } |
1578 | ||
1e4c797c | 1579 | bdrv_refresh_limits(bs, NULL, &local_err); |
01a56501 KW |
1580 | if (local_err) { |
1581 | error_propagate(errp, local_err); | |
180ca19a | 1582 | return -EINVAL; |
01a56501 KW |
1583 | } |
1584 | ||
1585 | assert(bdrv_opt_mem_align(bs) != 0); | |
1586 | assert(bdrv_min_mem_align(bs) != 0); | |
1587 | assert(is_power_of_2(bs->bl.request_alignment)); | |
1588 | ||
0f12264e KW |
1589 | for (i = 0; i < bs->quiesce_counter; i++) { |
1590 | if (drv->bdrv_co_drain_begin) { | |
1591 | drv->bdrv_co_drain_begin(bs); | |
1592 | } | |
1593 | } | |
1594 | ||
01a56501 | 1595 | return 0; |
180ca19a MP |
1596 | open_failed: |
1597 | bs->drv = NULL; | |
1598 | if (bs->file != NULL) { | |
1599 | bdrv_unref_child(bs, bs->file); | |
1600 | bs->file = NULL; | |
1601 | } | |
01a56501 KW |
1602 | g_free(bs->opaque); |
1603 | bs->opaque = NULL; | |
01a56501 KW |
1604 | return ret; |
1605 | } | |
1606 | ||
621d1737 VSO |
1607 | /* |
1608 | * Create and open a block node. | |
1609 | * | |
1610 | * @options is a QDict of options to pass to the block drivers, or NULL for an | |
1611 | * empty set of options. The reference to the QDict belongs to the block layer | |
1612 | * after the call (even on failure), so if the caller intends to reuse the | |
1613 | * dictionary, it needs to use qobject_ref() before calling bdrv_open. | |
1614 | */ | |
1615 | BlockDriverState *bdrv_new_open_driver_opts(BlockDriver *drv, | |
1616 | const char *node_name, | |
1617 | QDict *options, int flags, | |
1618 | Error **errp) | |
680c7f96 KW |
1619 | { |
1620 | BlockDriverState *bs; | |
1621 | int ret; | |
1622 | ||
1623 | bs = bdrv_new(); | |
1624 | bs->open_flags = flags; | |
621d1737 VSO |
1625 | bs->options = options ?: qdict_new(); |
1626 | bs->explicit_options = qdict_clone_shallow(bs->options); | |
680c7f96 KW |
1627 | bs->opaque = NULL; |
1628 | ||
1629 | update_options_from_flags(bs->options, flags); | |
1630 | ||
1631 | ret = bdrv_open_driver(bs, drv, node_name, bs->options, flags, errp); | |
1632 | if (ret < 0) { | |
cb3e7f08 | 1633 | qobject_unref(bs->explicit_options); |
180ca19a | 1634 | bs->explicit_options = NULL; |
cb3e7f08 | 1635 | qobject_unref(bs->options); |
180ca19a | 1636 | bs->options = NULL; |
680c7f96 KW |
1637 | bdrv_unref(bs); |
1638 | return NULL; | |
1639 | } | |
1640 | ||
1641 | return bs; | |
1642 | } | |
1643 | ||
621d1737 VSO |
1644 | /* Create and open a block node. */ |
1645 | BlockDriverState *bdrv_new_open_driver(BlockDriver *drv, const char *node_name, | |
1646 | int flags, Error **errp) | |
1647 | { | |
1648 | return bdrv_new_open_driver_opts(drv, node_name, NULL, flags, errp); | |
1649 | } | |
1650 | ||
c5f3014b | 1651 | QemuOptsList bdrv_runtime_opts = { |
18edf289 KW |
1652 | .name = "bdrv_common", |
1653 | .head = QTAILQ_HEAD_INITIALIZER(bdrv_runtime_opts.head), | |
1654 | .desc = { | |
1655 | { | |
1656 | .name = "node-name", | |
1657 | .type = QEMU_OPT_STRING, | |
1658 | .help = "Node name of the block device node", | |
1659 | }, | |
62392ebb KW |
1660 | { |
1661 | .name = "driver", | |
1662 | .type = QEMU_OPT_STRING, | |
1663 | .help = "Block driver to use for the node", | |
1664 | }, | |
91a097e7 KW |
1665 | { |
1666 | .name = BDRV_OPT_CACHE_DIRECT, | |
1667 | .type = QEMU_OPT_BOOL, | |
1668 | .help = "Bypass software writeback cache on the host", | |
1669 | }, | |
1670 | { | |
1671 | .name = BDRV_OPT_CACHE_NO_FLUSH, | |
1672 | .type = QEMU_OPT_BOOL, | |
1673 | .help = "Ignore flush requests", | |
1674 | }, | |
f87a0e29 AG |
1675 | { |
1676 | .name = BDRV_OPT_READ_ONLY, | |
1677 | .type = QEMU_OPT_BOOL, | |
1678 | .help = "Node is opened in read-only mode", | |
1679 | }, | |
e35bdc12 KW |
1680 | { |
1681 | .name = BDRV_OPT_AUTO_READ_ONLY, | |
1682 | .type = QEMU_OPT_BOOL, | |
1683 | .help = "Node can become read-only if opening read-write fails", | |
1684 | }, | |
692e01a2 KW |
1685 | { |
1686 | .name = "detect-zeroes", | |
1687 | .type = QEMU_OPT_STRING, | |
1688 | .help = "try to optimize zero writes (off, on, unmap)", | |
1689 | }, | |
818584a4 | 1690 | { |
415bbca8 | 1691 | .name = BDRV_OPT_DISCARD, |
818584a4 KW |
1692 | .type = QEMU_OPT_STRING, |
1693 | .help = "discard operation (ignore/off, unmap/on)", | |
1694 | }, | |
5a9347c6 FZ |
1695 | { |
1696 | .name = BDRV_OPT_FORCE_SHARE, | |
1697 | .type = QEMU_OPT_BOOL, | |
1698 | .help = "always accept other writers (default: off)", | |
1699 | }, | |
18edf289 KW |
1700 | { /* end of list */ } |
1701 | }, | |
1702 | }; | |
1703 | ||
5a5e7f8c ML |
1704 | QemuOptsList bdrv_create_opts_simple = { |
1705 | .name = "simple-create-opts", | |
1706 | .head = QTAILQ_HEAD_INITIALIZER(bdrv_create_opts_simple.head), | |
fd17146c HR |
1707 | .desc = { |
1708 | { | |
1709 | .name = BLOCK_OPT_SIZE, | |
1710 | .type = QEMU_OPT_SIZE, | |
1711 | .help = "Virtual disk size" | |
1712 | }, | |
1713 | { | |
1714 | .name = BLOCK_OPT_PREALLOC, | |
1715 | .type = QEMU_OPT_STRING, | |
1716 | .help = "Preallocation mode (allowed values: off)" | |
1717 | }, | |
1718 | { /* end of list */ } | |
1719 | } | |
1720 | }; | |
1721 | ||
57915332 KW |
1722 | /* |
1723 | * Common part for opening disk images and files | |
b6ad491a KW |
1724 | * |
1725 | * Removes all processed options from *options. | |
57915332 | 1726 | */ |
5696c6e3 | 1727 | static int bdrv_open_common(BlockDriverState *bs, BlockBackend *file, |
82dc8b41 | 1728 | QDict *options, Error **errp) |
57915332 KW |
1729 | { |
1730 | int ret, open_flags; | |
035fccdf | 1731 | const char *filename; |
62392ebb | 1732 | const char *driver_name = NULL; |
6913c0c2 | 1733 | const char *node_name = NULL; |
818584a4 | 1734 | const char *discard; |
18edf289 | 1735 | QemuOpts *opts; |
62392ebb | 1736 | BlockDriver *drv; |
34b5d2c6 | 1737 | Error *local_err = NULL; |
307261b2 | 1738 | bool ro; |
57915332 | 1739 | |
6405875c | 1740 | assert(bs->file == NULL); |
707ff828 | 1741 | assert(options != NULL && bs->options != options); |
57915332 | 1742 | |
62392ebb | 1743 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); |
af175e85 | 1744 | if (!qemu_opts_absorb_qdict(opts, options, errp)) { |
62392ebb KW |
1745 | ret = -EINVAL; |
1746 | goto fail_opts; | |
1747 | } | |
1748 | ||
9b7e8691 AG |
1749 | update_flags_from_options(&bs->open_flags, opts); |
1750 | ||
62392ebb KW |
1751 | driver_name = qemu_opt_get(opts, "driver"); |
1752 | drv = bdrv_find_format(driver_name); | |
1753 | assert(drv != NULL); | |
1754 | ||
5a9347c6 FZ |
1755 | bs->force_share = qemu_opt_get_bool(opts, BDRV_OPT_FORCE_SHARE, false); |
1756 | ||
1757 | if (bs->force_share && (bs->open_flags & BDRV_O_RDWR)) { | |
1758 | error_setg(errp, | |
1759 | BDRV_OPT_FORCE_SHARE | |
1760 | "=on can only be used with read-only images"); | |
1761 | ret = -EINVAL; | |
1762 | goto fail_opts; | |
1763 | } | |
1764 | ||
45673671 | 1765 | if (file != NULL) { |
f30c66ba | 1766 | bdrv_refresh_filename(blk_bs(file)); |
5696c6e3 | 1767 | filename = blk_bs(file)->filename; |
45673671 | 1768 | } else { |
129c7d1c MA |
1769 | /* |
1770 | * Caution: while qdict_get_try_str() is fine, getting | |
1771 | * non-string types would require more care. When @options | |
1772 | * come from -blockdev or blockdev_add, its members are typed | |
1773 | * according to the QAPI schema, but when they come from | |
1774 | * -drive, they're all QString. | |
1775 | */ | |
45673671 KW |
1776 | filename = qdict_get_try_str(options, "filename"); |
1777 | } | |
1778 | ||
4a008240 | 1779 | if (drv->bdrv_needs_filename && (!filename || !filename[0])) { |
765003db KW |
1780 | error_setg(errp, "The '%s' block driver requires a file name", |
1781 | drv->format_name); | |
18edf289 KW |
1782 | ret = -EINVAL; |
1783 | goto fail_opts; | |
6913c0c2 | 1784 | } |
6913c0c2 | 1785 | |
82dc8b41 KW |
1786 | trace_bdrv_open_common(bs, filename ?: "", bs->open_flags, |
1787 | drv->format_name); | |
62392ebb | 1788 | |
307261b2 VSO |
1789 | ro = bdrv_is_read_only(bs); |
1790 | ||
1791 | if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv, ro)) { | |
1792 | if (!ro && bdrv_is_whitelisted(drv, true)) { | |
8be25de6 KW |
1793 | ret = bdrv_apply_auto_read_only(bs, NULL, NULL); |
1794 | } else { | |
1795 | ret = -ENOTSUP; | |
1796 | } | |
1797 | if (ret < 0) { | |
1798 | error_setg(errp, | |
307261b2 | 1799 | !ro && bdrv_is_whitelisted(drv, true) |
8be25de6 KW |
1800 | ? "Driver '%s' can only be used for read-only devices" |
1801 | : "Driver '%s' is not whitelisted", | |
1802 | drv->format_name); | |
1803 | goto fail_opts; | |
1804 | } | |
b64ec4e4 | 1805 | } |
57915332 | 1806 | |
d3faa13e | 1807 | /* bdrv_new() and bdrv_close() make it so */ |
d73415a3 | 1808 | assert(qatomic_read(&bs->copy_on_read) == 0); |
d3faa13e | 1809 | |
82dc8b41 | 1810 | if (bs->open_flags & BDRV_O_COPY_ON_READ) { |
307261b2 | 1811 | if (!ro) { |
0ebd24e0 KW |
1812 | bdrv_enable_copy_on_read(bs); |
1813 | } else { | |
1814 | error_setg(errp, "Can't use copy-on-read on read-only device"); | |
18edf289 KW |
1815 | ret = -EINVAL; |
1816 | goto fail_opts; | |
0ebd24e0 | 1817 | } |
53fec9d3 SH |
1818 | } |
1819 | ||
415bbca8 | 1820 | discard = qemu_opt_get(opts, BDRV_OPT_DISCARD); |
818584a4 KW |
1821 | if (discard != NULL) { |
1822 | if (bdrv_parse_discard_flags(discard, &bs->open_flags) != 0) { | |
1823 | error_setg(errp, "Invalid discard option"); | |
1824 | ret = -EINVAL; | |
1825 | goto fail_opts; | |
1826 | } | |
1827 | } | |
1828 | ||
543770bd AG |
1829 | bs->detect_zeroes = |
1830 | bdrv_parse_detect_zeroes(opts, bs->open_flags, &local_err); | |
1831 | if (local_err) { | |
1832 | error_propagate(errp, local_err); | |
1833 | ret = -EINVAL; | |
1834 | goto fail_opts; | |
692e01a2 KW |
1835 | } |
1836 | ||
c2ad1b0c KW |
1837 | if (filename != NULL) { |
1838 | pstrcpy(bs->filename, sizeof(bs->filename), filename); | |
1839 | } else { | |
1840 | bs->filename[0] = '\0'; | |
1841 | } | |
91af7014 | 1842 | pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), bs->filename); |
57915332 | 1843 | |
66f82cee | 1844 | /* Open the image, either directly or using a protocol */ |
82dc8b41 | 1845 | open_flags = bdrv_open_flags(bs, bs->open_flags); |
01a56501 | 1846 | node_name = qemu_opt_get(opts, "node-name"); |
57915332 | 1847 | |
01a56501 KW |
1848 | assert(!drv->bdrv_file_open || file == NULL); |
1849 | ret = bdrv_open_driver(bs, drv, node_name, options, open_flags, errp); | |
51762288 | 1850 | if (ret < 0) { |
01a56501 | 1851 | goto fail_opts; |
3baca891 KW |
1852 | } |
1853 | ||
18edf289 | 1854 | qemu_opts_del(opts); |
57915332 KW |
1855 | return 0; |
1856 | ||
18edf289 KW |
1857 | fail_opts: |
1858 | qemu_opts_del(opts); | |
57915332 KW |
1859 | return ret; |
1860 | } | |
1861 | ||
5e5c4f63 KW |
1862 | static QDict *parse_json_filename(const char *filename, Error **errp) |
1863 | { | |
1864 | QObject *options_obj; | |
1865 | QDict *options; | |
1866 | int ret; | |
1867 | ||
1868 | ret = strstart(filename, "json:", &filename); | |
1869 | assert(ret); | |
1870 | ||
5577fff7 | 1871 | options_obj = qobject_from_json(filename, errp); |
5e5c4f63 | 1872 | if (!options_obj) { |
5577fff7 | 1873 | error_prepend(errp, "Could not parse the JSON options: "); |
5e5c4f63 KW |
1874 | return NULL; |
1875 | } | |
1876 | ||
7dc847eb | 1877 | options = qobject_to(QDict, options_obj); |
ca6b6e1e | 1878 | if (!options) { |
cb3e7f08 | 1879 | qobject_unref(options_obj); |
5e5c4f63 KW |
1880 | error_setg(errp, "Invalid JSON object given"); |
1881 | return NULL; | |
1882 | } | |
1883 | ||
5e5c4f63 KW |
1884 | qdict_flatten(options); |
1885 | ||
1886 | return options; | |
1887 | } | |
1888 | ||
de3b53f0 KW |
1889 | static void parse_json_protocol(QDict *options, const char **pfilename, |
1890 | Error **errp) | |
1891 | { | |
1892 | QDict *json_options; | |
1893 | Error *local_err = NULL; | |
1894 | ||
1895 | /* Parse json: pseudo-protocol */ | |
1896 | if (!*pfilename || !g_str_has_prefix(*pfilename, "json:")) { | |
1897 | return; | |
1898 | } | |
1899 | ||
1900 | json_options = parse_json_filename(*pfilename, &local_err); | |
1901 | if (local_err) { | |
1902 | error_propagate(errp, local_err); | |
1903 | return; | |
1904 | } | |
1905 | ||
1906 | /* Options given in the filename have lower priority than options | |
1907 | * specified directly */ | |
1908 | qdict_join(options, json_options, false); | |
cb3e7f08 | 1909 | qobject_unref(json_options); |
de3b53f0 KW |
1910 | *pfilename = NULL; |
1911 | } | |
1912 | ||
b6ce07aa | 1913 | /* |
f54120ff KW |
1914 | * Fills in default options for opening images and converts the legacy |
1915 | * filename/flags pair to option QDict entries. | |
53a29513 HR |
1916 | * The BDRV_O_PROTOCOL flag in *flags will be set or cleared accordingly if a |
1917 | * block driver has been specified explicitly. | |
b6ce07aa | 1918 | */ |
de3b53f0 | 1919 | static int bdrv_fill_options(QDict **options, const char *filename, |
053e1578 | 1920 | int *flags, Error **errp) |
ea2384d3 | 1921 | { |
c2ad1b0c | 1922 | const char *drvname; |
53a29513 | 1923 | bool protocol = *flags & BDRV_O_PROTOCOL; |
e3fa4bfa | 1924 | bool parse_filename = false; |
053e1578 | 1925 | BlockDriver *drv = NULL; |
34b5d2c6 | 1926 | Error *local_err = NULL; |
83f64091 | 1927 | |
129c7d1c MA |
1928 | /* |
1929 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
1930 | * types would require more care. When @options come from | |
1931 | * -blockdev or blockdev_add, its members are typed according to | |
1932 | * the QAPI schema, but when they come from -drive, they're all | |
1933 | * QString. | |
1934 | */ | |
53a29513 | 1935 | drvname = qdict_get_try_str(*options, "driver"); |
053e1578 HR |
1936 | if (drvname) { |
1937 | drv = bdrv_find_format(drvname); | |
1938 | if (!drv) { | |
1939 | error_setg(errp, "Unknown driver '%s'", drvname); | |
1940 | return -ENOENT; | |
1941 | } | |
1942 | /* If the user has explicitly specified the driver, this choice should | |
1943 | * override the BDRV_O_PROTOCOL flag */ | |
1944 | protocol = drv->bdrv_file_open; | |
53a29513 HR |
1945 | } |
1946 | ||
1947 | if (protocol) { | |
1948 | *flags |= BDRV_O_PROTOCOL; | |
1949 | } else { | |
1950 | *flags &= ~BDRV_O_PROTOCOL; | |
1951 | } | |
1952 | ||
91a097e7 KW |
1953 | /* Translate cache options from flags into options */ |
1954 | update_options_from_flags(*options, *flags); | |
1955 | ||
035fccdf | 1956 | /* Fetch the file name from the options QDict if necessary */ |
17b005f1 | 1957 | if (protocol && filename) { |
f54120ff | 1958 | if (!qdict_haskey(*options, "filename")) { |
46f5ac20 | 1959 | qdict_put_str(*options, "filename", filename); |
f54120ff KW |
1960 | parse_filename = true; |
1961 | } else { | |
1962 | error_setg(errp, "Can't specify 'file' and 'filename' options at " | |
1963 | "the same time"); | |
1964 | return -EINVAL; | |
1965 | } | |
035fccdf KW |
1966 | } |
1967 | ||
c2ad1b0c | 1968 | /* Find the right block driver */ |
129c7d1c | 1969 | /* See cautionary note on accessing @options above */ |
f54120ff | 1970 | filename = qdict_get_try_str(*options, "filename"); |
f54120ff | 1971 | |
053e1578 HR |
1972 | if (!drvname && protocol) { |
1973 | if (filename) { | |
1974 | drv = bdrv_find_protocol(filename, parse_filename, errp); | |
17b005f1 | 1975 | if (!drv) { |
053e1578 | 1976 | return -EINVAL; |
17b005f1 | 1977 | } |
053e1578 HR |
1978 | |
1979 | drvname = drv->format_name; | |
46f5ac20 | 1980 | qdict_put_str(*options, "driver", drvname); |
053e1578 HR |
1981 | } else { |
1982 | error_setg(errp, "Must specify either driver or file"); | |
1983 | return -EINVAL; | |
98289620 | 1984 | } |
c2ad1b0c KW |
1985 | } |
1986 | ||
17b005f1 | 1987 | assert(drv || !protocol); |
c2ad1b0c | 1988 | |
f54120ff | 1989 | /* Driver-specific filename parsing */ |
17b005f1 | 1990 | if (drv && drv->bdrv_parse_filename && parse_filename) { |
5acd9d81 | 1991 | drv->bdrv_parse_filename(filename, *options, &local_err); |
84d18f06 | 1992 | if (local_err) { |
34b5d2c6 | 1993 | error_propagate(errp, local_err); |
f54120ff | 1994 | return -EINVAL; |
6963a30d | 1995 | } |
cd5d031e HR |
1996 | |
1997 | if (!drv->bdrv_needs_filename) { | |
1998 | qdict_del(*options, "filename"); | |
cd5d031e | 1999 | } |
6963a30d KW |
2000 | } |
2001 | ||
f54120ff KW |
2002 | return 0; |
2003 | } | |
2004 | ||
148eb13c KW |
2005 | typedef struct BlockReopenQueueEntry { |
2006 | bool prepared; | |
69b736e7 | 2007 | bool perms_checked; |
148eb13c | 2008 | BDRVReopenState state; |
859443b0 | 2009 | QTAILQ_ENTRY(BlockReopenQueueEntry) entry; |
148eb13c KW |
2010 | } BlockReopenQueueEntry; |
2011 | ||
2012 | /* | |
2013 | * Return the flags that @bs will have after the reopens in @q have | |
2014 | * successfully completed. If @q is NULL (or @bs is not contained in @q), | |
2015 | * return the current flags. | |
2016 | */ | |
2017 | static int bdrv_reopen_get_flags(BlockReopenQueue *q, BlockDriverState *bs) | |
2018 | { | |
2019 | BlockReopenQueueEntry *entry; | |
2020 | ||
2021 | if (q != NULL) { | |
859443b0 | 2022 | QTAILQ_FOREACH(entry, q, entry) { |
148eb13c KW |
2023 | if (entry->state.bs == bs) { |
2024 | return entry->state.flags; | |
2025 | } | |
2026 | } | |
2027 | } | |
2028 | ||
2029 | return bs->open_flags; | |
2030 | } | |
2031 | ||
2032 | /* Returns whether the image file can be written to after the reopen queue @q | |
2033 | * has been successfully applied, or right now if @q is NULL. */ | |
cc022140 HR |
2034 | static bool bdrv_is_writable_after_reopen(BlockDriverState *bs, |
2035 | BlockReopenQueue *q) | |
148eb13c KW |
2036 | { |
2037 | int flags = bdrv_reopen_get_flags(q, bs); | |
2038 | ||
2039 | return (flags & (BDRV_O_RDWR | BDRV_O_INACTIVE)) == BDRV_O_RDWR; | |
2040 | } | |
2041 | ||
cc022140 HR |
2042 | /* |
2043 | * Return whether the BDS can be written to. This is not necessarily | |
2044 | * the same as !bdrv_is_read_only(bs), as inactivated images may not | |
2045 | * be written to but do not count as read-only images. | |
2046 | */ | |
2047 | bool bdrv_is_writable(BlockDriverState *bs) | |
2048 | { | |
2049 | return bdrv_is_writable_after_reopen(bs, NULL); | |
2050 | } | |
2051 | ||
3bf416ba VSO |
2052 | static char *bdrv_child_user_desc(BdrvChild *c) |
2053 | { | |
da261b69 | 2054 | return c->klass->get_parent_desc(c); |
3bf416ba VSO |
2055 | } |
2056 | ||
30ebb9aa VSO |
2057 | /* |
2058 | * Check that @a allows everything that @b needs. @a and @b must reference same | |
2059 | * child node. | |
2060 | */ | |
3bf416ba VSO |
2061 | static bool bdrv_a_allow_b(BdrvChild *a, BdrvChild *b, Error **errp) |
2062 | { | |
30ebb9aa VSO |
2063 | const char *child_bs_name; |
2064 | g_autofree char *a_user = NULL; | |
2065 | g_autofree char *b_user = NULL; | |
2066 | g_autofree char *perms = NULL; | |
2067 | ||
2068 | assert(a->bs); | |
2069 | assert(a->bs == b->bs); | |
3bf416ba VSO |
2070 | |
2071 | if ((b->perm & a->shared_perm) == b->perm) { | |
2072 | return true; | |
2073 | } | |
2074 | ||
30ebb9aa VSO |
2075 | child_bs_name = bdrv_get_node_name(b->bs); |
2076 | a_user = bdrv_child_user_desc(a); | |
2077 | b_user = bdrv_child_user_desc(b); | |
2078 | perms = bdrv_perm_names(b->perm & ~a->shared_perm); | |
2079 | ||
2080 | error_setg(errp, "Permission conflict on node '%s': permissions '%s' are " | |
2081 | "both required by %s (uses node '%s' as '%s' child) and " | |
2082 | "unshared by %s (uses node '%s' as '%s' child).", | |
2083 | child_bs_name, perms, | |
2084 | b_user, child_bs_name, b->name, | |
2085 | a_user, child_bs_name, a->name); | |
3bf416ba VSO |
2086 | |
2087 | return false; | |
2088 | } | |
2089 | ||
9397c14f | 2090 | static bool bdrv_parent_perms_conflict(BlockDriverState *bs, Error **errp) |
3bf416ba VSO |
2091 | { |
2092 | BdrvChild *a, *b; | |
2093 | ||
2094 | /* | |
2095 | * During the loop we'll look at each pair twice. That's correct because | |
2096 | * bdrv_a_allow_b() is asymmetric and we should check each pair in both | |
2097 | * directions. | |
2098 | */ | |
2099 | QLIST_FOREACH(a, &bs->parents, next_parent) { | |
2100 | QLIST_FOREACH(b, &bs->parents, next_parent) { | |
9397c14f | 2101 | if (a == b) { |
3bf416ba VSO |
2102 | continue; |
2103 | } | |
2104 | ||
2105 | if (!bdrv_a_allow_b(a, b, errp)) { | |
2106 | return true; | |
2107 | } | |
2108 | } | |
2109 | } | |
2110 | ||
2111 | return false; | |
2112 | } | |
2113 | ||
ffd1a5a2 | 2114 | static void bdrv_child_perm(BlockDriverState *bs, BlockDriverState *child_bs, |
e5d8a406 HR |
2115 | BdrvChild *c, BdrvChildRole role, |
2116 | BlockReopenQueue *reopen_queue, | |
ffd1a5a2 FZ |
2117 | uint64_t parent_perm, uint64_t parent_shared, |
2118 | uint64_t *nperm, uint64_t *nshared) | |
2119 | { | |
0b3ca76e | 2120 | assert(bs->drv && bs->drv->bdrv_child_perm); |
e5d8a406 | 2121 | bs->drv->bdrv_child_perm(bs, c, role, reopen_queue, |
0b3ca76e AG |
2122 | parent_perm, parent_shared, |
2123 | nperm, nshared); | |
e0995dc3 | 2124 | /* TODO Take force_share from reopen_queue */ |
ffd1a5a2 FZ |
2125 | if (child_bs && child_bs->force_share) { |
2126 | *nshared = BLK_PERM_ALL; | |
2127 | } | |
2128 | } | |
2129 | ||
bd57f8f7 VSO |
2130 | /* |
2131 | * Adds the whole subtree of @bs (including @bs itself) to the @list (except for | |
2132 | * nodes that are already in the @list, of course) so that final list is | |
2133 | * topologically sorted. Return the result (GSList @list object is updated, so | |
2134 | * don't use old reference after function call). | |
2135 | * | |
2136 | * On function start @list must be already topologically sorted and for any node | |
2137 | * in the @list the whole subtree of the node must be in the @list as well. The | |
2138 | * simplest way to satisfy this criteria: use only result of | |
2139 | * bdrv_topological_dfs() or NULL as @list parameter. | |
2140 | */ | |
2141 | static GSList *bdrv_topological_dfs(GSList *list, GHashTable *found, | |
2142 | BlockDriverState *bs) | |
2143 | { | |
2144 | BdrvChild *child; | |
2145 | g_autoptr(GHashTable) local_found = NULL; | |
2146 | ||
2147 | if (!found) { | |
2148 | assert(!list); | |
2149 | found = local_found = g_hash_table_new(NULL, NULL); | |
2150 | } | |
2151 | ||
2152 | if (g_hash_table_contains(found, bs)) { | |
2153 | return list; | |
2154 | } | |
2155 | g_hash_table_add(found, bs); | |
2156 | ||
2157 | QLIST_FOREACH(child, &bs->children, next) { | |
2158 | list = bdrv_topological_dfs(list, found, child->bs); | |
2159 | } | |
2160 | ||
2161 | return g_slist_prepend(list, bs); | |
2162 | } | |
2163 | ||
ecb776bd VSO |
2164 | typedef struct BdrvChildSetPermState { |
2165 | BdrvChild *child; | |
2166 | uint64_t old_perm; | |
2167 | uint64_t old_shared_perm; | |
2168 | } BdrvChildSetPermState; | |
b0defa83 VSO |
2169 | |
2170 | static void bdrv_child_set_perm_abort(void *opaque) | |
2171 | { | |
ecb776bd VSO |
2172 | BdrvChildSetPermState *s = opaque; |
2173 | ||
2174 | s->child->perm = s->old_perm; | |
2175 | s->child->shared_perm = s->old_shared_perm; | |
b0defa83 VSO |
2176 | } |
2177 | ||
2178 | static TransactionActionDrv bdrv_child_set_pem_drv = { | |
2179 | .abort = bdrv_child_set_perm_abort, | |
ecb776bd | 2180 | .clean = g_free, |
b0defa83 VSO |
2181 | }; |
2182 | ||
ecb776bd VSO |
2183 | static void bdrv_child_set_perm(BdrvChild *c, uint64_t perm, |
2184 | uint64_t shared, Transaction *tran) | |
b0defa83 | 2185 | { |
ecb776bd VSO |
2186 | BdrvChildSetPermState *s = g_new(BdrvChildSetPermState, 1); |
2187 | ||
2188 | *s = (BdrvChildSetPermState) { | |
2189 | .child = c, | |
2190 | .old_perm = c->perm, | |
2191 | .old_shared_perm = c->shared_perm, | |
2192 | }; | |
b0defa83 VSO |
2193 | |
2194 | c->perm = perm; | |
2195 | c->shared_perm = shared; | |
2196 | ||
ecb776bd | 2197 | tran_add(tran, &bdrv_child_set_pem_drv, s); |
b0defa83 VSO |
2198 | } |
2199 | ||
2513ef59 VSO |
2200 | static void bdrv_drv_set_perm_commit(void *opaque) |
2201 | { | |
2202 | BlockDriverState *bs = opaque; | |
2203 | uint64_t cumulative_perms, cumulative_shared_perms; | |
2204 | ||
2205 | if (bs->drv->bdrv_set_perm) { | |
2206 | bdrv_get_cumulative_perm(bs, &cumulative_perms, | |
2207 | &cumulative_shared_perms); | |
2208 | bs->drv->bdrv_set_perm(bs, cumulative_perms, cumulative_shared_perms); | |
2209 | } | |
2210 | } | |
2211 | ||
2212 | static void bdrv_drv_set_perm_abort(void *opaque) | |
2213 | { | |
2214 | BlockDriverState *bs = opaque; | |
2215 | ||
2216 | if (bs->drv->bdrv_abort_perm_update) { | |
2217 | bs->drv->bdrv_abort_perm_update(bs); | |
2218 | } | |
2219 | } | |
2220 | ||
2221 | TransactionActionDrv bdrv_drv_set_perm_drv = { | |
2222 | .abort = bdrv_drv_set_perm_abort, | |
2223 | .commit = bdrv_drv_set_perm_commit, | |
2224 | }; | |
2225 | ||
2226 | static int bdrv_drv_set_perm(BlockDriverState *bs, uint64_t perm, | |
2227 | uint64_t shared_perm, Transaction *tran, | |
2228 | Error **errp) | |
2229 | { | |
2230 | if (!bs->drv) { | |
2231 | return 0; | |
2232 | } | |
2233 | ||
2234 | if (bs->drv->bdrv_check_perm) { | |
2235 | int ret = bs->drv->bdrv_check_perm(bs, perm, shared_perm, errp); | |
2236 | if (ret < 0) { | |
2237 | return ret; | |
2238 | } | |
2239 | } | |
2240 | ||
2241 | if (tran) { | |
2242 | tran_add(tran, &bdrv_drv_set_perm_drv, bs); | |
2243 | } | |
2244 | ||
2245 | return 0; | |
2246 | } | |
2247 | ||
0978623e VSO |
2248 | typedef struct BdrvReplaceChildState { |
2249 | BdrvChild *child; | |
2250 | BlockDriverState *old_bs; | |
2251 | } BdrvReplaceChildState; | |
2252 | ||
2253 | static void bdrv_replace_child_commit(void *opaque) | |
2254 | { | |
2255 | BdrvReplaceChildState *s = opaque; | |
2256 | ||
2257 | bdrv_unref(s->old_bs); | |
2258 | } | |
2259 | ||
2260 | static void bdrv_replace_child_abort(void *opaque) | |
2261 | { | |
2262 | BdrvReplaceChildState *s = opaque; | |
2263 | BlockDriverState *new_bs = s->child->bs; | |
2264 | ||
2265 | /* old_bs reference is transparently moved from @s to @s->child */ | |
2266 | bdrv_replace_child_noperm(s->child, s->old_bs); | |
2267 | bdrv_unref(new_bs); | |
2268 | } | |
2269 | ||
2270 | static TransactionActionDrv bdrv_replace_child_drv = { | |
2271 | .commit = bdrv_replace_child_commit, | |
2272 | .abort = bdrv_replace_child_abort, | |
2273 | .clean = g_free, | |
2274 | }; | |
2275 | ||
2276 | /* | |
4bf021db | 2277 | * bdrv_replace_child_tran |
0978623e VSO |
2278 | * |
2279 | * Note: real unref of old_bs is done only on commit. | |
4bf021db VSO |
2280 | * |
2281 | * The function doesn't update permissions, caller is responsible for this. | |
0978623e | 2282 | */ |
4bf021db VSO |
2283 | static void bdrv_replace_child_tran(BdrvChild *child, BlockDriverState *new_bs, |
2284 | Transaction *tran) | |
0978623e VSO |
2285 | { |
2286 | BdrvReplaceChildState *s = g_new(BdrvReplaceChildState, 1); | |
2287 | *s = (BdrvReplaceChildState) { | |
2288 | .child = child, | |
2289 | .old_bs = child->bs, | |
2290 | }; | |
2291 | tran_add(tran, &bdrv_replace_child_drv, s); | |
2292 | ||
2293 | if (new_bs) { | |
2294 | bdrv_ref(new_bs); | |
2295 | } | |
2296 | bdrv_replace_child_noperm(child, new_bs); | |
2297 | /* old_bs reference is transparently moved from @child to @s */ | |
2298 | } | |
2299 | ||
33a610c3 | 2300 | /* |
c20555e1 VSO |
2301 | * Refresh permissions in @bs subtree. The function is intended to be called |
2302 | * after some graph modification that was done without permission update. | |
33a610c3 | 2303 | */ |
c20555e1 VSO |
2304 | static int bdrv_node_refresh_perm(BlockDriverState *bs, BlockReopenQueue *q, |
2305 | Transaction *tran, Error **errp) | |
33a610c3 KW |
2306 | { |
2307 | BlockDriver *drv = bs->drv; | |
2308 | BdrvChild *c; | |
2309 | int ret; | |
c20555e1 VSO |
2310 | uint64_t cumulative_perms, cumulative_shared_perms; |
2311 | ||
2312 | bdrv_get_cumulative_perm(bs, &cumulative_perms, &cumulative_shared_perms); | |
33a610c3 KW |
2313 | |
2314 | /* Write permissions never work with read-only images */ | |
2315 | if ((cumulative_perms & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED)) && | |
cc022140 | 2316 | !bdrv_is_writable_after_reopen(bs, q)) |
33a610c3 | 2317 | { |
481e0eee HR |
2318 | if (!bdrv_is_writable_after_reopen(bs, NULL)) { |
2319 | error_setg(errp, "Block node is read-only"); | |
2320 | } else { | |
c20555e1 VSO |
2321 | error_setg(errp, "Read-only block node '%s' cannot support " |
2322 | "read-write users", bdrv_get_node_name(bs)); | |
481e0eee HR |
2323 | } |
2324 | ||
33a610c3 KW |
2325 | return -EPERM; |
2326 | } | |
2327 | ||
9c60a5d1 KW |
2328 | /* |
2329 | * Unaligned requests will automatically be aligned to bl.request_alignment | |
2330 | * and without RESIZE we can't extend requests to write to space beyond the | |
2331 | * end of the image, so it's required that the image size is aligned. | |
2332 | */ | |
2333 | if ((cumulative_perms & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED)) && | |
2334 | !(cumulative_perms & BLK_PERM_RESIZE)) | |
2335 | { | |
2336 | if ((bs->total_sectors * BDRV_SECTOR_SIZE) % bs->bl.request_alignment) { | |
2337 | error_setg(errp, "Cannot get 'write' permission without 'resize': " | |
2338 | "Image size is not a multiple of request " | |
2339 | "alignment"); | |
2340 | return -EPERM; | |
2341 | } | |
2342 | } | |
2343 | ||
33a610c3 KW |
2344 | /* Check this node */ |
2345 | if (!drv) { | |
2346 | return 0; | |
2347 | } | |
2348 | ||
b1d2bbeb | 2349 | ret = bdrv_drv_set_perm(bs, cumulative_perms, cumulative_shared_perms, tran, |
2513ef59 VSO |
2350 | errp); |
2351 | if (ret < 0) { | |
2352 | return ret; | |
33a610c3 KW |
2353 | } |
2354 | ||
78e421c9 | 2355 | /* Drivers that never have children can omit .bdrv_child_perm() */ |
33a610c3 | 2356 | if (!drv->bdrv_child_perm) { |
78e421c9 | 2357 | assert(QLIST_EMPTY(&bs->children)); |
33a610c3 KW |
2358 | return 0; |
2359 | } | |
2360 | ||
2361 | /* Check all children */ | |
2362 | QLIST_FOREACH(c, &bs->children, next) { | |
2363 | uint64_t cur_perm, cur_shared; | |
9eab1544 | 2364 | |
e5d8a406 | 2365 | bdrv_child_perm(bs, c->bs, c, c->role, q, |
ffd1a5a2 FZ |
2366 | cumulative_perms, cumulative_shared_perms, |
2367 | &cur_perm, &cur_shared); | |
ecb776bd | 2368 | bdrv_child_set_perm(c, cur_perm, cur_shared, tran); |
bd57f8f7 VSO |
2369 | } |
2370 | ||
2371 | return 0; | |
2372 | } | |
3ef45e02 | 2373 | |
25409807 VSO |
2374 | static int bdrv_list_refresh_perms(GSList *list, BlockReopenQueue *q, |
2375 | Transaction *tran, Error **errp) | |
bd57f8f7 VSO |
2376 | { |
2377 | int ret; | |
b1d2bbeb | 2378 | BlockDriverState *bs; |
bd57f8f7 | 2379 | |
b1d2bbeb VSO |
2380 | for ( ; list; list = list->next) { |
2381 | bs = list->data; | |
2382 | ||
9397c14f | 2383 | if (bdrv_parent_perms_conflict(bs, errp)) { |
b1d2bbeb | 2384 | return -EINVAL; |
bd57f8f7 VSO |
2385 | } |
2386 | ||
c20555e1 | 2387 | ret = bdrv_node_refresh_perm(bs, q, tran, errp); |
33a610c3 KW |
2388 | if (ret < 0) { |
2389 | return ret; | |
2390 | } | |
2391 | } | |
2392 | ||
2393 | return 0; | |
2394 | } | |
2395 | ||
c7a0f2be KW |
2396 | void bdrv_get_cumulative_perm(BlockDriverState *bs, uint64_t *perm, |
2397 | uint64_t *shared_perm) | |
33a610c3 KW |
2398 | { |
2399 | BdrvChild *c; | |
2400 | uint64_t cumulative_perms = 0; | |
2401 | uint64_t cumulative_shared_perms = BLK_PERM_ALL; | |
2402 | ||
2403 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
2404 | cumulative_perms |= c->perm; | |
2405 | cumulative_shared_perms &= c->shared_perm; | |
2406 | } | |
2407 | ||
2408 | *perm = cumulative_perms; | |
2409 | *shared_perm = cumulative_shared_perms; | |
2410 | } | |
2411 | ||
5176196c | 2412 | char *bdrv_perm_names(uint64_t perm) |
d083319f KW |
2413 | { |
2414 | struct perm_name { | |
2415 | uint64_t perm; | |
2416 | const char *name; | |
2417 | } permissions[] = { | |
2418 | { BLK_PERM_CONSISTENT_READ, "consistent read" }, | |
2419 | { BLK_PERM_WRITE, "write" }, | |
2420 | { BLK_PERM_WRITE_UNCHANGED, "write unchanged" }, | |
2421 | { BLK_PERM_RESIZE, "resize" }, | |
2422 | { BLK_PERM_GRAPH_MOD, "change children" }, | |
2423 | { 0, NULL } | |
2424 | }; | |
2425 | ||
e2a7423a | 2426 | GString *result = g_string_sized_new(30); |
d083319f KW |
2427 | struct perm_name *p; |
2428 | ||
2429 | for (p = permissions; p->name; p++) { | |
2430 | if (perm & p->perm) { | |
e2a7423a AG |
2431 | if (result->len > 0) { |
2432 | g_string_append(result, ", "); | |
2433 | } | |
2434 | g_string_append(result, p->name); | |
d083319f KW |
2435 | } |
2436 | } | |
2437 | ||
e2a7423a | 2438 | return g_string_free(result, FALSE); |
d083319f KW |
2439 | } |
2440 | ||
33a610c3 | 2441 | |
071b474f | 2442 | static int bdrv_refresh_perms(BlockDriverState *bs, Error **errp) |
bb87e4d1 VSO |
2443 | { |
2444 | int ret; | |
b1d2bbeb VSO |
2445 | Transaction *tran = tran_new(); |
2446 | g_autoptr(GSList) list = bdrv_topological_dfs(NULL, NULL, bs); | |
bb87e4d1 | 2447 | |
b1d2bbeb VSO |
2448 | ret = bdrv_list_refresh_perms(list, NULL, tran, errp); |
2449 | tran_finalize(tran, ret); | |
bb87e4d1 | 2450 | |
b1d2bbeb | 2451 | return ret; |
bb87e4d1 VSO |
2452 | } |
2453 | ||
33a610c3 KW |
2454 | int bdrv_child_try_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared, |
2455 | Error **errp) | |
2456 | { | |
1046779e | 2457 | Error *local_err = NULL; |
83928dc4 | 2458 | Transaction *tran = tran_new(); |
33a610c3 KW |
2459 | int ret; |
2460 | ||
ecb776bd | 2461 | bdrv_child_set_perm(c, perm, shared, tran); |
83928dc4 VSO |
2462 | |
2463 | ret = bdrv_refresh_perms(c->bs, &local_err); | |
2464 | ||
2465 | tran_finalize(tran, ret); | |
2466 | ||
33a610c3 | 2467 | if (ret < 0) { |
071b474f VSO |
2468 | if ((perm & ~c->perm) || (c->shared_perm & ~shared)) { |
2469 | /* tighten permissions */ | |
1046779e HR |
2470 | error_propagate(errp, local_err); |
2471 | } else { | |
2472 | /* | |
2473 | * Our caller may intend to only loosen restrictions and | |
2474 | * does not expect this function to fail. Errors are not | |
2475 | * fatal in such a case, so we can just hide them from our | |
2476 | * caller. | |
2477 | */ | |
2478 | error_free(local_err); | |
2479 | ret = 0; | |
2480 | } | |
33a610c3 KW |
2481 | } |
2482 | ||
83928dc4 | 2483 | return ret; |
d5e6f437 KW |
2484 | } |
2485 | ||
c1087f12 HR |
2486 | int bdrv_child_refresh_perms(BlockDriverState *bs, BdrvChild *c, Error **errp) |
2487 | { | |
2488 | uint64_t parent_perms, parent_shared; | |
2489 | uint64_t perms, shared; | |
2490 | ||
2491 | bdrv_get_cumulative_perm(bs, &parent_perms, &parent_shared); | |
e5d8a406 | 2492 | bdrv_child_perm(bs, c->bs, c, c->role, NULL, |
bf8e925e | 2493 | parent_perms, parent_shared, &perms, &shared); |
c1087f12 HR |
2494 | |
2495 | return bdrv_child_try_set_perm(c, perms, shared, errp); | |
2496 | } | |
2497 | ||
87278af1 HR |
2498 | /* |
2499 | * Default implementation for .bdrv_child_perm() for block filters: | |
2500 | * Forward CONSISTENT_READ, WRITE, WRITE_UNCHANGED, and RESIZE to the | |
2501 | * filtered child. | |
2502 | */ | |
2503 | static void bdrv_filter_default_perms(BlockDriverState *bs, BdrvChild *c, | |
87278af1 HR |
2504 | BdrvChildRole role, |
2505 | BlockReopenQueue *reopen_queue, | |
2506 | uint64_t perm, uint64_t shared, | |
2507 | uint64_t *nperm, uint64_t *nshared) | |
6a1b9ee1 | 2508 | { |
e444fa83 KW |
2509 | *nperm = perm & DEFAULT_PERM_PASSTHROUGH; |
2510 | *nshared = (shared & DEFAULT_PERM_PASSTHROUGH) | DEFAULT_PERM_UNCHANGED; | |
6a1b9ee1 KW |
2511 | } |
2512 | ||
70082db4 | 2513 | static void bdrv_default_perms_for_cow(BlockDriverState *bs, BdrvChild *c, |
70082db4 HR |
2514 | BdrvChildRole role, |
2515 | BlockReopenQueue *reopen_queue, | |
2516 | uint64_t perm, uint64_t shared, | |
2517 | uint64_t *nperm, uint64_t *nshared) | |
2518 | { | |
e5d8a406 | 2519 | assert(role & BDRV_CHILD_COW); |
70082db4 HR |
2520 | |
2521 | /* | |
2522 | * We want consistent read from backing files if the parent needs it. | |
2523 | * No other operations are performed on backing files. | |
2524 | */ | |
2525 | perm &= BLK_PERM_CONSISTENT_READ; | |
2526 | ||
2527 | /* | |
2528 | * If the parent can deal with changing data, we're okay with a | |
2529 | * writable and resizable backing file. | |
2530 | * TODO Require !(perm & BLK_PERM_CONSISTENT_READ), too? | |
2531 | */ | |
2532 | if (shared & BLK_PERM_WRITE) { | |
2533 | shared = BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
2534 | } else { | |
2535 | shared = 0; | |
2536 | } | |
2537 | ||
2538 | shared |= BLK_PERM_CONSISTENT_READ | BLK_PERM_GRAPH_MOD | | |
2539 | BLK_PERM_WRITE_UNCHANGED; | |
2540 | ||
2541 | if (bs->open_flags & BDRV_O_INACTIVE) { | |
2542 | shared |= BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
2543 | } | |
2544 | ||
2545 | *nperm = perm; | |
2546 | *nshared = shared; | |
2547 | } | |
2548 | ||
6f838a4b | 2549 | static void bdrv_default_perms_for_storage(BlockDriverState *bs, BdrvChild *c, |
6f838a4b HR |
2550 | BdrvChildRole role, |
2551 | BlockReopenQueue *reopen_queue, | |
2552 | uint64_t perm, uint64_t shared, | |
2553 | uint64_t *nperm, uint64_t *nshared) | |
2554 | { | |
2555 | int flags; | |
2556 | ||
e5d8a406 | 2557 | assert(role & (BDRV_CHILD_METADATA | BDRV_CHILD_DATA)); |
6f838a4b HR |
2558 | |
2559 | flags = bdrv_reopen_get_flags(reopen_queue, bs); | |
2560 | ||
2561 | /* | |
2562 | * Apart from the modifications below, the same permissions are | |
2563 | * forwarded and left alone as for filters | |
2564 | */ | |
e5d8a406 | 2565 | bdrv_filter_default_perms(bs, c, role, reopen_queue, |
6f838a4b HR |
2566 | perm, shared, &perm, &shared); |
2567 | ||
f889054f HR |
2568 | if (role & BDRV_CHILD_METADATA) { |
2569 | /* Format drivers may touch metadata even if the guest doesn't write */ | |
2570 | if (bdrv_is_writable_after_reopen(bs, reopen_queue)) { | |
2571 | perm |= BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
2572 | } | |
2573 | ||
2574 | /* | |
2575 | * bs->file always needs to be consistent because of the | |
2576 | * metadata. We can never allow other users to resize or write | |
2577 | * to it. | |
2578 | */ | |
2579 | if (!(flags & BDRV_O_NO_IO)) { | |
2580 | perm |= BLK_PERM_CONSISTENT_READ; | |
2581 | } | |
2582 | shared &= ~(BLK_PERM_WRITE | BLK_PERM_RESIZE); | |
6f838a4b HR |
2583 | } |
2584 | ||
f889054f HR |
2585 | if (role & BDRV_CHILD_DATA) { |
2586 | /* | |
2587 | * Technically, everything in this block is a subset of the | |
2588 | * BDRV_CHILD_METADATA path taken above, and so this could | |
2589 | * be an "else if" branch. However, that is not obvious, and | |
2590 | * this function is not performance critical, therefore we let | |
2591 | * this be an independent "if". | |
2592 | */ | |
2593 | ||
2594 | /* | |
2595 | * We cannot allow other users to resize the file because the | |
2596 | * format driver might have some assumptions about the size | |
2597 | * (e.g. because it is stored in metadata, or because the file | |
2598 | * is split into fixed-size data files). | |
2599 | */ | |
2600 | shared &= ~BLK_PERM_RESIZE; | |
2601 | ||
2602 | /* | |
2603 | * WRITE_UNCHANGED often cannot be performed as such on the | |
2604 | * data file. For example, the qcow2 driver may still need to | |
2605 | * write copied clusters on copy-on-read. | |
2606 | */ | |
2607 | if (perm & BLK_PERM_WRITE_UNCHANGED) { | |
2608 | perm |= BLK_PERM_WRITE; | |
2609 | } | |
2610 | ||
2611 | /* | |
2612 | * If the data file is written to, the format driver may | |
2613 | * expect to be able to resize it by writing beyond the EOF. | |
2614 | */ | |
2615 | if (perm & BLK_PERM_WRITE) { | |
2616 | perm |= BLK_PERM_RESIZE; | |
2617 | } | |
6f838a4b | 2618 | } |
6f838a4b HR |
2619 | |
2620 | if (bs->open_flags & BDRV_O_INACTIVE) { | |
2621 | shared |= BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
2622 | } | |
2623 | ||
2624 | *nperm = perm; | |
2625 | *nshared = shared; | |
2626 | } | |
2627 | ||
2519f549 | 2628 | void bdrv_default_perms(BlockDriverState *bs, BdrvChild *c, |
e5d8a406 | 2629 | BdrvChildRole role, BlockReopenQueue *reopen_queue, |
2519f549 HR |
2630 | uint64_t perm, uint64_t shared, |
2631 | uint64_t *nperm, uint64_t *nshared) | |
2632 | { | |
2519f549 HR |
2633 | if (role & BDRV_CHILD_FILTERED) { |
2634 | assert(!(role & (BDRV_CHILD_DATA | BDRV_CHILD_METADATA | | |
2635 | BDRV_CHILD_COW))); | |
e5d8a406 | 2636 | bdrv_filter_default_perms(bs, c, role, reopen_queue, |
2519f549 HR |
2637 | perm, shared, nperm, nshared); |
2638 | } else if (role & BDRV_CHILD_COW) { | |
2639 | assert(!(role & (BDRV_CHILD_DATA | BDRV_CHILD_METADATA))); | |
e5d8a406 | 2640 | bdrv_default_perms_for_cow(bs, c, role, reopen_queue, |
2519f549 HR |
2641 | perm, shared, nperm, nshared); |
2642 | } else if (role & (BDRV_CHILD_METADATA | BDRV_CHILD_DATA)) { | |
e5d8a406 | 2643 | bdrv_default_perms_for_storage(bs, c, role, reopen_queue, |
2519f549 HR |
2644 | perm, shared, nperm, nshared); |
2645 | } else { | |
2646 | g_assert_not_reached(); | |
2647 | } | |
2648 | } | |
2649 | ||
7b1d9c4d HR |
2650 | uint64_t bdrv_qapi_perm_to_blk_perm(BlockPermission qapi_perm) |
2651 | { | |
2652 | static const uint64_t permissions[] = { | |
2653 | [BLOCK_PERMISSION_CONSISTENT_READ] = BLK_PERM_CONSISTENT_READ, | |
2654 | [BLOCK_PERMISSION_WRITE] = BLK_PERM_WRITE, | |
2655 | [BLOCK_PERMISSION_WRITE_UNCHANGED] = BLK_PERM_WRITE_UNCHANGED, | |
2656 | [BLOCK_PERMISSION_RESIZE] = BLK_PERM_RESIZE, | |
2657 | [BLOCK_PERMISSION_GRAPH_MOD] = BLK_PERM_GRAPH_MOD, | |
2658 | }; | |
2659 | ||
2660 | QEMU_BUILD_BUG_ON(ARRAY_SIZE(permissions) != BLOCK_PERMISSION__MAX); | |
2661 | QEMU_BUILD_BUG_ON(1UL << ARRAY_SIZE(permissions) != BLK_PERM_ALL + 1); | |
2662 | ||
2663 | assert(qapi_perm < BLOCK_PERMISSION__MAX); | |
2664 | ||
2665 | return permissions[qapi_perm]; | |
2666 | } | |
2667 | ||
8ee03995 KW |
2668 | static void bdrv_replace_child_noperm(BdrvChild *child, |
2669 | BlockDriverState *new_bs) | |
e9740bc6 KW |
2670 | { |
2671 | BlockDriverState *old_bs = child->bs; | |
debc2927 HR |
2672 | int new_bs_quiesce_counter; |
2673 | int drain_saldo; | |
e9740bc6 | 2674 | |
2cad1ebe AG |
2675 | assert(!child->frozen); |
2676 | ||
bb2614e9 FZ |
2677 | if (old_bs && new_bs) { |
2678 | assert(bdrv_get_aio_context(old_bs) == bdrv_get_aio_context(new_bs)); | |
2679 | } | |
debc2927 HR |
2680 | |
2681 | new_bs_quiesce_counter = (new_bs ? new_bs->quiesce_counter : 0); | |
2682 | drain_saldo = new_bs_quiesce_counter - child->parent_quiesce_counter; | |
2683 | ||
2684 | /* | |
2685 | * If the new child node is drained but the old one was not, flush | |
2686 | * all outstanding requests to the old child node. | |
2687 | */ | |
bd86fb99 | 2688 | while (drain_saldo > 0 && child->klass->drained_begin) { |
debc2927 HR |
2689 | bdrv_parent_drained_begin_single(child, true); |
2690 | drain_saldo--; | |
2691 | } | |
2692 | ||
e9740bc6 | 2693 | if (old_bs) { |
d736f119 KW |
2694 | /* Detach first so that the recursive drain sections coming from @child |
2695 | * are already gone and we only end the drain sections that came from | |
2696 | * elsewhere. */ | |
bd86fb99 HR |
2697 | if (child->klass->detach) { |
2698 | child->klass->detach(child); | |
d736f119 | 2699 | } |
e9740bc6 KW |
2700 | QLIST_REMOVE(child, next_parent); |
2701 | } | |
36fe1331 KW |
2702 | |
2703 | child->bs = new_bs; | |
2704 | ||
e9740bc6 KW |
2705 | if (new_bs) { |
2706 | QLIST_INSERT_HEAD(&new_bs->parents, child, next_parent); | |
debc2927 HR |
2707 | |
2708 | /* | |
2709 | * Detaching the old node may have led to the new node's | |
2710 | * quiesce_counter having been decreased. Not a problem, we | |
2711 | * just need to recognize this here and then invoke | |
2712 | * drained_end appropriately more often. | |
2713 | */ | |
2714 | assert(new_bs->quiesce_counter <= new_bs_quiesce_counter); | |
2715 | drain_saldo += new_bs->quiesce_counter - new_bs_quiesce_counter; | |
33a610c3 | 2716 | |
d736f119 KW |
2717 | /* Attach only after starting new drained sections, so that recursive |
2718 | * drain sections coming from @child don't get an extra .drained_begin | |
2719 | * callback. */ | |
bd86fb99 HR |
2720 | if (child->klass->attach) { |
2721 | child->klass->attach(child); | |
8ee03995 KW |
2722 | } |
2723 | } | |
debc2927 HR |
2724 | |
2725 | /* | |
2726 | * If the old child node was drained but the new one is not, allow | |
2727 | * requests to come in only after the new node has been attached. | |
2728 | */ | |
bd86fb99 | 2729 | while (drain_saldo < 0 && child->klass->drained_end) { |
debc2927 HR |
2730 | bdrv_parent_drained_end_single(child); |
2731 | drain_saldo++; | |
2732 | } | |
8ee03995 | 2733 | } |
33a610c3 | 2734 | |
46541ee5 VSO |
2735 | static void bdrv_child_free(void *opaque) |
2736 | { | |
2737 | BdrvChild *c = opaque; | |
2738 | ||
2739 | g_free(c->name); | |
2740 | g_free(c); | |
2741 | } | |
2742 | ||
548a74c0 | 2743 | static void bdrv_remove_empty_child(BdrvChild *child) |
df581792 | 2744 | { |
548a74c0 VSO |
2745 | assert(!child->bs); |
2746 | QLIST_SAFE_REMOVE(child, next); | |
46541ee5 | 2747 | bdrv_child_free(child); |
548a74c0 | 2748 | } |
d5e6f437 | 2749 | |
548a74c0 VSO |
2750 | typedef struct BdrvAttachChildCommonState { |
2751 | BdrvChild **child; | |
2752 | AioContext *old_parent_ctx; | |
2753 | AioContext *old_child_ctx; | |
2754 | } BdrvAttachChildCommonState; | |
2755 | ||
2756 | static void bdrv_attach_child_common_abort(void *opaque) | |
2757 | { | |
2758 | BdrvAttachChildCommonState *s = opaque; | |
2759 | BdrvChild *child = *s->child; | |
2760 | BlockDriverState *bs = child->bs; | |
2761 | ||
2762 | bdrv_replace_child_noperm(child, NULL); | |
2763 | ||
2764 | if (bdrv_get_aio_context(bs) != s->old_child_ctx) { | |
2765 | bdrv_try_set_aio_context(bs, s->old_child_ctx, &error_abort); | |
2766 | } | |
2767 | ||
2768 | if (bdrv_child_get_parent_aio_context(child) != s->old_parent_ctx) { | |
2769 | GSList *ignore = g_slist_prepend(NULL, child); | |
2770 | ||
2771 | child->klass->can_set_aio_ctx(child, s->old_parent_ctx, &ignore, | |
2772 | &error_abort); | |
2773 | g_slist_free(ignore); | |
2774 | ignore = g_slist_prepend(NULL, child); | |
2775 | child->klass->set_aio_ctx(child, s->old_parent_ctx, &ignore); | |
2776 | ||
2777 | g_slist_free(ignore); | |
d5e6f437 KW |
2778 | } |
2779 | ||
548a74c0 VSO |
2780 | bdrv_unref(bs); |
2781 | bdrv_remove_empty_child(child); | |
2782 | *s->child = NULL; | |
2783 | } | |
2784 | ||
2785 | static TransactionActionDrv bdrv_attach_child_common_drv = { | |
2786 | .abort = bdrv_attach_child_common_abort, | |
2787 | .clean = g_free, | |
2788 | }; | |
2789 | ||
2790 | /* | |
2791 | * Common part of attaching bdrv child to bs or to blk or to job | |
f8d2ad78 VSO |
2792 | * |
2793 | * Resulting new child is returned through @child. | |
2794 | * At start *@child must be NULL. | |
2795 | * @child is saved to a new entry of @tran, so that *@child could be reverted to | |
2796 | * NULL on abort(). So referenced variable must live at least until transaction | |
2797 | * end. | |
7ec390d5 VSO |
2798 | * |
2799 | * Function doesn't update permissions, caller is responsible for this. | |
548a74c0 VSO |
2800 | */ |
2801 | static int bdrv_attach_child_common(BlockDriverState *child_bs, | |
2802 | const char *child_name, | |
2803 | const BdrvChildClass *child_class, | |
2804 | BdrvChildRole child_role, | |
2805 | uint64_t perm, uint64_t shared_perm, | |
2806 | void *opaque, BdrvChild **child, | |
2807 | Transaction *tran, Error **errp) | |
2808 | { | |
2809 | BdrvChild *new_child; | |
2810 | AioContext *parent_ctx; | |
2811 | AioContext *child_ctx = bdrv_get_aio_context(child_bs); | |
2812 | ||
2813 | assert(child); | |
2814 | assert(*child == NULL); | |
da261b69 | 2815 | assert(child_class->get_parent_desc); |
548a74c0 VSO |
2816 | |
2817 | new_child = g_new(BdrvChild, 1); | |
2818 | *new_child = (BdrvChild) { | |
d5e6f437 KW |
2819 | .bs = NULL, |
2820 | .name = g_strdup(child_name), | |
bd86fb99 | 2821 | .klass = child_class, |
258b7765 | 2822 | .role = child_role, |
d5e6f437 KW |
2823 | .perm = perm, |
2824 | .shared_perm = shared_perm, | |
2825 | .opaque = opaque, | |
df581792 KW |
2826 | }; |
2827 | ||
548a74c0 VSO |
2828 | /* |
2829 | * If the AioContexts don't match, first try to move the subtree of | |
132ada80 | 2830 | * child_bs into the AioContext of the new parent. If this doesn't work, |
548a74c0 VSO |
2831 | * try moving the parent into the AioContext of child_bs instead. |
2832 | */ | |
2833 | parent_ctx = bdrv_child_get_parent_aio_context(new_child); | |
2834 | if (child_ctx != parent_ctx) { | |
2835 | Error *local_err = NULL; | |
2836 | int ret = bdrv_try_set_aio_context(child_bs, parent_ctx, &local_err); | |
2837 | ||
bd86fb99 | 2838 | if (ret < 0 && child_class->can_set_aio_ctx) { |
548a74c0 VSO |
2839 | GSList *ignore = g_slist_prepend(NULL, new_child); |
2840 | if (child_class->can_set_aio_ctx(new_child, child_ctx, &ignore, | |
2841 | NULL)) | |
2842 | { | |
132ada80 KW |
2843 | error_free(local_err); |
2844 | ret = 0; | |
2845 | g_slist_free(ignore); | |
548a74c0 VSO |
2846 | ignore = g_slist_prepend(NULL, new_child); |
2847 | child_class->set_aio_ctx(new_child, child_ctx, &ignore); | |
132ada80 KW |
2848 | } |
2849 | g_slist_free(ignore); | |
2850 | } | |
548a74c0 | 2851 | |
132ada80 KW |
2852 | if (ret < 0) { |
2853 | error_propagate(errp, local_err); | |
548a74c0 VSO |
2854 | bdrv_remove_empty_child(new_child); |
2855 | return ret; | |
132ada80 KW |
2856 | } |
2857 | } | |
2858 | ||
548a74c0 VSO |
2859 | bdrv_ref(child_bs); |
2860 | bdrv_replace_child_noperm(new_child, child_bs); | |
2861 | ||
2862 | *child = new_child; | |
b4b059f6 | 2863 | |
548a74c0 VSO |
2864 | BdrvAttachChildCommonState *s = g_new(BdrvAttachChildCommonState, 1); |
2865 | *s = (BdrvAttachChildCommonState) { | |
2866 | .child = child, | |
2867 | .old_parent_ctx = parent_ctx, | |
2868 | .old_child_ctx = child_ctx, | |
2869 | }; | |
2870 | tran_add(tran, &bdrv_attach_child_common_drv, s); | |
2871 | ||
2872 | return 0; | |
2873 | } | |
2874 | ||
f8d2ad78 VSO |
2875 | /* |
2876 | * Variable referenced by @child must live at least until transaction end. | |
2877 | * (see bdrv_attach_child_common() doc for details) | |
7ec390d5 VSO |
2878 | * |
2879 | * Function doesn't update permissions, caller is responsible for this. | |
f8d2ad78 | 2880 | */ |
aa5a04c7 VSO |
2881 | static int bdrv_attach_child_noperm(BlockDriverState *parent_bs, |
2882 | BlockDriverState *child_bs, | |
2883 | const char *child_name, | |
2884 | const BdrvChildClass *child_class, | |
2885 | BdrvChildRole child_role, | |
2886 | BdrvChild **child, | |
2887 | Transaction *tran, | |
2888 | Error **errp) | |
2889 | { | |
2890 | int ret; | |
2891 | uint64_t perm, shared_perm; | |
2892 | ||
2893 | assert(parent_bs->drv); | |
2894 | ||
2895 | bdrv_get_cumulative_perm(parent_bs, &perm, &shared_perm); | |
2896 | bdrv_child_perm(parent_bs, child_bs, NULL, child_role, NULL, | |
2897 | perm, shared_perm, &perm, &shared_perm); | |
2898 | ||
2899 | ret = bdrv_attach_child_common(child_bs, child_name, child_class, | |
2900 | child_role, perm, shared_perm, parent_bs, | |
2901 | child, tran, errp); | |
2902 | if (ret < 0) { | |
2903 | return ret; | |
2904 | } | |
2905 | ||
2906 | QLIST_INSERT_HEAD(&parent_bs->children, *child, next); | |
2907 | /* | |
2908 | * child is removed in bdrv_attach_child_common_abort(), so don't care to | |
2909 | * abort this change separately. | |
2910 | */ | |
2911 | ||
2912 | return 0; | |
2913 | } | |
2914 | ||
548a74c0 VSO |
2915 | static void bdrv_detach_child(BdrvChild *child) |
2916 | { | |
4954aace VSO |
2917 | BlockDriverState *old_bs = child->bs; |
2918 | ||
2919 | bdrv_replace_child_noperm(child, NULL); | |
548a74c0 | 2920 | bdrv_remove_empty_child(child); |
4954aace VSO |
2921 | |
2922 | if (old_bs) { | |
2923 | /* | |
2924 | * Update permissions for old node. We're just taking a parent away, so | |
2925 | * we're loosening restrictions. Errors of permission update are not | |
2926 | * fatal in this case, ignore them. | |
2927 | */ | |
2928 | bdrv_refresh_perms(old_bs, NULL); | |
2929 | ||
2930 | /* | |
2931 | * When the parent requiring a non-default AioContext is removed, the | |
2932 | * node moves back to the main AioContext | |
2933 | */ | |
2934 | bdrv_try_set_aio_context(old_bs, qemu_get_aio_context(), NULL); | |
2935 | } | |
548a74c0 VSO |
2936 | } |
2937 | ||
2938 | /* | |
2939 | * This function steals the reference to child_bs from the caller. | |
2940 | * That reference is later dropped by bdrv_root_unref_child(). | |
2941 | * | |
2942 | * On failure NULL is returned, errp is set and the reference to | |
2943 | * child_bs is also dropped. | |
2944 | * | |
2945 | * The caller must hold the AioContext lock @child_bs, but not that of @ctx | |
2946 | * (unless @child_bs is already in @ctx). | |
2947 | */ | |
2948 | BdrvChild *bdrv_root_attach_child(BlockDriverState *child_bs, | |
2949 | const char *child_name, | |
2950 | const BdrvChildClass *child_class, | |
2951 | BdrvChildRole child_role, | |
2952 | uint64_t perm, uint64_t shared_perm, | |
2953 | void *opaque, Error **errp) | |
2954 | { | |
2955 | int ret; | |
2956 | BdrvChild *child = NULL; | |
2957 | Transaction *tran = tran_new(); | |
2958 | ||
2959 | ret = bdrv_attach_child_common(child_bs, child_name, child_class, | |
2960 | child_role, perm, shared_perm, opaque, | |
2961 | &child, tran, errp); | |
2962 | if (ret < 0) { | |
e878bb12 | 2963 | goto out; |
548a74c0 VSO |
2964 | } |
2965 | ||
2966 | ret = bdrv_refresh_perms(child_bs, errp); | |
548a74c0 | 2967 | |
e878bb12 KW |
2968 | out: |
2969 | tran_finalize(tran, ret); | |
f8d2ad78 VSO |
2970 | /* child is unset on failure by bdrv_attach_child_common_abort() */ |
2971 | assert((ret < 0) == !child); | |
2972 | ||
548a74c0 | 2973 | bdrv_unref(child_bs); |
b4b059f6 | 2974 | return child; |
df581792 KW |
2975 | } |
2976 | ||
b441dc71 AG |
2977 | /* |
2978 | * This function transfers the reference to child_bs from the caller | |
2979 | * to parent_bs. That reference is later dropped by parent_bs on | |
2980 | * bdrv_close() or if someone calls bdrv_unref_child(). | |
2981 | * | |
2982 | * On failure NULL is returned, errp is set and the reference to | |
2983 | * child_bs is also dropped. | |
132ada80 KW |
2984 | * |
2985 | * If @parent_bs and @child_bs are in different AioContexts, the caller must | |
2986 | * hold the AioContext lock for @child_bs, but not for @parent_bs. | |
b441dc71 | 2987 | */ |
98292c61 WC |
2988 | BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs, |
2989 | BlockDriverState *child_bs, | |
2990 | const char *child_name, | |
bd86fb99 | 2991 | const BdrvChildClass *child_class, |
258b7765 | 2992 | BdrvChildRole child_role, |
8b2ff529 | 2993 | Error **errp) |
f21d96d0 | 2994 | { |
aa5a04c7 VSO |
2995 | int ret; |
2996 | BdrvChild *child = NULL; | |
2997 | Transaction *tran = tran_new(); | |
f68c598b | 2998 | |
aa5a04c7 VSO |
2999 | ret = bdrv_attach_child_noperm(parent_bs, child_bs, child_name, child_class, |
3000 | child_role, &child, tran, errp); | |
3001 | if (ret < 0) { | |
3002 | goto out; | |
3003 | } | |
d5e6f437 | 3004 | |
aa5a04c7 VSO |
3005 | ret = bdrv_refresh_perms(parent_bs, errp); |
3006 | if (ret < 0) { | |
3007 | goto out; | |
d5e6f437 KW |
3008 | } |
3009 | ||
aa5a04c7 VSO |
3010 | out: |
3011 | tran_finalize(tran, ret); | |
f8d2ad78 VSO |
3012 | /* child is unset on failure by bdrv_attach_child_common_abort() */ |
3013 | assert((ret < 0) == !child); | |
aa5a04c7 VSO |
3014 | |
3015 | bdrv_unref(child_bs); | |
3016 | ||
f21d96d0 KW |
3017 | return child; |
3018 | } | |
3019 | ||
7b99a266 | 3020 | /* Callers must ensure that child->frozen is false. */ |
f21d96d0 | 3021 | void bdrv_root_unref_child(BdrvChild *child) |
33a60407 | 3022 | { |
779020cb KW |
3023 | BlockDriverState *child_bs; |
3024 | ||
f21d96d0 KW |
3025 | child_bs = child->bs; |
3026 | bdrv_detach_child(child); | |
3027 | bdrv_unref(child_bs); | |
3028 | } | |
3029 | ||
332b3a17 VSO |
3030 | typedef struct BdrvSetInheritsFrom { |
3031 | BlockDriverState *bs; | |
3032 | BlockDriverState *old_inherits_from; | |
3033 | } BdrvSetInheritsFrom; | |
3034 | ||
3035 | static void bdrv_set_inherits_from_abort(void *opaque) | |
3036 | { | |
3037 | BdrvSetInheritsFrom *s = opaque; | |
3038 | ||
3039 | s->bs->inherits_from = s->old_inherits_from; | |
3040 | } | |
3041 | ||
3042 | static TransactionActionDrv bdrv_set_inherits_from_drv = { | |
3043 | .abort = bdrv_set_inherits_from_abort, | |
3044 | .clean = g_free, | |
3045 | }; | |
3046 | ||
3047 | /* @tran is allowed to be NULL. In this case no rollback is possible */ | |
3048 | static void bdrv_set_inherits_from(BlockDriverState *bs, | |
3049 | BlockDriverState *new_inherits_from, | |
3050 | Transaction *tran) | |
3051 | { | |
3052 | if (tran) { | |
3053 | BdrvSetInheritsFrom *s = g_new(BdrvSetInheritsFrom, 1); | |
3054 | ||
3055 | *s = (BdrvSetInheritsFrom) { | |
3056 | .bs = bs, | |
3057 | .old_inherits_from = bs->inherits_from, | |
3058 | }; | |
3059 | ||
3060 | tran_add(tran, &bdrv_set_inherits_from_drv, s); | |
3061 | } | |
3062 | ||
3063 | bs->inherits_from = new_inherits_from; | |
3064 | } | |
3065 | ||
3cf746b3 HR |
3066 | /** |
3067 | * Clear all inherits_from pointers from children and grandchildren of | |
3068 | * @root that point to @root, where necessary. | |
332b3a17 | 3069 | * @tran is allowed to be NULL. In this case no rollback is possible |
3cf746b3 | 3070 | */ |
332b3a17 VSO |
3071 | static void bdrv_unset_inherits_from(BlockDriverState *root, BdrvChild *child, |
3072 | Transaction *tran) | |
f21d96d0 | 3073 | { |
3cf746b3 | 3074 | BdrvChild *c; |
4e4bf5c4 | 3075 | |
3cf746b3 HR |
3076 | if (child->bs->inherits_from == root) { |
3077 | /* | |
3078 | * Remove inherits_from only when the last reference between root and | |
3079 | * child->bs goes away. | |
3080 | */ | |
3081 | QLIST_FOREACH(c, &root->children, next) { | |
4e4bf5c4 KW |
3082 | if (c != child && c->bs == child->bs) { |
3083 | break; | |
3084 | } | |
3085 | } | |
3086 | if (c == NULL) { | |
332b3a17 | 3087 | bdrv_set_inherits_from(child->bs, NULL, tran); |
4e4bf5c4 | 3088 | } |
33a60407 KW |
3089 | } |
3090 | ||
3cf746b3 | 3091 | QLIST_FOREACH(c, &child->bs->children, next) { |
332b3a17 | 3092 | bdrv_unset_inherits_from(root, c, tran); |
3cf746b3 HR |
3093 | } |
3094 | } | |
3095 | ||
7b99a266 | 3096 | /* Callers must ensure that child->frozen is false. */ |
3cf746b3 HR |
3097 | void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child) |
3098 | { | |
3099 | if (child == NULL) { | |
3100 | return; | |
3101 | } | |
3102 | ||
332b3a17 | 3103 | bdrv_unset_inherits_from(parent, child, NULL); |
f21d96d0 | 3104 | bdrv_root_unref_child(child); |
33a60407 KW |
3105 | } |
3106 | ||
5c8cab48 KW |
3107 | |
3108 | static void bdrv_parent_cb_change_media(BlockDriverState *bs, bool load) | |
3109 | { | |
3110 | BdrvChild *c; | |
3111 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
bd86fb99 HR |
3112 | if (c->klass->change_media) { |
3113 | c->klass->change_media(c, load); | |
5c8cab48 KW |
3114 | } |
3115 | } | |
3116 | } | |
3117 | ||
0065c455 AG |
3118 | /* Return true if you can reach parent going through child->inherits_from |
3119 | * recursively. If parent or child are NULL, return false */ | |
3120 | static bool bdrv_inherits_from_recursive(BlockDriverState *child, | |
3121 | BlockDriverState *parent) | |
3122 | { | |
3123 | while (child && child != parent) { | |
3124 | child = child->inherits_from; | |
3125 | } | |
3126 | ||
3127 | return child != NULL; | |
3128 | } | |
3129 | ||
25191e5f HR |
3130 | /* |
3131 | * Return the BdrvChildRole for @bs's backing child. bs->backing is | |
3132 | * mostly used for COW backing children (role = COW), but also for | |
3133 | * filtered children (role = FILTERED | PRIMARY). | |
3134 | */ | |
3135 | static BdrvChildRole bdrv_backing_role(BlockDriverState *bs) | |
3136 | { | |
3137 | if (bs->drv && bs->drv->is_filter) { | |
3138 | return BDRV_CHILD_FILTERED | BDRV_CHILD_PRIMARY; | |
3139 | } else { | |
3140 | return BDRV_CHILD_COW; | |
3141 | } | |
3142 | } | |
3143 | ||
5db15a57 | 3144 | /* |
e9238278 VSO |
3145 | * Sets the bs->backing or bs->file link of a BDS. A new reference is created; |
3146 | * callers which don't need their own reference any more must call bdrv_unref(). | |
7ec390d5 VSO |
3147 | * |
3148 | * Function doesn't update permissions, caller is responsible for this. | |
5db15a57 | 3149 | */ |
e9238278 VSO |
3150 | static int bdrv_set_file_or_backing_noperm(BlockDriverState *parent_bs, |
3151 | BlockDriverState *child_bs, | |
3152 | bool is_backing, | |
3153 | Transaction *tran, Error **errp) | |
8d24cce1 | 3154 | { |
a1e708fc | 3155 | int ret = 0; |
e9238278 VSO |
3156 | bool update_inherits_from = |
3157 | bdrv_inherits_from_recursive(child_bs, parent_bs); | |
3158 | BdrvChild *child = is_backing ? parent_bs->backing : parent_bs->file; | |
3159 | BdrvChildRole role; | |
0065c455 | 3160 | |
e9238278 VSO |
3161 | if (!parent_bs->drv) { |
3162 | /* | |
3163 | * Node without drv is an object without a class :/. TODO: finally fix | |
3164 | * qcow2 driver to never clear bs->drv and implement format corruption | |
3165 | * handling in other way. | |
3166 | */ | |
3167 | error_setg(errp, "Node corrupted"); | |
3168 | return -EINVAL; | |
3169 | } | |
3170 | ||
3171 | if (child && child->frozen) { | |
3172 | error_setg(errp, "Cannot change frozen '%s' link from '%s' to '%s'", | |
3173 | child->name, parent_bs->node_name, child->bs->node_name); | |
a1e708fc | 3174 | return -EPERM; |
2cad1ebe AG |
3175 | } |
3176 | ||
25f78d9e VSO |
3177 | if (is_backing && !parent_bs->drv->is_filter && |
3178 | !parent_bs->drv->supports_backing) | |
3179 | { | |
3180 | error_setg(errp, "Driver '%s' of node '%s' does not support backing " | |
3181 | "files", parent_bs->drv->format_name, parent_bs->node_name); | |
3182 | return -EINVAL; | |
3183 | } | |
3184 | ||
e9238278 VSO |
3185 | if (parent_bs->drv->is_filter) { |
3186 | role = BDRV_CHILD_FILTERED | BDRV_CHILD_PRIMARY; | |
3187 | } else if (is_backing) { | |
3188 | role = BDRV_CHILD_COW; | |
3189 | } else { | |
3190 | /* | |
3191 | * We only can use same role as it is in existing child. We don't have | |
3192 | * infrastructure to determine role of file child in generic way | |
3193 | */ | |
3194 | if (!child) { | |
3195 | error_setg(errp, "Cannot set file child to format node without " | |
3196 | "file child"); | |
3197 | return -EINVAL; | |
3198 | } | |
3199 | role = child->role; | |
826b6ca0 FZ |
3200 | } |
3201 | ||
e9238278 VSO |
3202 | if (child) { |
3203 | bdrv_unset_inherits_from(parent_bs, child, tran); | |
3204 | bdrv_remove_file_or_backing_child(parent_bs, child, tran); | |
3205 | } | |
3206 | ||
3207 | if (!child_bs) { | |
8d24cce1 FZ |
3208 | goto out; |
3209 | } | |
12fa4af6 | 3210 | |
e9238278 VSO |
3211 | ret = bdrv_attach_child_noperm(parent_bs, child_bs, |
3212 | is_backing ? "backing" : "file", | |
3213 | &child_of_bds, role, | |
3214 | is_backing ? &parent_bs->backing : | |
3215 | &parent_bs->file, | |
3216 | tran, errp); | |
160333e1 VSO |
3217 | if (ret < 0) { |
3218 | return ret; | |
a1e708fc VSO |
3219 | } |
3220 | ||
160333e1 VSO |
3221 | |
3222 | /* | |
e9238278 | 3223 | * If inherits_from pointed recursively to bs then let's update it to |
160333e1 VSO |
3224 | * point directly to bs (else it will become NULL). |
3225 | */ | |
a1e708fc | 3226 | if (update_inherits_from) { |
e9238278 | 3227 | bdrv_set_inherits_from(child_bs, parent_bs, tran); |
0065c455 | 3228 | } |
826b6ca0 | 3229 | |
8d24cce1 | 3230 | out: |
e9238278 | 3231 | bdrv_refresh_limits(parent_bs, tran, NULL); |
160333e1 VSO |
3232 | |
3233 | return 0; | |
3234 | } | |
3235 | ||
e9238278 VSO |
3236 | static int bdrv_set_backing_noperm(BlockDriverState *bs, |
3237 | BlockDriverState *backing_hd, | |
3238 | Transaction *tran, Error **errp) | |
3239 | { | |
3240 | return bdrv_set_file_or_backing_noperm(bs, backing_hd, true, tran, errp); | |
3241 | } | |
3242 | ||
160333e1 VSO |
3243 | int bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd, |
3244 | Error **errp) | |
3245 | { | |
3246 | int ret; | |
3247 | Transaction *tran = tran_new(); | |
3248 | ||
3249 | ret = bdrv_set_backing_noperm(bs, backing_hd, tran, errp); | |
3250 | if (ret < 0) { | |
3251 | goto out; | |
3252 | } | |
3253 | ||
3254 | ret = bdrv_refresh_perms(bs, errp); | |
3255 | out: | |
3256 | tran_finalize(tran, ret); | |
a1e708fc VSO |
3257 | |
3258 | return ret; | |
8d24cce1 FZ |
3259 | } |
3260 | ||
31ca6d07 KW |
3261 | /* |
3262 | * Opens the backing file for a BlockDriverState if not yet open | |
3263 | * | |
d9b7b057 KW |
3264 | * bdref_key specifies the key for the image's BlockdevRef in the options QDict. |
3265 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
3266 | * itself, all options starting with "${bdref_key}." are considered part of the | |
3267 | * BlockdevRef. | |
3268 | * | |
3269 | * TODO Can this be unified with bdrv_open_image()? | |
31ca6d07 | 3270 | */ |
d9b7b057 KW |
3271 | int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options, |
3272 | const char *bdref_key, Error **errp) | |
9156df12 | 3273 | { |
6b6833c1 | 3274 | char *backing_filename = NULL; |
d9b7b057 KW |
3275 | char *bdref_key_dot; |
3276 | const char *reference = NULL; | |
317fc44e | 3277 | int ret = 0; |
998c2019 | 3278 | bool implicit_backing = false; |
8d24cce1 | 3279 | BlockDriverState *backing_hd; |
d9b7b057 KW |
3280 | QDict *options; |
3281 | QDict *tmp_parent_options = NULL; | |
34b5d2c6 | 3282 | Error *local_err = NULL; |
9156df12 | 3283 | |
760e0063 | 3284 | if (bs->backing != NULL) { |
1ba4b6a5 | 3285 | goto free_exit; |
9156df12 PB |
3286 | } |
3287 | ||
31ca6d07 | 3288 | /* NULL means an empty set of options */ |
d9b7b057 KW |
3289 | if (parent_options == NULL) { |
3290 | tmp_parent_options = qdict_new(); | |
3291 | parent_options = tmp_parent_options; | |
31ca6d07 KW |
3292 | } |
3293 | ||
9156df12 | 3294 | bs->open_flags &= ~BDRV_O_NO_BACKING; |
d9b7b057 KW |
3295 | |
3296 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); | |
3297 | qdict_extract_subqdict(parent_options, &options, bdref_key_dot); | |
3298 | g_free(bdref_key_dot); | |
3299 | ||
129c7d1c MA |
3300 | /* |
3301 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
3302 | * types would require more care. When @parent_options come from | |
3303 | * -blockdev or blockdev_add, its members are typed according to | |
3304 | * the QAPI schema, but when they come from -drive, they're all | |
3305 | * QString. | |
3306 | */ | |
d9b7b057 KW |
3307 | reference = qdict_get_try_str(parent_options, bdref_key); |
3308 | if (reference || qdict_haskey(options, "file.filename")) { | |
6b6833c1 | 3309 | /* keep backing_filename NULL */ |
1cb6f506 | 3310 | } else if (bs->backing_file[0] == '\0' && qdict_size(options) == 0) { |
cb3e7f08 | 3311 | qobject_unref(options); |
1ba4b6a5 | 3312 | goto free_exit; |
dbecebdd | 3313 | } else { |
998c2019 HR |
3314 | if (qdict_size(options) == 0) { |
3315 | /* If the user specifies options that do not modify the | |
3316 | * backing file's behavior, we might still consider it the | |
3317 | * implicit backing file. But it's easier this way, and | |
3318 | * just specifying some of the backing BDS's options is | |
3319 | * only possible with -drive anyway (otherwise the QAPI | |
3320 | * schema forces the user to specify everything). */ | |
3321 | implicit_backing = !strcmp(bs->auto_backing_file, bs->backing_file); | |
3322 | } | |
3323 | ||
6b6833c1 | 3324 | backing_filename = bdrv_get_full_backing_filename(bs, &local_err); |
9f07429e HR |
3325 | if (local_err) { |
3326 | ret = -EINVAL; | |
3327 | error_propagate(errp, local_err); | |
cb3e7f08 | 3328 | qobject_unref(options); |
9f07429e HR |
3329 | goto free_exit; |
3330 | } | |
9156df12 PB |
3331 | } |
3332 | ||
8ee79e70 KW |
3333 | if (!bs->drv || !bs->drv->supports_backing) { |
3334 | ret = -EINVAL; | |
3335 | error_setg(errp, "Driver doesn't support backing files"); | |
cb3e7f08 | 3336 | qobject_unref(options); |
8ee79e70 KW |
3337 | goto free_exit; |
3338 | } | |
3339 | ||
6bff597b PK |
3340 | if (!reference && |
3341 | bs->backing_format[0] != '\0' && !qdict_haskey(options, "driver")) { | |
46f5ac20 | 3342 | qdict_put_str(options, "driver", bs->backing_format); |
9156df12 PB |
3343 | } |
3344 | ||
6b6833c1 | 3345 | backing_hd = bdrv_open_inherit(backing_filename, reference, options, 0, bs, |
25191e5f | 3346 | &child_of_bds, bdrv_backing_role(bs), errp); |
5b363937 | 3347 | if (!backing_hd) { |
9156df12 | 3348 | bs->open_flags |= BDRV_O_NO_BACKING; |
e43bfd9c | 3349 | error_prepend(errp, "Could not open backing file: "); |
5b363937 | 3350 | ret = -EINVAL; |
1ba4b6a5 | 3351 | goto free_exit; |
9156df12 | 3352 | } |
df581792 | 3353 | |
998c2019 HR |
3354 | if (implicit_backing) { |
3355 | bdrv_refresh_filename(backing_hd); | |
3356 | pstrcpy(bs->auto_backing_file, sizeof(bs->auto_backing_file), | |
3357 | backing_hd->filename); | |
3358 | } | |
3359 | ||
5db15a57 KW |
3360 | /* Hook up the backing file link; drop our reference, bs owns the |
3361 | * backing_hd reference now */ | |
dc9c10a1 | 3362 | ret = bdrv_set_backing_hd(bs, backing_hd, errp); |
5db15a57 | 3363 | bdrv_unref(backing_hd); |
dc9c10a1 | 3364 | if (ret < 0) { |
12fa4af6 KW |
3365 | goto free_exit; |
3366 | } | |
d80ac658 | 3367 | |
d9b7b057 KW |
3368 | qdict_del(parent_options, bdref_key); |
3369 | ||
1ba4b6a5 BC |
3370 | free_exit: |
3371 | g_free(backing_filename); | |
cb3e7f08 | 3372 | qobject_unref(tmp_parent_options); |
1ba4b6a5 | 3373 | return ret; |
9156df12 PB |
3374 | } |
3375 | ||
2d6b86af KW |
3376 | static BlockDriverState * |
3377 | bdrv_open_child_bs(const char *filename, QDict *options, const char *bdref_key, | |
bd86fb99 | 3378 | BlockDriverState *parent, const BdrvChildClass *child_class, |
272c02ea | 3379 | BdrvChildRole child_role, bool allow_none, Error **errp) |
da557aac | 3380 | { |
2d6b86af | 3381 | BlockDriverState *bs = NULL; |
da557aac | 3382 | QDict *image_options; |
da557aac HR |
3383 | char *bdref_key_dot; |
3384 | const char *reference; | |
3385 | ||
bd86fb99 | 3386 | assert(child_class != NULL); |
f67503e5 | 3387 | |
da557aac HR |
3388 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); |
3389 | qdict_extract_subqdict(options, &image_options, bdref_key_dot); | |
3390 | g_free(bdref_key_dot); | |
3391 | ||
129c7d1c MA |
3392 | /* |
3393 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
3394 | * types would require more care. When @options come from | |
3395 | * -blockdev or blockdev_add, its members are typed according to | |
3396 | * the QAPI schema, but when they come from -drive, they're all | |
3397 | * QString. | |
3398 | */ | |
da557aac HR |
3399 | reference = qdict_get_try_str(options, bdref_key); |
3400 | if (!filename && !reference && !qdict_size(image_options)) { | |
b4b059f6 | 3401 | if (!allow_none) { |
da557aac HR |
3402 | error_setg(errp, "A block device must be specified for \"%s\"", |
3403 | bdref_key); | |
da557aac | 3404 | } |
cb3e7f08 | 3405 | qobject_unref(image_options); |
da557aac HR |
3406 | goto done; |
3407 | } | |
3408 | ||
5b363937 | 3409 | bs = bdrv_open_inherit(filename, reference, image_options, 0, |
272c02ea | 3410 | parent, child_class, child_role, errp); |
5b363937 | 3411 | if (!bs) { |
df581792 KW |
3412 | goto done; |
3413 | } | |
3414 | ||
da557aac HR |
3415 | done: |
3416 | qdict_del(options, bdref_key); | |
2d6b86af KW |
3417 | return bs; |
3418 | } | |
3419 | ||
3420 | /* | |
3421 | * Opens a disk image whose options are given as BlockdevRef in another block | |
3422 | * device's options. | |
3423 | * | |
3424 | * If allow_none is true, no image will be opened if filename is false and no | |
3425 | * BlockdevRef is given. NULL will be returned, but errp remains unset. | |
3426 | * | |
3427 | * bdrev_key specifies the key for the image's BlockdevRef in the options QDict. | |
3428 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
3429 | * itself, all options starting with "${bdref_key}." are considered part of the | |
3430 | * BlockdevRef. | |
3431 | * | |
3432 | * The BlockdevRef will be removed from the options QDict. | |
3433 | */ | |
3434 | BdrvChild *bdrv_open_child(const char *filename, | |
3435 | QDict *options, const char *bdref_key, | |
3436 | BlockDriverState *parent, | |
bd86fb99 | 3437 | const BdrvChildClass *child_class, |
258b7765 | 3438 | BdrvChildRole child_role, |
2d6b86af KW |
3439 | bool allow_none, Error **errp) |
3440 | { | |
3441 | BlockDriverState *bs; | |
3442 | ||
bd86fb99 | 3443 | bs = bdrv_open_child_bs(filename, options, bdref_key, parent, child_class, |
272c02ea | 3444 | child_role, allow_none, errp); |
2d6b86af KW |
3445 | if (bs == NULL) { |
3446 | return NULL; | |
3447 | } | |
3448 | ||
258b7765 HR |
3449 | return bdrv_attach_child(parent, bs, bdref_key, child_class, child_role, |
3450 | errp); | |
b4b059f6 KW |
3451 | } |
3452 | ||
bd86fb99 HR |
3453 | /* |
3454 | * TODO Future callers may need to specify parent/child_class in order for | |
3455 | * option inheritance to work. Existing callers use it for the root node. | |
3456 | */ | |
e1d74bc6 KW |
3457 | BlockDriverState *bdrv_open_blockdev_ref(BlockdevRef *ref, Error **errp) |
3458 | { | |
3459 | BlockDriverState *bs = NULL; | |
e1d74bc6 KW |
3460 | QObject *obj = NULL; |
3461 | QDict *qdict = NULL; | |
3462 | const char *reference = NULL; | |
3463 | Visitor *v = NULL; | |
3464 | ||
3465 | if (ref->type == QTYPE_QSTRING) { | |
3466 | reference = ref->u.reference; | |
3467 | } else { | |
3468 | BlockdevOptions *options = &ref->u.definition; | |
3469 | assert(ref->type == QTYPE_QDICT); | |
3470 | ||
3471 | v = qobject_output_visitor_new(&obj); | |
1f584248 | 3472 | visit_type_BlockdevOptions(v, NULL, &options, &error_abort); |
e1d74bc6 KW |
3473 | visit_complete(v, &obj); |
3474 | ||
7dc847eb | 3475 | qdict = qobject_to(QDict, obj); |
e1d74bc6 KW |
3476 | qdict_flatten(qdict); |
3477 | ||
3478 | /* bdrv_open_inherit() defaults to the values in bdrv_flags (for | |
3479 | * compatibility with other callers) rather than what we want as the | |
3480 | * real defaults. Apply the defaults here instead. */ | |
3481 | qdict_set_default_str(qdict, BDRV_OPT_CACHE_DIRECT, "off"); | |
3482 | qdict_set_default_str(qdict, BDRV_OPT_CACHE_NO_FLUSH, "off"); | |
3483 | qdict_set_default_str(qdict, BDRV_OPT_READ_ONLY, "off"); | |
e35bdc12 KW |
3484 | qdict_set_default_str(qdict, BDRV_OPT_AUTO_READ_ONLY, "off"); |
3485 | ||
e1d74bc6 KW |
3486 | } |
3487 | ||
272c02ea | 3488 | bs = bdrv_open_inherit(NULL, reference, qdict, 0, NULL, NULL, 0, errp); |
e1d74bc6 | 3489 | obj = NULL; |
cb3e7f08 | 3490 | qobject_unref(obj); |
e1d74bc6 KW |
3491 | visit_free(v); |
3492 | return bs; | |
3493 | } | |
3494 | ||
66836189 HR |
3495 | static BlockDriverState *bdrv_append_temp_snapshot(BlockDriverState *bs, |
3496 | int flags, | |
3497 | QDict *snapshot_options, | |
3498 | Error **errp) | |
b998875d KW |
3499 | { |
3500 | /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */ | |
1ba4b6a5 | 3501 | char *tmp_filename = g_malloc0(PATH_MAX + 1); |
b998875d | 3502 | int64_t total_size; |
83d0521a | 3503 | QemuOpts *opts = NULL; |
ff6ed714 | 3504 | BlockDriverState *bs_snapshot = NULL; |
b998875d KW |
3505 | int ret; |
3506 | ||
3507 | /* if snapshot, we create a temporary backing file and open it | |
3508 | instead of opening 'filename' directly */ | |
3509 | ||
3510 | /* Get the required size from the image */ | |
f187743a KW |
3511 | total_size = bdrv_getlength(bs); |
3512 | if (total_size < 0) { | |
3513 | error_setg_errno(errp, -total_size, "Could not get image size"); | |
1ba4b6a5 | 3514 | goto out; |
f187743a | 3515 | } |
b998875d KW |
3516 | |
3517 | /* Create the temporary image */ | |
1ba4b6a5 | 3518 | ret = get_tmp_filename(tmp_filename, PATH_MAX + 1); |
b998875d KW |
3519 | if (ret < 0) { |
3520 | error_setg_errno(errp, -ret, "Could not get temporary filename"); | |
1ba4b6a5 | 3521 | goto out; |
b998875d KW |
3522 | } |
3523 | ||
ef810437 | 3524 | opts = qemu_opts_create(bdrv_qcow2.create_opts, NULL, 0, |
c282e1fd | 3525 | &error_abort); |
39101f25 | 3526 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_size, &error_abort); |
e43bfd9c | 3527 | ret = bdrv_create(&bdrv_qcow2, tmp_filename, opts, errp); |
83d0521a | 3528 | qemu_opts_del(opts); |
b998875d | 3529 | if (ret < 0) { |
e43bfd9c MA |
3530 | error_prepend(errp, "Could not create temporary overlay '%s': ", |
3531 | tmp_filename); | |
1ba4b6a5 | 3532 | goto out; |
b998875d KW |
3533 | } |
3534 | ||
73176bee | 3535 | /* Prepare options QDict for the temporary file */ |
46f5ac20 EB |
3536 | qdict_put_str(snapshot_options, "file.driver", "file"); |
3537 | qdict_put_str(snapshot_options, "file.filename", tmp_filename); | |
3538 | qdict_put_str(snapshot_options, "driver", "qcow2"); | |
b998875d | 3539 | |
5b363937 | 3540 | bs_snapshot = bdrv_open(NULL, NULL, snapshot_options, flags, errp); |
73176bee | 3541 | snapshot_options = NULL; |
5b363937 | 3542 | if (!bs_snapshot) { |
1ba4b6a5 | 3543 | goto out; |
b998875d KW |
3544 | } |
3545 | ||
934aee14 VSO |
3546 | ret = bdrv_append(bs_snapshot, bs, errp); |
3547 | if (ret < 0) { | |
ff6ed714 | 3548 | bs_snapshot = NULL; |
b2c2832c KW |
3549 | goto out; |
3550 | } | |
1ba4b6a5 BC |
3551 | |
3552 | out: | |
cb3e7f08 | 3553 | qobject_unref(snapshot_options); |
1ba4b6a5 | 3554 | g_free(tmp_filename); |
ff6ed714 | 3555 | return bs_snapshot; |
b998875d KW |
3556 | } |
3557 | ||
b6ce07aa KW |
3558 | /* |
3559 | * Opens a disk image (raw, qcow2, vmdk, ...) | |
de9c0cec KW |
3560 | * |
3561 | * options is a QDict of options to pass to the block drivers, or NULL for an | |
3562 | * empty set of options. The reference to the QDict belongs to the block layer | |
3563 | * after the call (even on failure), so if the caller intends to reuse the | |
cb3e7f08 | 3564 | * dictionary, it needs to use qobject_ref() before calling bdrv_open. |
f67503e5 HR |
3565 | * |
3566 | * If *pbs is NULL, a new BDS will be created with a pointer to it stored there. | |
3567 | * If it is not NULL, the referenced BDS will be reused. | |
ddf5636d HR |
3568 | * |
3569 | * The reference parameter may be used to specify an existing block device which | |
3570 | * should be opened. If specified, neither options nor a filename may be given, | |
3571 | * nor can an existing BDS be reused (that is, *pbs has to be NULL). | |
b6ce07aa | 3572 | */ |
5b363937 HR |
3573 | static BlockDriverState *bdrv_open_inherit(const char *filename, |
3574 | const char *reference, | |
3575 | QDict *options, int flags, | |
3576 | BlockDriverState *parent, | |
bd86fb99 | 3577 | const BdrvChildClass *child_class, |
272c02ea | 3578 | BdrvChildRole child_role, |
5b363937 | 3579 | Error **errp) |
ea2384d3 | 3580 | { |
b6ce07aa | 3581 | int ret; |
5696c6e3 | 3582 | BlockBackend *file = NULL; |
9a4f4c31 | 3583 | BlockDriverState *bs; |
ce343771 | 3584 | BlockDriver *drv = NULL; |
2f624b80 | 3585 | BdrvChild *child; |
74fe54f2 | 3586 | const char *drvname; |
3e8c2e57 | 3587 | const char *backing; |
34b5d2c6 | 3588 | Error *local_err = NULL; |
73176bee | 3589 | QDict *snapshot_options = NULL; |
b1e6fc08 | 3590 | int snapshot_flags = 0; |
712e7874 | 3591 | |
bd86fb99 HR |
3592 | assert(!child_class || !flags); |
3593 | assert(!child_class == !parent); | |
f67503e5 | 3594 | |
ddf5636d HR |
3595 | if (reference) { |
3596 | bool options_non_empty = options ? qdict_size(options) : false; | |
cb3e7f08 | 3597 | qobject_unref(options); |
ddf5636d | 3598 | |
ddf5636d HR |
3599 | if (filename || options_non_empty) { |
3600 | error_setg(errp, "Cannot reference an existing block device with " | |
3601 | "additional options or a new filename"); | |
5b363937 | 3602 | return NULL; |
ddf5636d HR |
3603 | } |
3604 | ||
3605 | bs = bdrv_lookup_bs(reference, reference, errp); | |
3606 | if (!bs) { | |
5b363937 | 3607 | return NULL; |
ddf5636d | 3608 | } |
76b22320 | 3609 | |
ddf5636d | 3610 | bdrv_ref(bs); |
5b363937 | 3611 | return bs; |
ddf5636d HR |
3612 | } |
3613 | ||
5b363937 | 3614 | bs = bdrv_new(); |
f67503e5 | 3615 | |
de9c0cec KW |
3616 | /* NULL means an empty set of options */ |
3617 | if (options == NULL) { | |
3618 | options = qdict_new(); | |
3619 | } | |
3620 | ||
145f598e | 3621 | /* json: syntax counts as explicit options, as if in the QDict */ |
de3b53f0 KW |
3622 | parse_json_protocol(options, &filename, &local_err); |
3623 | if (local_err) { | |
de3b53f0 KW |
3624 | goto fail; |
3625 | } | |
3626 | ||
145f598e KW |
3627 | bs->explicit_options = qdict_clone_shallow(options); |
3628 | ||
bd86fb99 | 3629 | if (child_class) { |
3cdc69d3 HR |
3630 | bool parent_is_format; |
3631 | ||
3632 | if (parent->drv) { | |
3633 | parent_is_format = parent->drv->is_format; | |
3634 | } else { | |
3635 | /* | |
3636 | * parent->drv is not set yet because this node is opened for | |
3637 | * (potential) format probing. That means that @parent is going | |
3638 | * to be a format node. | |
3639 | */ | |
3640 | parent_is_format = true; | |
3641 | } | |
3642 | ||
bddcec37 | 3643 | bs->inherits_from = parent; |
3cdc69d3 HR |
3644 | child_class->inherit_options(child_role, parent_is_format, |
3645 | &flags, options, | |
bd86fb99 | 3646 | parent->open_flags, parent->options); |
f3930ed0 KW |
3647 | } |
3648 | ||
de3b53f0 | 3649 | ret = bdrv_fill_options(&options, filename, &flags, &local_err); |
dfde483e | 3650 | if (ret < 0) { |
462f5bcf KW |
3651 | goto fail; |
3652 | } | |
3653 | ||
129c7d1c MA |
3654 | /* |
3655 | * Set the BDRV_O_RDWR and BDRV_O_ALLOW_RDWR flags. | |
3656 | * Caution: getting a boolean member of @options requires care. | |
3657 | * When @options come from -blockdev or blockdev_add, members are | |
3658 | * typed according to the QAPI schema, but when they come from | |
3659 | * -drive, they're all QString. | |
3660 | */ | |
f87a0e29 AG |
3661 | if (g_strcmp0(qdict_get_try_str(options, BDRV_OPT_READ_ONLY), "on") && |
3662 | !qdict_get_try_bool(options, BDRV_OPT_READ_ONLY, false)) { | |
3663 | flags |= (BDRV_O_RDWR | BDRV_O_ALLOW_RDWR); | |
3664 | } else { | |
3665 | flags &= ~BDRV_O_RDWR; | |
14499ea5 AG |
3666 | } |
3667 | ||
3668 | if (flags & BDRV_O_SNAPSHOT) { | |
3669 | snapshot_options = qdict_new(); | |
3670 | bdrv_temp_snapshot_options(&snapshot_flags, snapshot_options, | |
3671 | flags, options); | |
f87a0e29 AG |
3672 | /* Let bdrv_backing_options() override "read-only" */ |
3673 | qdict_del(options, BDRV_OPT_READ_ONLY); | |
00ff7ffd HR |
3674 | bdrv_inherited_options(BDRV_CHILD_COW, true, |
3675 | &flags, options, flags, options); | |
14499ea5 AG |
3676 | } |
3677 | ||
62392ebb KW |
3678 | bs->open_flags = flags; |
3679 | bs->options = options; | |
3680 | options = qdict_clone_shallow(options); | |
3681 | ||
76c591b0 | 3682 | /* Find the right image format driver */ |
129c7d1c | 3683 | /* See cautionary note on accessing @options above */ |
76c591b0 KW |
3684 | drvname = qdict_get_try_str(options, "driver"); |
3685 | if (drvname) { | |
3686 | drv = bdrv_find_format(drvname); | |
76c591b0 KW |
3687 | if (!drv) { |
3688 | error_setg(errp, "Unknown driver: '%s'", drvname); | |
76c591b0 KW |
3689 | goto fail; |
3690 | } | |
3691 | } | |
3692 | ||
3693 | assert(drvname || !(flags & BDRV_O_PROTOCOL)); | |
76c591b0 | 3694 | |
129c7d1c | 3695 | /* See cautionary note on accessing @options above */ |
3e8c2e57 | 3696 | backing = qdict_get_try_str(options, "backing"); |
e59a0cf1 HR |
3697 | if (qobject_to(QNull, qdict_get(options, "backing")) != NULL || |
3698 | (backing && *backing == '\0')) | |
3699 | { | |
4f7be280 HR |
3700 | if (backing) { |
3701 | warn_report("Use of \"backing\": \"\" is deprecated; " | |
3702 | "use \"backing\": null instead"); | |
3703 | } | |
3e8c2e57 | 3704 | flags |= BDRV_O_NO_BACKING; |
ae0f57f0 KW |
3705 | qdict_del(bs->explicit_options, "backing"); |
3706 | qdict_del(bs->options, "backing"); | |
3e8c2e57 AG |
3707 | qdict_del(options, "backing"); |
3708 | } | |
3709 | ||
5696c6e3 | 3710 | /* Open image file without format layer. This BlockBackend is only used for |
4e4bf5c4 KW |
3711 | * probing, the block drivers will do their own bdrv_open_child() for the |
3712 | * same BDS, which is why we put the node name back into options. */ | |
f4788adc | 3713 | if ((flags & BDRV_O_PROTOCOL) == 0) { |
5696c6e3 KW |
3714 | BlockDriverState *file_bs; |
3715 | ||
3716 | file_bs = bdrv_open_child_bs(filename, options, "file", bs, | |
58944401 HR |
3717 | &child_of_bds, BDRV_CHILD_IMAGE, |
3718 | true, &local_err); | |
1fdd6933 | 3719 | if (local_err) { |
f4788adc KW |
3720 | goto fail; |
3721 | } | |
5696c6e3 | 3722 | if (file_bs != NULL) { |
dacaa162 KW |
3723 | /* Not requesting BLK_PERM_CONSISTENT_READ because we're only |
3724 | * looking at the header to guess the image format. This works even | |
3725 | * in cases where a guest would not see a consistent state. */ | |
d861ab3a | 3726 | file = blk_new(bdrv_get_aio_context(file_bs), 0, BLK_PERM_ALL); |
d7086422 | 3727 | blk_insert_bs(file, file_bs, &local_err); |
5696c6e3 | 3728 | bdrv_unref(file_bs); |
d7086422 KW |
3729 | if (local_err) { |
3730 | goto fail; | |
3731 | } | |
5696c6e3 | 3732 | |
46f5ac20 | 3733 | qdict_put_str(options, "file", bdrv_get_node_name(file_bs)); |
4e4bf5c4 | 3734 | } |
f500a6d3 KW |
3735 | } |
3736 | ||
76c591b0 | 3737 | /* Image format probing */ |
38f3ef57 | 3738 | bs->probed = !drv; |
76c591b0 | 3739 | if (!drv && file) { |
cf2ab8fc | 3740 | ret = find_image_format(file, filename, &drv, &local_err); |
17b005f1 | 3741 | if (ret < 0) { |
8bfea15d | 3742 | goto fail; |
2a05cbe4 | 3743 | } |
62392ebb KW |
3744 | /* |
3745 | * This option update would logically belong in bdrv_fill_options(), | |
3746 | * but we first need to open bs->file for the probing to work, while | |
3747 | * opening bs->file already requires the (mostly) final set of options | |
3748 | * so that cache mode etc. can be inherited. | |
3749 | * | |
3750 | * Adding the driver later is somewhat ugly, but it's not an option | |
3751 | * that would ever be inherited, so it's correct. We just need to make | |
3752 | * sure to update both bs->options (which has the full effective | |
3753 | * options for bs) and options (which has file.* already removed). | |
3754 | */ | |
46f5ac20 EB |
3755 | qdict_put_str(bs->options, "driver", drv->format_name); |
3756 | qdict_put_str(options, "driver", drv->format_name); | |
76c591b0 | 3757 | } else if (!drv) { |
17b005f1 | 3758 | error_setg(errp, "Must specify either driver or file"); |
8bfea15d | 3759 | goto fail; |
ea2384d3 | 3760 | } |
b6ce07aa | 3761 | |
53a29513 HR |
3762 | /* BDRV_O_PROTOCOL must be set iff a protocol BDS is about to be created */ |
3763 | assert(!!(flags & BDRV_O_PROTOCOL) == !!drv->bdrv_file_open); | |
3764 | /* file must be NULL if a protocol BDS is about to be created | |
3765 | * (the inverse results in an error message from bdrv_open_common()) */ | |
3766 | assert(!(flags & BDRV_O_PROTOCOL) || !file); | |
3767 | ||
b6ce07aa | 3768 | /* Open the image */ |
82dc8b41 | 3769 | ret = bdrv_open_common(bs, file, options, &local_err); |
b6ce07aa | 3770 | if (ret < 0) { |
8bfea15d | 3771 | goto fail; |
6987307c CH |
3772 | } |
3773 | ||
4e4bf5c4 | 3774 | if (file) { |
5696c6e3 | 3775 | blk_unref(file); |
f500a6d3 KW |
3776 | file = NULL; |
3777 | } | |
3778 | ||
b6ce07aa | 3779 | /* If there is a backing file, use it */ |
9156df12 | 3780 | if ((flags & BDRV_O_NO_BACKING) == 0) { |
d9b7b057 | 3781 | ret = bdrv_open_backing_file(bs, options, "backing", &local_err); |
b6ce07aa | 3782 | if (ret < 0) { |
b6ad491a | 3783 | goto close_and_fail; |
b6ce07aa | 3784 | } |
b6ce07aa KW |
3785 | } |
3786 | ||
50196d7a AG |
3787 | /* Remove all children options and references |
3788 | * from bs->options and bs->explicit_options */ | |
2f624b80 AG |
3789 | QLIST_FOREACH(child, &bs->children, next) { |
3790 | char *child_key_dot; | |
3791 | child_key_dot = g_strdup_printf("%s.", child->name); | |
3792 | qdict_extract_subqdict(bs->explicit_options, NULL, child_key_dot); | |
3793 | qdict_extract_subqdict(bs->options, NULL, child_key_dot); | |
50196d7a AG |
3794 | qdict_del(bs->explicit_options, child->name); |
3795 | qdict_del(bs->options, child->name); | |
2f624b80 AG |
3796 | g_free(child_key_dot); |
3797 | } | |
3798 | ||
b6ad491a | 3799 | /* Check if any unknown options were used */ |
7ad2757f | 3800 | if (qdict_size(options) != 0) { |
b6ad491a | 3801 | const QDictEntry *entry = qdict_first(options); |
5acd9d81 HR |
3802 | if (flags & BDRV_O_PROTOCOL) { |
3803 | error_setg(errp, "Block protocol '%s' doesn't support the option " | |
3804 | "'%s'", drv->format_name, entry->key); | |
3805 | } else { | |
d0e46a55 HR |
3806 | error_setg(errp, |
3807 | "Block format '%s' does not support the option '%s'", | |
3808 | drv->format_name, entry->key); | |
5acd9d81 | 3809 | } |
b6ad491a | 3810 | |
b6ad491a KW |
3811 | goto close_and_fail; |
3812 | } | |
b6ad491a | 3813 | |
c01c214b | 3814 | bdrv_parent_cb_change_media(bs, true); |
b6ce07aa | 3815 | |
cb3e7f08 | 3816 | qobject_unref(options); |
8961be33 | 3817 | options = NULL; |
dd62f1ca KW |
3818 | |
3819 | /* For snapshot=on, create a temporary qcow2 overlay. bs points to the | |
3820 | * temporary snapshot afterwards. */ | |
3821 | if (snapshot_flags) { | |
66836189 HR |
3822 | BlockDriverState *snapshot_bs; |
3823 | snapshot_bs = bdrv_append_temp_snapshot(bs, snapshot_flags, | |
3824 | snapshot_options, &local_err); | |
73176bee | 3825 | snapshot_options = NULL; |
dd62f1ca KW |
3826 | if (local_err) { |
3827 | goto close_and_fail; | |
3828 | } | |
5b363937 HR |
3829 | /* We are not going to return bs but the overlay on top of it |
3830 | * (snapshot_bs); thus, we have to drop the strong reference to bs | |
3831 | * (which we obtained by calling bdrv_new()). bs will not be deleted, | |
3832 | * though, because the overlay still has a reference to it. */ | |
3833 | bdrv_unref(bs); | |
3834 | bs = snapshot_bs; | |
dd62f1ca KW |
3835 | } |
3836 | ||
5b363937 | 3837 | return bs; |
b6ce07aa | 3838 | |
8bfea15d | 3839 | fail: |
5696c6e3 | 3840 | blk_unref(file); |
cb3e7f08 MAL |
3841 | qobject_unref(snapshot_options); |
3842 | qobject_unref(bs->explicit_options); | |
3843 | qobject_unref(bs->options); | |
3844 | qobject_unref(options); | |
de9c0cec | 3845 | bs->options = NULL; |
998cbd6a | 3846 | bs->explicit_options = NULL; |
5b363937 | 3847 | bdrv_unref(bs); |
621ff94d | 3848 | error_propagate(errp, local_err); |
5b363937 | 3849 | return NULL; |
de9c0cec | 3850 | |
b6ad491a | 3851 | close_and_fail: |
5b363937 | 3852 | bdrv_unref(bs); |
cb3e7f08 MAL |
3853 | qobject_unref(snapshot_options); |
3854 | qobject_unref(options); | |
621ff94d | 3855 | error_propagate(errp, local_err); |
5b363937 | 3856 | return NULL; |
b6ce07aa KW |
3857 | } |
3858 | ||
5b363937 HR |
3859 | BlockDriverState *bdrv_open(const char *filename, const char *reference, |
3860 | QDict *options, int flags, Error **errp) | |
f3930ed0 | 3861 | { |
5b363937 | 3862 | return bdrv_open_inherit(filename, reference, options, flags, NULL, |
272c02ea | 3863 | NULL, 0, errp); |
f3930ed0 KW |
3864 | } |
3865 | ||
faf116b4 AG |
3866 | /* Return true if the NULL-terminated @list contains @str */ |
3867 | static bool is_str_in_list(const char *str, const char *const *list) | |
3868 | { | |
3869 | if (str && list) { | |
3870 | int i; | |
3871 | for (i = 0; list[i] != NULL; i++) { | |
3872 | if (!strcmp(str, list[i])) { | |
3873 | return true; | |
3874 | } | |
3875 | } | |
3876 | } | |
3877 | return false; | |
3878 | } | |
3879 | ||
3880 | /* | |
3881 | * Check that every option set in @bs->options is also set in | |
3882 | * @new_opts. | |
3883 | * | |
3884 | * Options listed in the common_options list and in | |
3885 | * @bs->drv->mutable_opts are skipped. | |
3886 | * | |
3887 | * Return 0 on success, otherwise return -EINVAL and set @errp. | |
3888 | */ | |
3889 | static int bdrv_reset_options_allowed(BlockDriverState *bs, | |
3890 | const QDict *new_opts, Error **errp) | |
3891 | { | |
3892 | const QDictEntry *e; | |
3893 | /* These options are common to all block drivers and are handled | |
3894 | * in bdrv_reopen_prepare() so they can be left out of @new_opts */ | |
3895 | const char *const common_options[] = { | |
3896 | "node-name", "discard", "cache.direct", "cache.no-flush", | |
3897 | "read-only", "auto-read-only", "detect-zeroes", NULL | |
3898 | }; | |
3899 | ||
3900 | for (e = qdict_first(bs->options); e; e = qdict_next(bs->options, e)) { | |
3901 | if (!qdict_haskey(new_opts, e->key) && | |
3902 | !is_str_in_list(e->key, common_options) && | |
3903 | !is_str_in_list(e->key, bs->drv->mutable_opts)) { | |
3904 | error_setg(errp, "Option '%s' cannot be reset " | |
3905 | "to its default value", e->key); | |
3906 | return -EINVAL; | |
3907 | } | |
3908 | } | |
3909 | ||
3910 | return 0; | |
3911 | } | |
3912 | ||
cb828c31 AG |
3913 | /* |
3914 | * Returns true if @child can be reached recursively from @bs | |
3915 | */ | |
3916 | static bool bdrv_recurse_has_child(BlockDriverState *bs, | |
3917 | BlockDriverState *child) | |
3918 | { | |
3919 | BdrvChild *c; | |
3920 | ||
3921 | if (bs == child) { | |
3922 | return true; | |
3923 | } | |
3924 | ||
3925 | QLIST_FOREACH(c, &bs->children, next) { | |
3926 | if (bdrv_recurse_has_child(c->bs, child)) { | |
3927 | return true; | |
3928 | } | |
3929 | } | |
3930 | ||
3931 | return false; | |
3932 | } | |
3933 | ||
e971aa12 JC |
3934 | /* |
3935 | * Adds a BlockDriverState to a simple queue for an atomic, transactional | |
3936 | * reopen of multiple devices. | |
3937 | * | |
859443b0 | 3938 | * bs_queue can either be an existing BlockReopenQueue that has had QTAILQ_INIT |
e971aa12 JC |
3939 | * already performed, or alternatively may be NULL a new BlockReopenQueue will |
3940 | * be created and initialized. This newly created BlockReopenQueue should be | |
3941 | * passed back in for subsequent calls that are intended to be of the same | |
3942 | * atomic 'set'. | |
3943 | * | |
3944 | * bs is the BlockDriverState to add to the reopen queue. | |
3945 | * | |
4d2cb092 KW |
3946 | * options contains the changed options for the associated bs |
3947 | * (the BlockReopenQueue takes ownership) | |
3948 | * | |
e971aa12 JC |
3949 | * flags contains the open flags for the associated bs |
3950 | * | |
3951 | * returns a pointer to bs_queue, which is either the newly allocated | |
3952 | * bs_queue, or the existing bs_queue being used. | |
3953 | * | |
1a63a907 | 3954 | * bs must be drained between bdrv_reopen_queue() and bdrv_reopen_multiple(). |
e971aa12 | 3955 | */ |
28518102 KW |
3956 | static BlockReopenQueue *bdrv_reopen_queue_child(BlockReopenQueue *bs_queue, |
3957 | BlockDriverState *bs, | |
3958 | QDict *options, | |
bd86fb99 | 3959 | const BdrvChildClass *klass, |
272c02ea | 3960 | BdrvChildRole role, |
3cdc69d3 | 3961 | bool parent_is_format, |
28518102 | 3962 | QDict *parent_options, |
077e8e20 AG |
3963 | int parent_flags, |
3964 | bool keep_old_opts) | |
e971aa12 JC |
3965 | { |
3966 | assert(bs != NULL); | |
3967 | ||
3968 | BlockReopenQueueEntry *bs_entry; | |
67251a31 | 3969 | BdrvChild *child; |
9aa09ddd AG |
3970 | QDict *old_options, *explicit_options, *options_copy; |
3971 | int flags; | |
3972 | QemuOpts *opts; | |
67251a31 | 3973 | |
1a63a907 KW |
3974 | /* Make sure that the caller remembered to use a drained section. This is |
3975 | * important to avoid graph changes between the recursive queuing here and | |
3976 | * bdrv_reopen_multiple(). */ | |
3977 | assert(bs->quiesce_counter > 0); | |
3978 | ||
e971aa12 JC |
3979 | if (bs_queue == NULL) { |
3980 | bs_queue = g_new0(BlockReopenQueue, 1); | |
859443b0 | 3981 | QTAILQ_INIT(bs_queue); |
e971aa12 JC |
3982 | } |
3983 | ||
4d2cb092 KW |
3984 | if (!options) { |
3985 | options = qdict_new(); | |
3986 | } | |
3987 | ||
5b7ba05f | 3988 | /* Check if this BlockDriverState is already in the queue */ |
859443b0 | 3989 | QTAILQ_FOREACH(bs_entry, bs_queue, entry) { |
5b7ba05f AG |
3990 | if (bs == bs_entry->state.bs) { |
3991 | break; | |
3992 | } | |
3993 | } | |
3994 | ||
28518102 KW |
3995 | /* |
3996 | * Precedence of options: | |
3997 | * 1. Explicitly passed in options (highest) | |
9aa09ddd AG |
3998 | * 2. Retained from explicitly set options of bs |
3999 | * 3. Inherited from parent node | |
4000 | * 4. Retained from effective options of bs | |
28518102 KW |
4001 | */ |
4002 | ||
145f598e | 4003 | /* Old explicitly set values (don't overwrite by inherited value) */ |
077e8e20 AG |
4004 | if (bs_entry || keep_old_opts) { |
4005 | old_options = qdict_clone_shallow(bs_entry ? | |
4006 | bs_entry->state.explicit_options : | |
4007 | bs->explicit_options); | |
4008 | bdrv_join_options(bs, options, old_options); | |
4009 | qobject_unref(old_options); | |
5b7ba05f | 4010 | } |
145f598e KW |
4011 | |
4012 | explicit_options = qdict_clone_shallow(options); | |
4013 | ||
28518102 KW |
4014 | /* Inherit from parent node */ |
4015 | if (parent_options) { | |
9aa09ddd | 4016 | flags = 0; |
3cdc69d3 | 4017 | klass->inherit_options(role, parent_is_format, &flags, options, |
272c02ea | 4018 | parent_flags, parent_options); |
9aa09ddd AG |
4019 | } else { |
4020 | flags = bdrv_get_flags(bs); | |
28518102 KW |
4021 | } |
4022 | ||
077e8e20 AG |
4023 | if (keep_old_opts) { |
4024 | /* Old values are used for options that aren't set yet */ | |
4025 | old_options = qdict_clone_shallow(bs->options); | |
4026 | bdrv_join_options(bs, options, old_options); | |
4027 | qobject_unref(old_options); | |
4028 | } | |
4d2cb092 | 4029 | |
9aa09ddd AG |
4030 | /* We have the final set of options so let's update the flags */ |
4031 | options_copy = qdict_clone_shallow(options); | |
4032 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); | |
4033 | qemu_opts_absorb_qdict(opts, options_copy, NULL); | |
4034 | update_flags_from_options(&flags, opts); | |
4035 | qemu_opts_del(opts); | |
4036 | qobject_unref(options_copy); | |
4037 | ||
fd452021 | 4038 | /* bdrv_open_inherit() sets and clears some additional flags internally */ |
f1f25a2e | 4039 | flags &= ~BDRV_O_PROTOCOL; |
fd452021 KW |
4040 | if (flags & BDRV_O_RDWR) { |
4041 | flags |= BDRV_O_ALLOW_RDWR; | |
4042 | } | |
f1f25a2e | 4043 | |
1857c97b KW |
4044 | if (!bs_entry) { |
4045 | bs_entry = g_new0(BlockReopenQueueEntry, 1); | |
859443b0 | 4046 | QTAILQ_INSERT_TAIL(bs_queue, bs_entry, entry); |
1857c97b | 4047 | } else { |
cb3e7f08 MAL |
4048 | qobject_unref(bs_entry->state.options); |
4049 | qobject_unref(bs_entry->state.explicit_options); | |
1857c97b KW |
4050 | } |
4051 | ||
4052 | bs_entry->state.bs = bs; | |
4053 | bs_entry->state.options = options; | |
4054 | bs_entry->state.explicit_options = explicit_options; | |
4055 | bs_entry->state.flags = flags; | |
4056 | ||
8546632e AG |
4057 | /* |
4058 | * If keep_old_opts is false then it means that unspecified | |
4059 | * options must be reset to their original value. We don't allow | |
4060 | * resetting 'backing' but we need to know if the option is | |
4061 | * missing in order to decide if we have to return an error. | |
4062 | */ | |
4063 | if (!keep_old_opts) { | |
4064 | bs_entry->state.backing_missing = | |
4065 | !qdict_haskey(options, "backing") && | |
4066 | !qdict_haskey(options, "backing.driver"); | |
4067 | } | |
4068 | ||
67251a31 | 4069 | QLIST_FOREACH(child, &bs->children, next) { |
8546632e AG |
4070 | QDict *new_child_options = NULL; |
4071 | bool child_keep_old = keep_old_opts; | |
67251a31 | 4072 | |
4c9dfe5d KW |
4073 | /* reopen can only change the options of block devices that were |
4074 | * implicitly created and inherited options. For other (referenced) | |
4075 | * block devices, a syntax like "backing.foo" results in an error. */ | |
67251a31 KW |
4076 | if (child->bs->inherits_from != bs) { |
4077 | continue; | |
4078 | } | |
4079 | ||
8546632e AG |
4080 | /* Check if the options contain a child reference */ |
4081 | if (qdict_haskey(options, child->name)) { | |
4082 | const char *childref = qdict_get_try_str(options, child->name); | |
4083 | /* | |
4084 | * The current child must not be reopened if the child | |
4085 | * reference is null or points to a different node. | |
4086 | */ | |
4087 | if (g_strcmp0(childref, child->bs->node_name)) { | |
4088 | continue; | |
4089 | } | |
4090 | /* | |
4091 | * If the child reference points to the current child then | |
4092 | * reopen it with its existing set of options (note that | |
4093 | * it can still inherit new options from the parent). | |
4094 | */ | |
4095 | child_keep_old = true; | |
4096 | } else { | |
4097 | /* Extract child options ("child-name.*") */ | |
4098 | char *child_key_dot = g_strdup_printf("%s.", child->name); | |
4099 | qdict_extract_subqdict(explicit_options, NULL, child_key_dot); | |
4100 | qdict_extract_subqdict(options, &new_child_options, child_key_dot); | |
4101 | g_free(child_key_dot); | |
4102 | } | |
4c9dfe5d | 4103 | |
9aa09ddd | 4104 | bdrv_reopen_queue_child(bs_queue, child->bs, new_child_options, |
3cdc69d3 HR |
4105 | child->klass, child->role, bs->drv->is_format, |
4106 | options, flags, child_keep_old); | |
e971aa12 JC |
4107 | } |
4108 | ||
e971aa12 JC |
4109 | return bs_queue; |
4110 | } | |
4111 | ||
28518102 KW |
4112 | BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue, |
4113 | BlockDriverState *bs, | |
077e8e20 | 4114 | QDict *options, bool keep_old_opts) |
28518102 | 4115 | { |
3cdc69d3 HR |
4116 | return bdrv_reopen_queue_child(bs_queue, bs, options, NULL, 0, false, |
4117 | NULL, 0, keep_old_opts); | |
28518102 KW |
4118 | } |
4119 | ||
ab5b5228 AG |
4120 | void bdrv_reopen_queue_free(BlockReopenQueue *bs_queue) |
4121 | { | |
4122 | if (bs_queue) { | |
4123 | BlockReopenQueueEntry *bs_entry, *next; | |
4124 | QTAILQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) { | |
4125 | qobject_unref(bs_entry->state.explicit_options); | |
4126 | qobject_unref(bs_entry->state.options); | |
4127 | g_free(bs_entry); | |
4128 | } | |
4129 | g_free(bs_queue); | |
4130 | } | |
4131 | } | |
4132 | ||
e971aa12 JC |
4133 | /* |
4134 | * Reopen multiple BlockDriverStates atomically & transactionally. | |
4135 | * | |
4136 | * The queue passed in (bs_queue) must have been built up previous | |
4137 | * via bdrv_reopen_queue(). | |
4138 | * | |
4139 | * Reopens all BDS specified in the queue, with the appropriate | |
4140 | * flags. All devices are prepared for reopen, and failure of any | |
50d6a8a3 | 4141 | * device will cause all device changes to be abandoned, and intermediate |
e971aa12 JC |
4142 | * data cleaned up. |
4143 | * | |
4144 | * If all devices prepare successfully, then the changes are committed | |
4145 | * to all devices. | |
4146 | * | |
1a63a907 KW |
4147 | * All affected nodes must be drained between bdrv_reopen_queue() and |
4148 | * bdrv_reopen_multiple(). | |
6cf42ca2 KW |
4149 | * |
4150 | * To be called from the main thread, with all other AioContexts unlocked. | |
e971aa12 | 4151 | */ |
5019aece | 4152 | int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp) |
e971aa12 JC |
4153 | { |
4154 | int ret = -1; | |
4155 | BlockReopenQueueEntry *bs_entry, *next; | |
6cf42ca2 | 4156 | AioContext *ctx; |
72373e40 VSO |
4157 | Transaction *tran = tran_new(); |
4158 | g_autoptr(GHashTable) found = NULL; | |
4159 | g_autoptr(GSList) refresh_list = NULL; | |
e971aa12 | 4160 | |
6cf42ca2 | 4161 | assert(qemu_get_current_aio_context() == qemu_get_aio_context()); |
e971aa12 JC |
4162 | assert(bs_queue != NULL); |
4163 | ||
a2aabf88 | 4164 | QTAILQ_FOREACH(bs_entry, bs_queue, entry) { |
6cf42ca2 KW |
4165 | ctx = bdrv_get_aio_context(bs_entry->state.bs); |
4166 | aio_context_acquire(ctx); | |
a2aabf88 | 4167 | ret = bdrv_flush(bs_entry->state.bs); |
6cf42ca2 | 4168 | aio_context_release(ctx); |
a2aabf88 VSO |
4169 | if (ret < 0) { |
4170 | error_setg_errno(errp, -ret, "Error flushing drive"); | |
e3fc91aa | 4171 | goto abort; |
a2aabf88 VSO |
4172 | } |
4173 | } | |
4174 | ||
859443b0 | 4175 | QTAILQ_FOREACH(bs_entry, bs_queue, entry) { |
1a63a907 | 4176 | assert(bs_entry->state.bs->quiesce_counter > 0); |
6cf42ca2 KW |
4177 | ctx = bdrv_get_aio_context(bs_entry->state.bs); |
4178 | aio_context_acquire(ctx); | |
72373e40 | 4179 | ret = bdrv_reopen_prepare(&bs_entry->state, bs_queue, tran, errp); |
6cf42ca2 | 4180 | aio_context_release(ctx); |
72373e40 VSO |
4181 | if (ret < 0) { |
4182 | goto abort; | |
e971aa12 JC |
4183 | } |
4184 | bs_entry->prepared = true; | |
4185 | } | |
4186 | ||
72373e40 | 4187 | found = g_hash_table_new(NULL, NULL); |
859443b0 | 4188 | QTAILQ_FOREACH(bs_entry, bs_queue, entry) { |
69b736e7 | 4189 | BDRVReopenState *state = &bs_entry->state; |
72373e40 VSO |
4190 | |
4191 | refresh_list = bdrv_topological_dfs(refresh_list, found, state->bs); | |
4192 | if (state->old_backing_bs) { | |
4193 | refresh_list = bdrv_topological_dfs(refresh_list, found, | |
4194 | state->old_backing_bs); | |
cb828c31 | 4195 | } |
ecd30d2d AG |
4196 | if (state->old_file_bs) { |
4197 | refresh_list = bdrv_topological_dfs(refresh_list, found, | |
4198 | state->old_file_bs); | |
4199 | } | |
72373e40 VSO |
4200 | } |
4201 | ||
4202 | /* | |
4203 | * Note that file-posix driver rely on permission update done during reopen | |
4204 | * (even if no permission changed), because it wants "new" permissions for | |
4205 | * reconfiguring the fd and that's why it does it in raw_check_perm(), not | |
4206 | * in raw_reopen_prepare() which is called with "old" permissions. | |
4207 | */ | |
4208 | ret = bdrv_list_refresh_perms(refresh_list, bs_queue, tran, errp); | |
4209 | if (ret < 0) { | |
4210 | goto abort; | |
69b736e7 KW |
4211 | } |
4212 | ||
fcd6a4f4 VSO |
4213 | /* |
4214 | * If we reach this point, we have success and just need to apply the | |
4215 | * changes. | |
4216 | * | |
4217 | * Reverse order is used to comfort qcow2 driver: on commit it need to write | |
4218 | * IN_USE flag to the image, to mark bitmaps in the image as invalid. But | |
4219 | * children are usually goes after parents in reopen-queue, so go from last | |
4220 | * to first element. | |
e971aa12 | 4221 | */ |
fcd6a4f4 | 4222 | QTAILQ_FOREACH_REVERSE(bs_entry, bs_queue, entry) { |
6cf42ca2 KW |
4223 | ctx = bdrv_get_aio_context(bs_entry->state.bs); |
4224 | aio_context_acquire(ctx); | |
e971aa12 | 4225 | bdrv_reopen_commit(&bs_entry->state); |
6cf42ca2 | 4226 | aio_context_release(ctx); |
e971aa12 JC |
4227 | } |
4228 | ||
72373e40 | 4229 | tran_commit(tran); |
69b736e7 | 4230 | |
72373e40 VSO |
4231 | QTAILQ_FOREACH_REVERSE(bs_entry, bs_queue, entry) { |
4232 | BlockDriverState *bs = bs_entry->state.bs; | |
74ad9a3b | 4233 | |
72373e40 | 4234 | if (bs->drv->bdrv_reopen_commit_post) { |
6cf42ca2 KW |
4235 | ctx = bdrv_get_aio_context(bs); |
4236 | aio_context_acquire(ctx); | |
72373e40 | 4237 | bs->drv->bdrv_reopen_commit_post(&bs_entry->state); |
6cf42ca2 | 4238 | aio_context_release(ctx); |
69b736e7 KW |
4239 | } |
4240 | } | |
17e1e2be | 4241 | |
72373e40 VSO |
4242 | ret = 0; |
4243 | goto cleanup; | |
17e1e2be | 4244 | |
72373e40 VSO |
4245 | abort: |
4246 | tran_abort(tran); | |
4247 | QTAILQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) { | |
4248 | if (bs_entry->prepared) { | |
6cf42ca2 KW |
4249 | ctx = bdrv_get_aio_context(bs_entry->state.bs); |
4250 | aio_context_acquire(ctx); | |
72373e40 | 4251 | bdrv_reopen_abort(&bs_entry->state); |
6cf42ca2 | 4252 | aio_context_release(ctx); |
17e1e2be PK |
4253 | } |
4254 | } | |
72373e40 | 4255 | |
e971aa12 | 4256 | cleanup: |
ab5b5228 | 4257 | bdrv_reopen_queue_free(bs_queue); |
40840e41 | 4258 | |
e971aa12 JC |
4259 | return ret; |
4260 | } | |
4261 | ||
6cf42ca2 KW |
4262 | int bdrv_reopen(BlockDriverState *bs, QDict *opts, bool keep_old_opts, |
4263 | Error **errp) | |
6e1000a8 | 4264 | { |
6cf42ca2 | 4265 | AioContext *ctx = bdrv_get_aio_context(bs); |
6e1000a8 | 4266 | BlockReopenQueue *queue; |
6cf42ca2 | 4267 | int ret; |
6e1000a8 AG |
4268 | |
4269 | bdrv_subtree_drained_begin(bs); | |
6cf42ca2 KW |
4270 | if (ctx != qemu_get_aio_context()) { |
4271 | aio_context_release(ctx); | |
4272 | } | |
4273 | ||
4274 | queue = bdrv_reopen_queue(NULL, bs, opts, keep_old_opts); | |
5019aece | 4275 | ret = bdrv_reopen_multiple(queue, errp); |
6cf42ca2 KW |
4276 | |
4277 | if (ctx != qemu_get_aio_context()) { | |
4278 | aio_context_acquire(ctx); | |
4279 | } | |
6e1000a8 AG |
4280 | bdrv_subtree_drained_end(bs); |
4281 | ||
4282 | return ret; | |
4283 | } | |
4284 | ||
6cf42ca2 KW |
4285 | int bdrv_reopen_set_read_only(BlockDriverState *bs, bool read_only, |
4286 | Error **errp) | |
4287 | { | |
4288 | QDict *opts = qdict_new(); | |
4289 | ||
4290 | qdict_put_bool(opts, BDRV_OPT_READ_ONLY, read_only); | |
4291 | ||
4292 | return bdrv_reopen(bs, opts, true, errp); | |
4293 | } | |
4294 | ||
cb828c31 AG |
4295 | /* |
4296 | * Take a BDRVReopenState and check if the value of 'backing' in the | |
4297 | * reopen_state->options QDict is valid or not. | |
4298 | * | |
4299 | * If 'backing' is missing from the QDict then return 0. | |
4300 | * | |
4301 | * If 'backing' contains the node name of the backing file of | |
4302 | * reopen_state->bs then return 0. | |
4303 | * | |
4304 | * If 'backing' contains a different node name (or is null) then check | |
4305 | * whether the current backing file can be replaced with the new one. | |
4306 | * If that's the case then reopen_state->replace_backing_bs is set to | |
4307 | * true and reopen_state->new_backing_bs contains a pointer to the new | |
4308 | * backing BlockDriverState (or NULL). | |
4309 | * | |
4310 | * Return 0 on success, otherwise return < 0 and set @errp. | |
4311 | */ | |
ecd30d2d AG |
4312 | static int bdrv_reopen_parse_file_or_backing(BDRVReopenState *reopen_state, |
4313 | bool is_backing, Transaction *tran, | |
4314 | Error **errp) | |
cb828c31 AG |
4315 | { |
4316 | BlockDriverState *bs = reopen_state->bs; | |
ecd30d2d AG |
4317 | BlockDriverState *new_child_bs; |
4318 | BlockDriverState *old_child_bs = is_backing ? child_bs(bs->backing) : | |
4319 | child_bs(bs->file); | |
4320 | const char *child_name = is_backing ? "backing" : "file"; | |
cb828c31 AG |
4321 | QObject *value; |
4322 | const char *str; | |
4323 | ||
ecd30d2d | 4324 | value = qdict_get(reopen_state->options, child_name); |
cb828c31 AG |
4325 | if (value == NULL) { |
4326 | return 0; | |
4327 | } | |
4328 | ||
4329 | switch (qobject_type(value)) { | |
4330 | case QTYPE_QNULL: | |
ecd30d2d AG |
4331 | assert(is_backing); /* The 'file' option does not allow a null value */ |
4332 | new_child_bs = NULL; | |
cb828c31 AG |
4333 | break; |
4334 | case QTYPE_QSTRING: | |
410f44f5 | 4335 | str = qstring_get_str(qobject_to(QString, value)); |
ecd30d2d AG |
4336 | new_child_bs = bdrv_lookup_bs(NULL, str, errp); |
4337 | if (new_child_bs == NULL) { | |
cb828c31 | 4338 | return -EINVAL; |
ecd30d2d AG |
4339 | } else if (bdrv_recurse_has_child(new_child_bs, bs)) { |
4340 | error_setg(errp, "Making '%s' a %s child of '%s' would create a " | |
4341 | "cycle", str, child_name, bs->node_name); | |
cb828c31 AG |
4342 | return -EINVAL; |
4343 | } | |
4344 | break; | |
4345 | default: | |
ecd30d2d AG |
4346 | /* |
4347 | * The options QDict has been flattened, so 'backing' and 'file' | |
4348 | * do not allow any other data type here. | |
4349 | */ | |
cb828c31 AG |
4350 | g_assert_not_reached(); |
4351 | } | |
4352 | ||
ecd30d2d AG |
4353 | if (old_child_bs == new_child_bs) { |
4354 | return 0; | |
4355 | } | |
4356 | ||
4357 | if (old_child_bs) { | |
4358 | if (bdrv_skip_implicit_filters(old_child_bs) == new_child_bs) { | |
cbfdb98c VSO |
4359 | return 0; |
4360 | } | |
4361 | ||
ecd30d2d AG |
4362 | if (old_child_bs->implicit) { |
4363 | error_setg(errp, "Cannot replace implicit %s child of %s", | |
4364 | child_name, bs->node_name); | |
cbfdb98c VSO |
4365 | return -EPERM; |
4366 | } | |
4367 | } | |
4368 | ||
ecd30d2d | 4369 | if (bs->drv->is_filter && !old_child_bs) { |
25f78d9e VSO |
4370 | /* |
4371 | * Filters always have a file or a backing child, so we are trying to | |
4372 | * change wrong child | |
4373 | */ | |
4374 | error_setg(errp, "'%s' is a %s filter node that does not support a " | |
ecd30d2d | 4375 | "%s child", bs->node_name, bs->drv->format_name, child_name); |
1d42f48c HR |
4376 | return -EINVAL; |
4377 | } | |
4378 | ||
ecd30d2d AG |
4379 | if (is_backing) { |
4380 | reopen_state->old_backing_bs = old_child_bs; | |
4381 | } else { | |
4382 | reopen_state->old_file_bs = old_child_bs; | |
4383 | } | |
4384 | ||
4385 | return bdrv_set_file_or_backing_noperm(bs, new_child_bs, is_backing, | |
4386 | tran, errp); | |
cb828c31 AG |
4387 | } |
4388 | ||
e971aa12 JC |
4389 | /* |
4390 | * Prepares a BlockDriverState for reopen. All changes are staged in the | |
4391 | * 'opaque' field of the BDRVReopenState, which is used and allocated by | |
4392 | * the block driver layer .bdrv_reopen_prepare() | |
4393 | * | |
4394 | * bs is the BlockDriverState to reopen | |
4395 | * flags are the new open flags | |
4396 | * queue is the reopen queue | |
4397 | * | |
4398 | * Returns 0 on success, non-zero on error. On error errp will be set | |
4399 | * as well. | |
4400 | * | |
4401 | * On failure, bdrv_reopen_abort() will be called to clean up any data. | |
4402 | * It is the responsibility of the caller to then call the abort() or | |
4403 | * commit() for any other BDS that have been left in a prepare() state | |
4404 | * | |
4405 | */ | |
53e96d1e | 4406 | static int bdrv_reopen_prepare(BDRVReopenState *reopen_state, |
72373e40 | 4407 | BlockReopenQueue *queue, |
ecd30d2d | 4408 | Transaction *change_child_tran, Error **errp) |
e971aa12 JC |
4409 | { |
4410 | int ret = -1; | |
e6d79c41 | 4411 | int old_flags; |
e971aa12 JC |
4412 | Error *local_err = NULL; |
4413 | BlockDriver *drv; | |
ccf9dc07 | 4414 | QemuOpts *opts; |
4c8350fe | 4415 | QDict *orig_reopen_opts; |
593b3071 | 4416 | char *discard = NULL; |
3d8ce171 | 4417 | bool read_only; |
9ad08c44 | 4418 | bool drv_prepared = false; |
e971aa12 JC |
4419 | |
4420 | assert(reopen_state != NULL); | |
4421 | assert(reopen_state->bs->drv != NULL); | |
4422 | drv = reopen_state->bs->drv; | |
4423 | ||
4c8350fe AG |
4424 | /* This function and each driver's bdrv_reopen_prepare() remove |
4425 | * entries from reopen_state->options as they are processed, so | |
4426 | * we need to make a copy of the original QDict. */ | |
4427 | orig_reopen_opts = qdict_clone_shallow(reopen_state->options); | |
4428 | ||
ccf9dc07 KW |
4429 | /* Process generic block layer options */ |
4430 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); | |
af175e85 | 4431 | if (!qemu_opts_absorb_qdict(opts, reopen_state->options, errp)) { |
ccf9dc07 KW |
4432 | ret = -EINVAL; |
4433 | goto error; | |
4434 | } | |
4435 | ||
e6d79c41 AG |
4436 | /* This was already called in bdrv_reopen_queue_child() so the flags |
4437 | * are up-to-date. This time we simply want to remove the options from | |
4438 | * QemuOpts in order to indicate that they have been processed. */ | |
4439 | old_flags = reopen_state->flags; | |
91a097e7 | 4440 | update_flags_from_options(&reopen_state->flags, opts); |
e6d79c41 | 4441 | assert(old_flags == reopen_state->flags); |
91a097e7 | 4442 | |
415bbca8 | 4443 | discard = qemu_opt_get_del(opts, BDRV_OPT_DISCARD); |
593b3071 AG |
4444 | if (discard != NULL) { |
4445 | if (bdrv_parse_discard_flags(discard, &reopen_state->flags) != 0) { | |
4446 | error_setg(errp, "Invalid discard option"); | |
4447 | ret = -EINVAL; | |
4448 | goto error; | |
4449 | } | |
4450 | } | |
4451 | ||
543770bd AG |
4452 | reopen_state->detect_zeroes = |
4453 | bdrv_parse_detect_zeroes(opts, reopen_state->flags, &local_err); | |
4454 | if (local_err) { | |
4455 | error_propagate(errp, local_err); | |
4456 | ret = -EINVAL; | |
4457 | goto error; | |
4458 | } | |
4459 | ||
57f9db9a AG |
4460 | /* All other options (including node-name and driver) must be unchanged. |
4461 | * Put them back into the QDict, so that they are checked at the end | |
4462 | * of this function. */ | |
4463 | qemu_opts_to_qdict(opts, reopen_state->options); | |
ccf9dc07 | 4464 | |
3d8ce171 JC |
4465 | /* If we are to stay read-only, do not allow permission change |
4466 | * to r/w. Attempting to set to r/w may fail if either BDRV_O_ALLOW_RDWR is | |
4467 | * not set, or if the BDS still has copy_on_read enabled */ | |
4468 | read_only = !(reopen_state->flags & BDRV_O_RDWR); | |
54a32bfe | 4469 | ret = bdrv_can_set_read_only(reopen_state->bs, read_only, true, &local_err); |
3d8ce171 JC |
4470 | if (local_err) { |
4471 | error_propagate(errp, local_err); | |
e971aa12 JC |
4472 | goto error; |
4473 | } | |
4474 | ||
e971aa12 | 4475 | if (drv->bdrv_reopen_prepare) { |
faf116b4 AG |
4476 | /* |
4477 | * If a driver-specific option is missing, it means that we | |
4478 | * should reset it to its default value. | |
4479 | * But not all options allow that, so we need to check it first. | |
4480 | */ | |
4481 | ret = bdrv_reset_options_allowed(reopen_state->bs, | |
4482 | reopen_state->options, errp); | |
4483 | if (ret) { | |
4484 | goto error; | |
4485 | } | |
4486 | ||
e971aa12 JC |
4487 | ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err); |
4488 | if (ret) { | |
4489 | if (local_err != NULL) { | |
4490 | error_propagate(errp, local_err); | |
4491 | } else { | |
f30c66ba | 4492 | bdrv_refresh_filename(reopen_state->bs); |
d8b6895f LC |
4493 | error_setg(errp, "failed while preparing to reopen image '%s'", |
4494 | reopen_state->bs->filename); | |
e971aa12 JC |
4495 | } |
4496 | goto error; | |
4497 | } | |
4498 | } else { | |
4499 | /* It is currently mandatory to have a bdrv_reopen_prepare() | |
4500 | * handler for each supported drv. */ | |
81e5f78a AG |
4501 | error_setg(errp, "Block format '%s' used by node '%s' " |
4502 | "does not support reopening files", drv->format_name, | |
4503 | bdrv_get_device_or_node_name(reopen_state->bs)); | |
e971aa12 JC |
4504 | ret = -1; |
4505 | goto error; | |
4506 | } | |
4507 | ||
9ad08c44 HR |
4508 | drv_prepared = true; |
4509 | ||
bacd9b87 AG |
4510 | /* |
4511 | * We must provide the 'backing' option if the BDS has a backing | |
4512 | * file or if the image file has a backing file name as part of | |
4513 | * its metadata. Otherwise the 'backing' option can be omitted. | |
4514 | */ | |
4515 | if (drv->supports_backing && reopen_state->backing_missing && | |
1d42f48c | 4516 | (reopen_state->bs->backing || reopen_state->bs->backing_file[0])) { |
8546632e AG |
4517 | error_setg(errp, "backing is missing for '%s'", |
4518 | reopen_state->bs->node_name); | |
4519 | ret = -EINVAL; | |
4520 | goto error; | |
4521 | } | |
4522 | ||
cb828c31 AG |
4523 | /* |
4524 | * Allow changing the 'backing' option. The new value can be | |
4525 | * either a reference to an existing node (using its node name) | |
4526 | * or NULL to simply detach the current backing file. | |
4527 | */ | |
ecd30d2d AG |
4528 | ret = bdrv_reopen_parse_file_or_backing(reopen_state, true, |
4529 | change_child_tran, errp); | |
cb828c31 AG |
4530 | if (ret < 0) { |
4531 | goto error; | |
4532 | } | |
4533 | qdict_del(reopen_state->options, "backing"); | |
4534 | ||
ecd30d2d AG |
4535 | /* Allow changing the 'file' option. In this case NULL is not allowed */ |
4536 | ret = bdrv_reopen_parse_file_or_backing(reopen_state, false, | |
4537 | change_child_tran, errp); | |
4538 | if (ret < 0) { | |
4539 | goto error; | |
4540 | } | |
4541 | qdict_del(reopen_state->options, "file"); | |
4542 | ||
4d2cb092 KW |
4543 | /* Options that are not handled are only okay if they are unchanged |
4544 | * compared to the old state. It is expected that some options are only | |
4545 | * used for the initial open, but not reopen (e.g. filename) */ | |
4546 | if (qdict_size(reopen_state->options)) { | |
4547 | const QDictEntry *entry = qdict_first(reopen_state->options); | |
4548 | ||
4549 | do { | |
54fd1b0d HR |
4550 | QObject *new = entry->value; |
4551 | QObject *old = qdict_get(reopen_state->bs->options, entry->key); | |
4552 | ||
db905283 AG |
4553 | /* Allow child references (child_name=node_name) as long as they |
4554 | * point to the current child (i.e. everything stays the same). */ | |
4555 | if (qobject_type(new) == QTYPE_QSTRING) { | |
4556 | BdrvChild *child; | |
4557 | QLIST_FOREACH(child, &reopen_state->bs->children, next) { | |
4558 | if (!strcmp(child->name, entry->key)) { | |
4559 | break; | |
4560 | } | |
4561 | } | |
4562 | ||
4563 | if (child) { | |
410f44f5 MA |
4564 | if (!strcmp(child->bs->node_name, |
4565 | qstring_get_str(qobject_to(QString, new)))) { | |
db905283 AG |
4566 | continue; /* Found child with this name, skip option */ |
4567 | } | |
4568 | } | |
4569 | } | |
4570 | ||
129c7d1c | 4571 | /* |
54fd1b0d HR |
4572 | * TODO: When using -drive to specify blockdev options, all values |
4573 | * will be strings; however, when using -blockdev, blockdev-add or | |
4574 | * filenames using the json:{} pseudo-protocol, they will be | |
4575 | * correctly typed. | |
4576 | * In contrast, reopening options are (currently) always strings | |
4577 | * (because you can only specify them through qemu-io; all other | |
4578 | * callers do not specify any options). | |
4579 | * Therefore, when using anything other than -drive to create a BDS, | |
4580 | * this cannot detect non-string options as unchanged, because | |
4581 | * qobject_is_equal() always returns false for objects of different | |
4582 | * type. In the future, this should be remedied by correctly typing | |
4583 | * all options. For now, this is not too big of an issue because | |
4584 | * the user can simply omit options which cannot be changed anyway, | |
4585 | * so they will stay unchanged. | |
129c7d1c | 4586 | */ |
54fd1b0d | 4587 | if (!qobject_is_equal(new, old)) { |
4d2cb092 KW |
4588 | error_setg(errp, "Cannot change the option '%s'", entry->key); |
4589 | ret = -EINVAL; | |
4590 | goto error; | |
4591 | } | |
4592 | } while ((entry = qdict_next(reopen_state->options, entry))); | |
4593 | } | |
4594 | ||
e971aa12 JC |
4595 | ret = 0; |
4596 | ||
4c8350fe AG |
4597 | /* Restore the original reopen_state->options QDict */ |
4598 | qobject_unref(reopen_state->options); | |
4599 | reopen_state->options = qobject_ref(orig_reopen_opts); | |
4600 | ||
e971aa12 | 4601 | error: |
9ad08c44 HR |
4602 | if (ret < 0 && drv_prepared) { |
4603 | /* drv->bdrv_reopen_prepare() has succeeded, so we need to | |
4604 | * call drv->bdrv_reopen_abort() before signaling an error | |
4605 | * (bdrv_reopen_multiple() will not call bdrv_reopen_abort() | |
4606 | * when the respective bdrv_reopen_prepare() has failed) */ | |
4607 | if (drv->bdrv_reopen_abort) { | |
4608 | drv->bdrv_reopen_abort(reopen_state); | |
4609 | } | |
4610 | } | |
ccf9dc07 | 4611 | qemu_opts_del(opts); |
4c8350fe | 4612 | qobject_unref(orig_reopen_opts); |
593b3071 | 4613 | g_free(discard); |
e971aa12 JC |
4614 | return ret; |
4615 | } | |
4616 | ||
4617 | /* | |
4618 | * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and | |
4619 | * makes them final by swapping the staging BlockDriverState contents into | |
4620 | * the active BlockDriverState contents. | |
4621 | */ | |
53e96d1e | 4622 | static void bdrv_reopen_commit(BDRVReopenState *reopen_state) |
e971aa12 JC |
4623 | { |
4624 | BlockDriver *drv; | |
50bf65ba | 4625 | BlockDriverState *bs; |
50196d7a | 4626 | BdrvChild *child; |
e971aa12 JC |
4627 | |
4628 | assert(reopen_state != NULL); | |
50bf65ba VSO |
4629 | bs = reopen_state->bs; |
4630 | drv = bs->drv; | |
e971aa12 JC |
4631 | assert(drv != NULL); |
4632 | ||
4633 | /* If there are any driver level actions to take */ | |
4634 | if (drv->bdrv_reopen_commit) { | |
4635 | drv->bdrv_reopen_commit(reopen_state); | |
4636 | } | |
4637 | ||
4638 | /* set BDS specific flags now */ | |
cb3e7f08 | 4639 | qobject_unref(bs->explicit_options); |
4c8350fe | 4640 | qobject_unref(bs->options); |
ab5b5228 AG |
4641 | qobject_ref(reopen_state->explicit_options); |
4642 | qobject_ref(reopen_state->options); | |
145f598e | 4643 | |
50bf65ba | 4644 | bs->explicit_options = reopen_state->explicit_options; |
4c8350fe | 4645 | bs->options = reopen_state->options; |
50bf65ba | 4646 | bs->open_flags = reopen_state->flags; |
543770bd | 4647 | bs->detect_zeroes = reopen_state->detect_zeroes; |
355ef4ac | 4648 | |
50196d7a AG |
4649 | /* Remove child references from bs->options and bs->explicit_options. |
4650 | * Child options were already removed in bdrv_reopen_queue_child() */ | |
4651 | QLIST_FOREACH(child, &bs->children, next) { | |
4652 | qdict_del(bs->explicit_options, child->name); | |
4653 | qdict_del(bs->options, child->name); | |
4654 | } | |
3d0e8743 VSO |
4655 | /* backing is probably removed, so it's not handled by previous loop */ |
4656 | qdict_del(bs->explicit_options, "backing"); | |
4657 | qdict_del(bs->options, "backing"); | |
4658 | ||
1e4c797c | 4659 | bdrv_refresh_limits(bs, NULL, NULL); |
e971aa12 JC |
4660 | } |
4661 | ||
4662 | /* | |
4663 | * Abort the reopen, and delete and free the staged changes in | |
4664 | * reopen_state | |
4665 | */ | |
53e96d1e | 4666 | static void bdrv_reopen_abort(BDRVReopenState *reopen_state) |
e971aa12 JC |
4667 | { |
4668 | BlockDriver *drv; | |
4669 | ||
4670 | assert(reopen_state != NULL); | |
4671 | drv = reopen_state->bs->drv; | |
4672 | assert(drv != NULL); | |
4673 | ||
4674 | if (drv->bdrv_reopen_abort) { | |
4675 | drv->bdrv_reopen_abort(reopen_state); | |
4676 | } | |
4677 | } | |
4678 | ||
4679 | ||
64dff520 | 4680 | static void bdrv_close(BlockDriverState *bs) |
fc01f7e7 | 4681 | { |
33384421 | 4682 | BdrvAioNotifier *ban, *ban_next; |
50a3efb0 | 4683 | BdrvChild *child, *next; |
33384421 | 4684 | |
30f55fb8 | 4685 | assert(!bs->refcnt); |
99b7e775 | 4686 | |
fc27291d | 4687 | bdrv_drained_begin(bs); /* complete I/O */ |
58fda173 | 4688 | bdrv_flush(bs); |
53ec73e2 | 4689 | bdrv_drain(bs); /* in case flush left pending I/O */ |
fc27291d | 4690 | |
3cbc002c | 4691 | if (bs->drv) { |
3c005293 | 4692 | if (bs->drv->bdrv_close) { |
7b99a266 | 4693 | /* Must unfreeze all children, so bdrv_unref_child() works */ |
3c005293 VSO |
4694 | bs->drv->bdrv_close(bs); |
4695 | } | |
9a4f4c31 | 4696 | bs->drv = NULL; |
50a3efb0 | 4697 | } |
9a7dedbc | 4698 | |
50a3efb0 | 4699 | QLIST_FOREACH_SAFE(child, &bs->children, next, next) { |
dd4118c7 | 4700 | bdrv_unref_child(bs, child); |
b338082b | 4701 | } |
98f90dba | 4702 | |
dd4118c7 AG |
4703 | bs->backing = NULL; |
4704 | bs->file = NULL; | |
50a3efb0 AG |
4705 | g_free(bs->opaque); |
4706 | bs->opaque = NULL; | |
d73415a3 | 4707 | qatomic_set(&bs->copy_on_read, 0); |
50a3efb0 AG |
4708 | bs->backing_file[0] = '\0'; |
4709 | bs->backing_format[0] = '\0'; | |
4710 | bs->total_sectors = 0; | |
4711 | bs->encrypted = false; | |
4712 | bs->sg = false; | |
cb3e7f08 MAL |
4713 | qobject_unref(bs->options); |
4714 | qobject_unref(bs->explicit_options); | |
50a3efb0 AG |
4715 | bs->options = NULL; |
4716 | bs->explicit_options = NULL; | |
cb3e7f08 | 4717 | qobject_unref(bs->full_open_options); |
50a3efb0 | 4718 | bs->full_open_options = NULL; |
0bc329fb HR |
4719 | g_free(bs->block_status_cache); |
4720 | bs->block_status_cache = NULL; | |
50a3efb0 | 4721 | |
cca43ae1 VSO |
4722 | bdrv_release_named_dirty_bitmaps(bs); |
4723 | assert(QLIST_EMPTY(&bs->dirty_bitmaps)); | |
4724 | ||
33384421 HR |
4725 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { |
4726 | g_free(ban); | |
4727 | } | |
4728 | QLIST_INIT(&bs->aio_notifiers); | |
fc27291d | 4729 | bdrv_drained_end(bs); |
1a6d3bd2 GK |
4730 | |
4731 | /* | |
4732 | * If we're still inside some bdrv_drain_all_begin()/end() sections, end | |
4733 | * them now since this BDS won't exist anymore when bdrv_drain_all_end() | |
4734 | * gets called. | |
4735 | */ | |
4736 | if (bs->quiesce_counter) { | |
4737 | bdrv_drain_all_end_quiesce(bs); | |
4738 | } | |
b338082b FB |
4739 | } |
4740 | ||
2bc93fed MK |
4741 | void bdrv_close_all(void) |
4742 | { | |
b3b5299d | 4743 | assert(job_next(NULL) == NULL); |
ca9bd24c HR |
4744 | |
4745 | /* Drop references from requests still in flight, such as canceled block | |
4746 | * jobs whose AIO context has not been polled yet */ | |
4747 | bdrv_drain_all(); | |
2bc93fed | 4748 | |
ca9bd24c HR |
4749 | blk_remove_all_bs(); |
4750 | blockdev_close_all_bdrv_states(); | |
ed78cda3 | 4751 | |
a1a2af07 | 4752 | assert(QTAILQ_EMPTY(&all_bdrv_states)); |
2bc93fed MK |
4753 | } |
4754 | ||
d0ac0380 KW |
4755 | static bool should_update_child(BdrvChild *c, BlockDriverState *to) |
4756 | { | |
2f30b7c3 VSO |
4757 | GQueue *queue; |
4758 | GHashTable *found; | |
4759 | bool ret; | |
d0ac0380 | 4760 | |
bd86fb99 | 4761 | if (c->klass->stay_at_node) { |
d0ac0380 KW |
4762 | return false; |
4763 | } | |
4764 | ||
ec9f10fe HR |
4765 | /* If the child @c belongs to the BDS @to, replacing the current |
4766 | * c->bs by @to would mean to create a loop. | |
4767 | * | |
4768 | * Such a case occurs when appending a BDS to a backing chain. | |
4769 | * For instance, imagine the following chain: | |
4770 | * | |
4771 | * guest device -> node A -> further backing chain... | |
4772 | * | |
4773 | * Now we create a new BDS B which we want to put on top of this | |
4774 | * chain, so we first attach A as its backing node: | |
4775 | * | |
4776 | * node B | |
4777 | * | | |
4778 | * v | |
4779 | * guest device -> node A -> further backing chain... | |
4780 | * | |
4781 | * Finally we want to replace A by B. When doing that, we want to | |
4782 | * replace all pointers to A by pointers to B -- except for the | |
4783 | * pointer from B because (1) that would create a loop, and (2) | |
4784 | * that pointer should simply stay intact: | |
4785 | * | |
4786 | * guest device -> node B | |
4787 | * | | |
4788 | * v | |
4789 | * node A -> further backing chain... | |
4790 | * | |
4791 | * In general, when replacing a node A (c->bs) by a node B (@to), | |
4792 | * if A is a child of B, that means we cannot replace A by B there | |
4793 | * because that would create a loop. Silently detaching A from B | |
4794 | * is also not really an option. So overall just leaving A in | |
2f30b7c3 VSO |
4795 | * place there is the most sensible choice. |
4796 | * | |
4797 | * We would also create a loop in any cases where @c is only | |
4798 | * indirectly referenced by @to. Prevent this by returning false | |
4799 | * if @c is found (by breadth-first search) anywhere in the whole | |
4800 | * subtree of @to. | |
4801 | */ | |
4802 | ||
4803 | ret = true; | |
4804 | found = g_hash_table_new(NULL, NULL); | |
4805 | g_hash_table_add(found, to); | |
4806 | queue = g_queue_new(); | |
4807 | g_queue_push_tail(queue, to); | |
4808 | ||
4809 | while (!g_queue_is_empty(queue)) { | |
4810 | BlockDriverState *v = g_queue_pop_head(queue); | |
4811 | BdrvChild *c2; | |
4812 | ||
4813 | QLIST_FOREACH(c2, &v->children, next) { | |
4814 | if (c2 == c) { | |
4815 | ret = false; | |
4816 | break; | |
4817 | } | |
4818 | ||
4819 | if (g_hash_table_contains(found, c2->bs)) { | |
4820 | continue; | |
4821 | } | |
4822 | ||
4823 | g_queue_push_tail(queue, c2->bs); | |
4824 | g_hash_table_add(found, c2->bs); | |
d0ac0380 KW |
4825 | } |
4826 | } | |
4827 | ||
2f30b7c3 VSO |
4828 | g_queue_free(queue); |
4829 | g_hash_table_destroy(found); | |
4830 | ||
4831 | return ret; | |
d0ac0380 KW |
4832 | } |
4833 | ||
46541ee5 VSO |
4834 | typedef struct BdrvRemoveFilterOrCowChild { |
4835 | BdrvChild *child; | |
4836 | bool is_backing; | |
4837 | } BdrvRemoveFilterOrCowChild; | |
4838 | ||
4839 | static void bdrv_remove_filter_or_cow_child_abort(void *opaque) | |
4840 | { | |
4841 | BdrvRemoveFilterOrCowChild *s = opaque; | |
4842 | BlockDriverState *parent_bs = s->child->opaque; | |
4843 | ||
4844 | QLIST_INSERT_HEAD(&parent_bs->children, s->child, next); | |
4845 | if (s->is_backing) { | |
4846 | parent_bs->backing = s->child; | |
4847 | } else { | |
4848 | parent_bs->file = s->child; | |
4849 | } | |
4850 | ||
4851 | /* | |
4bf021db | 4852 | * We don't have to restore child->bs here to undo bdrv_replace_child_tran() |
46541ee5 VSO |
4853 | * because that function is transactionable and it registered own completion |
4854 | * entries in @tran, so .abort() for bdrv_replace_child_safe() will be | |
4855 | * called automatically. | |
4856 | */ | |
4857 | } | |
4858 | ||
4859 | static void bdrv_remove_filter_or_cow_child_commit(void *opaque) | |
4860 | { | |
4861 | BdrvRemoveFilterOrCowChild *s = opaque; | |
4862 | ||
4863 | bdrv_child_free(s->child); | |
4864 | } | |
4865 | ||
4866 | static TransactionActionDrv bdrv_remove_filter_or_cow_child_drv = { | |
4867 | .abort = bdrv_remove_filter_or_cow_child_abort, | |
4868 | .commit = bdrv_remove_filter_or_cow_child_commit, | |
4869 | .clean = g_free, | |
4870 | }; | |
4871 | ||
4872 | /* | |
5b995019 | 4873 | * A function to remove backing or file child of @bs. |
7ec390d5 | 4874 | * Function doesn't update permissions, caller is responsible for this. |
46541ee5 | 4875 | */ |
5b995019 VSO |
4876 | static void bdrv_remove_file_or_backing_child(BlockDriverState *bs, |
4877 | BdrvChild *child, | |
4878 | Transaction *tran) | |
46541ee5 VSO |
4879 | { |
4880 | BdrvRemoveFilterOrCowChild *s; | |
5b995019 VSO |
4881 | |
4882 | assert(child == bs->backing || child == bs->file); | |
46541ee5 VSO |
4883 | |
4884 | if (!child) { | |
4885 | return; | |
4886 | } | |
4887 | ||
4888 | if (child->bs) { | |
4bf021db | 4889 | bdrv_replace_child_tran(child, NULL, tran); |
46541ee5 VSO |
4890 | } |
4891 | ||
4892 | s = g_new(BdrvRemoveFilterOrCowChild, 1); | |
4893 | *s = (BdrvRemoveFilterOrCowChild) { | |
4894 | .child = child, | |
4895 | .is_backing = (child == bs->backing), | |
4896 | }; | |
4897 | tran_add(tran, &bdrv_remove_filter_or_cow_child_drv, s); | |
4898 | ||
4899 | QLIST_SAFE_REMOVE(child, next); | |
4900 | if (s->is_backing) { | |
4901 | bs->backing = NULL; | |
4902 | } else { | |
4903 | bs->file = NULL; | |
4904 | } | |
4905 | } | |
4906 | ||
5b995019 VSO |
4907 | /* |
4908 | * A function to remove backing-chain child of @bs if exists: cow child for | |
4909 | * format nodes (always .backing) and filter child for filters (may be .file or | |
4910 | * .backing) | |
4911 | */ | |
4912 | static void bdrv_remove_filter_or_cow_child(BlockDriverState *bs, | |
4913 | Transaction *tran) | |
4914 | { | |
4915 | bdrv_remove_file_or_backing_child(bs, bdrv_filter_or_cow_child(bs), tran); | |
4916 | } | |
4917 | ||
117caba9 VSO |
4918 | static int bdrv_replace_node_noperm(BlockDriverState *from, |
4919 | BlockDriverState *to, | |
4920 | bool auto_skip, Transaction *tran, | |
4921 | Error **errp) | |
4922 | { | |
4923 | BdrvChild *c, *next; | |
4924 | ||
4925 | QLIST_FOREACH_SAFE(c, &from->parents, next_parent, next) { | |
4926 | assert(c->bs == from); | |
4927 | if (!should_update_child(c, to)) { | |
4928 | if (auto_skip) { | |
4929 | continue; | |
4930 | } | |
4931 | error_setg(errp, "Should not change '%s' link to '%s'", | |
4932 | c->name, from->node_name); | |
4933 | return -EINVAL; | |
4934 | } | |
4935 | if (c->frozen) { | |
4936 | error_setg(errp, "Cannot change '%s' link to '%s'", | |
4937 | c->name, from->node_name); | |
4938 | return -EPERM; | |
4939 | } | |
4bf021db | 4940 | bdrv_replace_child_tran(c, to, tran); |
117caba9 VSO |
4941 | } |
4942 | ||
4943 | return 0; | |
4944 | } | |
4945 | ||
313274bb VSO |
4946 | /* |
4947 | * With auto_skip=true bdrv_replace_node_common skips updating from parents | |
4948 | * if it creates a parent-child relation loop or if parent is block-job. | |
4949 | * | |
4950 | * With auto_skip=false the error is returned if from has a parent which should | |
4951 | * not be updated. | |
3108a15c VSO |
4952 | * |
4953 | * With @detach_subchain=true @to must be in a backing chain of @from. In this | |
4954 | * case backing link of the cow-parent of @to is removed. | |
313274bb | 4955 | */ |
a1e708fc VSO |
4956 | static int bdrv_replace_node_common(BlockDriverState *from, |
4957 | BlockDriverState *to, | |
3108a15c VSO |
4958 | bool auto_skip, bool detach_subchain, |
4959 | Error **errp) | |
dd62f1ca | 4960 | { |
3bb0e298 VSO |
4961 | Transaction *tran = tran_new(); |
4962 | g_autoptr(GHashTable) found = NULL; | |
4963 | g_autoptr(GSList) refresh_list = NULL; | |
2d369d6e | 4964 | BlockDriverState *to_cow_parent = NULL; |
234ac1a9 KW |
4965 | int ret; |
4966 | ||
3108a15c VSO |
4967 | if (detach_subchain) { |
4968 | assert(bdrv_chain_contains(from, to)); | |
4969 | assert(from != to); | |
4970 | for (to_cow_parent = from; | |
4971 | bdrv_filter_or_cow_bs(to_cow_parent) != to; | |
4972 | to_cow_parent = bdrv_filter_or_cow_bs(to_cow_parent)) | |
4973 | { | |
4974 | ; | |
4975 | } | |
4976 | } | |
4977 | ||
234ac1a9 KW |
4978 | /* Make sure that @from doesn't go away until we have successfully attached |
4979 | * all of its parents to @to. */ | |
4980 | bdrv_ref(from); | |
dd62f1ca | 4981 | |
f871abd6 | 4982 | assert(qemu_get_current_aio_context() == qemu_get_aio_context()); |
30dd65f3 | 4983 | assert(bdrv_get_aio_context(from) == bdrv_get_aio_context(to)); |
f871abd6 KW |
4984 | bdrv_drained_begin(from); |
4985 | ||
3bb0e298 VSO |
4986 | /* |
4987 | * Do the replacement without permission update. | |
4988 | * Replacement may influence the permissions, we should calculate new | |
4989 | * permissions based on new graph. If we fail, we'll roll-back the | |
4990 | * replacement. | |
4991 | */ | |
117caba9 VSO |
4992 | ret = bdrv_replace_node_noperm(from, to, auto_skip, tran, errp); |
4993 | if (ret < 0) { | |
4994 | goto out; | |
234ac1a9 KW |
4995 | } |
4996 | ||
3108a15c VSO |
4997 | if (detach_subchain) { |
4998 | bdrv_remove_filter_or_cow_child(to_cow_parent, tran); | |
4999 | } | |
5000 | ||
3bb0e298 | 5001 | found = g_hash_table_new(NULL, NULL); |
234ac1a9 | 5002 | |
3bb0e298 VSO |
5003 | refresh_list = bdrv_topological_dfs(refresh_list, found, to); |
5004 | refresh_list = bdrv_topological_dfs(refresh_list, found, from); | |
9bd910e2 | 5005 | |
3bb0e298 VSO |
5006 | ret = bdrv_list_refresh_perms(refresh_list, NULL, tran, errp); |
5007 | if (ret < 0) { | |
5008 | goto out; | |
dd62f1ca | 5009 | } |
234ac1a9 | 5010 | |
a1e708fc VSO |
5011 | ret = 0; |
5012 | ||
234ac1a9 | 5013 | out: |
3bb0e298 VSO |
5014 | tran_finalize(tran, ret); |
5015 | ||
f871abd6 | 5016 | bdrv_drained_end(from); |
234ac1a9 | 5017 | bdrv_unref(from); |
a1e708fc VSO |
5018 | |
5019 | return ret; | |
dd62f1ca KW |
5020 | } |
5021 | ||
a1e708fc VSO |
5022 | int bdrv_replace_node(BlockDriverState *from, BlockDriverState *to, |
5023 | Error **errp) | |
313274bb | 5024 | { |
3108a15c VSO |
5025 | return bdrv_replace_node_common(from, to, true, false, errp); |
5026 | } | |
5027 | ||
5028 | int bdrv_drop_filter(BlockDriverState *bs, Error **errp) | |
5029 | { | |
5030 | return bdrv_replace_node_common(bs, bdrv_filter_or_cow_bs(bs), true, true, | |
5031 | errp); | |
313274bb VSO |
5032 | } |
5033 | ||
4ddc07ca PB |
5034 | /* |
5035 | * Add new bs contents at the top of an image chain while the chain is | |
5036 | * live, while keeping required fields on the top layer. | |
5037 | * | |
5038 | * This will modify the BlockDriverState fields, and swap contents | |
5039 | * between bs_new and bs_top. Both bs_new and bs_top are modified. | |
5040 | * | |
2272edcf VSO |
5041 | * bs_new must not be attached to a BlockBackend and must not have backing |
5042 | * child. | |
4ddc07ca PB |
5043 | * |
5044 | * This function does not create any image files. | |
5045 | */ | |
a1e708fc VSO |
5046 | int bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top, |
5047 | Error **errp) | |
4ddc07ca | 5048 | { |
2272edcf VSO |
5049 | int ret; |
5050 | Transaction *tran = tran_new(); | |
5051 | ||
5052 | assert(!bs_new->backing); | |
5053 | ||
5054 | ret = bdrv_attach_child_noperm(bs_new, bs_top, "backing", | |
5055 | &child_of_bds, bdrv_backing_role(bs_new), | |
5056 | &bs_new->backing, tran, errp); | |
a1e708fc | 5057 | if (ret < 0) { |
2272edcf | 5058 | goto out; |
b2c2832c | 5059 | } |
dd62f1ca | 5060 | |
2272edcf | 5061 | ret = bdrv_replace_node_noperm(bs_top, bs_new, true, tran, errp); |
a1e708fc | 5062 | if (ret < 0) { |
2272edcf | 5063 | goto out; |
234ac1a9 | 5064 | } |
4ddc07ca | 5065 | |
2272edcf VSO |
5066 | ret = bdrv_refresh_perms(bs_new, errp); |
5067 | out: | |
5068 | tran_finalize(tran, ret); | |
5069 | ||
1e4c797c | 5070 | bdrv_refresh_limits(bs_top, NULL, NULL); |
2272edcf VSO |
5071 | |
5072 | return ret; | |
8802d1fd JC |
5073 | } |
5074 | ||
bd8f4c42 VSO |
5075 | /* Not for empty child */ |
5076 | int bdrv_replace_child_bs(BdrvChild *child, BlockDriverState *new_bs, | |
5077 | Error **errp) | |
5078 | { | |
5079 | int ret; | |
5080 | Transaction *tran = tran_new(); | |
5081 | g_autoptr(GHashTable) found = NULL; | |
5082 | g_autoptr(GSList) refresh_list = NULL; | |
5083 | BlockDriverState *old_bs = child->bs; | |
5084 | ||
5085 | bdrv_ref(old_bs); | |
5086 | bdrv_drained_begin(old_bs); | |
5087 | bdrv_drained_begin(new_bs); | |
5088 | ||
5089 | bdrv_replace_child_tran(child, new_bs, tran); | |
5090 | ||
5091 | found = g_hash_table_new(NULL, NULL); | |
5092 | refresh_list = bdrv_topological_dfs(refresh_list, found, old_bs); | |
5093 | refresh_list = bdrv_topological_dfs(refresh_list, found, new_bs); | |
5094 | ||
5095 | ret = bdrv_list_refresh_perms(refresh_list, NULL, tran, errp); | |
5096 | ||
5097 | tran_finalize(tran, ret); | |
5098 | ||
5099 | bdrv_drained_end(old_bs); | |
5100 | bdrv_drained_end(new_bs); | |
5101 | bdrv_unref(old_bs); | |
5102 | ||
5103 | return ret; | |
5104 | } | |
5105 | ||
4f6fd349 | 5106 | static void bdrv_delete(BlockDriverState *bs) |
b338082b | 5107 | { |
3718d8ab | 5108 | assert(bdrv_op_blocker_is_empty(bs)); |
4f6fd349 | 5109 | assert(!bs->refcnt); |
18846dee | 5110 | |
1b7bdbc1 | 5111 | /* remove from list, if necessary */ |
63eaaae0 KW |
5112 | if (bs->node_name[0] != '\0') { |
5113 | QTAILQ_REMOVE(&graph_bdrv_states, bs, node_list); | |
5114 | } | |
2c1d04e0 HR |
5115 | QTAILQ_REMOVE(&all_bdrv_states, bs, bs_list); |
5116 | ||
30c321f9 AK |
5117 | bdrv_close(bs); |
5118 | ||
7267c094 | 5119 | g_free(bs); |
fc01f7e7 FB |
5120 | } |
5121 | ||
96796fae VSO |
5122 | |
5123 | /* | |
5124 | * Replace @bs by newly created block node. | |
5125 | * | |
5126 | * @options is a QDict of options to pass to the block drivers, or NULL for an | |
5127 | * empty set of options. The reference to the QDict belongs to the block layer | |
5128 | * after the call (even on failure), so if the caller intends to reuse the | |
5129 | * dictionary, it needs to use qobject_ref() before calling bdrv_open. | |
5130 | */ | |
5131 | BlockDriverState *bdrv_insert_node(BlockDriverState *bs, QDict *options, | |
8872ef78 AS |
5132 | int flags, Error **errp) |
5133 | { | |
f053b7e8 VSO |
5134 | ERRP_GUARD(); |
5135 | int ret; | |
b11c8739 VSO |
5136 | BlockDriverState *new_node_bs = NULL; |
5137 | const char *drvname, *node_name; | |
5138 | BlockDriver *drv; | |
5139 | ||
5140 | drvname = qdict_get_try_str(options, "driver"); | |
5141 | if (!drvname) { | |
5142 | error_setg(errp, "driver is not specified"); | |
5143 | goto fail; | |
5144 | } | |
5145 | ||
5146 | drv = bdrv_find_format(drvname); | |
5147 | if (!drv) { | |
5148 | error_setg(errp, "Unknown driver: '%s'", drvname); | |
5149 | goto fail; | |
5150 | } | |
8872ef78 | 5151 | |
b11c8739 VSO |
5152 | node_name = qdict_get_try_str(options, "node-name"); |
5153 | ||
5154 | new_node_bs = bdrv_new_open_driver_opts(drv, node_name, options, flags, | |
5155 | errp); | |
5156 | options = NULL; /* bdrv_new_open_driver() eats options */ | |
5157 | if (!new_node_bs) { | |
8872ef78 | 5158 | error_prepend(errp, "Could not create node: "); |
b11c8739 | 5159 | goto fail; |
8872ef78 AS |
5160 | } |
5161 | ||
5162 | bdrv_drained_begin(bs); | |
f053b7e8 | 5163 | ret = bdrv_replace_node(bs, new_node_bs, errp); |
8872ef78 AS |
5164 | bdrv_drained_end(bs); |
5165 | ||
f053b7e8 VSO |
5166 | if (ret < 0) { |
5167 | error_prepend(errp, "Could not replace node: "); | |
b11c8739 | 5168 | goto fail; |
8872ef78 AS |
5169 | } |
5170 | ||
5171 | return new_node_bs; | |
b11c8739 VSO |
5172 | |
5173 | fail: | |
5174 | qobject_unref(options); | |
5175 | bdrv_unref(new_node_bs); | |
5176 | return NULL; | |
8872ef78 AS |
5177 | } |
5178 | ||
e97fc193 AL |
5179 | /* |
5180 | * Run consistency checks on an image | |
5181 | * | |
e076f338 | 5182 | * Returns 0 if the check could be completed (it doesn't mean that the image is |
a1c7273b | 5183 | * free of errors) or -errno when an internal error occurred. The results of the |
e076f338 | 5184 | * check are stored in res. |
e97fc193 | 5185 | */ |
21c2283e VSO |
5186 | int coroutine_fn bdrv_co_check(BlockDriverState *bs, |
5187 | BdrvCheckResult *res, BdrvCheckMode fix) | |
e97fc193 | 5188 | { |
908bcd54 HR |
5189 | if (bs->drv == NULL) { |
5190 | return -ENOMEDIUM; | |
5191 | } | |
2fd61638 | 5192 | if (bs->drv->bdrv_co_check == NULL) { |
e97fc193 AL |
5193 | return -ENOTSUP; |
5194 | } | |
5195 | ||
e076f338 | 5196 | memset(res, 0, sizeof(*res)); |
2fd61638 PB |
5197 | return bs->drv->bdrv_co_check(bs, res, fix); |
5198 | } | |
5199 | ||
756e6736 KW |
5200 | /* |
5201 | * Return values: | |
5202 | * 0 - success | |
5203 | * -EINVAL - backing format specified, but no file | |
5204 | * -ENOSPC - can't update the backing file because no space is left in the | |
5205 | * image file header | |
5206 | * -ENOTSUP - format driver doesn't support changing the backing file | |
5207 | */ | |
e54ee1b3 | 5208 | int bdrv_change_backing_file(BlockDriverState *bs, const char *backing_file, |
497a30db | 5209 | const char *backing_fmt, bool require) |
756e6736 KW |
5210 | { |
5211 | BlockDriver *drv = bs->drv; | |
469ef350 | 5212 | int ret; |
756e6736 | 5213 | |
d470ad42 HR |
5214 | if (!drv) { |
5215 | return -ENOMEDIUM; | |
5216 | } | |
5217 | ||
5f377794 PB |
5218 | /* Backing file format doesn't make sense without a backing file */ |
5219 | if (backing_fmt && !backing_file) { | |
5220 | return -EINVAL; | |
5221 | } | |
5222 | ||
497a30db EB |
5223 | if (require && backing_file && !backing_fmt) { |
5224 | return -EINVAL; | |
e54ee1b3 EB |
5225 | } |
5226 | ||
756e6736 | 5227 | if (drv->bdrv_change_backing_file != NULL) { |
469ef350 | 5228 | ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt); |
756e6736 | 5229 | } else { |
469ef350 | 5230 | ret = -ENOTSUP; |
756e6736 | 5231 | } |
469ef350 PB |
5232 | |
5233 | if (ret == 0) { | |
5234 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: ""); | |
5235 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: ""); | |
998c2019 HR |
5236 | pstrcpy(bs->auto_backing_file, sizeof(bs->auto_backing_file), |
5237 | backing_file ?: ""); | |
469ef350 PB |
5238 | } |
5239 | return ret; | |
756e6736 KW |
5240 | } |
5241 | ||
6ebdcee2 | 5242 | /* |
dcf3f9b2 HR |
5243 | * Finds the first non-filter node above bs in the chain between |
5244 | * active and bs. The returned node is either an immediate parent of | |
5245 | * bs, or there are only filter nodes between the two. | |
6ebdcee2 JC |
5246 | * |
5247 | * Returns NULL if bs is not found in active's image chain, | |
5248 | * or if active == bs. | |
4caf0fcd JC |
5249 | * |
5250 | * Returns the bottommost base image if bs == NULL. | |
6ebdcee2 JC |
5251 | */ |
5252 | BlockDriverState *bdrv_find_overlay(BlockDriverState *active, | |
5253 | BlockDriverState *bs) | |
5254 | { | |
dcf3f9b2 HR |
5255 | bs = bdrv_skip_filters(bs); |
5256 | active = bdrv_skip_filters(active); | |
5257 | ||
5258 | while (active) { | |
5259 | BlockDriverState *next = bdrv_backing_chain_next(active); | |
5260 | if (bs == next) { | |
5261 | return active; | |
5262 | } | |
5263 | active = next; | |
6ebdcee2 JC |
5264 | } |
5265 | ||
dcf3f9b2 | 5266 | return NULL; |
4caf0fcd | 5267 | } |
6ebdcee2 | 5268 | |
4caf0fcd JC |
5269 | /* Given a BDS, searches for the base layer. */ |
5270 | BlockDriverState *bdrv_find_base(BlockDriverState *bs) | |
5271 | { | |
5272 | return bdrv_find_overlay(bs, NULL); | |
6ebdcee2 JC |
5273 | } |
5274 | ||
2cad1ebe | 5275 | /* |
7b99a266 HR |
5276 | * Return true if at least one of the COW (backing) and filter links |
5277 | * between @bs and @base is frozen. @errp is set if that's the case. | |
0f0998f6 | 5278 | * @base must be reachable from @bs, or NULL. |
2cad1ebe AG |
5279 | */ |
5280 | bool bdrv_is_backing_chain_frozen(BlockDriverState *bs, BlockDriverState *base, | |
5281 | Error **errp) | |
5282 | { | |
5283 | BlockDriverState *i; | |
7b99a266 | 5284 | BdrvChild *child; |
2cad1ebe | 5285 | |
7b99a266 HR |
5286 | for (i = bs; i != base; i = child_bs(child)) { |
5287 | child = bdrv_filter_or_cow_child(i); | |
5288 | ||
5289 | if (child && child->frozen) { | |
2cad1ebe | 5290 | error_setg(errp, "Cannot change '%s' link from '%s' to '%s'", |
7b99a266 | 5291 | child->name, i->node_name, child->bs->node_name); |
2cad1ebe AG |
5292 | return true; |
5293 | } | |
5294 | } | |
5295 | ||
5296 | return false; | |
5297 | } | |
5298 | ||
5299 | /* | |
7b99a266 | 5300 | * Freeze all COW (backing) and filter links between @bs and @base. |
2cad1ebe AG |
5301 | * If any of the links is already frozen the operation is aborted and |
5302 | * none of the links are modified. | |
0f0998f6 | 5303 | * @base must be reachable from @bs, or NULL. |
2cad1ebe AG |
5304 | * Returns 0 on success. On failure returns < 0 and sets @errp. |
5305 | */ | |
5306 | int bdrv_freeze_backing_chain(BlockDriverState *bs, BlockDriverState *base, | |
5307 | Error **errp) | |
5308 | { | |
5309 | BlockDriverState *i; | |
7b99a266 | 5310 | BdrvChild *child; |
2cad1ebe AG |
5311 | |
5312 | if (bdrv_is_backing_chain_frozen(bs, base, errp)) { | |
5313 | return -EPERM; | |
5314 | } | |
5315 | ||
7b99a266 HR |
5316 | for (i = bs; i != base; i = child_bs(child)) { |
5317 | child = bdrv_filter_or_cow_child(i); | |
5318 | if (child && child->bs->never_freeze) { | |
e5182c1c | 5319 | error_setg(errp, "Cannot freeze '%s' link to '%s'", |
7b99a266 | 5320 | child->name, child->bs->node_name); |
e5182c1c HR |
5321 | return -EPERM; |
5322 | } | |
5323 | } | |
5324 | ||
7b99a266 HR |
5325 | for (i = bs; i != base; i = child_bs(child)) { |
5326 | child = bdrv_filter_or_cow_child(i); | |
5327 | if (child) { | |
5328 | child->frozen = true; | |
0f0998f6 | 5329 | } |
2cad1ebe AG |
5330 | } |
5331 | ||
5332 | return 0; | |
5333 | } | |
5334 | ||
5335 | /* | |
7b99a266 HR |
5336 | * Unfreeze all COW (backing) and filter links between @bs and @base. |
5337 | * The caller must ensure that all links are frozen before using this | |
5338 | * function. | |
0f0998f6 | 5339 | * @base must be reachable from @bs, or NULL. |
2cad1ebe AG |
5340 | */ |
5341 | void bdrv_unfreeze_backing_chain(BlockDriverState *bs, BlockDriverState *base) | |
5342 | { | |
5343 | BlockDriverState *i; | |
7b99a266 | 5344 | BdrvChild *child; |
2cad1ebe | 5345 | |
7b99a266 HR |
5346 | for (i = bs; i != base; i = child_bs(child)) { |
5347 | child = bdrv_filter_or_cow_child(i); | |
5348 | if (child) { | |
5349 | assert(child->frozen); | |
5350 | child->frozen = false; | |
0f0998f6 | 5351 | } |
2cad1ebe AG |
5352 | } |
5353 | } | |
5354 | ||
6ebdcee2 JC |
5355 | /* |
5356 | * Drops images above 'base' up to and including 'top', and sets the image | |
5357 | * above 'top' to have base as its backing file. | |
5358 | * | |
5359 | * Requires that the overlay to 'top' is opened r/w, so that the backing file | |
5360 | * information in 'bs' can be properly updated. | |
5361 | * | |
5362 | * E.g., this will convert the following chain: | |
5363 | * bottom <- base <- intermediate <- top <- active | |
5364 | * | |
5365 | * to | |
5366 | * | |
5367 | * bottom <- base <- active | |
5368 | * | |
5369 | * It is allowed for bottom==base, in which case it converts: | |
5370 | * | |
5371 | * base <- intermediate <- top <- active | |
5372 | * | |
5373 | * to | |
5374 | * | |
5375 | * base <- active | |
5376 | * | |
54e26900 JC |
5377 | * If backing_file_str is non-NULL, it will be used when modifying top's |
5378 | * overlay image metadata. | |
5379 | * | |
6ebdcee2 JC |
5380 | * Error conditions: |
5381 | * if active == top, that is considered an error | |
5382 | * | |
5383 | */ | |
bde70715 KW |
5384 | int bdrv_drop_intermediate(BlockDriverState *top, BlockDriverState *base, |
5385 | const char *backing_file_str) | |
6ebdcee2 | 5386 | { |
6bd858b3 AG |
5387 | BlockDriverState *explicit_top = top; |
5388 | bool update_inherits_from; | |
d669ed6a | 5389 | BdrvChild *c; |
12fa4af6 | 5390 | Error *local_err = NULL; |
6ebdcee2 | 5391 | int ret = -EIO; |
d669ed6a VSO |
5392 | g_autoptr(GSList) updated_children = NULL; |
5393 | GSList *p; | |
6ebdcee2 | 5394 | |
6858eba0 | 5395 | bdrv_ref(top); |
637d54a5 | 5396 | bdrv_subtree_drained_begin(top); |
6858eba0 | 5397 | |
6ebdcee2 JC |
5398 | if (!top->drv || !base->drv) { |
5399 | goto exit; | |
5400 | } | |
5401 | ||
5db15a57 KW |
5402 | /* Make sure that base is in the backing chain of top */ |
5403 | if (!bdrv_chain_contains(top, base)) { | |
6ebdcee2 JC |
5404 | goto exit; |
5405 | } | |
5406 | ||
6bd858b3 AG |
5407 | /* If 'base' recursively inherits from 'top' then we should set |
5408 | * base->inherits_from to top->inherits_from after 'top' and all | |
5409 | * other intermediate nodes have been dropped. | |
5410 | * If 'top' is an implicit node (e.g. "commit_top") we should skip | |
5411 | * it because no one inherits from it. We use explicit_top for that. */ | |
dcf3f9b2 | 5412 | explicit_top = bdrv_skip_implicit_filters(explicit_top); |
6bd858b3 AG |
5413 | update_inherits_from = bdrv_inherits_from_recursive(base, explicit_top); |
5414 | ||
6ebdcee2 | 5415 | /* success - we can delete the intermediate states, and link top->base */ |
bde70715 KW |
5416 | /* TODO Check graph modification op blockers (BLK_PERM_GRAPH_MOD) once |
5417 | * we've figured out how they should work. */ | |
f30c66ba HR |
5418 | if (!backing_file_str) { |
5419 | bdrv_refresh_filename(base); | |
5420 | backing_file_str = base->filename; | |
5421 | } | |
61f09cea | 5422 | |
d669ed6a VSO |
5423 | QLIST_FOREACH(c, &top->parents, next_parent) { |
5424 | updated_children = g_slist_prepend(updated_children, c); | |
5425 | } | |
5426 | ||
3108a15c VSO |
5427 | /* |
5428 | * It seems correct to pass detach_subchain=true here, but it triggers | |
5429 | * one more yet not fixed bug, when due to nested aio_poll loop we switch to | |
5430 | * another drained section, which modify the graph (for example, removing | |
5431 | * the child, which we keep in updated_children list). So, it's a TODO. | |
5432 | * | |
5433 | * Note, bug triggered if pass detach_subchain=true here and run | |
5434 | * test-bdrv-drain. test_drop_intermediate_poll() test-case will crash. | |
5435 | * That's a FIXME. | |
5436 | */ | |
5437 | bdrv_replace_node_common(top, base, false, false, &local_err); | |
d669ed6a VSO |
5438 | if (local_err) { |
5439 | error_report_err(local_err); | |
5440 | goto exit; | |
5441 | } | |
5442 | ||
5443 | for (p = updated_children; p; p = p->next) { | |
5444 | c = p->data; | |
12fa4af6 | 5445 | |
bd86fb99 HR |
5446 | if (c->klass->update_filename) { |
5447 | ret = c->klass->update_filename(c, base, backing_file_str, | |
5448 | &local_err); | |
61f09cea | 5449 | if (ret < 0) { |
d669ed6a VSO |
5450 | /* |
5451 | * TODO: Actually, we want to rollback all previous iterations | |
5452 | * of this loop, and (which is almost impossible) previous | |
5453 | * bdrv_replace_node()... | |
5454 | * | |
5455 | * Note, that c->klass->update_filename may lead to permission | |
5456 | * update, so it's a bad idea to call it inside permission | |
5457 | * update transaction of bdrv_replace_node. | |
5458 | */ | |
61f09cea KW |
5459 | error_report_err(local_err); |
5460 | goto exit; | |
5461 | } | |
5462 | } | |
12fa4af6 | 5463 | } |
6ebdcee2 | 5464 | |
6bd858b3 AG |
5465 | if (update_inherits_from) { |
5466 | base->inherits_from = explicit_top->inherits_from; | |
5467 | } | |
5468 | ||
6ebdcee2 | 5469 | ret = 0; |
6ebdcee2 | 5470 | exit: |
637d54a5 | 5471 | bdrv_subtree_drained_end(top); |
6858eba0 | 5472 | bdrv_unref(top); |
6ebdcee2 JC |
5473 | return ret; |
5474 | } | |
5475 | ||
081e4650 HR |
5476 | /** |
5477 | * Implementation of BlockDriver.bdrv_get_allocated_file_size() that | |
5478 | * sums the size of all data-bearing children. (This excludes backing | |
5479 | * children.) | |
5480 | */ | |
5481 | static int64_t bdrv_sum_allocated_file_size(BlockDriverState *bs) | |
5482 | { | |
5483 | BdrvChild *child; | |
5484 | int64_t child_size, sum = 0; | |
5485 | ||
5486 | QLIST_FOREACH(child, &bs->children, next) { | |
5487 | if (child->role & (BDRV_CHILD_DATA | BDRV_CHILD_METADATA | | |
5488 | BDRV_CHILD_FILTERED)) | |
5489 | { | |
5490 | child_size = bdrv_get_allocated_file_size(child->bs); | |
5491 | if (child_size < 0) { | |
5492 | return child_size; | |
5493 | } | |
5494 | sum += child_size; | |
5495 | } | |
5496 | } | |
5497 | ||
5498 | return sum; | |
5499 | } | |
5500 | ||
61007b31 SH |
5501 | /** |
5502 | * Length of a allocated file in bytes. Sparse files are counted by actual | |
5503 | * allocated space. Return < 0 if error or unknown. | |
5504 | */ | |
5505 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs) | |
71d0770c | 5506 | { |
61007b31 SH |
5507 | BlockDriver *drv = bs->drv; |
5508 | if (!drv) { | |
5509 | return -ENOMEDIUM; | |
8f4754ed | 5510 | } |
61007b31 SH |
5511 | if (drv->bdrv_get_allocated_file_size) { |
5512 | return drv->bdrv_get_allocated_file_size(bs); | |
5513 | } | |
081e4650 HR |
5514 | |
5515 | if (drv->bdrv_file_open) { | |
5516 | /* | |
5517 | * Protocol drivers default to -ENOTSUP (most of their data is | |
5518 | * not stored in any of their children (if they even have any), | |
5519 | * so there is no generic way to figure it out). | |
5520 | */ | |
5521 | return -ENOTSUP; | |
5522 | } else if (drv->is_filter) { | |
5523 | /* Filter drivers default to the size of their filtered child */ | |
5524 | return bdrv_get_allocated_file_size(bdrv_filter_bs(bs)); | |
5525 | } else { | |
5526 | /* Other drivers default to summing their children's sizes */ | |
5527 | return bdrv_sum_allocated_file_size(bs); | |
1c9805a3 SH |
5528 | } |
5529 | } | |
e7a8a783 | 5530 | |
90880ff1 SH |
5531 | /* |
5532 | * bdrv_measure: | |
5533 | * @drv: Format driver | |
5534 | * @opts: Creation options for new image | |
5535 | * @in_bs: Existing image containing data for new image (may be NULL) | |
5536 | * @errp: Error object | |
5537 | * Returns: A #BlockMeasureInfo (free using qapi_free_BlockMeasureInfo()) | |
5538 | * or NULL on error | |
5539 | * | |
5540 | * Calculate file size required to create a new image. | |
5541 | * | |
5542 | * If @in_bs is given then space for allocated clusters and zero clusters | |
5543 | * from that image are included in the calculation. If @opts contains a | |
5544 | * backing file that is shared by @in_bs then backing clusters may be omitted | |
5545 | * from the calculation. | |
5546 | * | |
5547 | * If @in_bs is NULL then the calculation includes no allocated clusters | |
5548 | * unless a preallocation option is given in @opts. | |
5549 | * | |
5550 | * Note that @in_bs may use a different BlockDriver from @drv. | |
5551 | * | |
5552 | * If an error occurs the @errp pointer is set. | |
5553 | */ | |
5554 | BlockMeasureInfo *bdrv_measure(BlockDriver *drv, QemuOpts *opts, | |
5555 | BlockDriverState *in_bs, Error **errp) | |
5556 | { | |
5557 | if (!drv->bdrv_measure) { | |
5558 | error_setg(errp, "Block driver '%s' does not support size measurement", | |
5559 | drv->format_name); | |
5560 | return NULL; | |
5561 | } | |
5562 | ||
5563 | return drv->bdrv_measure(opts, in_bs, errp); | |
5564 | } | |
5565 | ||
61007b31 SH |
5566 | /** |
5567 | * Return number of sectors on success, -errno on error. | |
1c9805a3 | 5568 | */ |
61007b31 | 5569 | int64_t bdrv_nb_sectors(BlockDriverState *bs) |
1c9805a3 | 5570 | { |
61007b31 | 5571 | BlockDriver *drv = bs->drv; |
498e386c | 5572 | |
61007b31 SH |
5573 | if (!drv) |
5574 | return -ENOMEDIUM; | |
2572b37a | 5575 | |
61007b31 SH |
5576 | if (drv->has_variable_length) { |
5577 | int ret = refresh_total_sectors(bs, bs->total_sectors); | |
5578 | if (ret < 0) { | |
5579 | return ret; | |
1c9805a3 SH |
5580 | } |
5581 | } | |
61007b31 | 5582 | return bs->total_sectors; |
1c9805a3 | 5583 | } |
b338082b | 5584 | |
61007b31 SH |
5585 | /** |
5586 | * Return length in bytes on success, -errno on error. | |
5587 | * The length is always a multiple of BDRV_SECTOR_SIZE. | |
8d3b1a2d | 5588 | */ |
61007b31 | 5589 | int64_t bdrv_getlength(BlockDriverState *bs) |
8d3b1a2d | 5590 | { |
61007b31 | 5591 | int64_t ret = bdrv_nb_sectors(bs); |
8d3b1a2d | 5592 | |
122860ba EB |
5593 | if (ret < 0) { |
5594 | return ret; | |
5595 | } | |
5596 | if (ret > INT64_MAX / BDRV_SECTOR_SIZE) { | |
5597 | return -EFBIG; | |
5598 | } | |
5599 | return ret * BDRV_SECTOR_SIZE; | |
fc01f7e7 FB |
5600 | } |
5601 | ||
61007b31 SH |
5602 | /* return 0 as number of sectors if no device present or error */ |
5603 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr) | |
07d27a44 | 5604 | { |
61007b31 | 5605 | int64_t nb_sectors = bdrv_nb_sectors(bs); |
07d27a44 | 5606 | |
61007b31 | 5607 | *nb_sectors_ptr = nb_sectors < 0 ? 0 : nb_sectors; |
07d27a44 MA |
5608 | } |
5609 | ||
54115412 | 5610 | bool bdrv_is_sg(BlockDriverState *bs) |
f08145fe | 5611 | { |
61007b31 | 5612 | return bs->sg; |
f08145fe KW |
5613 | } |
5614 | ||
ae23f786 HR |
5615 | /** |
5616 | * Return whether the given node supports compressed writes. | |
5617 | */ | |
5618 | bool bdrv_supports_compressed_writes(BlockDriverState *bs) | |
5619 | { | |
5620 | BlockDriverState *filtered; | |
5621 | ||
5622 | if (!bs->drv || !block_driver_can_compress(bs->drv)) { | |
5623 | return false; | |
5624 | } | |
5625 | ||
5626 | filtered = bdrv_filter_bs(bs); | |
5627 | if (filtered) { | |
5628 | /* | |
5629 | * Filters can only forward compressed writes, so we have to | |
5630 | * check the child. | |
5631 | */ | |
5632 | return bdrv_supports_compressed_writes(filtered); | |
5633 | } | |
5634 | ||
5635 | return true; | |
5636 | } | |
5637 | ||
61007b31 | 5638 | const char *bdrv_get_format_name(BlockDriverState *bs) |
40b4f539 | 5639 | { |
61007b31 | 5640 | return bs->drv ? bs->drv->format_name : NULL; |
40b4f539 KW |
5641 | } |
5642 | ||
61007b31 | 5643 | static int qsort_strcmp(const void *a, const void *b) |
40b4f539 | 5644 | { |
ceff5bd7 | 5645 | return strcmp(*(char *const *)a, *(char *const *)b); |
40b4f539 KW |
5646 | } |
5647 | ||
61007b31 | 5648 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
9ac404c5 | 5649 | void *opaque, bool read_only) |
40b4f539 | 5650 | { |
61007b31 SH |
5651 | BlockDriver *drv; |
5652 | int count = 0; | |
5653 | int i; | |
5654 | const char **formats = NULL; | |
40b4f539 | 5655 | |
61007b31 SH |
5656 | QLIST_FOREACH(drv, &bdrv_drivers, list) { |
5657 | if (drv->format_name) { | |
5658 | bool found = false; | |
5659 | int i = count; | |
9ac404c5 AS |
5660 | |
5661 | if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv, read_only)) { | |
5662 | continue; | |
5663 | } | |
5664 | ||
61007b31 SH |
5665 | while (formats && i && !found) { |
5666 | found = !strcmp(formats[--i], drv->format_name); | |
5667 | } | |
e2a305fb | 5668 | |
61007b31 SH |
5669 | if (!found) { |
5670 | formats = g_renew(const char *, formats, count + 1); | |
5671 | formats[count++] = drv->format_name; | |
5672 | } | |
6c5a42ac | 5673 | } |
61007b31 | 5674 | } |
6c5a42ac | 5675 | |
eb0df69f HR |
5676 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); i++) { |
5677 | const char *format_name = block_driver_modules[i].format_name; | |
5678 | ||
5679 | if (format_name) { | |
5680 | bool found = false; | |
5681 | int j = count; | |
5682 | ||
9ac404c5 AS |
5683 | if (use_bdrv_whitelist && |
5684 | !bdrv_format_is_whitelisted(format_name, read_only)) { | |
5685 | continue; | |
5686 | } | |
5687 | ||
eb0df69f HR |
5688 | while (formats && j && !found) { |
5689 | found = !strcmp(formats[--j], format_name); | |
5690 | } | |
5691 | ||
5692 | if (!found) { | |
5693 | formats = g_renew(const char *, formats, count + 1); | |
5694 | formats[count++] = format_name; | |
5695 | } | |
5696 | } | |
5697 | } | |
5698 | ||
61007b31 | 5699 | qsort(formats, count, sizeof(formats[0]), qsort_strcmp); |
40b4f539 | 5700 | |
61007b31 SH |
5701 | for (i = 0; i < count; i++) { |
5702 | it(opaque, formats[i]); | |
5703 | } | |
40b4f539 | 5704 | |
61007b31 SH |
5705 | g_free(formats); |
5706 | } | |
40b4f539 | 5707 | |
61007b31 SH |
5708 | /* This function is to find a node in the bs graph */ |
5709 | BlockDriverState *bdrv_find_node(const char *node_name) | |
5710 | { | |
5711 | BlockDriverState *bs; | |
391827eb | 5712 | |
61007b31 | 5713 | assert(node_name); |
40b4f539 | 5714 | |
61007b31 SH |
5715 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { |
5716 | if (!strcmp(node_name, bs->node_name)) { | |
5717 | return bs; | |
40b4f539 KW |
5718 | } |
5719 | } | |
61007b31 | 5720 | return NULL; |
40b4f539 KW |
5721 | } |
5722 | ||
61007b31 | 5723 | /* Put this QMP function here so it can access the static graph_bdrv_states. */ |
facda544 PK |
5724 | BlockDeviceInfoList *bdrv_named_nodes_list(bool flat, |
5725 | Error **errp) | |
40b4f539 | 5726 | { |
9812e712 | 5727 | BlockDeviceInfoList *list; |
61007b31 | 5728 | BlockDriverState *bs; |
40b4f539 | 5729 | |
61007b31 SH |
5730 | list = NULL; |
5731 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { | |
facda544 | 5732 | BlockDeviceInfo *info = bdrv_block_device_info(NULL, bs, flat, errp); |
61007b31 SH |
5733 | if (!info) { |
5734 | qapi_free_BlockDeviceInfoList(list); | |
5735 | return NULL; | |
301db7c2 | 5736 | } |
9812e712 | 5737 | QAPI_LIST_PREPEND(list, info); |
301db7c2 RH |
5738 | } |
5739 | ||
61007b31 SH |
5740 | return list; |
5741 | } | |
40b4f539 | 5742 | |
5d3b4e99 VSO |
5743 | typedef struct XDbgBlockGraphConstructor { |
5744 | XDbgBlockGraph *graph; | |
5745 | GHashTable *graph_nodes; | |
5746 | } XDbgBlockGraphConstructor; | |
5747 | ||
5748 | static XDbgBlockGraphConstructor *xdbg_graph_new(void) | |
5749 | { | |
5750 | XDbgBlockGraphConstructor *gr = g_new(XDbgBlockGraphConstructor, 1); | |
5751 | ||
5752 | gr->graph = g_new0(XDbgBlockGraph, 1); | |
5753 | gr->graph_nodes = g_hash_table_new(NULL, NULL); | |
5754 | ||
5755 | return gr; | |
5756 | } | |
5757 | ||
5758 | static XDbgBlockGraph *xdbg_graph_finalize(XDbgBlockGraphConstructor *gr) | |
5759 | { | |
5760 | XDbgBlockGraph *graph = gr->graph; | |
5761 | ||
5762 | g_hash_table_destroy(gr->graph_nodes); | |
5763 | g_free(gr); | |
5764 | ||
5765 | return graph; | |
5766 | } | |
5767 | ||
5768 | static uintptr_t xdbg_graph_node_num(XDbgBlockGraphConstructor *gr, void *node) | |
5769 | { | |
5770 | uintptr_t ret = (uintptr_t)g_hash_table_lookup(gr->graph_nodes, node); | |
5771 | ||
5772 | if (ret != 0) { | |
5773 | return ret; | |
5774 | } | |
5775 | ||
5776 | /* | |
5777 | * Start counting from 1, not 0, because 0 interferes with not-found (NULL) | |
5778 | * answer of g_hash_table_lookup. | |
5779 | */ | |
5780 | ret = g_hash_table_size(gr->graph_nodes) + 1; | |
5781 | g_hash_table_insert(gr->graph_nodes, node, (void *)ret); | |
5782 | ||
5783 | return ret; | |
5784 | } | |
5785 | ||
5786 | static void xdbg_graph_add_node(XDbgBlockGraphConstructor *gr, void *node, | |
5787 | XDbgBlockGraphNodeType type, const char *name) | |
5788 | { | |
5789 | XDbgBlockGraphNode *n; | |
5790 | ||
5791 | n = g_new0(XDbgBlockGraphNode, 1); | |
5792 | ||
5793 | n->id = xdbg_graph_node_num(gr, node); | |
5794 | n->type = type; | |
5795 | n->name = g_strdup(name); | |
5796 | ||
9812e712 | 5797 | QAPI_LIST_PREPEND(gr->graph->nodes, n); |
5d3b4e99 VSO |
5798 | } |
5799 | ||
5800 | static void xdbg_graph_add_edge(XDbgBlockGraphConstructor *gr, void *parent, | |
5801 | const BdrvChild *child) | |
5802 | { | |
cdb1cec8 | 5803 | BlockPermission qapi_perm; |
5d3b4e99 VSO |
5804 | XDbgBlockGraphEdge *edge; |
5805 | ||
5d3b4e99 VSO |
5806 | edge = g_new0(XDbgBlockGraphEdge, 1); |
5807 | ||
5808 | edge->parent = xdbg_graph_node_num(gr, parent); | |
5809 | edge->child = xdbg_graph_node_num(gr, child->bs); | |
5810 | edge->name = g_strdup(child->name); | |
5811 | ||
cdb1cec8 HR |
5812 | for (qapi_perm = 0; qapi_perm < BLOCK_PERMISSION__MAX; qapi_perm++) { |
5813 | uint64_t flag = bdrv_qapi_perm_to_blk_perm(qapi_perm); | |
5814 | ||
5815 | if (flag & child->perm) { | |
9812e712 | 5816 | QAPI_LIST_PREPEND(edge->perm, qapi_perm); |
5d3b4e99 | 5817 | } |
cdb1cec8 | 5818 | if (flag & child->shared_perm) { |
9812e712 | 5819 | QAPI_LIST_PREPEND(edge->shared_perm, qapi_perm); |
5d3b4e99 VSO |
5820 | } |
5821 | } | |
5822 | ||
9812e712 | 5823 | QAPI_LIST_PREPEND(gr->graph->edges, edge); |
5d3b4e99 VSO |
5824 | } |
5825 | ||
5826 | ||
5827 | XDbgBlockGraph *bdrv_get_xdbg_block_graph(Error **errp) | |
5828 | { | |
5829 | BlockBackend *blk; | |
5830 | BlockJob *job; | |
5831 | BlockDriverState *bs; | |
5832 | BdrvChild *child; | |
5833 | XDbgBlockGraphConstructor *gr = xdbg_graph_new(); | |
5834 | ||
5835 | for (blk = blk_all_next(NULL); blk; blk = blk_all_next(blk)) { | |
5836 | char *allocated_name = NULL; | |
5837 | const char *name = blk_name(blk); | |
5838 | ||
5839 | if (!*name) { | |
5840 | name = allocated_name = blk_get_attached_dev_id(blk); | |
5841 | } | |
5842 | xdbg_graph_add_node(gr, blk, X_DBG_BLOCK_GRAPH_NODE_TYPE_BLOCK_BACKEND, | |
5843 | name); | |
5844 | g_free(allocated_name); | |
5845 | if (blk_root(blk)) { | |
5846 | xdbg_graph_add_edge(gr, blk, blk_root(blk)); | |
5847 | } | |
5848 | } | |
5849 | ||
5850 | for (job = block_job_next(NULL); job; job = block_job_next(job)) { | |
5851 | GSList *el; | |
5852 | ||
5853 | xdbg_graph_add_node(gr, job, X_DBG_BLOCK_GRAPH_NODE_TYPE_BLOCK_JOB, | |
5854 | job->job.id); | |
5855 | for (el = job->nodes; el; el = el->next) { | |
5856 | xdbg_graph_add_edge(gr, job, (BdrvChild *)el->data); | |
5857 | } | |
5858 | } | |
5859 | ||
5860 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { | |
5861 | xdbg_graph_add_node(gr, bs, X_DBG_BLOCK_GRAPH_NODE_TYPE_BLOCK_DRIVER, | |
5862 | bs->node_name); | |
5863 | QLIST_FOREACH(child, &bs->children, next) { | |
5864 | xdbg_graph_add_edge(gr, bs, child); | |
5865 | } | |
5866 | } | |
5867 | ||
5868 | return xdbg_graph_finalize(gr); | |
5869 | } | |
5870 | ||
61007b31 SH |
5871 | BlockDriverState *bdrv_lookup_bs(const char *device, |
5872 | const char *node_name, | |
5873 | Error **errp) | |
5874 | { | |
5875 | BlockBackend *blk; | |
5876 | BlockDriverState *bs; | |
40b4f539 | 5877 | |
61007b31 SH |
5878 | if (device) { |
5879 | blk = blk_by_name(device); | |
40b4f539 | 5880 | |
61007b31 | 5881 | if (blk) { |
9f4ed6fb AG |
5882 | bs = blk_bs(blk); |
5883 | if (!bs) { | |
5433c24f | 5884 | error_setg(errp, "Device '%s' has no medium", device); |
5433c24f HR |
5885 | } |
5886 | ||
9f4ed6fb | 5887 | return bs; |
61007b31 SH |
5888 | } |
5889 | } | |
40b4f539 | 5890 | |
61007b31 SH |
5891 | if (node_name) { |
5892 | bs = bdrv_find_node(node_name); | |
6d519a5f | 5893 | |
61007b31 SH |
5894 | if (bs) { |
5895 | return bs; | |
5896 | } | |
40b4f539 KW |
5897 | } |
5898 | ||
785ec4b1 | 5899 | error_setg(errp, "Cannot find device=\'%s\' nor node-name=\'%s\'", |
61007b31 SH |
5900 | device ? device : "", |
5901 | node_name ? node_name : ""); | |
5902 | return NULL; | |
40b4f539 KW |
5903 | } |
5904 | ||
61007b31 SH |
5905 | /* If 'base' is in the same chain as 'top', return true. Otherwise, |
5906 | * return false. If either argument is NULL, return false. */ | |
5907 | bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base) | |
83f64091 | 5908 | { |
61007b31 | 5909 | while (top && top != base) { |
dcf3f9b2 | 5910 | top = bdrv_filter_or_cow_bs(top); |
02c50efe | 5911 | } |
61007b31 SH |
5912 | |
5913 | return top != NULL; | |
02c50efe FZ |
5914 | } |
5915 | ||
61007b31 | 5916 | BlockDriverState *bdrv_next_node(BlockDriverState *bs) |
02c50efe | 5917 | { |
61007b31 SH |
5918 | if (!bs) { |
5919 | return QTAILQ_FIRST(&graph_bdrv_states); | |
02c50efe | 5920 | } |
61007b31 | 5921 | return QTAILQ_NEXT(bs, node_list); |
83f64091 FB |
5922 | } |
5923 | ||
0f12264e KW |
5924 | BlockDriverState *bdrv_next_all_states(BlockDriverState *bs) |
5925 | { | |
5926 | if (!bs) { | |
5927 | return QTAILQ_FIRST(&all_bdrv_states); | |
5928 | } | |
5929 | return QTAILQ_NEXT(bs, bs_list); | |
5930 | } | |
5931 | ||
61007b31 | 5932 | const char *bdrv_get_node_name(const BlockDriverState *bs) |
83f64091 | 5933 | { |
61007b31 | 5934 | return bs->node_name; |
beac80cd FB |
5935 | } |
5936 | ||
1f0c461b | 5937 | const char *bdrv_get_parent_name(const BlockDriverState *bs) |
4c265bf9 KW |
5938 | { |
5939 | BdrvChild *c; | |
5940 | const char *name; | |
5941 | ||
5942 | /* If multiple parents have a name, just pick the first one. */ | |
5943 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
bd86fb99 HR |
5944 | if (c->klass->get_name) { |
5945 | name = c->klass->get_name(c); | |
4c265bf9 KW |
5946 | if (name && *name) { |
5947 | return name; | |
5948 | } | |
5949 | } | |
5950 | } | |
5951 | ||
5952 | return NULL; | |
5953 | } | |
5954 | ||
61007b31 SH |
5955 | /* TODO check what callers really want: bs->node_name or blk_name() */ |
5956 | const char *bdrv_get_device_name(const BlockDriverState *bs) | |
beac80cd | 5957 | { |
4c265bf9 | 5958 | return bdrv_get_parent_name(bs) ?: ""; |
f141eafe | 5959 | } |
83f64091 | 5960 | |
61007b31 SH |
5961 | /* This can be used to identify nodes that might not have a device |
5962 | * name associated. Since node and device names live in the same | |
5963 | * namespace, the result is unambiguous. The exception is if both are | |
5964 | * absent, then this returns an empty (non-null) string. */ | |
5965 | const char *bdrv_get_device_or_node_name(const BlockDriverState *bs) | |
f141eafe | 5966 | { |
4c265bf9 | 5967 | return bdrv_get_parent_name(bs) ?: bs->node_name; |
beac80cd | 5968 | } |
beac80cd | 5969 | |
61007b31 | 5970 | int bdrv_get_flags(BlockDriverState *bs) |
0b5a2445 | 5971 | { |
61007b31 | 5972 | return bs->open_flags; |
0b5a2445 PB |
5973 | } |
5974 | ||
61007b31 | 5975 | int bdrv_has_zero_init_1(BlockDriverState *bs) |
68485420 | 5976 | { |
61007b31 | 5977 | return 1; |
0b5a2445 PB |
5978 | } |
5979 | ||
61007b31 | 5980 | int bdrv_has_zero_init(BlockDriverState *bs) |
0b5a2445 | 5981 | { |
93393e69 HR |
5982 | BlockDriverState *filtered; |
5983 | ||
d470ad42 HR |
5984 | if (!bs->drv) { |
5985 | return 0; | |
5986 | } | |
0b5a2445 | 5987 | |
61007b31 SH |
5988 | /* If BS is a copy on write image, it is initialized to |
5989 | the contents of the base image, which may not be zeroes. */ | |
34778172 | 5990 | if (bdrv_cow_child(bs)) { |
61007b31 SH |
5991 | return 0; |
5992 | } | |
5993 | if (bs->drv->bdrv_has_zero_init) { | |
5994 | return bs->drv->bdrv_has_zero_init(bs); | |
0b5a2445 | 5995 | } |
93393e69 HR |
5996 | |
5997 | filtered = bdrv_filter_bs(bs); | |
5998 | if (filtered) { | |
5999 | return bdrv_has_zero_init(filtered); | |
5a612c00 | 6000 | } |
61007b31 SH |
6001 | |
6002 | /* safe default */ | |
6003 | return 0; | |
68485420 KW |
6004 | } |
6005 | ||
61007b31 | 6006 | bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs) |
68485420 | 6007 | { |
2f0342ef | 6008 | if (!(bs->open_flags & BDRV_O_UNMAP)) { |
61007b31 SH |
6009 | return false; |
6010 | } | |
68485420 | 6011 | |
e24d813b | 6012 | return bs->supported_zero_flags & BDRV_REQ_MAY_UNMAP; |
68485420 KW |
6013 | } |
6014 | ||
61007b31 SH |
6015 | void bdrv_get_backing_filename(BlockDriverState *bs, |
6016 | char *filename, int filename_size) | |
016f5cf6 | 6017 | { |
61007b31 SH |
6018 | pstrcpy(filename, filename_size, bs->backing_file); |
6019 | } | |
d318aea9 | 6020 | |
61007b31 SH |
6021 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi) |
6022 | { | |
8b117001 | 6023 | int ret; |
61007b31 | 6024 | BlockDriver *drv = bs->drv; |
5a612c00 MP |
6025 | /* if bs->drv == NULL, bs is closed, so there's nothing to do here */ |
6026 | if (!drv) { | |
61007b31 | 6027 | return -ENOMEDIUM; |
5a612c00 MP |
6028 | } |
6029 | if (!drv->bdrv_get_info) { | |
93393e69 HR |
6030 | BlockDriverState *filtered = bdrv_filter_bs(bs); |
6031 | if (filtered) { | |
6032 | return bdrv_get_info(filtered, bdi); | |
5a612c00 | 6033 | } |
61007b31 | 6034 | return -ENOTSUP; |
5a612c00 | 6035 | } |
61007b31 | 6036 | memset(bdi, 0, sizeof(*bdi)); |
8b117001 VSO |
6037 | ret = drv->bdrv_get_info(bs, bdi); |
6038 | if (ret < 0) { | |
6039 | return ret; | |
6040 | } | |
6041 | ||
6042 | if (bdi->cluster_size > BDRV_MAX_ALIGNMENT) { | |
6043 | return -EINVAL; | |
6044 | } | |
6045 | ||
6046 | return 0; | |
61007b31 | 6047 | } |
016f5cf6 | 6048 | |
1bf6e9ca AS |
6049 | ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs, |
6050 | Error **errp) | |
61007b31 SH |
6051 | { |
6052 | BlockDriver *drv = bs->drv; | |
6053 | if (drv && drv->bdrv_get_specific_info) { | |
1bf6e9ca | 6054 | return drv->bdrv_get_specific_info(bs, errp); |
61007b31 SH |
6055 | } |
6056 | return NULL; | |
016f5cf6 AG |
6057 | } |
6058 | ||
d9245599 AN |
6059 | BlockStatsSpecific *bdrv_get_specific_stats(BlockDriverState *bs) |
6060 | { | |
6061 | BlockDriver *drv = bs->drv; | |
6062 | if (!drv || !drv->bdrv_get_specific_stats) { | |
6063 | return NULL; | |
6064 | } | |
6065 | return drv->bdrv_get_specific_stats(bs); | |
6066 | } | |
6067 | ||
a31939e6 | 6068 | void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event) |
4265d620 | 6069 | { |
61007b31 SH |
6070 | if (!bs || !bs->drv || !bs->drv->bdrv_debug_event) { |
6071 | return; | |
6072 | } | |
4265d620 | 6073 | |
61007b31 | 6074 | bs->drv->bdrv_debug_event(bs, event); |
4265d620 PB |
6075 | } |
6076 | ||
d10529a2 | 6077 | static BlockDriverState *bdrv_find_debug_node(BlockDriverState *bs) |
4265d620 | 6078 | { |
61007b31 | 6079 | while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) { |
f706a92f | 6080 | bs = bdrv_primary_bs(bs); |
61007b31 | 6081 | } |
4265d620 | 6082 | |
61007b31 | 6083 | if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) { |
d10529a2 VSO |
6084 | assert(bs->drv->bdrv_debug_remove_breakpoint); |
6085 | return bs; | |
6086 | } | |
6087 | ||
6088 | return NULL; | |
6089 | } | |
6090 | ||
6091 | int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, | |
6092 | const char *tag) | |
6093 | { | |
6094 | bs = bdrv_find_debug_node(bs); | |
6095 | if (bs) { | |
61007b31 SH |
6096 | return bs->drv->bdrv_debug_breakpoint(bs, event, tag); |
6097 | } | |
4265d620 | 6098 | |
61007b31 | 6099 | return -ENOTSUP; |
4265d620 PB |
6100 | } |
6101 | ||
61007b31 | 6102 | int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag) |
ea2384d3 | 6103 | { |
d10529a2 VSO |
6104 | bs = bdrv_find_debug_node(bs); |
6105 | if (bs) { | |
61007b31 SH |
6106 | return bs->drv->bdrv_debug_remove_breakpoint(bs, tag); |
6107 | } | |
6108 | ||
6109 | return -ENOTSUP; | |
eb852011 MA |
6110 | } |
6111 | ||
61007b31 | 6112 | int bdrv_debug_resume(BlockDriverState *bs, const char *tag) |
ce1a14dc | 6113 | { |
61007b31 | 6114 | while (bs && (!bs->drv || !bs->drv->bdrv_debug_resume)) { |
f706a92f | 6115 | bs = bdrv_primary_bs(bs); |
61007b31 | 6116 | } |
ce1a14dc | 6117 | |
61007b31 SH |
6118 | if (bs && bs->drv && bs->drv->bdrv_debug_resume) { |
6119 | return bs->drv->bdrv_debug_resume(bs, tag); | |
6120 | } | |
ce1a14dc | 6121 | |
61007b31 | 6122 | return -ENOTSUP; |
f197fe2b FZ |
6123 | } |
6124 | ||
61007b31 | 6125 | bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag) |
ce1a14dc | 6126 | { |
61007b31 | 6127 | while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) { |
f706a92f | 6128 | bs = bdrv_primary_bs(bs); |
f197fe2b | 6129 | } |
19cb3738 | 6130 | |
61007b31 SH |
6131 | if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) { |
6132 | return bs->drv->bdrv_debug_is_suspended(bs, tag); | |
6133 | } | |
f9f05dc5 | 6134 | |
61007b31 SH |
6135 | return false; |
6136 | } | |
f9f05dc5 | 6137 | |
61007b31 SH |
6138 | /* backing_file can either be relative, or absolute, or a protocol. If it is |
6139 | * relative, it must be relative to the chain. So, passing in bs->filename | |
6140 | * from a BDS as backing_file should not be done, as that may be relative to | |
6141 | * the CWD rather than the chain. */ | |
6142 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, | |
6143 | const char *backing_file) | |
f9f05dc5 | 6144 | { |
61007b31 SH |
6145 | char *filename_full = NULL; |
6146 | char *backing_file_full = NULL; | |
6147 | char *filename_tmp = NULL; | |
6148 | int is_protocol = 0; | |
0b877d09 | 6149 | bool filenames_refreshed = false; |
61007b31 SH |
6150 | BlockDriverState *curr_bs = NULL; |
6151 | BlockDriverState *retval = NULL; | |
dcf3f9b2 | 6152 | BlockDriverState *bs_below; |
f9f05dc5 | 6153 | |
61007b31 SH |
6154 | if (!bs || !bs->drv || !backing_file) { |
6155 | return NULL; | |
f9f05dc5 KW |
6156 | } |
6157 | ||
61007b31 SH |
6158 | filename_full = g_malloc(PATH_MAX); |
6159 | backing_file_full = g_malloc(PATH_MAX); | |
f9f05dc5 | 6160 | |
61007b31 | 6161 | is_protocol = path_has_protocol(backing_file); |
f9f05dc5 | 6162 | |
dcf3f9b2 HR |
6163 | /* |
6164 | * Being largely a legacy function, skip any filters here | |
6165 | * (because filters do not have normal filenames, so they cannot | |
6166 | * match anyway; and allowing json:{} filenames is a bit out of | |
6167 | * scope). | |
6168 | */ | |
6169 | for (curr_bs = bdrv_skip_filters(bs); | |
6170 | bdrv_cow_child(curr_bs) != NULL; | |
6171 | curr_bs = bs_below) | |
6172 | { | |
6173 | bs_below = bdrv_backing_chain_next(curr_bs); | |
f9f05dc5 | 6174 | |
0b877d09 HR |
6175 | if (bdrv_backing_overridden(curr_bs)) { |
6176 | /* | |
6177 | * If the backing file was overridden, we can only compare | |
6178 | * directly against the backing node's filename. | |
6179 | */ | |
6180 | ||
6181 | if (!filenames_refreshed) { | |
6182 | /* | |
6183 | * This will automatically refresh all of the | |
6184 | * filenames in the rest of the backing chain, so we | |
6185 | * only need to do this once. | |
6186 | */ | |
6187 | bdrv_refresh_filename(bs_below); | |
6188 | filenames_refreshed = true; | |
6189 | } | |
6190 | ||
6191 | if (strcmp(backing_file, bs_below->filename) == 0) { | |
6192 | retval = bs_below; | |
6193 | break; | |
6194 | } | |
6195 | } else if (is_protocol || path_has_protocol(curr_bs->backing_file)) { | |
6196 | /* | |
6197 | * If either of the filename paths is actually a protocol, then | |
6198 | * compare unmodified paths; otherwise make paths relative. | |
6199 | */ | |
6b6833c1 HR |
6200 | char *backing_file_full_ret; |
6201 | ||
61007b31 | 6202 | if (strcmp(backing_file, curr_bs->backing_file) == 0) { |
dcf3f9b2 | 6203 | retval = bs_below; |
61007b31 SH |
6204 | break; |
6205 | } | |
418661e0 | 6206 | /* Also check against the full backing filename for the image */ |
6b6833c1 HR |
6207 | backing_file_full_ret = bdrv_get_full_backing_filename(curr_bs, |
6208 | NULL); | |
6209 | if (backing_file_full_ret) { | |
6210 | bool equal = strcmp(backing_file, backing_file_full_ret) == 0; | |
6211 | g_free(backing_file_full_ret); | |
6212 | if (equal) { | |
dcf3f9b2 | 6213 | retval = bs_below; |
418661e0 JC |
6214 | break; |
6215 | } | |
418661e0 | 6216 | } |
61007b31 SH |
6217 | } else { |
6218 | /* If not an absolute filename path, make it relative to the current | |
6219 | * image's filename path */ | |
2d9158ce HR |
6220 | filename_tmp = bdrv_make_absolute_filename(curr_bs, backing_file, |
6221 | NULL); | |
6222 | /* We are going to compare canonicalized absolute pathnames */ | |
6223 | if (!filename_tmp || !realpath(filename_tmp, filename_full)) { | |
6224 | g_free(filename_tmp); | |
61007b31 SH |
6225 | continue; |
6226 | } | |
2d9158ce | 6227 | g_free(filename_tmp); |
07f07615 | 6228 | |
61007b31 SH |
6229 | /* We need to make sure the backing filename we are comparing against |
6230 | * is relative to the current image filename (or absolute) */ | |
2d9158ce HR |
6231 | filename_tmp = bdrv_get_full_backing_filename(curr_bs, NULL); |
6232 | if (!filename_tmp || !realpath(filename_tmp, backing_file_full)) { | |
6233 | g_free(filename_tmp); | |
61007b31 SH |
6234 | continue; |
6235 | } | |
2d9158ce | 6236 | g_free(filename_tmp); |
eb489bb1 | 6237 | |
61007b31 | 6238 | if (strcmp(backing_file_full, filename_full) == 0) { |
dcf3f9b2 | 6239 | retval = bs_below; |
61007b31 SH |
6240 | break; |
6241 | } | |
6242 | } | |
eb489bb1 KW |
6243 | } |
6244 | ||
61007b31 SH |
6245 | g_free(filename_full); |
6246 | g_free(backing_file_full); | |
61007b31 SH |
6247 | return retval; |
6248 | } | |
6249 | ||
61007b31 SH |
6250 | void bdrv_init(void) |
6251 | { | |
e5f05f8c KW |
6252 | #ifdef CONFIG_BDRV_WHITELIST_TOOLS |
6253 | use_bdrv_whitelist = 1; | |
6254 | #endif | |
61007b31 SH |
6255 | module_call_init(MODULE_INIT_BLOCK); |
6256 | } | |
29cdb251 | 6257 | |
61007b31 SH |
6258 | void bdrv_init_with_whitelist(void) |
6259 | { | |
6260 | use_bdrv_whitelist = 1; | |
6261 | bdrv_init(); | |
07f07615 PB |
6262 | } |
6263 | ||
21c2283e | 6264 | int coroutine_fn bdrv_co_invalidate_cache(BlockDriverState *bs, Error **errp) |
0f15423c | 6265 | { |
4417ab7a | 6266 | BdrvChild *child, *parent; |
5a8a30db KW |
6267 | Error *local_err = NULL; |
6268 | int ret; | |
9c98f145 | 6269 | BdrvDirtyBitmap *bm; |
5a8a30db | 6270 | |
3456a8d1 | 6271 | if (!bs->drv) { |
5416645f | 6272 | return -ENOMEDIUM; |
3456a8d1 KW |
6273 | } |
6274 | ||
16e977d5 | 6275 | QLIST_FOREACH(child, &bs->children, next) { |
2b148f39 | 6276 | bdrv_co_invalidate_cache(child->bs, &local_err); |
0d1c5c91 | 6277 | if (local_err) { |
0d1c5c91 | 6278 | error_propagate(errp, local_err); |
5416645f | 6279 | return -EINVAL; |
0d1c5c91 | 6280 | } |
5a8a30db | 6281 | } |
0d1c5c91 | 6282 | |
dafe0960 KW |
6283 | /* |
6284 | * Update permissions, they may differ for inactive nodes. | |
6285 | * | |
6286 | * Note that the required permissions of inactive images are always a | |
6287 | * subset of the permissions required after activating the image. This | |
6288 | * allows us to just get the permissions upfront without restricting | |
6289 | * drv->bdrv_invalidate_cache(). | |
6290 | * | |
6291 | * It also means that in error cases, we don't have to try and revert to | |
6292 | * the old permissions (which is an operation that could fail, too). We can | |
6293 | * just keep the extended permissions for the next time that an activation | |
6294 | * of the image is tried. | |
6295 | */ | |
7bb4941a KW |
6296 | if (bs->open_flags & BDRV_O_INACTIVE) { |
6297 | bs->open_flags &= ~BDRV_O_INACTIVE; | |
071b474f | 6298 | ret = bdrv_refresh_perms(bs, errp); |
7bb4941a | 6299 | if (ret < 0) { |
0d1c5c91 | 6300 | bs->open_flags |= BDRV_O_INACTIVE; |
5416645f | 6301 | return ret; |
0d1c5c91 | 6302 | } |
3456a8d1 | 6303 | |
7bb4941a KW |
6304 | if (bs->drv->bdrv_co_invalidate_cache) { |
6305 | bs->drv->bdrv_co_invalidate_cache(bs, &local_err); | |
6306 | if (local_err) { | |
6307 | bs->open_flags |= BDRV_O_INACTIVE; | |
6308 | error_propagate(errp, local_err); | |
5416645f | 6309 | return -EINVAL; |
7bb4941a KW |
6310 | } |
6311 | } | |
9c98f145 | 6312 | |
7bb4941a KW |
6313 | FOR_EACH_DIRTY_BITMAP(bs, bm) { |
6314 | bdrv_dirty_bitmap_skip_store(bm, false); | |
6315 | } | |
6316 | ||
6317 | ret = refresh_total_sectors(bs, bs->total_sectors); | |
6318 | if (ret < 0) { | |
6319 | bs->open_flags |= BDRV_O_INACTIVE; | |
6320 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); | |
5416645f | 6321 | return ret; |
7bb4941a | 6322 | } |
5a8a30db | 6323 | } |
4417ab7a KW |
6324 | |
6325 | QLIST_FOREACH(parent, &bs->parents, next_parent) { | |
bd86fb99 HR |
6326 | if (parent->klass->activate) { |
6327 | parent->klass->activate(parent, &local_err); | |
4417ab7a | 6328 | if (local_err) { |
78fc3b3a | 6329 | bs->open_flags |= BDRV_O_INACTIVE; |
4417ab7a | 6330 | error_propagate(errp, local_err); |
5416645f | 6331 | return -EINVAL; |
4417ab7a KW |
6332 | } |
6333 | } | |
6334 | } | |
5416645f VSO |
6335 | |
6336 | return 0; | |
0f15423c AL |
6337 | } |
6338 | ||
5a8a30db | 6339 | void bdrv_invalidate_cache_all(Error **errp) |
0f15423c | 6340 | { |
7c8eece4 | 6341 | BlockDriverState *bs; |
88be7b4b | 6342 | BdrvNextIterator it; |
0f15423c | 6343 | |
88be7b4b | 6344 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
ed78cda3 | 6345 | AioContext *aio_context = bdrv_get_aio_context(bs); |
5416645f | 6346 | int ret; |
ed78cda3 SH |
6347 | |
6348 | aio_context_acquire(aio_context); | |
5416645f | 6349 | ret = bdrv_invalidate_cache(bs, errp); |
ed78cda3 | 6350 | aio_context_release(aio_context); |
5416645f | 6351 | if (ret < 0) { |
5e003f17 | 6352 | bdrv_next_cleanup(&it); |
5a8a30db KW |
6353 | return; |
6354 | } | |
0f15423c AL |
6355 | } |
6356 | } | |
6357 | ||
9e37271f KW |
6358 | static bool bdrv_has_bds_parent(BlockDriverState *bs, bool only_active) |
6359 | { | |
6360 | BdrvChild *parent; | |
6361 | ||
6362 | QLIST_FOREACH(parent, &bs->parents, next_parent) { | |
bd86fb99 | 6363 | if (parent->klass->parent_is_bds) { |
9e37271f KW |
6364 | BlockDriverState *parent_bs = parent->opaque; |
6365 | if (!only_active || !(parent_bs->open_flags & BDRV_O_INACTIVE)) { | |
6366 | return true; | |
6367 | } | |
6368 | } | |
6369 | } | |
6370 | ||
6371 | return false; | |
6372 | } | |
6373 | ||
6374 | static int bdrv_inactivate_recurse(BlockDriverState *bs) | |
76b1c7fe | 6375 | { |
cfa1a572 | 6376 | BdrvChild *child, *parent; |
76b1c7fe | 6377 | int ret; |
a13de40a | 6378 | uint64_t cumulative_perms, cumulative_shared_perms; |
76b1c7fe | 6379 | |
d470ad42 HR |
6380 | if (!bs->drv) { |
6381 | return -ENOMEDIUM; | |
6382 | } | |
6383 | ||
9e37271f KW |
6384 | /* Make sure that we don't inactivate a child before its parent. |
6385 | * It will be covered by recursion from the yet active parent. */ | |
6386 | if (bdrv_has_bds_parent(bs, true)) { | |
6387 | return 0; | |
6388 | } | |
6389 | ||
6390 | assert(!(bs->open_flags & BDRV_O_INACTIVE)); | |
6391 | ||
6392 | /* Inactivate this node */ | |
6393 | if (bs->drv->bdrv_inactivate) { | |
76b1c7fe KW |
6394 | ret = bs->drv->bdrv_inactivate(bs); |
6395 | if (ret < 0) { | |
6396 | return ret; | |
6397 | } | |
6398 | } | |
6399 | ||
9e37271f | 6400 | QLIST_FOREACH(parent, &bs->parents, next_parent) { |
bd86fb99 HR |
6401 | if (parent->klass->inactivate) { |
6402 | ret = parent->klass->inactivate(parent); | |
9e37271f KW |
6403 | if (ret < 0) { |
6404 | return ret; | |
cfa1a572 KW |
6405 | } |
6406 | } | |
9e37271f | 6407 | } |
9c5e6594 | 6408 | |
a13de40a VSO |
6409 | bdrv_get_cumulative_perm(bs, &cumulative_perms, |
6410 | &cumulative_shared_perms); | |
6411 | if (cumulative_perms & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED)) { | |
6412 | /* Our inactive parents still need write access. Inactivation failed. */ | |
6413 | return -EPERM; | |
6414 | } | |
6415 | ||
9e37271f | 6416 | bs->open_flags |= BDRV_O_INACTIVE; |
7d5b5261 | 6417 | |
bb87e4d1 VSO |
6418 | /* |
6419 | * Update permissions, they may differ for inactive nodes. | |
6420 | * We only tried to loosen restrictions, so errors are not fatal, ignore | |
6421 | * them. | |
6422 | */ | |
071b474f | 6423 | bdrv_refresh_perms(bs, NULL); |
9e37271f KW |
6424 | |
6425 | /* Recursively inactivate children */ | |
38701b6a | 6426 | QLIST_FOREACH(child, &bs->children, next) { |
9e37271f | 6427 | ret = bdrv_inactivate_recurse(child->bs); |
38701b6a KW |
6428 | if (ret < 0) { |
6429 | return ret; | |
6430 | } | |
6431 | } | |
6432 | ||
76b1c7fe KW |
6433 | return 0; |
6434 | } | |
6435 | ||
6436 | int bdrv_inactivate_all(void) | |
6437 | { | |
79720af6 | 6438 | BlockDriverState *bs = NULL; |
88be7b4b | 6439 | BdrvNextIterator it; |
aad0b7a0 | 6440 | int ret = 0; |
bd6458e4 | 6441 | GSList *aio_ctxs = NULL, *ctx; |
76b1c7fe | 6442 | |
88be7b4b | 6443 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
bd6458e4 PB |
6444 | AioContext *aio_context = bdrv_get_aio_context(bs); |
6445 | ||
6446 | if (!g_slist_find(aio_ctxs, aio_context)) { | |
6447 | aio_ctxs = g_slist_prepend(aio_ctxs, aio_context); | |
6448 | aio_context_acquire(aio_context); | |
6449 | } | |
aad0b7a0 | 6450 | } |
76b1c7fe | 6451 | |
9e37271f KW |
6452 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
6453 | /* Nodes with BDS parents are covered by recursion from the last | |
6454 | * parent that gets inactivated. Don't inactivate them a second | |
6455 | * time if that has already happened. */ | |
6456 | if (bdrv_has_bds_parent(bs, false)) { | |
6457 | continue; | |
6458 | } | |
6459 | ret = bdrv_inactivate_recurse(bs); | |
6460 | if (ret < 0) { | |
6461 | bdrv_next_cleanup(&it); | |
6462 | goto out; | |
76b1c7fe KW |
6463 | } |
6464 | } | |
6465 | ||
aad0b7a0 | 6466 | out: |
bd6458e4 PB |
6467 | for (ctx = aio_ctxs; ctx != NULL; ctx = ctx->next) { |
6468 | AioContext *aio_context = ctx->data; | |
6469 | aio_context_release(aio_context); | |
aad0b7a0 | 6470 | } |
bd6458e4 | 6471 | g_slist_free(aio_ctxs); |
aad0b7a0 FZ |
6472 | |
6473 | return ret; | |
76b1c7fe KW |
6474 | } |
6475 | ||
19cb3738 FB |
6476 | /**************************************************************/ |
6477 | /* removable device support */ | |
6478 | ||
6479 | /** | |
6480 | * Return TRUE if the media is present | |
6481 | */ | |
e031f750 | 6482 | bool bdrv_is_inserted(BlockDriverState *bs) |
19cb3738 FB |
6483 | { |
6484 | BlockDriver *drv = bs->drv; | |
28d7a789 | 6485 | BdrvChild *child; |
a1aff5bf | 6486 | |
e031f750 HR |
6487 | if (!drv) { |
6488 | return false; | |
6489 | } | |
28d7a789 HR |
6490 | if (drv->bdrv_is_inserted) { |
6491 | return drv->bdrv_is_inserted(bs); | |
6492 | } | |
6493 | QLIST_FOREACH(child, &bs->children, next) { | |
6494 | if (!bdrv_is_inserted(child->bs)) { | |
6495 | return false; | |
6496 | } | |
e031f750 | 6497 | } |
28d7a789 | 6498 | return true; |
19cb3738 FB |
6499 | } |
6500 | ||
19cb3738 FB |
6501 | /** |
6502 | * If eject_flag is TRUE, eject the media. Otherwise, close the tray | |
6503 | */ | |
f36f3949 | 6504 | void bdrv_eject(BlockDriverState *bs, bool eject_flag) |
19cb3738 FB |
6505 | { |
6506 | BlockDriver *drv = bs->drv; | |
19cb3738 | 6507 | |
822e1cd1 MA |
6508 | if (drv && drv->bdrv_eject) { |
6509 | drv->bdrv_eject(bs, eject_flag); | |
19cb3738 FB |
6510 | } |
6511 | } | |
6512 | ||
19cb3738 FB |
6513 | /** |
6514 | * Lock or unlock the media (if it is locked, the user won't be able | |
6515 | * to eject it manually). | |
6516 | */ | |
025e849a | 6517 | void bdrv_lock_medium(BlockDriverState *bs, bool locked) |
19cb3738 FB |
6518 | { |
6519 | BlockDriver *drv = bs->drv; | |
6520 | ||
025e849a | 6521 | trace_bdrv_lock_medium(bs, locked); |
b8c6d095 | 6522 | |
025e849a MA |
6523 | if (drv && drv->bdrv_lock_medium) { |
6524 | drv->bdrv_lock_medium(bs, locked); | |
19cb3738 FB |
6525 | } |
6526 | } | |
985a03b0 | 6527 | |
9fcb0251 FZ |
6528 | /* Get a reference to bs */ |
6529 | void bdrv_ref(BlockDriverState *bs) | |
6530 | { | |
6531 | bs->refcnt++; | |
6532 | } | |
6533 | ||
6534 | /* Release a previously grabbed reference to bs. | |
6535 | * If after releasing, reference count is zero, the BlockDriverState is | |
6536 | * deleted. */ | |
6537 | void bdrv_unref(BlockDriverState *bs) | |
6538 | { | |
9a4d5ca6 JC |
6539 | if (!bs) { |
6540 | return; | |
6541 | } | |
9fcb0251 FZ |
6542 | assert(bs->refcnt > 0); |
6543 | if (--bs->refcnt == 0) { | |
6544 | bdrv_delete(bs); | |
6545 | } | |
6546 | } | |
6547 | ||
fbe40ff7 FZ |
6548 | struct BdrvOpBlocker { |
6549 | Error *reason; | |
6550 | QLIST_ENTRY(BdrvOpBlocker) list; | |
6551 | }; | |
6552 | ||
6553 | bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp) | |
6554 | { | |
6555 | BdrvOpBlocker *blocker; | |
6556 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
6557 | if (!QLIST_EMPTY(&bs->op_blockers[op])) { | |
6558 | blocker = QLIST_FIRST(&bs->op_blockers[op]); | |
4b576648 MA |
6559 | error_propagate_prepend(errp, error_copy(blocker->reason), |
6560 | "Node '%s' is busy: ", | |
6561 | bdrv_get_device_or_node_name(bs)); | |
fbe40ff7 FZ |
6562 | return true; |
6563 | } | |
6564 | return false; | |
6565 | } | |
6566 | ||
6567 | void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason) | |
6568 | { | |
6569 | BdrvOpBlocker *blocker; | |
6570 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
6571 | ||
5839e53b | 6572 | blocker = g_new0(BdrvOpBlocker, 1); |
fbe40ff7 FZ |
6573 | blocker->reason = reason; |
6574 | QLIST_INSERT_HEAD(&bs->op_blockers[op], blocker, list); | |
6575 | } | |
6576 | ||
6577 | void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason) | |
6578 | { | |
6579 | BdrvOpBlocker *blocker, *next; | |
6580 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
6581 | QLIST_FOREACH_SAFE(blocker, &bs->op_blockers[op], list, next) { | |
6582 | if (blocker->reason == reason) { | |
6583 | QLIST_REMOVE(blocker, list); | |
6584 | g_free(blocker); | |
6585 | } | |
6586 | } | |
6587 | } | |
6588 | ||
6589 | void bdrv_op_block_all(BlockDriverState *bs, Error *reason) | |
6590 | { | |
6591 | int i; | |
6592 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
6593 | bdrv_op_block(bs, i, reason); | |
6594 | } | |
6595 | } | |
6596 | ||
6597 | void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason) | |
6598 | { | |
6599 | int i; | |
6600 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
6601 | bdrv_op_unblock(bs, i, reason); | |
6602 | } | |
6603 | } | |
6604 | ||
6605 | bool bdrv_op_blocker_is_empty(BlockDriverState *bs) | |
6606 | { | |
6607 | int i; | |
6608 | ||
6609 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
6610 | if (!QLIST_EMPTY(&bs->op_blockers[i])) { | |
6611 | return false; | |
6612 | } | |
6613 | } | |
6614 | return true; | |
6615 | } | |
6616 | ||
d92ada22 LC |
6617 | void bdrv_img_create(const char *filename, const char *fmt, |
6618 | const char *base_filename, const char *base_fmt, | |
9217283d FZ |
6619 | char *options, uint64_t img_size, int flags, bool quiet, |
6620 | Error **errp) | |
f88e1a42 | 6621 | { |
83d0521a CL |
6622 | QemuOptsList *create_opts = NULL; |
6623 | QemuOpts *opts = NULL; | |
6624 | const char *backing_fmt, *backing_file; | |
6625 | int64_t size; | |
f88e1a42 | 6626 | BlockDriver *drv, *proto_drv; |
cc84d90f | 6627 | Error *local_err = NULL; |
f88e1a42 JS |
6628 | int ret = 0; |
6629 | ||
6630 | /* Find driver and parse its options */ | |
6631 | drv = bdrv_find_format(fmt); | |
6632 | if (!drv) { | |
71c79813 | 6633 | error_setg(errp, "Unknown file format '%s'", fmt); |
d92ada22 | 6634 | return; |
f88e1a42 JS |
6635 | } |
6636 | ||
b65a5e12 | 6637 | proto_drv = bdrv_find_protocol(filename, true, errp); |
f88e1a42 | 6638 | if (!proto_drv) { |
d92ada22 | 6639 | return; |
f88e1a42 JS |
6640 | } |
6641 | ||
c6149724 HR |
6642 | if (!drv->create_opts) { |
6643 | error_setg(errp, "Format driver '%s' does not support image creation", | |
6644 | drv->format_name); | |
6645 | return; | |
6646 | } | |
6647 | ||
5a5e7f8c ML |
6648 | if (!proto_drv->create_opts) { |
6649 | error_setg(errp, "Protocol driver '%s' does not support image creation", | |
6650 | proto_drv->format_name); | |
6651 | return; | |
6652 | } | |
6653 | ||
f6dc1c31 | 6654 | /* Create parameter list */ |
c282e1fd | 6655 | create_opts = qemu_opts_append(create_opts, drv->create_opts); |
5a5e7f8c | 6656 | create_opts = qemu_opts_append(create_opts, proto_drv->create_opts); |
f88e1a42 | 6657 | |
83d0521a | 6658 | opts = qemu_opts_create(create_opts, NULL, 0, &error_abort); |
f88e1a42 JS |
6659 | |
6660 | /* Parse -o options */ | |
6661 | if (options) { | |
a5f9b9df | 6662 | if (!qemu_opts_do_parse(opts, options, NULL, errp)) { |
f88e1a42 JS |
6663 | goto out; |
6664 | } | |
6665 | } | |
6666 | ||
f6dc1c31 KW |
6667 | if (!qemu_opt_get(opts, BLOCK_OPT_SIZE)) { |
6668 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort); | |
6669 | } else if (img_size != UINT64_C(-1)) { | |
6670 | error_setg(errp, "The image size must be specified only once"); | |
6671 | goto out; | |
6672 | } | |
6673 | ||
f88e1a42 | 6674 | if (base_filename) { |
235e59cf | 6675 | if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, |
3882578b | 6676 | NULL)) { |
71c79813 LC |
6677 | error_setg(errp, "Backing file not supported for file format '%s'", |
6678 | fmt); | |
f88e1a42 JS |
6679 | goto out; |
6680 | } | |
6681 | } | |
6682 | ||
6683 | if (base_fmt) { | |
3882578b | 6684 | if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, NULL)) { |
71c79813 LC |
6685 | error_setg(errp, "Backing file format not supported for file " |
6686 | "format '%s'", fmt); | |
f88e1a42 JS |
6687 | goto out; |
6688 | } | |
6689 | } | |
6690 | ||
83d0521a CL |
6691 | backing_file = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE); |
6692 | if (backing_file) { | |
6693 | if (!strcmp(filename, backing_file)) { | |
71c79813 LC |
6694 | error_setg(errp, "Error: Trying to create an image with the " |
6695 | "same filename as the backing file"); | |
792da93a JS |
6696 | goto out; |
6697 | } | |
975a7bd2 CK |
6698 | if (backing_file[0] == '\0') { |
6699 | error_setg(errp, "Expected backing file name, got empty string"); | |
6700 | goto out; | |
6701 | } | |
792da93a JS |
6702 | } |
6703 | ||
83d0521a | 6704 | backing_fmt = qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT); |
f88e1a42 | 6705 | |
6e6e55f5 JS |
6706 | /* The size for the image must always be specified, unless we have a backing |
6707 | * file and we have not been forbidden from opening it. */ | |
a8b42a1c | 6708 | size = qemu_opt_get_size(opts, BLOCK_OPT_SIZE, img_size); |
6e6e55f5 JS |
6709 | if (backing_file && !(flags & BDRV_O_NO_BACKING)) { |
6710 | BlockDriverState *bs; | |
645ae7d8 | 6711 | char *full_backing; |
6e6e55f5 JS |
6712 | int back_flags; |
6713 | QDict *backing_options = NULL; | |
6714 | ||
645ae7d8 HR |
6715 | full_backing = |
6716 | bdrv_get_full_backing_filename_from_filename(filename, backing_file, | |
6717 | &local_err); | |
6e6e55f5 | 6718 | if (local_err) { |
6e6e55f5 JS |
6719 | goto out; |
6720 | } | |
645ae7d8 | 6721 | assert(full_backing); |
29168018 | 6722 | |
d5b23994 HR |
6723 | /* |
6724 | * No need to do I/O here, which allows us to open encrypted | |
6725 | * backing images without needing the secret | |
6726 | */ | |
6e6e55f5 JS |
6727 | back_flags = flags; |
6728 | back_flags &= ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING); | |
d5b23994 | 6729 | back_flags |= BDRV_O_NO_IO; |
f88e1a42 | 6730 | |
cc954f01 | 6731 | backing_options = qdict_new(); |
6e6e55f5 | 6732 | if (backing_fmt) { |
6e6e55f5 JS |
6733 | qdict_put_str(backing_options, "driver", backing_fmt); |
6734 | } | |
cc954f01 | 6735 | qdict_put_bool(backing_options, BDRV_OPT_FORCE_SHARE, true); |
e6641719 | 6736 | |
6e6e55f5 JS |
6737 | bs = bdrv_open(full_backing, NULL, backing_options, back_flags, |
6738 | &local_err); | |
6739 | g_free(full_backing); | |
add8200d EB |
6740 | if (!bs) { |
6741 | error_append_hint(&local_err, "Could not open backing image.\n"); | |
6e6e55f5 JS |
6742 | goto out; |
6743 | } else { | |
d9f059aa | 6744 | if (!backing_fmt) { |
497a30db EB |
6745 | error_setg(&local_err, |
6746 | "Backing file specified without backing format"); | |
6747 | error_append_hint(&local_err, "Detected format of %s.", | |
6748 | bs->drv->format_name); | |
6749 | goto out; | |
d9f059aa | 6750 | } |
6e6e55f5 JS |
6751 | if (size == -1) { |
6752 | /* Opened BS, have no size */ | |
6753 | size = bdrv_getlength(bs); | |
6754 | if (size < 0) { | |
6755 | error_setg_errno(errp, -size, "Could not get size of '%s'", | |
6756 | backing_file); | |
6757 | bdrv_unref(bs); | |
6758 | goto out; | |
6759 | } | |
6760 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, size, &error_abort); | |
52bf1e72 | 6761 | } |
66f6b814 | 6762 | bdrv_unref(bs); |
f88e1a42 | 6763 | } |
d9f059aa EB |
6764 | /* (backing_file && !(flags & BDRV_O_NO_BACKING)) */ |
6765 | } else if (backing_file && !backing_fmt) { | |
497a30db EB |
6766 | error_setg(&local_err, |
6767 | "Backing file specified without backing format"); | |
6768 | goto out; | |
d9f059aa | 6769 | } |
6e6e55f5 JS |
6770 | |
6771 | if (size == -1) { | |
6772 | error_setg(errp, "Image creation needs a size parameter"); | |
6773 | goto out; | |
f88e1a42 JS |
6774 | } |
6775 | ||
f382d43a | 6776 | if (!quiet) { |
fe646693 | 6777 | printf("Formatting '%s', fmt=%s ", filename, fmt); |
43c5d8f8 | 6778 | qemu_opts_print(opts, " "); |
f382d43a | 6779 | puts(""); |
4e2f4418 | 6780 | fflush(stdout); |
f382d43a | 6781 | } |
83d0521a | 6782 | |
c282e1fd | 6783 | ret = bdrv_create(drv, filename, opts, &local_err); |
83d0521a | 6784 | |
cc84d90f HR |
6785 | if (ret == -EFBIG) { |
6786 | /* This is generally a better message than whatever the driver would | |
6787 | * deliver (especially because of the cluster_size_hint), since that | |
6788 | * is most probably not much different from "image too large". */ | |
6789 | const char *cluster_size_hint = ""; | |
83d0521a | 6790 | if (qemu_opt_get_size(opts, BLOCK_OPT_CLUSTER_SIZE, 0)) { |
cc84d90f | 6791 | cluster_size_hint = " (try using a larger cluster size)"; |
f88e1a42 | 6792 | } |
cc84d90f HR |
6793 | error_setg(errp, "The image size is too large for file format '%s'" |
6794 | "%s", fmt, cluster_size_hint); | |
6795 | error_free(local_err); | |
6796 | local_err = NULL; | |
f88e1a42 JS |
6797 | } |
6798 | ||
6799 | out: | |
83d0521a CL |
6800 | qemu_opts_del(opts); |
6801 | qemu_opts_free(create_opts); | |
621ff94d | 6802 | error_propagate(errp, local_err); |
f88e1a42 | 6803 | } |
85d126f3 SH |
6804 | |
6805 | AioContext *bdrv_get_aio_context(BlockDriverState *bs) | |
6806 | { | |
33f2a757 | 6807 | return bs ? bs->aio_context : qemu_get_aio_context(); |
dcd04228 SH |
6808 | } |
6809 | ||
e336fd4c KW |
6810 | AioContext *coroutine_fn bdrv_co_enter(BlockDriverState *bs) |
6811 | { | |
6812 | Coroutine *self = qemu_coroutine_self(); | |
6813 | AioContext *old_ctx = qemu_coroutine_get_aio_context(self); | |
6814 | AioContext *new_ctx; | |
6815 | ||
6816 | /* | |
6817 | * Increase bs->in_flight to ensure that this operation is completed before | |
6818 | * moving the node to a different AioContext. Read new_ctx only afterwards. | |
6819 | */ | |
6820 | bdrv_inc_in_flight(bs); | |
6821 | ||
6822 | new_ctx = bdrv_get_aio_context(bs); | |
6823 | aio_co_reschedule_self(new_ctx); | |
6824 | return old_ctx; | |
6825 | } | |
6826 | ||
6827 | void coroutine_fn bdrv_co_leave(BlockDriverState *bs, AioContext *old_ctx) | |
6828 | { | |
6829 | aio_co_reschedule_self(old_ctx); | |
6830 | bdrv_dec_in_flight(bs); | |
6831 | } | |
6832 | ||
18c6ac1c KW |
6833 | void coroutine_fn bdrv_co_lock(BlockDriverState *bs) |
6834 | { | |
6835 | AioContext *ctx = bdrv_get_aio_context(bs); | |
6836 | ||
6837 | /* In the main thread, bs->aio_context won't change concurrently */ | |
6838 | assert(qemu_get_current_aio_context() == qemu_get_aio_context()); | |
6839 | ||
6840 | /* | |
6841 | * We're in coroutine context, so we already hold the lock of the main | |
6842 | * loop AioContext. Don't lock it twice to avoid deadlocks. | |
6843 | */ | |
6844 | assert(qemu_in_coroutine()); | |
6845 | if (ctx != qemu_get_aio_context()) { | |
6846 | aio_context_acquire(ctx); | |
6847 | } | |
6848 | } | |
6849 | ||
6850 | void coroutine_fn bdrv_co_unlock(BlockDriverState *bs) | |
6851 | { | |
6852 | AioContext *ctx = bdrv_get_aio_context(bs); | |
6853 | ||
6854 | assert(qemu_in_coroutine()); | |
6855 | if (ctx != qemu_get_aio_context()) { | |
6856 | aio_context_release(ctx); | |
6857 | } | |
6858 | } | |
6859 | ||
052a7572 FZ |
6860 | void bdrv_coroutine_enter(BlockDriverState *bs, Coroutine *co) |
6861 | { | |
6862 | aio_co_enter(bdrv_get_aio_context(bs), co); | |
6863 | } | |
6864 | ||
e8a095da SH |
6865 | static void bdrv_do_remove_aio_context_notifier(BdrvAioNotifier *ban) |
6866 | { | |
6867 | QLIST_REMOVE(ban, list); | |
6868 | g_free(ban); | |
6869 | } | |
6870 | ||
a3a683c3 | 6871 | static void bdrv_detach_aio_context(BlockDriverState *bs) |
dcd04228 | 6872 | { |
e8a095da | 6873 | BdrvAioNotifier *baf, *baf_tmp; |
33384421 | 6874 | |
e8a095da SH |
6875 | assert(!bs->walking_aio_notifiers); |
6876 | bs->walking_aio_notifiers = true; | |
6877 | QLIST_FOREACH_SAFE(baf, &bs->aio_notifiers, list, baf_tmp) { | |
6878 | if (baf->deleted) { | |
6879 | bdrv_do_remove_aio_context_notifier(baf); | |
6880 | } else { | |
6881 | baf->detach_aio_context(baf->opaque); | |
6882 | } | |
33384421 | 6883 | } |
e8a095da SH |
6884 | /* Never mind iterating again to check for ->deleted. bdrv_close() will |
6885 | * remove remaining aio notifiers if we aren't called again. | |
6886 | */ | |
6887 | bs->walking_aio_notifiers = false; | |
33384421 | 6888 | |
1bffe1ae | 6889 | if (bs->drv && bs->drv->bdrv_detach_aio_context) { |
dcd04228 SH |
6890 | bs->drv->bdrv_detach_aio_context(bs); |
6891 | } | |
dcd04228 | 6892 | |
e64f25f3 KW |
6893 | if (bs->quiesce_counter) { |
6894 | aio_enable_external(bs->aio_context); | |
6895 | } | |
dcd04228 SH |
6896 | bs->aio_context = NULL; |
6897 | } | |
6898 | ||
a3a683c3 KW |
6899 | static void bdrv_attach_aio_context(BlockDriverState *bs, |
6900 | AioContext *new_context) | |
dcd04228 | 6901 | { |
e8a095da | 6902 | BdrvAioNotifier *ban, *ban_tmp; |
33384421 | 6903 | |
e64f25f3 KW |
6904 | if (bs->quiesce_counter) { |
6905 | aio_disable_external(new_context); | |
6906 | } | |
6907 | ||
dcd04228 SH |
6908 | bs->aio_context = new_context; |
6909 | ||
1bffe1ae | 6910 | if (bs->drv && bs->drv->bdrv_attach_aio_context) { |
dcd04228 SH |
6911 | bs->drv->bdrv_attach_aio_context(bs, new_context); |
6912 | } | |
33384421 | 6913 | |
e8a095da SH |
6914 | assert(!bs->walking_aio_notifiers); |
6915 | bs->walking_aio_notifiers = true; | |
6916 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_tmp) { | |
6917 | if (ban->deleted) { | |
6918 | bdrv_do_remove_aio_context_notifier(ban); | |
6919 | } else { | |
6920 | ban->attached_aio_context(new_context, ban->opaque); | |
6921 | } | |
33384421 | 6922 | } |
e8a095da | 6923 | bs->walking_aio_notifiers = false; |
dcd04228 SH |
6924 | } |
6925 | ||
42a65f02 KW |
6926 | /* |
6927 | * Changes the AioContext used for fd handlers, timers, and BHs by this | |
6928 | * BlockDriverState and all its children and parents. | |
6929 | * | |
43eaaaef HR |
6930 | * Must be called from the main AioContext. |
6931 | * | |
42a65f02 KW |
6932 | * The caller must own the AioContext lock for the old AioContext of bs, but it |
6933 | * must not own the AioContext lock for new_context (unless new_context is the | |
6934 | * same as the current context of bs). | |
6935 | * | |
6936 | * @ignore will accumulate all visited BdrvChild object. The caller is | |
6937 | * responsible for freeing the list afterwards. | |
6938 | */ | |
53a7d041 KW |
6939 | void bdrv_set_aio_context_ignore(BlockDriverState *bs, |
6940 | AioContext *new_context, GSList **ignore) | |
dcd04228 | 6941 | { |
e037c09c | 6942 | AioContext *old_context = bdrv_get_aio_context(bs); |
722d8e73 SL |
6943 | GSList *children_to_process = NULL; |
6944 | GSList *parents_to_process = NULL; | |
6945 | GSList *entry; | |
6946 | BdrvChild *child, *parent; | |
0d83708a | 6947 | |
43eaaaef HR |
6948 | g_assert(qemu_get_current_aio_context() == qemu_get_aio_context()); |
6949 | ||
e037c09c | 6950 | if (old_context == new_context) { |
57830a49 DP |
6951 | return; |
6952 | } | |
6953 | ||
d70d5954 | 6954 | bdrv_drained_begin(bs); |
0d83708a KW |
6955 | |
6956 | QLIST_FOREACH(child, &bs->children, next) { | |
53a7d041 KW |
6957 | if (g_slist_find(*ignore, child)) { |
6958 | continue; | |
6959 | } | |
6960 | *ignore = g_slist_prepend(*ignore, child); | |
722d8e73 | 6961 | children_to_process = g_slist_prepend(children_to_process, child); |
53a7d041 | 6962 | } |
722d8e73 SL |
6963 | |
6964 | QLIST_FOREACH(parent, &bs->parents, next_parent) { | |
6965 | if (g_slist_find(*ignore, parent)) { | |
53a7d041 KW |
6966 | continue; |
6967 | } | |
722d8e73 SL |
6968 | *ignore = g_slist_prepend(*ignore, parent); |
6969 | parents_to_process = g_slist_prepend(parents_to_process, parent); | |
6970 | } | |
6971 | ||
6972 | for (entry = children_to_process; | |
6973 | entry != NULL; | |
6974 | entry = g_slist_next(entry)) { | |
6975 | child = entry->data; | |
6976 | bdrv_set_aio_context_ignore(child->bs, new_context, ignore); | |
6977 | } | |
6978 | g_slist_free(children_to_process); | |
6979 | ||
6980 | for (entry = parents_to_process; | |
6981 | entry != NULL; | |
6982 | entry = g_slist_next(entry)) { | |
6983 | parent = entry->data; | |
6984 | assert(parent->klass->set_aio_ctx); | |
6985 | parent->klass->set_aio_ctx(parent, new_context, ignore); | |
0d83708a | 6986 | } |
722d8e73 | 6987 | g_slist_free(parents_to_process); |
0d83708a | 6988 | |
dcd04228 SH |
6989 | bdrv_detach_aio_context(bs); |
6990 | ||
e037c09c | 6991 | /* Acquire the new context, if necessary */ |
43eaaaef | 6992 | if (qemu_get_aio_context() != new_context) { |
e037c09c HR |
6993 | aio_context_acquire(new_context); |
6994 | } | |
6995 | ||
dcd04228 | 6996 | bdrv_attach_aio_context(bs, new_context); |
e037c09c HR |
6997 | |
6998 | /* | |
6999 | * If this function was recursively called from | |
7000 | * bdrv_set_aio_context_ignore(), there may be nodes in the | |
7001 | * subtree that have not yet been moved to the new AioContext. | |
7002 | * Release the old one so bdrv_drained_end() can poll them. | |
7003 | */ | |
43eaaaef | 7004 | if (qemu_get_aio_context() != old_context) { |
e037c09c HR |
7005 | aio_context_release(old_context); |
7006 | } | |
7007 | ||
d70d5954 | 7008 | bdrv_drained_end(bs); |
e037c09c | 7009 | |
43eaaaef | 7010 | if (qemu_get_aio_context() != old_context) { |
e037c09c HR |
7011 | aio_context_acquire(old_context); |
7012 | } | |
43eaaaef | 7013 | if (qemu_get_aio_context() != new_context) { |
e037c09c HR |
7014 | aio_context_release(new_context); |
7015 | } | |
85d126f3 | 7016 | } |
d616b224 | 7017 | |
5d231849 KW |
7018 | static bool bdrv_parent_can_set_aio_context(BdrvChild *c, AioContext *ctx, |
7019 | GSList **ignore, Error **errp) | |
7020 | { | |
7021 | if (g_slist_find(*ignore, c)) { | |
7022 | return true; | |
7023 | } | |
7024 | *ignore = g_slist_prepend(*ignore, c); | |
7025 | ||
bd86fb99 HR |
7026 | /* |
7027 | * A BdrvChildClass that doesn't handle AioContext changes cannot | |
7028 | * tolerate any AioContext changes | |
7029 | */ | |
7030 | if (!c->klass->can_set_aio_ctx) { | |
5d231849 KW |
7031 | char *user = bdrv_child_user_desc(c); |
7032 | error_setg(errp, "Changing iothreads is not supported by %s", user); | |
7033 | g_free(user); | |
7034 | return false; | |
7035 | } | |
bd86fb99 | 7036 | if (!c->klass->can_set_aio_ctx(c, ctx, ignore, errp)) { |
5d231849 KW |
7037 | assert(!errp || *errp); |
7038 | return false; | |
7039 | } | |
7040 | return true; | |
7041 | } | |
7042 | ||
7043 | bool bdrv_child_can_set_aio_context(BdrvChild *c, AioContext *ctx, | |
7044 | GSList **ignore, Error **errp) | |
7045 | { | |
7046 | if (g_slist_find(*ignore, c)) { | |
7047 | return true; | |
7048 | } | |
7049 | *ignore = g_slist_prepend(*ignore, c); | |
7050 | return bdrv_can_set_aio_context(c->bs, ctx, ignore, errp); | |
7051 | } | |
7052 | ||
7053 | /* @ignore will accumulate all visited BdrvChild object. The caller is | |
7054 | * responsible for freeing the list afterwards. */ | |
7055 | bool bdrv_can_set_aio_context(BlockDriverState *bs, AioContext *ctx, | |
7056 | GSList **ignore, Error **errp) | |
7057 | { | |
7058 | BdrvChild *c; | |
7059 | ||
7060 | if (bdrv_get_aio_context(bs) == ctx) { | |
7061 | return true; | |
7062 | } | |
7063 | ||
7064 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
7065 | if (!bdrv_parent_can_set_aio_context(c, ctx, ignore, errp)) { | |
7066 | return false; | |
7067 | } | |
7068 | } | |
7069 | QLIST_FOREACH(c, &bs->children, next) { | |
7070 | if (!bdrv_child_can_set_aio_context(c, ctx, ignore, errp)) { | |
7071 | return false; | |
7072 | } | |
7073 | } | |
7074 | ||
7075 | return true; | |
7076 | } | |
7077 | ||
7078 | int bdrv_child_try_set_aio_context(BlockDriverState *bs, AioContext *ctx, | |
7079 | BdrvChild *ignore_child, Error **errp) | |
7080 | { | |
7081 | GSList *ignore; | |
7082 | bool ret; | |
7083 | ||
7084 | ignore = ignore_child ? g_slist_prepend(NULL, ignore_child) : NULL; | |
7085 | ret = bdrv_can_set_aio_context(bs, ctx, &ignore, errp); | |
7086 | g_slist_free(ignore); | |
7087 | ||
7088 | if (!ret) { | |
7089 | return -EPERM; | |
7090 | } | |
7091 | ||
53a7d041 KW |
7092 | ignore = ignore_child ? g_slist_prepend(NULL, ignore_child) : NULL; |
7093 | bdrv_set_aio_context_ignore(bs, ctx, &ignore); | |
7094 | g_slist_free(ignore); | |
7095 | ||
5d231849 KW |
7096 | return 0; |
7097 | } | |
7098 | ||
7099 | int bdrv_try_set_aio_context(BlockDriverState *bs, AioContext *ctx, | |
7100 | Error **errp) | |
7101 | { | |
7102 | return bdrv_child_try_set_aio_context(bs, ctx, NULL, errp); | |
7103 | } | |
7104 | ||
33384421 HR |
7105 | void bdrv_add_aio_context_notifier(BlockDriverState *bs, |
7106 | void (*attached_aio_context)(AioContext *new_context, void *opaque), | |
7107 | void (*detach_aio_context)(void *opaque), void *opaque) | |
7108 | { | |
7109 | BdrvAioNotifier *ban = g_new(BdrvAioNotifier, 1); | |
7110 | *ban = (BdrvAioNotifier){ | |
7111 | .attached_aio_context = attached_aio_context, | |
7112 | .detach_aio_context = detach_aio_context, | |
7113 | .opaque = opaque | |
7114 | }; | |
7115 | ||
7116 | QLIST_INSERT_HEAD(&bs->aio_notifiers, ban, list); | |
7117 | } | |
7118 | ||
7119 | void bdrv_remove_aio_context_notifier(BlockDriverState *bs, | |
7120 | void (*attached_aio_context)(AioContext *, | |
7121 | void *), | |
7122 | void (*detach_aio_context)(void *), | |
7123 | void *opaque) | |
7124 | { | |
7125 | BdrvAioNotifier *ban, *ban_next; | |
7126 | ||
7127 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { | |
7128 | if (ban->attached_aio_context == attached_aio_context && | |
7129 | ban->detach_aio_context == detach_aio_context && | |
e8a095da SH |
7130 | ban->opaque == opaque && |
7131 | ban->deleted == false) | |
33384421 | 7132 | { |
e8a095da SH |
7133 | if (bs->walking_aio_notifiers) { |
7134 | ban->deleted = true; | |
7135 | } else { | |
7136 | bdrv_do_remove_aio_context_notifier(ban); | |
7137 | } | |
33384421 HR |
7138 | return; |
7139 | } | |
7140 | } | |
7141 | ||
7142 | abort(); | |
7143 | } | |
7144 | ||
77485434 | 7145 | int bdrv_amend_options(BlockDriverState *bs, QemuOpts *opts, |
d1402b50 | 7146 | BlockDriverAmendStatusCB *status_cb, void *cb_opaque, |
a3579bfa | 7147 | bool force, |
d1402b50 | 7148 | Error **errp) |
6f176b48 | 7149 | { |
d470ad42 | 7150 | if (!bs->drv) { |
d1402b50 | 7151 | error_setg(errp, "Node is ejected"); |
d470ad42 HR |
7152 | return -ENOMEDIUM; |
7153 | } | |
c282e1fd | 7154 | if (!bs->drv->bdrv_amend_options) { |
d1402b50 HR |
7155 | error_setg(errp, "Block driver '%s' does not support option amendment", |
7156 | bs->drv->format_name); | |
6f176b48 HR |
7157 | return -ENOTSUP; |
7158 | } | |
a3579bfa ML |
7159 | return bs->drv->bdrv_amend_options(bs, opts, status_cb, |
7160 | cb_opaque, force, errp); | |
6f176b48 | 7161 | } |
f6186f49 | 7162 | |
5d69b5ab HR |
7163 | /* |
7164 | * This function checks whether the given @to_replace is allowed to be | |
7165 | * replaced by a node that always shows the same data as @bs. This is | |
7166 | * used for example to verify whether the mirror job can replace | |
7167 | * @to_replace by the target mirrored from @bs. | |
7168 | * To be replaceable, @bs and @to_replace may either be guaranteed to | |
7169 | * always show the same data (because they are only connected through | |
7170 | * filters), or some driver may allow replacing one of its children | |
7171 | * because it can guarantee that this child's data is not visible at | |
7172 | * all (for example, for dissenting quorum children that have no other | |
7173 | * parents). | |
7174 | */ | |
7175 | bool bdrv_recurse_can_replace(BlockDriverState *bs, | |
7176 | BlockDriverState *to_replace) | |
7177 | { | |
93393e69 HR |
7178 | BlockDriverState *filtered; |
7179 | ||
5d69b5ab HR |
7180 | if (!bs || !bs->drv) { |
7181 | return false; | |
7182 | } | |
7183 | ||
7184 | if (bs == to_replace) { | |
7185 | return true; | |
7186 | } | |
7187 | ||
7188 | /* See what the driver can do */ | |
7189 | if (bs->drv->bdrv_recurse_can_replace) { | |
7190 | return bs->drv->bdrv_recurse_can_replace(bs, to_replace); | |
7191 | } | |
7192 | ||
7193 | /* For filters without an own implementation, we can recurse on our own */ | |
93393e69 HR |
7194 | filtered = bdrv_filter_bs(bs); |
7195 | if (filtered) { | |
7196 | return bdrv_recurse_can_replace(filtered, to_replace); | |
5d69b5ab HR |
7197 | } |
7198 | ||
7199 | /* Safe default */ | |
7200 | return false; | |
7201 | } | |
7202 | ||
810803a8 HR |
7203 | /* |
7204 | * Check whether the given @node_name can be replaced by a node that | |
7205 | * has the same data as @parent_bs. If so, return @node_name's BDS; | |
7206 | * NULL otherwise. | |
7207 | * | |
7208 | * @node_name must be a (recursive) *child of @parent_bs (or this | |
7209 | * function will return NULL). | |
7210 | * | |
7211 | * The result (whether the node can be replaced or not) is only valid | |
7212 | * for as long as no graph or permission changes occur. | |
7213 | */ | |
e12f3784 WC |
7214 | BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs, |
7215 | const char *node_name, Error **errp) | |
09158f00 BC |
7216 | { |
7217 | BlockDriverState *to_replace_bs = bdrv_find_node(node_name); | |
5a7e7a0b SH |
7218 | AioContext *aio_context; |
7219 | ||
09158f00 | 7220 | if (!to_replace_bs) { |
785ec4b1 | 7221 | error_setg(errp, "Failed to find node with node-name='%s'", node_name); |
09158f00 BC |
7222 | return NULL; |
7223 | } | |
7224 | ||
5a7e7a0b SH |
7225 | aio_context = bdrv_get_aio_context(to_replace_bs); |
7226 | aio_context_acquire(aio_context); | |
7227 | ||
09158f00 | 7228 | if (bdrv_op_is_blocked(to_replace_bs, BLOCK_OP_TYPE_REPLACE, errp)) { |
5a7e7a0b SH |
7229 | to_replace_bs = NULL; |
7230 | goto out; | |
09158f00 BC |
7231 | } |
7232 | ||
7233 | /* We don't want arbitrary node of the BDS chain to be replaced only the top | |
7234 | * most non filter in order to prevent data corruption. | |
7235 | * Another benefit is that this tests exclude backing files which are | |
7236 | * blocked by the backing blockers. | |
7237 | */ | |
810803a8 HR |
7238 | if (!bdrv_recurse_can_replace(parent_bs, to_replace_bs)) { |
7239 | error_setg(errp, "Cannot replace '%s' by a node mirrored from '%s', " | |
7240 | "because it cannot be guaranteed that doing so would not " | |
7241 | "lead to an abrupt change of visible data", | |
7242 | node_name, parent_bs->node_name); | |
5a7e7a0b SH |
7243 | to_replace_bs = NULL; |
7244 | goto out; | |
09158f00 BC |
7245 | } |
7246 | ||
5a7e7a0b SH |
7247 | out: |
7248 | aio_context_release(aio_context); | |
09158f00 BC |
7249 | return to_replace_bs; |
7250 | } | |
448ad91d | 7251 | |
97e2f021 HR |
7252 | /** |
7253 | * Iterates through the list of runtime option keys that are said to | |
7254 | * be "strong" for a BDS. An option is called "strong" if it changes | |
7255 | * a BDS's data. For example, the null block driver's "size" and | |
7256 | * "read-zeroes" options are strong, but its "latency-ns" option is | |
7257 | * not. | |
7258 | * | |
7259 | * If a key returned by this function ends with a dot, all options | |
7260 | * starting with that prefix are strong. | |
7261 | */ | |
7262 | static const char *const *strong_options(BlockDriverState *bs, | |
7263 | const char *const *curopt) | |
7264 | { | |
7265 | static const char *const global_options[] = { | |
7266 | "driver", "filename", NULL | |
7267 | }; | |
7268 | ||
7269 | if (!curopt) { | |
7270 | return &global_options[0]; | |
7271 | } | |
7272 | ||
7273 | curopt++; | |
7274 | if (curopt == &global_options[ARRAY_SIZE(global_options) - 1] && bs->drv) { | |
7275 | curopt = bs->drv->strong_runtime_opts; | |
7276 | } | |
7277 | ||
7278 | return (curopt && *curopt) ? curopt : NULL; | |
7279 | } | |
7280 | ||
7281 | /** | |
7282 | * Copies all strong runtime options from bs->options to the given | |
7283 | * QDict. The set of strong option keys is determined by invoking | |
7284 | * strong_options(). | |
7285 | * | |
7286 | * Returns true iff any strong option was present in bs->options (and | |
7287 | * thus copied to the target QDict) with the exception of "filename" | |
7288 | * and "driver". The caller is expected to use this value to decide | |
7289 | * whether the existence of strong options prevents the generation of | |
7290 | * a plain filename. | |
7291 | */ | |
7292 | static bool append_strong_runtime_options(QDict *d, BlockDriverState *bs) | |
7293 | { | |
7294 | bool found_any = false; | |
7295 | const char *const *option_name = NULL; | |
7296 | ||
7297 | if (!bs->drv) { | |
7298 | return false; | |
7299 | } | |
7300 | ||
7301 | while ((option_name = strong_options(bs, option_name))) { | |
7302 | bool option_given = false; | |
7303 | ||
7304 | assert(strlen(*option_name) > 0); | |
7305 | if ((*option_name)[strlen(*option_name) - 1] != '.') { | |
7306 | QObject *entry = qdict_get(bs->options, *option_name); | |
7307 | if (!entry) { | |
7308 | continue; | |
7309 | } | |
7310 | ||
7311 | qdict_put_obj(d, *option_name, qobject_ref(entry)); | |
7312 | option_given = true; | |
7313 | } else { | |
7314 | const QDictEntry *entry; | |
7315 | for (entry = qdict_first(bs->options); entry; | |
7316 | entry = qdict_next(bs->options, entry)) | |
7317 | { | |
7318 | if (strstart(qdict_entry_key(entry), *option_name, NULL)) { | |
7319 | qdict_put_obj(d, qdict_entry_key(entry), | |
7320 | qobject_ref(qdict_entry_value(entry))); | |
7321 | option_given = true; | |
7322 | } | |
7323 | } | |
7324 | } | |
7325 | ||
7326 | /* While "driver" and "filename" need to be included in a JSON filename, | |
7327 | * their existence does not prohibit generation of a plain filename. */ | |
7328 | if (!found_any && option_given && | |
7329 | strcmp(*option_name, "driver") && strcmp(*option_name, "filename")) | |
7330 | { | |
7331 | found_any = true; | |
7332 | } | |
7333 | } | |
7334 | ||
62a01a27 HR |
7335 | if (!qdict_haskey(d, "driver")) { |
7336 | /* Drivers created with bdrv_new_open_driver() may not have a | |
7337 | * @driver option. Add it here. */ | |
7338 | qdict_put_str(d, "driver", bs->drv->format_name); | |
7339 | } | |
7340 | ||
97e2f021 HR |
7341 | return found_any; |
7342 | } | |
7343 | ||
90993623 HR |
7344 | /* Note: This function may return false positives; it may return true |
7345 | * even if opening the backing file specified by bs's image header | |
7346 | * would result in exactly bs->backing. */ | |
0b877d09 | 7347 | bool bdrv_backing_overridden(BlockDriverState *bs) |
90993623 HR |
7348 | { |
7349 | if (bs->backing) { | |
7350 | return strcmp(bs->auto_backing_file, | |
7351 | bs->backing->bs->filename); | |
7352 | } else { | |
7353 | /* No backing BDS, so if the image header reports any backing | |
7354 | * file, it must have been suppressed */ | |
7355 | return bs->auto_backing_file[0] != '\0'; | |
7356 | } | |
7357 | } | |
7358 | ||
91af7014 HR |
7359 | /* Updates the following BDS fields: |
7360 | * - exact_filename: A filename which may be used for opening a block device | |
7361 | * which (mostly) equals the given BDS (even without any | |
7362 | * other options; so reading and writing must return the same | |
7363 | * results, but caching etc. may be different) | |
7364 | * - full_open_options: Options which, when given when opening a block device | |
7365 | * (without a filename), result in a BDS (mostly) | |
7366 | * equalling the given one | |
7367 | * - filename: If exact_filename is set, it is copied here. Otherwise, | |
7368 | * full_open_options is converted to a JSON object, prefixed with | |
7369 | * "json:" (for use through the JSON pseudo protocol) and put here. | |
7370 | */ | |
7371 | void bdrv_refresh_filename(BlockDriverState *bs) | |
7372 | { | |
7373 | BlockDriver *drv = bs->drv; | |
e24518e3 | 7374 | BdrvChild *child; |
52f72d6f | 7375 | BlockDriverState *primary_child_bs; |
91af7014 | 7376 | QDict *opts; |
90993623 | 7377 | bool backing_overridden; |
998b3a1e HR |
7378 | bool generate_json_filename; /* Whether our default implementation should |
7379 | fill exact_filename (false) or not (true) */ | |
91af7014 HR |
7380 | |
7381 | if (!drv) { | |
7382 | return; | |
7383 | } | |
7384 | ||
e24518e3 HR |
7385 | /* This BDS's file name may depend on any of its children's file names, so |
7386 | * refresh those first */ | |
7387 | QLIST_FOREACH(child, &bs->children, next) { | |
7388 | bdrv_refresh_filename(child->bs); | |
91af7014 HR |
7389 | } |
7390 | ||
bb808d5f HR |
7391 | if (bs->implicit) { |
7392 | /* For implicit nodes, just copy everything from the single child */ | |
7393 | child = QLIST_FIRST(&bs->children); | |
7394 | assert(QLIST_NEXT(child, next) == NULL); | |
7395 | ||
7396 | pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), | |
7397 | child->bs->exact_filename); | |
7398 | pstrcpy(bs->filename, sizeof(bs->filename), child->bs->filename); | |
7399 | ||
cb895614 | 7400 | qobject_unref(bs->full_open_options); |
bb808d5f HR |
7401 | bs->full_open_options = qobject_ref(child->bs->full_open_options); |
7402 | ||
7403 | return; | |
7404 | } | |
7405 | ||
90993623 HR |
7406 | backing_overridden = bdrv_backing_overridden(bs); |
7407 | ||
7408 | if (bs->open_flags & BDRV_O_NO_IO) { | |
7409 | /* Without I/O, the backing file does not change anything. | |
7410 | * Therefore, in such a case (primarily qemu-img), we can | |
7411 | * pretend the backing file has not been overridden even if | |
7412 | * it technically has been. */ | |
7413 | backing_overridden = false; | |
7414 | } | |
7415 | ||
97e2f021 HR |
7416 | /* Gather the options QDict */ |
7417 | opts = qdict_new(); | |
998b3a1e HR |
7418 | generate_json_filename = append_strong_runtime_options(opts, bs); |
7419 | generate_json_filename |= backing_overridden; | |
97e2f021 HR |
7420 | |
7421 | if (drv->bdrv_gather_child_options) { | |
7422 | /* Some block drivers may not want to present all of their children's | |
7423 | * options, or name them differently from BdrvChild.name */ | |
7424 | drv->bdrv_gather_child_options(bs, opts, backing_overridden); | |
7425 | } else { | |
7426 | QLIST_FOREACH(child, &bs->children, next) { | |
25191e5f | 7427 | if (child == bs->backing && !backing_overridden) { |
97e2f021 HR |
7428 | /* We can skip the backing BDS if it has not been overridden */ |
7429 | continue; | |
7430 | } | |
7431 | ||
7432 | qdict_put(opts, child->name, | |
7433 | qobject_ref(child->bs->full_open_options)); | |
7434 | } | |
7435 | ||
7436 | if (backing_overridden && !bs->backing) { | |
7437 | /* Force no backing file */ | |
7438 | qdict_put_null(opts, "backing"); | |
7439 | } | |
7440 | } | |
7441 | ||
7442 | qobject_unref(bs->full_open_options); | |
7443 | bs->full_open_options = opts; | |
7444 | ||
52f72d6f HR |
7445 | primary_child_bs = bdrv_primary_bs(bs); |
7446 | ||
998b3a1e HR |
7447 | if (drv->bdrv_refresh_filename) { |
7448 | /* Obsolete information is of no use here, so drop the old file name | |
7449 | * information before refreshing it */ | |
7450 | bs->exact_filename[0] = '\0'; | |
7451 | ||
7452 | drv->bdrv_refresh_filename(bs); | |
52f72d6f HR |
7453 | } else if (primary_child_bs) { |
7454 | /* | |
7455 | * Try to reconstruct valid information from the underlying | |
7456 | * file -- this only works for format nodes (filter nodes | |
7457 | * cannot be probed and as such must be selected by the user | |
7458 | * either through an options dict, or through a special | |
7459 | * filename which the filter driver must construct in its | |
7460 | * .bdrv_refresh_filename() implementation). | |
7461 | */ | |
998b3a1e HR |
7462 | |
7463 | bs->exact_filename[0] = '\0'; | |
7464 | ||
fb695c74 HR |
7465 | /* |
7466 | * We can use the underlying file's filename if: | |
7467 | * - it has a filename, | |
52f72d6f | 7468 | * - the current BDS is not a filter, |
fb695c74 HR |
7469 | * - the file is a protocol BDS, and |
7470 | * - opening that file (as this BDS's format) will automatically create | |
7471 | * the BDS tree we have right now, that is: | |
7472 | * - the user did not significantly change this BDS's behavior with | |
7473 | * some explicit (strong) options | |
7474 | * - no non-file child of this BDS has been overridden by the user | |
7475 | * Both of these conditions are represented by generate_json_filename. | |
7476 | */ | |
52f72d6f HR |
7477 | if (primary_child_bs->exact_filename[0] && |
7478 | primary_child_bs->drv->bdrv_file_open && | |
7479 | !drv->is_filter && !generate_json_filename) | |
fb695c74 | 7480 | { |
52f72d6f | 7481 | strcpy(bs->exact_filename, primary_child_bs->exact_filename); |
998b3a1e HR |
7482 | } |
7483 | } | |
7484 | ||
91af7014 HR |
7485 | if (bs->exact_filename[0]) { |
7486 | pstrcpy(bs->filename, sizeof(bs->filename), bs->exact_filename); | |
97e2f021 | 7487 | } else { |
eab3a467 | 7488 | GString *json = qobject_to_json(QOBJECT(bs->full_open_options)); |
5c86bdf1 | 7489 | if (snprintf(bs->filename, sizeof(bs->filename), "json:%s", |
eab3a467 | 7490 | json->str) >= sizeof(bs->filename)) { |
5c86bdf1 EB |
7491 | /* Give user a hint if we truncated things. */ |
7492 | strcpy(bs->filename + sizeof(bs->filename) - 4, "..."); | |
7493 | } | |
eab3a467 | 7494 | g_string_free(json, true); |
91af7014 HR |
7495 | } |
7496 | } | |
e06018ad | 7497 | |
1e89d0f9 HR |
7498 | char *bdrv_dirname(BlockDriverState *bs, Error **errp) |
7499 | { | |
7500 | BlockDriver *drv = bs->drv; | |
52f72d6f | 7501 | BlockDriverState *child_bs; |
1e89d0f9 HR |
7502 | |
7503 | if (!drv) { | |
7504 | error_setg(errp, "Node '%s' is ejected", bs->node_name); | |
7505 | return NULL; | |
7506 | } | |
7507 | ||
7508 | if (drv->bdrv_dirname) { | |
7509 | return drv->bdrv_dirname(bs, errp); | |
7510 | } | |
7511 | ||
52f72d6f HR |
7512 | child_bs = bdrv_primary_bs(bs); |
7513 | if (child_bs) { | |
7514 | return bdrv_dirname(child_bs, errp); | |
1e89d0f9 HR |
7515 | } |
7516 | ||
7517 | bdrv_refresh_filename(bs); | |
7518 | if (bs->exact_filename[0] != '\0') { | |
7519 | return path_combine(bs->exact_filename, ""); | |
7520 | } | |
7521 | ||
7522 | error_setg(errp, "Cannot generate a base directory for %s nodes", | |
7523 | drv->format_name); | |
7524 | return NULL; | |
7525 | } | |
7526 | ||
e06018ad WC |
7527 | /* |
7528 | * Hot add/remove a BDS's child. So the user can take a child offline when | |
7529 | * it is broken and take a new child online | |
7530 | */ | |
7531 | void bdrv_add_child(BlockDriverState *parent_bs, BlockDriverState *child_bs, | |
7532 | Error **errp) | |
7533 | { | |
7534 | ||
7535 | if (!parent_bs->drv || !parent_bs->drv->bdrv_add_child) { | |
7536 | error_setg(errp, "The node %s does not support adding a child", | |
7537 | bdrv_get_device_or_node_name(parent_bs)); | |
7538 | return; | |
7539 | } | |
7540 | ||
7541 | if (!QLIST_EMPTY(&child_bs->parents)) { | |
7542 | error_setg(errp, "The node %s already has a parent", | |
7543 | child_bs->node_name); | |
7544 | return; | |
7545 | } | |
7546 | ||
7547 | parent_bs->drv->bdrv_add_child(parent_bs, child_bs, errp); | |
7548 | } | |
7549 | ||
7550 | void bdrv_del_child(BlockDriverState *parent_bs, BdrvChild *child, Error **errp) | |
7551 | { | |
7552 | BdrvChild *tmp; | |
7553 | ||
7554 | if (!parent_bs->drv || !parent_bs->drv->bdrv_del_child) { | |
7555 | error_setg(errp, "The node %s does not support removing a child", | |
7556 | bdrv_get_device_or_node_name(parent_bs)); | |
7557 | return; | |
7558 | } | |
7559 | ||
7560 | QLIST_FOREACH(tmp, &parent_bs->children, next) { | |
7561 | if (tmp == child) { | |
7562 | break; | |
7563 | } | |
7564 | } | |
7565 | ||
7566 | if (!tmp) { | |
7567 | error_setg(errp, "The node %s does not have a child named %s", | |
7568 | bdrv_get_device_or_node_name(parent_bs), | |
7569 | bdrv_get_device_or_node_name(child->bs)); | |
7570 | return; | |
7571 | } | |
7572 | ||
7573 | parent_bs->drv->bdrv_del_child(parent_bs, child, errp); | |
7574 | } | |
6f7a3b53 HR |
7575 | |
7576 | int bdrv_make_empty(BdrvChild *c, Error **errp) | |
7577 | { | |
7578 | BlockDriver *drv = c->bs->drv; | |
7579 | int ret; | |
7580 | ||
7581 | assert(c->perm & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED)); | |
7582 | ||
7583 | if (!drv->bdrv_make_empty) { | |
7584 | error_setg(errp, "%s does not support emptying nodes", | |
7585 | drv->format_name); | |
7586 | return -ENOTSUP; | |
7587 | } | |
7588 | ||
7589 | ret = drv->bdrv_make_empty(c->bs); | |
7590 | if (ret < 0) { | |
7591 | error_setg_errno(errp, -ret, "Failed to empty %s", | |
7592 | c->bs->filename); | |
7593 | return ret; | |
7594 | } | |
7595 | ||
7596 | return 0; | |
7597 | } | |
9a6fc887 HR |
7598 | |
7599 | /* | |
7600 | * Return the child that @bs acts as an overlay for, and from which data may be | |
7601 | * copied in COW or COR operations. Usually this is the backing file. | |
7602 | */ | |
7603 | BdrvChild *bdrv_cow_child(BlockDriverState *bs) | |
7604 | { | |
7605 | if (!bs || !bs->drv) { | |
7606 | return NULL; | |
7607 | } | |
7608 | ||
7609 | if (bs->drv->is_filter) { | |
7610 | return NULL; | |
7611 | } | |
7612 | ||
7613 | if (!bs->backing) { | |
7614 | return NULL; | |
7615 | } | |
7616 | ||
7617 | assert(bs->backing->role & BDRV_CHILD_COW); | |
7618 | return bs->backing; | |
7619 | } | |
7620 | ||
7621 | /* | |
7622 | * If @bs acts as a filter for exactly one of its children, return | |
7623 | * that child. | |
7624 | */ | |
7625 | BdrvChild *bdrv_filter_child(BlockDriverState *bs) | |
7626 | { | |
7627 | BdrvChild *c; | |
7628 | ||
7629 | if (!bs || !bs->drv) { | |
7630 | return NULL; | |
7631 | } | |
7632 | ||
7633 | if (!bs->drv->is_filter) { | |
7634 | return NULL; | |
7635 | } | |
7636 | ||
7637 | /* Only one of @backing or @file may be used */ | |
7638 | assert(!(bs->backing && bs->file)); | |
7639 | ||
7640 | c = bs->backing ?: bs->file; | |
7641 | if (!c) { | |
7642 | return NULL; | |
7643 | } | |
7644 | ||
7645 | assert(c->role & BDRV_CHILD_FILTERED); | |
7646 | return c; | |
7647 | } | |
7648 | ||
7649 | /* | |
7650 | * Return either the result of bdrv_cow_child() or bdrv_filter_child(), | |
7651 | * whichever is non-NULL. | |
7652 | * | |
7653 | * Return NULL if both are NULL. | |
7654 | */ | |
7655 | BdrvChild *bdrv_filter_or_cow_child(BlockDriverState *bs) | |
7656 | { | |
7657 | BdrvChild *cow_child = bdrv_cow_child(bs); | |
7658 | BdrvChild *filter_child = bdrv_filter_child(bs); | |
7659 | ||
7660 | /* Filter nodes cannot have COW backing files */ | |
7661 | assert(!(cow_child && filter_child)); | |
7662 | ||
7663 | return cow_child ?: filter_child; | |
7664 | } | |
7665 | ||
7666 | /* | |
7667 | * Return the primary child of this node: For filters, that is the | |
7668 | * filtered child. For other nodes, that is usually the child storing | |
7669 | * metadata. | |
7670 | * (A generally more helpful description is that this is (usually) the | |
7671 | * child that has the same filename as @bs.) | |
7672 | * | |
7673 | * Drivers do not necessarily have a primary child; for example quorum | |
7674 | * does not. | |
7675 | */ | |
7676 | BdrvChild *bdrv_primary_child(BlockDriverState *bs) | |
7677 | { | |
7678 | BdrvChild *c, *found = NULL; | |
7679 | ||
7680 | QLIST_FOREACH(c, &bs->children, next) { | |
7681 | if (c->role & BDRV_CHILD_PRIMARY) { | |
7682 | assert(!found); | |
7683 | found = c; | |
7684 | } | |
7685 | } | |
7686 | ||
7687 | return found; | |
7688 | } | |
d38d7eb8 HR |
7689 | |
7690 | static BlockDriverState *bdrv_do_skip_filters(BlockDriverState *bs, | |
7691 | bool stop_on_explicit_filter) | |
7692 | { | |
7693 | BdrvChild *c; | |
7694 | ||
7695 | if (!bs) { | |
7696 | return NULL; | |
7697 | } | |
7698 | ||
7699 | while (!(stop_on_explicit_filter && !bs->implicit)) { | |
7700 | c = bdrv_filter_child(bs); | |
7701 | if (!c) { | |
7702 | /* | |
7703 | * A filter that is embedded in a working block graph must | |
7704 | * have a child. Assert this here so this function does | |
7705 | * not return a filter node that is not expected by the | |
7706 | * caller. | |
7707 | */ | |
7708 | assert(!bs->drv || !bs->drv->is_filter); | |
7709 | break; | |
7710 | } | |
7711 | bs = c->bs; | |
7712 | } | |
7713 | /* | |
7714 | * Note that this treats nodes with bs->drv == NULL as not being | |
7715 | * filters (bs->drv == NULL should be replaced by something else | |
7716 | * anyway). | |
7717 | * The advantage of this behavior is that this function will thus | |
7718 | * always return a non-NULL value (given a non-NULL @bs). | |
7719 | */ | |
7720 | ||
7721 | return bs; | |
7722 | } | |
7723 | ||
7724 | /* | |
7725 | * Return the first BDS that has not been added implicitly or that | |
7726 | * does not have a filtered child down the chain starting from @bs | |
7727 | * (including @bs itself). | |
7728 | */ | |
7729 | BlockDriverState *bdrv_skip_implicit_filters(BlockDriverState *bs) | |
7730 | { | |
7731 | return bdrv_do_skip_filters(bs, true); | |
7732 | } | |
7733 | ||
7734 | /* | |
7735 | * Return the first BDS that does not have a filtered child down the | |
7736 | * chain starting from @bs (including @bs itself). | |
7737 | */ | |
7738 | BlockDriverState *bdrv_skip_filters(BlockDriverState *bs) | |
7739 | { | |
7740 | return bdrv_do_skip_filters(bs, false); | |
7741 | } | |
7742 | ||
7743 | /* | |
7744 | * For a backing chain, return the first non-filter backing image of | |
7745 | * the first non-filter image. | |
7746 | */ | |
7747 | BlockDriverState *bdrv_backing_chain_next(BlockDriverState *bs) | |
7748 | { | |
7749 | return bdrv_skip_filters(bdrv_cow_bs(bdrv_skip_filters(bs))); | |
7750 | } | |
0bc329fb HR |
7751 | |
7752 | /** | |
7753 | * Check whether [offset, offset + bytes) overlaps with the cached | |
7754 | * block-status data region. | |
7755 | * | |
7756 | * If so, and @pnum is not NULL, set *pnum to `bsc.data_end - offset`, | |
7757 | * which is what bdrv_bsc_is_data()'s interface needs. | |
7758 | * Otherwise, *pnum is not touched. | |
7759 | */ | |
7760 | static bool bdrv_bsc_range_overlaps_locked(BlockDriverState *bs, | |
7761 | int64_t offset, int64_t bytes, | |
7762 | int64_t *pnum) | |
7763 | { | |
7764 | BdrvBlockStatusCache *bsc = qatomic_rcu_read(&bs->block_status_cache); | |
7765 | bool overlaps; | |
7766 | ||
7767 | overlaps = | |
7768 | qatomic_read(&bsc->valid) && | |
7769 | ranges_overlap(offset, bytes, bsc->data_start, | |
7770 | bsc->data_end - bsc->data_start); | |
7771 | ||
7772 | if (overlaps && pnum) { | |
7773 | *pnum = bsc->data_end - offset; | |
7774 | } | |
7775 | ||
7776 | return overlaps; | |
7777 | } | |
7778 | ||
7779 | /** | |
7780 | * See block_int.h for this function's documentation. | |
7781 | */ | |
7782 | bool bdrv_bsc_is_data(BlockDriverState *bs, int64_t offset, int64_t *pnum) | |
7783 | { | |
7784 | RCU_READ_LOCK_GUARD(); | |
7785 | ||
7786 | return bdrv_bsc_range_overlaps_locked(bs, offset, 1, pnum); | |
7787 | } | |
7788 | ||
7789 | /** | |
7790 | * See block_int.h for this function's documentation. | |
7791 | */ | |
7792 | void bdrv_bsc_invalidate_range(BlockDriverState *bs, | |
7793 | int64_t offset, int64_t bytes) | |
7794 | { | |
7795 | RCU_READ_LOCK_GUARD(); | |
7796 | ||
7797 | if (bdrv_bsc_range_overlaps_locked(bs, offset, bytes, NULL)) { | |
7798 | qatomic_set(&bs->block_status_cache->valid, false); | |
7799 | } | |
7800 | } | |
7801 | ||
7802 | /** | |
7803 | * See block_int.h for this function's documentation. | |
7804 | */ | |
7805 | void bdrv_bsc_fill(BlockDriverState *bs, int64_t offset, int64_t bytes) | |
7806 | { | |
7807 | BdrvBlockStatusCache *new_bsc = g_new(BdrvBlockStatusCache, 1); | |
7808 | BdrvBlockStatusCache *old_bsc; | |
7809 | ||
7810 | *new_bsc = (BdrvBlockStatusCache) { | |
7811 | .valid = true, | |
7812 | .data_start = offset, | |
7813 | .data_end = offset + bytes, | |
7814 | }; | |
7815 | ||
7816 | QEMU_LOCK_GUARD(&bs->bsc_modify_lock); | |
7817 | ||
7818 | old_bsc = qatomic_rcu_read(&bs->block_status_cache); | |
7819 | qatomic_rcu_set(&bs->block_status_cache, new_bsc); | |
7820 | if (old_bsc) { | |
7821 | g_free_rcu(old_bsc, rcu); | |
7822 | } | |
7823 | } |