[mirror_ubuntu-focal-kernel.git] / arch / arm64 / include / asm / kvm_host.h

/*
 * Copyright (C) 2012,2013 - ARM Ltd
 * Author: Marc Zyngier <marc.zyngier@arm.com>
 *
 * Derived from arch/arm/include/asm/kvm_host.h:
 * Copyright (C) 2012 - Virtual Open Systems and Columbia University
 * Author: Christoffer Dall <c.dall@virtualopensystems.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __ARM64_KVM_HOST_H__
#define __ARM64_KVM_HOST_H__

#include <linux/types.h>
#include <linux/kvm_types.h>
#include <asm/kvm.h>
#include <asm/kvm_asm.h>
#include <asm/kvm_mmio.h>

#define __KVM_HAVE_ARCH_INTC_INITIALIZED

#if defined(CONFIG_KVM_ARM_MAX_VCPUS)
#define KVM_MAX_VCPUS CONFIG_KVM_ARM_MAX_VCPUS
#else
#define KVM_MAX_VCPUS 0
#endif

#define KVM_USER_MEM_SLOTS 32
#define KVM_PRIVATE_MEM_SLOTS 4
#define KVM_COALESCED_MMIO_PAGE_OFFSET 1

#include <kvm/arm_vgic.h>
#include <kvm/arm_arch_timer.h>

#define KVM_VCPU_MAX_FEATURES 3

int __attribute_const__ kvm_target_cpu(void);
int kvm_reset_vcpu(struct kvm_vcpu *vcpu);
int kvm_arch_dev_ioctl_check_extension(long ext);

struct kvm_arch {
	/* The VMID generation used for the virt. memory system */
	u64    vmid_gen;
	u32    vmid;

	/* 1-level 2nd stage table and lock */
	spinlock_t pgd_lock;
	pgd_t *pgd;

	/* VTTBR value associated with above pgd and vmid */
	u64    vttbr;

	/* The maximum number of vCPUs depends on the used GIC model */
	int max_vcpus;

	/* Interrupt controller */
	struct vgic_dist	vgic;

	/* Timer */
	struct arch_timer_kvm	timer;
};

#define KVM_NR_MEM_OBJS     40

/*
 * We don't want allocation failures within the mmu code, so we preallocate
 * enough memory for a single page fault in a cache.
 */
struct kvm_mmu_memory_cache {
	int nobjs;
	void *objects[KVM_NR_MEM_OBJS];
};

struct kvm_vcpu_fault_info {
	u32 esr_el2;		/* Hyp Syndrom Register */
	u64 far_el2;		/* Hyp Fault Address Register */
	u64 hpfar_el2;		/* Hyp IPA Fault Address Register */
};

struct kvm_cpu_context {
	struct kvm_regs	gp_regs;
	union {
		u64 sys_regs[NR_SYS_REGS];
		u32 copro[NR_COPRO_REGS];
	};
};

typedef struct kvm_cpu_context kvm_cpu_context_t;

struct kvm_vcpu_arch {
	struct kvm_cpu_context ctxt;

	/* HYP configuration */
	u64 hcr_el2;
	u32 mdcr_el2;

	/* Exception Information */
	struct kvm_vcpu_fault_info fault;

	/* Guest debug state */
	u64 debug_flags;

	/*
	 * We maintain more than a single set of debug registers to support
	 * debugging the guest from the host and to maintain separate host and
	 * guest state during world switches. vcpu_debug_state are the debug
	 * registers of the vcpu as the guest sees them.  host_debug_state are
	 * the host registers which are saved and restored during
	 * world switches. external_debug_state contains the debug
	 * values we want to debug the guest. This is set via the
	 * KVM_SET_GUEST_DEBUG ioctl.
	 *
	 * debug_ptr points to the set of debug registers that should be loaded
	 * onto the hardware when running the guest.
	 */
	struct kvm_guest_debug_arch *debug_ptr;
	struct kvm_guest_debug_arch vcpu_debug_state;
	struct kvm_guest_debug_arch external_debug_state;

	/* Pointer to host CPU context */
	kvm_cpu_context_t *host_cpu_context;
	struct kvm_guest_debug_arch host_debug_state;

	/* VGIC state */
	struct vgic_cpu vgic_cpu;
	struct arch_timer_cpu timer_cpu;

	/*
	 * Anything that is not used directly from assembly code goes
	 * here.
	 */

