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 "qapi/qapi-builtin-types.h" 29 30 #define SNAPSHOT_OPT_BASE "snapshot." 31 #define SNAPSHOT_OPT_ID "snapshot.id" 32 #define SNAPSHOT_OPT_NAME "snapshot.name" 33 34 extern QemuOptsList internal_snapshot_opts; 35 36 typedef 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 uint64_t icount; /* record/replay step */ 46 } QEMUSnapshotInfo; 47 48 /* 49 * Global state (GS) API. These functions run under the BQL. 50 * 51 * See include/block/block-global-state.h for more information about 52 * the GS API. 53 */ 54 55 int bdrv_snapshot_find(BlockDriverState *bs, QEMUSnapshotInfo *sn_info, 56 const char *name); 57 bool bdrv_snapshot_find_by_id_and_name(BlockDriverState *bs, 58 const char *id, 59 const char *name, 60 QEMUSnapshotInfo *sn_info, 61 Error **errp); 62 int bdrv_can_snapshot(BlockDriverState *bs); 63 int bdrv_snapshot_create(BlockDriverState *bs, 64 QEMUSnapshotInfo *sn_info); 65 int bdrv_snapshot_goto(BlockDriverState *bs, 66 const char *snapshot_id, 67 Error **errp); 68 int bdrv_snapshot_delete(BlockDriverState *bs, 69 const char *snapshot_id, 70 const char *name, 71 Error **errp); 72 int bdrv_snapshot_list(BlockDriverState *bs, 73 QEMUSnapshotInfo **psn_info); 74 int bdrv_snapshot_load_tmp(BlockDriverState *bs, 75 const char *snapshot_id, 76 const char *name, 77 Error **errp); 78 int bdrv_snapshot_load_tmp_by_id_or_name(BlockDriverState *bs, 79 const char *id_or_name, 80 Error **errp); 81 82 83 /* 84 * Group operations. All block drivers are involved. 85 * These functions will properly handle dataplane (take aio_context_acquire 86 * when appropriate for appropriate block drivers 87 */ 88 89 bool bdrv_all_can_snapshot(bool has_devices, strList *devices, 90 Error **errp); 91 int bdrv_all_delete_snapshot(const char *name, 92 bool has_devices, strList *devices, 93 Error **errp); 94 int bdrv_all_goto_snapshot(const char *name, 95 bool has_devices, strList *devices, 96 Error **errp); 97 int bdrv_all_has_snapshot(const char *name, 98 bool has_devices, strList *devices, 99 Error **errp); 100 int bdrv_all_create_snapshot(QEMUSnapshotInfo *sn, 101 BlockDriverState *vm_state_bs, 102 uint64_t vm_state_size, 103 bool has_devices, 104 strList *devices, 105 Error **errp); 106 107 BlockDriverState *bdrv_all_find_vmstate_bs(const char *vmstate_bs, 108 bool has_devices, strList *devices, 109 Error **errp); 110 111 #endif 112