2 * Copyright (c) 2003 Peter Wemm.
3 * Copyright (c) 1993 The Regents of the University of California.
4 * Copyright (c) 2008 The DragonFly Project.
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.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by the University of
18 * California, Berkeley and its contributors.
19 * 4. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * $FreeBSD: src/sys/amd64/include/cpufunc.h,v 1.139 2004/01/28 23:53:04 peter Exp $
39 * Functions to provide access to special i386 instructions.
40 * This in included in sys/systm.h, and that file should be
41 * used in preference to this.
44 #ifndef _CPU_CPUFUNC_H_
45 #define _CPU_CPUFUNC_H_
47 #include <sys/cdefs.h>
48 #include <machine/psl.h>
51 struct region_descriptor;
54 #define readb(va) (*(volatile u_int8_t *) (va))
55 #define readw(va) (*(volatile u_int16_t *) (va))
56 #define readl(va) (*(volatile u_int32_t *) (va))
57 #define readq(va) (*(volatile u_int64_t *) (va))
59 #define writeb(va, d) (*(volatile u_int8_t *) (va) = (d))
60 #define writew(va, d) (*(volatile u_int16_t *) (va) = (d))
61 #define writel(va, d) (*(volatile u_int32_t *) (va) = (d))
62 #define writeq(va, d) (*(volatile u_int64_t *) (va) = (d))
67 #include <machine/lock.h> /* XXX */
73 __asm __volatile("int $3");
79 __asm __volatile("pause");
87 __asm __volatile("bsfl %1,%0" : "=r" (result) : "rm" (mask));
91 static __inline u_long
96 __asm __volatile("bsfq %1,%0" : "=r" (result) : "rm" (mask));
100 static __inline u_long
105 __asm __volatile("bsfq %1,%0" : "=r" (result) : "rm" (mask));
109 static __inline u_int
114 __asm __volatile("bsrl %1,%0" : "=r" (result) : "rm" (mask));
118 static __inline u_long
123 __asm __volatile("bsrq %1,%0" : "=r" (result) : "rm" (mask));
130 __asm __volatile("clflush %0" : : "m" (*(char *) addr));
134 do_cpuid(u_int ax, u_int *p)
136 __asm __volatile("cpuid"
137 : "=a" (p[0]), "=b" (p[1]), "=c" (p[2]), "=d" (p[3])
142 cpuid_count(u_int ax, u_int cx, u_int *p)
144 __asm __volatile("cpuid"
145 : "=a" (p[0]), "=b" (p[1]), "=c" (p[2]), "=d" (p[3])
146 : "0" (ax), "c" (cx));
149 #ifndef _CPU_DISABLE_INTR_DEFINED
152 cpu_disable_intr(void)
154 __asm __volatile("cli" : : : "memory");
159 #ifndef _CPU_ENABLE_INTR_DEFINED
162 cpu_enable_intr(void)
164 __asm __volatile("sti");
170 * Cpu and compiler memory ordering fence. mfence ensures strong read and
173 * A serializing or fence instruction is required here. A locked bus
174 * cycle on data for which we already own cache mastership is the most
181 __asm __volatile("mfence" : : : "memory");
183 __asm __volatile("" : : : "memory");
188 * cpu_lfence() ensures strong read ordering for reads issued prior
189 * to the instruction verses reads issued afterwords.
191 * A serializing or fence instruction is required here. A locked bus
192 * cycle on data for which we already own cache mastership is the most
199 __asm __volatile("lfence" : : : "memory");
201 __asm __volatile("" : : : "memory");
206 * cpu_sfence() ensures strong write ordering for writes issued prior
207 * to the instruction verses writes issued afterwords. Writes are
208 * ordered on intel cpus so we do not actually have to do anything.
215 * Don't use 'sfence' here, as it will create a lot of
216 * unnecessary stalls.
218 __asm __volatile("" : : : "memory");
222 * cpu_ccfence() prevents the compiler from reordering instructions, in
223 * particular stores, relative to the current cpu. Use cpu_sfence() if
224 * you need to guarentee ordering by both the compiler and by the cpu.
226 * This also prevents the compiler from caching memory loads into local
227 * variables across the routine.
232 __asm __volatile("" : : : "memory");
236 * This is a horrible, horrible hack that might have to be put at the
237 * end of certain procedures (on a case by case basis), just before it
238 * returns to avoid what we believe to be an unreported AMD cpu bug.
239 * Found to occur on both a Phenom II X4 820 (two of them), as well
240 * as a 48-core built around an Opteron 6168 (Id = 0x100f91 Stepping = 1).
241 * The problem does not appear to occur w/Intel cpus.
243 * The bug is likely related to either a write combining issue or the
244 * Return Address Stack (RAS) hardware cache.
246 * In particular, we had to do this for GCC's fill_sons_in_loop() routine
247 * which due to its deep recursion and stack flow appears to be able to
248 * tickle the amd cpu bug (w/ gcc-4.4.7). Adding a single 'nop' to the
249 * end of the routine just before it returns works around the bug.
251 * The bug appears to be extremely sensitive to %rip and %rsp values, to
252 * the point where even just inserting an instruction in an unrelated
253 * procedure (shifting the entire code base being run) effects the outcome.
254 * DragonFly is probably able to more readily reproduce the bug due to
255 * the stackgap randomization code. We would expect OpenBSD (where we got
256 * the stackgap randomization code from) to also be able to reproduce the
257 * issue. To date we have only reproduced the issue in DragonFly.
259 #define __AMDCPUBUG_DFLY01_AVAILABLE__
262 cpu_amdcpubug_dfly01(void)
264 __asm __volatile("nop" : : : "memory");
269 #define HAVE_INLINE_FFS
276 * Note that gcc-2's builtin ffs would be used if we didn't declare
277 * this inline or turn off the builtin. The builtin is faster but
278 * broken in gcc-2.4.5 and slower but working in gcc-2.5 and later
281 return (mask == 0 ? mask : (int)bsfl((u_int)mask) + 1);
283 /* Actually, the above is way out of date. The builtins use cmov etc */
284 return (__builtin_ffs(mask));
288 #define HAVE_INLINE_FFSL
293 return (mask == 0 ? mask : (int)bsfq((u_long)mask) + 1);
296 #define HAVE_INLINE_FLS
301 return (mask == 0 ? mask : (int)bsrl((u_int)mask) + 1);
304 #define HAVE_INLINE_FLSL
309 return (mask == 0 ? mask : (int)bsrq((u_long)mask) + 1);
317 __asm __volatile("hlt");
321 * The following complications are to get around gcc not having a
322 * constraint letter for the range 0..255. We still put "d" in the
323 * constraint because "i" isn't a valid constraint when the port
324 * isn't constant. This only matters for -O0 because otherwise
325 * the non-working version gets optimized away.
327 * Use an expression-statement instead of a conditional expression
328 * because gcc-2.6.0 would promote the operands of the conditional
329 * and produce poor code for "if ((inb(var) & const1) == const2)".
331 * The unnecessary test `(port) < 0x10000' is to generate a warning if
332 * the `port' has type u_short or smaller. Such types are pessimal.
333 * This actually only works for signed types. The range check is
334 * careful to avoid generating warnings.
336 #define inb(port) __extension__ ({ \
338 if (__builtin_constant_p(port) && ((port) & 0xffff) < 0x100 \
339 && (port) < 0x10000) \
340 _data = inbc(port); \
342 _data = inbv(port); \
345 #define outb(port, data) ( \
346 __builtin_constant_p(port) && ((port) & 0xffff) < 0x100 \
347 && (port) < 0x10000 \
348 ? outbc(port, data) : outbv(port, data))
350 static __inline u_char
355 __asm __volatile("inb %1,%0" : "=a" (data) : "id" ((u_short)(port)));
360 outbc(u_int port, u_char data)
362 __asm __volatile("outb %0,%1" : : "a" (data), "id" ((u_short)(port)));
365 static __inline u_char
370 * We use %%dx and not %1 here because i/o is done at %dx and not at
371 * %edx, while gcc generates inferior code (movw instead of movl)
372 * if we tell it to load (u_short) port.
374 __asm __volatile("inb %%dx,%0" : "=a" (data) : "d" (port));
378 static __inline u_int
383 __asm __volatile("inl %%dx,%0" : "=a" (data) : "d" (port));
388 insb(u_int port, void *addr, size_t cnt)
390 __asm __volatile("cld; rep; insb"
391 : "+D" (addr), "+c" (cnt)
397 insw(u_int port, void *addr, size_t cnt)
399 __asm __volatile("cld; rep; insw"
400 : "+D" (addr), "+c" (cnt)
406 insl(u_int port, void *addr, size_t cnt)
408 __asm __volatile("cld; rep; insl"
409 : "+D" (addr), "+c" (cnt)
417 __asm __volatile("invd");
423 * If we are not a true-SMP box then smp_invltlb() is a NOP. Note that this
424 * will cause the invl*() functions to be equivalent to the cpu_invl*()
428 void smp_invltlb(void);
429 void smp_invltlb_intr(void);
431 #define smp_invltlb()
434 #ifndef _CPU_INVLPG_DEFINED
437 * Invalidate a patricular VA on this cpu only
440 cpu_invlpg(void *addr)
442 __asm __volatile("invlpg %0" : : "m" (*(char *)addr) : "memory");
450 __asm __volatile("rep; nop");
455 static __inline u_short
460 __asm __volatile("inw %%dx,%0" : "=a" (data) : "d" (port));
464 static __inline u_int
465 loadandclear(volatile u_int *addr)
469 __asm __volatile("xorl %0,%0; xchgl %1,%0"
470 : "=&r" (result) : "m" (*addr));
475 outbv(u_int port, u_char data)
479 * Use an unnecessary assignment to help gcc's register allocator.
480 * This make a large difference for gcc-1.40 and a tiny difference
481 * for gcc-2.6.0. For gcc-1.40, al had to be ``asm("ax")'' for
482 * best results. gcc-2.6.0 can't handle this.
485 __asm __volatile("outb %0,%%dx" : : "a" (al), "d" (port));
489 outl(u_int port, u_int data)
492 * outl() and outw() aren't used much so we haven't looked at
493 * possible micro-optimizations such as the unnecessary
494 * assignment for them.
496 __asm __volatile("outl %0,%%dx" : : "a" (data), "d" (port));
500 outsb(u_int port, const void *addr, size_t cnt)
502 __asm __volatile("cld; rep; outsb"
503 : "+S" (addr), "+c" (cnt)
508 outsw(u_int port, const void *addr, size_t cnt)
510 __asm __volatile("cld; rep; outsw"
511 : "+S" (addr), "+c" (cnt)
516 outsl(u_int port, const void *addr, size_t cnt)
518 __asm __volatile("cld; rep; outsl"
519 : "+S" (addr), "+c" (cnt)
524 outw(u_int port, u_short data)
526 __asm __volatile("outw %0,%%dx" : : "a" (data), "d" (port));
532 __asm __volatile("pause");
535 static __inline u_long
540 __asm __volatile("pushfq; popq %0" : "=r" (rf));
544 static __inline u_int64_t
549 __asm __volatile("rdmsr" : "=a" (low), "=d" (high) : "c" (msr));
550 return (low | ((u_int64_t)high << 32));
553 static __inline u_int64_t
558 __asm __volatile("rdpmc" : "=a" (low), "=d" (high) : "c" (pmc));
559 return (low | ((u_int64_t)high << 32));
562 #define _RDTSC_SUPPORTED_
564 static __inline u_int64_t
569 __asm __volatile("rdtsc" : "=a" (low), "=d" (high));
570 return (low | ((u_int64_t)high << 32));
576 __asm __volatile("wbinvd");
580 write_rflags(u_long rf)
582 __asm __volatile("pushq %0; popfq" : : "r" (rf));
586 wrmsr(u_int msr, u_int64_t newval)
592 __asm __volatile("wrmsr" : : "a" (low), "d" (high), "c" (msr));
596 load_cr0(u_long data)
599 __asm __volatile("movq %0,%%cr0" : : "r" (data));
602 static __inline u_long
607 __asm __volatile("movq %%cr0,%0" : "=r" (data));
611 static __inline u_long
616 __asm __volatile("movq %%cr2,%0" : "=r" (data));
621 load_cr3(u_long data)
624 __asm __volatile("movq %0,%%cr3" : : "r" (data) : "memory");
627 static __inline u_long
632 __asm __volatile("movq %%cr3,%0" : "=r" (data));
637 load_cr4(u_long data)
639 __asm __volatile("movq %0,%%cr4" : : "r" (data));
642 static __inline u_long
647 __asm __volatile("movq %%cr4,%0" : "=r" (data));
651 #ifndef _CPU_INVLTLB_DEFINED
654 * Invalidate the TLB on this cpu only
660 #if defined(SWTCH_OPTIM_STATS)
668 * TLB flush for an individual page (even if it has PG_G).
669 * Only works on 486+ CPUs (i386 does not have PG_G).
675 __asm __volatile("invlpg %0" : : "m" (*(char *)addr) : "memory");
678 static __inline u_short
682 __asm __volatile("movw %%fs,%0" : "=rm" (sel));
686 static __inline u_short
690 __asm __volatile("movw %%gs,%0" : "=rm" (sel));
697 __asm __volatile("movw %0,%%ds" : : "rm" (sel));
703 __asm __volatile("movw %0,%%es" : : "rm" (sel));
707 /* This is defined in <machine/specialreg.h> but is too painful to get to */
709 #define MSR_FSBASE 0xc0000100
714 /* Preserve the fsbase value across the selector load */
715 __asm __volatile("rdmsr; movw %0,%%fs; wrmsr"
716 : : "rm" (sel), "c" (MSR_FSBASE) : "eax", "edx");
720 #define MSR_GSBASE 0xc0000101
726 * Preserve the gsbase value across the selector load.
727 * Note that we have to disable interrupts because the gsbase
728 * being trashed happens to be the kernel gsbase at the time.
730 __asm __volatile("pushfq; cli; rdmsr; movw %0,%%gs; wrmsr; popfq"
731 : : "rm" (sel), "c" (MSR_GSBASE) : "eax", "edx");
734 /* Usable by userland */
738 __asm __volatile("movw %0,%%fs" : : "rm" (sel));
744 __asm __volatile("movw %0,%%gs" : : "rm" (sel));
748 /* void lidt(struct region_descriptor *addr); */
750 lidt(struct region_descriptor *addr)
752 __asm __volatile("lidt (%0)" : : "r" (addr));
755 /* void lldt(u_short sel); */
759 __asm __volatile("lldt %0" : : "r" (sel));
762 /* void ltr(u_short sel); */
766 __asm __volatile("ltr %0" : : "r" (sel));
769 static __inline u_int64_t
773 __asm __volatile("movq %%dr0,%0" : "=r" (data));
778 load_dr0(u_int64_t dr0)
780 __asm __volatile("movq %0,%%dr0" : : "r" (dr0));
783 static __inline u_int64_t
787 __asm __volatile("movq %%dr1,%0" : "=r" (data));
792 load_dr1(u_int64_t dr1)
794 __asm __volatile("movq %0,%%dr1" : : "r" (dr1));
797 static __inline u_int64_t
801 __asm __volatile("movq %%dr2,%0" : "=r" (data));
806 load_dr2(u_int64_t dr2)
808 __asm __volatile("movq %0,%%dr2" : : "r" (dr2));
811 static __inline u_int64_t
815 __asm __volatile("movq %%dr3,%0" : "=r" (data));
820 load_dr3(u_int64_t dr3)
822 __asm __volatile("movq %0,%%dr3" : : "r" (dr3));
825 static __inline u_int64_t
829 __asm __volatile("movq %%dr4,%0" : "=r" (data));
834 load_dr4(u_int64_t dr4)
836 __asm __volatile("movq %0,%%dr4" : : "r" (dr4));
839 static __inline u_int64_t
843 __asm __volatile("movq %%dr5,%0" : "=r" (data));
848 load_dr5(u_int64_t dr5)
850 __asm __volatile("movq %0,%%dr5" : : "r" (dr5));
853 static __inline u_int64_t
857 __asm __volatile("movq %%dr6,%0" : "=r" (data));
862 load_dr6(u_int64_t dr6)
864 __asm __volatile("movq %0,%%dr6" : : "r" (dr6));
867 static __inline u_int64_t
871 __asm __volatile("movq %%dr7,%0" : "=r" (data));
876 load_dr7(u_int64_t dr7)
878 __asm __volatile("movq %0,%%dr7" : : "r" (dr7));
881 static __inline register_t
886 rflags = read_rflags();
892 intr_restore(register_t rflags)
894 write_rflags(rflags);
897 #else /* !__GNUC__ */
899 int breakpoint(void);
900 void cpu_pause(void);
901 u_int bsfl(u_int mask);
902 u_int bsrl(u_int mask);
903 void cpu_disable_intr(void);
904 void cpu_enable_intr(void);
905 void cpu_invlpg(u_long addr);
906 void cpu_invlpg_range(u_long start, u_long end);
907 void do_cpuid(u_int ax, u_int *p);
909 u_char inb(u_int port);
910 u_int inl(u_int port);
911 void insb(u_int port, void *addr, size_t cnt);
912 void insl(u_int port, void *addr, size_t cnt);
913 void insw(u_int port, void *addr, size_t cnt);
915 void invlpg(u_int addr);
916 void invlpg_range(u_int start, u_int end);
917 void cpu_invltlb(void);
918 u_short inw(u_int port);
919 void load_cr0(u_int cr0);
920 void load_cr3(u_int cr3);
921 void load_cr4(u_int cr4);
922 void load_fs(u_int sel);
923 void load_gs(u_int sel);
924 struct region_descriptor;
925 void lidt(struct region_descriptor *addr);
926 void lldt(u_short sel);
927 void ltr(u_short sel);
928 void outb(u_int port, u_char data);
929 void outl(u_int port, u_int data);
930 void outsb(u_int port, void *addr, size_t cnt);
931 void outsl(u_int port, void *addr, size_t cnt);
932 void outsw(u_int port, void *addr, size_t cnt);
933 void outw(u_int port, u_short data);
934 void ia32_pause(void);
941 u_int64_t rdmsr(u_int msr);
942 u_int64_t rdpmc(u_int pmc);
943 u_int64_t rdtsc(void);
944 u_int read_rflags(void);
946 void write_rflags(u_int rf);
947 void wrmsr(u_int msr, u_int64_t newval);
948 u_int64_t rdr0(void);
949 void load_dr0(u_int64_t dr0);
950 u_int64_t rdr1(void);
951 void load_dr1(u_int64_t dr1);
952 u_int64_t rdr2(void);
953 void load_dr2(u_int64_t dr2);
954 u_int64_t rdr3(void);
955 void load_dr3(u_int64_t dr3);
956 u_int64_t rdr4(void);
957 void load_dr4(u_int64_t dr4);
958 u_int64_t rdr5(void);
959 void load_dr5(u_int64_t dr5);
960 u_int64_t rdr6(void);
961 void load_dr6(u_int64_t dr6);
962 u_int64_t rdr7(void);
963 void load_dr7(u_int64_t dr7);
964 register_t intr_disable(void);
965 void intr_restore(register_t rf);
967 #endif /* __GNUC__ */
969 int rdmsr_safe(u_int msr, uint64_t *val);
970 void reset_dbregs(void);
974 #endif /* !_CPU_CPUFUNC_H_ */