[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>

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

	/* Exception Information */
	struct kvm_vcpu_fault_info fault;

	/* Debug state */
	u64 debug_flags;

	/* Pointer to host CPU context */
	kvm_cpu_context_t *host_cpu_context;

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

	/*
	 * Anything that is not used directly from assembly code goes
	 * here.
	 */
	/* dcache set/way operation pending */
	int last_pcpu;
	cpumask_t require_dcache_flush;

	/* 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_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);

/* We do not have shadow page tables, hence the empty hooks */
static inline int kvm_age_hva(struct kvm *kvm, unsigned long start,
			      unsigned long end)
{
	return 0;
}

static inline int kvm_test_age_hva(struct kvm *kvm, unsigned long hva)
{
	return 0;
}

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

struct vgic_sr_vectors {
	void	*save_vgic;
	void	*restore_vgic;
};

static inline void vgic_arch_setup(const struct vgic_params *vgic)
{
	extern struct vgic_sr_vectors __vgic_sr_vectors;

	switch(vgic->type)
	{
	case VGIC_V2:
		__vgic_sr_vectors.save_vgic	= __save_vgic_v2_state;
		__vgic_sr_vectors.restore_vgic	= __restore_vgic_v2_state;
		break;

#ifdef CONFIG_ARM_GIC_V3
	case VGIC_V3:
		__vgic_sr_vectors.save_vgic	= __save_vgic_v3_state;
		__vgic_sr_vectors.restore_vgic	= __restore_vgic_v3_state;
		break;
#endif

	default:
		BUG();
	}
}

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) {}

#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
da781470 AP	31	#if defined(CONFIG_KVM_ARM_MAX_VCPUS)
	32	#define KVM_MAX_VCPUS CONFIG_KVM_ARM_MAX_VCPUS
	33	#else
	34	#define KVM_MAX_VCPUS 0
	35	#endif
	36
4f8d6632 MZ	37	#define KVM_USER_MEM_SLOTS 32
	38	#define KVM_PRIVATE_MEM_SLOTS 4
	39	#define KVM_COALESCED_MMIO_PAGE_OFFSET 1
	40
	41	#include <kvm/arm_vgic.h>
	42	#include <kvm/arm_arch_timer.h>
	43
