HyperV: Synthetic Debugging device
v3 cover HyperV: Synthetic Debugging device
This patchset adds support for the synthetic debugging device.
HyperV supports a special transport layer for the kernel debugger when running in HyperV.
This patchset add supports for this device so you could have a setup fast windows kernel debugging.
At this point of time, DHCP is not implmeneted so to set this up few things need to be noted.
The scenario I used to test is having 2 VMs in the same virtual network
i.e a Debugger VM with the NIC:
-nic tap,model=virtio,mac=02:ca:01:01:01:01,script=/etc/qemu-ifup
And it's IP is going to be static 192.168.53.12
And the VM we want to debug, to which we need to have the englightments
and vmbus configured:
-cpu host,hv-relaxed,hv_spinlocks=0x1fff,hv_time,+vmx,invtsc,hv-vapic,hv-vpindex,hv-synic,hv-syndbg \
-device vmbus-bridge \
-device hv-syndbg,host_ip=192.168.53.12,host_port=50000,use_hcalls=false \
-nic tap,model=virtio,mac=02:ca:01:01:01:02,script=/etc/qemu-ifup \
Then in the debuggee VM we would setup the kernel debugging in the following way:
If the VM is older than Win8:
* Copy the proper platform kdvm.dll (make sure it's called kdvm.dll even if platform is 32bit) bcdedit /set {GUID} dbgtransport kdvm.dll
bcdedit /set {GUID} loadoptions host_ip="1.2.3.4",host_port="50000",nodhcp bcdedit /set {GUID} debug on
bcdedit /set {GUID} halbreakpoint on
Win8 and late:
bcdedit /dbgsettings net hostip:7.7.7.7 port:50000 nodhcp
This is all the setup that is required to get the synthetic debugger configured correctly.
v3:
Fixed review from Paolo changes from QLIST*RCU to non RCU
Jon Doron (4):
hyperv: SControl is optional to enable SynIc
hyperv: Add definitions for syndbg
hyperv: Add support to process syndbg commands
hw: hyperv: Initial commit for Synthetic Debugging device
docs/hyperv.txt | 15 ++ hw/hyperv/Kconfig | 5 + hw/hyperv/hyperv.c | 352 ++++++++++++++++++++++++--- hw/hyperv/meson.build | 1 + hw/hyperv/syndbg.c | 402 +++++++++++++++++++++++++++++++ include/hw/hyperv/hyperv-proto.h | 52 ++++ include/hw/hyperv/hyperv.h | 58 +++++ target/i386/cpu.c | 2 + target/i386/cpu.h | 7 + target/i386/kvm/hyperv-proto.h | 37 +++ target/i386/kvm/hyperv-stub.c | 6 + target/i386/kvm/hyperv.c | 52 +++- target/i386/kvm/kvm.c | 76 +++++- 13 files changed, 1024 insertions(+), 41 deletions(-) create mode 100644 hw/hyperv/syndbg.c
Signature · 1 line
2.35.1
PATCH v3 1/4 hyperv: SControl is optional to enable SynIc
SynIc can be enabled regardless of the SControl mechanisim which can register a GSI for a given SintRoute.
This behaviour can achived by setting enabling SIMP and then the guest will poll on the message slot.
Once there is another message pending the host will set the message slot with the pending flag.
When the guest polls from the message slot, in case the pending flag is set it will write to the HV_X64_MSR_EOM indicating it has cleared the slot and we can try and push our message again.
--- hw/hyperv/hyperv.c | 109 +++++++++++++++++++++++++++++++-------------- 1 file changed, 76 insertions(+), 33 deletions(-)
hw/hyperv/hyperv.c +76 -33
@@ -27,13 +27,16 @@ struct SynICState {CPUState *cs; -bool enabled; +bool sctl_enabled;hwaddr msg_page_addr;hwaddr event_page_addr;MemoryRegion msg_page_mr;MemoryRegion event_page_mr;struct hyperv_message_page *msg_page;struct hyperv_event_flags_page *event_page; + +QemuMutex sint_routes_mutex; + QLIST_HEAD(, HvSintRoute) sint_routes; };#define TYPE_SYNIC "hyperv-synic"
@@ -51,11 +54,11 @@ static SynICState *get_synic(CPUState *cs)return SYNIC (object_resolve_path_component (OBJECT (cs),"synic" )); } -static void synic_update (SynICState *synic,bool enable, +static void synic_update (SynICState *synic,bool sctl_enable,hwaddr msg_page_addr,hwaddr event_page_addr) { - synic->enabled = enable; + synic->sctl_enabled = sctl_enable;if (synic->msg_page_addr != msg_page_addr) {if (synic->msg_page_addr) { memory_region_del_subregion(get_system_memory(),
@@ -80,7 +83,7 @@ static void synic_update(SynICState *synic, bool enable, } } -void hyperv_synic_update (CPUState *cs,bool enable, +void hyperv_synic_update (CPUState *cs,bool sctl_enable,hwaddr msg_page_addr,hwaddr event_page_addr) {SynICState *synic =get_synic (cs);
@@ -89,7 +92,7 @@ void hyperv_synic_update(CPUState *cs, bool enable,return ; } -synic_update (synic, enable, msg_page_addr, event_page_addr); +synic_update (synic, sctl_enable, msg_page_addr, event_page_addr); }static void synic_realize (DeviceState *dev,Error **errp)
@@ -110,16 +113,20 @@ static void synic_realize(DeviceState *dev, Error **errp) sizeof(*synic->event_page), &error_abort); synic->msg_page =memory_region_get_ram_ptr (&synic->msg_page_mr); synic->event_page =memory_region_get_ram_ptr (&synic->event_page_mr); +qemu_mutex_init (&synic->sint_routes_mutex); +QLIST_INIT (&synic->sint_routes);g_free (msgp_name);g_free (eventp_name); } +static void synic_reset (DeviceState *dev) {SynICState *synic =SYNIC (dev);memset (synic->msg_page,0 ,sizeof (*synic->msg_page));memset (synic->event_page,0 ,sizeof (*synic->event_page));synic_update (synic, false,0 ,0 ); +assert (QLIST_EMPTY (&synic->sint_routes)); }static void synic_class_init (ObjectClass *klass,void *data)
@@ -214,6 +221,7 @@ struct HvSintRoute {HvSintStagedMessage *staged_msg;unsigned refcount; +QLIST_ENTRY (HvSintRoute) link; };static CPUState *hyperv_find_vcpu (uint32_t vp_index)
@@ -259,7 +267,7 @@ static void cpu_post_msg(CPUState *cs, run_on_cpu_data data)assert (staged_msg->state ==HV_STAGED_MSG_BUSY ); -if (!synic->enabled || !synic->msg_page_addr) { +if (!synic->msg_page_addr) { staged_msg->status = -ENXIO ; goto posted; }
@@ -343,7 +351,7 @@ int hyperv_set_event_flag(HvSintRoute *sint_route, unsigned eventno)if (eventno >HV_EVENT_FLAGS_COUNT ) {return -EINVAL ; } -if (!synic->enabled || !synic->event_page_addr) { +if (!synic->sctl_enabled || !synic->event_page_addr) {return -ENXIO ; }
@@ -364,11 +372,12 @@ int hyperv_set_event_flag(HvSintRoute *sint_route, unsigned eventno)HvSintRoute *hyperv_sint_route_new (uint32_t vp_index,uint32_t sint,HvSintMsgCb cb,void *cb_data) { -HvSintRoute *sint_route; -EventNotifier *ack_notifier; +HvSintRoute *sint_route =NULL ; +EventNotifier *ack_notifier =NULL ;int r, gsi;CPUState *cs;SynICState *synic; +bool ack_event_initialized = false; cs =hyperv_find_vcpu (vp_index);if (!cs) {
@@ -381,57 +390,77 @@ HvSintRoute *hyperv_sint_route_new(uint32_t vp_index, uint32_t sint, } sint_route =g_new0 (HvSintRoute,1 ); - r =event_notifier_init (&sint_route->sint_set_notifier, false); -if (r) { - goto err; +if (!sint_route) { +return NULL ; } + sint_route->synic = synic; + sint_route->sint = sint; + sint_route->refcount =1 ; ack_notifier = cb ? &sint_route->sint_ack_notifier :NULL ;if (ack_notifier) { sint_route->staged_msg =g_new0 (HvSintStagedMessage,1 ); +if (!sint_route->staged_msg) { + goto cleanup_err_sint; + } sint_route->staged_msg->cb = cb; sint_route->staged_msg->cb_data = cb_data; r =event_notifier_init (ack_notifier, false);if (r) { - goto err_sint_set_notifier; + goto cleanup_err_sint; } -event_notifier_set_handler (ack_notifier, sint_ack_handler); + ack_event_initialized = true; + } + +/* See if we are done or we need to setup a GSI for this SintRoute */ +if (!synic->sctl_enabled) { + goto cleanup; + } + +/* We need to setup a GSI for this SintRoute */ + r =event_notifier_init (&sint_route->sint_set_notifier, false); +if (r) { + goto cleanup_err_sint; } gsi =kvm_irqchip_add_hv_sint_route (kvm_state, vp_index, sint);if (gsi <0 ) { - goto err_gsi; + goto cleanup_err_sint_notifier; } r =kvm_irqchip_add_irqfd_notifier_gsi (kvm_state, &sint_route->sint_set_notifier, ack_notifier, gsi);if (r) { - goto err_irqfd; + goto cleanup_err_irqfd; } sint_route->gsi = gsi; - sint_route->synic = synic; - sint_route->sint = sint; - sint_route->refcount =1 ; - +cleanup: +qemu_mutex_lock (&synic->sint_routes_mutex); +QLIST_INSERT_HEAD (&synic->sint_routes, sint_route, link); +qemu_mutex_unlock (&synic->sint_routes_mutex);return sint_route; -err_irqfd: +cleanup_err_irqfd:kvm_irqchip_release_virq (kvm_state, gsi); -err_gsi: + +cleanup_err_sint_notifier: +event_notifier_cleanup (&sint_route->sint_set_notifier); + +cleanup_err_sint:if (ack_notifier) { -event_notifier_set_handler (ack_notifier,NULL ); -event_notifier_cleanup (ack_notifier); +if (ack_event_initialized) { +event_notifier_set_handler (ack_notifier,NULL ); +event_notifier_cleanup (ack_notifier); + } +g_free (sint_route->staged_msg); } -err_sint_set_notifier: -event_notifier_cleanup (&sint_route->sint_set_notifier); -err: -g_free (sint_route); +g_free (sint_route);return NULL ; }
@@ -442,6 +471,8 @@ void hyperv_sint_route_ref(HvSintRoute *sint_route)void hyperv_sint_route_unref (HvSintRoute *sint_route) { +SynICState *synic; +if (!sint_route) {return ; }
@@ -452,21 +483,33 @@ void hyperv_sint_route_unref(HvSintRoute *sint_route)return ; } -kvm_irqchip_remove_irqfd_notifier_gsi (kvm_state, - &sint_route->sint_set_notifier, - sint_route->gsi); -kvm_irqchip_release_virq (kvm_state, sint_route->gsi); + synic = sint_route->synic; +qemu_mutex_lock (&synic->sint_routes_mutex); +QLIST_REMOVE (sint_route, link); +qemu_mutex_unlock (&synic->sint_routes_mutex); + +if (sint_route->gsi) { +kvm_irqchip_remove_irqfd_notifier_gsi (kvm_state, + &sint_route->sint_set_notifier, + sint_route->gsi); +kvm_irqchip_release_virq (kvm_state, sint_route->gsi); +event_notifier_cleanup (&sint_route->sint_set_notifier); + } +if (sint_route->staged_msg) {event_notifier_set_handler (&sint_route->sint_ack_notifier,NULL );event_notifier_cleanup (&sint_route->sint_ack_notifier);g_free (sint_route->staged_msg); } -event_notifier_cleanup (&sint_route->sint_set_notifier);g_free (sint_route); }int hyperv_sint_route_set_sint (HvSintRoute *sint_route) { +if (!sint_route->gsi) { +return 0 ; + } +return event_notifier_set (&sint_route->sint_set_notifier); }
Signature · 1 line
2.35.1
PATCH v3 2/4 hyperv: Add definitions for syndbg
In reply to Jon DoronAdd all required definitions for hyperv synthetic debugger interface.
--- include/hw/hyperv/hyperv-proto.h | 52 ++++++++++++++++++++++++++++++++ target/i386/kvm/hyperv-proto.h | 37 +++++++++++++++++++++++ 2 files changed, 89 insertions(+)
include/hw/hyperv/hyperv-proto.h +52 -0
@@ -24,12 +24,17 @@#define HV_STATUS_INVALID_PORT_ID 17#define HV_STATUS_INVALID_CONNECTION_ID 18#define HV_STATUS_INSUFFICIENT_BUFFERS 19 +#define HV_STATUS_NOT_ACKNOWLEDGED 20 +#define HV_STATUS_NO_DATA 27/* * Hypercall numbers */ #define HV_POST_MESSAGE 0x005c#define HV_SIGNAL_EVENT 0x005d +#define HV_POST_DEBUG_DATA 0x0069 +#define HV_RETRIEVE_DEBUG_DATA 0x006a +#define HV_RESET_DEBUG_SESSION 0x006b#define HV_HYPERCALL_FAST (1u << 16)/*
@@ -127,4 +132,51 @@ struct hyperv_event_flags_page { struct hyperv_event_flags slot[HV_SINT_COUNT]; }; +/* +* Kernel debugger structures +*/ + +/* Options flags for hyperv_reset_debug_session */ +#define HV_DEBUG_PURGE_INCOMING_DATA 0x00000001 +#define HV_DEBUG_PURGE_OUTGOING_DATA 0x00000002 +struct hyperv_reset_debug_session_input { +uint32_t options; +} __attribute__ ((__packed__ )); + +struct hyperv_reset_debug_session_output { +uint32_t host_ip; +uint32_t target_ip; +uint16_t host_port; +uint16_t target_port; +uint8_t host_mac[6 ]; +uint8_t target_mac[6 ]; +} __attribute__ ((__packed__ )); + +/* Options for hyperv_post_debug_data */ +#define HV_DEBUG_POST_LOOP 0x00000001 + +struct hyperv_post_debug_data_input { +uint32_t count; +uint32_t options; +/*uint8_t data[HV_HYP_PAGE_SIZE - 2 * sizeof(uint32_t)];*/ +} __attribute__ ((__packed__ )); + +struct hyperv_post_debug_data_output { +uint32_t pending_count; +} __attribute__ ((__packed__ )); + +/* Options for hyperv_retrieve_debug_data */ +#define HV_DEBUG_RETRIEVE_LOOP 0x00000001 +#define HV_DEBUG_RETRIEVE_TEST_ACTIVITY 0x00000002 + +struct hyperv_retrieve_debug_data_input { +uint32_t count; +uint32_t options; +uint64_t timeout; +} __attribute__ ((__packed__ )); + +struct hyperv_retrieve_debug_data_output { +uint32_t retrieved_count; +uint32_t remaining_count; +} __attribute__ ((__packed__ ));#endif
target/i386/kvm/hyperv-proto.h +37 -0
@@ -19,6 +19,9 @@#define HV_CPUID_ENLIGHTMENT_INFO 0x40000004#define HV_CPUID_IMPLEMENT_LIMITS 0x40000005#define HV_CPUID_NESTED_FEATURES 0x4000000A +#define HV_CPUID_SYNDBG_VENDOR_AND_MAX_FUNCTIONS 0x40000080 +#define HV_CPUID_SYNDBG_INTERFACE 0x40000081 +#define HV_CPUID_SYNDBG_PLATFORM_CAPABILITIES 0x40000082#define HV_CPUID_MIN 0x40000005#define HV_CPUID_MAX 0x4000ffff#define HV_HYPERVISOR_PRESENT_BIT 0x80000000
@@ -55,8 +58,14 @@#define HV_GUEST_IDLE_STATE_AVAILABLE (1u << 5)#define HV_FREQUENCY_MSRS_AVAILABLE (1u << 8)#define HV_GUEST_CRASH_MSR_AVAILABLE (1u << 10) +#define HV_FEATURE_DEBUG_MSRS_AVAILABLE (1u << 11)#define HV_STIMER_DIRECT_MODE_AVAILABLE (1u << 19) +/* +* HV_CPUID_FEATURES.EBX bits +*/ +#define HV_PARTITION_DEBUGGING_ALLOWED (1u << 12) +/* * HV_CPUID_ENLIGHTMENT_INFO.EAX bits */
@@ -72,6 +81,11 @@#define HV_ENLIGHTENED_VMCS_RECOMMENDED (1u << 14)#define HV_NO_NONARCH_CORESHARING (1u << 18) +/* +* HV_CPUID_SYNDBG_PLATFORM_CAPABILITIES.EAX bits +*/ +#define HV_SYNDBG_CAP_ALLOW_KERNEL_DEBUGGING (1u << 1) +/* * Basic virtualized MSRs */
@@ -130,6 +144,18 @@#define HV_X64_MSR_STIMER3_CONFIG 0x400000B6#define HV_X64_MSR_STIMER3_COUNT 0x400000B7 +/* +* 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 + +#define HV_X64_SYNDBG_OPTION_USE_HCALLS BIT(2) +/* * Guest crash notification MSRs */
@@ -168,5 +194,16 @@#define HV_STIMER_COUNT 4 +/* +* Synthetic debugger control definitions +*/ +#define HV_SYNDBG_CONTROL_SEND (1u << 0) +#define HV_SYNDBG_CONTROL_RECV (1u << 1) +#define HV_SYNDBG_CONTROL_SEND_SIZE (ctl) ((ctl >> 16) & 0xffff) +#define HV_SYNDBG_STATUS_INVALID (0) +#define HV_SYNDBG_STATUS_SEND_SUCCESS (1u << 0) +#define HV_SYNDBG_STATUS_RECV_SUCCESS (1u << 2) +#define HV_SYNDBG_STATUS_RESET (1u << 3) +#define HV_SYNDBG_STATUS_SET_SIZE (st, sz) (st | (sz << 16))#endif
Signature · 1 line
2.35.1
PATCH v3 3/4 hyperv: Add support to process syndbg commands
In reply to Jon DoronSynDbg commands can come from two different flows:
1. Hypercalls, in this mode the data being sent is fully encapsulated network packets.
2. SynDbg specific MSRs, in this mode only the data that needs to be transfered is passed.
--- docs/hyperv.txt | 15 +++ hw/hyperv/hyperv.c | 243 ++++++++++++++++++++++++++++++++++ include/hw/hyperv/hyperv.h | 58 ++++++++ target/i386/cpu.c | 2 + target/i386/cpu.h | 7 + target/i386/kvm/hyperv-stub.c | 6 + target/i386/kvm/hyperv.c | 52 +++++++- target/i386/kvm/kvm.c | 76 ++++++++++- 8 files changed, 451 insertions(+), 8 deletions(-)
docs/hyperv.txt +15 -0
@@ -225,6 +225,21 @@ default (WS2016). Note: hv-version-id-* are not enlightenments and thus don't enable Hyper-V identification when specified without any other enlightenments. +3.21. hv-syndbg +=============== +Enables Hyper-V synthetic debugger interface, this is a special interface used +by Windows Kernel debugger to send the packets through, rather than sending +them via serial/network . +When enabled, this enlightenment provides additional communication facilities +to the guest: SynDbg messages. +This new communication is used by Windows Kernel debugger rather than sending +packets via serial/network, adding significant performance boost over the other +comm channels. +This enlightenment requires a VMBus device (-device vmbus-bridge,irq=15) +and the follow enlightenments to work: +hv-relaxed,hv_time,hv-vapic,hv-vpindex,hv-synic,hv-runtime,hv-stimer + + 4. Supplementary features =========================
hw/hyperv/hyperv.c +243 -0
246 lines not on this page · raw message
include/hw/hyperv/hyperv.h +58 -0
62 lines not on this page · raw message
target/i386/cpu.c +2 -0
@@ -6841,6 +6841,8 @@ static Property x86_cpu_properties[] = { HYPERV_FEAT_AVIC, 0),DEFINE_PROP_ON_OFF_AUTO ("hv-no-nonarch-coresharing" ,X86CPU , hyperv_no_nonarch_cs,ON_OFF_AUTO_OFF ), +DEFINE_PROP_BIT64 ("hv-syndbg" ,X86CPU , hyperv_features, +HYPERV_FEAT_SYNDBG ,0 ),DEFINE_PROP_BOOL ("hv-passthrough" ,X86CPU , hyperv_passthrough, false), DEFINE_PROP_BOOL("hv-enforce-cpuid", X86CPU, hyperv_enforce_cpuid, false),
target/i386/cpu.h +7 -0
@@ -1060,6 +1060,7 @@ typedef uint64_t FeatureWordArray[FEATURE_WORDS];#define HYPERV_FEAT_IPI 13#define HYPERV_FEAT_STIMER_DIRECT 14#define HYPERV_FEAT_AVIC 15 +#define HYPERV_FEAT_SYNDBG 16#ifndef HYPERV_SPINLOCK_NEVER_NOTIFY #define HYPERV_SPINLOCK_NEVER_NOTIFY 0xFFFFFFFF
@@ -1560,6 +1561,12 @@ typedef struct CPUX86State {uint64_t msr_hv_hypercall;uint64_t msr_hv_guest_os_id;uint64_t msr_hv_tsc; +uint64_t msr_hv_syndbg_control; +uint64_t msr_hv_syndbg_status; +uint64_t msr_hv_syndbg_send_page; +uint64_t msr_hv_syndbg_recv_page; +uint64_t msr_hv_syndbg_pending_page; +uint64_t msr_hv_syndbg_options;/* Per-VCPU HV MSRs */ uint64_t msr_hv_vapic;
target/i386/kvm/hyperv-stub.c +6 -0
@@ -27,6 +27,12 @@ int kvm_hv_handle_exit(X86CPU *cpu, struct kvm_hyperv_exit *exit)return 0 ;case KVM_EXIT_HYPERV_HCALL : exit->u.hcall.result =HV_STATUS_INVALID_HYPERCALL_CODE ; +return 0 ; +case KVM_EXIT_HYPERV_SYNDBG : +if (!hyperv_feat_enabled (cpu,HYPERV_FEAT_SYNDBG )) { +return -1 ; + } +return 0 ;default :return -1 ;
target/i386/kvm/hyperv.c +49 -3
69 lines not on this page · raw message
target/i386/kvm/kvm.c +71 -5
139 lines not on this page · raw message
Signature · 1 line
2.35.1
PATCH v3 4/4 hw: hyperv: Initial commit for Synthetic Debugging device
In reply to Jon Doron--- hw/hyperv/Kconfig | 5 + hw/hyperv/meson.build | 1 + hw/hyperv/syndbg.c | 402 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 408 insertions(+) create mode 100644 hw/hyperv/syndbg.c
hw/hyperv/Kconfig +5 -0
@@ -11,3 +11,8 @@ config VMBUS bool default y depends on HYPERV + +config SYNDBG + bool + default y + depends on VMBUS
hw/hyperv/meson.build +1 -0
@@ -1,3 +1,4 @@ specific_ss.add(when: 'CONFIG_HYPERV', if_true: files('hyperv.c')) specific_ss.add(when: 'CONFIG_HYPERV_TESTDEV', if_true: files('hyperv_testdev.c')) specific_ss.add(when: 'CONFIG_VMBUS', if_true: files('vmbus.c')) +specific_ss.add(when: 'CONFIG_SYNDBG', if_true: files('syndbg.c'))
hw/hyperv/syndbg.c new file +402 -0
402 lines not on this page · raw message
Signature · 1 line
2.35.1
Paolo Bonzini
AppliedQueued, thanks.
Paolo