[linux-block.git] / arch / x86 / kvm / hyperv.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * KVM Microsoft Hyper-V emulation
 *
 * derived from arch/x86/kvm/x86.c
 *
 * Copyright (C) 2006 Qumranet, Inc.
 * Copyright (C) 2008 Qumranet, Inc.
 * Copyright IBM Corporation, 2008
 * Copyright 2010 Red Hat, Inc. and/or its affiliates.
 * Copyright (C) 2015 Andrey Smetanin <asmetanin@virtuozzo.com>
 *
 * Authors:
 *   Avi Kivity   <avi@qumranet.com>
 *   Yaniv Kamay  <yaniv@qumranet.com>
 *   Amit Shah    <amit.shah@qumranet.com>
 *   Ben-Ami Yassour <benami@il.ibm.com>
 *   Andrey Smetanin <asmetanin@virtuozzo.com>
 */

#ifndef __ARCH_X86_KVM_HYPERV_H__
#define __ARCH_X86_KVM_HYPERV_H__

#include <linux/kvm_host.h>

/* "Hv#1" signature */
#define HYPERV_CPUID_SIGNATURE_EAX 0x31237648

/*
 * 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_hv *to_kvm_hv(struct kvm *kvm)
{
	return &kvm->arch.hyperv;
}

static inline struct kvm_vcpu_hv *to_hv_vcpu(struct kvm_vcpu *vcpu)
{
	return vcpu->arch.hyperv;
}

static inline struct kvm_vcpu_hv_synic *to_hv_synic(struct kvm_vcpu *vcpu)
{
	struct kvm_vcpu_hv *hv_vcpu = to_hv_vcpu(vcpu);

	return &hv_vcpu->synic;
}

static inline struct kvm_vcpu *hv_synic_to_vcpu(struct kvm_vcpu_hv_synic *synic)
{
	struct kvm_vcpu_hv *hv_vcpu = container_of(synic, struct kvm_vcpu_hv, synic);

	return hv_vcpu->vcpu;
}

static inline struct kvm_hv_syndbg *to_hv_syndbg(struct kvm_vcpu *vcpu)
{
	return &vcpu->kvm->arch.hyperv.hv_syndbg;
}

static inline u32 kvm_hv_get_vpindex(struct kvm_vcpu *vcpu)
{
	struct kvm_vcpu_hv *hv_vcpu = to_hv_vcpu(vcpu);

	return hv_vcpu ? hv_vcpu->vp_index : vcpu->vcpu_idx;
}

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);

static inline bool kvm_hv_hypercall_enabled(struct kvm_vcpu *vcpu)
{
	return vcpu->arch.hyperv_enabled && to_kvm_hv(vcpu->kvm)->hv_guest_os_id;
}

int kvm_hv_hypercall(struct kvm_vcpu *vcpu);

void kvm_hv_irq_routing_update(struct kvm *kvm);
int kvm_hv_synic_set_irq(struct kvm *kvm, u32 vcpu_id, u32 sint);
void kvm_hv_synic_send_eoi(struct kvm_vcpu *vcpu, int vector);
int kvm_hv_activate_synic(struct kvm_vcpu *vcpu, bool dont_zero_synic_pages);

void kvm_hv_vcpu_uninit(struct kvm_vcpu *vcpu);

bool kvm_hv_assist_page_enabled(struct kvm_vcpu *vcpu);
bool kvm_hv_get_assist_page(struct kvm_vcpu *vcpu,
			    struct hv_vp_assist_page *assist_page);

static inline struct kvm_vcpu_hv_stimer *to_hv_stimer(struct kvm_vcpu *vcpu,
						      int timer_index)
{
	return &to_hv_vcpu(vcpu)->stimer[timer_index];
}

static inline struct kvm_vcpu *hv_stimer_to_vcpu(struct kvm_vcpu_hv_stimer *stimer)
{
	struct kvm_vcpu_hv *hv_vcpu;

	hv_vcpu = container_of(stimer - stimer->index, struct kvm_vcpu_hv,
			       stimer[0]);
	return hv_vcpu->vcpu;
}

static inline bool kvm_hv_has_stimer_pending(struct kvm_vcpu *vcpu)
{
	struct kvm_vcpu_hv *hv_vcpu = to_hv_vcpu(vcpu);

	if (!hv_vcpu)
		return false;

	return !bitmap_empty(hv_vcpu->stimer_pending_bitmap,
			     HV_SYNIC_STIMER_COUNT);
}

void kvm_hv_process_stimers(struct kvm_vcpu *vcpu);

void kvm_hv_setup_tsc_page(struct kvm *kvm,
			   struct pvclock_vcpu_time_info *hv_clock);
void kvm_hv_request_tsc_page_update(struct kvm *kvm);

void kvm_hv_init_vm(struct kvm *kvm);
void kvm_hv_destroy_vm(struct kvm *kvm);
int kvm_hv_vcpu_init(struct kvm_vcpu *vcpu);
void kvm_hv_set_cpuid(struct kvm_vcpu *vcpu, bool hyperv_enabled);
int kvm_hv_set_enforce_cpuid(struct kvm_vcpu *vcpu, bool enforce);
int kvm_vm_ioctl_hv_eventfd(struct kvm *kvm, struct kvm_hyperv_eventfd *args);
int kvm_get_hv_cpuid(struct kvm_vcpu *vcpu, struct kvm_cpuid2 *cpuid,
		     struct kvm_cpuid_entry2 __user *entries);

#endif
Commit	Line	Data
20c8ccb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
e83d5887 AS	2	/*
	3	* KVM Microsoft Hyper-V emulation
	4	*
	5	* derived from arch/x86/kvm/x86.c
	6	*
	7	* Copyright (C) 2006 Qumranet, Inc.
	8	* Copyright (C) 2008 Qumranet, Inc.
	9	* Copyright IBM Corporation, 2008
	10	* Copyright 2010 Red Hat, Inc. and/or its affiliates.
	11	* Copyright (C) 2015 Andrey Smetanin <asmetanin@virtuozzo.com>
	12	*
	13	* Authors:
	14	* Avi Kivity <avi@qumranet.com>
	15	* Yaniv Kamay <yaniv@qumranet.com>
	16	* Amit Shah <amit.shah@qumranet.com>
	17	* Ben-Ami Yassour <benami@il.ibm.com>
	18	* Andrey Smetanin <asmetanin@virtuozzo.com>
e83d5887 AS	19	*/
	20
	21	#ifndef __ARCH_X86_KVM_HYPERV_H__
	22	#define __ARCH_X86_KVM_HYPERV_H__
	23
