break out read part of measureme to the tools_lib

andjo403 · michaelwoerister · commit 756df3a2dfcb · 2019-11-11T20:06:18.000+01:00
diff --git a/crox/Cargo.toml b/crox/Cargo.toml
@@ -6,6 +6,7 @@ edition = "2018"
 
 [dependencies]
 measureme = { "path" = "../measureme" }
+tools_lib = { path = "../tools_lib" }
 rustc-hash = "1.0.1"
 serde = { version = "1.0", features = [ "derive" ] }
 serde_json = "1.0"
diff --git a/crox/src/main.rs b/crox/src/main.rs
@@ -5,7 +5,7 @@ use std::path::PathBuf;
 use std::time::Duration;
 use std::time::SystemTime;
 
-use measureme::{ProfilingData, Timestamp};
+use tools_lib::{ProfilingData, Timestamp};
 
 use serde::{Serialize, Serializer};
 use std::cmp;
diff --git a/flamegraph/src/main.rs b/flamegraph/src/main.rs
@@ -3,13 +3,9 @@ use std::fs::File;
 use std::io::BufWriter;
 use std::path::PathBuf;
 
-use measureme::ProfilingData;
-
-use structopt::StructOpt;
-
-use tools_lib::stack_collapse::collapse_stacks;
-
 use inferno::flamegraph::{from_lines, Options as FlamegraphOptions};
