x86/kvm/hyper-v: add support for synthetic debugger
Subsystems (7)
v6 cover x86/kvm/hyper-v: add support for synthetic debugger
Add support for the synthetic debugger interface of hyper-v, the synthetic debugger has 2 modes.
1. Use a set of MSRs to send/recv information (undocumented so it's not going to the hyperv-tlfs.h)
2. Use hypercalls
The first mode is based the following MSRs:
1. Control/Status MSRs which either asks for a send/recv .
2. Send/Recv MSRs each holds GPA where the send/recv buffers are.
3. Pending MSR, holds a GPA to a PAGE that simply has a boolean that indicates if there is data pending to issue a recv VMEXIT.
The first mode implementation is to simply exit to user-space when either the control MSR or the pending MSR are being set.
Then it's up-to userspace to implement the rest of the logic of sending/recving.
In the second mode instead of using MSRs KNet will simply issue Hypercalls with the information to send/recv, in this mode the data being transferred is UDP encapsulated, unlike in the previous mode in which you get just the data to send.
The new hypercalls will exit to userspace which will be incharge of re-encapsulating if needed the UDP packets to be sent.
There is an issue though in which KDNet does not respect the hypercall page and simply issues vmcall/vmmcall instructions depending on the cpu type expecting them to be handled as it a real hypercall was issued.
It's important to note that part of this feature has been subject to be removed in future versions of Windows, which is why some of the defintions will not be present the the TLFS but in the kvm hyperv header instead.
Jon Doron (5):
x86/kvm/hyper-v: Explicitly align hcall param for kvm_hyperv_exit x86/hyper-v: Add synthetic debugger definitions x86/kvm/hyper-v: Add support for synthetic debugger capability x86/kvm/hyper-v: enable hypercalls regardless of hypercall page x86/kvm/hyper-v: Add support for synthetic debugger via hypercalls
Documentation/virt/kvm/api.rst | 18 ++++ arch/x86/include/asm/hyperv-tlfs.h | 6 ++ arch/x86/include/asm/kvm_host.h | 13 +++ arch/x86/kvm/hyperv.c | 162 ++++++++++++++++++++++++++++- arch/x86/kvm/hyperv.h | 32 ++++++ arch/x86/kvm/trace.h | 51 +++++++++ arch/x86/kvm/x86.c | 9 ++ include/uapi/linux/kvm.h | 13 +++ 8 files changed, 302 insertions(+), 2 deletions(-)
Signature · 1 line
2.24.1
PATCH v6 1/5 x86/kvm/hyper-v: Explicitly align hcall param for kvm_hyperv_exit
--- Documentation/virt/kvm/api.rst | 2 ++ include/uapi/linux/kvm.h | 2 ++ 2 files changed, 4 insertions(+)
Documentation/virt/kvm/api.rst +2 -0
@@ -5025,9 +5025,11 @@ EOI was received. #define KVM_EXIT_HYPERV_SYNIC 1 #define KVM_EXIT_HYPERV_HCALL 2 __u32 type; + __u32 pad1; union { struct { __u32 msr; + __u32 pad2; __u64 control; __u64 evt_page; __u64 msg_page;
include/uapi/linux/kvm.h +2 -0
@@ -189,9 +189,11 @@ struct kvm_hyperv_exit {#define KVM_EXIT_HYPERV_SYNIC 1#define KVM_EXIT_HYPERV_HCALL 2__u32 type; +__u32 pad1;union {struct {__u32 msr; +__u32 pad2;__u64 control;__u64 evt_page;__u64 msg_page;
Signature · 1 line
2.24.1
PATCH v6 2/5 x86/hyper-v: Add synthetic debugger definitions
In reply to Jon DoronHyper-V synthetic debugger has two modes, one that uses MSRs and the other that use Hypercalls.
Add all the required definitions to both types of synthetic debugger interface.
Some of the required new CPUIDs and MSRs are not documented in the TLFS so they are in hyperv.h instead.
The reason they are not documented is because they are subjected to be removed in future versions of Windows.
--- arch/x86/include/asm/hyperv-tlfs.h | 6 ++++++ arch/x86/kvm/hyperv.h | 27 +++++++++++++++++++++++++++ 2 files changed, 33 insertions(+)
arch/x86/include/asm/hyperv-tlfs.h +6 -0
@@ -131,6 +131,8 @@#define HV_FEATURE_FREQUENCY_MSRS_AVAILABLE BIT(8)/* Crash MSR available */ #define HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE BIT(10) +/* Support for debug MSRs available */ +#define HV_FEATURE_DEBUG_MSRS_AVAILABLE BIT(11)/* stimer Direct Mode is available */ #define HV_STIMER_DIRECT_MODE_AVAILABLE BIT(19)
@@ -376,6 +378,9 @@ struct hv_tsc_emulation_status {#define HVCALL_SEND_IPI_EX 0x0015#define HVCALL_POST_MESSAGE 0x005c#define HVCALL_SIGNAL_EVENT 0x005d +#define HVCALL_POST_DEBUG_DATA 0x0069 +#define HVCALL_RETRIEVE_DEBUG_DATA 0x006a +#define HVCALL_RESET_DEBUG_SESSION 0x006b#define HVCALL_FLUSH_GUEST_PHYSICAL_ADDRESS_SPACE 0x00af#define HVCALL_FLUSH_GUEST_PHYSICAL_ADDRESS_LIST 0x00b0
@@ -419,6 +424,7 @@ enum HV_GENERIC_SET_FORMAT {#define HV_STATUS_INVALID_HYPERCALL_INPUT 3#define HV_STATUS_INVALID_ALIGNMENT 4#define HV_STATUS_INVALID_PARAMETER 5 +#define HV_STATUS_OPERATION_DENIED 8#define HV_STATUS_INSUFFICIENT_MEMORY 11#define HV_STATUS_INVALID_PORT_ID 17#define HV_STATUS_INVALID_CONNECTION_ID 18
arch/x86/kvm/hyperv.h +27 -0
@@ -23,6 +23,33 @@#include <linux/kvm_host.h> +/* +* The #defines related to the synthetic debugger are required by KDNet, but +* they are not documented in the Hyper-V TLFS because the synthetic debugger +* functionality has been deprecated and is subject to removal in future versions +* of Windows. +*/ +#define HYPERV_CPUID_SYNDBG_VENDOR_AND_MAX_FUNCTIONS 0x40000080 +#define HYPERV_CPUID_SYNDBG_INTERFACE 0x40000081 +#define HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES 0x40000082 + +/* +* Hyper-V synthetic debugger platform capabilities +* These are HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES.EAX bits. +*/ +#define HV_X64_SYNDBG_CAP_ALLOW_KERNEL_DEBUGGING BIT(1) + +/* Hyper-V Synthetic debug options MSR */ +#define HV_X64_MSR_SYNDBG_CONTROL 0x400000F1 +#define HV_X64_MSR_SYNDBG_STATUS 0x400000F2 +#define HV_X64_MSR_SYNDBG_SEND_BUFFER 0x400000F3 +#define HV_X64_MSR_SYNDBG_RECV_BUFFER 0x400000F4 +#define HV_X64_MSR_SYNDBG_PENDING_BUFFER 0x400000F5 +#define HV_X64_MSR_SYNDBG_OPTIONS 0x400000FF + +/* Hyper-V HV_X64_MSR_SYNDBG_OPTIONS bits */ +#define HV_X64_SYNDBG_OPTION_USE_HCALLS BIT(2) +static inline struct kvm_vcpu_hv *vcpu_to_hv_vcpu (struct kvm_vcpu *vcpu) {return &vcpu->arch.hyperv;
Signature · 1 line
2.24.1
PATCH v6 3/5 x86/kvm/hyper-v: Add support for synthetic debugger capability
In reply to Jon DoronAdd support for Hyper-V synthetic debugger (syndbg) interface. The syndbg interface is using MSRs to emulate a way to send/recv packets data.
The debug transport dll (kdvm/kdnet) will identify if Hyper-V is enabled and if it supports the synthetic debugger interface it will attempt to use it, instead of trying to initialize a network adapter.
--- Documentation/virt/kvm/api.rst | 16 ++++ arch/x86/include/asm/kvm_host.h | 13 +++ arch/x86/kvm/hyperv.c | 135 +++++++++++++++++++++++++++++++- arch/x86/kvm/hyperv.h | 5 ++ arch/x86/kvm/trace.h | 51 ++++++++++++ arch/x86/kvm/x86.c | 9 +++ include/uapi/linux/kvm.h | 11 +++ 7 files changed, 239 insertions(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +16 -0
@@ -5024,6 +5024,7 @@ EOI was received. struct kvm_hyperv_exit { #define KVM_EXIT_HYPERV_SYNIC 1 #define KVM_EXIT_HYPERV_HCALL 2 + #define KVM_EXIT_HYPERV_SYNDBG 3 __u32 type; __u32 pad1; union {
@@ -5039,6 +5040,15 @@ EOI was received. __u64 result; __u64 params[2]; } hcall; + struct { + __u32 msr; + __u32 pad2; + __u64 control; + __u64 status; + __u64 send_page; + __u64 recv_page; + __u64 pending_page; + } syndbg; } u; }; /* KVM_EXIT_HYPERV */
@@ -5055,6 +5065,12 @@ Hyper-V SynIC state change. Notification is used to remap SynIC event/message pages and to enable/disable SynIC messages/events processing in userspace. + - KVM_EXIT_HYPERV_SYNDBG -- synchronously notify user-space about + +Hyper-V Synthetic debugger state change. Notification is used to either update +the pending_page location or to send a control command (send the buffer located +in send_page or recv a buffer to recv_page). + :: /* KVM_EXIT_ARM_NISV */
arch/x86/include/asm/kvm_host.h +13 -0
@@ -854,6 +854,18 @@ struct kvm_apic_map {struct kvm_lapic *phys_map[]; }; +/* Hyper-V synthetic debugger (SynDbg)*/ +struct kvm_hv_syndbg { +struct { +u64 control; +u64 status; +u64 send_page; +u64 recv_page; +u64 pending_page; + } control; +u64 options; +}; +/* Hyper-V emulation context */ struct kvm_hv {struct mutex hv_lock;
@@ -877,6 +889,7 @@ struct kvm_hv {atomic_t num_mismatched_vp_indexes;struct hv_partition_assist_pg *hv_pa_pg; +struct kvm_hv_syndbg hv_syndbg; };enum kvm_irqchip_mode {
arch/x86/kvm/hyperv.c +134 -1
186 lines not on this page · raw message
arch/x86/kvm/hyperv.h +5 -0
@@ -73,6 +73,11 @@ static inline struct kvm_vcpu *synic_to_vcpu(struct kvm_vcpu_hv_synic *synic) return hv_vcpu_to_vcpu(container_of(synic, struct kvm_vcpu_hv, synic)); } +static inline struct kvm_hv_syndbg *vcpu_to_hv_syndbg (struct kvm_vcpu *vcpu) +{ +return &vcpu->kvm->arch.hyperv.hv_syndbg; +} +int kvm_hv_set_msr_common (struct kvm_vcpu *vcpu,u32 msr,u64 data,bool host);int kvm_hv_get_msr_common (struct kvm_vcpu *vcpu,u32 msr,u64 *pdata,bool host);
arch/x86/kvm/trace.h +51 -0
57 lines not on this page · raw message
arch/x86/kvm/x86.c +9 -0
@@ -1214,6 +1214,10 @@ static const u32 emulated_msrs_all[] = {HV_X64_MSR_VP_ASSIST_PAGE ,HV_X64_MSR_REENLIGHTENMENT_CONTROL ,HV_X64_MSR_TSC_EMULATION_CONTROL ,HV_X64_MSR_TSC_EMULATION_STATUS , +HV_X64_MSR_SYNDBG_OPTIONS , +HV_X64_MSR_SYNDBG_CONTROL ,HV_X64_MSR_SYNDBG_STATUS , +HV_X64_MSR_SYNDBG_SEND_BUFFER ,HV_X64_MSR_SYNDBG_RECV_BUFFER , +HV_X64_MSR_SYNDBG_PENDING_BUFFER ,MSR_KVM_ASYNC_PF_EN ,MSR_KVM_STEAL_TIME , MSR_KVM_PV_EOI_EN,
@@ -2906,6 +2910,8 @@ int kvm_set_msr_common(struct kvm_vcpu *vcpu, struct msr_data *msr_info)*/ break ; case HV_X64_MSR_GUEST_OS_ID ... HV_X64_MSR_SINT15: + case HV_X64_MSR_SYNDBG_CONTROL ... HV_X64_MSR_SYNDBG_PENDING_BUFFER: +case HV_X64_MSR_SYNDBG_OPTIONS : case HV_X64_MSR_CRASH_P0 ... HV_X64_MSR_CRASH_P4:case HV_X64_MSR_CRASH_CTL : case HV_X64_MSR_STIMER0_CONFIG ... HV_X64_MSR_STIMER3_COUNT:
@@ -3151,6 +3157,8 @@ int kvm_get_msr_common(struct kvm_vcpu *vcpu, struct msr_data *msr_info) msr_info->data =0x20000000 ;break ; case HV_X64_MSR_GUEST_OS_ID ... HV_X64_MSR_SINT15: + case HV_X64_MSR_SYNDBG_CONTROL ... HV_X64_MSR_SYNDBG_PENDING_BUFFER: +case HV_X64_MSR_SYNDBG_OPTIONS : case HV_X64_MSR_CRASH_P0 ... HV_X64_MSR_CRASH_P4:case HV_X64_MSR_CRASH_CTL : case HV_X64_MSR_STIMER0_CONFIG ... HV_X64_MSR_STIMER3_COUNT:
@@ -3323,6 +3331,7 @@ int kvm_vm_ioctl_check_extension(struct kvm *kvm, long ext)case KVM_CAP_HYPERV_TLBFLUSH :case KVM_CAP_HYPERV_SEND_IPI :case KVM_CAP_HYPERV_CPUID : +case KVM_CAP_HYPERV_DEBUGGING :case KVM_CAP_PCI_SEGMENT :case KVM_CAP_DEBUGREGS :case KVM_CAP_X86_ROBUST_SINGLESTEP :
include/uapi/linux/kvm.h +11 -0
@@ -188,6 +188,7 @@ struct kvm_s390_cmma_log {struct kvm_hyperv_exit {#define KVM_EXIT_HYPERV_SYNIC 1#define KVM_EXIT_HYPERV_HCALL 2 +#define KVM_EXIT_HYPERV_SYNDBG 3__u32 type;__u32 pad1;union {
@@ -203,6 +204,15 @@ struct kvm_hyperv_exit {__u64 result;__u64 params[2 ]; } hcall; +struct { +__u32 msr; +__u32 pad2; +__u64 control; +__u64 status; +__u64 send_page; +__u64 recv_page; +__u64 pending_page; + } syndbg; } u; };
@@ -1012,6 +1022,7 @@ struct kvm_ppc_resize_hpt {#define KVM_CAP_ARM_NISV_TO_USER 177#define KVM_CAP_ARM_INJECT_EXT_DABT 178#define KVM_CAP_S390_VCPU_RESETS 179 +#define KVM_CAP_HYPERV_DEBUGGING 180#ifdef KVM_CAP_IRQ_ROUTING
Signature · 1 line
2.24.1
PATCH v6 4/5 x86/kvm/hyper-v: enable hypercalls regardless of hypercall page
In reply to Jon DoronMicrosoft's kdvm.dll dbgtransport module does not respect the hypercall page and simply identifies the CPU being used (AMD/Intel) and according to it simply makes hypercalls with the relevant instruction (vmmcall/vmcall respectively).
The relevant function in kdvm is KdHvConnectHypervisor which first checks if the hypercall page has been enabled via HV_X64_MSR_HYPERCALL_ENABLE, and in case it was not it simply sets the HV_X64_MSR_GUEST_OS_ID to 0x1000101010001 which means:build_number = 0x0001service_version = 0x01minor_version = 0x01major_version = 0x01os_id = 0x00 (Undefined)vendor_id = 1 (Microsoft)os_type = 0 (A value of 0 indicates a proprietary, closed source OS)
and starts issuing the hypercall without setting the hypercall page.
To resolve this issue simply enable hypercalls also if the guest_os_id is not 0.
--- arch/x86/kvm/hyperv.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
arch/x86/kvm/hyperv.c +4 -1
@@ -1639,7 +1639,10 @@ static u64 kvm_hv_send_ipi(struct kvm_vcpu *current_vcpu, u64 ingpa, u64 outgpa,bool kvm_hv_hypercall_enabled (struct kvm *kvm) { -return READ_ONCE (kvm->arch.hyperv.hv_hypercall) &HV_X64_MSR_HYPERCALL_ENABLE ; +struct kvm_hv *hv = &kvm->arch.hyperv; + +return READ_ONCE (hv->hv_hypercall) &HV_X64_MSR_HYPERCALL_ENABLE || +READ_ONCE (hv->hv_guest_os_id) !=0 ; }static void kvm_hv_hypercall_set_result (struct kvm_vcpu *vcpu,u64 result)
Signature · 1 line
2.24.1
PATCH v6 5/5 x86/kvm/hyper-v: Add support for synthetic debugger via hypercalls
In reply to Jon DoronThere is another mode for the synthetic debugger which uses hypercalls to send/recv network data instead of the MSR interface.
This interface is much slower and less recommended since you might get a lot of VMExits while KDVM polling for new packets to recv, rather than simply checking the pending page to see if there is data avialble and then request.
--- arch/x86/kvm/hyperv.c | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+)
arch/x86/kvm/hyperv.c +22 -0
@@ -1821,6 +1821,28 @@ int kvm_hv_hypercall(struct kvm_vcpu *vcpu) } ret =kvm_hv_send_ipi (vcpu, ingpa, outgpa, true, false);break ; +case HVCALL_POST_DEBUG_DATA : +case HVCALL_RETRIEVE_DEBUG_DATA : +if (unlikely (fast)) { + ret =HV_STATUS_INVALID_PARAMETER ; +break ; + } +/* fallthrough */ +case HVCALL_RESET_DEBUG_SESSION : { +struct kvm_hv_syndbg *syndbg =vcpu_to_hv_syndbg (vcpu); +if (!(syndbg->options &HV_X64_SYNDBG_OPTION_USE_HCALLS )) { + ret =HV_STATUS_OPERATION_DENIED ; +break ; + } + vcpu->run->exit_reason =KVM_EXIT_HYPERV ; + vcpu->run->hyperv.type =KVM_EXIT_HYPERV_HCALL ; + vcpu->run->hyperv.u.hcall.input = param; + vcpu->run->hyperv.u.hcall.params[0 ] = ingpa; + vcpu->run->hyperv.u.hcall.params[1 ] = outgpa; + vcpu->arch.complete_userspace_io = + kvm_hv_hypercall_complete_userspace; +return 0 ; + }default : ret =HV_STATUS_INVALID_HYPERCALL_CODE ;break ;
Signature · 1 line
2.24.1
Re: [PATCH v6 1/5] x86/kvm/hyper-v: Explicitly align hcall param for kvm_hyperv_exit
In reply to Jon DoronQuoted 28 lines · Jon Doron
Signed-off-by Jon Doron <[email protected]>--- Documentation/virt/kvm/api.rst | 2 ++ include/uapi/linux/kvm.h | 2 ++ 2 files changed, 4 insertions(+)Documentation/virt/kvm/api.rst +2
-0@@ -5025,9 +5025,11 @@ EOI was received. #define KVM_EXIT_HYPERV_SYNIC 1 #define KVM_EXIT_HYPERV_HCALL 2 __u32 type; + __u32 pad1; union { struct { __u32 msr; + __u32 pad2; __u64 control; __u64 evt_page; __u64 msg_page;include/uapi/linux/kvm.h +0
-0@@ -189,9 +189,11 @@ struct kvm_hyperv_exit {#define KVM_EXIT_HYPERV_SYNIC 1
include/uapi/linux/kvm.h struct kvm_hyperv_exit { · line 199
Quoted 10 lines
include/uapi/linux/kvm.h +2
-0#define KVM_EXIT_HYPERV_HCALL 2__u32 type; +__u32 pad1;union {struct {__u32 msr; +__u32 pad2;__u64 control;__u64 evt_page;__u64 msg_page;
This looks good to me but probably not to an unprepared reader some time later. What's going on here is:
The problem the patch is trying to address is the fact that 'struct kvm_hyperv_exit' has different layout on when compiling in 32 and 64 bit modes. In 64-bit mode the default alignment boundary is 64 bits thus forcing extra gaps after 'type' and 'msr' but in 32-bit mode the boundary is at 32 bits thus no extra gaps. This is an issue as even when the kernel is 64 bit, the userspace using the interface can be both 32 and 64 bit but the same 32 bit userspace has to work with 32 bit kernel. The issue is fixed by forcing the 64 bit layout, this leads to ABI change for 32 bit builds and while we are obviously breaking '32 bit userspace with 32 bit kernel' case, we're fixing the '32 bit userspace with 64 bit kernel' one. As the interface has no (known) users and 32 bit KVM is rather baroque nowadays, this seems like a reasonable decision.
I think something like the paragraph above should be the commit message. With this fixed,
Signature · 1 line
Vitaly
Vitaly Kuznetsov
maintainerRe: [PATCH v6 3/5] x86/kvm/hyper-v: Add support for synthetic debugger capability
In reply to Jon DoronQuoted 121 lines · Jon Doron
Add support for Hyper-V synthetic debugger (syndbg) interface. The syndbg interface is using MSRs to emulate a way to send/recv packets data.
The debug transport dll (kdvm/kdnet) will identify if Hyper-V is enabled and if it supports the synthetic debugger interface it will attempt to use it, instead of trying to initialize a network adapter.
Signed-off-by Jon Doron <[email protected]>--- Documentation/virt/kvm/api.rst | 16 ++++ arch/x86/include/asm/kvm_host.h | 13 +++ arch/x86/kvm/hyperv.c | 135 +++++++++++++++++++++++++++++++- arch/x86/kvm/hyperv.h | 5 ++ arch/x86/kvm/trace.h | 51 ++++++++++++ arch/x86/kvm/x86.c | 9 +++ include/uapi/linux/kvm.h | 11 +++ 7 files changed, 239 insertions(+), 1 deletion(-)Documentation/virt/kvm/api.rst +16
-0@@ -5024,6 +5024,7 @@ EOI was received. struct kvm_hyperv_exit { #define KVM_EXIT_HYPERV_SYNIC 1 #define KVM_EXIT_HYPERV_HCALL 2 + #define KVM_EXIT_HYPERV_SYNDBG 3 __u32 type; __u32 pad1; union {@@ -5039,6 +5040,15 @@ EOI was received. __u64 result; __u64 params[2]; } hcall; + struct { + __u32 msr; + __u32 pad2; + __u64 control; + __u64 status; + __u64 send_page; + __u64 recv_page; + __u64 pending_page; + } syndbg; } u; }; /* KVM_EXIT_HYPERV */@@ -5055,6 +5065,12 @@ Hyper-V SynIC state change. Notification is used to remap SynIC event/message pages and to enable/disable SynIC messages/events processing in userspace. + - KVM_EXIT_HYPERV_SYNDBG -- synchronously notify user-space about + +Hyper-V Synthetic debugger state change. Notification is used to either update +the pending_page location or to send a control command (send the buffer located +in send_page or recv a buffer to recv_page). + :: /* KVM_EXIT_ARM_NISV */arch/x86/include/asm/kvm_host.h +13
-0@@ -854,6 +854,18 @@ struct kvm_apic_map {struct kvm_lapic *phys_map[]; }; +/* Hyper-V synthetic debugger (SynDbg)*/ +struct kvm_hv_syndbg { +struct { +u64 control; +u64 status; +u64 send_page; +u64 recv_page; +u64 pending_page; + } control; +u64 options; +}; +/* Hyper-V emulation context */ struct kvm_hv {struct mutex hv_lock;@@ -877,6 +889,7 @@ struct kvm_hv {atomic_t num_mismatched_vp_indexes;struct hv_partition_assist_pg *hv_pa_pg; +struct kvm_hv_syndbg hv_syndbg; };enum kvm_irqchip_mode {arch/x86/kvm/hyperv.c +22
-0@@ -266,6 +266,107 @@ static int synic_set_msr(struct kvm_vcpu_hv_synic *synic,return ret; } +static int kvm_hv_syndbg_complete_userspace (struct kvm_vcpu *vcpu) +{ +struct kvm *kvm = vcpu->kvm; +struct kvm_hv *hv = &kvm->arch.hyperv; + +if (vcpu->run->hyperv.u.syndbg.msr ==HV_X64_MSR_SYNDBG_CONTROL ) + hv->hv_syndbg.control.status = + vcpu->run->hyperv.u.syndbg.status; +return 1 ; +} + +static void syndbg_exit (struct kvm_vcpu *vcpu,u32 msr) +{ +struct kvm_hv_syndbg *syndbg =vcpu_to_hv_syndbg (vcpu); +struct kvm_vcpu_hv *hv_vcpu = &vcpu->arch.hyperv; + + hv_vcpu->exit.type =KVM_EXIT_HYPERV_SYNDBG ; + hv_vcpu->exit.u.syndbg.msr = msr; + hv_vcpu->exit.u.syndbg.control = syndbg->control.control; + hv_vcpu->exit.u.syndbg.send_page = syndbg->control.send_page; + hv_vcpu->exit.u.syndbg.recv_page = syndbg->control.recv_page; + hv_vcpu->exit.u.syndbg.pending_page = syndbg->control.pending_page;
arch/x86/kvm/hyperv.c static int synic_set_msr(struct kvm_vcpu_hv_synic *synic, · line 300
Quoted 10 lines
arch/x86/kvm/hyperv.c +10
-0+ vcpu->arch.complete_userspace_io = + kvm_hv_syndbg_complete_userspace; + +kvm_make_request (KVM_REQ_HV_EXIT , vcpu); +} + +static int syndbg_set_msr (struct kvm_vcpu *vcpu,u32 msr,u64 data) +{ +struct kvm_hv_syndbg *syndbg =vcpu_to_hv_syndbg (vcpu); +int ret;
Minor nitpick: you could've initialized 'ret' to '0' here. But actually, looking at the code, you don't really need the return value as 'default' case can just BUG(): this can never happen. The whole function can be 'void'.
Quoted 29 lines
arch/x86/kvm/hyperv.c +29
-0+ +trace_kvm_hv_syndbg_set_msr (vcpu->vcpu_id, +vcpu_to_hv_vcpu (vcpu)->vp_index, msr, data); + ret =0 ; +switch (msr) { +case HV_X64_MSR_SYNDBG_CONTROL : + syndbg->control.control = data; +syndbg_exit (vcpu, msr); +break ; +case HV_X64_MSR_SYNDBG_STATUS : + syndbg->control.status = data; +break ; +case HV_X64_MSR_SYNDBG_SEND_BUFFER : + syndbg->control.send_page = data; +break ; +case HV_X64_MSR_SYNDBG_RECV_BUFFER : + syndbg->control.recv_page = data; +break ; +case HV_X64_MSR_SYNDBG_PENDING_BUFFER : + syndbg->control.pending_page = data; +syndbg_exit (vcpu, msr); +break ; +case HV_X64_MSR_SYNDBG_OPTIONS : + syndbg->options = data; +break ; +default : + ret =1 ; +break ; + }
arch/x86/kvm/hyperv.c static int synic_set_msr(struct kvm_vcpu_hv_synic *synic, · line 339
Quoted 10 lines
arch/x86/kvm/hyperv.c +10
-0+ +return ret; +} + +static int syndbg_get_msr (struct kvm_vcpu *vcpu,u32 msr,u64 *pdata) +{ +struct kvm_hv_syndbg *syndbg =vcpu_to_hv_syndbg (vcpu); +int ret; + + ret =0 ;
Same comment as the above.
Quoted 73 lines
arch/x86/kvm/hyperv.c +41
-0+switch (msr) { +case HV_X64_MSR_SYNDBG_CONTROL : + *pdata = syndbg->control.control; +break ; +case HV_X64_MSR_SYNDBG_STATUS : + *pdata = syndbg->control.status; +break ; +case HV_X64_MSR_SYNDBG_SEND_BUFFER : + *pdata = syndbg->control.send_page; +break ; +case HV_X64_MSR_SYNDBG_RECV_BUFFER : + *pdata = syndbg->control.recv_page; +break ; +case HV_X64_MSR_SYNDBG_PENDING_BUFFER : + *pdata = syndbg->control.pending_page; +break ; +case HV_X64_MSR_SYNDBG_OPTIONS : + *pdata = syndbg->options; +break ; +default : + ret =1 ; +break ; + } + +trace_kvm_hv_syndbg_get_msr (vcpu->vcpu_id, +vcpu_to_hv_vcpu (vcpu)->vp_index, msr, + *pdata); +return ret; +} +static int synic_get_msr (struct kvm_vcpu_hv_synic *synic,u32 msr,u64 *pdata,bool host) {@@ -800,6 +901,8 @@ static bool kvm_hv_msr_partition_wide(u32 msr)case HV_X64_MSR_REENLIGHTENMENT_CONTROL :case HV_X64_MSR_TSC_EMULATION_CONTROL :case HV_X64_MSR_TSC_EMULATION_STATUS : +case HV_X64_MSR_SYNDBG_OPTIONS : + case HV_X64_MSR_SYNDBG_CONTROL ... HV_X64_MSR_SYNDBG_PENDING_BUFFER: r = true;break ; }@@ -1061,6 +1164,9 @@ static int kvm_hv_set_msr_pw(struct kvm_vcpu *vcpu, u32 msr, u64 data,if (!host)return 1 ;break ; +case HV_X64_MSR_SYNDBG_OPTIONS : + case HV_X64_MSR_SYNDBG_CONTROL ... HV_X64_MSR_SYNDBG_PENDING_BUFFER: +return syndbg_set_msr (vcpu, msr, data);default :vcpu_unimpl (vcpu,"Hyper-V unhandled wrmsr: 0x%x data 0x%llx\n" , msr, data);@@ -1227,6 +1333,9 @@ static int kvm_hv_get_msr_pw(struct kvm_vcpu *vcpu, u32 msr, u64 *pdata)case HV_X64_MSR_TSC_EMULATION_STATUS : data = hv->hv_tsc_emulation_status;break ; +case HV_X64_MSR_SYNDBG_OPTIONS : + case HV_X64_MSR_SYNDBG_CONTROL ... HV_X64_MSR_SYNDBG_PENDING_BUFFER: +return syndbg_get_msr (vcpu, msr, pdata);default :vcpu_unimpl (vcpu,"Hyper-V unhandled rdmsr: 0x%x\n" , msr);return 1 ;@@ -1797,6 +1906,9 @@ int kvm_vcpu_ioctl_get_hv_cpuid(struct kvm_vcpu *vcpu, struct kvm_cpuid2 *cpuid, { .function = HYPERV_CPUID_ENLIGHTMENT_INFO }, { .function = HYPERV_CPUID_IMPLEMENT_LIMITS }, { .function = HYPERV_CPUID_NESTED_FEATURES }, + { .function = HYPERV_CPUID_SYNDBG_VENDOR_AND_MAX_FUNCTIONS }, + { .function = HYPERV_CPUID_SYNDBG_INTERFACE }, + { .function = HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES }, };int i, nent =ARRAY_SIZE (cpuid_entries);
arch/x86/kvm/hyperv.c int kvm_vcpu_ioctl_get_hv_cpuid(struct kvm_vcpu *vcpu, struct kvm_cpuid2 *cpuid, · line 1936
Quoted 5 lines
arch/x86/kvm/hyperv.c +1
-1@@ -1821,7 +1933,7 @@ int kvm_vcpu_ioctl_get_hv_cpuid(struct kvm_vcpu *vcpu, struct kvm_cpuid2 *cpuid,case HYPERV_CPUID_VENDOR_AND_MAX_FUNCTIONS :memcpy (signature,"Linux KVM Hv" ,12 ); - ent->eax =HYPERV_CPUID_NESTED_FEATURES ; + ent->eax =HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES ;
This should depend on KVM_CAP_HYPERV_DEBUGGING being enabled (see below).
Quoted 153 lines
arch/x86/kvm/hyperv.c +21
-0ent->ebx = signature[0 ]; ent->ecx = signature[1 ]; ent->edx = signature[2 ];@@ -1856,9 +1968,12 @@ int kvm_vcpu_ioctl_get_hv_cpuid(struct kvm_vcpu *vcpu, struct kvm_cpuid2 *cpuid, ent->ebx |=HV_X64_POST_MESSAGES ; ent->ebx |=HV_X64_SIGNAL_EVENTS ; + ent->ebx |=HV_X64_DEBUGGING ; ent->edx |=HV_FEATURE_FREQUENCY_MSRS_AVAILABLE ; ent->edx |=HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE ; + ent->edx |=HV_X64_GUEST_DEBUGGING_AVAILABLE ; + ent->edx |=HV_FEATURE_DEBUG_MSRS_AVAILABLE ;/* * Direct Synthetic timers only make sense with in-kernel @@ -1903,6 +2018,24 @@ int kvm_vcpu_ioctl_get_hv_cpuid(struct kvm_vcpu *vcpu, struct kvm_cpuid2 *cpuid,break ; +case HYPERV_CPUID_SYNDBG_VENDOR_AND_MAX_FUNCTIONS : +memcpy (signature,"Linux KVM Hv" ,12 ); + + ent->eax =0 ; + ent->ebx = signature[0 ]; + ent->ecx = signature[1 ]; + ent->edx = signature[2 ]; +break ; + +case HYPERV_CPUID_SYNDBG_INTERFACE : +memcpy (signature,"VS#1\0\0\0\0\0\0\0\0" ,12 ); + ent->eax = signature[0 ]; +break ; + +case HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES : + ent->eax |=HV_X64_SYNDBG_CAP_ALLOW_KERNEL_DEBUGGING ; +break ; +default :break ; }arch/x86/kvm/hyperv.h +5
-0@@ -73,6 +73,11 @@ static inline struct kvm_vcpu *synic_to_vcpu(struct kvm_vcpu_hv_synic *synic) return hv_vcpu_to_vcpu(container_of(synic, struct kvm_vcpu_hv, synic)); } +static inline struct kvm_hv_syndbg *vcpu_to_hv_syndbg (struct kvm_vcpu *vcpu) +{ +return &vcpu->kvm->arch.hyperv.hv_syndbg; +} +int kvm_hv_set_msr_common (struct kvm_vcpu *vcpu,u32 msr,u64 data,bool host);int kvm_hv_get_msr_common (struct kvm_vcpu *vcpu,u32 msr,u64 *pdata,bool host);arch/x86/kvm/trace.h +51
-0@@ -1515,6 +1515,57 @@ TRACE_EVENT(kvm_nested_vmenter_failed, __print_symbolic(__entry->err, VMX_VMENTER_INSTRUCTION_ERRORS)) ); +/* +* Tracepoint for syndbg_set_msr. +*/ +TRACE_EVENT (kvm_hv_syndbg_set_msr, + TP_PROTO(int vcpu_id, u32 vp_index, u32 msr, u64 data), +TP_ARGS (vcpu_id, vp_index, msr, data), + +TP_STRUCT__entry ( + __field(int, vcpu_id) + __field(u32, vp_index) + __field(u32, msr) +__field (u64, data) + ), + +TP_fast_assign ( + __entry->vcpu_id = vcpu_id; + __entry->vp_index = vp_index; + __entry->msr = msr; + __entry->data = data; + ), + +TP_printk ("vcpu_id %d vp_index %u msr 0x%x data 0x%llx" , + __entry->vcpu_id, __entry->vp_index, __entry->msr, + __entry->data) +); + +/* +* Tracepoint for syndbg_get_msr. +*/ +TRACE_EVENT (kvm_hv_syndbg_get_msr, + TP_PROTO(int vcpu_id, u32 vp_index, u32 msr, u64 data), +TP_ARGS (vcpu_id, vp_index, msr, data), + +TP_STRUCT__entry ( + __field(int, vcpu_id) + __field(u32, vp_index) + __field(u32, msr) +__field (u64, data) + ), + +TP_fast_assign ( + __entry->vcpu_id = vcpu_id; + __entry->vp_index = vp_index; + __entry->msr = msr; + __entry->data = data; + ), + +TP_printk ("vcpu_id %d vp_index %u msr 0x%x data 0x%llx" , + __entry->vcpu_id, __entry->vp_index, __entry->msr, + __entry->data) +);#endif /* _TRACE_KVM_H */ #undef TRACE_INCLUDE_PATHarch/x86/kvm/x86.c +8
-0@@ -1214,6 +1214,10 @@ static const u32 emulated_msrs_all[] = {HV_X64_MSR_VP_ASSIST_PAGE ,HV_X64_MSR_REENLIGHTENMENT_CONTROL ,HV_X64_MSR_TSC_EMULATION_CONTROL ,HV_X64_MSR_TSC_EMULATION_STATUS , +HV_X64_MSR_SYNDBG_OPTIONS , +HV_X64_MSR_SYNDBG_CONTROL ,HV_X64_MSR_SYNDBG_STATUS , +HV_X64_MSR_SYNDBG_SEND_BUFFER ,HV_X64_MSR_SYNDBG_RECV_BUFFER , +HV_X64_MSR_SYNDBG_PENDING_BUFFER ,MSR_KVM_ASYNC_PF_EN ,MSR_KVM_STEAL_TIME , MSR_KVM_PV_EOI_EN,@@ -2906,6 +2910,8 @@ int kvm_set_msr_common(struct kvm_vcpu *vcpu, struct msr_data *msr_info)*/ break ; case HV_X64_MSR_GUEST_OS_ID ... HV_X64_MSR_SINT15: + case HV_X64_MSR_SYNDBG_CONTROL ... HV_X64_MSR_SYNDBG_PENDING_BUFFER: +case HV_X64_MSR_SYNDBG_OPTIONS : case HV_X64_MSR_CRASH_P0 ... HV_X64_MSR_CRASH_P4:case HV_X64_MSR_CRASH_CTL : case HV_X64_MSR_STIMER0_CONFIG ... HV_X64_MSR_STIMER3_COUNT:@@ -3151,6 +3157,8 @@ int kvm_get_msr_common(struct kvm_vcpu *vcpu, struct msr_data *msr_info) msr_info->data =0x20000000 ;break ; case HV_X64_MSR_GUEST_OS_ID ... HV_X64_MSR_SINT15: + case HV_X64_MSR_SYNDBG_CONTROL ... HV_X64_MSR_SYNDBG_PENDING_BUFFER: +case HV_X64_MSR_SYNDBG_OPTIONS : case HV_X64_MSR_CRASH_P0 ... HV_X64_MSR_CRASH_P4:case HV_X64_MSR_CRASH_CTL : case HV_X64_MSR_STIMER0_CONFIG ... HV_X64_MSR_STIMER3_COUNT:
arch/x86/kvm/x86.c int kvm_vm_ioctl_check_extension(struct kvm *kvm, long ext) · line 3334
Quoted 4 lines
arch/x86/kvm/x86.c +1
-0@@ -3323,6 +3331,7 @@ int kvm_vm_ioctl_check_extension(struct kvm *kvm, long ext)case KVM_CAP_HYPERV_TLBFLUSH :case KVM_CAP_HYPERV_SEND_IPI :case KVM_CAP_HYPERV_CPUID : +case KVM_CAP_HYPERV_DEBUGGING :
This is not enough: the userspace actually need to enable KVM_CAP_HYPERV_DEBUGGING to start receiving KVM_EXIT_HYPERV_SYNDBG. (see kvm_vcpu_ioctl_enable_cap()) Whem the capability is disabled, we should likely forbid writing to these debug MSRs.
The problem here is: what if an unprepared userspace receives KVM_EXIT_HYPERV_SYNDBG? It will likely crash or misbehave (and this is guest triggerable!) so we need to prevent this.
Quoted 32 lines
arch/x86/kvm/x86.c +0
-0case KVM_CAP_PCI_SEGMENT :case KVM_CAP_DEBUGREGS :case KVM_CAP_X86_ROBUST_SINGLESTEP :include/uapi/linux/kvm.h +10
-0@@ -188,6 +188,7 @@ struct kvm_s390_cmma_log {struct kvm_hyperv_exit {#define KVM_EXIT_HYPERV_SYNIC 1#define KVM_EXIT_HYPERV_HCALL 2 +#define KVM_EXIT_HYPERV_SYNDBG 3__u32 type;__u32 pad1;union {@@ -203,6 +204,15 @@ struct kvm_hyperv_exit {__u64 result;__u64 params[2 ]; } hcall; +struct { +__u32 msr; +__u32 pad2; +__u64 control; +__u64 status; +__u64 send_page; +__u64 recv_page; +__u64 pending_page; + } syndbg; } u; };
include/uapi/linux/kvm.h struct kvm_ppc_resize_hpt { · line 1025
Quoted 4 lines
include/uapi/linux/kvm.h +1
-0@@ -1012,6 +1022,7 @@ struct kvm_ppc_resize_hpt {#define KVM_CAP_ARM_NISV_TO_USER 177#define KVM_CAP_ARM_INJECT_EXT_DABT 178#define KVM_CAP_S390_VCPU_RESETS 179 +#define KVM_CAP_HYPERV_DEBUGGING 180
I'd name this KVM_CAP_HYPERV_SYNDBG to not cause confusion.
Quoted 2 lines
include/uapi/linux/kvm.h +0
-0#ifdef KVM_CAP_IRQ_ROUTING
Signature · 1 line
Vitaly
Vitaly Kuznetsov
maintainerRe: [PATCH v6 4/5] x86/kvm/hyper-v: enable hypercalls regardless of hypercall page
In reply to Jon DoronQuoted 33 lines · Jon Doron
Microsoft's kdvm.dll dbgtransport module does not respect the hypercall page and simply identifies the CPU being used (AMD/Intel) and according to it simply makes hypercalls with the relevant instruction (vmmcall/vmcall respectively).
The relevant function in kdvm is KdHvConnectHypervisor which first checks if the hypercall page has been enabled via
HV_X64_MSR_HYPERCALL_ENABLE, and in case it was not it simply sets theHV_X64_MSR_GUEST_OS_IDto0x1000101010001which means:build_number=0x0001service_version=0x01minor_version=0x01major_version=0x01os_id=0x00(Undefined)vendor_id= 1 (Microsoft)os_type= 0 (A value of 0 indicates a proprietary, closed source OS)and starts issuing the hypercall without setting the hypercall page.
To resolve this issue simply enable hypercalls also if the
guest_os_idis not 0.Signed-off-by Jon Doron <[email protected]>--- arch/x86/kvm/hyperv.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)arch/x86/kvm/hyperv.c +0
-0@@ -1639,7 +1639,10 @@ static u64 kvm_hv_send_ipi(struct kvm_vcpu *current_vcpu, u64 ingpa, u64 outgpa,
arch/x86/kvm/hyperv.c static u64 kvm_hv_send_ipi(struct kvm_vcpu *current_vcpu, u64 ingpa, u64 outgpa, · line 1648
Quoted 10 lines
arch/x86/kvm/hyperv.c +4
-1bool kvm_hv_hypercall_enabled (struct kvm *kvm) { -return READ_ONCE (kvm->arch.hyperv.hv_hypercall) &HV_X64_MSR_HYPERCALL_ENABLE ; +struct kvm_hv *hv = &kvm->arch.hyperv; + +return READ_ONCE (hv->hv_hypercall) &HV_X64_MSR_HYPERCALL_ENABLE || +READ_ONCE (hv->hv_guest_os_id) !=0 ; }static void kvm_hv_hypercall_set_result (struct kvm_vcpu *vcpu,u64 result)
Also, as we're introducing KVM_CAP_HYPERV_DEBUGGING please include it in the check: no need to enable hypercalls without a hypercall page if we haven't enabled KVM_CAP_HYPERV_DEBUGGING (preserve the status quo).
Signature · 1 line
Vitaly
Vitaly Kuznetsov
maintainerRe: [PATCH v6 5/5] x86/kvm/hyper-v: Add support for synthetic debugger via hypercalls
In reply to Jon DoronQuoted 18 lines · Jon Doron
There is another mode for the synthetic debugger which uses hypercalls to send/recv network data instead of the MSR interface.
This interface is much slower and less recommended since you might get a lot of VMExits while KDVM polling for new packets to recv, rather than simply checking the pending page to see if there is data avialble and then request.
Signed-off-by Jon Doron <[email protected]>--- arch/x86/kvm/hyperv.c | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+)arch/x86/kvm/hyperv.c +0
-0
arch/x86/kvm/hyperv.c int kvm_hv_hypercall(struct kvm_vcpu *vcpu) · line 1830
Quoted 10 lines
arch/x86/kvm/hyperv.c +7
-0@@ -1821,6 +1821,28 @@ int kvm_hv_hypercall(struct kvm_vcpu *vcpu) } ret =kvm_hv_send_ipi (vcpu, ingpa, outgpa, true, false);break ; +case HVCALL_POST_DEBUG_DATA : +case HVCALL_RETRIEVE_DEBUG_DATA : +if (unlikely (fast)) { + ret =HV_STATUS_INVALID_PARAMETER ; +break ; + } +/* fallthrough */
This is now being changed to 'fallthrough;'
Quoted 8 lines
arch/x86/kvm/hyperv.c +8
-0+case HVCALL_RESET_DEBUG_SESSION : { +struct kvm_hv_syndbg *syndbg =vcpu_to_hv_syndbg (vcpu); +if (!(syndbg->options &HV_X64_SYNDBG_OPTION_USE_HCALLS )) { + ret =HV_STATUS_OPERATION_DENIED ; +break ; + } + vcpu->run->exit_reason =KVM_EXIT_HYPERV ; + vcpu->run->hyperv.type =KVM_EXIT_HYPERV_HCALL ;
arch/x86/kvm/hyperv.c int kvm_hv_hypercall(struct kvm_vcpu *vcpu) · line 1848
Quoted 10 lines
arch/x86/kvm/hyperv.c +7
-0+ vcpu->run->hyperv.u.hcall.input = param; + vcpu->run->hyperv.u.hcall.params[0 ] = ingpa; + vcpu->run->hyperv.u.hcall.params[1 ] = outgpa; + vcpu->arch.complete_userspace_io = + kvm_hv_hypercall_complete_userspace; +return 0 ; + }default : ret =HV_STATUS_INVALID_HYPERCALL_CODE ;break ;
And the hypercall should also check whether KVM_CAP_HYPERV_DEBUGGING is enabled.
Signature · 1 line
Vitaly