[mirror_ubuntu-jammy-kernel.git] / arch / x86 / include / asm / kvm_para.h

#ifndef _ASM_X86_KVM_PARA_H
#define _ASM_X86_KVM_PARA_H

#include <linux/types.h>
#include <asm/hyperv.h>

/* This CPUID returns the signature 'KVMKVMKVM' in ebx, ecx, and edx.  It
 * should be used to determine that a VM is running under KVM.
 */
#define KVM_CPUID_SIGNATURE	0x40000000

/* This CPUID returns a feature bitmap in eax.  Before enabling a particular
 * paravirtualization, the appropriate feature bit should be checked.
 */
#define KVM_CPUID_FEATURES	0x40000001
#define KVM_FEATURE_CLOCKSOURCE		0
#define KVM_FEATURE_NOP_IO_DELAY	1
#define KVM_FEATURE_MMU_OP		2
/* This indicates that the new set of kvmclock msrs
 * are available. The use of 0x11 and 0x12 is deprecated
 */
#define KVM_FEATURE_CLOCKSOURCE2        3
#define KVM_FEATURE_ASYNC_PF		4

/* The last 8 bits are used to indicate how to interpret the flags field
 * in pvclock structure. If no bits are set, all flags are ignored.
 */
#define KVM_FEATURE_CLOCKSOURCE_STABLE_BIT	24

#define MSR_KVM_WALL_CLOCK  0x11
#define MSR_KVM_SYSTEM_TIME 0x12

/* Custom MSRs falls in the range 0x4b564d00-0x4b564dff */
#define MSR_KVM_WALL_CLOCK_NEW  0x4b564d00
#define MSR_KVM_SYSTEM_TIME_NEW 0x4b564d01
#define MSR_KVM_ASYNC_PF_EN 0x4b564d02

#define KVM_MAX_MMU_OP_BATCH           32

#define KVM_ASYNC_PF_ENABLED			(1 << 0)
#define KVM_ASYNC_PF_SEND_ALWAYS		(1 << 1)

/* Operations for KVM_HC_MMU_OP */
#define KVM_MMU_OP_WRITE_PTE            1
#define KVM_MMU_OP_FLUSH_TLB	        2
#define KVM_MMU_OP_RELEASE_PT	        3

/* Payload for KVM_HC_MMU_OP */
struct kvm_mmu_op_header {
	__u32 op;
	__u32 pad;
};

struct kvm_mmu_op_write_pte {
	struct kvm_mmu_op_header header;
	__u64 pte_phys;
	__u64 pte_val;
};

struct kvm_mmu_op_flush_tlb {
	struct kvm_mmu_op_header header;
};

struct kvm_mmu_op_release_pt {
	struct kvm_mmu_op_header header;
	__u64 pt_phys;
};

#define KVM_PV_REASON_PAGE_NOT_PRESENT 1
#define KVM_PV_REASON_PAGE_READY 2

struct kvm_vcpu_pv_apf_data {
	__u32 reason;
	__u8 pad[60];
	__u32 enabled;
};

#ifdef __KERNEL__
#include <asm/processor.h>

extern void kvmclock_init(void);
extern int kvm_register_clock(char *txt);


/* This instruction is vmcall.  On non-VT architectures, it will generate a
 * trap that we will then rewrite to the appropriate instruction.
 */
#define KVM_HYPERCALL ".byte 0x0f,0x01,0xc1"

/* For KVM hypercalls, a three-byte sequence of either the vmrun or the vmmrun
 * instruction.  The hypervisor may replace it with something else but only the
 * instructions are guaranteed to be supported.
 *
 * Up to four arguments may be passed in rbx, rcx, rdx, and rsi respectively.
 * The hypercall number should be placed in rax and the return value will be
 * placed in rax.  No other registers will be clobbered unless explicited
 * noted by the particular hypercall.
 */

static inline long kvm_hypercall0(unsigned int nr)
{
	long ret;
	asm volatile(KVM_HYPERCALL
		     : "=a"(ret)
		     : "a"(nr)
		     : "memory");
	return ret;
}

static inline long kvm_hypercall1(unsigned int nr, unsigned long p1)
{
	long ret;
	asm volatile(KVM_HYPERCALL
		     : "=a"(ret)
		     : "a"(nr), "b"(p1)
		     : "memory");
	return ret;
}

static inline long kvm_hypercall2(unsigned int nr, unsigned long p1,
				  unsigned long p2)
{
	long ret;
	asm volatile(KVM_HYPERCALL
		     : "=a"(ret)
		     : "a"(nr), "b"(p1), "c"(p2)
		     : "memory");
	return ret;
}

static inline long kvm_hypercall3(unsigned int nr, unsigned long p1,
				  unsigned long p2, unsigned long p3)
{
	long ret;
	asm volatile(KVM_HYPERCALL
		     : "=a"(ret)
		     : "a"(nr), "b"(p1), "c"(p2), "d"(p3)
		     : "memory");
	return ret;
}

