xref: /qemu/target/s390x/cpu_models.c (revision 1029cd5b9827ba6aa7f5e02eed1928a928e2fa5e)
1 /*
2  * CPU models for s390x
3  *
4  * Copyright 2016 IBM Corp.
5  *
6  * Author(s): David Hildenbrand <dahi@linux.vnet.ibm.com>
7  *
8  * This work is licensed under the terms of the GNU GPL, version 2 or (at
9  * your option) any later version. See the COPYING file in the top-level
10  * directory.
11  */
12 
13 #include "qemu/osdep.h"
14 #include "cpu.h"
15 #include "s390x-internal.h"
16 #include "kvm/kvm_s390x.h"
17 #include "sysemu/kvm.h"
18 #include "sysemu/tcg.h"
19 #include "qapi/error.h"
20 #include "qemu/error-report.h"
21 #include "qapi/visitor.h"
22 #include "qemu/module.h"
23 #include "qemu/hw-version.h"
24 #include "qemu/qemu-print.h"
25 #ifndef CONFIG_USER_ONLY
26 #include "sysemu/sysemu.h"
27 #include "target/s390x/kvm/pv.h"
28 #include CONFIG_DEVICES
29 #endif
30 
31 #define CPUDEF_INIT(_type, _gen, _ec_ga, _mha_pow, _hmfai, _name, _desc) \
32     {                                                                    \
33         .name = _name,                                                   \
34         .type = _type,                                                   \
35         .gen = _gen,                                                     \
36         .ec_ga = _ec_ga,                                                 \
37         .mha_pow = _mha_pow,                                             \
38         .hmfai = _hmfai,                                                 \
39         .desc = _desc,                                                   \
40         .base_init = { S390_FEAT_LIST_GEN ## _gen ## _GA ## _ec_ga ## _BASE },  \
41         .default_init = { S390_FEAT_LIST_GEN ## _gen ## _GA ## _ec_ga ## _DEFAULT },  \
42         .full_init = { S390_FEAT_LIST_GEN ## _gen ## _GA ## _ec_ga ## _FULL },  \
43     }
44 
45 /*
46  * CPU definition list in order of release. Up to generation 14 base features
47  * of a following release have been a superset of the previous release. With
48  * generation 15 one base feature and one optional feature have been deprecated.
49  */
50 static S390CPUDef s390_cpu_defs[] = {
51     /*
52      * Linux requires at least z10 nowadays, and IBM only supports recent CPUs
53      * (see https://www.ibm.com/support/pages/ibm-mainframe-life-cycle-history),
54      * so we consider older CPUs as legacy that can optionally be disabled via
55      * the CONFIG_S390X_LEGACY_CPUS config switch.
56      */
57 #if defined(CONFIG_S390X_LEGACY_CPUS) || defined(CONFIG_USER_ONLY)
58     CPUDEF_INIT(0x2064, 7, 1, 38, 0x00000000U, "z900", "IBM zSeries 900 GA1"),
59     CPUDEF_INIT(0x2064, 7, 2, 38, 0x00000000U, "z900.2", "IBM zSeries 900 GA2"),
60     CPUDEF_INIT(0x2064, 7, 3, 38, 0x00000000U, "z900.3", "IBM zSeries 900 GA3"),
61     CPUDEF_INIT(0x2066, 7, 3, 38, 0x00000000U, "z800", "IBM zSeries 800 GA1"),
62     CPUDEF_INIT(0x2084, 8, 1, 38, 0x00000000U, "z990", "IBM zSeries 990 GA1"),
63     CPUDEF_INIT(0x2084, 8, 2, 38, 0x00000000U, "z990.2", "IBM zSeries 990 GA2"),
64     CPUDEF_INIT(0x2084, 8, 3, 38, 0x00000000U, "z990.3", "IBM zSeries 990 GA3"),
65     CPUDEF_INIT(0x2086, 8, 3, 38, 0x00000000U, "z890", "IBM zSeries 880 GA1"),
66     CPUDEF_INIT(0x2084, 8, 4, 38, 0x00000000U, "z990.4", "IBM zSeries 990 GA4"),
67     CPUDEF_INIT(0x2086, 8, 4, 38, 0x00000000U, "z890.2", "IBM zSeries 880 GA2"),
68     CPUDEF_INIT(0x2084, 8, 5, 38, 0x00000000U, "z990.5", "IBM zSeries 990 GA5"),
69     CPUDEF_INIT(0x2086, 8, 5, 38, 0x00000000U, "z890.3", "IBM zSeries 880 GA3"),
70     CPUDEF_INIT(0x2094, 9, 1, 40, 0x00000000U, "z9EC", "IBM System z9 EC GA1"),
71     CPUDEF_INIT(0x2094, 9, 2, 40, 0x00000000U, "z9EC.2", "IBM System z9 EC GA2"),
72     CPUDEF_INIT(0x2096, 9, 2, 40, 0x00000000U, "z9BC", "IBM System z9 BC GA1"),
73     CPUDEF_INIT(0x2094, 9, 3, 40, 0x00000000U, "z9EC.3", "IBM System z9 EC GA3"),
74     CPUDEF_INIT(0x2096, 9, 3, 40, 0x00000000U, "z9BC.2", "IBM System z9 BC GA2"),
75 #endif
76     CPUDEF_INIT(0x2097, 10, 1, 43, 0x00000000U, "z10EC", "IBM System z10 EC GA1"),
77     CPUDEF_INIT(0x2097, 10, 2, 43, 0x00000000U, "z10EC.2", "IBM System z10 EC GA2"),
78     CPUDEF_INIT(0x2098, 10, 2, 43, 0x00000000U, "z10BC", "IBM System z10 BC GA1"),
79     CPUDEF_INIT(0x2097, 10, 3, 43, 0x00000000U, "z10EC.3", "IBM System z10 EC GA3"),
80     CPUDEF_INIT(0x2098, 10, 3, 43, 0x00000000U, "z10BC.2", "IBM System z10 BC GA2"),
81     CPUDEF_INIT(0x2817, 11, 1, 44, 0x08000000U, "z196", "IBM zEnterprise 196 GA1"),
82     CPUDEF_INIT(0x2817, 11, 2, 44, 0x08000000U, "z196.2", "IBM zEnterprise 196 GA2"),
83     CPUDEF_INIT(0x2818, 11, 2, 44, 0x08000000U, "z114", "IBM zEnterprise 114 GA1"),
84     CPUDEF_INIT(0x2827, 12, 1, 44, 0x08000000U, "zEC12", "IBM zEnterprise EC12 GA1"),
85     CPUDEF_INIT(0x2827, 12, 2, 44, 0x08000000U, "zEC12.2", "IBM zEnterprise EC12 GA2"),
86     CPUDEF_INIT(0x2828, 12, 2, 44, 0x08000000U, "zBC12", "IBM zEnterprise BC12 GA1"),
87     CPUDEF_INIT(0x2964, 13, 1, 47, 0x08000000U, "z13", "IBM z13 GA1"),
88     CPUDEF_INIT(0x2964, 13, 2, 47, 0x08000000U, "z13.2", "IBM z13 GA2"),
89     CPUDEF_INIT(0x2965, 13, 2, 47, 0x08000000U, "z13s", "IBM z13s GA1"),
90     CPUDEF_INIT(0x3906, 14, 1, 47, 0x08000000U, "z14", "IBM z14 GA1"),
91     CPUDEF_INIT(0x3906, 14, 2, 47, 0x08000000U, "z14.2", "IBM z14 GA2"),
92     CPUDEF_INIT(0x3907, 14, 1, 47, 0x08000000U, "z14ZR1", "IBM z14 Model ZR1 GA1"),
93     CPUDEF_INIT(0x8561, 15, 1, 47, 0x08000000U, "gen15a", "IBM z15 T01 GA1"),
94     CPUDEF_INIT(0x8562, 15, 1, 47, 0x08000000U, "gen15b", "IBM z15 T02 GA1"),
95     CPUDEF_INIT(0x3931, 16, 1, 47, 0x08000000U, "gen16a", "IBM 3931 GA1"),
96     CPUDEF_INIT(0x3932, 16, 1, 47, 0x08000000U, "gen16b", "IBM 3932 GA1"),
97 };
98 
99 #define QEMU_MAX_CPU_TYPE 0x8561
100 #define QEMU_MAX_CPU_GEN 15
101 #define QEMU_MAX_CPU_EC_GA 1
102 static S390FeatBitmap qemu_max_cpu_feat;
103 
104 /* features part of a base model but not relevant for finding a base model */
105 S390FeatBitmap ignored_base_feat;
106 
107 void s390_cpudef_featoff(uint8_t gen, uint8_t ec_ga, S390Feat feat)
108 {
109     const S390CPUDef *def;
110 
111     def = s390_find_cpu_def(0, gen, ec_ga, NULL);
112     clear_bit(feat, (unsigned long *)&def->default_feat);
113 }
114 
115 void s390_cpudef_featoff_greater(uint8_t gen, uint8_t ec_ga, S390Feat feat)
116 {
117     int i;
118 
119     for (i = 0; i < ARRAY_SIZE(s390_cpu_defs); i++) {
120         const S390CPUDef *def = &s390_cpu_defs[i];
121 
122         if (def->gen < gen) {
123             continue;
124         }
125         if (def->gen == gen && def->ec_ga < ec_ga) {
126             continue;
127         }
128 
129         clear_bit(feat, (unsigned long *)&def->default_feat);
130     }
131 }
132 
133 void s390_cpudef_group_featoff_greater(uint8_t gen, uint8_t ec_ga,
134                                        S390FeatGroup group)
135 {
136     const S390FeatGroupDef *group_def = s390_feat_group_def(group);
137     S390FeatBitmap group_def_off;
138     int i;
139 
140     bitmap_complement(group_def_off, group_def->feat, S390_FEAT_MAX);
141 
142     for (i = 0; i < ARRAY_SIZE(s390_cpu_defs); i++) {
143         const S390CPUDef *cpu_def = &s390_cpu_defs[i];
144 
145         if (cpu_def->gen < gen) {
146             continue;
147         }
148         if (cpu_def->gen == gen && cpu_def->ec_ga < ec_ga) {
149             continue;
150         }
151 
152         bitmap_and((unsigned long *)&cpu_def->default_feat,
153                    cpu_def->default_feat, group_def_off, S390_FEAT_MAX);
154     }
155 }
156 
157 uint32_t s390_get_hmfai(void)
158 {
159     static S390CPU *cpu;
160 
161     if (!cpu) {
162         cpu = S390_CPU(qemu_get_cpu(0));
163     }
164 
165     if (!cpu || !cpu->model) {
166         return 0;
167     }
168     return cpu->model->def->hmfai;
169 }
170 
171 uint8_t s390_get_mha_pow(void)
172 {
173     static S390CPU *cpu;
174 
175     if (!cpu) {
176         cpu = S390_CPU(qemu_get_cpu(0));
177     }
178 
179     if (!cpu || !cpu->model) {
180         return 0;
181     }
182     return cpu->model->def->mha_pow;
183 }
184 
185 uint32_t s390_get_ibc_val(void)
186 {
187     uint16_t unblocked_ibc, lowest_ibc;
188     static S390CPU *cpu;
189 
190     if (!cpu) {
191         cpu = S390_CPU(qemu_get_cpu(0));
192     }
193 
194     if (!cpu || !cpu->model) {
195         return 0;
196     }
197     unblocked_ibc = s390_ibc_from_cpu_model(cpu->model);
198     lowest_ibc = cpu->model->lowest_ibc;
199     /* the lowest_ibc always has to be <= unblocked_ibc */
200     if (!lowest_ibc || lowest_ibc > unblocked_ibc) {
201         return 0;
202     }
203     return ((uint32_t) lowest_ibc << 16) | unblocked_ibc;
204 }
205 
206 void s390_get_feat_block(S390FeatType type, uint8_t *data)
207 {
208     S390CPU *cpu = S390_CPU(first_cpu);
209 
210     if (!cpu || !cpu->model) {
211         return;
212     }
213     s390_fill_feat_block(cpu->model->features, type, data);
214 }
215 
216 bool s390_has_feat(S390Feat feat)
217 {
218     static S390CPU *cpu;
219 
220     if (!cpu) {
221         cpu = S390_CPU(qemu_get_cpu(0));
222     }
223 
224     if (!cpu || !cpu->model) {
225 #ifdef CONFIG_KVM
226         if (kvm_enabled()) {
227             if (feat == S390_FEAT_VECTOR) {
228                 return kvm_check_extension(kvm_state,
229                                            KVM_CAP_S390_VECTOR_REGISTERS);
230             }
231             if (feat == S390_FEAT_RUNTIME_INSTRUMENTATION) {
232                 return kvm_s390_get_ri();
233             }
234             if (feat == S390_FEAT_MSA_EXT_3) {
235                 return true;
236             }
237         }
238 #endif
239         if (feat == S390_FEAT_ZPCI) {
240             return true;
241         }
242         return 0;
243     }
244 
245 #ifndef CONFIG_USER_ONLY
246     if (s390_is_pv()) {
247         switch (feat) {
248         case S390_FEAT_DIAG_318:
249         case S390_FEAT_HPMA2:
250         case S390_FEAT_SIE_F2:
251         case S390_FEAT_SIE_SKEY:
252         case S390_FEAT_SIE_GPERE:
253         case S390_FEAT_SIE_SIIF:
254         case S390_FEAT_SIE_SIGPIF:
255         case S390_FEAT_SIE_IB:
256         case S390_FEAT_SIE_CEI:
257         case S390_FEAT_SIE_KSS:
258         case S390_FEAT_SIE_GSLS:
259         case S390_FEAT_SIE_64BSCAO:
260         case S390_FEAT_SIE_CMMA:
261         case S390_FEAT_SIE_PFMFI:
262         case S390_FEAT_SIE_IBS:
263         case S390_FEAT_CONFIGURATION_TOPOLOGY:
264             return false;
265             break;
266         default:
267             break;
268         }
269     }
270 #endif
271     return test_bit(feat, cpu->model->features);
272 }
273 
274 uint8_t s390_get_gen_for_cpu_type(uint16_t type)
275 {
276     int i;
277 
278     for (i = 0; i < ARRAY_SIZE(s390_cpu_defs); i++) {
279         if (s390_cpu_defs[i].type == type) {
280             return s390_cpu_defs[i].gen;
281         }
282     }
283     return 0;
284 }
285 
286 const S390CPUDef *s390_find_cpu_def(uint16_t type, uint8_t gen, uint8_t ec_ga,
287                                     S390FeatBitmap features)
288 {
289     const S390CPUDef *last_compatible = NULL;
290     const S390CPUDef *matching_cpu_type = NULL;
291     int i;
292 
293     if (!gen) {
294         ec_ga = 0;
295     }
296     if (!gen && type) {
297         gen = s390_get_gen_for_cpu_type(type);
298     }
299 
300     for (i = 0; i < ARRAY_SIZE(s390_cpu_defs); i++) {
301         const S390CPUDef *def = &s390_cpu_defs[i];
302         S390FeatBitmap missing;
303 
304         /* don't even try newer generations if we know the generation */
305         if (gen) {
306             if (def->gen > gen) {
307                 break;
308             } else if (def->gen == gen && ec_ga && def->ec_ga > ec_ga) {
309                 break;
310             }
311         }
312 
313         if (features) {
314             /* see if the model satisfies the minimum features */
315             bitmap_andnot(missing, def->base_feat, features, S390_FEAT_MAX);
316             /*
317              * Ignore certain features that are in the base model, but not
318              * relevant for the search (esp. MSA subfunctions).
319              */
320             bitmap_andnot(missing, missing, ignored_base_feat, S390_FEAT_MAX);
321             if (!bitmap_empty(missing, S390_FEAT_MAX)) {
322                 break;
323             }
324         }
325 
326         /* stop the search if we found the exact model */
327         if (def->type == type && def->ec_ga == ec_ga) {
328             return def;
329         }
330         /* remember if we've at least seen one with the same cpu type */
331         if (def->type == type) {
332             matching_cpu_type = def;
333         }
334         last_compatible = def;
335     }
336     /* prefer the model with the same cpu type, esp. don't take the BC for EC */
337     if (matching_cpu_type) {
338         return matching_cpu_type;
339     }
340     return last_compatible;
341 }
342 
343 static void s390_print_cpu_model_list_entry(gpointer data, gpointer user_data)
344 {
345     const S390CPUClass *scc = S390_CPU_CLASS((ObjectClass *)data);
346     CPUClass *cc = CPU_CLASS(scc);
347     char *name = g_strdup(object_class_get_name((ObjectClass *)data));
348     g_autoptr(GString) details = g_string_new("");
349 
350     if (scc->is_static) {
351         g_string_append(details, "static, ");
352     }
353     if (scc->is_migration_safe) {
354         g_string_append(details, "migration-safe, ");
355     }
356     if (cc->deprecation_note) {
357         g_string_append(details, "deprecated, ");
358     }
359     if (details->len) {
360         /* cull trailing ', ' */
361         g_string_truncate(details, details->len - 2);
362     }
363 
364     /* strip off the -s390x-cpu */
365     g_strrstr(name, "-" TYPE_S390_CPU)[0] = 0;
366     if (details->len) {
367         qemu_printf("  %-15s %-35s (%s)\n", name, scc->desc, details->str);
368     } else {
369         qemu_printf("  %-15s %-35s\n", name, scc->desc);
370     }
371     g_free(name);
372 }
373 
374 static gint s390_cpu_list_compare(gconstpointer a, gconstpointer b)
375 {
376     const S390CPUClass *cc_a = S390_CPU_CLASS((ObjectClass *)a);
377     const S390CPUClass *cc_b = S390_CPU_CLASS((ObjectClass *)b);
378     const char *name_a = object_class_get_name((ObjectClass *)a);
379     const char *name_b = object_class_get_name((ObjectClass *)b);
380 
381     /*
382      * Move qemu, host and max to the top of the list, qemu first, host second,
383      * max third.
384      */
385     if (name_a[0] == 'q') {
386         return -1;
387     } else if (name_b[0] == 'q') {
388         return 1;
389     } else if (name_a[0] == 'h') {
390         return -1;
391     } else if (name_b[0] == 'h') {
392         return 1;
393     } else if (name_a[0] == 'm') {
394         return -1;
395     } else if (name_b[0] == 'm') {
396         return 1;
397     }
398 
399     /* keep the same order we have in our table (sorted by release date) */
400     if (cc_a->cpu_def != cc_b->cpu_def) {
401         return cc_a->cpu_def - cc_b->cpu_def;
402     }
403 
404     /* exact same definition - list base model first */
405     return cc_a->is_static ? -1 : 1;
406 }
407 
408 void s390_cpu_list(void)
409 {
410     S390FeatGroup group;
411     S390Feat feat;
412     GSList *list;
413 
414     qemu_printf("Available CPUs:\n");
415     list = object_class_get_list(TYPE_S390_CPU, false);
416     list = g_slist_sort(list, s390_cpu_list_compare);
417     g_slist_foreach(list, s390_print_cpu_model_list_entry, NULL);
418     g_slist_free(list);
419 
420     qemu_printf("\nRecognized feature flags:\n");
421     for (feat = 0; feat < S390_FEAT_MAX; feat++) {
422         const S390FeatDef *def = s390_feat_def(feat);
423 
424         qemu_printf("  %-20s %s\n", def->name, def->desc);
425     }
426 
427     qemu_printf("\nRecognized feature groups:\n");
428     for (group = 0; group < S390_FEAT_GROUP_MAX; group++) {
429         const S390FeatGroupDef *def = s390_feat_group_def(group);
430 
431         qemu_printf("  %-20s %s\n", def->name, def->desc);
432     }
433 }
434 
435 static void check_consistency(const S390CPUModel *model)
436 {
437     static int dep[][2] = {
438         { S390_FEAT_IPTE_RANGE, S390_FEAT_DAT_ENH },
439         { S390_FEAT_IDTE_SEGMENT, S390_FEAT_DAT_ENH },
440         { S390_FEAT_IDTE_REGION, S390_FEAT_DAT_ENH },
441         { S390_FEAT_IDTE_REGION, S390_FEAT_IDTE_SEGMENT },
442         { S390_FEAT_LOCAL_TLB_CLEARING, S390_FEAT_DAT_ENH},
443         { S390_FEAT_LONG_DISPLACEMENT_FAST, S390_FEAT_LONG_DISPLACEMENT },
444         { S390_FEAT_DFP_FAST, S390_FEAT_DFP },
445         { S390_FEAT_TRANSACTIONAL_EXE, S390_FEAT_STFLE_49 },
446         { S390_FEAT_EDAT_2, S390_FEAT_EDAT},
447         { S390_FEAT_MSA_EXT_5, S390_FEAT_KIMD_SHA_512 },
448         { S390_FEAT_MSA_EXT_5, S390_FEAT_KLMD_SHA_512 },
449         { S390_FEAT_MSA_EXT_4, S390_FEAT_MSA_EXT_3 },
450         { S390_FEAT_SIE_CMMA, S390_FEAT_CMM },
451         { S390_FEAT_SIE_CMMA, S390_FEAT_SIE_GSLS },
452         { S390_FEAT_SIE_PFMFI, S390_FEAT_EDAT },
453         { S390_FEAT_MSA_EXT_8, S390_FEAT_MSA_EXT_3 },
454         { S390_FEAT_MSA_EXT_9, S390_FEAT_MSA_EXT_3 },
455         { S390_FEAT_MSA_EXT_9, S390_FEAT_MSA_EXT_4 },
456         { S390_FEAT_MULTIPLE_EPOCH, S390_FEAT_TOD_CLOCK_STEERING },
457         { S390_FEAT_VECTOR_PACKED_DECIMAL, S390_FEAT_VECTOR },
458         { S390_FEAT_VECTOR_PACKED_DECIMAL_ENH, S390_FEAT_VECTOR_PACKED_DECIMAL },
459         { S390_FEAT_VECTOR_PACKED_DECIMAL_ENH2, S390_FEAT_VECTOR_PACKED_DECIMAL_ENH },
460         { S390_FEAT_VECTOR_ENH, S390_FEAT_VECTOR },
461         { S390_FEAT_INSTRUCTION_EXEC_PROT, S390_FEAT_SIDE_EFFECT_ACCESS_ESOP2 },
462         { S390_FEAT_SIDE_EFFECT_ACCESS_ESOP2, S390_FEAT_ESOP },
463         { S390_FEAT_CMM_NT, S390_FEAT_CMM },
464         { S390_FEAT_GUARDED_STORAGE, S390_FEAT_SIDE_EFFECT_ACCESS_ESOP2 },
465         { S390_FEAT_MULTIPLE_EPOCH, S390_FEAT_STORE_CLOCK_FAST },
466         { S390_FEAT_MULTIPLE_EPOCH, S390_FEAT_TOD_CLOCK_STEERING },
467         { S390_FEAT_SEMAPHORE_ASSIST, S390_FEAT_STFLE_49 },
468         { S390_FEAT_KIMD_SHA3_224, S390_FEAT_MSA },
469         { S390_FEAT_KIMD_SHA3_256, S390_FEAT_MSA },
470         { S390_FEAT_KIMD_SHA3_384, S390_FEAT_MSA },
471         { S390_FEAT_KIMD_SHA3_512, S390_FEAT_MSA },
472         { S390_FEAT_KIMD_SHAKE_128, S390_FEAT_MSA },
473         { S390_FEAT_KIMD_SHAKE_256, S390_FEAT_MSA },
474         { S390_FEAT_KLMD_SHA3_224, S390_FEAT_MSA },
475         { S390_FEAT_KLMD_SHA3_256, S390_FEAT_MSA },
476         { S390_FEAT_KLMD_SHA3_384, S390_FEAT_MSA },
477         { S390_FEAT_KLMD_SHA3_512, S390_FEAT_MSA },
478         { S390_FEAT_KLMD_SHAKE_128, S390_FEAT_MSA },
479         { S390_FEAT_KLMD_SHAKE_256, S390_FEAT_MSA },
480         { S390_FEAT_KM_FULL_XTS_AES_128, S390_FEAT_MSA_EXT_4 },
481         { S390_FEAT_KM_FULL_XTS_AES_256, S390_FEAT_MSA_EXT_4 },
482         { S390_FEAT_KM_FULL_XTS_EAES_128, S390_FEAT_MSA_EXT_4 },
483         { S390_FEAT_KM_FULL_XTS_EAES_256, S390_FEAT_MSA_EXT_4 },
484         { S390_FEAT_PRNO_TRNG_QRTCR, S390_FEAT_MSA_EXT_5 },
485         { S390_FEAT_PRNO_TRNG, S390_FEAT_MSA_EXT_5 },
486         { S390_FEAT_SIE_KSS, S390_FEAT_SIE_F2 },
487         { S390_FEAT_AP_QUERY_CONFIG_INFO, S390_FEAT_AP },
488         { S390_FEAT_AP_FACILITIES_TEST, S390_FEAT_AP },
489         { S390_FEAT_PTFF_QSIE, S390_FEAT_MULTIPLE_EPOCH },
490         { S390_FEAT_PTFF_QTOUE, S390_FEAT_MULTIPLE_EPOCH },
491         { S390_FEAT_PTFF_STOE, S390_FEAT_MULTIPLE_EPOCH },
492         { S390_FEAT_PTFF_STOUE, S390_FEAT_MULTIPLE_EPOCH },
493         { S390_FEAT_AP_QUEUE_INTERRUPT_CONTROL, S390_FEAT_AP },
494         { S390_FEAT_DIAG_318, S390_FEAT_EXTENDED_LENGTH_SCCB },
495         { S390_FEAT_NNPA, S390_FEAT_VECTOR },
496         { S390_FEAT_RDP, S390_FEAT_LOCAL_TLB_CLEARING },
497         { S390_FEAT_UV_FEAT_AP, S390_FEAT_AP },
498         { S390_FEAT_UV_FEAT_AP_INTR, S390_FEAT_UV_FEAT_AP },
499     };
500     int i;
501 
502     for (i = 0; i < ARRAY_SIZE(dep); i++) {
503         if (test_bit(dep[i][0], model->features) &&
504             !test_bit(dep[i][1], model->features)) {
505             warn_report("\'%s\' requires \'%s\'.",
506                         s390_feat_def(dep[i][0])->name,
507                         s390_feat_def(dep[i][1])->name);
508         }
509     }
510 }
511 
512 static void error_prepend_missing_feat(const char *name, void *opaque)
513 {
514     error_prepend((Error **) opaque, "%s ", name);
515 }
516 
517 static void check_compat_model_failed(Error **errp,
518                                       const S390CPUModel *max_model,
519                                       const char *msg)
520 {
521     error_setg(errp, "%s. Maximum supported model in the current configuration: \'%s\'",
522                msg, max_model->def->name);
523     error_append_hint(errp, "Consider a different accelerator, try \"-accel help\"\n");
524     return;
525 }
526 
527 static bool check_compatibility(const S390CPUModel *max_model,
528                                 const S390CPUModel *model, Error **errp)
529 {
530     ERRP_GUARD();
531     S390FeatBitmap missing;
532 
533     if (model->def->gen > max_model->def->gen) {
534         check_compat_model_failed(errp, max_model, "Selected CPU generation is too new");
535         return false;
536     } else if (model->def->gen == max_model->def->gen &&
537                model->def->ec_ga > max_model->def->ec_ga) {
538         check_compat_model_failed(errp, max_model, "Selected CPU GA level is too new");
539         return false;
540     }
541 
542 #ifndef CONFIG_USER_ONLY
543     if (only_migratable && test_bit(S390_FEAT_UNPACK, model->features)) {
544         error_setg(errp, "The unpack facility is not compatible with "
545                    "the --only-migratable option. You must remove either "
546                    "the 'unpack' facility or the --only-migratable option");
547         return false;
548     }
549 #endif
550 
551     /* detect the missing features to properly report them */
552     bitmap_andnot(missing, model->features, max_model->features, S390_FEAT_MAX);
553     if (bitmap_empty(missing, S390_FEAT_MAX)) {
554         return true;
555     }
556 
557     error_setg(errp, " ");
558     s390_feat_bitmap_to_ascii(missing, errp, error_prepend_missing_feat);
559     error_prepend(errp, "Some features requested in the CPU model are not "
560                   "available in the current configuration: ");
561     error_append_hint(errp,
562                       "Consider a different accelerator, QEMU, or kernel version\n");
563     return false;
564 }
565 
566 S390CPUModel *get_max_cpu_model(Error **errp)
567 {
568     static S390CPUModel max_model;
569     static bool cached;
570 
571     if (cached) {
572         return &max_model;
573     }
574 
575     if (kvm_enabled()) {
576         if (!kvm_s390_get_host_cpu_model(&max_model, errp)) {
577             return NULL;
578         }
579     } else {
580         max_model.def = s390_find_cpu_def(QEMU_MAX_CPU_TYPE, QEMU_MAX_CPU_GEN,
581                                           QEMU_MAX_CPU_EC_GA, NULL);
582         bitmap_copy(max_model.features, qemu_max_cpu_feat, S390_FEAT_MAX);
583     }
584     cached = true;
585     return &max_model;
586 }
587 
588 void s390_realize_cpu_model(CPUState *cs, Error **errp)
589 {
590     ERRP_GUARD();
591     S390CPUClass *xcc = S390_CPU_GET_CLASS(cs);
592     S390CPU *cpu = S390_CPU(cs);
593     const S390CPUModel *max_model;
594 
595     if (xcc->kvm_required && !kvm_enabled()) {
596         error_setg(errp, "CPU definition requires KVM");
597         return;
598     }
599 
600     if (!cpu->model) {
601         /* no host model support -> perform compatibility stuff */
602         apply_cpu_model(NULL, errp);
603         return;
604     }
605 
606     max_model = get_max_cpu_model(errp);
607     if (!max_model) {
608         error_prepend(errp, "CPU models are not available: ");
609         return;
610     }
611 
612     /* copy over properties that can vary */
613     cpu->model->lowest_ibc = max_model->lowest_ibc;
614     cpu->model->cpu_id = max_model->cpu_id;
615     cpu->model->cpu_id_format = max_model->cpu_id_format;
616     cpu->model->cpu_ver = max_model->cpu_ver;
617 
618     check_consistency(cpu->model);
619     if (!check_compatibility(max_model, cpu->model, errp)) {
620         return;
621     }
622 
623     apply_cpu_model(cpu->model, errp);
624 
625 #if !defined(CONFIG_USER_ONLY)
626     cpu->env.cpuid = s390_cpuid_from_cpu_model(cpu->model);
627     if (tcg_enabled()) {
628         cpu->env.cpuid = deposit64(cpu->env.cpuid, CPU_PHYS_ADDR_SHIFT,
629                                    CPU_PHYS_ADDR_BITS, cpu->env.core_id);
630     }
631 #endif
632 }
633 
634 static void get_feature(Object *obj, Visitor *v, const char *name,
635                         void *opaque, Error **errp)
636 {
637     S390Feat feat = (S390Feat) (uintptr_t) opaque;
638     S390CPU *cpu = S390_CPU(obj);
639     bool value;
640 
641     if (!cpu->model) {
642         error_setg(errp, "Details about the host CPU model are not available, "
643                          "features cannot be queried.");
644         return;
645     }
646 
647     value = test_bit(feat, cpu->model->features);
648     visit_type_bool(v, name, &value, errp);
649 }
650 
651 static void set_feature(Object *obj, Visitor *v, const char *name,
652                         void *opaque, Error **errp)
653 {
654     S390Feat feat = (S390Feat) (uintptr_t) opaque;
655     DeviceState *dev = DEVICE(obj);
656     S390CPU *cpu = S390_CPU(obj);
657     bool value;
658 
659     if (dev->realized) {
660         error_setg(errp, "Attempt to set property '%s' on '%s' after "
661                    "it was realized", name, object_get_typename(obj));
662         return;
663     } else if (!cpu->model) {
664         error_setg(errp, "Details about the host CPU model are not available, "
665                          "features cannot be changed.");
666         return;
667     }
668 
669     if (!visit_type_bool(v, name, &value, errp)) {
670         return;
671     }
672     if (value) {
673         if (!test_bit(feat, cpu->model->def->full_feat)) {
674             error_setg(errp, "Feature '%s' is not available for CPU model '%s',"
675                        " it was introduced with later models.",
676                        name, cpu->model->def->name);
677             return;
678         }
679         set_bit(feat, cpu->model->features);
680     } else {
681         clear_bit(feat, cpu->model->features);
682     }
683 }
684 
685 static void get_feature_group(Object *obj, Visitor *v, const char *name,
686                               void *opaque, Error **errp)
687 {
688     S390FeatGroup group = (S390FeatGroup) (uintptr_t) opaque;
689     const S390FeatGroupDef *def = s390_feat_group_def(group);
690     S390CPU *cpu = S390_CPU(obj);
691     S390FeatBitmap tmp;
692     bool value;
693 
694     if (!cpu->model) {
695         error_setg(errp, "Details about the host CPU model are not available, "
696                          "features cannot be queried.");
697         return;
698     }
699 
700     /* a group is enabled if all features are enabled */
701     bitmap_and(tmp, cpu->model->features, def->feat, S390_FEAT_MAX);
702     value = bitmap_equal(tmp, def->feat, S390_FEAT_MAX);
703     visit_type_bool(v, name, &value, errp);
704 }
705 
706 static void set_feature_group(Object *obj, Visitor *v, const char *name,
707                               void *opaque, Error **errp)
708 {
709     S390FeatGroup group = (S390FeatGroup) (uintptr_t) opaque;
710     const S390FeatGroupDef *def = s390_feat_group_def(group);
711     DeviceState *dev = DEVICE(obj);
712     S390CPU *cpu = S390_CPU(obj);
713     bool value;
714 
715     if (dev->realized) {
716         error_setg(errp, "Attempt to set property '%s' on '%s' after "
717                    "it was realized", name, object_get_typename(obj));
718         return;
719     } else if (!cpu->model) {
720         error_setg(errp, "Details about the host CPU model are not available, "
721                          "features cannot be changed.");
722         return;
723     }
724 
725     if (!visit_type_bool(v, name, &value, errp)) {
726         return;
727     }
728     if (value) {
729         /* groups are added in one shot, so an intersect is sufficient */
730         if (!bitmap_intersects(def->feat, cpu->model->def->full_feat,
731                                S390_FEAT_MAX)) {
732             error_setg(errp, "Group '%s' is not available for CPU model '%s',"
733                        " it was introduced with later models.",
734                        name, cpu->model->def->name);
735             return;
736         }
737         bitmap_or(cpu->model->features, cpu->model->features, def->feat,
738                   S390_FEAT_MAX);
739     } else {
740         bitmap_andnot(cpu->model->features, cpu->model->features, def->feat,
741                       S390_FEAT_MAX);
742     }
743 }
744 
745 static void s390_cpu_model_initfn(Object *obj)
746 {
747     S390CPU *cpu = S390_CPU(obj);
748     S390CPUClass *xcc = S390_CPU_GET_CLASS(cpu);
749 
750     cpu->model = g_malloc0(sizeof(*cpu->model));
751     /* copy the model, so we can modify it */
752     cpu->model->def = xcc->cpu_def;
753     if (xcc->is_static) {
754         /* base model - features will never change */
755         bitmap_copy(cpu->model->features, cpu->model->def->base_feat,
756                     S390_FEAT_MAX);
757     } else {
758         /* latest model - features can change */
759         bitmap_copy(cpu->model->features,
760                     cpu->model->def->default_feat, S390_FEAT_MAX);
761     }
762 }
763 
764 static S390CPUModel s390_qemu_cpu_model;
765 
766 /* Set the qemu CPU model (on machine initialization). Must not be called
767  * once CPUs have been created.
768  */
769 void s390_set_qemu_cpu_model(uint16_t type, uint8_t gen, uint8_t ec_ga,
770                              const S390FeatInit feat_init)
771 {
772     const S390CPUDef *def = s390_find_cpu_def(type, gen, ec_ga, NULL);
773 
774     g_assert(def);
775     g_assert(QTAILQ_EMPTY_RCU(&cpus_queue));
776 
777     /* build the CPU model */
778     s390_qemu_cpu_model.def = def;
779     bitmap_zero(s390_qemu_cpu_model.features, S390_FEAT_MAX);
780     s390_init_feat_bitmap(feat_init, s390_qemu_cpu_model.features);
781 }
782 
783 static void s390_qemu_cpu_model_initfn(Object *obj)
784 {
785     S390CPU *cpu = S390_CPU(obj);
786 
787     cpu->model = g_malloc0(sizeof(*cpu->model));
788     /* copy the CPU model so we can modify it */
789     memcpy(cpu->model, &s390_qemu_cpu_model, sizeof(*cpu->model));
790 }
791 
792 static void s390_max_cpu_model_initfn(Object *obj)
793 {
794     const S390CPUModel *max_model;
795     S390CPU *cpu = S390_CPU(obj);
796     Error *local_err = NULL;
797 
798     if (kvm_enabled() && !kvm_s390_cpu_models_supported()) {
799         /* "max" and "host" always work, even without CPU model support */
800         return;
801     }
802 
803     max_model = get_max_cpu_model(&local_err);
804     if (local_err) {
805         /* we expect errors only under KVM, when actually querying the kernel */
806         g_assert(kvm_enabled());
807         error_report_err(local_err);
808         /* fallback to unsupported CPU models */
809         return;
810     }
811 
812     cpu->model = g_new(S390CPUModel, 1);
813     /* copy the CPU model so we can modify it */
814     memcpy(cpu->model, max_model, sizeof(*cpu->model));
815 }
816 
817 static void s390_cpu_model_finalize(Object *obj)
818 {
819     S390CPU *cpu = S390_CPU(obj);
820 
821     g_free(cpu->model);
822     cpu->model = NULL;
823 }
824 
825 static bool get_is_migration_safe(Object *obj, Error **errp)
826 {
827     return S390_CPU_GET_CLASS(obj)->is_migration_safe;
828 }
829 
830 static bool get_is_static(Object *obj, Error **errp)
831 {
832     return S390_CPU_GET_CLASS(obj)->is_static;
833 }
834 
835 static char *get_description(Object *obj, Error **errp)
836 {
837     return g_strdup(S390_CPU_GET_CLASS(obj)->desc);
838 }
839 
840 void s390_cpu_model_class_register_props(ObjectClass *oc)
841 {
842     S390FeatGroup group;
843     S390Feat feat;
844 
845     object_class_property_add_bool(oc, "migration-safe", get_is_migration_safe,
846                                    NULL);
847     object_class_property_add_bool(oc, "static", get_is_static,
848                                    NULL);
849     object_class_property_add_str(oc, "description", get_description, NULL);
850 
851     for (feat = 0; feat < S390_FEAT_MAX; feat++) {
852         const S390FeatDef *def = s390_feat_def(feat);
853         object_class_property_add(oc, def->name, "bool", get_feature,
854                                   set_feature, NULL, (void *) feat);
855         object_class_property_set_description(oc, def->name, def->desc);
856     }
857     for (group = 0; group < S390_FEAT_GROUP_MAX; group++) {
858         const S390FeatGroupDef *def = s390_feat_group_def(group);
859         object_class_property_add(oc, def->name, "bool", get_feature_group,
860                                   set_feature_group, NULL, (void *) group);
861         object_class_property_set_description(oc, def->name, def->desc);
862     }
863 }
864 
865 #ifdef CONFIG_KVM
866 static void s390_host_cpu_model_class_init(ObjectClass *oc, void *data)
867 {
868     S390CPUClass *xcc = S390_CPU_CLASS(oc);
869 
870     xcc->kvm_required = true;
871     xcc->desc = "KVM only: All recognized features";
872 }
873 #endif
874 
875 static void s390_base_cpu_model_class_init(ObjectClass *oc, void *data)
876 {
877     S390CPUClass *xcc = S390_CPU_CLASS(oc);
878 
879     /* all base models are migration safe */
880     xcc->cpu_def = (const S390CPUDef *) data;
881     xcc->is_migration_safe = true;
882     xcc->is_static = true;
883     xcc->desc = xcc->cpu_def->desc;
884 }
885 
886 static void s390_cpu_model_class_init(ObjectClass *oc, void *data)
887 {
888     S390CPUClass *xcc = S390_CPU_CLASS(oc);
889 
890     /* model that can change between QEMU versions */
891     xcc->cpu_def = (const S390CPUDef *) data;
892     xcc->is_migration_safe = true;
893     xcc->desc = xcc->cpu_def->desc;
894 }
895 
896 static void s390_qemu_cpu_model_class_init(ObjectClass *oc, void *data)
897 {
898     S390CPUClass *xcc = S390_CPU_CLASS(oc);
899 
900     xcc->is_migration_safe = true;
901     xcc->desc = g_strdup_printf("QEMU Virtual CPU version %s",
902                                 qemu_hw_version());
903 }
904 
905 static void s390_max_cpu_model_class_init(ObjectClass *oc, void *data)
906 {
907     S390CPUClass *xcc = S390_CPU_CLASS(oc);
908 
909     /*
910      * The "max" model is neither static nor migration safe. Under KVM
911      * it represents the "host" model. Under TCG it represents the "qemu" CPU
912      * model of the latest QEMU machine.
913      */
914     xcc->desc =
915         "Enables all features supported by the accelerator in the current host";
916 }
917 
918 /* Generate type name for a cpu model. Caller has to free the string. */
919 static char *s390_cpu_type_name(const char *model_name)
920 {
921     return g_strdup_printf(S390_CPU_TYPE_NAME("%s"), model_name);
922 }
923 
924 /* Generate type name for a base cpu model. Caller has to free the string. */
925 static char *s390_base_cpu_type_name(const char *model_name)
926 {
927     return g_strdup_printf(S390_CPU_TYPE_NAME("%s-base"), model_name);
928 }
929 
930 ObjectClass *s390_cpu_class_by_name(const char *name)
931 {
932     char *typename = s390_cpu_type_name(name);
933     ObjectClass *oc;
934 
935     oc = object_class_by_name(typename);
936     g_free(typename);
937     return oc;
938 }
939 
940 static const TypeInfo qemu_s390_cpu_type_info = {
941     .name = S390_CPU_TYPE_NAME("qemu"),
942     .parent = TYPE_S390_CPU,
943     .instance_init = s390_qemu_cpu_model_initfn,
944     .instance_finalize = s390_cpu_model_finalize,
945     .class_init = s390_qemu_cpu_model_class_init,
946 };
947 
948 static const TypeInfo max_s390_cpu_type_info = {
949     .name = S390_CPU_TYPE_NAME("max"),
950     .parent = TYPE_S390_CPU,
951     .instance_init = s390_max_cpu_model_initfn,
952     .instance_finalize = s390_cpu_model_finalize,
953     .class_init = s390_max_cpu_model_class_init,
954 };
955 
956 #ifdef CONFIG_KVM
957 static const TypeInfo host_s390_cpu_type_info = {
958     .name = S390_CPU_TYPE_NAME("host"),
959     .parent = S390_CPU_TYPE_NAME("max"),
960     .class_init = s390_host_cpu_model_class_init,
961 };
962 #endif
963 
964 static void init_ignored_base_feat(void)
965 {
966     static const int feats[] = {
967          /* MSA subfunctions that could not be available on certain machines */
968          S390_FEAT_KMAC_DEA,
969          S390_FEAT_KMAC_TDEA_128,
970          S390_FEAT_KMAC_TDEA_192,
971          S390_FEAT_KMC_DEA,
972          S390_FEAT_KMC_TDEA_128,
973          S390_FEAT_KMC_TDEA_192,
974          S390_FEAT_KM_DEA,
975          S390_FEAT_KM_TDEA_128,
976          S390_FEAT_KM_TDEA_192,
977          S390_FEAT_KIMD_SHA_1,
978          S390_FEAT_KLMD_SHA_1,
979          /* CSSKE is deprecated on newer generations */
980          S390_FEAT_CONDITIONAL_SSKE,
981     };
982     int i;
983 
984     for (i = 0; i < ARRAY_SIZE(feats); i++) {
985         set_bit(feats[i], ignored_base_feat);
986     }
987 }
988 
989 static void register_types(void)
990 {
991     static const S390FeatInit qemu_max_init = { S390_FEAT_LIST_QEMU_MAX };
992     int i;
993 
994     init_ignored_base_feat();
995 
996     /* init all bitmaps from generated data initially */
997     s390_init_feat_bitmap(qemu_max_init, qemu_max_cpu_feat);
998     for (i = 0; i < ARRAY_SIZE(s390_cpu_defs); i++) {
999         s390_init_feat_bitmap(s390_cpu_defs[i].base_init,
1000                               s390_cpu_defs[i].base_feat);
1001         s390_init_feat_bitmap(s390_cpu_defs[i].default_init,
1002                               s390_cpu_defs[i].default_feat);
1003         s390_init_feat_bitmap(s390_cpu_defs[i].full_init,
1004                               s390_cpu_defs[i].full_feat);
1005     }
1006 
1007     /* initialize the qemu model with the maximum definition ("max" model) */
1008     s390_set_qemu_cpu_model(QEMU_MAX_CPU_TYPE, QEMU_MAX_CPU_GEN,
1009                             QEMU_MAX_CPU_EC_GA, qemu_max_init);
1010 
1011     for (i = 0; i < ARRAY_SIZE(s390_cpu_defs); i++) {
1012         char *base_name = s390_base_cpu_type_name(s390_cpu_defs[i].name);
1013         TypeInfo ti_base = {
1014             .name = base_name,
1015             .parent = TYPE_S390_CPU,
1016             .instance_init = s390_cpu_model_initfn,
1017             .instance_finalize = s390_cpu_model_finalize,
1018             .class_init = s390_base_cpu_model_class_init,
1019             .class_data = (void *) &s390_cpu_defs[i],
1020         };
1021         char *name = s390_cpu_type_name(s390_cpu_defs[i].name);
1022         TypeInfo ti = {
1023             .name = name,
1024             .parent = TYPE_S390_CPU,
1025             .instance_init = s390_cpu_model_initfn,
1026             .instance_finalize = s390_cpu_model_finalize,
1027             .class_init = s390_cpu_model_class_init,
1028             .class_data = (void *) &s390_cpu_defs[i],
1029         };
1030 
1031         type_register_static(&ti_base);
1032         type_register_static(&ti);
1033         g_free(base_name);
1034         g_free(name);
1035     }
1036 
1037     type_register_static(&qemu_s390_cpu_type_info);
1038     type_register_static(&max_s390_cpu_type_info);
1039 #ifdef CONFIG_KVM
1040     type_register_static(&host_s390_cpu_type_info);
1041 #endif
1042 }
1043 
1044 type_init(register_types)
1045