QmlDebug: Support QtQuick3D profiler events

The client definitions should provide the same event types as the
service definitions.

Adapt the code for reading and writing the events from Qt Creator.

Change-Id: Ib714304a5b56f7d1bd9c1f53656554b9705f630b
Reviewed-by: Sami Shalayel <[email protected]>
Reviewed-by: Ulf Hermann <[email protected]>
Reviewed-by: Antti Määttä <[email protected]>

Author: ulfhermannqt

src/qmldebug/qqmlprofilerclientdefinitions_p.h

@@ -31,6 +31,7 @@ enum Message {
     SceneGraphFrame,
     MemoryAllocation,
     DebugMessage,
+    Quick3DFrame,
 
     MaximumMessage
 };
@@ -91,6 +92,22 @@ enum MemoryType {
     SmallItem
 };
 
+enum Quick3DFrameType {
+    Quick3DRenderFrame,     // Render Thread
+    Quick3DSynchronizeFrame,
+    Quick3DPrepareFrame,
+    Quick3DMeshLoad,
+    Quick3DCustomMeshLoad,
+    Quick3DTextureLoad,
+    Quick3DGenerateShader,
+    Quick3DLoadShader,
+    Quick3DParticleUpdate,  // GUI Thread
+    Quick3DRenderCall,      // Render Thread
+    Quick3DRenderPass,      // Render Thread
+    Quick3DEventData,       // N/A
+    MaximumQuick3DFrameType,
+};
+
 enum ProfileFeature {
     ProfileJavaScript,
     ProfileMemory,
@@ -104,6 +121,7 @@ enum ProfileFeature {
     ProfileHandlingSignal,
     ProfileInputEvents,
     ProfileDebugMessages,
+    ProfileQuick3D,
 
     MaximumProfileFeature
 };

src/qmldebug/qqmlprofilereventtype.cpp

@@ -17,6 +17,12 @@ QDataStream &operator>>(QDataStream &stream, QQmlProfilerEventType &type)
            >> type.m_detailType;
     type.m_message = static_cast<Message>(message);
     type.m_rangeType = static_cast<RangeType>(rangeType);
+
+    // If the trace is from before Quick3D events were introduced, the value that's now
+    // Quick3DFrame is MaximumMessage and denoted a range. Check for that.
+    if (type.m_message == Quick3DFrame && type.m_rangeType != MaximumRangeType)
+        type.m_message = MaximumMessage;
+
     return stream;
 }
 
@@ -49,6 +55,8 @@ ProfileFeature QQmlProfilerEventType::feature() const
         return ProfileMemory;
     case DebugMessage:
         return ProfileDebugMessages;
+    case Quick3DFrame:
+        return ProfileQuick3D;
     default:
         break;
     }

src/qmldebug/qqmlprofilerqtdwriter.cpp

@@ -42,7 +42,8 @@ static const char *MESSAGE_STRINGS[] = {
     "PixmapCache",
     "SceneGraph",
     "MemoryAllocation",
-    "DebugMessage"
+    "DebugMessage",
+    "Quick3D", // Not "Quick3DFrame" unfortunately. See precedence in Qt Creator.
 };
 
 Q_STATIC_ASSERT(sizeof(MESSAGE_STRINGS) == MaximumMessage * sizeof(const char *));
@@ -197,6 +198,9 @@ void QQmlProfilerQtdWriter::addEventType(const QQmlProfilerEventType &type)
     case DebugMessage:
         displayName = QString::fromLatin1("DebugMessage:%1").arg(type.detailType());
         break;
+    case Quick3DFrame:
+        displayName = QString::fromLatin1("Quick3DFrame:%1").arg(type.detailType());
+        break;
     case MaximumMessage: {
         const QQmlProfilerEventLocation eventLocation = type.location();
         // generate hash

src/qmldebug/qqmlprofilertypedevent.cpp

@@ -175,6 +175,26 @@ QDataStream &operator>>(QDataStream &stream, QQmlProfilerTypedEvent &event)
         event.event.setRangeStage(RangeEnd);
         break;
     }
+    case Quick3DFrame: {
+        QVarLengthArray<qint64> params;
+        qint64 param = 0;
+        QByteArray str;
+        if (subtype == Quick3DEventData) {
+            stream >> str;
+        } else {
+            while (!stream.atEnd()) {
+                stream >> param;
+                params.push_back(param);
+            }
+        }
+
+        event.type = QQmlProfilerEventType(
+                static_cast<Message>(messageType),
+                MaximumRangeType, subtype);
+        event.type.setData(QString::fromUtf8(str));
+        event.event.setNumbers<QVarLengthArray<qint64>, qint64>(params);
+        break;
+    }
     default:
         event.event.setNumbers<char>({});
         event.type = QQmlProfilerEventType(

tools/qmlprofiler/qmlprofilerapplication.cpp

@@ -46,7 +46,8 @@ static const char *features[] = {
     "binding",
     "handlingsignal",
     "inputevents",
-    "debugmessages"
+    "debugmessages",
+    "quick3d",
 };
 
 Q_STATIC_ASSERT(sizeof(features) == MaximumProfileFeature * sizeof(char *));