Add perfetto trace output

Author: fsimonis

.gitignore

@@ -16,4 +16,5 @@
 # output files
 profiling.db
 profiling.csv
+profiling.pftrace
 trace.json

preciceprofiling/common.py

@@ -7,6 +7,7 @@
 import sqlite3
 import json
 import pathlib
+import collections
 
 from preciceprofiling.merge import warning, MERGED_FILE_VERSION
 
@@ -119,6 +120,11 @@ def makeData(s):
     def participants(self):
         return [name for (name,) in self._cur.execute("SELECT name FROM participants")]
 
+    def ranks(self):
+        return cur.execute(
+            "SELECT DISTINCT participant, rank FROM full_events"
+        ).fetchall()
+
     def events(self):
         return [name for (name,) in self._cur.execute("SELECT name FROM names")]
 
@@ -155,3 +161,100 @@ def toExportDataFrame(self, unit):
             schema=schema,
         )
         return df
+
+    def toPFTrace(self):
+        import uuid
+        from perfetto.trace_builder.proto_builder import TraceProtoBuilder
+        from perfetto.protos.perfetto.trace.perfetto_trace_pb2 import (
+            TrackEvent,
+            TrackDescriptor,
+            TracePacket,
+        )
+
+        Event = collections.namedtuple("Event", ["name", "ts", "dur", "data"])
+
+        def eventsFor(participant, rank):
+            for e in self._cur.execute(
+                "SELECT event, (ts - (SELECT min(ts) FROM events))*1000 as ts , dur*1000, data FROM full_events WHERE dur > 0 AND event <> '_GLOBAL' AND participant == ? AND rank == ? ORDER BY ts ASC",
+                (participant, rank),
+            ):
+                yield Event(*e)
+
+        TPS_ID = 2025
+
+        builder = TraceProtoBuilder()
+
+        participants = {
+            p: uuid.uuid4().int & ((1 << 63) - 1) for p in self.participants()
+        }
+
+        for p, u in participants.items():
+            pkt = builder.add_packet()
+            pkt.track_descriptor.uuid = u
+            pkt.track_descriptor.name = p
+            pkt.track_descriptor.child_ordering = TrackDescriptor.EXPLICIT
+            pkt.trusted_packet_sequence_id = TPS_ID
+
+        ranks = [
+            (p, r, i)
+            for i, (p, r) in enumerate(
+                self.ranks(),
+                start=10,
+            )
+        ]
+
+        for p, r, u in ranks:
+            pkt = builder.add_packet()
+            pkt.track_descriptor.uuid = u
+            pkt.track_descriptor.name = f"Rank {r}"
+            pkt.track_descriptor.parent_uuid = participants[p]
+            pkt.track_descriptor.sibling_order_rank = r
+            pkt.trusted_packet_sequence_id = TPS_ID
+            pkt.sequence_flags = TracePacket.SEQ_INCREMENTAL_STATE_CLEARED
+
+        seen = {}
+
+        for p, r, u in ranks:
+            active = []
+            for e in eventsFor(p, r):
+
+                # end past events
+                for a in active:
+                    if (a.ts + a.dur) <= e.ts:
+                        pkt = builder.add_packet()
+                        pkt.timestamp = a.ts + a.dur
+                        pkt.track_event.type = TrackEvent.TYPE_SLICE_END
+                        pkt.track_event.track_uuid = u
+                        pkt.trusted_packet_sequence_id = TPS_ID
+                        pkt.sequence_flags = TracePacket.SEQ_NEEDS_INCREMENTAL_STATE
+
+                # discard inactive
+                active = [a for a in active if (a.ts + a.dur) > e.ts]
+                active.append(e)
+
+                # add new event
+                pkt = builder.add_packet()
+                pkt.timestamp = e.ts
+                pkt.track_event.type = TrackEvent.TYPE_SLICE_BEGIN
+                pkt.track_event.track_uuid = u
+                pkt.trusted_packet_sequence_id = TPS_ID
+                name = e.name.rpartition("/")[-1]
+                if name in seen:
+                    pkt.track_event.name_iid = seen[name]
+                else:
+                    pkt.track_event.name = name
+                    entry = pkt.interned_data.event_names.add()
+                    entry.iid = seen[name] = len(seen) + 1
+                    entry.name = name
+                pkt.sequence_flags = TracePacket.SEQ_NEEDS_INCREMENTAL_STATE
+
+            # end leftover events
+            for a in active:
+                pkt = builder.add_packet()
+                pkt.timestamp = a.ts + a.dur
+                pkt.track_event.type = TrackEvent.TYPE_SLICE_END
+                pkt.track_event.track_uuid = u
+                pkt.trusted_packet_sequence_id = TPS_ID
+                pkt.sequence_flags = TracePacket.SEQ_NEEDS_INCREMENTAL_STATE
+
+        return builder.serialize()

preciceprofiling/pftrace.py

@@ -0,0 +1,42 @@
+from preciceprofiling.common import Run
+import argparse
+import sys
+import pathlib
+from preciceprofiling.parsers import addInputArgument
+
+
+def makePFTraceParser(add_help: bool = True):
+    trace_help = "Transform profiling to the perfetto trace."
+    trace = argparse.ArgumentParser(description=trace_help, add_help=add_help)
+    addInputArgument(trace)
+    trace.add_argument(
+        "-o",
+        "--output",
+        default="profiling.pftrace",
+        type=pathlib.Path,
+        help="The resulting perfetto trace file",
+    )
+    return trace
+
+
+def runPFTrace(ns):
+    return pftraceCommand(ns.profilingfile, ns.output)
+
+
+def pftraceCommand(profilingfile, outfile):
+    run = Run(profilingfile)
+    print(f"Building perfetto trace")
+    trace = run.toPFTrace()
+    print(f"Writing to {outfile}")
+    outfile.write_bytes(trace)
+    return 0
+
+
+def main():
+    parser = makePFTraceParser()
+    ns = parser.parse_args()
+    return runPFTrace(ns)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name="precice-profiling"
 dynamic = [ "version" ]
 dependencies = [
-    "typing_extensions", "orjson >= 3", "polars >= 0.19.0", "matplotlib"
+    "typing_extensions", "orjson >= 3", "polars >= 0.19.0", "matplotlib", "perfetto"
 ]
 requires-python = ">=3.10"
 authors = [
@@ -40,6 +40,7 @@ precice-profiling-analyze = "preciceprofiling.analyze:main"
 precice-profiling-trace = "preciceprofiling.trace:main"
 precice-profiling-export = "preciceprofiling.export:main"
 precice-profiling-histogram = "preciceprofiling.histogram:main"
+precice-profiling-pftrace = "preciceprofiling.pftrace:main"
 
 [tool.setuptools]
 packages=["preciceprofiling"]