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