Skip to content

Commit 9f6d798

Browse files
alexcrichtonalexcrichton
committed
Emit more info on --message-format=json
This adds more output on Cargo's behalf to the output of `--message-format=json`. Cargo will now emit a message when a crate is finished compiling with a list of all files that were just generated along with a message when a build script finishes executing with linked libraries and linked library paths. Closes #3212
1 parent 71a6cc9 commit 9f6d798

File tree

6 files changed

+144
-35
lines changed

6 files changed

+144
-35
lines changed

‎src/cargo/core/manifest.rs

+20-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ impl Encodable for TargetKind {
123123
}
124124
}
125125

126-
#[derive(RustcEncodable, RustcDecodable, Clone, PartialEq, Eq, Debug, Hash)]
126+
#[derive(Clone, PartialEq, Eq, Debug, Hash)]
127127
pub struct Profile {
128128
pub opt_level: String,
129129
pub lto: bool,
@@ -139,6 +139,25 @@ pub struct Profile {
139139
pub panic: Option<String>,
140140
}
141141

142+
#[derive(RustcEncodable)]
143+
struct SerializedProfile<'a> {
144+
opt_level: &'a str,
145+
debuginfo: bool,
146+
debug_assertions: bool,
147+
test: bool,
148+
}
149+
150+
impl Encodable for Profile {
151+
fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
152+
SerializedProfile {
153+
opt_level: &self.opt_level,
154+
debuginfo: self.debuginfo,
155+
debug_assertions: self.debug_assertions,
156+
test: self.test,
157+
}.encode(s)
158+
}
159+
}
160+
142161
#[derive(Default, Clone, Debug, PartialEq, Eq)]
143162
pub struct Profiles {
144163
pub release: Profile,

‎src/cargo/ops/cargo_compile.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ pub fn compile_ws<'a>(ws: &Workspace<'a>,
251251
let mut build_config = scrape_build_config(config, jobs, target)?;
252252
build_config.release = release;
253253
build_config.test = mode == CompileMode::Test || mode == CompileMode::Bench;
254-
build_config.json_errors = message_format == MessageFormat::Json;
254+
build_config.json_messages = message_format == MessageFormat::Json;
255255
if let CompileMode::Doc { deps } = mode {
256256
build_config.doc_all = deps;
257257
}
@@ -512,7 +512,7 @@ fn scrape_target_config(config: &Config, triple: &str)
512512
let (flags, definition) = value.string(&k)?;
513513
let whence = format!("in `{}` (in {})", key,
514514
definition.display());
515-
let (paths, links) =
515+
let (paths, links) =
516516
BuildOutput::parse_rustc_flags(&flags, &whence)
517517
?;
518518
output.library_paths.extend(paths);

‎src/cargo/ops/cargo_rustc/custom_build.rs

+15
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ use std::sync::{Mutex, Arc};
77
use core::PackageId;
88
use util::{CargoResult, Human, Freshness, Cfg};
99
use util::{internal, ChainError, profile, paths};
10+
use util::machine_message;
1011

1112
use super::job::Work;
1213
use super::{fingerprint, Kind, Context, Unit};
@@ -168,6 +169,7 @@ fn build_work<'a, 'cfg>(cx: &mut Context<'a, 'cfg>, unit: &Unit<'a>)
168169
output_file.clone());
169170
let build_scripts = super::load_build_deps(cx, unit);
170171
let kind = unit.kind;
172+
let json_messages = cx.build_config.json_messages;
171173

172174
// Check to see if the build script as already run, and if it has keep
173175
// track of whether it has told us about some explicit dependencies
@@ -242,6 +244,19 @@ fn build_work<'a, 'cfg>(cx: &mut Context<'a, 'cfg>, unit: &Unit<'a>)
242244
// state informing what variables were discovered via our script as
243245
// well.
244246
let parsed_output = BuildOutput::parse(&output.stdout, &pkg_name)?;
247+
248+
if json_messages {
249+
let library_paths = parsed_output.library_paths.iter().map(|l| {
250+
l.display().to_string()
251+
}).collect::<Vec<_>>();
252+
machine_message::emit(machine_message::BuildScript {
253+
package_id: &id,
254+
linked_libs: &parsed_output.library_links,
255+
linked_paths: &library_paths,
256+
cfgs: &parsed_output.cfgs,
257+
});
258+
}
259+
245260
build_state.insert(id, kind, parsed_output);
246261
Ok(())
247262
});

