Crate tracy_client

Source
Expand description

This crate is a set of safe bindings to the client library of the Tracy profiler.

If you have already instrumented your application with tracing, consider the tracing-tracy crate.

§Important note

Depending on the configuration Tracy may broadcast discovery packets to the local network and expose the data it collects in the background to that same network. Traces collected by Tracy may include source and assembly code as well.

As thus, you may want make sure to only enable the tracy-client crate conditionally, via the enable feature flag provided by this crate.

§Features

The following crate features are provided to customize the functionality of the Tracy client:

  • enable – enables the Tracy client. Corresponds to the TRACY_ENABLE define.
  • flush-on-exit – waits for Tracy to connect and read out the profiling data before the program terminates. Corresponds to the TRACY_NO_EXIT define. Does not work in combination with the manual-lifetime feature.
  • manual-lifetime – allow for manual initialization and deinitialization of the profiler data structures. Corresponds to the TRACY_MANUAL_LIFETIME define. tracy_client::Client transparently switches to manual lifetime management when this feature is enabled. Implies delayed-init.
  • system-tracing – enable capture of system level details. Corresponds to the TRACY_NO_SYSTEM_TRACING define.
  • context-switch-tracing – enable capture of the context switch data. Corresponds to the TRACY_NO_CONTEXT_SWITCH define.
  • sampling – enable periodic sampling of the call stack. Corresponds to the TRACY_NO_SAMPLING define.
  • code-transfer – enable transfer of the machine code to the profiler. Corresponds to the TRACY_NO_CODE_TRANSFER define.
  • broadcast – announce presence of the client to the profilers on the local network. Corresponds to the TRACY_NO_BROADCAST define.
  • only-localhost – listen for profilers on the localhost interface only. Corresponds to the TRACY_ONLY_LOCALHOST define.
  • only-ipv4 – listen for profilers on IPv4 interfaces only. Corresponds to the TRACY_ONLY_IPV4 define.
  • timer-fallback – allow running on devices without a high resolution timer support. Corresponds to the TRACY_TIMER_FALLBACK define.
  • ondemand – start collecting traces only when a server connects to the client. Corresponds to the TRACY_ON_DEMAND define.
  • fibers – enable support for instrumenting fibers, coroutines and similar such asynchrony primitives. Corresponds to the TRACY_FIBERS define.
  • callstack-inlines - enables resolution of inline frames for call stacks. Disabling it will make the profiler use the basic but much faster frame resolution mode. Corresponds to the TRACY_NO_CALLSTACK_INLINES define.
  • delayed-init – initializes trace structures upon a first request, rather than at load time. Corresponds to the TRACY_DELAYED_INIT define.
  • demangle - requires that the demangling function be defined by the user. See the register_demangler! macro for more details. Corresponds to the TRACY_DEMANGLE define.
  • verify - enables verification that instrumentation is well formed. Enabling this introduces additional instrumentation overhead (~50% for 0 callstack depth spans.) When disabled corresponds to the TRACY_NO_VERIFY define.
  • debuginfod - enables debuginfo for system libraries on systems supporting debuginfod. Corresponds to the TRACY_DEBUGINFOD define.

Refer to this package’s Cargo.toml for the list of the features enabled by default. Refer to the Tracy manual for more information on the implications of each feature.

Re-exports§

pub use sys;

Modules§

demangledemangle
Custom symbol demangling support.

Macros§

frame_name
Construct a FrameName.
non_continuous_frame
Convenience macro for Client::non_continuous_frame on the current client.
plot
Convenience macro for Client::plot on the current client.
plot_name
Construct a PlotName.
register_demanglerdemangle
Registers a custom demangler function.
secondary_frame_mark
Convenience macro for Client::secondary_frame_mark on the current client.
set_thread_name
Convenience macro for Client::set_thread_name on the current client.
span
Start a new Tracy span with function, file, and line determined automatically.
span_location
Construct a &’static SpanLocation.

Structs§

Client
A type representing an enabled Tracy client.
Frame
A non-continuous frame region.
FrameName
A name for secondary and non-continuous frames.
GpuContext
Context for creating gpu spans.
GpuSpan
Span for timing gpu work.
PlotConfiguration
Configuration for how a plot appears in the Tracy profiling UI.
PlotName
Name of a plot.
ProfiledAllocator
A profiling wrapper around another allocator.
Span
A handle representing a span of execution.
SpanLocation
A statically allocated location information for a span.

Enums§

GpuContextCreationError
Errors that can occur when creating a gpu context.
GpuContextType
The API label associated with the given gpu context. The list here only includes APIs that are currently supported by Tracy’s own gpu implementations.
GpuSpanCreationError
Errors that can occur when creating a gpu span.
PlotFormat
The format of a plot to be shown in the Tracy profiler UI.
PlotLineStyle
The style of lines of a plot, shown in the Tracy profiler UI.

Functions§

frame_image
Convenience shortcut for Client::frame_image on the current client.
frame_mark
Convenience shortcut for Client::frame_mark on the current client.