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