Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 1 | /* |
| 2 | * QTest testcase for VM Generation ID |
| 3 | * |
| 4 | * Copyright (c) 2016 Red Hat, Inc. |
| 5 | * Copyright (c) 2017 Skyport Systems |
| 6 | * |
| 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. |
| 9 | */ |
| 10 | |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 11 | #include "qemu/osdep.h" |
| 12 | #include "qemu/bitmap.h" |
| 13 | #include "qemu/uuid.h" |
| 14 | #include "hw/acpi/acpi-defs.h" |
Michael S. Tsirkin | 4871b51 | 2017-07-14 18:30:45 +0300 | [diff] [blame] | 15 | #include "boot-sector.h" |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 16 | #include "acpi-utils.h" |
| 17 | #include "libqtest.h" |
Markus Armbruster | 452fcdb | 2018-02-01 12:18:39 +0100 | [diff] [blame] | 18 | #include "qapi/qmp/qdict.h" |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 19 | |
| 20 | #define VGID_GUID "324e6eaf-d1d1-4bf6-bf41-b9bb6c91fb87" |
| 21 | #define VMGENID_GUID_OFFSET 40 /* allow space for |
| 22 | * OVMF SDT Header Probe Supressor |
| 23 | */ |
| 24 | #define RSDP_ADDR_INVALID 0x100000 /* RSDP must be below this address */ |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 25 | |
Eric Blake | 273e3d9 | 2017-09-11 12:20:08 -0500 | [diff] [blame] | 26 | static uint32_t acpi_find_vgia(QTestState *qts) |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 27 | { |
| 28 | uint32_t rsdp_offset; |
| 29 | uint32_t guid_offset = 0; |
Samuel Ortiz | d6caf36 | 2018-12-20 16:02:55 +0100 | [diff] [blame] | 30 | uint8_t rsdp_table[36 /* ACPI 2.0+ RSDP size */]; |
Igor Mammedov | acee774 | 2018-12-27 15:13:31 +0100 | [diff] [blame] | 31 | uint32_t rsdt_len, table_length; |
| 32 | uint8_t *rsdt, *ent; |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 33 | |
Michael S. Tsirkin | 4871b51 | 2017-07-14 18:30:45 +0300 | [diff] [blame] | 34 | /* Wait for guest firmware to finish and start the payload. */ |
Eric Blake | 273e3d9 | 2017-09-11 12:20:08 -0500 | [diff] [blame] | 35 | boot_sector_test(qts); |
Michael S. Tsirkin | 4871b51 | 2017-07-14 18:30:45 +0300 | [diff] [blame] | 36 | |
| 37 | /* Tables should be initialized now. */ |
Eric Blake | 273e3d9 | 2017-09-11 12:20:08 -0500 | [diff] [blame] | 38 | rsdp_offset = acpi_find_rsdp_address(qts); |
Michael S. Tsirkin | 4871b51 | 2017-07-14 18:30:45 +0300 | [diff] [blame] | 39 | |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 40 | g_assert_cmphex(rsdp_offset, <, RSDP_ADDR_INVALID); |
| 41 | |
Igor Mammedov | acee774 | 2018-12-27 15:13:31 +0100 | [diff] [blame] | 42 | |
Igor Mammedov | 38fb3d7 | 2019-05-02 16:51:49 +0200 | [diff] [blame] | 43 | acpi_fetch_rsdp_table(qts, rsdp_offset, rsdp_table); |
Igor Mammedov | acee774 | 2018-12-27 15:13:31 +0100 | [diff] [blame] | 44 | acpi_fetch_table(qts, &rsdt, &rsdt_len, &rsdp_table[16 /* RsdtAddress */], |
Igor Mammedov | 4b14d54 | 2019-05-02 16:51:50 +0200 | [diff] [blame] | 45 | 4, "RSDT", true); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 46 | |
Igor Mammedov | acee774 | 2018-12-27 15:13:31 +0100 | [diff] [blame] | 47 | ACPI_FOREACH_RSDT_ENTRY(rsdt, rsdt_len, ent, 4 /* Entry size */) { |
| 48 | uint8_t *table_aml; |
Samuel Ortiz | d6caf36 | 2018-12-20 16:02:55 +0100 | [diff] [blame] | 49 | |
Igor Mammedov | 4b14d54 | 2019-05-02 16:51:50 +0200 | [diff] [blame] | 50 | acpi_fetch_table(qts, &table_aml, &table_length, ent, 4, NULL, true); |
Igor Mammedov | acee774 | 2018-12-27 15:13:31 +0100 | [diff] [blame] | 51 | if (!memcmp(table_aml + 16 /* OEM Table ID */, "VMGENID", 7)) { |
| 52 | uint32_t vgia_val; |
| 53 | uint8_t *aml = &table_aml[36 /* AML byte-code start */]; |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 54 | /* the first entry in the table should be VGIA |
| 55 | * That's all we need |
| 56 | */ |
Igor Mammedov | acee774 | 2018-12-27 15:13:31 +0100 | [diff] [blame] | 57 | g_assert(aml[0 /* name_op*/] == 0x08); |
| 58 | g_assert(memcmp(&aml[1 /* name */], "VGIA", 4) == 0); |
| 59 | g_assert(aml[5 /* value op */] == 0x0C /* dword */); |
| 60 | memcpy(&vgia_val, &aml[6 /* value */], 4); |
| 61 | |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 62 | /* The GUID is written at a fixed offset into the fw_cfg file |
| 63 | * in order to implement the "OVMF SDT Header probe suppressor" |
| 64 | * see docs/specs/vmgenid.txt for more details |
| 65 | */ |
Igor Mammedov | acee774 | 2018-12-27 15:13:31 +0100 | [diff] [blame] | 66 | guid_offset = le32_to_cpu(vgia_val) + VMGENID_GUID_OFFSET; |
| 67 | g_free(table_aml); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 68 | break; |
| 69 | } |
Igor Mammedov | acee774 | 2018-12-27 15:13:31 +0100 | [diff] [blame] | 70 | g_free(table_aml); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 71 | } |
Igor Mammedov | acee774 | 2018-12-27 15:13:31 +0100 | [diff] [blame] | 72 | g_free(rsdt); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 73 | return guid_offset; |
| 74 | } |
| 75 | |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 76 | static void read_guid_from_memory(QTestState *qts, QemuUUID *guid) |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 77 | { |
| 78 | uint32_t vmgenid_addr; |
| 79 | int i; |
| 80 | |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 81 | vmgenid_addr = acpi_find_vgia(qts); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 82 | g_assert(vmgenid_addr); |
| 83 | |
| 84 | /* Read the GUID directly from guest memory */ |
| 85 | for (i = 0; i < 16; i++) { |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 86 | guid->data[i] = qtest_readb(qts, vmgenid_addr + i); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 87 | } |
| 88 | /* The GUID is in little-endian format in the guest, while QEMU |
| 89 | * uses big-endian. Swap after reading. |
| 90 | */ |
Peter Maydell | 1324f06 | 2018-12-10 11:26:49 +0000 | [diff] [blame] | 91 | *guid = qemu_uuid_bswap(*guid); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 92 | } |
| 93 | |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 94 | static void read_guid_from_monitor(QTestState *qts, QemuUUID *guid) |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 95 | { |
| 96 | QDict *rsp, *rsp_ret; |
| 97 | const char *guid_str; |
| 98 | |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 99 | rsp = qtest_qmp(qts, "{ 'execute': 'query-vm-generation-id' }"); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 100 | if (qdict_haskey(rsp, "return")) { |
| 101 | rsp_ret = qdict_get_qdict(rsp, "return"); |
| 102 | g_assert(qdict_haskey(rsp_ret, "guid")); |
| 103 | guid_str = qdict_get_str(rsp_ret, "guid"); |
| 104 | g_assert(qemu_uuid_parse(guid_str, guid) == 0); |
| 105 | } |
Marc-André Lureau | cb3e7f0 | 2018-04-19 17:01:43 +0200 | [diff] [blame] | 106 | qobject_unref(rsp); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 107 | } |
| 108 | |
Michael S. Tsirkin | 4871b51 | 2017-07-14 18:30:45 +0300 | [diff] [blame] | 109 | static char disk[] = "tests/vmgenid-test-disk-XXXXXX"; |
| 110 | |
Eric Blake | 78b27ba | 2017-10-18 16:20:27 +0200 | [diff] [blame] | 111 | #define GUID_CMD(guid) \ |
| 112 | "-machine accel=kvm:tcg " \ |
| 113 | "-device vmgenid,id=testvgid,guid=%s " \ |
| 114 | "-drive id=hd0,if=none,file=%s,format=raw " \ |
| 115 | "-device ide-hd,drive=hd0 ", guid, disk |
Michael S. Tsirkin | 4871b51 | 2017-07-14 18:30:45 +0300 | [diff] [blame] | 116 | |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 117 | static void vmgenid_set_guid_test(void) |
| 118 | { |
| 119 | QemuUUID expected, measured; |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 120 | QTestState *qts; |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 121 | |
| 122 | g_assert(qemu_uuid_parse(VGID_GUID, &expected) == 0); |
| 123 | |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 124 | qts = qtest_initf(GUID_CMD(VGID_GUID)); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 125 | |
| 126 | /* Read the GUID from accessing guest memory */ |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 127 | read_guid_from_memory(qts, &measured); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 128 | g_assert(memcmp(measured.data, expected.data, sizeof(measured.data)) == 0); |
| 129 | |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 130 | qtest_quit(qts); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | static void vmgenid_set_guid_auto_test(void) |
| 134 | { |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 135 | QemuUUID measured; |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 136 | QTestState *qts; |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 137 | |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 138 | qts = qtest_initf(GUID_CMD("auto")); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 139 | |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 140 | read_guid_from_memory(qts, &measured); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 141 | |
| 142 | /* Just check that the GUID is non-null */ |
| 143 | g_assert(!qemu_uuid_is_null(&measured)); |
| 144 | |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 145 | qtest_quit(qts); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 146 | } |
| 147 | |
| 148 | static void vmgenid_query_monitor_test(void) |
| 149 | { |
| 150 | QemuUUID expected, measured; |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 151 | QTestState *qts; |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 152 | |
| 153 | g_assert(qemu_uuid_parse(VGID_GUID, &expected) == 0); |
| 154 | |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 155 | qts = qtest_initf(GUID_CMD(VGID_GUID)); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 156 | |
| 157 | /* Read the GUID via the monitor */ |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 158 | read_guid_from_monitor(qts, &measured); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 159 | g_assert(memcmp(measured.data, expected.data, sizeof(measured.data)) == 0); |
| 160 | |
Thomas Huth | ac16ab7 | 2018-11-12 19:46:20 +0100 | [diff] [blame] | 161 | qtest_quit(qts); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | int main(int argc, char **argv) |
| 165 | { |
| 166 | int ret; |
| 167 | |
Michael S. Tsirkin | 4871b51 | 2017-07-14 18:30:45 +0300 | [diff] [blame] | 168 | ret = boot_sector_init(disk); |
| 169 | if (ret) { |
| 170 | return ret; |
| 171 | } |
| 172 | |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 173 | g_test_init(&argc, &argv, NULL); |
| 174 | |
| 175 | qtest_add_func("/vmgenid/vmgenid/set-guid", |
| 176 | vmgenid_set_guid_test); |
| 177 | qtest_add_func("/vmgenid/vmgenid/set-guid-auto", |
| 178 | vmgenid_set_guid_auto_test); |
| 179 | qtest_add_func("/vmgenid/vmgenid/query-monitor", |
| 180 | vmgenid_query_monitor_test); |
| 181 | ret = g_test_run(); |
Michael S. Tsirkin | 4871b51 | 2017-07-14 18:30:45 +0300 | [diff] [blame] | 182 | boot_sector_cleanup(disk); |
Ben Warren | 83f3c70 | 2017-07-01 23:54:03 -0400 | [diff] [blame] | 183 | |
| 184 | return ret; |
| 185 | } |