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