QV8Profiler service
authorChristiaan Janssen <christiaan.janssen@nokia.com>
Tue, 27 Sep 2011 13:38:08 +0000 (15:38 +0200)
committerQt by Nokia <qt-info@nokia.com>
Thu, 6 Oct 2011 12:04:02 +0000 (14:04 +0200)
Expose the v8 profiler API through the declarative debugging
infrastructure. The client side is implemented in Qt Creator.

Change-Id: Idf4f3338d2e6756e7774f0704c0e5c4b35b0ed35
Reviewed-on: http://codereview.qt-project.org/5893
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Kai Koehne <kai.koehne@nokia.com>

src/declarative/debugger/debugger.pri
src/declarative/debugger/qv8profilerservice.cpp [new file with mode: 0644]
src/declarative/debugger/qv8profilerservice_p.h [new file with mode: 0644]
src/declarative/qml/qdeclarativeengine.cpp
src/declarative/qml/v8/qv8profiler_p.h [new file with mode: 0644]
src/declarative/qml/v8/v8.pri

index a257da2..7bfb5a1 100644 (file)
@@ -11,6 +11,7 @@ SOURCES += \
     $$PWD/qdeclarativedebugserver.cpp \
     $$PWD/qdeclarativeinspectorservice.cpp \
     $$PWD/qv8debugservice.cpp \
+    $$PWD/qv8profilerservice.cpp \
     $$PWD/qdeclarativeenginedebugservice.cpp
 
 HEADERS += \
@@ -27,5 +28,6 @@ HEADERS += \
     $$PWD/qdeclarativeinspectorservice_p.h \
     $$PWD/qdeclarativeinspectorinterface_p.h \
     $$PWD/qv8debugservice_p.h \
+    $$PWD/qv8profilerservice_p.h \
     $$PWD/qdeclarativeenginedebugservice_p.h \
     $$PWD/qdeclarativedebug.h
