[PATCH 1/2] add ACPI SLIT table sanity checking (LP: #1465276)

Colin King colin.king at canonical.com
Mon Jun 15 13:53:43 UTC 2015


From: Colin Ian King <colin.king at canonical.com>

Add SLIT (System Locality Distance Information Table) test.

Signed-off-by: Colin Ian King <colin.king at canonical.com>
---
 src/Makefile.am      |   1 +
 src/acpi/slit/slit.c | 190 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 191 insertions(+)
 create mode 100644 src/acpi/slit/slit.c

diff --git a/src/Makefile.am b/src/Makefile.am
index 3fa679c..42ecac7 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -53,6 +53,7 @@ fwts_SOURCES = main.c 				\
 	acpi/s3/s3.c 				\
 	acpi/s3power/s3power.c 			\
 	acpi/s4/s4.c 				\
+	acpi/slit/slit.c 			\
 	acpi/spcr/spcr.c 			\
 	acpi/spmi/spmi.c 			\
 	acpi/srat/srat.c 			\
diff --git a/src/acpi/slit/slit.c b/src/acpi/slit/slit.c
new file mode 100644
index 0000000..ef28d2a
--- /dev/null
+++ b/src/acpi/slit/slit.c
@@ -0,0 +1,190 @@
+/*
+ * 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>
+
+#define	INDEX(i, j)	(((i) * slit->num_of_system_localities) + (j))
+
+fwts_acpi_table_info *table;
+
+static int slit_init(fwts_framework *fw)
+{
+
+	if (fwts_acpi_find_table(fw, "SLIT", 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 SLIT table does not exist, skipping test");
+		return FWTS_SKIP;
+	}
+
+	return FWTS_OK;
+}
+
+/*
+ *  For SLIT System Locality Distance Information refer to
+ *    section 5.2.17 of the ACPI specification version 6.0
+ */
+static int slit_test1(fwts_framework *fw)
+{
+	bool passed = true;
+	uint64_t i, j, size, n, reserved = 0, bad_entry = 0;
+	uint8_t *entry;
+	fwts_acpi_table_slit *slit = (fwts_acpi_table_slit *)table->data;
+
+	/* Size sanity check #1, got enough table to at least get matrix size */
+	if (table->length < sizeof(fwts_acpi_table_slit)) {
+		passed = false;
+		fwts_failed(fw, LOG_LEVEL_HIGH,
+			"SLITTooShort",
+			"SLIT table too short, must be at least %zu bytes, "
+			"instead got %zu bytes",
+			sizeof(fwts_acpi_table_spmi), table->length);
+		goto done;
+	}
+
+	n = slit->num_of_system_localities;
+	fwts_log_info_verbatum(fw, "SLIT System Locality Distance Information Table:");
+	fwts_log_info_verbatum(fw, "  Number of Localities:     0x%" PRIx64, n);
+
+	/*
+	 *  ACPI table length is 32 bits, so maximum matrix of entries size is
+	 *  is 2^32 - sizeof(fwts_acpi_table_slit) = 2^32 - 44 = 4294967252
+	 *  and table is a N x N matrix, so maxium number of localities is
+	 *  limited to int(sqrt(4294967252)) = 65535. 
+	 */
+	if (n > 0xffff) {
+		passed = false;
+		fwts_failed(fw, LOG_LEVEL_HIGH,
+			"SLITTooManySystemLocalities",
+			"SLIT table size is %zu, however, the number of "
+			"System Locality Entries is %" PRIu64 " which "
+			"results in an ACPI table larger than the maximum "
+			"32 bit ACPI table size of 4MB",
+			table->length,
+			n);
+		goto done;
+	}
+
+	/*
+	 *  Now that we are confident of no overflow, check that the matrix
+	 *  + SLIT table header is not bigger than the actual table.
+	 */
+	size = (n * n) + sizeof(fwts_acpi_table_slit);
+	if ((uint64_t)table->length < size) {
+		passed = false;
+		fwts_failed(fw, LOG_LEVEL_HIGH,
+			"SLITTooManySystemLocalities",
+			"SLIT table size is %zu, however, the number of "
+			"System Locality Entries is %" PRIu64 " and this "
+			"results in a table of size %" PRIu64 " which "
+			"is larger than the SLIT table size",
+			table->length, size, n);
+		goto done;
+	}
+
+	entry = (uint8_t *)table->data + sizeof(fwts_acpi_table_slit);
+
+	/*
+	 *  Now sanity check the entries..
+	 */
+	if (entry[INDEX(0,0)] != 10) {
+		passed = false;
+		fwts_failed(fw, LOG_LEVEL_HIGH,
+			"SLITBadCornerEntry",
+			"SLIT Entry[0][0] is 0x%" PRIx8 ", expecting value 0x0a.",
+			entry[INDEX(0,0)]);
+	}
+	if (entry[INDEX(n - 1, n - 1)] != 10) {
+		passed = false;
+		fwts_failed(fw, LOG_LEVEL_HIGH,
+			"SLITBadCornerEntry",
+			"SLIT Entry[%" PRIu64 "][%" PRIu64 "] is 0x%" PRIx8 ", expecting value 0x0a.",
+			n - 1, n - 1,
+			entry[INDEX(n - 1, n - 1)]);
+	}
+
+	for (i = 0; i < n; i++) {
+		for (j = 0; j < n; j++) {
+			uint8_t val1 = entry[INDEX(i, j)],
+				val2 = entry[INDEX(j, i)];
+
+			/* Check for distances less than 10 (reserved, no meaning) */
+			if (val1 < 10) {
+				reserved++;
+				/* Report first 16 errors */
+				if (reserved < 16) {
+					fwts_failed(fw, LOG_LEVEL_HIGH,
+						"SLITEntryReserved",
+						"SLIT Entry[%" PRIu64 "][%" PRIu64 "]"
+						" is 0x%" PRIx8 " which is a reserved value"
+						" and has no defined meaning",
+						i, j, val1);
+				}
+			}
+
+			if (val1 != val2) {
+				bad_entry++;
+				/* Report first 16 bad entries */
+				if (bad_entry < 16) {
+					fwts_failed(fw, LOG_LEVEL_HIGH,
+						"SLITEntryReserved",
+						"SLIT Entry[%" PRIu64 "][%" PRIu64 "]"
+						" is 0x%" PRIx8 " and not the same as "
+						"SLIT Entry[%" PRIu64 "][%" PRIu64 "]"
+						" which is 0x%" PRIx8,
+						i, j, val1, j, i, val2);
+				}
+			}
+		}
+	}
+
+	if (reserved)
+		fwts_log_info(fw, "Total of %" PRIu64 " entries were using reserved values",
+			reserved);
+	if (bad_entry)
+		fwts_log_info(fw, "Total of %" PRIu64 " entries were not matching "
+			"their diagonal parner element", bad_entry);
+done:
+	if (passed)
+		fwts_passed(fw, "No issues found in SLIT table.");
+
+	return FWTS_OK;
+}
+
+static fwts_framework_minor_test slit_tests[] = {
+	{ slit_test1, "SLIT System Locality Distance Information test." },
+	{ NULL, NULL }
+};
+
+static fwts_framework_ops slit_ops = {
+	.description = "SLIT System Locality Distance Information test.",
+	.init        = slit_init,
+	.minor_tests = slit_tests
+};
+
+FWTS_REGISTER("slit", &slit_ops, FWTS_TEST_ANYTIME, FWTS_FLAG_BATCH | FWTS_FLAG_ROOT_PRIV | FWTS_FLAG_TEST_ACPI)
-- 
2.1.4




More information about the fwts-devel mailing list