1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (C) 2019 Arm Ltd.
4 #include <linux/arm-smccc.h>
5 #include <linux/kvm_host.h>
7 #include <asm/kvm_emulate.h>
9 #include <kvm/arm_hypercalls.h>
10 #include <kvm/arm_psci.h>
12 #define KVM_ARM_SMCCC_STD_FEATURES \
13 GENMASK(KVM_REG_ARM_STD_BMAP_BIT_COUNT - 1, 0)
14 #define KVM_ARM_SMCCC_STD_HYP_FEATURES \
15 GENMASK(KVM_REG_ARM_STD_HYP_BMAP_BIT_COUNT - 1, 0)
16 #define KVM_ARM_SMCCC_VENDOR_HYP_FEATURES \
17 GENMASK(KVM_REG_ARM_VENDOR_HYP_BMAP_BIT_COUNT - 1, 0)
19 static void kvm_ptp_get_time(struct kvm_vcpu *vcpu, u64 *val)
21 struct system_time_snapshot systime_snapshot;
26 * system time and counter value must captured at the same
27 * time to keep consistency and precision.
29 ktime_get_snapshot(&systime_snapshot);
32 * This is only valid if the current clocksource is the
33 * architected counter, as this is the only one the guest
36 if (systime_snapshot.cs_id != CSID_ARM_ARCH_COUNTER)
40 * The guest selects one of the two reference counters
41 * (virtual or physical) with the first argument of the SMCCC
42 * call. In case the identifier is not supported, error out.
44 feature = smccc_get_arg1(vcpu);
46 case KVM_PTP_VIRT_COUNTER:
47 cycles = systime_snapshot.cycles - vcpu->kvm->arch.timer_data.voffset;
49 case KVM_PTP_PHYS_COUNTER:
50 cycles = systime_snapshot.cycles - vcpu->kvm->arch.timer_data.poffset;
57 * This relies on the top bit of val[0] never being set for
58 * valid values of system time, because that is *really* far
59 * in the future (about 292 years from 1970, and at that stage
60 * nobody will give a damn about it).
62 val[0] = upper_32_bits(systime_snapshot.real);
63 val[1] = lower_32_bits(systime_snapshot.real);
64 val[2] = upper_32_bits(cycles);
65 val[3] = lower_32_bits(cycles);
68 static bool kvm_smccc_default_allowed(u32 func_id)
72 * List of function-ids that are not gated with the bitmapped
73 * feature firmware registers, and are to be allowed for
74 * servicing the call by default.
76 case ARM_SMCCC_VERSION_FUNC_ID:
77 case ARM_SMCCC_ARCH_FEATURES_FUNC_ID:
80 /* PSCI 0.2 and up is in the 0:0x1f range */
81 if (ARM_SMCCC_OWNER_NUM(func_id) == ARM_SMCCC_OWNER_STANDARD &&
82 ARM_SMCCC_FUNC_NUM(func_id) <= 0x1f)
86 * KVM's PSCI 0.1 doesn't comply with SMCCC, and has
87 * its own function-id base and range
89 if (func_id >= KVM_PSCI_FN(0) && func_id <= KVM_PSCI_FN(3))
96 static bool kvm_smccc_test_fw_bmap(struct kvm_vcpu *vcpu, u32 func_id)
98 struct kvm_smccc_features *smccc_feat = &vcpu->kvm->arch.smccc_feat;
101 case ARM_SMCCC_TRNG_VERSION:
102 case ARM_SMCCC_TRNG_FEATURES:
103 case ARM_SMCCC_TRNG_GET_UUID:
104 case ARM_SMCCC_TRNG_RND32:
105 case ARM_SMCCC_TRNG_RND64:
106 return test_bit(KVM_REG_ARM_STD_BIT_TRNG_V1_0,
107 &smccc_feat->std_bmap);
108 case ARM_SMCCC_HV_PV_TIME_FEATURES:
109 case ARM_SMCCC_HV_PV_TIME_ST:
110 return test_bit(KVM_REG_ARM_STD_HYP_BIT_PV_TIME,
111 &smccc_feat->std_hyp_bmap);
112 case ARM_SMCCC_VENDOR_HYP_KVM_FEATURES_FUNC_ID:
113 case ARM_SMCCC_VENDOR_HYP_CALL_UID_FUNC_ID:
114 return test_bit(KVM_REG_ARM_VENDOR_HYP_BIT_FUNC_FEAT,
115 &smccc_feat->vendor_hyp_bmap);
116 case ARM_SMCCC_VENDOR_HYP_KVM_PTP_FUNC_ID:
117 return test_bit(KVM_REG_ARM_VENDOR_HYP_BIT_PTP,
118 &smccc_feat->vendor_hyp_bmap);
124 #define SMC32_ARCH_RANGE_BEGIN ARM_SMCCC_VERSION_FUNC_ID
125 #define SMC32_ARCH_RANGE_END ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
127 0, ARM_SMCCC_FUNC_MASK)
129 #define SMC64_ARCH_RANGE_BEGIN ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
132 #define SMC64_ARCH_RANGE_END ARM_SMCCC_CALL_VAL(ARM_SMCCC_FAST_CALL, \
134 0, ARM_SMCCC_FUNC_MASK)
136 static void init_smccc_filter(struct kvm *kvm)
140 mt_init(&kvm->arch.smccc_filter);
143 * Prevent userspace from handling any SMCCC calls in the architecture
144 * range, avoiding the risk of misrepresenting Spectre mitigation status
147 r = mtree_insert_range(&kvm->arch.smccc_filter,
148 SMC32_ARCH_RANGE_BEGIN, SMC32_ARCH_RANGE_END,
149 xa_mk_value(KVM_SMCCC_FILTER_HANDLE),
153 r = mtree_insert_range(&kvm->arch.smccc_filter,
154 SMC64_ARCH_RANGE_BEGIN, SMC64_ARCH_RANGE_END,
155 xa_mk_value(KVM_SMCCC_FILTER_HANDLE),
161 static int kvm_smccc_set_filter(struct kvm *kvm, struct kvm_smccc_filter __user *uaddr)
163 const void *zero_page = page_to_virt(ZERO_PAGE(0));
164 struct kvm_smccc_filter filter;
168 if (copy_from_user(&filter, uaddr, sizeof(filter)))
171 if (memcmp(filter.pad, zero_page, sizeof(filter.pad)))
175 end = start + filter.nr_functions - 1;
177 if (end < start || filter.action >= NR_SMCCC_FILTER_ACTIONS)
180 mutex_lock(&kvm->arch.config_lock);
182 if (kvm_vm_has_ran_once(kvm)) {
187 r = mtree_insert_range(&kvm->arch.smccc_filter, start, end,
188 xa_mk_value(filter.action), GFP_KERNEL_ACCOUNT);
192 set_bit(KVM_ARCH_FLAG_SMCCC_FILTER_CONFIGURED, &kvm->arch.flags);
195 mutex_unlock(&kvm->arch.config_lock);
199 static u8 kvm_smccc_filter_get_action(struct kvm *kvm, u32 func_id)
201 unsigned long idx = func_id;
204 if (!test_bit(KVM_ARCH_FLAG_SMCCC_FILTER_CONFIGURED, &kvm->arch.flags))
205 return KVM_SMCCC_FILTER_HANDLE;
208 * But where's the error handling, you say?
210 * mt_find() returns NULL if no entry was found, which just so happens
211 * to match KVM_SMCCC_FILTER_HANDLE.
213 val = mt_find(&kvm->arch.smccc_filter, &idx, idx);
214 return xa_to_value(val);
217 static u8 kvm_smccc_get_action(struct kvm_vcpu *vcpu, u32 func_id)
220 * Intervening actions in the SMCCC filter take precedence over the
221 * pseudo-firmware register bitmaps.
223 u8 action = kvm_smccc_filter_get_action(vcpu->kvm, func_id);
224 if (action != KVM_SMCCC_FILTER_HANDLE)
227 if (kvm_smccc_test_fw_bmap(vcpu, func_id) ||
228 kvm_smccc_default_allowed(func_id))
229 return KVM_SMCCC_FILTER_HANDLE;
231 return KVM_SMCCC_FILTER_DENY;
234 static void kvm_prepare_hypercall_exit(struct kvm_vcpu *vcpu, u32 func_id)
236 u8 ec = ESR_ELx_EC(kvm_vcpu_get_esr(vcpu));
237 struct kvm_run *run = vcpu->run;
240 if (ec == ESR_ELx_EC_SMC32 || ec == ESR_ELx_EC_SMC64)
241 flags |= KVM_HYPERCALL_EXIT_SMC;
243 if (!kvm_vcpu_trap_il_is32bit(vcpu))
244 flags |= KVM_HYPERCALL_EXIT_16BIT;
246 run->exit_reason = KVM_EXIT_HYPERCALL;
247 run->hypercall = (typeof(run->hypercall)) {
253 int kvm_smccc_call_handler(struct kvm_vcpu *vcpu)
255 struct kvm_smccc_features *smccc_feat = &vcpu->kvm->arch.smccc_feat;
256 u32 func_id = smccc_get_function(vcpu);
257 u64 val[4] = {SMCCC_RET_NOT_SUPPORTED};
262 action = kvm_smccc_get_action(vcpu, func_id);
264 case KVM_SMCCC_FILTER_HANDLE:
266 case KVM_SMCCC_FILTER_DENY:
268 case KVM_SMCCC_FILTER_FWD_TO_USER:
269 kvm_prepare_hypercall_exit(vcpu, func_id);
272 WARN_RATELIMIT(1, "Unhandled SMCCC filter action: %d\n", action);
277 case ARM_SMCCC_VERSION_FUNC_ID:
278 val[0] = ARM_SMCCC_VERSION_1_1;
280 case ARM_SMCCC_ARCH_FEATURES_FUNC_ID:
281 feature = smccc_get_arg1(vcpu);
283 case ARM_SMCCC_ARCH_WORKAROUND_1:
284 switch (arm64_get_spectre_v2_state()) {
285 case SPECTRE_VULNERABLE:
287 case SPECTRE_MITIGATED:
288 val[0] = SMCCC_RET_SUCCESS;
290 case SPECTRE_UNAFFECTED:
291 val[0] = SMCCC_ARCH_WORKAROUND_RET_UNAFFECTED;
295 case ARM_SMCCC_ARCH_WORKAROUND_2:
296 switch (arm64_get_spectre_v4_state()) {
297 case SPECTRE_VULNERABLE:
299 case SPECTRE_MITIGATED:
301 * SSBS everywhere: Indicate no firmware
302 * support, as the SSBS support will be
303 * indicated to the guest and the default is
306 * Otherwise, expose a permanent mitigation
307 * to the guest, and hide SSBS so that the
308 * guest stays protected.
310 if (cpus_have_final_cap(ARM64_SSBS))
313 case SPECTRE_UNAFFECTED:
314 val[0] = SMCCC_RET_NOT_REQUIRED;
318 case ARM_SMCCC_ARCH_WORKAROUND_3:
319 switch (arm64_get_spectre_bhb_state()) {
320 case SPECTRE_VULNERABLE:
322 case SPECTRE_MITIGATED:
323 val[0] = SMCCC_RET_SUCCESS;
325 case SPECTRE_UNAFFECTED:
326 val[0] = SMCCC_ARCH_WORKAROUND_RET_UNAFFECTED;
330 case ARM_SMCCC_HV_PV_TIME_FEATURES:
331 if (test_bit(KVM_REG_ARM_STD_HYP_BIT_PV_TIME,
332 &smccc_feat->std_hyp_bmap))
333 val[0] = SMCCC_RET_SUCCESS;
337 case ARM_SMCCC_HV_PV_TIME_FEATURES:
338 val[0] = kvm_hypercall_pv_features(vcpu);
340 case ARM_SMCCC_HV_PV_TIME_ST:
341 gpa = kvm_init_stolen_time(vcpu);
342 if (gpa != INVALID_GPA)
345 case ARM_SMCCC_VENDOR_HYP_CALL_UID_FUNC_ID:
346 val[0] = ARM_SMCCC_VENDOR_HYP_UID_KVM_REG_0;
347 val[1] = ARM_SMCCC_VENDOR_HYP_UID_KVM_REG_1;
348 val[2] = ARM_SMCCC_VENDOR_HYP_UID_KVM_REG_2;
349 val[3] = ARM_SMCCC_VENDOR_HYP_UID_KVM_REG_3;
351 case ARM_SMCCC_VENDOR_HYP_KVM_FEATURES_FUNC_ID:
352 val[0] = smccc_feat->vendor_hyp_bmap;
354 case ARM_SMCCC_VENDOR_HYP_KVM_PTP_FUNC_ID:
355 kvm_ptp_get_time(vcpu, val);
357 case ARM_SMCCC_TRNG_VERSION:
358 case ARM_SMCCC_TRNG_FEATURES:
359 case ARM_SMCCC_TRNG_GET_UUID:
360 case ARM_SMCCC_TRNG_RND32:
361 case ARM_SMCCC_TRNG_RND64:
362 return kvm_trng_call(vcpu);
364 return kvm_psci_call(vcpu);
368 smccc_set_retval(vcpu, val[0], val[1], val[2], val[3]);
372 static const u64 kvm_arm_fw_reg_ids[] = {
373 KVM_REG_ARM_PSCI_VERSION,
374 KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1,
375 KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2,
376 KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_3,
377 KVM_REG_ARM_STD_BMAP,
378 KVM_REG_ARM_STD_HYP_BMAP,
379 KVM_REG_ARM_VENDOR_HYP_BMAP,
382 void kvm_arm_init_hypercalls(struct kvm *kvm)
384 struct kvm_smccc_features *smccc_feat = &kvm->arch.smccc_feat;
386 smccc_feat->std_bmap = KVM_ARM_SMCCC_STD_FEATURES;
387 smccc_feat->std_hyp_bmap = KVM_ARM_SMCCC_STD_HYP_FEATURES;
388 smccc_feat->vendor_hyp_bmap = KVM_ARM_SMCCC_VENDOR_HYP_FEATURES;
390 init_smccc_filter(kvm);
393 void kvm_arm_teardown_hypercalls(struct kvm *kvm)
395 mtree_destroy(&kvm->arch.smccc_filter);
398 int kvm_arm_get_fw_num_regs(struct kvm_vcpu *vcpu)
400 return ARRAY_SIZE(kvm_arm_fw_reg_ids);
403 int kvm_arm_copy_fw_reg_indices(struct kvm_vcpu *vcpu, u64 __user *uindices)
407 for (i = 0; i < ARRAY_SIZE(kvm_arm_fw_reg_ids); i++) {
408 if (put_user(kvm_arm_fw_reg_ids[i], uindices++))
415 #define KVM_REG_FEATURE_LEVEL_MASK GENMASK(3, 0)
418 * Convert the workaround level into an easy-to-compare number, where higher
419 * values mean better protection.
421 static int get_kernel_wa_level(u64 regid)
424 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1:
425 switch (arm64_get_spectre_v2_state()) {
426 case SPECTRE_VULNERABLE:
427 return KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_AVAIL;
428 case SPECTRE_MITIGATED:
429 return KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_AVAIL;
430 case SPECTRE_UNAFFECTED:
431 return KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_REQUIRED;
433 return KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_AVAIL;
434 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2:
435 switch (arm64_get_spectre_v4_state()) {
436 case SPECTRE_MITIGATED:
438 * As for the hypercall discovery, we pretend we
439 * don't have any FW mitigation if SSBS is there at
442 if (cpus_have_final_cap(ARM64_SSBS))
443 return KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_AVAIL;
445 case SPECTRE_UNAFFECTED:
446 return KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_REQUIRED;
447 case SPECTRE_VULNERABLE:
448 return KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_AVAIL;
451 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_3:
452 switch (arm64_get_spectre_bhb_state()) {
453 case SPECTRE_VULNERABLE:
454 return KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_3_NOT_AVAIL;
455 case SPECTRE_MITIGATED:
456 return KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_3_AVAIL;
457 case SPECTRE_UNAFFECTED:
458 return KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_3_NOT_REQUIRED;
460 return KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_3_NOT_AVAIL;
466 int kvm_arm_get_fw_reg(struct kvm_vcpu *vcpu, const struct kvm_one_reg *reg)
468 struct kvm_smccc_features *smccc_feat = &vcpu->kvm->arch.smccc_feat;
469 void __user *uaddr = (void __user *)(long)reg->addr;
473 case KVM_REG_ARM_PSCI_VERSION:
474 val = kvm_psci_version(vcpu);
476 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1:
477 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2:
478 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_3:
479 val = get_kernel_wa_level(reg->id) & KVM_REG_FEATURE_LEVEL_MASK;
481 case KVM_REG_ARM_STD_BMAP:
482 val = READ_ONCE(smccc_feat->std_bmap);
484 case KVM_REG_ARM_STD_HYP_BMAP:
485 val = READ_ONCE(smccc_feat->std_hyp_bmap);
487 case KVM_REG_ARM_VENDOR_HYP_BMAP:
488 val = READ_ONCE(smccc_feat->vendor_hyp_bmap);
494 if (copy_to_user(uaddr, &val, KVM_REG_SIZE(reg->id)))
500 static int kvm_arm_set_fw_reg_bmap(struct kvm_vcpu *vcpu, u64 reg_id, u64 val)
503 struct kvm *kvm = vcpu->kvm;
504 struct kvm_smccc_features *smccc_feat = &kvm->arch.smccc_feat;
505 unsigned long *fw_reg_bmap, fw_reg_features;
508 case KVM_REG_ARM_STD_BMAP:
509 fw_reg_bmap = &smccc_feat->std_bmap;
510 fw_reg_features = KVM_ARM_SMCCC_STD_FEATURES;
512 case KVM_REG_ARM_STD_HYP_BMAP:
513 fw_reg_bmap = &smccc_feat->std_hyp_bmap;
514 fw_reg_features = KVM_ARM_SMCCC_STD_HYP_FEATURES;
516 case KVM_REG_ARM_VENDOR_HYP_BMAP:
517 fw_reg_bmap = &smccc_feat->vendor_hyp_bmap;
518 fw_reg_features = KVM_ARM_SMCCC_VENDOR_HYP_FEATURES;
524 /* Check for unsupported bit */
525 if (val & ~fw_reg_features)
528 mutex_lock(&kvm->arch.config_lock);
530 if (kvm_vm_has_ran_once(kvm) && val != *fw_reg_bmap) {
535 WRITE_ONCE(*fw_reg_bmap, val);
537 mutex_unlock(&kvm->arch.config_lock);
541 int kvm_arm_set_fw_reg(struct kvm_vcpu *vcpu, const struct kvm_one_reg *reg)
543 void __user *uaddr = (void __user *)(long)reg->addr;
547 if (KVM_REG_SIZE(reg->id) != sizeof(val))
549 if (copy_from_user(&val, uaddr, KVM_REG_SIZE(reg->id)))
553 case KVM_REG_ARM_PSCI_VERSION:
557 wants_02 = test_bit(KVM_ARM_VCPU_PSCI_0_2, vcpu->arch.features);
560 case KVM_ARM_PSCI_0_1:
563 vcpu->kvm->arch.psci_version = val;
565 case KVM_ARM_PSCI_0_2:
566 case KVM_ARM_PSCI_1_0:
567 case KVM_ARM_PSCI_1_1:
570 vcpu->kvm->arch.psci_version = val;
576 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1:
577 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_3:
578 if (val & ~KVM_REG_FEATURE_LEVEL_MASK)
581 if (get_kernel_wa_level(reg->id) < val)
586 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2:
587 if (val & ~(KVM_REG_FEATURE_LEVEL_MASK |
588 KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_ENABLED))
591 /* The enabled bit must not be set unless the level is AVAIL. */
592 if ((val & KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_ENABLED) &&
593 (val & KVM_REG_FEATURE_LEVEL_MASK) != KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_AVAIL)
597 * Map all the possible incoming states to the only two we
598 * really want to deal with.
600 switch (val & KVM_REG_FEATURE_LEVEL_MASK) {
601 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_AVAIL:
602 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_UNKNOWN:
603 wa_level = KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_AVAIL;
605 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_AVAIL:
606 case KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_REQUIRED:
607 wa_level = KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_REQUIRED;
614 * We can deal with NOT_AVAIL on NOT_REQUIRED, but not the
617 if (get_kernel_wa_level(reg->id) < wa_level)
621 case KVM_REG_ARM_STD_BMAP:
622 case KVM_REG_ARM_STD_HYP_BMAP:
623 case KVM_REG_ARM_VENDOR_HYP_BMAP:
624 return kvm_arm_set_fw_reg_bmap(vcpu, reg->id, val);
632 int kvm_vm_smccc_has_attr(struct kvm *kvm, struct kvm_device_attr *attr)
634 switch (attr->attr) {
635 case KVM_ARM_VM_SMCCC_FILTER:
642 int kvm_vm_smccc_set_attr(struct kvm *kvm, struct kvm_device_attr *attr)
644 void __user *uaddr = (void __user *)attr->addr;
646 switch (attr->attr) {
647 case KVM_ARM_VM_SMCCC_FILTER:
648 return kvm_smccc_set_filter(kvm, uaddr);