	/*
	 * Guest registers we preserve during guest debugging.
	 *
	 * These shadow registers are updated by the kvm_handle_sys_reg
	 * trap handler if the guest accesses or updates them while we
	 * are using guest debug.
	 */
	struct {
		u32	mdscr_el1;
	} guest_debug_preserved;

	/* Don't run the guest */
	bool pause;

	/* IO related fields */
	struct kvm_decode mmio_decode;

	/* Interrupt related fields */
	u64 irq_lines;		/* IRQ and FIQ levels */

	/* Cache some mmu pages needed inside spinlock regions */
	struct kvm_mmu_memory_cache mmu_page_cache;

	/* Target CPU and feature flags */
	int target;
	DECLARE_BITMAP(features, KVM_VCPU_MAX_FEATURES);

	/* Detect first run of a vcpu */
	bool has_run_once;
};

#define vcpu_gp_regs(v)		(&(v)->arch.ctxt.gp_regs)
#define vcpu_sys_reg(v,r)	((v)->arch.ctxt.sys_regs[(r)])
/*
 * CP14 and CP15 live in the same array, as they are backed by the
 * same system registers.
 */
#define vcpu_cp14(v,r)		((v)->arch.ctxt.copro[(r)])
#define vcpu_cp15(v,r)		((v)->arch.ctxt.copro[(r)])

#ifdef CONFIG_CPU_BIG_ENDIAN
#define vcpu_cp15_64_high(v,r)	vcpu_cp15((v),(r))
#define vcpu_cp15_64_low(v,r)	vcpu_cp15((v),(r) + 1)
#else
#define vcpu_cp15_64_high(v,r)	vcpu_cp15((v),(r) + 1)
#define vcpu_cp15_64_low(v,r)	vcpu_cp15((v),(r))
#endif

struct kvm_vm_stat {
	u32 remote_tlb_flush;
};

struct kvm_vcpu_stat {
	u32 halt_successful_poll;
	u32 halt_wakeup;
};

int kvm_vcpu_preferred_target(struct kvm_vcpu_init *init);
unsigned long kvm_arm_num_regs(struct kvm_vcpu *vcpu);
int kvm_arm_copy_reg_indices(struct kvm_vcpu *vcpu, u64 __user *indices);
int kvm_arm_get_reg(struct kvm_vcpu *vcpu, const struct kvm_one_reg *reg);
int kvm_arm_set_reg(struct kvm_vcpu *vcpu, const struct kvm_one_reg *reg);

#define KVM_ARCH_WANT_MMU_NOTIFIER
int kvm_unmap_hva(struct kvm *kvm, unsigned long hva);
int kvm_unmap_hva_range(struct kvm *kvm,
			unsigned long start, unsigned long end);
void kvm_set_spte_hva(struct kvm *kvm, unsigned long hva, pte_t pte);
int kvm_age_hva(struct kvm *kvm, unsigned long start, unsigned long end);
int kvm_test_age_hva(struct kvm *kvm, unsigned long hva);

/* We do not have shadow page tables, hence the empty hooks */
static inline void kvm_arch_mmu_notifier_invalidate_page(struct kvm *kvm,
							 unsigned long address)
{
}

struct kvm_vcpu *kvm_arm_get_running_vcpu(void);
struct kvm_vcpu * __percpu *kvm_get_running_vcpus(void);

u64 kvm_call_hyp(void *hypfn, ...);
void force_vm_exit(const cpumask_t *mask);
void kvm_mmu_wp_memory_region(struct kvm *kvm, int slot);

int handle_exit(struct kvm_vcpu *vcpu, struct kvm_run *run,
		int exception_index);

int kvm_perf_init(void);
int kvm_perf_teardown(void);

struct kvm_vcpu *kvm_mpidr_to_vcpu(struct kvm *kvm, unsigned long mpidr);

static inline void __cpu_init_hyp_mode(phys_addr_t boot_pgd_ptr,
				       phys_addr_t pgd_ptr,
				       unsigned long hyp_stack_ptr,
				       unsigned long vector_ptr)
{
	/*
	 * Call initialization code, and switch to the full blown
	 * HYP code.
	 */
	kvm_call_hyp((void *)boot_pgd_ptr, pgd_ptr,
		     hyp_stack_ptr, vector_ptr);
}

