QDeclarativeTrace patch for a custom trace instance

Needed for the BB10 Cascades profiling. There are more reasons for
introducing this patch:

1) Cascades do not use QtGui library for QML rendering. It has its own
paint engine with client-server architecture. Profiler traces are sent
asynchronously from non Qt renderer thread to the Qt client.
The QPerformanceTimer has to be patched too, cause we need to know time
difference between tracing zero time and some time in past,
see: qint64 QPerformanceTimer::elapsed(qint64 to_monotonic_time_ns) const

2) Since we need more sophisticated trace engine in cascades, this patch
allows explicitly assign custom class derived from QDeclaraqtiveDebugtrace
to the trace framework.
If no custom instance is assigned, the default QDeclarativeDebugTrace
instance is created implicitly on first trace request.
Using custom trace instance which is not part of Qt
(it is part of libbbcascades) allows us to implement all Cascades trace
special needs in libbbcascades and not to carry Qt with the platform
specific code.

3) The NO_CUSTOM_DECLARATIVE_DEBUG_TRACE_INSTANCE macro is introduced to
allow custom trace engine only on the bleckberry platform,
see declarative.pro.
If this macro is defined Qt compiles from its original code.

4) Possibility of custom QDeclaraqtiveDebugTrace instance might be usable
for other projects which needs to extends somehow default Qt trace
functionality.

5) Patch is not intended to be applied to Qt Quick 2, since declarative
debugging infrastructure is changed there.

Change-Id: I199211c1de66e930e252e8c033503d7f4940565f
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
Reviewed-by: Christiaan Janssen <christiaan.janssen@digia.com>

5 files changed, 113 insertions, 4 deletions

diff --git a/src/declarative/debugger/qdeclarativedebugtrace.cpp b/src/declarative/debugger/qdeclarativedebugtrace.cpp
index d6bb5f88..366c8c57 100644
--- a/src/declarative/debugger/qdeclarativedebugtrace.cpp
+++ b/src/declarative/debugger/qdeclarativedebugtrace.cpp
@@ -44,8 +44,68 @@
 #include <QtCore/qdatastream.h>
 #include <QtCore/qurl.h>
 #include <QtCore/qtimer.h>
+#include <QDebug>
+
+#ifdef CUSTOM_DECLARATIVE_DEBUG_TRACE_INSTANCE
+
+namespace {
+
+    class GlobalInstanceDeleter
+    {
+    private:
+        QBasicAtomicPointer<QDeclarativeDebugTrace> &m_pointer;
+    public:
+        GlobalInstanceDeleter(QBasicAtomicPointer<QDeclarativeDebugTrace> &p)
+        : m_pointer(p)
+        {}
+        ~GlobalInstanceDeleter()
+        {
+            delete m_pointer.load();
+            m_pointer.store(0);
+        }
+    };
+
+    QBasicAtomicPointer<QDeclarativeDebugTrace> s_globalInstance = Q_BASIC_ATOMIC_INITIALIZER(0);
+}
+
+
+static QDeclarativeDebugTrace *traceInstance()
+{
+    return QDeclarativeDebugTrace::globalInstance();
+}
+
+QDeclarativeDebugTrace *QDeclarativeDebugTrace::globalInstance()
+{
+    if (!s_globalInstance.load()) {
+        // create default QDeclarativeDebugTrace instance if it is not explicitly set by setGlobalInstance(QDeclarativeDebugTrace *instance)
+        // thread safe implementation
+        QDeclarativeDebugTrace *x = new QDeclarativeDebugTrace();
+        if (!s_globalInstance.testAndSetOrdered(0, x))
+            delete x;
+        else
+            static GlobalInstanceDeleter cleanup(s_globalInstance);
+    }
+    return s_globalInstance.load();
+}
+
+/*!
+ *  Set custom QDeclarativeDebugTrace instance \a custom_instance.
+ *  Function fails if QDeclarativeDebugTrace::globalInstance() was called before.
+ *  QDeclarativeDebugTrace framework takes ownership of the custom instance.
+ */
+void QDeclarativeDebugTrace::setGlobalInstance(QDeclarativeDebugTrace *custom_instance)
+{
+    if (!s_globalInstance.testAndSetOrdered(0, custom_instance)) {
+        qWarning() << "QDeclarativeDebugTrace::setGlobalInstance() - instance already set.";
+        delete custom_instance;
+    } else {
+        static GlobalInstanceDeleter cleanup(s_globalInstance);
+    }
+}
 
+#else // CUSTOM_DECLARATIVE_DEBUG_TRACE_INSTANCE
 Q_GLOBAL_STATIC(QDeclarativeDebugTrace, traceInstance);
+#endif
 
 // convert to a QByteArray that can be sent to the debug client
 // use of QDataStream can skew results if m_deferredSend == false
diff --git a/src/declarative/debugger/qdeclarativedebugtrace_p.h b/src/declarative/debugger/qdeclarativedebugtrace_p.h
index f4d6c18b..dfd478b0 100644
--- a/src/declarative/debugger/qdeclarativedebugtrace_p.h
+++ b/src/declarative/debugger/qdeclarativedebugtrace_p.h
@@ -42,6 +42,8 @@
 #ifndef QDECLARATIVEDEBUGTRACE_P_H
 #define QDECLARATIVEDEBUGTRACE_P_H
 
+#include "qtquick1global.h"
+
 #include <private/qdeclarativedebugservice_p.h>
 #include <private/qperformancetimer_p.h>
 
@@ -63,7 +65,7 @@ struct QDeclarativeDebugData
 };
 
 class QUrl;
