Add load, safe load, read xcr0 functions
[akaros.git] / kern / arch / x86 / x86.h
1 #pragma once
2
3 #include <ros/common.h>
4 #include <arch/mmu.h>
5 #include <ros/errno.h>
6 #include <arch/fixup.h>
7
8 /* Model Specific Registers */
9 // TODO: figure out which are intel specific, and name them accordingly
10 #define IA32_APIC_BASE                          0x1b
11 /* These two are intel-only */
12 #define IA32_FEATURE_CONTROL            0x3a
13 #define IA32_MISC_ENABLE                        0x1a0
14
15 #define IA32_MTRR_DEF_TYPE                      0x2ff
16 #define IA32_MTRR_PHYSBASE0                     0x200
17 #define IA32_MTRR_PHYSMASK0                     0x201
18 #define IA32_MTRR_PHYSBASE1                     0x202
19 #define IA32_MTRR_PHYSMASK1                     0x203
20 #define IA32_MTRR_PHYSBASE2                     0x204
21 #define IA32_MTRR_PHYSMASK2                     0x205
22 #define IA32_MTRR_PHYSBASE3                     0x206
23 #define IA32_MTRR_PHYSMASK3                     0x207
24 #define IA32_MTRR_PHYSBASE4                     0x208
25 #define IA32_MTRR_PHYSMASK4                     0x209
26 #define IA32_MTRR_PHYSBASE5                     0x20a
27 #define IA32_MTRR_PHYSMASK5                     0x20b
28 #define IA32_MTRR_PHYSBASE6                     0x20c
29 #define IA32_MTRR_PHYSMASK6                     0x20d
30 #define IA32_MTRR_PHYSBASE7                     0x20e
31 #define IA32_MTRR_PHYSMASK7                     0x20f
32
33 #define MSR_APIC_ENABLE                         0x00000800
34 #define MSR_APIC_BASE_ADDRESS           0x0000000FFFFFF000
35
36 #define IA32_EFER_MSR                           0xc0000080
37 # define IA32_EFER_SYSCALL                      (1 << 0)
38 # define IA32_EFER_IA32E_EN                     (1 << 8)
39 # define IA32_EFER_IA32E_ACT            (1 << 10)
40 # define IA32_EFER_EXE_DIS_BIT          (1 << 11)
41
42 #define MSR_TSC_AUX                                     0xc0000103
43
44 #define MSR_FS_BASE                                     0xc0000100
45 #define MSR_GS_BASE                                     0xc0000101
46 #define MSR_KERN_GS_BASE                        0xc0000102
47
48 #define MSR_STAR                                        0xc0000081
49 #define MSR_LSTAR                                       0xc0000082
50 #define MSR_CSTAR                                       0xc0000083
51 #define MSR_SFMASK                                      0xc0000084
52
53 /* CPUID */
54 #define CPUID_PSE_SUPPORT                       0x00000008
55
56 /* Arch Constants */
57 #define MAX_NUM_CORES                           255
58
59 #define X86_REG_BP                                      "rbp"
60 #define X86_REG_SP                                      "rsp"
61 #define X86_REG_IP                                      "rip"
62 #define X86_REG_AX                                      "rax"
63 #define X86_REG_BX                                      "rbx"
64 #define X86_REG_CX                                      "rcx"
65 #define X86_REG_DX                                      "rdx"
66
67
68 /* Various flags defined: can be included from assembler. */
69
70 /*
71  * EFLAGS bits
72  */
73 #define X86_EFLAGS_CF   0x00000001 /* Carry Flag */
74 #define X86_EFLAGS_BIT1 0x00000002 /* Bit 1 - always on */
75 #define X86_EFLAGS_PF   0x00000004 /* Parity Flag */
76 #define X86_EFLAGS_AF   0x00000010 /* Auxiliary carry Flag */
77 #define X86_EFLAGS_ZF   0x00000040 /* Zero Flag */
78 #define X86_EFLAGS_SF   0x00000080 /* Sign Flag */
79 #define X86_EFLAGS_TF   0x00000100 /* Trap Flag */
80 #define X86_EFLAGS_IF   0x00000200 /* Interrupt Flag */
81 #define X86_EFLAGS_DF   0x00000400 /* Direction Flag */
82 #define X86_EFLAGS_OF   0x00000800 /* Overflow Flag */
83 #define X86_EFLAGS_IOPL 0x00003000 /* IOPL mask */
84 #define X86_EFLAGS_NT   0x00004000 /* Nested Task */
85 #define X86_EFLAGS_RF   0x00010000 /* Resume Flag */
86 #define X86_EFLAGS_VM   0x00020000 /* Virtual Mode */
87 #define X86_EFLAGS_AC   0x00040000 /* Alignment Check */
88 #define X86_EFLAGS_VIF  0x00080000 /* Virtual Interrupt Flag */
89 #define X86_EFLAGS_VIP  0x00100000 /* Virtual Interrupt Pending */
90 #define X86_EFLAGS_ID   0x00200000 /* CPUID detection flag */
91
92 /*
93  * Basic CPU control in CR0
94  */
95 #define X86_CR0_PE      0x00000001 /* Protection Enable */
96 #define X86_CR0_MP      0x00000002 /* Monitor Coprocessor */
97 #define X86_CR0_EM      0x00000004 /* Emulation */
98 #define X86_CR0_TS      0x00000008 /* Task Switched */
99 #define X86_CR0_ET      0x00000010 /* Extension Type */
100 #define X86_CR0_NE      0x00000020 /* Numeric Error */
101 #define X86_CR0_WP      0x00010000 /* Write Protect */
102 #define X86_CR0_AM      0x00040000 /* Alignment Mask */
103 #define X86_CR0_NW      0x20000000 /* Not Write-through */
104 #define X86_CR0_CD      0x40000000 /* Cache Disable */
105 #define X86_CR0_PG      0x80000000 /* Paging */
106
107 /*
108  * Paging options in CR3
109  */
110 #define X86_CR3_PWT     0x00000008 /* Page Write Through */
111 #define X86_CR3_PCD     0x00000010 /* Page Cache Disable */
112 #define X86_CR3_PCID_MASK 0x00000fff /* PCID Mask */
113
114 /*
115  * Intel CPU features in CR4
116  */
117 #define X86_CR4_VME     0x00000001 /* enable vm86 extensions */
118 #define X86_CR4_PVI     0x00000002 /* virtual interrupts flag enable */
119 #define X86_CR4_TSD     0x00000004 /* disable time stamp at ipl 3 */
120 #define X86_CR4_DE      0x00000008 /* enable debugging extensions */
121 #define X86_CR4_PSE     0x00000010 /* enable page size extensions */
122 #define X86_CR4_PAE     0x00000020 /* enable physical address extensions */
123 #define X86_CR4_MCE     0x00000040 /* Machine check enable */
124 #define X86_CR4_PGE     0x00000080 /* enable global pages */
125 #define X86_CR4_PCE     0x00000100 /* enable performance counters at ipl 3 */
126 #define X86_CR4_OSFXSR  0x00000200 /* enable fast FPU save and restore */
127 #define X86_CR4_OSXMMEXCPT 0x00000400 /* enable unmasked SSE exceptions */
128 #define X86_CR4_VMXE    0x00002000 /* enable VMX virtualization */
129 #define X86_CR4_RDWRGSFS 0x00010000 /* enable RDWRGSFS support */
130 #define X86_CR4_PCIDE   0x00020000 /* enable PCID support */
131 #define X86_CR4_OSXSAVE 0x00040000 /* enable xsave and xrestore */
132 #define X86_CR4_SMEP    0x00100000 /* enable SMEP support */
133 #define X86_CR4_SMAP    0x00200000 /* enable SMAP support */
134
135 /*
136  * x86-64 Task Priority Register, CR8
137  */
138 #define X86_CR8_TPR     0x0000000F /* task priority register */
139
140 #ifndef __ASSEMBLER__
141 static inline uint8_t inb(int port) __attribute__((always_inline));
142 static inline void insb(int port, void *addr, int cnt)
143               __attribute__((always_inline));
144 static inline uint16_t inw(int port) __attribute__((always_inline));
145 static inline void insw(int port, void *addr, int cnt)
146               __attribute__((always_inline));
147 static inline uint32_t inl(int port) __attribute__((always_inline));
148 static inline void insl(int port, void *addr, int cnt)
149               __attribute__((always_inline));
150 static inline void outb(int port, uint8_t data) __attribute__((always_inline));
151 static inline void outsb(int port, const void *addr, int cnt)
152               __attribute__((always_inline));
153 static inline void outw(int port, uint16_t data) __attribute__((always_inline));
154 static inline void outsw(int port, const void *addr, int cnt)
155               __attribute__((always_inline));
156 static inline void outsl(int port, const void *addr, int cnt)
157               __attribute__((always_inline));
158 static inline void outl(int port, uint32_t data) __attribute__((always_inline));
159 static inline void lidt(void *p) __attribute__((always_inline));
160 static inline void lldt(uint16_t sel) __attribute__((always_inline));
161 static inline void ltr(uint16_t sel) __attribute__((always_inline));
162 static inline void lcr0(unsigned long val) __attribute__((always_inline));
163 static inline unsigned long rcr0(void) __attribute__((always_inline));
164 static inline unsigned long rcr2(void) __attribute__((always_inline));
165 static inline void lcr3(unsigned long val) __attribute__((always_inline));
166 static inline unsigned long rcr3(void) __attribute__((always_inline));
167 static inline void lcr4(unsigned long val) __attribute__((always_inline));
168 static inline unsigned long rcr4(void) __attribute__((always_inline));
169
170 static inline void lxcr0(uint64_t xcr0) __attribute__((always_inline));
171 static inline int safe_lxcr0(uint64_t xcr0) __attribute__((always_inline));
172 static inline uint64_t rxcr0(void) __attribute__((always_inline));
173
174 static inline unsigned long read_flags(void) __attribute__((always_inline));
175 static inline void write_eflags(unsigned long eflags)
176               __attribute__((always_inline));
177 static inline unsigned long read_bp(void) __attribute__((always_inline));
178 static inline unsigned long read_pc(void) __attribute__((always_inline));
179 static inline unsigned long read_sp(void) __attribute__((always_inline));
180 static inline void cpuid(uint32_t info1, uint32_t info2, uint32_t *eaxp,
181                          uint32_t *ebxp, uint32_t *ecxp, uint32_t *edxp)
182                                                                __attribute__((always_inline));
183 static inline uint32_t cpuid_ecx(uint32_t op) __attribute__((always_inline));
184 static inline uint64_t read_msr(uint32_t reg) __attribute__((always_inline));
185 static inline void write_msr(uint32_t reg, uint64_t val)
186               __attribute__((always_inline));
187 /* if we have mm64s, change the hpet helpers */
188 static inline void write_mmreg32(uintptr_t reg, uint32_t val)
189               __attribute__((always_inline));
190 static inline uint32_t read_mmreg32(uintptr_t reg)
191               __attribute__((always_inline));
192 static inline void wbinvd(void) __attribute__((always_inline));
193 static inline void __cpu_relax(void) __attribute__((always_inline));
194
195 static inline uint8_t inb(int port)
196 {
197         uint8_t data;
198         asm volatile("inb %w1,%0" : "=a" (data) : "d" (port));
199         return data;
200 }
201
202 static inline void insb(int port, void *addr, int cnt)
203 {
204         asm volatile("cld\n\trepne\n\tinsb"
205                      : "=D" (addr), "=c" (cnt)
206                      : "d" (port), "0" (addr), "1" (cnt)
207                      : "memory", "cc");
208 }
209
210 static inline uint16_t inw(int port)
211 {
212         uint16_t data;
213         asm volatile("inw %w1,%0" : "=a" (data) : "d" (port));
214         return data;
215 }
216
217 static inline void insw(int port, void *addr, int cnt)
218 {
219         asm volatile("cld\n\trepne\n\tinsw"
220                      : "=D" (addr), "=c" (cnt)
221                      : "d" (port), "0" (addr), "1" (cnt)
222                      : "memory", "cc");
223 }
224
225 static inline uint32_t inl(int port)
226 {
227         uint32_t data;
228         asm volatile("inl %w1,%0" : "=a" (data) : "d" (port));
229         return data;
230 }
231
232 static inline void insl(int port, void *addr, int cnt)
233 {
234         asm volatile("cld\n\trepne\n\tinsl"
235                      : "=D" (addr), "=c" (cnt)
236                      : "d" (port), "0" (addr), "1" (cnt)
237                      : "memory", "cc");
238 }
239
240 static inline void outb(int port, uint8_t data)
241 {
242         asm volatile("outb %0,%w1" : : "a" (data), "d" (port));
243 }
244
245 static inline void outsb(int port, const void *addr, int cnt)
246 {
247         asm volatile("cld\n\trepne\n\toutsb"
248                      : "=S" (addr), "=c" (cnt)
249                      : "d" (port), "0" (addr), "1" (cnt)
250                      : "cc");
251 }
252
253 static inline void outw(int port, uint16_t data)
254 {
255         asm volatile("outw %0,%w1" : : "a" (data), "d" (port));
256 }
257
258 static inline void outsw(int port, const void *addr, int cnt)
259 {
260         asm volatile("cld\n\trepne\n\toutsw"
261                      : "=S" (addr), "=c" (cnt)
262                      : "d" (port), "0" (addr), "1" (cnt)
263                      : "cc");
264 }
265
266 static inline void outsl(int port, const void *addr, int cnt)
267 {
268         asm volatile("cld\n\trepne\n\toutsl"
269                      : "=S" (addr), "=c" (cnt)
270                      : "d" (port), "0" (addr), "1" (cnt)
271                      : "cc");
272 }
273
274 static inline void outl(int port, uint32_t data)
275 {
276         asm volatile("outl %0,%w1" : : "a" (data), "d" (port));
277 }
278
279 static inline void lidt(void *p)
280 {
281         asm volatile("lidt (%0)" : : "r" (p));
282 }
283
284 static inline void lldt(uint16_t sel)
285 {
286         asm volatile("lldt %0" : : "r" (sel));
287 }
288
289 static inline void ltr(uint16_t sel)
290 {
291         asm volatile("ltr %0" : : "r" (sel));
292 }
293
294 static inline void lcr0(unsigned long val)
295 {
296         asm volatile("mov %0,%%cr0" : : "r" (val));
297 }
298
299 static inline unsigned long rcr0(void)
300 {
301         unsigned long val;
302         asm volatile("mov %%cr0,%0" : "=r" (val));
303         return val;
304 }
305
306 static inline void lcr2(unsigned long val)
307 {
308         asm volatile("mov %0,%%cr2" : : "r" (val));
309 }
310
311 static inline unsigned long rcr2(void)
312 {
313         unsigned long val;
314         asm volatile("mov %%cr2,%0" : "=r" (val));
315         return val;
316 }
317
318 static inline void lcr3(unsigned long val)
319 {
320         asm volatile("mov %0,%%cr3" : : "r" (val));
321 }
322
323 static inline unsigned long rcr3(void)
324 {
325         unsigned long val;
326         asm volatile("mov %%cr3,%0" : "=r" (val));
327         return val;
328 }
329
330 static inline void lcr4(unsigned long val)
331 {
332         asm volatile("mov %0,%%cr4" : : "r" (val));
333 }
334
335 static inline unsigned long rcr4(void)
336 {
337         unsigned long cr4;
338         asm volatile("mov %%cr4,%0" : "=r" (cr4));
339         return cr4;
340 }
341
342 static inline void lxcr0(uint64_t xcr0)
343 {
344         uint32_t eax, edx;
345
346         edx = xcr0 >> 32;
347         eax = xcr0;
348         asm volatile("xsetbv"
349                      : /* No outputs */
350                      : "a"(eax), "c" (0), "d"(edx));
351 }
352
353 static inline int safe_lxcr0(uint64_t xcr0)
354 {
355         int err = 0;
356         uint32_t eax, edx;
357
358         edx = xcr0 >> 32;
359         eax = xcr0;
360         asm volatile(ASM_STAC               ";"
361                          "1: xsetbv              ;"
362                      "2: " ASM_CLAC "        ;"
363                      ".section .fixup, \"ax\";"
364                      "3: mov %4, %0          ;"
365                      "   jmp 2b              ;"
366                      ".previous              ;"
367                      _ASM_EXTABLE(1b, 3b)
368                      : "=r" (err)
369                      : "a"(eax), "c" (0), "d"(edx),
370                        "i" (-EINVAL), "0" (err));
371
372         return err;
373 }
374
375 static inline uint64_t rxcr0(void)
376 {
377         uint32_t eax, edx;
378
379         asm volatile("xgetbv"
380                      : "=a"(eax), "=d"(edx)
381                      : "c" (0));
382         return ((uint64_t)edx << 32) | eax;
383 }
384
385 static inline unsigned long read_flags(void)
386 {
387         unsigned long eflags;
388         asm volatile("pushf; pop %0" : "=r" (eflags));
389         return eflags;
390 }
391
392 static inline void write_eflags(unsigned long eflags)
393 {
394         asm volatile("push %0; popf" : : "r" (eflags));
395 }
396
397 static inline unsigned long read_bp(void)
398 {
399         unsigned long bp;
400         asm volatile("mov %%"X86_REG_BP",%0" : "=r" (bp));
401         return bp;
402 }
403
404 static inline unsigned long read_pc(void)
405 {
406         unsigned long ip;
407         asm volatile("call 1f; 1: pop %0" : "=r"(ip));
408         return ip;
409 }
410
411 static inline unsigned long read_sp(void)
412 {
413         unsigned long sp;
414         asm volatile("mov %%"X86_REG_SP",%0" : "=r" (sp));
415         return sp;
416 }
417
418 static inline void cpuid(uint32_t info1, uint32_t info2, uint32_t *eaxp,
419                          uint32_t *ebxp, uint32_t *ecxp, uint32_t *edxp)
420 {
421         uint32_t eax, ebx, ecx, edx;
422         /* Can select with both eax (info1) and ecx (info2) */
423         asm volatile("cpuid"
424                 : "=a" (eax), "=b" (ebx), "=c" (ecx), "=d" (edx)
425                 : "a" (info1), "c" (info2));
426         if (eaxp)
427                 *eaxp = eax;
428         if (ebxp)
429                 *ebxp = ebx;
430         if (ecxp)
431                 *ecxp = ecx;
432         if (edxp)
433                 *edxp = edx;
434 }
435
436 static inline uint32_t cpuid_ecx(uint32_t op)
437 {
438         uint32_t ecx;
439         cpuid(op, 0, NULL, NULL, &ecx, NULL);
440         return ecx;
441 }
442
443 // Might need to mfence rdmsr.  supposedly wrmsr serializes, but not for x2APIC
444 static inline uint64_t read_msr(uint32_t reg)
445 {
446         uint32_t edx, eax;
447         asm volatile("rdmsr; mfence" : "=d"(edx), "=a"(eax) : "c"(reg));
448         return (uint64_t)edx << 32 | eax;
449 }
450
451 static inline void write_msr(uint32_t reg, uint64_t val)
452 {
453         asm volatile("wrmsr" : : "d"((uint32_t)(val >> 32)),
454                                  "a"((uint32_t)(val & 0xFFFFFFFF)),
455                                  "c"(reg));
456 }
457
458 static inline void write_mmreg32(uintptr_t reg, uint32_t val)
459 {
460         *((volatile uint32_t*)reg) = val;
461 }
462
463 static inline uint32_t read_mmreg32(uintptr_t reg)
464 {
465         return *((volatile uint32_t*)reg);
466 }
467
468 static inline void wbinvd(void)
469 {
470         asm volatile("wbinvd");
471 }
472
473 /* this version of cpu_relax is needed to resolve some circular dependencies
474  * with arch/arch.h and arch/apic.h */
475 static inline void __cpu_relax(void)
476 {
477         // in case the compiler doesn't serialize for pause, the "m" will make sure
478         // no memory is reordered around this instruction.
479         asm volatile("pause" : : : "memory");
480 }
481
482 #ifndef UNUSED_ARG
483 #define UNUSED_ARG(x) (void)x
484 #endif /* This prevents compiler warnings for UNUSED_ARG */
485 #endif /* !__ASSEMBLER__ */