Skip to contentSkip to conversation

fallback for emulation errors

PATCH In review Aaron Lewis 3 participants 7 messages May 10, 2021 – Jun 23, 2021

Subsystems (5)
Documentation x86 KVM Kselftest +1 more subsystems
lore
Share & tools
lore
#0 lore raw

v6 cover fallback for emulation errors

This patchset allows userspace to be a fallback for handling emulation errors.

v1 -> v2:

- Added additional documentation for KVM_CAP_EXIT_ON_EMULATION_FAILURE.
- In prepare_emulation_failure_exit():
- Created a local variable for vcpu->run.
- Cleared the flags, emulation_failure.flags.
- Or'd the instruction bytes flag on to emulation_failure.flags.
- Updated the comment for KVM_INTERNAL_ERROR_EMULATION flags on how they are to be used.
- Updated the comment for struct emulation_failure.

v2 -> v3:

- Update documentation for KVM_CAP_EXIT_ON_EMULATION_FAILURE.
- Fix spacing in prepare_emulation_failure_exit().

v3 -> v4:

- In prepare_emulation_failure_exit():
- Clear instruction bytes to 0x90.
- Copy over insn_size bytes rather than sizeof(ctxt->fetch.data).
- set_page_table_entry() takes a pte rather than mask.
- In _vm_get_page_table_entry():
- Removed check for page aligned addresses only.
- Added canonical check.
- Added a check to make sure no reserved bits are set along the walk except for the final pte (the pte cannot have the reserved bits checked otherwise the test would fail).
- Added check to ensure superpage bits are clear.
- Added check in test for 'allow_smaller_maxphyaddr' module parameter.
- If the is_flds() check fails, only look at the first byte.
- Don't use labels to increment the RIP. Decode the instruction well enough to ensure it is only 2-bytes.

v4 -> v5:

- Switch 'insn_size' to u32.
- Add documentation for how the flags are used.
- Remove 'max_insn_size' and use 'sizeof(run->emulation_failure.insn_bytes)' instead.
- Fix typos.
- Fix canonical check.
- Add reserved check for bit-7 of PML4E.
- Add reserved check for bit-63 of all page table levels if EFER.NXE = 0.
- Remove opcode check (it might be a prefix).
- Remove labels.
- Remove detritus (rogue cpuid entry in the test).

v5 -> v6

- Fix documentation.

Aaron Lewis (2):
kvm: x86: Allow userspace to handle emulation errors
selftests: kvm: Allows userspace to handle emulation errors.

 Documentation/virt/kvm/api.rst                |  19 ++
 arch/x86/include/asm/kvm_host.h               |   6 +
 arch/x86/kvm/x86.c                            |  37 ++-
 include/uapi/linux/kvm.h                      |  23 ++
 tools/include/uapi/linux/kvm.h                |  23 ++
 tools/testing/selftests/kvm/.gitignore        |   1 +
 tools/testing/selftests/kvm/Makefile          |   1 +
 .../selftests/kvm/include/x86_64/processor.h  |   4 +
 .../selftests/kvm/lib/x86_64/processor.c      |  94 ++++++++
 .../kvm/x86_64/emulator_error_test.c          | 219 ++++++++++++++++++
 10 files changed, 423 insertions(+), 4 deletions(-)
 create mode 100644 tools/testing/selftests/kvm/x86_64/emulator_error_test.c
Signature · 1 line
2.31.1.607.g51e8a6a459-goog
#1 lore raw

PATCH v6 1/2 kvm: x86: Allow userspace to handle emulation errors

Add a fallback mechanism to the in-kernel instruction emulator that allows userspace the opportunity to process an instruction the emulator was unable to. When the in-kernel instruction emulator fails to process an instruction it will either inject a #UD into the guest or exit to userspace with exit reason KVM_INTERNAL_ERROR. This is because it does not know how to proceed in an appropriate manner. This feature lets userspace get involved to see if it can figure out a better path forward.

