Rust性能分析工具tracy_full的使用

tracy_full是Tracy分析器的完整Rust绑定，提供高性能应用程序的实时帧捕获和GPU/CPU分析功能。

开始使用

在Cargo.toml中添加以下依赖：

[dependencies.tracy]
package = "tracy_full"
version = "1.10.0"

要启用分析功能，添加enable特性：

[dependencies.tracy]
...
features = ["enable"]

特性

分配跟踪

#[global_allocator]
static ALLOC: tracy::GlobalAllocator = tracy::GlobalAllocator::new();

这跟踪所有分配，使用默认的System分配器进行分配。

对于自定义分配器：

#[global_allocator]
static ALLOC: tracy::GlobalAllocator<MyAlloc> = tracy::GlobalAllocator::new_with(MyAlloc::new());

Tracy还支持使用allocator_api特性跟踪自定义分配器：

[dependencies.tracy]
...
features = ["allocator_api"]

let alloc = TrackedAllocator::new(alloc, tracy::c_str!("TrackedAllocator"));

这会在Tracy中创建一个名为TrackedAllocator的内存池。

所有分配器都有一个*Sampled变体，每次分配时对调用栈进行采样。

帧标记

使用以下方式标记主帧结束：

use tracy::frame;

frame!();

标记子帧结束：

frame!("Name");

标记不连续帧的范围：

frame!(discontinuous "Name");

绘图

你可以在Tracy中绘制图表：

use tracy::plotter;

let plotter = plotter!("MyGraph");
plotter.value(1.0);
plotter.value(2.0);

区域

use tracy::zone;

zone!(); // 无名称区域
zone!("MyZone"); // 名称为"MyZone"的区域
zone!(tracy::color::RED); // 红色区域
zone!("MyZone", true); // 名称为"MyZone"的区域，并通过运行时表达式启用
zone!(tracy::color::RED, true); // 红色区域，并通过运行时表达式启用
zone!("MyZone", tracy::color::RED, true); // 名称为"MyZone"、红色、并通过运行时表达式启用的区域

所有区域从创建到包含范围结束进行分析。

完整示例

下面是一个完整的示例代码，展示如何使用tracy_full进行性能分析：

use tracy::{frame, plotter, zone};

// 设置全局分配器跟踪
#[global_allocator]
static ALLOC: tracy::GlobalAllocator = tracy::GlobalAllocator::new();

fn main() {
    // 模拟游戏主循环
    loop {
        // 输入处理
        {
            zone!("Input Processing");
            // 模拟输入处理
            std::thread::sleep(std::time::Duration::from_millis(10));
            frame!("Input");
        }

        // 游戏逻辑
        {
            zone!("Game Logic");
            // 模拟游戏逻辑
            std::thread::sleep(std::time::Duration::from_millis(20));
            frame!("Logic");
        }

        // 渲染
        {
            zone!("Rendering");
            // 模拟渲染
            std::thread::sleep(std::time::Duration::from_millis(30));
            frame!("Render");
        }

        // 记录帧时间
        let frame_time = 60.0; // 模拟帧时间
        let plotter = plotter!("Frame Time (ms)");
        plotter.value(frame_time);

        // 标记主帧结束
        frame!();
    }
}

额外特性

未来支持

未来可以作为Tracy中的光纤表示。必须启用futures特性。

[dependencies.tracy]
...
features = ["enable", "futures"]

use tracy::future;

trace_future!(async_function(), "Async Function").await;

外部库集成

Bevy

启用bevy特性可以分析Bevy系统：

[dependencies.tracy]
...
features = ["enable", "bevy"]

use tracy::bevy::timeline;

App::new().add_system(timeline(my_system)).run();

Tracing

启用tracing特性可以分析tracing spans：

[dependencies.tracy]
...
features = ["enable", "tracing"]

use tracy::tracing::TracyLayer;

tracing::subscriber::set_global_default(
    tracing_subscriber::registry().with(TracyLayer)
);

WGPU

启用wgpu特性可以分析wgpu命令编码器和渲染/计算通道：

[dependencies.tracy]
...
features = ["enable", "wgpu"]

use tracy::wgpu::ProfileContext;

let mut profile context = ProfileContext::with_name("Name", &adapter, &device, &queue, buffered_frames);

扩展示例

下面是一个更完整的示例，展示tracy_full的各种功能组合使用：

use tracy::{frame, plotter, zone, future};
use std::time::Instant;

// 设置全局分配器跟踪
#[global_allocator]
static ALLOC: tracy::GlobalAllocator = tracy::GlobalAllocator::new();

async fn async_task() {
    zone!("Async Task");
    tokio::time::sleep(std::time::Duration::from_millis(50)).await;
}

#[tokio::main]
async fn main() {
    // 记录启动时间
    let start = Instant::now();
    let mut plotter = plotter!("Execution Time");
    
    // 主循环
    for i in 0..10 {
        // 帧开始区域
        zone!("Frame", tracy::color::BLUE);
        
        // CPU密集型任务
        {
            zone!("CPU Work");
            let mut sum = 0;
            for j in 0..1000 {
                sum += j;
            }
            plotter!("CPU Sum", sum as f32);
        }
        
        // 异步任务跟踪
        trace_future!(async_task(), "Tracked Async Task").await;
        
        // 内存分配跟踪
        {
            zone!("Memory Allocation");
            let _vec = vec![0u8; 1024]; // 会被全局分配器跟踪
        }
        
        // 记录帧时间
        plotter.value(start.elapsed().as_secs_f32());
        
        // 标记帧结束
        frame!("Frame {}", i);
    }
    
    // 特殊标记
    frame!(discontinuous "Application Shutdown");
}

这个示例展示了：

1. 全局内存分配跟踪
2. 同步和异步代码分析
3. 帧标记和区域划分
4. 性能数据绘图
5. 不连续帧标记
6. 颜色编码区域

要运行此示例，需要添加以下依赖：

[dependencies]
tokio = { version = "1.0", features = ["full"] }
tracy = { package = "tracy_full", version = "1.10.0", features = ["enable", "futures"] }