path: root/src/qml/debugger/qqmlprofilerservice_p.h

/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtQml module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, 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, Digia gives you certain additional
** rights.  These rights are described in the Digia 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.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QQMLPROFILERSERVICE_P_H
#define QQMLPROFILERSERVICE_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/qqmldebugservice_p.h>
#include <private/qqmlboundsignal_p.h>

#include <QtCore/qelapsedtimer.h>
#include <QtCore/qmetaobject.h>
#include <QtCore/qmutex.h>
#include <QtCore/qvector.h>
#include <QtCore/qstringbuilder.h>
#include <QtCore/qwaitcondition.h>


QT_BEGIN_NAMESPACE

struct Q_AUTOTEST_EXPORT QQmlProfilerData
{
    qint64 time;
    int messageType;
    int detailType;

    //###
    QString detailData; //used by RangeData and RangeLocation
    int line;           //used by RangeLocation, also as "width" for pixmaps
    int column;         //used by RangeLocation, also as "height" for pixmaps
    int framerate;      //used by animation events
    int animationcount; //used by animation events, also as "cache/reference count" for pixmaps
    int bindingType;

    qint64 subtime_1;
    qint64 subtime_2;
    qint64 subtime_3;
    qint64 subtime_4;
    qint64 subtime_5;

    QByteArray toByteArray() const;
};

Q_DECLARE_TYPEINFO(QQmlProfilerData, Q_MOVABLE_TYPE);

class QUrl;
class QQmlEngine;


class Q_QML_PRIVATE_EXPORT QQmlProfilerService : public QQmlDebugService
{
public:
    enum Message {
        Event,
        RangeStart,
        RangeData,
        RangeLocation,
        RangeEnd,
        Complete, // end of transmission
        PixmapCacheEvent,
        SceneGraphFrame,

        MaximumMessage
    };

    enum EventType {
        FramePaint,
        Mouse,
        Key,
        AnimationFrame,
        EndTrace,
        StartTrace,

        MaximumEventType
    };

    enum RangeType {
        Painting,
        Compiling,
        Creating,
        Binding,            //running a binding
        HandlingSignal,     //running a signal handler

        MaximumRangeType
    };

    enum BindingType {
        QmlBinding,
        V8Binding,
        V4Binding,

        MaximumBindingType
    };

    enum PixmapEventType {
        PixmapSizeKnown,
        PixmapReferenceCountChanged,
        PixmapCacheCountChanged,
        PixmapLoadingStarted,
        PixmapLoadingFinished,
        PixmapLoadingError,

        MaximumPixmapEventType
    };

    enum SceneGraphFrameType {
        SceneGraphRendererFrame,
        SceneGraphAdaptationLayerFrame,
        SceneGraphContextFrame,
        SceneGraphRenderLoopFrame,
        SceneGraphTexturePrepare,
        SceneGraphTextureDeletion,
        SceneGraphPolishAndSync,
        SceneGraphWindowsRenderShow,
        SceneGraphWindowsAnimations,
        SceneGraphWindowsPolishFrame,

        MaximumSceneGraphFrameType
    };

    static void initialize();

    static bool startProfiling();
    static bool stopProfiling();
    static void sendStartedProfilingMessage();
    static bool profilingEnabled();

    static void addEvent(EventType);
    static void animationFrame(qint64);

    static void sceneGraphFrame(SceneGraphFrameType frameType, qint64 value1, qint64 value2 = -1, qint64 value3 = -1, qint64 value4 = -1, qint64 value5 = -1);
    static void sendProfilingData();

    QQmlProfilerService();
    ~QQmlProfilerService();

protected:
    virtual void stateAboutToBeChanged(State state);
    virtual void messageReceived(const QByteArray &);

private:
    bool startProfilingImpl();
    bool stopProfilingImpl();
    void sendStartedProfilingMessageImpl();
    void addEventImpl(EventType);
    void animationFrameImpl(qint64);

