1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2021 Google LLC
4 * Author: Fuad Tabba <tabba@google.com>
7 #include <linux/irqchip/arm-gic-v3.h>
9 #include <asm/kvm_asm.h>
10 #include <asm/kvm_mmu.h>
12 #include <hyp/adjust_pc.h>
14 #include <nvhe/fixed_config.h>
16 #include "../../sys_regs.h"
19 * Copies of the host's CPU features registers holding sanitized values at hyp.
21 u64 id_aa64pfr0_el1_sys_val;
22 u64 id_aa64pfr1_el1_sys_val;
23 u64 id_aa64isar0_el1_sys_val;
24 u64 id_aa64isar1_el1_sys_val;
25 u64 id_aa64isar2_el1_sys_val;
26 u64 id_aa64mmfr0_el1_sys_val;
27 u64 id_aa64mmfr1_el1_sys_val;
28 u64 id_aa64mmfr2_el1_sys_val;
31 * Inject an unknown/undefined exception to an AArch64 guest while most of its
34 static void inject_undef64(struct kvm_vcpu *vcpu)
36 u64 esr = (ESR_ELx_EC_UNKNOWN << ESR_ELx_EC_SHIFT);
38 *vcpu_pc(vcpu) = read_sysreg_el2(SYS_ELR);
39 *vcpu_cpsr(vcpu) = read_sysreg_el2(SYS_SPSR);
41 kvm_pend_exception(vcpu, EXCEPT_AA64_EL1_SYNC);
43 __kvm_adjust_pc(vcpu);
45 write_sysreg_el1(esr, SYS_ESR);
46 write_sysreg_el1(read_sysreg_el2(SYS_ELR), SYS_ELR);
47 write_sysreg_el2(*vcpu_pc(vcpu), SYS_ELR);
48 write_sysreg_el2(*vcpu_cpsr(vcpu), SYS_SPSR);
52 * Returns the restricted features values of the feature register based on the
53 * limitations in restrict_fields.
54 * A feature id field value of 0b0000 does not impose any restrictions.
55 * Note: Use only for unsigned feature field values.
57 static u64 get_restricted_features_unsigned(u64 sys_reg_val,
61 u64 mask = GENMASK_ULL(ARM64_FEATURE_FIELD_BITS - 1, 0);
64 * According to the Arm Architecture Reference Manual, feature fields
65 * use increasing values to indicate increases in functionality.
66 * Iterate over the restricted feature fields and calculate the minimum
67 * unsigned value between the one supported by the system, and what the
68 * value is being restricted to.
70 while (sys_reg_val && restrict_fields) {
71 value |= min(sys_reg_val & mask, restrict_fields & mask);
73 restrict_fields &= ~mask;
74 mask <<= ARM64_FEATURE_FIELD_BITS;
81 * Functions that return the value of feature id registers for protected VMs
82 * based on allowed features, system features, and KVM support.
85 static u64 get_pvm_id_aa64pfr0(const struct kvm_vcpu *vcpu)
87 const struct kvm *kvm = (const struct kvm *)kern_hyp_va(vcpu->kvm);
89 u64 allow_mask = PVM_ID_AA64PFR0_ALLOW;
91 set_mask |= get_restricted_features_unsigned(id_aa64pfr0_el1_sys_val,
92 PVM_ID_AA64PFR0_RESTRICT_UNSIGNED);
94 /* Spectre and Meltdown mitigation in KVM */
95 set_mask |= FIELD_PREP(ARM64_FEATURE_MASK(ID_AA64PFR0_EL1_CSV2),
96 (u64)kvm->arch.pfr0_csv2);
97 set_mask |= FIELD_PREP(ARM64_FEATURE_MASK(ID_AA64PFR0_EL1_CSV3),
98 (u64)kvm->arch.pfr0_csv3);
100 return (id_aa64pfr0_el1_sys_val & allow_mask) | set_mask;
103 static u64 get_pvm_id_aa64pfr1(const struct kvm_vcpu *vcpu)
105 const struct kvm *kvm = (const struct kvm *)kern_hyp_va(vcpu->kvm);
106 u64 allow_mask = PVM_ID_AA64PFR1_ALLOW;
108 if (!kvm_has_mte(kvm))
109 allow_mask &= ~ARM64_FEATURE_MASK(ID_AA64PFR1_EL1_MTE);
111 return id_aa64pfr1_el1_sys_val & allow_mask;
114 static u64 get_pvm_id_aa64zfr0(const struct kvm_vcpu *vcpu)
117 * No support for Scalable Vectors, therefore, hyp has no sanitized
118 * copy of the feature id register.
120 BUILD_BUG_ON(PVM_ID_AA64ZFR0_ALLOW != 0ULL);
124 static u64 get_pvm_id_aa64dfr0(const struct kvm_vcpu *vcpu)
127 * No support for debug, including breakpoints, and watchpoints,
128 * therefore, pKVM has no sanitized copy of the feature id register.
130 BUILD_BUG_ON(PVM_ID_AA64DFR0_ALLOW != 0ULL);
134 static u64 get_pvm_id_aa64dfr1(const struct kvm_vcpu *vcpu)
137 * No support for debug, therefore, hyp has no sanitized copy of the
138 * feature id register.
140 BUILD_BUG_ON(PVM_ID_AA64DFR1_ALLOW != 0ULL);
144 static u64 get_pvm_id_aa64afr0(const struct kvm_vcpu *vcpu)
147 * No support for implementation defined features, therefore, hyp has no
148 * sanitized copy of the feature id register.
150 BUILD_BUG_ON(PVM_ID_AA64AFR0_ALLOW != 0ULL);
154 static u64 get_pvm_id_aa64afr1(const struct kvm_vcpu *vcpu)
157 * No support for implementation defined features, therefore, hyp has no
158 * sanitized copy of the feature id register.
160 BUILD_BUG_ON(PVM_ID_AA64AFR1_ALLOW != 0ULL);
164 static u64 get_pvm_id_aa64isar0(const struct kvm_vcpu *vcpu)
166 return id_aa64isar0_el1_sys_val & PVM_ID_AA64ISAR0_ALLOW;
169 static u64 get_pvm_id_aa64isar1(const struct kvm_vcpu *vcpu)
171 u64 allow_mask = PVM_ID_AA64ISAR1_ALLOW;
173 if (!vcpu_has_ptrauth(vcpu))
174 allow_mask &= ~(ARM64_FEATURE_MASK(ID_AA64ISAR1_EL1_APA) |
175 ARM64_FEATURE_MASK(ID_AA64ISAR1_EL1_API) |
176 ARM64_FEATURE_MASK(ID_AA64ISAR1_EL1_GPA) |
177 ARM64_FEATURE_MASK(ID_AA64ISAR1_EL1_GPI));
179 return id_aa64isar1_el1_sys_val & allow_mask;
182 static u64 get_pvm_id_aa64isar2(const struct kvm_vcpu *vcpu)
184 u64 allow_mask = PVM_ID_AA64ISAR2_ALLOW;
186 if (!vcpu_has_ptrauth(vcpu))
187 allow_mask &= ~(ARM64_FEATURE_MASK(ID_AA64ISAR2_EL1_APA3) |
188 ARM64_FEATURE_MASK(ID_AA64ISAR2_EL1_GPA3));
190 return id_aa64isar2_el1_sys_val & allow_mask;
193 static u64 get_pvm_id_aa64mmfr0(const struct kvm_vcpu *vcpu)
197 set_mask = get_restricted_features_unsigned(id_aa64mmfr0_el1_sys_val,
198 PVM_ID_AA64MMFR0_RESTRICT_UNSIGNED);
200 return (id_aa64mmfr0_el1_sys_val & PVM_ID_AA64MMFR0_ALLOW) | set_mask;
203 static u64 get_pvm_id_aa64mmfr1(const struct kvm_vcpu *vcpu)
205 return id_aa64mmfr1_el1_sys_val & PVM_ID_AA64MMFR1_ALLOW;
208 static u64 get_pvm_id_aa64mmfr2(const struct kvm_vcpu *vcpu)
210 return id_aa64mmfr2_el1_sys_val & PVM_ID_AA64MMFR2_ALLOW;
213 /* Read a sanitized cpufeature ID register by its encoding */
214 u64 pvm_read_id_reg(const struct kvm_vcpu *vcpu, u32 id)
217 case SYS_ID_AA64PFR0_EL1:
218 return get_pvm_id_aa64pfr0(vcpu);
219 case SYS_ID_AA64PFR1_EL1:
220 return get_pvm_id_aa64pfr1(vcpu);
221 case SYS_ID_AA64ZFR0_EL1:
222 return get_pvm_id_aa64zfr0(vcpu);
223 case SYS_ID_AA64DFR0_EL1:
224 return get_pvm_id_aa64dfr0(vcpu);
225 case SYS_ID_AA64DFR1_EL1:
226 return get_pvm_id_aa64dfr1(vcpu);
227 case SYS_ID_AA64AFR0_EL1:
228 return get_pvm_id_aa64afr0(vcpu);
229 case SYS_ID_AA64AFR1_EL1:
230 return get_pvm_id_aa64afr1(vcpu);
231 case SYS_ID_AA64ISAR0_EL1:
232 return get_pvm_id_aa64isar0(vcpu);
233 case SYS_ID_AA64ISAR1_EL1:
234 return get_pvm_id_aa64isar1(vcpu);
235 case SYS_ID_AA64ISAR2_EL1:
236 return get_pvm_id_aa64isar2(vcpu);
237 case SYS_ID_AA64MMFR0_EL1:
238 return get_pvm_id_aa64mmfr0(vcpu);
239 case SYS_ID_AA64MMFR1_EL1:
240 return get_pvm_id_aa64mmfr1(vcpu);
241 case SYS_ID_AA64MMFR2_EL1:
242 return get_pvm_id_aa64mmfr2(vcpu);
244 /* Unhandled ID register, RAZ */
249 static u64 read_id_reg(const struct kvm_vcpu *vcpu,
250 struct sys_reg_desc const *r)
252 return pvm_read_id_reg(vcpu, reg_to_encoding(r));
255 /* Handler to RAZ/WI sysregs */
256 static bool pvm_access_raz_wi(struct kvm_vcpu *vcpu, struct sys_reg_params *p,
257 const struct sys_reg_desc *r)
266 * Accessor for AArch32 feature id registers.
268 * The value of these registers is "unknown" according to the spec if AArch32
271 static bool pvm_access_id_aarch32(struct kvm_vcpu *vcpu,
272 struct sys_reg_params *p,
273 const struct sys_reg_desc *r)
276 inject_undef64(vcpu);
281 * No support for AArch32 guests, therefore, pKVM has no sanitized copy
282 * of AArch32 feature id registers.
284 BUILD_BUG_ON(FIELD_GET(ARM64_FEATURE_MASK(ID_AA64PFR0_EL1_EL1),
285 PVM_ID_AA64PFR0_RESTRICT_UNSIGNED) > ID_AA64PFR0_EL1_ELx_64BIT_ONLY);
287 return pvm_access_raz_wi(vcpu, p, r);
291 * Accessor for AArch64 feature id registers.
293 * If access is allowed, set the regval to the protected VM's view of the
294 * register and return true.
295 * Otherwise, inject an undefined exception and return false.
297 static bool pvm_access_id_aarch64(struct kvm_vcpu *vcpu,
298 struct sys_reg_params *p,
299 const struct sys_reg_desc *r)
302 inject_undef64(vcpu);
306 p->regval = read_id_reg(vcpu, r);
310 static bool pvm_gic_read_sre(struct kvm_vcpu *vcpu,
311 struct sys_reg_params *p,
312 const struct sys_reg_desc *r)
314 /* pVMs only support GICv3. 'nuf said. */
316 p->regval = ICC_SRE_EL1_DIB | ICC_SRE_EL1_DFB | ICC_SRE_EL1_SRE;
321 /* Mark the specified system register as an AArch32 feature id register. */
322 #define AARCH32(REG) { SYS_DESC(REG), .access = pvm_access_id_aarch32 }
324 /* Mark the specified system register as an AArch64 feature id register. */
325 #define AARCH64(REG) { SYS_DESC(REG), .access = pvm_access_id_aarch64 }
328 * sys_reg_desc initialiser for architecturally unallocated cpufeature ID
329 * register with encoding Op0=3, Op1=0, CRn=0, CRm=crm, Op2=op2
330 * (1 <= crm < 8, 0 <= Op2 < 8).
332 #define ID_UNALLOCATED(crm, op2) { \
333 Op0(3), Op1(0), CRn(0), CRm(crm), Op2(op2), \
334 .access = pvm_access_id_aarch64, \
337 /* Mark the specified system register as Read-As-Zero/Write-Ignored */
338 #define RAZ_WI(REG) { SYS_DESC(REG), .access = pvm_access_raz_wi }
340 /* Mark the specified system register as not being handled in hyp. */
341 #define HOST_HANDLED(REG) { SYS_DESC(REG), .access = NULL }
344 * Architected system registers.
345 * Important: Must be sorted ascending by Op0, Op1, CRn, CRm, Op2
347 * NOTE: Anything not explicitly listed here is *restricted by default*, i.e.,
348 * it will lead to injecting an exception into the guest.
350 static const struct sys_reg_desc pvm_sys_reg_descs[] = {
351 /* Cache maintenance by set/way operations are restricted. */
353 /* Debug and Trace Registers are restricted. */
355 /* AArch64 mappings of the AArch32 ID registers */
357 AARCH32(SYS_ID_PFR0_EL1),
358 AARCH32(SYS_ID_PFR1_EL1),
359 AARCH32(SYS_ID_DFR0_EL1),
360 AARCH32(SYS_ID_AFR0_EL1),
361 AARCH32(SYS_ID_MMFR0_EL1),
362 AARCH32(SYS_ID_MMFR1_EL1),
363 AARCH32(SYS_ID_MMFR2_EL1),
364 AARCH32(SYS_ID_MMFR3_EL1),
367 AARCH32(SYS_ID_ISAR0_EL1),
368 AARCH32(SYS_ID_ISAR1_EL1),
369 AARCH32(SYS_ID_ISAR2_EL1),
370 AARCH32(SYS_ID_ISAR3_EL1),
371 AARCH32(SYS_ID_ISAR4_EL1),
372 AARCH32(SYS_ID_ISAR5_EL1),
373 AARCH32(SYS_ID_MMFR4_EL1),
374 AARCH32(SYS_ID_ISAR6_EL1),
377 AARCH32(SYS_MVFR0_EL1),
378 AARCH32(SYS_MVFR1_EL1),
379 AARCH32(SYS_MVFR2_EL1),
381 AARCH32(SYS_ID_PFR2_EL1),
382 AARCH32(SYS_ID_DFR1_EL1),
383 AARCH32(SYS_ID_MMFR5_EL1),
386 /* AArch64 ID registers */
388 AARCH64(SYS_ID_AA64PFR0_EL1),
389 AARCH64(SYS_ID_AA64PFR1_EL1),
392 AARCH64(SYS_ID_AA64ZFR0_EL1),
396 AARCH64(SYS_ID_AA64DFR0_EL1),
397 AARCH64(SYS_ID_AA64DFR1_EL1),
400 AARCH64(SYS_ID_AA64AFR0_EL1),
401 AARCH64(SYS_ID_AA64AFR1_EL1),
404 AARCH64(SYS_ID_AA64ISAR0_EL1),
405 AARCH64(SYS_ID_AA64ISAR1_EL1),
406 AARCH64(SYS_ID_AA64ISAR2_EL1),
412 AARCH64(SYS_ID_AA64MMFR0_EL1),
413 AARCH64(SYS_ID_AA64MMFR1_EL1),
414 AARCH64(SYS_ID_AA64MMFR2_EL1),
421 /* Scalable Vector Registers are restricted. */
423 RAZ_WI(SYS_ERRIDR_EL1),
424 RAZ_WI(SYS_ERRSELR_EL1),
425 RAZ_WI(SYS_ERXFR_EL1),
426 RAZ_WI(SYS_ERXCTLR_EL1),
427 RAZ_WI(SYS_ERXSTATUS_EL1),
428 RAZ_WI(SYS_ERXADDR_EL1),
429 RAZ_WI(SYS_ERXMISC0_EL1),
430 RAZ_WI(SYS_ERXMISC1_EL1),
432 /* Performance Monitoring Registers are restricted. */
434 /* Limited Ordering Regions Registers are restricted. */
436 HOST_HANDLED(SYS_ICC_SGI1R_EL1),
437 HOST_HANDLED(SYS_ICC_ASGI1R_EL1),
438 HOST_HANDLED(SYS_ICC_SGI0R_EL1),
439 { SYS_DESC(SYS_ICC_SRE_EL1), .access = pvm_gic_read_sre, },
441 HOST_HANDLED(SYS_CCSIDR_EL1),
442 HOST_HANDLED(SYS_CLIDR_EL1),
443 HOST_HANDLED(SYS_CSSELR_EL1),
444 HOST_HANDLED(SYS_CTR_EL0),
446 /* Performance Monitoring Registers are restricted. */
448 /* Activity Monitoring Registers are restricted. */
450 HOST_HANDLED(SYS_CNTP_TVAL_EL0),
451 HOST_HANDLED(SYS_CNTP_CTL_EL0),
452 HOST_HANDLED(SYS_CNTP_CVAL_EL0),
454 /* Performance Monitoring Registers are restricted. */
458 * Checks that the sysreg table is unique and in-order.
460 * Returns 0 if the table is consistent, or 1 otherwise.
462 int kvm_check_pvm_sysreg_table(void)
466 for (i = 1; i < ARRAY_SIZE(pvm_sys_reg_descs); i++) {
467 if (cmp_sys_reg(&pvm_sys_reg_descs[i-1], &pvm_sys_reg_descs[i]) >= 0)
475 * Handler for protected VM MSR, MRS or System instruction execution.
477 * Returns true if the hypervisor has handled the exit, and control should go
478 * back to the guest, or false if it hasn't, to be handled by the host.
480 bool kvm_handle_pvm_sysreg(struct kvm_vcpu *vcpu, u64 *exit_code)
482 const struct sys_reg_desc *r;
483 struct sys_reg_params params;
484 unsigned long esr = kvm_vcpu_get_esr(vcpu);
485 int Rt = kvm_vcpu_sys_get_rt(vcpu);
487 params = esr_sys64_to_params(esr);
488 params.regval = vcpu_get_reg(vcpu, Rt);
490 r = find_reg(¶ms, pvm_sys_reg_descs, ARRAY_SIZE(pvm_sys_reg_descs));
492 /* Undefined (RESTRICTED). */
494 inject_undef64(vcpu);
498 /* Handled by the host (HOST_HANDLED) */
499 if (r->access == NULL)
502 /* Handled by hyp: skip instruction if instructed to do so. */
503 if (r->access(vcpu, ¶ms, r))
504 __kvm_skip_instr(vcpu);
506 if (!params.is_write)
507 vcpu_set_reg(vcpu, Rt, params.regval);
513 * Handler for protected VM restricted exceptions.
515 * Inject an undefined exception into the guest and return true to indicate that
516 * the hypervisor has handled the exit, and control should go back to the guest.
518 bool kvm_handle_pvm_restricted(struct kvm_vcpu *vcpu, u64 *exit_code)
520 inject_undef64(vcpu);