7d0f84aa	44	#define KVM_VCPU_MAX_FEATURES 3
4f8d6632	45
6951e48b	46	int __attribute_const__ kvm_target_cpu(void);
4f8d6632 MZ	47	int kvm_reset_vcpu(struct kvm_vcpu *vcpu);
	48	int kvm_arch_dev_ioctl_check_extension(long ext);
	49
	50	struct kvm_arch {
	51	/* The VMID generation used for the virt. memory system */
	52	u64 vmid_gen;
	53	u32 vmid;
	54
	55	/* 1-level 2nd stage table and lock */
	56	spinlock_t pgd_lock;
	57	pgd_t *pgd;
	58
	59	/* VTTBR value associated with above pgd and vmid */
	60	u64 vttbr;
	61
3caa2d8c AP	62	/* The maximum number of vCPUs depends on the used GIC model */
	63	int max_vcpus;
	64
4f8d6632 MZ	65	/* Interrupt controller */
	66	struct vgic_dist vgic;
	67
	68	/* Timer */
	69	struct arch_timer_kvm timer;
	70	};
	71
	72	#define KVM_NR_MEM_OBJS 40
	73
	74	/*
	75	* We don't want allocation failures within the mmu code, so we preallocate
	76	* enough memory for a single page fault in a cache.
	77	*/
	78	struct kvm_mmu_memory_cache {
	79	int nobjs;
	80	void *objects[KVM_NR_MEM_OBJS];
	81	};
	82
	83	struct kvm_vcpu_fault_info {
	84	u32 esr_el2; /* Hyp Syndrom Register */
	85	u64 far_el2; /* Hyp Fault Address Register */
	86	u64 hpfar_el2; /* Hyp IPA Fault Address Register */
	87	};
	88
	89	struct kvm_cpu_context {
	90	struct kvm_regs gp_regs;
40033a61 MZ	91	union {
40033a61 MZ	92	u64 sys_regs[NR_SYS_REGS];
72564016	93	u32 copro[NR_COPRO_REGS];
40033a61	94	};
4f8d6632 MZ	95	};
	96
	97	typedef struct kvm_cpu_context kvm_cpu_context_t;
	98
	99	struct kvm_vcpu_arch {
	100	struct kvm_cpu_context ctxt;
	101
	102	/* HYP configuration */
	103	u64 hcr_el2;
	104
	105	/* Exception Information */
	106	struct kvm_vcpu_fault_info fault;
	107
0c557ed4 MZ	108	/* Debug state */
	109	u64 debug_flags;
	110
4f8d6632 MZ	111	/* Pointer to host CPU context */
	112	kvm_cpu_context_t *host_cpu_context;
	113
	114	/* VGIC state */
	115	struct vgic_cpu vgic_cpu;
	116	struct arch_timer_cpu timer_cpu;
	117
	118	/*
	119	* Anything that is not used directly from assembly code goes
	120	* here.
	121	*/
	122	/* dcache set/way operation pending */
	123	int last_pcpu;
	124	cpumask_t require_dcache_flush;
	125
	126	/* Don't run the guest */
	127	bool pause;
	128
	129	/* IO related fields */
	130	struct kvm_decode mmio_decode;
	131
	132	/* Interrupt related fields */
	133	u64 irq_lines; /* IRQ and FIQ levels */
	134
	135	/* Cache some mmu pages needed inside spinlock regions */
	136	struct kvm_mmu_memory_cache mmu_page_cache;
	137
	138	/* Target CPU and feature flags */
6c8c0c4d	139	int target;
4f8d6632 MZ	140	DECLARE_BITMAP(features, KVM_VCPU_MAX_FEATURES);
	141
	142	/* Detect first run of a vcpu */
	143	bool has_run_once;
	144	};
	145
	146	#define vcpu_gp_regs(v) (&(v)->arch.ctxt.gp_regs)
	147	#define vcpu_sys_reg(v,r) ((v)->arch.ctxt.sys_regs[(r)])
72564016 MZ	148	/*
	149	* CP14 and CP15 live in the same array, as they are backed by the
	150	* same system registers.
	151	*/
	152	#define vcpu_cp14(v,r) ((v)->arch.ctxt.copro[(r)])
	153	#define vcpu_cp15(v,r) ((v)->arch.ctxt.copro[(r)])
4f8d6632	154
f0a3eaff	155	#ifdef CONFIG_CPU_BIG_ENDIAN
dedf97e8 MZ	156	#define vcpu_cp15_64_high(v,r) vcpu_cp15((v),(r))
dedf97e8 MZ	157	#define vcpu_cp15_64_low(v,r) vcpu_cp15((v),(r) + 1)
f0a3eaff	158	#else
dedf97e8 MZ	159	#define vcpu_cp15_64_high(v,r) vcpu_cp15((v),(r) + 1)
dedf97e8 MZ	160	#define vcpu_cp15_64_low(v,r) vcpu_cp15((v),(r))
f0a3eaff VK	161	#endif
f0a3eaff VK	162
4f8d6632 MZ	163	struct kvm_vm_stat {
	164	u32 remote_tlb_flush;
	165	};
	166
	167	struct kvm_vcpu_stat {
	168	u32 halt_wakeup;
	169	};
	170
473bdc0e	171	int kvm_vcpu_preferred_target(struct kvm_vcpu_init *init);
4f8d6632 MZ	172	unsigned long kvm_arm_num_regs(struct kvm_vcpu *vcpu);
4f8d6632 MZ	173	int kvm_arm_copy_reg_indices(struct kvm_vcpu vcpu, u64 __user indices);
4f8d6632 MZ	174	int kvm_arm_get_reg(struct kvm_vcpu vcpu, const struct kvm_one_reg reg);
	175	int kvm_arm_set_reg(struct kvm_vcpu vcpu, const struct kvm_one_reg reg);
	176
	177	#define KVM_ARCH_WANT_MMU_NOTIFIER
