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
*bdrv_snapshot_fallback_child(BlockDriverState
*bs
)
160 BdrvChild
*fallback
= bdrv_primary_child(bs
);
163 /* We allow fallback only to primary child */
169 * Check that there are no other children that would need to be
170 * snapshotted. If there are, it is not safe to fall back to
173 QLIST_FOREACH(child
, &bs
->children
, next
) {
174 if (child
->role
& (BDRV_CHILD_DATA
| BDRV_CHILD_METADATA
|
175 BDRV_CHILD_FILTERED
) &&
185 static BlockDriverState
*bdrv_snapshot_fallback(BlockDriverState
*bs
)
187 return child_bs(bdrv_snapshot_fallback_child(bs
));
190 int bdrv_can_snapshot(BlockDriverState
*bs
)
192 BlockDriver
*drv
= bs
->drv
;
194 if (!drv
|| !bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
198 if (!drv
->bdrv_snapshot_create
) {
199 BlockDriverState
*fallback_bs
= bdrv_snapshot_fallback(bs
);
201 return bdrv_can_snapshot(fallback_bs
);
209 int bdrv_snapshot_create(BlockDriverState
*bs
,
210 QEMUSnapshotInfo
*sn_info
)
212 BlockDriver
*drv
= bs
->drv
;
213 BlockDriverState
*fallback_bs
= bdrv_snapshot_fallback(bs
);
220 if (drv
->bdrv_snapshot_create
) {
221 return drv
->bdrv_snapshot_create(bs
, sn_info
);
224 return bdrv_snapshot_create(fallback_bs
, sn_info
);
229 int bdrv_snapshot_goto(BlockDriverState
*bs
,
230 const char *snapshot_id
,
233 BlockDriver
*drv
= bs
->drv
;
240 error_setg(errp
, "Block driver is closed");
244 if (!QLIST_EMPTY(&bs
->dirty_bitmaps
)) {
245 error_setg(errp
, "Device has active dirty bitmaps");
249 if (drv
->bdrv_snapshot_goto
) {
250 ret
= drv
->bdrv_snapshot_goto(bs
, snapshot_id
);
252 error_setg_errno(errp
, -ret
, "Failed to load snapshot");
257 fallback
= bdrv_snapshot_fallback_child(bs
);
261 Error
*local_err
= NULL
;
262 BlockDriverState
*fallback_bs
= fallback
->bs
;
263 char *subqdict_prefix
= g_strdup_printf("%s.", fallback
->name
);
265 options
= qdict_clone_shallow(bs
->options
);
267 /* Prevent it from getting deleted when detached from bs */
268 bdrv_ref(fallback_bs
);
270 qdict_extract_subqdict(options
, &file_options
, subqdict_prefix
);
271 qobject_unref(file_options
);
272 g_free(subqdict_prefix
);
274 /* Force .bdrv_open() below to re-attach fallback_bs on fallback */
275 qdict_put_str(options
, fallback
->name
,
276 bdrv_get_node_name(fallback_bs
));
278 /* Now close bs, apply the snapshot on fallback_bs, and re-open bs */
279 if (drv
->bdrv_close
) {
283 /* .bdrv_open() will re-attach it */
284 bdrv_graph_wrlock(NULL
);
285 bdrv_unref_child(bs
, fallback
);
286 bdrv_graph_wrunlock();
288 ret
= bdrv_snapshot_goto(fallback_bs
, snapshot_id
, errp
);
289 open_ret
= drv
->bdrv_open(bs
, options
, bs
->open_flags
, &local_err
);
290 qobject_unref(options
);
292 bdrv_unref(fallback_bs
);
294 /* A bdrv_snapshot_goto() error takes precedence */
295 error_propagate(errp
, local_err
);
296 return ret
< 0 ? ret
: open_ret
;
300 * fallback was a primary child. It was closed above and set to NULL,
301 * but the .bdrv_open() call has opened it again, because we set the
302 * respective option (with the qdict_put_str() call above).
303 * Assert that .bdrv_open() has attached the right BDS as primary child.
305 assert(bdrv_primary_bs(bs
) == fallback_bs
);
306 bdrv_unref(fallback_bs
);
310 error_setg(errp
, "Block driver does not support snapshots");
315 * Delete an internal snapshot by @snapshot_id and @name.
316 * @bs: block device used in the operation
317 * @snapshot_id: unique snapshot ID, or NULL
318 * @name: snapshot name, or NULL
319 * @errp: location to store error
321 * If both @snapshot_id and @name are specified, delete the first one with
322 * id @snapshot_id and name @name.
323 * If only @snapshot_id is specified, delete the first one with id
325 * If only @name is specified, delete the first one with name @name.
326 * if none is specified, return -EINVAL.
328 * Returns: 0 on success, -errno on failure. If @bs is not inserted, return
329 * -ENOMEDIUM. If @snapshot_id and @name are both NULL, return -EINVAL. If @bs
330 * does not support internal snapshot deletion, return -ENOTSUP. If @bs does
331 * not support parameter @snapshot_id or @name, or one of them is not correctly
332 * specified, return -EINVAL. If @bs can't find one matching @id and @name,
333 * return -ENOENT. If @errp != NULL, it will always be filled with error
334 * message on failure.
336 int bdrv_snapshot_delete(BlockDriverState
*bs
,
337 const char *snapshot_id
,
341 BlockDriver
*drv
= bs
->drv
;
342 BlockDriverState
*fallback_bs
= bdrv_snapshot_fallback(bs
);
348 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, bdrv_get_device_name(bs
));
351 if (!snapshot_id
&& !name
) {
352 error_setg(errp
, "snapshot_id and name are both NULL");
356 /* drain all pending i/o before deleting snapshot */
357 bdrv_drained_begin(bs
);
359 if (drv
->bdrv_snapshot_delete
) {
360 ret
= drv
->bdrv_snapshot_delete(bs
, snapshot_id
, name
, errp
);
361 } else if (fallback_bs
) {
362 ret
= bdrv_snapshot_delete(fallback_bs
, snapshot_id
, name
, errp
);
364 error_setg(errp
, "Block format '%s' used by device '%s' "
365 "does not support internal snapshot deletion",
366 drv
->format_name
, bdrv_get_device_name(bs
));
370 bdrv_drained_end(bs
);
374 int bdrv_snapshot_list(BlockDriverState
*bs
,
375 QEMUSnapshotInfo
**psn_info
)
377 BlockDriver
*drv
= bs
->drv
;
378 BlockDriverState
*fallback_bs
= bdrv_snapshot_fallback(bs
);
384 if (drv
->bdrv_snapshot_list
) {
385 return drv
->bdrv_snapshot_list(bs
, psn_info
);
388 return bdrv_snapshot_list(fallback_bs
, psn_info
);
394 * Temporarily load an internal snapshot by @snapshot_id and @name.
395 * @bs: block device used in the operation
396 * @snapshot_id: unique snapshot ID, or NULL
397 * @name: snapshot name, or NULL
398 * @errp: location to store error
400 * If both @snapshot_id and @name are specified, load the first one with
401 * id @snapshot_id and name @name.
402 * If only @snapshot_id is specified, load the first one with id
404 * If only @name is specified, load the first one with name @name.
405 * if none is specified, return -EINVAL.
407 * Returns: 0 on success, -errno on fail. If @bs is not inserted, return
408 * -ENOMEDIUM. If @bs is not readonly, return -EINVAL. If @bs did not support
409 * internal snapshot, return -ENOTSUP. If qemu can't find a matching @id and
410 * @name, return -ENOENT. If @errp != NULL, it will always be filled on
413 int bdrv_snapshot_load_tmp(BlockDriverState
*bs
,
414 const char *snapshot_id
,
418 BlockDriver
*drv
= bs
->drv
;
423 error_setg(errp
, QERR_DEVICE_HAS_NO_MEDIUM
, bdrv_get_device_name(bs
));
426 if (!snapshot_id
&& !name
) {
427 error_setg(errp
, "snapshot_id and name are both NULL");
430 if (!bdrv_is_read_only(bs
)) {
431 error_setg(errp
, "Device is not readonly");
434 if (drv
->bdrv_snapshot_load_tmp
) {
435 return drv
->bdrv_snapshot_load_tmp(bs
, snapshot_id
, name
, errp
);
437 error_setg(errp
, "Block format '%s' used by device '%s' "
438 "does not support temporarily loading internal snapshots",
439 drv
->format_name
, bdrv_get_device_name(bs
));
443 int bdrv_snapshot_load_tmp_by_id_or_name(BlockDriverState
*bs
,
444 const char *id_or_name
,
448 Error
*local_err
= NULL
;
452 ret
= bdrv_snapshot_load_tmp(bs
, id_or_name
, NULL
, &local_err
);
453 if (ret
== -ENOENT
|| ret
== -EINVAL
) {
454 error_free(local_err
);
456 ret
= bdrv_snapshot_load_tmp(bs
, NULL
, id_or_name
, &local_err
);
459 error_propagate(errp
, local_err
);
465 static int bdrv_all_get_snapshot_devices(bool has_devices
, strList
*devices
,
469 g_autoptr(GList
) bdrvs
= NULL
;
473 error_setg(errp
, "At least one device is required for snapshot");
478 BlockDriverState
*bs
= bdrv_find_node(devices
->value
);
480 error_setg(errp
, "No block device node '%s'", devices
->value
);
483 bdrvs
= g_list_append(bdrvs
, bs
);
484 devices
= devices
->next
;
487 BlockDriverState
*bs
;
489 for (bs
= bdrv_first(&it
); bs
; bs
= bdrv_next(&it
)) {
490 bdrvs
= g_list_append(bdrvs
, bs
);
494 *all_bdrvs
= g_steal_pointer(&bdrvs
);
499 static bool bdrv_all_snapshots_includes_bs(BlockDriverState
*bs
)
501 if (!bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
505 /* Include all nodes that are either in use by a BlockBackend, or that
506 * aren't attached to any node, but owned by the monitor. */
507 return bdrv_has_blk(bs
) || QLIST_EMPTY(&bs
->parents
);
510 /* Group operations. All block drivers are involved.
511 * These functions will properly handle dataplane (take aio_context_acquire
512 * when appropriate for appropriate block drivers) */
514 bool bdrv_all_can_snapshot(bool has_devices
, strList
*devices
,
517 g_autoptr(GList
) bdrvs
= NULL
;
522 if (bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
) < 0) {
528 BlockDriverState
*bs
= iterbdrvs
->data
;
529 AioContext
*ctx
= bdrv_get_aio_context(bs
);
532 aio_context_acquire(ctx
);
533 if (devices
|| bdrv_all_snapshots_includes_bs(bs
)) {
534 ok
= bdrv_can_snapshot(bs
);
536 aio_context_release(ctx
);
538 error_setg(errp
, "Device '%s' is writable but does not support "
539 "snapshots", bdrv_get_device_or_node_name(bs
));
543 iterbdrvs
= iterbdrvs
->next
;
549 int bdrv_all_delete_snapshot(const char *name
,
550 bool has_devices
, strList
*devices
,
553 g_autoptr(GList
) bdrvs
= NULL
;
558 if (bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
) < 0) {
564 BlockDriverState
*bs
= iterbdrvs
->data
;
565 AioContext
*ctx
= bdrv_get_aio_context(bs
);
566 QEMUSnapshotInfo sn1
, *snapshot
= &sn1
;
569 aio_context_acquire(ctx
);
570 if ((devices
|| bdrv_all_snapshots_includes_bs(bs
)) &&
571 bdrv_snapshot_find(bs
, snapshot
, name
) >= 0)
573 ret
= bdrv_snapshot_delete(bs
, snapshot
->id_str
,
574 snapshot
->name
, errp
);
576 aio_context_release(ctx
);
578 error_prepend(errp
, "Could not delete snapshot '%s' on '%s': ",
579 name
, bdrv_get_device_or_node_name(bs
));
583 iterbdrvs
= iterbdrvs
->next
;
590 int bdrv_all_goto_snapshot(const char *name
,
591 bool has_devices
, strList
*devices
,
594 g_autoptr(GList
) bdrvs
= NULL
;
599 if (bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
) < 0) {
605 BlockDriverState
*bs
= iterbdrvs
->data
;
606 AioContext
*ctx
= bdrv_get_aio_context(bs
);
609 aio_context_acquire(ctx
);
610 if (devices
|| bdrv_all_snapshots_includes_bs(bs
)) {
611 ret
= bdrv_snapshot_goto(bs
, name
, errp
);
613 aio_context_release(ctx
);
615 error_prepend(errp
, "Could not load snapshot '%s' on '%s': ",
616 name
, bdrv_get_device_or_node_name(bs
));
620 iterbdrvs
= iterbdrvs
->next
;
626 int bdrv_all_has_snapshot(const char *name
,
627 bool has_devices
, strList
*devices
,
630 g_autoptr(GList
) bdrvs
= NULL
;
635 if (bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
) < 0) {
641 BlockDriverState
*bs
= iterbdrvs
->data
;
642 AioContext
*ctx
= bdrv_get_aio_context(bs
);
646 aio_context_acquire(ctx
);
647 if (devices
|| bdrv_all_snapshots_includes_bs(bs
)) {
648 ret
= bdrv_snapshot_find(bs
, &sn
, name
);
650 aio_context_release(ctx
);
652 if (ret
== -ENOENT
) {
655 error_setg_errno(errp
, errno
,
656 "Could not check snapshot '%s' on '%s'",
657 name
, bdrv_get_device_or_node_name(bs
));
662 iterbdrvs
= iterbdrvs
->next
;
668 int bdrv_all_create_snapshot(QEMUSnapshotInfo
*sn
,
669 BlockDriverState
*vm_state_bs
,
670 uint64_t vm_state_size
,
671 bool has_devices
, strList
*devices
,
674 g_autoptr(GList
) bdrvs
= NULL
;
678 if (bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
) < 0) {
684 BlockDriverState
*bs
= iterbdrvs
->data
;
685 AioContext
*ctx
= bdrv_get_aio_context(bs
);
688 aio_context_acquire(ctx
);
689 if (bs
== vm_state_bs
) {
690 sn
->vm_state_size
= vm_state_size
;
691 ret
= bdrv_snapshot_create(bs
, sn
);
692 } else if (devices
|| bdrv_all_snapshots_includes_bs(bs
)) {
693 sn
->vm_state_size
= 0;
694 ret
= bdrv_snapshot_create(bs
, sn
);
696 aio_context_release(ctx
);
698 error_setg(errp
, "Could not create snapshot '%s' on '%s'",
699 sn
->name
, bdrv_get_device_or_node_name(bs
));
703 iterbdrvs
= iterbdrvs
->next
;
710 BlockDriverState
*bdrv_all_find_vmstate_bs(const char *vmstate_bs
,
711 bool has_devices
, strList
*devices
,
714 g_autoptr(GList
) bdrvs
= NULL
;
719 if (bdrv_all_get_snapshot_devices(has_devices
, devices
, &bdrvs
, errp
) < 0) {
725 BlockDriverState
*bs
= iterbdrvs
->data
;
726 AioContext
*ctx
= bdrv_get_aio_context(bs
);
729 aio_context_acquire(ctx
);
730 found
= (devices
|| bdrv_all_snapshots_includes_bs(bs
)) &&
731 bdrv_can_snapshot(bs
);
732 aio_context_release(ctx
);
735 if (g_str_equal(vmstate_bs
,
736 bdrv_get_node_name(bs
))) {
741 "vmstate block device '%s' does not support snapshots",
750 iterbdrvs
= iterbdrvs
->next
;
755 "vmstate block device '%s' does not exist", vmstate_bs
);
758 "no block device can store vmstate for snapshot");