usr.sbin/bhyve/bhyverun.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2011 NetApp, Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #ifndef _BHYVERUN_H_
  30 #define _BHYVERUN_H_
  31
  32 #include <stdbool.h>
  33
  34 #define VMEXIT_CONTINUE         (0)
  35 #define VMEXIT_ABORT            (-1)
  36
  37 extern int guest_ncpus;
  38 extern uint16_t cpu_cores, cpu_sockets, cpu_threads;
  39
  40 #ifdef BHYVE_SNAPSHOT
  41 extern char *restore_file;
  42 #endif
  43
  44 struct vcpu;
  45 struct vmctx;
  46 struct vm_run;
  47
  48 void *paddr_guest2host(struct vmctx *ctx, uintptr_t addr, size_t len);
  49 #ifdef BHYVE_SNAPSHOT
  50 uintptr_t paddr_host2guest(struct vmctx *ctx, void *addr);
  51 #endif
  52
  53 struct vcpu;
  54 struct vcpu *fbsdrun_vcpu(int vcpuid);
  55 void fbsdrun_addcpu(int vcpuid);
  56 void fbsdrun_deletecpu(int vcpuid);
  57 int fbsdrun_suspendcpu(int vcpuid);
  58
  59 int  fbsdrun_virtio_msix(void);
  60
  61 typedef int (*vmexit_handler_t)(struct vmctx *, struct vcpu *, struct vm_run *);
  62
  63 /* Interfaces implemented by machine-dependent code. */
  64 void bhyve_init_config(void);
  65 void bhyve_optparse(int argc, char **argv);
  66 void bhyve_usage(int code);
  67
  68 /* Interfaces used by command-line option-parsing code. */
  69 bool bhyve_parse_config_option(const char *option);
  70 void bhyve_parse_simple_config_file(const char *path);
  71 #ifdef BHYVE_GDB
  72 void bhyve_parse_gdb_options(const char *opt);
  73 #endif
  74 int bhyve_pincpu_parse(const char *opt);
  75 int bhyve_topology_parse(const char *opt);
  76
  77 void bhyve_init_vcpu(struct vcpu *vcpu);
  78 void bhyve_start_vcpu(struct vcpu *vcpu, bool bsp);
  79 int bhyve_init_platform(struct vmctx *ctx, struct vcpu *bsp);
  80 int bhyve_init_platform_late(struct vmctx *ctx, struct vcpu *bsp);
  81
  82 #endif