1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
//! This crate provides a library for high-performance event tracing which is used by //! the Rust compiler's unstable `-Z self-profile` feature. //! //! The output of a tracing session will be three files: //! 1. A `.events` file which contains all of the traced events. //! 2. A `.string_data` file which contains all the strings referenced by events. //! 3. A `.string_index` file which maps `StringId` values to offsets into the `.string_data` file. //! //! # Writing event trace files //! //! The main entry point for writing event trace files is the [`Profiler`] struct. //! //! To create a [`Profiler`], call the [`Profiler::new()`] function and provide a `Path` with //! the directory and file name for the trace files. //! //! To record an event, call the [`Profiler::record_instant_event()`] method, passing a few arguments: //! - `event_kind`: a [`StringId`] which assigns an arbitrary category to the event //! - `event_id`: a [`StringId`] which specifies the name of the event //! - `thread_id`: a `u32` id of the thread which is recording this event //! //! Alternatively, events can also be recorded via the [`Profiler::start_recording_interval_event()`] method. This //! method records a "start" event and returns a `TimingGuard` object that will automatically record //! the corresponding "end" event when it is dropped. //! //! To create a [`StringId`], call one of the string allocation methods: //! - [`Profiler::alloc_string()`]: allocates a string and returns the [`StringId`] that refers to it //! - [`Profiler::alloc_string_with_reserved_id()`]: allocates a string using the specified [`StringId`]. //! It is up to the caller to make sure the specified [`StringId`] hasn't already been used. //! //! [`Profiler`]: struct.Profiler.html //! [`Profiler::alloc_string()`]: struct.Profiler.html#method.alloc_string //! [`Profiler::alloc_string_with_reserved_id()`]: struct.Profiler.html#method.alloc_string_with_reserved_id //! [`Profiler::new()`]: struct.Profiler.html#method.new //! [`Profiler::record_event()`]: struct.Profiler.html#method.record_event //! [`Profiler::start_recording_interval_event()`]: struct.Profiler.html#method.start_recording_interval_event //! [`StringId`]: struct.StringId.html #![deny(warnings)] pub mod file_header; #[cfg(any(not(target_arch = "wasm32"), target_os = "wasi"))] mod file_serialization_sink; #[cfg(not(target_arch = "wasm32"))] mod mmap_serialization_sink; mod profiler; mod raw_event; mod serialization; pub mod stringtable; pub mod rustc; #[cfg(any(not(target_arch = "wasm32"), target_os = "wasi"))] pub use crate::file_serialization_sink::FileSerializationSink; #[cfg(not(target_arch = "wasm32"))] pub use crate::mmap_serialization_sink::MmapSerializationSink; pub use crate::profiler::{Profiler, ProfilerFiles, TimingGuard}; pub use crate::raw_event::{RawEvent, MAX_INSTANT_TIMESTAMP, MAX_INTERVAL_TIMESTAMP}; pub use crate::serialization::{Addr, ByteVecSink, SerializationSink}; pub use crate::stringtable::{SerializableString, StringComponent, StringId, StringTableBuilder};