Skip to contentSkip to conversation

acpi unit-test: rebuild aml files functionality

PATCH In review Marcel Apfelbaum 2 participants 6 messages Dec 26, 2013

lore
Share & tools
lore
#0 lore raw

v3 cover acpi unit-test: rebuild aml files functionality

Acpi unit-test will fail every time the acpi tables change.

The series adds a script that rebuilds the expected aml files, so the test will pass. It also validates the modifications.

The acpi unit test will rebuild the aml tables if TEST_ACPI_REBUILD_AML environment variable is set.

v2 -> v3:
Addressed Michael S. Tsirkin's comments:
- Used qemu_write_full instead of write
- Some trailing space

v1 -> v2:
Addressed Michael S. Tsirkin's comments:
- added TEST_ prefix to the environment variable
- some rephrases

Marcel Apfelbaum (2):
acpi unit-test: added script to rebuild the expected aml files acpi unit-test: hook to rebuild expected aml files

 tests/acpi-test-data/rebuild-expected-aml.sh | 36 +++++++++++++++++++++++++++
 tests/acpi-test.c                            | 37 ++++++++++++++++++++++------
 2 files changed, 66 insertions(+), 7 deletions(-)
 create mode 100755 tests/acpi-test-data/rebuild-expected-aml.sh
Signature · 1 line
1.8.3.1
#1 lore raw

PATCH v3 1/2 acpi unit-test: added script to rebuild the expected aml files

Acpi unit-test will fail every time the acpi tables change. This script rebuild the expected aml files, so the test will pass. It also validates the modifications.

---
v2 -> v3:
Addressed Michael S. Tsirkin's comments:
- Some trailing space
v1 -> v2:
Addressed Michael S. Tsirkin's comments:
- added TEST_ prefix to the environment variable
- some rephrases

 tests/acpi-test-data/rebuild-expected-aml.sh | 36 ++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100755 tests/acpi-test-data/rebuild-expected-aml.sh
tests/acpi-test-data/rebuild-expected-aml.sh new file +36 -0
new file mode 100755
index 0000000..ab98498
@@ -0,0 +1,36 @@
+#! /bin/bash
+
+#
+# Rebuild expected AML files for acpi unit-test
+#
+# Copyright (c) 2013 Red Hat Inc.
+#
+# Authors:
+#  Marcel Apfelbaum <[email protected]>
+#
+# This work is licensed under the terms of the GNU GPLv2.
+# See the COPYING.LIB file in the top-level directory.
+
+qemu=
+
+if [ -e x86_64-softmmu/qemu-system-x86_64 ]; then
+    qemu="x86_64-softmmu/qemu-system-x86_64"
+elif [ -e i386-softmmu/qemu-system-i386 ]; then
+    qemu="i386-softmmu/qemu-system-i386"
+else
+    echo "Run 'make' to build the qemu exectutable!"
+    echo "Run this script from the build directory."
+    exit 1;
+fi
+
+if [ ! -e "tests/acpi-test" ]; then
+    echo "Test: acpi-test is required! Run make check before this script."
+    echo "Run this script from the build directory."
+    exit 1;
+fi
+
+TEST_ACPI_REBUILD_AML=y QTEST_QEMU_BINARY=$qemu tests/acpi-test
+
+echo "The files were rebuilt and can be added to git."
+echo "However, if new files were created, please copy them manually" \
+     "to tests/acpi-test-data/pc/ or tests/acpi-test-data/q35/ ."
Signature · 1 line
1.8.3.1
#2 lore raw

PATCH v3 2/2 acpi unit-test: hook to rebuild expected aml files

In reply to Marcel Apfelbaum

When running the test with TEST_ACPI_REBUILD_AML=y environment variable, the test will rebuild and validate the expected aml files.

---
v2 -> v3:
Addressed Michael S. Tsirkin's comments:
- Used qemu_write_full instead of write
v1 -> v2:
Addressed Michael S. Tsirkin's comments:
- added TEST_ prefix to the environment variable

 tests/acpi-test.c | 37 ++++++++++++++++++++++++++++++-------
 1 file changed, 30 insertions(+), 7 deletions(-)