---
 Documentation/virt/kvm/api.rst  | 19 +++++++++++++++++
 arch/x86/include/asm/kvm_host.h |  6 ++++++
 arch/x86/kvm/x86.c              | 37 +++++++++++++++++++++++++++++----
 include/uapi/linux/kvm.h        | 23 ++++++++++++++++++++
 tools/include/uapi/linux/kvm.h  | 23 ++++++++++++++++++++
 5 files changed, 104 insertions(+), 4 deletions(-)
Documentation/virt/kvm/api.rst +19 -0
index 307f2fcf1b02..17668d3e1cb7 100644
@@ -6233,6 +6233,25 @@ KVM_RUN_BUS_LOCK flag is used to distinguish between them.
 This capability can be used to check / enable 2nd DAWR feature provided
 by POWER10 processor.
 
+7.24 KVM_CAP_EXIT_ON_EMULATION_FAILURE
+--------------------------------------
+
+:Architectures: x86
+:Parameters: args[0] whether the feature should be enabled or not
+
+When this capability is enabled, an emulation failure will result in an exit
+to userspace with KVM_INTERNAL_ERROR (except when the emulator was invoked
+to handle a VMware backdoor instruction). Furthermore, KVM will now provide up
+to 15 instruction bytes for any exit to userspace resulting from an emulation
+failure.  When these exits to userspace occur use the emulation_failure struct
+instead of the internal struct.  They both have the same layout, but the
+emulation_failure struct matches the content better.  It also explicitly
+defines the 'flags' field which is used to describe the fields in the struct
+that are valid (ie: if KVM_INTERNAL_ERROR_EMULATION_FLAG_INSTRUCTION_BYTES is
+set in the 'flags' field then both 'insn_size' and 'insn_bytes' have valid data
+in them.)
+
+
 8. Other capabilities.
 ======================
 
