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.
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.
11 //! [Flexible target specification.](https://github.com/rust-lang/rfcs/pull/131)
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.
19 //! # Using custom targets
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
32 //! Projects defining their own targets should use
33 //! `--target=path/to/my-awesome-platform.json` instead of adding to
34 //! `RUST_TARGET_PATH`.
36 //! # Defining a new target
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.
47 use serialize::json::{Json, ToJson};
48 use std::collections::BTreeMap;
49 use std::default::Default;
50 use syntax::abi::{Abi, lookup as lookup_abi};
52 use {LinkerFlavor, PanicStrategy, RelroLevel};
70 mod windows_msvc_base;
76 pub type LinkArgs = BTreeMap<LinkerFlavor, Vec<String>>;
77 pub type TargetResult = Result<Target, String>;
79 macro_rules! supported_targets {
80 ( $(($triple:expr, $module:ident),)+ ) => (
83 /// List of supported targets
84 const TARGETS: &'static [&'static str] = &[$($triple),*];
86 fn load_specific(target: &str) -> TargetResult {
90 let mut t = $module::target()?;
91 t.options.is_builtin = true;
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);
100 _ => Err(format!("Unable to find target: {}", target))
104 pub fn get_targets() -> Box<Iterator<Item=String>> {
105 Box::new(TARGETS.iter().filter_map(|t| -> Option<String> {
107 .and(Ok(t.to_string()))
113 mod test_json_encode_decode {
114 use serialize::json::ToJson;
116 $(use super::$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);
137 ("x86_64-unknown-linux-gnu", x86_64_unknown_linux_gnu),
138 ("x86_64-unknown-linux-gnux32", x86_64_unknown_linux_gnux32),
139 ("i686-unknown-linux-gnu", i686_unknown_linux_gnu),
140 ("i586-unknown-linux-gnu", i586_unknown_linux_gnu),
141 ("mips-unknown-linux-gnu", mips_unknown_linux_gnu),
142 ("mips64-unknown-linux-gnuabi64", mips64_unknown_linux_gnuabi64),
143 ("mips64el-unknown-linux-gnuabi64", mips64el_unknown_linux_gnuabi64),
144 ("mipsel-unknown-linux-gnu", mipsel_unknown_linux_gnu),
145 ("powerpc-unknown-linux-gnu", powerpc_unknown_linux_gnu),
146 ("powerpc-unknown-linux-gnuspe", powerpc_unknown_linux_gnuspe),
147 ("powerpc64-unknown-linux-gnu", powerpc64_unknown_linux_gnu),
148 ("powerpc64le-unknown-linux-gnu", powerpc64le_unknown_linux_gnu),
149 ("s390x-unknown-linux-gnu", s390x_unknown_linux_gnu),
150 ("sparc-unknown-linux-gnu", sparc_unknown_linux_gnu),
151 ("sparc64-unknown-linux-gnu", sparc64_unknown_linux_gnu),
152 ("arm-unknown-linux-gnueabi", arm_unknown_linux_gnueabi),
153 ("arm-unknown-linux-gnueabihf", arm_unknown_linux_gnueabihf),
154 ("arm-unknown-linux-musleabi", arm_unknown_linux_musleabi),
155 ("arm-unknown-linux-musleabihf", arm_unknown_linux_musleabihf),
156 ("armv4t-unknown-linux-gnueabi", armv4t_unknown_linux_gnueabi),
157 ("armv5te-unknown-linux-gnueabi", armv5te_unknown_linux_gnueabi),
158 ("armv7-unknown-linux-gnueabihf", armv7_unknown_linux_gnueabihf),
159 ("armv7-unknown-linux-musleabihf", armv7_unknown_linux_musleabihf),
160 ("aarch64-unknown-linux-gnu", aarch64_unknown_linux_gnu),
162 ("aarch64-unknown-linux-musl", aarch64_unknown_linux_musl),
163 ("x86_64-unknown-linux-musl", x86_64_unknown_linux_musl),
164 ("i686-unknown-linux-musl", i686_unknown_linux_musl),
165 ("i586-unknown-linux-musl", i586_unknown_linux_musl),
166 ("mips-unknown-linux-musl", mips_unknown_linux_musl),
167 ("mipsel-unknown-linux-musl", mipsel_unknown_linux_musl),
169 ("mips-unknown-linux-uclibc", mips_unknown_linux_uclibc),
170 ("mipsel-unknown-linux-uclibc", mipsel_unknown_linux_uclibc),
172 ("i686-linux-android", i686_linux_android),
173 ("x86_64-linux-android", x86_64_linux_android),
174 ("arm-linux-androideabi", arm_linux_androideabi),
175 ("armv7-linux-androideabi", armv7_linux_androideabi),
176 ("aarch64-linux-android", aarch64_linux_android),
178 ("aarch64-unknown-freebsd", aarch64_unknown_freebsd),
179 ("i686-unknown-freebsd", i686_unknown_freebsd),
180 ("x86_64-unknown-freebsd", x86_64_unknown_freebsd),
182 ("i686-unknown-dragonfly", i686_unknown_dragonfly),
183 ("x86_64-unknown-dragonfly", x86_64_unknown_dragonfly),
185 ("x86_64-unknown-bitrig", x86_64_unknown_bitrig),
187 ("i686-unknown-openbsd", i686_unknown_openbsd),
188 ("x86_64-unknown-openbsd", x86_64_unknown_openbsd),
190 ("i686-unknown-netbsd", i686_unknown_netbsd),
191 ("powerpc-unknown-netbsd", powerpc_unknown_netbsd),
192 ("sparc64-unknown-netbsd", sparc64_unknown_netbsd),
193 ("x86_64-unknown-netbsd", x86_64_unknown_netbsd),
194 ("x86_64-rumprun-netbsd", x86_64_rumprun_netbsd),
196 ("i686-unknown-haiku", i686_unknown_haiku),
197 ("x86_64-unknown-haiku", x86_64_unknown_haiku),
199 ("x86_64-apple-darwin", x86_64_apple_darwin),
200 ("i686-apple-darwin", i686_apple_darwin),
202 ("aarch64-unknown-fuchsia", aarch64_unknown_fuchsia),
203 ("x86_64-unknown-fuchsia", x86_64_unknown_fuchsia),
205 ("x86_64-unknown-l4re-uclibc", x86_64_unknown_l4re_uclibc),
207 ("x86_64-unknown-redox", x86_64_unknown_redox),
209 ("i386-apple-ios", i386_apple_ios),
210 ("x86_64-apple-ios", x86_64_apple_ios),
211 ("aarch64-apple-ios", aarch64_apple_ios),
212 ("armv7-apple-ios", armv7_apple_ios),
213 ("armv7s-apple-ios", armv7s_apple_ios),
215 ("x86_64-sun-solaris", x86_64_sun_solaris),
216 ("sparcv9-sun-solaris", sparcv9_sun_solaris),
218 ("x86_64-pc-windows-gnu", x86_64_pc_windows_gnu),
219 ("i686-pc-windows-gnu", i686_pc_windows_gnu),
221 ("x86_64-pc-windows-msvc", x86_64_pc_windows_msvc),
222 ("i686-pc-windows-msvc", i686_pc_windows_msvc),
223 ("i586-pc-windows-msvc", i586_pc_windows_msvc),
225 ("asmjs-unknown-emscripten", asmjs_unknown_emscripten),
226 ("wasm32-unknown-emscripten", wasm32_unknown_emscripten),
227 ("wasm32-unknown-unknown", wasm32_unknown_unknown),
228 ("wasm32-experimental-emscripten", wasm32_experimental_emscripten),
230 ("thumbv6m-none-eabi", thumbv6m_none_eabi),
231 ("thumbv7m-none-eabi", thumbv7m_none_eabi),
232 ("thumbv7em-none-eabi", thumbv7em_none_eabi),
233 ("thumbv7em-none-eabihf", thumbv7em_none_eabihf),
235 ("msp430-none-elf", msp430_none_elf),
237 ("aarch64-unknown-cloudabi", aarch64_unknown_cloudabi),
238 ("armv7-unknown-cloudabi-eabihf", armv7_unknown_cloudabi_eabihf),
239 ("i686-unknown-cloudabi", i686_unknown_cloudabi),
240 ("x86_64-unknown-cloudabi", x86_64_unknown_cloudabi),
243 /// Everything `rustc` knows about how to compile for a specific target.
245 /// Every field here must be specified, and has no default value.
246 #[derive(PartialEq, Clone, Debug)]
248 /// Target triple to pass to LLVM.
249 pub llvm_target: String,
250 /// String to use as the `target_endian` `cfg` variable.
251 pub target_endian: String,
252 /// String to use as the `target_pointer_width` `cfg` variable.
253 pub target_pointer_width: String,
254 /// Width of c_int type
255 pub target_c_int_width: String,
256 /// OS name to use for conditional compilation.
257 pub target_os: String,
258 /// Environment name to use for conditional compilation.
259 pub target_env: String,
260 /// Vendor name to use for conditional compilation.
261 pub target_vendor: String,
262 /// Architecture to use for ABI considerations. Valid options: "x86",
263 /// "x86_64", "arm", "aarch64", "mips", "powerpc", and "powerpc64".
265 /// [Data layout](http://llvm.org/docs/LangRef.html#data-layout) to pass to LLVM.
266 pub data_layout: String,
268 pub linker_flavor: LinkerFlavor,
269 /// Optional settings with defaults.
270 pub options: TargetOptions,
273 /// Optional aspects of a target specification.
275 /// This has an implementation of `Default`, see each field for what the default is. In general,
276 /// these try to take "minimal defaults" that don't assume anything about the runtime they run in.
277 #[derive(PartialEq, Clone, Debug)]
278 pub struct TargetOptions {
279 /// Whether the target is built-in or loaded from a custom target specification.
280 pub is_builtin: bool,
282 /// Linker to invoke. Defaults to "cc".
285 /// Linker arguments that are unconditionally passed *before* any
286 /// user-defined libraries.
287 pub pre_link_args: LinkArgs,
288 /// Objects to link before all others, always found within the
290 pub pre_link_objects_exe: Vec<String>, // ... when linking an executable
291 pub pre_link_objects_dll: Vec<String>, // ... when linking a dylib
292 /// Linker arguments that are unconditionally passed after any
293 /// user-defined but before post_link_objects. Standard platform
294 /// libraries that should be always be linked to, usually go here.
295 pub late_link_args: LinkArgs,
296 /// Objects to link after all others, always found within the
298 pub post_link_objects: Vec<String>,
299 /// Linker arguments that are unconditionally passed *after* any
300 /// user-defined libraries.
301 pub post_link_args: LinkArgs,
303 /// Environment variables to be set before invoking the linker.
304 pub link_env: Vec<(String, String)>,
306 /// Extra arguments to pass to the external assembler (when used)
307 pub asm_args: Vec<String>,
309 /// Default CPU to pass to LLVM. Corresponds to `llc -mcpu=$cpu`. Defaults
312 /// Default target features to pass to LLVM. These features will *always* be
313 /// passed, and cannot be disabled even via `-C`. Corresponds to `llc
314 /// -mattr=$features`.
315 pub features: String,
316 /// Whether dynamic linking is available on this target. Defaults to false.
317 pub dynamic_linking: bool,
318 /// If dynamic linking is available, whether only cdylibs are supported.
319 pub only_cdylib: bool,
320 /// Whether executables are available on this target. iOS, for example, only allows static
321 /// libraries. Defaults to false.
322 pub executables: bool,
323 /// Relocation model to use in object file. Corresponds to `llc
324 /// -relocation-model=$relocation_model`. Defaults to "pic".
325 pub relocation_model: String,
326 /// Code model to use. Corresponds to `llc -code-model=$code_model`.
327 pub code_model: Option<String>,
328 /// TLS model to use. Options are "global-dynamic" (default), "local-dynamic", "initial-exec"
329 /// and "local-exec". This is similar to the -ftls-model option in GCC/Clang.
330 pub tls_model: String,
331 /// Do not emit code that uses the "red zone", if the ABI has one. Defaults to false.
332 pub disable_redzone: bool,
333 /// Eliminate frame pointers from stack frames if possible. Defaults to true.
334 pub eliminate_frame_pointer: bool,
335 /// Emit each function in its own section. Defaults to true.
336 pub function_sections: bool,
337 /// String to prepend to the name of every dynamic library. Defaults to "lib".
338 pub dll_prefix: String,
339 /// String to append to the name of every dynamic library. Defaults to ".so".
340 pub dll_suffix: String,
341 /// String to append to the name of every executable.
342 pub exe_suffix: String,
343 /// String to prepend to the name of every static library. Defaults to "lib".
344 pub staticlib_prefix: String,
345 /// String to append to the name of every static library. Defaults to ".a".
346 pub staticlib_suffix: String,
347 /// OS family to use for conditional compilation. Valid options: "unix", "windows".
348 pub target_family: Option<String>,
349 /// Whether the target toolchain is like OpenBSD's.
350 /// Only useful for compiling against OpenBSD, for configuring abi when returning a struct.
351 pub is_like_openbsd: bool,
352 /// Whether the target toolchain is like macOS's. Only useful for compiling against iOS/macOS,
353 /// in particular running dsymutil and some other stuff like `-dead_strip`. Defaults to false.
354 pub is_like_osx: bool,
355 /// Whether the target toolchain is like Solaris's.
356 /// Only useful for compiling against Illumos/Solaris,
357 /// as they have a different set of linker flags. Defaults to false.
358 pub is_like_solaris: bool,
359 /// Whether the target toolchain is like Windows'. Only useful for compiling against Windows,
360 /// only really used for figuring out how to find libraries, since Windows uses its own
361 /// library naming convention. Defaults to false.
362 pub is_like_windows: bool,
363 pub is_like_msvc: bool,
364 /// Whether the target toolchain is like Android's. Only useful for compiling against Android.
365 /// Defaults to false.
366 pub is_like_android: bool,
367 /// Whether the target toolchain is like Emscripten's. Only useful for compiling with
368 /// Emscripten toolchain.
369 /// Defaults to false.
370 pub is_like_emscripten: bool,
371 /// Whether the linker support GNU-like arguments such as -O. Defaults to false.
372 pub linker_is_gnu: bool,
373 /// The MinGW toolchain has a known issue that prevents it from correctly
374 /// handling COFF object files with more than 2<sup>15</sup> sections. Since each weak
375 /// symbol needs its own COMDAT section, weak linkage implies a large
376 /// number sections that easily exceeds the given limit for larger
377 /// codebases. Consequently we want a way to disallow weak linkage on some
379 pub allows_weak_linkage: bool,
380 /// Whether the linker support rpaths or not. Defaults to false.
382 /// Whether to disable linking to the default libraries, typically corresponds
383 /// to `-nodefaultlibs`. Defaults to true.
384 pub no_default_libraries: bool,
385 /// Dynamically linked executables can be compiled as position independent
386 /// if the default relocation model of position independent code is not
387 /// changed. This is a requirement to take advantage of ASLR, as otherwise
388 /// the functions in the executable are not randomized and can be used
389 /// during an exploit of a vulnerability in any code.
390 pub position_independent_executables: bool,
391 /// Either partial, full, or off. Full RELRO makes the dynamic linker
392 /// resolve all symbols at startup and marks the GOT read-only before
393 /// starting the program, preventing overwriting the GOT.
394 pub relro_level: RelroLevel,
395 /// Format that archives should be emitted in. This affects whether we use
396 /// LLVM to assemble an archive or fall back to the system linker, and
397 /// currently only "gnu" is used to fall into LLVM. Unknown strings cause
398 /// the system linker to be used.
399 pub archive_format: String,
400 /// Is asm!() allowed? Defaults to true.
402 /// Whether the target uses a custom unwind resumption routine.
403 /// By default LLVM lowers `resume` instructions into calls to `_Unwind_Resume`
404 /// defined in libgcc. If this option is enabled, the target must provide
405 /// `eh_unwind_resume` lang item.
406 pub custom_unwind_resume: bool,
408 /// If necessary, a different crate to link exe allocators by default
409 pub exe_allocation_crate: Option<String>,
411 /// Flag indicating whether ELF TLS (e.g. #[thread_local]) is available for
413 pub has_elf_tls: bool,
414 // This is mainly for easy compatibility with emscripten.
415 // If we give emcc .o files that are actually .bc files it
417 pub obj_is_bitcode: bool,
419 // LLVM can't produce object files for this target. Instead, we'll make LLVM
420 // emit assembly and then use `gcc` to turn that assembly into an object
422 pub no_integrated_as: bool,
424 /// Don't use this field; instead use the `.min_atomic_width()` method.
425 pub min_atomic_width: Option<u64>,
427 /// Don't use this field; instead use the `.max_atomic_width()` method.
428 pub max_atomic_width: Option<u64>,
430 /// Panic strategy: "unwind" or "abort"
431 pub panic_strategy: PanicStrategy,
433 /// A blacklist of ABIs unsupported by the current target. Note that generic
434 /// ABIs are considered to be supported on all platforms and cannot be blacklisted.
435 pub abi_blacklist: Vec<Abi>,
437 /// Whether or not linking dylibs to a static CRT is allowed.
438 pub crt_static_allows_dylibs: bool,
439 /// Whether or not the CRT is statically linked by default.
440 pub crt_static_default: bool,
441 /// Whether or not crt-static is respected by the compiler (or is a no-op).
442 pub crt_static_respected: bool,
444 /// Whether or not stack probes (__rust_probestack) are enabled
445 pub stack_probes: bool,
447 /// The minimum alignment for global symbols.
448 pub min_global_align: Option<u64>,
450 /// Default number of codegen units to use in debug mode
451 pub default_codegen_units: Option<u64>,
453 /// Whether to generate trap instructions in places where optimization would
454 /// otherwise produce control flow that falls through into unrelated memory.
455 pub trap_unreachable: bool,
457 /// This target requires everything to be compiled with LTO to emit a final
458 /// executable, aka there is no native linker for this target.
459 pub requires_lto: bool,
461 /// This target has no support for threads.
462 pub singlethread: bool,
464 /// Whether library functions call lowering/optimization is disabled in LLVM
465 /// for this target unconditionally.
466 pub no_builtins: bool,
468 /// Whether to lower 128-bit operations to compiler_builtins calls. Use if
469 /// your backend only supports 64-bit and smaller math.
470 pub i128_lowering: bool,
472 /// The codegen backend to use for this target, typically "llvm"
473 pub codegen_backend: String,
475 /// The default visibility for symbols in this target should be "hidden"
476 /// rather than "default"
477 pub default_hidden_visibility: bool,
480 impl Default for TargetOptions {
481 /// Create a set of "sane defaults" for any target. This is still
482 /// incomplete, and if used for compilation, will certainly not work.
483 fn default() -> TargetOptions {
486 linker: option_env!("CFG_DEFAULT_LINKER").unwrap_or("cc").to_string(),
487 pre_link_args: LinkArgs::new(),
488 post_link_args: LinkArgs::new(),
489 asm_args: Vec::new(),
490 cpu: "generic".to_string(),
491 features: "".to_string(),
492 dynamic_linking: false,
495 relocation_model: "pic".to_string(),
497 tls_model: "global-dynamic".to_string(),
498 disable_redzone: false,
499 eliminate_frame_pointer: true,
500 function_sections: true,
501 dll_prefix: "lib".to_string(),
502 dll_suffix: ".so".to_string(),
503 exe_suffix: "".to_string(),
504 staticlib_prefix: "lib".to_string(),
505 staticlib_suffix: ".a".to_string(),
507 is_like_openbsd: false,
509 is_like_solaris: false,
510 is_like_windows: false,
511 is_like_android: false,
512 is_like_emscripten: false,
514 linker_is_gnu: false,
515 allows_weak_linkage: true,
517 no_default_libraries: true,
518 position_independent_executables: false,
519 relro_level: RelroLevel::Off,
520 pre_link_objects_exe: Vec::new(),
521 pre_link_objects_dll: Vec::new(),
522 post_link_objects: Vec::new(),
523 late_link_args: LinkArgs::new(),
524 link_env: Vec::new(),
525 archive_format: "gnu".to_string(),
526 custom_unwind_resume: false,
527 exe_allocation_crate: None,
530 obj_is_bitcode: false,
531 no_integrated_as: false,
532 min_atomic_width: None,
533 max_atomic_width: None,
534 panic_strategy: PanicStrategy::Unwind,
535 abi_blacklist: vec![],
536 crt_static_allows_dylibs: false,
537 crt_static_default: false,
538 crt_static_respected: false,
540 min_global_align: None,
541 default_codegen_units: None,
542 trap_unreachable: true,
546 i128_lowering: false,
547 codegen_backend: "llvm".to_string(),
548 default_hidden_visibility: false,
554 /// Given a function ABI, turn "System" into the correct ABI for this target.
555 pub fn adjust_abi(&self, abi: Abi) -> Abi {
558 if self.options.is_like_windows && self.arch == "x86" {
568 /// Minimum integer size in bits that this target can perform atomic
570 pub fn min_atomic_width(&self) -> u64 {
571 self.options.min_atomic_width.unwrap_or(8)
574 /// Maximum integer size in bits that this target can perform atomic
576 pub fn max_atomic_width(&self) -> u64 {
577 self.options.max_atomic_width.unwrap_or(self.target_pointer_width.parse().unwrap())
580 pub fn is_abi_supported(&self, abi: Abi) -> bool {
581 abi.generic() || !self.options.abi_blacklist.contains(&abi)
584 /// Load a target descriptor from a JSON object.
585 pub fn from_json(obj: Json) -> TargetResult {
586 // While ugly, this code must remain this way to retain
587 // compatibility with existing JSON fields and the internal
588 // expected naming of the Target and TargetOptions structs.
589 // To ensure compatibility is retained, the built-in targets
590 // are round-tripped through this code to catch cases where
591 // the JSON parser is not updated to match the structs.
593 let get_req_field = |name: &str| {
595 .map(|s| s.as_string())
596 .and_then(|os| os.map(|s| s.to_string())) {
597 Some(val) => Ok(val),
599 return Err(format!("Field {} in target specification is required", name))
604 let get_opt_field = |name: &str, default: &str| {
605 obj.find(name).and_then(|s| s.as_string())
606 .map(|s| s.to_string())
607 .unwrap_or(default.to_string())
610 let mut base = Target {
611 llvm_target: get_req_field("llvm-target")?,
612 target_endian: get_req_field("target-endian")?,
613 target_pointer_width: get_req_field("target-pointer-width")?,
614 target_c_int_width: get_req_field("target-c-int-width")?,
615 data_layout: get_req_field("data-layout")?,
616 arch: get_req_field("arch")?,
617 target_os: get_req_field("os")?,
618 target_env: get_opt_field("env", ""),
619 target_vendor: get_opt_field("vendor", "unknown"),
620 linker_flavor: LinkerFlavor::from_str(&*get_req_field("linker-flavor")?)
622 format!("linker flavor must be {}", LinkerFlavor::one_of())
624 options: Default::default(),
628 ($key_name:ident) => ( {
629 let name = (stringify!($key_name)).replace("_", "-");
630 obj.find(&name[..]).map(|o| o.as_string()
631 .map(|s| base.options.$key_name = s.to_string()));
633 ($key_name:ident, bool) => ( {
634 let name = (stringify!($key_name)).replace("_", "-");
636 .map(|o| o.as_boolean()
637 .map(|s| base.options.$key_name = s));
639 ($key_name:ident, Option<u64>) => ( {
640 let name = (stringify!($key_name)).replace("_", "-");
643 .map(|s| base.options.$key_name = Some(s)));
645 ($key_name:ident, PanicStrategy) => ( {
646 let name = (stringify!($key_name)).replace("_", "-");
647 obj.find(&name[..]).and_then(|o| o.as_string().and_then(|s| {
649 "unwind" => base.options.$key_name = PanicStrategy::Unwind,
650 "abort" => base.options.$key_name = PanicStrategy::Abort,
651 _ => return Some(Err(format!("'{}' is not a valid value for \
652 panic-strategy. Use 'unwind' or 'abort'.",
656 })).unwrap_or(Ok(()))
658 ($key_name:ident, RelroLevel) => ( {
659 let name = (stringify!($key_name)).replace("_", "-");
660 obj.find(&name[..]).and_then(|o| o.as_string().and_then(|s| {
661 match s.parse::<RelroLevel>() {
662 Ok(level) => base.options.$key_name = level,
663 _ => return Some(Err(format!("'{}' is not a valid value for \
664 relro-level. Use 'full', 'partial, or 'off'.",
668 })).unwrap_or(Ok(()))
670 ($key_name:ident, list) => ( {
671 let name = (stringify!($key_name)).replace("_", "-");
672 obj.find(&name[..]).map(|o| o.as_array()
673 .map(|v| base.options.$key_name = v.iter()
674 .map(|a| a.as_string().unwrap().to_string()).collect()
678 ($key_name:ident, optional) => ( {
679 let name = (stringify!($key_name)).replace("_", "-");
680 if let Some(o) = obj.find(&name[..]) {
681 base.options.$key_name = o
683 .map(|s| s.to_string() );
686 ($key_name:ident, LinkerFlavor) => ( {
687 let name = (stringify!($key_name)).replace("_", "-");
688 obj.find(&name[..]).and_then(|o| o.as_string().map(|s| {
689 LinkerFlavor::from_str(&s).ok_or_else(|| {
690 Err(format!("'{}' is not a valid value for linker-flavor. \
691 Use 'em', 'gcc', 'ld' or 'msvc.", s))
693 })).unwrap_or(Ok(()))
695 ($key_name:ident, link_args) => ( {
696 let name = (stringify!($key_name)).replace("_", "-");
697 if let Some(obj) = obj.find(&name[..]).and_then(|o| o.as_object()) {
698 let mut args = LinkArgs::new();
700 let k = LinkerFlavor::from_str(&k).ok_or_else(|| {
701 format!("{}: '{}' is not a valid value for linker-flavor. \
702 Use 'em', 'gcc', 'ld' or 'msvc'", name, k)
705 let v = v.as_array().map(|a| {
708 .filter_map(|o| o.as_string())
709 .map(|s| s.to_owned())
711 }).unwrap_or(vec![]);
715 base.options.$key_name = args;
718 ($key_name:ident, env) => ( {
719 let name = (stringify!($key_name)).replace("_", "-");
720 if let Some(a) = obj.find(&name[..]).and_then(|o| o.as_array()) {
722 if let Some(s) = o.as_string() {
723 let p = s.split('=').collect::<Vec<_>>();
725 let k = p[0].to_string();
726 let v = p[1].to_string();
727 base.options.$key_name.push((k, v));
735 key!(is_builtin, bool);
737 key!(pre_link_args, link_args);
738 key!(pre_link_objects_exe, list);
739 key!(pre_link_objects_dll, list);
740 key!(late_link_args, link_args);
741 key!(post_link_objects, list);
742 key!(post_link_args, link_args);
744 key!(asm_args, list);
747 key!(dynamic_linking, bool);
748 key!(only_cdylib, bool);
749 key!(executables, bool);
750 key!(relocation_model);
751 key!(code_model, optional);
753 key!(disable_redzone, bool);
754 key!(eliminate_frame_pointer, bool);
755 key!(function_sections, bool);
759 key!(staticlib_prefix);
760 key!(staticlib_suffix);
761 key!(target_family, optional);
762 key!(is_like_openbsd, bool);
763 key!(is_like_osx, bool);
764 key!(is_like_solaris, bool);
765 key!(is_like_windows, bool);
766 key!(is_like_msvc, bool);
767 key!(is_like_emscripten, bool);
768 key!(is_like_android, bool);
769 key!(linker_is_gnu, bool);
770 key!(allows_weak_linkage, bool);
771 key!(has_rpath, bool);
772 key!(no_default_libraries, bool);
773 key!(position_independent_executables, bool);
774 try!(key!(relro_level, RelroLevel));
775 key!(archive_format);
776 key!(allow_asm, bool);
777 key!(custom_unwind_resume, bool);
778 key!(exe_allocation_crate, optional);
779 key!(has_elf_tls, bool);
780 key!(obj_is_bitcode, bool);
781 key!(no_integrated_as, bool);
782 key!(max_atomic_width, Option<u64>);
783 key!(min_atomic_width, Option<u64>);
784 try!(key!(panic_strategy, PanicStrategy));
785 key!(crt_static_allows_dylibs, bool);
786 key!(crt_static_default, bool);
787 key!(crt_static_respected, bool);
788 key!(stack_probes, bool);
789 key!(min_global_align, Option<u64>);
790 key!(default_codegen_units, Option<u64>);
791 key!(trap_unreachable, bool);
792 key!(requires_lto, bool);
793 key!(singlethread, bool);
794 key!(no_builtins, bool);
795 key!(codegen_backend);
796 key!(default_hidden_visibility, bool);
798 if let Some(array) = obj.find("abi-blacklist").and_then(Json::as_array) {
799 for name in array.iter().filter_map(|abi| abi.as_string()) {
800 match lookup_abi(name) {
803 return Err(format!("The ABI \"{}\" is considered to be supported on \
804 all targets and cannot be blacklisted", abi))
807 base.options.abi_blacklist.push(abi)
809 None => return Err(format!("Unknown ABI \"{}\" in target specification", name))
817 /// Search RUST_TARGET_PATH for a JSON file specifying the given target
818 /// triple. Note that it could also just be a bare filename already, so also
819 /// check for that. If one of the hardcoded targets we know about, just
820 /// return it directly.
822 /// The error string could come from any of the APIs called, including
823 /// filesystem access and JSON decoding.
824 pub fn search(target: &str) -> Result<Target, String> {
826 use std::ffi::OsString;
828 use std::path::{Path, PathBuf};
831 fn load_file(path: &Path) -> Result<Target, String> {
832 let contents = fs::read(path).map_err(|e| e.to_string())?;
833 let obj = json::from_reader(&mut &contents[..])
834 .map_err(|e| e.to_string())?;
835 Target::from_json(obj)
838 if let Ok(t) = load_specific(target) {
842 let path = Path::new(target);
845 return load_file(&path);
849 let mut target = target.to_string();
850 target.push_str(".json");
851 PathBuf::from(target)
854 let target_path = env::var_os("RUST_TARGET_PATH")
855 .unwrap_or(OsString::new());
857 // FIXME 16351: add a sane default search path?
859 for dir in env::split_paths(&target_path) {
860 let p = dir.join(&path);
862 return load_file(&p);
866 Err(format!("Could not find specification for target {:?}", target))
870 impl ToJson for Target {
871 fn to_json(&self) -> Json {
872 let mut d = BTreeMap::new();
873 let default: TargetOptions = Default::default();
875 macro_rules! target_val {
877 let name = (stringify!($attr)).replace("_", "-");
878 d.insert(name.to_string(), self.$attr.to_json());
880 ($attr:ident, $key_name:expr) => ( {
881 let name = $key_name;
882 d.insert(name.to_string(), self.$attr.to_json());
886 macro_rules! target_option_val {
888 let name = (stringify!($attr)).replace("_", "-");
889 if default.$attr != self.options.$attr {
890 d.insert(name.to_string(), self.options.$attr.to_json());
893 ($attr:ident, $key_name:expr) => ( {
894 let name = $key_name;
895 if default.$attr != self.options.$attr {
896 d.insert(name.to_string(), self.options.$attr.to_json());
899 (link_args - $attr:ident) => ( {
900 let name = (stringify!($attr)).replace("_", "-");
901 if default.$attr != self.options.$attr {
902 let obj = self.options.$attr
904 .map(|(k, v)| (k.desc().to_owned(), v.clone()))
905 .collect::<BTreeMap<_, _>>();
906 d.insert(name.to_string(), obj.to_json());
909 (env - $attr:ident) => ( {
910 let name = (stringify!($attr)).replace("_", "-");
911 if default.$attr != self.options.$attr {
912 let obj = self.options.$attr
914 .map(|&(ref k, ref v)| k.clone() + "=" + &v)
915 .collect::<Vec<_>>();
916 d.insert(name.to_string(), obj.to_json());
922 target_val!(llvm_target);
923 target_val!(target_endian);
924 target_val!(target_pointer_width);
925 target_val!(target_c_int_width);
927 target_val!(target_os, "os");
928 target_val!(target_env, "env");
929 target_val!(target_vendor, "vendor");
930 target_val!(data_layout);
931 target_val!(linker_flavor);
933 target_option_val!(is_builtin);
934 target_option_val!(linker);
935 target_option_val!(link_args - pre_link_args);
936 target_option_val!(pre_link_objects_exe);
937 target_option_val!(pre_link_objects_dll);
938 target_option_val!(link_args - late_link_args);
939 target_option_val!(post_link_objects);
940 target_option_val!(link_args - post_link_args);
941 target_option_val!(env - link_env);
942 target_option_val!(asm_args);
943 target_option_val!(cpu);
944 target_option_val!(features);
945 target_option_val!(dynamic_linking);
946 target_option_val!(only_cdylib);
947 target_option_val!(executables);
948 target_option_val!(relocation_model);
949 target_option_val!(code_model);
950 target_option_val!(tls_model);
951 target_option_val!(disable_redzone);
952 target_option_val!(eliminate_frame_pointer);
953 target_option_val!(function_sections);
954 target_option_val!(dll_prefix);
955 target_option_val!(dll_suffix);
956 target_option_val!(exe_suffix);
957 target_option_val!(staticlib_prefix);
958 target_option_val!(staticlib_suffix);
959 target_option_val!(target_family);
960 target_option_val!(is_like_openbsd);
961 target_option_val!(is_like_osx);
962 target_option_val!(is_like_solaris);
963 target_option_val!(is_like_windows);
964 target_option_val!(is_like_msvc);
965 target_option_val!(is_like_emscripten);
966 target_option_val!(is_like_android);
967 target_option_val!(linker_is_gnu);
968 target_option_val!(allows_weak_linkage);
969 target_option_val!(has_rpath);
970 target_option_val!(no_default_libraries);
971 target_option_val!(position_independent_executables);
972 target_option_val!(relro_level);
973 target_option_val!(archive_format);
974 target_option_val!(allow_asm);
975 target_option_val!(custom_unwind_resume);
976 target_option_val!(exe_allocation_crate);
977 target_option_val!(has_elf_tls);
978 target_option_val!(obj_is_bitcode);
979 target_option_val!(no_integrated_as);
980 target_option_val!(min_atomic_width);
981 target_option_val!(max_atomic_width);
982 target_option_val!(panic_strategy);
983 target_option_val!(crt_static_allows_dylibs);
984 target_option_val!(crt_static_default);
985 target_option_val!(crt_static_respected);
986 target_option_val!(stack_probes);
987 target_option_val!(min_global_align);
988 target_option_val!(default_codegen_units);
989 target_option_val!(trap_unreachable);
990 target_option_val!(requires_lto);
991 target_option_val!(singlethread);
992 target_option_val!(no_builtins);
993 target_option_val!(codegen_backend);
994 target_option_val!(default_hidden_visibility);
996 if default.abi_blacklist != self.options.abi_blacklist {
997 d.insert("abi-blacklist".to_string(), self.options.abi_blacklist.iter()
998 .map(Abi::name).map(|name| name.to_json())
999 .collect::<Vec<_>>().to_json());
1006 fn maybe_jemalloc() -> Option<String> {
1007 if cfg!(feature = "jemalloc") {
1008 Some("alloc_jemalloc".to_string())