]>
Commit | Line | Data |
---|---|---|
fc01f7e7 FB |
1 | /* |
2 | * QEMU System Emulator block driver | |
5fafdf24 | 3 | * |
fc01f7e7 | 4 | * Copyright (c) 2003 Fabrice Bellard |
5fafdf24 | 5 | * |
fc01f7e7 FB |
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
7 | * of this software and associated documentation files (the "Software"), to deal | |
8 | * in the Software without restriction, including without limitation the rights | |
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
10 | * copies of the Software, and to permit persons to whom the Software is | |
11 | * furnished to do so, subject to the following conditions: | |
12 | * | |
13 | * The above copyright notice and this permission notice shall be included in | |
14 | * all copies or substantial portions of the Software. | |
15 | * | |
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
19 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
22 | * THE SOFTWARE. | |
23 | */ | |
e688df6b | 24 | |
d38ea87a | 25 | #include "qemu/osdep.h" |
0ab8ed18 | 26 | #include "block/trace.h" |
737e150e PB |
27 | #include "block/block_int.h" |
28 | #include "block/blockjob.h" | |
cd7fca95 | 29 | #include "block/nbd.h" |
609f45ea | 30 | #include "block/qdict.h" |
d49b6836 | 31 | #include "qemu/error-report.h" |
88d88798 | 32 | #include "module_block.h" |
db725815 | 33 | #include "qemu/main-loop.h" |
1de7afc9 | 34 | #include "qemu/module.h" |
e688df6b | 35 | #include "qapi/error.h" |
452fcdbc | 36 | #include "qapi/qmp/qdict.h" |
7b1b5d19 | 37 | #include "qapi/qmp/qjson.h" |
e59a0cf1 | 38 | #include "qapi/qmp/qnull.h" |
fc81fa1e | 39 | #include "qapi/qmp/qstring.h" |
e1d74bc6 KW |
40 | #include "qapi/qobject-output-visitor.h" |
41 | #include "qapi/qapi-visit-block-core.h" | |
bfb197e0 | 42 | #include "sysemu/block-backend.h" |
9c17d615 | 43 | #include "sysemu/sysemu.h" |
1de7afc9 | 44 | #include "qemu/notify.h" |
922a01a0 | 45 | #include "qemu/option.h" |
10817bf0 | 46 | #include "qemu/coroutine.h" |
c13163fb | 47 | #include "block/qapi.h" |
1de7afc9 | 48 | #include "qemu/timer.h" |
f348b6d1 VB |
49 | #include "qemu/cutils.h" |
50 | #include "qemu/id.h" | |
fc01f7e7 | 51 | |
71e72a19 | 52 | #ifdef CONFIG_BSD |
7674e7bf | 53 | #include <sys/ioctl.h> |
72cf2d4f | 54 | #include <sys/queue.h> |
c5e97233 | 55 | #ifndef __DragonFly__ |
7674e7bf FB |
56 | #include <sys/disk.h> |
57 | #endif | |
c5e97233 | 58 | #endif |
7674e7bf | 59 | |
49dc768d AL |
60 | #ifdef _WIN32 |
61 | #include <windows.h> | |
62 | #endif | |
63 | ||
1c9805a3 SH |
64 | #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */ |
65 | ||
dc364f4c BC |
66 | static QTAILQ_HEAD(, BlockDriverState) graph_bdrv_states = |
67 | QTAILQ_HEAD_INITIALIZER(graph_bdrv_states); | |
68 | ||
2c1d04e0 HR |
69 | static QTAILQ_HEAD(, BlockDriverState) all_bdrv_states = |
70 | QTAILQ_HEAD_INITIALIZER(all_bdrv_states); | |
71 | ||
8a22f02a SH |
72 | static QLIST_HEAD(, BlockDriver) bdrv_drivers = |
73 | QLIST_HEAD_INITIALIZER(bdrv_drivers); | |
ea2384d3 | 74 | |
5b363937 HR |
75 | static BlockDriverState *bdrv_open_inherit(const char *filename, |
76 | const char *reference, | |
77 | QDict *options, int flags, | |
78 | BlockDriverState *parent, | |
bd86fb99 | 79 | const BdrvChildClass *child_class, |
272c02ea | 80 | BdrvChildRole child_role, |
5b363937 | 81 | Error **errp); |
f3930ed0 | 82 | |
eb852011 MA |
83 | /* If non-zero, use only whitelisted block drivers */ |
84 | static int use_bdrv_whitelist; | |
85 | ||
9e0b22f4 SH |
86 | #ifdef _WIN32 |
87 | static int is_windows_drive_prefix(const char *filename) | |
88 | { | |
89 | return (((filename[0] >= 'a' && filename[0] <= 'z') || | |
90 | (filename[0] >= 'A' && filename[0] <= 'Z')) && | |
91 | filename[1] == ':'); | |
92 | } | |
93 | ||
94 | int is_windows_drive(const char *filename) | |
95 | { | |
96 | if (is_windows_drive_prefix(filename) && | |
97 | filename[2] == '\0') | |
98 | return 1; | |
99 | if (strstart(filename, "\\\\.\\", NULL) || | |
100 | strstart(filename, "//./", NULL)) | |
101 | return 1; | |
102 | return 0; | |
103 | } | |
104 | #endif | |
105 | ||
339064d5 KW |
106 | size_t bdrv_opt_mem_align(BlockDriverState *bs) |
107 | { | |
108 | if (!bs || !bs->drv) { | |
459b4e66 | 109 | /* page size or 4k (hdd sector size) should be on the safe side */ |
038adc2f | 110 | return MAX(4096, qemu_real_host_page_size); |
339064d5 KW |
111 | } |
112 | ||
113 | return bs->bl.opt_mem_alignment; | |
114 | } | |
115 | ||
4196d2f0 DL |
116 | size_t bdrv_min_mem_align(BlockDriverState *bs) |
117 | { | |
118 | if (!bs || !bs->drv) { | |
459b4e66 | 119 | /* page size or 4k (hdd sector size) should be on the safe side */ |
038adc2f | 120 | return MAX(4096, qemu_real_host_page_size); |
4196d2f0 DL |
121 | } |
122 | ||
123 | return bs->bl.min_mem_alignment; | |
124 | } | |
125 | ||
9e0b22f4 | 126 | /* check if the path starts with "<protocol>:" */ |
5c98415b | 127 | int path_has_protocol(const char *path) |
9e0b22f4 | 128 | { |
947995c0 PB |
129 | const char *p; |
130 | ||
9e0b22f4 SH |
131 | #ifdef _WIN32 |
132 | if (is_windows_drive(path) || | |
133 | is_windows_drive_prefix(path)) { | |
134 | return 0; | |
135 | } | |
947995c0 PB |
136 | p = path + strcspn(path, ":/\\"); |
137 | #else | |
138 | p = path + strcspn(path, ":/"); | |
9e0b22f4 SH |
139 | #endif |
140 | ||
947995c0 | 141 | return *p == ':'; |
9e0b22f4 SH |
142 | } |
143 | ||
83f64091 | 144 | int path_is_absolute(const char *path) |
3b0d4f61 | 145 | { |
21664424 FB |
146 | #ifdef _WIN32 |
147 | /* specific case for names like: "\\.\d:" */ | |
f53f4da9 | 148 | if (is_windows_drive(path) || is_windows_drive_prefix(path)) { |
21664424 | 149 | return 1; |
f53f4da9 PB |
150 | } |
151 | return (*path == '/' || *path == '\\'); | |
3b9f94e1 | 152 | #else |
f53f4da9 | 153 | return (*path == '/'); |
3b9f94e1 | 154 | #endif |
3b0d4f61 FB |
155 | } |
156 | ||
009b03aa | 157 | /* if filename is absolute, just return its duplicate. Otherwise, build a |
83f64091 FB |
158 | path to it by considering it is relative to base_path. URL are |
159 | supported. */ | |
009b03aa | 160 | char *path_combine(const char *base_path, const char *filename) |
3b0d4f61 | 161 | { |
009b03aa | 162 | const char *protocol_stripped = NULL; |
83f64091 | 163 | const char *p, *p1; |
009b03aa | 164 | char *result; |
83f64091 FB |
165 | int len; |
166 | ||
83f64091 | 167 | if (path_is_absolute(filename)) { |
009b03aa HR |
168 | return g_strdup(filename); |
169 | } | |
0d54a6fe | 170 | |
009b03aa HR |
171 | if (path_has_protocol(base_path)) { |
172 | protocol_stripped = strchr(base_path, ':'); | |
173 | if (protocol_stripped) { | |
174 | protocol_stripped++; | |
0d54a6fe | 175 | } |
009b03aa HR |
176 | } |
177 | p = protocol_stripped ?: base_path; | |
0d54a6fe | 178 | |
009b03aa | 179 | p1 = strrchr(base_path, '/'); |
3b9f94e1 | 180 | #ifdef _WIN32 |
009b03aa HR |
181 | { |
182 | const char *p2; | |
183 | p2 = strrchr(base_path, '\\'); | |
184 | if (!p1 || p2 > p1) { | |
185 | p1 = p2; | |
3b9f94e1 | 186 | } |
009b03aa | 187 | } |
3b9f94e1 | 188 | #endif |
009b03aa HR |
189 | if (p1) { |
190 | p1++; | |
191 | } else { | |
192 | p1 = base_path; | |
193 | } | |
194 | if (p1 > p) { | |
195 | p = p1; | |
3b0d4f61 | 196 | } |
009b03aa HR |
197 | len = p - base_path; |
198 | ||
199 | result = g_malloc(len + strlen(filename) + 1); | |
200 | memcpy(result, base_path, len); | |
201 | strcpy(result + len, filename); | |
202 | ||
203 | return result; | |
204 | } | |
205 | ||
03c320d8 HR |
206 | /* |
207 | * Helper function for bdrv_parse_filename() implementations to remove optional | |
208 | * protocol prefixes (especially "file:") from a filename and for putting the | |
209 | * stripped filename into the options QDict if there is such a prefix. | |
210 | */ | |
211 | void bdrv_parse_filename_strip_prefix(const char *filename, const char *prefix, | |
212 | QDict *options) | |
213 | { | |
214 | if (strstart(filename, prefix, &filename)) { | |
215 | /* Stripping the explicit protocol prefix may result in a protocol | |
216 | * prefix being (wrongly) detected (if the filename contains a colon) */ | |
217 | if (path_has_protocol(filename)) { | |
218 | QString *fat_filename; | |
219 | ||
220 | /* This means there is some colon before the first slash; therefore, | |
221 | * this cannot be an absolute path */ | |
222 | assert(!path_is_absolute(filename)); | |
223 | ||
224 | /* And we can thus fix the protocol detection issue by prefixing it | |
225 | * by "./" */ | |
226 | fat_filename = qstring_from_str("./"); | |
227 | qstring_append(fat_filename, filename); | |
228 | ||
229 | assert(!path_has_protocol(qstring_get_str(fat_filename))); | |
230 | ||
231 | qdict_put(options, "filename", fat_filename); | |
232 | } else { | |
233 | /* If no protocol prefix was detected, we can use the shortened | |
234 | * filename as-is */ | |
235 | qdict_put_str(options, "filename", filename); | |
236 | } | |
237 | } | |
238 | } | |
239 | ||
240 | ||
9c5e6594 KW |
241 | /* Returns whether the image file is opened as read-only. Note that this can |
242 | * return false and writing to the image file is still not possible because the | |
243 | * image is inactivated. */ | |
93ed524e JC |
244 | bool bdrv_is_read_only(BlockDriverState *bs) |
245 | { | |
246 | return bs->read_only; | |
247 | } | |
248 | ||
54a32bfe KW |
249 | int bdrv_can_set_read_only(BlockDriverState *bs, bool read_only, |
250 | bool ignore_allow_rdw, Error **errp) | |
fe5241bf | 251 | { |
e2b8247a JC |
252 | /* Do not set read_only if copy_on_read is enabled */ |
253 | if (bs->copy_on_read && read_only) { | |
254 | error_setg(errp, "Can't set node '%s' to r/o with copy-on-read enabled", | |
255 | bdrv_get_device_or_node_name(bs)); | |
256 | return -EINVAL; | |
257 | } | |
258 | ||
d6fcdf06 | 259 | /* Do not clear read_only if it is prohibited */ |
54a32bfe KW |
260 | if (!read_only && !(bs->open_flags & BDRV_O_ALLOW_RDWR) && |
261 | !ignore_allow_rdw) | |
262 | { | |
d6fcdf06 JC |
263 | error_setg(errp, "Node '%s' is read only", |
264 | bdrv_get_device_or_node_name(bs)); | |
265 | return -EPERM; | |
266 | } | |
267 | ||
45803a03 JC |
268 | return 0; |
269 | } | |
270 | ||
eaa2410f KW |
271 | /* |
272 | * Called by a driver that can only provide a read-only image. | |
273 | * | |
274 | * Returns 0 if the node is already read-only or it could switch the node to | |
275 | * read-only because BDRV_O_AUTO_RDONLY is set. | |
276 | * | |
277 | * Returns -EACCES if the node is read-write and BDRV_O_AUTO_RDONLY is not set | |
278 | * or bdrv_can_set_read_only() forbids making the node read-only. If @errmsg | |
279 | * is not NULL, it is used as the error message for the Error object. | |
280 | */ | |
281 | int bdrv_apply_auto_read_only(BlockDriverState *bs, const char *errmsg, | |
282 | Error **errp) | |
45803a03 JC |
283 | { |
284 | int ret = 0; | |
285 | ||
eaa2410f KW |
286 | if (!(bs->open_flags & BDRV_O_RDWR)) { |
287 | return 0; | |
288 | } | |
289 | if (!(bs->open_flags & BDRV_O_AUTO_RDONLY)) { | |
290 | goto fail; | |
45803a03 JC |
291 | } |
292 | ||
eaa2410f KW |
293 | ret = bdrv_can_set_read_only(bs, true, false, NULL); |
294 | if (ret < 0) { | |
295 | goto fail; | |
eeae6a59 KW |
296 | } |
297 | ||
eaa2410f KW |
298 | bs->read_only = true; |
299 | bs->open_flags &= ~BDRV_O_RDWR; | |
300 | ||
e2b8247a | 301 | return 0; |
eaa2410f KW |
302 | |
303 | fail: | |
304 | error_setg(errp, "%s", errmsg ?: "Image is read-only"); | |
305 | return -EACCES; | |
fe5241bf JC |
306 | } |
307 | ||
645ae7d8 HR |
308 | /* |
309 | * If @backing is empty, this function returns NULL without setting | |
310 | * @errp. In all other cases, NULL will only be returned with @errp | |
311 | * set. | |
312 | * | |
313 | * Therefore, a return value of NULL without @errp set means that | |
314 | * there is no backing file; if @errp is set, there is one but its | |
315 | * absolute filename cannot be generated. | |
316 | */ | |
317 | char *bdrv_get_full_backing_filename_from_filename(const char *backed, | |
318 | const char *backing, | |
319 | Error **errp) | |
dc5a1371 | 320 | { |
645ae7d8 HR |
321 | if (backing[0] == '\0') { |
322 | return NULL; | |
323 | } else if (path_has_protocol(backing) || path_is_absolute(backing)) { | |
324 | return g_strdup(backing); | |
9f07429e HR |
325 | } else if (backed[0] == '\0' || strstart(backed, "json:", NULL)) { |
326 | error_setg(errp, "Cannot use relative backing file names for '%s'", | |
327 | backed); | |
645ae7d8 | 328 | return NULL; |
dc5a1371 | 329 | } else { |
645ae7d8 | 330 | return path_combine(backed, backing); |
dc5a1371 PB |
331 | } |
332 | } | |
333 | ||
9f4793d8 HR |
334 | /* |
335 | * If @filename is empty or NULL, this function returns NULL without | |
336 | * setting @errp. In all other cases, NULL will only be returned with | |
337 | * @errp set. | |
338 | */ | |
339 | static char *bdrv_make_absolute_filename(BlockDriverState *relative_to, | |
340 | const char *filename, Error **errp) | |
0a82855a | 341 | { |
8df68616 | 342 | char *dir, *full_name; |
9f4793d8 | 343 | |
8df68616 HR |
344 | if (!filename || filename[0] == '\0') { |
345 | return NULL; | |
346 | } else if (path_has_protocol(filename) || path_is_absolute(filename)) { | |
347 | return g_strdup(filename); | |
348 | } | |
9f07429e | 349 | |
8df68616 HR |
350 | dir = bdrv_dirname(relative_to, errp); |
351 | if (!dir) { | |
352 | return NULL; | |
353 | } | |
f30c66ba | 354 | |
8df68616 HR |
355 | full_name = g_strconcat(dir, filename, NULL); |
356 | g_free(dir); | |
357 | return full_name; | |
9f4793d8 HR |
358 | } |
359 | ||
360 | char *bdrv_get_full_backing_filename(BlockDriverState *bs, Error **errp) | |
361 | { | |
362 | return bdrv_make_absolute_filename(bs, bs->backing_file, errp); | |
0a82855a HR |
363 | } |
364 | ||
0eb7217e SH |
365 | void bdrv_register(BlockDriver *bdrv) |
366 | { | |
a15f08dc | 367 | assert(bdrv->format_name); |
8a22f02a | 368 | QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list); |
ea2384d3 | 369 | } |
b338082b | 370 | |
e4e9986b MA |
371 | BlockDriverState *bdrv_new(void) |
372 | { | |
373 | BlockDriverState *bs; | |
374 | int i; | |
375 | ||
5839e53b | 376 | bs = g_new0(BlockDriverState, 1); |
e4654d2d | 377 | QLIST_INIT(&bs->dirty_bitmaps); |
fbe40ff7 FZ |
378 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { |
379 | QLIST_INIT(&bs->op_blockers[i]); | |
380 | } | |
d616b224 | 381 | notifier_with_return_list_init(&bs->before_write_notifiers); |
3783fa3d | 382 | qemu_co_mutex_init(&bs->reqs_lock); |
2119882c | 383 | qemu_mutex_init(&bs->dirty_bitmap_mutex); |
9fcb0251 | 384 | bs->refcnt = 1; |
dcd04228 | 385 | bs->aio_context = qemu_get_aio_context(); |
d7d512f6 | 386 | |
3ff2f67a EY |
387 | qemu_co_queue_init(&bs->flush_queue); |
388 | ||
0f12264e KW |
389 | for (i = 0; i < bdrv_drain_all_count; i++) { |
390 | bdrv_drained_begin(bs); | |
391 | } | |
392 | ||
2c1d04e0 HR |
393 | QTAILQ_INSERT_TAIL(&all_bdrv_states, bs, bs_list); |
394 | ||
b338082b FB |
395 | return bs; |
396 | } | |
397 | ||
88d88798 | 398 | static BlockDriver *bdrv_do_find_format(const char *format_name) |
ea2384d3 FB |
399 | { |
400 | BlockDriver *drv1; | |
88d88798 | 401 | |
8a22f02a SH |
402 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { |
403 | if (!strcmp(drv1->format_name, format_name)) { | |
ea2384d3 | 404 | return drv1; |
8a22f02a | 405 | } |
ea2384d3 | 406 | } |
88d88798 | 407 | |
ea2384d3 FB |
408 | return NULL; |
409 | } | |
410 | ||
88d88798 MM |
411 | BlockDriver *bdrv_find_format(const char *format_name) |
412 | { | |
413 | BlockDriver *drv1; | |
414 | int i; | |
415 | ||
416 | drv1 = bdrv_do_find_format(format_name); | |
417 | if (drv1) { | |
418 | return drv1; | |
419 | } | |
420 | ||
421 | /* The driver isn't registered, maybe we need to load a module */ | |
422 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); ++i) { | |
423 | if (!strcmp(block_driver_modules[i].format_name, format_name)) { | |
424 | block_module_load_one(block_driver_modules[i].library_name); | |
425 | break; | |
426 | } | |
427 | } | |
428 | ||
429 | return bdrv_do_find_format(format_name); | |
430 | } | |
431 | ||
9ac404c5 | 432 | static int bdrv_format_is_whitelisted(const char *format_name, bool read_only) |
eb852011 | 433 | { |
b64ec4e4 FZ |
434 | static const char *whitelist_rw[] = { |
435 | CONFIG_BDRV_RW_WHITELIST | |
436 | }; | |
437 | static const char *whitelist_ro[] = { | |
438 | CONFIG_BDRV_RO_WHITELIST | |
eb852011 MA |
439 | }; |
440 | const char **p; | |
441 | ||
b64ec4e4 | 442 | if (!whitelist_rw[0] && !whitelist_ro[0]) { |
eb852011 | 443 | return 1; /* no whitelist, anything goes */ |
b64ec4e4 | 444 | } |
eb852011 | 445 | |
b64ec4e4 | 446 | for (p = whitelist_rw; *p; p++) { |
9ac404c5 | 447 | if (!strcmp(format_name, *p)) { |
eb852011 MA |
448 | return 1; |
449 | } | |
450 | } | |
b64ec4e4 FZ |
451 | if (read_only) { |
452 | for (p = whitelist_ro; *p; p++) { | |
9ac404c5 | 453 | if (!strcmp(format_name, *p)) { |
b64ec4e4 FZ |
454 | return 1; |
455 | } | |
456 | } | |
457 | } | |
eb852011 MA |
458 | return 0; |
459 | } | |
460 | ||
9ac404c5 AS |
461 | int bdrv_is_whitelisted(BlockDriver *drv, bool read_only) |
462 | { | |
463 | return bdrv_format_is_whitelisted(drv->format_name, read_only); | |
464 | } | |
465 | ||
e6ff69bf DB |
466 | bool bdrv_uses_whitelist(void) |
467 | { | |
468 | return use_bdrv_whitelist; | |
469 | } | |
470 | ||
5b7e1542 ZYW |
471 | typedef struct CreateCo { |
472 | BlockDriver *drv; | |
473 | char *filename; | |
83d0521a | 474 | QemuOpts *opts; |
5b7e1542 | 475 | int ret; |
cc84d90f | 476 | Error *err; |
5b7e1542 ZYW |
477 | } CreateCo; |
478 | ||
479 | static void coroutine_fn bdrv_create_co_entry(void *opaque) | |
480 | { | |
cc84d90f HR |
481 | Error *local_err = NULL; |
482 | int ret; | |
483 | ||
5b7e1542 ZYW |
484 | CreateCo *cco = opaque; |
485 | assert(cco->drv); | |
486 | ||
b92902df ML |
487 | ret = cco->drv->bdrv_co_create_opts(cco->drv, |
488 | cco->filename, cco->opts, &local_err); | |
621ff94d | 489 | error_propagate(&cco->err, local_err); |
cc84d90f | 490 | cco->ret = ret; |
5b7e1542 ZYW |
491 | } |
492 | ||
0e7e1989 | 493 | int bdrv_create(BlockDriver *drv, const char* filename, |
83d0521a | 494 | QemuOpts *opts, Error **errp) |
ea2384d3 | 495 | { |
5b7e1542 ZYW |
496 | int ret; |
497 | ||
498 | Coroutine *co; | |
499 | CreateCo cco = { | |
500 | .drv = drv, | |
501 | .filename = g_strdup(filename), | |
83d0521a | 502 | .opts = opts, |
5b7e1542 | 503 | .ret = NOT_DONE, |
cc84d90f | 504 | .err = NULL, |
5b7e1542 ZYW |
505 | }; |
506 | ||
efc75e2a | 507 | if (!drv->bdrv_co_create_opts) { |
cc84d90f | 508 | error_setg(errp, "Driver '%s' does not support image creation", drv->format_name); |
80168bff LC |
509 | ret = -ENOTSUP; |
510 | goto out; | |
5b7e1542 ZYW |
511 | } |
512 | ||
513 | if (qemu_in_coroutine()) { | |
514 | /* Fast-path if already in coroutine context */ | |
515 | bdrv_create_co_entry(&cco); | |
516 | } else { | |
0b8b8753 PB |
517 | co = qemu_coroutine_create(bdrv_create_co_entry, &cco); |
518 | qemu_coroutine_enter(co); | |
5b7e1542 | 519 | while (cco.ret == NOT_DONE) { |
b47ec2c4 | 520 | aio_poll(qemu_get_aio_context(), true); |
5b7e1542 ZYW |
521 | } |
522 | } | |
523 | ||
524 | ret = cco.ret; | |
cc84d90f | 525 | if (ret < 0) { |
84d18f06 | 526 | if (cco.err) { |
cc84d90f HR |
527 | error_propagate(errp, cco.err); |
528 | } else { | |
529 | error_setg_errno(errp, -ret, "Could not create image"); | |
530 | } | |
531 | } | |
0e7e1989 | 532 | |
80168bff LC |
533 | out: |
534 | g_free(cco.filename); | |
5b7e1542 | 535 | return ret; |
ea2384d3 FB |
536 | } |
537 | ||
fd17146c HR |
538 | /** |
539 | * Helper function for bdrv_create_file_fallback(): Resize @blk to at | |
540 | * least the given @minimum_size. | |
541 | * | |
542 | * On success, return @blk's actual length. | |
543 | * Otherwise, return -errno. | |
544 | */ | |
545 | static int64_t create_file_fallback_truncate(BlockBackend *blk, | |
546 | int64_t minimum_size, Error **errp) | |
84a12e66 | 547 | { |
cc84d90f | 548 | Error *local_err = NULL; |
fd17146c | 549 | int64_t size; |
cc84d90f | 550 | int ret; |
84a12e66 | 551 | |
8c6242b6 KW |
552 | ret = blk_truncate(blk, minimum_size, false, PREALLOC_MODE_OFF, 0, |
553 | &local_err); | |
fd17146c HR |
554 | if (ret < 0 && ret != -ENOTSUP) { |
555 | error_propagate(errp, local_err); | |
556 | return ret; | |
557 | } | |
558 | ||
559 | size = blk_getlength(blk); | |
560 | if (size < 0) { | |
561 | error_free(local_err); | |
562 | error_setg_errno(errp, -size, | |
563 | "Failed to inquire the new image file's length"); | |
564 | return size; | |
565 | } | |
566 | ||
567 | if (size < minimum_size) { | |
568 | /* Need to grow the image, but we failed to do that */ | |
569 | error_propagate(errp, local_err); | |
570 | return -ENOTSUP; | |
571 | } | |
572 | ||
573 | error_free(local_err); | |
574 | local_err = NULL; | |
575 | ||
576 | return size; | |
577 | } | |
578 | ||
579 | /** | |
580 | * Helper function for bdrv_create_file_fallback(): Zero the first | |
581 | * sector to remove any potentially pre-existing image header. | |
582 | */ | |
583 | static int create_file_fallback_zero_first_sector(BlockBackend *blk, | |
584 | int64_t current_size, | |
585 | Error **errp) | |
586 | { | |
587 | int64_t bytes_to_clear; | |
588 | int ret; | |
589 | ||
590 | bytes_to_clear = MIN(current_size, BDRV_SECTOR_SIZE); | |
591 | if (bytes_to_clear) { | |
592 | ret = blk_pwrite_zeroes(blk, 0, bytes_to_clear, BDRV_REQ_MAY_UNMAP); | |
593 | if (ret < 0) { | |
594 | error_setg_errno(errp, -ret, | |
595 | "Failed to clear the new image's first sector"); | |
596 | return ret; | |
597 | } | |
598 | } | |
599 | ||
600 | return 0; | |
601 | } | |
602 | ||
5a5e7f8c ML |
603 | /** |
604 | * Simple implementation of bdrv_co_create_opts for protocol drivers | |
605 | * which only support creation via opening a file | |
606 | * (usually existing raw storage device) | |
607 | */ | |
608 | int coroutine_fn bdrv_co_create_opts_simple(BlockDriver *drv, | |
609 | const char *filename, | |
610 | QemuOpts *opts, | |
611 | Error **errp) | |
fd17146c HR |
612 | { |
613 | BlockBackend *blk; | |
eeea1faa | 614 | QDict *options; |
fd17146c HR |
615 | int64_t size = 0; |
616 | char *buf = NULL; | |
617 | PreallocMode prealloc; | |
618 | Error *local_err = NULL; | |
619 | int ret; | |
620 | ||
621 | size = qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0); | |
622 | buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC); | |
623 | prealloc = qapi_enum_parse(&PreallocMode_lookup, buf, | |
624 | PREALLOC_MODE_OFF, &local_err); | |
625 | g_free(buf); | |
626 | if (local_err) { | |
627 | error_propagate(errp, local_err); | |
628 | return -EINVAL; | |
629 | } | |
630 | ||
631 | if (prealloc != PREALLOC_MODE_OFF) { | |
632 | error_setg(errp, "Unsupported preallocation mode '%s'", | |
633 | PreallocMode_str(prealloc)); | |
634 | return -ENOTSUP; | |
635 | } | |
636 | ||
eeea1faa | 637 | options = qdict_new(); |
fd17146c HR |
638 | qdict_put_str(options, "driver", drv->format_name); |
639 | ||
640 | blk = blk_new_open(filename, NULL, options, | |
641 | BDRV_O_RDWR | BDRV_O_RESIZE, errp); | |
642 | if (!blk) { | |
643 | error_prepend(errp, "Protocol driver '%s' does not support image " | |
644 | "creation, and opening the image failed: ", | |
645 | drv->format_name); | |
646 | return -EINVAL; | |
647 | } | |
648 | ||
649 | size = create_file_fallback_truncate(blk, size, errp); | |
650 | if (size < 0) { | |
651 | ret = size; | |
652 | goto out; | |
653 | } | |
654 | ||
655 | ret = create_file_fallback_zero_first_sector(blk, size, errp); | |
656 | if (ret < 0) { | |
657 | goto out; | |
658 | } | |
659 | ||
660 | ret = 0; | |
661 | out: | |
662 | blk_unref(blk); | |
663 | return ret; | |
664 | } | |
665 | ||
666 | int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp) | |
667 | { | |
668 | BlockDriver *drv; | |
669 | ||
b65a5e12 | 670 | drv = bdrv_find_protocol(filename, true, errp); |
84a12e66 | 671 | if (drv == NULL) { |
16905d71 | 672 | return -ENOENT; |
84a12e66 CH |
673 | } |
674 | ||
5a5e7f8c | 675 | return bdrv_create(drv, filename, opts, errp); |
84a12e66 CH |
676 | } |
677 | ||
e1d7f8bb DHB |
678 | int coroutine_fn bdrv_co_delete_file(BlockDriverState *bs, Error **errp) |
679 | { | |
680 | Error *local_err = NULL; | |
681 | int ret; | |
682 | ||
683 | assert(bs != NULL); | |
684 | ||
685 | if (!bs->drv) { | |
686 | error_setg(errp, "Block node '%s' is not opened", bs->filename); | |
687 | return -ENOMEDIUM; | |
688 | } | |
689 | ||
690 | if (!bs->drv->bdrv_co_delete_file) { | |
691 | error_setg(errp, "Driver '%s' does not support image deletion", | |
692 | bs->drv->format_name); | |
693 | return -ENOTSUP; | |
694 | } | |
695 | ||
696 | ret = bs->drv->bdrv_co_delete_file(bs, &local_err); | |
697 | if (ret < 0) { | |
698 | error_propagate(errp, local_err); | |
699 | } | |
700 | ||
701 | return ret; | |
702 | } | |
703 | ||
892b7de8 ET |
704 | /** |
705 | * Try to get @bs's logical and physical block size. | |
706 | * On success, store them in @bsz struct and return 0. | |
707 | * On failure return -errno. | |
708 | * @bs must not be empty. | |
709 | */ | |
710 | int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz) | |
711 | { | |
712 | BlockDriver *drv = bs->drv; | |
713 | ||
714 | if (drv && drv->bdrv_probe_blocksizes) { | |
715 | return drv->bdrv_probe_blocksizes(bs, bsz); | |
5a612c00 MP |
716 | } else if (drv && drv->is_filter && bs->file) { |
717 | return bdrv_probe_blocksizes(bs->file->bs, bsz); | |
892b7de8 ET |
718 | } |
719 | ||
720 | return -ENOTSUP; | |
721 | } | |
722 | ||
723 | /** | |
724 | * Try to get @bs's geometry (cyls, heads, sectors). | |
725 | * On success, store them in @geo struct and return 0. | |
726 | * On failure return -errno. | |
727 | * @bs must not be empty. | |
728 | */ | |
729 | int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo) | |
730 | { | |
731 | BlockDriver *drv = bs->drv; | |
732 | ||
733 | if (drv && drv->bdrv_probe_geometry) { | |
734 | return drv->bdrv_probe_geometry(bs, geo); | |
5a612c00 MP |
735 | } else if (drv && drv->is_filter && bs->file) { |
736 | return bdrv_probe_geometry(bs->file->bs, geo); | |
892b7de8 ET |
737 | } |
738 | ||
739 | return -ENOTSUP; | |
740 | } | |
741 | ||
eba25057 JM |
742 | /* |
743 | * Create a uniquely-named empty temporary file. | |
744 | * Return 0 upon success, otherwise a negative errno value. | |
745 | */ | |
746 | int get_tmp_filename(char *filename, int size) | |
d5249393 | 747 | { |
eba25057 | 748 | #ifdef _WIN32 |
3b9f94e1 | 749 | char temp_dir[MAX_PATH]; |
eba25057 JM |
750 | /* GetTempFileName requires that its output buffer (4th param) |
751 | have length MAX_PATH or greater. */ | |
752 | assert(size >= MAX_PATH); | |
753 | return (GetTempPath(MAX_PATH, temp_dir) | |
754 | && GetTempFileName(temp_dir, "qem", 0, filename) | |
755 | ? 0 : -GetLastError()); | |
d5249393 | 756 | #else |
67b915a5 | 757 | int fd; |
7ccfb2eb | 758 | const char *tmpdir; |
0badc1ee | 759 | tmpdir = getenv("TMPDIR"); |
69bef793 AS |
760 | if (!tmpdir) { |
761 | tmpdir = "/var/tmp"; | |
762 | } | |
eba25057 JM |
763 | if (snprintf(filename, size, "%s/vl.XXXXXX", tmpdir) >= size) { |
764 | return -EOVERFLOW; | |
765 | } | |
ea2384d3 | 766 | fd = mkstemp(filename); |
fe235a06 DH |
767 | if (fd < 0) { |
768 | return -errno; | |
769 | } | |
770 | if (close(fd) != 0) { | |
771 | unlink(filename); | |
eba25057 JM |
772 | return -errno; |
773 | } | |
774 | return 0; | |
d5249393 | 775 | #endif |
eba25057 | 776 | } |
fc01f7e7 | 777 | |
84a12e66 CH |
778 | /* |
779 | * Detect host devices. By convention, /dev/cdrom[N] is always | |
780 | * recognized as a host CDROM. | |
781 | */ | |
782 | static BlockDriver *find_hdev_driver(const char *filename) | |
783 | { | |
784 | int score_max = 0, score; | |
785 | BlockDriver *drv = NULL, *d; | |
786 | ||
787 | QLIST_FOREACH(d, &bdrv_drivers, list) { | |
788 | if (d->bdrv_probe_device) { | |
789 | score = d->bdrv_probe_device(filename); | |
790 | if (score > score_max) { | |
791 | score_max = score; | |
792 | drv = d; | |
793 | } | |
794 | } | |
795 | } | |
796 | ||
797 | return drv; | |
798 | } | |
799 | ||
88d88798 MM |
800 | static BlockDriver *bdrv_do_find_protocol(const char *protocol) |
801 | { | |
802 | BlockDriver *drv1; | |
803 | ||
804 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { | |
805 | if (drv1->protocol_name && !strcmp(drv1->protocol_name, protocol)) { | |
806 | return drv1; | |
807 | } | |
808 | } | |
809 | ||
810 | return NULL; | |
811 | } | |
812 | ||
98289620 | 813 | BlockDriver *bdrv_find_protocol(const char *filename, |
b65a5e12 HR |
814 | bool allow_protocol_prefix, |
815 | Error **errp) | |
83f64091 FB |
816 | { |
817 | BlockDriver *drv1; | |
818 | char protocol[128]; | |
1cec71e3 | 819 | int len; |
83f64091 | 820 | const char *p; |
88d88798 | 821 | int i; |
19cb3738 | 822 | |
66f82cee KW |
823 | /* TODO Drivers without bdrv_file_open must be specified explicitly */ |
824 | ||
39508e7a CH |
825 | /* |
826 | * XXX(hch): we really should not let host device detection | |
827 | * override an explicit protocol specification, but moving this | |
828 | * later breaks access to device names with colons in them. | |
829 | * Thanks to the brain-dead persistent naming schemes on udev- | |
830 | * based Linux systems those actually are quite common. | |
831 | */ | |
832 | drv1 = find_hdev_driver(filename); | |
833 | if (drv1) { | |
834 | return drv1; | |
835 | } | |
836 | ||
98289620 | 837 | if (!path_has_protocol(filename) || !allow_protocol_prefix) { |
ef810437 | 838 | return &bdrv_file; |
84a12e66 | 839 | } |
98289620 | 840 | |
9e0b22f4 SH |
841 | p = strchr(filename, ':'); |
842 | assert(p != NULL); | |
1cec71e3 AL |
843 | len = p - filename; |
844 | if (len > sizeof(protocol) - 1) | |
845 | len = sizeof(protocol) - 1; | |
846 | memcpy(protocol, filename, len); | |
847 | protocol[len] = '\0'; | |
88d88798 MM |
848 | |
849 | drv1 = bdrv_do_find_protocol(protocol); | |
850 | if (drv1) { | |
851 | return drv1; | |
852 | } | |
853 | ||
854 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); ++i) { | |
855 | if (block_driver_modules[i].protocol_name && | |
856 | !strcmp(block_driver_modules[i].protocol_name, protocol)) { | |
857 | block_module_load_one(block_driver_modules[i].library_name); | |
858 | break; | |
8a22f02a | 859 | } |
83f64091 | 860 | } |
b65a5e12 | 861 | |
88d88798 MM |
862 | drv1 = bdrv_do_find_protocol(protocol); |
863 | if (!drv1) { | |
864 | error_setg(errp, "Unknown protocol '%s'", protocol); | |
865 | } | |
866 | return drv1; | |
83f64091 FB |
867 | } |
868 | ||
c6684249 MA |
869 | /* |
870 | * Guess image format by probing its contents. | |
871 | * This is not a good idea when your image is raw (CVE-2008-2004), but | |
872 | * we do it anyway for backward compatibility. | |
873 | * | |
874 | * @buf contains the image's first @buf_size bytes. | |
7cddd372 KW |
875 | * @buf_size is the buffer size in bytes (generally BLOCK_PROBE_BUF_SIZE, |
876 | * but can be smaller if the image file is smaller) | |
c6684249 MA |
877 | * @filename is its filename. |
878 | * | |
879 | * For all block drivers, call the bdrv_probe() method to get its | |
880 | * probing score. | |
881 | * Return the first block driver with the highest probing score. | |
882 | */ | |
38f3ef57 KW |
883 | BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size, |
884 | const char *filename) | |
c6684249 MA |
885 | { |
886 | int score_max = 0, score; | |
887 | BlockDriver *drv = NULL, *d; | |
888 | ||
889 | QLIST_FOREACH(d, &bdrv_drivers, list) { | |
890 | if (d->bdrv_probe) { | |
891 | score = d->bdrv_probe(buf, buf_size, filename); | |
892 | if (score > score_max) { | |
893 | score_max = score; | |
894 | drv = d; | |
895 | } | |
896 | } | |
897 | } | |
898 | ||
899 | return drv; | |
900 | } | |
901 | ||
5696c6e3 | 902 | static int find_image_format(BlockBackend *file, const char *filename, |
34b5d2c6 | 903 | BlockDriver **pdrv, Error **errp) |
f3a5d3f8 | 904 | { |
c6684249 | 905 | BlockDriver *drv; |
7cddd372 | 906 | uint8_t buf[BLOCK_PROBE_BUF_SIZE]; |
f500a6d3 | 907 | int ret = 0; |
f8ea0b00 | 908 | |
08a00559 | 909 | /* Return the raw BlockDriver * to scsi-generic devices or empty drives */ |
5696c6e3 | 910 | if (blk_is_sg(file) || !blk_is_inserted(file) || blk_getlength(file) == 0) { |
ef810437 | 911 | *pdrv = &bdrv_raw; |
c98ac35d | 912 | return ret; |
1a396859 | 913 | } |
f8ea0b00 | 914 | |
5696c6e3 | 915 | ret = blk_pread(file, 0, buf, sizeof(buf)); |
83f64091 | 916 | if (ret < 0) { |
34b5d2c6 HR |
917 | error_setg_errno(errp, -ret, "Could not read image for determining its " |
918 | "format"); | |
c98ac35d SW |
919 | *pdrv = NULL; |
920 | return ret; | |
83f64091 FB |
921 | } |
922 | ||
c6684249 | 923 | drv = bdrv_probe_all(buf, ret, filename); |
c98ac35d | 924 | if (!drv) { |
34b5d2c6 HR |
925 | error_setg(errp, "Could not determine image format: No compatible " |
926 | "driver found"); | |
c98ac35d SW |
927 | ret = -ENOENT; |
928 | } | |
929 | *pdrv = drv; | |
930 | return ret; | |
ea2384d3 FB |
931 | } |
932 | ||
51762288 SH |
933 | /** |
934 | * Set the current 'total_sectors' value | |
65a9bb25 | 935 | * Return 0 on success, -errno on error. |
51762288 | 936 | */ |
3d9f2d2a | 937 | int refresh_total_sectors(BlockDriverState *bs, int64_t hint) |
51762288 SH |
938 | { |
939 | BlockDriver *drv = bs->drv; | |
940 | ||
d470ad42 HR |
941 | if (!drv) { |
942 | return -ENOMEDIUM; | |
943 | } | |
944 | ||
396759ad | 945 | /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */ |
b192af8a | 946 | if (bdrv_is_sg(bs)) |
396759ad NB |
947 | return 0; |
948 | ||
51762288 SH |
949 | /* query actual device if possible, otherwise just trust the hint */ |
950 | if (drv->bdrv_getlength) { | |
951 | int64_t length = drv->bdrv_getlength(bs); | |
952 | if (length < 0) { | |
953 | return length; | |
954 | } | |
7e382003 | 955 | hint = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE); |
51762288 SH |
956 | } |
957 | ||
958 | bs->total_sectors = hint; | |
959 | return 0; | |
960 | } | |
961 | ||
cddff5ba KW |
962 | /** |
963 | * Combines a QDict of new block driver @options with any missing options taken | |
964 | * from @old_options, so that leaving out an option defaults to its old value. | |
965 | */ | |
966 | static void bdrv_join_options(BlockDriverState *bs, QDict *options, | |
967 | QDict *old_options) | |
968 | { | |
969 | if (bs->drv && bs->drv->bdrv_join_options) { | |
970 | bs->drv->bdrv_join_options(options, old_options); | |
971 | } else { | |
972 | qdict_join(options, old_options, false); | |
973 | } | |
974 | } | |
975 | ||
543770bd AG |
976 | static BlockdevDetectZeroesOptions bdrv_parse_detect_zeroes(QemuOpts *opts, |
977 | int open_flags, | |
978 | Error **errp) | |
979 | { | |
980 | Error *local_err = NULL; | |
981 | char *value = qemu_opt_get_del(opts, "detect-zeroes"); | |
982 | BlockdevDetectZeroesOptions detect_zeroes = | |
983 | qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup, value, | |
984 | BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF, &local_err); | |
985 | g_free(value); | |
986 | if (local_err) { | |
987 | error_propagate(errp, local_err); | |
988 | return detect_zeroes; | |
989 | } | |
990 | ||
991 | if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP && | |
992 | !(open_flags & BDRV_O_UNMAP)) | |
993 | { | |
994 | error_setg(errp, "setting detect-zeroes to unmap is not allowed " | |
995 | "without setting discard operation to unmap"); | |
996 | } | |
997 | ||
998 | return detect_zeroes; | |
999 | } | |
1000 | ||
f80f2673 AM |
1001 | /** |
1002 | * Set open flags for aio engine | |
1003 | * | |
1004 | * Return 0 on success, -1 if the engine specified is invalid | |
1005 | */ | |
1006 | int bdrv_parse_aio(const char *mode, int *flags) | |
1007 | { | |
1008 | if (!strcmp(mode, "threads")) { | |
1009 | /* do nothing, default */ | |
1010 | } else if (!strcmp(mode, "native")) { | |
1011 | *flags |= BDRV_O_NATIVE_AIO; | |
1012 | #ifdef CONFIG_LINUX_IO_URING | |
1013 | } else if (!strcmp(mode, "io_uring")) { | |
1014 | *flags |= BDRV_O_IO_URING; | |
1015 | #endif | |
1016 | } else { | |
1017 | return -1; | |
1018 | } | |
1019 | ||
1020 | return 0; | |
1021 | } | |
1022 | ||
9e8f1835 PB |
1023 | /** |
1024 | * Set open flags for a given discard mode | |
1025 | * | |
1026 | * Return 0 on success, -1 if the discard mode was invalid. | |
1027 | */ | |
1028 | int bdrv_parse_discard_flags(const char *mode, int *flags) | |
1029 | { | |
1030 | *flags &= ~BDRV_O_UNMAP; | |
1031 | ||
1032 | if (!strcmp(mode, "off") || !strcmp(mode, "ignore")) { | |
1033 | /* do nothing */ | |
1034 | } else if (!strcmp(mode, "on") || !strcmp(mode, "unmap")) { | |
1035 | *flags |= BDRV_O_UNMAP; | |
1036 | } else { | |
1037 | return -1; | |
1038 | } | |
1039 | ||
1040 | return 0; | |
1041 | } | |
1042 | ||
c3993cdc SH |
1043 | /** |
1044 | * Set open flags for a given cache mode | |
1045 | * | |
1046 | * Return 0 on success, -1 if the cache mode was invalid. | |
1047 | */ | |
53e8ae01 | 1048 | int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough) |
c3993cdc SH |
1049 | { |
1050 | *flags &= ~BDRV_O_CACHE_MASK; | |
1051 | ||
1052 | if (!strcmp(mode, "off") || !strcmp(mode, "none")) { | |
53e8ae01 KW |
1053 | *writethrough = false; |
1054 | *flags |= BDRV_O_NOCACHE; | |
92196b2f | 1055 | } else if (!strcmp(mode, "directsync")) { |
53e8ae01 | 1056 | *writethrough = true; |
92196b2f | 1057 | *flags |= BDRV_O_NOCACHE; |
c3993cdc | 1058 | } else if (!strcmp(mode, "writeback")) { |
53e8ae01 | 1059 | *writethrough = false; |
c3993cdc | 1060 | } else if (!strcmp(mode, "unsafe")) { |
53e8ae01 | 1061 | *writethrough = false; |
c3993cdc SH |
1062 | *flags |= BDRV_O_NO_FLUSH; |
1063 | } else if (!strcmp(mode, "writethrough")) { | |
53e8ae01 | 1064 | *writethrough = true; |
c3993cdc SH |
1065 | } else { |
1066 | return -1; | |
1067 | } | |
1068 | ||
1069 | return 0; | |
1070 | } | |
1071 | ||
b5411555 KW |
1072 | static char *bdrv_child_get_parent_desc(BdrvChild *c) |
1073 | { | |
1074 | BlockDriverState *parent = c->opaque; | |
1075 | return g_strdup(bdrv_get_device_or_node_name(parent)); | |
1076 | } | |
1077 | ||
20018e12 KW |
1078 | static void bdrv_child_cb_drained_begin(BdrvChild *child) |
1079 | { | |
1080 | BlockDriverState *bs = child->opaque; | |
6cd5c9d7 | 1081 | bdrv_do_drained_begin_quiesce(bs, NULL, false); |
20018e12 KW |
1082 | } |
1083 | ||
89bd0305 KW |
1084 | static bool bdrv_child_cb_drained_poll(BdrvChild *child) |
1085 | { | |
1086 | BlockDriverState *bs = child->opaque; | |
6cd5c9d7 | 1087 | return bdrv_drain_poll(bs, false, NULL, false); |
89bd0305 KW |
1088 | } |
1089 | ||
e037c09c HR |
1090 | static void bdrv_child_cb_drained_end(BdrvChild *child, |
1091 | int *drained_end_counter) | |
20018e12 KW |
1092 | { |
1093 | BlockDriverState *bs = child->opaque; | |
e037c09c | 1094 | bdrv_drained_end_no_poll(bs, drained_end_counter); |
20018e12 KW |
1095 | } |
1096 | ||
d736f119 KW |
1097 | static void bdrv_child_cb_attach(BdrvChild *child) |
1098 | { | |
1099 | BlockDriverState *bs = child->opaque; | |
1100 | bdrv_apply_subtree_drain(child, bs); | |
1101 | } | |
1102 | ||
1103 | static void bdrv_child_cb_detach(BdrvChild *child) | |
1104 | { | |
1105 | BlockDriverState *bs = child->opaque; | |
1106 | bdrv_unapply_subtree_drain(child, bs); | |
1107 | } | |
1108 | ||
38701b6a KW |
1109 | static int bdrv_child_cb_inactivate(BdrvChild *child) |
1110 | { | |
1111 | BlockDriverState *bs = child->opaque; | |
1112 | assert(bs->open_flags & BDRV_O_INACTIVE); | |
1113 | return 0; | |
1114 | } | |
1115 | ||
5d231849 KW |
1116 | static bool bdrv_child_cb_can_set_aio_ctx(BdrvChild *child, AioContext *ctx, |
1117 | GSList **ignore, Error **errp) | |
1118 | { | |
1119 | BlockDriverState *bs = child->opaque; | |
1120 | return bdrv_can_set_aio_context(bs, ctx, ignore, errp); | |
1121 | } | |
1122 | ||
53a7d041 KW |
1123 | static void bdrv_child_cb_set_aio_ctx(BdrvChild *child, AioContext *ctx, |
1124 | GSList **ignore) | |
1125 | { | |
1126 | BlockDriverState *bs = child->opaque; | |
1127 | return bdrv_set_aio_context_ignore(bs, ctx, ignore); | |
1128 | } | |
1129 | ||
b1e6fc08 | 1130 | /* |
73176bee KW |
1131 | * Returns the options and flags that a temporary snapshot should get, based on |
1132 | * the originally requested flags (the originally requested image will have | |
1133 | * flags like a backing file) | |
b1e6fc08 | 1134 | */ |
73176bee KW |
1135 | static void bdrv_temp_snapshot_options(int *child_flags, QDict *child_options, |
1136 | int parent_flags, QDict *parent_options) | |
b1e6fc08 | 1137 | { |
73176bee KW |
1138 | *child_flags = (parent_flags & ~BDRV_O_SNAPSHOT) | BDRV_O_TEMPORARY; |
1139 | ||
1140 | /* For temporary files, unconditional cache=unsafe is fine */ | |
73176bee KW |
1141 | qdict_set_default_str(child_options, BDRV_OPT_CACHE_DIRECT, "off"); |
1142 | qdict_set_default_str(child_options, BDRV_OPT_CACHE_NO_FLUSH, "on"); | |
41869044 | 1143 | |
3f48686f | 1144 | /* Copy the read-only and discard options from the parent */ |
f87a0e29 | 1145 | qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY); |
3f48686f | 1146 | qdict_copy_default(child_options, parent_options, BDRV_OPT_DISCARD); |
f87a0e29 | 1147 | |
41869044 KW |
1148 | /* aio=native doesn't work for cache.direct=off, so disable it for the |
1149 | * temporary snapshot */ | |
1150 | *child_flags &= ~BDRV_O_NATIVE_AIO; | |
b1e6fc08 KW |
1151 | } |
1152 | ||
0b50cc88 | 1153 | /* |
8e2160e2 KW |
1154 | * Returns the options and flags that bs->file should get if a protocol driver |
1155 | * is expected, based on the given options and flags for the parent BDS | |
0b50cc88 | 1156 | */ |
b054ff73 HR |
1157 | static void bdrv_protocol_options(BdrvChildRole role, bool parent_is_format, |
1158 | int *child_flags, QDict *child_options, | |
1159 | int parent_flags, QDict *parent_options) | |
0b50cc88 | 1160 | { |
8e2160e2 KW |
1161 | int flags = parent_flags; |
1162 | ||
0b50cc88 KW |
1163 | /* Enable protocol handling, disable format probing for bs->file */ |
1164 | flags |= BDRV_O_PROTOCOL; | |
1165 | ||
91a097e7 KW |
1166 | /* If the cache mode isn't explicitly set, inherit direct and no-flush from |
1167 | * the parent. */ | |
1168 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT); | |
1169 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH); | |
5a9347c6 | 1170 | qdict_copy_default(child_options, parent_options, BDRV_OPT_FORCE_SHARE); |
91a097e7 | 1171 | |
f87a0e29 AG |
1172 | /* Inherit the read-only option from the parent if it's not set */ |
1173 | qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY); | |
e35bdc12 | 1174 | qdict_copy_default(child_options, parent_options, BDRV_OPT_AUTO_READ_ONLY); |
f87a0e29 | 1175 | |
0b50cc88 | 1176 | /* Our block drivers take care to send flushes and respect unmap policy, |
91a097e7 KW |
1177 | * so we can default to enable both on lower layers regardless of the |
1178 | * corresponding parent options. */ | |
818584a4 | 1179 | qdict_set_default_str(child_options, BDRV_OPT_DISCARD, "unmap"); |
0b50cc88 | 1180 | |
0b50cc88 | 1181 | /* Clear flags that only apply to the top layer */ |
abb06c5a DB |
1182 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ | |
1183 | BDRV_O_NO_IO); | |
0b50cc88 | 1184 | |
8e2160e2 | 1185 | *child_flags = flags; |
0b50cc88 KW |
1186 | } |
1187 | ||
bd86fb99 | 1188 | const BdrvChildClass child_file = { |
6cd5c9d7 | 1189 | .parent_is_bds = true, |
b5411555 | 1190 | .get_parent_desc = bdrv_child_get_parent_desc, |
b054ff73 | 1191 | .inherit_options = bdrv_protocol_options, |
20018e12 | 1192 | .drained_begin = bdrv_child_cb_drained_begin, |
89bd0305 | 1193 | .drained_poll = bdrv_child_cb_drained_poll, |
20018e12 | 1194 | .drained_end = bdrv_child_cb_drained_end, |
d736f119 KW |
1195 | .attach = bdrv_child_cb_attach, |
1196 | .detach = bdrv_child_cb_detach, | |
38701b6a | 1197 | .inactivate = bdrv_child_cb_inactivate, |
5d231849 | 1198 | .can_set_aio_ctx = bdrv_child_cb_can_set_aio_ctx, |
53a7d041 | 1199 | .set_aio_ctx = bdrv_child_cb_set_aio_ctx, |
f3930ed0 KW |
1200 | }; |
1201 | ||
1202 | /* | |
8e2160e2 KW |
1203 | * Returns the options and flags that bs->file should get if the use of formats |
1204 | * (and not only protocols) is permitted for it, based on the given options and | |
1205 | * flags for the parent BDS | |
f3930ed0 | 1206 | */ |
272c02ea | 1207 | static void bdrv_inherited_fmt_options(BdrvChildRole role, |
3cdc69d3 | 1208 | bool parent_is_format, |
272c02ea | 1209 | int *child_flags, QDict *child_options, |
8e2160e2 | 1210 | int parent_flags, QDict *parent_options) |
f3930ed0 | 1211 | { |
3cdc69d3 HR |
1212 | child_file.inherit_options(role, parent_is_format, |
1213 | child_flags, child_options, | |
8e2160e2 KW |
1214 | parent_flags, parent_options); |
1215 | ||
abb06c5a | 1216 | *child_flags &= ~(BDRV_O_PROTOCOL | BDRV_O_NO_IO); |
f3930ed0 KW |
1217 | } |
1218 | ||
bd86fb99 | 1219 | const BdrvChildClass child_format = { |
6cd5c9d7 | 1220 | .parent_is_bds = true, |
b5411555 | 1221 | .get_parent_desc = bdrv_child_get_parent_desc, |
8e2160e2 | 1222 | .inherit_options = bdrv_inherited_fmt_options, |
20018e12 | 1223 | .drained_begin = bdrv_child_cb_drained_begin, |
89bd0305 | 1224 | .drained_poll = bdrv_child_cb_drained_poll, |
20018e12 | 1225 | .drained_end = bdrv_child_cb_drained_end, |
d736f119 KW |
1226 | .attach = bdrv_child_cb_attach, |
1227 | .detach = bdrv_child_cb_detach, | |
38701b6a | 1228 | .inactivate = bdrv_child_cb_inactivate, |
5d231849 | 1229 | .can_set_aio_ctx = bdrv_child_cb_can_set_aio_ctx, |
53a7d041 | 1230 | .set_aio_ctx = bdrv_child_cb_set_aio_ctx, |
f3930ed0 KW |
1231 | }; |
1232 | ||
db95dbba KW |
1233 | static void bdrv_backing_attach(BdrvChild *c) |
1234 | { | |
1235 | BlockDriverState *parent = c->opaque; | |
1236 | BlockDriverState *backing_hd = c->bs; | |
1237 | ||
1238 | assert(!parent->backing_blocker); | |
1239 | error_setg(&parent->backing_blocker, | |
1240 | "node is used as backing hd of '%s'", | |
1241 | bdrv_get_device_or_node_name(parent)); | |
1242 | ||
f30c66ba HR |
1243 | bdrv_refresh_filename(backing_hd); |
1244 | ||
db95dbba KW |
1245 | parent->open_flags &= ~BDRV_O_NO_BACKING; |
1246 | pstrcpy(parent->backing_file, sizeof(parent->backing_file), | |
1247 | backing_hd->filename); | |
1248 | pstrcpy(parent->backing_format, sizeof(parent->backing_format), | |
1249 | backing_hd->drv ? backing_hd->drv->format_name : ""); | |
1250 | ||
1251 | bdrv_op_block_all(backing_hd, parent->backing_blocker); | |
1252 | /* Otherwise we won't be able to commit or stream */ | |
1253 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_COMMIT_TARGET, | |
1254 | parent->backing_blocker); | |
1255 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_STREAM, | |
1256 | parent->backing_blocker); | |
1257 | /* | |
1258 | * We do backup in 3 ways: | |
1259 | * 1. drive backup | |
1260 | * The target bs is new opened, and the source is top BDS | |
1261 | * 2. blockdev backup | |
1262 | * Both the source and the target are top BDSes. | |
1263 | * 3. internal backup(used for block replication) | |
1264 | * Both the source and the target are backing file | |
1265 | * | |
1266 | * In case 1 and 2, neither the source nor the target is the backing file. | |
1267 | * In case 3, we will block the top BDS, so there is only one block job | |
1268 | * for the top BDS and its backing chain. | |
1269 | */ | |
1270 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_SOURCE, | |
1271 | parent->backing_blocker); | |
1272 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_TARGET, | |
1273 | parent->backing_blocker); | |
d736f119 KW |
1274 | |
1275 | bdrv_child_cb_attach(c); | |
db95dbba KW |
1276 | } |
1277 | ||
1278 | static void bdrv_backing_detach(BdrvChild *c) | |
1279 | { | |
1280 | BlockDriverState *parent = c->opaque; | |
1281 | ||
1282 | assert(parent->backing_blocker); | |
1283 | bdrv_op_unblock_all(c->bs, parent->backing_blocker); | |
1284 | error_free(parent->backing_blocker); | |
1285 | parent->backing_blocker = NULL; | |
d736f119 KW |
1286 | |
1287 | bdrv_child_cb_detach(c); | |
db95dbba KW |
1288 | } |
1289 | ||
317fc44e | 1290 | /* |
8e2160e2 KW |
1291 | * Returns the options and flags that bs->backing should get, based on the |
1292 | * given options and flags for the parent BDS | |
317fc44e | 1293 | */ |
3cdc69d3 | 1294 | static void bdrv_backing_options(BdrvChildRole role, bool parent_is_format, |
272c02ea | 1295 | int *child_flags, QDict *child_options, |
8e2160e2 | 1296 | int parent_flags, QDict *parent_options) |
317fc44e | 1297 | { |
8e2160e2 KW |
1298 | int flags = parent_flags; |
1299 | ||
b8816a43 KW |
1300 | /* The cache mode is inherited unmodified for backing files; except WCE, |
1301 | * which is only applied on the top level (BlockBackend) */ | |
91a097e7 KW |
1302 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT); |
1303 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH); | |
5a9347c6 | 1304 | qdict_copy_default(child_options, parent_options, BDRV_OPT_FORCE_SHARE); |
91a097e7 | 1305 | |
317fc44e | 1306 | /* backing files always opened read-only */ |
f87a0e29 | 1307 | qdict_set_default_str(child_options, BDRV_OPT_READ_ONLY, "on"); |
e35bdc12 | 1308 | qdict_set_default_str(child_options, BDRV_OPT_AUTO_READ_ONLY, "off"); |
f87a0e29 | 1309 | flags &= ~BDRV_O_COPY_ON_READ; |
317fc44e KW |
1310 | |
1311 | /* snapshot=on is handled on the top layer */ | |
8bfea15d | 1312 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_TEMPORARY); |
317fc44e | 1313 | |
8e2160e2 | 1314 | *child_flags = flags; |
317fc44e KW |
1315 | } |
1316 | ||
6858eba0 KW |
1317 | static int bdrv_backing_update_filename(BdrvChild *c, BlockDriverState *base, |
1318 | const char *filename, Error **errp) | |
1319 | { | |
1320 | BlockDriverState *parent = c->opaque; | |
e94d3dba | 1321 | bool read_only = bdrv_is_read_only(parent); |
6858eba0 KW |
1322 | int ret; |
1323 | ||
e94d3dba AG |
1324 | if (read_only) { |
1325 | ret = bdrv_reopen_set_read_only(parent, false, errp); | |
61f09cea KW |
1326 | if (ret < 0) { |
1327 | return ret; | |
1328 | } | |
1329 | } | |
1330 | ||
6858eba0 KW |
1331 | ret = bdrv_change_backing_file(parent, filename, |
1332 | base->drv ? base->drv->format_name : ""); | |
1333 | if (ret < 0) { | |
64730694 | 1334 | error_setg_errno(errp, -ret, "Could not update backing file link"); |
6858eba0 KW |
1335 | } |
1336 | ||
e94d3dba AG |
1337 | if (read_only) { |
1338 | bdrv_reopen_set_read_only(parent, true, NULL); | |
61f09cea KW |
1339 | } |
1340 | ||
6858eba0 KW |
1341 | return ret; |
1342 | } | |
1343 | ||
bd86fb99 | 1344 | const BdrvChildClass child_backing = { |
6cd5c9d7 | 1345 | .parent_is_bds = true, |
b5411555 | 1346 | .get_parent_desc = bdrv_child_get_parent_desc, |
db95dbba KW |
1347 | .attach = bdrv_backing_attach, |
1348 | .detach = bdrv_backing_detach, | |
8e2160e2 | 1349 | .inherit_options = bdrv_backing_options, |
20018e12 | 1350 | .drained_begin = bdrv_child_cb_drained_begin, |
89bd0305 | 1351 | .drained_poll = bdrv_child_cb_drained_poll, |
20018e12 | 1352 | .drained_end = bdrv_child_cb_drained_end, |
38701b6a | 1353 | .inactivate = bdrv_child_cb_inactivate, |
6858eba0 | 1354 | .update_filename = bdrv_backing_update_filename, |
5d231849 | 1355 | .can_set_aio_ctx = bdrv_child_cb_can_set_aio_ctx, |
53a7d041 | 1356 | .set_aio_ctx = bdrv_child_cb_set_aio_ctx, |
f3930ed0 KW |
1357 | }; |
1358 | ||
7b272452 KW |
1359 | static int bdrv_open_flags(BlockDriverState *bs, int flags) |
1360 | { | |
61de4c68 | 1361 | int open_flags = flags; |
7b272452 KW |
1362 | |
1363 | /* | |
1364 | * Clear flags that are internal to the block layer before opening the | |
1365 | * image. | |
1366 | */ | |
20cca275 | 1367 | open_flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_PROTOCOL); |
7b272452 | 1368 | |
7b272452 KW |
1369 | return open_flags; |
1370 | } | |
1371 | ||
91a097e7 KW |
1372 | static void update_flags_from_options(int *flags, QemuOpts *opts) |
1373 | { | |
2a3d4331 | 1374 | *flags &= ~(BDRV_O_CACHE_MASK | BDRV_O_RDWR | BDRV_O_AUTO_RDONLY); |
91a097e7 | 1375 | |
57f9db9a | 1376 | if (qemu_opt_get_bool_del(opts, BDRV_OPT_CACHE_NO_FLUSH, false)) { |
91a097e7 KW |
1377 | *flags |= BDRV_O_NO_FLUSH; |
1378 | } | |
1379 | ||
57f9db9a | 1380 | if (qemu_opt_get_bool_del(opts, BDRV_OPT_CACHE_DIRECT, false)) { |
91a097e7 KW |
1381 | *flags |= BDRV_O_NOCACHE; |
1382 | } | |
f87a0e29 | 1383 | |
57f9db9a | 1384 | if (!qemu_opt_get_bool_del(opts, BDRV_OPT_READ_ONLY, false)) { |
f87a0e29 AG |
1385 | *flags |= BDRV_O_RDWR; |
1386 | } | |
1387 | ||
e35bdc12 KW |
1388 | if (qemu_opt_get_bool_del(opts, BDRV_OPT_AUTO_READ_ONLY, false)) { |
1389 | *flags |= BDRV_O_AUTO_RDONLY; | |
1390 | } | |
91a097e7 KW |
1391 | } |
1392 | ||
1393 | static void update_options_from_flags(QDict *options, int flags) | |
1394 | { | |
91a097e7 | 1395 | if (!qdict_haskey(options, BDRV_OPT_CACHE_DIRECT)) { |
46f5ac20 | 1396 | qdict_put_bool(options, BDRV_OPT_CACHE_DIRECT, flags & BDRV_O_NOCACHE); |
91a097e7 KW |
1397 | } |
1398 | if (!qdict_haskey(options, BDRV_OPT_CACHE_NO_FLUSH)) { | |
46f5ac20 EB |
1399 | qdict_put_bool(options, BDRV_OPT_CACHE_NO_FLUSH, |
1400 | flags & BDRV_O_NO_FLUSH); | |
91a097e7 | 1401 | } |
f87a0e29 | 1402 | if (!qdict_haskey(options, BDRV_OPT_READ_ONLY)) { |
46f5ac20 | 1403 | qdict_put_bool(options, BDRV_OPT_READ_ONLY, !(flags & BDRV_O_RDWR)); |
f87a0e29 | 1404 | } |
e35bdc12 KW |
1405 | if (!qdict_haskey(options, BDRV_OPT_AUTO_READ_ONLY)) { |
1406 | qdict_put_bool(options, BDRV_OPT_AUTO_READ_ONLY, | |
1407 | flags & BDRV_O_AUTO_RDONLY); | |
1408 | } | |
91a097e7 KW |
1409 | } |
1410 | ||
636ea370 KW |
1411 | static void bdrv_assign_node_name(BlockDriverState *bs, |
1412 | const char *node_name, | |
1413 | Error **errp) | |
6913c0c2 | 1414 | { |
15489c76 | 1415 | char *gen_node_name = NULL; |
6913c0c2 | 1416 | |
15489c76 JC |
1417 | if (!node_name) { |
1418 | node_name = gen_node_name = id_generate(ID_BLOCK); | |
1419 | } else if (!id_wellformed(node_name)) { | |
1420 | /* | |
1421 | * Check for empty string or invalid characters, but not if it is | |
1422 | * generated (generated names use characters not available to the user) | |
1423 | */ | |
9aebf3b8 | 1424 | error_setg(errp, "Invalid node name"); |
636ea370 | 1425 | return; |
6913c0c2 BC |
1426 | } |
1427 | ||
0c5e94ee | 1428 | /* takes care of avoiding namespaces collisions */ |
7f06d47e | 1429 | if (blk_by_name(node_name)) { |
0c5e94ee BC |
1430 | error_setg(errp, "node-name=%s is conflicting with a device id", |
1431 | node_name); | |
15489c76 | 1432 | goto out; |
0c5e94ee BC |
1433 | } |
1434 | ||
6913c0c2 BC |
1435 | /* takes care of avoiding duplicates node names */ |
1436 | if (bdrv_find_node(node_name)) { | |
1437 | error_setg(errp, "Duplicate node name"); | |
15489c76 | 1438 | goto out; |
6913c0c2 BC |
1439 | } |
1440 | ||
824808dd KW |
1441 | /* Make sure that the node name isn't truncated */ |
1442 | if (strlen(node_name) >= sizeof(bs->node_name)) { | |
1443 | error_setg(errp, "Node name too long"); | |
1444 | goto out; | |
1445 | } | |
1446 | ||
6913c0c2 BC |
1447 | /* copy node name into the bs and insert it into the graph list */ |
1448 | pstrcpy(bs->node_name, sizeof(bs->node_name), node_name); | |
1449 | QTAILQ_INSERT_TAIL(&graph_bdrv_states, bs, node_list); | |
15489c76 JC |
1450 | out: |
1451 | g_free(gen_node_name); | |
6913c0c2 BC |
1452 | } |
1453 | ||
01a56501 KW |
1454 | static int bdrv_open_driver(BlockDriverState *bs, BlockDriver *drv, |
1455 | const char *node_name, QDict *options, | |
1456 | int open_flags, Error **errp) | |
1457 | { | |
1458 | Error *local_err = NULL; | |
0f12264e | 1459 | int i, ret; |
01a56501 KW |
1460 | |
1461 | bdrv_assign_node_name(bs, node_name, &local_err); | |
1462 | if (local_err) { | |
1463 | error_propagate(errp, local_err); | |
1464 | return -EINVAL; | |
1465 | } | |
1466 | ||
1467 | bs->drv = drv; | |
680c7f96 | 1468 | bs->read_only = !(bs->open_flags & BDRV_O_RDWR); |
01a56501 KW |
1469 | bs->opaque = g_malloc0(drv->instance_size); |
1470 | ||
1471 | if (drv->bdrv_file_open) { | |
1472 | assert(!drv->bdrv_needs_filename || bs->filename[0]); | |
1473 | ret = drv->bdrv_file_open(bs, options, open_flags, &local_err); | |
680c7f96 | 1474 | } else if (drv->bdrv_open) { |
01a56501 | 1475 | ret = drv->bdrv_open(bs, options, open_flags, &local_err); |
680c7f96 KW |
1476 | } else { |
1477 | ret = 0; | |
01a56501 KW |
1478 | } |
1479 | ||
1480 | if (ret < 0) { | |
1481 | if (local_err) { | |
1482 | error_propagate(errp, local_err); | |
1483 | } else if (bs->filename[0]) { | |
1484 | error_setg_errno(errp, -ret, "Could not open '%s'", bs->filename); | |
1485 | } else { | |
1486 | error_setg_errno(errp, -ret, "Could not open image"); | |
1487 | } | |
180ca19a | 1488 | goto open_failed; |
01a56501 KW |
1489 | } |
1490 | ||
1491 | ret = refresh_total_sectors(bs, bs->total_sectors); | |
1492 | if (ret < 0) { | |
1493 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); | |
180ca19a | 1494 | return ret; |
01a56501 KW |
1495 | } |
1496 | ||
1497 | bdrv_refresh_limits(bs, &local_err); | |
1498 | if (local_err) { | |
1499 | error_propagate(errp, local_err); | |
180ca19a | 1500 | return -EINVAL; |
01a56501 KW |
1501 | } |
1502 | ||
1503 | assert(bdrv_opt_mem_align(bs) != 0); | |
1504 | assert(bdrv_min_mem_align(bs) != 0); | |
1505 | assert(is_power_of_2(bs->bl.request_alignment)); | |
1506 | ||
0f12264e KW |
1507 | for (i = 0; i < bs->quiesce_counter; i++) { |
1508 | if (drv->bdrv_co_drain_begin) { | |
1509 | drv->bdrv_co_drain_begin(bs); | |
1510 | } | |
1511 | } | |
1512 | ||
01a56501 | 1513 | return 0; |
180ca19a MP |
1514 | open_failed: |
1515 | bs->drv = NULL; | |
1516 | if (bs->file != NULL) { | |
1517 | bdrv_unref_child(bs, bs->file); | |
1518 | bs->file = NULL; | |
1519 | } | |
01a56501 KW |
1520 | g_free(bs->opaque); |
1521 | bs->opaque = NULL; | |
01a56501 KW |
1522 | return ret; |
1523 | } | |
1524 | ||
680c7f96 KW |
1525 | BlockDriverState *bdrv_new_open_driver(BlockDriver *drv, const char *node_name, |
1526 | int flags, Error **errp) | |
1527 | { | |
1528 | BlockDriverState *bs; | |
1529 | int ret; | |
1530 | ||
1531 | bs = bdrv_new(); | |
1532 | bs->open_flags = flags; | |
1533 | bs->explicit_options = qdict_new(); | |
1534 | bs->options = qdict_new(); | |
1535 | bs->opaque = NULL; | |
1536 | ||
1537 | update_options_from_flags(bs->options, flags); | |
1538 | ||
1539 | ret = bdrv_open_driver(bs, drv, node_name, bs->options, flags, errp); | |
1540 | if (ret < 0) { | |
cb3e7f08 | 1541 | qobject_unref(bs->explicit_options); |
180ca19a | 1542 | bs->explicit_options = NULL; |
cb3e7f08 | 1543 | qobject_unref(bs->options); |
180ca19a | 1544 | bs->options = NULL; |
680c7f96 KW |
1545 | bdrv_unref(bs); |
1546 | return NULL; | |
1547 | } | |
1548 | ||
1549 | return bs; | |
1550 | } | |
1551 | ||
c5f3014b | 1552 | QemuOptsList bdrv_runtime_opts = { |
18edf289 KW |
1553 | .name = "bdrv_common", |
1554 | .head = QTAILQ_HEAD_INITIALIZER(bdrv_runtime_opts.head), | |
1555 | .desc = { | |
1556 | { | |
1557 | .name = "node-name", | |
1558 | .type = QEMU_OPT_STRING, | |
1559 | .help = "Node name of the block device node", | |
1560 | }, | |
62392ebb KW |
1561 | { |
1562 | .name = "driver", | |
1563 | .type = QEMU_OPT_STRING, | |
1564 | .help = "Block driver to use for the node", | |
1565 | }, | |
91a097e7 KW |
1566 | { |
1567 | .name = BDRV_OPT_CACHE_DIRECT, | |
1568 | .type = QEMU_OPT_BOOL, | |
1569 | .help = "Bypass software writeback cache on the host", | |
1570 | }, | |
1571 | { | |
1572 | .name = BDRV_OPT_CACHE_NO_FLUSH, | |
1573 | .type = QEMU_OPT_BOOL, | |
1574 | .help = "Ignore flush requests", | |
1575 | }, | |
f87a0e29 AG |
1576 | { |
1577 | .name = BDRV_OPT_READ_ONLY, | |
1578 | .type = QEMU_OPT_BOOL, | |
1579 | .help = "Node is opened in read-only mode", | |
1580 | }, | |
e35bdc12 KW |
1581 | { |
1582 | .name = BDRV_OPT_AUTO_READ_ONLY, | |
1583 | .type = QEMU_OPT_BOOL, | |
1584 | .help = "Node can become read-only if opening read-write fails", | |
1585 | }, | |
692e01a2 KW |
1586 | { |
1587 | .name = "detect-zeroes", | |
1588 | .type = QEMU_OPT_STRING, | |
1589 | .help = "try to optimize zero writes (off, on, unmap)", | |
1590 | }, | |
818584a4 | 1591 | { |
415bbca8 | 1592 | .name = BDRV_OPT_DISCARD, |
818584a4 KW |
1593 | .type = QEMU_OPT_STRING, |
1594 | .help = "discard operation (ignore/off, unmap/on)", | |
1595 | }, | |
5a9347c6 FZ |
1596 | { |
1597 | .name = BDRV_OPT_FORCE_SHARE, | |
1598 | .type = QEMU_OPT_BOOL, | |
1599 | .help = "always accept other writers (default: off)", | |
1600 | }, | |
18edf289 KW |
1601 | { /* end of list */ } |
1602 | }, | |
1603 | }; | |
1604 | ||
5a5e7f8c ML |
1605 | QemuOptsList bdrv_create_opts_simple = { |
1606 | .name = "simple-create-opts", | |
1607 | .head = QTAILQ_HEAD_INITIALIZER(bdrv_create_opts_simple.head), | |
fd17146c HR |
1608 | .desc = { |
1609 | { | |
1610 | .name = BLOCK_OPT_SIZE, | |
1611 | .type = QEMU_OPT_SIZE, | |
1612 | .help = "Virtual disk size" | |
1613 | }, | |
1614 | { | |
1615 | .name = BLOCK_OPT_PREALLOC, | |
1616 | .type = QEMU_OPT_STRING, | |
1617 | .help = "Preallocation mode (allowed values: off)" | |
1618 | }, | |
1619 | { /* end of list */ } | |
1620 | } | |
1621 | }; | |
1622 | ||
57915332 KW |
1623 | /* |
1624 | * Common part for opening disk images and files | |
b6ad491a KW |
1625 | * |
1626 | * Removes all processed options from *options. | |
57915332 | 1627 | */ |
5696c6e3 | 1628 | static int bdrv_open_common(BlockDriverState *bs, BlockBackend *file, |
82dc8b41 | 1629 | QDict *options, Error **errp) |
57915332 KW |
1630 | { |
1631 | int ret, open_flags; | |
035fccdf | 1632 | const char *filename; |
62392ebb | 1633 | const char *driver_name = NULL; |
6913c0c2 | 1634 | const char *node_name = NULL; |
818584a4 | 1635 | const char *discard; |
18edf289 | 1636 | QemuOpts *opts; |
62392ebb | 1637 | BlockDriver *drv; |
34b5d2c6 | 1638 | Error *local_err = NULL; |
57915332 | 1639 | |
6405875c | 1640 | assert(bs->file == NULL); |
707ff828 | 1641 | assert(options != NULL && bs->options != options); |
57915332 | 1642 | |
62392ebb KW |
1643 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); |
1644 | qemu_opts_absorb_qdict(opts, options, &local_err); | |
1645 | if (local_err) { | |
1646 | error_propagate(errp, local_err); | |
1647 | ret = -EINVAL; | |
1648 | goto fail_opts; | |
1649 | } | |
1650 | ||
9b7e8691 AG |
1651 | update_flags_from_options(&bs->open_flags, opts); |
1652 | ||
62392ebb KW |
1653 | driver_name = qemu_opt_get(opts, "driver"); |
1654 | drv = bdrv_find_format(driver_name); | |
1655 | assert(drv != NULL); | |
1656 | ||
5a9347c6 FZ |
1657 | bs->force_share = qemu_opt_get_bool(opts, BDRV_OPT_FORCE_SHARE, false); |
1658 | ||
1659 | if (bs->force_share && (bs->open_flags & BDRV_O_RDWR)) { | |
1660 | error_setg(errp, | |
1661 | BDRV_OPT_FORCE_SHARE | |
1662 | "=on can only be used with read-only images"); | |
1663 | ret = -EINVAL; | |
1664 | goto fail_opts; | |
1665 | } | |
1666 | ||
45673671 | 1667 | if (file != NULL) { |
f30c66ba | 1668 | bdrv_refresh_filename(blk_bs(file)); |
5696c6e3 | 1669 | filename = blk_bs(file)->filename; |
45673671 | 1670 | } else { |
129c7d1c MA |
1671 | /* |
1672 | * Caution: while qdict_get_try_str() is fine, getting | |
1673 | * non-string types would require more care. When @options | |
1674 | * come from -blockdev or blockdev_add, its members are typed | |
1675 | * according to the QAPI schema, but when they come from | |
1676 | * -drive, they're all QString. | |
1677 | */ | |
45673671 KW |
1678 | filename = qdict_get_try_str(options, "filename"); |
1679 | } | |
1680 | ||
4a008240 | 1681 | if (drv->bdrv_needs_filename && (!filename || !filename[0])) { |
765003db KW |
1682 | error_setg(errp, "The '%s' block driver requires a file name", |
1683 | drv->format_name); | |
18edf289 KW |
1684 | ret = -EINVAL; |
1685 | goto fail_opts; | |
6913c0c2 | 1686 | } |
6913c0c2 | 1687 | |
82dc8b41 KW |
1688 | trace_bdrv_open_common(bs, filename ?: "", bs->open_flags, |
1689 | drv->format_name); | |
62392ebb | 1690 | |
82dc8b41 | 1691 | bs->read_only = !(bs->open_flags & BDRV_O_RDWR); |
b64ec4e4 FZ |
1692 | |
1693 | if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv, bs->read_only)) { | |
8be25de6 KW |
1694 | if (!bs->read_only && bdrv_is_whitelisted(drv, true)) { |
1695 | ret = bdrv_apply_auto_read_only(bs, NULL, NULL); | |
1696 | } else { | |
1697 | ret = -ENOTSUP; | |
1698 | } | |
1699 | if (ret < 0) { | |
1700 | error_setg(errp, | |
1701 | !bs->read_only && bdrv_is_whitelisted(drv, true) | |
1702 | ? "Driver '%s' can only be used for read-only devices" | |
1703 | : "Driver '%s' is not whitelisted", | |
1704 | drv->format_name); | |
1705 | goto fail_opts; | |
1706 | } | |
b64ec4e4 | 1707 | } |
57915332 | 1708 | |
d3faa13e PB |
1709 | /* bdrv_new() and bdrv_close() make it so */ |
1710 | assert(atomic_read(&bs->copy_on_read) == 0); | |
1711 | ||
82dc8b41 | 1712 | if (bs->open_flags & BDRV_O_COPY_ON_READ) { |
0ebd24e0 KW |
1713 | if (!bs->read_only) { |
1714 | bdrv_enable_copy_on_read(bs); | |
1715 | } else { | |
1716 | error_setg(errp, "Can't use copy-on-read on read-only device"); | |
18edf289 KW |
1717 | ret = -EINVAL; |
1718 | goto fail_opts; | |
0ebd24e0 | 1719 | } |
53fec9d3 SH |
1720 | } |
1721 | ||
415bbca8 | 1722 | discard = qemu_opt_get(opts, BDRV_OPT_DISCARD); |
818584a4 KW |
1723 | if (discard != NULL) { |
1724 | if (bdrv_parse_discard_flags(discard, &bs->open_flags) != 0) { | |
1725 | error_setg(errp, "Invalid discard option"); | |
1726 | ret = -EINVAL; | |
1727 | goto fail_opts; | |
1728 | } | |
1729 | } | |
1730 | ||
543770bd AG |
1731 | bs->detect_zeroes = |
1732 | bdrv_parse_detect_zeroes(opts, bs->open_flags, &local_err); | |
1733 | if (local_err) { | |
1734 | error_propagate(errp, local_err); | |
1735 | ret = -EINVAL; | |
1736 | goto fail_opts; | |
692e01a2 KW |
1737 | } |
1738 | ||
c2ad1b0c KW |
1739 | if (filename != NULL) { |
1740 | pstrcpy(bs->filename, sizeof(bs->filename), filename); | |
1741 | } else { | |
1742 | bs->filename[0] = '\0'; | |
1743 | } | |
91af7014 | 1744 | pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), bs->filename); |
57915332 | 1745 | |
66f82cee | 1746 | /* Open the image, either directly or using a protocol */ |
82dc8b41 | 1747 | open_flags = bdrv_open_flags(bs, bs->open_flags); |
01a56501 | 1748 | node_name = qemu_opt_get(opts, "node-name"); |
57915332 | 1749 | |
01a56501 KW |
1750 | assert(!drv->bdrv_file_open || file == NULL); |
1751 | ret = bdrv_open_driver(bs, drv, node_name, options, open_flags, errp); | |
51762288 | 1752 | if (ret < 0) { |
01a56501 | 1753 | goto fail_opts; |
3baca891 KW |
1754 | } |
1755 | ||
18edf289 | 1756 | qemu_opts_del(opts); |
57915332 KW |
1757 | return 0; |
1758 | ||
18edf289 KW |
1759 | fail_opts: |
1760 | qemu_opts_del(opts); | |
57915332 KW |
1761 | return ret; |
1762 | } | |
1763 | ||
5e5c4f63 KW |
1764 | static QDict *parse_json_filename(const char *filename, Error **errp) |
1765 | { | |
1766 | QObject *options_obj; | |
1767 | QDict *options; | |
1768 | int ret; | |
1769 | ||
1770 | ret = strstart(filename, "json:", &filename); | |
1771 | assert(ret); | |
1772 | ||
5577fff7 | 1773 | options_obj = qobject_from_json(filename, errp); |
5e5c4f63 | 1774 | if (!options_obj) { |
5577fff7 | 1775 | error_prepend(errp, "Could not parse the JSON options: "); |
5e5c4f63 KW |
1776 | return NULL; |
1777 | } | |
1778 | ||
7dc847eb | 1779 | options = qobject_to(QDict, options_obj); |
ca6b6e1e | 1780 | if (!options) { |
cb3e7f08 | 1781 | qobject_unref(options_obj); |
5e5c4f63 KW |
1782 | error_setg(errp, "Invalid JSON object given"); |
1783 | return NULL; | |
1784 | } | |
1785 | ||
5e5c4f63 KW |
1786 | qdict_flatten(options); |
1787 | ||
1788 | return options; | |
1789 | } | |
1790 | ||
de3b53f0 KW |
1791 | static void parse_json_protocol(QDict *options, const char **pfilename, |
1792 | Error **errp) | |
1793 | { | |
1794 | QDict *json_options; | |
1795 | Error *local_err = NULL; | |
1796 | ||
1797 | /* Parse json: pseudo-protocol */ | |
1798 | if (!*pfilename || !g_str_has_prefix(*pfilename, "json:")) { | |
1799 | return; | |
1800 | } | |
1801 | ||
1802 | json_options = parse_json_filename(*pfilename, &local_err); | |
1803 | if (local_err) { | |
1804 | error_propagate(errp, local_err); | |
1805 | return; | |
1806 | } | |
1807 | ||
1808 | /* Options given in the filename have lower priority than options | |
1809 | * specified directly */ | |
1810 | qdict_join(options, json_options, false); | |
cb3e7f08 | 1811 | qobject_unref(json_options); |
de3b53f0 KW |
1812 | *pfilename = NULL; |
1813 | } | |
1814 | ||
b6ce07aa | 1815 | /* |
f54120ff KW |
1816 | * Fills in default options for opening images and converts the legacy |
1817 | * filename/flags pair to option QDict entries. | |
53a29513 HR |
1818 | * The BDRV_O_PROTOCOL flag in *flags will be set or cleared accordingly if a |
1819 | * block driver has been specified explicitly. | |
b6ce07aa | 1820 | */ |
de3b53f0 | 1821 | static int bdrv_fill_options(QDict **options, const char *filename, |
053e1578 | 1822 | int *flags, Error **errp) |
ea2384d3 | 1823 | { |
c2ad1b0c | 1824 | const char *drvname; |
53a29513 | 1825 | bool protocol = *flags & BDRV_O_PROTOCOL; |
e3fa4bfa | 1826 | bool parse_filename = false; |
053e1578 | 1827 | BlockDriver *drv = NULL; |
34b5d2c6 | 1828 | Error *local_err = NULL; |
83f64091 | 1829 | |
129c7d1c MA |
1830 | /* |
1831 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
1832 | * types would require more care. When @options come from | |
1833 | * -blockdev or blockdev_add, its members are typed according to | |
1834 | * the QAPI schema, but when they come from -drive, they're all | |
1835 | * QString. | |
1836 | */ | |
53a29513 | 1837 | drvname = qdict_get_try_str(*options, "driver"); |
053e1578 HR |
1838 | if (drvname) { |
1839 | drv = bdrv_find_format(drvname); | |
1840 | if (!drv) { | |
1841 | error_setg(errp, "Unknown driver '%s'", drvname); | |
1842 | return -ENOENT; | |
1843 | } | |
1844 | /* If the user has explicitly specified the driver, this choice should | |
1845 | * override the BDRV_O_PROTOCOL flag */ | |
1846 | protocol = drv->bdrv_file_open; | |
53a29513 HR |
1847 | } |
1848 | ||
1849 | if (protocol) { | |
1850 | *flags |= BDRV_O_PROTOCOL; | |
1851 | } else { | |
1852 | *flags &= ~BDRV_O_PROTOCOL; | |
1853 | } | |
1854 | ||
91a097e7 KW |
1855 | /* Translate cache options from flags into options */ |
1856 | update_options_from_flags(*options, *flags); | |
1857 | ||
035fccdf | 1858 | /* Fetch the file name from the options QDict if necessary */ |
17b005f1 | 1859 | if (protocol && filename) { |
f54120ff | 1860 | if (!qdict_haskey(*options, "filename")) { |
46f5ac20 | 1861 | qdict_put_str(*options, "filename", filename); |
f54120ff KW |
1862 | parse_filename = true; |
1863 | } else { | |
1864 | error_setg(errp, "Can't specify 'file' and 'filename' options at " | |
1865 | "the same time"); | |
1866 | return -EINVAL; | |
1867 | } | |
035fccdf KW |
1868 | } |
1869 | ||
c2ad1b0c | 1870 | /* Find the right block driver */ |
129c7d1c | 1871 | /* See cautionary note on accessing @options above */ |
f54120ff | 1872 | filename = qdict_get_try_str(*options, "filename"); |
f54120ff | 1873 | |
053e1578 HR |
1874 | if (!drvname && protocol) { |
1875 | if (filename) { | |
1876 | drv = bdrv_find_protocol(filename, parse_filename, errp); | |
17b005f1 | 1877 | if (!drv) { |
053e1578 | 1878 | return -EINVAL; |
17b005f1 | 1879 | } |
053e1578 HR |
1880 | |
1881 | drvname = drv->format_name; | |
46f5ac20 | 1882 | qdict_put_str(*options, "driver", drvname); |
053e1578 HR |
1883 | } else { |
1884 | error_setg(errp, "Must specify either driver or file"); | |
1885 | return -EINVAL; | |
98289620 | 1886 | } |
c2ad1b0c KW |
1887 | } |
1888 | ||
17b005f1 | 1889 | assert(drv || !protocol); |
c2ad1b0c | 1890 | |
f54120ff | 1891 | /* Driver-specific filename parsing */ |
17b005f1 | 1892 | if (drv && drv->bdrv_parse_filename && parse_filename) { |
5acd9d81 | 1893 | drv->bdrv_parse_filename(filename, *options, &local_err); |
84d18f06 | 1894 | if (local_err) { |
34b5d2c6 | 1895 | error_propagate(errp, local_err); |
f54120ff | 1896 | return -EINVAL; |
6963a30d | 1897 | } |
cd5d031e HR |
1898 | |
1899 | if (!drv->bdrv_needs_filename) { | |
1900 | qdict_del(*options, "filename"); | |
cd5d031e | 1901 | } |
6963a30d KW |
1902 | } |
1903 | ||
f54120ff KW |
1904 | return 0; |
1905 | } | |
1906 | ||
3121fb45 KW |
1907 | static int bdrv_child_check_perm(BdrvChild *c, BlockReopenQueue *q, |
1908 | uint64_t perm, uint64_t shared, | |
9eab1544 HR |
1909 | GSList *ignore_children, |
1910 | bool *tighten_restrictions, Error **errp); | |
c1cef672 FZ |
1911 | static void bdrv_child_abort_perm_update(BdrvChild *c); |
1912 | static void bdrv_child_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared); | |
1913 | ||
148eb13c KW |
1914 | typedef struct BlockReopenQueueEntry { |
1915 | bool prepared; | |
69b736e7 | 1916 | bool perms_checked; |
148eb13c | 1917 | BDRVReopenState state; |
859443b0 | 1918 | QTAILQ_ENTRY(BlockReopenQueueEntry) entry; |
148eb13c KW |
1919 | } BlockReopenQueueEntry; |
1920 | ||
1921 | /* | |
1922 | * Return the flags that @bs will have after the reopens in @q have | |
1923 | * successfully completed. If @q is NULL (or @bs is not contained in @q), | |
1924 | * return the current flags. | |
1925 | */ | |
1926 | static int bdrv_reopen_get_flags(BlockReopenQueue *q, BlockDriverState *bs) | |
1927 | { | |
1928 | BlockReopenQueueEntry *entry; | |
1929 | ||
1930 | if (q != NULL) { | |
859443b0 | 1931 | QTAILQ_FOREACH(entry, q, entry) { |
148eb13c KW |
1932 | if (entry->state.bs == bs) { |
1933 | return entry->state.flags; | |
1934 | } | |
1935 | } | |
1936 | } | |
1937 | ||
1938 | return bs->open_flags; | |
1939 | } | |
1940 | ||
1941 | /* Returns whether the image file can be written to after the reopen queue @q | |
1942 | * has been successfully applied, or right now if @q is NULL. */ | |
cc022140 HR |
1943 | static bool bdrv_is_writable_after_reopen(BlockDriverState *bs, |
1944 | BlockReopenQueue *q) | |
148eb13c KW |
1945 | { |
1946 | int flags = bdrv_reopen_get_flags(q, bs); | |
1947 | ||
1948 | return (flags & (BDRV_O_RDWR | BDRV_O_INACTIVE)) == BDRV_O_RDWR; | |
1949 | } | |
1950 | ||
cc022140 HR |
1951 | /* |
1952 | * Return whether the BDS can be written to. This is not necessarily | |
1953 | * the same as !bdrv_is_read_only(bs), as inactivated images may not | |
1954 | * be written to but do not count as read-only images. | |
1955 | */ | |
1956 | bool bdrv_is_writable(BlockDriverState *bs) | |
1957 | { | |
1958 | return bdrv_is_writable_after_reopen(bs, NULL); | |
1959 | } | |
1960 | ||
ffd1a5a2 | 1961 | static void bdrv_child_perm(BlockDriverState *bs, BlockDriverState *child_bs, |
bd86fb99 | 1962 | BdrvChild *c, const BdrvChildClass *child_class, |
bf8e925e | 1963 | BdrvChildRole role, BlockReopenQueue *reopen_queue, |
ffd1a5a2 FZ |
1964 | uint64_t parent_perm, uint64_t parent_shared, |
1965 | uint64_t *nperm, uint64_t *nshared) | |
1966 | { | |
0b3ca76e | 1967 | assert(bs->drv && bs->drv->bdrv_child_perm); |
bf8e925e | 1968 | bs->drv->bdrv_child_perm(bs, c, child_class, role, reopen_queue, |
0b3ca76e AG |
1969 | parent_perm, parent_shared, |
1970 | nperm, nshared); | |
e0995dc3 | 1971 | /* TODO Take force_share from reopen_queue */ |
ffd1a5a2 FZ |
1972 | if (child_bs && child_bs->force_share) { |
1973 | *nshared = BLK_PERM_ALL; | |
1974 | } | |
1975 | } | |
1976 | ||
33a610c3 KW |
1977 | /* |
1978 | * Check whether permissions on this node can be changed in a way that | |
1979 | * @cumulative_perms and @cumulative_shared_perms are the new cumulative | |
1980 | * permissions of all its parents. This involves checking whether all necessary | |
1981 | * permission changes to child nodes can be performed. | |
1982 | * | |
9eab1544 HR |
1983 | * Will set *tighten_restrictions to true if and only if new permissions have to |
1984 | * be taken or currently shared permissions are to be unshared. Otherwise, | |
1985 | * errors are not fatal as long as the caller accepts that the restrictions | |
1986 | * remain tighter than they need to be. The caller still has to abort the | |
1987 | * transaction. | |
1988 | * @tighten_restrictions cannot be used together with @q: When reopening, we may | |
1989 | * encounter fatal errors even though no restrictions are to be tightened. For | |
1990 | * example, changing a node from RW to RO will fail if the WRITE permission is | |
1991 | * to be kept. | |
1992 | * | |
33a610c3 KW |
1993 | * A call to this function must always be followed by a call to bdrv_set_perm() |
1994 | * or bdrv_abort_perm_update(). | |
1995 | */ | |
3121fb45 KW |
1996 | static int bdrv_check_perm(BlockDriverState *bs, BlockReopenQueue *q, |
1997 | uint64_t cumulative_perms, | |
46181129 | 1998 | uint64_t cumulative_shared_perms, |
9eab1544 HR |
1999 | GSList *ignore_children, |
2000 | bool *tighten_restrictions, Error **errp) | |
33a610c3 KW |
2001 | { |
2002 | BlockDriver *drv = bs->drv; | |
2003 | BdrvChild *c; | |
2004 | int ret; | |
2005 | ||
9eab1544 HR |
2006 | assert(!q || !tighten_restrictions); |
2007 | ||
2008 | if (tighten_restrictions) { | |
2009 | uint64_t current_perms, current_shared; | |
2010 | uint64_t added_perms, removed_shared_perms; | |
2011 | ||
2012 | bdrv_get_cumulative_perm(bs, ¤t_perms, ¤t_shared); | |
2013 | ||
2014 | added_perms = cumulative_perms & ~current_perms; | |
2015 | removed_shared_perms = current_shared & ~cumulative_shared_perms; | |
2016 | ||
2017 | *tighten_restrictions = added_perms || removed_shared_perms; | |
2018 | } | |
2019 | ||
33a610c3 KW |
2020 | /* Write permissions never work with read-only images */ |
2021 | if ((cumulative_perms & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED)) && | |
cc022140 | 2022 | !bdrv_is_writable_after_reopen(bs, q)) |
33a610c3 | 2023 | { |
481e0eee HR |
2024 | if (!bdrv_is_writable_after_reopen(bs, NULL)) { |
2025 | error_setg(errp, "Block node is read-only"); | |
2026 | } else { | |
2027 | uint64_t current_perms, current_shared; | |
2028 | bdrv_get_cumulative_perm(bs, ¤t_perms, ¤t_shared); | |
2029 | if (current_perms & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED)) { | |
2030 | error_setg(errp, "Cannot make block node read-only, there is " | |
2031 | "a writer on it"); | |
2032 | } else { | |
2033 | error_setg(errp, "Cannot make block node read-only and create " | |
2034 | "a writer on it"); | |
2035 | } | |
2036 | } | |
2037 | ||
33a610c3 KW |
2038 | return -EPERM; |
2039 | } | |
2040 | ||
2041 | /* Check this node */ | |
2042 | if (!drv) { | |
2043 | return 0; | |
2044 | } | |
2045 | ||
2046 | if (drv->bdrv_check_perm) { | |
2047 | return drv->bdrv_check_perm(bs, cumulative_perms, | |
2048 | cumulative_shared_perms, errp); | |
2049 | } | |
2050 | ||
78e421c9 | 2051 | /* Drivers that never have children can omit .bdrv_child_perm() */ |
33a610c3 | 2052 | if (!drv->bdrv_child_perm) { |
78e421c9 | 2053 | assert(QLIST_EMPTY(&bs->children)); |
33a610c3 KW |
2054 | return 0; |
2055 | } | |
2056 | ||
2057 | /* Check all children */ | |
2058 | QLIST_FOREACH(c, &bs->children, next) { | |
2059 | uint64_t cur_perm, cur_shared; | |
9eab1544 HR |
2060 | bool child_tighten_restr; |
2061 | ||
bf8e925e | 2062 | bdrv_child_perm(bs, c->bs, c, c->klass, c->role, q, |
ffd1a5a2 FZ |
2063 | cumulative_perms, cumulative_shared_perms, |
2064 | &cur_perm, &cur_shared); | |
9eab1544 HR |
2065 | ret = bdrv_child_check_perm(c, q, cur_perm, cur_shared, ignore_children, |
2066 | tighten_restrictions ? &child_tighten_restr | |
2067 | : NULL, | |
2068 | errp); | |
2069 | if (tighten_restrictions) { | |
2070 | *tighten_restrictions |= child_tighten_restr; | |
2071 | } | |
33a610c3 KW |
2072 | if (ret < 0) { |
2073 | return ret; | |
2074 | } | |
2075 | } | |
2076 | ||
2077 | return 0; | |
2078 | } | |
2079 | ||
2080 | /* | |
2081 | * Notifies drivers that after a previous bdrv_check_perm() call, the | |
2082 | * permission update is not performed and any preparations made for it (e.g. | |
2083 | * taken file locks) need to be undone. | |
2084 | * | |
2085 | * This function recursively notifies all child nodes. | |
2086 | */ | |
2087 | static void bdrv_abort_perm_update(BlockDriverState *bs) | |
2088 | { | |
2089 | BlockDriver *drv = bs->drv; | |
2090 | BdrvChild *c; | |
2091 | ||
2092 | if (!drv) { | |
2093 | return; | |
2094 | } | |
2095 | ||
2096 | if (drv->bdrv_abort_perm_update) { | |
2097 | drv->bdrv_abort_perm_update(bs); | |
2098 | } | |
2099 | ||
2100 | QLIST_FOREACH(c, &bs->children, next) { | |
2101 | bdrv_child_abort_perm_update(c); | |
2102 | } | |
2103 | } | |
2104 | ||
2105 | static void bdrv_set_perm(BlockDriverState *bs, uint64_t cumulative_perms, | |
2106 | uint64_t cumulative_shared_perms) | |
2107 | { | |
2108 | BlockDriver *drv = bs->drv; | |
2109 | BdrvChild *c; | |
2110 | ||
2111 | if (!drv) { | |
2112 | return; | |
2113 | } | |
2114 | ||
2115 | /* Update this node */ | |
2116 | if (drv->bdrv_set_perm) { | |
2117 | drv->bdrv_set_perm(bs, cumulative_perms, cumulative_shared_perms); | |
2118 | } | |
2119 | ||
78e421c9 | 2120 | /* Drivers that never have children can omit .bdrv_child_perm() */ |
33a610c3 | 2121 | if (!drv->bdrv_child_perm) { |
78e421c9 | 2122 | assert(QLIST_EMPTY(&bs->children)); |
33a610c3 KW |
2123 | return; |
2124 | } | |
2125 | ||
2126 | /* Update all children */ | |
2127 | QLIST_FOREACH(c, &bs->children, next) { | |
2128 | uint64_t cur_perm, cur_shared; | |
bf8e925e | 2129 | bdrv_child_perm(bs, c->bs, c, c->klass, c->role, NULL, |
ffd1a5a2 FZ |
2130 | cumulative_perms, cumulative_shared_perms, |
2131 | &cur_perm, &cur_shared); | |
33a610c3 KW |
2132 | bdrv_child_set_perm(c, cur_perm, cur_shared); |
2133 | } | |
2134 | } | |
2135 | ||
c7a0f2be KW |
2136 | void bdrv_get_cumulative_perm(BlockDriverState *bs, uint64_t *perm, |
2137 | uint64_t *shared_perm) | |
33a610c3 KW |
2138 | { |
2139 | BdrvChild *c; | |
2140 | uint64_t cumulative_perms = 0; | |
2141 | uint64_t cumulative_shared_perms = BLK_PERM_ALL; | |
2142 | ||
2143 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
2144 | cumulative_perms |= c->perm; | |
2145 | cumulative_shared_perms &= c->shared_perm; | |
2146 | } | |
2147 | ||
2148 | *perm = cumulative_perms; | |
2149 | *shared_perm = cumulative_shared_perms; | |
2150 | } | |
2151 | ||
d083319f KW |
2152 | static char *bdrv_child_user_desc(BdrvChild *c) |
2153 | { | |
bd86fb99 HR |
2154 | if (c->klass->get_parent_desc) { |
2155 | return c->klass->get_parent_desc(c); | |
d083319f KW |
2156 | } |
2157 | ||
2158 | return g_strdup("another user"); | |
2159 | } | |
2160 | ||
5176196c | 2161 | char *bdrv_perm_names(uint64_t perm) |
d083319f KW |
2162 | { |
2163 | struct perm_name { | |
2164 | uint64_t perm; | |
2165 | const char *name; | |
2166 | } permissions[] = { | |
2167 | { BLK_PERM_CONSISTENT_READ, "consistent read" }, | |
2168 | { BLK_PERM_WRITE, "write" }, | |
2169 | { BLK_PERM_WRITE_UNCHANGED, "write unchanged" }, | |
2170 | { BLK_PERM_RESIZE, "resize" }, | |
2171 | { BLK_PERM_GRAPH_MOD, "change children" }, | |
2172 | { 0, NULL } | |
2173 | }; | |
2174 | ||
e2a7423a | 2175 | GString *result = g_string_sized_new(30); |
d083319f KW |
2176 | struct perm_name *p; |
2177 | ||
2178 | for (p = permissions; p->name; p++) { | |
2179 | if (perm & p->perm) { | |
e2a7423a AG |
2180 | if (result->len > 0) { |
2181 | g_string_append(result, ", "); | |
2182 | } | |
2183 | g_string_append(result, p->name); | |
d083319f KW |
2184 | } |
2185 | } | |
2186 | ||
e2a7423a | 2187 | return g_string_free(result, FALSE); |
d083319f KW |
2188 | } |
2189 | ||
33a610c3 KW |
2190 | /* |
2191 | * Checks whether a new reference to @bs can be added if the new user requires | |
46181129 KW |
2192 | * @new_used_perm/@new_shared_perm as its permissions. If @ignore_children is |
2193 | * set, the BdrvChild objects in this list are ignored in the calculations; | |
2194 | * this allows checking permission updates for an existing reference. | |
33a610c3 | 2195 | * |
9eab1544 HR |
2196 | * See bdrv_check_perm() for the semantics of @tighten_restrictions. |
2197 | * | |
33a610c3 KW |
2198 | * Needs to be followed by a call to either bdrv_set_perm() or |
2199 | * bdrv_abort_perm_update(). */ | |
3121fb45 KW |
2200 | static int bdrv_check_update_perm(BlockDriverState *bs, BlockReopenQueue *q, |
2201 | uint64_t new_used_perm, | |
d5e6f437 | 2202 | uint64_t new_shared_perm, |
9eab1544 HR |
2203 | GSList *ignore_children, |
2204 | bool *tighten_restrictions, | |
2205 | Error **errp) | |
d5e6f437 KW |
2206 | { |
2207 | BdrvChild *c; | |
33a610c3 KW |
2208 | uint64_t cumulative_perms = new_used_perm; |
2209 | uint64_t cumulative_shared_perms = new_shared_perm; | |
d5e6f437 | 2210 | |
9eab1544 HR |
2211 | assert(!q || !tighten_restrictions); |
2212 | ||
d5e6f437 KW |
2213 | /* There is no reason why anyone couldn't tolerate write_unchanged */ |
2214 | assert(new_shared_perm & BLK_PERM_WRITE_UNCHANGED); | |
2215 | ||
2216 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
46181129 | 2217 | if (g_slist_find(ignore_children, c)) { |
d5e6f437 KW |
2218 | continue; |
2219 | } | |
2220 | ||
d083319f KW |
2221 | if ((new_used_perm & c->shared_perm) != new_used_perm) { |
2222 | char *user = bdrv_child_user_desc(c); | |
2223 | char *perm_names = bdrv_perm_names(new_used_perm & ~c->shared_perm); | |
9eab1544 HR |
2224 | |
2225 | if (tighten_restrictions) { | |
2226 | *tighten_restrictions = true; | |
2227 | } | |
2228 | ||
d083319f KW |
2229 | error_setg(errp, "Conflicts with use by %s as '%s', which does not " |
2230 | "allow '%s' on %s", | |
2231 | user, c->name, perm_names, bdrv_get_node_name(c->bs)); | |
2232 | g_free(user); | |
2233 | g_free(perm_names); | |
2234 | return -EPERM; | |
2235 | } | |
2236 | ||
2237 | if ((c->perm & new_shared_perm) != c->perm) { | |
2238 | char *user = bdrv_child_user_desc(c); | |
2239 | char *perm_names = bdrv_perm_names(c->perm & ~new_shared_perm); | |
9eab1544 HR |
2240 | |
2241 | if (tighten_restrictions) { | |
2242 | *tighten_restrictions = true; | |
2243 | } | |
2244 | ||
d083319f KW |
2245 | error_setg(errp, "Conflicts with use by %s as '%s', which uses " |
2246 | "'%s' on %s", | |
2247 | user, c->name, perm_names, bdrv_get_node_name(c->bs)); | |
2248 | g_free(user); | |
2249 | g_free(perm_names); | |
d5e6f437 KW |
2250 | return -EPERM; |
2251 | } | |
33a610c3 KW |
2252 | |
2253 | cumulative_perms |= c->perm; | |
2254 | cumulative_shared_perms &= c->shared_perm; | |
d5e6f437 KW |
2255 | } |
2256 | ||
3121fb45 | 2257 | return bdrv_check_perm(bs, q, cumulative_perms, cumulative_shared_perms, |
9eab1544 | 2258 | ignore_children, tighten_restrictions, errp); |
33a610c3 KW |
2259 | } |
2260 | ||
2261 | /* Needs to be followed by a call to either bdrv_child_set_perm() or | |
2262 | * bdrv_child_abort_perm_update(). */ | |
3121fb45 KW |
2263 | static int bdrv_child_check_perm(BdrvChild *c, BlockReopenQueue *q, |
2264 | uint64_t perm, uint64_t shared, | |
9eab1544 HR |
2265 | GSList *ignore_children, |
2266 | bool *tighten_restrictions, Error **errp) | |
33a610c3 | 2267 | { |
46181129 KW |
2268 | int ret; |
2269 | ||
2270 | ignore_children = g_slist_prepend(g_slist_copy(ignore_children), c); | |
9eab1544 HR |
2271 | ret = bdrv_check_update_perm(c->bs, q, perm, shared, ignore_children, |
2272 | tighten_restrictions, errp); | |
46181129 KW |
2273 | g_slist_free(ignore_children); |
2274 | ||
f962e961 VSO |
2275 | if (ret < 0) { |
2276 | return ret; | |
2277 | } | |
2278 | ||
2279 | if (!c->has_backup_perm) { | |
2280 | c->has_backup_perm = true; | |
2281 | c->backup_perm = c->perm; | |
2282 | c->backup_shared_perm = c->shared_perm; | |
2283 | } | |
2284 | /* | |
2285 | * Note: it's OK if c->has_backup_perm was already set, as we can find the | |
2286 | * same child twice during check_perm procedure | |
2287 | */ | |
2288 | ||
2289 | c->perm = perm; | |
2290 | c->shared_perm = shared; | |
2291 | ||
2292 | return 0; | |
33a610c3 KW |
2293 | } |
2294 | ||
c1cef672 | 2295 | static void bdrv_child_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared) |
33a610c3 KW |
2296 | { |
2297 | uint64_t cumulative_perms, cumulative_shared_perms; | |
2298 | ||
f962e961 VSO |
2299 | c->has_backup_perm = false; |
2300 | ||
33a610c3 KW |
2301 | c->perm = perm; |
2302 | c->shared_perm = shared; | |
2303 | ||
2304 | bdrv_get_cumulative_perm(c->bs, &cumulative_perms, | |
2305 | &cumulative_shared_perms); | |
2306 | bdrv_set_perm(c->bs, cumulative_perms, cumulative_shared_perms); | |
2307 | } | |
2308 | ||
c1cef672 | 2309 | static void bdrv_child_abort_perm_update(BdrvChild *c) |
33a610c3 | 2310 | { |
f962e961 VSO |
2311 | if (c->has_backup_perm) { |
2312 | c->perm = c->backup_perm; | |
2313 | c->shared_perm = c->backup_shared_perm; | |
2314 | c->has_backup_perm = false; | |
2315 | } | |
2316 | ||
33a610c3 KW |
2317 | bdrv_abort_perm_update(c->bs); |
2318 | } | |
2319 | ||
2320 | int bdrv_child_try_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared, | |
2321 | Error **errp) | |
2322 | { | |
1046779e | 2323 | Error *local_err = NULL; |
33a610c3 | 2324 | int ret; |
1046779e | 2325 | bool tighten_restrictions; |
33a610c3 | 2326 | |
1046779e HR |
2327 | ret = bdrv_child_check_perm(c, NULL, perm, shared, NULL, |
2328 | &tighten_restrictions, &local_err); | |
33a610c3 KW |
2329 | if (ret < 0) { |
2330 | bdrv_child_abort_perm_update(c); | |
1046779e HR |
2331 | if (tighten_restrictions) { |
2332 | error_propagate(errp, local_err); | |
2333 | } else { | |
2334 | /* | |
2335 | * Our caller may intend to only loosen restrictions and | |
2336 | * does not expect this function to fail. Errors are not | |
2337 | * fatal in such a case, so we can just hide them from our | |
2338 | * caller. | |
2339 | */ | |
2340 | error_free(local_err); | |
2341 | ret = 0; | |
2342 | } | |
33a610c3 KW |
2343 | return ret; |
2344 | } | |
2345 | ||
2346 | bdrv_child_set_perm(c, perm, shared); | |
2347 | ||
d5e6f437 KW |
2348 | return 0; |
2349 | } | |
2350 | ||
c1087f12 HR |
2351 | int bdrv_child_refresh_perms(BlockDriverState *bs, BdrvChild *c, Error **errp) |
2352 | { | |
2353 | uint64_t parent_perms, parent_shared; | |
2354 | uint64_t perms, shared; | |
2355 | ||
2356 | bdrv_get_cumulative_perm(bs, &parent_perms, &parent_shared); | |
bf8e925e HR |
2357 | bdrv_child_perm(bs, c->bs, c, c->klass, c->role, NULL, |
2358 | parent_perms, parent_shared, &perms, &shared); | |
c1087f12 HR |
2359 | |
2360 | return bdrv_child_try_set_perm(c, perms, shared, errp); | |
2361 | } | |
2362 | ||
6a1b9ee1 | 2363 | void bdrv_filter_default_perms(BlockDriverState *bs, BdrvChild *c, |
bd86fb99 | 2364 | const BdrvChildClass *child_class, |
bf8e925e | 2365 | BdrvChildRole role, |
e0995dc3 | 2366 | BlockReopenQueue *reopen_queue, |
6a1b9ee1 KW |
2367 | uint64_t perm, uint64_t shared, |
2368 | uint64_t *nperm, uint64_t *nshared) | |
2369 | { | |
e444fa83 KW |
2370 | *nperm = perm & DEFAULT_PERM_PASSTHROUGH; |
2371 | *nshared = (shared & DEFAULT_PERM_PASSTHROUGH) | DEFAULT_PERM_UNCHANGED; | |
6a1b9ee1 KW |
2372 | } |
2373 | ||
6b1a044a | 2374 | void bdrv_format_default_perms(BlockDriverState *bs, BdrvChild *c, |
bd86fb99 | 2375 | const BdrvChildClass *child_class, |
bf8e925e | 2376 | BdrvChildRole role, |
e0995dc3 | 2377 | BlockReopenQueue *reopen_queue, |
6b1a044a KW |
2378 | uint64_t perm, uint64_t shared, |
2379 | uint64_t *nperm, uint64_t *nshared) | |
2380 | { | |
bd86fb99 HR |
2381 | bool backing = (child_class == &child_backing); |
2382 | assert(child_class == &child_backing || child_class == &child_file); | |
6b1a044a KW |
2383 | |
2384 | if (!backing) { | |
5fbfabd3 KW |
2385 | int flags = bdrv_reopen_get_flags(reopen_queue, bs); |
2386 | ||
6b1a044a KW |
2387 | /* Apart from the modifications below, the same permissions are |
2388 | * forwarded and left alone as for filters */ | |
bf8e925e | 2389 | bdrv_filter_default_perms(bs, c, child_class, role, reopen_queue, |
bd86fb99 | 2390 | perm, shared, &perm, &shared); |
6b1a044a KW |
2391 | |
2392 | /* Format drivers may touch metadata even if the guest doesn't write */ | |
cc022140 | 2393 | if (bdrv_is_writable_after_reopen(bs, reopen_queue)) { |
6b1a044a KW |
2394 | perm |= BLK_PERM_WRITE | BLK_PERM_RESIZE; |
2395 | } | |
2396 | ||
2397 | /* bs->file always needs to be consistent because of the metadata. We | |
2398 | * can never allow other users to resize or write to it. */ | |
5fbfabd3 KW |
2399 | if (!(flags & BDRV_O_NO_IO)) { |
2400 | perm |= BLK_PERM_CONSISTENT_READ; | |
2401 | } | |
6b1a044a KW |
2402 | shared &= ~(BLK_PERM_WRITE | BLK_PERM_RESIZE); |
2403 | } else { | |
2404 | /* We want consistent read from backing files if the parent needs it. | |
2405 | * No other operations are performed on backing files. */ | |
2406 | perm &= BLK_PERM_CONSISTENT_READ; | |
2407 | ||
2408 | /* If the parent can deal with changing data, we're okay with a | |
2409 | * writable and resizable backing file. */ | |
2410 | /* TODO Require !(perm & BLK_PERM_CONSISTENT_READ), too? */ | |
2411 | if (shared & BLK_PERM_WRITE) { | |
2412 | shared = BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
2413 | } else { | |
2414 | shared = 0; | |
2415 | } | |
2416 | ||
2417 | shared |= BLK_PERM_CONSISTENT_READ | BLK_PERM_GRAPH_MOD | | |
2418 | BLK_PERM_WRITE_UNCHANGED; | |
2419 | } | |
2420 | ||
9c5e6594 KW |
2421 | if (bs->open_flags & BDRV_O_INACTIVE) { |
2422 | shared |= BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
2423 | } | |
2424 | ||
6b1a044a KW |
2425 | *nperm = perm; |
2426 | *nshared = shared; | |
2427 | } | |
2428 | ||
7b1d9c4d HR |
2429 | uint64_t bdrv_qapi_perm_to_blk_perm(BlockPermission qapi_perm) |
2430 | { | |
2431 | static const uint64_t permissions[] = { | |
2432 | [BLOCK_PERMISSION_CONSISTENT_READ] = BLK_PERM_CONSISTENT_READ, | |
2433 | [BLOCK_PERMISSION_WRITE] = BLK_PERM_WRITE, | |
2434 | [BLOCK_PERMISSION_WRITE_UNCHANGED] = BLK_PERM_WRITE_UNCHANGED, | |
2435 | [BLOCK_PERMISSION_RESIZE] = BLK_PERM_RESIZE, | |
2436 | [BLOCK_PERMISSION_GRAPH_MOD] = BLK_PERM_GRAPH_MOD, | |
2437 | }; | |
2438 | ||
2439 | QEMU_BUILD_BUG_ON(ARRAY_SIZE(permissions) != BLOCK_PERMISSION__MAX); | |
2440 | QEMU_BUILD_BUG_ON(1UL << ARRAY_SIZE(permissions) != BLK_PERM_ALL + 1); | |
2441 | ||
2442 | assert(qapi_perm < BLOCK_PERMISSION__MAX); | |
2443 | ||
2444 | return permissions[qapi_perm]; | |
2445 | } | |
2446 | ||
8ee03995 KW |
2447 | static void bdrv_replace_child_noperm(BdrvChild *child, |
2448 | BlockDriverState *new_bs) | |
e9740bc6 KW |
2449 | { |
2450 | BlockDriverState *old_bs = child->bs; | |
debc2927 HR |
2451 | int new_bs_quiesce_counter; |
2452 | int drain_saldo; | |
e9740bc6 | 2453 | |
2cad1ebe AG |
2454 | assert(!child->frozen); |
2455 | ||
bb2614e9 FZ |
2456 | if (old_bs && new_bs) { |
2457 | assert(bdrv_get_aio_context(old_bs) == bdrv_get_aio_context(new_bs)); | |
2458 | } | |
debc2927 HR |
2459 | |
2460 | new_bs_quiesce_counter = (new_bs ? new_bs->quiesce_counter : 0); | |
2461 | drain_saldo = new_bs_quiesce_counter - child->parent_quiesce_counter; | |
2462 | ||
2463 | /* | |
2464 | * If the new child node is drained but the old one was not, flush | |
2465 | * all outstanding requests to the old child node. | |
2466 | */ | |
bd86fb99 | 2467 | while (drain_saldo > 0 && child->klass->drained_begin) { |
debc2927 HR |
2468 | bdrv_parent_drained_begin_single(child, true); |
2469 | drain_saldo--; | |
2470 | } | |
2471 | ||
e9740bc6 | 2472 | if (old_bs) { |
d736f119 KW |
2473 | /* Detach first so that the recursive drain sections coming from @child |
2474 | * are already gone and we only end the drain sections that came from | |
2475 | * elsewhere. */ | |
bd86fb99 HR |
2476 | if (child->klass->detach) { |
2477 | child->klass->detach(child); | |
d736f119 | 2478 | } |
e9740bc6 KW |
2479 | QLIST_REMOVE(child, next_parent); |
2480 | } | |
36fe1331 KW |
2481 | |
2482 | child->bs = new_bs; | |
2483 | ||
e9740bc6 KW |
2484 | if (new_bs) { |
2485 | QLIST_INSERT_HEAD(&new_bs->parents, child, next_parent); | |
debc2927 HR |
2486 | |
2487 | /* | |
2488 | * Detaching the old node may have led to the new node's | |
2489 | * quiesce_counter having been decreased. Not a problem, we | |
2490 | * just need to recognize this here and then invoke | |
2491 | * drained_end appropriately more often. | |
2492 | */ | |
2493 | assert(new_bs->quiesce_counter <= new_bs_quiesce_counter); | |
2494 | drain_saldo += new_bs->quiesce_counter - new_bs_quiesce_counter; | |
33a610c3 | 2495 | |
d736f119 KW |
2496 | /* Attach only after starting new drained sections, so that recursive |
2497 | * drain sections coming from @child don't get an extra .drained_begin | |
2498 | * callback. */ | |
bd86fb99 HR |
2499 | if (child->klass->attach) { |
2500 | child->klass->attach(child); | |
8ee03995 KW |
2501 | } |
2502 | } | |
debc2927 HR |
2503 | |
2504 | /* | |
2505 | * If the old child node was drained but the new one is not, allow | |
2506 | * requests to come in only after the new node has been attached. | |
2507 | */ | |
bd86fb99 | 2508 | while (drain_saldo < 0 && child->klass->drained_end) { |
debc2927 HR |
2509 | bdrv_parent_drained_end_single(child); |
2510 | drain_saldo++; | |
2511 | } | |
8ee03995 | 2512 | } |
33a610c3 | 2513 | |
466787fb KW |
2514 | /* |
2515 | * Updates @child to change its reference to point to @new_bs, including | |
2516 | * checking and applying the necessary permisson updates both to the old node | |
2517 | * and to @new_bs. | |
2518 | * | |
2519 | * NULL is passed as @new_bs for removing the reference before freeing @child. | |
2520 | * | |
2521 | * If @new_bs is not NULL, bdrv_check_perm() must be called beforehand, as this | |
2522 | * function uses bdrv_set_perm() to update the permissions according to the new | |
2523 | * reference that @new_bs gets. | |
2524 | */ | |
2525 | static void bdrv_replace_child(BdrvChild *child, BlockDriverState *new_bs) | |
8ee03995 KW |
2526 | { |
2527 | BlockDriverState *old_bs = child->bs; | |
2528 | uint64_t perm, shared_perm; | |
2529 | ||
8aecf1d1 KW |
2530 | bdrv_replace_child_noperm(child, new_bs); |
2531 | ||
87ace5f8 HR |
2532 | /* |
2533 | * Start with the new node's permissions. If @new_bs is a (direct | |
2534 | * or indirect) child of @old_bs, we must complete the permission | |
2535 | * update on @new_bs before we loosen the restrictions on @old_bs. | |
2536 | * Otherwise, bdrv_check_perm() on @old_bs would re-initiate | |
2537 | * updating the permissions of @new_bs, and thus not purely loosen | |
2538 | * restrictions. | |
2539 | */ | |
2540 | if (new_bs) { | |
2541 | bdrv_get_cumulative_perm(new_bs, &perm, &shared_perm); | |
2542 | bdrv_set_perm(new_bs, perm, shared_perm); | |
2543 | } | |
2544 | ||
8ee03995 | 2545 | if (old_bs) { |
33a610c3 KW |
2546 | /* Update permissions for old node. This is guaranteed to succeed |
2547 | * because we're just taking a parent away, so we're loosening | |
2548 | * restrictions. */ | |
1046779e HR |
2549 | bool tighten_restrictions; |
2550 | int ret; | |
2551 | ||
33a610c3 | 2552 | bdrv_get_cumulative_perm(old_bs, &perm, &shared_perm); |
1046779e HR |
2553 | ret = bdrv_check_perm(old_bs, NULL, perm, shared_perm, NULL, |
2554 | &tighten_restrictions, NULL); | |
2555 | assert(tighten_restrictions == false); | |
2556 | if (ret < 0) { | |
2557 | /* We only tried to loosen restrictions, so errors are not fatal */ | |
2558 | bdrv_abort_perm_update(old_bs); | |
2559 | } else { | |
2560 | bdrv_set_perm(old_bs, perm, shared_perm); | |
2561 | } | |
ad943dcb KW |
2562 | |
2563 | /* When the parent requiring a non-default AioContext is removed, the | |
2564 | * node moves back to the main AioContext */ | |
2565 | bdrv_try_set_aio_context(old_bs, qemu_get_aio_context(), NULL); | |
e9740bc6 | 2566 | } |
e9740bc6 KW |
2567 | } |
2568 | ||
b441dc71 AG |
2569 | /* |
2570 | * This function steals the reference to child_bs from the caller. | |
2571 | * That reference is later dropped by bdrv_root_unref_child(). | |
2572 | * | |
2573 | * On failure NULL is returned, errp is set and the reference to | |
2574 | * child_bs is also dropped. | |
132ada80 KW |
2575 | * |
2576 | * The caller must hold the AioContext lock @child_bs, but not that of @ctx | |
2577 | * (unless @child_bs is already in @ctx). | |
b441dc71 | 2578 | */ |
f21d96d0 KW |
2579 | BdrvChild *bdrv_root_attach_child(BlockDriverState *child_bs, |
2580 | const char *child_name, | |
bd86fb99 | 2581 | const BdrvChildClass *child_class, |
258b7765 | 2582 | BdrvChildRole child_role, |
132ada80 | 2583 | AioContext *ctx, |
d5e6f437 KW |
2584 | uint64_t perm, uint64_t shared_perm, |
2585 | void *opaque, Error **errp) | |
df581792 | 2586 | { |
d5e6f437 | 2587 | BdrvChild *child; |
132ada80 | 2588 | Error *local_err = NULL; |
d5e6f437 KW |
2589 | int ret; |
2590 | ||
9eab1544 HR |
2591 | ret = bdrv_check_update_perm(child_bs, NULL, perm, shared_perm, NULL, NULL, |
2592 | errp); | |
d5e6f437 | 2593 | if (ret < 0) { |
33a610c3 | 2594 | bdrv_abort_perm_update(child_bs); |
b441dc71 | 2595 | bdrv_unref(child_bs); |
d5e6f437 KW |
2596 | return NULL; |
2597 | } | |
2598 | ||
2599 | child = g_new(BdrvChild, 1); | |
df581792 | 2600 | *child = (BdrvChild) { |
d5e6f437 KW |
2601 | .bs = NULL, |
2602 | .name = g_strdup(child_name), | |
bd86fb99 | 2603 | .klass = child_class, |
258b7765 | 2604 | .role = child_role, |
d5e6f437 KW |
2605 | .perm = perm, |
2606 | .shared_perm = shared_perm, | |
2607 | .opaque = opaque, | |
df581792 KW |
2608 | }; |
2609 | ||
132ada80 KW |
2610 | /* If the AioContexts don't match, first try to move the subtree of |
2611 | * child_bs into the AioContext of the new parent. If this doesn't work, | |
2612 | * try moving the parent into the AioContext of child_bs instead. */ | |
2613 | if (bdrv_get_aio_context(child_bs) != ctx) { | |
2614 | ret = bdrv_try_set_aio_context(child_bs, ctx, &local_err); | |
bd86fb99 | 2615 | if (ret < 0 && child_class->can_set_aio_ctx) { |
0beab811 | 2616 | GSList *ignore = g_slist_prepend(NULL, child); |
132ada80 | 2617 | ctx = bdrv_get_aio_context(child_bs); |
bd86fb99 | 2618 | if (child_class->can_set_aio_ctx(child, ctx, &ignore, NULL)) { |
132ada80 KW |
2619 | error_free(local_err); |
2620 | ret = 0; | |
2621 | g_slist_free(ignore); | |
0beab811 | 2622 | ignore = g_slist_prepend(NULL, child); |
bd86fb99 | 2623 | child_class->set_aio_ctx(child, ctx, &ignore); |
132ada80 KW |
2624 | } |
2625 | g_slist_free(ignore); | |
2626 | } | |
2627 | if (ret < 0) { | |
2628 | error_propagate(errp, local_err); | |
2629 | g_free(child); | |
2630 | bdrv_abort_perm_update(child_bs); | |
7a26df20 | 2631 | bdrv_unref(child_bs); |
132ada80 KW |
2632 | return NULL; |
2633 | } | |
2634 | } | |
2635 | ||
33a610c3 | 2636 | /* This performs the matching bdrv_set_perm() for the above check. */ |
466787fb | 2637 | bdrv_replace_child(child, child_bs); |
b4b059f6 KW |
2638 | |
2639 | return child; | |
df581792 KW |
2640 | } |
2641 | ||
b441dc71 AG |
2642 | /* |
2643 | * This function transfers the reference to child_bs from the caller | |
2644 | * to parent_bs. That reference is later dropped by parent_bs on | |
2645 | * bdrv_close() or if someone calls bdrv_unref_child(). | |
2646 | * | |
2647 | * On failure NULL is returned, errp is set and the reference to | |
2648 | * child_bs is also dropped. | |
132ada80 KW |
2649 | * |
2650 | * If @parent_bs and @child_bs are in different AioContexts, the caller must | |
2651 | * hold the AioContext lock for @child_bs, but not for @parent_bs. | |
b441dc71 | 2652 | */ |
98292c61 WC |
2653 | BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs, |
2654 | BlockDriverState *child_bs, | |
2655 | const char *child_name, | |
bd86fb99 | 2656 | const BdrvChildClass *child_class, |
258b7765 | 2657 | BdrvChildRole child_role, |
8b2ff529 | 2658 | Error **errp) |
f21d96d0 | 2659 | { |
d5e6f437 | 2660 | BdrvChild *child; |
f68c598b KW |
2661 | uint64_t perm, shared_perm; |
2662 | ||
2663 | bdrv_get_cumulative_perm(parent_bs, &perm, &shared_perm); | |
2664 | ||
2665 | assert(parent_bs->drv); | |
bf8e925e | 2666 | bdrv_child_perm(parent_bs, child_bs, NULL, child_class, child_role, NULL, |
ffd1a5a2 | 2667 | perm, shared_perm, &perm, &shared_perm); |
d5e6f437 | 2668 | |
bd86fb99 | 2669 | child = bdrv_root_attach_child(child_bs, child_name, child_class, |
258b7765 | 2670 | child_role, bdrv_get_aio_context(parent_bs), |
f68c598b | 2671 | perm, shared_perm, parent_bs, errp); |
d5e6f437 KW |
2672 | if (child == NULL) { |
2673 | return NULL; | |
2674 | } | |
2675 | ||
f21d96d0 KW |
2676 | QLIST_INSERT_HEAD(&parent_bs->children, child, next); |
2677 | return child; | |
2678 | } | |
2679 | ||
3f09bfbc | 2680 | static void bdrv_detach_child(BdrvChild *child) |
33a60407 | 2681 | { |
195ed8cb | 2682 | QLIST_SAFE_REMOVE(child, next); |
e9740bc6 | 2683 | |
466787fb | 2684 | bdrv_replace_child(child, NULL); |
e9740bc6 | 2685 | |
260fecf1 | 2686 | g_free(child->name); |
33a60407 KW |
2687 | g_free(child); |
2688 | } | |
2689 | ||
f21d96d0 | 2690 | void bdrv_root_unref_child(BdrvChild *child) |
33a60407 | 2691 | { |
779020cb KW |
2692 | BlockDriverState *child_bs; |
2693 | ||
f21d96d0 KW |
2694 | child_bs = child->bs; |
2695 | bdrv_detach_child(child); | |
2696 | bdrv_unref(child_bs); | |
2697 | } | |
2698 | ||
3cf746b3 HR |
2699 | /** |
2700 | * Clear all inherits_from pointers from children and grandchildren of | |
2701 | * @root that point to @root, where necessary. | |
2702 | */ | |
2703 | static void bdrv_unset_inherits_from(BlockDriverState *root, BdrvChild *child) | |
f21d96d0 | 2704 | { |
3cf746b3 | 2705 | BdrvChild *c; |
4e4bf5c4 | 2706 | |
3cf746b3 HR |
2707 | if (child->bs->inherits_from == root) { |
2708 | /* | |
2709 | * Remove inherits_from only when the last reference between root and | |
2710 | * child->bs goes away. | |
2711 | */ | |
2712 | QLIST_FOREACH(c, &root->children, next) { | |
4e4bf5c4 KW |
2713 | if (c != child && c->bs == child->bs) { |
2714 | break; | |
2715 | } | |
2716 | } | |
2717 | if (c == NULL) { | |
2718 | child->bs->inherits_from = NULL; | |
2719 | } | |
33a60407 KW |
2720 | } |
2721 | ||
3cf746b3 HR |
2722 | QLIST_FOREACH(c, &child->bs->children, next) { |
2723 | bdrv_unset_inherits_from(root, c); | |
2724 | } | |
2725 | } | |
2726 | ||
2727 | void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child) | |
2728 | { | |
2729 | if (child == NULL) { | |
2730 | return; | |
2731 | } | |
2732 | ||
2733 | bdrv_unset_inherits_from(parent, child); | |
f21d96d0 | 2734 | bdrv_root_unref_child(child); |
33a60407 KW |
2735 | } |
2736 | ||
5c8cab48 KW |
2737 | |
2738 | static void bdrv_parent_cb_change_media(BlockDriverState *bs, bool load) | |
2739 | { | |
2740 | BdrvChild *c; | |
2741 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
bd86fb99 HR |
2742 | if (c->klass->change_media) { |
2743 | c->klass->change_media(c, load); | |
5c8cab48 KW |
2744 | } |
2745 | } | |
2746 | } | |
2747 | ||
0065c455 AG |
2748 | /* Return true if you can reach parent going through child->inherits_from |
2749 | * recursively. If parent or child are NULL, return false */ | |
2750 | static bool bdrv_inherits_from_recursive(BlockDriverState *child, | |
2751 | BlockDriverState *parent) | |
2752 | { | |
2753 | while (child && child != parent) { | |
2754 | child = child->inherits_from; | |
2755 | } | |
2756 | ||
2757 | return child != NULL; | |
2758 | } | |
2759 | ||
5db15a57 KW |
2760 | /* |
2761 | * Sets the backing file link of a BDS. A new reference is created; callers | |
2762 | * which don't need their own reference any more must call bdrv_unref(). | |
2763 | */ | |
12fa4af6 KW |
2764 | void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd, |
2765 | Error **errp) | |
8d24cce1 | 2766 | { |
0065c455 AG |
2767 | bool update_inherits_from = bdrv_chain_contains(bs, backing_hd) && |
2768 | bdrv_inherits_from_recursive(backing_hd, bs); | |
2769 | ||
2cad1ebe AG |
2770 | if (bdrv_is_backing_chain_frozen(bs, backing_bs(bs), errp)) { |
2771 | return; | |
2772 | } | |
2773 | ||
5db15a57 KW |
2774 | if (backing_hd) { |
2775 | bdrv_ref(backing_hd); | |
2776 | } | |
8d24cce1 | 2777 | |
760e0063 | 2778 | if (bs->backing) { |
5db15a57 | 2779 | bdrv_unref_child(bs, bs->backing); |
6e57963a | 2780 | bs->backing = NULL; |
826b6ca0 FZ |
2781 | } |
2782 | ||
8d24cce1 FZ |
2783 | if (!backing_hd) { |
2784 | goto out; | |
2785 | } | |
12fa4af6 | 2786 | |
8b2ff529 | 2787 | bs->backing = bdrv_attach_child(bs, backing_hd, "backing", &child_backing, |
258b7765 | 2788 | 0, errp); |
0065c455 AG |
2789 | /* If backing_hd was already part of bs's backing chain, and |
2790 | * inherits_from pointed recursively to bs then let's update it to | |
2791 | * point directly to bs (else it will become NULL). */ | |
b441dc71 | 2792 | if (bs->backing && update_inherits_from) { |
0065c455 AG |
2793 | backing_hd->inherits_from = bs; |
2794 | } | |
826b6ca0 | 2795 | |
8d24cce1 | 2796 | out: |
3baca891 | 2797 | bdrv_refresh_limits(bs, NULL); |
8d24cce1 FZ |
2798 | } |
2799 | ||
31ca6d07 KW |
2800 | /* |
2801 | * Opens the backing file for a BlockDriverState if not yet open | |
2802 | * | |
d9b7b057 KW |
2803 | * bdref_key specifies the key for the image's BlockdevRef in the options QDict. |
2804 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
2805 | * itself, all options starting with "${bdref_key}." are considered part of the | |
2806 | * BlockdevRef. | |
2807 | * | |
2808 | * TODO Can this be unified with bdrv_open_image()? | |
31ca6d07 | 2809 | */ |
d9b7b057 KW |
2810 | int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options, |
2811 | const char *bdref_key, Error **errp) | |
9156df12 | 2812 | { |
6b6833c1 | 2813 | char *backing_filename = NULL; |
d9b7b057 KW |
2814 | char *bdref_key_dot; |
2815 | const char *reference = NULL; | |
317fc44e | 2816 | int ret = 0; |
998c2019 | 2817 | bool implicit_backing = false; |
8d24cce1 | 2818 | BlockDriverState *backing_hd; |
d9b7b057 KW |
2819 | QDict *options; |
2820 | QDict *tmp_parent_options = NULL; | |
34b5d2c6 | 2821 | Error *local_err = NULL; |
9156df12 | 2822 | |
760e0063 | 2823 | if (bs->backing != NULL) { |
1ba4b6a5 | 2824 | goto free_exit; |
9156df12 PB |
2825 | } |
2826 | ||
31ca6d07 | 2827 | /* NULL means an empty set of options */ |
d9b7b057 KW |
2828 | if (parent_options == NULL) { |
2829 | tmp_parent_options = qdict_new(); | |
2830 | parent_options = tmp_parent_options; | |
31ca6d07 KW |
2831 | } |
2832 | ||
9156df12 | 2833 | bs->open_flags &= ~BDRV_O_NO_BACKING; |
d9b7b057 KW |
2834 | |
2835 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); | |
2836 | qdict_extract_subqdict(parent_options, &options, bdref_key_dot); | |
2837 | g_free(bdref_key_dot); | |
2838 | ||
129c7d1c MA |
2839 | /* |
2840 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
2841 | * types would require more care. When @parent_options come from | |
2842 | * -blockdev or blockdev_add, its members are typed according to | |
2843 | * the QAPI schema, but when they come from -drive, they're all | |
2844 | * QString. | |
2845 | */ | |
d9b7b057 KW |
2846 | reference = qdict_get_try_str(parent_options, bdref_key); |
2847 | if (reference || qdict_haskey(options, "file.filename")) { | |
6b6833c1 | 2848 | /* keep backing_filename NULL */ |
1cb6f506 | 2849 | } else if (bs->backing_file[0] == '\0' && qdict_size(options) == 0) { |
cb3e7f08 | 2850 | qobject_unref(options); |
1ba4b6a5 | 2851 | goto free_exit; |
dbecebdd | 2852 | } else { |
998c2019 HR |
2853 | if (qdict_size(options) == 0) { |
2854 | /* If the user specifies options that do not modify the | |
2855 | * backing file's behavior, we might still consider it the | |
2856 | * implicit backing file. But it's easier this way, and | |
2857 | * just specifying some of the backing BDS's options is | |
2858 | * only possible with -drive anyway (otherwise the QAPI | |
2859 | * schema forces the user to specify everything). */ | |
2860 | implicit_backing = !strcmp(bs->auto_backing_file, bs->backing_file); | |
2861 | } | |
2862 | ||
6b6833c1 | 2863 | backing_filename = bdrv_get_full_backing_filename(bs, &local_err); |
9f07429e HR |
2864 | if (local_err) { |
2865 | ret = -EINVAL; | |
2866 | error_propagate(errp, local_err); | |
cb3e7f08 | 2867 | qobject_unref(options); |
9f07429e HR |
2868 | goto free_exit; |
2869 | } | |
9156df12 PB |
2870 | } |
2871 | ||
8ee79e70 KW |
2872 | if (!bs->drv || !bs->drv->supports_backing) { |
2873 | ret = -EINVAL; | |
2874 | error_setg(errp, "Driver doesn't support backing files"); | |
cb3e7f08 | 2875 | qobject_unref(options); |
8ee79e70 KW |
2876 | goto free_exit; |
2877 | } | |
2878 | ||
6bff597b PK |
2879 | if (!reference && |
2880 | bs->backing_format[0] != '\0' && !qdict_haskey(options, "driver")) { | |
46f5ac20 | 2881 | qdict_put_str(options, "driver", bs->backing_format); |
9156df12 PB |
2882 | } |
2883 | ||
6b6833c1 | 2884 | backing_hd = bdrv_open_inherit(backing_filename, reference, options, 0, bs, |
272c02ea | 2885 | &child_backing, 0, errp); |
5b363937 | 2886 | if (!backing_hd) { |
9156df12 | 2887 | bs->open_flags |= BDRV_O_NO_BACKING; |
e43bfd9c | 2888 | error_prepend(errp, "Could not open backing file: "); |
5b363937 | 2889 | ret = -EINVAL; |
1ba4b6a5 | 2890 | goto free_exit; |
9156df12 | 2891 | } |
df581792 | 2892 | |
998c2019 HR |
2893 | if (implicit_backing) { |
2894 | bdrv_refresh_filename(backing_hd); | |
2895 | pstrcpy(bs->auto_backing_file, sizeof(bs->auto_backing_file), | |
2896 | backing_hd->filename); | |
2897 | } | |
2898 | ||
5db15a57 KW |
2899 | /* Hook up the backing file link; drop our reference, bs owns the |
2900 | * backing_hd reference now */ | |
12fa4af6 | 2901 | bdrv_set_backing_hd(bs, backing_hd, &local_err); |
5db15a57 | 2902 | bdrv_unref(backing_hd); |
12fa4af6 | 2903 | if (local_err) { |
8cd1a3e4 | 2904 | error_propagate(errp, local_err); |
12fa4af6 KW |
2905 | ret = -EINVAL; |
2906 | goto free_exit; | |
2907 | } | |
d80ac658 | 2908 | |
d9b7b057 KW |
2909 | qdict_del(parent_options, bdref_key); |
2910 | ||
1ba4b6a5 BC |
2911 | free_exit: |
2912 | g_free(backing_filename); | |
cb3e7f08 | 2913 | qobject_unref(tmp_parent_options); |
1ba4b6a5 | 2914 | return ret; |
9156df12 PB |
2915 | } |
2916 | ||
2d6b86af KW |
2917 | static BlockDriverState * |
2918 | bdrv_open_child_bs(const char *filename, QDict *options, const char *bdref_key, | |
bd86fb99 | 2919 | BlockDriverState *parent, const BdrvChildClass *child_class, |
272c02ea | 2920 | BdrvChildRole child_role, bool allow_none, Error **errp) |
da557aac | 2921 | { |
2d6b86af | 2922 | BlockDriverState *bs = NULL; |
da557aac | 2923 | QDict *image_options; |
da557aac HR |
2924 | char *bdref_key_dot; |
2925 | const char *reference; | |
2926 | ||
bd86fb99 | 2927 | assert(child_class != NULL); |
f67503e5 | 2928 | |
da557aac HR |
2929 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); |
2930 | qdict_extract_subqdict(options, &image_options, bdref_key_dot); | |
2931 | g_free(bdref_key_dot); | |
2932 | ||
129c7d1c MA |
2933 | /* |
2934 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
2935 | * types would require more care. When @options come from | |
2936 | * -blockdev or blockdev_add, its members are typed according to | |
2937 | * the QAPI schema, but when they come from -drive, they're all | |
2938 | * QString. | |
2939 | */ | |
da557aac HR |
2940 | reference = qdict_get_try_str(options, bdref_key); |
2941 | if (!filename && !reference && !qdict_size(image_options)) { | |
b4b059f6 | 2942 | if (!allow_none) { |
da557aac HR |
2943 | error_setg(errp, "A block device must be specified for \"%s\"", |
2944 | bdref_key); | |
da557aac | 2945 | } |
cb3e7f08 | 2946 | qobject_unref(image_options); |
da557aac HR |
2947 | goto done; |
2948 | } | |
2949 | ||
5b363937 | 2950 | bs = bdrv_open_inherit(filename, reference, image_options, 0, |
272c02ea | 2951 | parent, child_class, child_role, errp); |
5b363937 | 2952 | if (!bs) { |
df581792 KW |
2953 | goto done; |
2954 | } | |
2955 | ||
da557aac HR |
2956 | done: |
2957 | qdict_del(options, bdref_key); | |
2d6b86af KW |
2958 | return bs; |
2959 | } | |
2960 | ||
2961 | /* | |
2962 | * Opens a disk image whose options are given as BlockdevRef in another block | |
2963 | * device's options. | |
2964 | * | |
2965 | * If allow_none is true, no image will be opened if filename is false and no | |
2966 | * BlockdevRef is given. NULL will be returned, but errp remains unset. | |
2967 | * | |
2968 | * bdrev_key specifies the key for the image's BlockdevRef in the options QDict. | |
2969 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
2970 | * itself, all options starting with "${bdref_key}." are considered part of the | |
2971 | * BlockdevRef. | |
2972 | * | |
2973 | * The BlockdevRef will be removed from the options QDict. | |
2974 | */ | |
2975 | BdrvChild *bdrv_open_child(const char *filename, | |
2976 | QDict *options, const char *bdref_key, | |
2977 | BlockDriverState *parent, | |
bd86fb99 | 2978 | const BdrvChildClass *child_class, |
258b7765 | 2979 | BdrvChildRole child_role, |
2d6b86af KW |
2980 | bool allow_none, Error **errp) |
2981 | { | |
2982 | BlockDriverState *bs; | |
2983 | ||
bd86fb99 | 2984 | bs = bdrv_open_child_bs(filename, options, bdref_key, parent, child_class, |
272c02ea | 2985 | child_role, allow_none, errp); |
2d6b86af KW |
2986 | if (bs == NULL) { |
2987 | return NULL; | |
2988 | } | |
2989 | ||
258b7765 HR |
2990 | return bdrv_attach_child(parent, bs, bdref_key, child_class, child_role, |
2991 | errp); | |
b4b059f6 KW |
2992 | } |
2993 | ||
bd86fb99 HR |
2994 | /* |
2995 | * TODO Future callers may need to specify parent/child_class in order for | |
2996 | * option inheritance to work. Existing callers use it for the root node. | |
2997 | */ | |
e1d74bc6 KW |
2998 | BlockDriverState *bdrv_open_blockdev_ref(BlockdevRef *ref, Error **errp) |
2999 | { | |
3000 | BlockDriverState *bs = NULL; | |
e1d74bc6 KW |
3001 | QObject *obj = NULL; |
3002 | QDict *qdict = NULL; | |
3003 | const char *reference = NULL; | |
3004 | Visitor *v = NULL; | |
3005 | ||
3006 | if (ref->type == QTYPE_QSTRING) { | |
3007 | reference = ref->u.reference; | |
3008 | } else { | |
3009 | BlockdevOptions *options = &ref->u.definition; | |
3010 | assert(ref->type == QTYPE_QDICT); | |
3011 | ||
3012 | v = qobject_output_visitor_new(&obj); | |
1f584248 | 3013 | visit_type_BlockdevOptions(v, NULL, &options, &error_abort); |
e1d74bc6 KW |
3014 | visit_complete(v, &obj); |
3015 | ||
7dc847eb | 3016 | qdict = qobject_to(QDict, obj); |
e1d74bc6 KW |
3017 | qdict_flatten(qdict); |
3018 | ||
3019 | /* bdrv_open_inherit() defaults to the values in bdrv_flags (for | |
3020 | * compatibility with other callers) rather than what we want as the | |
3021 | * real defaults. Apply the defaults here instead. */ | |
3022 | qdict_set_default_str(qdict, BDRV_OPT_CACHE_DIRECT, "off"); | |
3023 | qdict_set_default_str(qdict, BDRV_OPT_CACHE_NO_FLUSH, "off"); | |
3024 | qdict_set_default_str(qdict, BDRV_OPT_READ_ONLY, "off"); | |
e35bdc12 KW |
3025 | qdict_set_default_str(qdict, BDRV_OPT_AUTO_READ_ONLY, "off"); |
3026 | ||
e1d74bc6 KW |
3027 | } |
3028 | ||
272c02ea | 3029 | bs = bdrv_open_inherit(NULL, reference, qdict, 0, NULL, NULL, 0, errp); |
e1d74bc6 | 3030 | obj = NULL; |
cb3e7f08 | 3031 | qobject_unref(obj); |
e1d74bc6 KW |
3032 | visit_free(v); |
3033 | return bs; | |
3034 | } | |
3035 | ||
66836189 HR |
3036 | static BlockDriverState *bdrv_append_temp_snapshot(BlockDriverState *bs, |
3037 | int flags, | |
3038 | QDict *snapshot_options, | |
3039 | Error **errp) | |
b998875d KW |
3040 | { |
3041 | /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */ | |
1ba4b6a5 | 3042 | char *tmp_filename = g_malloc0(PATH_MAX + 1); |
b998875d | 3043 | int64_t total_size; |
83d0521a | 3044 | QemuOpts *opts = NULL; |
ff6ed714 | 3045 | BlockDriverState *bs_snapshot = NULL; |
b2c2832c | 3046 | Error *local_err = NULL; |
b998875d KW |
3047 | int ret; |
3048 | ||
3049 | /* if snapshot, we create a temporary backing file and open it | |
3050 | instead of opening 'filename' directly */ | |
3051 | ||
3052 | /* Get the required size from the image */ | |
f187743a KW |
3053 | total_size = bdrv_getlength(bs); |
3054 | if (total_size < 0) { | |
3055 | error_setg_errno(errp, -total_size, "Could not get image size"); | |
1ba4b6a5 | 3056 | goto out; |
f187743a | 3057 | } |
b998875d KW |
3058 | |
3059 | /* Create the temporary image */ | |
1ba4b6a5 | 3060 | ret = get_tmp_filename(tmp_filename, PATH_MAX + 1); |
b998875d KW |
3061 | if (ret < 0) { |
3062 | error_setg_errno(errp, -ret, "Could not get temporary filename"); | |
1ba4b6a5 | 3063 | goto out; |
b998875d KW |
3064 | } |
3065 | ||
ef810437 | 3066 | opts = qemu_opts_create(bdrv_qcow2.create_opts, NULL, 0, |
c282e1fd | 3067 | &error_abort); |
39101f25 | 3068 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_size, &error_abort); |
e43bfd9c | 3069 | ret = bdrv_create(&bdrv_qcow2, tmp_filename, opts, errp); |
83d0521a | 3070 | qemu_opts_del(opts); |
b998875d | 3071 | if (ret < 0) { |
e43bfd9c MA |
3072 | error_prepend(errp, "Could not create temporary overlay '%s': ", |
3073 | tmp_filename); | |
1ba4b6a5 | 3074 | goto out; |
b998875d KW |
3075 | } |
3076 | ||
73176bee | 3077 | /* Prepare options QDict for the temporary file */ |
46f5ac20 EB |
3078 | qdict_put_str(snapshot_options, "file.driver", "file"); |
3079 | qdict_put_str(snapshot_options, "file.filename", tmp_filename); | |
3080 | qdict_put_str(snapshot_options, "driver", "qcow2"); | |
b998875d | 3081 | |
5b363937 | 3082 | bs_snapshot = bdrv_open(NULL, NULL, snapshot_options, flags, errp); |
73176bee | 3083 | snapshot_options = NULL; |
5b363937 | 3084 | if (!bs_snapshot) { |
1ba4b6a5 | 3085 | goto out; |
b998875d KW |
3086 | } |
3087 | ||
ff6ed714 EB |
3088 | /* bdrv_append() consumes a strong reference to bs_snapshot |
3089 | * (i.e. it will call bdrv_unref() on it) even on error, so in | |
3090 | * order to be able to return one, we have to increase | |
3091 | * bs_snapshot's refcount here */ | |
66836189 | 3092 | bdrv_ref(bs_snapshot); |
b2c2832c KW |
3093 | bdrv_append(bs_snapshot, bs, &local_err); |
3094 | if (local_err) { | |
3095 | error_propagate(errp, local_err); | |
ff6ed714 | 3096 | bs_snapshot = NULL; |
b2c2832c KW |
3097 | goto out; |
3098 | } | |
1ba4b6a5 BC |
3099 | |
3100 | out: | |
cb3e7f08 | 3101 | qobject_unref(snapshot_options); |
1ba4b6a5 | 3102 | g_free(tmp_filename); |
ff6ed714 | 3103 | return bs_snapshot; |
b998875d KW |
3104 | } |
3105 | ||
b6ce07aa KW |
3106 | /* |
3107 | * Opens a disk image (raw, qcow2, vmdk, ...) | |
de9c0cec KW |
3108 | * |
3109 | * options is a QDict of options to pass to the block drivers, or NULL for an | |
3110 | * empty set of options. The reference to the QDict belongs to the block layer | |
3111 | * after the call (even on failure), so if the caller intends to reuse the | |
cb3e7f08 | 3112 | * dictionary, it needs to use qobject_ref() before calling bdrv_open. |
f67503e5 HR |
3113 | * |
3114 | * If *pbs is NULL, a new BDS will be created with a pointer to it stored there. | |
3115 | * If it is not NULL, the referenced BDS will be reused. | |
ddf5636d HR |
3116 | * |
3117 | * The reference parameter may be used to specify an existing block device which | |
3118 | * should be opened. If specified, neither options nor a filename may be given, | |
3119 | * nor can an existing BDS be reused (that is, *pbs has to be NULL). | |
b6ce07aa | 3120 | */ |
5b363937 HR |
3121 | static BlockDriverState *bdrv_open_inherit(const char *filename, |
3122 | const char *reference, | |
3123 | QDict *options, int flags, | |
3124 | BlockDriverState *parent, | |
bd86fb99 | 3125 | const BdrvChildClass *child_class, |
272c02ea | 3126 | BdrvChildRole child_role, |
5b363937 | 3127 | Error **errp) |
ea2384d3 | 3128 | { |
b6ce07aa | 3129 | int ret; |
5696c6e3 | 3130 | BlockBackend *file = NULL; |
9a4f4c31 | 3131 | BlockDriverState *bs; |
ce343771 | 3132 | BlockDriver *drv = NULL; |
2f624b80 | 3133 | BdrvChild *child; |
74fe54f2 | 3134 | const char *drvname; |
3e8c2e57 | 3135 | const char *backing; |
34b5d2c6 | 3136 | Error *local_err = NULL; |
73176bee | 3137 | QDict *snapshot_options = NULL; |
b1e6fc08 | 3138 | int snapshot_flags = 0; |
712e7874 | 3139 | |
bd86fb99 HR |
3140 | assert(!child_class || !flags); |
3141 | assert(!child_class == !parent); | |
f67503e5 | 3142 | |
ddf5636d HR |
3143 | if (reference) { |
3144 | bool options_non_empty = options ? qdict_size(options) : false; | |
cb3e7f08 | 3145 | qobject_unref(options); |
ddf5636d | 3146 | |
ddf5636d HR |
3147 | if (filename || options_non_empty) { |
3148 | error_setg(errp, "Cannot reference an existing block device with " | |
3149 | "additional options or a new filename"); | |
5b363937 | 3150 | return NULL; |
ddf5636d HR |
3151 | } |
3152 | ||
3153 | bs = bdrv_lookup_bs(reference, reference, errp); | |
3154 | if (!bs) { | |
5b363937 | 3155 | return NULL; |
ddf5636d | 3156 | } |
76b22320 | 3157 | |
ddf5636d | 3158 | bdrv_ref(bs); |
5b363937 | 3159 | return bs; |
ddf5636d HR |
3160 | } |
3161 | ||
5b363937 | 3162 | bs = bdrv_new(); |
f67503e5 | 3163 | |
de9c0cec KW |
3164 | /* NULL means an empty set of options */ |
3165 | if (options == NULL) { | |
3166 | options = qdict_new(); | |
3167 | } | |
3168 | ||
145f598e | 3169 | /* json: syntax counts as explicit options, as if in the QDict */ |
de3b53f0 KW |
3170 | parse_json_protocol(options, &filename, &local_err); |
3171 | if (local_err) { | |
de3b53f0 KW |
3172 | goto fail; |
3173 | } | |
3174 | ||
145f598e KW |
3175 | bs->explicit_options = qdict_clone_shallow(options); |
3176 | ||
bd86fb99 | 3177 | if (child_class) { |
3cdc69d3 HR |
3178 | bool parent_is_format; |
3179 | ||
3180 | if (parent->drv) { | |
3181 | parent_is_format = parent->drv->is_format; | |
3182 | } else { | |
3183 | /* | |
3184 | * parent->drv is not set yet because this node is opened for | |
3185 | * (potential) format probing. That means that @parent is going | |
3186 | * to be a format node. | |
3187 | */ | |
3188 | parent_is_format = true; | |
3189 | } | |
3190 | ||
bddcec37 | 3191 | bs->inherits_from = parent; |
3cdc69d3 HR |
3192 | child_class->inherit_options(child_role, parent_is_format, |
3193 | &flags, options, | |
bd86fb99 | 3194 | parent->open_flags, parent->options); |
f3930ed0 KW |
3195 | } |
3196 | ||
de3b53f0 | 3197 | ret = bdrv_fill_options(&options, filename, &flags, &local_err); |
dfde483e | 3198 | if (ret < 0) { |
462f5bcf KW |
3199 | goto fail; |
3200 | } | |
3201 | ||
129c7d1c MA |
3202 | /* |
3203 | * Set the BDRV_O_RDWR and BDRV_O_ALLOW_RDWR flags. | |
3204 | * Caution: getting a boolean member of @options requires care. | |
3205 | * When @options come from -blockdev or blockdev_add, members are | |
3206 | * typed according to the QAPI schema, but when they come from | |
3207 | * -drive, they're all QString. | |
3208 | */ | |
f87a0e29 AG |
3209 | if (g_strcmp0(qdict_get_try_str(options, BDRV_OPT_READ_ONLY), "on") && |
3210 | !qdict_get_try_bool(options, BDRV_OPT_READ_ONLY, false)) { | |
3211 | flags |= (BDRV_O_RDWR | BDRV_O_ALLOW_RDWR); | |
3212 | } else { | |
3213 | flags &= ~BDRV_O_RDWR; | |
14499ea5 AG |
3214 | } |
3215 | ||
3216 | if (flags & BDRV_O_SNAPSHOT) { | |
3217 | snapshot_options = qdict_new(); | |
3218 | bdrv_temp_snapshot_options(&snapshot_flags, snapshot_options, | |
3219 | flags, options); | |
f87a0e29 AG |
3220 | /* Let bdrv_backing_options() override "read-only" */ |
3221 | qdict_del(options, BDRV_OPT_READ_ONLY); | |
3cdc69d3 | 3222 | bdrv_backing_options(0, true, &flags, options, flags, options); |
14499ea5 AG |
3223 | } |
3224 | ||
62392ebb KW |
3225 | bs->open_flags = flags; |
3226 | bs->options = options; | |
3227 | options = qdict_clone_shallow(options); | |
3228 | ||
76c591b0 | 3229 | /* Find the right image format driver */ |
129c7d1c | 3230 | /* See cautionary note on accessing @options above */ |
76c591b0 KW |
3231 | drvname = qdict_get_try_str(options, "driver"); |
3232 | if (drvname) { | |
3233 | drv = bdrv_find_format(drvname); | |
76c591b0 KW |
3234 | if (!drv) { |
3235 | error_setg(errp, "Unknown driver: '%s'", drvname); | |
76c591b0 KW |
3236 | goto fail; |
3237 | } | |
3238 | } | |
3239 | ||
3240 | assert(drvname || !(flags & BDRV_O_PROTOCOL)); | |
76c591b0 | 3241 | |
129c7d1c | 3242 | /* See cautionary note on accessing @options above */ |
3e8c2e57 | 3243 | backing = qdict_get_try_str(options, "backing"); |
e59a0cf1 HR |
3244 | if (qobject_to(QNull, qdict_get(options, "backing")) != NULL || |
3245 | (backing && *backing == '\0')) | |
3246 | { | |
4f7be280 HR |
3247 | if (backing) { |
3248 | warn_report("Use of \"backing\": \"\" is deprecated; " | |
3249 | "use \"backing\": null instead"); | |
3250 | } | |
3e8c2e57 | 3251 | flags |= BDRV_O_NO_BACKING; |
ae0f57f0 KW |
3252 | qdict_del(bs->explicit_options, "backing"); |
3253 | qdict_del(bs->options, "backing"); | |
3e8c2e57 AG |
3254 | qdict_del(options, "backing"); |
3255 | } | |
3256 | ||
5696c6e3 | 3257 | /* Open image file without format layer. This BlockBackend is only used for |
4e4bf5c4 KW |
3258 | * probing, the block drivers will do their own bdrv_open_child() for the |
3259 | * same BDS, which is why we put the node name back into options. */ | |
f4788adc | 3260 | if ((flags & BDRV_O_PROTOCOL) == 0) { |
5696c6e3 KW |
3261 | BlockDriverState *file_bs; |
3262 | ||
3263 | file_bs = bdrv_open_child_bs(filename, options, "file", bs, | |
272c02ea | 3264 | &child_file, 0, true, &local_err); |
1fdd6933 | 3265 | if (local_err) { |
f4788adc KW |
3266 | goto fail; |
3267 | } | |
5696c6e3 | 3268 | if (file_bs != NULL) { |
dacaa162 KW |
3269 | /* Not requesting BLK_PERM_CONSISTENT_READ because we're only |
3270 | * looking at the header to guess the image format. This works even | |
3271 | * in cases where a guest would not see a consistent state. */ | |
d861ab3a | 3272 | file = blk_new(bdrv_get_aio_context(file_bs), 0, BLK_PERM_ALL); |
d7086422 | 3273 | blk_insert_bs(file, file_bs, &local_err); |
5696c6e3 | 3274 | bdrv_unref(file_bs); |
d7086422 KW |
3275 | if (local_err) { |
3276 | goto fail; | |
3277 | } | |
5696c6e3 | 3278 | |
46f5ac20 | 3279 | qdict_put_str(options, "file", bdrv_get_node_name(file_bs)); |
4e4bf5c4 | 3280 | } |
f500a6d3 KW |
3281 | } |
3282 | ||
76c591b0 | 3283 | /* Image format probing */ |
38f3ef57 | 3284 | bs->probed = !drv; |
76c591b0 | 3285 | if (!drv && file) { |
cf2ab8fc | 3286 | ret = find_image_format(file, filename, &drv, &local_err); |
17b005f1 | 3287 | if (ret < 0) { |
8bfea15d | 3288 | goto fail; |
2a05cbe4 | 3289 | } |
62392ebb KW |
3290 | /* |
3291 | * This option update would logically belong in bdrv_fill_options(), | |
3292 | * but we first need to open bs->file for the probing to work, while | |
3293 | * opening bs->file already requires the (mostly) final set of options | |
3294 | * so that cache mode etc. can be inherited. | |
3295 | * | |
3296 | * Adding the driver later is somewhat ugly, but it's not an option | |
3297 | * that would ever be inherited, so it's correct. We just need to make | |
3298 | * sure to update both bs->options (which has the full effective | |
3299 | * options for bs) and options (which has file.* already removed). | |
3300 | */ | |
46f5ac20 EB |
3301 | qdict_put_str(bs->options, "driver", drv->format_name); |
3302 | qdict_put_str(options, "driver", drv->format_name); | |
76c591b0 | 3303 | } else if (!drv) { |
17b005f1 | 3304 | error_setg(errp, "Must specify either driver or file"); |
8bfea15d | 3305 | goto fail; |
ea2384d3 | 3306 | } |
b6ce07aa | 3307 | |
53a29513 HR |
3308 | /* BDRV_O_PROTOCOL must be set iff a protocol BDS is about to be created */ |
3309 | assert(!!(flags & BDRV_O_PROTOCOL) == !!drv->bdrv_file_open); | |
3310 | /* file must be NULL if a protocol BDS is about to be created | |
3311 | * (the inverse results in an error message from bdrv_open_common()) */ | |
3312 | assert(!(flags & BDRV_O_PROTOCOL) || !file); | |
3313 | ||
b6ce07aa | 3314 | /* Open the image */ |
82dc8b41 | 3315 | ret = bdrv_open_common(bs, file, options, &local_err); |
b6ce07aa | 3316 | if (ret < 0) { |
8bfea15d | 3317 | goto fail; |
6987307c CH |
3318 | } |
3319 | ||
4e4bf5c4 | 3320 | if (file) { |
5696c6e3 | 3321 | blk_unref(file); |
f500a6d3 KW |
3322 | file = NULL; |
3323 | } | |
3324 | ||
b6ce07aa | 3325 | /* If there is a backing file, use it */ |
9156df12 | 3326 | if ((flags & BDRV_O_NO_BACKING) == 0) { |
d9b7b057 | 3327 | ret = bdrv_open_backing_file(bs, options, "backing", &local_err); |
b6ce07aa | 3328 | if (ret < 0) { |
b6ad491a | 3329 | goto close_and_fail; |
b6ce07aa | 3330 | } |
b6ce07aa KW |
3331 | } |
3332 | ||
50196d7a AG |
3333 | /* Remove all children options and references |
3334 | * from bs->options and bs->explicit_options */ | |
2f624b80 AG |
3335 | QLIST_FOREACH(child, &bs->children, next) { |
3336 | char *child_key_dot; | |
3337 | child_key_dot = g_strdup_printf("%s.", child->name); | |
3338 | qdict_extract_subqdict(bs->explicit_options, NULL, child_key_dot); | |
3339 | qdict_extract_subqdict(bs->options, NULL, child_key_dot); | |
50196d7a AG |
3340 | qdict_del(bs->explicit_options, child->name); |
3341 | qdict_del(bs->options, child->name); | |
2f624b80 AG |
3342 | g_free(child_key_dot); |
3343 | } | |
3344 | ||
b6ad491a | 3345 | /* Check if any unknown options were used */ |
7ad2757f | 3346 | if (qdict_size(options) != 0) { |
b6ad491a | 3347 | const QDictEntry *entry = qdict_first(options); |
5acd9d81 HR |
3348 | if (flags & BDRV_O_PROTOCOL) { |
3349 | error_setg(errp, "Block protocol '%s' doesn't support the option " | |
3350 | "'%s'", drv->format_name, entry->key); | |
3351 | } else { | |
d0e46a55 HR |
3352 | error_setg(errp, |
3353 | "Block format '%s' does not support the option '%s'", | |
3354 | drv->format_name, entry->key); | |
5acd9d81 | 3355 | } |
b6ad491a | 3356 | |
b6ad491a KW |
3357 | goto close_and_fail; |
3358 | } | |
b6ad491a | 3359 | |
c01c214b | 3360 | bdrv_parent_cb_change_media(bs, true); |
b6ce07aa | 3361 | |
cb3e7f08 | 3362 | qobject_unref(options); |
8961be33 | 3363 | options = NULL; |
dd62f1ca KW |
3364 | |
3365 | /* For snapshot=on, create a temporary qcow2 overlay. bs points to the | |
3366 | * temporary snapshot afterwards. */ | |
3367 | if (snapshot_flags) { | |
66836189 HR |
3368 | BlockDriverState *snapshot_bs; |
3369 | snapshot_bs = bdrv_append_temp_snapshot(bs, snapshot_flags, | |
3370 | snapshot_options, &local_err); | |
73176bee | 3371 | snapshot_options = NULL; |
dd62f1ca KW |
3372 | if (local_err) { |
3373 | goto close_and_fail; | |
3374 | } | |
5b363937 HR |
3375 | /* We are not going to return bs but the overlay on top of it |
3376 | * (snapshot_bs); thus, we have to drop the strong reference to bs | |
3377 | * (which we obtained by calling bdrv_new()). bs will not be deleted, | |
3378 | * though, because the overlay still has a reference to it. */ | |
3379 | bdrv_unref(bs); | |
3380 | bs = snapshot_bs; | |
dd62f1ca KW |
3381 | } |
3382 | ||
5b363937 | 3383 | return bs; |
b6ce07aa | 3384 | |
8bfea15d | 3385 | fail: |
5696c6e3 | 3386 | blk_unref(file); |
cb3e7f08 MAL |
3387 | qobject_unref(snapshot_options); |
3388 | qobject_unref(bs->explicit_options); | |
3389 | qobject_unref(bs->options); | |
3390 | qobject_unref(options); | |
de9c0cec | 3391 | bs->options = NULL; |
998cbd6a | 3392 | bs->explicit_options = NULL; |
5b363937 | 3393 | bdrv_unref(bs); |
621ff94d | 3394 | error_propagate(errp, local_err); |
5b363937 | 3395 | return NULL; |
de9c0cec | 3396 | |
b6ad491a | 3397 | close_and_fail: |
5b363937 | 3398 | bdrv_unref(bs); |
cb3e7f08 MAL |
3399 | qobject_unref(snapshot_options); |
3400 | qobject_unref(options); | |
621ff94d | 3401 | error_propagate(errp, local_err); |
5b363937 | 3402 | return NULL; |
b6ce07aa KW |
3403 | } |
3404 | ||
5b363937 HR |
3405 | BlockDriverState *bdrv_open(const char *filename, const char *reference, |
3406 | QDict *options, int flags, Error **errp) | |
f3930ed0 | 3407 | { |
5b363937 | 3408 | return bdrv_open_inherit(filename, reference, options, flags, NULL, |
272c02ea | 3409 | NULL, 0, errp); |
f3930ed0 KW |
3410 | } |
3411 | ||
faf116b4 AG |
3412 | /* Return true if the NULL-terminated @list contains @str */ |
3413 | static bool is_str_in_list(const char *str, const char *const *list) | |
3414 | { | |
3415 | if (str && list) { | |
3416 | int i; | |
3417 | for (i = 0; list[i] != NULL; i++) { | |
3418 | if (!strcmp(str, list[i])) { | |
3419 | return true; | |
3420 | } | |
3421 | } | |
3422 | } | |
3423 | return false; | |
3424 | } | |
3425 | ||
3426 | /* | |
3427 | * Check that every option set in @bs->options is also set in | |
3428 | * @new_opts. | |
3429 | * | |
3430 | * Options listed in the common_options list and in | |
3431 | * @bs->drv->mutable_opts are skipped. | |
3432 | * | |
3433 | * Return 0 on success, otherwise return -EINVAL and set @errp. | |
3434 | */ | |
3435 | static int bdrv_reset_options_allowed(BlockDriverState *bs, | |
3436 | const QDict *new_opts, Error **errp) | |
3437 | { | |
3438 | const QDictEntry *e; | |
3439 | /* These options are common to all block drivers and are handled | |
3440 | * in bdrv_reopen_prepare() so they can be left out of @new_opts */ | |
3441 | const char *const common_options[] = { | |
3442 | "node-name", "discard", "cache.direct", "cache.no-flush", | |
3443 | "read-only", "auto-read-only", "detect-zeroes", NULL | |
3444 | }; | |
3445 | ||
3446 | for (e = qdict_first(bs->options); e; e = qdict_next(bs->options, e)) { | |
3447 | if (!qdict_haskey(new_opts, e->key) && | |
3448 | !is_str_in_list(e->key, common_options) && | |
3449 | !is_str_in_list(e->key, bs->drv->mutable_opts)) { | |
3450 | error_setg(errp, "Option '%s' cannot be reset " | |
3451 | "to its default value", e->key); | |
3452 | return -EINVAL; | |
3453 | } | |
3454 | } | |
3455 | ||
3456 | return 0; | |
3457 | } | |
3458 | ||
cb828c31 AG |
3459 | /* |
3460 | * Returns true if @child can be reached recursively from @bs | |
3461 | */ | |
3462 | static bool bdrv_recurse_has_child(BlockDriverState *bs, | |
3463 | BlockDriverState *child) | |
3464 | { | |
3465 | BdrvChild *c; | |
3466 | ||
3467 | if (bs == child) { | |
3468 | return true; | |
3469 | } | |
3470 | ||
3471 | QLIST_FOREACH(c, &bs->children, next) { | |
3472 | if (bdrv_recurse_has_child(c->bs, child)) { | |
3473 | return true; | |
3474 | } | |
3475 | } | |
3476 | ||
3477 | return false; | |
3478 | } | |
3479 | ||
e971aa12 JC |
3480 | /* |
3481 | * Adds a BlockDriverState to a simple queue for an atomic, transactional | |
3482 | * reopen of multiple devices. | |
3483 | * | |
859443b0 | 3484 | * bs_queue can either be an existing BlockReopenQueue that has had QTAILQ_INIT |
e971aa12 JC |
3485 | * already performed, or alternatively may be NULL a new BlockReopenQueue will |
3486 | * be created and initialized. This newly created BlockReopenQueue should be | |
3487 | * passed back in for subsequent calls that are intended to be of the same | |
3488 | * atomic 'set'. | |
3489 | * | |
3490 | * bs is the BlockDriverState to add to the reopen queue. | |
3491 | * | |
4d2cb092 KW |
3492 | * options contains the changed options for the associated bs |
3493 | * (the BlockReopenQueue takes ownership) | |
3494 | * | |
e971aa12 JC |
3495 | * flags contains the open flags for the associated bs |
3496 | * | |
3497 | * returns a pointer to bs_queue, which is either the newly allocated | |
3498 | * bs_queue, or the existing bs_queue being used. | |
3499 | * | |
1a63a907 | 3500 | * bs must be drained between bdrv_reopen_queue() and bdrv_reopen_multiple(). |
e971aa12 | 3501 | */ |
28518102 KW |
3502 | static BlockReopenQueue *bdrv_reopen_queue_child(BlockReopenQueue *bs_queue, |
3503 | BlockDriverState *bs, | |
3504 | QDict *options, | |
bd86fb99 | 3505 | const BdrvChildClass *klass, |
272c02ea | 3506 | BdrvChildRole role, |
3cdc69d3 | 3507 | bool parent_is_format, |
28518102 | 3508 | QDict *parent_options, |
077e8e20 AG |
3509 | int parent_flags, |
3510 | bool keep_old_opts) | |
e971aa12 JC |
3511 | { |
3512 | assert(bs != NULL); | |
3513 | ||
3514 | BlockReopenQueueEntry *bs_entry; | |
67251a31 | 3515 | BdrvChild *child; |
9aa09ddd AG |
3516 | QDict *old_options, *explicit_options, *options_copy; |
3517 | int flags; | |
3518 | QemuOpts *opts; | |
67251a31 | 3519 | |
1a63a907 KW |
3520 | /* Make sure that the caller remembered to use a drained section. This is |
3521 | * important to avoid graph changes between the recursive queuing here and | |
3522 | * bdrv_reopen_multiple(). */ | |
3523 | assert(bs->quiesce_counter > 0); | |
3524 | ||
e971aa12 JC |
3525 | if (bs_queue == NULL) { |
3526 | bs_queue = g_new0(BlockReopenQueue, 1); | |
859443b0 | 3527 | QTAILQ_INIT(bs_queue); |
e971aa12 JC |
3528 | } |
3529 | ||
4d2cb092 KW |
3530 | if (!options) { |
3531 | options = qdict_new(); | |
3532 | } | |
3533 | ||
5b7ba05f | 3534 | /* Check if this BlockDriverState is already in the queue */ |
859443b0 | 3535 | QTAILQ_FOREACH(bs_entry, bs_queue, entry) { |
5b7ba05f AG |
3536 | if (bs == bs_entry->state.bs) { |
3537 | break; | |
3538 | } | |
3539 | } | |
3540 | ||
28518102 KW |
3541 | /* |
3542 | * Precedence of options: | |
3543 | * 1. Explicitly passed in options (highest) | |
9aa09ddd AG |
3544 | * 2. Retained from explicitly set options of bs |
3545 | * 3. Inherited from parent node | |
3546 | * 4. Retained from effective options of bs | |
28518102 KW |
3547 | */ |
3548 | ||
145f598e | 3549 | /* Old explicitly set values (don't overwrite by inherited value) */ |
077e8e20 AG |
3550 | if (bs_entry || keep_old_opts) { |
3551 | old_options = qdict_clone_shallow(bs_entry ? | |
3552 | bs_entry->state.explicit_options : | |
3553 | bs->explicit_options); | |
3554 | bdrv_join_options(bs, options, old_options); | |
3555 | qobject_unref(old_options); | |
5b7ba05f | 3556 | } |
145f598e KW |
3557 | |
3558 | explicit_options = qdict_clone_shallow(options); | |
3559 | ||
28518102 KW |
3560 | /* Inherit from parent node */ |
3561 | if (parent_options) { | |
9aa09ddd | 3562 | flags = 0; |
3cdc69d3 | 3563 | klass->inherit_options(role, parent_is_format, &flags, options, |
272c02ea | 3564 | parent_flags, parent_options); |
9aa09ddd AG |
3565 | } else { |
3566 | flags = bdrv_get_flags(bs); | |
28518102 KW |
3567 | } |
3568 | ||
077e8e20 AG |
3569 | if (keep_old_opts) { |
3570 | /* Old values are used for options that aren't set yet */ | |
3571 | old_options = qdict_clone_shallow(bs->options); | |
3572 | bdrv_join_options(bs, options, old_options); | |
3573 | qobject_unref(old_options); | |
3574 | } | |
4d2cb092 | 3575 | |
9aa09ddd AG |
3576 | /* We have the final set of options so let's update the flags */ |
3577 | options_copy = qdict_clone_shallow(options); | |
3578 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); | |
3579 | qemu_opts_absorb_qdict(opts, options_copy, NULL); | |
3580 | update_flags_from_options(&flags, opts); | |
3581 | qemu_opts_del(opts); | |
3582 | qobject_unref(options_copy); | |
3583 | ||
fd452021 | 3584 | /* bdrv_open_inherit() sets and clears some additional flags internally */ |
f1f25a2e | 3585 | flags &= ~BDRV_O_PROTOCOL; |
fd452021 KW |
3586 | if (flags & BDRV_O_RDWR) { |
3587 | flags |= BDRV_O_ALLOW_RDWR; | |
3588 | } | |
f1f25a2e | 3589 | |
1857c97b KW |
3590 | if (!bs_entry) { |
3591 | bs_entry = g_new0(BlockReopenQueueEntry, 1); | |
859443b0 | 3592 | QTAILQ_INSERT_TAIL(bs_queue, bs_entry, entry); |
1857c97b | 3593 | } else { |
cb3e7f08 MAL |
3594 | qobject_unref(bs_entry->state.options); |
3595 | qobject_unref(bs_entry->state.explicit_options); | |
1857c97b KW |
3596 | } |
3597 | ||
3598 | bs_entry->state.bs = bs; | |
3599 | bs_entry->state.options = options; | |
3600 | bs_entry->state.explicit_options = explicit_options; | |
3601 | bs_entry->state.flags = flags; | |
3602 | ||
30450259 KW |
3603 | /* This needs to be overwritten in bdrv_reopen_prepare() */ |
3604 | bs_entry->state.perm = UINT64_MAX; | |
3605 | bs_entry->state.shared_perm = 0; | |
3606 | ||
8546632e AG |
3607 | /* |
3608 | * If keep_old_opts is false then it means that unspecified | |
3609 | * options must be reset to their original value. We don't allow | |
3610 | * resetting 'backing' but we need to know if the option is | |
3611 | * missing in order to decide if we have to return an error. | |
3612 | */ | |
3613 | if (!keep_old_opts) { | |
3614 | bs_entry->state.backing_missing = | |
3615 | !qdict_haskey(options, "backing") && | |
3616 | !qdict_haskey(options, "backing.driver"); | |
3617 | } | |
3618 | ||
67251a31 | 3619 | QLIST_FOREACH(child, &bs->children, next) { |
8546632e AG |
3620 | QDict *new_child_options = NULL; |
3621 | bool child_keep_old = keep_old_opts; | |
67251a31 | 3622 | |
4c9dfe5d KW |
3623 | /* reopen can only change the options of block devices that were |
3624 | * implicitly created and inherited options. For other (referenced) | |
3625 | * block devices, a syntax like "backing.foo" results in an error. */ | |
67251a31 KW |
3626 | if (child->bs->inherits_from != bs) { |
3627 | continue; | |
3628 | } | |
3629 | ||
8546632e AG |
3630 | /* Check if the options contain a child reference */ |
3631 | if (qdict_haskey(options, child->name)) { | |
3632 | const char *childref = qdict_get_try_str(options, child->name); | |
3633 | /* | |
3634 | * The current child must not be reopened if the child | |
3635 | * reference is null or points to a different node. | |
3636 | */ | |
3637 | if (g_strcmp0(childref, child->bs->node_name)) { | |
3638 | continue; | |
3639 | } | |
3640 | /* | |
3641 | * If the child reference points to the current child then | |
3642 | * reopen it with its existing set of options (note that | |
3643 | * it can still inherit new options from the parent). | |
3644 | */ | |
3645 | child_keep_old = true; | |
3646 | } else { | |
3647 | /* Extract child options ("child-name.*") */ | |
3648 | char *child_key_dot = g_strdup_printf("%s.", child->name); | |
3649 | qdict_extract_subqdict(explicit_options, NULL, child_key_dot); | |
3650 | qdict_extract_subqdict(options, &new_child_options, child_key_dot); | |
3651 | g_free(child_key_dot); | |
3652 | } | |
4c9dfe5d | 3653 | |
9aa09ddd | 3654 | bdrv_reopen_queue_child(bs_queue, child->bs, new_child_options, |
3cdc69d3 HR |
3655 | child->klass, child->role, bs->drv->is_format, |
3656 | options, flags, child_keep_old); | |
e971aa12 JC |
3657 | } |
3658 | ||
e971aa12 JC |
3659 | return bs_queue; |
3660 | } | |
3661 | ||
28518102 KW |
3662 | BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue, |
3663 | BlockDriverState *bs, | |
077e8e20 | 3664 | QDict *options, bool keep_old_opts) |
28518102 | 3665 | { |
3cdc69d3 HR |
3666 | return bdrv_reopen_queue_child(bs_queue, bs, options, NULL, 0, false, |
3667 | NULL, 0, keep_old_opts); | |
28518102 KW |
3668 | } |
3669 | ||
e971aa12 JC |
3670 | /* |
3671 | * Reopen multiple BlockDriverStates atomically & transactionally. | |
3672 | * | |
3673 | * The queue passed in (bs_queue) must have been built up previous | |
3674 | * via bdrv_reopen_queue(). | |
3675 | * | |
3676 | * Reopens all BDS specified in the queue, with the appropriate | |
3677 | * flags. All devices are prepared for reopen, and failure of any | |
50d6a8a3 | 3678 | * device will cause all device changes to be abandoned, and intermediate |
e971aa12 JC |
3679 | * data cleaned up. |
3680 | * | |
3681 | * If all devices prepare successfully, then the changes are committed | |
3682 | * to all devices. | |
3683 | * | |
1a63a907 KW |
3684 | * All affected nodes must be drained between bdrv_reopen_queue() and |
3685 | * bdrv_reopen_multiple(). | |
e971aa12 | 3686 | */ |
5019aece | 3687 | int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp) |
e971aa12 JC |
3688 | { |
3689 | int ret = -1; | |
3690 | BlockReopenQueueEntry *bs_entry, *next; | |
e971aa12 JC |
3691 | |
3692 | assert(bs_queue != NULL); | |
3693 | ||
859443b0 | 3694 | QTAILQ_FOREACH(bs_entry, bs_queue, entry) { |
1a63a907 | 3695 | assert(bs_entry->state.bs->quiesce_counter > 0); |
a4615ab3 | 3696 | if (bdrv_reopen_prepare(&bs_entry->state, bs_queue, errp)) { |
e971aa12 JC |
3697 | goto cleanup; |
3698 | } | |
3699 | bs_entry->prepared = true; | |
3700 | } | |
3701 | ||
859443b0 | 3702 | QTAILQ_FOREACH(bs_entry, bs_queue, entry) { |
69b736e7 KW |
3703 | BDRVReopenState *state = &bs_entry->state; |
3704 | ret = bdrv_check_perm(state->bs, bs_queue, state->perm, | |
9eab1544 | 3705 | state->shared_perm, NULL, NULL, errp); |
69b736e7 KW |
3706 | if (ret < 0) { |
3707 | goto cleanup_perm; | |
3708 | } | |
cb828c31 AG |
3709 | /* Check if new_backing_bs would accept the new permissions */ |
3710 | if (state->replace_backing_bs && state->new_backing_bs) { | |
3711 | uint64_t nperm, nshared; | |
3712 | bdrv_child_perm(state->bs, state->new_backing_bs, | |
bf8e925e | 3713 | NULL, &child_backing, 0, bs_queue, |
cb828c31 AG |
3714 | state->perm, state->shared_perm, |
3715 | &nperm, &nshared); | |
3716 | ret = bdrv_check_update_perm(state->new_backing_bs, NULL, | |
9eab1544 | 3717 | nperm, nshared, NULL, NULL, errp); |
cb828c31 AG |
3718 | if (ret < 0) { |
3719 | goto cleanup_perm; | |
3720 | } | |
3721 | } | |
69b736e7 KW |
3722 | bs_entry->perms_checked = true; |
3723 | } | |
3724 | ||
fcd6a4f4 VSO |
3725 | /* |
3726 | * If we reach this point, we have success and just need to apply the | |
3727 | * changes. | |
3728 | * | |
3729 | * Reverse order is used to comfort qcow2 driver: on commit it need to write | |
3730 | * IN_USE flag to the image, to mark bitmaps in the image as invalid. But | |
3731 | * children are usually goes after parents in reopen-queue, so go from last | |
3732 | * to first element. | |
e971aa12 | 3733 | */ |
fcd6a4f4 | 3734 | QTAILQ_FOREACH_REVERSE(bs_entry, bs_queue, entry) { |
e971aa12 JC |
3735 | bdrv_reopen_commit(&bs_entry->state); |
3736 | } | |
3737 | ||
3738 | ret = 0; | |
69b736e7 | 3739 | cleanup_perm: |
859443b0 | 3740 | QTAILQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) { |
69b736e7 KW |
3741 | BDRVReopenState *state = &bs_entry->state; |
3742 | ||
3743 | if (!bs_entry->perms_checked) { | |
3744 | continue; | |
3745 | } | |
e971aa12 | 3746 | |
69b736e7 KW |
3747 | if (ret == 0) { |
3748 | bdrv_set_perm(state->bs, state->perm, state->shared_perm); | |
3749 | } else { | |
3750 | bdrv_abort_perm_update(state->bs); | |
cb828c31 AG |
3751 | if (state->replace_backing_bs && state->new_backing_bs) { |
3752 | bdrv_abort_perm_update(state->new_backing_bs); | |
3753 | } | |
69b736e7 KW |
3754 | } |
3755 | } | |
17e1e2be PK |
3756 | |
3757 | if (ret == 0) { | |
3758 | QTAILQ_FOREACH_REVERSE(bs_entry, bs_queue, entry) { | |
3759 | BlockDriverState *bs = bs_entry->state.bs; | |
3760 | ||
3761 | if (bs->drv->bdrv_reopen_commit_post) | |
3762 | bs->drv->bdrv_reopen_commit_post(&bs_entry->state); | |
3763 | } | |
3764 | } | |
e971aa12 | 3765 | cleanup: |
859443b0 | 3766 | QTAILQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) { |
1bab38e7 AG |
3767 | if (ret) { |
3768 | if (bs_entry->prepared) { | |
3769 | bdrv_reopen_abort(&bs_entry->state); | |
3770 | } | |
cb3e7f08 | 3771 | qobject_unref(bs_entry->state.explicit_options); |
4c8350fe | 3772 | qobject_unref(bs_entry->state.options); |
e971aa12 | 3773 | } |
cb828c31 AG |
3774 | if (bs_entry->state.new_backing_bs) { |
3775 | bdrv_unref(bs_entry->state.new_backing_bs); | |
3776 | } | |
e971aa12 JC |
3777 | g_free(bs_entry); |
3778 | } | |
3779 | g_free(bs_queue); | |
40840e41 | 3780 | |
e971aa12 JC |
3781 | return ret; |
3782 | } | |
3783 | ||
6e1000a8 AG |
3784 | int bdrv_reopen_set_read_only(BlockDriverState *bs, bool read_only, |
3785 | Error **errp) | |
3786 | { | |
3787 | int ret; | |
3788 | BlockReopenQueue *queue; | |
3789 | QDict *opts = qdict_new(); | |
3790 | ||
3791 | qdict_put_bool(opts, BDRV_OPT_READ_ONLY, read_only); | |
3792 | ||
3793 | bdrv_subtree_drained_begin(bs); | |
077e8e20 | 3794 | queue = bdrv_reopen_queue(NULL, bs, opts, true); |
5019aece | 3795 | ret = bdrv_reopen_multiple(queue, errp); |
6e1000a8 AG |
3796 | bdrv_subtree_drained_end(bs); |
3797 | ||
3798 | return ret; | |
3799 | } | |
3800 | ||
30450259 KW |
3801 | static BlockReopenQueueEntry *find_parent_in_reopen_queue(BlockReopenQueue *q, |
3802 | BdrvChild *c) | |
3803 | { | |
3804 | BlockReopenQueueEntry *entry; | |
3805 | ||
859443b0 | 3806 | QTAILQ_FOREACH(entry, q, entry) { |
30450259 KW |
3807 | BlockDriverState *bs = entry->state.bs; |
3808 | BdrvChild *child; | |
3809 | ||
3810 | QLIST_FOREACH(child, &bs->children, next) { | |
3811 | if (child == c) { | |
3812 | return entry; | |
3813 | } | |
3814 | } | |
3815 | } | |
3816 | ||
3817 | return NULL; | |
3818 | } | |
3819 | ||
3820 | static void bdrv_reopen_perm(BlockReopenQueue *q, BlockDriverState *bs, | |
3821 | uint64_t *perm, uint64_t *shared) | |
3822 | { | |
3823 | BdrvChild *c; | |
3824 | BlockReopenQueueEntry *parent; | |
3825 | uint64_t cumulative_perms = 0; | |
3826 | uint64_t cumulative_shared_perms = BLK_PERM_ALL; | |
3827 | ||
3828 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
3829 | parent = find_parent_in_reopen_queue(q, c); | |
3830 | if (!parent) { | |
3831 | cumulative_perms |= c->perm; | |
3832 | cumulative_shared_perms &= c->shared_perm; | |
3833 | } else { | |
3834 | uint64_t nperm, nshared; | |
3835 | ||
bf8e925e | 3836 | bdrv_child_perm(parent->state.bs, bs, c, c->klass, c->role, q, |
30450259 KW |
3837 | parent->state.perm, parent->state.shared_perm, |
3838 | &nperm, &nshared); | |
3839 | ||
3840 | cumulative_perms |= nperm; | |
3841 | cumulative_shared_perms &= nshared; | |
3842 | } | |
3843 | } | |
3844 | *perm = cumulative_perms; | |
3845 | *shared = cumulative_shared_perms; | |
3846 | } | |
e971aa12 | 3847 | |
1de6b45f KW |
3848 | static bool bdrv_reopen_can_attach(BlockDriverState *parent, |
3849 | BdrvChild *child, | |
3850 | BlockDriverState *new_child, | |
3851 | Error **errp) | |
3852 | { | |
3853 | AioContext *parent_ctx = bdrv_get_aio_context(parent); | |
3854 | AioContext *child_ctx = bdrv_get_aio_context(new_child); | |
3855 | GSList *ignore; | |
3856 | bool ret; | |
3857 | ||
3858 | ignore = g_slist_prepend(NULL, child); | |
3859 | ret = bdrv_can_set_aio_context(new_child, parent_ctx, &ignore, NULL); | |
3860 | g_slist_free(ignore); | |
3861 | if (ret) { | |
3862 | return ret; | |
3863 | } | |
3864 | ||
3865 | ignore = g_slist_prepend(NULL, child); | |
3866 | ret = bdrv_can_set_aio_context(parent, child_ctx, &ignore, errp); | |
3867 | g_slist_free(ignore); | |
3868 | return ret; | |
3869 | } | |
3870 | ||
cb828c31 AG |
3871 | /* |
3872 | * Take a BDRVReopenState and check if the value of 'backing' in the | |
3873 | * reopen_state->options QDict is valid or not. | |
3874 | * | |
3875 | * If 'backing' is missing from the QDict then return 0. | |
3876 | * | |
3877 | * If 'backing' contains the node name of the backing file of | |
3878 | * reopen_state->bs then return 0. | |
3879 | * | |
3880 | * If 'backing' contains a different node name (or is null) then check | |
3881 | * whether the current backing file can be replaced with the new one. | |
3882 | * If that's the case then reopen_state->replace_backing_bs is set to | |
3883 | * true and reopen_state->new_backing_bs contains a pointer to the new | |
3884 | * backing BlockDriverState (or NULL). | |
3885 | * | |
3886 | * Return 0 on success, otherwise return < 0 and set @errp. | |
3887 | */ | |
3888 | static int bdrv_reopen_parse_backing(BDRVReopenState *reopen_state, | |
3889 | Error **errp) | |
3890 | { | |
3891 | BlockDriverState *bs = reopen_state->bs; | |
3892 | BlockDriverState *overlay_bs, *new_backing_bs; | |
3893 | QObject *value; | |
3894 | const char *str; | |
3895 | ||
3896 | value = qdict_get(reopen_state->options, "backing"); | |
3897 | if (value == NULL) { | |
3898 | return 0; | |
3899 | } | |
3900 | ||
3901 | switch (qobject_type(value)) { | |
3902 | case QTYPE_QNULL: | |
3903 | new_backing_bs = NULL; | |
3904 | break; | |
3905 | case QTYPE_QSTRING: | |
3906 | str = qobject_get_try_str(value); | |
3907 | new_backing_bs = bdrv_lookup_bs(NULL, str, errp); | |
3908 | if (new_backing_bs == NULL) { | |
3909 | return -EINVAL; | |
3910 | } else if (bdrv_recurse_has_child(new_backing_bs, bs)) { | |
3911 | error_setg(errp, "Making '%s' a backing file of '%s' " | |
3912 | "would create a cycle", str, bs->node_name); | |
3913 | return -EINVAL; | |
3914 | } | |
3915 | break; | |
3916 | default: | |
3917 | /* 'backing' does not allow any other data type */ | |
3918 | g_assert_not_reached(); | |
3919 | } | |
3920 | ||
3921 | /* | |
1de6b45f KW |
3922 | * Check AioContext compatibility so that the bdrv_set_backing_hd() call in |
3923 | * bdrv_reopen_commit() won't fail. | |
cb828c31 AG |
3924 | */ |
3925 | if (new_backing_bs) { | |
1de6b45f | 3926 | if (!bdrv_reopen_can_attach(bs, bs->backing, new_backing_bs, errp)) { |
cb828c31 AG |
3927 | return -EINVAL; |
3928 | } | |
3929 | } | |
3930 | ||
3931 | /* | |
3932 | * Find the "actual" backing file by skipping all links that point | |
3933 | * to an implicit node, if any (e.g. a commit filter node). | |
3934 | */ | |
3935 | overlay_bs = bs; | |
3936 | while (backing_bs(overlay_bs) && backing_bs(overlay_bs)->implicit) { | |
3937 | overlay_bs = backing_bs(overlay_bs); | |
3938 | } | |
3939 | ||
3940 | /* If we want to replace the backing file we need some extra checks */ | |
3941 | if (new_backing_bs != backing_bs(overlay_bs)) { | |
3942 | /* Check for implicit nodes between bs and its backing file */ | |
3943 | if (bs != overlay_bs) { | |
3944 | error_setg(errp, "Cannot change backing link if '%s' has " | |
3945 | "an implicit backing file", bs->node_name); | |
3946 | return -EPERM; | |
3947 | } | |
3948 | /* Check if the backing link that we want to replace is frozen */ | |
3949 | if (bdrv_is_backing_chain_frozen(overlay_bs, backing_bs(overlay_bs), | |
3950 | errp)) { | |
3951 | return -EPERM; | |
3952 | } | |
3953 | reopen_state->replace_backing_bs = true; | |
3954 | if (new_backing_bs) { | |
3955 | bdrv_ref(new_backing_bs); | |
3956 | reopen_state->new_backing_bs = new_backing_bs; | |
3957 | } | |
3958 | } | |
3959 | ||
3960 | return 0; | |
3961 | } | |
3962 | ||
e971aa12 JC |
3963 | /* |
3964 | * Prepares a BlockDriverState for reopen. All changes are staged in the | |
3965 | * 'opaque' field of the BDRVReopenState, which is used and allocated by | |
3966 | * the block driver layer .bdrv_reopen_prepare() | |
3967 | * | |
3968 | * bs is the BlockDriverState to reopen | |
3969 | * flags are the new open flags | |
3970 | * queue is the reopen queue | |
3971 | * | |
3972 | * Returns 0 on success, non-zero on error. On error errp will be set | |
3973 | * as well. | |
3974 | * | |
3975 | * On failure, bdrv_reopen_abort() will be called to clean up any data. | |
3976 | * It is the responsibility of the caller to then call the abort() or | |
3977 | * commit() for any other BDS that have been left in a prepare() state | |
3978 | * | |
3979 | */ | |
3980 | int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue, | |
3981 | Error **errp) | |
3982 | { | |
3983 | int ret = -1; | |
e6d79c41 | 3984 | int old_flags; |
e971aa12 JC |
3985 | Error *local_err = NULL; |
3986 | BlockDriver *drv; | |
ccf9dc07 | 3987 | QemuOpts *opts; |
4c8350fe | 3988 | QDict *orig_reopen_opts; |
593b3071 | 3989 | char *discard = NULL; |
3d8ce171 | 3990 | bool read_only; |
9ad08c44 | 3991 | bool drv_prepared = false; |
e971aa12 JC |
3992 | |
3993 | assert(reopen_state != NULL); | |
3994 | assert(reopen_state->bs->drv != NULL); | |
3995 | drv = reopen_state->bs->drv; | |
3996 | ||
4c8350fe AG |
3997 | /* This function and each driver's bdrv_reopen_prepare() remove |
3998 | * entries from reopen_state->options as they are processed, so | |
3999 | * we need to make a copy of the original QDict. */ | |
4000 | orig_reopen_opts = qdict_clone_shallow(reopen_state->options); | |
4001 | ||
ccf9dc07 KW |
4002 | /* Process generic block layer options */ |
4003 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); | |
4004 | qemu_opts_absorb_qdict(opts, reopen_state->options, &local_err); | |
4005 | if (local_err) { | |
4006 | error_propagate(errp, local_err); | |
4007 | ret = -EINVAL; | |
4008 | goto error; | |
4009 | } | |
4010 | ||
e6d79c41 AG |
4011 | /* This was already called in bdrv_reopen_queue_child() so the flags |
4012 | * are up-to-date. This time we simply want to remove the options from | |
4013 | * QemuOpts in order to indicate that they have been processed. */ | |
4014 | old_flags = reopen_state->flags; | |
91a097e7 | 4015 | update_flags_from_options(&reopen_state->flags, opts); |
e6d79c41 | 4016 | assert(old_flags == reopen_state->flags); |
91a097e7 | 4017 | |
415bbca8 | 4018 | discard = qemu_opt_get_del(opts, BDRV_OPT_DISCARD); |
593b3071 AG |
4019 | if (discard != NULL) { |
4020 | if (bdrv_parse_discard_flags(discard, &reopen_state->flags) != 0) { | |
4021 | error_setg(errp, "Invalid discard option"); | |
4022 | ret = -EINVAL; | |
4023 | goto error; | |
4024 | } | |
4025 | } | |
4026 | ||
543770bd AG |
4027 | reopen_state->detect_zeroes = |
4028 | bdrv_parse_detect_zeroes(opts, reopen_state->flags, &local_err); | |
4029 | if (local_err) { | |
4030 | error_propagate(errp, local_err); | |
4031 | ret = -EINVAL; | |
4032 | goto error; | |
4033 | } | |
4034 | ||
57f9db9a AG |
4035 | /* All other options (including node-name and driver) must be unchanged. |
4036 | * Put them back into the QDict, so that they are checked at the end | |
4037 | * of this function. */ | |
4038 | qemu_opts_to_qdict(opts, reopen_state->options); | |
ccf9dc07 | 4039 | |
3d8ce171 JC |
4040 | /* If we are to stay read-only, do not allow permission change |
4041 | * to r/w. Attempting to set to r/w may fail if either BDRV_O_ALLOW_RDWR is | |
4042 | * not set, or if the BDS still has copy_on_read enabled */ | |
4043 | read_only = !(reopen_state->flags & BDRV_O_RDWR); | |
54a32bfe | 4044 | ret = bdrv_can_set_read_only(reopen_state->bs, read_only, true, &local_err); |
3d8ce171 JC |
4045 | if (local_err) { |
4046 | error_propagate(errp, local_err); | |
e971aa12 JC |
4047 | goto error; |
4048 | } | |
4049 | ||
30450259 KW |
4050 | /* Calculate required permissions after reopening */ |
4051 | bdrv_reopen_perm(queue, reopen_state->bs, | |
4052 | &reopen_state->perm, &reopen_state->shared_perm); | |
e971aa12 JC |
4053 | |
4054 | ret = bdrv_flush(reopen_state->bs); | |
4055 | if (ret) { | |
455b0fde | 4056 | error_setg_errno(errp, -ret, "Error flushing drive"); |
e971aa12 JC |
4057 | goto error; |
4058 | } | |
4059 | ||
4060 | if (drv->bdrv_reopen_prepare) { | |
faf116b4 AG |
4061 | /* |
4062 | * If a driver-specific option is missing, it means that we | |
4063 | * should reset it to its default value. | |
4064 | * But not all options allow that, so we need to check it first. | |
4065 | */ | |
4066 | ret = bdrv_reset_options_allowed(reopen_state->bs, | |
4067 | reopen_state->options, errp); | |
4068 | if (ret) { | |
4069 | goto error; | |
4070 | } | |
4071 | ||
e971aa12 JC |
4072 | ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err); |
4073 | if (ret) { | |
4074 | if (local_err != NULL) { | |
4075 | error_propagate(errp, local_err); | |
4076 | } else { | |
f30c66ba | 4077 | bdrv_refresh_filename(reopen_state->bs); |
d8b6895f LC |
4078 | error_setg(errp, "failed while preparing to reopen image '%s'", |
4079 | reopen_state->bs->filename); | |
e971aa12 JC |
4080 | } |
4081 | goto error; | |
4082 | } | |
4083 | } else { | |
4084 | /* It is currently mandatory to have a bdrv_reopen_prepare() | |
4085 | * handler for each supported drv. */ | |
81e5f78a AG |
4086 | error_setg(errp, "Block format '%s' used by node '%s' " |
4087 | "does not support reopening files", drv->format_name, | |
4088 | bdrv_get_device_or_node_name(reopen_state->bs)); | |
e971aa12 JC |
4089 | ret = -1; |
4090 | goto error; | |
4091 | } | |
4092 | ||
9ad08c44 HR |
4093 | drv_prepared = true; |
4094 | ||
bacd9b87 AG |
4095 | /* |
4096 | * We must provide the 'backing' option if the BDS has a backing | |
4097 | * file or if the image file has a backing file name as part of | |
4098 | * its metadata. Otherwise the 'backing' option can be omitted. | |
4099 | */ | |
4100 | if (drv->supports_backing && reopen_state->backing_missing && | |
4101 | (backing_bs(reopen_state->bs) || reopen_state->bs->backing_file[0])) { | |
8546632e AG |
4102 | error_setg(errp, "backing is missing for '%s'", |
4103 | reopen_state->bs->node_name); | |
4104 | ret = -EINVAL; | |
4105 | goto error; | |
4106 | } | |
4107 | ||
cb828c31 AG |
4108 | /* |
4109 | * Allow changing the 'backing' option. The new value can be | |
4110 | * either a reference to an existing node (using its node name) | |
4111 | * or NULL to simply detach the current backing file. | |
4112 | */ | |
4113 | ret = bdrv_reopen_parse_backing(reopen_state, errp); | |
4114 | if (ret < 0) { | |
4115 | goto error; | |
4116 | } | |
4117 | qdict_del(reopen_state->options, "backing"); | |
4118 | ||
4d2cb092 KW |
4119 | /* Options that are not handled are only okay if they are unchanged |
4120 | * compared to the old state. It is expected that some options are only | |
4121 | * used for the initial open, but not reopen (e.g. filename) */ | |
4122 | if (qdict_size(reopen_state->options)) { | |
4123 | const QDictEntry *entry = qdict_first(reopen_state->options); | |
4124 | ||
4125 | do { | |
54fd1b0d HR |
4126 | QObject *new = entry->value; |
4127 | QObject *old = qdict_get(reopen_state->bs->options, entry->key); | |
4128 | ||
db905283 AG |
4129 | /* Allow child references (child_name=node_name) as long as they |
4130 | * point to the current child (i.e. everything stays the same). */ | |
4131 | if (qobject_type(new) == QTYPE_QSTRING) { | |
4132 | BdrvChild *child; | |
4133 | QLIST_FOREACH(child, &reopen_state->bs->children, next) { | |
4134 | if (!strcmp(child->name, entry->key)) { | |
4135 | break; | |
4136 | } | |
4137 | } | |
4138 | ||
4139 | if (child) { | |
4140 | const char *str = qobject_get_try_str(new); | |
4141 | if (!strcmp(child->bs->node_name, str)) { | |
4142 | continue; /* Found child with this name, skip option */ | |
4143 | } | |
4144 | } | |
4145 | } | |
4146 | ||
129c7d1c | 4147 | /* |
54fd1b0d HR |
4148 | * TODO: When using -drive to specify blockdev options, all values |
4149 | * will be strings; however, when using -blockdev, blockdev-add or | |
4150 | * filenames using the json:{} pseudo-protocol, they will be | |
4151 | * correctly typed. | |
4152 | * In contrast, reopening options are (currently) always strings | |
4153 | * (because you can only specify them through qemu-io; all other | |
4154 | * callers do not specify any options). | |
4155 | * Therefore, when using anything other than -drive to create a BDS, | |
4156 | * this cannot detect non-string options as unchanged, because | |
4157 | * qobject_is_equal() always returns false for objects of different | |
4158 | * type. In the future, this should be remedied by correctly typing | |
4159 | * all options. For now, this is not too big of an issue because | |
4160 | * the user can simply omit options which cannot be changed anyway, | |
4161 | * so they will stay unchanged. | |
129c7d1c | 4162 | */ |
54fd1b0d | 4163 | if (!qobject_is_equal(new, old)) { |
4d2cb092 KW |
4164 | error_setg(errp, "Cannot change the option '%s'", entry->key); |
4165 | ret = -EINVAL; | |
4166 | goto error; | |
4167 | } | |
4168 | } while ((entry = qdict_next(reopen_state->options, entry))); | |
4169 | } | |
4170 | ||
e971aa12 JC |
4171 | ret = 0; |
4172 | ||
4c8350fe AG |
4173 | /* Restore the original reopen_state->options QDict */ |
4174 | qobject_unref(reopen_state->options); | |
4175 | reopen_state->options = qobject_ref(orig_reopen_opts); | |
4176 | ||
e971aa12 | 4177 | error: |
9ad08c44 HR |
4178 | if (ret < 0 && drv_prepared) { |
4179 | /* drv->bdrv_reopen_prepare() has succeeded, so we need to | |
4180 | * call drv->bdrv_reopen_abort() before signaling an error | |
4181 | * (bdrv_reopen_multiple() will not call bdrv_reopen_abort() | |
4182 | * when the respective bdrv_reopen_prepare() has failed) */ | |
4183 | if (drv->bdrv_reopen_abort) { | |
4184 | drv->bdrv_reopen_abort(reopen_state); | |
4185 | } | |
4186 | } | |
ccf9dc07 | 4187 | qemu_opts_del(opts); |
4c8350fe | 4188 | qobject_unref(orig_reopen_opts); |
593b3071 | 4189 | g_free(discard); |
e971aa12 JC |
4190 | return ret; |
4191 | } | |
4192 | ||
4193 | /* | |
4194 | * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and | |
4195 | * makes them final by swapping the staging BlockDriverState contents into | |
4196 | * the active BlockDriverState contents. | |
4197 | */ | |
4198 | void bdrv_reopen_commit(BDRVReopenState *reopen_state) | |
4199 | { | |
4200 | BlockDriver *drv; | |
50bf65ba | 4201 | BlockDriverState *bs; |
50196d7a | 4202 | BdrvChild *child; |
e971aa12 JC |
4203 | |
4204 | assert(reopen_state != NULL); | |
50bf65ba VSO |
4205 | bs = reopen_state->bs; |
4206 | drv = bs->drv; | |
e971aa12 JC |
4207 | assert(drv != NULL); |
4208 | ||
4209 | /* If there are any driver level actions to take */ | |
4210 | if (drv->bdrv_reopen_commit) { | |
4211 | drv->bdrv_reopen_commit(reopen_state); | |
4212 | } | |
4213 | ||
4214 | /* set BDS specific flags now */ | |
cb3e7f08 | 4215 | qobject_unref(bs->explicit_options); |
4c8350fe | 4216 | qobject_unref(bs->options); |
145f598e | 4217 | |
50bf65ba | 4218 | bs->explicit_options = reopen_state->explicit_options; |
4c8350fe | 4219 | bs->options = reopen_state->options; |
50bf65ba VSO |
4220 | bs->open_flags = reopen_state->flags; |
4221 | bs->read_only = !(reopen_state->flags & BDRV_O_RDWR); | |
543770bd | 4222 | bs->detect_zeroes = reopen_state->detect_zeroes; |
355ef4ac | 4223 | |
cb828c31 AG |
4224 | if (reopen_state->replace_backing_bs) { |
4225 | qdict_del(bs->explicit_options, "backing"); | |
4226 | qdict_del(bs->options, "backing"); | |
4227 | } | |
4228 | ||
50196d7a AG |
4229 | /* Remove child references from bs->options and bs->explicit_options. |
4230 | * Child options were already removed in bdrv_reopen_queue_child() */ | |
4231 | QLIST_FOREACH(child, &bs->children, next) { | |
4232 | qdict_del(bs->explicit_options, child->name); | |
4233 | qdict_del(bs->options, child->name); | |
4234 | } | |
4235 | ||
cb828c31 AG |
4236 | /* |
4237 | * Change the backing file if a new one was specified. We do this | |
4238 | * after updating bs->options, so bdrv_refresh_filename() (called | |
4239 | * from bdrv_set_backing_hd()) has the new values. | |
4240 | */ | |
4241 | if (reopen_state->replace_backing_bs) { | |
4242 | BlockDriverState *old_backing_bs = backing_bs(bs); | |
4243 | assert(!old_backing_bs || !old_backing_bs->implicit); | |
4244 | /* Abort the permission update on the backing bs we're detaching */ | |
4245 | if (old_backing_bs) { | |
4246 | bdrv_abort_perm_update(old_backing_bs); | |
4247 | } | |
4248 | bdrv_set_backing_hd(bs, reopen_state->new_backing_bs, &error_abort); | |
4249 | } | |
4250 | ||
50bf65ba | 4251 | bdrv_refresh_limits(bs, NULL); |
e971aa12 JC |
4252 | } |
4253 | ||
4254 | /* | |
4255 | * Abort the reopen, and delete and free the staged changes in | |
4256 | * reopen_state | |
4257 | */ | |
4258 | void bdrv_reopen_abort(BDRVReopenState *reopen_state) | |
4259 | { | |
4260 | BlockDriver *drv; | |
4261 | ||
4262 | assert(reopen_state != NULL); | |
4263 | drv = reopen_state->bs->drv; | |
4264 | assert(drv != NULL); | |
4265 | ||
4266 | if (drv->bdrv_reopen_abort) { | |
4267 | drv->bdrv_reopen_abort(reopen_state); | |
4268 | } | |
4269 | } | |
4270 | ||
4271 | ||
64dff520 | 4272 | static void bdrv_close(BlockDriverState *bs) |
fc01f7e7 | 4273 | { |
33384421 | 4274 | BdrvAioNotifier *ban, *ban_next; |
50a3efb0 | 4275 | BdrvChild *child, *next; |
33384421 | 4276 | |
30f55fb8 | 4277 | assert(!bs->refcnt); |
99b7e775 | 4278 | |
fc27291d | 4279 | bdrv_drained_begin(bs); /* complete I/O */ |
58fda173 | 4280 | bdrv_flush(bs); |
53ec73e2 | 4281 | bdrv_drain(bs); /* in case flush left pending I/O */ |
fc27291d | 4282 | |
3cbc002c | 4283 | if (bs->drv) { |
3c005293 VSO |
4284 | if (bs->drv->bdrv_close) { |
4285 | bs->drv->bdrv_close(bs); | |
4286 | } | |
9a4f4c31 | 4287 | bs->drv = NULL; |
50a3efb0 | 4288 | } |
9a7dedbc | 4289 | |
50a3efb0 | 4290 | QLIST_FOREACH_SAFE(child, &bs->children, next, next) { |
dd4118c7 | 4291 | bdrv_unref_child(bs, child); |
b338082b | 4292 | } |
98f90dba | 4293 | |
dd4118c7 AG |
4294 | bs->backing = NULL; |
4295 | bs->file = NULL; | |
50a3efb0 AG |
4296 | g_free(bs->opaque); |
4297 | bs->opaque = NULL; | |
4298 | atomic_set(&bs->copy_on_read, 0); | |
4299 | bs->backing_file[0] = '\0'; | |
4300 | bs->backing_format[0] = '\0'; | |
4301 | bs->total_sectors = 0; | |
4302 | bs->encrypted = false; | |
4303 | bs->sg = false; | |
cb3e7f08 MAL |
4304 | qobject_unref(bs->options); |
4305 | qobject_unref(bs->explicit_options); | |
50a3efb0 AG |
4306 | bs->options = NULL; |
4307 | bs->explicit_options = NULL; | |
cb3e7f08 | 4308 | qobject_unref(bs->full_open_options); |
50a3efb0 AG |
4309 | bs->full_open_options = NULL; |
4310 | ||
cca43ae1 VSO |
4311 | bdrv_release_named_dirty_bitmaps(bs); |
4312 | assert(QLIST_EMPTY(&bs->dirty_bitmaps)); | |
4313 | ||
33384421 HR |
4314 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { |
4315 | g_free(ban); | |
4316 | } | |
4317 | QLIST_INIT(&bs->aio_notifiers); | |
fc27291d | 4318 | bdrv_drained_end(bs); |
b338082b FB |
4319 | } |
4320 | ||
2bc93fed MK |
4321 | void bdrv_close_all(void) |
4322 | { | |
b3b5299d | 4323 | assert(job_next(NULL) == NULL); |
cd7fca95 | 4324 | nbd_export_close_all(); |
ca9bd24c HR |
4325 | |
4326 | /* Drop references from requests still in flight, such as canceled block | |
4327 | * jobs whose AIO context has not been polled yet */ | |
4328 | bdrv_drain_all(); | |
2bc93fed | 4329 | |
ca9bd24c HR |
4330 | blk_remove_all_bs(); |
4331 | blockdev_close_all_bdrv_states(); | |
ed78cda3 | 4332 | |
a1a2af07 | 4333 | assert(QTAILQ_EMPTY(&all_bdrv_states)); |
2bc93fed MK |
4334 | } |
4335 | ||
d0ac0380 KW |
4336 | static bool should_update_child(BdrvChild *c, BlockDriverState *to) |
4337 | { | |
2f30b7c3 VSO |
4338 | GQueue *queue; |
4339 | GHashTable *found; | |
4340 | bool ret; | |
d0ac0380 | 4341 | |
bd86fb99 | 4342 | if (c->klass->stay_at_node) { |
d0ac0380 KW |
4343 | return false; |
4344 | } | |
4345 | ||
ec9f10fe HR |
4346 | /* If the child @c belongs to the BDS @to, replacing the current |
4347 | * c->bs by @to would mean to create a loop. | |
4348 | * | |
4349 | * Such a case occurs when appending a BDS to a backing chain. | |
4350 | * For instance, imagine the following chain: | |
4351 | * | |
4352 | * guest device -> node A -> further backing chain... | |
4353 | * | |
4354 | * Now we create a new BDS B which we want to put on top of this | |
4355 | * chain, so we first attach A as its backing node: | |
4356 | * | |
4357 | * node B | |
4358 | * | | |
4359 | * v | |
4360 | * guest device -> node A -> further backing chain... | |
4361 | * | |
4362 | * Finally we want to replace A by B. When doing that, we want to | |
4363 | * replace all pointers to A by pointers to B -- except for the | |
4364 | * pointer from B because (1) that would create a loop, and (2) | |
4365 | * that pointer should simply stay intact: | |
4366 | * | |
4367 | * guest device -> node B | |
4368 | * | | |
4369 | * v | |
4370 | * node A -> further backing chain... | |
4371 | * | |
4372 | * In general, when replacing a node A (c->bs) by a node B (@to), | |
4373 | * if A is a child of B, that means we cannot replace A by B there | |
4374 | * because that would create a loop. Silently detaching A from B | |
4375 | * is also not really an option. So overall just leaving A in | |
2f30b7c3 VSO |
4376 | * place there is the most sensible choice. |
4377 | * | |
4378 | * We would also create a loop in any cases where @c is only | |
4379 | * indirectly referenced by @to. Prevent this by returning false | |
4380 | * if @c is found (by breadth-first search) anywhere in the whole | |
4381 | * subtree of @to. | |
4382 | */ | |
4383 | ||
4384 | ret = true; | |
4385 | found = g_hash_table_new(NULL, NULL); | |
4386 | g_hash_table_add(found, to); | |
4387 | queue = g_queue_new(); | |
4388 | g_queue_push_tail(queue, to); | |
4389 | ||
4390 | while (!g_queue_is_empty(queue)) { | |
4391 | BlockDriverState *v = g_queue_pop_head(queue); | |
4392 | BdrvChild *c2; | |
4393 | ||
4394 | QLIST_FOREACH(c2, &v->children, next) { | |
4395 | if (c2 == c) { | |
4396 | ret = false; | |
4397 | break; | |
4398 | } | |
4399 | ||
4400 | if (g_hash_table_contains(found, c2->bs)) { | |
4401 | continue; | |
4402 | } | |
4403 | ||
4404 | g_queue_push_tail(queue, c2->bs); | |
4405 | g_hash_table_add(found, c2->bs); | |
d0ac0380 KW |
4406 | } |
4407 | } | |
4408 | ||
2f30b7c3 VSO |
4409 | g_queue_free(queue); |
4410 | g_hash_table_destroy(found); | |
4411 | ||
4412 | return ret; | |
d0ac0380 KW |
4413 | } |
4414 | ||
5fe31c25 KW |
4415 | void bdrv_replace_node(BlockDriverState *from, BlockDriverState *to, |
4416 | Error **errp) | |
dd62f1ca | 4417 | { |
d0ac0380 | 4418 | BdrvChild *c, *next; |
234ac1a9 | 4419 | GSList *list = NULL, *p; |
234ac1a9 KW |
4420 | uint64_t perm = 0, shared = BLK_PERM_ALL; |
4421 | int ret; | |
4422 | ||
4423 | /* Make sure that @from doesn't go away until we have successfully attached | |
4424 | * all of its parents to @to. */ | |
4425 | bdrv_ref(from); | |
dd62f1ca | 4426 | |
f871abd6 | 4427 | assert(qemu_get_current_aio_context() == qemu_get_aio_context()); |
30dd65f3 | 4428 | assert(bdrv_get_aio_context(from) == bdrv_get_aio_context(to)); |
f871abd6 KW |
4429 | bdrv_drained_begin(from); |
4430 | ||
234ac1a9 | 4431 | /* Put all parents into @list and calculate their cumulative permissions */ |
dd62f1ca | 4432 | QLIST_FOREACH_SAFE(c, &from->parents, next_parent, next) { |
ec9f10fe | 4433 | assert(c->bs == from); |
d0ac0380 | 4434 | if (!should_update_child(c, to)) { |
26de9438 KW |
4435 | continue; |
4436 | } | |
2cad1ebe AG |
4437 | if (c->frozen) { |
4438 | error_setg(errp, "Cannot change '%s' link to '%s'", | |
4439 | c->name, from->node_name); | |
4440 | goto out; | |
4441 | } | |
234ac1a9 KW |
4442 | list = g_slist_prepend(list, c); |
4443 | perm |= c->perm; | |
4444 | shared &= c->shared_perm; | |
4445 | } | |
4446 | ||
4447 | /* Check whether the required permissions can be granted on @to, ignoring | |
4448 | * all BdrvChild in @list so that they can't block themselves. */ | |
9eab1544 | 4449 | ret = bdrv_check_update_perm(to, NULL, perm, shared, list, NULL, errp); |
234ac1a9 KW |
4450 | if (ret < 0) { |
4451 | bdrv_abort_perm_update(to); | |
4452 | goto out; | |
4453 | } | |
4454 | ||
4455 | /* Now actually perform the change. We performed the permission check for | |
4456 | * all elements of @list at once, so set the permissions all at once at the | |
4457 | * very end. */ | |
4458 | for (p = list; p != NULL; p = p->next) { | |
4459 | c = p->data; | |
9bd910e2 | 4460 | |
dd62f1ca | 4461 | bdrv_ref(to); |
234ac1a9 | 4462 | bdrv_replace_child_noperm(c, to); |
dd62f1ca KW |
4463 | bdrv_unref(from); |
4464 | } | |
234ac1a9 | 4465 | |
b503de61 VSO |
4466 | bdrv_get_cumulative_perm(to, &perm, &shared); |
4467 | bdrv_set_perm(to, perm, shared); | |
234ac1a9 KW |
4468 | |
4469 | out: | |
4470 | g_slist_free(list); | |
f871abd6 | 4471 | bdrv_drained_end(from); |
234ac1a9 | 4472 | bdrv_unref(from); |
dd62f1ca KW |
4473 | } |
4474 | ||
4ddc07ca PB |
4475 | /* |
4476 | * Add new bs contents at the top of an image chain while the chain is | |
4477 | * live, while keeping required fields on the top layer. | |
4478 | * | |
4479 | * This will modify the BlockDriverState fields, and swap contents | |
4480 | * between bs_new and bs_top. Both bs_new and bs_top are modified. | |
4481 | * | |
bfb197e0 | 4482 | * bs_new must not be attached to a BlockBackend. |
4ddc07ca PB |
4483 | * |
4484 | * This function does not create any image files. | |
dd62f1ca KW |
4485 | * |
4486 | * bdrv_append() takes ownership of a bs_new reference and unrefs it because | |
4487 | * that's what the callers commonly need. bs_new will be referenced by the old | |
4488 | * parents of bs_top after bdrv_append() returns. If the caller needs to keep a | |
4489 | * reference of its own, it must call bdrv_ref(). | |
4ddc07ca | 4490 | */ |
b2c2832c KW |
4491 | void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top, |
4492 | Error **errp) | |
4ddc07ca | 4493 | { |
b2c2832c KW |
4494 | Error *local_err = NULL; |
4495 | ||
b2c2832c KW |
4496 | bdrv_set_backing_hd(bs_new, bs_top, &local_err); |
4497 | if (local_err) { | |
4498 | error_propagate(errp, local_err); | |
4499 | goto out; | |
4500 | } | |
dd62f1ca | 4501 | |
5fe31c25 | 4502 | bdrv_replace_node(bs_top, bs_new, &local_err); |
234ac1a9 KW |
4503 | if (local_err) { |
4504 | error_propagate(errp, local_err); | |
4505 | bdrv_set_backing_hd(bs_new, NULL, &error_abort); | |
4506 | goto out; | |
4507 | } | |
4ddc07ca | 4508 | |
dd62f1ca KW |
4509 | /* bs_new is now referenced by its new parents, we don't need the |
4510 | * additional reference any more. */ | |
b2c2832c | 4511 | out: |
dd62f1ca | 4512 | bdrv_unref(bs_new); |
8802d1fd JC |
4513 | } |
4514 | ||
4f6fd349 | 4515 | static void bdrv_delete(BlockDriverState *bs) |
b338082b | 4516 | { |
3718d8ab | 4517 | assert(bdrv_op_blocker_is_empty(bs)); |
4f6fd349 | 4518 | assert(!bs->refcnt); |
18846dee | 4519 | |
1b7bdbc1 | 4520 | /* remove from list, if necessary */ |
63eaaae0 KW |
4521 | if (bs->node_name[0] != '\0') { |
4522 | QTAILQ_REMOVE(&graph_bdrv_states, bs, node_list); | |
4523 | } | |
2c1d04e0 HR |
4524 | QTAILQ_REMOVE(&all_bdrv_states, bs, bs_list); |
4525 | ||
30c321f9 AK |
4526 | bdrv_close(bs); |
4527 | ||
7267c094 | 4528 | g_free(bs); |
fc01f7e7 FB |
4529 | } |
4530 | ||
e97fc193 AL |
4531 | /* |
4532 | * Run consistency checks on an image | |
4533 | * | |
e076f338 | 4534 | * Returns 0 if the check could be completed (it doesn't mean that the image is |
a1c7273b | 4535 | * free of errors) or -errno when an internal error occurred. The results of the |
e076f338 | 4536 | * check are stored in res. |
e97fc193 | 4537 | */ |
2fd61638 PB |
4538 | static int coroutine_fn bdrv_co_check(BlockDriverState *bs, |
4539 | BdrvCheckResult *res, BdrvCheckMode fix) | |
e97fc193 | 4540 | { |
908bcd54 HR |
4541 | if (bs->drv == NULL) { |
4542 | return -ENOMEDIUM; | |
4543 | } | |
2fd61638 | 4544 | if (bs->drv->bdrv_co_check == NULL) { |
e97fc193 AL |
4545 | return -ENOTSUP; |
4546 | } | |
4547 | ||
e076f338 | 4548 | memset(res, 0, sizeof(*res)); |
2fd61638 PB |
4549 | return bs->drv->bdrv_co_check(bs, res, fix); |
4550 | } | |
4551 | ||
4552 | typedef struct CheckCo { | |
4553 | BlockDriverState *bs; | |
4554 | BdrvCheckResult *res; | |
4555 | BdrvCheckMode fix; | |
4556 | int ret; | |
4557 | } CheckCo; | |
4558 | ||
66a5bdf3 | 4559 | static void coroutine_fn bdrv_check_co_entry(void *opaque) |
2fd61638 PB |
4560 | { |
4561 | CheckCo *cco = opaque; | |
4562 | cco->ret = bdrv_co_check(cco->bs, cco->res, cco->fix); | |
4720cbee | 4563 | aio_wait_kick(); |
2fd61638 PB |
4564 | } |
4565 | ||
4566 | int bdrv_check(BlockDriverState *bs, | |
4567 | BdrvCheckResult *res, BdrvCheckMode fix) | |
4568 | { | |
4569 | Coroutine *co; | |
4570 | CheckCo cco = { | |
4571 | .bs = bs, | |
4572 | .res = res, | |
4573 | .ret = -EINPROGRESS, | |
4574 | .fix = fix, | |
4575 | }; | |
4576 | ||
4577 | if (qemu_in_coroutine()) { | |
4578 | /* Fast-path if already in coroutine context */ | |
4579 | bdrv_check_co_entry(&cco); | |
4580 | } else { | |
4581 | co = qemu_coroutine_create(bdrv_check_co_entry, &cco); | |
4720cbee | 4582 | bdrv_coroutine_enter(bs, co); |
2fd61638 PB |
4583 | BDRV_POLL_WHILE(bs, cco.ret == -EINPROGRESS); |
4584 | } | |
4585 | ||
4586 | return cco.ret; | |
e97fc193 AL |
4587 | } |
4588 | ||
756e6736 KW |
4589 | /* |
4590 | * Return values: | |
4591 | * 0 - success | |
4592 | * -EINVAL - backing format specified, but no file | |
4593 | * -ENOSPC - can't update the backing file because no space is left in the | |
4594 | * image file header | |
4595 | * -ENOTSUP - format driver doesn't support changing the backing file | |
4596 | */ | |
4597 | int bdrv_change_backing_file(BlockDriverState *bs, | |
4598 | const char *backing_file, const char *backing_fmt) | |
4599 | { | |
4600 | BlockDriver *drv = bs->drv; | |
469ef350 | 4601 | int ret; |
756e6736 | 4602 | |
d470ad42 HR |
4603 | if (!drv) { |
4604 | return -ENOMEDIUM; | |
4605 | } | |
4606 | ||
5f377794 PB |
4607 | /* Backing file format doesn't make sense without a backing file */ |
4608 | if (backing_fmt && !backing_file) { | |
4609 | return -EINVAL; | |
4610 | } | |
4611 | ||
756e6736 | 4612 | if (drv->bdrv_change_backing_file != NULL) { |
469ef350 | 4613 | ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt); |
756e6736 | 4614 | } else { |
469ef350 | 4615 | ret = -ENOTSUP; |
756e6736 | 4616 | } |
469ef350 PB |
4617 | |
4618 | if (ret == 0) { | |
4619 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: ""); | |
4620 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: ""); | |
998c2019 HR |
4621 | pstrcpy(bs->auto_backing_file, sizeof(bs->auto_backing_file), |
4622 | backing_file ?: ""); | |
469ef350 PB |
4623 | } |
4624 | return ret; | |
756e6736 KW |
4625 | } |
4626 | ||
6ebdcee2 JC |
4627 | /* |
4628 | * Finds the image layer in the chain that has 'bs' as its backing file. | |
4629 | * | |
4630 | * active is the current topmost image. | |
4631 | * | |
4632 | * Returns NULL if bs is not found in active's image chain, | |
4633 | * or if active == bs. | |
4caf0fcd JC |
4634 | * |
4635 | * Returns the bottommost base image if bs == NULL. | |
6ebdcee2 JC |
4636 | */ |
4637 | BlockDriverState *bdrv_find_overlay(BlockDriverState *active, | |
4638 | BlockDriverState *bs) | |
4639 | { | |
760e0063 KW |
4640 | while (active && bs != backing_bs(active)) { |
4641 | active = backing_bs(active); | |
6ebdcee2 JC |
4642 | } |
4643 | ||
4caf0fcd JC |
4644 | return active; |
4645 | } | |
6ebdcee2 | 4646 | |
4caf0fcd JC |
4647 | /* Given a BDS, searches for the base layer. */ |
4648 | BlockDriverState *bdrv_find_base(BlockDriverState *bs) | |
4649 | { | |
4650 | return bdrv_find_overlay(bs, NULL); | |
6ebdcee2 JC |
4651 | } |
4652 | ||
2cad1ebe AG |
4653 | /* |
4654 | * Return true if at least one of the backing links between @bs and | |
4655 | * @base is frozen. @errp is set if that's the case. | |
0f0998f6 | 4656 | * @base must be reachable from @bs, or NULL. |
2cad1ebe AG |
4657 | */ |
4658 | bool bdrv_is_backing_chain_frozen(BlockDriverState *bs, BlockDriverState *base, | |
4659 | Error **errp) | |
4660 | { | |
4661 | BlockDriverState *i; | |
4662 | ||
0f0998f6 AG |
4663 | for (i = bs; i != base; i = backing_bs(i)) { |
4664 | if (i->backing && i->backing->frozen) { | |
2cad1ebe AG |
4665 | error_setg(errp, "Cannot change '%s' link from '%s' to '%s'", |
4666 | i->backing->name, i->node_name, | |
4667 | backing_bs(i)->node_name); | |
4668 | return true; | |
4669 | } | |
4670 | } | |
4671 | ||
4672 | return false; | |
4673 | } | |
4674 | ||
4675 | /* | |
4676 | * Freeze all backing links between @bs and @base. | |
4677 | * If any of the links is already frozen the operation is aborted and | |
4678 | * none of the links are modified. | |
0f0998f6 | 4679 | * @base must be reachable from @bs, or NULL. |
2cad1ebe AG |
4680 | * Returns 0 on success. On failure returns < 0 and sets @errp. |
4681 | */ | |
4682 | int bdrv_freeze_backing_chain(BlockDriverState *bs, BlockDriverState *base, | |
4683 | Error **errp) | |
4684 | { | |
4685 | BlockDriverState *i; | |
4686 | ||
4687 | if (bdrv_is_backing_chain_frozen(bs, base, errp)) { | |
4688 | return -EPERM; | |
4689 | } | |
4690 | ||
e5182c1c HR |
4691 | for (i = bs; i != base; i = backing_bs(i)) { |
4692 | if (i->backing && backing_bs(i)->never_freeze) { | |
4693 | error_setg(errp, "Cannot freeze '%s' link to '%s'", | |
4694 | i->backing->name, backing_bs(i)->node_name); | |
4695 | return -EPERM; | |
4696 | } | |
4697 | } | |
4698 | ||
0f0998f6 AG |
4699 | for (i = bs; i != base; i = backing_bs(i)) { |
4700 | if (i->backing) { | |
4701 | i->backing->frozen = true; | |
4702 | } | |
2cad1ebe AG |
4703 | } |
4704 | ||
4705 | return 0; | |
4706 | } | |
4707 | ||
4708 | /* | |
4709 | * Unfreeze all backing links between @bs and @base. The caller must | |
4710 | * ensure that all links are frozen before using this function. | |
0f0998f6 | 4711 | * @base must be reachable from @bs, or NULL. |
2cad1ebe AG |
4712 | */ |
4713 | void bdrv_unfreeze_backing_chain(BlockDriverState *bs, BlockDriverState *base) | |
4714 | { | |
4715 | BlockDriverState *i; | |
4716 | ||
0f0998f6 AG |
4717 | for (i = bs; i != base; i = backing_bs(i)) { |
4718 | if (i->backing) { | |
4719 | assert(i->backing->frozen); | |
4720 | i->backing->frozen = false; | |
4721 | } | |
2cad1ebe AG |
4722 | } |
4723 | } | |
4724 | ||
6ebdcee2 JC |
4725 | /* |
4726 | * Drops images above 'base' up to and including 'top', and sets the image | |
4727 | * above 'top' to have base as its backing file. | |
4728 | * | |
4729 | * Requires that the overlay to 'top' is opened r/w, so that the backing file | |
4730 | * information in 'bs' can be properly updated. | |
4731 | * | |
4732 | * E.g., this will convert the following chain: | |
4733 | * bottom <- base <- intermediate <- top <- active | |
4734 | * | |
4735 | * to | |
4736 | * | |
4737 | * bottom <- base <- active | |
4738 | * | |
4739 | * It is allowed for bottom==base, in which case it converts: | |
4740 | * | |
4741 | * base <- intermediate <- top <- active | |
4742 | * | |
4743 | * to | |
4744 | * | |
4745 | * base <- active | |
4746 | * | |
54e26900 JC |
4747 | * If backing_file_str is non-NULL, it will be used when modifying top's |
4748 | * overlay image metadata. | |
4749 | * | |
6ebdcee2 JC |
4750 | * Error conditions: |
4751 | * if active == top, that is considered an error | |
4752 | * | |
4753 | */ | |
bde70715 KW |
4754 | int bdrv_drop_intermediate(BlockDriverState *top, BlockDriverState *base, |
4755 | const char *backing_file_str) | |
6ebdcee2 | 4756 | { |
6bd858b3 AG |
4757 | BlockDriverState *explicit_top = top; |
4758 | bool update_inherits_from; | |
61f09cea | 4759 | BdrvChild *c, *next; |
12fa4af6 | 4760 | Error *local_err = NULL; |
6ebdcee2 JC |
4761 | int ret = -EIO; |
4762 | ||
6858eba0 | 4763 | bdrv_ref(top); |
637d54a5 | 4764 | bdrv_subtree_drained_begin(top); |
6858eba0 | 4765 | |
6ebdcee2 JC |
4766 | if (!top->drv || !base->drv) { |
4767 | goto exit; | |
4768 | } | |
4769 | ||
5db15a57 KW |
4770 | /* Make sure that base is in the backing chain of top */ |
4771 | if (!bdrv_chain_contains(top, base)) { | |
6ebdcee2 JC |
4772 | goto exit; |
4773 | } | |
4774 | ||
2cad1ebe AG |
4775 | /* This function changes all links that point to top and makes |
4776 | * them point to base. Check that none of them is frozen. */ | |
4777 | QLIST_FOREACH(c, &top->parents, next_parent) { | |
4778 | if (c->frozen) { | |
4779 | goto exit; | |
4780 | } | |
4781 | } | |
4782 | ||
6bd858b3 AG |
4783 | /* If 'base' recursively inherits from 'top' then we should set |
4784 | * base->inherits_from to top->inherits_from after 'top' and all | |
4785 | * other intermediate nodes have been dropped. | |
4786 | * If 'top' is an implicit node (e.g. "commit_top") we should skip | |
4787 | * it because no one inherits from it. We use explicit_top for that. */ | |
4788 | while (explicit_top && explicit_top->implicit) { | |
4789 | explicit_top = backing_bs(explicit_top); | |
4790 | } | |
4791 | update_inherits_from = bdrv_inherits_from_recursive(base, explicit_top); | |
4792 | ||
6ebdcee2 | 4793 | /* success - we can delete the intermediate states, and link top->base */ |
bde70715 KW |
4794 | /* TODO Check graph modification op blockers (BLK_PERM_GRAPH_MOD) once |
4795 | * we've figured out how they should work. */ | |
f30c66ba HR |
4796 | if (!backing_file_str) { |
4797 | bdrv_refresh_filename(base); | |
4798 | backing_file_str = base->filename; | |
4799 | } | |
61f09cea KW |
4800 | |
4801 | QLIST_FOREACH_SAFE(c, &top->parents, next_parent, next) { | |
4802 | /* Check whether we are allowed to switch c from top to base */ | |
4803 | GSList *ignore_children = g_slist_prepend(NULL, c); | |
2345bde6 | 4804 | ret = bdrv_check_update_perm(base, NULL, c->perm, c->shared_perm, |
9eab1544 | 4805 | ignore_children, NULL, &local_err); |
2c860e79 | 4806 | g_slist_free(ignore_children); |
2345bde6 | 4807 | if (ret < 0) { |
61f09cea | 4808 | error_report_err(local_err); |
6858eba0 KW |
4809 | goto exit; |
4810 | } | |
12fa4af6 | 4811 | |
61f09cea | 4812 | /* If so, update the backing file path in the image file */ |
bd86fb99 HR |
4813 | if (c->klass->update_filename) { |
4814 | ret = c->klass->update_filename(c, base, backing_file_str, | |
4815 | &local_err); | |
61f09cea KW |
4816 | if (ret < 0) { |
4817 | bdrv_abort_perm_update(base); | |
4818 | error_report_err(local_err); | |
4819 | goto exit; | |
4820 | } | |
4821 | } | |
4822 | ||
4823 | /* Do the actual switch in the in-memory graph. | |
4824 | * Completes bdrv_check_update_perm() transaction internally. */ | |
4825 | bdrv_ref(base); | |
4826 | bdrv_replace_child(c, base); | |
4827 | bdrv_unref(top); | |
12fa4af6 | 4828 | } |
6ebdcee2 | 4829 | |
6bd858b3 AG |
4830 | if (update_inherits_from) { |
4831 | base->inherits_from = explicit_top->inherits_from; | |
4832 | } | |
4833 | ||
6ebdcee2 | 4834 | ret = 0; |
6ebdcee2 | 4835 | exit: |
637d54a5 | 4836 | bdrv_subtree_drained_end(top); |
6858eba0 | 4837 | bdrv_unref(top); |
6ebdcee2 JC |
4838 | return ret; |
4839 | } | |
4840 | ||
61007b31 SH |
4841 | /** |
4842 | * Length of a allocated file in bytes. Sparse files are counted by actual | |
4843 | * allocated space. Return < 0 if error or unknown. | |
4844 | */ | |
4845 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs) | |
71d0770c | 4846 | { |
61007b31 SH |
4847 | BlockDriver *drv = bs->drv; |
4848 | if (!drv) { | |
4849 | return -ENOMEDIUM; | |
8f4754ed | 4850 | } |
61007b31 SH |
4851 | if (drv->bdrv_get_allocated_file_size) { |
4852 | return drv->bdrv_get_allocated_file_size(bs); | |
4853 | } | |
4854 | if (bs->file) { | |
9a4f4c31 | 4855 | return bdrv_get_allocated_file_size(bs->file->bs); |
1c9805a3 | 4856 | } |
61007b31 | 4857 | return -ENOTSUP; |
1c9805a3 | 4858 | } |
e7a8a783 | 4859 | |
90880ff1 SH |
4860 | /* |
4861 | * bdrv_measure: | |
4862 | * @drv: Format driver | |
4863 | * @opts: Creation options for new image | |
4864 | * @in_bs: Existing image containing data for new image (may be NULL) | |
4865 | * @errp: Error object | |
4866 | * Returns: A #BlockMeasureInfo (free using qapi_free_BlockMeasureInfo()) | |
4867 | * or NULL on error | |
4868 | * | |
4869 | * Calculate file size required to create a new image. | |
4870 | * | |
4871 | * If @in_bs is given then space for allocated clusters and zero clusters | |
4872 | * from that image are included in the calculation. If @opts contains a | |
4873 | * backing file that is shared by @in_bs then backing clusters may be omitted | |
4874 | * from the calculation. | |
4875 | * | |
4876 | * If @in_bs is NULL then the calculation includes no allocated clusters | |
4877 | * unless a preallocation option is given in @opts. | |
4878 | * | |
4879 | * Note that @in_bs may use a different BlockDriver from @drv. | |
4880 | * | |
4881 | * If an error occurs the @errp pointer is set. | |
4882 | */ | |
4883 | BlockMeasureInfo *bdrv_measure(BlockDriver *drv, QemuOpts *opts, | |
4884 | BlockDriverState *in_bs, Error **errp) | |
4885 | { | |
4886 | if (!drv->bdrv_measure) { | |
4887 | error_setg(errp, "Block driver '%s' does not support size measurement", | |
4888 | drv->format_name); | |
4889 | return NULL; | |
4890 | } | |
4891 | ||
4892 | return drv->bdrv_measure(opts, in_bs, errp); | |
4893 | } | |
4894 | ||
61007b31 SH |
4895 | /** |
4896 | * Return number of sectors on success, -errno on error. | |
1c9805a3 | 4897 | */ |
61007b31 | 4898 | int64_t bdrv_nb_sectors(BlockDriverState *bs) |
1c9805a3 | 4899 | { |
61007b31 | 4900 | BlockDriver *drv = bs->drv; |
498e386c | 4901 | |
61007b31 SH |
4902 | if (!drv) |
4903 | return -ENOMEDIUM; | |
2572b37a | 4904 | |
61007b31 SH |
4905 | if (drv->has_variable_length) { |
4906 | int ret = refresh_total_sectors(bs, bs->total_sectors); | |
4907 | if (ret < 0) { | |
4908 | return ret; | |
1c9805a3 SH |
4909 | } |
4910 | } | |
61007b31 | 4911 | return bs->total_sectors; |
1c9805a3 | 4912 | } |
b338082b | 4913 | |
61007b31 SH |
4914 | /** |
4915 | * Return length in bytes on success, -errno on error. | |
4916 | * The length is always a multiple of BDRV_SECTOR_SIZE. | |
8d3b1a2d | 4917 | */ |
61007b31 | 4918 | int64_t bdrv_getlength(BlockDriverState *bs) |
8d3b1a2d | 4919 | { |
61007b31 | 4920 | int64_t ret = bdrv_nb_sectors(bs); |
8d3b1a2d | 4921 | |
4a9c9ea0 | 4922 | ret = ret > INT64_MAX / BDRV_SECTOR_SIZE ? -EFBIG : ret; |
61007b31 | 4923 | return ret < 0 ? ret : ret * BDRV_SECTOR_SIZE; |
fc01f7e7 FB |
4924 | } |
4925 | ||
61007b31 SH |
4926 | /* return 0 as number of sectors if no device present or error */ |
4927 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr) | |
07d27a44 | 4928 | { |
61007b31 | 4929 | int64_t nb_sectors = bdrv_nb_sectors(bs); |
07d27a44 | 4930 | |
61007b31 | 4931 | *nb_sectors_ptr = nb_sectors < 0 ? 0 : nb_sectors; |
07d27a44 MA |
4932 | } |
4933 | ||
54115412 | 4934 | bool bdrv_is_sg(BlockDriverState *bs) |
f08145fe | 4935 | { |
61007b31 | 4936 | return bs->sg; |
f08145fe KW |
4937 | } |
4938 | ||
54115412 | 4939 | bool bdrv_is_encrypted(BlockDriverState *bs) |
fc3959e4 | 4940 | { |
760e0063 | 4941 | if (bs->backing && bs->backing->bs->encrypted) { |
54115412 | 4942 | return true; |
760e0063 | 4943 | } |
61007b31 | 4944 | return bs->encrypted; |
fc3959e4 FZ |
4945 | } |
4946 | ||
61007b31 | 4947 | const char *bdrv_get_format_name(BlockDriverState *bs) |
40b4f539 | 4948 | { |
61007b31 | 4949 | return bs->drv ? bs->drv->format_name : NULL; |
40b4f539 KW |
4950 | } |
4951 | ||
61007b31 | 4952 | static int qsort_strcmp(const void *a, const void *b) |
40b4f539 | 4953 | { |
ceff5bd7 | 4954 | return strcmp(*(char *const *)a, *(char *const *)b); |
40b4f539 KW |
4955 | } |
4956 | ||
61007b31 | 4957 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
9ac404c5 | 4958 | void *opaque, bool read_only) |
40b4f539 | 4959 | { |
61007b31 SH |
4960 | BlockDriver *drv; |
4961 | int count = 0; | |
4962 | int i; | |
4963 | const char **formats = NULL; | |
40b4f539 | 4964 | |
61007b31 SH |
4965 | QLIST_FOREACH(drv, &bdrv_drivers, list) { |
4966 | if (drv->format_name) { | |
4967 | bool found = false; | |
4968 | int i = count; | |
9ac404c5 AS |
4969 | |
4970 | if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv, read_only)) { | |
4971 | continue; | |
4972 | } | |
4973 | ||
61007b31 SH |
4974 | while (formats && i && !found) { |
4975 | found = !strcmp(formats[--i], drv->format_name); | |
4976 | } | |
e2a305fb | 4977 | |
61007b31 SH |
4978 | if (!found) { |
4979 | formats = g_renew(const char *, formats, count + 1); | |
4980 | formats[count++] = drv->format_name; | |
4981 | } | |
6c5a42ac | 4982 | } |
61007b31 | 4983 | } |
6c5a42ac | 4984 | |
eb0df69f HR |
4985 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); i++) { |
4986 | const char *format_name = block_driver_modules[i].format_name; | |
4987 | ||
4988 | if (format_name) { | |
4989 | bool found = false; | |
4990 | int j = count; | |
4991 | ||
9ac404c5 AS |
4992 | if (use_bdrv_whitelist && |
4993 | !bdrv_format_is_whitelisted(format_name, read_only)) { | |
4994 | continue; | |
4995 | } | |
4996 | ||
eb0df69f HR |
4997 | while (formats && j && !found) { |
4998 | found = !strcmp(formats[--j], format_name); | |
4999 | } | |
5000 | ||
5001 | if (!found) { | |
5002 | formats = g_renew(const char *, formats, count + 1); | |
5003 | formats[count++] = format_name; | |
5004 | } | |
5005 | } | |
5006 | } | |
5007 | ||
61007b31 | 5008 | qsort(formats, count, sizeof(formats[0]), qsort_strcmp); |
40b4f539 | 5009 | |
61007b31 SH |
5010 | for (i = 0; i < count; i++) { |
5011 | it(opaque, formats[i]); | |
5012 | } | |
40b4f539 | 5013 | |
61007b31 SH |
5014 | g_free(formats); |
5015 | } | |
40b4f539 | 5016 | |
61007b31 SH |
5017 | /* This function is to find a node in the bs graph */ |
5018 | BlockDriverState *bdrv_find_node(const char *node_name) | |
5019 | { | |
5020 | BlockDriverState *bs; | |
391827eb | 5021 | |
61007b31 | 5022 | assert(node_name); |
40b4f539 | 5023 | |
61007b31 SH |
5024 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { |
5025 | if (!strcmp(node_name, bs->node_name)) { | |
5026 | return bs; | |
40b4f539 KW |
5027 | } |
5028 | } | |
61007b31 | 5029 | return NULL; |
40b4f539 KW |
5030 | } |
5031 | ||
61007b31 | 5032 | /* Put this QMP function here so it can access the static graph_bdrv_states. */ |
facda544 PK |
5033 | BlockDeviceInfoList *bdrv_named_nodes_list(bool flat, |
5034 | Error **errp) | |
40b4f539 | 5035 | { |
61007b31 SH |
5036 | BlockDeviceInfoList *list, *entry; |
5037 | BlockDriverState *bs; | |
40b4f539 | 5038 | |
61007b31 SH |
5039 | list = NULL; |
5040 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { | |
facda544 | 5041 | BlockDeviceInfo *info = bdrv_block_device_info(NULL, bs, flat, errp); |
61007b31 SH |
5042 | if (!info) { |
5043 | qapi_free_BlockDeviceInfoList(list); | |
5044 | return NULL; | |
301db7c2 | 5045 | } |
61007b31 SH |
5046 | entry = g_malloc0(sizeof(*entry)); |
5047 | entry->value = info; | |
5048 | entry->next = list; | |
5049 | list = entry; | |
301db7c2 RH |
5050 | } |
5051 | ||
61007b31 SH |
5052 | return list; |
5053 | } | |
40b4f539 | 5054 | |
5d3b4e99 VSO |
5055 | #define QAPI_LIST_ADD(list, element) do { \ |
5056 | typeof(list) _tmp = g_new(typeof(*(list)), 1); \ | |
5057 | _tmp->value = (element); \ | |
5058 | _tmp->next = (list); \ | |
5059 | (list) = _tmp; \ | |
5060 | } while (0) | |
5061 | ||
5062 | typedef struct XDbgBlockGraphConstructor { | |
5063 | XDbgBlockGraph *graph; | |
5064 | GHashTable *graph_nodes; | |
5065 | } XDbgBlockGraphConstructor; | |
5066 | ||
5067 | static XDbgBlockGraphConstructor *xdbg_graph_new(void) | |
5068 | { | |
5069 | XDbgBlockGraphConstructor *gr = g_new(XDbgBlockGraphConstructor, 1); | |
5070 | ||
5071 | gr->graph = g_new0(XDbgBlockGraph, 1); | |
5072 | gr->graph_nodes = g_hash_table_new(NULL, NULL); | |
5073 | ||
5074 | return gr; | |
5075 | } | |
5076 | ||
5077 | static XDbgBlockGraph *xdbg_graph_finalize(XDbgBlockGraphConstructor *gr) | |
5078 | { | |
5079 | XDbgBlockGraph *graph = gr->graph; | |
5080 | ||
5081 | g_hash_table_destroy(gr->graph_nodes); | |
5082 | g_free(gr); | |
5083 | ||
5084 | return graph; | |
5085 | } | |
5086 | ||
5087 | static uintptr_t xdbg_graph_node_num(XDbgBlockGraphConstructor *gr, void *node) | |
5088 | { | |
5089 | uintptr_t ret = (uintptr_t)g_hash_table_lookup(gr->graph_nodes, node); | |
5090 | ||
5091 | if (ret != 0) { | |
5092 | return ret; | |
5093 | } | |
5094 | ||
5095 | /* | |
5096 | * Start counting from 1, not 0, because 0 interferes with not-found (NULL) | |
5097 | * answer of g_hash_table_lookup. | |
5098 | */ | |
5099 | ret = g_hash_table_size(gr->graph_nodes) + 1; | |
5100 | g_hash_table_insert(gr->graph_nodes, node, (void *)ret); | |
5101 | ||
5102 | return ret; | |
5103 | } | |
5104 | ||
5105 | static void xdbg_graph_add_node(XDbgBlockGraphConstructor *gr, void *node, | |
5106 | XDbgBlockGraphNodeType type, const char *name) | |
5107 | { | |
5108 | XDbgBlockGraphNode *n; | |
5109 | ||
5110 | n = g_new0(XDbgBlockGraphNode, 1); | |
5111 | ||
5112 | n->id = xdbg_graph_node_num(gr, node); | |
5113 | n->type = type; | |
5114 | n->name = g_strdup(name); | |
5115 | ||
5116 | QAPI_LIST_ADD(gr->graph->nodes, n); | |
5117 | } | |
5118 | ||
5119 | static void xdbg_graph_add_edge(XDbgBlockGraphConstructor *gr, void *parent, | |
5120 | const BdrvChild *child) | |
5121 | { | |
cdb1cec8 | 5122 | BlockPermission qapi_perm; |
5d3b4e99 VSO |
5123 | XDbgBlockGraphEdge *edge; |
5124 | ||
5d3b4e99 VSO |
5125 | edge = g_new0(XDbgBlockGraphEdge, 1); |
5126 | ||
5127 | edge->parent = xdbg_graph_node_num(gr, parent); | |
5128 | edge->child = xdbg_graph_node_num(gr, child->bs); | |
5129 | edge->name = g_strdup(child->name); | |
5130 | ||
cdb1cec8 HR |
5131 | for (qapi_perm = 0; qapi_perm < BLOCK_PERMISSION__MAX; qapi_perm++) { |
5132 | uint64_t flag = bdrv_qapi_perm_to_blk_perm(qapi_perm); | |
5133 | ||
5134 | if (flag & child->perm) { | |
5135 | QAPI_LIST_ADD(edge->perm, qapi_perm); | |
5d3b4e99 | 5136 | } |
cdb1cec8 HR |
5137 | if (flag & child->shared_perm) { |
5138 | QAPI_LIST_ADD(edge->shared_perm, qapi_perm); | |
5d3b4e99 VSO |
5139 | } |
5140 | } | |
5141 | ||
5142 | QAPI_LIST_ADD(gr->graph->edges, edge); | |
5143 | } | |
5144 | ||
5145 | ||
5146 | XDbgBlockGraph *bdrv_get_xdbg_block_graph(Error **errp) | |
5147 | { | |
5148 | BlockBackend *blk; | |
5149 | BlockJob *job; | |
5150 | BlockDriverState *bs; | |
5151 | BdrvChild *child; | |
5152 | XDbgBlockGraphConstructor *gr = xdbg_graph_new(); | |
5153 | ||
5154 | for (blk = blk_all_next(NULL); blk; blk = blk_all_next(blk)) { | |
5155 | char *allocated_name = NULL; | |
5156 | const char *name = blk_name(blk); | |
5157 | ||
5158 | if (!*name) { | |
5159 | name = allocated_name = blk_get_attached_dev_id(blk); | |
5160 | } | |
5161 | xdbg_graph_add_node(gr, blk, X_DBG_BLOCK_GRAPH_NODE_TYPE_BLOCK_BACKEND, | |
5162 | name); | |
5163 | g_free(allocated_name); | |
5164 | if (blk_root(blk)) { | |
5165 | xdbg_graph_add_edge(gr, blk, blk_root(blk)); | |
5166 | } | |
5167 | } | |
5168 | ||
5169 | for (job = block_job_next(NULL); job; job = block_job_next(job)) { | |
5170 | GSList *el; | |
5171 | ||
5172 | xdbg_graph_add_node(gr, job, X_DBG_BLOCK_GRAPH_NODE_TYPE_BLOCK_JOB, | |
5173 | job->job.id); | |
5174 | for (el = job->nodes; el; el = el->next) { | |
5175 | xdbg_graph_add_edge(gr, job, (BdrvChild *)el->data); | |
5176 | } | |
5177 | } | |
5178 | ||
5179 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { | |
5180 | xdbg_graph_add_node(gr, bs, X_DBG_BLOCK_GRAPH_NODE_TYPE_BLOCK_DRIVER, | |
5181 | bs->node_name); | |
5182 | QLIST_FOREACH(child, &bs->children, next) { | |
5183 | xdbg_graph_add_edge(gr, bs, child); | |
5184 | } | |
5185 | } | |
5186 | ||
5187 | return xdbg_graph_finalize(gr); | |
5188 | } | |
5189 | ||
61007b31 SH |
5190 | BlockDriverState *bdrv_lookup_bs(const char *device, |
5191 | const char *node_name, | |
5192 | Error **errp) | |
5193 | { | |
5194 | BlockBackend *blk; | |
5195 | BlockDriverState *bs; | |
40b4f539 | 5196 | |
61007b31 SH |
5197 | if (device) { |
5198 | blk = blk_by_name(device); | |
40b4f539 | 5199 | |
61007b31 | 5200 | if (blk) { |
9f4ed6fb AG |
5201 | bs = blk_bs(blk); |
5202 | if (!bs) { | |
5433c24f | 5203 | error_setg(errp, "Device '%s' has no medium", device); |
5433c24f HR |
5204 | } |
5205 | ||
9f4ed6fb | 5206 | return bs; |
61007b31 SH |
5207 | } |
5208 | } | |
40b4f539 | 5209 | |
61007b31 SH |
5210 | if (node_name) { |
5211 | bs = bdrv_find_node(node_name); | |
6d519a5f | 5212 | |
61007b31 SH |
5213 | if (bs) { |
5214 | return bs; | |
5215 | } | |
40b4f539 KW |
5216 | } |
5217 | ||
61007b31 SH |
5218 | error_setg(errp, "Cannot find device=%s nor node_name=%s", |
5219 | device ? device : "", | |
5220 | node_name ? node_name : ""); | |
5221 | return NULL; | |
40b4f539 KW |
5222 | } |
5223 | ||
61007b31 SH |
5224 | /* If 'base' is in the same chain as 'top', return true. Otherwise, |
5225 | * return false. If either argument is NULL, return false. */ | |
5226 | bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base) | |
83f64091 | 5227 | { |
61007b31 | 5228 | while (top && top != base) { |
760e0063 | 5229 | top = backing_bs(top); |
02c50efe | 5230 | } |
61007b31 SH |
5231 | |
5232 | return top != NULL; | |
02c50efe FZ |
5233 | } |
5234 | ||
61007b31 | 5235 | BlockDriverState *bdrv_next_node(BlockDriverState *bs) |
02c50efe | 5236 | { |
61007b31 SH |
5237 | if (!bs) { |
5238 | return QTAILQ_FIRST(&graph_bdrv_states); | |
02c50efe | 5239 | } |
61007b31 | 5240 | return QTAILQ_NEXT(bs, node_list); |
83f64091 FB |
5241 | } |
5242 | ||
0f12264e KW |
5243 | BlockDriverState *bdrv_next_all_states(BlockDriverState *bs) |
5244 | { | |
5245 | if (!bs) { | |
5246 | return QTAILQ_FIRST(&all_bdrv_states); | |
5247 | } | |
5248 | return QTAILQ_NEXT(bs, bs_list); | |
5249 | } | |
5250 | ||
61007b31 | 5251 | const char *bdrv_get_node_name(const BlockDriverState *bs) |
83f64091 | 5252 | { |
61007b31 | 5253 | return bs->node_name; |
beac80cd FB |
5254 | } |
5255 | ||
1f0c461b | 5256 | const char *bdrv_get_parent_name(const BlockDriverState *bs) |
4c265bf9 KW |
5257 | { |
5258 | BdrvChild *c; | |
5259 | const char *name; | |
5260 | ||
5261 | /* If multiple parents have a name, just pick the first one. */ | |
5262 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
bd86fb99 HR |
5263 | if (c->klass->get_name) { |
5264 | name = c->klass->get_name(c); | |
4c265bf9 KW |
5265 | if (name && *name) { |
5266 | return name; | |
5267 | } | |
5268 | } | |
5269 | } | |
5270 | ||
5271 | return NULL; | |
5272 | } | |
5273 | ||
61007b31 SH |
5274 | /* TODO check what callers really want: bs->node_name or blk_name() */ |
5275 | const char *bdrv_get_device_name(const BlockDriverState *bs) | |
beac80cd | 5276 | { |
4c265bf9 | 5277 | return bdrv_get_parent_name(bs) ?: ""; |
f141eafe | 5278 | } |
83f64091 | 5279 | |
61007b31 SH |
5280 | /* This can be used to identify nodes that might not have a device |
5281 | * name associated. Since node and device names live in the same | |
5282 | * namespace, the result is unambiguous. The exception is if both are | |
5283 | * absent, then this returns an empty (non-null) string. */ | |
5284 | const char *bdrv_get_device_or_node_name(const BlockDriverState *bs) | |
f141eafe | 5285 | { |
4c265bf9 | 5286 | return bdrv_get_parent_name(bs) ?: bs->node_name; |
beac80cd | 5287 | } |
beac80cd | 5288 | |
61007b31 | 5289 | int bdrv_get_flags(BlockDriverState *bs) |
0b5a2445 | 5290 | { |
61007b31 | 5291 | return bs->open_flags; |
0b5a2445 PB |
5292 | } |
5293 | ||
61007b31 | 5294 | int bdrv_has_zero_init_1(BlockDriverState *bs) |
68485420 | 5295 | { |
61007b31 | 5296 | return 1; |
0b5a2445 PB |
5297 | } |
5298 | ||
61007b31 | 5299 | int bdrv_has_zero_init(BlockDriverState *bs) |
0b5a2445 | 5300 | { |
d470ad42 HR |
5301 | if (!bs->drv) { |
5302 | return 0; | |
5303 | } | |
0b5a2445 | 5304 | |
61007b31 SH |
5305 | /* If BS is a copy on write image, it is initialized to |
5306 | the contents of the base image, which may not be zeroes. */ | |
760e0063 | 5307 | if (bs->backing) { |
61007b31 SH |
5308 | return 0; |
5309 | } | |
5310 | if (bs->drv->bdrv_has_zero_init) { | |
5311 | return bs->drv->bdrv_has_zero_init(bs); | |
0b5a2445 | 5312 | } |
5a612c00 MP |
5313 | if (bs->file && bs->drv->is_filter) { |
5314 | return bdrv_has_zero_init(bs->file->bs); | |
5315 | } | |
61007b31 SH |
5316 | |
5317 | /* safe default */ | |
5318 | return 0; | |
68485420 KW |
5319 | } |
5320 | ||
61007b31 | 5321 | bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs) |
b2a61371 | 5322 | { |
61007b31 | 5323 | BlockDriverInfo bdi; |
b2a61371 | 5324 | |
760e0063 | 5325 | if (bs->backing) { |
61007b31 SH |
5326 | return false; |
5327 | } | |
5328 | ||
5329 | if (bdrv_get_info(bs, &bdi) == 0) { | |
5330 | return bdi.unallocated_blocks_are_zero; | |
b2a61371 SH |
5331 | } |
5332 | ||
61007b31 | 5333 | return false; |
b2a61371 SH |
5334 | } |
5335 | ||
61007b31 | 5336 | bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs) |
68485420 | 5337 | { |
2f0342ef | 5338 | if (!(bs->open_flags & BDRV_O_UNMAP)) { |
61007b31 SH |
5339 | return false; |
5340 | } | |
68485420 | 5341 | |
e24d813b | 5342 | return bs->supported_zero_flags & BDRV_REQ_MAY_UNMAP; |
68485420 KW |
5343 | } |
5344 | ||
61007b31 SH |
5345 | void bdrv_get_backing_filename(BlockDriverState *bs, |
5346 | char *filename, int filename_size) | |
016f5cf6 | 5347 | { |
61007b31 SH |
5348 | pstrcpy(filename, filename_size, bs->backing_file); |
5349 | } | |
d318aea9 | 5350 | |
61007b31 SH |
5351 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi) |
5352 | { | |
5353 | BlockDriver *drv = bs->drv; | |
5a612c00 MP |
5354 | /* if bs->drv == NULL, bs is closed, so there's nothing to do here */ |
5355 | if (!drv) { | |
61007b31 | 5356 | return -ENOMEDIUM; |
5a612c00 MP |
5357 | } |
5358 | if (!drv->bdrv_get_info) { | |
5359 | if (bs->file && drv->is_filter) { | |
5360 | return bdrv_get_info(bs->file->bs, bdi); | |
5361 | } | |
61007b31 | 5362 | return -ENOTSUP; |
5a612c00 | 5363 | } |
61007b31 SH |
5364 | memset(bdi, 0, sizeof(*bdi)); |
5365 | return drv->bdrv_get_info(bs, bdi); | |
5366 | } | |
016f5cf6 | 5367 | |
1bf6e9ca AS |
5368 | ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs, |
5369 | Error **errp) | |
61007b31 SH |
5370 | { |
5371 | BlockDriver *drv = bs->drv; | |
5372 | if (drv && drv->bdrv_get_specific_info) { | |
1bf6e9ca | 5373 | return drv->bdrv_get_specific_info(bs, errp); |
61007b31 SH |
5374 | } |
5375 | return NULL; | |
016f5cf6 AG |
5376 | } |
5377 | ||
d9245599 AN |
5378 | BlockStatsSpecific *bdrv_get_specific_stats(BlockDriverState *bs) |
5379 | { | |
5380 | BlockDriver *drv = bs->drv; | |
5381 | if (!drv || !drv->bdrv_get_specific_stats) { | |
5382 | return NULL; | |
5383 | } | |
5384 | return drv->bdrv_get_specific_stats(bs); | |
5385 | } | |
5386 | ||
a31939e6 | 5387 | void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event) |
4265d620 | 5388 | { |
61007b31 SH |
5389 | if (!bs || !bs->drv || !bs->drv->bdrv_debug_event) { |
5390 | return; | |
5391 | } | |
4265d620 | 5392 | |
61007b31 | 5393 | bs->drv->bdrv_debug_event(bs, event); |
4265d620 PB |
5394 | } |
5395 | ||
d10529a2 | 5396 | static BlockDriverState *bdrv_find_debug_node(BlockDriverState *bs) |
4265d620 | 5397 | { |
61007b31 | 5398 | while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) { |
d10529a2 VSO |
5399 | if (bs->file) { |
5400 | bs = bs->file->bs; | |
5401 | continue; | |
5402 | } | |
5403 | ||
5404 | if (bs->drv->is_filter && bs->backing) { | |
5405 | bs = bs->backing->bs; | |
5406 | continue; | |
5407 | } | |
5408 | ||
5409 | break; | |
61007b31 | 5410 | } |
4265d620 | 5411 | |
61007b31 | 5412 | if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) { |
d10529a2 VSO |
5413 | assert(bs->drv->bdrv_debug_remove_breakpoint); |
5414 | return bs; | |
5415 | } | |
5416 | ||
5417 | return NULL; | |
5418 | } | |
5419 | ||
5420 | int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, | |
5421 | const char *tag) | |
5422 | { | |
5423 | bs = bdrv_find_debug_node(bs); | |
5424 | if (bs) { | |
61007b31 SH |
5425 | return bs->drv->bdrv_debug_breakpoint(bs, event, tag); |
5426 | } | |
4265d620 | 5427 | |
61007b31 | 5428 | return -ENOTSUP; |
4265d620 PB |
5429 | } |
5430 | ||
61007b31 | 5431 | int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag) |
ea2384d3 | 5432 | { |
d10529a2 VSO |
5433 | bs = bdrv_find_debug_node(bs); |
5434 | if (bs) { | |
61007b31 SH |
5435 | return bs->drv->bdrv_debug_remove_breakpoint(bs, tag); |
5436 | } | |
5437 | ||
5438 | return -ENOTSUP; | |
eb852011 MA |
5439 | } |
5440 | ||
61007b31 | 5441 | int bdrv_debug_resume(BlockDriverState *bs, const char *tag) |
ce1a14dc | 5442 | { |
61007b31 | 5443 | while (bs && (!bs->drv || !bs->drv->bdrv_debug_resume)) { |
9a4f4c31 | 5444 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 5445 | } |
ce1a14dc | 5446 | |
61007b31 SH |
5447 | if (bs && bs->drv && bs->drv->bdrv_debug_resume) { |
5448 | return bs->drv->bdrv_debug_resume(bs, tag); | |
5449 | } | |
ce1a14dc | 5450 | |
61007b31 | 5451 | return -ENOTSUP; |
f197fe2b FZ |
5452 | } |
5453 | ||
61007b31 | 5454 | bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag) |
ce1a14dc | 5455 | { |
61007b31 | 5456 | while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) { |
9a4f4c31 | 5457 | bs = bs->file ? bs->file->bs : NULL; |
f197fe2b | 5458 | } |
19cb3738 | 5459 | |
61007b31 SH |
5460 | if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) { |
5461 | return bs->drv->bdrv_debug_is_suspended(bs, tag); | |
5462 | } | |
f9f05dc5 | 5463 | |
61007b31 SH |
5464 | return false; |
5465 | } | |
f9f05dc5 | 5466 | |
61007b31 SH |
5467 | /* backing_file can either be relative, or absolute, or a protocol. If it is |
5468 | * relative, it must be relative to the chain. So, passing in bs->filename | |
5469 | * from a BDS as backing_file should not be done, as that may be relative to | |
5470 | * the CWD rather than the chain. */ | |
5471 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, | |
5472 | const char *backing_file) | |
f9f05dc5 | 5473 | { |
61007b31 SH |
5474 | char *filename_full = NULL; |
5475 | char *backing_file_full = NULL; | |
5476 | char *filename_tmp = NULL; | |
5477 | int is_protocol = 0; | |
5478 | BlockDriverState *curr_bs = NULL; | |
5479 | BlockDriverState *retval = NULL; | |
f9f05dc5 | 5480 | |
61007b31 SH |
5481 | if (!bs || !bs->drv || !backing_file) { |
5482 | return NULL; | |
f9f05dc5 KW |
5483 | } |
5484 | ||
61007b31 SH |
5485 | filename_full = g_malloc(PATH_MAX); |
5486 | backing_file_full = g_malloc(PATH_MAX); | |
f9f05dc5 | 5487 | |
61007b31 | 5488 | is_protocol = path_has_protocol(backing_file); |
f9f05dc5 | 5489 | |
760e0063 | 5490 | for (curr_bs = bs; curr_bs->backing; curr_bs = curr_bs->backing->bs) { |
f9f05dc5 | 5491 | |
61007b31 SH |
5492 | /* If either of the filename paths is actually a protocol, then |
5493 | * compare unmodified paths; otherwise make paths relative */ | |
5494 | if (is_protocol || path_has_protocol(curr_bs->backing_file)) { | |
6b6833c1 HR |
5495 | char *backing_file_full_ret; |
5496 | ||
61007b31 | 5497 | if (strcmp(backing_file, curr_bs->backing_file) == 0) { |
760e0063 | 5498 | retval = curr_bs->backing->bs; |
61007b31 SH |
5499 | break; |
5500 | } | |
418661e0 | 5501 | /* Also check against the full backing filename for the image */ |
6b6833c1 HR |
5502 | backing_file_full_ret = bdrv_get_full_backing_filename(curr_bs, |
5503 | NULL); | |
5504 | if (backing_file_full_ret) { | |
5505 | bool equal = strcmp(backing_file, backing_file_full_ret) == 0; | |
5506 | g_free(backing_file_full_ret); | |
5507 | if (equal) { | |
418661e0 JC |
5508 | retval = curr_bs->backing->bs; |
5509 | break; | |
5510 | } | |
418661e0 | 5511 | } |
61007b31 SH |
5512 | } else { |
5513 | /* If not an absolute filename path, make it relative to the current | |
5514 | * image's filename path */ | |
2d9158ce HR |
5515 | filename_tmp = bdrv_make_absolute_filename(curr_bs, backing_file, |
5516 | NULL); | |
5517 | /* We are going to compare canonicalized absolute pathnames */ | |
5518 | if (!filename_tmp || !realpath(filename_tmp, filename_full)) { | |
5519 | g_free(filename_tmp); | |
61007b31 SH |
5520 | continue; |
5521 | } | |
2d9158ce | 5522 | g_free(filename_tmp); |
07f07615 | 5523 | |
61007b31 SH |
5524 | /* We need to make sure the backing filename we are comparing against |
5525 | * is relative to the current image filename (or absolute) */ | |
2d9158ce HR |
5526 | filename_tmp = bdrv_get_full_backing_filename(curr_bs, NULL); |
5527 | if (!filename_tmp || !realpath(filename_tmp, backing_file_full)) { | |
5528 | g_free(filename_tmp); | |
61007b31 SH |
5529 | continue; |
5530 | } | |
2d9158ce | 5531 | g_free(filename_tmp); |
eb489bb1 | 5532 | |
61007b31 | 5533 | if (strcmp(backing_file_full, filename_full) == 0) { |
760e0063 | 5534 | retval = curr_bs->backing->bs; |
61007b31 SH |
5535 | break; |
5536 | } | |
5537 | } | |
eb489bb1 KW |
5538 | } |
5539 | ||
61007b31 SH |
5540 | g_free(filename_full); |
5541 | g_free(backing_file_full); | |
61007b31 SH |
5542 | return retval; |
5543 | } | |
5544 | ||
61007b31 SH |
5545 | void bdrv_init(void) |
5546 | { | |
5547 | module_call_init(MODULE_INIT_BLOCK); | |
5548 | } | |
29cdb251 | 5549 | |
61007b31 SH |
5550 | void bdrv_init_with_whitelist(void) |
5551 | { | |
5552 | use_bdrv_whitelist = 1; | |
5553 | bdrv_init(); | |
07f07615 PB |
5554 | } |
5555 | ||
2b148f39 PB |
5556 | static void coroutine_fn bdrv_co_invalidate_cache(BlockDriverState *bs, |
5557 | Error **errp) | |
0f15423c | 5558 | { |
4417ab7a | 5559 | BdrvChild *child, *parent; |
9c5e6594 | 5560 | uint64_t perm, shared_perm; |
5a8a30db KW |
5561 | Error *local_err = NULL; |
5562 | int ret; | |
9c98f145 | 5563 | BdrvDirtyBitmap *bm; |
5a8a30db | 5564 | |
3456a8d1 KW |
5565 | if (!bs->drv) { |
5566 | return; | |
5567 | } | |
5568 | ||
16e977d5 | 5569 | QLIST_FOREACH(child, &bs->children, next) { |
2b148f39 | 5570 | bdrv_co_invalidate_cache(child->bs, &local_err); |
0d1c5c91 | 5571 | if (local_err) { |
0d1c5c91 FZ |
5572 | error_propagate(errp, local_err); |
5573 | return; | |
5574 | } | |
5a8a30db | 5575 | } |
0d1c5c91 | 5576 | |
dafe0960 KW |
5577 | /* |
5578 | * Update permissions, they may differ for inactive nodes. | |
5579 | * | |
5580 | * Note that the required permissions of inactive images are always a | |
5581 | * subset of the permissions required after activating the image. This | |
5582 | * allows us to just get the permissions upfront without restricting | |
5583 | * drv->bdrv_invalidate_cache(). | |
5584 | * | |
5585 | * It also means that in error cases, we don't have to try and revert to | |
5586 | * the old permissions (which is an operation that could fail, too). We can | |
5587 | * just keep the extended permissions for the next time that an activation | |
5588 | * of the image is tried. | |
5589 | */ | |
7bb4941a KW |
5590 | if (bs->open_flags & BDRV_O_INACTIVE) { |
5591 | bs->open_flags &= ~BDRV_O_INACTIVE; | |
5592 | bdrv_get_cumulative_perm(bs, &perm, &shared_perm); | |
5593 | ret = bdrv_check_perm(bs, NULL, perm, shared_perm, NULL, NULL, &local_err); | |
5594 | if (ret < 0) { | |
0d1c5c91 FZ |
5595 | bs->open_flags |= BDRV_O_INACTIVE; |
5596 | error_propagate(errp, local_err); | |
5597 | return; | |
5598 | } | |
7bb4941a | 5599 | bdrv_set_perm(bs, perm, shared_perm); |
3456a8d1 | 5600 | |
7bb4941a KW |
5601 | if (bs->drv->bdrv_co_invalidate_cache) { |
5602 | bs->drv->bdrv_co_invalidate_cache(bs, &local_err); | |
5603 | if (local_err) { | |
5604 | bs->open_flags |= BDRV_O_INACTIVE; | |
5605 | error_propagate(errp, local_err); | |
5606 | return; | |
5607 | } | |
5608 | } | |
9c98f145 | 5609 | |
7bb4941a KW |
5610 | FOR_EACH_DIRTY_BITMAP(bs, bm) { |
5611 | bdrv_dirty_bitmap_skip_store(bm, false); | |
5612 | } | |
5613 | ||
5614 | ret = refresh_total_sectors(bs, bs->total_sectors); | |
5615 | if (ret < 0) { | |
5616 | bs->open_flags |= BDRV_O_INACTIVE; | |
5617 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); | |
5618 | return; | |
5619 | } | |
5a8a30db | 5620 | } |
4417ab7a KW |
5621 | |
5622 | QLIST_FOREACH(parent, &bs->parents, next_parent) { | |
bd86fb99 HR |
5623 | if (parent->klass->activate) { |
5624 | parent->klass->activate(parent, &local_err); | |
4417ab7a | 5625 | if (local_err) { |
78fc3b3a | 5626 | bs->open_flags |= BDRV_O_INACTIVE; |
4417ab7a KW |
5627 | error_propagate(errp, local_err); |
5628 | return; | |
5629 | } | |
5630 | } | |
5631 | } | |
0f15423c AL |
5632 | } |
5633 | ||
2b148f39 PB |
5634 | typedef struct InvalidateCacheCo { |
5635 | BlockDriverState *bs; | |
5636 | Error **errp; | |
5637 | bool done; | |
5638 | } InvalidateCacheCo; | |
5639 | ||
5640 | static void coroutine_fn bdrv_invalidate_cache_co_entry(void *opaque) | |
5641 | { | |
5642 | InvalidateCacheCo *ico = opaque; | |
5643 | bdrv_co_invalidate_cache(ico->bs, ico->errp); | |
5644 | ico->done = true; | |
4720cbee | 5645 | aio_wait_kick(); |
2b148f39 PB |
5646 | } |
5647 | ||
5648 | void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp) | |
5649 | { | |
5650 | Coroutine *co; | |
5651 | InvalidateCacheCo ico = { | |
5652 | .bs = bs, | |
5653 | .done = false, | |
5654 | .errp = errp | |
5655 | }; | |
5656 | ||
5657 | if (qemu_in_coroutine()) { | |
5658 | /* Fast-path if already in coroutine context */ | |
5659 | bdrv_invalidate_cache_co_entry(&ico); | |
5660 | } else { | |
5661 | co = qemu_coroutine_create(bdrv_invalidate_cache_co_entry, &ico); | |
4720cbee | 5662 | bdrv_coroutine_enter(bs, co); |
2b148f39 PB |
5663 | BDRV_POLL_WHILE(bs, !ico.done); |
5664 | } | |
5665 | } | |
5666 | ||
5a8a30db | 5667 | void bdrv_invalidate_cache_all(Error **errp) |
0f15423c | 5668 | { |
7c8eece4 | 5669 | BlockDriverState *bs; |
5a8a30db | 5670 | Error *local_err = NULL; |
88be7b4b | 5671 | BdrvNextIterator it; |
0f15423c | 5672 | |
88be7b4b | 5673 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
ed78cda3 SH |
5674 | AioContext *aio_context = bdrv_get_aio_context(bs); |
5675 | ||
5676 | aio_context_acquire(aio_context); | |
5a8a30db | 5677 | bdrv_invalidate_cache(bs, &local_err); |
ed78cda3 | 5678 | aio_context_release(aio_context); |
5a8a30db KW |
5679 | if (local_err) { |
5680 | error_propagate(errp, local_err); | |
5e003f17 | 5681 | bdrv_next_cleanup(&it); |
5a8a30db KW |
5682 | return; |
5683 | } | |
0f15423c AL |
5684 | } |
5685 | } | |
5686 | ||
9e37271f KW |
5687 | static bool bdrv_has_bds_parent(BlockDriverState *bs, bool only_active) |
5688 | { | |
5689 | BdrvChild *parent; | |
5690 | ||
5691 | QLIST_FOREACH(parent, &bs->parents, next_parent) { | |
bd86fb99 | 5692 | if (parent->klass->parent_is_bds) { |
9e37271f KW |
5693 | BlockDriverState *parent_bs = parent->opaque; |
5694 | if (!only_active || !(parent_bs->open_flags & BDRV_O_INACTIVE)) { | |
5695 | return true; | |
5696 | } | |
5697 | } | |
5698 | } | |
5699 | ||
5700 | return false; | |
5701 | } | |
5702 | ||
5703 | static int bdrv_inactivate_recurse(BlockDriverState *bs) | |
76b1c7fe | 5704 | { |
cfa1a572 | 5705 | BdrvChild *child, *parent; |
1046779e | 5706 | bool tighten_restrictions; |
9e37271f | 5707 | uint64_t perm, shared_perm; |
76b1c7fe KW |
5708 | int ret; |
5709 | ||
d470ad42 HR |
5710 | if (!bs->drv) { |
5711 | return -ENOMEDIUM; | |
5712 | } | |
5713 | ||
9e37271f KW |
5714 | /* Make sure that we don't inactivate a child before its parent. |
5715 | * It will be covered by recursion from the yet active parent. */ | |
5716 | if (bdrv_has_bds_parent(bs, true)) { | |
5717 | return 0; | |
5718 | } | |
5719 | ||
5720 | assert(!(bs->open_flags & BDRV_O_INACTIVE)); | |
5721 | ||
5722 | /* Inactivate this node */ | |
5723 | if (bs->drv->bdrv_inactivate) { | |
76b1c7fe KW |
5724 | ret = bs->drv->bdrv_inactivate(bs); |
5725 | if (ret < 0) { | |
5726 | return ret; | |
5727 | } | |
5728 | } | |
5729 | ||
9e37271f | 5730 | QLIST_FOREACH(parent, &bs->parents, next_parent) { |
bd86fb99 HR |
5731 | if (parent->klass->inactivate) { |
5732 | ret = parent->klass->inactivate(parent); | |
9e37271f KW |
5733 | if (ret < 0) { |
5734 | return ret; | |
cfa1a572 KW |
5735 | } |
5736 | } | |
9e37271f | 5737 | } |
9c5e6594 | 5738 | |
9e37271f | 5739 | bs->open_flags |= BDRV_O_INACTIVE; |
7d5b5261 | 5740 | |
9e37271f KW |
5741 | /* Update permissions, they may differ for inactive nodes */ |
5742 | bdrv_get_cumulative_perm(bs, &perm, &shared_perm); | |
1046779e HR |
5743 | ret = bdrv_check_perm(bs, NULL, perm, shared_perm, NULL, |
5744 | &tighten_restrictions, NULL); | |
5745 | assert(tighten_restrictions == false); | |
5746 | if (ret < 0) { | |
5747 | /* We only tried to loosen restrictions, so errors are not fatal */ | |
5748 | bdrv_abort_perm_update(bs); | |
5749 | } else { | |
5750 | bdrv_set_perm(bs, perm, shared_perm); | |
5751 | } | |
38701b6a | 5752 | |
9e37271f KW |
5753 | |
5754 | /* Recursively inactivate children */ | |
38701b6a | 5755 | QLIST_FOREACH(child, &bs->children, next) { |
9e37271f | 5756 | ret = bdrv_inactivate_recurse(child->bs); |
38701b6a KW |
5757 | if (ret < 0) { |
5758 | return ret; | |
5759 | } | |
5760 | } | |
5761 | ||
76b1c7fe KW |
5762 | return 0; |
5763 | } | |
5764 | ||
5765 | int bdrv_inactivate_all(void) | |
5766 | { | |
79720af6 | 5767 | BlockDriverState *bs = NULL; |
88be7b4b | 5768 | BdrvNextIterator it; |
aad0b7a0 | 5769 | int ret = 0; |
bd6458e4 | 5770 | GSList *aio_ctxs = NULL, *ctx; |
76b1c7fe | 5771 | |
88be7b4b | 5772 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
bd6458e4 PB |
5773 | AioContext *aio_context = bdrv_get_aio_context(bs); |
5774 | ||
5775 | if (!g_slist_find(aio_ctxs, aio_context)) { | |
5776 | aio_ctxs = g_slist_prepend(aio_ctxs, aio_context); | |
5777 | aio_context_acquire(aio_context); | |
5778 | } | |
aad0b7a0 | 5779 | } |
76b1c7fe | 5780 | |
9e37271f KW |
5781 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
5782 | /* Nodes with BDS parents are covered by recursion from the last | |
5783 | * parent that gets inactivated. Don't inactivate them a second | |
5784 | * time if that has already happened. */ | |
5785 | if (bdrv_has_bds_parent(bs, false)) { | |
5786 | continue; | |
5787 | } | |
5788 | ret = bdrv_inactivate_recurse(bs); | |
5789 | if (ret < 0) { | |
5790 | bdrv_next_cleanup(&it); | |
5791 | goto out; | |
76b1c7fe KW |
5792 | } |
5793 | } | |
5794 | ||
aad0b7a0 | 5795 | out: |
bd6458e4 PB |
5796 | for (ctx = aio_ctxs; ctx != NULL; ctx = ctx->next) { |
5797 | AioContext *aio_context = ctx->data; | |
5798 | aio_context_release(aio_context); | |
aad0b7a0 | 5799 | } |
bd6458e4 | 5800 | g_slist_free(aio_ctxs); |
aad0b7a0 FZ |
5801 | |
5802 | return ret; | |
76b1c7fe KW |
5803 | } |
5804 | ||
19cb3738 FB |
5805 | /**************************************************************/ |
5806 | /* removable device support */ | |
5807 | ||
5808 | /** | |
5809 | * Return TRUE if the media is present | |
5810 | */ | |
e031f750 | 5811 | bool bdrv_is_inserted(BlockDriverState *bs) |
19cb3738 FB |
5812 | { |
5813 | BlockDriver *drv = bs->drv; | |
28d7a789 | 5814 | BdrvChild *child; |
a1aff5bf | 5815 | |
e031f750 HR |
5816 | if (!drv) { |
5817 | return false; | |
5818 | } | |
28d7a789 HR |
5819 | if (drv->bdrv_is_inserted) { |
5820 | return drv->bdrv_is_inserted(bs); | |
5821 | } | |
5822 | QLIST_FOREACH(child, &bs->children, next) { | |
5823 | if (!bdrv_is_inserted(child->bs)) { | |
5824 | return false; | |
5825 | } | |
e031f750 | 5826 | } |
28d7a789 | 5827 | return true; |
19cb3738 FB |
5828 | } |
5829 | ||
19cb3738 FB |
5830 | /** |
5831 | * If eject_flag is TRUE, eject the media. Otherwise, close the tray | |
5832 | */ | |
f36f3949 | 5833 | void bdrv_eject(BlockDriverState *bs, bool eject_flag) |
19cb3738 FB |
5834 | { |
5835 | BlockDriver *drv = bs->drv; | |
19cb3738 | 5836 | |
822e1cd1 MA |
5837 | if (drv && drv->bdrv_eject) { |
5838 | drv->bdrv_eject(bs, eject_flag); | |
19cb3738 FB |
5839 | } |
5840 | } | |
5841 | ||
19cb3738 FB |
5842 | /** |
5843 | * Lock or unlock the media (if it is locked, the user won't be able | |
5844 | * to eject it manually). | |
5845 | */ | |
025e849a | 5846 | void bdrv_lock_medium(BlockDriverState *bs, bool locked) |
19cb3738 FB |
5847 | { |
5848 | BlockDriver *drv = bs->drv; | |
5849 | ||
025e849a | 5850 | trace_bdrv_lock_medium(bs, locked); |
b8c6d095 | 5851 | |
025e849a MA |
5852 | if (drv && drv->bdrv_lock_medium) { |
5853 | drv->bdrv_lock_medium(bs, locked); | |
19cb3738 FB |
5854 | } |
5855 | } | |
985a03b0 | 5856 | |
9fcb0251 FZ |
5857 | /* Get a reference to bs */ |
5858 | void bdrv_ref(BlockDriverState *bs) | |
5859 | { | |
5860 | bs->refcnt++; | |
5861 | } | |
5862 | ||
5863 | /* Release a previously grabbed reference to bs. | |
5864 | * If after releasing, reference count is zero, the BlockDriverState is | |
5865 | * deleted. */ | |
5866 | void bdrv_unref(BlockDriverState *bs) | |
5867 | { | |
9a4d5ca6 JC |
5868 | if (!bs) { |
5869 | return; | |
5870 | } | |
9fcb0251 FZ |
5871 | assert(bs->refcnt > 0); |
5872 | if (--bs->refcnt == 0) { | |
5873 | bdrv_delete(bs); | |
5874 | } | |
5875 | } | |
5876 | ||
fbe40ff7 FZ |
5877 | struct BdrvOpBlocker { |
5878 | Error *reason; | |
5879 | QLIST_ENTRY(BdrvOpBlocker) list; | |
5880 | }; | |
5881 | ||
5882 | bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp) | |
5883 | { | |
5884 | BdrvOpBlocker *blocker; | |
5885 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
5886 | if (!QLIST_EMPTY(&bs->op_blockers[op])) { | |
5887 | blocker = QLIST_FIRST(&bs->op_blockers[op]); | |
4b576648 MA |
5888 | error_propagate_prepend(errp, error_copy(blocker->reason), |
5889 | "Node '%s' is busy: ", | |
5890 | bdrv_get_device_or_node_name(bs)); | |
fbe40ff7 FZ |
5891 | return true; |
5892 | } | |
5893 | return false; | |
5894 | } | |
5895 | ||
5896 | void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason) | |
5897 | { | |
5898 | BdrvOpBlocker *blocker; | |
5899 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
5900 | ||
5839e53b | 5901 | blocker = g_new0(BdrvOpBlocker, 1); |
fbe40ff7 FZ |
5902 | blocker->reason = reason; |
5903 | QLIST_INSERT_HEAD(&bs->op_blockers[op], blocker, list); | |
5904 | } | |
5905 | ||
5906 | void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason) | |
5907 | { | |
5908 | BdrvOpBlocker *blocker, *next; | |
5909 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
5910 | QLIST_FOREACH_SAFE(blocker, &bs->op_blockers[op], list, next) { | |
5911 | if (blocker->reason == reason) { | |
5912 | QLIST_REMOVE(blocker, list); | |
5913 | g_free(blocker); | |
5914 | } | |
5915 | } | |
5916 | } | |
5917 | ||
5918 | void bdrv_op_block_all(BlockDriverState *bs, Error *reason) | |
5919 | { | |
5920 | int i; | |
5921 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
5922 | bdrv_op_block(bs, i, reason); | |
5923 | } | |
5924 | } | |
5925 | ||
5926 | void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason) | |
5927 | { | |
5928 | int i; | |
5929 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
5930 | bdrv_op_unblock(bs, i, reason); | |
5931 | } | |
5932 | } | |
5933 | ||
5934 | bool bdrv_op_blocker_is_empty(BlockDriverState *bs) | |
5935 | { | |
5936 | int i; | |
5937 | ||
5938 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
5939 | if (!QLIST_EMPTY(&bs->op_blockers[i])) { | |
5940 | return false; | |
5941 | } | |
5942 | } | |
5943 | return true; | |
5944 | } | |
5945 | ||
d92ada22 LC |
5946 | void bdrv_img_create(const char *filename, const char *fmt, |
5947 | const char *base_filename, const char *base_fmt, | |
9217283d FZ |
5948 | char *options, uint64_t img_size, int flags, bool quiet, |
5949 | Error **errp) | |
f88e1a42 | 5950 | { |
83d0521a CL |
5951 | QemuOptsList *create_opts = NULL; |
5952 | QemuOpts *opts = NULL; | |
5953 | const char *backing_fmt, *backing_file; | |
5954 | int64_t size; | |
f88e1a42 | 5955 | BlockDriver *drv, *proto_drv; |
cc84d90f | 5956 | Error *local_err = NULL; |
f88e1a42 JS |
5957 | int ret = 0; |
5958 | ||
5959 | /* Find driver and parse its options */ | |
5960 | drv = bdrv_find_format(fmt); | |
5961 | if (!drv) { | |
71c79813 | 5962 | error_setg(errp, "Unknown file format '%s'", fmt); |
d92ada22 | 5963 | return; |
f88e1a42 JS |
5964 | } |
5965 | ||
b65a5e12 | 5966 | proto_drv = bdrv_find_protocol(filename, true, errp); |
f88e1a42 | 5967 | if (!proto_drv) { |
d92ada22 | 5968 | return; |
f88e1a42 JS |
5969 | } |
5970 | ||
c6149724 HR |
5971 | if (!drv->create_opts) { |
5972 | error_setg(errp, "Format driver '%s' does not support image creation", | |
5973 | drv->format_name); | |
5974 | return; | |
5975 | } | |
5976 | ||
5a5e7f8c ML |
5977 | if (!proto_drv->create_opts) { |
5978 | error_setg(errp, "Protocol driver '%s' does not support image creation", | |
5979 | proto_drv->format_name); | |
5980 | return; | |
5981 | } | |
5982 | ||
f6dc1c31 | 5983 | /* Create parameter list */ |
c282e1fd | 5984 | create_opts = qemu_opts_append(create_opts, drv->create_opts); |
5a5e7f8c | 5985 | create_opts = qemu_opts_append(create_opts, proto_drv->create_opts); |
f88e1a42 | 5986 | |
83d0521a | 5987 | opts = qemu_opts_create(create_opts, NULL, 0, &error_abort); |
f88e1a42 JS |
5988 | |
5989 | /* Parse -o options */ | |
5990 | if (options) { | |
dc523cd3 MA |
5991 | qemu_opts_do_parse(opts, options, NULL, &local_err); |
5992 | if (local_err) { | |
f88e1a42 JS |
5993 | goto out; |
5994 | } | |
5995 | } | |
5996 | ||
f6dc1c31 KW |
5997 | if (!qemu_opt_get(opts, BLOCK_OPT_SIZE)) { |
5998 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort); | |
5999 | } else if (img_size != UINT64_C(-1)) { | |
6000 | error_setg(errp, "The image size must be specified only once"); | |
6001 | goto out; | |
6002 | } | |
6003 | ||
f88e1a42 | 6004 | if (base_filename) { |
f43e47db | 6005 | qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &local_err); |
6be4194b | 6006 | if (local_err) { |
71c79813 LC |
6007 | error_setg(errp, "Backing file not supported for file format '%s'", |
6008 | fmt); | |
f88e1a42 JS |
6009 | goto out; |
6010 | } | |
6011 | } | |
6012 | ||
6013 | if (base_fmt) { | |
f43e47db | 6014 | qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &local_err); |
6be4194b | 6015 | if (local_err) { |
71c79813 LC |
6016 | error_setg(errp, "Backing file format not supported for file " |
6017 | "format '%s'", fmt); | |
f88e1a42 JS |
6018 | goto out; |
6019 | } | |
6020 | } | |
6021 | ||
83d0521a CL |
6022 | backing_file = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE); |
6023 | if (backing_file) { | |
6024 | if (!strcmp(filename, backing_file)) { | |
71c79813 LC |
6025 | error_setg(errp, "Error: Trying to create an image with the " |
6026 | "same filename as the backing file"); | |
792da93a JS |
6027 | goto out; |
6028 | } | |
6029 | } | |
6030 | ||
83d0521a | 6031 | backing_fmt = qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT); |
f88e1a42 | 6032 | |
6e6e55f5 JS |
6033 | /* The size for the image must always be specified, unless we have a backing |
6034 | * file and we have not been forbidden from opening it. */ | |
a8b42a1c | 6035 | size = qemu_opt_get_size(opts, BLOCK_OPT_SIZE, img_size); |
6e6e55f5 JS |
6036 | if (backing_file && !(flags & BDRV_O_NO_BACKING)) { |
6037 | BlockDriverState *bs; | |
645ae7d8 | 6038 | char *full_backing; |
6e6e55f5 JS |
6039 | int back_flags; |
6040 | QDict *backing_options = NULL; | |
6041 | ||
645ae7d8 HR |
6042 | full_backing = |
6043 | bdrv_get_full_backing_filename_from_filename(filename, backing_file, | |
6044 | &local_err); | |
6e6e55f5 | 6045 | if (local_err) { |
6e6e55f5 JS |
6046 | goto out; |
6047 | } | |
645ae7d8 | 6048 | assert(full_backing); |
29168018 | 6049 | |
6e6e55f5 JS |
6050 | /* backing files always opened read-only */ |
6051 | back_flags = flags; | |
6052 | back_flags &= ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING); | |
f88e1a42 | 6053 | |
cc954f01 | 6054 | backing_options = qdict_new(); |
6e6e55f5 | 6055 | if (backing_fmt) { |
6e6e55f5 JS |
6056 | qdict_put_str(backing_options, "driver", backing_fmt); |
6057 | } | |
cc954f01 | 6058 | qdict_put_bool(backing_options, BDRV_OPT_FORCE_SHARE, true); |
e6641719 | 6059 | |
6e6e55f5 JS |
6060 | bs = bdrv_open(full_backing, NULL, backing_options, back_flags, |
6061 | &local_err); | |
6062 | g_free(full_backing); | |
6063 | if (!bs && size != -1) { | |
6064 | /* Couldn't open BS, but we have a size, so it's nonfatal */ | |
6065 | warn_reportf_err(local_err, | |
6066 | "Could not verify backing image. " | |
6067 | "This may become an error in future versions.\n"); | |
6068 | local_err = NULL; | |
6069 | } else if (!bs) { | |
6070 | /* Couldn't open bs, do not have size */ | |
6071 | error_append_hint(&local_err, | |
6072 | "Could not open backing image to determine size.\n"); | |
6073 | goto out; | |
6074 | } else { | |
6075 | if (size == -1) { | |
6076 | /* Opened BS, have no size */ | |
6077 | size = bdrv_getlength(bs); | |
6078 | if (size < 0) { | |
6079 | error_setg_errno(errp, -size, "Could not get size of '%s'", | |
6080 | backing_file); | |
6081 | bdrv_unref(bs); | |
6082 | goto out; | |
6083 | } | |
6084 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, size, &error_abort); | |
52bf1e72 | 6085 | } |
66f6b814 | 6086 | bdrv_unref(bs); |
f88e1a42 | 6087 | } |
6e6e55f5 JS |
6088 | } /* (backing_file && !(flags & BDRV_O_NO_BACKING)) */ |
6089 | ||
6090 | if (size == -1) { | |
6091 | error_setg(errp, "Image creation needs a size parameter"); | |
6092 | goto out; | |
f88e1a42 JS |
6093 | } |
6094 | ||
f382d43a | 6095 | if (!quiet) { |
fe646693 | 6096 | printf("Formatting '%s', fmt=%s ", filename, fmt); |
43c5d8f8 | 6097 | qemu_opts_print(opts, " "); |
f382d43a MR |
6098 | puts(""); |
6099 | } | |
83d0521a | 6100 | |
c282e1fd | 6101 | ret = bdrv_create(drv, filename, opts, &local_err); |
83d0521a | 6102 | |
cc84d90f HR |
6103 | if (ret == -EFBIG) { |
6104 | /* This is generally a better message than whatever the driver would | |
6105 | * deliver (especially because of the cluster_size_hint), since that | |
6106 | * is most probably not much different from "image too large". */ | |
6107 | const char *cluster_size_hint = ""; | |
83d0521a | 6108 | if (qemu_opt_get_size(opts, BLOCK_OPT_CLUSTER_SIZE, 0)) { |
cc84d90f | 6109 | cluster_size_hint = " (try using a larger cluster size)"; |
f88e1a42 | 6110 | } |
cc84d90f HR |
6111 | error_setg(errp, "The image size is too large for file format '%s'" |
6112 | "%s", fmt, cluster_size_hint); | |
6113 | error_free(local_err); | |
6114 | local_err = NULL; | |
f88e1a42 JS |
6115 | } |
6116 | ||
6117 | out: | |
83d0521a CL |
6118 | qemu_opts_del(opts); |
6119 | qemu_opts_free(create_opts); | |
621ff94d | 6120 | error_propagate(errp, local_err); |
f88e1a42 | 6121 | } |
85d126f3 SH |
6122 | |
6123 | AioContext *bdrv_get_aio_context(BlockDriverState *bs) | |
6124 | { | |
33f2a757 | 6125 | return bs ? bs->aio_context : qemu_get_aio_context(); |
dcd04228 SH |
6126 | } |
6127 | ||
052a7572 FZ |
6128 | void bdrv_coroutine_enter(BlockDriverState *bs, Coroutine *co) |
6129 | { | |
6130 | aio_co_enter(bdrv_get_aio_context(bs), co); | |
6131 | } | |
6132 | ||
e8a095da SH |
6133 | static void bdrv_do_remove_aio_context_notifier(BdrvAioNotifier *ban) |
6134 | { | |
6135 | QLIST_REMOVE(ban, list); | |
6136 | g_free(ban); | |
6137 | } | |
6138 | ||
a3a683c3 | 6139 | static void bdrv_detach_aio_context(BlockDriverState *bs) |
dcd04228 | 6140 | { |
e8a095da | 6141 | BdrvAioNotifier *baf, *baf_tmp; |
33384421 | 6142 | |
e8a095da SH |
6143 | assert(!bs->walking_aio_notifiers); |
6144 | bs->walking_aio_notifiers = true; | |
6145 | QLIST_FOREACH_SAFE(baf, &bs->aio_notifiers, list, baf_tmp) { | |
6146 | if (baf->deleted) { | |
6147 | bdrv_do_remove_aio_context_notifier(baf); | |
6148 | } else { | |
6149 | baf->detach_aio_context(baf->opaque); | |
6150 | } | |
33384421 | 6151 | } |
e8a095da SH |
6152 | /* Never mind iterating again to check for ->deleted. bdrv_close() will |
6153 | * remove remaining aio notifiers if we aren't called again. | |
6154 | */ | |
6155 | bs->walking_aio_notifiers = false; | |
33384421 | 6156 | |
1bffe1ae | 6157 | if (bs->drv && bs->drv->bdrv_detach_aio_context) { |
dcd04228 SH |
6158 | bs->drv->bdrv_detach_aio_context(bs); |
6159 | } | |
dcd04228 | 6160 | |
e64f25f3 KW |
6161 | if (bs->quiesce_counter) { |
6162 | aio_enable_external(bs->aio_context); | |
6163 | } | |
dcd04228 SH |
6164 | bs->aio_context = NULL; |
6165 | } | |
6166 | ||
a3a683c3 KW |
6167 | static void bdrv_attach_aio_context(BlockDriverState *bs, |
6168 | AioContext *new_context) | |
dcd04228 | 6169 | { |
e8a095da | 6170 | BdrvAioNotifier *ban, *ban_tmp; |
33384421 | 6171 | |
e64f25f3 KW |
6172 | if (bs->quiesce_counter) { |
6173 | aio_disable_external(new_context); | |
6174 | } | |
6175 | ||
dcd04228 SH |
6176 | bs->aio_context = new_context; |
6177 | ||
1bffe1ae | 6178 | if (bs->drv && bs->drv->bdrv_attach_aio_context) { |
dcd04228 SH |
6179 | bs->drv->bdrv_attach_aio_context(bs, new_context); |
6180 | } | |
33384421 | 6181 | |
e8a095da SH |
6182 | assert(!bs->walking_aio_notifiers); |
6183 | bs->walking_aio_notifiers = true; | |
6184 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_tmp) { | |
6185 | if (ban->deleted) { | |
6186 | bdrv_do_remove_aio_context_notifier(ban); | |
6187 | } else { | |
6188 | ban->attached_aio_context(new_context, ban->opaque); | |
6189 | } | |
33384421 | 6190 | } |
e8a095da | 6191 | bs->walking_aio_notifiers = false; |
dcd04228 SH |
6192 | } |
6193 | ||
42a65f02 KW |
6194 | /* |
6195 | * Changes the AioContext used for fd handlers, timers, and BHs by this | |
6196 | * BlockDriverState and all its children and parents. | |
6197 | * | |
43eaaaef HR |
6198 | * Must be called from the main AioContext. |
6199 | * | |
42a65f02 KW |
6200 | * The caller must own the AioContext lock for the old AioContext of bs, but it |
6201 | * must not own the AioContext lock for new_context (unless new_context is the | |
6202 | * same as the current context of bs). | |
6203 | * | |
6204 | * @ignore will accumulate all visited BdrvChild object. The caller is | |
6205 | * responsible for freeing the list afterwards. | |
6206 | */ | |
53a7d041 KW |
6207 | void bdrv_set_aio_context_ignore(BlockDriverState *bs, |
6208 | AioContext *new_context, GSList **ignore) | |
dcd04228 | 6209 | { |
e037c09c | 6210 | AioContext *old_context = bdrv_get_aio_context(bs); |
0d83708a KW |
6211 | BdrvChild *child; |
6212 | ||
43eaaaef HR |
6213 | g_assert(qemu_get_current_aio_context() == qemu_get_aio_context()); |
6214 | ||
e037c09c | 6215 | if (old_context == new_context) { |
57830a49 DP |
6216 | return; |
6217 | } | |
6218 | ||
d70d5954 | 6219 | bdrv_drained_begin(bs); |
0d83708a KW |
6220 | |
6221 | QLIST_FOREACH(child, &bs->children, next) { | |
53a7d041 KW |
6222 | if (g_slist_find(*ignore, child)) { |
6223 | continue; | |
6224 | } | |
6225 | *ignore = g_slist_prepend(*ignore, child); | |
6226 | bdrv_set_aio_context_ignore(child->bs, new_context, ignore); | |
6227 | } | |
6228 | QLIST_FOREACH(child, &bs->parents, next_parent) { | |
6229 | if (g_slist_find(*ignore, child)) { | |
6230 | continue; | |
6231 | } | |
bd86fb99 | 6232 | assert(child->klass->set_aio_ctx); |
42a65f02 | 6233 | *ignore = g_slist_prepend(*ignore, child); |
bd86fb99 | 6234 | child->klass->set_aio_ctx(child, new_context, ignore); |
0d83708a KW |
6235 | } |
6236 | ||
dcd04228 SH |
6237 | bdrv_detach_aio_context(bs); |
6238 | ||
e037c09c | 6239 | /* Acquire the new context, if necessary */ |
43eaaaef | 6240 | if (qemu_get_aio_context() != new_context) { |
e037c09c HR |
6241 | aio_context_acquire(new_context); |
6242 | } | |
6243 | ||
dcd04228 | 6244 | bdrv_attach_aio_context(bs, new_context); |
e037c09c HR |
6245 | |
6246 | /* | |
6247 | * If this function was recursively called from | |
6248 | * bdrv_set_aio_context_ignore(), there may be nodes in the | |
6249 | * subtree that have not yet been moved to the new AioContext. | |
6250 | * Release the old one so bdrv_drained_end() can poll them. | |
6251 | */ | |
43eaaaef | 6252 | if (qemu_get_aio_context() != old_context) { |
e037c09c HR |
6253 | aio_context_release(old_context); |
6254 | } | |
6255 | ||
d70d5954 | 6256 | bdrv_drained_end(bs); |
e037c09c | 6257 | |
43eaaaef | 6258 | if (qemu_get_aio_context() != old_context) { |
e037c09c HR |
6259 | aio_context_acquire(old_context); |
6260 | } | |
43eaaaef | 6261 | if (qemu_get_aio_context() != new_context) { |
e037c09c HR |
6262 | aio_context_release(new_context); |
6263 | } | |
85d126f3 | 6264 | } |
d616b224 | 6265 | |
5d231849 KW |
6266 | static bool bdrv_parent_can_set_aio_context(BdrvChild *c, AioContext *ctx, |
6267 | GSList **ignore, Error **errp) | |
6268 | { | |
6269 | if (g_slist_find(*ignore, c)) { | |
6270 | return true; | |
6271 | } | |
6272 | *ignore = g_slist_prepend(*ignore, c); | |
6273 | ||
bd86fb99 HR |
6274 | /* |
6275 | * A BdrvChildClass that doesn't handle AioContext changes cannot | |
6276 | * tolerate any AioContext changes | |
6277 | */ | |
6278 | if (!c->klass->can_set_aio_ctx) { | |
5d231849 KW |
6279 | char *user = bdrv_child_user_desc(c); |
6280 | error_setg(errp, "Changing iothreads is not supported by %s", user); | |
6281 | g_free(user); | |
6282 | return false; | |
6283 | } | |
bd86fb99 | 6284 | if (!c->klass->can_set_aio_ctx(c, ctx, ignore, errp)) { |
5d231849 KW |
6285 | assert(!errp || *errp); |
6286 | return false; | |
6287 | } | |
6288 | return true; | |
6289 | } | |
6290 | ||
6291 | bool bdrv_child_can_set_aio_context(BdrvChild *c, AioContext *ctx, | |
6292 | GSList **ignore, Error **errp) | |
6293 | { | |
6294 | if (g_slist_find(*ignore, c)) { | |
6295 | return true; | |
6296 | } | |
6297 | *ignore = g_slist_prepend(*ignore, c); | |
6298 | return bdrv_can_set_aio_context(c->bs, ctx, ignore, errp); | |
6299 | } | |
6300 | ||
6301 | /* @ignore will accumulate all visited BdrvChild object. The caller is | |
6302 | * responsible for freeing the list afterwards. */ | |
6303 | bool bdrv_can_set_aio_context(BlockDriverState *bs, AioContext *ctx, | |
6304 | GSList **ignore, Error **errp) | |
6305 | { | |
6306 | BdrvChild *c; | |
6307 | ||
6308 | if (bdrv_get_aio_context(bs) == ctx) { | |
6309 | return true; | |
6310 | } | |
6311 | ||
6312 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
6313 | if (!bdrv_parent_can_set_aio_context(c, ctx, ignore, errp)) { | |
6314 | return false; | |
6315 | } | |
6316 | } | |
6317 | QLIST_FOREACH(c, &bs->children, next) { | |
6318 | if (!bdrv_child_can_set_aio_context(c, ctx, ignore, errp)) { | |
6319 | return false; | |
6320 | } | |
6321 | } | |
6322 | ||
6323 | return true; | |
6324 | } | |
6325 | ||
6326 | int bdrv_child_try_set_aio_context(BlockDriverState *bs, AioContext *ctx, | |
6327 | BdrvChild *ignore_child, Error **errp) | |
6328 | { | |
6329 | GSList *ignore; | |
6330 | bool ret; | |
6331 | ||
6332 | ignore = ignore_child ? g_slist_prepend(NULL, ignore_child) : NULL; | |
6333 | ret = bdrv_can_set_aio_context(bs, ctx, &ignore, errp); | |
6334 | g_slist_free(ignore); | |
6335 | ||
6336 | if (!ret) { | |
6337 | return -EPERM; | |
6338 | } | |
6339 | ||
53a7d041 KW |
6340 | ignore = ignore_child ? g_slist_prepend(NULL, ignore_child) : NULL; |
6341 | bdrv_set_aio_context_ignore(bs, ctx, &ignore); | |
6342 | g_slist_free(ignore); | |
6343 | ||
5d231849 KW |
6344 | return 0; |
6345 | } | |
6346 | ||
6347 | int bdrv_try_set_aio_context(BlockDriverState *bs, AioContext *ctx, | |
6348 | Error **errp) | |
6349 | { | |
6350 | return bdrv_child_try_set_aio_context(bs, ctx, NULL, errp); | |
6351 | } | |
6352 | ||
33384421 HR |
6353 | void bdrv_add_aio_context_notifier(BlockDriverState *bs, |
6354 | void (*attached_aio_context)(AioContext *new_context, void *opaque), | |
6355 | void (*detach_aio_context)(void *opaque), void *opaque) | |
6356 | { | |
6357 | BdrvAioNotifier *ban = g_new(BdrvAioNotifier, 1); | |
6358 | *ban = (BdrvAioNotifier){ | |
6359 | .attached_aio_context = attached_aio_context, | |
6360 | .detach_aio_context = detach_aio_context, | |
6361 | .opaque = opaque | |
6362 | }; | |
6363 | ||
6364 | QLIST_INSERT_HEAD(&bs->aio_notifiers, ban, list); | |
6365 | } | |
6366 | ||
6367 | void bdrv_remove_aio_context_notifier(BlockDriverState *bs, | |
6368 | void (*attached_aio_context)(AioContext *, | |
6369 | void *), | |
6370 | void (*detach_aio_context)(void *), | |
6371 | void *opaque) | |
6372 | { | |
6373 | BdrvAioNotifier *ban, *ban_next; | |
6374 | ||
6375 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { | |
6376 | if (ban->attached_aio_context == attached_aio_context && | |
6377 | ban->detach_aio_context == detach_aio_context && | |
e8a095da SH |
6378 | ban->opaque == opaque && |
6379 | ban->deleted == false) | |
33384421 | 6380 | { |
e8a095da SH |
6381 | if (bs->walking_aio_notifiers) { |
6382 | ban->deleted = true; | |
6383 | } else { | |
6384 | bdrv_do_remove_aio_context_notifier(ban); | |
6385 | } | |
33384421 HR |
6386 | return; |
6387 | } | |
6388 | } | |
6389 | ||
6390 | abort(); | |
6391 | } | |
6392 | ||
77485434 | 6393 | int bdrv_amend_options(BlockDriverState *bs, QemuOpts *opts, |
d1402b50 HR |
6394 | BlockDriverAmendStatusCB *status_cb, void *cb_opaque, |
6395 | Error **errp) | |
6f176b48 | 6396 | { |
d470ad42 | 6397 | if (!bs->drv) { |
d1402b50 | 6398 | error_setg(errp, "Node is ejected"); |
d470ad42 HR |
6399 | return -ENOMEDIUM; |
6400 | } | |
c282e1fd | 6401 | if (!bs->drv->bdrv_amend_options) { |
d1402b50 HR |
6402 | error_setg(errp, "Block driver '%s' does not support option amendment", |
6403 | bs->drv->format_name); | |
6f176b48 HR |
6404 | return -ENOTSUP; |
6405 | } | |
d1402b50 | 6406 | return bs->drv->bdrv_amend_options(bs, opts, status_cb, cb_opaque, errp); |
6f176b48 | 6407 | } |
f6186f49 | 6408 | |
5d69b5ab HR |
6409 | /* |
6410 | * This function checks whether the given @to_replace is allowed to be | |
6411 | * replaced by a node that always shows the same data as @bs. This is | |
6412 | * used for example to verify whether the mirror job can replace | |
6413 | * @to_replace by the target mirrored from @bs. | |
6414 | * To be replaceable, @bs and @to_replace may either be guaranteed to | |
6415 | * always show the same data (because they are only connected through | |
6416 | * filters), or some driver may allow replacing one of its children | |
6417 | * because it can guarantee that this child's data is not visible at | |
6418 | * all (for example, for dissenting quorum children that have no other | |
6419 | * parents). | |
6420 | */ | |
6421 | bool bdrv_recurse_can_replace(BlockDriverState *bs, | |
6422 | BlockDriverState *to_replace) | |
6423 | { | |
6424 | if (!bs || !bs->drv) { | |
6425 | return false; | |
6426 | } | |
6427 | ||
6428 | if (bs == to_replace) { | |
6429 | return true; | |
6430 | } | |
6431 | ||
6432 | /* See what the driver can do */ | |
6433 | if (bs->drv->bdrv_recurse_can_replace) { | |
6434 | return bs->drv->bdrv_recurse_can_replace(bs, to_replace); | |
6435 | } | |
6436 | ||
6437 | /* For filters without an own implementation, we can recurse on our own */ | |
6438 | if (bs->drv->is_filter) { | |
6439 | BdrvChild *child = bs->file ?: bs->backing; | |
6440 | return bdrv_recurse_can_replace(child->bs, to_replace); | |
6441 | } | |
6442 | ||
6443 | /* Safe default */ | |
6444 | return false; | |
6445 | } | |
6446 | ||
810803a8 HR |
6447 | /* |
6448 | * Check whether the given @node_name can be replaced by a node that | |
6449 | * has the same data as @parent_bs. If so, return @node_name's BDS; | |
6450 | * NULL otherwise. | |
6451 | * | |
6452 | * @node_name must be a (recursive) *child of @parent_bs (or this | |
6453 | * function will return NULL). | |
6454 | * | |
6455 | * The result (whether the node can be replaced or not) is only valid | |
6456 | * for as long as no graph or permission changes occur. | |
6457 | */ | |
e12f3784 WC |
6458 | BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs, |
6459 | const char *node_name, Error **errp) | |
09158f00 BC |
6460 | { |
6461 | BlockDriverState *to_replace_bs = bdrv_find_node(node_name); | |
5a7e7a0b SH |
6462 | AioContext *aio_context; |
6463 | ||
09158f00 BC |
6464 | if (!to_replace_bs) { |
6465 | error_setg(errp, "Node name '%s' not found", node_name); | |
6466 | return NULL; | |
6467 | } | |
6468 | ||
5a7e7a0b SH |
6469 | aio_context = bdrv_get_aio_context(to_replace_bs); |
6470 | aio_context_acquire(aio_context); | |
6471 | ||
09158f00 | 6472 | if (bdrv_op_is_blocked(to_replace_bs, BLOCK_OP_TYPE_REPLACE, errp)) { |
5a7e7a0b SH |
6473 | to_replace_bs = NULL; |
6474 | goto out; | |
09158f00 BC |
6475 | } |
6476 | ||
6477 | /* We don't want arbitrary node of the BDS chain to be replaced only the top | |
6478 | * most non filter in order to prevent data corruption. | |
6479 | * Another benefit is that this tests exclude backing files which are | |
6480 | * blocked by the backing blockers. | |
6481 | */ | |
810803a8 HR |
6482 | if (!bdrv_recurse_can_replace(parent_bs, to_replace_bs)) { |
6483 | error_setg(errp, "Cannot replace '%s' by a node mirrored from '%s', " | |
6484 | "because it cannot be guaranteed that doing so would not " | |
6485 | "lead to an abrupt change of visible data", | |
6486 | node_name, parent_bs->node_name); | |
5a7e7a0b SH |
6487 | to_replace_bs = NULL; |
6488 | goto out; | |
09158f00 BC |
6489 | } |
6490 | ||
5a7e7a0b SH |
6491 | out: |
6492 | aio_context_release(aio_context); | |
09158f00 BC |
6493 | return to_replace_bs; |
6494 | } | |
448ad91d | 6495 | |
97e2f021 HR |
6496 | /** |
6497 | * Iterates through the list of runtime option keys that are said to | |
6498 | * be "strong" for a BDS. An option is called "strong" if it changes | |
6499 | * a BDS's data. For example, the null block driver's "size" and | |
6500 | * "read-zeroes" options are strong, but its "latency-ns" option is | |
6501 | * not. | |
6502 | * | |
6503 | * If a key returned by this function ends with a dot, all options | |
6504 | * starting with that prefix are strong. | |
6505 | */ | |
6506 | static const char *const *strong_options(BlockDriverState *bs, | |
6507 | const char *const *curopt) | |
6508 | { | |
6509 | static const char *const global_options[] = { | |
6510 | "driver", "filename", NULL | |
6511 | }; | |
6512 | ||
6513 | if (!curopt) { | |
6514 | return &global_options[0]; | |
6515 | } | |
6516 | ||
6517 | curopt++; | |
6518 | if (curopt == &global_options[ARRAY_SIZE(global_options) - 1] && bs->drv) { | |
6519 | curopt = bs->drv->strong_runtime_opts; | |
6520 | } | |
6521 | ||
6522 | return (curopt && *curopt) ? curopt : NULL; | |
6523 | } | |
6524 | ||
6525 | /** | |
6526 | * Copies all strong runtime options from bs->options to the given | |
6527 | * QDict. The set of strong option keys is determined by invoking | |
6528 | * strong_options(). | |
6529 | * | |
6530 | * Returns true iff any strong option was present in bs->options (and | |
6531 | * thus copied to the target QDict) with the exception of "filename" | |
6532 | * and "driver". The caller is expected to use this value to decide | |
6533 | * whether the existence of strong options prevents the generation of | |
6534 | * a plain filename. | |
6535 | */ | |
6536 | static bool append_strong_runtime_options(QDict *d, BlockDriverState *bs) | |
6537 | { | |
6538 | bool found_any = false; | |
6539 | const char *const *option_name = NULL; | |
6540 | ||
6541 | if (!bs->drv) { | |
6542 | return false; | |
6543 | } | |
6544 | ||
6545 | while ((option_name = strong_options(bs, option_name))) { | |
6546 | bool option_given = false; | |
6547 | ||
6548 | assert(strlen(*option_name) > 0); | |
6549 | if ((*option_name)[strlen(*option_name) - 1] != '.') { | |
6550 | QObject *entry = qdict_get(bs->options, *option_name); | |
6551 | if (!entry) { | |
6552 | continue; | |
6553 | } | |
6554 | ||
6555 | qdict_put_obj(d, *option_name, qobject_ref(entry)); | |
6556 | option_given = true; | |
6557 | } else { | |
6558 | const QDictEntry *entry; | |
6559 | for (entry = qdict_first(bs->options); entry; | |
6560 | entry = qdict_next(bs->options, entry)) | |
6561 | { | |
6562 | if (strstart(qdict_entry_key(entry), *option_name, NULL)) { | |
6563 | qdict_put_obj(d, qdict_entry_key(entry), | |
6564 | qobject_ref(qdict_entry_value(entry))); | |
6565 | option_given = true; | |
6566 | } | |
6567 | } | |
6568 | } | |
6569 | ||
6570 | /* While "driver" and "filename" need to be included in a JSON filename, | |
6571 | * their existence does not prohibit generation of a plain filename. */ | |
6572 | if (!found_any && option_given && | |
6573 | strcmp(*option_name, "driver") && strcmp(*option_name, "filename")) | |
6574 | { | |
6575 | found_any = true; | |
6576 | } | |
6577 | } | |
6578 | ||
62a01a27 HR |
6579 | if (!qdict_haskey(d, "driver")) { |
6580 | /* Drivers created with bdrv_new_open_driver() may not have a | |
6581 | * @driver option. Add it here. */ | |
6582 | qdict_put_str(d, "driver", bs->drv->format_name); | |
6583 | } | |
6584 | ||
97e2f021 HR |
6585 | return found_any; |
6586 | } | |
6587 | ||
90993623 HR |
6588 | /* Note: This function may return false positives; it may return true |
6589 | * even if opening the backing file specified by bs's image header | |
6590 | * would result in exactly bs->backing. */ | |
6591 | static bool bdrv_backing_overridden(BlockDriverState *bs) | |
6592 | { | |
6593 | if (bs->backing) { | |
6594 | return strcmp(bs->auto_backing_file, | |
6595 | bs->backing->bs->filename); | |
6596 | } else { | |
6597 | /* No backing BDS, so if the image header reports any backing | |
6598 | * file, it must have been suppressed */ | |
6599 | return bs->auto_backing_file[0] != '\0'; | |
6600 | } | |
6601 | } | |
6602 | ||
91af7014 HR |
6603 | /* Updates the following BDS fields: |
6604 | * - exact_filename: A filename which may be used for opening a block device | |
6605 | * which (mostly) equals the given BDS (even without any | |
6606 | * other options; so reading and writing must return the same | |
6607 | * results, but caching etc. may be different) | |
6608 | * - full_open_options: Options which, when given when opening a block device | |
6609 | * (without a filename), result in a BDS (mostly) | |
6610 | * equalling the given one | |
6611 | * - filename: If exact_filename is set, it is copied here. Otherwise, | |
6612 | * full_open_options is converted to a JSON object, prefixed with | |
6613 | * "json:" (for use through the JSON pseudo protocol) and put here. | |
6614 | */ | |
6615 | void bdrv_refresh_filename(BlockDriverState *bs) | |
6616 | { | |
6617 | BlockDriver *drv = bs->drv; | |
e24518e3 | 6618 | BdrvChild *child; |
91af7014 | 6619 | QDict *opts; |
90993623 | 6620 | bool backing_overridden; |
998b3a1e HR |
6621 | bool generate_json_filename; /* Whether our default implementation should |
6622 | fill exact_filename (false) or not (true) */ | |
91af7014 HR |
6623 | |
6624 | if (!drv) { | |
6625 | return; | |
6626 | } | |
6627 | ||
e24518e3 HR |
6628 | /* This BDS's file name may depend on any of its children's file names, so |
6629 | * refresh those first */ | |
6630 | QLIST_FOREACH(child, &bs->children, next) { | |
6631 | bdrv_refresh_filename(child->bs); | |
91af7014 HR |
6632 | } |
6633 | ||
bb808d5f HR |
6634 | if (bs->implicit) { |
6635 | /* For implicit nodes, just copy everything from the single child */ | |
6636 | child = QLIST_FIRST(&bs->children); | |
6637 | assert(QLIST_NEXT(child, next) == NULL); | |
6638 | ||
6639 | pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), | |
6640 | child->bs->exact_filename); | |
6641 | pstrcpy(bs->filename, sizeof(bs->filename), child->bs->filename); | |
6642 | ||
cb895614 | 6643 | qobject_unref(bs->full_open_options); |
bb808d5f HR |
6644 | bs->full_open_options = qobject_ref(child->bs->full_open_options); |
6645 | ||
6646 | return; | |
6647 | } | |
6648 | ||
90993623 HR |
6649 | backing_overridden = bdrv_backing_overridden(bs); |
6650 | ||
6651 | if (bs->open_flags & BDRV_O_NO_IO) { | |
6652 | /* Without I/O, the backing file does not change anything. | |
6653 | * Therefore, in such a case (primarily qemu-img), we can | |
6654 | * pretend the backing file has not been overridden even if | |
6655 | * it technically has been. */ | |
6656 | backing_overridden = false; | |
6657 | } | |
6658 | ||
97e2f021 HR |
6659 | /* Gather the options QDict */ |
6660 | opts = qdict_new(); | |
998b3a1e HR |
6661 | generate_json_filename = append_strong_runtime_options(opts, bs); |
6662 | generate_json_filename |= backing_overridden; | |
97e2f021 HR |
6663 | |
6664 | if (drv->bdrv_gather_child_options) { | |
6665 | /* Some block drivers may not want to present all of their children's | |
6666 | * options, or name them differently from BdrvChild.name */ | |
6667 | drv->bdrv_gather_child_options(bs, opts, backing_overridden); | |
6668 | } else { | |
6669 | QLIST_FOREACH(child, &bs->children, next) { | |
bd86fb99 | 6670 | if (child->klass == &child_backing && !backing_overridden) { |
97e2f021 HR |
6671 | /* We can skip the backing BDS if it has not been overridden */ |
6672 | continue; | |
6673 | } | |
6674 | ||
6675 | qdict_put(opts, child->name, | |
6676 | qobject_ref(child->bs->full_open_options)); | |
6677 | } | |
6678 | ||
6679 | if (backing_overridden && !bs->backing) { | |
6680 | /* Force no backing file */ | |
6681 | qdict_put_null(opts, "backing"); | |
6682 | } | |
6683 | } | |
6684 | ||
6685 | qobject_unref(bs->full_open_options); | |
6686 | bs->full_open_options = opts; | |
6687 | ||
998b3a1e HR |
6688 | if (drv->bdrv_refresh_filename) { |
6689 | /* Obsolete information is of no use here, so drop the old file name | |
6690 | * information before refreshing it */ | |
6691 | bs->exact_filename[0] = '\0'; | |
6692 | ||
6693 | drv->bdrv_refresh_filename(bs); | |
6694 | } else if (bs->file) { | |
6695 | /* Try to reconstruct valid information from the underlying file */ | |
6696 | ||
6697 | bs->exact_filename[0] = '\0'; | |
6698 | ||
fb695c74 HR |
6699 | /* |
6700 | * We can use the underlying file's filename if: | |
6701 | * - it has a filename, | |
6702 | * - the file is a protocol BDS, and | |
6703 | * - opening that file (as this BDS's format) will automatically create | |
6704 | * the BDS tree we have right now, that is: | |
6705 | * - the user did not significantly change this BDS's behavior with | |
6706 | * some explicit (strong) options | |
6707 | * - no non-file child of this BDS has been overridden by the user | |
6708 | * Both of these conditions are represented by generate_json_filename. | |
6709 | */ | |
6710 | if (bs->file->bs->exact_filename[0] && | |
6711 | bs->file->bs->drv->bdrv_file_open && | |
6712 | !generate_json_filename) | |
6713 | { | |
998b3a1e HR |
6714 | strcpy(bs->exact_filename, bs->file->bs->exact_filename); |
6715 | } | |
6716 | } | |
6717 | ||
91af7014 HR |
6718 | if (bs->exact_filename[0]) { |
6719 | pstrcpy(bs->filename, sizeof(bs->filename), bs->exact_filename); | |
97e2f021 | 6720 | } else { |
91af7014 HR |
6721 | QString *json = qobject_to_json(QOBJECT(bs->full_open_options)); |
6722 | snprintf(bs->filename, sizeof(bs->filename), "json:%s", | |
6723 | qstring_get_str(json)); | |
cb3e7f08 | 6724 | qobject_unref(json); |
91af7014 HR |
6725 | } |
6726 | } | |
e06018ad | 6727 | |
1e89d0f9 HR |
6728 | char *bdrv_dirname(BlockDriverState *bs, Error **errp) |
6729 | { | |
6730 | BlockDriver *drv = bs->drv; | |
6731 | ||
6732 | if (!drv) { | |
6733 | error_setg(errp, "Node '%s' is ejected", bs->node_name); | |
6734 | return NULL; | |
6735 | } | |
6736 | ||
6737 | if (drv->bdrv_dirname) { | |
6738 | return drv->bdrv_dirname(bs, errp); | |
6739 | } | |
6740 | ||
6741 | if (bs->file) { | |
6742 | return bdrv_dirname(bs->file->bs, errp); | |
6743 | } | |
6744 | ||
6745 | bdrv_refresh_filename(bs); | |
6746 | if (bs->exact_filename[0] != '\0') { | |
6747 | return path_combine(bs->exact_filename, ""); | |
6748 | } | |
6749 | ||
6750 | error_setg(errp, "Cannot generate a base directory for %s nodes", | |
6751 | drv->format_name); | |
6752 | return NULL; | |
6753 | } | |
6754 | ||
e06018ad WC |
6755 | /* |
6756 | * Hot add/remove a BDS's child. So the user can take a child offline when | |
6757 | * it is broken and take a new child online | |
6758 | */ | |
6759 | void bdrv_add_child(BlockDriverState *parent_bs, BlockDriverState *child_bs, | |
6760 | Error **errp) | |
6761 | { | |
6762 | ||
6763 | if (!parent_bs->drv || !parent_bs->drv->bdrv_add_child) { | |
6764 | error_setg(errp, "The node %s does not support adding a child", | |
6765 | bdrv_get_device_or_node_name(parent_bs)); | |
6766 | return; | |
6767 | } | |
6768 | ||
6769 | if (!QLIST_EMPTY(&child_bs->parents)) { | |
6770 | error_setg(errp, "The node %s already has a parent", | |
6771 | child_bs->node_name); | |
6772 | return; | |
6773 | } | |
6774 | ||
6775 | parent_bs->drv->bdrv_add_child(parent_bs, child_bs, errp); | |
6776 | } | |
6777 | ||
6778 | void bdrv_del_child(BlockDriverState *parent_bs, BdrvChild *child, Error **errp) | |
6779 | { | |
6780 | BdrvChild *tmp; | |
6781 | ||
6782 | if (!parent_bs->drv || !parent_bs->drv->bdrv_del_child) { | |
6783 | error_setg(errp, "The node %s does not support removing a child", | |
6784 | bdrv_get_device_or_node_name(parent_bs)); | |
6785 | return; | |
6786 | } | |
6787 | ||
6788 | QLIST_FOREACH(tmp, &parent_bs->children, next) { | |
6789 | if (tmp == child) { | |
6790 | break; | |
6791 | } | |
6792 | } | |
6793 | ||
6794 | if (!tmp) { | |
6795 | error_setg(errp, "The node %s does not have a child named %s", | |
6796 | bdrv_get_device_or_node_name(parent_bs), | |
6797 | bdrv_get_device_or_node_name(child->bs)); | |
6798 | return; | |
6799 | } | |
6800 | ||
6801 | parent_bs->drv->bdrv_del_child(parent_bs, child, errp); | |
6802 | } | |
6f7a3b53 HR |
6803 | |
6804 | int bdrv_make_empty(BdrvChild *c, Error **errp) | |
6805 | { | |
6806 | BlockDriver *drv = c->bs->drv; | |
6807 | int ret; | |
6808 | ||
6809 | assert(c->perm & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED)); | |
6810 | ||
6811 | if (!drv->bdrv_make_empty) { | |
6812 | error_setg(errp, "%s does not support emptying nodes", | |
6813 | drv->format_name); | |
6814 | return -ENOTSUP; | |
6815 | } | |
6816 | ||
6817 | ret = drv->bdrv_make_empty(c->bs); | |
6818 | if (ret < 0) { | |
6819 | error_setg_errno(errp, -ret, "Failed to empty %s", | |
6820 | c->bs->filename); | |
6821 | return ret; | |
6822 | } | |
6823 | ||
6824 | return 0; | |
6825 | } |