‎src/cargo/ops/cargo_rustc/mod.rs

+27-10
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pub struct BuildConfig {
4242
pub release: bool,
4343
pub test: bool,
4444
pub doc_all: bool,
45-
pub json_errors: bool,
45+
pub json_messages: bool,
4646
}
4747

4848
#[derive(Clone, Default)]
@@ -246,9 +246,15 @@ fn rustc(cx: &mut Context, unit: &Unit) -> CargoResult<Work> {
246246
let cwd = cx.config.cwd().to_path_buf();
247247

248248
rustc.args(&cx.rustflags_args(unit)?);
249-
let json_errors = cx.build_config.json_errors;
249+
let json_messages = cx.build_config.json_messages;
250250
let package_id = unit.pkg.package_id().clone();
251251
let target = unit.target.clone();
252+
let profile = unit.profile.clone();
253+
let features = cx.resolve.features(unit.pkg.package_id())
254+
.into_iter()
255+
.flat_map(|i| i)
256+
.map(|s| s.to_string())
257+
.collect::<Vec<_>>();
252258
return Ok(Work::new(move |state| {
253259
// Only at runtime have we discovered what the extra -L and -l
254260
// arguments are for native libraries, so we process those here. We
@@ -273,7 +279,7 @@ fn rustc(cx: &mut Context, unit: &Unit) -> CargoResult<Work> {
273279
}
274280

275281
state.running(&rustc);
276-
if json_errors {
282+
if json_messages {
277283
rustc.exec_with_streaming(
278284
&mut |line| if !line.is_empty() {
279285
Err(internal(&format!("compiler stdout is not empty: `{}`", line)))
@@ -285,12 +291,11 @@ fn rustc(cx: &mut Context, unit: &Unit) -> CargoResult<Work> {
285291
internal(&format!("compiler produced invalid json: `{}`", line))
286292
})?;
287293

288-
machine_message::FromCompiler::new(
289-
&package_id,
290-
&target,
291-
compiler_message
292-
).emit();
293-
294+
machine_message::emit(machine_message::FromCompiler {
295+
package_id: &package_id,
296+
target: &target,
297+
message: compiler_message,
298+
});
294299
Ok(())
295300
},
296301
).map(|_| ())
@@ -321,6 +326,18 @@ fn rustc(cx: &mut Context, unit: &Unit) -> CargoResult<Work> {
321326
fingerprint::append_current_dir(&dep_info_loc, &cwd)?;
322327
}
323328

329+
if json_messages {
330+
machine_message::emit(machine_message::Artifact {
331+
package_id: &package_id,
332+
target: &target,
333+
profile: &profile,
334+
features: features,
335+
filenames: filenames.iter().map(|&(ref src, _, _)| {
336+
src.display().to_string()
337+
}).collect(),
338+
});
339+
}
340+
324341
Ok(())
325342
}));
326343

@@ -527,7 +544,7 @@ fn build_base_args(cx: &mut Context,
527544
cmd.arg("--color").arg(&color_config.to_string());
528545
}
529546

530-
if cx.build_config.json_errors {
547+
if cx.build_config.json_messages {
531548
cmd.arg("--error-format").arg("json");
532549
}
533550

‎src/cargo/util/machine_message.rs

+52-22
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,60 @@
1-
use rustc_serialize::json;
2-
use core::{PackageId, Target};
1+
use rustc_serialize::Encodable;
2+
use rustc_serialize::json::{self, Json};
3+
4+
use core::{PackageId, Target, Profile};
5+
6+
pub trait Message: Encodable {
7+
fn reason(&self) -> &str;
8+
}
9+
10+
pub fn emit<T: Message>(t: T) {
11+
let json = json::encode(&t).unwrap();
12+
let mut map = match json.parse().unwrap() {
13+
Json::Object(obj) => obj,
14+
_ => panic!("not a json object"),
15+
};
16+
map.insert("reason".to_string(), Json::String(t.reason().to_string()));
17+
println!("{}", Json::Object(map));
18+
}
319

420
#[derive(RustcEncodable)]
521
pub struct FromCompiler<'a> {
6-
reason: &'static str,
7-
package_id: &'a PackageId,
8-
target: &'a Target,
9-
message: json::Json,
10-
}
11-
12-
impl<'a> FromCompiler<'a> {
13-
pub fn new(package_id: &'a PackageId,
14-
target: &'a Target,
15-
message: json::Json)
16-
-> FromCompiler<'a> {
17-
FromCompiler {
18-
reason: "compiler-message",
19-
package_id: package_id,
20-
target: target,
21-
message: message,
22-
}
22+
pub package_id: &'a PackageId,
23+
pub target: &'a Target,
24+
pub message: json::Json,
25+
}
26+
27+
impl<'a> Message for FromCompiler<'a> {
28+
fn reason(&self) -> &str {
29+
"compiler-message"
2330
}
31+
}
2432

25-
pub fn emit(self) {
26-
let json = json::encode(&self).unwrap();
27-
println!("{}", json);
33+
#[derive(RustcEncodable)]
34+
pub struct Artifact<'a> {
35+
pub package_id: &'a PackageId,
36+
pub target: &'a Target,
37+
pub profile: &'a Profile,
38+
pub features: Vec<String>,
39+
pub filenames: Vec<String>,
40+
}
41+
42+
impl<'a> Message for Artifact<'a> {
43+
fn reason(&self) -> &str {
44+
"compiler-artifact"
2845
}
2946
}
3047

48+
#[derive(RustcEncodable)]
49+
pub struct BuildScript<'a> {
50+
pub package_id: &'a PackageId,
51+
pub linked_libs: &'a [String],
52+
pub linked_paths: &'a [String],
53+
pub cfgs: &'a [String],
54+
}
55+
56+
impl<'a> Message for BuildScript<'a> {
57+
fn reason(&self) -> &str {
58+
"build-script-executed"
59+
}
60+
}

‎tests/build.rs

+28
Original file line numberDiff line numberDiff line change
@@ -2411,6 +2411,20 @@ fn compiler_json_error_format() {
24112411
}
24122412
}
24132413
2414+
{
2415+
"reason":"compiler-artifact",
2416+
"profile": {
2417+
"debug_assertions": true,
2418+
"debuginfo": true,
2419+
"opt_level": "0",
2420+
"test": false
2421+
},
2422+
"features": [],
2423+
"package_id":"bar 0.5.0 ([..])",
2424+
"target":{"kind":["lib"],"name":"bar","src_path":"[..]lib.rs"},
2425+
"filenames":["[..].rlib"]
2426+
}
2427+
24142428
{
24152429
"reason":"compiler-message",
24162430
"package_id":"foo 0.5.0 ([..])",
@@ -2426,6 +2440,20 @@ fn compiler_json_error_format() {
24262440
}]
24272441
}
24282442
}
2443+
2444+
{
2445+
"reason":"compiler-artifact",
2446+
"package_id":"foo 0.5.0 ([..])",
2447+
"target":{"kind":["bin"],"name":"foo","src_path":"[..]main.rs"},
2448+
"profile": {
2449+
"debug_assertions": true,
2450+
"debuginfo": true,
2451+
"opt_level": "0",
2452+
"test": false
2453+
},
2454+
"features": [],
2455+
"filenames": ["[..]"]
2456+
}
24292457
"#));
24302458
}
24312459

0 commit comments

Comments
 (0)