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