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