acpi: Error Record Serialization Table, ERST, support for QEMU
v6 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.txt, which is patch 2/10.
---
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 (10):
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
ACPI ERST: step 6 of bios-tables-test
docs/specs/acpi_erst.txt | 147 ++++++ hw/acpi/erst.c | 989 ++++++++++++++++++++++++++++++++++++++ hw/acpi/meson.build | 1 + hw/acpi/trace-events | 15 + hw/i386/acpi-build.c | 9 + hw/i386/acpi-microvm.c | 9 + include/hw/acpi/erst.h | 24 + include/hw/pci/pci.h | 1 + tests/data/acpi/microvm/ERST | 0 tests/data/acpi/microvm/ERST.pcie | Bin 0 -> 912 bytes tests/data/acpi/pc/DSDT | Bin 6002 -> 6009 bytes tests/data/acpi/pc/ERST | Bin 0 -> 912 bytes tests/data/acpi/q35/DSDT | Bin 8289 -> 8306 bytes tests/data/acpi/q35/ERST | Bin 0 -> 912 bytes tests/qtest/bios-tables-test.c | 43 ++ tests/qtest/erst-test.c | 167 +++++++ tests/qtest/meson.build | 2 + 17 files changed, 1407 insertions(+) create mode 100644 docs/specs/acpi_erst.txt create mode 100644 hw/acpi/erst.c create mode 100644 include/hw/acpi/erst.h create mode 100644 tests/data/acpi/microvm/ERST create mode 100644 tests/data/acpi/microvm/ERST.pcie create mode 100644 tests/data/acpi/pc/ERST create mode 100644 tests/data/acpi/q35/ERST create mode 100644 tests/qtest/erst-test.c
Signature · 1 line
1.8.3.1
PATCH v6 1/10 ACPI ERST: bios-tables-test.c steps 1 and 2
Following 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 | 0 tests/data/acpi/pc/ERST | 0 tests/data/acpi/q35/ERST | 0 tests/qtest/bios-tables-test-allowed-diff.h | 6 ++++++ 4 files changed, 6 insertions(+) create mode 100644 tests/data/acpi/microvm/ERST create mode 100644 tests/data/acpi/pc/ERST create mode 100644 tests/data/acpi/q35/ERST
tests/data/acpi/microvm/ERST new file +0 -0
tests/data/acpi/pc/ERST new file +0 -0
tests/data/acpi/q35/ERST new file +0 -0
tests/qtest/bios-tables-test-allowed-diff.h +6 -0
@@ -1 +1,7 @@/* List of comma-separated changed AML files to ignore */ +"tests/data/acpi/pc/ERST" , +"tests/data/acpi/q35/ERST" , +"tests/data/acpi/microvm/ERST" , +"tests/data/acpi/pc/DSDT" , +"tests/data/acpi/q35/DSDT" , +"tests/data/acpi/microvm/DSDT",
Signature · 1 line
1.8.3.1
Re: [PATCH v6 01/10] ACPI ERST: bios-tables-test.c steps 1 and 2
Quoted 5 lines · On Thu, 5 Aug 2021 18:30:30 -0400 Eric DeVolder <[email protected]>…
Following 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 inbios-tables-test-allowed-diff.hper step 2.
I'd move this right before 10/10
Quoted 1 line
Signed-off-by Eric DeVolder <[email protected]>
Quoted 31 lines
--- tests/data/acpi/microvm/ERST | 0 tests/data/acpi/pc/ERST | 0 tests/data/acpi/q35/ERST | 0 tests/qtest/bios-tables-test-allowed-diff.h | 6 ++++++ 4 files changed, 6 insertions(+) create mode 100644 tests/data/acpi/microvm/ERST create mode 100644 tests/data/acpi/pc/ERST create mode 100644 tests/data/acpi/q35/ERSTtests/data/acpi/microvm/ERST new file +0
-0tests/data/acpi/pc/ERST new file +0
-0tests/data/acpi/q35/ERST new file +0
-0tests/qtest/bios-tables-test-allowed-diff.h +6
-0@@ -1 +1,7 @@/* List of comma-separated changed AML files to ignore */ +"tests/data/acpi/pc/ERST" , +"tests/data/acpi/q35/ERST" , +"tests/data/acpi/microvm/ERST" , +"tests/data/acpi/pc/DSDT" , +"tests/data/acpi/q35/DSDT" , +"tests/data/acpi/microvm/DSDT",
Re: [PATCH v6 01/10] ACPI ERST: bios-tables-test.c steps 1 and 2
Quoted 10 lines · Igor Mammedov
Quoted 5 lines · On Thu, 5 Aug 2021 18:30:30 -0400 Eric DeVolder <[email protected]>…
Following 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 inbios-tables-test-allowed-diff.hper step 2.I'd move this right before 10/10
done
Quoted 38 lines
Quoted 2 lines
Signed-off-by Eric DeVolder <[email protected]>Acked-by Igor Mammedov <[email protected]>Quoted 31 lines
--- tests/data/acpi/microvm/ERST | 0 tests/data/acpi/pc/ERST | 0 tests/data/acpi/q35/ERST | 0 tests/qtest/bios-tables-test-allowed-diff.h | 6 ++++++ 4 files changed, 6 insertions(+)create mode 100644 tests/data/acpi/microvm/ERST
create mode 100644 tests/data/acpi/pc/ERST
create mode 100644 tests/data/acpi/q35/ERSTtests/data/acpi/microvm/ERST new file +0
-0tests/data/acpi/pc/ERST new file +0
-0tests/data/acpi/q35/ERST new file +0
-0tests/qtest/bios-tables-test-allowed-diff.h +6
-0@@ -1 +1,7 @@/* List of comma-separated changed AML files to ignore */ +"tests/data/acpi/pc/ERST" , +"tests/data/acpi/q35/ERST" , +"tests/data/acpi/microvm/ERST" , +"tests/data/acpi/pc/DSDT" , +"tests/data/acpi/q35/DSDT" , +"tests/data/acpi/microvm/DSDT",
PATCH v6 2/10 ACPI ERST: specification for ERST support
In reply to Eric DeVolderInformation on the implementation of the ACPI ERST support.
--- docs/specs/acpi_erst.txt | 147 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) create mode 100644 docs/specs/acpi_erst.txt
docs/specs/acpi_erst.txt new file +147 -0
@@ -0,0 +1,147 @@ +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), 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. + + +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 is reserved for 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 reserved to be a part of the slot 0 header. For example, at 8KiB, +the slot 0 header can accomodate 1024 records. Thus a storage size +above 8MiB (8KiB * 1024) requires an additional slot. 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 + +--------------------------------------------+ + 0 | reserved: storage header | + +--------------------------------------------+ + 1 | empty/available | + +--------------------------------------------+ + 2 | CPER | + +--------------------------------------------+ + 3 | CPER | + +--------------------------------------------+ + ... | | + +--------------------------------------------+ + N | empty/available | + +--------------------------------------------+ + <------------------ 8KiB --------------------> + + + +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
Re: [PATCH v6 02/10] ACPI ERST: specification for ERST support
Quoted 3 lines · On Thu, 5 Aug 2021 18:30:31 -0400 Eric DeVolder <[email protected]>…
Information on the implementation of the ACPI ERST support.
Signed-off-by Eric DeVolder <[email protected]>
modulo missing parts documentation looks good to but I'm tainted at this point (after so many reviews) so libvirt folks (CCed) can take look at it and see if something needs to be changed here.
Quoted 122 lines
--- docs/specs/acpi_erst.txt | 147 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) create mode 100644 docs/specs/acpi_erst.txtdocs/specs/acpi_erst.txt new file +111
-0@@ -0,0 +1,147 @@ +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), 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. + + +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 is reserved for 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 reserved to be a part of the slot 0 header. For example, at 8KiB, +the slot 0 header can accomodate 1024 records. Thus a storage size +above 8MiB (8KiB * 1024) requires an additional slot. In this +scenario, slot 0 and slot 1 form the backend storage header, and +records can be stored starting at slot 2.
docs/specs/acpi_erst.txt line 121
Quoted 10 lines
docs/specs/acpi_erst.txt new file +10
-0+ +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 + +--------------------------------------------+ + 0 | reserved: storage header |
typically reserved means 'not used', so I'd drop mentioning reserved an leave it just as storage header.
Also header format should be described here
docs/specs/acpi_erst.txt line 126
Quoted 5 lines
docs/specs/acpi_erst.txt new file +5
-0+ +--------------------------------------------+ + 1 | empty/available | + +--------------------------------------------+ + 2 | CPER | + +--------------------------------------------+
how can one distinguish empty vs used slots (i.e define empty somewhere here)
Quoted 21 lines
docs/specs/acpi_erst.txt new file +21
-0+ 3 | CPER | + +--------------------------------------------+ + ... | | + +--------------------------------------------+ + N | empty/available | + +--------------------------------------------+ + <------------------ 8KiB --------------------> + + + +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".
Re: [PATCH v6 02/10] ACPI ERST: specification for ERST support
Quoted 11 lines · Igor Mammedov
Quoted 3 lines · On Thu, 5 Aug 2021 18:30:31 -0400 Eric DeVolder <[email protected]>…
Information on the implementation of the ACPI ERST support.
Signed-off-by Eric DeVolder <[email protected]>modulo missing parts documentation looks good to but I'm tainted at this point (after so many reviews) so libvirt folks (CCed) can take look at it and see if something needs to be changed here.
OK. I'll wait for Daniel's feedback before posting v7.
Quoted 128 lines
Quoted 128 lines
--- docs/specs/acpi_erst.txt | 147 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+)create mode 100644
docs/specs/acpi_erst.txtdocs/specs/acpi_erst.txt new file +116
-0@@ -0,0 +1,147 @@ +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), 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. + + +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 is reserved for 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 reserved to be a part of the slot 0 header. For example, at 8KiB, +the slot 0 header can accomodate 1024 records. Thus a storage size +above 8MiB (8KiB * 1024) requires an additional slot. 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
Quoted 8 lines
docs/specs/acpi_erst.txt line 121
Quoted 5 lines
docs/specs/acpi_erst.txt new file +5
-0+remaining slots are empty/available. + + Slot Record + +--------------------------------------------+ + 0 | reserved: storage header |typically reserved means 'not used', so I'd drop mentioning reserved an leave it just as storage header.
done
Quoted 2 lines
Also header format should be described here
done
Quoted 8 lines
docs/specs/acpi_erst.txt line 126
Quoted 6 lines
docs/specs/acpi_erst.txt new file +5
-0+ +--------------------------------------------+ + 1 | empty/available | + +--------------------------------------------+ + 2 | CPER | + +--------------------------------------------+how can one distinguish empty vs used slots (i.e define empty somewhere here)
done; explained in v7.
Quoted 23 lines
Quoted 22 lines
docs/specs/acpi_erst.txt new file +21
-0+ 3 | CPER | + +--------------------------------------------+ + ... | | + +--------------------------------------------+ + N | empty/available | + +--------------------------------------------+ + <------------------ 8KiB --------------------> + + + +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".
Re: [PATCH] ACPI ERST: specification for ERST support
In reply to Eric DeVolderFrom: Eric DeVolder <[email protected]>
Quoted 5 lines
---
docs/specs/acpi_erst.txt| 147 +++++++++++++++++++++++++++++++++++++++1 file changed, 147 insertions(+)create mode 100644
docs/specs/acpi_erst.txt
Ani Sinha
Acked-byRe: [PATCH] ACPI ERST: specification for ERST support
Quoted 7 lines · Ani Sinha
From: Eric DeVolder <[email protected]>
Quoted 5 lines
---
docs/specs/acpi_erst.txt| 147 +++++++++++++++++++++++++++++++++++++++1 file changed, 147 insertions(+)create mode 100644
docs/specs/acpi_erst.txt
OK it did not come out the way I wanted. But
Re: [PATCH] ACPI ERST: specification for ERST support
Quoted 12 lines · Ani Sinha
Quoted 7 lines · Ani Sinha
From: Eric DeVolder <[email protected]>
Quoted 5 lines
---
docs/specs/acpi_erst.txt| 147 +++++++++++++++++++++++++++++++++++++++1 file changed, 147 insertions(+)create mode 100644
docs/specs/acpi_erst.txt
Quoted 4 lines
OK it did not come out the way I wanted. But
Acked-by Ani Sinha <[email protected]>
thank you!
eric
Re: [PATCH] ACPI ERST: specification for ERST support
Quoted 15 lines · Eric DeVolder
Quoted 12 lines · Ani Sinha
Quoted 7 lines · Ani Sinha
From: Eric DeVolder <[email protected]>
Quoted 5 lines
---
docs/specs/acpi_erst.txt| 147 +++++++++++++++++++++++++++++++++++++++1 file changed, 147 insertions(+)create mode 100644
docs/specs/acpi_erst.txt
Quoted 5 lines
Quoted 4 lines
OK it did not come out the way I wanted. But
Acked-by Ani Sinha <[email protected]>thank you!
So this patchset was sent when I was still not in MAINTAINERS file. Hence I was not on the CC list. Its a little hard to send reviews when the patches are not in my inbox (this resulted in the mess above). So if you have pending updates to the patch series, maybe you can spin out a new revision and I can review it more comfortably (this time hopefully I will be on the cc list).
Re: [PATCH v6 02/10] ACPI ERST: specification for ERST support
In reply to Eric DeVolderQuoted 7 lines · Eric DeVolder
Information on the implementation of the ACPI ERST support.
Signed-off-by Eric DeVolder <[email protected]>--- docs/specs/acpi_erst.txt | 147 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) create mode 100644 docs/specs/acpi_erst.txt
It's probably a good idea to have new documents in the rst format.
Signature · 1 line
MST
Re: [PATCH v6 02/10] ACPI ERST: specification for ERST support
Quoted 12 lines · Michael S. Tsirkin
Quoted 7 lines · Eric DeVolder
Information on the implementation of the ACPI ERST support.
Signed-off-by Eric DeVolder <[email protected]>--- docs/specs/acpi_erst.txt | 147 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+)create mode 100644
docs/specs/acpi_erst.txtIt's probably a good idea to have new documents in the rst format.
done!
PATCH v6 3/10 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
Re: [PATCH v6 03/10] ACPI ERST: PCI device_id for ERST
Quoted 4 lines · On Thu, 5 Aug 2021 18:30:32 -0400 Eric DeVolder <[email protected]>…
This change reserves the PCI
device_idfor the new ACPI ERST device.Signed-off-by Eric DeVolder <[email protected]>
Quoted 16 lines
--- 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
PATCH v6 4/10 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 v6 5/10 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/erst.c | 750 +++++++++++++++++++++++++++++++++++++++++++++++++++ hw/acpi/meson.build | 1 + hw/acpi/trace-events | 15 ++ 3 files changed, 766 insertions(+) create mode 100644 hw/acpi/erst.c
hw/acpi/erst.c new file +750 -0
@@ -0,0 +1,750 @@ +/* +* 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 +*/ + +#include <sys/types.h> +#include <sys/stat.h> +#include <unistd.h> + +#include "qemu/osdep.h" +#include "qapi/error.h" +#include "hw/qdev-core.h" +#include "exec/memory.h" +#include "qom/object.h" +#include "hw/pci/pci.h" +#include "qom/object_interfaces.h" +#include "qemu/error-report.h" +#include "migration/vmstate.h" +#include "hw/qdev-properties.h" +#include "hw/acpi/acpi.h" +#include "hw/acpi/acpi-defs.h" +#include "hw/acpi/aml-build.h" +#include "hw/acpi/bios-linker-loader.h" +#include "exec/address-spaces.h" +#include "sysemu/hostmem.h" +#include "hw/acpi/erst.h" +#include "trace.h" + +/* ACPI 4.0: Table 17-16 Serialization Actions */ +#define ACTION_BEGIN_WRITE_OPERATION 0x0 +#define ACTION_BEGIN_READ_OPERATION 0x1 +#define ACTION_BEGIN_CLEAR_OPERATION 0x2 +#define ACTION_END_OPERATION 0x3 +#define ACTION_SET_RECORD_OFFSET 0x4 +#define ACTION_EXECUTE_OPERATION 0x5 +#define ACTION_CHECK_BUSY_STATUS 0x6 +#define ACTION_GET_COMMAND_STATUS 0x7 +#define ACTION_GET_RECORD_IDENTIFIER 0x8 +#define ACTION_SET_RECORD_IDENTIFIER 0x9 +#define ACTION_GET_RECORD_COUNT 0xA +#define ACTION_BEGIN_DUMMY_WRITE_OPERATION 0xB +#define ACTION_RESERVED 0xC +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE 0xD +#define ACTION_GET_ERROR_LOG_ADDRESS_LENGTH 0xE +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0xF +#define ACTION_GET_EXECUTE_OPERATION_TIMINGS 0x10 + +/* ACPI 4.0: Table 17-17 Command Status Definitions */ +#define STATUS_SUCCESS 0x00 +#define STATUS_NOT_ENOUGH_SPACE 0x01 +#define STATUS_HARDWARE_NOT_AVAILABLE 0x02 +#define STATUS_FAILED 0x03 +#define STATUS_RECORD_STORE_EMPTY 0x04 +#define STATUS_RECORD_NOT_FOUND 0x05 + + +/* UEFI 2.1: Appendix N Common Platform Error Record */ +#define UEFI_CPER_RECORD_MIN_SIZE 128U +#define UEFI_CPER_RECORD_LENGTH_OFFSET 20U +#define UEFI_CPER_RECORD_ID_OFFSET 96U +#define IS_UEFI_CPER_RECORD (ptr) \ + (((ptr)[0] == 'C') && \ + ((ptr)[1] == 'P') && \ + ((ptr)[2] == 'E') && \ + ((ptr)[3] == 'R')) +#define THE_UEFI_CPER_RECORD_ID (ptr) \ + (*(uint64_t *)(&(ptr)[UEFI_CPER_RECORD_ID_OFFSET])) + +/* +* This implementation is an ACTION (cmd) and VALUE (data) +* interface consisting of just two 64-bit registers. +*/ +#define ERST_REG_SIZE (16UL) +#define ERST_ACTION_OFFSET (0UL)/* action (cmd) */ +#define ERST_VALUE_OFFSET (8UL)/* argument/value (data) */ + +/* +* ERST_RECORD_SIZE is the buffer size for exchanging ERST +* record contents. Thus, it defines the maximum record size. +* As this is mapped through a PCI BAR, it must be a power of +* two and larger than UEFI_CPER_RECORD_MIN_SIZE. +* The backing storage is divided into fixed size "slots", +* each ERST_RECORD_SIZE in length, and each "slot" +* storing a single record. No attempt at optimizing storage +* through compression, compaction, etc is attempted. +* NOTE that slot 0 is reserved for the backing storage header. +* Depending upon the size of the backing storage, additional +* slots will be part of the slot 0 header in order to account +* for a record_id for each available remaining slot. +*/ +/* 8KiB records, not too small, not too big */ +#define ERST_RECORD_SIZE (8192UL) + +#define ACPI_ERST_MEMDEV_PROP "memdev" + +/* +* From the ACPI ERST spec sections: +* A record id of all 0s is used to indicate +* 'unspecified' record id. +* A record id of all 1s is used to indicate +* empty or end. +*/ +#define ERST_UNSPECIFIED_RECORD_ID (0UL) +#define ERST_EMPTY_END_RECORD_ID (~0UL) +#define ERST_EXECUTE_OPERATION_MAGIC 0x9CUL +#define ERST_IS_VALID_RECORD_ID (rid) \ + ((rid != ERST_UNSPECIFIED_RECORD_ID) && \ + (rid != ERST_EMPTY_END_RECORD_ID)) + +typedef struct erst_storage_header_s { +#define ERST_STORE_MAGIC 0x524F545354535245UL +uint64_t magic; +uint32_t record_size; +uint32_t record_offset;/* offset to record storage beyond header */ +uint16_t version; +uint16_t reserved; +uint32_t record_count; +uint64_t map[];/* contains record_ids, and position indicates index */ +}erst_storage_header_t ; + +/* +* Object cast macro +*/ +#define ACPIERST (obj) \ + OBJECT_CHECK(ERSTDeviceState, (obj), TYPE_ACPI_ERST) + +/* +* Main ERST device state structure +*/ +typedef struct { +PCIDevice parent_obj; + +/* Backend storage */ +HostMemoryBackend *hostmem; +MemoryRegion *hostmem_mr; + +/* Programming registers */ +MemoryRegion iomem; + +/* Exchange buffer */ +Object *exchange_obj; +HostMemoryBackend *exchange; +MemoryRegion *exchange_mr; +uint32_t storage_size; + +/* Interface state */ +uint8_t operation; +uint8_t busy_status; +uint8_t command_status; +uint32_t record_offset; +uint64_t reg_action; +uint64_t reg_value; +uint64_t record_identifier; +erst_storage_header_t *header; +unsigned next_record_index; +unsigned first_record_index; +unsigned last_record_index; + +}ERSTDeviceState ; + +/*******************************************************************/ +/*******************************************************************/ + +static uint8_t *get_nvram_ptr_by_index (ERSTDeviceState *s,unsigned index) +{ +uint8_t *rc =NULL ; +off_t offset = (index *ERST_RECORD_SIZE ); +if ((offset +ERST_RECORD_SIZE ) <= s->storage_size) { +if (s->hostmem_mr) { +uint8_t *p = (uint8_t *)memory_region_get_ram_ptr (s->hostmem_mr); + rc = p + offset; + } + } +return rc; +} + +static void make_erst_storage_header (ERSTDeviceState *s) +{ +erst_storage_header_t *header = s->header; +unsigned mapsz, headersz; + + header->magic =ERST_STORE_MAGIC ; + header->record_size =ERST_RECORD_SIZE ; + header->version =0x0101 ; + header->reserved =0x0000 ; + +/* Compute mapsize */ + mapsz = s->storage_size /ERST_RECORD_SIZE ; + mapsz *=sizeof (uint64_t ); +/* Compute header+map size */ + headersz =sizeof (erst_storage_header_t) + mapsz; +/* Round up to nearest integer multiple of ERST_RECORD_SIZE */ + headersz += (ERST_RECORD_SIZE -1 ); + headersz /=ERST_RECORD_SIZE ; + headersz *=ERST_RECORD_SIZE ; + header->record_offset = headersz; + +/* +* The HostMemoryBackend initializes contents to zero, +* so all record_ids stashed in the map are zero'd. +* As well the record_count is zero. Properly initialized. +*/ +} + +static void check_erst_backend_storage (ERSTDeviceState *s,Error **errp) +{ +erst_storage_header_t *header; + + header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 ); + s->header = header; + +/* Check if header is uninitialized */ +if (header->magic ==0UL ) {/* HostMemoryBackend inits to 0 */ +make_erst_storage_header (s); + } + +if (!( + (header->magic ==ERST_STORE_MAGIC ) && + (header->record_size ==ERST_RECORD_SIZE ) && + ((header->record_offset %ERST_RECORD_SIZE ) ==0 ) && + (header->version ==0x0101 ) && + (header->reserved ==0x0000 ) + )) { +error_setg (errp,"ERST backend storage header is invalid" ); + } + +/* Compute offset of first and last record storage slot */ + s->first_record_index = header->record_offset /ERST_RECORD_SIZE ; + s->last_record_index = (s->storage_size /ERST_RECORD_SIZE ); +} + +static void set_erst_map_by_index (ERSTDeviceState *s,unsigned index, +uint64_t record_id) +{ +if (index < s->last_record_index) { + s->header->map[index] = record_id; + } +} + +static unsigned lookup_erst_record (ERSTDeviceState *s, +uint64_t record_identifier) +{ +unsigned rc =0 ;/* 0 not a valid index */ +unsigned index = s->first_record_index; + +/* Find the record_identifier in the map */ +if (record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* +* Count number of valid records encountered, and +* short-circuit the loop if identifier not found +*/ +unsigned count =0 ; +for (; index < s->last_record_index && + count < s->header->record_count; ++index) { +uint64_t map_record_identifier = s->header->map[index]; +if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { + ++count; + } +if (map_record_identifier == record_identifier) { + rc = index; +break ; + } + } + }else { +/* Find first available unoccupied slot */ +for (; index < s->last_record_index; ++index) { +if (s->header->map[index] ==ERST_UNSPECIFIED_RECORD_ID ) { + rc = index; +break ; + } + } + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.3 Operations - Clearing */ +static unsigned clear_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +/* No need to wipe record, just invalidate its map entry */ +set_erst_map_by_index (s, index,ERST_UNSPECIFIED_RECORD_ID ); + s->header->record_count -=1 ; + rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.2 Operations - Reading */ +static unsigned read_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check record boundary wihin exchange buffer */ +if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + } + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +uint8_t *ptr; +uint8_t *record = ((uint8_t *) +memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + ptr =get_nvram_ptr_by_index (s, index); +memcpy (record, ptr,ERST_RECORD_SIZE - s->record_offset); + rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.1 Operations - Writing */ +static unsigned write_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_FAILED ; +unsigned index; +uint64_t record_identifier; +uint8_t *record; +uint8_t *ptr =NULL ; +bool record_found = false; + +/* Check record boundary wihin exchange buffer */ +if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + } + +/* Extract record identifier */ + record = ((uint8_t *)memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + record_identifier =THE_UEFI_CPER_RECORD_ID (record); + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, record_identifier); +if (index) { +/* Record found, overwrite existing record */ + ptr =get_nvram_ptr_by_index (s, index); + record_found = true; + }else { +/* Record not found, not an overwrite, allocate for write */ + index =lookup_erst_record (s,ERST_UNSPECIFIED_RECORD_ID ); +if (index) { + ptr =get_nvram_ptr_by_index (s, index); + }else { + rc =STATUS_NOT_ENOUGH_SPACE ; + } + } +if (ptr) { +memcpy (ptr, record,ERST_RECORD_SIZE - s->record_offset); +if (0 != s->record_offset) { +memset (&ptr[ERST_RECORD_SIZE - s->record_offset], +0xFF , s->record_offset); + } +if (!record_found) { + s->header->record_count +=1 ;/* writing new record */ + } +set_erst_map_by_index (s, index, record_identifier); + rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.2 Operations - Reading "During boot..." */ +static unsigned next_erst_record (ERSTDeviceState *s, +uint64_t *record_identifier) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index = s->next_record_index; + + *record_identifier =ERST_EMPTY_END_RECORD_ID ; + +if (s->header->record_count) { +for (; index < s->last_record_index; ++index) { +uint64_t map_record_identifier; + map_record_identifier = s->header->map[index]; +if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* where to start next time */ + s->next_record_index = index +1 ; + *record_identifier = map_record_identifier; + rc =STATUS_SUCCESS ; +break ; + } + } + } +if (rc !=STATUS_SUCCESS ) { +if (s->next_record_index == s->first_record_index) { +/* +* next_record_identifier is unchanged, no records found +* and *record_identifier contains EMPTY_END id +*/ + rc =STATUS_RECORD_STORE_EMPTY ; + } +/* at end/scan complete, reset */ + s->next_record_index = s->first_record_index; + } + +return rc; +} + +/*******************************************************************/ + +static uint64_t erst_rd_reg64 (hwaddr addr, +uint64_t reg,unsigned size) +{ +uint64_t rdval; +uint64_t mask; +unsigned shift; + +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + rdval = reg; + rdval >>= shift; + rdval &= mask; + +return rdval; +} + +static uint64_t erst_wr_reg64 (hwaddr addr, +uint64_t reg,uint64_t val,unsigned size) +{ +uint64_t wrval; +uint64_t mask; +unsigned shift; + +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + val &= mask; + val <<= shift; + mask <<= shift; + wrval = reg; + wrval &= ~mask; + wrval |= val; + +return wrval; +} + +static void erst_reg_write (void *opaque,hwaddr addr, +uint64_t val,unsigned size) +{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; + +/* +* NOTE: All actions/operations/side effects happen on the WRITE, +* by design. The READs simply return the reg_value contents. +*/ +trace_acpi_erst_reg_write (addr, val, size); + +switch (addr) { +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + s->reg_value =erst_wr_reg64 (addr, s->reg_value, val, size); +break ; +case ERST_ACTION_OFFSET +0 : +/* case ERST_ACTION_OFFSET+4: as coded, not really a 64b register */ +switch (val) { +case ACTION_BEGIN_WRITE_OPERATION : +case ACTION_BEGIN_READ_OPERATION : +case ACTION_BEGIN_CLEAR_OPERATION : +case ACTION_BEGIN_DUMMY_WRITE_OPERATION : +case ACTION_END_OPERATION : + s->operation = val; +break ; +case ACTION_SET_RECORD_OFFSET : + s->record_offset = s->reg_value; +break ; +case ACTION_EXECUTE_OPERATION : +if ((uint8_t )s->reg_value ==ERST_EXECUTE_OPERATION_MAGIC ) { + s->busy_status =1 ; +switch (s->operation) { +case ACTION_BEGIN_WRITE_OPERATION : + s->command_status =write_erst_record (s); +break ; +case ACTION_BEGIN_READ_OPERATION : + s->command_status =read_erst_record (s); +break ; +case ACTION_BEGIN_CLEAR_OPERATION : + s->command_status =clear_erst_record (s); +break ; +case ACTION_BEGIN_DUMMY_WRITE_OPERATION : + s->command_status =STATUS_SUCCESS ; +break ; +case ACTION_END_OPERATION : + s->command_status =STATUS_SUCCESS ; +break ; +default : + s->command_status =STATUS_FAILED ; +break ; + } + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ; + s->busy_status =0 ; + } +break ; +case ACTION_CHECK_BUSY_STATUS : + s->reg_value = s->busy_status; +break ; +case ACTION_GET_COMMAND_STATUS : + s->reg_value = s->command_status; +break ; +case ACTION_GET_RECORD_IDENTIFIER : + s->command_status =next_erst_record (s, &s->reg_value); +break ; +case ACTION_SET_RECORD_IDENTIFIER : + s->record_identifier = s->reg_value; +break ; +case ACTION_GET_RECORD_COUNT : + s->reg_value = s->header->record_count; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE : + s->reg_value = (hwaddr )pci_get_bar_addr (PCI_DEVICE (s),1 ); +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_LENGTH : + s->reg_value =ERST_RECORD_SIZE ; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES : + s->reg_value =0x0 ;/* intentional, not NVRAM mode */ +break ; +case ACTION_GET_EXECUTE_OPERATION_TIMINGS : + s->reg_value = + (100ULL <<32 ) |/* 100us max time */ + (10ULL <<0 ) ;/* 10us min time */ +break ; +default : +/* Unknown action/command, NOP */ +break ; + } +break ; +default : +/* This should not happen, but if it does, NOP */ +break ; + } +} + +static uint64_t erst_reg_read (void *opaque,hwaddr addr, +unsigned size) +{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; +uint64_t val =0 ; + +switch (addr) { +case ERST_ACTION_OFFSET +0 : +case ERST_ACTION_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_action, size); +break ; +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_value, size); +break ; +default : +break ; + } +trace_acpi_erst_reg_read (addr, val, size); +return val; +} + +static const MemoryRegionOps erst_reg_ops = { + .read = erst_reg_read, + .write = erst_reg_write, + .endianness =DEVICE_NATIVE_ENDIAN , +}; + +/*******************************************************************/ +/*******************************************************************/ +static int erst_post_load (void *opaque,int version_id) +{ +ERSTDeviceState *s = opaque; + +/* Recompute pointer to header */ + s->header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 ); +trace_acpi_erst_post_load (s->header); + +return 0 ; +} + +static const VMStateDescription erst_vmstate = { + .name ="acpi-erst" , + .version_id =1 , + .minimum_version_id =1 , + .post_load = erst_post_load, + .fields = (VMStateField []) { +VMSTATE_UINT32 (storage_size, ERSTDeviceState), +VMSTATE_UINT8 (operation, ERSTDeviceState), +VMSTATE_UINT8 (busy_status, ERSTDeviceState), +VMSTATE_UINT8 (command_status, ERSTDeviceState), +VMSTATE_UINT32 (record_offset, ERSTDeviceState), +VMSTATE_UINT64 (reg_action, ERSTDeviceState), +VMSTATE_UINT64 (reg_value, ERSTDeviceState), +VMSTATE_UINT64 (record_identifier, ERSTDeviceState), +VMSTATE_UINT32 (next_record_index, ERSTDeviceState), +VMSTATE_UINT32 (first_record_index, ERSTDeviceState), +VMSTATE_UINT32 (last_record_index, ERSTDeviceState), +VMSTATE_END_OF_LIST () + } +}; + +static void erst_realizefn (PCIDevice *pci_dev,Error **errp) +{ +ERSTDeviceState *s =ACPIERST (pci_dev); + +trace_acpi_erst_realizefn_in (); + +if (!s->hostmem) { +error_setg (errp,"'" ACPI_ERST_MEMDEV_PROP "' property is not set" ); +return ; + }else if (host_memory_backend_is_mapped (s->hostmem)) { +error_setg (errp,"can't use already busy memdev: %s" , +object_get_canonical_path_component (OBJECT (s->hostmem))); +return ; + } + + s->hostmem_mr =host_memory_backend_get_memory (s->hostmem); + +/* HostMemoryBackend size will be multiple of PAGE_SIZE */ + s->storage_size =object_property_get_int (OBJECT (s->hostmem),"size" , errp); + +/* Check storage_size against ERST_RECORD_SIZE */ +if (((s->storage_size %ERST_RECORD_SIZE ) !=0 ) || + (ERST_RECORD_SIZE > s->storage_size)) { +error_setg (errp,"ACPI ERST requires size be multiple of " +"record size (%luKiB)" ,ERST_RECORD_SIZE ); + } + +/* Initialize backend storage and record_count */ +check_erst_backend_storage (s, errp); + +/* BAR 0: Programming registers */ +memory_region_init_io (&s->iomem,OBJECT (pci_dev), &erst_reg_ops, s, +TYPE_ACPI_ERST ,ERST_REG_SIZE ); +pci_register_bar (pci_dev,0 ,PCI_BASE_ADDRESS_SPACE_MEMORY , &s->iomem); + +/* BAR 1: Exchange buffer memory */ +/* Create a hostmem object to use as the exchange buffer */ + s->exchange_obj =object_new (TYPE_MEMORY_BACKEND_RAM ); +object_property_set_int (s->exchange_obj,"size" ,ERST_RECORD_SIZE , errp); +user_creatable_complete (USER_CREATABLE (s->exchange_obj), errp); + s->exchange =MEMORY_BACKEND (s->exchange_obj); +host_memory_backend_set_mapped (s->exchange, true); + s->exchange_mr =host_memory_backend_get_memory (s->exchange); +memory_region_init_resizeable_ram (s->exchange_mr,OBJECT (pci_dev), +TYPE_ACPI_ERST ,ERST_RECORD_SIZE ,ERST_RECORD_SIZE ,NULL , errp); +pci_register_bar (pci_dev,1 ,PCI_BASE_ADDRESS_SPACE_MEMORY , s->exchange_mr); +/* Include the exchange buffer in the migration stream */ +vmstate_register_ram_global (s->exchange_mr); + +/* Include the backend storage in the migration stream */ +vmstate_register_ram_global (s->hostmem_mr); + +trace_acpi_erst_realizefn_out (s->storage_size); +} + +static void erst_reset (DeviceState *dev) +{ +ERSTDeviceState *s =ACPIERST (dev); + +trace_acpi_erst_reset_in (s->header->record_count); + s->operation =0 ; + s->busy_status =0 ; + s->command_status =STATUS_SUCCESS ; + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ; + s->record_offset =0 ; + s->next_record_index = s->first_record_index; +/* NOTE: first/last_record_index are computed only once */ +trace_acpi_erst_reset_out (s->header->record_count); +} + +static Property erst_properties[] = { +DEFINE_PROP_LINK (ACPI_ERST_MEMDEV_PROP , ERSTDeviceState, hostmem, + TYPE_MEMORY_BACKEND, HostMemoryBackend *), +DEFINE_PROP_END_OF_LIST (), +}; + +static void erst_class_init (ObjectClass *klass,void *data) +{ +DeviceClass *dc =DEVICE_CLASS (klass); +PCIDeviceClass *k =PCI_DEVICE_CLASS (klass); + +trace_acpi_erst_class_init_in (); + k->realize = erst_realizefn; + k->vendor_id =PCI_VENDOR_ID_REDHAT ; + k->device_id =PCI_DEVICE_ID_REDHAT_ACPI_ERST ; + k->revision =0x00 ; + k->class_id =PCI_CLASS_OTHERS ; + dc->reset = erst_reset; + dc->vmsd = &erst_vmstate; + dc->user_creatable = true; +device_class_set_props (dc, erst_properties); + dc->desc ="ACPI Error Record Serialization Table (ERST) device" ; +set_bit (DEVICE_CATEGORY_MISC , dc->categories); +trace_acpi_erst_class_init_out (); +} + +static const TypeInfo erst_type_info = { + .name =TYPE_ACPI_ERST , + .parent =TYPE_PCI_DEVICE , + .class_init = erst_class_init, + .instance_size =sizeof (ERSTDeviceState), + .interfaces = (InterfaceInfo []) { + {INTERFACE_CONVENTIONAL_PCI_DEVICE }, + { } + } +}; + +static void erst_register_types (void ) +{ +type_register_static (&erst_type_info); +} + +type_init (erst_register_types)
hw/acpi/meson.build +1 -0
@@ -5,6 +5,7 @@ acpi_ss.add(files( 'bios-linker-loader.c', 'core.c', 'utils.c', + 'erst.c', )) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu.c')) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu_hotplug.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) "header: 0x%p" +acpi_erst_class_init_in(void) +acpi_erst_class_init_out(void)
Signature · 1 line
1.8.3.1
Re: [PATCH v6 05/10] ACPI ERST: support for ACPI ERST feature
Quoted 126 lines · On Thu, 5 Aug 2021 18:30:34 -0400 Eric DeVolder <[email protected]>…
This 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.
Signed-off-by Eric DeVolder <[email protected]>--- hw/acpi/erst.c | 750 +++++++++++++++++++++++++++++++++++++++++++++++++++ hw/acpi/meson.build | 1 + hw/acpi/trace-events | 15 ++ 3 files changed, 766 insertions(+) create mode 100644 hw/acpi/erst.chw/acpi/erst.c new file +108
-0@@ -0,0 +1,750 @@ +/* +* 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 +*/ + +#include <sys/types.h> +#include <sys/stat.h> +#include <unistd.h> + +#include "qemu/osdep.h" +#include "qapi/error.h" +#include "hw/qdev-core.h" +#include "exec/memory.h" +#include "qom/object.h" +#include "hw/pci/pci.h" +#include "qom/object_interfaces.h" +#include "qemu/error-report.h" +#include "migration/vmstate.h" +#include "hw/qdev-properties.h" +#include "hw/acpi/acpi.h" +#include "hw/acpi/acpi-defs.h" +#include "hw/acpi/aml-build.h" +#include "hw/acpi/bios-linker-loader.h" +#include "exec/address-spaces.h" +#include "sysemu/hostmem.h" +#include "hw/acpi/erst.h" +#include "trace.h" + +/* ACPI 4.0: Table 17-16 Serialization Actions */ +#define ACTION_BEGIN_WRITE_OPERATION 0x0 +#define ACTION_BEGIN_READ_OPERATION 0x1 +#define ACTION_BEGIN_CLEAR_OPERATION 0x2 +#define ACTION_END_OPERATION 0x3 +#define ACTION_SET_RECORD_OFFSET 0x4 +#define ACTION_EXECUTE_OPERATION 0x5 +#define ACTION_CHECK_BUSY_STATUS 0x6 +#define ACTION_GET_COMMAND_STATUS 0x7 +#define ACTION_GET_RECORD_IDENTIFIER 0x8 +#define ACTION_SET_RECORD_IDENTIFIER 0x9 +#define ACTION_GET_RECORD_COUNT 0xA +#define ACTION_BEGIN_DUMMY_WRITE_OPERATION 0xB +#define ACTION_RESERVED 0xC +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE 0xD +#define ACTION_GET_ERROR_LOG_ADDRESS_LENGTH 0xE +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0xF +#define ACTION_GET_EXECUTE_OPERATION_TIMINGS 0x10 + +/* ACPI 4.0: Table 17-17 Command Status Definitions */ +#define STATUS_SUCCESS 0x00 +#define STATUS_NOT_ENOUGH_SPACE 0x01 +#define STATUS_HARDWARE_NOT_AVAILABLE 0x02 +#define STATUS_FAILED 0x03 +#define STATUS_RECORD_STORE_EMPTY 0x04 +#define STATUS_RECORD_NOT_FOUND 0x05 + + +/* UEFI 2.1: Appendix N Common Platform Error Record */ +#define UEFI_CPER_RECORD_MIN_SIZE 128U +#define UEFI_CPER_RECORD_LENGTH_OFFSET 20U +#define UEFI_CPER_RECORD_ID_OFFSET 96U +#define IS_UEFI_CPER_RECORD (ptr) \ + (((ptr)[0] == 'C') && \ + ((ptr)[1] == 'P') && \ + ((ptr)[2] == 'E') && \ + ((ptr)[3] == 'R')) +#define THE_UEFI_CPER_RECORD_ID (ptr) \ + (*(uint64_t *)(&(ptr)[UEFI_CPER_RECORD_ID_OFFSET])) + +/* +* This implementation is an ACTION (cmd) and VALUE (data) +* interface consisting of just two 64-bit registers. +*/ +#define ERST_REG_SIZE (16UL) +#define ERST_ACTION_OFFSET (0UL)/* action (cmd) */ +#define ERST_VALUE_OFFSET (8UL)/* argument/value (data) */ + +/* +* ERST_RECORD_SIZE is the buffer size for exchanging ERST +* record contents. Thus, it defines the maximum record size. +* As this is mapped through a PCI BAR, it must be a power of +* two and larger than UEFI_CPER_RECORD_MIN_SIZE. +* The backing storage is divided into fixed size "slots", +* each ERST_RECORD_SIZE in length, and each "slot" +* storing a single record. No attempt at optimizing storage +* through compression, compaction, etc is attempted. +* NOTE that slot 0 is reserved for the backing storage header. +* Depending upon the size of the backing storage, additional +* slots will be part of the slot 0 header in order to account +* for a record_id for each available remaining slot. +*/ +/* 8KiB records, not too small, not too big */ +#define ERST_RECORD_SIZE (8192UL) + +#define ACPI_ERST_MEMDEV_PROP "memdev" + +/* +* From the ACPI ERST spec sections: +* A record id of all 0s is used to indicate +* 'unspecified' record id. +* A record id of all 1s is used to indicate +* empty or end. +*/
hw/acpi/erst.c line 117
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+#define ERST_UNSPECIFIED_RECORD_ID (0UL) +#define ERST_EMPTY_END_RECORD_ID (~0UL) +#define ERST_EXECUTE_OPERATION_MAGIC 0x9CUL +#define ERST_IS_VALID_RECORD_ID (rid) \ + ((rid != ERST_UNSPECIFIED_RECORD_ID) && \ + (rid != ERST_EMPTY_END_RECORD_ID)) + +typedef struct erst_storage_header_s { +#define ERST_STORE_MAGIC 0x524F545354535245UL
move it out of structure definition,
also where value comes from? (perhaps something starting with ERST... would be more self-describing)
hw/acpi/erst.c line 125
Quoted 8 lines
hw/acpi/erst.c new file +8
-0+uint64_t magic; +uint32_t record_size; +uint32_t record_offset;/* offset to record storage beyond header */ +uint16_t version; +uint16_t reserved; +uint32_t record_count; +uint64_t map[];/* contains record_ids, and position indicates index */ +} erst_storage_header_t;
docs/devel/style.rst: Typedefs
also give it's used as header layout in storage,
set packed attribute for structure
Quoted 40 lines
hw/acpi/erst.c new file +40
-0+ +/* +* Object cast macro +*/ +#define ACPIERST (obj) \ + OBJECT_CHECK(ERSTDeviceState, (obj), TYPE_ACPI_ERST) + +/* +* Main ERST device state structure +*/ +typedef struct { +PCIDevice parent_obj; + +/* Backend storage */ +HostMemoryBackend *hostmem; +MemoryRegion *hostmem_mr; + +/* Programming registers */ +MemoryRegion iomem; + +/* Exchange buffer */ +Object *exchange_obj; +HostMemoryBackend *exchange; +MemoryRegion *exchange_mr; +uint32_t storage_size; + +/* Interface state */ +uint8_t operation; +uint8_t busy_status; +uint8_t command_status; +uint32_t record_offset; +uint64_t reg_action; +uint64_t reg_value; +uint64_t record_identifier; +erst_storage_header_t *header; +unsigned next_record_index; +unsigned first_record_index; +unsigned last_record_index; + +}ERSTDeviceState ;
hw/acpi/erst.c line 174
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+ +/*******************************************************************/ +/*******************************************************************/ + +static uint8_t *get_nvram_ptr_by_index (ERSTDeviceState *s,unsigned index) +{ +uint8_t *rc =NULL ; +off_t offset = (index *ERST_RECORD_SIZE ); +if ((offset +ERST_RECORD_SIZE ) <= s->storage_size) {
it looks like 'index' passed by caller is always valid, if it's the case convert this to
g_assert((offset + ERST_RECORD_SIZE) <= s->storage_size))
also shouldn't <= be just <
Quoted 1 line
+ if (
s->hostmem_mr) {
can hostmem_mr be NULL, when this function is called? if not I'd drop condition.
Quoted 5 lines
hw/acpi/erst.c new file +5
-0+uint8_t *p = (uint8_t *)memory_region_get_ram_ptr (s->hostmem_mr); + rc = p + offset; + } + } +return rc;
hw/acpi/erst.c line 190
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+} + +static void make_erst_storage_header (ERSTDeviceState *s) +{ +erst_storage_header_t *header = s->header; +unsigned mapsz, headersz; + + header->magic =ERST_STORE_MAGIC ; + header->record_size =ERST_RECORD_SIZE ; + header->version =0x0101 ;
maybe 0 or 1 to avoid question about what previous versions are
Quoted 1 line
+
header->reserved=0x0000;
s/0x.../0/
hw/acpi/erst.c line 201
Quoted 11 lines
hw/acpi/erst.c new file +10
-0+ +/* Compute mapsize */ + mapsz = s->storage_size /ERST_RECORD_SIZE ; + mapsz *=sizeof (uint64_t ); +/* Compute header+map size */ + headersz =sizeof (erst_storage_header_t) + mapsz; +/* Round up to nearest integer multiple of ERST_RECORD_SIZE */ + headersz += (ERST_RECORD_SIZE -1 ); + headersz /=ERST_RECORD_SIZE ; + headersz *=ERST_RECORD_SIZE ;
git grep ROUND_UP
may be of help here
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+ header->record_offset = headersz; + +/* +* The HostMemoryBackend initializes contents to zero,
hw/acpi/erst.c line 215
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+* so all record_ids stashed in the map are zero'd. +* As well the record_count is zero. Properly initialized. +*/ +} + +static void check_erst_backend_storage (ERSTDeviceState *s,Error **errp) +{ +erst_storage_header_t *header; + + header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 );
optionally check/assert if it's not 64bit aligned, if it's not you risk getting killed by SIGBUG on some hosts, since you're accessing fields directly.
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ s->header = header; + +/* Check if header is uninitialized */ +if (header->magic ==0UL ) {/* HostMemoryBackend inits to 0 */ +make_erst_storage_header (s); + } + + if (!( + (header->magic == ERST_STORE_MAGIC) && + (header->record_size == ERST_RECORD_SIZE) &&
hw/acpi/erst.c line 235
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ ((header->record_offset % ERST_RECORD_SIZE) == 0) && + (header->version == 0x0101) && + (header->reserved == 0x0000) + )) { +error_setg (errp,"ERST backend storage header is invalid" ); + } + +/* Compute offset of first and last record storage slot */ + s->first_record_index = header->record_offset /ERST_RECORD_SIZE ; + s->last_record_index = (s->storage_size /ERST_RECORD_SIZE );
applies to whole patch/series,
if mmaped header values are interpreted as integers you shall take care of endianness, i.e. use cpu_to_foo/foo_to_cpu for access
and document file endianness in doc (2/10)
hw/acpi/erst.c line 239
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+} + +static void set_erst_map_by_index (ERSTDeviceState *s,unsigned index, +uint64_t record_id)
update_[cache|map]_[entry|record_id]() or something like this might be a better description erst and index don't really add much here as it's clear from context.
Quoted 12 lines
hw/acpi/erst.c new file +12
-0+{ +if (index < s->last_record_index) { + s->header->map[index] = record_id; + } +} + +static unsigned lookup_erst_record (ERSTDeviceState *s, +uint64_t record_identifier) +{ +unsigned rc =0 ;/* 0 not a valid index */ +unsigned index = s->first_record_index; +
hw/acpi/erst.c line 261
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+/* Find the record_identifier in the map */ +if (record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* +* Count number of valid records encountered, and +* short-circuit the loop if identifier not found +*/ +unsigned count =0 ; +for (; index < s->last_record_index && + count < s->header->record_count; ++index) { +uint64_t map_record_identifier = s->header->map[index];
I'd drop map_record_identifier and use s->header->map[index] directly, i.e
if (s->header->map[index] ...
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { + ++count; + } +if (map_record_identifier == record_identifier) { + rc = index; +break ; + } + } + }else { +/* Find first available unoccupied slot */
hw/acpi/erst.c line 281
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+for (; index < s->last_record_index; ++index) { +if (s->header->map[index] ==ERST_UNSPECIFIED_RECORD_ID ) { + rc = index; +break ; + } + } + } + +return rc; +}
what's the reason for combining lookup and allocate ops, if they where separated it' would be easier to follow code.
Quoted 20 lines
hw/acpi/erst.c new file +20
-0+ +/* ACPI 4.0: 17.4.2.3 Operations - Clearing */ +static unsigned clear_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +/* No need to wipe record, just invalidate its map entry */ +set_erst_map_by_index (s, index,ERST_UNSPECIFIED_RECORD_ID ); + s->header->record_count -=1 ; + rc =STATUS_SUCCESS ; + } +
hw/acpi/erst.c line 311
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+return rc; +} + +/* ACPI 4.0: 17.4.2.2 Operations - Reading */ +static unsigned read_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check record boundary wihin exchange buffer */
^^^ typo
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + } + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ;
hw/acpi/erst.c line 328
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +uint8_t *ptr; +uint8_t *record = ((uint8_t *) +memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + ptr =get_nvram_ptr_by_index (s, index); +memcpy (record, ptr,ERST_RECORD_SIZE - s->record_offset);
if record_offset is large enough that record won't fit, this will copy truncated record into the exchange buffer.
Maybe it's better to fail whole op?
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+ rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.1 Operations - Writing */
hw/acpi/erst.c line 345
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+static unsigned write_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_FAILED ; +unsigned index; +uint64_t record_identifier; +uint8_t *record; +uint8_t *ptr =NULL ; +bool record_found = false; + +/* Check record boundary wihin exchange buffer */
ditto, typo
hw/acpi/erst.c line 353
Quoted 8 lines
hw/acpi/erst.c new file +8
-0+if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + } + +/* Extract record identifier */ + record = ((uint8_t *)memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + record_identifier =THE_UEFI_CPER_RECORD_ID (record);
potentially unaligned access to int, should use memcpy()
Quoted 17 lines
hw/acpi/erst.c new file +17
-0+ +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, record_identifier); +if (index) { +/* Record found, overwrite existing record */ + ptr =get_nvram_ptr_by_index (s, index); + record_found = true; + }else { +/* Record not found, not an overwrite, allocate for write */ + index =lookup_erst_record (s,ERST_UNSPECIFIED_RECORD_ID ); +if (index) { + ptr =get_nvram_ptr_by_index (s, index); + }else {
hw/acpi/erst.c line 379
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+ rc =STATUS_NOT_ENOUGH_SPACE ; + } + } +if (ptr) { +memcpy (ptr, record,ERST_RECORD_SIZE - s->record_offset); +if (0 != s->record_offset) { +memset (&ptr[ERST_RECORD_SIZE - s->record_offset], +0xFF , s->record_offset); + }
you've lost me here, care to explain what's going on here?
hw/acpi/erst.c line 392
Quoted 13 lines
hw/acpi/erst.c new file +13
-0+if (!record_found) { + s->header->record_count +=1 ;/* writing new record */ + } +set_erst_map_by_index (s, index, record_identifier); + rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.2 Operations - Reading "During boot..." */ +static unsigned next_erst_record (ERSTDeviceState *s, +uint64_t *record_identifier)
s/record_identifier/found.../
hw/acpi/erst.c line 401
Quoted 9 lines
hw/acpi/erst.c new file +9
-0+{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index = s->next_record_index; + + *record_identifier =ERST_EMPTY_END_RECORD_ID ; + +if (s->header->record_count) { +for (; index < s->last_record_index; ++index) { +uint64_t map_record_identifier;
and then s/map_record_identifier/record_identifier/
the same applies to other occurrences within patch (map_record_identifier is a bit confusing) or drop it and use s->header->map[index] directly
Quoted 11 lines
hw/acpi/erst.c new file +11
-0+ map_record_identifier = s->header->map[index]; +if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* where to start next time */ + s->next_record_index = index +1 ; + *record_identifier = map_record_identifier; + rc =STATUS_SUCCESS ; +break ; + } + } + } +if (rc !=STATUS_SUCCESS ) {
hw/acpi/erst.c line 422
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+if (s->next_record_index == s->first_record_index) { +/* +* next_record_identifier is unchanged, no records found +* and *record_identifier contains EMPTY_END id +*/ + rc =STATUS_RECORD_STORE_EMPTY ; + } +/* at end/scan complete, reset */ + s->next_record_index = s->first_record_index; + }
Table 17-16, says return existing error or ERST_EMPTY_END_RECORD_ID but nothing about op returning a error, so I'd assume status should always be STATUS_SUCCESS for GET_RECORD_IDENTIFIER.
Advancing to the next record is part of record READ op and
not the part of GET_RECORD_IDENTIFIER as it's done here.
"The steps performed by the platform to carry out ...
2. ..
c. If the specified error record does not exist,
... update the status register’s Identifier field with the identifier of the
‘first’ error record
4. Record the Identifier of the ‘next’ valid error record ...
"
Quoted 54 lines
hw/acpi/erst.c new file +54
-0+ +return rc; +} + +/*******************************************************************/ + +static uint64_t erst_rd_reg64 (hwaddr addr, +uint64_t reg,unsigned size) +{ +uint64_t rdval; +uint64_t mask; +unsigned shift; + +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + rdval = reg; + rdval >>= shift; + rdval &= mask; + +return rdval; +} + +static uint64_t erst_wr_reg64 (hwaddr addr, +uint64_t reg,uint64_t val,unsigned size) +{ +uint64_t wrval; +uint64_t mask; +unsigned shift; +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + val &= mask; + val <<= shift; + mask <<= shift; + wrval = reg; + wrval &= ~mask; + wrval |= val; + +return wrval;
hw/acpi/erst.c line 487
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+} + +static void erst_reg_write (void *opaque,hwaddr addr, +uint64_t val,unsigned size) +{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; + +/* +* NOTE: All actions/operations/side effects happen on the WRITE, +* by design. The READs simply return the reg_value contents.
point to spec, pls.
hw/acpi/erst.c line 497
Quoted 11 lines
hw/acpi/erst.c new file +10
-0+*/ +trace_acpi_erst_reg_write (addr, val, size); + +switch (addr) { +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + s->reg_value =erst_wr_reg64 (addr, s->reg_value, val, size); +break ; +case ERST_ACTION_OFFSET +0 : +/* case ERST_ACTION_OFFSET+4: as coded, not really a 64b register */
what does this mean?
Quoted 25 lines
hw/acpi/erst.c new file +25
-0+switch (val) { +case ACTION_BEGIN_WRITE_OPERATION : +case ACTION_BEGIN_READ_OPERATION : +case ACTION_BEGIN_CLEAR_OPERATION : +case ACTION_BEGIN_DUMMY_WRITE_OPERATION : +case ACTION_END_OPERATION : + s->operation = val; +break ; +case ACTION_SET_RECORD_OFFSET : + s->record_offset = s->reg_value; +break ; +case ACTION_EXECUTE_OPERATION : +if ((uint8_t )s->reg_value ==ERST_EXECUTE_OPERATION_MAGIC ) { + s->busy_status =1 ; +switch (s->operation) { +case ACTION_BEGIN_WRITE_OPERATION : + s->command_status =write_erst_record (s); +break ; +case ACTION_BEGIN_READ_OPERATION : + s->command_status =read_erst_record (s); +break ; +case ACTION_BEGIN_CLEAR_OPERATION : + s->command_status =clear_erst_record (s); +break ; +case ACTION_BEGIN_DUMMY_WRITE_OPERATION :
hw/acpi/erst.c line 532
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ s->command_status =STATUS_SUCCESS ; +break ; +case ACTION_END_OPERATION : + s->command_status =STATUS_SUCCESS ; +break ; +default : + s->command_status =STATUS_FAILED ; +break ; + } + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ;
shouldn't happen in case of Read op
"
17.4.2.2
4. Record the Identifier of the ‘next’ valid error record that resides on the persistent store. This allows OSPM to retrieve a valid record identifier by executing a GET_RECORD_IDENTIFIER operation.
"
Quoted 81 lines
hw/acpi/erst.c new file +81
-0+ s->busy_status =0 ; + } +break ; +case ACTION_CHECK_BUSY_STATUS : + s->reg_value = s->busy_status; +break ; +case ACTION_GET_COMMAND_STATUS : + s->reg_value = s->command_status; +break ; +case ACTION_GET_RECORD_IDENTIFIER : + s->command_status =next_erst_record (s, &s->reg_value); +break ; +case ACTION_SET_RECORD_IDENTIFIER : + s->record_identifier = s->reg_value; +break ; +case ACTION_GET_RECORD_COUNT : + s->reg_value = s->header->record_count; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE : + s->reg_value = (hwaddr )pci_get_bar_addr (PCI_DEVICE (s),1 ); +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_LENGTH : + s->reg_value =ERST_RECORD_SIZE ; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES : + s->reg_value =0x0 ;/* intentional, not NVRAM mode */ +break ; +case ACTION_GET_EXECUTE_OPERATION_TIMINGS : + s->reg_value = + (100ULL <<32 ) |/* 100us max time */ + (10ULL <<0 ) ;/* 10us min time */ +break ; +default : +/* Unknown action/command, NOP */ +break ; + } +break ; +default : +/* This should not happen, but if it does, NOP */ +break ; + } +} + +static uint64_t erst_reg_read (void *opaque,hwaddr addr, +unsigned size) +{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; +uint64_t val =0 ; + +switch (addr) { +case ERST_ACTION_OFFSET +0 : +case ERST_ACTION_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_action, size); +break ; +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_value, size); +break ; +default : +break ; + } +trace_acpi_erst_reg_read (addr, val, size); +return val; +} + +static const MemoryRegionOps erst_reg_ops = { + .read = erst_reg_read, + .write = erst_reg_write, + .endianness =DEVICE_NATIVE_ENDIAN , +}; + +/*******************************************************************/ +/*******************************************************************/ +static int erst_post_load (void *opaque,int version_id) +{ +ERSTDeviceState *s = opaque; + +/* Recompute pointer to header */ + s->header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 ); +trace_acpi_erst_post_load (s->header); +
hw/acpi/erst.c line 623
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+return 0 ; +} + +static const VMStateDescription erst_vmstate = { + .name ="acpi-erst" , + .version_id =1 , + .minimum_version_id =1 , + .post_load = erst_post_load, + .fields = (VMStateField []) { +VMSTATE_UINT32 (storage_size, ERSTDeviceState),
1)
hw/acpi/erst.c line 633
Quoted 11 lines
hw/acpi/erst.c new file +10
-0+VMSTATE_UINT8 (operation, ERSTDeviceState), +VMSTATE_UINT8 (busy_status, ERSTDeviceState), +VMSTATE_UINT8 (command_status, ERSTDeviceState), +VMSTATE_UINT32 (record_offset, ERSTDeviceState), +VMSTATE_UINT64 (reg_action, ERSTDeviceState), +VMSTATE_UINT64 (reg_value, ERSTDeviceState), +VMSTATE_UINT64 (record_identifier, ERSTDeviceState), +VMSTATE_UINT32 (next_record_index, ERSTDeviceState), +VMSTATE_UINT32 (first_record_index, ERSTDeviceState), + VMSTATE_UINT32(last_record_index, ERSTDeviceState),
2)
hw/acpi/erst.c line 636
Quoted 3 lines
hw/acpi/erst.c new file +3
-0+ VMSTATE_END_OF_LIST() + } +};
1 and 2 aren't runtime state, so why they are in migration stream?
I'd imagine size could be used to check that backend on target is of the same size to avoid buffer overrun if target side has smaller backend, and fail migration if it's not the same. But it aren't used this way here.
the rest could be calculated at realize time.
Quoted 36 lines
hw/acpi/erst.c new file +36
-0+ +static void erst_realizefn (PCIDevice *pci_dev,Error **errp) +{ +ERSTDeviceState *s =ACPIERST (pci_dev); + +trace_acpi_erst_realizefn_in (); + +if (!s->hostmem) { +error_setg (errp,"'" ACPI_ERST_MEMDEV_PROP "' property is not set" ); +return ; + }else if (host_memory_backend_is_mapped (s->hostmem)) { +error_setg (errp,"can't use already busy memdev: %s" , +object_get_canonical_path_component (OBJECT (s->hostmem))); +return ; + } + + s->hostmem_mr =host_memory_backend_get_memory (s->hostmem); + +/* HostMemoryBackend size will be multiple of PAGE_SIZE */ + s->storage_size =object_property_get_int (OBJECT (s->hostmem),"size" , errp); + +/* Check storage_size against ERST_RECORD_SIZE */ +if (((s->storage_size %ERST_RECORD_SIZE ) !=0 ) || + (ERST_RECORD_SIZE > s->storage_size)) { +error_setg (errp,"ACPI ERST requires size be multiple of " +"record size (%luKiB)" ,ERST_RECORD_SIZE ); + } + +/* Initialize backend storage and record_count */ +check_erst_backend_storage (s, errp); + +/* BAR 0: Programming registers */ +memory_region_init_io (&s->iomem,OBJECT (pci_dev), &erst_reg_ops, s, +TYPE_ACPI_ERST ,ERST_REG_SIZE ); +pci_register_bar (pci_dev,0 ,PCI_BASE_ADDRESS_SPACE_MEMORY , &s->iomem); +
hw/acpi/erst.c line 680
Quoted 10 lines
hw/acpi/erst.c new file +8
-0+/* BAR 1: Exchange buffer memory */ +/* Create a hostmem object to use as the exchange buffer */ + s->exchange_obj =object_new (TYPE_MEMORY_BACKEND_RAM ); +object_property_set_int (s->exchange_obj,"size" ,ERST_RECORD_SIZE , errp); +user_creatable_complete (USER_CREATABLE (s->exchange_obj), errp); + s->exchange =MEMORY_BACKEND (s->exchange_obj); +host_memory_backend_set_mapped (s->exchange, true); + s->exchange_mr =host_memory_backend_get_memory (s->exchange);
replace this block with single memory_region_init_ram()
hw/acpi/erst.c line 682
Quoted 2 lines
hw/acpi/erst.c new file +2
-0+memory_region_init_resizeable_ram (s->exchange_mr,OBJECT (pci_dev), +TYPE_ACPI_ERST ,ERST_RECORD_SIZE ,ERST_RECORD_SIZE ,NULL , errp);
have ho idea why it's necessary, seems just wrong, it basically leaks previous memory region and creates a new one.
hw/acpi/erst.c line 685
Quoted 4 lines
hw/acpi/erst.c new file +3
-0+pci_register_bar (pci_dev,1 ,PCI_BASE_ADDRESS_SPACE_MEMORY , s->exchange_mr); +/* Include the exchange buffer in the migration stream */ +vmstate_register_ram_global (s->exchange_mr);
not necessary if memory_region_init_ram() is used directly
Quoted 32 lines
hw/acpi/erst.c new file +32
-0+ +/* Include the backend storage in the migration stream */ +vmstate_register_ram_global (s->hostmem_mr); + +trace_acpi_erst_realizefn_out (s->storage_size); +} + +static void erst_reset (DeviceState *dev) +{ +ERSTDeviceState *s =ACPIERST (dev); + +trace_acpi_erst_reset_in (s->header->record_count); + s->operation =0 ; + s->busy_status =0 ; + s->command_status =STATUS_SUCCESS ; + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ; + s->record_offset =0 ; + s->next_record_index = s->first_record_index; +/* NOTE: first/last_record_index are computed only once */ +trace_acpi_erst_reset_out (s->header->record_count); +} + +static Property erst_properties[] = { +DEFINE_PROP_LINK (ACPI_ERST_MEMDEV_PROP , ERSTDeviceState, hostmem, + TYPE_MEMORY_BACKEND, HostMemoryBackend *), +DEFINE_PROP_END_OF_LIST (), +}; + +static void erst_class_init (ObjectClass *klass,void *data) +{ +DeviceClass *dc =DEVICE_CLASS (klass); +PCIDeviceClass *k =PCI_DEVICE_CLASS (klass);
hw/acpi/erst.c line 727
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ +trace_acpi_erst_class_init_in (); + k->realize = erst_realizefn; + k->vendor_id =PCI_VENDOR_ID_REDHAT ; + k->device_id =PCI_DEVICE_ID_REDHAT_ACPI_ERST ; + k->revision =0x00 ; + k->class_id =PCI_CLASS_OTHERS ; + dc->reset = erst_reset; + dc->vmsd = &erst_vmstate; + dc->user_creatable = true;
can't be hotplugged, add:
dc->hotpluggable = false;
Quoted 58 lines
hw/acpi/erst.c new file +23
-0+device_class_set_props (dc, erst_properties); + dc->desc ="ACPI Error Record Serialization Table (ERST) device" ; +set_bit (DEVICE_CATEGORY_MISC , dc->categories); +trace_acpi_erst_class_init_out (); +} + +static const TypeInfo erst_type_info = { + .name =TYPE_ACPI_ERST , + .parent =TYPE_PCI_DEVICE , + .class_init = erst_class_init, + .instance_size =sizeof (ERSTDeviceState), + .interfaces = (InterfaceInfo []) { + {INTERFACE_CONVENTIONAL_PCI_DEVICE }, + { } + } +}; + +static void erst_register_types (void ) +{ +type_register_static (&erst_type_info); +} + +type_init (erst_register_types)hw/acpi/meson.build +1
-0@@ -5,6 +5,7 @@ acpi_ss.add(files( 'bios-linker-loader.c', 'core.c', 'utils.c', + 'erst.c', )) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu.c')) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu_hotplug.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) "header: 0x%p" +acpi_erst_class_init_in(void) +acpi_erst_class_init_out(void)
Re: [PATCH v6 05/10] ACPI ERST: support for ACPI ERST feature
Igor, thanks for the close examination. Inline responses below. eric
Quoted 138 lines · Igor Mammedov
Quoted 134 lines · On Thu, 5 Aug 2021 18:30:34 -0400 Eric DeVolder <[email protected]>…
This 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.
Signed-off-by Eric DeVolder <[email protected]>--- hw/acpi/erst.c | 750 +++++++++++++++++++++++++++++++++++++++++++++++++++ hw/acpi/meson.build | 1 + hw/acpi/trace-events | 15 ++ 3 files changed, 766 insertions(+)create mode 100644
hw/acpi/erst.chw/acpi/erst.c new file +116
-0@@ -0,0 +1,750 @@ +/* +* 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 +*/ + +#include <sys/types.h> +#include <sys/stat.h> +#include <unistd.h> + +#include "qemu/osdep.h" +#include "qapi/error.h" +#include "hw/qdev-core.h" +#include "exec/memory.h" +#include "qom/object.h" +#include "hw/pci/pci.h" +#include "qom/object_interfaces.h" +#include "qemu/error-report.h" +#include "migration/vmstate.h" +#include "hw/qdev-properties.h" +#include "hw/acpi/acpi.h" +#include "hw/acpi/acpi-defs.h" +#include "hw/acpi/aml-build.h" +#include "hw/acpi/bios-linker-loader.h" +#include "exec/address-spaces.h" +#include "sysemu/hostmem.h" +#include "hw/acpi/erst.h" +#include "trace.h" + +/* ACPI 4.0: Table 17-16 Serialization Actions */ +#define ACTION_BEGIN_WRITE_OPERATION 0x0 +#define ACTION_BEGIN_READ_OPERATION 0x1 +#define ACTION_BEGIN_CLEAR_OPERATION 0x2 +#define ACTION_END_OPERATION 0x3 +#define ACTION_SET_RECORD_OFFSET 0x4 +#define ACTION_EXECUTE_OPERATION 0x5 +#define ACTION_CHECK_BUSY_STATUS 0x6 +#define ACTION_GET_COMMAND_STATUS 0x7 +#define ACTION_GET_RECORD_IDENTIFIER 0x8 +#define ACTION_SET_RECORD_IDENTIFIER 0x9 +#define ACTION_GET_RECORD_COUNT 0xA +#define ACTION_BEGIN_DUMMY_WRITE_OPERATION 0xB +#define ACTION_RESERVED 0xC +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE 0xD +#define ACTION_GET_ERROR_LOG_ADDRESS_LENGTH 0xE +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0xF +#define ACTION_GET_EXECUTE_OPERATION_TIMINGS 0x10 + +/* ACPI 4.0: Table 17-17 Command Status Definitions */ +#define STATUS_SUCCESS 0x00 +#define STATUS_NOT_ENOUGH_SPACE 0x01 +#define STATUS_HARDWARE_NOT_AVAILABLE 0x02 +#define STATUS_FAILED 0x03 +#define STATUS_RECORD_STORE_EMPTY 0x04 +#define STATUS_RECORD_NOT_FOUND 0x05 + + +/* UEFI 2.1: Appendix N Common Platform Error Record */ +#define UEFI_CPER_RECORD_MIN_SIZE 128U +#define UEFI_CPER_RECORD_LENGTH_OFFSET 20U +#define UEFI_CPER_RECORD_ID_OFFSET 96U +#define IS_UEFI_CPER_RECORD (ptr) \ + (((ptr)[0] == 'C') && \ + ((ptr)[1] == 'P') && \ + ((ptr)[2] == 'E') && \ + ((ptr)[3] == 'R')) +#define THE_UEFI_CPER_RECORD_ID (ptr) \ + (*(uint64_t *)(&(ptr)[UEFI_CPER_RECORD_ID_OFFSET])) + +/* +* This implementation is an ACTION (cmd) and VALUE (data) +* interface consisting of just two 64-bit registers. +*/ +#define ERST_REG_SIZE (16UL) +#define ERST_ACTION_OFFSET (0UL)/* action (cmd) */ +#define ERST_VALUE_OFFSET (8UL)/* argument/value (data) */ + +/* +* ERST_RECORD_SIZE is the buffer size for exchanging ERST +* record contents. Thus, it defines the maximum record size. +* As this is mapped through a PCI BAR, it must be a power of +* two and larger than UEFI_CPER_RECORD_MIN_SIZE. +* The backing storage is divided into fixed size "slots", +* each ERST_RECORD_SIZE in length, and each "slot" +* storing a single record. No attempt at optimizing storage +* through compression, compaction, etc is attempted. +* NOTE that slot 0 is reserved for the backing storage header. +* Depending upon the size of the backing storage, additional +* slots will be part of the slot 0 header in order to account +* for a record_id for each available remaining slot. +*/ +/* 8KiB records, not too small, not too big */ +#define ERST_RECORD_SIZE (8192UL) + +#define ACPI_ERST_MEMDEV_PROP "memdev" + +/* +* From the ACPI ERST spec sections: +* A record id of all 0s is used to indicate +* 'unspecified' record id. +* A record id of all 1s is used to indicate +* empty or end. +*/ +#define ERST_UNSPECIFIED_RECORD_ID (0UL) +#define ERST_EMPTY_END_RECORD_ID (~0UL) +#define ERST_EXECUTE_OPERATION_MAGIC 0x9CUL +#define ERST_IS_VALID_RECORD_ID (rid) \ + ((rid != ERST_UNSPECIFIED_RECORD_ID) && \ + (rid != ERST_EMPTY_END_RECORD_ID)) + +typedef struct erst_storage_header_s {
Quoted 5 lines
hw/acpi/erst.c line 117
Quoted 1 line
hw/acpi/erst.c new file +1
-0+#define ERST_STORE_MAGIC 0x524F545354535245ULmove it out of structure definition,
also where value comes from? (perhaps something starting with ERST... would be more self-describing)
done; this value is 'ERSTSTOR', which I've left as a comment in v7.
Quoted 10 lines
hw/acpi/erst.c line 125
Quoted 9 lines
hw/acpi/erst.c new file +8
-0+uint64_t magic; +uint32_t record_size; +uint32_t record_offset;/* offset to record storage beyond header */ +uint16_t version; +uint16_t reserved; +uint32_t record_count; +uint64_t map[];/* contains record_ids, and position indicates index */ +} erst_storage_header_t;
docs/devel/style.rst: Typedefs
done; thanks
Quoted 3 lines
also give it's used as header layout in storage,
set packed attribute for structure
done
Quoted 50 lines
Quoted 49 lines
hw/acpi/erst.c new file +48
-0+ +/* +* Object cast macro +*/ +#define ACPIERST (obj) \ + OBJECT_CHECK(ERSTDeviceState, (obj), TYPE_ACPI_ERST) + +/* +* Main ERST device state structure +*/ +typedef struct { +PCIDevice parent_obj; + +/* Backend storage */ +HostMemoryBackend *hostmem; +MemoryRegion *hostmem_mr; + +/* Programming registers */ +MemoryRegion iomem; + +/* Exchange buffer */ +Object *exchange_obj; +HostMemoryBackend *exchange; +MemoryRegion *exchange_mr; +uint32_t storage_size; + +/* Interface state */ +uint8_t operation; +uint8_t busy_status; +uint8_t command_status; +uint32_t record_offset; +uint64_t reg_action; +uint64_t reg_value; +uint64_t record_identifier; +erst_storage_header_t *header; +unsigned next_record_index; +unsigned first_record_index; +unsigned last_record_index; + +}ERSTDeviceState ; + +/*******************************************************************/ +/*******************************************************************/ + +static uint8_t *get_nvram_ptr_by_index (ERSTDeviceState *s,unsigned index) +{ +uint8_t *rc =NULL ; +off_t offset = (index *ERST_RECORD_SIZE );
Quoted 5 lines
hw/acpi/erst.c line 174
Quoted 1 line
hw/acpi/erst.c new file +1
-0+if ((offset +ERST_RECORD_SIZE ) <= s->storage_size) {it looks like 'index' passed by caller is always valid, if it's the case convert this to
g_assert((offset + ERST_RECORD_SIZE) <= s->storage_size))
done
Quoted 2 lines
also shouldn't <= be just <
yes, done
Quoted 5 lines
hw/acpi/erst.c line 175
Quoted 3 lines
hw/acpi/erst.c new file +1
-0+if (s->hostmem_mr) {can
hostmem_mrbe NULL, when this function is called? if not I'd drop condition.
no, so dropped. done
Quoted 10 lines
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+uint8_t *p = (uint8_t *)memory_region_get_ram_ptr (s->hostmem_mr); + rc = p + offset; + } + } +return rc; +} + +static void make_erst_storage_header (ERSTDeviceState *s) +{
Quoted 8 lines
hw/acpi/erst.c line 190
Quoted 6 lines
hw/acpi/erst.c new file +6
-0+erst_storage_header_t *header = s->header; +unsigned mapsz, headersz; + + header->magic =ERST_STORE_MAGIC ; + header->record_size =ERST_RECORD_SIZE ; + header->version =0x0101 ;maybe 0 or 1 to avoid question about what previous versions are
changed to simply 0x0100 (ie 1.0)
Quoted 3 lines
hw/acpi/erst.c line 191
Quoted 2 lines
hw/acpi/erst.c new file +1
-0+ header->reserved =0x0000 ;s/0x.../0/
done
Quoted 8 lines
Quoted 7 lines
hw/acpi/erst.c new file +6
-0+ +/* Compute mapsize */ + mapsz = s->storage_size /ERST_RECORD_SIZE ; + mapsz *=sizeof (uint64_t ); +/* Compute header+map size */ + headersz =sizeof (erst_storage_header_t) + mapsz;
Quoted 6 lines
hw/acpi/erst.c line 201
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+/* Round up to nearest integer multiple of ERST_RECORD_SIZE */ + headersz += (ERST_RECORD_SIZE -1 ); + headersz /=ERST_RECORD_SIZE ; + headersz *=ERST_RECORD_SIZE ;git grep
ROUND_UP
may be of help here
yes, thanks. I'm using that now, done.
Quoted 10 lines
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+ header->record_offset = headersz; + +/* +* The HostMemoryBackend initializes contents to zero, +* so all record_ids stashed in the map are zero'd. +* As well the record_count is zero. Properly initialized. +*/ +} +
Quoted 8 lines
hw/acpi/erst.c line 215
Quoted 5 lines
hw/acpi/erst.c new file +5
-0+static void check_erst_backend_storage (ERSTDeviceState *s,Error **errp) +{ +erst_storage_header_t *header; + + header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 );optionally check/assert if it's not 64bit aligned, if it's not you risk getting killed by SIGBUG on some hosts, since you're accessing fields directly.
done!
Quoted 17 lines
Quoted 17 lines
hw/acpi/erst.c new file +16
-0+ s->header = header; + +/* Check if header is uninitialized */ +if (header->magic ==0UL ) {/* HostMemoryBackend inits to 0 */ +make_erst_storage_header (s); + } + +if (!( + (header->magic ==ERST_STORE_MAGIC ) && + (header->record_size ==ERST_RECORD_SIZE ) && + ((header->record_offset %ERST_RECORD_SIZE ) ==0 ) && + (header->version ==0x0101 ) && + (header->reserved ==0x0000 ) + )) { +error_setg (errp,"ERST backend storage header is invalid" ); + }
Quoted 8 lines
hw/acpi/erst.c line 235
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+ +/* Compute offset of first and last record storage slot */ + s->first_record_index = header->record_offset /ERST_RECORD_SIZE ; + s->last_record_index = (s->storage_size /ERST_RECORD_SIZE );applies to whole patch/series,
if mmaped header values are interpreted as integers you shall take care of endianness, i.e. use cpu_to_foo/foo_to_cpu for access
done; I'm using cpu_to_leX() and leX_to_cpu() for any access to the header.
Quoted 2 lines
and document file endianness in doc (2/10)
done
Quoted 9 lines
hw/acpi/erst.c line 239
Quoted 5 lines
hw/acpi/erst.c new file +4
-0+} + +static void set_erst_map_by_index (ERSTDeviceState *s,unsigned index, +uint64_t record_id)update_[cache|map]_[entry|record_id]() or something like this might be a better description erst and index don't really add much here as it's clear from context.
done; now update_map_entry()
Quoted 26 lines
Quoted 14 lines
hw/acpi/erst.c new file +12
-0+{ +if (index < s->last_record_index) { + s->header->map[index] = record_id; + } +} + +static unsigned lookup_erst_record (ERSTDeviceState *s, +uint64_t record_identifier) +{ +unsigned rc =0 ;/* 0 not a valid index */ +unsigned index = s->first_record_index; +hw/acpi/erst.c line 261
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+/* Find the record_identifier in the map */ +if (record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* +* Count number of valid records encountered, and +* short-circuit the loop if identifier not found +*/ +unsigned count =0 ; +for (; index < s->last_record_index && + count < s->header->record_count; ++index) { +uint64_t map_record_identifier = s->header->map[index];I'd drop
map_record_identifierand use s->header->map[index] directly, i.e
Quoted 1 line
if (s->header->map[index] ...
done
Quoted 16 lines
Quoted 16 lines
hw/acpi/erst.c new file +15
-0+if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { + ++count; + } +if (map_record_identifier == record_identifier) { + rc = index; +break ; + } + } + }else { +/* Find first available unoccupied slot */ +for (; index < s->last_record_index; ++index) { +if (s->header->map[index] ==ERST_UNSPECIFIED_RECORD_ID ) { + rc = index; +break ; + }
Quoted 8 lines
hw/acpi/erst.c line 281
Quoted 5 lines
hw/acpi/erst.c new file +5
-0+ } + } + +return rc; +}what's the reason for combining lookup and allocate ops, if they where separated it' would be easier to follow code.
done; at one point it made sense; no longer.
Quoted 24 lines
Quoted 24 lines
hw/acpi/erst.c new file +23
-0+ +/* ACPI 4.0: 17.4.2.3 Operations - Clearing */ +static unsigned clear_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +/* No need to wipe record, just invalidate its map entry */ +set_erst_map_by_index (s, index,ERST_UNSPECIFIED_RECORD_ID ); + s->header->record_count -=1 ; + rc =STATUS_SUCCESS ; + } + +return rc; +} +
Quoted 8 lines
hw/acpi/erst.c line 311
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+/* ACPI 4.0: 17.4.2.2 Operations - Reading */ +static unsigned read_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check record boundary wihin exchange buffer */ ^^^ typo
done
Quoted 22 lines
Quoted 8 lines
hw/acpi/erst.c new file +7
-0+if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + } + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ;hw/acpi/erst.c line 328
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +uint8_t *ptr; +uint8_t *record = ((uint8_t *) +memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + ptr =get_nvram_ptr_by_index (s, index); +memcpy (record, ptr,ERST_RECORD_SIZE - s->record_offset);if
record_offsetis large enough that record won't fit, this will copy truncated record into the exchange buffer.
Quoted 1 line
Maybe it's better to fail whole op?
The first check within this function checks for this very condition, and does fail. I believe the code does as you are asking.
Quoted 11 lines
Quoted 11 lines
hw/acpi/erst.c new file +10
-0+ rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.1 Operations - Writing */ +static unsigned write_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_FAILED ;
Quoted 8 lines
hw/acpi/erst.c line 345
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+unsigned index; +uint64_t record_identifier; +uint8_t *record; +uint8_t *ptr =NULL ; +bool record_found = false; + +/* Check record boundary wihin exchange buffer */ ditto, typo
done
Quoted 10 lines
hw/acpi/erst.c line 353
Quoted 9 lines
hw/acpi/erst.c new file +8
-0+if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + } + +/* Extract record identifier */ + record = ((uint8_t *)memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + record_identifier =THE_UEFI_CPER_RECORD_ID (record);potentially unaligned access to int, should use
memcpy()
done
Quoted 24 lines
Quoted 23 lines
hw/acpi/erst.c new file +22
-0+ +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, record_identifier); +if (index) { +/* Record found, overwrite existing record */ + ptr =get_nvram_ptr_by_index (s, index); + record_found = true; + }else { +/* Record not found, not an overwrite, allocate for write */ + index =lookup_erst_record (s,ERST_UNSPECIFIED_RECORD_ID ); +if (index) { + ptr =get_nvram_ptr_by_index (s, index); + }else { + rc =STATUS_NOT_ENOUGH_SPACE ; + } + } +if (ptr) { +memcpy (ptr, record,ERST_RECORD_SIZE - s->record_offset);
Quoted 5 lines
hw/acpi/erst.c line 379
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+if (0 != s->record_offset) { +memset (&ptr[ERST_RECORD_SIZE - s->record_offset], +0xFF , s->record_offset); + }you've lost me here, care to explain what's going on here?
If the record_offset is not 0, then there can be bytes following the record within the slot that were not written. This simply sets them to 0xFF (so bytes from a previously written record that happened to occupy this slot do not "bleed" through). I've left a comment in v7.
Quoted 15 lines
Quoted 4 lines
hw/acpi/erst.c new file +3
-0+if (!record_found) { + s->header->record_count +=1 ;/* writing new record */ + }hw/acpi/erst.c line 392
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+set_erst_map_by_index (s, index, record_identifier); + rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.2 Operations - Reading "During boot..." */ +static unsigned next_erst_record (ERSTDeviceState *s, +uint64_t *record_identifier)s/record_identifier/found.../
done
Quoted 11 lines
hw/acpi/erst.c line 401
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index = s->next_record_index; + + *record_identifier =ERST_EMPTY_END_RECORD_ID ; + +if (s->header->record_count) { +for (; index < s->last_record_index; ++index) { +uint64_t map_record_identifier;and then s/map_record_identifier/record_identifier/
done
Quoted 4 lines
the same applies to other occurrences within patch (
map_record_identifieris a bit confusing) or drop it and use s->header->map[index] directly
done
Quoted 23 lines
Quoted 12 lines
hw/acpi/erst.c new file +11
-0+ map_record_identifier = s->header->map[index]; +if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* where to start next time */ + s->next_record_index = index +1 ; + *record_identifier = map_record_identifier; + rc =STATUS_SUCCESS ; +break ; + } + } + } +if (rc !=STATUS_SUCCESS ) {hw/acpi/erst.c line 422
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+if (s->next_record_index == s->first_record_index) { +/* +* next_record_identifier is unchanged, no records found +* and *record_identifier contains EMPTY_END id +*/ + rc =STATUS_RECORD_STORE_EMPTY ; + } +/* at end/scan complete, reset */ + s->next_record_index = s->first_record_index; + }
Quoted 3 lines
Table 17-16, says return existing error or
ERST_EMPTY_END_RECORD_IDbut nothing about op returning a error, so I'd assume status should always beSTATUS_SUCCESSforGET_RECORD_IDENTIFIER.
done
Quoted 3 lines
Advancing to the next record is part of record READ op and not the part of
GET_RECORD_IDENTIFIERas it's done here.
well...
Quoted 7 lines
"The steps performed by the platform to carry out ...
2. ..
c. If the specified error record does not exist,
... update the status register’s Identifier field with the identifier of the
‘first’ error record
4. Record the Identifier of the ‘next’ valid error record ...
"
I used ACPI spec v6 and I was asked to locate the first occurrence of ERST in the spec, which was v4. So the above spec quotes are accurate, however, spec v6 deviates in an important way from the above, which reads:
"c. If the status is Record Not Found (0x05), indicating that the specified error record does not
exist, OSPM retrieves a valid identifier by a GET_RECORD_IDENTIFIER action. The platform will return a valid record identifier."
So GET_RECORD_IDENTIFIER is essentially a factory that pumps out record identifiers for records stored. I kind of think of it as the old DOS 'find_first/find_next'. And yes v4 of the spec states that the READ operation should initiate the first record_identifer. However v6 clearly states this is now the responsibility of OSPM, not the READ op.
I am thinking that the best way to handle this contradiction is to change the ACPI spec citation from v4 to v5, as the wording in v5 matches what I cite from v6, and implemented. Furthermore, this approach of OSPM obtaining the next valid record_id via GET_RECORD_IDENTIFIER is consistent with what I observed in BIOS and with how Linux is coded.
Thoughts?
Quoted 60 lines
Quoted 60 lines
hw/acpi/erst.c new file +58
-0+ +return rc; +} + +/*******************************************************************/ + +static uint64_t erst_rd_reg64 (hwaddr addr, +uint64_t reg,unsigned size) +{ +uint64_t rdval; +uint64_t mask; +unsigned shift; + +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + rdval = reg; + rdval >>= shift; + rdval &= mask; + +return rdval; +} + +static uint64_t erst_wr_reg64 (hwaddr addr, +uint64_t reg,uint64_t val,unsigned size) +{ +uint64_t wrval; +uint64_t mask; +unsigned shift; +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + val &= mask; + val <<= shift; + mask <<= shift; + wrval = reg; + wrval &= ~mask; + wrval |= val; + +return wrval; +} + +static void erst_reg_write (void *opaque,hwaddr addr, +uint64_t val,unsigned size)
Quoted 8 lines
hw/acpi/erst.c line 487
Quoted 6 lines
hw/acpi/erst.c new file +6
-0+{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; + +/* +* NOTE: All actions/operations/side effects happen on the WRITE, +* by design. The READs simply return the reg_value contents. point to spec, pls.
This was an implementation design choice, so no spec reference applicable, I left a comment.
Quoted 11 lines
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+*/ +trace_acpi_erst_reg_write (addr, val, size); + +switch (addr) { +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + s->reg_value =erst_wr_reg64 (addr, s->reg_value, val, size); +break ; +case ERST_ACTION_OFFSET +0 :
Quoted 3 lines
hw/acpi/erst.c line 497
Quoted 1 line
hw/acpi/erst.c new file +1
-0+/* case ERST_ACTION_OFFSET+4: as coded, not really a 64b register */ what does this mean?
In short, all values written to this register are just the ACTION ops, so there wasn't a need to implement this as a 64-bit register, especially since Linux seems to issue two 32-bit accesses for 64-bit; in this case the upper access is utterly useless. I placed a comment in code.
Quoted 36 lines
Quoted 26 lines
hw/acpi/erst.c new file +25
-0+switch (val) { +case ACTION_BEGIN_WRITE_OPERATION : +case ACTION_BEGIN_READ_OPERATION : +case ACTION_BEGIN_CLEAR_OPERATION : +case ACTION_BEGIN_DUMMY_WRITE_OPERATION : +case ACTION_END_OPERATION : + s->operation = val; +break ; +case ACTION_SET_RECORD_OFFSET : + s->record_offset = s->reg_value; +break ; +case ACTION_EXECUTE_OPERATION : +if ((uint8_t )s->reg_value ==ERST_EXECUTE_OPERATION_MAGIC ) { + s->busy_status =1 ; +switch (s->operation) { +case ACTION_BEGIN_WRITE_OPERATION : + s->command_status =write_erst_record (s); +break ; +case ACTION_BEGIN_READ_OPERATION : + s->command_status =read_erst_record (s); +break ; +case ACTION_BEGIN_CLEAR_OPERATION : + s->command_status =clear_erst_record (s); +break ; +case ACTION_BEGIN_DUMMY_WRITE_OPERATION :hw/acpi/erst.c line 532
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ s->command_status =STATUS_SUCCESS ; +break ; +case ACTION_END_OPERATION : + s->command_status =STATUS_SUCCESS ; +break ; +default : + s->command_status =STATUS_FAILED ; +break ; + } + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ;
Quoted 1 line
shouldn't happen in case of Read op
correct, removed as not needed at all now.
Quoted 109 lines
"
17.4.2.2
4. Record the Identifier of the ‘next’ valid error record that resides on the persistent store. This allows OSPM to retrieve a valid record identifier by executing aGET_RECORD_IDENTIFIERoperation.
"Quoted 81 lines
hw/acpi/erst.c new file +81
-0+ s->busy_status =0 ; + } +break ; +case ACTION_CHECK_BUSY_STATUS : + s->reg_value = s->busy_status; +break ; +case ACTION_GET_COMMAND_STATUS : + s->reg_value = s->command_status; +break ; +case ACTION_GET_RECORD_IDENTIFIER : + s->command_status =next_erst_record (s, &s->reg_value); +break ; +case ACTION_SET_RECORD_IDENTIFIER : + s->record_identifier = s->reg_value; +break ; +case ACTION_GET_RECORD_COUNT : + s->reg_value = s->header->record_count; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE : + s->reg_value = (hwaddr )pci_get_bar_addr (PCI_DEVICE (s),1 ); +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_LENGTH : + s->reg_value =ERST_RECORD_SIZE ; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES : + s->reg_value =0x0 ;/* intentional, not NVRAM mode */ +break ; +case ACTION_GET_EXECUTE_OPERATION_TIMINGS : + s->reg_value = + (100ULL <<32 ) |/* 100us max time */ + (10ULL <<0 ) ;/* 10us min time */ +break ; +default : +/* Unknown action/command, NOP */ +break ; + } +break ; +default : +/* This should not happen, but if it does, NOP */ +break ; + } +} + +static uint64_t erst_reg_read (void *opaque,hwaddr addr, +unsigned size) +{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; +uint64_t val =0 ; + +switch (addr) { +case ERST_ACTION_OFFSET +0 : +case ERST_ACTION_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_action, size); +break ; +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_value, size); +break ; +default : +break ; + } +trace_acpi_erst_reg_read (addr, val, size); +return val; +} + +static const MemoryRegionOps erst_reg_ops = { + .read = erst_reg_read, + .write = erst_reg_write, + .endianness =DEVICE_NATIVE_ENDIAN , +}; + +/*******************************************************************/ +/*******************************************************************/ +static int erst_post_load (void *opaque,int version_id) +{ +ERSTDeviceState *s = opaque; + +/* Recompute pointer to header */ + s->header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 ); +trace_acpi_erst_post_load (s->header); +hw/acpi/erst.c line 623
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+return 0 ; +} + +static const VMStateDescription erst_vmstate = { + .name ="acpi-erst" , + .version_id =1 , + .minimum_version_id =1 , + .post_load = erst_post_load, + .fields = (VMStateField []) { +VMSTATE_UINT32 (storage_size, ERSTDeviceState),1)
Quoted 8 lines
hw/acpi/erst.c new file +8
-0+VMSTATE_UINT8 (operation, ERSTDeviceState), +VMSTATE_UINT8 (busy_status, ERSTDeviceState), +VMSTATE_UINT8 (command_status, ERSTDeviceState), +VMSTATE_UINT32 (record_offset, ERSTDeviceState), +VMSTATE_UINT64 (reg_action, ERSTDeviceState), +VMSTATE_UINT64 (reg_value, ERSTDeviceState), +VMSTATE_UINT64 (record_identifier, ERSTDeviceState), + VMSTATE_UINT32(next_record_index, ERSTDeviceState),
Quoted 8 lines
hw/acpi/erst.c line 633
Quoted 2 lines
hw/acpi/erst.c new file +2
-0+VMSTATE_UINT32 (first_record_index, ERSTDeviceState), + VMSTATE_UINT32(last_record_index, ERSTDeviceState),2)
hw/acpi/erst.c line 636
Quoted 3 lines
hw/acpi/erst.c new file +3
-0+ VMSTATE_END_OF_LIST() + } +};1 and 2 aren't runtime state, so why they are in migration stream?
done; removed storage_size, first_record_index and last_record_index from the migration stream.
Quoted 4 lines
I'd imagine size could be used to check that backend on target is of the same size to avoid buffer overrun if target side has smaller backend, and fail migration if it's not the same. But it aren't used this way here.
I decided to not do this check as that memory object is migrated automatically, so I dont think my check adds any value.
Quoted 2 lines
the rest could be calculated at realize time.
and in fact they are.
Quoted 40 lines
Quoted 38 lines
hw/acpi/erst.c new file +37
-0+ +static void erst_realizefn (PCIDevice *pci_dev,Error **errp) +{ +ERSTDeviceState *s =ACPIERST (pci_dev); + +trace_acpi_erst_realizefn_in (); + +if (!s->hostmem) { +error_setg (errp,"'" ACPI_ERST_MEMDEV_PROP "' property is not set" ); +return ; + }else if (host_memory_backend_is_mapped (s->hostmem)) { +error_setg (errp,"can't use already busy memdev: %s" , +object_get_canonical_path_component (OBJECT (s->hostmem))); +return ; + } + + s->hostmem_mr =host_memory_backend_get_memory (s->hostmem); + +/* HostMemoryBackend size will be multiple of PAGE_SIZE */ + s->storage_size =object_property_get_int (OBJECT (s->hostmem),"size" , errp); + +/* Check storage_size against ERST_RECORD_SIZE */ +if (((s->storage_size %ERST_RECORD_SIZE ) !=0 ) || + (ERST_RECORD_SIZE > s->storage_size)) { +error_setg (errp,"ACPI ERST requires size be multiple of " +"record size (%luKiB)" ,ERST_RECORD_SIZE ); + } + +/* Initialize backend storage and record_count */ +check_erst_backend_storage (s, errp); + +/* BAR 0: Programming registers */ +memory_region_init_io (&s->iomem,OBJECT (pci_dev), &erst_reg_ops, s, +TYPE_ACPI_ERST ,ERST_REG_SIZE ); +pci_register_bar (pci_dev,0 ,PCI_BASE_ADDRESS_SPACE_MEMORY , &s->iomem); + +/* BAR 1: Exchange buffer memory */
Quoted 8 lines
hw/acpi/erst.c line 680
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+/* Create a hostmem object to use as the exchange buffer */ + s->exchange_obj =object_new (TYPE_MEMORY_BACKEND_RAM ); +object_property_set_int (s->exchange_obj,"size" ,ERST_RECORD_SIZE , errp); +user_creatable_complete (USER_CREATABLE (s->exchange_obj), errp); + s->exchange =MEMORY_BACKEND (s->exchange_obj); +host_memory_backend_set_mapped (s->exchange, true); + s->exchange_mr =host_memory_backend_get_memory (s->exchange);replace this block with single
memory_region_init_ram()
done!
Quoted 6 lines
hw/acpi/erst.c line 682
Quoted 4 lines
hw/acpi/erst.c new file +2
-0+memory_region_init_resizeable_ram (s->exchange_mr,OBJECT (pci_dev), +TYPE_ACPI_ERST ,ERST_RECORD_SIZE ,ERST_RECORD_SIZE ,NULL , errp);have ho idea why it's necessary, seems just wrong, it basically leaks previous memory region and creates a new one.
done!
Quoted 6 lines
hw/acpi/erst.c line 685
Quoted 5 lines
hw/acpi/erst.c new file +3
-0+pci_register_bar (pci_dev,1 ,PCI_BASE_ADDRESS_SPACE_MEMORY , s->exchange_mr); +/* Include the exchange buffer in the migration stream */ +vmstate_register_ram_global (s->exchange_mr);not necessary if
memory_region_init_ram()is used directly
done!
Quoted 45 lines
Quoted 33 lines
hw/acpi/erst.c new file +32
-0+ +/* Include the backend storage in the migration stream */ +vmstate_register_ram_global (s->hostmem_mr); + +trace_acpi_erst_realizefn_out (s->storage_size); +} + +static void erst_reset (DeviceState *dev) +{ +ERSTDeviceState *s =ACPIERST (dev); + +trace_acpi_erst_reset_in (s->header->record_count); + s->operation =0 ; + s->busy_status =0 ; + s->command_status =STATUS_SUCCESS ; + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ; + s->record_offset =0 ; + s->next_record_index = s->first_record_index; +/* NOTE: first/last_record_index are computed only once */ +trace_acpi_erst_reset_out (s->header->record_count); +} + +static Property erst_properties[] = { +DEFINE_PROP_LINK (ACPI_ERST_MEMDEV_PROP , ERSTDeviceState, hostmem, + TYPE_MEMORY_BACKEND, HostMemoryBackend *), +DEFINE_PROP_END_OF_LIST (), +}; + +static void erst_class_init (ObjectClass *klass,void *data) +{ +DeviceClass *dc =DEVICE_CLASS (klass); +PCIDeviceClass *k =PCI_DEVICE_CLASS (klass);hw/acpi/erst.c line 727
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ +trace_acpi_erst_class_init_in (); + k->realize = erst_realizefn; + k->vendor_id =PCI_VENDOR_ID_REDHAT ; + k->device_id =PCI_DEVICE_ID_REDHAT_ACPI_ERST ; + k->revision =0x00 ; + k->class_id =PCI_CLASS_OTHERS ; + dc->reset = erst_reset; + dc->vmsd = &erst_vmstate; + dc->user_creatable = true;can't be hotplugged, add:
Quoted 1 line
dc->hotpluggable = false;
done
Quoted 60 lines
Quoted 59 lines
hw/acpi/erst.c new file +23
-0+device_class_set_props (dc, erst_properties); + dc->desc ="ACPI Error Record Serialization Table (ERST) device" ; +set_bit (DEVICE_CATEGORY_MISC , dc->categories); +trace_acpi_erst_class_init_out (); +} + +static const TypeInfo erst_type_info = { + .name =TYPE_ACPI_ERST , + .parent =TYPE_PCI_DEVICE , + .class_init = erst_class_init, + .instance_size =sizeof (ERSTDeviceState), + .interfaces = (InterfaceInfo []) { + {INTERFACE_CONVENTIONAL_PCI_DEVICE }, + { } + } +}; + +static void erst_register_types (void ) +{ +type_register_static (&erst_type_info); +} + +type_init (erst_register_types)hw/acpi/meson.build +1
-0@@ -5,6 +5,7 @@ acpi_ss.add(files( 'bios-linker-loader.c', 'core.c', 'utils.c', + 'erst.c', )) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu.c')) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu_hotplug.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) "header: 0x%p" +acpi_erst_class_init_in(void) +acpi_erst_class_init_out(void)
Re: [PATCH v6 05/10] ACPI ERST: support for ACPI ERST feature
Quoted 447 lines · On Mon, 4 Oct 2021 16:13:09 -0500 Eric DeVolder <[email protected]>…
Igor, thanks for the close examination. Inline responses below. eric
Quoted 138 lines · Igor Mammedov
Quoted 134 lines · On Thu, 5 Aug 2021 18:30:34 -0400 Eric DeVolder <[email protected]>…
This 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.
Signed-off-by Eric DeVolder <[email protected]>--- hw/acpi/erst.c | 750 +++++++++++++++++++++++++++++++++++++++++++++++++++ hw/acpi/meson.build | 1 + hw/acpi/trace-events | 15 ++ 3 files changed, 766 insertions(+)create mode 100644
hw/acpi/erst.chw/acpi/erst.c new file +116
-0@@ -0,0 +1,750 @@ +/* +* 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 +*/ + +#include <sys/types.h> +#include <sys/stat.h> +#include <unistd.h> + +#include "qemu/osdep.h" +#include "qapi/error.h" +#include "hw/qdev-core.h" +#include "exec/memory.h" +#include "qom/object.h" +#include "hw/pci/pci.h" +#include "qom/object_interfaces.h" +#include "qemu/error-report.h" +#include "migration/vmstate.h" +#include "hw/qdev-properties.h" +#include "hw/acpi/acpi.h" +#include "hw/acpi/acpi-defs.h" +#include "hw/acpi/aml-build.h" +#include "hw/acpi/bios-linker-loader.h" +#include "exec/address-spaces.h" +#include "sysemu/hostmem.h" +#include "hw/acpi/erst.h" +#include "trace.h" + +/* ACPI 4.0: Table 17-16 Serialization Actions */ +#define ACTION_BEGIN_WRITE_OPERATION 0x0 +#define ACTION_BEGIN_READ_OPERATION 0x1 +#define ACTION_BEGIN_CLEAR_OPERATION 0x2 +#define ACTION_END_OPERATION 0x3 +#define ACTION_SET_RECORD_OFFSET 0x4 +#define ACTION_EXECUTE_OPERATION 0x5 +#define ACTION_CHECK_BUSY_STATUS 0x6 +#define ACTION_GET_COMMAND_STATUS 0x7 +#define ACTION_GET_RECORD_IDENTIFIER 0x8 +#define ACTION_SET_RECORD_IDENTIFIER 0x9 +#define ACTION_GET_RECORD_COUNT 0xA +#define ACTION_BEGIN_DUMMY_WRITE_OPERATION 0xB +#define ACTION_RESERVED 0xC +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE 0xD +#define ACTION_GET_ERROR_LOG_ADDRESS_LENGTH 0xE +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0xF +#define ACTION_GET_EXECUTE_OPERATION_TIMINGS 0x10 + +/* ACPI 4.0: Table 17-17 Command Status Definitions */ +#define STATUS_SUCCESS 0x00 +#define STATUS_NOT_ENOUGH_SPACE 0x01 +#define STATUS_HARDWARE_NOT_AVAILABLE 0x02 +#define STATUS_FAILED 0x03 +#define STATUS_RECORD_STORE_EMPTY 0x04 +#define STATUS_RECORD_NOT_FOUND 0x05 + + +/* UEFI 2.1: Appendix N Common Platform Error Record */ +#define UEFI_CPER_RECORD_MIN_SIZE 128U +#define UEFI_CPER_RECORD_LENGTH_OFFSET 20U +#define UEFI_CPER_RECORD_ID_OFFSET 96U +#define IS_UEFI_CPER_RECORD (ptr) \ + (((ptr)[0] == 'C') && \ + ((ptr)[1] == 'P') && \ + ((ptr)[2] == 'E') && \ + ((ptr)[3] == 'R')) +#define THE_UEFI_CPER_RECORD_ID (ptr) \ + (*(uint64_t *)(&(ptr)[UEFI_CPER_RECORD_ID_OFFSET])) + +/* +* This implementation is an ACTION (cmd) and VALUE (data) +* interface consisting of just two 64-bit registers. +*/ +#define ERST_REG_SIZE (16UL) +#define ERST_ACTION_OFFSET (0UL)/* action (cmd) */ +#define ERST_VALUE_OFFSET (8UL)/* argument/value (data) */ + +/* +* ERST_RECORD_SIZE is the buffer size for exchanging ERST +* record contents. Thus, it defines the maximum record size. +* As this is mapped through a PCI BAR, it must be a power of +* two and larger than UEFI_CPER_RECORD_MIN_SIZE. +* The backing storage is divided into fixed size "slots", +* each ERST_RECORD_SIZE in length, and each "slot" +* storing a single record. No attempt at optimizing storage +* through compression, compaction, etc is attempted. +* NOTE that slot 0 is reserved for the backing storage header. +* Depending upon the size of the backing storage, additional +* slots will be part of the slot 0 header in order to account +* for a record_id for each available remaining slot. +*/ +/* 8KiB records, not too small, not too big */ +#define ERST_RECORD_SIZE (8192UL) + +#define ACPI_ERST_MEMDEV_PROP "memdev" + +/* +* From the ACPI ERST spec sections: +* A record id of all 0s is used to indicate +* 'unspecified' record id. +* A record id of all 1s is used to indicate +* empty or end. +*/ +#define ERST_UNSPECIFIED_RECORD_ID (0UL) +#define ERST_EMPTY_END_RECORD_ID (~0UL) +#define ERST_EXECUTE_OPERATION_MAGIC 0x9CUL +#define ERST_IS_VALID_RECORD_ID (rid) \ + ((rid != ERST_UNSPECIFIED_RECORD_ID) && \ + (rid != ERST_EMPTY_END_RECORD_ID)) + +typedef struct erst_storage_header_s {Quoted 5 lines
hw/acpi/erst.c line 117
Quoted 1 line
hw/acpi/erst.c new file +1
-0+#define ERST_STORE_MAGIC 0x524F545354535245ULmove it out of structure definition,
also where value comes from? (perhaps something starting with ERST... would be more self-describing)done; this value is 'ERSTSTOR', which I've left as a comment in v7.
Quoted 10 lines
hw/acpi/erst.c line 125
Quoted 9 lines
hw/acpi/erst.c new file +8
-0+uint64_t magic; +uint32_t record_size; +uint32_t record_offset;/* offset to record storage beyond header */ +uint16_t version; +uint16_t reserved; +uint32_t record_count; +uint64_t map[];/* contains record_ids, and position indicates index */ +} erst_storage_header_t;
docs/devel/style.rst: Typedefsdone; thanks
Quoted 3 lines
also give it's used as header layout in storage,
set packed attribute for structuredone
Quoted 50 lines
Quoted 49 lines
hw/acpi/erst.c new file +48
-0+ +/* +* Object cast macro +*/ +#define ACPIERST (obj) \ + OBJECT_CHECK(ERSTDeviceState, (obj), TYPE_ACPI_ERST) + +/* +* Main ERST device state structure +*/ +typedef struct { +PCIDevice parent_obj; + +/* Backend storage */ +HostMemoryBackend *hostmem; +MemoryRegion *hostmem_mr; + +/* Programming registers */ +MemoryRegion iomem; + +/* Exchange buffer */ +Object *exchange_obj; +HostMemoryBackend *exchange; +MemoryRegion *exchange_mr; +uint32_t storage_size; + +/* Interface state */ +uint8_t operation; +uint8_t busy_status; +uint8_t command_status; +uint32_t record_offset; +uint64_t reg_action; +uint64_t reg_value; +uint64_t record_identifier; +erst_storage_header_t *header; +unsigned next_record_index; +unsigned first_record_index; +unsigned last_record_index; + +}ERSTDeviceState ; + +/*******************************************************************/ +/*******************************************************************/ + +static uint8_t *get_nvram_ptr_by_index (ERSTDeviceState *s,unsigned index) +{ +uint8_t *rc =NULL ; +off_t offset = (index *ERST_RECORD_SIZE );Quoted 5 lines
hw/acpi/erst.c line 174
Quoted 1 line
hw/acpi/erst.c new file +1
-0+if ((offset +ERST_RECORD_SIZE ) <= s->storage_size) {it looks like 'index' passed by caller is always valid, if it's the case convert this to
g_assert((offset + ERST_RECORD_SIZE) <= s->storage_size))done
Quoted 2 lines
also shouldn't <= be just <
yes, done
Quoted 5 lines
hw/acpi/erst.c line 175
Quoted 3 lines
hw/acpi/erst.c new file +1
-0+if (s->hostmem_mr) {can
hostmem_mrbe NULL, when this function is called? if not I'd drop condition.no, so dropped. done
Quoted 10 lines
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+uint8_t *p = (uint8_t *)memory_region_get_ram_ptr (s->hostmem_mr); + rc = p + offset; + } + } +return rc; +} + +static void make_erst_storage_header (ERSTDeviceState *s) +{Quoted 8 lines
hw/acpi/erst.c line 190
Quoted 6 lines
hw/acpi/erst.c new file +6
-0+erst_storage_header_t *header = s->header; +unsigned mapsz, headersz; + + header->magic =ERST_STORE_MAGIC ; + header->record_size =ERST_RECORD_SIZE ; + header->version =0x0101 ;maybe 0 or 1 to avoid question about what previous versions are
changed to simply
0x0100(ie 1.0)Quoted 3 lines
hw/acpi/erst.c line 191
Quoted 2 lines
hw/acpi/erst.c new file +1
-0+ header->reserved =0x0000 ;s/0x.../0/
done
Quoted 8 lines
Quoted 7 lines
hw/acpi/erst.c new file +6
-0+ +/* Compute mapsize */ + mapsz = s->storage_size /ERST_RECORD_SIZE ; + mapsz *=sizeof (uint64_t ); +/* Compute header+map size */ + headersz =sizeof (erst_storage_header_t) + mapsz;Quoted 6 lines
hw/acpi/erst.c line 201
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+/* Round up to nearest integer multiple of ERST_RECORD_SIZE */ + headersz += (ERST_RECORD_SIZE -1 ); + headersz /=ERST_RECORD_SIZE ; + headersz *=ERST_RECORD_SIZE ;git grep
ROUND_UP
may be of help hereyes, thanks. I'm using that now, done.
Quoted 10 lines
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+ header->record_offset = headersz; + +/* +* The HostMemoryBackend initializes contents to zero, +* so all record_ids stashed in the map are zero'd. +* As well the record_count is zero. Properly initialized. +*/ +} +Quoted 8 lines
hw/acpi/erst.c line 215
Quoted 5 lines
hw/acpi/erst.c new file +5
-0+static void check_erst_backend_storage (ERSTDeviceState *s,Error **errp) +{ +erst_storage_header_t *header; + + header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 );optionally check/assert if it's not 64bit aligned, if it's not you risk getting killed by SIGBUG on some hosts, since you're accessing fields directly.
done!
Quoted 17 lines
Quoted 17 lines
hw/acpi/erst.c new file +16
-0+ s->header = header; + +/* Check if header is uninitialized */ +if (header->magic ==0UL ) {/* HostMemoryBackend inits to 0 */ +make_erst_storage_header (s); + } + +if (!( + (header->magic ==ERST_STORE_MAGIC ) && + (header->record_size ==ERST_RECORD_SIZE ) && + ((header->record_offset %ERST_RECORD_SIZE ) ==0 ) && + (header->version ==0x0101 ) && + (header->reserved ==0x0000 ) + )) { +error_setg (errp,"ERST backend storage header is invalid" ); + }Quoted 8 lines
hw/acpi/erst.c line 235
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+ +/* Compute offset of first and last record storage slot */ + s->first_record_index = header->record_offset /ERST_RECORD_SIZE ; + s->last_record_index = (s->storage_size /ERST_RECORD_SIZE );applies to whole patch/series,
if mmaped header values are interpreted as integers you shall take care of endianness, i.e. use cpu_to_foo/foo_to_cpu for accessdone; I'm using
cpu_to_leX()andleX_to_cpu()for any access to the header.Quoted 2 lines
and document file endianness in doc (2/10)
done
Quoted 9 lines
hw/acpi/erst.c line 239
Quoted 5 lines
hw/acpi/erst.c new file +4
-0+} + +static void set_erst_map_by_index (ERSTDeviceState *s,unsigned index, +uint64_t record_id)update_[cache|map]_[entry|record_id]() or something like this might be a better description erst and index don't really add much here as it's clear from context.
done; now
update_map_entry()Quoted 26 lines
Quoted 14 lines
hw/acpi/erst.c new file +12
-0+{ +if (index < s->last_record_index) { + s->header->map[index] = record_id; + } +} + +static unsigned lookup_erst_record (ERSTDeviceState *s, +uint64_t record_identifier) +{ +unsigned rc =0 ;/* 0 not a valid index */ +unsigned index = s->first_record_index; +hw/acpi/erst.c line 261
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+/* Find the record_identifier in the map */ +if (record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* +* Count number of valid records encountered, and +* short-circuit the loop if identifier not found +*/ +unsigned count =0 ; +for (; index < s->last_record_index && + count < s->header->record_count; ++index) { +uint64_t map_record_identifier = s->header->map[index];I'd drop
map_record_identifierand use s->header->map[index] directly, i.eQuoted 1 line
if (s->header->map[index] ...done
Quoted 16 lines
Quoted 16 lines
hw/acpi/erst.c new file +15
-0+if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { + ++count; + } +if (map_record_identifier == record_identifier) { + rc = index; +break ; + } + } + }else { +/* Find first available unoccupied slot */ +for (; index < s->last_record_index; ++index) { +if (s->header->map[index] ==ERST_UNSPECIFIED_RECORD_ID ) { + rc = index; +break ; + }Quoted 8 lines
hw/acpi/erst.c line 281
Quoted 5 lines
hw/acpi/erst.c new file +5
-0+ } + } + +return rc; +}what's the reason for combining lookup and allocate ops, if they where separated it' would be easier to follow code.
done; at one point it made sense; no longer.
Quoted 24 lines
Quoted 24 lines
hw/acpi/erst.c new file +23
-0+ +/* ACPI 4.0: 17.4.2.3 Operations - Clearing */ +static unsigned clear_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +/* No need to wipe record, just invalidate its map entry */ +set_erst_map_by_index (s, index,ERST_UNSPECIFIED_RECORD_ID ); + s->header->record_count -=1 ; + rc =STATUS_SUCCESS ; + } + +return rc; +} +Quoted 8 lines
hw/acpi/erst.c line 311
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+/* ACPI 4.0: 17.4.2.2 Operations - Reading */ +static unsigned read_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check record boundary wihin exchange buffer */ ^^^ typodone
Quoted 22 lines
Quoted 8 lines
hw/acpi/erst.c new file +7
-0+if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + } + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ;hw/acpi/erst.c line 328
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +uint8_t *ptr; +uint8_t *record = ((uint8_t *) +memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + ptr =get_nvram_ptr_by_index (s, index); +memcpy (record, ptr,ERST_RECORD_SIZE - s->record_offset);if
record_offsetis large enough that record won't fit, this will copy truncated record into the exchange buffer.
Quoted 3 lines
Quoted 1 line
Maybe it's better to fail whole op?
The first check within this function checks for this very condition, and does fail. I believe the code does as you are asking.
The 1st check guaranties that 'exchange_mr + record_offset, exchange_mr_end' has a space at least for UEFI_CPER_RECORD_MIN_SIZE, while the source record that's being copied can be larger than that.
i.e. assume
record_offset = 7, ERST_RECORD_SIZE = 10, UEFI_CPER_RECORD_MIN_SIZE = 2, ptr->record_size = 9
Quoted 1 line
if (
s->record_offset>= (ERST_RECORD_SIZE-UEFI_CPER_RECORD_MIN_SIZE))
will be passed, while
Quoted 1 line
memcpy(record, ptr, ERST_RECORD_SIZE - s->record_offset);
will copy 3 bytes only, truncating the rest of the record but still report success.
Also, while max copied amount won't exceed exchange_mr capacity due to it being equal to ERST_RECORD_SIZE in current impl., it can be dangerous later on if buffer/record sizes diverge as dependency coded here is implicit. Safer option would be using actual destination buffer/copied record size for check to avoid potential buffer overrun (I'm assuming that records are not random blobs but CPER formatted structure).
copy_size = to_be_copied_record_size
if copy_size <= memory_region_size(exchange_mr) - record_offset
memcpy(record, ptr, copy_size)
else
error_out
[1] the same applies to 'if (s->record_offset >= ...)' check make it use actual exchange_mr size explicitly.
nit:
Also use of record_offset in header and in state is a bit of overloaded, I'd consider renaming one of them to avoid confusion.
Quoted 19 lines
Quoted 11 lines
Quoted 11 lines
hw/acpi/erst.c new file +10
-0+ rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.1 Operations - Writing */ +static unsigned write_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_FAILED ;Quoted 8 lines
hw/acpi/erst.c line 345
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+unsigned index; +uint64_t record_identifier; +uint8_t *record; +uint8_t *ptr =NULL ; +bool record_found = false; + +/* Check record boundary wihin exchange buffer */ ditto, typo
Quoted 6 lines
done
Quoted 4 lines
Quoted 4 lines
hw/acpi/erst.c new file +3
-0+if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + }
see (1)
Quoted 23 lines
Quoted 6 lines
hw/acpi/erst.c line 353
Quoted 5 lines
hw/acpi/erst.c new file +5
-0+ +/* Extract record identifier */ + record = ((uint8_t *)memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + record_identifier =THE_UEFI_CPER_RECORD_ID (record);potentially unaligned access to int, should use
memcpy()done
Quoted 15 lines
Quoted 15 lines
hw/acpi/erst.c new file +14
-0+ +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, record_identifier); +if (index) { +/* Record found, overwrite existing record */ + ptr =get_nvram_ptr_by_index (s, index); + record_found = true; + }else { +/* Record not found, not an overwrite, allocate for write */ + index =lookup_erst_record (s,ERST_UNSPECIFIED_RECORD_ID );
Quoted 8 lines
Quoted 8 lines
hw/acpi/erst.c line 375
Quoted 8 lines
hw/acpi/erst.c new file +8
-0+if (index) { + ptr =get_nvram_ptr_by_index (s, index); + }else { + rc =STATUS_NOT_ENOUGH_SPACE ; + } + } +if (ptr) { +memcpy (ptr, record,ERST_RECORD_SIZE - s->record_offset);
This copies the remainder of exchange buffer, including 'leftovers' from previous operations.
Is there a reason why are you not verifying actual 'record' size in buffer and if it fits within target 'ptr' copy just useful payload from buffer?
Quoted 9 lines
Quoted 5 lines
hw/acpi/erst.c line 379
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+if (0 != s->record_offset) { +memset (&ptr[ERST_RECORD_SIZE - s->record_offset], +0xFF , s->record_offset); + }you've lost me here, care to explain what's going on here?
If the
record_offsetis not 0, then there can be bytes following the record within the slot that were not written. This simply sets them to0xFF(so bytes from a previously written record that happened to occupy this slot do not "bleed" through).
I've left a comment in v7.
well, 'bleed' happens because 'read_erst_record' copies whole slot instead of the actual record size.
And that would work, only while exchange buffer size and record size are equal, and fall apart silently as soon as that is not true, leading to potential exploits.
it might be more robust if it written like this:
if_record_is_complete (i.e. record in buffer is not truncated)
if_actual_record_size_fits_in_slot
memcpy(slot, record, actual_record_size) memset(slot+actual_record_size, 0xff, slot_size - actual_record_size);
otherwise error out
Quoted 76 lines
Quoted 6 lines
Quoted 6 lines
hw/acpi/erst.c new file +6
-0+if (!record_found) { + s->header->record_count +=1 ;/* writing new record */ + } +set_erst_map_by_index (s, index, record_identifier); + rc =STATUS_SUCCESS ; + }Quoted 8 lines
hw/acpi/erst.c line 392
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+ +return rc; +} + +/* ACPI 4.0: 17.4.2.2 Operations - Reading "During boot..." */ +static unsigned next_erst_record (ERSTDeviceState *s, +uint64_t *record_identifier)s/record_identifier/found.../
done
Quoted 11 lines
hw/acpi/erst.c line 401
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index = s->next_record_index; + + *record_identifier =ERST_EMPTY_END_RECORD_ID ; + +if (s->header->record_count) { +for (; index < s->last_record_index; ++index) { +uint64_t map_record_identifier;and then s/map_record_identifier/record_identifier/
done
Quoted 4 lines
the same applies to other occurrences within patch (
map_record_identifieris a bit confusing) or drop it and use s->header->map[index] directlydone
Quoted 23 lines
Quoted 12 lines
hw/acpi/erst.c new file +11
-0+ map_record_identifier = s->header->map[index]; +if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* where to start next time */ + s->next_record_index = index +1 ; + *record_identifier = map_record_identifier; + rc =STATUS_SUCCESS ; +break ; + } + } + } +if (rc !=STATUS_SUCCESS ) {hw/acpi/erst.c line 422
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+if (s->next_record_index == s->first_record_index) { +/* +* next_record_identifier is unchanged, no records found +* and *record_identifier contains EMPTY_END id +*/ + rc =STATUS_RECORD_STORE_EMPTY ; + } +/* at end/scan complete, reset */ + s->next_record_index = s->first_record_index; + }Quoted 3 lines
Table 17-16, says return existing error or
ERST_EMPTY_END_RECORD_IDbut nothing about op returning a error, so I'd assume status should always beSTATUS_SUCCESSforGET_RECORD_IDENTIFIER.done
Quoted 3 lines
Advancing to the next record is part of record READ op and not the part of
GET_RECORD_IDENTIFIERas it's done here.well...
Quoted 7 lines
"The steps performed by the platform to carry out ...
2. ..
c. If the specified error record does not exist,
... update the status register’s Identifier field with the identifier of the
‘first’ error record
4. Record the Identifier of the ‘next’ valid error record ...
"
Quoted 7 lines
I used ACPI spec v6 and I was asked to locate the first occurrence of ERST in the spec, which was v4. So the above spec quotes are accurate, however, spec v6 deviates in an important way from the above, which reads:
"c. If the status is Record Not Found (
0x05), indicating that the specified error record does not
exist, OSPM retrieves a valid identifier by aGET_RECORD_IDENTIFIERaction. The platform will return a valid record identifier."
that's quote from OSPM behavior,
the platform part still looks the same to me (in 4.0/5.0/6.0/6.3) (they split 2.c on 2.c and 2.d) but the meaning is the same.
Quoted 10 lines
So
GET_RECORD_IDENTIFIERis essentially a factory that pumps out record identifiers for records stored. I kind of think of it as the old DOS 'find_first/find_next'. And yes v4 of the spec states that the READ operation should initiate the firstrecord_identifer. However v6 clearly states this is now the responsibility of OSPM, not the READ op.I am thinking that the best way to handle this contradiction is to change the ACPI spec citation from v4 to v5, as the wording in v5 matches what I cite from v6, and implemented. Furthermore, this approach of OSPM obtaining the next valid
record_idviaGET_RECORD_IDENTIFIERis consistent withwhat I observed in BIOS and with how Linux is coded.
pointer[s] to source[s] please?
Well, spec can be wrong too (not the 1st time) but we need to be sure what is broken and doesn't work as it's supposed to and document it properly, before deviating from the spec.
Quoted 84 lines
Thoughts?
Quoted 60 lines
Quoted 60 lines
hw/acpi/erst.c new file +58
-0+ +return rc; +} + +/*******************************************************************/ + +static uint64_t erst_rd_reg64 (hwaddr addr, +uint64_t reg,unsigned size) +{ +uint64_t rdval; +uint64_t mask; +unsigned shift; + +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + rdval = reg; + rdval >>= shift; + rdval &= mask; + +return rdval; +} + +static uint64_t erst_wr_reg64 (hwaddr addr, +uint64_t reg,uint64_t val,unsigned size) +{ +uint64_t wrval; +uint64_t mask; +unsigned shift; +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + val &= mask; + val <<= shift; + mask <<= shift; + wrval = reg; + wrval &= ~mask; + wrval |= val; + +return wrval; +} + +static void erst_reg_write (void *opaque,hwaddr addr, +uint64_t val,unsigned size)Quoted 8 lines
hw/acpi/erst.c line 487
Quoted 6 lines
hw/acpi/erst.c new file +6
-0+{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; + +/* +* NOTE: All actions/operations/side effects happen on the WRITE, +* by design. The READs simply return the reg_value contents. point to spec, pls.
This was an implementation design choice, so no spec reference applicable, I left a comment.
Quoted 11 lines
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+*/ +trace_acpi_erst_reg_write (addr, val, size); + +switch (addr) { +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + s->reg_value =erst_wr_reg64 (addr, s->reg_value, val, size); +break ; +case ERST_ACTION_OFFSET +0 :
Quoted 7 lines
Quoted 3 lines
hw/acpi/erst.c line 497
Quoted 1 line
hw/acpi/erst.c new file +1
-0+/* case ERST_ACTION_OFFSET+4: as coded, not really a 64b register */ what does this mean?
In short, all values written to this register are just the ACTION ops, so there wasn't a need to implement this as a 64-bit register, especially since Linux seems to issue two 32-bit accesses for 64-bit; in this case the upper access is utterly useless.
I placed a comment in code.
comment as it's, above is not helpful,
so it would be better to have a comment that explains reasoning a bit better. like:
supported/impl ACPTION ops are 32 only, so ...
Quoted 344 lines
Quoted 35 lines
Quoted 25 lines
hw/acpi/erst.c new file +25
-0+switch (val) { +case ACTION_BEGIN_WRITE_OPERATION : +case ACTION_BEGIN_READ_OPERATION : +case ACTION_BEGIN_CLEAR_OPERATION : +case ACTION_BEGIN_DUMMY_WRITE_OPERATION : +case ACTION_END_OPERATION : + s->operation = val; +break ; +case ACTION_SET_RECORD_OFFSET : + s->record_offset = s->reg_value; +break ; +case ACTION_EXECUTE_OPERATION : +if ((uint8_t )s->reg_value ==ERST_EXECUTE_OPERATION_MAGIC ) { + s->busy_status =1 ; +switch (s->operation) { +case ACTION_BEGIN_WRITE_OPERATION : + s->command_status =write_erst_record (s); +break ; +case ACTION_BEGIN_READ_OPERATION : + s->command_status =read_erst_record (s); +break ; +case ACTION_BEGIN_CLEAR_OPERATION : + s->command_status =clear_erst_record (s); +break ; +case ACTION_BEGIN_DUMMY_WRITE_OPERATION :hw/acpi/erst.c line 532
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ s->command_status =STATUS_SUCCESS ; +break ; +case ACTION_END_OPERATION : + s->command_status =STATUS_SUCCESS ; +break ; +default : + s->command_status =STATUS_FAILED ; +break ; + } + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ;Quoted 1 line
shouldn't happen in case of Read op
correct, removed as not needed at all now.
Quoted 109 lines
"
17.4.2.2
4. Record the Identifier of the ‘next’ valid error record that resides on the persistent store. This allows OSPM to retrieve a valid record identifier by executing aGET_RECORD_IDENTIFIERoperation.
"Quoted 81 lines
hw/acpi/erst.c new file +81
-0+ s->busy_status =0 ; + } +break ; +case ACTION_CHECK_BUSY_STATUS : + s->reg_value = s->busy_status; +break ; +case ACTION_GET_COMMAND_STATUS : + s->reg_value = s->command_status; +break ; +case ACTION_GET_RECORD_IDENTIFIER : + s->command_status =next_erst_record (s, &s->reg_value); +break ; +case ACTION_SET_RECORD_IDENTIFIER : + s->record_identifier = s->reg_value; +break ; +case ACTION_GET_RECORD_COUNT : + s->reg_value = s->header->record_count; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE : + s->reg_value = (hwaddr )pci_get_bar_addr (PCI_DEVICE (s),1 ); +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_LENGTH : + s->reg_value =ERST_RECORD_SIZE ; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES : + s->reg_value =0x0 ;/* intentional, not NVRAM mode */ +break ; +case ACTION_GET_EXECUTE_OPERATION_TIMINGS : + s->reg_value = + (100ULL <<32 ) |/* 100us max time */ + (10ULL <<0 ) ;/* 10us min time */ +break ; +default : +/* Unknown action/command, NOP */ +break ; + } +break ; +default : +/* This should not happen, but if it does, NOP */ +break ; + } +} + +static uint64_t erst_reg_read (void *opaque,hwaddr addr, +unsigned size) +{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; +uint64_t val =0 ; + +switch (addr) { +case ERST_ACTION_OFFSET +0 : +case ERST_ACTION_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_action, size); +break ; +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_value, size); +break ; +default : +break ; + } +trace_acpi_erst_reg_read (addr, val, size); +return val; +} + +static const MemoryRegionOps erst_reg_ops = { + .read = erst_reg_read, + .write = erst_reg_write, + .endianness =DEVICE_NATIVE_ENDIAN , +}; + +/*******************************************************************/ +/*******************************************************************/ +static int erst_post_load (void *opaque,int version_id) +{ +ERSTDeviceState *s = opaque; + +/* Recompute pointer to header */ + s->header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 ); +trace_acpi_erst_post_load (s->header); +hw/acpi/erst.c line 623
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+return 0 ; +} + +static const VMStateDescription erst_vmstate = { + .name ="acpi-erst" , + .version_id =1 , + .minimum_version_id =1 , + .post_load = erst_post_load, + .fields = (VMStateField []) { +VMSTATE_UINT32 (storage_size, ERSTDeviceState),1)
Quoted 8 lines
hw/acpi/erst.c new file +8
-0+VMSTATE_UINT8 (operation, ERSTDeviceState), +VMSTATE_UINT8 (busy_status, ERSTDeviceState), +VMSTATE_UINT8 (command_status, ERSTDeviceState), +VMSTATE_UINT32 (record_offset, ERSTDeviceState), +VMSTATE_UINT64 (reg_action, ERSTDeviceState), +VMSTATE_UINT64 (reg_value, ERSTDeviceState), +VMSTATE_UINT64 (record_identifier, ERSTDeviceState), + VMSTATE_UINT32(next_record_index, ERSTDeviceState),Quoted 8 lines
hw/acpi/erst.c line 633
Quoted 2 lines
hw/acpi/erst.c new file +2
-0+VMSTATE_UINT32 (first_record_index, ERSTDeviceState), + VMSTATE_UINT32(last_record_index, ERSTDeviceState),2)
hw/acpi/erst.c line 636
Quoted 3 lines
hw/acpi/erst.c new file +3
-0+ VMSTATE_END_OF_LIST() + } +};1 and 2 aren't runtime state, so why they are in migration stream?
done; removed
storage_size,first_record_indexandlast_record_indexfrom the migration stream.Quoted 4 lines
I'd imagine size could be used to check that backend on target is of the same size to avoid buffer overrun if target side has smaller backend, and fail migration if it's not the same. But it aren't used this way here.
I decided to not do this check as that memory object is migrated automatically, so I dont think my check adds any value.
Quoted 2 lines
the rest could be calculated at realize time.
and in fact they are.
Quoted 40 lines
Quoted 38 lines
hw/acpi/erst.c new file +37
-0+ +static void erst_realizefn (PCIDevice *pci_dev,Error **errp) +{ +ERSTDeviceState *s =ACPIERST (pci_dev); + +trace_acpi_erst_realizefn_in (); + +if (!s->hostmem) { +error_setg (errp,"'" ACPI_ERST_MEMDEV_PROP "' property is not set" ); +return ; + }else if (host_memory_backend_is_mapped (s->hostmem)) { +error_setg (errp,"can't use already busy memdev: %s" , +object_get_canonical_path_component (OBJECT (s->hostmem))); +return ; + } + + s->hostmem_mr =host_memory_backend_get_memory (s->hostmem); + +/* HostMemoryBackend size will be multiple of PAGE_SIZE */ + s->storage_size =object_property_get_int (OBJECT (s->hostmem),"size" , errp); + +/* Check storage_size against ERST_RECORD_SIZE */ +if (((s->storage_size %ERST_RECORD_SIZE ) !=0 ) || + (ERST_RECORD_SIZE > s->storage_size)) { +error_setg (errp,"ACPI ERST requires size be multiple of " +"record size (%luKiB)" ,ERST_RECORD_SIZE ); + } + +/* Initialize backend storage and record_count */ +check_erst_backend_storage (s, errp); + +/* BAR 0: Programming registers */ +memory_region_init_io (&s->iomem,OBJECT (pci_dev), &erst_reg_ops, s, +TYPE_ACPI_ERST ,ERST_REG_SIZE ); +pci_register_bar (pci_dev,0 ,PCI_BASE_ADDRESS_SPACE_MEMORY , &s->iomem); + +/* BAR 1: Exchange buffer memory */ Quoted 8 lines
hw/acpi/erst.c line 680
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+/* Create a hostmem object to use as the exchange buffer */ + s->exchange_obj =object_new (TYPE_MEMORY_BACKEND_RAM ); +object_property_set_int (s->exchange_obj,"size" ,ERST_RECORD_SIZE , errp); +user_creatable_complete (USER_CREATABLE (s->exchange_obj), errp); + s->exchange =MEMORY_BACKEND (s->exchange_obj); +host_memory_backend_set_mapped (s->exchange, true); + s->exchange_mr =host_memory_backend_get_memory (s->exchange);replace this block with single
memory_region_init_ram()done!
Quoted 6 lines
hw/acpi/erst.c line 682
Quoted 4 lines
hw/acpi/erst.c new file +2
-0+memory_region_init_resizeable_ram (s->exchange_mr,OBJECT (pci_dev), +TYPE_ACPI_ERST ,ERST_RECORD_SIZE ,ERST_RECORD_SIZE ,NULL , errp);have ho idea why it's necessary, seems just wrong, it basically leaks previous memory region and creates a new one.
done!
Quoted 6 lines
hw/acpi/erst.c line 685
Quoted 5 lines
hw/acpi/erst.c new file +3
-0+pci_register_bar (pci_dev,1 ,PCI_BASE_ADDRESS_SPACE_MEMORY , s->exchange_mr); +/* Include the exchange buffer in the migration stream */ +vmstate_register_ram_global (s->exchange_mr);not necessary if
memory_region_init_ram()is used directlydone!
Quoted 45 lines
Quoted 33 lines
hw/acpi/erst.c new file +32
-0+ +/* Include the backend storage in the migration stream */ +vmstate_register_ram_global (s->hostmem_mr); + +trace_acpi_erst_realizefn_out (s->storage_size); +} + +static void erst_reset (DeviceState *dev) +{ +ERSTDeviceState *s =ACPIERST (dev); + +trace_acpi_erst_reset_in (s->header->record_count); + s->operation =0 ; + s->busy_status =0 ; + s->command_status =STATUS_SUCCESS ; + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ; + s->record_offset =0 ; + s->next_record_index = s->first_record_index; +/* NOTE: first/last_record_index are computed only once */ +trace_acpi_erst_reset_out (s->header->record_count); +} + +static Property erst_properties[] = { +DEFINE_PROP_LINK (ACPI_ERST_MEMDEV_PROP , ERSTDeviceState, hostmem, + TYPE_MEMORY_BACKEND, HostMemoryBackend *), +DEFINE_PROP_END_OF_LIST (), +}; + +static void erst_class_init (ObjectClass *klass,void *data) +{ +DeviceClass *dc =DEVICE_CLASS (klass); +PCIDeviceClass *k =PCI_DEVICE_CLASS (klass);hw/acpi/erst.c line 727
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ +trace_acpi_erst_class_init_in (); + k->realize = erst_realizefn; + k->vendor_id =PCI_VENDOR_ID_REDHAT ; + k->device_id =PCI_DEVICE_ID_REDHAT_ACPI_ERST ; + k->revision =0x00 ; + k->class_id =PCI_CLASS_OTHERS ; + dc->reset = erst_reset; + dc->vmsd = &erst_vmstate; + dc->user_creatable = true;can't be hotplugged, add:
Quoted 1 line
dc->hotpluggable = false;done
Quoted 60 lines
Quoted 59 lines
hw/acpi/erst.c new file +23
-0+device_class_set_props (dc, erst_properties); + dc->desc ="ACPI Error Record Serialization Table (ERST) device" ; +set_bit (DEVICE_CATEGORY_MISC , dc->categories); +trace_acpi_erst_class_init_out (); +} + +static const TypeInfo erst_type_info = { + .name =TYPE_ACPI_ERST , + .parent =TYPE_PCI_DEVICE , + .class_init = erst_class_init, + .instance_size =sizeof (ERSTDeviceState), + .interfaces = (InterfaceInfo []) { + {INTERFACE_CONVENTIONAL_PCI_DEVICE }, + { } + } +}; + +static void erst_register_types (void ) +{ +type_register_static (&erst_type_info); +} + +type_init (erst_register_types)hw/acpi/meson.build +1
-0@@ -5,6 +5,7 @@ acpi_ss.add(files( 'bios-linker-loader.c', 'core.c', 'utils.c', + 'erst.c', )) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu.c')) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu_hotplug.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) "header: 0x%p" +acpi_erst_class_init_in(void) +acpi_erst_class_init_out(void)
Re: [PATCH v6 05/10] ACPI ERST: support for ACPI ERST feature
Igor, again thanks for the detailed review. Inline responses below. eric
Quoted 460 lines · Igor Mammedov
Quoted 447 lines · On Mon, 4 Oct 2021 16:13:09 -0500 Eric DeVolder <[email protected]>…
Igor, thanks for the close examination. Inline responses below. eric
Quoted 138 lines · Igor Mammedov
Quoted 134 lines · On Thu, 5 Aug 2021 18:30:34 -0400 Eric DeVolder <[email protected]>…
This 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.
Signed-off-by Eric DeVolder <[email protected]>--- hw/acpi/erst.c | 750 +++++++++++++++++++++++++++++++++++++++++++++++++++ hw/acpi/meson.build | 1 + hw/acpi/trace-events | 15 ++ 3 files changed, 766 insertions(+)create mode 100644
hw/acpi/erst.chw/acpi/erst.c new file +116
-0@@ -0,0 +1,750 @@ +/* +* 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 +*/ + +#include <sys/types.h> +#include <sys/stat.h> +#include <unistd.h> + +#include "qemu/osdep.h" +#include "qapi/error.h" +#include "hw/qdev-core.h" +#include "exec/memory.h" +#include "qom/object.h" +#include "hw/pci/pci.h" +#include "qom/object_interfaces.h" +#include "qemu/error-report.h" +#include "migration/vmstate.h" +#include "hw/qdev-properties.h" +#include "hw/acpi/acpi.h" +#include "hw/acpi/acpi-defs.h" +#include "hw/acpi/aml-build.h" +#include "hw/acpi/bios-linker-loader.h" +#include "exec/address-spaces.h" +#include "sysemu/hostmem.h" +#include "hw/acpi/erst.h" +#include "trace.h" + +/* ACPI 4.0: Table 17-16 Serialization Actions */ +#define ACTION_BEGIN_WRITE_OPERATION 0x0 +#define ACTION_BEGIN_READ_OPERATION 0x1 +#define ACTION_BEGIN_CLEAR_OPERATION 0x2 +#define ACTION_END_OPERATION 0x3 +#define ACTION_SET_RECORD_OFFSET 0x4 +#define ACTION_EXECUTE_OPERATION 0x5 +#define ACTION_CHECK_BUSY_STATUS 0x6 +#define ACTION_GET_COMMAND_STATUS 0x7 +#define ACTION_GET_RECORD_IDENTIFIER 0x8 +#define ACTION_SET_RECORD_IDENTIFIER 0x9 +#define ACTION_GET_RECORD_COUNT 0xA +#define ACTION_BEGIN_DUMMY_WRITE_OPERATION 0xB +#define ACTION_RESERVED 0xC +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE 0xD +#define ACTION_GET_ERROR_LOG_ADDRESS_LENGTH 0xE +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0xF +#define ACTION_GET_EXECUTE_OPERATION_TIMINGS 0x10 + +/* ACPI 4.0: Table 17-17 Command Status Definitions */ +#define STATUS_SUCCESS 0x00 +#define STATUS_NOT_ENOUGH_SPACE 0x01 +#define STATUS_HARDWARE_NOT_AVAILABLE 0x02 +#define STATUS_FAILED 0x03 +#define STATUS_RECORD_STORE_EMPTY 0x04 +#define STATUS_RECORD_NOT_FOUND 0x05 + + +/* UEFI 2.1: Appendix N Common Platform Error Record */ +#define UEFI_CPER_RECORD_MIN_SIZE 128U +#define UEFI_CPER_RECORD_LENGTH_OFFSET 20U +#define UEFI_CPER_RECORD_ID_OFFSET 96U +#define IS_UEFI_CPER_RECORD (ptr) \ + (((ptr)[0] == 'C') && \ + ((ptr)[1] == 'P') && \ + ((ptr)[2] == 'E') && \ + ((ptr)[3] == 'R')) +#define THE_UEFI_CPER_RECORD_ID (ptr) \ + (*(uint64_t *)(&(ptr)[UEFI_CPER_RECORD_ID_OFFSET])) + +/* +* This implementation is an ACTION (cmd) and VALUE (data) +* interface consisting of just two 64-bit registers. +*/ +#define ERST_REG_SIZE (16UL) +#define ERST_ACTION_OFFSET (0UL)/* action (cmd) */ +#define ERST_VALUE_OFFSET (8UL)/* argument/value (data) */ + +/* +* ERST_RECORD_SIZE is the buffer size for exchanging ERST +* record contents. Thus, it defines the maximum record size. +* As this is mapped through a PCI BAR, it must be a power of +* two and larger than UEFI_CPER_RECORD_MIN_SIZE. +* The backing storage is divided into fixed size "slots", +* each ERST_RECORD_SIZE in length, and each "slot" +* storing a single record. No attempt at optimizing storage +* through compression, compaction, etc is attempted. +* NOTE that slot 0 is reserved for the backing storage header. +* Depending upon the size of the backing storage, additional +* slots will be part of the slot 0 header in order to account +* for a record_id for each available remaining slot. +*/ +/* 8KiB records, not too small, not too big */ +#define ERST_RECORD_SIZE (8192UL) + +#define ACPI_ERST_MEMDEV_PROP "memdev" + +/* +* From the ACPI ERST spec sections: +* A record id of all 0s is used to indicate +* 'unspecified' record id. +* A record id of all 1s is used to indicate +* empty or end. +*/ +#define ERST_UNSPECIFIED_RECORD_ID (0UL) +#define ERST_EMPTY_END_RECORD_ID (~0UL) +#define ERST_EXECUTE_OPERATION_MAGIC 0x9CUL +#define ERST_IS_VALID_RECORD_ID (rid) \ + ((rid != ERST_UNSPECIFIED_RECORD_ID) && \ + (rid != ERST_EMPTY_END_RECORD_ID)) + +typedef struct erst_storage_header_s {Quoted 5 lines
hw/acpi/erst.c line 117
Quoted 1 line
hw/acpi/erst.c new file +1
-0+#define ERST_STORE_MAGIC 0x524F545354535245ULmove it out of structure definition,
also where value comes from? (perhaps something starting with ERST... would be more self-describing)done; this value is 'ERSTSTOR', which I've left as a comment in v7.
Quoted 10 lines
hw/acpi/erst.c line 125
Quoted 9 lines
hw/acpi/erst.c new file +8
-0+uint64_t magic; +uint32_t record_size; +uint32_t record_offset;/* offset to record storage beyond header */ +uint16_t version; +uint16_t reserved; +uint32_t record_count; +uint64_t map[];/* contains record_ids, and position indicates index */ +} erst_storage_header_t;
docs/devel/style.rst: Typedefsdone; thanks
Quoted 3 lines
also give it's used as header layout in storage,
set packed attribute for structuredone
Quoted 50 lines
Quoted 49 lines
hw/acpi/erst.c new file +48
-0+ +/* +* Object cast macro +*/ +#define ACPIERST (obj) \ + OBJECT_CHECK(ERSTDeviceState, (obj), TYPE_ACPI_ERST) + +/* +* Main ERST device state structure +*/ +typedef struct { +PCIDevice parent_obj; + +/* Backend storage */ +HostMemoryBackend *hostmem; +MemoryRegion *hostmem_mr; + +/* Programming registers */ +MemoryRegion iomem; + +/* Exchange buffer */ +Object *exchange_obj; +HostMemoryBackend *exchange; +MemoryRegion *exchange_mr; +uint32_t storage_size; + +/* Interface state */ +uint8_t operation; +uint8_t busy_status; +uint8_t command_status; +uint32_t record_offset; +uint64_t reg_action; +uint64_t reg_value; +uint64_t record_identifier; +erst_storage_header_t *header; +unsigned next_record_index; +unsigned first_record_index; +unsigned last_record_index; + +}ERSTDeviceState ; + +/*******************************************************************/ +/*******************************************************************/ + +static uint8_t *get_nvram_ptr_by_index (ERSTDeviceState *s,unsigned index) +{ +uint8_t *rc =NULL ; +off_t offset = (index *ERST_RECORD_SIZE );Quoted 5 lines
hw/acpi/erst.c line 174
Quoted 1 line
hw/acpi/erst.c new file +1
-0+if ((offset +ERST_RECORD_SIZE ) <= s->storage_size) {it looks like 'index' passed by caller is always valid, if it's the case convert this to
g_assert((offset + ERST_RECORD_SIZE) <= s->storage_size))done
Quoted 2 lines
also shouldn't <= be just <
yes, done
Quoted 5 lines
hw/acpi/erst.c line 175
Quoted 3 lines
hw/acpi/erst.c new file +1
-0+if (s->hostmem_mr) {can
hostmem_mrbe NULL, when this function is called? if not I'd drop condition.no, so dropped. done
Quoted 10 lines
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+uint8_t *p = (uint8_t *)memory_region_get_ram_ptr (s->hostmem_mr); + rc = p + offset; + } + } +return rc; +} + +static void make_erst_storage_header (ERSTDeviceState *s) +{Quoted 8 lines
hw/acpi/erst.c line 190
Quoted 6 lines
hw/acpi/erst.c new file +6
-0+erst_storage_header_t *header = s->header; +unsigned mapsz, headersz; + + header->magic =ERST_STORE_MAGIC ; + header->record_size =ERST_RECORD_SIZE ; + header->version =0x0101 ;maybe 0 or 1 to avoid question about what previous versions are
changed to simply
0x0100(ie 1.0)Quoted 3 lines
hw/acpi/erst.c line 191
Quoted 2 lines
hw/acpi/erst.c new file +1
-0+ header->reserved =0x0000 ;s/0x.../0/
done
Quoted 8 lines
Quoted 7 lines
hw/acpi/erst.c new file +6
-0+ +/* Compute mapsize */ + mapsz = s->storage_size /ERST_RECORD_SIZE ; + mapsz *=sizeof (uint64_t ); +/* Compute header+map size */ + headersz =sizeof (erst_storage_header_t) + mapsz;Quoted 6 lines
hw/acpi/erst.c line 201
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+/* Round up to nearest integer multiple of ERST_RECORD_SIZE */ + headersz += (ERST_RECORD_SIZE -1 ); + headersz /=ERST_RECORD_SIZE ; + headersz *=ERST_RECORD_SIZE ;git grep
ROUND_UP
may be of help hereyes, thanks. I'm using that now, done.
Quoted 10 lines
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+ header->record_offset = headersz; + +/* +* The HostMemoryBackend initializes contents to zero, +* so all record_ids stashed in the map are zero'd. +* As well the record_count is zero. Properly initialized. +*/ +} +Quoted 8 lines
hw/acpi/erst.c line 215
Quoted 5 lines
hw/acpi/erst.c new file +5
-0+static void check_erst_backend_storage (ERSTDeviceState *s,Error **errp) +{ +erst_storage_header_t *header; + + header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 );optionally check/assert if it's not 64bit aligned, if it's not you risk getting killed by SIGBUG on some hosts, since you're accessing fields directly.
done!
Quoted 17 lines
Quoted 17 lines
hw/acpi/erst.c new file +16
-0+ s->header = header; + +/* Check if header is uninitialized */ +if (header->magic ==0UL ) {/* HostMemoryBackend inits to 0 */ +make_erst_storage_header (s); + } + +if (!( + (header->magic ==ERST_STORE_MAGIC ) && + (header->record_size ==ERST_RECORD_SIZE ) && + ((header->record_offset %ERST_RECORD_SIZE ) ==0 ) && + (header->version ==0x0101 ) && + (header->reserved ==0x0000 ) + )) { +error_setg (errp,"ERST backend storage header is invalid" ); + }Quoted 8 lines
hw/acpi/erst.c line 235
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+ +/* Compute offset of first and last record storage slot */ + s->first_record_index = header->record_offset /ERST_RECORD_SIZE ; + s->last_record_index = (s->storage_size /ERST_RECORD_SIZE );applies to whole patch/series,
if mmaped header values are interpreted as integers you shall take care of endianness, i.e. use cpu_to_foo/foo_to_cpu for accessdone; I'm using
cpu_to_leX()andleX_to_cpu()for any access to the header.Quoted 2 lines
and document file endianness in doc (2/10)
done
Quoted 9 lines
hw/acpi/erst.c line 239
Quoted 5 lines
hw/acpi/erst.c new file +4
-0+} + +static void set_erst_map_by_index (ERSTDeviceState *s,unsigned index, +uint64_t record_id)update_[cache|map]_[entry|record_id]() or something like this might be a better description erst and index don't really add much here as it's clear from context.
done; now
update_map_entry()Quoted 26 lines
Quoted 14 lines
hw/acpi/erst.c new file +12
-0+{ +if (index < s->last_record_index) { + s->header->map[index] = record_id; + } +} + +static unsigned lookup_erst_record (ERSTDeviceState *s, +uint64_t record_identifier) +{ +unsigned rc =0 ;/* 0 not a valid index */ +unsigned index = s->first_record_index; +hw/acpi/erst.c line 261
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+/* Find the record_identifier in the map */ +if (record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* +* Count number of valid records encountered, and +* short-circuit the loop if identifier not found +*/ +unsigned count =0 ; +for (; index < s->last_record_index && + count < s->header->record_count; ++index) { +uint64_t map_record_identifier = s->header->map[index];I'd drop
map_record_identifierand use s->header->map[index] directly, i.eQuoted 1 line
if (s->header->map[index] ...done
Quoted 16 lines
Quoted 16 lines
hw/acpi/erst.c new file +15
-0+if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { + ++count; + } +if (map_record_identifier == record_identifier) { + rc = index; +break ; + } + } + }else { +/* Find first available unoccupied slot */ +for (; index < s->last_record_index; ++index) { +if (s->header->map[index] ==ERST_UNSPECIFIED_RECORD_ID ) { + rc = index; +break ; + }Quoted 8 lines
hw/acpi/erst.c line 281
Quoted 5 lines
hw/acpi/erst.c new file +5
-0+ } + } + +return rc; +}what's the reason for combining lookup and allocate ops, if they where separated it' would be easier to follow code.
done; at one point it made sense; no longer.
Quoted 24 lines
Quoted 24 lines
hw/acpi/erst.c new file +23
-0+ +/* ACPI 4.0: 17.4.2.3 Operations - Clearing */ +static unsigned clear_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +/* No need to wipe record, just invalidate its map entry */ +set_erst_map_by_index (s, index,ERST_UNSPECIFIED_RECORD_ID ); + s->header->record_count -=1 ; + rc =STATUS_SUCCESS ; + } + +return rc; +} +Quoted 8 lines
hw/acpi/erst.c line 311
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+/* ACPI 4.0: 17.4.2.2 Operations - Reading */ +static unsigned read_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check record boundary wihin exchange buffer */ ^^^ typodone
Quoted 22 lines
Quoted 8 lines
hw/acpi/erst.c new file +7
-0+if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + } + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ;hw/acpi/erst.c line 328
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +uint8_t *ptr; +uint8_t *record = ((uint8_t *) +memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + ptr =get_nvram_ptr_by_index (s, index); +memcpy (record, ptr,ERST_RECORD_SIZE - s->record_offset);if
record_offsetis large enough that record won't fit, this will copy truncated record into the exchange buffer.Quoted 3 lines
Quoted 1 line
Maybe it's better to fail whole op?
The first check within this function checks for this very condition, and does fail. I believe the code does as you are asking.
The 1st check guaranties that '
exchange_mr+record_offset,exchange_mr_end'
has a space at least forUEFI_CPER_RECORD_MIN_SIZE, while the source record that's being copied can be larger than that.
i.e. assume
record_offset= 7,ERST_RECORD_SIZE= 10,UEFI_CPER_RECORD_MIN_SIZE= 2,ptr->record_size= 9
Quoted 5 lines
Quoted 1 line
if (
s->record_offset>= (ERST_RECORD_SIZE-UEFI_CPER_RECORD_MIN_SIZE))will be passed, while
Quoted 1 line
memcpy(record, ptr, ERST_RECORD_SIZE - s->record_offset);will copy 3 bytes only, truncating the rest of the record but still report success.
ok, I understand now, thanks!
Quoted 8 lines
Also, while max copied amount won't exceed
exchange_mrcapacity due to it being equal toERST_RECORD_SIZEin current impl., it can be dangerous later on if buffer/record sizes diverge as dependency coded here is implicit. Safer option would be using actual destination buffer/copied record size for check to avoid potential buffer overrun (I'm assuming that records are not random blobs but CPER formatted structure).
Quoted 5 lines
copy_size=to_be_copied_record_size
ifcopy_size<=memory_region_size(exchange_mr)-record_offset
memcpy(record, ptr, copy_size)
else
error_out
ok
Quoted 3 lines
[1] the same applies to 'if (
s->record_offset>= ...)' check make it use actualexchange_mrsize explicitly.
ok
Quoted 4 lines
nit:
Also use ofrecord_offsetin header and in state is a bit of overloaded, I'd consider renaming one of them to avoid confusion.
done; changed header field to 'storage_offset'
Quoted 20 lines
Quoted 20 lines
Quoted 20 lines
Quoted 9 lines
hw/acpi/erst.c new file +7
-0+ rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.1 Operations - Writing */ hw/acpi/erst.c line 345
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+static unsigned write_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_FAILED ; +unsigned index; +uint64_t record_identifier; +uint8_t *record; +uint8_t *ptr =NULL ; +bool record_found = false; + +/* Check record boundary wihin exchange buffer */ ditto, typo
Quoted 7 lines
Quoted 6 lines
done
Quoted 4 lines
Quoted 4 lines
hw/acpi/erst.c new file +3
-0+if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + }see (1)
yep
Quoted 29 lines
Quoted 29 lines
Quoted 7 lines
hw/acpi/erst.c line 353
Quoted 6 lines
hw/acpi/erst.c new file +5
-0+ +/* Extract record identifier */ + record = ((uint8_t *)memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + record_identifier =THE_UEFI_CPER_RECORD_ID (record);potentially unaligned access to int, should use
memcpy()done
Quoted 20 lines
Quoted 20 lines
hw/acpi/erst.c new file +19
-0+ +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, record_identifier); +if (index) { +/* Record found, overwrite existing record */ + ptr =get_nvram_ptr_by_index (s, index); + record_found = true; + }else { +/* Record not found, not an overwrite, allocate for write */ + index =lookup_erst_record (s,ERST_UNSPECIFIED_RECORD_ID ); +if (index) { + ptr =get_nvram_ptr_by_index (s, index); + }else { + rc =STATUS_NOT_ENOUGH_SPACE ; + }
Quoted 8 lines
Quoted 3 lines
Quoted 3 lines
hw/acpi/erst.c line 375
Quoted 3 lines
hw/acpi/erst.c new file +3
-0+ } +if (ptr) { +memcpy (ptr, record,ERST_RECORD_SIZE - s->record_offset);This copies the remainder of exchange buffer, including 'leftovers' from previous operations.
Is there a reason why are you not verifying actual 'record' size in buffer and if it fits within target 'ptr' copy just useful payload from buffer?
So I think this question might be getting at a fundamental difference (and thus the questions/points you are raising). The UEFI CPER record has a member field 'record_length':
"Indicates the size of the actual error record, including the size of the record header, all section descriptors, and section bodies. The size may include extra buffer space to allow for the dynamic addition of error sections descriptors bodies."
Thus far, in this implementation, I have *avoided* using 'record_length' out of the record as simply deeming it as untrustworthy and a possible attack vector. Instead, I've been using (ERST_RECORD_SIZE-s->record_offset) as the length of the record to copy.
I could use 'record_length', and validate it prior to trusting it. Validation here would simply be ensuring it is <= ERST_RECORD_SIZE? I think this is what you are suggesting, correct?
Quoted 18 lines
Quoted 10 lines
Quoted 6 lines
hw/acpi/erst.c line 379
Quoted 5 lines
hw/acpi/erst.c new file +4
-0+if (0 != s->record_offset) { +memset (&ptr[ERST_RECORD_SIZE - s->record_offset], +0xFF , s->record_offset); + }you've lost me here, care to explain what's going on here?
If the
record_offsetis not 0, then there can be bytes following the record within the slot that were not written. This simply sets them to0xFF(so bytes from a previously written record that happened to occupy this slot do not "bleed" through).
I've left a comment in v7.well, 'bleed' happens because '
read_erst_record' copies whole slot instead of the actual record size.And that would work, only while exchange buffer size and record size are equal, and fall apart silently as soon as that is not true, leading to potential exploits.
Quoted 6 lines
it might be more robust if it written like this:
if_record_is_complete(i.e. record in buffer is not truncated)
if_actual_record_size_fits_in_slot
memcpy(slot, record, actual_record_size)memset(slot+actual_record_size, 0xff, slot_size - actual_record_size);
otherwise error out
See question on 'record_length' above.
Quoted 81 lines
Quoted 81 lines
Quoted 15 lines
Quoted 4 lines
hw/acpi/erst.c new file +3
-0+if (!record_found) { + s->header->record_count +=1 ;/* writing new record */ + }hw/acpi/erst.c line 392
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+set_erst_map_by_index (s, index, record_identifier); + rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.2 Operations - Reading "During boot..." */ +static unsigned next_erst_record (ERSTDeviceState *s, +uint64_t *record_identifier)s/record_identifier/found.../
done
Quoted 11 lines
hw/acpi/erst.c line 401
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index = s->next_record_index; + + *record_identifier =ERST_EMPTY_END_RECORD_ID ; + +if (s->header->record_count) { +for (; index < s->last_record_index; ++index) { +uint64_t map_record_identifier;and then s/map_record_identifier/record_identifier/
done
Quoted 4 lines
the same applies to other occurrences within patch (
map_record_identifieris a bit confusing) or drop it and use s->header->map[index] directlydone
Quoted 23 lines
Quoted 12 lines
hw/acpi/erst.c new file +11
-0+ map_record_identifier = s->header->map[index]; +if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* where to start next time */ + s->next_record_index = index +1 ; + *record_identifier = map_record_identifier; + rc =STATUS_SUCCESS ; +break ; + } + } + } +if (rc !=STATUS_SUCCESS ) {hw/acpi/erst.c line 422
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+if (s->next_record_index == s->first_record_index) { +/* +* next_record_identifier is unchanged, no records found +* and *record_identifier contains EMPTY_END id +*/ + rc =STATUS_RECORD_STORE_EMPTY ; + } +/* at end/scan complete, reset */ + s->next_record_index = s->first_record_index; + }Quoted 3 lines
Table 17-16, says return existing error or
ERST_EMPTY_END_RECORD_IDbut nothing about op returning a error, so I'd assume status should always beSTATUS_SUCCESSforGET_RECORD_IDENTIFIER.done
Quoted 3 lines
Advancing to the next record is part of record READ op and not the part of
GET_RECORD_IDENTIFIERas it's done here.well...
Quoted 7 lines
"The steps performed by the platform to carry out ...
2. ..
c. If the specified error record does not exist,
... update the status register’s Identifier field with the identifier of the
‘first’ error record
4. Record the Identifier of the ‘next’ valid error record ...
"I used ACPI spec v6 and I was asked to locate the first occurrence of ERST in the spec, which was v4. So the above spec quotes are accurate, however, spec v6 deviates in an important way from the above, which reads:
Quoted 8 lines
Quoted 3 lines
"c. If the status is Record Not Found (0x05), indicating that the specified error record does notexist, OSPM retrieves a valid identifier by a
GET_RECORD_IDENTIFIERaction. The platform will return a valid record identifier."that's quote from OSPM behavior,
the platform part still looks the same to me (in 4.0/5.0/6.0/6.3) (they split 2.c on 2.c and 2.d) but the meaning is the same.
So I now see that the description of the READ operation actually has two sections; the first starts with "during boot" and another talking about a straight up read operation. I had been focusing on the "on boot" reading, but alas I do need to accomodate better the plain read, as you point out.
Quoted 7 lines
Quoted 7 lines
So
GET_RECORD_IDENTIFIERis essentially a factory that pumps out record identifiers for records stored. I kind of think of it as the old DOS 'find_first/find_next'. And yes v4 of the spec states that the READ operation should initiate the firstrecord_identifer. However v6 clearly states this is now the responsibility of OSPM, not the READ op.
Quoted 6 lines
Quoted 5 lines
I am thinking that the best way to handle this contradiction is to change the ACPI spec citation from v4 to v5, as the wording in v5 matches what I cite from v6, and implemented. Furthermore, this approach of OSPM obtaining the next valid
record_idviaGET_RECORD_IDENTIFIERis consistent withwhat I observed in BIOS and with how Linux is coded.
pointer[s] to source[s] please?
Fwiw, Linux converts all the entries in ERST into pstore entries upon boot. Any subsequent "read" of the pstore entry does not touch ERST again; instead it reads from the in-kernel pstore contents.
The driver in Linux is drivers/acpi/apei/erst.c; but note that it conforms to the pstore set of callbacks.
Quoted 5 lines
Well, spec can be wrong too (not the 1st time) but we need to be sure what is broken and doesn't work as it's supposed to and document it properly, before deviating from the spec.
I see now specs appear to be the same. I need to accomodate the non "on boot" path.
Quoted 90 lines
Quoted 90 lines
Thoughts?
Quoted 60 lines
Quoted 60 lines
hw/acpi/erst.c new file +58
-0+ +return rc; +} + +/*******************************************************************/ + +static uint64_t erst_rd_reg64 (hwaddr addr, +uint64_t reg,unsigned size) +{ +uint64_t rdval; +uint64_t mask; +unsigned shift; + +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + rdval = reg; + rdval >>= shift; + rdval &= mask; + +return rdval; +} + +static uint64_t erst_wr_reg64 (hwaddr addr, +uint64_t reg,uint64_t val,unsigned size) +{ +uint64_t wrval; +uint64_t mask; +unsigned shift; +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + val &= mask; + val <<= shift; + mask <<= shift; + wrval = reg; + wrval &= ~mask; + wrval |= val; + +return wrval; +} + +static void erst_reg_write (void *opaque,hwaddr addr, +uint64_t val,unsigned size)Quoted 8 lines
hw/acpi/erst.c line 487
Quoted 6 lines
hw/acpi/erst.c new file +6
-0+{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; + +/* +* NOTE: All actions/operations/side effects happen on the WRITE, +* by design. The READs simply return the reg_value contents. point to spec, pls.
This was an implementation design choice, so no spec reference applicable, I left a comment.
Quoted 14 lines
hw/acpi/erst.c line 497
Quoted 12 lines
hw/acpi/erst.c new file +10
-0+*/ +trace_acpi_erst_reg_write (addr, val, size); + +switch (addr) { +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + s->reg_value =erst_wr_reg64 (addr, s->reg_value, val, size); +break ; +case ERST_ACTION_OFFSET +0 : +/* case ERST_ACTION_OFFSET+4: as coded, not really a 64b register */ what does this mean?
Quoted 8 lines
Quoted 4 lines
In short, all values written to this register are just the ACTION ops, so there wasn't a need to implement this as a 64-bit register, especially since Linux seems to issue two 32-bit accesses for 64-bit; in this case the upper access is utterly useless.
I placed a comment in code.comment as it's, above is not helpful,
so it would be better to have a comment that explains reasoning a bit better. like:
supported/impl ACPTION ops are 32 only, so ...
ok
Quoted 346 lines
Quoted 345 lines
Quoted 36 lines
Quoted 26 lines
hw/acpi/erst.c new file +25
-0+switch (val) { +case ACTION_BEGIN_WRITE_OPERATION : +case ACTION_BEGIN_READ_OPERATION : +case ACTION_BEGIN_CLEAR_OPERATION : +case ACTION_BEGIN_DUMMY_WRITE_OPERATION : +case ACTION_END_OPERATION : + s->operation = val; +break ; +case ACTION_SET_RECORD_OFFSET : + s->record_offset = s->reg_value; +break ; +case ACTION_EXECUTE_OPERATION : +if ((uint8_t )s->reg_value ==ERST_EXECUTE_OPERATION_MAGIC ) { + s->busy_status =1 ; +switch (s->operation) { +case ACTION_BEGIN_WRITE_OPERATION : + s->command_status =write_erst_record (s); +break ; +case ACTION_BEGIN_READ_OPERATION : + s->command_status =read_erst_record (s); +break ; +case ACTION_BEGIN_CLEAR_OPERATION : + s->command_status =clear_erst_record (s); +break ; +case ACTION_BEGIN_DUMMY_WRITE_OPERATION :hw/acpi/erst.c line 532
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ s->command_status =STATUS_SUCCESS ; +break ; +case ACTION_END_OPERATION : + s->command_status =STATUS_SUCCESS ; +break ; +default : + s->command_status =STATUS_FAILED ; +break ; + } + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ;Quoted 1 line
shouldn't happen in case of Read op
correct, removed as not needed at all now.
Quoted 109 lines
"
17.4.2.2
4. Record the Identifier of the ‘next’ valid error record that resides on the persistent store. This allows OSPM to retrieve a valid record identifier by executing aGET_RECORD_IDENTIFIERoperation.
"Quoted 81 lines
hw/acpi/erst.c new file +81
-0+ s->busy_status =0 ; + } +break ; +case ACTION_CHECK_BUSY_STATUS : + s->reg_value = s->busy_status; +break ; +case ACTION_GET_COMMAND_STATUS : + s->reg_value = s->command_status; +break ; +case ACTION_GET_RECORD_IDENTIFIER : + s->command_status =next_erst_record (s, &s->reg_value); +break ; +case ACTION_SET_RECORD_IDENTIFIER : + s->record_identifier = s->reg_value; +break ; +case ACTION_GET_RECORD_COUNT : + s->reg_value = s->header->record_count; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE : + s->reg_value = (hwaddr )pci_get_bar_addr (PCI_DEVICE (s),1 ); +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_LENGTH : + s->reg_value =ERST_RECORD_SIZE ; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES : + s->reg_value =0x0 ;/* intentional, not NVRAM mode */ +break ; +case ACTION_GET_EXECUTE_OPERATION_TIMINGS : + s->reg_value = + (100ULL <<32 ) |/* 100us max time */ + (10ULL <<0 ) ;/* 10us min time */ +break ; +default : +/* Unknown action/command, NOP */ +break ; + } +break ; +default : +/* This should not happen, but if it does, NOP */ +break ; + } +} + +static uint64_t erst_reg_read (void *opaque,hwaddr addr, +unsigned size) +{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; +uint64_t val =0 ; + +switch (addr) { +case ERST_ACTION_OFFSET +0 : +case ERST_ACTION_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_action, size); +break ; +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_value, size); +break ; +default : +break ; + } +trace_acpi_erst_reg_read (addr, val, size); +return val; +} + +static const MemoryRegionOps erst_reg_ops = { + .read = erst_reg_read, + .write = erst_reg_write, + .endianness =DEVICE_NATIVE_ENDIAN , +}; + +/*******************************************************************/ +/*******************************************************************/ +static int erst_post_load (void *opaque,int version_id) +{ +ERSTDeviceState *s = opaque; + +/* Recompute pointer to header */ + s->header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 ); +trace_acpi_erst_post_load (s->header); +hw/acpi/erst.c line 623
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+return 0 ; +} + +static const VMStateDescription erst_vmstate = { + .name ="acpi-erst" , + .version_id =1 , + .minimum_version_id =1 , + .post_load = erst_post_load, + .fields = (VMStateField []) { +VMSTATE_UINT32 (storage_size, ERSTDeviceState),1)
Quoted 8 lines
hw/acpi/erst.c new file +8
-0+VMSTATE_UINT8 (operation, ERSTDeviceState), +VMSTATE_UINT8 (busy_status, ERSTDeviceState), +VMSTATE_UINT8 (command_status, ERSTDeviceState), +VMSTATE_UINT32 (record_offset, ERSTDeviceState), +VMSTATE_UINT64 (reg_action, ERSTDeviceState), +VMSTATE_UINT64 (reg_value, ERSTDeviceState), +VMSTATE_UINT64 (record_identifier, ERSTDeviceState), + VMSTATE_UINT32(next_record_index, ERSTDeviceState),Quoted 8 lines
hw/acpi/erst.c line 633
Quoted 2 lines
hw/acpi/erst.c new file +2
-0+VMSTATE_UINT32 (first_record_index, ERSTDeviceState), + VMSTATE_UINT32(last_record_index, ERSTDeviceState),2)
hw/acpi/erst.c line 636
Quoted 3 lines
hw/acpi/erst.c new file +3
-0+ VMSTATE_END_OF_LIST() + } +};1 and 2 aren't runtime state, so why they are in migration stream?
done; removed
storage_size,first_record_indexandlast_record_indexfrom the migration stream.Quoted 4 lines
I'd imagine size could be used to check that backend on target is of the same size to avoid buffer overrun if target side has smaller backend, and fail migration if it's not the same. But it aren't used this way here.
I decided to not do this check as that memory object is migrated automatically, so I dont think my check adds any value.
Quoted 2 lines
the rest could be calculated at realize time.
and in fact they are.
Quoted 40 lines
Quoted 38 lines
hw/acpi/erst.c new file +37
-0+ +static void erst_realizefn (PCIDevice *pci_dev,Error **errp) +{ +ERSTDeviceState *s =ACPIERST (pci_dev); + +trace_acpi_erst_realizefn_in (); + +if (!s->hostmem) { +error_setg (errp,"'" ACPI_ERST_MEMDEV_PROP "' property is not set" ); +return ; + }else if (host_memory_backend_is_mapped (s->hostmem)) { +error_setg (errp,"can't use already busy memdev: %s" , +object_get_canonical_path_component (OBJECT (s->hostmem))); +return ; + } + + s->hostmem_mr =host_memory_backend_get_memory (s->hostmem); + +/* HostMemoryBackend size will be multiple of PAGE_SIZE */ + s->storage_size =object_property_get_int (OBJECT (s->hostmem),"size" , errp); + +/* Check storage_size against ERST_RECORD_SIZE */ +if (((s->storage_size %ERST_RECORD_SIZE ) !=0 ) || + (ERST_RECORD_SIZE > s->storage_size)) { +error_setg (errp,"ACPI ERST requires size be multiple of " +"record size (%luKiB)" ,ERST_RECORD_SIZE ); + } + +/* Initialize backend storage and record_count */ +check_erst_backend_storage (s, errp); + +/* BAR 0: Programming registers */ +memory_region_init_io (&s->iomem,OBJECT (pci_dev), &erst_reg_ops, s, +TYPE_ACPI_ERST ,ERST_REG_SIZE ); +pci_register_bar (pci_dev,0 ,PCI_BASE_ADDRESS_SPACE_MEMORY , &s->iomem); + +/* BAR 1: Exchange buffer memory */ Quoted 8 lines
hw/acpi/erst.c line 680
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+/* Create a hostmem object to use as the exchange buffer */ + s->exchange_obj =object_new (TYPE_MEMORY_BACKEND_RAM ); +object_property_set_int (s->exchange_obj,"size" ,ERST_RECORD_SIZE , errp); +user_creatable_complete (USER_CREATABLE (s->exchange_obj), errp); + s->exchange =MEMORY_BACKEND (s->exchange_obj); +host_memory_backend_set_mapped (s->exchange, true); + s->exchange_mr =host_memory_backend_get_memory (s->exchange);replace this block with single
memory_region_init_ram()done!
Quoted 6 lines
hw/acpi/erst.c line 682
Quoted 4 lines
hw/acpi/erst.c new file +2
-0+memory_region_init_resizeable_ram (s->exchange_mr,OBJECT (pci_dev), +TYPE_ACPI_ERST ,ERST_RECORD_SIZE ,ERST_RECORD_SIZE ,NULL , errp);have ho idea why it's necessary, seems just wrong, it basically leaks previous memory region and creates a new one.
done!
Quoted 6 lines
hw/acpi/erst.c line 685
Quoted 5 lines
hw/acpi/erst.c new file +3
-0+pci_register_bar (pci_dev,1 ,PCI_BASE_ADDRESS_SPACE_MEMORY , s->exchange_mr); +/* Include the exchange buffer in the migration stream */ +vmstate_register_ram_global (s->exchange_mr);not necessary if
memory_region_init_ram()is used directlydone!
Quoted 45 lines
Quoted 33 lines
hw/acpi/erst.c new file +32
-0+ +/* Include the backend storage in the migration stream */ +vmstate_register_ram_global (s->hostmem_mr); + +trace_acpi_erst_realizefn_out (s->storage_size); +} + +static void erst_reset (DeviceState *dev) +{ +ERSTDeviceState *s =ACPIERST (dev); + +trace_acpi_erst_reset_in (s->header->record_count); + s->operation =0 ; + s->busy_status =0 ; + s->command_status =STATUS_SUCCESS ; + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ; + s->record_offset =0 ; + s->next_record_index = s->first_record_index; +/* NOTE: first/last_record_index are computed only once */ +trace_acpi_erst_reset_out (s->header->record_count); +} + +static Property erst_properties[] = { +DEFINE_PROP_LINK (ACPI_ERST_MEMDEV_PROP , ERSTDeviceState, hostmem, + TYPE_MEMORY_BACKEND, HostMemoryBackend *), +DEFINE_PROP_END_OF_LIST (), +}; + +static void erst_class_init (ObjectClass *klass,void *data) +{ +DeviceClass *dc =DEVICE_CLASS (klass); +PCIDeviceClass *k =PCI_DEVICE_CLASS (klass);hw/acpi/erst.c line 727
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ +trace_acpi_erst_class_init_in (); + k->realize = erst_realizefn; + k->vendor_id =PCI_VENDOR_ID_REDHAT ; + k->device_id =PCI_DEVICE_ID_REDHAT_ACPI_ERST ; + k->revision =0x00 ; + k->class_id =PCI_CLASS_OTHERS ; + dc->reset = erst_reset; + dc->vmsd = &erst_vmstate; + dc->user_creatable = true;can't be hotplugged, add:
Quoted 1 line
dc->hotpluggable = false;done
Quoted 60 lines
Quoted 59 lines
hw/acpi/erst.c new file +23
-0+device_class_set_props (dc, erst_properties); + dc->desc ="ACPI Error Record Serialization Table (ERST) device" ; +set_bit (DEVICE_CATEGORY_MISC , dc->categories); +trace_acpi_erst_class_init_out (); +} + +static const TypeInfo erst_type_info = { + .name =TYPE_ACPI_ERST , + .parent =TYPE_PCI_DEVICE , + .class_init = erst_class_init, + .instance_size =sizeof (ERSTDeviceState), + .interfaces = (InterfaceInfo []) { + {INTERFACE_CONVENTIONAL_PCI_DEVICE }, + { } + } +}; + +static void erst_register_types (void ) +{ +type_register_static (&erst_type_info); +} + +type_init (erst_register_types)hw/acpi/meson.build +1
-0@@ -5,6 +5,7 @@ acpi_ss.add(files( 'bios-linker-loader.c', 'core.c', 'utils.c', + 'erst.c', )) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu.c')) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu_hotplug.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) "header: 0x%p" +acpi_erst_class_init_in(void) +acpi_erst_class_init_out(void)
Re: [PATCH v6 05/10] ACPI ERST: support for ACPI ERST feature
Quoted 571 lines · On Tue, 5 Oct 2021 11:40:35 -0500 Eric DeVolder <[email protected]>…
Igor, again thanks for the detailed review. Inline responses below. eric
Quoted 460 lines · Igor Mammedov
Quoted 447 lines · On Mon, 4 Oct 2021 16:13:09 -0500 Eric DeVolder <[email protected]>…
Igor, thanks for the close examination. Inline responses below. eric
Quoted 138 lines · Igor Mammedov
Quoted 134 lines · On Thu, 5 Aug 2021 18:30:34 -0400 Eric DeVolder <[email protected]>…
This 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.
Signed-off-by Eric DeVolder <[email protected]>--- hw/acpi/erst.c | 750 +++++++++++++++++++++++++++++++++++++++++++++++++++ hw/acpi/meson.build | 1 + hw/acpi/trace-events | 15 ++ 3 files changed, 766 insertions(+)create mode 100644
hw/acpi/erst.chw/acpi/erst.c new file +116
-0@@ -0,0 +1,750 @@ +/* +* 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 +*/ + +#include <sys/types.h> +#include <sys/stat.h> +#include <unistd.h> + +#include "qemu/osdep.h" +#include "qapi/error.h" +#include "hw/qdev-core.h" +#include "exec/memory.h" +#include "qom/object.h" +#include "hw/pci/pci.h" +#include "qom/object_interfaces.h" +#include "qemu/error-report.h" +#include "migration/vmstate.h" +#include "hw/qdev-properties.h" +#include "hw/acpi/acpi.h" +#include "hw/acpi/acpi-defs.h" +#include "hw/acpi/aml-build.h" +#include "hw/acpi/bios-linker-loader.h" +#include "exec/address-spaces.h" +#include "sysemu/hostmem.h" +#include "hw/acpi/erst.h" +#include "trace.h" + +/* ACPI 4.0: Table 17-16 Serialization Actions */ +#define ACTION_BEGIN_WRITE_OPERATION 0x0 +#define ACTION_BEGIN_READ_OPERATION 0x1 +#define ACTION_BEGIN_CLEAR_OPERATION 0x2 +#define ACTION_END_OPERATION 0x3 +#define ACTION_SET_RECORD_OFFSET 0x4 +#define ACTION_EXECUTE_OPERATION 0x5 +#define ACTION_CHECK_BUSY_STATUS 0x6 +#define ACTION_GET_COMMAND_STATUS 0x7 +#define ACTION_GET_RECORD_IDENTIFIER 0x8 +#define ACTION_SET_RECORD_IDENTIFIER 0x9 +#define ACTION_GET_RECORD_COUNT 0xA +#define ACTION_BEGIN_DUMMY_WRITE_OPERATION 0xB +#define ACTION_RESERVED 0xC +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE 0xD +#define ACTION_GET_ERROR_LOG_ADDRESS_LENGTH 0xE +#define ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0xF +#define ACTION_GET_EXECUTE_OPERATION_TIMINGS 0x10 + +/* ACPI 4.0: Table 17-17 Command Status Definitions */ +#define STATUS_SUCCESS 0x00 +#define STATUS_NOT_ENOUGH_SPACE 0x01 +#define STATUS_HARDWARE_NOT_AVAILABLE 0x02 +#define STATUS_FAILED 0x03 +#define STATUS_RECORD_STORE_EMPTY 0x04 +#define STATUS_RECORD_NOT_FOUND 0x05 + + +/* UEFI 2.1: Appendix N Common Platform Error Record */ +#define UEFI_CPER_RECORD_MIN_SIZE 128U +#define UEFI_CPER_RECORD_LENGTH_OFFSET 20U +#define UEFI_CPER_RECORD_ID_OFFSET 96U +#define IS_UEFI_CPER_RECORD (ptr) \ + (((ptr)[0] == 'C') && \ + ((ptr)[1] == 'P') && \ + ((ptr)[2] == 'E') && \ + ((ptr)[3] == 'R')) +#define THE_UEFI_CPER_RECORD_ID (ptr) \ + (*(uint64_t *)(&(ptr)[UEFI_CPER_RECORD_ID_OFFSET])) + +/* +* This implementation is an ACTION (cmd) and VALUE (data) +* interface consisting of just two 64-bit registers. +*/ +#define ERST_REG_SIZE (16UL) +#define ERST_ACTION_OFFSET (0UL)/* action (cmd) */ +#define ERST_VALUE_OFFSET (8UL)/* argument/value (data) */ + +/* +* ERST_RECORD_SIZE is the buffer size for exchanging ERST +* record contents. Thus, it defines the maximum record size. +* As this is mapped through a PCI BAR, it must be a power of +* two and larger than UEFI_CPER_RECORD_MIN_SIZE. +* The backing storage is divided into fixed size "slots", +* each ERST_RECORD_SIZE in length, and each "slot" +* storing a single record. No attempt at optimizing storage +* through compression, compaction, etc is attempted. +* NOTE that slot 0 is reserved for the backing storage header. +* Depending upon the size of the backing storage, additional +* slots will be part of the slot 0 header in order to account +* for a record_id for each available remaining slot. +*/ +/* 8KiB records, not too small, not too big */ +#define ERST_RECORD_SIZE (8192UL) + +#define ACPI_ERST_MEMDEV_PROP "memdev" + +/* +* From the ACPI ERST spec sections: +* A record id of all 0s is used to indicate +* 'unspecified' record id. +* A record id of all 1s is used to indicate +* empty or end. +*/ +#define ERST_UNSPECIFIED_RECORD_ID (0UL) +#define ERST_EMPTY_END_RECORD_ID (~0UL) +#define ERST_EXECUTE_OPERATION_MAGIC 0x9CUL +#define ERST_IS_VALID_RECORD_ID (rid) \ + ((rid != ERST_UNSPECIFIED_RECORD_ID) && \ + (rid != ERST_EMPTY_END_RECORD_ID)) + +typedef struct erst_storage_header_s {Quoted 5 lines
hw/acpi/erst.c line 117
Quoted 1 line
hw/acpi/erst.c new file +1
-0+#define ERST_STORE_MAGIC 0x524F545354535245ULmove it out of structure definition,
also where value comes from? (perhaps something starting with ERST... would be more self-describing)done; this value is 'ERSTSTOR', which I've left as a comment in v7.
Quoted 10 lines
hw/acpi/erst.c line 125
Quoted 9 lines
hw/acpi/erst.c new file +8
-0+uint64_t magic; +uint32_t record_size; +uint32_t record_offset;/* offset to record storage beyond header */ +uint16_t version; +uint16_t reserved; +uint32_t record_count; +uint64_t map[];/* contains record_ids, and position indicates index */ +} erst_storage_header_t;
docs/devel/style.rst: Typedefsdone; thanks
Quoted 3 lines
also give it's used as header layout in storage,
set packed attribute for structuredone
Quoted 50 lines
Quoted 49 lines
hw/acpi/erst.c new file +48
-0+ +/* +* Object cast macro +*/ +#define ACPIERST (obj) \ + OBJECT_CHECK(ERSTDeviceState, (obj), TYPE_ACPI_ERST) + +/* +* Main ERST device state structure +*/ +typedef struct { +PCIDevice parent_obj; + +/* Backend storage */ +HostMemoryBackend *hostmem; +MemoryRegion *hostmem_mr; + +/* Programming registers */ +MemoryRegion iomem; + +/* Exchange buffer */ +Object *exchange_obj; +HostMemoryBackend *exchange; +MemoryRegion *exchange_mr; +uint32_t storage_size; + +/* Interface state */ +uint8_t operation; +uint8_t busy_status; +uint8_t command_status; +uint32_t record_offset; +uint64_t reg_action; +uint64_t reg_value; +uint64_t record_identifier; +erst_storage_header_t *header; +unsigned next_record_index; +unsigned first_record_index; +unsigned last_record_index; + +}ERSTDeviceState ; + +/*******************************************************************/ +/*******************************************************************/ + +static uint8_t *get_nvram_ptr_by_index (ERSTDeviceState *s,unsigned index) +{ +uint8_t *rc =NULL ; +off_t offset = (index *ERST_RECORD_SIZE );Quoted 5 lines
hw/acpi/erst.c line 174
Quoted 1 line
hw/acpi/erst.c new file +1
-0+if ((offset +ERST_RECORD_SIZE ) <= s->storage_size) {it looks like 'index' passed by caller is always valid, if it's the case convert this to
g_assert((offset + ERST_RECORD_SIZE) <= s->storage_size))done
Quoted 2 lines
also shouldn't <= be just <
yes, done
Quoted 5 lines
hw/acpi/erst.c line 175
Quoted 3 lines
hw/acpi/erst.c new file +1
-0+if (s->hostmem_mr) {can
hostmem_mrbe NULL, when this function is called? if not I'd drop condition.no, so dropped. done
Quoted 10 lines
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+uint8_t *p = (uint8_t *)memory_region_get_ram_ptr (s->hostmem_mr); + rc = p + offset; + } + } +return rc; +} + +static void make_erst_storage_header (ERSTDeviceState *s) +{Quoted 8 lines
hw/acpi/erst.c line 190
Quoted 6 lines
hw/acpi/erst.c new file +6
-0+erst_storage_header_t *header = s->header; +unsigned mapsz, headersz; + + header->magic =ERST_STORE_MAGIC ; + header->record_size =ERST_RECORD_SIZE ; + header->version =0x0101 ;maybe 0 or 1 to avoid question about what previous versions are
changed to simply
0x0100(ie 1.0)Quoted 3 lines
hw/acpi/erst.c line 191
Quoted 2 lines
hw/acpi/erst.c new file +1
-0+ header->reserved =0x0000 ;s/0x.../0/
done
Quoted 8 lines
Quoted 7 lines
hw/acpi/erst.c new file +6
-0+ +/* Compute mapsize */ + mapsz = s->storage_size /ERST_RECORD_SIZE ; + mapsz *=sizeof (uint64_t ); +/* Compute header+map size */ + headersz =sizeof (erst_storage_header_t) + mapsz;Quoted 6 lines
hw/acpi/erst.c line 201
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+/* Round up to nearest integer multiple of ERST_RECORD_SIZE */ + headersz += (ERST_RECORD_SIZE -1 ); + headersz /=ERST_RECORD_SIZE ; + headersz *=ERST_RECORD_SIZE ;git grep
ROUND_UP
may be of help hereyes, thanks. I'm using that now, done.
Quoted 10 lines
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+ header->record_offset = headersz; + +/* +* The HostMemoryBackend initializes contents to zero, +* so all record_ids stashed in the map are zero'd. +* As well the record_count is zero. Properly initialized. +*/ +} +Quoted 8 lines
hw/acpi/erst.c line 215
Quoted 5 lines
hw/acpi/erst.c new file +5
-0+static void check_erst_backend_storage (ERSTDeviceState *s,Error **errp) +{ +erst_storage_header_t *header; + + header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 );optionally check/assert if it's not 64bit aligned, if it's not you risk getting killed by SIGBUG on some hosts, since you're accessing fields directly.
done!
Quoted 17 lines
Quoted 17 lines
hw/acpi/erst.c new file +16
-0+ s->header = header; + +/* Check if header is uninitialized */ +if (header->magic ==0UL ) {/* HostMemoryBackend inits to 0 */ +make_erst_storage_header (s); + } + +if (!( + (header->magic ==ERST_STORE_MAGIC ) && + (header->record_size ==ERST_RECORD_SIZE ) && + ((header->record_offset %ERST_RECORD_SIZE ) ==0 ) && + (header->version ==0x0101 ) && + (header->reserved ==0x0000 ) + )) { +error_setg (errp,"ERST backend storage header is invalid" ); + }Quoted 8 lines
hw/acpi/erst.c line 235
Quoted 4 lines
hw/acpi/erst.c new file +4
-0+ +/* Compute offset of first and last record storage slot */ + s->first_record_index = header->record_offset /ERST_RECORD_SIZE ; + s->last_record_index = (s->storage_size /ERST_RECORD_SIZE );applies to whole patch/series,
if mmaped header values are interpreted as integers you shall take care of endianness, i.e. use cpu_to_foo/foo_to_cpu for accessdone; I'm using
cpu_to_leX()andleX_to_cpu()for any access to the header.Quoted 2 lines
and document file endianness in doc (2/10)
done
Quoted 9 lines
hw/acpi/erst.c line 239
Quoted 5 lines
hw/acpi/erst.c new file +4
-0+} + +static void set_erst_map_by_index (ERSTDeviceState *s,unsigned index, +uint64_t record_id)update_[cache|map]_[entry|record_id]() or something like this might be a better description erst and index don't really add much here as it's clear from context.
done; now
update_map_entry()Quoted 26 lines
Quoted 14 lines
hw/acpi/erst.c new file +12
-0+{ +if (index < s->last_record_index) { + s->header->map[index] = record_id; + } +} + +static unsigned lookup_erst_record (ERSTDeviceState *s, +uint64_t record_identifier) +{ +unsigned rc =0 ;/* 0 not a valid index */ +unsigned index = s->first_record_index; +hw/acpi/erst.c line 261
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+/* Find the record_identifier in the map */ +if (record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* +* Count number of valid records encountered, and +* short-circuit the loop if identifier not found +*/ +unsigned count =0 ; +for (; index < s->last_record_index && + count < s->header->record_count; ++index) { +uint64_t map_record_identifier = s->header->map[index];I'd drop
map_record_identifierand use s->header->map[index] directly, i.eQuoted 1 line
if (s->header->map[index] ...done
Quoted 16 lines
Quoted 16 lines
hw/acpi/erst.c new file +15
-0+if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { + ++count; + } +if (map_record_identifier == record_identifier) { + rc = index; +break ; + } + } + }else { +/* Find first available unoccupied slot */ +for (; index < s->last_record_index; ++index) { +if (s->header->map[index] ==ERST_UNSPECIFIED_RECORD_ID ) { + rc = index; +break ; + }Quoted 8 lines
hw/acpi/erst.c line 281
Quoted 5 lines
hw/acpi/erst.c new file +5
-0+ } + } + +return rc; +}what's the reason for combining lookup and allocate ops, if they where separated it' would be easier to follow code.
done; at one point it made sense; no longer.
Quoted 24 lines
Quoted 24 lines
hw/acpi/erst.c new file +23
-0+ +/* ACPI 4.0: 17.4.2.3 Operations - Clearing */ +static unsigned clear_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +/* No need to wipe record, just invalidate its map entry */ +set_erst_map_by_index (s, index,ERST_UNSPECIFIED_RECORD_ID ); + s->header->record_count -=1 ; + rc =STATUS_SUCCESS ; + } + +return rc; +} +Quoted 8 lines
hw/acpi/erst.c line 311
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+/* ACPI 4.0: 17.4.2.2 Operations - Reading */ +static unsigned read_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index; + +/* Check record boundary wihin exchange buffer */ ^^^ typodone
Quoted 22 lines
Quoted 8 lines
hw/acpi/erst.c new file +7
-0+if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + } + +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (s->record_identifier)) { +return STATUS_FAILED ;hw/acpi/erst.c line 328
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ } + + index =lookup_erst_record (s, s->record_identifier); +if (index) { +uint8_t *ptr; +uint8_t *record = ((uint8_t *) +memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + ptr =get_nvram_ptr_by_index (s, index); +memcpy (record, ptr,ERST_RECORD_SIZE - s->record_offset);if
record_offsetis large enough that record won't fit, this will copy truncated record into the exchange buffer.Quoted 3 lines
Quoted 1 line
Maybe it's better to fail whole op?
The first check within this function checks for this very condition, and does fail. I believe the code does as you are asking.
The 1st check guaranties that '
exchange_mr+record_offset,exchange_mr_end'
has a space at least forUEFI_CPER_RECORD_MIN_SIZE, while the source record that's being copied can be larger than that.
i.e. assume
record_offset= 7,ERST_RECORD_SIZE= 10,UEFI_CPER_RECORD_MIN_SIZE= 2,ptr->record_size= 9Quoted 5 lines
Quoted 1 line
if (
s->record_offset>= (ERST_RECORD_SIZE-UEFI_CPER_RECORD_MIN_SIZE))will be passed, while
Quoted 1 line
memcpy(record, ptr, ERST_RECORD_SIZE - s->record_offset);will copy 3 bytes only, truncating the rest of the record but still report success.
ok, I understand now, thanks!
Quoted 8 lines
Also, while max copied amount won't exceed
exchange_mrcapacity due to it being equal toERST_RECORD_SIZEin current impl., it can be dangerous later on if buffer/record sizes diverge as dependency coded here is implicit. Safer option would be using actual destination buffer/copied record size for check to avoid potential buffer overrun (I'm assuming that records are not random blobs but CPER formatted structure).Quoted 5 lines
copy_size=to_be_copied_record_size
ifcopy_size<=memory_region_size(exchange_mr)-record_offset
memcpy(record, ptr, copy_size)
else
error_outok
Quoted 3 lines
[1] the same applies to 'if (
s->record_offset>= ...)' check make it use actualexchange_mrsize explicitly.ok
Quoted 4 lines
nit:
Also use ofrecord_offsetin header and in state is a bit of overloaded, I'd consider renaming one of them to avoid confusion.done; changed header field to '
storage_offset'Quoted 20 lines
Quoted 20 lines
Quoted 20 lines
Quoted 9 lines
hw/acpi/erst.c new file +7
-0+ rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.1 Operations - Writing */ hw/acpi/erst.c line 345
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+static unsigned write_erst_record (ERSTDeviceState *s) +{ +unsigned rc =STATUS_FAILED ; +unsigned index; +uint64_t record_identifier; +uint8_t *record; +uint8_t *ptr =NULL ; +bool record_found = false; + +/* Check record boundary wihin exchange buffer */ ditto, typo
Quoted 7 lines
Quoted 6 lines
done
Quoted 4 lines
Quoted 4 lines
hw/acpi/erst.c new file +3
-0+if (s->record_offset >= (ERST_RECORD_SIZE -UEFI_CPER_RECORD_MIN_SIZE )) { +return STATUS_FAILED ; + }see (1)
yep
Quoted 29 lines
Quoted 29 lines
Quoted 7 lines
hw/acpi/erst.c line 353
Quoted 6 lines
hw/acpi/erst.c new file +5
-0+ +/* Extract record identifier */ + record = ((uint8_t *)memory_region_get_ram_ptr (s->exchange_mr) + + s->record_offset); + record_identifier =THE_UEFI_CPER_RECORD_ID (record);potentially unaligned access to int, should use
memcpy()done
Quoted 20 lines
Quoted 20 lines
hw/acpi/erst.c new file +19
-0+ +/* Check for valid record identifier */ +if (!ERST_IS_VALID_RECORD_ID (record_identifier)) { +return STATUS_FAILED ; + } + + index =lookup_erst_record (s, record_identifier); +if (index) { +/* Record found, overwrite existing record */ + ptr =get_nvram_ptr_by_index (s, index); + record_found = true; + }else { +/* Record not found, not an overwrite, allocate for write */ + index =lookup_erst_record (s,ERST_UNSPECIFIED_RECORD_ID ); +if (index) { + ptr =get_nvram_ptr_by_index (s, index); + }else { + rc =STATUS_NOT_ENOUGH_SPACE ; + }Quoted 8 lines
Quoted 3 lines
Quoted 3 lines
hw/acpi/erst.c line 375
Quoted 3 lines
hw/acpi/erst.c new file +3
-0+ } +if (ptr) { +memcpy (ptr, record,ERST_RECORD_SIZE - s->record_offset);This copies the remainder of exchange buffer, including 'leftovers' from previous operations.
Is there a reason why are you not verifying actual 'record' size in buffer and if it fits within target 'ptr' copy just useful payload from buffer?So I think this question might be getting at a fundamental difference (and thus the questions/points you are raising). The UEFI CPER record has a member field '
record_length':"Indicates the size of the actual error record, including the size of the record header, all section descriptors, and section bodies. The size may include extra buffer space to allow for the dynamic addition of error sections descriptors bodies."
Quoted 6 lines
Thus far, in this implementation, I have *avoided* using '
record_length' out of the record as simply deeming it as untrustworthy and a possible attack vector. Instead, I've been using (ERST_RECORD_SIZE-s->record_offset) as the length of the record to copy.I could use '
record_length', and validate it prior to trusting it. Validation here would simply be ensuring it is <=ERST_RECORD_SIZE? I think this is what you are suggesting, correct?
it should be verified and be less than memcpy target explicitly (i.e. use exchange_mr size or slot size) that should decouple exchange buffer size from record size.
This way if in the future exchange buffer is increased, one won't have to rewrite
whole impl.
Quoted 113 lines
Quoted 19 lines
Quoted 11 lines
Quoted 7 lines
hw/acpi/erst.c line 379
Quoted 6 lines
hw/acpi/erst.c new file +4
-0+if (0 != s->record_offset) { +memset (&ptr[ERST_RECORD_SIZE - s->record_offset], +0xFF , s->record_offset); + }you've lost me here, care to explain what's going on here?
If the
record_offsetis not 0, then there can be bytes following the record within the slot that were not written. This simply sets them to0xFF(so bytes from a previously written record that happened to occupy this slot do not "bleed" through).
I've left a comment in v7.well, 'bleed' happens because '
read_erst_record' copies whole slot instead of the actual record size.And that would work, only while exchange buffer size and record size are equal, and fall apart silently as soon as that is not true, leading to potential exploits.
Quoted 6 lines
it might be more robust if it written like this:
if_record_is_complete(i.e. record in buffer is not truncated)
if_actual_record_size_fits_in_slot
memcpy(slot, record, actual_record_size)memset(slot+actual_record_size, 0xff, slot_size - actual_record_size);
otherwise error outSee question on '
record_length' above.Quoted 85 lines
Quoted 84 lines
Quoted 15 lines
Quoted 4 lines
hw/acpi/erst.c new file +3
-0+if (!record_found) { + s->header->record_count +=1 ;/* writing new record */ + }hw/acpi/erst.c line 392
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+set_erst_map_by_index (s, index, record_identifier); + rc =STATUS_SUCCESS ; + } + +return rc; +} + +/* ACPI 4.0: 17.4.2.2 Operations - Reading "During boot..." */ +static unsigned next_erst_record (ERSTDeviceState *s, +uint64_t *record_identifier)s/record_identifier/found.../
done
Quoted 11 lines
hw/acpi/erst.c line 401
Quoted 10 lines
hw/acpi/erst.c new file +9
-0+{ +unsigned rc =STATUS_RECORD_NOT_FOUND ; +unsigned index = s->next_record_index; + + *record_identifier =ERST_EMPTY_END_RECORD_ID ; + +if (s->header->record_count) { +for (; index < s->last_record_index; ++index) { +uint64_t map_record_identifier;and then s/map_record_identifier/record_identifier/
done
Quoted 4 lines
the same applies to other occurrences within patch (
map_record_identifieris a bit confusing) or drop it and use s->header->map[index] directlydone
Quoted 23 lines
Quoted 12 lines
hw/acpi/erst.c new file +11
-0+ map_record_identifier = s->header->map[index]; +if (map_record_identifier !=ERST_UNSPECIFIED_RECORD_ID ) { +/* where to start next time */ + s->next_record_index = index +1 ; + *record_identifier = map_record_identifier; + rc =STATUS_SUCCESS ; +break ; + } + } + } +if (rc !=STATUS_SUCCESS ) {hw/acpi/erst.c line 422
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+if (s->next_record_index == s->first_record_index) { +/* +* next_record_identifier is unchanged, no records found +* and *record_identifier contains EMPTY_END id +*/ + rc =STATUS_RECORD_STORE_EMPTY ; + } +/* at end/scan complete, reset */ + s->next_record_index = s->first_record_index; + }Quoted 3 lines
Table 17-16, says return existing error or
ERST_EMPTY_END_RECORD_IDbut nothing about op returning a error, so I'd assume status should always beSTATUS_SUCCESSforGET_RECORD_IDENTIFIER.done
Quoted 3 lines
Advancing to the next record is part of record READ op and not the part of
GET_RECORD_IDENTIFIERas it's done here.well...
Quoted 7 lines
"The steps performed by the platform to carry out ...
2. ..
c. If the specified error record does not exist,
... update the status register’s Identifier field with the identifier of the
‘first’ error record
4. Record the Identifier of the ‘next’ valid error record ...
"I used ACPI spec v6 and I was asked to locate the first occurrence of ERST in the spec, which was v4. So the above spec quotes are accurate, however, spec v6 deviates in an important way from the above, which reads:
"c. If the status is Record Not Found (0x05), indicating that the specified error record does notexist, OSPM retrieves a valid identifier by a
GET_RECORD_IDENTIFIERaction. The platform will return a valid record identifier."
Quoted 8 lines
Quoted 4 lines
that's quote from OSPM behavior,
the platform part still looks the same to me (in 4.0/5.0/6.0/6.3) (they split 2.c on 2.c and 2.d) but the meaning is the same.
So I now see that the description of the READ operation actually has two sections; the first starts with "during boot" and another talking about a straight up read operation. I had been focusing on the "on boot" reading, but alas I do need to accomodate better the plain read, as you point out.
if it can work as spec say, we'd better to follow it. If it doesn't actually work, we can code whatever works + sufficient documentation/proof to justify that.
Quoted 475 lines
Quoted 7 lines
Quoted 7 lines
So
GET_RECORD_IDENTIFIERis essentially a factory that pumps out record identifiers for records stored. I kind of think of it as the old DOS 'find_first/find_next'. And yes v4 of the spec states that the READ operation should initiate the firstrecord_identifer. However v6 clearly states this is now the responsibility of OSPM, not the READ op.Quoted 6 lines
Quoted 5 lines
I am thinking that the best way to handle this contradiction is to change the ACPI spec citation from v4 to v5, as the wording in v5 matches what I cite from v6, and implemented. Furthermore, this approach of OSPM obtaining the next valid
record_idviaGET_RECORD_IDENTIFIERis consistent withwhat I observed in BIOS and with how Linux is coded.
pointer[s] to source[s] please?
Fwiw, Linux converts all the entries in ERST into pstore entries upon boot. Any subsequent "read" of the pstore entry does not touch ERST again; instead it reads from the in-kernel pstore contents.
The driver in Linux is
drivers/acpi/apei/erst.c; but note that it conforms to the pstore set of callbacks.Quoted 5 lines
Well, spec can be wrong too (not the 1st time) but we need to be sure what is broken and doesn't work as it's supposed to and document it properly, before deviating from the spec.
I see now specs appear to be the same. I need to accomodate the non "on boot" path.
Quoted 90 lines
Quoted 90 lines
Thoughts?
Quoted 60 lines
Quoted 60 lines
hw/acpi/erst.c new file +58
-0+ +return rc; +} + +/*******************************************************************/ + +static uint64_t erst_rd_reg64 (hwaddr addr, +uint64_t reg,unsigned size) +{ +uint64_t rdval; +uint64_t mask; +unsigned shift; + +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + rdval = reg; + rdval >>= shift; + rdval &= mask; + +return rdval; +} + +static uint64_t erst_wr_reg64 (hwaddr addr, +uint64_t reg,uint64_t val,unsigned size) +{ +uint64_t wrval; +uint64_t mask; +unsigned shift; +if (size ==sizeof (uint64_t )) { +/* 64b access */ + mask =0xFFFFFFFFFFFFFFFFUL ; + shift =0 ; + }else { +/* 32b access */ + mask =0x00000000FFFFFFFFUL ; + shift = ((addr &0x4 ) ==0x4 ) ?32 :0 ; + } + + val &= mask; + val <<= shift; + mask <<= shift; + wrval = reg; + wrval &= ~mask; + wrval |= val; + +return wrval; +} + +static void erst_reg_write (void *opaque,hwaddr addr, +uint64_t val,unsigned size)Quoted 8 lines
hw/acpi/erst.c line 487
Quoted 6 lines
hw/acpi/erst.c new file +6
-0+{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; + +/* +* NOTE: All actions/operations/side effects happen on the WRITE, +* by design. The READs simply return the reg_value contents. point to spec, pls.
This was an implementation design choice, so no spec reference applicable, I left a comment.
Quoted 14 lines
hw/acpi/erst.c line 497
Quoted 12 lines
hw/acpi/erst.c new file +10
-0+*/ +trace_acpi_erst_reg_write (addr, val, size); + +switch (addr) { +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + s->reg_value =erst_wr_reg64 (addr, s->reg_value, val, size); +break ; +case ERST_ACTION_OFFSET +0 : +/* case ERST_ACTION_OFFSET+4: as coded, not really a 64b register */ what does this mean?
Quoted 8 lines
Quoted 4 lines
In short, all values written to this register are just the ACTION ops, so there wasn't a need to implement this as a 64-bit register, especially since Linux seems to issue two 32-bit accesses for 64-bit; in this case the upper access is utterly useless.
I placed a comment in code.comment as it's, above is not helpful,
so it would be better to have a comment that explains reasoning a bit better. like:
supported/impl ACPTION ops are 32 only, so ...ok
Quoted 346 lines
Quoted 345 lines
Quoted 36 lines
Quoted 26 lines
hw/acpi/erst.c new file +25
-0+switch (val) { +case ACTION_BEGIN_WRITE_OPERATION : +case ACTION_BEGIN_READ_OPERATION : +case ACTION_BEGIN_CLEAR_OPERATION : +case ACTION_BEGIN_DUMMY_WRITE_OPERATION : +case ACTION_END_OPERATION : + s->operation = val; +break ; +case ACTION_SET_RECORD_OFFSET : + s->record_offset = s->reg_value; +break ; +case ACTION_EXECUTE_OPERATION : +if ((uint8_t )s->reg_value ==ERST_EXECUTE_OPERATION_MAGIC ) { + s->busy_status =1 ; +switch (s->operation) { +case ACTION_BEGIN_WRITE_OPERATION : + s->command_status =write_erst_record (s); +break ; +case ACTION_BEGIN_READ_OPERATION : + s->command_status =read_erst_record (s); +break ; +case ACTION_BEGIN_CLEAR_OPERATION : + s->command_status =clear_erst_record (s); +break ; +case ACTION_BEGIN_DUMMY_WRITE_OPERATION :hw/acpi/erst.c line 532
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ s->command_status =STATUS_SUCCESS ; +break ; +case ACTION_END_OPERATION : + s->command_status =STATUS_SUCCESS ; +break ; +default : + s->command_status =STATUS_FAILED ; +break ; + } + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ;Quoted 1 line
shouldn't happen in case of Read op
correct, removed as not needed at all now.
Quoted 109 lines
"
17.4.2.2
4. Record the Identifier of the ‘next’ valid error record that resides on the persistent store. This allows OSPM to retrieve a valid record identifier by executing aGET_RECORD_IDENTIFIERoperation.
"Quoted 81 lines
hw/acpi/erst.c new file +81
-0+ s->busy_status =0 ; + } +break ; +case ACTION_CHECK_BUSY_STATUS : + s->reg_value = s->busy_status; +break ; +case ACTION_GET_COMMAND_STATUS : + s->reg_value = s->command_status; +break ; +case ACTION_GET_RECORD_IDENTIFIER : + s->command_status =next_erst_record (s, &s->reg_value); +break ; +case ACTION_SET_RECORD_IDENTIFIER : + s->record_identifier = s->reg_value; +break ; +case ACTION_GET_RECORD_COUNT : + s->reg_value = s->header->record_count; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE : + s->reg_value = (hwaddr )pci_get_bar_addr (PCI_DEVICE (s),1 ); +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_LENGTH : + s->reg_value =ERST_RECORD_SIZE ; +break ; +case ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES : + s->reg_value =0x0 ;/* intentional, not NVRAM mode */ +break ; +case ACTION_GET_EXECUTE_OPERATION_TIMINGS : + s->reg_value = + (100ULL <<32 ) |/* 100us max time */ + (10ULL <<0 ) ;/* 10us min time */ +break ; +default : +/* Unknown action/command, NOP */ +break ; + } +break ; +default : +/* This should not happen, but if it does, NOP */ +break ; + } +} + +static uint64_t erst_reg_read (void *opaque,hwaddr addr, +unsigned size) +{ +ERSTDeviceState *s = (ERSTDeviceState *)opaque; +uint64_t val =0 ; + +switch (addr) { +case ERST_ACTION_OFFSET +0 : +case ERST_ACTION_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_action, size); +break ; +case ERST_VALUE_OFFSET +0 : +case ERST_VALUE_OFFSET +4 : + val =erst_rd_reg64 (addr, s->reg_value, size); +break ; +default : +break ; + } +trace_acpi_erst_reg_read (addr, val, size); +return val; +} + +static const MemoryRegionOps erst_reg_ops = { + .read = erst_reg_read, + .write = erst_reg_write, + .endianness =DEVICE_NATIVE_ENDIAN , +}; + +/*******************************************************************/ +/*******************************************************************/ +static int erst_post_load (void *opaque,int version_id) +{ +ERSTDeviceState *s = opaque; + +/* Recompute pointer to header */ + s->header = (erst_storage_header_t *)get_nvram_ptr_by_index (s,0 ); +trace_acpi_erst_post_load (s->header); +hw/acpi/erst.c line 623
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+return 0 ; +} + +static const VMStateDescription erst_vmstate = { + .name ="acpi-erst" , + .version_id =1 , + .minimum_version_id =1 , + .post_load = erst_post_load, + .fields = (VMStateField []) { +VMSTATE_UINT32 (storage_size, ERSTDeviceState),1)
Quoted 8 lines
hw/acpi/erst.c new file +8
-0+VMSTATE_UINT8 (operation, ERSTDeviceState), +VMSTATE_UINT8 (busy_status, ERSTDeviceState), +VMSTATE_UINT8 (command_status, ERSTDeviceState), +VMSTATE_UINT32 (record_offset, ERSTDeviceState), +VMSTATE_UINT64 (reg_action, ERSTDeviceState), +VMSTATE_UINT64 (reg_value, ERSTDeviceState), +VMSTATE_UINT64 (record_identifier, ERSTDeviceState), + VMSTATE_UINT32(next_record_index, ERSTDeviceState),Quoted 8 lines
hw/acpi/erst.c line 633
Quoted 2 lines
hw/acpi/erst.c new file +2
-0+VMSTATE_UINT32 (first_record_index, ERSTDeviceState), + VMSTATE_UINT32(last_record_index, ERSTDeviceState),2)
hw/acpi/erst.c line 636
Quoted 3 lines
hw/acpi/erst.c new file +3
-0+ VMSTATE_END_OF_LIST() + } +};1 and 2 aren't runtime state, so why they are in migration stream?
done; removed
storage_size,first_record_indexandlast_record_indexfrom the migration stream.Quoted 4 lines
I'd imagine size could be used to check that backend on target is of the same size to avoid buffer overrun if target side has smaller backend, and fail migration if it's not the same. But it aren't used this way here.
I decided to not do this check as that memory object is migrated automatically, so I dont think my check adds any value.
Quoted 2 lines
the rest could be calculated at realize time.
and in fact they are.
Quoted 40 lines
Quoted 38 lines
hw/acpi/erst.c new file +37
-0+ +static void erst_realizefn (PCIDevice *pci_dev,Error **errp) +{ +ERSTDeviceState *s =ACPIERST (pci_dev); + +trace_acpi_erst_realizefn_in (); + +if (!s->hostmem) { +error_setg (errp,"'" ACPI_ERST_MEMDEV_PROP "' property is not set" ); +return ; + }else if (host_memory_backend_is_mapped (s->hostmem)) { +error_setg (errp,"can't use already busy memdev: %s" , +object_get_canonical_path_component (OBJECT (s->hostmem))); +return ; + } + + s->hostmem_mr =host_memory_backend_get_memory (s->hostmem); + +/* HostMemoryBackend size will be multiple of PAGE_SIZE */ + s->storage_size =object_property_get_int (OBJECT (s->hostmem),"size" , errp); + +/* Check storage_size against ERST_RECORD_SIZE */ +if (((s->storage_size %ERST_RECORD_SIZE ) !=0 ) || + (ERST_RECORD_SIZE > s->storage_size)) { +error_setg (errp,"ACPI ERST requires size be multiple of " +"record size (%luKiB)" ,ERST_RECORD_SIZE ); + } + +/* Initialize backend storage and record_count */ +check_erst_backend_storage (s, errp); + +/* BAR 0: Programming registers */ +memory_region_init_io (&s->iomem,OBJECT (pci_dev), &erst_reg_ops, s, +TYPE_ACPI_ERST ,ERST_REG_SIZE ); +pci_register_bar (pci_dev,0 ,PCI_BASE_ADDRESS_SPACE_MEMORY , &s->iomem); + +/* BAR 1: Exchange buffer memory */ Quoted 8 lines
hw/acpi/erst.c line 680
Quoted 7 lines
hw/acpi/erst.c new file +7
-0+/* Create a hostmem object to use as the exchange buffer */ + s->exchange_obj =object_new (TYPE_MEMORY_BACKEND_RAM ); +object_property_set_int (s->exchange_obj,"size" ,ERST_RECORD_SIZE , errp); +user_creatable_complete (USER_CREATABLE (s->exchange_obj), errp); + s->exchange =MEMORY_BACKEND (s->exchange_obj); +host_memory_backend_set_mapped (s->exchange, true); + s->exchange_mr =host_memory_backend_get_memory (s->exchange);replace this block with single
memory_region_init_ram()done!
Quoted 6 lines
hw/acpi/erst.c line 682
Quoted 4 lines
hw/acpi/erst.c new file +2
-0+memory_region_init_resizeable_ram (s->exchange_mr,OBJECT (pci_dev), +TYPE_ACPI_ERST ,ERST_RECORD_SIZE ,ERST_RECORD_SIZE ,NULL , errp);have ho idea why it's necessary, seems just wrong, it basically leaks previous memory region and creates a new one.
done!
Quoted 6 lines
hw/acpi/erst.c line 685
Quoted 5 lines
hw/acpi/erst.c new file +3
-0+pci_register_bar (pci_dev,1 ,PCI_BASE_ADDRESS_SPACE_MEMORY , s->exchange_mr); +/* Include the exchange buffer in the migration stream */ +vmstate_register_ram_global (s->exchange_mr);not necessary if
memory_region_init_ram()is used directlydone!
Quoted 45 lines
Quoted 33 lines
hw/acpi/erst.c new file +32
-0+ +/* Include the backend storage in the migration stream */ +vmstate_register_ram_global (s->hostmem_mr); + +trace_acpi_erst_realizefn_out (s->storage_size); +} + +static void erst_reset (DeviceState *dev) +{ +ERSTDeviceState *s =ACPIERST (dev); + +trace_acpi_erst_reset_in (s->header->record_count); + s->operation =0 ; + s->busy_status =0 ; + s->command_status =STATUS_SUCCESS ; + s->record_identifier =ERST_UNSPECIFIED_RECORD_ID ; + s->record_offset =0 ; + s->next_record_index = s->first_record_index; +/* NOTE: first/last_record_index are computed only once */ +trace_acpi_erst_reset_out (s->header->record_count); +} + +static Property erst_properties[] = { +DEFINE_PROP_LINK (ACPI_ERST_MEMDEV_PROP , ERSTDeviceState, hostmem, + TYPE_MEMORY_BACKEND, HostMemoryBackend *), +DEFINE_PROP_END_OF_LIST (), +}; + +static void erst_class_init (ObjectClass *klass,void *data) +{ +DeviceClass *dc =DEVICE_CLASS (klass); +PCIDeviceClass *k =PCI_DEVICE_CLASS (klass);hw/acpi/erst.c line 727
Quoted 10 lines
hw/acpi/erst.c new file +10
-0+ +trace_acpi_erst_class_init_in (); + k->realize = erst_realizefn; + k->vendor_id =PCI_VENDOR_ID_REDHAT ; + k->device_id =PCI_DEVICE_ID_REDHAT_ACPI_ERST ; + k->revision =0x00 ; + k->class_id =PCI_CLASS_OTHERS ; + dc->reset = erst_reset; + dc->vmsd = &erst_vmstate; + dc->user_creatable = true;can't be hotplugged, add:
Quoted 1 line
dc->hotpluggable = false;done
Quoted 60 lines
Quoted 59 lines
hw/acpi/erst.c new file +23
-0+device_class_set_props (dc, erst_properties); + dc->desc ="ACPI Error Record Serialization Table (ERST) device" ; +set_bit (DEVICE_CATEGORY_MISC , dc->categories); +trace_acpi_erst_class_init_out (); +} + +static const TypeInfo erst_type_info = { + .name =TYPE_ACPI_ERST , + .parent =TYPE_PCI_DEVICE , + .class_init = erst_class_init, + .instance_size =sizeof (ERSTDeviceState), + .interfaces = (InterfaceInfo []) { + {INTERFACE_CONVENTIONAL_PCI_DEVICE }, + { } + } +}; + +static void erst_register_types (void ) +{ +type_register_static (&erst_type_info); +} + +type_init (erst_register_types)hw/acpi/meson.build +1
-0@@ -5,6 +5,7 @@ acpi_ss.add(files( 'bios-linker-loader.c', 'core.c', 'utils.c', + 'erst.c', )) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu.c')) acpi_ss.add(when: 'CONFIG_ACPI_CPU_HOTPLUG', if_true: files('cpu_hotplug.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) "header: 0x%p" +acpi_erst_class_init_in(void) +acpi_erst_class_init_out(void)
PATCH v6 6/10 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 | 239 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 239 insertions(+)
hw/acpi/erst.c +239 -0
@@ -601,6 +601,245 @@ static const MemoryRegionOps erst_reg_ops = { .endianness = DEVICE_NATIVE_ENDIAN, }; + +/*******************************************************************/ +/*******************************************************************/ + +/* 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 + +/* 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, +uint64_t mask) +{ +/* ACPI 4.0: Table 17-18 Serialization Instruction Entry */ +struct AcpiGenericAddress gas; + +/* 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 ; +switch (register_bit_width) { +case 8 : + gas.access_width =1 ; +break ; +case 16 : + gas.access_width =2 ; +break ; +case 32 : + gas.access_width =3 ; +break ; +case 64 : + gas.access_width =4 ; +break ; +default : + gas.access_width =0 ; +break ; + } + gas.address = register_address; +build_append_gas_from_struct (table_data, &gas); +/* Value */ +build_append_int_noprefix (table_data, value ,8 ); +/* Mask */ +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; +unsigned erst_start = table_data->len; +hwaddr bar0, bar1; + + bar0 = (hwaddr )pci_get_bar_addr (PCI_DEVICE (erst_dev),0 ); +trace_acpi_erst_pci_bar_0 (bar0); + bar1 = (hwaddr )pci_get_bar_addr (PCI_DEVICE (erst_dev),1 ); +trace_acpi_erst_pci_bar_1 (bar1); + +#define MASK8 0x00000000000000FFUL +#define MASK16 0x000000000000FFFFUL +#define MASK32 0x00000000FFFFFFFFUL +#define MASK64 0xFFFFFFFFFFFFFFFFUL + +/* +* 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 )); + +/* Serialization Instruction Entries */ + action =ACTION_BEGIN_WRITE_OPERATION ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); + + action =ACTION_BEGIN_READ_OPERATION ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); + + action =ACTION_BEGIN_CLEAR_OPERATION ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); + + action =ACTION_END_OPERATION ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); + + action =ACTION_SET_RECORD_OFFSET ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER ,0 ,32 , + bar0 +ERST_VALUE_OFFSET ,0 ,MASK32 ); +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); + + action =ACTION_EXECUTE_OPERATION ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_VALUE_OFFSET ,ERST_EXECUTE_OPERATION_MAGIC ,MASK8 ); +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); + + action =ACTION_CHECK_BUSY_STATUS ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); +build_serialization_instruction_entry (table_instruction_data, + action,INST_READ_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_VALUE_OFFSET ,0x01 ,MASK8 ); + + action =ACTION_GET_COMMAND_STATUS ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); +build_serialization_instruction_entry (table_instruction_data, + action,INST_READ_REGISTER ,0 ,32 , + bar0 +ERST_VALUE_OFFSET ,0 ,MASK8 ); + + action =ACTION_GET_RECORD_IDENTIFIER ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); +build_serialization_instruction_entry (table_instruction_data, + action,INST_READ_REGISTER ,0 ,64 , + bar0 +ERST_VALUE_OFFSET ,0 ,MASK64 ); + + action =ACTION_SET_RECORD_IDENTIFIER ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER ,0 ,64 , + bar0 +ERST_VALUE_OFFSET ,0 ,MASK64 ); +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); + + action =ACTION_GET_RECORD_COUNT ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); +build_serialization_instruction_entry (table_instruction_data, + action,INST_READ_REGISTER ,0 ,32 , + bar0 +ERST_VALUE_OFFSET ,0 ,MASK32 ); + + action =ACTION_BEGIN_DUMMY_WRITE_OPERATION ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); + + action =ACTION_GET_ERROR_LOG_ADDRESS_RANGE ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); +build_serialization_instruction_entry (table_instruction_data, + action,INST_READ_REGISTER ,0 ,64 , + bar0 +ERST_VALUE_OFFSET ,0 ,MASK64 ); + + action =ACTION_GET_ERROR_LOG_ADDRESS_LENGTH ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); +build_serialization_instruction_entry (table_instruction_data, + action,INST_READ_REGISTER ,0 ,64 , + bar0 +ERST_VALUE_OFFSET ,0 ,MASK32 ); + + action =ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); +build_serialization_instruction_entry (table_instruction_data, + action,INST_READ_REGISTER ,0 ,32 , + bar0 +ERST_VALUE_OFFSET ,0 ,MASK32 ); + + action =ACTION_GET_EXECUTE_OPERATION_TIMINGS ; +build_serialization_instruction_entry (table_instruction_data, + action,INST_WRITE_REGISTER_VALUE ,0 ,32 , + bar0 +ERST_ACTION_OFFSET , action,MASK8 ); +build_serialization_instruction_entry (table_instruction_data, + action,INST_READ_REGISTER ,0 ,64 , + bar0 +ERST_VALUE_OFFSET ,0 ,MASK64 ); + +/* Serialization Header */ +acpi_data_push (table_data,sizeof (AcpiTableHeader)); +/* 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 +*/ +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); + +build_header (linker, table_data, + (void *)(table_data->data + erst_start), +"ERST" , table_data->len - erst_start, +1 , oem_id, oem_table_id); +} +/*******************************************************************/ /*******************************************************************/ static int erst_post_load (void *opaque,int version_id)
Signature · 1 line
1.8.3.1
PATCH v6 7/10 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 | 9 +++++++++ hw/i386/acpi-microvm.c | 9 +++++++++ include/hw/acpi/erst.h | 5 +++++ 3 files changed, 23 insertions(+)
hw/i386/acpi-build.c +9 -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"
@@ -2443,6 +2444,7 @@ void acpi_build(AcpiBuildTables *tables, MachineState *machine)GArray *tables_blob = tables->table_data;AcpiSlicOem slic_oem = { .id =NULL , .table_id =NULL };Object *vmgenid_dev; +Object *erst_dev;char *oem_id;char *oem_table_id;
@@ -2504,6 +2506,13 @@ void acpi_build(AcpiBuildTables *tables, MachineState *machine)ACPI_DEVICE_IF (x86ms->acpi_dev), x86ms->oem_id, x86ms->oem_table_id); + 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); + } + vmgenid_dev =find_vmgenid_dev ();if (vmgenid_dev) {acpi_add_table (table_offsets, tables_blob);
hw/i386/acpi-microvm.c +9 -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"
@@ -159,6 +160,7 @@ static void acpi_build_microvm(AcpiBuildTables *tables,X86MachineState *x86ms =X86_MACHINE (mms);GArray *table_offsets;GArray *tables_blob = tables->table_data; +Object *erst_dev;unsigned dsdt, xsdt;AcpiFadtData pmfadt = {/* ACPI 5.0: 4.1 Hardware-Reduced ACPI */
@@ -208,6 +210,13 @@ static void acpi_build_microvm(AcpiBuildTables *tables,ACPI_DEVICE_IF (x86ms->acpi_dev), x86ms->oem_id, x86ms->oem_table_id); + 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); + } + 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 v6 8/10 ACPI ERST: qtest for ERST
In reply to Eric DeVolderThis change provides a qtest that locates and then does a simple interrogation of the ERST feature within the guest.
--- tests/qtest/erst-test.c | 167 ++++++++++++++++++++++++++++++++++++++++++++++++ tests/qtest/meson.build | 2 + 2 files changed, 169 insertions(+) create mode 100644 tests/qtest/erst-test.c
tests/qtest/erst-test.c new file +167 -0
@@ -0,0 +1,167 @@ +/* +* 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" + +static void save_fn (QPCIDevice *dev,int devfn,void *data) +{ +QPCIDevice **pdev = (QPCIDevice **) data; + + *pdev = dev; +} + +static QPCIDevice *get_device (QPCIBus *pcibus) +{ +QPCIDevice *dev; + + dev =NULL ; +qpci_device_foreach (pcibus,0x1b36 ,0x0012 , 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_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-test'] : []) + \ qtests_pci + \ ['fdc-test', 'ide-test',
@@ -245,6 +246,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 v6 9/10 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 | 43 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+)
tests/qtest/bios-tables-test.c +43 -0
@@ -1378,6 +1378,45 @@ static void test_acpi_piix4_tcg_acpi_hmat(void)test_acpi_tcg_acpi_hmat (MACHINE_PC ); } +static void test_acpi_erst (const char *machine) +{ +test_data data; + +memset (&data,0 ,sizeof (data)); + data.machine = machine; +/*data.variant = ".acpierst";*/ +test_acpi_one (" -object memory-backend-file,id=erstnvram," +"mem-path=tests/acpi-erst.XXXXXX,size=0x10000,share=on" +" -device acpi-erst,memdev=erstnvram" , + &data); +free_test_data (&data); +} + +static void test_acpi_piix4_erst (void ) +{ +test_acpi_erst (MACHINE_PC ); +} + +static void test_acpi_q35_erst (void ) +{ +test_acpi_erst (MACHINE_Q35 ); +} + +static void test_acpi_microvm_erst (void ) +{ +test_data data; + +test_acpi_microvm_prepare (&data); + data.variant =".pcie" ; + data.tcg_only = true;/* need constant host-phys-bits */ +test_acpi_one (" -machine microvm,acpi=on,ioapic2=off,rtc=off,pcie=on " +"-object memory-backend-file,id=erstnvram," +"mem-path=tests/acpi-erst.XXXXXX,size=0x10000,share=on " +"-device acpi-erst,memdev=erstnvram" , + &data); +free_test_data (&data); +} +static void test_acpi_virt_tcg (void ) {test_data data = {
@@ -1560,7 +1599,11 @@ int main(int argc, char *argv[])qtest_add_func ("acpi/microvm/oem-fields" , test_acpi_oem_fields_microvm);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_erst); } +qtest_add_func ("acpi/piix4/acpierst" , test_acpi_piix4_erst); +qtest_add_func ("acpi/q35/acpierst" , test_acpi_q35_erst); + }else if (strcmp (arch,"aarch64" ) ==0 ) {qtest_add_func ("acpi/virt" , test_acpi_virt_tcg);qtest_add_func ("acpi/virt/numamem" , test_acpi_virt_tcg_numamem);
Signature · 1 line
1.8.3.1
Re: [PATCH v6 09/10] ACPI ERST: bios-tables-test testcase
Quoted 39 lines · On Thu, 5 Aug 2021 18:30:38 -0400 Eric DeVolder <[email protected]>…
This change implements the test suite checks for the ERST table.
Signed-off-by Eric DeVolder <[email protected]>--- tests/qtest/bios-tables-test.c | 43 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+)tests/qtest/bios-tables-test.c +24
-0@@ -1378,6 +1378,45 @@ static void test_acpi_piix4_tcg_acpi_hmat(void)test_acpi_tcg_acpi_hmat (MACHINE_PC ); } +static void test_acpi_erst (const char *machine) +{ +test_data data; + +memset (&data,0 ,sizeof (data)); + data.machine = machine; +/*data.variant = ".acpierst";*/ +test_acpi_one (" -object memory-backend-file,id=erstnvram," +"mem-path=tests/acpi-erst.XXXXXX,size=0x10000,share=on" +" -device acpi-erst,memdev=erstnvram" , + &data); +free_test_data (&data); +} + +static void test_acpi_piix4_erst (void ) +{ +test_acpi_erst (MACHINE_PC ); +} + +static void test_acpi_q35_erst (void ) +{ +test_acpi_erst (MACHINE_Q35 ); +} +
tests/qtest/bios-tables-test.c static void test_acpi_piix4_tcg_acpi_hmat(void) · line 1414
Quoted 10 lines
tests/qtest/bios-tables-test.c +10
-0+static void test_acpi_microvm_erst (void ) +{ +test_data data; + +test_acpi_microvm_prepare (&data); + data.variant =".pcie" ; + data.tcg_only = true;/* need constant host-phys-bits */ +test_acpi_one (" -machine microvm,acpi=on,ioapic2=off,rtc=off,pcie=on " +"-object memory-backend-file,id=erstnvram," + "mem-path=tests/acpi-erst.XXXXXX,size=0x10000,share=on "
^^^^
shouldn't the path be generated with g_dir_make_tmp() & co + corresponding cleanup
Quoted 20 lines
tests/qtest/bios-tables-test.c +9
-0+"-device acpi-erst,memdev=erstnvram" , + &data); +free_test_data (&data); +} +static void test_acpi_virt_tcg (void ) {test_data data = {@@ -1560,7 +1599,11 @@ int main(int argc, char *argv[])qtest_add_func ("acpi/microvm/oem-fields" , test_acpi_oem_fields_microvm);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_erst); } +qtest_add_func ("acpi/piix4/acpierst" , test_acpi_piix4_erst); +qtest_add_func ("acpi/q35/acpierst" , test_acpi_q35_erst); + }else if (strcmp (arch,"aarch64" ) ==0 ) {qtest_add_func ("acpi/virt" , test_acpi_virt_tcg);qtest_add_func ("acpi/virt/numamem" , test_acpi_virt_tcg_numamem);
Re: [PATCH v6 09/10] ACPI ERST: bios-tables-test testcase
Quoted 53 lines · Igor Mammedov
Quoted 39 lines · On Thu, 5 Aug 2021 18:30:38 -0400 Eric DeVolder <[email protected]>…
This change implements the test suite checks for the ERST table.
Signed-off-by Eric DeVolder <[email protected]>--- tests/qtest/bios-tables-test.c | 43 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+)tests/qtest/bios-tables-test.c +24
-0@@ -1378,6 +1378,45 @@ static void test_acpi_piix4_tcg_acpi_hmat(void)test_acpi_tcg_acpi_hmat (MACHINE_PC ); } +static void test_acpi_erst (const char *machine) +{ +test_data data; + +memset (&data,0 ,sizeof (data)); + data.machine = machine; +/*data.variant = ".acpierst";*/ +test_acpi_one (" -object memory-backend-file,id=erstnvram," +"mem-path=tests/acpi-erst.XXXXXX,size=0x10000,share=on" +" -device acpi-erst,memdev=erstnvram" , + &data); +free_test_data (&data); +} + +static void test_acpi_piix4_erst (void ) +{ +test_acpi_erst (MACHINE_PC ); +} + +static void test_acpi_q35_erst (void ) +{ +test_acpi_erst (MACHINE_Q35 ); +} +tests/qtest/bios-tables-test.c static void test_acpi_piix4_tcg_acpi_hmat(void) · line 1414
Quoted 10 lines
tests/qtest/bios-tables-test.c +10
-0+static void test_acpi_microvm_erst (void ) +{ +test_data data; + +test_acpi_microvm_prepare (&data); + data.variant =".pcie" ; + data.tcg_only = true;/* need constant host-phys-bits */ +test_acpi_one (" -machine microvm,acpi=on,ioapic2=off,rtc=off,pcie=on " +"-object memory-backend-file,id=erstnvram," + "mem-path=tests/acpi-erst.XXXXXX,size=0x10000,share=on "^^^^
Quoted 1 line
shouldn't the path be generated with
g_dir_make_tmp()& co + corresponding cleanup
done!
Quoted 22 lines
Quoted 21 lines
tests/qtest/bios-tables-test.c +9
-0+"-device acpi-erst,memdev=erstnvram" , + &data); +free_test_data (&data); +} +static void test_acpi_virt_tcg (void ) {test_data data = {@@ -1560,7 +1599,11 @@ int main(int argc, char *argv[])qtest_add_func ("acpi/microvm/oem-fields" , test_acpi_oem_fields_microvm);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_erst); } +qtest_add_func ("acpi/piix4/acpierst" , test_acpi_piix4_erst); +qtest_add_func ("acpi/q35/acpierst" , test_acpi_q35_erst); + }else if (strcmp (arch,"aarch64" ) ==0 ) {qtest_add_func ("acpi/virt" , test_acpi_virt_tcg);qtest_add_func ("acpi/virt/numamem" , test_acpi_virt_tcg_numamem);
PATCH v6 10/10 ACPI ERST: step 6 of bios-tables-test
In reply to Eric DeVolderFollowing the guidelines in tests/qtest/bios-tables-test.c, this is step 6, the re-generated ACPI tables binary blobs.
--- tests/data/acpi/microvm/ERST.pcie | Bin 0 -> 912 bytes tests/data/acpi/pc/DSDT | Bin 6002 -> 6009 bytes tests/data/acpi/pc/ERST | Bin 0 -> 912 bytes tests/data/acpi/q35/DSDT | Bin 8289 -> 8306 bytes tests/data/acpi/q35/ERST | Bin 0 -> 912 bytes tests/qtest/bios-tables-test-allowed-diff.h | 6 ------ 6 files changed, 6 deletions(-) create mode 100644 tests/data/acpi/microvm/ERST.pcie
tests/data/acpi/microvm/ERST.pcie new file binary +0 -0
tests/data/acpi/pc/DSDT binary +0 -0
tests/data/acpi/pc/ERST binary +0 -0
tests/data/acpi/q35/DSDT binary +0 -0
tests/data/acpi/q35/ERST binary +0 -0
tests/qtest/bios-tables-test-allowed-diff.h +0 -6
@@ -1,7 +1 @@/* List of comma-separated changed AML files to ignore */ -"tests/data/acpi/pc/ERST" , -"tests/data/acpi/q35/ERST" , -"tests/data/acpi/microvm/ERST" , -"tests/data/acpi/pc/DSDT" , -"tests/data/acpi/q35/DSDT" , -"tests/data/acpi/microvm/DSDT",
Signature · 1 line
1.8.3.1
Re: [PATCH v6 10/10] ACPI ERST: step 6 of bios-tables-test
Well, I discovered today that running "make check" again resulted in bios table mismatches. In looking into this further, I think I might finally have an understanding as to how this is all to work. My bios-tables-test-allowed-diff for step 1 now looks like:
"tests/data/acpi/pc/DSDT.acpierst",
"tests/data/acpi/pc/ERST",
"tests/data/acpi/q35/DSDT.acpierst",
"tests/data/acpi/q35/ERST",
"tests/data/acpi/microvm/ERST.pcie",
and with the corresponding empty files and by using the
.variant = ".acpierst"
in bios-tables-test, I am able to run "make check" multiple times now without failures.
So, that means patch 01/10 and 10/10 are wrong. I'm assuming there will be other items to address, so I'll plan for these fixes in v7.
My apologies,
eric
Quoted 88 lines · Eric DeVolder
Following the guidelines in
tests/qtest/bios-tables-test.c, this is step 6, the re-generated ACPI tables binary blobs.Signed-off-by Eric DeVolder <[email protected]>--- tests/data/acpi/microvm/ERST.pcie | Bin 0 -> 912 bytes tests/data/acpi/pc/DSDT | Bin 6002 -> 6009 bytes tests/data/acpi/pc/ERST | Bin 0 -> 912 bytes tests/data/acpi/q35/DSDT | Bin 8289 -> 8306 bytes tests/data/acpi/q35/ERST | Bin 0 -> 912 bytes tests/qtest/bios-tables-test-allowed-diff.h | 6 ------ 6 files changed, 6 deletions(-)create mode 100644 tests/data/acpi/microvm/ERST.pcie
tests/data/acpi/microvm/ERST.pcie new file binary +0
-0tests/data/acpi/pc/DSDT binary +0
-0tests/data/acpi/pc/ERST binary +0
-0tests/data/acpi/q35/DSDT binary +0
-0tests/data/acpi/q35/ERST binary +0
-0tests/qtest/bios-tables-test-allowed-diff.h +0
-6@@ -1,7 +1 @@/* List of comma-separated changed AML files to ignore */ -"tests/data/acpi/pc/ERST" , -"tests/data/acpi/q35/ERST" , -"tests/data/acpi/microvm/ERST" , -"tests/data/acpi/pc/DSDT" , -"tests/data/acpi/q35/DSDT" , -"tests/data/acpi/microvm/DSDT",
Re: [PATCH v6 10/10] ACPI ERST: step 6 of bios-tables-test
Igor,
I'm not sure if I should post v7 with the correction to the tables, or await your guidance/feedback on v6.
Thanks,
eric
Quoted 113 lines · Eric DeVolder
Well, I discovered today that running "make check" again resulted in bios table mismatches. In looking into this further, I think I might finally have an understanding as to how this is all to work. My bios-tables-test-allowed-diff for step 1 now looks like:
"tests/data/acpi/pc/DSDT.acpierst",
"tests/data/acpi/pc/ERST",
"tests/data/acpi/q35/DSDT.acpierst",
"tests/data/acpi/q35/ERST",
"tests/data/acpi/microvm/ERST.pcie",and with the corresponding empty files and by using the
.variant = ".acpierst"
in bios-tables-test, I am able to run "make check" multiple times now without failures.So, that means patch 01/10 and 10/10 are wrong. I'm assuming there will be other items to address, so I'll plan for these fixes in v7.
My apologies,
ericQuoted 88 lines · Eric DeVolder
Following the guidelines in
tests/qtest/bios-tables-test.c, this is step 6, the re-generated ACPI tables binary blobs.Signed-off-by Eric DeVolder <[email protected]>---
tests/data/acpi/microvm/ERST.pcie | Bin 0 -> 912 bytes tests/data/acpi/pc/DSDT | Bin 6002 -> 6009 bytes tests/data/acpi/pc/ERST | Bin 0 -> 912 bytes tests/data/acpi/q35/DSDT | Bin 8289 -> 8306 bytes tests/data/acpi/q35/ERST | Bin 0 -> 912 bytestests/qtest/bios-tables-test-allowed-diff.h| 6 ------6 files changed, 6 deletions(-)create mode 100644 tests/data/acpi/microvm/ERST.pcie
tests/data/acpi/microvm/ERST.pcie new file binary +0
-0tests/data/acpi/pc/DSDT binary +0
-0tests/data/acpi/pc/ERST binary +0
-0tests/data/acpi/q35/DSDT binary +0
-0tests/data/acpi/q35/ERST binary +0
-0tests/qtest/bios-tables-test-allowed-diff.h +0
-6@@ -1,7 +1 @@ /* List of comma-separated changed AML files to ignore */ -"tests/data/acpi/pc/ERST" , -"tests/data/acpi/q35/ERST" , -"tests/data/acpi/microvm/ERST" , -"tests/data/acpi/pc/DSDT" , -"tests/data/acpi/q35/DSDT" , -"tests/data/acpi/microvm/DSDT",
Re: [PATCH v6 10/10] ACPI ERST: step 6 of bios-tables-test
Quoted 3 lines · On Fri, 27 Aug 2021 16:45:15 -0500 Eric DeVolder <[email protected]>…
Igor,
I'm not sure if I should post v7 with the correction to the tables, or await your guidance/feedback on v6.
Hopefully, I'll be back to reviewing patches (including yours) next week.
Quoted 120 lines
Thanks,
ericQuoted 114 lines · Eric DeVolder
Well, I discovered today that running "make check" again resulted in bios table mismatches. In looking into this further, I think I might finally have an understanding as to how this is all to work. My bios-tables-test-allowed-diff for step 1 now looks like:
"tests/data/acpi/pc/DSDT.acpierst",
"tests/data/acpi/pc/ERST",
"tests/data/acpi/q35/DSDT.acpierst",
"tests/data/acpi/q35/ERST",
"tests/data/acpi/microvm/ERST.pcie",and with the corresponding empty files and by using the
.variant = ".acpierst"
in bios-tables-test, I am able to run "make check" multiple times now without failures.So, that means patch 01/10 and 10/10 are wrong. I'm assuming there will be other items to address, so I'll plan for these fixes in v7.
My apologies,
ericQuoted 89 lines · Eric DeVolder
Following the guidelines in
tests/qtest/bios-tables-test.c, this is step 6, the re-generated ACPI tables binary blobs.Signed-off-by Eric DeVolder <[email protected]>---
tests/data/acpi/microvm/ERST.pcie | Bin 0 -> 912 bytes tests/data/acpi/pc/DSDT | Bin 6002 -> 6009 bytes tests/data/acpi/pc/ERST | Bin 0 -> 912 bytes tests/data/acpi/q35/DSDT | Bin 8289 -> 8306 bytes tests/data/acpi/q35/ERST | Bin 0 -> 912 bytestests/qtest/bios-tables-test-allowed-diff.h| 6 ------6 files changed, 6 deletions(-)create mode 100644 tests/data/acpi/microvm/ERST.pcie
tests/data/acpi/microvm/ERST.pcie new file binary +0
-0tests/data/acpi/pc/DSDT binary +0
-0zcmeyQ_fwC{CD<jTQk;Q-F=QiG057Ni!kGAAr+5MP$;rGe;+
zQh8FQ0@s2J*JPZuX l3>=QZp?+M<lN)&@ggD~CY!RV&S1$v0B2XP&5C@1oB+Xc6m$Rpdelta 65 zcmeyV_eqb-CD<jTNSuLzao$F*0A5ayg)#BLPVoW
laqN{#GFy4K3n1;)6r|xR^QO V9bJNW7#Nr*U*I#Y|7t2>@&@5ljF8tests/data/acpi/pc/ERST binary +0
-0zcmaKpOAdlC6h#XZC=fn#CoF*_7>J28jW}>wF2KFG3zs9lTPTnl;U#=7r>E_sr(1u2 z21<FK_R^jEx_w-
TFO&O;T_LLF4O@x8LMi!H}5Z^t6_Tah{H!Y?i2S%JoA7!BFgz1 zf~;?N{b8^}H2K=viyuzhL7M``U{CiG=Ib#4X^gc{m10T<lDURCpCW$T#HMd{o-? zH~aEPznCu9;f*enm;9;GDrTme_0zSBR|7ODR;g(@qEM!N8Z_gL4HBL%^N<3mgJY@ R+q~0XMSexT%^U0Ee0~)`g#iEnliteral 0
HcmV?d00001tests/data/acpi/q35/DSDT binary +0
-0tests/data/acpi/q35/ERST binary +0
-0zcmaKpOAdlC6h#XZC=fn#CoF*_7>J28jW}>wF2KFG3zs9lTPTnl;U#=7r>E_sr(1u2 z21<FK_R^jEx_w-
TFO&O;T_LLF4O@x8LMi!H}5Z^t6_Tah{H!Y?i2S%JoA7!BFgz1 zf~;?N{b8^}H2K=viyuzhL7M``U{CiG=Ib#4X^gc{m10T<lDURCpCW$T#HMd{o-? zH~aEPznCu9;f*enm;9;GDrTme_0zSBR|7ODR;g(@qEM!N8Z_gL4HBL%^N<3mgJY@ R+q~0XMSexT%^U0Ee0~)`g#iEnliteral 0
HcmV?d00001tests/qtest/bios-tables-test-allowed-diff.h +0
-6@@ -1,7 +1 @@ /* List of comma-separated changed AML files to ignore */ -"tests/data/acpi/pc/ERST" , -"tests/data/acpi/q35/ERST" , -"tests/data/acpi/microvm/ERST" , -"tests/data/acpi/pc/DSDT" , -"tests/data/acpi/q35/DSDT" , -"tests/data/acpi/microvm/DSDT",
Re: [PATCH v6 10/10] ACPI ERST: step 6 of bios-tables-test
In reply to Eric DeVolderQuoted 2 lines · On Thu, 5 Aug 2021 18:30:39 -0400 Eric DeVolder <[email protected]>…
Following the guidelines in
tests/qtest/bios-tables-test.c, this is step 6, the re-generated ACPI tables binary blobs.
commit message should include ASL diff for new/changed content
for example see commit:1aaef7d8092803 acpi: unit-test: Update WAET ACPI Table expected binaries
Quoted 85 lines
Signed-off-by Eric DeVolder <[email protected]>--- tests/data/acpi/microvm/ERST.pcie | Bin 0 -> 912 bytes tests/data/acpi/pc/DSDT | Bin 6002 -> 6009 bytes tests/data/acpi/pc/ERST | Bin 0 -> 912 bytes tests/data/acpi/q35/DSDT | Bin 8289 -> 8306 bytes tests/data/acpi/q35/ERST | Bin 0 -> 912 bytes tests/qtest/bios-tables-test-allowed-diff.h | 6 ------ 6 files changed, 6 deletions(-) create mode 100644 tests/data/acpi/microvm/ERST.pcietests/data/acpi/microvm/ERST.pcie new file binary +0
-0tests/data/acpi/pc/DSDT binary +0
-0l3>=QZp?+M<lN)&@ggD~CY!RV&S1$v`0B2XP&5C@1oB+Xc6m$Rp
delta 65 zcmeyV_eqb-CD<jTNSuLzao$F*0A5ayg)#BLPVoW
laqN{#GFy4K3n1;)6r|xR^QO V9bJNW7#Nr*U*I#Y|7t2>@&@5ljF8tests/data/acpi/pc/ERST binary +0
-0zcmaKpOAdlC6h#XZC=fn#CoF*_7>J28jW}>wF2KFG3zs9lTPTnl;U#=7r>E_sr(1u2 z21<FK_R^jEx_w-
TFO&O;T_LLF4O@x8LMi!H}5Z^t6_Tah{H!Y?i2S%JoA7!BFgz1 zf~;?N{b8^}H2K=viyuzhL7M``U{CiG=Ib#4X^gc{m10T<lDURCpCW$T#HMd{o-? zH~aEPznCu9;f*enm;9;GDrTme_0zSBR|7ODR;g(@qEM!N8Z_gL4HBL%^N<3mgJY@ R+q~0XMSexT%^U0Ee0~)`g#iEnliteral 0
HcmV?d00001tests/data/acpi/q35/DSDT binary +0
-0tests/data/acpi/q35/ERST binary +0
-0zcmaKpOAdlC6h#XZC=fn#CoF*_7>J28jW}>wF2KFG3zs9lTPTnl;U#=7r>E_sr(1u2 z21<FK_R^jEx_w-
TFO&O;T_LLF4O@x8LMi!H}5Z^t6_Tah{H!Y?i2S%JoA7!BFgz1 zf~;?N{b8^}H2K=viyuzhL7M``U{CiG=Ib#4X^gc{m10T<lDURCpCW$T#HMd{o-? zH~aEPznCu9;f*enm;9;GDrTme_0zSBR|7ODR;g(@qEM!N8Z_gL4HBL%^N<3mgJY@ R+q~0XMSexT%^U0Ee0~)`g#iEnliteral 0
HcmV?d00001tests/qtest/bios-tables-test-allowed-diff.h +0
-6@@ -1,7 +1 @@/* List of comma-separated changed AML files to ignore */ -"tests/data/acpi/pc/ERST" , -"tests/data/acpi/q35/ERST" , -"tests/data/acpi/microvm/ERST" , -"tests/data/acpi/pc/DSDT" , -"tests/data/acpi/q35/DSDT" , -"tests/data/acpi/microvm/DSDT",
Re: [PATCH v6 10/10] ACPI ERST: step 6 of bios-tables-test
Quoted 11 lines · Igor Mammedov
Quoted 2 lines · On Thu, 5 Aug 2021 18:30:39 -0400 Eric DeVolder <[email protected]>…
Following the guidelines in
tests/qtest/bios-tables-test.c, this is step 6, the re-generated ACPI tables binary blobs.commit message should include ASL diff for new/changed content
for example see commit:
1aaef7d8092803acpi: unit-test: Update WAET ACPI Table expected binaries
done
Quoted 87 lines
Quoted 86 lines
Signed-off-by Eric DeVolder <[email protected]>--- tests/data/acpi/microvm/ERST.pcie | Bin 0 -> 912 bytes tests/data/acpi/pc/DSDT | Bin 6002 -> 6009 bytes tests/data/acpi/pc/ERST | Bin 0 -> 912 bytes tests/data/acpi/q35/DSDT | Bin 8289 -> 8306 bytes tests/data/acpi/q35/ERST | Bin 0 -> 912 bytes tests/qtest/bios-tables-test-allowed-diff.h | 6 ------ 6 files changed, 6 deletions(-)create mode 100644 tests/data/acpi/microvm/ERST.pcie
tests/data/acpi/microvm/ERST.pcie new file binary +0
-0tests/data/acpi/pc/DSDT binary +0
-0tests/data/acpi/pc/ERST binary +0
-0tests/data/acpi/q35/DSDT binary +0
-0tests/data/acpi/q35/ERST binary +0
-0tests/qtest/bios-tables-test-allowed-diff.h +0
-6@@ -1,7 +1 @@/* List of comma-separated changed AML files to ignore */ -"tests/data/acpi/pc/ERST" , -"tests/data/acpi/q35/ERST" , -"tests/data/acpi/microvm/ERST" , -"tests/data/acpi/pc/DSDT" , -"tests/data/acpi/q35/DSDT" , -"tests/data/acpi/microvm/DSDT",