src/librustc_target/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](http://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::spec::abi::{lookup as lookup_abi, Abi};
  38 use rustc_serialize::json::{Json, ToJson};
  39 use std::collections::BTreeMap;
  40 use std::path::{Path, PathBuf};
  41 use std::str::FromStr;
  42 use std::{fmt, io};
  43
  44 use rustc_macros::HashStable_Generic;
  45
  46 pub mod abi;
  47 mod android_base;
  48 mod apple_base;
  49 mod apple_sdk_base;
  50 mod arm_base;
  51 mod cloudabi_base;
  52 mod dragonfly_base;
  53 mod freebsd_base;
  54 mod fuchsia_base;
  55 mod haiku_base;
  56 mod hermit_base;
  57 mod hermit_kernel_base;
  58 mod illumos_base;
  59 mod l4re_base;
  60 mod linux_base;
  61 mod linux_kernel_base;
  62 mod linux_musl_base;
  63 mod msvc_base;
  64 mod netbsd_base;
  65 mod openbsd_base;
  66 mod redox_base;
  67 mod riscv_base;
  68 mod solaris_base;
  69 mod thumb_base;
  70 mod uefi_msvc_base;
  71 mod vxworks_base;
  72 mod wasm32_base;
  73 mod windows_gnu_base;
  74 mod windows_msvc_base;
  75 mod windows_uwp_gnu_base;
  76 mod windows_uwp_msvc_base;
  77
  78 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
  79 pub enum LinkerFlavor {
  80     Em,
  81     Gcc,
  82     Ld,
  83     Msvc,
  84     Lld(LldFlavor),
  85     PtxLinker,
  86 }
  87
  88 #[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
  89 pub enum LldFlavor {
  90     Wasm,
  91     Ld64,
  92     Ld,
  93     Link,
  94 }
  95
  96 impl LldFlavor {
  97     fn from_str(s: &str) -> Option<Self> {
  98         Some(match s {
  99             "darwin" => LldFlavor::Ld64,
 100             "gnu" => LldFlavor::Ld,
 101             "link" => LldFlavor::Link,
 102             "wasm" => LldFlavor::Wasm,
 103             _ => return None,
 104         })
 105     }
 106 }
 107
 108 impl ToJson for LldFlavor {
 109     fn to_json(&self) -> Json {
 110         match *self {
 111             LldFlavor::Ld64 => "darwin",
 112             LldFlavor::Ld => "gnu",
 113             LldFlavor::Link => "link",
 114             LldFlavor::Wasm => "wasm",
 115         }
 116         .to_json()
 117     }
 118 }
 119
 120 impl ToJson for LinkerFlavor {
 121     fn to_json(&self) -> Json {
 122         self.desc().to_json()
 123     }
 124 }
 125 macro_rules! flavor_mappings {
 126     ($((($($flavor:tt)*), $string:expr),)*) => (
 127         impl LinkerFlavor {
 128             pub const fn one_of() -> &'static str {
 129                 concat!("one of: ", $($string, " ",)*)
 130             }
 131
 132             pub fn from_str(s: &str) -> Option<Self> {
 133                 Some(match s {
 134                     $($string => $($flavor)*,)*
 135                     _ => return None,
 136                 })
 137             }
 138
 139             pub fn desc(&self) -> &str {
 140                 match *self {
 141                     $($($flavor)* => $string,)*
 142                 }
 143             }
 144         }
 145     )
 146 }
 147
 148 flavor_mappings! {
 149     ((LinkerFlavor::Em), "em"),
 150     ((LinkerFlavor::Gcc), "gcc"),
 151     ((LinkerFlavor::Ld), "ld"),
 152     ((LinkerFlavor::Msvc), "msvc"),
 153     ((LinkerFlavor::PtxLinker), "ptx-linker"),
 154     ((LinkerFlavor::Lld(LldFlavor::Wasm)), "wasm-ld"),
 155     ((LinkerFlavor::Lld(LldFlavor::Ld64)), "ld64.lld"),
 156     ((LinkerFlavor::Lld(LldFlavor::Ld)), "ld.lld"),
 157     ((LinkerFlavor::Lld(LldFlavor::Link)), "lld-link"),
 158 }
 159
 160 #[derive(Clone, Copy, Debug, PartialEq, Hash, RustcEncodable, RustcDecodable, HashStable_Generic)]
 161 pub enum PanicStrategy {
 162     Unwind,
 163     Abort,
 164 }
 165
 166 impl PanicStrategy {
 167     pub fn desc(&self) -> &str {
 168         match *self {
 169             PanicStrategy::Unwind => "unwind",
 170             PanicStrategy::Abort => "abort",
 171         }
 172     }
 173 }
 174
 175 impl ToJson for PanicStrategy {
 176     fn to_json(&self) -> Json {
 177         match *self {
 178             PanicStrategy::Abort => "abort".to_json(),
 179             PanicStrategy::Unwind => "unwind".to_json(),
 180         }
 181     }
 182 }
 183
 184 #[derive(Clone, Copy, Debug, PartialEq, Hash, RustcEncodable, RustcDecodable)]
 185 pub enum RelroLevel {
 186     Full,
 187     Partial,
 188     Off,
 189     None,
 190 }
 191
 192 impl RelroLevel {
 193     pub fn desc(&self) -> &str {
 194         match *self {
 195             RelroLevel::Full => "full",
 196             RelroLevel::Partial => "partial",
 197             RelroLevel::Off => "off",
 198             RelroLevel::None => "none",
 199         }
 200     }
 201 }
 202
 203 impl FromStr for RelroLevel {
 204     type Err = ();
 205
 206     fn from_str(s: &str) -> Result<RelroLevel, ()> {
 207         match s {
 208             "full" => Ok(RelroLevel::Full),
 209             "partial" => Ok(RelroLevel::Partial),
 210             "off" => Ok(RelroLevel::Off),
 211             "none" => Ok(RelroLevel::None),
 212             _ => Err(()),
 213         }
 214     }
 215 }
 216
 217 impl ToJson for RelroLevel {
 218     fn to_json(&self) -> Json {
 219         match *self {
 220             RelroLevel::Full => "full".to_json(),
 221             RelroLevel::Partial => "partial".to_json(),
 222             RelroLevel::Off => "off".to_json(),
 223             RelroLevel::None => "None".to_json(),
 224         }
 225     }
 226 }
 227
 228 #[derive(Clone, Copy, Debug, PartialEq, Hash, RustcEncodable, RustcDecodable)]
 229 pub enum MergeFunctions {
 230     Disabled,
 231     Trampolines,
 232     Aliases,
 233 }
 234
 235 impl MergeFunctions {
 236     pub fn desc(&self) -> &str {
 237         match *self {
 238             MergeFunctions::Disabled => "disabled",
 239             MergeFunctions::Trampolines => "trampolines",
 240             MergeFunctions::Aliases => "aliases",
 241         }
 242     }
 243 }
 244
 245 impl FromStr for MergeFunctions {
 246     type Err = ();
 247
 248     fn from_str(s: &str) -> Result<MergeFunctions, ()> {
 249         match s {
 250             "disabled" => Ok(MergeFunctions::Disabled),
 251             "trampolines" => Ok(MergeFunctions::Trampolines),
 252             "aliases" => Ok(MergeFunctions::Aliases),
 253             _ => Err(()),
 254         }
 255     }
 256 }
 257
 258 impl ToJson for MergeFunctions {
 259     fn to_json(&self) -> Json {
 260         match *self {
 261             MergeFunctions::Disabled => "disabled".to_json(),
 262             MergeFunctions::Trampolines => "trampolines".to_json(),
 263             MergeFunctions::Aliases => "aliases".to_json(),
 264         }
 265     }
 266 }
 267
 268 pub enum LoadTargetError {
 269     BuiltinTargetNotFound(String),
 270     Other(String),
 271 }
 272
 273 pub type LinkArgs = BTreeMap<LinkerFlavor, Vec<String>>;
 274 pub type TargetResult = Result<Target, String>;
 275
 276 macro_rules! supported_targets {
 277     ( $(($( $triple:literal, )+ $module:ident ),)+ ) => {
 278         $(mod $module;)+
 279
 280         /// List of supported targets
 281         const TARGETS: &[&str] = &[$($($triple),+),+];
 282
 283         fn load_specific(target: &str) -> Result<Target, LoadTargetError> {
 284             match target {
 285                 $(
 286                     $($triple)|+ => {
 287                         let mut t = $module::target()
 288                             .map_err(LoadTargetError::Other)?;
 289                         t.options.is_builtin = true;
 290
 291                         // round-trip through the JSON parser to ensure at
 292                         // run-time that the parser works correctly
 293                         t = Target::from_json(t.to_json())
 294                             .map_err(LoadTargetError::Other)?;
 295                         debug!("got builtin target: {:?}", t);
 296                         Ok(t)
 297                     },
 298                 )+
 299                     _ => Err(LoadTargetError::BuiltinTargetNotFound(
 300                         format!("Unable to find target: {}", target)))
 301             }
 302         }
 303
 304         pub fn get_targets() -> impl Iterator<Item = String> {
 305             TARGETS.iter().filter_map(|t| -> Option<String> {
 306                 load_specific(t)
 307                     .and(Ok(t.to_string()))
 308                     .ok()
 309             })
 310         }
 311
 312         #[cfg(test)]
 313         mod tests {
 314             mod tests_impl;
 315
 316             // Cannot put this into a separate file without duplication, make an exception.
 317             $(
 318                 #[test] // `#[test]`
 319                 fn $module() {
 320                     tests_impl::test_target(super::$module::target());
 321                 }
 322             )+
 323         }
 324     };
 325 }
 326
 327 supported_targets! {
 328     ("x86_64-unknown-linux-gnu", x86_64_unknown_linux_gnu),
 329     ("x86_64-unknown-linux-gnux32", x86_64_unknown_linux_gnux32),
 330     ("i686-unknown-linux-gnu", i686_unknown_linux_gnu),
 331     ("i586-unknown-linux-gnu", i586_unknown_linux_gnu),
 332     ("mips-unknown-linux-gnu", mips_unknown_linux_gnu),
 333     ("mips64-unknown-linux-gnuabi64", mips64_unknown_linux_gnuabi64),
 334     ("mips64el-unknown-linux-gnuabi64", mips64el_unknown_linux_gnuabi64),
 335     ("mipsisa32r6-unknown-linux-gnu", mipsisa32r6_unknown_linux_gnu),
 336     ("mipsisa32r6el-unknown-linux-gnu", mipsisa32r6el_unknown_linux_gnu),
 337     ("mipsisa64r6-unknown-linux-gnuabi64", mipsisa64r6_unknown_linux_gnuabi64),
 338     ("mipsisa64r6el-unknown-linux-gnuabi64", mipsisa64r6el_unknown_linux_gnuabi64),
 339     ("mipsel-unknown-linux-gnu", mipsel_unknown_linux_gnu),
 340     ("powerpc-unknown-linux-gnu", powerpc_unknown_linux_gnu),
 341     ("powerpc-unknown-linux-gnuspe", powerpc_unknown_linux_gnuspe),
 342     ("powerpc-unknown-linux-musl", powerpc_unknown_linux_musl),
 343     ("powerpc64-unknown-linux-gnu", powerpc64_unknown_linux_gnu),
 344     ("powerpc64-unknown-linux-musl", powerpc64_unknown_linux_musl),
 345     ("powerpc64le-unknown-linux-gnu", powerpc64le_unknown_linux_gnu),
 346     ("powerpc64le-unknown-linux-musl", powerpc64le_unknown_linux_musl),
 347     ("s390x-unknown-linux-gnu", s390x_unknown_linux_gnu),
 348     ("sparc-unknown-linux-gnu", sparc_unknown_linux_gnu),
 349     ("sparc64-unknown-linux-gnu", sparc64_unknown_linux_gnu),
 350     ("arm-unknown-linux-gnueabi", arm_unknown_linux_gnueabi),
 351     ("arm-unknown-linux-gnueabihf", arm_unknown_linux_gnueabihf),
 352     ("arm-unknown-linux-musleabi", arm_unknown_linux_musleabi),
 353     ("arm-unknown-linux-musleabihf", arm_unknown_linux_musleabihf),
 354     ("armv4t-unknown-linux-gnueabi", armv4t_unknown_linux_gnueabi),
 355     ("armv5te-unknown-linux-gnueabi", armv5te_unknown_linux_gnueabi),
 356     ("armv5te-unknown-linux-musleabi", armv5te_unknown_linux_musleabi),
 357     ("armv7-unknown-linux-gnueabi", armv7_unknown_linux_gnueabi),
 358     ("armv7-unknown-linux-gnueabihf", armv7_unknown_linux_gnueabihf),
 359     ("thumbv7neon-unknown-linux-gnueabihf", thumbv7neon_unknown_linux_gnueabihf),
 360     ("thumbv7neon-unknown-linux-musleabihf", thumbv7neon_unknown_linux_musleabihf),
 361     ("armv7-unknown-linux-musleabi", armv7_unknown_linux_musleabi),
 362     ("armv7-unknown-linux-musleabihf", armv7_unknown_linux_musleabihf),
 363     ("aarch64-unknown-linux-gnu", aarch64_unknown_linux_gnu),
 364     ("aarch64-unknown-linux-musl", aarch64_unknown_linux_musl),
 365     ("x86_64-unknown-linux-musl", x86_64_unknown_linux_musl),
 366     ("i686-unknown-linux-musl", i686_unknown_linux_musl),
 367     ("i586-unknown-linux-musl", i586_unknown_linux_musl),
 368     ("mips-unknown-linux-musl", mips_unknown_linux_musl),
 369     ("mipsel-unknown-linux-musl", mipsel_unknown_linux_musl),
 370     ("mips64-unknown-linux-muslabi64", mips64_unknown_linux_muslabi64),
 371     ("mips64el-unknown-linux-muslabi64", mips64el_unknown_linux_muslabi64),
 372     ("hexagon-unknown-linux-musl", hexagon_unknown_linux_musl),
 373
 374     ("mips-unknown-linux-uclibc", mips_unknown_linux_uclibc),
 375     ("mipsel-unknown-linux-uclibc", mipsel_unknown_linux_uclibc),
 376
 377     ("i686-linux-android", i686_linux_android),
 378     ("x86_64-linux-android", x86_64_linux_android),
 379     ("arm-linux-androideabi", arm_linux_androideabi),
 380     ("armv7-linux-androideabi", armv7_linux_androideabi),
 381     ("thumbv7neon-linux-androideabi", thumbv7neon_linux_androideabi),
 382     ("aarch64-linux-android", aarch64_linux_android),
 383
 384     ("x86_64-linux-kernel", x86_64_linux_kernel),
 385
 386     ("aarch64-unknown-freebsd", aarch64_unknown_freebsd),
 387     ("armv6-unknown-freebsd", armv6_unknown_freebsd),
 388     ("armv7-unknown-freebsd", armv7_unknown_freebsd),
 389     ("i686-unknown-freebsd", i686_unknown_freebsd),
 390     ("powerpc64-unknown-freebsd", powerpc64_unknown_freebsd),
 391     ("x86_64-unknown-freebsd", x86_64_unknown_freebsd),
 392
 393     ("x86_64-unknown-dragonfly", x86_64_unknown_dragonfly),
 394
 395     ("aarch64-unknown-openbsd", aarch64_unknown_openbsd),
 396     ("i686-unknown-openbsd", i686_unknown_openbsd),
 397     ("sparc64-unknown-openbsd", sparc64_unknown_openbsd),
 398     ("x86_64-unknown-openbsd", x86_64_unknown_openbsd),
 399
 400     ("aarch64-unknown-netbsd", aarch64_unknown_netbsd),
 401     ("armv6-unknown-netbsd-eabihf", armv6_unknown_netbsd_eabihf),
 402     ("armv7-unknown-netbsd-eabihf", armv7_unknown_netbsd_eabihf),
 403     ("i686-unknown-netbsd", i686_unknown_netbsd),
 404     ("powerpc-unknown-netbsd", powerpc_unknown_netbsd),
 405     ("sparc64-unknown-netbsd", sparc64_unknown_netbsd),
 406     ("x86_64-unknown-netbsd", x86_64_unknown_netbsd),
 407     ("x86_64-rumprun-netbsd", x86_64_rumprun_netbsd),
 408
 409     ("i686-unknown-haiku", i686_unknown_haiku),
 410     ("x86_64-unknown-haiku", x86_64_unknown_haiku),
 411
 412     ("x86_64-apple-darwin", x86_64_apple_darwin),
 413     ("i686-apple-darwin", i686_apple_darwin),
 414
 415     ("aarch64-fuchsia", aarch64_fuchsia),
 416     ("x86_64-fuchsia", x86_64_fuchsia),
 417
 418     ("x86_64-unknown-l4re-uclibc", x86_64_unknown_l4re_uclibc),
 419
 420     ("aarch64-unknown-redox", aarch64_unknown_redox),
 421     ("x86_64-unknown-redox", x86_64_unknown_redox),
 422
 423     ("i386-apple-ios", i386_apple_ios),
 424     ("x86_64-apple-ios", x86_64_apple_ios),
 425     ("aarch64-apple-ios", aarch64_apple_ios),
 426     ("armv7-apple-ios", armv7_apple_ios),
 427     ("armv7s-apple-ios", armv7s_apple_ios),
 428     ("x86_64-apple-ios-macabi", x86_64_apple_ios_macabi),
 429     ("aarch64-apple-tvos", aarch64_apple_tvos),
 430     ("x86_64-apple-tvos", x86_64_apple_tvos),
 431
 432     ("armebv7r-none-eabi", armebv7r_none_eabi),
 433     ("armebv7r-none-eabihf", armebv7r_none_eabihf),
 434     ("armv7r-none-eabi", armv7r_none_eabi),
 435     ("armv7r-none-eabihf", armv7r_none_eabihf),
 436
 437     // `x86_64-pc-solaris` is an alias for `x86_64_sun_solaris` for backwards compatibility reasons.
 438     // (See <https://github.com/rust-lang/rust/issues/40531>.)
 439     ("x86_64-sun-solaris", "x86_64-pc-solaris", x86_64_sun_solaris),
 440     ("sparcv9-sun-solaris", sparcv9_sun_solaris),
 441
 442     ("x86_64-unknown-illumos", x86_64_unknown_illumos),
 443
 444     ("x86_64-pc-windows-gnu", x86_64_pc_windows_gnu),
 445     ("i686-pc-windows-gnu", i686_pc_windows_gnu),
 446     ("i686-uwp-windows-gnu", i686_uwp_windows_gnu),
 447     ("x86_64-uwp-windows-gnu", x86_64_uwp_windows_gnu),
 448
 449     ("aarch64-pc-windows-msvc", aarch64_pc_windows_msvc),
 450     ("aarch64-uwp-windows-msvc", aarch64_uwp_windows_msvc),
 451     ("x86_64-pc-windows-msvc", x86_64_pc_windows_msvc),
 452     ("x86_64-uwp-windows-msvc", x86_64_uwp_windows_msvc),
 453     ("i686-pc-windows-msvc", i686_pc_windows_msvc),
 454     ("i686-uwp-windows-msvc", i686_uwp_windows_msvc),
 455     ("i586-pc-windows-msvc", i586_pc_windows_msvc),
 456     ("thumbv7a-pc-windows-msvc", thumbv7a_pc_windows_msvc),
 457
 458     ("asmjs-unknown-emscripten", asmjs_unknown_emscripten),
 459     ("wasm32-unknown-emscripten", wasm32_unknown_emscripten),
 460     ("wasm32-unknown-unknown", wasm32_unknown_unknown),
 461     ("wasm32-wasi", wasm32_wasi),
 462
 463     ("thumbv6m-none-eabi", thumbv6m_none_eabi),
 464     ("thumbv7m-none-eabi", thumbv7m_none_eabi),
 465     ("thumbv7em-none-eabi", thumbv7em_none_eabi),
 466     ("thumbv7em-none-eabihf", thumbv7em_none_eabihf),
 467     ("thumbv8m.base-none-eabi", thumbv8m_base_none_eabi),
 468     ("thumbv8m.main-none-eabi", thumbv8m_main_none_eabi),
 469     ("thumbv8m.main-none-eabihf", thumbv8m_main_none_eabihf),
 470
 471     ("armv7a-none-eabi", armv7a_none_eabi),
 472     ("armv7a-none-eabihf", armv7a_none_eabihf),
 473
 474     ("msp430-none-elf", msp430_none_elf),
 475
 476     ("aarch64-unknown-cloudabi", aarch64_unknown_cloudabi),
 477     ("armv7-unknown-cloudabi-eabihf", armv7_unknown_cloudabi_eabihf),
 478     ("i686-unknown-cloudabi", i686_unknown_cloudabi),
 479     ("x86_64-unknown-cloudabi", x86_64_unknown_cloudabi),
 480
 481     ("aarch64-unknown-hermit", aarch64_unknown_hermit),
 482     ("x86_64-unknown-hermit", x86_64_unknown_hermit),
 483     ("x86_64-unknown-hermit-kernel", x86_64_unknown_hermit_kernel),
 484
 485     ("riscv32i-unknown-none-elf", riscv32i_unknown_none_elf),
 486     ("riscv32imc-unknown-none-elf", riscv32imc_unknown_none_elf),
 487     ("riscv32imac-unknown-none-elf", riscv32imac_unknown_none_elf),
 488     ("riscv64imac-unknown-none-elf", riscv64imac_unknown_none_elf),
 489     ("riscv64gc-unknown-none-elf", riscv64gc_unknown_none_elf),
 490     ("riscv64gc-unknown-linux-gnu", riscv64gc_unknown_linux_gnu),
 491
 492     ("aarch64-unknown-none", aarch64_unknown_none),
 493     ("aarch64-unknown-none-softfloat", aarch64_unknown_none_softfloat),
 494
 495     ("x86_64-fortanix-unknown-sgx", x86_64_fortanix_unknown_sgx),
 496
 497     ("x86_64-unknown-uefi", x86_64_unknown_uefi),
 498     ("i686-unknown-uefi", i686_unknown_uefi),
 499
 500     ("nvptx64-nvidia-cuda", nvptx64_nvidia_cuda),
 501
 502     ("i686-wrs-vxworks", i686_wrs_vxworks),
 503     ("x86_64-wrs-vxworks", x86_64_wrs_vxworks),
 504     ("armv7-wrs-vxworks-eabihf", armv7_wrs_vxworks_eabihf),
 505     ("aarch64-wrs-vxworks", aarch64_wrs_vxworks),
 506     ("powerpc-wrs-vxworks", powerpc_wrs_vxworks),
 507     ("powerpc-wrs-vxworks-spe", powerpc_wrs_vxworks_spe),
 508     ("powerpc64-wrs-vxworks", powerpc64_wrs_vxworks),
 509 }
 510
 511 /// Everything `rustc` knows about how to compile for a specific target.
 512 ///
 513 /// Every field here must be specified, and has no default value.
 514 #[derive(PartialEq, Clone, Debug)]
 515 pub struct Target {
 516     /// Target triple to pass to LLVM.
 517     pub llvm_target: String,
 518     /// String to use as the `target_endian` `cfg` variable.
 519     pub target_endian: String,
 520     /// String to use as the `target_pointer_width` `cfg` variable.
 521     pub target_pointer_width: String,
 522     /// Width of c_int type
 523     pub target_c_int_width: String,
 524     /// OS name to use for conditional compilation.
 525     pub target_os: String,
 526     /// Environment name to use for conditional compilation.
 527     pub target_env: String,
 528     /// Vendor name to use for conditional compilation.
 529     pub target_vendor: String,
 530     /// Architecture to use for ABI considerations. Valid options include: "x86",
 531     /// "x86_64", "arm", "aarch64", "mips", "powerpc", "powerpc64", and others.
 532     pub arch: String,
 533     /// [Data layout](http://llvm.org/docs/LangRef.html#data-layout) to pass to LLVM.
 534     pub data_layout: String,
 535     /// Default linker flavor used if `-C linker-flavor` or `-C linker` are not passed
 536     /// on the command line.
 537     pub linker_flavor: LinkerFlavor,
 538     /// Optional settings with defaults.
 539     pub options: TargetOptions,
 540 }
 541
 542 pub trait HasTargetSpec {
 543     fn target_spec(&self) -> &Target;
 544 }
 545
 546 impl HasTargetSpec for Target {
 547     fn target_spec(&self) -> &Target {
 548         self
 549     }
 550 }
 551
 552 /// Optional aspects of a target specification.
 553 ///
 554 /// This has an implementation of `Default`, see each field for what the default is. In general,
 555 /// these try to take "minimal defaults" that don't assume anything about the runtime they run in.
 556 #[derive(PartialEq, Clone, Debug)]
 557 pub struct TargetOptions {
 558     /// Whether the target is built-in or loaded from a custom target specification.
 559     pub is_builtin: bool,
 560
 561     /// Linker to invoke
 562     pub linker: Option<String>,
 563
 564     /// LLD flavor used if `lld` (or `rust-lld`) is specified as a linker
 565     /// without clarifying its flavor in any way.
 566     pub lld_flavor: LldFlavor,
 567
 568     /// Linker arguments that are passed *before* any user-defined libraries.
 569     pub pre_link_args: LinkArgs, // ... unconditionally
 570     pub pre_link_args_crt: LinkArgs, // ... when linking with a bundled crt
 571     /// Objects to link before all others, always found within the
 572     /// sysroot folder.
 573     pub pre_link_objects_exe: Vec<String>, // ... when linking an executable, unconditionally
 574     pub pre_link_objects_exe_crt: Vec<String>, // ... when linking an executable with a bundled crt
 575     pub pre_link_objects_dll: Vec<String>, // ... when linking a dylib
 576     /// Linker arguments that are unconditionally passed after any
 577     /// user-defined but before post_link_objects. Standard platform
 578     /// libraries that should be always be linked to, usually go here.
 579     pub late_link_args: LinkArgs,
 580     /// Linker arguments used in addition to `late_link_args` if at least one
 581     /// Rust dependency is dynamically linked.
 582     pub late_link_args_dynamic: LinkArgs,
 583     /// Linker arguments used in addition to `late_link_args` if aall Rust
 584     /// dependencies are statically linked.
 585     pub late_link_args_static: LinkArgs,
 586     /// Objects to link after all others, always found within the
 587     /// sysroot folder.
 588     pub post_link_objects: Vec<String>, // ... unconditionally
 589     pub post_link_objects_crt: Vec<String>, // ... when linking with a bundled crt
 590     /// Linker arguments that are unconditionally passed *after* any
 591     /// user-defined libraries.
 592     pub post_link_args: LinkArgs,
 593
 594     /// Environment variables to be set for the linker invocation.
 595     pub link_env: Vec<(String, String)>,
 596     /// Environment variables to be removed for the linker invocation.
 597     pub link_env_remove: Vec<String>,
 598
 599     /// Extra arguments to pass to the external assembler (when used)
 600     pub asm_args: Vec<String>,
 601
 602     /// Default CPU to pass to LLVM. Corresponds to `llc -mcpu=$cpu`. Defaults
 603     /// to "generic".
 604     pub cpu: String,
 605     /// Default target features to pass to LLVM. These features will *always* be
 606     /// passed, and cannot be disabled even via `-C`. Corresponds to `llc
 607     /// -mattr=$features`.
 608     pub features: String,
 609     /// Whether dynamic linking is available on this target. Defaults to false.
 610     pub dynamic_linking: bool,
 611     /// If dynamic linking is available, whether only cdylibs are supported.
 612     pub only_cdylib: bool,
 613     /// Whether executables are available on this target. iOS, for example, only allows static
 614     /// libraries. Defaults to false.
 615     pub executables: bool,
 616     /// Relocation model to use in object file. Corresponds to `llc
 617     /// -relocation-model=$relocation_model`. Defaults to "pic".
 618     pub relocation_model: String,
 619     /// Code model to use. Corresponds to `llc -code-model=$code_model`.
 620     pub code_model: Option<String>,
 621     /// TLS model to use. Options are "global-dynamic" (default), "local-dynamic", "initial-exec"
 622     /// and "local-exec". This is similar to the -ftls-model option in GCC/Clang.
 623     pub tls_model: String,
 624     /// Do not emit code that uses the "red zone", if the ABI has one. Defaults to false.
 625     pub disable_redzone: bool,
 626     /// Eliminate frame pointers from stack frames if possible. Defaults to true.
 627     pub eliminate_frame_pointer: bool,
 628     /// Emit each function in its own section. Defaults to true.
 629     pub function_sections: bool,
 630     /// String to prepend to the name of every dynamic library. Defaults to "lib".
 631     pub dll_prefix: String,
 632     /// String to append to the name of every dynamic library. Defaults to ".so".
 633     pub dll_suffix: String,
 634     /// String to append to the name of every executable.
 635     pub exe_suffix: String,
 636     /// String to prepend to the name of every static library. Defaults to "lib".
 637     pub staticlib_prefix: String,
 638     /// String to append to the name of every static library. Defaults to ".a".
 639     pub staticlib_suffix: String,
 640     /// OS family to use for conditional compilation. Valid options: "unix", "windows".
 641     pub target_family: Option<String>,
 642     /// Whether the target toolchain's ABI supports returning small structs as an integer.
 643     pub abi_return_struct_as_int: bool,
 644     /// Whether the target toolchain is like macOS's. Only useful for compiling against iOS/macOS,
 645     /// in particular running dsymutil and some other stuff like `-dead_strip`. Defaults to false.
 646     pub is_like_osx: bool,
 647     /// Whether the target toolchain is like Solaris's.
 648     /// Only useful for compiling against Illumos/Solaris,
 649     /// as they have a different set of linker flags. Defaults to false.
 650     pub is_like_solaris: bool,
 651     /// Whether the target toolchain is like Windows'. Only useful for compiling against Windows,
 652     /// only really used for figuring out how to find libraries, since Windows uses its own
 653     /// library naming convention. Defaults to false.
 654     pub is_like_windows: bool,
 655     pub is_like_msvc: bool,
 656     /// Whether the target toolchain is like Android's. Only useful for compiling against Android.
 657     /// Defaults to false.
 658     pub is_like_android: bool,
 659     /// Whether the target toolchain is like Emscripten's. Only useful for compiling with
 660     /// Emscripten toolchain.
 661     /// Defaults to false.
 662     pub is_like_emscripten: bool,
 663     /// Whether the target toolchain is like Fuchsia's.
 664     pub is_like_fuchsia: bool,
 665     /// Whether the linker support GNU-like arguments such as -O. Defaults to false.
 666     pub linker_is_gnu: bool,
 667     /// The MinGW toolchain has a known issue that prevents it from correctly
 668     /// handling COFF object files with more than 2<sup>15</sup> sections. Since each weak
 669     /// symbol needs its own COMDAT section, weak linkage implies a large
 670     /// number sections that easily exceeds the given limit for larger
 671     /// codebases. Consequently we want a way to disallow weak linkage on some
 672     /// platforms.
 673     pub allows_weak_linkage: bool,
 674     /// Whether the linker support rpaths or not. Defaults to false.
 675     pub has_rpath: bool,
 676     /// Whether to disable linking to the default libraries, typically corresponds
 677     /// to `-nodefaultlibs`. Defaults to true.
 678     pub no_default_libraries: bool,
 679     /// Dynamically linked executables can be compiled as position independent
 680     /// if the default relocation model of position independent code is not
 681     /// changed. This is a requirement to take advantage of ASLR, as otherwise
 682     /// the functions in the executable are not randomized and can be used
 683     /// during an exploit of a vulnerability in any code.
 684     pub position_independent_executables: bool,
 685     /// Determines if the target always requires using the PLT for indirect
 686     /// library calls or not. This controls the default value of the `-Z plt` flag.
 687     pub needs_plt: bool,
 688     /// Either partial, full, or off. Full RELRO makes the dynamic linker
 689     /// resolve all symbols at startup and marks the GOT read-only before
 690     /// starting the program, preventing overwriting the GOT.
 691     pub relro_level: RelroLevel,
 692     /// Format that archives should be emitted in. This affects whether we use
 693     /// LLVM to assemble an archive or fall back to the system linker, and
 694     /// currently only "gnu" is used to fall into LLVM. Unknown strings cause
 695     /// the system linker to be used.
 696     pub archive_format: String,
 697     /// Is asm!() allowed? Defaults to true.
 698     pub allow_asm: bool,
 699     /// Whether the runtime startup code requires the `main` function be passed
 700     /// `argc` and `argv` values.
 701     pub main_needs_argc_argv: bool,
 702
 703     /// Flag indicating whether ELF TLS (e.g., #[thread_local]) is available for
 704     /// this target.
 705     pub has_elf_tls: bool,
 706     // This is mainly for easy compatibility with emscripten.
 707     // If we give emcc .o files that are actually .bc files it
 708     // will 'just work'.
 709     pub obj_is_bitcode: bool,
 710
 711     /// Don't use this field; instead use the `.min_atomic_width()` method.
 712     pub min_atomic_width: Option<u64>,
 713
 714     /// Don't use this field; instead use the `.max_atomic_width()` method.
 715     pub max_atomic_width: Option<u64>,
 716
 717     /// Whether the target supports atomic CAS operations natively
 718     pub atomic_cas: bool,
 719
 720     /// Panic strategy: "unwind" or "abort"
 721     pub panic_strategy: PanicStrategy,
 722
 723     /// A blacklist of ABIs unsupported by the current target. Note that generic
 724     /// ABIs are considered to be supported on all platforms and cannot be blacklisted.
 725     pub abi_blacklist: Vec<Abi>,
 726
 727     /// Whether or not linking dylibs to a static CRT is allowed.
 728     pub crt_static_allows_dylibs: bool,
 729     /// Whether or not the CRT is statically linked by default.
 730     pub crt_static_default: bool,
 731     /// Whether or not crt-static is respected by the compiler (or is a no-op).
 732     pub crt_static_respected: bool,
 733
 734     /// Whether or not stack probes (__rust_probestack) are enabled
 735     pub stack_probes: bool,
 736
 737     /// The minimum alignment for global symbols.
 738     pub min_global_align: Option<u64>,
 739
 740     /// Default number of codegen units to use in debug mode
 741     pub default_codegen_units: Option<u64>,
 742
 743     /// Whether to generate trap instructions in places where optimization would
 744     /// otherwise produce control flow that falls through into unrelated memory.
 745     pub trap_unreachable: bool,
 746
 747     /// This target requires everything to be compiled with LTO to emit a final
 748     /// executable, aka there is no native linker for this target.
 749     pub requires_lto: bool,
 750
 751     /// This target has no support for threads.
 752     pub singlethread: bool,
 753
 754     /// Whether library functions call lowering/optimization is disabled in LLVM
 755     /// for this target unconditionally.
 756     pub no_builtins: bool,
 757
 758     /// The codegen backend to use for this target, typically "llvm"
 759     pub codegen_backend: String,
 760
 761     /// The default visibility for symbols in this target should be "hidden"
 762     /// rather than "default"
 763     pub default_hidden_visibility: bool,
 764
 765     /// Whether a .debug_gdb_scripts section will be added to the output object file
 766     pub emit_debug_gdb_scripts: bool,
 767
 768     /// Whether or not to unconditionally `uwtable` attributes on functions,
 769     /// typically because the platform needs to unwind for things like stack
 770     /// unwinders.
 771     pub requires_uwtable: bool,
 772
 773     /// Whether or not SIMD types are passed by reference in the Rust ABI,
 774     /// typically required if a target can be compiled with a mixed set of
 775     /// target features. This is `true` by default, and `false` for targets like
 776     /// wasm32 where the whole program either has simd or not.
 777     pub simd_types_indirect: bool,
 778
 779     /// Pass a list of symbol which should be exported in the dylib to the linker.
 780     pub limit_rdylib_exports: bool,
 781
 782     /// If set, have the linker export exactly these symbols, instead of using
 783     /// the usual logic to figure this out from the crate itself.
 784     pub override_export_symbols: Option<Vec<String>>,
 785
 786     /// Determines how or whether the MergeFunctions LLVM pass should run for
 787     /// this target. Either "disabled", "trampolines", or "aliases".
 788     /// The MergeFunctions pass is generally useful, but some targets may need
 789     /// to opt out. The default is "aliases".
 790     ///
 791     /// Workaround for: https://github.com/rust-lang/rust/issues/57356
 792     pub merge_functions: MergeFunctions,
 793
 794     /// Use platform dependent mcount function
 795     pub target_mcount: String,
 796
 797     /// LLVM ABI name, corresponds to the '-mabi' parameter available in multilib C compilers
 798     pub llvm_abiname: String,
 799
 800     /// Whether or not RelaxElfRelocation flag will be passed to the linker
 801     pub relax_elf_relocations: bool,
 802
 803     /// Additional arguments to pass to LLVM, similar to the `-C llvm-args` codegen option.
 804     pub llvm_args: Vec<String>,
 805 }
 806
 807 impl Default for TargetOptions {
 808     /// Creates a set of "sane defaults" for any target. This is still
 809     /// incomplete, and if used for compilation, will certainly not work.
 810     fn default() -> TargetOptions {
 811         TargetOptions {
 812             is_builtin: false,
 813             linker: option_env!("CFG_DEFAULT_LINKER").map(|s| s.to_string()),
 814             lld_flavor: LldFlavor::Ld,
 815             pre_link_args: LinkArgs::new(),
 816             pre_link_args_crt: LinkArgs::new(),
 817             post_link_args: LinkArgs::new(),
 818             asm_args: Vec::new(),
 819             cpu: "generic".to_string(),
 820             features: String::new(),
 821             dynamic_linking: false,
 822             only_cdylib: false,
 823             executables: false,
 824             relocation_model: "pic".to_string(),
 825             code_model: None,
 826             tls_model: "global-dynamic".to_string(),
 827             disable_redzone: false,
 828             eliminate_frame_pointer: true,
 829             function_sections: true,
 830             dll_prefix: "lib".to_string(),
 831             dll_suffix: ".so".to_string(),
 832             exe_suffix: String::new(),
 833             staticlib_prefix: "lib".to_string(),
 834             staticlib_suffix: ".a".to_string(),
 835             target_family: None,
 836             abi_return_struct_as_int: false,
 837             is_like_osx: false,
 838             is_like_solaris: false,
 839             is_like_windows: false,
 840             is_like_android: false,
 841             is_like_emscripten: false,
 842             is_like_msvc: false,
 843             is_like_fuchsia: false,
 844             linker_is_gnu: false,
 845             allows_weak_linkage: true,
 846             has_rpath: false,
 847             no_default_libraries: true,
 848             position_independent_executables: false,
 849             needs_plt: false,
 850             relro_level: RelroLevel::None,
 851             pre_link_objects_exe: Vec::new(),
 852             pre_link_objects_exe_crt: Vec::new(),
 853             pre_link_objects_dll: Vec::new(),
 854             post_link_objects: Vec::new(),
 855             post_link_objects_crt: Vec::new(),
 856             late_link_args: LinkArgs::new(),
 857             late_link_args_dynamic: LinkArgs::new(),
 858             late_link_args_static: LinkArgs::new(),
 859             link_env: Vec::new(),
 860             link_env_remove: Vec::new(),
 861             archive_format: "gnu".to_string(),
 862             main_needs_argc_argv: true,
 863             allow_asm: true,
 864             has_elf_tls: false,
 865             obj_is_bitcode: false,
 866             min_atomic_width: None,
 867             max_atomic_width: None,
 868             atomic_cas: true,
 869             panic_strategy: PanicStrategy::Unwind,
 870             abi_blacklist: vec![],
 871             crt_static_allows_dylibs: false,
 872             crt_static_default: false,
 873             crt_static_respected: false,
 874             stack_probes: false,
 875             min_global_align: None,
 876             default_codegen_units: None,
 877             trap_unreachable: true,
 878             requires_lto: false,
 879             singlethread: false,
 880             no_builtins: false,
 881             codegen_backend: "llvm".to_string(),
 882             default_hidden_visibility: false,
 883             emit_debug_gdb_scripts: true,
 884             requires_uwtable: false,
 885             simd_types_indirect: true,
 886             limit_rdylib_exports: true,
 887             override_export_symbols: None,
 888             merge_functions: MergeFunctions::Aliases,
 889             target_mcount: "mcount".to_string(),
 890             llvm_abiname: "".to_string(),
 891             relax_elf_relocations: false,
 892             llvm_args: vec![],
 893         }
 894     }
 895 }
 896
 897 impl Target {
 898     /// Given a function ABI, turn it into the correct ABI for this target.
 899     pub fn adjust_abi(&self, abi: Abi) -> Abi {
 900         match abi {
 901             Abi::System => {
 902                 if self.options.is_like_windows && self.arch == "x86" {
 903                     Abi::Stdcall
 904                 } else {
 905                     Abi::C
 906                 }
 907             }
 908             // These ABI kinds are ignored on non-x86 Windows targets.
 909             // See https://docs.microsoft.com/en-us/cpp/cpp/argument-passing-and-naming-conventions
 910             // and the individual pages for __stdcall et al.
 911             Abi::Stdcall | Abi::Fastcall | Abi::Vectorcall | Abi::Thiscall => {
 912                 if self.options.is_like_windows && self.arch != "x86" { Abi::C } else { abi }
 913             }
 914             Abi::EfiApi => {
 915                 if self.arch == "x86_64" {
 916                     Abi::Win64
 917                 } else {
 918                     Abi::C
 919                 }
 920             }
 921             abi => abi,
 922         }
 923     }
 924
 925     /// Minimum integer size in bits that this target can perform atomic
 926     /// operations on.
 927     pub fn min_atomic_width(&self) -> u64 {
 928         self.options.min_atomic_width.unwrap_or(8)
 929     }
 930
 931     /// Maximum integer size in bits that this target can perform atomic
 932     /// operations on.
 933     pub fn max_atomic_width(&self) -> u64 {
 934         self.options.max_atomic_width.unwrap_or_else(|| self.target_pointer_width.parse().unwrap())
 935     }
 936
 937     pub fn is_abi_supported(&self, abi: Abi) -> bool {
 938         abi.generic() || !self.options.abi_blacklist.contains(&abi)
 939     }
 940
 941     /// Loads a target descriptor from a JSON object.
 942     pub fn from_json(obj: Json) -> TargetResult {
 943         // While ugly, this code must remain this way to retain
 944         // compatibility with existing JSON fields and the internal
 945         // expected naming of the Target and TargetOptions structs.
 946         // To ensure compatibility is retained, the built-in targets
 947         // are round-tripped through this code to catch cases where
 948         // the JSON parser is not updated to match the structs.
 949
 950         let get_req_field = |name: &str| {
 951             obj.find(name)
 952                 .map(|s| s.as_string())
 953                 .and_then(|os| os.map(|s| s.to_string()))
 954                 .ok_or_else(|| format!("Field {} in target specification is required", name))
 955         };
 956
 957         let get_opt_field = |name: &str, default: &str| {
 958             obj.find(name)
 959                 .and_then(|s| s.as_string())
 960                 .map(|s| s.to_string())
 961                 .unwrap_or_else(|| default.to_string())
 962         };
 963
 964         let mut base = Target {
 965             llvm_target: get_req_field("llvm-target")?,
 966             target_endian: get_req_field("target-endian")?,
 967             target_pointer_width: get_req_field("target-pointer-width")?,
 968             target_c_int_width: get_req_field("target-c-int-width")?,
 969             data_layout: get_req_field("data-layout")?,
 970             arch: get_req_field("arch")?,
 971             target_os: get_req_field("os")?,
 972             target_env: get_opt_field("env", ""),
 973             target_vendor: get_opt_field("vendor", "unknown"),
 974             linker_flavor: LinkerFlavor::from_str(&*get_req_field("linker-flavor")?)
 975                 .ok_or_else(|| format!("linker flavor must be {}", LinkerFlavor::one_of()))?,
 976             options: Default::default(),
 977         };
 978
 979         macro_rules! key {
 980             ($key_name:ident) => ( {
 981                 let name = (stringify!($key_name)).replace("_", "-");
 982                 obj.find(&name[..]).map(|o| o.as_string()
 983                                     .map(|s| base.options.$key_name = s.to_string()));
 984             } );
 985             ($key_name:ident, bool) => ( {
 986                 let name = (stringify!($key_name)).replace("_", "-");
 987                 obj.find(&name[..])
 988                     .map(|o| o.as_boolean()
 989                          .map(|s| base.options.$key_name = s));
 990             } );
 991             ($key_name:ident, Option<u64>) => ( {
 992                 let name = (stringify!($key_name)).replace("_", "-");
 993                 obj.find(&name[..])
 994                     .map(|o| o.as_u64()
 995                          .map(|s| base.options.$key_name = Some(s)));
 996             } );
 997             ($key_name:ident, MergeFunctions) => ( {
 998                 let name = (stringify!($key_name)).replace("_", "-");
 999                 obj.find(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1000                     match s.parse::<MergeFunctions>() {
1001                         Ok(mergefunc) => base.options.$key_name = mergefunc,
1002                         _ => return Some(Err(format!("'{}' is not a valid value for \
1003                                                       merge-functions. Use 'disabled', \
1004                                                       'trampolines', or 'aliases'.",
1005                                                       s))),
1006                     }
1007                     Some(Ok(()))
1008                 })).unwrap_or(Ok(()))
1009             } );
1010             ($key_name:ident, PanicStrategy) => ( {
1011                 let name = (stringify!($key_name)).replace("_", "-");
1012                 obj.find(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1013                     match s {
1014                         "unwind" => base.options.$key_name = PanicStrategy::Unwind,
1015                         "abort" => base.options.$key_name = PanicStrategy::Abort,
1016                         _ => return Some(Err(format!("'{}' is not a valid value for \
1017                                                       panic-strategy. Use 'unwind' or 'abort'.",
1018                                                      s))),
1019                 }
1020                 Some(Ok(()))
1021             })).unwrap_or(Ok(()))
1022             } );
1023             ($key_name:ident, RelroLevel) => ( {
1024                 let name = (stringify!($key_name)).replace("_", "-");
1025                 obj.find(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1026                     match s.parse::<RelroLevel>() {
1027                         Ok(level) => base.options.$key_name = level,
1028                         _ => return Some(Err(format!("'{}' is not a valid value for \
1029                                                       relro-level. Use 'full', 'partial, or 'off'.",
1030                                                       s))),
1031                     }
1032                     Some(Ok(()))
1033                 })).unwrap_or(Ok(()))
1034             } );
1035             ($key_name:ident, list) => ( {
1036                 let name = (stringify!($key_name)).replace("_", "-");
1037                 obj.find(&name[..]).map(|o| o.as_array()
1038                     .map(|v| base.options.$key_name = v.iter()
1039                         .map(|a| a.as_string().unwrap().to_string()).collect()
1040                         )
1041                     );
1042             } );
1043             ($key_name:ident, opt_list) => ( {
1044                 let name = (stringify!($key_name)).replace("_", "-");
1045                 obj.find(&name[..]).map(|o| o.as_array()
1046                     .map(|v| base.options.$key_name = Some(v.iter()
1047                         .map(|a| a.as_string().unwrap().to_string()).collect())
1048                         )
1049                     );
1050             } );
1051             ($key_name:ident, optional) => ( {
1052                 let name = (stringify!($key_name)).replace("_", "-");
1053                 if let Some(o) = obj.find(&name[..]) {
1054                     base.options.$key_name = o
1055                         .as_string()
1056                         .map(|s| s.to_string() );
1057                 }
1058             } );
1059             ($key_name:ident, LldFlavor) => ( {
1060                 let name = (stringify!($key_name)).replace("_", "-");
1061                 obj.find(&name[..]).and_then(|o| o.as_string().and_then(|s| {
1062                     if let Some(flavor) = LldFlavor::from_str(&s) {
1063                         base.options.$key_name = flavor;
1064                     } else {
1065                         return Some(Err(format!(
1066                             "'{}' is not a valid value for lld-flavor. \
1067                              Use 'darwin', 'gnu', 'link' or 'wasm.",
1068                             s)))
1069                     }
1070                     Some(Ok(()))
1071                 })).unwrap_or(Ok(()))
1072             } );
1073             ($key_name:ident, LinkerFlavor) => ( {
1074                 let name = (stringify!($key_name)).replace("_", "-");
1075                 obj.find(&name[..]).and_then(|o| o.as_string().map(|s| {
1076                     LinkerFlavor::from_str(&s).ok_or_else(|| {
1077                         Err(format!("'{}' is not a valid value for linker-flavor. \
1078                                      Use 'em', 'gcc', 'ld' or 'msvc.", s))
1079                     })
1080                 })).unwrap_or(Ok(()))
1081             } );
1082             ($key_name:ident, link_args) => ( {
1083                 let name = (stringify!($key_name)).replace("_", "-");
1084                 if let Some(val) = obj.find(&name[..]) {
1085                     let obj = val.as_object().ok_or_else(|| format!("{}: expected a \
1086                         JSON object with fields per linker-flavor.", name))?;
1087                     let mut args = LinkArgs::new();
1088                     for (k, v) in obj {
1089                         let flavor = LinkerFlavor::from_str(&k).ok_or_else(|| {
1090                             format!("{}: '{}' is not a valid value for linker-flavor. \
1091                                      Use 'em', 'gcc', 'ld' or 'msvc'", name, k)
1092                         })?;
1093
1094                         let v = v.as_array().ok_or_else(||
1095                             format!("{}.{}: expected a JSON array", name, k)
1096                         )?.iter().enumerate()
1097                             .map(|(i,s)| {
1098                                 let s = s.as_string().ok_or_else(||
1099                                     format!("{}.{}[{}]: expected a JSON string", name, k, i))?;
1100                                 Ok(s.to_owned())
1101                             })
1102                             .collect::<Result<Vec<_>, String>>()?;
1103
1104                         args.insert(flavor, v);
1105                     }
1106                     base.options.$key_name = args;
1107                 }
1108             } );
1109             ($key_name:ident, env) => ( {
1110                 let name = (stringify!($key_name)).replace("_", "-");
1111                 if let Some(a) = obj.find(&name[..]).and_then(|o| o.as_array()) {
1112                     for o in a {
1113                         if let Some(s) = o.as_string() {
1114                             let p = s.split('=').collect::<Vec<_>>();
1115                             if p.len() == 2 {
1116                                 let k = p[0].to_string();
1117                                 let v = p[1].to_string();
1118                                 base.options.$key_name.push((k, v));
1119                             }
1120                         }
1121                     }
1122                 }
1123             } );
1124         }
1125
1126         key!(is_builtin, bool);
1127         key!(linker, optional);
1128         key!(lld_flavor, LldFlavor)?;
1129         key!(pre_link_args, link_args);
1130         key!(pre_link_args_crt, link_args);
1131         key!(pre_link_objects_exe, list);
1132         key!(pre_link_objects_exe_crt, list);
1133         key!(pre_link_objects_dll, list);
1134         key!(late_link_args, link_args);
1135         key!(late_link_args_dynamic, link_args);
1136         key!(late_link_args_static, link_args);
1137         key!(post_link_objects, list);
1138         key!(post_link_objects_crt, list);
1139         key!(post_link_args, link_args);
1140         key!(link_env, env);
1141         key!(link_env_remove, list);
1142         key!(asm_args, list);
1143         key!(cpu);
1144         key!(features);
1145         key!(dynamic_linking, bool);
1146         key!(only_cdylib, bool);
1147         key!(executables, bool);
1148         key!(relocation_model);
1149         key!(code_model, optional);
1150         key!(tls_model);
1151         key!(disable_redzone, bool);
1152         key!(eliminate_frame_pointer, bool);
1153         key!(function_sections, bool);
1154         key!(dll_prefix);
1155         key!(dll_suffix);
1156         key!(exe_suffix);
1157         key!(staticlib_prefix);
1158         key!(staticlib_suffix);
1159         key!(target_family, optional);
1160         key!(abi_return_struct_as_int, bool);
1161         key!(is_like_osx, bool);
1162         key!(is_like_solaris, bool);
1163         key!(is_like_windows, bool);
1164         key!(is_like_msvc, bool);
1165         key!(is_like_emscripten, bool);
1166         key!(is_like_android, bool);
1167         key!(is_like_fuchsia, bool);
1168         key!(linker_is_gnu, bool);
1169         key!(allows_weak_linkage, bool);
1170         key!(has_rpath, bool);
1171         key!(no_default_libraries, bool);
1172         key!(position_independent_executables, bool);
1173         key!(needs_plt, bool);
1174         key!(relro_level, RelroLevel)?;
1175         key!(archive_format);
1176         key!(allow_asm, bool);
1177         key!(main_needs_argc_argv, bool);
1178         key!(has_elf_tls, bool);
1179         key!(obj_is_bitcode, bool);
1180         key!(max_atomic_width, Option<u64>);
1181         key!(min_atomic_width, Option<u64>);
1182         key!(atomic_cas, bool);
1183         key!(panic_strategy, PanicStrategy)?;
1184         key!(crt_static_allows_dylibs, bool);
1185         key!(crt_static_default, bool);
1186         key!(crt_static_respected, bool);
1187         key!(stack_probes, bool);
1188         key!(min_global_align, Option<u64>);
1189         key!(default_codegen_units, Option<u64>);
1190         key!(trap_unreachable, bool);
1191         key!(requires_lto, bool);
1192         key!(singlethread, bool);
1193         key!(no_builtins, bool);
1194         key!(codegen_backend);
1195         key!(default_hidden_visibility, bool);
1196         key!(emit_debug_gdb_scripts, bool);
1197         key!(requires_uwtable, bool);
1198         key!(simd_types_indirect, bool);
1199         key!(limit_rdylib_exports, bool);
1200         key!(override_export_symbols, opt_list);
1201         key!(merge_functions, MergeFunctions)?;
1202         key!(target_mcount);
1203         key!(llvm_abiname);
1204         key!(relax_elf_relocations, bool);
1205         key!(llvm_args, list);
1206
1207         if let Some(array) = obj.find("abi-blacklist").and_then(Json::as_array) {
1208             for name in array.iter().filter_map(|abi| abi.as_string()) {
1209                 match lookup_abi(name) {
1210                     Some(abi) => {
1211                         if abi.generic() {
1212                             return Err(format!(
1213                                 "The ABI \"{}\" is considered to be supported on \
1214                                                 all targets and cannot be blacklisted",
1215                                 abi
1216                             ));
1217                         }
1218
1219                         base.options.abi_blacklist.push(abi)
1220                     }
1221                     None => {
1222                         return Err(format!("Unknown ABI \"{}\" in target specification", name));
1223                     }
1224                 }
1225             }
1226         }
1227
1228         Ok(base)
1229     }
1230
1231     /// Search RUST_TARGET_PATH for a JSON file specifying the given target
1232     /// triple. Note that it could also just be a bare filename already, so also
1233     /// check for that. If one of the hardcoded targets we know about, just
1234     /// return it directly.
1235     ///
1236     /// The error string could come from any of the APIs called, including
1237     /// filesystem access and JSON decoding.
1238     pub fn search(target_triple: &TargetTriple) -> Result<Target, String> {
1239         use rustc_serialize::json;
1240         use std::env;
1241         use std::fs;
1242
1243         fn load_file(path: &Path) -> Result<Target, String> {
1244             let contents = fs::read(path).map_err(|e| e.to_string())?;
1245             let obj = json::from_reader(&mut &contents[..]).map_err(|e| e.to_string())?;
1246             Target::from_json(obj)
1247         }
1248
1249         match *target_triple {
1250             TargetTriple::TargetTriple(ref target_triple) => {
1251                 // check if triple is in list of supported targets
1252                 match load_specific(target_triple) {
1253                     Ok(t) => return Ok(t),
1254                     Err(LoadTargetError::BuiltinTargetNotFound(_)) => (),
1255                     Err(LoadTargetError::Other(e)) => return Err(e),
1256                 }
1257
1258                 // search for a file named `target_triple`.json in RUST_TARGET_PATH
1259                 let path = {
1260                     let mut target = target_triple.to_string();
1261                     target.push_str(".json");
1262                     PathBuf::from(target)
1263                 };
1264
1265                 let target_path = env::var_os("RUST_TARGET_PATH").unwrap_or_default();
1266
1267                 // FIXME 16351: add a sane default search path?
1268
1269                 for dir in env::split_paths(&target_path) {
1270                     let p = dir.join(&path);
1271                     if p.is_file() {
1272                         return load_file(&p);
1273                     }
1274                 }
1275                 Err(format!("Could not find specification for target {:?}", target_triple))
1276             }
1277             TargetTriple::TargetPath(ref target_path) => {
1278                 if target_path.is_file() {
1279                     return load_file(&target_path);
1280                 }
1281                 Err(format!("Target path {:?} is not a valid file", target_path))
1282             }
1283         }
1284     }
1285 }
1286
1287 impl ToJson for Target {
1288     fn to_json(&self) -> Json {
1289         let mut d = BTreeMap::new();
1290         let default: TargetOptions = Default::default();
1291
1292         macro_rules! target_val {
1293             ($attr:ident) => {{
1294                 let name = (stringify!($attr)).replace("_", "-");
1295                 d.insert(name, self.$attr.to_json());
1296             }};
1297             ($attr:ident, $key_name:expr) => {{
1298                 let name = $key_name;
1299                 d.insert(name.to_string(), self.$attr.to_json());
1300             }};
1301         }
1302
1303         macro_rules! target_option_val {
1304             ($attr:ident) => {{
1305                 let name = (stringify!($attr)).replace("_", "-");
1306                 if default.$attr != self.options.$attr {
1307                     d.insert(name, self.options.$attr.to_json());
1308                 }
1309             }};
1310             ($attr:ident, $key_name:expr) => {{
1311                 let name = $key_name;
1312                 if default.$attr != self.options.$attr {
1313                     d.insert(name.to_string(), self.options.$attr.to_json());
1314                 }
1315             }};
1316             (link_args - $attr:ident) => {{
1317                 let name = (stringify!($attr)).replace("_", "-");
1318                 if default.$attr != self.options.$attr {
1319                     let obj = self
1320                         .options
1321                         .$attr
1322                         .iter()
1323                         .map(|(k, v)| (k.desc().to_owned(), v.clone()))
1324                         .collect::<BTreeMap<_, _>>();
1325                     d.insert(name, obj.to_json());
1326                 }
1327             }};
1328             (env - $attr:ident) => {{
1329                 let name = (stringify!($attr)).replace("_", "-");
1330                 if default.$attr != self.options.$attr {
1331                     let obj = self
1332                         .options
1333                         .$attr
1334                         .iter()
1335                         .map(|&(ref k, ref v)| k.clone() + "=" + &v)
1336                         .collect::<Vec<_>>();
1337                     d.insert(name, obj.to_json());
1338                 }
1339             }};
1340         }
1341
1342         target_val!(llvm_target);
1343         target_val!(target_endian);
1344         target_val!(target_pointer_width);
1345         target_val!(target_c_int_width);
1346         target_val!(arch);
1347         target_val!(target_os, "os");
1348         target_val!(target_env, "env");
1349         target_val!(target_vendor, "vendor");
1350         target_val!(data_layout);
1351         target_val!(linker_flavor);
1352
1353         target_option_val!(is_builtin);
1354         target_option_val!(linker);
1355         target_option_val!(lld_flavor);
1356         target_option_val!(link_args - pre_link_args);
1357         target_option_val!(link_args - pre_link_args_crt);
1358         target_option_val!(pre_link_objects_exe);
1359         target_option_val!(pre_link_objects_exe_crt);
1360         target_option_val!(pre_link_objects_dll);
1361         target_option_val!(link_args - late_link_args);
1362         target_option_val!(link_args - late_link_args_dynamic);
1363         target_option_val!(link_args - late_link_args_static);
1364         target_option_val!(post_link_objects);
1365         target_option_val!(post_link_objects_crt);
1366         target_option_val!(link_args - post_link_args);
1367         target_option_val!(env - link_env);
1368         target_option_val!(link_env_remove);
1369         target_option_val!(asm_args);
1370         target_option_val!(cpu);
1371         target_option_val!(features);
1372         target_option_val!(dynamic_linking);
1373         target_option_val!(only_cdylib);
1374         target_option_val!(executables);
1375         target_option_val!(relocation_model);
1376         target_option_val!(code_model);
1377         target_option_val!(tls_model);
1378         target_option_val!(disable_redzone);
1379         target_option_val!(eliminate_frame_pointer);
1380         target_option_val!(function_sections);
1381         target_option_val!(dll_prefix);
1382         target_option_val!(dll_suffix);
1383         target_option_val!(exe_suffix);
1384         target_option_val!(staticlib_prefix);
1385         target_option_val!(staticlib_suffix);
1386         target_option_val!(target_family);
1387         target_option_val!(abi_return_struct_as_int);
1388         target_option_val!(is_like_osx);
1389         target_option_val!(is_like_solaris);
1390         target_option_val!(is_like_windows);
1391         target_option_val!(is_like_msvc);
1392         target_option_val!(is_like_emscripten);
1393         target_option_val!(is_like_android);
1394         target_option_val!(is_like_fuchsia);
1395         target_option_val!(linker_is_gnu);
1396         target_option_val!(allows_weak_linkage);
1397         target_option_val!(has_rpath);
1398         target_option_val!(no_default_libraries);
1399         target_option_val!(position_independent_executables);
1400         target_option_val!(needs_plt);
1401         target_option_val!(relro_level);
1402         target_option_val!(archive_format);
1403         target_option_val!(allow_asm);
1404         target_option_val!(main_needs_argc_argv);
1405         target_option_val!(has_elf_tls);
1406         target_option_val!(obj_is_bitcode);
1407         target_option_val!(min_atomic_width);
1408         target_option_val!(max_atomic_width);
1409         target_option_val!(atomic_cas);
1410         target_option_val!(panic_strategy);
1411         target_option_val!(crt_static_allows_dylibs);
1412         target_option_val!(crt_static_default);
1413         target_option_val!(crt_static_respected);
1414         target_option_val!(stack_probes);
1415         target_option_val!(min_global_align);
1416         target_option_val!(default_codegen_units);
1417         target_option_val!(trap_unreachable);
1418         target_option_val!(requires_lto);
1419         target_option_val!(singlethread);
1420         target_option_val!(no_builtins);
1421         target_option_val!(codegen_backend);
1422         target_option_val!(default_hidden_visibility);
1423         target_option_val!(emit_debug_gdb_scripts);
1424         target_option_val!(requires_uwtable);
1425         target_option_val!(simd_types_indirect);
1426         target_option_val!(limit_rdylib_exports);
1427         target_option_val!(override_export_symbols);
1428         target_option_val!(merge_functions);
1429         target_option_val!(target_mcount);
1430         target_option_val!(llvm_abiname);
1431         target_option_val!(relax_elf_relocations);
1432         target_option_val!(llvm_args);
1433
1434         if default.abi_blacklist != self.options.abi_blacklist {
1435             d.insert(
1436                 "abi-blacklist".to_string(),
1437                 self.options
1438                     .abi_blacklist
1439                     .iter()
1440                     .map(|&name| Abi::name(name).to_json())
1441                     .collect::<Vec<_>>()
1442                     .to_json(),
1443             );
1444         }
1445
1446         Json::Object(d)
1447     }
1448 }
1449
1450 /// Either a target triple string or a path to a JSON file.
1451 #[derive(PartialEq, Clone, Debug, Hash, RustcEncodable, RustcDecodable)]
1452 pub enum TargetTriple {
1453     TargetTriple(String),
1454     TargetPath(PathBuf),
1455 }
1456
1457 impl TargetTriple {
1458     /// Creates a target triple from the passed target triple string.
1459     pub fn from_triple(triple: &str) -> Self {
1460         TargetTriple::TargetTriple(triple.to_string())
1461     }
1462
1463     /// Creates a target triple from the passed target path.
1464     pub fn from_path(path: &Path) -> Result<Self, io::Error> {
1465         let canonicalized_path = path.canonicalize()?;
1466         Ok(TargetTriple::TargetPath(canonicalized_path))
1467     }
1468
1469     /// Returns a string triple for this target.
1470     ///
1471     /// If this target is a path, the file name (without extension) is returned.
1472     pub fn triple(&self) -> &str {
1473         match *self {
1474             TargetTriple::TargetTriple(ref triple) => triple,
1475             TargetTriple::TargetPath(ref path) => path
1476                 .file_stem()
1477                 .expect("target path must not be empty")
1478                 .to_str()
1479                 .expect("target path must be valid unicode"),
1480         }
1481     }
1482
1483     /// Returns an extended string triple for this target.
1484     ///
1485     /// If this target is a path, a hash of the path is appended to the triple returned
1486     /// by `triple()`.
1487     pub fn debug_triple(&self) -> String {
1488         use std::collections::hash_map::DefaultHasher;
1489         use std::hash::{Hash, Hasher};
1490
1491         let triple = self.triple();
1492         if let TargetTriple::TargetPath(ref path) = *self {
1493             let mut hasher = DefaultHasher::new();
1494             path.hash(&mut hasher);
1495             let hash = hasher.finish();
1496             format!("{}-{}", triple, hash)
1497         } else {
1498             triple.to_owned()
1499         }
1500     }
1501 }
1502
1503 impl fmt::Display for TargetTriple {
1504     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1505         write!(f, "{}", self.debug_triple())
1506     }
1507 }