Added basic support for saving compilation units to disk

Hidden behind a QML_DISK_CACHE=1 environment variable we will now attempt to
save a binary representation of the type compilation for Foo.qml next to it called
Foo.qmlc.

Change-Id: I27e800b50cdb186669256fd277578ea1f1e70513
Reviewed-by: Lars Knoll <lars.knoll@qt.io>

2 files changed, 189 insertions, 0 deletions

diff --git a/tests/auto/qml/qmldiskcache/qmldiskcache.pro b/tests/auto/qml/qmldiskcache/qmldiskcache.pro
new file mode 100644
index 0000000000..f2d1a04780
--- /dev/null
+++ b/tests/auto/qml/qmldiskcache/qmldiskcache.pro
@@ -0,0 +1,7 @@
+CONFIG += testcase
+TARGET = tst_qmldiskcache
+osx:CONFIG -= app_bundle
+
+SOURCES += tst_qmldiskcache.cpp
+
+QT += core-private qml-private testlib
diff --git a/tests/auto/qml/qmldiskcache/tst_qmldiskcache.cpp b/tests/auto/qml/qmldiskcache/tst_qmldiskcache.cpp
new file mode 100644
index 0000000000..edab49e4be
--- /dev/null
+++ b/tests/auto/qml/qmldiskcache/tst_qmldiskcache.cpp
@@ -0,0 +1,182 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <qtest.h>
+
+#include <private/qv4compileddata_p.h>
+#include <QQmlComponent>
+#include <QQmlEngine>
+
+class tst_qmldiskcache: public QObject
+{
+    Q_OBJECT
+
+private slots:
+    void initTestCase();
+
+    void regenerateAfterChange();
+};
+
+struct TestCompiler
+{
+    TestCompiler(QQmlEngine *engine)
+        : engine(engine)
+        , tempDir()
+        , testFilePath(tempDir.path() + QStringLiteral("/test.qml"))
+        , cacheFilePath(tempDir.path() + QStringLiteral("/test.qmlc"))
+        , mappedFile(cacheFilePath)
+        , currentMapping(nullptr)
+    {
+    }
+
+    bool compile(const QByteArray &contents)
+    {
+        if (currentMapping) {
+            mappedFile.unmap(currentMapping);
+            currentMapping = nullptr;
+        }
+        mappedFile.close();
+
+        {
+            QFile f(testFilePath);
+            if (!f.open(QIODevice::WriteOnly | QIODevice::Truncate)) {
+                lastErrorString = f.errorString();
+                return false;
+            }
+            if (f.write(contents) != contents.size()) {
+                lastErrorString = f.errorString();
+                return false;
+            }
+        }
+
+        QQmlComponent component(engine, testFilePath);
+        if (!component.isReady()) {
+            lastErrorString = component.errorString();
+            return false;
+        }
+
+        return true;
+    }
+
+    const QV4::CompiledData::Unit *mapUnit()
+    {
+        if (!mappedFile.open(QIODevice::ReadOnly)) {
+            lastErrorString = mappedFile.errorString();
+            return nullptr;
+        }
+
+        currentMapping = mappedFile.map(/*offset*/0, mappedFile.size());
+        if (!currentMapping) {
+            lastErrorString = mappedFile.errorString();
+            return nullptr;
+        }
+        QV4::CompiledData::Unit *unitPtr;
+        memcpy(&unitPtr, &currentMapping, sizeof(unitPtr));
+        return unitPtr;
+    }
+
+    QQmlEngine *engine;
+    const QTemporaryDir tempDir;
+    const QString testFilePath;
+    const QString cacheFilePath;
+    QString lastErrorString;
+    QFile mappedFile;
+    uchar *currentMapping;
+};
+
+void tst_qmldiskcache::initTestCase()
+{
+    qputenv("QML_DISK_CACHE", "1");
+}
+
+void tst_qmldiskcache::regenerateAfterChange()
+{
+    QQmlEngine engine;
+    TestCompiler testCompiler(&engine);
+
+    QVERIFY(testCompiler.tempDir.isValid());
+
+    const QByteArray contents = QByteArrayLiteral("import QtQml 2.0\n"
+                                                  "QtObject {\n"
+                                                   "    property string blah: Qt.platform;\n"
+                                                   "}");
+
+    QVERIFY2(testCompiler.compile(contents), qPrintable(testCompiler.lastErrorString));
+
+#ifdef V4_ENABLE_JIT
+    {
+        const QV4::CompiledData::Unit *testUnit = testCompiler.mapUnit();
+        QVERIFY2(testUnit, qPrintable(testCompiler.lastErrorString));
+
+        QCOMPARE(testUnit->nObjects, quint32(1));
+
+        const QV4::CompiledData::Object *obj = testUnit->objectAt(0);
+        QCOMPARE(obj->nBindings, quint32(1));
+        QCOMPARE(obj->bindingTable()->type, quint32(QV4::CompiledData::Binding::Type_Script));
+        QCOMPARE(obj->bindingTable()->value.compiledScriptIndex, quint32(1));
+
+        QCOMPARE(testUnit->functionTableSize, quint32(2));
+
+        const QV4::CompiledData::Function *bindingFunction = testUnit->functionAt(1);
+        QVERIFY(bindingFunction->codeOffset > testUnit->unitSize);
+    }
+#else
+    QVERIFY(!testCompiler.mapUnit());
+    return;
+#endif
+
+    engine.clearComponentCache();
+
+    {
+        const QByteArray newContents = QByteArrayLiteral("import QtQml 2.0\n"
+                                                         "QtObject {\n"
+                                                         "    property string blah: Qt.platform;\n"
+                                                         "    property int secondProperty: 42;\n"
+                                                         "}");
+
+        QVERIFY2(testCompiler.compile(newContents), qPrintable(testCompiler.lastErrorString));
+        const QV4::CompiledData::Unit *testUnit = testCompiler.mapUnit();
+        QVERIFY2(testUnit, qPrintable(testCompiler.lastErrorString));
+
+        QCOMPARE(testUnit->nObjects, quint32(1));
+
+        const QV4::CompiledData::Object *obj = testUnit->objectAt(0);
+        QCOMPARE(obj->nBindings, quint32(2));
+        QCOMPARE(obj->bindingTable()->type, quint32(QV4::CompiledData::Binding::Type_Number));
+        QCOMPARE(obj->bindingTable()->value.d, double(42));
+
+        QCOMPARE(testUnit->functionTableSize, quint32(2));
+
+        const QV4::CompiledData::Function *bindingFunction = testUnit->functionAt(1);
+        QVERIFY(bindingFunction->codeOffset > testUnit->unitSize);
+    }
+}
+
+QTEST_MAIN(tst_qmldiskcache)
+
+#include "tst_qmldiskcache.moc"