]>
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" |
d49b6836 | 30 | #include "qemu/error-report.h" |
88d88798 | 31 | #include "module_block.h" |
1de7afc9 | 32 | #include "qemu/module.h" |
e688df6b | 33 | #include "qapi/error.h" |
cc7a8ea7 | 34 | #include "qapi/qmp/qerror.h" |
91a097e7 | 35 | #include "qapi/qmp/qbool.h" |
7b1b5d19 | 36 | #include "qapi/qmp/qjson.h" |
bfb197e0 | 37 | #include "sysemu/block-backend.h" |
9c17d615 | 38 | #include "sysemu/sysemu.h" |
1de7afc9 | 39 | #include "qemu/notify.h" |
10817bf0 | 40 | #include "qemu/coroutine.h" |
c13163fb | 41 | #include "block/qapi.h" |
1de7afc9 | 42 | #include "qemu/timer.h" |
a5ee7bd4 | 43 | #include "qapi-event.h" |
f348b6d1 VB |
44 | #include "qemu/cutils.h" |
45 | #include "qemu/id.h" | |
fc01f7e7 | 46 | |
71e72a19 | 47 | #ifdef CONFIG_BSD |
7674e7bf | 48 | #include <sys/ioctl.h> |
72cf2d4f | 49 | #include <sys/queue.h> |
c5e97233 | 50 | #ifndef __DragonFly__ |
7674e7bf FB |
51 | #include <sys/disk.h> |
52 | #endif | |
c5e97233 | 53 | #endif |
7674e7bf | 54 | |
49dc768d AL |
55 | #ifdef _WIN32 |
56 | #include <windows.h> | |
57 | #endif | |
58 | ||
1c9805a3 SH |
59 | #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */ |
60 | ||
dc364f4c BC |
61 | static QTAILQ_HEAD(, BlockDriverState) graph_bdrv_states = |
62 | QTAILQ_HEAD_INITIALIZER(graph_bdrv_states); | |
63 | ||
2c1d04e0 HR |
64 | static QTAILQ_HEAD(, BlockDriverState) all_bdrv_states = |
65 | QTAILQ_HEAD_INITIALIZER(all_bdrv_states); | |
66 | ||
8a22f02a SH |
67 | static QLIST_HEAD(, BlockDriver) bdrv_drivers = |
68 | QLIST_HEAD_INITIALIZER(bdrv_drivers); | |
ea2384d3 | 69 | |
5b363937 HR |
70 | static BlockDriverState *bdrv_open_inherit(const char *filename, |
71 | const char *reference, | |
72 | QDict *options, int flags, | |
73 | BlockDriverState *parent, | |
74 | const BdrvChildRole *child_role, | |
75 | Error **errp); | |
f3930ed0 | 76 | |
eb852011 MA |
77 | /* If non-zero, use only whitelisted block drivers */ |
78 | static int use_bdrv_whitelist; | |
79 | ||
9e0b22f4 SH |
80 | #ifdef _WIN32 |
81 | static int is_windows_drive_prefix(const char *filename) | |
82 | { | |
83 | return (((filename[0] >= 'a' && filename[0] <= 'z') || | |
84 | (filename[0] >= 'A' && filename[0] <= 'Z')) && | |
85 | filename[1] == ':'); | |
86 | } | |
87 | ||
88 | int is_windows_drive(const char *filename) | |
89 | { | |
90 | if (is_windows_drive_prefix(filename) && | |
91 | filename[2] == '\0') | |
92 | return 1; | |
93 | if (strstart(filename, "\\\\.\\", NULL) || | |
94 | strstart(filename, "//./", NULL)) | |
95 | return 1; | |
96 | return 0; | |
97 | } | |
98 | #endif | |
99 | ||
339064d5 KW |
100 | size_t bdrv_opt_mem_align(BlockDriverState *bs) |
101 | { | |
102 | if (!bs || !bs->drv) { | |
459b4e66 DL |
103 | /* page size or 4k (hdd sector size) should be on the safe side */ |
104 | return MAX(4096, getpagesize()); | |
339064d5 KW |
105 | } |
106 | ||
107 | return bs->bl.opt_mem_alignment; | |
108 | } | |
109 | ||
4196d2f0 DL |
110 | size_t bdrv_min_mem_align(BlockDriverState *bs) |
111 | { | |
112 | if (!bs || !bs->drv) { | |
459b4e66 DL |
113 | /* page size or 4k (hdd sector size) should be on the safe side */ |
114 | return MAX(4096, getpagesize()); | |
4196d2f0 DL |
115 | } |
116 | ||
117 | return bs->bl.min_mem_alignment; | |
118 | } | |
119 | ||
9e0b22f4 | 120 | /* check if the path starts with "<protocol>:" */ |
5c98415b | 121 | int path_has_protocol(const char *path) |
9e0b22f4 | 122 | { |
947995c0 PB |
123 | const char *p; |
124 | ||
9e0b22f4 SH |
125 | #ifdef _WIN32 |
126 | if (is_windows_drive(path) || | |
127 | is_windows_drive_prefix(path)) { | |
128 | return 0; | |
129 | } | |
947995c0 PB |
130 | p = path + strcspn(path, ":/\\"); |
131 | #else | |
132 | p = path + strcspn(path, ":/"); | |
9e0b22f4 SH |
133 | #endif |
134 | ||
947995c0 | 135 | return *p == ':'; |
9e0b22f4 SH |
136 | } |
137 | ||
83f64091 | 138 | int path_is_absolute(const char *path) |
3b0d4f61 | 139 | { |
21664424 FB |
140 | #ifdef _WIN32 |
141 | /* specific case for names like: "\\.\d:" */ | |
f53f4da9 | 142 | if (is_windows_drive(path) || is_windows_drive_prefix(path)) { |
21664424 | 143 | return 1; |
f53f4da9 PB |
144 | } |
145 | return (*path == '/' || *path == '\\'); | |
3b9f94e1 | 146 | #else |
f53f4da9 | 147 | return (*path == '/'); |
3b9f94e1 | 148 | #endif |
3b0d4f61 FB |
149 | } |
150 | ||
83f64091 FB |
151 | /* if filename is absolute, just copy it to dest. Otherwise, build a |
152 | path to it by considering it is relative to base_path. URL are | |
153 | supported. */ | |
154 | void path_combine(char *dest, int dest_size, | |
155 | const char *base_path, | |
156 | const char *filename) | |
3b0d4f61 | 157 | { |
83f64091 FB |
158 | const char *p, *p1; |
159 | int len; | |
160 | ||
161 | if (dest_size <= 0) | |
162 | return; | |
163 | if (path_is_absolute(filename)) { | |
164 | pstrcpy(dest, dest_size, filename); | |
165 | } else { | |
0d54a6fe HR |
166 | const char *protocol_stripped = NULL; |
167 | ||
168 | if (path_has_protocol(base_path)) { | |
169 | protocol_stripped = strchr(base_path, ':'); | |
170 | if (protocol_stripped) { | |
171 | protocol_stripped++; | |
172 | } | |
173 | } | |
174 | p = protocol_stripped ?: base_path; | |
175 | ||
3b9f94e1 FB |
176 | p1 = strrchr(base_path, '/'); |
177 | #ifdef _WIN32 | |
178 | { | |
179 | const char *p2; | |
180 | p2 = strrchr(base_path, '\\'); | |
181 | if (!p1 || p2 > p1) | |
182 | p1 = p2; | |
183 | } | |
184 | #endif | |
83f64091 FB |
185 | if (p1) |
186 | p1++; | |
187 | else | |
188 | p1 = base_path; | |
189 | if (p1 > p) | |
190 | p = p1; | |
191 | len = p - base_path; | |
192 | if (len > dest_size - 1) | |
193 | len = dest_size - 1; | |
194 | memcpy(dest, base_path, len); | |
195 | dest[len] = '\0'; | |
196 | pstrcat(dest, dest_size, filename); | |
3b0d4f61 | 197 | } |
3b0d4f61 FB |
198 | } |
199 | ||
03c320d8 HR |
200 | /* |
201 | * Helper function for bdrv_parse_filename() implementations to remove optional | |
202 | * protocol prefixes (especially "file:") from a filename and for putting the | |
203 | * stripped filename into the options QDict if there is such a prefix. | |
204 | */ | |
205 | void bdrv_parse_filename_strip_prefix(const char *filename, const char *prefix, | |
206 | QDict *options) | |
207 | { | |
208 | if (strstart(filename, prefix, &filename)) { | |
209 | /* Stripping the explicit protocol prefix may result in a protocol | |
210 | * prefix being (wrongly) detected (if the filename contains a colon) */ | |
211 | if (path_has_protocol(filename)) { | |
212 | QString *fat_filename; | |
213 | ||
214 | /* This means there is some colon before the first slash; therefore, | |
215 | * this cannot be an absolute path */ | |
216 | assert(!path_is_absolute(filename)); | |
217 | ||
218 | /* And we can thus fix the protocol detection issue by prefixing it | |
219 | * by "./" */ | |
220 | fat_filename = qstring_from_str("./"); | |
221 | qstring_append(fat_filename, filename); | |
222 | ||
223 | assert(!path_has_protocol(qstring_get_str(fat_filename))); | |
224 | ||
225 | qdict_put(options, "filename", fat_filename); | |
226 | } else { | |
227 | /* If no protocol prefix was detected, we can use the shortened | |
228 | * filename as-is */ | |
229 | qdict_put_str(options, "filename", filename); | |
230 | } | |
231 | } | |
232 | } | |
233 | ||
234 | ||
9c5e6594 KW |
235 | /* Returns whether the image file is opened as read-only. Note that this can |
236 | * return false and writing to the image file is still not possible because the | |
237 | * image is inactivated. */ | |
93ed524e JC |
238 | bool bdrv_is_read_only(BlockDriverState *bs) |
239 | { | |
240 | return bs->read_only; | |
241 | } | |
242 | ||
54a32bfe KW |
243 | int bdrv_can_set_read_only(BlockDriverState *bs, bool read_only, |
244 | bool ignore_allow_rdw, Error **errp) | |
fe5241bf | 245 | { |
e2b8247a JC |
246 | /* Do not set read_only if copy_on_read is enabled */ |
247 | if (bs->copy_on_read && read_only) { | |
248 | error_setg(errp, "Can't set node '%s' to r/o with copy-on-read enabled", | |
249 | bdrv_get_device_or_node_name(bs)); | |
250 | return -EINVAL; | |
251 | } | |
252 | ||
d6fcdf06 | 253 | /* Do not clear read_only if it is prohibited */ |
54a32bfe KW |
254 | if (!read_only && !(bs->open_flags & BDRV_O_ALLOW_RDWR) && |
255 | !ignore_allow_rdw) | |
256 | { | |
d6fcdf06 JC |
257 | error_setg(errp, "Node '%s' is read only", |
258 | bdrv_get_device_or_node_name(bs)); | |
259 | return -EPERM; | |
260 | } | |
261 | ||
45803a03 JC |
262 | return 0; |
263 | } | |
264 | ||
398e6ad0 KW |
265 | /* TODO Remove (deprecated since 2.11) |
266 | * Block drivers are not supposed to automatically change bs->read_only. | |
267 | * Instead, they should just check whether they can provide what the user | |
268 | * explicitly requested and error out if read-write is requested, but they can | |
269 | * only provide read-only access. */ | |
45803a03 JC |
270 | int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp) |
271 | { | |
272 | int ret = 0; | |
273 | ||
54a32bfe | 274 | ret = bdrv_can_set_read_only(bs, read_only, false, errp); |
45803a03 JC |
275 | if (ret < 0) { |
276 | return ret; | |
277 | } | |
278 | ||
fe5241bf | 279 | bs->read_only = read_only; |
e2b8247a | 280 | return 0; |
fe5241bf JC |
281 | } |
282 | ||
0a82855a HR |
283 | void bdrv_get_full_backing_filename_from_filename(const char *backed, |
284 | const char *backing, | |
9f07429e HR |
285 | char *dest, size_t sz, |
286 | Error **errp) | |
dc5a1371 | 287 | { |
9f07429e HR |
288 | if (backing[0] == '\0' || path_has_protocol(backing) || |
289 | path_is_absolute(backing)) | |
290 | { | |
0a82855a | 291 | pstrcpy(dest, sz, backing); |
9f07429e HR |
292 | } else if (backed[0] == '\0' || strstart(backed, "json:", NULL)) { |
293 | error_setg(errp, "Cannot use relative backing file names for '%s'", | |
294 | backed); | |
dc5a1371 | 295 | } else { |
0a82855a | 296 | path_combine(dest, sz, backed, backing); |
dc5a1371 PB |
297 | } |
298 | } | |
299 | ||
9f07429e HR |
300 | void bdrv_get_full_backing_filename(BlockDriverState *bs, char *dest, size_t sz, |
301 | Error **errp) | |
0a82855a | 302 | { |
9f07429e HR |
303 | char *backed = bs->exact_filename[0] ? bs->exact_filename : bs->filename; |
304 | ||
305 | bdrv_get_full_backing_filename_from_filename(backed, bs->backing_file, | |
306 | dest, sz, errp); | |
0a82855a HR |
307 | } |
308 | ||
0eb7217e SH |
309 | void bdrv_register(BlockDriver *bdrv) |
310 | { | |
8a22f02a | 311 | QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list); |
ea2384d3 | 312 | } |
b338082b | 313 | |
e4e9986b MA |
314 | BlockDriverState *bdrv_new(void) |
315 | { | |
316 | BlockDriverState *bs; | |
317 | int i; | |
318 | ||
5839e53b | 319 | bs = g_new0(BlockDriverState, 1); |
e4654d2d | 320 | QLIST_INIT(&bs->dirty_bitmaps); |
fbe40ff7 FZ |
321 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { |
322 | QLIST_INIT(&bs->op_blockers[i]); | |
323 | } | |
d616b224 | 324 | notifier_with_return_list_init(&bs->before_write_notifiers); |
3783fa3d | 325 | qemu_co_mutex_init(&bs->reqs_lock); |
2119882c | 326 | qemu_mutex_init(&bs->dirty_bitmap_mutex); |
9fcb0251 | 327 | bs->refcnt = 1; |
dcd04228 | 328 | bs->aio_context = qemu_get_aio_context(); |
d7d512f6 | 329 | |
3ff2f67a EY |
330 | qemu_co_queue_init(&bs->flush_queue); |
331 | ||
2c1d04e0 HR |
332 | QTAILQ_INSERT_TAIL(&all_bdrv_states, bs, bs_list); |
333 | ||
b338082b FB |
334 | return bs; |
335 | } | |
336 | ||
88d88798 | 337 | static BlockDriver *bdrv_do_find_format(const char *format_name) |
ea2384d3 FB |
338 | { |
339 | BlockDriver *drv1; | |
88d88798 | 340 | |
8a22f02a SH |
341 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { |
342 | if (!strcmp(drv1->format_name, format_name)) { | |
ea2384d3 | 343 | return drv1; |
8a22f02a | 344 | } |
ea2384d3 | 345 | } |
88d88798 | 346 | |
ea2384d3 FB |
347 | return NULL; |
348 | } | |
349 | ||
88d88798 MM |
350 | BlockDriver *bdrv_find_format(const char *format_name) |
351 | { | |
352 | BlockDriver *drv1; | |
353 | int i; | |
354 | ||
355 | drv1 = bdrv_do_find_format(format_name); | |
356 | if (drv1) { | |
357 | return drv1; | |
358 | } | |
359 | ||
360 | /* The driver isn't registered, maybe we need to load a module */ | |
361 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); ++i) { | |
362 | if (!strcmp(block_driver_modules[i].format_name, format_name)) { | |
363 | block_module_load_one(block_driver_modules[i].library_name); | |
364 | break; | |
365 | } | |
366 | } | |
367 | ||
368 | return bdrv_do_find_format(format_name); | |
369 | } | |
370 | ||
b64ec4e4 | 371 | static int bdrv_is_whitelisted(BlockDriver *drv, bool read_only) |
eb852011 | 372 | { |
b64ec4e4 FZ |
373 | static const char *whitelist_rw[] = { |
374 | CONFIG_BDRV_RW_WHITELIST | |
375 | }; | |
376 | static const char *whitelist_ro[] = { | |
377 | CONFIG_BDRV_RO_WHITELIST | |
eb852011 MA |
378 | }; |
379 | const char **p; | |
380 | ||
b64ec4e4 | 381 | if (!whitelist_rw[0] && !whitelist_ro[0]) { |
eb852011 | 382 | return 1; /* no whitelist, anything goes */ |
b64ec4e4 | 383 | } |
eb852011 | 384 | |
b64ec4e4 | 385 | for (p = whitelist_rw; *p; p++) { |
eb852011 MA |
386 | if (!strcmp(drv->format_name, *p)) { |
387 | return 1; | |
388 | } | |
389 | } | |
b64ec4e4 FZ |
390 | if (read_only) { |
391 | for (p = whitelist_ro; *p; p++) { | |
392 | if (!strcmp(drv->format_name, *p)) { | |
393 | return 1; | |
394 | } | |
395 | } | |
396 | } | |
eb852011 MA |
397 | return 0; |
398 | } | |
399 | ||
e6ff69bf DB |
400 | bool bdrv_uses_whitelist(void) |
401 | { | |
402 | return use_bdrv_whitelist; | |
403 | } | |
404 | ||
5b7e1542 ZYW |
405 | typedef struct CreateCo { |
406 | BlockDriver *drv; | |
407 | char *filename; | |
83d0521a | 408 | QemuOpts *opts; |
5b7e1542 | 409 | int ret; |
cc84d90f | 410 | Error *err; |
5b7e1542 ZYW |
411 | } CreateCo; |
412 | ||
413 | static void coroutine_fn bdrv_create_co_entry(void *opaque) | |
414 | { | |
cc84d90f HR |
415 | Error *local_err = NULL; |
416 | int ret; | |
417 | ||
5b7e1542 ZYW |
418 | CreateCo *cco = opaque; |
419 | assert(cco->drv); | |
420 | ||
c282e1fd | 421 | ret = cco->drv->bdrv_create(cco->filename, cco->opts, &local_err); |
621ff94d | 422 | error_propagate(&cco->err, local_err); |
cc84d90f | 423 | cco->ret = ret; |
5b7e1542 ZYW |
424 | } |
425 | ||
0e7e1989 | 426 | int bdrv_create(BlockDriver *drv, const char* filename, |
83d0521a | 427 | QemuOpts *opts, Error **errp) |
ea2384d3 | 428 | { |
5b7e1542 ZYW |
429 | int ret; |
430 | ||
431 | Coroutine *co; | |
432 | CreateCo cco = { | |
433 | .drv = drv, | |
434 | .filename = g_strdup(filename), | |
83d0521a | 435 | .opts = opts, |
5b7e1542 | 436 | .ret = NOT_DONE, |
cc84d90f | 437 | .err = NULL, |
5b7e1542 ZYW |
438 | }; |
439 | ||
c282e1fd | 440 | if (!drv->bdrv_create) { |
cc84d90f | 441 | error_setg(errp, "Driver '%s' does not support image creation", drv->format_name); |
80168bff LC |
442 | ret = -ENOTSUP; |
443 | goto out; | |
5b7e1542 ZYW |
444 | } |
445 | ||
446 | if (qemu_in_coroutine()) { | |
447 | /* Fast-path if already in coroutine context */ | |
448 | bdrv_create_co_entry(&cco); | |
449 | } else { | |
0b8b8753 PB |
450 | co = qemu_coroutine_create(bdrv_create_co_entry, &cco); |
451 | qemu_coroutine_enter(co); | |
5b7e1542 | 452 | while (cco.ret == NOT_DONE) { |
b47ec2c4 | 453 | aio_poll(qemu_get_aio_context(), true); |
5b7e1542 ZYW |
454 | } |
455 | } | |
456 | ||
457 | ret = cco.ret; | |
cc84d90f | 458 | if (ret < 0) { |
84d18f06 | 459 | if (cco.err) { |
cc84d90f HR |
460 | error_propagate(errp, cco.err); |
461 | } else { | |
462 | error_setg_errno(errp, -ret, "Could not create image"); | |
463 | } | |
464 | } | |
0e7e1989 | 465 | |
80168bff LC |
466 | out: |
467 | g_free(cco.filename); | |
5b7e1542 | 468 | return ret; |
ea2384d3 FB |
469 | } |
470 | ||
c282e1fd | 471 | int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp) |
84a12e66 CH |
472 | { |
473 | BlockDriver *drv; | |
cc84d90f HR |
474 | Error *local_err = NULL; |
475 | int ret; | |
84a12e66 | 476 | |
b65a5e12 | 477 | drv = bdrv_find_protocol(filename, true, errp); |
84a12e66 | 478 | if (drv == NULL) { |
16905d71 | 479 | return -ENOENT; |
84a12e66 CH |
480 | } |
481 | ||
c282e1fd | 482 | ret = bdrv_create(drv, filename, opts, &local_err); |
621ff94d | 483 | error_propagate(errp, local_err); |
cc84d90f | 484 | return ret; |
84a12e66 CH |
485 | } |
486 | ||
892b7de8 ET |
487 | /** |
488 | * Try to get @bs's logical and physical block size. | |
489 | * On success, store them in @bsz struct and return 0. | |
490 | * On failure return -errno. | |
491 | * @bs must not be empty. | |
492 | */ | |
493 | int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz) | |
494 | { | |
495 | BlockDriver *drv = bs->drv; | |
496 | ||
497 | if (drv && drv->bdrv_probe_blocksizes) { | |
498 | return drv->bdrv_probe_blocksizes(bs, bsz); | |
5a612c00 MP |
499 | } else if (drv && drv->is_filter && bs->file) { |
500 | return bdrv_probe_blocksizes(bs->file->bs, bsz); | |
892b7de8 ET |
501 | } |
502 | ||
503 | return -ENOTSUP; | |
504 | } | |
505 | ||
506 | /** | |
507 | * Try to get @bs's geometry (cyls, heads, sectors). | |
508 | * On success, store them in @geo struct and return 0. | |
509 | * On failure return -errno. | |
510 | * @bs must not be empty. | |
511 | */ | |
512 | int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo) | |
513 | { | |
514 | BlockDriver *drv = bs->drv; | |
515 | ||
516 | if (drv && drv->bdrv_probe_geometry) { | |
517 | return drv->bdrv_probe_geometry(bs, geo); | |
5a612c00 MP |
518 | } else if (drv && drv->is_filter && bs->file) { |
519 | return bdrv_probe_geometry(bs->file->bs, geo); | |
892b7de8 ET |
520 | } |
521 | ||
522 | return -ENOTSUP; | |
523 | } | |
524 | ||
eba25057 JM |
525 | /* |
526 | * Create a uniquely-named empty temporary file. | |
527 | * Return 0 upon success, otherwise a negative errno value. | |
528 | */ | |
529 | int get_tmp_filename(char *filename, int size) | |
d5249393 | 530 | { |
eba25057 | 531 | #ifdef _WIN32 |
3b9f94e1 | 532 | char temp_dir[MAX_PATH]; |
eba25057 JM |
533 | /* GetTempFileName requires that its output buffer (4th param) |
534 | have length MAX_PATH or greater. */ | |
535 | assert(size >= MAX_PATH); | |
536 | return (GetTempPath(MAX_PATH, temp_dir) | |
537 | && GetTempFileName(temp_dir, "qem", 0, filename) | |
538 | ? 0 : -GetLastError()); | |
d5249393 | 539 | #else |
67b915a5 | 540 | int fd; |
7ccfb2eb | 541 | const char *tmpdir; |
0badc1ee | 542 | tmpdir = getenv("TMPDIR"); |
69bef793 AS |
543 | if (!tmpdir) { |
544 | tmpdir = "/var/tmp"; | |
545 | } | |
eba25057 JM |
546 | if (snprintf(filename, size, "%s/vl.XXXXXX", tmpdir) >= size) { |
547 | return -EOVERFLOW; | |
548 | } | |
ea2384d3 | 549 | fd = mkstemp(filename); |
fe235a06 DH |
550 | if (fd < 0) { |
551 | return -errno; | |
552 | } | |
553 | if (close(fd) != 0) { | |
554 | unlink(filename); | |
eba25057 JM |
555 | return -errno; |
556 | } | |
557 | return 0; | |
d5249393 | 558 | #endif |
eba25057 | 559 | } |
fc01f7e7 | 560 | |
84a12e66 CH |
561 | /* |
562 | * Detect host devices. By convention, /dev/cdrom[N] is always | |
563 | * recognized as a host CDROM. | |
564 | */ | |
565 | static BlockDriver *find_hdev_driver(const char *filename) | |
566 | { | |
567 | int score_max = 0, score; | |
568 | BlockDriver *drv = NULL, *d; | |
569 | ||
570 | QLIST_FOREACH(d, &bdrv_drivers, list) { | |
571 | if (d->bdrv_probe_device) { | |
572 | score = d->bdrv_probe_device(filename); | |
573 | if (score > score_max) { | |
574 | score_max = score; | |
575 | drv = d; | |
576 | } | |
577 | } | |
578 | } | |
579 | ||
580 | return drv; | |
581 | } | |
582 | ||
88d88798 MM |
583 | static BlockDriver *bdrv_do_find_protocol(const char *protocol) |
584 | { | |
585 | BlockDriver *drv1; | |
586 | ||
587 | QLIST_FOREACH(drv1, &bdrv_drivers, list) { | |
588 | if (drv1->protocol_name && !strcmp(drv1->protocol_name, protocol)) { | |
589 | return drv1; | |
590 | } | |
591 | } | |
592 | ||
593 | return NULL; | |
594 | } | |
595 | ||
98289620 | 596 | BlockDriver *bdrv_find_protocol(const char *filename, |
b65a5e12 HR |
597 | bool allow_protocol_prefix, |
598 | Error **errp) | |
83f64091 FB |
599 | { |
600 | BlockDriver *drv1; | |
601 | char protocol[128]; | |
1cec71e3 | 602 | int len; |
83f64091 | 603 | const char *p; |
88d88798 | 604 | int i; |
19cb3738 | 605 | |
66f82cee KW |
606 | /* TODO Drivers without bdrv_file_open must be specified explicitly */ |
607 | ||
39508e7a CH |
608 | /* |
609 | * XXX(hch): we really should not let host device detection | |
610 | * override an explicit protocol specification, but moving this | |
611 | * later breaks access to device names with colons in them. | |
612 | * Thanks to the brain-dead persistent naming schemes on udev- | |
613 | * based Linux systems those actually are quite common. | |
614 | */ | |
615 | drv1 = find_hdev_driver(filename); | |
616 | if (drv1) { | |
617 | return drv1; | |
618 | } | |
619 | ||
98289620 | 620 | if (!path_has_protocol(filename) || !allow_protocol_prefix) { |
ef810437 | 621 | return &bdrv_file; |
84a12e66 | 622 | } |
98289620 | 623 | |
9e0b22f4 SH |
624 | p = strchr(filename, ':'); |
625 | assert(p != NULL); | |
1cec71e3 AL |
626 | len = p - filename; |
627 | if (len > sizeof(protocol) - 1) | |
628 | len = sizeof(protocol) - 1; | |
629 | memcpy(protocol, filename, len); | |
630 | protocol[len] = '\0'; | |
88d88798 MM |
631 | |
632 | drv1 = bdrv_do_find_protocol(protocol); | |
633 | if (drv1) { | |
634 | return drv1; | |
635 | } | |
636 | ||
637 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); ++i) { | |
638 | if (block_driver_modules[i].protocol_name && | |
639 | !strcmp(block_driver_modules[i].protocol_name, protocol)) { | |
640 | block_module_load_one(block_driver_modules[i].library_name); | |
641 | break; | |
8a22f02a | 642 | } |
83f64091 | 643 | } |
b65a5e12 | 644 | |
88d88798 MM |
645 | drv1 = bdrv_do_find_protocol(protocol); |
646 | if (!drv1) { | |
647 | error_setg(errp, "Unknown protocol '%s'", protocol); | |
648 | } | |
649 | return drv1; | |
83f64091 FB |
650 | } |
651 | ||
c6684249 MA |
652 | /* |
653 | * Guess image format by probing its contents. | |
654 | * This is not a good idea when your image is raw (CVE-2008-2004), but | |
655 | * we do it anyway for backward compatibility. | |
656 | * | |
657 | * @buf contains the image's first @buf_size bytes. | |
7cddd372 KW |
658 | * @buf_size is the buffer size in bytes (generally BLOCK_PROBE_BUF_SIZE, |
659 | * but can be smaller if the image file is smaller) | |
c6684249 MA |
660 | * @filename is its filename. |
661 | * | |
662 | * For all block drivers, call the bdrv_probe() method to get its | |
663 | * probing score. | |
664 | * Return the first block driver with the highest probing score. | |
665 | */ | |
38f3ef57 KW |
666 | BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size, |
667 | const char *filename) | |
c6684249 MA |
668 | { |
669 | int score_max = 0, score; | |
670 | BlockDriver *drv = NULL, *d; | |
671 | ||
672 | QLIST_FOREACH(d, &bdrv_drivers, list) { | |
673 | if (d->bdrv_probe) { | |
674 | score = d->bdrv_probe(buf, buf_size, filename); | |
675 | if (score > score_max) { | |
676 | score_max = score; | |
677 | drv = d; | |
678 | } | |
679 | } | |
680 | } | |
681 | ||
682 | return drv; | |
683 | } | |
684 | ||
5696c6e3 | 685 | static int find_image_format(BlockBackend *file, const char *filename, |
34b5d2c6 | 686 | BlockDriver **pdrv, Error **errp) |
f3a5d3f8 | 687 | { |
c6684249 | 688 | BlockDriver *drv; |
7cddd372 | 689 | uint8_t buf[BLOCK_PROBE_BUF_SIZE]; |
f500a6d3 | 690 | int ret = 0; |
f8ea0b00 | 691 | |
08a00559 | 692 | /* Return the raw BlockDriver * to scsi-generic devices or empty drives */ |
5696c6e3 | 693 | if (blk_is_sg(file) || !blk_is_inserted(file) || blk_getlength(file) == 0) { |
ef810437 | 694 | *pdrv = &bdrv_raw; |
c98ac35d | 695 | return ret; |
1a396859 | 696 | } |
f8ea0b00 | 697 | |
5696c6e3 | 698 | ret = blk_pread(file, 0, buf, sizeof(buf)); |
83f64091 | 699 | if (ret < 0) { |
34b5d2c6 HR |
700 | error_setg_errno(errp, -ret, "Could not read image for determining its " |
701 | "format"); | |
c98ac35d SW |
702 | *pdrv = NULL; |
703 | return ret; | |
83f64091 FB |
704 | } |
705 | ||
c6684249 | 706 | drv = bdrv_probe_all(buf, ret, filename); |
c98ac35d | 707 | if (!drv) { |
34b5d2c6 HR |
708 | error_setg(errp, "Could not determine image format: No compatible " |
709 | "driver found"); | |
c98ac35d SW |
710 | ret = -ENOENT; |
711 | } | |
712 | *pdrv = drv; | |
713 | return ret; | |
ea2384d3 FB |
714 | } |
715 | ||
51762288 SH |
716 | /** |
717 | * Set the current 'total_sectors' value | |
65a9bb25 | 718 | * Return 0 on success, -errno on error. |
51762288 SH |
719 | */ |
720 | static int refresh_total_sectors(BlockDriverState *bs, int64_t hint) | |
721 | { | |
722 | BlockDriver *drv = bs->drv; | |
723 | ||
d470ad42 HR |
724 | if (!drv) { |
725 | return -ENOMEDIUM; | |
726 | } | |
727 | ||
396759ad | 728 | /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */ |
b192af8a | 729 | if (bdrv_is_sg(bs)) |
396759ad NB |
730 | return 0; |
731 | ||
51762288 SH |
732 | /* query actual device if possible, otherwise just trust the hint */ |
733 | if (drv->bdrv_getlength) { | |
734 | int64_t length = drv->bdrv_getlength(bs); | |
735 | if (length < 0) { | |
736 | return length; | |
737 | } | |
7e382003 | 738 | hint = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE); |
51762288 SH |
739 | } |
740 | ||
741 | bs->total_sectors = hint; | |
742 | return 0; | |
743 | } | |
744 | ||
cddff5ba KW |
745 | /** |
746 | * Combines a QDict of new block driver @options with any missing options taken | |
747 | * from @old_options, so that leaving out an option defaults to its old value. | |
748 | */ | |
749 | static void bdrv_join_options(BlockDriverState *bs, QDict *options, | |
750 | QDict *old_options) | |
751 | { | |
752 | if (bs->drv && bs->drv->bdrv_join_options) { | |
753 | bs->drv->bdrv_join_options(options, old_options); | |
754 | } else { | |
755 | qdict_join(options, old_options, false); | |
756 | } | |
757 | } | |
758 | ||
9e8f1835 PB |
759 | /** |
760 | * Set open flags for a given discard mode | |
761 | * | |
762 | * Return 0 on success, -1 if the discard mode was invalid. | |
763 | */ | |
764 | int bdrv_parse_discard_flags(const char *mode, int *flags) | |
765 | { | |
766 | *flags &= ~BDRV_O_UNMAP; | |
767 | ||
768 | if (!strcmp(mode, "off") || !strcmp(mode, "ignore")) { | |
769 | /* do nothing */ | |
770 | } else if (!strcmp(mode, "on") || !strcmp(mode, "unmap")) { | |
771 | *flags |= BDRV_O_UNMAP; | |
772 | } else { | |
773 | return -1; | |
774 | } | |
775 | ||
776 | return 0; | |
777 | } | |
778 | ||
c3993cdc SH |
779 | /** |
780 | * Set open flags for a given cache mode | |
781 | * | |
782 | * Return 0 on success, -1 if the cache mode was invalid. | |
783 | */ | |
53e8ae01 | 784 | int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough) |
c3993cdc SH |
785 | { |
786 | *flags &= ~BDRV_O_CACHE_MASK; | |
787 | ||
788 | if (!strcmp(mode, "off") || !strcmp(mode, "none")) { | |
53e8ae01 KW |
789 | *writethrough = false; |
790 | *flags |= BDRV_O_NOCACHE; | |
92196b2f | 791 | } else if (!strcmp(mode, "directsync")) { |
53e8ae01 | 792 | *writethrough = true; |
92196b2f | 793 | *flags |= BDRV_O_NOCACHE; |
c3993cdc | 794 | } else if (!strcmp(mode, "writeback")) { |
53e8ae01 | 795 | *writethrough = false; |
c3993cdc | 796 | } else if (!strcmp(mode, "unsafe")) { |
53e8ae01 | 797 | *writethrough = false; |
c3993cdc SH |
798 | *flags |= BDRV_O_NO_FLUSH; |
799 | } else if (!strcmp(mode, "writethrough")) { | |
53e8ae01 | 800 | *writethrough = true; |
c3993cdc SH |
801 | } else { |
802 | return -1; | |
803 | } | |
804 | ||
805 | return 0; | |
806 | } | |
807 | ||
b5411555 KW |
808 | static char *bdrv_child_get_parent_desc(BdrvChild *c) |
809 | { | |
810 | BlockDriverState *parent = c->opaque; | |
811 | return g_strdup(bdrv_get_device_or_node_name(parent)); | |
812 | } | |
813 | ||
20018e12 KW |
814 | static void bdrv_child_cb_drained_begin(BdrvChild *child) |
815 | { | |
816 | BlockDriverState *bs = child->opaque; | |
817 | bdrv_drained_begin(bs); | |
818 | } | |
819 | ||
820 | static void bdrv_child_cb_drained_end(BdrvChild *child) | |
821 | { | |
822 | BlockDriverState *bs = child->opaque; | |
823 | bdrv_drained_end(bs); | |
824 | } | |
825 | ||
d736f119 KW |
826 | static void bdrv_child_cb_attach(BdrvChild *child) |
827 | { | |
828 | BlockDriverState *bs = child->opaque; | |
829 | bdrv_apply_subtree_drain(child, bs); | |
830 | } | |
831 | ||
832 | static void bdrv_child_cb_detach(BdrvChild *child) | |
833 | { | |
834 | BlockDriverState *bs = child->opaque; | |
835 | bdrv_unapply_subtree_drain(child, bs); | |
836 | } | |
837 | ||
38701b6a KW |
838 | static int bdrv_child_cb_inactivate(BdrvChild *child) |
839 | { | |
840 | BlockDriverState *bs = child->opaque; | |
841 | assert(bs->open_flags & BDRV_O_INACTIVE); | |
842 | return 0; | |
843 | } | |
844 | ||
b1e6fc08 | 845 | /* |
73176bee KW |
846 | * Returns the options and flags that a temporary snapshot should get, based on |
847 | * the originally requested flags (the originally requested image will have | |
848 | * flags like a backing file) | |
b1e6fc08 | 849 | */ |
73176bee KW |
850 | static void bdrv_temp_snapshot_options(int *child_flags, QDict *child_options, |
851 | int parent_flags, QDict *parent_options) | |
b1e6fc08 | 852 | { |
73176bee KW |
853 | *child_flags = (parent_flags & ~BDRV_O_SNAPSHOT) | BDRV_O_TEMPORARY; |
854 | ||
855 | /* For temporary files, unconditional cache=unsafe is fine */ | |
73176bee KW |
856 | qdict_set_default_str(child_options, BDRV_OPT_CACHE_DIRECT, "off"); |
857 | qdict_set_default_str(child_options, BDRV_OPT_CACHE_NO_FLUSH, "on"); | |
41869044 | 858 | |
f87a0e29 AG |
859 | /* Copy the read-only option from the parent */ |
860 | qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY); | |
861 | ||
41869044 KW |
862 | /* aio=native doesn't work for cache.direct=off, so disable it for the |
863 | * temporary snapshot */ | |
864 | *child_flags &= ~BDRV_O_NATIVE_AIO; | |
b1e6fc08 KW |
865 | } |
866 | ||
0b50cc88 | 867 | /* |
8e2160e2 KW |
868 | * Returns the options and flags that bs->file should get if a protocol driver |
869 | * is expected, based on the given options and flags for the parent BDS | |
0b50cc88 | 870 | */ |
8e2160e2 KW |
871 | static void bdrv_inherited_options(int *child_flags, QDict *child_options, |
872 | int parent_flags, QDict *parent_options) | |
0b50cc88 | 873 | { |
8e2160e2 KW |
874 | int flags = parent_flags; |
875 | ||
0b50cc88 KW |
876 | /* Enable protocol handling, disable format probing for bs->file */ |
877 | flags |= BDRV_O_PROTOCOL; | |
878 | ||
91a097e7 KW |
879 | /* If the cache mode isn't explicitly set, inherit direct and no-flush from |
880 | * the parent. */ | |
881 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT); | |
882 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH); | |
5a9347c6 | 883 | qdict_copy_default(child_options, parent_options, BDRV_OPT_FORCE_SHARE); |
91a097e7 | 884 | |
f87a0e29 AG |
885 | /* Inherit the read-only option from the parent if it's not set */ |
886 | qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY); | |
887 | ||
0b50cc88 | 888 | /* Our block drivers take care to send flushes and respect unmap policy, |
91a097e7 KW |
889 | * so we can default to enable both on lower layers regardless of the |
890 | * corresponding parent options. */ | |
818584a4 | 891 | qdict_set_default_str(child_options, BDRV_OPT_DISCARD, "unmap"); |
0b50cc88 | 892 | |
0b50cc88 | 893 | /* Clear flags that only apply to the top layer */ |
abb06c5a DB |
894 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ | |
895 | BDRV_O_NO_IO); | |
0b50cc88 | 896 | |
8e2160e2 | 897 | *child_flags = flags; |
0b50cc88 KW |
898 | } |
899 | ||
f3930ed0 | 900 | const BdrvChildRole child_file = { |
b5411555 | 901 | .get_parent_desc = bdrv_child_get_parent_desc, |
8e2160e2 | 902 | .inherit_options = bdrv_inherited_options, |
20018e12 KW |
903 | .drained_begin = bdrv_child_cb_drained_begin, |
904 | .drained_end = bdrv_child_cb_drained_end, | |
d736f119 KW |
905 | .attach = bdrv_child_cb_attach, |
906 | .detach = bdrv_child_cb_detach, | |
38701b6a | 907 | .inactivate = bdrv_child_cb_inactivate, |
f3930ed0 KW |
908 | }; |
909 | ||
910 | /* | |
8e2160e2 KW |
911 | * Returns the options and flags that bs->file should get if the use of formats |
912 | * (and not only protocols) is permitted for it, based on the given options and | |
913 | * flags for the parent BDS | |
f3930ed0 | 914 | */ |
8e2160e2 KW |
915 | static void bdrv_inherited_fmt_options(int *child_flags, QDict *child_options, |
916 | int parent_flags, QDict *parent_options) | |
f3930ed0 | 917 | { |
8e2160e2 KW |
918 | child_file.inherit_options(child_flags, child_options, |
919 | parent_flags, parent_options); | |
920 | ||
abb06c5a | 921 | *child_flags &= ~(BDRV_O_PROTOCOL | BDRV_O_NO_IO); |
f3930ed0 KW |
922 | } |
923 | ||
924 | const BdrvChildRole child_format = { | |
b5411555 | 925 | .get_parent_desc = bdrv_child_get_parent_desc, |
8e2160e2 | 926 | .inherit_options = bdrv_inherited_fmt_options, |
20018e12 KW |
927 | .drained_begin = bdrv_child_cb_drained_begin, |
928 | .drained_end = bdrv_child_cb_drained_end, | |
d736f119 KW |
929 | .attach = bdrv_child_cb_attach, |
930 | .detach = bdrv_child_cb_detach, | |
38701b6a | 931 | .inactivate = bdrv_child_cb_inactivate, |
f3930ed0 KW |
932 | }; |
933 | ||
db95dbba KW |
934 | static void bdrv_backing_attach(BdrvChild *c) |
935 | { | |
936 | BlockDriverState *parent = c->opaque; | |
937 | BlockDriverState *backing_hd = c->bs; | |
938 | ||
939 | assert(!parent->backing_blocker); | |
940 | error_setg(&parent->backing_blocker, | |
941 | "node is used as backing hd of '%s'", | |
942 | bdrv_get_device_or_node_name(parent)); | |
943 | ||
944 | parent->open_flags &= ~BDRV_O_NO_BACKING; | |
945 | pstrcpy(parent->backing_file, sizeof(parent->backing_file), | |
946 | backing_hd->filename); | |
947 | pstrcpy(parent->backing_format, sizeof(parent->backing_format), | |
948 | backing_hd->drv ? backing_hd->drv->format_name : ""); | |
949 | ||
950 | bdrv_op_block_all(backing_hd, parent->backing_blocker); | |
951 | /* Otherwise we won't be able to commit or stream */ | |
952 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_COMMIT_TARGET, | |
953 | parent->backing_blocker); | |
954 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_STREAM, | |
955 | parent->backing_blocker); | |
956 | /* | |
957 | * We do backup in 3 ways: | |
958 | * 1. drive backup | |
959 | * The target bs is new opened, and the source is top BDS | |
960 | * 2. blockdev backup | |
961 | * Both the source and the target are top BDSes. | |
962 | * 3. internal backup(used for block replication) | |
963 | * Both the source and the target are backing file | |
964 | * | |
965 | * In case 1 and 2, neither the source nor the target is the backing file. | |
966 | * In case 3, we will block the top BDS, so there is only one block job | |
967 | * for the top BDS and its backing chain. | |
968 | */ | |
969 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_SOURCE, | |
970 | parent->backing_blocker); | |
971 | bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_TARGET, | |
972 | parent->backing_blocker); | |
d736f119 KW |
973 | |
974 | bdrv_child_cb_attach(c); | |
db95dbba KW |
975 | } |
976 | ||
977 | static void bdrv_backing_detach(BdrvChild *c) | |
978 | { | |
979 | BlockDriverState *parent = c->opaque; | |
980 | ||
981 | assert(parent->backing_blocker); | |
982 | bdrv_op_unblock_all(c->bs, parent->backing_blocker); | |
983 | error_free(parent->backing_blocker); | |
984 | parent->backing_blocker = NULL; | |
d736f119 KW |
985 | |
986 | bdrv_child_cb_detach(c); | |
db95dbba KW |
987 | } |
988 | ||
317fc44e | 989 | /* |
8e2160e2 KW |
990 | * Returns the options and flags that bs->backing should get, based on the |
991 | * given options and flags for the parent BDS | |
317fc44e | 992 | */ |
8e2160e2 KW |
993 | static void bdrv_backing_options(int *child_flags, QDict *child_options, |
994 | int parent_flags, QDict *parent_options) | |
317fc44e | 995 | { |
8e2160e2 KW |
996 | int flags = parent_flags; |
997 | ||
b8816a43 KW |
998 | /* The cache mode is inherited unmodified for backing files; except WCE, |
999 | * which is only applied on the top level (BlockBackend) */ | |
91a097e7 KW |
1000 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT); |
1001 | qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH); | |
5a9347c6 | 1002 | qdict_copy_default(child_options, parent_options, BDRV_OPT_FORCE_SHARE); |
91a097e7 | 1003 | |
317fc44e | 1004 | /* backing files always opened read-only */ |
f87a0e29 AG |
1005 | qdict_set_default_str(child_options, BDRV_OPT_READ_ONLY, "on"); |
1006 | flags &= ~BDRV_O_COPY_ON_READ; | |
317fc44e KW |
1007 | |
1008 | /* snapshot=on is handled on the top layer */ | |
8bfea15d | 1009 | flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_TEMPORARY); |
317fc44e | 1010 | |
8e2160e2 | 1011 | *child_flags = flags; |
317fc44e KW |
1012 | } |
1013 | ||
6858eba0 KW |
1014 | static int bdrv_backing_update_filename(BdrvChild *c, BlockDriverState *base, |
1015 | const char *filename, Error **errp) | |
1016 | { | |
1017 | BlockDriverState *parent = c->opaque; | |
61f09cea | 1018 | int orig_flags = bdrv_get_flags(parent); |
6858eba0 KW |
1019 | int ret; |
1020 | ||
61f09cea KW |
1021 | if (!(orig_flags & BDRV_O_RDWR)) { |
1022 | ret = bdrv_reopen(parent, orig_flags | BDRV_O_RDWR, errp); | |
1023 | if (ret < 0) { | |
1024 | return ret; | |
1025 | } | |
1026 | } | |
1027 | ||
6858eba0 KW |
1028 | ret = bdrv_change_backing_file(parent, filename, |
1029 | base->drv ? base->drv->format_name : ""); | |
1030 | if (ret < 0) { | |
64730694 | 1031 | error_setg_errno(errp, -ret, "Could not update backing file link"); |
6858eba0 KW |
1032 | } |
1033 | ||
61f09cea KW |
1034 | if (!(orig_flags & BDRV_O_RDWR)) { |
1035 | bdrv_reopen(parent, orig_flags, NULL); | |
1036 | } | |
1037 | ||
6858eba0 KW |
1038 | return ret; |
1039 | } | |
1040 | ||
91ef3825 | 1041 | const BdrvChildRole child_backing = { |
b5411555 | 1042 | .get_parent_desc = bdrv_child_get_parent_desc, |
db95dbba KW |
1043 | .attach = bdrv_backing_attach, |
1044 | .detach = bdrv_backing_detach, | |
8e2160e2 | 1045 | .inherit_options = bdrv_backing_options, |
20018e12 KW |
1046 | .drained_begin = bdrv_child_cb_drained_begin, |
1047 | .drained_end = bdrv_child_cb_drained_end, | |
38701b6a | 1048 | .inactivate = bdrv_child_cb_inactivate, |
6858eba0 | 1049 | .update_filename = bdrv_backing_update_filename, |
f3930ed0 KW |
1050 | }; |
1051 | ||
7b272452 KW |
1052 | static int bdrv_open_flags(BlockDriverState *bs, int flags) |
1053 | { | |
61de4c68 | 1054 | int open_flags = flags; |
7b272452 KW |
1055 | |
1056 | /* | |
1057 | * Clear flags that are internal to the block layer before opening the | |
1058 | * image. | |
1059 | */ | |
20cca275 | 1060 | open_flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_PROTOCOL); |
7b272452 KW |
1061 | |
1062 | /* | |
1063 | * Snapshots should be writable. | |
1064 | */ | |
8bfea15d | 1065 | if (flags & BDRV_O_TEMPORARY) { |
7b272452 KW |
1066 | open_flags |= BDRV_O_RDWR; |
1067 | } | |
1068 | ||
1069 | return open_flags; | |
1070 | } | |
1071 | ||
91a097e7 KW |
1072 | static void update_flags_from_options(int *flags, QemuOpts *opts) |
1073 | { | |
1074 | *flags &= ~BDRV_O_CACHE_MASK; | |
1075 | ||
91a097e7 KW |
1076 | assert(qemu_opt_find(opts, BDRV_OPT_CACHE_NO_FLUSH)); |
1077 | if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_NO_FLUSH, false)) { | |
1078 | *flags |= BDRV_O_NO_FLUSH; | |
1079 | } | |
1080 | ||
1081 | assert(qemu_opt_find(opts, BDRV_OPT_CACHE_DIRECT)); | |
1082 | if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_DIRECT, false)) { | |
1083 | *flags |= BDRV_O_NOCACHE; | |
1084 | } | |
f87a0e29 AG |
1085 | |
1086 | *flags &= ~BDRV_O_RDWR; | |
1087 | ||
1088 | assert(qemu_opt_find(opts, BDRV_OPT_READ_ONLY)); | |
1089 | if (!qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false)) { | |
1090 | *flags |= BDRV_O_RDWR; | |
1091 | } | |
1092 | ||
91a097e7 KW |
1093 | } |
1094 | ||
1095 | static void update_options_from_flags(QDict *options, int flags) | |
1096 | { | |
91a097e7 | 1097 | if (!qdict_haskey(options, BDRV_OPT_CACHE_DIRECT)) { |
46f5ac20 | 1098 | qdict_put_bool(options, BDRV_OPT_CACHE_DIRECT, flags & BDRV_O_NOCACHE); |
91a097e7 KW |
1099 | } |
1100 | if (!qdict_haskey(options, BDRV_OPT_CACHE_NO_FLUSH)) { | |
46f5ac20 EB |
1101 | qdict_put_bool(options, BDRV_OPT_CACHE_NO_FLUSH, |
1102 | flags & BDRV_O_NO_FLUSH); | |
91a097e7 | 1103 | } |
f87a0e29 | 1104 | if (!qdict_haskey(options, BDRV_OPT_READ_ONLY)) { |
46f5ac20 | 1105 | qdict_put_bool(options, BDRV_OPT_READ_ONLY, !(flags & BDRV_O_RDWR)); |
f87a0e29 | 1106 | } |
91a097e7 KW |
1107 | } |
1108 | ||
636ea370 KW |
1109 | static void bdrv_assign_node_name(BlockDriverState *bs, |
1110 | const char *node_name, | |
1111 | Error **errp) | |
6913c0c2 | 1112 | { |
15489c76 | 1113 | char *gen_node_name = NULL; |
6913c0c2 | 1114 | |
15489c76 JC |
1115 | if (!node_name) { |
1116 | node_name = gen_node_name = id_generate(ID_BLOCK); | |
1117 | } else if (!id_wellformed(node_name)) { | |
1118 | /* | |
1119 | * Check for empty string or invalid characters, but not if it is | |
1120 | * generated (generated names use characters not available to the user) | |
1121 | */ | |
9aebf3b8 | 1122 | error_setg(errp, "Invalid node name"); |
636ea370 | 1123 | return; |
6913c0c2 BC |
1124 | } |
1125 | ||
0c5e94ee | 1126 | /* takes care of avoiding namespaces collisions */ |
7f06d47e | 1127 | if (blk_by_name(node_name)) { |
0c5e94ee BC |
1128 | error_setg(errp, "node-name=%s is conflicting with a device id", |
1129 | node_name); | |
15489c76 | 1130 | goto out; |
0c5e94ee BC |
1131 | } |
1132 | ||
6913c0c2 BC |
1133 | /* takes care of avoiding duplicates node names */ |
1134 | if (bdrv_find_node(node_name)) { | |
1135 | error_setg(errp, "Duplicate node name"); | |
15489c76 | 1136 | goto out; |
6913c0c2 BC |
1137 | } |
1138 | ||
1139 | /* copy node name into the bs and insert it into the graph list */ | |
1140 | pstrcpy(bs->node_name, sizeof(bs->node_name), node_name); | |
1141 | QTAILQ_INSERT_TAIL(&graph_bdrv_states, bs, node_list); | |
15489c76 JC |
1142 | out: |
1143 | g_free(gen_node_name); | |
6913c0c2 BC |
1144 | } |
1145 | ||
01a56501 KW |
1146 | static int bdrv_open_driver(BlockDriverState *bs, BlockDriver *drv, |
1147 | const char *node_name, QDict *options, | |
1148 | int open_flags, Error **errp) | |
1149 | { | |
1150 | Error *local_err = NULL; | |
1151 | int ret; | |
1152 | ||
1153 | bdrv_assign_node_name(bs, node_name, &local_err); | |
1154 | if (local_err) { | |
1155 | error_propagate(errp, local_err); | |
1156 | return -EINVAL; | |
1157 | } | |
1158 | ||
1159 | bs->drv = drv; | |
680c7f96 | 1160 | bs->read_only = !(bs->open_flags & BDRV_O_RDWR); |
01a56501 KW |
1161 | bs->opaque = g_malloc0(drv->instance_size); |
1162 | ||
1163 | if (drv->bdrv_file_open) { | |
1164 | assert(!drv->bdrv_needs_filename || bs->filename[0]); | |
1165 | ret = drv->bdrv_file_open(bs, options, open_flags, &local_err); | |
680c7f96 | 1166 | } else if (drv->bdrv_open) { |
01a56501 | 1167 | ret = drv->bdrv_open(bs, options, open_flags, &local_err); |
680c7f96 KW |
1168 | } else { |
1169 | ret = 0; | |
01a56501 KW |
1170 | } |
1171 | ||
1172 | if (ret < 0) { | |
1173 | if (local_err) { | |
1174 | error_propagate(errp, local_err); | |
1175 | } else if (bs->filename[0]) { | |
1176 | error_setg_errno(errp, -ret, "Could not open '%s'", bs->filename); | |
1177 | } else { | |
1178 | error_setg_errno(errp, -ret, "Could not open image"); | |
1179 | } | |
180ca19a | 1180 | goto open_failed; |
01a56501 KW |
1181 | } |
1182 | ||
1183 | ret = refresh_total_sectors(bs, bs->total_sectors); | |
1184 | if (ret < 0) { | |
1185 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); | |
180ca19a | 1186 | return ret; |
01a56501 KW |
1187 | } |
1188 | ||
1189 | bdrv_refresh_limits(bs, &local_err); | |
1190 | if (local_err) { | |
1191 | error_propagate(errp, local_err); | |
180ca19a | 1192 | return -EINVAL; |
01a56501 KW |
1193 | } |
1194 | ||
1195 | assert(bdrv_opt_mem_align(bs) != 0); | |
1196 | assert(bdrv_min_mem_align(bs) != 0); | |
1197 | assert(is_power_of_2(bs->bl.request_alignment)); | |
1198 | ||
1199 | return 0; | |
180ca19a MP |
1200 | open_failed: |
1201 | bs->drv = NULL; | |
1202 | if (bs->file != NULL) { | |
1203 | bdrv_unref_child(bs, bs->file); | |
1204 | bs->file = NULL; | |
1205 | } | |
01a56501 KW |
1206 | g_free(bs->opaque); |
1207 | bs->opaque = NULL; | |
01a56501 KW |
1208 | return ret; |
1209 | } | |
1210 | ||
680c7f96 KW |
1211 | BlockDriverState *bdrv_new_open_driver(BlockDriver *drv, const char *node_name, |
1212 | int flags, Error **errp) | |
1213 | { | |
1214 | BlockDriverState *bs; | |
1215 | int ret; | |
1216 | ||
1217 | bs = bdrv_new(); | |
1218 | bs->open_flags = flags; | |
1219 | bs->explicit_options = qdict_new(); | |
1220 | bs->options = qdict_new(); | |
1221 | bs->opaque = NULL; | |
1222 | ||
1223 | update_options_from_flags(bs->options, flags); | |
1224 | ||
1225 | ret = bdrv_open_driver(bs, drv, node_name, bs->options, flags, errp); | |
1226 | if (ret < 0) { | |
1227 | QDECREF(bs->explicit_options); | |
180ca19a | 1228 | bs->explicit_options = NULL; |
680c7f96 | 1229 | QDECREF(bs->options); |
180ca19a | 1230 | bs->options = NULL; |
680c7f96 KW |
1231 | bdrv_unref(bs); |
1232 | return NULL; | |
1233 | } | |
1234 | ||
1235 | return bs; | |
1236 | } | |
1237 | ||
c5f3014b | 1238 | QemuOptsList bdrv_runtime_opts = { |
18edf289 KW |
1239 | .name = "bdrv_common", |
1240 | .head = QTAILQ_HEAD_INITIALIZER(bdrv_runtime_opts.head), | |
1241 | .desc = { | |
1242 | { | |
1243 | .name = "node-name", | |
1244 | .type = QEMU_OPT_STRING, | |
1245 | .help = "Node name of the block device node", | |
1246 | }, | |
62392ebb KW |
1247 | { |
1248 | .name = "driver", | |
1249 | .type = QEMU_OPT_STRING, | |
1250 | .help = "Block driver to use for the node", | |
1251 | }, | |
91a097e7 KW |
1252 | { |
1253 | .name = BDRV_OPT_CACHE_DIRECT, | |
1254 | .type = QEMU_OPT_BOOL, | |
1255 | .help = "Bypass software writeback cache on the host", | |
1256 | }, | |
1257 | { | |
1258 | .name = BDRV_OPT_CACHE_NO_FLUSH, | |
1259 | .type = QEMU_OPT_BOOL, | |
1260 | .help = "Ignore flush requests", | |
1261 | }, | |
f87a0e29 AG |
1262 | { |
1263 | .name = BDRV_OPT_READ_ONLY, | |
1264 | .type = QEMU_OPT_BOOL, | |
1265 | .help = "Node is opened in read-only mode", | |
1266 | }, | |
692e01a2 KW |
1267 | { |
1268 | .name = "detect-zeroes", | |
1269 | .type = QEMU_OPT_STRING, | |
1270 | .help = "try to optimize zero writes (off, on, unmap)", | |
1271 | }, | |
818584a4 KW |
1272 | { |
1273 | .name = "discard", | |
1274 | .type = QEMU_OPT_STRING, | |
1275 | .help = "discard operation (ignore/off, unmap/on)", | |
1276 | }, | |
5a9347c6 FZ |
1277 | { |
1278 | .name = BDRV_OPT_FORCE_SHARE, | |
1279 | .type = QEMU_OPT_BOOL, | |
1280 | .help = "always accept other writers (default: off)", | |
1281 | }, | |
18edf289 KW |
1282 | { /* end of list */ } |
1283 | }, | |
1284 | }; | |
1285 | ||
57915332 KW |
1286 | /* |
1287 | * Common part for opening disk images and files | |
b6ad491a KW |
1288 | * |
1289 | * Removes all processed options from *options. | |
57915332 | 1290 | */ |
5696c6e3 | 1291 | static int bdrv_open_common(BlockDriverState *bs, BlockBackend *file, |
82dc8b41 | 1292 | QDict *options, Error **errp) |
57915332 KW |
1293 | { |
1294 | int ret, open_flags; | |
035fccdf | 1295 | const char *filename; |
62392ebb | 1296 | const char *driver_name = NULL; |
6913c0c2 | 1297 | const char *node_name = NULL; |
818584a4 | 1298 | const char *discard; |
692e01a2 | 1299 | const char *detect_zeroes; |
18edf289 | 1300 | QemuOpts *opts; |
62392ebb | 1301 | BlockDriver *drv; |
34b5d2c6 | 1302 | Error *local_err = NULL; |
57915332 | 1303 | |
6405875c | 1304 | assert(bs->file == NULL); |
707ff828 | 1305 | assert(options != NULL && bs->options != options); |
57915332 | 1306 | |
62392ebb KW |
1307 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); |
1308 | qemu_opts_absorb_qdict(opts, options, &local_err); | |
1309 | if (local_err) { | |
1310 | error_propagate(errp, local_err); | |
1311 | ret = -EINVAL; | |
1312 | goto fail_opts; | |
1313 | } | |
1314 | ||
9b7e8691 AG |
1315 | update_flags_from_options(&bs->open_flags, opts); |
1316 | ||
62392ebb KW |
1317 | driver_name = qemu_opt_get(opts, "driver"); |
1318 | drv = bdrv_find_format(driver_name); | |
1319 | assert(drv != NULL); | |
1320 | ||
5a9347c6 FZ |
1321 | bs->force_share = qemu_opt_get_bool(opts, BDRV_OPT_FORCE_SHARE, false); |
1322 | ||
1323 | if (bs->force_share && (bs->open_flags & BDRV_O_RDWR)) { | |
1324 | error_setg(errp, | |
1325 | BDRV_OPT_FORCE_SHARE | |
1326 | "=on can only be used with read-only images"); | |
1327 | ret = -EINVAL; | |
1328 | goto fail_opts; | |
1329 | } | |
1330 | ||
45673671 | 1331 | if (file != NULL) { |
5696c6e3 | 1332 | filename = blk_bs(file)->filename; |
45673671 | 1333 | } else { |
129c7d1c MA |
1334 | /* |
1335 | * Caution: while qdict_get_try_str() is fine, getting | |
1336 | * non-string types would require more care. When @options | |
1337 | * come from -blockdev or blockdev_add, its members are typed | |
1338 | * according to the QAPI schema, but when they come from | |
1339 | * -drive, they're all QString. | |
1340 | */ | |
45673671 KW |
1341 | filename = qdict_get_try_str(options, "filename"); |
1342 | } | |
1343 | ||
4a008240 | 1344 | if (drv->bdrv_needs_filename && (!filename || !filename[0])) { |
765003db KW |
1345 | error_setg(errp, "The '%s' block driver requires a file name", |
1346 | drv->format_name); | |
18edf289 KW |
1347 | ret = -EINVAL; |
1348 | goto fail_opts; | |
6913c0c2 | 1349 | } |
6913c0c2 | 1350 | |
82dc8b41 KW |
1351 | trace_bdrv_open_common(bs, filename ?: "", bs->open_flags, |
1352 | drv->format_name); | |
62392ebb | 1353 | |
82dc8b41 | 1354 | bs->read_only = !(bs->open_flags & BDRV_O_RDWR); |
b64ec4e4 FZ |
1355 | |
1356 | if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv, bs->read_only)) { | |
8f94a6e4 KW |
1357 | error_setg(errp, |
1358 | !bs->read_only && bdrv_is_whitelisted(drv, true) | |
1359 | ? "Driver '%s' can only be used for read-only devices" | |
1360 | : "Driver '%s' is not whitelisted", | |
1361 | drv->format_name); | |
18edf289 KW |
1362 | ret = -ENOTSUP; |
1363 | goto fail_opts; | |
b64ec4e4 | 1364 | } |
57915332 | 1365 | |
d3faa13e PB |
1366 | /* bdrv_new() and bdrv_close() make it so */ |
1367 | assert(atomic_read(&bs->copy_on_read) == 0); | |
1368 | ||
82dc8b41 | 1369 | if (bs->open_flags & BDRV_O_COPY_ON_READ) { |
0ebd24e0 KW |
1370 | if (!bs->read_only) { |
1371 | bdrv_enable_copy_on_read(bs); | |
1372 | } else { | |
1373 | error_setg(errp, "Can't use copy-on-read on read-only device"); | |
18edf289 KW |
1374 | ret = -EINVAL; |
1375 | goto fail_opts; | |
0ebd24e0 | 1376 | } |
53fec9d3 SH |
1377 | } |
1378 | ||
818584a4 KW |
1379 | discard = qemu_opt_get(opts, "discard"); |
1380 | if (discard != NULL) { | |
1381 | if (bdrv_parse_discard_flags(discard, &bs->open_flags) != 0) { | |
1382 | error_setg(errp, "Invalid discard option"); | |
1383 | ret = -EINVAL; | |
1384 | goto fail_opts; | |
1385 | } | |
1386 | } | |
1387 | ||
692e01a2 KW |
1388 | detect_zeroes = qemu_opt_get(opts, "detect-zeroes"); |
1389 | if (detect_zeroes) { | |
1390 | BlockdevDetectZeroesOptions value = | |
f7abe0ec | 1391 | qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup, |
692e01a2 | 1392 | detect_zeroes, |
692e01a2 KW |
1393 | BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF, |
1394 | &local_err); | |
1395 | if (local_err) { | |
1396 | error_propagate(errp, local_err); | |
1397 | ret = -EINVAL; | |
1398 | goto fail_opts; | |
1399 | } | |
1400 | ||
1401 | if (value == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP && | |
1402 | !(bs->open_flags & BDRV_O_UNMAP)) | |
1403 | { | |
1404 | error_setg(errp, "setting detect-zeroes to unmap is not allowed " | |
1405 | "without setting discard operation to unmap"); | |
1406 | ret = -EINVAL; | |
1407 | goto fail_opts; | |
1408 | } | |
1409 | ||
1410 | bs->detect_zeroes = value; | |
1411 | } | |
1412 | ||
c2ad1b0c KW |
1413 | if (filename != NULL) { |
1414 | pstrcpy(bs->filename, sizeof(bs->filename), filename); | |
1415 | } else { | |
1416 | bs->filename[0] = '\0'; | |
1417 | } | |
91af7014 | 1418 | pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), bs->filename); |
57915332 | 1419 | |
66f82cee | 1420 | /* Open the image, either directly or using a protocol */ |
82dc8b41 | 1421 | open_flags = bdrv_open_flags(bs, bs->open_flags); |
01a56501 | 1422 | node_name = qemu_opt_get(opts, "node-name"); |
57915332 | 1423 | |
01a56501 KW |
1424 | assert(!drv->bdrv_file_open || file == NULL); |
1425 | ret = bdrv_open_driver(bs, drv, node_name, options, open_flags, errp); | |
51762288 | 1426 | if (ret < 0) { |
01a56501 | 1427 | goto fail_opts; |
3baca891 KW |
1428 | } |
1429 | ||
18edf289 | 1430 | qemu_opts_del(opts); |
57915332 KW |
1431 | return 0; |
1432 | ||
18edf289 KW |
1433 | fail_opts: |
1434 | qemu_opts_del(opts); | |
57915332 KW |
1435 | return ret; |
1436 | } | |
1437 | ||
5e5c4f63 KW |
1438 | static QDict *parse_json_filename(const char *filename, Error **errp) |
1439 | { | |
1440 | QObject *options_obj; | |
1441 | QDict *options; | |
1442 | int ret; | |
1443 | ||
1444 | ret = strstart(filename, "json:", &filename); | |
1445 | assert(ret); | |
1446 | ||
5577fff7 | 1447 | options_obj = qobject_from_json(filename, errp); |
5e5c4f63 | 1448 | if (!options_obj) { |
5577fff7 MA |
1449 | /* Work around qobject_from_json() lossage TODO fix that */ |
1450 | if (errp && !*errp) { | |
1451 | error_setg(errp, "Could not parse the JSON options"); | |
1452 | return NULL; | |
1453 | } | |
1454 | error_prepend(errp, "Could not parse the JSON options: "); | |
5e5c4f63 KW |
1455 | return NULL; |
1456 | } | |
1457 | ||
ca6b6e1e MA |
1458 | options = qobject_to_qdict(options_obj); |
1459 | if (!options) { | |
5e5c4f63 KW |
1460 | qobject_decref(options_obj); |
1461 | error_setg(errp, "Invalid JSON object given"); | |
1462 | return NULL; | |
1463 | } | |
1464 | ||
5e5c4f63 KW |
1465 | qdict_flatten(options); |
1466 | ||
1467 | return options; | |
1468 | } | |
1469 | ||
de3b53f0 KW |
1470 | static void parse_json_protocol(QDict *options, const char **pfilename, |
1471 | Error **errp) | |
1472 | { | |
1473 | QDict *json_options; | |
1474 | Error *local_err = NULL; | |
1475 | ||
1476 | /* Parse json: pseudo-protocol */ | |
1477 | if (!*pfilename || !g_str_has_prefix(*pfilename, "json:")) { | |
1478 | return; | |
1479 | } | |
1480 | ||
1481 | json_options = parse_json_filename(*pfilename, &local_err); | |
1482 | if (local_err) { | |
1483 | error_propagate(errp, local_err); | |
1484 | return; | |
1485 | } | |
1486 | ||
1487 | /* Options given in the filename have lower priority than options | |
1488 | * specified directly */ | |
1489 | qdict_join(options, json_options, false); | |
1490 | QDECREF(json_options); | |
1491 | *pfilename = NULL; | |
1492 | } | |
1493 | ||
b6ce07aa | 1494 | /* |
f54120ff KW |
1495 | * Fills in default options for opening images and converts the legacy |
1496 | * filename/flags pair to option QDict entries. | |
53a29513 HR |
1497 | * The BDRV_O_PROTOCOL flag in *flags will be set or cleared accordingly if a |
1498 | * block driver has been specified explicitly. | |
b6ce07aa | 1499 | */ |
de3b53f0 | 1500 | static int bdrv_fill_options(QDict **options, const char *filename, |
053e1578 | 1501 | int *flags, Error **errp) |
ea2384d3 | 1502 | { |
c2ad1b0c | 1503 | const char *drvname; |
53a29513 | 1504 | bool protocol = *flags & BDRV_O_PROTOCOL; |
e3fa4bfa | 1505 | bool parse_filename = false; |
053e1578 | 1506 | BlockDriver *drv = NULL; |
34b5d2c6 | 1507 | Error *local_err = NULL; |
83f64091 | 1508 | |
129c7d1c MA |
1509 | /* |
1510 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
1511 | * types would require more care. When @options come from | |
1512 | * -blockdev or blockdev_add, its members are typed according to | |
1513 | * the QAPI schema, but when they come from -drive, they're all | |
1514 | * QString. | |
1515 | */ | |
53a29513 | 1516 | drvname = qdict_get_try_str(*options, "driver"); |
053e1578 HR |
1517 | if (drvname) { |
1518 | drv = bdrv_find_format(drvname); | |
1519 | if (!drv) { | |
1520 | error_setg(errp, "Unknown driver '%s'", drvname); | |
1521 | return -ENOENT; | |
1522 | } | |
1523 | /* If the user has explicitly specified the driver, this choice should | |
1524 | * override the BDRV_O_PROTOCOL flag */ | |
1525 | protocol = drv->bdrv_file_open; | |
53a29513 HR |
1526 | } |
1527 | ||
1528 | if (protocol) { | |
1529 | *flags |= BDRV_O_PROTOCOL; | |
1530 | } else { | |
1531 | *flags &= ~BDRV_O_PROTOCOL; | |
1532 | } | |
1533 | ||
91a097e7 KW |
1534 | /* Translate cache options from flags into options */ |
1535 | update_options_from_flags(*options, *flags); | |
1536 | ||
035fccdf | 1537 | /* Fetch the file name from the options QDict if necessary */ |
17b005f1 | 1538 | if (protocol && filename) { |
f54120ff | 1539 | if (!qdict_haskey(*options, "filename")) { |
46f5ac20 | 1540 | qdict_put_str(*options, "filename", filename); |
f54120ff KW |
1541 | parse_filename = true; |
1542 | } else { | |
1543 | error_setg(errp, "Can't specify 'file' and 'filename' options at " | |
1544 | "the same time"); | |
1545 | return -EINVAL; | |
1546 | } | |
035fccdf KW |
1547 | } |
1548 | ||
c2ad1b0c | 1549 | /* Find the right block driver */ |
129c7d1c | 1550 | /* See cautionary note on accessing @options above */ |
f54120ff | 1551 | filename = qdict_get_try_str(*options, "filename"); |
f54120ff | 1552 | |
053e1578 HR |
1553 | if (!drvname && protocol) { |
1554 | if (filename) { | |
1555 | drv = bdrv_find_protocol(filename, parse_filename, errp); | |
17b005f1 | 1556 | if (!drv) { |
053e1578 | 1557 | return -EINVAL; |
17b005f1 | 1558 | } |
053e1578 HR |
1559 | |
1560 | drvname = drv->format_name; | |
46f5ac20 | 1561 | qdict_put_str(*options, "driver", drvname); |
053e1578 HR |
1562 | } else { |
1563 | error_setg(errp, "Must specify either driver or file"); | |
1564 | return -EINVAL; | |
98289620 | 1565 | } |
c2ad1b0c KW |
1566 | } |
1567 | ||
17b005f1 | 1568 | assert(drv || !protocol); |
c2ad1b0c | 1569 | |
f54120ff | 1570 | /* Driver-specific filename parsing */ |
17b005f1 | 1571 | if (drv && drv->bdrv_parse_filename && parse_filename) { |
5acd9d81 | 1572 | drv->bdrv_parse_filename(filename, *options, &local_err); |
84d18f06 | 1573 | if (local_err) { |
34b5d2c6 | 1574 | error_propagate(errp, local_err); |
f54120ff | 1575 | return -EINVAL; |
6963a30d | 1576 | } |
cd5d031e HR |
1577 | |
1578 | if (!drv->bdrv_needs_filename) { | |
1579 | qdict_del(*options, "filename"); | |
cd5d031e | 1580 | } |
6963a30d KW |
1581 | } |
1582 | ||
f54120ff KW |
1583 | return 0; |
1584 | } | |
1585 | ||
3121fb45 KW |
1586 | static int bdrv_child_check_perm(BdrvChild *c, BlockReopenQueue *q, |
1587 | uint64_t perm, uint64_t shared, | |
c1cef672 FZ |
1588 | GSList *ignore_children, Error **errp); |
1589 | static void bdrv_child_abort_perm_update(BdrvChild *c); | |
1590 | static void bdrv_child_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared); | |
1591 | ||
148eb13c KW |
1592 | typedef struct BlockReopenQueueEntry { |
1593 | bool prepared; | |
1594 | BDRVReopenState state; | |
1595 | QSIMPLEQ_ENTRY(BlockReopenQueueEntry) entry; | |
1596 | } BlockReopenQueueEntry; | |
1597 | ||
1598 | /* | |
1599 | * Return the flags that @bs will have after the reopens in @q have | |
1600 | * successfully completed. If @q is NULL (or @bs is not contained in @q), | |
1601 | * return the current flags. | |
1602 | */ | |
1603 | static int bdrv_reopen_get_flags(BlockReopenQueue *q, BlockDriverState *bs) | |
1604 | { | |
1605 | BlockReopenQueueEntry *entry; | |
1606 | ||
1607 | if (q != NULL) { | |
1608 | QSIMPLEQ_FOREACH(entry, q, entry) { | |
1609 | if (entry->state.bs == bs) { | |
1610 | return entry->state.flags; | |
1611 | } | |
1612 | } | |
1613 | } | |
1614 | ||
1615 | return bs->open_flags; | |
1616 | } | |
1617 | ||
1618 | /* Returns whether the image file can be written to after the reopen queue @q | |
1619 | * has been successfully applied, or right now if @q is NULL. */ | |
1620 | static bool bdrv_is_writable(BlockDriverState *bs, BlockReopenQueue *q) | |
1621 | { | |
1622 | int flags = bdrv_reopen_get_flags(q, bs); | |
1623 | ||
1624 | return (flags & (BDRV_O_RDWR | BDRV_O_INACTIVE)) == BDRV_O_RDWR; | |
1625 | } | |
1626 | ||
ffd1a5a2 | 1627 | static void bdrv_child_perm(BlockDriverState *bs, BlockDriverState *child_bs, |
e0995dc3 KW |
1628 | BdrvChild *c, const BdrvChildRole *role, |
1629 | BlockReopenQueue *reopen_queue, | |
ffd1a5a2 FZ |
1630 | uint64_t parent_perm, uint64_t parent_shared, |
1631 | uint64_t *nperm, uint64_t *nshared) | |
1632 | { | |
1633 | if (bs->drv && bs->drv->bdrv_child_perm) { | |
e0995dc3 | 1634 | bs->drv->bdrv_child_perm(bs, c, role, reopen_queue, |
ffd1a5a2 FZ |
1635 | parent_perm, parent_shared, |
1636 | nperm, nshared); | |
1637 | } | |
e0995dc3 | 1638 | /* TODO Take force_share from reopen_queue */ |
ffd1a5a2 FZ |
1639 | if (child_bs && child_bs->force_share) { |
1640 | *nshared = BLK_PERM_ALL; | |
1641 | } | |
1642 | } | |
1643 | ||
33a610c3 KW |
1644 | /* |
1645 | * Check whether permissions on this node can be changed in a way that | |
1646 | * @cumulative_perms and @cumulative_shared_perms are the new cumulative | |
1647 | * permissions of all its parents. This involves checking whether all necessary | |
1648 | * permission changes to child nodes can be performed. | |
1649 | * | |
1650 | * A call to this function must always be followed by a call to bdrv_set_perm() | |
1651 | * or bdrv_abort_perm_update(). | |
1652 | */ | |
3121fb45 KW |
1653 | static int bdrv_check_perm(BlockDriverState *bs, BlockReopenQueue *q, |
1654 | uint64_t cumulative_perms, | |
46181129 KW |
1655 | uint64_t cumulative_shared_perms, |
1656 | GSList *ignore_children, Error **errp) | |
33a610c3 KW |
1657 | { |
1658 | BlockDriver *drv = bs->drv; | |
1659 | BdrvChild *c; | |
1660 | int ret; | |
1661 | ||
1662 | /* Write permissions never work with read-only images */ | |
1663 | if ((cumulative_perms & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED)) && | |
148eb13c | 1664 | !bdrv_is_writable(bs, q)) |
33a610c3 KW |
1665 | { |
1666 | error_setg(errp, "Block node is read-only"); | |
1667 | return -EPERM; | |
1668 | } | |
1669 | ||
1670 | /* Check this node */ | |
1671 | if (!drv) { | |
1672 | return 0; | |
1673 | } | |
1674 | ||
1675 | if (drv->bdrv_check_perm) { | |
1676 | return drv->bdrv_check_perm(bs, cumulative_perms, | |
1677 | cumulative_shared_perms, errp); | |
1678 | } | |
1679 | ||
78e421c9 | 1680 | /* Drivers that never have children can omit .bdrv_child_perm() */ |
33a610c3 | 1681 | if (!drv->bdrv_child_perm) { |
78e421c9 | 1682 | assert(QLIST_EMPTY(&bs->children)); |
33a610c3 KW |
1683 | return 0; |
1684 | } | |
1685 | ||
1686 | /* Check all children */ | |
1687 | QLIST_FOREACH(c, &bs->children, next) { | |
1688 | uint64_t cur_perm, cur_shared; | |
3121fb45 | 1689 | bdrv_child_perm(bs, c->bs, c, c->role, q, |
ffd1a5a2 FZ |
1690 | cumulative_perms, cumulative_shared_perms, |
1691 | &cur_perm, &cur_shared); | |
3121fb45 KW |
1692 | ret = bdrv_child_check_perm(c, q, cur_perm, cur_shared, |
1693 | ignore_children, errp); | |
33a610c3 KW |
1694 | if (ret < 0) { |
1695 | return ret; | |
1696 | } | |
1697 | } | |
1698 | ||
1699 | return 0; | |
1700 | } | |
1701 | ||
1702 | /* | |
1703 | * Notifies drivers that after a previous bdrv_check_perm() call, the | |
1704 | * permission update is not performed and any preparations made for it (e.g. | |
1705 | * taken file locks) need to be undone. | |
1706 | * | |
1707 | * This function recursively notifies all child nodes. | |
1708 | */ | |
1709 | static void bdrv_abort_perm_update(BlockDriverState *bs) | |
1710 | { | |
1711 | BlockDriver *drv = bs->drv; | |
1712 | BdrvChild *c; | |
1713 | ||
1714 | if (!drv) { | |
1715 | return; | |
1716 | } | |
1717 | ||
1718 | if (drv->bdrv_abort_perm_update) { | |
1719 | drv->bdrv_abort_perm_update(bs); | |
1720 | } | |
1721 | ||
1722 | QLIST_FOREACH(c, &bs->children, next) { | |
1723 | bdrv_child_abort_perm_update(c); | |
1724 | } | |
1725 | } | |
1726 | ||
1727 | static void bdrv_set_perm(BlockDriverState *bs, uint64_t cumulative_perms, | |
1728 | uint64_t cumulative_shared_perms) | |
1729 | { | |
1730 | BlockDriver *drv = bs->drv; | |
1731 | BdrvChild *c; | |
1732 | ||
1733 | if (!drv) { | |
1734 | return; | |
1735 | } | |
1736 | ||
1737 | /* Update this node */ | |
1738 | if (drv->bdrv_set_perm) { | |
1739 | drv->bdrv_set_perm(bs, cumulative_perms, cumulative_shared_perms); | |
1740 | } | |
1741 | ||
78e421c9 | 1742 | /* Drivers that never have children can omit .bdrv_child_perm() */ |
33a610c3 | 1743 | if (!drv->bdrv_child_perm) { |
78e421c9 | 1744 | assert(QLIST_EMPTY(&bs->children)); |
33a610c3 KW |
1745 | return; |
1746 | } | |
1747 | ||
1748 | /* Update all children */ | |
1749 | QLIST_FOREACH(c, &bs->children, next) { | |
1750 | uint64_t cur_perm, cur_shared; | |
e0995dc3 | 1751 | bdrv_child_perm(bs, c->bs, c, c->role, NULL, |
ffd1a5a2 FZ |
1752 | cumulative_perms, cumulative_shared_perms, |
1753 | &cur_perm, &cur_shared); | |
33a610c3 KW |
1754 | bdrv_child_set_perm(c, cur_perm, cur_shared); |
1755 | } | |
1756 | } | |
1757 | ||
1758 | static void bdrv_get_cumulative_perm(BlockDriverState *bs, uint64_t *perm, | |
1759 | uint64_t *shared_perm) | |
1760 | { | |
1761 | BdrvChild *c; | |
1762 | uint64_t cumulative_perms = 0; | |
1763 | uint64_t cumulative_shared_perms = BLK_PERM_ALL; | |
1764 | ||
1765 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
1766 | cumulative_perms |= c->perm; | |
1767 | cumulative_shared_perms &= c->shared_perm; | |
1768 | } | |
1769 | ||
1770 | *perm = cumulative_perms; | |
1771 | *shared_perm = cumulative_shared_perms; | |
1772 | } | |
1773 | ||
d083319f KW |
1774 | static char *bdrv_child_user_desc(BdrvChild *c) |
1775 | { | |
1776 | if (c->role->get_parent_desc) { | |
1777 | return c->role->get_parent_desc(c); | |
1778 | } | |
1779 | ||
1780 | return g_strdup("another user"); | |
1781 | } | |
1782 | ||
5176196c | 1783 | char *bdrv_perm_names(uint64_t perm) |
d083319f KW |
1784 | { |
1785 | struct perm_name { | |
1786 | uint64_t perm; | |
1787 | const char *name; | |
1788 | } permissions[] = { | |
1789 | { BLK_PERM_CONSISTENT_READ, "consistent read" }, | |
1790 | { BLK_PERM_WRITE, "write" }, | |
1791 | { BLK_PERM_WRITE_UNCHANGED, "write unchanged" }, | |
1792 | { BLK_PERM_RESIZE, "resize" }, | |
1793 | { BLK_PERM_GRAPH_MOD, "change children" }, | |
1794 | { 0, NULL } | |
1795 | }; | |
1796 | ||
1797 | char *result = g_strdup(""); | |
1798 | struct perm_name *p; | |
1799 | ||
1800 | for (p = permissions; p->name; p++) { | |
1801 | if (perm & p->perm) { | |
1802 | char *old = result; | |
1803 | result = g_strdup_printf("%s%s%s", old, *old ? ", " : "", p->name); | |
1804 | g_free(old); | |
1805 | } | |
1806 | } | |
1807 | ||
1808 | return result; | |
1809 | } | |
1810 | ||
33a610c3 KW |
1811 | /* |
1812 | * Checks whether a new reference to @bs can be added if the new user requires | |
46181129 KW |
1813 | * @new_used_perm/@new_shared_perm as its permissions. If @ignore_children is |
1814 | * set, the BdrvChild objects in this list are ignored in the calculations; | |
1815 | * this allows checking permission updates for an existing reference. | |
33a610c3 KW |
1816 | * |
1817 | * Needs to be followed by a call to either bdrv_set_perm() or | |
1818 | * bdrv_abort_perm_update(). */ | |
3121fb45 KW |
1819 | static int bdrv_check_update_perm(BlockDriverState *bs, BlockReopenQueue *q, |
1820 | uint64_t new_used_perm, | |
d5e6f437 | 1821 | uint64_t new_shared_perm, |
46181129 | 1822 | GSList *ignore_children, Error **errp) |
d5e6f437 KW |
1823 | { |
1824 | BdrvChild *c; | |
33a610c3 KW |
1825 | uint64_t cumulative_perms = new_used_perm; |
1826 | uint64_t cumulative_shared_perms = new_shared_perm; | |
d5e6f437 KW |
1827 | |
1828 | /* There is no reason why anyone couldn't tolerate write_unchanged */ | |
1829 | assert(new_shared_perm & BLK_PERM_WRITE_UNCHANGED); | |
1830 | ||
1831 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
46181129 | 1832 | if (g_slist_find(ignore_children, c)) { |
d5e6f437 KW |
1833 | continue; |
1834 | } | |
1835 | ||
d083319f KW |
1836 | if ((new_used_perm & c->shared_perm) != new_used_perm) { |
1837 | char *user = bdrv_child_user_desc(c); | |
1838 | char *perm_names = bdrv_perm_names(new_used_perm & ~c->shared_perm); | |
1839 | error_setg(errp, "Conflicts with use by %s as '%s', which does not " | |
1840 | "allow '%s' on %s", | |
1841 | user, c->name, perm_names, bdrv_get_node_name(c->bs)); | |
1842 | g_free(user); | |
1843 | g_free(perm_names); | |
1844 | return -EPERM; | |
1845 | } | |
1846 | ||
1847 | if ((c->perm & new_shared_perm) != c->perm) { | |
1848 | char *user = bdrv_child_user_desc(c); | |
1849 | char *perm_names = bdrv_perm_names(c->perm & ~new_shared_perm); | |
1850 | error_setg(errp, "Conflicts with use by %s as '%s', which uses " | |
1851 | "'%s' on %s", | |
1852 | user, c->name, perm_names, bdrv_get_node_name(c->bs)); | |
1853 | g_free(user); | |
1854 | g_free(perm_names); | |
d5e6f437 KW |
1855 | return -EPERM; |
1856 | } | |
33a610c3 KW |
1857 | |
1858 | cumulative_perms |= c->perm; | |
1859 | cumulative_shared_perms &= c->shared_perm; | |
d5e6f437 KW |
1860 | } |
1861 | ||
3121fb45 | 1862 | return bdrv_check_perm(bs, q, cumulative_perms, cumulative_shared_perms, |
46181129 | 1863 | ignore_children, errp); |
33a610c3 KW |
1864 | } |
1865 | ||
1866 | /* Needs to be followed by a call to either bdrv_child_set_perm() or | |
1867 | * bdrv_child_abort_perm_update(). */ | |
3121fb45 KW |
1868 | static int bdrv_child_check_perm(BdrvChild *c, BlockReopenQueue *q, |
1869 | uint64_t perm, uint64_t shared, | |
c1cef672 | 1870 | GSList *ignore_children, Error **errp) |
33a610c3 | 1871 | { |
46181129 KW |
1872 | int ret; |
1873 | ||
1874 | ignore_children = g_slist_prepend(g_slist_copy(ignore_children), c); | |
3121fb45 | 1875 | ret = bdrv_check_update_perm(c->bs, q, perm, shared, ignore_children, errp); |
46181129 KW |
1876 | g_slist_free(ignore_children); |
1877 | ||
1878 | return ret; | |
33a610c3 KW |
1879 | } |
1880 | ||
c1cef672 | 1881 | static void bdrv_child_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared) |
33a610c3 KW |
1882 | { |
1883 | uint64_t cumulative_perms, cumulative_shared_perms; | |
1884 | ||
1885 | c->perm = perm; | |
1886 | c->shared_perm = shared; | |
1887 | ||
1888 | bdrv_get_cumulative_perm(c->bs, &cumulative_perms, | |
1889 | &cumulative_shared_perms); | |
1890 | bdrv_set_perm(c->bs, cumulative_perms, cumulative_shared_perms); | |
1891 | } | |
1892 | ||
c1cef672 | 1893 | static void bdrv_child_abort_perm_update(BdrvChild *c) |
33a610c3 KW |
1894 | { |
1895 | bdrv_abort_perm_update(c->bs); | |
1896 | } | |
1897 | ||
1898 | int bdrv_child_try_set_perm(BdrvChild *c, uint64_t perm, uint64_t shared, | |
1899 | Error **errp) | |
1900 | { | |
1901 | int ret; | |
1902 | ||
3121fb45 | 1903 | ret = bdrv_child_check_perm(c, NULL, perm, shared, NULL, errp); |
33a610c3 KW |
1904 | if (ret < 0) { |
1905 | bdrv_child_abort_perm_update(c); | |
1906 | return ret; | |
1907 | } | |
1908 | ||
1909 | bdrv_child_set_perm(c, perm, shared); | |
1910 | ||
d5e6f437 KW |
1911 | return 0; |
1912 | } | |
1913 | ||
6a1b9ee1 KW |
1914 | #define DEFAULT_PERM_PASSTHROUGH (BLK_PERM_CONSISTENT_READ \ |
1915 | | BLK_PERM_WRITE \ | |
1916 | | BLK_PERM_WRITE_UNCHANGED \ | |
1917 | | BLK_PERM_RESIZE) | |
1918 | #define DEFAULT_PERM_UNCHANGED (BLK_PERM_ALL & ~DEFAULT_PERM_PASSTHROUGH) | |
1919 | ||
1920 | void bdrv_filter_default_perms(BlockDriverState *bs, BdrvChild *c, | |
1921 | const BdrvChildRole *role, | |
e0995dc3 | 1922 | BlockReopenQueue *reopen_queue, |
6a1b9ee1 KW |
1923 | uint64_t perm, uint64_t shared, |
1924 | uint64_t *nperm, uint64_t *nshared) | |
1925 | { | |
1926 | if (c == NULL) { | |
1927 | *nperm = perm & DEFAULT_PERM_PASSTHROUGH; | |
1928 | *nshared = (shared & DEFAULT_PERM_PASSTHROUGH) | DEFAULT_PERM_UNCHANGED; | |
1929 | return; | |
1930 | } | |
1931 | ||
1932 | *nperm = (perm & DEFAULT_PERM_PASSTHROUGH) | | |
1933 | (c->perm & DEFAULT_PERM_UNCHANGED); | |
1934 | *nshared = (shared & DEFAULT_PERM_PASSTHROUGH) | | |
1935 | (c->shared_perm & DEFAULT_PERM_UNCHANGED); | |
1936 | } | |
1937 | ||
6b1a044a KW |
1938 | void bdrv_format_default_perms(BlockDriverState *bs, BdrvChild *c, |
1939 | const BdrvChildRole *role, | |
e0995dc3 | 1940 | BlockReopenQueue *reopen_queue, |
6b1a044a KW |
1941 | uint64_t perm, uint64_t shared, |
1942 | uint64_t *nperm, uint64_t *nshared) | |
1943 | { | |
1944 | bool backing = (role == &child_backing); | |
1945 | assert(role == &child_backing || role == &child_file); | |
1946 | ||
1947 | if (!backing) { | |
5fbfabd3 KW |
1948 | int flags = bdrv_reopen_get_flags(reopen_queue, bs); |
1949 | ||
6b1a044a KW |
1950 | /* Apart from the modifications below, the same permissions are |
1951 | * forwarded and left alone as for filters */ | |
e0995dc3 KW |
1952 | bdrv_filter_default_perms(bs, c, role, reopen_queue, perm, shared, |
1953 | &perm, &shared); | |
6b1a044a KW |
1954 | |
1955 | /* Format drivers may touch metadata even if the guest doesn't write */ | |
148eb13c | 1956 | if (bdrv_is_writable(bs, reopen_queue)) { |
6b1a044a KW |
1957 | perm |= BLK_PERM_WRITE | BLK_PERM_RESIZE; |
1958 | } | |
1959 | ||
1960 | /* bs->file always needs to be consistent because of the metadata. We | |
1961 | * can never allow other users to resize or write to it. */ | |
5fbfabd3 KW |
1962 | if (!(flags & BDRV_O_NO_IO)) { |
1963 | perm |= BLK_PERM_CONSISTENT_READ; | |
1964 | } | |
6b1a044a KW |
1965 | shared &= ~(BLK_PERM_WRITE | BLK_PERM_RESIZE); |
1966 | } else { | |
1967 | /* We want consistent read from backing files if the parent needs it. | |
1968 | * No other operations are performed on backing files. */ | |
1969 | perm &= BLK_PERM_CONSISTENT_READ; | |
1970 | ||
1971 | /* If the parent can deal with changing data, we're okay with a | |
1972 | * writable and resizable backing file. */ | |
1973 | /* TODO Require !(perm & BLK_PERM_CONSISTENT_READ), too? */ | |
1974 | if (shared & BLK_PERM_WRITE) { | |
1975 | shared = BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
1976 | } else { | |
1977 | shared = 0; | |
1978 | } | |
1979 | ||
1980 | shared |= BLK_PERM_CONSISTENT_READ | BLK_PERM_GRAPH_MOD | | |
1981 | BLK_PERM_WRITE_UNCHANGED; | |
1982 | } | |
1983 | ||
9c5e6594 KW |
1984 | if (bs->open_flags & BDRV_O_INACTIVE) { |
1985 | shared |= BLK_PERM_WRITE | BLK_PERM_RESIZE; | |
1986 | } | |
1987 | ||
6b1a044a KW |
1988 | *nperm = perm; |
1989 | *nshared = shared; | |
1990 | } | |
1991 | ||
8ee03995 KW |
1992 | static void bdrv_replace_child_noperm(BdrvChild *child, |
1993 | BlockDriverState *new_bs) | |
e9740bc6 KW |
1994 | { |
1995 | BlockDriverState *old_bs = child->bs; | |
0152bf40 | 1996 | int i; |
e9740bc6 | 1997 | |
bb2614e9 FZ |
1998 | if (old_bs && new_bs) { |
1999 | assert(bdrv_get_aio_context(old_bs) == bdrv_get_aio_context(new_bs)); | |
2000 | } | |
e9740bc6 | 2001 | if (old_bs) { |
d736f119 KW |
2002 | /* Detach first so that the recursive drain sections coming from @child |
2003 | * are already gone and we only end the drain sections that came from | |
2004 | * elsewhere. */ | |
2005 | if (child->role->detach) { | |
2006 | child->role->detach(child); | |
2007 | } | |
36fe1331 | 2008 | if (old_bs->quiesce_counter && child->role->drained_end) { |
0152bf40 KW |
2009 | for (i = 0; i < old_bs->quiesce_counter; i++) { |
2010 | child->role->drained_end(child); | |
2011 | } | |
36fe1331 | 2012 | } |
e9740bc6 KW |
2013 | QLIST_REMOVE(child, next_parent); |
2014 | } | |
36fe1331 KW |
2015 | |
2016 | child->bs = new_bs; | |
2017 | ||
e9740bc6 KW |
2018 | if (new_bs) { |
2019 | QLIST_INSERT_HEAD(&new_bs->parents, child, next_parent); | |
36fe1331 | 2020 | if (new_bs->quiesce_counter && child->role->drained_begin) { |
0152bf40 KW |
2021 | for (i = 0; i < new_bs->quiesce_counter; i++) { |
2022 | child->role->drained_begin(child); | |
2023 | } | |
36fe1331 | 2024 | } |
33a610c3 | 2025 | |
d736f119 KW |
2026 | /* Attach only after starting new drained sections, so that recursive |
2027 | * drain sections coming from @child don't get an extra .drained_begin | |
2028 | * callback. */ | |
8ee03995 KW |
2029 | if (child->role->attach) { |
2030 | child->role->attach(child); | |
2031 | } | |
2032 | } | |
2033 | } | |
33a610c3 | 2034 | |
466787fb KW |
2035 | /* |
2036 | * Updates @child to change its reference to point to @new_bs, including | |
2037 | * checking and applying the necessary permisson updates both to the old node | |
2038 | * and to @new_bs. | |
2039 | * | |
2040 | * NULL is passed as @new_bs for removing the reference before freeing @child. | |
2041 | * | |
2042 | * If @new_bs is not NULL, bdrv_check_perm() must be called beforehand, as this | |
2043 | * function uses bdrv_set_perm() to update the permissions according to the new | |
2044 | * reference that @new_bs gets. | |
2045 | */ | |
2046 | static void bdrv_replace_child(BdrvChild *child, BlockDriverState *new_bs) | |
8ee03995 KW |
2047 | { |
2048 | BlockDriverState *old_bs = child->bs; | |
2049 | uint64_t perm, shared_perm; | |
2050 | ||
8aecf1d1 KW |
2051 | bdrv_replace_child_noperm(child, new_bs); |
2052 | ||
8ee03995 | 2053 | if (old_bs) { |
33a610c3 KW |
2054 | /* Update permissions for old node. This is guaranteed to succeed |
2055 | * because we're just taking a parent away, so we're loosening | |
2056 | * restrictions. */ | |
2057 | bdrv_get_cumulative_perm(old_bs, &perm, &shared_perm); | |
3121fb45 | 2058 | bdrv_check_perm(old_bs, NULL, perm, shared_perm, NULL, &error_abort); |
33a610c3 | 2059 | bdrv_set_perm(old_bs, perm, shared_perm); |
e9740bc6 | 2060 | } |
36fe1331 | 2061 | |
e9740bc6 | 2062 | if (new_bs) { |
33a610c3 | 2063 | bdrv_get_cumulative_perm(new_bs, &perm, &shared_perm); |
33a610c3 | 2064 | bdrv_set_perm(new_bs, perm, shared_perm); |
e9740bc6 | 2065 | } |
e9740bc6 KW |
2066 | } |
2067 | ||
f21d96d0 KW |
2068 | BdrvChild *bdrv_root_attach_child(BlockDriverState *child_bs, |
2069 | const char *child_name, | |
36fe1331 | 2070 | const BdrvChildRole *child_role, |
d5e6f437 KW |
2071 | uint64_t perm, uint64_t shared_perm, |
2072 | void *opaque, Error **errp) | |
df581792 | 2073 | { |
d5e6f437 KW |
2074 | BdrvChild *child; |
2075 | int ret; | |
2076 | ||
3121fb45 | 2077 | ret = bdrv_check_update_perm(child_bs, NULL, perm, shared_perm, NULL, errp); |
d5e6f437 | 2078 | if (ret < 0) { |
33a610c3 | 2079 | bdrv_abort_perm_update(child_bs); |
d5e6f437 KW |
2080 | return NULL; |
2081 | } | |
2082 | ||
2083 | child = g_new(BdrvChild, 1); | |
df581792 | 2084 | *child = (BdrvChild) { |
d5e6f437 KW |
2085 | .bs = NULL, |
2086 | .name = g_strdup(child_name), | |
2087 | .role = child_role, | |
2088 | .perm = perm, | |
2089 | .shared_perm = shared_perm, | |
2090 | .opaque = opaque, | |
df581792 KW |
2091 | }; |
2092 | ||
33a610c3 | 2093 | /* This performs the matching bdrv_set_perm() for the above check. */ |
466787fb | 2094 | bdrv_replace_child(child, child_bs); |
b4b059f6 KW |
2095 | |
2096 | return child; | |
df581792 KW |
2097 | } |
2098 | ||
98292c61 WC |
2099 | BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs, |
2100 | BlockDriverState *child_bs, | |
2101 | const char *child_name, | |
8b2ff529 KW |
2102 | const BdrvChildRole *child_role, |
2103 | Error **errp) | |
f21d96d0 | 2104 | { |
d5e6f437 | 2105 | BdrvChild *child; |
f68c598b KW |
2106 | uint64_t perm, shared_perm; |
2107 | ||
2108 | bdrv_get_cumulative_perm(parent_bs, &perm, &shared_perm); | |
2109 | ||
2110 | assert(parent_bs->drv); | |
bb2614e9 | 2111 | assert(bdrv_get_aio_context(parent_bs) == bdrv_get_aio_context(child_bs)); |
e0995dc3 | 2112 | bdrv_child_perm(parent_bs, child_bs, NULL, child_role, NULL, |
ffd1a5a2 | 2113 | perm, shared_perm, &perm, &shared_perm); |
d5e6f437 | 2114 | |
d5e6f437 | 2115 | child = bdrv_root_attach_child(child_bs, child_name, child_role, |
f68c598b | 2116 | perm, shared_perm, parent_bs, errp); |
d5e6f437 KW |
2117 | if (child == NULL) { |
2118 | return NULL; | |
2119 | } | |
2120 | ||
f21d96d0 KW |
2121 | QLIST_INSERT_HEAD(&parent_bs->children, child, next); |
2122 | return child; | |
2123 | } | |
2124 | ||
3f09bfbc | 2125 | static void bdrv_detach_child(BdrvChild *child) |
33a60407 | 2126 | { |
f21d96d0 KW |
2127 | if (child->next.le_prev) { |
2128 | QLIST_REMOVE(child, next); | |
2129 | child->next.le_prev = NULL; | |
2130 | } | |
e9740bc6 | 2131 | |
466787fb | 2132 | bdrv_replace_child(child, NULL); |
e9740bc6 | 2133 | |
260fecf1 | 2134 | g_free(child->name); |
33a60407 KW |
2135 | g_free(child); |
2136 | } | |
2137 | ||
f21d96d0 | 2138 | void bdrv_root_unref_child(BdrvChild *child) |
33a60407 | 2139 | { |
779020cb KW |
2140 | BlockDriverState *child_bs; |
2141 | ||
f21d96d0 KW |
2142 | child_bs = child->bs; |
2143 | bdrv_detach_child(child); | |
2144 | bdrv_unref(child_bs); | |
2145 | } | |
2146 | ||
2147 | void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child) | |
2148 | { | |
779020cb KW |
2149 | if (child == NULL) { |
2150 | return; | |
2151 | } | |
33a60407 KW |
2152 | |
2153 | if (child->bs->inherits_from == parent) { | |
4e4bf5c4 KW |
2154 | BdrvChild *c; |
2155 | ||
2156 | /* Remove inherits_from only when the last reference between parent and | |
2157 | * child->bs goes away. */ | |
2158 | QLIST_FOREACH(c, &parent->children, next) { | |
2159 | if (c != child && c->bs == child->bs) { | |
2160 | break; | |
2161 | } | |
2162 | } | |
2163 | if (c == NULL) { | |
2164 | child->bs->inherits_from = NULL; | |
2165 | } | |
33a60407 KW |
2166 | } |
2167 | ||
f21d96d0 | 2168 | bdrv_root_unref_child(child); |
33a60407 KW |
2169 | } |
2170 | ||
5c8cab48 KW |
2171 | |
2172 | static void bdrv_parent_cb_change_media(BlockDriverState *bs, bool load) | |
2173 | { | |
2174 | BdrvChild *c; | |
2175 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
2176 | if (c->role->change_media) { | |
2177 | c->role->change_media(c, load); | |
2178 | } | |
2179 | } | |
2180 | } | |
2181 | ||
2182 | static void bdrv_parent_cb_resize(BlockDriverState *bs) | |
2183 | { | |
2184 | BdrvChild *c; | |
2185 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
2186 | if (c->role->resize) { | |
2187 | c->role->resize(c); | |
2188 | } | |
2189 | } | |
2190 | } | |
2191 | ||
5db15a57 KW |
2192 | /* |
2193 | * Sets the backing file link of a BDS. A new reference is created; callers | |
2194 | * which don't need their own reference any more must call bdrv_unref(). | |
2195 | */ | |
12fa4af6 KW |
2196 | void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd, |
2197 | Error **errp) | |
8d24cce1 | 2198 | { |
5db15a57 KW |
2199 | if (backing_hd) { |
2200 | bdrv_ref(backing_hd); | |
2201 | } | |
8d24cce1 | 2202 | |
760e0063 | 2203 | if (bs->backing) { |
5db15a57 | 2204 | bdrv_unref_child(bs, bs->backing); |
826b6ca0 FZ |
2205 | } |
2206 | ||
8d24cce1 | 2207 | if (!backing_hd) { |
760e0063 | 2208 | bs->backing = NULL; |
8d24cce1 FZ |
2209 | goto out; |
2210 | } | |
12fa4af6 | 2211 | |
8b2ff529 | 2212 | bs->backing = bdrv_attach_child(bs, backing_hd, "backing", &child_backing, |
12fa4af6 KW |
2213 | errp); |
2214 | if (!bs->backing) { | |
2215 | bdrv_unref(backing_hd); | |
2216 | } | |
826b6ca0 | 2217 | |
9e7e940c KW |
2218 | bdrv_refresh_filename(bs); |
2219 | ||
8d24cce1 | 2220 | out: |
3baca891 | 2221 | bdrv_refresh_limits(bs, NULL); |
8d24cce1 FZ |
2222 | } |
2223 | ||
31ca6d07 KW |
2224 | /* |
2225 | * Opens the backing file for a BlockDriverState if not yet open | |
2226 | * | |
d9b7b057 KW |
2227 | * bdref_key specifies the key for the image's BlockdevRef in the options QDict. |
2228 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
2229 | * itself, all options starting with "${bdref_key}." are considered part of the | |
2230 | * BlockdevRef. | |
2231 | * | |
2232 | * TODO Can this be unified with bdrv_open_image()? | |
31ca6d07 | 2233 | */ |
d9b7b057 KW |
2234 | int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options, |
2235 | const char *bdref_key, Error **errp) | |
9156df12 | 2236 | { |
1ba4b6a5 | 2237 | char *backing_filename = g_malloc0(PATH_MAX); |
d9b7b057 KW |
2238 | char *bdref_key_dot; |
2239 | const char *reference = NULL; | |
317fc44e | 2240 | int ret = 0; |
8d24cce1 | 2241 | BlockDriverState *backing_hd; |
d9b7b057 KW |
2242 | QDict *options; |
2243 | QDict *tmp_parent_options = NULL; | |
34b5d2c6 | 2244 | Error *local_err = NULL; |
9156df12 | 2245 | |
760e0063 | 2246 | if (bs->backing != NULL) { |
1ba4b6a5 | 2247 | goto free_exit; |
9156df12 PB |
2248 | } |
2249 | ||
31ca6d07 | 2250 | /* NULL means an empty set of options */ |
d9b7b057 KW |
2251 | if (parent_options == NULL) { |
2252 | tmp_parent_options = qdict_new(); | |
2253 | parent_options = tmp_parent_options; | |
31ca6d07 KW |
2254 | } |
2255 | ||
9156df12 | 2256 | bs->open_flags &= ~BDRV_O_NO_BACKING; |
d9b7b057 KW |
2257 | |
2258 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); | |
2259 | qdict_extract_subqdict(parent_options, &options, bdref_key_dot); | |
2260 | g_free(bdref_key_dot); | |
2261 | ||
129c7d1c MA |
2262 | /* |
2263 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
2264 | * types would require more care. When @parent_options come from | |
2265 | * -blockdev or blockdev_add, its members are typed according to | |
2266 | * the QAPI schema, but when they come from -drive, they're all | |
2267 | * QString. | |
2268 | */ | |
d9b7b057 KW |
2269 | reference = qdict_get_try_str(parent_options, bdref_key); |
2270 | if (reference || qdict_haskey(options, "file.filename")) { | |
1cb6f506 KW |
2271 | backing_filename[0] = '\0'; |
2272 | } else if (bs->backing_file[0] == '\0' && qdict_size(options) == 0) { | |
31ca6d07 | 2273 | QDECREF(options); |
1ba4b6a5 | 2274 | goto free_exit; |
dbecebdd | 2275 | } else { |
9f07429e HR |
2276 | bdrv_get_full_backing_filename(bs, backing_filename, PATH_MAX, |
2277 | &local_err); | |
2278 | if (local_err) { | |
2279 | ret = -EINVAL; | |
2280 | error_propagate(errp, local_err); | |
2281 | QDECREF(options); | |
2282 | goto free_exit; | |
2283 | } | |
9156df12 PB |
2284 | } |
2285 | ||
8ee79e70 KW |
2286 | if (!bs->drv || !bs->drv->supports_backing) { |
2287 | ret = -EINVAL; | |
2288 | error_setg(errp, "Driver doesn't support backing files"); | |
2289 | QDECREF(options); | |
2290 | goto free_exit; | |
2291 | } | |
2292 | ||
6bff597b PK |
2293 | if (!reference && |
2294 | bs->backing_format[0] != '\0' && !qdict_haskey(options, "driver")) { | |
46f5ac20 | 2295 | qdict_put_str(options, "driver", bs->backing_format); |
9156df12 PB |
2296 | } |
2297 | ||
5b363937 HR |
2298 | backing_hd = bdrv_open_inherit(*backing_filename ? backing_filename : NULL, |
2299 | reference, options, 0, bs, &child_backing, | |
2300 | errp); | |
2301 | if (!backing_hd) { | |
9156df12 | 2302 | bs->open_flags |= BDRV_O_NO_BACKING; |
e43bfd9c | 2303 | error_prepend(errp, "Could not open backing file: "); |
5b363937 | 2304 | ret = -EINVAL; |
1ba4b6a5 | 2305 | goto free_exit; |
9156df12 | 2306 | } |
5ce6bfe2 | 2307 | bdrv_set_aio_context(backing_hd, bdrv_get_aio_context(bs)); |
df581792 | 2308 | |
5db15a57 KW |
2309 | /* Hook up the backing file link; drop our reference, bs owns the |
2310 | * backing_hd reference now */ | |
12fa4af6 | 2311 | bdrv_set_backing_hd(bs, backing_hd, &local_err); |
5db15a57 | 2312 | bdrv_unref(backing_hd); |
12fa4af6 | 2313 | if (local_err) { |
8cd1a3e4 | 2314 | error_propagate(errp, local_err); |
12fa4af6 KW |
2315 | ret = -EINVAL; |
2316 | goto free_exit; | |
2317 | } | |
d80ac658 | 2318 | |
d9b7b057 KW |
2319 | qdict_del(parent_options, bdref_key); |
2320 | ||
1ba4b6a5 BC |
2321 | free_exit: |
2322 | g_free(backing_filename); | |
d9b7b057 | 2323 | QDECREF(tmp_parent_options); |
1ba4b6a5 | 2324 | return ret; |
9156df12 PB |
2325 | } |
2326 | ||
2d6b86af KW |
2327 | static BlockDriverState * |
2328 | bdrv_open_child_bs(const char *filename, QDict *options, const char *bdref_key, | |
2329 | BlockDriverState *parent, const BdrvChildRole *child_role, | |
2330 | bool allow_none, Error **errp) | |
da557aac | 2331 | { |
2d6b86af | 2332 | BlockDriverState *bs = NULL; |
da557aac | 2333 | QDict *image_options; |
da557aac HR |
2334 | char *bdref_key_dot; |
2335 | const char *reference; | |
2336 | ||
df581792 | 2337 | assert(child_role != NULL); |
f67503e5 | 2338 | |
da557aac HR |
2339 | bdref_key_dot = g_strdup_printf("%s.", bdref_key); |
2340 | qdict_extract_subqdict(options, &image_options, bdref_key_dot); | |
2341 | g_free(bdref_key_dot); | |
2342 | ||
129c7d1c MA |
2343 | /* |
2344 | * Caution: while qdict_get_try_str() is fine, getting non-string | |
2345 | * types would require more care. When @options come from | |
2346 | * -blockdev or blockdev_add, its members are typed according to | |
2347 | * the QAPI schema, but when they come from -drive, they're all | |
2348 | * QString. | |
2349 | */ | |
da557aac HR |
2350 | reference = qdict_get_try_str(options, bdref_key); |
2351 | if (!filename && !reference && !qdict_size(image_options)) { | |
b4b059f6 | 2352 | if (!allow_none) { |
da557aac HR |
2353 | error_setg(errp, "A block device must be specified for \"%s\"", |
2354 | bdref_key); | |
da557aac | 2355 | } |
b20e61e0 | 2356 | QDECREF(image_options); |
da557aac HR |
2357 | goto done; |
2358 | } | |
2359 | ||
5b363937 HR |
2360 | bs = bdrv_open_inherit(filename, reference, image_options, 0, |
2361 | parent, child_role, errp); | |
2362 | if (!bs) { | |
df581792 KW |
2363 | goto done; |
2364 | } | |
2365 | ||
da557aac HR |
2366 | done: |
2367 | qdict_del(options, bdref_key); | |
2d6b86af KW |
2368 | return bs; |
2369 | } | |
2370 | ||
2371 | /* | |
2372 | * Opens a disk image whose options are given as BlockdevRef in another block | |
2373 | * device's options. | |
2374 | * | |
2375 | * If allow_none is true, no image will be opened if filename is false and no | |
2376 | * BlockdevRef is given. NULL will be returned, but errp remains unset. | |
2377 | * | |
2378 | * bdrev_key specifies the key for the image's BlockdevRef in the options QDict. | |
2379 | * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict | |
2380 | * itself, all options starting with "${bdref_key}." are considered part of the | |
2381 | * BlockdevRef. | |
2382 | * | |
2383 | * The BlockdevRef will be removed from the options QDict. | |
2384 | */ | |
2385 | BdrvChild *bdrv_open_child(const char *filename, | |
2386 | QDict *options, const char *bdref_key, | |
2387 | BlockDriverState *parent, | |
2388 | const BdrvChildRole *child_role, | |
2389 | bool allow_none, Error **errp) | |
2390 | { | |
8b2ff529 | 2391 | BdrvChild *c; |
2d6b86af KW |
2392 | BlockDriverState *bs; |
2393 | ||
2394 | bs = bdrv_open_child_bs(filename, options, bdref_key, parent, child_role, | |
2395 | allow_none, errp); | |
2396 | if (bs == NULL) { | |
2397 | return NULL; | |
2398 | } | |
2399 | ||
8b2ff529 KW |
2400 | c = bdrv_attach_child(parent, bs, bdref_key, child_role, errp); |
2401 | if (!c) { | |
2402 | bdrv_unref(bs); | |
2403 | return NULL; | |
2404 | } | |
2405 | ||
2406 | return c; | |
b4b059f6 KW |
2407 | } |
2408 | ||
66836189 HR |
2409 | static BlockDriverState *bdrv_append_temp_snapshot(BlockDriverState *bs, |
2410 | int flags, | |
2411 | QDict *snapshot_options, | |
2412 | Error **errp) | |
b998875d KW |
2413 | { |
2414 | /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */ | |
1ba4b6a5 | 2415 | char *tmp_filename = g_malloc0(PATH_MAX + 1); |
b998875d | 2416 | int64_t total_size; |
83d0521a | 2417 | QemuOpts *opts = NULL; |
ff6ed714 | 2418 | BlockDriverState *bs_snapshot = NULL; |
b2c2832c | 2419 | Error *local_err = NULL; |
b998875d KW |
2420 | int ret; |
2421 | ||
2422 | /* if snapshot, we create a temporary backing file and open it | |
2423 | instead of opening 'filename' directly */ | |
2424 | ||
2425 | /* Get the required size from the image */ | |
f187743a KW |
2426 | total_size = bdrv_getlength(bs); |
2427 | if (total_size < 0) { | |
2428 | error_setg_errno(errp, -total_size, "Could not get image size"); | |
1ba4b6a5 | 2429 | goto out; |
f187743a | 2430 | } |
b998875d KW |
2431 | |
2432 | /* Create the temporary image */ | |
1ba4b6a5 | 2433 | ret = get_tmp_filename(tmp_filename, PATH_MAX + 1); |
b998875d KW |
2434 | if (ret < 0) { |
2435 | error_setg_errno(errp, -ret, "Could not get temporary filename"); | |
1ba4b6a5 | 2436 | goto out; |
b998875d KW |
2437 | } |
2438 | ||
ef810437 | 2439 | opts = qemu_opts_create(bdrv_qcow2.create_opts, NULL, 0, |
c282e1fd | 2440 | &error_abort); |
39101f25 | 2441 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_size, &error_abort); |
e43bfd9c | 2442 | ret = bdrv_create(&bdrv_qcow2, tmp_filename, opts, errp); |
83d0521a | 2443 | qemu_opts_del(opts); |
b998875d | 2444 | if (ret < 0) { |
e43bfd9c MA |
2445 | error_prepend(errp, "Could not create temporary overlay '%s': ", |
2446 | tmp_filename); | |
1ba4b6a5 | 2447 | goto out; |
b998875d KW |
2448 | } |
2449 | ||
73176bee | 2450 | /* Prepare options QDict for the temporary file */ |
46f5ac20 EB |
2451 | qdict_put_str(snapshot_options, "file.driver", "file"); |
2452 | qdict_put_str(snapshot_options, "file.filename", tmp_filename); | |
2453 | qdict_put_str(snapshot_options, "driver", "qcow2"); | |
b998875d | 2454 | |
5b363937 | 2455 | bs_snapshot = bdrv_open(NULL, NULL, snapshot_options, flags, errp); |
73176bee | 2456 | snapshot_options = NULL; |
5b363937 | 2457 | if (!bs_snapshot) { |
1ba4b6a5 | 2458 | goto out; |
b998875d KW |
2459 | } |
2460 | ||
ff6ed714 EB |
2461 | /* bdrv_append() consumes a strong reference to bs_snapshot |
2462 | * (i.e. it will call bdrv_unref() on it) even on error, so in | |
2463 | * order to be able to return one, we have to increase | |
2464 | * bs_snapshot's refcount here */ | |
66836189 | 2465 | bdrv_ref(bs_snapshot); |
b2c2832c KW |
2466 | bdrv_append(bs_snapshot, bs, &local_err); |
2467 | if (local_err) { | |
2468 | error_propagate(errp, local_err); | |
ff6ed714 | 2469 | bs_snapshot = NULL; |
b2c2832c KW |
2470 | goto out; |
2471 | } | |
1ba4b6a5 BC |
2472 | |
2473 | out: | |
73176bee | 2474 | QDECREF(snapshot_options); |
1ba4b6a5 | 2475 | g_free(tmp_filename); |
ff6ed714 | 2476 | return bs_snapshot; |
b998875d KW |
2477 | } |
2478 | ||
b6ce07aa KW |
2479 | /* |
2480 | * Opens a disk image (raw, qcow2, vmdk, ...) | |
de9c0cec KW |
2481 | * |
2482 | * options is a QDict of options to pass to the block drivers, or NULL for an | |
2483 | * empty set of options. The reference to the QDict belongs to the block layer | |
2484 | * after the call (even on failure), so if the caller intends to reuse the | |
2485 | * dictionary, it needs to use QINCREF() before calling bdrv_open. | |
f67503e5 HR |
2486 | * |
2487 | * If *pbs is NULL, a new BDS will be created with a pointer to it stored there. | |
2488 | * If it is not NULL, the referenced BDS will be reused. | |
ddf5636d HR |
2489 | * |
2490 | * The reference parameter may be used to specify an existing block device which | |
2491 | * should be opened. If specified, neither options nor a filename may be given, | |
2492 | * nor can an existing BDS be reused (that is, *pbs has to be NULL). | |
b6ce07aa | 2493 | */ |
5b363937 HR |
2494 | static BlockDriverState *bdrv_open_inherit(const char *filename, |
2495 | const char *reference, | |
2496 | QDict *options, int flags, | |
2497 | BlockDriverState *parent, | |
2498 | const BdrvChildRole *child_role, | |
2499 | Error **errp) | |
ea2384d3 | 2500 | { |
b6ce07aa | 2501 | int ret; |
5696c6e3 | 2502 | BlockBackend *file = NULL; |
9a4f4c31 | 2503 | BlockDriverState *bs; |
ce343771 | 2504 | BlockDriver *drv = NULL; |
74fe54f2 | 2505 | const char *drvname; |
3e8c2e57 | 2506 | const char *backing; |
34b5d2c6 | 2507 | Error *local_err = NULL; |
73176bee | 2508 | QDict *snapshot_options = NULL; |
b1e6fc08 | 2509 | int snapshot_flags = 0; |
712e7874 | 2510 | |
f3930ed0 KW |
2511 | assert(!child_role || !flags); |
2512 | assert(!child_role == !parent); | |
f67503e5 | 2513 | |
ddf5636d HR |
2514 | if (reference) { |
2515 | bool options_non_empty = options ? qdict_size(options) : false; | |
2516 | QDECREF(options); | |
2517 | ||
ddf5636d HR |
2518 | if (filename || options_non_empty) { |
2519 | error_setg(errp, "Cannot reference an existing block device with " | |
2520 | "additional options or a new filename"); | |
5b363937 | 2521 | return NULL; |
ddf5636d HR |
2522 | } |
2523 | ||
2524 | bs = bdrv_lookup_bs(reference, reference, errp); | |
2525 | if (!bs) { | |
5b363937 | 2526 | return NULL; |
ddf5636d | 2527 | } |
76b22320 | 2528 | |
ddf5636d | 2529 | bdrv_ref(bs); |
5b363937 | 2530 | return bs; |
ddf5636d HR |
2531 | } |
2532 | ||
5b363937 | 2533 | bs = bdrv_new(); |
f67503e5 | 2534 | |
de9c0cec KW |
2535 | /* NULL means an empty set of options */ |
2536 | if (options == NULL) { | |
2537 | options = qdict_new(); | |
2538 | } | |
2539 | ||
145f598e | 2540 | /* json: syntax counts as explicit options, as if in the QDict */ |
de3b53f0 KW |
2541 | parse_json_protocol(options, &filename, &local_err); |
2542 | if (local_err) { | |
de3b53f0 KW |
2543 | goto fail; |
2544 | } | |
2545 | ||
145f598e KW |
2546 | bs->explicit_options = qdict_clone_shallow(options); |
2547 | ||
f3930ed0 | 2548 | if (child_role) { |
bddcec37 | 2549 | bs->inherits_from = parent; |
8e2160e2 KW |
2550 | child_role->inherit_options(&flags, options, |
2551 | parent->open_flags, parent->options); | |
f3930ed0 KW |
2552 | } |
2553 | ||
de3b53f0 | 2554 | ret = bdrv_fill_options(&options, filename, &flags, &local_err); |
462f5bcf KW |
2555 | if (local_err) { |
2556 | goto fail; | |
2557 | } | |
2558 | ||
129c7d1c MA |
2559 | /* |
2560 | * Set the BDRV_O_RDWR and BDRV_O_ALLOW_RDWR flags. | |
2561 | * Caution: getting a boolean member of @options requires care. | |
2562 | * When @options come from -blockdev or blockdev_add, members are | |
2563 | * typed according to the QAPI schema, but when they come from | |
2564 | * -drive, they're all QString. | |
2565 | */ | |
f87a0e29 AG |
2566 | if (g_strcmp0(qdict_get_try_str(options, BDRV_OPT_READ_ONLY), "on") && |
2567 | !qdict_get_try_bool(options, BDRV_OPT_READ_ONLY, false)) { | |
2568 | flags |= (BDRV_O_RDWR | BDRV_O_ALLOW_RDWR); | |
2569 | } else { | |
2570 | flags &= ~BDRV_O_RDWR; | |
14499ea5 AG |
2571 | } |
2572 | ||
2573 | if (flags & BDRV_O_SNAPSHOT) { | |
2574 | snapshot_options = qdict_new(); | |
2575 | bdrv_temp_snapshot_options(&snapshot_flags, snapshot_options, | |
2576 | flags, options); | |
f87a0e29 AG |
2577 | /* Let bdrv_backing_options() override "read-only" */ |
2578 | qdict_del(options, BDRV_OPT_READ_ONLY); | |
14499ea5 AG |
2579 | bdrv_backing_options(&flags, options, flags, options); |
2580 | } | |
2581 | ||
62392ebb KW |
2582 | bs->open_flags = flags; |
2583 | bs->options = options; | |
2584 | options = qdict_clone_shallow(options); | |
2585 | ||
76c591b0 | 2586 | /* Find the right image format driver */ |
129c7d1c | 2587 | /* See cautionary note on accessing @options above */ |
76c591b0 KW |
2588 | drvname = qdict_get_try_str(options, "driver"); |
2589 | if (drvname) { | |
2590 | drv = bdrv_find_format(drvname); | |
76c591b0 KW |
2591 | if (!drv) { |
2592 | error_setg(errp, "Unknown driver: '%s'", drvname); | |
76c591b0 KW |
2593 | goto fail; |
2594 | } | |
2595 | } | |
2596 | ||
2597 | assert(drvname || !(flags & BDRV_O_PROTOCOL)); | |
76c591b0 | 2598 | |
129c7d1c | 2599 | /* See cautionary note on accessing @options above */ |
3e8c2e57 AG |
2600 | backing = qdict_get_try_str(options, "backing"); |
2601 | if (backing && *backing == '\0') { | |
2602 | flags |= BDRV_O_NO_BACKING; | |
2603 | qdict_del(options, "backing"); | |
2604 | } | |
2605 | ||
5696c6e3 | 2606 | /* Open image file without format layer. This BlockBackend is only used for |
4e4bf5c4 KW |
2607 | * probing, the block drivers will do their own bdrv_open_child() for the |
2608 | * same BDS, which is why we put the node name back into options. */ | |
f4788adc | 2609 | if ((flags & BDRV_O_PROTOCOL) == 0) { |
5696c6e3 KW |
2610 | BlockDriverState *file_bs; |
2611 | ||
2612 | file_bs = bdrv_open_child_bs(filename, options, "file", bs, | |
2613 | &child_file, true, &local_err); | |
1fdd6933 | 2614 | if (local_err) { |
f4788adc KW |
2615 | goto fail; |
2616 | } | |
5696c6e3 | 2617 | if (file_bs != NULL) { |
dacaa162 KW |
2618 | /* Not requesting BLK_PERM_CONSISTENT_READ because we're only |
2619 | * looking at the header to guess the image format. This works even | |
2620 | * in cases where a guest would not see a consistent state. */ | |
2621 | file = blk_new(0, BLK_PERM_ALL); | |
d7086422 | 2622 | blk_insert_bs(file, file_bs, &local_err); |
5696c6e3 | 2623 | bdrv_unref(file_bs); |
d7086422 KW |
2624 | if (local_err) { |
2625 | goto fail; | |
2626 | } | |
5696c6e3 | 2627 | |
46f5ac20 | 2628 | qdict_put_str(options, "file", bdrv_get_node_name(file_bs)); |
4e4bf5c4 | 2629 | } |
f500a6d3 KW |
2630 | } |
2631 | ||
76c591b0 | 2632 | /* Image format probing */ |
38f3ef57 | 2633 | bs->probed = !drv; |
76c591b0 | 2634 | if (!drv && file) { |
cf2ab8fc | 2635 | ret = find_image_format(file, filename, &drv, &local_err); |
17b005f1 | 2636 | if (ret < 0) { |
8bfea15d | 2637 | goto fail; |
2a05cbe4 | 2638 | } |
62392ebb KW |
2639 | /* |
2640 | * This option update would logically belong in bdrv_fill_options(), | |
2641 | * but we first need to open bs->file for the probing to work, while | |
2642 | * opening bs->file already requires the (mostly) final set of options | |
2643 | * so that cache mode etc. can be inherited. | |
2644 | * | |
2645 | * Adding the driver later is somewhat ugly, but it's not an option | |
2646 | * that would ever be inherited, so it's correct. We just need to make | |
2647 | * sure to update both bs->options (which has the full effective | |
2648 | * options for bs) and options (which has file.* already removed). | |
2649 | */ | |
46f5ac20 EB |
2650 | qdict_put_str(bs->options, "driver", drv->format_name); |
2651 | qdict_put_str(options, "driver", drv->format_name); | |
76c591b0 | 2652 | } else if (!drv) { |
17b005f1 | 2653 | error_setg(errp, "Must specify either driver or file"); |
8bfea15d | 2654 | goto fail; |
ea2384d3 | 2655 | } |
b6ce07aa | 2656 | |
53a29513 HR |
2657 | /* BDRV_O_PROTOCOL must be set iff a protocol BDS is about to be created */ |
2658 | assert(!!(flags & BDRV_O_PROTOCOL) == !!drv->bdrv_file_open); | |
2659 | /* file must be NULL if a protocol BDS is about to be created | |
2660 | * (the inverse results in an error message from bdrv_open_common()) */ | |
2661 | assert(!(flags & BDRV_O_PROTOCOL) || !file); | |
2662 | ||
b6ce07aa | 2663 | /* Open the image */ |
82dc8b41 | 2664 | ret = bdrv_open_common(bs, file, options, &local_err); |
b6ce07aa | 2665 | if (ret < 0) { |
8bfea15d | 2666 | goto fail; |
6987307c CH |
2667 | } |
2668 | ||
4e4bf5c4 | 2669 | if (file) { |
5696c6e3 | 2670 | blk_unref(file); |
f500a6d3 KW |
2671 | file = NULL; |
2672 | } | |
2673 | ||
b6ce07aa | 2674 | /* If there is a backing file, use it */ |
9156df12 | 2675 | if ((flags & BDRV_O_NO_BACKING) == 0) { |
d9b7b057 | 2676 | ret = bdrv_open_backing_file(bs, options, "backing", &local_err); |
b6ce07aa | 2677 | if (ret < 0) { |
b6ad491a | 2678 | goto close_and_fail; |
b6ce07aa | 2679 | } |
b6ce07aa KW |
2680 | } |
2681 | ||
91af7014 HR |
2682 | bdrv_refresh_filename(bs); |
2683 | ||
b6ad491a | 2684 | /* Check if any unknown options were used */ |
7ad2757f | 2685 | if (qdict_size(options) != 0) { |
b6ad491a | 2686 | const QDictEntry *entry = qdict_first(options); |
5acd9d81 HR |
2687 | if (flags & BDRV_O_PROTOCOL) { |
2688 | error_setg(errp, "Block protocol '%s' doesn't support the option " | |
2689 | "'%s'", drv->format_name, entry->key); | |
2690 | } else { | |
d0e46a55 HR |
2691 | error_setg(errp, |
2692 | "Block format '%s' does not support the option '%s'", | |
2693 | drv->format_name, entry->key); | |
5acd9d81 | 2694 | } |
b6ad491a | 2695 | |
b6ad491a KW |
2696 | goto close_and_fail; |
2697 | } | |
b6ad491a | 2698 | |
c01c214b | 2699 | bdrv_parent_cb_change_media(bs, true); |
b6ce07aa | 2700 | |
c3adb58f | 2701 | QDECREF(options); |
dd62f1ca KW |
2702 | |
2703 | /* For snapshot=on, create a temporary qcow2 overlay. bs points to the | |
2704 | * temporary snapshot afterwards. */ | |
2705 | if (snapshot_flags) { | |
66836189 HR |
2706 | BlockDriverState *snapshot_bs; |
2707 | snapshot_bs = bdrv_append_temp_snapshot(bs, snapshot_flags, | |
2708 | snapshot_options, &local_err); | |
73176bee | 2709 | snapshot_options = NULL; |
dd62f1ca KW |
2710 | if (local_err) { |
2711 | goto close_and_fail; | |
2712 | } | |
5b363937 HR |
2713 | /* We are not going to return bs but the overlay on top of it |
2714 | * (snapshot_bs); thus, we have to drop the strong reference to bs | |
2715 | * (which we obtained by calling bdrv_new()). bs will not be deleted, | |
2716 | * though, because the overlay still has a reference to it. */ | |
2717 | bdrv_unref(bs); | |
2718 | bs = snapshot_bs; | |
dd62f1ca KW |
2719 | } |
2720 | ||
5b363937 | 2721 | return bs; |
b6ce07aa | 2722 | |
8bfea15d | 2723 | fail: |
5696c6e3 | 2724 | blk_unref(file); |
73176bee | 2725 | QDECREF(snapshot_options); |
145f598e | 2726 | QDECREF(bs->explicit_options); |
de9c0cec | 2727 | QDECREF(bs->options); |
b6ad491a | 2728 | QDECREF(options); |
de9c0cec | 2729 | bs->options = NULL; |
998cbd6a | 2730 | bs->explicit_options = NULL; |
5b363937 | 2731 | bdrv_unref(bs); |
621ff94d | 2732 | error_propagate(errp, local_err); |
5b363937 | 2733 | return NULL; |
de9c0cec | 2734 | |
b6ad491a | 2735 | close_and_fail: |
5b363937 | 2736 | bdrv_unref(bs); |
73176bee | 2737 | QDECREF(snapshot_options); |
b6ad491a | 2738 | QDECREF(options); |
621ff94d | 2739 | error_propagate(errp, local_err); |
5b363937 | 2740 | return NULL; |
b6ce07aa KW |
2741 | } |
2742 | ||
5b363937 HR |
2743 | BlockDriverState *bdrv_open(const char *filename, const char *reference, |
2744 | QDict *options, int flags, Error **errp) | |
f3930ed0 | 2745 | { |
5b363937 | 2746 | return bdrv_open_inherit(filename, reference, options, flags, NULL, |
ce343771 | 2747 | NULL, errp); |
f3930ed0 KW |
2748 | } |
2749 | ||
e971aa12 JC |
2750 | /* |
2751 | * Adds a BlockDriverState to a simple queue for an atomic, transactional | |
2752 | * reopen of multiple devices. | |
2753 | * | |
2754 | * bs_queue can either be an existing BlockReopenQueue that has had QSIMPLE_INIT | |
2755 | * already performed, or alternatively may be NULL a new BlockReopenQueue will | |
2756 | * be created and initialized. This newly created BlockReopenQueue should be | |
2757 | * passed back in for subsequent calls that are intended to be of the same | |
2758 | * atomic 'set'. | |
2759 | * | |
2760 | * bs is the BlockDriverState to add to the reopen queue. | |
2761 | * | |
4d2cb092 KW |
2762 | * options contains the changed options for the associated bs |
2763 | * (the BlockReopenQueue takes ownership) | |
2764 | * | |
e971aa12 JC |
2765 | * flags contains the open flags for the associated bs |
2766 | * | |
2767 | * returns a pointer to bs_queue, which is either the newly allocated | |
2768 | * bs_queue, or the existing bs_queue being used. | |
2769 | * | |
1a63a907 | 2770 | * bs must be drained between bdrv_reopen_queue() and bdrv_reopen_multiple(). |
e971aa12 | 2771 | */ |
28518102 KW |
2772 | static BlockReopenQueue *bdrv_reopen_queue_child(BlockReopenQueue *bs_queue, |
2773 | BlockDriverState *bs, | |
2774 | QDict *options, | |
2775 | int flags, | |
2776 | const BdrvChildRole *role, | |
2777 | QDict *parent_options, | |
2778 | int parent_flags) | |
e971aa12 JC |
2779 | { |
2780 | assert(bs != NULL); | |
2781 | ||
2782 | BlockReopenQueueEntry *bs_entry; | |
67251a31 | 2783 | BdrvChild *child; |
145f598e | 2784 | QDict *old_options, *explicit_options; |
67251a31 | 2785 | |
1a63a907 KW |
2786 | /* Make sure that the caller remembered to use a drained section. This is |
2787 | * important to avoid graph changes between the recursive queuing here and | |
2788 | * bdrv_reopen_multiple(). */ | |
2789 | assert(bs->quiesce_counter > 0); | |
2790 | ||
e971aa12 JC |
2791 | if (bs_queue == NULL) { |
2792 | bs_queue = g_new0(BlockReopenQueue, 1); | |
2793 | QSIMPLEQ_INIT(bs_queue); | |
2794 | } | |
2795 | ||
4d2cb092 KW |
2796 | if (!options) { |
2797 | options = qdict_new(); | |
2798 | } | |
2799 | ||
5b7ba05f AG |
2800 | /* Check if this BlockDriverState is already in the queue */ |
2801 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { | |
2802 | if (bs == bs_entry->state.bs) { | |
2803 | break; | |
2804 | } | |
2805 | } | |
2806 | ||
28518102 KW |
2807 | /* |
2808 | * Precedence of options: | |
2809 | * 1. Explicitly passed in options (highest) | |
91a097e7 | 2810 | * 2. Set in flags (only for top level) |
145f598e | 2811 | * 3. Retained from explicitly set options of bs |
8e2160e2 | 2812 | * 4. Inherited from parent node |
28518102 KW |
2813 | * 5. Retained from effective options of bs |
2814 | */ | |
2815 | ||
91a097e7 KW |
2816 | if (!parent_options) { |
2817 | /* | |
2818 | * Any setting represented by flags is always updated. If the | |
2819 | * corresponding QDict option is set, it takes precedence. Otherwise | |
2820 | * the flag is translated into a QDict option. The old setting of bs is | |
2821 | * not considered. | |
2822 | */ | |
2823 | update_options_from_flags(options, flags); | |
2824 | } | |
2825 | ||
145f598e | 2826 | /* Old explicitly set values (don't overwrite by inherited value) */ |
5b7ba05f AG |
2827 | if (bs_entry) { |
2828 | old_options = qdict_clone_shallow(bs_entry->state.explicit_options); | |
2829 | } else { | |
2830 | old_options = qdict_clone_shallow(bs->explicit_options); | |
2831 | } | |
145f598e KW |
2832 | bdrv_join_options(bs, options, old_options); |
2833 | QDECREF(old_options); | |
2834 | ||
2835 | explicit_options = qdict_clone_shallow(options); | |
2836 | ||
28518102 KW |
2837 | /* Inherit from parent node */ |
2838 | if (parent_options) { | |
2839 | assert(!flags); | |
8e2160e2 | 2840 | role->inherit_options(&flags, options, parent_flags, parent_options); |
28518102 KW |
2841 | } |
2842 | ||
2843 | /* Old values are used for options that aren't set yet */ | |
4d2cb092 | 2844 | old_options = qdict_clone_shallow(bs->options); |
cddff5ba | 2845 | bdrv_join_options(bs, options, old_options); |
4d2cb092 KW |
2846 | QDECREF(old_options); |
2847 | ||
fd452021 | 2848 | /* bdrv_open_inherit() sets and clears some additional flags internally */ |
f1f25a2e | 2849 | flags &= ~BDRV_O_PROTOCOL; |
fd452021 KW |
2850 | if (flags & BDRV_O_RDWR) { |
2851 | flags |= BDRV_O_ALLOW_RDWR; | |
2852 | } | |
f1f25a2e | 2853 | |
1857c97b KW |
2854 | if (!bs_entry) { |
2855 | bs_entry = g_new0(BlockReopenQueueEntry, 1); | |
2856 | QSIMPLEQ_INSERT_TAIL(bs_queue, bs_entry, entry); | |
2857 | } else { | |
2858 | QDECREF(bs_entry->state.options); | |
2859 | QDECREF(bs_entry->state.explicit_options); | |
2860 | } | |
2861 | ||
2862 | bs_entry->state.bs = bs; | |
2863 | bs_entry->state.options = options; | |
2864 | bs_entry->state.explicit_options = explicit_options; | |
2865 | bs_entry->state.flags = flags; | |
2866 | ||
30450259 KW |
2867 | /* This needs to be overwritten in bdrv_reopen_prepare() */ |
2868 | bs_entry->state.perm = UINT64_MAX; | |
2869 | bs_entry->state.shared_perm = 0; | |
2870 | ||
67251a31 | 2871 | QLIST_FOREACH(child, &bs->children, next) { |
4c9dfe5d KW |
2872 | QDict *new_child_options; |
2873 | char *child_key_dot; | |
67251a31 | 2874 | |
4c9dfe5d KW |
2875 | /* reopen can only change the options of block devices that were |
2876 | * implicitly created and inherited options. For other (referenced) | |
2877 | * block devices, a syntax like "backing.foo" results in an error. */ | |
67251a31 KW |
2878 | if (child->bs->inherits_from != bs) { |
2879 | continue; | |
2880 | } | |
2881 | ||
4c9dfe5d KW |
2882 | child_key_dot = g_strdup_printf("%s.", child->name); |
2883 | qdict_extract_subqdict(options, &new_child_options, child_key_dot); | |
2884 | g_free(child_key_dot); | |
2885 | ||
28518102 KW |
2886 | bdrv_reopen_queue_child(bs_queue, child->bs, new_child_options, 0, |
2887 | child->role, options, flags); | |
e971aa12 JC |
2888 | } |
2889 | ||
e971aa12 JC |
2890 | return bs_queue; |
2891 | } | |
2892 | ||
28518102 KW |
2893 | BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue, |
2894 | BlockDriverState *bs, | |
2895 | QDict *options, int flags) | |
2896 | { | |
2897 | return bdrv_reopen_queue_child(bs_queue, bs, options, flags, | |
2898 | NULL, NULL, 0); | |
2899 | } | |
2900 | ||
e971aa12 JC |
2901 | /* |
2902 | * Reopen multiple BlockDriverStates atomically & transactionally. | |
2903 | * | |
2904 | * The queue passed in (bs_queue) must have been built up previous | |
2905 | * via bdrv_reopen_queue(). | |
2906 | * | |
2907 | * Reopens all BDS specified in the queue, with the appropriate | |
2908 | * flags. All devices are prepared for reopen, and failure of any | |
2909 | * device will cause all device changes to be abandonded, and intermediate | |
2910 | * data cleaned up. | |
2911 | * | |
2912 | * If all devices prepare successfully, then the changes are committed | |
2913 | * to all devices. | |
2914 | * | |
1a63a907 KW |
2915 | * All affected nodes must be drained between bdrv_reopen_queue() and |
2916 | * bdrv_reopen_multiple(). | |
e971aa12 | 2917 | */ |
720150f3 | 2918 | int bdrv_reopen_multiple(AioContext *ctx, BlockReopenQueue *bs_queue, Error **errp) |
e971aa12 JC |
2919 | { |
2920 | int ret = -1; | |
2921 | BlockReopenQueueEntry *bs_entry, *next; | |
2922 | Error *local_err = NULL; | |
2923 | ||
2924 | assert(bs_queue != NULL); | |
2925 | ||
e971aa12 | 2926 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { |
1a63a907 | 2927 | assert(bs_entry->state.bs->quiesce_counter > 0); |
e971aa12 JC |
2928 | if (bdrv_reopen_prepare(&bs_entry->state, bs_queue, &local_err)) { |
2929 | error_propagate(errp, local_err); | |
2930 | goto cleanup; | |
2931 | } | |
2932 | bs_entry->prepared = true; | |
2933 | } | |
2934 | ||
2935 | /* If we reach this point, we have success and just need to apply the | |
2936 | * changes | |
2937 | */ | |
2938 | QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) { | |
2939 | bdrv_reopen_commit(&bs_entry->state); | |
2940 | } | |
2941 | ||
2942 | ret = 0; | |
2943 | ||
2944 | cleanup: | |
2945 | QSIMPLEQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) { | |
2946 | if (ret && bs_entry->prepared) { | |
2947 | bdrv_reopen_abort(&bs_entry->state); | |
145f598e KW |
2948 | } else if (ret) { |
2949 | QDECREF(bs_entry->state.explicit_options); | |
e971aa12 | 2950 | } |
4d2cb092 | 2951 | QDECREF(bs_entry->state.options); |
e971aa12 JC |
2952 | g_free(bs_entry); |
2953 | } | |
2954 | g_free(bs_queue); | |
40840e41 | 2955 | |
e971aa12 JC |
2956 | return ret; |
2957 | } | |
2958 | ||
2959 | ||
2960 | /* Reopen a single BlockDriverState with the specified flags. */ | |
2961 | int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp) | |
2962 | { | |
2963 | int ret = -1; | |
2964 | Error *local_err = NULL; | |
1a63a907 | 2965 | BlockReopenQueue *queue; |
e971aa12 | 2966 | |
1a63a907 KW |
2967 | bdrv_subtree_drained_begin(bs); |
2968 | ||
2969 | queue = bdrv_reopen_queue(NULL, bs, NULL, bdrv_flags); | |
720150f3 | 2970 | ret = bdrv_reopen_multiple(bdrv_get_aio_context(bs), queue, &local_err); |
e971aa12 JC |
2971 | if (local_err != NULL) { |
2972 | error_propagate(errp, local_err); | |
2973 | } | |
1a63a907 KW |
2974 | |
2975 | bdrv_subtree_drained_end(bs); | |
2976 | ||
e971aa12 JC |
2977 | return ret; |
2978 | } | |
2979 | ||
30450259 KW |
2980 | static BlockReopenQueueEntry *find_parent_in_reopen_queue(BlockReopenQueue *q, |
2981 | BdrvChild *c) | |
2982 | { | |
2983 | BlockReopenQueueEntry *entry; | |
2984 | ||
2985 | QSIMPLEQ_FOREACH(entry, q, entry) { | |
2986 | BlockDriverState *bs = entry->state.bs; | |
2987 | BdrvChild *child; | |
2988 | ||
2989 | QLIST_FOREACH(child, &bs->children, next) { | |
2990 | if (child == c) { | |
2991 | return entry; | |
2992 | } | |
2993 | } | |
2994 | } | |
2995 | ||
2996 | return NULL; | |
2997 | } | |
2998 | ||
2999 | static void bdrv_reopen_perm(BlockReopenQueue *q, BlockDriverState *bs, | |
3000 | uint64_t *perm, uint64_t *shared) | |
3001 | { | |
3002 | BdrvChild *c; | |
3003 | BlockReopenQueueEntry *parent; | |
3004 | uint64_t cumulative_perms = 0; | |
3005 | uint64_t cumulative_shared_perms = BLK_PERM_ALL; | |
3006 | ||
3007 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
3008 | parent = find_parent_in_reopen_queue(q, c); | |
3009 | if (!parent) { | |
3010 | cumulative_perms |= c->perm; | |
3011 | cumulative_shared_perms &= c->shared_perm; | |
3012 | } else { | |
3013 | uint64_t nperm, nshared; | |
3014 | ||
3015 | bdrv_child_perm(parent->state.bs, bs, c, c->role, q, | |
3016 | parent->state.perm, parent->state.shared_perm, | |
3017 | &nperm, &nshared); | |
3018 | ||
3019 | cumulative_perms |= nperm; | |
3020 | cumulative_shared_perms &= nshared; | |
3021 | } | |
3022 | } | |
3023 | *perm = cumulative_perms; | |
3024 | *shared = cumulative_shared_perms; | |
3025 | } | |
e971aa12 JC |
3026 | |
3027 | /* | |
3028 | * Prepares a BlockDriverState for reopen. All changes are staged in the | |
3029 | * 'opaque' field of the BDRVReopenState, which is used and allocated by | |
3030 | * the block driver layer .bdrv_reopen_prepare() | |
3031 | * | |
3032 | * bs is the BlockDriverState to reopen | |
3033 | * flags are the new open flags | |
3034 | * queue is the reopen queue | |
3035 | * | |
3036 | * Returns 0 on success, non-zero on error. On error errp will be set | |
3037 | * as well. | |
3038 | * | |
3039 | * On failure, bdrv_reopen_abort() will be called to clean up any data. | |
3040 | * It is the responsibility of the caller to then call the abort() or | |
3041 | * commit() for any other BDS that have been left in a prepare() state | |
3042 | * | |
3043 | */ | |
3044 | int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue, | |
3045 | Error **errp) | |
3046 | { | |
3047 | int ret = -1; | |
3048 | Error *local_err = NULL; | |
3049 | BlockDriver *drv; | |
ccf9dc07 KW |
3050 | QemuOpts *opts; |
3051 | const char *value; | |
3d8ce171 | 3052 | bool read_only; |
e971aa12 JC |
3053 | |
3054 | assert(reopen_state != NULL); | |
3055 | assert(reopen_state->bs->drv != NULL); | |
3056 | drv = reopen_state->bs->drv; | |
3057 | ||
ccf9dc07 KW |
3058 | /* Process generic block layer options */ |
3059 | opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort); | |
3060 | qemu_opts_absorb_qdict(opts, reopen_state->options, &local_err); | |
3061 | if (local_err) { | |
3062 | error_propagate(errp, local_err); | |
3063 | ret = -EINVAL; | |
3064 | goto error; | |
3065 | } | |
3066 | ||
91a097e7 KW |
3067 | update_flags_from_options(&reopen_state->flags, opts); |
3068 | ||
ccf9dc07 KW |
3069 | /* node-name and driver must be unchanged. Put them back into the QDict, so |
3070 | * that they are checked at the end of this function. */ | |
3071 | value = qemu_opt_get(opts, "node-name"); | |
3072 | if (value) { | |
46f5ac20 | 3073 | qdict_put_str(reopen_state->options, "node-name", value); |
ccf9dc07 KW |
3074 | } |
3075 | ||
3076 | value = qemu_opt_get(opts, "driver"); | |
3077 | if (value) { | |
46f5ac20 | 3078 | qdict_put_str(reopen_state->options, "driver", value); |
ccf9dc07 KW |
3079 | } |
3080 | ||
3d8ce171 JC |
3081 | /* If we are to stay read-only, do not allow permission change |
3082 | * to r/w. Attempting to set to r/w may fail if either BDRV_O_ALLOW_RDWR is | |
3083 | * not set, or if the BDS still has copy_on_read enabled */ | |
3084 | read_only = !(reopen_state->flags & BDRV_O_RDWR); | |
54a32bfe | 3085 | ret = bdrv_can_set_read_only(reopen_state->bs, read_only, true, &local_err); |
3d8ce171 JC |
3086 | if (local_err) { |
3087 | error_propagate(errp, local_err); | |
e971aa12 JC |
3088 | goto error; |
3089 | } | |
3090 | ||
30450259 KW |
3091 | /* Calculate required permissions after reopening */ |
3092 | bdrv_reopen_perm(queue, reopen_state->bs, | |
3093 | &reopen_state->perm, &reopen_state->shared_perm); | |
e971aa12 JC |
3094 | |
3095 | ret = bdrv_flush(reopen_state->bs); | |
3096 | if (ret) { | |
455b0fde | 3097 | error_setg_errno(errp, -ret, "Error flushing drive"); |
e971aa12 JC |
3098 | goto error; |
3099 | } | |
3100 | ||
3101 | if (drv->bdrv_reopen_prepare) { | |
3102 | ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err); | |
3103 | if (ret) { | |
3104 | if (local_err != NULL) { | |
3105 | error_propagate(errp, local_err); | |
3106 | } else { | |
d8b6895f LC |
3107 | error_setg(errp, "failed while preparing to reopen image '%s'", |
3108 | reopen_state->bs->filename); | |
e971aa12 JC |
3109 | } |
3110 | goto error; | |
3111 | } | |
3112 | } else { | |
3113 | /* It is currently mandatory to have a bdrv_reopen_prepare() | |
3114 | * handler for each supported drv. */ | |
81e5f78a AG |
3115 | error_setg(errp, "Block format '%s' used by node '%s' " |
3116 | "does not support reopening files", drv->format_name, | |
3117 | bdrv_get_device_or_node_name(reopen_state->bs)); | |
e971aa12 JC |
3118 | ret = -1; |
3119 | goto error; | |
3120 | } | |
3121 | ||
4d2cb092 KW |
3122 | /* Options that are not handled are only okay if they are unchanged |
3123 | * compared to the old state. It is expected that some options are only | |
3124 | * used for the initial open, but not reopen (e.g. filename) */ | |
3125 | if (qdict_size(reopen_state->options)) { | |
3126 | const QDictEntry *entry = qdict_first(reopen_state->options); | |
3127 | ||
3128 | do { | |
54fd1b0d HR |
3129 | QObject *new = entry->value; |
3130 | QObject *old = qdict_get(reopen_state->bs->options, entry->key); | |
3131 | ||
129c7d1c | 3132 | /* |
54fd1b0d HR |
3133 | * TODO: When using -drive to specify blockdev options, all values |
3134 | * will be strings; however, when using -blockdev, blockdev-add or | |
3135 | * filenames using the json:{} pseudo-protocol, they will be | |
3136 | * correctly typed. | |
3137 | * In contrast, reopening options are (currently) always strings | |
3138 | * (because you can only specify them through qemu-io; all other | |
3139 | * callers do not specify any options). | |
3140 | * Therefore, when using anything other than -drive to create a BDS, | |
3141 | * this cannot detect non-string options as unchanged, because | |
3142 | * qobject_is_equal() always returns false for objects of different | |
3143 | * type. In the future, this should be remedied by correctly typing | |
3144 | * all options. For now, this is not too big of an issue because | |
3145 | * the user can simply omit options which cannot be changed anyway, | |
3146 | * so they will stay unchanged. | |
129c7d1c | 3147 | */ |
54fd1b0d | 3148 | if (!qobject_is_equal(new, old)) { |
4d2cb092 KW |
3149 | error_setg(errp, "Cannot change the option '%s'", entry->key); |
3150 | ret = -EINVAL; | |
3151 | goto error; | |
3152 | } | |
3153 | } while ((entry = qdict_next(reopen_state->options, entry))); | |
3154 | } | |
3155 | ||
30450259 KW |
3156 | ret = bdrv_check_perm(reopen_state->bs, queue, reopen_state->perm, |
3157 | reopen_state->shared_perm, NULL, errp); | |
3158 | if (ret < 0) { | |
3159 | goto error; | |
3160 | } | |
3161 | ||
e971aa12 JC |
3162 | ret = 0; |
3163 | ||
3164 | error: | |
ccf9dc07 | 3165 | qemu_opts_del(opts); |
e971aa12 JC |
3166 | return ret; |
3167 | } | |
3168 | ||
3169 | /* | |
3170 | * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and | |
3171 | * makes them final by swapping the staging BlockDriverState contents into | |
3172 | * the active BlockDriverState contents. | |
3173 | */ | |
3174 | void bdrv_reopen_commit(BDRVReopenState *reopen_state) | |
3175 | { | |
3176 | BlockDriver *drv; | |
50bf65ba | 3177 | BlockDriverState *bs; |
cb9ff6c2 | 3178 | bool old_can_write, new_can_write; |
e971aa12 JC |
3179 | |
3180 | assert(reopen_state != NULL); | |
50bf65ba VSO |
3181 | bs = reopen_state->bs; |
3182 | drv = bs->drv; | |
e971aa12 JC |
3183 | assert(drv != NULL); |
3184 | ||
cb9ff6c2 VSO |
3185 | old_can_write = |
3186 | !bdrv_is_read_only(bs) && !(bdrv_get_flags(bs) & BDRV_O_INACTIVE); | |
3187 | ||
e971aa12 JC |
3188 | /* If there are any driver level actions to take */ |
3189 | if (drv->bdrv_reopen_commit) { | |
3190 | drv->bdrv_reopen_commit(reopen_state); | |
3191 | } | |
3192 | ||
3193 | /* set BDS specific flags now */ | |
50bf65ba | 3194 | QDECREF(bs->explicit_options); |
145f598e | 3195 | |
50bf65ba VSO |
3196 | bs->explicit_options = reopen_state->explicit_options; |
3197 | bs->open_flags = reopen_state->flags; | |
3198 | bs->read_only = !(reopen_state->flags & BDRV_O_RDWR); | |
355ef4ac | 3199 | |
50bf65ba | 3200 | bdrv_refresh_limits(bs, NULL); |
cb9ff6c2 | 3201 | |
30450259 KW |
3202 | bdrv_set_perm(reopen_state->bs, reopen_state->perm, |
3203 | reopen_state->shared_perm); | |
3204 | ||
cb9ff6c2 VSO |
3205 | new_can_write = |
3206 | !bdrv_is_read_only(bs) && !(bdrv_get_flags(bs) & BDRV_O_INACTIVE); | |
3207 | if (!old_can_write && new_can_write && drv->bdrv_reopen_bitmaps_rw) { | |
3208 | Error *local_err = NULL; | |
3209 | if (drv->bdrv_reopen_bitmaps_rw(bs, &local_err) < 0) { | |
3210 | /* This is not fatal, bitmaps just left read-only, so all following | |
3211 | * writes will fail. User can remove read-only bitmaps to unblock | |
3212 | * writes. | |
3213 | */ | |
3214 | error_reportf_err(local_err, | |
3215 | "%s: Failed to make dirty bitmaps writable: ", | |
3216 | bdrv_get_node_name(bs)); | |
3217 | } | |
3218 | } | |
e971aa12 JC |
3219 | } |
3220 | ||
3221 | /* | |
3222 | * Abort the reopen, and delete and free the staged changes in | |
3223 | * reopen_state | |
3224 | */ | |
3225 | void bdrv_reopen_abort(BDRVReopenState *reopen_state) | |
3226 | { | |
3227 | BlockDriver *drv; | |
3228 | ||
3229 | assert(reopen_state != NULL); | |
3230 | drv = reopen_state->bs->drv; | |
3231 | assert(drv != NULL); | |
3232 | ||
3233 | if (drv->bdrv_reopen_abort) { | |
3234 | drv->bdrv_reopen_abort(reopen_state); | |
3235 | } | |
145f598e KW |
3236 | |
3237 | QDECREF(reopen_state->explicit_options); | |
30450259 KW |
3238 | |
3239 | bdrv_abort_perm_update(reopen_state->bs); | |
e971aa12 JC |
3240 | } |
3241 | ||
3242 | ||
64dff520 | 3243 | static void bdrv_close(BlockDriverState *bs) |
fc01f7e7 | 3244 | { |
33384421 | 3245 | BdrvAioNotifier *ban, *ban_next; |
50a3efb0 | 3246 | BdrvChild *child, *next; |
33384421 | 3247 | |
ca9bd24c | 3248 | assert(!bs->job); |
30f55fb8 | 3249 | assert(!bs->refcnt); |
99b7e775 | 3250 | |
fc27291d | 3251 | bdrv_drained_begin(bs); /* complete I/O */ |
58fda173 | 3252 | bdrv_flush(bs); |
53ec73e2 | 3253 | bdrv_drain(bs); /* in case flush left pending I/O */ |
fc27291d | 3254 | |
3cbc002c | 3255 | if (bs->drv) { |
9a7dedbc | 3256 | bs->drv->bdrv_close(bs); |
9a4f4c31 | 3257 | bs->drv = NULL; |
50a3efb0 | 3258 | } |
9a7dedbc | 3259 | |
50a3efb0 | 3260 | bdrv_set_backing_hd(bs, NULL, &error_abort); |
9a7dedbc | 3261 | |
50a3efb0 AG |
3262 | if (bs->file != NULL) { |
3263 | bdrv_unref_child(bs, bs->file); | |
3264 | bs->file = NULL; | |
3265 | } | |
9a4f4c31 | 3266 | |
50a3efb0 AG |
3267 | QLIST_FOREACH_SAFE(child, &bs->children, next, next) { |
3268 | /* TODO Remove bdrv_unref() from drivers' close function and use | |
3269 | * bdrv_unref_child() here */ | |
3270 | if (child->bs->inherits_from == bs) { | |
3271 | child->bs->inherits_from = NULL; | |
6e93e7c4 | 3272 | } |
50a3efb0 | 3273 | bdrv_detach_child(child); |
b338082b | 3274 | } |
98f90dba | 3275 | |
50a3efb0 AG |
3276 | g_free(bs->opaque); |
3277 | bs->opaque = NULL; | |
3278 | atomic_set(&bs->copy_on_read, 0); | |
3279 | bs->backing_file[0] = '\0'; | |
3280 | bs->backing_format[0] = '\0'; | |
3281 | bs->total_sectors = 0; | |
3282 | bs->encrypted = false; | |
3283 | bs->sg = false; | |
3284 | QDECREF(bs->options); | |
3285 | QDECREF(bs->explicit_options); | |
3286 | bs->options = NULL; | |
3287 | bs->explicit_options = NULL; | |
3288 | QDECREF(bs->full_open_options); | |
3289 | bs->full_open_options = NULL; | |
3290 | ||
cca43ae1 VSO |
3291 | bdrv_release_named_dirty_bitmaps(bs); |
3292 | assert(QLIST_EMPTY(&bs->dirty_bitmaps)); | |
3293 | ||
33384421 HR |
3294 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { |
3295 | g_free(ban); | |
3296 | } | |
3297 | QLIST_INIT(&bs->aio_notifiers); | |
fc27291d | 3298 | bdrv_drained_end(bs); |
b338082b FB |
3299 | } |
3300 | ||
2bc93fed MK |
3301 | void bdrv_close_all(void) |
3302 | { | |
a1a2af07 | 3303 | block_job_cancel_sync_all(); |
cd7fca95 | 3304 | nbd_export_close_all(); |
ca9bd24c HR |
3305 | |
3306 | /* Drop references from requests still in flight, such as canceled block | |
3307 | * jobs whose AIO context has not been polled yet */ | |
3308 | bdrv_drain_all(); | |
2bc93fed | 3309 | |
ca9bd24c HR |
3310 | blk_remove_all_bs(); |
3311 | blockdev_close_all_bdrv_states(); | |
ed78cda3 | 3312 | |
a1a2af07 | 3313 | assert(QTAILQ_EMPTY(&all_bdrv_states)); |
2bc93fed MK |
3314 | } |
3315 | ||
d0ac0380 KW |
3316 | static bool should_update_child(BdrvChild *c, BlockDriverState *to) |
3317 | { | |
3318 | BdrvChild *to_c; | |
3319 | ||
3320 | if (c->role->stay_at_node) { | |
3321 | return false; | |
3322 | } | |
3323 | ||
3324 | if (c->role == &child_backing) { | |
3325 | /* If @from is a backing file of @to, ignore the child to avoid | |
3326 | * creating a loop. We only want to change the pointer of other | |
3327 | * parents. */ | |
3328 | QLIST_FOREACH(to_c, &to->children, next) { | |
3329 | if (to_c == c) { | |
3330 | break; | |
3331 | } | |
3332 | } | |
3333 | if (to_c) { | |
3334 | return false; | |
3335 | } | |
3336 | } | |
3337 | ||
3338 | return true; | |
3339 | } | |
3340 | ||
5fe31c25 KW |
3341 | void bdrv_replace_node(BlockDriverState *from, BlockDriverState *to, |
3342 | Error **errp) | |
dd62f1ca | 3343 | { |
d0ac0380 | 3344 | BdrvChild *c, *next; |
234ac1a9 KW |
3345 | GSList *list = NULL, *p; |
3346 | uint64_t old_perm, old_shared; | |
3347 | uint64_t perm = 0, shared = BLK_PERM_ALL; | |
3348 | int ret; | |
3349 | ||
5fe31c25 KW |
3350 | assert(!atomic_read(&from->in_flight)); |
3351 | assert(!atomic_read(&to->in_flight)); | |
dd62f1ca | 3352 | |
234ac1a9 KW |
3353 | /* Make sure that @from doesn't go away until we have successfully attached |
3354 | * all of its parents to @to. */ | |
3355 | bdrv_ref(from); | |
dd62f1ca | 3356 | |
234ac1a9 | 3357 | /* Put all parents into @list and calculate their cumulative permissions */ |
dd62f1ca | 3358 | QLIST_FOREACH_SAFE(c, &from->parents, next_parent, next) { |
d0ac0380 | 3359 | if (!should_update_child(c, to)) { |
26de9438 KW |
3360 | continue; |
3361 | } | |
234ac1a9 KW |
3362 | list = g_slist_prepend(list, c); |
3363 | perm |= c->perm; | |
3364 | shared &= c->shared_perm; | |
3365 | } | |
3366 | ||
3367 | /* Check whether the required permissions can be granted on @to, ignoring | |
3368 | * all BdrvChild in @list so that they can't block themselves. */ | |
3121fb45 | 3369 | ret = bdrv_check_update_perm(to, NULL, perm, shared, list, errp); |
234ac1a9 KW |
3370 | if (ret < 0) { |
3371 | bdrv_abort_perm_update(to); | |
3372 | goto out; | |
3373 | } | |
3374 | ||
3375 | /* Now actually perform the change. We performed the permission check for | |
3376 | * all elements of @list at once, so set the permissions all at once at the | |
3377 | * very end. */ | |
3378 | for (p = list; p != NULL; p = p->next) { | |
3379 | c = p->data; | |
9bd910e2 | 3380 | |
dd62f1ca | 3381 | bdrv_ref(to); |
234ac1a9 | 3382 | bdrv_replace_child_noperm(c, to); |
dd62f1ca KW |
3383 | bdrv_unref(from); |
3384 | } | |
234ac1a9 KW |
3385 | |
3386 | bdrv_get_cumulative_perm(to, &old_perm, &old_shared); | |
3387 | bdrv_set_perm(to, old_perm | perm, old_shared | shared); | |
3388 | ||
3389 | out: | |
3390 | g_slist_free(list); | |
3391 | bdrv_unref(from); | |
dd62f1ca KW |
3392 | } |
3393 | ||
4ddc07ca PB |
3394 | /* |
3395 | * Add new bs contents at the top of an image chain while the chain is | |
3396 | * live, while keeping required fields on the top layer. | |
3397 | * | |
3398 | * This will modify the BlockDriverState fields, and swap contents | |
3399 | * between bs_new and bs_top. Both bs_new and bs_top are modified. | |
3400 | * | |
bfb197e0 | 3401 | * bs_new must not be attached to a BlockBackend. |
4ddc07ca PB |
3402 | * |
3403 | * This function does not create any image files. | |
dd62f1ca KW |
3404 | * |
3405 | * bdrv_append() takes ownership of a bs_new reference and unrefs it because | |
3406 | * that's what the callers commonly need. bs_new will be referenced by the old | |
3407 | * parents of bs_top after bdrv_append() returns. If the caller needs to keep a | |
3408 | * reference of its own, it must call bdrv_ref(). | |
4ddc07ca | 3409 | */ |
b2c2832c KW |
3410 | void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top, |
3411 | Error **errp) | |
4ddc07ca | 3412 | { |
b2c2832c KW |
3413 | Error *local_err = NULL; |
3414 | ||
b2c2832c KW |
3415 | bdrv_set_backing_hd(bs_new, bs_top, &local_err); |
3416 | if (local_err) { | |
3417 | error_propagate(errp, local_err); | |
3418 | goto out; | |
3419 | } | |
dd62f1ca | 3420 | |
5fe31c25 | 3421 | bdrv_replace_node(bs_top, bs_new, &local_err); |
234ac1a9 KW |
3422 | if (local_err) { |
3423 | error_propagate(errp, local_err); | |
3424 | bdrv_set_backing_hd(bs_new, NULL, &error_abort); | |
3425 | goto out; | |
3426 | } | |
4ddc07ca | 3427 | |
dd62f1ca KW |
3428 | /* bs_new is now referenced by its new parents, we don't need the |
3429 | * additional reference any more. */ | |
b2c2832c | 3430 | out: |
dd62f1ca | 3431 | bdrv_unref(bs_new); |
8802d1fd JC |
3432 | } |
3433 | ||
4f6fd349 | 3434 | static void bdrv_delete(BlockDriverState *bs) |
b338082b | 3435 | { |
3e914655 | 3436 | assert(!bs->job); |
3718d8ab | 3437 | assert(bdrv_op_blocker_is_empty(bs)); |
4f6fd349 | 3438 | assert(!bs->refcnt); |
18846dee | 3439 | |
e1b5c52e SH |
3440 | bdrv_close(bs); |
3441 | ||
1b7bdbc1 | 3442 | /* remove from list, if necessary */ |
63eaaae0 KW |
3443 | if (bs->node_name[0] != '\0') { |
3444 | QTAILQ_REMOVE(&graph_bdrv_states, bs, node_list); | |
3445 | } | |
2c1d04e0 HR |
3446 | QTAILQ_REMOVE(&all_bdrv_states, bs, bs_list); |
3447 | ||
7267c094 | 3448 | g_free(bs); |
fc01f7e7 FB |
3449 | } |
3450 | ||
e97fc193 AL |
3451 | /* |
3452 | * Run consistency checks on an image | |
3453 | * | |
e076f338 | 3454 | * Returns 0 if the check could be completed (it doesn't mean that the image is |
a1c7273b | 3455 | * free of errors) or -errno when an internal error occurred. The results of the |
e076f338 | 3456 | * check are stored in res. |
e97fc193 | 3457 | */ |
4534ff54 | 3458 | int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix) |
e97fc193 | 3459 | { |
908bcd54 HR |
3460 | if (bs->drv == NULL) { |
3461 | return -ENOMEDIUM; | |
3462 | } | |
e97fc193 AL |
3463 | if (bs->drv->bdrv_check == NULL) { |
3464 | return -ENOTSUP; | |
3465 | } | |
3466 | ||
e076f338 | 3467 | memset(res, 0, sizeof(*res)); |
4534ff54 | 3468 | return bs->drv->bdrv_check(bs, res, fix); |
e97fc193 AL |
3469 | } |
3470 | ||
756e6736 KW |
3471 | /* |
3472 | * Return values: | |
3473 | * 0 - success | |
3474 | * -EINVAL - backing format specified, but no file | |
3475 | * -ENOSPC - can't update the backing file because no space is left in the | |
3476 | * image file header | |
3477 | * -ENOTSUP - format driver doesn't support changing the backing file | |
3478 | */ | |
3479 | int bdrv_change_backing_file(BlockDriverState *bs, | |
3480 | const char *backing_file, const char *backing_fmt) | |
3481 | { | |
3482 | BlockDriver *drv = bs->drv; | |
469ef350 | 3483 | int ret; |
756e6736 | 3484 | |
d470ad42 HR |
3485 | if (!drv) { |
3486 | return -ENOMEDIUM; | |
3487 | } | |
3488 | ||
5f377794 PB |
3489 | /* Backing file format doesn't make sense without a backing file */ |
3490 | if (backing_fmt && !backing_file) { | |
3491 | return -EINVAL; | |
3492 | } | |
3493 | ||
756e6736 | 3494 | if (drv->bdrv_change_backing_file != NULL) { |
469ef350 | 3495 | ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt); |
756e6736 | 3496 | } else { |
469ef350 | 3497 | ret = -ENOTSUP; |
756e6736 | 3498 | } |
469ef350 PB |
3499 | |
3500 | if (ret == 0) { | |
3501 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: ""); | |
3502 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: ""); | |
3503 | } | |
3504 | return ret; | |
756e6736 KW |
3505 | } |
3506 | ||
6ebdcee2 JC |
3507 | /* |
3508 | * Finds the image layer in the chain that has 'bs' as its backing file. | |
3509 | * | |
3510 | * active is the current topmost image. | |
3511 | * | |
3512 | * Returns NULL if bs is not found in active's image chain, | |
3513 | * or if active == bs. | |
4caf0fcd JC |
3514 | * |
3515 | * Returns the bottommost base image if bs == NULL. | |
6ebdcee2 JC |
3516 | */ |
3517 | BlockDriverState *bdrv_find_overlay(BlockDriverState *active, | |
3518 | BlockDriverState *bs) | |
3519 | { | |
760e0063 KW |
3520 | while (active && bs != backing_bs(active)) { |
3521 | active = backing_bs(active); | |
6ebdcee2 JC |
3522 | } |
3523 | ||
4caf0fcd JC |
3524 | return active; |
3525 | } | |
6ebdcee2 | 3526 | |
4caf0fcd JC |
3527 | /* Given a BDS, searches for the base layer. */ |
3528 | BlockDriverState *bdrv_find_base(BlockDriverState *bs) | |
3529 | { | |
3530 | return bdrv_find_overlay(bs, NULL); | |
6ebdcee2 JC |
3531 | } |
3532 | ||
6ebdcee2 JC |
3533 | /* |
3534 | * Drops images above 'base' up to and including 'top', and sets the image | |
3535 | * above 'top' to have base as its backing file. | |
3536 | * | |
3537 | * Requires that the overlay to 'top' is opened r/w, so that the backing file | |
3538 | * information in 'bs' can be properly updated. | |
3539 | * | |
3540 | * E.g., this will convert the following chain: | |
3541 | * bottom <- base <- intermediate <- top <- active | |
3542 | * | |
3543 | * to | |
3544 | * | |
3545 | * bottom <- base <- active | |
3546 | * | |
3547 | * It is allowed for bottom==base, in which case it converts: | |
3548 | * | |
3549 | * base <- intermediate <- top <- active | |
3550 | * | |
3551 | * to | |
3552 | * | |
3553 | * base <- active | |
3554 | * | |
54e26900 JC |
3555 | * If backing_file_str is non-NULL, it will be used when modifying top's |
3556 | * overlay image metadata. | |
3557 | * | |
6ebdcee2 JC |
3558 | * Error conditions: |
3559 | * if active == top, that is considered an error | |
3560 | * | |
3561 | */ | |
bde70715 KW |
3562 | int bdrv_drop_intermediate(BlockDriverState *top, BlockDriverState *base, |
3563 | const char *backing_file_str) | |
6ebdcee2 | 3564 | { |
61f09cea | 3565 | BdrvChild *c, *next; |
12fa4af6 | 3566 | Error *local_err = NULL; |
6ebdcee2 JC |
3567 | int ret = -EIO; |
3568 | ||
6858eba0 KW |
3569 | bdrv_ref(top); |
3570 | ||
6ebdcee2 JC |
3571 | if (!top->drv || !base->drv) { |
3572 | goto exit; | |
3573 | } | |
3574 | ||
5db15a57 KW |
3575 | /* Make sure that base is in the backing chain of top */ |
3576 | if (!bdrv_chain_contains(top, base)) { | |
6ebdcee2 JC |
3577 | goto exit; |
3578 | } | |
3579 | ||
3580 | /* success - we can delete the intermediate states, and link top->base */ | |
bde70715 KW |
3581 | /* TODO Check graph modification op blockers (BLK_PERM_GRAPH_MOD) once |
3582 | * we've figured out how they should work. */ | |
61f09cea KW |
3583 | backing_file_str = backing_file_str ? backing_file_str : base->filename; |
3584 | ||
3585 | QLIST_FOREACH_SAFE(c, &top->parents, next_parent, next) { | |
3586 | /* Check whether we are allowed to switch c from top to base */ | |
3587 | GSList *ignore_children = g_slist_prepend(NULL, c); | |
3588 | bdrv_check_update_perm(base, NULL, c->perm, c->shared_perm, | |
3589 | ignore_children, &local_err); | |
3590 | if (local_err) { | |
3591 | ret = -EPERM; | |
3592 | error_report_err(local_err); | |
6858eba0 KW |
3593 | goto exit; |
3594 | } | |
61f09cea | 3595 | g_slist_free(ignore_children); |
12fa4af6 | 3596 | |
61f09cea KW |
3597 | /* If so, update the backing file path in the image file */ |
3598 | if (c->role->update_filename) { | |
3599 | ret = c->role->update_filename(c, base, backing_file_str, | |
3600 | &local_err); | |
3601 | if (ret < 0) { | |
3602 | bdrv_abort_perm_update(base); | |
3603 | error_report_err(local_err); | |
3604 | goto exit; | |
3605 | } | |
3606 | } | |
3607 | ||
3608 | /* Do the actual switch in the in-memory graph. | |
3609 | * Completes bdrv_check_update_perm() transaction internally. */ | |
3610 | bdrv_ref(base); | |
3611 | bdrv_replace_child(c, base); | |
3612 | bdrv_unref(top); | |
12fa4af6 | 3613 | } |
6ebdcee2 | 3614 | |
6ebdcee2 | 3615 | ret = 0; |
6ebdcee2 | 3616 | exit: |
6858eba0 | 3617 | bdrv_unref(top); |
6ebdcee2 JC |
3618 | return ret; |
3619 | } | |
3620 | ||
61007b31 SH |
3621 | /** |
3622 | * Truncate file to 'offset' bytes (needed only for file protocols) | |
3623 | */ | |
7ea37c30 HR |
3624 | int bdrv_truncate(BdrvChild *child, int64_t offset, PreallocMode prealloc, |
3625 | Error **errp) | |
71d0770c | 3626 | { |
52cdbc58 | 3627 | BlockDriverState *bs = child->bs; |
61007b31 SH |
3628 | BlockDriver *drv = bs->drv; |
3629 | int ret; | |
c8f6d58e | 3630 | |
362b3786 | 3631 | assert(child->perm & BLK_PERM_RESIZE); |
c8f6d58e | 3632 | |
5a612c00 | 3633 | /* if bs->drv == NULL, bs is closed, so there's nothing to do here */ |
ed3d2ec9 HR |
3634 | if (!drv) { |
3635 | error_setg(errp, "No medium inserted"); | |
71d0770c | 3636 | return -ENOMEDIUM; |
ed3d2ec9 HR |
3637 | } |
3638 | if (!drv->bdrv_truncate) { | |
5a612c00 MP |
3639 | if (bs->file && drv->is_filter) { |
3640 | return bdrv_truncate(bs->file, offset, prealloc, errp); | |
3641 | } | |
ed3d2ec9 | 3642 | error_setg(errp, "Image format driver does not support resize"); |
61007b31 | 3643 | return -ENOTSUP; |
ed3d2ec9 HR |
3644 | } |
3645 | if (bs->read_only) { | |
3646 | error_setg(errp, "Image is read-only"); | |
61007b31 | 3647 | return -EACCES; |
ed3d2ec9 | 3648 | } |
71d0770c | 3649 | |
504c205a DL |
3650 | assert(!(bs->open_flags & BDRV_O_INACTIVE)); |
3651 | ||
7ea37c30 | 3652 | ret = drv->bdrv_truncate(bs, offset, prealloc, errp); |
1b6cc579 EB |
3653 | if (ret < 0) { |
3654 | return ret; | |
3655 | } | |
3656 | ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS); | |
3657 | if (ret < 0) { | |
3658 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); | |
3659 | } else { | |
3660 | offset = bs->total_sectors * BDRV_SECTOR_SIZE; | |
c0191e76 | 3661 | } |
1b6cc579 EB |
3662 | bdrv_dirty_bitmap_truncate(bs, offset); |
3663 | bdrv_parent_cb_resize(bs); | |
3664 | atomic_inc(&bs->write_gen); | |
61007b31 | 3665 | return ret; |
71d0770c AL |
3666 | } |
3667 | ||
61007b31 SH |
3668 | /** |
3669 | * Length of a allocated file in bytes. Sparse files are counted by actual | |
3670 | * allocated space. Return < 0 if error or unknown. | |
3671 | */ | |
3672 | int64_t bdrv_get_allocated_file_size(BlockDriverState *bs) | |
71d0770c | 3673 | { |
61007b31 SH |
3674 | BlockDriver *drv = bs->drv; |
3675 | if (!drv) { | |
3676 | return -ENOMEDIUM; | |
8f4754ed | 3677 | } |
61007b31 SH |
3678 | if (drv->bdrv_get_allocated_file_size) { |
3679 | return drv->bdrv_get_allocated_file_size(bs); | |
3680 | } | |
3681 | if (bs->file) { | |
9a4f4c31 | 3682 | return bdrv_get_allocated_file_size(bs->file->bs); |
1c9805a3 | 3683 | } |
61007b31 | 3684 | return -ENOTSUP; |
1c9805a3 | 3685 | } |
e7a8a783 | 3686 | |
90880ff1 SH |
3687 | /* |
3688 | * bdrv_measure: | |
3689 | * @drv: Format driver | |
3690 | * @opts: Creation options for new image | |
3691 | * @in_bs: Existing image containing data for new image (may be NULL) | |
3692 | * @errp: Error object | |
3693 | * Returns: A #BlockMeasureInfo (free using qapi_free_BlockMeasureInfo()) | |
3694 | * or NULL on error | |
3695 | * | |
3696 | * Calculate file size required to create a new image. | |
3697 | * | |
3698 | * If @in_bs is given then space for allocated clusters and zero clusters | |
3699 | * from that image are included in the calculation. If @opts contains a | |
3700 | * backing file that is shared by @in_bs then backing clusters may be omitted | |
3701 | * from the calculation. | |
3702 | * | |
3703 | * If @in_bs is NULL then the calculation includes no allocated clusters | |
3704 | * unless a preallocation option is given in @opts. | |
3705 | * | |
3706 | * Note that @in_bs may use a different BlockDriver from @drv. | |
3707 | * | |
3708 | * If an error occurs the @errp pointer is set. | |
3709 | */ | |
3710 | BlockMeasureInfo *bdrv_measure(BlockDriver *drv, QemuOpts *opts, | |
3711 | BlockDriverState *in_bs, Error **errp) | |
3712 | { | |
3713 | if (!drv->bdrv_measure) { | |
3714 | error_setg(errp, "Block driver '%s' does not support size measurement", | |
3715 | drv->format_name); | |
3716 | return NULL; | |
3717 | } | |
3718 | ||
3719 | return drv->bdrv_measure(opts, in_bs, errp); | |
3720 | } | |
3721 | ||
61007b31 SH |
3722 | /** |
3723 | * Return number of sectors on success, -errno on error. | |
1c9805a3 | 3724 | */ |
61007b31 | 3725 | int64_t bdrv_nb_sectors(BlockDriverState *bs) |
1c9805a3 | 3726 | { |
61007b31 | 3727 | BlockDriver *drv = bs->drv; |
498e386c | 3728 | |
61007b31 SH |
3729 | if (!drv) |
3730 | return -ENOMEDIUM; | |
2572b37a | 3731 | |
61007b31 SH |
3732 | if (drv->has_variable_length) { |
3733 | int ret = refresh_total_sectors(bs, bs->total_sectors); | |
3734 | if (ret < 0) { | |
3735 | return ret; | |
1c9805a3 SH |
3736 | } |
3737 | } | |
61007b31 | 3738 | return bs->total_sectors; |
1c9805a3 | 3739 | } |
b338082b | 3740 | |
61007b31 SH |
3741 | /** |
3742 | * Return length in bytes on success, -errno on error. | |
3743 | * The length is always a multiple of BDRV_SECTOR_SIZE. | |
8d3b1a2d | 3744 | */ |
61007b31 | 3745 | int64_t bdrv_getlength(BlockDriverState *bs) |
8d3b1a2d | 3746 | { |
61007b31 | 3747 | int64_t ret = bdrv_nb_sectors(bs); |
8d3b1a2d | 3748 | |
4a9c9ea0 | 3749 | ret = ret > INT64_MAX / BDRV_SECTOR_SIZE ? -EFBIG : ret; |
61007b31 | 3750 | return ret < 0 ? ret : ret * BDRV_SECTOR_SIZE; |
fc01f7e7 FB |
3751 | } |
3752 | ||
61007b31 SH |
3753 | /* return 0 as number of sectors if no device present or error */ |
3754 | void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr) | |
07d27a44 | 3755 | { |
61007b31 | 3756 | int64_t nb_sectors = bdrv_nb_sectors(bs); |
07d27a44 | 3757 | |
61007b31 | 3758 | *nb_sectors_ptr = nb_sectors < 0 ? 0 : nb_sectors; |
07d27a44 MA |
3759 | } |
3760 | ||
54115412 | 3761 | bool bdrv_is_sg(BlockDriverState *bs) |
f08145fe | 3762 | { |
61007b31 | 3763 | return bs->sg; |
f08145fe KW |
3764 | } |
3765 | ||
54115412 | 3766 | bool bdrv_is_encrypted(BlockDriverState *bs) |
fc3959e4 | 3767 | { |
760e0063 | 3768 | if (bs->backing && bs->backing->bs->encrypted) { |
54115412 | 3769 | return true; |
760e0063 | 3770 | } |
61007b31 | 3771 | return bs->encrypted; |
fc3959e4 FZ |
3772 | } |
3773 | ||
61007b31 | 3774 | const char *bdrv_get_format_name(BlockDriverState *bs) |
40b4f539 | 3775 | { |
61007b31 | 3776 | return bs->drv ? bs->drv->format_name : NULL; |
40b4f539 KW |
3777 | } |
3778 | ||
61007b31 | 3779 | static int qsort_strcmp(const void *a, const void *b) |
40b4f539 | 3780 | { |
ceff5bd7 | 3781 | return strcmp(*(char *const *)a, *(char *const *)b); |
40b4f539 KW |
3782 | } |
3783 | ||
61007b31 SH |
3784 | void bdrv_iterate_format(void (*it)(void *opaque, const char *name), |
3785 | void *opaque) | |
40b4f539 | 3786 | { |
61007b31 SH |
3787 | BlockDriver *drv; |
3788 | int count = 0; | |
3789 | int i; | |
3790 | const char **formats = NULL; | |
40b4f539 | 3791 | |
61007b31 SH |
3792 | QLIST_FOREACH(drv, &bdrv_drivers, list) { |
3793 | if (drv->format_name) { | |
3794 | bool found = false; | |
3795 | int i = count; | |
3796 | while (formats && i && !found) { | |
3797 | found = !strcmp(formats[--i], drv->format_name); | |
3798 | } | |
e2a305fb | 3799 | |
61007b31 SH |
3800 | if (!found) { |
3801 | formats = g_renew(const char *, formats, count + 1); | |
3802 | formats[count++] = drv->format_name; | |
3803 | } | |
6c5a42ac | 3804 | } |
61007b31 | 3805 | } |
6c5a42ac | 3806 | |
eb0df69f HR |
3807 | for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); i++) { |
3808 | const char *format_name = block_driver_modules[i].format_name; | |
3809 | ||
3810 | if (format_name) { | |
3811 | bool found = false; | |
3812 | int j = count; | |
3813 | ||
3814 | while (formats && j && !found) { | |
3815 | found = !strcmp(formats[--j], format_name); | |
3816 | } | |
3817 | ||
3818 | if (!found) { | |
3819 | formats = g_renew(const char *, formats, count + 1); | |
3820 | formats[count++] = format_name; | |
3821 | } | |
3822 | } | |
3823 | } | |
3824 | ||
61007b31 | 3825 | qsort(formats, count, sizeof(formats[0]), qsort_strcmp); |
40b4f539 | 3826 | |
61007b31 SH |
3827 | for (i = 0; i < count; i++) { |
3828 | it(opaque, formats[i]); | |
3829 | } | |
40b4f539 | 3830 | |
61007b31 SH |
3831 | g_free(formats); |
3832 | } | |
40b4f539 | 3833 | |
61007b31 SH |
3834 | /* This function is to find a node in the bs graph */ |
3835 | BlockDriverState *bdrv_find_node(const char *node_name) | |
3836 | { | |
3837 | BlockDriverState *bs; | |
391827eb | 3838 | |
61007b31 | 3839 | assert(node_name); |
40b4f539 | 3840 | |
61007b31 SH |
3841 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { |
3842 | if (!strcmp(node_name, bs->node_name)) { | |
3843 | return bs; | |
40b4f539 KW |
3844 | } |
3845 | } | |
61007b31 | 3846 | return NULL; |
40b4f539 KW |
3847 | } |
3848 | ||
61007b31 SH |
3849 | /* Put this QMP function here so it can access the static graph_bdrv_states. */ |
3850 | BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp) | |
40b4f539 | 3851 | { |
61007b31 SH |
3852 | BlockDeviceInfoList *list, *entry; |
3853 | BlockDriverState *bs; | |
40b4f539 | 3854 | |
61007b31 SH |
3855 | list = NULL; |
3856 | QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) { | |
c83f9fba | 3857 | BlockDeviceInfo *info = bdrv_block_device_info(NULL, bs, errp); |
61007b31 SH |
3858 | if (!info) { |
3859 | qapi_free_BlockDeviceInfoList(list); | |
3860 | return NULL; | |
301db7c2 | 3861 | } |
61007b31 SH |
3862 | entry = g_malloc0(sizeof(*entry)); |
3863 | entry->value = info; | |
3864 | entry->next = list; | |
3865 | list = entry; | |
301db7c2 RH |
3866 | } |
3867 | ||
61007b31 SH |
3868 | return list; |
3869 | } | |
40b4f539 | 3870 | |
61007b31 SH |
3871 | BlockDriverState *bdrv_lookup_bs(const char *device, |
3872 | const char *node_name, | |
3873 | Error **errp) | |
3874 | { | |
3875 | BlockBackend *blk; | |
3876 | BlockDriverState *bs; | |
40b4f539 | 3877 | |
61007b31 SH |
3878 | if (device) { |
3879 | blk = blk_by_name(device); | |
40b4f539 | 3880 | |
61007b31 | 3881 | if (blk) { |
9f4ed6fb AG |
3882 | bs = blk_bs(blk); |
3883 | if (!bs) { | |
5433c24f | 3884 | error_setg(errp, "Device '%s' has no medium", device); |
5433c24f HR |
3885 | } |
3886 | ||
9f4ed6fb | 3887 | return bs; |
61007b31 SH |
3888 | } |
3889 | } | |
40b4f539 | 3890 | |
61007b31 SH |
3891 | if (node_name) { |
3892 | bs = bdrv_find_node(node_name); | |
6d519a5f | 3893 | |
61007b31 SH |
3894 | if (bs) { |
3895 | return bs; | |
3896 | } | |
40b4f539 KW |
3897 | } |
3898 | ||
61007b31 SH |
3899 | error_setg(errp, "Cannot find device=%s nor node_name=%s", |
3900 | device ? device : "", | |
3901 | node_name ? node_name : ""); | |
3902 | return NULL; | |
40b4f539 KW |
3903 | } |
3904 | ||
61007b31 SH |
3905 | /* If 'base' is in the same chain as 'top', return true. Otherwise, |
3906 | * return false. If either argument is NULL, return false. */ | |
3907 | bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base) | |
83f64091 | 3908 | { |
61007b31 | 3909 | while (top && top != base) { |
760e0063 | 3910 | top = backing_bs(top); |
02c50efe | 3911 | } |
61007b31 SH |
3912 | |
3913 | return top != NULL; | |
02c50efe FZ |
3914 | } |
3915 | ||
61007b31 | 3916 | BlockDriverState *bdrv_next_node(BlockDriverState *bs) |
02c50efe | 3917 | { |
61007b31 SH |
3918 | if (!bs) { |
3919 | return QTAILQ_FIRST(&graph_bdrv_states); | |
02c50efe | 3920 | } |
61007b31 | 3921 | return QTAILQ_NEXT(bs, node_list); |
83f64091 FB |
3922 | } |
3923 | ||
61007b31 | 3924 | const char *bdrv_get_node_name(const BlockDriverState *bs) |
83f64091 | 3925 | { |
61007b31 | 3926 | return bs->node_name; |
beac80cd FB |
3927 | } |
3928 | ||
1f0c461b | 3929 | const char *bdrv_get_parent_name(const BlockDriverState *bs) |
4c265bf9 KW |
3930 | { |
3931 | BdrvChild *c; | |
3932 | const char *name; | |
3933 | ||
3934 | /* If multiple parents have a name, just pick the first one. */ | |
3935 | QLIST_FOREACH(c, &bs->parents, next_parent) { | |
3936 | if (c->role->get_name) { | |
3937 | name = c->role->get_name(c); | |
3938 | if (name && *name) { | |
3939 | return name; | |
3940 | } | |
3941 | } | |
3942 | } | |
3943 | ||
3944 | return NULL; | |
3945 | } | |
3946 | ||
61007b31 SH |
3947 | /* TODO check what callers really want: bs->node_name or blk_name() */ |
3948 | const char *bdrv_get_device_name(const BlockDriverState *bs) | |
beac80cd | 3949 | { |
4c265bf9 | 3950 | return bdrv_get_parent_name(bs) ?: ""; |
f141eafe | 3951 | } |
83f64091 | 3952 | |
61007b31 SH |
3953 | /* This can be used to identify nodes that might not have a device |
3954 | * name associated. Since node and device names live in the same | |
3955 | * namespace, the result is unambiguous. The exception is if both are | |
3956 | * absent, then this returns an empty (non-null) string. */ | |
3957 | const char *bdrv_get_device_or_node_name(const BlockDriverState *bs) | |
f141eafe | 3958 | { |
4c265bf9 | 3959 | return bdrv_get_parent_name(bs) ?: bs->node_name; |
beac80cd | 3960 | } |
beac80cd | 3961 | |
61007b31 | 3962 | int bdrv_get_flags(BlockDriverState *bs) |
0b5a2445 | 3963 | { |
61007b31 | 3964 | return bs->open_flags; |
0b5a2445 PB |
3965 | } |
3966 | ||
61007b31 | 3967 | int bdrv_has_zero_init_1(BlockDriverState *bs) |
68485420 | 3968 | { |
61007b31 | 3969 | return 1; |
0b5a2445 PB |
3970 | } |
3971 | ||
61007b31 | 3972 | int bdrv_has_zero_init(BlockDriverState *bs) |
0b5a2445 | 3973 | { |
d470ad42 HR |
3974 | if (!bs->drv) { |
3975 | return 0; | |
3976 | } | |
0b5a2445 | 3977 | |
61007b31 SH |
3978 | /* If BS is a copy on write image, it is initialized to |
3979 | the contents of the base image, which may not be zeroes. */ | |
760e0063 | 3980 | if (bs->backing) { |
61007b31 SH |
3981 | return 0; |
3982 | } | |
3983 | if (bs->drv->bdrv_has_zero_init) { | |
3984 | return bs->drv->bdrv_has_zero_init(bs); | |
0b5a2445 | 3985 | } |
5a612c00 MP |
3986 | if (bs->file && bs->drv->is_filter) { |
3987 | return bdrv_has_zero_init(bs->file->bs); | |
3988 | } | |
61007b31 SH |
3989 | |
3990 | /* safe default */ | |
3991 | return 0; | |
68485420 KW |
3992 | } |
3993 | ||
61007b31 | 3994 | bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs) |
b2a61371 | 3995 | { |
61007b31 | 3996 | BlockDriverInfo bdi; |
b2a61371 | 3997 | |
760e0063 | 3998 | if (bs->backing) { |
61007b31 SH |
3999 | return false; |
4000 | } | |
4001 | ||
4002 | if (bdrv_get_info(bs, &bdi) == 0) { | |
4003 | return bdi.unallocated_blocks_are_zero; | |
b2a61371 SH |
4004 | } |
4005 | ||
61007b31 | 4006 | return false; |
b2a61371 SH |
4007 | } |
4008 | ||
61007b31 | 4009 | bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs) |
68485420 | 4010 | { |
61007b31 | 4011 | BlockDriverInfo bdi; |
68485420 | 4012 | |
2f0342ef | 4013 | if (!(bs->open_flags & BDRV_O_UNMAP)) { |
61007b31 SH |
4014 | return false; |
4015 | } | |
68485420 | 4016 | |
61007b31 SH |
4017 | if (bdrv_get_info(bs, &bdi) == 0) { |
4018 | return bdi.can_write_zeroes_with_unmap; | |
4019 | } | |
68485420 | 4020 | |
61007b31 | 4021 | return false; |
68485420 KW |
4022 | } |
4023 | ||
61007b31 | 4024 | const char *bdrv_get_encrypted_filename(BlockDriverState *bs) |
b2e12bc6 | 4025 | { |
760e0063 | 4026 | if (bs->backing && bs->backing->bs->encrypted) |
61007b31 SH |
4027 | return bs->backing_file; |
4028 | else if (bs->encrypted) | |
4029 | return bs->filename; | |
4030 | else | |
4031 | return NULL; | |
b2e12bc6 CH |
4032 | } |
4033 | ||
61007b31 SH |
4034 | void bdrv_get_backing_filename(BlockDriverState *bs, |
4035 | char *filename, int filename_size) | |
016f5cf6 | 4036 | { |
61007b31 SH |
4037 | pstrcpy(filename, filename_size, bs->backing_file); |
4038 | } | |
d318aea9 | 4039 | |
61007b31 SH |
4040 | int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi) |
4041 | { | |
4042 | BlockDriver *drv = bs->drv; | |
5a612c00 MP |
4043 | /* if bs->drv == NULL, bs is closed, so there's nothing to do here */ |
4044 | if (!drv) { | |
61007b31 | 4045 | return -ENOMEDIUM; |
5a612c00 MP |
4046 | } |
4047 | if (!drv->bdrv_get_info) { | |
4048 | if (bs->file && drv->is_filter) { | |
4049 | return bdrv_get_info(bs->file->bs, bdi); | |
4050 | } | |
61007b31 | 4051 | return -ENOTSUP; |
5a612c00 | 4052 | } |
61007b31 SH |
4053 | memset(bdi, 0, sizeof(*bdi)); |
4054 | return drv->bdrv_get_info(bs, bdi); | |
4055 | } | |
016f5cf6 | 4056 | |
61007b31 SH |
4057 | ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs) |
4058 | { | |
4059 | BlockDriver *drv = bs->drv; | |
4060 | if (drv && drv->bdrv_get_specific_info) { | |
4061 | return drv->bdrv_get_specific_info(bs); | |
4062 | } | |
4063 | return NULL; | |
016f5cf6 AG |
4064 | } |
4065 | ||
a31939e6 | 4066 | void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event) |
4265d620 | 4067 | { |
61007b31 SH |
4068 | if (!bs || !bs->drv || !bs->drv->bdrv_debug_event) { |
4069 | return; | |
4070 | } | |
4265d620 | 4071 | |
61007b31 | 4072 | bs->drv->bdrv_debug_event(bs, event); |
4265d620 PB |
4073 | } |
4074 | ||
61007b31 SH |
4075 | int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event, |
4076 | const char *tag) | |
4265d620 | 4077 | { |
61007b31 | 4078 | while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) { |
9a4f4c31 | 4079 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 4080 | } |
4265d620 | 4081 | |
61007b31 SH |
4082 | if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) { |
4083 | return bs->drv->bdrv_debug_breakpoint(bs, event, tag); | |
4084 | } | |
4265d620 | 4085 | |
61007b31 | 4086 | return -ENOTSUP; |
4265d620 PB |
4087 | } |
4088 | ||
61007b31 | 4089 | int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag) |
ea2384d3 | 4090 | { |
61007b31 | 4091 | while (bs && bs->drv && !bs->drv->bdrv_debug_remove_breakpoint) { |
9a4f4c31 | 4092 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 4093 | } |
ce1a14dc | 4094 | |
61007b31 SH |
4095 | if (bs && bs->drv && bs->drv->bdrv_debug_remove_breakpoint) { |
4096 | return bs->drv->bdrv_debug_remove_breakpoint(bs, tag); | |
4097 | } | |
4098 | ||
4099 | return -ENOTSUP; | |
eb852011 MA |
4100 | } |
4101 | ||
61007b31 | 4102 | int bdrv_debug_resume(BlockDriverState *bs, const char *tag) |
ce1a14dc | 4103 | { |
61007b31 | 4104 | while (bs && (!bs->drv || !bs->drv->bdrv_debug_resume)) { |
9a4f4c31 | 4105 | bs = bs->file ? bs->file->bs : NULL; |
61007b31 | 4106 | } |
ce1a14dc | 4107 | |
61007b31 SH |
4108 | if (bs && bs->drv && bs->drv->bdrv_debug_resume) { |
4109 | return bs->drv->bdrv_debug_resume(bs, tag); | |
4110 | } | |
ce1a14dc | 4111 | |
61007b31 | 4112 | return -ENOTSUP; |
f197fe2b FZ |
4113 | } |
4114 | ||
61007b31 | 4115 | bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag) |
ce1a14dc | 4116 | { |
61007b31 | 4117 | while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) { |
9a4f4c31 | 4118 | bs = bs->file ? bs->file->bs : NULL; |
f197fe2b | 4119 | } |
19cb3738 | 4120 | |
61007b31 SH |
4121 | if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) { |
4122 | return bs->drv->bdrv_debug_is_suspended(bs, tag); | |
4123 | } | |
f9f05dc5 | 4124 | |
61007b31 SH |
4125 | return false; |
4126 | } | |
f9f05dc5 | 4127 | |
61007b31 SH |
4128 | /* backing_file can either be relative, or absolute, or a protocol. If it is |
4129 | * relative, it must be relative to the chain. So, passing in bs->filename | |
4130 | * from a BDS as backing_file should not be done, as that may be relative to | |
4131 | * the CWD rather than the chain. */ | |
4132 | BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs, | |
4133 | const char *backing_file) | |
f9f05dc5 | 4134 | { |
61007b31 SH |
4135 | char *filename_full = NULL; |
4136 | char *backing_file_full = NULL; | |
4137 | char *filename_tmp = NULL; | |
4138 | int is_protocol = 0; | |
4139 | BlockDriverState *curr_bs = NULL; | |
4140 | BlockDriverState *retval = NULL; | |
418661e0 | 4141 | Error *local_error = NULL; |
f9f05dc5 | 4142 | |
61007b31 SH |
4143 | if (!bs || !bs->drv || !backing_file) { |
4144 | return NULL; | |
f9f05dc5 KW |
4145 | } |
4146 | ||
61007b31 SH |
4147 | filename_full = g_malloc(PATH_MAX); |
4148 | backing_file_full = g_malloc(PATH_MAX); | |
4149 | filename_tmp = g_malloc(PATH_MAX); | |
f9f05dc5 | 4150 | |
61007b31 | 4151 | is_protocol = path_has_protocol(backing_file); |
f9f05dc5 | 4152 | |
760e0063 | 4153 | for (curr_bs = bs; curr_bs->backing; curr_bs = curr_bs->backing->bs) { |
f9f05dc5 | 4154 | |
61007b31 SH |
4155 | /* If either of the filename paths is actually a protocol, then |
4156 | * compare unmodified paths; otherwise make paths relative */ | |
4157 | if (is_protocol || path_has_protocol(curr_bs->backing_file)) { | |
4158 | if (strcmp(backing_file, curr_bs->backing_file) == 0) { | |
760e0063 | 4159 | retval = curr_bs->backing->bs; |
61007b31 SH |
4160 | break; |
4161 | } | |
418661e0 JC |
4162 | /* Also check against the full backing filename for the image */ |
4163 | bdrv_get_full_backing_filename(curr_bs, backing_file_full, PATH_MAX, | |
4164 | &local_error); | |
4165 | if (local_error == NULL) { | |
4166 | if (strcmp(backing_file, backing_file_full) == 0) { | |
4167 | retval = curr_bs->backing->bs; | |
4168 | break; | |
4169 | } | |
4170 | } else { | |
4171 | error_free(local_error); | |
4172 | local_error = NULL; | |
4173 | } | |
61007b31 SH |
4174 | } else { |
4175 | /* If not an absolute filename path, make it relative to the current | |
4176 | * image's filename path */ | |
4177 | path_combine(filename_tmp, PATH_MAX, curr_bs->filename, | |
4178 | backing_file); | |
f9f05dc5 | 4179 | |
61007b31 SH |
4180 | /* We are going to compare absolute pathnames */ |
4181 | if (!realpath(filename_tmp, filename_full)) { | |
4182 | continue; | |
4183 | } | |
07f07615 | 4184 | |
61007b31 SH |
4185 | /* We need to make sure the backing filename we are comparing against |
4186 | * is relative to the current image filename (or absolute) */ | |
4187 | path_combine(filename_tmp, PATH_MAX, curr_bs->filename, | |
4188 | curr_bs->backing_file); | |
07f07615 | 4189 | |
61007b31 SH |
4190 | if (!realpath(filename_tmp, backing_file_full)) { |
4191 | continue; | |
4192 | } | |
eb489bb1 | 4193 | |
61007b31 | 4194 | if (strcmp(backing_file_full, filename_full) == 0) { |
760e0063 | 4195 | retval = curr_bs->backing->bs; |
61007b31 SH |
4196 | break; |
4197 | } | |
4198 | } | |
eb489bb1 KW |
4199 | } |
4200 | ||
61007b31 SH |
4201 | g_free(filename_full); |
4202 | g_free(backing_file_full); | |
4203 | g_free(filename_tmp); | |
4204 | return retval; | |
4205 | } | |
4206 | ||
61007b31 SH |
4207 | void bdrv_init(void) |
4208 | { | |
4209 | module_call_init(MODULE_INIT_BLOCK); | |
4210 | } | |
29cdb251 | 4211 | |
61007b31 SH |
4212 | void bdrv_init_with_whitelist(void) |
4213 | { | |
4214 | use_bdrv_whitelist = 1; | |
4215 | bdrv_init(); | |
07f07615 PB |
4216 | } |
4217 | ||
5a8a30db | 4218 | void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp) |
0f15423c | 4219 | { |
4417ab7a | 4220 | BdrvChild *child, *parent; |
9c5e6594 | 4221 | uint64_t perm, shared_perm; |
5a8a30db KW |
4222 | Error *local_err = NULL; |
4223 | int ret; | |
4224 | ||
3456a8d1 KW |
4225 | if (!bs->drv) { |
4226 | return; | |
4227 | } | |
4228 | ||
04c01a5c | 4229 | if (!(bs->open_flags & BDRV_O_INACTIVE)) { |
7ea2d269 AK |
4230 | return; |
4231 | } | |
7ea2d269 | 4232 | |
16e977d5 VSO |
4233 | QLIST_FOREACH(child, &bs->children, next) { |
4234 | bdrv_invalidate_cache(child->bs, &local_err); | |
0d1c5c91 | 4235 | if (local_err) { |
0d1c5c91 FZ |
4236 | error_propagate(errp, local_err); |
4237 | return; | |
4238 | } | |
5a8a30db | 4239 | } |
0d1c5c91 | 4240 | |
dafe0960 KW |
4241 | /* |
4242 | * Update permissions, they may differ for inactive nodes. | |
4243 | * | |
4244 | * Note that the required permissions of inactive images are always a | |
4245 | * subset of the permissions required after activating the image. This | |
4246 | * allows us to just get the permissions upfront without restricting | |
4247 | * drv->bdrv_invalidate_cache(). | |
4248 | * | |
4249 | * It also means that in error cases, we don't have to try and revert to | |
4250 | * the old permissions (which is an operation that could fail, too). We can | |
4251 | * just keep the extended permissions for the next time that an activation | |
4252 | * of the image is tried. | |
4253 | */ | |
16e977d5 | 4254 | bs->open_flags &= ~BDRV_O_INACTIVE; |
dafe0960 KW |
4255 | bdrv_get_cumulative_perm(bs, &perm, &shared_perm); |
4256 | ret = bdrv_check_perm(bs, NULL, perm, shared_perm, NULL, &local_err); | |
4257 | if (ret < 0) { | |
4258 | bs->open_flags |= BDRV_O_INACTIVE; | |
4259 | error_propagate(errp, local_err); | |
4260 | return; | |
4261 | } | |
4262 | bdrv_set_perm(bs, perm, shared_perm); | |
4263 | ||
16e977d5 VSO |
4264 | if (bs->drv->bdrv_invalidate_cache) { |
4265 | bs->drv->bdrv_invalidate_cache(bs, &local_err); | |
0d1c5c91 FZ |
4266 | if (local_err) { |
4267 | bs->open_flags |= BDRV_O_INACTIVE; | |
4268 | error_propagate(errp, local_err); | |
4269 | return; | |
4270 | } | |
0f15423c | 4271 | } |
3456a8d1 | 4272 | |
5a8a30db KW |
4273 | ret = refresh_total_sectors(bs, bs->total_sectors); |
4274 | if (ret < 0) { | |
04c01a5c | 4275 | bs->open_flags |= BDRV_O_INACTIVE; |
5a8a30db KW |
4276 | error_setg_errno(errp, -ret, "Could not refresh total sector count"); |
4277 | return; | |
4278 | } | |
4417ab7a KW |
4279 | |
4280 | QLIST_FOREACH(parent, &bs->parents, next_parent) { | |
4281 | if (parent->role->activate) { | |
4282 | parent->role->activate(parent, &local_err); | |
4283 | if (local_err) { | |
4284 | error_propagate(errp, local_err); | |
4285 | return; | |
4286 | } | |
4287 | } | |
4288 | } | |
0f15423c AL |
4289 | } |
4290 | ||
5a8a30db | 4291 | void bdrv_invalidate_cache_all(Error **errp) |
0f15423c | 4292 | { |
7c8eece4 | 4293 | BlockDriverState *bs; |
5a8a30db | 4294 | Error *local_err = NULL; |
88be7b4b | 4295 | BdrvNextIterator it; |
0f15423c | 4296 | |
88be7b4b | 4297 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
ed78cda3 SH |
4298 | AioContext *aio_context = bdrv_get_aio_context(bs); |
4299 | ||
4300 | aio_context_acquire(aio_context); | |
5a8a30db | 4301 | bdrv_invalidate_cache(bs, &local_err); |
ed78cda3 | 4302 | aio_context_release(aio_context); |
5a8a30db KW |
4303 | if (local_err) { |
4304 | error_propagate(errp, local_err); | |
5e003f17 | 4305 | bdrv_next_cleanup(&it); |
5a8a30db KW |
4306 | return; |
4307 | } | |
0f15423c AL |
4308 | } |
4309 | } | |
4310 | ||
aad0b7a0 FZ |
4311 | static int bdrv_inactivate_recurse(BlockDriverState *bs, |
4312 | bool setting_flag) | |
76b1c7fe | 4313 | { |
cfa1a572 | 4314 | BdrvChild *child, *parent; |
76b1c7fe KW |
4315 | int ret; |
4316 | ||
d470ad42 HR |
4317 | if (!bs->drv) { |
4318 | return -ENOMEDIUM; | |
4319 | } | |
4320 | ||
aad0b7a0 | 4321 | if (!setting_flag && bs->drv->bdrv_inactivate) { |
76b1c7fe KW |
4322 | ret = bs->drv->bdrv_inactivate(bs); |
4323 | if (ret < 0) { | |
4324 | return ret; | |
4325 | } | |
4326 | } | |
4327 | ||
7d5b5261 | 4328 | if (setting_flag && !(bs->open_flags & BDRV_O_INACTIVE)) { |
9c5e6594 KW |
4329 | uint64_t perm, shared_perm; |
4330 | ||
cfa1a572 KW |
4331 | QLIST_FOREACH(parent, &bs->parents, next_parent) { |
4332 | if (parent->role->inactivate) { | |
4333 | ret = parent->role->inactivate(parent); | |
4334 | if (ret < 0) { | |
cfa1a572 KW |
4335 | return ret; |
4336 | } | |
4337 | } | |
4338 | } | |
9c5e6594 | 4339 | |
7d5b5261 SH |
4340 | bs->open_flags |= BDRV_O_INACTIVE; |
4341 | ||
9c5e6594 KW |
4342 | /* Update permissions, they may differ for inactive nodes */ |
4343 | bdrv_get_cumulative_perm(bs, &perm, &shared_perm); | |
3121fb45 | 4344 | bdrv_check_perm(bs, NULL, perm, shared_perm, NULL, &error_abort); |
9c5e6594 | 4345 | bdrv_set_perm(bs, perm, shared_perm); |
aad0b7a0 | 4346 | } |
38701b6a KW |
4347 | |
4348 | QLIST_FOREACH(child, &bs->children, next) { | |
4349 | ret = bdrv_inactivate_recurse(child->bs, setting_flag); | |
4350 | if (ret < 0) { | |
4351 | return ret; | |
4352 | } | |
4353 | } | |
4354 | ||
615b5dcf VSO |
4355 | /* At this point persistent bitmaps should be already stored by the format |
4356 | * driver */ | |
4357 | bdrv_release_persistent_dirty_bitmaps(bs); | |
4358 | ||
76b1c7fe KW |
4359 | return 0; |
4360 | } | |
4361 | ||
4362 | int bdrv_inactivate_all(void) | |
4363 | { | |
79720af6 | 4364 | BlockDriverState *bs = NULL; |
88be7b4b | 4365 | BdrvNextIterator it; |
aad0b7a0 FZ |
4366 | int ret = 0; |
4367 | int pass; | |
bd6458e4 | 4368 | GSList *aio_ctxs = NULL, *ctx; |
76b1c7fe | 4369 | |
88be7b4b | 4370 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
bd6458e4 PB |
4371 | AioContext *aio_context = bdrv_get_aio_context(bs); |
4372 | ||
4373 | if (!g_slist_find(aio_ctxs, aio_context)) { | |
4374 | aio_ctxs = g_slist_prepend(aio_ctxs, aio_context); | |
4375 | aio_context_acquire(aio_context); | |
4376 | } | |
aad0b7a0 | 4377 | } |
76b1c7fe | 4378 | |
aad0b7a0 FZ |
4379 | /* We do two passes of inactivation. The first pass calls to drivers' |
4380 | * .bdrv_inactivate callbacks recursively so all cache is flushed to disk; | |
4381 | * the second pass sets the BDRV_O_INACTIVE flag so that no further write | |
4382 | * is allowed. */ | |
4383 | for (pass = 0; pass < 2; pass++) { | |
88be7b4b | 4384 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
aad0b7a0 FZ |
4385 | ret = bdrv_inactivate_recurse(bs, pass); |
4386 | if (ret < 0) { | |
5e003f17 | 4387 | bdrv_next_cleanup(&it); |
aad0b7a0 FZ |
4388 | goto out; |
4389 | } | |
76b1c7fe KW |
4390 | } |
4391 | } | |
4392 | ||
aad0b7a0 | 4393 | out: |
bd6458e4 PB |
4394 | for (ctx = aio_ctxs; ctx != NULL; ctx = ctx->next) { |
4395 | AioContext *aio_context = ctx->data; | |
4396 | aio_context_release(aio_context); | |
aad0b7a0 | 4397 | } |
bd6458e4 | 4398 | g_slist_free(aio_ctxs); |
aad0b7a0 FZ |
4399 | |
4400 | return ret; | |
76b1c7fe KW |
4401 | } |
4402 | ||
19cb3738 FB |
4403 | /**************************************************************/ |
4404 | /* removable device support */ | |
4405 | ||
4406 | /** | |
4407 | * Return TRUE if the media is present | |
4408 | */ | |
e031f750 | 4409 | bool bdrv_is_inserted(BlockDriverState *bs) |
19cb3738 FB |
4410 | { |
4411 | BlockDriver *drv = bs->drv; | |
28d7a789 | 4412 | BdrvChild *child; |
a1aff5bf | 4413 | |
e031f750 HR |
4414 | if (!drv) { |
4415 | return false; | |
4416 | } | |
28d7a789 HR |
4417 | if (drv->bdrv_is_inserted) { |
4418 | return drv->bdrv_is_inserted(bs); | |
4419 | } | |
4420 | QLIST_FOREACH(child, &bs->children, next) { | |
4421 | if (!bdrv_is_inserted(child->bs)) { | |
4422 | return false; | |
4423 | } | |
e031f750 | 4424 | } |
28d7a789 | 4425 | return true; |
19cb3738 FB |
4426 | } |
4427 | ||
19cb3738 FB |
4428 | /** |
4429 | * If eject_flag is TRUE, eject the media. Otherwise, close the tray | |
4430 | */ | |
f36f3949 | 4431 | void bdrv_eject(BlockDriverState *bs, bool eject_flag) |
19cb3738 FB |
4432 | { |
4433 | BlockDriver *drv = bs->drv; | |
19cb3738 | 4434 | |
822e1cd1 MA |
4435 | if (drv && drv->bdrv_eject) { |
4436 | drv->bdrv_eject(bs, eject_flag); | |
19cb3738 FB |
4437 | } |
4438 | } | |
4439 | ||
19cb3738 FB |
4440 | /** |
4441 | * Lock or unlock the media (if it is locked, the user won't be able | |
4442 | * to eject it manually). | |
4443 | */ | |
025e849a | 4444 | void bdrv_lock_medium(BlockDriverState *bs, bool locked) |
19cb3738 FB |
4445 | { |
4446 | BlockDriver *drv = bs->drv; | |
4447 | ||
025e849a | 4448 | trace_bdrv_lock_medium(bs, locked); |
b8c6d095 | 4449 | |
025e849a MA |
4450 | if (drv && drv->bdrv_lock_medium) { |
4451 | drv->bdrv_lock_medium(bs, locked); | |
19cb3738 FB |
4452 | } |
4453 | } | |
985a03b0 | 4454 | |
9fcb0251 FZ |
4455 | /* Get a reference to bs */ |
4456 | void bdrv_ref(BlockDriverState *bs) | |
4457 | { | |
4458 | bs->refcnt++; | |
4459 | } | |
4460 | ||
4461 | /* Release a previously grabbed reference to bs. | |
4462 | * If after releasing, reference count is zero, the BlockDriverState is | |
4463 | * deleted. */ | |
4464 | void bdrv_unref(BlockDriverState *bs) | |
4465 | { | |
9a4d5ca6 JC |
4466 | if (!bs) { |
4467 | return; | |
4468 | } | |
9fcb0251 FZ |
4469 | assert(bs->refcnt > 0); |
4470 | if (--bs->refcnt == 0) { | |
4471 | bdrv_delete(bs); | |
4472 | } | |
4473 | } | |
4474 | ||
fbe40ff7 FZ |
4475 | struct BdrvOpBlocker { |
4476 | Error *reason; | |
4477 | QLIST_ENTRY(BdrvOpBlocker) list; | |
4478 | }; | |
4479 | ||
4480 | bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp) | |
4481 | { | |
4482 | BdrvOpBlocker *blocker; | |
4483 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
4484 | if (!QLIST_EMPTY(&bs->op_blockers[op])) { | |
4485 | blocker = QLIST_FIRST(&bs->op_blockers[op]); | |
57ef3f12 EH |
4486 | error_propagate(errp, error_copy(blocker->reason)); |
4487 | error_prepend(errp, "Node '%s' is busy: ", | |
4488 | bdrv_get_device_or_node_name(bs)); | |
fbe40ff7 FZ |
4489 | return true; |
4490 | } | |
4491 | return false; | |
4492 | } | |
4493 | ||
4494 | void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason) | |
4495 | { | |
4496 | BdrvOpBlocker *blocker; | |
4497 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
4498 | ||
5839e53b | 4499 | blocker = g_new0(BdrvOpBlocker, 1); |
fbe40ff7 FZ |
4500 | blocker->reason = reason; |
4501 | QLIST_INSERT_HEAD(&bs->op_blockers[op], blocker, list); | |
4502 | } | |
4503 | ||
4504 | void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason) | |
4505 | { | |
4506 | BdrvOpBlocker *blocker, *next; | |
4507 | assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX); | |
4508 | QLIST_FOREACH_SAFE(blocker, &bs->op_blockers[op], list, next) { | |
4509 | if (blocker->reason == reason) { | |
4510 | QLIST_REMOVE(blocker, list); | |
4511 | g_free(blocker); | |
4512 | } | |
4513 | } | |
4514 | } | |
4515 | ||
4516 | void bdrv_op_block_all(BlockDriverState *bs, Error *reason) | |
4517 | { | |
4518 | int i; | |
4519 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
4520 | bdrv_op_block(bs, i, reason); | |
4521 | } | |
4522 | } | |
4523 | ||
4524 | void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason) | |
4525 | { | |
4526 | int i; | |
4527 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
4528 | bdrv_op_unblock(bs, i, reason); | |
4529 | } | |
4530 | } | |
4531 | ||
4532 | bool bdrv_op_blocker_is_empty(BlockDriverState *bs) | |
4533 | { | |
4534 | int i; | |
4535 | ||
4536 | for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) { | |
4537 | if (!QLIST_EMPTY(&bs->op_blockers[i])) { | |
4538 | return false; | |
4539 | } | |
4540 | } | |
4541 | return true; | |
4542 | } | |
4543 | ||
d92ada22 LC |
4544 | void bdrv_img_create(const char *filename, const char *fmt, |
4545 | const char *base_filename, const char *base_fmt, | |
9217283d FZ |
4546 | char *options, uint64_t img_size, int flags, bool quiet, |
4547 | Error **errp) | |
f88e1a42 | 4548 | { |
83d0521a CL |
4549 | QemuOptsList *create_opts = NULL; |
4550 | QemuOpts *opts = NULL; | |
4551 | const char *backing_fmt, *backing_file; | |
4552 | int64_t size; | |
f88e1a42 | 4553 | BlockDriver *drv, *proto_drv; |
cc84d90f | 4554 | Error *local_err = NULL; |
f88e1a42 JS |
4555 | int ret = 0; |
4556 | ||
4557 | /* Find driver and parse its options */ | |
4558 | drv = bdrv_find_format(fmt); | |
4559 | if (!drv) { | |
71c79813 | 4560 | error_setg(errp, "Unknown file format '%s'", fmt); |
d92ada22 | 4561 | return; |
f88e1a42 JS |
4562 | } |
4563 | ||
b65a5e12 | 4564 | proto_drv = bdrv_find_protocol(filename, true, errp); |
f88e1a42 | 4565 | if (!proto_drv) { |
d92ada22 | 4566 | return; |
f88e1a42 JS |
4567 | } |
4568 | ||
c6149724 HR |
4569 | if (!drv->create_opts) { |
4570 | error_setg(errp, "Format driver '%s' does not support image creation", | |
4571 | drv->format_name); | |
4572 | return; | |
4573 | } | |
4574 | ||
4575 | if (!proto_drv->create_opts) { | |
4576 | error_setg(errp, "Protocol driver '%s' does not support image creation", | |
4577 | proto_drv->format_name); | |
4578 | return; | |
4579 | } | |
4580 | ||
c282e1fd CL |
4581 | create_opts = qemu_opts_append(create_opts, drv->create_opts); |
4582 | create_opts = qemu_opts_append(create_opts, proto_drv->create_opts); | |
f88e1a42 JS |
4583 | |
4584 | /* Create parameter list with default values */ | |
83d0521a | 4585 | opts = qemu_opts_create(create_opts, NULL, 0, &error_abort); |
39101f25 | 4586 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort); |
f88e1a42 JS |
4587 | |
4588 | /* Parse -o options */ | |
4589 | if (options) { | |
dc523cd3 MA |
4590 | qemu_opts_do_parse(opts, options, NULL, &local_err); |
4591 | if (local_err) { | |
4592 | error_report_err(local_err); | |
4593 | local_err = NULL; | |
83d0521a | 4594 | error_setg(errp, "Invalid options for file format '%s'", fmt); |
f88e1a42 JS |
4595 | goto out; |
4596 | } | |
4597 | } | |
4598 | ||
4599 | if (base_filename) { | |
f43e47db | 4600 | qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &local_err); |
6be4194b | 4601 | if (local_err) { |
71c79813 LC |
4602 | error_setg(errp, "Backing file not supported for file format '%s'", |
4603 | fmt); | |
f88e1a42 JS |
4604 | goto out; |
4605 | } | |
4606 | } | |
4607 | ||
4608 | if (base_fmt) { | |
f43e47db | 4609 | qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &local_err); |
6be4194b | 4610 | if (local_err) { |
71c79813 LC |
4611 | error_setg(errp, "Backing file format not supported for file " |
4612 | "format '%s'", fmt); | |
f88e1a42 JS |
4613 | goto out; |
4614 | } | |
4615 | } | |
4616 | ||
83d0521a CL |
4617 | backing_file = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE); |
4618 | if (backing_file) { | |
4619 | if (!strcmp(filename, backing_file)) { | |
71c79813 LC |
4620 | error_setg(errp, "Error: Trying to create an image with the " |
4621 | "same filename as the backing file"); | |
792da93a JS |
4622 | goto out; |
4623 | } | |
4624 | } | |
4625 | ||
83d0521a | 4626 | backing_fmt = qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT); |
f88e1a42 | 4627 | |
6e6e55f5 JS |
4628 | /* The size for the image must always be specified, unless we have a backing |
4629 | * file and we have not been forbidden from opening it. */ | |
a8b42a1c | 4630 | size = qemu_opt_get_size(opts, BLOCK_OPT_SIZE, img_size); |
6e6e55f5 JS |
4631 | if (backing_file && !(flags & BDRV_O_NO_BACKING)) { |
4632 | BlockDriverState *bs; | |
4633 | char *full_backing = g_new0(char, PATH_MAX); | |
4634 | int back_flags; | |
4635 | QDict *backing_options = NULL; | |
4636 | ||
4637 | bdrv_get_full_backing_filename_from_filename(filename, backing_file, | |
4638 | full_backing, PATH_MAX, | |
4639 | &local_err); | |
4640 | if (local_err) { | |
4641 | g_free(full_backing); | |
4642 | goto out; | |
4643 | } | |
29168018 | 4644 | |
6e6e55f5 JS |
4645 | /* backing files always opened read-only */ |
4646 | back_flags = flags; | |
4647 | back_flags &= ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING); | |
f88e1a42 | 4648 | |
cc954f01 | 4649 | backing_options = qdict_new(); |
6e6e55f5 | 4650 | if (backing_fmt) { |
6e6e55f5 JS |
4651 | qdict_put_str(backing_options, "driver", backing_fmt); |
4652 | } | |
cc954f01 | 4653 | qdict_put_bool(backing_options, BDRV_OPT_FORCE_SHARE, true); |
e6641719 | 4654 | |
6e6e55f5 JS |
4655 | bs = bdrv_open(full_backing, NULL, backing_options, back_flags, |
4656 | &local_err); | |
4657 | g_free(full_backing); | |
4658 | if (!bs && size != -1) { | |
4659 | /* Couldn't open BS, but we have a size, so it's nonfatal */ | |
4660 | warn_reportf_err(local_err, | |
4661 | "Could not verify backing image. " | |
4662 | "This may become an error in future versions.\n"); | |
4663 | local_err = NULL; | |
4664 | } else if (!bs) { | |
4665 | /* Couldn't open bs, do not have size */ | |
4666 | error_append_hint(&local_err, | |
4667 | "Could not open backing image to determine size.\n"); | |
4668 | goto out; | |
4669 | } else { | |
4670 | if (size == -1) { | |
4671 | /* Opened BS, have no size */ | |
4672 | size = bdrv_getlength(bs); | |
4673 | if (size < 0) { | |
4674 | error_setg_errno(errp, -size, "Could not get size of '%s'", | |
4675 | backing_file); | |
4676 | bdrv_unref(bs); | |
4677 | goto out; | |
4678 | } | |
4679 | qemu_opt_set_number(opts, BLOCK_OPT_SIZE, size, &error_abort); | |
52bf1e72 | 4680 | } |
66f6b814 | 4681 | bdrv_unref(bs); |
f88e1a42 | 4682 | } |
6e6e55f5 JS |
4683 | } /* (backing_file && !(flags & BDRV_O_NO_BACKING)) */ |
4684 | ||
4685 | if (size == -1) { | |
4686 | error_setg(errp, "Image creation needs a size parameter"); | |
4687 | goto out; | |
f88e1a42 JS |
4688 | } |
4689 | ||
f382d43a | 4690 | if (!quiet) { |
fe646693 | 4691 | printf("Formatting '%s', fmt=%s ", filename, fmt); |
43c5d8f8 | 4692 | qemu_opts_print(opts, " "); |
f382d43a MR |
4693 | puts(""); |
4694 | } | |
83d0521a | 4695 | |
c282e1fd | 4696 | ret = bdrv_create(drv, filename, opts, &local_err); |
83d0521a | 4697 | |
cc84d90f HR |
4698 | if (ret == -EFBIG) { |
4699 | /* This is generally a better message than whatever the driver would | |
4700 | * deliver (especially because of the cluster_size_hint), since that | |
4701 | * is most probably not much different from "image too large". */ | |
4702 | const char *cluster_size_hint = ""; | |
83d0521a | 4703 | if (qemu_opt_get_size(opts, BLOCK_OPT_CLUSTER_SIZE, 0)) { |
cc84d90f | 4704 | cluster_size_hint = " (try using a larger cluster size)"; |
f88e1a42 | 4705 | } |
cc84d90f HR |
4706 | error_setg(errp, "The image size is too large for file format '%s'" |
4707 | "%s", fmt, cluster_size_hint); | |
4708 | error_free(local_err); | |
4709 | local_err = NULL; | |
f88e1a42 JS |
4710 | } |
4711 | ||
4712 | out: | |
83d0521a CL |
4713 | qemu_opts_del(opts); |
4714 | qemu_opts_free(create_opts); | |
621ff94d | 4715 | error_propagate(errp, local_err); |
f88e1a42 | 4716 | } |
85d126f3 SH |
4717 | |
4718 | AioContext *bdrv_get_aio_context(BlockDriverState *bs) | |
4719 | { | |
dcd04228 SH |
4720 | return bs->aio_context; |
4721 | } | |
4722 | ||
052a7572 FZ |
4723 | void bdrv_coroutine_enter(BlockDriverState *bs, Coroutine *co) |
4724 | { | |
4725 | aio_co_enter(bdrv_get_aio_context(bs), co); | |
4726 | } | |
4727 | ||
e8a095da SH |
4728 | static void bdrv_do_remove_aio_context_notifier(BdrvAioNotifier *ban) |
4729 | { | |
4730 | QLIST_REMOVE(ban, list); | |
4731 | g_free(ban); | |
4732 | } | |
4733 | ||
dcd04228 SH |
4734 | void bdrv_detach_aio_context(BlockDriverState *bs) |
4735 | { | |
e8a095da | 4736 | BdrvAioNotifier *baf, *baf_tmp; |
b97511c7 | 4737 | BdrvChild *child; |
33384421 | 4738 | |
dcd04228 SH |
4739 | if (!bs->drv) { |
4740 | return; | |
4741 | } | |
4742 | ||
e8a095da SH |
4743 | assert(!bs->walking_aio_notifiers); |
4744 | bs->walking_aio_notifiers = true; | |
4745 | QLIST_FOREACH_SAFE(baf, &bs->aio_notifiers, list, baf_tmp) { | |
4746 | if (baf->deleted) { | |
4747 | bdrv_do_remove_aio_context_notifier(baf); | |
4748 | } else { | |
4749 | baf->detach_aio_context(baf->opaque); | |
4750 | } | |
33384421 | 4751 | } |
e8a095da SH |
4752 | /* Never mind iterating again to check for ->deleted. bdrv_close() will |
4753 | * remove remaining aio notifiers if we aren't called again. | |
4754 | */ | |
4755 | bs->walking_aio_notifiers = false; | |
33384421 | 4756 | |
dcd04228 SH |
4757 | if (bs->drv->bdrv_detach_aio_context) { |
4758 | bs->drv->bdrv_detach_aio_context(bs); | |
4759 | } | |
b97511c7 HR |
4760 | QLIST_FOREACH(child, &bs->children, next) { |
4761 | bdrv_detach_aio_context(child->bs); | |
dcd04228 SH |
4762 | } |
4763 | ||
4764 | bs->aio_context = NULL; | |
4765 | } | |
4766 | ||
4767 | void bdrv_attach_aio_context(BlockDriverState *bs, | |
4768 | AioContext *new_context) | |
4769 | { | |
e8a095da | 4770 | BdrvAioNotifier *ban, *ban_tmp; |
b97511c7 | 4771 | BdrvChild *child; |
33384421 | 4772 | |
dcd04228 SH |
4773 | if (!bs->drv) { |
4774 | return; | |
4775 | } | |
4776 | ||
4777 | bs->aio_context = new_context; | |
4778 | ||
b97511c7 HR |
4779 | QLIST_FOREACH(child, &bs->children, next) { |
4780 | bdrv_attach_aio_context(child->bs, new_context); | |
dcd04228 SH |
4781 | } |
4782 | if (bs->drv->bdrv_attach_aio_context) { | |
4783 | bs->drv->bdrv_attach_aio_context(bs, new_context); | |
4784 | } | |
33384421 | 4785 | |
e8a095da SH |
4786 | assert(!bs->walking_aio_notifiers); |
4787 | bs->walking_aio_notifiers = true; | |
4788 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_tmp) { | |
4789 | if (ban->deleted) { | |
4790 | bdrv_do_remove_aio_context_notifier(ban); | |
4791 | } else { | |
4792 | ban->attached_aio_context(new_context, ban->opaque); | |
4793 | } | |
33384421 | 4794 | } |
e8a095da | 4795 | bs->walking_aio_notifiers = false; |
dcd04228 SH |
4796 | } |
4797 | ||
4798 | void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context) | |
4799 | { | |
aabf5910 | 4800 | AioContext *ctx = bdrv_get_aio_context(bs); |
c2b6428d | 4801 | |
aabf5910 | 4802 | aio_disable_external(ctx); |
0152bf40 | 4803 | bdrv_parent_drained_begin(bs, NULL); |
53ec73e2 | 4804 | bdrv_drain(bs); /* ensure there are no in-flight requests */ |
dcd04228 | 4805 | |
c2b6428d PB |
4806 | while (aio_poll(ctx, false)) { |
4807 | /* wait for all bottom halves to execute */ | |
4808 | } | |
4809 | ||
dcd04228 SH |
4810 | bdrv_detach_aio_context(bs); |
4811 | ||
4812 | /* This function executes in the old AioContext so acquire the new one in | |
4813 | * case it runs in a different thread. | |
4814 | */ | |
4815 | aio_context_acquire(new_context); | |
4816 | bdrv_attach_aio_context(bs, new_context); | |
0152bf40 | 4817 | bdrv_parent_drained_end(bs, NULL); |
aabf5910 | 4818 | aio_enable_external(ctx); |
dcd04228 | 4819 | aio_context_release(new_context); |
85d126f3 | 4820 | } |
d616b224 | 4821 | |
33384421 HR |
4822 | void bdrv_add_aio_context_notifier(BlockDriverState *bs, |
4823 | void (*attached_aio_context)(AioContext *new_context, void *opaque), | |
4824 | void (*detach_aio_context)(void *opaque), void *opaque) | |
4825 | { | |
4826 | BdrvAioNotifier *ban = g_new(BdrvAioNotifier, 1); | |
4827 | *ban = (BdrvAioNotifier){ | |
4828 | .attached_aio_context = attached_aio_context, | |
4829 | .detach_aio_context = detach_aio_context, | |
4830 | .opaque = opaque | |
4831 | }; | |
4832 | ||
4833 | QLIST_INSERT_HEAD(&bs->aio_notifiers, ban, list); | |
4834 | } | |
4835 | ||
4836 | void bdrv_remove_aio_context_notifier(BlockDriverState *bs, | |
4837 | void (*attached_aio_context)(AioContext *, | |
4838 | void *), | |
4839 | void (*detach_aio_context)(void *), | |
4840 | void *opaque) | |
4841 | { | |
4842 | BdrvAioNotifier *ban, *ban_next; | |
4843 | ||
4844 | QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) { | |
4845 | if (ban->attached_aio_context == attached_aio_context && | |
4846 | ban->detach_aio_context == detach_aio_context && | |
e8a095da SH |
4847 | ban->opaque == opaque && |
4848 | ban->deleted == false) | |
33384421 | 4849 | { |
e8a095da SH |
4850 | if (bs->walking_aio_notifiers) { |
4851 | ban->deleted = true; | |
4852 | } else { | |
4853 | bdrv_do_remove_aio_context_notifier(ban); | |
4854 | } | |
33384421 HR |
4855 | return; |
4856 | } | |
4857 | } | |
4858 | ||
4859 | abort(); | |
4860 | } | |
4861 | ||
77485434 | 4862 | int bdrv_amend_options(BlockDriverState *bs, QemuOpts *opts, |
8b13976d | 4863 | BlockDriverAmendStatusCB *status_cb, void *cb_opaque) |
6f176b48 | 4864 | { |
d470ad42 HR |
4865 | if (!bs->drv) { |
4866 | return -ENOMEDIUM; | |
4867 | } | |
c282e1fd | 4868 | if (!bs->drv->bdrv_amend_options) { |
6f176b48 HR |
4869 | return -ENOTSUP; |
4870 | } | |
8b13976d | 4871 | return bs->drv->bdrv_amend_options(bs, opts, status_cb, cb_opaque); |
6f176b48 | 4872 | } |
f6186f49 | 4873 | |
b5042a36 BC |
4874 | /* This function will be called by the bdrv_recurse_is_first_non_filter method |
4875 | * of block filter and by bdrv_is_first_non_filter. | |
4876 | * It is used to test if the given bs is the candidate or recurse more in the | |
4877 | * node graph. | |
212a5a8f | 4878 | */ |
b5042a36 | 4879 | bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs, |
212a5a8f | 4880 | BlockDriverState *candidate) |
f6186f49 | 4881 | { |
b5042a36 BC |
4882 | /* return false if basic checks fails */ |
4883 | if (!bs || !bs->drv) { | |
212a5a8f | 4884 | return false; |
f6186f49 BC |
4885 | } |
4886 | ||
b5042a36 BC |
4887 | /* the code reached a non block filter driver -> check if the bs is |
4888 | * the same as the candidate. It's the recursion termination condition. | |
4889 | */ | |
4890 | if (!bs->drv->is_filter) { | |
4891 | return bs == candidate; | |
212a5a8f | 4892 | } |
b5042a36 | 4893 | /* Down this path the driver is a block filter driver */ |
212a5a8f | 4894 | |
b5042a36 BC |
4895 | /* If the block filter recursion method is defined use it to recurse down |
4896 | * the node graph. | |
4897 | */ | |
4898 | if (bs->drv->bdrv_recurse_is_first_non_filter) { | |
212a5a8f | 4899 | return bs->drv->bdrv_recurse_is_first_non_filter(bs, candidate); |
f6186f49 BC |
4900 | } |
4901 | ||
b5042a36 BC |
4902 | /* the driver is a block filter but don't allow to recurse -> return false |
4903 | */ | |
4904 | return false; | |
f6186f49 BC |
4905 | } |
4906 | ||
212a5a8f BC |
4907 | /* This function checks if the candidate is the first non filter bs down it's |
4908 | * bs chain. Since we don't have pointers to parents it explore all bs chains | |
4909 | * from the top. Some filters can choose not to pass down the recursion. | |
4910 | */ | |
4911 | bool bdrv_is_first_non_filter(BlockDriverState *candidate) | |
f6186f49 | 4912 | { |
7c8eece4 | 4913 | BlockDriverState *bs; |
88be7b4b | 4914 | BdrvNextIterator it; |
212a5a8f BC |
4915 | |
4916 | /* walk down the bs forest recursively */ | |
88be7b4b | 4917 | for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) { |
212a5a8f BC |
4918 | bool perm; |
4919 | ||
b5042a36 | 4920 | /* try to recurse in this top level bs */ |
e6dc8a1f | 4921 | perm = bdrv_recurse_is_first_non_filter(bs, candidate); |
212a5a8f BC |
4922 | |
4923 | /* candidate is the first non filter */ | |
4924 | if (perm) { | |
5e003f17 | 4925 | bdrv_next_cleanup(&it); |
212a5a8f BC |
4926 | return true; |
4927 | } | |
4928 | } | |
4929 | ||
4930 | return false; | |
f6186f49 | 4931 | } |
09158f00 | 4932 | |
e12f3784 WC |
4933 | BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs, |
4934 | const char *node_name, Error **errp) | |
09158f00 BC |
4935 | { |
4936 | BlockDriverState *to_replace_bs = bdrv_find_node(node_name); | |
5a7e7a0b SH |
4937 | AioContext *aio_context; |
4938 | ||
09158f00 BC |
4939 | if (!to_replace_bs) { |
4940 | error_setg(errp, "Node name '%s' not found", node_name); | |
4941 | return NULL; | |
4942 | } | |
4943 | ||
5a7e7a0b SH |
4944 | aio_context = bdrv_get_aio_context(to_replace_bs); |
4945 | aio_context_acquire(aio_context); | |
4946 | ||
09158f00 | 4947 | if (bdrv_op_is_blocked(to_replace_bs, BLOCK_OP_TYPE_REPLACE, errp)) { |
5a7e7a0b SH |
4948 | to_replace_bs = NULL; |
4949 | goto out; | |
09158f00 BC |
4950 | } |
4951 | ||
4952 | /* We don't want arbitrary node of the BDS chain to be replaced only the top | |
4953 | * most non filter in order to prevent data corruption. | |
4954 | * Another benefit is that this tests exclude backing files which are | |
4955 | * blocked by the backing blockers. | |
4956 | */ | |
e12f3784 | 4957 | if (!bdrv_recurse_is_first_non_filter(parent_bs, to_replace_bs)) { |
09158f00 | 4958 | error_setg(errp, "Only top most non filter can be replaced"); |
5a7e7a0b SH |
4959 | to_replace_bs = NULL; |
4960 | goto out; | |
09158f00 BC |
4961 | } |
4962 | ||
5a7e7a0b SH |
4963 | out: |
4964 | aio_context_release(aio_context); | |
09158f00 BC |
4965 | return to_replace_bs; |
4966 | } | |
448ad91d | 4967 | |
91af7014 HR |
4968 | static bool append_open_options(QDict *d, BlockDriverState *bs) |
4969 | { | |
4970 | const QDictEntry *entry; | |
9e700c1a | 4971 | QemuOptDesc *desc; |
260fecf1 | 4972 | BdrvChild *child; |
91af7014 | 4973 | bool found_any = false; |
260fecf1 | 4974 | const char *p; |
91af7014 HR |
4975 | |
4976 | for (entry = qdict_first(bs->options); entry; | |
4977 | entry = qdict_next(bs->options, entry)) | |
4978 | { | |
260fecf1 KW |
4979 | /* Exclude options for children */ |
4980 | QLIST_FOREACH(child, &bs->children, next) { | |
4981 | if (strstart(qdict_entry_key(entry), child->name, &p) | |
4982 | && (!*p || *p == '.')) | |
4983 | { | |
4984 | break; | |
4985 | } | |
4986 | } | |
4987 | if (child) { | |
9e700c1a | 4988 | continue; |
91af7014 | 4989 | } |
9e700c1a KW |
4990 | |
4991 | /* And exclude all non-driver-specific options */ | |
4992 | for (desc = bdrv_runtime_opts.desc; desc->name; desc++) { | |
4993 | if (!strcmp(qdict_entry_key(entry), desc->name)) { | |
4994 | break; | |
4995 | } | |
4996 | } | |
4997 | if (desc->name) { | |
4998 | continue; | |
4999 | } | |
5000 | ||
5001 | qobject_incref(qdict_entry_value(entry)); | |
5002 | qdict_put_obj(d, qdict_entry_key(entry), qdict_entry_value(entry)); | |
5003 | found_any = true; | |
91af7014 HR |
5004 | } |
5005 | ||
5006 | return found_any; | |
5007 | } | |
5008 | ||
5009 | /* Updates the following BDS fields: | |
5010 | * - exact_filename: A filename which may be used for opening a block device | |
5011 | * which (mostly) equals the given BDS (even without any | |
5012 | * other options; so reading and writing must return the same | |
5013 | * results, but caching etc. may be different) | |
5014 | * - full_open_options: Options which, when given when opening a block device | |
5015 | * (without a filename), result in a BDS (mostly) | |
5016 | * equalling the given one | |
5017 | * - filename: If exact_filename is set, it is copied here. Otherwise, | |
5018 | * full_open_options is converted to a JSON object, prefixed with | |
5019 | * "json:" (for use through the JSON pseudo protocol) and put here. | |
5020 | */ | |
5021 | void bdrv_refresh_filename(BlockDriverState *bs) | |
5022 | { | |
5023 | BlockDriver *drv = bs->drv; | |
5024 | QDict *opts; | |
5025 | ||
5026 | if (!drv) { | |
5027 | return; | |
5028 | } | |
5029 | ||
5030 | /* This BDS's file name will most probably depend on its file's name, so | |
5031 | * refresh that first */ | |
5032 | if (bs->file) { | |
9a4f4c31 | 5033 | bdrv_refresh_filename(bs->file->bs); |
91af7014 HR |
5034 | } |
5035 | ||
5036 | if (drv->bdrv_refresh_filename) { | |
5037 | /* Obsolete information is of no use here, so drop the old file name | |
5038 | * information before refreshing it */ | |
5039 | bs->exact_filename[0] = '\0'; | |
5040 | if (bs->full_open_options) { | |
5041 | QDECREF(bs->full_open_options); | |
5042 | bs->full_open_options = NULL; | |
5043 | } | |
5044 | ||
4cdd01d3 KW |
5045 | opts = qdict_new(); |
5046 | append_open_options(opts, bs); | |
5047 | drv->bdrv_refresh_filename(bs, opts); | |
5048 | QDECREF(opts); | |
91af7014 HR |
5049 | } else if (bs->file) { |
5050 | /* Try to reconstruct valid information from the underlying file */ | |
5051 | bool has_open_options; | |
5052 | ||
5053 | bs->exact_filename[0] = '\0'; | |
5054 | if (bs->full_open_options) { | |
5055 | QDECREF(bs->full_open_options); | |
5056 | bs->full_open_options = NULL; | |
5057 | } | |
5058 | ||
5059 | opts = qdict_new(); | |
5060 | has_open_options = append_open_options(opts, bs); | |
5061 | ||
5062 | /* If no specific options have been given for this BDS, the filename of | |
5063 | * the underlying file should suffice for this one as well */ | |
9a4f4c31 KW |
5064 | if (bs->file->bs->exact_filename[0] && !has_open_options) { |
5065 | strcpy(bs->exact_filename, bs->file->bs->exact_filename); | |
91af7014 HR |
5066 | } |
5067 | /* Reconstructing the full options QDict is simple for most format block | |
5068 | * drivers, as long as the full options are known for the underlying | |
5069 | * file BDS. The full options QDict of that file BDS should somehow | |
5070 | * contain a representation of the filename, therefore the following | |
5071 | * suffices without querying the (exact_)filename of this BDS. */ | |
9a4f4c31 | 5072 | if (bs->file->bs->full_open_options) { |
46f5ac20 | 5073 | qdict_put_str(opts, "driver", drv->format_name); |
9a4f4c31 | 5074 | QINCREF(bs->file->bs->full_open_options); |
de6e7951 | 5075 | qdict_put(opts, "file", bs->file->bs->full_open_options); |
91af7014 HR |
5076 | |
5077 | bs->full_open_options = opts; | |
5078 | } else { | |
5079 | QDECREF(opts); | |
5080 | } | |
5081 | } else if (!bs->full_open_options && qdict_size(bs->options)) { | |
5082 | /* There is no underlying file BDS (at least referenced by BDS.file), | |
5083 | * so the full options QDict should be equal to the options given | |
5084 | * specifically for this block device when it was opened (plus the | |
5085 | * driver specification). | |
5086 | * Because those options don't change, there is no need to update | |
5087 | * full_open_options when it's already set. */ | |
5088 | ||
5089 | opts = qdict_new(); | |
5090 | append_open_options(opts, bs); | |
46f5ac20 | 5091 | qdict_put_str(opts, "driver", drv->format_name); |
91af7014 HR |
5092 | |
5093 | if (bs->exact_filename[0]) { | |
5094 | /* This may not work for all block protocol drivers (some may | |
5095 | * require this filename to be parsed), but we have to find some | |
5096 | * default solution here, so just include it. If some block driver | |
5097 | * does not support pure options without any filename at all or | |
5098 | * needs some special format of the options QDict, it needs to | |
5099 | * implement the driver-specific bdrv_refresh_filename() function. | |
5100 | */ | |
46f5ac20 | 5101 | qdict_put_str(opts, "filename", bs->exact_filename); |
91af7014 HR |
5102 | } |
5103 | ||
5104 | bs->full_open_options = opts; | |
5105 | } | |
5106 | ||
5107 | if (bs->exact_filename[0]) { | |
5108 | pstrcpy(bs->filename, sizeof(bs->filename), bs->exact_filename); | |
5109 | } else if (bs->full_open_options) { | |
5110 | QString *json = qobject_to_json(QOBJECT(bs->full_open_options)); | |
5111 | snprintf(bs->filename, sizeof(bs->filename), "json:%s", | |
5112 | qstring_get_str(json)); | |
5113 | QDECREF(json); | |
5114 | } | |
5115 | } | |
e06018ad WC |
5116 | |
5117 | /* | |
5118 | * Hot add/remove a BDS's child. So the user can take a child offline when | |
5119 | * it is broken and take a new child online | |
5120 | */ | |
5121 | void bdrv_add_child(BlockDriverState *parent_bs, BlockDriverState *child_bs, | |
5122 | Error **errp) | |
5123 | { | |
5124 | ||
5125 | if (!parent_bs->drv || !parent_bs->drv->bdrv_add_child) { | |
5126 | error_setg(errp, "The node %s does not support adding a child", | |
5127 | bdrv_get_device_or_node_name(parent_bs)); | |
5128 | return; | |
5129 | } | |
5130 | ||
5131 | if (!QLIST_EMPTY(&child_bs->parents)) { | |
5132 | error_setg(errp, "The node %s already has a parent", | |
5133 | child_bs->node_name); | |
5134 | return; | |
5135 | } | |
5136 | ||
5137 | parent_bs->drv->bdrv_add_child(parent_bs, child_bs, errp); | |
5138 | } | |
5139 | ||
5140 | void bdrv_del_child(BlockDriverState *parent_bs, BdrvChild *child, Error **errp) | |
5141 | { | |
5142 | BdrvChild *tmp; | |
5143 | ||
5144 | if (!parent_bs->drv || !parent_bs->drv->bdrv_del_child) { | |
5145 | error_setg(errp, "The node %s does not support removing a child", | |
5146 | bdrv_get_device_or_node_name(parent_bs)); | |
5147 | return; | |
5148 | } | |
5149 | ||
5150 | QLIST_FOREACH(tmp, &parent_bs->children, next) { | |
5151 | if (tmp == child) { | |
5152 | break; | |
5153 | } | |
5154 | } | |
5155 | ||
5156 | if (!tmp) { | |
5157 | error_setg(errp, "The node %s does not have a child named %s", | |
5158 | bdrv_get_device_or_node_name(parent_bs), | |
5159 | bdrv_get_device_or_node_name(child->bs)); | |
5160 | return; | |
5161 | } | |
5162 | ||
5163 | parent_bs->drv->bdrv_del_child(parent_bs, child, errp); | |
5164 | } | |
67b792f5 VSO |
5165 | |
5166 | bool bdrv_can_store_new_dirty_bitmap(BlockDriverState *bs, const char *name, | |
5167 | uint32_t granularity, Error **errp) | |
5168 | { | |
5169 | BlockDriver *drv = bs->drv; | |
5170 | ||
5171 | if (!drv) { | |
5172 | error_setg_errno(errp, ENOMEDIUM, | |
5173 | "Can't store persistent bitmaps to %s", | |
5174 | bdrv_get_device_or_node_name(bs)); | |
5175 | return false; | |
5176 | } | |
5177 | ||
5178 | if (!drv->bdrv_can_store_new_dirty_bitmap) { | |
5179 | error_setg_errno(errp, ENOTSUP, | |
5180 | "Can't store persistent bitmaps to %s", | |
5181 | bdrv_get_device_or_node_name(bs)); | |
5182 | return false; | |
5183 | } | |
5184 | ||
5185 | return drv->bdrv_can_store_new_dirty_bitmap(bs, name, granularity, errp); | |
5186 | } |