    void startRange(RangeType, BindingType bindingType = QmlBinding);
    void rangeData(RangeType, const QString &);
    void rangeData(RangeType, const QUrl &);
    void rangeLocation(RangeType, const QString &, int, int);
    void rangeLocation(RangeType, const QUrl &, int, int);
    void endRange(RangeType);

    // overloading depending on parameters
    void pixmapEventImpl(PixmapEventType eventType, const QUrl &url);
    void pixmapEventImpl(PixmapEventType eventType, const QUrl &url, int width, int height);
    void pixmapEventImpl(PixmapEventType eventType, const QUrl &url, int count);

    void sceneGraphFrameImpl(SceneGraphFrameType frameType, qint64 value1, qint64 value2, qint64 value3, qint64 value4, qint64 value5);


    void setProfilingEnabled(bool enable);
    void sendMessages();
    void processMessage(const QQmlProfilerData &);

public:
    static bool enabled;
private:
    QElapsedTimer m_timer;
    QVector<QQmlProfilerData> m_data;
    QMutex m_dataMutex;
    QMutex m_initializeMutex;
    QWaitCondition m_initializeCondition;

    static QQmlProfilerService *instance;

    friend struct QQmlBindingProfiler;
    friend struct QQmlHandlingSignalProfiler;
    friend struct QQmlVmeProfiler;
    friend struct QQmlCompilingProfiler;
    friend struct QQmlPixmapProfiler;
};

//
// RAII helper structs
//

struct QQmlBindingProfiler {
    QQmlBindingProfiler(const QString &url, int line, int column, QQmlProfilerService::BindingType bindingType)
    {
        if (QQmlProfilerService::enabled) {
            QQmlProfilerService::instance->startRange(QQmlProfilerService::Binding, bindingType);
            QQmlProfilerService::instance->rangeLocation(QQmlProfilerService::Binding, url, line, column);
        }
    }

    ~QQmlBindingProfiler()
    {
        if (QQmlProfilerService::enabled)
            QQmlProfilerService::instance->endRange(QQmlProfilerService::Binding);
    }
};

struct QQmlHandlingSignalProfiler {
    QQmlHandlingSignalProfiler(QQmlBoundSignalExpression *expression)
    {
        if (QQmlProfilerService::enabled) {
            QQmlProfilerService::instance->startRange(QQmlProfilerService::HandlingSignal);
            QQmlProfilerService::instance->rangeLocation(QQmlProfilerService::HandlingSignal,
                                   expression->sourceFile(), expression->lineNumber(),
                                   expression->columnNumber());
        }
    }

    ~QQmlHandlingSignalProfiler()
    {
        if (QQmlProfilerService::enabled)
            QQmlProfilerService::instance->endRange(QQmlProfilerService::HandlingSignal);
    }
};

struct QQmlCompilingProfiler {
    QQmlCompilingProfiler(const QString &name)
    {
        if (QQmlProfilerService::enabled) {
            QQmlProfilerService::instance->startRange(QQmlProfilerService::Compiling);
            QQmlProfilerService::instance->rangeLocation(QQmlProfilerService::Compiling, name, 1, 1);
            QQmlProfilerService::instance->rangeData(QQmlProfilerService::Compiling, name);
        }
    }

    ~QQmlCompilingProfiler()
    {
        if (QQmlProfilerService::enabled)
            QQmlProfilerService::instance->endRange(QQmlProfilerService::Compiling);
    }
};

struct QQmlVmeProfiler {
public:

    struct Data {
        Data() : line(0), column(0) {}
        QUrl url;
        int line;
        int column;
        QString typeName;
        void clear()
        {
            url.clear();
            line = 0;
            column = 0;
            typeName.clear();
        }
    };

    QQmlVmeProfiler() :
        running(false)
    {}

    ~QQmlVmeProfiler()
    {
        if (QQmlProfilerService::enabled)
            clear();
    }

    void clear()
    {
        stop();
        ranges.clear();
        if (QQmlProfilerService::enabled) {
            for (int i = 0; i < backgroundRanges.count(); ++i) {
                QQmlProfilerService::instance->endRange(QQmlProfilerService::Creating);
            }
        }
        backgroundRanges.clear();
        running = false;
    }

