xref: /openbmc/qemu/target/s390x/cpu.h (revision ad4ec279)
1 /*
2  * S/390 virtual CPU header
3  *
4  * For details on the s390x architecture and used definitions (e.g.,
5  * PSW, PER and DAT (Dynamic Address Translation)), please refer to
6  * the "z/Architecture Principles of Operations" - a.k.a. PoP.
7  *
8  *  Copyright (c) 2009 Ulrich Hecht
9  *  Copyright IBM Corp. 2012, 2018
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, see <http://www.gnu.org/licenses/>.
23  */
24 
25 #ifndef S390X_CPU_H
26 #define S390X_CPU_H
27 
28 #include "cpu-qom.h"
29 #include "cpu_models.h"
30 #include "exec/cpu-defs.h"
31 #include "qemu/cpu-float.h"
32 #include "tcg/tcg_s390x.h"
33 
34 #define ELF_MACHINE_UNAME "S390X"
35 
36 /* The z/Architecture has a strong memory model with some store-after-load re-ordering */
37 #define TCG_GUEST_DEFAULT_MO      (TCG_MO_ALL & ~TCG_MO_ST_LD)
38 
39 #define TARGET_HAS_PRECISE_SMC
40 
41 #define TARGET_INSN_START_EXTRA_WORDS 2
42 
43 #define MMU_USER_IDX 0
44 
45 #define S390_MAX_CPUS 248
46 
47 #ifndef CONFIG_KVM
48 #define S390_ADAPTER_SUPPRESSIBLE 0x01
49 #else
50 #define S390_ADAPTER_SUPPRESSIBLE KVM_S390_ADAPTER_SUPPRESSIBLE
51 #endif
52 
53 typedef struct PSW {
54     uint64_t mask;
55     uint64_t addr;
56 } PSW;
57 
58 struct CPUArchState {
59     uint64_t regs[16];     /* GP registers */
60     /*
61      * The floating point registers are part of the vector registers.
62      * vregs[0][0] -> vregs[15][0] are 16 floating point registers
63      */
64     uint64_t vregs[32][2] QEMU_ALIGNED(16);  /* vector registers */
65     uint32_t aregs[16];    /* access registers */
66     uint64_t gscb[4];      /* guarded storage control */
67     uint64_t etoken;       /* etoken */
68     uint64_t etoken_extension; /* etoken extension */
69 
70     uint64_t diag318_info;
71 
72     /* Fields up to this point are not cleared by initial CPU reset */
73     struct {} start_initial_reset_fields;
74 
75     uint32_t fpc;          /* floating-point control register */
76     uint32_t cc_op;
77     bool bpbc;             /* branch prediction blocking */
78 
79     float_status fpu_status; /* passed to softfloat lib */
80 
81     PSW psw;
82 
83     S390CrashReason crash_reason;
84 
85     uint64_t cc_src;
86     uint64_t cc_dst;
87     uint64_t cc_vr;
88 
89     uint64_t ex_value;
90     uint64_t ex_target;
91 
92     uint64_t __excp_addr;
93     uint64_t psa;
94 
95     uint32_t int_pgm_code;
96     uint32_t int_pgm_ilen;
97 
98     uint32_t int_svc_code;
99     uint32_t int_svc_ilen;
100 
101     uint64_t per_address;
102     uint16_t per_perc_atmid;
103 
104     uint64_t cregs[16]; /* control registers */
105 
106     uint64_t ckc;
107     uint64_t cputm;
108     uint32_t todpr;
109 
110     uint64_t pfault_token;
111     uint64_t pfault_compare;
112     uint64_t pfault_select;
113 
114     uint64_t gbea;
115     uint64_t pp;
116 
117     /* Fields up to this point are not cleared by normal CPU reset */
118     struct {} start_normal_reset_fields;
119     uint8_t riccb[64];     /* runtime instrumentation control */
120 
121     int pending_int;
122     uint16_t external_call_addr;
123     DECLARE_BITMAP(emergency_signals, S390_MAX_CPUS);
124 
125 #if !defined(CONFIG_USER_ONLY)
126     uint64_t tlb_fill_tec;   /* translation exception code during tlb_fill */
127     int tlb_fill_exc;        /* exception number seen during tlb_fill */
128 #endif
129 
130     /* Fields up to this point are cleared by a CPU reset */
131     struct {} end_reset_fields;
132 
133 #if !defined(CONFIG_USER_ONLY)
134     uint32_t core_id; /* PoP "CPU address", same as cpu_index */
135     uint64_t cpuid;
136 #endif
137 
138     QEMUTimer *tod_timer;
139 
140     QEMUTimer *cpu_timer;
141 
142     /*
143      * The cpu state represents the logical state of a cpu. In contrast to other
144      * architectures, there is a difference between a halt and a stop on s390.
145      * If all cpus are either stopped (including check stop) or in the disabled
146      * wait state, the vm can be shut down.
147      * The acceptable cpu_state values are defined in the CpuInfoS390State
148      * enum.
149      */
150     uint8_t cpu_state;
151 
152     /* currently processed sigp order */
153     uint8_t sigp_order;
154 
155 };
156 
157 static inline uint64_t *get_freg(CPUS390XState *cs, int nr)
158 {
159     return &cs->vregs[nr][0];
160 }
161 
162 /**
163  * S390CPU:
164  * @env: #CPUS390XState.
165  *
166  * An S/390 CPU.
167  */
168 struct ArchCPU {
169     /*< private >*/
170     CPUState parent_obj;
171     /*< public >*/
172 
173     CPUNegativeOffsetState neg;
174     CPUS390XState env;
175     S390CPUModel *model;
176     /* needed for live migration */
177     void *irqstate;
178     uint32_t irqstate_saved_size;
179 };
180 
181 
182 #ifndef CONFIG_USER_ONLY
183 extern const VMStateDescription vmstate_s390_cpu;
184 #endif
185 
186 /* distinguish between 24 bit and 31 bit addressing */
187 #define HIGH_ORDER_BIT 0x80000000
188 
189 /* Interrupt Codes */
190 /* Program Interrupts */
191 #define PGM_OPERATION                   0x0001
192 #define PGM_PRIVILEGED                  0x0002
193 #define PGM_EXECUTE                     0x0003
194 #define PGM_PROTECTION                  0x0004
195 #define PGM_ADDRESSING                  0x0005
196 #define PGM_SPECIFICATION               0x0006
197 #define PGM_DATA                        0x0007
198 #define PGM_FIXPT_OVERFLOW              0x0008
199 #define PGM_FIXPT_DIVIDE                0x0009
200 #define PGM_DEC_OVERFLOW                0x000a
201 #define PGM_DEC_DIVIDE                  0x000b
202 #define PGM_HFP_EXP_OVERFLOW            0x000c
203 #define PGM_HFP_EXP_UNDERFLOW           0x000d
204 #define PGM_HFP_SIGNIFICANCE            0x000e
205 #define PGM_HFP_DIVIDE                  0x000f
206 #define PGM_SEGMENT_TRANS               0x0010
207 #define PGM_PAGE_TRANS                  0x0011
208 #define PGM_TRANS_SPEC                  0x0012
209 #define PGM_SPECIAL_OP                  0x0013
210 #define PGM_OPERAND                     0x0015
211 #define PGM_TRACE_TABLE                 0x0016
212 #define PGM_VECTOR_PROCESSING           0x001b
213 #define PGM_SPACE_SWITCH                0x001c
214 #define PGM_HFP_SQRT                    0x001d
215 #define PGM_PC_TRANS_SPEC               0x001f
216 #define PGM_AFX_TRANS                   0x0020
217 #define PGM_ASX_TRANS                   0x0021
218 #define PGM_LX_TRANS                    0x0022
219 #define PGM_EX_TRANS                    0x0023
220 #define PGM_PRIM_AUTH                   0x0024
221 #define PGM_SEC_AUTH                    0x0025
222 #define PGM_ALET_SPEC                   0x0028
223 #define PGM_ALEN_SPEC                   0x0029
224 #define PGM_ALE_SEQ                     0x002a
225 #define PGM_ASTE_VALID                  0x002b
226 #define PGM_ASTE_SEQ                    0x002c
227 #define PGM_EXT_AUTH                    0x002d
228 #define PGM_STACK_FULL                  0x0030
229 #define PGM_STACK_EMPTY                 0x0031
230 #define PGM_STACK_SPEC                  0x0032
231 #define PGM_STACK_TYPE                  0x0033
232 #define PGM_STACK_OP                    0x0034
233 #define PGM_ASCE_TYPE                   0x0038
234 #define PGM_REG_FIRST_TRANS             0x0039
235 #define PGM_REG_SEC_TRANS               0x003a
236 #define PGM_REG_THIRD_TRANS             0x003b
237 #define PGM_MONITOR                     0x0040
238 #define PGM_PER                         0x0080
239 #define PGM_CRYPTO                      0x0119
240 
241 /* External Interrupts */
242 #define EXT_INTERRUPT_KEY               0x0040
243 #define EXT_CLOCK_COMP                  0x1004
244 #define EXT_CPU_TIMER                   0x1005
245 #define EXT_MALFUNCTION                 0x1200
246 #define EXT_EMERGENCY                   0x1201
247 #define EXT_EXTERNAL_CALL               0x1202
248 #define EXT_ETR                         0x1406
249 #define EXT_SERVICE                     0x2401
250 #define EXT_VIRTIO                      0x2603
251 
252 /* PSW defines */
253 #undef PSW_MASK_PER
254 #undef PSW_MASK_UNUSED_2
255 #undef PSW_MASK_UNUSED_3
256 #undef PSW_MASK_DAT
257 #undef PSW_MASK_IO
258 #undef PSW_MASK_EXT
259 #undef PSW_MASK_KEY
260 #undef PSW_SHIFT_KEY
261 #undef PSW_MASK_MCHECK
262 #undef PSW_MASK_WAIT
263 #undef PSW_MASK_PSTATE
264 #undef PSW_MASK_ASC
265 #undef PSW_SHIFT_ASC
266 #undef PSW_MASK_CC
267 #undef PSW_MASK_PM
268 #undef PSW_MASK_RI
269 #undef PSW_SHIFT_MASK_PM
270 #undef PSW_MASK_64
271 #undef PSW_MASK_32
272 #undef PSW_MASK_ESA_ADDR
273 
274 #define PSW_MASK_PER            0x4000000000000000ULL
275 #define PSW_MASK_UNUSED_2       0x2000000000000000ULL
276 #define PSW_MASK_UNUSED_3       0x1000000000000000ULL
277 #define PSW_MASK_DAT            0x0400000000000000ULL
278 #define PSW_MASK_IO             0x0200000000000000ULL
279 #define PSW_MASK_EXT            0x0100000000000000ULL
280 #define PSW_MASK_KEY            0x00F0000000000000ULL
281 #define PSW_SHIFT_KEY           52
282 #define PSW_MASK_SHORTPSW       0x0008000000000000ULL
283 #define PSW_MASK_MCHECK         0x0004000000000000ULL
284 #define PSW_MASK_WAIT           0x0002000000000000ULL
285 #define PSW_MASK_PSTATE         0x0001000000000000ULL
286 #define PSW_MASK_ASC            0x0000C00000000000ULL
287 #define PSW_SHIFT_ASC           46
288 #define PSW_MASK_CC             0x0000300000000000ULL
289 #define PSW_MASK_PM             0x00000F0000000000ULL
290 #define PSW_SHIFT_MASK_PM       40
291 #define PSW_MASK_RI             0x0000008000000000ULL
292 #define PSW_MASK_64             0x0000000100000000ULL
293 #define PSW_MASK_32             0x0000000080000000ULL
294 #define PSW_MASK_SHORT_ADDR     0x000000007fffffffULL
295 #define PSW_MASK_SHORT_CTRL     0xffffffff80000000ULL
296 #define PSW_MASK_RESERVED       0xb80800fe7fffffffULL
297 
298 #undef PSW_ASC_PRIMARY
299 #undef PSW_ASC_ACCREG
300 #undef PSW_ASC_SECONDARY
301 #undef PSW_ASC_HOME
302 
303 #define PSW_ASC_PRIMARY         0x0000000000000000ULL
304 #define PSW_ASC_ACCREG          0x0000400000000000ULL
305 #define PSW_ASC_SECONDARY       0x0000800000000000ULL
306 #define PSW_ASC_HOME            0x0000C00000000000ULL
307 
308 /* the address space values shifted */
309 #define AS_PRIMARY              0
310 #define AS_ACCREG               1
311 #define AS_SECONDARY            2
312 #define AS_HOME                 3
313 
314 /* tb flags */
315 
316 #define FLAG_MASK_PSW_SHIFT     31
317 #define FLAG_MASK_PER           (PSW_MASK_PER    >> FLAG_MASK_PSW_SHIFT)
318 #define FLAG_MASK_DAT           (PSW_MASK_DAT    >> FLAG_MASK_PSW_SHIFT)
319 #define FLAG_MASK_PSTATE        (PSW_MASK_PSTATE >> FLAG_MASK_PSW_SHIFT)
320 #define FLAG_MASK_ASC           (PSW_MASK_ASC    >> FLAG_MASK_PSW_SHIFT)
321 #define FLAG_MASK_64            (PSW_MASK_64     >> FLAG_MASK_PSW_SHIFT)
322 #define FLAG_MASK_32            (PSW_MASK_32     >> FLAG_MASK_PSW_SHIFT)
323 #define FLAG_MASK_PSW           (FLAG_MASK_PER | FLAG_MASK_DAT | FLAG_MASK_PSTATE \
324                                 | FLAG_MASK_ASC | FLAG_MASK_64 | FLAG_MASK_32)
325 
326 /* we'll use some unused PSW positions to store CR flags in tb flags */
327 #define FLAG_MASK_AFP           (PSW_MASK_UNUSED_2 >> FLAG_MASK_PSW_SHIFT)
328 #define FLAG_MASK_VECTOR        (PSW_MASK_UNUSED_3 >> FLAG_MASK_PSW_SHIFT)
329 
330 /* Control register 0 bits */
331 #define CR0_LOWPROT             0x0000000010000000ULL
332 #define CR0_SECONDARY           0x0000000004000000ULL
333 #define CR0_EDAT                0x0000000000800000ULL
334 #define CR0_AFP                 0x0000000000040000ULL
335 #define CR0_VECTOR              0x0000000000020000ULL
336 #define CR0_IEP                 0x0000000000100000ULL
337 #define CR0_EMERGENCY_SIGNAL_SC 0x0000000000004000ULL
338 #define CR0_EXTERNAL_CALL_SC    0x0000000000002000ULL
339 #define CR0_CKC_SC              0x0000000000000800ULL
340 #define CR0_CPU_TIMER_SC        0x0000000000000400ULL
341 #define CR0_SERVICE_SC          0x0000000000000200ULL
342 
343 /* Control register 14 bits */
344 #define CR14_CHANNEL_REPORT_SC  0x0000000010000000ULL
345 
346 /* MMU */
347 #define MMU_PRIMARY_IDX         0
348 #define MMU_SECONDARY_IDX       1
349 #define MMU_HOME_IDX            2
350 #define MMU_REAL_IDX            3
351 
352 static inline int cpu_mmu_index(CPUS390XState *env, bool ifetch)
353 {
354 #ifdef CONFIG_USER_ONLY
355     return MMU_USER_IDX;
356 #else
357     if (!(env->psw.mask & PSW_MASK_DAT)) {
358         return MMU_REAL_IDX;
359     }
360 
361     if (ifetch) {
362         if ((env->psw.mask & PSW_MASK_ASC) == PSW_ASC_HOME) {
363             return MMU_HOME_IDX;
364         }
365         return MMU_PRIMARY_IDX;
366     }
367 
368     switch (env->psw.mask & PSW_MASK_ASC) {
369     case PSW_ASC_PRIMARY:
370         return MMU_PRIMARY_IDX;
371     case PSW_ASC_SECONDARY:
372         return MMU_SECONDARY_IDX;
373     case PSW_ASC_HOME:
374         return MMU_HOME_IDX;
375     case PSW_ASC_ACCREG:
376         /* Fallthrough: access register mode is not yet supported */
377     default:
378         abort();
379     }
380 #endif
381 }
382 
383 static inline void cpu_get_tb_cpu_state(CPUS390XState *env, vaddr *pc,
384                                         uint64_t *cs_base, uint32_t *flags)
385 {
386     if (env->psw.addr & 1) {
387         /*
388          * Instructions must be at even addresses.
389          * This needs to be checked before address translation.
390          */
391         env->int_pgm_ilen = 2; /* see s390_cpu_tlb_fill() */
392         tcg_s390_program_interrupt(env, PGM_SPECIFICATION, 0);
393     }
394     *pc = env->psw.addr;
395     *cs_base = env->ex_value;
396     *flags = (env->psw.mask >> FLAG_MASK_PSW_SHIFT) & FLAG_MASK_PSW;
397     if (env->cregs[0] & CR0_AFP) {
398         *flags |= FLAG_MASK_AFP;
399     }
400     if (env->cregs[0] & CR0_VECTOR) {
401         *flags |= FLAG_MASK_VECTOR;
402     }
403 }
404 
405 /* PER bits from control register 9 */
406 #define PER_CR9_EVENT_BRANCH           0x80000000
407 #define PER_CR9_EVENT_IFETCH           0x40000000
408 #define PER_CR9_EVENT_STORE            0x20000000
409 #define PER_CR9_EVENT_STORE_REAL       0x08000000
410 #define PER_CR9_EVENT_NULLIFICATION    0x01000000
411 #define PER_CR9_CONTROL_BRANCH_ADDRESS 0x00800000
412 #define PER_CR9_CONTROL_ALTERATION     0x00200000
413 
414 /* PER bits from the PER CODE/ATMID/AI in lowcore */
415 #define PER_CODE_EVENT_BRANCH          0x8000
416 #define PER_CODE_EVENT_IFETCH          0x4000
417 #define PER_CODE_EVENT_STORE           0x2000
418 #define PER_CODE_EVENT_STORE_REAL      0x0800
419 #define PER_CODE_EVENT_NULLIFICATION   0x0100
420 
421 #define EXCP_EXT 1 /* external interrupt */
422 #define EXCP_SVC 2 /* supervisor call (syscall) */
423 #define EXCP_PGM 3 /* program interruption */
424 #define EXCP_RESTART 4 /* restart interrupt */
425 #define EXCP_STOP 5 /* stop interrupt */
426 #define EXCP_IO  7 /* I/O interrupt */
427 #define EXCP_MCHK 8 /* machine check */
428 
429 #define INTERRUPT_EXT_CPU_TIMER          (1 << 3)
430 #define INTERRUPT_EXT_CLOCK_COMPARATOR   (1 << 4)
431 #define INTERRUPT_EXTERNAL_CALL          (1 << 5)
432 #define INTERRUPT_EMERGENCY_SIGNAL       (1 << 6)
433 #define INTERRUPT_RESTART                (1 << 7)
434 #define INTERRUPT_STOP                   (1 << 8)
435 
436 /* Program Status Word.  */
437 #define S390_PSWM_REGNUM 0
438 #define S390_PSWA_REGNUM 1
439 /* General Purpose Registers.  */
440 #define S390_R0_REGNUM 2
441 #define S390_R1_REGNUM 3
442 #define S390_R2_REGNUM 4
443 #define S390_R3_REGNUM 5
444 #define S390_R4_REGNUM 6
445 #define S390_R5_REGNUM 7
446 #define S390_R6_REGNUM 8
447 #define S390_R7_REGNUM 9
448 #define S390_R8_REGNUM 10
449 #define S390_R9_REGNUM 11
450 #define S390_R10_REGNUM 12
451 #define S390_R11_REGNUM 13
452 #define S390_R12_REGNUM 14
453 #define S390_R13_REGNUM 15
454 #define S390_R14_REGNUM 16
455 #define S390_R15_REGNUM 17
456 /* Total Core Registers. */
457 #define S390_NUM_CORE_REGS 18
458 
459 static inline void setcc(S390CPU *cpu, uint64_t cc)
460 {
461     CPUS390XState *env = &cpu->env;
462 
463     env->psw.mask &= ~(3ull << 44);
464     env->psw.mask |= (cc & 3) << 44;
465     env->cc_op = cc;
466 }
467 
468 /* STSI */
469 #define STSI_R0_FC_MASK         0x00000000f0000000ULL
470 #define STSI_R0_FC_CURRENT      0x0000000000000000ULL
471 #define STSI_R0_FC_LEVEL_1      0x0000000010000000ULL
472 #define STSI_R0_FC_LEVEL_2      0x0000000020000000ULL
473 #define STSI_R0_FC_LEVEL_3      0x0000000030000000ULL
474 #define STSI_R0_RESERVED_MASK   0x000000000fffff00ULL
475 #define STSI_R0_SEL1_MASK       0x00000000000000ffULL
476 #define STSI_R1_RESERVED_MASK   0x00000000ffff0000ULL
477 #define STSI_R1_SEL2_MASK       0x000000000000ffffULL
478 
479 /* Basic Machine Configuration */
480 typedef struct SysIB_111 {
481     uint8_t  res1[32];
482     uint8_t  manuf[16];
483     uint8_t  type[4];
484     uint8_t  res2[12];
485     uint8_t  model[16];
486     uint8_t  sequence[16];
487     uint8_t  plant[4];
488     uint8_t  res3[3996];
489 } SysIB_111;
490 QEMU_BUILD_BUG_ON(sizeof(SysIB_111) != 4096);
491 
492 /* Basic Machine CPU */
493 typedef struct SysIB_121 {
494     uint8_t  res1[80];
495     uint8_t  sequence[16];
496     uint8_t  plant[4];
497     uint8_t  res2[2];
498     uint16_t cpu_addr;
499     uint8_t  res3[3992];
500 } SysIB_121;
501 QEMU_BUILD_BUG_ON(sizeof(SysIB_121) != 4096);
502 
503 /* Basic Machine CPUs */
504 typedef struct SysIB_122 {
505     uint8_t res1[32];
506     uint32_t capability;
507     uint16_t total_cpus;
508     uint16_t conf_cpus;
509     uint16_t standby_cpus;
510     uint16_t reserved_cpus;
511     uint16_t adjustments[2026];
512 } SysIB_122;
513 QEMU_BUILD_BUG_ON(sizeof(SysIB_122) != 4096);
514 
515 /* LPAR CPU */
516 typedef struct SysIB_221 {
517     uint8_t  res1[80];
518     uint8_t  sequence[16];
519     uint8_t  plant[4];
520     uint16_t cpu_id;
521     uint16_t cpu_addr;
522     uint8_t  res3[3992];
523 } SysIB_221;
524 QEMU_BUILD_BUG_ON(sizeof(SysIB_221) != 4096);
525 
526 /* LPAR CPUs */
527 typedef struct SysIB_222 {
528     uint8_t  res1[32];
529     uint16_t lpar_num;
530     uint8_t  res2;
531     uint8_t  lcpuc;
532     uint16_t total_cpus;
533     uint16_t conf_cpus;
534     uint16_t standby_cpus;
535     uint16_t reserved_cpus;
536     uint8_t  name[8];
537     uint32_t caf;
538     uint8_t  res3[16];
539     uint16_t dedicated_cpus;
540     uint16_t shared_cpus;
541     uint8_t  res4[4020];
542 } SysIB_222;
543 QEMU_BUILD_BUG_ON(sizeof(SysIB_222) != 4096);
544 
545 /* VM CPUs */
546 typedef struct SysIB_322 {
547     uint8_t  res1[31];
548     uint8_t  count;
549     struct {
550         uint8_t  res2[4];
551         uint16_t total_cpus;
552         uint16_t conf_cpus;
553         uint16_t standby_cpus;
554         uint16_t reserved_cpus;
555         uint8_t  name[8];
556         uint32_t caf;
557         uint8_t  cpi[16];
558         uint8_t res5[3];
559         uint8_t ext_name_encoding;
560         uint32_t res3;
561         uint8_t uuid[16];
562     } vm[8];
563     uint8_t res4[1504];
564     uint8_t ext_names[8][256];
565 } SysIB_322;
566 QEMU_BUILD_BUG_ON(sizeof(SysIB_322) != 4096);
567 
568 typedef union SysIB {
569     SysIB_111 sysib_111;
570     SysIB_121 sysib_121;
571     SysIB_122 sysib_122;
572     SysIB_221 sysib_221;
573     SysIB_222 sysib_222;
574     SysIB_322 sysib_322;
575 } SysIB;
576 QEMU_BUILD_BUG_ON(sizeof(SysIB) != 4096);
577 
578 /* MMU defines */
579 #define ASCE_ORIGIN           (~0xfffULL) /* segment table origin             */
580 #define ASCE_SUBSPACE         0x200       /* subspace group control           */
581 #define ASCE_PRIVATE_SPACE    0x100       /* private space control            */
582 #define ASCE_ALT_EVENT        0x80        /* storage alteration event control */
583 #define ASCE_SPACE_SWITCH     0x40        /* space switch event               */
584 #define ASCE_REAL_SPACE       0x20        /* real space control               */
585 #define ASCE_TYPE_MASK        0x0c        /* asce table type mask             */
586 #define ASCE_TYPE_REGION1     0x0c        /* region first table type          */
587 #define ASCE_TYPE_REGION2     0x08        /* region second table type         */
588 #define ASCE_TYPE_REGION3     0x04        /* region third table type          */
589 #define ASCE_TYPE_SEGMENT     0x00        /* segment table type               */
590 #define ASCE_TABLE_LENGTH     0x03        /* region table length              */
591 
592 #define REGION_ENTRY_ORIGIN         0xfffffffffffff000ULL
593 #define REGION_ENTRY_P              0x0000000000000200ULL
594 #define REGION_ENTRY_TF             0x00000000000000c0ULL
595 #define REGION_ENTRY_I              0x0000000000000020ULL
596 #define REGION_ENTRY_TT             0x000000000000000cULL
597 #define REGION_ENTRY_TL             0x0000000000000003ULL
598 
599 #define REGION_ENTRY_TT_REGION1     0x000000000000000cULL
600 #define REGION_ENTRY_TT_REGION2     0x0000000000000008ULL
601 #define REGION_ENTRY_TT_REGION3     0x0000000000000004ULL
602 
603 #define REGION3_ENTRY_RFAA          0xffffffff80000000ULL
604 #define REGION3_ENTRY_AV            0x0000000000010000ULL
605 #define REGION3_ENTRY_ACC           0x000000000000f000ULL
606 #define REGION3_ENTRY_F             0x0000000000000800ULL
607 #define REGION3_ENTRY_FC            0x0000000000000400ULL
608 #define REGION3_ENTRY_IEP           0x0000000000000100ULL
609 #define REGION3_ENTRY_CR            0x0000000000000010ULL
610 
611 #define SEGMENT_ENTRY_ORIGIN        0xfffffffffffff800ULL
612 #define SEGMENT_ENTRY_SFAA          0xfffffffffff00000ULL
613 #define SEGMENT_ENTRY_AV            0x0000000000010000ULL
614 #define SEGMENT_ENTRY_ACC           0x000000000000f000ULL
615 #define SEGMENT_ENTRY_F             0x0000000000000800ULL
616 #define SEGMENT_ENTRY_FC            0x0000000000000400ULL
617 #define SEGMENT_ENTRY_P             0x0000000000000200ULL
618 #define SEGMENT_ENTRY_IEP           0x0000000000000100ULL
619 #define SEGMENT_ENTRY_I             0x0000000000000020ULL
620 #define SEGMENT_ENTRY_CS            0x0000000000000010ULL
621 #define SEGMENT_ENTRY_TT            0x000000000000000cULL
622 
623 #define SEGMENT_ENTRY_TT_SEGMENT    0x0000000000000000ULL
624 
625 #define PAGE_ENTRY_0                0x0000000000000800ULL
626 #define PAGE_ENTRY_I                0x0000000000000400ULL
627 #define PAGE_ENTRY_P                0x0000000000000200ULL
628 #define PAGE_ENTRY_IEP              0x0000000000000100ULL
629 
630 #define VADDR_REGION1_TX_MASK       0xffe0000000000000ULL
631 #define VADDR_REGION2_TX_MASK       0x001ffc0000000000ULL
632 #define VADDR_REGION3_TX_MASK       0x000003ff80000000ULL
633 #define VADDR_SEGMENT_TX_MASK       0x000000007ff00000ULL
634 #define VADDR_PAGE_TX_MASK          0x00000000000ff000ULL
635 
636 #define VADDR_REGION1_TX(vaddr)     (((vaddr) & VADDR_REGION1_TX_MASK) >> 53)
637 #define VADDR_REGION2_TX(vaddr)     (((vaddr) & VADDR_REGION2_TX_MASK) >> 42)
638 #define VADDR_REGION3_TX(vaddr)     (((vaddr) & VADDR_REGION3_TX_MASK) >> 31)
639 #define VADDR_SEGMENT_TX(vaddr)     (((vaddr) & VADDR_SEGMENT_TX_MASK) >> 20)
640 #define VADDR_PAGE_TX(vaddr)        (((vaddr) & VADDR_PAGE_TX_MASK) >> 12)
641 
642 #define VADDR_REGION1_TL(vaddr)     (((vaddr) & 0xc000000000000000ULL) >> 62)
643 #define VADDR_REGION2_TL(vaddr)     (((vaddr) & 0x0018000000000000ULL) >> 51)
644 #define VADDR_REGION3_TL(vaddr)     (((vaddr) & 0x0000030000000000ULL) >> 40)
645 #define VADDR_SEGMENT_TL(vaddr)     (((vaddr) & 0x0000000060000000ULL) >> 29)
646 
647 #define SK_C                    (0x1 << 1)
648 #define SK_R                    (0x1 << 2)
649 #define SK_F                    (0x1 << 3)
650 #define SK_ACC_MASK             (0xf << 4)
651 
652 /* SIGP order codes */
653 #define SIGP_SENSE             0x01
654 #define SIGP_EXTERNAL_CALL     0x02
655 #define SIGP_EMERGENCY         0x03
656 #define SIGP_START             0x04
657 #define SIGP_STOP              0x05
658 #define SIGP_RESTART           0x06
659 #define SIGP_STOP_STORE_STATUS 0x09
660 #define SIGP_INITIAL_CPU_RESET 0x0b
661 #define SIGP_CPU_RESET         0x0c
662 #define SIGP_SET_PREFIX        0x0d
663 #define SIGP_STORE_STATUS_ADDR 0x0e
664 #define SIGP_SET_ARCH          0x12
665 #define SIGP_COND_EMERGENCY    0x13
666 #define SIGP_SENSE_RUNNING     0x15
667 #define SIGP_STORE_ADTL_STATUS 0x17
668 
669 /* SIGP condition codes */
670 #define SIGP_CC_ORDER_CODE_ACCEPTED 0
671 #define SIGP_CC_STATUS_STORED       1
672 #define SIGP_CC_BUSY                2
673 #define SIGP_CC_NOT_OPERATIONAL     3
674 
675 /* SIGP status bits */
676 #define SIGP_STAT_EQUIPMENT_CHECK   0x80000000UL
677 #define SIGP_STAT_NOT_RUNNING       0x00000400UL
678 #define SIGP_STAT_INCORRECT_STATE   0x00000200UL
679 #define SIGP_STAT_INVALID_PARAMETER 0x00000100UL
680 #define SIGP_STAT_EXT_CALL_PENDING  0x00000080UL
681 #define SIGP_STAT_STOPPED           0x00000040UL
682 #define SIGP_STAT_OPERATOR_INTERV   0x00000020UL
683 #define SIGP_STAT_CHECK_STOP        0x00000010UL
684 #define SIGP_STAT_INOPERATIVE       0x00000004UL
685 #define SIGP_STAT_INVALID_ORDER     0x00000002UL
686 #define SIGP_STAT_RECEIVER_CHECK    0x00000001UL
687 
688 /* SIGP order code mask corresponding to bit positions 56-63 */
689 #define SIGP_ORDER_MASK 0x000000ff
690 
691 /* machine check interruption code */
692 
693 /* subclasses */
694 #define MCIC_SC_SD 0x8000000000000000ULL
695 #define MCIC_SC_PD 0x4000000000000000ULL
696 #define MCIC_SC_SR 0x2000000000000000ULL
697 #define MCIC_SC_CD 0x0800000000000000ULL
698 #define MCIC_SC_ED 0x0400000000000000ULL
699 #define MCIC_SC_DG 0x0100000000000000ULL
700 #define MCIC_SC_W  0x0080000000000000ULL
701 #define MCIC_SC_CP 0x0040000000000000ULL
702 #define MCIC_SC_SP 0x0020000000000000ULL
703 #define MCIC_SC_CK 0x0010000000000000ULL
704 
705 /* subclass modifiers */
706 #define MCIC_SCM_B  0x0002000000000000ULL
707 #define MCIC_SCM_DA 0x0000000020000000ULL
708 #define MCIC_SCM_AP 0x0000000000080000ULL
709 
710 /* storage errors */
711 #define MCIC_SE_SE 0x0000800000000000ULL
712 #define MCIC_SE_SC 0x0000400000000000ULL
713 #define MCIC_SE_KE 0x0000200000000000ULL
714 #define MCIC_SE_DS 0x0000100000000000ULL
715 #define MCIC_SE_IE 0x0000000080000000ULL
716 
717 /* validity bits */
718 #define MCIC_VB_WP 0x0000080000000000ULL
719 #define MCIC_VB_MS 0x0000040000000000ULL
720 #define MCIC_VB_PM 0x0000020000000000ULL
721 #define MCIC_VB_IA 0x0000010000000000ULL
722 #define MCIC_VB_FA 0x0000008000000000ULL
723 #define MCIC_VB_VR 0x0000004000000000ULL
724 #define MCIC_VB_EC 0x0000002000000000ULL
725 #define MCIC_VB_FP 0x0000001000000000ULL
726 #define MCIC_VB_GR 0x0000000800000000ULL
727 #define MCIC_VB_CR 0x0000000400000000ULL
728 #define MCIC_VB_ST 0x0000000100000000ULL
729 #define MCIC_VB_AR 0x0000000040000000ULL
730 #define MCIC_VB_GS 0x0000000008000000ULL
731 #define MCIC_VB_PR 0x0000000000200000ULL
732 #define MCIC_VB_FC 0x0000000000100000ULL
733 #define MCIC_VB_CT 0x0000000000020000ULL
734 #define MCIC_VB_CC 0x0000000000010000ULL
735 
736 static inline uint64_t s390_build_validity_mcic(void)
737 {
738     uint64_t mcic;
739 
740     /*
741      * Indicate all validity bits (no damage) only. Other bits have to be
742      * added by the caller. (storage errors, subclasses and subclass modifiers)
743      */
744     mcic = MCIC_VB_WP | MCIC_VB_MS | MCIC_VB_PM | MCIC_VB_IA | MCIC_VB_FP |
745            MCIC_VB_GR | MCIC_VB_CR | MCIC_VB_ST | MCIC_VB_AR | MCIC_VB_PR |
746            MCIC_VB_FC | MCIC_VB_CT | MCIC_VB_CC;
747     if (s390_has_feat(S390_FEAT_VECTOR)) {
748         mcic |= MCIC_VB_VR;
749     }
750     if (s390_has_feat(S390_FEAT_GUARDED_STORAGE)) {
751         mcic |= MCIC_VB_GS;
752     }
753     return mcic;
754 }
755 
756 static inline void s390_do_cpu_full_reset(CPUState *cs, run_on_cpu_data arg)
757 {
758     cpu_reset(cs);
759 }
760 
761 static inline void s390_do_cpu_reset(CPUState *cs, run_on_cpu_data arg)
762 {
763     S390CPUClass *scc = S390_CPU_GET_CLASS(cs);
764 
765     scc->reset(cs, S390_CPU_RESET_NORMAL);
766 }
767 
768 static inline void s390_do_cpu_initial_reset(CPUState *cs, run_on_cpu_data arg)
769 {
770     S390CPUClass *scc = S390_CPU_GET_CLASS(cs);
771 
772     scc->reset(cs, S390_CPU_RESET_INITIAL);
773 }
774 
775 static inline void s390_do_cpu_load_normal(CPUState *cs, run_on_cpu_data arg)
776 {
777     S390CPUClass *scc = S390_CPU_GET_CLASS(cs);
778 
779     scc->load_normal(cs);
780 }
781 
782 
783 /* cpu.c */
784 void s390_crypto_reset(void);
785 int s390_set_memory_limit(uint64_t new_limit, uint64_t *hw_limit);
786 void s390_set_max_pagesize(uint64_t pagesize, Error **errp);
787 void s390_cmma_reset(void);
788 void s390_enable_css_support(S390CPU *cpu);
789 void s390_do_cpu_set_diag318(CPUState *cs, run_on_cpu_data arg);
790 int s390_assign_subch_ioeventfd(EventNotifier *notifier, uint32_t sch_id,
791                                 int vq, bool assign);
792 #ifndef CONFIG_USER_ONLY
793 unsigned int s390_cpu_set_state(uint8_t cpu_state, S390CPU *cpu);
794 #else
795 static inline unsigned int s390_cpu_set_state(uint8_t cpu_state, S390CPU *cpu)
796 {
797     return 0;
798 }
799 #endif /* CONFIG_USER_ONLY */
800 static inline uint8_t s390_cpu_get_state(S390CPU *cpu)
801 {
802     return cpu->env.cpu_state;
803 }
804 
805 
806 /* cpu_models.c */
807 void s390_cpu_list(void);
808 #define cpu_list s390_cpu_list
809 void s390_set_qemu_cpu_model(uint16_t type, uint8_t gen, uint8_t ec_ga,
810                              const S390FeatInit feat_init);
811 
812 
813 /* helper.c */
814 #define S390_CPU_TYPE_SUFFIX "-" TYPE_S390_CPU
815 #define S390_CPU_TYPE_NAME(name) (name S390_CPU_TYPE_SUFFIX)
816 #define CPU_RESOLVING_TYPE TYPE_S390_CPU
817 
818 /* interrupt.c */
819 #define RA_IGNORED                  0
820 void s390_program_interrupt(CPUS390XState *env, uint32_t code, uintptr_t ra);
821 /* service interrupts are floating therefore we must not pass an cpustate */
822 void s390_sclp_extint(uint32_t parm);
823 
824 /* mmu_helper.c */
825 int s390_cpu_virt_mem_rw(S390CPU *cpu, vaddr laddr, uint8_t ar, void *hostbuf,
826                          int len, bool is_write);
827 #define s390_cpu_virt_mem_read(cpu, laddr, ar, dest, len)    \
828         s390_cpu_virt_mem_rw(cpu, laddr, ar, dest, len, false)
829 #define s390_cpu_virt_mem_write(cpu, laddr, ar, dest, len)       \
830         s390_cpu_virt_mem_rw(cpu, laddr, ar, dest, len, true)
831 #define s390_cpu_virt_mem_check_read(cpu, laddr, ar, len)   \
832         s390_cpu_virt_mem_rw(cpu, laddr, ar, NULL, len, false)
833 #define s390_cpu_virt_mem_check_write(cpu, laddr, ar, len)   \
834         s390_cpu_virt_mem_rw(cpu, laddr, ar, NULL, len, true)
835 void s390_cpu_virt_mem_handle_exc(S390CPU *cpu, uintptr_t ra);
836 int s390_cpu_pv_mem_rw(S390CPU *cpu, unsigned int offset, void *hostbuf,
837                        int len, bool is_write);
838 #define s390_cpu_pv_mem_read(cpu, offset, dest, len)    \
839         s390_cpu_pv_mem_rw(cpu, offset, dest, len, false)
840 #define s390_cpu_pv_mem_write(cpu, offset, dest, len)       \
841         s390_cpu_pv_mem_rw(cpu, offset, dest, len, true)
842 
843 /* sigp.c */
844 int s390_cpu_restart(S390CPU *cpu);
845 void s390_init_sigp(void);
846 
847 /* helper.c */
848 void s390_cpu_set_psw(CPUS390XState *env, uint64_t mask, uint64_t addr);
849 uint64_t s390_cpu_get_psw_mask(CPUS390XState *env);
850 
851 /* outside of target/s390x/ */
852 S390CPU *s390_cpu_addr2state(uint16_t cpu_addr);
853 
854 #include "exec/cpu-all.h"
855 
856 #endif
857