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