2 * Block layer snapshot related functions
4 * Copyright (c) 2003-2008 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #include "qemu/osdep.h"
26 #include "block/snapshot.h"
27 #include "block/block_int.h"
28 #include "block/qdict.h"
29 #include "qapi/error.h"
30 #include "qapi/qmp/qdict.h"
31 #include "qapi/qmp/qerror.h"
32 #include "qapi/qmp/qstring.h"
33 #include "qemu/option.h"
34 #include "sysemu/block-backend.h"
36 QemuOptsList internal_snapshot_opts
= {
38 .head
= QTAILQ_HEAD_INITIALIZER(internal_snapshot_opts
.head
),
41 .name
= SNAPSHOT_OPT_ID
,
42 .type
= QEMU_OPT_STRING
,
45 .name
= SNAPSHOT_OPT_NAME
,
46 .type
= QEMU_OPT_STRING
,
47 .help
= "snapshot name"
54 int bdrv_snapshot_find(BlockDriverState
*bs
, QEMUSnapshotInfo
*sn_info
,
57 QEMUSnapshotInfo
*sn_tab
, *sn
;
63 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
67 for (i
= 0; i
< nb_sns
; i
++) {
69 if (!strcmp(sn
->name
, name
)) {
80 * Look up an internal snapshot by @id and @name.
81 * @bs: block device to search
82 * @id: unique snapshot ID, or NULL
83 * @name: snapshot name, or NULL
84 * @sn_info: location to store information on the snapshot found
85 * @errp: location to store error, will be set only for exception
87 * This function will traverse snapshot list in @bs to search the matching
88 * one, @id and @name are the matching condition:
89 * If both @id and @name are specified, find the first one with id @id and
91 * If only @id is specified, find the first one with id @id.
92 * If only @name is specified, find the first one with name @name.
93 * if none is specified, abort().
95 * Returns: true when a snapshot is found and @sn_info will be filled, false
96 * when error or not found. If all operation succeed but no matching one is
97 * found, @errp will NOT be set.
99 bool bdrv_snapshot_find_by_id_and_name(BlockDriverState
*bs
,
102 QEMUSnapshotInfo
*sn_info
,
105 QEMUSnapshotInfo
*sn_tab
, *sn
;
112 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
114 error_setg_errno(errp
, -nb_sns
, "Failed to get a snapshot list");
116 } else if (nb_sns
== 0) {
121 for (i
= 0; i
< nb_sns
; i
++) {
123 if (!strcmp(sn
->id_str
, id
) && !strcmp(sn
->name
, name
)) {
130 for (i
= 0; i
< nb_sns
; i
++) {
132 if (!strcmp(sn
->id_str
, id
)) {
139 for (i
= 0; i
< nb_sns
; i
++) {
141 if (!strcmp(sn
->name
, name
)) {
154 * Return a pointer to child of given BDS to which we can fall
155 * back if the given BDS does not support snapshots.
156 * Return NULL if there is no BDS to (safely) fall back to.
158 static BdrvChild
* GRAPH_RDLOCK
159 bdrv_snapshot_fallback_child(BlockDriverState
*bs
)
161 BdrvChild
*fallback
= bdrv_primary_child(bs
);
165 assert_bdrv_graph_readable();
167 /* We allow fallback only to primary child */
173 * Check that there are no other children that would need to be
174 * snapshotted. If there are, it is not safe to fall back to
177 QLIST_FOREACH(child
, &bs
->children
, next
) {
178 if (child
->role
& (BDRV_CHILD_DATA
| BDRV_CHILD_METADATA
|
179 BDRV_CHILD_FILTERED
) &&
189 static BlockDriverState
* GRAPH_RDLOCK
190 bdrv_snapshot_fallback(BlockDriverState
*bs
)
193 return child_bs(bdrv_snapshot_fallback_child(bs
));
196 int bdrv_can_snapshot(BlockDriverState
*bs
)
198 BlockDriver
*drv
= bs
->drv
;
202 if (!drv
|| !bdrv_is_inserted(bs
) || !bdrv_is_writable(bs
)) {
206 if (!drv
->bdrv_snapshot_create
) {
207 BlockDriverState
*fallback_bs
= bdrv_snapshot_fallback(bs
);
209 return bdrv_can_snapshot(fallback_bs
);
217 int bdrv_snapshot_create(BlockDriverState
*bs
,
218 QEMUSnapshotInfo
*sn_info
)
220 BlockDriver
*drv
= bs
->drv
;
221 BlockDriverState
*fallback_bs
= bdrv_snapshot_fallback(bs
);
228 if (drv
->bdrv_snapshot_create
) {
229 return drv
->bdrv_snapshot_create(bs
, sn_info
);
232 return bdrv_snapshot_create(fallback_bs
, sn_info
);
237 int bdrv_snapshot_goto(BlockDriverState
*bs
,
238 const char *snapshot_id
,
241 BlockDriver
*drv
= bs
->drv
;
248 error_setg(errp
, "Block driver is closed");
252 if (!QLIST_EMPTY(&bs
->dirty_bitmaps
)) {
253 error_setg(errp
, "Device has active dirty bitmaps");
257 if (drv
->bdrv_snapshot_goto
) {
258 ret
= drv
->bdrv_snapshot_goto(bs
, snapshot_id
);
260 error_setg_errno(errp
, -ret
, "Failed to load snapshot");
265 bdrv_graph_rdlock_main_loop();
266 fallback
= bdrv_snapshot_fallback_child(bs
);
267 bdrv_graph_rdunlock_main_loop();
272 Error
*local_err
= NULL
;
273 BlockDriverState
*fallback_bs
= fallback
->bs
;
274 char *subqdict_prefix
= g_strdup_printf("%s.", fallback
->name
);
276 options
= qdict_clone_shallow(bs
->options
);
278 /* Prevent it from getting deleted when detached from bs */
279 bdrv_ref(fallback_bs
);
281 qdict_extract_subqdict(options
, &file_options
, subqdict_prefix
);
282 qobject_unref(file_options
);
283 g_free(subqdict_prefix
);
285 /* Force .bdrv_open() below to re-attach fallback_bs on fallback */
286 qdict_put_str(options
, fallback
->name
,
287 bdrv_get_node_name(fallback_bs
));
289 /* Now close bs, apply the snapshot on fallback_bs, and re-open bs */
290 if (drv
->bdrv_close
) {
294 /* .bdrv_open() will re-attach it */
296 bdrv_unref_child(bs
, fallback
);
297 bdrv_graph_wrunlock();
299 ret
= bdrv_snapshot_goto(fallback_bs
, snapshot_id
, errp
);
300 open_ret
= drv
->bdrv_open(bs
, options
, bs
->open_flags
, &local_err
);
301 qobject_unref(options
);
303 bdrv_unref(fallback_bs
);
305 /* A bdrv_snapshot_goto() error takes precedence */
306 error_propagate(errp
, local_err
);
307 return ret
< 0 ? ret
: open_ret
;
311 * fallback was a primary child. It was closed above and set to NULL,
312 * but the .bdrv_open() call has opened it again, because we set the
313 * respective option (with the qdict_put_str() call above).
314 * Assert that .bdrv_open() has attached the right BDS as primary child.
316 bdrv_graph_rdlock_main_loop();
317 assert(bdrv_primary_bs(bs
) == fallback_bs
);
318 bdrv_graph_rdunlock_main_loop();
320 bdrv_unref(fallback_bs
);
324 error_setg(errp
, "Block driver does not support snapshots");
329 * Delete an internal snapshot by @snapshot_id and @name.
330 * @bs: block device used in the operation
331 * @snapshot_id: unique snapshot ID, or NULL
332 * @name: snapshot name, or NULL
333 * @errp: location to store error
335 * If both @snapshot_id and @name are specified, delete the first one with
336 * id @snapshot_id and name @name.
337 * If only @snapshot_id is specified, delete the first one with id
339 * If only @name is specified, delete the first one with name @name.
340 * if none is specified, return -EINVAL.
342 * Returns: 0 on success, -errno on failure. If @bs is not inserted, return
343 * -ENOMEDIUM. If @snapshot_id and @name are both NULL, return -EINVAL. If @bs
344 * does not support internal snapshot deletion, return -ENOTSUP. If @bs does
345 * not support parameter @snapshot_id or @name, or one of them is not correctly
346 * specified, return -EINVAL. If @bs can't find one matching @id and @name,
347 * return -ENOENT. If @errp != NULL, it will always be filled with error
348 * message on failure.
350 int bdrv_snapshot_delete(BlockDriverState
*bs
,
351 const char *snapshot_id
,
355 BlockDriver
*drv
= bs
->drv
;
356 BlockDriverState
*fallback_bs
= bdrv_snapshot_fallback(bs
);
362 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, bdrv_get_device_name(bs
));
365 if (!snapshot_id
&& !name
) {
366 error_setg(errp
, "snapshot_id and name are both NULL");
370 /* drain all pending i/o before deleting snapshot */
371 bdrv_drained_begin(bs
);
373 if (drv
->bdrv_snapshot_delete
) {
374 ret
= drv
->bdrv_snapshot_delete(bs
, snapshot_id
, name
, errp
);
375 } else if (fallback_bs
) {
376 ret
= bdrv_snapshot_delete(fallback_bs
, snapshot_id
, name
, errp
);
378 error_setg(errp
, "Block format '%s' used by device '%s' "
379 "does not support internal snapshot deletion",
380 drv
->format_name
, bdrv_get_device_name(bs
));
384 bdrv_drained_end(bs
);
388 int bdrv_snapshot_list(BlockDriverState
*bs
,
389 QEMUSnapshotInfo
**psn_info
)
392 GRAPH_RDLOCK_GUARD_MAINLOOP();
394 BlockDriver
*drv
= bs
->drv
;
395 BlockDriverState
*fallback_bs
= bdrv_snapshot_fallback(bs
);
400 if (drv
->bdrv_snapshot_list
) {
401 return drv
->bdrv_snapshot_list(bs
, psn_info
);
404 return bdrv_snapshot_list(fallback_bs
, psn_info
);
410 * Temporarily load an internal snapshot by @snapshot_id and @name.
411 * @bs: block device used in the operation
412 * @snapshot_id: unique snapshot ID, or NULL
413 * @name: snapshot name, or NULL
414 * @errp: location to store error
416 * If both @snapshot_id and @name are specified, load the first one with
417 * id @snapshot_id and name @name.
418 * If only @snapshot_id is specified, load the first one with id
420 * If only @name is specified, load the first one with name @name.
421 * if none is specified, return -EINVAL.
423 * Returns: 0 on success, -errno on fail. If @bs is not inserted, return
424 * -ENOMEDIUM. If @bs is not readonly, return -EINVAL. If @bs did not support
425 * internal snapshot, return -ENOTSUP. If qemu can't find a matching @id and
426 * @name, return -ENOENT. If @errp != NULL, it will always be filled on
429 int bdrv_snapshot_load_tmp(BlockDriverState
*bs
,
430 const char *snapshot_id
,
434 BlockDriver
*drv
= bs
->drv
;
437 GRAPH_RDLOCK_GUARD_MAINLOOP();
440 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, bdrv_get_device_name(bs
));
443 if (!snapshot_id
&& !name
) {
444 error_setg(errp
, "snapshot_id and name are both NULL");
447 if (!bdrv_is_read_only(bs
)) {
448 error_setg(errp
, "Device is not readonly");
451 if (drv
->bdrv_snapshot_load_tmp
) {
452 return drv
->bdrv_snapshot_load_tmp(bs
, snapshot_id
, name
, errp
);
454 error_setg(errp
, "Block format '%s' used by device '%s' "
455 "does not support temporarily loading internal snapshots",
456 drv
->format_name
, bdrv_get_device_name(bs
));
460 int bdrv_snapshot_load_tmp_by_id_or_name(BlockDriverState
*bs
,
461 const char *id_or_name
,
465 Error
*local_err
= NULL
;
469 ret
= bdrv_snapshot_load_tmp(bs
, id_or_name
, NULL
, &local_err
);
470 if (ret
== -ENOENT
|| ret
== -EINVAL
) {
471 error_free(local_err
);
473 ret
= bdrv_snapshot_load_tmp(bs
, NULL
, id_or_name
, &local_err
);
476 error_propagate(errp
, local_err
);
482 static int GRAPH_RDLOCK
483 bdrv_all_get_snapshot_devices(bool has_devices
, strList
*devices
,
484 GList
**all_bdrvs
, Error
**errp
)
486 g_autoptr(GList
) bdrvs
= NULL
;
490 error_setg(errp
, "At least one device is required for snapshot");
495 BlockDriverState
*bs
= bdrv_find_node(devices
->value
);
497 error_setg(errp
, "No block device node '%s'", devices
->value
);
500 bdrvs
= g_list_append(bdrvs
, bs
);
501 devices
= devices
->next
;
504 BlockDriverState
*bs
;
506 for (bs
= bdrv_first(&it
); bs
; bs
= bdrv_next(&it
)) {
507 bdrvs
= g_list_append(bdrvs
, bs
);
511 *all_bdrvs
= g_steal_pointer(&bdrvs
);
516 static bool GRAPH_RDLOCK
bdrv_all_snapshots_includes_bs(BlockDriverState
*bs
)
519 assert_bdrv_graph_readable();
521 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
525 /* Include all nodes that are either in use by a BlockBackend, or that
526 * aren't attached to any node, but owned by the monitor. */
527 return bdrv_has_blk(bs
) || QLIST_EMPTY(&bs
->parents
);
530 /* Group operations. All block drivers are involved. */
532 bool bdrv_all_can_snapshot(bool has_devices
, strList
*devices
,
535 g_autoptr(GList
) bdrvs
= NULL
;
539 GRAPH_RDLOCK_GUARD_MAINLOOP();
541 if (bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
) < 0) {
547 BlockDriverState
*bs
= iterbdrvs
->data
;
550 if (devices
|| bdrv_all_snapshots_includes_bs(bs
)) {
551 ok
= bdrv_can_snapshot(bs
);
554 error_setg(errp
, "Device '%s' is writable but does not support "
555 "snapshots", bdrv_get_device_or_node_name(bs
));
559 iterbdrvs
= iterbdrvs
->next
;
565 int bdrv_all_delete_snapshot(const char *name
,
566 bool has_devices
, strList
*devices
,
569 g_autoptr(GList
) bdrvs
= NULL
;
573 GRAPH_RDLOCK_GUARD_MAINLOOP();
575 if (bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
) < 0) {
581 BlockDriverState
*bs
= iterbdrvs
->data
;
582 QEMUSnapshotInfo sn1
, *snapshot
= &sn1
;
585 if ((devices
|| bdrv_all_snapshots_includes_bs(bs
)) &&
586 bdrv_snapshot_find(bs
, snapshot
, name
) >= 0)
588 ret
= bdrv_snapshot_delete(bs
, snapshot
->id_str
,
589 snapshot
->name
, errp
);
592 error_prepend(errp
, "Could not delete snapshot '%s' on '%s': ",
593 name
, bdrv_get_device_or_node_name(bs
));
597 iterbdrvs
= iterbdrvs
->next
;
604 int bdrv_all_goto_snapshot(const char *name
,
605 bool has_devices
, strList
*devices
,
608 g_autoptr(GList
) bdrvs
= NULL
;
614 bdrv_graph_rdlock_main_loop();
615 ret
= bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
);
616 bdrv_graph_rdunlock_main_loop();
624 BlockDriverState
*bs
= iterbdrvs
->data
;
625 bool all_snapshots_includes_bs
;
627 bdrv_graph_rdlock_main_loop();
628 all_snapshots_includes_bs
= bdrv_all_snapshots_includes_bs(bs
);
629 bdrv_graph_rdunlock_main_loop();
631 ret
= (devices
|| all_snapshots_includes_bs
) ?
632 bdrv_snapshot_goto(bs
, name
, errp
) : 0;
634 bdrv_graph_rdlock_main_loop();
635 error_prepend(errp
, "Could not load snapshot '%s' on '%s': ",
636 name
, bdrv_get_device_or_node_name(bs
));
637 bdrv_graph_rdunlock_main_loop();
641 iterbdrvs
= iterbdrvs
->next
;
647 int bdrv_all_has_snapshot(const char *name
,
648 bool has_devices
, strList
*devices
,
651 g_autoptr(GList
) bdrvs
= NULL
;
655 GRAPH_RDLOCK_GUARD_MAINLOOP();
657 if (bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
) < 0) {
663 BlockDriverState
*bs
= iterbdrvs
->data
;
667 if (devices
|| bdrv_all_snapshots_includes_bs(bs
)) {
668 ret
= bdrv_snapshot_find(bs
, &sn
, name
);
671 if (ret
== -ENOENT
) {
674 error_setg_errno(errp
, errno
,
675 "Could not check snapshot '%s' on '%s'",
676 name
, bdrv_get_device_or_node_name(bs
));
681 iterbdrvs
= iterbdrvs
->next
;
687 int bdrv_all_create_snapshot(QEMUSnapshotInfo
*sn
,
688 BlockDriverState
*vm_state_bs
,
689 uint64_t vm_state_size
,
690 bool has_devices
, strList
*devices
,
693 g_autoptr(GList
) bdrvs
= NULL
;
697 GRAPH_RDLOCK_GUARD_MAINLOOP();
699 if (bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
) < 0) {
705 BlockDriverState
*bs
= iterbdrvs
->data
;
708 if (bs
== vm_state_bs
) {
709 sn
->vm_state_size
= vm_state_size
;
710 ret
= bdrv_snapshot_create(bs
, sn
);
711 } else if (devices
|| bdrv_all_snapshots_includes_bs(bs
)) {
712 sn
->vm_state_size
= 0;
713 ret
= bdrv_snapshot_create(bs
, sn
);
716 error_setg(errp
, "Could not create snapshot '%s' on '%s'",
717 sn
->name
, bdrv_get_device_or_node_name(bs
));
721 iterbdrvs
= iterbdrvs
->next
;
728 BlockDriverState
*bdrv_all_find_vmstate_bs(const char *vmstate_bs
,
729 bool has_devices
, strList
*devices
,
732 g_autoptr(GList
) bdrvs
= NULL
;
736 GRAPH_RDLOCK_GUARD_MAINLOOP();
738 if (bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
) < 0) {
744 BlockDriverState
*bs
= iterbdrvs
->data
;
747 found
= (devices
|| bdrv_all_snapshots_includes_bs(bs
)) &&
748 bdrv_can_snapshot(bs
);
751 if (g_str_equal(vmstate_bs
,
752 bdrv_get_node_name(bs
))) {
757 "vmstate block device '%s' does not support snapshots",
766 iterbdrvs
= iterbdrvs
->next
;
771 "vmstate block device '%s' does not exist", vmstate_bs
);
774 "no block device can store vmstate for snapshot");