tests/acpi-test.c +30 -7
index 954d9b9..5aa0a00 100644
@@ -13,6 +13,7 @@
 #include <string.h>
 #include <stdio.h>
 #include <glib.h>
+#include <glib/gstdio.h>
 #include "qemu-common.h"
 #include "libqtest.h"
 #include "qemu/compiler.h"
@@ -21,6 +22,8 @@
 #define MACHINE_PC "pc"
 #define MACHINE_Q35 "q35"
 
+#define ACPI_REBUILD_EXPECTED_AML "TEST_ACPI_REBUILD_AML"
+
 /* DSDT and SSDTs format */
 typedef struct {
     AcpiTableHeader header;
@@ -363,23 +366,39 @@ static void test_acpi_ssdt_tables(test_data *data)
     }
 }
 
-static void dump_aml_files(test_data *data)
+static void dump_aml_files(test_data *data, bool rebuild)
 {
     AcpiSdtTable *sdt;
     GError *error = NULL;
+    gchar *aml_file = NULL;
     gint fd;
     int i;
+    ssize_t ret;
 
     for (i = 0; i < data->ssdt_tables->len; ++i) {
         sdt = &g_array_index(data->ssdt_tables, AcpiSdtTable, i);
         g_assert(sdt->aml);
 
-        fd = g_file_open_tmp("aml-XXXXXX", &sdt->aml_file, &error);
-        g_assert_no_error(error);
+        if (rebuild) {
+            aml_file = g_strdup_printf("%s/%s/%.4s", data_dir, data->machine,
+                                       (gchar *)&sdt->header.signature);
+            fd = g_open(aml_file, O_WRONLY|O_TRUNC|O_CREAT,
+                        S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH);
+        } else {
+            fd = g_file_open_tmp("aml-XXXXXX", &sdt->aml_file, &error);
+            g_assert_no_error(error);
+        }
+        g_assert(fd >= 0);
 
-        write(fd, sdt, sizeof(AcpiTableHeader));
-        write(fd, sdt->aml, sdt->aml_len);
+        ret = qemu_write_full(fd, sdt, sizeof(AcpiTableHeader));
+        g_assert(ret == sizeof(AcpiTableHeader));
+        ret = qemu_write_full(fd, sdt->aml, sdt->aml_len);
+        g_assert(ret == sdt->aml_len);
         close(fd);
+
+        if (aml_file) {
+            g_free(aml_file);
+        }
     }
 }
 
@@ -487,7 +506,7 @@ static void test_acpi_asl(test_data *data)
 
     memset(&exp_data, 0, sizeof(exp_data));
     exp_data.ssdt_tables = load_expected_aml(data);
-    dump_aml_files(data);
+    dump_aml_files(data, false);
     for (i = 0; i < data->ssdt_tables->len; ++i) {
         GString *asl, *exp_asl;
 
@@ -553,7 +572,11 @@ static void test_acpi_one(const char *params, test_data *data)
     test_acpi_ssdt_tables(data);
 
     if (iasl) {
-        test_acpi_asl(data);
+        if (getenv(ACPI_REBUILD_EXPECTED_AML)) {
+            dump_aml_files(data, true);
+        } else {
+            test_acpi_asl(data);
+        }
     }
 
     qtest_quit(global_qtest);
Signature · 1 line
1.8.3.1
#3 lore raw

Re: [Qemu-devel] [PATCH v3 2/2] acpi unit-test: hook to rebuild expected aml files

Quoted 60 lines · Marcel Apfelbaum

When running the test with TEST_ACPI_REBUILD_AML=y environment variable, the test will rebuild and validate the expected aml files.

---
v2 -> v3:
Addressed Michael S. Tsirkin's comments:
- Used qemu_write_full instead of write
v1 -> v2:
Addressed Michael S. Tsirkin's comments:
- added TEST_ prefix to the environment variable

 tests/acpi-test.c | 37 ++++++++++++++++++++++++++++++-------
 1 file changed, 30 insertions(+), 7 deletions(-)
tests/acpi-test.c +9 -3
index 954d9b9..5aa0a00 100644
@@ -13,6 +13,7 @@
 #include <string.h>
 #include <stdio.h>
 #include <glib.h>
+#include <glib/gstdio.h>
 #include "qemu-common.h"
 #include "libqtest.h"
 #include "qemu/compiler.h"
@@ -21,6 +22,8 @@
 #define MACHINE_PC "pc"
 #define MACHINE_Q35 "q35"
 
+#define ACPI_REBUILD_EXPECTED_AML "TEST_ACPI_REBUILD_AML"
+
 /* DSDT and SSDTs format */
 typedef struct {
     AcpiTableHeader header;
@@ -363,23 +366,39 @@ static void test_acpi_ssdt_tables(test_data *data)
     }
 }
 
