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