-class Q_AUTOTEST_EXPORT QDeclarativeDebugTrace : public QDeclarativeDebugService
+class Q_QUICK1_EXPORT QDeclarativeDebugTrace : public QDeclarativeDebugService
 {
 public:
     enum Message {
@@ -105,6 +107,21 @@ public:
     static void endRange(RangeType);
 
     QDeclarativeDebugTrace();
+#ifdef CUSTOM_DECLARATIVE_DEBUG_TRACE_INSTANCE
+public:
+    static QDeclarativeDebugTrace* globalInstance();
+    static void setGlobalInstance(QDeclarativeDebugTrace *custom_instance);
+protected:
+    virtual void messageReceived(const QByteArray &);
+protected:
+    virtual void addEventImpl(EventType);
+    virtual void startRangeImpl(RangeType);
+    virtual void rangeDataImpl(RangeType, const QString &);
+    virtual void rangeDataImpl(RangeType, const QUrl &);
+    virtual void rangeLocationImpl(RangeType, const QString &, int);
+    virtual void rangeLocationImpl(RangeType, const QUrl &, int);
+    virtual void endRangeImpl(RangeType);
+#else
 protected:
     virtual void messageReceived(const QByteArray &);
 private:
@@ -115,6 +132,7 @@ private:
     void rangeLocationImpl(RangeType, const QString &, int);
     void rangeLocationImpl(RangeType, const QUrl &, int);
     void endRangeImpl(RangeType);
+#endif
     void processMessage(const QDeclarativeDebugData &);
     void sendMessages();
     QPerformanceTimer m_timer;
diff --git a/src/declarative/declarative.pro b/src/declarative/declarative.pro
index 896aec03..7c3d38f1 100644
--- a/src/declarative/declarative.pro
+++ b/src/declarative/declarative.pro
@@ -31,3 +31,6 @@ linux-g++-maemo:DEFINES += QDECLARATIVEVIEW_NOBACKGROUND
 DEFINES += QT_NO_OPENTYPE
 INCLUDEPATH += ../3rdparty/harfbuzz/src
 
+blackberry: {
+    DEFINES   += CUSTOM_DECLARATIVE_DEBUG_TRACE_INSTANCE
+}
diff --git a/src/declarative/qml/qperformancetimer.cpp b/src/declarative/qml/qperformancetimer.cpp
index b7c2f47c..9e2e0734 100644
--- a/src/declarative/qml/qperformancetimer.cpp
+++ b/src/declarative/qml/qperformancetimer.cpp
@@ -80,6 +80,13 @@ qint64 QPerformanceTimer::elapsed() const
     return absoluteToNSecs(cpu_time - t1);
 }
 
+// return number of nsecs elapsed from timer start time till absoluteMonotonicTimeNs
+qint64 QPerformanceTimer::elapsedToAbsoluteTime(qint64 absoluteMonotonicTimeNs) const
+{
+    uint64_t cpu_time = absoluteMonotonicTimeNs;
+    return absoluteToNSecs(cpu_time - t1);
+}
+
 ////////////////////////////// Unix //////////////////////////////
 #elif defined(Q_OS_UNIX)
 
@@ -154,6 +161,16 @@ qint64 QPerformanceTimer::elapsed() const
     return sec * Q_INT64_C(1000000000) + frac;
 }
 
+qint64 QPerformanceTimer::elapsedToAbsoluteTime(qint64 absoluteMonotonicTimeNs) const
+{
+    qint64 sec = absoluteMonotonicTimeNs / Q_INT64_C(1000000000);
+    qint64 frac = absoluteMonotonicTimeNs % Q_INT64_C(1000000000);
+    sec = sec - t1;
+    frac = frac - t2;
+
+    return sec * Q_INT64_C(1000000000) + frac;
+}
+
 ////////////////////////////// Windows //////////////////////////////
 #elif defined(Q_OS_WIN)
 
@@ -179,6 +196,11 @@ qint64 QPerformanceTimer::elapsed() const
     return getTimeFromTick(li.QuadPart - t1);
 }
 
+qint64 QPerformanceTimer::elapsedToAbsoluteTime(qint64 absoluteMonotonicTimeNs) const
+{
+    return absoluteMonotonicTimeNs - t1;
+}
+
 ////////////////////////////// Default //////////////////////////////
 #else
 
@@ -192,6 +214,12 @@ qint64 QPerformanceTimer::elapsed() const
     return 0;
 }
 
+qint64 QPerformanceTimer::elapsedToAbsoluteTime(qint64 absoluteMonotonicTimeNs) const
+{
+    Q_UNUSED(absoluteMonotonicTimeNs);
+    return 0;
+}
+
 #endif
 
 QT_END_NAMESPACE
diff --git a/src/declarative/qml/qperformancetimer_p.h b/src/declarative/qml/qperformancetimer_p.h
index 7880fa89..98cf9c25 100644
--- a/src/declarative/qml/qperformancetimer_p.h
+++ b/src/declarative/qml/qperformancetimer_p.h
@@ -53,7 +53,7 @@
 // We mean it.
 //
 
-#include <QtCore/qglobal.h>
+#include "qtquick1global.h"
 
 QT_BEGIN_HEADER
 
@@ -61,12 +61,12 @@ QT_BEGIN_NAMESPACE
 
 QT_MODULE(Declarative)
 
-class Q_AUTOTEST_EXPORT QPerformanceTimer
+class Q_QUICK1_EXPORT QPerformanceTimer
 {
 public:
     void start();
     qint64 elapsed() const;
-
+    qint64 elapsedToAbsoluteTime(qint64 absoluteMonotonicTimeNs) const;
 private:
     qint64 t1;
     qint64 t2;