migration/ram-compress.h

   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_COMPRESS_H
  30 #define QEMU_MIGRATION_COMPRESS_H
  31
  32 #include "qemu-file.h"
  33 #include "qapi/qapi-types-migration.h"
  34
  35 enum CompressResult {
  36     RES_NONE = 0,
  37     RES_ZEROPAGE = 1,
  38     RES_COMPRESS = 2
  39 };
  40 typedef enum CompressResult CompressResult;
  41
  42 struct CompressParam {
  43     bool done;
  44     bool quit;
  45     bool trigger;
  46     CompressResult result;
  47     QEMUFile *file;
  48     QemuMutex mutex;
  49     QemuCond cond;
  50     RAMBlock *block;
  51     ram_addr_t offset;
  52
  53     /* internally used fields */
  54     z_stream stream;
  55     uint8_t *originbuf;
  56 };
  57 typedef struct CompressParam CompressParam;
  58
  59 void compress_threads_save_cleanup(void);
  60 int compress_threads_save_setup(void);
  61
  62 bool compress_page_with_multi_thread(RAMBlock *block, ram_addr_t offset,
  63                                       int (send_queued_data(CompressParam *)));
  64
  65 int wait_for_decompress_done(void);
  66 void compress_threads_load_cleanup(void);
  67 int compress_threads_load_setup(QEMUFile *f);
  68 void decompress_data_with_multi_threads(QEMUFile *f, void *host, int len);
  69
  70 void populate_compress(MigrationInfo *info);
  71 uint64_t compress_ram_pages(void);
  72 void update_compress_thread_counts(const CompressParam *param, int bytes_xmit);
  73 void compress_update_rates(uint64_t page_count);
  74 int compress_send_queued_data(CompressParam *param);
  75 void compress_flush_data(void);
  76
  77 #endif