static inline void kvm_arch_hardware_disable(void) {}
static inline void kvm_arch_hardware_unsetup(void) {}
static inline void kvm_arch_sync_events(struct kvm *kvm) {}
static inline void kvm_arch_vcpu_uninit(struct kvm_vcpu *vcpu) {}
static inline void kvm_arch_sched_in(struct kvm_vcpu *vcpu, int cpu) {}

void kvm_arm_init_debug(void);
void kvm_arm_setup_debug(struct kvm_vcpu *vcpu);
void kvm_arm_clear_debug(struct kvm_vcpu *vcpu);
void kvm_arm_reset_debug_ptr(struct kvm_vcpu *vcpu);

#endif /* __ARM64_KVM_HOST_H__ */
Commit	Line	Data
4f8d6632 MZ	1	/*
	2	* Copyright (C) 2012,2013 - ARM Ltd
	3	* Author: Marc Zyngier <marc.zyngier@arm.com>
	4	*
	5	* Derived from arch/arm/include/asm/kvm_host.h:
	6	* Copyright (C) 2012 - Virtual Open Systems and Columbia University
	7	* Author: Christoffer Dall <c.dall@virtualopensystems.com>
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License version 2 as
	11	* published by the Free Software Foundation.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	20	*/
	21
	22	#ifndef __ARM64_KVM_HOST_H__
	23	#define __ARM64_KVM_HOST_H__
	24
65647300 PB	25	#include <linux/types.h>
65647300 PB	26	#include <linux/kvm_types.h>
4f8d6632 MZ	27	#include <asm/kvm.h>
	28	#include <asm/kvm_asm.h>
	29	#include <asm/kvm_mmio.h>
	30
c1426e4c EA	31	#define __KVM_HAVE_ARCH_INTC_INITIALIZED
c1426e4c EA	32
da781470 AP	33	#if defined(CONFIG_KVM_ARM_MAX_VCPUS)
	34	#define KVM_MAX_VCPUS CONFIG_KVM_ARM_MAX_VCPUS
	35	#else
	36	#define KVM_MAX_VCPUS 0
	37	#endif
	38
4f8d6632 MZ	39	#define KVM_USER_MEM_SLOTS 32
	40	#define KVM_PRIVATE_MEM_SLOTS 4
	41	#define KVM_COALESCED_MMIO_PAGE_OFFSET 1
	42
	43	#include <kvm/arm_vgic.h>
	44	#include <kvm/arm_arch_timer.h>
	45
