Import frame messages (#459)

Co-authored-by: Joshua Kriegshauser <joshuakr@nvidia.com>
Co-authored-by: Bartosz Taudul <wolf@nereid.pl>

NEWS

@@ -80,6 +80,9 @@ v0.x.x (xxxx-xx-xx)
   instead of "/usr/bin/../lib64/gcc/x86_64-pc-linux-gnu/12.2.0/../../../../
   include/c++/12.2.0/bits/std_mutex.h" Tracy will now report such file as
   "/usr/include/c++/12.2.0/bits/std_mutex.h".
+- The import-chrome utility interprets Instant (`i`/`I`) events where the
+  `name` field contains the word `frame` as a frame event. The `name` is the
+  frame set name.
 
 
 v0.8.2 (2022-06-28)

import-chrome/src/import-chrome.cpp

@@ -30,6 +30,13 @@ using json = nlohmann::json;
 void Usage()
 {
     printf( "Usage: import-chrome input.json output.tracy\n\n" );
+    printf( "The following chrome-tracing phases are supported:\n\n" );
+    printf( "  b/B/e/E - Timeline events such as ZoneNamed\n" );
+    printf( "  X - Timeline events such as ZoneNamed\n" );
+    printf( "  i/I - Message events such as TracyMessage\n" );
+    printf( "    * Messages containing the word \"frame\" are interpreted as frame events such as FrameMarkNamed\n" );
+    printf( "  C - Plot events such as TracyPlot\n" );
+    printf( "  M - Metadata of type \"thread_name\" is used to name threads\n" );
     exit( 1 );
 }
 

server/TracyWorker.cpp

@@ -423,21 +423,46 @@ Worker::Worker( const char* name, const char* program, const std::vector<ImportE
         }
     }
 
+    std::unordered_map<std::string, uint64_t> frameNames;
+
     for( auto& v : messages )
     {
-        auto msg = m_slab.Alloc<MessageData>();
+        // There is no specific chrome-tracing type for frame events. We use messages that contain the word "frame"
-        msg->time = v.timestamp;
+        std::string lower( v.message );
-        msg->ref = StringRef( StringRef::Type::Idx, StoreString( v.message.c_str(), v.message.size() ).idx );
+        std::transform( lower.begin(), lower.end(), lower.begin(), []( char c ) { return char( std::tolower( c ) ); } );
-        msg->thread = CompressThread( v.tid );
+        if( lower.find( "frame" ) != std::string::npos )
-        msg->color = 0xFFFFFFFF;
-        msg->callstack.SetVal( 0 );
-
-        if( m_threadCtx != v.tid )
         {
-            m_threadCtx = v.tid;
+            // Reserve 0 as the default FrameSet, since it replaces the name with "Frame" and we want to keep our custom names.
-            m_threadCtxData = nullptr;
+            auto result = frameNames.emplace( v.message, frameNames.size() + 1 );
+            auto fd = m_data.frames.Retrieve( result.first->second, [&] ( uint64_t name ) {
+                auto fd = m_slab.AllocInit<FrameData>();
+                fd->name = name;
+                fd->continuous = 1;
+                return fd;
+            }, [&] ( uint64_t name ) {
+                HandleFrameName( name, v.message.c_str(), v.message.length() );
+            });
+
+            int64_t time = v.timestamp;
+            fd->frames.push_back( FrameEvent{ time, -1, -1 } );
+            if ( m_data.lastTime < time ) m_data.lastTime = time;
+        }
+        else
+        {
+            auto msg = m_slab.Alloc<MessageData>();
+            msg->time = v.timestamp;
+            msg->ref = StringRef( StringRef::Type::Idx, StoreString( v.message.c_str(), v.message.size() ).idx );
+            msg->thread = CompressThread( v.tid );
+            msg->color = 0xFFFFFFFF;
+            msg->callstack.SetVal( 0 );
+
+            if( m_threadCtx != v.tid )
+            {
+                m_threadCtx = v.tid;
+                m_threadCtxData = nullptr;
+            }
+            InsertMessageData( msg );
         }
-        InsertMessageData( msg );
     }
 
     for( auto& v : plots )
@@ -512,19 +537,23 @@ Worker::Worker( const char* name, const char* program, const std::vector<ImportE
         }
     }
 
-    m_data.framesBase = m_data.frames.Retrieve( 0, [this] ( uint64_t name ) {
+    // Add a default frame if we didn't have any framesets
-        auto fd = m_slab.AllocInit<FrameData>();
+    if( frameNames.empty() )
-        fd->name = name;
+    {
-        fd->continuous = 1;
+        m_data.framesBase = m_data.frames.Retrieve( 0, [this] ( uint64_t name ) {
-        return fd;
+            auto fd = m_slab.AllocInit<FrameData>();
-    }, [this] ( uint64_t name ) {
+            fd->name = name;
-        assert( name == 0 );
+            fd->continuous = 1;
-        char tmp[6] = "Frame";
+            return fd;
-        HandleFrameName( name, tmp, 5 );
+        }, [this] ( uint64_t name ) {
-    } );
+            assert( name == 0 );
+            char tmp[6] = "Frame";
+            HandleFrameName( name, tmp, 5 );
+        } );
 
-    m_data.framesBase->frames.push_back( FrameEvent{ 0, -1, -1 } );
+        m_data.framesBase->frames.push_back( FrameEvent{ 0, -1, -1 } );
-    m_data.framesBase->frames.push_back( FrameEvent{ 0, -1, -1 } );
+        m_data.framesBase->frames.push_back( FrameEvent{ 0, -1, -1 } );
+    }
 }
 
 Worker::Worker( FileRead& f, EventType::Type eventMask, bool bgTasks )