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 * modification, are permitted provided that the following conditions
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * $FreeBSD: src/sys/i386/i386/vm86.c,v 1.31.2.2 2001/10/05 06:18:55 peter Exp $
28 * $DragonFly: src/sys/platform/pc32/i386/vm86.c,v 1.26 2008/08/02 01:14:43 dillon Exp $
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
37 #include <sys/malloc.h>
38 #include <sys/sysctl.h>
42 #include <vm/vm_map.h>
43 #include <vm/vm_page.h>
47 #include <sys/thread2.h>
48 #include <sys/mplock2.h>
50 #include <machine/md_var.h>
51 #include <machine/pcb_ext.h> /* pcb.h included via sys/user.h */
52 #include <machine/psl.h>
53 #include <machine/specialreg.h>
54 #include <machine/sysarch.h>
55 #include <machine/clock.h>
56 #include <bus/isa/isa.h>
57 #include <bus/isa/rtc.h>
58 #include <machine_base/isa/timerreg.h>
60 extern int i386_extend_pcb (struct lwp *);
62 extern struct pcb *vm86pcb;
64 extern int vm86_bioscall(struct vm86frame *);
65 extern void vm86_biosret(struct vm86frame *);
67 #define PGTABLE_SIZE ((1024 + 64) * 1024 / PAGE_SIZE)
68 #define INTMAP_SIZE 32
69 #define IOMAP_SIZE ctob(IOPAGES)
71 (sizeof(struct pcb_ext) - sizeof(struct segment_descriptor) + \
72 INTMAP_SIZE + IOMAP_SIZE + 1)
75 pt_entry_t vml_pgtbl[PGTABLE_SIZE];
77 struct pcb_ext vml_ext;
78 char vml_intmap[INTMAP_SIZE];
79 char vml_iomap[IOMAP_SIZE];
80 char vml_iomap_trailer;
83 void vm86_prepcall(struct vm86frame *);
107 #define OPERAND_SIZE_PREFIX 0x66
108 #define ADDRESS_SIZE_PREFIX 0x67
109 #define PUSH_MASK ~(PSL_VM | PSL_RF | PSL_I)
110 #define POP_MASK ~(PSL_VIP | PSL_VIF | PSL_VM | PSL_RF | PSL_IOPL)
112 static void vm86_setup_timer_fault(void);
113 static void vm86_clear_timer_fault(void);
115 static int vm86_blew_up_timer;
117 static int timer_warn = 1;
118 SYSCTL_INT(_debug, OID_AUTO, timer_warn, CTLFLAG_RW, &timer_warn, 0, "");
120 static __inline caddr_t
121 MAKE_ADDR(u_short sel, u_short off)
123 return ((caddr_t)((sel << 4) + off));
127 GET_VEC(u_int vec, u_short *sel, u_short *off)
133 static __inline u_int
134 MAKE_VEC(u_short sel, u_short off)
136 return ((sel << 16) | off);
140 PUSH(u_short x, struct vm86frame *vmf)
143 susword(MAKE_ADDR(vmf->vmf_ss, vmf->vmf_sp), x);
147 PUSHL(u_int x, struct vm86frame *vmf)
150 suword(MAKE_ADDR(vmf->vmf_ss, vmf->vmf_sp), x);
153 static __inline u_short
154 POP(struct vm86frame *vmf)
156 u_short x = fusword(MAKE_ADDR(vmf->vmf_ss, vmf->vmf_sp));
162 static __inline u_int
163 POPL(struct vm86frame *vmf)
165 u_int x = fuword(MAKE_ADDR(vmf->vmf_ss, vmf->vmf_sp));
175 vm86_emulate(struct vm86frame *vmf)
177 struct vm86_kernel *vm86;
185 * pcb_ext contains the address of the extension area, or zero if
186 * the extension is not present. (This check should not be needed,
187 * as we can't enter vm86 mode until we set up an extension area)
189 if (curthread->td_pcb->pcb_ext == 0)
191 vm86 = &curthread->td_pcb->pcb_ext->ext_vm86;
193 if (vmf->vmf_eflags & PSL_T)
197 * Instruction emulation
199 addr = MAKE_ADDR(vmf->vmf_cs, vmf->vmf_ip);
200 i_byte = fubyte(addr);
201 if (i_byte == ADDRESS_SIZE_PREFIX) {
202 i_byte = fubyte(++addr);
207 * I/O emulation (TIMER only, a big hack). Just reenable the
208 * IO bits involved, flag it, and retry the instruction.
215 vm86_blew_up_timer = 1;
221 vm86_clear_timer_fault();
226 if (vm86->vm86_has_vme) {
228 case OPERAND_SIZE_PREFIX:
229 i_byte = fubyte(++addr);
233 if (vmf->vmf_eflags & PSL_VIF)
234 PUSHL((vmf->vmf_eflags & PUSH_MASK)
235 | PSL_IOPL | PSL_I, vmf);
237 PUSHL((vmf->vmf_eflags & PUSH_MASK)
239 vmf->vmf_ip += inc_ip;
243 temp_flags = POPL(vmf) & POP_MASK;
244 vmf->vmf_eflags = (vmf->vmf_eflags & ~POP_MASK)
245 | temp_flags | PSL_VM | PSL_I;
246 vmf->vmf_ip += inc_ip;
247 if (temp_flags & PSL_I) {
248 vmf->vmf_eflags |= PSL_VIF;
249 if (vmf->vmf_eflags & PSL_VIP)
252 vmf->vmf_eflags &= ~PSL_VIF;
258 /* VME faults here if VIP is set, but does not set VIF. */
260 vmf->vmf_eflags |= PSL_VIF;
261 vmf->vmf_ip += inc_ip;
262 if ((vmf->vmf_eflags & PSL_VIP) == 0) {
263 uprintf("fatal sti\n");
268 /* VME if no redirection support */
272 /* VME if trying to set PSL_TF, or PSL_I when VIP is set */
274 temp_flags = POP(vmf) & POP_MASK;
275 vmf->vmf_flags = (vmf->vmf_flags & ~POP_MASK)
276 | temp_flags | PSL_VM | PSL_I;
277 vmf->vmf_ip += inc_ip;
278 if (temp_flags & PSL_I) {
279 vmf->vmf_eflags |= PSL_VIF;
280 if (vmf->vmf_eflags & PSL_VIP)
283 vmf->vmf_eflags &= ~PSL_VIF;
287 /* VME if trying to set PSL_TF, or PSL_I when VIP is set */
289 vmf->vmf_ip = POP(vmf);
290 vmf->vmf_cs = POP(vmf);
291 temp_flags = POP(vmf) & POP_MASK;
292 vmf->vmf_flags = (vmf->vmf_flags & ~POP_MASK)
293 | temp_flags | PSL_VM | PSL_I;
294 if (temp_flags & PSL_I) {
295 vmf->vmf_eflags |= PSL_VIF;
296 if (vmf->vmf_eflags & PSL_VIP)
299 vmf->vmf_eflags &= ~PSL_VIF;
308 case OPERAND_SIZE_PREFIX:
309 i_byte = fubyte(++addr);
313 if (vm86->vm86_eflags & PSL_VIF)
314 PUSHL((vmf->vmf_flags & PUSH_MASK)
315 | PSL_IOPL | PSL_I, vmf);
317 PUSHL((vmf->vmf_flags & PUSH_MASK)
319 vmf->vmf_ip += inc_ip;
323 temp_flags = POPL(vmf) & POP_MASK;
324 vmf->vmf_eflags = (vmf->vmf_eflags & ~POP_MASK)
325 | temp_flags | PSL_VM | PSL_I;
326 vmf->vmf_ip += inc_ip;
327 if (temp_flags & PSL_I) {
328 vm86->vm86_eflags |= PSL_VIF;
329 if (vm86->vm86_eflags & PSL_VIP)
332 vm86->vm86_eflags &= ~PSL_VIF;
339 vm86->vm86_eflags &= ~PSL_VIF;
340 vmf->vmf_ip += inc_ip;
344 /* if there is a pending interrupt, go to the emulator */
345 vm86->vm86_eflags |= PSL_VIF;
346 vmf->vmf_ip += inc_ip;
347 if (vm86->vm86_eflags & PSL_VIP)
352 if (vm86->vm86_eflags & PSL_VIF)
353 PUSH((vmf->vmf_flags & PUSH_MASK)
354 | PSL_IOPL | PSL_I, vmf);
356 PUSH((vmf->vmf_flags & PUSH_MASK) | PSL_IOPL, vmf);
357 vmf->vmf_ip += inc_ip;
361 i_byte = fubyte(addr + 1);
362 if ((vm86->vm86_intmap[i_byte >> 3] & (1 << (i_byte & 7))) != 0)
364 if (vm86->vm86_eflags & PSL_VIF)
365 PUSH((vmf->vmf_flags & PUSH_MASK)
366 | PSL_IOPL | PSL_I, vmf);
368 PUSH((vmf->vmf_flags & PUSH_MASK) | PSL_IOPL, vmf);
369 PUSH(vmf->vmf_cs, vmf);
370 PUSH(vmf->vmf_ip + inc_ip + 1, vmf); /* increment IP */
371 GET_VEC(fuword((caddr_t)(i_byte * 4)),
372 &vmf->vmf_cs, &vmf->vmf_ip);
373 vmf->vmf_flags &= ~PSL_T;
374 vm86->vm86_eflags &= ~PSL_VIF;
378 vmf->vmf_ip = POP(vmf);
379 vmf->vmf_cs = POP(vmf);
380 temp_flags = POP(vmf) & POP_MASK;
381 vmf->vmf_flags = (vmf->vmf_flags & ~POP_MASK)
382 | temp_flags | PSL_VM | PSL_I;
383 if (temp_flags & PSL_I) {
384 vm86->vm86_eflags |= PSL_VIF;
385 if (vm86->vm86_eflags & PSL_VIP)
388 vm86->vm86_eflags &= ~PSL_VIF;
393 temp_flags = POP(vmf) & POP_MASK;
394 vmf->vmf_flags = (vmf->vmf_flags & ~POP_MASK)
395 | temp_flags | PSL_VM | PSL_I;
396 vmf->vmf_ip += inc_ip;
397 if (temp_flags & PSL_I) {
398 vm86->vm86_eflags |= PSL_VIF;
399 if (vm86->vm86_eflags & PSL_VIP)
402 vm86->vm86_eflags &= ~PSL_VIF;
410 vm86_initialize(void)
414 struct vm86_layout *vml = (struct vm86_layout *)vm86paddr;
417 struct soft_segment_descriptor ssd = {
418 0, /* segment base address (overwritten) */
419 0, /* length (overwritten) */
420 SDT_SYS386TSS, /* segment type */
421 0, /* priority level */
422 1, /* descriptor present */
424 0, /* default 16 size */
429 * this should be a compile time error, but cpp doesn't grok sizeof().
431 if (sizeof(struct vm86_layout) > ctob(3))
432 panic("struct vm86_layout exceeds space allocated in locore.s");
435 * Below is the memory layout that we use for the vm86 region.
443 * +--------+ +--------+ <--------- vm86paddr
444 * | | |Page Tbl| 1M + 64K = 272 entries = 1088 bytes
446 * | | | PCB | size: ~240 bytes
447 * | page 1 | |PCB Ext | size: ~140 bytes (includes TSS)
453 * +--------+ | bitmap |
460 * A rudimentary PCB must be installed, in order to get to the
461 * PCB extension area. We use the PCB area as a scratchpad for
462 * data storage, the layout of which is shown below.
464 * pcb_esi = new PTD entry 0
465 * pcb_ebp = pointer to frame on vm86 stack
466 * pcb_esp = stack frame pointer at time of switch
467 * pcb_ebx = va of vm86 page table
468 * pcb_eip = argument pointer to initial call
469 * pcb_spare[0] = saved TSS descriptor, word 0
470 * pcb_space[1] = saved TSS descriptor, word 1
472 #define new_ptd pcb_esi
473 #define vm86_frame pcb_ebp
474 #define pgtable_va pcb_ebx
479 bzero(pcb, sizeof(struct pcb));
480 pcb->new_ptd = vm86pa | PG_V | PG_RW | PG_U;
481 pcb->vm86_frame = (pt_entry_t)vm86paddr - sizeof(struct vm86frame);
482 pcb->pgtable_va = (vm_offset_t)vm86paddr;
485 bzero(ext, sizeof(struct pcb_ext));
486 ext->ext_tss.tss_esp0 = (vm_offset_t)vm86paddr;
487 ext->ext_tss.tss_ss0 = GSEL(GDATA_SEL, SEL_KPL);
488 ext->ext_tss.tss_ioopt =
489 ((u_int)vml->vml_iomap - (u_int)&ext->ext_tss) << 16;
490 ext->ext_iomap = vml->vml_iomap;
491 ext->ext_vm86.vm86_intmap = vml->vml_intmap;
493 if (cpu_feature & CPUID_VME)
494 ext->ext_vm86.vm86_has_vme = (rcr4() & CR4_VME ? 1 : 0);
496 addr = (u_int *)ext->ext_vm86.vm86_intmap;
497 for (i = 0; i < (INTMAP_SIZE + IOMAP_SIZE) / sizeof(u_int); i++)
499 vml->vml_iomap_trailer = 0xff;
501 ssd.ssd_base = (u_int)&ext->ext_tss;
502 ssd.ssd_limit = TSS_SIZE - 1;
503 ssdtosd(&ssd, &ext->ext_tssd);
509 * use whatever is leftover of the vm86 page layout as a
510 * message buffer so we can capture early output.
512 msgbufinit((vm_offset_t)vm86paddr + sizeof(struct vm86_layout),
513 ctob(3) - sizeof(struct vm86_layout));
518 vm86_getpage(struct vm86context *vmc, int pagenum)
522 for (i = 0; i < vmc->npages; i++)
523 if (vmc->pmap[i].pte_num == pagenum)
524 return (vmc->pmap[i].kva);
529 vm86_addpage(struct vm86context *vmc, int pagenum, vm_offset_t kva)
533 for (i = 0; i < vmc->npages; i++)
534 if (vmc->pmap[i].pte_num == pagenum)
537 if (vmc->npages == VM86_PMAPSIZE)
538 goto bad; /* XXX grow map? */
541 kva = (vm_offset_t)kmalloc(PAGE_SIZE, M_TEMP, M_WAITOK);
546 vmc->pmap[i].flags = flags;
547 vmc->pmap[i].kva = kva;
548 vmc->pmap[i].pte_num = pagenum;
551 panic("vm86_addpage: not enough room, or overlap");
555 vm86_initflags(struct vm86frame *vmf)
557 int eflags = vmf->vmf_eflags;
558 struct vm86_kernel *vm86 = &curthread->td_pcb->pcb_ext->ext_vm86;
560 if (vm86->vm86_has_vme) {
561 eflags = (vmf->vmf_eflags & ~VME_USERCHANGE) |
562 (eflags & VME_USERCHANGE) | PSL_VM;
564 vm86->vm86_eflags = eflags; /* save VIF, VIP */
565 eflags = (vmf->vmf_eflags & ~VM_USERCHANGE) |
566 (eflags & VM_USERCHANGE) | PSL_VM;
568 vmf->vmf_eflags = eflags | PSL_VM;
572 * called from vm86_bioscall, while in vm86 address space, to finalize setup.
575 vm86_prepcall(struct vm86frame *vmf)
577 uintptr_t addr[] = { 0xA00, 0x1000 }; /* code, stack */
579 CLI, INTn, 0x00, STI, HLT
582 if ((vmf->vmf_trapno & PAGE_MASK) <= 0xff) {
583 /* interrupt call requested */
584 intcall[2] = (u_char)(vmf->vmf_trapno & 0xff);
585 memcpy((void *)addr[0], (void *)intcall, sizeof(intcall));
586 vmf->vmf_ip = addr[0];
589 vmf->vmf_sp = addr[1] - 2; /* keep aligned */
590 vmf->kernel_fs = vmf->kernel_es = vmf->kernel_ds = vmf->kernel_gs = 0;
592 vmf->vmf_eflags = PSL_VIF | PSL_VM | PSL_USER;
597 * vm86 trap handler; determines whether routine succeeded or not.
598 * Called while in vm86 space, returns to calling process.
600 * A MP lock ref is held on entry from trap() and must be released prior
601 * to returning to the VM86 call.
604 vm86_trap(struct vm86frame *vmf, int have_mplock)
608 /* "should not happen" */
609 if ((vmf->vmf_eflags & PSL_VM) == 0)
610 panic("vm86_trap called, but not in vm86 mode");
612 addr = MAKE_ADDR(vmf->vmf_cs, vmf->vmf_ip);
613 if (*(u_char *)addr == HLT)
614 vmf->vmf_trapno = vmf->vmf_eflags & PSL_C;
616 vmf->vmf_trapno = vmf->vmf_trapno << 16;
624 vm86_intcall(int intnum, struct vm86frame *vmf)
628 if (intnum < 0 || intnum > 0xff)
632 ASSERT_MP_LOCK_HELD(curthread);
634 vm86_setup_timer_fault();
635 vmf->vmf_trapno = intnum;
636 error = vm86_bioscall(vmf);
639 * Yes, this happens, especially with video BIOS calls. The BIOS
640 * will sometimes eat timer 2 for lunch, and we need timer 2.
642 if (vm86_blew_up_timer) {
643 vm86_blew_up_timer = 0;
646 kprintf("Warning: BIOS played with the 8254, "
655 * struct vm86context contains the page table to use when making
656 * vm86 calls. If intnum is a valid interrupt number (0-255), then
657 * the "interrupt trampoline" will be used, otherwise we use the
658 * caller's cs:ip routine.
661 vm86_datacall(int intnum, struct vm86frame *vmf, struct vm86context *vmc)
663 pt_entry_t *pte = vm86paddr;
665 int i, entry, retval;
668 ASSERT_MP_LOCK_HELD(curthread);
670 for (i = 0; i < vmc->npages; i++) {
671 page = vtophys(vmc->pmap[i].kva & PG_FRAME);
672 entry = vmc->pmap[i].pte_num;
673 vmc->pmap[i].old_pte = pte[entry];
674 pte[entry] = page | PG_V | PG_RW | PG_U;
677 vmf->vmf_trapno = intnum;
678 retval = vm86_bioscall(vmf);
680 for (i = 0; i < vmc->npages; i++) {
681 entry = vmc->pmap[i].pte_num;
682 pte[entry] = vmc->pmap[i].old_pte;
689 vm86_getaddr(struct vm86context *vmc, u_short sel, u_short off)
694 addr = (vm_offset_t)MAKE_ADDR(sel, off);
695 page = addr >> PAGE_SHIFT;
696 for (i = 0; i < vmc->npages; i++)
697 if (page == vmc->pmap[i].pte_num)
698 return (vmc->pmap[i].kva + (addr & PAGE_MASK));
703 vm86_getptr(struct vm86context *vmc, vm_offset_t kva, u_short *sel,
708 for (i = 0; i < vmc->npages; i++)
709 if (kva >= vmc->pmap[i].kva &&
710 kva < vmc->pmap[i].kva + PAGE_SIZE) {
711 *off = kva - vmc->pmap[i].kva;
712 *sel = vmc->pmap[i].pte_num << 8;
716 panic("vm86_getptr: address not found");
720 vm86_sysarch(struct lwp *lp, char *args)
723 struct i386_vm86_args ua;
724 struct vm86_kernel *vm86;
726 if ((error = copyin(args, &ua, sizeof(struct i386_vm86_args))) != 0)
729 if (lp->lwp_thread->td_pcb->pcb_ext == 0)
730 if ((error = i386_extend_pcb(lp)) != 0)
732 vm86 = &lp->lwp_thread->td_pcb->pcb_ext->ext_vm86;
736 struct vm86_init_args sa;
738 if ((error = copyin(ua.sub_args, &sa, sizeof(sa))) != 0)
740 if (cpu_feature & CPUID_VME)
741 vm86->vm86_has_vme = (rcr4() & CR4_VME ? 1 : 0);
743 vm86->vm86_has_vme = 0;
744 vm86->vm86_inited = 1;
745 vm86->vm86_debug = sa.debug;
746 bcopy(&sa.int_map, vm86->vm86_intmap, 32);
752 struct vm86_vme_args sa;
754 if ((cpu_feature & CPUID_VME) == 0)
757 if (error = copyin(ua.sub_args, &sa, sizeof(sa)))
760 load_cr4(rcr4() | CR4_VME);
762 load_cr4(rcr4() & ~CR4_VME);
768 struct vm86_vme_args sa;
770 sa.state = (rcr4() & CR4_VME ? 1 : 0);
771 error = copyout(&sa, ua.sub_args, sizeof(sa));
776 struct vm86_intcall_args sa;
778 if ((error = priv_check_cred(lp->lwp_proc->p_ucred, PRIV_ROOT, 0)))
780 if ((error = copyin(ua.sub_args, &sa, sizeof(sa))))
782 if ((error = vm86_intcall(sa.intnum, &sa.vmf)))
784 error = copyout(&sa, ua.sub_args, sizeof(sa));
795 * Setup the VM86 I/O map to take faults on the timer
798 vm86_setup_timer_fault(void)
800 struct vm86_layout *vml = (struct vm86_layout *)vm86paddr;
802 vml->vml_iomap[TIMER_MODE >> 3] |= 1 << (TIMER_MODE & 7);
803 vml->vml_iomap[TIMER_CNTR0 >> 3] |= 1 << (TIMER_CNTR0 & 7);
804 vml->vml_iomap[TIMER_CNTR1 >> 3] |= 1 << (TIMER_CNTR1 & 7);
805 vml->vml_iomap[TIMER_CNTR2 >> 3] |= 1 << (TIMER_CNTR2 & 7);
809 * Setup the VM86 I/O map to not fault on the timer
812 vm86_clear_timer_fault(void)
814 struct vm86_layout *vml = (struct vm86_layout *)vm86paddr;
816 vml->vml_iomap[TIMER_MODE >> 3] &= ~(1 << (TIMER_MODE & 7));
817 vml->vml_iomap[TIMER_CNTR0 >> 3] &= ~(1 << (TIMER_CNTR0 & 7));
818 vml->vml_iomap[TIMER_CNTR1 >> 3] &= ~(1 << (TIMER_CNTR1 & 7));
819 vml->vml_iomap[TIMER_CNTR2 >> 3] &= ~(1 << (TIMER_CNTR2 & 7));