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