-static void dump_aml_files(test_data *data)
+static void dump_aml_files(test_data *data, bool rebuild)
 {
     AcpiSdtTable *sdt;
     GError *error = NULL;
+    gchar *aml_file = NULL;
     gint fd;
     int i;
+    ssize_t ret;
 
     for (i = 0; i < data->ssdt_tables->len; ++i) {
         sdt = &g_array_index(data->ssdt_tables, AcpiSdtTable, i);
         g_assert(sdt->aml);
 
-        fd = g_file_open_tmp("aml-XXXXXX", &sdt->aml_file, &error);
-        g_assert_no_error(error);
+        if (rebuild) {
+            aml_file = g_strdup_printf("%s/%s/%.4s", data_dir, data->machine,
+                                       (gchar *)&sdt->header.signature);

tests/acpi-test.c static void test_acpi_ssdt_tables(test_data *data) · line 381

Quoted 10 lines
tests/acpi-test.c +7 -2
+            fd = g_open(aml_file, O_WRONLY|O_TRUNC|O_CREAT,
+                        S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH);
+        } else {
+            fd = g_file_open_tmp("aml-XXXXXX", &sdt->aml_file, &error);
+            g_assert_no_error(error);
+        }
+        g_assert(fd >= 0);
 
-        write(fd, sdt, sizeof(AcpiTableHeader));
-        write(fd, sdt->aml, sdt->aml_len);

Please fix the original patch up and resend the whole series - it's not a good idea to break bisect.

So just smash this patch into the previous one.

Quoted 36 lines
tests/acpi-test.c +14 -2
+        ret = qemu_write_full(fd, sdt, sizeof(AcpiTableHeader));
+        g_assert(ret == sizeof(AcpiTableHeader));
+        ret = qemu_write_full(fd, sdt->aml, sdt->aml_len);
+        g_assert(ret == sdt->aml_len);
         close(fd);
+
+        if (aml_file) {
+            g_free(aml_file);
+        }
     }
 }
 
@@ -487,7 +506,7 @@ static void test_acpi_asl(test_data *data)
 
     memset(&exp_data, 0, sizeof(exp_data));
     exp_data.ssdt_tables = load_expected_aml(data);
-    dump_aml_files(data);
+    dump_aml_files(data, false);
     for (i = 0; i < data->ssdt_tables->len; ++i) {
         GString *asl, *exp_asl;
 
@@ -553,7 +572,11 @@ static void test_acpi_one(const char *params, test_data *data)
     test_acpi_ssdt_tables(data);
 
     if (iasl) {
-        test_acpi_asl(data);
+        if (getenv(ACPI_REBUILD_EXPECTED_AML)) {
+            dump_aml_files(data, true);
+        } else {
+            test_acpi_asl(data);
+        }
     }
 
     qtest_quit(global_qtest);
Signature · 1 line
1.8.3.1
#4 lore raw

Re: [Qemu-devel] [PATCH v3 2/2] acpi unit-test: hook to rebuild expected aml files

Quoted 69 lines · Michael S. Tsirkin
Quoted 68 lines · Marcel Apfelbaum

When running the test with TEST_ACPI_REBUILD_AML=y environment variable, the test will rebuild and validate the expected aml files.

---
v2 -> v3:
Addressed Michael S. Tsirkin's comments:
- Used qemu_write_full instead of write
v1 -> v2:
Addressed Michael S. Tsirkin's comments:
- added TEST_ prefix to the environment variable

 tests/acpi-test.c | 37 ++++++++++++++++++++++++++++++-------
 1 file changed, 30 insertions(+), 7 deletions(-)
tests/acpi-test.c +16 -3
index 954d9b9..5aa0a00 100644
@@ -13,6 +13,7 @@
 #include <string.h>
 #include <stdio.h>
 #include <glib.h>
+#include <glib/gstdio.h>
 #include "qemu-common.h"
 #include "libqtest.h"
 #include "qemu/compiler.h"
@@ -21,6 +22,8 @@
 #define MACHINE_PC "pc"
 #define MACHINE_Q35 "q35"
 
+#define ACPI_REBUILD_EXPECTED_AML "TEST_ACPI_REBUILD_AML"
+
 /* DSDT and SSDTs format */
 typedef struct {
     AcpiTableHeader header;
@@ -363,23 +366,39 @@ static void test_acpi_ssdt_tables(test_data *data)
     }
 }
 
