2 * Copyright (c) 2003,2004,2008 The DragonFly Project. All rights reserved.
3 * Copyright (c) 2008 Jordan Gordeev.
5 * This code is derived from software contributed to The DragonFly Project
6 * by Matthew Dillon <dillon@backplane.com>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * 3. Neither the name of The DragonFly Project nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific, prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * Copyright (c) 1990 The Regents of the University of California.
36 * All rights reserved.
38 * This code is derived from software contributed to Berkeley by
41 * Redistribution and use in source and binary forms, with or without
42 * modification, are permitted provided that the following conditions
44 * 1. Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * 2. Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in the
48 * documentation and/or other materials provided with the distribution.
49 * 3. All advertising materials mentioning features or use of this software
50 * must display the following acknowledgement:
51 * This product includes software developed by the University of
52 * California, Berkeley and its contributors.
53 * 4. Neither the name of the University nor the names of its contributors
54 * may be used to endorse or promote products derived from this software
55 * without specific prior written permission.
57 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
58 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
59 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
60 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
61 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
62 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
63 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
64 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
65 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
66 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 * $FreeBSD: src/sys/i386/i386/swtch.s,v 1.89.2.10 2003/01/23 03:36:24 ps Exp $
72 //#include "use_npx.h"
74 #include <sys/rtprio.h>
76 #include <machine/asmacros.h>
77 #include <machine/segments.h>
79 #include <machine/pmap.h>
81 #include <machine_base/apic/apicreg.h>
83 #include <machine/lock.h>
88 #define MPLOCKED lock ;
96 .globl lwkt_switch_return
98 #if defined(SWTCH_OPTIM_STATS)
99 .globl swtch_optim_stats, tlb_flush_count
100 swtch_optim_stats: .long 0 /* number of _swtch_optims */
101 tlb_flush_count: .long 0
108 * cpu_heavy_switch(struct thread *next_thread)
110 * Switch from the current thread to a new thread. This entry
111 * is normally called via the thread->td_switch function, and will
112 * only be called when the current thread is a heavy weight process.
114 * Some instructions have been reordered to reduce pipeline stalls.
116 * YYY disable interrupts once giant is removed.
118 ENTRY(cpu_heavy_switch)
120 * Save RIP, RSP and callee-saved registers (RBX, RBP, R12-R15).
122 movq PCPU(curthread),%rcx
123 /* On top of the stack is the return adress. */
124 movq (%rsp),%rax /* (reorder optimization) */
125 movq TD_PCB(%rcx),%rdx /* RDX = PCB */
126 movq %rax,PCB_RIP(%rdx) /* return PC may be modified */
127 movq %rbx,PCB_RBX(%rdx)
128 movq %rsp,PCB_RSP(%rdx)
129 movq %rbp,PCB_RBP(%rdx)
130 movq %r12,PCB_R12(%rdx)
131 movq %r13,PCB_R13(%rdx)
132 movq %r14,PCB_R14(%rdx)
133 movq %r15,PCB_R15(%rdx)
136 * Clear the cpu bit in the pmap active mask. The restore
137 * function will set the bit in the pmap active mask.
139 * Special case: when switching between threads sharing the
140 * same vmspace if we avoid clearing the bit we do not have
141 * to reload %cr3 (if we clear the bit we could race page
142 * table ops done by other threads and would have to reload
143 * %cr3, because those ops will not know to IPI us).
145 movq %rcx,%rbx /* RBX = oldthread */
146 movq TD_LWP(%rcx),%rcx /* RCX = oldlwp */
147 movq TD_LWP(%rdi),%r13 /* R13 = newlwp */
148 movq LWP_VMSPACE(%rcx), %rcx /* RCX = oldvmspace */
149 testq %r13,%r13 /* might not be a heavy */
151 cmpq LWP_VMSPACE(%r13),%rcx /* same vmspace? */
154 movslq PCPU(cpuid), %rax
155 MPLOCKED btrq %rax, VM_PMAP+PM_ACTIVE(%rcx)
159 * Push the LWKT switch restore function, which resumes a heavy
160 * weight process. Note that the LWKT switcher is based on
161 * TD_SP, while the heavy weight process switcher is based on
162 * PCB_RSP. TD_SP is usually two ints pushed relative to
163 * PCB_RSP. We push the flags for later restore by cpu_heavy_restore.
166 movq $cpu_heavy_restore, %rax
168 movq %rsp,TD_SP(%rbx)
171 * Save debug regs if necessary
173 movq PCB_FLAGS(%rdx),%rax
174 andq $PCB_DBREGS,%rax
175 jz 1f /* no, skip over */
176 movq %dr7,%rax /* yes, do the save */
177 movq %rax,PCB_DR7(%rdx)
178 /* JG correct value? */
179 andq $0x0000fc00, %rax /* disable all watchpoints */
182 movq %rax,PCB_DR6(%rdx)
184 movq %rax,PCB_DR3(%rdx)
186 movq %rax,PCB_DR2(%rdx)
188 movq %rax,PCB_DR1(%rdx)
190 movq %rax,PCB_DR0(%rdx)
195 * Save the FP state if we have used the FP. Note that calling
196 * npxsave will NULL out PCPU(npxthread).
198 cmpq %rbx,PCPU(npxthread)
200 movq %rdi,%r12 /* save %rdi. %r12 is callee-saved */
201 movq TD_SAVEFPU(%rbx),%rdi
202 call npxsave /* do it in a big C function */
203 movq %r12,%rdi /* restore %rdi */
208 * Switch to the next thread, which was passed as an argument
209 * to cpu_heavy_switch(). The argument is in %rdi.
210 * Set the current thread, load the stack pointer,
211 * and 'ret' into the switch-restore function.
213 * The switch restore function expects the new thread to be in %rax
214 * and the old one to be in %rbx.
216 * There is a one-instruction window where curthread is the new
217 * thread but %rsp still points to the old thread's stack, but
218 * we are protected by a critical section so it is ok.
220 movq %rdi,%rax /* RAX = newtd, RBX = oldtd */
221 movq %rax,PCPU(curthread)
222 movq TD_SP(%rax),%rsp
226 * cpu_exit_switch(struct thread *next)
228 * The switch function is changed to this when a thread is going away
229 * for good. We have to ensure that the MMU state is not cached, and
230 * we don't bother saving the existing thread state before switching.
232 * At this point we are in a critical section and this cpu owns the
233 * thread's token, which serves as an interlock until the switchout is
236 ENTRY(cpu_exit_switch)
238 * Get us out of the vmspace
246 /* JG no increment of statistics counters? see cpu_heavy_restore */
249 movq PCPU(curthread),%rbx
252 * If this is a process/lwp, deactivate the pmap after we've
255 movq TD_LWP(%rbx),%rcx
258 movslq PCPU(cpuid), %rax
259 movq LWP_VMSPACE(%rcx), %rcx /* RCX = vmspace */
260 MPLOCKED btrq %rax, VM_PMAP+PM_ACTIVE(%rcx)
263 * Switch to the next thread. RET into the restore function, which
264 * expects the new thread in RAX and the old in RBX.
266 * There is a one-instruction window where curthread is the new
267 * thread but %rsp still points to the old thread's stack, but
268 * we are protected by a critical section so it is ok.
271 movq %rax,PCPU(curthread)
272 movq TD_SP(%rax),%rsp
276 * cpu_heavy_restore() (current thread in %rax on entry, old thread in %rbx)
278 * Restore the thread after an LWKT switch. This entry is normally
279 * called via the LWKT switch restore function, which was pulled
280 * off the thread stack and jumped to.
282 * This entry is only called if the thread was previously saved
283 * using cpu_heavy_switch() (the heavy weight process thread switcher),
284 * or when a new process is initially scheduled.
286 * NOTE: The lwp may be in any state, not necessarily LSRUN, because
287 * a preemption switch may interrupt the process and then return via
290 * YYY theoretically we do not have to restore everything here, a lot
291 * of this junk can wait until we return to usermode. But for now
292 * we restore everything.
294 * YYY the PCB crap is really crap, it makes startup a bitch because
295 * we can't switch away.
297 * YYY note: spl check is done in mi_switch when it splx()'s.
300 ENTRY(cpu_heavy_restore)
303 #if defined(SWTCH_OPTIM_STATS)
304 incl _swtch_optim_stats
307 * Tell the pmap that our cpu is using the VMSPACE now. We cannot
308 * safely test/reload %cr3 until after we have set the bit in the
311 * We must do an interlocked test of the CPUMASK_BIT at the same
312 * time. If found to be set we will have to wait for it to clear
313 * and then do a forced reload of %cr3 (even if the value matches).
315 * XXX When switching between two LWPs sharing the same vmspace
316 * the cpu_heavy_switch() code currently avoids clearing the
317 * cpu bit in PM_ACTIVE. So if the bit is already set we can
318 * avoid checking for the interlock via CPUMASK_BIT. We currently
319 * do not perform this optimization.
321 * %rax is needed for the cmpxchgl so store newthread in %r12
324 movq TD_LWP(%rax),%rcx
325 movq LWP_VMSPACE(%rcx),%rcx /* RCX = vmspace */
327 movq %rax,%r12 /* save newthread ptr */
329 movq VM_PMAP+PM_ACTIVE(%rcx),%rax /* old contents */
330 movq PCPU(cpumask),%rsi /* new contents */
332 MPLOCKED cmpxchgq %rsi,VM_PMAP+PM_ACTIVE(%rcx)
338 btq $CPUMASK_BIT,%rax /* test interlock */
340 movq %rcx,%rdi /* (found to be set) */
341 call pmap_interlock_wait /* pmap_interlock_wait(%rdi:vm) */
344 * Need unconditional load cr3
347 movq TD_PCB(%rax),%rdx /* RDX = PCB */
348 movq PCB_CR3(%rdx),%rcx /* RCX = desired CR3 */
349 jmp 2f /* unconditional reload */
351 movq %r12,%rax /* restore RAX = newthread */
353 movq PCPU(cpumask),%rsi
354 orq %rsi,VM_PMAP+PM_ACTIVE(%rcx)
357 * Restore the MMU address space. If it is the same as the last
358 * thread we don't have to invalidate the tlb (i.e. reload cr3).
359 * YYY which naturally also means that the PM_ACTIVE bit had better
360 * already have been set before we set it above, check? YYY
362 movq TD_PCB(%rax),%rdx /* RDX = PCB */
363 movq %cr3,%rsi /* RSI = current CR3 */
364 movq PCB_CR3(%rdx),%rcx /* RCX = desired CR3 */
368 #if defined(SWTCH_OPTIM_STATS)
369 decl _swtch_optim_stats
370 incl _tlb_flush_count
376 * NOTE: %rbx is the previous thread and %rax is the new thread.
377 * %rbx is retained throughout so we can return it.
379 * lwkt_switch[_return] is responsible for handling TDF_RUNNING.
383 * Deal with the PCB extension, restore the private tss
385 movq PCB_EXT(%rdx),%rdi /* check for a PCB extension */
386 movq $1,%rcx /* maybe mark use of a private tss */
393 * Going back to the common_tss. We may need to update TSS_RSP0
394 * which sets the top of the supervisor stack when entering from
395 * usermode. The PCB is at the top of the stack but we need another
396 * 16 bytes to take vm86 into account.
399 /*leaq -TF_SIZE(%rdx),%rcx*/
400 movq %rcx, PCPU(common_tss) + TSS_RSP0
403 cmpl $0,PCPU(private_tss) /* don't have to reload if */
404 je 3f /* already using the common TSS */
407 subq %rcx,%rcx /* unmark use of private tss */
410 * Get the address of the common TSS descriptor for the ltr.
411 * There is no way to get the address of a segment-accessed variable
412 * so we store a self-referential pointer at the base of the per-cpu
413 * data area and add the appropriate offset.
416 movq $gd_common_tssd, %rdi
417 /* JG name for "%gs:0"? */
421 * Move the correct TSS descriptor into the GDT slot, then reload
426 movl %rcx,PCPU(private_tss) /* mark/unmark private tss */
427 movq PCPU(tss_gdt), %rbx /* entry in GDT */
430 movl $GPROC0_SEL*8, %esi /* GSEL(entry, SEL_KPL) */
436 * Restore the user %gs and %fs
438 movq PCB_FSBASE(%rdx),%r9
439 cmpq PCPU(user_fs),%r9
442 movq %r9,PCPU(user_fs)
443 movl $MSR_FSBASE,%ecx
444 movl PCB_FSBASE(%r10),%eax
445 movl PCB_FSBASE+4(%r10),%edx
449 movq PCB_GSBASE(%rdx),%r9
450 cmpq PCPU(user_gs),%r9
453 movq %r9,PCPU(user_gs)
454 movl $MSR_KGSBASE,%ecx /* later swapgs moves it to GSBASE */
455 movl PCB_GSBASE(%r10),%eax
456 movl PCB_GSBASE+4(%r10),%edx
462 * Restore general registers. %rbx is restored later.
464 movq PCB_RSP(%rdx), %rsp
465 movq PCB_RBP(%rdx), %rbp
466 movq PCB_R12(%rdx), %r12
467 movq PCB_R13(%rdx), %r13
468 movq PCB_R14(%rdx), %r14
469 movq PCB_R15(%rdx), %r15
470 movq PCB_RIP(%rdx), %rax
475 * Restore the user LDT if we have one
477 cmpl $0, PCB_USERLDT(%edx)
479 movl _default_ldt,%eax
480 cmpl PCPU(currentldt),%eax
483 movl %eax,PCPU(currentldt)
492 * Restore the user TLS if we have one
500 * Restore the DEBUG register state if necessary.
502 movq PCB_FLAGS(%rdx),%rax
503 andq $PCB_DBREGS,%rax
504 jz 1f /* no, skip over */
505 movq PCB_DR6(%rdx),%rax /* yes, do the restore */
507 movq PCB_DR3(%rdx),%rax
509 movq PCB_DR2(%rdx),%rax
511 movq PCB_DR1(%rdx),%rax
513 movq PCB_DR0(%rdx),%rax
515 movq %dr7,%rax /* load dr7 so as not to disturb */
516 /* JG correct value? */
517 andq $0x0000fc00,%rax /* reserved bits */
518 /* JG we've got more registers on x86_64 */
519 movq PCB_DR7(%rdx),%rcx
520 /* JG correct value? */
521 andq $~0x0000fc00,%rcx
526 * Clear the QUICKRET flag when restoring a user process context
527 * so we don't try to do a quick syscall return.
530 andl $~RQF_QUICKRET,PCPU(reqflags)
532 movq PCB_RBX(%rdx),%rbx
536 * savectx(struct pcb *pcb)
538 * Update pcb, saving current processor state.
542 /* JG use %rdi instead of %rcx everywhere? */
545 /* caller's return address - child won't execute this routine */
547 movq %rax,PCB_RIP(%rcx)
550 movq %rax,PCB_CR3(%rcx)
552 movq %rbx,PCB_RBX(%rcx)
553 movq %rsp,PCB_RSP(%rcx)
554 movq %rbp,PCB_RBP(%rcx)
555 movq %r12,PCB_R12(%rcx)
556 movq %r13,PCB_R13(%rcx)
557 movq %r14,PCB_R14(%rcx)
558 movq %r15,PCB_R15(%rcx)
562 * If npxthread == NULL, then the npx h/w state is irrelevant and the
563 * state had better already be in the pcb. This is true for forks
564 * but not for dumps (the old book-keeping with FP flags in the pcb
565 * always lost for dumps because the dump pcb has 0 flags).
567 * If npxthread != NULL, then we have to save the npx h/w state to
568 * npxthread's pcb and copy it to the requested pcb, or save to the
569 * requested pcb and reload. Copying is easier because we would
570 * have to handle h/w bugs for reloading. We used to lose the
571 * parent's npx state for forks by forgetting to reload.
573 movq PCPU(npxthread),%rax
577 pushq %rcx /* target pcb */
578 movq TD_SAVEFPU(%rax),%rax /* originating savefpu area */
587 movq $PCB_SAVEFPU_SIZE,%rdx
588 leaq PCB_SAVEFPU(%rcx),%rcx
598 * cpu_idle_restore() (current thread in %rax on entry) (one-time execution)
600 * Don't bother setting up any regs other than %rbp so backtraces
601 * don't die. This restore function is used to bootstrap into the
602 * cpu_idle() LWKT only, after that cpu_lwkt_*() will be used for
605 * Clear TDF_RUNNING in old thread only after we've cleaned up %cr3.
606 * This only occurs during system boot so no special handling is
607 * required for migration.
609 * If we are an AP we have to call ap_init() before jumping to
610 * cpu_idle(). ap_init() will synchronize with the BP and finish
611 * setting up various ncpu-dependant globaldata fields. This may
612 * happen on UP as well as SMP if we happen to be simulating multiple
615 ENTRY(cpu_idle_restore)
623 andl $~TDF_RUNNING,TD_FLAGS(%rbx)
625 orl $TDF_RUNNING,TD_FLAGS(%rax)
634 * ap_init can decide to enable interrupts early, but otherwise, or if
635 * we are UP, do it here.
641 * cpu_kthread_restore() (current thread is %rax on entry, previous is %rbx)
642 * (one-time execution)
644 * Don't bother setting up any regs other then %rbp so backtraces
645 * don't die. This restore function is used to bootstrap into an
646 * LWKT based kernel thread only. cpu_lwkt_switch() will be used
649 * Because this switch target does not 'return' to lwkt_switch()
650 * we have to call lwkt_switch_return(otd) to clean up otd.
653 * Since all of our context is on the stack we are reentrant and
654 * we can release our critical section and enable interrupts early.
656 ENTRY(cpu_kthread_restore)
659 movq TD_PCB(%rax),%r13
664 * rax and rbx come from the switchout code. Call
665 * lwkt_switch_return(otd).
667 * NOTE: unlike i386, %rsi and %rdi are not call-saved regs.
671 call lwkt_switch_return
673 decl TD_CRITCOUNT(%rax)
674 movq PCB_R12(%r13),%rdi /* argument to RBX function */
675 movq PCB_RBX(%r13),%rax /* thread function */
676 /* note: top of stack return address inherited by function */
680 * cpu_lwkt_switch(struct thread *)
682 * Standard LWKT switching function. Only non-scratch registers are
683 * saved and we don't bother with the MMU state or anything else.
685 * This function is always called while in a critical section.
687 * There is a one-instruction window where curthread is the new
688 * thread but %rsp still points to the old thread's stack, but
689 * we are protected by a critical section so it is ok.
691 ENTRY(cpu_lwkt_switch)
692 pushq %rbp /* JG note: GDB hacked to locate ebp rel to td_sp */
694 movq PCPU(curthread),%rbx /* becomes old thread in restore */
703 * Save the FP state if we have used the FP. Note that calling
704 * npxsave will NULL out PCPU(npxthread).
706 * We have to deal with the FP state for LWKT threads in case they
707 * happen to get preempted or block while doing an optimized
708 * bzero/bcopy/memcpy.
710 cmpq %rbx,PCPU(npxthread)
712 movq %rdi,%r12 /* save %rdi. %r12 is callee-saved */
713 movq TD_SAVEFPU(%rbx),%rdi
714 call npxsave /* do it in a big C function */
715 movq %r12,%rdi /* restore %rdi */
719 movq %rdi,%rax /* switch to this thread */
720 pushq $cpu_lwkt_restore
721 movq %rsp,TD_SP(%rbx)
723 * %rax contains new thread, %rbx contains old thread.
725 movq %rax,PCPU(curthread)
726 movq TD_SP(%rax),%rsp
730 * cpu_lwkt_restore() (current thread in %rax on entry)
732 * Standard LWKT restore function. This function is always called
733 * while in a critical section.
735 * Warning: due to preemption the restore function can be used to
736 * 'return' to the original thread. Interrupt disablement must be
737 * protected through the switch so we cannot run splz here.
739 * YYY we theoretically do not need to load KPML4phys into cr3, but if
740 * so we need a way to detect when the PTD we are using is being
741 * deleted due to a process exiting.
743 ENTRY(cpu_lwkt_restore)
744 movq KPML4phys,%rcx /* YYY borrow but beware desched/cpuchg/exit */
753 * NOTE: %rbx is the previous thread and %rax is the new thread.
754 * %rbx is retained throughout so we can return it.
756 * lwkt_switch[_return] is responsible for handling TDF_RUNNING.