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