]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_target/src/spec/mod.rs
Auto merge of #88379 - camelid:cleanup-clean, r=jyn514
[rust.git] / compiler / rustc_target / src / spec / mod.rs
1 //! [Flexible target specification.](https://github.com/rust-lang/rfcs/pull/131)
2 //!
3 //! Rust targets a wide variety of usecases, and in the interest of flexibility,
4 //! allows new target triples to be defined in configuration files. Most users
5 //! will not need to care about these, but this is invaluable when porting Rust
6 //! to a new platform, and allows for an unprecedented level of control over how
7 //! the compiler works.
8 //!
9 //! # Using custom targets
10 //!
11 //! A target triple, as passed via `rustc --target=TRIPLE`, will first be
12 //! compared against the list of built-in targets. This is to ease distributing
13 //! rustc (no need for configuration files) and also to hold these built-in
14 //! targets as immutable and sacred. If `TRIPLE` is not one of the built-in
15 //! targets, rustc will check if a file named `TRIPLE` exists. If it does, it
16 //! will be loaded as the target configuration. If the file does not exist,
17 //! rustc will search each directory in the environment variable
18 //! `RUST_TARGET_PATH` for a file named `TRIPLE.json`. The first one found will
19 //! be loaded. If no file is found in any of those directories, a fatal error
20 //! will be given.
21 //!
22 //! Projects defining their own targets should use
23 //! `--target=path/to/my-awesome-platform.json` instead of adding to
24 //! `RUST_TARGET_PATH`.
25 //!
26 //! # Defining a new target
27 //!
28 //! Targets are defined using [JSON](https://json.org/). The `Target` struct in
29 //! this module defines the format the JSON file should take, though each
30 //! underscore in the field names should be replaced with a hyphen (`-`) in the
31 //! JSON file. Some fields are required in every target specification, such as
32 //! `llvm-target`, `target-endian`, `target-pointer-width`, `data-layout`,
33 //! `arch`, and `os`. In general, options passed to rustc with `-C` override
34 //! the target's settings, though `target-feature` and `link-args` will *add*
35 //! to the list specified by the target, rather than replace.
36
37 use crate::abi::Endian;
38 use crate::spec::abi::{lookup as lookup_abi, Abi};
39 use crate::spec::crt_objects::{CrtObjects, CrtObjectsFallback};
40 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
41 use rustc_serialize::json::{Json, ToJson};
42 use rustc_span::symbol::{sym, Symbol};
43 use std::collections::BTreeMap;
44 use std::convert::TryFrom;
45 use std::ops::{Deref, DerefMut};
46 use std::path::{Path, PathBuf};
47 use std::str::FromStr;
48 use std::{fmt, io};
49
50 use rustc_macros::HashStable_Generic;
51
52 pub mod abi;
53 pub mod crt_objects;
54
55 mod android_base;
56 mod apple_base;
57 mod apple_sdk_base;
58 mod avr_gnu_base;
59 mod bpf_base;
60 mod dragonfly_base;
61 mod freebsd_base;
62 mod fuchsia_base;
63 mod haiku_base;
64 mod hermit_base;
65 mod hermit_kernel_base;
66 mod illumos_base;
67 mod l4re_base;
68 mod linux_base;
69 mod linux_gnu_base;
70 mod linux_kernel_base;
71 mod linux_musl_base;
72 mod linux_uclibc_base;
73 mod msvc_base;
74 mod netbsd_base;
75 mod openbsd_base;
76 mod redox_base;
77 mod solaris_base;
78 mod solid_base;
79 mod thumb_base;
80 mod uefi_msvc_base;
81 mod vxworks_base;
82 mod wasm_base;
83 mod windows_gnu_base;
84 mod windows_msvc_base;
85 mod windows_uwp_gnu_base;
86 mod windows_uwp_msvc_base;
87
88 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
89 pub enum LinkerFlavor {
90     Em,
91     Gcc,
92     Ld,
93     Msvc,
94     Lld(LldFlavor),
95     PtxLinker,
96     BpfLinker,
97 }
98
99 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
100 pub enum LldFlavor {
101     Wasm,
102     Ld64,
103     Ld,
104     Link,
105 }
106
107 impl LldFlavor {
108     fn from_str(s: &str) -> Option<Self> {
109         Some(match s {
110             "darwin" => LldFlavor::Ld64,
111             "gnu" => LldFlavor::Ld,
112             "link" => LldFlavor::Link,
113             "wasm" => LldFlavor::Wasm,
114             _ => return None,
115         })
116     }
117 }
118
119 impl ToJson for LldFlavor {
120     fn to_json(&self) -> Json {
121         match *self {
122             LldFlavor::Ld64 => "darwin",
123             LldFlavor::Ld => "gnu",
124             LldFlavor::Link => "link",
125             LldFlavor::Wasm => "wasm",
126         }
127         .to_json()
128     }
129 }
130
131 impl ToJson for LinkerFlavor {
132     fn to_json(&self) -> Json {
133         self.desc().to_json()
134     }
135 }
136 macro_rules! flavor_mappings {
137     ($((($($flavor:tt)*), $string:expr),)*) => (
138         impl LinkerFlavor {
139             pub const fn one_of() -> &'static str {
140                 concat!("one of: ", $($string, " ",)*)
141             }
142
143             pub fn from_str(s: &str) -> Option<Self> {
144                 Some(match s {
145                     $($string => $($flavor)*,)*
146                     _ => return None,
147                 })
148             }
149
150             pub fn desc(&self) -> &str {
151                 match *self {
152                     $($($flavor)* => $string,)*
153                 }
154             }
155         }
156     )
157 }
158
159 flavor_mappings! {
160     ((LinkerFlavor::Em), "em"),
161     ((LinkerFlavor::Gcc), "gcc"),
162     ((LinkerFlavor::Ld), "ld"),
163     ((LinkerFlavor::Msvc), "msvc"),
164     ((LinkerFlavor::PtxLinker), "ptx-linker"),
165     ((LinkerFlavor::BpfLinker), "bpf-linker"),
166     ((LinkerFlavor::Lld(LldFlavor::Wasm)), "wasm-ld"),
167     ((LinkerFlavor::Lld(LldFlavor::Ld64)), "ld64.lld"),
168     ((LinkerFlavor::Lld(LldFlavor::Ld)), "ld.lld"),
169     ((LinkerFlavor::Lld(LldFlavor::Link)), "lld-link"),
170 }
171
172 #[derive(Clone, Copy, Debug, PartialEq, Hash, Encodable, Decodable, HashStable_Generic)]
173 pub enum PanicStrategy {
174     Unwind,
175     Abort,
176 }
177
178 impl PanicStrategy {
179     pub fn desc(&self) -> &str {
180         match *self {
181             PanicStrategy::Unwind => "unwind",
182             PanicStrategy::Abort => "abort",
183         }
184     }
185
186     pub fn desc_symbol(&self) -> Symbol {
187         match *self {
188             PanicStrategy::Unwind => sym::unwind,
189             PanicStrategy::Abort => sym::abort,
190         }
191     }
192 }
193
194 impl ToJson for PanicStrategy {
195     fn to_json(&self) -> Json {
196         match *self {
197             PanicStrategy::Abort => "abort".to_json(),
198             PanicStrategy::Unwind => "unwind".to_json(),
199         }
200     }
201 }
202
203 #[derive(Clone, Copy, Debug, PartialEq, Hash, Encodable, Decodable)]
204 pub enum RelroLevel {
205     Full,
206     Partial,
207     Off,
208     None,
209 }
210
211 impl RelroLevel {
212     pub fn desc(&self) -> &str {
213         match *self {
214             RelroLevel::Full => "full",
215             RelroLevel::Partial => "partial",
216             RelroLevel::Off => "off",
217             RelroLevel::None => "none",
218         }
219     }
220 }
221
222 impl FromStr for RelroLevel {
223     type Err = ();
224
225     fn from_str(s: &str) -> Result<RelroLevel, ()> {
226         match s {
227             "full" => Ok(RelroLevel::Full),
228             "partial" => Ok(RelroLevel::Partial),
229             "off" => Ok(RelroLevel::Off),
230             "none" => Ok(RelroLevel::None),
231             _ => Err(()),
232         }
233     }
234 }
235
236 impl ToJson for RelroLevel {
237     fn to_json(&self) -> Json {
238         match *self {
239             RelroLevel::Full => "full".to_json(),
240             RelroLevel::Partial => "partial".to_json(),
241             RelroLevel::Off => "off".to_json(),
242             RelroLevel::None => "None".to_json(),
243         }
244     }
245 }
246
247 #[derive(Clone, Copy, Debug, PartialEq, Hash, Encodable, Decodable)]
248 pub enum MergeFunctions {
249     Disabled,
250     Trampolines,
251     Aliases,
252 }
253
254 impl MergeFunctions {
255     pub fn desc(&self) -> &str {
256         match *self {
257             MergeFunctions::Disabled => "disabled",
258             MergeFunctions::Trampolines => "trampolines",
259             MergeFunctions::Aliases => "aliases",
260         }
261     }
262 }
263
264 impl FromStr for MergeFunctions {
265     type Err = ();
266
267     fn from_str(s: &str) -> Result<MergeFunctions, ()> {
268         match s {
269             "disabled" => Ok(MergeFunctions::Disabled),
270             "trampolines" => Ok(MergeFunctions::Trampolines),
271             "aliases" => Ok(MergeFunctions::Aliases),
272             _ => Err(()),
273         }
274     }
275 }
276
277 impl ToJson for MergeFunctions {
278     fn to_json(&self) -> Json {
279         match *self {
280             MergeFunctions::Disabled => "disabled".to_json(),
281             MergeFunctions::Trampolines => "trampolines".to_json(),
282             MergeFunctions::Aliases => "aliases".to_json(),
283         }
284     }
285 }
286
287 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
288 pub enum RelocModel {
289     Static,
290     Pic,
291     Pie,
292     DynamicNoPic,
293     Ropi,
294     Rwpi,
295     RopiRwpi,
296 }
297
298 impl FromStr for RelocModel {
299     type Err = ();
300
301     fn from_str(s: &str) -> Result<RelocModel, ()> {
302         Ok(match s {
303             "static" => RelocModel::Static,
304             "pic" => RelocModel::Pic,
305             "pie" => RelocModel::Pie,
306             "dynamic-no-pic" => RelocModel::DynamicNoPic,
307             "ropi" => RelocModel::Ropi,
308             "rwpi" => RelocModel::Rwpi,
309             "ropi-rwpi" => RelocModel::RopiRwpi,
310             _ => return Err(()),
311         })
312     }
313 }
314
315 impl ToJson for RelocModel {
316     fn to_json(&self) -> Json {
317         match *self {
318             RelocModel::Static => "static",
319             RelocModel::Pic => "pic",
320             RelocModel::Pie => "pie",
321             RelocModel::DynamicNoPic => "dynamic-no-pic",
322             RelocModel::Ropi => "ropi",
323             RelocModel::Rwpi => "rwpi",
324             RelocModel::RopiRwpi => "ropi-rwpi",
325         }
326         .to_json()
327     }
328 }
329
330 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
331 pub enum CodeModel {
332     Tiny,
333     Small,
334     Kernel,
335     Medium,
336     Large,
337 }
338
339 impl FromStr for CodeModel {
340     type Err = ();
341
342     fn from_str(s: &str) -> Result<CodeModel, ()> {
343         Ok(match s {
344             "tiny" => CodeModel::Tiny,
345             "small" => CodeModel::Small,
346             "kernel" => CodeModel::Kernel,
347             "medium" => CodeModel::Medium,
348             "large" => CodeModel::Large,
349             _ => return Err(()),
350         })
351     }
352 }
353
354 impl ToJson for CodeModel {
355     fn to_json(&self) -> Json {
356         match *self {
357             CodeModel::Tiny => "tiny",
358             CodeModel::Small => "small",
359             CodeModel::Kernel => "kernel",
360             CodeModel::Medium => "medium",
361             CodeModel::Large => "large",
362         }
363         .to_json()
364     }
365 }
366
367 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
368 pub enum TlsModel {
369     GeneralDynamic,
370     LocalDynamic,
371     InitialExec,
372     LocalExec,
373 }
374
375 impl FromStr for TlsModel {
376     type Err = ();
377
378     fn from_str(s: &str) -> Result<TlsModel, ()> {
379         Ok(match s {
380             // Note the difference "general" vs "global" difference. The model name is "general",
381             // but the user-facing option name is "global" for consistency with other compilers.
382             "global-dynamic" => TlsModel::GeneralDynamic,
383             "local-dynamic" => TlsModel::LocalDynamic,
384             "initial-exec" => TlsModel::InitialExec,
385             "local-exec" => TlsModel::LocalExec,
386             _ => return Err(()),
387         })
388     }
389 }
390
391 impl ToJson for TlsModel {
392     fn to_json(&self) -> Json {
393         match *self {
394             TlsModel::GeneralDynamic => "global-dynamic",
395             TlsModel::LocalDynamic => "local-dynamic",
396             TlsModel::InitialExec => "initial-exec",
397             TlsModel::LocalExec => "local-exec",
398         }
399         .to_json()
400     }
401 }
402
403 /// Everything is flattened to a single enum to make the json encoding/decoding less annoying.
404 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug)]
405 pub enum LinkOutputKind {
406     /// Dynamically linked non position-independent executable.
407     DynamicNoPicExe,
408     /// Dynamically linked position-independent executable.
409     DynamicPicExe,
410     /// Statically linked non position-independent executable.
411     StaticNoPicExe,
412     /// Statically linked position-independent executable.
413     StaticPicExe,
414     /// Regular dynamic library ("dynamically linked").
415     DynamicDylib,
416     /// Dynamic library with bundled libc ("statically linked").
417     StaticDylib,
418     /// WASI module with a lifetime past the _initialize entry point
419     WasiReactorExe,
420 }
421
422 impl LinkOutputKind {
423     fn as_str(&self) -> &'static str {
424         match self {
425             LinkOutputKind::DynamicNoPicExe => "dynamic-nopic-exe",
426             LinkOutputKind::DynamicPicExe => "dynamic-pic-exe",
427             LinkOutputKind::StaticNoPicExe => "static-nopic-exe",
428             LinkOutputKind::StaticPicExe => "static-pic-exe",
429             LinkOutputKind::DynamicDylib => "dynamic-dylib",
430             LinkOutputKind::StaticDylib => "static-dylib",
431             LinkOutputKind::WasiReactorExe => "wasi-reactor-exe",
432         }
433     }
434
435     pub(super) fn from_str(s: &str) -> Option<LinkOutputKind> {
436         Some(match s {
437             "dynamic-nopic-exe" => LinkOutputKind::DynamicNoPicExe,
438             "dynamic-pic-exe" => LinkOutputKind::DynamicPicExe,
439             "static-nopic-exe" => LinkOutputKind::StaticNoPicExe,
440             "static-pic-exe" => LinkOutputKind::StaticPicExe,
441             "dynamic-dylib" => LinkOutputKind::DynamicDylib,
442             "static-dylib" => LinkOutputKind::StaticDylib,
443             "wasi-reactor-exe" => LinkOutputKind::WasiReactorExe,
444             _ => return None,
445         })
446     }
447 }
448
449 impl fmt::Display for LinkOutputKind {
450     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
451         f.write_str(self.as_str())
452     }
453 }
454
455 pub type LinkArgs = BTreeMap<LinkerFlavor, Vec<String>>;
456
457 #[derive(Clone, Copy, Hash, Debug, PartialEq, Eq)]
458 pub enum SplitDebuginfo {
459     /// Split debug-information is disabled, meaning that on supported platforms
460     /// you can find all debug information in the executable itself. This is
461     /// only supported for ELF effectively.
462     ///
463     /// * Windows - not supported
464     /// * macOS - don't run `dsymutil`
465     /// * ELF - `.dwarf_*` sections
466     Off,
467
468     /// Split debug-information can be found in a "packed" location separate
469     /// from the final artifact. This is supported on all platforms.
470     ///
471     /// * Windows - `*.pdb`
472     /// * macOS - `*.dSYM` (run `dsymutil`)
473     /// * ELF - `*.dwp` (run `rust-llvm-dwp`)
474     Packed,
475
476     /// Split debug-information can be found in individual object files on the
477     /// filesystem. The main executable may point to the object files.
478     ///
479     /// * Windows - not supported
480     /// * macOS - supported, scattered object files
481     /// * ELF - supported, scattered `*.dwo` files
482     Unpacked,
483 }
484
485 impl SplitDebuginfo {
486     fn as_str(&self) -> &'static str {
487         match self {
488             SplitDebuginfo::Off => "off",
489             SplitDebuginfo::Packed => "packed",
490             SplitDebuginfo::Unpacked => "unpacked",
491         }
492     }
493 }
494
495 impl FromStr for SplitDebuginfo {
496     type Err = ();
497
498     fn from_str(s: &str) -> Result<SplitDebuginfo, ()> {
499         Ok(match s {
500             "off" => SplitDebuginfo::Off,
501             "unpacked" => SplitDebuginfo::Unpacked,
502             "packed" => SplitDebuginfo::Packed,
503             _ => return Err(()),
504         })
505     }
506 }
507
508 impl ToJson for SplitDebuginfo {
509     fn to_json(&self) -> Json {
510         self.as_str().to_json()
511     }
512 }
513
514 impl fmt::Display for SplitDebuginfo {
515     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
516         f.write_str(self.as_str())
517     }
518 }
519
520 #[derive(Clone, Debug, PartialEq, Eq)]
521 pub enum StackProbeType {
522     /// Don't emit any stack probes.
523     None,
524     /// It is harmless to use this option even on targets that do not have backend support for
525     /// stack probes as the failure mode is the same as if no stack-probe option was specified in
526     /// the first place.
527     Inline,
528     /// Call `__rust_probestack` whenever stack needs to be probed.
529     Call,
530     /// Use inline option for LLVM versions later than specified in `min_llvm_version_for_inline`
531     /// and call `__rust_probestack` otherwise.
532     InlineOrCall { min_llvm_version_for_inline: (u32, u32, u32) },
533 }
534
535 impl StackProbeType {
536     fn from_json(json: &Json) -> Result<Self, String> {
537         let object = json.as_object().ok_or_else(|| "expected a JSON object")?;
538         let kind = object
539             .get("kind")
540             .and_then(|o| o.as_string())
541             .ok_or_else(|| "expected `kind` to be a string")?;
542         match kind {
543             "none" => Ok(StackProbeType::None),
544             "inline" => Ok(StackProbeType::Inline),
545             "call" => Ok(StackProbeType::Call),
546             "inline-or-call" => {
547                 let min_version = object
548                     .get("min-llvm-version-for-inline")
549                     .and_then(|o| o.as_array())
550                     .ok_or_else(|| "expected `min-llvm-version-for-inline` to be an array")?;
551                 let mut iter = min_version.into_iter().map(|v| {
552                     let int = v.as_u64().ok_or_else(
553                         || "expected `min-llvm-version-for-inline` values to be integers",
554                     )?;
555                     u32::try_from(int)
556                         .map_err(|_| "`min-llvm-version-for-inline` values don't convert to u32")
557                 });
558                 let min_llvm_version_for_inline = (
559                     iter.next().unwrap_or(Ok(11))?,
560                     iter.next().unwrap_or(Ok(0))?,
561                     iter.next().unwrap_or(Ok(0))?,
562                 );
563                 Ok(StackProbeType::InlineOrCall { min_llvm_version_for_inline })
564             }
565             _ => Err(String::from(
566                 "`kind` expected to be one of `none`, `inline`, `call` or `inline-or-call`",
567             )),
568         }
569     }
570 }
571
572 impl ToJson for StackProbeType {
573     fn to_json(&self) -> Json {
574         Json::Object(match self {
575             StackProbeType::None => {
576                 vec![(String::from("kind"), "none".to_json())].into_iter().collect()
577             }
578             StackProbeType::Inline => {
579                 vec![(String::from("kind"), "inline".to_json())].into_iter().collect()
580             }
581             StackProbeType::Call => {
582                 vec![(String::from("kind"), "call".to_json())].into_iter().collect()
583             }
584             StackProbeType::InlineOrCall { min_llvm_version_for_inline } => vec![
585                 (String::from("kind"), "inline-or-call".to_json()),
586                 (
587                     String::from("min-llvm-version-for-inline"),
588                     min_llvm_version_for_inline.to_json(),
589                 ),
590             ]
591             .into_iter()
592             .collect(),
593         })
594     }
595 }
596
597 bitflags::bitflags! {
598     #[derive(Default, Encodable, Decodable)]
599     pub struct SanitizerSet: u8 {
600         const ADDRESS = 1 << 0;
601         const LEAK    = 1 << 1;
602         const MEMORY  = 1 << 2;
603         const THREAD  = 1 << 3;
604         const HWADDRESS = 1 << 4;
605     }
606 }
607
608 impl SanitizerSet {
609     /// Return sanitizer's name
610     ///
611     /// Returns none if the flags is a set of sanitizers numbering not exactly one.
612     fn as_str(self) -> Option<&'static str> {
613         Some(match self {
614             SanitizerSet::ADDRESS => "address",
615             SanitizerSet::LEAK => "leak",
616             SanitizerSet::MEMORY => "memory",
617             SanitizerSet::THREAD => "thread",
618             SanitizerSet::HWADDRESS => "hwaddress",
619             _ => return None,
620         })
621     }
622 }
623
624 /// Formats a sanitizer set as a comma separated list of sanitizers' names.
625 impl fmt::Display for SanitizerSet {
626     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
627         let mut first = true;
628         for s in *self {
629             let name = s.as_str().unwrap_or_else(|| panic!("unrecognized sanitizer {:?}", s));
630             if !first {
631                 f.write_str(", ")?;
632             }
633             f.write_str(name)?;
634             first = false;
635         }
636         Ok(())
637     }
638 }
639
640 impl IntoIterator for SanitizerSet {
641     type Item = SanitizerSet;
642     type IntoIter = std::vec::IntoIter<SanitizerSet>;
643
644     fn into_iter(self) -> Self::IntoIter {
645         [
646             SanitizerSet::ADDRESS,
647             SanitizerSet::LEAK,
648             SanitizerSet::MEMORY,
649             SanitizerSet::THREAD,
650             SanitizerSet::HWADDRESS,
651         ]
652         .iter()
653         .copied()
654         .filter(|&s| self.contains(s))
655         .collect::<Vec<_>>()
656         .into_iter()
657     }
658 }
659
660 impl<CTX> HashStable<CTX> for SanitizerSet {
661     fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
662         self.bits().hash_stable(ctx, hasher);
663     }
664 }
665
666 impl ToJson for SanitizerSet {
667     fn to_json(&self) -> Json {
668         self.into_iter()
669             .map(|v| Some(v.as_str()?.to_json()))
670             .collect::<Option<Vec<_>>>()
671             .unwrap_or_default()
672             .to_json()
673     }
674 }
675
676 #[derive(Clone, Copy, PartialEq, Hash, Debug)]
677 pub enum FramePointer {
678     /// Forces the machine code generator to always preserve the frame pointers.
679     Always,
680     /// Forces the machine code generator to preserve the frame pointers except for the leaf
681     /// functions (i.e. those that don't call other functions).
682     NonLeaf,
683     /// Allows the machine code generator to omit the frame pointers.
684     ///
685     /// This option does not guarantee that the frame pointers will be omitted.
686     MayOmit,
687 }
688
689 impl FromStr for FramePointer {
690     type Err = ();
691     fn from_str(s: &str) -> Result<Self, ()> {
692         Ok(match s {
693             "always" => Self::Always,
694             "non-leaf" => Self::NonLeaf,
695             "may-omit" => Self::MayOmit,
696             _ => return Err(()),
697         })
698     }
699 }
700
701 impl ToJson for FramePointer {
702     fn to_json(&self) -> Json {
703         match *self {
704             Self::Always => "always",
705             Self::NonLeaf => "non-leaf",
706             Self::MayOmit => "may-omit",
707         }
708         .to_json()
709     }
710 }
711
712 macro_rules! supported_targets {
713     ( $(($( $triple:literal, )+ $module:ident ),)+ ) => {
714         $(mod $module;)+
715
716         /// List of supported targets
717         pub const TARGETS: &[&str] = &[$($($triple),+),+];
718
719         fn load_builtin(target: &str) -> Option<Target> {
720             let mut t = match target {
721                 $( $($triple)|+ => $module::target(), )+
722                 _ => return None,
723             };
724             t.is_builtin = true;
725             debug!("got builtin target: {:?}", t);
726             Some(t)
727         }
728
729         #[cfg(test)]
730         mod tests {
731             mod tests_impl;
732
733             // Cannot put this into a separate file without duplication, make an exception.
734             $(
735                 #[test] // `#[test]`
736                 fn $module() {
737                     tests_impl::test_target(super::$module::target());
738                 }
739             )+
740         }
741     };
742 }
743
744 supported_targets! {
745     ("x86_64-unknown-linux-gnu", x86_64_unknown_linux_gnu),
746     ("x86_64-unknown-linux-gnux32", x86_64_unknown_linux_gnux32),
747     ("i686-unknown-linux-gnu", i686_unknown_linux_gnu),
748     ("i586-unknown-linux-gnu", i586_unknown_linux_gnu),
749     ("m68k-unknown-linux-gnu", m68k_unknown_linux_gnu),
750     ("mips-unknown-linux-gnu", mips_unknown_linux_gnu),
751     ("mips64-unknown-linux-gnuabi64", mips64_unknown_linux_gnuabi64),
752     ("mips64el-unknown-linux-gnuabi64", mips64el_unknown_linux_gnuabi64),
753     ("mipsisa32r6-unknown-linux-gnu", mipsisa32r6_unknown_linux_gnu),
754     ("mipsisa32r6el-unknown-linux-gnu", mipsisa32r6el_unknown_linux_gnu),
755     ("mipsisa64r6-unknown-linux-gnuabi64", mipsisa64r6_unknown_linux_gnuabi64),
756     ("mipsisa64r6el-unknown-linux-gnuabi64", mipsisa64r6el_unknown_linux_gnuabi64),
757     ("mipsel-unknown-linux-gnu", mipsel_unknown_linux_gnu),
758     ("powerpc-unknown-linux-gnu", powerpc_unknown_linux_gnu),
759     ("powerpc-unknown-linux-gnuspe", powerpc_unknown_linux_gnuspe),
760     ("powerpc-unknown-linux-musl", powerpc_unknown_linux_musl),
761     ("powerpc64-unknown-linux-gnu", powerpc64_unknown_linux_gnu),
762     ("powerpc64-unknown-linux-musl", powerpc64_unknown_linux_musl),
763     ("powerpc64le-unknown-linux-gnu", powerpc64le_unknown_linux_gnu),
764     ("powerpc64le-unknown-linux-musl", powerpc64le_unknown_linux_musl),
765     ("s390x-unknown-linux-gnu", s390x_unknown_linux_gnu),
766     ("s390x-unknown-linux-musl", s390x_unknown_linux_musl),
767     ("sparc-unknown-linux-gnu", sparc_unknown_linux_gnu),
768     ("sparc64-unknown-linux-gnu", sparc64_unknown_linux_gnu),
769     ("arm-unknown-linux-gnueabi", arm_unknown_linux_gnueabi),
770     ("arm-unknown-linux-gnueabihf", arm_unknown_linux_gnueabihf),
771     ("arm-unknown-linux-musleabi", arm_unknown_linux_musleabi),
772     ("arm-unknown-linux-musleabihf", arm_unknown_linux_musleabihf),
773     ("armv4t-unknown-linux-gnueabi", armv4t_unknown_linux_gnueabi),
774     ("armv5te-unknown-linux-gnueabi", armv5te_unknown_linux_gnueabi),
775     ("armv5te-unknown-linux-musleabi", armv5te_unknown_linux_musleabi),
776     ("armv5te-unknown-linux-uclibceabi", armv5te_unknown_linux_uclibceabi),
777     ("armv7-unknown-linux-gnueabi", armv7_unknown_linux_gnueabi),
778     ("armv7-unknown-linux-gnueabihf", armv7_unknown_linux_gnueabihf),
779     ("thumbv7neon-unknown-linux-gnueabihf", thumbv7neon_unknown_linux_gnueabihf),
780     ("thumbv7neon-unknown-linux-musleabihf", thumbv7neon_unknown_linux_musleabihf),
781     ("armv7-unknown-linux-musleabi", armv7_unknown_linux_musleabi),
782     ("armv7-unknown-linux-musleabihf", armv7_unknown_linux_musleabihf),
783     ("aarch64-unknown-linux-gnu", aarch64_unknown_linux_gnu),
784     ("aarch64-unknown-linux-musl", aarch64_unknown_linux_musl),
785     ("x86_64-unknown-linux-musl", x86_64_unknown_linux_musl),
786     ("i686-unknown-linux-musl", i686_unknown_linux_musl),
787     ("i586-unknown-linux-musl", i586_unknown_linux_musl),
788     ("mips-unknown-linux-musl", mips_unknown_linux_musl),
789     ("mipsel-unknown-linux-musl", mipsel_unknown_linux_musl),
790     ("mips64-unknown-linux-muslabi64", mips64_unknown_linux_muslabi64),
791     ("mips64el-unknown-linux-muslabi64", mips64el_unknown_linux_muslabi64),
792     ("hexagon-unknown-linux-musl", hexagon_unknown_linux_musl),
793
794     ("mips-unknown-linux-uclibc", mips_unknown_linux_uclibc),
795     ("mipsel-unknown-linux-uclibc", mipsel_unknown_linux_uclibc),
796
797     ("i686-linux-android", i686_linux_android),
798     ("x86_64-linux-android", x86_64_linux_android),
799     ("arm-linux-androideabi", arm_linux_androideabi),
800     ("armv7-linux-androideabi", armv7_linux_androideabi),
801     ("thumbv7neon-linux-androideabi", thumbv7neon_linux_androideabi),
802     ("aarch64-linux-android", aarch64_linux_android),
803
804     ("x86_64-unknown-none-linuxkernel", x86_64_unknown_none_linuxkernel),
805
806     ("aarch64-unknown-freebsd", aarch64_unknown_freebsd),
807     ("armv6-unknown-freebsd", armv6_unknown_freebsd),
808     ("armv7-unknown-freebsd", armv7_unknown_freebsd),
809     ("i686-unknown-freebsd", i686_unknown_freebsd),
810     ("powerpc-unknown-freebsd", powerpc_unknown_freebsd),
811     ("powerpc64-unknown-freebsd", powerpc64_unknown_freebsd),
812     ("powerpc64le-unknown-freebsd", powerpc64le_unknown_freebsd),
813     ("x86_64-unknown-freebsd", x86_64_unknown_freebsd),
814
815     ("x86_64-unknown-dragonfly", x86_64_unknown_dragonfly),
816
817     ("aarch64-unknown-openbsd", aarch64_unknown_openbsd),
818     ("i686-unknown-openbsd", i686_unknown_openbsd),
819     ("sparc64-unknown-openbsd", sparc64_unknown_openbsd),
820     ("x86_64-unknown-openbsd", x86_64_unknown_openbsd),
821     ("powerpc-unknown-openbsd", powerpc_unknown_openbsd),
822
823     ("aarch64-unknown-netbsd", aarch64_unknown_netbsd),
824     ("armv6-unknown-netbsd-eabihf", armv6_unknown_netbsd_eabihf),
825     ("armv7-unknown-netbsd-eabihf", armv7_unknown_netbsd_eabihf),
826     ("i686-unknown-netbsd", i686_unknown_netbsd),
827     ("powerpc-unknown-netbsd", powerpc_unknown_netbsd),
828     ("sparc64-unknown-netbsd", sparc64_unknown_netbsd),
829     ("x86_64-unknown-netbsd", x86_64_unknown_netbsd),
830
831     ("i686-unknown-haiku", i686_unknown_haiku),
832     ("x86_64-unknown-haiku", x86_64_unknown_haiku),
833
834     ("aarch64-apple-darwin", aarch64_apple_darwin),
835     ("x86_64-apple-darwin", x86_64_apple_darwin),
836     ("i686-apple-darwin", i686_apple_darwin),
837
838     ("aarch64-fuchsia", aarch64_fuchsia),
839     ("x86_64-fuchsia", x86_64_fuchsia),
840
841     ("avr-unknown-gnu-atmega328", avr_unknown_gnu_atmega328),
842
843     ("x86_64-unknown-l4re-uclibc", x86_64_unknown_l4re_uclibc),
844
845     ("aarch64-unknown-redox", aarch64_unknown_redox),
846     ("x86_64-unknown-redox", x86_64_unknown_redox),
847
848     ("i386-apple-ios", i386_apple_ios),
849     ("x86_64-apple-ios", x86_64_apple_ios),
850     ("aarch64-apple-ios", aarch64_apple_ios),
851     ("armv7-apple-ios", armv7_apple_ios),
852     ("armv7s-apple-ios", armv7s_apple_ios),
853     ("x86_64-apple-ios-macabi", x86_64_apple_ios_macabi),
854     ("aarch64-apple-ios-macabi", aarch64_apple_ios_macabi),
855     ("aarch64-apple-ios-sim", aarch64_apple_ios_sim),
856     ("aarch64-apple-tvos", aarch64_apple_tvos),
857     ("x86_64-apple-tvos", x86_64_apple_tvos),
858
859     ("armebv7r-none-eabi", armebv7r_none_eabi),
860     ("armebv7r-none-eabihf", armebv7r_none_eabihf),
861     ("armv7r-none-eabi", armv7r_none_eabi),
862     ("armv7r-none-eabihf", armv7r_none_eabihf),
863
864     ("x86_64-pc-solaris", x86_64_pc_solaris),
865     ("x86_64-sun-solaris", x86_64_sun_solaris),
866     ("sparcv9-sun-solaris", sparcv9_sun_solaris),
867
868     ("x86_64-unknown-illumos", x86_64_unknown_illumos),
869
870     ("x86_64-pc-windows-gnu", x86_64_pc_windows_gnu),
871     ("i686-pc-windows-gnu", i686_pc_windows_gnu),
872     ("i686-uwp-windows-gnu", i686_uwp_windows_gnu),
873     ("x86_64-uwp-windows-gnu", x86_64_uwp_windows_gnu),
874
875     ("aarch64-pc-windows-msvc", aarch64_pc_windows_msvc),
876     ("aarch64-uwp-windows-msvc", aarch64_uwp_windows_msvc),
877     ("x86_64-pc-windows-msvc", x86_64_pc_windows_msvc),
878     ("x86_64-uwp-windows-msvc", x86_64_uwp_windows_msvc),
879     ("i686-pc-windows-msvc", i686_pc_windows_msvc),
880     ("i686-uwp-windows-msvc", i686_uwp_windows_msvc),
881     ("i586-pc-windows-msvc", i586_pc_windows_msvc),
882     ("thumbv7a-pc-windows-msvc", thumbv7a_pc_windows_msvc),
883     ("thumbv7a-uwp-windows-msvc", thumbv7a_uwp_windows_msvc),
884
885     ("asmjs-unknown-emscripten", asmjs_unknown_emscripten),
886     ("wasm32-unknown-emscripten", wasm32_unknown_emscripten),
887     ("wasm32-unknown-unknown", wasm32_unknown_unknown),
888     ("wasm32-wasi", wasm32_wasi),
889     ("wasm64-unknown-unknown", wasm64_unknown_unknown),
890
891     ("thumbv6m-none-eabi", thumbv6m_none_eabi),
892     ("thumbv7m-none-eabi", thumbv7m_none_eabi),
893     ("thumbv7em-none-eabi", thumbv7em_none_eabi),
894     ("thumbv7em-none-eabihf", thumbv7em_none_eabihf),
895     ("thumbv8m.base-none-eabi", thumbv8m_base_none_eabi),
896     ("thumbv8m.main-none-eabi", thumbv8m_main_none_eabi),
897     ("thumbv8m.main-none-eabihf", thumbv8m_main_none_eabihf),
898
899     ("armv7a-none-eabi", armv7a_none_eabi),
900     ("armv7a-none-eabihf", armv7a_none_eabihf),
901
902     ("msp430-none-elf", msp430_none_elf),
903
904     ("aarch64-unknown-hermit", aarch64_unknown_hermit),
905     ("x86_64-unknown-hermit", x86_64_unknown_hermit),
906
907     ("x86_64-unknown-none-hermitkernel", x86_64_unknown_none_hermitkernel),
908
909     ("riscv32i-unknown-none-elf", riscv32i_unknown_none_elf),
910     ("riscv32imc-unknown-none-elf", riscv32imc_unknown_none_elf),
911     ("riscv32imc-esp-espidf", riscv32imc_esp_espidf),
912     ("riscv32imac-unknown-none-elf", riscv32imac_unknown_none_elf),
913     ("riscv32gc-unknown-linux-gnu", riscv32gc_unknown_linux_gnu),
914     ("riscv32gc-unknown-linux-musl", riscv32gc_unknown_linux_musl),
915     ("riscv64imac-unknown-none-elf", riscv64imac_unknown_none_elf),
916     ("riscv64gc-unknown-none-elf", riscv64gc_unknown_none_elf),
917     ("riscv64gc-unknown-linux-gnu", riscv64gc_unknown_linux_gnu),
918     ("riscv64gc-unknown-linux-musl", riscv64gc_unknown_linux_musl),
919
920     ("aarch64-unknown-none", aarch64_unknown_none),
921     ("aarch64-unknown-none-softfloat", aarch64_unknown_none_softfloat),
922
923     ("x86_64-fortanix-unknown-sgx", x86_64_fortanix_unknown_sgx),
924
925     ("x86_64-unknown-uefi", x86_64_unknown_uefi),
926     ("i686-unknown-uefi", i686_unknown_uefi),
927     ("aarch64-unknown-uefi", aarch64_unknown_uefi),
928
929     ("nvptx64-nvidia-cuda", nvptx64_nvidia_cuda),
930
931     ("i686-wrs-vxworks", i686_wrs_vxworks),
932     ("x86_64-wrs-vxworks", x86_64_wrs_vxworks),
933     ("armv7-wrs-vxworks-eabihf", armv7_wrs_vxworks_eabihf),
934     ("aarch64-wrs-vxworks", aarch64_wrs_vxworks),
935     ("powerpc-wrs-vxworks", powerpc_wrs_vxworks),
936     ("powerpc-wrs-vxworks-spe", powerpc_wrs_vxworks_spe),
937     ("powerpc64-wrs-vxworks", powerpc64_wrs_vxworks),
938
939     ("aarch64-kmc-solid_asp3", aarch64_kmc_solid_asp3),
940     ("armv7a-kmc-solid_asp3-eabi", armv7a_kmc_solid_asp3_eabi),
941     ("armv7a-kmc-solid_asp3-eabihf", armv7a_kmc_solid_asp3_eabihf),
942
943     ("mipsel-sony-psp", mipsel_sony_psp),
944     ("mipsel-unknown-none", mipsel_unknown_none),
945     ("thumbv4t-none-eabi", thumbv4t_none_eabi),
946
947     ("aarch64_be-unknown-linux-gnu", aarch64_be_unknown_linux_gnu),
948     ("aarch64-unknown-linux-gnu_ilp32", aarch64_unknown_linux_gnu_ilp32),
949     ("aarch64_be-unknown-linux-gnu_ilp32", aarch64_be_unknown_linux_gnu_ilp32),
950
951     ("bpfeb-unknown-none", bpfeb_unknown_none),
952     ("bpfel-unknown-none", bpfel_unknown_none),
953
954     ("armv6k-nintendo-3ds", armv6k_nintendo_3ds),
955 }
956
957 /// Warnings encountered when parsing the target `json`.
958 ///
959 /// Includes fields that weren't recognized and fields that don't have the expected type.
960 #[derive(Debug, PartialEq)]
961 pub struct TargetWarnings {
962     unused_fields: Vec<String>,
963     incorrect_type: Vec<String>,
964 }
965
966 impl TargetWarnings {
967     pub fn empty() -> Self {
968         Self { unused_fields: Vec::new(), incorrect_type: Vec::new() }
969     }
970
971     pub fn warning_messages(&self) -> Vec<String> {
972         let mut warnings = vec![];
973         if !self.unused_fields.is_empty() {
974             warnings.push(format!(
975                 "target json file contains unused fields: {}",
976                 self.unused_fields.join(", ")
977             ));
978         }
979         if !self.incorrect_type.is_empty() {
980             warnings.push(format!(
981                 "target json file contains fields whose value doesn't have the correct json type: {}",
982                 self.incorrect_type.join(", ")
983             ));
984         }
985         warnings
986     }
987 }
988
989 /// Everything `rustc` knows about how to compile for a specific target.
990 ///
991 /// Every field here must be specified, and has no default value.
992 #[derive(PartialEq, Clone, Debug)]
993 pub struct Target {
994     /// Target triple to pass to LLVM.
995     pub llvm_target: String,
996     /// Number of bits in a pointer. Influences the `target_pointer_width` `cfg` variable.
997     pub pointer_width: u32,
998     /// Architecture to use for ABI considerations. Valid options include: "x86",
999     /// "x86_64", "arm", "aarch64", "mips", "powerpc", "powerpc64", and others.
1000     pub arch: String,
1001     /// [Data layout](https://llvm.org/docs/LangRef.html#data-layout) to pass to LLVM.
1002     pub data_layout: String,
1003     /// Optional settings with defaults.
1004     pub options: TargetOptions,
1005 }
1006
1007 pub trait HasTargetSpec {
1008     fn target_spec(&self) -> &Target;
1009 }
1010
1011 impl HasTargetSpec for Target {
1012     #[inline]
1013     fn target_spec(&self) -> &Target {
1014         self
1015     }
1016 }
1017
1018 /// Optional aspects of a target specification.
1019 ///
1020 /// This has an implementation of `Default`, see each field for what the default is. In general,
1021 /// these try to take "minimal defaults" that don't assume anything about the runtime they run in.
1022 ///
1023 /// `TargetOptions` as a separate structure is mostly an implementation detail of `Target`
1024 /// construction, all its fields logically belong to `Target` and available from `Target`
1025 /// through `Deref` impls.
1026 #[derive(PartialEq, Clone, Debug)]
1027 pub struct TargetOptions {
1028     /// Whether the target is built-in or loaded from a custom target specification.
1029     pub is_builtin: bool,
1030
1031     /// Used as the `target_endian` `cfg` variable. Defaults to little endian.
1032     pub endian: Endian,
1033     /// Width of c_int type. Defaults to "32".
1034     pub c_int_width: String,
1035     /// OS name to use for conditional compilation (`target_os`). Defaults to "none".
1036     /// "none" implies a bare metal target without `std` library.
1037     /// A couple of targets having `std` also use "unknown" as an `os` value,
1038     /// but they are exceptions.
1039     pub os: String,
1040     /// Environment name to use for conditional compilation (`target_env`). Defaults to "".
1041     pub env: String,
1042     /// ABI name to distinguish multiple ABIs on the same OS and architecture. For instance, `"eabi"`
1043     /// or `"eabihf"`. Defaults to "".
1044     pub abi: String,
1045     /// Vendor name to use for conditional compilation (`target_vendor`). Defaults to "unknown".
1046     pub vendor: String,
1047     /// Default linker flavor used if `-C linker-flavor` or `-C linker` are not passed
1048     /// on the command line. Defaults to `LinkerFlavor::Gcc`.
1049     pub linker_flavor: LinkerFlavor,
1050
1051     /// Linker to invoke
1052     pub linker: Option<String>,
1053
1054     /// LLD flavor used if `lld` (or `rust-lld`) is specified as a linker
1055     /// without clarifying its flavor in any way.
1056     pub lld_flavor: LldFlavor,
1057
1058     /// Linker arguments that are passed *before* any user-defined libraries.
1059     pub pre_link_args: LinkArgs,
1060     /// Objects to link before and after all other object code.
1061     pub pre_link_objects: CrtObjects,
1062     pub post_link_objects: CrtObjects,
1063     /// Same as `(pre|post)_link_objects`, but when we fail to pull the objects with help of the
1064     /// target's native gcc and fall back to the "self-contained" mode and pull them manually.
1065     /// See `crt_objects.rs` for some more detailed documentation.
1066     pub pre_link_objects_fallback: CrtObjects,
1067     pub post_link_objects_fallback: CrtObjects,
1068     /// Which logic to use to determine whether to fall back to the "self-contained" mode or not.
1069     pub crt_objects_fallback: Option<CrtObjectsFallback>,
1070
1071     /// Linker arguments that are unconditionally passed after any
1072     /// user-defined but before post-link objects. Standard platform
1073     /// libraries that should be always be linked to, usually go here.
1074     pub late_link_args: LinkArgs,
1075     /// Linker arguments used in addition to `late_link_args` if at least one
1076     /// Rust dependency is dynamically linked.
1077     pub late_link_args_dynamic: LinkArgs,
1078     /// Linker arguments used in addition to `late_link_args` if aall Rust
1079     /// dependencies are statically linked.
1080     pub late_link_args_static: LinkArgs,
1081     /// Linker arguments that are unconditionally passed *after* any
1082     /// user-defined libraries.
1083     pub post_link_args: LinkArgs,
1084     /// Optional link script applied to `dylib` and `executable` crate types.
1085     /// This is a string containing the script, not a path. Can only be applied
1086     /// to linkers where `linker_is_gnu` is true.
1087     pub link_script: Option<String>,
1088
1089     /// Environment variables to be set for the linker invocation.
1090     pub link_env: Vec<(String, String)>,
1091     /// Environment variables to be removed for the linker invocation.
1092     pub link_env_remove: Vec<String>,
1093
1094     /// Extra arguments to pass to the external assembler (when used)
1095     pub asm_args: Vec<String>,
1096
1097     /// Default CPU to pass to LLVM. Corresponds to `llc -mcpu=$cpu`. Defaults
1098     /// to "generic".
1099     pub cpu: String,
1100     /// Default target features to pass to LLVM. These features will *always* be
1101     /// passed, and cannot be disabled even via `-C`. Corresponds to `llc
1102     /// -mattr=$features`.
1103     pub features: String,
1104     /// Whether dynamic linking is available on this target. Defaults to false.
1105     pub dynamic_linking: bool,
1106     /// If dynamic linking is available, whether only cdylibs are supported.
1107     pub only_cdylib: bool,
1108     /// Whether executables are available on this target. iOS, for example, only allows static
1109     /// libraries. Defaults to false.
1110     pub executables: bool,
1111     /// Relocation model to use in object file. Corresponds to `llc
1112     /// -relocation-model=$relocation_model`. Defaults to `Pic`.
1113     pub relocation_model: RelocModel,
1114     /// Code model to use. Corresponds to `llc -code-model=$code_model`.
1115     /// Defaults to `None` which means "inherited from the base LLVM target".
1116     pub code_model: Option<CodeModel>,
1117     /// TLS model to use. Options are "global-dynamic" (default), "local-dynamic", "initial-exec"
1118     /// and "local-exec". This is similar to the -ftls-model option in GCC/Clang.
1119     pub tls_model: TlsModel,
1120     /// Do not emit code that uses the "red zone", if the ABI has one. Defaults to false.
1121     pub disable_redzone: bool,
1122     /// Frame pointer mode for this target. Defaults to `MayOmit`.
1123     pub frame_pointer: FramePointer,
1124     /// Emit each function in its own section. Defaults to true.
1125     pub function_sections: bool,
1126     /// String to prepend to the name of every dynamic library. Defaults to "lib".
1127     pub dll_prefix: String,
1128     /// String to append to the name of every dynamic library. Defaults to ".so".
1129     pub dll_suffix: String,
1130     /// String to append to the name of every executable.
1131     pub exe_suffix: String,
1132     /// String to prepend to the name of every static library. Defaults to "lib".
1133     pub staticlib_prefix: String,
1134     /// String to append to the name of every static library. Defaults to ".a".
1135     pub staticlib_suffix: String,
1136     /// Values of the `target_family` cfg set for this target.
1137     ///
1138     /// Common options are: "unix", "windows". Defaults to no families.
1139     ///
1140     /// See <https://doc.rust-lang.org/reference/conditional-compilation.html#target_family>.
1141     pub families: Vec<String>,
1142     /// Whether the target toolchain's ABI supports returning small structs as an integer.
1143     pub abi_return_struct_as_int: bool,
1144     /// Whether the target toolchain is like macOS's. Only useful for compiling against iOS/macOS,
1145     /// in particular running dsymutil and some other stuff like `-dead_strip`. Defaults to false.
1146     pub is_like_osx: bool,
1147     /// Whether the target toolchain is like Solaris's.
1148     /// Only useful for compiling against Illumos/Solaris,
1149     /// as they have a different set of linker flags. Defaults to false.
1150     pub is_like_solaris: bool,
1151     /// Whether the target is like Windows.
1152     /// This is a combination of several more specific properties represented as a single flag:
1153     ///   - The target uses a Windows ABI,
1154     ///   - uses PE/COFF as a format for object code,
1155     ///   - uses Windows-style dllexport/dllimport for shared libraries,
1156     ///   - uses import libraries and .def files for symbol exports,
1157     ///   - executables support setting a subsystem.
1158     pub is_like_windows: bool,
1159     /// Whether the target is like MSVC.
1160     /// This is a combination of several more specific properties represented as a single flag:
1161     ///   - The target has all the properties from `is_like_windows`
1162     ///     (for in-tree targets "is_like_msvc â‡’ is_like_windows" is ensured by a unit test),
1163     ///   - has some MSVC-specific Windows ABI properties,
1164     ///   - uses a link.exe-like linker,
1165     ///   - uses CodeView/PDB for debuginfo and natvis for its visualization,
1166     ///   - uses SEH-based unwinding,
1167     ///   - supports control flow guard mechanism.
1168     pub is_like_msvc: bool,
1169     /// Whether the target toolchain is like Emscripten's. Only useful for compiling with
1170     /// Emscripten toolchain.
1171     /// Defaults to false.
1172     pub is_like_emscripten: bool,
1173     /// Whether the target toolchain is like Fuchsia's.
1174     pub is_like_fuchsia: bool,
1175     /// Whether a target toolchain is like WASM.
1176     pub is_like_wasm: bool,
1177     /// Version of DWARF to use if not using the default.
1178     /// Useful because some platforms (osx, bsd) only want up to DWARF2.
1179     pub dwarf_version: Option<u32>,
1180     /// Whether the linker support GNU-like arguments such as -O. Defaults to true.
1181     pub linker_is_gnu: bool,
1182     /// The MinGW toolchain has a known issue that prevents it from correctly
1183     /// handling COFF object files with more than 2<sup>15</sup> sections. Since each weak
1184     /// symbol needs its own COMDAT section, weak linkage implies a large
1185     /// number sections that easily exceeds the given limit for larger
1186     /// codebases. Consequently we want a way to disallow weak linkage on some
1187     /// platforms.
1188     pub allows_weak_linkage: bool,
1189     /// Whether the linker support rpaths or not. Defaults to false.
1190     pub has_rpath: bool,
1191     /// Whether to disable linking to the default libraries, typically corresponds
1192     /// to `-nodefaultlibs`. Defaults to true.
1193     pub no_default_libraries: bool,
1194     /// Dynamically linked executables can be compiled as position independent
1195     /// if the default relocation model of position independent code is not
1196     /// changed. This is a requirement to take advantage of ASLR, as otherwise
1197     /// the functions in the executable are not randomized and can be used
1198     /// during an exploit of a vulnerability in any code.
1199     pub position_independent_executables: bool,
1200     /// Executables that are both statically linked and position-independent are supported.
1201     pub static_position_independent_executables: bool,
1202     /// Determines if the target always requires using the PLT for indirect
1203     /// library calls or not. This controls the default value of the `-Z plt` flag.
1204     pub needs_plt: bool,
1205     /// Either partial, full, or off. Full RELRO makes the dynamic linker
1206     /// resolve all symbols at startup and marks the GOT read-only before
1207     /// starting the program, preventing overwriting the GOT.
1208     pub relro_level: RelroLevel,
1209     /// Format that archives should be emitted in. This affects whether we use
1210     /// LLVM to assemble an archive or fall back to the system linker, and
1211     /// currently only "gnu" is used to fall into LLVM. Unknown strings cause
1212     /// the system linker to be used.
1213     pub archive_format: String,
1214     /// Is asm!() allowed? Defaults to true.
1215     pub allow_asm: bool,
1216     /// Whether the runtime startup code requires the `main` function be passed
1217     /// `argc` and `argv` values.
1218     pub main_needs_argc_argv: bool,
1219
1220     /// Flag indicating whether ELF TLS (e.g., #[thread_local]) is available for
1221     /// this target.
1222     pub has_elf_tls: bool,
1223     // This is mainly for easy compatibility with emscripten.
1224     // If we give emcc .o files that are actually .bc files it
1225     // will 'just work'.
1226     pub obj_is_bitcode: bool,
1227     /// Whether the target requires that emitted object code includes bitcode.
1228     pub forces_embed_bitcode: bool,
1229     /// Content of the LLVM cmdline section associated with embedded bitcode.
1230     pub bitcode_llvm_cmdline: String,
1231
1232     /// Don't use this field; instead use the `.min_atomic_width()` method.
1233     pub min_atomic_width: Option<u64>,
1234
1235     /// Don't use this field; instead use the `.max_atomic_width()` method.
1236     pub max_atomic_width: Option<u64>,
1237
1238     /// Whether the target supports atomic CAS operations natively
1239     pub atomic_cas: bool,
1240
1241     /// Panic strategy: "unwind" or "abort"
1242     pub panic_strategy: PanicStrategy,
1243
1244     /// Whether or not linking dylibs to a static CRT is allowed.
1245     pub crt_static_allows_dylibs: bool,
1246     /// Whether or not the CRT is statically linked by default.
1247     pub crt_static_default: bool,
1248     /// Whether or not crt-static is respected by the compiler (or is a no-op).
1249     pub crt_static_respected: bool,
1250
1251     /// The implementation of stack probes to use.
1252     pub stack_probes: StackProbeType,
1253
1254     /// The minimum alignment for global symbols.
1255     pub min_global_align: Option<u64>,
1256
1257     /// Default number of codegen units to use in debug mode
1258     pub default_codegen_units: Option<u64>,
1259
1260     /// Whether to generate trap instructions in places where optimization would
1261     /// otherwise produce control flow that falls through into unrelated memory.
1262     pub trap_unreachable: bool,
1263
1264     /// This target requires everything to be compiled with LTO to emit a final
1265     /// executable, aka there is no native linker for this target.
1266     pub requires_lto: bool,
1267
1268     /// This target has no support for threads.
1269     pub singlethread: bool,
1270
1271     /// Whether library functions call lowering/optimization is disabled in LLVM
1272     /// for this target unconditionally.
1273     pub no_builtins: bool,
1274
1275     /// The default visibility for symbols in this target should be "hidden"
1276     /// rather than "default"
1277     pub default_hidden_visibility: bool,
1278
1279     /// Whether a .debug_gdb_scripts section will be added to the output object file
1280     pub emit_debug_gdb_scripts: bool,
1281
1282     /// Whether or not to unconditionally `uwtable` attributes on functions,
1283     /// typically because the platform needs to unwind for things like stack
1284     /// unwinders.
1285     pub requires_uwtable: bool,
1286
1287     /// Whether or not to emit `uwtable` attributes on functions if `-C force-unwind-tables`
1288     /// is not specified and `uwtable` is not required on this target.
1289     pub default_uwtable: bool,
1290
1291     /// Whether or not SIMD types are passed by reference in the Rust ABI,
1292     /// typically required if a target can be compiled with a mixed set of
1293     /// target features. This is `true` by default, and `false` for targets like
1294     /// wasm32 where the whole program either has simd or not.
1295     pub simd_types_indirect: bool,
1296
1297     /// Pass a list of symbol which should be exported in the dylib to the linker.
1298     pub limit_rdylib_exports: bool,
1299
1300     /// If set, have the linker export exactly these symbols, instead of using
1301     /// the usual logic to figure this out from the crate itself.
1302     pub override_export_symbols: Option<Vec<String>>,
1303
1304     /// Determines how or whether the MergeFunctions LLVM pass should run for
1305     /// this target. Either "disabled", "trampolines", or "aliases".
1306     /// The MergeFunctions pass is generally useful, but some targets may need
1307     /// to opt out. The default is "aliases".
1308     ///
1309     /// Workaround for: <https://github.com/rust-lang/rust/issues/57356>
1310     pub merge_functions: MergeFunctions,
1311
1312     /// Use platform dependent mcount function
1313     pub mcount: String,
1314
1315     /// LLVM ABI name, corresponds to the '-mabi' parameter available in multilib C compilers
1316     pub llvm_abiname: String,
1317
1318     /// Whether or not RelaxElfRelocation flag will be passed to the linker
1319     pub relax_elf_relocations: bool,
1320
1321     /// Additional arguments to pass to LLVM, similar to the `-C llvm-args` codegen option.
1322     pub llvm_args: Vec<String>,
1323
1324     /// Whether to use legacy .ctors initialization hooks rather than .init_array. Defaults
1325     /// to false (uses .init_array).
1326     pub use_ctors_section: bool,
1327
1328     /// Whether the linker is instructed to add a `GNU_EH_FRAME` ELF header
1329     /// used to locate unwinding information is passed
1330     /// (only has effect if the linker is `ld`-like).
1331     pub eh_frame_header: bool,
1332
1333     /// Is true if the target is an ARM architecture using thumb v1 which allows for
1334     /// thumb and arm interworking.
1335     pub has_thumb_interworking: bool,
1336
1337     /// How to handle split debug information, if at all. Specifying `None` has
1338     /// target-specific meaning.
1339     pub split_debuginfo: SplitDebuginfo,
1340
1341     /// The sanitizers supported by this target
1342     ///
1343     /// Note that the support here is at a codegen level. If the machine code with sanitizer
1344     /// enabled can generated on this target, but the necessary supporting libraries are not
1345     /// distributed with the target, the sanitizer should still appear in this list for the target.
1346     pub supported_sanitizers: SanitizerSet,
1347
1348     /// If present it's a default value to use for adjusting the C ABI.
1349     pub default_adjusted_cabi: Option<Abi>,
1350
1351     /// Minimum number of bits in #[repr(C)] enum. Defaults to 32.
1352     pub c_enum_min_bits: u64,
1353 }
1354
1355 impl Default for TargetOptions {
1356     /// Creates a set of "sane defaults" for any target. This is still
1357     /// incomplete, and if used for compilation, will certainly not work.
1358     fn default() -> TargetOptions {
1359         TargetOptions {
1360             is_builtin: false,
1361             endian: Endian::Little,
1362             c_int_width: "32".to_string(),
1363             os: "none".to_string(),
1364             env: String::new(),
1365             abi: String::new(),
1366             vendor: "unknown".to_string(),
1367             linker_flavor: LinkerFlavor::Gcc,
1368             linker: option_env!("CFG_DEFAULT_LINKER").map(|s| s.to_string()),
1369             lld_flavor: LldFlavor::Ld,
1370             pre_link_args: LinkArgs::new(),
1371             post_link_args: LinkArgs::new(),
1372             link_script: None,
1373             asm_args: Vec::new(),
1374             cpu: "generic".to_string(),
1375             features: String::new(),
1376             dynamic_linking: false,
1377             only_cdylib: false,
1378             executables: false,
1379             relocation_model: RelocModel::Pic,
1380             code_model: None,
1381             tls_model: TlsModel::GeneralDynamic,
1382             disable_redzone: false,
1383             frame_pointer: FramePointer::MayOmit,
1384             function_sections: true,
1385             dll_prefix: "lib".to_string(),
1386             dll_suffix: ".so".to_string(),
1387             exe_suffix: String::new(),
1388             staticlib_prefix: "lib".to_string(),
1389             staticlib_suffix: ".a".to_string(),
1390             families: Vec::new(),
1391             abi_return_struct_as_int: false,
1392             is_like_osx: false,
1393             is_like_solaris: false,
1394             is_like_windows: false,
1395             is_like_emscripten: false,
1396             is_like_msvc: false,
1397             is_like_fuchsia: false,
1398             is_like_wasm: false,
1399             dwarf_version: None,
1400             linker_is_gnu: true,
1401             allows_weak_linkage: true,
1402             has_rpath: false,
1403             no_default_libraries: true,
1404             position_independent_executables: false,
1405             static_position_independent_executables: false,
1406             needs_plt: false,
1407             relro_level: RelroLevel::None,
1408             pre_link_objects: Default::default(),
1409             post_link_objects: Default::default(),
1410             pre_link_objects_fallback: Default::default(),
1411             post_link_objects_fallback: Default::default(),
1412             crt_objects_fallback: None,
1413             late_link_args: LinkArgs::new(),
1414             late_link_args_dynamic: LinkArgs::new(),
1415             late_link_args_static: LinkArgs::new(),
1416             link_env: Vec::new(),
1417             link_env_remove: Vec::new(),
1418             archive_format: "gnu".to_string(),
1419             main_needs_argc_argv: true,
1420             allow_asm: true,
1421             has_elf_tls: false,
1422             obj_is_bitcode: false,
1423             forces_embed_bitcode: false,
1424             bitcode_llvm_cmdline: String::new(),
1425             min_atomic_width: None,
1426             max_atomic_width: None,
1427             atomic_cas: true,
1428             panic_strategy: PanicStrategy::Unwind,
1429             crt_static_allows_dylibs: false,
1430             crt_static_default: false,
1431             crt_static_respected: false,
1432             stack_probes: StackProbeType::None,
1433             min_global_align: None,
1434             default_codegen_units: None,
1435             trap_unreachable: true,
1436             requires_lto: false,
1437             singlethread: false,
1438             no_builtins: false,
1439             default_hidden_visibility: false,
1440             emit_debug_gdb_scripts: true,
1441             requires_uwtable: false,
1442             default_uwtable: false,
1443             simd_types_indirect: true,
1444             limit_rdylib_exports: true,
1445             override_export_symbols: None,
1446             merge_functions: MergeFunctions::Aliases,
1447             mcount: "mcount".to_string(),
1448             llvm_abiname: "".to_string(),
1449             relax_elf_relocations: false,
1450             llvm_args: vec![],
1451             use_ctors_section: false,
1452             eh_frame_header: true,
1453             has_thumb_interworking: false,
1454             split_debuginfo: SplitDebuginfo::Off,
1455             supported_sanitizers: SanitizerSet::empty(),
1456             default_adjusted_cabi: None,
1457             c_enum_min_bits: 32,
1458         }
1459     }
1460 }
1461
1462 /// `TargetOptions` being a separate type is basically an implementation detail of `Target` that is
1463 /// used for providing defaults. Perhaps there's a way to merge `TargetOptions` into `Target` so
1464 /// this `Deref` implementation is no longer necessary.
1465 impl Deref for Target {
1466     type Target = TargetOptions;
1467
1468     fn deref(&self) -> &Self::Target {
1469         &self.options
1470     }
1471 }
1472 impl DerefMut for Target {
1473     fn deref_mut(&mut self) -> &mut Self::Target {
1474         &mut self.options
1475     }
1476 }
1477
1478 impl Target {
1479     /// Given a function ABI, turn it into the correct ABI for this target.
1480     pub fn adjust_abi(&self, abi: Abi) -> Abi {
1481         match abi {
1482             Abi::C { .. } => self.default_adjusted_cabi.unwrap_or(abi),
1483             Abi::System { unwind } if self.is_like_windows && self.arch == "x86" => {
1484                 Abi::Stdcall { unwind }
1485             }
1486             Abi::System { unwind } => Abi::C { unwind },
1487             Abi::EfiApi if self.arch == "x86_64" => Abi::Win64,
1488             Abi::EfiApi => Abi::C { unwind: false },
1489
1490             // See commentary in `is_abi_supported`.
1491             Abi::Stdcall { .. } | Abi::Thiscall { .. } if self.arch == "x86" => abi,
1492             Abi::Stdcall { unwind } | Abi::Thiscall { unwind } => Abi::C { unwind },
1493             Abi::Fastcall if self.arch == "x86" => abi,
1494             Abi::Vectorcall if ["x86", "x86_64"].contains(&&self.arch[..]) => abi,
1495             Abi::Fastcall | Abi::Vectorcall => Abi::C { unwind: false },
1496
1497             abi => abi,
1498         }
1499     }
1500
1501     /// Returns a None if the UNSUPPORTED_CALLING_CONVENTIONS lint should be emitted
1502     pub fn is_abi_supported(&self, abi: Abi) -> Option<bool> {
1503         use Abi::*;
1504         Some(match abi {
1505             Rust
1506             | C { .. }
1507             | System { .. }
1508             | RustIntrinsic
1509             | RustCall
1510             | PlatformIntrinsic
1511             | Unadjusted
1512             | Cdecl
1513             | EfiApi => true,
1514             X86Interrupt => ["x86", "x86_64"].contains(&&self.arch[..]),
1515             Aapcs => "arm" == self.arch,
1516             CCmseNonSecureCall => ["arm", "aarch64"].contains(&&self.arch[..]),
1517             Win64 | SysV64 => self.arch == "x86_64",
1518             PtxKernel => self.arch == "nvptx64",
1519             Msp430Interrupt => self.arch == "msp430",
1520             AmdGpuKernel => self.arch == "amdgcn",
1521             AvrInterrupt | AvrNonBlockingInterrupt => self.arch == "avr",
1522             Wasm => ["wasm32", "wasm64"].contains(&&self.arch[..]),
1523             // On windows these fall-back to platform native calling convention (C) when the
1524             // architecture is not supported.
1525             //
1526             // This is I believe a historical accident that has occurred as part of Microsoft
1527             // striving to allow most of the code to "just" compile when support for 64-bit x86
1528             // was added and then later again, when support for ARM architectures was added.
1529             //
1530             // This is well documented across MSDN. Support for this in Rust has been added in
1531             // #54576. This makes much more sense in context of Microsoft's C++ than it does in
1532             // Rust, but there isn't much leeway remaining here to change it back at the time this
1533             // comment has been written.
1534             //
1535             // Following are the relevant excerpts from the MSDN documentation.
1536             //
1537             // > The __vectorcall calling convention is only supported in native code on x86 and
1538             // x64 processors that include Streaming SIMD Extensions 2 (SSE2) and above.
1539             // > ...
1540             // > On ARM machines, __vectorcall is accepted and ignored by the compiler.
1541             //
1542             // -- https://docs.microsoft.com/en-us/cpp/cpp/vectorcall?view=msvc-160
1543             //
1544             // > On ARM and x64 processors, __stdcall is accepted and ignored by the compiler;
1545             //
1546             // -- https://docs.microsoft.com/en-us/cpp/cpp/stdcall?view=msvc-160
1547             //
1548             // > In most cases, keywords or compiler switches that specify an unsupported
1549             // > convention on a particular platform are ignored, and the platform default
1550             // > convention is used.
1551             //
1552             // -- https://docs.microsoft.com/en-us/cpp/cpp/argument-passing-and-naming-conventions
1553             Stdcall { .. } | Fastcall | Thiscall { .. } | Vectorcall if self.is_like_windows => {
1554                 true
1555             }
1556             // Outside of Windows we want to only support these calling conventions for the
1557             // architectures for which these calling conventions are actually well defined.
1558             Stdcall { .. } | Fastcall | Thiscall { .. } if self.arch == "x86" => true,
1559             Vectorcall if ["x86", "x86_64"].contains(&&self.arch[..]) => true,
1560             // Return a `None` for other cases so that we know to emit a future compat lint.
1561             Stdcall { .. } | Fastcall | Thiscall { .. } | Vectorcall => return None,
1562         })
1563     }
1564
1565     /// Minimum integer size in bits that this target can perform atomic
1566     /// operations on.
1567     pub fn min_atomic_width(&self) -> u64 {
1568         self.min_atomic_width.unwrap_or(8)
1569     }
1570
1571     /// Maximum integer size in bits that this target can perform atomic
1572     /// operations on.
1573     pub fn max_atomic_width(&self) -> u64 {
1574         self.max_atomic_width.unwrap_or_else(|| self.pointer_width.into())
1575     }
1576
1577     /// Loads a target descriptor from a JSON object.
1578     pub fn from_json(mut obj: Json) -> Result<(Target, TargetWarnings), String> {
1579         // While ugly, this code must remain this way to retain
1580         // compatibility with existing JSON fields and the internal
1581         // expected naming of the Target and TargetOptions structs.
1582         // To ensure compatibility is retained, the built-in targets
1583         // are round-tripped through this code to catch cases where
1584         // the JSON parser is not updated to match the structs.
1585
1586         let mut get_req_field = |name: &str| {
1587             obj.remove_key(name)
1588                 .and_then(|j| Json::as_string(&j).map(str::to_string))
1589                 .ok_or_else(|| format!("Field {} in target specification is required", name))
1590         };
1591
1592         let mut base = Target {
1593             llvm_target: get_req_field("llvm-target")?,
1594             pointer_width: get_req_field("target-pointer-width")?
1595                 .parse::<u32>()
1596                 .map_err(|_| "target-pointer-width must be an integer".to_string())?,
1597             data_layout: get_req_field("data-layout")?,
1598             arch: get_req_field("arch")?,
1599             options: Default::default(),
1600         };
1601
1602         let mut incorrect_type = vec![];
1603
1604         macro_rules! key {
1605             ($key_name:ident) => ( {
1606                 let name = (stringify!($key_name)).replace("_", "-");
1607                 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_string(&j).map(str::to_string)) {
1608                     base.$key_name = s;
1609                 }
1610             } );
1611             ($key_name:ident = $json_name:expr) => ( {
1612                 let name = $json_name;
1613                 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_string(&j).map(str::to_string)) {
1614                     base.$key_name = s;
1615                 }
1616             } );
1617             ($key_name:ident, bool) => ( {
1618                 let name = (stringify!($key_name)).replace("_", "-");
1619                 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_boolean(&j)) {
1620                     base.$key_name = s;
1621                 }
1622             } );
1623             ($key_name:ident, u64) => ( {
1624                 let name = (stringify!($key_name)).replace("_", "-");
1625                 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_u64(&j)) {
1626                     base.$key_name = s;
1627                 }
1628             } );
1629             ($key_name:ident, Option<u32>) => ( {
1630                 let name = (stringify!($key_name)).replace("_", "-");
1631                 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_u64(&j)) {
1632                     if s < 1 || s > 5 {
1633                         return Err("Not a valid DWARF version number".to_string());
1634                     }
1635                     base.$key_name = Some(s as u32);
1636                 }
1637             } );
1638             ($key_name:ident, Option<u64>) => ( {
1639                 let name = (stringify!($key_name)).replace("_", "-");
1640                 if let Some(s) = obj.remove_key(&name).and_then(|j| Json::as_u64(&j)) {
1641                     base.$key_name = Some(s);
1642                 }
1643             } );
1644             ($key_name:ident, MergeFunctions) => ( {
1645                 let name = (stringify!($key_name)).replace("_", "-");
1646                 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1647                     match s.parse::<MergeFunctions>() {
1648                         Ok(mergefunc) => base.$key_name = mergefunc,
1649                         _ => return Some(Err(format!("'{}' is not a valid value for \
1650                                                       merge-functions. Use 'disabled', \
1651                                                       'trampolines', or 'aliases'.",
1652                                                       s))),
1653                     }
1654                     Some(Ok(()))
1655                 })).unwrap_or(Ok(()))
1656             } );
1657             ($key_name:ident, RelocModel) => ( {
1658                 let name = (stringify!($key_name)).replace("_", "-");
1659                 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1660                     match s.parse::<RelocModel>() {
1661                         Ok(relocation_model) => base.$key_name = relocation_model,
1662                         _ => return Some(Err(format!("'{}' is not a valid relocation model. \
1663                                                       Run `rustc --print relocation-models` to \
1664                                                       see the list of supported values.", s))),
1665                     }
1666                     Some(Ok(()))
1667                 })).unwrap_or(Ok(()))
1668             } );
1669             ($key_name:ident, CodeModel) => ( {
1670                 let name = (stringify!($key_name)).replace("_", "-");
1671                 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1672                     match s.parse::<CodeModel>() {
1673                         Ok(code_model) => base.$key_name = Some(code_model),
1674                         _ => return Some(Err(format!("'{}' is not a valid code model. \
1675                                                       Run `rustc --print code-models` to \
1676                                                       see the list of supported values.", s))),
1677                     }
1678                     Some(Ok(()))
1679                 })).unwrap_or(Ok(()))
1680             } );
1681             ($key_name:ident, TlsModel) => ( {
1682                 let name = (stringify!($key_name)).replace("_", "-");
1683                 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1684                     match s.parse::<TlsModel>() {
1685                         Ok(tls_model) => base.$key_name = tls_model,
1686                         _ => return Some(Err(format!("'{}' is not a valid TLS model. \
1687                                                       Run `rustc --print tls-models` to \
1688                                                       see the list of supported values.", s))),
1689                     }
1690                     Some(Ok(()))
1691                 })).unwrap_or(Ok(()))
1692             } );
1693             ($key_name:ident, PanicStrategy) => ( {
1694                 let name = (stringify!($key_name)).replace("_", "-");
1695                 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1696                     match s {
1697                         "unwind" => base.$key_name = PanicStrategy::Unwind,
1698                         "abort" => base.$key_name = PanicStrategy::Abort,
1699                         _ => return Some(Err(format!("'{}' is not a valid value for \
1700                                                       panic-strategy. Use 'unwind' or 'abort'.",
1701                                                      s))),
1702                 }
1703                 Some(Ok(()))
1704             })).unwrap_or(Ok(()))
1705             } );
1706             ($key_name:ident, RelroLevel) => ( {
1707                 let name = (stringify!($key_name)).replace("_", "-");
1708                 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1709                     match s.parse::<RelroLevel>() {
1710                         Ok(level) => base.$key_name = level,
1711                         _ => return Some(Err(format!("'{}' is not a valid value for \
1712                                                       relro-level. Use 'full', 'partial, or 'off'.",
1713                                                       s))),
1714                     }
1715                     Some(Ok(()))
1716                 })).unwrap_or(Ok(()))
1717             } );
1718             ($key_name:ident, SplitDebuginfo) => ( {
1719                 let name = (stringify!($key_name)).replace("_", "-");
1720                 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1721                     match s.parse::<SplitDebuginfo>() {
1722                         Ok(level) => base.$key_name = level,
1723                         _ => return Some(Err(format!("'{}' is not a valid value for \
1724                                                       split-debuginfo. Use 'off' or 'dsymutil'.",
1725                                                       s))),
1726                     }
1727                     Some(Ok(()))
1728                 })).unwrap_or(Ok(()))
1729             } );
1730             ($key_name:ident, list) => ( {
1731                 let name = (stringify!($key_name)).replace("_", "-");
1732                 if let Some(j) = obj.remove_key(&name){
1733                     if let Some(v) = Json::as_array(&j) {
1734                         base.$key_name = v.iter()
1735                             .map(|a| a.as_string().unwrap().to_string())
1736                             .collect();
1737                     } else {
1738                         incorrect_type.push(name)
1739                     }
1740                 }
1741             } );
1742             ($key_name:ident, opt_list) => ( {
1743                 let name = (stringify!($key_name)).replace("_", "-");
1744                 if let Some(j) = obj.remove_key(&name) {
1745                     if let Some(v) = Json::as_array(&j) {
1746                         base.$key_name = Some(v.iter()
1747                             .map(|a| a.as_string().unwrap().to_string())
1748                             .collect());
1749                     } else {
1750                         incorrect_type.push(name)
1751                     }
1752                 }
1753             } );
1754             ($key_name:ident, optional) => ( {
1755                 let name = (stringify!($key_name)).replace("_", "-");
1756                 if let Some(o) = obj.remove_key(&name[..]) {
1757                     base.$key_name = o
1758                         .as_string()
1759                         .map(|s| s.to_string() );
1760                 }
1761             } );
1762             ($key_name:ident, LldFlavor) => ( {
1763                 let name = (stringify!($key_name)).replace("_", "-");
1764                 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1765                     if let Some(flavor) = LldFlavor::from_str(&s) {
1766                         base.$key_name = flavor;
1767                     } else {
1768                         return Some(Err(format!(
1769                             "'{}' is not a valid value for lld-flavor. \
1770                              Use 'darwin', 'gnu', 'link' or 'wasm.",
1771                             s)))
1772                     }
1773                     Some(Ok(()))
1774                 })).unwrap_or(Ok(()))
1775             } );
1776             ($key_name:ident, LinkerFlavor) => ( {
1777                 let name = (stringify!($key_name)).replace("_", "-");
1778                 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1779                     match LinkerFlavor::from_str(s) {
1780                         Some(linker_flavor) => base.$key_name = linker_flavor,
1781                         _ => return Some(Err(format!("'{}' is not a valid value for linker-flavor. \
1782                                                       Use {}", s, LinkerFlavor::one_of()))),
1783                     }
1784                     Some(Ok(()))
1785                 })).unwrap_or(Ok(()))
1786             } );
1787             ($key_name:ident, StackProbeType) => ( {
1788                 let name = (stringify!($key_name)).replace("_", "-");
1789                 obj.remove_key(&name[..]).and_then(|o| match StackProbeType::from_json(&o) {
1790                     Ok(v) => {
1791                         base.$key_name = v;
1792                         Some(Ok(()))
1793                     },
1794                     Err(s) => Some(Err(
1795                         format!("`{:?}` is not a valid value for `{}`: {}", o, name, s)
1796                     )),
1797                 }).unwrap_or(Ok(()))
1798             } );
1799             ($key_name:ident, SanitizerSet) => ( {
1800                 let name = (stringify!($key_name)).replace("_", "-");
1801                 if let Some(o) = obj.remove_key(&name[..]) {
1802                     if let Some(a) = o.as_array() {
1803                         for s in a {
1804                             base.$key_name |= match s.as_string() {
1805                                 Some("address") => SanitizerSet::ADDRESS,
1806                                 Some("leak") => SanitizerSet::LEAK,
1807                                 Some("memory") => SanitizerSet::MEMORY,
1808                                 Some("thread") => SanitizerSet::THREAD,
1809                                 Some("hwaddress") => SanitizerSet::HWADDRESS,
1810                                 Some(s) => return Err(format!("unknown sanitizer {}", s)),
1811                                 _ => return Err(format!("not a string: {:?}", s)),
1812                             };
1813                         }
1814                     } else {
1815                         incorrect_type.push(name)
1816                     }
1817                 }
1818                 Ok::<(), String>(())
1819             } );
1820
1821             ($key_name:ident, crt_objects_fallback) => ( {
1822                 let name = (stringify!($key_name)).replace("_", "-");
1823                 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1824                     match s.parse::<CrtObjectsFallback>() {
1825                         Ok(fallback) => base.$key_name = Some(fallback),
1826                         _ => return Some(Err(format!("'{}' is not a valid CRT objects fallback. \
1827                                                       Use 'musl', 'mingw' or 'wasm'", s))),
1828                     }
1829                     Some(Ok(()))
1830                 })).unwrap_or(Ok(()))
1831             } );
1832             ($key_name:ident, link_objects) => ( {
1833                 let name = (stringify!($key_name)).replace("_", "-");
1834                 if let Some(val) = obj.remove_key(&name[..]) {
1835                     let obj = val.as_object().ok_or_else(|| format!("{}: expected a \
1836                         JSON object with fields per CRT object kind.", name))?;
1837                     let mut args = CrtObjects::new();
1838                     for (k, v) in obj {
1839                         let kind = LinkOutputKind::from_str(&k).ok_or_else(|| {
1840                             format!("{}: '{}' is not a valid value for CRT object kind. \
1841                                      Use '(dynamic,static)-(nopic,pic)-exe' or \
1842                                      '(dynamic,static)-dylib' or 'wasi-reactor-exe'", name, k)
1843                         })?;
1844
1845                         let v = v.as_array().ok_or_else(||
1846                             format!("{}.{}: expected a JSON array", name, k)
1847                         )?.iter().enumerate()
1848                             .map(|(i,s)| {
1849                                 let s = s.as_string().ok_or_else(||
1850                                     format!("{}.{}[{}]: expected a JSON string", name, k, i))?;
1851                                 Ok(s.to_owned())
1852                             })
1853                             .collect::<Result<Vec<_>, String>>()?;
1854
1855                         args.insert(kind, v);
1856                     }
1857                     base.$key_name = args;
1858                 }
1859             } );
1860             ($key_name:ident, link_args) => ( {
1861                 let name = (stringify!($key_name)).replace("_", "-");
1862                 if let Some(val) = obj.remove_key(&name[..]) {
1863                     let obj = val.as_object().ok_or_else(|| format!("{}: expected a \
1864                         JSON object with fields per linker-flavor.", name))?;
1865                     let mut args = LinkArgs::new();
1866                     for (k, v) in obj {
1867                         let flavor = LinkerFlavor::from_str(&k).ok_or_else(|| {
1868                             format!("{}: '{}' is not a valid value for linker-flavor. \
1869                                      Use 'em', 'gcc', 'ld' or 'msvc'", name, k)
1870                         })?;
1871
1872                         let v = v.as_array().ok_or_else(||
1873                             format!("{}.{}: expected a JSON array", name, k)
1874                         )?.iter().enumerate()
1875                             .map(|(i,s)| {
1876                                 let s = s.as_string().ok_or_else(||
1877                                     format!("{}.{}[{}]: expected a JSON string", name, k, i))?;
1878                                 Ok(s.to_owned())
1879                             })
1880                             .collect::<Result<Vec<_>, String>>()?;
1881
1882                         args.insert(flavor, v);
1883                     }
1884                     base.$key_name = args;
1885                 }
1886             } );
1887             ($key_name:ident, env) => ( {
1888                 let name = (stringify!($key_name)).replace("_", "-");
1889                 if let Some(o) = obj.remove_key(&name[..]) {
1890                     if let Some(a) = o.as_array() {
1891                         for o in a {
1892                             if let Some(s) = o.as_string() {
1893                                 let p = s.split('=').collect::<Vec<_>>();
1894                                 if p.len() == 2 {
1895                                     let k = p[0].to_string();
1896                                     let v = p[1].to_string();
1897                                     base.$key_name.push((k, v));
1898                                 }
1899                             }
1900                         }
1901                     } else {
1902                         incorrect_type.push(name)
1903                     }
1904                 }
1905             } );
1906             ($key_name:ident, Option<Abi>) => ( {
1907                 let name = (stringify!($key_name)).replace("_", "-");
1908                 obj.remove_key(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1909                     match lookup_abi(s) {
1910                         Some(abi) => base.$key_name = Some(abi),
1911                         _ => return Some(Err(format!("'{}' is not a valid value for abi", s))),
1912                     }
1913                     Some(Ok(()))
1914                 })).unwrap_or(Ok(()))
1915             } );
1916             ($key_name:ident, TargetFamilies) => ( {
1917                 if let Some(value) = obj.remove_key("target-family") {
1918                     if let Some(v) = Json::as_array(&value) {
1919                         base.$key_name = v.iter()
1920                             .map(|a| a.as_string().unwrap().to_string())
1921                             .collect();
1922                     } else if let Some(v) = Json::as_string(&value) {
1923                         base.$key_name = vec![v.to_string()];
1924                     }
1925                 }
1926             } );
1927         }
1928
1929         if let Some(j) = obj.remove_key("target-endian") {
1930             if let Some(s) = Json::as_string(&j) {
1931                 base.endian = s.parse()?;
1932             } else {
1933                 incorrect_type.push("target-endian".to_string())
1934             }
1935         }
1936
1937         if let Some(fp) = obj.remove_key("frame-pointer") {
1938             if let Some(s) = Json::as_string(&fp) {
1939                 base.frame_pointer = s
1940                     .parse()
1941                     .map_err(|()| format!("'{}' is not a valid value for frame-pointer", s))?;
1942             } else {
1943                 incorrect_type.push("frame-pointer".to_string())
1944             }
1945         }
1946
1947         key!(is_builtin, bool);
1948         key!(c_int_width = "target-c-int-width");
1949         key!(os);
1950         key!(env);
1951         key!(abi);
1952         key!(vendor);
1953         key!(linker_flavor, LinkerFlavor)?;
1954         key!(linker, optional);
1955         key!(lld_flavor, LldFlavor)?;
1956         key!(pre_link_objects, link_objects);
1957         key!(post_link_objects, link_objects);
1958         key!(pre_link_objects_fallback, link_objects);
1959         key!(post_link_objects_fallback, link_objects);
1960         key!(crt_objects_fallback, crt_objects_fallback)?;
1961         key!(pre_link_args, link_args);
1962         key!(late_link_args, link_args);
1963         key!(late_link_args_dynamic, link_args);
1964         key!(late_link_args_static, link_args);
1965         key!(post_link_args, link_args);
1966         key!(link_script, optional);
1967         key!(link_env, env);
1968         key!(link_env_remove, list);
1969         key!(asm_args, list);
1970         key!(cpu);
1971         key!(features);
1972         key!(dynamic_linking, bool);
1973         key!(only_cdylib, bool);
1974         key!(executables, bool);
1975         key!(relocation_model, RelocModel)?;
1976         key!(code_model, CodeModel)?;
1977         key!(tls_model, TlsModel)?;
1978         key!(disable_redzone, bool);
1979         key!(function_sections, bool);
1980         key!(dll_prefix);
1981         key!(dll_suffix);
1982         key!(exe_suffix);
1983         key!(staticlib_prefix);
1984         key!(staticlib_suffix);
1985         key!(families, TargetFamilies);
1986         key!(abi_return_struct_as_int, bool);
1987         key!(is_like_osx, bool);
1988         key!(is_like_solaris, bool);
1989         key!(is_like_windows, bool);
1990         key!(is_like_msvc, bool);
1991         key!(is_like_emscripten, bool);
1992         key!(is_like_fuchsia, bool);
1993         key!(is_like_wasm, bool);
1994         key!(dwarf_version, Option<u32>);
1995         key!(linker_is_gnu, bool);
1996         key!(allows_weak_linkage, bool);
1997         key!(has_rpath, bool);
1998         key!(no_default_libraries, bool);
1999         key!(position_independent_executables, bool);
2000         key!(static_position_independent_executables, bool);
2001         key!(needs_plt, bool);
2002         key!(relro_level, RelroLevel)?;
2003         key!(archive_format);
2004         key!(allow_asm, bool);
2005         key!(main_needs_argc_argv, bool);
2006         key!(has_elf_tls, bool);
2007         key!(obj_is_bitcode, bool);
2008         key!(forces_embed_bitcode, bool);
2009         key!(bitcode_llvm_cmdline);
2010         key!(max_atomic_width, Option<u64>);
2011         key!(min_atomic_width, Option<u64>);
2012         key!(atomic_cas, bool);
2013         key!(panic_strategy, PanicStrategy)?;
2014         key!(crt_static_allows_dylibs, bool);
2015         key!(crt_static_default, bool);
2016         key!(crt_static_respected, bool);
2017         key!(stack_probes, StackProbeType)?;
2018         key!(min_global_align, Option<u64>);
2019         key!(default_codegen_units, Option<u64>);
2020         key!(trap_unreachable, bool);
2021         key!(requires_lto, bool);
2022         key!(singlethread, bool);
2023         key!(no_builtins, bool);
2024         key!(default_hidden_visibility, bool);
2025         key!(emit_debug_gdb_scripts, bool);
2026         key!(requires_uwtable, bool);
2027         key!(default_uwtable, bool);
2028         key!(simd_types_indirect, bool);
2029         key!(limit_rdylib_exports, bool);
2030         key!(override_export_symbols, opt_list);
2031         key!(merge_functions, MergeFunctions)?;
2032         key!(mcount = "target-mcount");
2033         key!(llvm_abiname);
2034         key!(relax_elf_relocations, bool);
2035         key!(llvm_args, list);
2036         key!(use_ctors_section, bool);
2037         key!(eh_frame_header, bool);
2038         key!(has_thumb_interworking, bool);
2039         key!(split_debuginfo, SplitDebuginfo)?;
2040         key!(supported_sanitizers, SanitizerSet)?;
2041         key!(default_adjusted_cabi, Option<Abi>)?;
2042         key!(c_enum_min_bits, u64);
2043
2044         if base.is_builtin {
2045             // This can cause unfortunate ICEs later down the line.
2046             return Err("may not set is_builtin for targets not built-in".to_string());
2047         }
2048         // Each field should have been read using `Json::remove_key` so any keys remaining are unused.
2049         let remaining_keys = obj.as_object().ok_or("Expected JSON object for target")?.keys();
2050         Ok((
2051             base,
2052             TargetWarnings { unused_fields: remaining_keys.cloned().collect(), incorrect_type },
2053         ))
2054     }
2055
2056     /// Search for a JSON file specifying the given target triple.
2057     ///
2058     /// If none is found in `$RUST_TARGET_PATH`, look for a file called `target.json` inside the
2059     /// sysroot under the target-triple's `rustlib` directory.  Note that it could also just be a
2060     /// bare filename already, so also check for that. If one of the hardcoded targets we know
2061     /// about, just return it directly.
2062     ///
2063     /// The error string could come from any of the APIs called, including filesystem access and
2064     /// JSON decoding.
2065     pub fn search(
2066         target_triple: &TargetTriple,
2067         sysroot: &PathBuf,
2068     ) -> Result<(Target, TargetWarnings), String> {
2069         use rustc_serialize::json;
2070         use std::env;
2071         use std::fs;
2072
2073         fn load_file(path: &Path) -> Result<(Target, TargetWarnings), String> {
2074             let contents = fs::read(path).map_err(|e| e.to_string())?;
2075             let obj = json::from_reader(&mut &contents[..]).map_err(|e| e.to_string())?;
2076             Target::from_json(obj)
2077         }
2078
2079         match *target_triple {
2080             TargetTriple::TargetTriple(ref target_triple) => {
2081                 // check if triple is in list of built-in targets
2082                 if let Some(t) = load_builtin(target_triple) {
2083                     return Ok((t, TargetWarnings::empty()));
2084                 }
2085
2086                 // search for a file named `target_triple`.json in RUST_TARGET_PATH
2087                 let path = {
2088                     let mut target = target_triple.to_string();
2089                     target.push_str(".json");
2090                     PathBuf::from(target)
2091                 };
2092
2093                 let target_path = env::var_os("RUST_TARGET_PATH").unwrap_or_default();
2094
2095                 for dir in env::split_paths(&target_path) {
2096                     let p = dir.join(&path);
2097                     if p.is_file() {
2098                         return load_file(&p);
2099                     }
2100                 }
2101
2102                 // Additionally look in the sysroot under `lib/rustlib/<triple>/target.json`
2103                 // as a fallback.
2104                 let rustlib_path = crate::target_rustlib_path(&sysroot, &target_triple);
2105                 let p = std::array::IntoIter::new([
2106                     Path::new(sysroot),
2107                     Path::new(&rustlib_path),
2108                     Path::new("target.json"),
2109                 ])
2110                 .collect::<PathBuf>();
2111                 if p.is_file() {
2112                     return load_file(&p);
2113                 }
2114
2115                 Err(format!("Could not find specification for target {:?}", target_triple))
2116             }
2117             TargetTriple::TargetPath(ref target_path) => {
2118                 if target_path.is_file() {
2119                     return load_file(&target_path);
2120                 }
2121                 Err(format!("Target path {:?} is not a valid file", target_path))
2122             }
2123         }
2124     }
2125 }
2126
2127 impl ToJson for Target {
2128     fn to_json(&self) -> Json {
2129         let mut d = BTreeMap::new();
2130         let default: TargetOptions = Default::default();
2131
2132         macro_rules! target_val {
2133             ($attr:ident) => {{
2134                 let name = (stringify!($attr)).replace("_", "-");
2135                 d.insert(name, self.$attr.to_json());
2136             }};
2137             ($attr:ident, $key_name:expr) => {{
2138                 let name = $key_name;
2139                 d.insert(name.to_string(), self.$attr.to_json());
2140             }};
2141         }
2142
2143         macro_rules! target_option_val {
2144             ($attr:ident) => {{
2145                 let name = (stringify!($attr)).replace("_", "-");
2146                 if default.$attr != self.$attr {
2147                     d.insert(name, self.$attr.to_json());
2148                 }
2149             }};
2150             ($attr:ident, $key_name:expr) => {{
2151                 let name = $key_name;
2152                 if default.$attr != self.$attr {
2153                     d.insert(name.to_string(), self.$attr.to_json());
2154                 }
2155             }};
2156             (link_args - $attr:ident) => {{
2157                 let name = (stringify!($attr)).replace("_", "-");
2158                 if default.$attr != self.$attr {
2159                     let obj = self
2160                         .$attr
2161                         .iter()
2162                         .map(|(k, v)| (k.desc().to_owned(), v.clone()))
2163                         .collect::<BTreeMap<_, _>>();
2164                     d.insert(name, obj.to_json());
2165                 }
2166             }};
2167             (env - $attr:ident) => {{
2168                 let name = (stringify!($attr)).replace("_", "-");
2169                 if default.$attr != self.$attr {
2170                     let obj = self
2171                         .$attr
2172                         .iter()
2173                         .map(|&(ref k, ref v)| k.clone() + "=" + &v)
2174                         .collect::<Vec<_>>();
2175                     d.insert(name, obj.to_json());
2176                 }
2177             }};
2178         }
2179
2180         target_val!(llvm_target);
2181         d.insert("target-pointer-width".to_string(), self.pointer_width.to_string().to_json());
2182         target_val!(arch);
2183         target_val!(data_layout);
2184
2185         target_option_val!(is_builtin);
2186         target_option_val!(endian, "target-endian");
2187         target_option_val!(c_int_width, "target-c-int-width");
2188         target_option_val!(os);
2189         target_option_val!(env);
2190         target_option_val!(abi);
2191         target_option_val!(vendor);
2192         target_option_val!(linker_flavor);
2193         target_option_val!(linker);
2194         target_option_val!(lld_flavor);
2195         target_option_val!(pre_link_objects);
2196         target_option_val!(post_link_objects);
2197         target_option_val!(pre_link_objects_fallback);
2198         target_option_val!(post_link_objects_fallback);
2199         target_option_val!(crt_objects_fallback);
2200         target_option_val!(link_args - pre_link_args);
2201         target_option_val!(link_args - late_link_args);
2202         target_option_val!(link_args - late_link_args_dynamic);
2203         target_option_val!(link_args - late_link_args_static);
2204         target_option_val!(link_args - post_link_args);
2205         target_option_val!(link_script);
2206         target_option_val!(env - link_env);
2207         target_option_val!(link_env_remove);
2208         target_option_val!(asm_args);
2209         target_option_val!(cpu);
2210         target_option_val!(features);
2211         target_option_val!(dynamic_linking);
2212         target_option_val!(only_cdylib);
2213         target_option_val!(executables);
2214         target_option_val!(relocation_model);
2215         target_option_val!(code_model);
2216         target_option_val!(tls_model);
2217         target_option_val!(disable_redzone);
2218         target_option_val!(frame_pointer);
2219         target_option_val!(function_sections);
2220         target_option_val!(dll_prefix);
2221         target_option_val!(dll_suffix);
2222         target_option_val!(exe_suffix);
2223         target_option_val!(staticlib_prefix);
2224         target_option_val!(staticlib_suffix);
2225         target_option_val!(families, "target-family");
2226         target_option_val!(abi_return_struct_as_int);
2227         target_option_val!(is_like_osx);
2228         target_option_val!(is_like_solaris);
2229         target_option_val!(is_like_windows);
2230         target_option_val!(is_like_msvc);
2231         target_option_val!(is_like_emscripten);
2232         target_option_val!(is_like_fuchsia);
2233         target_option_val!(is_like_wasm);
2234         target_option_val!(dwarf_version);
2235         target_option_val!(linker_is_gnu);
2236         target_option_val!(allows_weak_linkage);
2237         target_option_val!(has_rpath);
2238         target_option_val!(no_default_libraries);
2239         target_option_val!(position_independent_executables);
2240         target_option_val!(static_position_independent_executables);
2241         target_option_val!(needs_plt);
2242         target_option_val!(relro_level);
2243         target_option_val!(archive_format);
2244         target_option_val!(allow_asm);
2245         target_option_val!(main_needs_argc_argv);
2246         target_option_val!(has_elf_tls);
2247         target_option_val!(obj_is_bitcode);
2248         target_option_val!(forces_embed_bitcode);
2249         target_option_val!(bitcode_llvm_cmdline);
2250         target_option_val!(min_atomic_width);
2251         target_option_val!(max_atomic_width);
2252         target_option_val!(atomic_cas);
2253         target_option_val!(panic_strategy);
2254         target_option_val!(crt_static_allows_dylibs);
2255         target_option_val!(crt_static_default);
2256         target_option_val!(crt_static_respected);
2257         target_option_val!(stack_probes);
2258         target_option_val!(min_global_align);
2259         target_option_val!(default_codegen_units);
2260         target_option_val!(trap_unreachable);
2261         target_option_val!(requires_lto);
2262         target_option_val!(singlethread);
2263         target_option_val!(no_builtins);
2264         target_option_val!(default_hidden_visibility);
2265         target_option_val!(emit_debug_gdb_scripts);
2266         target_option_val!(requires_uwtable);
2267         target_option_val!(default_uwtable);
2268         target_option_val!(simd_types_indirect);
2269         target_option_val!(limit_rdylib_exports);
2270         target_option_val!(override_export_symbols);
2271         target_option_val!(merge_functions);
2272         target_option_val!(mcount, "target-mcount");
2273         target_option_val!(llvm_abiname);
2274         target_option_val!(relax_elf_relocations);
2275         target_option_val!(llvm_args);
2276         target_option_val!(use_ctors_section);
2277         target_option_val!(eh_frame_header);
2278         target_option_val!(has_thumb_interworking);
2279         target_option_val!(split_debuginfo);
2280         target_option_val!(supported_sanitizers);
2281         target_option_val!(c_enum_min_bits);
2282
2283         if let Some(abi) = self.default_adjusted_cabi {
2284             d.insert("default-adjusted-cabi".to_string(), Abi::name(abi).to_json());
2285         }
2286
2287         Json::Object(d)
2288     }
2289 }
2290
2291 /// Either a target triple string or a path to a JSON file.
2292 #[derive(PartialEq, Clone, Debug, Hash, Encodable, Decodable)]
2293 pub enum TargetTriple {
2294     TargetTriple(String),
2295     TargetPath(PathBuf),
2296 }
2297
2298 impl TargetTriple {
2299     /// Creates a target triple from the passed target triple string.
2300     pub fn from_triple(triple: &str) -> Self {
2301         TargetTriple::TargetTriple(triple.to_string())
2302     }
2303
2304     /// Creates a target triple from the passed target path.
2305     pub fn from_path(path: &Path) -> Result<Self, io::Error> {
2306         let canonicalized_path = path.canonicalize()?;
2307         Ok(TargetTriple::TargetPath(canonicalized_path))
2308     }
2309
2310     /// Returns a string triple for this target.
2311     ///
2312     /// If this target is a path, the file name (without extension) is returned.
2313     pub fn triple(&self) -> &str {
2314         match *self {
2315             TargetTriple::TargetTriple(ref triple) => triple,
2316             TargetTriple::TargetPath(ref path) => path
2317                 .file_stem()
2318                 .expect("target path must not be empty")
2319                 .to_str()
2320                 .expect("target path must be valid unicode"),
2321         }
2322     }
2323
2324     /// Returns an extended string triple for this target.
2325     ///
2326     /// If this target is a path, a hash of the path is appended to the triple returned
2327     /// by `triple()`.
2328     pub fn debug_triple(&self) -> String {
2329         use std::collections::hash_map::DefaultHasher;
2330         use std::hash::{Hash, Hasher};
2331
2332         let triple = self.triple();
2333         if let TargetTriple::TargetPath(ref path) = *self {
2334             let mut hasher = DefaultHasher::new();
2335             path.hash(&mut hasher);
2336             let hash = hasher.finish();
2337             format!("{}-{}", triple, hash)
2338         } else {
2339             triple.to_owned()
2340         }
2341     }
2342 }
2343
2344 impl fmt::Display for TargetTriple {
2345     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2346         write!(f, "{}", self.debug_triple())
2347     }
2348 }