xref: /qemu/migration/ram.h (revision 3214bec13d8d4c40f707d21d8350d04e4123ae97)
1 /*
2  * QEMU System Emulator
3  *
4  * Copyright (c) 2003-2008 Fabrice Bellard
5  * Copyright (c) 2011-2015 Red Hat Inc
6  *
7  * Authors:
8  *  Juan Quintela <quintela@redhat.com>
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining a copy
11  * of this software and associated documentation files (the "Software"), to deal
12  * in the Software without restriction, including without limitation the rights
13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14  * copies of the Software, and to permit persons to whom the Software is
15  * furnished to do so, subject to the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be included in
18  * all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26  * THE SOFTWARE.
27  */
28 
29 #ifndef QEMU_MIGRATION_RAM_H
30 #define QEMU_MIGRATION_RAM_H
31 
32 #include "qapi/qapi-types-migration.h"
33 #include "exec/cpu-common.h"
34 #include "io/channel.h"
35 
36 /*
37  * RAM_SAVE_FLAG_ZERO used to be named RAM_SAVE_FLAG_COMPRESS, it
38  * worked for pages that were filled with the same char.  We switched
39  * it to only search for the zero value.  And to avoid confusion with
40  * RAM_SAVE_FLAG_COMPRESS_PAGE just rename it.
41  *
42  * RAM_SAVE_FLAG_FULL (0x01) was obsoleted in 2009.
43  *
44  * RAM_SAVE_FLAG_COMPRESS_PAGE (0x100) was removed in QEMU 9.1.
45  *
46  * RAM_SAVE_FLAG_HOOK is only used in RDMA. Whenever this is found in the
47  * data stream, the flags will be passed to rdma functions in the
48  * incoming-migration side.
49  *
50  * We can't use any flag that is bigger than 0x200, because the flags are
51  * always assumed to be encoded in a ramblock address offset, which is
52  * multiple of PAGE_SIZE.  Here it means QEMU supports migration with any
53  * architecture that has PAGE_SIZE>=1K (0x400).
54  */
55 #define RAM_SAVE_FLAG_ZERO                    0x002
56 #define RAM_SAVE_FLAG_MEM_SIZE                0x004
57 #define RAM_SAVE_FLAG_PAGE                    0x008
58 #define RAM_SAVE_FLAG_EOS                     0x010
59 #define RAM_SAVE_FLAG_CONTINUE                0x020
60 #define RAM_SAVE_FLAG_XBZRLE                  0x040
61 #define RAM_SAVE_FLAG_HOOK                    0x080
62 #define RAM_SAVE_FLAG_MULTIFD_FLUSH           0x200
63 
64 extern XBZRLECacheStats xbzrle_counters;
65 
66 /* Should be holding either ram_list.mutex, or the RCU lock. */
67 #define RAMBLOCK_FOREACH_NOT_IGNORED(block)            \
68     INTERNAL_RAMBLOCK_FOREACH(block)                   \
69         if (migrate_ram_is_ignored(block)) {} else
70 
71 #define RAMBLOCK_FOREACH_MIGRATABLE(block)             \
72     INTERNAL_RAMBLOCK_FOREACH(block)                   \
73         if (!qemu_ram_is_migratable(block)) {} else
74 
75 void ram_mig_init(void);
76 int xbzrle_cache_resize(uint64_t new_size, Error **errp);
77 uint64_t ram_bytes_remaining(void);
78 uint64_t ram_bytes_total(void);
79 void mig_throttle_counter_reset(void);
80 
81 uint64_t ram_pagesize_summary(void);
82 int ram_save_queue_pages(const char *rbname, ram_addr_t start, ram_addr_t len,
83                          Error **errp);
84 void ram_postcopy_migrated_memory_release(MigrationState *ms);
85 /* For outgoing discard bitmap */
86 void ram_postcopy_send_discard_bitmap(MigrationState *ms);
87 /* For incoming postcopy discard */
88 int ram_discard_range(const char *block_name, uint64_t start, size_t length);
89 int ram_postcopy_incoming_init(MigrationIncomingState *mis);
90 int ram_load_postcopy(QEMUFile *f, int channel);
91 
92 void ram_handle_zero(void *host, uint64_t size);
93 
94 void ram_transferred_add(uint64_t bytes);
95 void ram_release_page(const char *rbname, uint64_t offset);
96 
97 int ramblock_recv_bitmap_test(RAMBlock *rb, void *host_addr);
98 bool ramblock_recv_bitmap_test_byte_offset(RAMBlock *rb, uint64_t byte_offset);
99 void ramblock_recv_bitmap_set(RAMBlock *rb, void *host_addr);
100 void ramblock_recv_bitmap_set_range(RAMBlock *rb, void *host_addr, size_t nr);
101 void ramblock_recv_bitmap_set_offset(RAMBlock *rb, uint64_t byte_offset);
102 int64_t ramblock_recv_bitmap_send(QEMUFile *file,
103                                   const char *block_name);
104 bool ram_dirty_bitmap_reload(MigrationState *s, RAMBlock *rb, Error **errp);
105 bool ramblock_page_is_discarded(RAMBlock *rb, ram_addr_t start);
106 void postcopy_preempt_shutdown_file(MigrationState *s);
107 void *postcopy_preempt_thread(void *opaque);
108 void ramblock_set_file_bmap_atomic(RAMBlock *block, ram_addr_t offset,
109                                    bool set);
110 
111 /* ram cache */
112 int colo_init_ram_cache(void);
113 void colo_flush_ram_cache(void);
114 void colo_release_ram_cache(void);
115 void colo_incoming_start_dirty_log(void);
116 void colo_record_bitmap(RAMBlock *block, ram_addr_t *normal, uint32_t pages);
117 
118 /* Background snapshot */
119 bool ram_write_tracking_available(void);
120 bool ram_write_tracking_compatible(void);
121 void ram_write_tracking_prepare(void);
122 int ram_write_tracking_start(void);
123 void ram_write_tracking_stop(void);
124 
125 #endif
126