src/librustc_back/target/mod.rs

   1 // Copyright 2014-2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! [Flexible target specification.](https://github.com/rust-lang/rfcs/pull/131)
  12 //!
  13 //! Rust targets a wide variety of usecases, and in the interest of flexibility,
  14 //! allows new target triples to be defined in configuration files. Most users
  15 //! will not need to care about these, but this is invaluable when porting Rust
  16 //! to a new platform, and allows for an unprecedented level of control over how
  17 //! the compiler works.
  18 //!
  19 //! # Using custom targets
  20 //!
  21 //! A target triple, as passed via `rustc --target=TRIPLE`, will first be
  22 //! compared against the list of built-in targets. This is to ease distributing
  23 //! rustc (no need for configuration files) and also to hold these built-in
  24 //! targets as immutable and sacred. If `TRIPLE` is not one of the built-in
  25 //! targets, rustc will check if a file named `TRIPLE` exists. If it does, it
  26 //! will be loaded as the target configuration. If the file does not exist,
  27 //! rustc will search each directory in the environment variable
  28 //! `RUST_TARGET_PATH` for a file named `TRIPLE.json`. The first one found will
  29 //! be loaded. If no file is found in any of those directories, a fatal error
  30 //! will be given.
  31 //!
  32 //! Projects defining their own targets should use
  33 //! `--target=path/to/my-awesome-platform.json` instead of adding to
  34 //! `RUST_TARGET_PATH`.
  35 //!
  36 //! # Defining a new target
  37 //!
  38 //! Targets are defined using [JSON](http://json.org/). The `Target` struct in
  39 //! this module defines the format the JSON file should take, though each
  40 //! underscore in the field names should be replaced with a hyphen (`-`) in the
  41 //! JSON file. Some fields are required in every target specification, such as
  42 //! `llvm-target`, `target-endian`, `target-pointer-width`, `data-layout`,
  43 //! `arch`, and `os`. In general, options passed to rustc with `-C` override
  44 //! the target's settings, though `target-feature` and `link-args` will *add*
  45 //! to the list specified by the target, rather than replace.
  46
  47 use serialize::json::{Json, ToJson};
  48 use std::collections::BTreeMap;
  49 use std::default::Default;
  50 use std::io::prelude::*;
  51 use syntax::abi::{Abi, lookup as lookup_abi};
  52
  53 use {LinkerFlavor, PanicStrategy, RelroLevel};
  54
  55 mod android_base;
  56 mod apple_base;
  57 mod apple_ios_base;
  58 mod arm_base;
  59 mod bitrig_base;
  60 mod dragonfly_base;
  61 mod emscripten_base;
  62 mod freebsd_base;
  63 mod haiku_base;
  64 mod linux_base;
  65 mod linux_musl_base;
  66 mod openbsd_base;
  67 mod netbsd_base;
  68 mod solaris_base;
  69 mod windows_base;
  70 mod windows_msvc_base;
  71 mod thumb_base;
  72 mod l4re_base;
  73 mod fuchsia_base;
  74 mod redox_base;
  75
  76 pub type LinkArgs = BTreeMap<LinkerFlavor, Vec<String>>;
  77 pub type TargetResult = Result<Target, String>;
  78
  79 macro_rules! supported_targets {
  80     ( $(($triple:expr, $module:ident),)+ ) => (
  81         $(mod $module;)*
  82
  83         /// List of supported targets
  84         const TARGETS: &'static [&'static str] = &[$($triple),*];
  85
  86         fn load_specific(target: &str) -> TargetResult {
  87             match target {
  88                 $(
  89                     $triple => {
  90                         let mut t = $module::target()?;
  91                         t.options.is_builtin = true;
  92
  93                         // round-trip through the JSON parser to ensure at
  94                         // run-time that the parser works correctly
  95                         t = Target::from_json(t.to_json())?;
  96                         debug!("Got builtin target: {:?}", t);
  97                         Ok(t)
  98                     },
  99                 )+
 100                 _ => Err(format!("Unable to find target: {}", target))
 101             }
 102         }
 103
 104         pub fn get_targets() -> Box<Iterator<Item=String>> {
 105             Box::new(TARGETS.iter().filter_map(|t| -> Option<String> {
 106                 load_specific(t)
 107                     .and(Ok(t.to_string()))
 108                     .ok()
 109             }))
 110         }
 111
 112         #[cfg(test)]
 113         mod test_json_encode_decode {
 114             use serialize::json::ToJson;
 115             use super::Target;
 116             $(use super::$module;)*
 117
 118             $(
 119                 #[test]
 120                 fn $module() {
 121                     // Grab the TargetResult struct. If we successfully retrieved
 122                     // a Target, then the test JSON encoding/decoding can run for this
 123                     // Target on this testing platform (i.e., checking the iOS targets
 124                     // only on a Mac test platform).
 125                     let _ = $module::target().map(|original| {
 126                         let as_json = original.to_json();
 127                         let parsed = Target::from_json(as_json).unwrap();
 128                         assert_eq!(original, parsed);
 129                     });
 130                 }
 131             )*
 132         }
 133     )
 134 }
 135
 136 supported_targets! {
 137     ("x86_64-unknown-linux-gnu", x86_64_unknown_linux_gnu),
 138     ("i686-unknown-linux-gnu", i686_unknown_linux_gnu),
 139     ("i586-unknown-linux-gnu", i586_unknown_linux_gnu),
 140     ("mips-unknown-linux-gnu", mips_unknown_linux_gnu),
 141     ("mips64-unknown-linux-gnuabi64", mips64_unknown_linux_gnuabi64),
 142     ("mips64el-unknown-linux-gnuabi64", mips64el_unknown_linux_gnuabi64),
 143     ("mipsel-unknown-linux-gnu", mipsel_unknown_linux_gnu),
 144     ("powerpc-unknown-linux-gnu", powerpc_unknown_linux_gnu),
 145     ("powerpc64-unknown-linux-gnu", powerpc64_unknown_linux_gnu),
 146     ("powerpc64le-unknown-linux-gnu", powerpc64le_unknown_linux_gnu),
 147     ("s390x-unknown-linux-gnu", s390x_unknown_linux_gnu),
 148     ("arm-unknown-linux-gnueabi", arm_unknown_linux_gnueabi),
 149     ("arm-unknown-linux-gnueabihf", arm_unknown_linux_gnueabihf),
 150     ("arm-unknown-linux-musleabi", arm_unknown_linux_musleabi),
 151     ("arm-unknown-linux-musleabihf", arm_unknown_linux_musleabihf),
 152     ("armv5te-unknown-linux-gnueabi", armv5te_unknown_linux_gnueabi),
 153     ("armv7-unknown-linux-gnueabihf", armv7_unknown_linux_gnueabihf),
 154     ("armv7-unknown-linux-musleabihf", armv7_unknown_linux_musleabihf),
 155     ("aarch64-unknown-linux-gnu", aarch64_unknown_linux_gnu),
 156     ("x86_64-unknown-linux-musl", x86_64_unknown_linux_musl),
 157     ("i686-unknown-linux-musl", i686_unknown_linux_musl),
 158     ("mips-unknown-linux-musl", mips_unknown_linux_musl),
 159     ("mipsel-unknown-linux-musl", mipsel_unknown_linux_musl),
 160     ("mips-unknown-linux-uclibc", mips_unknown_linux_uclibc),
 161     ("mipsel-unknown-linux-uclibc", mipsel_unknown_linux_uclibc),
 162
 163     ("sparc64-unknown-linux-gnu", sparc64_unknown_linux_gnu),
 164
 165     ("i686-linux-android", i686_linux_android),
 166     ("x86_64-linux-android", x86_64_linux_android),
 167     ("arm-linux-androideabi", arm_linux_androideabi),
 168     ("armv7-linux-androideabi", armv7_linux_androideabi),
 169     ("aarch64-linux-android", aarch64_linux_android),
 170
 171     ("aarch64-unknown-freebsd", aarch64_unknown_freebsd),
 172     ("i686-unknown-freebsd", i686_unknown_freebsd),
 173     ("x86_64-unknown-freebsd", x86_64_unknown_freebsd),
 174
 175     ("i686-unknown-dragonfly", i686_unknown_dragonfly),
 176     ("x86_64-unknown-dragonfly", x86_64_unknown_dragonfly),
 177
 178     ("x86_64-unknown-bitrig", x86_64_unknown_bitrig),
 179
 180     ("i686-unknown-openbsd", i686_unknown_openbsd),
 181     ("x86_64-unknown-openbsd", x86_64_unknown_openbsd),
 182
 183     ("i686-unknown-netbsd", i686_unknown_netbsd),
 184     ("sparc64-unknown-netbsd", sparc64_unknown_netbsd),
 185     ("x86_64-unknown-netbsd", x86_64_unknown_netbsd),
 186     ("x86_64-rumprun-netbsd", x86_64_rumprun_netbsd),
 187
 188     ("i686-unknown-haiku", i686_unknown_haiku),
 189     ("x86_64-unknown-haiku", x86_64_unknown_haiku),
 190
 191     ("x86_64-apple-darwin", x86_64_apple_darwin),
 192     ("i686-apple-darwin", i686_apple_darwin),
 193
 194     ("aarch64-unknown-fuchsia", aarch64_unknown_fuchsia),
 195     ("x86_64-unknown-fuchsia", x86_64_unknown_fuchsia),
 196
 197     ("x86_64-unknown-l4re-uclibc", x86_64_unknown_l4re_uclibc),
 198
 199     ("x86_64-unknown-redox", x86_64_unknown_redox),
 200
 201     ("i386-apple-ios", i386_apple_ios),
 202     ("x86_64-apple-ios", x86_64_apple_ios),
 203     ("aarch64-apple-ios", aarch64_apple_ios),
 204     ("armv7-apple-ios", armv7_apple_ios),
 205     ("armv7s-apple-ios", armv7s_apple_ios),
 206
 207     ("x86_64-sun-solaris", x86_64_sun_solaris),
 208     ("sparcv9-sun-solaris", sparcv9_sun_solaris),
 209
 210     ("x86_64-pc-windows-gnu", x86_64_pc_windows_gnu),
 211     ("i686-pc-windows-gnu", i686_pc_windows_gnu),
 212
 213     ("x86_64-pc-windows-msvc", x86_64_pc_windows_msvc),
 214     ("i686-pc-windows-msvc", i686_pc_windows_msvc),
 215     ("i586-pc-windows-msvc", i586_pc_windows_msvc),
 216
 217     ("le32-unknown-nacl", le32_unknown_nacl),
 218     ("asmjs-unknown-emscripten", asmjs_unknown_emscripten),
 219     ("wasm32-unknown-emscripten", wasm32_unknown_emscripten),
 220     ("wasm32-experimental-emscripten", wasm32_experimental_emscripten),
 221
 222     ("thumbv6m-none-eabi", thumbv6m_none_eabi),
 223     ("thumbv7m-none-eabi", thumbv7m_none_eabi),
 224     ("thumbv7em-none-eabi", thumbv7em_none_eabi),
 225     ("thumbv7em-none-eabihf", thumbv7em_none_eabihf),
 226
 227     ("msp430-none-elf", msp430_none_elf),
 228 }
 229
 230 /// Everything `rustc` knows about how to compile for a specific target.
 231 ///
 232 /// Every field here must be specified, and has no default value.
 233 #[derive(PartialEq, Clone, Debug)]
 234 pub struct Target {
 235     /// Target triple to pass to LLVM.
 236     pub llvm_target: String,
 237     /// String to use as the `target_endian` `cfg` variable.
 238     pub target_endian: String,
 239     /// String to use as the `target_pointer_width` `cfg` variable.
 240     pub target_pointer_width: String,
 241     /// OS name to use for conditional compilation.
 242     pub target_os: String,
 243     /// Environment name to use for conditional compilation.
 244     pub target_env: String,
 245     /// Vendor name to use for conditional compilation.
 246     pub target_vendor: String,
 247     /// Architecture to use for ABI considerations. Valid options: "x86",
 248     /// "x86_64", "arm", "aarch64", "mips", "powerpc", and "powerpc64".
 249     pub arch: String,
 250     /// [Data layout](http://llvm.org/docs/LangRef.html#data-layout) to pass to LLVM.
 251     pub data_layout: String,
 252     /// Linker flavor
 253     pub linker_flavor: LinkerFlavor,
 254     /// Optional settings with defaults.
 255     pub options: TargetOptions,
 256 }
 257
 258 /// Optional aspects of a target specification.
 259 ///
 260 /// This has an implementation of `Default`, see each field for what the default is. In general,
 261 /// these try to take "minimal defaults" that don't assume anything about the runtime they run in.
 262 #[derive(PartialEq, Clone, Debug)]
 263 pub struct TargetOptions {
 264     /// Whether the target is built-in or loaded from a custom target specification.
 265     pub is_builtin: bool,
 266
 267     /// Linker to invoke. Defaults to "cc".
 268     pub linker: String,
 269     /// Archive utility to use when managing archives. Defaults to "ar".
 270     pub ar: String,
 271
 272     /// Linker arguments that are unconditionally passed *before* any
 273     /// user-defined libraries.
 274     pub pre_link_args: LinkArgs,
 275     /// Objects to link before all others, always found within the
 276     /// sysroot folder.
 277     pub pre_link_objects_exe: Vec<String>, // ... when linking an executable
 278     pub pre_link_objects_dll: Vec<String>, // ... when linking a dylib
 279     /// Linker arguments that are unconditionally passed after any
 280     /// user-defined but before post_link_objects.  Standard platform
 281     /// libraries that should be always be linked to, usually go here.
 282     pub late_link_args: LinkArgs,
 283     /// Objects to link after all others, always found within the
 284     /// sysroot folder.
 285     pub post_link_objects: Vec<String>,
 286     /// Linker arguments that are unconditionally passed *after* any
 287     /// user-defined libraries.
 288     pub post_link_args: LinkArgs,
 289
 290     /// Environment variables to be set before invoking the linker.
 291     pub link_env: Vec<(String, String)>,
 292
 293     /// Extra arguments to pass to the external assembler (when used)
 294     pub asm_args: Vec<String>,
 295
 296     /// Default CPU to pass to LLVM. Corresponds to `llc -mcpu=$cpu`. Defaults
 297     /// to "generic".
 298     pub cpu: String,
 299     /// Default target features to pass to LLVM. These features will *always* be
 300     /// passed, and cannot be disabled even via `-C`. Corresponds to `llc
 301     /// -mattr=$features`.
 302     pub features: String,
 303     /// Whether dynamic linking is available on this target. Defaults to false.
 304     pub dynamic_linking: bool,
 305     /// Whether executables are available on this target. iOS, for example, only allows static
 306     /// libraries. Defaults to false.
 307     pub executables: bool,
 308     /// Relocation model to use in object file. Corresponds to `llc
 309     /// -relocation-model=$relocation_model`. Defaults to "pic".
 310     pub relocation_model: String,
 311     /// Code model to use. Corresponds to `llc -code-model=$code_model`. Defaults to "default".
 312     pub code_model: String,
 313     /// Do not emit code that uses the "red zone", if the ABI has one. Defaults to false.
 314     pub disable_redzone: bool,
 315     /// Eliminate frame pointers from stack frames if possible. Defaults to true.
 316     pub eliminate_frame_pointer: bool,
 317     /// Emit each function in its own section. Defaults to true.
 318     pub function_sections: bool,
 319     /// String to prepend to the name of every dynamic library. Defaults to "lib".
 320     pub dll_prefix: String,
 321     /// String to append to the name of every dynamic library. Defaults to ".so".
 322     pub dll_suffix: String,
 323     /// String to append to the name of every executable.
 324     pub exe_suffix: String,
 325     /// String to prepend to the name of every static library. Defaults to "lib".
 326     pub staticlib_prefix: String,
 327     /// String to append to the name of every static library. Defaults to ".a".
 328     pub staticlib_suffix: String,
 329     /// OS family to use for conditional compilation. Valid options: "unix", "windows".
 330     pub target_family: Option<String>,
 331     /// Whether the target toolchain is like OpenBSD's.
 332     /// Only useful for compiling against OpenBSD, for configuring abi when returning a struct.
 333     pub is_like_openbsd: bool,
 334     /// Whether the target toolchain is like macOS's. Only useful for compiling against iOS/macOS,
 335     /// in particular running dsymutil and some other stuff like `-dead_strip`. Defaults to false.
 336     pub is_like_osx: bool,
 337     /// Whether the target toolchain is like Solaris's.
 338     /// Only useful for compiling against Illumos/Solaris,
 339     /// as they have a different set of linker flags. Defaults to false.
 340     pub is_like_solaris: bool,
 341     /// Whether the target toolchain is like Windows'. Only useful for compiling against Windows,
 342     /// only really used for figuring out how to find libraries, since Windows uses its own
 343     /// library naming convention. Defaults to false.
 344     pub is_like_windows: bool,
 345     pub is_like_msvc: bool,
 346     /// Whether the target toolchain is like Android's. Only useful for compiling against Android.
 347     /// Defaults to false.
 348     pub is_like_android: bool,
 349     /// Whether the target toolchain is like Emscripten's. Only useful for compiling with
 350     /// Emscripten toolchain.
 351     /// Defaults to false.
 352     pub is_like_emscripten: bool,
 353     /// Whether the linker support GNU-like arguments such as -O. Defaults to false.
 354     pub linker_is_gnu: bool,
 355     /// The MinGW toolchain has a known issue that prevents it from correctly
 356     /// handling COFF object files with more than 2^15 sections. Since each weak
 357     /// symbol needs its own COMDAT section, weak linkage implies a large
 358     /// number sections that easily exceeds the given limit for larger
 359     /// codebases. Consequently we want a way to disallow weak linkage on some
 360     /// platforms.
 361     pub allows_weak_linkage: bool,
 362     /// Whether the linker support rpaths or not. Defaults to false.
 363     pub has_rpath: bool,
 364     /// Whether to disable linking to the default libraries, typically corresponds
 365     /// to `-nodefaultlibs`. Defaults to true.
 366     pub no_default_libraries: bool,
 367     /// Dynamically linked executables can be compiled as position independent
 368     /// if the default relocation model of position independent code is not
 369     /// changed. This is a requirement to take advantage of ASLR, as otherwise
 370     /// the functions in the executable are not randomized and can be used
 371     /// during an exploit of a vulnerability in any code.
 372     pub position_independent_executables: bool,
 373     /// Either partial, full, or off. Full RELRO makes the dynamic linker
 374     /// resolve all symbols at startup and marks the GOT read-only before
 375     /// starting the program, preventing overwriting the GOT.
 376     pub relro_level: RelroLevel,
 377     /// Format that archives should be emitted in. This affects whether we use
 378     /// LLVM to assemble an archive or fall back to the system linker, and
 379     /// currently only "gnu" is used to fall into LLVM. Unknown strings cause
 380     /// the system linker to be used.
 381     pub archive_format: String,
 382     /// Is asm!() allowed? Defaults to true.
 383     pub allow_asm: bool,
 384     /// Whether the target uses a custom unwind resumption routine.
 385     /// By default LLVM lowers `resume` instructions into calls to `_Unwind_Resume`
 386     /// defined in libgcc.  If this option is enabled, the target must provide
 387     /// `eh_unwind_resume` lang item.
 388     pub custom_unwind_resume: bool,
 389
 390     /// If necessary, a different crate to link exe allocators by default
 391     pub exe_allocation_crate: Option<String>,
 392
 393     /// Flag indicating whether ELF TLS (e.g. #[thread_local]) is available for
 394     /// this target.
 395     pub has_elf_tls: bool,
 396     // This is mainly for easy compatibility with emscripten.
 397     // If we give emcc .o files that are actually .bc files it
 398     // will 'just work'.
 399     pub obj_is_bitcode: bool,
 400
 401     // LLVM can't produce object files for this target. Instead, we'll make LLVM
 402     // emit assembly and then use `gcc` to turn that assembly into an object
 403     // file
 404     pub no_integrated_as: bool,
 405
 406     /// Don't use this field; instead use the `.min_atomic_width()` method.
 407     pub min_atomic_width: Option<u64>,
 408
 409     /// Don't use this field; instead use the `.max_atomic_width()` method.
 410     pub max_atomic_width: Option<u64>,
 411
 412     /// Panic strategy: "unwind" or "abort"
 413     pub panic_strategy: PanicStrategy,
 414
 415     /// A blacklist of ABIs unsupported by the current target. Note that generic
 416     /// ABIs are considered to be supported on all platforms and cannot be blacklisted.
 417     pub abi_blacklist: Vec<Abi>,
 418
 419     /// Whether or not the CRT is statically linked by default.
 420     pub crt_static_default: bool,
 421     /// Whether or not crt-static is respected by the compiler (or is a no-op).
 422     pub crt_static_respected: bool,
 423
 424     /// Whether or not stack probes (__rust_probestack) are enabled
 425     pub stack_probes: bool,
 426 }
 427
 428 impl Default for TargetOptions {
 429     /// Create a set of "sane defaults" for any target. This is still
 430     /// incomplete, and if used for compilation, will certainly not work.
 431     fn default() -> TargetOptions {
 432         TargetOptions {
 433             is_builtin: false,
 434             linker: option_env!("CFG_DEFAULT_LINKER").unwrap_or("cc").to_string(),
 435             ar: option_env!("CFG_DEFAULT_AR").unwrap_or("ar").to_string(),
 436             pre_link_args: LinkArgs::new(),
 437             post_link_args: LinkArgs::new(),
 438             asm_args: Vec::new(),
 439             cpu: "generic".to_string(),
 440             features: "".to_string(),
 441             dynamic_linking: false,
 442             executables: false,
 443             relocation_model: "pic".to_string(),
 444             code_model: "default".to_string(),
 445             disable_redzone: false,
 446             eliminate_frame_pointer: true,
 447             function_sections: true,
 448             dll_prefix: "lib".to_string(),
 449             dll_suffix: ".so".to_string(),
 450             exe_suffix: "".to_string(),
 451             staticlib_prefix: "lib".to_string(),
 452             staticlib_suffix: ".a".to_string(),
 453             target_family: None,
 454             is_like_openbsd: false,
 455             is_like_osx: false,
 456             is_like_solaris: false,
 457             is_like_windows: false,
 458             is_like_android: false,
 459             is_like_emscripten: false,
 460             is_like_msvc: false,
 461             linker_is_gnu: false,
 462             allows_weak_linkage: true,
 463             has_rpath: false,
 464             no_default_libraries: true,
 465             position_independent_executables: false,
 466             relro_level: RelroLevel::Off,
 467             pre_link_objects_exe: Vec::new(),
 468             pre_link_objects_dll: Vec::new(),
 469             post_link_objects: Vec::new(),
 470             late_link_args: LinkArgs::new(),
 471             link_env: Vec::new(),
 472             archive_format: "gnu".to_string(),
 473             custom_unwind_resume: false,
 474             exe_allocation_crate: None,
 475             allow_asm: true,
 476             has_elf_tls: false,
 477             obj_is_bitcode: false,
 478             no_integrated_as: false,
 479             min_atomic_width: None,
 480             max_atomic_width: None,
 481             panic_strategy: PanicStrategy::Unwind,
 482             abi_blacklist: vec![],
 483             crt_static_default: false,
 484             crt_static_respected: false,
 485             stack_probes: false,
 486         }
 487     }
 488 }
 489
 490 impl Target {
 491     /// Given a function ABI, turn "System" into the correct ABI for this target.
 492     pub fn adjust_abi(&self, abi: Abi) -> Abi {
 493         match abi {
 494             Abi::System => {
 495                 if self.options.is_like_windows && self.arch == "x86" {
 496                     Abi::Stdcall
 497                 } else {
 498                     Abi::C
 499                 }
 500             },
 501             abi => abi
 502         }
 503     }
 504
 505     /// Minimum integer size in bits that this target can perform atomic
 506     /// operations on.
 507     pub fn min_atomic_width(&self) -> u64 {
 508         self.options.min_atomic_width.unwrap_or(8)
 509     }
 510
 511     /// Maximum integer size in bits that this target can perform atomic
 512     /// operations on.
 513     pub fn max_atomic_width(&self) -> u64 {
 514         self.options.max_atomic_width.unwrap_or(self.target_pointer_width.parse().unwrap())
 515     }
 516
 517     pub fn is_abi_supported(&self, abi: Abi) -> bool {
 518         abi.generic() || !self.options.abi_blacklist.contains(&abi)
 519     }
 520
 521     /// Load a target descriptor from a JSON object.
 522     pub fn from_json(obj: Json) -> TargetResult {
 523         // While ugly, this code must remain this way to retain
 524         // compatibility with existing JSON fields and the internal
 525         // expected naming of the Target and TargetOptions structs.
 526         // To ensure compatibility is retained, the built-in targets
 527         // are round-tripped through this code to catch cases where
 528         // the JSON parser is not updated to match the structs.
 529
 530         let get_req_field = |name: &str| {
 531             match obj.find(name)
 532                      .map(|s| s.as_string())
 533                      .and_then(|os| os.map(|s| s.to_string())) {
 534                 Some(val) => Ok(val),
 535                 None => {
 536                     return Err(format!("Field {} in target specification is required", name))
 537                 }
 538             }
 539         };
 540
 541         let get_opt_field = |name: &str, default: &str| {
 542             obj.find(name).and_then(|s| s.as_string())
 543                .map(|s| s.to_string())
 544                .unwrap_or(default.to_string())
 545         };
 546
 547         let mut base = Target {
 548             llvm_target: get_req_field("llvm-target")?,
 549             target_endian: get_req_field("target-endian")?,
 550             target_pointer_width: get_req_field("target-pointer-width")?,
 551             data_layout: get_req_field("data-layout")?,
 552             arch: get_req_field("arch")?,
 553             target_os: get_req_field("os")?,
 554             target_env: get_opt_field("env", ""),
 555             target_vendor: get_opt_field("vendor", "unknown"),
 556             linker_flavor: LinkerFlavor::from_str(&*get_req_field("linker-flavor")?)
 557                 .ok_or_else(|| {
 558                     format!("linker flavor must be {}", LinkerFlavor::one_of())
 559                 })?,
 560             options: Default::default(),
 561         };
 562
 563         macro_rules! key {
 564             ($key_name:ident) => ( {
 565                 let name = (stringify!($key_name)).replace("_", "-");
 566                 obj.find(&name[..]).map(|o| o.as_string()
 567                                     .map(|s| base.options.$key_name = s.to_string()));
 568             } );
 569             ($key_name:ident, bool) => ( {
 570                 let name = (stringify!($key_name)).replace("_", "-");
 571                 obj.find(&name[..])
 572                     .map(|o| o.as_boolean()
 573                          .map(|s| base.options.$key_name = s));
 574             } );
 575             ($key_name:ident, Option<u64>) => ( {
 576                 let name = (stringify!($key_name)).replace("_", "-");
 577                 obj.find(&name[..])
 578                     .map(|o| o.as_u64()
 579                          .map(|s| base.options.$key_name = Some(s)));
 580             } );
 581             ($key_name:ident, PanicStrategy) => ( {
 582                 let name = (stringify!($key_name)).replace("_", "-");
 583                 obj.find(&name[..]).and_then(|o| o.as_string().and_then(|s| {
 584                     match s {
 585                         "unwind" => base.options.$key_name = PanicStrategy::Unwind,
 586                         "abort" => base.options.$key_name = PanicStrategy::Abort,
 587                         _ => return Some(Err(format!("'{}' is not a valid value for \
 588                                                       panic-strategy. Use 'unwind' or 'abort'.",
 589                                                      s))),
 590                 }
 591                 Some(Ok(()))
 592             })).unwrap_or(Ok(()))
 593             } );
 594             ($key_name:ident, RelroLevel) => ( {
 595                 let name = (stringify!($key_name)).replace("_", "-");
 596                 obj.find(&name[..]).and_then(|o| o.as_string().and_then(|s| {
 597                     match s.parse::<RelroLevel>() {
 598                         Ok(level) => base.options.$key_name = level,
 599                         _ => return Some(Err(format!("'{}' is not a valid value for \
 600                                                       relro-level. Use 'full', 'partial, or 'off'.",
 601                                                       s))),
 602                     }
 603                     Some(Ok(()))
 604                 })).unwrap_or(Ok(()))
 605             } );
 606             ($key_name:ident, list) => ( {
 607                 let name = (stringify!($key_name)).replace("_", "-");
 608                 obj.find(&name[..]).map(|o| o.as_array()
 609                     .map(|v| base.options.$key_name = v.iter()
 610                         .map(|a| a.as_string().unwrap().to_string()).collect()
 611                         )
 612                     );
 613             } );
 614             ($key_name:ident, optional) => ( {
 615                 let name = (stringify!($key_name)).replace("_", "-");
 616                 if let Some(o) = obj.find(&name[..]) {
 617                     base.options.$key_name = o
 618                         .as_string()
 619                         .map(|s| s.to_string() );
 620                 }
 621             } );
 622             ($key_name:ident, LinkerFlavor) => ( {
 623                 let name = (stringify!($key_name)).replace("_", "-");
 624                 obj.find(&name[..]).and_then(|o| o.as_string().map(|s| {
 625                     LinkerFlavor::from_str(&s).ok_or_else(|| {
 626                         Err(format!("'{}' is not a valid value for linker-flavor. \
 627                                      Use 'em', 'gcc', 'ld' or 'msvc.", s))
 628                     })
 629                 })).unwrap_or(Ok(()))
 630             } );
 631             ($key_name:ident, link_args) => ( {
 632                 let name = (stringify!($key_name)).replace("_", "-");
 633                 if let Some(obj) = obj.find(&name[..]).and_then(|o| o.as_object()) {
 634                     let mut args = LinkArgs::new();
 635                     for (k, v) in obj {
 636                         let k = LinkerFlavor::from_str(&k).ok_or_else(|| {
 637                             format!("{}: '{}' is not a valid value for linker-flavor. \
 638                                      Use 'em', 'gcc', 'ld' or 'msvc'", name, k)
 639                         })?;
 640
 641                         let v = v.as_array().map(|a| {
 642                             a
 643                                 .iter()
 644                                 .filter_map(|o| o.as_string())
 645                                 .map(|s| s.to_owned())
 646                                 .collect::<Vec<_>>()
 647                         }).unwrap_or(vec![]);
 648
 649                         args.insert(k, v);
 650                     }
 651                     base.options.$key_name = args;
 652                 }
 653             } );
 654             ($key_name:ident, env) => ( {
 655                 let name = (stringify!($key_name)).replace("_", "-");
 656                 if let Some(a) = obj.find(&name[..]).and_then(|o| o.as_array()) {
 657                     for o in a {
 658                         if let Some(s) = o.as_string() {
 659                             let p = s.split('=').collect::<Vec<_>>();
 660                             if p.len() == 2 {
 661                                 let k = p[0].to_string();
 662                                 let v = p[1].to_string();
 663                                 base.options.$key_name.push((k, v));
 664                             }
 665                         }
 666                     }
 667                 }
 668             } );
 669         }
 670
 671         key!(is_builtin, bool);
 672         key!(linker);
 673         key!(ar);
 674         key!(pre_link_args, link_args);
 675         key!(pre_link_objects_exe, list);
 676         key!(pre_link_objects_dll, list);
 677         key!(late_link_args, link_args);
 678         key!(post_link_objects, list);
 679         key!(post_link_args, link_args);
 680         key!(link_env, env);
 681         key!(asm_args, list);
 682         key!(cpu);
 683         key!(features);
 684         key!(dynamic_linking, bool);
 685         key!(executables, bool);
 686         key!(relocation_model);
 687         key!(code_model);
 688         key!(disable_redzone, bool);
 689         key!(eliminate_frame_pointer, bool);
 690         key!(function_sections, bool);
 691         key!(dll_prefix);
 692         key!(dll_suffix);
 693         key!(exe_suffix);
 694         key!(staticlib_prefix);
 695         key!(staticlib_suffix);
 696         key!(target_family, optional);
 697         key!(is_like_openbsd, bool);
 698         key!(is_like_osx, bool);
 699         key!(is_like_solaris, bool);
 700         key!(is_like_windows, bool);
 701         key!(is_like_msvc, bool);
 702         key!(is_like_emscripten, bool);
 703         key!(is_like_android, bool);
 704         key!(linker_is_gnu, bool);
 705         key!(allows_weak_linkage, bool);
 706         key!(has_rpath, bool);
 707         key!(no_default_libraries, bool);
 708         key!(position_independent_executables, bool);
 709         try!(key!(relro_level, RelroLevel));
 710         key!(archive_format);
 711         key!(allow_asm, bool);
 712         key!(custom_unwind_resume, bool);
 713         key!(exe_allocation_crate, optional);
 714         key!(has_elf_tls, bool);
 715         key!(obj_is_bitcode, bool);
 716         key!(no_integrated_as, bool);
 717         key!(max_atomic_width, Option<u64>);
 718         key!(min_atomic_width, Option<u64>);
 719         try!(key!(panic_strategy, PanicStrategy));
 720         key!(crt_static_default, bool);
 721         key!(crt_static_respected, bool);
 722         key!(stack_probes, bool);
 723
 724         if let Some(array) = obj.find("abi-blacklist").and_then(Json::as_array) {
 725             for name in array.iter().filter_map(|abi| abi.as_string()) {
 726                 match lookup_abi(name) {
 727                     Some(abi) => {
 728                         if abi.generic() {
 729                             return Err(format!("The ABI \"{}\" is considered to be supported on \
 730                                                 all targets and cannot be blacklisted", abi))
 731                         }
 732
 733                         base.options.abi_blacklist.push(abi)
 734                     }
 735                     None => return Err(format!("Unknown ABI \"{}\" in target specification", name))
 736                 }
 737             }
 738         }
 739
 740         Ok(base)
 741     }
 742
 743     /// Search RUST_TARGET_PATH for a JSON file specifying the given target
 744     /// triple. Note that it could also just be a bare filename already, so also
 745     /// check for that. If one of the hardcoded targets we know about, just
 746     /// return it directly.
 747     ///
 748     /// The error string could come from any of the APIs called, including
 749     /// filesystem access and JSON decoding.
 750     pub fn search(target: &str) -> Result<Target, String> {
 751         use std::env;
 752         use std::ffi::OsString;
 753         use std::fs::File;
 754         use std::path::{Path, PathBuf};
 755         use serialize::json;
 756
 757         fn load_file(path: &Path) -> Result<Target, String> {
 758             let mut f = File::open(path).map_err(|e| e.to_string())?;
 759             let mut contents = Vec::new();
 760             f.read_to_end(&mut contents).map_err(|e| e.to_string())?;
 761             let obj = json::from_reader(&mut &contents[..])
 762                            .map_err(|e| e.to_string())?;
 763             Target::from_json(obj)
 764         }
 765
 766         if let Ok(t) = load_specific(target) {
 767             return Ok(t)
 768         }
 769
 770         let path = Path::new(target);
 771
 772         if path.is_file() {
 773             return load_file(&path);
 774         }
 775
 776         let path = {
 777             let mut target = target.to_string();
 778             target.push_str(".json");
 779             PathBuf::from(target)
 780         };
 781
 782         let target_path = env::var_os("RUST_TARGET_PATH")
 783                               .unwrap_or(OsString::new());
 784
 785         // FIXME 16351: add a sane default search path?
 786
 787         for dir in env::split_paths(&target_path) {
 788             let p =  dir.join(&path);
 789             if p.is_file() {
 790                 return load_file(&p);
 791             }
 792         }
 793
 794         Err(format!("Could not find specification for target {:?}", target))
 795     }
 796 }
 797
 798 impl ToJson for Target {
 799     fn to_json(&self) -> Json {
 800         let mut d = BTreeMap::new();
 801         let default: TargetOptions = Default::default();
 802
 803         macro_rules! target_val {
 804             ($attr:ident) => ( {
 805                 let name = (stringify!($attr)).replace("_", "-");
 806                 d.insert(name.to_string(), self.$attr.to_json());
 807             } );
 808             ($attr:ident, $key_name:expr) => ( {
 809                 let name = $key_name;
 810                 d.insert(name.to_string(), self.$attr.to_json());
 811             } );
 812         }
 813
 814         macro_rules! target_option_val {
 815             ($attr:ident) => ( {
 816                 let name = (stringify!($attr)).replace("_", "-");
 817                 if default.$attr != self.options.$attr {
 818                     d.insert(name.to_string(), self.options.$attr.to_json());
 819                 }
 820             } );
 821             ($attr:ident, $key_name:expr) => ( {
 822                 let name = $key_name;
 823                 if default.$attr != self.options.$attr {
 824                     d.insert(name.to_string(), self.options.$attr.to_json());
 825                 }
 826             } );
 827             (link_args - $attr:ident) => ( {
 828                 let name = (stringify!($attr)).replace("_", "-");
 829                 if default.$attr != self.options.$attr {
 830                     let obj = self.options.$attr
 831                         .iter()
 832                         .map(|(k, v)| (k.desc().to_owned(), v.clone()))
 833                         .collect::<BTreeMap<_, _>>();
 834                     d.insert(name.to_string(), obj.to_json());
 835                 }
 836             } );
 837             (env - $attr:ident) => ( {
 838                 let name = (stringify!($attr)).replace("_", "-");
 839                 if default.$attr != self.options.$attr {
 840                     let obj = self.options.$attr
 841                         .iter()
 842                         .map(|&(ref k, ref v)| k.clone() + "=" + &v)
 843                         .collect::<Vec<_>>();
 844                     d.insert(name.to_string(), obj.to_json());
 845                 }
 846             } );
 847
 848         }
 849
 850         target_val!(llvm_target);
 851         target_val!(target_endian);
 852         target_val!(target_pointer_width);
 853         target_val!(arch);
 854         target_val!(target_os, "os");
 855         target_val!(target_env, "env");
 856         target_val!(target_vendor, "vendor");
 857         target_val!(data_layout);
 858         target_val!(linker_flavor);
 859
 860         target_option_val!(is_builtin);
 861         target_option_val!(linker);
 862         target_option_val!(ar);
 863         target_option_val!(link_args - pre_link_args);
 864         target_option_val!(pre_link_objects_exe);
 865         target_option_val!(pre_link_objects_dll);
 866         target_option_val!(link_args - late_link_args);
 867         target_option_val!(post_link_objects);
 868         target_option_val!(link_args - post_link_args);
 869         target_option_val!(env - link_env);
 870         target_option_val!(asm_args);
 871         target_option_val!(cpu);
 872         target_option_val!(features);
 873         target_option_val!(dynamic_linking);
 874         target_option_val!(executables);
 875         target_option_val!(relocation_model);
 876         target_option_val!(code_model);
 877         target_option_val!(disable_redzone);
 878         target_option_val!(eliminate_frame_pointer);
 879         target_option_val!(function_sections);
 880         target_option_val!(dll_prefix);
 881         target_option_val!(dll_suffix);
 882         target_option_val!(exe_suffix);
 883         target_option_val!(staticlib_prefix);
 884         target_option_val!(staticlib_suffix);
 885         target_option_val!(target_family);
 886         target_option_val!(is_like_openbsd);
 887         target_option_val!(is_like_osx);
 888         target_option_val!(is_like_solaris);
 889         target_option_val!(is_like_windows);
 890         target_option_val!(is_like_msvc);
 891         target_option_val!(is_like_emscripten);
 892         target_option_val!(is_like_android);
 893         target_option_val!(linker_is_gnu);
 894         target_option_val!(allows_weak_linkage);
 895         target_option_val!(has_rpath);
 896         target_option_val!(no_default_libraries);
 897         target_option_val!(position_independent_executables);
 898         target_option_val!(relro_level);
 899         target_option_val!(archive_format);
 900         target_option_val!(allow_asm);
 901         target_option_val!(custom_unwind_resume);
 902         target_option_val!(exe_allocation_crate);
 903         target_option_val!(has_elf_tls);
 904         target_option_val!(obj_is_bitcode);
 905         target_option_val!(no_integrated_as);
 906         target_option_val!(min_atomic_width);
 907         target_option_val!(max_atomic_width);
 908         target_option_val!(panic_strategy);
 909         target_option_val!(crt_static_default);
 910         target_option_val!(crt_static_respected);
 911         target_option_val!(stack_probes);
 912
 913         if default.abi_blacklist != self.options.abi_blacklist {
 914             d.insert("abi-blacklist".to_string(), self.options.abi_blacklist.iter()
 915                 .map(Abi::name).map(|name| name.to_json())
 916                 .collect::<Vec<_>>().to_json());
 917         }
 918
 919         Json::Object(d)
 920     }
 921 }
 922
 923 fn maybe_jemalloc() -> Option<String> {
 924     if cfg!(feature = "jemalloc") {
 925         Some("alloc_jemalloc".to_string())
 926     } else {
 927         None
 928     }
 929 }