static inline long kvm_hypercall4(unsigned int nr, unsigned long p1,
				  unsigned long p2, unsigned long p3,
				  unsigned long p4)
{
	long ret;
	asm volatile(KVM_HYPERCALL
		     : "=a"(ret)
		     : "a"(nr), "b"(p1), "c"(p2), "d"(p3), "S"(p4)
		     : "memory");
	return ret;
}

static inline int kvm_para_available(void)
{
	unsigned int eax, ebx, ecx, edx;
	char signature[13];

	cpuid(KVM_CPUID_SIGNATURE, &eax, &ebx, &ecx, &edx);
	memcpy(signature + 0, &ebx, 4);
	memcpy(signature + 4, &ecx, 4);
	memcpy(signature + 8, &edx, 4);
	signature[12] = 0;

	if (strcmp(signature, "KVMKVMKVM") == 0)
		return 1;

	return 0;
}

static inline unsigned int kvm_arch_para_features(void)
{
	return cpuid_eax(KVM_CPUID_FEATURES);
}

#ifdef CONFIG_KVM_GUEST
void __init kvm_guest_init(void);
void kvm_async_pf_task_wait(u32 token);
void kvm_async_pf_task_wake(u32 token);
u32 kvm_read_and_reset_pf_reason(void);
#else
#define kvm_guest_init() do { } while (0)
#define kvm_async_pf_task_wait(T) do {} while(0)
#define kvm_async_pf_task_wake(T) do {} while(0)
static u32 kvm_read_and_reset_pf_reason(void)
{
	return 0;
}
#endif

#endif /* __KERNEL__ */

#endif /* _ASM_X86_KVM_PARA_H */
Commit	Line	Data
1965aae3 PA	1	#ifndef _ASM_X86_KVM_PARA_H
1965aae3 PA	2	#define _ASM_X86_KVM_PARA_H
5f43238d	3
fa6870c6	4	#include <linux/types.h>
55cd8e5a	5	#include <asm/hyperv.h>
fa6870c6	6
5f43238d CB	7	/* This CPUID returns the signature 'KVMKVMKVM' in ebx, ecx, and edx. It
	8	* should be used to determine that a VM is running under KVM.
	9	*/
	10	#define KVM_CPUID_SIGNATURE 0x40000000
	11
	12	/* This CPUID returns a feature bitmap in eax. Before enabling a particular
	13	* paravirtualization, the appropriate feature bit should be checked.
	14	*/
	15	#define KVM_CPUID_FEATURES 0x40000001
a28e4f5a MT	16	#define KVM_FEATURE_CLOCKSOURCE 0
a28e4f5a MT	17	#define KVM_FEATURE_NOP_IO_DELAY 1
2f333bcb	18	#define KVM_FEATURE_MMU_OP 2
0e6ac58a GC	19	/* This indicates that the new set of kvmclock msrs
	20	* are available. The use of 0x11 and 0x12 is deprecated
	21	*/
	22	#define KVM_FEATURE_CLOCKSOURCE2 3
344d9588	23	#define KVM_FEATURE_ASYNC_PF 4
18068523	24
3a0d7256 GC	25	/* The last 8 bits are used to indicate how to interpret the flags field
	26	* in pvclock structure. If no bits are set, all flags are ignored.
	27	*/
	28	#define KVM_FEATURE_CLOCKSOURCE_STABLE_BIT 24
	29
18068523 GOC	30	#define MSR_KVM_WALL_CLOCK 0x11
18068523 GOC	31	#define MSR_KVM_SYSTEM_TIME 0x12
5f43238d	32
11c6bffa GC	33	/* Custom MSRs falls in the range 0x4b564d00-0x4b564dff */
	34	#define MSR_KVM_WALL_CLOCK_NEW 0x4b564d00
	35	#define MSR_KVM_SYSTEM_TIME_NEW 0x4b564d01
344d9588	36	#define MSR_KVM_ASYNC_PF_EN 0x4b564d02
11c6bffa	37
2f333bcb MT	38	#define KVM_MAX_MMU_OP_BATCH 32
2f333bcb MT	39
344d9588	40	#define KVM_ASYNC_PF_ENABLED (1 << 0)
6adba527	41	#define KVM_ASYNC_PF_SEND_ALWAYS (1 << 1)
344d9588	42
2f333bcb MT	43	/* Operations for KVM_HC_MMU_OP */
	44	#define KVM_MMU_OP_WRITE_PTE 1
	45	#define KVM_MMU_OP_FLUSH_TLB 2
	46	#define KVM_MMU_OP_RELEASE_PT 3
	47
	48	/* Payload for KVM_HC_MMU_OP */
	49	struct kvm_mmu_op_header {
	50	__u32 op;
	51	__u32 pad;
	52	};
	53
	54	struct kvm_mmu_op_write_pte {
	55	struct kvm_mmu_op_header header;
	56	__u64 pte_phys;
	57	__u64 pte_val;
	58	};
	59
	60	struct kvm_mmu_op_flush_tlb {
	61	struct kvm_mmu_op_header header;
	62	};
	63
	64	struct kvm_mmu_op_release_pt {
	65	struct kvm_mmu_op_header header;
	66	__u64 pt_phys;
	67	};
	68
