Skip to content

Commit 949f059

Browse files
committed
Use serde for target spec json deserialize
The previous manual parsing of `serde_json::Value` was a lot of complicated code and extremely error-prone. It was full of janky behavior like sometimes ignoring type errors, sometimes erroring for type errors, sometimes warning for type errors, and sometimes just ICEing for type errors (the icing on the top). Additionally, many of the error messages about allowed values were out of date because they were in a completely different place than the FromStr impls. Overall, the system caused confusion for users. I also found the old deserialization code annoying to read. Whenever a `key!` invocation was found, one had to first look for the right macro arm, and no go to definition could help. This PR replaces all this manual parsing with a 2-step process involving serde. First, the string is parsed into a `TargetSpecJson` struct. This struct is a 1:1 representation of the spec JSON. It already parses all the enums and is very simple to read and write. Then, the fields from this struct are copied into the actual `Target`. The reason for this two-step process instead of just serializing into a `Target` is because of a few reasons 1. There are a few transformations performed between the two formats 2. The default logic is implemented this way. Otherwise all the default field values would have to be spelled out again, which is suboptimal. With this logic, they fall out naturally, because everything in the json struct is an `Option`. Overall, the mapping is pretty simple, with the vast majority of fields just doing a 1:1 mapping that is captured by two macros. I have deliberately avoided making the macros generic to keep them simple. All the `FromStr` impls now have the error message right inside them, which increases the chance of it being up to date. Some "`from_str`" impls were turned into proper `FromStr` impls to support this. The new code is much less involved, delegating all the JSON parsing logic to serde, without any manual type matching. This change introduces a few breaking changes for consumers. While it is possible to use this format on stable, it is very much subject to change, so breaking changes are expected. The hope is also that because of the way stricter behavior, breaking changes are easier to deal with, as they come with clearer error messages. 1. Invalid types now always error, everywhere. Previously, they would sometimes error, and sometimes just be ignored (which meant the users JSON was still broken, just silently!) 2. This now makes use of `deny_unknown_fields` instead of just warning on unused fields, which was done previously. Serde doesn't make it easy to get such warning behavior, which was the primary reason that this now changed. But I think error behavior is very reasonable too. If someone has random stale fields in their JSON, it is likely because these fields did something at some point but no longer do, and the user likely wants to be informed of this so they can figure out what to do. This is also relevant for the future. If we remove a field but someone has it set, it probably makes sense for them to take a look whether they need this and should look for alternatives, or whether they can just delete it. Overall, the JSON is made more explicit. This is the only expected breakage, but there could also be small breakage from small mistakes. All targets roundtrip though, so it can't be anything too major.
1 parent 6707bf0 commit 949f059

File tree

17 files changed

+667
-836
lines changed

17 files changed

+667
-836
lines changed

Cargo.lock

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4499,7 +4499,9 @@ dependencies = [
44994499
"rustc_macros",
45004500
"rustc_serialize",
45014501
"rustc_span",
4502+
"serde",
45024503
"serde_json",
4504+
"serde_path_to_error",
45034505
"tracing",
45044506
]
45054507

@@ -4870,6 +4872,16 @@ dependencies = [
48704872
"serde",
48714873
]
48724874

4875+
[[package]]
4876+
name = "serde_path_to_error"
4877+
version = "0.1.17"
4878+
source = "registry+https://github.com/rust-lang/crates.io-index"
4879+
checksum = "59fab13f937fa393d08645bf3a84bdfe86e296747b506ada67bb15f10f218b2a"
4880+
dependencies = [
4881+
"itoa",
4882+
"serde",
4883+
]
4884+
48734885
[[package]]
48744886
name = "serde_spanned"
48754887
version = "0.6.9"

compiler/rustc_session/src/config.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -336,12 +336,12 @@ impl LinkSelfContained {
336336
if let Some(component_to_enable) = component.strip_prefix('+') {
337337
self.explicitly_set = None;
338338
self.enabled_components
339-
.insert(LinkSelfContainedComponents::from_str(component_to_enable)?);
339+
.insert(LinkSelfContainedComponents::from_str(component_to_enable).ok()?);
340340
Some(())
341341
} else if let Some(component_to_disable) = component.strip_prefix('-') {
342342
self.explicitly_set = None;
343343
self.disabled_components
344-
.insert(LinkSelfContainedComponents::from_str(component_to_disable)?);
344+
.insert(LinkSelfContainedComponents::from_str(component_to_disable).ok()?);
345345
Some(())
346346
} else {
347347
None

compiler/rustc_session/src/options.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1295,7 +1295,7 @@ pub mod parse {
12951295
}
12961296

12971297
pub(crate) fn parse_linker_flavor(slot: &mut Option<LinkerFlavorCli>, v: Option<&str>) -> bool {
1298-
match v.and_then(LinkerFlavorCli::from_str) {
1298+
match v.and_then(|v| LinkerFlavorCli::from_str(v).ok()) {
12991299
Some(lf) => *slot = Some(lf),
13001300
_ => return false,
13011301
}

compiler/rustc_target/Cargo.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ rustc_fs_util = { path = "../rustc_fs_util" }
1212
rustc_macros = { path = "../rustc_macros" }
1313
rustc_serialize = { path = "../rustc_serialize" }
1414
rustc_span = { path = "../rustc_span" }
15+
serde = { version = "1.0.219", features = ["derive"] }
1516
serde_json = "1.0.59"
17+
serde_path_to_error = "0.1.17"
1618
tracing = "0.1"
1719
# tidy-alphabetical-end
1820

compiler/rustc_target/src/json.rs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,3 +114,18 @@ impl ToJson for rustc_abi::CanonAbi {
114114
self.to_string().to_json()
115115
}
116116
}
117+
118+
macro_rules! serde_deserialize_from_str {
119+
($ty:ty) => {
120+
impl<'de> serde::Deserialize<'de> for $ty {
121+
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
122+
where
123+
D: serde::Deserializer<'de>,
124+
{
125+
let s = String::deserialize(deserializer)?;
126+
FromStr::from_str(&s).map_err(serde::de::Error::custom)
127+
}
128+
}
129+
};
130+
}
131+
pub(crate) use serde_deserialize_from_str;

compiler/rustc_target/src/spec/json.rs

Lines changed: 373 additions & 652 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)