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