7d0f84aa	46	#define KVM_VCPU_MAX_FEATURES 3
4f8d6632	47
6951e48b	48	int __attribute_const__ kvm_target_cpu(void);
4f8d6632 MZ	49	int kvm_reset_vcpu(struct kvm_vcpu *vcpu);
	50	int kvm_arch_dev_ioctl_check_extension(long ext);
	51
	52	struct kvm_arch {
	53	/* The VMID generation used for the virt. memory system */
	54	u64 vmid_gen;
	55	u32 vmid;
	56
	57	/* 1-level 2nd stage table and lock */
	58	spinlock_t pgd_lock;
	59	pgd_t *pgd;
	60
	61	/* VTTBR value associated with above pgd and vmid */
	62	u64 vttbr;
	63
3caa2d8c AP	64	/* The maximum number of vCPUs depends on the used GIC model */
	65	int max_vcpus;
	66
4f8d6632 MZ	67	/* Interrupt controller */
	68	struct vgic_dist vgic;
	69
	70	/* Timer */
	71	struct arch_timer_kvm timer;
	72	};
	73
	74	#define KVM_NR_MEM_OBJS 40
	75
	76	/*
	77	* We don't want allocation failures within the mmu code, so we preallocate
	78	* enough memory for a single page fault in a cache.
	79	*/
	80	struct kvm_mmu_memory_cache {
	81	int nobjs;
	82	void *objects[KVM_NR_MEM_OBJS];
	83	};
	84
	85	struct kvm_vcpu_fault_info {
	86	u32 esr_el2; /* Hyp Syndrom Register */
	87	u64 far_el2; /* Hyp Fault Address Register */
	88	u64 hpfar_el2; /* Hyp IPA Fault Address Register */
	89	};
	90
	91	struct kvm_cpu_context {
	92	struct kvm_regs gp_regs;
40033a61 MZ	93	union {
40033a61 MZ	94	u64 sys_regs[NR_SYS_REGS];
72564016	95	u32 copro[NR_COPRO_REGS];
40033a61	96	};
4f8d6632 MZ	97	};
	98
	99	typedef struct kvm_cpu_context kvm_cpu_context_t;
	100
	101	struct kvm_vcpu_arch {
	102	struct kvm_cpu_context ctxt;
	103
	104	/* HYP configuration */
	105	u64 hcr_el2;
56c7f5e7	106	u32 mdcr_el2;
4f8d6632 MZ	107
	108	/* Exception Information */
	109	struct kvm_vcpu_fault_info fault;
	110
84e690bf	111	/* Guest debug state */
0c557ed4 MZ	112	u64 debug_flags;
0c557ed4 MZ	113
84e690bf AB	114	/*
	115	* We maintain more than a single set of debug registers to support
	116	* debugging the guest from the host and to maintain separate host and
	117	* guest state during world switches. vcpu_debug_state are the debug
	118	* registers of the vcpu as the guest sees them. host_debug_state are
834bf887 AB	119	* the host registers which are saved and restored during
	120	* world switches. external_debug_state contains the debug
	121	* values we want to debug the guest. This is set via the
	122	* KVM_SET_GUEST_DEBUG ioctl.
84e690bf AB	123	*
	124	* debug_ptr points to the set of debug registers that should be loaded
	125	* onto the hardware when running the guest.
	126	*/
	127	struct kvm_guest_debug_arch *debug_ptr;
	128	struct kvm_guest_debug_arch vcpu_debug_state;
834bf887	129	struct kvm_guest_debug_arch external_debug_state;
84e690bf	130
4f8d6632 MZ	131	/* Pointer to host CPU context */
4f8d6632 MZ	132	kvm_cpu_context_t *host_cpu_context;
84e690bf	133	struct kvm_guest_debug_arch host_debug_state;
4f8d6632 MZ	134
	135	/* VGIC state */
	136	struct vgic_cpu vgic_cpu;
	137	struct arch_timer_cpu timer_cpu;
	138
	139	/*
	140	* Anything that is not used directly from assembly code goes
	141	* here.
	142	*/
4f8d6632	143
337b99bf AB	144	/*
	145	* Guest registers we preserve during guest debugging.
	146	*
	147	* These shadow registers are updated by the kvm_handle_sys_reg
	148	* trap handler if the guest accesses or updates them while we
	149	* are using guest debug.
	150	*/
	151	struct {
	152	u32 mdscr_el1;
	153	} guest_debug_preserved;
	154
4f8d6632 MZ	155	/* Don't run the guest */
	156	bool pause;
	157
	158	/* IO related fields */
	159	struct kvm_decode mmio_decode;
	160
	161	/* Interrupt related fields */
	162	u64 irq_lines; /* IRQ and FIQ levels */
	163
	164	/* Cache some mmu pages needed inside spinlock regions */
	165	struct kvm_mmu_memory_cache mmu_page_cache;
	166
	167	/* Target CPU and feature flags */
6c8c0c4d	168	int target;
4f8d6632 MZ	169	DECLARE_BITMAP(features, KVM_VCPU_MAX_FEATURES);
	170
	171	/* Detect first run of a vcpu */
	172	bool has_run_once;
	173	};
	174
	175	#define vcpu_gp_regs(v) (&(v)->arch.ctxt.gp_regs)
	176	#define vcpu_sys_reg(v,r) ((v)->arch.ctxt.sys_regs[(r)])
72564016 MZ	177	/*
	178	* CP14 and CP15 live in the same array, as they are backed by the
	179	* same system registers.
	180	*/
	181	#define vcpu_cp14(v,r) ((v)->arch.ctxt.copro[(r)])
	182	#define vcpu_cp15(v,r) ((v)->arch.ctxt.copro[(r)])
4f8d6632	183
f0a3eaff	184	#ifdef CONFIG_CPU_BIG_ENDIAN
dedf97e8 MZ	185	#define vcpu_cp15_64_high(v,r) vcpu_cp15((v),(r))
dedf97e8 MZ	186	#define vcpu_cp15_64_low(v,r) vcpu_cp15((v),(r) + 1)
f0a3eaff	187	#else
dedf97e8 MZ	188	#define vcpu_cp15_64_high(v,r) vcpu_cp15((v),(r) + 1)
dedf97e8 MZ	189	#define vcpu_cp15_64_low(v,r) vcpu_cp15((v),(r))
f0a3eaff VK	190	#endif
f0a3eaff VK	191
4f8d6632 MZ	192	struct kvm_vm_stat {
	193	u32 remote_tlb_flush;
	194	};
	195
	196	struct kvm_vcpu_stat {
f7819512	197	u32 halt_successful_poll;
4f8d6632 MZ	198	u32 halt_wakeup;
	199	};
	200
