OSDN Git Service

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