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