xref: /openbmc/qemu/migration/ram.h (revision 7d87775f)
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 extern XBZRLECacheStats xbzrle_counters;
37 
38 /* Should be holding either ram_list.mutex, or the RCU lock. */
39 #define RAMBLOCK_FOREACH_NOT_IGNORED(block)            \
40     INTERNAL_RAMBLOCK_FOREACH(block)                   \
41         if (migrate_ram_is_ignored(block)) {} else
42 
43 #define RAMBLOCK_FOREACH_MIGRATABLE(block)             \
44     INTERNAL_RAMBLOCK_FOREACH(block)                   \
45         if (!qemu_ram_is_migratable(block)) {} else
46 
47 void ram_mig_init(void);
48 int xbzrle_cache_resize(uint64_t new_size, Error **errp);
49 uint64_t ram_bytes_remaining(void);
50 uint64_t ram_bytes_total(void);
51 void mig_throttle_counter_reset(void);
52 
53 uint64_t ram_pagesize_summary(void);
54 int ram_save_queue_pages(const char *rbname, ram_addr_t start, ram_addr_t len,
55                          Error **errp);
56 void ram_postcopy_migrated_memory_release(MigrationState *ms);
57 /* For outgoing discard bitmap */
58 void ram_postcopy_send_discard_bitmap(MigrationState *ms);
59 /* For incoming postcopy discard */
60 int ram_discard_range(const char *block_name, uint64_t start, size_t length);
61 int ram_postcopy_incoming_init(MigrationIncomingState *mis);
62 int ram_load_postcopy(QEMUFile *f, int channel);
63 
64 void ram_handle_zero(void *host, uint64_t size);
65 
66 void ram_transferred_add(uint64_t bytes);
67 void ram_release_page(const char *rbname, uint64_t offset);
68 
69 int ramblock_recv_bitmap_test(RAMBlock *rb, void *host_addr);
70 bool ramblock_recv_bitmap_test_byte_offset(RAMBlock *rb, uint64_t byte_offset);
71 void ramblock_recv_bitmap_set(RAMBlock *rb, void *host_addr);
72 void ramblock_recv_bitmap_set_range(RAMBlock *rb, void *host_addr, size_t nr);
73 void ramblock_recv_bitmap_set_offset(RAMBlock *rb, uint64_t byte_offset);
74 int64_t ramblock_recv_bitmap_send(QEMUFile *file,
75                                   const char *block_name);
76 bool ram_dirty_bitmap_reload(MigrationState *s, RAMBlock *rb, Error **errp);
77 bool ramblock_page_is_discarded(RAMBlock *rb, ram_addr_t start);
78 void postcopy_preempt_shutdown_file(MigrationState *s);
79 void *postcopy_preempt_thread(void *opaque);
80 void ramblock_set_file_bmap_atomic(RAMBlock *block, ram_addr_t offset,
81                                    bool set);
82 
83 /* ram cache */
84 int colo_init_ram_cache(void);
85 void colo_flush_ram_cache(void);
86 void colo_release_ram_cache(void);
87 void colo_incoming_start_dirty_log(void);
88 void colo_record_bitmap(RAMBlock *block, ram_addr_t *normal, uint32_t pages);
89 
90 /* Background snapshot */
91 bool ram_write_tracking_available(void);
92 bool ram_write_tracking_compatible(void);
93 void ram_write_tracking_prepare(void);
94 int ram_write_tracking_start(void);
95 void ram_write_tracking_stop(void);
96 
97 #endif
98