arch/x86/include/asm/kvm_host.h +6 -0
index 3768819693e5..07235d08e976 100644
@@ -1049,6 +1049,12 @@ struct kvm_arch {
 	bool exception_payload_enabled;
 
 	bool bus_lock_detection_enabled;
+	/*
+	 * If exit_on_emulation_error is set, and the in-kernel instruction
+	 * emulator fails to emulate an instruction, allow userspace
+	 * the opportunity to look at it.
+	 */
+	bool exit_on_emulation_error;
 
 	/* Deflect RDMSR and WRMSR to user space when they trigger a #GP */
 	u32 user_space_msr_mask;
arch/x86/kvm/x86.c +33 -4
index eca63625aee4..703bcc93b129 100644
@@ -3771,6 +3771,7 @@ int kvm_vm_ioctl_check_extension(struct kvm *kvm, long ext)
 	case KVM_CAP_X86_USER_SPACE_MSR:
 	case KVM_CAP_X86_MSR_FILTER:
 	case KVM_CAP_ENFORCE_PV_FEATURE_CPUID:
+	case KVM_CAP_EXIT_ON_EMULATION_FAILURE:
 		r = 1;
 		break;
 #ifdef CONFIG_KVM_XEN
@@ -5357,6 +5358,10 @@ int kvm_vm_ioctl_enable_cap(struct kvm *kvm,
 			kvm->arch.bus_lock_detection_enabled = true;
 		r = 0;
 		break;
+	case KVM_CAP_EXIT_ON_EMULATION_FAILURE:
+		kvm->arch.exit_on_emulation_error = cap->args[0];
+		r = 0;
+		break;
 	default:
 		r = -EINVAL;
 		break;
@@ -7119,8 +7124,33 @@ void kvm_inject_realmode_interrupt(struct kvm_vcpu *vcpu, int irq, int inc_eip)
 }
 EXPORT_SYMBOL_GPL(kvm_inject_realmode_interrupt);
 
+static void prepare_emulation_failure_exit(struct kvm_vcpu *vcpu)
+{
+	struct x86_emulate_ctxt *ctxt = vcpu->arch.emulate_ctxt;
+	u32 insn_size = ctxt->fetch.end - ctxt->fetch.data;
+	struct kvm_run *run = vcpu->run;
+
+	run->exit_reason = KVM_EXIT_INTERNAL_ERROR;
+	run->emulation_failure.suberror = KVM_INTERNAL_ERROR_EMULATION;
+	run->emulation_failure.ndata = 0;
+	run->emulation_failure.flags = 0;
+
+	if (insn_size) {
+		run->emulation_failure.ndata = 3;
+		run->emulation_failure.flags |=
+			KVM_INTERNAL_ERROR_EMULATION_FLAG_INSTRUCTION_BYTES;
+		run->emulation_failure.insn_size = insn_size;
+		memset(run->emulation_failure.insn_bytes, 0x90,
+		       sizeof(run->emulation_failure.insn_bytes));
+		memcpy(run->emulation_failure.insn_bytes,
+		       ctxt->fetch.data, insn_size);
+	}
+}
+
 static int handle_emulation_failure(struct kvm_vcpu *vcpu, int emulation_type)
 {
+	struct kvm *kvm = vcpu->kvm;
+
 	++vcpu->stat.insn_emulation_fail;
 	trace_kvm_emulate_insn_failed(vcpu);
 
@@ -7129,10 +7159,9 @@ static int handle_emulation_failure(struct kvm_vcpu *vcpu, int emulation_type)
 		return 1;
 	}
 
-	if (emulation_type & EMULTYPE_SKIP) {
-		vcpu->run->exit_reason = KVM_EXIT_INTERNAL_ERROR;
-		vcpu->run->internal.suberror = KVM_INTERNAL_ERROR_EMULATION;
-		vcpu->run->internal.ndata = 0;
+	if (kvm->arch.exit_on_emulation_error ||
+	    (emulation_type & EMULTYPE_SKIP)) {
+		prepare_emulation_failure_exit(vcpu);
 		return 0;
 	}
 
include/uapi/linux/kvm.h +23 -0
index f6afee209620..1bca5d066e3c 100644
@@ -279,6 +279,9 @@ struct kvm_xen_exit {
 /* Encounter unexpected vm-exit reason */
 #define KVM_INTERNAL_ERROR_UNEXPECTED_EXIT_REASON	4
 
+/* Flags that describe what fields in emulation_failure hold valid data. */
+#define KVM_INTERNAL_ERROR_EMULATION_FLAG_INSTRUCTION_BYTES (1ULL << 0)
+
 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
 struct kvm_run {
 	/* in */
@@ -382,6 +385,25 @@ struct kvm_run {
 			__u32 ndata;
 			__u64 data[16];
 		} internal;
+		/*
+		 * KVM_INTERNAL_ERROR_EMULATION
+		 *
+		 * "struct emulation_failure" is an overlay of "struct internal"
+		 * that is used for the KVM_INTERNAL_ERROR_EMULATION sub-type of
+		 * KVM_EXIT_INTERNAL_ERROR.  Note, unlike other internal error
+		 * sub-types, this struct is ABI!  It also needs to be backwards
+		 * compatible with "struct internal".  Take special care that
+		 * "ndata" is correct, that new fields are enumerated in "flags",
+		 * and that each flag enumerates fields that are 64-bit aligned
+		 * and sized (so that ndata+internal.data[] is valid/accurate).
+		 */
+		struct {
+			__u32 suberror;
+			__u32 ndata;
+			__u64 flags;
+			__u8  insn_size;
+			__u8  insn_bytes[15];
+		} emulation_failure;
 		/* KVM_EXIT_OSI */
 		struct {
 			__u64 gprs[32];
@@ -1078,6 +1100,7 @@ struct kvm_ppc_resize_hpt {
 #define KVM_CAP_DIRTY_LOG_RING 192
 #define KVM_CAP_X86_BUS_LOCK_EXIT 193
 #define KVM_CAP_PPC_DAWR1 194
+#define KVM_CAP_EXIT_ON_EMULATION_FAILURE 195
 
 #ifdef KVM_CAP_IRQ_ROUTING
 
tools/include/uapi/linux/kvm.h +23 -0
index f6afee209620..1bca5d066e3c 100644
@@ -279,6 +279,9 @@ struct kvm_xen_exit {
 /* Encounter unexpected vm-exit reason */
 #define KVM_INTERNAL_ERROR_UNEXPECTED_EXIT_REASON	4
 
+/* Flags that describe what fields in emulation_failure hold valid data. */
+#define KVM_INTERNAL_ERROR_EMULATION_FLAG_INSTRUCTION_BYTES (1ULL << 0)
+
 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
 struct kvm_run {
 	/* in */
@@ -382,6 +385,25 @@ struct kvm_run {
 			__u32 ndata;
 			__u64 data[16];
 		} internal;
+		/*
+		 * KVM_INTERNAL_ERROR_EMULATION
+		 *
+		 * "struct emulation_failure" is an overlay of "struct internal"
+		 * that is used for the KVM_INTERNAL_ERROR_EMULATION sub-type of
+		 * KVM_EXIT_INTERNAL_ERROR.  Note, unlike other internal error
+		 * sub-types, this struct is ABI!  It also needs to be backwards
+		 * compatible with "struct internal".  Take special care that
+		 * "ndata" is correct, that new fields are enumerated in "flags",
+		 * and that each flag enumerates fields that are 64-bit aligned
+		 * and sized (so that ndata+internal.data[] is valid/accurate).
+		 */
+		struct {
+			__u32 suberror;
+			__u32 ndata;
+			__u64 flags;
+			__u8  insn_size;
+			__u8  insn_bytes[15];
+		} emulation_failure;
 		/* KVM_EXIT_OSI */
 		struct {
 			__u64 gprs[32];
@@ -1078,6 +1100,7 @@ struct kvm_ppc_resize_hpt {
 #define KVM_CAP_DIRTY_LOG_RING 192
 #define KVM_CAP_X86_BUS_LOCK_EXIT 193
 #define KVM_CAP_PPC_DAWR1 194
+#define KVM_CAP_EXIT_ON_EMULATION_FAILURE 195
 
 #ifdef KVM_CAP_IRQ_ROUTING
 
Signature · 1 line
2.31.1.607.g51e8a6a459-goog
Reviewed-by on v6 1/2
#2 lore raw

Re: [PATCH v6 1/2] kvm: x86: Allow userspace to handle emulation errors

Quoted 10 lines · Aaron Lewis

Add a fallback mechanism to the in-kernel instruction emulator that allows userspace the opportunity to process an instruction the emulator was unable to. When the in-kernel instruction emulator fails to process an instruction it will either inject a #UD into the guest or exit to userspace with exit reason KVM_INTERNAL_ERROR. This is because it does not know how to proceed in an appropriate manner. This feature lets userspace get involved to see if it can figure out a better path forward.

Quoted 2 lines
#3 lore raw

Re: [PATCH v6 1/2] kvm: x86: Allow userspace to handle emulation errors

Quoted 12 lines · Jim Mattson
Quoted 10 lines · Aaron Lewis

Add a fallback mechanism to the in-kernel instruction emulator that allows userspace the opportunity to process an instruction the emulator was unable to. When the in-kernel instruction emulator fails to process an instruction it will either inject a #UD into the guest or exit to userspace with exit reason KVM_INTERNAL_ERROR. This is because it does not know how to proceed in an appropriate manner. This feature lets userspace get involved to see if it can figure out a better path forward.

Quoted 3 lines
Quoted 2 lines

Hi Paolo,

Does this change look okay to you? Can I get it queued?

Thanks,
Aaron

maintainer
#4 lore raw

Re: [PATCH v6 1/2] kvm: x86: Allow userspace to handle emulation errors

Quoted 15 lines · Aaron Lewis
Quoted 14 lines · Jim Mattson
Quoted 12 lines · Aaron Lewis

Add a fallback mechanism to the in-kernel instruction emulator that allows userspace the opportunity to process an instruction the emulator was unable to. When the in-kernel instruction emulator fails to process an instruction it will either inject a #UD into the guest or exit to userspace with exit reason KVM_INTERNAL_ERROR. This is because it does not know how to proceed in an appropriate manner. This feature lets userspace get involved to see if it can figure out a better path forward.

Quoted 9 lines
Quoted 1 line

Hi Paolo,

Does this change look okay to you? Can I get it queued?

Thanks,
Aaron

Sorry I missed it. Looking now.

Paolo

#5 lore raw

PATCH v6 2/2 selftests: kvm: Allows userspace to handle emulation errors.

In reply to Aaron Lewis

This test exercises the feature KVM_CAP_EXIT_ON_EMULATION_FAILURE. When enabled, errors in the in-kernel instruction emulator are forwarded to userspace with the instruction bytes stored in the exit struct for KVM_EXIT_INTERNAL_ERROR. So, when the guest attempts to emulate an 'flds' instruction, which isn't able to be emulated in KVM, instead of failing, KVM sends the instruction to userspace to handle.

For this test to work properly the module parameter 'allow_smaller_maxphyaddr' has to be set.

---
 tools/testing/selftests/kvm/.gitignore        |   1 +
 tools/testing/selftests/kvm/Makefile          |   1 +
 .../selftests/kvm/include/x86_64/processor.h  |   4 +
 .../selftests/kvm/lib/x86_64/processor.c      |  94 ++++++++
 .../kvm/x86_64/emulator_error_test.c          | 219 ++++++++++++++++++
 5 files changed, 319 insertions(+)
 create mode 100644 tools/testing/selftests/kvm/x86_64/emulator_error_test.c
tools/testing/selftests/kvm/.gitignore +1 -0
index 7bd7e776c266..ec9e20a2f752 100644
@@ -7,6 +7,7 @@
 /x86_64/cr4_cpuid_sync_test
 /x86_64/debug_regs
 /x86_64/evmcs_test
+/x86_64/emulator_error_test
 /x86_64/get_cpuid_test
 /x86_64/get_msr_index_features
 /x86_64/kvm_pv_test
tools/testing/selftests/kvm/Makefile +1 -0
index 67eebb53235f..5ff705d92d02 100644
@@ -41,6 +41,7 @@ LIBKVM_s390x = lib/s390x/processor.c lib/s390x/ucall.c lib/s390x/diag318_test_ha
 TEST_GEN_PROGS_x86_64 = x86_64/cr4_cpuid_sync_test
 TEST_GEN_PROGS_x86_64 += x86_64/get_msr_index_features
 TEST_GEN_PROGS_x86_64 += x86_64/evmcs_test
+TEST_GEN_PROGS_x86_64 += x86_64/emulator_error_test
 TEST_GEN_PROGS_x86_64 += x86_64/get_cpuid_test
 TEST_GEN_PROGS_x86_64 += x86_64/hyperv_clock
 TEST_GEN_PROGS_x86_64 += x86_64/hyperv_cpuid
tools/testing/selftests/kvm/include/x86_64/processor.h +4 -0
index 0b30b4e15c38..8fdd21710aae 100644
@@ -394,6 +394,10 @@ void vcpu_init_descriptor_tables(struct kvm_vm *vm, uint32_t vcpuid);
 void vm_handle_exception(struct kvm_vm *vm, int vector,
 			void (*handler)(struct ex_regs *));
 
+uint64_t vm_get_page_table_entry(struct kvm_vm *vm, int vcpuid, uint64_t vaddr);
+void vm_set_page_table_entry(struct kvm_vm *vm, int vcpuid, uint64_t vaddr,
+			     uint64_t pte);
+
 /*
  * set_cpuid() - overwrites a matching cpuid entry with the provided value.
  *		 matches based on ent->function && ent->index. returns true
tools/testing/selftests/kvm/lib/x86_64/processor.c +94 -0

100 lines not on this page · raw message

tools/testing/selftests/kvm/x86_64/emulator_error_test.c new file +219 -0

219 lines not on this page · raw message

Signature · 1 line
2.31.1.607.g51e8a6a459-goog
maintainer
#6 lore raw
In reply to Aaron Lewis
Quoted 68 lines · Aaron Lewis

This patchset allows userspace to be a fallback for handling emulation errors.

v1 -> v2:

- Added additional documentation for KVM_CAP_EXIT_ON_EMULATION_FAILURE.
- In prepare_emulation_failure_exit():
- Created a local variable for vcpu->run.
- Cleared the flags, emulation_failure.flags.
- Or'd the instruction bytes flag on to emulation_failure.flags.
- Updated the comment for KVM_INTERNAL_ERROR_EMULATION flags on how they are to be used.
- Updated the comment for struct emulation_failure.

v2 -> v3:

- Update documentation for KVM_CAP_EXIT_ON_EMULATION_FAILURE.
- Fix spacing in prepare_emulation_failure_exit().

v3 -> v4:

- In prepare_emulation_failure_exit():
- Clear instruction bytes to 0x90.
- Copy over insn_size bytes rather than sizeof(ctxt->fetch.data).
- set_page_table_entry() takes a pte rather than mask.
- In _vm_get_page_table_entry():
- Removed check for page aligned addresses only.
- Added canonical check.
- Added a check to make sure no reserved bits are set along the walk except for the final pte (the pte cannot have the reserved bits checked otherwise the test would fail).
- Added check to ensure superpage bits are clear.
- Added check in test for 'allow_smaller_maxphyaddr' module parameter.
- If the is_flds() check fails, only look at the first byte.
- Don't use labels to increment the RIP. Decode the instruction well enough to ensure it is only 2-bytes.

v4 -> v5:

- Switch 'insn_size' to u32.
- Add documentation for how the flags are used.
- Remove 'max_insn_size' and use 'sizeof(run->emulation_failure.insn_bytes)' instead.
- Fix typos.
- Fix canonical check.
- Add reserved check for bit-7 of PML4E.
- Add reserved check for bit-63 of all page table levels if EFER.NXE = 0.
- Remove opcode check (it might be a prefix).
- Remove labels.
- Remove detritus (rogue cpuid entry in the test).

v5 -> v6

- Fix documentation.

Aaron Lewis (2):
kvm: x86: Allow userspace to handle emulation errors
selftests: kvm: Allows userspace to handle emulation errors.

  Documentation/virt/kvm/api.rst                |  19 ++
  arch/x86/include/asm/kvm_host.h               |   6 +
  arch/x86/kvm/x86.c                            |  37 ++-
  include/uapi/linux/kvm.h                      |  23 ++
  tools/include/uapi/linux/kvm.h                |  23 ++
  tools/testing/selftests/kvm/.gitignore        |   1 +
  tools/testing/selftests/kvm/Makefile          |   1 +
  .../selftests/kvm/include/x86_64/processor.h  |   4 +
  .../selftests/kvm/lib/x86_64/processor.c      |  94 ++++++++
  .../kvm/x86_64/emulator_error_test.c          | 219 ++++++++++++++++++
  10 files changed, 423 insertions(+), 4 deletions(-)
Quoted 2 lines

create mode 100644 tools/testing/selftests/kvm/x86_64/emulator_error_test.c

Queued, thanks (not yet tested, but still).

Paolo