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