Split ram_save_block
[sdk/emulator/qemu.git] / arch_init.c
1 /*
2  * QEMU System Emulator
3  *
4  * Copyright (c) 2003-2008 Fabrice Bellard
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 #include <stdint.h>
25 #include <stdarg.h>
26 #include <stdlib.h>
27 #ifndef _WIN32
28 #include <sys/types.h>
29 #include <sys/mman.h>
30 #endif
31 #include "config.h"
32 #include "monitor/monitor.h"
33 #include "sysemu/sysemu.h"
34 #include "qemu/bitops.h"
35 #include "qemu/bitmap.h"
36 #include "sysemu/arch_init.h"
37 #include "audio/audio.h"
38 #include "hw/i386/pc.h"
39 #include "hw/pci/pci.h"
40 #include "hw/audio/audio.h"
41 #include "sysemu/kvm.h"
42 #include "migration/migration.h"
43 #include "hw/i386/smbios.h"
44 #include "exec/address-spaces.h"
45 #include "hw/audio/pcspk.h"
46 #include "migration/page_cache.h"
47 #include "qemu/config-file.h"
48 #include "qemu/error-report.h"
49 #include "qmp-commands.h"
50 #include "trace.h"
51 #include "exec/cpu-all.h"
52 #include "exec/ram_addr.h"
53 #include "hw/acpi/acpi.h"
54 #include "qemu/host-utils.h"
55
56 #ifdef DEBUG_ARCH_INIT
57 #define DPRINTF(fmt, ...) \
58     do { fprintf(stdout, "arch_init: " fmt, ## __VA_ARGS__); } while (0)
59 #else
60 #define DPRINTF(fmt, ...) \
61     do { } while (0)
62 #endif
63
64 #ifdef TARGET_SPARC
65 int graphic_width = 1024;
66 int graphic_height = 768;
67 int graphic_depth = 8;
68 #else
69 int graphic_width = 800;
70 int graphic_height = 600;
71 int graphic_depth = 32;
72 #endif
73
74
75 #if defined(TARGET_ALPHA)
76 #define QEMU_ARCH QEMU_ARCH_ALPHA
77 #elif defined(TARGET_ARM)
78 #define QEMU_ARCH QEMU_ARCH_ARM
79 #elif defined(TARGET_CRIS)
80 #define QEMU_ARCH QEMU_ARCH_CRIS
81 #elif defined(TARGET_I386)
82 #define QEMU_ARCH QEMU_ARCH_I386
83 #elif defined(TARGET_M68K)
84 #define QEMU_ARCH QEMU_ARCH_M68K
85 #elif defined(TARGET_LM32)
86 #define QEMU_ARCH QEMU_ARCH_LM32
87 #elif defined(TARGET_MICROBLAZE)
88 #define QEMU_ARCH QEMU_ARCH_MICROBLAZE
89 #elif defined(TARGET_MIPS)
90 #define QEMU_ARCH QEMU_ARCH_MIPS
91 #elif defined(TARGET_MOXIE)
92 #define QEMU_ARCH QEMU_ARCH_MOXIE
93 #elif defined(TARGET_OPENRISC)
94 #define QEMU_ARCH QEMU_ARCH_OPENRISC
95 #elif defined(TARGET_PPC)
96 #define QEMU_ARCH QEMU_ARCH_PPC
97 #elif defined(TARGET_S390X)
98 #define QEMU_ARCH QEMU_ARCH_S390X
99 #elif defined(TARGET_SH4)
100 #define QEMU_ARCH QEMU_ARCH_SH4
101 #elif defined(TARGET_SPARC)
102 #define QEMU_ARCH QEMU_ARCH_SPARC
103 #elif defined(TARGET_XTENSA)
104 #define QEMU_ARCH QEMU_ARCH_XTENSA
105 #elif defined(TARGET_UNICORE32)
106 #define QEMU_ARCH QEMU_ARCH_UNICORE32
107 #endif
108
109 const uint32_t arch_type = QEMU_ARCH;
110 static bool mig_throttle_on;
111 static int dirty_rate_high_cnt;
112 static void check_guest_throttling(void);
113
114 static uint64_t bitmap_sync_count;
115
116 /***********************************************************/
117 /* ram save/restore */
118
119 #define RAM_SAVE_FLAG_FULL     0x01 /* Obsolete, not used anymore */
120 #define RAM_SAVE_FLAG_COMPRESS 0x02
121 #define RAM_SAVE_FLAG_MEM_SIZE 0x04
122 #define RAM_SAVE_FLAG_PAGE     0x08
123 #define RAM_SAVE_FLAG_EOS      0x10
124 #define RAM_SAVE_FLAG_CONTINUE 0x20
125 #define RAM_SAVE_FLAG_XBZRLE   0x40
126 /* 0x80 is reserved in migration.h start with 0x100 next */
127
128 static struct defconfig_file {
129     const char *filename;
130     /* Indicates it is an user config file (disabled by -no-user-config) */
131     bool userconfig;
132 } default_config_files[] = {
133     { CONFIG_QEMU_CONFDIR "/qemu.conf",                   true },
134     { CONFIG_QEMU_CONFDIR "/target-" TARGET_NAME ".conf", true },
135     { NULL }, /* end of list */
136 };
137
138 static const uint8_t ZERO_TARGET_PAGE[TARGET_PAGE_SIZE];
139
140 int qemu_read_default_config_files(bool userconfig)
141 {
142     int ret;
143     struct defconfig_file *f;
144
145     for (f = default_config_files; f->filename; f++) {
146         if (!userconfig && f->userconfig) {
147             continue;
148         }
149         ret = qemu_read_config_file(f->filename);
150         if (ret < 0 && ret != -ENOENT) {
151             return ret;
152         }
153     }
154
155     return 0;
156 }
157
158 static inline bool is_zero_range(uint8_t *p, uint64_t size)
159 {
160     return buffer_find_nonzero_offset(p, size) == size;
161 }
162
163 /* struct contains XBZRLE cache and a static page
164    used by the compression */
165 static struct {
166     /* buffer used for XBZRLE encoding */
167     uint8_t *encoded_buf;
168     /* buffer for storing page content */
169     uint8_t *current_buf;
170     /* Cache for XBZRLE, Protected by lock. */
171     PageCache *cache;
172     QemuMutex lock;
173 } XBZRLE;
174
175 /* buffer used for XBZRLE decoding */
176 static uint8_t *xbzrle_decoded_buf;
177
178 static void XBZRLE_cache_lock(void)
179 {
180     if (migrate_use_xbzrle())
181         qemu_mutex_lock(&XBZRLE.lock);
182 }
183
184 static void XBZRLE_cache_unlock(void)
185 {
186     if (migrate_use_xbzrle())
187         qemu_mutex_unlock(&XBZRLE.lock);
188 }
189
190 /*
191  * called from qmp_migrate_set_cache_size in main thread, possibly while
192  * a migration is in progress.
193  * A running migration maybe using the cache and might finish during this
194  * call, hence changes to the cache are protected by XBZRLE.lock().
195  */
196 int64_t xbzrle_cache_resize(int64_t new_size)
197 {
198     PageCache *new_cache;
199     int64_t ret;
200
201     if (new_size < TARGET_PAGE_SIZE) {
202         return -1;
203     }
204
205     XBZRLE_cache_lock();
206
207     if (XBZRLE.cache != NULL) {
208         if (pow2floor(new_size) == migrate_xbzrle_cache_size()) {
209             goto out_new_size;
210         }
211         new_cache = cache_init(new_size / TARGET_PAGE_SIZE,
212                                         TARGET_PAGE_SIZE);
213         if (!new_cache) {
214             error_report("Error creating cache");
215             ret = -1;
216             goto out;
217         }
218
219         cache_fini(XBZRLE.cache);
220         XBZRLE.cache = new_cache;
221     }
222
223 out_new_size:
224     ret = pow2floor(new_size);
225 out:
226     XBZRLE_cache_unlock();
227     return ret;
228 }
229
230 /* accounting for migration statistics */
231 typedef struct AccountingInfo {
232     uint64_t dup_pages;
233     uint64_t skipped_pages;
234     uint64_t norm_pages;
235     uint64_t iterations;
236     uint64_t xbzrle_bytes;
237     uint64_t xbzrle_pages;
238     uint64_t xbzrle_cache_miss;
239     double xbzrle_cache_miss_rate;
240     uint64_t xbzrle_overflows;
241 } AccountingInfo;
242
243 static AccountingInfo acct_info;
244
245 static void acct_clear(void)
246 {
247     memset(&acct_info, 0, sizeof(acct_info));
248 }
249
250 uint64_t dup_mig_bytes_transferred(void)
251 {
252     return acct_info.dup_pages * TARGET_PAGE_SIZE;
253 }
254
255 uint64_t dup_mig_pages_transferred(void)
256 {
257     return acct_info.dup_pages;
258 }
259
260 uint64_t skipped_mig_bytes_transferred(void)
261 {
262     return acct_info.skipped_pages * TARGET_PAGE_SIZE;
263 }
264
265 uint64_t skipped_mig_pages_transferred(void)
266 {
267     return acct_info.skipped_pages;
268 }
269
270 uint64_t norm_mig_bytes_transferred(void)
271 {
272     return acct_info.norm_pages * TARGET_PAGE_SIZE;
273 }
274
275 uint64_t norm_mig_pages_transferred(void)
276 {
277     return acct_info.norm_pages;
278 }
279
280 uint64_t xbzrle_mig_bytes_transferred(void)
281 {
282     return acct_info.xbzrle_bytes;
283 }
284
285 uint64_t xbzrle_mig_pages_transferred(void)
286 {
287     return acct_info.xbzrle_pages;
288 }
289
290 uint64_t xbzrle_mig_pages_cache_miss(void)
291 {
292     return acct_info.xbzrle_cache_miss;
293 }
294
295 double xbzrle_mig_cache_miss_rate(void)
296 {
297     return acct_info.xbzrle_cache_miss_rate;
298 }
299
300 uint64_t xbzrle_mig_pages_overflow(void)
301 {
302     return acct_info.xbzrle_overflows;
303 }
304
305 static size_t save_block_hdr(QEMUFile *f, RAMBlock *block, ram_addr_t offset,
306                              int cont, int flag)
307 {
308     size_t size;
309
310     qemu_put_be64(f, offset | cont | flag);
311     size = 8;
312
313     if (!cont) {
314         qemu_put_byte(f, strlen(block->idstr));
315         qemu_put_buffer(f, (uint8_t *)block->idstr,
316                         strlen(block->idstr));
317         size += 1 + strlen(block->idstr);
318     }
319     return size;
320 }
321
322 /* This is the last block that we have visited serching for dirty pages
323  */
324 static RAMBlock *last_seen_block;
325 /* This is the last block from where we have sent data */
326 static RAMBlock *last_sent_block;
327 static ram_addr_t last_offset;
328 static unsigned long *migration_bitmap;
329 static uint64_t migration_dirty_pages;
330 static uint32_t last_version;
331 static bool ram_bulk_stage;
332
333 /* Update the xbzrle cache to reflect a page that's been sent as all 0.
334  * The important thing is that a stale (not-yet-0'd) page be replaced
335  * by the new data.
336  * As a bonus, if the page wasn't in the cache it gets added so that
337  * when a small write is made into the 0'd page it gets XBZRLE sent
338  */
339 static void xbzrle_cache_zero_page(ram_addr_t current_addr)
340 {
341     if (ram_bulk_stage || !migrate_use_xbzrle()) {
342         return;
343     }
344
345     /* We don't care if this fails to allocate a new cache page
346      * as long as it updated an old one */
347     cache_insert(XBZRLE.cache, current_addr, ZERO_TARGET_PAGE);
348 }
349
350 #define ENCODING_FLAG_XBZRLE 0x1
351
352 static int save_xbzrle_page(QEMUFile *f, uint8_t **current_data,
353                             ram_addr_t current_addr, RAMBlock *block,
354                             ram_addr_t offset, int cont, bool last_stage)
355 {
356     int encoded_len = 0, bytes_sent = -1;
357     uint8_t *prev_cached_page;
358
359     if (!cache_is_cached(XBZRLE.cache, current_addr)) {
360         acct_info.xbzrle_cache_miss++;
361         if (!last_stage) {
362             if (cache_insert(XBZRLE.cache, current_addr, *current_data) == -1) {
363                 return -1;
364             } else {
365                 /* update *current_data when the page has been
366                    inserted into cache */
367                 *current_data = get_cached_data(XBZRLE.cache, current_addr);
368             }
369         }
370         return -1;
371     }
372
373     prev_cached_page = get_cached_data(XBZRLE.cache, current_addr);
374
375     /* save current buffer into memory */
376     memcpy(XBZRLE.current_buf, *current_data, TARGET_PAGE_SIZE);
377
378     /* XBZRLE encoding (if there is no overflow) */
379     encoded_len = xbzrle_encode_buffer(prev_cached_page, XBZRLE.current_buf,
380                                        TARGET_PAGE_SIZE, XBZRLE.encoded_buf,
381                                        TARGET_PAGE_SIZE);
382     if (encoded_len == 0) {
383         DPRINTF("Skipping unmodified page\n");
384         return 0;
385     } else if (encoded_len == -1) {
386         DPRINTF("Overflow\n");
387         acct_info.xbzrle_overflows++;
388         /* update data in the cache */
389         if (!last_stage) {
390             memcpy(prev_cached_page, *current_data, TARGET_PAGE_SIZE);
391             *current_data = prev_cached_page;
392         }
393         return -1;
394     }
395
396     /* we need to update the data in the cache, in order to get the same data */
397     if (!last_stage) {
398         memcpy(prev_cached_page, XBZRLE.current_buf, TARGET_PAGE_SIZE);
399     }
400
401     /* Send XBZRLE based compressed page */
402     bytes_sent = save_block_hdr(f, block, offset, cont, RAM_SAVE_FLAG_XBZRLE);
403     qemu_put_byte(f, ENCODING_FLAG_XBZRLE);
404     qemu_put_be16(f, encoded_len);
405     qemu_put_buffer(f, XBZRLE.encoded_buf, encoded_len);
406     bytes_sent += encoded_len + 1 + 2;
407     acct_info.xbzrle_pages++;
408     acct_info.xbzrle_bytes += bytes_sent;
409
410     return bytes_sent;
411 }
412
413 static inline
414 ram_addr_t migration_bitmap_find_and_reset_dirty(MemoryRegion *mr,
415                                                  ram_addr_t start)
416 {
417     unsigned long base = mr->ram_addr >> TARGET_PAGE_BITS;
418     unsigned long nr = base + (start >> TARGET_PAGE_BITS);
419     uint64_t mr_size = TARGET_PAGE_ALIGN(memory_region_size(mr));
420     unsigned long size = base + (mr_size >> TARGET_PAGE_BITS);
421
422     unsigned long next;
423
424     if (ram_bulk_stage && nr > base) {
425         next = nr + 1;
426     } else {
427         next = find_next_bit(migration_bitmap, size, nr);
428     }
429
430     if (next < size) {
431         clear_bit(next, migration_bitmap);
432         migration_dirty_pages--;
433     }
434     return (next - base) << TARGET_PAGE_BITS;
435 }
436
437 static inline bool migration_bitmap_set_dirty(ram_addr_t addr)
438 {
439     bool ret;
440     int nr = addr >> TARGET_PAGE_BITS;
441
442     ret = test_and_set_bit(nr, migration_bitmap);
443
444     if (!ret) {
445         migration_dirty_pages++;
446     }
447     return ret;
448 }
449
450 static void migration_bitmap_sync_range(ram_addr_t start, ram_addr_t length)
451 {
452     ram_addr_t addr;
453     unsigned long page = BIT_WORD(start >> TARGET_PAGE_BITS);
454
455     /* start address is aligned at the start of a word? */
456     if (((page * BITS_PER_LONG) << TARGET_PAGE_BITS) == start) {
457         int k;
458         int nr = BITS_TO_LONGS(length >> TARGET_PAGE_BITS);
459         unsigned long *src = ram_list.dirty_memory[DIRTY_MEMORY_MIGRATION];
460
461         for (k = page; k < page + nr; k++) {
462             if (src[k]) {
463                 unsigned long new_dirty;
464                 new_dirty = ~migration_bitmap[k];
465                 migration_bitmap[k] |= src[k];
466                 new_dirty &= src[k];
467                 migration_dirty_pages += ctpopl(new_dirty);
468                 src[k] = 0;
469             }
470         }
471     } else {
472         for (addr = 0; addr < length; addr += TARGET_PAGE_SIZE) {
473             if (cpu_physical_memory_get_dirty(start + addr,
474                                               TARGET_PAGE_SIZE,
475                                               DIRTY_MEMORY_MIGRATION)) {
476                 cpu_physical_memory_reset_dirty(start + addr,
477                                                 TARGET_PAGE_SIZE,
478                                                 DIRTY_MEMORY_MIGRATION);
479                 migration_bitmap_set_dirty(start + addr);
480             }
481         }
482     }
483 }
484
485
486 /* Needs iothread lock! */
487
488 static void migration_bitmap_sync(void)
489 {
490     RAMBlock *block;
491     uint64_t num_dirty_pages_init = migration_dirty_pages;
492     MigrationState *s = migrate_get_current();
493     static int64_t start_time;
494     static int64_t bytes_xfer_prev;
495     static int64_t num_dirty_pages_period;
496     int64_t end_time;
497     int64_t bytes_xfer_now;
498     static uint64_t xbzrle_cache_miss_prev;
499     static uint64_t iterations_prev;
500
501     bitmap_sync_count++;
502
503     if (!bytes_xfer_prev) {
504         bytes_xfer_prev = ram_bytes_transferred();
505     }
506
507     if (!start_time) {
508         start_time = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
509     }
510
511     trace_migration_bitmap_sync_start();
512     address_space_sync_dirty_bitmap(&address_space_memory);
513
514     QTAILQ_FOREACH(block, &ram_list.blocks, next) {
515         migration_bitmap_sync_range(block->mr->ram_addr, block->length);
516     }
517     trace_migration_bitmap_sync_end(migration_dirty_pages
518                                     - num_dirty_pages_init);
519     num_dirty_pages_period += migration_dirty_pages - num_dirty_pages_init;
520     end_time = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
521
522     /* more than 1 second = 1000 millisecons */
523     if (end_time > start_time + 1000) {
524         if (migrate_auto_converge()) {
525             /* The following detection logic can be refined later. For now:
526                Check to see if the dirtied bytes is 50% more than the approx.
527                amount of bytes that just got transferred since the last time we
528                were in this routine. If that happens >N times (for now N==4)
529                we turn on the throttle down logic */
530             bytes_xfer_now = ram_bytes_transferred();
531             if (s->dirty_pages_rate &&
532                (num_dirty_pages_period * TARGET_PAGE_SIZE >
533                    (bytes_xfer_now - bytes_xfer_prev)/2) &&
534                (dirty_rate_high_cnt++ > 4)) {
535                     trace_migration_throttle();
536                     mig_throttle_on = true;
537                     dirty_rate_high_cnt = 0;
538              }
539              bytes_xfer_prev = bytes_xfer_now;
540         } else {
541              mig_throttle_on = false;
542         }
543         if (migrate_use_xbzrle()) {
544             if (iterations_prev != 0) {
545                 acct_info.xbzrle_cache_miss_rate =
546                    (double)(acct_info.xbzrle_cache_miss -
547                             xbzrle_cache_miss_prev) /
548                    (acct_info.iterations - iterations_prev);
549             }
550             iterations_prev = acct_info.iterations;
551             xbzrle_cache_miss_prev = acct_info.xbzrle_cache_miss;
552         }
553         s->dirty_pages_rate = num_dirty_pages_period * 1000
554             / (end_time - start_time);
555         s->dirty_bytes_rate = s->dirty_pages_rate * TARGET_PAGE_SIZE;
556         start_time = end_time;
557         num_dirty_pages_period = 0;
558         s->dirty_sync_count = bitmap_sync_count;
559     }
560 }
561
562 /*
563  * ram_save_page: Send the given page to the stream
564  *
565  * Returns: Number of bytes written.
566  */
567 static int ram_save_page(QEMUFile *f, RAMBlock* block, ram_addr_t offset,
568                          bool last_stage)
569 {
570     int bytes_sent;
571     int cont;
572     ram_addr_t current_addr;
573     MemoryRegion *mr = block->mr;
574     uint8_t *p;
575     int ret;
576     bool send_async = true;
577
578     cont = (block == last_sent_block) ? RAM_SAVE_FLAG_CONTINUE : 0;
579
580     p = memory_region_get_ram_ptr(mr) + offset;
581
582     /* In doubt sent page as normal */
583     bytes_sent = -1;
584     ret = ram_control_save_page(f, block->offset,
585                            offset, TARGET_PAGE_SIZE, &bytes_sent);
586
587     XBZRLE_cache_lock();
588
589     current_addr = block->offset + offset;
590     if (ret != RAM_SAVE_CONTROL_NOT_SUPP) {
591         if (ret != RAM_SAVE_CONTROL_DELAYED) {
592             if (bytes_sent > 0) {
593                 acct_info.norm_pages++;
594             } else if (bytes_sent == 0) {
595                 acct_info.dup_pages++;
596             }
597         }
598     } else if (is_zero_range(p, TARGET_PAGE_SIZE)) {
599         acct_info.dup_pages++;
600         bytes_sent = save_block_hdr(f, block, offset, cont,
601                                     RAM_SAVE_FLAG_COMPRESS);
602         qemu_put_byte(f, 0);
603         bytes_sent++;
604         /* Must let xbzrle know, otherwise a previous (now 0'd) cached
605          * page would be stale
606          */
607         xbzrle_cache_zero_page(current_addr);
608     } else if (!ram_bulk_stage && migrate_use_xbzrle()) {
609         bytes_sent = save_xbzrle_page(f, &p, current_addr, block,
610                                       offset, cont, last_stage);
611         if (!last_stage) {
612             /* Can't send this cached data async, since the cache page
613              * might get updated before it gets to the wire
614              */
615             send_async = false;
616         }
617     }
618
619     /* XBZRLE overflow or normal page */
620     if (bytes_sent == -1) {
621         bytes_sent = save_block_hdr(f, block, offset, cont, RAM_SAVE_FLAG_PAGE);
622         if (send_async) {
623             qemu_put_buffer_async(f, p, TARGET_PAGE_SIZE);
624         } else {
625             qemu_put_buffer(f, p, TARGET_PAGE_SIZE);
626         }
627         bytes_sent += TARGET_PAGE_SIZE;
628         acct_info.norm_pages++;
629     }
630
631     XBZRLE_cache_unlock();
632
633     return bytes_sent;
634 }
635
636 /*
637  * ram_find_and_save_block: Finds a page to send and sends it to f
638  *
639  * Returns:  The number of bytes written.
640  *           0 means no dirty pages
641  */
642
643 static int ram_find_and_save_block(QEMUFile *f, bool last_stage)
644 {
645     RAMBlock *block = last_seen_block;
646     ram_addr_t offset = last_offset;
647     bool complete_round = false;
648     int bytes_sent = 0;
649     MemoryRegion *mr;
650
651     if (!block)
652         block = QTAILQ_FIRST(&ram_list.blocks);
653
654     while (true) {
655         mr = block->mr;
656         offset = migration_bitmap_find_and_reset_dirty(mr, offset);
657         if (complete_round && block == last_seen_block &&
658             offset >= last_offset) {
659             break;
660         }
661         if (offset >= block->length) {
662             offset = 0;
663             block = QTAILQ_NEXT(block, next);
664             if (!block) {
665                 block = QTAILQ_FIRST(&ram_list.blocks);
666                 complete_round = true;
667                 ram_bulk_stage = false;
668             }
669         } else {
670             bytes_sent = ram_save_page(f, block, offset, last_stage);
671
672             /* if page is unmodified, continue to the next */
673             if (bytes_sent > 0) {
674                 last_sent_block = block;
675                 break;
676             }
677         }
678     }
679     last_seen_block = block;
680     last_offset = offset;
681
682     return bytes_sent;
683 }
684
685 static uint64_t bytes_transferred;
686
687 void acct_update_position(QEMUFile *f, size_t size, bool zero)
688 {
689     uint64_t pages = size / TARGET_PAGE_SIZE;
690     if (zero) {
691         acct_info.dup_pages += pages;
692     } else {
693         acct_info.norm_pages += pages;
694         bytes_transferred += size;
695         qemu_update_position(f, size);
696     }
697 }
698
699 static ram_addr_t ram_save_remaining(void)
700 {
701     return migration_dirty_pages;
702 }
703
704 uint64_t ram_bytes_remaining(void)
705 {
706     return ram_save_remaining() * TARGET_PAGE_SIZE;
707 }
708
709 uint64_t ram_bytes_transferred(void)
710 {
711     return bytes_transferred;
712 }
713
714 uint64_t ram_bytes_total(void)
715 {
716     RAMBlock *block;
717     uint64_t total = 0;
718
719     QTAILQ_FOREACH(block, &ram_list.blocks, next)
720         total += block->length;
721
722     return total;
723 }
724
725 void free_xbzrle_decoded_buf(void)
726 {
727     g_free(xbzrle_decoded_buf);
728     xbzrle_decoded_buf = NULL;
729 }
730
731 static void migration_end(void)
732 {
733     if (migration_bitmap) {
734         memory_global_dirty_log_stop();
735         g_free(migration_bitmap);
736         migration_bitmap = NULL;
737     }
738
739     XBZRLE_cache_lock();
740     if (XBZRLE.cache) {
741         cache_fini(XBZRLE.cache);
742         g_free(XBZRLE.cache);
743         g_free(XBZRLE.encoded_buf);
744         g_free(XBZRLE.current_buf);
745         XBZRLE.cache = NULL;
746         XBZRLE.encoded_buf = NULL;
747         XBZRLE.current_buf = NULL;
748     }
749     XBZRLE_cache_unlock();
750 }
751
752 static void ram_migration_cancel(void *opaque)
753 {
754     migration_end();
755 }
756
757 static void reset_ram_globals(void)
758 {
759     last_seen_block = NULL;
760     last_sent_block = NULL;
761     last_offset = 0;
762     last_version = ram_list.version;
763     ram_bulk_stage = true;
764 }
765
766 #define MAX_WAIT 50 /* ms, half buffered_file limit */
767
768 static int ram_save_setup(QEMUFile *f, void *opaque)
769 {
770     RAMBlock *block;
771     int64_t ram_bitmap_pages; /* Size of bitmap in pages, including gaps */
772
773     mig_throttle_on = false;
774     dirty_rate_high_cnt = 0;
775     bitmap_sync_count = 0;
776
777     if (migrate_use_xbzrle()) {
778         XBZRLE_cache_lock();
779         XBZRLE.cache = cache_init(migrate_xbzrle_cache_size() /
780                                   TARGET_PAGE_SIZE,
781                                   TARGET_PAGE_SIZE);
782         if (!XBZRLE.cache) {
783             XBZRLE_cache_unlock();
784             error_report("Error creating cache");
785             return -1;
786         }
787         XBZRLE_cache_unlock();
788
789         /* We prefer not to abort if there is no memory */
790         XBZRLE.encoded_buf = g_try_malloc0(TARGET_PAGE_SIZE);
791         if (!XBZRLE.encoded_buf) {
792             error_report("Error allocating encoded_buf");
793             return -1;
794         }
795
796         XBZRLE.current_buf = g_try_malloc(TARGET_PAGE_SIZE);
797         if (!XBZRLE.current_buf) {
798             error_report("Error allocating current_buf");
799             g_free(XBZRLE.encoded_buf);
800             XBZRLE.encoded_buf = NULL;
801             return -1;
802         }
803
804         acct_clear();
805     }
806
807     qemu_mutex_lock_iothread();
808     qemu_mutex_lock_ramlist();
809     bytes_transferred = 0;
810     reset_ram_globals();
811
812     ram_bitmap_pages = last_ram_offset() >> TARGET_PAGE_BITS;
813     migration_bitmap = bitmap_new(ram_bitmap_pages);
814     bitmap_set(migration_bitmap, 0, ram_bitmap_pages);
815
816     /*
817      * Count the total number of pages used by ram blocks not including any
818      * gaps due to alignment or unplugs.
819      */
820     migration_dirty_pages = 0;
821     QTAILQ_FOREACH(block, &ram_list.blocks, next) {
822         uint64_t block_pages;
823
824         block_pages = block->length >> TARGET_PAGE_BITS;
825         migration_dirty_pages += block_pages;
826     }
827
828     memory_global_dirty_log_start();
829     migration_bitmap_sync();
830     qemu_mutex_unlock_iothread();
831
832     qemu_put_be64(f, ram_bytes_total() | RAM_SAVE_FLAG_MEM_SIZE);
833
834     QTAILQ_FOREACH(block, &ram_list.blocks, next) {
835         qemu_put_byte(f, strlen(block->idstr));
836         qemu_put_buffer(f, (uint8_t *)block->idstr, strlen(block->idstr));
837         qemu_put_be64(f, block->length);
838     }
839
840     qemu_mutex_unlock_ramlist();
841
842     ram_control_before_iterate(f, RAM_CONTROL_SETUP);
843     ram_control_after_iterate(f, RAM_CONTROL_SETUP);
844
845     qemu_put_be64(f, RAM_SAVE_FLAG_EOS);
846
847     return 0;
848 }
849
850 static int ram_save_iterate(QEMUFile *f, void *opaque)
851 {
852     int ret;
853     int i;
854     int64_t t0;
855     int total_sent = 0;
856
857     qemu_mutex_lock_ramlist();
858
859     if (ram_list.version != last_version) {
860         reset_ram_globals();
861     }
862
863     ram_control_before_iterate(f, RAM_CONTROL_ROUND);
864
865     t0 = qemu_clock_get_ns(QEMU_CLOCK_REALTIME);
866     i = 0;
867     while ((ret = qemu_file_rate_limit(f)) == 0) {
868         int bytes_sent;
869
870         bytes_sent = ram_find_and_save_block(f, false);
871         /* no more blocks to sent */
872         if (bytes_sent == 0) {
873             break;
874         }
875         total_sent += bytes_sent;
876         acct_info.iterations++;
877         check_guest_throttling();
878         /* we want to check in the 1st loop, just in case it was the 1st time
879            and we had to sync the dirty bitmap.
880            qemu_get_clock_ns() is a bit expensive, so we only check each some
881            iterations
882         */
883         if ((i & 63) == 0) {
884             uint64_t t1 = (qemu_clock_get_ns(QEMU_CLOCK_REALTIME) - t0) / 1000000;
885             if (t1 > MAX_WAIT) {
886                 DPRINTF("big wait: %" PRIu64 " milliseconds, %d iterations\n",
887                         t1, i);
888                 break;
889             }
890         }
891         i++;
892     }
893
894     qemu_mutex_unlock_ramlist();
895
896     /*
897      * Must occur before EOS (or any QEMUFile operation)
898      * because of RDMA protocol.
899      */
900     ram_control_after_iterate(f, RAM_CONTROL_ROUND);
901
902     bytes_transferred += total_sent;
903
904     /*
905      * Do not count these 8 bytes into total_sent, so that we can
906      * return 0 if no page had been dirtied.
907      */
908     qemu_put_be64(f, RAM_SAVE_FLAG_EOS);
909     bytes_transferred += 8;
910
911     ret = qemu_file_get_error(f);
912     if (ret < 0) {
913         return ret;
914     }
915
916     return total_sent;
917 }
918
919 static int ram_save_complete(QEMUFile *f, void *opaque)
920 {
921     qemu_mutex_lock_ramlist();
922     migration_bitmap_sync();
923
924     ram_control_before_iterate(f, RAM_CONTROL_FINISH);
925
926     /* try transferring iterative blocks of memory */
927
928     /* flush all remaining blocks regardless of rate limiting */
929     while (true) {
930         int bytes_sent;
931
932         bytes_sent = ram_find_and_save_block(f, true);
933         /* no more blocks to sent */
934         if (bytes_sent == 0) {
935             break;
936         }
937         bytes_transferred += bytes_sent;
938     }
939
940     ram_control_after_iterate(f, RAM_CONTROL_FINISH);
941     migration_end();
942
943     qemu_mutex_unlock_ramlist();
944     qemu_put_be64(f, RAM_SAVE_FLAG_EOS);
945
946     return 0;
947 }
948
949 static uint64_t ram_save_pending(QEMUFile *f, void *opaque, uint64_t max_size)
950 {
951     uint64_t remaining_size;
952
953     remaining_size = ram_save_remaining() * TARGET_PAGE_SIZE;
954
955     if (remaining_size < max_size) {
956         qemu_mutex_lock_iothread();
957         migration_bitmap_sync();
958         qemu_mutex_unlock_iothread();
959         remaining_size = ram_save_remaining() * TARGET_PAGE_SIZE;
960     }
961     return remaining_size;
962 }
963
964 static int load_xbzrle(QEMUFile *f, ram_addr_t addr, void *host)
965 {
966     unsigned int xh_len;
967     int xh_flags;
968
969     if (!xbzrle_decoded_buf) {
970         xbzrle_decoded_buf = g_malloc(TARGET_PAGE_SIZE);
971     }
972
973     /* extract RLE header */
974     xh_flags = qemu_get_byte(f);
975     xh_len = qemu_get_be16(f);
976
977     if (xh_flags != ENCODING_FLAG_XBZRLE) {
978         fprintf(stderr, "Failed to load XBZRLE page - wrong compression!\n");
979         return -1;
980     }
981
982     if (xh_len > TARGET_PAGE_SIZE) {
983         fprintf(stderr, "Failed to load XBZRLE page - len overflow!\n");
984         return -1;
985     }
986     /* load data and decode */
987     qemu_get_buffer(f, xbzrle_decoded_buf, xh_len);
988
989     /* decode RLE */
990     if (xbzrle_decode_buffer(xbzrle_decoded_buf, xh_len, host,
991                              TARGET_PAGE_SIZE) == -1) {
992         fprintf(stderr, "Failed to load XBZRLE page - decode error!\n");
993         return -1;
994     }
995
996     return 0;
997 }
998
999 static inline void *host_from_stream_offset(QEMUFile *f,
1000                                             ram_addr_t offset,
1001                                             int flags)
1002 {
1003     static RAMBlock *block = NULL;
1004     char id[256];
1005     uint8_t len;
1006
1007     if (flags & RAM_SAVE_FLAG_CONTINUE) {
1008         if (!block) {
1009             fprintf(stderr, "Ack, bad migration stream!\n");
1010             return NULL;
1011         }
1012
1013         return memory_region_get_ram_ptr(block->mr) + offset;
1014     }
1015
1016     len = qemu_get_byte(f);
1017     qemu_get_buffer(f, (uint8_t *)id, len);
1018     id[len] = 0;
1019
1020     QTAILQ_FOREACH(block, &ram_list.blocks, next) {
1021         if (!strncmp(id, block->idstr, sizeof(id)))
1022             return memory_region_get_ram_ptr(block->mr) + offset;
1023     }
1024
1025     fprintf(stderr, "Can't find block %s!\n", id);
1026     return NULL;
1027 }
1028
1029 /*
1030  * If a page (or a whole RDMA chunk) has been
1031  * determined to be zero, then zap it.
1032  */
1033 void ram_handle_compressed(void *host, uint8_t ch, uint64_t size)
1034 {
1035     if (ch != 0 || !is_zero_range(host, size)) {
1036         memset(host, ch, size);
1037     }
1038 }
1039
1040 static int ram_load(QEMUFile *f, void *opaque, int version_id)
1041 {
1042     ram_addr_t addr;
1043     int flags, ret = 0;
1044     int error;
1045     static uint64_t seq_iter;
1046
1047     seq_iter++;
1048
1049     if (version_id != 4) {
1050         ret = -EINVAL;
1051         goto done;
1052     }
1053
1054     do {
1055         addr = qemu_get_be64(f);
1056
1057         flags = addr & ~TARGET_PAGE_MASK;
1058         addr &= TARGET_PAGE_MASK;
1059
1060         if (flags & RAM_SAVE_FLAG_MEM_SIZE) {
1061             /* Synchronize RAM block list */
1062             char id[256];
1063             ram_addr_t length;
1064             ram_addr_t total_ram_bytes = addr;
1065
1066             while (total_ram_bytes) {
1067                 RAMBlock *block;
1068                 uint8_t len;
1069
1070                 len = qemu_get_byte(f);
1071                 qemu_get_buffer(f, (uint8_t *)id, len);
1072                 id[len] = 0;
1073                 length = qemu_get_be64(f);
1074
1075                 QTAILQ_FOREACH(block, &ram_list.blocks, next) {
1076                     if (!strncmp(id, block->idstr, sizeof(id))) {
1077                         if (block->length != length) {
1078                             fprintf(stderr,
1079                                     "Length mismatch: %s: " RAM_ADDR_FMT
1080                                     " in != " RAM_ADDR_FMT "\n", id, length,
1081                                     block->length);
1082                             ret =  -EINVAL;
1083                             goto done;
1084                         }
1085                         break;
1086                     }
1087                 }
1088
1089                 if (!block) {
1090                     fprintf(stderr, "Unknown ramblock \"%s\", cannot "
1091                             "accept migration\n", id);
1092                     ret = -EINVAL;
1093                     goto done;
1094                 }
1095
1096                 total_ram_bytes -= length;
1097             }
1098         }
1099
1100         if (flags & RAM_SAVE_FLAG_COMPRESS) {
1101             void *host;
1102             uint8_t ch;
1103
1104             host = host_from_stream_offset(f, addr, flags);
1105             if (!host) {
1106                 ret = -EINVAL;
1107                 goto done;
1108             }
1109
1110             ch = qemu_get_byte(f);
1111             ram_handle_compressed(host, ch, TARGET_PAGE_SIZE);
1112         } else if (flags & RAM_SAVE_FLAG_PAGE) {
1113             void *host;
1114
1115             host = host_from_stream_offset(f, addr, flags);
1116             if (!host) {
1117                 ret = -EINVAL;
1118                 goto done;
1119             }
1120
1121             qemu_get_buffer(f, host, TARGET_PAGE_SIZE);
1122         } else if (flags & RAM_SAVE_FLAG_XBZRLE) {
1123             void *host = host_from_stream_offset(f, addr, flags);
1124             if (!host) {
1125                 ret = -EINVAL;
1126                 goto done;
1127             }
1128
1129             if (load_xbzrle(f, addr, host) < 0) {
1130                 ret = -EINVAL;
1131                 goto done;
1132             }
1133         } else if (flags & RAM_SAVE_FLAG_HOOK) {
1134             ram_control_load_hook(f, flags);
1135         }
1136         error = qemu_file_get_error(f);
1137         if (error) {
1138             ret = error;
1139             goto done;
1140         }
1141     } while (!(flags & RAM_SAVE_FLAG_EOS));
1142
1143 done:
1144     DPRINTF("Completed load of VM with exit code %d seq iteration "
1145             "%" PRIu64 "\n", ret, seq_iter);
1146     return ret;
1147 }
1148
1149 static SaveVMHandlers savevm_ram_handlers = {
1150     .save_live_setup = ram_save_setup,
1151     .save_live_iterate = ram_save_iterate,
1152     .save_live_complete = ram_save_complete,
1153     .save_live_pending = ram_save_pending,
1154     .load_state = ram_load,
1155     .cancel = ram_migration_cancel,
1156 };
1157
1158 void ram_mig_init(void)
1159 {
1160     qemu_mutex_init(&XBZRLE.lock);
1161     register_savevm_live(NULL, "ram", 0, 4, &savevm_ram_handlers, NULL);
1162 }
1163
1164 struct soundhw {
1165     const char *name;
1166     const char *descr;
1167     int enabled;
1168     int isa;
1169     union {
1170         int (*init_isa) (ISABus *bus);
1171         int (*init_pci) (PCIBus *bus);
1172     } init;
1173 };
1174
1175 static struct soundhw soundhw[9];
1176 static int soundhw_count;
1177
1178 void isa_register_soundhw(const char *name, const char *descr,
1179                           int (*init_isa)(ISABus *bus))
1180 {
1181     assert(soundhw_count < ARRAY_SIZE(soundhw) - 1);
1182     soundhw[soundhw_count].name = name;
1183     soundhw[soundhw_count].descr = descr;
1184     soundhw[soundhw_count].isa = 1;
1185     soundhw[soundhw_count].init.init_isa = init_isa;
1186     soundhw_count++;
1187 }
1188
1189 void pci_register_soundhw(const char *name, const char *descr,
1190                           int (*init_pci)(PCIBus *bus))
1191 {
1192     assert(soundhw_count < ARRAY_SIZE(soundhw) - 1);
1193     soundhw[soundhw_count].name = name;
1194     soundhw[soundhw_count].descr = descr;
1195     soundhw[soundhw_count].isa = 0;
1196     soundhw[soundhw_count].init.init_pci = init_pci;
1197     soundhw_count++;
1198 }
1199
1200 void select_soundhw(const char *optarg)
1201 {
1202     struct soundhw *c;
1203
1204     if (is_help_option(optarg)) {
1205     show_valid_cards:
1206
1207         if (soundhw_count) {
1208              printf("Valid sound card names (comma separated):\n");
1209              for (c = soundhw; c->name; ++c) {
1210                  printf ("%-11s %s\n", c->name, c->descr);
1211              }
1212              printf("\n-soundhw all will enable all of the above\n");
1213         } else {
1214              printf("Machine has no user-selectable audio hardware "
1215                     "(it may or may not have always-present audio hardware).\n");
1216         }
1217         exit(!is_help_option(optarg));
1218     }
1219     else {
1220         size_t l;
1221         const char *p;
1222         char *e;
1223         int bad_card = 0;
1224
1225         if (!strcmp(optarg, "all")) {
1226             for (c = soundhw; c->name; ++c) {
1227                 c->enabled = 1;
1228             }
1229             return;
1230         }
1231
1232         p = optarg;
1233         while (*p) {
1234             e = strchr(p, ',');
1235             l = !e ? strlen(p) : (size_t) (e - p);
1236
1237             for (c = soundhw; c->name; ++c) {
1238                 if (!strncmp(c->name, p, l) && !c->name[l]) {
1239                     c->enabled = 1;
1240                     break;
1241                 }
1242             }
1243
1244             if (!c->name) {
1245                 if (l > 80) {
1246                     fprintf(stderr,
1247                             "Unknown sound card name (too big to show)\n");
1248                 }
1249                 else {
1250                     fprintf(stderr, "Unknown sound card name `%.*s'\n",
1251                             (int) l, p);
1252                 }
1253                 bad_card = 1;
1254             }
1255             p += l + (e != NULL);
1256         }
1257
1258         if (bad_card) {
1259             goto show_valid_cards;
1260         }
1261     }
1262 }
1263
1264 void audio_init(void)
1265 {
1266     struct soundhw *c;
1267     ISABus *isa_bus = (ISABus *) object_resolve_path_type("", TYPE_ISA_BUS, NULL);
1268     PCIBus *pci_bus = (PCIBus *) object_resolve_path_type("", TYPE_PCI_BUS, NULL);
1269
1270     for (c = soundhw; c->name; ++c) {
1271         if (c->enabled) {
1272             if (c->isa) {
1273                 if (!isa_bus) {
1274                     fprintf(stderr, "ISA bus not available for %s\n", c->name);
1275                     exit(1);
1276                 }
1277                 c->init.init_isa(isa_bus);
1278             } else {
1279                 if (!pci_bus) {
1280                     fprintf(stderr, "PCI bus not available for %s\n", c->name);
1281                     exit(1);
1282                 }
1283                 c->init.init_pci(pci_bus);
1284             }
1285         }
1286     }
1287 }
1288
1289 int qemu_uuid_parse(const char *str, uint8_t *uuid)
1290 {
1291     int ret;
1292
1293     if (strlen(str) != 36) {
1294         return -1;
1295     }
1296
1297     ret = sscanf(str, UUID_FMT, &uuid[0], &uuid[1], &uuid[2], &uuid[3],
1298                  &uuid[4], &uuid[5], &uuid[6], &uuid[7], &uuid[8], &uuid[9],
1299                  &uuid[10], &uuid[11], &uuid[12], &uuid[13], &uuid[14],
1300                  &uuid[15]);
1301
1302     if (ret != 16) {
1303         return -1;
1304     }
1305     return 0;
1306 }
1307
1308 void do_acpitable_option(const QemuOpts *opts)
1309 {
1310 #ifdef TARGET_I386
1311     Error *err = NULL;
1312
1313     acpi_table_add(opts, &err);
1314     if (err) {
1315         error_report("Wrong acpi table provided: %s",
1316                      error_get_pretty(err));
1317         error_free(err);
1318         exit(1);
1319     }
1320 #endif
1321 }
1322
1323 void do_smbios_option(QemuOpts *opts)
1324 {
1325 #ifdef TARGET_I386
1326     smbios_entry_add(opts);
1327 #endif
1328 }
1329
1330 void cpudef_init(void)
1331 {
1332 #if defined(cpudef_setup)
1333     cpudef_setup(); /* parse cpu definitions in target config file */
1334 #endif
1335 }
1336
1337 int tcg_available(void)
1338 {
1339     return 1;
1340 }
1341
1342 int kvm_available(void)
1343 {
1344 #ifdef CONFIG_KVM
1345     return 1;
1346 #else
1347     return 0;
1348 #endif
1349 }
1350
1351 int xen_available(void)
1352 {
1353 #ifdef CONFIG_XEN
1354     return 1;
1355 #else
1356     return 0;
1357 #endif
1358 }
1359
1360
1361 TargetInfo *qmp_query_target(Error **errp)
1362 {
1363     TargetInfo *info = g_malloc0(sizeof(*info));
1364
1365     info->arch = g_strdup(TARGET_NAME);
1366
1367     return info;
1368 }
1369
1370 /* Stub function that's gets run on the vcpu when its brought out of the
1371    VM to run inside qemu via async_run_on_cpu()*/
1372 static void mig_sleep_cpu(void *opq)
1373 {
1374     qemu_mutex_unlock_iothread();
1375     g_usleep(30*1000);
1376     qemu_mutex_lock_iothread();
1377 }
1378
1379 /* To reduce the dirty rate explicitly disallow the VCPUs from spending
1380    much time in the VM. The migration thread will try to catchup.
1381    Workload will experience a performance drop.
1382 */
1383 static void mig_throttle_guest_down(void)
1384 {
1385     CPUState *cpu;
1386
1387     qemu_mutex_lock_iothread();
1388     CPU_FOREACH(cpu) {
1389         async_run_on_cpu(cpu, mig_sleep_cpu, NULL);
1390     }
1391     qemu_mutex_unlock_iothread();
1392 }
1393
1394 static void check_guest_throttling(void)
1395 {
1396     static int64_t t0;
1397     int64_t        t1;
1398
1399     if (!mig_throttle_on) {
1400         return;
1401     }
1402
1403     if (!t0)  {
1404         t0 = qemu_clock_get_ns(QEMU_CLOCK_REALTIME);
1405         return;
1406     }
1407
1408     t1 = qemu_clock_get_ns(QEMU_CLOCK_REALTIME);
1409
1410     /* If it has been more than 40 ms since the last time the guest
1411      * was throttled then do it again.
1412      */
1413     if (40 < (t1-t0)/1000000) {
1414         mig_throttle_guest_down();
1415         t0 = t1;
1416     }
1417 }