1/*
2 * definition for kvm on s390
3 *
4 * Copyright IBM Corp. 2008, 2009
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License (version 2 only)
8 * as published by the Free Software Foundation.
9 *
10 *    Author(s): Carsten Otte <cotte@de.ibm.com>
11 *               Christian Borntraeger <borntraeger@de.ibm.com>
12 *               Christian Ehrhardt <ehrhardt@de.ibm.com>
13 */
14
15#ifndef ARCH_S390_KVM_S390_H
16#define ARCH_S390_KVM_S390_H
17
18#include <linux/hrtimer.h>
19#include <linux/kvm.h>
20#include <linux/kvm_host.h>
21#include <asm/facility.h>
22
23typedef int (*intercept_handler_t)(struct kvm_vcpu *vcpu);
24
25/* Transactional Memory Execution related macros */
26#define IS_TE_ENABLED(vcpu)	((vcpu->arch.sie_block->ecb & 0x10))
27#define TDB_FORMAT1		1
28#define IS_ITDB_VALID(vcpu)	((*(char *)vcpu->arch.sie_block->itdba == TDB_FORMAT1))
29
30#define VM_EVENT(d_kvm, d_loglevel, d_string, d_args...)\
31do { \
32	debug_sprintf_event(d_kvm->arch.dbf, d_loglevel, d_string "\n", \
33	  d_args); \
34} while (0)
35
36#define VCPU_EVENT(d_vcpu, d_loglevel, d_string, d_args...)\
37do { \
38	debug_sprintf_event(d_vcpu->kvm->arch.dbf, d_loglevel, \
39	  "%02d[%016lx-%016lx]: " d_string "\n", d_vcpu->vcpu_id, \
40	  d_vcpu->arch.sie_block->gpsw.mask, d_vcpu->arch.sie_block->gpsw.addr,\
41	  d_args); \
42} while (0)
43
44static inline int is_vcpu_stopped(struct kvm_vcpu *vcpu)
45{
46	return atomic_read(&vcpu->arch.sie_block->cpuflags) & CPUSTAT_STOPPED;
47}
48
49static inline int kvm_is_ucontrol(struct kvm *kvm)
50{
51#ifdef CONFIG_KVM_S390_UCONTROL
52	if (kvm->arch.gmap)
53		return 0;
54	return 1;
55#else
56	return 0;
57#endif
58}
59
60#define GUEST_PREFIX_SHIFT 13
61static inline u32 kvm_s390_get_prefix(struct kvm_vcpu *vcpu)
62{
63	return vcpu->arch.sie_block->prefix << GUEST_PREFIX_SHIFT;
64}
65
66static inline void kvm_s390_set_prefix(struct kvm_vcpu *vcpu, u32 prefix)
67{
68	vcpu->arch.sie_block->prefix = prefix >> GUEST_PREFIX_SHIFT;
69	kvm_make_request(KVM_REQ_TLB_FLUSH, vcpu);
70	kvm_make_request(KVM_REQ_MMU_RELOAD, vcpu);
71}
72
73typedef u8 __bitwise ar_t;
74
75static inline u64 kvm_s390_get_base_disp_s(struct kvm_vcpu *vcpu, ar_t *ar)
76{
77	u32 base2 = vcpu->arch.sie_block->ipb >> 28;
78	u32 disp2 = ((vcpu->arch.sie_block->ipb & 0x0fff0000) >> 16);
79
80	if (ar)
81		*ar = base2;
82
83	return (base2 ? vcpu->run->s.regs.gprs[base2] : 0) + disp2;
84}
85
86static inline void kvm_s390_get_base_disp_sse(struct kvm_vcpu *vcpu,
87					      u64 *address1, u64 *address2,
88					      ar_t *ar_b1, ar_t *ar_b2)
89{
90	u32 base1 = (vcpu->arch.sie_block->ipb & 0xf0000000) >> 28;
91	u32 disp1 = (vcpu->arch.sie_block->ipb & 0x0fff0000) >> 16;
92	u32 base2 = (vcpu->arch.sie_block->ipb & 0xf000) >> 12;
93	u32 disp2 = vcpu->arch.sie_block->ipb & 0x0fff;
94
95	*address1 = (base1 ? vcpu->run->s.regs.gprs[base1] : 0) + disp1;
96	*address2 = (base2 ? vcpu->run->s.regs.gprs[base2] : 0) + disp2;
97
98	if (ar_b1)
99		*ar_b1 = base1;
100	if (ar_b2)
101		*ar_b2 = base2;
102}
103
104static inline void kvm_s390_get_regs_rre(struct kvm_vcpu *vcpu, int *r1, int *r2)
105{
106	if (r1)
107		*r1 = (vcpu->arch.sie_block->ipb & 0x00f00000) >> 20;
108	if (r2)
109		*r2 = (vcpu->arch.sie_block->ipb & 0x000f0000) >> 16;
110}
111
112static inline u64 kvm_s390_get_base_disp_rsy(struct kvm_vcpu *vcpu, ar_t *ar)
113{
114	u32 base2 = vcpu->arch.sie_block->ipb >> 28;
115	u32 disp2 = ((vcpu->arch.sie_block->ipb & 0x0fff0000) >> 16) +
116			((vcpu->arch.sie_block->ipb & 0xff00) << 4);
117	/* The displacement is a 20bit _SIGNED_ value */
118	if (disp2 & 0x80000)
119		disp2+=0xfff00000;
120
121	if (ar)
122		*ar = base2;
123
124	return (base2 ? vcpu->run->s.regs.gprs[base2] : 0) + (long)(int)disp2;
125}
126
127static inline u64 kvm_s390_get_base_disp_rs(struct kvm_vcpu *vcpu, ar_t *ar)
128{
129	u32 base2 = vcpu->arch.sie_block->ipb >> 28;
130	u32 disp2 = ((vcpu->arch.sie_block->ipb & 0x0fff0000) >> 16);
131
132	if (ar)
133		*ar = base2;
134
135	return (base2 ? vcpu->run->s.regs.gprs[base2] : 0) + disp2;
136}
137
138/* Set the condition code in the guest program status word */
139static inline void kvm_s390_set_psw_cc(struct kvm_vcpu *vcpu, unsigned long cc)
140{
141	vcpu->arch.sie_block->gpsw.mask &= ~(3UL << 44);
142	vcpu->arch.sie_block->gpsw.mask |= cc << 44;
143}
144
145/* test availability of facility in a kvm instance */
146static inline int test_kvm_facility(struct kvm *kvm, unsigned long nr)
147{
148	return __test_facility(nr, kvm->arch.model.fac->mask) &&
149		__test_facility(nr, kvm->arch.model.fac->list);
150}
151
152static inline int set_kvm_facility(u64 *fac_list, unsigned long nr)
153{
154	unsigned char *ptr;
155
156	if (nr >= MAX_FACILITY_BIT)
157		return -EINVAL;
158	ptr = (unsigned char *) fac_list + (nr >> 3);
159	*ptr |= (0x80UL >> (nr & 7));
160	return 0;
161}
162
163/* are cpu states controlled by user space */
164static inline int kvm_s390_user_cpu_state_ctrl(struct kvm *kvm)
165{
166	return kvm->arch.user_cpu_state_ctrl != 0;
167}
168
169int kvm_s390_handle_wait(struct kvm_vcpu *vcpu);
170void kvm_s390_vcpu_wakeup(struct kvm_vcpu *vcpu);
171enum hrtimer_restart kvm_s390_idle_wakeup(struct hrtimer *timer);
172int __must_check kvm_s390_deliver_pending_interrupts(struct kvm_vcpu *vcpu);
173void kvm_s390_clear_local_irqs(struct kvm_vcpu *vcpu);
174void kvm_s390_clear_float_irqs(struct kvm *kvm);
175int __must_check kvm_s390_inject_vm(struct kvm *kvm,
176				    struct kvm_s390_interrupt *s390int);
177int __must_check kvm_s390_inject_vcpu(struct kvm_vcpu *vcpu,
178				      struct kvm_s390_irq *irq);
179int __must_check kvm_s390_inject_program_int(struct kvm_vcpu *vcpu, u16 code);
180struct kvm_s390_interrupt_info *kvm_s390_get_io_int(struct kvm *kvm,
181						    u64 isc_mask, u32 schid);
182int kvm_s390_reinject_io_int(struct kvm *kvm,
183			     struct kvm_s390_interrupt_info *inti);
184int kvm_s390_mask_adapter(struct kvm *kvm, unsigned int id, bool masked);
185
186/* implemented in intercept.c */
187void kvm_s390_rewind_psw(struct kvm_vcpu *vcpu, int ilc);
188int kvm_handle_sie_intercept(struct kvm_vcpu *vcpu);
189
190/* implemented in priv.c */
191int is_valid_psw(psw_t *psw);
192int kvm_s390_handle_b2(struct kvm_vcpu *vcpu);
193int kvm_s390_handle_e5(struct kvm_vcpu *vcpu);
194int kvm_s390_handle_01(struct kvm_vcpu *vcpu);
195int kvm_s390_handle_b9(struct kvm_vcpu *vcpu);
196int kvm_s390_handle_lpsw(struct kvm_vcpu *vcpu);
197int kvm_s390_handle_stctl(struct kvm_vcpu *vcpu);
198int kvm_s390_handle_lctl(struct kvm_vcpu *vcpu);
199int kvm_s390_handle_eb(struct kvm_vcpu *vcpu);
200
201/* implemented in sigp.c */
202int kvm_s390_handle_sigp(struct kvm_vcpu *vcpu);
203int kvm_s390_handle_sigp_pei(struct kvm_vcpu *vcpu);
204
205/* implemented in kvm-s390.c */
206long kvm_arch_fault_in_page(struct kvm_vcpu *vcpu, gpa_t gpa, int writable);
207int kvm_s390_store_status_unloaded(struct kvm_vcpu *vcpu, unsigned long addr);
208int kvm_s390_store_adtl_status_unloaded(struct kvm_vcpu *vcpu,
209					unsigned long addr);
210int kvm_s390_vcpu_store_status(struct kvm_vcpu *vcpu, unsigned long addr);
211int kvm_s390_vcpu_store_adtl_status(struct kvm_vcpu *vcpu, unsigned long addr);
212void kvm_s390_vcpu_start(struct kvm_vcpu *vcpu);
213void kvm_s390_vcpu_stop(struct kvm_vcpu *vcpu);
214void s390_vcpu_block(struct kvm_vcpu *vcpu);
215void s390_vcpu_unblock(struct kvm_vcpu *vcpu);
216void exit_sie(struct kvm_vcpu *vcpu);
217void exit_sie_sync(struct kvm_vcpu *vcpu);
218int kvm_s390_vcpu_setup_cmma(struct kvm_vcpu *vcpu);
219void kvm_s390_vcpu_unsetup_cmma(struct kvm_vcpu *vcpu);
220/* is cmma enabled */
221bool kvm_s390_cmma_enabled(struct kvm *kvm);
222unsigned long kvm_s390_fac_list_mask_size(void);
223extern unsigned long kvm_s390_fac_list_mask[];
224
225/* implemented in diag.c */
226int kvm_s390_handle_diag(struct kvm_vcpu *vcpu);
227/* implemented in interrupt.c */
228int kvm_s390_inject_prog_irq(struct kvm_vcpu *vcpu,
229			     struct kvm_s390_pgm_info *pgm_info);
230
231/**
232 * kvm_s390_inject_prog_cond - conditionally inject a program check
233 * @vcpu: virtual cpu
234 * @rc: original return/error code
235 *
236 * This function is supposed to be used after regular guest access functions
237 * failed, to conditionally inject a program check to a vcpu. The typical
238 * pattern would look like
239 *
240 * rc = write_guest(vcpu, addr, data, len);
241 * if (rc)
242 *	return kvm_s390_inject_prog_cond(vcpu, rc);
243 *
244 * A negative return code from guest access functions implies an internal error
245 * like e.g. out of memory. In these cases no program check should be injected
246 * to the guest.
247 * A positive value implies that an exception happened while accessing a guest's
248 * memory. In this case all data belonging to the corresponding program check
249 * has been stored in vcpu->arch.pgm and can be injected with
250 * kvm_s390_inject_prog_irq().
251 *
252 * Returns: - the original @rc value if @rc was negative (internal error)
253 *	    - zero if @rc was already zero
254 *	    - zero or error code from injecting if @rc was positive
255 *	      (program check injected to @vcpu)
256 */
257static inline int kvm_s390_inject_prog_cond(struct kvm_vcpu *vcpu, int rc)
258{
259	if (rc <= 0)
260		return rc;
261	return kvm_s390_inject_prog_irq(vcpu, &vcpu->arch.pgm);
262}
263
264int s390int_to_s390irq(struct kvm_s390_interrupt *s390int,
265			struct kvm_s390_irq *s390irq);
266
267/* implemented in interrupt.c */
268int kvm_s390_vcpu_has_irq(struct kvm_vcpu *vcpu, int exclude_stop);
269int psw_extint_disabled(struct kvm_vcpu *vcpu);
270void kvm_s390_destroy_adapters(struct kvm *kvm);
271int kvm_s390_ext_call_pending(struct kvm_vcpu *vcpu);
272extern struct kvm_device_ops kvm_flic_ops;
273int kvm_s390_is_stop_irq_pending(struct kvm_vcpu *vcpu);
274void kvm_s390_clear_stop_irq(struct kvm_vcpu *vcpu);
275int kvm_s390_set_irq_state(struct kvm_vcpu *vcpu,
276			   void __user *buf, int len);
277int kvm_s390_get_irq_state(struct kvm_vcpu *vcpu,
278			   __u8 __user *buf, int len);
279
280/* implemented in guestdbg.c */
281void kvm_s390_backup_guest_per_regs(struct kvm_vcpu *vcpu);
282void kvm_s390_restore_guest_per_regs(struct kvm_vcpu *vcpu);
283void kvm_s390_patch_guest_per_regs(struct kvm_vcpu *vcpu);
284int kvm_s390_import_bp_data(struct kvm_vcpu *vcpu,
285			    struct kvm_guest_debug *dbg);
286void kvm_s390_clear_bp_data(struct kvm_vcpu *vcpu);
287void kvm_s390_prepare_debug_exit(struct kvm_vcpu *vcpu);
288void kvm_s390_handle_per_event(struct kvm_vcpu *vcpu);
289
290#endif
291