xref: /openbmc/qemu/migration/ram.h (revision c3a073c6)
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 #include "qemu/stats64.h"
36 
37 /*
38  * These are the migration statistic counters that need to be updated using
39  * atomic ops (can be accessed by more than one thread).  Here since we
40  * cannot modify MigrationStats directly to use Stat64 as it was defined in
41  * the QAPI scheme, we define an internal structure to hold them, and we
42  * propagate the real values when QMP queries happen.
43  *
44  * IOW, the corresponding fields within ram_counters on these specific
45  * fields will be always zero and not being used at all; they're just
46  * placeholders to make it QAPI-compatible.
47  */
48 typedef struct {
49     Stat64 transferred;
50     Stat64 duplicate;
51     Stat64 normal;
52     Stat64 postcopy_bytes;
53 } MigrationAtomicStats;
54 
55 extern MigrationAtomicStats ram_atomic_counters;
56 extern MigrationStats ram_counters;
57 extern XBZRLECacheStats xbzrle_counters;
58 extern CompressionStats compression_counters;
59 
60 bool ramblock_is_ignored(RAMBlock *block);
61 /* Should be holding either ram_list.mutex, or the RCU lock. */
62 #define RAMBLOCK_FOREACH_NOT_IGNORED(block)            \
63     INTERNAL_RAMBLOCK_FOREACH(block)                   \
64         if (ramblock_is_ignored(block)) {} else
65 
66 #define RAMBLOCK_FOREACH_MIGRATABLE(block)             \
67     INTERNAL_RAMBLOCK_FOREACH(block)                   \
68         if (!qemu_ram_is_migratable(block)) {} else
69 
70 int xbzrle_cache_resize(uint64_t new_size, Error **errp);
71 uint64_t ram_bytes_remaining(void);
72 uint64_t ram_bytes_total(void);
73 void mig_throttle_counter_reset(void);
74 
75 uint64_t ram_pagesize_summary(void);
76 int ram_save_queue_pages(const char *rbname, ram_addr_t start, ram_addr_t len);
77 void acct_update_position(QEMUFile *f, size_t size, bool zero);
78 void ram_postcopy_migrated_memory_release(MigrationState *ms);
79 /* For outgoing discard bitmap */
80 void ram_postcopy_send_discard_bitmap(MigrationState *ms);
81 /* For incoming postcopy discard */
82 int ram_discard_range(const char *block_name, uint64_t start, size_t length);
83 int ram_postcopy_incoming_init(MigrationIncomingState *mis);
84 int ram_load_postcopy(QEMUFile *f, int channel);
85 
86 void ram_handle_compressed(void *host, uint8_t ch, uint64_t size);
87 
88 void ram_transferred_add(uint64_t bytes);
89 void ram_release_page(const char *rbname, uint64_t offset);
90 
91 int ramblock_recv_bitmap_test(RAMBlock *rb, void *host_addr);
92 bool ramblock_recv_bitmap_test_byte_offset(RAMBlock *rb, uint64_t byte_offset);
93 void ramblock_recv_bitmap_set(RAMBlock *rb, void *host_addr);
94 void ramblock_recv_bitmap_set_range(RAMBlock *rb, void *host_addr, size_t nr);
95 int64_t ramblock_recv_bitmap_send(QEMUFile *file,
96                                   const char *block_name);
97 int ram_dirty_bitmap_reload(MigrationState *s, RAMBlock *rb);
98 bool ramblock_page_is_discarded(RAMBlock *rb, ram_addr_t start);
99 void postcopy_preempt_shutdown_file(MigrationState *s);
100 void *postcopy_preempt_thread(void *opaque);
101 
102 /* ram cache */
103 int colo_init_ram_cache(void);
104 void colo_flush_ram_cache(void);
105 void colo_release_ram_cache(void);
106 void colo_incoming_start_dirty_log(void);
107 
108 /* Background snapshot */
109 bool ram_write_tracking_available(void);
110 bool ram_write_tracking_compatible(void);
111 void ram_write_tracking_prepare(void);
112 int ram_write_tracking_start(void);
113 void ram_write_tracking_stop(void);
114 
115 void dirty_sync_missed_zero_copy(void);
116 
117 #endif
118