-static void dump_aml_files(test_data *data)
+static void dump_aml_files(test_data *data, bool rebuild)
 {
     AcpiSdtTable *sdt;
     GError *error = NULL;
+    gchar *aml_file = NULL;
     gint fd;
     int i;
+    ssize_t ret;
 
     for (i = 0; i < data->ssdt_tables->len; ++i) {
         sdt = &g_array_index(data->ssdt_tables, AcpiSdtTable, i);
         g_assert(sdt->aml);
 
-        fd = g_file_open_tmp("aml-XXXXXX", &sdt->aml_file, &error);
-        g_assert_no_error(error);
+        if (rebuild) {
+            aml_file = g_strdup_printf("%s/%s/%.4s", data_dir, data->machine,
+                                       (gchar *)&sdt->header.signature);
+            fd = g_open(aml_file, O_WRONLY|O_TRUNC|O_CREAT,
+                        S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH);
+        } else {
+            fd = g_file_open_tmp("aml-XXXXXX", &sdt->aml_file, &error);
+            g_assert_no_error(error);
+        }
+        g_assert(fd >= 0);
 
Quoted 7 lines

tests/acpi-test.c static void test_acpi_ssdt_tables(test_data *data) · line 381

Quoted 2 lines
tests/acpi-test.c +0 -2
-        write(fd, sdt, sizeof(AcpiTableHeader));
-        write(fd, sdt->aml, sdt->aml_len);

Please fix the original patch up and resend the whole series - it's not a good idea to break bisect.

So just smash this patch into the previous one.

It is exactly what I did (and resent the whole series), did I miss anything?

Thanks,
Marcel

Quoted 38 lines
Quoted 37 lines
tests/acpi-test.c +14 -2
+        ret = qemu_write_full(fd, sdt, sizeof(AcpiTableHeader));
+        g_assert(ret == sizeof(AcpiTableHeader));
+        ret = qemu_write_full(fd, sdt->aml, sdt->aml_len);
+        g_assert(ret == sdt->aml_len);
         close(fd);
+
+        if (aml_file) {
+            g_free(aml_file);
+        }
     }
 }
 
@@ -487,7 +506,7 @@ static void test_acpi_asl(test_data *data)
 
     memset(&exp_data, 0, sizeof(exp_data));
     exp_data.ssdt_tables = load_expected_aml(data);
