2 * Copyright (c) 1997 Jonathan Lemon
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 THE AUTHOR AND CONTRIBUTORS ``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 THE AUTHOR 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
26 * $FreeBSD: src/sys/i386/i386/vm86.c,v 1.31.2.2 2001/10/05 06:18:55 peter Exp $
29 #include <sys/param.h>
30 #include <sys/systm.h>
33 #include <sys/malloc.h>
37 #include <vm/vm_map.h>
38 #include <vm/vm_page.h>
42 #include <machine/md_var.h>
43 #include <machine/pcb_ext.h> /* pcb.h included via sys/user.h */
44 #include <machine/psl.h>
45 #include <machine/specialreg.h>
46 #include <machine/sysarch.h>
48 extern int i386_extend_pcb __P((struct proc *));
50 extern struct pcb *vm86pcb;
52 extern int vm86_bioscall(struct vm86frame *);
53 extern void vm86_biosret(struct vm86frame *);
55 void vm86_prepcall(struct vm86frame);
71 #define OPERAND_SIZE_PREFIX 0x66
72 #define ADDRESS_SIZE_PREFIX 0x67
73 #define PUSH_MASK ~(PSL_VM | PSL_RF | PSL_I)
74 #define POP_MASK ~(PSL_VIP | PSL_VIF | PSL_VM | PSL_RF | PSL_IOPL)
76 static __inline caddr_t
77 MAKE_ADDR(u_short sel, u_short off)
79 return ((caddr_t)((sel << 4) + off));
83 GET_VEC(u_int vec, u_short *sel, u_short *off)
90 MAKE_VEC(u_short sel, u_short off)
92 return ((sel << 16) | off);
96 PUSH(u_short x, struct vm86frame *vmf)
99 susword(MAKE_ADDR(vmf->vmf_ss, vmf->vmf_sp), x);
103 PUSHL(u_int x, struct vm86frame *vmf)
106 suword(MAKE_ADDR(vmf->vmf_ss, vmf->vmf_sp), x);
109 static __inline u_short
110 POP(struct vm86frame *vmf)
112 u_short x = fusword(MAKE_ADDR(vmf->vmf_ss, vmf->vmf_sp));
118 static __inline u_int
119 POPL(struct vm86frame *vmf)
121 u_int x = fuword(MAKE_ADDR(vmf->vmf_ss, vmf->vmf_sp));
129 struct vm86frame *vmf;
131 struct vm86_kernel *vm86;
139 * pcb_ext contains the address of the extension area, or zero if
140 * the extension is not present. (This check should not be needed,
141 * as we can't enter vm86 mode until we set up an extension area)
143 if (curpcb->pcb_ext == 0)
145 vm86 = &curpcb->pcb_ext->ext_vm86;
147 if (vmf->vmf_eflags & PSL_T)
150 addr = MAKE_ADDR(vmf->vmf_cs, vmf->vmf_ip);
151 i_byte = fubyte(addr);
152 if (i_byte == ADDRESS_SIZE_PREFIX) {
153 i_byte = fubyte(++addr);
157 if (vm86->vm86_has_vme) {
159 case OPERAND_SIZE_PREFIX:
160 i_byte = fubyte(++addr);
164 if (vmf->vmf_eflags & PSL_VIF)
165 PUSHL((vmf->vmf_eflags & PUSH_MASK)
166 | PSL_IOPL | PSL_I, vmf);
168 PUSHL((vmf->vmf_eflags & PUSH_MASK)
170 vmf->vmf_ip += inc_ip;
174 temp_flags = POPL(vmf) & POP_MASK;
175 vmf->vmf_eflags = (vmf->vmf_eflags & ~POP_MASK)
176 | temp_flags | PSL_VM | PSL_I;
177 vmf->vmf_ip += inc_ip;
178 if (temp_flags & PSL_I) {
179 vmf->vmf_eflags |= PSL_VIF;
180 if (vmf->vmf_eflags & PSL_VIP)
183 vmf->vmf_eflags &= ~PSL_VIF;
189 /* VME faults here if VIP is set, but does not set VIF. */
191 vmf->vmf_eflags |= PSL_VIF;
192 vmf->vmf_ip += inc_ip;
193 if ((vmf->vmf_eflags & PSL_VIP) == 0) {
194 uprintf("fatal sti\n");
199 /* VME if no redirection support */
203 /* VME if trying to set PSL_TF, or PSL_I when VIP is set */
205 temp_flags = POP(vmf) & POP_MASK;
206 vmf->vmf_flags = (vmf->vmf_flags & ~POP_MASK)
207 | temp_flags | PSL_VM | PSL_I;
208 vmf->vmf_ip += inc_ip;
209 if (temp_flags & PSL_I) {
210 vmf->vmf_eflags |= PSL_VIF;
211 if (vmf->vmf_eflags & PSL_VIP)
214 vmf->vmf_eflags &= ~PSL_VIF;
218 /* VME if trying to set PSL_TF, or PSL_I when VIP is set */
220 vmf->vmf_ip = POP(vmf);
221 vmf->vmf_cs = POP(vmf);
222 temp_flags = POP(vmf) & POP_MASK;
223 vmf->vmf_flags = (vmf->vmf_flags & ~POP_MASK)
224 | temp_flags | PSL_VM | PSL_I;
225 if (temp_flags & PSL_I) {
226 vmf->vmf_eflags |= PSL_VIF;
227 if (vmf->vmf_eflags & PSL_VIP)
230 vmf->vmf_eflags &= ~PSL_VIF;
239 case OPERAND_SIZE_PREFIX:
240 i_byte = fubyte(++addr);
244 if (vm86->vm86_eflags & PSL_VIF)
245 PUSHL((vmf->vmf_flags & PUSH_MASK)
246 | PSL_IOPL | PSL_I, vmf);
248 PUSHL((vmf->vmf_flags & PUSH_MASK)
250 vmf->vmf_ip += inc_ip;
254 temp_flags = POPL(vmf) & POP_MASK;
255 vmf->vmf_eflags = (vmf->vmf_eflags & ~POP_MASK)
256 | temp_flags | PSL_VM | PSL_I;
257 vmf->vmf_ip += inc_ip;
258 if (temp_flags & PSL_I) {
259 vm86->vm86_eflags |= PSL_VIF;
260 if (vm86->vm86_eflags & PSL_VIP)
263 vm86->vm86_eflags &= ~PSL_VIF;
270 vm86->vm86_eflags &= ~PSL_VIF;
271 vmf->vmf_ip += inc_ip;
275 /* if there is a pending interrupt, go to the emulator */
276 vm86->vm86_eflags |= PSL_VIF;
277 vmf->vmf_ip += inc_ip;
278 if (vm86->vm86_eflags & PSL_VIP)
283 if (vm86->vm86_eflags & PSL_VIF)
284 PUSH((vmf->vmf_flags & PUSH_MASK)
285 | PSL_IOPL | PSL_I, vmf);
287 PUSH((vmf->vmf_flags & PUSH_MASK) | PSL_IOPL, vmf);
288 vmf->vmf_ip += inc_ip;
292 i_byte = fubyte(addr + 1);
293 if ((vm86->vm86_intmap[i_byte >> 3] & (1 << (i_byte & 7))) != 0)
295 if (vm86->vm86_eflags & PSL_VIF)
296 PUSH((vmf->vmf_flags & PUSH_MASK)
297 | PSL_IOPL | PSL_I, vmf);
299 PUSH((vmf->vmf_flags & PUSH_MASK) | PSL_IOPL, vmf);
300 PUSH(vmf->vmf_cs, vmf);
301 PUSH(vmf->vmf_ip + inc_ip + 1, vmf); /* increment IP */
302 GET_VEC(fuword((caddr_t)(i_byte * 4)),
303 &vmf->vmf_cs, &vmf->vmf_ip);
304 vmf->vmf_flags &= ~PSL_T;
305 vm86->vm86_eflags &= ~PSL_VIF;
309 vmf->vmf_ip = POP(vmf);
310 vmf->vmf_cs = POP(vmf);
311 temp_flags = POP(vmf) & POP_MASK;
312 vmf->vmf_flags = (vmf->vmf_flags & ~POP_MASK)
313 | temp_flags | PSL_VM | PSL_I;
314 if (temp_flags & PSL_I) {
315 vm86->vm86_eflags |= PSL_VIF;
316 if (vm86->vm86_eflags & PSL_VIP)
319 vm86->vm86_eflags &= ~PSL_VIF;
324 temp_flags = POP(vmf) & POP_MASK;
325 vmf->vmf_flags = (vmf->vmf_flags & ~POP_MASK)
326 | temp_flags | PSL_VM | PSL_I;
327 vmf->vmf_ip += inc_ip;
328 if (temp_flags & PSL_I) {
329 vm86->vm86_eflags |= PSL_VIF;
330 if (vm86->vm86_eflags & PSL_VIP)
333 vm86->vm86_eflags &= ~PSL_VIF;
340 #define PGTABLE_SIZE ((1024 + 64) * 1024 / PAGE_SIZE)
341 #define INTMAP_SIZE 32
342 #define IOMAP_SIZE ctob(IOPAGES)
344 (sizeof(struct pcb_ext) - sizeof(struct segment_descriptor) + \
345 INTMAP_SIZE + IOMAP_SIZE + 1)
348 pt_entry_t vml_pgtbl[PGTABLE_SIZE];
350 struct pcb_ext vml_ext;
351 char vml_intmap[INTMAP_SIZE];
352 char vml_iomap[IOMAP_SIZE];
353 char vml_iomap_trailer;
357 vm86_initialize(void)
361 struct vm86_layout *vml = (struct vm86_layout *)vm86paddr;
364 struct soft_segment_descriptor ssd = {
365 0, /* segment base address (overwritten) */
366 0, /* length (overwritten) */
367 SDT_SYS386TSS, /* segment type */
368 0, /* priority level */
369 1, /* descriptor present */
371 0, /* default 16 size */
376 * this should be a compile time error, but cpp doesn't grok sizeof().
378 if (sizeof(struct vm86_layout) > ctob(3))
379 panic("struct vm86_layout exceeds space allocated in locore.s");
382 * Below is the memory layout that we use for the vm86 region.
390 * +--------+ +--------+ <--------- vm86paddr
391 * | | |Page Tbl| 1M + 64K = 272 entries = 1088 bytes
393 * | | | PCB | size: ~240 bytes
394 * | page 1 | |PCB Ext | size: ~140 bytes (includes TSS)
400 * +--------+ | bitmap |
407 * A rudimentary PCB must be installed, in order to get to the
408 * PCB extension area. We use the PCB area as a scratchpad for
409 * data storage, the layout of which is shown below.
411 * pcb_esi = new PTD entry 0
412 * pcb_ebp = pointer to frame on vm86 stack
413 * pcb_esp = stack frame pointer at time of switch
414 * pcb_ebx = va of vm86 page table
415 * pcb_eip = argument pointer to initial call
416 * pcb_spare[0] = saved TSS descriptor, word 0
417 * pcb_space[1] = saved TSS descriptor, word 1
419 #define new_ptd pcb_esi
420 #define vm86_frame pcb_ebp
421 #define pgtable_va pcb_ebx
426 bzero(pcb, sizeof(struct pcb));
427 pcb->new_ptd = vm86pa | PG_V | PG_RW | PG_U;
428 pcb->vm86_frame = vm86paddr - sizeof(struct vm86frame);
429 pcb->pgtable_va = vm86paddr;
432 bzero(ext, sizeof(struct pcb_ext));
433 ext->ext_tss.tss_esp0 = vm86paddr;
434 ext->ext_tss.tss_ss0 = GSEL(GDATA_SEL, SEL_KPL);
435 ext->ext_tss.tss_ioopt =
436 ((u_int)vml->vml_iomap - (u_int)&ext->ext_tss) << 16;
437 ext->ext_iomap = vml->vml_iomap;
438 ext->ext_vm86.vm86_intmap = vml->vml_intmap;
440 if (cpu_feature & CPUID_VME)
441 ext->ext_vm86.vm86_has_vme = (rcr4() & CR4_VME ? 1 : 0);
443 addr = (u_int *)ext->ext_vm86.vm86_intmap;
444 for (i = 0; i < (INTMAP_SIZE + IOMAP_SIZE) / sizeof(u_int); i++)
446 vml->vml_iomap_trailer = 0xff;
448 ssd.ssd_base = (u_int)&ext->ext_tss;
449 ssd.ssd_limit = TSS_SIZE - 1;
450 ssdtosd(&ssd, &ext->ext_tssd);
456 * use whatever is leftover of the vm86 page layout as a
457 * message buffer so we can capture early output.
459 msgbufinit((vm_offset_t)vm86paddr + sizeof(struct vm86_layout),
460 ctob(3) - sizeof(struct vm86_layout));
465 vm86_getpage(struct vm86context *vmc, int pagenum)
469 for (i = 0; i < vmc->npages; i++)
470 if (vmc->pmap[i].pte_num == pagenum)
471 return (vmc->pmap[i].kva);
476 vm86_addpage(struct vm86context *vmc, int pagenum, vm_offset_t kva)
480 for (i = 0; i < vmc->npages; i++)
481 if (vmc->pmap[i].pte_num == pagenum)
484 if (vmc->npages == VM86_PMAPSIZE)
485 goto bad; /* XXX grow map? */
488 kva = (vm_offset_t)malloc(PAGE_SIZE, M_TEMP, M_WAITOK);
493 vmc->pmap[i].flags = flags;
494 vmc->pmap[i].kva = kva;
495 vmc->pmap[i].pte_num = pagenum;
498 panic("vm86_addpage: not enough room, or overlap");
502 vm86_initflags(struct vm86frame *vmf)
504 int eflags = vmf->vmf_eflags;
505 struct vm86_kernel *vm86 = &curpcb->pcb_ext->ext_vm86;
507 if (vm86->vm86_has_vme) {
508 eflags = (vmf->vmf_eflags & ~VME_USERCHANGE) |
509 (eflags & VME_USERCHANGE) | PSL_VM;
511 vm86->vm86_eflags = eflags; /* save VIF, VIP */
512 eflags = (vmf->vmf_eflags & ~VM_USERCHANGE) |
513 (eflags & VM_USERCHANGE) | PSL_VM;
515 vmf->vmf_eflags = eflags | PSL_VM;
519 * called from vm86_bioscall, while in vm86 address space, to finalize setup.
522 vm86_prepcall(struct vm86frame vmf)
524 uintptr_t addr[] = { 0xA00, 0x1000 }; /* code, stack */
526 CLI, INTn, 0x00, STI, HLT
529 if ((vmf.vmf_trapno & PAGE_MASK) <= 0xff) {
530 /* interrupt call requested */
531 intcall[2] = (u_char)(vmf.vmf_trapno & 0xff);
532 memcpy((void *)addr[0], (void *)intcall, sizeof(intcall));
533 vmf.vmf_ip = addr[0];
536 vmf.vmf_sp = addr[1] - 2; /* keep aligned */
537 vmf.kernel_fs = vmf.kernel_es = vmf.kernel_ds = 0;
539 vmf.vmf_eflags = PSL_VIF | PSL_VM | PSL_USER;
540 vm86_initflags(&vmf);
544 * vm86 trap handler; determines whether routine succeeded or not.
545 * Called while in vm86 space, returns to calling process.
548 vm86_trap(struct vm86frame *vmf)
552 /* "should not happen" */
553 if ((vmf->vmf_eflags & PSL_VM) == 0)
554 panic("vm86_trap called, but not in vm86 mode");
556 addr = MAKE_ADDR(vmf->vmf_cs, vmf->vmf_ip);
557 if (*(u_char *)addr == HLT)
558 vmf->vmf_trapno = vmf->vmf_eflags & PSL_C;
560 vmf->vmf_trapno = vmf->vmf_trapno << 16;
566 vm86_intcall(int intnum, struct vm86frame *vmf)
568 if (intnum < 0 || intnum > 0xff)
571 vmf->vmf_trapno = intnum;
572 return (vm86_bioscall(vmf));
576 * struct vm86context contains the page table to use when making
577 * vm86 calls. If intnum is a valid interrupt number (0-255), then
578 * the "interrupt trampoline" will be used, otherwise we use the
579 * caller's cs:ip routine.
582 vm86_datacall(intnum, vmf, vmc)
584 struct vm86frame *vmf;
585 struct vm86context *vmc;
587 pt_entry_t pte = (pt_entry_t)vm86paddr;
589 int i, entry, retval;
591 for (i = 0; i < vmc->npages; i++) {
592 page = vtophys(vmc->pmap[i].kva & PG_FRAME);
593 entry = vmc->pmap[i].pte_num;
594 vmc->pmap[i].old_pte = pte[entry];
595 pte[entry] = page | PG_V | PG_RW | PG_U;
598 vmf->vmf_trapno = intnum;
599 retval = vm86_bioscall(vmf);
601 for (i = 0; i < vmc->npages; i++) {
602 entry = vmc->pmap[i].pte_num;
603 pte[entry] = vmc->pmap[i].old_pte;
610 vm86_getaddr(vmc, sel, off)
611 struct vm86context *vmc;
618 addr = (vm_offset_t)MAKE_ADDR(sel, off);
619 page = addr >> PAGE_SHIFT;
620 for (i = 0; i < vmc->npages; i++)
621 if (page == vmc->pmap[i].pte_num)
622 return (vmc->pmap[i].kva + (addr & PAGE_MASK));
627 vm86_getptr(vmc, kva, sel, off)
628 struct vm86context *vmc;
635 for (i = 0; i < vmc->npages; i++)
636 if (kva >= vmc->pmap[i].kva &&
637 kva < vmc->pmap[i].kva + PAGE_SIZE) {
638 *off = kva - vmc->pmap[i].kva;
639 *sel = vmc->pmap[i].pte_num << 8;
643 panic("vm86_getptr: address not found");
647 vm86_sysarch(p, args)
652 struct i386_vm86_args ua;
653 struct vm86_kernel *vm86;
655 if ((error = copyin(args, &ua, sizeof(struct i386_vm86_args))) != 0)
658 if (p->p_addr->u_pcb.pcb_ext == 0)
659 if ((error = i386_extend_pcb(p)) != 0)
661 vm86 = &p->p_addr->u_pcb.pcb_ext->ext_vm86;
665 struct vm86_init_args sa;
667 if ((error = copyin(ua.sub_args, &sa, sizeof(sa))) != 0)
669 if (cpu_feature & CPUID_VME)
670 vm86->vm86_has_vme = (rcr4() & CR4_VME ? 1 : 0);
672 vm86->vm86_has_vme = 0;
673 vm86->vm86_inited = 1;
674 vm86->vm86_debug = sa.debug;
675 bcopy(&sa.int_map, vm86->vm86_intmap, 32);
681 struct vm86_vme_args sa;
683 if ((cpu_feature & CPUID_VME) == 0)
686 if (error = copyin(ua.sub_args, &sa, sizeof(sa)))
689 load_cr4(rcr4() | CR4_VME);
691 load_cr4(rcr4() & ~CR4_VME);
697 struct vm86_vme_args sa;
699 sa.state = (rcr4() & CR4_VME ? 1 : 0);
700 error = copyout(&sa, ua.sub_args, sizeof(sa));
705 struct vm86_intcall_args sa;
707 if ((error = suser(p)))
709 if ((error = copyin(ua.sub_args, &sa, sizeof(sa))))
711 if ((error = vm86_intcall(sa.intnum, &sa.vmf)))
713 error = copyout(&sa, ua.sub_args, sizeof(sa));