include/migration/misc.h

   1 /*
   2  * QEMU migration miscellaneus exported functions
   3  *
   4  * Copyright IBM, Corp. 2008
   5  *
   6  * Authors:
   7  *  Anthony Liguori   <aliguori@us.ibm.com>
   8  *
   9  * This work is licensed under the terms of the GNU GPL, version 2.  See
  10  * the COPYING file in the top-level directory.
  11  *
  12  */
  13
  14 #ifndef MIGRATION_MISC_H
  15 #define MIGRATION_MISC_H
  16
  17 #include "qemu/notify.h"
  18 #include "qapi/qapi-types-migration.h"
  19 #include "qapi/qapi-types-net.h"
  20 #include "migration/client-options.h"
  21
  22 /* migration/ram.c */
  23
  24 typedef enum PrecopyNotifyReason {
  25     PRECOPY_NOTIFY_SETUP = 0,
  26     PRECOPY_NOTIFY_BEFORE_BITMAP_SYNC = 1,
  27     PRECOPY_NOTIFY_AFTER_BITMAP_SYNC = 2,
  28     PRECOPY_NOTIFY_COMPLETE = 3,
  29     PRECOPY_NOTIFY_CLEANUP = 4,
  30     PRECOPY_NOTIFY_MAX = 5,
  31 } PrecopyNotifyReason;
  32
  33 typedef struct PrecopyNotifyData {
  34     enum PrecopyNotifyReason reason;
  35 } PrecopyNotifyData;
  36
  37 void precopy_infrastructure_init(void);
  38 void precopy_add_notifier(NotifierWithReturn *n);
  39 void precopy_remove_notifier(NotifierWithReturn *n);
  40 int precopy_notify(PrecopyNotifyReason reason, Error **errp);
  41
  42 void ram_mig_init(void);
  43 void qemu_guest_free_page_hint(void *addr, size_t len);
  44 bool migrate_ram_is_ignored(RAMBlock *block);
  45
  46 /* migration/block.c */
  47
  48 AnnounceParameters *migrate_announce_params(void);
  49 /* migration/savevm.c */
  50
  51 void dump_vmstate_json_to_file(FILE *out_fp);
  52
  53 /* migration/migration.c */
  54 void migration_object_init(void);
  55 void migration_shutdown(void);
  56 bool migration_is_idle(void);
  57 bool migration_is_active(void);
  58 bool migration_is_device(void);
  59 bool migration_thread_is_self(void);
  60 bool migration_is_setup_or_active(void);
  61
  62 typedef enum MigrationEventType {
  63     MIG_EVENT_PRECOPY_SETUP,
  64     MIG_EVENT_PRECOPY_DONE,
  65     MIG_EVENT_PRECOPY_FAILED,
  66     MIG_EVENT_MAX
  67 } MigrationEventType;
  68
  69 typedef struct MigrationEvent {
  70     MigrationEventType type;
  71 } MigrationEvent;
  72
  73 /*
  74  * A MigrationNotifyFunc may return an error code and an Error object,
  75  * but only when @e->type is MIG_EVENT_PRECOPY_SETUP.  The code is an int
  76  * to allow for different failure modes and recovery actions.
  77  */
  78 typedef int (*MigrationNotifyFunc)(NotifierWithReturn *notify,
  79                                    MigrationEvent *e, Error **errp);
  80
  81 /*
  82  * Register the notifier @notify to be called when a migration event occurs
  83  * for MIG_MODE_NORMAL, as specified by the MigrationEvent passed to @func.
  84  * Notifiers may receive events in any of the following orders:
  85  *    - MIG_EVENT_PRECOPY_SETUP -> MIG_EVENT_PRECOPY_DONE
  86  *    - MIG_EVENT_PRECOPY_SETUP -> MIG_EVENT_PRECOPY_FAILED
  87  *    - MIG_EVENT_PRECOPY_FAILED
  88  */
  89 void migration_add_notifier(NotifierWithReturn *notify,
  90                             MigrationNotifyFunc func);
  91
  92 /*
  93  * Same as migration_add_notifier, but applies to be specified @mode.
  94  */
  95 void migration_add_notifier_mode(NotifierWithReturn *notify,
  96                                  MigrationNotifyFunc func, MigMode mode);
  97
  98 void migration_remove_notifier(NotifierWithReturn *notify);
  99 bool migration_is_running(void);
 100 void migration_file_set_error(int ret, Error *err);
 101
 102 /* True if incoming migration entered POSTCOPY_INCOMING_DISCARD */
 103 bool migration_in_incoming_postcopy(void);
 104
 105 /* True if incoming migration entered POSTCOPY_INCOMING_ADVISE */
 106 bool migration_incoming_postcopy_advised(void);
 107
 108 /* True if background snapshot is active */
 109 bool migration_in_bg_snapshot(void);
 110
 111 /* migration/block-dirty-bitmap.c */
 112 void dirty_bitmap_mig_init(void);
 113
 114 #endif