631bc487 GN	69	#define KVM_PV_REASON_PAGE_NOT_PRESENT 1
	70	#define KVM_PV_REASON_PAGE_READY 2
	71
fd10cde9 GN	72	struct kvm_vcpu_pv_apf_data {
	73	__u32 reason;
	74	__u8 pad[60];
	75	__u32 enabled;
	76	};
	77
5f43238d CB	78	#ifdef __KERNEL__
	79	#include <asm/processor.h>
	80
18068523	81	extern void kvmclock_init(void);
ca3f1017	82	extern int kvm_register_clock(char *txt);
18068523 GOC	83
18068523 GOC	84
5f43238d CB	85	/* This instruction is vmcall. On non-VT architectures, it will generate a
	86	* trap that we will then rewrite to the appropriate instruction.
	87	*/
	88	#define KVM_HYPERCALL ".byte 0x0f,0x01,0xc1"
	89
	90	/* For KVM hypercalls, a three-byte sequence of either the vmrun or the vmmrun
	91	* instruction. The hypervisor may replace it with something else but only the
	92	* instructions are guaranteed to be supported.
	93	*
	94	* Up to four arguments may be passed in rbx, rcx, rdx, and rsi respectively.
	95	* The hypercall number should be placed in rax and the return value will be
	96	* placed in rax. No other registers will be clobbered unless explicited
	97	* noted by the particular hypercall.
	98	*/
	99
	100	static inline long kvm_hypercall0(unsigned int nr)
	101	{
	102	long ret;
	103	asm volatile(KVM_HYPERCALL
	104	: "=a"(ret)
ca373932 AL	105	: "a"(nr)
ca373932 AL	106	: "memory");
5f43238d CB	107	return ret;
	108	}
	109
	110	static inline long kvm_hypercall1(unsigned int nr, unsigned long p1)
	111	{
	112	long ret;
	113	asm volatile(KVM_HYPERCALL
	114	: "=a"(ret)
ca373932 AL	115	: "a"(nr), "b"(p1)
ca373932 AL	116	: "memory");
5f43238d CB	117	return ret;
	118	}
	119
	120	static inline long kvm_hypercall2(unsigned int nr, unsigned long p1,
	121	unsigned long p2)
	122	{
	123	long ret;
	124	asm volatile(KVM_HYPERCALL
	125	: "=a"(ret)
ca373932 AL	126	: "a"(nr), "b"(p1), "c"(p2)
ca373932 AL	127	: "memory");
5f43238d CB	128	return ret;
	129	}
	130
	131	static inline long kvm_hypercall3(unsigned int nr, unsigned long p1,
	132	unsigned long p2, unsigned long p3)
	133	{
	134	long ret;
	135	asm volatile(KVM_HYPERCALL
	136	: "=a"(ret)
ca373932 AL	137	: "a"(nr), "b"(p1), "c"(p2), "d"(p3)
ca373932 AL	138	: "memory");
5f43238d CB	139	return ret;
	140	}
	141
	142	static inline long kvm_hypercall4(unsigned int nr, unsigned long p1,
	143	unsigned long p2, unsigned long p3,
	144	unsigned long p4)
	145	{
	146	long ret;
	147	asm volatile(KVM_HYPERCALL
	148	: "=a"(ret)
ca373932 AL	149	: "a"(nr), "b"(p1), "c"(p2), "d"(p3), "S"(p4)
ca373932 AL	150	: "memory");
5f43238d CB	151	return ret;
	152	}
	153
	154	static inline int kvm_para_available(void)
	155	{
	156	unsigned int eax, ebx, ecx, edx;
	157	char signature[13];
	158
	159	cpuid(KVM_CPUID_SIGNATURE, &eax, &ebx, &ecx, &edx);
	160	memcpy(signature + 0, &ebx, 4);
	161	memcpy(signature + 4, &ecx, 4);
	162	memcpy(signature + 8, &edx, 4);
	163	signature[12] = 0;
	164
	165	if (strcmp(signature, "KVMKVMKVM") == 0)
	166	return 1;
	167
	168	return 0;
	169	}
	170
	171	static inline unsigned int kvm_arch_para_features(void)
	172	{
	173	return cpuid_eax(KVM_CPUID_FEATURES);
	174	}
	175
ba492962 AG	176	#ifdef CONFIG_KVM_GUEST
ba492962 AG	177	void __init kvm_guest_init(void);
631bc487 GN	178	void kvm_async_pf_task_wait(u32 token);
	179	void kvm_async_pf_task_wake(u32 token);
	180	u32 kvm_read_and_reset_pf_reason(void);
ba492962 AG	181	#else
ba492962 AG	182	#define kvm_guest_init() do { } while (0)
631bc487 GN	183	#define kvm_async_pf_task_wait(T) do {} while(0)
	184	#define kvm_async_pf_task_wake(T) do {} while(0)
	185	static u32 kvm_read_and_reset_pf_reason(void)
	186	{
	187	return 0;
	188	}
5f43238d CB	189	#endif
5f43238d CB	190
ba492962 AG	191	#endif /* __KERNEL__ */
ba492962 AG	192
1965aae3	193	#endif /* _ASM_X86_KVM_PARA_H */