diff --git a/src/declarative/debugger/qv8profilerservice.cpp b/src/declarative/debugger/qv8profilerservice.cpp
new file mode 100644 (file)
index 0000000..83bb700
--- /dev/null
@@ -0,0 +1,252 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtDeclarative module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this
+** file. Please review the following information to ensure the GNU Lesser
+** General Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qv8profilerservice_p.h"
+#include "qdeclarativedebugservice_p_p.h"
+#include "qdeclarativeengine_p.h"
+#include "private/qv8profiler_p.h"
+#include "qjsconverter_p.h"
+
+#include <QtCore/QHash>
+
+QT_BEGIN_NAMESPACE
+
+Q_GLOBAL_STATIC(QV8ProfilerService, v8ServiceInstance)
+
+class ByteArrayOutputStream : public v8::OutputStream
+{
+    QByteArray *_buffer;
+public:
+    ByteArrayOutputStream(QByteArray *buffer)
+        : v8::OutputStream(),
+          _buffer(buffer) {}
+    void EndOfStream() {}
+    WriteResult WriteAsciiChunk(char *data, int size)
+    {
+        QByteArray b(data, size);
+        _buffer->append(b);
+        return kContinue;
+    }
+};
+
+// convert to a QByteArray that can be sent to the debug client
+QByteArray QV8ProfilerData::toByteArray() const
+{
+    QByteArray data;
+    //### using QDataStream is relatively expensive
+    QDataStream ds(&data, QIODevice::WriteOnly);
+    ds << messageType << filename << functionname << lineNumber << totalTime << selfTime << treeLevel;
+
+    return data;
+}
+
+class QV8ProfilerServicePrivate : public QDeclarativeDebugServicePrivate
+{
+    Q_DECLARE_PUBLIC(QV8ProfilerService)
+
+public:
+    QV8ProfilerServicePrivate()
+        :initialized(false)
+    {
+    }
+
+    void takeSnapshot(v8::HeapSnapshot::Type);
+
+    void printProfileTree(const v8::CpuProfileNode *node, int level = 0);
+    void sendMessages();
+
+    QList<QV8ProfilerData> m_data;
+
+    bool initialized;
+    QList<QDeclarativeEngine *> engines;
+};
+
+QV8ProfilerService::QV8ProfilerService(QObject *parent)
+    : QDeclarativeDebugService(*(new QV8ProfilerServicePrivate()), QLatin1String("V8Profiler"), parent)
+{
+    Q_D(QV8ProfilerService);
+    if (status() == Enabled) {
+        // ,block mode, client attached
+        while (!d->initialized)
+            waitForMessage();
+    }
+}
+
+QV8ProfilerService::~QV8ProfilerService()
+{
+}
+
+QV8ProfilerService *QV8ProfilerService::instance()
+{
+    return v8ServiceInstance();
+}
+
+void QV8ProfilerService::addEngine(QDeclarativeEngine *engine)
+{
+    Q_D(QV8ProfilerService);
+    Q_ASSERT(engine);
+    Q_ASSERT(!d->engines.contains(engine));
+
+    d->engines.append(engine);
+}
+
+void QV8ProfilerService::removeEngine(QDeclarativeEngine *engine)
+{
+    Q_D(QV8ProfilerService);
+    Q_ASSERT(engine);
+    Q_ASSERT(d->engines.contains(engine));
+
+    d->engines.removeOne(engine);
+}
+
+void QV8ProfilerService::messageReceived(const QByteArray &message)
+{
+    Q_D(QV8ProfilerService);
+
+    QDataStream ds(message);
+    QByteArray command;
+    QByteArray option;
+    QByteArray title;
+    ds >> command >> option;
+
+    if (command == "V8PROFILER") {
+        ds >>  title;
+        if (option == "start") {
+            d->initialized = true;
+            startProfiling(QString::fromUtf8(title));
+        } else if (option == "stop") {
+            stopProfiling(QString::fromUtf8(title));
+            // Send messages to client
+            d->sendMessages();
+        }
+    }
+
+    if (command == "V8SNAPSHOT") {
+            QByteArray snapshotType;
+            ds >> snapshotType;
+
+            if (snapshotType == "aggregated")
+                d->takeSnapshot(v8::HeapSnapshot::kAggregated);
+            else if (snapshotType == "full")
+                d->takeSnapshot(v8::HeapSnapshot::kFull);
+        } else if (command == "deletesnapshots") {
+            v8::HeapProfiler::DeleteAllSnapshots();
+        }
+
+    QDeclarativeDebugService::messageReceived(message);
+}
+
+void QV8ProfilerService::startProfiling(const QString &title)
+{
+    // Start Profiling
+    v8::HandleScope handle_scope;
+    v8::Handle<v8::String> v8title = v8::String::New(reinterpret_cast<const uint16_t*>(title.data()), title.size());
+    v8::CpuProfiler::StartProfiling(v8title);
+}
+
+void QV8ProfilerService::stopProfiling(const QString &title)
+{
+    Q_D(QV8ProfilerService);
+    // Stop profiling
+    v8::HandleScope handle_scope;
+    v8::Handle<v8::String> v8title = v8::String::New(reinterpret_cast<const uint16_t*>(title.data()), title.size());
+    const v8::CpuProfile *cpuProfile = v8::CpuProfiler::StopProfiling(v8title);
+    const v8::CpuProfileNode *rootNode = cpuProfile->GetTopDownRoot();
+
+    d->printProfileTree(rootNode);
+}
+
+void QV8ProfilerServicePrivate::printProfileTree(const v8::CpuProfileNode *node, int level)
+{
+    for (int index = 0 ; index < node->GetChildrenCount() ; index++) {
+        const v8::CpuProfileNode* childNode = node->GetChild(index);
+        if (QV8Engine::toStringStatic(childNode->GetScriptResourceName()).length() > 0) {
+
+            QV8ProfilerData rd = {(int)QV8ProfilerService::V8Entry, QV8Engine::toStringStatic(childNode->GetScriptResourceName()),
+                QV8Engine::toStringStatic(childNode->GetFunctionName()),
+                childNode->GetLineNumber(), childNode->GetTotalTime(), childNode->GetSelfTime(), level};
+            m_data.append(rd);
+
+            // different nodes might have common children: fix at client side
+            if (childNode->GetChildrenCount() > 0) {
+                printProfileTree(childNode, level+1);
+            }
+        }
+    }
+}
+
+void QV8ProfilerServicePrivate::takeSnapshot(v8::HeapSnapshot::Type snapshotType)
+{
+    Q_Q(QV8ProfilerService);
+
+    v8::HandleScope scope;
+    v8::Local<v8::String> title = v8::String::New("");
+
+    const v8::HeapSnapshot *snapshot = v8::HeapProfiler::TakeSnapshot(title, snapshotType);
+
+    QByteArray data;
+    QDataStream ds(&data, QIODevice::WriteOnly);
+    ds << (int)QV8ProfilerService::V8Snapshot;
+
+    ByteArrayOutputStream bos(&data);
+    snapshot->Serialize(&bos, v8::HeapSnapshot::kJSON);
+
+    q->sendMessage(data);
+}
+
+void QV8ProfilerServicePrivate::sendMessages()
+{
+    Q_Q(QV8ProfilerService);
+
+    for (int i = 0; i < m_data.count(); ++i)
+        q->sendMessage(m_data.at(i).toByteArray());
+    m_data.clear();
+
+    //indicate completion
+    QByteArray data;
+    QDataStream ds(&data, QIODevice::WriteOnly);
+    ds << (int)QV8ProfilerService::V8Complete;
+
+    q->sendMessage(data);
+}
+
+
+QT_END_NAMESPACE
diff --git a/src/declarative/debugger/qv8profilerservice_p.h b/src/declarative/debugger/qv8profilerservice_p.h
new file mode 100644 (file)
index 0000000..1e912d0
--- /dev/null
@@ -0,0 +1,115 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtDeclarative module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this
+** file. Please review the following information to ensure the GNU Lesser
+** General Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QV8PROFILERSERVICE_P_H
+#define QV8PROFILERSERVICE_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include "private/qdeclarativedebugservice_p.h"
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+QT_MODULE(Declarative)
+
+struct QV8ProfilerData
+{
+    int messageType;
+    QString filename;
+    QString functionname;
+    int lineNumber;
+    double totalTime;
+    double selfTime;
+    int treeLevel;
+
+    QByteArray toByteArray() const;
+};
+
+class QDeclarativeEngine;
+class QV8ProfilerServicePrivate;
+
+class QV8ProfilerService : public QDeclarativeDebugService
+{
+    Q_OBJECT
+public:
+    enum MessageType {
+        V8Entry,
+        V8Complete,
+        V8Snapshot,
+
+        V8MaximumMessage
+    };
+
+    QV8ProfilerService(QObject *parent = 0);
+    ~QV8ProfilerService();
+
+    static QV8ProfilerService *instance();
+
+    void addEngine(QDeclarativeEngine *);
+    void removeEngine(QDeclarativeEngine *);
+
+    void startProfiling(const QString &title);
+    void stopProfiling(const QString &title);
+
+protected:
+    void messageReceived(const QByteArray &);
+
+private:
+    Q_DISABLE_COPY(QV8ProfilerService)
+    Q_DECLARE_PRIVATE(QV8ProfilerService)
+};
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif // QV8PROFILERSERVICE_P_H
index 3f283bd..96c3989 100644 (file)
@@ -69,6 +69,7 @@
 #include "private/qdeclarativeapplication_p.h"
 #include "private/qv8debugservice_p.h"
 #include "qdeclarativeincubator.h"