3592cda6 SC	24	#include <linux/kvm_host.h>
3592cda6 SC	25
3be29eb7 SC	26	/* "Hv#1" signature */
	27	#define HYPERV_CPUID_SIGNATURE_EAX 0x31237648
	28
22ad0026 JD	29	/*
	30	* The #defines related to the synthetic debugger are required by KDNet, but
	31	* they are not documented in the Hyper-V TLFS because the synthetic debugger
	32	* functionality has been deprecated and is subject to removal in future
	33	* versions of Windows.
	34	*/
	35	#define HYPERV_CPUID_SYNDBG_VENDOR_AND_MAX_FUNCTIONS 0x40000080
	36	#define HYPERV_CPUID_SYNDBG_INTERFACE 0x40000081
	37	#define HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES 0x40000082
	38
	39	/*
	40	* Hyper-V synthetic debugger platform capabilities
	41	* These are HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES.EAX bits.
	42	*/
	43	#define HV_X64_SYNDBG_CAP_ALLOW_KERNEL_DEBUGGING BIT(1)
	44
	45	/* Hyper-V Synthetic debug options MSR */
	46	#define HV_X64_MSR_SYNDBG_CONTROL 0x400000F1
	47	#define HV_X64_MSR_SYNDBG_STATUS 0x400000F2
	48	#define HV_X64_MSR_SYNDBG_SEND_BUFFER 0x400000F3
	49	#define HV_X64_MSR_SYNDBG_RECV_BUFFER 0x400000F4
	50	#define HV_X64_MSR_SYNDBG_PENDING_BUFFER 0x400000F5
	51	#define HV_X64_MSR_SYNDBG_OPTIONS 0x400000FF
	52
	53	/* Hyper-V HV_X64_MSR_SYNDBG_OPTIONS bits */
	54	#define HV_X64_SYNDBG_OPTION_USE_HCALLS BIT(2)
	55
05f04ae4 VK	56	static inline struct kvm_hv to_kvm_hv(struct kvm kvm)
	57	{
	58	return &kvm->arch.hyperv;
	59	}
	60
ef3f3980	61	static inline struct kvm_vcpu_hv to_hv_vcpu(struct kvm_vcpu vcpu)
5c919412	62	{
4592b7ea	63	return vcpu->arch.hyperv;
5c919412 AS	64	}
5c919412 AS	65
e0121fa2	66	static inline struct kvm_vcpu_hv_synic to_hv_synic(struct kvm_vcpu vcpu)
0ae80384	67	{
4592b7ea VK	68	struct kvm_vcpu_hv *hv_vcpu = to_hv_vcpu(vcpu);
	69
	70	return &hv_vcpu->synic;
0ae80384 AS	71	}
0ae80384 AS	72
e0121fa2	73	static inline struct kvm_vcpu hv_synic_to_vcpu(struct kvm_vcpu_hv_synic synic)
0ae80384	74	{
b9ce0f86 VK	75	struct kvm_vcpu_hv *hv_vcpu = container_of(synic, struct kvm_vcpu_hv, synic);
	76
	77	return hv_vcpu->vcpu;
0ae80384 AS	78	}
0ae80384 AS	79
f69b55ef	80	static inline struct kvm_hv_syndbg to_hv_syndbg(struct kvm_vcpu vcpu)
f97f5a56 JD	81	{
	82	return &vcpu->kvm->arch.hyperv.hv_syndbg;
	83	}
	84