-    dump_aml_files(data);
+    dump_aml_files(data, false);
     for (i = 0; i < data->ssdt_tables->len; ++i) {
         GString *asl, *exp_asl;
 
@@ -553,7 +572,11 @@ static void test_acpi_one(const char *params, test_data *data)
     test_acpi_ssdt_tables(data);
 
     if (iasl) {
-        test_acpi_asl(data);
+        if (getenv(ACPI_REBUILD_EXPECTED_AML)) {
+            dump_aml_files(data, true);
+        } else {
+            test_acpi_asl(data);
+        }
     }
 
     qtest_quit(global_qtest);
Signature · 1 line
1.8.3.1
#5 lore raw

Re: [Qemu-devel] [PATCH v3 2/2] acpi unit-test: hook to rebuild expected aml files

In reply to Michael S. Tsirkin
Quoted 69 lines · Michael S. Tsirkin
Quoted 68 lines · Marcel Apfelbaum

When running the test with TEST_ACPI_REBUILD_AML=y environment variable, the test will rebuild and validate the expected aml files.

---
v2 -> v3:
Addressed Michael S. Tsirkin's comments:
- Used qemu_write_full instead of write
v1 -> v2:
Addressed Michael S. Tsirkin's comments:
- added TEST_ prefix to the environment variable

 tests/acpi-test.c | 37 ++++++++++++++++++++++++++++++-------
 1 file changed, 30 insertions(+), 7 deletions(-)
tests/acpi-test.c +16 -3
index 954d9b9..5aa0a00 100644
@@ -13,6 +13,7 @@
 #include <string.h>
 #include <stdio.h>
 #include <glib.h>
+#include <glib/gstdio.h>
 #include "qemu-common.h"
 #include "libqtest.h"
 #include "qemu/compiler.h"
@@ -21,6 +22,8 @@
 #define MACHINE_PC "pc"
 #define MACHINE_Q35 "q35"
 
+#define ACPI_REBUILD_EXPECTED_AML "TEST_ACPI_REBUILD_AML"
+
 /* DSDT and SSDTs format */
 typedef struct {
     AcpiTableHeader header;
@@ -363,23 +366,39 @@ static void test_acpi_ssdt_tables(test_data *data)
     }
 }
 
-static void dump_aml_files(test_data *data)
+static void dump_aml_files(test_data *data, bool rebuild)
 {
     AcpiSdtTable *sdt;
     GError *error = NULL;
+    gchar *aml_file = NULL;
     gint fd;
     int i;
+    ssize_t ret;
 
     for (i = 0; i < data->ssdt_tables->len; ++i) {
         sdt = &g_array_index(data->ssdt_tables, AcpiSdtTable, i);
         g_assert(sdt->aml);
 
-        fd = g_file_open_tmp("aml-XXXXXX", &sdt->aml_file, &error);
-        g_assert_no_error(error);
+        if (rebuild) {
+            aml_file = g_strdup_printf("%s/%s/%.4s", data_dir, data->machine,
+                                       (gchar *)&sdt->header.signature);
+            fd = g_open(aml_file, O_WRONLY|O_TRUNC|O_CREAT,
+                        S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH);
+        } else {
+            fd = g_file_open_tmp("aml-XXXXXX", &sdt->aml_file, &error);
+            g_assert_no_error(error);
+        }
+        g_assert(fd >= 0);
 
Quoted 5 lines

tests/acpi-test.c static void test_acpi_ssdt_tables(test_data *data) · line 381

Quoted 2 lines
tests/acpi-test.c +0 -2
-        write(fd, sdt, sizeof(AcpiTableHeader));
-        write(fd, sdt->aml, sdt->aml_len);

Please fix the original patch up and resend the whole series - it's not a good idea to break bisect.

I finally understood, the prev series :)
I am sending both of them shortly.

Thanks,
Marcel

Quoted 39 lines

So just smash this patch into the previous one.

Quoted 36 lines
tests/acpi-test.c +14 -2
+        ret = qemu_write_full(fd, sdt, sizeof(AcpiTableHeader));
+        g_assert(ret == sizeof(AcpiTableHeader));
+        ret = qemu_write_full(fd, sdt->aml, sdt->aml_len);
+        g_assert(ret == sdt->aml_len);
         close(fd);
+
+        if (aml_file) {
+            g_free(aml_file);
+        }
     }
 }
 
@@ -487,7 +506,7 @@ static void test_acpi_asl(test_data *data)
 
     memset(&exp_data, 0, sizeof(exp_data));
     exp_data.ssdt_tables = load_expected_aml(data);
-    dump_aml_files(data);
+    dump_aml_files(data, false);
     for (i = 0; i < data->ssdt_tables->len; ++i) {
         GString *asl, *exp_asl;
 
@@ -553,7 +572,11 @@ static void test_acpi_one(const char *params, test_data *data)
     test_acpi_ssdt_tables(data);
 
     if (iasl) {
-        test_acpi_asl(data);
+        if (getenv(ACPI_REBUILD_EXPECTED_AML)) {
+            dump_aml_files(data, true);
+        } else {
+            test_acpi_asl(data);
+        }
     }
 
     qtest_quit(global_qtest);
Signature · 1 line
1.8.3.1