1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef _ASM_X86_PARAVIRT_TYPES_H 3 #define _ASM_X86_PARAVIRT_TYPES_H 4 5 #ifdef CONFIG_PARAVIRT 6 7 #ifndef __ASSEMBLY__ 8 #include <linux/types.h> 9 10 #include <asm/desc_defs.h> 11 #include <asm/pgtable_types.h> 12 #include <asm/nospec-branch.h> 13 14 struct page; 15 struct thread_struct; 16 struct desc_ptr; 17 struct tss_struct; 18 struct mm_struct; 19 struct desc_struct; 20 struct task_struct; 21 struct cpumask; 22 struct flush_tlb_info; 23 struct mmu_gather; 24 struct vm_area_struct; 25 26 /* 27 * Wrapper type for pointers to code which uses the non-standard 28 * calling convention. See PV_CALL_SAVE_REGS_THUNK below. 29 */ 30 struct paravirt_callee_save { 31 void *func; 32 }; 33 34 /* general info */ 35 struct pv_info { 36 #ifdef CONFIG_PARAVIRT_XXL 37 u16 extra_user_64bit_cs; /* __USER_CS if none */ 38 #endif 39 40 const char *name; 41 }; 42 43 #ifdef CONFIG_PARAVIRT_XXL 44 struct pv_lazy_ops { 45 /* Set deferred update mode, used for batching operations. */ 46 void (*enter)(void); 47 void (*leave)(void); 48 void (*flush)(void); 49 } __no_randomize_layout; 50 #endif 51 52 struct pv_cpu_ops { 53 /* hooks for various privileged instructions */ 54 void (*io_delay)(void); 55 56 #ifdef CONFIG_PARAVIRT_XXL 57 unsigned long (*get_debugreg)(int regno); 58 void (*set_debugreg)(int regno, unsigned long value); 59 60 unsigned long (*read_cr0)(void); 61 void (*write_cr0)(unsigned long); 62 63 void (*write_cr4)(unsigned long); 64 65 /* Segment descriptor handling */ 66 void (*load_tr_desc)(void); 67 void (*load_gdt)(const struct desc_ptr *); 68 void (*load_idt)(const struct desc_ptr *); 69 void (*set_ldt)(const void *desc, unsigned entries); 70 unsigned long (*store_tr)(void); 71 void (*load_tls)(struct thread_struct *t, unsigned int cpu); 72 void (*load_gs_index)(unsigned int idx); 73 void (*write_ldt_entry)(struct desc_struct *ldt, int entrynum, 74 const void *desc); 75 void (*write_gdt_entry)(struct desc_struct *, 76 int entrynum, const void *desc, int size); 77 void (*write_idt_entry)(gate_desc *, 78 int entrynum, const gate_desc *gate); 79 void (*alloc_ldt)(struct desc_struct *ldt, unsigned entries); 80 void (*free_ldt)(struct desc_struct *ldt, unsigned entries); 81 82 void (*load_sp0)(unsigned long sp0); 83 84 #ifdef CONFIG_X86_IOPL_IOPERM 85 void (*invalidate_io_bitmap)(void); 86 void (*update_io_bitmap)(void); 87 #endif 88 89 void (*wbinvd)(void); 90 91 /* cpuid emulation, mostly so that caps bits can be disabled */ 92 void (*cpuid)(unsigned int *eax, unsigned int *ebx, 93 unsigned int *ecx, unsigned int *edx); 94 95 /* Unsafe MSR operations. These will warn or panic on failure. */ 96 u64 (*read_msr)(unsigned int msr); 97 void (*write_msr)(unsigned int msr, unsigned low, unsigned high); 98 99 /* 100 * Safe MSR operations. 101 * read sets err to 0 or -EIO. write returns 0 or -EIO. 102 */ 103 u64 (*read_msr_safe)(unsigned int msr, int *err); 104 int (*write_msr_safe)(unsigned int msr, unsigned low, unsigned high); 105 106 u64 (*read_pmc)(int counter); 107 108 void (*start_context_switch)(struct task_struct *prev); 109 void (*end_context_switch)(struct task_struct *next); 110 #endif 111 } __no_randomize_layout; 112 113 struct pv_irq_ops { 114 #ifdef CONFIG_PARAVIRT_XXL 115 /* 116 * Get/set interrupt state. save_fl is expected to use X86_EFLAGS_IF; 117 * all other bits returned from save_fl are undefined. 118 * 119 * NOTE: These functions callers expect the callee to preserve 120 * more registers than the standard C calling convention. 121 */ 122 struct paravirt_callee_save save_fl; 123 struct paravirt_callee_save irq_disable; 124 struct paravirt_callee_save irq_enable; 125 #endif 126 void (*safe_halt)(void); 127 void (*halt)(void); 128 } __no_randomize_layout; 129 130 struct pv_mmu_ops { 131 /* TLB operations */ 132 void (*flush_tlb_user)(void); 133 void (*flush_tlb_kernel)(void); 134 void (*flush_tlb_one_user)(unsigned long addr); 135 void (*flush_tlb_multi)(const struct cpumask *cpus, 136 const struct flush_tlb_info *info); 137 138 void (*tlb_remove_table)(struct mmu_gather *tlb, void *table); 139 140 /* Hook for intercepting the destruction of an mm_struct. */ 141 void (*exit_mmap)(struct mm_struct *mm); 142 void (*notify_page_enc_status_changed)(unsigned long pfn, int npages, bool enc); 143 144 #ifdef CONFIG_PARAVIRT_XXL 145 struct paravirt_callee_save read_cr2; 146 void (*write_cr2)(unsigned long); 147 148 unsigned long (*read_cr3)(void); 149 void (*write_cr3)(unsigned long); 150 151 /* Hook for intercepting the creation/use of an mm_struct. */ 152 void (*enter_mmap)(struct mm_struct *mm); 153 154 /* Hooks for allocating and freeing a pagetable top-level */ 155 int (*pgd_alloc)(struct mm_struct *mm); 156 void (*pgd_free)(struct mm_struct *mm, pgd_t *pgd); 157 158 /* 159 * Hooks for allocating/releasing pagetable pages when they're 160 * attached to a pagetable 161 */ 162 void (*alloc_pte)(struct mm_struct *mm, unsigned long pfn); 163 void (*alloc_pmd)(struct mm_struct *mm, unsigned long pfn); 164 void (*alloc_pud)(struct mm_struct *mm, unsigned long pfn); 165 void (*alloc_p4d)(struct mm_struct *mm, unsigned long pfn); 166 void (*release_pte)(unsigned long pfn); 167 void (*release_pmd)(unsigned long pfn); 168 void (*release_pud)(unsigned long pfn); 169 void (*release_p4d)(unsigned long pfn); 170 171 /* Pagetable manipulation functions */ 172 void (*set_pte)(pte_t *ptep, pte_t pteval); 173 void (*set_pmd)(pmd_t *pmdp, pmd_t pmdval); 174 175 pte_t (*ptep_modify_prot_start)(struct vm_area_struct *vma, unsigned long addr, 176 pte_t *ptep); 177 void (*ptep_modify_prot_commit)(struct vm_area_struct *vma, unsigned long addr, 178 pte_t *ptep, pte_t pte); 179 180 struct paravirt_callee_save pte_val; 181 struct paravirt_callee_save make_pte; 182 183 struct paravirt_callee_save pgd_val; 184 struct paravirt_callee_save make_pgd; 185 186 void (*set_pud)(pud_t *pudp, pud_t pudval); 187 188 struct paravirt_callee_save pmd_val; 189 struct paravirt_callee_save make_pmd; 190 191 struct paravirt_callee_save pud_val; 192 struct paravirt_callee_save make_pud; 193 194 void (*set_p4d)(p4d_t *p4dp, p4d_t p4dval); 195 196 #if CONFIG_PGTABLE_LEVELS >= 5 197 struct paravirt_callee_save p4d_val; 198 struct paravirt_callee_save make_p4d; 199 200 void (*set_pgd)(pgd_t *pgdp, pgd_t pgdval); 201 #endif /* CONFIG_PGTABLE_LEVELS >= 5 */ 202 203 struct pv_lazy_ops lazy_mode; 204 205 /* dom0 ops */ 206 207 /* Sometimes the physical address is a pfn, and sometimes its 208 an mfn. We can tell which is which from the index. */ 209 void (*set_fixmap)(unsigned /* enum fixed_addresses */ idx, 210 phys_addr_t phys, pgprot_t flags); 211 #endif 212 } __no_randomize_layout; 213 214 struct arch_spinlock; 215 #ifdef CONFIG_SMP 216 #include <asm/spinlock_types.h> 217 #endif 218 219 struct qspinlock; 220 221 struct pv_lock_ops { 222 void (*queued_spin_lock_slowpath)(struct qspinlock *lock, u32 val); 223 struct paravirt_callee_save queued_spin_unlock; 224 225 void (*wait)(u8 *ptr, u8 val); 226 void (*kick)(int cpu); 227 228 struct paravirt_callee_save vcpu_is_preempted; 229 } __no_randomize_layout; 230 231 /* This contains all the paravirt structures: we get a convenient 232 * number for each function using the offset which we use to indicate 233 * what to patch. */ 234 struct paravirt_patch_template { 235 struct pv_cpu_ops cpu; 236 struct pv_irq_ops irq; 237 struct pv_mmu_ops mmu; 238 struct pv_lock_ops lock; 239 } __no_randomize_layout; 240 241 extern struct pv_info pv_info; 242 extern struct paravirt_patch_template pv_ops; 243 244 #define paravirt_ptr(op) [paravirt_opptr] "m" (pv_ops.op) 245 246 int paravirt_disable_iospace(void); 247 248 /* This generates an indirect call based on the operation type number. */ 249 #define PARAVIRT_CALL \ 250 ANNOTATE_RETPOLINE_SAFE \ 251 "call *%[paravirt_opptr];" 252 253 /* 254 * These macros are intended to wrap calls through one of the paravirt 255 * ops structs, so that they can be later identified and patched at 256 * runtime. 257 * 258 * Normally, a call to a pv_op function is a simple indirect call: 259 * (pv_op_struct.operations)(args...). 260 * 261 * Unfortunately, this is a relatively slow operation for modern CPUs, 262 * because it cannot necessarily determine what the destination 263 * address is. In this case, the address is a runtime constant, so at 264 * the very least we can patch the call to a simple direct call, or, 265 * ideally, patch an inline implementation into the callsite. (Direct 266 * calls are essentially free, because the call and return addresses 267 * are completely predictable.) 268 * 269 * For i386, these macros rely on the standard gcc "regparm(3)" calling 270 * convention, in which the first three arguments are placed in %eax, 271 * %edx, %ecx (in that order), and the remaining arguments are placed 272 * on the stack. All caller-save registers (eax,edx,ecx) are expected 273 * to be modified (either clobbered or used for return values). 274 * X86_64, on the other hand, already specifies a register-based calling 275 * conventions, returning at %rax, with parameters going in %rdi, %rsi, 276 * %rdx, and %rcx. Note that for this reason, x86_64 does not need any 277 * special handling for dealing with 4 arguments, unlike i386. 278 * However, x86_64 also has to clobber all caller saved registers, which 279 * unfortunately, are quite a bit (r8 - r11) 280 * 281 * Unfortunately there's no way to get gcc to generate the args setup 282 * for the call, and then allow the call itself to be generated by an 283 * inline asm. Because of this, we must do the complete arg setup and 284 * return value handling from within these macros. This is fairly 285 * cumbersome. 286 * 287 * There are 5 sets of PVOP_* macros for dealing with 0-4 arguments. 288 * It could be extended to more arguments, but there would be little 289 * to be gained from that. For each number of arguments, there are 290 * two VCALL and CALL variants for void and non-void functions. 291 * 292 * When there is a return value, the invoker of the macro must specify 293 * the return type. The macro then uses sizeof() on that type to 294 * determine whether it's a 32 or 64 bit value and places the return 295 * in the right register(s) (just %eax for 32-bit, and %edx:%eax for 296 * 64-bit). For x86_64 machines, it just returns in %rax regardless of 297 * the return value size. 298 * 299 * 64-bit arguments are passed as a pair of adjacent 32-bit arguments; 300 * i386 also passes 64-bit arguments as a pair of adjacent 32-bit arguments 301 * in low,high order 302 * 303 * Small structures are passed and returned in registers. The macro 304 * calling convention can't directly deal with this, so the wrapper 305 * functions must do it. 306 * 307 * These PVOP_* macros are only defined within this header. This 308 * means that all uses must be wrapped in inline functions. This also 309 * makes sure the incoming and outgoing types are always correct. 310 */ 311 #ifdef CONFIG_X86_32 312 #define PVOP_CALL_ARGS \ 313 unsigned long __eax = __eax, __edx = __edx, __ecx = __ecx; 314 315 #define PVOP_CALL_ARG1(x) "a" ((unsigned long)(x)) 316 #define PVOP_CALL_ARG2(x) "d" ((unsigned long)(x)) 317 #define PVOP_CALL_ARG3(x) "c" ((unsigned long)(x)) 318 319 #define PVOP_VCALL_CLOBBERS "=a" (__eax), "=d" (__edx), \ 320 "=c" (__ecx) 321 #define PVOP_CALL_CLOBBERS PVOP_VCALL_CLOBBERS 322 323 #define PVOP_VCALLEE_CLOBBERS "=a" (__eax), "=d" (__edx) 324 #define PVOP_CALLEE_CLOBBERS PVOP_VCALLEE_CLOBBERS 325 326 #define EXTRA_CLOBBERS 327 #define VEXTRA_CLOBBERS 328 #else /* CONFIG_X86_64 */ 329 /* [re]ax isn't an arg, but the return val */ 330 #define PVOP_CALL_ARGS \ 331 unsigned long __edi = __edi, __esi = __esi, \ 332 __edx = __edx, __ecx = __ecx, __eax = __eax; 333 334 #define PVOP_CALL_ARG1(x) "D" ((unsigned long)(x)) 335 #define PVOP_CALL_ARG2(x) "S" ((unsigned long)(x)) 336 #define PVOP_CALL_ARG3(x) "d" ((unsigned long)(x)) 337 #define PVOP_CALL_ARG4(x) "c" ((unsigned long)(x)) 338 339 #define PVOP_VCALL_CLOBBERS "=D" (__edi), \ 340 "=S" (__esi), "=d" (__edx), \ 341 "=c" (__ecx) 342 #define PVOP_CALL_CLOBBERS PVOP_VCALL_CLOBBERS, "=a" (__eax) 343 344 /* 345 * void functions are still allowed [re]ax for scratch. 346 * 347 * The ZERO_CALL_USED REGS feature may end up zeroing out callee-saved 348 * registers. Make sure we model this with the appropriate clobbers. 349 */ 350 #ifdef CONFIG_ZERO_CALL_USED_REGS 351 #define PVOP_VCALLEE_CLOBBERS "=a" (__eax), PVOP_VCALL_CLOBBERS 352 #else 353 #define PVOP_VCALLEE_CLOBBERS "=a" (__eax) 354 #endif 355 #define PVOP_CALLEE_CLOBBERS PVOP_VCALLEE_CLOBBERS 356 357 #define EXTRA_CLOBBERS , "r8", "r9", "r10", "r11" 358 #define VEXTRA_CLOBBERS , "rax", "r8", "r9", "r10", "r11" 359 #endif /* CONFIG_X86_32 */ 360 361 #ifdef CONFIG_PARAVIRT_DEBUG 362 #define PVOP_TEST_NULL(op) BUG_ON(pv_ops.op == NULL) 363 #else 364 #define PVOP_TEST_NULL(op) ((void)pv_ops.op) 365 #endif 366 367 #define PVOP_RETVAL(rettype) \ 368 ({ unsigned long __mask = ~0UL; \ 369 BUILD_BUG_ON(sizeof(rettype) > sizeof(unsigned long)); \ 370 switch (sizeof(rettype)) { \ 371 case 1: __mask = 0xffUL; break; \ 372 case 2: __mask = 0xffffUL; break; \ 373 case 4: __mask = 0xffffffffUL; break; \ 374 default: break; \ 375 } \ 376 __mask & __eax; \ 377 }) 378 379 /* 380 * Use alternative patching for paravirt calls: 381 * - For replacing an indirect call with a direct one, use the "normal" 382 * ALTERNATIVE() macro with the indirect call as the initial code sequence, 383 * which will be replaced with the related direct call by using the 384 * ALT_FLAG_DIRECT_CALL special case and the "always on" feature. 385 * - In case the replacement is either a direct call or a short code sequence 386 * depending on a feature bit, the ALTERNATIVE_2() macro is being used. 387 * The indirect call is the initial code sequence again, while the special 388 * code sequence is selected with the specified feature bit. In case the 389 * feature is not active, the direct call is used as above via the 390 * ALT_FLAG_DIRECT_CALL special case and the "always on" feature. 391 */ 392 #define ____PVOP_CALL(ret, op, call_clbr, extra_clbr, ...) \ 393 ({ \ 394 PVOP_CALL_ARGS; \ 395 PVOP_TEST_NULL(op); \ 396 asm volatile(ALTERNATIVE(PARAVIRT_CALL, ALT_CALL_INSTR, \ 397 ALT_CALL_ALWAYS) \ 398 : call_clbr, ASM_CALL_CONSTRAINT \ 399 : paravirt_ptr(op), \ 400 ##__VA_ARGS__ \ 401 : "memory", "cc" extra_clbr); \ 402 ret; \ 403 }) 404 405 #define ____PVOP_ALT_CALL(ret, op, alt, cond, call_clbr, \ 406 extra_clbr, ...) \ 407 ({ \ 408 PVOP_CALL_ARGS; \ 409 PVOP_TEST_NULL(op); \ 410 asm volatile(ALTERNATIVE_2(PARAVIRT_CALL, \ 411 ALT_CALL_INSTR, ALT_CALL_ALWAYS, \ 412 alt, cond) \ 413 : call_clbr, ASM_CALL_CONSTRAINT \ 414 : paravirt_ptr(op), \ 415 ##__VA_ARGS__ \ 416 : "memory", "cc" extra_clbr); \ 417 ret; \ 418 }) 419 420 #define __PVOP_CALL(rettype, op, ...) \ 421 ____PVOP_CALL(PVOP_RETVAL(rettype), op, \ 422 PVOP_CALL_CLOBBERS, EXTRA_CLOBBERS, ##__VA_ARGS__) 423 424 #define __PVOP_ALT_CALL(rettype, op, alt, cond, ...) \ 425 ____PVOP_ALT_CALL(PVOP_RETVAL(rettype), op, alt, cond, \ 426 PVOP_CALL_CLOBBERS, EXTRA_CLOBBERS, \ 427 ##__VA_ARGS__) 428 429 #define __PVOP_CALLEESAVE(rettype, op, ...) \ 430 ____PVOP_CALL(PVOP_RETVAL(rettype), op.func, \ 431 PVOP_CALLEE_CLOBBERS, , ##__VA_ARGS__) 432 433 #define __PVOP_ALT_CALLEESAVE(rettype, op, alt, cond, ...) \ 434 ____PVOP_ALT_CALL(PVOP_RETVAL(rettype), op.func, alt, cond, \ 435 PVOP_CALLEE_CLOBBERS, , ##__VA_ARGS__) 436 437 438 #define __PVOP_VCALL(op, ...) \ 439 (void)____PVOP_CALL(, op, PVOP_VCALL_CLOBBERS, \ 440 VEXTRA_CLOBBERS, ##__VA_ARGS__) 441 442 #define __PVOP_ALT_VCALL(op, alt, cond, ...) \ 443 (void)____PVOP_ALT_CALL(, op, alt, cond, \ 444 PVOP_VCALL_CLOBBERS, VEXTRA_CLOBBERS, \ 445 ##__VA_ARGS__) 446 447 #define __PVOP_VCALLEESAVE(op, ...) \ 448 (void)____PVOP_CALL(, op.func, \ 449 PVOP_VCALLEE_CLOBBERS, , ##__VA_ARGS__) 450 451 #define __PVOP_ALT_VCALLEESAVE(op, alt, cond, ...) \ 452 (void)____PVOP_ALT_CALL(, op.func, alt, cond, \ 453 PVOP_VCALLEE_CLOBBERS, , ##__VA_ARGS__) 454 455 456 #define PVOP_CALL0(rettype, op) \ 457 __PVOP_CALL(rettype, op) 458 #define PVOP_VCALL0(op) \ 459 __PVOP_VCALL(op) 460 #define PVOP_ALT_CALL0(rettype, op, alt, cond) \ 461 __PVOP_ALT_CALL(rettype, op, alt, cond) 462 #define PVOP_ALT_VCALL0(op, alt, cond) \ 463 __PVOP_ALT_VCALL(op, alt, cond) 464 465 #define PVOP_CALLEE0(rettype, op) \ 466 __PVOP_CALLEESAVE(rettype, op) 467 #define PVOP_VCALLEE0(op) \ 468 __PVOP_VCALLEESAVE(op) 469 #define PVOP_ALT_CALLEE0(rettype, op, alt, cond) \ 470 __PVOP_ALT_CALLEESAVE(rettype, op, alt, cond) 471 #define PVOP_ALT_VCALLEE0(op, alt, cond) \ 472 __PVOP_ALT_VCALLEESAVE(op, alt, cond) 473 474 475 #define PVOP_CALL1(rettype, op, arg1) \ 476 __PVOP_CALL(rettype, op, PVOP_CALL_ARG1(arg1)) 477 #define PVOP_VCALL1(op, arg1) \ 478 __PVOP_VCALL(op, PVOP_CALL_ARG1(arg1)) 479 #define PVOP_ALT_VCALL1(op, arg1, alt, cond) \ 480 __PVOP_ALT_VCALL(op, alt, cond, PVOP_CALL_ARG1(arg1)) 481 482 #define PVOP_CALLEE1(rettype, op, arg1) \ 483 __PVOP_CALLEESAVE(rettype, op, PVOP_CALL_ARG1(arg1)) 484 #define PVOP_VCALLEE1(op, arg1) \ 485 __PVOP_VCALLEESAVE(op, PVOP_CALL_ARG1(arg1)) 486 #define PVOP_ALT_CALLEE1(rettype, op, arg1, alt, cond) \ 487 __PVOP_ALT_CALLEESAVE(rettype, op, alt, cond, PVOP_CALL_ARG1(arg1)) 488 #define PVOP_ALT_VCALLEE1(op, arg1, alt, cond) \ 489 __PVOP_ALT_VCALLEESAVE(op, alt, cond, PVOP_CALL_ARG1(arg1)) 490 491 492 #define PVOP_CALL2(rettype, op, arg1, arg2) \ 493 __PVOP_CALL(rettype, op, PVOP_CALL_ARG1(arg1), PVOP_CALL_ARG2(arg2)) 494 #define PVOP_VCALL2(op, arg1, arg2) \ 495 __PVOP_VCALL(op, PVOP_CALL_ARG1(arg1), PVOP_CALL_ARG2(arg2)) 496 497 #define PVOP_CALL3(rettype, op, arg1, arg2, arg3) \ 498 __PVOP_CALL(rettype, op, PVOP_CALL_ARG1(arg1), \ 499 PVOP_CALL_ARG2(arg2), PVOP_CALL_ARG3(arg3)) 500 #define PVOP_VCALL3(op, arg1, arg2, arg3) \ 501 __PVOP_VCALL(op, PVOP_CALL_ARG1(arg1), \ 502 PVOP_CALL_ARG2(arg2), PVOP_CALL_ARG3(arg3)) 503 504 #define PVOP_CALL4(rettype, op, arg1, arg2, arg3, arg4) \ 505 __PVOP_CALL(rettype, op, \ 506 PVOP_CALL_ARG1(arg1), PVOP_CALL_ARG2(arg2), \ 507 PVOP_CALL_ARG3(arg3), PVOP_CALL_ARG4(arg4)) 508 #define PVOP_VCALL4(op, arg1, arg2, arg3, arg4) \ 509 __PVOP_VCALL(op, PVOP_CALL_ARG1(arg1), PVOP_CALL_ARG2(arg2), \ 510 PVOP_CALL_ARG3(arg3), PVOP_CALL_ARG4(arg4)) 511 512 unsigned long paravirt_ret0(void); 513 #ifdef CONFIG_PARAVIRT_XXL 514 u64 _paravirt_ident_64(u64); 515 unsigned long pv_native_save_fl(void); 516 void pv_native_irq_disable(void); 517 void pv_native_irq_enable(void); 518 unsigned long pv_native_read_cr2(void); 519 #endif 520 521 #define paravirt_nop ((void *)nop_func) 522 523 #endif /* __ASSEMBLY__ */ 524 525 #define ALT_NOT_XEN ALT_NOT(X86_FEATURE_XENPV) 526 527 #endif /* CONFIG_PARAVIRT */ 528 #endif /* _ASM_X86_PARAVIRT_TYPES_H */ 529