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