usr.sbin/bhyve/snapshot.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2016 Flavius Anton
   5  * Copyright (c) 2016 Mihai Tiganus
   6  * Copyright (c) 2016-2019 Mihai Carabas
   7  * Copyright (c) 2017-2019 Darius Mihai
   8  * Copyright (c) 2017-2019 Elena Mihailescu
   9  * Copyright (c) 2018-2019 Sergiu Weisz
  10  * All rights reserved.
  11  * The bhyve-snapshot feature was developed under sponsorships
  12  * from Matthew Grooms.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions
  16  * are met:
  17  * 1. Redistributions of source code must retain the above copyright
  18  *    notice, this list of conditions and the following disclaimer.
  19  * 2. Redistributions in binary form must reproduce the above copyright
  20  *    notice, this list of conditions and the following disclaimer in the
  21  *    documentation and/or other materials provided with the distribution.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  *
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _BHYVE_SNAPSHOT_
  39 #define _BHYVE_SNAPSHOT_
  40
  41 #include <machine/vmm_snapshot.h>
  42 #include <libxo/xo.h>
  43 #include <ucl.h>
  44
  45 struct vmctx;
  46
  47 struct restore_state {
  48         int kdata_fd;
  49         int vmmem_fd;
  50
  51         void *kdata_map;
  52         size_t kdata_len;
  53
  54         size_t vmmem_len;
  55
  56         struct ucl_parser *meta_parser;
  57         ucl_object_t *meta_root_obj;
  58 };
  59
  60 struct checkpoint_thread_info {
  61         struct vmctx *ctx;
  62         int socket_fd;
  63 };
  64
  65 typedef int (*vm_snapshot_dev_cb)(struct vm_snapshot_meta *);
  66 typedef int (*vm_pause_dev_cb) (struct vmctx *, const char *);
  67 typedef int (*vm_resume_dev_cb) (struct vmctx *, const char *);
  68
  69 struct vm_snapshot_dev_info {
  70         const char *dev_name;           /* device name */
  71         vm_snapshot_dev_cb snapshot_cb; /* callback for device snapshot */
  72         vm_pause_dev_cb pause_cb;       /* callback for device pause */
  73         vm_resume_dev_cb resume_cb;     /* callback for device resume */
  74 };
  75
  76 struct vm_snapshot_kern_info {
  77         const char *struct_name;        /* kernel structure name*/
  78         enum snapshot_req req;          /* request type */
  79 };
  80
  81 void destroy_restore_state(struct restore_state *rstate);
  82
  83 const char *lookup_vmname(struct restore_state *rstate);
  84 int lookup_memflags(struct restore_state *rstate);
  85 size_t lookup_memsize(struct restore_state *rstate);
  86 int lookup_guest_ncpus(struct restore_state *rstate);
  87
  88 void checkpoint_cpu_add(int vcpu);
  89 void checkpoint_cpu_resume(int vcpu);
  90 void checkpoint_cpu_suspend(int vcpu);
  91
  92 int restore_vm_mem(struct vmctx *ctx, struct restore_state *rstate);
  93 int vm_restore_kern_structs(struct vmctx *ctx, struct restore_state *rstate);
  94
  95 int vm_restore_user_devs(struct vmctx *ctx, struct restore_state *rstate);
  96 int vm_pause_user_devs(struct vmctx *ctx);
  97 int vm_resume_user_devs(struct vmctx *ctx);
  98
  99 int get_checkpoint_msg(int conn_fd, struct vmctx *ctx);
 100 void *checkpoint_thread(void *param);
 101 int init_checkpoint_thread(struct vmctx *ctx);
 102
 103 int load_restore_file(const char *filename, struct restore_state *rstate);
 104
 105 #endif