473bdc0e	201	int kvm_vcpu_preferred_target(struct kvm_vcpu_init *init);
4f8d6632 MZ	202	unsigned long kvm_arm_num_regs(struct kvm_vcpu *vcpu);
4f8d6632 MZ	203	int kvm_arm_copy_reg_indices(struct kvm_vcpu vcpu, u64 __user indices);
4f8d6632 MZ	204	int kvm_arm_get_reg(struct kvm_vcpu vcpu, const struct kvm_one_reg reg);
	205	int kvm_arm_set_reg(struct kvm_vcpu vcpu, const struct kvm_one_reg reg);
	206
	207	#define KVM_ARCH_WANT_MMU_NOTIFIER
4f8d6632 MZ	208	int kvm_unmap_hva(struct kvm *kvm, unsigned long hva);
	209	int kvm_unmap_hva_range(struct kvm *kvm,
	210	unsigned long start, unsigned long end);
	211	void kvm_set_spte_hva(struct kvm *kvm, unsigned long hva, pte_t pte);
35307b9a MZ	212	int kvm_age_hva(struct kvm *kvm, unsigned long start, unsigned long end);
35307b9a MZ	213	int kvm_test_age_hva(struct kvm *kvm, unsigned long hva);
4f8d6632 MZ	214
4f8d6632 MZ	215	/* We do not have shadow page tables, hence the empty hooks */
fe71557a TC	216	static inline void kvm_arch_mmu_notifier_invalidate_page(struct kvm *kvm,
	217	unsigned long address)
	218	{
	219	}
	220
4f8d6632	221	struct kvm_vcpu *kvm_arm_get_running_vcpu(void);
4000be42	222	struct kvm_vcpu * __percpu *kvm_get_running_vcpus(void);
4f8d6632 MZ	223
4f8d6632 MZ	224	u64 kvm_call_hyp(void *hypfn, ...);
cf5d3188	225	void force_vm_exit(const cpumask_t *mask);
8199ed0e	226	void kvm_mmu_wp_memory_region(struct kvm *kvm, int slot);
4f8d6632 MZ	227
	228	int handle_exit(struct kvm_vcpu vcpu, struct kvm_run run,
	229	int exception_index);
	230
	231	int kvm_perf_init(void);
	232	int kvm_perf_teardown(void);
	233
4429fc64 AP	234	struct kvm_vcpu kvm_mpidr_to_vcpu(struct kvm kvm, unsigned long mpidr);
4429fc64 AP	235
092bd143 MZ	236	static inline void __cpu_init_hyp_mode(phys_addr_t boot_pgd_ptr,
	237	phys_addr_t pgd_ptr,
	238	unsigned long hyp_stack_ptr,
	239	unsigned long vector_ptr)
	240	{
	241	/*
	242	* Call initialization code, and switch to the full blown
	243	* HYP code.
	244	*/
	245	kvm_call_hyp((void *)boot_pgd_ptr, pgd_ptr,
	246	hyp_stack_ptr, vector_ptr);
	247	}
	248
13a34e06	249	static inline void kvm_arch_hardware_disable(void) {}
0865e636 RK	250	static inline void kvm_arch_hardware_unsetup(void) {}
	251	static inline void kvm_arch_sync_events(struct kvm *kvm) {}
	252	static inline void kvm_arch_vcpu_uninit(struct kvm_vcpu *vcpu) {}
	253	static inline void kvm_arch_sched_in(struct kvm_vcpu *vcpu, int cpu) {}
	254
56c7f5e7 AB	255	void kvm_arm_init_debug(void);
	256	void kvm_arm_setup_debug(struct kvm_vcpu *vcpu);
	257	void kvm_arm_clear_debug(struct kvm_vcpu *vcpu);
84e690bf	258	void kvm_arm_reset_debug_ptr(struct kvm_vcpu *vcpu);
56c7f5e7	259
4f8d6632	260	#endif /* __ARM64_KVM_HOST_H__ */