2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2011 NetApp, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/types.h>
36 #include <machine/specialreg.h>
37 #include <machine/segments.h>
38 #include <machine/vmm.h>
45 #define I386_TSS_SIZE 104
47 #define DESC_PRESENT 0x00000080
48 #define DESC_LONGMODE 0x00002000
49 #define DESC_DEF32 0x00004000
50 #define DESC_GRAN 0x00008000
51 #define DESC_UNUSABLE 0x00010000
53 #define GUEST_NULL_SEL 0
54 #define GUEST_CODE_SEL 1
55 #define GUEST_DATA_SEL 2
56 #define GUEST_TSS_SEL 3
57 #define GUEST_GDTR_LIMIT64 (3 * 8 - 1)
59 static struct segment_descriptor i386_gdt[] = {
61 { .sd_lolimit = 0xffff, .sd_type = SDT_MEMER, /* CODE */
62 .sd_p = 1, .sd_hilimit = 0xf, .sd_def32 = 1, .sd_gran = 1 },
63 { .sd_lolimit = 0xffff, .sd_type = SDT_MEMRW, /* DATA */
64 .sd_p = 1, .sd_hilimit = 0xf, .sd_def32 = 1, .sd_gran = 1 },
65 { .sd_lolimit = I386_TSS_SIZE - 1, /* TSS */
66 .sd_type = SDT_SYS386TSS, .sd_p = 1 }
70 * Setup the 'vcpu' register set such that it will begin execution at
74 vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu, uint32_t eip,
75 uint32_t gdtbase, uint32_t esp)
77 uint64_t cr0, rflags, desc_base;
78 uint32_t desc_access, desc_limit, tssbase;
80 struct segment_descriptor *gdt;
83 /* A 32-bit guest requires unrestricted mode. */
84 error = vm_get_capability(vmctx, vcpu, VM_CAP_UNRESTRICTED_GUEST, &tmp);
87 error = vm_set_capability(vmctx, vcpu, VM_CAP_UNRESTRICTED_GUEST, 1);
91 cr0 = CR0_PE | CR0_NE;
92 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CR0, cr0)) != 0)
95 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CR4, 0)) != 0)
99 * Forcing EFER to 0 causes bhyve to clear the "IA-32e guest
100 * mode" entry control.
102 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_EFER, 0)))
105 gdt = vm_map_gpa(vmctx, gdtbase, 0x1000);
108 memcpy(gdt, i386_gdt, sizeof(i386_gdt));
110 desc_limit = sizeof(i386_gdt) - 1;
111 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_GDTR,
112 desc_base, desc_limit, 0);
116 /* Place the TSS one page above the GDT. */
117 tssbase = gdtbase + 0x1000;
118 gdt[3].sd_lobase = tssbase;
121 error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RFLAGS, rflags);
126 desc_limit = 0xffffffff;
127 desc_access = DESC_GRAN | DESC_DEF32 | DESC_PRESENT | SDT_MEMERA;
128 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_CS,
129 desc_base, desc_limit, desc_access);
131 desc_access = DESC_GRAN | DESC_DEF32 | DESC_PRESENT | SDT_MEMRWA;
132 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_DS,
133 desc_base, desc_limit, desc_access);
137 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_ES,
138 desc_base, desc_limit, desc_access);
142 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_FS,
143 desc_base, desc_limit, desc_access);
147 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_GS,
148 desc_base, desc_limit, desc_access);
152 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_SS,
153 desc_base, desc_limit, desc_access);
158 desc_limit = I386_TSS_SIZE - 1;
159 desc_access = DESC_PRESENT | SDT_SYS386BSY;
160 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_TR,
161 desc_base, desc_limit, desc_access);
166 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_LDTR, 0, 0,
171 gsel = GSEL(GUEST_CODE_SEL, SEL_KPL);
172 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CS, gsel)) != 0)
175 gsel = GSEL(GUEST_DATA_SEL, SEL_KPL);
176 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_DS, gsel)) != 0)
179 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_ES, gsel)) != 0)
182 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_FS, gsel)) != 0)
185 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_GS, gsel)) != 0)
188 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_SS, gsel)) != 0)
191 gsel = GSEL(GUEST_TSS_SEL, SEL_KPL);
192 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_TR, gsel)) != 0)
195 /* LDTR is pointing to the null selector */
196 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_LDTR, 0)) != 0)
200 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RIP, eip)) != 0)
203 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RSP, esp)) != 0)
212 vm_setup_freebsd_gdt(uint64_t *gdtr)
214 gdtr[GUEST_NULL_SEL] = 0;
215 gdtr[GUEST_CODE_SEL] = 0x0020980000000000;
216 gdtr[GUEST_DATA_SEL] = 0x0000900000000000;
220 * Setup the 'vcpu' register set such that it will begin execution at
221 * 'rip' in long mode.
224 vm_setup_freebsd_registers(struct vmctx *vmctx, int vcpu,
225 uint64_t rip, uint64_t cr3, uint64_t gdtbase,
229 uint64_t cr0, cr4, efer, rflags, desc_base;
230 uint32_t desc_access, desc_limit;
233 cr0 = CR0_PE | CR0_PG | CR0_NE;
234 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CR0, cr0)) != 0)
238 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CR4, cr4)) != 0)
241 efer = EFER_LME | EFER_LMA;
242 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_EFER, efer)))
246 error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RFLAGS, rflags);
252 desc_access = 0x0000209B;
253 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_CS,
254 desc_base, desc_limit, desc_access);
258 desc_access = 0x00000093;
259 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_DS,
260 desc_base, desc_limit, desc_access);
264 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_ES,
265 desc_base, desc_limit, desc_access);
269 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_FS,
270 desc_base, desc_limit, desc_access);
274 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_GS,
275 desc_base, desc_limit, desc_access);
279 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_SS,
280 desc_base, desc_limit, desc_access);
285 * XXX TR is pointing to null selector even though we set the
286 * TSS segment to be usable with a base address and limit of 0.
288 desc_access = 0x0000008b;
289 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_TR, 0, 0, desc_access);
293 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_LDTR, 0, 0,
298 gsel = GSEL(GUEST_CODE_SEL, SEL_KPL);
299 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CS, gsel)) != 0)
302 gsel = GSEL(GUEST_DATA_SEL, SEL_KPL);
303 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_DS, gsel)) != 0)
306 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_ES, gsel)) != 0)
309 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_FS, gsel)) != 0)
312 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_GS, gsel)) != 0)
315 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_SS, gsel)) != 0)
318 /* XXX TR is pointing to the null selector */
319 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_TR, 0)) != 0)
322 /* LDTR is pointing to the null selector */
323 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_LDTR, 0)) != 0)
327 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RIP, rip)) != 0)
330 /* page table base */
331 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CR3, cr3)) != 0)
335 desc_limit = GUEST_GDTR_LIMIT64;
336 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_GDTR,
337 desc_base, desc_limit, 0);
341 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RSP, rsp)) != 0)