Files
tracy/update/src/update.cpp
Clément Grégoire 55d5436fb9 Add option to reset callstack frame symbols to the unresolved state
The new `-R` option of tracy-update sets every callstack frame back to `[unresolved]` / `[unknown]`. Since failed lookups leave frames untouched and the image-relative offset in `symAddr` survives patching, this makes it possible to chain several resolution passes over the same capture, each with different `-p` path substitutions (e.g. one pass per symbol directory).
2026-06-05 19:03:35 +02:00

264 lines
8.8 KiB
C++

#ifdef _WIN32
# include <windows.h>
#endif
#include <chrono>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <zstd.h>
#include "../../public/common/TracyVersion.hpp"
#include "../../server/TracyFileRead.hpp"
#include "../../server/TracyFileWrite.hpp"
#include "../../server/TracyPrint.hpp"
#include "../../server/TracyWorker.hpp"
#include "../../getopt/getopt.h"
#include "GitRef.hpp"
#include "OfflineSymbolResolver.h"
#ifdef __APPLE__
# define ftello64(x) ftello(x)
#elif defined _WIN32
# define ftello64(x) _ftelli64(x)
#endif
void Usage()
{
printf( "tracy-update %i.%i.%i / %s\n\n", tracy::Version::Major, tracy::Version::Minor, tracy::Version::Patch, tracy::GitRef );
printf( "Usage: update [options] input.tracy output.tracy\n\n" );
printf( " -4: enable LZ4 compression\n" );
printf( " -h: enable LZ4HC compression\n" );
printf( " -e: enable extreme LZ4HC compression (very slow)\n" );
printf( " -z level: use Zstd compression with given compression level\n" );
printf( " -d: build dictionary for frame images\n" );
printf( " -s flags: strip selected data from capture:\n" );
printf( " l: locks, m: messages, p: plots, M: memory, i: frame images\n" );
printf( " c: context switches, s: sampling data, C: symbol code, S: source cache\n" );
printf( " -c: scan for source files missing in cache and add if found\n" );
printf( " -r: resolve symbols and patch callstack frames\n");
printf( " -R: reset all callstack frame symbols to unresolved (e.g. to re-run resolution)\n");
printf( " -p: substitute symbol resolution path with an alternative: \"REGEX_MATCH;REPLACEMENT\"\n");
printf( " -a: path to a custom addr2line-compatible tool to use for symbol resolution\n");
printf( " -A: extra arguments passed verbatim to the symbol resolution tool,\n");
printf( " e.g. \"--relative-address\" for llvm-addr2line on PE/Mach-O images\n");
printf( " -v: verbose output while resolving symbols\n");
printf( " -j: number of threads to use for compression (-1 to use all cores)\n" );
exit( 1 );
}
int main( int argc, char** argv )
{
#ifdef _WIN32
if( !AttachConsole( ATTACH_PARENT_PROCESS ) )
{
AllocConsole();
SetConsoleMode( GetStdHandle( STD_OUTPUT_HANDLE ), 0x07 );
}
#endif
tracy::FileCompression clev = tracy::FileCompression::Zstd;
uint32_t events = tracy::EventType::All;
int zstdLevel = 3;
int streams = 4;
bool buildDict = false;
bool cacheSource = false;
bool resolveSymbols = false;
bool resetSymbols = false;
std::vector<std::string> pathSubstitutions;
std::string addr2lineToolPath;
std::string addr2lineArgs;
bool verboseSymbols = false;
int c;
while( ( c = getopt( argc, argv, "4hez:ds:crRp:a:A:vj:" ) ) != -1 )
{
switch( c )
{
case '4':
clev = tracy::FileCompression::Fast;
break;
case 'h':
clev = tracy::FileCompression::Slow;
break;
case 'e':
clev = tracy::FileCompression::Extreme;
break;
case 'z':
clev = tracy::FileCompression::Zstd;
zstdLevel = atoi( optarg );
if( zstdLevel > ZSTD_maxCLevel() || zstdLevel < ZSTD_minCLevel() )
{
printf( "Available Zstd compression levels range: %i - %i\n", ZSTD_minCLevel(), ZSTD_maxCLevel() );
exit( 1 );
}
break;
case 'd':
buildDict = true;
break;
case 's':
{
auto ptr = optarg;
do
{
switch( *optarg )
{
case 'l':
events &= ~tracy::EventType::Locks;
break;
case 'm':
events &= ~tracy::EventType::Messages;
break;
case 'p':
events &= ~tracy::EventType::Plots;
break;
case 'M':
events &= ~tracy::EventType::Memory;
break;
case 'i':
events &= ~tracy::EventType::FrameImages;
break;
case 'c':
events &= ~tracy::EventType::ContextSwitches;
break;
case 's':
events &= ~tracy::EventType::Samples;
break;
case 'C':
events &= ~tracy::EventType::SymbolCode;
break;
case 'S':
events &= ~tracy::EventType::SourceCache;
break;
default:
Usage();
break;
}
}
while( *++optarg != '\0' );
break;
}
case 'c':
cacheSource = true;
break;
case 'r':
resolveSymbols = true;
break;
case 'R':
resetSymbols = true;
break;
case 'p':
pathSubstitutions.push_back(optarg);
break;
case 'a':
addr2lineToolPath = optarg;
break;
case 'A':
addr2lineArgs = optarg;
break;
case 'v':
verboseSymbols = true;
break;
case 'j':
streams = atoi( optarg );
break;
default:
Usage();
break;
}
}
if (argc != optind + 2) Usage();
const char* input = argv[optind];
const char* output = argv[optind+1];
printf( "Loading...\r" );
fflush( stdout );
auto f = std::unique_ptr<tracy::FileRead>( tracy::FileRead::Open( input ) );
if( !f )
{
fprintf( stderr, "Cannot open input file!\n" );
exit( 1 );
}
try
{
int64_t tLoad, tSave;
float ratio;
int inVer;
{
const auto t0 = std::chrono::high_resolution_clock::now();
const bool allowBgThreads = false;
const bool allowStringModification = resolveSymbols || resetSymbols;
tracy::Worker worker( *f, (tracy::EventType::Type)events, allowBgThreads, allowStringModification );
#ifndef TRACY_NO_STATISTICS
while( !worker.AreSourceLocationZonesReady() ) std::this_thread::sleep_for( std::chrono::milliseconds( 10 ) );
#endif
const auto t1 = std::chrono::high_resolution_clock::now();
if( cacheSource ) worker.CacheSourceFiles();
if( resetSymbols ) ResetSymbols( worker );
if( resolveSymbols ) PatchSymbols( worker, pathSubstitutions, addr2lineToolPath, addr2lineArgs, verboseSymbols );
auto w = std::unique_ptr<tracy::FileWrite>( tracy::FileWrite::Open( output, clev, zstdLevel, streams ) );
if( !w )
{
fprintf( stderr, "Cannot open output file!\n" );
exit( 1 );
}
printf( "Saving... \r" );
fflush( stdout );
worker.Write( *w, buildDict );
w->Finish();
const auto t2 = std::chrono::high_resolution_clock::now();
const auto stats = w->GetCompressionStatistics();
ratio = 100.f * stats.second / stats.first;
inVer = worker.GetTraceVersion();
tLoad = std::chrono::duration_cast<std::chrono::nanoseconds>( t1 - t0 ).count();
tSave = std::chrono::duration_cast<std::chrono::nanoseconds>( t2 - t1 ).count();
}
FILE* in = fopen( input, "rb" );
fseek( in, 0, SEEK_END );
const auto inSize = ftello64( in );
fclose( in );
FILE* out = fopen( output, "rb" );
fseek( out, 0, SEEK_END );
const auto outSize = ftello64( out );
fclose( out );
printf( "%s (%i.%i.%i) {%s} -> %s (%i.%i.%i) {%s, %.2f%%} %s load, %s save, %.2f%% change\n",
input, inVer >> 16, ( inVer >> 8 ) & 0xFF, inVer & 0xFF, tracy::MemSizeToString( inSize ),
output, tracy::Version::Major, tracy::Version::Minor, tracy::Version::Patch, tracy::MemSizeToString( outSize ), ratio,
tracy::TimeToString( tLoad ), tracy::TimeToString( tSave ), float( outSize ) / inSize * 100 );
}
catch( const tracy::UnsupportedVersion& e )
{
fprintf( stderr, "The file you are trying to open is from the future version.\n" );
exit( 1 );
}
catch( const tracy::NotTracyDump& e )
{
fprintf( stderr, "The file you are trying to open is not a tracy dump.\n" );
exit( 1 );
}
catch( const tracy::FileReadError& e )
{
fprintf( stderr, "The file you are trying to open cannot be mapped to memory.\n" );
exit( 1 );
}
catch( const tracy::LegacyVersion& e )
{
fprintf( stderr, "The file you are trying to open is from a legacy version.\n" );
exit( 1 );
}
return 0;
}