    bool start()
    {
        if (QQmlProfilerService::enabled) {
            currentRange.clear();
            if (running)
                QQmlProfilerService::instance->endRange(QQmlProfilerService::Creating);
            else
                running = true;
            QQmlProfilerService::instance->startRange(QQmlProfilerService::Creating);
            return true;
        }
        return false;
    }

    void stop()
    {
        if (QQmlProfilerService::enabled && running) {
            QQmlProfilerService::instance->endRange(QQmlProfilerService::Creating);
            currentRange.clear();
            running = false;
        }
    }

    void updateLocation(const QUrl &url, int line, int column)
    {
        if (QQmlProfilerService::enabled && running) {
            currentRange.url = url;
            currentRange.line = line;
            currentRange.column = column;
            QQmlProfilerService::instance->rangeLocation(
                    QQmlProfilerService::Creating, url, line, column);
        }
    }

    void updateTypeName(const QString &typeName)
    {
        if (QQmlProfilerService::enabled && running) {
            currentRange.typeName = typeName;
            QQmlProfilerService::instance->rangeData(QQmlProfilerService::Creating, typeName);
        }
    }

    bool pop()
    {
        if (QQmlProfilerService::enabled && ranges.count() > 0) {
            start();
            currentRange = ranges.pop();
            QQmlProfilerService::instance->rangeLocation(
                    QQmlProfilerService::Creating, currentRange.url, currentRange.line, currentRange.column);
            QQmlProfilerService::instance->rangeData(QQmlProfilerService::Creating, currentRange.typeName);
            return true;
        }
        return false;
    }

    void push()
    {
        if (QQmlProfilerService::enabled && running)
            ranges.push(currentRange);
    }

    void background()
    {
        if (QQmlProfilerService::enabled && running) {
            backgroundRanges.push(currentRange);
            running = false;
        }
    }

    bool foreground()
    {
        if (QQmlProfilerService::enabled && backgroundRanges.count() > 0) {
            stop();
            currentRange = backgroundRanges.pop();
            running = true;
            return true;
        }
        return false;
    }

private:

    Data currentRange;
    QStack<Data> ranges;
    QStack<Data> backgroundRanges;
    bool running;
};

struct QQmlPixmapProfiler {
    void startLoading(const QUrl &pixmapUrl) {
        if (QQmlProfilerService::enabled) {
            QQmlProfilerService::instance->pixmapEventImpl(QQmlProfilerService::PixmapLoadingStarted, pixmapUrl);
        }
    }
    void finishLoading(const QUrl &pixmapUrl) {
        if (QQmlProfilerService::enabled) {
            QQmlProfilerService::instance->pixmapEventImpl(QQmlProfilerService::PixmapLoadingFinished, pixmapUrl);
        }
    }
    void errorLoading(const QUrl &pixmapUrl) {
        if (QQmlProfilerService::enabled) {
            QQmlProfilerService::instance->pixmapEventImpl(QQmlProfilerService::PixmapLoadingError, pixmapUrl);
        }
    }
    void cacheCountChanged(const QUrl &pixmapUrl, int cacheCount) {
        if (QQmlProfilerService::enabled) {
            QQmlProfilerService::instance->pixmapEventImpl(QQmlProfilerService::PixmapCacheCountChanged, pixmapUrl, cacheCount);
        }
    }
    void referenceCountChanged(const QUrl &pixmapUrl, int referenceCount) {
        if (QQmlProfilerService::enabled) {
            QQmlProfilerService::instance->pixmapEventImpl(QQmlProfilerService::PixmapReferenceCountChanged, pixmapUrl, referenceCount);
        }
    }
    void setSize(const QUrl &pixmapUrl, const QSize &size) {
        if (QQmlProfilerService::enabled && size.width() > 0) {
            QQmlProfilerService::instance->pixmapEventImpl(QQmlProfilerService::PixmapSizeKnown, pixmapUrl, size.width(), size.height());
        }
    }
};

QT_END_NAMESPACE

#endif // QQMLPROFILERSERVICE_P_H