vmx.h revision 330897 
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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 * $FreeBSD: stable/11/sys/amd64/vmm/intel/vmx.h 330897 2018-03-14 03:19:51Z eadler $
29 */
30
31#ifndef _VMX_H_
32#define	_VMX_H_
33
34#include "vmcs.h"
35
36struct pmap;
37
38struct vmxctx {
39	register_t	guest_rdi;		/* Guest state */
40	register_t	guest_rsi;
41	register_t	guest_rdx;
42	register_t	guest_rcx;
43	register_t	guest_r8;
44	register_t	guest_r9;
45	register_t	guest_rax;
46	register_t	guest_rbx;
47	register_t	guest_rbp;
48	register_t	guest_r10;
49	register_t	guest_r11;
50	register_t	guest_r12;
51	register_t	guest_r13;
52	register_t	guest_r14;
53	register_t	guest_r15;
54	register_t	guest_cr2;
55	register_t	guest_dr0;
56	register_t	guest_dr1;
57	register_t	guest_dr2;
58	register_t	guest_dr3;
59	register_t	guest_dr6;
60
61	register_t	host_r15;		/* Host state */
62	register_t	host_r14;
63	register_t	host_r13;
64	register_t	host_r12;
65	register_t	host_rbp;
66	register_t	host_rsp;
67	register_t	host_rbx;
68	register_t	host_dr0;
69	register_t	host_dr1;
70	register_t	host_dr2;
71	register_t	host_dr3;
72	register_t	host_dr6;
73	register_t	host_dr7;
74	uint64_t	host_debugctl;
75	int		host_tf;
76
77	int		inst_fail_status;
78
79	/*
80	 * The pmap needs to be deactivated in vmx_enter_guest()
81	 * so keep a copy of the 'pmap' in each vmxctx.
82	 */
83	struct pmap	*pmap;
84};
85
86struct vmxcap {
87	int	set;
88	uint32_t proc_ctls;
89	uint32_t proc_ctls2;
90};
91
92struct vmxstate {
93	uint64_t nextrip;	/* next instruction to be executed by guest */
94	int	lastcpu;	/* host cpu that this 'vcpu' last ran on */
95	uint16_t vpid;
96};
97
98struct apic_page {
99	uint32_t reg[PAGE_SIZE / 4];
100};
101CTASSERT(sizeof(struct apic_page) == PAGE_SIZE);
102
103/* Posted Interrupt Descriptor (described in section 29.6 of the Intel SDM) */
104struct pir_desc {
105	uint64_t	pir[4];
106	uint64_t	pending;
107	uint64_t	unused[3];
108} __aligned(64);
109CTASSERT(sizeof(struct pir_desc) == 64);
110
111/* Index into the 'guest_msrs[]' array */
112enum {
113	IDX_MSR_LSTAR,
114	IDX_MSR_CSTAR,
115	IDX_MSR_STAR,
116	IDX_MSR_SF_MASK,
117	IDX_MSR_KGSBASE,
118	IDX_MSR_PAT,
119	GUEST_MSR_NUM		/* must be the last enumeration */
120};
121
122/* virtual machine softc */
123struct vmx {
124	struct vmcs	vmcs[VM_MAXCPU];	/* one vmcs per virtual cpu */
125	struct apic_page apic_page[VM_MAXCPU];	/* one apic page per vcpu */
126	char		msr_bitmap[PAGE_SIZE];
127	struct pir_desc	pir_desc[VM_MAXCPU];
128	uint64_t	guest_msrs[VM_MAXCPU][GUEST_MSR_NUM];
129	struct vmxctx	ctx[VM_MAXCPU];
130	struct vmxcap	cap[VM_MAXCPU];
131	struct vmxstate	state[VM_MAXCPU];
132	uint64_t	eptp;
133	struct vm	*vm;
134	long		eptgen[MAXCPU];		/* cached pmap->pm_eptgen */
135};
136CTASSERT((offsetof(struct vmx, vmcs) & PAGE_MASK) == 0);
137CTASSERT((offsetof(struct vmx, msr_bitmap) & PAGE_MASK) == 0);
138CTASSERT((offsetof(struct vmx, pir_desc[0]) & 63) == 0);
139
140#define	VMX_GUEST_VMEXIT	0
141#define	VMX_VMRESUME_ERROR	1
142#define	VMX_VMLAUNCH_ERROR	2
143#define	VMX_INVEPT_ERROR	3
144int	vmx_enter_guest(struct vmxctx *ctx, struct vmx *vmx, int launched);
145void	vmx_call_isr(uintptr_t entry);
146
147u_long	vmx_fix_cr0(u_long cr0);
148u_long	vmx_fix_cr4(u_long cr4);
149
150int	vmx_set_tsc_offset(struct vmx *vmx, int vcpu, uint64_t offset);
151
152extern char	vmx_exit_guest[];
153extern char	vmx_exit_guest_flush_rsb[];
154
155#endif
156