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