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