xref: /openbmc/qemu/target/s390x/cpu_models.c (revision 1a7a31ae)
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_PRNO_TRNG_QRTCR, S390_FEAT_MSA_EXT_5 },
481         { S390_FEAT_PRNO_TRNG, S390_FEAT_MSA_EXT_5 },
482         { S390_FEAT_SIE_KSS, S390_FEAT_SIE_F2 },
483         { S390_FEAT_AP_QUERY_CONFIG_INFO, S390_FEAT_AP },
484         { S390_FEAT_AP_FACILITIES_TEST, S390_FEAT_AP },
485         { S390_FEAT_PTFF_QSIE, S390_FEAT_MULTIPLE_EPOCH },
486         { S390_FEAT_PTFF_QTOUE, S390_FEAT_MULTIPLE_EPOCH },
487         { S390_FEAT_PTFF_STOE, S390_FEAT_MULTIPLE_EPOCH },
488         { S390_FEAT_PTFF_STOUE, S390_FEAT_MULTIPLE_EPOCH },
489         { S390_FEAT_AP_QUEUE_INTERRUPT_CONTROL, S390_FEAT_AP },
490         { S390_FEAT_DIAG_318, S390_FEAT_EXTENDED_LENGTH_SCCB },
491         { S390_FEAT_NNPA, S390_FEAT_VECTOR },
492         { S390_FEAT_RDP, S390_FEAT_LOCAL_TLB_CLEARING },
493         { S390_FEAT_UV_FEAT_AP, S390_FEAT_AP },
494         { S390_FEAT_UV_FEAT_AP_INTR, S390_FEAT_UV_FEAT_AP },
495     };
496     int i;
497 
498     for (i = 0; i < ARRAY_SIZE(dep); i++) {
499         if (test_bit(dep[i][0], model->features) &&
500             !test_bit(dep[i][1], model->features)) {
501             warn_report("\'%s\' requires \'%s\'.",
502                         s390_feat_def(dep[i][0])->name,
503                         s390_feat_def(dep[i][1])->name);
504         }
505     }
506 }
507 
508 static void error_prepend_missing_feat(const char *name, void *opaque)
509 {
510     error_prepend((Error **) opaque, "%s ", name);
511 }
512 
513 static void check_compat_model_failed(Error **errp,
514                                       const S390CPUModel *max_model,
515                                       const char *msg)
516 {
517     error_setg(errp, "%s. Maximum supported model in the current configuration: \'%s\'",
518                msg, max_model->def->name);
519     error_append_hint(errp, "Consider a different accelerator, try \"-accel help\"\n");
520     return;
521 }
522 
523 static bool check_compatibility(const S390CPUModel *max_model,
524                                 const S390CPUModel *model, Error **errp)
525 {
526     ERRP_GUARD();
527     S390FeatBitmap missing;
528 
529     if (model->def->gen > max_model->def->gen) {
530         check_compat_model_failed(errp, max_model, "Selected CPU generation is too new");
531         return false;
532     } else if (model->def->gen == max_model->def->gen &&
533                model->def->ec_ga > max_model->def->ec_ga) {
534         check_compat_model_failed(errp, max_model, "Selected CPU GA level is too new");
535         return false;
536     }
537 
538 #ifndef CONFIG_USER_ONLY
539     if (only_migratable && test_bit(S390_FEAT_UNPACK, model->features)) {
540         error_setg(errp, "The unpack facility is not compatible with "
541                    "the --only-migratable option. You must remove either "
542                    "the 'unpack' facility or the --only-migratable option");
543         return false;
544     }
545 #endif
546 
547     /* detect the missing features to properly report them */
548     bitmap_andnot(missing, model->features, max_model->features, S390_FEAT_MAX);
549     if (bitmap_empty(missing, S390_FEAT_MAX)) {
550         return true;
551     }
552 
553     error_setg(errp, " ");
554     s390_feat_bitmap_to_ascii(missing, errp, error_prepend_missing_feat);
555     error_prepend(errp, "Some features requested in the CPU model are not "
556                   "available in the current configuration: ");
557     error_append_hint(errp,
558                       "Consider a different accelerator, QEMU, or kernel version\n");
559     return false;
560 }
561 
562 S390CPUModel *get_max_cpu_model(Error **errp)
563 {
564     static S390CPUModel max_model;
565     static bool cached;
566 
567     if (cached) {
568         return &max_model;
569     }
570 
571     if (kvm_enabled()) {
572         if (!kvm_s390_get_host_cpu_model(&max_model, errp)) {
573             return NULL;
574         }
575     } else {
576         max_model.def = s390_find_cpu_def(QEMU_MAX_CPU_TYPE, QEMU_MAX_CPU_GEN,
577                                           QEMU_MAX_CPU_EC_GA, NULL);
578         bitmap_copy(max_model.features, qemu_max_cpu_feat, S390_FEAT_MAX);
579     }
580     cached = true;
581     return &max_model;
582 }
583 
584 void s390_realize_cpu_model(CPUState *cs, Error **errp)
585 {
586     ERRP_GUARD();
587     S390CPUClass *xcc = S390_CPU_GET_CLASS(cs);
588     S390CPU *cpu = S390_CPU(cs);
589     const S390CPUModel *max_model;
590 
591     if (xcc->kvm_required && !kvm_enabled()) {
592         error_setg(errp, "CPU definition requires KVM");
593         return;
594     }
595 
596     if (!cpu->model) {
597         /* no host model support -> perform compatibility stuff */
598         apply_cpu_model(NULL, errp);
599         return;
600     }
601 
602     max_model = get_max_cpu_model(errp);
603     if (!max_model) {
604         error_prepend(errp, "CPU models are not available: ");
605         return;
606     }
607 
608     /* copy over properties that can vary */
609     cpu->model->lowest_ibc = max_model->lowest_ibc;
610     cpu->model->cpu_id = max_model->cpu_id;
611     cpu->model->cpu_id_format = max_model->cpu_id_format;
612     cpu->model->cpu_ver = max_model->cpu_ver;
613 
614     check_consistency(cpu->model);
615     if (!check_compatibility(max_model, cpu->model, errp)) {
616         return;
617     }
618 
619     apply_cpu_model(cpu->model, errp);
620 
621 #if !defined(CONFIG_USER_ONLY)
622     cpu->env.cpuid = s390_cpuid_from_cpu_model(cpu->model);
623     if (tcg_enabled()) {
624         cpu->env.cpuid = deposit64(cpu->env.cpuid, CPU_PHYS_ADDR_SHIFT,
625                                    CPU_PHYS_ADDR_BITS, cpu->env.core_id);
626     }
627 #endif
628 }
629 
630 static void get_feature(Object *obj, Visitor *v, const char *name,
631                         void *opaque, Error **errp)
632 {
633     S390Feat feat = (S390Feat) (uintptr_t) opaque;
634     S390CPU *cpu = S390_CPU(obj);
635     bool value;
636 
637     if (!cpu->model) {
638         error_setg(errp, "Details about the host CPU model are not available, "
639                          "features cannot be queried.");
640         return;
641     }
642 
643     value = test_bit(feat, cpu->model->features);
644     visit_type_bool(v, name, &value, errp);
645 }
646 
647 static void set_feature(Object *obj, Visitor *v, const char *name,
648                         void *opaque, Error **errp)
649 {
650     S390Feat feat = (S390Feat) (uintptr_t) opaque;
651     DeviceState *dev = DEVICE(obj);
652     S390CPU *cpu = S390_CPU(obj);
653     bool value;
654 
655     if (dev->realized) {
656         error_setg(errp, "Attempt to set property '%s' on '%s' after "
657                    "it was realized", name, object_get_typename(obj));
658         return;
659     } else if (!cpu->model) {
660         error_setg(errp, "Details about the host CPU model are not available, "
661                          "features cannot be changed.");
662         return;
663     }
664 
665     if (!visit_type_bool(v, name, &value, errp)) {
666         return;
667     }
668     if (value) {
669         if (!test_bit(feat, cpu->model->def->full_feat)) {
670             error_setg(errp, "Feature '%s' is not available for CPU model '%s',"
671                        " it was introduced with later models.",
672                        name, cpu->model->def->name);
673             return;
674         }
675         set_bit(feat, cpu->model->features);
676     } else {
677         clear_bit(feat, cpu->model->features);
678     }
679 }
680 
681 static void get_feature_group(Object *obj, Visitor *v, const char *name,
682                               void *opaque, Error **errp)
683 {
684     S390FeatGroup group = (S390FeatGroup) (uintptr_t) opaque;
685     const S390FeatGroupDef *def = s390_feat_group_def(group);
686     S390CPU *cpu = S390_CPU(obj);
687     S390FeatBitmap tmp;
688     bool value;
689 
690     if (!cpu->model) {
691         error_setg(errp, "Details about the host CPU model are not available, "
692                          "features cannot be queried.");
693         return;
694     }
695 
696     /* a group is enabled if all features are enabled */
697     bitmap_and(tmp, cpu->model->features, def->feat, S390_FEAT_MAX);
698     value = bitmap_equal(tmp, def->feat, S390_FEAT_MAX);
699     visit_type_bool(v, name, &value, errp);
700 }
701 
702 static void set_feature_group(Object *obj, Visitor *v, const char *name,
703                               void *opaque, Error **errp)
704 {
705     S390FeatGroup group = (S390FeatGroup) (uintptr_t) opaque;
706     const S390FeatGroupDef *def = s390_feat_group_def(group);
707     DeviceState *dev = DEVICE(obj);
708     S390CPU *cpu = S390_CPU(obj);
709     bool value;
710 
711     if (dev->realized) {
712         error_setg(errp, "Attempt to set property '%s' on '%s' after "
713                    "it was realized", name, object_get_typename(obj));
714         return;
715     } else if (!cpu->model) {
716         error_setg(errp, "Details about the host CPU model are not available, "
717                          "features cannot be changed.");
718         return;
719     }
720 
721     if (!visit_type_bool(v, name, &value, errp)) {
722         return;
723     }
724     if (value) {
725         /* groups are added in one shot, so an intersect is sufficient */
726         if (!bitmap_intersects(def->feat, cpu->model->def->full_feat,
727                                S390_FEAT_MAX)) {
728             error_setg(errp, "Group '%s' is not available for CPU model '%s',"
729                        " it was introduced with later models.",
730                        name, cpu->model->def->name);
731             return;
732         }
733         bitmap_or(cpu->model->features, cpu->model->features, def->feat,
734                   S390_FEAT_MAX);
735     } else {
736         bitmap_andnot(cpu->model->features, cpu->model->features, def->feat,
737                       S390_FEAT_MAX);
738     }
739 }
740 
741 static void s390_cpu_model_initfn(Object *obj)
742 {
743     S390CPU *cpu = S390_CPU(obj);
744     S390CPUClass *xcc = S390_CPU_GET_CLASS(cpu);
745 
746     cpu->model = g_malloc0(sizeof(*cpu->model));
747     /* copy the model, so we can modify it */
748     cpu->model->def = xcc->cpu_def;
749     if (xcc->is_static) {
750         /* base model - features will never change */
751         bitmap_copy(cpu->model->features, cpu->model->def->base_feat,
752                     S390_FEAT_MAX);
753     } else {
754         /* latest model - features can change */
755         bitmap_copy(cpu->model->features,
756                     cpu->model->def->default_feat, S390_FEAT_MAX);
757     }
758 }
759 
760 static S390CPUModel s390_qemu_cpu_model;
761 
762 /* Set the qemu CPU model (on machine initialization). Must not be called
763  * once CPUs have been created.
764  */
765 void s390_set_qemu_cpu_model(uint16_t type, uint8_t gen, uint8_t ec_ga,
766                              const S390FeatInit feat_init)
767 {
768     const S390CPUDef *def = s390_find_cpu_def(type, gen, ec_ga, NULL);
769 
770     g_assert(def);
771     g_assert(QTAILQ_EMPTY_RCU(&cpus_queue));
772 
773     /* build the CPU model */
774     s390_qemu_cpu_model.def = def;
775     bitmap_zero(s390_qemu_cpu_model.features, S390_FEAT_MAX);
776     s390_init_feat_bitmap(feat_init, s390_qemu_cpu_model.features);
777 }
778 
779 static void s390_qemu_cpu_model_initfn(Object *obj)
780 {
781     S390CPU *cpu = S390_CPU(obj);
782 
783     cpu->model = g_malloc0(sizeof(*cpu->model));
784     /* copy the CPU model so we can modify it */
785     memcpy(cpu->model, &s390_qemu_cpu_model, sizeof(*cpu->model));
786 }
787 
788 static void s390_max_cpu_model_initfn(Object *obj)
789 {
790     const S390CPUModel *max_model;
791     S390CPU *cpu = S390_CPU(obj);
792     Error *local_err = NULL;
793 
794     if (kvm_enabled() && !kvm_s390_cpu_models_supported()) {
795         /* "max" and "host" always work, even without CPU model support */
796         return;
797     }
798 
799     max_model = get_max_cpu_model(&local_err);
800     if (local_err) {
801         /* we expect errors only under KVM, when actually querying the kernel */
802         g_assert(kvm_enabled());
803         error_report_err(local_err);
804         /* fallback to unsupported CPU models */
805         return;
806     }
807 
808     cpu->model = g_new(S390CPUModel, 1);
809     /* copy the CPU model so we can modify it */
810     memcpy(cpu->model, max_model, sizeof(*cpu->model));
811 }
812 
813 static void s390_cpu_model_finalize(Object *obj)
814 {
815     S390CPU *cpu = S390_CPU(obj);
816 
817     g_free(cpu->model);
818     cpu->model = NULL;
819 }
820 
821 static bool get_is_migration_safe(Object *obj, Error **errp)
822 {
823     return S390_CPU_GET_CLASS(obj)->is_migration_safe;
824 }
825 
826 static bool get_is_static(Object *obj, Error **errp)
827 {
828     return S390_CPU_GET_CLASS(obj)->is_static;
829 }
830 
831 static char *get_description(Object *obj, Error **errp)
832 {
833     return g_strdup(S390_CPU_GET_CLASS(obj)->desc);
834 }
835 
836 void s390_cpu_model_class_register_props(ObjectClass *oc)
837 {
838     S390FeatGroup group;
839     S390Feat feat;
840 
841     object_class_property_add_bool(oc, "migration-safe", get_is_migration_safe,
842                                    NULL);
843     object_class_property_add_bool(oc, "static", get_is_static,
844                                    NULL);
845     object_class_property_add_str(oc, "description", get_description, NULL);
846 
847     for (feat = 0; feat < S390_FEAT_MAX; feat++) {
848         const S390FeatDef *def = s390_feat_def(feat);
849         object_class_property_add(oc, def->name, "bool", get_feature,
850                                   set_feature, NULL, (void *) feat);
851         object_class_property_set_description(oc, def->name, def->desc);
852     }
853     for (group = 0; group < S390_FEAT_GROUP_MAX; group++) {
854         const S390FeatGroupDef *def = s390_feat_group_def(group);
855         object_class_property_add(oc, def->name, "bool", get_feature_group,
856                                   set_feature_group, NULL, (void *) group);
857         object_class_property_set_description(oc, def->name, def->desc);
858     }
859 }
860 
861 #ifdef CONFIG_KVM
862 static void s390_host_cpu_model_class_init(ObjectClass *oc, void *data)
863 {
864     S390CPUClass *xcc = S390_CPU_CLASS(oc);
865 
866     xcc->kvm_required = true;
867     xcc->desc = "KVM only: All recognized features";
868 }
869 #endif
870 
871 static void s390_base_cpu_model_class_init(ObjectClass *oc, void *data)
872 {
873     S390CPUClass *xcc = S390_CPU_CLASS(oc);
874 
875     /* all base models are migration safe */
876     xcc->cpu_def = (const S390CPUDef *) data;
877     xcc->is_migration_safe = true;
878     xcc->is_static = true;
879     xcc->desc = xcc->cpu_def->desc;
880 }
881 
882 static void s390_cpu_model_class_init(ObjectClass *oc, void *data)
883 {
884     S390CPUClass *xcc = S390_CPU_CLASS(oc);
885 
886     /* model that can change between QEMU versions */
887     xcc->cpu_def = (const S390CPUDef *) data;
888     xcc->is_migration_safe = true;
889     xcc->desc = xcc->cpu_def->desc;
890 }
891 
892 static void s390_qemu_cpu_model_class_init(ObjectClass *oc, void *data)
893 {
894     S390CPUClass *xcc = S390_CPU_CLASS(oc);
895 
896     xcc->is_migration_safe = true;
897     xcc->desc = g_strdup_printf("QEMU Virtual CPU version %s",
898                                 qemu_hw_version());
899 }
900 
901 static void s390_max_cpu_model_class_init(ObjectClass *oc, void *data)
902 {
903     S390CPUClass *xcc = S390_CPU_CLASS(oc);
904 
905     /*
906      * The "max" model is neither static nor migration safe. Under KVM
907      * it represents the "host" model. Under TCG it represents the "qemu" CPU
908      * model of the latest QEMU machine.
909      */
910     xcc->desc =
911         "Enables all features supported by the accelerator in the current host";
912 }
913 
914 /* Generate type name for a cpu model. Caller has to free the string. */
915 static char *s390_cpu_type_name(const char *model_name)
916 {
917     return g_strdup_printf(S390_CPU_TYPE_NAME("%s"), model_name);
918 }
919 
920 /* Generate type name for a base cpu model. Caller has to free the string. */
921 static char *s390_base_cpu_type_name(const char *model_name)
922 {
923     return g_strdup_printf(S390_CPU_TYPE_NAME("%s-base"), model_name);
924 }
925 
926 ObjectClass *s390_cpu_class_by_name(const char *name)
927 {
928     char *typename = s390_cpu_type_name(name);
929     ObjectClass *oc;
930 
931     oc = object_class_by_name(typename);
932     g_free(typename);
933     return oc;
934 }
935 
936 static const TypeInfo qemu_s390_cpu_type_info = {
937     .name = S390_CPU_TYPE_NAME("qemu"),
938     .parent = TYPE_S390_CPU,
939     .instance_init = s390_qemu_cpu_model_initfn,
940     .instance_finalize = s390_cpu_model_finalize,
941     .class_init = s390_qemu_cpu_model_class_init,
942 };
943 
944 static const TypeInfo max_s390_cpu_type_info = {
945     .name = S390_CPU_TYPE_NAME("max"),
946     .parent = TYPE_S390_CPU,
947     .instance_init = s390_max_cpu_model_initfn,
948     .instance_finalize = s390_cpu_model_finalize,
949     .class_init = s390_max_cpu_model_class_init,
950 };
951 
952 #ifdef CONFIG_KVM
953 static const TypeInfo host_s390_cpu_type_info = {
954     .name = S390_CPU_TYPE_NAME("host"),
955     .parent = S390_CPU_TYPE_NAME("max"),
956     .class_init = s390_host_cpu_model_class_init,
957 };
958 #endif
959 
960 static void init_ignored_base_feat(void)
961 {
962     static const int feats[] = {
963          /* MSA subfunctions that could not be available on certain machines */
964          S390_FEAT_KMAC_DEA,
965          S390_FEAT_KMAC_TDEA_128,
966          S390_FEAT_KMAC_TDEA_192,
967          S390_FEAT_KMC_DEA,
968          S390_FEAT_KMC_TDEA_128,
969          S390_FEAT_KMC_TDEA_192,
970          S390_FEAT_KM_DEA,
971          S390_FEAT_KM_TDEA_128,
972          S390_FEAT_KM_TDEA_192,
973          S390_FEAT_KIMD_SHA_1,
974          S390_FEAT_KLMD_SHA_1,
975          /* CSSKE is deprecated on newer generations */
976          S390_FEAT_CONDITIONAL_SSKE,
977     };
978     int i;
979 
980     for (i = 0; i < ARRAY_SIZE(feats); i++) {
981         set_bit(feats[i], ignored_base_feat);
982     }
983 }
984 
985 static void register_types(void)
986 {
987     static const S390FeatInit qemu_max_init = { S390_FEAT_LIST_QEMU_MAX };
988     int i;
989 
990     init_ignored_base_feat();
991 
992     /* init all bitmaps from generated data initially */
993     s390_init_feat_bitmap(qemu_max_init, qemu_max_cpu_feat);
994     for (i = 0; i < ARRAY_SIZE(s390_cpu_defs); i++) {
995         s390_init_feat_bitmap(s390_cpu_defs[i].base_init,
996                               s390_cpu_defs[i].base_feat);
997         s390_init_feat_bitmap(s390_cpu_defs[i].default_init,
998                               s390_cpu_defs[i].default_feat);
999         s390_init_feat_bitmap(s390_cpu_defs[i].full_init,
1000                               s390_cpu_defs[i].full_feat);
1001     }
1002 
1003     /* initialize the qemu model with the maximum definition ("max" model) */
1004     s390_set_qemu_cpu_model(QEMU_MAX_CPU_TYPE, QEMU_MAX_CPU_GEN,
1005                             QEMU_MAX_CPU_EC_GA, qemu_max_init);
1006 
1007     for (i = 0; i < ARRAY_SIZE(s390_cpu_defs); i++) {
1008         char *base_name = s390_base_cpu_type_name(s390_cpu_defs[i].name);
1009         TypeInfo ti_base = {
1010             .name = base_name,
1011             .parent = TYPE_S390_CPU,
1012             .instance_init = s390_cpu_model_initfn,
1013             .instance_finalize = s390_cpu_model_finalize,
1014             .class_init = s390_base_cpu_model_class_init,
1015             .class_data = (void *) &s390_cpu_defs[i],
1016         };
1017         char *name = s390_cpu_type_name(s390_cpu_defs[i].name);
1018         TypeInfo ti = {
1019             .name = name,
1020             .parent = TYPE_S390_CPU,
1021             .instance_init = s390_cpu_model_initfn,
1022             .instance_finalize = s390_cpu_model_finalize,
1023             .class_init = s390_cpu_model_class_init,
1024             .class_data = (void *) &s390_cpu_defs[i],
1025         };
1026 
1027         type_register_static(&ti_base);
1028         type_register_static(&ti);
1029         g_free(base_name);
1030         g_free(name);
1031     }
1032 
1033     type_register_static(&qemu_s390_cpu_type_info);
1034     type_register_static(&max_s390_cpu_type_info);
1035 #ifdef CONFIG_KVM
1036     type_register_static(&host_s390_cpu_type_info);
1037 #endif
1038 }
1039 
1040 type_init(register_types)
1041