2 * Copyright (C) 2012,2013 - ARM Ltd
3 * Author: Marc Zyngier <marc.zyngier@arm.com>
5 * Derived from arch/arm/include/asm/kvm_host.h:
6 * Copyright (C) 2012 - Virtual Open Systems and Columbia University
7 * Author: Christoffer Dall <c.dall@virtualopensystems.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #ifndef __ARM64_KVM_HOST_H__
23 #define __ARM64_KVM_HOST_H__
25 #include <linux/types.h>
26 #include <linux/kvm_types.h>
27 #include <asm/cpufeature.h>
29 #include <asm/kvm_asm.h>
30 #include <asm/kvm_mmio.h>
32 #define __KVM_HAVE_ARCH_INTC_INITIALIZED
34 #define KVM_USER_MEM_SLOTS 512
35 #define KVM_HALT_POLL_NS_DEFAULT 500000
37 #include <kvm/arm_vgic.h>
38 #include <kvm/arm_arch_timer.h>
39 #include <kvm/arm_pmu.h>
41 #define KVM_MAX_VCPUS VGIC_V3_MAX_CPUS
43 #define KVM_VCPU_MAX_FEATURES 4
45 #define KVM_REQ_SLEEP \
46 KVM_ARCH_REQ_FLAGS(0, KVM_REQUEST_WAIT | KVM_REQUEST_NO_WAKEUP)
47 #define KVM_REQ_IRQ_PENDING KVM_ARCH_REQ(1)
49 int __attribute_const__ kvm_target_cpu(void);
50 int kvm_reset_vcpu(struct kvm_vcpu *vcpu);
51 int kvm_arch_dev_ioctl_check_extension(struct kvm *kvm, long ext);
52 void __extended_idmap_trampoline(phys_addr_t boot_pgd, phys_addr_t idmap_start);
55 /* The VMID generation used for the virt. memory system */
59 /* 1-level 2nd stage table and lock */
63 /* VTTBR value associated with above pgd and vmid */
66 /* The last vcpu id that ran on each physical CPU */
67 int __percpu *last_vcpu_ran;
69 /* The maximum number of vCPUs depends on the used GIC model */
72 /* Interrupt controller */
73 struct vgic_dist vgic;
75 /* Mandated version of PSCI */
79 #define KVM_NR_MEM_OBJS 40
82 * We don't want allocation failures within the mmu code, so we preallocate
83 * enough memory for a single page fault in a cache.
85 struct kvm_mmu_memory_cache {
87 void *objects[KVM_NR_MEM_OBJS];
90 struct kvm_vcpu_fault_info {
91 u32 esr_el2; /* Hyp Syndrom Register */
92 u64 far_el2; /* Hyp Fault Address Register */
93 u64 hpfar_el2; /* Hyp IPA Fault Address Register */
97 * 0 is reserved as an invalid value.
98 * Order should be kept in sync with the save/restore code.
102 MPIDR_EL1, /* MultiProcessor Affinity Register */
103 CSSELR_EL1, /* Cache Size Selection Register */
104 SCTLR_EL1, /* System Control Register */
105 ACTLR_EL1, /* Auxiliary Control Register */
106 CPACR_EL1, /* Coprocessor Access Control */
107 TTBR0_EL1, /* Translation Table Base Register 0 */
108 TTBR1_EL1, /* Translation Table Base Register 1 */
109 TCR_EL1, /* Translation Control Register */
110 ESR_EL1, /* Exception Syndrome Register */
111 AFSR0_EL1, /* Auxiliary Fault Status Register 0 */
112 AFSR1_EL1, /* Auxiliary Fault Status Register 1 */
113 FAR_EL1, /* Fault Address Register */
114 MAIR_EL1, /* Memory Attribute Indirection Register */
115 VBAR_EL1, /* Vector Base Address Register */
116 CONTEXTIDR_EL1, /* Context ID Register */
117 TPIDR_EL0, /* Thread ID, User R/W */
118 TPIDRRO_EL0, /* Thread ID, User R/O */
119 TPIDR_EL1, /* Thread ID, Privileged */
120 AMAIR_EL1, /* Aux Memory Attribute Indirection Register */
121 CNTKCTL_EL1, /* Timer Control Register (EL1) */
122 PAR_EL1, /* Physical Address Register */
123 MDSCR_EL1, /* Monitor Debug System Control Register */
124 MDCCINT_EL1, /* Monitor Debug Comms Channel Interrupt Enable Reg */
126 /* Performance Monitors Registers */
127 PMCR_EL0, /* Control Register */
128 PMSELR_EL0, /* Event Counter Selection Register */
129 PMEVCNTR0_EL0, /* Event Counter Register (0-30) */
130 PMEVCNTR30_EL0 = PMEVCNTR0_EL0 + 30,
131 PMCCNTR_EL0, /* Cycle Counter Register */
132 PMEVTYPER0_EL0, /* Event Type Register (0-30) */
133 PMEVTYPER30_EL0 = PMEVTYPER0_EL0 + 30,
134 PMCCFILTR_EL0, /* Cycle Count Filter Register */
135 PMCNTENSET_EL0, /* Count Enable Set Register */
136 PMINTENSET_EL1, /* Interrupt Enable Set Register */
137 PMOVSSET_EL0, /* Overflow Flag Status Set Register */
138 PMSWINC_EL0, /* Software Increment Register */
139 PMUSERENR_EL0, /* User Enable Register */
141 /* 32bit specific registers. Keep them at the end of the range */
142 DACR32_EL2, /* Domain Access Control Register */
143 IFSR32_EL2, /* Instruction Fault Status Register */
144 FPEXC32_EL2, /* Floating-Point Exception Control Register */
145 DBGVCR32_EL2, /* Debug Vector Catch Register */
147 NR_SYS_REGS /* Nothing after this line! */
151 #define c0_MPIDR (MPIDR_EL1 * 2) /* MultiProcessor ID Register */
152 #define c0_CSSELR (CSSELR_EL1 * 2)/* Cache Size Selection Register */
153 #define c1_SCTLR (SCTLR_EL1 * 2) /* System Control Register */
154 #define c1_ACTLR (ACTLR_EL1 * 2) /* Auxiliary Control Register */
155 #define c1_CPACR (CPACR_EL1 * 2) /* Coprocessor Access Control */
156 #define c2_TTBR0 (TTBR0_EL1 * 2) /* Translation Table Base Register 0 */
157 #define c2_TTBR0_high (c2_TTBR0 + 1) /* TTBR0 top 32 bits */
158 #define c2_TTBR1 (TTBR1_EL1 * 2) /* Translation Table Base Register 1 */
159 #define c2_TTBR1_high (c2_TTBR1 + 1) /* TTBR1 top 32 bits */
160 #define c2_TTBCR (TCR_EL1 * 2) /* Translation Table Base Control R. */
161 #define c2_TTBCR2 (c2_TTBCR + 1) /* Translation Table Base Control R. 2 */
162 #define c3_DACR (DACR32_EL2 * 2)/* Domain Access Control Register */
163 #define c5_DFSR (ESR_EL1 * 2) /* Data Fault Status Register */
164 #define c5_IFSR (IFSR32_EL2 * 2)/* Instruction Fault Status Register */
165 #define c5_ADFSR (AFSR0_EL1 * 2) /* Auxiliary Data Fault Status R */
166 #define c5_AIFSR (AFSR1_EL1 * 2) /* Auxiliary Instr Fault Status R */
167 #define c6_DFAR (FAR_EL1 * 2) /* Data Fault Address Register */
168 #define c6_IFAR (c6_DFAR + 1) /* Instruction Fault Address Register */
169 #define c7_PAR (PAR_EL1 * 2) /* Physical Address Register */
170 #define c7_PAR_high (c7_PAR + 1) /* PAR top 32 bits */
171 #define c10_PRRR (MAIR_EL1 * 2) /* Primary Region Remap Register */
172 #define c10_NMRR (c10_PRRR + 1) /* Normal Memory Remap Register */
173 #define c12_VBAR (VBAR_EL1 * 2) /* Vector Base Address Register */
174 #define c13_CID (CONTEXTIDR_EL1 * 2) /* Context ID Register */
175 #define c13_TID_URW (TPIDR_EL0 * 2) /* Thread ID, User R/W */
176 #define c13_TID_URO (TPIDRRO_EL0 * 2)/* Thread ID, User R/O */
177 #define c13_TID_PRIV (TPIDR_EL1 * 2) /* Thread ID, Privileged */
178 #define c10_AMAIR0 (AMAIR_EL1 * 2) /* Aux Memory Attr Indirection Reg */
179 #define c10_AMAIR1 (c10_AMAIR0 + 1)/* Aux Memory Attr Indirection Reg */
180 #define c14_CNTKCTL (CNTKCTL_EL1 * 2) /* Timer Control Register (PL1) */
182 #define cp14_DBGDSCRext (MDSCR_EL1 * 2)
183 #define cp14_DBGBCR0 (DBGBCR0_EL1 * 2)
184 #define cp14_DBGBVR0 (DBGBVR0_EL1 * 2)
185 #define cp14_DBGBXVR0 (cp14_DBGBVR0 + 1)
186 #define cp14_DBGWCR0 (DBGWCR0_EL1 * 2)
187 #define cp14_DBGWVR0 (DBGWVR0_EL1 * 2)
188 #define cp14_DBGDCCINT (MDCCINT_EL1 * 2)
189 #define cp14_DBGVCR (DBGVCR32_EL2 * 2)
191 #define NR_COPRO_REGS (NR_SYS_REGS * 2)
193 struct kvm_cpu_context {
194 struct kvm_regs gp_regs;
196 u64 sys_regs[NR_SYS_REGS];
197 u32 copro[NR_COPRO_REGS];
200 struct kvm_vcpu *__hyp_running_vcpu;
203 typedef struct kvm_cpu_context kvm_cpu_context_t;
205 struct kvm_vcpu_arch {
206 struct kvm_cpu_context ctxt;
208 /* HYP configuration */
212 /* Exception Information */
213 struct kvm_vcpu_fault_info fault;
215 /* State of various workarounds, see kvm_asm.h for bit assignment */
216 u64 workaround_flags;
218 /* Guest debug state */
222 * We maintain more than a single set of debug registers to support
223 * debugging the guest from the host and to maintain separate host and
224 * guest state during world switches. vcpu_debug_state are the debug
225 * registers of the vcpu as the guest sees them. host_debug_state are
226 * the host registers which are saved and restored during
227 * world switches. external_debug_state contains the debug
228 * values we want to debug the guest. This is set via the
229 * KVM_SET_GUEST_DEBUG ioctl.
231 * debug_ptr points to the set of debug registers that should be loaded
232 * onto the hardware when running the guest.
234 struct kvm_guest_debug_arch *debug_ptr;
235 struct kvm_guest_debug_arch vcpu_debug_state;
236 struct kvm_guest_debug_arch external_debug_state;
238 /* Pointer to host CPU context */
239 kvm_cpu_context_t *host_cpu_context;
241 /* {Break,watch}point registers */
242 struct kvm_guest_debug_arch regs;
243 /* Statistical profiling extension */
248 struct vgic_cpu vgic_cpu;
249 struct arch_timer_cpu timer_cpu;
253 * Anything that is not used directly from assembly code goes
258 * Guest registers we preserve during guest debugging.
260 * These shadow registers are updated by the kvm_handle_sys_reg
261 * trap handler if the guest accesses or updates them while we
262 * are using guest debug.
266 } guest_debug_preserved;
268 /* vcpu power-off state */
271 /* Don't run the guest (internal implementation need) */
274 /* IO related fields */
275 struct kvm_decode mmio_decode;
277 /* Interrupt related fields */
278 u64 irq_lines; /* IRQ and FIQ levels */
280 /* Cache some mmu pages needed inside spinlock regions */
281 struct kvm_mmu_memory_cache mmu_page_cache;
283 /* Target CPU and feature flags */
285 DECLARE_BITMAP(features, KVM_VCPU_MAX_FEATURES);
287 /* Detect first run of a vcpu */
291 #define vcpu_gp_regs(v) (&(v)->arch.ctxt.gp_regs)
292 #define vcpu_sys_reg(v,r) ((v)->arch.ctxt.sys_regs[(r)])
294 * CP14 and CP15 live in the same array, as they are backed by the
295 * same system registers.
297 #define CPx_BIAS IS_ENABLED(CONFIG_CPU_BIG_ENDIAN)
299 #define vcpu_cp14(v,r) ((v)->arch.ctxt.copro[(r) ^ CPx_BIAS])
300 #define vcpu_cp15(v,r) ((v)->arch.ctxt.copro[(r) ^ CPx_BIAS])
302 #ifdef CONFIG_CPU_BIG_ENDIAN
303 #define vcpu_cp15_64_high(v,r) vcpu_cp15((v),(r))
304 #define vcpu_cp15_64_low(v,r) vcpu_cp15((v),(r) + 1)
306 #define vcpu_cp15_64_high(v,r) vcpu_cp15((v),(r) + 1)
307 #define vcpu_cp15_64_low(v,r) vcpu_cp15((v),(r))
311 ulong remote_tlb_flush;
314 struct kvm_vcpu_stat {
315 u64 halt_successful_poll;
316 u64 halt_attempted_poll;
317 u64 halt_poll_invalid;
323 u64 mmio_exit_kernel;
327 int kvm_vcpu_preferred_target(struct kvm_vcpu_init *init);
328 unsigned long kvm_arm_num_regs(struct kvm_vcpu *vcpu);
329 int kvm_arm_copy_reg_indices(struct kvm_vcpu *vcpu, u64 __user *indices);
330 int kvm_arm_get_reg(struct kvm_vcpu *vcpu, const struct kvm_one_reg *reg);
331 int kvm_arm_set_reg(struct kvm_vcpu *vcpu, const struct kvm_one_reg *reg);
333 #define KVM_ARCH_WANT_MMU_NOTIFIER
334 int kvm_unmap_hva(struct kvm *kvm, unsigned long hva);
335 int kvm_unmap_hva_range(struct kvm *kvm,
336 unsigned long start, unsigned long end);
337 void kvm_set_spte_hva(struct kvm *kvm, unsigned long hva, pte_t pte);
338 int kvm_age_hva(struct kvm *kvm, unsigned long start, unsigned long end);
339 int kvm_test_age_hva(struct kvm *kvm, unsigned long hva);
341 struct kvm_vcpu *kvm_arm_get_running_vcpu(void);
342 struct kvm_vcpu * __percpu *kvm_get_running_vcpus(void);
343 void kvm_arm_halt_guest(struct kvm *kvm);
344 void kvm_arm_resume_guest(struct kvm *kvm);
346 u64 __kvm_call_hyp(void *hypfn, ...);
347 #define kvm_call_hyp(f, ...) __kvm_call_hyp(kvm_ksym_ref(f), ##__VA_ARGS__)
349 void force_vm_exit(const cpumask_t *mask);
350 void kvm_mmu_wp_memory_region(struct kvm *kvm, int slot);
352 int handle_exit(struct kvm_vcpu *vcpu, struct kvm_run *run,
353 int exception_index);
355 int kvm_perf_init(void);
356 int kvm_perf_teardown(void);
358 struct kvm_vcpu *kvm_mpidr_to_vcpu(struct kvm *kvm, unsigned long mpidr);
360 void __kvm_set_tpidr_el2(u64 tpidr_el2);
361 DECLARE_PER_CPU(kvm_cpu_context_t, kvm_host_cpu_state);
363 void __kvm_enable_ssbs(void);
365 static inline void __cpu_init_hyp_mode(phys_addr_t pgd_ptr,
366 unsigned long hyp_stack_ptr,
367 unsigned long vector_ptr)
372 * Call initialization code, and switch to the full blown HYP code.
373 * If the cpucaps haven't been finalized yet, something has gone very
374 * wrong, and hyp will crash and burn when it uses any
375 * cpus_have_const_cap() wrapper.
377 BUG_ON(!static_branch_likely(&arm64_const_caps_ready));
378 __kvm_call_hyp((void *)pgd_ptr, hyp_stack_ptr, vector_ptr);
381 * Calculate the raw per-cpu offset without a translation from the
382 * kernel's mapping to the linear mapping, and store it in tpidr_el2
383 * so that we can use adr_l to access per-cpu variables in EL2.
385 tpidr_el2 = (u64)this_cpu_ptr(&kvm_host_cpu_state)
386 - (u64)kvm_ksym_ref(kvm_host_cpu_state);
388 kvm_call_hyp(__kvm_set_tpidr_el2, tpidr_el2);
391 * Disabling SSBD on a non-VHE system requires us to enable SSBS
394 if (!has_vhe() && this_cpu_has_cap(ARM64_SSBS) &&
395 arm64_get_ssbd_state() == ARM64_SSBD_FORCE_DISABLE) {
396 kvm_call_hyp(__kvm_enable_ssbs);
400 static inline void kvm_arch_hardware_unsetup(void) {}
401 static inline void kvm_arch_sync_events(struct kvm *kvm) {}
402 static inline void kvm_arch_vcpu_uninit(struct kvm_vcpu *vcpu) {}
403 static inline void kvm_arch_sched_in(struct kvm_vcpu *vcpu, int cpu) {}
404 static inline void kvm_arch_vcpu_block_finish(struct kvm_vcpu *vcpu) {}
406 void kvm_arm_init_debug(void);
407 void kvm_arm_setup_debug(struct kvm_vcpu *vcpu);
408 void kvm_arm_clear_debug(struct kvm_vcpu *vcpu);
409 void kvm_arm_reset_debug_ptr(struct kvm_vcpu *vcpu);
410 int kvm_arm_vcpu_arch_set_attr(struct kvm_vcpu *vcpu,
411 struct kvm_device_attr *attr);
412 int kvm_arm_vcpu_arch_get_attr(struct kvm_vcpu *vcpu,
413 struct kvm_device_attr *attr);
414 int kvm_arm_vcpu_arch_has_attr(struct kvm_vcpu *vcpu,
415 struct kvm_device_attr *attr);
417 static inline void __cpu_init_stage2(void)
419 u32 parange = kvm_call_hyp(__init_stage2_translation);
421 WARN_ONCE(parange < 40,
422 "PARange is %d bits, unsupported configuration!", parange);
425 static inline bool kvm_arm_harden_branch_predictor(void)
427 return cpus_have_const_cap(ARM64_HARDEN_BRANCH_PREDICTOR);
430 #define KVM_SSBD_UNKNOWN -1
431 #define KVM_SSBD_FORCE_DISABLE 0
432 #define KVM_SSBD_KERNEL 1
433 #define KVM_SSBD_FORCE_ENABLE 2
434 #define KVM_SSBD_MITIGATED 3
436 static inline int kvm_arm_have_ssbd(void)
438 switch (arm64_get_ssbd_state()) {
439 case ARM64_SSBD_FORCE_DISABLE:
440 return KVM_SSBD_FORCE_DISABLE;
441 case ARM64_SSBD_KERNEL:
442 return KVM_SSBD_KERNEL;
443 case ARM64_SSBD_FORCE_ENABLE:
444 return KVM_SSBD_FORCE_ENABLE;
445 case ARM64_SSBD_MITIGATED:
446 return KVM_SSBD_MITIGATED;
447 case ARM64_SSBD_UNKNOWN:
449 return KVM_SSBD_UNKNOWN;
453 #endif /* __ARM64_KVM_HOST_H__ */