xref: /qemu/tests/qtest/bios-tables-test.c (revision a7b4384fefbd1cbe05c8fd10fe06de8c4fdc2792)
1 /*
2  * Boot order test cases.
3  *
4  * Copyright (c) 2013 Red Hat Inc.
5  *
6  * Authors:
7  *  Michael S. Tsirkin <mst@redhat.com>,
8  *
9  * This work is licensed under the terms of the GNU GPL, version 2 or later.
10  * See the COPYING file in the top-level directory.
11  */
12 
13 /*
14  * How to add or update the tests:
15  * Contributor:
16  * 1. add empty files for new tables, if any, under tests/data/acpi
17  * 2. list any changed files in tests/qtest/bios-tables-test-allowed-diff.h
18  * 3. commit the above *before* making changes that affect the tables
19  *
20  * Contributor or ACPI Maintainer (steps 4-7 need to be redone to resolve conflicts
21  * in binary commit created in step 6):
22  *
23  * After 1-3 above tests will pass but ignore differences with the expected files.
24  * You will also notice that tests/qtest/bios-tables-test-allowed-diff.h lists
25  * a bunch of files. This is your hint that you need to do the below:
26  * 4. Run
27  *      make check V=1
28  * this will produce a bunch of warnings about differences
29  * beween actual and expected ACPI tables. If you have IASL installed,
30  * they will also be disassembled so you can look at the disassembled
31  * output. If not - disassemble them yourself in any way you like.
32  * Look at the differences - make sure they make sense and match what the
33  * changes you are merging are supposed to do.
34  * Save the changes, preferably in form of ASL diff for the commit log in
35  * step 6.
36  *
37  * 5. From build directory, run:
38  *      $(SRC_PATH)/tests/data/acpi/rebuild-expected-aml.sh
39  * 6. Now commit any changes to the expected binary, include diff from step 4
40  *    in commit log.
41  * 7. Before sending patches to the list (Contributor)
42  *    or before doing a pull request (Maintainer), make sure
43  *    tests/qtest/bios-tables-test-allowed-diff.h is empty - this will ensure
44  *    following changes to ACPI tables will be noticed.
45  *
46  * The resulting patchset/pull request then looks like this:
47  * - patch 1: list changed files in tests/qtest/bios-tables-test-allowed-diff.h.
48  * - patches 2 - n: real changes, may contain multiple patches.
49  * - patch n + 1: update golden master binaries and empty
50  *   tests/qtest/bios-tables-test-allowed-diff.h
51  */
52 
53 #include "qemu/osdep.h"
54 #include <glib/gstdio.h>
55 #include "qemu-common.h"
56 #include "hw/firmware/smbios.h"
57 #include "qemu/bitmap.h"
58 #include "acpi-utils.h"
59 #include "boot-sector.h"
60 
61 #define MACHINE_PC "pc"
62 #define MACHINE_Q35 "q35"
63 
64 #define ACPI_REBUILD_EXPECTED_AML "TEST_ACPI_REBUILD_AML"
65 
66 typedef struct {
67     bool tcg_only;
68     const char *machine;
69     const char *variant;
70     const char *uefi_fl1;
71     const char *uefi_fl2;
72     const char *cd;
73     const uint64_t ram_start;
74     const uint64_t scan_len;
75     uint64_t rsdp_addr;
76     uint8_t rsdp_table[36 /* ACPI 2.0+ RSDP size */];
77     GArray *tables;
78     uint32_t smbios_ep_addr;
79     struct smbios_21_entry_point smbios_ep_table;
80     uint8_t *required_struct_types;
81     int required_struct_types_len;
82     QTestState *qts;
83 } test_data;
84 
85 static char disk[] = "tests/acpi-test-disk-XXXXXX";
86 static const char *data_dir = "tests/data/acpi";
87 #ifdef CONFIG_IASL
88 static const char *iasl = stringify(CONFIG_IASL);
89 #else
90 static const char *iasl;
91 #endif
92 
93 static bool compare_signature(const AcpiSdtTable *sdt, const char *signature)
94 {
95    return !memcmp(sdt->aml, signature, 4);
96 }
97 
98 static void cleanup_table_descriptor(AcpiSdtTable *table)
99 {
100     g_free(table->aml);
101     if (table->aml_file &&
102         !table->tmp_files_retain &&
103         g_strstr_len(table->aml_file, -1, "aml-")) {
104         unlink(table->aml_file);
105     }
106     g_free(table->aml_file);
107     g_free(table->asl);
108     if (table->asl_file &&
109         !table->tmp_files_retain) {
110         unlink(table->asl_file);
111     }
112     g_free(table->asl_file);
113 }
114 
115 static void free_test_data(test_data *data)
116 {
117     int i;
118 
119     for (i = 0; i < data->tables->len; ++i) {
120         cleanup_table_descriptor(&g_array_index(data->tables, AcpiSdtTable, i));
121     }
122 
123     g_array_free(data->tables, true);
124 }
125 
126 static void test_acpi_rsdp_table(test_data *data)
127 {
128     uint8_t *rsdp_table = data->rsdp_table;
129 
130     acpi_fetch_rsdp_table(data->qts, data->rsdp_addr, rsdp_table);
131 
132     switch (rsdp_table[15 /* Revision offset */]) {
133     case 0: /* ACPI 1.0 RSDP */
134         /* With rev 1, checksum is only for the first 20 bytes */
135         g_assert(!acpi_calc_checksum(rsdp_table,  20));
136         break;
137     case 2: /* ACPI 2.0+ RSDP */
138         /* With revision 2, we have 2 checksums */
139         g_assert(!acpi_calc_checksum(rsdp_table, 20));
140         g_assert(!acpi_calc_checksum(rsdp_table, 36));
141         break;
142     default:
143         g_assert_not_reached();
144     }
145 }
146 
147 static void test_acpi_rxsdt_table(test_data *data)
148 {
149     const char *sig = "RSDT";
150     AcpiSdtTable rsdt = {};
151     int entry_size = 4;
152     int addr_off = 16 /* RsdtAddress */;
153     uint8_t *ent;
154 
155     if (data->rsdp_table[15 /* Revision offset */] != 0) {
156         addr_off = 24 /* XsdtAddress */;
157         entry_size = 8;
158         sig = "XSDT";
159     }
160     /* read [RX]SDT table */
161     acpi_fetch_table(data->qts, &rsdt.aml, &rsdt.aml_len,
162                      &data->rsdp_table[addr_off], entry_size, sig, true);
163 
164     /* Load all tables and add to test list directly RSDT referenced tables */
165     ACPI_FOREACH_RSDT_ENTRY(rsdt.aml, rsdt.aml_len, ent, entry_size) {
166         AcpiSdtTable ssdt_table = {};
167 
168         acpi_fetch_table(data->qts, &ssdt_table.aml, &ssdt_table.aml_len, ent,
169                          entry_size, NULL, true);
170         /* Add table to ASL test tables list */
171         g_array_append_val(data->tables, ssdt_table);
172     }
173     cleanup_table_descriptor(&rsdt);
174 }
175 
176 static void test_acpi_fadt_table(test_data *data)
177 {
178     /* FADT table is 1st */
179     AcpiSdtTable table = g_array_index(data->tables, typeof(table), 0);
180     uint8_t *fadt_aml = table.aml;
181     uint32_t fadt_len = table.aml_len;
182     uint32_t val;
183     int dsdt_offset = 40 /* DSDT */;
184     int dsdt_entry_size = 4;
185 
186     g_assert(compare_signature(&table, "FACP"));
187 
188     /* Since DSDT/FACS isn't in RSDT, add them to ASL test list manually */
189     memcpy(&val, fadt_aml + 112 /* Flags */, 4);
190     val = le32_to_cpu(val);
191     if (!(val & 1UL << 20 /* HW_REDUCED_ACPI */)) {
192         acpi_fetch_table(data->qts, &table.aml, &table.aml_len,
193                          fadt_aml + 36 /* FIRMWARE_CTRL */, 4, "FACS", false);
194         g_array_append_val(data->tables, table);
195     }
196 
197     memcpy(&val, fadt_aml + dsdt_offset, 4);
198     val = le32_to_cpu(val);
199     if (!val) {
200         dsdt_offset = 140 /* X_DSDT */;
201         dsdt_entry_size = 8;
202     }
203     acpi_fetch_table(data->qts, &table.aml, &table.aml_len,
204                      fadt_aml + dsdt_offset, dsdt_entry_size, "DSDT", true);
205     g_array_append_val(data->tables, table);
206 
207     memset(fadt_aml + 36, 0, 4); /* sanitize FIRMWARE_CTRL ptr */
208     memset(fadt_aml + 40, 0, 4); /* sanitize DSDT ptr */
209     if (fadt_aml[8 /* FADT Major Version */] >= 3) {
210         memset(fadt_aml + 132, 0, 8); /* sanitize X_FIRMWARE_CTRL ptr */
211         memset(fadt_aml + 140, 0, 8); /* sanitize X_DSDT ptr */
212     }
213 
214     /* update checksum */
215     fadt_aml[9 /* Checksum */] = 0;
216     fadt_aml[9 /* Checksum */] -= acpi_calc_checksum(fadt_aml, fadt_len);
217 }
218 
219 static void dump_aml_files(test_data *data, bool rebuild)
220 {
221     AcpiSdtTable *sdt;
222     GError *error = NULL;
223     gchar *aml_file = NULL;
224     gint fd;
225     ssize_t ret;
226     int i;
227 
228     for (i = 0; i < data->tables->len; ++i) {
229         const char *ext = data->variant ? data->variant : "";
230         sdt = &g_array_index(data->tables, AcpiSdtTable, i);
231         g_assert(sdt->aml);
232 
233         if (rebuild) {
234             aml_file = g_strdup_printf("%s/%s/%.4s%s", data_dir, data->machine,
235                                        sdt->aml, ext);
236             fd = g_open(aml_file, O_WRONLY|O_TRUNC|O_CREAT,
237                         S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH);
238             if (fd < 0) {
239                 perror(aml_file);
240             }
241             g_assert(fd >= 0);
242         } else {
243             fd = g_file_open_tmp("aml-XXXXXX", &sdt->aml_file, &error);
244             g_assert_no_error(error);
245         }
246 
247         ret = qemu_write_full(fd, sdt->aml, sdt->aml_len);
248         g_assert(ret == sdt->aml_len);
249 
250         close(fd);
251 
252         g_free(aml_file);
253     }
254 }
255 
256 static bool load_asl(GArray *sdts, AcpiSdtTable *sdt)
257 {
258     AcpiSdtTable *temp;
259     GError *error = NULL;
260     GString *command_line = g_string_new(iasl);
261     gint fd;
262     gchar *out, *out_err;
263     gboolean ret;
264     int i;
265 
266     fd = g_file_open_tmp("asl-XXXXXX.dsl", &sdt->asl_file, &error);
267     g_assert_no_error(error);
268     close(fd);
269 
270     /* build command line */
271     g_string_append_printf(command_line, " -p %s ", sdt->asl_file);
272     if (compare_signature(sdt, "DSDT") ||
273         compare_signature(sdt, "SSDT")) {
274         for (i = 0; i < sdts->len; ++i) {
275             temp = &g_array_index(sdts, AcpiSdtTable, i);
276             if (compare_signature(temp, "DSDT") ||
277                 compare_signature(temp, "SSDT")) {
278                 g_string_append_printf(command_line, "-e %s ", temp->aml_file);
279             }
280         }
281     }
282     g_string_append_printf(command_line, "-d %s", sdt->aml_file);
283 
284     /* pass 'out' and 'out_err' in order to be redirected */
285     ret = g_spawn_command_line_sync(command_line->str, &out, &out_err, NULL, &error);
286     g_assert_no_error(error);
287     if (ret) {
288         ret = g_file_get_contents(sdt->asl_file, &sdt->asl,
289                                   &sdt->asl_len, &error);
290         g_assert(ret);
291         g_assert_no_error(error);
292         ret = (sdt->asl_len > 0);
293     }
294 
295     g_free(out);
296     g_free(out_err);
297     g_string_free(command_line, true);
298 
299     return !ret;
300 }
301 
302 #define COMMENT_END "*/"
303 #define DEF_BLOCK "DefinitionBlock ("
304 #define BLOCK_NAME_END ","
305 
306 static GString *normalize_asl(gchar *asl_code)
307 {
308     GString *asl = g_string_new(asl_code);
309     gchar *comment, *block_name;
310 
311     /* strip comments (different generation days) */
312     comment = g_strstr_len(asl->str, asl->len, COMMENT_END);
313     if (comment) {
314         comment += strlen(COMMENT_END);
315         while (*comment == '\n') {
316             comment++;
317         }
318         asl = g_string_erase(asl, 0, comment - asl->str);
319     }
320 
321     /* strip def block name (it has file path in it) */
322     if (g_str_has_prefix(asl->str, DEF_BLOCK)) {
323         block_name = g_strstr_len(asl->str, asl->len, BLOCK_NAME_END);
324         g_assert(block_name);
325         asl = g_string_erase(asl, 0,
326                              block_name + sizeof(BLOCK_NAME_END) - asl->str);
327     }
328 
329     return asl;
330 }
331 
332 static GArray *load_expected_aml(test_data *data)
333 {
334     int i;
335     AcpiSdtTable *sdt;
336     GError *error = NULL;
337     gboolean ret;
338     gsize aml_len;
339 
340     GArray *exp_tables = g_array_new(false, true, sizeof(AcpiSdtTable));
341     if (getenv("V")) {
342         fputc('\n', stderr);
343     }
344     for (i = 0; i < data->tables->len; ++i) {
345         AcpiSdtTable exp_sdt;
346         gchar *aml_file = NULL;
347         const char *ext = data->variant ? data->variant : "";
348 
349         sdt = &g_array_index(data->tables, AcpiSdtTable, i);
350 
351         memset(&exp_sdt, 0, sizeof(exp_sdt));
352 
353 try_again:
354         aml_file = g_strdup_printf("%s/%s/%.4s%s", data_dir, data->machine,
355                                    sdt->aml, ext);
356         if (getenv("V")) {
357             fprintf(stderr, "Looking for expected file '%s'\n", aml_file);
358         }
359         if (g_file_test(aml_file, G_FILE_TEST_EXISTS)) {
360             exp_sdt.aml_file = aml_file;
361         } else if (*ext != '\0') {
362             /* try fallback to generic (extension less) expected file */
363             ext = "";
364             g_free(aml_file);
365             goto try_again;
366         }
367         g_assert(exp_sdt.aml_file);
368         if (getenv("V")) {
369             fprintf(stderr, "Using expected file '%s'\n", aml_file);
370         }
371         ret = g_file_get_contents(aml_file, (gchar **)&exp_sdt.aml,
372                                   &aml_len, &error);
373         exp_sdt.aml_len = aml_len;
374         g_assert(ret);
375         g_assert_no_error(error);
376         g_assert(exp_sdt.aml);
377         if (!exp_sdt.aml_len) {
378             fprintf(stderr, "Warning! zero length expected file '%s'\n",
379                     aml_file);
380         }
381 
382         g_array_append_val(exp_tables, exp_sdt);
383     }
384 
385     return exp_tables;
386 }
387 
388 static bool test_acpi_find_diff_allowed(AcpiSdtTable *sdt)
389 {
390     const gchar *allowed_diff_file[] = {
391 #include "bios-tables-test-allowed-diff.h"
392         NULL
393     };
394     const gchar **f;
395 
396     for (f = allowed_diff_file; *f; ++f) {
397         if (!g_strcmp0(sdt->aml_file, *f)) {
398             return true;
399         }
400     }
401     return false;
402 }
403 
404 /* test the list of tables in @data->tables against reference tables */
405 static void test_acpi_asl(test_data *data)
406 {
407     int i;
408     AcpiSdtTable *sdt, *exp_sdt;
409     test_data exp_data;
410     gboolean exp_err, err, all_tables_match = true;
411 
412     memset(&exp_data, 0, sizeof(exp_data));
413     exp_data.tables = load_expected_aml(data);
414     dump_aml_files(data, false);
415     for (i = 0; i < data->tables->len; ++i) {
416         GString *asl, *exp_asl;
417 
418         sdt = &g_array_index(data->tables, AcpiSdtTable, i);
419         exp_sdt = &g_array_index(exp_data.tables, AcpiSdtTable, i);
420 
421         if (sdt->aml_len == exp_sdt->aml_len &&
422             !memcmp(sdt->aml, exp_sdt->aml, sdt->aml_len)) {
423             /* Identical table binaries: no need to disassemble. */
424             continue;
425         }
426 
427         fprintf(stderr,
428                 "acpi-test: Warning! %.4s binary file mismatch. "
429                 "Actual [aml:%s], Expected [aml:%s].\n"
430                 "See source file tests/qtest/bios-tables-test.c "
431                 "for instructions on how to update expected files.\n",
432                 exp_sdt->aml, sdt->aml_file, exp_sdt->aml_file);
433 
434         all_tables_match = all_tables_match &&
435             test_acpi_find_diff_allowed(exp_sdt);
436 
437         /*
438          *  don't try to decompile if IASL isn't present, in this case user
439          * will just 'get binary file mismatch' warnings and test failure
440          */
441         if (!iasl) {
442             continue;
443         }
444 
445         err = load_asl(data->tables, sdt);
446         asl = normalize_asl(sdt->asl);
447 
448         exp_err = load_asl(exp_data.tables, exp_sdt);
449         exp_asl = normalize_asl(exp_sdt->asl);
450 
451         /* TODO: check for warnings */
452         g_assert(!err || exp_err);
453 
454         if (g_strcmp0(asl->str, exp_asl->str)) {
455             sdt->tmp_files_retain = true;
456             if (exp_err) {
457                 fprintf(stderr,
458                         "Warning! iasl couldn't parse the expected aml\n");
459             } else {
460                 exp_sdt->tmp_files_retain = true;
461                 fprintf(stderr,
462                         "acpi-test: Warning! %.4s mismatch. "
463                         "Actual [asl:%s, aml:%s], Expected [asl:%s, aml:%s].\n",
464                         exp_sdt->aml, sdt->asl_file, sdt->aml_file,
465                         exp_sdt->asl_file, exp_sdt->aml_file);
466                 if (getenv("V")) {
467                     const char *diff_cmd = getenv("DIFF");
468                     if (diff_cmd) {
469                         int ret G_GNUC_UNUSED;
470                         char *diff = g_strdup_printf("%s %s %s", diff_cmd,
471                             exp_sdt->asl_file, sdt->asl_file);
472                         ret = system(diff) ;
473                         g_free(diff);
474                     } else {
475                         fprintf(stderr, "acpi-test: Warning. not showing "
476                             "difference since no diff utility is specified. "
477                             "Set 'DIFF' environment variable to a preferred "
478                             "diff utility and run 'make V=1 check' again to "
479                             "see ASL difference.");
480                     }
481                 }
482             }
483         }
484         g_string_free(asl, true);
485         g_string_free(exp_asl, true);
486     }
487     if (!iasl && !all_tables_match) {
488         fprintf(stderr, "to see ASL diff between mismatched files install IASL,"
489                 " rebuild QEMU from scratch and re-run tests with V=1"
490                 " environment variable set");
491     }
492     g_assert(all_tables_match);
493 
494     free_test_data(&exp_data);
495 }
496 
497 static bool smbios_ep_table_ok(test_data *data)
498 {
499     struct smbios_21_entry_point *ep_table = &data->smbios_ep_table;
500     uint32_t addr = data->smbios_ep_addr;
501 
502     qtest_memread(data->qts, addr, ep_table, sizeof(*ep_table));
503     if (memcmp(ep_table->anchor_string, "_SM_", 4)) {
504         return false;
505     }
506     if (memcmp(ep_table->intermediate_anchor_string, "_DMI_", 5)) {
507         return false;
508     }
509     if (ep_table->structure_table_length == 0) {
510         return false;
511     }
512     if (ep_table->number_of_structures == 0) {
513         return false;
514     }
515     if (acpi_calc_checksum((uint8_t *)ep_table, sizeof *ep_table) ||
516         acpi_calc_checksum((uint8_t *)ep_table + 0x10,
517                            sizeof *ep_table - 0x10)) {
518         return false;
519     }
520     return true;
521 }
522 
523 static void test_smbios_entry_point(test_data *data)
524 {
525     uint32_t off;
526 
527     /* find smbios entry point structure */
528     for (off = 0xf0000; off < 0x100000; off += 0x10) {
529         uint8_t sig[] = "_SM_";
530         int i;
531 
532         for (i = 0; i < sizeof sig - 1; ++i) {
533             sig[i] = qtest_readb(data->qts, off + i);
534         }
535 
536         if (!memcmp(sig, "_SM_", sizeof sig)) {
537             /* signature match, but is this a valid entry point? */
538             data->smbios_ep_addr = off;
539             if (smbios_ep_table_ok(data)) {
540                 break;
541             }
542         }
543     }
544 
545     g_assert_cmphex(off, <, 0x100000);
546 }
547 
548 static inline bool smbios_single_instance(uint8_t type)
549 {
550     switch (type) {
551     case 0:
552     case 1:
553     case 2:
554     case 3:
555     case 16:
556     case 32:
557     case 127:
558         return true;
559     default:
560         return false;
561     }
562 }
563 
564 static void test_smbios_structs(test_data *data)
565 {
566     DECLARE_BITMAP(struct_bitmap, SMBIOS_MAX_TYPE+1) = { 0 };
567     struct smbios_21_entry_point *ep_table = &data->smbios_ep_table;
568     uint32_t addr = le32_to_cpu(ep_table->structure_table_address);
569     int i, len, max_len = 0;
570     uint8_t type, prv, crt;
571 
572     /* walk the smbios tables */
573     for (i = 0; i < le16_to_cpu(ep_table->number_of_structures); i++) {
574 
575         /* grab type and formatted area length from struct header */
576         type = qtest_readb(data->qts, addr);
577         g_assert_cmpuint(type, <=, SMBIOS_MAX_TYPE);
578         len = qtest_readb(data->qts, addr + 1);
579 
580         /* single-instance structs must not have been encountered before */
581         if (smbios_single_instance(type)) {
582             g_assert(!test_bit(type, struct_bitmap));
583         }
584         set_bit(type, struct_bitmap);
585 
586         /* seek to end of unformatted string area of this struct ("\0\0") */
587         prv = crt = 1;
588         while (prv || crt) {
589             prv = crt;
590             crt = qtest_readb(data->qts, addr + len);
591             len++;
592         }
593 
594         /* keep track of max. struct size */
595         if (max_len < len) {
596             max_len = len;
597             g_assert_cmpuint(max_len, <=, ep_table->max_structure_size);
598         }
599 
600         /* start of next structure */
601         addr += len;
602     }
603 
604     /* total table length and max struct size must match entry point values */
605     g_assert_cmpuint(le16_to_cpu(ep_table->structure_table_length), ==,
606                      addr - le32_to_cpu(ep_table->structure_table_address));
607     g_assert_cmpuint(le16_to_cpu(ep_table->max_structure_size), ==, max_len);
608 
609     /* required struct types must all be present */
610     for (i = 0; i < data->required_struct_types_len; i++) {
611         g_assert(test_bit(data->required_struct_types[i], struct_bitmap));
612     }
613 }
614 
615 static void test_acpi_one(const char *params, test_data *data)
616 {
617     char *args;
618     bool use_uefi = data->uefi_fl1 && data->uefi_fl2;
619 
620     if (use_uefi) {
621         /*
622          * TODO: convert '-drive if=pflash' to new syntax (see e33763be7cd3)
623          * when arm/virt boad starts to support it.
624          */
625         args = g_strdup_printf("-machine %s %s -accel tcg -nodefaults -nographic "
626             "-drive if=pflash,format=raw,file=%s,readonly "
627             "-drive if=pflash,format=raw,file=%s,snapshot=on -cdrom %s %s",
628             data->machine, data->tcg_only ? "" : "-accel kvm",
629             data->uefi_fl1, data->uefi_fl2, data->cd, params ? params : "");
630 
631     } else {
632         /* Disable kernel irqchip to be able to override apic irq0. */
633         args = g_strdup_printf("-machine %s,kernel-irqchip=off %s -accel tcg "
634             "-net none -display none %s "
635             "-drive id=hd0,if=none,file=%s,format=raw "
636             "-device ide-hd,drive=hd0 ",
637              data->machine, data->tcg_only ? "" : "-accel kvm",
638              params ? params : "", disk);
639     }
640 
641     data->qts = qtest_init(args);
642 
643     if (use_uefi) {
644         g_assert(data->scan_len);
645         data->rsdp_addr = acpi_find_rsdp_address_uefi(data->qts,
646             data->ram_start, data->scan_len);
647     } else {
648         boot_sector_test(data->qts);
649         data->rsdp_addr = acpi_find_rsdp_address(data->qts);
650         g_assert_cmphex(data->rsdp_addr, <, 0x100000);
651     }
652 
653     data->tables = g_array_new(false, true, sizeof(AcpiSdtTable));
654     test_acpi_rsdp_table(data);
655     test_acpi_rxsdt_table(data);
656     test_acpi_fadt_table(data);
657 
658     if (getenv(ACPI_REBUILD_EXPECTED_AML)) {
659         dump_aml_files(data, true);
660     } else {
661         test_acpi_asl(data);
662     }
663 
664     /*
665      * TODO: make SMBIOS tests work with UEFI firmware,
666      * Bug on uefi-test-tools to provide entry point:
667      * https://bugs.launchpad.net/qemu/+bug/1821884
668      */
669     if (!use_uefi) {
670         test_smbios_entry_point(data);
671         test_smbios_structs(data);
672     }
673 
674     qtest_quit(data->qts);
675     g_free(args);
676 }
677 
678 static uint8_t base_required_struct_types[] = {
679     0, 1, 3, 4, 16, 17, 19, 32, 127
680 };
681 
682 static void test_acpi_piix4_tcg(void)
683 {
684     test_data data;
685 
686     /* Supplying -machine accel argument overrides the default (qtest).
687      * This is to make guest actually run.
688      */
689     memset(&data, 0, sizeof(data));
690     data.machine = MACHINE_PC;
691     data.required_struct_types = base_required_struct_types;
692     data.required_struct_types_len = ARRAY_SIZE(base_required_struct_types);
693     test_acpi_one(NULL, &data);
694     free_test_data(&data);
695 }
696 
697 static void test_acpi_piix4_tcg_bridge(void)
698 {
699     test_data data;
700 
701     memset(&data, 0, sizeof(data));
702     data.machine = MACHINE_PC;
703     data.variant = ".bridge";
704     data.required_struct_types = base_required_struct_types;
705     data.required_struct_types_len = ARRAY_SIZE(base_required_struct_types);
706     test_acpi_one("-device pci-bridge,chassis_nr=1", &data);
707     free_test_data(&data);
708 }
709 
710 static void test_acpi_q35_tcg(void)
711 {
712     test_data data;
713 
714     memset(&data, 0, sizeof(data));
715     data.machine = MACHINE_Q35;
716     data.required_struct_types = base_required_struct_types;
717     data.required_struct_types_len = ARRAY_SIZE(base_required_struct_types);
718     test_acpi_one(NULL, &data);
719     free_test_data(&data);
720 }
721 
722 static void test_acpi_q35_tcg_bridge(void)
723 {
724     test_data data;
725 
726     memset(&data, 0, sizeof(data));
727     data.machine = MACHINE_Q35;
728     data.variant = ".bridge";
729     data.required_struct_types = base_required_struct_types;
730     data.required_struct_types_len = ARRAY_SIZE(base_required_struct_types);
731     test_acpi_one("-device pci-bridge,chassis_nr=1",
732                   &data);
733     free_test_data(&data);
734 }
735 
736 static void test_acpi_q35_tcg_mmio64(void)
737 {
738     test_data data = {
739         .machine = MACHINE_Q35,
740         .variant = ".mmio64",
741         .required_struct_types = base_required_struct_types,
742         .required_struct_types_len = ARRAY_SIZE(base_required_struct_types)
743     };
744 
745     test_acpi_one("-m 128M,slots=1,maxmem=2G "
746                   "-object memory-backend-ram,id=ram0,size=128M "
747                   "-numa node,memdev=ram0 "
748                   "-device pci-testdev,membar=2G",
749                   &data);
750     free_test_data(&data);
751 }
752 
753 static void test_acpi_piix4_tcg_cphp(void)
754 {
755     test_data data;
756 
757     memset(&data, 0, sizeof(data));
758     data.machine = MACHINE_PC;
759     data.variant = ".cphp";
760     test_acpi_one("-smp 2,cores=3,sockets=2,maxcpus=6"
761                   " -object memory-backend-ram,id=ram0,size=64M"
762                   " -object memory-backend-ram,id=ram1,size=64M"
763                   " -numa node,memdev=ram0 -numa node,memdev=ram1"
764                   " -numa dist,src=0,dst=1,val=21",
765                   &data);
766     free_test_data(&data);
767 }
768 
769 static void test_acpi_q35_tcg_cphp(void)
770 {
771     test_data data;
772 
773     memset(&data, 0, sizeof(data));
774     data.machine = MACHINE_Q35;
775     data.variant = ".cphp";
776     test_acpi_one(" -smp 2,cores=3,sockets=2,maxcpus=6"
777                   " -object memory-backend-ram,id=ram0,size=64M"
778                   " -object memory-backend-ram,id=ram1,size=64M"
779                   " -numa node,memdev=ram0 -numa node,memdev=ram1"
780                   " -numa dist,src=0,dst=1,val=21",
781                   &data);
782     free_test_data(&data);
783 }
784 
785 static uint8_t ipmi_required_struct_types[] = {
786     0, 1, 3, 4, 16, 17, 19, 32, 38, 127
787 };
788 
789 static void test_acpi_q35_tcg_ipmi(void)
790 {
791     test_data data;
792 
793     memset(&data, 0, sizeof(data));
794     data.machine = MACHINE_Q35;
795     data.variant = ".ipmibt";
796     data.required_struct_types = ipmi_required_struct_types;
797     data.required_struct_types_len = ARRAY_SIZE(ipmi_required_struct_types);
798     test_acpi_one("-device ipmi-bmc-sim,id=bmc0"
799                   " -device isa-ipmi-bt,bmc=bmc0",
800                   &data);
801     free_test_data(&data);
802 }
803 
804 static void test_acpi_piix4_tcg_ipmi(void)
805 {
806     test_data data;
807 
808     /* Supplying -machine accel argument overrides the default (qtest).
809      * This is to make guest actually run.
810      */
811     memset(&data, 0, sizeof(data));
812     data.machine = MACHINE_PC;
813     data.variant = ".ipmikcs";
814     data.required_struct_types = ipmi_required_struct_types;
815     data.required_struct_types_len = ARRAY_SIZE(ipmi_required_struct_types);
816     test_acpi_one("-device ipmi-bmc-sim,id=bmc0"
817                   " -device isa-ipmi-kcs,irq=0,bmc=bmc0",
818                   &data);
819     free_test_data(&data);
820 }
821 
822 static void test_acpi_q35_tcg_memhp(void)
823 {
824     test_data data;
825 
826     memset(&data, 0, sizeof(data));
827     data.machine = MACHINE_Q35;
828     data.variant = ".memhp";
829     test_acpi_one(" -m 128,slots=3,maxmem=1G"
830                   " -object memory-backend-ram,id=ram0,size=64M"
831                   " -object memory-backend-ram,id=ram1,size=64M"
832                   " -numa node,memdev=ram0 -numa node,memdev=ram1"
833                   " -numa dist,src=0,dst=1,val=21",
834                   &data);
835     free_test_data(&data);
836 }
837 
838 static void test_acpi_piix4_tcg_memhp(void)
839 {
840     test_data data;
841 
842     memset(&data, 0, sizeof(data));
843     data.machine = MACHINE_PC;
844     data.variant = ".memhp";
845     test_acpi_one(" -m 128,slots=3,maxmem=1G"
846                   " -object memory-backend-ram,id=ram0,size=64M"
847                   " -object memory-backend-ram,id=ram1,size=64M"
848                   " -numa node,memdev=ram0 -numa node,memdev=ram1"
849                   " -numa dist,src=0,dst=1,val=21",
850                   &data);
851     free_test_data(&data);
852 }
853 
854 static void test_acpi_q35_tcg_numamem(void)
855 {
856     test_data data;
857 
858     memset(&data, 0, sizeof(data));
859     data.machine = MACHINE_Q35;
860     data.variant = ".numamem";
861     test_acpi_one(" -object memory-backend-ram,id=ram0,size=128M"
862                   " -numa node -numa node,memdev=ram0", &data);
863     free_test_data(&data);
864 }
865 
866 static void test_acpi_piix4_tcg_numamem(void)
867 {
868     test_data data;
869 
870     memset(&data, 0, sizeof(data));
871     data.machine = MACHINE_PC;
872     data.variant = ".numamem";
873     test_acpi_one(" -object memory-backend-ram,id=ram0,size=128M"
874                   " -numa node -numa node,memdev=ram0", &data);
875     free_test_data(&data);
876 }
877 
878 static void test_acpi_tcg_dimm_pxm(const char *machine)
879 {
880     test_data data;
881 
882     memset(&data, 0, sizeof(data));
883     data.machine = machine;
884     data.variant = ".dimmpxm";
885     test_acpi_one(" -machine nvdimm=on,nvdimm-persistence=cpu"
886                   " -smp 4,sockets=4"
887                   " -m 128M,slots=3,maxmem=1G"
888                   " -object memory-backend-ram,id=ram0,size=32M"
889                   " -object memory-backend-ram,id=ram1,size=32M"
890                   " -object memory-backend-ram,id=ram2,size=32M"
891                   " -object memory-backend-ram,id=ram3,size=32M"
892                   " -numa node,memdev=ram0,nodeid=0"
893                   " -numa node,memdev=ram1,nodeid=1"
894                   " -numa node,memdev=ram2,nodeid=2"
895                   " -numa node,memdev=ram3,nodeid=3"
896                   " -numa cpu,node-id=0,socket-id=0"
897                   " -numa cpu,node-id=1,socket-id=1"
898                   " -numa cpu,node-id=2,socket-id=2"
899                   " -numa cpu,node-id=3,socket-id=3"
900                   " -object memory-backend-ram,id=ram4,size=128M"
901                   " -object memory-backend-ram,id=nvm0,size=128M"
902                   " -device pc-dimm,id=dimm0,memdev=ram4,node=1"
903                   " -device nvdimm,id=dimm1,memdev=nvm0,node=2",
904                   &data);
905     free_test_data(&data);
906 }
907 
908 static void test_acpi_q35_tcg_dimm_pxm(void)
909 {
910     test_acpi_tcg_dimm_pxm(MACHINE_Q35);
911 }
912 
913 static void test_acpi_piix4_tcg_dimm_pxm(void)
914 {
915     test_acpi_tcg_dimm_pxm(MACHINE_PC);
916 }
917 
918 static void test_acpi_virt_tcg_memhp(void)
919 {
920     test_data data = {
921         .machine = "virt",
922         .tcg_only = true,
923         .uefi_fl1 = "pc-bios/edk2-aarch64-code.fd",
924         .uefi_fl2 = "pc-bios/edk2-arm-vars.fd",
925         .cd = "tests/data/uefi-boot-images/bios-tables-test.aarch64.iso.qcow2",
926         .ram_start = 0x40000000ULL,
927         .scan_len = 256ULL * 1024 * 1024,
928     };
929 
930     data.variant = ".memhp";
931     test_acpi_one(" -cpu cortex-a57"
932                   " -m 256M,slots=3,maxmem=1G"
933                   " -object memory-backend-ram,id=ram0,size=128M"
934                   " -object memory-backend-ram,id=ram1,size=128M"
935                   " -numa node,memdev=ram0 -numa node,memdev=ram1"
936                   " -numa dist,src=0,dst=1,val=21",
937                   &data);
938 
939     free_test_data(&data);
940 
941 }
942 
943 static void test_acpi_virt_tcg_numamem(void)
944 {
945     test_data data = {
946         .machine = "virt",
947         .tcg_only = true,
948         .uefi_fl1 = "pc-bios/edk2-aarch64-code.fd",
949         .uefi_fl2 = "pc-bios/edk2-arm-vars.fd",
950         .cd = "tests/data/uefi-boot-images/bios-tables-test.aarch64.iso.qcow2",
951         .ram_start = 0x40000000ULL,
952         .scan_len = 128ULL * 1024 * 1024,
953     };
954 
955     data.variant = ".numamem";
956     test_acpi_one(" -cpu cortex-a57"
957                   " -object memory-backend-ram,id=ram0,size=128M"
958                   " -numa node,memdev=ram0",
959                   &data);
960 
961     free_test_data(&data);
962 
963 }
964 
965 static void test_acpi_tcg_acpi_hmat(const char *machine)
966 {
967     test_data data;
968 
969     memset(&data, 0, sizeof(data));
970     data.machine = machine;
971     data.variant = ".acpihmat";
972     test_acpi_one(" -machine hmat=on"
973                   " -smp 2,sockets=2"
974                   " -m 128M,slots=2,maxmem=1G"
975                   " -object memory-backend-ram,size=64M,id=m0"
976                   " -object memory-backend-ram,size=64M,id=m1"
977                   " -numa node,nodeid=0,memdev=m0"
978                   " -numa node,nodeid=1,memdev=m1,initiator=0"
979                   " -numa cpu,node-id=0,socket-id=0"
980                   " -numa cpu,node-id=0,socket-id=1"
981                   " -numa hmat-lb,initiator=0,target=0,hierarchy=memory,"
982                   "data-type=access-latency,latency=1"
983                   " -numa hmat-lb,initiator=0,target=0,hierarchy=memory,"
984                   "data-type=access-bandwidth,bandwidth=65534M"
985                   " -numa hmat-lb,initiator=0,target=1,hierarchy=memory,"
986                   "data-type=access-latency,latency=65534"
987                   " -numa hmat-lb,initiator=0,target=1,hierarchy=memory,"
988                   "data-type=access-bandwidth,bandwidth=32767M"
989                   " -numa hmat-cache,node-id=0,size=10K,level=1,"
990                   "associativity=direct,policy=write-back,line=8"
991                   " -numa hmat-cache,node-id=1,size=10K,level=1,"
992                   "associativity=direct,policy=write-back,line=8",
993                   &data);
994     free_test_data(&data);
995 }
996 
997 static void test_acpi_q35_tcg_acpi_hmat(void)
998 {
999     test_acpi_tcg_acpi_hmat(MACHINE_Q35);
1000 }
1001 
1002 static void test_acpi_piix4_tcg_acpi_hmat(void)
1003 {
1004     test_acpi_tcg_acpi_hmat(MACHINE_PC);
1005 }
1006 
1007 static void test_acpi_virt_tcg(void)
1008 {
1009     test_data data = {
1010         .machine = "virt",
1011         .tcg_only = true,
1012         .uefi_fl1 = "pc-bios/edk2-aarch64-code.fd",
1013         .uefi_fl2 = "pc-bios/edk2-arm-vars.fd",
1014         .cd = "tests/data/uefi-boot-images/bios-tables-test.aarch64.iso.qcow2",
1015         .ram_start = 0x40000000ULL,
1016         .scan_len = 128ULL * 1024 * 1024,
1017     };
1018 
1019     test_acpi_one("-cpu cortex-a57", &data);
1020     free_test_data(&data);
1021 }
1022 
1023 int main(int argc, char *argv[])
1024 {
1025     const char *arch = qtest_get_arch();
1026     int ret;
1027 
1028     g_test_init(&argc, &argv, NULL);
1029 
1030     if (strcmp(arch, "i386") == 0 || strcmp(arch, "x86_64") == 0) {
1031         ret = boot_sector_init(disk);
1032         if (ret) {
1033             return ret;
1034         }
1035 
1036         qtest_add_func("acpi/piix4", test_acpi_piix4_tcg);
1037         qtest_add_func("acpi/piix4/bridge", test_acpi_piix4_tcg_bridge);
1038         qtest_add_func("acpi/q35", test_acpi_q35_tcg);
1039         qtest_add_func("acpi/q35/bridge", test_acpi_q35_tcg_bridge);
1040         qtest_add_func("acpi/q35/mmio64", test_acpi_q35_tcg_mmio64);
1041         qtest_add_func("acpi/piix4/ipmi", test_acpi_piix4_tcg_ipmi);
1042         qtest_add_func("acpi/q35/ipmi", test_acpi_q35_tcg_ipmi);
1043         qtest_add_func("acpi/piix4/cpuhp", test_acpi_piix4_tcg_cphp);
1044         qtest_add_func("acpi/q35/cpuhp", test_acpi_q35_tcg_cphp);
1045         qtest_add_func("acpi/piix4/memhp", test_acpi_piix4_tcg_memhp);
1046         qtest_add_func("acpi/q35/memhp", test_acpi_q35_tcg_memhp);
1047         qtest_add_func("acpi/piix4/numamem", test_acpi_piix4_tcg_numamem);
1048         qtest_add_func("acpi/q35/numamem", test_acpi_q35_tcg_numamem);
1049         qtest_add_func("acpi/piix4/dimmpxm", test_acpi_piix4_tcg_dimm_pxm);
1050         qtest_add_func("acpi/q35/dimmpxm", test_acpi_q35_tcg_dimm_pxm);
1051         qtest_add_func("acpi/piix4/acpihmat", test_acpi_piix4_tcg_acpi_hmat);
1052         qtest_add_func("acpi/q35/acpihmat", test_acpi_q35_tcg_acpi_hmat);
1053     } else if (strcmp(arch, "aarch64") == 0) {
1054         qtest_add_func("acpi/virt", test_acpi_virt_tcg);
1055         qtest_add_func("acpi/virt/numamem", test_acpi_virt_tcg_numamem);
1056         qtest_add_func("acpi/virt/memhp", test_acpi_virt_tcg_memhp);
1057     }
1058     ret = g_test_run();
1059     boot_sector_cleanup(disk);
1060     return ret;
1061 }
1062