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