1/*
2 * Block layer snapshot related functions
3 *
4 * Copyright (c) 2003-2008 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
25#ifndef SNAPSHOT_H
26#define SNAPSHOT_H
27
28
29
30#define SNAPSHOT_OPT_BASE "snapshot."
31#define SNAPSHOT_OPT_ID "snapshot.id"
32#define SNAPSHOT_OPT_NAME "snapshot.name"
33
34extern QemuOptsList internal_snapshot_opts;
35
36typedef struct QEMUSnapshotInfo {
37 char id_str[128]; /* unique snapshot id */
38 /* the following fields are informative. They are not needed for
39 the consistency of the snapshot */
40 char name[256]; /* user chosen name */
41 uint64_t vm_state_size; /* VM state info size */
42 uint32_t date_sec; /* UTC date of the snapshot */
43 uint32_t date_nsec;
44 uint64_t vm_clock_nsec; /* VM clock relative to boot */
45} QEMUSnapshotInfo;
46
47int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
48 const char *name);
49bool bdrv_snapshot_find_by_id_and_name(BlockDriverState *bs,
50 const char *id,
51 const char *name,
52 QEMUSnapshotInfo *sn_info,
53 Error **errp);
54int bdrv_can_snapshot(BlockDriverState *bs);
55int bdrv_snapshot_create(BlockDriverState *bs,
56 QEMUSnapshotInfo *sn_info);
57int bdrv_snapshot_goto(BlockDriverState *bs,
58 const char *snapshot_id,
59 Error **errp);
60int bdrv_snapshot_delete(BlockDriverState *bs,
61 const char *snapshot_id,
62 const char *name,
63 Error **errp);
64int bdrv_snapshot_list(BlockDriverState *bs,
65 QEMUSnapshotInfo **psn_info);
66int bdrv_snapshot_load_tmp(BlockDriverState *bs,
67 const char *snapshot_id,
68 const char *name,
69 Error **errp);
70int bdrv_snapshot_load_tmp_by_id_or_name(BlockDriverState *bs,
71 const char *id_or_name,
72 Error **errp);
73
74
75/* Group operations. All block drivers are involved.
76 * These functions will properly handle dataplane (take aio_context_acquire
77 * when appropriate for appropriate block drivers */
78
79bool bdrv_all_can_snapshot(BlockDriverState **first_bad_bs);
80int bdrv_all_delete_snapshot(const char *name, BlockDriverState **first_bsd_bs,
81 Error **err);
82int bdrv_all_goto_snapshot(const char *name, BlockDriverState **first_bad_bs,
83 Error **errp);
84int bdrv_all_find_snapshot(const char *name, BlockDriverState **first_bad_bs);
85int bdrv_all_create_snapshot(QEMUSnapshotInfo *sn,
86 BlockDriverState *vm_state_bs,
87 uint64_t vm_state_size,
88 BlockDriverState **first_bad_bs);
89
90BlockDriverState *bdrv_all_find_vmstate_bs(void);
91
92#endif
93