* [PATCH 0/1] acpi: Implement ACPI ERST support for guests
@ 2020-10-26 20:19 Eric DeVolder
2020-10-26 20:19 ` [PATCH 1/1] " Eric DeVolder
` (3 more replies)
0 siblings, 4 replies; 7+ messages in thread
From: Eric DeVolder @ 2020-10-26 20:19 UTC (permalink / raw)
To: qemu-devel
Cc: ehabkost, mst, konrad.wilk, pbonzini, imammedo, boris.ostrovsky, rth
This changeset introduces support for the ACPI Error Record
Serialization Table, ERST.
The change to hw/acpi/meson.build simply adds in the new .c file
for compilation.
The change to hw/i386/acpi-build.c calls out the building of the
ERST table (and also creates the associated device).
The new file hw/acpi/erst.c contains the building of the ERST
table, as well as the simple device for exchanging error records.
The new file include/hw/acpi/erst.h contains associated definitions
and declarations for ERST.
The primary description of this changeset is in the patch commit
message.
NOTES: When reviewing, I would especially appreciate feedback
on the following topics:
- The hope is to have ERST always present if ACPI is enabled, however,
I have found it difficult to devise a method for passing the base
address that does not require the workaround at the bottom of
build_erst(). The issues I encountered are:
- desire to keep this is common ACPI code
- the device requires a qdev_new(), this needs to happen early,
thus the workaround in build_erst()
- the base address is machine/arch specific (eg ARM vs x86)
I've not found a nice way to thread this needle, so what I've settled
on is to simply lump ERST on to the CONFIG_ACPI (rather than a
separate CONFIG_ACPI_ERST), and the workaround at the bottom of
build_erst(). I suspect there is a better way for a built-in/
always present device. This does not support "-device acpi-erst,...".
- I found a base address that "worked", but would like an address
that would be known to be availabe, and then to document/reserve
it for ERST. This takes into account that the base address can be
different for x86 vs ARM.
- I've run this through checkpatch, and all issues addressed except
for the long lines in build_erst(). For readable I left the long
lines, but will change if asked.
- What else do I need to provide?
Signed-off-by: Eric DeVolder <eric.devolder@oracle.com>
---
hw/acpi/erst.c | 909 +++++++++++++++++++++++++++++++++++++++++++++++++
hw/acpi/meson.build | 1 +
hw/i386/acpi-build.c | 4 +
include/hw/acpi/erst.h | 97 ++++++
4 files changed, 1011 insertions(+)
create mode 100644 hw/acpi/erst.c
create mode 100644 include/hw/acpi/erst.h
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH 1/1] acpi: Implement ACPI ERST support for guests
2020-10-26 20:19 [PATCH 0/1] acpi: Implement ACPI ERST support for guests Eric DeVolder
@ 2020-10-26 20:19 ` Eric DeVolder
2020-11-03 21:16 ` Paolo Bonzini
2021-02-08 21:08 ` Eric Devolder
2020-10-26 20:54 ` [PATCH 0/1] " no-reply
` (2 subsequent siblings)
3 siblings, 2 replies; 7+ messages in thread
From: Eric DeVolder @ 2020-10-26 20:19 UTC (permalink / raw)
To: qemu-devel
Cc: ehabkost, mst, konrad.wilk, pbonzini, imammedo, boris.ostrovsky, rth
This changeset introduces support for the ACPI Error Record
Serialization Table, ERST.
ERST is defined in [1], and the error records are defined
according to [2].
This changeset generates the ACPI ERST table, which OSPM
follows to program the associated ERST device. The ERST
device occupies 8KiB of address space, with the first 8 bytes
containing registers, and the remainder being an exchange
buffer for reading/writing error records.
The ERST device contains two registers, ACTION and VALUE
registers, following closely the ERST operations.
The ERST device only examines the record for the signature 'CPER',
its record identifier, and bounds-checks the length against the size
of the the CPER record header; otherwise all other record fields
and payload are ignored.
There are two options for this device:
-global acpi-erst.size=X
-global acpi-erst.filename=Y
The size X, if not specified, defaults to 64KiB, and must be within
64KiB and 1MiB.
The filename Y, if not specified, defaults to "acpi-erst.backing".
The ERST backing storage is not mapped into the guest address space,
just the 8KiB programming area is mapped into the guest.
This has been utilized as a backend for the Linux pstore feature.
[1] ACPI 6.3 Specification, 18.3 Error Serialization
https://uefi.org/sites/default/files/resources/ACPI_6_3_final_Jan30.pdf
[2] UEFI 2.8 Specification, Appendix N Common Platform Error Record
https://uefi.org/sites/default/files/resources/UEFI_Spec_2_8_final.pdf
Signed-off-by: Eric DeVolder <eric.devolder@oracle.com>
---
hw/acpi/erst.c | 909 +++++++++++++++++++++++++++++++++++++++++++++++++
hw/acpi/meson.build | 1 +
hw/i386/acpi-build.c | 4 +
include/hw/acpi/erst.h | 97 ++++++
4 files changed, 1011 insertions(+)
create mode 100644 hw/acpi/erst.c
create mode 100644 include/hw/acpi/erst.h
diff --git a/hw/acpi/erst.c b/hw/acpi/erst.c
new file mode 100644
index 0000000..407dc97
--- /dev/null
+++ b/hw/acpi/erst.c
@@ -0,0 +1,909 @@
+/*
+ * ACPI Error Record Serialization Table, ERST, Implementation
+ *
+ * Copyright (c) 2020 Oracle and/or its affiliates.
+ *
+ * See ACPI specification,
+ * "ACPI Platform Error Interfaces" : "Error Serialization"
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>
+ */
+
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+
+#include "qemu/osdep.h"
+#include "qapi/error.h"
+#include "hw/sysbus.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 "hw/acpi/erst.h"
+
+#ifdef _ERST_DEBUG
+#define erst_debug(fmt, ...) \
+ do { fprintf(stderr, fmt, ## __VA_ARGS__); fflush(stderr); } while (0)
+#else
+#define erst_debug(fmt, ...) do { } while (0)
+#endif
+
+/* See UEFI spec, Appendix N Common Platform Error Record */
+/* UEFI CPER allows for an OSPM book keeping area in the record */
+#define UEFI_CPER_RECORD_MIN_SIZE 128U
+#define UEFI_CPER_SIZE_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]))
+
+#define ERST_INVALID_RECORD_ID (~0UL)
+#define ERST_EXECUTE_OPERATION_MAGIC 0x9CUL
+#define ERST_CSR_ACTION (0UL << 3) /* action (cmd) */
+#define ERST_CSR_VALUE (1UL << 3) /* argument/value (data) */
+
+/*
+ * As ERST_IOMEM_SIZE is used to map the ERST into the guest,
+ * it should/must be an integer multiple of PAGE_SIZE.
+ * NOTE that any change to this value will make any pre-
+ * existing backing files, not of the same ERST_IOMEM_SIZE,
+ * unusable to the guest.
+ */
+#define ERST_IOMEM_SIZE (2UL * 4096)
+
+/*
+ * This implementation is an ACTION (cmd) and VALUE (data)
+ * interface consisting of just two 64-bit registers.
+ */
+#define ERST_REG_LEN (2UL * sizeof(uint64_t))
+
+/*
+ * The space not utilized by the register interface is the
+ * buffer for exchanging ERST record contents.
+ */
+#define ERST_RECORD_SIZE (ERST_IOMEM_SIZE - ERST_REG_LEN)
+
+/*
+ * Mode to be used for backing file
+ */
+#define ERST_BACKING_FILE_MODE 0644 /* S_IRWXU|S_IRWXG */
+
+#define ACPIERST(obj) \
+ OBJECT_CHECK(ERSTDeviceState, (obj), TYPE_ACPI_ERST)
+#define ACPIERST_CLASS(oc) \
+ OBJECT_CLASS_CHECK(ERSTDeviceStateClass, (oc), TYPE_ACPI_ERST)
+#define ACPIERST_GET_CLASS(obj) \
+ OBJECT_GET_CLASS(ERSTDeviceStateClass, (obj), TYPE_ACPI_ERST)
+
+static hwaddr erst_base;
+
+typedef struct {
+ SysBusDevice parent_obj;
+
+ MemoryRegion iomem;
+ uint32_t prop_size;
+ char *prop_filename;
+ hwaddr base;
+
+ uint8_t operation;
+ uint8_t busy_status;
+ uint8_t command_status;
+ uint32_t record_offset;
+ uint32_t record_count;
+ uint64_t reg_action;
+ uint64_t reg_value;
+ uint64_t record_identifier;
+
+ unsigned next_record_index;
+ uint8_t record[ERST_RECORD_SIZE]; /* read/written directly by guest */
+ uint8_t tmp_record[ERST_RECORD_SIZE]; /* intermediate manipulation buffer */
+ uint8_t *nvram; /* persistent storage, of length prop_size */
+
+} ERSTDeviceState;
+
+static void update_erst_backing_file(ERSTDeviceState *s,
+ off_t offset, const uint8_t *data, size_t length)
+{
+ int fd;
+
+ /* Bounds check */
+ if ((offset + length) > s->prop_size) {
+ error_report("update: off 0x%lx len 0x%lx > size 0x%lx out of range",
+ (long)offset, (long)length, (long)s->prop_size);
+ return;
+ }
+
+ fd = open(s->prop_filename, O_WRONLY | O_CREAT, ERST_BACKING_FILE_MODE);
+ if (fd > 0) {
+ off_t src;
+ size_t wrc = 0;
+ src = lseek(fd, offset, SEEK_SET);
+ if (offset == src) {
+ wrc = write(fd, data, length);
+ }
+ if ((offset != src) || (length != wrc)) {
+ error_report("ERST write failed: %d %d", (int)wrc, (int)length);
+ }
+ close(fd);
+ } else {
+ error_report("open failed: %s : %d", s->prop_filename, fd);
+ }
+}
+
+static unsigned copy_from_nvram_by_index(ERSTDeviceState *s, unsigned index)
+{
+ /* Read a nvram[] entry into tmp_record */
+ unsigned rc = ACPI_ERST_STATUS_FAILED;
+ off_t offset = (index * ERST_RECORD_SIZE);
+
+ if ((offset + ERST_RECORD_SIZE) <= s->prop_size) {
+ memcpy(s->tmp_record, &s->nvram[offset], ERST_RECORD_SIZE);
+ rc = ACPI_ERST_STATUS_SUCCESS;
+ }
+ return rc;
+}
+
+static unsigned copy_to_nvram_by_index(ERSTDeviceState *s, unsigned index)
+{
+ /* Write entry in tmp_record into nvram[], and backing file */
+ unsigned rc = ACPI_ERST_STATUS_FAILED;
+ off_t offset = (index * ERST_RECORD_SIZE);
+
+ if ((offset + ERST_RECORD_SIZE) <= s->prop_size) {
+ memcpy(&s->nvram[offset], s->tmp_record, ERST_RECORD_SIZE);
+ update_erst_backing_file(s, offset, s->tmp_record, ERST_RECORD_SIZE);
+ rc = ACPI_ERST_STATUS_SUCCESS;
+ }
+ return rc;
+}
+
+static int lookup_erst_record_by_identifier(ERSTDeviceState *s,
+ uint64_t record_identifier, bool *record_found, bool alloc_for_write)
+{
+ int rc = -1;
+ int empty_index = -1;
+ int index = 0;
+ unsigned rrc;
+
+ *record_found = 0;
+
+ do {
+ rrc = copy_from_nvram_by_index(s, (unsigned)index);
+ if (rrc == ACPI_ERST_STATUS_SUCCESS) {
+ uint64_t this_identifier;
+ this_identifier = THE_UEFI_CPER_RECORD_ID(s->tmp_record);
+ if (IS_UEFI_CPER_RECORD(s->tmp_record) &&
+ (this_identifier == record_identifier)) {
+ rc = index;
+ *record_found = 1;
+ break;
+ }
+ if ((this_identifier == ERST_INVALID_RECORD_ID) &&
+ (empty_index < 0)) {
+ empty_index = index; /* first available for write */
+ }
+ }
+ ++index;
+ } while (rrc == ACPI_ERST_STATUS_SUCCESS);
+
+ /* Record not found, allocate for writing */
+ if ((rc < 0) && alloc_for_write) {
+ rc = empty_index;
+ }
+
+ return rc;
+}
+
+static unsigned clear_erst_record(ERSTDeviceState *s)
+{
+ unsigned rc = ACPI_ERST_STATUS_RECORD_NOT_FOUND;
+ bool record_found;
+ int index;
+
+ index = lookup_erst_record_by_identifier(s,
+ s->record_identifier, &record_found, 0);
+ if (record_found) {
+ memset(s->tmp_record, 0xFF, ERST_RECORD_SIZE);
+ rc = copy_to_nvram_by_index(s, (unsigned)index);
+ if (rc == ACPI_ERST_STATUS_SUCCESS) {
+ s->record_count -= 1;
+ }
+ }
+
+ return rc;
+}
+
+static unsigned write_erst_record(ERSTDeviceState *s)
+{
+ unsigned rc = ACPI_ERST_STATUS_FAILED;
+
+ if (s->record_offset < (ERST_RECORD_SIZE - UEFI_CPER_RECORD_MIN_SIZE)) {
+ uint64_t record_identifier;
+ uint8_t *record = &s->record[s->record_offset];
+ bool record_found;
+ int index;
+
+ record_identifier = (s->record_identifier == ERST_INVALID_RECORD_ID)
+ ? THE_UEFI_CPER_RECORD_ID(record) : s->record_identifier;
+
+ index = lookup_erst_record_by_identifier(s,
+ record_identifier, &record_found, 1);
+ if (index < 0) {
+ rc = ACPI_ERST_STATUS_NOT_ENOUGH_SPACE;
+ } else {
+ if (0 != s->record_offset) {
+ memset(&s->tmp_record[ERST_RECORD_SIZE - s->record_offset],
+ 0xFF, s->record_offset);
+ }
+ memcpy(s->tmp_record, record, ERST_RECORD_SIZE - s->record_offset);
+ rc = copy_to_nvram_by_index(s, (unsigned)index);
+ if (rc == ACPI_ERST_STATUS_SUCCESS) {
+ if (!record_found) { /* not overwriting existing record */
+ s->record_count += 1; /* writing new record */
+ }
+ }
+ }
+ }
+
+ return rc;
+}
+
+static unsigned next_erst_record(ERSTDeviceState *s,
+ uint64_t *record_identifier)
+{
+ unsigned rc = ACPI_ERST_STATUS_RECORD_NOT_FOUND;
+ unsigned index;
+ unsigned rrc;
+
+ *record_identifier = ERST_INVALID_RECORD_ID;
+
+ index = s->next_record_index;
+ do {
+ rrc = copy_from_nvram_by_index(s, (unsigned)index);
+ if (rrc == ACPI_ERST_STATUS_SUCCESS) {
+ if (IS_UEFI_CPER_RECORD(s->tmp_record)) {
+ s->next_record_index = index + 1; /* where to start next time */
+ *record_identifier = THE_UEFI_CPER_RECORD_ID(s->tmp_record);
+ rc = ACPI_ERST_STATUS_SUCCESS;
+ break;
+ }
+ ++index;
+ } else {
+ if (s->next_record_index == 0) {
+ rc = ACPI_ERST_STATUS_RECORD_STORE_EMPTY;
+ }
+ s->next_record_index = 0; /* at end, reset */
+ }
+ } while (rrc == ACPI_ERST_STATUS_SUCCESS);
+
+ return rc;
+}
+
+static unsigned read_erst_record(ERSTDeviceState *s)
+{
+ unsigned rc = ACPI_ERST_STATUS_RECORD_NOT_FOUND;
+ bool record_found;
+ int index;
+
+ index = lookup_erst_record_by_identifier(s,
+ s->record_identifier, &record_found, 0);
+ if (record_found) {
+ rc = copy_from_nvram_by_index(s, (unsigned)index);
+ if (rc == ACPI_ERST_STATUS_SUCCESS) {
+ if (s->record_offset < ERST_RECORD_SIZE) {
+ memcpy(&s->record[s->record_offset], s->tmp_record,
+ ERST_RECORD_SIZE - s->record_offset);
+ }
+ }
+ }
+
+ return rc;
+}
+
+static unsigned get_erst_record_count(ERSTDeviceState *s)
+{
+ /* Compute record_count */
+ off_t offset;
+
+ s->record_count = 0;
+ offset = 0;
+ do {
+ uint8_t *ptr = &s->nvram[offset];
+ uint64_t record_identifier = THE_UEFI_CPER_RECORD_ID(ptr);
+ if (IS_UEFI_CPER_RECORD(ptr) &&
+ (ERST_INVALID_RECORD_ID != record_identifier)) {
+ s->record_count += 1;
+ }
+ offset += ERST_RECORD_SIZE;
+ } while (offset < (off_t)s->prop_size);
+
+ return s->record_count;
+}
+
+static void load_erst_backing_file(ERSTDeviceState *s)
+{
+ int fd;
+ struct stat statbuf;
+
+ erst_debug("+load_erst_backing_file()\n");
+
+ /* Allocate and initialize nvram[] */
+ s->nvram = g_malloc(s->prop_size);
+ memset(s->nvram, 0xFF, s->prop_size);
+
+ /* Ensure backing file at least same as prop_size */
+ if (stat(s->prop_filename, &statbuf) == 0) {
+ /* ensure prop_size at least matches file size */
+ if (statbuf.st_size < s->prop_size) {
+ /* Ensure records are ERST_INVALID_RECORD_ID */
+ memset(s->nvram, 0xFF, s->prop_size - statbuf.st_size);
+ update_erst_backing_file(s,
+ statbuf.st_size, s->nvram, s->prop_size - statbuf.st_size);
+ }
+ }
+
+ /* Pre-load nvram[] from backing file, if present */
+ fd = open(s->prop_filename, O_RDONLY, ERST_BACKING_FILE_MODE);
+ if (fd > 0) {
+ size_t rrc = read(fd, s->nvram, s->prop_size);
+ (void)rrc;
+ close(fd);
+ /*
+ * If existing file is smaller than prop_size, it will be resized
+ * accordingly upon subsequent record writes. If the file
+ * is larger than prop_size, only prop_size bytes are utilized,
+ * the extra bytes are untouched (though will be lost after
+ * a migration when the backing file is re-written as length
+ * of prop_size bytes).
+ */
+ } else {
+ /* Create empty backing file */
+ update_erst_backing_file(s, 0, s->nvram, s->prop_size);
+ }
+
+ /* Initialize record_count */
+ get_erst_record_count(s);
+
+ erst_debug("-load_erst_backing_file() %d\n", s->record_count);
+}
+
+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_write(void *opaque, hwaddr addr,
+ uint64_t val, unsigned size)
+{
+ ERSTDeviceState *s = (ERSTDeviceState *)opaque;
+
+ if (addr < ERST_REG_LEN) {
+ /*
+ * NOTE: All actions/operations/side effects happen on the WRITE,
+ * by design. The READs simply return the reg_value contents.
+ */
+ erst_debug("ERST write %016lx %10s val %016lx sz %u",
+ addr, erst_reg(addr), val, size);
+ /* The REGISTER region */
+ switch (addr) {
+ case ERST_CSR_VALUE + 0:
+ case ERST_CSR_VALUE + 4:
+ s->reg_value = erst_wr_reg64(addr, s->reg_value, val, size);
+ break;
+ case ERST_CSR_ACTION + 0:
+/* case ERST_CSR_ACTION+4: as coded, not really a 64b register */
+ switch (val) {
+ case ACPI_ERST_ACTION_BEGIN_WRITE_OPERATION:
+ case ACPI_ERST_ACTION_BEGIN_READ_OPERATION:
+ case ACPI_ERST_ACTION_BEGIN_CLEAR_OPERATION:
+ case ACPI_ERST_ACTION_BEGIN_DUMMY_WRITE_OPERATION:
+ case ACPI_ERST_ACTION_END_OPERATION:
+ s->operation = val;
+ break;
+ case ACPI_ERST_ACTION_SET_RECORD_OFFSET:
+ s->record_offset = s->reg_value;
+ break;
+ case ACPI_ERST_ACTION_EXECUTE_OPERATION:
+ if ((uint8_t)s->reg_value == ERST_EXECUTE_OPERATION_MAGIC) {
+ s->busy_status = 1;
+ switch (s->operation) {
+ case ACPI_ERST_ACTION_BEGIN_WRITE_OPERATION:
+ s->command_status = write_erst_record(s);
+ break;
+ case ACPI_ERST_ACTION_BEGIN_READ_OPERATION:
+ s->command_status = read_erst_record(s);
+ break;
+ case ACPI_ERST_ACTION_BEGIN_CLEAR_OPERATION:
+ s->command_status = clear_erst_record(s);
+ break;
+ case ACPI_ERST_ACTION_BEGIN_DUMMY_WRITE_OPERATION:
+ s->command_status = ACPI_ERST_STATUS_SUCCESS;
+ break;
+ case ACPI_ERST_ACTION_END_OPERATION:
+ s->command_status = ACPI_ERST_STATUS_SUCCESS;
+ break;
+ default:
+ s->command_status = ACPI_ERST_STATUS_FAILED;
+ break;
+ }
+ s->record_identifier = ERST_INVALID_RECORD_ID;
+ s->busy_status = 0;
+ }
+ break;
+ case ACPI_ERST_ACTION_CHECK_BUSY_STATUS:
+ s->reg_value = s->busy_status;
+ break;
+ case ACPI_ERST_ACTION_GET_COMMAND_STATUS:
+ s->reg_value = s->command_status;
+ break;
+ case ACPI_ERST_ACTION_GET_RECORD_IDENTIFIER:
+ s->command_status = next_erst_record(s, &s->reg_value);
+ break;
+ case ACPI_ERST_ACTION_SET_RECORD_IDENTIFIER:
+ s->record_identifier = s->reg_value;
+ break;
+ case ACPI_ERST_ACTION_GET_RECORD_COUNT:
+ s->reg_value = s->record_count;
+ break;
+ case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE:
+ s->reg_value = s->base + ERST_REG_LEN;
+ break;
+ case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_LENGTH:
+ s->reg_value = ERST_RECORD_SIZE;
+ break;
+ case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES:
+ s->reg_value = 0; /* correct/intended value */
+ break;
+ case ACPI_ERST_ACTION_GET_EXECUTE_OPERATION_TIMINGS:
+ /*
+ * 100UL is max, 10UL is nominal
+ */
+ s->reg_value = ((100UL << 32) | (10UL << 0));
+ break;
+ case ACPI_ERST_ACTION_RESERVED:
+ default:
+ /*
+ * NOP
+ */
+ break;
+ }
+ break;
+ default:
+ /*
+ * All other register writes are NO-OPs
+ */
+ break;
+ }
+ } else {
+ /* The RECORD region */
+ unsigned offset = addr - ERST_REG_LEN;
+ uint8_t *ptr = &s->record[offset];
+ switch (size) {
+ default:
+ case sizeof(uint8_t):
+ *(uint8_t *)ptr = (uint8_t)val;
+ break;
+ case sizeof(uint16_t):
+ *(uint16_t *)ptr = (uint16_t)val;
+ break;
+ case sizeof(uint32_t):
+ *(uint32_t *)ptr = (uint32_t)val;
+ break;
+ case sizeof(uint64_t):
+ *(uint64_t *)ptr = (uint64_t)val;
+ break;
+ }
+ }
+}
+
+static uint64_t erst_read(void *opaque, hwaddr addr,
+ unsigned size)
+{
+ ERSTDeviceState *s = (ERSTDeviceState *)opaque;
+ uint64_t val = 0;
+
+ if (addr < ERST_REG_LEN) {
+ switch (addr) {
+ case ERST_CSR_ACTION + 0:
+ case ERST_CSR_ACTION + 4:
+ val = erst_rd_reg64(addr, s->reg_action, size);
+ break;
+ case ERST_CSR_VALUE + 0:
+ case ERST_CSR_VALUE + 4:
+ val = erst_rd_reg64(addr, s->reg_value, size);
+ break;
+ default:
+ break;
+ }
+ erst_debug("ERST read %016lx %10s val %016lx sz %u\n",
+ addr, erst_reg(addr), val, size);
+ } else {
+ /*
+ * The RECORD region
+ */
+ uint8_t *ptr = &s->record[addr - ERST_REG_LEN];
+ switch (size) {
+ default:
+ case sizeof(uint8_t):
+ val = *(uint8_t *)ptr;
+ break;
+ case sizeof(uint16_t):
+ val = *(uint16_t *)ptr;
+ break;
+ case sizeof(uint32_t):
+ val = *(uint32_t *)ptr;
+ break;
+ case sizeof(uint64_t):
+ val = *(uint64_t *)ptr;
+ break;
+ }
+ }
+ erst_debug("ERST read %016lx %10s val %016lx sz %u\n",
+ addr, erst_reg(addr), val, size);
+ return val;
+}
+
+static size_t build_erst_action(GArray *table_data,
+ uint8_t serialization_action,
+ uint8_t instruction,
+ uint8_t flags,
+ uint8_t width,
+ uint64_t address,
+ uint64_t value,
+ uint64_t mask)
+{
+ Acpi20ErstSerializationAction *action;
+
+ action = acpi_data_push(table_data, sizeof(*action));
+ action->serialization_action = serialization_action;
+ action->instruction = instruction;
+ action->flags = flags;
+ action->reserved = 0;
+ action->addr.space_id = AML_SYSTEM_MEMORY;
+ action->addr.bit_width = width;
+ action->addr.bit_offset = 0;
+ switch (width) {
+ case 8:
+ action->addr.access_width = 1;
+ break;
+ case 16:
+ action->addr.access_width = 2;
+ break;
+ case 32:
+ action->addr.access_width = 3;
+ break;
+ case 64:
+ action->addr.access_width = 4;
+ break;
+ default:
+ action->addr.access_width = 0;
+ break;
+ }
+ action->addr.address = cpu_to_le64(address);
+ action->value = cpu_to_le64(value);
+ action->mask = cpu_to_le64(mask);
+
+ return 1;
+}
+
+static const MemoryRegionOps erst_rw_ops = {
+ .read = erst_read,
+ .write = erst_write,
+ .endianness = DEVICE_NATIVE_ENDIAN,
+};
+
+void build_erst(GArray *table_data, BIOSLinker *linker, hwaddr base)
+{
+ Acpi20Erst *erst;
+ unsigned action, insns = 0;
+ unsigned erst_len = 0;
+
+ erst = acpi_data_push(table_data, sizeof(*erst));
+ erst->serialization_header_length = cpu_to_le32(sizeof(*erst));
+ erst->reserved = cpu_to_le32(0);
+ erst_len += sizeof(*erst);
+
+#define BEA(I, F, W, ADDR, VAL, MASK) \
+ build_erst_action(table_data, action, \
+ ACPI_ERST_INST_##I, F, W, base + ADDR, VAL, MASK)
+#define MASK8 0x00000000000000FFUL
+#define MASK16 0x000000000000FFFFUL
+#define MASK32 0x00000000FFFFFFFFUL
+#define MASK64 0xFFFFFFFFFFFFFFFFUL
+
+ for (action = 0; action < ACPI_ERST_MAX_ACTIONS; ++action) {
+ switch (action) {
+ case ACPI_ERST_ACTION_BEGIN_WRITE_OPERATION:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ break;
+ case ACPI_ERST_ACTION_BEGIN_READ_OPERATION:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ break;
+ case ACPI_ERST_ACTION_BEGIN_CLEAR_OPERATION:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ break;
+ case ACPI_ERST_ACTION_END_OPERATION:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ break;
+ case ACPI_ERST_ACTION_SET_RECORD_OFFSET:
+ insns += BEA(WRITE_REGISTER , 0, 32, ERST_CSR_VALUE , 0, MASK32);
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ break;
+ case ACPI_ERST_ACTION_EXECUTE_OPERATION:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_VALUE , ERST_EXECUTE_OPERATION_MAGIC, MASK8);
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ break;
+ case ACPI_ERST_ACTION_CHECK_BUSY_STATUS:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ insns += BEA(READ_REGISTER_VALUE , 0, 32, ERST_CSR_VALUE, 0x01, MASK8);
+ break;
+ case ACPI_ERST_ACTION_GET_COMMAND_STATUS:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ insns += BEA(READ_REGISTER , 0, 32, ERST_CSR_VALUE, 0, MASK8);
+ break;
+ case ACPI_ERST_ACTION_GET_RECORD_IDENTIFIER:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ insns += BEA(READ_REGISTER , 0, 64, ERST_CSR_VALUE, 0, MASK64);
+ break;
+ case ACPI_ERST_ACTION_SET_RECORD_IDENTIFIER:
+ insns += BEA(WRITE_REGISTER , 0, 64, ERST_CSR_VALUE , 0, MASK64);
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ break;
+ case ACPI_ERST_ACTION_GET_RECORD_COUNT:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ insns += BEA(READ_REGISTER , 0, 32, ERST_CSR_VALUE, 0, MASK32);
+ break;
+ case ACPI_ERST_ACTION_BEGIN_DUMMY_WRITE_OPERATION:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ break;
+ case ACPI_ERST_ACTION_RESERVED:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ break;
+ case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ insns += BEA(READ_REGISTER , 0, 64, ERST_CSR_VALUE, 0, MASK64);
+ break;
+ case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_LENGTH:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ insns += BEA(READ_REGISTER , 0, 64, ERST_CSR_VALUE, 0, MASK32);
+ break;
+ case ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ insns += BEA(READ_REGISTER , 0, 32, ERST_CSR_VALUE, 0, MASK32);
+ break;
+ case ACPI_ERST_ACTION_GET_EXECUTE_OPERATION_TIMINGS:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
+ insns += BEA(READ_REGISTER , 0, 64, ERST_CSR_VALUE, 0, MASK64);
+ default:
+ insns += BEA(NOOP, 0, 0, 0, action, 0);
+ break;
+ }
+ }
+ erst->instruction_entry_count = cpu_to_le32(insns);
+ erst_len += (insns * sizeof(Acpi20ErstSerializationAction));
+
+ build_header(linker, table_data,
+ (void *)erst, "ERST", erst_len, 1, NULL, NULL);
+
+ if (erst_base == 0) {
+ /*
+ * This ACPI routine is invoked * twice, but this code
+ * snippet needs to happen just once.
+ * And this code in erst_class_init() is too early.
+ */
+ DeviceState *dev;
+ SysBusDevice *s;
+
+ dev = qdev_new(TYPE_ACPI_ERST);
+ erst_debug("qdev_create dev %p\n", dev);
+ s = SYS_BUS_DEVICE(dev);
+ sysbus_realize_and_unref(s, &error_fatal);
+
+ ACPIERST(dev)->base = base;
+ sysbus_mmio_map(s, 0, base);
+ erst_base = base;
+ erst_debug("erst_base %lx\n", base);
+ }
+}
+
+/*******************************************************************/
+/*******************************************************************/
+static int erst_post_load(void *opaque, int version_id)
+{
+ ERSTDeviceState *s = opaque;
+ erst_debug("+erst_post_load(%d)\n", version_id);
+ /* Ensure nvram[] persists into backing file */
+ update_erst_backing_file(s, 0, s->nvram, s->prop_size);
+ erst_debug("-erst_post_load()\n");
+ 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_UINT8(operation, ERSTDeviceState),
+ VMSTATE_UINT8(busy_status, ERSTDeviceState),
+ VMSTATE_UINT8(command_status, ERSTDeviceState),
+ VMSTATE_UINT32(record_offset, ERSTDeviceState),
+ VMSTATE_UINT32(record_count, ERSTDeviceState),
+ VMSTATE_UINT64(reg_action, ERSTDeviceState),
+ VMSTATE_UINT64(reg_value, ERSTDeviceState),
+ VMSTATE_UINT64(record_identifier, ERSTDeviceState),
+ VMSTATE_UINT8_ARRAY(record, ERSTDeviceState, ERST_RECORD_SIZE),
+ VMSTATE_UINT8_ARRAY(tmp_record, ERSTDeviceState, ERST_RECORD_SIZE),
+ VMSTATE_VARRAY_UINT32(nvram, ERSTDeviceState, prop_size, 0,
+ vmstate_info_uint8, uint8_t),
+ VMSTATE_END_OF_LIST()
+ }
+};
+
+static void erst_realizefn(DeviceState *dev, Error **errp)
+{
+ SysBusDevice *d = SYS_BUS_DEVICE(dev);
+ ERSTDeviceState *s = ACPIERST(dev);
+
+ erst_debug("+erst_realizefn()\n");
+ if (!s->prop_filename) {
+ s->prop_filename = (char *)(TYPE_ACPI_ERST ".backing");
+ }
+
+ if (!s->prop_filename) {
+ error_setg(errp, "'filename' property is not set");
+ return;
+ }
+
+ if (!(s->prop_size > ERST_RECORD_SIZE) &&
+ (s->prop_size <= 0x04000000)) {
+ error_setg(errp, "'size' property %d is not set properly",
+ s->prop_size);
+ return;
+ }
+
+ /* Convert prop_size to integer multiple of ERST_RECORD_SIZE */
+ s->prop_size -= (s->prop_size % ERST_RECORD_SIZE);
+
+ load_erst_backing_file(s);
+
+ erst_debug("filename %s\n", s->prop_filename);
+ erst_debug("size %x\n", s->prop_size);
+
+ memory_region_init_io(&s->iomem, OBJECT(s), &erst_rw_ops, s,
+ TYPE_ACPI_ERST, ERST_IOMEM_SIZE);
+ sysbus_init_mmio(d, &s->iomem);
+ erst_debug("-erst_realizefn()\n");
+}
+
+static void erst_unrealizefn(DeviceState *dev)
+{
+ ERSTDeviceState *s = ACPIERST(dev);
+
+ erst_debug("+erst_unrealizefn()\n");
+ if (s->nvram) {
+ /* Ensure nvram[] persists into backing file */
+ update_erst_backing_file(s, 0, s->nvram, s->prop_size);
+ g_free(s->nvram);
+ s->nvram = NULL;
+ }
+ erst_debug("-erst_unrealizefn()\n");
+}
+
+static void erst_reset(DeviceState *dev)
+{
+ ERSTDeviceState *s = ACPIERST(dev);
+
+ erst_debug("+erst_reset(%p) %d\n", s, s->record_count);
+ s->operation = 0;
+ s->busy_status = 0;
+ s->command_status = ACPI_ERST_STATUS_SUCCESS;
+ /* indicate empty/no-more until further notice */
+ s->record_identifier = ERST_INVALID_RECORD_ID;
+ s->record_offset = 0;
+ s->next_record_index = 0;
+ /* NOTE: record_count and nvram[] are initialized elsewhere */
+ erst_debug("-erst_reset()\n");
+}
+
+static Property erst_properties[] = {
+ DEFINE_PROP_UINT32("size", ERSTDeviceState, prop_size, 0x00010000),
+ DEFINE_PROP_STRING("filename", ERSTDeviceState, prop_filename),
+ DEFINE_PROP_END_OF_LIST(),
+};
+
+static void erst_class_init(ObjectClass *klass, void *data)
+{
+ DeviceClass *dc = DEVICE_CLASS(klass);
+
+ erst_debug("+erst_class_init()\n");
+ dc->realize = erst_realizefn;
+ dc->unrealize = erst_unrealizefn;
+ dc->reset = erst_reset;
+ dc->vmsd = &erst_vmstate;
+ device_class_set_props(dc, erst_properties);
+ dc->desc = "ACPI Error Record Serialization Table (ERST) device";
+ set_bit(DEVICE_CATEGORY_MISC, dc->categories);
+ erst_debug("-erst_class_init()\n");
+}
+
+static const TypeInfo erst_type_info = {
+ .name = TYPE_ACPI_ERST,
+ .parent = TYPE_SYS_BUS_DEVICE,
+ .class_init = erst_class_init,
+ .instance_size = sizeof(ERSTDeviceState),
+};
+
+static void erst_register_types(void)
+{
+ type_register_static(&erst_type_info);
+}
+
+type_init(erst_register_types)
diff --git a/hw/acpi/meson.build b/hw/acpi/meson.build
index dd69577..262a8ee 100644
--- a/hw/acpi/meson.build
+++ b/hw/acpi/meson.build
@@ -4,6 +4,7 @@ acpi_ss.add(files(
'aml-build.c',
'bios-linker-loader.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'))
diff --git a/hw/i386/acpi-build.c b/hw/i386/acpi-build.c
index e3a4bc2..2c6b867 100644
--- a/hw/i386/acpi-build.c
+++ b/hw/i386/acpi-build.c
@@ -43,6 +43,7 @@
#include "sysemu/tpm.h"
#include "hw/acpi/tpm.h"
#include "hw/acpi/vmgenid.h"
+#include "hw/acpi/erst.h"
#include "hw/boards.h"
#include "sysemu/tpm_backend.h"
#include "hw/rtc/mc146818rtc_regs.h"
@@ -2479,6 +2480,9 @@ void acpi_build(AcpiBuildTables *tables, MachineState *machine)
acpi_build_madt(tables_blob, tables->linker, x86ms,
ACPI_DEVICE_IF(x86ms->acpi_dev));
+ acpi_add_table(table_offsets, tables_blob);
+ build_erst(tables_blob, tables->linker, HPET_BASE + 0x10000UL);
+
vmgenid_dev = find_vmgenid_dev();
if (vmgenid_dev) {
acpi_add_table(table_offsets, tables_blob);
diff --git a/include/hw/acpi/erst.h b/include/hw/acpi/erst.h
new file mode 100644
index 0000000..7882239
--- /dev/null
+++ b/include/hw/acpi/erst.h
@@ -0,0 +1,97 @@
+/*
+ * ACPI Error Record Serialization Table, ERST, Implementation
+ *
+ * Copyright (c) 2020 Oracle and/or its affiliates.
+ *
+ * See ACPI specification, "ACPI Platform Error Interfaces" : "Error Serialization"
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>
+ */
+#ifndef HW_ACPI_ERST_H
+#define HW_ACPI_ERST_H
+
+/*
+ * ERST Description Table
+ */
+struct Acpi20Erst {
+ ACPI_TABLE_HEADER_DEF /* ACPI common table header */
+ uint32_t serialization_header_length;
+ uint32_t reserved;
+ uint32_t instruction_entry_count;
+} QEMU_PACKED;
+typedef struct Acpi20Erst Acpi20Erst;
+
+struct Acpi20ErstSerializationAction {
+ uint8_t serialization_action;
+ uint8_t instruction;
+ uint8_t flags;
+ uint8_t reserved;
+ struct AcpiGenericAddress addr;
+ uint64_t value;
+ uint64_t mask;
+} QEMU_PACKED;
+typedef struct Acpi20ErstSerializationAction Acpi20ErstSerializationAction;
+
+void build_erst(GArray *table_data, BIOSLinker *linker, hwaddr base);
+
+#define TYPE_ACPI_ERST "acpi-erst"
+
+#define ACPI_ERST_ACTION_BEGIN_WRITE_OPERATION 0x0
+#define ACPI_ERST_ACTION_BEGIN_READ_OPERATION 0x1
+#define ACPI_ERST_ACTION_BEGIN_CLEAR_OPERATION 0x2
+#define ACPI_ERST_ACTION_END_OPERATION 0x3
+#define ACPI_ERST_ACTION_SET_RECORD_OFFSET 0x4
+#define ACPI_ERST_ACTION_EXECUTE_OPERATION 0x5
+#define ACPI_ERST_ACTION_CHECK_BUSY_STATUS 0x6
+#define ACPI_ERST_ACTION_GET_COMMAND_STATUS 0x7
+#define ACPI_ERST_ACTION_GET_RECORD_IDENTIFIER 0x8
+#define ACPI_ERST_ACTION_SET_RECORD_IDENTIFIER 0x9
+#define ACPI_ERST_ACTION_GET_RECORD_COUNT 0xA
+#define ACPI_ERST_ACTION_BEGIN_DUMMY_WRITE_OPERATION 0xB
+#define ACPI_ERST_ACTION_RESERVED 0xC
+#define ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE 0xD
+#define ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_LENGTH 0xE
+#define ACPI_ERST_ACTION_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0xF
+#define ACPI_ERST_ACTION_GET_EXECUTE_OPERATION_TIMINGS 0x10
+#define ACPI_ERST_MAX_ACTIONS (ACPI_ERST_ACTION_GET_EXECUTE_OPERATION_TIMINGS + 1)
+
+#define ACPI_ERST_STATUS_SUCCESS 0x00
+#define ACPI_ERST_STATUS_NOT_ENOUGH_SPACE 0x01
+#define ACPI_ERST_STATUS_HARDWARE_NOT_AVAILABLE 0x02
+#define ACPI_ERST_STATUS_FAILED 0x03
+#define ACPI_ERST_STATUS_RECORD_STORE_EMPTY 0x04
+#define ACPI_ERST_STATUS_RECORD_NOT_FOUND 0x05
+
+#define ACPI_ERST_INST_READ_REGISTER 0x00
+#define ACPI_ERST_INST_READ_REGISTER_VALUE 0x01
+#define ACPI_ERST_INST_WRITE_REGISTER 0x02
+#define ACPI_ERST_INST_WRITE_REGISTER_VALUE 0x03
+#define ACPI_ERST_INST_NOOP 0x04
+#define ACPI_ERST_INST_LOAD_VAR1 0x05
+#define ACPI_ERST_INST_LOAD_VAR2 0x06
+#define ACPI_ERST_INST_STORE_VAR1 0x07
+#define ACPI_ERST_INST_ADD 0x08
+#define ACPI_ERST_INST_SUBTRACT 0x09
+#define ACPI_ERST_INST_ADD_VALUE 0x0A
+#define ACPI_ERST_INST_SUBTRACT_VALUE 0x0B
+#define ACPI_ERST_INST_STALL 0x0C
+#define ACPI_ERST_INST_STALL_WHILE_TRUE 0x0D
+#define ACPI_ERST_INST_SKIP_NEXT_INSTRUCTION_IF_TRUE 0x0E
+#define ACPI_ERST_INST_GOTO 0x0F
+#define ACPI_ERST_INST_SET_SRC_ADDRESS_BASE 0x10
+#define ACPI_ERST_INST_SET_DST_ADDRESS_BASE 0x11
+#define ACPI_ERST_INST_MOVE_DATA 0x12
+
+#endif
+
--
1.8.3.1
^ permalink raw reply related [flat|nested] 7+ messages in thread
* Re: [PATCH 0/1] acpi: Implement ACPI ERST support for guests
2020-10-26 20:19 [PATCH 0/1] acpi: Implement ACPI ERST support for guests Eric DeVolder
2020-10-26 20:19 ` [PATCH 1/1] " Eric DeVolder
@ 2020-10-26 20:54 ` no-reply
2020-11-03 14:57 ` Igor Mammedov
2021-02-08 21:07 ` Eric Devolder
3 siblings, 0 replies; 7+ messages in thread
From: no-reply @ 2020-10-26 20:54 UTC (permalink / raw)
To: eric.devolder
Cc: ehabkost, mst, konrad.wilk, qemu-devel, imammedo, pbonzini,
boris.ostrovsky, rth
Patchew URL: https://patchew.org/QEMU/1603743573-9870-1-git-send-email-eric.devolder@oracle.com/
Hi,
This series seems to have some coding style problems. See output below for
more information:
Type: series
Message-id: 1603743573-9870-1-git-send-email-eric.devolder@oracle.com
Subject: [PATCH 0/1] acpi: Implement ACPI ERST support for guests
=== TEST SCRIPT BEGIN ===
#!/bin/bash
git rev-parse base > /dev/null || exit 0
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===
Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
From https://github.com/patchew-project/qemu
* [new tag] patchew/1603743573-9870-1-git-send-email-eric.devolder@oracle.com -> patchew/1603743573-9870-1-git-send-email-eric.devolder@oracle.com
- [tag update] patchew/20201026105504.4023620-1-philmd@redhat.com -> patchew/20201026105504.4023620-1-philmd@redhat.com
Switched to a new branch 'test'
94c25ac acpi: Implement ACPI ERST support for guests
=== OUTPUT BEGIN ===
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#48:
new file mode 100644
WARNING: line over 80 characters
#736: FILE: hw/acpi/erst.c:684:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#739: FILE: hw/acpi/erst.c:687:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#742: FILE: hw/acpi/erst.c:690:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#745: FILE: hw/acpi/erst.c:693:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#748: FILE: hw/acpi/erst.c:696:
+ insns += BEA(WRITE_REGISTER , 0, 32, ERST_CSR_VALUE , 0, MASK32);
WARNING: line over 80 characters
#749: FILE: hw/acpi/erst.c:697:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
ERROR: line over 90 characters
#752: FILE: hw/acpi/erst.c:700:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_VALUE , ERST_EXECUTE_OPERATION_MAGIC, MASK8);
WARNING: line over 80 characters
#753: FILE: hw/acpi/erst.c:701:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#756: FILE: hw/acpi/erst.c:704:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#757: FILE: hw/acpi/erst.c:705:
+ insns += BEA(READ_REGISTER_VALUE , 0, 32, ERST_CSR_VALUE, 0x01, MASK8);
WARNING: line over 80 characters
#760: FILE: hw/acpi/erst.c:708:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#764: FILE: hw/acpi/erst.c:712:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#765: FILE: hw/acpi/erst.c:713:
+ insns += BEA(READ_REGISTER , 0, 64, ERST_CSR_VALUE, 0, MASK64);
WARNING: line over 80 characters
#768: FILE: hw/acpi/erst.c:716:
+ insns += BEA(WRITE_REGISTER , 0, 64, ERST_CSR_VALUE , 0, MASK64);
WARNING: line over 80 characters
#769: FILE: hw/acpi/erst.c:717:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#772: FILE: hw/acpi/erst.c:720:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#773: FILE: hw/acpi/erst.c:721:
+ insns += BEA(READ_REGISTER , 0, 32, ERST_CSR_VALUE, 0, MASK32);
WARNING: line over 80 characters
#776: FILE: hw/acpi/erst.c:724:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#779: FILE: hw/acpi/erst.c:727:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#782: FILE: hw/acpi/erst.c:730:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#783: FILE: hw/acpi/erst.c:731:
+ insns += BEA(READ_REGISTER , 0, 64, ERST_CSR_VALUE, 0, MASK64);
WARNING: line over 80 characters
#786: FILE: hw/acpi/erst.c:734:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#787: FILE: hw/acpi/erst.c:735:
+ insns += BEA(READ_REGISTER , 0, 64, ERST_CSR_VALUE, 0, MASK32);
WARNING: line over 80 characters
#790: FILE: hw/acpi/erst.c:738:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#791: FILE: hw/acpi/erst.c:739:
+ insns += BEA(READ_REGISTER , 0, 32, ERST_CSR_VALUE, 0, MASK32);
WARNING: line over 80 characters
#794: FILE: hw/acpi/erst.c:742:
+ insns += BEA(WRITE_REGISTER_VALUE, 0, 32, ERST_CSR_ACTION, action, MASK8);
WARNING: line over 80 characters
#795: FILE: hw/acpi/erst.c:743:
+ insns += BEA(READ_REGISTER , 0, 64, ERST_CSR_VALUE, 0, MASK64);
WARNING: line over 80 characters
#1007: FILE: include/hw/acpi/erst.h:6:
+ * See ACPI specification, "ACPI Platform Error Interfaces" : "Error Serialization"
WARNING: line over 80 characters
#1068: FILE: include/hw/acpi/erst.h:67:
+#define ACPI_ERST_MAX_ACTIONS (ACPI_ERST_ACTION_GET_EXECUTE_OPERATION_TIMINGS + 1)
total: 1 errors, 29 warnings, 1029 lines checked
Commit 94c25acdc0f1 (acpi: Implement ACPI ERST support for guests) has style problems, please review. If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
=== OUTPUT END ===
Test command exited with code: 1
The full log is available at
http://patchew.org/logs/1603743573-9870-1-git-send-email-eric.devolder@oracle.com/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [https://patchew.org/].
Please send your feedback to patchew-devel@redhat.com
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH 0/1] acpi: Implement ACPI ERST support for guests
2020-10-26 20:19 [PATCH 0/1] acpi: Implement ACPI ERST support for guests Eric DeVolder
2020-10-26 20:19 ` [PATCH 1/1] " Eric DeVolder
2020-10-26 20:54 ` [PATCH 0/1] " no-reply
@ 2020-11-03 14:57 ` Igor Mammedov
2021-02-08 21:07 ` Eric Devolder
3 siblings, 0 replies; 7+ messages in thread
From: Igor Mammedov @ 2020-11-03 14:57 UTC (permalink / raw)
To: Eric DeVolder
Cc: ehabkost, mst, konrad.wilk, qemu-devel, pbonzini,
boris.ostrovsky, lersek, rth
On Mon, 26 Oct 2020 16:19:32 -0400
Eric DeVolder <eric.devolder@oracle.com> wrote:
> This changeset introduces support for the ACPI Error Record
> Serialization Table, ERST.
>
> The change to hw/acpi/meson.build simply adds in the new .c file
> for compilation.
>
> The change to hw/i386/acpi-build.c calls out the building of the
> ERST table (and also creates the associated device).
>
> The new file hw/acpi/erst.c contains the building of the ERST
> table, as well as the simple device for exchanging error records.
>
> The new file include/hw/acpi/erst.h contains associated definitions
> and declarations for ERST.
>
> The primary description of this changeset is in the patch commit
> message.
>
> NOTES: When reviewing, I would especially appreciate feedback
> on the following topics:
>
> - The hope is to have ERST always present if ACPI is enabled, however,
> I have found it difficult to devise a method for passing the base
> address that does not require the workaround at the bottom of
> build_erst(). The issues I encountered are:
> - desire to keep this is common ACPI code
> - the device requires a qdev_new(), this needs to happen early,
> thus the workaround in build_erst()
> - the base address is machine/arch specific (eg ARM vs x86)
> I've not found a nice way to thread this needle, so what I've settled
> on is to simply lump ERST on to the CONFIG_ACPI (rather than a
> separate CONFIG_ACPI_ERST), and the workaround at the bottom of
> build_erst(). I suspect there is a better way for a built-in/
> always present device. This does not support "-device acpi-erst,...".
>
> - I found a base address that "worked", but would like an address
> that would be known to be availabe, and then to document/reserve
> it for ERST. This takes into account that the base address can be
> different for x86 vs ARM.
>
> - I've run this through checkpatch, and all issues addressed except
> for the long lines in build_erst(). For readable I left the long
> lines, but will change if asked.
>
> - What else do I need to provide?
For now, I have just several generic comments:
1. that's quite a lot code to maintain, why not use existing UEFI vars
as pstore storage instead?
Not sure ancient ACPI table is a way to go, with NVDIMMs around
it probably possible to use pstores ram backend or make it work
with nvdimms directly. The only benefit of ERST is that it should
just work without extra configuration, but then UEFI backend
would probably also just work.
2. patch is too big to review, please split it up in smaller chunks.
3. Use of packed structures is discouraged in new ACPI code,
see build_ghes_v2() as an example for building ACPI tables.
4. Maybe instead of SYSBUS device, implement it as a PCI device and
use its BAR/control registers for pstore storage and control interface.
It could save you headache of picking address where to map it +
it would take care of migration part automatically, as firmware
would do it for you and then QEMU could pickup firmware programmed
address and put it into ERST table.
5. instead of dealing with file for storage directly, reuse hostmem backend
to provide it to for your device. ex: pc-dimm. i.e. split device
on frontend and backend
> Signed-off-by: Eric DeVolder <eric.devolder@oracle.com>
>
> ---
> hw/acpi/erst.c | 909 +++++++++++++++++++++++++++++++++++++++++++++++++
> hw/acpi/meson.build | 1 +
> hw/i386/acpi-build.c | 4 +
> include/hw/acpi/erst.h | 97 ++++++
> 4 files changed, 1011 insertions(+)
> create mode 100644 hw/acpi/erst.c
> create mode 100644 include/hw/acpi/erst.h
>
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH 1/1] acpi: Implement ACPI ERST support for guests
2020-10-26 20:19 ` [PATCH 1/1] " Eric DeVolder
@ 2020-11-03 21:16 ` Paolo Bonzini
2021-02-08 21:08 ` Eric Devolder
1 sibling, 0 replies; 7+ messages in thread
From: Paolo Bonzini @ 2020-11-03 21:16 UTC (permalink / raw)
To: Eric DeVolder, qemu-devel
Cc: ehabkost, konrad.wilk, mst, imammedo, boris.ostrovsky, rth
On 26/10/20 21:19, Eric DeVolder wrote:
> This changeset introduces support for the ACPI Error Record
> Serialization Table, ERST.
>
> ERST is defined in [1], and the error records are defined
> according to [2].
>
> This changeset generates the ACPI ERST table, which OSPM
> follows to program the associated ERST device. The ERST
> device occupies 8KiB of address space, with the first 8 bytes
> containing registers, and the remainder being an exchange
> buffer for reading/writing error records.
>
> The ERST device contains two registers, ACTION and VALUE
> registers, following closely the ERST operations.
>
> The ERST device only examines the record for the signature 'CPER',
> its record identifier, and bounds-checks the length against the size
> of the the CPER record header; otherwise all other record fields
> and payload are ignored.
>
> There are two options for this device:
> -global acpi-erst.size=X
> -global acpi-erst.filename=Y
> The size X, if not specified, defaults to 64KiB, and must be within
> 64KiB and 1MiB.
> The filename Y, if not specified, defaults to "acpi-erst.backing".
> The ERST backing storage is not mapped into the guest address space,
> just the 8KiB programming area is mapped into the guest.
>
> This has been utilized as a backend for the Linux pstore feature.
>
> [1] ACPI 6.3 Specification, 18.3 Error Serialization
> https://uefi.org/sites/default/files/resources/ACPI_6_3_final_Jan30.pdf
>
> [2] UEFI 2.8 Specification, Appendix N Common Platform Error Record
> https://uefi.org/sites/default/files/resources/UEFI_Spec_2_8_final.pdf
In addition to what Igor said, this really needs a test for the device
(using qtest). It doesn't have to be super fine-grained, but at least a
smoke test that the action and value registers do what they mean for a
sample error recording operation.
Paolo
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH 0/1] acpi: Implement ACPI ERST support for guests
2020-10-26 20:19 [PATCH 0/1] acpi: Implement ACPI ERST support for guests Eric DeVolder
` (2 preceding siblings ...)
2020-11-03 14:57 ` Igor Mammedov
@ 2021-02-08 21:07 ` Eric Devolder
3 siblings, 0 replies; 7+ messages in thread
From: Eric Devolder @ 2021-02-08 21:07 UTC (permalink / raw)
To: Igor Mammedov
Cc: ehabkost, mst, Konrad Wilk, qemu-devel, pbonzini,
Boris Ostrovsky, lersek, rth
[-- Attachment #1: Type: text/plain, Size: 5160 bytes --]
Igor,
Thanks for the feedback. Please see EJD: inline below.
I've posted v2 of this patch based on your feedback.
eric
________________________________
From: Igor Mammedov <imammedo@redhat.com>
Sent: Tuesday, November 3, 2020 8:57 AM
To: Eric DeVolder <eric.devolder@oracle.com>
Cc: qemu-devel@nongnu.org <qemu-devel@nongnu.org>; mst@redhat.com <mst@redhat.com>; marcel.apfelbaum@gmail.com <marcel.apfelbaum@gmail.com>; pbonzini@redhat.com <pbonzini@redhat.com>; rth@twiddle.net <rth@twiddle.net>; ehabkost@redhat.com <ehabkost@redhat.com>; konrad.wilk@oracle.com <konrad.wilk@oracle.com>; boris.ostrovsky@oracle.com <boris.ostrovsky@oracle.com>; lersek@redhat.com <lersek@redhat.com>
Subject: Re: [PATCH 0/1] acpi: Implement ACPI ERST support for guests
On Mon, 26 Oct 2020 16:19:32 -0400
Eric DeVolder <eric.devolder@oracle.com> wrote:
> This changeset introduces support for the ACPI Error Record
> Serialization Table, ERST.
>
> The change to hw/acpi/meson.build simply adds in the new .c file
> for compilation.
>
> The change to hw/i386/acpi-build.c calls out the building of the
> ERST table (and also creates the associated device).
>
> The new file hw/acpi/erst.c contains the building of the ERST
> table, as well as the simple device for exchanging error records.
>
> The new file include/hw/acpi/erst.h contains associated definitions
> and declarations for ERST.
>
> The primary description of this changeset is in the patch commit
> message.
>
> NOTES: When reviewing, I would especially appreciate feedback
> on the following topics:
>
> - The hope is to have ERST always present if ACPI is enabled, however,
> I have found it difficult to devise a method for passing the base
> address that does not require the workaround at the bottom of
> build_erst(). The issues I encountered are:
> - desire to keep this is common ACPI code
> - the device requires a qdev_new(), this needs to happen early,
> thus the workaround in build_erst()
> - the base address is machine/arch specific (eg ARM vs x86)
> I've not found a nice way to thread this needle, so what I've settled
> on is to simply lump ERST on to the CONFIG_ACPI (rather than a
> separate CONFIG_ACPI_ERST), and the workaround at the bottom of
> build_erst(). I suspect there is a better way for a built-in/
> always present device. This does not support "-device acpi-erst,...".
>
> - I found a base address that "worked", but would like an address
> that would be known to be availabe, and then to document/reserve
> it for ERST. This takes into account that the base address can be
> different for x86 vs ARM.
>
> - I've run this through checkpatch, and all issues addressed except
> for the long lines in build_erst(). For readable I left the long
> lines, but will change if asked.
>
> - What else do I need to provide?
For now, I have just several generic comments:
1. that's quite a lot code to maintain, why not use existing UEFI vars
as pstore storage instead?
Not sure ancient ACPI table is a way to go, with NVDIMMs around
it probably possible to use pstores ram backend or make it work
with nvdimms directly. The only benefit of ERST is that it should
just work without extra configuration, but then UEFI backend
would probably also just work.
EJD: UEFI is not available in all virtual machines types. While perhaps ancient, ACPI ERST has been around for along time, and most bare metal (x86_64) machines implement this in BIOS.
EJD: My exposure to NVDIMM is limited, but it seems utilizing it as a storage backend to pstore would be quite difficult.
2. patch is too big to review, please split it up in smaller chunks.
EJD: Done.
3. Use of packed structures is discouraged in new ACPI code,
see build_ghes_v2() as an example for building ACPI tables.
EJD: Done. Thanks for the pointer.
4. Maybe instead of SYSBUS device, implement it as a PCI device and
use its BAR/control registers for pstore storage and control interface.
It could save you headache of picking address where to map it +
it would take care of migration part automatically, as firmware
would do it for you and then QEMU could pickup firmware programmed
address and put it into ERST table.
EJD: Thanks for the idea. For now I've left it as a SYSBUS device; we can revisit as needed.
5. instead of dealing with file for storage directly, reuse hostmem backend
to provide it to for your device. ex: pc-dimm. i.e. split device
on frontend and backend
EJD: I had looked into that prior to posting v1. The entire ERST storage is not memory mapped, just an exchange buffer. So the hostmem backend is not suitable for this purpose.
> Signed-off-by: Eric DeVolder <eric.devolder@oracle.com>
>
> ---
> hw/acpi/erst.c | 909 +++++++++++++++++++++++++++++++++++++++++++++++++
> hw/acpi/meson.build | 1 +
> hw/i386/acpi-build.c | 4 +
> include/hw/acpi/erst.h | 97 ++++++
> 4 files changed, 1011 insertions(+)
> create mode 100644 hw/acpi/erst.c
> create mode 100644 include/hw/acpi/erst.h
>
[-- Attachment #2: Type: text/html, Size: 7883 bytes --]
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH 1/1] acpi: Implement ACPI ERST support for guests
2020-10-26 20:19 ` [PATCH 1/1] " Eric DeVolder
2020-11-03 21:16 ` Paolo Bonzini
@ 2021-02-08 21:08 ` Eric Devolder
1 sibling, 0 replies; 7+ messages in thread
From: Eric Devolder @ 2021-02-08 21:08 UTC (permalink / raw)
To: Paolo Bonzini, qemu-devel
Cc: ehabkost, Konrad Wilk, mst, imammedo, Boris Ostrovsky, rth
[-- Attachment #1: Type: text/plain, Size: 2648 bytes --]
Paolo,
Thanks for the feedback. I've posted v2 with changes based on Igor's feedback.
I've also included a qtest per your feedback.
Eric
________________________________
From: Paolo Bonzini <pbonzini@redhat.com>
Sent: Tuesday, November 3, 2020 3:16 PM
To: Eric DeVolder <eric.devolder@oracle.com>; qemu-devel@nongnu.org <qemu-devel@nongnu.org>
Cc: mst@redhat.com <mst@redhat.com>; imammedo@redhat.com <imammedo@redhat.com>; marcel.apfelbaum@gmail.com <marcel.apfelbaum@gmail.com>; rth@twiddle.net <rth@twiddle.net>; ehabkost@redhat.com <ehabkost@redhat.com>; konrad.wilk@oracle.com <konrad.wilk@oracle.com>; boris.ostrovsky@oracle.com <boris.ostrovsky@oracle.com>
Subject: Re: [PATCH 1/1] acpi: Implement ACPI ERST support for guests
On 26/10/20 21:19, Eric DeVolder wrote:
> This changeset introduces support for the ACPI Error Record
> Serialization Table, ERST.
>
> ERST is defined in [1], and the error records are defined
> according to [2].
>
> This changeset generates the ACPI ERST table, which OSPM
> follows to program the associated ERST device. The ERST
> device occupies 8KiB of address space, with the first 8 bytes
> containing registers, and the remainder being an exchange
> buffer for reading/writing error records.
>
> The ERST device contains two registers, ACTION and VALUE
> registers, following closely the ERST operations.
>
> The ERST device only examines the record for the signature 'CPER',
> its record identifier, and bounds-checks the length against the size
> of the the CPER record header; otherwise all other record fields
> and payload are ignored.
>
> There are two options for this device:
> -global acpi-erst.size=X
> -global acpi-erst.filename=Y
> The size X, if not specified, defaults to 64KiB, and must be within
> 64KiB and 1MiB.
> The filename Y, if not specified, defaults to "acpi-erst.backing".
> The ERST backing storage is not mapped into the guest address space,
> just the 8KiB programming area is mapped into the guest.
>
> This has been utilized as a backend for the Linux pstore feature.
>
> [1] ACPI 6.3 Specification, 18.3 Error Serialization
> https://uefi.org/sites/default/files/resources/ACPI_6_3_final_Jan30.pdf
>
> [2] UEFI 2.8 Specification, Appendix N Common Platform Error Record
> https://uefi.org/sites/default/files/resources/UEFI_Spec_2_8_final.pdf
In addition to what Igor said, this really needs a test for the device
(using qtest). It doesn't have to be super fine-grained, but at least a
smoke test that the action and value registers do what they mean for a
sample error recording operation.
Paolo
[-- Attachment #2: Type: text/html, Size: 4424 bytes --]
^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2021-02-09 0:43 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-26 20:19 [PATCH 0/1] acpi: Implement ACPI ERST support for guests Eric DeVolder
2020-10-26 20:19 ` [PATCH 1/1] " Eric DeVolder
2020-11-03 21:16 ` Paolo Bonzini
2021-02-08 21:08 ` Eric Devolder
2020-10-26 20:54 ` [PATCH 0/1] " no-reply
2020-11-03 14:57 ` Igor Mammedov
2021-02-08 21:07 ` Eric Devolder
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.