| 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 "system/ram_addr.h" |
| 35 | #include "io/channel.h" |
| 36 | |
| 37 | /* |
| 38 | * RAM_SAVE_FLAG_ZERO used to be named RAM_SAVE_FLAG_COMPRESS, it |
| 39 | * worked for pages that were filled with the same char. We switched |
| 40 | * it to only search for the zero value. And to avoid confusion with |
| 41 | * RAM_SAVE_FLAG_COMPRESS_PAGE just rename it. |
| 42 | * |
| 43 | * RAM_SAVE_FLAG_FULL (0x01) was obsoleted in 2009. |
| 44 | * |
| 45 | * RAM_SAVE_FLAG_COMPRESS_PAGE (0x100) was removed in QEMU 9.1. |
| 46 | * |
| 47 | * RAM_SAVE_FLAG_HOOK is only used in RDMA. Whenever this is found in the |
| 48 | * data stream, the flags will be passed to rdma functions in the |
| 49 | * incoming-migration side. |
| 50 | * |
| 51 | * We can't use any flag that is bigger than 0x200, because the flags are |
| 52 | * always assumed to be encoded in a ramblock address offset, which is |
| 53 | * multiple of PAGE_SIZE. Here it means QEMU supports migration with any |
| 54 | * architecture that has PAGE_SIZE>=1K (0x400). |
| 55 | */ |
| 56 | #define RAM_SAVE_FLAG_ZERO 0x002 |
| 57 | #define RAM_SAVE_FLAG_MEM_SIZE 0x004 |
| 58 | #define RAM_SAVE_FLAG_PAGE 0x008 |
| 59 | #define RAM_SAVE_FLAG_EOS 0x010 |
| 60 | #define RAM_SAVE_FLAG_CONTINUE 0x020 |
| 61 | #define RAM_SAVE_FLAG_XBZRLE 0x040 |
| 62 | #define RAM_SAVE_FLAG_HOOK 0x080 |
| 63 | #define RAM_SAVE_FLAG_MULTIFD_FLUSH 0x200 |
| 64 | |
| 65 | extern XBZRLECacheStats xbzrle_counters; |
| 66 | |
| 67 | /* Should be holding either ram_list.mutex, or the RCU lock. */ |
| 68 | #define RAMBLOCK_FOREACH_NOT_IGNORED(block) \ |
| 69 | INTERNAL_RAMBLOCK_FOREACH(block) \ |
| 70 | if (migrate_ram_is_ignored(block)) {} else |
| 71 | |
| 72 | #define RAMBLOCK_FOREACH_MIGRATABLE(block) \ |
| 73 | INTERNAL_RAMBLOCK_FOREACH(block) \ |
| 74 | if (!qemu_ram_is_migratable(block)) {} else |
| 75 | |
| 76 | void ram_mig_init(void); |
| 77 | int xbzrle_cache_resize(uint64_t new_size, Error **errp); |
| 78 | uint64_t ram_bytes_remaining(void); |
| 79 | uint64_t ram_bytes_total(void); |
| 80 | void mig_throttle_counter_reset(void); |
| 81 | |
| 82 | uint64_t ram_pagesize_summary(void); |
| 83 | int ram_save_queue_pages(const char *rbname, ram_addr_t start, ram_addr_t len, |
| 84 | Error **errp); |
| 85 | void ram_postcopy_migrated_memory_release(MigrationState *ms); |
| 86 | /* For outgoing discard bitmap */ |
| 87 | void ram_postcopy_send_discard_bitmap(MigrationState *ms); |
| 88 | /* For incoming postcopy discard */ |
| 89 | int ram_discard_range(const char *block_name, uint64_t start, size_t length); |
| 90 | int ram_postcopy_incoming_init(MigrationIncomingState *mis, Error **errp); |
| 91 | int ram_load_postcopy(QEMUFile *f, int channel); |
| 92 | |
| 93 | void ram_handle_zero(void *host, uint64_t size); |
| 94 | |
| 95 | void ram_transferred_add(uint64_t bytes); |
| 96 | void ram_release_page(const char *rbname, uint64_t offset); |
| 97 | |
| 98 | int ramblock_recv_bitmap_test(RAMBlock *rb, void *host_addr); |
| 99 | bool ramblock_recv_bitmap_test_byte_offset(RAMBlock *rb, uint64_t byte_offset); |
| 100 | void ramblock_recv_bitmap_set(RAMBlock *rb, void *host_addr); |
| 101 | void ramblock_recv_bitmap_set_range(RAMBlock *rb, void *host_addr, size_t nr); |
| 102 | void ramblock_recv_bitmap_set_offset(RAMBlock *rb, uint64_t byte_offset); |
| 103 | int64_t ramblock_recv_bitmap_send(QEMUFile *file, |
| 104 | const char *block_name); |
| 105 | bool ram_dirty_bitmap_reload(MigrationState *s, RAMBlock *rb, Error **errp); |
| 106 | bool ramblock_page_is_discarded(RAMBlock *rb, ram_addr_t start); |
| 107 | void postcopy_preempt_shutdown_file(MigrationState *s); |
| 108 | void *postcopy_preempt_thread(void *opaque); |
| 109 | void ramblock_set_file_bmap_atomic(RAMBlock *block, ram_addr_t offset, |
| 110 | bool set); |
| 111 | |
| 112 | /* ram cache */ |
| 113 | int colo_init_ram_cache(Error **errp); |
| 114 | void colo_flush_ram_cache(void); |
| 115 | void colo_release_ram_cache(void); |
| 116 | void colo_incoming_start_dirty_log(void); |
| 117 | void colo_record_bitmap(RAMBlock *block, ram_addr_t *normal, uint32_t pages); |
| 118 | |
| 119 | /* Background snapshot */ |
| 120 | bool ram_write_tracking_available(void); |
| 121 | bool ram_write_tracking_compatible(void); |
| 122 | void ram_write_tracking_prepare(void); |
| 123 | int ram_write_tracking_start(void); |
| 124 | void ram_write_tracking_stop(void); |
| 125 | |
| 126 | #endif |