[PATCH 2/3] acpi: add SRAT table sanity checking (LP: #1464658)
Colin Ian King
colin.king at canonical.com
Mon Jun 15 08:13:09 UTC 2015
On 15/06/15 08:05, ivanhu wrote:
>
>
> On 2015年06月12日 21:02, Colin King wrote:
>> From: Colin Ian King <colin.king at canonical.com>
>>
>> Add one more of many ACPI tables that need some level of sanity checking.
>>
>> Signed-off-by: Colin Ian King <colin.king at canonical.com>
>> ---
>> src/Makefile.am | 1 +
>> src/acpi/srat/srat.c | 300
>> +++++++++++++++++++++++++++++++++++++++++++++++++++
>> 2 files changed, 301 insertions(+)
>> create mode 100644 src/acpi/srat/srat.c
>>
>> diff --git a/src/Makefile.am b/src/Makefile.am
>> index 62c63ef..d1ace77 100644
>> --- a/src/Makefile.am
>> +++ b/src/Makefile.am
>> @@ -52,6 +52,7 @@ fwts_SOURCES = main.c \
>> acpi/s3power/s3power.c \
>> acpi/s4/s4.c \
>> acpi/spcr/spcr.c \
>> + acpi/srat/srat.c \
>> acpi/syntaxcheck/syntaxcheck.c \
>> acpi/wakealarm/wakealarm.c \
>> acpi/wmi/wmi.c \
>> diff --git a/src/acpi/srat/srat.c b/src/acpi/srat/srat.c
>> new file mode 100644
>> index 0000000..c62d905
>> --- /dev/null
>> +++ b/src/acpi/srat/srat.c
>> @@ -0,0 +1,300 @@
>> +/*
>> + * Copyright (C) 2015 Canonical
>> + *
>> + * Portions of this code original from the Linux-ready Firmware
>> Developer Kit
>> + *
>> + * 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, write to the Free Software
>> + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
>> 02110-1301, USA.
>> + *
>> + */
>> +#include "fwts.h"
>> +
>> +#include <stdlib.h>
>> +#include <stdio.h>
>> +#include <unistd.h>
>> +#include <inttypes.h>
>> +#include <string.h>
>> +
>> +static fwts_acpi_table_info *table;
>> +
>> +static int srat_init(fwts_framework *fw)
>> +{
>> +
>> + if (fwts_acpi_find_table(fw, "SRAT", 0, &table) != FWTS_OK) {
>> + fwts_log_error(fw, "Cannot read ACPI tables.");
>> + return FWTS_ERROR;
>> + }
>> + if (table == NULL || (table && table->length == 0)) {
>> + fwts_log_error(fw, "ACPI SRAT table does not exist, skipping
>> test");
>> + return FWTS_SKIP;
>> + }
>> +
>> + return FWTS_OK;
>> +}
>> +
>> +static void srat_check_local_apic_sapic_affinity(
>> + fwts_framework *fw,
>> + ssize_t *length,
>> + uint8_t **data,
>> + bool *passed)
>> +{
>> + fwts_acpi_table_local_apic_sapic_affinity *affinity =
>> + (fwts_acpi_table_local_apic_sapic_affinity *)*data;
>> +
>> + if ((ssize_t)sizeof(fwts_acpi_table_local_apic_sapic_affinity) >
>> *length) {
>> + fwts_failed(fw, LOG_LEVEL_MEDIUM,
>> + "SRATLocalApicSapicAffinityShort",
>> + "SRAT Local APIC/SPAIC Affinity structure too short, got "
>> + "%zu bytes, expecting %zu bytes",
>> + *length, sizeof(fwts_acpi_table_local_apic_sapic_affinity));
>> + *passed = false;
>> + goto done;
>> + }
>> +
>> + if (affinity->length !=
>> sizeof(fwts_acpi_table_local_apic_sapic_affinity)) {
>> + fwts_failed(fw, LOG_LEVEL_MEDIUM,
>> + "SRATLocalApicSapicAffinityLength",
>> + "SRAT Local APIC/SPAIC Affinity Length incorrect, got "
>> + "%" PRIu8 ", expecting %zu",
>> + affinity->length,
>> sizeof(fwts_acpi_table_local_apic_sapic_affinity));
>> + *passed = false;
>> + }
>> +
>> + fwts_log_info_verbatum(fw, "SRAT Local APIC/SAPIC Affinity
>> Structure:");
>> + fwts_log_info_verbatum(fw, " Proximity Domain: [7:0] 0x%2.2"
>> PRIx8, affinity->proximity_domain_0);
>> + fwts_log_info_verbatum(fw, " APIC ID: 0x%2.2"
>> PRIx8, affinity->apic_id);
>> + fwts_log_info_verbatum(fw, " Flags: 0x%8.8"
>> PRIx32, affinity->flags);
>> + fwts_log_info_verbatum(fw, " Local SAPIC EID: 0x%2.2"
>> PRIx8, affinity->local_sapic_eid);
>> + fwts_log_info_verbatum(fw, " Proximity Domain: [8:15] 0x%2.2"
>> PRIx8, affinity->proximity_domain_1);
>> + fwts_log_info_verbatum(fw, " Proximity Domain: [16:23] 0x%2.2"
>> PRIx8, affinity->proximity_domain_2);
>> + fwts_log_info_verbatum(fw, " Proximity Domain: [23:31] 0x%2.2"
>> PRIx8, affinity->proximity_domain_3);
>> + fwts_log_info_verbatum(fw, " Clock Domain 0x%8.8"
>> PRIx32, affinity->clock_domain);
>> + fwts_log_nl(fw);
>> +
>> + if (affinity->flags & ~0x1UL) {
>> + fwts_failed(fw, LOG_LEVEL_MEDIUM,
>> + "SRATLocalApicSapicAffinityFlags",
>> + "SRAT Local APIC/SPAIC Affinity Flags field reserved bits
>> 1..31 should be zero, got "
>> + "0x%" PRIx32,
>> + affinity->flags);
>> + *passed = false;
>> + }
>> +
>> + /*
>> + * Not clear of bits 0..7 of Proximity Domain are reserved or not
>> + * so skip check for these
>> + */
>> +
>> + /*
>> + * Clock domain probably needs deeper sanity checking, for now
>> + * skip this.
>> + */
>> +done:
>> + *length -= sizeof(fwts_acpi_table_local_apic_sapic_affinity);
>> + *data += sizeof(fwts_acpi_table_local_apic_sapic_affinity);
>> +}
>> +
>> +static void srat_check_memory_affinity(
>> + fwts_framework *fw,
>> + ssize_t *length,
>> + uint8_t **data,
>> + bool *passed)
>> +{
>> + fwts_acpi_table_memory_affinity *affinity =
>> + (fwts_acpi_table_memory_affinity *)*data;
>> +
>> + if ((ssize_t)sizeof(fwts_acpi_table_memory_affinity) > *length) {
>> + fwts_failed(fw, LOG_LEVEL_MEDIUM,
>> + "SRATMemoryAffinityShort",
>> + "SRAT Memory Affinity structure too short, got "
>> + "%zu bytes, expecting %zu bytes",
>> + *length, sizeof(fwts_acpi_table_memory_affinity));
>> + *passed = false;
>> + goto done;
>> + }
>> +
>> + if (affinity->length != sizeof(fwts_acpi_table_memory_affinity)) {
>> + fwts_failed(fw, LOG_LEVEL_MEDIUM,
>> + "SRATMemoryAffinityLength",
>> + "SRAT Memory Affinity Length incorrect, got "
>> + "%" PRIu8 ", expecting %zu",
>> + affinity->length, sizeof(fwts_acpi_table_memory_affinity));
>> + *passed = false;
>> + goto done;
>> + }
>> +
>> + fwts_log_info_verbatum(fw, "SRAT Memory Affinity Structure:");
>> + fwts_log_info_verbatum(fw, " Proximity Domain: 0x%8.8"
>> PRIx32, affinity->proximity_domain);
>> + fwts_log_info_verbatum(fw, " Reserved: 0x%4.4"
>> PRIx16, affinity->reserved1);
>> + fwts_log_info_verbatum(fw, " Base Address: 0x%8.8"
>> PRIx32 "%8.8" PRIx32,
>> + affinity->base_addr_hi, affinity->base_addr_lo);
>> + fwts_log_info_verbatum(fw, " Length: 0x%8.8"
>> PRIx32 "%8.8" PRIx32,
>> + affinity->length_hi, affinity->length_lo);
>> + fwts_log_info_verbatum(fw, " Reserved: 0x%8.8"
>> PRIx32, affinity->reserved2);
>> + fwts_log_info_verbatum(fw, " Flags: 0x%8.8"
>> PRIx32, affinity->flags);
>> + fwts_log_info_verbatum(fw, " Reserved: 0x%16.16"
>> PRIx64, affinity->reserved3);
>> + fwts_log_nl(fw);
>> +
>> + if (affinity->flags & ~0x7UL) {
>> + fwts_failed(fw, LOG_LEVEL_MEDIUM,
>> + "SRATMemoryAffinityFlags",
>> + "SRAT Memory Affinity Flags field reserved bits 3..31
>> should be zero, got "
>> + "0x%" PRIx32,
>> + affinity->flags);
>> + *passed = false;
>> + }
>> +done:
>> + *length -= sizeof(fwts_acpi_table_memory_affinity);
>> + *data += sizeof(fwts_acpi_table_memory_affinity);
>> +}
>> +
>> +/*
>> +typedef struct {
>> + uint8_t type;
>> + uint8_t length;
>> + uint16_t reserved1;
>> + uint32_t proximity_domain;
>> + uint32_t x2apic_id;
>> + uint32_t flags;
>> + uint32_t clock_domain;
>> + uint32_t reserved2;
>> +} __attribute__ ((packed)) fwts_acpi_table_local_x2apic_affinity;
>> +
>> +
>> +*/
>> +static void srat_check_local_x2apic_affinity(
>> + fwts_framework *fw,
>> + ssize_t *length,
>> + uint8_t **data,
>> + bool *passed)
>> +{
>> + fwts_acpi_table_local_x2apic_affinity *affinity =
>> + (fwts_acpi_table_local_x2apic_affinity *)*data;
>> +
>> + if ((ssize_t)sizeof(fwts_acpi_table_local_x2apic_affinity) >
>> *length) {
>> + fwts_failed(fw, LOG_LEVEL_MEDIUM,
>> + "SRATLocalx2apicAffinityShort",
>> + "SRAT Local x2APIC Affinity structure too short, got "
>> + "%zu bytes, expecting %zu bytes",
>> + *length, sizeof(fwts_acpi_table_local_x2apic_affinity));
>> + *passed = false;
>> + goto done;
>> + }
>> +
>> + if (affinity->length !=
>> sizeof(fwts_acpi_table_local_x2apic_affinity)) {
>> + fwts_failed(fw, LOG_LEVEL_MEDIUM,
>> + "SRATLocalx2apicAffinityLength",
>> + "SRAT Local x2APIC Affinity Length incorrect, got "
>> + "%" PRIu8 ", expecting %zu",
>> + affinity->length,
>> sizeof(fwts_acpi_table_local_x2apic_affinity));
>> + *passed = false;
>> + goto done;
>> + }
>> +
>> + fwts_log_info_verbatum(fw, "SRAT Local x2APIC Affinity Structure:");
>> + fwts_log_info_verbatum(fw, " Reserved: 0x%4.4"
>> PRIx16, affinity->reserved1);
>> + fwts_log_info_verbatum(fw, " Proximity Domain: 0x%4.4"
>> PRIx16, affinity->proximity_domain);
>> + fwts_log_info_verbatum(fw, " X2APIC ID: 0x%8.8"
>> PRIx32, affinity->x2apic_id);
>> + fwts_log_info_verbatum(fw, " Flags: 0x%8.8"
>> PRIx32, affinity->flags);
>> + fwts_log_info_verbatum(fw, " Clock Domain 0x%8.8"
>> PRIx32, affinity->clock_domain);
>> + fwts_log_info_verbatum(fw, " Reserved: 0x%4.4"
>> PRIx16, affinity->reserved2);
>> + fwts_log_nl(fw);
>> +
>> + /* Spec states 1st reserved field MUST be zero */
>> + if (affinity->reserved1) {
>> + fwts_failed(fw, LOG_LEVEL_MEDIUM,
>> + "SRATLocalx2apicReserved1",
>> + "SRAT Local x2APIC Affinity 1st Reserved field should be
>> zero, got "
>> + "0x%" PRIx32,
>> + affinity->reserved1);
>> + *passed = false;
>> + }
>> +
>> + if (affinity->flags & ~0x1UL) {
>> + fwts_failed(fw, LOG_LEVEL_MEDIUM,
>> + "SRATLocalx2apicAffinityFlags",
>> + "SRAT Local x2APIC Affinity Flags field reserved bits
>> 1..31 should be zero, got "
>> + "0x%" PRIx32,
>> + affinity->flags);
>> + *passed = false;
>> + }
>> +
>> +done:
>> + *length -= sizeof(fwts_acpi_table_local_x2apic_affinity);
>> + *data += sizeof(fwts_acpi_table_local_x2apic_affinity);
>> +}
>> +
>> +
>> +/*
>> + * See ACPI 6.0, Section 5.2.16
>> + */
>> +static int srat_test1(fwts_framework *fw)
>> +{
>> + const fwts_acpi_table_srat *srat = (const fwts_acpi_table_srat
>> *)table->data;
>> + uint8_t *data = (uint8_t *)table->data;
>> + bool passed = true;
>> + ssize_t length = (ssize_t)srat->header.length;
>> +
>> + if (srat->reserved1 != 1) {
>> + fwts_failed(fw, LOG_LEVEL_MEDIUM,
>> + "SRATInterfaceReserved",
>> + "SRAT reserved field 1 should be 1, instead was "
>> + "0x%" PRIx32, srat->reserved1);
>> + passed = false;
>> + }
>> +
>> + data += sizeof(fwts_acpi_table_srat);
>> + length -= sizeof(fwts_acpi_table_srat);
>> +
>> + while (length > 0) {
>> + switch (*data) {
>> + case 0x00:
>> + srat_check_local_apic_sapic_affinity(fw, &length, &data,
>> &passed);
>> + break;
>> + case 0x01:
>> + srat_check_memory_affinity(fw, &length, &data, &passed);
>> + break;
>> + case 0x02:
>> + srat_check_local_x2apic_affinity(fw, &length, &data,
>> &passed);
>> + break;
> Do we need to check GICC Affinity Structure (0x03)?
We do, I missed that completely, oops. Thanks for spotting that.
>
>> + default:
>> + fwts_failed(fw, LOG_LEVEL_HIGH,
>> + "SRATInvalidType",
>> + "SRAT Affinity Structure Type 0x%" PRIx8
>> + " is an invalid type, expecting 0x00..0x02",
>> + *data);
>> + passed = false;
>> + length = 0;
>> + break;
>> + }
>> + }
>> +
>> + if (passed)
>> + fwts_passed(fw, "No issues found in SRAT table.");
>> +
>> + return FWTS_OK;
>> +}
>> +
>> +static fwts_framework_minor_test srat_tests[] = {
>> + { srat_test1, "SRAT System Resource Affinity Table test." },
>> + { NULL, NULL }
>> +};
>> +
>> +static fwts_framework_ops srat_ops = {
>> + .description = "SRAT System Resource Affinity Table test.",
>> + .init = srat_init,
>> + .minor_tests = srat_tests
>> +};
>> +
>> +FWTS_REGISTER("srat", &srat_ops, FWTS_TEST_ANYTIME, FWTS_FLAG_BATCH |
>> FWTS_FLAG_ROOT_PRIV | FWTS_FLAG_TEST_ACPI)
>
>
More information about the fwts-devel
mailing list