2 * QTest testcase for VM Generation ID
4 * Copyright (c) 2016 Red Hat, Inc.
5 * Copyright (c) 2017 Skyport Systems
7 * This work is licensed under the terms of the GNU GPL, version 2 or later.
8 * See the COPYING file in the top-level directory.
11 #include "qemu/osdep.h"
12 #include "qemu/bitmap.h"
13 #include "qemu/uuid.h"
14 #include "hw/acpi/acpi-defs.h"
15 #include "boot-sector.h"
16 #include "acpi-utils.h"
18 #include "qapi/qmp/qdict.h"
20 #define VGID_GUID "324e6eaf-d1d1-4bf6-bf41-b9bb6c91fb87"
21 #define VMGENID_GUID_OFFSET 40 /* allow space for
22 * OVMF SDT Header Probe Supressor
24 #define RSDP_ADDR_INVALID 0x100000 /* RSDP must be below this address */
27 AcpiTableHeader header
;
32 } QEMU_PACKED VgidTable
;
34 static uint32_t acpi_find_vgia(QTestState
*qts
)
37 uint32_t guid_offset
= 0;
38 uint8_t rsdp_table
[36 /* ACPI 2.0+ RSDP size */];
39 uint32_t rsdt
, rsdt_table_length
;
40 AcpiRsdtDescriptorRev1 rsdt_table
;
43 AcpiTableHeader ssdt_table
;
47 /* Wait for guest firmware to finish and start the payload. */
48 boot_sector_test(qts
);
50 /* Tables should be initialized now. */
51 rsdp_offset
= acpi_find_rsdp_address(qts
);
53 g_assert_cmphex(rsdp_offset
, <, RSDP_ADDR_INVALID
);
55 acpi_parse_rsdp_table(qts
, rsdp_offset
, rsdp_table
);
57 rsdt
= acpi_get_rsdt_address(rsdp_table
);
61 ACPI_READ_TABLE_HEADER(qts
, &rsdt_table
, rsdt
);
62 ACPI_ASSERT_CMP(rsdt_table
.signature
, "RSDT");
63 rsdt_table_length
= le32_to_cpu(rsdt_table
.length
);
65 /* compute the table entries in rsdt */
66 g_assert_cmpint(rsdt_table_length
, >, sizeof(AcpiRsdtDescriptorRev1
));
67 tables_nr
= (rsdt_table_length
- sizeof(AcpiRsdtDescriptorRev1
)) /
70 /* get the addresses of the tables pointed by rsdt */
71 tables
= g_new0(uint32_t, tables_nr
);
72 ACPI_READ_ARRAY_PTR(qts
, tables
, tables_nr
, rsdt
);
74 for (i
= 0; i
< tables_nr
; i
++) {
75 uint32_t addr
= le32_to_cpu(tables
[i
]);
76 ACPI_READ_TABLE_HEADER(qts
, &ssdt_table
, addr
);
77 if (!strncmp((char *)ssdt_table
.oem_table_id
, "VMGENID", 7)) {
78 /* the first entry in the table should be VGIA
81 ACPI_READ_FIELD(qts
, vgid_table
.name_op
, addr
);
82 g_assert(vgid_table
.name_op
== 0x08); /* name */
83 ACPI_READ_ARRAY(qts
, vgid_table
.vgia
, addr
);
84 g_assert(memcmp(vgid_table
.vgia
, "VGIA", 4) == 0);
85 ACPI_READ_FIELD(qts
, vgid_table
.val_op
, addr
);
86 g_assert(vgid_table
.val_op
== 0x0C); /* dword */
87 ACPI_READ_FIELD(qts
, vgid_table
.vgia_val
, addr
);
88 /* The GUID is written at a fixed offset into the fw_cfg file
89 * in order to implement the "OVMF SDT Header probe suppressor"
90 * see docs/specs/vmgenid.txt for more details
92 guid_offset
= le32_to_cpu(vgid_table
.vgia_val
) + VMGENID_GUID_OFFSET
;
100 static void read_guid_from_memory(QTestState
*qts
, QemuUUID
*guid
)
102 uint32_t vmgenid_addr
;
105 vmgenid_addr
= acpi_find_vgia(qts
);
106 g_assert(vmgenid_addr
);
108 /* Read the GUID directly from guest memory */
109 for (i
= 0; i
< 16; i
++) {
110 guid
->data
[i
] = qtest_readb(qts
, vmgenid_addr
+ i
);
112 /* The GUID is in little-endian format in the guest, while QEMU
113 * uses big-endian. Swap after reading.
115 qemu_uuid_bswap(guid
);
118 static void read_guid_from_monitor(QTestState
*qts
, QemuUUID
*guid
)
120 QDict
*rsp
, *rsp_ret
;
121 const char *guid_str
;
123 rsp
= qtest_qmp(qts
, "{ 'execute': 'query-vm-generation-id' }");
124 if (qdict_haskey(rsp
, "return")) {
125 rsp_ret
= qdict_get_qdict(rsp
, "return");
126 g_assert(qdict_haskey(rsp_ret
, "guid"));
127 guid_str
= qdict_get_str(rsp_ret
, "guid");
128 g_assert(qemu_uuid_parse(guid_str
, guid
) == 0);
133 static char disk
[] = "tests/vmgenid-test-disk-XXXXXX";
135 #define GUID_CMD(guid) \
136 "-machine accel=kvm:tcg " \
137 "-device vmgenid,id=testvgid,guid=%s " \
138 "-drive id=hd0,if=none,file=%s,format=raw " \
139 "-device ide-hd,drive=hd0 ", guid, disk
141 static void vmgenid_set_guid_test(void)
143 QemuUUID expected
, measured
;
146 g_assert(qemu_uuid_parse(VGID_GUID
, &expected
) == 0);
148 qts
= qtest_initf(GUID_CMD(VGID_GUID
));
150 /* Read the GUID from accessing guest memory */
151 read_guid_from_memory(qts
, &measured
);
152 g_assert(memcmp(measured
.data
, expected
.data
, sizeof(measured
.data
)) == 0);
157 static void vmgenid_set_guid_auto_test(void)
162 qts
= qtest_initf(GUID_CMD("auto"));
164 read_guid_from_memory(qts
, &measured
);
166 /* Just check that the GUID is non-null */
167 g_assert(!qemu_uuid_is_null(&measured
));
172 static void vmgenid_query_monitor_test(void)
174 QemuUUID expected
, measured
;
177 g_assert(qemu_uuid_parse(VGID_GUID
, &expected
) == 0);
179 qts
= qtest_initf(GUID_CMD(VGID_GUID
));
181 /* Read the GUID via the monitor */
182 read_guid_from_monitor(qts
, &measured
);
183 g_assert(memcmp(measured
.data
, expected
.data
, sizeof(measured
.data
)) == 0);
188 int main(int argc
, char **argv
)
192 ret
= boot_sector_init(disk
);
197 g_test_init(&argc
, &argv
, NULL
);
199 qtest_add_func("/vmgenid/vmgenid/set-guid",
200 vmgenid_set_guid_test
);
201 qtest_add_func("/vmgenid/vmgenid/set-guid-auto",
202 vmgenid_set_guid_auto_test
);
203 qtest_add_func("/vmgenid/vmgenid/query-monitor",
204 vmgenid_query_monitor_test
);
206 boot_sector_cleanup(disk
);