f2bc14b6 VK	85	static inline u32 kvm_hv_get_vpindex(struct kvm_vcpu *vcpu)
	86	{
	87	struct kvm_vcpu_hv *hv_vcpu = to_hv_vcpu(vcpu);
	88
4eeef242	89	return hv_vcpu ? hv_vcpu->vp_index : vcpu->vcpu_idx;
f2bc14b6 VK	90	}
f2bc14b6 VK	91
e18eaeed	92	int kvm_hv_set_msr_common(struct kvm_vcpu *vcpu, u32 msr, u64 data, bool host);
44883f01	93	int kvm_hv_get_msr_common(struct kvm_vcpu vcpu, u32 msr, u64 pdata, bool host);
e18eaeed	94
ce385917 VK	95	static inline bool kvm_hv_hypercall_enabled(struct kvm_vcpu *vcpu)
	96	{
	97	return vcpu->arch.hyperv_enabled && to_kvm_hv(vcpu->kvm)->hv_guest_os_id;
	98	}
	99
e18eaeed	100	int kvm_hv_hypercall(struct kvm_vcpu *vcpu);
5c919412	101
e18eaeed AS	102	void kvm_hv_irq_routing_update(struct kvm *kvm);
	103	int kvm_hv_synic_set_irq(struct kvm *kvm, u32 vcpu_id, u32 sint);
	104	void kvm_hv_synic_send_eoi(struct kvm_vcpu *vcpu, int vector);
efc479e6	105	int kvm_hv_activate_synic(struct kvm_vcpu *vcpu, bool dont_zero_synic_pages);
5c919412	106
1f4b34f8 AS	107	void kvm_hv_vcpu_uninit(struct kvm_vcpu *vcpu);
1f4b34f8 AS	108
72bbf935 LP	109	bool kvm_hv_assist_page_enabled(struct kvm_vcpu *vcpu);
	110	bool kvm_hv_get_assist_page(struct kvm_vcpu *vcpu,
	111	struct hv_vp_assist_page *assist_page);
	112
aafa97fd VK	113	static inline struct kvm_vcpu_hv_stimer to_hv_stimer(struct kvm_vcpu vcpu,
aafa97fd VK	114	int timer_index)
1f4b34f8	115	{
ef3f3980	116	return &to_hv_vcpu(vcpu)->stimer[timer_index];
1f4b34f8 AS	117	}
1f4b34f8 AS	118
aafa97fd	119	static inline struct kvm_vcpu hv_stimer_to_vcpu(struct kvm_vcpu_hv_stimer stimer)
1f4b34f8 AS	120	{
	121	struct kvm_vcpu_hv *hv_vcpu;
	122
	123	hv_vcpu = container_of(stimer - stimer->index, struct kvm_vcpu_hv,
	124	stimer[0]);
b9ce0f86	125	return hv_vcpu->vcpu;
1f4b34f8 AS	126	}
	127
	128	static inline bool kvm_hv_has_stimer_pending(struct kvm_vcpu *vcpu)
	129	{
9ff5e030 VK	130	struct kvm_vcpu_hv *hv_vcpu = to_hv_vcpu(vcpu);
9ff5e030 VK	131
f2bc14b6 VK	132	if (!hv_vcpu)
	133	return false;
	134
9ff5e030	135	return !bitmap_empty(hv_vcpu->stimer_pending_bitmap,
1f4b34f8 AS	136	HV_SYNIC_STIMER_COUNT);
	137	}
	138
	139	void kvm_hv_process_stimers(struct kvm_vcpu *vcpu);
e18eaeed	140
095cf55d PB	141	void kvm_hv_setup_tsc_page(struct kvm *kvm,
095cf55d PB	142	struct pvclock_vcpu_time_info *hv_clock);
42dcbe7d	143	void kvm_hv_request_tsc_page_update(struct kvm *kvm);
095cf55d	144
cbc0236a RK	145	void kvm_hv_init_vm(struct kvm *kvm);
cbc0236a RK	146	void kvm_hv_destroy_vm(struct kvm *kvm);
3be29eb7 SC	147	int kvm_hv_vcpu_init(struct kvm_vcpu *vcpu);
3be29eb7 SC	148	void kvm_hv_set_cpuid(struct kvm_vcpu *vcpu, bool hyperv_enabled);
644f7067	149	int kvm_hv_set_enforce_cpuid(struct kvm_vcpu *vcpu, bool enforce);
faeb7833	150	int kvm_vm_ioctl_hv_eventfd(struct kvm kvm, struct kvm_hyperv_eventfd args);
c21d54f0 VK	151	int kvm_get_hv_cpuid(struct kvm_vcpu vcpu, struct kvm_cpuid2 cpuid,
c21d54f0 VK	152	struct kvm_cpuid_entry2 __user *entries);
cbc0236a	153
e83d5887	154	#endif