rustc_target/spec/
json.rs

1use std::collections::BTreeMap;
2use std::str::FromStr;
3
4use rustc_abi::{Align, AlignFromBytesError};
5
6use super::crt_objects::CrtObjects;
7use super::{
8    BinaryFormat, CodeModel, DebuginfoKind, FloatAbi, FramePointer, LinkArgsCli,
9    LinkSelfContainedComponents, LinkSelfContainedDefault, LinkerFlavorCli, LldFlavor,
10    MergeFunctions, PanicStrategy, RelocModel, RelroLevel, RustcAbi, SanitizerSet,
11    SmallDataThresholdSupport, SplitDebuginfo, StackProbeType, StaticCow, SymbolVisibility, Target,
12    TargetKind, TargetOptions, TargetWarnings, TlsModel,
13};
14use crate::json::{Json, ToJson};
15use crate::spec::AbiMap;
16
17impl Target {
18    /// Loads a target descriptor from a JSON object.
19    pub fn from_json(json: &str) -> Result<(Target, TargetWarnings), String> {
20        let json_deserializer = &mut serde_json::Deserializer::from_str(json);
21
22        let json: TargetSpecJson =
23            serde_path_to_error::deserialize(json_deserializer).map_err(|err| err.to_string())?;
24
25        let mut base = Target {
26            llvm_target: json.llvm_target,
27            metadata: Default::default(),
28            pointer_width: json
29                .target_pointer_width
30                .parse()
31                .map_err(|err| format!("invalid target-pointer-width: {err}"))?,
32            data_layout: json.data_layout,
33            arch: json.arch,
34            options: Default::default(),
35        };
36
37        // FIXME: This doesn't properly validate anything and just ignores the data if it's invalid.
38        // That's okay for now, the only use of this is when generating docs, which we don't do for
39        // custom targets.
40        if let Some(metadata) = json.metadata {
41            base.metadata.description = metadata.description;
42            base.metadata.tier = metadata.tier.filter(|tier| (1..=3).contains(tier));
43            base.metadata.host_tools = metadata.host_tools;
44            base.metadata.std = metadata.std;
45        }
46
47        let alignment_error = |field_name: &str, error: AlignFromBytesError| -> String {
48            let msg = match error {
49                AlignFromBytesError::NotPowerOfTwo(_) => "not a power of 2 number of bytes",
50                AlignFromBytesError::TooLarge(_) => "too large",
51            };
52            format!("`{}` bits is not a valid value for {field_name}: {msg}", error.align() * 8)
53        };
54
55        macro_rules! forward {
56            ($name:ident) => {
57                if let Some($name) = json.$name {
58                    base.$name = $name;
59                }
60            };
61        }
62        macro_rules! forward_opt {
63            ($name:ident) => {
64                if let Some($name) = json.$name {
65                    base.$name = Some($name);
66                }
67            };
68        }
69
70        if let Some(target_endian) = json.target_endian {
71            base.endian = target_endian.0;
72        }
73
74        forward!(frame_pointer);
75        forward!(c_int_width);
76        forward_opt!(c_enum_min_bits); // if None, matches c_int_width
77        forward!(os);
78        forward!(env);
79        forward!(abi);
80        forward!(vendor);
81        forward_opt!(linker);
82        forward!(linker_flavor_json);
83        forward!(lld_flavor_json);
84        forward!(linker_is_gnu_json);
85        forward!(pre_link_objects);
86        forward!(post_link_objects);
87        forward!(pre_link_objects_self_contained);
88        forward!(post_link_objects_self_contained);
89
90        // Deserializes the backwards-compatible variants of `-Clink-self-contained`
91        if let Some(link_self_contained) = json.link_self_contained_backwards_compatible {
92            base.link_self_contained = link_self_contained;
93        }
94        // Deserializes the components variant of `-Clink-self-contained`
95        if let Some(link_self_contained) = json.link_self_contained {
96            let components = link_self_contained
97                .components
98                .into_iter()
99                .fold(LinkSelfContainedComponents::empty(), |a, b| a | b);
100            base.link_self_contained = LinkSelfContainedDefault::WithComponents(components);
101        }
102
103        forward!(pre_link_args_json);
104        forward!(late_link_args_json);
105        forward!(late_link_args_dynamic_json);
106        forward!(late_link_args_static_json);
107        forward!(post_link_args_json);
108        forward_opt!(link_script);
109
110        if let Some(link_env) = json.link_env {
111            for s in link_env {
112                if let [k, v] = *s.split('=').collect::<Vec<_>>() {
113                    base.link_env.to_mut().push((k.to_string().into(), v.to_string().into()))
114                } else {
115                    return Err(format!("link-env value '{s}' must be of the pattern 'KEY=VALUE'"));
116                }
117            }
118        }
119
120        forward!(link_env_remove);
121        forward!(asm_args);
122        forward!(cpu);
123        forward!(need_explicit_cpu);
124        forward!(features);
125        forward!(dynamic_linking);
126        forward_opt!(direct_access_external_data);
127        forward!(dll_tls_export);
128        forward!(only_cdylib);
129        forward!(executables);
130        forward!(relocation_model);
131        forward_opt!(code_model);
132        forward!(tls_model);
133        forward!(disable_redzone);
134        forward!(function_sections);
135        forward!(dll_prefix);
136        forward!(dll_suffix);
137        forward!(exe_suffix);
138        forward!(staticlib_prefix);
139        forward!(staticlib_suffix);
140
141        if let Some(target_family) = json.target_family {
142            match target_family {
143                TargetFamiliesJson::Array(families) => base.families = families,
144                TargetFamiliesJson::String(family) => base.families = vec![family].into(),
145            }
146        }
147
148        forward!(abi_return_struct_as_int);
149        forward!(is_like_aix);
150        forward!(is_like_darwin);
151        forward!(is_like_solaris);
152        forward!(is_like_windows);
153        forward!(is_like_msvc);
154        forward!(is_like_wasm);
155        forward!(is_like_android);
156        forward!(is_like_vexos);
157        forward!(binary_format);
158        forward!(default_dwarf_version);
159        forward!(allows_weak_linkage);
160        forward!(has_rpath);
161        forward!(no_default_libraries);
162        forward!(position_independent_executables);
163        forward!(static_position_independent_executables);
164        forward!(plt_by_default);
165        forward!(relro_level);
166        forward!(archive_format);
167        forward!(allow_asm);
168        forward!(main_needs_argc_argv);
169        forward!(has_thread_local);
170        forward!(obj_is_bitcode);
171        forward_opt!(max_atomic_width);
172        forward_opt!(min_atomic_width);
173        forward!(atomic_cas);
174        forward!(panic_strategy);
175        forward!(crt_static_allows_dylibs);
176        forward!(crt_static_default);
177        forward!(crt_static_respected);
178        forward!(stack_probes);
179
180        if let Some(min_global_align) = json.min_global_align {
181            match Align::from_bits(min_global_align) {
182                Ok(align) => base.min_global_align = Some(align),
183                Err(e) => return Err(alignment_error("min-global-align", e)),
184            }
185        }
186
187        forward_opt!(default_codegen_units);
188        forward_opt!(default_codegen_backend);
189        forward!(trap_unreachable);
190        forward!(requires_lto);
191        forward!(singlethread);
192        forward!(no_builtins);
193        forward_opt!(default_visibility);
194        forward!(emit_debug_gdb_scripts);
195        forward!(requires_uwtable);
196        forward!(default_uwtable);
197        forward!(simd_types_indirect);
198        forward!(limit_rdylib_exports);
199        forward_opt!(override_export_symbols);
200        forward!(merge_functions);
201        forward!(mcount);
202        forward_opt!(llvm_mcount_intrinsic);
203        forward!(llvm_abiname);
204        forward_opt!(llvm_floatabi);
205        forward_opt!(rustc_abi);
206        forward!(relax_elf_relocations);
207        forward!(llvm_args);
208        forward!(use_ctors_section);
209        forward!(eh_frame_header);
210        forward!(has_thumb_interworking);
211        forward!(debuginfo_kind);
212        forward!(split_debuginfo);
213        forward!(supported_split_debuginfo);
214
215        if let Some(supported_sanitizers) = json.supported_sanitizers {
216            base.supported_sanitizers =
217                supported_sanitizers.into_iter().fold(SanitizerSet::empty(), |a, b| a | b);
218        }
219
220        forward!(generate_arange_section);
221        forward!(supports_stack_protector);
222        forward!(small_data_threshold_support);
223        forward!(entry_name);
224        forward!(supports_xray);
225
226        // we're going to run `update_from_cli`, but that won't change the target's AbiMap
227        // FIXME: better factor the Target definition so we enforce this on a type level
228        let abi_map = AbiMap::from_target(&base);
229        if let Some(entry_abi) = json.entry_abi {
230            base.options.entry_abi = abi_map.canonize_abi(entry_abi.0, false).unwrap();
231        }
232
233        base.update_from_cli();
234        base.check_consistency(TargetKind::Json)?;
235
236        Ok((base, TargetWarnings { unused_fields: vec![] }))
237    }
238}
239
240impl ToJson for Target {
241    fn to_json(&self) -> Json {
242        let mut d = serde_json::Map::new();
243        let default: TargetOptions = Default::default();
244        let mut target = self.clone();
245        target.update_to_cli();
246
247        macro_rules! target_val {
248            ($attr:ident) => {{
249                let name = (stringify!($attr)).replace("_", "-");
250                d.insert(name, target.$attr.to_json());
251            }};
252        }
253
254        macro_rules! target_option_val {
255            ($attr:ident) => {{
256                let name = (stringify!($attr)).replace("_", "-");
257                if default.$attr != target.$attr {
258                    d.insert(name, target.$attr.to_json());
259                }
260            }};
261            ($attr:ident, $json_name:expr) => {{
262                let name = $json_name;
263                if default.$attr != target.$attr {
264                    d.insert(name.into(), target.$attr.to_json());
265                }
266            }};
267            (link_args - $attr:ident, $json_name:expr) => {{
268                let name = $json_name;
269                if default.$attr != target.$attr {
270                    let obj = target
271                        .$attr
272                        .iter()
273                        .map(|(k, v)| (k.desc().to_string(), v.clone()))
274                        .collect::<BTreeMap<_, _>>();
275                    d.insert(name.to_string(), obj.to_json());
276                }
277            }};
278            (env - $attr:ident) => {{
279                let name = (stringify!($attr)).replace("_", "-");
280                if default.$attr != target.$attr {
281                    let obj = target
282                        .$attr
283                        .iter()
284                        .map(|&(ref k, ref v)| format!("{k}={v}"))
285                        .collect::<Vec<_>>();
286                    d.insert(name, obj.to_json());
287                }
288            }};
289        }
290
291        target_val!(llvm_target);
292        target_val!(metadata);
293        d.insert("target-pointer-width".to_string(), self.pointer_width.to_string().to_json());
294        target_val!(arch);
295        target_val!(data_layout);
296
297        target_option_val!(endian, "target-endian");
298        target_option_val!(c_int_width, "target-c-int-width");
299        target_option_val!(os);
300        target_option_val!(env);
301        target_option_val!(abi);
302        target_option_val!(vendor);
303        target_option_val!(linker);
304        target_option_val!(linker_flavor_json, "linker-flavor");
305        target_option_val!(lld_flavor_json, "lld-flavor");
306        target_option_val!(linker_is_gnu_json, "linker-is-gnu");
307        target_option_val!(pre_link_objects);
308        target_option_val!(post_link_objects);
309        target_option_val!(pre_link_objects_self_contained, "pre-link-objects-fallback");
310        target_option_val!(post_link_objects_self_contained, "post-link-objects-fallback");
311        target_option_val!(link_args - pre_link_args_json, "pre-link-args");
312        target_option_val!(link_args - late_link_args_json, "late-link-args");
313        target_option_val!(link_args - late_link_args_dynamic_json, "late-link-args-dynamic");
314        target_option_val!(link_args - late_link_args_static_json, "late-link-args-static");
315        target_option_val!(link_args - post_link_args_json, "post-link-args");
316        target_option_val!(link_script);
317        target_option_val!(env - link_env);
318        target_option_val!(link_env_remove);
319        target_option_val!(asm_args);
320        target_option_val!(cpu);
321        target_option_val!(need_explicit_cpu);
322        target_option_val!(features);
323        target_option_val!(dynamic_linking);
324        target_option_val!(direct_access_external_data);
325        target_option_val!(dll_tls_export);
326        target_option_val!(only_cdylib);
327        target_option_val!(executables);
328        target_option_val!(relocation_model);
329        target_option_val!(code_model);
330        target_option_val!(tls_model);
331        target_option_val!(disable_redzone);
332        target_option_val!(frame_pointer);
333        target_option_val!(function_sections);
334        target_option_val!(dll_prefix);
335        target_option_val!(dll_suffix);
336        target_option_val!(exe_suffix);
337        target_option_val!(staticlib_prefix);
338        target_option_val!(staticlib_suffix);
339        target_option_val!(families, "target-family");
340        target_option_val!(abi_return_struct_as_int);
341        target_option_val!(is_like_aix);
342        target_option_val!(is_like_darwin);
343        target_option_val!(is_like_solaris);
344        target_option_val!(is_like_windows);
345        target_option_val!(is_like_msvc);
346        target_option_val!(is_like_wasm);
347        target_option_val!(is_like_android);
348        target_option_val!(is_like_vexos);
349        target_option_val!(binary_format);
350        target_option_val!(default_dwarf_version);
351        target_option_val!(allows_weak_linkage);
352        target_option_val!(has_rpath);
353        target_option_val!(no_default_libraries);
354        target_option_val!(position_independent_executables);
355        target_option_val!(static_position_independent_executables);
356        target_option_val!(plt_by_default);
357        target_option_val!(relro_level);
358        target_option_val!(archive_format);
359        target_option_val!(allow_asm);
360        target_option_val!(main_needs_argc_argv);
361        target_option_val!(has_thread_local);
362        target_option_val!(obj_is_bitcode);
363        target_option_val!(min_atomic_width);
364        target_option_val!(max_atomic_width);
365        target_option_val!(atomic_cas);
366        target_option_val!(panic_strategy);
367        target_option_val!(crt_static_allows_dylibs);
368        target_option_val!(crt_static_default);
369        target_option_val!(crt_static_respected);
370        target_option_val!(stack_probes);
371        target_option_val!(min_global_align);
372        target_option_val!(default_codegen_units);
373        target_option_val!(default_codegen_backend);
374        target_option_val!(trap_unreachable);
375        target_option_val!(requires_lto);
376        target_option_val!(singlethread);
377        target_option_val!(no_builtins);
378        target_option_val!(default_visibility);
379        target_option_val!(emit_debug_gdb_scripts);
380        target_option_val!(requires_uwtable);
381        target_option_val!(default_uwtable);
382        target_option_val!(simd_types_indirect);
383        target_option_val!(limit_rdylib_exports);
384        target_option_val!(override_export_symbols);
385        target_option_val!(merge_functions);
386        target_option_val!(mcount, "target-mcount");
387        target_option_val!(llvm_mcount_intrinsic);
388        target_option_val!(llvm_abiname);
389        target_option_val!(llvm_floatabi);
390        target_option_val!(rustc_abi);
391        target_option_val!(relax_elf_relocations);
392        target_option_val!(llvm_args);
393        target_option_val!(use_ctors_section);
394        target_option_val!(eh_frame_header);
395        target_option_val!(has_thumb_interworking);
396        target_option_val!(debuginfo_kind);
397        target_option_val!(split_debuginfo);
398        target_option_val!(supported_split_debuginfo);
399        target_option_val!(supported_sanitizers);
400        target_option_val!(c_enum_min_bits);
401        target_option_val!(generate_arange_section);
402        target_option_val!(supports_stack_protector);
403        target_option_val!(small_data_threshold_support);
404        target_option_val!(entry_name);
405        target_option_val!(entry_abi);
406        target_option_val!(supports_xray);
407
408        // Serializing `-Clink-self-contained` needs a dynamic key to support the
409        // backwards-compatible variants.
410        d.insert(self.link_self_contained.json_key().into(), self.link_self_contained.to_json());
411
412        Json::Object(d)
413    }
414}
415
416#[derive(serde_derive::Deserialize)]
417struct LinkSelfContainedComponentsWrapper {
418    components: Vec<LinkSelfContainedComponents>,
419}
420
421#[derive(serde_derive::Deserialize)]
422#[serde(untagged)]
423enum TargetFamiliesJson {
424    Array(StaticCow<[StaticCow<str>]>),
425    String(StaticCow<str>),
426}
427
428/// `Endian` is in `rustc_abi`, which doesn't have access to the macro and serde.
429struct EndianWrapper(rustc_abi::Endian);
430impl FromStr for EndianWrapper {
431    type Err = String;
432    fn from_str(s: &str) -> Result<Self, Self::Err> {
433        rustc_abi::Endian::from_str(s).map(Self)
434    }
435}
436crate::json::serde_deserialize_from_str!(EndianWrapper);
437
438/// `ExternAbi` is in `rustc_abi`, which doesn't have access to the macro and serde.
439struct ExternAbiWrapper(rustc_abi::ExternAbi);
440impl FromStr for ExternAbiWrapper {
441    type Err = String;
442    fn from_str(s: &str) -> Result<Self, Self::Err> {
443        rustc_abi::ExternAbi::from_str(s)
444            .map(Self)
445            .map_err(|_| format!("{s} is not a valid extern ABI"))
446    }
447}
448crate::json::serde_deserialize_from_str!(ExternAbiWrapper);
449
450#[derive(serde_derive::Deserialize)]
451struct TargetSpecJsonMetadata {
452    description: Option<StaticCow<str>>,
453    tier: Option<u64>,
454    host_tools: Option<bool>,
455    std: Option<bool>,
456}
457
458#[derive(serde_derive::Deserialize)]
459#[serde(rename_all = "kebab-case")]
460// Ensure that all unexpected fields get turned into errors.
461// This helps users stay up to date when the schema changes instead of silently
462// ignoring their old values.
463#[serde(deny_unknown_fields)]
464struct TargetSpecJson {
465    llvm_target: StaticCow<str>,
466    target_pointer_width: String,
467    data_layout: StaticCow<str>,
468    arch: StaticCow<str>,
469
470    metadata: Option<TargetSpecJsonMetadata>,
471
472    // options:
473    target_endian: Option<EndianWrapper>,
474    frame_pointer: Option<FramePointer>,
475    #[serde(rename = "target-c-int-width")]
476    c_int_width: Option<u16>,
477    c_enum_min_bits: Option<u64>,
478    os: Option<StaticCow<str>>,
479    env: Option<StaticCow<str>>,
480    abi: Option<StaticCow<str>>,
481    vendor: Option<StaticCow<str>>,
482    linker: Option<StaticCow<str>>,
483    #[serde(rename = "linker-flavor")]
484    linker_flavor_json: Option<LinkerFlavorCli>,
485    #[serde(rename = "lld-flavor")]
486    lld_flavor_json: Option<LldFlavor>,
487    #[serde(rename = "linker-is-gnu")]
488    linker_is_gnu_json: Option<bool>,
489    #[serde(rename = "pre-link-objects")]
490    pre_link_objects: Option<CrtObjects>,
491    #[serde(rename = "post-link-objects")]
492    post_link_objects: Option<CrtObjects>,
493    #[serde(rename = "pre-link-objects-fallback")]
494    pre_link_objects_self_contained: Option<CrtObjects>,
495    #[serde(rename = "post-link-objects-fallback")]
496    post_link_objects_self_contained: Option<CrtObjects>,
497    #[serde(rename = "crt-objects-fallback")]
498    link_self_contained_backwards_compatible: Option<LinkSelfContainedDefault>,
499    link_self_contained: Option<LinkSelfContainedComponentsWrapper>,
500    #[serde(rename = "pre-link-args")]
501    pre_link_args_json: Option<LinkArgsCli>,
502    #[serde(rename = "late-link-args")]
503    late_link_args_json: Option<LinkArgsCli>,
504    #[serde(rename = "late-link-args-dynamic")]
505    late_link_args_dynamic_json: Option<LinkArgsCli>,
506    #[serde(rename = "late-link-args-static")]
507    late_link_args_static_json: Option<LinkArgsCli>,
508    #[serde(rename = "post-link-args")]
509    post_link_args_json: Option<LinkArgsCli>,
510    link_script: Option<StaticCow<str>>,
511    link_env: Option<Vec<StaticCow<str>>>,
512    link_env_remove: Option<StaticCow<[StaticCow<str>]>>,
513    asm_args: Option<StaticCow<[StaticCow<str>]>>,
514    cpu: Option<StaticCow<str>>,
515    need_explicit_cpu: Option<bool>,
516    features: Option<StaticCow<str>>,
517    dynamic_linking: Option<bool>,
518    direct_access_external_data: Option<bool>,
519    dll_tls_export: Option<bool>,
520    only_cdylib: Option<bool>,
521    executables: Option<bool>,
522    relocation_model: Option<RelocModel>,
523    code_model: Option<CodeModel>,
524    tls_model: Option<TlsModel>,
525    disable_redzone: Option<bool>,
526    function_sections: Option<bool>,
527    dll_prefix: Option<StaticCow<str>>,
528    dll_suffix: Option<StaticCow<str>>,
529    exe_suffix: Option<StaticCow<str>>,
530    staticlib_prefix: Option<StaticCow<str>>,
531    staticlib_suffix: Option<StaticCow<str>>,
532    target_family: Option<TargetFamiliesJson>,
533    abi_return_struct_as_int: Option<bool>,
534    is_like_aix: Option<bool>,
535    is_like_darwin: Option<bool>,
536    is_like_solaris: Option<bool>,
537    is_like_windows: Option<bool>,
538    is_like_msvc: Option<bool>,
539    is_like_wasm: Option<bool>,
540    is_like_android: Option<bool>,
541    is_like_vexos: Option<bool>,
542    binary_format: Option<BinaryFormat>,
543    default_dwarf_version: Option<u32>,
544    allows_weak_linkage: Option<bool>,
545    has_rpath: Option<bool>,
546    no_default_libraries: Option<bool>,
547    position_independent_executables: Option<bool>,
548    static_position_independent_executables: Option<bool>,
549    plt_by_default: Option<bool>,
550    relro_level: Option<RelroLevel>,
551    archive_format: Option<StaticCow<str>>,
552    allow_asm: Option<bool>,
553    main_needs_argc_argv: Option<bool>,
554    has_thread_local: Option<bool>,
555    obj_is_bitcode: Option<bool>,
556    max_atomic_width: Option<u64>,
557    min_atomic_width: Option<u64>,
558    atomic_cas: Option<bool>,
559    panic_strategy: Option<PanicStrategy>,
560    crt_static_allows_dylibs: Option<bool>,
561    crt_static_default: Option<bool>,
562    crt_static_respected: Option<bool>,
563    stack_probes: Option<StackProbeType>,
564    min_global_align: Option<u64>,
565    default_codegen_units: Option<u64>,
566    default_codegen_backend: Option<StaticCow<str>>,
567    trap_unreachable: Option<bool>,
568    requires_lto: Option<bool>,
569    singlethread: Option<bool>,
570    no_builtins: Option<bool>,
571    default_visibility: Option<SymbolVisibility>,
572    emit_debug_gdb_scripts: Option<bool>,
573    requires_uwtable: Option<bool>,
574    default_uwtable: Option<bool>,
575    simd_types_indirect: Option<bool>,
576    limit_rdylib_exports: Option<bool>,
577    override_export_symbols: Option<StaticCow<[StaticCow<str>]>>,
578    merge_functions: Option<MergeFunctions>,
579    #[serde(rename = "target-mcount")]
580    mcount: Option<StaticCow<str>>,
581    llvm_mcount_intrinsic: Option<StaticCow<str>>,
582    llvm_abiname: Option<StaticCow<str>>,
583    llvm_floatabi: Option<FloatAbi>,
584    rustc_abi: Option<RustcAbi>,
585    relax_elf_relocations: Option<bool>,
586    llvm_args: Option<StaticCow<[StaticCow<str>]>>,
587    use_ctors_section: Option<bool>,
588    eh_frame_header: Option<bool>,
589    has_thumb_interworking: Option<bool>,
590    debuginfo_kind: Option<DebuginfoKind>,
591    split_debuginfo: Option<SplitDebuginfo>,
592    supported_split_debuginfo: Option<StaticCow<[SplitDebuginfo]>>,
593    supported_sanitizers: Option<Vec<SanitizerSet>>,
594    generate_arange_section: Option<bool>,
595    supports_stack_protector: Option<bool>,
596    small_data_threshold_support: Option<SmallDataThresholdSupport>,
597    entry_name: Option<StaticCow<str>>,
598    supports_xray: Option<bool>,
599    entry_abi: Option<ExternAbiWrapper>,
600}
rustc_target/spec/json.rs

rustc_target/spec/
json.rs
