fridtjof/qemu-cr16
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
qemu-cr16/hw/acpi/ghes.c
Mauro Carvalho Chehab ddd8f3baa2 qapi/acpi-hest: add an interface to do generic CPER error injection 
Create a QMP command to be used for generic ACPI APEI hardware error
injection (HEST) via GHESv2, and add support for it for ARM guests.

Error injection uses ACPI_HEST_SRC_ID_QMP source ID to be platform
independent. This is mapped at arch virt bindings, depending on the
types supported by QEMU and by the BIOS. So, on ARM, this is supported
via ACPI_GHES_NOTIFY_GPIO notification type.

This patch was co-authored:
    - original ghes logic to inject a simple ARM record by Shiju Jose;
    - generic logic to handle block addresses by Jonathan Cameron;
    - generic GHESv2 error inject by Mauro Carvalho Chehab;

Co-authored-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Co-authored-by: Shiju Jose <shiju.jose@huawei.com>
Co-authored-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: Shiju Jose <shiju.jose@huawei.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Igor Mammedov <imammedo@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
Message-ID: <81e2118b3c8b7e5da341817f277d61251655e0db.1758610789.git.mchehab+huawei@kernel.org>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
2025-10-05 08:06:32 -04:00

615 lines
21 KiB
C
Raw Blame History

