2 * Boot order test cases.
4 * Copyright (c) 2013 Red Hat Inc.
7 * Michael S. Tsirkin <mst@redhat.com>,
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.
16 #include <glib/gstdio.h>
17 #include "qemu-common.h"
19 #include "qemu/compiler.h"
20 #include "hw/i386/acpi-defs.h"
22 #define MACHINE_PC "pc"
23 #define MACHINE_Q35 "q35"
25 #define ACPI_REBUILD_EXPECTED_AML "TEST_ACPI_REBUILD_AML"
27 /* DSDT and SSDTs format */
29 AcpiTableHeader header
;
30 gchar
*aml
; /* aml bytecode from guest */
33 gchar
*asl
; /* asl code generated from aml */
36 bool tmp_files_retain
; /* do not delete the temp asl/aml */
37 } QEMU_PACKED AcpiSdtTable
;
42 AcpiRsdpDescriptor rsdp_table
;
43 AcpiRsdtDescriptorRev1 rsdt_table
;
44 AcpiFadtDescriptorRev1 fadt_table
;
45 AcpiFacsDescriptorRev1 facs_table
;
46 uint32_t *rsdt_tables_addr
;
51 #define LOW(x) ((x) & 0xff)
52 #define HIGH(x) ((x) >> 8)
54 #define SIGNATURE 0xdead
55 #define SIGNATURE_OFFSET 0x10
56 #define BOOT_SECTOR_ADDRESS 0x7c00
58 #define ACPI_READ_FIELD(field, addr) \
60 switch (sizeof(field)) { \
62 field = readb(addr); \
65 field = readw(addr); \
68 field = readl(addr); \
71 field = readq(addr); \
76 addr += sizeof(field); \
79 #define ACPI_READ_ARRAY_PTR(arr, length, addr) \
82 for (idx = 0; idx < length; ++idx) { \
83 ACPI_READ_FIELD(arr[idx], addr); \
87 #define ACPI_READ_ARRAY(arr, addr) \
88 ACPI_READ_ARRAY_PTR(arr, sizeof(arr)/sizeof(arr[0]), addr)
90 #define ACPI_READ_TABLE_HEADER(table, addr) \
92 ACPI_READ_FIELD((table)->signature, addr); \
93 ACPI_READ_FIELD((table)->length, addr); \
94 ACPI_READ_FIELD((table)->revision, addr); \
95 ACPI_READ_FIELD((table)->checksum, addr); \
96 ACPI_READ_ARRAY((table)->oem_id, addr); \
97 ACPI_READ_ARRAY((table)->oem_table_id, addr); \
98 ACPI_READ_FIELD((table)->oem_revision, addr); \
99 ACPI_READ_ARRAY((table)->asl_compiler_id, addr); \
100 ACPI_READ_FIELD((table)->asl_compiler_revision, addr); \
103 #define ACPI_ASSERT_CMP(actual, expected) do { \
104 uint32_t ACPI_ASSERT_CMP_le = cpu_to_le32(actual); \
105 char ACPI_ASSERT_CMP_str[5] = {}; \
106 memcpy(ACPI_ASSERT_CMP_str, &ACPI_ASSERT_CMP_le, 4); \
107 g_assert_cmpstr(ACPI_ASSERT_CMP_str, ==, expected); \
110 #define ACPI_ASSERT_CMP64(actual, expected) do { \
111 uint64_t ACPI_ASSERT_CMP_le = cpu_to_le64(actual); \
112 char ACPI_ASSERT_CMP_str[9] = {}; \
113 memcpy(ACPI_ASSERT_CMP_str, &ACPI_ASSERT_CMP_le, 8); \
114 g_assert_cmpstr(ACPI_ASSERT_CMP_str, ==, expected); \
117 /* Boot sector code: write SIGNATURE into memory,
119 * Q35 machine requires a minimum 0x7e000 bytes disk.
122 static uint8_t boot_sector
[0x7e000] = {
123 /* 7c00: mov $0xdead,%ax */
125 [0x01] = LOW(SIGNATURE
),
126 [0x02] = HIGH(SIGNATURE
),
127 /* 7c03: mov %ax,0x7c10 */
129 [0x04] = LOW(BOOT_SECTOR_ADDRESS
+ SIGNATURE_OFFSET
),
130 [0x05] = HIGH(BOOT_SECTOR_ADDRESS
+ SIGNATURE_OFFSET
),
135 /* 7c08: jmp 0x7c07=0x7c0a-3 */
138 /* We mov 0xdead here: set value to make debugging easier */
139 [SIGNATURE_OFFSET
] = LOW(0xface),
140 [SIGNATURE_OFFSET
+ 1] = HIGH(0xface),
141 /* End of boot sector marker */
146 static const char *disk
= "tests/acpi-test-disk.raw";
147 static const char *data_dir
= "tests/acpi-test-data";
149 static const char *iasl
= stringify(CONFIG_IASL
);
151 static const char *iasl
;
154 static void free_test_data(test_data
*data
)
159 if (data
->rsdt_tables_addr
) {
160 g_free(data
->rsdt_tables_addr
);
163 for (i
= 0; i
< data
->tables
->len
; ++i
) {
164 temp
= &g_array_index(data
->tables
, AcpiSdtTable
, i
);
168 if (temp
->aml_file
) {
169 if (!temp
->tmp_files_retain
&&
170 g_strstr_len(temp
->aml_file
, -1, "aml-")) {
171 unlink(temp
->aml_file
);
173 g_free(temp
->aml_file
);
178 if (temp
->asl_file
) {
179 if (!temp
->tmp_files_retain
) {
180 unlink(temp
->asl_file
);
182 g_free(temp
->asl_file
);
186 g_array_free(data
->tables
, false);
189 static uint8_t acpi_checksum(const uint8_t *data
, int len
)
194 for (i
= 0; i
< len
; i
++) {
201 static void test_acpi_rsdp_address(test_data
*data
)
205 /* OK, now find RSDP */
206 for (off
= 0xf0000; off
< 0x100000; off
+= 0x10) {
207 uint8_t sig
[] = "RSD PTR ";
210 for (i
= 0; i
< sizeof sig
- 1; ++i
) {
211 sig
[i
] = readb(off
+ i
);
214 if (!memcmp(sig
, "RSD PTR ", sizeof sig
)) {
219 g_assert_cmphex(off
, <, 0x100000);
220 data
->rsdp_addr
= off
;
223 static void test_acpi_rsdp_table(test_data
*data
)
225 AcpiRsdpDescriptor
*rsdp_table
= &data
->rsdp_table
;
226 uint32_t addr
= data
->rsdp_addr
;
228 ACPI_READ_FIELD(rsdp_table
->signature
, addr
);
229 ACPI_ASSERT_CMP64(rsdp_table
->signature
, "RSD PTR ");
231 ACPI_READ_FIELD(rsdp_table
->checksum
, addr
);
232 ACPI_READ_ARRAY(rsdp_table
->oem_id
, addr
);
233 ACPI_READ_FIELD(rsdp_table
->revision
, addr
);
234 ACPI_READ_FIELD(rsdp_table
->rsdt_physical_address
, addr
);
235 ACPI_READ_FIELD(rsdp_table
->length
, addr
);
237 /* rsdp checksum is not for the whole table, but for the first 20 bytes */
238 g_assert(!acpi_checksum((uint8_t *)rsdp_table
, 20));
241 static void test_acpi_rsdt_table(test_data
*data
)
243 AcpiRsdtDescriptorRev1
*rsdt_table
= &data
->rsdt_table
;
244 uint32_t addr
= data
->rsdp_table
.rsdt_physical_address
;
249 /* read the header */
250 ACPI_READ_TABLE_HEADER(rsdt_table
, addr
);
251 ACPI_ASSERT_CMP(rsdt_table
->signature
, "RSDT");
253 /* compute the table entries in rsdt */
254 tables_nr
= (rsdt_table
->length
- sizeof(AcpiRsdtDescriptorRev1
)) /
256 g_assert_cmpint(tables_nr
, >, 0);
258 /* get the addresses of the tables pointed by rsdt */
259 tables
= g_new0(uint32_t, tables_nr
);
260 ACPI_READ_ARRAY_PTR(tables
, tables_nr
, addr
);
262 checksum
= acpi_checksum((uint8_t *)rsdt_table
, rsdt_table
->length
) +
263 acpi_checksum((uint8_t *)tables
, tables_nr
* sizeof(uint32_t));
266 /* SSDT tables after FADT */
267 data
->rsdt_tables_addr
= tables
;
268 data
->rsdt_tables_nr
= tables_nr
;
271 static void test_acpi_fadt_table(test_data
*data
)
273 AcpiFadtDescriptorRev1
*fadt_table
= &data
->fadt_table
;
276 /* FADT table comes first */
277 addr
= data
->rsdt_tables_addr
[0];
278 ACPI_READ_TABLE_HEADER(fadt_table
, addr
);
280 ACPI_READ_FIELD(fadt_table
->firmware_ctrl
, addr
);
281 ACPI_READ_FIELD(fadt_table
->dsdt
, addr
);
282 ACPI_READ_FIELD(fadt_table
->model
, addr
);
283 ACPI_READ_FIELD(fadt_table
->reserved1
, addr
);
284 ACPI_READ_FIELD(fadt_table
->sci_int
, addr
);
285 ACPI_READ_FIELD(fadt_table
->smi_cmd
, addr
);
286 ACPI_READ_FIELD(fadt_table
->acpi_enable
, addr
);
287 ACPI_READ_FIELD(fadt_table
->acpi_disable
, addr
);
288 ACPI_READ_FIELD(fadt_table
->S4bios_req
, addr
);
289 ACPI_READ_FIELD(fadt_table
->reserved2
, addr
);
290 ACPI_READ_FIELD(fadt_table
->pm1a_evt_blk
, addr
);
291 ACPI_READ_FIELD(fadt_table
->pm1b_evt_blk
, addr
);
292 ACPI_READ_FIELD(fadt_table
->pm1a_cnt_blk
, addr
);
293 ACPI_READ_FIELD(fadt_table
->pm1b_cnt_blk
, addr
);
294 ACPI_READ_FIELD(fadt_table
->pm2_cnt_blk
, addr
);
295 ACPI_READ_FIELD(fadt_table
->pm_tmr_blk
, addr
);
296 ACPI_READ_FIELD(fadt_table
->gpe0_blk
, addr
);
297 ACPI_READ_FIELD(fadt_table
->gpe1_blk
, addr
);
298 ACPI_READ_FIELD(fadt_table
->pm1_evt_len
, addr
);
299 ACPI_READ_FIELD(fadt_table
->pm1_cnt_len
, addr
);
300 ACPI_READ_FIELD(fadt_table
->pm2_cnt_len
, addr
);
301 ACPI_READ_FIELD(fadt_table
->pm_tmr_len
, addr
);
302 ACPI_READ_FIELD(fadt_table
->gpe0_blk_len
, addr
);
303 ACPI_READ_FIELD(fadt_table
->gpe1_blk_len
, addr
);
304 ACPI_READ_FIELD(fadt_table
->gpe1_base
, addr
);
305 ACPI_READ_FIELD(fadt_table
->reserved3
, addr
);
306 ACPI_READ_FIELD(fadt_table
->plvl2_lat
, addr
);
307 ACPI_READ_FIELD(fadt_table
->plvl3_lat
, addr
);
308 ACPI_READ_FIELD(fadt_table
->flush_size
, addr
);
309 ACPI_READ_FIELD(fadt_table
->flush_stride
, addr
);
310 ACPI_READ_FIELD(fadt_table
->duty_offset
, addr
);
311 ACPI_READ_FIELD(fadt_table
->duty_width
, addr
);
312 ACPI_READ_FIELD(fadt_table
->day_alrm
, addr
);
313 ACPI_READ_FIELD(fadt_table
->mon_alrm
, addr
);
314 ACPI_READ_FIELD(fadt_table
->century
, addr
);
315 ACPI_READ_FIELD(fadt_table
->reserved4
, addr
);
316 ACPI_READ_FIELD(fadt_table
->reserved4a
, addr
);
317 ACPI_READ_FIELD(fadt_table
->reserved4b
, addr
);
318 ACPI_READ_FIELD(fadt_table
->flags
, addr
);
320 ACPI_ASSERT_CMP(fadt_table
->signature
, "FACP");
321 g_assert(!acpi_checksum((uint8_t *)fadt_table
, fadt_table
->length
));
324 static void test_acpi_facs_table(test_data
*data
)
326 AcpiFacsDescriptorRev1
*facs_table
= &data
->facs_table
;
327 uint32_t addr
= data
->fadt_table
.firmware_ctrl
;
329 ACPI_READ_FIELD(facs_table
->signature
, addr
);
330 ACPI_READ_FIELD(facs_table
->length
, addr
);
331 ACPI_READ_FIELD(facs_table
->hardware_signature
, addr
);
332 ACPI_READ_FIELD(facs_table
->firmware_waking_vector
, addr
);
333 ACPI_READ_FIELD(facs_table
->global_lock
, addr
);
334 ACPI_READ_FIELD(facs_table
->flags
, addr
);
335 ACPI_READ_ARRAY(facs_table
->resverved3
, addr
);
337 ACPI_ASSERT_CMP(facs_table
->signature
, "FACS");
340 static void test_dst_table(AcpiSdtTable
*sdt_table
, uint32_t addr
)
344 ACPI_READ_TABLE_HEADER(&sdt_table
->header
, addr
);
346 sdt_table
->aml_len
= sdt_table
->header
.length
- sizeof(AcpiTableHeader
);
347 sdt_table
->aml
= g_malloc0(sdt_table
->aml_len
);
348 ACPI_READ_ARRAY_PTR(sdt_table
->aml
, sdt_table
->aml_len
, addr
);
350 checksum
= acpi_checksum((uint8_t *)sdt_table
, sizeof(AcpiTableHeader
)) +
351 acpi_checksum((uint8_t *)sdt_table
->aml
, sdt_table
->aml_len
);
355 static void test_acpi_dsdt_table(test_data
*data
)
357 AcpiSdtTable dsdt_table
;
358 uint32_t addr
= data
->fadt_table
.dsdt
;
360 memset(&dsdt_table
, 0, sizeof(dsdt_table
));
361 data
->tables
= g_array_new(false, true, sizeof(AcpiSdtTable
));
363 test_dst_table(&dsdt_table
, addr
);
364 ACPI_ASSERT_CMP(dsdt_table
.header
.signature
, "DSDT");
366 /* Place DSDT first */
367 g_array_append_val(data
->tables
, dsdt_table
);
370 static void test_acpi_tables(test_data
*data
)
372 int tables_nr
= data
->rsdt_tables_nr
- 1; /* fadt is first */
375 for (i
= 0; i
< tables_nr
; i
++) {
376 AcpiSdtTable ssdt_table
;
378 memset(&ssdt_table
, 0 , sizeof(ssdt_table
));
379 uint32_t addr
= data
->rsdt_tables_addr
[i
+ 1]; /* fadt is first */
380 test_dst_table(&ssdt_table
, addr
);
381 g_array_append_val(data
->tables
, ssdt_table
);
385 static void dump_aml_files(test_data
*data
, bool rebuild
)
388 GError
*error
= NULL
;
389 gchar
*aml_file
= NULL
;
394 for (i
= 0; i
< data
->tables
->len
; ++i
) {
395 sdt
= &g_array_index(data
->tables
, AcpiSdtTable
, i
);
399 uint32_t signature
= cpu_to_le32(sdt
->header
.signature
);
400 aml_file
= g_strdup_printf("%s/%s/%.4s", data_dir
, data
->machine
,
401 (gchar
*)&signature
);
402 fd
= g_open(aml_file
, O_WRONLY
|O_TRUNC
|O_CREAT
,
403 S_IRUSR
|S_IWUSR
|S_IRGRP
|S_IWGRP
|S_IROTH
);
405 fd
= g_file_open_tmp("aml-XXXXXX", &sdt
->aml_file
, &error
);
406 g_assert_no_error(error
);
410 ret
= qemu_write_full(fd
, sdt
, sizeof(AcpiTableHeader
));
411 g_assert(ret
== sizeof(AcpiTableHeader
));
412 ret
= qemu_write_full(fd
, sdt
->aml
, sdt
->aml_len
);
413 g_assert(ret
== sdt
->aml_len
);
423 static bool compare_signature(AcpiSdtTable
*sdt
, const char *signature
)
425 return !memcmp(&sdt
->header
.signature
, signature
, 4);
428 static bool load_asl(GArray
*sdts
, AcpiSdtTable
*sdt
)
431 GError
*error
= NULL
;
432 GString
*command_line
= g_string_new(iasl
);
434 gchar
*out
, *out_err
;
438 fd
= g_file_open_tmp("asl-XXXXXX.dsl", &sdt
->asl_file
, &error
);
439 g_assert_no_error(error
);
442 /* build command line */
443 g_string_append_printf(command_line
, " -p %s ", sdt
->asl_file
);
444 if (compare_signature(sdt
, "DSDT") ||
445 compare_signature(sdt
, "SSDT")) {
446 for (i
= 0; i
< sdts
->len
; ++i
) {
447 temp
= &g_array_index(sdts
, AcpiSdtTable
, i
);
448 if (compare_signature(temp
, "DSDT") ||
449 compare_signature(temp
, "SSDT")) {
450 g_string_append_printf(command_line
, "-e %s ", temp
->aml_file
);
454 g_string_append_printf(command_line
, "-d %s", sdt
->aml_file
);
456 /* pass 'out' and 'out_err' in order to be redirected */
457 ret
= g_spawn_command_line_sync(command_line
->str
, &out
, &out_err
, NULL
, &error
);
458 g_assert_no_error(error
);
460 ret
= g_file_get_contents(sdt
->asl_file
, (gchar
**)&sdt
->asl
,
461 &sdt
->asl_len
, &error
);
463 g_assert_no_error(error
);
464 ret
= (sdt
->asl_len
> 0);
469 g_string_free(command_line
, true);
474 #define COMMENT_END "*/"
475 #define DEF_BLOCK "DefinitionBlock ("
476 #define BLOCK_NAME_END ".aml"
478 static GString
*normalize_asl(gchar
*asl_code
)
480 GString
*asl
= g_string_new(asl_code
);
481 gchar
*comment
, *block_name
;
483 /* strip comments (different generation days) */
484 comment
= g_strstr_len(asl
->str
, asl
->len
, COMMENT_END
);
486 asl
= g_string_erase(asl
, 0, comment
+ sizeof(COMMENT_END
) - asl
->str
);
489 /* strip def block name (it has file path in it) */
490 if (g_str_has_prefix(asl
->str
, DEF_BLOCK
)) {
491 block_name
= g_strstr_len(asl
->str
, asl
->len
, BLOCK_NAME_END
);
492 g_assert(block_name
);
493 asl
= g_string_erase(asl
, 0,
494 block_name
+ sizeof(BLOCK_NAME_END
) - asl
->str
);
500 static GArray
*load_expected_aml(test_data
*data
)
505 GError
*error
= NULL
;
508 GArray
*exp_tables
= g_array_new(false, true, sizeof(AcpiSdtTable
));
509 for (i
= 0; i
< data
->tables
->len
; ++i
) {
510 AcpiSdtTable exp_sdt
;
513 sdt
= &g_array_index(data
->tables
, AcpiSdtTable
, i
);
515 memset(&exp_sdt
, 0, sizeof(exp_sdt
));
516 exp_sdt
.header
.signature
= sdt
->header
.signature
;
518 signature
= cpu_to_le32(sdt
->header
.signature
);
519 aml_file
= g_strdup_printf("%s/%s/%.4s", data_dir
, data
->machine
,
520 (gchar
*)&signature
);
521 exp_sdt
.aml_file
= aml_file
;
522 g_assert(g_file_test(aml_file
, G_FILE_TEST_EXISTS
));
523 ret
= g_file_get_contents(aml_file
, &exp_sdt
.aml
,
524 &exp_sdt
.aml_len
, &error
);
526 g_assert_no_error(error
);
527 g_assert(exp_sdt
.aml
);
528 g_assert(exp_sdt
.aml_len
);
530 g_array_append_val(exp_tables
, exp_sdt
);
536 static void test_acpi_asl(test_data
*data
)
539 AcpiSdtTable
*sdt
, *exp_sdt
;
541 gboolean exp_err
, err
;
543 memset(&exp_data
, 0, sizeof(exp_data
));
544 exp_data
.tables
= load_expected_aml(data
);
545 dump_aml_files(data
, false);
546 for (i
= 0; i
< data
->tables
->len
; ++i
) {
547 GString
*asl
, *exp_asl
;
549 sdt
= &g_array_index(data
->tables
, AcpiSdtTable
, i
);
550 exp_sdt
= &g_array_index(exp_data
.tables
, AcpiSdtTable
, i
);
552 err
= load_asl(data
->tables
, sdt
);
553 asl
= normalize_asl(sdt
->asl
);
555 exp_err
= load_asl(exp_data
.tables
, exp_sdt
);
556 exp_asl
= normalize_asl(exp_sdt
->asl
);
558 /* TODO: check for warnings */
559 g_assert(!err
|| exp_err
);
561 if (g_strcmp0(asl
->str
, exp_asl
->str
)) {
564 "Warning! iasl couldn't parse the expected aml\n");
566 uint32_t signature
= cpu_to_le32(exp_sdt
->header
.signature
);
567 sdt
->tmp_files_retain
= true;
568 exp_sdt
->tmp_files_retain
= true;
570 "acpi-test: Warning! %.4s mismatch. "
571 "Actual [asl:%s, aml:%s], Expected [asl:%s, aml:%s].\n",
573 sdt
->asl_file
, sdt
->aml_file
,
574 exp_sdt
->asl_file
, exp_sdt
->aml_file
);
577 g_string_free(asl
, true);
578 g_string_free(exp_asl
, true);
581 free_test_data(&exp_data
);
584 static void test_acpi_one(const char *params
, test_data
*data
)
587 uint8_t signature_low
;
588 uint8_t signature_high
;
591 const char *device
= "";
593 if (!g_strcmp0(data
->machine
, MACHINE_Q35
)) {
594 device
= ",id=hd -device ide-hd,drive=hd";
597 args
= g_strdup_printf("-net none -display none %s -drive file=%s%s,",
598 params
? params
: "", disk
, device
);
601 /* Wait at most 1 minute */
602 #define TEST_DELAY (1 * G_USEC_PER_SEC / 10)
603 #define TEST_CYCLES MAX((60 * G_USEC_PER_SEC / TEST_DELAY), 1)
605 /* Poll until code has run and modified memory. Once it has we know BIOS
606 * initialization is done. TODO: check that IP reached the halt
609 for (i
= 0; i
< TEST_CYCLES
; ++i
) {
610 signature_low
= readb(BOOT_SECTOR_ADDRESS
+ SIGNATURE_OFFSET
);
611 signature_high
= readb(BOOT_SECTOR_ADDRESS
+ SIGNATURE_OFFSET
+ 1);
612 signature
= (signature_high
<< 8) | signature_low
;
613 if (signature
== SIGNATURE
) {
616 g_usleep(TEST_DELAY
);
618 g_assert_cmphex(signature
, ==, SIGNATURE
);
620 test_acpi_rsdp_address(data
);
621 test_acpi_rsdp_table(data
);
622 test_acpi_rsdt_table(data
);
623 test_acpi_fadt_table(data
);
624 test_acpi_facs_table(data
);
625 test_acpi_dsdt_table(data
);
626 test_acpi_tables(data
);
629 if (getenv(ACPI_REBUILD_EXPECTED_AML
)) {
630 dump_aml_files(data
, true);
636 qtest_quit(global_qtest
);
640 static void test_acpi_tcg(void)
644 /* Supplying -machine accel argument overrides the default (qtest).
645 * This is to make guest actually run.
647 memset(&data
, 0, sizeof(data
));
648 data
.machine
= MACHINE_PC
;
649 test_acpi_one("-machine accel=tcg", &data
);
650 free_test_data(&data
);
652 memset(&data
, 0, sizeof(data
));
653 data
.machine
= MACHINE_Q35
;
654 test_acpi_one("-machine q35,accel=tcg", &data
);
655 free_test_data(&data
);
658 int main(int argc
, char *argv
[])
660 const char *arch
= qtest_get_arch();
661 FILE *f
= fopen(disk
, "w");
663 fwrite(boot_sector
, 1, sizeof boot_sector
, f
);
666 g_test_init(&argc
, &argv
, NULL
);
668 if (strcmp(arch
, "i386") == 0 || strcmp(arch
, "x86_64") == 0) {
669 qtest_add_func("acpi/tcg", test_acpi_tcg
);