acpi: Error Record Serialization Table, ERST, support for QEMU
PATCH v12 2/9 ACPI ERST: specification for ERST support
In reply to Eric DeVolderInformation on the implementation of the ACPI ERST support.
--- docs/specs/acpi_erst.rst | 200 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 200 insertions(+) create mode 100644 docs/specs/acpi_erst.rst
docs/specs/acpi_erst.rst new file +200 -0
@@ -0,0 +1,200 @@ +ACPI ERST DEVICE +================ + +The ACPI ERST device is utilized to support the ACPI Error Record +Serialization Table, ERST, functionality. This feature is designed for +storing error records in persistent storage for future reference +and/or debugging. + +The ACPI specification[1], in Chapter "ACPI Platform Error Interfaces +(APEI)", and specifically subsection "Error Serialization", outlines a +method for storing error records into persistent storage. + +The format of error records is described in the UEFI specification[2], +in Appendix N "Common Platform Error Record". + +While the ACPI specification allows for an NVRAM "mode" (see +GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES) where non-volatile RAM is +directly exposed for direct access by the OS/guest, this device +implements the non-NVRAM "mode". This non-NVRAM "mode" is what is +implemented by most BIOS (since flash memory requires programming +operations in order to update its contents). Furthermore, as of the +time of this writing, Linux only supports the non-NVRAM "mode". + + +Background/Motivation +--------------------- + +Linux uses the persistent storage filesystem, pstore, to record +information (eg. dmesg tail) upon panics and shutdowns. Pstore is +independent of, and runs before, kdump. In certain scenarios (ie. +hosts/guests with root filesystems on NFS/iSCSI where networking +software and/or hardware fails, and thus kdump fails), pstore may +contain information available for post-mortem debugging. + +Two common storage backends for the pstore filesystem are ACPI ERST +and UEFI. Most BIOS implement ACPI ERST. UEFI is not utilized in all +guests. With QEMU supporting ACPI ERST, it becomes a viable pstore +storage backend for virtual machines (as it is now for bare metal +machines). + +Enabling support for ACPI ERST facilitates a consistent method to +capture kernel panic information in a wide range of guests: from +resource-constrained microvms to very large guests, and in particular, +in direct-boot environments (which would lack UEFI run-time services). + +Note that Microsoft Windows also utilizes the ACPI ERST for certain +crash information, if available[3]. + + +Configuration|Usage +------------------- + +To use ACPI ERST, a memory-backend-file object and acpi-erst device +can be created, for example: + + qemu ... + -object memory-backend-file,id=erstnvram,mem-path=acpi-erst.backing,size=0x10000,share=on \ + -device acpi-erst,memdev=erstnvram + +For proper operation, the ACPI ERST device needs a memory-backend-file +object with the following parameters: + + - id: The id of the memory-backend-file object is used to associate + this memory with the acpi-erst device. + - size: The size of the ACPI ERST backing storage. This parameter is + required. + - mem-path: The location of the ACPI ERST backing storage file. This + parameter is also required. + - share: The share=on parameter is required so that updates to the + ERST backing store are written to the file. + +and ERST device: + + - memdev: Is the object id of the memory-backend-file. + - record_size: Specifies the size of the records (or slots) in the + backend storage. Must be a power of two value greater than or + equal to 4096 (PAGE_SIZE). + + +PCI Interface +------------- + +The ERST device is a PCI device with two BARs, one for accessing the +programming registers, and the other for accessing the record exchange +buffer. + +BAR0 contains the programming interface consisting of ACTION and VALUE +64-bit registers. All ERST actions/operations/side effects happen on +the write to the ACTION, by design. Any data needed by the action must +be placed into VALUE prior to writing ACTION. Reading the VALUE +simply returns the register contents, which can be updated by a +previous ACTION. + +BAR1 contains the 8KiB record exchange buffer, which is the +implemented maximum record size. + + +Backend Storage Format +---------------------- + +The backend storage is divided into fixed size "slots", 8KiB in +length, with each slot storing a single record. Not all slots need to +be occupied, and they need not be occupied in a contiguous fashion. +The ability to clear/erase specific records allows for the formation +of unoccupied slots. + +Slot 0 contains a backend storage header that identifies the contents +as ERST and also facilitates efficient access to the records. +Depending upon the size of the backend storage, additional slots will +be designated to be a part of the slot 0 header. For example, at 8KiB, +the slot 0 header can accomodate 1021 records. Thus a storage size +of 8MiB (8KiB * 1024) requires an additional slot for use by the +header. In this scenario, slot 0 and slot 1 form the backend storage +header, and records can be stored starting at slot 2. + +Below is an example layout of the backend storage format (for storage +size less than 8MiB). The size of the storage is a multiple of 8KiB, +and contains N number of slots to store records. The example below +shows two records (in CPER format) in the backend storage, while the +remaining slots are empty/available. + +:: + + Slot Record + <------------------ 8KiB --------------------> + +--------------------------------------------+ + 0 | storage header | + +--------------------------------------------+ + 1 | empty/available | + +--------------------------------------------+ + 2 | CPER | + +--------------------------------------------+ + 3 | CPER | + +--------------------------------------------+ + ... | | + +--------------------------------------------+ + N | empty/available | + +--------------------------------------------+ + +The storage header consists of some basic information and an array +of CPER record_id's to efficiently access records in the backend +storage. + +All fields in the header are stored in little endian format. + +:: + + +--------------------------------------------+ + | magic | 0x0000 + +--------------------------------------------+ + | record_offset | record_size | 0x0008 + +--------------------------------------------+ + | record_count | reserved | version | 0x0010 + +--------------------------------------------+ + | record_id[0] | 0x0018 + +--------------------------------------------+ + | record_id[1] | 0x0020 + +--------------------------------------------+ + | record_id[...] | + +--------------------------------------------+ + | record_id[N] | 0x1FF8 + +--------------------------------------------+ + +The 'magic' field contains the value 0x524F545354535245. + +The 'record_size' field contains the value 0x2000, 8KiB. + +The 'record_offset' field points to the first record_id in the array, +0x0018. + +The 'version' field contains 0x0100, the first version. + +The 'record_count' field contains the number of valid records in the +backend storage. + +The 'record_id' array fields are the 64-bit record identifiers of the +CPER record in the corresponding slot. Stated differently, the +location of a CPER record_id in the record_id[] array provides the +slot index for the corresponding record in the backend storage. + +Note that, for example, with a backend storage less than 8MiB, slot 0 +contains the header, so the record_id[0] will never contain a valid +CPER record_id. Instead slot 1 is the first available slot and thus +record_id_[1] may contain a CPER. + +A 'record_id' of all 0s or all 1s indicates an invalid record (ie. the +slot is available). + + +References +---------- + +[1] "Advanced Configuration and Power Interface Specification", + version 4.0, June 2009. + +[2] "Unified Extensible Firmware Interface Specification", + version 2.1, October 2008. + +[3] "Windows Hardware Error Architecture", specfically + "Error Record Persistence Mechanism".
Signature · 1 line
1.8.3.1
PATCH v12 3/9 ACPI ERST: PCI device_id for ERST
In reply to Eric DeVolderThis change reserves the PCI device_id for the new ACPI ERST device.
--- include/hw/pci/pci.h | 1 + 1 file changed, 1 insertion(+)
include/hw/pci/pci.h +1 -0
@@ -108,6 +108,7 @@ extern bool pci_available;#define PCI_DEVICE_ID_REDHAT_MDPY 0x000f#define PCI_DEVICE_ID_REDHAT_NVME 0x0010#define PCI_DEVICE_ID_REDHAT_PVPANIC 0x0011 +#define PCI_DEVICE_ID_REDHAT_ACPI_ERST 0x0012#define PCI_DEVICE_ID_REDHAT_QXL 0x0100#define FMT_PCIBUS PRIx64
Signature · 1 line
1.8.3.1
v12 cover acpi: Error Record Serialization Table, ERST, support for QEMU
This patchset introduces support for the ACPI Error Record Serialization Table, ERST.
For background and implementation information, please see docs/specs/acpi_erst.rst, which is patch 2/10.
---
v12: 10jan2022
- Converted macros in build_erst() to uppert to follow coding style, as pointed out by Michael Tsirkin.
- And few items to help further simplify build_erst().
v11: 15dec2021
- Simplified build_erst() via feedback from Michael Tsirkin
- Addressed additional feedback from Ani Sinha
v10: 9dec2021
- Addressed additional feedback from Ani Sinha
v9: 2dec2021
- Addressed feedback from Ani Sinha
v8: 15oct2021
- Added Kconfig option for ERST, per Ani Sinha
- Fixed patch ordering, per Ani
v7: 7oct2021
- style improvements, per Igor
- use of endian accessors for storage header, per Igor
- a number of optimizations and improvements, per Igor
- updated spec for header, per Igor
- updated spec for rst format, per Michael Tsirkin
- updated spec for new record_size parameter Due to changes in the spec, I am not carrying the Acked-by from Ani Sinha.
- changes for and testing of migration to systems with differing ERST_RECORD_SIZE
v6: 5aug2021
- Fixed compile warning/error, per Michael Tsirkin
- Fixed mingw32 build error, per Michael
- Converted exchange buffer to MemoryBackend, per Igor
- Migrated test to PCI, per Igor
- Significantly reduced amount of copying, per Igor
- Corrections/enhancements to acpi_erst.txt, per Igor
- Many misc/other small items, per Igor
v5: 30jun2021
- Create docs/specs/acpi_erst.txt, per Igor
- Separate PCI BARs for registers and memory, per Igor
- Convert debugging to use trace infrastructure, per Igor
- Various other fixups, per Igor
v4: 11jun2021
- Converted to a PCI device, per Igor.
- Updated qtest.
- Rearranged patches, per Igor.
v3: 28may2021
- Converted to using a TYPE_MEMORY_BACKEND_FILE object rather than internal array with explicit file operations, per Igor.
- Changed the way the qdev and base address are handled, allowing ERST to be disabled at run-time. Also aligns better with other existing code.
v2: 8feb2021
- Added qtest/smoke test per Paolo Bonzini
- Split patch into smaller chunks, per Igor Mammedov
- Did away with use of ACPI packed structures, per Igor Mammedov
v1: 26oct2020
- initial post
---
Eric DeVolder (9):
ACPI ERST: bios-tables-test.c steps 1 and 2 ACPI ERST: specification for ERST support ACPI ERST: PCI device_id for ERST
ACPI ERST: header file for ERST
ACPI ERST: support for ACPI ERST feature ACPI ERST: build the ACPI ERST table
ACPI ERST: create ACPI ERST table for pc/x86 machines ACPI ERST: qtest for ERST
ACPI ERST: bios-tables-test testcase
docs/specs/acpi_erst.rst | 200 ++++++ hw/acpi/Kconfig | 6 + hw/acpi/erst.c | 1033 +++++++++++++++++++++++++++ hw/acpi/meson.build | 1 + hw/acpi/trace-events | 15 + hw/i386/acpi-build.c | 15 + hw/i386/acpi-microvm.c | 15 + include/hw/acpi/erst.h | 24 + include/hw/pci/pci.h | 1 + tests/data/acpi/microvm/ERST.pcie | 0 tests/data/acpi/pc/DSDT.acpierst | 0 tests/data/acpi/pc/ERST.acpierst | 0 tests/data/acpi/q35/DSDT.acpierst | 0 tests/data/acpi/q35/ERST.acpierst | 0 tests/qtest/bios-tables-test-allowed-diff.h | 5 + tests/qtest/bios-tables-test.c | 54 ++ tests/qtest/erst-test.c | 172 +++++ tests/qtest/meson.build | 2 + 18 files changed, 1543 insertions(+) create mode 100644 docs/specs/acpi_erst.rst create mode 100644 hw/acpi/erst.c create mode 100644 include/hw/acpi/erst.h create mode 100644 tests/data/acpi/microvm/ERST.pcie create mode 100644 tests/data/acpi/pc/DSDT.acpierst create mode 100644 tests/data/acpi/pc/ERST.acpierst create mode 100644 tests/data/acpi/q35/DSDT.acpierst create mode 100644 tests/data/acpi/q35/ERST.acpierst create mode 100644 tests/qtest/erst-test.c
Signature · 1 line
1.8.3.1
PATCH v12 8/9 ACPI ERST: qtest for ERST
This change provides a qtest that locates and then does a simple interrogation of the ERST feature within the guest.
--- tests/qtest/erst-test.c | 172 ++++++++++++++++++++++++++++++++++++++++++++++++ tests/qtest/meson.build | 2 + 2 files changed, 174 insertions(+) create mode 100644 tests/qtest/erst-test.c
tests/qtest/erst-test.c new file +172 -0
@@ -0,0 +1,172 @@ +/* +* QTest testcase for acpi-erst +* +* Copyright (c) 2021 Oracle +* +* This work is licensed under the terms of the GNU GPL, version 2 or later. +* See the COPYING file in the top-level directory. +*/ + +#include "qemu/osdep.h" +#include <glib/gstdio.h> +#include "libqos/libqos-pc.h" +#include "libqos/libqtest.h" +#include "qemu-common.h" + +#include "hw/pci/pci.h" + +static void save_fn (QPCIDevice *dev,int devfn,void *data) +{ +QPCIDevice **pdev = (QPCIDevice **) data; + + *pdev = dev; +} + +static QPCIDevice *get_erst_device (QPCIBus *pcibus) +{ +QPCIDevice *dev; + + dev =NULL ; +qpci_device_foreach (pcibus, +PCI_VENDOR_ID_REDHAT , +PCI_DEVICE_ID_REDHAT_ACPI_ERST , + save_fn, &dev); +g_assert (dev !=NULL ); + +return dev; +} + +typedef struct _ERSTState { +QOSState *qs; +QPCIBar reg_bar, mem_bar; +uint64_t reg_barsize, mem_barsize; +QPCIDevice *dev; +}ERSTState ; + +#define ACTION 0 +#define VALUE 8 + +static const char *reg2str (unsigned reg) +{ +switch (reg) { +case 0 : +return "ACTION" ; +case 8 : +return "VALUE" ; +default : +return NULL ; + } +} + +static inline uint32_t in_reg32 (ERSTState *s,unsigned reg) +{ +const char *name =reg2str (reg); +uint32_t res; + + res =qpci_io_readl (s->dev, s->reg_bar, reg); +g_test_message ("*%s -> %08x" , name, res); + +return res; +} + +static inline uint64_t in_reg64 (ERSTState *s,unsigned reg) +{ +const char *name =reg2str (reg); +uint64_t res; + + res =qpci_io_readq (s->dev, s->reg_bar, reg); +g_test_message ("*%s -> %016llx" , name, (unsigned long long )res); + +return res; +} + +static inline void out_reg32 (ERSTState *s,unsigned reg,uint32_t v) +{ +const char *name =reg2str (reg); + +g_test_message ("%08x -> *%s" , v, name); +qpci_io_writel (s->dev, s->reg_bar, reg, v); +} + +static inline void out_reg64 (ERSTState *s,unsigned reg,uint64_t v) +{ +const char *name =reg2str (reg); + +g_test_message ("%016llx -> *%s" , (unsigned long long )v, name); +qpci_io_writeq (s->dev, s->reg_bar, reg, v); +} + +static void cleanup_vm (ERSTState *s) +{ +g_free (s->dev); +qtest_shutdown (s->qs); +} + +static void setup_vm_cmd (ERSTState *s,const char *cmd) +{ +const char *arch =qtest_get_arch (); + +if (strcmp (arch,"i386" ) ==0 ||strcmp (arch,"x86_64" ) ==0 ) { + s->qs =qtest_pc_boot (cmd); + }else { +g_printerr ("erst-test tests are only available on x86\n" ); +exit (EXIT_FAILURE ); + } + s->dev =get_erst_device (s->qs->pcibus); + + s->reg_bar =qpci_iomap (s->dev,0 , &s->reg_barsize); + g_assert_cmpuint(s->reg_barsize, ==, 16); + + s->mem_bar =qpci_iomap (s->dev,1 , &s->mem_barsize); + g_assert_cmpuint(s->mem_barsize, ==, 0x2000); + +qpci_device_enable (s->dev); +} + +static void test_acpi_erst_basic (void ) +{ +ERSTState state; +uint64_t log_address_range; +uint64_t log_address_length; +uint32_t log_address_attr; + +setup_vm_cmd (&state, +"-object memory-backend-file," +"mem-path=acpi-erst.XXXXXX," +"size=64K," +"share=on," +"id=nvram " +"-device acpi-erst," +"memdev=nvram" ); + +out_reg32 (&state,ACTION ,0xD ); + log_address_range =in_reg64 (&state,VALUE ); +out_reg32 (&state,ACTION ,0xE ); + log_address_length =in_reg64 (&state,VALUE ); +out_reg32 (&state,ACTION ,0xF ); + log_address_attr =in_reg32 (&state,VALUE ); + +/* Check log_address_range is not 0, ~0 or base */ + g_assert_cmpuint(log_address_range, !=, 0ULL); + g_assert_cmpuint(log_address_range, !=, ~0ULL); + g_assert_cmpuint(log_address_range, !=, state.reg_bar.addr); + g_assert_cmpuint(log_address_range, ==, state.mem_bar.addr); + +/* Check log_address_length is bar1_size */ + g_assert_cmpuint(log_address_length, ==, state.mem_barsize); + +/* Check log_address_attr is 0 */ + g_assert_cmpuint(log_address_attr, ==, 0); + +cleanup_vm (&state); +} + +int main (int argc,char **argv) +{ +int ret; + +g_test_init (&argc, &argv,NULL ); +qtest_add_func ("/acpi-erst/basic" , test_acpi_erst_basic); + ret =g_test_run (); +return ret; +}
tests/qtest/meson.build +2 -0
@@ -68,6 +68,7 @@ qtests_i386 = \ (config_all_devices.has_key('CONFIG_RTL8139_PCI') ? ['rtl8139-test'] : []) + \ (config_all_devices.has_key('CONFIG_E1000E_PCI_EXPRESS') ? ['fuzz-e1000e-test'] : []) + \ (config_all_devices.has_key('CONFIG_ESP_PCI') ? ['am53c974-test'] : []) + \ + (config_all_devices.has_key('CONFIG_ACPI_ERST') ? ['erst-test'] : []) + \ (config_all_devices.has_key('CONFIG_VIRTIO_NET') and \ config_all_devices.has_key('CONFIG_Q35') and \ config_all_devices.has_key('CONFIG_VIRTIO_PCI') and \
@@ -278,6 +279,7 @@ qtests = { 'bios-tables-test': [io, 'boot-sector.c', 'acpi-utils.c', 'tpm-emu.c'], 'cdrom-test': files('boot-sector.c'), 'dbus-vmstate-test': files('migration-helpers.c') + dbus_vmstate1, + 'erst-test': files('erst-test.c'), 'ivshmem-test': [rt, '../../contrib/ivshmem-server/ivshmem-server.c'], 'migration-test': files('migration-helpers.c'), 'pxe-test': files('boot-sector.c'),
Signature · 1 line
1.8.3.1
PATCH v12 7/9 ACPI ERST: create ACPI ERST table for pc/x86 machines
In reply to Eric DeVolderThis change exposes ACPI ERST support for x86 guests.
--- hw/i386/acpi-build.c | 15 +++++++++++++++ hw/i386/acpi-microvm.c | 15 +++++++++++++++ include/hw/acpi/erst.h | 5 +++++ 3 files changed, 35 insertions(+)
hw/i386/acpi-build.c +15 -0
@@ -43,6 +43,7 @@#include "sysemu/tpm.h" #include "hw/acpi/tpm.h" #include "hw/acpi/vmgenid.h" +#include "hw/acpi/erst.h" #include "sysemu/tpm_backend.h" #include "hw/rtc/mc146818rtc_regs.h" #include "migration/vmstate.h"
@@ -74,6 +75,8 @@#include "hw/acpi/hmat.h" #include "hw/acpi/viot.h" +#include CONFIG_DEVICES +/* These are used to size the ACPI tables for -M pc-i440fx-1.7 and * -M pc-i440fx-2.0. Even if the actual amount of AML generated grows * a little bit, there should be plenty of free space since the DSDT
@@ -2575,6 +2578,18 @@ void acpi_build(AcpiBuildTables *tables, MachineState *machine)ACPI_DEVICE_IF (x86ms->acpi_dev), x86ms->oem_id, x86ms->oem_table_id); +#ifdef CONFIG_ACPI_ERST + { +Object *erst_dev; + erst_dev =find_erst_dev (); +if (erst_dev) { +acpi_add_table (table_offsets, tables_blob); +build_erst (tables_blob, tables->linker, erst_dev, + x86ms->oem_id, x86ms->oem_table_id); + } + } +#endif + vmgenid_dev =find_vmgenid_dev ();if (vmgenid_dev) {acpi_add_table (table_offsets, tables_blob);
hw/i386/acpi-microvm.c +15 -0
@@ -30,6 +30,7 @@#include "hw/acpi/bios-linker-loader.h" #include "hw/acpi/generic_event_device.h" #include "hw/acpi/utils.h" +#include "hw/acpi/erst.h" #include "hw/i386/fw_cfg.h" #include "hw/i386/microvm.h" #include "hw/pci/pci.h"
@@ -40,6 +41,8 @@#include "acpi-common.h" #include "acpi-microvm.h" +#include CONFIG_DEVICES +static void acpi_dsdt_add_virtio (Aml *scope,MicrovmMachineState *mms) {
@@ -207,6 +210,18 @@ static void acpi_build_microvm(AcpiBuildTables *tables,ACPI_DEVICE_IF (x86ms->acpi_dev), x86ms->oem_id, x86ms->oem_table_id); +#ifdef CONFIG_ACPI_ERST + { +Object *erst_dev; + erst_dev =find_erst_dev (); +if (erst_dev) { +acpi_add_table (table_offsets, tables_blob); +build_erst (tables_blob, tables->linker, erst_dev, + x86ms->oem_id, x86ms->oem_table_id); + } + } +#endif + xsdt = tables_blob->len;build_xsdt (tables_blob, tables->linker, table_offsets, x86ms->oem_id, x86ms->oem_table_id);
include/hw/acpi/erst.h +5 -0
@@ -16,4 +16,9 @@ void build_erst(GArray *table_data, BIOSLinker *linker, Object *erst_dev,#define TYPE_ACPI_ERST "acpi-erst" +/* returns NULL unless there is exactly one device */ +static inline Object *find_erst_dev (void ) +{ +return object_resolve_path_type ("" ,TYPE_ACPI_ERST ,NULL ); +}#endif
Signature · 1 line
1.8.3.1
PATCH v12 1/9 ACPI ERST: bios-tables-test.c steps 1 and 2
In reply to Eric DeVolderFollowing the guidelines in tests/qtest/bios-tables-test.c, this change adds empty placeholder files per step 1 for the new ERST table, and excludes resulting changed files in bios-tables-test-allowed-diff.h per step 2.
--- tests/data/acpi/microvm/ERST.pcie | 0 tests/data/acpi/pc/DSDT.acpierst | 0 tests/data/acpi/pc/ERST.acpierst | 0 tests/data/acpi/q35/DSDT.acpierst | 0 tests/data/acpi/q35/ERST.acpierst | 0 tests/qtest/bios-tables-test-allowed-diff.h | 5 +++++ 6 files changed, 5 insertions(+) create mode 100644 tests/data/acpi/microvm/ERST.pcie create mode 100644 tests/data/acpi/pc/DSDT.acpierst create mode 100644 tests/data/acpi/pc/ERST.acpierst create mode 100644 tests/data/acpi/q35/DSDT.acpierst create mode 100644 tests/data/acpi/q35/ERST.acpierst
tests/data/acpi/microvm/ERST.pcie new file +0 -0
tests/data/acpi/pc/DSDT.acpierst new file +0 -0
tests/data/acpi/pc/ERST.acpierst new file +0 -0
tests/data/acpi/q35/DSDT.acpierst new file +0 -0
tests/data/acpi/q35/ERST.acpierst new file +0 -0
tests/qtest/bios-tables-test-allowed-diff.h +5 -0
@@ -1 +1,6 @@/* List of comma-separated changed AML files to ignore */ +"tests/data/acpi/pc/DSDT.acpierst" , +"tests/data/acpi/pc/ERST.acpierst" , +"tests/data/acpi/q35/DSDT.acpierst" , +"tests/data/acpi/q35/ERST.acpierst" , +"tests/data/acpi/microvm/ERST.pcie",
Signature · 1 line
1.8.3.1
PATCH v12 9/9 ACPI ERST: bios-tables-test testcase
In reply to Eric DeVolderThis change implements the test suite checks for the ERST table.
--- tests/qtest/bios-tables-test.c | 54 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+)
tests/qtest/bios-tables-test.c +54 -0
@@ -1446,6 +1446,57 @@ static void test_acpi_piix4_tcg_acpi_hmat(void)test_acpi_tcg_acpi_hmat (MACHINE_PC ); } +static void test_acpi_erst (const char *machine) +{ +gchar *tmp_path =g_dir_make_tmp ("qemu-test-erst.XXXXXX" ,NULL ); +gchar *params; +test_data data; + +memset (&data,0 ,sizeof (data)); + data.machine = machine; + data.variant =".acpierst" ; + params =g_strdup_printf ( +" -object memory-backend-file,id=erstnvram," +"mem-path=%s,size=0x10000,share=on" +" -device acpi-erst,memdev=erstnvram" , tmp_path); +test_acpi_one (params, &data); +free_test_data (&data); +g_free (params); +g_assert (g_rmdir (tmp_path) ==0 ); +g_free (tmp_path); +} + +static void test_acpi_piix4_acpi_erst (void ) +{ +test_acpi_erst (MACHINE_PC ); +} + +static void test_acpi_q35_acpi_erst (void ) +{ +test_acpi_erst (MACHINE_Q35 ); +} + +static void test_acpi_microvm_acpi_erst (void ) +{ +gchar *tmp_path =g_dir_make_tmp ("qemu-test-erst.XXXXXX" ,NULL ); +gchar *params; +test_data data; + +test_acpi_microvm_prepare (&data); + data.variant =".pcie" ; + data.tcg_only = true;/* need constant host-phys-bits */ + params =g_strdup_printf (" -machine microvm," +"acpi=on,ioapic2=off,rtc=off,pcie=on" +" -object memory-backend-file,id=erstnvram," +"mem-path=%s,size=0x10000,share=on" +" -device acpi-erst,memdev=erstnvram" , tmp_path); +test_acpi_one (params, &data); +g_free (params); +g_assert (g_rmdir (tmp_path) ==0 ); +g_free (tmp_path); +free_test_data (&data); +} +static void test_acpi_virt_tcg (void ) {test_data data = {
@@ -1675,6 +1726,8 @@ int main(int argc, char *argv[])qtest_add_func ("acpi/q35/dimmpxm" , test_acpi_q35_tcg_dimm_pxm);qtest_add_func ("acpi/piix4/acpihmat" , test_acpi_piix4_tcg_acpi_hmat);qtest_add_func ("acpi/q35/acpihmat" , test_acpi_q35_tcg_acpi_hmat); +qtest_add_func ("acpi/piix4/acpierst" , test_acpi_piix4_acpi_erst); +qtest_add_func ("acpi/q35/acpierst" , test_acpi_q35_acpi_erst);qtest_add_func ("acpi/microvm" , test_acpi_microvm_tcg);qtest_add_func ("acpi/microvm/usb" , test_acpi_microvm_usb_tcg);qtest_add_func ("acpi/microvm/rtc" , test_acpi_microvm_rtc_tcg);
@@ -1684,6 +1737,7 @@ int main(int argc, char *argv[])qtest_add_func ("acpi/q35/ivrs" , test_acpi_q35_tcg_ivrs);if (strcmp (arch,"x86_64" ) ==0 ) {qtest_add_func ("acpi/microvm/pcie" , test_acpi_microvm_pcie_tcg); +qtest_add_func ("acpi/microvm/acpierst" , test_acpi_microvm_acpi_erst); } }if (has_kvm) {
Signature · 1 line
1.8.3.1
PATCH v12 4/9 ACPI ERST: header file for ERST
In reply to Eric DeVolderThis change introduces the public defintions for ACPI ERST.
--- include/hw/acpi/erst.h | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 include/hw/acpi/erst.h
include/hw/acpi/erst.h new file +19 -0
@@ -0,0 +1,19 @@ +/* +* ACPI Error Record Serialization Table, ERST, Implementation +* +* ACPI ERST introduced in ACPI 4.0, June 16, 2009. +* ACPI Platform Error Interfaces : Error Serialization +* +* Copyright (c) 2021 Oracle and/or its affiliates. +* +* SPDX-License-Identifier: GPL-2.0-or-later +*/ +#ifndef HW_ACPI_ERST_H +#define HW_ACPI_ERST_H + +void build_erst (GArray *table_data,BIOSLinker *linker,Object *erst_dev, +const char *oem_id,const char *oem_table_id); + +#define TYPE_ACPI_ERST "acpi-erst" + +#endif
Signature · 1 line
1.8.3.1
PATCH v12 5/9 ACPI ERST: support for ACPI ERST feature
In reply to Eric DeVolderThis implements a PCI device for ACPI ERST. This implements the non-NVRAM "mode" of operation for ERST as it is supported by Linux and Windows.
--- hw/acpi/Kconfig | 6 + hw/acpi/erst.c | 845 +++++++++++++++++++++++++++++++++++++++++++++++++++ hw/acpi/meson.build | 1 + hw/acpi/trace-events | 15 + 4 files changed, 867 insertions(+) create mode 100644 hw/acpi/erst.c
hw/acpi/Kconfig +6 -0
@@ -10,6 +10,7 @@ config ACPI_X86 select ACPI_HMAT select ACPI_PIIX4 select ACPI_PCIHP + select ACPI_ERST config ACPI_X86_ICH bool
@@ -60,3 +61,8 @@ config ACPI_HW_REDUCED select ACPI select ACPI_MEMORY_HOTPLUG select ACPI_NVDIMM + +config ACPI_ERST + bool + default y + depends on ACPI && PCI
hw/acpi/erst.c new file +845 -0
845 lines not on this page · raw message
hw/acpi/meson.build +1 -0
@@ -22,6 +22,7 @@ acpi_ss.add(when: 'CONFIG_ACPI_PCIHP', if_true: files('pcihp.c')) acpi_ss.add(when: 'CONFIG_ACPI_PCIHP', if_false: files('acpi-pci-hotplug-stub.c')) acpi_ss.add(when: 'CONFIG_ACPI_VIOT', if_true: files('viot.c')) acpi_ss.add(when: 'CONFIG_ACPI_X86_ICH', if_true: files('ich9.c', 'tco.c')) +acpi_ss.add(when: 'CONFIG_ACPI_ERST', if_true: files('erst.c')) acpi_ss.add(when: 'CONFIG_IPMI', if_true: files('ipmi.c'), if_false: files('ipmi-stub.c')) acpi_ss.add(when: 'CONFIG_PC', if_false: files('acpi-x86-stub.c')) acpi_ss.add(when: 'CONFIG_TPM', if_true: files('tpm.c'))
hw/acpi/trace-events +15 -0
@@ -55,3 +55,18 @@ piix4_gpe_writeb(uint64_t addr, unsigned width, uint64_t val) "addr: 0x%" PRIx64 # tco.c tco_timer_reload(int ticks, int msec) "ticks=%d (%d ms)" tco_timer_expired(int timeouts_no, bool strap, bool no_reboot) "timeouts_no=%d no_reboot=%d/%d" + +# erst.c +acpi_erst_reg_write(uint64_t addr, uint64_t val, unsigned size) "addr: 0x%04" PRIx64 " <== 0x%016" PRIx64 " (size: %u)" +acpi_erst_reg_read(uint64_t addr, uint64_t val, unsigned size) " addr: 0x%04" PRIx64 " ==> 0x%016" PRIx64 " (size: %u)" +acpi_erst_mem_write(uint64_t addr, uint64_t val, unsigned size) "addr: 0x%06" PRIx64 " <== 0x%016" PRIx64 " (size: %u)" +acpi_erst_mem_read(uint64_t addr, uint64_t val, unsigned size) " addr: 0x%06" PRIx64 " ==> 0x%016" PRIx64 " (size: %u)" +acpi_erst_pci_bar_0(uint64_t addr) "BAR0: 0x%016" PRIx64 +acpi_erst_pci_bar_1(uint64_t addr) "BAR1: 0x%016" PRIx64 +acpi_erst_realizefn_in(void) +acpi_erst_realizefn_out(unsigned size) "total nvram size %u bytes" +acpi_erst_reset_in(unsigned record_count) "record_count %u" +acpi_erst_reset_out(unsigned record_count) "record_count %u" +acpi_erst_post_load(void *header, unsigned slot_size) "header: 0x%p slot_size %u" +acpi_erst_class_init_in(void) +acpi_erst_class_init_out(void)
Signature · 1 line
1.8.3.1
PATCH v12 6/9 ACPI ERST: build the ACPI ERST table
In reply to Eric DeVolderThis builds the ACPI ERST table to inform OSPM how to communicate with the acpi-erst device.
--- hw/acpi/erst.c | 188 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 188 insertions(+)
hw/acpi/erst.c +188 -0
@@ -59,6 +59,27 @@#define STATUS_RECORD_STORE_EMPTY 0x04#define STATUS_RECORD_NOT_FOUND 0x05 +/* ACPI 4.0: Table 17-19 Serialization Instructions */ +#define INST_READ_REGISTER 0x00 +#define INST_READ_REGISTER_VALUE 0x01 +#define INST_WRITE_REGISTER 0x02 +#define INST_WRITE_REGISTER_VALUE 0x03 +#define INST_NOOP 0x04 +#define INST_LOAD_VAR1 0x05 +#define INST_LOAD_VAR2 0x06 +#define INST_STORE_VAR1 0x07 +#define INST_ADD 0x08 +#define INST_SUBTRACT 0x09 +#define INST_ADD_VALUE 0x0A +#define INST_SUBTRACT_VALUE 0x0B +#define INST_STALL 0x0C +#define INST_STALL_WHILE_TRUE 0x0D +#define INST_SKIP_NEXT_INSTRUCTION_IF_TRUE 0x0E +#define INST_GOTO 0x0F +#define INST_SET_SRC_ADDRESS_BASE 0x10 +#define INST_SET_DST_ADDRESS_BASE 0x11 +#define INST_MOVE_DATA 0x12 +/* UEFI 2.1: Appendix N Common Platform Error Record */ #define UEFI_CPER_RECORD_MIN_SIZE 128U#define UEFI_CPER_RECORD_LENGTH_OFFSET 20U
@@ -172,6 +193,173 @@ typedef struct {/*******************************************************************/ /*******************************************************************/ + +/* ACPI 4.0: 17.4.1.2 Serialization Instruction Entries */ +static void build_serialization_instruction_entry (GArray *table_data, +uint8_t serialization_action, +uint8_t instruction, +uint8_t flags, +uint8_t register_bit_width, +uint64_t register_address, +uint64_t value) +{ +/* ACPI 4.0: Table 17-18 Serialization Instruction Entry */ +struct AcpiGenericAddress gas; +uint64_t mask; + +/* Serialization Action */ +build_append_int_noprefix (table_data, serialization_action,1 ); +/* Instruction */ +build_append_int_noprefix (table_data, instruction ,1 ); +/* Flags */ +build_append_int_noprefix (table_data, flags ,1 ); +/* Reserved */ +build_append_int_noprefix (table_data,0 ,1 ); +/* Register Region */ + gas.space_id =AML_SYSTEM_MEMORY ; + gas.bit_width = register_bit_width; + gas.bit_offset =0 ; + gas.access_width =ctz32 (register_bit_width) -2 ; + gas.address = register_address; +build_append_gas_from_struct (table_data, &gas); +/* Value */ +build_append_int_noprefix (table_data, value ,8 ); +/* Mask */ + mask = (1ULL << (register_bit_width -1 ) <<1 ) -1 ; +build_append_int_noprefix (table_data, mask ,8 ); +} + +/* ACPI 4.0: 17.4.1 Serialization Action Table */ +void build_erst (GArray *table_data,BIOSLinker *linker,Object *erst_dev, +const char *oem_id,const char *oem_table_id) +{ +GArray *table_instruction_data; +unsigned action; +pcibus_t bar0 =pci_get_bar_addr (PCI_DEVICE (erst_dev),0 ); +AcpiTable table = { .sig ="ERST" , .rev =1 , .oem_id = oem_id, + .oem_table_id = oem_table_id }; + +trace_acpi_erst_pci_bar_0 (bar0); + +/* +* Serialization Action Table +* The serialization action table must be generated first +* so that its size can be known in order to populate the +* Instruction Entry Count field. +*/ + table_instruction_data =g_array_new (FALSE, FALSE,sizeof (char )); + +/* +* Macros for use with construction of the action instructions +*/ +#define BUILD_READ_REGISTER (width_in_bits, reg) \ + build_serialization_instruction_entry(table_instruction_data, \ + action, INST_READ_REGISTER, 0, width_in_bits, \ + bar0 + reg, 0) + +#define BUILD_READ_REGISTER_VALUE (width_in_bits, reg, value) \ + build_serialization_instruction_entry(table_instruction_data, \ + action, INST_READ_REGISTER_VALUE, 0, width_in_bits, \ + bar0 + reg, value) + +#define BUILD_WRITE_REGISTER (width_in_bits, reg, value) \ + build_serialization_instruction_entry(table_instruction_data, \ + action, INST_WRITE_REGISTER, 0, width_in_bits, \ + bar0 + reg, value) + +#define BUILD_WRITE_REGISTER_VALUE (width_in_bits, reg, value) \ + build_serialization_instruction_entry(table_instruction_data, \ + action, INST_WRITE_REGISTER_VALUE, 0, width_in_bits, \ + bar0 + reg, value) + +/* Serialization Instruction Entries */ + action =ACTION_BEGIN_WRITE_OPERATION ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); + + action =ACTION_BEGIN_READ_OPERATION ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); + + action =ACTION_BEGIN_CLEAR_OPERATION ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); + + action =ACTION_END_OPERATION ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); + + action =ACTION_SET_RECORD_OFFSET ; +BUILD_WRITE_REGISTER (32 ,ERST_VALUE_OFFSET ,0 ); +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); + + action =ACTION_EXECUTE_OPERATION ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_VALUE_OFFSET , +ERST_EXECUTE_OPERATION_MAGIC ); +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); + + action =ACTION_CHECK_BUSY_STATUS ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); +BUILD_READ_REGISTER_VALUE (32 ,ERST_VALUE_OFFSET ,0x01 ); + + action =ACTION_GET_COMMAND_STATUS ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); +BUILD_READ_REGISTER (32 ,ERST_VALUE_OFFSET ); + + action =ACTION_GET_RECORD_IDENTIFIER ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); +BUILD_READ_REGISTER (64 ,ERST_VALUE_OFFSET ); + + action =ACTION_SET_RECORD_IDENTIFIER ; +BUILD_WRITE_REGISTER (64 ,ERST_VALUE_OFFSET ,0 ); +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); + + action =ACTION_GET_RECORD_COUNT ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); +BUILD_READ_REGISTER (32 ,ERST_VALUE_OFFSET ); + + action =ACTION_BEGIN_DUMMY_WRITE_OPERATION ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); + + action =ACTION_GET_ERROR_LOG_ADDRESS_RANGE ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); +BUILD_READ_REGISTER (64 ,ERST_VALUE_OFFSET ); + + action =ACTION_GET_ERROR_LOG_ADDRESS_LENGTH ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); +BUILD_READ_REGISTER (64 ,ERST_VALUE_OFFSET ); + + action =ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); +BUILD_READ_REGISTER (32 ,ERST_VALUE_OFFSET ); + + action =ACTION_GET_EXECUTE_OPERATION_TIMINGS ; +BUILD_WRITE_REGISTER_VALUE (32 ,ERST_ACTION_OFFSET , action); +BUILD_READ_REGISTER (64 ,ERST_VALUE_OFFSET ); + +/* Serialization Header */ +acpi_table_begin (&table, table_data); + +/* Serialization Header Size */ +build_append_int_noprefix (table_data,48 ,4 ); + +/* Reserved */ +build_append_int_noprefix (table_data,0 ,4 ); + +/* +* Instruction Entry Count +* Each instruction entry is 32 bytes +*/ +g_assert ((table_instruction_data->len) %32 ==0 ); +build_append_int_noprefix (table_data, + (table_instruction_data->len /32 ),4 ); + +/* Serialization Instruction Entries */ +g_array_append_vals (table_data, table_instruction_data->data, + table_instruction_data->len); +g_array_free (table_instruction_data, TRUE); + +acpi_table_end (linker, &table); +} + +/*******************************************************************/ +/*******************************************************************/ static uint8_t *get_nvram_ptr_by_index (ERSTDeviceState *s,unsigned index) {uint8_t *rc =NULL ;
Signature · 1 line
1.8.3.1