+#include "private/qv8profilerservice_p.h"
 
 #include <QtCore/qmetaobject.h>
 #include <QNetworkAccessManager>
@@ -436,6 +437,7 @@ void QDeclarativeEnginePrivate::init()
         isDebugging = true;
         QDeclarativeEngineDebugService::instance()->addEngine(q);
         QV8DebugService::instance()->addEngine(q);
+        QV8ProfilerService::instance()->addEngine(q);
     }
 }
 
@@ -498,8 +500,10 @@ QDeclarativeEngine::QDeclarativeEngine(QObject *parent)
 QDeclarativeEngine::~QDeclarativeEngine()
 {
     Q_D(QDeclarativeEngine);
-    if (d->isDebugging)
+    if (d->isDebugging) {
         QDeclarativeEngineDebugService::instance()->remEngine(this);
+        QV8ProfilerService::instance()->removeEngine(this);
+    }
 
     // if we are the parent of any of the qobject module api instances,
     // we need to remove them from our internal list, in order to prevent
diff --git a/src/declarative/qml/v8/qv8profiler_p.h b/src/declarative/qml/v8/qv8profiler_p.h
new file mode 100644 (file)
index 0000000..a36eb07
--- /dev/null
@@ -0,0 +1,42 @@
+/****************************************************************************
+**
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtDeclarative module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this
+** file. Please review the following information to ensure the GNU Lesser
+** General Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <private/v8-profiler.h>
index e74265e..104f34f 100644 (file)
@@ -6,6 +6,7 @@ include(script.pri)
 HEADERS += \
     $$PWD/qv8_p.h \
     $$PWD/qv8debug_p.h \
+    $$PWD/qv8profiler_p.h \
     $$PWD/qv8stringwrapper_p.h \
     $$PWD/qv8engine_p.h \
     $$PWD/qv8gccallback_p.h \