+use structopt::StructOpt;
+use tools_lib::{collapse_stacks, ProfilingData};
 
 #[derive(StructOpt, Debug)]
 struct Opt {
diff --git a/measureme/Cargo.toml b/measureme/Cargo.toml
@@ -18,3 +18,6 @@ rustc-hash = "1.0.1"
 
 [target.'cfg(not(target_arch="wasm32"))'.dependencies]
 memmap = "0.6.0"
+
+[dev-dependencies]
+tools_lib = { path = "../tools_lib" }
diff --git a/measureme/src/lib.rs b/measureme/src/lib.rs
@@ -1,8 +1,5 @@
-//! This crate provides a library for high-performance event tracing which is used by the Rust compiler's unstable `-Z self-profile` feature.
-//!
-//! There are two main parts to this library:
-//!   - Writing event trace files
-//!   - Reading event trace files
+//! 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.
@@ -13,7 +10,8 @@
 //!
 //! 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 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_event()`] method, passing a few arguments:
 //!   - `event_kind`: a [`StringId`] which assigns an arbitrary category to the event
@@ -30,51 +28,33 @@
 //!   - [`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.
 //!
-//! # Reading event trace files
-//!
-//! The main entry point for reading trace files is the [`ProfilingData`] struct.
-//!
-//! To create a [`ProfilingData`], call the [`ProfilingData::new()`] function and provide a `Path` with the directory and file name for the trace files.
-//!
-//! To retrieve an `Iterator` of all of the events in the file, call the [`ProfilingData::iter()`] method.
-//!
-//! To retrieve an `Iterator` of only matching start/stop events, call the [`ProfilingData::iter_matching_events()`] method.
-//!
 //! [`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
-//! [`ProfilingData`]: struct.ProfilingData.html
-//! [`ProfilingData::iter()`]: struct.ProfilingData.html#method.iter
-//! [`ProfilingData::iter_matching_events()`]: struct.ProfilingData.html#method.iter_matching_events
 //! [`StringId`]: struct.StringId.html
 
 #![deny(warnings)]
 
-mod event;
-mod file_header;
+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 profiling_data;
 mod raw_event;
 mod serialization;
 mod stringtable;
 
 pub mod rustc;
-pub mod testing_common;
 
-pub use crate::event::{Event, Timestamp};
 #[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::profiling_data::{ProfilingData, ProfilingDataBuilder};
 pub use crate::raw_event::RawEvent;
 pub use crate::serialization::{Addr, ByteVecSink, SerializationSink};
 pub use crate::stringtable::{
diff --git a/mmview/Cargo.toml b/mmview/Cargo.toml
@@ -7,4 +7,5 @@ license = "MIT OR Apache-2.0"
 
 [dependencies]
 measureme = { path = "../measureme" }
+tools_lib = { path = "../tools_lib" }
 structopt = "0.2"
diff --git a/mmview/src/main.rs b/mmview/src/main.rs
@@ -1,6 +1,6 @@
-use measureme::ProfilingData;
 use std::error::Error;
 use std::path::PathBuf;
+use tools_lib::ProfilingData;
 
 use structopt::StructOpt;
 
diff --git a/stack_collapse/src/main.rs b/stack_collapse/src/main.rs
@@ -3,11 +3,8 @@ use std::fs::File;
 use std::io::{BufWriter, Write};
 use std::path::PathBuf;
 
-use measureme::ProfilingData;
-
 use structopt::StructOpt;
-
-use tools_lib::stack_collapse::collapse_stacks;
+use tools_lib::{collapse_stacks, ProfilingData};
 
 #[derive(StructOpt, Debug)]
 struct Opt {
diff --git a/summarize/Cargo.toml b/summarize/Cargo.toml
@@ -7,6 +7,7 @@ license = "MIT OR Apache-2.0"
 
 [dependencies]
 measureme = { path = "../measureme" }
+tools_lib = { path = "../tools_lib" }
 prettytable-rs = "0.8"
 rustc-hash = "1.0.1"
 serde = { version = "1.0", features = [ "derive" ] }
diff --git a/summarize/src/analysis.rs b/summarize/src/analysis.rs
@@ -1,9 +1,9 @@
 use crate::query_data::{QueryData, Results};
 use measureme::rustc::*;
-use measureme::{Event, ProfilingData, Timestamp};
 use rustc_hash::FxHashMap;
 use std::borrow::Cow;
 use std::time::SystemTime;
+use tools_lib::{Event, ProfilingData, Timestamp};
 
 /// Collects accumulated summary data for the given ProfilingData.
 ///
@@ -220,7 +220,7 @@ pub fn perform_analysis(data: ProfilingData) -> Results {
 mod tests {
     use super::*;
     use std::time::Duration;
-    use measureme::ProfilingDataBuilder;
+    use tools_lib::ProfilingDataBuilder;
 
     #[test]
     fn total_time_and_nesting() {
diff --git a/summarize/src/main.rs b/summarize/src/main.rs
@@ -1,11 +1,11 @@
 #[macro_use]
 extern crate prettytable;
 
-use measureme::ProfilingData;
 use std::error::Error;
 use std::fs::File;
 use std::io::{BufReader, BufWriter};
 use std::path::PathBuf;
+use tools_lib::ProfilingData;
 
 use prettytable::Table;
 use serde::Serialize;
diff --git a/tools_lib/benches/serialization_bench.rs b/tools_lib/benches/serialization_bench.rs
@@ -2,7 +2,8 @@
 
 extern crate test;
 
-use measureme::{testing_common, FileSerializationSink, MmapSerializationSink};
+use measureme::{FileSerializationSink, MmapSerializationSink};
+use tools_lib::testing_common;
 
 #[bench]
 fn bench_file_serialization_sink(bencher: &mut test::Bencher) {
diff --git a/tools_lib/src/event.rs b/tools_lib/src/event.rs
@@ -1,4 +1,4 @@
-use crate::raw_event::RawEvent;
+use measureme::RawEvent;
 use std::borrow::Cow;
 use std::time::{Duration, SystemTime};
 
diff --git a/tools_lib/src/lib.rs b/tools_lib/src/lib.rs
@@ -1 +1,22 @@
-pub mod stack_collapse;
+//! This crate provides a library with common functionality for measureme tools
+//!
+//! # Reading event trace files
+//!
+//! The main entry point for reading trace files is the [`ProfilingData`] struct.
+//!
+//! To create a [`ProfilingData`], call the [`ProfilingData::new()`] function and
+//! provide a `Path` with the directory and file name for the trace files.
+//!
+//! To retrieve an `Iterator` of all of the events in the file, call the [`ProfilingData::iter()`] method.
+//!
+//! [`ProfilingData`]: struct.ProfilingData.html
+//! [`ProfilingData::iter()`]: struct.ProfilingData.html#method.iter
+
+mod event;
+mod profiling_data;
+mod stack_collapse;
+pub mod testing_common;
+
+pub use crate::event::{Event, Timestamp};
+pub use crate::profiling_data::{ProfilingData, ProfilingDataBuilder};
+pub use crate::stack_collapse::collapse_stacks;
diff --git a/tools_lib/src/profiling_data.rs b/tools_lib/src/profiling_data.rs
@@ -1,12 +1,10 @@
-use crate::event::Event;
-use crate::file_header::{
+use crate::event::{Event, Timestamp};
+use measureme::file_header::{
     read_file_header, write_file_header, CURRENT_FILE_FORMAT_VERSION, FILE_HEADER_SIZE,
     FILE_MAGIC_EVENT_STREAM,
 };
-use crate::serialization::ByteVecSink;
-use crate::{
-    ProfilerFiles, RawEvent, SerializationSink, StringTable, StringTableBuilder, Timestamp,
-};
+use measureme::ByteVecSink;
+use measureme::{ProfilerFiles, RawEvent, SerializationSink, StringTable, StringTableBuilder};
 use std::error::Error;
 use std::fs;
 use std::mem;
diff --git a/tools_lib/src/stack_collapse.rs b/tools_lib/src/stack_collapse.rs
@@ -2,7 +2,7 @@ use rustc_hash::FxHashMap;
 use std::cmp;
 use std::time::SystemTime;
 
-use measureme::{Event, ProfilingData};
+use crate::{Event, ProfilingData};
 
 // This state is kept up-to-date while iteration over events.
 struct PerThreadState<'a> {
@@ -94,7 +94,7 @@ pub fn collapse_stacks<'a>(profiling_data: &ProfilingData) -> FxHashMap<String,
 
 #[cfg(test)]
 mod test {
-    use measureme::ProfilingDataBuilder;
+    use crate::ProfilingDataBuilder;
     use rustc_hash::FxHashMap;
 
     #[test]
diff --git a/tools_lib/src/testing_common.rs b/tools_lib/src/testing_common.rs
@@ -1,4 +1,5 @@
-use crate::{Event, Profiler, ProfilingData, SerializationSink, StringId, Timestamp};
+use crate::{Event, ProfilingData, Timestamp};
+use measureme::{Profiler, SerializationSink, StringId};
 use rustc_hash::FxHashMap;
 use std::borrow::Cow;
 use std::default::Default;
diff --git a/tools_lib/tests/serialization.rs b/tools_lib/tests/serialization.rs
@@ -1,5 +1,5 @@
-use measureme::testing_common::run_end_to_end_serialization_test;
 use measureme::{FileSerializationSink, MmapSerializationSink};
+use tools_lib::testing_common::run_end_to_end_serialization_test;
 
 #[test]
 fn test_file_serialization_sink() {
