Skip to content

Better build progress report #3451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Better build progress report #3451

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9569948
Better build progress report.
Yamakaky Dec 24, 2016
cfff304
Better output handling.
Yamakaky Dec 24, 2016
d7b5fd9
Sort current jobs by start time.
Yamakaky Dec 24, 2016
fd972e3
Add support for documenting.
Yamakaky Dec 24, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 81 additions & 33 deletions src/cargo/ops/cargo_rustc/job_queue.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use std::collections::HashSet;
use std::collections::{HashSet, VecDeque};
use std::collections::hash_map::HashMap;
use std::fmt;
use std::io::Write;
Expand All @@ -24,7 +24,11 @@ pub struct JobQueue<'a> {
queue: DependencyQueue<Key<'a>, Vec<(Job, Freshness)>>,
tx: Sender<(Key<'a>, Message)>,
rx: Receiver<(Key<'a>, Message)>,
active: usize,
/// Packages currently compiling.
///
/// We want to keep the insert order so that the jobs are sorted by start
/// time.
active: VecDeque<(&'a PackageId, JobType)>,
pending: HashMap<Key<'a>, PendingBuild>,
compiled: HashSet<&'a PackageId>,
documented: HashSet<&'a PackageId>,
Expand All @@ -33,6 +37,18 @@ pub struct JobQueue<'a> {
is_doc_all: bool,
}

#[derive(Debug, Copy, Clone)]
enum JobType {
Compiling,
Documenting,
}

impl fmt::Display for JobType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
fmt::Debug::fmt(self, f)
}
}

/// A helper structure for metadata about the state of a building package.
struct PendingBuild {
/// Number of jobs currently active
Expand Down Expand Up @@ -84,7 +100,7 @@ impl<'a> JobQueue<'a> {
queue: DependencyQueue::new(),
tx: tx,
rx: rx,
active: 0,
active: VecDeque::new(),
pending: HashMap::new(),
compiled: HashSet::new(),
documented: HashSet::new(),
Expand Down Expand Up @@ -138,7 +154,7 @@ impl<'a> JobQueue<'a> {
let mut error = None;
let start_time = Instant::now();
loop {
while error.is_none() && self.active < self.jobs {
while error.is_none() && self.active.len() < self.jobs {
if !queue.is_empty() {
let (key, job, fresh) = queue.remove(0);
self.run(key, fresh, job, cx.config, scope)?;
Expand All @@ -157,36 +173,47 @@ impl<'a> JobQueue<'a> {
break
}
}
if self.active == 0 {
if self.active.len() == 0 {
break
}

let (key, msg) = self.rx.recv().unwrap();

match msg {
Message::Run(cmd) => {
cx.config.shell().verbose(|c| c.status("Running", &cmd))?;
self.update_display(cx.config, |_| {
Ok(cx.config.shell().verbose(|c| c.status("Running", &cmd))?)
})?;
}
Message::Stdout(out) => {
if cx.config.extra_verbose() {
writeln!(cx.config.shell().out(), "{}", out)?;
self.update_display(cx.config, |_| {
Ok(writeln!(cx.config.shell().out(), "{}", out)?)
})?;
}
}
Message::Stderr(err) => {
if cx.config.extra_verbose() {
writeln!(cx.config.shell().err(), "{}", err)?;
self.update_display(cx.config, |_| {
Ok(writeln!(cx.config.shell().err(), "{}", err)?)
})?;
}
}
Message::Finish(result) => {
info!("end: {:?}", key);
self.active -= 1;
self.update_display(cx.config, |self_| {
self_.active.retain(|x| x.0 != key.pkg);
cx.config.shell().status("Finished", key.pkg)
})?;
match result {
Ok(()) => self.finish(key, cx)?,
Err(e) => {
if self.active > 0 {
cx.config.shell().say(
"Build failed, waiting for other \
jobs to finish...", YELLOW)?;
if self.active.len() > 0 {
self.update_display(cx.config, |_| {
Ok(cx.config.shell().say(
"Build failed, waiting for other \
jobs to finish...", YELLOW)?)
})?;
}
if error.is_none() {
error = Some(e);
Expand Down Expand Up @@ -234,7 +261,6 @@ impl<'a> JobQueue<'a> {
scope: &Scope<'a>) -> CargoResult<()> {
info!("start: {:?}", key);

self.active += 1;
*self.counts.get_mut(key.pkg).unwrap() -= 1;

let my_tx = self.tx.clone();
Expand All @@ -256,9 +282,12 @@ impl<'a> JobQueue<'a> {
if key.profile.run_custom_build && cx.show_warnings(key.pkg) {
let output = cx.build_state.outputs.lock().unwrap();
if let Some(output) = output.get(&(key.pkg.clone(), key.kind)) {
for warning in output.warnings.iter() {
cx.config.shell().warn(warning)?;
}
self.update_display(cx.config, |_| {
for warning in output.warnings.iter() {
cx.config.shell().warn(warning)?;
}
Ok(())
})?;
}
}
let state = self.pending.get_mut(&key).unwrap();
Expand Down Expand Up @@ -287,23 +316,42 @@ impl<'a> JobQueue<'a> {
return Ok(())
}

match fresh {
// Any dirty stage which runs at least one command gets printed as
// being a compiled package
Dirty => {
if key.profile.doc {
self.documented.insert(key.pkg);
config.shell().status("Documenting", key.pkg)?;
} else {
self.compiled.insert(key.pkg);
config.shell().status("Compiling", key.pkg)?;
self.update_display(config, |self_| {
Ok(match fresh {
// Any dirty stage which runs at least one command gets printed as
// being a compiled package
Dirty => {
if key.profile.doc {
self_.documented.insert(key.pkg);
self_.active.push_back((key.pkg, JobType::Documenting));
} else {
self_.compiled.insert(key.pkg);
self_.active.push_back((key.pkg, JobType::Compiling));
}
}
}
Fresh if self.counts[key.pkg] == 0 => {
self.compiled.insert(key.pkg);
config.shell().verbose(|c| c.status("Fresh", key.pkg))?;
}
Fresh => {}
Fresh if self_.counts[key.pkg] == 0 => {
self_.compiled.insert(key.pkg);
config.shell().verbose(|c| c.status("Fresh", key.pkg))?;
}
Fresh => {}
})
})
}

/// Cleans the display before printing the message.
fn update_display<F>(&mut self, config: &Config, f: F) -> CargoResult<()>
where F: FnOnce(&mut Self) -> CargoResult<()>
{
// Move up n lines.
println!("\x1B[{}A", self.active.len() + 1);

// Clear line
print!("\x1B[100D\x1B[2K");
f(self)?;

for &(pkg, job_type) in &self.active {
print!("\x1B[100D\x1B[2K");
config.shell().status(job_type, pkg)?;
}
Ok(())
}
Expand Down