xref: /openbmc/qemu/include/block/snapshot.h (revision 8dc4d915)
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 #include "qemu-common.h"
29 #include "qapi/error.h"
30 
31 typedef struct QEMUSnapshotInfo {
32     char id_str[128]; /* unique snapshot id */
33     /* the following fields are informative. They are not needed for
34        the consistency of the snapshot */
35     char name[256]; /* user chosen name */
36     uint64_t vm_state_size; /* VM state info size */
37     uint32_t date_sec; /* UTC date of the snapshot */
38     uint32_t date_nsec;
39     uint64_t vm_clock_nsec; /* VM clock relative to boot */
40 } QEMUSnapshotInfo;
41 
42 int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info,
43                        const char *name);
44 bool bdrv_snapshot_find_by_id_and_name(BlockDriverState *bs,
45                                        const char *id,
46                                        const char *name,
47                                        QEMUSnapshotInfo *sn_info,
48                                        Error **errp);
49 int bdrv_can_snapshot(BlockDriverState *bs);
50 int bdrv_snapshot_create(BlockDriverState *bs,
51                          QEMUSnapshotInfo *sn_info);
52 int bdrv_snapshot_goto(BlockDriverState *bs,
53                        const char *snapshot_id);
54 int bdrv_snapshot_delete(BlockDriverState *bs,
55                          const char *snapshot_id,
56                          const char *name,
57                          Error **errp);
58 void bdrv_snapshot_delete_by_id_or_name(BlockDriverState *bs,
59                                         const char *id_or_name,
60                                         Error **errp);
61 int bdrv_snapshot_list(BlockDriverState *bs,
62                        QEMUSnapshotInfo **psn_info);
63 int bdrv_snapshot_load_tmp(BlockDriverState *bs,
64                            const char *snapshot_name);
65 #endif
66