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