/*
* Support for generating APEI tables and recording CPER for Guests
*
* Copyright (c) 2020 HUAWEI TECHNOLOGIES CO., LTD.
*
* Author: Dongjiu Geng <gengdongjiu@huawei.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License along
* with this program; if not, see <http://www.gnu.org/licenses/>.
*/
#include "qemu/osdep.h"
#include "qemu/units.h"
#include "hw/acpi/ghes.h"
#include "hw/acpi/aml-build.h"
#include "qemu/error-report.h"
#include "hw/acpi/generic_event_device.h"
#include "hw/nvram/fw_cfg.h"
#include "qemu/uuid.h"
#define ACPI_HW_ERROR_FW_CFG_FILE "etc/hardware_errors"
#define ACPI_HW_ERROR_ADDR_FW_CFG_FILE "etc/hardware_errors_addr"
#define ACPI_HEST_ADDR_FW_CFG_FILE "etc/acpi_table_hest_addr"
/* The max size in bytes for one error block */
#define ACPI_GHES_MAX_RAW_DATA_LENGTH (1 * KiB)
/* Generic Hardware Error Source version 2 */
#define ACPI_GHES_SOURCE_GENERIC_ERROR_V2 10
/* Address offset in Generic Address Structure(GAS) */
#define GAS_ADDR_OFFSET 4
/*
* ACPI spec 1.0b
* 5.2.3 System Description Table Header
*/
#define ACPI_DESC_HEADER_OFFSET 36
/*
* The total size of Generic Error Data Entry
* ACPI 6.1/6.2: 18.3.2.7.1 Generic Error Data,
* Table 18-343 Generic Error Data Entry
*/
#define ACPI_GHES_DATA_LENGTH 72
/* The memory section CPER size, UEFI 2.6: N.2.5 Memory Error Section */
#define ACPI_GHES_MEM_CPER_LENGTH 80
/* Masks for block_status flags */
#define ACPI_GEBS_UNCORRECTABLE 1
/*
* Total size for Generic Error Status Block except Generic Error Data Entries
* ACPI 6.2: 18.3.2.7.1 Generic Error Data,
* Table 18-380 Generic Error Status Block
*/
#define ACPI_GHES_GESB_SIZE 20
/*
* See the memory layout map at docs/specs/acpi_hest_ghes.rst.
*/
/*
* ACPI 6.1: 18.3.2.8 Generic Hardware Error Source version 2
* Table 18-344 Generic Hardware Error Source version 2 (GHESv2) Structure
*/
#define HEST_GHES_V2_ENTRY_SIZE 92
/*
* ACPI 6.1: 18.3.2.8 Generic Hardware Error Source version 2
* Table 18-344 Generic Hardware Error Source version 2 (GHESv2) Structure
* Read Ack Register
*/
#define GHES_READ_ACK_ADDR_OFF 64
/*
* ACPI 6.1: 18.3.2.7: Generic Hardware Error Source
* Table 18-341 Generic Hardware Error Source Structure
* Error Status Address
*/
#define GHES_ERR_STATUS_ADDR_OFF 20
/*
* Values for error_severity field
*/
enum AcpiGenericErrorSeverity {
ACPI_CPER_SEV_RECOVERABLE = 0,
ACPI_CPER_SEV_FATAL = 1,
ACPI_CPER_SEV_CORRECTED = 2,
ACPI_CPER_SEV_NONE = 3,
};
/*
* Hardware Error Notification
* ACPI 4.0: 17.3.2.7 Hardware Error Notification
* Composes dummy Hardware Error Notification descriptor of specified type
*/
static void build_ghes_hw_error_notification(GArray *table, const uint8_t type)
{
/* Type */
build_append_int_noprefix(table, type, 1);
/*
* Length:
* Total length of the structure in bytes
*/
build_append_int_noprefix(table, 28, 1);
/* Configuration Write Enable */
build_append_int_noprefix(table, 0, 2);
/* Poll Interval */
build_append_int_noprefix(table, 0, 4);
/* Vector */
build_append_int_noprefix(table, 0, 4);
/* Switch To Polling Threshold Value */
build_append_int_noprefix(table, 0, 4);
/* Switch To Polling Threshold Window */
build_append_int_noprefix(table, 0, 4);
/* Error Threshold Value */
build_append_int_noprefix(table, 0, 4);
/* Error Threshold Window */
build_append_int_noprefix(table, 0, 4);
}
/*
* Generic Error Data Entry
* ACPI 6.1: 18.3.2.7.1 Generic Error Data
*/
static void acpi_ghes_generic_error_data(GArray *table,
const uint8_t *section_type, uint32_t error_severity,
uint8_t validation_bits, uint8_t flags,
uint32_t error_data_length, QemuUUID fru_id,
uint64_t time_stamp)
{
const uint8_t fru_text[20] = {0};
/* Section Type */
g_array_append_vals(table, section_type, 16);
/* Error Severity */
build_append_int_noprefix(table, error_severity, 4);
/* Revision */
build_append_int_noprefix(table, 0x300, 2);
/* Validation Bits */
build_append_int_noprefix(table, validation_bits, 1);
/* Flags */
build_append_int_noprefix(table, flags, 1);
/* Error Data Length */
build_append_int_noprefix(table, error_data_length, 4);
/* FRU Id */
g_array_append_vals(table, fru_id.data, ARRAY_SIZE(fru_id.data));
/* FRU Text */
g_array_append_vals(table, fru_text, sizeof(fru_text));
/* Timestamp */
build_append_int_noprefix(table, time_stamp, 8);
}
/*
* Generic Error Status Block
* ACPI 6.1: 18.3.2.7.1 Generic Error Data
*/
static void acpi_ghes_generic_error_status(GArray *table, uint32_t block_status,
uint32_t raw_data_offset, uint32_t raw_data_length,
uint32_t data_length, uint32_t error_severity)
{
/* Block Status */
build_append_int_noprefix(table, block_status, 4);
/* Raw Data Offset */
build_append_int_noprefix(table, raw_data_offset, 4);
/* Raw Data Length */
build_append_int_noprefix(table, raw_data_length, 4);
/* Data Length */
build_append_int_noprefix(table, data_length, 4);
/* Error Severity */
build_append_int_noprefix(table, error_severity, 4);
}
/* UEFI 2.6: N.2.5 Memory Error Section */
static void acpi_ghes_build_append_mem_cper(GArray *table,
uint64_t error_physical_addr)
{
/*
* Memory Error Record
*/
/* Validation Bits */
build_append_int_noprefix(table,
(1ULL << 14) | /* Type Valid */
(1ULL << 1) /* Physical Address Valid */,
8);
/* Error Status */
build_append_int_noprefix(table, 0, 8);
/* Physical Address */
build_append_int_noprefix(table, error_physical_addr, 8);
/* Skip all the detailed information normally found in such a record */
build_append_int_noprefix(table, 0, 48);
/* Memory Error Type */
build_append_int_noprefix(table, 0 /* Unknown error */, 1);
/* Skip all the detailed information normally found in such a record */
build_append_int_noprefix(table, 0, 7);
}
static void
ghes_gen_err_data_uncorrectable_recoverable(GArray *block,
const uint8_t *section_type,
int data_length)
{
/* invalid fru id: ACPI 4.0: 17.3.2.6.1 Generic Error Data,
* Table 17-13 Generic Error Data Entry
*/
QemuUUID fru_id = {};
/* Build the new generic error status block header */
acpi_ghes_generic_error_status(block, ACPI_GEBS_UNCORRECTABLE,
0, 0, data_length, ACPI_CPER_SEV_RECOVERABLE);
/* Build this new generic error data entry header */
acpi_ghes_generic_error_data(block, section_type,
ACPI_CPER_SEV_RECOVERABLE, 0, 0,
ACPI_GHES_MEM_CPER_LENGTH, fru_id, 0);
}
/*
* Build table for the hardware error fw_cfg blob.
* Initialize "etc/hardware_errors" and "etc/hardware_errors_addr" fw_cfg blobs.
* See docs/specs/acpi_hest_ghes.rst for blobs format.
*/
static void build_ghes_error_table(AcpiGhesState *ags, GArray *hardware_errors,
BIOSLinker *linker, int num_sources)
{
int i, error_status_block_offset;
/* Build error_block_address */
for (i = 0; i < num_sources; i++) {
build_append_int_noprefix(hardware_errors, 0, sizeof(uint64_t));
}
/* Build read_ack_register */
for (i = 0; i < num_sources; i++) {
/*
* Initialize the value of read_ack_register to 1, so GHES can be
* writable after (re)boot.
* ACPI 6.2: 18.3.2.8 Generic Hardware Error Source version 2
* (GHESv2 - Type 10)
*/
build_append_int_noprefix(hardware_errors, 1, sizeof(uint64_t));
}
/* Generic Error Status Block offset in the hardware error fw_cfg blob */
error_status_block_offset = hardware_errors->len;
/* Reserve space for Error Status Data Block */
acpi_data_push(hardware_errors,
ACPI_GHES_MAX_RAW_DATA_LENGTH * num_sources);
/* Tell guest firmware to place hardware_errors blob into RAM */
bios_linker_loader_alloc(linker, ACPI_HW_ERROR_FW_CFG_FILE,
hardware_errors, sizeof(uint64_t), false);
for (i = 0; i < num_sources; i++) {
/*
* Tell firmware to patch error_block_address entries to point to
* corresponding "Generic Error Status Block"
*/
bios_linker_loader_add_pointer(linker,
ACPI_HW_ERROR_FW_CFG_FILE,
sizeof(uint64_t) * i,
sizeof(uint64_t),
ACPI_HW_ERROR_FW_CFG_FILE,
error_status_block_offset +
i * ACPI_GHES_MAX_RAW_DATA_LENGTH);
}
if (!ags->use_hest_addr) {
/*
* Tell firmware to write hardware_errors GPA into
* hardware_errors_addr fw_cfg, once the former has been initialized.
*/
bios_linker_loader_write_pointer(linker, ACPI_HW_ERROR_ADDR_FW_CFG_FILE,
0, sizeof(uint64_t),
ACPI_HW_ERROR_FW_CFG_FILE, 0);
}
}
/* Build Generic Hardware Error Source version 2 (GHESv2) */
static void build_ghes_v2_entry(GArray *table_data,
BIOSLinker *linker,
const AcpiNotificationSourceId *notif_src,
uint16_t index, int num_sources)
{
uint64_t address_offset;
const uint16_t notify = notif_src->notify;
const uint16_t source_id = notif_src->source_id;
/*
* Type:
* Generic Hardware Error Source version 2(GHESv2 - Type 10)
*/
build_append_int_noprefix(table_data, ACPI_GHES_SOURCE_GENERIC_ERROR_V2, 2);
/* Source Id */
build_append_int_noprefix(table_data, source_id, 2);
/* Related Source Id */
build_append_int_noprefix(table_data, 0xffff, 2);
/* Flags */
build_append_int_noprefix(table_data, 0, 1);
/* Enabled */
build_append_int_noprefix(table_data, 1, 1);
/* Number of Records To Pre-allocate */
build_append_int_noprefix(table_data, 1, 4);
/* Max Sections Per Record */
build_append_int_noprefix(table_data, 1, 4);
/* Max Raw Data Length */
build_append_int_noprefix(table_data, ACPI_GHES_MAX_RAW_DATA_LENGTH, 4);
address_offset = table_data->len;
/* Error Status Address */
build_append_gas(table_data, AML_AS_SYSTEM_MEMORY, 0x40, 0,
4 /* QWord access */, 0);
bios_linker_loader_add_pointer(linker, ACPI_BUILD_TABLE_FILE,
address_offset + GAS_ADDR_OFFSET,
sizeof(uint64_t),
ACPI_HW_ERROR_FW_CFG_FILE,
index * sizeof(uint64_t));
/* Notification Structure */
build_ghes_hw_error_notification(table_data, notify);
/* Error Status Block Length */
build_append_int_noprefix(table_data, ACPI_GHES_MAX_RAW_DATA_LENGTH, 4);
/*
* Read Ack Register
* ACPI 6.1: 18.3.2.8 Generic Hardware Error Source
* version 2 (GHESv2 - Type 10)
*/
address_offset = table_data->len;
build_append_gas(table_data, AML_AS_SYSTEM_MEMORY, 0x40, 0,
4 /* QWord access */, 0);
bios_linker_loader_add_pointer(linker, ACPI_BUILD_TABLE_FILE,
address_offset + GAS_ADDR_OFFSET,
sizeof(uint64_t),
ACPI_HW_ERROR_FW_CFG_FILE,
(num_sources + index) * sizeof(uint64_t));
/*
* Read Ack Preserve field
* We only provide the first bit in Read Ack Register to OSPM to write
* while the other bits are preserved.
*/
build_append_int_noprefix(table_data, ~0x1ULL, 8);
/* Read Ack Write */
build_append_int_noprefix(table_data, 0x1, 8);
}
/* Build Hardware Error Source Table */
void acpi_build_hest(AcpiGhesState *ags, GArray *table_data,
GArray *hardware_errors,
BIOSLinker *linker,
const AcpiNotificationSourceId *notif_source,
int num_sources,
const char *oem_id, const char *oem_table_id)
{
AcpiTable table = { .sig = "HEST", .rev = 1,
.oem_id = oem_id, .oem_table_id = oem_table_id };
uint32_t hest_offset;
int i;
hest_offset = table_data->len;
build_ghes_error_table(ags, hardware_errors, linker, num_sources);
acpi_table_begin(&table, table_data);
/* Error Source Count */
build_append_int_noprefix(table_data, num_sources, 4);
for (i = 0; i < num_sources; i++) {
build_ghes_v2_entry(table_data, linker, &notif_source[i], i, num_sources);
}
acpi_table_end(linker, &table);
if (ags->use_hest_addr) {
/*
* Tell firmware to write into GPA the address of HEST via fw_cfg,
* once initialized.
*/
bios_linker_loader_write_pointer(linker,
ACPI_HEST_ADDR_FW_CFG_FILE, 0,
sizeof(uint64_t),
ACPI_BUILD_TABLE_FILE, hest_offset);
}
}
void acpi_ghes_add_fw_cfg(AcpiGhesState *ags, FWCfgState *s,
GArray *hardware_error)
{
/* Create a read-only fw_cfg file for GHES */
fw_cfg_add_file(s, ACPI_HW_ERROR_FW_CFG_FILE, hardware_error->data,
hardware_error->len);
if (ags->use_hest_addr) {
fw_cfg_add_file_callback(s, ACPI_HEST_ADDR_FW_CFG_FILE, NULL, NULL,
NULL, &(ags->hest_addr_le), sizeof(ags->hest_addr_le), false);
} else {
/* Create a read-write fw_cfg file for Address */
fw_cfg_add_file_callback(s, ACPI_HW_ERROR_ADDR_FW_CFG_FILE, NULL, NULL,
NULL, &(ags->hw_error_le), sizeof(ags->hw_error_le), false);
}
}
static void get_hw_error_offsets(uint64_t ghes_addr,
uint64_t *cper_addr,
uint64_t *read_ack_register_addr)
{
/*
* non-HEST version supports only one source, so no need to change
* the start offset based on the source ID. Also, we can't validate
* the source ID, as it is stored inside the HEST table.
*/
cpu_physical_memory_read(ghes_addr, cper_addr,
sizeof(*cper_addr));
*cper_addr = le64_to_cpu(*cper_addr);
/*
* As the current version supports only one source, the ack offset is
* just sizeof(uint64_t).
*/
*read_ack_register_addr = ghes_addr + sizeof(uint64_t);
}
static void get_ghes_source_offsets(uint16_t source_id,
uint64_t hest_addr,
uint64_t *cper_addr,
uint64_t *read_ack_start_addr,
Error **errp)
{
uint64_t hest_err_block_addr, hest_read_ack_addr;
uint64_t err_source_entry, error_block_addr;
uint32_t num_sources, i;
hest_addr += ACPI_DESC_HEADER_OFFSET;
cpu_physical_memory_read(hest_addr, &num_sources,
sizeof(num_sources));
num_sources = le32_to_cpu(num_sources);
err_source_entry = hest_addr + sizeof(num_sources);
/*
* Currently, HEST Error source navigates only for GHESv2 tables
*/
for (i = 0; i < num_sources; i++) {
uint64_t addr = err_source_entry;
uint16_t type, src_id;
cpu_physical_memory_read(addr, &type, sizeof(type));
type = le16_to_cpu(type);
/* For now, we only know the size of GHESv2 table */
if (type != ACPI_GHES_SOURCE_GENERIC_ERROR_V2) {
error_setg(errp, "HEST: type %d not supported.", type);
return;
}
/* Compare CPER source ID at the GHESv2 structure */
addr += sizeof(type);
cpu_physical_memory_read(addr, &src_id, sizeof(src_id));
if (le16_to_cpu(src_id) == source_id) {
break;
}
err_source_entry += HEST_GHES_V2_ENTRY_SIZE;
}
if (i == num_sources) {
error_setg(errp, "HEST: Source %d not found.", source_id);
return;
}
/* Navigate through table address pointers */
hest_err_block_addr = err_source_entry + GHES_ERR_STATUS_ADDR_OFF +
GAS_ADDR_OFFSET;
cpu_physical_memory_read(hest_err_block_addr, &error_block_addr,
sizeof(error_block_addr));
error_block_addr = le64_to_cpu(error_block_addr);
cpu_physical_memory_read(error_block_addr, cper_addr,
sizeof(*cper_addr));
*cper_addr = le64_to_cpu(*cper_addr);
hest_read_ack_addr = err_source_entry + GHES_READ_ACK_ADDR_OFF +
GAS_ADDR_OFFSET;
cpu_physical_memory_read(hest_read_ack_addr, read_ack_start_addr,
sizeof(*read_ack_start_addr));
*read_ack_start_addr = le64_to_cpu(*read_ack_start_addr);
}
NotifierList acpi_generic_error_notifiers =
NOTIFIER_LIST_INITIALIZER(acpi_generic_error_notifiers);
void ghes_record_cper_errors(AcpiGhesState *ags, const void *cper, size_t len,
uint16_t source_id, Error **errp)
{
uint64_t cper_addr = 0, read_ack_register_addr = 0, read_ack_register;
if (len > ACPI_GHES_MAX_RAW_DATA_LENGTH) {
error_setg(errp, "GHES CPER record is too big: %zd", len);
return;
}
if (!ags->use_hest_addr) {
get_hw_error_offsets(le64_to_cpu(ags->hw_error_le),
&cper_addr, &read_ack_register_addr);
} else {
get_ghes_source_offsets(source_id, le64_to_cpu(ags->hest_addr_le),
&cper_addr, &read_ack_register_addr, errp);
}
cpu_physical_memory_read(read_ack_register_addr,
&read_ack_register, sizeof(read_ack_register));
/* zero means OSPM does not acknowledge the error */
if (!read_ack_register) {
error_setg(errp,
"OSPM does not acknowledge previous error,"
" so can not record CPER for current error anymore");
return;
}
read_ack_register = cpu_to_le64(0);
/*
* Clear the Read Ack Register, OSPM will write 1 to this register when
* it acknowledges the error.
*/
cpu_physical_memory_write(read_ack_register_addr,
&read_ack_register, sizeof(uint64_t));
/* Write the generic error data entry into guest memory */
cpu_physical_memory_write(cper_addr, cper, len);
notifier_list_notify(&acpi_generic_error_notifiers, &source_id);
}
int acpi_ghes_memory_errors(AcpiGhesState *ags, uint16_t source_id,
uint64_t physical_address)
{
/* Memory Error Section Type */
const uint8_t guid[] =
UUID_LE(0xA5BC1114, 0x6F64, 0x4EDE, 0xB8, 0x63, 0x3E, 0x83, \
0xED, 0x7C, 0x83, 0xB1);
Error *errp = NULL;
int data_length;
GArray *block;
block = g_array_new(false, true /* clear */, 1);
data_length = ACPI_GHES_DATA_LENGTH + ACPI_GHES_MEM_CPER_LENGTH;
/*
* It should not run out of the preallocated memory if adding a new generic
* error data entry
*/
assert((data_length + ACPI_GHES_GESB_SIZE) <=
ACPI_GHES_MAX_RAW_DATA_LENGTH);
ghes_gen_err_data_uncorrectable_recoverable(block, guid, data_length);
/* Build the memory section CPER for above new generic error data entry */
acpi_ghes_build_append_mem_cper(block, physical_address);
/* Report the error */
ghes_record_cper_errors(ags, block->data, block->len, source_id, &errp);
g_array_free(block, true);
if (errp) {
error_report_err(errp);
return -1;
}
return 0;
}
AcpiGhesState *acpi_ghes_get_state(void)
{
AcpiGedState *acpi_ged_state;
AcpiGhesState *ags;
acpi_ged_state = ACPI_GED(object_resolve_path_type("", TYPE_ACPI_GED,
NULL));
if (!acpi_ged_state) {
return NULL;
}
ags = &acpi_ged_state->ghes_state;
if (!ags->hw_error_le && !ags->hest_addr_le) {
return NULL;
}
return ags;
}
Reference in a new issue View git blame Copy permalink