1 /* SPDX-License-Identifier: GPL-2.0 */
3 * definition for kvm on s390
5 * Copyright IBM Corp. 2008, 2020
7 * Author(s): Carsten Otte <cotte@de.ibm.com>
8 * Christian Borntraeger <borntraeger@de.ibm.com>
9 * Christian Ehrhardt <ehrhardt@de.ibm.com>
12 #ifndef ARCH_S390_KVM_S390_H
13 #define ARCH_S390_KVM_S390_H
15 #include <linux/hrtimer.h>
16 #include <linux/kvm.h>
17 #include <linux/kvm_host.h>
18 #include <linux/lockdep.h>
19 #include <asm/facility.h>
20 #include <asm/processor.h>
23 /* Transactional Memory Execution related macros */
24 #define IS_TE_ENABLED(vcpu) ((vcpu->arch.sie_block->ecb & ECB_TE))
26 #define IS_ITDB_VALID(vcpu) \
27 ((*(char *)phys_to_virt((vcpu)->arch.sie_block->itdba) == TDB_FORMAT1))
29 extern debug_info_t *kvm_s390_dbf;
30 extern debug_info_t *kvm_s390_dbf_uv;
32 #define KVM_UV_EVENT(d_kvm, d_loglevel, d_string, d_args...)\
34 debug_sprintf_event((d_kvm)->arch.dbf, d_loglevel, d_string "\n", \
36 debug_sprintf_event(kvm_s390_dbf_uv, d_loglevel, \
37 "%d: " d_string "\n", (d_kvm)->userspace_pid, \
41 #define KVM_EVENT(d_loglevel, d_string, d_args...)\
43 debug_sprintf_event(kvm_s390_dbf, d_loglevel, d_string "\n", \
47 #define VM_EVENT(d_kvm, d_loglevel, d_string, d_args...)\
49 debug_sprintf_event(d_kvm->arch.dbf, d_loglevel, d_string "\n", \
53 #define VCPU_EVENT(d_vcpu, d_loglevel, d_string, d_args...)\
55 debug_sprintf_event(d_vcpu->kvm->arch.dbf, d_loglevel, \
56 "%02d[%016lx-%016lx]: " d_string "\n", d_vcpu->vcpu_id, \
57 d_vcpu->arch.sie_block->gpsw.mask, d_vcpu->arch.sie_block->gpsw.addr,\
61 static inline void kvm_s390_set_cpuflags(struct kvm_vcpu *vcpu, u32 flags)
63 atomic_or(flags, &vcpu->arch.sie_block->cpuflags);
66 static inline void kvm_s390_clear_cpuflags(struct kvm_vcpu *vcpu, u32 flags)
68 atomic_andnot(flags, &vcpu->arch.sie_block->cpuflags);
71 static inline bool kvm_s390_test_cpuflags(struct kvm_vcpu *vcpu, u32 flags)
73 return (atomic_read(&vcpu->arch.sie_block->cpuflags) & flags) == flags;
76 static inline int is_vcpu_stopped(struct kvm_vcpu *vcpu)
78 return kvm_s390_test_cpuflags(vcpu, CPUSTAT_STOPPED);
81 static inline int is_vcpu_idle(struct kvm_vcpu *vcpu)
83 return test_bit(vcpu->vcpu_idx, vcpu->kvm->arch.idle_mask);
86 static inline int kvm_is_ucontrol(struct kvm *kvm)
88 #ifdef CONFIG_KVM_S390_UCONTROL
97 #define GUEST_PREFIX_SHIFT 13
98 static inline u32 kvm_s390_get_prefix(struct kvm_vcpu *vcpu)
100 return vcpu->arch.sie_block->prefix << GUEST_PREFIX_SHIFT;
103 static inline void kvm_s390_set_prefix(struct kvm_vcpu *vcpu, u32 prefix)
105 VCPU_EVENT(vcpu, 3, "set prefix of cpu %03u to 0x%x", vcpu->vcpu_id,
107 vcpu->arch.sie_block->prefix = prefix >> GUEST_PREFIX_SHIFT;
108 kvm_make_request(KVM_REQ_TLB_FLUSH, vcpu);
109 kvm_make_request(KVM_REQ_REFRESH_GUEST_PREFIX, vcpu);
112 static inline u64 kvm_s390_get_base_disp_s(struct kvm_vcpu *vcpu, u8 *ar)
114 u32 base2 = vcpu->arch.sie_block->ipb >> 28;
115 u32 disp2 = ((vcpu->arch.sie_block->ipb & 0x0fff0000) >> 16);
120 return (base2 ? vcpu->run->s.regs.gprs[base2] : 0) + disp2;
123 static inline void kvm_s390_get_base_disp_sse(struct kvm_vcpu *vcpu,
124 u64 *address1, u64 *address2,
125 u8 *ar_b1, u8 *ar_b2)
127 u32 base1 = (vcpu->arch.sie_block->ipb & 0xf0000000) >> 28;
128 u32 disp1 = (vcpu->arch.sie_block->ipb & 0x0fff0000) >> 16;
129 u32 base2 = (vcpu->arch.sie_block->ipb & 0xf000) >> 12;
130 u32 disp2 = vcpu->arch.sie_block->ipb & 0x0fff;
132 *address1 = (base1 ? vcpu->run->s.regs.gprs[base1] : 0) + disp1;
133 *address2 = (base2 ? vcpu->run->s.regs.gprs[base2] : 0) + disp2;
141 static inline void kvm_s390_get_regs_rre(struct kvm_vcpu *vcpu, int *r1, int *r2)
144 *r1 = (vcpu->arch.sie_block->ipb & 0x00f00000) >> 20;
146 *r2 = (vcpu->arch.sie_block->ipb & 0x000f0000) >> 16;
149 static inline u64 kvm_s390_get_base_disp_rsy(struct kvm_vcpu *vcpu, u8 *ar)
151 u32 base2 = vcpu->arch.sie_block->ipb >> 28;
152 u32 disp2 = ((vcpu->arch.sie_block->ipb & 0x0fff0000) >> 16) +
153 ((vcpu->arch.sie_block->ipb & 0xff00) << 4);
154 /* The displacement is a 20bit _SIGNED_ value */
161 return (base2 ? vcpu->run->s.regs.gprs[base2] : 0) + (long)(int)disp2;
164 static inline u64 kvm_s390_get_base_disp_rs(struct kvm_vcpu *vcpu, u8 *ar)
166 u32 base2 = vcpu->arch.sie_block->ipb >> 28;
167 u32 disp2 = ((vcpu->arch.sie_block->ipb & 0x0fff0000) >> 16);
172 return (base2 ? vcpu->run->s.regs.gprs[base2] : 0) + disp2;
175 /* Set the condition code in the guest program status word */
176 static inline void kvm_s390_set_psw_cc(struct kvm_vcpu *vcpu, unsigned long cc)
178 vcpu->arch.sie_block->gpsw.mask &= ~(3UL << 44);
179 vcpu->arch.sie_block->gpsw.mask |= cc << 44;
182 /* test availability of facility in a kvm instance */
183 static inline int test_kvm_facility(struct kvm *kvm, unsigned long nr)
185 return __test_facility(nr, kvm->arch.model.fac_mask) &&
186 __test_facility(nr, kvm->arch.model.fac_list);
189 static inline int set_kvm_facility(u64 *fac_list, unsigned long nr)
193 if (nr >= MAX_FACILITY_BIT)
195 ptr = (unsigned char *) fac_list + (nr >> 3);
196 *ptr |= (0x80UL >> (nr & 7));
200 static inline int test_kvm_cpu_feat(struct kvm *kvm, unsigned long nr)
202 WARN_ON_ONCE(nr >= KVM_S390_VM_CPU_FEAT_NR_BITS);
203 return test_bit_inv(nr, kvm->arch.cpu_feat);
206 /* are cpu states controlled by user space */
207 static inline int kvm_s390_user_cpu_state_ctrl(struct kvm *kvm)
209 return kvm->arch.user_cpu_state_ctrl != 0;
212 static inline void kvm_s390_set_user_cpu_state_ctrl(struct kvm *kvm)
214 if (kvm->arch.user_cpu_state_ctrl)
217 VM_EVENT(kvm, 3, "%s", "ENABLE: Userspace CPU state control");
218 kvm->arch.user_cpu_state_ctrl = 1;
221 /* get the end gfn of the last (highest gfn) memslot */
222 static inline unsigned long kvm_s390_get_gfn_end(struct kvm_memslots *slots)
224 struct rb_node *node;
225 struct kvm_memory_slot *ms;
227 if (WARN_ON(kvm_memslots_empty(slots)))
230 node = rb_last(&slots->gfn_tree);
231 ms = container_of(node, struct kvm_memory_slot, gfn_node[slots->node_idx]);
232 return ms->base_gfn + ms->npages;
235 static inline u32 kvm_s390_get_gisa_desc(struct kvm *kvm)
237 u32 gd = virt_to_phys(kvm->arch.gisa_int.origin);
239 if (gd && sclp.has_gisaf)
244 /* implemented in pv.c */
245 int kvm_s390_pv_destroy_cpu(struct kvm_vcpu *vcpu, u16 *rc, u16 *rrc);
246 int kvm_s390_pv_create_cpu(struct kvm_vcpu *vcpu, u16 *rc, u16 *rrc);
247 int kvm_s390_pv_set_aside(struct kvm *kvm, u16 *rc, u16 *rrc);
248 int kvm_s390_pv_deinit_aside_vm(struct kvm *kvm, u16 *rc, u16 *rrc);
249 int kvm_s390_pv_deinit_cleanup_all(struct kvm *kvm, u16 *rc, u16 *rrc);
250 int kvm_s390_pv_deinit_vm(struct kvm *kvm, u16 *rc, u16 *rrc);
251 int kvm_s390_pv_init_vm(struct kvm *kvm, u16 *rc, u16 *rrc);
252 int kvm_s390_pv_set_sec_parms(struct kvm *kvm, void *hdr, u64 length, u16 *rc,
254 int kvm_s390_pv_unpack(struct kvm *kvm, unsigned long addr, unsigned long size,
255 unsigned long tweak, u16 *rc, u16 *rrc);
256 int kvm_s390_pv_set_cpu_state(struct kvm_vcpu *vcpu, u8 state);
257 int kvm_s390_pv_dump_cpu(struct kvm_vcpu *vcpu, void *buff, u16 *rc, u16 *rrc);
258 int kvm_s390_pv_dump_stor_state(struct kvm *kvm, void __user *buff_user,
259 u64 *gaddr, u64 buff_user_len, u16 *rc, u16 *rrc);
260 int kvm_s390_pv_dump_complete(struct kvm *kvm, void __user *buff_user,
263 static inline u64 kvm_s390_pv_get_handle(struct kvm *kvm)
265 return kvm->arch.pv.handle;
268 static inline u64 kvm_s390_pv_cpu_get_handle(struct kvm_vcpu *vcpu)
270 return vcpu->arch.pv.handle;
273 /* implemented in interrupt.c */
274 int kvm_s390_handle_wait(struct kvm_vcpu *vcpu);
275 void kvm_s390_vcpu_wakeup(struct kvm_vcpu *vcpu);
276 enum hrtimer_restart kvm_s390_idle_wakeup(struct hrtimer *timer);
277 int __must_check kvm_s390_deliver_pending_interrupts(struct kvm_vcpu *vcpu);
278 void kvm_s390_clear_local_irqs(struct kvm_vcpu *vcpu);
279 void kvm_s390_clear_float_irqs(struct kvm *kvm);
280 int __must_check kvm_s390_inject_vm(struct kvm *kvm,
281 struct kvm_s390_interrupt *s390int);
282 int __must_check kvm_s390_inject_vcpu(struct kvm_vcpu *vcpu,
283 struct kvm_s390_irq *irq);
284 static inline int kvm_s390_inject_prog_irq(struct kvm_vcpu *vcpu,
285 struct kvm_s390_pgm_info *pgm_info)
287 struct kvm_s390_irq irq = {
288 .type = KVM_S390_PROGRAM_INT,
292 return kvm_s390_inject_vcpu(vcpu, &irq);
294 static inline int kvm_s390_inject_program_int(struct kvm_vcpu *vcpu, u16 code)
296 struct kvm_s390_irq irq = {
297 .type = KVM_S390_PROGRAM_INT,
301 return kvm_s390_inject_vcpu(vcpu, &irq);
303 struct kvm_s390_interrupt_info *kvm_s390_get_io_int(struct kvm *kvm,
304 u64 isc_mask, u32 schid);
305 int kvm_s390_reinject_io_int(struct kvm *kvm,
306 struct kvm_s390_interrupt_info *inti);
307 int kvm_s390_mask_adapter(struct kvm *kvm, unsigned int id, bool masked);
309 /* implemented in intercept.c */
310 u8 kvm_s390_get_ilen(struct kvm_vcpu *vcpu);
311 int kvm_handle_sie_intercept(struct kvm_vcpu *vcpu);
312 static inline void kvm_s390_rewind_psw(struct kvm_vcpu *vcpu, int ilen)
314 struct kvm_s390_sie_block *sie_block = vcpu->arch.sie_block;
316 sie_block->gpsw.addr = __rewind_psw(sie_block->gpsw, ilen);
318 static inline void kvm_s390_forward_psw(struct kvm_vcpu *vcpu, int ilen)
320 kvm_s390_rewind_psw(vcpu, -ilen);
322 static inline void kvm_s390_retry_instr(struct kvm_vcpu *vcpu)
324 /* don't inject PER events if we re-execute the instruction */
325 vcpu->arch.sie_block->icptstatus &= ~0x02;
326 kvm_s390_rewind_psw(vcpu, kvm_s390_get_ilen(vcpu));
329 int handle_sthyi(struct kvm_vcpu *vcpu);
331 /* implemented in priv.c */
332 int is_valid_psw(psw_t *psw);
333 int kvm_s390_handle_aa(struct kvm_vcpu *vcpu);
334 int kvm_s390_handle_b2(struct kvm_vcpu *vcpu);
335 int kvm_s390_handle_e3(struct kvm_vcpu *vcpu);
336 int kvm_s390_handle_e5(struct kvm_vcpu *vcpu);
337 int kvm_s390_handle_01(struct kvm_vcpu *vcpu);
338 int kvm_s390_handle_b9(struct kvm_vcpu *vcpu);
339 int kvm_s390_handle_lpsw(struct kvm_vcpu *vcpu);
340 int kvm_s390_handle_stctl(struct kvm_vcpu *vcpu);
341 int kvm_s390_handle_lctl(struct kvm_vcpu *vcpu);
342 int kvm_s390_handle_eb(struct kvm_vcpu *vcpu);
343 int kvm_s390_skey_check_enable(struct kvm_vcpu *vcpu);
345 /* implemented in vsie.c */
346 int kvm_s390_handle_vsie(struct kvm_vcpu *vcpu);
347 void kvm_s390_vsie_kick(struct kvm_vcpu *vcpu);
348 void kvm_s390_vsie_gmap_notifier(struct gmap *gmap, unsigned long start,
350 void kvm_s390_vsie_init(struct kvm *kvm);
351 void kvm_s390_vsie_destroy(struct kvm *kvm);
353 /* implemented in sigp.c */
354 int kvm_s390_handle_sigp(struct kvm_vcpu *vcpu);
355 int kvm_s390_handle_sigp_pei(struct kvm_vcpu *vcpu);
357 /* implemented in kvm-s390.c */
358 int kvm_s390_try_set_tod_clock(struct kvm *kvm, const struct kvm_s390_vm_tod_clock *gtod);
359 long kvm_arch_fault_in_page(struct kvm_vcpu *vcpu, gpa_t gpa, int writable);
360 int kvm_s390_store_status_unloaded(struct kvm_vcpu *vcpu, unsigned long addr);
361 int kvm_s390_vcpu_store_status(struct kvm_vcpu *vcpu, unsigned long addr);
362 int kvm_s390_vcpu_start(struct kvm_vcpu *vcpu);
363 int kvm_s390_vcpu_stop(struct kvm_vcpu *vcpu);
364 void kvm_s390_vcpu_block(struct kvm_vcpu *vcpu);
365 void kvm_s390_vcpu_unblock(struct kvm_vcpu *vcpu);
366 bool kvm_s390_vcpu_sie_inhibited(struct kvm_vcpu *vcpu);
367 void exit_sie(struct kvm_vcpu *vcpu);
368 void kvm_s390_sync_request(int req, struct kvm_vcpu *vcpu);
369 int kvm_s390_vcpu_setup_cmma(struct kvm_vcpu *vcpu);
370 void kvm_s390_vcpu_unsetup_cmma(struct kvm_vcpu *vcpu);
371 void kvm_s390_set_cpu_timer(struct kvm_vcpu *vcpu, __u64 cputm);
372 __u64 kvm_s390_get_cpu_timer(struct kvm_vcpu *vcpu);
373 int kvm_s390_cpus_from_pv(struct kvm *kvm, u16 *rc, u16 *rrc);
375 /* implemented in diag.c */
376 int kvm_s390_handle_diag(struct kvm_vcpu *vcpu);
378 static inline void kvm_s390_vcpu_block_all(struct kvm *kvm)
381 struct kvm_vcpu *vcpu;
383 WARN_ON(!mutex_is_locked(&kvm->lock));
384 kvm_for_each_vcpu(i, vcpu, kvm)
385 kvm_s390_vcpu_block(vcpu);
388 static inline void kvm_s390_vcpu_unblock_all(struct kvm *kvm)
391 struct kvm_vcpu *vcpu;
393 kvm_for_each_vcpu(i, vcpu, kvm)
394 kvm_s390_vcpu_unblock(vcpu);
397 static inline u64 kvm_s390_get_tod_clock_fast(struct kvm *kvm)
402 rc = get_tod_clock_fast() + kvm->arch.epoch;
408 * kvm_s390_inject_prog_cond - conditionally inject a program check
410 * @rc: original return/error code
412 * This function is supposed to be used after regular guest access functions
413 * failed, to conditionally inject a program check to a vcpu. The typical
414 * pattern would look like
416 * rc = write_guest(vcpu, addr, data, len);
418 * return kvm_s390_inject_prog_cond(vcpu, rc);
420 * A negative return code from guest access functions implies an internal error
421 * like e.g. out of memory. In these cases no program check should be injected
423 * A positive value implies that an exception happened while accessing a guest's
424 * memory. In this case all data belonging to the corresponding program check
425 * has been stored in vcpu->arch.pgm and can be injected with
426 * kvm_s390_inject_prog_irq().
428 * Returns: - the original @rc value if @rc was negative (internal error)
429 * - zero if @rc was already zero
430 * - zero or error code from injecting if @rc was positive
431 * (program check injected to @vcpu)
433 static inline int kvm_s390_inject_prog_cond(struct kvm_vcpu *vcpu, int rc)
437 return kvm_s390_inject_prog_irq(vcpu, &vcpu->arch.pgm);
440 int s390int_to_s390irq(struct kvm_s390_interrupt *s390int,
441 struct kvm_s390_irq *s390irq);
443 /* implemented in interrupt.c */
444 int kvm_s390_vcpu_has_irq(struct kvm_vcpu *vcpu, int exclude_stop);
445 int psw_extint_disabled(struct kvm_vcpu *vcpu);
446 void kvm_s390_destroy_adapters(struct kvm *kvm);
447 int kvm_s390_ext_call_pending(struct kvm_vcpu *vcpu);
448 extern struct kvm_device_ops kvm_flic_ops;
449 int kvm_s390_is_stop_irq_pending(struct kvm_vcpu *vcpu);
450 int kvm_s390_is_restart_irq_pending(struct kvm_vcpu *vcpu);
451 void kvm_s390_clear_stop_irq(struct kvm_vcpu *vcpu);
452 int kvm_s390_set_irq_state(struct kvm_vcpu *vcpu,
453 void __user *buf, int len);
454 int kvm_s390_get_irq_state(struct kvm_vcpu *vcpu,
455 __u8 __user *buf, int len);
456 void kvm_s390_gisa_init(struct kvm *kvm);
457 void kvm_s390_gisa_clear(struct kvm *kvm);
458 void kvm_s390_gisa_destroy(struct kvm *kvm);
459 void kvm_s390_gisa_disable(struct kvm *kvm);
460 void kvm_s390_gisa_enable(struct kvm *kvm);
461 int __init kvm_s390_gib_init(u8 nisc);
462 void kvm_s390_gib_destroy(void);
464 /* implemented in guestdbg.c */
465 void kvm_s390_backup_guest_per_regs(struct kvm_vcpu *vcpu);
466 void kvm_s390_restore_guest_per_regs(struct kvm_vcpu *vcpu);
467 void kvm_s390_patch_guest_per_regs(struct kvm_vcpu *vcpu);
468 int kvm_s390_import_bp_data(struct kvm_vcpu *vcpu,
469 struct kvm_guest_debug *dbg);
470 void kvm_s390_clear_bp_data(struct kvm_vcpu *vcpu);
471 void kvm_s390_prepare_debug_exit(struct kvm_vcpu *vcpu);
472 int kvm_s390_handle_per_ifetch_icpt(struct kvm_vcpu *vcpu);
473 int kvm_s390_handle_per_event(struct kvm_vcpu *vcpu);
475 /* support for Basic/Extended SCA handling */
476 static inline union ipte_control *kvm_s390_get_ipte_control(struct kvm *kvm)
478 struct bsca_block *sca = kvm->arch.sca; /* SCA version doesn't matter */
480 return &sca->ipte_control;
482 static inline int kvm_s390_use_sca_entries(void)
485 * Without SIGP interpretation, only SRS interpretation (if available)
486 * might use the entries. By not setting the entries and keeping them
487 * invalid, hardware will not access them but intercept.
489 return sclp.has_sigpif;
491 void kvm_s390_reinject_machine_check(struct kvm_vcpu *vcpu,
492 struct mcck_volatile_info *mcck_info);
495 * kvm_s390_vcpu_crypto_reset_all
497 * Reset the crypto attributes for each vcpu. This can be done while the vcpus
498 * are running as each vcpu will be removed from SIE before resetting the crypt
499 * attributes and restored to SIE afterward.
501 * Note: The kvm->lock must be held while calling this function
503 * @kvm: the KVM guest
505 void kvm_s390_vcpu_crypto_reset_all(struct kvm *kvm);
508 * kvm_s390_vcpu_pci_enable_interp
510 * Set the associated PCI attributes for each vcpu to allow for zPCI Load/Store
511 * interpretation as well as adapter interruption forwarding.
513 * @kvm: the KVM guest
515 void kvm_s390_vcpu_pci_enable_interp(struct kvm *kvm);
518 * diag9c_forwarding_hz
520 * Set the maximum number of diag9c forwarding per second
522 extern unsigned int diag9c_forwarding_hz;