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