4f8d6632 MZ	178	int kvm_unmap_hva(struct kvm *kvm, unsigned long hva);
	179	int kvm_unmap_hva_range(struct kvm *kvm,
	180	unsigned long start, unsigned long end);
	181	void kvm_set_spte_hva(struct kvm *kvm, unsigned long hva, pte_t pte);
	182
	183	/* We do not have shadow page tables, hence the empty hooks */
57128468 ALC	184	static inline int kvm_age_hva(struct kvm *kvm, unsigned long start,
57128468 ALC	185	unsigned long end)
4f8d6632 MZ	186	{
	187	return 0;
	188	}
	189
	190	static inline int kvm_test_age_hva(struct kvm *kvm, unsigned long hva)
	191	{
	192	return 0;
	193	}
	194
fe71557a TC	195	static inline void kvm_arch_mmu_notifier_invalidate_page(struct kvm *kvm,
	196	unsigned long address)
	197	{
	198	}
	199
4f8d6632	200	struct kvm_vcpu *kvm_arm_get_running_vcpu(void);
4000be42	201	struct kvm_vcpu * __percpu *kvm_get_running_vcpus(void);
4f8d6632 MZ	202
4f8d6632 MZ	203	u64 kvm_call_hyp(void *hypfn, ...);
cf5d3188	204	void force_vm_exit(const cpumask_t *mask);
8199ed0e	205	void kvm_mmu_wp_memory_region(struct kvm *kvm, int slot);
4f8d6632 MZ	206
	207	int handle_exit(struct kvm_vcpu vcpu, struct kvm_run run,
	208	int exception_index);
	209
	210	int kvm_perf_init(void);
	211	int kvm_perf_teardown(void);
	212
4429fc64 AP	213	struct kvm_vcpu kvm_mpidr_to_vcpu(struct kvm kvm, unsigned long mpidr);
4429fc64 AP	214
092bd143 MZ	215	static inline void __cpu_init_hyp_mode(phys_addr_t boot_pgd_ptr,
	216	phys_addr_t pgd_ptr,
	217	unsigned long hyp_stack_ptr,
	218	unsigned long vector_ptr)
	219	{
	220	/*
	221	* Call initialization code, and switch to the full blown
	222	* HYP code.
	223	*/
	224	kvm_call_hyp((void *)boot_pgd_ptr, pgd_ptr,
	225	hyp_stack_ptr, vector_ptr);
	226	}
	227
1a9b1305 MZ	228	struct vgic_sr_vectors {
	229	void *save_vgic;
	230	void *restore_vgic;
	231	};
	232
	233	static inline void vgic_arch_setup(const struct vgic_params *vgic)
	234	{
	235	extern struct vgic_sr_vectors __vgic_sr_vectors;
	236
	237	switch(vgic->type)
	238	{
	239	case VGIC_V2:
	240	__vgic_sr_vectors.save_vgic = __save_vgic_v2_state;
	241	__vgic_sr_vectors.restore_vgic = __restore_vgic_v2_state;
	242	break;
	243
67b2abfe MZ	244	#ifdef CONFIG_ARM_GIC_V3
	245	case VGIC_V3:
	246	__vgic_sr_vectors.save_vgic = __save_vgic_v3_state;
	247	__vgic_sr_vectors.restore_vgic = __restore_vgic_v3_state;
	248	break;
	249	#endif
	250
1a9b1305 MZ	251	default:
	252	BUG();
	253	}
	254	}
	255
13a34e06	256	static inline void kvm_arch_hardware_disable(void) {}
0865e636 RK	257	static inline void kvm_arch_hardware_unsetup(void) {}
	258	static inline void kvm_arch_sync_events(struct kvm *kvm) {}
	259	static inline void kvm_arch_vcpu_uninit(struct kvm_vcpu *vcpu) {}
	260	static inline void kvm_arch_sched_in(struct kvm_vcpu *vcpu, int cpu) {}
	261
4f8d6632	262	#endif /* __ARM64_KVM_HOST_H__ */