2 * Copyright (c) 2011 NetApp, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/types.h>
34 #include <machine/specialreg.h>
35 #include <machine/segments.h>
36 #include <machine/vmm.h>
43 #define I386_TSS_SIZE 104
45 #define DESC_PRESENT 0x00000080
46 #define DESC_LONGMODE 0x00002000
47 #define DESC_DEF32 0x00004000
48 #define DESC_GRAN 0x00008000
49 #define DESC_UNUSABLE 0x00010000
51 #define GUEST_NULL_SEL 0
52 #define GUEST_CODE_SEL 1
53 #define GUEST_DATA_SEL 2
54 #define GUEST_TSS_SEL 3
55 #define GUEST_GDTR_LIMIT64 (3 * 8 - 1)
57 static struct segment_descriptor i386_gdt[] = {
59 { .sd_lolimit = 0xffff, .sd_type = SDT_MEMER, /* CODE */
60 .sd_p = 1, .sd_hilimit = 0xf, .sd_def32 = 1, .sd_gran = 1 },
61 { .sd_lolimit = 0xffff, .sd_type = SDT_MEMRW, /* DATA */
62 .sd_p = 1, .sd_hilimit = 0xf, .sd_def32 = 1, .sd_gran = 1 },
63 { .sd_lolimit = I386_TSS_SIZE - 1, /* TSS */
64 .sd_type = SDT_SYS386TSS, .sd_p = 1 }
68 * Setup the 'vcpu' register set such that it will begin execution at
72 vm_setup_freebsd_registers_i386(struct vmctx *vmctx, int vcpu, uint32_t eip,
73 uint32_t gdtbase, uint32_t esp)
75 uint64_t cr0, rflags, desc_base;
76 uint32_t desc_access, desc_limit, tssbase;
78 struct segment_descriptor *gdt;
81 /* A 32-bit guest requires unrestricted mode. */
82 error = vm_get_capability(vmctx, vcpu, VM_CAP_UNRESTRICTED_GUEST, &tmp);
85 error = vm_set_capability(vmctx, vcpu, VM_CAP_UNRESTRICTED_GUEST, 1);
89 cr0 = CR0_PE | CR0_NE;
90 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CR0, cr0)) != 0)
93 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CR4, 0)) != 0)
97 * Forcing EFER to 0 causes bhyve to clear the "IA-32e guest
98 * mode" entry control.
100 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_EFER, 0)))
103 gdt = vm_map_gpa(vmctx, gdtbase, 0x1000);
106 memcpy(gdt, i386_gdt, sizeof(i386_gdt));
108 desc_limit = sizeof(i386_gdt) - 1;
109 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_GDTR,
110 desc_base, desc_limit, 0);
114 /* Place the TSS one page above the GDT. */
115 tssbase = gdtbase + 0x1000;
116 gdt[3].sd_lobase = tssbase;
119 error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RFLAGS, rflags);
124 desc_limit = 0xffffffff;
125 desc_access = DESC_GRAN | DESC_DEF32 | DESC_PRESENT | SDT_MEMERA;
126 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_CS,
127 desc_base, desc_limit, desc_access);
129 desc_access = DESC_GRAN | DESC_DEF32 | DESC_PRESENT | SDT_MEMRWA;
130 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_DS,
131 desc_base, desc_limit, desc_access);
135 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_ES,
136 desc_base, desc_limit, desc_access);
140 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_FS,
141 desc_base, desc_limit, desc_access);
145 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_GS,
146 desc_base, desc_limit, desc_access);
150 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_SS,
151 desc_base, desc_limit, desc_access);
156 desc_limit = I386_TSS_SIZE - 1;
157 desc_access = DESC_PRESENT | SDT_SYS386BSY;
158 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_TR,
159 desc_base, desc_limit, desc_access);
164 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_LDTR, 0, 0,
169 gsel = GSEL(GUEST_CODE_SEL, SEL_KPL);
170 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CS, gsel)) != 0)
173 gsel = GSEL(GUEST_DATA_SEL, SEL_KPL);
174 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_DS, gsel)) != 0)
177 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_ES, gsel)) != 0)
180 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_FS, gsel)) != 0)
183 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_GS, gsel)) != 0)
186 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_SS, gsel)) != 0)
189 gsel = GSEL(GUEST_TSS_SEL, SEL_KPL);
190 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_TR, gsel)) != 0)
193 /* LDTR is pointing to the null selector */
194 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_LDTR, 0)) != 0)
198 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RIP, eip)) != 0)
201 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RSP, esp)) != 0)
210 vm_setup_freebsd_gdt(uint64_t *gdtr)
212 gdtr[GUEST_NULL_SEL] = 0;
213 gdtr[GUEST_CODE_SEL] = 0x0020980000000000;
214 gdtr[GUEST_DATA_SEL] = 0x0000900000000000;
218 * Setup the 'vcpu' register set such that it will begin execution at
219 * 'rip' in long mode.
222 vm_setup_freebsd_registers(struct vmctx *vmctx, int vcpu,
223 uint64_t rip, uint64_t cr3, uint64_t gdtbase,
227 uint64_t cr0, cr4, efer, rflags, desc_base;
228 uint32_t desc_access, desc_limit;
231 cr0 = CR0_PE | CR0_PG | CR0_NE;
232 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CR0, cr0)) != 0)
236 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CR4, cr4)) != 0)
239 efer = EFER_LME | EFER_LMA;
240 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_EFER, efer)))
244 error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RFLAGS, rflags);
250 desc_access = 0x0000209B;
251 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_CS,
252 desc_base, desc_limit, desc_access);
256 desc_access = 0x00000093;
257 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_DS,
258 desc_base, desc_limit, desc_access);
262 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_ES,
263 desc_base, desc_limit, desc_access);
267 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_FS,
268 desc_base, desc_limit, desc_access);
272 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_GS,
273 desc_base, desc_limit, desc_access);
277 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_SS,
278 desc_base, desc_limit, desc_access);
283 * XXX TR is pointing to null selector even though we set the
284 * TSS segment to be usable with a base address and limit of 0.
286 desc_access = 0x0000008b;
287 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_TR, 0, 0, desc_access);
291 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_LDTR, 0, 0,
296 gsel = GSEL(GUEST_CODE_SEL, SEL_KPL);
297 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CS, gsel)) != 0)
300 gsel = GSEL(GUEST_DATA_SEL, SEL_KPL);
301 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_DS, gsel)) != 0)
304 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_ES, gsel)) != 0)
307 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_FS, gsel)) != 0)
310 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_GS, gsel)) != 0)
313 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_SS, gsel)) != 0)
316 /* XXX TR is pointing to the null selector */
317 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_TR, 0)) != 0)
320 /* LDTR is pointing to the null selector */
321 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_LDTR, 0)) != 0)
325 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RIP, rip)) != 0)
328 /* page table base */
329 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_CR3, cr3)) != 0)
333 desc_limit = GUEST_GDTR_LIMIT64;
334 error = vm_set_desc(vmctx, vcpu, VM_REG_GUEST_GDTR,
335 desc_base, desc_limit, 0);
339 if ((error = vm_set_register(vmctx, vcpu, VM_REG_GUEST_RSP, rsp)) != 0)