use std::fs::File;
use std::io::{stdout, BufReader, Error, ErrorKind, Read, Write};
use instant::Instant;
use crate::{prettyprint_usize, PROGRESS_FREQUENCY_SECONDS};
pub fn elapsed_seconds(since: Instant) -> f64 {
let dt = since.elapsed();
(dt.as_secs() as f64) + (f64::from(dt.subsec_nanos()) * 1e-9)
}
#[derive(Debug)]
struct Progress {
label: String,
processed_items: usize,
total_items: usize,
started_at: Instant,
last_printed_at: Instant,
first_update: bool,
}
impl Progress {
fn new(label: String, total_items: usize) -> Progress {
Progress {
label,
processed_items: 0,
total_items,
started_at: Instant::now(),
last_printed_at: Instant::now(),
first_update: true,
}
}
fn next<'a>(
&mut self,
maybe_sink: &mut Option<Box<dyn TimerSink + 'a>>,
) -> Option<(f64, String)> {
self.processed_items += 1;
if self.processed_items > self.total_items {
panic!(
"{} is too few items for {} progress",
prettyprint_usize(self.total_items),
self.label
);
}
if self.processed_items == self.total_items {
let elapsed = elapsed_seconds(self.started_at);
let line = format!(
"{} ({})... {}",
self.label,
prettyprint_usize(self.total_items),
prettyprint_time(elapsed)
);
if self.total_items == 1 {
Timer::selfless_println(maybe_sink, line.clone());
} else {
clear_current_line();
println!("{}", line);
if let Some(ref mut sink) = maybe_sink {
sink.reprintln(line.clone());
}
}
return Some((elapsed, line));
} else if elapsed_seconds(self.last_printed_at) >= PROGRESS_FREQUENCY_SECONDS {
self.last_printed_at = Instant::now();
let line = format!(
"{}: {}/{}... {}",
self.label,
prettyprint_usize(self.processed_items),
prettyprint_usize(self.total_items),
prettyprint_time(elapsed_seconds(self.started_at))
);
clear_current_line();
print!("{}", line);
stdout().flush().unwrap();
if let Some(ref mut sink) = maybe_sink {
if self.first_update {
sink.println(line);
self.first_update = false;
} else {
sink.reprintln(line);
}
}
}
None
}
fn cancel_iter_early(&mut self) -> f64 {
elapsed_seconds(self.started_at)
}
}
enum StackEntry {
TimerSpan(TimerSpan),
Progress(Progress),
File(TimedFileReader),
}
pub trait TimerSink {
fn println(&mut self, line: String);
fn reprintln(&mut self, line: String);
}
pub struct Timer<'a> {
results: Vec<String>,
stack: Vec<StackEntry>,
outermost_name: String,
notes: Vec<String>,
pub(crate) warnings: Vec<String>,
pub(crate) errors: Vec<String>,
sink: Option<Box<dyn TimerSink + 'a>>,
}
struct TimerSpan {
name: String,
started_at: Instant,
nested_results: Vec<String>,
nested_time: f64,
}
pub enum Parallelism {
Fastest,
Polite,
}
impl<'a> Timer<'a> {
pub fn new<S: Into<String>>(raw_name: S) -> Timer<'a> {
let name = raw_name.into();
let mut t = Timer {
results: Vec::new(),
stack: Vec::new(),
outermost_name: name.clone(),
notes: Vec::new(),
warnings: Vec::new(),
errors: Vec::new(),
sink: None,
};
t.start(name);
t
}
pub fn new_with_sink(name: &str, sink: Box<dyn TimerSink + 'a>) -> Timer<'a> {
let mut t = Timer::new(name);
t.sink = Some(sink);
t
}
pub fn throwaway() -> Timer<'a> {
Timer::new("throwaway")
}
fn println(&mut self, line: String) {
Timer::selfless_println(&mut self.sink, line);
}
fn selfless_println(maybe_sink: &mut Option<Box<dyn TimerSink + 'a>>, line: String) {
#[cfg(not(target_arch = "wasm32"))]
{
println!("{}", line);
}
#[cfg(target_arch = "wasm32")]
{
debug!("{}", line);
}
if let Some(ref mut sink) = maybe_sink {
sink.println(line);
}
}
pub fn note(&mut self, line: String) {
if let Some(StackEntry::Progress(_)) = self.stack.last() {
self.println(String::new());
}
self.println(line.clone());
self.notes.push(line);
}
pub fn warn(&mut self, line: String) {
self.warnings.push(line);
}
pub fn error(&mut self, line: String) {
self.errors.push(line);
}
pub fn done(self) {}
pub fn start<S: Into<String>>(&mut self, raw_name: S) {
if self.outermost_name == "throwaway" {
return;
}
let name = raw_name.into();
self.println(format!("{}...", name));
self.stack.push(StackEntry::TimerSpan(TimerSpan {
name,
started_at: Instant::now(),
nested_results: Vec::new(),
nested_time: 0.0,
}));
}
pub fn stop<S: Into<String>>(&mut self, raw_name: S) {
if self.outermost_name == "throwaway" {
return;
}
let name = raw_name.into();
let span = match self.stack.pop().unwrap() {
StackEntry::TimerSpan(s) => s,
StackEntry::Progress(p) => panic!("stop() during unfinished start_iter(): {:?}", p),
StackEntry::File(f) => panic!("stop() while reading file {}", f.path),
};
assert_eq!(span.name, name);
let elapsed = elapsed_seconds(span.started_at);
let line = format!("{} took {}", name, prettyprint_time(elapsed));
let padding = " ".repeat(self.stack.len());
match self.stack.last_mut() {
Some(StackEntry::TimerSpan(ref mut s)) => {
s.nested_results.push(format!("{}- {}", padding, line));
s.nested_results.extend(span.nested_results);
if span.nested_time != 0.0 {
Timer::selfless_println(
&mut self.sink,
format!(
"{}... plus {}",
name,
prettyprint_time(elapsed - span.nested_time)
),
);
s.nested_results.push(format!(
" {}- ... plus {}",
padding,
prettyprint_time(elapsed - span.nested_time)
));
}
s.nested_time += elapsed;
}
Some(_) => unreachable!(),
None => {
self.results.push(format!("{}- {}", padding, line));
self.results.extend(span.nested_results);
if span.nested_time != 0.0 {
self.println(format!(
"{}... plus {}",
name,
prettyprint_time(elapsed - span.nested_time)
));
self.results.push(format!(
" - ... plus {}",
prettyprint_time(elapsed - span.nested_time)
));
}
}
}
self.println(line);
}
pub fn start_iter<S: Into<String>>(&mut self, raw_name: S, total_items: usize) {
if self.outermost_name == "throwaway" {
return;
}
if total_items == 0 {
return;
}
let name = raw_name.into();
if let Some(StackEntry::Progress(p)) = self.stack.last() {
panic!(
"Can't start_iter({}) while Progress({}) is top of the stack",
name, p.label
);
}
self.stack
.push(StackEntry::Progress(Progress::new(name, total_items)));
}
pub fn next(&mut self) {
if self.outermost_name == "throwaway" {
return;
}
let maybe_result =
if let Some(StackEntry::Progress(ref mut progress)) = self.stack.last_mut() {
progress.next(&mut self.sink)
} else {
panic!("Can't next() while a TimerSpan is top of the stack");
};
if let Some((elapsed, result)) = maybe_result {
self.stack.pop();
self.add_result(elapsed, result);
}
}
pub fn cancel_iter_early(&mut self) {
if self.outermost_name == "throwaway" {
return;
}
let elapsed = if let Some(StackEntry::Progress(ref mut progress)) = self.stack.last_mut() {
progress.cancel_iter_early()
} else {
panic!("Can't cancel_iter_early() while a TimerSpan is top of the stack");
};
self.stack.pop();
self.add_result(elapsed, format!("cancelled early"));
}
pub(crate) fn add_result(&mut self, elapsed: f64, line: String) {
let padding = " ".repeat(self.stack.len());
match self.stack.last_mut() {
Some(StackEntry::TimerSpan(ref mut s)) => {
s.nested_results.push(format!("{}- {}", padding, line));
s.nested_time += elapsed;
}
Some(_) => unreachable!(),
None => {
self.results.push(format!("{}- {}", padding, line));
}
}
}
pub fn parallelize<I, O, F: Fn(I) -> O>(
&mut self,
timer_name: &str,
parallelism: Parallelism,
requests: Vec<I>,
cb: F,
) -> Vec<O>
where
I: Send,
O: Send,
F: Send + Clone + Copy,
{
#[cfg(target_arch = "wasm32")]
{
let _ = parallelism;
let mut results: Vec<O> = Vec::new();
self.start_iter(timer_name, requests.len());
for req in requests {
self.next();
results.push(cb(req));
}
return results;
}
#[cfg(not(target_arch = "wasm32"))]
{
let cpus = match parallelism {
Parallelism::Fastest => num_cpus::get(),
Parallelism::Polite => num_cpus::get() / 2,
}
.max(1) as u32;
scoped_threadpool::Pool::new(cpus).scoped(|scope| {
let (tx, rx) = std::sync::mpsc::channel();
let mut results: Vec<Option<O>> = std::iter::repeat_with(|| None)
.take(requests.len())
.collect();
for (idx, req) in requests.into_iter().enumerate() {
let tx = tx.clone();
scope.execute(move || {
tx.send((idx, cb(req))).unwrap();
});
}
drop(tx);
self.start_iter(timer_name, results.len());
for (idx, result) in rx.iter() {
self.next();
results[idx] = Some(result);
}
results.into_iter().map(|x| x.unwrap()).collect()
})
}
}
pub(crate) fn read_file(&mut self, path: &str) -> Result<(), String> {
self.stack.push(StackEntry::File(
TimedFileReader::new(path).map_err(|err| err.to_string())?,
));
Ok(())
}
}
impl<'a> std::ops::Drop for Timer<'a> {
fn drop(&mut self) {
if self.outermost_name == "throwaway" {
return;
}
let stop_name = self.outermost_name.clone();
match self.stack.last() {
Some(StackEntry::TimerSpan(ref s)) => {
if s.name != stop_name {
println!("dropping Timer during {}, due to panic?", s.name);
return;
}
}
Some(StackEntry::File(ref r)) => {
println!("dropping Timer while reading {}, due to panic?", r.path);
return;
}
Some(StackEntry::Progress(ref p)) => {
println!(
"dropping Timer while doing progress {}, due to panic?",
p.label
);
return;
}
None => unreachable!(),
}
self.stop(&stop_name);
assert!(self.stack.is_empty());
self.println(String::new());
for line in &self.results {
Timer::selfless_println(&mut self.sink, line.to_string());
}
self.println(String::new());
if !self.notes.is_empty() {
self.println(format!("{} notes:", self.notes.len()));
for line in &self.notes {
Timer::selfless_println(&mut self.sink, line.to_string());
}
self.println(String::new());
}
if !self.warnings.is_empty() {
self.println(format!("{} warnings:", self.warnings.len()));
for line in &self.warnings {
Timer::selfless_println(&mut self.sink, line.to_string());
}
self.println(String::new());
}
if !self.errors.is_empty() {
self.println(format!("***** {} errors: *****", self.errors.len()));
for line in &self.errors {
Timer::selfless_println(&mut self.sink, line.to_string());
}
self.println(String::new());
}
Timer::selfless_println(&mut self.sink, self.results[0].clone());
if std::thread::panicking() {
self.println(String::new());
self.println(String::new());
self.println(String::new());
self.println(String::new());
self.println(
"!!! The program panicked, look above for the stack trace !!!".to_string(),
);
}
}
}
pub fn prettyprint_time(seconds: f64) -> String {
format!("{:.4}s", seconds)
}
#[cfg(unix)]
pub fn clear_current_line() {
if let Ok((terminal_width, _)) = termion::terminal_size() {
print!(
"{}{}",
termion::clear::CurrentLine,
termion::cursor::Left(terminal_width)
);
} else {
print!("\r");
}
}
#[cfg(not(unix))]
pub fn clear_current_line() {
print!("\r");
}
struct TimedFileReader {
inner: BufReader<File>,
path: String,
processed_bytes: usize,
total_bytes: usize,
started_at: Instant,
last_printed_at: Option<Instant>,
}
impl TimedFileReader {
fn new(path: &str) -> Result<TimedFileReader, Error> {
let file = File::open(path)?;
let total_bytes = file.metadata()?.len() as usize;
Ok(TimedFileReader {
inner: BufReader::new(file),
path: path.to_string(),
processed_bytes: 0,
total_bytes,
started_at: Instant::now(),
last_printed_at: None,
})
}
}
impl<'a> Read for Timer<'a> {
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error> {
let mut file = match self.stack.last_mut() {
Some(StackEntry::File(ref mut f)) => f,
_ => {
return Err(Error::new(
ErrorKind::Other,
"trying to read when Timer doesn't have file on the stack?!",
));
}
};
let bytes = file.inner.read(buf)?;
file.processed_bytes += bytes;
if file.processed_bytes > file.total_bytes {
panic!(
"{} is too many bytes read from {}",
prettyprint_usize(file.processed_bytes),
file.path
);
}
if file.processed_bytes == file.total_bytes {
let elapsed = elapsed_seconds(file.started_at);
let line = format!(
"Read {} ({})... {}",
file.path,
prettyprint_usize(file.total_bytes / 1024 / 1024),
prettyprint_time(elapsed)
);
if self.outermost_name != "throwaway" {
if file.last_printed_at.is_none() {
self.println(line.clone());
} else {
clear_current_line();
println!("{}", line);
if let Some(ref mut sink) = self.sink {
sink.reprintln(line.clone());
}
}
}
self.stack.pop();
self.add_result(elapsed, line);
} else if file.last_printed_at.is_none()
|| elapsed_seconds(file.last_printed_at.unwrap()) >= PROGRESS_FREQUENCY_SECONDS
{
if self.outermost_name != "throwaway" {
let line = format!(
"Reading {}: {}/{} MB... {}",
file.path,
prettyprint_usize(file.processed_bytes / 1024 / 1024),
prettyprint_usize(file.total_bytes / 1024 / 1024),
prettyprint_time(elapsed_seconds(file.started_at))
);
clear_current_line();
print!("{}", line);
stdout().flush().unwrap();
if let Some(ref mut sink) = self.sink {
if file.last_printed_at.is_none() {
sink.println(line);
} else {
sink.reprintln(line);
}
}
}
file.last_printed_at = Some(Instant::now());
}
Ok(bytes)
}
}