xref: /illumos-gate/usr/src/cmd/bhyve/common/bhyverun.h (revision 5c4a5fe16715fb423db76577a6883b5bbecdbe45)
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  * This file and its contents are supplied under the terms of the
30  * Common Development and Distribution License ("CDDL"), version 1.0.
31  * You may only use this file in accordance with the terms of version
32  * 1.0 of the CDDL.
33  *
34  * A full copy of the text of the CDDL should have accompanied this
35  * source.  A copy of the CDDL is also available via the Internet at
36  * http://www.illumos.org/license/CDDL.
37  *
38  * Copyright 2015 Pluribus Networks Inc.
39  */
40 
41 #ifndef	_BHYVERUN_H_
42 #define	_BHYVERUN_H_
43 
44 #define	VMEXIT_CONTINUE		(0)
45 #define	VMEXIT_ABORT		(-1)
46 
47 #include <stdbool.h>
48 
49 extern int guest_ncpus;
50 extern uint16_t cpu_cores, cpu_sockets, cpu_threads;
51 
52 struct vcpu;
53 struct vmctx;
54 struct vm_exit;
55 
56 extern void *paddr_guest2host(struct vmctx *ctx, uintptr_t addr, size_t len);
57 
58 struct vcpu *fbsdrun_vcpu(int vcpuid);
59 void fbsdrun_addcpu(int vcpuid, bool);
60 void fbsdrun_deletecpu(int vcpuid);
61 
62 int  fbsdrun_virtio_msix(void);
63 
64 typedef int (*vmexit_handler_t)(struct vmctx *, struct vcpu *,
65     struct vm_exit *);
66 
67 extern int vmexit_task_switch(struct vmctx *, struct vcpu *, struct vm_exit *);
68 
69 /* Interfaces implemented by machine-dependent code. */
70 void bhyve_init_config(void);
71 void bhyve_init_vcpu(struct vcpu *vcpu);
72 void bhyve_start_vcpu(struct vcpu *vcpu, bool bsp, bool suspend);
73 int bhyve_init_platform(struct vmctx *ctx, struct vcpu *bsp);
74 int bhyve_init_platform_late(struct vmctx *ctx, struct vcpu *bsp);
75 void bhyve_optparse(int argc, char **argv);
76 void bhyve_usage(int code);
77 
78 /* Interfaces used by command-line option-parsing code. */
79 bool bhyve_parse_config_option(const char *option);
80 void bhyve_parse_simple_config_file(const char *path);
81 void bhyve_parse_gdb_options(const char *opt);
82 #ifdef	__FreeBSD__
83 int bhyve_pincpu_parse(const char *opt);
84 #endif
85 int bhyve_topology_parse(const char *opt);
86 
87 #endif
88